Add user_api_active flag to enable/disable user-defined regions (#312)

* Add user start/stop bool * Update documentation for user-api * Update projects/rocprofiler-systems/source/lib/rocprof-sys-dl/dl.cpp Co-authored-by: Aleksandar Djordjevic <aleksandar.djordjevic@amd.com> * Format fix --------- Co-authored-by: Aleksandar Djordjevic <aleksandar.djordjevic@amd.com>
2025-11-18 19:48:27 +01:00
Commit 3ee393047c
@@ -30,8 +30,8 @@ ROCm Systems Profiler supports several modes of recording trace and profiling da
 |                             | dynamic library/executable, like ``pthread_mutex_lock`` |
 |                             | in ``libpthread.so`` or ``MPI_Init`` in the MPI library |
 +-----------------------------+---------------------------------------------------------+
-| User API                    | User-defined regions and controls for ROCm Systems      |
-|                             | Profiler                                                |
+| User API                    | User-defined regions and controls for User API ROCm     |
+|                             | Systems Profiler                                        |
 +-----------------------------+---------------------------------------------------------+

 The two most generic and important modes are binary instrumentation and statistical sampling.
@@ -24,7 +24,7 @@ the :doc:`ROCm Systems Profiler glossary <../reference/rocprof-sys-glossary>`.
 * **Use binary instrumentation for characterizing the performance of every invocation of specific functions**
 * **Use statistical sampling to characterize the performance of the entire application while minimizing overhead**
 * Enable statistical sampling after binary instrumentation to help "fill in the gaps" between instrumented regions
-* Use the user API to create custom regions and enable/disable ROCm Systems Profiler for specific processes, threads, and regions
+* Use the user API to create custom regions and enable/disable User API ROCm Systems Profiler for specific processes, threads, and regions
 * Dynamic symbol interception, callback APIs, and the user API are always available with binary instrumentation and sampling

  * Dynamic symbol interception and callback APIs are (generally) controlled through ``ROCPROFSYS_USE_<API>``
@@ -24,9 +24,6 @@ ROCm Systems Profiler API, such as ``rocprofsys_user_push_region`` and
   is disabled at start up, which means ``rocprofsys_user_stop_trace()`` is not
   required at the beginning of ``main``. This behavior
   can be manually controlled by using the ``ROCPROFSYS_INIT_ENABLED`` environment variable.
-   User-defined regions are always
-   recorded, regardless of whether ``rocprofsys_user_start_*`` or
-   ``rocprofsys_user_stop_*`` has been called.

 .. code-block:: shell