Static L0 Loader Support

.github/workflows/build-multi-static.yml

@@ -0,0 +1,160 @@
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+permissions: read-all
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  config:
+    if: github.repository_owner == 'oneapi-src'
+    runs-on: ubuntu-latest
+    outputs:
+      short-sha: ${{ steps.const.outputs.short-sha }}
+      ref-slug: ${{ steps.const.outputs.ref-slug }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        clean: true
+        ref: ${{ github.event.pull_request.head.sha }}
+    - name: Set constants
+      id: const
+      run: |
+        cat >> ${GITHUB_OUTPUT} <<EOF
+        short-sha=$(git rev-parse --short=7 ${GITHUB_SHA})
+        ref-slug=$(echo ${{ github.ref_name }} | tr '/_' '-')
+        EOF
+
+  build:
+    # Notes on formatting:
+    #
+    # GitHub Actions expressions ${{ ... }} are used wherever possible so the
+    # evaluation results are plainly visible in the web console.
+    #
+    # Note the mixed spaces and tabs in the heredocs, see the bash man page
+    # entry for <<- in the Here Documents section. This allows generated code to
+    # be indented for readability in the workflow output.
+    if: github.repository_owner == 'oneapi-src'
+    needs: [config]
+    runs-on: ${{ matrix.os.name == 'windows' && 'windows-latest' || 'ubuntu-latest' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [
+          {name: ubuntu, vmaj: 20, vmin: '04'},
+          {name: ubuntu, vmaj: 22, vmin: '04'},
+          {name: ubuntu, vmaj: 24, vmin: '04'},
+          {name: ubuntu, vmaj: 24, vmin: '10'},
+          {name: sles, vmaj: 15, vmin: 2},
+          {name: sles, vmaj: 15, vmin: 3},
+          {name: sles, vmaj: 15, vmin: 4},
+          {name: rhel, vmaj: 8, vmin: 6},
+          {name: windows}
+        ]
+        target: [install, package]
+        arch: ['']
+        include: [
+          {os: {name: ubuntu, vmaj: 20, vmin: '04'}, target: install, arch: arm64},
+          {os: {name: ubuntu, vmaj: 20, vmin: '04'}, target: package, arch: arm64}
+        ]
+    env:
+      MSYS_NO_PATHCONV: 1
+      MOUNT_TARGET:  ${{ matrix.os.name == 'windows' && 'C:/project' || '/project' }}
+      # -j breaks the Visual Studio configuration selection
+      PARALLEL: ${{ ! (matrix.os.name == 'windows') && '-j' || '' }}
+      ARCH_SUFFIX: ${{ matrix.arch != '' && format('_{0}', matrix.arch) || '' }}
+    steps:
+    - name: Set constants
+      id: const
+      env:
+        OS_STRING: >-
+          ${{ matrix.os.name == 'windows' && 'windows' ||
+              format('{0}-{1}.{2}',
+                matrix.os.name,
+                matrix.os.vmaj,
+                matrix.os.vmin
+              )
+          }}
+        CCACHE_DIR: ${{ github.workspace }}/ccache
+      run: |
+        cat >> ${GITHUB_OUTPUT} <<EOF
+        os-string=${OS_STRING}
+        image-name=ghcr.io/${{ github.repository }}/${OS_STRING}
+        ccache-dir=${CCACHE_DIR}
+        EOF
+    - uses: actions/checkout@v4
+      with:
+        clean: true
+        fetch-depth: 0
+        ref: ${{ github.event.pull_request.head.sha }}
+    - name: Create Ccache directory
+      run: mkdir -p '${{ steps.const.outputs.ccache-dir }}'
+    - name: Ccache
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.const.outputs.ccache-dir }}
+        key: ccache-${{ github.job }}-${{ steps.const.outputs.os-string }}${{ env.ARCH_SUFFIX }}-${{ matrix.target }}-${{ github.sha }}
+        restore-keys: ccache-${{ github.job }}-${{ steps.const.outputs.os-string }}${{ env.ARCH_SUFFIX }}-${{ matrix.target }}-
+    - name: Compute image name
+      run: echo "DOCKER_IMAGE=localhost/${{ github.repository }}/${{ steps.const.outputs.os-string }}" >> ${GITHUB_ENV}
+    - name: "Registry login: ghcr.io"
+      run: |
+        echo ${{ secrets.GITHUB_TOKEN }} |
+        docker login -u sys-lzdev --password-stdin ghcr.io
+    - name: Build image
+      run: |
+        docker info
+        docker build \
+        ${{ runner.os == 'Windows' && '  \
+          --memory 16G ' || '  '
+        }}\
+        ${{ matrix.os.vmaj != '' && format('  \
+          --build-arg VMAJ={0} \
+          --build-arg VMIN={1} ', matrix.os.vmaj, matrix.os.vmin) || '  '
+        }}\
+          --pull \
+          --tag ${DOCKER_IMAGE}:${{ needs.config.outputs.ref-slug }} \
+          - < .github/docker/${{ matrix.os.name }}.Dockerfile
+    - name: Build
+      id: build
+      run: |
+        mkdir build
+        docker run \
+          --rm \
+          --interactive \
+          -v '${{ github.workspace }}':${MOUNT_TARGET} \
+          -w ${MOUNT_TARGET}/build \
+          -e CCACHE_BASEDIR=${MOUNT_TARGET} \
+          -e CCACHE_DIR=${MOUNT_TARGET}/ccache \
+          -v '${{ steps.const.outputs.ccache-dir }}':${MOUNT_TARGET}/ccache \
+          ${DOCKER_IMAGE}:${{ needs.config.outputs.ref-slug }} \
+          bash -e -x <<-EOF
+
+        	cmake \
+        ${{ matrix.os.name != 'windows' && '	  \
+        	  -G Ninja ' || '	  '
+        }}\
+        ${{ matrix.arch == 'arm64' && '	  \
+        	  -D CMAKE_C_COMPILER=aarch64-linux-gnu-gcc \
+        	  -D CMAKE_CXX_COMPILER=aarch64-linux-gnu-g++ \
+        	  -D CMAKE_SYSTEM_PROCESSOR=aarch64 ' || '	  '
+        }}\
+        	  -D CMAKE_C_COMPILER_LAUNCHER=ccache \
+        	  -D CMAKE_CXX_COMPILER_LAUNCHER=ccache \
+        	  -D CMAKE_BUILD_TYPE=Release \
+        	  -D BUILD_STATIC=1 \
+        	  -D CMAKE_INSTALL_PREFIX=${{ matrix.target == 'install' && '../level-zero-install' || matrix.target == 'package' && '/usr' || '' }} \
+        	  -D CPACK_OUTPUT_FILE_PREFIX=${MOUNT_TARGET}/level-zero-package \
+        	  ..
+
+        	cmake --build . ${PARALLEL} --target ${{ matrix.target }} ${{ matrix.os.name == 'windows' && '--config Release' || '' }}
+
+        	ccache --show-stats
+
+        	EOF

.github/workflows/build-quick-static.yml

@@ -0,0 +1,62 @@
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+permissions: read-all
+
+jobs:
+  build-linux:
+    if: github.repository_owner == 'oneapi-src'
+    runs-on: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: hendrikmuhs/ccache-action@v1
+      - name: Build Static Loader on Latest Ubuntu
+        run: |
+          mkdir build
+          cd build
+          cmake \
+            -D CMAKE_C_COMPILER_LAUNCHER=ccache \
+            -D CMAKE_CXX_COMPILER_LAUNCHER=ccache \
+            -D CMAKE_BUILD_TYPE=Release \
+            -D BUILD_L0_LOADER_TESTS=1 \
+            -D BUILD_STATIC=1 \
+            ..
+          make -j$(nproc)
+      - name: Build Dynamic Loader on Latest Ubuntu
+        run: |
+            cd ${{ github.workspace }}
+            mkdir dynamic_build
+            cd dynamic_build
+            cmake \
+              -D CMAKE_C_COMPILER_LAUNCHER=ccache \
+              -D CMAKE_CXX_COMPILER_LAUNCHER=ccache \
+              -D CMAKE_BUILD_TYPE=Release \
+              -D BUILD_L0_LOADER_TESTS=1 \
+              -D BUILD_STATIC=0 \
+              ..
+            make -j$(nproc)
+      - env:
+          ZEL_LIBRARY_PATH: '${{ github.workspace }}/dynamic_build/lib'
+        working-directory: build
+        run: ls $ZEL_LIBRARY_PATH;ZE_ENABLE_LOADER_DEBUG_TRACE=1 ctest -V
+
+  build-windows:
+    if: github.repository_owner == 'oneapi-src'
+    runs-on: [windows-latest]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build Loader on Latest Windows
+        run: |
+          mkdir build
+          cd build
+          cmake -D BUILD_L0_LOADER_TESTS=1 -D BUILD_STATIC=1 ..
+          cmake --build . --config Release
+      - env:
+          ZE_ENABLE_LOADER_DEBUG_TRACE: '1'
+          ZEL_LIBRARY_PATH: '${{ github.workspace }}/build/bin/Release'
+        working-directory: build
+        run: ctest -C Release -V

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Level zero loader changelog
 
+## v1.21.0
+* Add Support for building the L0 Loader statically
 ## v1.20.6
 * Add in missing header for ze_handle_t definition for DDI extension
 ## v1.20.5

CMakeLists.txt

@@ -13,7 +13,7 @@ if(MSVC AND (MSVC_VERSION LESS 1900))
 endif()
 
 # This project follows semantic versioning (https://semver.org/)
-project(level-zero VERSION 1.20.6)
+project(level-zero VERSION 1.21.0)
 
 include(GNUInstallDirs)
 
@@ -52,14 +52,19 @@ endif()
 
 include(FetchContent)
 
-if(BUILD_L0_LOADER_TESTS)
-	FetchContent_Declare(
-		googletest
-		URL https://github.com/google/googletest/archive/refs/tags/v1.14.0.zip
-	)
+if(BUILD_L0_LOADER_TESTS AND (NOT MSVC OR (MSVC AND NOT BUILD_STATIC)))
+    FetchContent_Declare(
+        googletest
+        GIT_REPOSITORY https://github.com/google/googletest.git
+        GIT_TAG        v1.14.0
+    )
+    add_library(GTest::GTest INTERFACE IMPORTED)
+    target_link_libraries(GTest::GTest INTERFACE gtest_main)
 
 	# For Windows: Prevent overriding the parent project's compiler/linker settings
-	set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    if(MSVC)
+        set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    endif()
 
 	FetchContent_MakeAvailable(googletest)
 
@@ -182,7 +187,7 @@ set(TARGET_LOADER_NAME ze_loader)
 add_subdirectory(source)
 add_subdirectory(samples)
 
-if(BUILD_L0_LOADER_TESTS)
+if(BUILD_L0_LOADER_TESTS AND (NOT MSVC OR (MSVC AND NOT BUILD_STATIC)))
     include(CTest)
     add_subdirectory(test)
 endif()

README.md

@@ -32,6 +32,19 @@ cmake --build . --target package
 cmake --build . --target install
 ```
 
+# Static Loader
+To build the Loader statically one must set `-DBUILD_STATIC=1` during the cmake configuration step.
+
+The build of the static loader creates a ze_loader.a/.lib which will link the source/lib source code into your application or library.
+
+This enables for inclusion of all L0 symbols into your application/library allowing for backwards compatability with older versions of the Loader.
+
+The static loader "shim" dynamically loads the ze_loader.so/.dll on the system enabling plugin like behavior where the init will fail gracefully given a usable loader or L0 driver is not found.
+
+When the `-DBUILD_STATIC=1` is executed, the dynamic loader and layers are not built to avoid conflicts during local test execution which requires the dynamic loader and layers to all be the same version for compatability.
+
+Testing with the static loader requires a build of the dynamic loader or an installation of the dynamic loader to exist in the library path.
+
 # Debug Trace
 The Level Zero Loader has the ability to print warnings and errors which occur within the internals of the Level Zero Loader itself.
 

scripts/templates/libddi.cpp.mako

@@ -26,7 +26,7 @@ namespace ${x}_lib
     ///////////////////////////////////////////////////////////////////////////////
 
 #ifdef DYNAMIC_LOAD_LOADER
-    __zedlllocal ${x}_result_t context_t::${n}DdiTableInit()
+    __zedlllocal ${x}_result_t context_t::${n}DdiTableInit(ze_api_version_t version)
     {
         ${x}_result_t result = ${X}_RESULT_SUCCESS;
 
@@ -37,19 +37,19 @@ namespace ${x}_lib
             // Optional
             auto getTable = reinterpret_cast<${tbl['pfn']}>(
                 GET_FUNCTION_PTR(loader, "${tbl['export']['name']}") );
-            getTable( ${X}_API_VERSION_CURRENT, &initial${n}DdiTable.${tbl['name']} );
+            getTableWithCheck(getTable, version, &initial${n}DdiTable.${tbl['name']} );
     %else:
             auto getTable = reinterpret_cast<${tbl['pfn']}>(
                 GET_FUNCTION_PTR(loader, "${tbl['export']['name']}") );
-            result = getTable( ${X}_API_VERSION_CURRENT, &initial${n}DdiTable.${tbl['name']} );
+            result = getTableWithCheck(getTable, version, &initial${n}DdiTable.${tbl['name']} );
     %endif
         }
 
     %endfor
         return result;
     }
 #else
-    __zedlllocal ${x}_result_t context_t::${n}DdiTableInit()
+    __zedlllocal ${x}_result_t context_t::${n}DdiTableInit(ze_api_version_t version)
     {
         ${x}_result_t result = ${X}_RESULT_SUCCESS;
 
@@ -58,9 +58,9 @@ namespace ${x}_lib
         {
             %if tbl['optional'] == True:
             // Optional
-            ${tbl['export']['name']}( ${X}_API_VERSION_CURRENT, &initial${n}DdiTable.${tbl['name']} );
+            ${tbl['export']['name']}( version, &initial${n}DdiTable.${tbl['name']} );
             %else:
-            result = ${tbl['export']['name']}( ${X}_API_VERSION_CURRENT, &initial${n}DdiTable.${tbl['name']} );
+            result = ${tbl['export']['name']}( version, &initial${n}DdiTable.${tbl['name']} );
             %endif
         }
 

source/CMakeLists.txt

@@ -12,15 +12,28 @@ configure_file(
     @ONLY)
 
 include(GNUInstallDirs)
-add_library(${TARGET_LOADER_NAME}
-    SHARED
-    ""
-    ${CMAKE_CURRENT_BINARY_DIR}/ZeLoaderVersion.rc
-)
+if (BUILD_STATIC)
+    message(STATUS "Building loader as static library")
+    add_library(${TARGET_LOADER_NAME}
+        STATIC
+        ""
+        ${CMAKE_CURRENT_BINARY_DIR}/ZeLoaderVersion.rc
+    )
+    add_definitions(-DDYNAMIC_LOAD_LOADER="1")
+else()
+    message(STATUS "Building loader as dynamic library")
+    add_library(${TARGET_LOADER_NAME}
+        SHARED
+        ""
+        ${CMAKE_CURRENT_BINARY_DIR}/ZeLoaderVersion.rc
+    )
+endif()
 
 add_subdirectory(lib)
-add_subdirectory(loader)
-add_subdirectory(layers)
+if (NOT BUILD_STATIC)
+    add_subdirectory(loader)
+    add_subdirectory(layers)
+endif()
 add_subdirectory(drivers)
 add_subdirectory(utils)
 

source/lib/linux/lib_init.cpp

@@ -10,13 +10,13 @@
 
 namespace ze_lib
 {
-
+#ifndef DYNAMIC_LOAD_LOADER
     void __attribute__((constructor)) createLibContext() {
         context = new context_t;
-    } 
-
-    void __attribute__((destructor)) deleteLibContext() {
-        delete context;
-    } 
+    }
+void __attribute__((destructor)) deleteLibContext() {
+    delete context;
+} 
+#endif
 
 }