Add tests to validate tracing layer for Zer API's (#388)

* Add tests to validate tracing layer for Zer API's

Signed-off-by: Vishnu Khanth <[email protected]>

Author: vishnu-khanth

source/drivers/null/ze_null.cpp

@@ -420,6 +420,9 @@ namespace driver
             }
             *pCount = 1;
 
+            char *env_str = context.setenv_var_with_driver_id("zeDeviceGetCommandQueueGroupProperties", ZEL_NULL_DRIVER_ID);
+            context.env_vars.push_back(env_str);
+
             return ZE_RESULT_SUCCESS;
         };
 
@@ -435,6 +438,9 @@ namespace driver
             *pCount = 1;
             if( nullptr != pMemProperties ) *pMemProperties = memoryProperties;
 
+            char *env_str = context.setenv_var_with_driver_id("zeDeviceGetMemoryProperties", ZEL_NULL_DRIVER_ID);
+            context.env_vars.push_back(env_str);
+
             return ZE_RESULT_SUCCESS;
         };
 
@@ -447,6 +453,10 @@ namespace driver
             memoryAccessProperties.stype = ZE_STRUCTURE_TYPE_DEVICE_MEMORY_ACCESS_PROPERTIES;
 
             *pMemAccessProperties = memoryAccessProperties;
+            
+            char *env_str = context.setenv_var_with_driver_id("zeDeviceGetMemoryAccessProperties", ZEL_NULL_DRIVER_ID);
+            context.env_vars.push_back(env_str);
+
             return ZE_RESULT_SUCCESS;
         };
 

test/CMakeLists.txt

@@ -6,6 +6,7 @@ add_executable(
   loader_api.cpp
   loader_validation_layer.cpp
   driver_ordering_helper_tests.cpp
+  loader_tracing_layer.cpp
 )
 
 # Only include driver_ordering_unit_tests for static builds or non-Windows platforms
@@ -661,3 +662,43 @@ foreach(init_method IN LISTS init_methods)
         add_runtime_api_test("unsupported" ${init_method} "single_driver")
     endif()
 endforeach()
+
+# ZER API Tracing Tests
+add_test(NAME test_zer_tracing_static_prologue COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWhenCallingZerApisWithStaticTracingEnabledAndPrologueCallbacksRegisteredThenExpectTracingToWork*)
+set_property(TEST test_zer_tracing_static_prologue PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_static_epilogue COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWhenCallingZerApisWithStaticTracingEnabledAndEpilogueCallbacksRegisteredThenExpectTracingToWork*)
+set_property(TEST test_zer_tracing_static_epilogue PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_static_both COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWhenCallingZerApisWithStaticTracingEnabledAndBothCallbacksRegisteredThenExpectBothToWork*)
+set_property(TEST test_zer_tracing_static_both PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_dynamic_prologue COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWhenCallingZerApisWithDynamicTracingEnabledAndPrologueCallbacksRegisteredThenExpectCallbacksToWorkCorrectly*)
+set_property(TEST test_zer_tracing_dynamic_prologue PROPERTY ENVIRONMENT "ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_dynamic_epilogue COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWhenCallingZerApisWithDynamicTracingEnabledAndEpilogueCallbacksRegisteredThenExpectTracingToWork*)
+set_property(TEST test_zer_tracing_dynamic_epilogue PROPERTY ENVIRONMENT "ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_dynamic_both COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWhenCallingZerApisWithDynamicTracingEnabledAndBothCallbacksRegisteredThenExpectFullTracingFunctionality*)
+set_property(TEST test_zer_tracing_dynamic_both PROPERTY ENVIRONMENT "ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_static_multi_tracers COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithStaticTracingEnabledAndMultipleTracersWithBothCallbacksRegisteredWhenCallingZerApisThenAllTracersReceiveCallbacks*)
+set_property(TEST test_zer_tracing_static_multi_tracers PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_static_multi_enabled_disabled_tracers COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithStaticTracingEnabledAndMultipleEnabledAndDisabledTracersWithPrologueCallbacksRegisteredWhenCallingZerApisThenOnlyEnabledTracersReceiveCallbacks*)
+set_property(TEST test_zer_tracing_static_multi_enabled_disabled_tracers PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_static_multi_tracers_different_callbacks COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithStaticTracingEnabledAndMultipleTracersWithDifferentCallbacksRegisteredWhenCallingZerApisThenEachTracerWorksIndependently*)
+set_property(TEST test_zer_tracing_static_multi_tracers_different_callbacks PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_tracing_static_selective COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithStaticTracingEnabledAndSelectiveCallbackRegistrationWhenCallingZerApisThenOnlyRegisteredCallbacksAreTriggered*)
+set_property(TEST test_zer_tracing_static_selective PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_ze_and_zer_tracing_static COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithStaticTracingEnabledAndBothZeAndZerCallbacksRegisteredWhenCallingBothApisThenBothAreTraced*)
+set_property(TEST test_ze_and_zer_tracing_static PROPERTY ENVIRONMENT "ZE_ENABLE_LOADER_DEBUG_TRACE=1;ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_ze_and_zer_tracing_dynamic COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithDynamicTracingEnabledAndBothZeAndZerCallbacksRegisteredWhenCallingBothApisThenBothAreTraced*)
+set_property(TEST test_ze_and_zer_tracing_dynamic PROPERTY ENVIRONMENT "ZE_ENABLE_NULL_DRIVER=1")
+
+add_test(NAME test_zer_unsupported_and_ze_tracing_dynamic COMMAND tests --gtest_filter=*TracingParameterizedTest*GivenLoaderWithDynamicTracingEnabledAndZerApisUnsupportedAndBothZeAndZerCallbacksRegisteredWhenCallingBothApisThenTracingWorksForZeOnly*)
+set_property(TEST test_zer_unsupported_and_ze_tracing_dynamic PROPERTY ENVIRONMENT "ZE_ENABLE_NULL_DRIVER=1")