Merge pull request #1875 from kswiecicki/static-linking-loader

Add option to build loader as a static library

Author: pbalcer

.github/workflows/build-hw-reusable.yml

@@ -11,6 +11,10 @@ on:
         required: false
         type: string
         default: ""
+      static_loader:
+        required: false
+        type: string
+        default: OFF
 
 permissions:
   contents: read
@@ -29,14 +33,19 @@ jobs:
     strategy:
       matrix:
         adapter: [
-          {name: "${{inputs.name}}", platform: "${{inputs.platform}}"},
+          {name: "${{inputs.name}}", platform: "${{inputs.platform}}", static_Loader: "${{inputs.static_loader}}"},
         ]
         build_type: [Debug, Release]
         compiler: [{c: gcc, cxx: g++}, {c: clang, cxx: clang++}]
         # TODO: The latest L0 loader segfaults when built with clang.
         exclude:
          - adapter: {name: L0, platform: ""}
            compiler: {c: clang, cxx: clang++}
+        # Exclude these configurations to avoid overloading the runners.
+         - adapter: {static_Loader: ON}
+           build_type: Release
+         - adapter: {static_Loader: ON}
+           compiler: {c: clang, cxx: clang++}
 
     runs-on: ${{matrix.adapter.name}}
 
@@ -63,6 +72,7 @@ jobs:
         -DUR_DEVELOPER_MODE=ON
         -DUR_BUILD_TESTS=ON
         -DUR_BUILD_ADAPTER_${{matrix.adapter.name}}=ON
+        -DUR_STATIC_LOADER=${{matrix.adapter.static_Loader}}
         -DUR_DPCXX=${{github.workspace}}/dpcpp_compiler/bin/clang++
         -DUR_SYCL_LIBRARY_DIR=${{github.workspace}}/dpcpp_compiler/lib
         ${{ matrix.adapter.name == 'HIP' && '-DUR_CONFORMANCE_AMD_ARCH=gfx1030' || '' }}

.github/workflows/cmake.yml

@@ -121,13 +121,20 @@ jobs:
     uses: ./.github/workflows/build-fuzz-reusable.yml
     with:
       test_label: "fuzz-short"
-    
+
   level-zero:
     name: Level Zero
     uses: ./.github/workflows/build-hw-reusable.yml
     with:
       name: L0
 
+  level-zero-static:
+    name: Level Zero static
+    uses: ./.github/workflows/build-hw-reusable.yml
+    with:
+      name: L0
+      static_loader: ON
+
   opencl:
     name: OpenCL
     uses: ./.github/workflows/build-hw-reusable.yml

CMakeLists.txt

@@ -49,6 +49,7 @@ option(UR_BUILD_EXAMPLE_CODEGEN "Build the codegen example." OFF)
 option(VAL_USE_LIBBACKTRACE_BACKTRACE "enable libbacktrace validation backtrace for linux" OFF)
 option(UR_ENABLE_ASSERTIONS "Enable assertions for all build types" OFF)
 option(UR_BUILD_XPTI_LIBS "Build the XPTI libraries when tracing is enabled" ON)
+option(UR_STATIC_LOADER "Build loader as a static library" OFF)
 set(UR_DPCXX "" CACHE FILEPATH "Path of the DPC++ compiler executable")
 set(UR_DPCXX_BUILD_FLAGS "" CACHE STRING "Build flags to pass to DPC++ when compiling device programs")
 set(UR_SYCL_LIBRARY_DIR "" CACHE PATH
@@ -134,6 +135,15 @@ if(UR_ENABLE_TRACING)
         set_target_properties(xptifw PROPERTIES
             LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
         )
+
+        if (UR_STATIC_LOADER)
+            install(TARGETS xpti xptifw
+                EXPORT ${PROJECT_NAME}-targets
+                ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+                RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+                LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            )
+        endif()
     endif()
 
     if (MSVC)
@@ -179,7 +189,7 @@ endif()
 if(UR_FORMAT_CPP_STYLE)
     find_program(CLANG_FORMAT NAMES clang-format-15 clang-format-15.0 clang-format)
 
-    if(CLANG_FORMAT)        
+    if(CLANG_FORMAT)
         get_program_version_major_minor(${CLANG_FORMAT} CLANG_FORMAT_VERSION)
         message(STATUS "Found clang-format: ${CLANG_FORMAT} (version: ${CLANG_FORMAT_VERSION})")
 

source/common/CMakeLists.txt

@@ -12,11 +12,12 @@ add_ur_library(ur_common STATIC
     $<$<PLATFORM_ID:Windows>:windows/ur_lib_loader.cpp>
     $<$<PLATFORM_ID:Linux,Darwin>:linux/ur_lib_loader.cpp>
 )
+
 add_library(${PROJECT_NAME}::common ALIAS ur_common)
 
 target_include_directories(ur_common PUBLIC
-    ${CMAKE_CURRENT_SOURCE_DIR}
-    ${CMAKE_SOURCE_DIR}/include
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/include>
 )
 
 message(STATUS "Download Unified Memory Framework from github.com")
@@ -62,3 +63,10 @@ if (UNIX)
     find_package(Threads REQUIRED)
     target_link_libraries(ur_common PUBLIC Threads::Threads)
 endif()
+
+install(TARGETS ur_common
+    EXPORT ${PROJECT_NAME}-targets
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+)

source/loader/CMakeLists.txt

@@ -9,16 +9,21 @@ configure_file(
     @ONLY
 )
 
+set(LOADER_LIB_TYPE SHARED)
+if(UR_STATIC_LOADER)
+  set(LOADER_LIB_TYPE STATIC)
+endif()
+
 add_ur_library(ur_loader
-    SHARED
+    ${LOADER_LIB_TYPE}
     ""
     ${CMAKE_CURRENT_BINARY_DIR}/UrLoaderVersion.rc
 )
 
 if (MSVC)
     set(TARGET_LIBNAME ur_loader)
     string(TOUPPER ${TARGET_LIBNAME} TARGET_LIBNAME)
-    
+
     set(LOADER_VERSION_SCRIPT ${CMAKE_CURRENT_BINARY_DIR}/ur_loader.def)
     configure_file(${CMAKE_CURRENT_SOURCE_DIR}/loader.def.in ${LOADER_VERSION_SCRIPT} @ONLY)
     set_target_properties(ur_loader PROPERTIES