Rework sampling and colorized logs (#140)

## Overview

This is a significant PR which has 3 very notable characteristics:

1. Omnitrace colorizes most of it's logging
2. Completely reworked the sampling 
  - Samples now record the current instruction pointers instead of strings
    - This _dramatically_ decreases the overhead of taking a sample
  - The collection of metrics during a sample are split out into another component, enabling that data collection to be disabled -- which decreases the sampling overhead even further
  - When both `OMNITRACE_SAMPLING_CPUTIME` and `OMNITRACE_SAMPLING_REALTIME` are ON:
    - `OMNITRACE_SAMPLING_CPUTIME_FREQ` and `OMNITRACE_SAMPLING_REALTIME_FREQ` can be used to individually control the sampling frequency 
  - `OMNITRACE_SAMPLING_CPUTIME_DELAY` and `OMNITRACE_SAMPLING_REALTIME_DELAY` can be used to individually control the delay time before starting
  - Now, omnitrace does not start a real-time sampler on the main thread unless `OMNITRACE_SAMPLING_REALTIME` is ON
    - In the future, an `OMNITRACE_SAMPLING_TIDS` (and real-time, cpu-time variants) configuration variable(s) will allow you to select which threads will be sampled
3. Files produced by `omnitrace` exe -- `available-instr.txt`, `instrumented-instr.txt`, etc. -- now no longer has `-instr` suffix and are placed in `instrumentation/` subfolder, i.e. `available-instr.txt` -> instrumentation/available.txt`
  - This helped de-clutter the output folder

Most of the other edits were reorganization (e.g. internal namespace changes), cleanup, and splitting up functionality.

## Bug Fixes

There is a bug fix with respect to the HSA callbacks which disabled sampling on child threads when an HSA API call was made

## Details

- created thread_info struct for mapping different thread IDs
- reorganized file structure significantly
- added categories.hpp, concepts.hpp
- moved around name trait definitions
- moved all omnitrace components into `omnitrace::component` namespace
  - there was a lot of inconsistency b/t using `tim::component` in some places and `omnitrace::component`
  - added macros like OMNITRACE_DECLARE_COMPONENT in lieu of TIMEMORY_DECLARE_COMPONENT
- OMNITRACE_CRITICAL_TRACE_NUM_THREADS -> OMNITRACE_THREAD_POOL_SIZE
- roctracer and critical_trace use same thread pool
- critical_trace functions do not lock anymore bc of thread-local TaskGroup
- added `component::local_category_region` to support using `component::category_region` without explicitly passing in name
- removed `component::omnitrace` (unused)
- migrated KokkosP and OMPT to use `component::local_category_region`
  - removed `component::user_region` as a result
- migrated omnitrace_{push,pop}_{trace,region}_hidden to use component::category_region
  - removed `component::functors` as a result
- migrated some ppdefs
- `api::omnitrace` -> `project::omnitrace`
- `api::(...)` -> `category::(...)`
- improved recording the execution time of threads
  - migrated this functionality out of pthread_create_gotcha and into thread_info
- moved mpi_gotcha, fork_gotcha, exit_gotcha, rcclp into omnitrace::component namespace
- split backtrace up into backtrace, backtrace_metrics, backtrace_timestamp components
- sampling.cpp handles setup and post-processing that was formerly in backtrace
- updated logging to use colors
- `OMNITRACE_COLORIZED_LOG` config variable
- updated docs on JSON output from timemory
- instrumentation info in instrumentation subfolder
- added testing for KokkosP entries
- added testing for ompt entries
- add_critical_trace function defined in critical_trace.hpp
- disable push_thread_state and pop_thread_state when thread state is Disabled or Completed
- add comp::page_rss to main bundle
- thread_data supports std::optional instead of std::unique_ptr
- thread_data supports tim::identity<T> to avoid unique_ptr or optional
- tracing::record_thread_start_time()
- tracing::push_timemory and tracing::pop_timemory are templated on CategoryT
- removed anonymous namespace from omnitrace::utility
- sampling backtrace stores instruction pointers instead of strings
- component::category_region updates
  - handle disabled thread state
  - handle finalized state
  - fewer debug messages
  - invoke thread_init()
  - invoke thread_init_sampling()
  - handle push/pop count based on category
  - push/pop count only modified when used
- component::cpu_freq
- components/ensure_storage.hpp
- reworked the pthread_create replacement function
- updated parallel-overhead example to report # of times locked
- OMNITRACE_MAX_UNWIND_DEPTH build option
- update timemory submodule

[ROCm/rocprofiler-systems commit: 808ea7dfa7]

projects/rocprofiler-systems/cmake/BuildSettings.cmake

@@ -82,6 +82,10 @@ add_flag_if_avail(
     "-W" "-Wall" "-Wno-unknown-pragmas" "-Wno-unused-function" "-Wno-ignored-attributes"
     "-Wno-attributes" "-Wno-missing-field-initializers")
 
+if(OMNITRACE_BUILD_DEBUG)
+    add_flag_if_avail("-g" "-gdwarf-3" "-fno-omit-frame-pointer")
+endif()
+
 if(WIN32)
     # suggested by MSVC for spectre mitigation in rapidjson implementation
     add_cxx_flag_if_avail("/Qspectre")

projects/rocprofiler-systems/cmake/Formatting.cmake

@@ -87,7 +87,7 @@ if(OMNITRACE_CLANG_FORMAT_EXE
     if(OMNITRACE_BLACK_FORMAT_EXE)
         add_custom_target(
             format-omnitrace-python
-            ${OMNITRACE_BLACK_FORMAT_EXE} ${PROJECT_SOURCE_DIR}
+            ${OMNITRACE_BLACK_FORMAT_EXE} -q ${PROJECT_SOURCE_DIR}
             COMMENT
                 "[omnitrace] Running Python formatter ${OMNITRACE_BLACK_FORMAT_EXE}...")
         if(NOT TARGET format-python)

projects/rocprofiler-systems/cmake/Packages.cmake

@@ -265,8 +265,21 @@ if(OMNITRACE_BUILD_DYNINST)
         OFF
         CACHE BOOL "Enable LTO for dyninst libraries")
 
-    omnitrace_save_variables(PIC VARIABLES CMAKE_POSITION_INDEPENDENT_CODE)
+    if(NOT DEFINED CMAKE_INSTALL_RPATH)
+        set(CMAKE_INSTALL_RPATH "")
+    endif()
+
+    if(NOT DEFINED CMAKE_BUILD_RPATH)
+        set(CMAKE_BUILD_RPATH "")
+    endif()
+
+    omnitrace_save_variables(
+        PIC VARIABLES CMAKE_POSITION_INDEPENDENT_CODE CMAKE_INSTALL_RPATH
+                      CMAKE_BUILD_RPATH CMAKE_INSTALL_RPATH_USE_LINK_PATH)
     set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+    set(CMAKE_INSTALL_RPATH_USE_LINK_PATH OFF)
+    set(CMAKE_BUILD_RPATH "\$ORIGIN:\$ORIGIN/omnitrace")
+    set(CMAKE_INSTALL_RPATH "\$ORIGIN:\$ORIGIN/omnitrace")
     set(DYNINST_TPL_INSTALL_PREFIX
         "omnitrace"
         CACHE PATH "Third-party library install-tree install prefix" FORCE)
@@ -274,7 +287,9 @@ if(OMNITRACE_BUILD_DYNINST)
         "omnitrace"
         CACHE PATH "Third-party library install-tree install library prefix" FORCE)
     add_subdirectory(external/dyninst EXCLUDE_FROM_ALL)
-    omnitrace_restore_variables(PIC VARIABLES CMAKE_POSITION_INDEPENDENT_CODE)
+    omnitrace_restore_variables(
+        PIC VARIABLES CMAKE_POSITION_INDEPENDENT_CODE CMAKE_INSTALL_RPATH
+                      CMAKE_BUILD_RPATH CMAKE_INSTALL_RPATH_USE_LINK_PATH)
 
     add_library(Dyninst::Dyninst INTERFACE IMPORTED)
     foreach(_LIB common dyninstAPI parseAPI instructionAPI symtabAPI stackwalk)
@@ -299,7 +314,8 @@ if(OMNITRACE_BUILD_DYNINST)
                 TARGETS ${_LIB}
                 DESTINATION ${CMAKE_INSTALL_LIBDIR}/omnitrace
                 COMPONENT dyninst
-                PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_LIBDIR}/omnitrace/include)
+                PUBLIC_HEADER DESTINATION ${PROJECT_BINARY_DIR}/.discard/omnitrace/include
+                )
         endif()
     endforeach()
 
@@ -502,7 +518,7 @@ endif()
 #
 # ----------------------------------------------------------------------------------------#
 
-target_compile_definitions(omnitrace-timemory-config INTERFACE TIMEMORY_PAPI_ARRAY_SIZE=16
+target_compile_definitions(omnitrace-timemory-config INTERFACE TIMEMORY_PAPI_ARRAY_SIZE=12
                                                                TIMEMORY_USE_ROOFLINE=0)
 
 if(OMNITRACE_BUILD_STACK_PROTECTOR)
@@ -510,6 +526,11 @@ if(OMNITRACE_BUILD_STACK_PROTECTOR)
                              "-Wstack-protector")
 endif()
 
+if(OMNITRACE_BUILD_DEBUG)
+    add_target_flag_if_avail(omnitrace-timemory-config "-fno-omit-frame-pointer" "-g"
+                             "-gdwarf-3")
+endif()
+
 set(TIMEMORY_EXTERNAL_INTERFACE_LIBRARY
     omnitrace-timemory-config
     CACHE STRING "timemory configuration interface library")
@@ -563,6 +584,9 @@ set(TIMEMORY_USE_PAPI
 set(TIMEMORY_USE_LIBUNWIND
     ON
     CACHE BOOL "Enable libunwind support in timemory")
+set(TIMEMORY_USE_VISIBILITY
+    OFF
+    CACHE BOOL "Enable/disable using visibility decorations")
 
 if(DEFINED TIMEMORY_BUILD_GOTCHA AND NOT TIMEMORY_BUILD_GOTCHA)
     omnitrace_message(
@@ -581,6 +605,9 @@ set(TIMEMORY_BUILD_LIBUNWIND
 set(TIMEMORY_BUILD_EXTRA_OPTIMIZATIONS
     ${OMNITRACE_BUILD_EXTRA_OPTIMIZATIONS}
     CACHE BOOL "Enable building GOTCHA library from submodule" FORCE)
+set(TIMEMORY_BUILD_ERT
+    OFF
+    CACHE BOOL "Disable building ERT support" FORCE)
 
 # timemory build settings
 set(TIMEMORY_TLS_MODEL
@@ -595,6 +622,10 @@ set(TIMEMORY_SETTINGS_PREFIX
 set(TIMEMORY_PROJECT_NAME
     "omnitrace"
     CACHE STRING "Name for configuration")
+set(TIMEMORY_CXX_LIBRARY_EXCLUDE
+    "kokkosp.cpp;pthread.cpp;timemory_c.cpp;trace.cpp;weak.cpp;library.cpp"
+    CACHE STRING "Timemory C++ library implementation files to exclude from compiling")
+
 mark_as_advanced(TIMEMORY_SETTINGS_PREFIX)
 mark_as_advanced(TIMEMORY_PROJECT_NAME)