Skip to content

[WIP][DNM]UCT/API: allow purge cb returning code #11882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jeynmann wants to merge 3 commits into from
Closed

[WIP][DNM]UCT/API: allow purge cb returning code #11882

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ef1304
UCT/API: allow purge cb return code
JeynmannZ Sep 2, 2026
8aec343
GTEST/UCT/IB: fix purge cb
JeynmannZ Sep 3, 2026
632357f
UCT/API: address comments
JeynmannZ Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/uct/api/v2/uct_v2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1916,8 +1916,12 @@ typedef struct uct_ep_op_info {
/**
* @ingroup UCT_RESOURCE
* @brief Callback invoked for each undelivered outstanding operation.
*

@svc-nvidia-pr-review svc-nvidia-pr-review Sep 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The return value is not consumed or documented anywhere. The new doc says UCS_OK means the error was handled and otherwise it is "returned back", but: no in-tree caller consumes the status (the only invocation is in test_ib_mlx5_ext.cc:72, which discards the return value); and the uct_ep_outstanding_purge function doc and uct_ep_outstanding_purge_params_t::cb doc are not updated to describe what "returned back" means (e.g. does a non-UCS_OK from the callback abort the purge, and does it propagate out of uct_ep_outstanding_purge?). Please clarify in the API docs how the status flows back to the uct_ep_outstanding_purge caller, and update the test callback so the change is exercised.

* @return @ref UCS_OK - The operation was purged successfully.
* Otherwise - The operation was not purged and is returned back

@evgeny-leksikov evgeny-leksikov Sep 3, 2026

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.

Suggested change
* @return @ref UCS_OK - The operation was purged successfully.
* Otherwise - The operation was not purged and is returned back
* @return @ref UCS_OK - The purged operation was handled successfully.
* Otherwise - The purged operation was handled with error and returned back

additional question - how should transport handle this error? what's the side effect of it for user?

@roiedanino roiedanino Sep 3, 2026

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.

Should probably stop processing the next wqes?

@evgeny-leksikov evgeny-leksikov Sep 4, 2026

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.

it may lead to hang of upper layer (UCP), it looks like this status useless, UCT cannot react on this and must continue purging.
if UCP is not able to handle its requests, it looks like unrecoverable error on UCP side.

* to the transport.
*/
typedef void (*uct_ep_outstanding_purge_callback_t)(
typedef ucs_status_t (*uct_ep_outstanding_purge_callback_t)(
const uct_ep_op_info_t *op_info, void *arg);


Expand Down
3 changes: 2 additions & 1 deletion test/gtest/uct/ib/test_ib_mlx5_ext.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,10 @@ class test_uct_ib_mlx5_ext_rc : public test_rc {
return UCS_OK;
}

static void purge_cb(const uct_ep_op_info_t*, void *arg)
static ucs_status_t purge_cb(const uct_ep_op_info_t*, void *arg)
{
*static_cast<bool*>(arg) = true;
return UCS_OK;
}

static void
Expand Down