Rebase and update some file paths

ROCm · Oct 16, 2024 · 3562b2d · 3562b2d
1 parent 5f82d22
commit 3562b2d
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 49 deletions.
diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -114,10 +114,10 @@ WARN_LOGFILE           = doc/warnings.log
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
 INPUT                  = ../../README.md \
-                         ../../source/lib/rocprof-sys-user/rocprof-sys/types.h \
-                         ../../source/lib/rocprof-sys-user/rocprof-sys/categories.h \
-                         ../../source/lib/rocprof-sys-user/rocprof-sys/user.h \
-                         ../../source/lib/rocprof-sys-user/rocprof-sys/causal.h
+                         ../../source/lib/rocprof-sys-user/rocprofiler-systems/types.h \
+                         ../../source/lib/rocprof-sys-user/rocprofiler-systems/categories.h \
+                         ../../source/lib/rocprof-sys-user/rocprofiler-systems/user.h \
+                         ../../source/lib/rocprof-sys-user/rocprofiler-systems/causal.h
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h \
                          *.hh \

diff --git a/docs/how-to/configuring-runtime-options.rst b/docs/how-to/configuring-runtime-options.rst
@@ -1320,7 +1320,7 @@ The full XML specification for a configuration value contains the same informati
 
    <?xml version="1.0" encoding="utf-8"?>
    <timemory_xml>
-      <rocprof-sys>
+      <rocprofiler-systems>
          <settings>
                <cereal_class_version>2</cereal_class_version>
                <!-- Full setting specification -->
@@ -1345,7 +1345,7 @@ The full XML specification for a configuration value contains the same informati
                </ROCPROFSYS_ADD_SECONDARY>
                <!-- etc. -->
          </settings>
-      </rocprof-sys>
+      </rocprofiler-systems>
    </timemory_xml>
 
 However, when writing an XML configuration file, it is minimally acceptable
@@ -1355,11 +1355,11 @@ to set ``ROCPROFSYS_ADD_SECONDARY=false``:
 
    <?xml version="1.0" encoding="utf-8"?>
    <timemory_xml>
-      <rocprof-sys>
+      <rocprofiler-systems>
          <settings>
                <ROCPROFSYS_ADD_SECONDARY>
                   <value>false</value>
                </ROCPROFSYS_ADD_SECONDARY>
          </settings>
-      </rocprof-sys>
+      </rocprofiler-systems>
    </timemory_xml>
diff --git a/docs/how-to/configuring-validating-environment.rst b/docs/how-to/configuring-validating-environment.rst
@@ -11,7 +11,7 @@ and validate the environment.
 
 .. note::
 
-   The following instructions use the installation path ``/opt/rocprof-sys``. If
+   The following instructions use the installation path ``/opt/rocprofiler-systems``. If
    ROCm Systems Profiler is installed elsewhere, substitute the actual installation path.
 
 Configuring the environment
@@ -22,26 +22,26 @@ After ROCm Systems Profiler is installed, source the ``setup-env.sh`` script to
 
 .. code-block:: shell
 
-   source /opt/rocprof-sys/share/rocprof-sys/setup-env.sh
+   source /opt/rocprofiler-systems/share/rocprofiler-systems/setup-env.sh
 
 Alternatively, if environment modules are supported, add the ``<prefix>/share/modulefiles`` directory
 to ``MODULEPATH``:
 
 .. code-block:: shell
 
-   module use /opt/rocprof-sys/share/modulefiles
+   module use /opt/rocprofiler-systems/share/modulefiles
 
 .. note::
 
    As an alternative, the above line can be added to the ``${HOME}/.modulerc`` file.
 
 After ROCm Systems Profiler has been added to the ``MODULEPATH``, it can be loaded
-using ``module load rocprof-sys/<VERSION>`` and unloaded using ``module unload rocprof-sys/<VERSION>``.
+using ``module load rocprofiler-systems/<VERSION>`` and unloaded using ``module unload rocprofiler-systems/<VERSION>``.
 
 .. code-block:: shell
 
-   module load rocprof-sys/1.0.0
-   module unload rocprof-sys/1.0.0
+   module load rocprofiler-systems/1.0.0
+   module unload rocprofiler-systems/1.0.0
 
 .. note::
 

diff --git a/docs/how-to/performing-causal-profiling.rst b/docs/how-to/performing-causal-profiling.rst
@@ -331,7 +331,7 @@ Examples
 
    #!/bin/bash -e
 
-   module load rocprof-sys
+   module load rocprofiler-systems
 
    N=20
    I=3

diff --git a/docs/how-to/profiling-python-scripts.rst b/docs/how-to/profiling-python-scripts.rst
@@ -37,10 +37,10 @@ add this path to the ``PYTHONPATH`` environment variable, as in the following ex
 
 .. code-block:: shell
 
-   export PYTHONPATH=/opt/rocprof-sys/lib/python3.8/site-packages:${PYTHONPATH}
+   export PYTHONPATH=/opt/rocprofiler-systems/lib/python3.8/site-packages:${PYTHONPATH}
 
-Both the ``share/rocprof-sys/setup-env.sh`` script and the module file in
-``share/modulefiles/rocprof-sys`` automatically handle the prefixing of the ``PYTHONPATH``
+Both the ``share/rocprofiler-systems/setup-env.sh`` script and the module file in
+``share/modulefiles/rocprofiler-systems`` automatically handle the prefixing of the ``PYTHONPATH``
 environment variable.
 
 Running ROCm Systems Profiler on a Python script
@@ -58,7 +58,7 @@ and
 
 .. code-block:: shell
 
-   export PYTHONPATH=/opt/rocprof-sys/lib/python3.8/site-packages:${PYTHONPATH}
+   export PYTHONPATH=/opt/rocprofiler-systems/lib/python3.8/site-packages:${PYTHONPATH}
    python3.8 -m rocprofsys --help
 
 .. note::

diff --git a/docs/how-to/sampling-call-stack.rst b/docs/how-to/sampling-call-stack.rst
@@ -268,13 +268,13 @@ The following snippets show how ``rocprof-sys-sample`` runs with various environ
 
       $ rocprof-sys-sample -- ./parallel-overhead-locks 30 4 100
 
-      HSA_TOOLS_LIB=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
+      HSA_TOOLS_LIB=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
       HSA_TOOLS_REPORT_LOAD_FAILURE=1
-      LD_PRELOAD=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
+      LD_PRELOAD=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
       ROCPROFSYS_USE_PROCESS_SAMPLING=false
       ROCPROFSYS_USE_SAMPLING=true
-      OMP_TOOL_LIBRARIES=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
-      ROCP_TOOL_LIB=/opt/rocprof-sys/lib/librocprof-sys.so.1.7.1
+      OMP_TOOL_LIBRARIES=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
+      ROCP_TOOL_LIB=/opt/rocprofiler-systems/lib/librocprof-sys.so.1.7.1
 
 *  The next snippet shows the environment updates when ``rocprof-sys-sample`` enables
    profiling, tracing, host process-sampling, device process-sampling, and all the available backends:
@@ -283,10 +283,10 @@ The following snippets show how ``rocprof-sys-sample`` runs with various environ
 
       $ rocprof-sys-sample -PTDH -I all -- ./parallel-overhead-locks 30 4 100
 
-      HSA_TOOLS_LIB=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
+      HSA_TOOLS_LIB=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
       HSA_TOOLS_REPORT_LOAD_FAILURE=1
-      KOKKOS_PROFILE_LIBRARY=/opt/rocprof-sys/lib/librocprof-sys.so.1.7.1
-      LD_PRELOAD=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
+      KOKKOS_PROFILE_LIBRARY=/opt/rocprofiler-systems/lib/librocprof-sys.so.1.7.1
+      LD_PRELOAD=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
       ROCPROFSYS_CPU_FREQ_ENABLED=true
       ROCPROFSYS_TRACE_THREAD_LOCKS=true
       ROCPROFSYS_TRACE_THREAD_RW_LOCKS=true
@@ -303,8 +303,8 @@ The following snippets show how ``rocprof-sys-sample`` runs with various environ
       ROCPROFSYS_USE_ROCTX=true
       ROCPROFSYS_USE_SAMPLING=true
       ROCPROFSYS_PROFILE=true
-      OMP_TOOL_LIBRARIES=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
-      ROCP_TOOL_LIB=/opt/rocprof-sys/lib/librocprof-sys.so.1.7.1
+      OMP_TOOL_LIBRARIES=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
+      ROCP_TOOL_LIB=/opt/rocprofiler-systems/lib/librocprof-sys.so.1.7.1
       ...
 
 *  The final snippet shows the environment updates when ``rocprof-sys-sample`` enables
@@ -316,7 +316,7 @@ The following snippets show how ``rocprof-sys-sample`` runs with various environ
 
       $ rocprof-sys-sample -PTDH -E all -o rocprof-sys-output %tag% -- ./parallel-overhead-locks 30 4 100
 
-      LD_PRELOAD=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.7.1
+      LD_PRELOAD=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.7.1
       ROCPROFSYS_CPU_FREQ_ENABLED=true
       ROCPROFSYS_OUTPUT_PATH=rocprof-sys-output
       ROCPROFSYS_OUTPUT_PREFIX=%tag%
@@ -347,7 +347,7 @@ Here is the full output from the previous
 
    $ rocprof-sys-sample -PTDH -E all -o rocprof-sys-output %tag% -c -- ./parallel-overhead-locks 30 4 100
 
-   LD_PRELOAD=/opt/rocprof-sys/lib/librocprof-sys-dl.so.1.11.3
+   LD_PRELOAD=/opt/rocprofiler-systems/lib/librocprof-sys-dl.so.1.11.3
    ROCPROFSYS_CONFIG_FILE=
    ROCPROFSYS_CPU_FREQ_ENABLED=true
    ROCPROFSYS_OUTPUT_PATH=rocprof-sys-output
@@ -397,7 +397,7 @@ Here is the full output from the previous
    [rocprof-sys][1785877][0][rocprofsys_finalize] rocprof-sys/process/1785877/thread/4 : 0.212029 sec wall_clock, 0.211694 sec thread_cpu_clock,   99.8 % thread_cpu_util,    1.152 MB peak_rss [laps: 1]
    [rocprof-sys][1785877][0][rocprofsys_finalize]
    [rocprof-sys][1785877][0][rocprofsys_finalize] Finalizing perfetto...
-   [rocprof-sys][1785877][perfetto]> Outputting '/home/user/code/rocprof-sys/build-release/rocprof-sys-output/2024-07-15_16.21/parallel-overhead-locksperfetto-trace-1785877.proto' (39.12 KB / 0.04 MB / 0.00 GB)... Done
+   [rocprof-sys][1785877][perfetto]> Outputting '/home/user/code/rocprofiler-systems/build-release/rocprofiler-systems-output/2024-07-15_16.21/parallel-overhead-locksperfetto-trace-1785877.proto' (39.12 KB / 0.04 MB / 0.00 GB)... Done
    [rocprof-sys][1785877][wall_clock]> Outputting 'rocprof-sys-output/2024-07-15_16.21/parallel-overhead-lockswall_clock-1785877.json'
    [rocprof-sys][1785877][wall_clock]> Outputting 'rocprof-sys-output/2024-07-15_16.21/parallel-overhead-lockswall_clock-1785877.txt'
    [rocprof-sys][1785877][metadata]> Outputting 'rocprof-sys-output/2024-07-15_16.21/parallel-overhead-locksmetadata-1785877.json' and 'rocprof-sys-output/2024-07-15_16.21/parallel-overhead-locksfunctions-1785877.json'

diff --git a/docs/how-to/using-rocprof-sys-api.rst b/docs/how-to/using-rocprof-sys-api.rst
@@ -30,9 +30,9 @@ ROCm Systems Profiler API, such as ``rocprofsys_user_push_region`` and
 
 .. code-block:: shell
 
-   #include <rocprof-sys/categories.h>
-   #include <rocprof-sys/types.h>
-   #include <rocprof-sys/user.h>
+   #include <rocprofiler-systems/categories.h>
+   #include <rocprofiler-systems/types.h>
+   #include <rocprofiler-systems/user.h>
 
    #include <atomic>
    #include <cassert>
@@ -159,27 +159,27 @@ ROCm Systems Profiler API, such as ``rocprofsys_user_push_region`` and
 Linking the ROCm Systems Profiler libraries to another program
 =======================================================
 
-To link the ``rocprof-sys-user-library`` to another program,
+To link the ``rocprofiler-systems-user-library`` to another program,
 use the following CMake and ``g++`` directives.
 
 CMake
 -------------------------------------------------------
 
 .. code-block:: cmake
 
-   find_package(rocprof-sys REQUIRED COMPONENTS user)
+   find_package(rocprofiler-systems REQUIRED COMPONENTS user)
    add_executable(foo foo.cpp)
-   target_link_libraries(foo PRIVATE rocprof-sys::rocprof-sys-user-library)
+   target_link_libraries(foo PRIVATE rocprofiler-systems::rocprofiler-systems-user-library)
 
 g++ compilation
 -------------------------------------------------------
 
-Assuming ROCm Systems Profiler is installed in ``/opt/rocprof-sys``, use the ``g++`` compiler
+Assuming ROCm Systems Profiler is installed in ``/opt/rocprofiler-systems``, use the ``g++`` compiler
 to build the application.
 
 .. code-block:: shell
 
-   g++ -I/opt/rocprof-sys foo.cpp -o foo -lrocprof-sys-user
+   g++ -I/opt/rocprofiler-systems foo.cpp -o foo -lrocprofiler-systems-user
 
 Output from the API example program
 ========================================

diff --git a/docs/install/install.rst b/docs/install/install.rst
@@ -104,13 +104,13 @@ To install ROCm Systems Profiler using a binary installer script, follow these s
 
    .. code-block:: shell
 
-      mkdir /opt/rocprof-sys
+      mkdir /opt/rocprofiler-systems
 
 #. Run the installer script
 
    .. code-block:: shell
 
-      ./rocprof-sys-1.0.0-ubuntu-18.04-ROCm-405000-OMPT-PAPI.sh --prefix=/opt/rocprof-sys --exclude-subdir
+      ./rocprofiler-systems-1.0.0-ubuntu-18.04-ROCm-405000-OMPT-PAPI.sh --prefix=/opt/rocprofiler-systems --exclude-subdir
 
 Installing ROCm Systems Profiler from source
 ========================================
@@ -263,7 +263,7 @@ in `the Perfetto UI <https://ui.perfetto.dev>`_.
    git clone https://github.com/ROCm/rocprofiler-systems.git rocprof-sys-source
    cmake                                       \
        -B rocprof-sys-build                      \
-       -D CMAKE_INSTALL_PREFIX=/opt/rocprof-sys  \
+       -D CMAKE_INSTALL_PREFIX=/opt/rocprofiler-systems  \
        -D ROCPROFSYS_USE_HIP=ON                 \
        -D ROCPROFSYS_USE_ROCM_SMI=ON            \
        -D ROCPROFSYS_USE_ROCTRACER=ON           \
@@ -280,7 +280,7 @@ in `the Perfetto UI <https://ui.perfetto.dev>`_.
        rocprof-sys-source
    cmake --build rocprof-sys-build --target all --parallel 8
    cmake --build rocprof-sys-build --target install
-   source /opt/rocprof-sys/share/rocprof-sys/setup-env.sh
+   source /opt/rocprofiler-systems/share/rocprofiler-systems/setup-env.sh
 
 .. _mpi-support-rocprof-sys:
 
@@ -326,14 +326,14 @@ If environment modules are available and preferred, add them using these command
 
 .. code-block:: shell
 
-   module use /opt/rocprof-sys/share/modulefiles
-   module load rocprof-sys/1.0.0
+   module use /opt/rocprofiler-systems/share/modulefiles
+   module load rocprofiler-systems/1.0.0
 
 Alternatively, you can directly source the ``setup-env.sh`` script:
 
 .. code-block:: shell
 
-   source /opt/rocprof-sys/share/rocprof-sys/setup-env.sh
+   source /opt/rocprofiler-systems/share/rocprofiler-systems/setup-env.sh
 
 Test the executables
 -----------------------------------

diff --git a/docs/install/quick-start.rst b/docs/install/quick-start.rst
@@ -7,16 +7,16 @@ ROCm Systems Profiler quick start
 *************************************
 
 To install ROCm Systems Profiler, download the
-`ROCm Systems Profiler installer <https://github.com/ROCm/rocprofiler-systems/releases/latest/download/rocprof-sys-install.py>`_
+`ROCm Systems Profiler installer <https://github.com/ROCm/rocprofiler-systems/releases/latest/download/rocprofiler-systems-install.py>`_
 and specify ``--prefix <install-directory>``. The script attempts to auto-detect
 the appropriate OS distribution and version. To include AMD ROCm Software support,
 specify ``--rocm X.Y``, where ``X`` is the ROCm major
 version and ``Y`` is the ROCm minor version, for example, ``--rocm 6.3``.
 
 .. code-block:: shell
 
-   wget https://github.com/ROCm/rocprofiler-systems/releases/latest/download/rocprof-sys-install.py
-   python3 ./rocprof-sys-install.py --prefix /opt/rocprof-sys --rocm 6.3
+   wget https://github.com/ROCm/rocprofiler-systems/releases/latest/download/rocprofiler-systems-install.py
+   python3 ./rocprofiler-systems-install.py --prefix /opt/rocprofiler-systems --rocm 6.3
 
 This script supports installation on Ubuntu, OpenSUSE, Red Hat, Debian, CentOS, and Fedora.
 If the target OS is compatible with one of the operating system versions listed in