request_mem.h
1 
5 #pragma once
6 #include <memory>
7 #include <string>
8 #include <utility>
9 
10 #include <ucp/api/ucp.h>
11 
12 #include <ucxx/delayed_submission.h>
13 #include <ucxx/request.h>
14 #include <ucxx/typedefs.h>
15 
16 namespace ucxx {
17 
18 class Buffer;
19 
20 namespace internal {
21 class RecvMemMessage;
22 } // namespace internal
23 
30 class RequestMem : public Request {
31  private:
32  friend class internal::RecvMemMessage;
33 
34  uint64_t _remote_addr{};
35  ucp_rkey_h _rkey{};
36 
63  RequestMem(std::shared_ptr<Endpoint> endpoint,
64  const std::variant<data::MemPut, data::MemGet> requestData,
65  const std::string operationName,
66  const bool enablePythonFuture = false,
67  RequestCallbackUserFunction callbackFunction = nullptr,
68  RequestCallbackUserData callbackData = nullptr);
69 
70  public:
95  friend std::shared_ptr<RequestMem> createRequestMem(
96  std::shared_ptr<Endpoint> endpoint,
97  const std::variant<data::MemPut, data::MemGet> requestData,
98  const bool enablePythonFuture,
99  RequestCallbackUserFunction callbackFunction,
100  RequestCallbackUserData callbackData);
101 
103 
119  static void memPutCallback(void* request, ucs_status_t status, void* arg);
120 
136  static void memGetCallback(void* request, ucs_status_t status, void* arg);
137 
146  void request();
147 };
148 
149 } // namespace ucxx
Send or receive a message with the UCX RMA API.
Definition: request_mem.h:30
friend std::shared_ptr< RequestMem > createRequestMem(std::shared_ptr< Endpoint > endpoint, const std::variant< data::MemPut, data::MemGet > requestData, const bool enablePythonFuture, RequestCallbackUserFunction callbackFunction, RequestCallbackUserData callbackData)
Constructor for std::shared_ptr<ucxx::RequestMem>.
void request()
Create and submit a memory get or put request.
virtual void populateDelayedSubmission()
Populate the internal submission dispatcher.
static void memPutCallback(void *request, ucs_status_t status, void *arg)
Callback executed by UCX when a memory put request is completed.
static void memGetCallback(void *request, ucs_status_t status, void *arg)
Callback executed by UCX when a memory get request is completed.
Base type for a UCXX transfer request.
Definition: request.h:38
Definition: address.h:15
std::function< void(ucs_status_t, std::shared_ptr< void >)> RequestCallbackUserFunction
A user-defined function to execute as part of a ucxx::Request callback.
Definition: typedefs.h:109
std::shared_ptr< void > RequestCallbackUserData
Data for the user-defined function provided to the ucxx::Request callback.
Definition: typedefs.h:117