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/omnitrace/library/components/pthread_gotcha.cpp

@@ -21,7 +21,6 @@
 // SOFTWARE.
 
 #include "library/components/pthread_gotcha.hpp"
-#include "library/components/omnitrace.hpp"
 #include "library/components/pthread_create_gotcha.hpp"
 #include "library/components/pthread_mutex_gotcha.hpp"
 #include "library/components/roctracer.hpp"
@@ -33,7 +32,7 @@
 #include "library/utility.hpp"
 
 #include <timemory/backends/threading.hpp>
-#include <timemory/sampling/allocator.hpp>
+#include <timemory/utility/macros.hpp>
 #include <timemory/utility/types.hpp>
 
 #include <pthread.h>
@@ -41,11 +40,34 @@
 #include <array>
 #include <vector>
 
+namespace tim
+{
+namespace operation
+{
+template <>
+struct stop<omnitrace::component::pthread_create_gotcha_t>
+{
+    using type = omnitrace::component::pthread_create_gotcha_t;
+
+    TIMEMORY_DEFAULT_OBJECT(stop)
+
+    template <typename... Args>
+    explicit stop(type&, Args&&...)
+    {}
+
+    template <typename... Args>
+    void operator()(type&, Args&&...)
+    {}
+};
+}  // namespace operation
+}  // namespace tim
+
 namespace omnitrace
 {
 namespace
 {
-using bundle_t = tim::lightweight_tuple<pthread_create_gotcha_t, pthread_mutex_gotcha_t>;
+using bundle_t = tim::lightweight_tuple<component::pthread_create_gotcha_t,
+                                        component::pthread_mutex_gotcha_t>;
 
 auto&
 get_sampling_on_child_threads_history(int64_t _idx = utility::get_thread_index())
@@ -62,6 +84,8 @@ get_bundle()
     if(!_v) _v = std::make_unique<bundle_t>("pthread_gotcha");
     return _v;
 }
+
+bool is_configured = false;
 }  // namespace
 
 //--------------------------------------------------------------------------------------//
@@ -69,15 +93,23 @@ get_bundle()
 void
 pthread_gotcha::configure()
 {
-    pthread_create_gotcha::configure();
-    pthread_mutex_gotcha::configure();
+    if(!is_configured)
+    {
+        ::omnitrace::component::pthread_create_gotcha::configure();
+        ::omnitrace::component::pthread_mutex_gotcha::configure();
+        is_configured = true;
+    }
 }
 
 void
 pthread_gotcha::shutdown()
 {
-    pthread_create_gotcha::shutdown();
-    pthread_mutex_gotcha::shutdown();
+    if(is_configured)
+    {
+        ::omnitrace::component::pthread_mutex_gotcha::shutdown();
+        // ::omnitrace::component::pthread_create_gotcha::shutdown();
+        is_configured = false;
+    }
 }
 
 bool
@@ -89,10 +121,10 @@ pthread_gotcha::sampling_enabled_on_child_threads()
 bool
 pthread_gotcha::push_enable_sampling_on_child_threads(bool _v)
 {
-    auto& _hist = get_sampling_on_child_threads_history();
-    bool  _last = sampling_on_child_threads();
-    _hist.emplace_back(_last);
+    bool _last                  = sampling_on_child_threads();
     sampling_on_child_threads() = _v;
+    auto& _hist                 = get_sampling_on_child_threads_history();
+    _hist.emplace_back(_last);
     return _last;
 }
 
@@ -128,6 +160,7 @@ pthread_gotcha::sampling_on_child_threads()
 void
 pthread_gotcha::start()
 {
+    configure();
     get_bundle()->start();
 }
 
@@ -135,6 +168,5 @@ void
 pthread_gotcha::stop()
 {
     get_bundle()->stop();
-    get_bundle().reset();
 }
 }  // namespace omnitrace