address review

Signed-off-by: Sergey V Maslov <[email protected]>

Author: smaslov-intel

sycl/doc/EnvironmentVariables.md

@@ -152,7 +152,6 @@ variables in production code.</span>
 | `SYCL_PI_LEVEL_ZERO_USE_COPY_ENGINE_FOR_D2D_COPY` (experimental) | Integer | Allows the use of copy engine, if available in the device, in Level Zero plugin for device to device copy operations. The default is 0. This option is experimental and will be removed once heuristics are added to make a decision about use of copy engine for device to device copy operations. |
 | `SYCL_PI_LEVEL_ZERO_DEVICE_SCOPE_EVENTS` | Any(\*) | Enable support of device-scope events whose state is not visible to the host. If enabled mode is SYCL_PI_LEVEL_ZERO_DEVICE_SCOPE_EVENTS=1 the Level Zero plugin would create all events having device-scope only and create proxy host-visible events for them when their status is needed (wait/query) on the host. If enabled mode is SYCL_PI_LEVEL_ZERO_DEVICE_SCOPE_EVENTS=2 the Level Zero plugin would create all events having device-scope and add proxy host-visible event at the end of each command-list submission. The default is 2, meaning only the last event in a batch is host-visible. |
 | `SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS` | Integer | When set to a positive value enables use of Level Zero immediate commandlists, which means there is no batching and all commands are immediately submitted for execution. Default is 0. Note: When immediate commandlist usage is enabled it is necessary to also set SYCL_PI_LEVEL_ZERO_DEVICE_SCOPE_EVENTS to either 0 or 1.  |
-| `SYCL_PI_LEVEL_ZERO_ENABLE_TRACING` | Any(\*) | Enable XPTI-based tracing in L0 plugin |
 
 ## Debugging variables for CUDA Plugin
 

sycl/plugins/level_zero/pi_level_zero.cpp

@@ -36,7 +36,9 @@ static pi_result EventCreate(pi_context Context, pi_queue Queue,
                              bool HostVisible, pi_event *RetEvent);
 }
 
-void enableL0Tracing();
+// Defined in tracing.cpp
+void enableZeTracing();
+void disableZeTracing();
 
 namespace {
 
@@ -7944,10 +7946,7 @@ pi_result piPluginInit(pi_plugin *PluginInit) {
   (PluginInit->PiFunctionTable).api = (decltype(&::api))(&api);
 #include <CL/sycl/detail/pi.def>
 
-  if (std::getenv("SYCL_PI_LEVEL_ZERO_ENABLE_TRACING") != nullptr) {
-    enableL0Tracing();
-  }
-
+  enableZeTracing();
   return PI_SUCCESS;
 }
 
@@ -8054,6 +8053,8 @@ pi_result piTearDown(void *PluginParameter) {
   }
   if (LeakFound)
     return PI_INVALID_MEM_OBJECT;
+
+  disableZeTracing();
   return PI_SUCCESS;
 }
 

sycl/plugins/level_zero/tracing.cpp

@@ -1,4 +1,4 @@
-//===-------------- tracing.cpp - L0 Host API Tracing ----------------------==//
+//===-------------- tracing.cpp - Level-Zero Host API Tracing --------------==//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -14,8 +14,8 @@
 
 #include <iostream>
 
-constexpr auto L0_CALL_STREAM_NAME = "sycl.experimental.level_zero.call";
-constexpr auto L0_DEBUG_STREAM_NAME = "sycl.experimental.level_zero.debug";
+constexpr auto ZE_CALL_STREAM_NAME = "sycl.experimental.level_zero.call";
+constexpr auto ZE_DEBUG_STREAM_NAME = "sycl.experimental.level_zero.debug";
 
 thread_local uint64_t CallCorrelationID = 0;
 thread_local uint64_t DebugCorrelationID = 0;
@@ -35,25 +35,25 @@ enum class ZEApiKind {
 #undef _ZE_API
 };
 
-void enableL0Tracing() {
+void enableZeTracing() {
 #ifdef XPTI_ENABLE_INSTRUMENTATION
   if (!xptiTraceEnabled())
     return;
 
-  xptiRegisterStream(L0_CALL_STREAM_NAME);
-  xptiInitialize(L0_CALL_STREAM_NAME, GMajVer, GMinVer, GVerStr);
-  xptiRegisterStream(L0_DEBUG_STREAM_NAME);
-  xptiInitialize(L0_DEBUG_STREAM_NAME, GMajVer, GMinVer, GVerStr);
+  xptiRegisterStream(ZE_CALL_STREAM_NAME);
+  xptiInitialize(ZE_CALL_STREAM_NAME, GMajVer, GMinVer, GVerStr);
+  xptiRegisterStream(ZE_DEBUG_STREAM_NAME);
+  xptiInitialize(ZE_DEBUG_STREAM_NAME, GMajVer, GMinVer, GVerStr);
 
   uint64_t Dummy;
-  xpti::payload_t L0Payload("Level Zero Plugin Layer");
+  xpti::payload_t ZePayload("Level Zero Plugin Layer");
   GCallEvent =
-      xptiMakeEvent("L0 Plugin Layer", &L0Payload, xpti::trace_algorithm_event,
+      xptiMakeEvent("Level Zero Plugin Layer", &ZePayload, xpti::trace_algorithm_event,
                     xpti_at::active, &Dummy);
 
-  xpti::payload_t L0DebugPayload("L0 Plugin Debug Layer");
+  xpti::payload_t ZeDebugPayload("Level Zero Plugin Debug Layer");
   GDebugEvent =
-      xptiMakeEvent("L0 Plugin Debug Layer", &L0DebugPayload,
+      xptiMakeEvent("Level Zero Plugin Debug Layer", &ZeDebugPayload,
                     xpti::trace_algorithm_event, xpti_at::active, &Dummy);
 
   ze_result_t Status = zeInit(0);
@@ -70,7 +70,7 @@ void enableL0Tracing() {
   Status = zelTracerCreate(&TracerDesc, &Tracer);
 
   if (Status != ZE_RESULT_SUCCESS || Tracer == nullptr) {
-    std::cerr << "[WARNING] Failed to create L0 tracer: " << Status << "\n";
+    std::cerr << "[WARNING] Failed to create Level Zero tracer: " << Status << "\n";
     return;
   }
 
@@ -80,8 +80,8 @@ void enableL0Tracing() {
 #define _ZE_API(call, domain, cb, params_type)                                 \
   Prologue.domain.cb = [](params_type *Params, ze_result_t, void *, void **) { \
     if (xptiTraceEnabled()) {                                                  \
-      uint8_t CallStreamID = xptiRegisterStream(L0_CALL_STREAM_NAME);          \
-      uint8_t DebugStreamID = xptiRegisterStream(L0_DEBUG_STREAM_NAME);        \
+      uint8_t CallStreamID = xptiRegisterStream(ZE_CALL_STREAM_NAME);          \
+      uint8_t DebugStreamID = xptiRegisterStream(ZE_DEBUG_STREAM_NAME);        \
       CallCorrelationID = xptiGetUniqueId();                                   \
       DebugCorrelationID = xptiGetUniqueId();                                  \
       const char *FuncName = #call;                                            \
@@ -100,8 +100,8 @@ void enableL0Tracing() {
   Epilogue.domain.cb = [](params_type *Params, ze_result_t Result, void *,     \
                           void **) {                                           \
     if (xptiTraceEnabled()) {                                                  \
-      uint8_t CallStreamID = xptiRegisterStream(L0_CALL_STREAM_NAME);          \
-      uint8_t DebugStreamID = xptiRegisterStream(L0_DEBUG_STREAM_NAME);        \
+      uint8_t CallStreamID = xptiRegisterStream(ZE_CALL_STREAM_NAME);          \
+      uint8_t DebugStreamID = xptiRegisterStream(ZE_DEBUG_STREAM_NAME);        \
       const char *FuncName = #call;                                            \
       xptiNotifySubscribers(CallStreamID,                                      \
                             (uint16_t)xpti::trace_point_type_t::function_end,  \
@@ -122,24 +122,29 @@ void enableL0Tracing() {
 
   Status = zelTracerSetPrologues(Tracer, &Prologue);
   if (Status != ZE_RESULT_SUCCESS) {
-    std::cerr << "Failed to enable L0 tracing\n";
+    std::cerr << "Failed to enable Level Zero tracing\n";
     std::terminate();
   }
   Status = zelTracerSetEpilogues(Tracer, &Epilogue);
   if (Status != ZE_RESULT_SUCCESS) {
-    std::cerr << "Failed to enable L0 tracing\n";
+    std::cerr << "Failed to enable Level Zero tracing\n";
     std::terminate();
   }
 
   Status = zelTracerSetEnabled(Tracer, true);
   if (Status != ZE_RESULT_SUCCESS) {
-    std::cerr << "Failed to enable L0 tracing\n";
+    std::cerr << "Failed to enable Level Zero tracing\n";
     std::terminate();
   }
-#endif
+#endif // XPTI_ENABLE_INSTRUMENTATION
 }
 
-void disableL0Tracing() {
-  xptiFinalize(L0_CALL_STREAM_NAME);
-  xptiFinalize(L0_DEBUG_STREAM_NAME);
+void disableZeTracing() {
+#ifdef XPTI_ENABLE_INSTRUMENTATION
+  if (!xptiTraceEnabled())
+    return;
+
+  xptiFinalize(ZE_CALL_STREAM_NAME);
+  xptiFinalize(ZE_DEBUG_STREAM_NAME);
+#endif // XPTI_ENABLE_INSTRUMENTATION
 }

sycl/tools/sycl-prof/main.cpp

@@ -45,7 +45,6 @@ int main(int argc, char **argv, char *env[]) {
   NewEnv.push_back("XPTI_FRAMEWORK_DISPATCHER=libxptifw.so");
   NewEnv.push_back("XPTI_SUBSCRIBERS=libsycl_profiler_collector.so");
   NewEnv.push_back("XPTI_TRACE_ENABLE=1");
-  NewEnv.push_back("SYCL_PI_LEVEL_ZERO_ENABLE_TRACING=1");
   NewEnv.push_back("ZE_ENABLE_TRACING_LAYER=1");
 
   std::vector<std::string> Args;

sycl/tools/sycl-trace/collector.cpp

@@ -56,7 +56,6 @@ int main(int argc, char **argv, char *env[]) {
   };
   const auto EnableZETrace = [&]() {
     NewEnv.push_back("SYCL_TRACE_ZE_ENABLE=1");
-    NewEnv.push_back("SYCL_PI_LEVEL_ZERO_ENABLE_TRACING=1");
     NewEnv.push_back("ZE_ENABLE_TRACING_LAYER=1");
   };