UCT/API: Add uct_rkey_compare() function #9297
Conversation
src/uct/api/uct.h
Outdated
| /** | ||
| * Register the memory region so its remote access key would likely be | ||
| * equal to remote access keys received from other peers, when compared | ||
| * with @ref uct_rkey_compare. This flag is best-effort. When remote access |
There was a problem hiding this comment.
I'd suggest the following to solve docs build problem
| * with @ref uct_rkey_compare. This flag is best-effort. When remote access | |
| * with @a uct_rkey_compare. This flag is best-effort. When remote access |
src/uct/api/uct.h
Outdated
| * with @a uct_rkey_compare. This flag is a best-effort hint. When remote | ||
| * access keys received from different peers are compared equal, they can | ||
| * be used interchangeably, avoiding the need to keep all of them in | ||
| * memory. |
There was a problem hiding this comment.
All the comment for UCP API are applicable here.
src/uct/api/v2/uct_v2.h
Outdated
| /** | ||
| * @ingroup UCT_MD | ||
| * | ||
| * @brief Compare two remote keys |
There was a problem hiding this comment.
replaced by This routine compares two remote keys.
src/uct/api/v2/uct_v2.h
Outdated
| * semantic is arbitrary and implementation dependent, nevertheless it's | ||
| * guaranteed to be consistent (transitive and antisymmetric). It can be used, | ||
| * for example, to perform an efficient binary search in a sorted array of | ||
| * remote keys. |
There was a problem hiding this comment.
the same comments as in UCP code review
There was a problem hiding this comment.
replaced by shorter paragraph.
src/uct/api/v2/uct_v2.h
Outdated
| * @param[in] params Additional parameters for comparison | ||
| * @param[out] result Result of the comparison | ||
| * | ||
| * @return Error code or UCS_OK if result contains the comparison result |
There was a problem hiding this comment.
What UCP will do if error returned ? What does unsupported means ?
There was a problem hiding this comment.
The proposal is to have UCP immediately return that error.
The unsupported below is to be replaced by actual implementation after this PR is merged.
There was a problem hiding this comment.
what UCP will return if underlaying layer reports unsuported
There was a problem hiding this comment.
please check UCP side response: #9289 (comment)
src/uct/api/v2/uct_v2.h
Outdated
| * @brief This routine compares two remote keys. | ||
| * | ||
| * It sets the @a result argument to < 0 if rkey1 is lower than rkey2, 0 if they | ||
| * are equal or > 0 if rkey1 is greater than rkey2. It can be used for sorting. |
There was a problem hiding this comment.
E.g. the result value can be used for sorting remote keys
tvegas1
force-pushed
the
uct_rkey_compare_api
branch
from
e0ca269
to
4fc943a
Compare
tvegas1
force-pushed
the
uct_rkey_compare_api
branch
from
4fc943a
to
e0ca269
Compare
tvegas1
force-pushed
the
uct_rkey_compare_api
branch
from
e0ca269
to
3bea09d
Compare
What
Add
uct_rkey_compare()API, relates to #9289.Why ?
We need to compare remote keys to deduplicate received remote keys, > 0, = 0 or < 0.
How ?
Usage: