[SYCL][UR] Add Windows debug libs to install target #17512

kbenzie · 2025-03-18T17:51:16Z

Add install target for Windows debug libs called install-unified-runtime-libraries which installs only the runtime library subset of targets. This can be used to provide ur_loaderd.dll and ur_adatper_<name>d.dll which link against the multithreaded debug DLL C runtime by using the DEBUG_POSTFIX target property to append d to the library names.
Add UR_USE_DEBUG_POSTFIX option to enable adding the d suffix to library names.
Remove setting redundant OUTPUT_NAMEs as combining DEBUG_POSTFIX=d and then setting LIBRARY_OUTPUT_NAME/RUNTIME_OUTPUT_NAME exposes a bug in CMake where the DEBUG_POSTFIX is ignored for the ur_loader.dll. Removing these redundant property setters fixed the previous issue.
Add debug UR subbuild on Windows ExternalProject compiled in debug mode and with the UR_USE_DEBUG_POSTFIX option enabled.
- The resulting libraries are then copied to the <build>/bin/<build>/lib directories so they can be used in testing (not yet implemented).
- Additionally, they are also included in the deploy-sycl-toolchain install target alongside the normally named runtime libraries.
Update ur_proxy_loaderd.dll to use Windows debug libs

unified-runtime/cmake/helpers.cmake

kbenzie

@bratpiorka as mentioned in my last email, here's where to hook in the UMF debug postfix option and copy/install the library to the relevant places.

kbenzie · 2025-03-21T10:41:09Z

sycl/cmake/modules/FetchUnifiedRuntime.cmake

+      -DUMF_LINK_HWLOC_STATICALLY:BOOL=${UMF_LINK_HWLOC_STATICALLY}
+      -DUMF_DISABLE_HWLOC:BOOL=${UMF_DISABLE_HWLOC}
+      # TODO: Enable d suffix in UMF
+      # -DUMF_USE_DEBUG_POSTFIX=ON


Enable building umfd.dll/umfd.lib in the UR subbuild.

kbenzie · 2025-03-21T10:41:45Z

sycl/cmake/modules/FetchUnifiedRuntime.cmake

+    urd_copy_library_to_build(ur_adapter_${adatper}d)
+  endforeach()
+  # TODO: Also copy umfd.dll/umfd.lib
+  # urd_copy_library_to_build(umfd)


Copy umfd.dll/umfd.lib into the parent <build>/bin/<build>/lib directories for use in testing.

kbenzie · 2025-03-21T10:42:22Z

sycl/cmake/modules/FetchUnifiedRuntime.cmake

+  # TODO: Also install umfd.dll/umfd.lib
+  # install(
+  #   FILES ${URD_INSTALL_DIR}/bin/umfd.dll
+  #   DESTINATION "bin" COMPONENT unified-memory-framework)
+  # install(
+  #   FILES ${URD_INSTALL_DIR}/lib/umfd.lib
+  #   DESTINATION "lib${LLVM_LIBDIR_SUFFIX}" COMPONENT unified-memory-framework)


Add umfd.dll/umfd.lib to the install target.

kbenzie · 2025-03-21T10:44:00Z

unified-runtime/cmake/helpers.cmake

+            -P ${CMAKE_BINARY_DIR}/cmake_install.cmake
+        # TODO: Also install debug UMF runtime libraries component
+        DEPENDS unified-runtime-libraries
+        # TODO: Add dependency on building debug UMF libraries


Add command to install only umfd.dll/umfd.lib, we don't want a full install here since we only care about the runtime libraries being installed with the debug postfix.

Please, see changes in oneapi-src/unified-memory-framework#1238

Thanks, I'll test this today.

This is mostly working, I've commented on the PR with one issue.

sycl/cmake/modules/FetchUnifiedRuntime.cmake

This patch adds the `install-unified-runtime-libraries` target which installs only the runtime library subset of targets. This can be used to provide `ur_loaderd.dll` and `ur_adatper_<name>d.dll` which link against the multithreaded debug DLL C runtime by using the `DEBUG_POSTFIX` target property to append `d` to the library names.

Instead of implicitly adding the `d` suffix to library names make this optional. `DEBUG_POSTFIX` appears to be broken on Windows, the place it's most useful, as `urinfo.exe` still attempts to load `ur_loader.dll` when it should be looking for `ur_loaderd.dll`. Switching this over to `OUTPUT_NAME ${name}d` fixes this.

Looks like combining `DEBUG_POSTFIX=d` and then setting `LIBRARY_OUTPUT_NAME`/`RUNTIME_OUTPUT_NAME` exposes a bug in CMake where the `DEBUG_POSTFIX` is ignored for the `ur_loader.dll`. Removing these redundant propert setters fixed the previous issue.

Using ExternalProject this commit adds a subbuild of UR in compiled in debug mode and with the `UR_USE_DEBUG_POSTFIX` option enabled. The resulting libraries are then copied to the `<build>/bin`/`<build>/lib` directories so they can be used in testing (not yet implemented). Additionally, they are also included in the `deploy-sycl-toolchain` install target alongside the normally named runtime libraries.

PatKamin · 2025-03-25T13:26:23Z

sycl/cmake/modules/FetchUnifiedRuntime.cmake

+      --build <BINARY_DIR>
+      --target install-unified-runtime-libraries
+    CMAKE_CACHE_ARGS
+      -DCMAKE_BUILD_TYPE:STRING=Debug


Windows generators might ignore CMAKE_BUILD_TYPE. Consider using a cmake argument --config Debug instead.

That would need to be included in the install command?

Yes, in the install command add: --config Debug. And perhaps leave -DCMAKE_BUILD_TYPE:STRING=Debug here as well, just for the case where Unix Makefiles generator is used on Windows.

steffenlarsen

Looks reasonable to me, but I would like to also hear @cperkinsintel thoughts on this.

PatKamin · 2025-03-27T16:17:31Z

There is a PR with requested changes in UMF if you would like to test them: oneapi-src/unified-memory-framework#1219

steffenlarsen · 2025-04-16T14:14:55Z

@kbenzie - Is this ready to go in (after a conflict resolution?)

kbenzie · 2025-04-16T14:28:23Z

@kbenzie - Is this ready to go in (after a conflict resolution?)

It needs to pull in the UMF changes which I've not tested yet due a few high priority bug reports that have come in this week.

kbenzie temporarily deployed to WindowsCILock March 18, 2025 17:51 — with GitHub Actions Inactive

kbenzie commented Mar 18, 2025

View reviewed changes

unified-runtime/cmake/helpers.cmake Show resolved Hide resolved

kbenzie temporarily deployed to WindowsCILock March 18, 2025 18:21 — with GitHub Actions Inactive

kbenzie temporarily deployed to WindowsCILock March 19, 2025 11:01 — with GitHub Actions Inactive

kbenzie had a problem deploying to WindowsCILock March 19, 2025 11:11 — with GitHub Actions Error

kbenzie temporarily deployed to WindowsCILock March 19, 2025 11:37 — with GitHub Actions Inactive

kbenzie temporarily deployed to WindowsCILock March 19, 2025 11:47 — with GitHub Actions Inactive

kbenzie force-pushed the benie/ur-debug-lib-suffix branch from 8a462bf to 3c4e12e Compare March 20, 2025 14:45

kbenzie temporarily deployed to WindowsCILock March 20, 2025 14:45 — with GitHub Actions Inactive

kbenzie had a problem deploying to WindowsCILock March 20, 2025 15:09 — with GitHub Actions Error

kbenzie temporarily deployed to WindowsCILock March 20, 2025 15:09 — with GitHub Actions Inactive

kbenzie had a problem deploying to WindowsCILock March 20, 2025 17:42 — with GitHub Actions Error

kbenzie force-pushed the benie/ur-debug-lib-suffix branch from 613d83b to a448455 Compare March 20, 2025 17:44

kbenzie temporarily deployed to WindowsCILock March 20, 2025 17:44 — with GitHub Actions Inactive

kbenzie temporarily deployed to WindowsCILock March 20, 2025 18:34 — with GitHub Actions Inactive

kbenzie marked this pull request as ready for review March 21, 2025 10:44

kbenzie requested review from a team as code owners March 21, 2025 10:44

kbenzie requested a review from KseniyaTikhomirova March 21, 2025 10:44

kbenzie commented Mar 21, 2025

View reviewed changes

kbenzie requested review from bratpiorka and steffenlarsen March 21, 2025 10:45

kbenzie changed the title ~~[UR] Add install target for Windows debug libs~~ [SYCL][UR] Add Windows debug libs to install target Mar 21, 2025

aarongreig approved these changes Mar 21, 2025

View reviewed changes

sycl/cmake/modules/FetchUnifiedRuntime.cmake Outdated Show resolved Hide resolved

sycl/cmake/modules/FetchUnifiedRuntime.cmake Outdated Show resolved Hide resolved

kbenzie added 2 commits March 21, 2025 11:33

kbenzie added 4 commits March 21, 2025 11:33

[SYCL][UR] Update proxy loader to use Windows debug libs

1b820ed

[UR] Fix typos

468c07c

kbenzie force-pushed the benie/ur-debug-lib-suffix branch from a448455 to 468c07c Compare March 21, 2025 11:35

kbenzie temporarily deployed to WindowsCILock March 21, 2025 11:36 — with GitHub Actions Inactive

kbenzie temporarily deployed to WindowsCILock March 21, 2025 11:51 — with GitHub Actions Inactive

PatKamin approved these changes Mar 21, 2025

View reviewed changes

bratpiorka approved these changes Mar 21, 2025

View reviewed changes

PatKamin mentioned this pull request Mar 25, 2025

Install debug libraries on Windows oneapi-src/unified-memory-framework#1219

Merged

11 tasks

PatKamin reviewed Mar 25, 2025

View reviewed changes

steffenlarsen approved these changes Mar 26, 2025

View reviewed changes

steffenlarsen requested a review from cperkinsintel March 26, 2025 12:42

cperkinsintel approved these changes Mar 27, 2025

View reviewed changes

KseniyaTikhomirova approved these changes Mar 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SYCL][UR] Add Windows debug libs to install target #17512

[SYCL][UR] Add Windows debug libs to install target #17512

kbenzie commented Mar 18, 2025 •

edited

Loading

kbenzie left a comment

kbenzie Mar 21, 2025

kbenzie Mar 21, 2025

kbenzie Mar 21, 2025

kbenzie Mar 21, 2025

PatKamin Apr 4, 2025

kbenzie Apr 4, 2025

kbenzie Apr 4, 2025

PatKamin Mar 25, 2025

kbenzie Apr 1, 2025

PatKamin Apr 1, 2025

steffenlarsen left a comment

PatKamin commented Mar 27, 2025

steffenlarsen commented Apr 16, 2025

kbenzie commented Apr 16, 2025

[SYCL][UR] Add Windows debug libs to install target #17512

Are you sure you want to change the base?

[SYCL][UR] Add Windows debug libs to install target #17512

Conversation

kbenzie commented Mar 18, 2025 • edited Loading

kbenzie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steffenlarsen left a comment

Choose a reason for hiding this comment

PatKamin commented Mar 27, 2025

steffenlarsen commented Apr 16, 2025

kbenzie commented Apr 16, 2025

kbenzie commented Mar 18, 2025 •

edited

Loading