Fix dynamic tracing support with static loader (#313)

* Fix dynamic tracing support with static loader

- To allow for dynamic init of tracing, the static loader cannot
  optimize out the call to the ze_loader's ze_lib.
- Therefore, during init, the function pointer is instead assigned to
  the dynamic loaded loader's apis to enable tracing.
* Add optimizations for static loader calls.
* Fix visual studio version for all windows builds

Signed-off-by: Neil R. Spruit <[email protected]>

Author: nrspruit

.github/docker/windows.Dockerfile

@@ -4,7 +4,7 @@ ARG BASE_IMAGE=mcr.microsoft.com/dotnet/framework/runtime:4.8
 FROM ${BASE_IMAGE}
 
 SHELL ["powershell"]
-ENV VS_VERSION=2019
+ENV VS_VERSION=2022
 RUN [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; `
     Switch ($env:VS_VERSION) { `
         "2019" {$url_version = "16"} `

scripts/templates/libapi.cpp.mako

@@ -160,6 +160,28 @@ ${th.make_func_name(n, tags, obj)}(
 }
 %endif
 %else:
+    #ifdef DYNAMIC_LOAD_LOADER
+    ze_result_t result = ${X}_RESULT_SUCCESS;
+    if(ze_lib::destruction) {
+        return ${X}_RESULT_ERROR_UNINITIALIZED;
+    }
+%if re.match(r"\w+DriverGet$", th.make_func_name(n, tags, obj)):
+    if (${x}_lib::context->${n}DdiTable == nullptr) {
+        return ${X}_RESULT_ERROR_UNINITIALIZED;
+    }
+%endif
+    static const ${th.make_pfn_type(n, tags, obj)} ${th.make_pfn_name(n, tags, obj)} = [&result] {
+        auto ${th.make_pfn_name(n, tags, obj)} = ${x}_lib::context->${n}DdiTable.load()->${th.get_table_name(n, tags, obj)}.${th.make_pfn_name(n, tags, obj)};
+        if( nullptr == ${th.make_pfn_name(n, tags, obj)} ) {
+            result = ${X}_RESULT_ERROR_UNSUPPORTED_FEATURE;
+        }
+        return ${th.make_pfn_name(n, tags, obj)};
+    }();
+    if (result != ${X}_RESULT_SUCCESS) {
+        return result;
+    }
+    return ${th.make_pfn_name(n, tags, obj)}( ${", ".join(th.make_param_lines(n, tags, obj, format=["name"]))} );
+    #else
     if(ze_lib::destruction) {
         return ${X}_RESULT_ERROR_UNINITIALIZED;
     }
@@ -182,6 +204,7 @@ ${th.make_func_name(n, tags, obj)}(
 %endif
 
     return ${th.make_pfn_name(n, tags, obj)}( ${", ".join(th.make_param_lines(n, tags, obj, format=["name"]))} );
+    #endif
 }
 %endif
 %if 'condition' in obj:

scripts/templates/libddi.cpp.mako

@@ -43,6 +43,10 @@ namespace ${x}_lib
                 GET_FUNCTION_PTR(loader, "${tbl['export']['name']}") );
             result = getTableWithCheck(getTable, version, &initial${n}DdiTable.${tbl['name']} );
     %endif
+            %for obj in tbl['functions']:
+            initial${n}DdiTable.${tbl['name']}.${th.make_pfn_name(n, tags, obj)} = reinterpret_cast<${th.make_pfn_type(n, tags, obj)}>(
+                GET_FUNCTION_PTR(loader, "${th.make_func_name(n, tags, obj)}") );
+            %endfor
         }
 
     %endfor

source/lib/ze_lib.cpp

@@ -538,24 +538,42 @@ zelLoaderContextTeardown()
 ze_result_t ZE_APICALL
 zelEnableTracingLayer()
 {
+    #ifdef DYNAMIC_LOAD_LOADER
+    if(nullptr == ze_lib::context->loader)
+        return ZE_RESULT_ERROR_UNINITIALIZED;
+    typedef ze_result_t (ZE_APICALL *zelEnableTracingLayerInternal_t)();
+    auto enableDynamicTracing = reinterpret_cast<zelEnableTracingLayerInternal_t>(
+            GET_FUNCTION_PTR(ze_lib::context->loader, "zelEnableTracingLayer") );
+    return enableDynamicTracing();
+    #else
     if (ze_lib::context->dynamicTracingSupported == false) {
         return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
     }
     if (ze_lib::context->tracingLayerEnableCounter.fetch_add(1) == 0) {
         ze_lib::context->zeDdiTable.exchange(ze_lib::context->pTracingZeDdiTable);
     }
+    #endif
     return ZE_RESULT_SUCCESS;
 }
 
 ze_result_t ZE_APICALL
 zelDisableTracingLayer()
 {
+    #ifdef DYNAMIC_LOAD_LOADER
+    if(nullptr == ze_lib::context->loader)
+        return ZE_RESULT_ERROR_UNINITIALIZED;
+    typedef ze_result_t (ZE_APICALL *zelDisableTracingLayerInternal_t)();
+    auto disableDynamicTracing = reinterpret_cast<zelDisableTracingLayerInternal_t>(
+            GET_FUNCTION_PTR(ze_lib::context->loader, "zelDisableTracingLayer") );
+    return disableDynamicTracing();
+    #else
     if (ze_lib::context->dynamicTracingSupported == false) {
         return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
     }
     if (ze_lib::context->tracingLayerEnableCounter.fetch_sub(1) <= 1) {
         ze_lib::context->zeDdiTable.exchange(&ze_lib::context->initialzeDdiTable);
     }
+    #endif
     return ZE_RESULT_SUCCESS;
 }