Refactor onnxruntime_fetchcontent_makeavailable cmake function

cmake/external/abseil-cpp.cmake

@@ -22,11 +22,12 @@ endif()
 # currently absl::lts_20240116 which affects abseil-cpp.natvis debugger
 # visualization file, that must be adjusted accordingly, unless we eliminate
 # that namespace at build time.
-FetchContent_Declare(
+onnxruntime_fetchcontent_declare(
     abseil_cpp
     URL ${DEP_URL_abseil_cpp}
     URL_HASH SHA1=${DEP_SHA1_abseil_cpp}
     PATCH_COMMAND ${ABSL_PATCH_COMMAND}
+    EXCLUDE_FROM_ALL
     FIND_PACKAGE_ARGS 20240116 NAMES absl
 )
 

cmake/external/composable_kernel.cmake

@@ -1,10 +1,11 @@
 set(PATCH ${PROJECT_SOURCE_DIR}/patches/composable_kernel/Fix_Clang_Build.patch)
 
 include(FetchContent)
-FetchContent_Declare(composable_kernel
+onnxruntime_fetchcontent_declare(composable_kernel
   URL ${DEP_URL_composable_kernel}
   URL_HASH SHA1=${DEP_SHA1_composable_kernel}
   PATCH_COMMAND ${Patch_EXECUTABLE} --binary --ignore-whitespace -p1 < ${PATCH}
+  EXCLUDE_FROM_ALL
 )
 
 FetchContent_GetProperties(composable_kernel)

cmake/external/cutlass.cmake

@@ -1,9 +1,10 @@
 include(FetchContent)
-FetchContent_Declare(
+onnxruntime_fetchcontent_declare(
   cutlass
   URL ${DEP_URL_cutlass}
   URL_HASH SHA1=${DEP_SHA1_cutlass}
   PATCH_COMMAND ${Patch_EXECUTABLE} --binary --ignore-whitespace -p1 < ${PROJECT_SOURCE_DIR}/patches/cutlass/cutlass_3.5.0.patch
+  EXCLUDE_FROM_ALL
 )
 
 FetchContent_GetProperties(cutlass)

cmake/external/dml.cmake

@@ -100,10 +100,11 @@ else()
   endif()
 endif()
 
-FetchContent_Declare(
+onnxruntime_fetchcontent_declare(
     directx_headers
     URL ${DEP_URL_directx_headers}
     URL_HASH SHA1=${DEP_SHA1_directx_headers}
+    EXCLUDE_FROM_ALL
 )
 
 FetchContent_Populate(directx_headers)

cmake/external/eigen.cmake

@@ -3,10 +3,11 @@ if (onnxruntime_USE_PREINSTALLED_EIGEN)
     file(TO_CMAKE_PATH ${eigen_SOURCE_PATH} eigen_INCLUDE_DIRS)
     target_include_directories(eigen INTERFACE ${eigen_INCLUDE_DIRS})
 else ()
-    FetchContent_Declare(
+    onnxruntime_fetchcontent_declare(
         eigen
         URL ${DEP_URL_eigen}
         URL_HASH SHA1=${DEP_SHA1_eigen}
+        EXCLUDE_FROM_ALL
     )
 
     FetchContent_Populate(eigen)

cmake/external/extensions.cmake

@@ -38,10 +38,11 @@ endif()
 
 # onnxruntime-extensions
 if (NOT onnxruntime_EXTENSIONS_OVERRIDDEN)
-  FetchContent_Declare(
+  onnxruntime_fetchcontent_declare(
     extensions
     URL ${DEP_URL_extensions}
     URL_HASH SHA1=${DEP_SHA1_extensions}
+    EXCLUDE_FROM_ALL
   )
   onnxruntime_fetchcontent_makeavailable(extensions)
 else()

cmake/external/helper_functions.cmake

@@ -1,173 +1,34 @@
-# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
-# file Copyright.txt or https://cmake.org/licensing for details.
-
-# This file was copied from cmake source with modifications:
-# 1. Add the EXCLUDE_FROM_ALL keyword when this function calls add_subdirectory. It will also resolve the
-#    'make install' issue.
-# 2. Group the VC projects into the "external" folder. We can do it at there in a centralized way instead
+# This file contains some wrappers for cmake's FetchContent functions. The wrappers added the following functionalities:
+# 1. Group the VC projects into the "external" folder. We can do it at there in a centralized way instead
 #    of doing it one by one.
-# 3. Set the cmake property COMPILE_WARNING_AS_ERROR to OFF for these external projects.
-
-macro(onnxruntime_fetchcontent_makeavailable)
-
-  # We must append an item, even if the variable is unset, so prefix its value.
-  # We will strip that prefix when we pop the value at the end of the macro.
-  list(APPEND __cmake_fcCurrentVarsStack
-    "__fcprefix__${CMAKE_VERIFY_INTERFACE_HEADER_SETS}"
-  )
-  set(CMAKE_VERIFY_INTERFACE_HEADER_SETS FALSE)
-
-  get_property(__cmake_providerCommand GLOBAL PROPERTY
-    __FETCHCONTENT_MAKEAVAILABLE_SERIAL_PROVIDER
-  )
-  foreach(__cmake_contentName IN ITEMS ${ARGV})
-    string(TOLOWER ${__cmake_contentName} __cmake_contentNameLower)
-
-    # If user specified FETCHCONTENT_SOURCE_DIR_... for this dependency, that
-    # overrides everything else and we shouldn't try to use find_package() or
-    # a dependency provider.
-    string(TOUPPER ${__cmake_contentName} __cmake_contentNameUpper)
-    if("${FETCHCONTENT_SOURCE_DIR_${__cmake_contentNameUpper}}" STREQUAL "")
-      # Dependency provider gets first opportunity, but prevent infinite
-      # recursion if we are called again for the same thing
-      if(NOT "${__cmake_providerCommand}" STREQUAL "" AND
-        NOT DEFINED __cmake_fcProvider_${__cmake_contentNameLower})
-        message(VERBOSE
-          "Trying FETCHCONTENT_MAKEAVAILABLE_SERIAL dependency provider for "
-          "${__cmake_contentName}"
-        )
-        # It's still valid if there are no saved details. The project may have
-        # been written to assume a dependency provider is always set and will
-        # provide dependencies without having any declared details for them.
-        __FetchContent_getSavedDetails(${__cmake_contentName} __cmake_contentDetails)
-        set(__cmake_providerArgs
-          "FETCHCONTENT_MAKEAVAILABLE_SERIAL"
-          "${__cmake_contentName}"
-        )
-        # Empty arguments must be preserved because of things like
-        # GIT_SUBMODULES (see CMP0097)
-        foreach(__cmake_item IN LISTS __cmake_contentDetails)
-          string(APPEND __cmake_providerArgs " [==[${__cmake_item}]==]")
-        endforeach()
-
-        # This property might be defined but empty. As long as it is defined,
-        # find_package() can be called.
-        get_property(__cmake_addfpargs GLOBAL PROPERTY
-          _FetchContent_${contentNameLower}_find_package_args
-          DEFINED
-        )
-        if(__cmake_addfpargs)
-          get_property(__cmake_fpargs GLOBAL PROPERTY
-            _FetchContent_${contentNameLower}_find_package_args
-          )
-          string(APPEND __cmake_providerArgs " FIND_PACKAGE_ARGS")
-          foreach(__cmake_item IN LISTS __cmake_fpargs)
-            string(APPEND __cmake_providerArgs " [==[${__cmake_item}]==]")
-          endforeach()
-        endif()
-
-        # Calling the provider could lead to onnxruntime_fetchcontent_makeavailable() being
-        # called for a nested dependency. That nested call may occur in the
-        # current variable scope. We have to save and restore the variables we
-        # need preserved.
-        list(APPEND __cmake_fcCurrentVarsStack
-          ${__cmake_contentName}
-          ${__cmake_contentNameLower}
-        )
-
-        set(__cmake_fcProvider_${__cmake_contentNameLower} YES)
-        cmake_language(EVAL CODE "${__cmake_providerCommand}(${__cmake_providerArgs})")
-
-        list(POP_BACK __cmake_fcCurrentVarsStack
-          __cmake_contentNameLower
-          __cmake_contentName
-        )
-
-        unset(__cmake_fcProvider_${__cmake_contentNameLower})
-        unset(__cmake_providerArgs)
-        unset(__cmake_addfpargs)
-        unset(__cmake_fpargs)
-        unset(__cmake_item)
-        unset(__cmake_contentDetails)
-
-        FetchContent_GetProperties(${__cmake_contentName})
-        if(${__cmake_contentNameLower}_POPULATED)
-          continue()
-        endif()
-      endif()
-
-      # Check if we've been asked to try find_package() first, even if we
-      # have already populated this dependency. If we previously tried to
-      # use find_package() for this and it succeeded, those things might
-      # no longer be in scope, so we have to do it again.
-      get_property(__cmake_haveFpArgs GLOBAL PROPERTY
-        _FetchContent_${__cmake_contentNameLower}_find_package_args DEFINED
-      )
-      if(__cmake_haveFpArgs)
-        unset(__cmake_haveFpArgs)
-        message(VERBOSE "Trying find_package(${__cmake_contentName} ...) before FetchContent")
-        get_property(__cmake_fpArgs GLOBAL PROPERTY
-          _FetchContent_${__cmake_contentNameLower}_find_package_args
-        )
-
-        # This call could lead to onnxruntime_fetchcontent_makeavailable() being called for
-        # a nested dependency and it may occur in the current variable scope.
-        # We have to save/restore the variables we need to preserve.
-        list(APPEND __cmake_fcCurrentNameStack
-          ${__cmake_contentName}
-          ${__cmake_contentNameLower}
-        )
-        find_package(${__cmake_contentName} ${__cmake_fpArgs})
-        list(POP_BACK __cmake_fcCurrentNameStack
-          __cmake_contentNameLower
-          __cmake_contentName
-        )
-        unset(__cmake_fpArgs)
-
-        if(${__cmake_contentName}_FOUND)
-          FetchContent_SetPopulated(${__cmake_contentName})
-          FetchContent_GetProperties(${__cmake_contentName})
-          continue()
-        endif()
-      endif()
-    else()
-      unset(__cmake_haveFpArgs)
+# 2. Set the cmake property COMPILE_WARNING_AS_ERROR to OFF for these external projects.
+
+function(onnxruntime_fetchcontent_declare contentName)
+    FetchContent_Declare(${ARGV})
+    string(TOLOWER ${contentName} contentNameLower)
+    list(FIND ARGN SOURCE_SUBDIR index_SOURCE_SUBDIR)
+    if(index_SOURCE_SUBDIR GREATER_EQUAL 0)
+      cmake_parse_arguments(PARSE_ARGV 1 ARG "" "SOURCE_SUBDIR" "") 
+      set(onnxruntime_${contentNameLower}_cmake_src_dir "${ARG_SOURCE_SUBDIR}" PARENT_SCOPE)
     endif()
+endfunction()
 
-    FetchContent_GetProperties(${__cmake_contentName})
-    if(NOT ${__cmake_contentNameLower}_POPULATED)
-      FetchContent_Populate(${__cmake_contentName})
-      __FetchContent_setupFindPackageRedirection(${__cmake_contentName})
-
-      # Only try to call add_subdirectory() if the populated content
-      # can be treated that way. Protecting the call with the check
-      # allows this function to be used for projects that just want
-      # to ensure the content exists, such as to provide content at
-      # a known location. We check the saved details for an optional
-      # SOURCE_SUBDIR which can be used in the same way as its meaning
-      # for ExternalProject. It won't matter if it was passed through
-      # to the ExternalProject sub-build, since it would have been
-      # ignored there.
-      set(__cmake_srcdir "${${__cmake_contentNameLower}_SOURCE_DIR}")
-      __FetchContent_getSavedDetails(${__cmake_contentName} __cmake_contentDetails)
-      if("${__cmake_contentDetails}" STREQUAL "")
-        message(FATAL_ERROR "No details have been set for content: ${__cmake_contentName}")
-      endif()
-      cmake_parse_arguments(__cmake_arg "SYSTEM" "SOURCE_SUBDIR" "" ${__cmake_contentDetails})
-      if(NOT "${__cmake_arg_SOURCE_SUBDIR}" STREQUAL "")
-        string(APPEND __cmake_srcdir "/${__cmake_arg_SOURCE_SUBDIR}")
+macro(onnxruntime_fetchcontent_makeavailable)
+    set(ONNXRUNTIME_CMAKE_SKIP_INSTALL_RULES_OLD_VALUE
+      "${CMAKE_SKIP_INSTALL_RULES}")
+    # If we don't skip the install rules we will hit errors from re2 like:
+    # CMake Error: install(EXPORT "re2Targets" ...) includes target "re2" which requires target "absl_base" that is not in any export set.
+    set(CMAKE_SKIP_INSTALL_RULES TRUE)
+    FetchContent_MakeAvailable(${ARGV})
+    foreach(contentName IN ITEMS ${ARGV})
+      string(TOLOWER ${contentName} contentNameLower)
+      set(content_src_dir  "${${contentNameLower}_SOURCE_DIR}")
+      if(NOT "${onnxruntime_${contentNameLower}_cmake_src_dir}" STREQUAL "")
+        string(APPEND content_src_dir "/${onnxruntime_${contentNameLower}_cmake_src_dir}")
       endif()
-
-      if(EXISTS ${__cmake_srcdir}/CMakeLists.txt)
-        set(CMAKE_SKIP_INSTALL_RULES TRUE)
-        if (__cmake_arg_SYSTEM)
-          add_subdirectory(${__cmake_srcdir} ${${__cmake_contentNameLower}_BINARY_DIR} SYSTEM)
-        else()
-          add_subdirectory(${__cmake_srcdir} ${${__cmake_contentNameLower}_BINARY_DIR} EXCLUDE_FROM_ALL)
-        endif()
-          get_property(subdir_import_targets DIRECTORY "${__cmake_srcdir}" PROPERTY BUILDSYSTEM_TARGETS)
-          foreach(subdir_target ${subdir_import_targets})
-            if(TARGET ${subdir_target})
+      get_property(subdir_import_targets DIRECTORY "${content_src_dir}" PROPERTY BUILDSYSTEM_TARGETS)
+      foreach(subdir_target ${subdir_import_targets})
+          if(TARGET ${subdir_target})
               get_target_property(subdir_target_type ${subdir_target} TYPE)
               if(subdir_target_type STREQUAL "EXECUTABLE")
                 get_target_property(subdir_target_osx_arch ${subdir_target} OSX_ARCHITECTURES)
@@ -179,27 +40,8 @@ macro(onnxruntime_fetchcontent_makeavailable)
               endif()
               set_target_properties(${subdir_target} PROPERTIES FOLDER "External")
               set_target_properties(${subdir_target} PROPERTIES COMPILE_WARNING_AS_ERROR OFF)
-            endif()
-          endforeach()
-          set(CMAKE_SKIP_INSTALL_RULES FALSE)
-      endif()
-
-      unset(__cmake_srcdir)
-      unset(__cmake_contentDetails)
-      unset(__cmake_arg_SOURCE_SUBDIR)
-    endif()
-  endforeach()
-  # Prefix will be "__fcprefix__"
-  list(POP_BACK __cmake_fcCurrentVarsStack __cmake_original_verify_setting)
-  string(SUBSTRING "${__cmake_original_verify_setting}"
-    12 -1 __cmake_original_verify_setting
-  )
-  set(CMAKE_VERIFY_INTERFACE_HEADER_SETS ${__cmake_original_verify_setting})
-
-  # clear local variables to prevent leaking into the caller's scope
-  unset(__cmake_contentName)
-  unset(__cmake_contentNameLower)
-  unset(__cmake_contentNameUpper)
-  unset(__cmake_providerCommand)
-  unset(__cmake_original_verify_setting)
+          endif()
+      endforeach()
+    endforeach()
+    set(CMAKE_SKIP_INSTALL_RULES ${ONNXRUNTIME_CMAKE_SKIP_INSTALL_RULES_OLD_VALUE})
 endmacro()

cmake/external/neural_speed.cmake

@@ -5,11 +5,12 @@ elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC" AND onnxruntime_target_platfo
 endif()
 
 if(USE_NEURAL_SPEED)
-  FetchContent_Declare(
+  onnxruntime_fetchcontent_declare(
       neural_speed
       URL ${DEP_URL_neural_speed}
       URL_HASH SHA1=${DEP_SHA1_neural_speed}
       PATCH_COMMAND ${Patch_EXECUTABLE} -p1 < ${PROJECT_SOURCE_DIR}/patches/neural_speed/150e7527d5286ddd3a995c228dedf8d76a7a86bc.patch
+      EXCLUDE_FROM_ALL
   )
   set(BTLA_USE_OPENMP OFF)
   onnxruntime_fetchcontent_makeavailable(neural_speed)