Remove Critical Trace Support (#327)

* Delete core critical-trace files * Update docs and README * Update workflows * Update testing * Update cmake * Remove critical trace usage in source code * Update source/docs/critical_trace.md - fix spelling * Formatting * Update bin/omnitrace-avail/avail.cpp - statically allocate shared pointers for timemory manager and hash id/aliases to prevent use-after-free errors
ROCm · Apr 23, 2024 · 9499e2f · 9499e2f
1 parent b81db80
commit 9499e2f
Show file tree

Hide file tree

Showing 45 changed files with 55 additions and 2,954 deletions.
diff --git a/.github/workflows/opensuse.yml b/.github/workflows/opensuse.yml
@@ -107,8 +107,6 @@ jobs:
         ldd $(which omnitrace-avail)
         omnitrace-avail --help
         omnitrace-avail -a
-        which omnitrace-critical-trace
-        ldd $(which omnitrace-critical-trace)
         which omnitrace
         ldd $(which omnitrace)
         omnitrace-instrument --help

diff --git a/.github/workflows/redhat.yml b/.github/workflows/redhat.yml
@@ -125,7 +125,7 @@ jobs:
       run: |
         set -v
         source /opt/omnitrace/share/omnitrace/setup-env.sh
-        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,rewrite,runtime,critical-trace,python}=1
+        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,rewrite,runtime,python}=1
 
     - name: Test User API
       timeout-minutes: 10

diff --git a/.github/workflows/ubuntu-bionic.yml b/.github/workflows/ubuntu-bionic.yml
@@ -138,8 +138,6 @@ jobs:
         ldd $(which omnitrace-avail)
         omnitrace-avail --help
         omnitrace-avail -a
-        which omnitrace-critical-trace
-        ldd $(which omnitrace-critical-trace)
         which omnitrace
         ldd $(which omnitrace)
         omnitrace-instrument --help

diff --git a/.github/workflows/ubuntu-focal.yml b/.github/workflows/ubuntu-focal.yml
@@ -196,7 +196,7 @@ jobs:
         module use /opt/omnitrace/share/modulefiles
         module avail
         module load omnitrace
-        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,rewrite,runtime,critical-trace}=1 --test-omnitrace-python=${{ matrix.python }}
+        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,rewrite,runtime}=1 --test-omnitrace-python=${{ matrix.python }}
 
     - name: Test User API
       timeout-minutes: 10
@@ -362,7 +362,7 @@ jobs:
       shell: bash
       run: |
         source /opt/omnitrace/share/omnitrace/setup-env.sh
-        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime,critical-trace}=1
+        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime}=1
 
     - name: Test User API
       timeout-minutes: 10
@@ -525,7 +525,7 @@ jobs:
       run: |
         set -v
         source /opt/omnitrace/share/omnitrace/setup-env.sh
-        ${{ github.workspace }}/scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime,critical-trace}=1
+        ${{ github.workspace }}/scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime}=1
 
     - name: Test Install with Modulefile
       timeout-minutes: 15
@@ -534,7 +534,7 @@ jobs:
         source /usr/share/modules/init/$(basename ${SHELL})
         module use /opt/omnitrace/share/modulefiles
         module load omnitrace
-        ${{ github.workspace }}/scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime,critical-trace}=1
+        ${{ github.workspace }}/scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime}=1
 
     - name: Test User API
       timeout-minutes: 10

diff --git a/.github/workflows/ubuntu-jammy.yml b/.github/workflows/ubuntu-jammy.yml
@@ -216,7 +216,7 @@ jobs:
         module use /opt/omnitrace/share/modulefiles
         module avail
         module load omnitrace
-        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime,critical-trace}=1
+        ./scripts/test-install.sh --test-omnitrace-{instrument,avail,sample,python,rewrite,runtime}=1
 
     - name: Test User API
       timeout-minutes: 10

diff --git a/README.md b/README.md
@@ -35,7 +35,6 @@ such as the memory usage, page-faults, and context-switches, and thread-level me
   - Background thread records process-, system- and device-level metrics while the application executes
 - Causal profiling
   - Quantifies the potential impact of optimizations in parallel codes
-- Critical trace generation
 
 ### Data Analysis
 
@@ -45,7 +44,6 @@ such as the memory usage, page-faults, and context-switches, and thread-level me
 - Comprehensive traces
   - Every individual event/measurement
 - Application speedup predictions resulting from potential optimizations in functions and lines of code (causal profiling)
-- Critical trace analysis (alpha)
 
 ### Parallelism API Support
 

diff --git a/scripts/test-install.sh b/scripts/test-install.sh
@@ -42,7 +42,6 @@ fi
 : ${ENABLE_OMNITRACE_PYTHON:=0}
 : ${ENABLE_OMNITRACE_REWRITE:=1}
 : ${ENABLE_OMNITRACE_RUNTIME:=1}
-: ${ENABLE_OMNITRACE_CRITICAL_TRACE:=1}
 
 usage()
 {
@@ -55,7 +54,6 @@ usage()
     print_option test-omnitrace-python "0|1" "Enable testing omnitrace-python" "${ENABLE_OMNITRACE_PYTHON}"
     print_option test-omnitrace-rewrite "0|1" "Enable testing omnitrace-instrument binary rewrite" "${ENABLE_OMNITRACE_REWRITE}"
     print_option test-omnitrace-runtime "0|1" "Enable testing omnitrace-instrument runtime instrumentation" "${ENABLE_OMNITRACE_RUNTIME}"
-    print_option test-omnitrace-critial-trace "0|1" "Enable testing omnitrace-instrument critical trace" "${ENABLE_OMNITRACE_CRITICAL_TRACE}"
 }
 
 cat << EOF > ${CONFIG_DIR}/omnitrace.cfg
@@ -126,10 +124,6 @@ do
             ENABLE_OMNITRACE_RUNTIME=${VAL}
             continue
             ;;
-        --test-omnitrace-critical-trace)
-            ENABLE_OMNITRACE_CRITICAL_TRACE=${VAL}
-            continue
-            ;;
         --source-dir)
             SOURCE_DIR=${VAL}
             continue
@@ -204,16 +198,9 @@ test-omnitrace-runtime()
     verbose-run omnitrace-instrument -e -v 1 -- ${LS_NAME} ${LS_ARGS}
 }
 
-test-omnitrace-critical-trace()
-{
-    which omnitrace-critical-trace
-    ldd $(which omnitrace-critical-trace)
-}
-
 if [ "${ENABLE_OMNITRACE_INSTRUMENT}" -ne 0 ]; then verbose-run test-omnitrace; fi
 if [ "${ENABLE_OMNITRACE_AVAIL}" -ne 0 ]; then verbose-run test-omnitrace-avail; fi
 if [ "${ENABLE_OMNITRACE_SAMPLE}" -ne 0 ]; then verbose-run test-omnitrace-sample; fi
 if [ "${ENABLE_OMNITRACE_PYTHON}" -ne 0 ]; then verbose-run test-omnitrace-python; fi
 if [ "${ENABLE_OMNITRACE_REWRITE}" -ne 0 ]; then verbose-run test-omnitrace-rewrite; fi
 if [ "${ENABLE_OMNITRACE_RUNTIME}" -ne 0 ]; then verbose-run test-omnitrace-runtime; fi
-if [ "${ENABLE_OMNITRACE_CRITICAL_TRACE}" -ne 0 ]; then verbose-run test-omnitrace-critical-trace; fi
diff --git a/source/bin/CMakeLists.txt b/source/bin/CMakeLists.txt
@@ -15,7 +15,6 @@ endif()
 
 # executables
 add_subdirectory(omnitrace-avail)
-add_subdirectory(omnitrace-critical-trace)
 add_subdirectory(omnitrace-causal)
 add_subdirectory(omnitrace-sample)
 add_subdirectory(omnitrace-instrument)

diff --git a/source/bin/omnitrace-avail/avail.cpp b/source/bin/omnitrace-avail/avail.cpp
@@ -41,6 +41,8 @@
 #include <timemory/components/placeholder.hpp>
 #include <timemory/components/properties.hpp>
 #include <timemory/components/skeletons.hpp>
+#include <timemory/hash/types.hpp>
+#include <timemory/manager/manager.hpp>
 #include <timemory/mpl/types.hpp>
 #include <timemory/timemory.hpp>
 #include <timemory/unwind/bfd.hpp>
@@ -118,13 +120,22 @@ namespace
 {
 // initialize HIP before main so that libomnitrace is not HSA_TOOLS_LIB
 int gpu_count = omnitrace::gpu::hip_device_count();
+
+// statically allocated shared_ptrs to prevent use after free errors
+auto timemory_manager      = tim::manager::master_instance();
+auto timemory_hash_ids     = tim::hash::get_main_hash_ids();
+auto timemory_hash_aliases = tim::hash::get_main_hash_aliases();
 }  // namespace
 
 //--------------------------------------------------------------------------------------//
 
 int
 main(int argc, char** argv)
 {
+    (void) timemory_manager;       // suppress unused variables
+    (void) timemory_hash_ids;      //
+    (void) timemory_hash_aliases;  //
+
     tim::unwind::set_bfd_verbose(3);
     tim::set_env("OMNITRACE_INIT_TOOLING", "OFF", 1);
     omnitrace_init_library();

diff --git a/source/bin/omnitrace-causal/impl.cpp b/source/bin/omnitrace-causal/impl.cpp
@@ -200,7 +200,6 @@ get_initial_environment()
     update_env(_env, "OMNITRACE_TRACE", false);
     update_env(_env, "OMNITRACE_PROFILE", false);
     update_env(_env, "OMNITRACE_USE_PROCESS_SAMPLING", false);
-    update_env(_env, "OMNITRACE_CRITICAL_TRACE", false);
     update_env(_env, "OMNITRACE_THREAD_POOL_SIZE",
                get_env<int>("OMNITRACE_THREAD_POOL_SIZE", 0));
     update_env(_env, "OMNITRACE_LAUNCHER", "omnitrace-causal");

diff --git a/source/bin/omnitrace-critical-trace/CMakeLists.txt b/source/bin/omnitrace-critical-trace/CMakeLists.txt