Merge pull request #339 from PatKamin/refactor-libs-load

[ur] Refactor adapters load

Author: pbalcer

scripts/templates/ldrddi.cpp.mako

@@ -9,13 +9,14 @@ from templates import helper as th
     X=x.upper()
 %>/*
  *
- * Copyright (C) 2022 Intel Corporation
+ * Copyright (C) 2022-2023 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
  * @file ${name}.cpp
  *
  */
+#include "${x}_lib_loader.hpp"
 #include "${x}_loader.hpp"
 
 namespace loader
@@ -239,7 +240,7 @@ ${tbl['export']['name']}(
         if(platform.initStatus != ${X}_RESULT_SUCCESS)
             continue;
         auto getTable = reinterpret_cast<${tbl['pfn']}>(
-            GET_FUNCTION_PTR( platform.handle, "${tbl['export']['name']}") );
+            loader::LibLoader::getFunctionPtr(platform.handle.get(), "${tbl['export']['name']}"));
         if(!getTable) 
             continue; 
         auto getTableResult = getTable( version, &platform.dditable.${n}.${tbl['name']});

scripts/templates/ldrddi.hpp.mako

@@ -9,7 +9,7 @@ from templates import helper as th
     X=x.upper()
 %>/*
  *
- * Copyright (C) 2022 Intel Corporation
+ * Copyright (C) 2022-2023 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -19,6 +19,8 @@ from templates import helper as th
 #ifndef UR_LOADER_LDRDDI_H
 #define UR_LOADER_LDRDDI_H 1
 
+#include "${x}_object.hpp"
+
 namespace loader
 {
     ///////////////////////////////////////////////////////////////////////////////

source/common/CMakeLists.txt

@@ -12,3 +12,15 @@ add_subdirectory(unified_memory_allocation)
 target_link_libraries(common INTERFACE unified_memory_allocation)
 
 target_sources(common INTERFACE uma_helpers.hpp)
+
+if(WIN32)
+    target_sources(common
+        INTERFACE
+            ${CMAKE_CURRENT_SOURCE_DIR}/windows/ur_lib_loader.cpp
+    )
+else()
+    target_sources(common
+        INTERFACE
+            ${CMAKE_CURRENT_SOURCE_DIR}/linux/ur_lib_loader.cpp
+    )
+endif()

source/common/linux/ur_lib_loader.cpp

@@ -0,0 +1,43 @@
+/*
+ *
+ * Copyright (C) 2023 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+#include <dlfcn.h>
+
+#include "logger/ur_logger.hpp"
+#include "ur_lib_loader.hpp"
+
+#if defined(SANITIZER_ANY)
+#define LOAD_DRIVER_LIBRARY(NAME) dlopen(NAME, RTLD_LAZY | RTLD_LOCAL)
+#else
+#define LOAD_DRIVER_LIBRARY(NAME)                                              \
+    dlopen(NAME, RTLD_LAZY | RTLD_LOCAL | RTLD_DEEPBIND)
+#endif
+
+namespace loader {
+
+void LibLoader::freeAdapterLibrary(HMODULE handle) {
+    if (handle) {
+        int res = dlclose(handle);
+        if (res) {
+            logger::error(
+                "Failed to unload the library with the handle at address {}",
+                handle);
+        }
+    }
+}
+
+std::unique_ptr<HMODULE, LibLoader::lib_dtor>
+LibLoader::loadAdapterLibrary(const char *name) {
+    return std::unique_ptr<HMODULE, LibLoader::lib_dtor>(
+        LOAD_DRIVER_LIBRARY(name));
+}
+
+void *LibLoader::getFunctionPtr(HMODULE handle, const char *func_name) {
+    return dlsym(handle, func_name);
+}
+
+} // namespace loader

source/common/ur_lib_loader.hpp

@@ -0,0 +1,34 @@
+/*
+ *
+ * Copyright (C) 2023 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+#ifndef UR_LIB_LOADER_HPP
+#define UR_LIB_LOADER_HPP 1
+
+#include <memory>
+
+#include "ur_util.hpp"
+
+namespace loader {
+
+class LibLoader {
+  public:
+    struct lib_dtor {
+        typedef HMODULE pointer;
+        void operator()(HMODULE handle) { freeAdapterLibrary(handle); }
+    };
+
+    static std::unique_ptr<HMODULE, lib_dtor>
+    loadAdapterLibrary(const char *name);
+
+    static void freeAdapterLibrary(HMODULE handle);
+
+    static void *getFunctionPtr(HMODULE handle, const char *func_name);
+};
+
+} // namespace loader
+
+#endif // UR_LIB_LOADER_HPP

source/common/ur_util.hpp

@@ -38,35 +38,13 @@
 #if defined(SANITIZER_MEMORY) || defined(SANITIZER_ADDRESS)
 #define SANITIZER_ANY
 #endif
-
 ///////////////////////////////////////////////////////////////////////////////
 #if defined(_WIN32)
 #include <Windows.h>
 #define MAKE_LIBRARY_NAME(NAME, VERSION) NAME ".dll"
-#define MAKE_LAYER_NAME(NAME) NAME ".dll"
-#define LOAD_DRIVER_LIBRARY(NAME) LoadLibraryExA(NAME, nullptr, 0)
-#define FREE_DRIVER_LIBRARY(LIB)                                               \
-    if (LIB)                                                                   \
-    FreeLibrary(LIB)
-#define GET_FUNCTION_PTR(LIB, FUNC_NAME) GetProcAddress(LIB, FUNC_NAME)
-#define string_copy_s strncpy_s
 #else
-#include <dlfcn.h>
 #define HMODULE void *
 #define MAKE_LIBRARY_NAME(NAME, VERSION) "lib" NAME ".so." VERSION
-#define MAKE_LAYER_NAME(NAME)                                                  \
-    "lib" NAME ".so." L0_VALIDATION_LAYER_SUPPORTED_VERSION
-#if defined(SANITIZER_ANY)
-#define LOAD_DRIVER_LIBRARY(NAME) dlopen(NAME, RTLD_LAZY | RTLD_LOCAL)
-#else
-#define LOAD_DRIVER_LIBRARY(NAME)                                              \
-    dlopen(NAME, RTLD_LAZY | RTLD_LOCAL | RTLD_DEEPBIND)
-#endif
-#define FREE_DRIVER_LIBRARY(LIB)                                               \
-    if (LIB)                                                                   \
-    dlclose(LIB)
-#define GET_FUNCTION_PTR(LIB, FUNC_NAME) dlsym(LIB, FUNC_NAME)
-#define string_copy_s strncpy
 #endif
 
 inline std::string create_library_path(const char *name, const char *path) {

source/common/windows/ur_lib_loader.cpp

@@ -0,0 +1,34 @@
+/*
+ *
+ * Copyright (C) 2023 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+#include "ur_lib_loader.hpp"
+#include "logger/ur_logger.hpp"
+
+namespace loader {
+
+void LibLoader::freeAdapterLibrary(HMODULE handle) {
+    if (handle) {
+        BOOL res = FreeLibrary(handle);
+        if (!res) {
+            logger::error(
+                "Failed to unload the library with the handle at address {}",
+                handle);
+        }
+    }
+}
+
+std::unique_ptr<HMODULE, LibLoader::lib_dtor>
+LibLoader::loadAdapterLibrary(const char *name) {
+    return std::unique_ptr<HMODULE, LibLoader::lib_dtor>(
+        LoadLibraryExA(name, nullptr, 0));
+}
+
+void *LibLoader::getFunctionPtr(HMODULE handle, const char *func_name) {
+    return GetProcAddress(handle, func_name);
+}
+
+} // namespace loader

source/loader/CMakeLists.txt

@@ -95,15 +95,13 @@ if(WIN32)
     target_sources(loader
         PRIVATE
             ${CMAKE_CURRENT_SOURCE_DIR}/windows/lib_init.cpp
-            ${CMAKE_CURRENT_SOURCE_DIR}/windows/platform_discovery_win.cpp
             ${CMAKE_CURRENT_SOURCE_DIR}/windows/loader_init.cpp
             ${CMAKE_CURRENT_SOURCE_DIR}/layers/validation/backtrace_win.cpp
     )
 else()
     target_sources(loader
         PRIVATE
             ${CMAKE_CURRENT_SOURCE_DIR}/linux/lib_init.cpp
-            ${CMAKE_CURRENT_SOURCE_DIR}/linux/platform_discovery_lin.cpp
             ${CMAKE_CURRENT_SOURCE_DIR}/linux/loader_init.cpp
             ${CMAKE_CURRENT_SOURCE_DIR}/layers/validation/backtrace_lin.cpp
     )