Correct rocprofv2 help message.

CHANGELOG.md

@@ -3,7 +3,210 @@
 Full documentation for ROCprofiler is available at
 [docs.amd.com](https://docs.amd.com/bundle/ROCm-Profiling-Tools-User-Guide-v5.3)
 
+As of ROCm 5.5, the ROCm Profiler will not use terminologies like `rocmtools` or
+`rocsight` to describe `rocrofiler` as was done in ROCm 5.4. To identify the
+separation of the two versions of `rocprofiler`, the terms `rocprofilerV1` and
+`rocprofilerV2` will be used. The `rocprofilerV2` API is currently considered a
+beta release and subject to changes in future releases.
+
+## ROCprofiler for rocm 5.4.4
+
+In ROCm 5.4 the naming of the ROCm Profiler related files is:
+
+  | ROCm 5.4        | rocprofilerv1                       | rocmtools                       |
+  |-----------------|-------------------------------------|---------------------------------|
+  | **Tool script** | `bin/rocprof`                       | `bin/rocsight`                  |
+  | **API include** | `include/rocprofiler/rocprofiler.h` | `include/rocmtools/rocmtools.h` |
+  | **API library** | `lib/librocprofiler64.so.1`         | `lib/librocmtools.so.1`         |
+
+The ROCm Profiler Tool that uses `rocprofilerV1` can be invoked using the
+following command:
+
+```sh
+$ rocprof …
+```
+
+To write a custom tool based on the `rocprofilerV1` API do the following:
+
+```C
+main.c:
+#include <rocprofiler/rocprofiler.h> // Use the rocprofilerV1 API
+int main() {
+  // Use the rocprofilerV1 API
+  return 0;
+}
+```
+
+This can be built in the following manner:
+
+```sh
+$ gcc main.c -I/opt/rocm-5.4.4/include -L/opt/rocm-5.4.4/lib -lrocprofiler64
+```
+
+The resulting `a.out` will depend on
+`/opt/rocm-5.4.4/lib/librocprofiler64.so.1`.
+
+The ROCm Profiler that uses `rocprofilerV2` API can be invoked using the
+following command:
+
+```sh
+$ rocsight …
+```
+
+To write a custom tool based on the `rocmtools` API do the following:
+
+```C
+main.c:
+#include <rocmtools/rocmtools.h> // Use the rocmtools API
+int main() {
+  // Use the rocmtools API
+  return 0;
+}
+```
+
+This can be built in the following manner:
+
+```sh
+$ gcc main.c -I/opt/rocm-5.4.4/include -L/opt/rocm-5.4.4/lib -lrocmtools
+```
+
+The resulting `a.out` will depend on `/opt/rocm-5.4.4/lib/librocmtools.so.1`.
+
+## ROCprofiler for rocm 5.5.0
+
+In ROCm 5.5 the `rocprofilerv1` and `rocprofilerv2` include and library files
+are merged into single files. The `rocmtools` available in ROCm 5.4 is also
+available in ROCm 5.5 but is deprecated and will be removed in a future release.
+
+  | ROCm 5.5        | rocprofilerv1                       | rocprofilerv2                       | rocmtools *(deprecated)*        |
+  |-----------------|-------------------------------------|-------------------------------------|---------------------------------|
+  | **Tool script** | `bin/rocprof`                       | `bin/rocprofv2`                     | `bin/rocsight`                  |
+  | **API include** | `include/rocprofiler/rocprofiler.h` | `include/rocprofiler/rocprofiler.h` | `include/rocmtools/rocmtools.h` |
+  | **API library** | `lib/librocprofiler64.so.1`         | `lib/librocprofiler64.so.1`         | `lib/librocmtools.so.1`         |
+
+
+The ROCm Profiler Tool that uses `rocprofilerV1` can be invoked using the
+following command:
+
+```sh
+$ rocprof …
+```
+
+To write a custom tool based on the `rocprofilerV1` API it is necessary to
+define the macro `ROCPROFILER_V1`:
+
+```C
+main.c:
+#define ROCPROFILER_V1
+#include <rocprofiler/rocprofiler.h>
+int main() {
+  // Use the rocprofilerV1 API
+  return 0;
+}
+```
+
+This can be built in the following manner:
+
+```sh
+$ gcc main.c -I/opt/rocm-5.5.0/include -L/opt/rocm-5.5.0/lib -lrocprofiler64
+```
+
+The resulting `a.out` will depend on
+`/opt/rocm-5.5.0/lib/librocprofiler64.so.1`.
+
+The ROCm Profiler that uses `rocprofilerV2` API can be invoked using the
+following command:
+
+```sh
+$ rocprofv2 …
+```
+
+To write a custom tool based on the `rocprofilerV2` API do the following:
+
+```C
+main.c:
+#include <rocprofiler/rocprofiler.h>
+int main() {
+  // Use the rocprofilerV2 API
+  return 0;
+}
+```
+
+This can be built in the following manner:
+
+```sh
+$ gcc main.c -I/opt/rocm-5.5.0/include -L/opt/rocm-5.5.0/lib -lrocprofiler64
+```
+
+The resulting `a.out` will depend on
+`/opt/rocm-5.5.0/lib/librocprofiler64.so.1`.
+
 ## ROCprofiler for rocm 5.6.0
+
+In ROCm 5.6 the `rocprofilerv1` and `rocprofilerv2` include and library files of
+ROCm 5.5 are split into separate files. The `rocmtools` files that were
+deprecated in ROCm 5.5 have been removed.
+
+  | ROCm 5.6        | rocprofilerv1                       | rocprofilerv2                          |
+  |-----------------|-------------------------------------|----------------------------------------|
+  | **Tool script** | `bin/rocprof`                       | `bin/rocprofv2`                        |
+  | **API include** | `include/rocprofiler/rocprofiler.h` | `include/rocprofiler/v2/rocprofiler.h` |
+  | **API library** | `lib/librocprofiler.so.1`           | `lib/librocprofiler.so.2`              |
+
+The ROCm Profiler Tool that uses `rocprofilerV1` can be invoked using the
+following command:
+
+```sh
+$ rocprof …
+```
+
+To write a custom tool based on the `rocprofilerV1` API do the following:
+
+```C
+main.c:
+#include <rocprofiler/rocprofiler.h> // Use the rocprofilerV1 API
+int main() {
+  // Use the rocprofilerV1 API
+  return 0;
+}
+```
+
+This can be built in the following manner:
+
+```sh
+$ gcc main.c -I/opt/rocm-5.6.0/include -L/opt/rocm-5.6.0/lib -lrocprofiler64
+```
+
+The resulting `a.out` will depend on
+`/opt/rocm-5.6.0/lib/librocprofiler64.so.1`.
+
+The ROCm Profiler that uses `rocprofilerV2` API can be invoked using the
+following command:
+
+```sh
+$ rocprofv2 …
+```
+
+To write a custom tool based on the `rocprofilerV2` API do the following:
+
+```C
+main.c:
+#include <rocprofiler/v2/rocprofiler.h> // Use the rocprofilerV2 API
+int main() {
+  // Use the rocprofilerV2 API
+  return 0;
+}
+```
+
+This can be built in the following manner:
+
+```sh
+$ gcc main.c -I/opt/rocm-5.6.0/include -L/opt/rocm-5.6.0/lib -lrocprofiler64-v2
+```
+
+The resulting `a.out` will depend on
+`/opt/rocm-5.6.0/lib/librocprofiler64.so.2`.
+
 ### Optimized
 - Improved Test Suite
 ### Added

CMakeLists.txt

@@ -55,7 +55,7 @@ include(utils)
 include(env)
 
 # Setup the package version.
-get_version("2.0.0")
+get_version("1.0.0")
 message("-- LIB-VERSION: ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
 
 set(BUILD_VERSION_MAJOR ${VERSION_MAJOR})
@@ -277,7 +277,7 @@ if(FILE_REORG_BACKWARD_COMPATIBILITY)
        set(ROCM_HEADER_WRAPPER_WERROR "$ENV{ROCM_HEADER_WRAPPER_WERROR}"
             CACHE STRING "Header wrapper warnings as errors.")
     else()
-       set(ROCM_HEADER_WRAPPER_WERROR "ON" CACHE STRING "Header wrapper warnings as errors.")
+       set(ROCM_HEADER_WRAPPER_WERROR "OFF" CACHE STRING "Header wrapper warnings as errors.")
     endif()
   endif()
 
@@ -516,8 +516,8 @@ if(DOXYGEN_FOUND)
     COMMAND make -C ${CMAKE_CURRENT_BINARY_DIR}/doc/latex pdf
     MAIN_DEPENDENCY ${DOXYGEN_OUT}
     ${DOXYGEN_IN}
-    DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/inc/rocprofiler.h
-            ${CMAKE_CURRENT_SOURCE_DIR}/inc/rocprofiler_plugin.h
+    DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/include/rocprofiler/v2/rocprofiler_plugin.h
+            ${CMAKE_CURRENT_SOURCE_DIR}/include/rocprofiler/v2/rocprofiler.h
     COMMENT "Generating documentation")
 
   add_custom_target(

README.md

@@ -13,7 +13,9 @@ Library supports GFX8/GFX9.
 
 The library source tree:
  - doc  - Documentation
- - inc/rocprofiler.h - Library public API
+ - include/rocprofiler/rocprofiler.h - Library public API
+ - include/rocprofiler/v2/rocprofiler.h - V2 Beta Library public API
+ - include/rocprofiler/v2/rocprofiler_plugins.h - V2 Beta Tool's Plugins Library public API
  - src  - Library sources
    - core - Library API sources
    - util - Library utils sources
@@ -64,7 +66,7 @@ To enable verbose tracing:
 $ export ROCPROFILER_TRACE=1
 ```
 
-## ROC Profiler library version 2.0
+## ROC Profiler library version 9.0
 
 ## Introduction
 
@@ -249,8 +251,8 @@ The user has two options for building:
 
       installtion:
       ```bash
-      rocprofiler-plugins_2.0.0-local_amd64.deb
-      rocprofiler-plugins-2.0.0-local.x86_64.rpm
+      rocprofiler-plugins_9.0.0-local_amd64.deb
+      rocprofiler-plugins-9.0.0-local.x86_64.rpm
       ``` 
       usage:
 
@@ -299,8 +301,8 @@ The user has two options for building:
 
   installation:
   ```bash
-  rocprofiler-tests_2.0.0-local_amd64.deb
-  rocprofiler-tests-2.0.0-local.x86_64.rpm
+  rocprofiler-tests_9.0.0-local_amd64.deb
+  rocprofiler-tests-9.0.0-local.x86_64.rpm
   ```
   usage:
   From build directory:
@@ -319,8 +321,8 @@ We make use of doxygen to autmatically generate API documentation. Generated doc
 
    installtion:
    ```bash
-   rocprofiler-docs_2.0.0-local_amd64.deb
-   rocprofiler-docs-2.0.0-local.x86_64.rpm
+   rocprofiler-docs_9.0.0-local_amd64.deb
+   rocprofiler-docs-9.0.0-local.x86_64.rpm
    ```
 ## Samples
 
@@ -329,8 +331,8 @@ We make use of doxygen to autmatically generate API documentation. Generated doc
 
 insalltion:
 ```bash
-rocprofiler-samples_2.0.0-local_amd64.deb
-rocprofiler-samples-2.0.0-local.x86_64.rpm
+rocprofiler-samples_9.0.0-local_amd64.deb
+rocprofiler-samples-9.0.0-local.x86_64.rpm
 ```
 usage:
 
@@ -371,3 +373,8 @@ samples can be run as independent executables once installed
 Please report in the Github Issues
 
 ## Limitations
+- In 5.6, Navi2x requires a GRBM counter as the first counter for input PMC lines. Results are undefined otherwise.
+- Navi requires a stable power state for counter collection. Currently this state needs to be set by the user.
+  To do so, set "power_dpm_force_performance_level" to be writeable for non-root users with chmod, then:
+  echo profile_standard >> /sys/class/drm/card0/device/power_dpm_force_performance_level
+  Recommended: "auto" or "high" for ATT and "profile_standard" for PMC. Use rocm-smi to verify the current power state.

bin/rocprofv2

@@ -25,8 +25,8 @@ usage() {
     echo -e "--clean-install             For installing ROCProfilerV2 with new clean build in the default installation folder (review build.sh to know more about the default paths)"
   fi
   echo -e "--hip-api                   For Collecting HIP API Traces"
-  echo -e "--hip-activity              For Collecting HSA API Activities Traces"
-  echo -e "--hsa-api                   For Collecting HIP API Traces"
+  echo -e "--hip-activity              For Collecting HIP API Activities Traces"
+  echo -e "--hsa-api                   For Collecting HSA API Traces"
   echo -e "--hsa-activity              For Collecting HSA API Activities Traces"
   echo -e "--roctx-trace               For Collecting ROCTx Traces"
   echo -e "--kernel-trace              For Collecting Kernel dispatch Traces"

bin/rpl_run.sh

@@ -61,7 +61,7 @@ unset ROCPROFILER_SESS
 
 # Profiler environment
 # Loading of profiler library by HSA runtime
-MY_HSA_TOOLS_LIB="$RPL_PATH/librocprofiler64.so"
+MY_HSA_TOOLS_LIB="$RPL_PATH/librocprofiler64.so.1"
 # Loading of the test tool by ROC Profiler
 export ROCP_TOOL_LIB=$TLIB_PATH/librocprof-tool.so
 # Enabling HSA dispatches intercepting by ROC PRofiler
@@ -272,16 +272,16 @@ run() {
 
   if [ "$HSA_TRACE" = 1 ] ; then
     export ROCTRACER_DOMAIN=$API_TRACE":hsa"
-    MY_HSA_TOOLS_LIB="$MY_HSA_TOOLS_LIB $ROCM_LIB_PATH/libroctracer64.so $TTLIB_PATH/libroctracer_tool.so"
+    MY_HSA_TOOLS_LIB="$MY_HSA_TOOLS_LIB $ROCM_LIB_PATH/libroctracer64.so.4 $TTLIB_PATH/libroctracer_tool.so"
   elif [ -n "$API_TRACE" ] ; then
     export ROCTRACER_DOMAIN=$API_TRACE
     OUTPUT_LIST="$ROCP_OUTPUT_DIR/"
-    MY_HSA_TOOLS_LIB="$ROCM_LIB_PATH/libroctracer64.so $TTLIB_PATH/libroctracer_tool.so"
+    MY_HSA_TOOLS_LIB="$ROCM_LIB_PATH/libroctracer64.so.4 $TTLIB_PATH/libroctracer_tool.so"
   fi
 
   if [ "$ROCP_STATS_OPT" = 1 ] ; then
     if [ "$ROCTRACER_DOMAIN" = ":hip" ] ; then
-      MY_HSA_TOOLS_LIB="$ROCM_LIB_PATH/libroctracer64.so $TTLIB_PATH/libhip_stats.so"
+      MY_HSA_TOOLS_LIB="$ROCM_LIB_PATH/libroctracer64.so.4 $TTLIB_PATH/libhip_stats.so"
     else
       error_message="ROCP_STATS_OPT is only available with --hip-trace option"
       echo $error_message

doc/Doxyfile.in

@@ -791,7 +791,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/inc/rocprofiler.h @CMAKE_CURRENT_SOURCE_DIR@/inc/rocprofiler_plugin.h
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/include/rocprofiler/v2/rocprofiler.h @CMAKE_CURRENT_SOURCE_DIR@/include/rocprofiler/v2/rocprofiler_plugin.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses