docs and tests format (#927)

CHANGELOG.md

@@ -4,7 +4,7 @@ Full documentation for ROCprofiler-SDK is available at [Click Here](source/docs/
 
 ## ROCprofiler-SDK for AFAR I
 
-## Added
+## Additions
 
 - HSA API Tracing
 - Kernel Dispatch Tracing
@@ -14,7 +14,7 @@ Full documentation for ROCprofiler-SDK is available at [Click Here](source/docs/
 
 ## ROCprofiler-SDK for AFAR II
 
-## Added
+## Additions
 
 - HIP API Tracing
 - ROCTx Tracing
@@ -23,10 +23,9 @@ Full documentation for ROCprofiler-SDK is available at [Click Here](source/docs/
 - ROCTx start/stop
 - Memory Copy Tracing
 
-
 ## ROCprofiler-SDK for AFAR III
 
-## Added
+## Additions
 
 - Kernel Dispatch Counter Collection – (includes serialization and multidimensional instances)
 - Kernel serialization
@@ -44,7 +43,7 @@ Full documentation for ROCprofiler-SDK is available at [Click Here](source/docs/
 
 ## ROCprofiler-SDK for AFAR IV
 
-## Added
+## Additions
 
 - Page Migration Reporting (API)
 - Scratch Memory Reporting (API)
@@ -56,22 +55,22 @@ Full documentation for ROCprofiler-SDK is available at [Click Here](source/docs/
 
 ## ROCprofiler-SDK for AFAR V
 
-## Added
+## Additions
 
 - Agent/Device Counter Collection (API)
-- JSON output format support (tool)
+- Single JSON output format support (tool)
 - Perfetto output format support(.pftrace) (tool)
 - Input YAML support for counter collection (tool)
 - Input JSON support for counter collection (tool)
+- Application Replay (Counter collection)
 - PC Sampling (Beta)(API)
 - ROCProf V3 Multi-GPU Support:
-  - Merged files
   - Multi-process (multiple files)
 
-## Fixed
+## Fixes
 
 - SQ_ACCUM_PREV and SQ_ACCUM_PREV_HIRE overwriting issue
 
-## Changed
+## Changes
 
 - rocprofv3 tool now needs `--` in front of application. For detailed uses, please [Click Here](source/docs/rocprofv3.md)

tests/rocprofv3/CMakeLists.txt

@@ -24,7 +24,7 @@ enable_testing()
 include(CTest)
 
 add_subdirectory(tracing)
-add_subdirectory(tracing-plus-cc)
+add_subdirectory(tracing-plus-counter-collection)
 add_subdirectory(tracing-hip-in-libraries)
 add_subdirectory(counter-collection)
 add_subdirectory(hsa-queue-dependency)

tests/rocprofv3/counter-collection/input1/CMakeLists.txt

@@ -15,7 +15,7 @@ rocprofiler_configure_pytest_files(CONFIG pytest.ini COPY validate.py conftest.p
 
 # pmc1
 add_test(
-    NAME rocprofv3-test-cc-txt-pmc1-execute
+    NAME rocprofv3-test-counter-collection-txt-pmc1-execute
     COMMAND
         $<TARGET_FILE:rocprofiler-sdk::rocprofv3> -i
         ${CMAKE_CURRENT_BINARY_DIR}/input.txt -T -d ${CMAKE_CURRENT_BINARY_DIR}/out_cc_1
@@ -27,19 +27,19 @@ string(REPLACE "LD_PRELOAD=" "ROCPROF_PRELOAD=" PRELOAD_ENV
 set(cc-env-pmc1 "${PRELOAD_ENV}")
 
 set_tests_properties(
-    rocprofv3-test-cc-txt-pmc1-execute
+    rocprofv3-test-counter-collection-txt-pmc1-execute
     PROPERTIES TIMEOUT 45 LABELS "integration-tests" ENVIRONMENT "${cc-env-pmc1}"
                FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
 
 add_test(
-    NAME rocprofv3-test-cc-pmc1-validate
+    NAME rocprofv3-test-counter-collection-pmc1-validate
     COMMAND
         ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --input
         ${CMAKE_CURRENT_BINARY_DIR}/out_cc_1/pmc_1/pmc1_counter_collection.csv
         --json-input ${CMAKE_CURRENT_BINARY_DIR}/out_cc_1/pmc_1/pmc1_results.json)
 
 set_tests_properties(
-    rocprofv3-test-cc-pmc1-validate
+    rocprofv3-test-counter-collection-pmc1-validate
     PROPERTIES TIMEOUT 45 LABELS "integration-tests" DEPENDS
-               "rocprofv3-test-cc-txt-pmc1-execute" FAIL_REGULAR_EXPRESSION
-               "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+               "rocprofv3-test-counter-collection-txt-pmc1-execute"
+               FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")

tests/rocprofv3/counter-collection/input2/CMakeLists.txt

@@ -15,7 +15,7 @@ rocprofiler_configure_pytest_files(CONFIG pytest.ini COPY validate.py conftest.p
 
 # pmc2
 add_test(
-    NAME rocprofv3-test-cc-txt-pmc2-execute
+    NAME rocprofv3-test-counter-collection-txt-pmc2-execute
     COMMAND
         $<TARGET_FILE:rocprofiler-sdk::rocprofv3> -i
         ${CMAKE_CURRENT_BINARY_DIR}/input.txt --output-format CSV JSON -d
@@ -27,12 +27,12 @@ string(REPLACE "LD_PRELOAD=" "ROCPROF_PRELOAD=" PRELOAD_ENV
 set(cc-env-pmc2 "${PRELOAD_ENV}")
 
 set_tests_properties(
-    rocprofv3-test-cc-txt-pmc2-execute
+    rocprofv3-test-counter-collection-txt-pmc2-execute
     PROPERTIES TIMEOUT 45 LABELS "integration-tests" ENVIRONMENT "${cc-env-pmc2}"
                FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
 
 add_test(
-    NAME rocprofv3-test-cc-txt-pmc2-execute-validate
+    NAME rocprofv3-test-counter-collection-txt-pmc2-execute-validate
     COMMAND
         ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --agent-input
         ${CMAKE_CURRENT_BINARY_DIR}/simple-transpose-cc/pmc_1/out_agent_info.csv
@@ -50,7 +50,7 @@ set(SYS_VALIDATION_FILES
     ${CMAKE_CURRENT_BINARY_DIR}/simple-transpose-cc/pmc_2/out_counter_collection.csv)
 
 set_tests_properties(
-    rocprofv3-test-cc-txt-pmc2-execute-validate
+    rocprofv3-test-counter-collection-txt-pmc2-execute-validate
     PROPERTIES TIMEOUT
                45
                LABELS

tests/rocprofv3/counter-collection/input3/CMakeLists.txt

@@ -15,14 +15,14 @@ rocprofiler_configure_pytest_files(CONFIG pytest.ini COPY validate.py conftest.p
 
 # pmc1
 add_test(
-    NAME rocprofv3-test-cc-json-pmc1-execute
+    NAME rocprofv3-test-counter-collection-json-pmc1-execute
     COMMAND
         $<TARGET_FILE:rocprofiler-sdk::rocprofv3> -i
         ${CMAKE_CURRENT_BINARY_DIR}/input.json -d ${CMAKE_CURRENT_BINARY_DIR}/%argt%-cc
         -o out_json -- $<TARGET_FILE:simple-transpose>)
 
 add_test(
-    NAME rocprofv3-test-cc-yaml-pmc1-execute
+    NAME rocprofv3-test-counter-collection-yaml-pmc1-execute
     COMMAND
         $<TARGET_FILE:rocprofiler-sdk::rocprofv3> -i
         ${CMAKE_CURRENT_BINARY_DIR}/input.yml -d ${CMAKE_CURRENT_BINARY_DIR}/%argt%-cc -o
@@ -34,12 +34,13 @@ string(REPLACE "LD_PRELOAD=" "ROCPROF_PRELOAD=" PRELOAD_ENV
 set(cc-env-pmc1 "${PRELOAD_ENV}")
 
 set_tests_properties(
-    rocprofv3-test-cc-json-pmc1-execute rocprofv3-test-cc-yaml-pmc1-execute
+    rocprofv3-test-counter-collection-json-pmc1-execute
+    rocprofv3-test-counter-collection-yaml-pmc1-execute
     PROPERTIES TIMEOUT 45 LABELS "integration-tests" ENVIRONMENT "${cc-env-pmc1}"
                FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
 
 add_test(
-    NAME rocprofv3-test-cc-json-pmc1-validate
+    NAME rocprofv3-test-counter-collection-json-pmc1-validate
     COMMAND
         ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --agent-input
         ${CMAKE_CURRENT_BINARY_DIR}/simple-transpose-cc/pmc_1/out_json_agent_info.csv
@@ -58,20 +59,20 @@ set(JSON_VALIDATION_FILES
     ${CMAKE_CURRENT_BINARY_DIR}/simple-transpose-cc/pmc_2/out_json_counter_collection.csv)
 
 set_tests_properties(
-    rocprofv3-test-cc-json-pmc1-validate
+    rocprofv3-test-counter-collection-json-pmc1-validate
     PROPERTIES TIMEOUT
                45
                LABELS
                "integration-tests"
                DEPENDS
-               rocprofv3-test-cc-json-pmc1-execute
+               rocprofv3-test-counter-collection-json-pmc1-execute
                FAIL_REGULAR_EXPRESSION
                "${ROCPROFILER_DEFAULT_FAIL_REGEX}"
                ATTACHED_FILES_ON_FAIL
                "${JSON_VALIDATION_FILES}")
 
 add_test(
-    NAME rocprofv3-test-cc-yaml-pmc1-validate
+    NAME rocprofv3-test-counter-collection-yaml-pmc1-validate
     COMMAND
         ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --agent-input
         ${CMAKE_CURRENT_BINARY_DIR}/simple-transpose-cc/pmc_1/out_yaml_agent_info.csv
@@ -90,13 +91,13 @@ set(YAML_VALIDATION_FILES
     ${CMAKE_CURRENT_BINARY_DIR}/simple-transpose-cc/pmc_2/out_yaml_counter_collection.csv)
 
 set_tests_properties(
-    rocprofv3-test-cc-yaml-pmc1-validate
+    rocprofv3-test-counter-collection-yaml-pmc1-validate
     PROPERTIES TIMEOUT
                45
                LABELS
                "integration-tests"
                DEPENDS
-               rocprofv3-test-cc-yaml-pmc1-execute
+               rocprofv3-test-counter-collection-yaml-pmc1-execute
                FAIL_REGULAR_EXPRESSION
                "${ROCPROFILER_DEFAULT_FAIL_REGEX}"
                ATTACHED_FILES_ON_FAIL

tests/rocprofv3/counter-collection/input3/validate.py

@@ -22,7 +22,7 @@ def test_agent_info(agent_info_input_data):
             assert int(row["Max_Waves_Per_Simd"]) > 0
 
 
-def test_validate_cc_yml_pmc(counter_input_data):
+def test_validate_counter_collection_yml_pmc(counter_input_data):
     counter_names = ["SQ_WAVES", "GRBM_COUNT", "GRBM_GUI_ACTIVE"]
     di_list = []
 

tests/rocprofv3/tracing-plus-counter-collection/CMakeLists.txt

@@ -16,7 +16,7 @@ rocprofiler_configure_pytest_files(COPY validate.py conftest.py input.txt
 
 # pmc3
 add_test(
-    NAME rocprofv3-test-tracing-plus-cc-execute
+    NAME rocprofv3-test-tracing-plus-counter-collection-execute
     COMMAND
         $<TARGET_FILE:rocprofiler-sdk::rocprofv3> --hsa-trace -i
         ${CMAKE_CURRENT_BINARY_DIR}/input.txt -d ${CMAKE_CURRENT_BINARY_DIR}/out_cc_trace
@@ -28,14 +28,14 @@ string(REPLACE "LD_PRELOAD=" "ROCPROF_PRELOAD=" PRELOAD_ENV
 set(cc-tracing-env "${PRELOAD_ENV}")
 
 set_tests_properties(
-    rocprofv3-test-tracing-plus-cc-execute
+    rocprofv3-test-tracing-plus-counter-collection-execute
     PROPERTIES TIMEOUT 45 LABELS "integration-tests;application-replay" ENVIRONMENT
                "${cc-tracing-env}" FAIL_REGULAR_EXPRESSION
                "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
 
 foreach(_DIR "pmc_1" "pmc_2" "pmc_3" "pmc_4")
     add_test(
-        NAME rocprofv3-test-tracing-plus-cc-validate-${_DIR}
+        NAME rocprofv3-test-tracing-plus-counter-collection-validate-${_DIR}
         COMMAND
             ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --json-input
             "${CMAKE_CURRENT_BINARY_DIR}/out_cc_trace/${_DIR}/pmc3_results.json"
@@ -50,7 +50,7 @@ foreach(_DIR "pmc_1" "pmc_2" "pmc_3" "pmc_4")
         )
 
     set_tests_properties(
-        rocprofv3-test-tracing-plus-cc-validate-${_DIR}
+        rocprofv3-test-tracing-plus-counter-collection-validate-${_DIR}
         PROPERTIES TIMEOUT 45 LABELS "integration-tests;application-replay" DEPENDS
                    "rocprofv3-test-tracing-plus-cc-execute" FAIL_REGULAR_EXPRESSION
                    "${ROCPROFILER_DEFAULT_FAIL_REGEX}")