Fix wasm build with WebGPU EP

microsoft · Jan 11, 2025 · 4e7317c · 4e7317c
1 parent 81ee27f
commit 4e7317c
Show file tree

Hide file tree

Showing 22 changed files with 702 additions and 147 deletions.
diff --git a/cmake/external/onnxruntime_external_deps.cmake b/cmake/external/onnxruntime_external_deps.cmake
@@ -631,78 +631,92 @@ if (onnxruntime_USE_WEBGPU)
       URL_HASH SHA1=${DEP_SHA1_dawn}
       # All previous patches are merged into the upstream dawn project. We don't need to apply any patches right now.
       # if we need to apply patches in the future, we can uncomment the following line.
-      # PATCH_COMMAND ${Patch_EXECUTABLE} --binary --ignore-whitespace -p1 < ${PROJECT_SOURCE_DIR}/patches/dawn/dawn.patch
+      PATCH_COMMAND ${Patch_EXECUTABLE} --binary --ignore-whitespace -p1 < ${PROJECT_SOURCE_DIR}/patches/dawn/dawn.patch
     )
   endif()
 
-  if (onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY)
-    set(DAWN_BUILD_MONOLITHIC_LIBRARY ON CACHE BOOL "" FORCE)
-    set(DAWN_ENABLE_INSTALL ON CACHE BOOL "" FORCE)
-
-    if (onnxruntime_USE_EXTERNAL_DAWN)
-      message(FATAL_ERROR "onnxruntime_USE_EXTERNAL_DAWN and onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY cannot be enabled at the same time.")
-    endif()
-  else()
-    # use dawn::dawn_native and dawn::dawn_proc instead of the monolithic dawn::webgpu_dawn to minimize binary size
-    set(DAWN_BUILD_MONOLITHIC_LIBRARY OFF CACHE BOOL "" FORCE)
-    set(DAWN_ENABLE_INSTALL OFF CACHE BOOL "" FORCE)
-  endif()
   set(DAWN_BUILD_SAMPLES OFF CACHE BOOL "" FORCE)
   set(DAWN_ENABLE_NULL OFF CACHE BOOL "" FORCE)
   set(DAWN_FETCH_DEPENDENCIES ON CACHE BOOL "" FORCE)
 
-  # disable things we don't use
-  set(DAWN_DXC_ENABLE_ASSERTS_IN_NDEBUG OFF)
-  set(DAWN_ENABLE_DESKTOP_GL OFF CACHE BOOL "" FORCE)
-  set(DAWN_ENABLE_OPENGLES OFF CACHE BOOL "" FORCE)
-  set(DAWN_SUPPORTS_GLFW_FOR_WINDOWING OFF CACHE BOOL "" FORCE)
-  set(DAWN_USE_GLFW OFF CACHE BOOL "" FORCE)
-  set(DAWN_USE_WINDOWS_UI OFF CACHE BOOL "" FORCE)
-  set(DAWN_USE_X11 OFF CACHE BOOL "" FORCE)
-
-  set(TINT_BUILD_TESTS OFF CACHE BOOL "" FORCE)
-  set(TINT_BUILD_CMD_TOOLS OFF CACHE BOOL "" FORCE)
-  set(TINT_BUILD_GLSL_WRITER OFF CACHE BOOL "" FORCE)
-  set(TINT_BUILD_GLSL_VALIDATOR OFF CACHE BOOL "" FORCE)
-  set(TINT_BUILD_IR_BINARY OFF CACHE BOOL "" FORCE)
-  set(TINT_BUILD_SPV_READER OFF CACHE BOOL "" FORCE)  # don't need. disabling is a large binary size saving
-  set(TINT_BUILD_WGSL_WRITER ON CACHE BOOL "" FORCE)  # needed to create cache key. runtime error if not enabled.
-
-  # SPIR-V validation shouldn't be required given we're using Tint to create the SPIR-V.
-  set(DAWN_ENABLE_SPIRV_VALIDATION OFF CACHE BOOL "" FORCE)
-
-  if (WIN32)
-    # building this requires the HLSL writer to be enabled in Tint. TBD if that we need either of these to be ON.
-    set(DAWN_USE_BUILT_DXC ON CACHE BOOL "" FORCE)
-    set(TINT_BUILD_HLSL_WRITER ON CACHE BOOL "" FORCE)
-
-    if ((NOT onnxruntime_ENABLE_DAWN_BACKEND_VULKAN) AND (NOT onnxruntime_ENABLE_DAWN_BACKEND_D3D12))
-      message(FATAL_ERROR "At least one of onnxruntime_ENABLE_DAWN_BACKEND_VULKAN or onnxruntime_ENABLE_DAWN_BACKEND_D3D12 must be enabled when using Dawn on Windows.")
-    endif()
-    if (onnxruntime_ENABLE_DAWN_BACKEND_VULKAN)
-      set(DAWN_ENABLE_VULKAN ON CACHE BOOL "" FORCE)
-      set(TINT_BUILD_SPV_WRITER ON CACHE BOOL "" FORCE)
+  if (CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
+    set(DAWN_EMSCRIPTEN_TOOLCHAIN "${REPO_ROOT}/cmake/external/emsdk/upstream/emscripten" CACHE STRING "" FORCE)
+
+    # file "${DAWN_EMSCRIPTEN_TOOLCHAIN}/tools/maint/gen_struct_info.py" is missing from emsdk installation.
+    # we should copy if from ${PROJECT_SOURCE_DIR}/patches/
+    file(COPY_FILE
+         "${PROJECT_SOURCE_DIR}/patches/emscripten/tools/maint/gen_struct_info.py"
+         "${DAWN_EMSCRIPTEN_TOOLCHAIN}/tools/maint/gen_struct_info.py"
+         ONLY_IF_DIFFERENT)
+  else()
+    if (onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY)
+      set(DAWN_BUILD_MONOLITHIC_LIBRARY ON CACHE BOOL "" FORCE)
+      set(DAWN_ENABLE_INSTALL ON CACHE BOOL "" FORCE)
+
+      if (onnxruntime_USE_EXTERNAL_DAWN)
+        message(FATAL_ERROR "onnxruntime_USE_EXTERNAL_DAWN and onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY cannot be enabled at the same time.")
+      endif()
     else()
-      set(DAWN_ENABLE_VULKAN OFF CACHE BOOL "" FORCE)
+      # use dawn::dawn_native and dawn::dawn_proc instead of the monolithic dawn::webgpu_dawn to minimize binary size
+      set(DAWN_BUILD_MONOLITHIC_LIBRARY OFF CACHE BOOL "" FORCE)
+      set(DAWN_ENABLE_INSTALL OFF CACHE BOOL "" FORCE)
     endif()
-    if (onnxruntime_ENABLE_DAWN_BACKEND_D3D12)
-      set(DAWN_ENABLE_D3D12 ON CACHE BOOL "" FORCE)
-    else()
-      set(DAWN_ENABLE_D3D12 OFF CACHE BOOL "" FORCE)
+
+    # disable things we don't use
+    set(DAWN_DXC_ENABLE_ASSERTS_IN_NDEBUG OFF)
+    set(DAWN_ENABLE_DESKTOP_GL OFF CACHE BOOL "" FORCE)
+    set(DAWN_ENABLE_OPENGLES OFF CACHE BOOL "" FORCE)
+    set(DAWN_SUPPORTS_GLFW_FOR_WINDOWING OFF CACHE BOOL "" FORCE)
+    set(DAWN_USE_GLFW OFF CACHE BOOL "" FORCE)
+    set(DAWN_USE_WINDOWS_UI OFF CACHE BOOL "" FORCE)
+    set(DAWN_USE_X11 OFF CACHE BOOL "" FORCE)
+
+    set(TINT_BUILD_TESTS OFF CACHE BOOL "" FORCE)
+    set(TINT_BUILD_CMD_TOOLS OFF CACHE BOOL "" FORCE)
+    set(TINT_BUILD_GLSL_WRITER OFF CACHE BOOL "" FORCE)
+    set(TINT_BUILD_GLSL_VALIDATOR OFF CACHE BOOL "" FORCE)
+    set(TINT_BUILD_IR_BINARY OFF CACHE BOOL "" FORCE)
+    set(TINT_BUILD_SPV_READER OFF CACHE BOOL "" FORCE)  # don't need. disabling is a large binary size saving
+    set(TINT_BUILD_WGSL_WRITER ON CACHE BOOL "" FORCE)  # needed to create cache key. runtime error if not enabled.
+
+    # SPIR-V validation shouldn't be required given we're using Tint to create the SPIR-V.
+    set(DAWN_ENABLE_SPIRV_VALIDATION OFF CACHE BOOL "" FORCE)
+
+    if (WIN32)
+      # building this requires the HLSL writer to be enabled in Tint. TBD if that we need either of these to be ON.
+      set(DAWN_USE_BUILT_DXC ON CACHE BOOL "" FORCE)
+      set(TINT_BUILD_HLSL_WRITER ON CACHE BOOL "" FORCE)
+
+      if ((NOT onnxruntime_ENABLE_DAWN_BACKEND_VULKAN) AND (NOT onnxruntime_ENABLE_DAWN_BACKEND_D3D12))
+        message(FATAL_ERROR "At least one of onnxruntime_ENABLE_DAWN_BACKEND_VULKAN or onnxruntime_ENABLE_DAWN_BACKEND_D3D12 must be enabled when using Dawn on Windows.")
+      endif()
+      if (onnxruntime_ENABLE_DAWN_BACKEND_VULKAN)
+        set(DAWN_ENABLE_VULKAN ON CACHE BOOL "" FORCE)
+        set(TINT_BUILD_SPV_WRITER ON CACHE BOOL "" FORCE)
+      else()
+        set(DAWN_ENABLE_VULKAN OFF CACHE BOOL "" FORCE)
+      endif()
+      if (onnxruntime_ENABLE_DAWN_BACKEND_D3D12)
+        set(DAWN_ENABLE_D3D12 ON CACHE BOOL "" FORCE)
+      else()
+        set(DAWN_ENABLE_D3D12 OFF CACHE BOOL "" FORCE)
+      endif()
+      # We are currently always using the D3D12 backend.
+      set(DAWN_ENABLE_D3D11 OFF CACHE BOOL "" FORCE)
     endif()
-    # We are currently always using the D3D12 backend.
-    set(DAWN_ENABLE_D3D11 OFF CACHE BOOL "" FORCE)
   endif()
 
   onnxruntime_fetchcontent_makeavailable(dawn)
 
-  if (onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY)
-    list(APPEND onnxruntime_EXTERNAL_LIBRARIES dawn::webgpu_dawn)
-  else()
-    if (NOT onnxruntime_USE_EXTERNAL_DAWN)
-      list(APPEND onnxruntime_EXTERNAL_LIBRARIES dawn::dawn_native)
+  if (NOT CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
+    if (onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY)
+      list(APPEND onnxruntime_EXTERNAL_LIBRARIES dawn::webgpu_dawn)
+    else()
+      if (NOT onnxruntime_USE_EXTERNAL_DAWN)
+        list(APPEND onnxruntime_EXTERNAL_LIBRARIES dawn::dawn_native)
+      endif()
+      list(APPEND onnxruntime_EXTERNAL_LIBRARIES dawn::dawn_proc)
     endif()
-    list(APPEND onnxruntime_EXTERNAL_LIBRARIES dawn::dawn_proc)
   endif()
 endif()
 

diff --git a/cmake/onnxruntime_providers_webgpu.cmake b/cmake/onnxruntime_providers_webgpu.cmake
@@ -21,44 +21,57 @@
   source_group(TREE ${REPO_ROOT} FILES ${onnxruntime_providers_webgpu_cc_srcs})
   onnxruntime_add_static_library(onnxruntime_providers_webgpu ${onnxruntime_providers_webgpu_cc_srcs})
   onnxruntime_add_include_to_target(onnxruntime_providers_webgpu
-    onnxruntime_common dawn::dawncpp_headers dawn::dawn_headers onnx onnx_proto flatbuffers::flatbuffers Boost::mp11 safeint_interface)
+    onnxruntime_common onnx onnx_proto flatbuffers::flatbuffers Boost::mp11 safeint_interface)
 
-  set(onnxruntime_providers_webgpu_dll_deps)
+  if (CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
+    # if "-s DISABLE_EXCEPTION_CATCHING=0" is globally set, we need to remove "-fno-exceptions" from emdawnwebgpu_c
+    if (CMAKE_CXX_FLAGS MATCHES "DISABLE_EXCEPTION_CATCHING=0")
+      get_property(EM_DAWN_WEBGPU_C_COMPILE_OPTIONS TARGET emdawnwebgpu_c PROPERTY COMPILE_OPTIONS)
+      list(REMOVE_ITEM EM_DAWN_WEBGPU_C_COMPILE_OPTIONS "-fno-exceptions")
+      set_property(TARGET emdawnwebgpu_c PROPERTY COMPILE_OPTIONS ${EM_DAWN_WEBGPU_C_COMPILE_OPTIONS})
+    endif()
 
-  if (onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY)
-    target_link_libraries(onnxruntime_providers_webgpu dawn::webgpu_dawn)
+    target_link_libraries(onnxruntime_providers_webgpu PUBLIC emdawnwebgpu_cpp)
+  else()
+    onnxruntime_add_include_to_target(onnxruntime_providers_webgpu dawn::dawncpp_headers dawn::dawn_headers)
 
-    if (WIN32)
-      if (onnxruntime_ENABLE_DELAY_LOADING_WIN_DLLS)
-        list(APPEND onnxruntime_DELAYLOAD_FLAGS "/DELAYLOAD:webgpu_dawn.dll")
-      endif()
+    set(onnxruntime_providers_webgpu_dll_deps)
 
-      list(APPEND onnxruntime_providers_webgpu_dll_deps "$<TARGET_FILE:dawn::webgpu_dawn>")
-    endif()
-  else()
-    if (NOT onnxruntime_USE_EXTERNAL_DAWN)
-      target_link_libraries(onnxruntime_providers_webgpu dawn::dawn_native)
+    if (onnxruntime_BUILD_DAWN_MONOLITHIC_LIBRARY)
+      target_link_libraries(onnxruntime_providers_webgpu dawn::webgpu_dawn)
+
+      if (WIN32)
+        if (onnxruntime_ENABLE_DELAY_LOADING_WIN_DLLS)
+          list(APPEND onnxruntime_DELAYLOAD_FLAGS "/DELAYLOAD:webgpu_dawn.dll")
+        endif()
+
+        list(APPEND onnxruntime_providers_webgpu_dll_deps "$<TARGET_FILE:dawn::webgpu_dawn>")
+      endif()
+    else()
+      if (NOT onnxruntime_USE_EXTERNAL_DAWN)
+        target_link_libraries(onnxruntime_providers_webgpu dawn::dawn_native)
+      endif()
+      target_link_libraries(onnxruntime_providers_webgpu dawn::dawn_proc)
     endif()
-    target_link_libraries(onnxruntime_providers_webgpu dawn::dawn_proc)
-  endif()
 
-  if (WIN32 AND onnxruntime_ENABLE_DAWN_BACKEND_D3D12)
-    # Ensure dxil.dll and dxcompiler.dll exist in the output directory $<TARGET_FILE_DIR:dxcompiler>
-    add_dependencies(onnxruntime_providers_webgpu copy_dxil_dll)
-    add_dependencies(onnxruntime_providers_webgpu dxcompiler)
+    if (WIN32 AND onnxruntime_ENABLE_DAWN_BACKEND_D3D12)
+      # Ensure dxil.dll and dxcompiler.dll exist in the output directory $<TARGET_FILE_DIR:dxcompiler>
+      add_dependencies(onnxruntime_providers_webgpu copy_dxil_dll)
+      add_dependencies(onnxruntime_providers_webgpu dxcompiler)
 
-    list(APPEND onnxruntime_providers_webgpu_dll_deps "$<TARGET_FILE_DIR:dxcompiler>/dxil.dll")
-    list(APPEND onnxruntime_providers_webgpu_dll_deps "$<TARGET_FILE_DIR:dxcompiler>/dxcompiler.dll")
-  endif()
+      list(APPEND onnxruntime_providers_webgpu_dll_deps "$<TARGET_FILE_DIR:dxcompiler>/dxil.dll")
+      list(APPEND onnxruntime_providers_webgpu_dll_deps "$<TARGET_FILE_DIR:dxcompiler>/dxcompiler.dll")
+    endif()
 
-  if (onnxruntime_providers_webgpu_dll_deps)
-    # Copy dependency DLLs to the output directory
-    add_custom_command(
-      TARGET onnxruntime_providers_webgpu
-      POST_BUILD
-      COMMAND ${CMAKE_COMMAND} -E copy_if_different "${onnxruntime_providers_webgpu_dll_deps}" "$<TARGET_FILE_DIR:onnxruntime_providers_webgpu>"
-      COMMAND_EXPAND_LISTS
-      VERBATIM )
+    if (onnxruntime_providers_webgpu_dll_deps)
+      # Copy dependency DLLs to the output directory
+      add_custom_command(
+        TARGET onnxruntime_providers_webgpu
+        POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different "${onnxruntime_providers_webgpu_dll_deps}" "$<TARGET_FILE_DIR:onnxruntime_providers_webgpu>"
+        COMMAND_EXPAND_LISTS
+        VERBATIM )
+    endif()
   endif()
 
   add_dependencies(onnxruntime_providers_webgpu ${onnxruntime_EXTERNAL_DEPENDENCIES})

diff --git a/cmake/onnxruntime_webassembly.cmake b/cmake/onnxruntime_webassembly.cmake
@@ -111,6 +111,7 @@ if (onnxruntime_BUILD_WEBASSEMBLY_STATIC_LIB)
       ${PROVIDERS_JS}
       ${PROVIDERS_XNNPACK}
       ${PROVIDERS_WEBNN}
+      ${PROVIDERS_WEBGPU}
       onnxruntime_session
       onnxruntime_util
       re2::re2
@@ -188,6 +189,7 @@ else()
     ${PROVIDERS_JS}
     ${PROVIDERS_XNNPACK}
     ${PROVIDERS_WEBNN}
+    ${PROVIDERS_WEBGPU}
     onnxruntime_session
     onnxruntime_util
     re2::re2
@@ -391,6 +393,11 @@ jsepDownload:_pp_")
     endif()
   endif()
 
+  if (onnxruntime_USE_WEBGPU)
+    target_compile_definitions(onnxruntime_webassembly PRIVATE USE_WEBGPU=1)
+    # target_link_libraries(onnxruntime_webassembly PUBLIC emdawnwebgpu_cpp)
+  endif()
+
   if (onnxruntime_EMSCRIPTEN_SETTINGS)
     foreach(setting IN LISTS onnxruntime_EMSCRIPTEN_SETTINGS)
       target_link_options(onnxruntime_webassembly PRIVATE "SHELL:-s ${setting}")

diff --git a/cmake/patches/dawn/dawn.patch b/cmake/patches/dawn/dawn.patch
@@ -0,0 +1,12 @@
+diff --git a/src/emdawnwebgpu/CMakeLists.txt b/src/emdawnwebgpu/CMakeLists.txt
+index de673537d3..c98dc46de7 100644
+--- a/src/emdawnwebgpu/CMakeLists.txt
++++ b/src/emdawnwebgpu/CMakeLists.txt
+@@ -78,6 +78,7 @@ if (${DAWN_ENABLE_EMSCRIPTEN})
+         endif()
+
+         set(ARGS
++            ${Python3_EXECUTABLE}
+             "${DAWN_EMSCRIPTEN_TOOLCHAIN}/tools/maint/gen_struct_info.py"
+             -q
+             "${EM_BUILD_GEN_DIR}/struct_info_webgpu.json"