Enhance cmake install instructions with std install location/destination

.cmake-format.yaml

@@ -253,6 +253,15 @@ parse:
         BINARY_DIR: '*'
         INSTALL_DIR: '*'
         COMPONENT: '*'
+    rocprofiler_sdk_custom_compilation:
+      flags:
+        - GLOBAL
+        - PROJECT
+      kwargs:
+        COMPILER: '*'
+        DIRECTORY: '*'
+        TARGET: '*'
+        SOURCE: '*'
   override_spec: {}
   vartags: []
   proptags: []

.github/pull_request_template.md

@@ -1,6 +1,8 @@
 
 # PR Details
 
+## Associated Jira Ticket Number/Link
+
 ## What type of PR is this? (check all applicable)
 
 - [ ] Refactor
@@ -11,18 +13,18 @@
 
 ## Technical details
 
-_Please explain the changes along with JIRA/Github link(if applies)._
+<!-- Please explain the changes along with JIRA/Github link(if applies). -->
 
 ## Added/updated tests?
 
-_We encourage you to keep the code coverage percentage at 80% and above._
+<!-- We encourage you to keep the code coverage percentage at 80% and above. -->
 
 - [ ] Yes
 - [ ] No, Does not apply to this PR.
 
 ## Updated CHANGELOG?
 
-_Needed for Release updates for a ROCm release._
+<!-- Needed for Release updates for a ROCm release. -->
 
 - [ ] Yes
 - [ ] No, Does not apply to this PR.

.github/workflows/continuous_integration.yml

@@ -23,24 +23,36 @@ env:
   ROCM_PATH: "/opt/rocm"
   GPU_TARGETS: "gfx900 gfx906 gfx908 gfx90a gfx940 gfx941 gfx942 gfx1030 gfx1100 gfx1101 gfx1102"
   PATH: "/usr/bin:$PATH"
+  navi3_EXCLUDE_TESTS_REGEX: "^(test-page-migration-(execute|validate))$"
+  vega20_EXCLUDE_TESTS_REGEX: "^(test-page-migration-(execute|validate))$"
+  mi200_EXCLUDE_TESTS_REGEX: "^(test-page-migration-(execute|validate))$"
+  mi300_EXCLUDE_TESTS_REGEX: "^(test-page-migration-(execute|validate))$"
+  mi300a_EXCLUDE_TESTS_REGEX: "^(test-page-migration-(execute|validate))$"
+  mi325_EXCLUDE_TESTS_REGEX: "^(test-page-migration-(execute|validate))$"
+  navi3_EXCLUDE_LABEL_REGEX: "^(pc-sampling|pc_sampling|openmp-target)$"
+  vega20_EXCLUDE_LABEL_REGEX: "^(pc-sampling|pc_sampling|openmp-target)$"
+  mi200_EXCLUDE_LABEL_REGEX: "^(openmp-target)$"
+  mi300_EXCLUDE_LABEL_REGEX: "^(pc-sampling|pc_sampling)$"
+  mi300a_EXCLUDE_LABEL_REGEX: ""
+  mi325_EXCLUDE_LABEL_REGEX: "^(pc-sampling|pc_sampling)$"
 
 jobs:
   core-deb:
     # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
     strategy:
       fail-fast: false
       matrix:
-        runner: ['mi200', 'mi300']
+        runner: ['vega20', 'mi300a']
         os: ['ubuntu-22.04']
         build-type: ['RelWithDebInfo']
         ci-flags: ['--linter clang-tidy']
 
-    runs-on: ${{ matrix.runner }}-runner-set
+    runs-on: ${{ matrix.runner }}-emu-runner-set
 
     # define this for containers
     env:
       GIT_DISCOVERY_ACROSS_FILESYSTEM: 1
-      CORE_EXT_RUNNER: mi200
+      CORE_EXT_RUNNER: mi300
 
     steps:
     - uses: actions/checkout@v4
@@ -51,7 +63,7 @@ jobs:
       run: |
         git config --global --add safe.directory '*'
         apt-get update
-        apt-get install -y build-essential cmake g++-11 g++-12 python3-pip libdw-dev
+        apt-get install -y build-essential cmake g++-11 g++-12 python3-pip libdw-dev rccl-dev rccl-unittests
         update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 10 --slave /usr/bin/g++ g++ /usr/bin/g++-11 --slave /usr/bin/gcov gcov /usr/bin/gcov-11
         update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 20 --slave /usr/bin/g++ g++ /usr/bin/g++-12 --slave /usr/bin/gcov gcov /usr/bin/gcov-12
         python3 -m pip install -r requirements.txt
@@ -91,7 +103,8 @@ jobs:
           -DCPACK_PACKAGING_INSTALL_PREFIX="$(realpath /opt/rocm)"
           -DPython3_EXECUTABLE=$(which python3)
           --
-          -LE "${EXCLUDED_TESTS}"
+          -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}"
+          -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}"
 
     - name: Install
       if: ${{ contains(matrix.runner, env.CORE_EXT_RUNNER) }}
@@ -115,8 +128,8 @@ jobs:
         export LD_LIBRARY_PATH=/opt/rocprofiler-sdk/lib:${LD_LIBRARY_PATH}
         cmake --build build-samples --target all --parallel 16
         cmake --build build-tests --target all --parallel 16
-        ctest --test-dir build-samples -LE "${EXCLUDED_TESTS}" --output-on-failure
-        ctest --test-dir build-tests -LE "${EXCLUDED_TESTS}" --output-on-failure
+        ctest --test-dir build-samples -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
+        ctest --test-dir build-tests -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
 
     - name: Install Packages
       if: ${{ contains(matrix.runner, env.CORE_EXT_RUNNER) }}
@@ -138,8 +151,8 @@ jobs:
         CMAKE_PREFIX_PATH=/opt/rocm cmake -B build-tests-deb /opt/rocm/share/rocprofiler-sdk/tests
         cmake --build build-samples-deb --target all --parallel 16
         cmake --build build-tests-deb --target all --parallel 16
-        ctest --test-dir build-samples-deb -LE "${EXCLUDED_TESTS}" --output-on-failure
-        ctest --test-dir build-tests-deb -LE "${EXCLUDED_TESTS}" --output-on-failure
+        ctest --test-dir build-samples-deb -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
+        ctest --test-dir build-tests-deb -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
 
     - name: Archive production artifacts
       if: ${{ contains(matrix.runner, env.CORE_EXT_RUNNER) }}
@@ -156,8 +169,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        runner: ['mi300']
-        os: ['rhel', 'sles']
+        runner: ['mi325']
+        os: ['rhel-emu', 'sles-emu']
         build-type: ['RelWithDebInfo']
         ci-flags: ['--linter clang-tidy']
 
@@ -213,7 +226,8 @@ jobs:
           -DCPACK_PACKAGING_INSTALL_PREFIX="$(realpath /opt/rocm)"
           -DPython3_EXECUTABLE=$(which python3)
           --
-          -LE "${EXCLUDED_TESTS}"
+          -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}"
+          -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}"
 
     - name: Install
       if: ${{ contains(matrix.runner, env.CORE_EXT_RUNNER) }}
@@ -237,8 +251,8 @@ jobs:
         export LD_LIBRARY_PATH=/opt/rocprofiler-sdk/lib:${LD_LIBRARY_PATH}
         cmake --build build-samples --target all --parallel 16
         cmake --build build-tests --target all --parallel 16
-        ctest --test-dir build-samples -LE "${EXCLUDED_TESTS}" --output-on-failure
-        ctest --test-dir build-tests -LE "${EXCLUDED_TESTS}" --output-on-failure
+        ctest --test-dir build-samples -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
+        ctest --test-dir build-tests -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
 
     - name: Install Packages
       if: ${{ contains(matrix.runner, env.CORE_EXT_RUNNER) }}
@@ -260,8 +274,8 @@ jobs:
         CMAKE_PREFIX_PATH=/opt/rocm cmake -B build-tests-deb /opt/rocm/share/rocprofiler-sdk/tests
         cmake --build build-samples-deb --target all --parallel 16
         cmake --build build-tests-deb --target all --parallel 16
-        ctest --test-dir build-samples-deb -LE "${EXCLUDED_TESTS}" --output-on-failure
-        ctest --test-dir build-tests-deb -LE "${EXCLUDED_TESTS}" --output-on-failure
+        ctest --test-dir build-samples-deb -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
+        ctest --test-dir build-tests-deb -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}" -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" --output-on-failure
 
     - name: Archive production artifacts
       if: ${{ contains(matrix.runner, env.CORE_EXT_RUNNER) }}
@@ -274,15 +288,15 @@ jobs:
           ${{github.workspace}}/build/*.tgz
 
   code-coverage:
+    if: ${{ contains(github.event_name, 'pull_request') }}
     strategy:
-      fail-fast: false
+      # fail-fast: false
       matrix:
         runner: ['mi200']
         os: ['ubuntu-22.04']
         build-type: ['Release']
 
-    if: ${{ contains(github.event_name, 'pull_request') }}
-    runs-on: ${{ matrix.runner }}-runner-set
+    runs-on: ${{ matrix.runner }}-emu-runner-set
 
     # define this for containers
     env:
@@ -351,6 +365,12 @@ jobs:
         cat /opt/rocm/.info/version
         ls -la
 
+    - name: Enable PC Sampling
+      if: ${{ contains(matrix.runner, 'mi200') }}
+      shell: bash
+      run: |
+          echo 'ROCPROFILER_PC_SAMPLING_BETA_ENABLED=1' >> $GITHUB_ENV
+
     - name: Configure, Build, and Test (Total Code Coverage)
       timeout-minutes: 30
       shell: bash
@@ -366,7 +386,8 @@ jobs:
           -DCMAKE_BUILD_TYPE=${{ matrix.build-type }}
           -DPython3_EXECUTABLE=$(which python3)
           --
-          -LE "${EXCLUDED_TESTS}"
+          -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}"
+          -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}"
 
     - name: Configure, Build, and Test (Tests Code Coverage)
       timeout-minutes: 30
@@ -384,7 +405,8 @@ jobs:
           -DCMAKE_BUILD_TYPE=${{ matrix.build-type }}
           -DPython3_EXECUTABLE=$(which python3)
           --
-          -LE "${EXCLUDED_TESTS}"
+          -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}"
+          -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}"
 
     - name: Configure, Build, and Test (Samples Code Coverage)
       timeout-minutes: 30
@@ -402,7 +424,8 @@ jobs:
           -DCMAKE_BUILD_TYPE=${{ matrix.build-type }}
           -DPython3_EXECUTABLE=$(which python3)
           --
-          -LE "${EXCLUDED_TESTS}"
+          -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}"
+          -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}"
 
     - name: Save XML Code Coverage
       id: save-coverage
@@ -412,7 +435,8 @@ jobs:
         path: |
           .codecov/*.xml
 
-    - name: Generate Code Coverage Comment
+    - id: generatereport
+      name: Generate Code Coverage Comment
       if: github.event_name == 'pull_request'
       timeout-minutes: 5
       shell: bash
@@ -427,7 +451,7 @@ jobs:
         which -a git
         git --version
 
-        ./source/scripts/upload-image-to-github.py --bot --token ${{ github.token }} --files .codecov/{all,tests,samples}.png --output-dir .codecov --name pr-${{ github.event.pull_request.number }}
+        ./source/scripts/upload-image-to-github.py --bot --token ${{ secrets.TOKEN }} --files .codecov/{all,tests,samples}.png --output-dir .codecov --name pr-${{ github.event.pull_request.number }}
 
         echo -e "\n${PWD}:"
         ls -la .
@@ -449,15 +473,54 @@ jobs:
         ## Tests + Samples
         $(get-full-md-contents all)
 
+        <!-- code-coverage-comment-identifier -->
         EOF
 
+        echo 'CODECOVERAGE_REPORT<<EOF' > $GITHUB_OUTPUT
+        cat .codecov/report.md >> $GITHUB_OUTPUT
+        echo 'EOF' >> $GITHUB_OUTPUT
+
     - name: Write Code Coverage Comment
       if: github.event_name == 'pull_request'
       timeout-minutes: 5
-      uses: thollander/[email protected]
+      uses: actions/github-script@v6
+      env:
+        COMMENT_BODY: ${{ steps.generatereport.outputs.CODECOVERAGE_REPORT }}
       with:
-        comment_tag: codecov-report
-        filePath: .codecov/report.md
+        github-token: ${{ secrets.TOKEN }}
+        script: |
+          const commentIdentifier = '<!-- code-coverage-comment-identifier -->'; // Used to identify codecov comment
+            const commentBody = process.env.COMMENT_BODY;
+
+            // Fetch existing comments
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+            });
+
+            // Check for an existing comment
+            const existingComment = comments.find(comment => comment.body.includes(commentIdentifier));
+
+            if (existingComment) {
+              // Update the existing comment
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existingComment.id,
+                body: commentBody,
+              });
+              core.info(`Updated comment with ID: ${existingComment.id}`);
+            } else {
+              // Create a new comment
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.payload.pull_request.number,
+                body: commentBody,
+              });
+              core.info('Created a new comment.');
+            }
 
     - name: Archive Code Coverage Data
       uses: actions/upload-artifact@v4
@@ -479,7 +542,7 @@ jobs:
         #   - unittests
         #   - integration-tests
         #
-        ctest -N -LE 'samples|tests' -O ctest.mislabeled.log
+        ctest -N -LE 'samples|tests' -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}" -O ctest.mislabeled.log
         grep 'Total Tests: 0' ctest.mislabeled.log
         #
         # if following fails, then there is overlap between the labels.
@@ -504,23 +567,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        runner: ['mi200', 'mi300']
+        runner: ['vega20', 'navi3', 'mi300']
         sanitizer: ['AddressSanitizer', 'ThreadSanitizer', 'LeakSanitizer', 'UndefinedBehaviorSanitizer']
         os: ['ubuntu-22.04']
         build-type: ['RelWithDebInfo']
         exclude:
-        #   - { runner: 'navi3',  sanitizer: 'ThreadSanitizer' }
-        #   - { runner: 'navi3',  sanitizer: 'LeakSanitizer' }
-        #   - { runner: 'vega20', sanitizer: 'AddressSanitizer' }
-        #   - { runner: 'vega20', sanitizer: 'LeakSanitizer' }
-          - { runner: 'mi200', sanitizer: 'LeakSanitizer' }
-          - { runner: 'mi200', sanitizer: 'AddressSanitizer' }
-        #   - { runner: 'mi300',  sanitizer: 'AddressSanitizer' }
-          - { runner: 'mi300', sanitizer: 'ThreadSanitizer' }
-          - { runner: 'mi300', sanitizer: 'UndefinedBehaviorSanitizer' }
+          - { runner: 'vega20', sanitizer: 'ThreadSanitizer' }
+          - { runner: 'vega20', sanitizer: 'AddressSanitizer' }
+          - { runner: 'vega20', sanitizer: 'UndefinedBehaviorSanitizer' }
+          - { runner: 'mi300', sanitizer: 'AddressSanitizer' }
+          - { runner: 'mi300', sanitizer: 'LeakSanitizer' }
+          - { runner: 'navi3', sanitizer: 'LeakSanitizer' }
+          - { runner: 'navi3', sanitizer: 'ThreadSanitizer' }
+          - { runner: 'navi3', sanitizer: 'UndefinedBehaviorSanitizer' }
 
     if: ${{ contains(github.event_name, 'pull_request') }}
-    runs-on: ${{ matrix.runner }}-runner-set
+    runs-on: ${{ matrix.runner }}-emu-runner-set
 
     # define this for containers
     env:
@@ -573,4 +635,5 @@ jobs:
           -DCMAKE_INSTALL_PREFIX="${{ env.ROCM_PATH }}"
           -DPython3_EXECUTABLE=$(which python3)
           --
-          -LE "${EXCLUDED_TESTS}"
+          -LE "${${{ matrix.runner }}_EXCLUDE_LABEL_REGEX}"
+          -E "${${{ matrix.runner }}_EXCLUDE_TESTS_REGEX}"