Documentation + Miscellaneous Fixes (#36)
* Added documentation markdown source
* Replaced AARInternal with AMDResearch in URLs
* Renamed cpack artifact names
* Fix to testing and lulesh submodule checkout
* Docker updates
* CMake and CPack
- force CMAKE_INSTALL_LIBDIR to lib
- CPACK_DEBIAN_PACKAGE_RELEASE uses OMNITRACE_CPACK_SYSTEM_NAME
- CPACK_RPM_PACKAGE_RELEASE uses OMNITRACE_CPACK_SYSTEM_NAME
- Tweak LIBOMP_LIBRARY find in examples/openmp
- Tweak setup-env.sh.in
* Partial update of README
- status badges
- docs link
- removed install info (covered by docs)
* OMNITRACE_SAMPLING_CPUS setting
- enables control over which CPUs are sampled for frequency
* omnitrace exe updates
- exclude transaction clone, virtual thunk, non-virtual thunk
- module_function::start_address
- module_function::instructions
- verbosity > 0 encodes instructions into JSON
* Miscellaneous fixes
- relocate setup-env.sh.in
- add modulefile.in
- Updated README.md and source/docs/about.md
- cmake fix for libomp
- fix license in miscellaneous places
- dl.hpp and dl.cpp
* Update timemory and dyninst submodules
- timemory signals updates
- dyninst Movement-adhoc updates
* cmake format
[ROCm/rocprofiler-systems commit: 945f541965]
This commit is contained in:
committed by
GitHub
parent
4ddb8405ac
commit
127e30a4d7
@@ -0,0 +1,29 @@
|
||||
# Generating a Critical Trace
|
||||
|
||||
```eval_rst
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 4
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
A critical trace is defined in omnitrace as the most time-consuming path through a parallelized code.
|
||||
The steps for generating a critical trace are:
|
||||
|
||||
1. Enable the `OMNITRACE_CRITICAL_TRACE` setting
|
||||
2. Configure any other relevant critical-trace settings, as needed
|
||||
- `omnitrace-avail --categories settings::critical-trace`
|
||||
3. Execute application
|
||||
4. Locate the JSON files with `call-chain` in their name
|
||||
5. Provide these files to the `omnitrace-critical-trace` executable
|
||||
6. Open generated perfetto file in [ui.perfetto.dev](https://ui.perfetto.dev/)
|
||||
|
||||
## omnitrace-critical-trace Executable
|
||||
|
||||
The `omnitrace-critical-trace` executable post-processes one or more `call-chain` JSON files and generates a perfetto output
|
||||
for visualizing the critical trace.
|
||||
|
||||
**INCOMPLETE**
|
||||
|
||||
This executable is still under-development.
|
||||
Reference in New Issue
Block a user