Fix init checks when sorting legacy drivers (#317)

nrspruit · web-flow · commit e0df1d0478ab · 2025-04-10T10:47:01.000-07:00
Signed-off-by: Neil R. Spruit &lt;neil.r.spruit@intel.com&gt;
diff --git a/scripts/templates/ldrddi.cpp.mako b/scripts/templates/ldrddi.cpp.mako
@@ -67,6 +67,9 @@ namespace loader
             drv.initStatus = drv.dditable.${n}.${th.get_table_name(n, tags, obj)}.${th.make_pfn_name(n, tags, obj)}( ${", ".join(th.make_param_lines(n, tags, obj, format=["name"]))} );
             if(drv.initStatus == ZE_RESULT_SUCCESS)
                 atLeastOneDriverValid = true;
+            %if re.match(r"Init", obj['name']) and namespace == "ze":
+            drv.legacyInitAttempted = true;
+            %endif
             %endif
         }
 
diff --git a/scripts/templates/nullddi.cpp.mako b/scripts/templates/nullddi.cpp.mako
@@ -134,7 +134,11 @@ ${tbl['export']['name']}(
     pDdiTable->pfnInit                                   = driver::zeInit;
 
     auto missing_api = getenv_string( "ZEL_TEST_MISSING_API" );
-    if (std::strcmp(missing_api.c_str(), "zeInitDrivers") == 0) {
+    auto missing_api_driver_id = getenv_string( "ZEL_TEST_MISSING_API_DRIVER_ID" );
+    std::string zeInitDriversWithNullDriverId = "zeInitDrivers:" + std::to_string(ZEL_NULL_DRIVER_ID);
+    if (std::strcmp(missing_api_driver_id.c_str(), zeInitDriversWithNullDriverId.c_str()) == 0) {
+        pDdiTable->pfnInitDrivers                            = nullptr;
+    } else if (std::strcmp(missing_api.c_str(), "zeInitDrivers") == 0) {
         pDdiTable->pfnInitDrivers                            = nullptr;
     } else {
         pDdiTable->pfnInitDrivers                            = driver::zeInitDrivers;
diff --git a/scripts/templates/ze_loader_internal.h.mako b/scripts/templates/ze_loader_internal.h.mako
@@ -65,6 +65,7 @@ namespace loader
         zel_driver_type_t driverType = ZEL_DRIVER_TYPE_FORCE_UINT32;
         ze_driver_properties_t properties;
         bool pciOrderingRequested = false;
+        bool legacyInitAttempted = false;
     };
 
     using driver_vector_t = std::vector< driver_t >;
diff --git a/source/drivers/null/CMakeLists.txt b/source/drivers/null/CMakeLists.txt
@@ -65,6 +65,10 @@ target_include_directories(ze_null_test2
         ${CMAKE_CURRENT_SOURCE_DIR}
 )
 
+target_compile_definitions(ze_null_test1 PUBLIC ZEL_NULL_DRIVER_ID=1)
+target_compile_definitions(ze_null_test2 PUBLIC ZEL_NULL_DRIVER_ID=2)
+target_compile_definitions(ze_null PUBLIC ZEL_NULL_DRIVER_ID=1)
+
 if(INSTALL_NULL_DRIVER)
     install(TARGETS ze_null_test1
         ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT level-zero-devel
diff --git a/source/drivers/null/ze_null.h b/source/drivers/null/ze_null.h
@@ -15,6 +15,10 @@
 #include "zes_ddi.h"
 #include "ze_util.h"
 
+#ifndef ZEL_NULL_DRIVER_ID
+#define ZEL_NULL_DRIVER_ID 1
+#endif
+
 namespace driver
 {
     ///////////////////////////////////////////////////////////////////////////////
diff --git a/source/drivers/null/ze_nullddi.cpp b/source/drivers/null/ze_nullddi.cpp
@@ -5282,7 +5282,11 @@ zeGetGlobalProcAddrTable(
     pDdiTable->pfnInit                                   = driver::zeInit;
 
     auto missing_api = getenv_string( "ZEL_TEST_MISSING_API" );
-    if (std::strcmp(missing_api.c_str(), "zeInitDrivers") == 0) {
+    auto missing_api_driver_id = getenv_string( "ZEL_TEST_MISSING_API_DRIVER_ID" );
+    std::string zeInitDriversWithNullDriverId = "zeInitDrivers:" + std::to_string(ZEL_NULL_DRIVER_ID);
+    if (std::strcmp(missing_api_driver_id.c_str(), zeInitDriversWithNullDriverId.c_str()) == 0) {
+        pDdiTable->pfnInitDrivers                            = nullptr;
+    } else if (std::strcmp(missing_api.c_str(), "zeInitDrivers") == 0) {
         pDdiTable->pfnInitDrivers                            = nullptr;
     } else {
         pDdiTable->pfnInitDrivers                            = driver::zeInitDrivers;
diff --git a/source/loader/ze_ldrddi.cpp b/source/loader/ze_ldrddi.cpp
@@ -29,6 +29,7 @@ namespace loader
             drv.initStatus = drv.dditable.ze.Global.pfnInit( flags );
             if(drv.initStatus == ZE_RESULT_SUCCESS)
                 atLeastOneDriverValid = true;
+            drv.legacyInitAttempted = true;
         }
 
         if(!atLeastOneDriverValid)
diff --git a/source/loader/ze_loader.cpp b/source/loader/ze_loader.cpp
@@ -100,6 +100,13 @@ namespace loader
             std::vector<ze_driver_handle_t> driverHandles;
             ze_result_t res = ZE_RESULT_SUCCESS;
             if (desc && driver.dditable.ze.Global.pfnInitDrivers) {
+                if (driver.initDriversStatus != ZE_RESULT_SUCCESS) {
+                    if (debugTraceEnabled) {
+                        std::string message = "driverSorting " + driver.name + " failed, zeInitDrivers returned ";
+                        debug_trace_message(message, loader::to_string(driver.initDriversStatus));
+                    }
+                    continue;
+                }
                 if (debugTraceEnabled) {
                     std::string message = "driverSorting " + driver.name + " using zeInitDrivers(" + loader::to_string(&permissiveDesc) + ")";
                     debug_trace_message(message, "");
@@ -126,6 +133,13 @@ namespace loader
                     continue;
                 }
             } else if (driver.dditable.ze.Driver.pfnGet) {
+                if (driver.initStatus != ZE_RESULT_SUCCESS || !driver.legacyInitAttempted) {
+                    if (debugTraceEnabled) {
+                        std::string message = "driverSorting " + driver.name + " failed, zeInit returned ";
+                        debug_trace_message(message, loader::to_string(driver.initStatus));
+                    }
+                    continue;
+                }
                 if (debugTraceEnabled) {
                     std::string message = "driverSorting " + driver.name + " using zeDriverGet";
                     debug_trace_message(message, "");
diff --git a/source/loader/ze_loader_internal.h b/source/loader/ze_loader_internal.h
@@ -56,6 +56,7 @@ namespace loader
         zel_driver_type_t driverType = ZEL_DRIVER_TYPE_FORCE_UINT32;
         ze_driver_properties_t properties;
         bool pciOrderingRequested = false;
+        bool legacyInitAttempted = false;
     };
 
     using driver_vector_t = std::vector< driver_t >;
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -52,6 +52,13 @@ else()
   set_property(TEST tests_multi_driver_missing_initDrivers PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_ALT_DRIVERS=${CMAKE_BINARY_DIR}/lib/libze_null_test1.so,${CMAKE_BINARY_DIR}/lib/libze_null_test2.so")
 endif()
 
+add_test(NAME tests_multi_driver_one_driver_missing_initDrivers COMMAND tests --gtest_filter=*GivenLevelZeroLoaderPresentWithMultipleDriversMissingInitDriversInOneDriverWhenCallingZeInitDriversThenExpectSuccessForZeInitDrivers)
+if (MSVC)
+  set_property(TEST tests_multi_driver_one_driver_missing_initDrivers PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_ALT_DRIVERS=${CMAKE_BINARY_DIR}/bin/$<CONFIG>/ze_null_test1.dll,${CMAKE_BINARY_DIR}/bin/$<CONFIG>/ze_null_test2.dll")
+else()
+  set_property(TEST tests_multi_driver_one_driver_missing_initDrivers PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_ALT_DRIVERS=${CMAKE_BINARY_DIR}/lib/libze_null_test1.so,${CMAKE_BINARY_DIR}/lib/libze_null_test2.so")
+endif()
+
 add_test(NAME tests_multi_driver_missing_initDrivers_sort_after_error COMMAND tests --gtest_filter=*GivenLevelZeroLoaderPresentWithMultipleDriversMissingInitDriversWhenCallingZeInitDriversThenExpectSuccessForZeInitWithDriverGetAfterInitDrivers)
 if (MSVC)
   set_property(TEST tests_multi_driver_missing_initDrivers_sort_after_error APPEND PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_ALT_DRIVERS=${CMAKE_BINARY_DIR}/bin/$<CONFIG>/ze_null_test1.dll,${CMAKE_BINARY_DIR}/bin/$<CONFIG>/ze_null_test2.dll")
diff --git a/test/loader_api.cpp b/test/loader_api.cpp
@@ -269,6 +269,19 @@ TEST(
   EXPECT_EQ(pInitDriversCount, 0);
 }
 
+TEST(
+  LoaderInit,
+  GivenLevelZeroLoaderPresentWithMultipleDriversMissingInitDriversInOneDriverWhenCallingZeInitDriversThenExpectSuccessForZeInitDrivers) {
+
+  uint32_t pInitDriversCount = 0;
+  ze_init_driver_type_desc_t desc = {ZE_STRUCTURE_TYPE_INIT_DRIVER_TYPE_DESC};
+  desc.flags = UINT32_MAX;
+  desc.pNext = nullptr;
+  putenv_safe( const_cast<char *>( "ZEL_TEST_MISSING_API_DRIVER_ID=zeInitDrivers:1" ) );
+  EXPECT_EQ(ZE_RESULT_SUCCESS, zeInitDrivers(&pInitDriversCount, nullptr, &desc));
+  EXPECT_GT(pInitDriversCount, 0);
+}
+
 TEST(
   LoaderInit,
   GivenLevelZeroLoaderPresentWithMultipleDriversMissingInitDriversWhenCallingZeInitDriversThenExpectSuccessForZeInitWithDriverGetAfterInitDrivers) {

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,9 @@ namespace loader`
`67`	`67`	`drv.initStatus = drv.dditable.${n}.${th.get_table_name(n, tags, obj)}.${th.make_pfn_name(n, tags, obj)}( ${", ".join(th.make_param_lines(n, tags, obj, format=["name"]))} );`
`68`	`68`	`if(drv.initStatus == ZE_RESULT_SUCCESS)`
`69`	`69`	`atLeastOneDriverValid = true;`
	`70`	`+ %if re.match(r"Init", obj['name']) and namespace == "ze":`
	`71`	`+ drv.legacyInitAttempted = true;`
	`72`	`+ %endif`
`70`	`73`	`%endif`
`71`	`74`	`}`
`72`	`75`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ namespace loader`
`29`	`29`	`drv.initStatus = drv.dditable.ze.Global.pfnInit( flags );`
`30`	`30`	`if(drv.initStatus == ZE_RESULT_SUCCESS)`
`31`	`31`	`atLeastOneDriverValid = true;`
	`32`	`+ drv.legacyInitAttempted = true;`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`if(!atLeastOneDriverValid)`