Skip to content

ROCR: document hotswap debug instrumentation architecture - #8388

Draft
harsh-amd wants to merge 2 commits into
ROCm:developfrom
harsh-amd:users/harsh-amd/hotswap-debug-instrumentation-architecture
Draft

ROCR: document hotswap debug instrumentation architecture#8388
harsh-amd wants to merge 2 commits into
ROCm:developfrom
harsh-amd:users/harsh-amd/hotswap-debug-instrumentation-architecture

Conversation

@harsh-amd

@harsh-amd harsh-amd commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a ROCR design note for a separate opt-in hotswap debug instrumentation mode.
  • Define dispatch, entry-wrapper, and per-site diagnostic modes.
  • Split responsibilities between ROCR runtime policy/resources and COMGR instruction-level instrumentation.
  • Document host-known cluster metadata versus device-time hardware reads, including the production B0 use of the documented IB_STS2 cluster-id source.
  • Clarify that dispatch packet metadata capture is opportunistic unless the packet path is ROCR-visible, and that production strict-mode correctness must stay independent of debug mode.
  • Document compatibility and failure policy for future debug flags/options.

Validation

  • Docs-only change.
  • Ran git diff --check on the touched RST files.

@github-actions github-actions Bot added documentation Improvements or additions to documentation project: rocr-runtime labels Jul 10, 2026
@therock-pr-bot

Copy link
Copy Markdown

❌ PR Check — Action Required

Check Status Details
🌿 Branch Name ✅ Pass
📝 PR Title/Description ❌ Fail Error: Title does not follow Conventional Commits style.
Expected: start with a valid type (feat, fix, docs, …).
Desired format: type(optional-scope): short description
───
Error: PR description must reference a JIRA ID, ISSUE ID, or a GitHub closing keyword.
Expected: include a JIRA ID / ISSUE ID line (separator : or -, or omitted; value may be a JIRA key, a number with/without #, or a link), OR a closing keyword + issue reference. Accepted examples:
JIRA ID : TESTAUTO-6039
JIRA ID - #330
JIRA ID #330
ISSUE ID : TESTUTO-3334
ISSUE ID #3334
ISSUE ID - TESTAUTO-3433
ISSUE ID : https://github.com/<org_name>/<repo_name>/issues/1234
Closes #10
Fixes octo-org/octo-repo#100
Resolves: #123
#123
https://github.com/<org_name>/<repo_name>/issues/123
Current: no valid JIRA/ISSUE/closing-keyword reference found
Forbidden Files ✅ Pass
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 pre-commit ⏳ Pending ⏳ Still running…
🚫 Draft PR 🔜 To Be Enabled
🚩 Feature Flag 🔜 To Be Enabled
📊 Code Coverage 🔜 To Be Enabled

⚠️ 1 policy check(s) failed. Please address the issues above before this PR can be Reviewed.

🚫 Please fix the failed policies

  • ❌ PR Title/Description

The Not ready to Review label was added to this PR. Once all policies pass, the label is removed automatically.

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

@therock-pr-bot

Copy link
Copy Markdown

🚫 Please fix the failed policies before requesting reviews.

The following policy checks failed:

  • ❌ PR Title/Description

The Not ready to Review label has been added to this PR.
Once all policies pass, the label will be removed automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant