Fork the WinML APIs into the Microsoft namespace (microsoft#3503)

* Migrate winml to Microsoft Namespace (packaging changes are pending)

* add ns_prefix toggle

* fix packaging

* Users/sheilk/add missing raw header (microsoft#3484)

* add dualapipartition

* wrong variable for repo root

Co-authored-by: Sheil Kumar <[email protected]>

* remove existence check to force failures

* extra paren

* dualapipartition needs to be referenced from the source

* add microsoft.ai.machinelearning.dll to the output dir

* rename the idl file so that assembly info is correctly added into the winmd

* fix namespaces

* update namespaces

* default to microsoft, and add namespace override as build argument

* update cmakesetings.json as well

* remove from cmakelists.txt

Co-authored-by: Sheil Kumar <[email protected]>
Co-authored-by: Changming Sun <[email protected]>

Author: 3 people

cmake/CMakeLists.txt

@@ -881,7 +881,7 @@ else()
   list(APPEND onnxruntime_EXTERNAL_LIBRARIES ${CMAKE_DL_LIBS} Threads::Threads)
 endif()
 
-# Default version parts for Windows.AI.MachineLearning.dll and onnxruntime.dll in non-ADO pipeline local builds
+# Default version parts for Microsoft.AI.MachineLearning.dll and onnxruntime.dll in non-ADO pipeline local builds
 set(VERSION_MAJOR_PART   0 CACHE STRING "First part of numeric file/product version.")
 set(VERSION_MINOR_PART   0 CACHE STRING "Second part of numeric file/product version.")
 set(VERSION_BUILD_PART       0 CACHE STRING "Third part of numeric file/product version.")

cmake/CMakeSettings.json

@@ -16,6 +16,10 @@
           "value": "True",
           "type": "BOOL"
         },
+        {
+          "name": "onnxruntime_WINML_NAMESPACE_OVERRIDE",
+          "value": "Microsoft"
+        },
         {
           "name": "onnxruntime_USE_DML",
           "value": "True",
@@ -45,6 +49,10 @@
           "value": "True",
           "type": "BOOL"
         },
+        {
+          "name": "onnxruntime_WINML_NAMESPACE_OVERRIDE",
+          "value": "Microsoft"
+        },
         {
           "name": "onnxruntime_USE_DML",
           "value": "True",

cmake/winml.cmake

@@ -24,6 +24,24 @@ set(winml_lib_api_ort_dir ${REPO_ROOT}/winml/lib/api.ort)
 set(winml_lib_common_dir ${REPO_ROOT}/winml/lib/common)
 set(winml_lib_telemetry_dir ${REPO_ROOT}/winml/lib/telemetry)
 
+if (onnxruntime_WINML_NAMESPACE_OVERRIDE)
+  set(output_name "${onnxruntime_WINML_NAMESPACE_OVERRIDE}.AI.MachineLearning")
+  set(idl_native_output_name "${onnxruntime_WINML_NAMESPACE_OVERRIDE}.AI.MachineLearning.Native")
+  set(idl_native_internal_output_name "${onnxruntime_WINML_NAMESPACE_OVERRIDE}.AI.MachineLearning.Native.Internal")
+  set(winml_midl_defines "/DROOT_NS=${onnxruntime_WINML_NAMESPACE_OVERRIDE}")
+  set(winml_root_ns "${onnxruntime_WINML_NAMESPACE_OVERRIDE}")
+  set(BINARY_NAME "${onnxruntime_WINML_NAMESPACE_OVERRIDE}.AI.MachineLearning.dll")
+  set(winml_api_use_ns_prefix false)
+else()
+  set(output_name "Microsoft.AI.MachineLearning")
+  set(idl_native_output_name "Microsoft.AI.MachineLearning.Native")
+  set(idl_native_internal_output_name "Microsoft.AI.MachineLearning.Native.Internal")
+  set(winml_midl_defines "/DROOT_NS=Microsoft")
+  set(winml_root_ns "Microsoft")
+  set(BINARY_NAME "Microsoft.AI.MachineLearning.dll")
+  set(winml_api_use_ns_prefix true)
+endif()
+
 get_filename_component(exclusions "${winml_api_root}/exclusions.txt" ABSOLUTE)
 convert_forward_slashes_to_back(${exclusions} CPPWINRT_COMPONENT_EXCLUSION_LIST)
 
@@ -51,25 +69,33 @@ add_generate_cppwinrt_sdk_headers_target(
 
 # generate winml headers from idl
 target_cppwinrt(winml_api
-  ${winrt_idl}            # winml winrt idl to compile
-  ${winml_lib_api_dir}    # location for cppwinrt generated component sources
-  ${sdk_folder}           # location of sdk folder
-  ${sdk_version}          # sdk version
-  ${target_folder}        # the folder this target will be placed under
+  ${winrt_idl}               # winml winrt idl to compile
+  ${output_name}             # outputs name
+  ${winml_lib_api_dir}       # location for cppwinrt generated component sources
+  ${sdk_folder}              # location of sdk folder
+  ${sdk_version}             # sdk version
+  ${target_folder}           # the folder this target will be placed under
+  ${winml_midl_defines}      # the midl compiler defines
+  ${winml_api_use_ns_prefix} # set ns_prefix
 )
 
 target_midl(winml_api_native
-  ${idl_native}           # winml native idl to compile
-  ${sdk_folder}           # location of sdk folder
-  ${sdk_version}          # sdk version
-  ${target_folder}        # the folder this target will be placed under
+  ${idl_native}             # winml native idl to compile
+  ${idl_native_output_name} # outputs name
+  ${sdk_folder}             # location of sdk folder
+  ${sdk_version}            # sdk version
+  ${target_folder}          # the folder this target will be placed under
+  ${winml_midl_defines}     # the midl compiler defines
 )
 
 target_midl(winml_api_native_internal
-  ${idl_native_internal}  # winml internal native idl to compile
-  ${sdk_folder}           # location of sdk folder
-  ${sdk_version}          # sdk version
-  ${target_folder})       # the folder this target will be placed under
+  ${idl_native_internal}             # winml internal native idl to compile
+  ${idl_native_internal_output_name} # outputs name
+  ${sdk_folder}                      # location of sdk folder
+  ${sdk_version}                     # sdk version
+  ${target_folder}                   # the folder this target will be placed under
+  ${winml_midl_defines}              # the midl compiler defines
+)
 
 ###########################
 # Add winml_lib_telemetry
@@ -96,6 +122,7 @@ endif()
 # Compiler flags
 target_compile_definitions(winml_lib_telemetry PRIVATE PLATFORM_WINDOWS)
 target_compile_definitions(winml_lib_telemetry PRIVATE _SCL_SECURE_NO_WARNINGS)      # remove warnings about unchecked iterators
+target_compile_definitions(winml_lib_telemetry PRIVATE BINARY_NAME=\"${BINARY_NAME}\")
 
 # Specify the usage of a precompiled header
 target_precompiled_header(winml_lib_telemetry pch.h)
@@ -153,6 +180,7 @@ target_compile_features(winml_lib_ort PRIVATE cxx_std_17)
 target_compile_options(winml_lib_ort PRIVATE /GR- /await /wd4238)
 
 # Compiler definitions
+target_compile_definitions(winml_lib_ort PRIVATE WINML_ROOT_NS=${winml_root_ns})
 target_compile_definitions(winml_lib_ort PRIVATE PLATFORM_WINDOWS)
 target_compile_definitions(winml_lib_ort PRIVATE _SCL_SECURE_NO_WARNINGS)                         # remove warnings about unchecked iterators
 
@@ -280,6 +308,7 @@ target_compile_features(winml_lib_image PRIVATE cxx_std_17)
 target_compile_options(winml_lib_image PRIVATE /GR- /await /wd4238)
 
 # Compiler flags
+target_compile_definitions(winml_lib_image PRIVATE WINML_ROOT_NS=${winml_root_ns})
 target_compile_definitions(winml_lib_image PRIVATE ONNX_NAMESPACE=onnx)
 target_compile_definitions(winml_lib_image PRIVATE ONNX_ML)
 target_compile_definitions(winml_lib_image PRIVATE LOTUS_LOG_THRESHOLD=2)
@@ -370,6 +399,7 @@ target_compile_features(winml_lib_api PRIVATE cxx_std_17)
 target_compile_options(winml_lib_api PRIVATE /GR- /await /bigobj /wd4238)
 
 # Compiler flags
+target_compile_definitions(winml_lib_api PRIVATE WINML_ROOT_NS=${winml_root_ns})
 target_compile_definitions(winml_lib_api PRIVATE ONNX_NAMESPACE=onnx)
 target_compile_definitions(winml_lib_api PRIVATE ONNX_ML)
 target_compile_definitions(winml_lib_api PRIVATE LOTUS_LOG_THRESHOLD=2)
@@ -452,18 +482,23 @@ set_target_properties(winml_lib_common PROPERTIES CXX_STANDARD_REQUIRED ON)
 target_compile_options(winml_lib_common PRIVATE /GR- /await /bigobj /wd4238)
 target_link_libraries(winml_lib_common PRIVATE wil)
 target_include_directories(winml_lib_common PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/winml_api)
-target_compile_definitions(winml_lib_common PRIVATE
-  ONNX_NAMESPACE=onnx
-  ONNX_ML
-  LOTUS_LOG_THRESHOLD=2
-  LOTUS_ENABLE_STDERR_LOGGING
-  PLATFORM_WINDOWS
-  _SCL_SECURE_NO_WARNINGS)
+
+# Compiler flags
+target_compile_definitions(winml_lib_common PRIVATE BINARY_NAME=\"${BINARY_NAME}\")
+target_compile_definitions(winml_lib_common PRIVATE WINML_ROOT_NS=${winml_root_ns})
+target_compile_definitions(winml_lib_common PRIVATE ONNX_NAMESPACE=onnx)
+target_compile_definitions(winml_lib_common PRIVATE ONNX_ML)
+target_compile_definitions(winml_lib_common PRIVATE LOTUS_LOG_THRESHOLD=2)
+target_compile_definitions(winml_lib_common PRIVATE LOTUS_ENABLE_STDERR_LOGGING)
+target_compile_definitions(winml_lib_common PRIVATE PLATFORM_WINDOWS)
+target_compile_definitions(winml_lib_common PRIVATE _SCL_SECURE_NO_WARNINGS)
+
 add_dependencies(winml_lib_common winml_sdk_cppwinrt)
 add_dependencies(winml_lib_common winml_api)
 add_dependencies(winml_lib_common winml_api_native)
 add_dependencies(winml_lib_common winml_api_native_internal)
 
+
 target_include_directories(winml_lib_common PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/winml_api)                   # windows machine learning generated component headers
 target_include_directories(winml_lib_common PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/winml_api/comp_generated)    # windows machine learning generated component headers
 target_include_directories(winml_lib_common PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/winml/sdk/cppwinrt/include)  # sdk cppwinrt headers
@@ -489,7 +524,7 @@ set_source_files_properties(
 # Add library
 add_library(winml_dll SHARED
   ${CMAKE_CURRENT_BINARY_DIR}/winml_api/comp_generated/module.g.excl.cpp
-  ${winml_dll_dir}/windows.ai.machinelearning.def
+  ${winml_dll_dir}/winml.def
   ${winml_dll_dir}/winml.rc
   ${winml_dll_dir}/pch.h
   ${winml_dll_dir}/module.cpp
@@ -500,6 +535,7 @@ target_compile_features(winml_dll PRIVATE cxx_std_17)
 target_compile_options(winml_dll PRIVATE /GR- /await /bigobj /wd4238)
 
 # Compiler definitions
+target_compile_definitions(winml_dll PRIVATE WINML_ROOT_NS=${winml_root_ns})
 target_compile_definitions(winml_dll PRIVATE ONNX_NAMESPACE=onnx)
 target_compile_definitions(winml_dll PRIVATE ONNX_ML)
 target_compile_definitions(winml_dll PRIVATE LOTUS_LOG_THRESHOLD=2)
@@ -510,6 +546,7 @@ target_compile_definitions(winml_dll PRIVATE VER_MINOR=${VERSION_MINOR_PART})
 target_compile_definitions(winml_dll PRIVATE VER_BUILD=${VERSION_BUILD_PART})
 target_compile_definitions(winml_dll PRIVATE VER_PRIVATE=${VERSION_PRIVATE_PART})
 target_compile_definitions(winml_dll PRIVATE VER_STRING=\"${VERSION_STRING}\")
+target_compile_definitions(winml_dll PRIVATE BINARY_NAME=\"${BINARY_NAME}\")
 
 # Specify the usage of a precompiled header
 target_precompiled_header(winml_dll pch.h)
@@ -545,15 +582,15 @@ target_include_directories(winml_dll PRIVATE ${REPO_ROOT}/cmake/external/eigen)
 # Properties
 set_target_properties(winml_dll
   PROPERTIES
-  OUTPUT_NAME windows.ai.machinelearning)
+  OUTPUT_NAME ${output_name})
 
 if (onnxruntime_USE_DML)
   set(delayload_dml "/DELAYLOAD:directml.dll")
 endif(onnxruntime_USE_DML)
 
 set(os_component_link_flags_list ${os_component_link_flags})
 separate_arguments(os_component_link_flags_list)
-target_link_options(winml_dll PRIVATE /DEF:${WINML_DIR}/windows.ai.machinelearning.def ${os_component_link_flags_list} /DELAYLOAD:api-ms-win-core-libraryloader-l1-2-1.dll /DELAYLOAD:api-ms-win-core-threadpool-legacy-l1-1-0.dll /DELAYLOAD:api-ms-win-core-processtopology-obsolete-l1-1-0.dll /DELAYLOAD:api-ms-win-core-kernel32-legacy-l1-1-0.dll /DELAYLOAD:d3d12.dll /DELAYLOAD:d3d11.dll /DELAYLOAD:dxgi.dll ${delayload_dml})
+target_link_options(winml_dll PRIVATE /DEF:${WINML_DIR}/winml.def ${os_component_link_flags_list} /DELAYLOAD:api-ms-win-core-libraryloader-l1-2-1.dll /DELAYLOAD:api-ms-win-core-threadpool-legacy-l1-1-0.dll /DELAYLOAD:api-ms-win-core-processtopology-obsolete-l1-1-0.dll /DELAYLOAD:api-ms-win-core-kernel32-legacy-l1-1-0.dll /DELAYLOAD:d3d12.dll /DELAYLOAD:d3d11.dll /DELAYLOAD:dxgi.dll ${delayload_dml})
 
 if (EXISTS ${dxcore_header})
   target_link_options(winml_dll PRIVATE /DELAYLOAD:ext-ms-win-dxcore-l1-*.dll)

cmake/winml_cppwinrt.cmake

@@ -20,9 +20,12 @@
 function(target_midl
     target_name
     idl_file
-    sdk_folder            # sdk kit directory
-    sdk_version           # sdk version
-    folder_name)
+    output_name       # output name of the generated headers, winmd and tlb
+    sdk_folder        # sdk kit directory
+    sdk_version       # sdk version
+    folder_name
+    midl_options      # defines for the midl compiler
+    )
     if (MSVC)
         # get sdk include paths for midl
         get_sdk_include_folder(${sdk_folder} ${sdk_version} sdk_include_folder)
@@ -38,9 +41,7 @@ function(target_midl
         get_sdk_midl_exe(${sdk_folder} ${sdk_version} midl_exe)
 
         # Filename variables
-        get_filename_component(file_name_with_extension ${idl_file} NAME)
-        string(REGEX REPLACE "\\.[^.]*$" "" file_name ${file_name_with_extension})
-        set(header_filename ${file_name}.h)
+        set(header_filename ${output_name}.h)
         convert_forward_slashes_to_back(${idl_file} idl_file_forward_slash)
 
         # using add_custom_command trick to prevent rerunning script unless ${file} is changed
@@ -55,6 +56,7 @@ function(target_midl
                 /I ${winrt_sdk_directory}
                 /I ${CMAKE_CURRENT_SOURCE_DIR}
                 /h ${header_filename}
+                ${midl_options}
                 ${idl_file_forward_slash}
             DEPENDS ${idl_file}
         )
@@ -70,12 +72,15 @@ function(target_midl
 endfunction()
 
 function(target_cppwinrt
-    target_name           # the name of the target to add
-    file                  # name of the idl file to compile
-    out_sources_folder    # path where generated sources will be placed
-    sdk_folder            # sdk kit directory
-    sdk_version           # sdk version
-    folder_name           # folder this target will be placed
+    target_name          # the name of the target to add
+    file                 # name of the idl file to compile
+    output_name          # output name of the generated headers, winmd and tlb
+    out_sources_folder   # path where generated sources will be placed
+    sdk_folder           # sdk kit directory
+    sdk_version          # sdk version
+    folder_name          # folder this target will be placed
+    midl_options         # defines for the midl compiler
+    set_ns_prefix        # set ns_prefix option
 )
     if (MSVC)
         # get sdk include paths for midl
@@ -95,12 +100,9 @@ function(target_cppwinrt
         get_sdk_cppwinrt_exe(${sdk_folder} ${sdk_version} cppwinrt_exe)
 
         # Filename variables
-        convert_forward_slashes_to_back(${file} idl_file_forward_slash)
-        get_filename_component(file_name_with_extension ${file} NAME)
-        string(REGEX REPLACE "\\.[^.]*$" "" fileName ${file_name_with_extension})
-        set(header_filename ${fileName}.h)
-        set(winmd_filename ${fileName}.winmd)
-        set(tlb_filename ${fileName}.tlb)
+        set(header_filename ${output_name}.h)
+        set(winmd_filename ${output_name}.winmd)
+        set(tlb_filename ${output_name}.tlb)
 
         # Get directory
         get_filename_component(idl_source_directory ${file} DIRECTORY)
@@ -111,6 +113,24 @@ function(target_cppwinrt
         convert_forward_slashes_to_back(${target_outputs}/comp_generated generated_dir_back_slash)
         convert_forward_slashes_to_back(${generated_dir_back_slash}/module.g.cpp module_g_cpp_back_slash)
         convert_forward_slashes_to_back(${generated_dir_back_slash}/module.g.excl.cpp module_g_ecxl_cpp_back_slash)
+  
+        if (set_ns_prefix)
+          set(ns_prefix "/ns_prefix")
+        else()
+          set(ns_prefix "")
+        endif()
+
+        # Get name
+        set(renamed_idl_filename ${output_name}.idl)
+        set(renamed_idl_fullpath ${target_outputs}/${renamed_idl_filename})
+
+        get_filename_component(idl_source_filename ${file} NAME)
+        set(copied_idl_fullpath ${target_outputs}/${idl_source_filename})
+
+        file(COPY ${file} DESTINATION ${target_outputs})
+        file(RENAME ${copied_idl_fullpath} ${renamed_idl_fullpath})
+
+        convert_forward_slashes_to_back(${renamed_idl_fullpath} renamed_idl_fullpath_back_slash)
 
         # using add_custom_command trick to prevent rerunning script unless ${file} is changed
         add_custom_command(
@@ -125,9 +145,11 @@ function(target_cppwinrt
                 /I ${winrt_sdk_directory}
                 /I ${idl_source_directory}
                 /winmd ${winmd_filename}
+                ${ns_prefix}
                 /h ${header_filename}
                 /tlb ${tlb_filename}
-                ${idl_file_forward_slash}
+                ${midl_options}
+                ${renamed_idl_fullpath_back_slash}
             COMMAND
                     ${cppwinrt_exe} -in ${winmd_filename} -comp ${output_dir_back_slash} -ref ${sdk_metadata_directory} -out ${generated_dir_back_slash} -verbose
             COMMAND

cmake/winml_unittests.cmake

@@ -23,6 +23,8 @@ function(set_winml_target_properties target)
     CXX_EXTENSIONS NO
   )
   target_include_directories(${target} PRIVATE ${WINML_TEST_INC_DIR})
+  target_compile_definitions(${target} PRIVATE WINML_ROOT_NS=${winml_root_ns})
+  target_compile_definitions(${target} PRIVATE BINARY_NAME=\"${BINARY_NAME}\")
 endfunction()
 
 function(add_winml_test)