Repository navigation
docs(hrr): match api matrix workload comments to the expectations header - #14135
Merged
Merged
Conversation
Many comments in hrr_api_matrix_workload_test.cc contradicted hrr_api_matrix_expectations.h and the capture code: they described a hipLaunchByPtr call the file never makes, replay segfaults on APIs the header classes REAL, NOOP classes for the hipCtx* and shareable-handle APIs that the header classes otherwise, a grid-wide barrier the cooperative kernels do not have, and failed imports that capture does not record. Rewrite each to state the header's class or the capture behaviour, or delete it. Comments only. Jira: AIRUNTIME-3052
✅ All Policy Checks Passed
📖 Need help? See the Policy FAQ for details on every check and how to fix failures. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes affect only comments, match the checked expectations and implementations, and have no unresolved findings.
No open issues 🎉
What changed in this PR
This comment-only PR aligns the HRR API matrix workload documentation with the expectations header and capture/replay behavior. Executable code and test expectations are unchanged.
Changes:
- Replaces outdated replay-crash claims with current replay classifications.
- Clarifies success-only capture behavior and removes descriptions of calls or barriers the workloads do not execute.
- Revises the T1 and T2 headers to reflect their mixed replay classes.
| File | Description |
|---|---|
| projects/hrr/tests/integration/hrr_api_matrix_workload_test.cc | Corrects workload comments to match API expectations and capture/replay behavior. |
Review effort: Balanced
danielbolsson
approved these changes
Oct 26, 2026
danielbolsson
left a comment
danielbolsson
left a comment
Contributor
There was a problem hiding this comment.
Checked 8606a18: comments only (the PR's own git diff -U0 | grep -v '//' check is empty) and the classes the new comments state match hrr_api_matrix_expectations.h. Nothing blocking.
Contributor
TheRock Submodule Bump ActivityNewest first
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Many comments in
hrr_api_matrix_workload_test.cccontradicthrr_api_matrix_expectations.hand the capture code. They describe replay crashes the header no longer expects, calls the file never makes, and replay classes the header does not assign. A reader who uses the tests to learn how HRR handles an API is misled.Technical Details
git diff -U0 a08bc31f04 | grep '^[-+]' | grep -v '^[-+][-+]' | grep -v '^[-+] *//'prints nothing.hipSetupArgument,hipGetProcAddress_spt, the_sptlaunches,hipCtx*and the shareable-handle exports now give the class from the header.hipLaunchByPtr, cooperative-barrier and "recorded either way" comments are corrected or removed. Capture records the IPC open and the external memory and semaphore imports only onhipSuccess.Issue Tracking
JIRA ID: AIRUNTIME-3052
Test Plan
None. Only comments change, so the compiled code is the same as on develop. The PR carries
ci:skip.Test Result
Not applicable.
Submission Checklist