Jonathan R. Madsen
473f452d39
## 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]
109 řádky
4.4 KiB
C
109 řádky
4.4 KiB
C
// MIT License
|
|
//
|
|
// Copyright (c) 2022 Advanced Micro Devices, Inc. All Rights Reserved.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in all
|
|
// copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
|
|
#pragma once
|
|
|
|
// clang-format off
|
|
#define OMNITRACE_VERSION_STRING "@FULL_VERSION_STRING@"
|
|
#define OMNITRACE_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
|
|
#define OMNITRACE_VERSION_MINOR @PROJECT_VERSION_MINOR@
|
|
#define OMNITRACE_VERSION_PATCH @PROJECT_VERSION_PATCH@
|
|
#define OMNITRACE_GIT_DESCRIBE "@OMNITRACE_GIT_DESCRIBE@"
|
|
#define OMNITRACE_GIT_REVISION "@OMNITRACE_GIT_REVISION@"
|
|
|
|
#define OMNITRACE_DEFAULT_ROCM_PATH "@ROCmVersion_DIR@"
|
|
#define OMNITRACE_HIP_VERSION_STRING "@OMNITRACE_HIP_VERSION@"
|
|
#define OMNITRACE_HIP_VERSION_MAJOR @OMNITRACE_HIP_VERSION_MAJOR@
|
|
#define OMNITRACE_HIP_VERSION_MINOR @OMNITRACE_HIP_VERSION_MINOR@
|
|
#define OMNITRACE_HIP_VERSION_PATCH @OMNITRACE_HIP_VERSION_PATCH@
|
|
// clang-format on
|
|
|
|
#define OMNITRACE_VERSION \
|
|
((10000 * OMNITRACE_VERSION_MAJOR) + (100 * OMNITRACE_VERSION_MINOR) + \
|
|
OMNITRACE_VERSION_PATCH)
|
|
|
|
#define OMNITRACE_HIP_VERSION \
|
|
((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")
|
|
#define OMNITRACE_HIDDEN_API OMNITRACE_VISIBILITY("hidden")
|
|
#define OMNITRACE_INLINE OMNITRACE_ATTRIBUTE(always_inline) inline
|
|
#define OMNITRACE_NOINLINE OMNITRACE_ATTRIBUTE(noinline)
|
|
#define OMNITRACE_HOT OMNITRACE_ATTRIBUTE(hot)
|
|
#define OMNITRACE_CONST OMNITRACE_ATTRIBUTE(const)
|
|
#define OMNITRACE_PURE OMNITRACE_ATTRIBUTE(pure)
|
|
#define OMNITRACE_WEAK OMNITRACE_ATTRIBUTE(weak)
|
|
#define OMNITRACE_PACKED OMNITRACE_ATTRIBUTE(__packed__)
|
|
#define OMNITRACE_PACKED_ALIGN(VAL) OMNITRACE_PACKED OMNITRACE_ATTRIBUTE(__aligned__(VAL))
|
|
|
|
#if defined(OMNITRACE_CI) && OMNITRACE_CI > 0
|
|
# if defined(NDEBUG)
|
|
# undef NDEBUG
|
|
# endif
|
|
# if !defined(DEBUG)
|
|
# define DEBUG 1
|
|
# endif
|
|
# if defined(__cplusplus)
|
|
# include <cassert>
|
|
# else
|
|
# include <assert.h>
|
|
# endif
|
|
#endif
|
|
|
|
#define OMNITRACE_STRINGIZE(X) OMNITRACE_STRINGIZE2(X)
|
|
#define OMNITRACE_STRINGIZE2(X) #X
|
|
#define OMNITRACE_VAR_NAME_COMBINE(X, Y) X##Y
|
|
#define OMNITRACE_VARIABLE(Y) OMNITRACE_VAR_NAME_COMBINE(_omni_var_, Y)
|
|
#define OMNITRACE_LINESTR OMNITRACE_STRINGIZE(__LINE__)
|
|
#define OMNITRACE_ESC(...) __VA_ARGS__
|
|
|
|
#if defined(__cplusplus)
|
|
# if !defined(OMNITRACE_FOLD_EXPRESSION)
|
|
# define OMNITRACE_FOLD_EXPRESSION(...) ((__VA_ARGS__), ...)
|
|
# endif
|
|
#endif
|