DEVICE: Document return status for device APIs #10940
Open
+39
−1
Conversation
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
michal-shalev
requested review from
Artemy-Mellanox,
brminich,
iyastreb,
ofirfarjun7 and
tvegas1
iyastreb
previously approved these changes
Oct 8, 2025
|
@Artemy-Mellanox currently UCP returns |
tvegas1
previously approved these changes
Oct 8, 2025
|
It would require testing and updating the tests, let's discuss tomorrow and for now update documentation according to the current implementation. |
michal-shalev
changed the title
tvegas1
approved these changes
Oct 13, 2025
ofirfarjun7
approved these changes
Oct 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
What?
Following #10928
Update UCT and UCP device API documentation to specify that send operations return
UCS_INPROGRESSwhen successfully posted andUCS_OKwhen successfully completed.Why?
Following #10928 the device send functions return
UCS_INPROGRESSafter posting operations (for gda_rc, not_cuda_ipc), but the documentation only stated generic "Error code as defined by ucs_status_t" without clarifying the expected return values or that completion checking is required.How?
Added explicit
UCS_INPROGRESSandUCS_OKdocumentation to all device send functions (put_single, atomic_add, put_multi, put_multi_partial) at both UCT and UCP layers.