Skip to content

docs(hip): Added warning in hipHostRegister API - #11670

Merged
cgoea merged 4 commits into
developfrom
users/jujiang/hip-header
Sep 21, 2026
Merged

cgoea merged 4 commits into
developfrom
users/jujiang/hip-header

Conversation

@jujiang-del

Copy link
Copy Markdown
Contributor

Motivation

Add extra doxygen for the API hipHostRegister, in HIP api header, as a permanent limitation for performance and kernel stability with large host memory registrations.

Technical Details

JIRA ID AIRUNTIME-2779.
Add a warning regarding with the issue ROCM-29767 for Performance and Kernel Stability Limitations with Large Registrations.
hipHostRegister is intended for small-to-moderate buffers and staging areas. Avoid registering very large host-allocated memory regions (e.g., multi-gigabyte or multi-terabyte buffers such as LLM KV caches or large dataset buffers) via hipHostRegister (userptr).

Issue Tracking

AIRUNTIME-2779

Test Plan

N/A

Test Result

N/A

Submission Checklist

@therock-pr-bot

Copy link
Copy Markdown

✅ All Policy Checks Passed

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ⚠️ Warning Error: Source/code files changed without an accompanying unit test.
Expected: add at least one test file named like test_<name>.py / test_<name>.cpp (or <name>_test.*).
Current: code file(s) changed: projects/hip/include/hip/hip_runtime_api.h; no test file found
🚫 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?

@randyh62 randyh62 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks.

@cgoea
cgoea merged commit 2f0b42c into develop Sep 21, 2026
35 of 43 checks passed
@cgoea
cgoea deleted the users/jujiang/hip-header branch September 21, 2026 07:52
systems-assistant Bot pushed a commit to ROCm/hip that referenced this pull request Sep 21, 2026
## Motivation

Add extra doxygen for the API hipHostRegister, in HIP api header, as a
permanent limitation for performance and kernel stability with large
host memory registrations.

## Technical Details

JIRA ID AIRUNTIME-2779.
Add a warning regarding with the issue ROCM-29767 for Performance and
Kernel Stability Limitations with Large Registrations.
hipHostRegister is intended for small-to-moderate buffers and staging
areas. Avoid registering very large host-allocated memory regions (e.g.,
multi-gigabyte or multi-terabyte buffers such as LLM KV caches or large
dataset buffers) via hipHostRegister (userptr).

## Issue Tracking

AIRUNTIME-2779

## Test Plan

N/A

## Test Result

N/A

## Submission Checklist

- [ ] Look over the contributing guidelines at
https://github.com/ROCm/rocm-systems/blob/develop/CONTRIBUTING.md.
[rocm-systems] ROCm/rocm-systems#11670 (commit 2f0b42c)
@systems-assistant

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

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.

4 participants