feat: add a passthrough for PROJECT_ENABLE_COVERAGE flag by reboss · Pull Request #3761 · ROCm/TheRock

reboss · 2026-03-04T21:22:48Z

Motivation

We want to migrate code coverage jobs to TheRock

Technical Details

This PR introduces a passthrough for cmake definitions to their respective projects with:

set(_coverage_arg "-D${_logical_target_name}_ENABLE_COVERAGE=${${_logical_target_name}_ENABLE_COVERAGE}")

Test Plan

We'll use the following PR to test that a code coverage job can be kicked off and run for any given project:
ROCm/rocm-libraries#4441

Test Result

Submission Checklist

Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests.

Resolves: #6572

therock-pr-bot · 2026-07-13T16:22:59Z

✅ All Policy Checks Passed

Check	Status	Details
📝 PR Description	✅ Pass	—
⛔ Forbidden Files	✅ Pass	—
🧪 Unit Test	✅ Pass	PR does not contain code files — Unit Test auto-passed
🚫 Draft PR	🔜 To Be Enabled	—
🚩 Feature Flag	🔜 To Be Enabled	—
📊 Code Coverage	🔜 To Be Enabled	—

🎉 All policy checks passed!

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

therock-pr-bot · 2026-07-13T16:23:01Z

🎉 All checks passed! This PR is ready for review.

ScottTodd · 2026-07-15T18:00:27Z

+    # Passthrough -D<PROJECT_NAME>_ENABLE_COVERAGE=ON to the subproject
+    # Convert logical target name to uppercase (e.g., hipDNN -> HIPDNN_ENABLE_COVERAGE)
+    set(_coverage_arg)
+    string(TOUPPER "${_logical_target_name}" _coverage_project_name)
+    set(_coverage_var_name "${_coverage_project_name}_ENABLE_COVERAGE")
+
+    if(DEFINED ${_coverage_var_name})
+      set(_coverage_arg "-D${_coverage_var_name}=${${_coverage_var_name}}")
+    endif()


Please document {project}_ENABLE_COVERAGE support here:

TheRock/docs/development/development_guide.md

Lines 178 to 202 in 6033313

### Per-project CMake flags

These CMake flags allow overriding the global options for individual sub-projects:

- `{project}_BUILD_TYPE`

For example, this will build the "hipBLASLt" subproject in `RelWithDebInfo` and all other projects in `Release`:

```bash

-DCMAKE_BUILD_TYPE=Release \

-DhipBLASLt_BUILD_TYPE=RelWithDebInfo \

```

> [!TIP]

> See the [Tips for using VSCode](#tips-for-using-vscode) section below for an

> example of how to debug programs built in this way.

- `{project}_CMAKE_ARGS`

This variable will append to a subproject's default CMAKE arguments. It is a semicolon separated list.

For example, this will add options to set tensilelite build parallel and keep build tmp in the "hipBLASLt" subproject:

```bash

-DhipBLASLt_CMAKE_ARGS="-DTENSILELITE_BUILD_PARALLEL_LEVEL=32;-DTENSILELITE_KEEP_BUILD_TMP=ON"

```

Added docs here: 1ced5b9

ScottTodd · 2026-07-15T18:03:09Z

+    # Passthrough -D<PROJECT_NAME>_ENABLE_COVERAGE=ON to the subproject
+    # Convert logical target name to uppercase (e.g., hipDNN -> HIPDNN_ENABLE_COVERAGE)
+    set(_coverage_arg)
+    string(TOUPPER "${_logical_target_name}" _coverage_project_name)
+    set(_coverage_var_name "${_coverage_project_name}_ENABLE_COVERAGE")
+
+    if(DEFINED ${_coverage_var_name})
+      set(_coverage_arg "-D${_coverage_var_name}=${${_coverage_var_name}}")
+    endif()


You can also move _coverage_arg up to be next to the other per-project CMake flags here:

TheRock/cmake/therock_subproject.cmake

Lines 872 to 881 in 6033313

list(APPEND _cmake_args "${${target_name}_CMAKE_ARGS}")

# Derive the CMAKE_BUILD_TYPE from either {project}_BUILD_TYPE or the global

# CMAKE_BUILD_TYPE.

set(_cmake_build_type "${${target_name}_BUILD_TYPE}")

if(NOT _cmake_build_type)

set(_cmake_build_type "${CMAKE_BUILD_TYPE}")

else()

message(STATUS " PROJECT SPECIFIC CMAKE_BUILD_TYPE=${_cmake_build_type}")

endif()

and I think you can simplify this "check if the variable exists" to just match the style used for CMAKE_ARGS:

list(APPEND _cmake_args "${${target_name}_CMAKE_ARGS}")

if the variable doesn't exist, list append will do nothing I think...

I reordered the logic and used _cmake_args instead. I simplified the logic a little bit, but the TOUPPER is still required.

53d303c

ScottTodd · 2026-07-15T18:03:25Z

+    # Convert logical target name to uppercase (e.g., hipDNN -> HIPDNN_ENABLE_COVERAGE)
+    set(_coverage_arg)
+    string(TOUPPER "${_logical_target_name}" _coverage_project_name)


If we standardize the case we should do it for all per-project variables. Is this actually needed?

Yes it's needed, or rather should be there, as it ensures that we always get -DHIPDNN_ENABLE_COVERAGE, for example, instead of -DhipDNN_ENABLE_COVERAGE, which doesn't follow CMake's standard for definitions.

As it is defined, it will only check if the former is being passed, and if it is, propagate it to hipDNN. If someone uses some non-standard case, then it will ignore it.

See docs: 1ced5b9

All per-project variables should use consistent casing, possibly standardizing with TOUPPER.

geomin12

lgtm but as Scott mentioned, docs to show the support!

Add documentation explaining that TheRock checks for uppercase PROJECT_ENABLE_COVERAGE flags and passes them through to subprojects. This clarifies that users must use HIPDNN_ENABLE_COVERAGE, not hipDNN_ENABLE_COVERAGE, as the code only checks for the uppercase form.

Propagate the COMPILER_RT_BUILD_PROFILE_ROCM flag from TheRock's top-level configure to the LLVM/compiler-rt sub-project build. This enables building libclang_rt.profile_rocm.a when coverage instrumentation is requested. The flag is set in the rocm-libraries coverage workflow and now properly reaches the compiler-rt configuration, allowing device-side profiling runtime to be built for HIP coverage builds.

Configure LLVM_RUNTIME_TARGETS with amdgcn-amd-amdhsa when COMPILER_RT_BUILD_PROFILE_ROCM is enabled. This builds compiler-rt for device targets, which is required for HIP device profiling. Per LLVM HIP offload PGO documentation, device coverage requires: - LLVM_RUNTIME_TARGETS="default;amdgcn-amd-amdhsa" - RUNTIMES_amdgcn-amd-amdhsa_LLVM_ENABLE_RUNTIMES="compiler-rt;libc" - RUNTIMES_amdgcn-amd-amdhsa_CACHE_FILES pointing to GPU.cmake - RUNTIMES_amdgcn-amd-amdhsa_RUNTIMES_USE_LIBC="llvm-libc" This enables building the device profiling runtime that provides __llvm_prf_* symbols needed by instrumented device code.

Correct the cache file reference from GPU.cmake (doesn't exist) to AMDGPU.cmake, and override COMPILER_RT_PROFILE_BAREMETAL to OFF. AMDGPU.cmake sets COMPILER_RT_PROFILE_BAREMETAL=ON which causes COMPILER_RT_BUILD_PROFILE_ROCM to default to OFF, disabling the device profiling runtime. Explicitly set both flags to ensure the device profiling runtime is built for coverage builds.

Coverage builds cross-compile compiler-rt for amdgcn targets in addition to host, significantly increasing memory usage. Flang is not required for HIP coverage instrumentation, so disable it when COMPILER_RT_BUILD_PROFILE_ROCM is enabled to prevent OOM during LLVM build. Minimal HIP offload PGO/coverage only requires clang and lld.

Flang will be kept enabled but with limited parallelism via LLVM_PARALLEL_LINK_JOBS to control memory usage.

Device profiling runtime cannot build for amdgcn targets because the profiling source code includes host OS headers (unistd.h, fcntl.h) that don't exist in freestanding GPU environments. Reverting commits: - b83de89 Forward COMPILER_RT_BUILD_PROFILE_ROCM to LLVM build - 1f7153f Enable amdgcn runtime targets for device coverage builds - 979c90b Fix amdgcn device profiling runtime configuration Will use host-only coverage instrumentation instead.

CreateIntrinsic now returns Value* instead of CallInst*, requiring explicit casts in SPIRVRegularizeLLVM and SPIRVReader.

Remove the coverage-specific branch that stripped down AMDGPU runtimes to just compiler-rt and libc. Device profiling doesn't conflict with libcxx, libcxxabi, flang-rt, or openmp - the minimal runtime list was purely a build-time optimization. Always build the full runtime set (compiler-rt, libc, libcxx, libcxxabi, flang-rt, openmp) for amdgcn-amd-amdhsa. When COMPILER_RT_BUILD_PROFILE_ROCM is enabled, just add the two coverage-specific flags without removing runtimes. This ensures other TheRock components that depend on libcxx or OpenMP aren't broken by coverage builds.

The coverage-specific logic that strips down amdgcn runtimes was already removed from the amd-staging block in commit 8a3c29b. This separate COMPILER_RT_BUILD_PROFILE_ROCM block (lines 71-92) was leftover redundant code that: 1. Removed Flang from LLVM_ENABLE_PROJECTS (conflicts with flang-rt in the amdgcn runtime list set by the earlier block) 2. Re-set LLVM_RUNTIME_TARGETS and amdgcn runtime config that's already handled in the amd-staging block Remove this entire block. Coverage builds now work the same as normal builds with the addition of COMPILER_RT_BUILD_PROFILE_ROCM=ON.

The device profiling runtime for amdgcn targets must use BAREMETAL=ON (the GPU.cmake default) because GPU device code cannot use filesystem operations or host-side initialization code. Device profiling support comes from InstrProfilingPlatformGPU.c which is automatically included for GPU targets when COMPILER_RT_BUILD_PROFILE=ON (already set by GPU.cmake cache). The previous override to BAREMETAL=OFF was attempting to enable the host-side libclang_rt.profile_rocm.a (InstrProfilingPlatformROCm.cpp), but that's only for host code. Device-side instrumentation works differently and requires BAREMETAL=ON. This fixes "Kernel launch failure" errors in hipRAND coverage tests caused by invalid device runtime configuration.

…patibility)

github-project-automation Bot added this to TheRock Triage Mar 4, 2026

github-project-automation Bot moved this to TODO in TheRock Triage Mar 4, 2026

reboss force-pushed the enable-codecov branch 2 times, most recently from f629edc to 6afcd5a Compare April 21, 2026 22:08

reboss force-pushed the enable-codecov branch from 6afcd5a to 383b8dd Compare May 22, 2026 21:55

reboss force-pushed the enable-codecov branch from 383b8dd to 5475e66 Compare June 4, 2026 16:19

reboss mentioned this pull request Jul 13, 2026

[Proof of Concept ] code coverage for ROCm libraries ROCm/rocm-libraries#8656

Closed

reboss force-pushed the enable-codecov branch from 5475e66 to 64b48d5 Compare July 13, 2026 16:22

therock-pr-bot Bot added the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 13, 2026

reboss force-pushed the enable-codecov branch from 64b48d5 to 90b257d Compare July 13, 2026 18:23

reboss marked this pull request as ready for review July 13, 2026 18:23

amd-shiraz requested review from ScottTodd, amd-shiraz and geomin12 July 15, 2026 15:08

reboss changed the title ~~[codecov] add a simple passthrough for PROJECT_ENABLE_COVERAGE flag~~ [codecov] add a simple passthrough for PROJECT_ENABLE_COVERAGE flag Resolves: #6572 Jul 15, 2026

reboss removed the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 15, 2026

therock-pr-bot Bot added the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 15, 2026

reboss changed the title ~~[codecov] add a simple passthrough for PROJECT_ENABLE_COVERAGE flag Resolves: #6572~~ [codecov] add a passthrough for PROJECT_ENABLE_COVERAGE flag Resolves: #6572 Jul 15, 2026

reboss changed the title ~~[codecov] add a passthrough for PROJECT_ENABLE_COVERAGE flag Resolves: #6572~~ feat: add a passthrough for PROJECT_ENABLE_COVERAGE flag Resolves: #6572 Jul 15, 2026

reboss removed the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 15, 2026

therock-pr-bot Bot added the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 15, 2026

reboss changed the title ~~feat: add a passthrough for PROJECT_ENABLE_COVERAGE flag Resolves: #6572~~ feat: add a passthrough for PROJECT_ENABLE_COVERAGE flag Jul 15, 2026

reboss removed the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 15, 2026

ScottTodd reviewed Jul 15, 2026

View reviewed changes

geomin12 reviewed Jul 17, 2026

View reviewed changes

reboss force-pushed the enable-codecov branch 2 times, most recently from 4a1dbaa to 53d303c Compare July 21, 2026 15:10

reboss requested a review from ScottTodd July 21, 2026 15:21

reboss force-pushed the enable-codecov branch from 8a3c29b to 1d6d339 Compare July 29, 2026 16:58

ScottTodd mentioned this pull request Jul 31, 2026

Add RFC0014 for code coverage infrastructure in TheRock #6967

Merged

reboss force-pushed the enable-codecov branch from e0491e3 to cea8407 Compare August 6, 2026 15:35

reboss added 19 commits August 13, 2026 10:16

[codecov] add a simple passthrough for PROJECT_ENABLE_COVERAGE flag

df7d4cc

Make sure to make project name uppercase before passing to CMake

512b412

WIP: check both forms of project name

9393043

minimal changes to achieve passthrough

f30c5ff

Organize logic better and use _cmake_args instead of _coverage_arg var

0846e74

Revert "Disable Flang for coverage builds to reduce memory usage"

4c67440

Flang will be kept enabled but with limited parallelism via LLVM_PARALLEL_LINK_JOBS to control memory usage.

Revert device profiling and Flang disablement attempts

01961d7

Enable device profiling runtime for coverage builds

0d2ab29

Update spirv-llvm-translator for LLVM API compatibility

16f051d

CreateIntrinsic now returns Value* instead of CallInst*, requiring explicit casts in SPIRVRegularizeLLVM and SPIRVReader.

wip: debug artifact fetch in setup_test_environment

f027e21

reboss force-pushed the enable-codecov branch from cea8407 to 5bb0da9 Compare August 13, 2026 16:18

reboss added 4 commits August 13, 2026 10:31

sync up spirv with what is in main

d086bee

Restore amd-llvm to commit with HIP device PGO fixes

c0e892f

Update spirv-llvm-translator to match main branch (fixes LLVM API com…

615b63d

…patibility)

use proper spirv hash

cb55bf0

jainprad mentioned this pull request Aug 25, 2026

feat(ci): Migrate code coverage workflows into TheRock #7623

Closed

3 of 4 tasks

reboss closed this Sep 14, 2026

github-project-automation Bot moved this from TODO to Done in TheRock Triage Sep 14, 2026

Navigation Menu

Repository navigation

feat: add a passthrough for PROJECT_ENABLE_COVERAGE flag - #3761

feat: add a passthrough for PROJECT_ENABLE_COVERAGE flag#3761
reboss wants to merge 23 commits into
ROCm:mainfrom
reboss:enable-codecov

reboss commented Mar 4, 2026 •

edited

Loading

Uh oh!

therock-pr-bot Bot commented Jul 13, 2026 •

edited

Loading

Uh oh!

therock-pr-bot Bot commented Jul 13, 2026 •

edited

Loading

Uh oh!

ScottTodd Jul 15, 2026

Uh oh!

reboss Jul 21, 2026

Uh oh!

ScottTodd Jul 15, 2026 •

edited

Loading

Uh oh!

reboss Jul 21, 2026 •

edited

Loading

Uh oh!

ScottTodd Jul 15, 2026

Uh oh!

reboss Jul 21, 2026 •

edited

Loading

Uh oh!

ScottTodd Jul 21, 2026

Uh oh!

geomin12 left a comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	### Per-project CMake flags

	These CMake flags allow overriding the global options for individual sub-projects:

	- `{project}_BUILD_TYPE`

	For example, this will build the "hipBLASLt" subproject in `RelWithDebInfo` and all other projects in `Release`:

	```bash
	-DCMAKE_BUILD_TYPE=Release \
	-DhipBLASLt_BUILD_TYPE=RelWithDebInfo \
	```

	> [!TIP]
	> See the [Tips for using VSCode](#tips-for-using-vscode) section below for an
	> example of how to debug programs built in this way.

	- `{project}_CMAKE_ARGS`

	This variable will append to a subproject's default CMAKE arguments. It is a semicolon separated list.
	For example, this will add options to set tensilelite build parallel and keep build tmp in the "hipBLASLt" subproject:

	```bash
	-DhipBLASLt_CMAKE_ARGS="-DTENSILELITE_BUILD_PARALLEL_LEVEL=32;-DTENSILELITE_KEEP_BUILD_TMP=ON"
	```

	list(APPEND _cmake_args "${${target_name}_CMAKE_ARGS}")

	# Derive the CMAKE_BUILD_TYPE from either {project}_BUILD_TYPE or the global
	# CMAKE_BUILD_TYPE.
	set(_cmake_build_type "${${target_name}_BUILD_TYPE}")
	if(NOT _cmake_build_type)
	set(_cmake_build_type "${CMAKE_BUILD_TYPE}")
	else()
	message(STATUS " PROJECT SPECIFIC CMAKE_BUILD_TYPE=${_cmake_build_type}")
	endif()

Conversation

reboss commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Technical Details

Test Plan

Test Result

Submission Checklist

Uh oh!

therock-pr-bot Bot commented Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ All Policy Checks Passed

Uh oh!

therock-pr-bot Bot commented Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ScottTodd Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

reboss Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

ScottTodd Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reboss Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ScottTodd Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

reboss Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ScottTodd Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

geomin12 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

reboss commented Mar 4, 2026 •

edited

Loading

therock-pr-bot Bot commented Jul 13, 2026 •

edited

Loading

therock-pr-bot Bot commented Jul 13, 2026 •

edited

Loading

ScottTodd Jul 15, 2026 •

edited

Loading

reboss Jul 21, 2026 •

edited

Loading

reboss Jul 21, 2026 •

edited

Loading