Block all calls to get drivers until after init has completed to avoid race during sorting (#344)

* Block all calls to get drivers until after init has completed to avoid race during sorting

Signed-off-by: Neil R. Spruit <neil.r.spruit@intel.com>

Author: nrspruit

.github/workflows/build-msi-package.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   pull_request:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   workflow_dispatch:
 
 permissions: read-all

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

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   pull_request:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   workflow_dispatch:
 
 permissions: read-all

.github/workflows/build-multi.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   pull_request:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   workflow_dispatch:
 
 permissions: read-all

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

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   pull_request:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   workflow_dispatch:
 
 permissions: read-all

.github/workflows/build-quick.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   pull_request:
-    branches: [ master ]
+    branches: [ master,release_branch* ]
   workflow_dispatch:
 
 permissions: read-all

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Level zero loader changelog
 
+
+## v1.21.10
+* Block all calls to get until after init has completed to avoid race during sorting.
 ## v1.21.9
 * Fix init checks when sorting legacy drivers
 * Fix MSVC Link optimization flags

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.21.9)
+project(level-zero VERSION 1.21.10)
 
 include(GNUInstallDirs)
 

PRODUCT_GUID.txt

@@ -1,2 +1,2 @@
-1.21.9
-01037281-c9ef-43cf-bc65-f72fb3438788
+1.21.10
+98f4ce5b-d498-4ec9-b025-2e509c4ebecc

scripts/templates/ldrddi.cpp.mako

@@ -79,23 +79,26 @@ namespace loader
         %elif re.match(r"\w+DriverGet$", th.make_func_name(n, tags, obj)) or re.match(r"\w+InitDrivers$", th.make_func_name(n, tags, obj)):
         uint32_t total_driver_handle_count = 0;
 
-        if (!loader::context->sortingInProgress.exchange(true) && !loader::context->instrumentationEnabled) {
-            %if namespace != "zes":
-            %if not re.match(r"\w+InitDrivers$", th.make_func_name(n, tags, obj)):
-            std::call_once(loader::context->coreDriverSortOnce, []() {
-                loader::context->driverSorting(&loader::context->zeDrivers, nullptr, false);
-            });
-            %else:
-            std::call_once(loader::context->coreDriverSortOnce, [desc]() {
-                loader::context->driverSorting(&loader::context->zeDrivers, desc, false);
-            });
-            %endif
-            %else:
-            std::call_once(loader::context->sysmanDriverSortOnce, []() {
-                loader::context->driverSorting(loader::context->sysmanInstanceDrivers, nullptr, true);
-            });
-            %endif
-            loader::context->sortingInProgress.store(false);
+        {
+            std::lock_guard<std::mutex> lock(loader::context->sortMutex);
+            if (!loader::context->sortingInProgress.exchange(true) && !loader::context->instrumentationEnabled) {
+                %if namespace != "zes":
+                %if not re.match(r"\w+InitDrivers$", th.make_func_name(n, tags, obj)):
+                std::call_once(loader::context->coreDriverSortOnce, []() {
+                    loader::context->driverSorting(&loader::context->zeDrivers, nullptr, false);
+                });
+                %else:
+                std::call_once(loader::context->coreDriverSortOnce, [desc]() {
+                    loader::context->driverSorting(&loader::context->zeDrivers, desc, false);
+                });
+                %endif
+                %else:
+                std::call_once(loader::context->sysmanDriverSortOnce, []() {
+                    loader::context->driverSorting(loader::context->sysmanInstanceDrivers, nullptr, true);
+                });
+                %endif
+                loader::context->sortingInProgress.store(false);
+            }
         }
 
         %if namespace != "zes":

scripts/templates/ze_loader_internal.h.mako

@@ -121,6 +121,7 @@ namespace loader
         std::once_flag coreDriverSortOnce;
         std::once_flag sysmanDriverSortOnce;
         std::atomic<bool> sortingInProgress = {false};
+        std::mutex sortMutex;
         bool instrumentationEnabled = false;
         dditable_t tracing_dditable = {};
         std::shared_ptr<Logger> zel_logger;