Repository navigation
Fix comments and documentation - #262
Merged
Merged
Conversation
derobins
commented
Oct 19, 2026
Collaborator
- Say in hipobj.h that hipObjInit() reads the environment, so it mustn't run while another thread changes it, and that a callback must return on the thread that called it. Assert in debug builds that a thread's count of connection leases doesn't go below zero.
- Say in hipobj.h that a staging copy that timed out keeps calls that start after it from using the buffer, rather than that the buffer can't be used, since calls already in progress aren't stopped.
- Correct the comment in BufferMap::deregisterBuffer() about where copies of a buffer's entry are made.
- List every package the MinIO bridge build needs in building.rst.
- Say in interop.rst that the client's and server's MTUs must match, since hipObject doesn't negotiate a path MTU.
- Mention the GET that sometimes hangs in the two-VM GPU lane's known-failure summary.
- Say in hipobj.h that hipObjInit() reads the environment, so it mustn't run while another thread changes it, and that a callback must return on the thread that called it. Assert in debug builds that a thread's count of connection leases doesn't go below zero. - Say in hipobj.h that a staging copy that timed out keeps calls that start after it from using the buffer, rather than that the buffer can't be used, since calls already in progress aren't stopped. - Correct the comment in BufferMap::deregisterBuffer() about where copies of a buffer's entry are made. - List every package the MinIO bridge build needs in building.rst. - Say in interop.rst that the client's and server's MTUs must match, since hipObject doesn't negotiate a path MTU. - Mention the GET that sometimes hangs in the two-VM GPU lane's known-failure summary. Co-Authored-By: Claude <noreply@anthropic.com>
derobins
requested review from
akolliasAMD,
gaoikawa,
jordan-turbofish,
kurtmcmillan,
riley-dixon,
sbates130272 and
zbyrne
as code owners
October 19, 2026 06:56
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Only a minor documentation correction about optional dependencies remains; no blocking issues were identified.
1 open issue
What changed in this PR
Clarifies hipObject’s caller requirements, build dependencies, and RDMA interoperability guidance, with a debug assertion for lease accounting.
Changes:
- Clarifies threading and timed-out staging-copy behavior.
- Documents bridge dependencies, MTU requirements, and a known CI hang.
- Adds a lease-count assertion and corrects an ownership comment.
| File | Description |
|---|---|
| src/rdma/connection-pool.cpp | Adds a debug lease-count assertion. |
| src/buffer.cpp | Corrects the buffer ownership comment. |
| include/hipobj.h | Clarifies threading and buffer-use requirements. |
| docs/interop.rst | Documents matching MTU requirements. |
| docs/building.rst | Expands MinIO bridge dependency guidance. |
| CHANGELOG.md | Records clarified requirements and limitations. |
| .github/workflows/hipobject-hardware-test-two-vm-gpu-direct.yml | Documents an intermittent GET hang. |
Review effort: Balanced
Contributor
Security scan found no critical or high findings on lines changed by this pull requestView the security scan run for complete reports. “New” means the finding is located in a changed file on an added or modified line; it is not a base-versus-head findings delta. |
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.
