Dynamic load ze_loader, remove link with ze_loader.{so/dll} (#485)

* Dynamic load ze_loader, remove link with ze_loader.{so/dll}

Changed all zeXXX function calls to use ZE_FUNC(zeXXX) macro
defined in src/levelzero/ze_loader.h

* Added optional variable to specify level-zero commit.
Used tag v1.21.6 for unitrace build, which is the current master.

---------

Co-authored-by: Guy Zadicario <[email protected]>

Author: gzadica1

build_utils/CMakeLists.txt

@@ -626,7 +626,7 @@ macro(GetLevelZeroHeaders TARGET)
                               ${L0_INC_PATH}/level_zero/zet_api.h
                               ${L0_INC_PATH}/level_zero/layers/zel_tracing_api.h
                               ${L0_INC_PATH}/level_zero/layers/zel_tracing_register_cb.h
-                      COMMAND "${PYTHON_EXECUTABLE}" "${PTI_CMAKE_MACRO_DIR}/get_ze_headers.py" ${L0_INC_PATH} ${CMAKE_BINARY_DIR})
+                      COMMAND "${PYTHON_EXECUTABLE}" "${PTI_CMAKE_MACRO_DIR}/get_ze_headers.py" ${L0_INC_PATH} ${CMAKE_BINARY_DIR} ${LEVEL_ZERO_COMMIT_ID})
   endif()
 
   target_include_directories(${TARGET}

build_utils/get_ze_headers.py

@@ -4,11 +4,11 @@
 import build_utils
 
 url = "https://github.com/oneapi-src/level-zero.git"
-commit = "a4afcb39ee265e595d3f0aa57b25b5e845fb494c"
+default_commit = "a4afcb39ee265e595d3f0aa57b25b5e845fb494c"
 
 def main():
   if len(sys.argv) < 3:
-    print("Usage: python get_ze_headers.py <include_path> <build_path>")
+    print("Usage: python get_ze_headers.py <include_path> <build_path> [<commit-sha>]")
     return
 
   dst_path = sys.argv[1]
@@ -20,6 +20,12 @@ def main():
 
   clone_path = sys.argv[2]
   clone_path = os.path.join(clone_path, "level-zero")
+
+  if len(sys.argv) > 3:
+    commit = sys.argv[3]
+  else:
+    commit = default_commit
+
   build_utils.clone(url, commit, clone_path)
 
   src_path = os.path.join(clone_path, "include")

tools/unitrace/CMakeLists.txt

@@ -102,7 +102,7 @@ find_package(Xptifw REQUIRED)
 if (Xptifw_FOUND)
   target_include_directories(unitrace_tool PRIVATE "${Xptifw_INCLUDE_DIR}")
   if(WIN32)
-    target_link_libraries(unitrace_tool PRIVATE ${Xptifw_LIBRARY} "${CMAKE_BINARY_DIR}/ze_loader.lib")
+    target_link_libraries(unitrace_tool PRIVATE ${Xptifw_LIBRARY})
   else()
     target_link_libraries(unitrace_tool PRIVATE xptifw)
   endif()
@@ -131,7 +131,7 @@ FindOpenCLHeaders(unitrace_tool)
 
 GetOpenCLTracingHeaders(unitrace_tool)
 
-FindL0Library(unitrace_tool)
+set (LEVEL_ZERO_COMMIT_ID "v1.21.6")
 GetLevelZeroHeaders(unitrace_tool)
 
 FindHeadersPath(unitrace_tool "${PROJECT_SOURCE_DIR}/scripts/gen_tracing_common_header.py" "common_header.gen" gen_common_header)
@@ -216,13 +216,9 @@ if(UNIX)
   target_link_libraries(unitrace pthread dl)
 endif()
 
-FindL0Library(unitrace)
 GetLevelZeroHeaders(unitrace)
 GetGitCommitHash(unitrace "${PROJECT_SOURCE_DIR}/scripts/get_commit_hash.py" "unitrace_commit_hash.h" get_git_commit_hash_unitrace)
 GetGitCommitHash(unitrace_tool "${PROJECT_SOURCE_DIR}/scripts/get_commit_hash.py" "unitrace_tool_commit_hash.h" get_git_commit_hash_unitrace_tool)
-if(WIN32)
-  target_link_libraries(unitrace "${CMAKE_BINARY_DIR}/ze_loader.lib")
-endif()
 
 if(UNIX)
   add_custom_command(TARGET unitrace POST_BUILD COMMAND "rm" "-rf" "unitrace_commit_hash.h")

tools/unitrace/scripts/gen_l0_loader.py

@@ -8,8 +8,8 @@
 import sys
 import re
 
-def get_func_list(f, func_list):
-  f.seek(0)
+def get_func_list(file_path, func_list):
+  f = open(file_path, "rt")
   for line in f.readlines():
     if line.find("ZE_APICALL") != -1 and line.find("ze_pfn") != -1:
       items = line.split("ze_pfn")
@@ -18,18 +18,38 @@ def get_func_list(f, func_list):
       items = items[1].split("Cb_t")
       assert len(items) == 2
       func_list.append("ze" + items[0].strip())
+  f.close()
 
-def gen_loader(f, func_list):
+def get_api_func_list(file_path, func_list):
+  f = open(file_path, "rt")
+  api_line = False
+  for line in f.readlines():
+    if line.find("ZE_APICALL") != -1:
+      api_line = True
+    elif api_line:
+      api_line = False
+      items = line.split("(")
+      assert len(items) == 2
+      func_list.append(items[0].strip())
+  f.close()
+
+def gen_loader(f, register_func_list, api_func_list):
   f.write("public:\n");
-  for func in func_list:
+  for func in register_func_list:
     reg_fname = "zelTracer" + func[2:] + "RegisterCallback"
     f.write("  decltype(&" + reg_fname + ") " + reg_fname + "_ = nullptr;\n");
+    f.write("  decltype(&" + func + ") " + func + "_ = nullptr;\n");
+  for func in api_func_list:
+    f.write("  decltype(&" + func + ") " + func + "_ = nullptr;\n");
 
   f.write("private:\n");
   f.write("  void init() {\n");
-  for func in func_list:
+  for func in register_func_list:
     reg_fname = "zelTracer" + func[2:] + "RegisterCallback"
     f.write("  LEVEL_ZERO_LOADER_GET_SYMBOL(" + reg_fname + ");\n");
+    f.write("  LEVEL_ZERO_LOADER_GET_SYMBOL(" + func + ");\n");
+  for func in api_func_list:
+    f.write("  LEVEL_ZERO_LOADER_GET_SYMBOL(" + func + ");\n");
   f.write("}\n");
 
 def main():
@@ -47,22 +67,18 @@ def main():
 
   dst_loader_file = open(dst_loader_file_path, "wt")
 
-  l0_path = sys.argv[2]
-  l0_file_path = os.path.join(l0_path, "ze_api.h")
+  register_func_list = []
+  api_func_list = []
 
-  func_list = []
-
-  l0_file = open(l0_file_path, "rt")
-  get_func_list(l0_file, func_list)
-
-  l0_exp_path = os.path.join(l0_path, "layers", "zel_tracing_register_cb.h")
-  l0_exp_file = open(l0_exp_path, "rt")
-  get_func_list(l0_exp_file, func_list)
+  l0_path = sys.argv[2]
+  get_func_list(os.path.join(l0_path, "ze_api.h"), register_func_list)
+  get_func_list(os.path.join(l0_path, "layers", "zel_tracing_register_cb.h"), register_func_list)
+  get_api_func_list(os.path.join(l0_path, "zet_api.h"), api_func_list)
+  get_api_func_list(os.path.join(l0_path, "zes_api.h"), api_func_list)
+  get_api_func_list(os.path.join(l0_path, "layers", "zel_tracing_api.h"),api_func_list)
 
-  gen_loader(dst_loader_file, func_list)
+  gen_loader(dst_loader_file, register_func_list, api_func_list)
 
-  l0_exp_file.close()
-  l0_file.close()
   dst_loader_file.close()
 
 if __name__ == "__main__":

tools/unitrace/scripts/gen_tracing_callbacks.py

@@ -241,7 +241,7 @@ def gen_api(f, func_list, kfunc_list):
   gen_register(f, kfunc_list)
   f.write("  }\n")
   f.write("\n")
-  f.write("  status = zelTracerSetEnabled(tracer, true);\n")
+  f.write("  status = ZE_FUNC(zelTracerSetEnabled)(tracer, true);\n")
   f.write("  PTI_ASSERT(status == ZE_RESULT_SUCCESS);\n")
   f.write("}\n")
 
@@ -721,7 +721,7 @@ def gen_exit_callback(f, func, submission_func_list, synchronize_func_list_on_en
   if func == "zeModuleCreate": 
     f.write("    bool aot = (*(params->pdesc))->format; \n");
     f.write("    unsigned int kcount = 0; \n")
-    f.write("    if (zeModuleGetKernelNames(**(params->pphModule), &kcount, NULL) == ZE_RESULT_SUCCESS) {\n")
+    f.write("    if (ZE_FUNC(zeModuleGetKernelNames)(**(params->pphModule), &kcount, NULL) == ZE_RESULT_SUCCESS) {\n")
     f.write("      if (aot) { \n")
     f.write("        str += \"AOT (AOT_BINARY) \"; \n")
     f.write("      }\n")
@@ -739,7 +739,7 @@ def gen_exit_callback(f, func, submission_func_list, synchronize_func_list_on_en
     f.write("      q += 1024;\n")
     f.write("    }\n")
 
-    f.write("    if (zeModuleGetKernelNames(**(params->pphModule), &kcount, knames) == ZE_RESULT_SUCCESS) {\n")
+    f.write("    if (ZE_FUNC(zeModuleGetKernelNames)(**(params->pphModule), &kcount, knames) == ZE_RESULT_SUCCESS) {\n")
     f.write("      for (int i = 0; i < kcount; i++) {\n")
     f.write("        str += \"Kernel #\" + std::to_string(i) + \": \" + knames[i] + \"\\n\";\n")
     f.write("      }\n")