Files
rocm-systems/source/docs
Jonathan R. Madsen 6b374b8e68 Improve static singleton memory safety (#316)
* Update GitHub links

* Update samples/api_buffered_tracing/client.cpp

- check if initialized before forcing initialization

* Add lib/common/static_object.*

- template class for creating a static allocation in the binary which has all the properties of a heap allocated singleton but does not trigger leak sanitizers

* Update include/rocprofiler-sdk/internal_threading.h

- document return values

* Update lib/rocprofiler-sdk/internal_threading.cpp

- return codes from rocprofiler_create_callback_thread and rocprofiler_assign_callback_thread
- use common::static_object for thread-pool object

* Update lib/rocprofiler-sdk/agent.cpp

- use common::static_object to store array of strings and their hashes

* Update lib/rocprofiler-sdk/hsa/code_object.cpp

- use common::static_object to store array of strings and their hashes to ensure strings exist until termination

* Update lib/rocprofiler-sdk/registration.cpp

- use common::static_object to store status and client libraries
- update return values for rocprofiler_set_api_table

* Update lib/rocprofiler-sdk/hsa/hsa.cpp

- check registration::get_fini_status() in hsa_api_impl::functor<Idx>(args...)

* Update lib/rocprofiler-sdk/context/context.cpp

- using common::static_object for correlation id map
2023-12-19 13:47:21 -06:00
..
2023-09-12 12:34:36 -05:00
2023-09-12 12:34:36 -05:00
2023-09-12 12:34:36 -05:00
2023-09-12 12:34:36 -05:00
2023-09-12 12:34:36 -05:00
2023-09-12 12:34:36 -05:00
2023-09-12 12:34:36 -05:00

ROCprofiler Documentation

Build Instructions

  1. Install conda
    • wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
    • bash miniconda.sh -b -p /opt/conda
    • export PATH=${PATH}:/opt/conda
  2. Install conda environment
    • source activate
    • conda env create -n rocprofiler-docs -f environment.yml
    • conda activate rocprofiler-docs
  3. Build the docs
    • ../scripts/update-docs.sh
    • HTML docs will be located in _build/html

Developer Information

If you create a new page, add the name of the new markdown file (without extension) to the index.md file.