Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WebGPU] Support crosscompiling on windows platform #22777

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WebGPU] Support crosscompiling on windows platform #22777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
689ab6a
[WebGPU] Support crosscompiling on windows platform
shaoboyan Nov 8, 2024
01ecc42
fix non-crosscompiling case error
shaoboyan Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cmake/external/onnxruntime_external_deps.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,9 @@ if (onnxruntime_USE_WEBGPU)
# We are currently always using the D3D12 backend.
set(DAWN_ENABLE_D3D11 OFF CACHE BOOL "" FORCE)
endif()
if (onnxruntime_CROSS_COMPILING)
set(DAWN_CROSSCOMPILING_WIN ON CACHE BOOL "" FORCE)
endif()

onnxruntime_fetchcontent_makeavailable(dawn)

Expand Down
108 changes: 108 additions & 0 deletions cmake/patches/dawn/dawn.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,111 @@ index 0037d83276..6372c4ee77 100644
tint_lang_wgsl_program
tint_lang_wgsl_sem
tint_lang_wgsl_writer_ir_to_program
diff --git a/CMakeLists.txt b/CMakeLists.txt
index bcb91ba106..4e54940c50 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -188,6 +188,8 @@ option(DAWN_ENABLE_PIC "Build with Position-Independent-Code enabled" OFF)
option(DAWN_EMIT_COVERAGE "Emit code coverage information" OFF)
set_if_not_defined(LLVM_SOURCE_DIR "${Dawn_LLVM_SOURCE_DIR}" "Directory to an LLVM source checkout. Required to build turbo-cov")

+option(DAWN_CROSSCOMPILING_WIN "Support windows platform crosscompiling, mainly for build arm/aarch64 target on x64 platform" OFF)
+
message(STATUS "Dawn build with asserts in all configurations: ${DAWN_ALWAYS_ASSERT}")
message(STATUS "Dawn build Wayland support: ${DAWN_USE_WAYLAND}")
message(STATUS "Dawn build X11 support: ${DAWN_USE_X11}")
@@ -377,6 +380,11 @@ target_include_directories(dawn_internal_config INTERFACE
)
target_link_libraries(dawn_internal_config INTERFACE dawn_public_config)

+# Disable CMAKE_CROSSCOMPING because we don't have full support
+if(CMAKE_CROSSCOMPILING)
+ set(CMAKE_CROSSCOMPILING OFF)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we are doing cross-compiling? Usually the var is set to ON when the CMAKE_SYSTEM_NAME variable has been set manually. And usually we only read from this var, we do not set it. I worry a lot of other cmake functions/modules may rely on this var.

Copy link
Author

@shaoboyan shaoboyan Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this. Let me have a try locally.

+endif()
+
################################################################################
# Include utility CMake modules
################################################################################
diff --git a/third_party/CMakeLists.txt b/third_party/CMakeLists.txt
index bcb91ba106..4e54940c50 100644
--- a/third_party/CMakeLists.txt
+++ b/third_party/CMakeLists.txt
@@ -194,6 +194,38 @@ function(get_all_targets_recursive targets dir)
endfunction()

function(AddSubdirectoryDXC)
+ if (DAWN_CROSSCOMPILING_WIN)
+ set(FOLDER_TO_CHECK ${CMAKE_BINARY_DIR}/native-tools)
+ if(EXISTS "${FOLDER_TO_CHECK}")
+ # Find llvm-tblgen and clang-tblgen executable file in the folder
+ find_program(CLANG_TBLGEN NAMES clang-tblgen clang-tblgen.exe)
+ find_program(LLVM_TBLGEN NAMES llvm_tblgen llvm-tblgen.exe)
+ endif()
+
+ # Config clang-tblgen and llvm-tblgen tools with host cpu arch and build them during cmake configuration progress to support future crosscompiling.
+ if (NOT EXISTS "${FOLDER_TO_CHECK}")
+ file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/native-tools)
+ endif()
+
+ if (NOT CLANG_TBLGEN OR NOT LLVM_TBLGEN)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is complicated. I think we may ask the user to provide a prebuilt binary instead. Like what we do now for protoc.exe .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we build onnxruntime on Windows, we also pass in a lot of other cmake parameters like "-A Win32 --toolset 14.40". These flags cannot be handled here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is complicated. I think we may ask the user to provide a prebuilt binary instead. Like what we do now for protoc.exe

It would be ideal that user could provided the pre-baked tool for this.

When we build onnxruntime on Windows, we also pass in a lot of other cmake parameters like "-A Win32 --toolset 14.40". These flags cannot be handled here.
My understanding is that in crosscompilation situation, the llvm-talgen and clang-tblgen are built in default behaviour? (Because we don't have extra params to define the behaviour)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Sry for late reply due to some OOO)
By thinking it again, one thing I need to point out is that provide a prebuilt binary for user is not that straightforward. I tried the released llvm package contains llvm-tblgen and clang-tblgen tools and that doesn't work with dxc compilation.

And considering it is used by dawn project and dawn set some flags for the self-built dxc, it is a bit complicated for them to provided the proper tool.

Another thing is that the code here is a quick workable way. Would it be possible to replace these execute_process calls with custom_target + custom command and proper deps relationships(I'm not so familiar with CMake)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the released llvm package contains llvm-tblgen and clang-tblgen tools and that doesn't work with dxc compilation.

No, it would not work. We need the special DXC one.
I was just thinking, if we could achieve the goal without patching dawn, I'd prefer not doing that.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that with cmake flag CMAKE_CROSSCOMPILING, onnxruntime generated NATIVE folder in build-dir and configs with host-cpu-os info (e.g. Generated visual studio project files with x64 arch while target platform is arm64 by setting -A flag). Several third_party repo works but dawn doesn't. Do you think it is possible that we could rely on this?

Another thoughts is that we might host dxc as a third_party repo and compile tools from it when cross-compilation is required.

+ execute_process(
+ COMMAND ${CMAKE_COMMAND} -B ${CMAKE_BINARY_DIR}/native-tools -S . -C ${CMAKE_BINARY_DIR}/_deps/dawn-src/third_party/cmake/caches/PredefinedParams.cmake -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DHLSL_OPTIONAL_PROJS_IN_DEFAULT=OFF -DHLSL_ENABLE_ANALYZE=OFF -DHLSL_OFFICIAL_BUILD=OFF -DHLSL_ENABLE_FIXED_VER=OFF -DHLSL_BUILD_DXILCONV=OFF -DHLSL_INCLUDE_TESTS=OFF -DHLSL_ENABLE_DEBUG_ITERATORS=ON -DENABLE_SPIRV_CODEGEN=OFF -DSPIRV_BUILD_TESTS=OFF -DLLVM_BUILD_RUNTIME=ON -DLLVM_BUILD_EXAMPLES=OFF -DLLVM_BUILD_TESTS=OFF -DLLVM_INCLUDE_TESTS=OFF -DLLVM_INCLUDE_DOCS=OFF -DLLVM_INCLUDE_EXAMPLES=OFF -DLLVM_OPTIMIZED_TABLEGEN=OFF -DLLVM_APPEND_VC_REV=OFF -DLLVM_ENABLE_RTTI=ON -DLLVM_ENABLE_EH=ON -DCLANG_CL=OFF
+ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/_deps/dawn-src/third_party/dxc
+ )
+
+ execute_process(
+ COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR}/native-tools --config=${CMAKE_BUILD_TYPE} --target=llvm-tblgen
+ )
+
+ execute_process(
+ COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR}/native-tools --config=${CMAKE_BUILD_TYPE} --target=clang-tblgen
+ )
+ endif()
+ set(LLVM_TABLEGEN ${CMAKE_BINARY_DIR}/native-tools/${CMAKE_BUILD_TYPE}/bin/llvm-tblgen.exe CACHE STRING "" FORCE)
+ set(CLANG_TABLEGEN ${CMAKE_BINARY_DIR}/native-tools/${CMAKE_BUILD_TYPE}/bin/clang-tblgen.exe CACHE STRING "" FORCE)
+ endif()
+
+
# We use a CMake function so that all these (non-cache) variables are scoped
# only to this function.
set(HLSL_OPTIONAL_PROJS_IN_DEFAULT OFF)
@@ -345,8 +377,17 @@ function(AddSubdirectoryDXC)
unset(sdk_dirs)
message(STATUS "Windows SDK version not found from CMake variable 'CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION', attempted to find from SDK path: ${WIN10_SDK_VERSION}")
endif()
+ if(${CMAKE_SYSTEM_PROCESSOR} STREQUAL "AMD64" OR ${CMAKE_SYSTEM_PROCESSOR} STREQUAL "IA64" OR ${CMAKE_SYSTEM_PROCESSOR} STREQUAL "EM64T")
+ set(DXIL_DLL_ARCH "x64")
+ elseif(${CMAKE_SYSTEM_PROCESSOR} STREQUAL "X86")
+ set(DXIL_DLL_ARCH "x86")
+ elseif(${CMAKE_SYSTEM_PROCESSOR} STREQUAL "ARM64")
+ set(DXIL_DLL_ARCH "arm64")
+ else()
+ set(DXIL_DLL_ARCH "")
+ endif()

- set(DXIL_DLL_PATH "${WIN10_SDK_PATH}/bin/${WIN10_SDK_VERSION}/x64/dxil.dll")
+ set(DXIL_DLL_PATH "${WIN10_SDK_PATH}/bin/${WIN10_SDK_VERSION}/${DXIL_DLL_ARCH}/dxil.dll")
add_custom_target(copy_dxil_dll)
add_custom_command(
TARGET copy_dxil_dll
diff --git a/third_party/cmake/caches/PredefinedParams.cmake b/third_party/cmake/caches/PredefinedParams.cmake
new file mode 100644
index 0000000000..4e54940c50
--- /dev/null
+++ b/third_party/cmake/caches/PredefinedParams.cmake
@@ -0,0 +1,15 @@
+# This file contains the basic options required for building DXC using CMake on
+# *nix platforms. It is passed to CMake using the `-C` flag and gets processed
+# before the root CMakeLists.txt file. Only cached variables persist after this
+# file executes, so all state must be saved into the cache. These variables also
+# will not override explicit command line parameters, and can only read
+# parameters that are specified before the `-C` flag.
+
+set(LLVM_TARGETS_TO_BUILD "None" CACHE STRING "" FORCE)
+set(LLVM_DEFAULT_TARGET_TRIPLE "dxil-ms-dx" CACHE STRING "" FORCE)
+set(CLANG_ENABLE_STATIC_ANALYZER OFF CACHE BOOL "" FORCE)
+set(CLANG_ENABLE_ARCMT OFF CACHE BOOL "" FORCE)
+set(CLANG_BUILD_EXAMPLES OFF CACHE BOOL "" FORCE)
+set(CLANG_INCLUDE_TESTS OFF CACHE BOOL "" FORCE)
+set(LLVM_ENABLE_TERMINFO OFF CACHE BOOL "" FORCE)
+set(CLANG_FORMAT_EXE "" CACHE STRING "" FORCE)
Loading