Set Sysman environment (#589)

* Process all kernels/commands submitted upon reseting/destroying command lists and queuing/executing command lists

* Emit more information in error messages

* Fix help message format

* Fix help message

* Check OtherStall[Events] instead of 'OtherStall[Events],' for EU stall sampling metrics

* Remove trailing ',' in 'OtherStall[Events],' search pattern

* Fix segfault if --chrome-event-buffer-size 0 is passed in

* Fix segfault if --chrome-event-buffer-size 0 is passed in

* Fix segfault if --chrome-event-buffer-size 0 is passed in

* Fix segfault if --chrome-event-buffer-size 0 is passed in

* Try to shutdown gracefully in case the application is crashed or terminated

* Remove copy elision warning on Windows

* Added option --teardown-on-signal

* Added option --teardown-on-signal

* Change 'shutdown' to 'shut down'

* Update tools/unitrace/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Change 'shutdown' to 'shut down'

* Add option 'no-follow-child-process;

* Add option 'no-follow-child-process'

* Add option 'no-follow-child-process'

* Add 'no-follow-child-process' option

* Add 'no-follow-child-process' option

* Change option --no-follow-child-process to --follow-child-process

* Change option --no-follow-child-process to --follow-child-process

* Change option --no-follow-child-process to --follow-child-process

* Add option --follow-child-processand fix regressions in gen_tracing_callbacks.py

* Add option --follow-child-processand fix regressions in gen_tracing_callbacks.py

* Add option --follow-child-processand fix regressions in gen_tracing_callbacks.py

* Add option --follow-child-processand fix regressions in gen_tracing_callbacks.py

* Add option --follow-child-processand fix regressions in gen_tracing_callbacks.py

* Revise README.md and rename doc/images/Roofline.png doc/images/roofline.png

* Revise README.md and rename doc/images/Roofline.png doc/images/roofline.png

* Revise README.md and rename doc/images/Roofline.png doc/images/roofline.png

* Revise README.md and rename doc/images/Roofline.png doc/images/roofline.png

* Revise README.md and rename doc/images/Roofline.png doc/images/roofline.png

* Fix build errors with -DBUILD_WITH_XPTI=0

* Write out process info and thread info right after it is available

* Write out process and thread info on the fly and make sure to properly close JSON trace files in postprocess scripts if the trace files

* Validate trace file before loading

* Add closing tags in trace file if they are missing

* Write out process and thread info as soon as they are available

* Remove deprecated options

* Bump minor version number

* Write out process and thread info as soon as it is available

* Explicitly set api_type_ for host events

* Explicitly set api_type_ for host events

* Install uniview.py

* Use process id as dummy rank id to handle distributed computing environment that does not use MPI

* Reduce metric query pool size to save memory

* Use process id as dummy rank id in case that distrubuted computing envrionment does not use MPI

* Use process id as dummy rank id in case that distrubuted computing envrionment does not use MPI

* More meaningful error message in case file is cannot be opened for writing

* More meaningful error message in case file is cannot be opened for writing

* Write out process info and thread info as soon as they are available

* Fix race condition if --chrome-event-buffer-size is set to 0

* Use process id as dummy rank in case distributed environment does not MPI

* Use process id as dummy rank in case distributed environment does not MPI

* Update tools/unitrace/src/chromelogger.h

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update tools/unitrace/src/levelzero/ze_collector.h

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Replacing manual lock/unlock calls with scoped lock calls

* Update tools/unitrace/scripts/tracemerge/mergetrace.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Install uniview.py

* Revise README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update tools/unitrace/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update tools/unitrace/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update tools/unitrace/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Revise README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Set sysman envrionment for oneCCL

* Remove extraneous parentheses around the comparison to silence compiler warnings

* Enable sysman environment for OpenCL and oneCCL

---------

Co-authored-by: Zhiqiang Ma <zma2@DUT6018BMGFRD.fm.intel.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

tools/unitrace/src/levelzero/ze_collector.h

@@ -4667,7 +4667,7 @@ class ZeCollector {
     ZeCollector* collector = reinterpret_cast<ZeCollector*>(global_data);
 
     if (UniController::IsCollectionEnabled()) {
-        if ((result == ZE_RESULT_SUCCESS)) {
+        if (result == ZE_RESULT_SUCCESS) {
            local_device_submissions_.SubmitStagedKernelCommandAndMetricQueries(collector->event_cache_, kids);
         }
         else {

tools/unitrace/src/unitrace.cc

@@ -253,6 +253,7 @@ int ParseArgs(int argc, char* argv[]) {
 #if BUILD_WITH_ITT
     } else if (strcmp(argv[i], "--ccl-summary-report") == 0 || strcmp(argv[i], "-r") == 0) {
       utils::SetEnv("UNITRACE_CclSummaryReport", "1");
+      utils::SetEnv("UNITRACE_ChromeIttLogging", "1");
       utils::SetEnv("CCL_ITT_LEVEL", "1");
       ++app_index;
 #endif /* BUILD_WITH_ITT */
@@ -722,12 +723,9 @@ int main(int argc, char *argv[]) {
 #endif
 
   SetTracingEnvironment();
+  //OpenCL and oneCCL require sysman enabled
+  SetSysmanEnvironment();
 
-  if (utils::GetEnv("UNITRACE_OpenCLTracing") == "1") {
-    // opencl tracing requires sysman enabled for device enumeration
-    SetSysmanEnvironment();
-  }
-
   if (utils::GetEnv("UNITRACE_MetricQuery") == "1") {
     // UNITRACE_KernelMetrics is not set
     SetProfilingEnvironment();