Add check for path limit in Windows (#2472)

***NO_CI***

Author: josesimoes

CMake/binutils.common.cmake

@@ -672,3 +672,23 @@ macro(nf_clear_common_output_files_nanoclr)
     )
 
 endmacro()
+
+# function to check the path limit in Windows
+function(nf_check_path_limits)
+
+    # only need to check in Windows
+    if (WIN32)
+        set(FILESYSTEM_REG_PATH "HKLM\\SYSTEM\\CurrentControlSet\\Control\\FileSystem")
+        
+        cmake_host_system_information(RESULT WIN_LONG_PATH_OPTION QUERY WINDOWS_REGISTRY ${FILESYSTEM_REG_PATH} VALUE LongPathsEnabled)
+        if(${WIN_LONG_PATH_OPTION} EQUAL 0)
+            message(STATUS "******* WARNING ******\n\nWindows path limit is too short.\nPlease enable long paths in Windows registry.\nSee https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=cmd#enable-long-paths-in-windows-10-version-1607-and-later\n\n")
+        
+            # try setting limits to overcome this 
+            set(CMAKE_OBJECT_PATH_MAX 260)
+            set(CMAKE_OBJECT_NAME_MAX 255)
+        endif()
+
+    endif()
+
+endfunction()

CMakeLists.txt

@@ -37,6 +37,8 @@ list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/CMake)
 include(binutils.common)
 include(binutils.ESP32)
 
+nf_check_path_limits()
+
 ######################################################
 # set build type to release if not specified otherwise
 if(NOT CMAKE_BUILD_TYPE)

azure-pipelines-templates/build-preparations.yml

@@ -18,3 +18,9 @@ steps:
             }
         errorActionPreference: 'stop'
         failOnStderr: 'true'
+
+  - task: PowerShell@2
+    displayName: Enable long paths
+    inputs:
+      targetType: 'inline'
+      script: New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force

azure-pipelines-templates/download-install-esp32-build-components.yml

@@ -73,8 +73,8 @@ steps:
         # need to access the PATH collection, which seems to always be the last on in the collection
         $varsCount = $envars_raw.Count
         # go through the output and grab what has to be appended to the PATH
-        # need to remove the entry for IDF CMake because it's using an older version of CMake, OK to remove after they update it to >2.23.0
-        $newPath = $envars_raw[$varsCount - 1].ToString().Replace('PATH=', '').Replace(';%PATH%', '').Replace('C:\Users\VssAdministrator\.espressif\tools\cmake\3.20.3\bin;', '')
+        # need to remove the entry for IDF CMake because it's using an older version of CMake, OK to remove after they update it to >3.24.0
+        $newPath = $envars_raw[$varsCount - 1].ToString().Replace('PATH=', '').Replace(';%PATH%', '').Replace('C:\Users\VssAdministrator\.espressif\tools\cmake\3.23.1\bin;', '')
 
         # append to path
         Write-Host "##vso[task.prependpath]$newPath"