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/source/lib/common/CMakeLists.txt

@@ -26,7 +26,9 @@ get_filename_component(COMMON_BINARY_INCLUDE_DIR "${CMAKE_CURRENT_BINARY_DIR}" D
 target_include_directories(
     omnitrace-common-library
     INTERFACE $<BUILD_INTERFACE:${COMMON_SOURCE_INCLUDE_DIR}>
-    INTERFACE $<BUILD_INTERFACE:${COMMON_BINARY_INCLUDE_DIR}>)
+              $<BUILD_INTERFACE:${COMMON_BINARY_INCLUDE_DIR}>
+              $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/external/timemory/source>
+              $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/external/timemory/source>)
 
 target_compile_definitions(omnitrace-common-library
                            INTERFACE $<BUILD_INTERFACE:OMNITRACE_INTERNAL_BUILD=1>)

projects/rocprofiler-systems/source/lib/common/defines.h.in

@@ -45,6 +45,28 @@
     ((10000 * OMNITRACE_HIP_VERSION_MAJOR) + (100 * OMNITRACE_HIP_VERSION_MINOR) +       \
      OMNITRACE_HIP_VERSION_PATCH)
 
+// clang-format off
+#if !defined(OMNITRACE_MAX_THREADS)
+#    define OMNITRACE_MAX_THREADS @OMNITRACE_MAX_THREADS@
+#endif
+
+#if !defined(OMNITRACE_MAX_UNWIND_DEPTH)
+#    define OMNITRACE_MAX_UNWIND_DEPTH @OMNITRACE_MAX_UNWIND_DEPTH@
+#endif
+// clang-format on
+
+#if !defined(OMNITRACE_MAX_COUNTERS)
+#    define OMNITRACE_MAX_COUNTERS 25
+#endif
+
+#if !defined(OMNITRACE_ROCM_LOOK_AHEAD)
+#    define OMNITRACE_ROCM_LOOK_AHEAD 128
+#endif
+
+#if !defined(OMNITRACE_MAX_ROCM_QUEUES)
+#    define OMNITRACE_MAX_ROCM_QUEUES OMNITRACE_MAX_THREADS
+#endif
+
 #define OMNITRACE_ATTRIBUTE(...)    __attribute__((__VA_ARGS__))
 #define OMNITRACE_VISIBILITY(MODE)  OMNITRACE_ATTRIBUTE(visibility(MODE))
 #define OMNITRACE_PUBLIC_API        OMNITRACE_VISIBILITY("default")

projects/rocprofiler-systems/source/lib/common/invoke.hpp

@@ -35,6 +35,14 @@
 #    error OMNITRACE_COMMON_LIBRARY_NAME must be defined
 #endif
 
+#if !defined(OMNITRACE_COMMON_LIBRARY_LOG_START)
+#    define OMNITRACE_COMMON_LIBRARY_LOG_START
+#endif
+
+#if !defined(OMNITRACE_COMMON_LIBRARY_LOG_END)
+#    define OMNITRACE_COMMON_LIBRARY_LOG_END
+#endif
+
 namespace omnitrace
 {
 inline namespace common
@@ -98,11 +106,13 @@ invoke(const char* _name, int _verbose, bool& _toggle, FuncT&& _func, Args... _a
             if(_verbose >= 3)
             {
                 fflush(stderr);
+                OMNITRACE_COMMON_LIBRARY_LOG_START
                 fprintf(stderr,
                         "[omnitrace][" OMNITRACE_COMMON_LIBRARY_NAME
                         "][%li][%i] %s(%s)\n",
                         get_thread_index(), _lk, _name,
                         join(QuoteStrings{}, ", ", _args...).c_str());
+                OMNITRACE_COMMON_LIBRARY_LOG_END
                 fflush(stderr);
             }
             return std::invoke(std::forward<FuncT>(_func), _args...);
@@ -110,20 +120,24 @@ invoke(const char* _name, int _verbose, bool& _toggle, FuncT&& _func, Args... _a
         else if(_verbose >= 2)
         {
             fflush(stderr);
+            OMNITRACE_COMMON_LIBRARY_LOG_START
             fprintf(stderr,
                     "[omnitrace][" OMNITRACE_COMMON_LIBRARY_NAME
                     "][%li] %s(%s) was guarded :: value = %i\n",
                     get_thread_index(), _name,
                     join(QuoteStrings{}, ", ", _args...).c_str(), _lk);
+            OMNITRACE_COMMON_LIBRARY_LOG_END
             fflush(stderr);
         }
     }
     else if(_verbose >= 0)
     {
+        OMNITRACE_COMMON_LIBRARY_LOG_START
         fprintf(stderr,
                 "[omnitrace][" OMNITRACE_COMMON_LIBRARY_NAME
                 "][%li] %s(%s) ignored :: null function pointer\n",
                 get_thread_index(), _name, join(QuoteStrings{}, ", ", _args...).c_str());
+        OMNITRACE_COMMON_LIBRARY_LOG_END
     }
 
     using return_type = decltype(std::invoke(std::forward<FuncT>(_func), _args...));

projects/rocprofiler-systems/source/lib/common/setup.hpp

@@ -42,12 +42,35 @@
 #    endif
 #endif
 
+#if !defined(OMNITRACE_SETUP_LOG_START)
+#    if defined(OMNITRACE_COMMON_LIBRARY_LOG_START)
+#        define OMNITRACE_SETUP_LOG_START OMNITRACE_COMMON_LIBRARY_LOG_START
+#    elif defined(TIMEMORY_LOG_COLORS_AVAILABLE)
+#        define OMNITRACE_SETUP_LOG_START                                                \
+            fprintf(stderr, "%s", ::tim::log::color::info());
+#    else
+#        define OMNITRACE_SETUP_LOG_START
+#    endif
+#endif
+
+#if !defined(OMNITRACE_SETUP_LOG_END)
+#    if defined(OMNITRACE_COMMON_LIBRARY_LOG_END)
+#        define OMNITRACE_SETUP_LOG_END OMNITRACE_COMMON_LIBRARY_LOG_END
+#    elif defined(TIMEMORY_LOG_COLORS_AVAILABLE)
+#        define OMNITRACE_SETUP_LOG_END fprintf(stderr, "%s", ::tim::log::color::end());
+#    else
+#        define OMNITRACE_SETUP_LOG_END
+#    endif
+#endif
+
 #define OMNITRACE_SETUP_LOG(CONDITION, ...)                                              \
     if(CONDITION)                                                                        \
     {                                                                                    \
         fflush(stderr);                                                                  \
+        OMNITRACE_SETUP_LOG_START                                                        \
         fprintf(stderr, "[omnitrace]" OMNITRACE_SETUP_LOG_NAME "[%i] ", getpid());       \
         fprintf(stderr, __VA_ARGS__);                                                    \
+        OMNITRACE_SETUP_LOG_END                                                          \
         fflush(stderr);                                                                  \
     }