Change local/remote handle names (#11145)

UCP/DEVICE/API: Change local/remote handle names

Author: ofirfarjun7

src/ucp/api/device/ucp_device_impl.h

@@ -118,7 +118,7 @@ UCS_F_DEVICE ucs_status_t ucp_device_prepare_send(
 
 
 UCS_F_DEVICE ucs_status_t ucp_device_prepare_send_remote(
-        ucp_device_remote_mem_list_handle_h dst_mem_list_h,
+        ucp_device_remote_mem_list_h dst_mem_list_h,
         unsigned dst_mem_list_index, uint64_t &remote_address,
         ucp_device_request_t *req, uct_device_ep_t *&device_ep,
         const uct_device_mem_element_t *&uct_elem,
@@ -143,16 +143,15 @@ UCS_F_DEVICE ucs_status_t ucp_device_prepare_send_remote(
 }
 
 
-UCS_F_DEVICE ucs_status_t
-ucp_device_prepare_send(ucp_device_local_mem_list_handle_h src_mem_list_h,
-                        unsigned src_mem_list_index,
-                        ucp_device_remote_mem_list_handle_h dst_mem_list_h,
-                        unsigned dst_mem_list_index, const void *&address,
-                        uint64_t &remote_address, ucp_device_request_t *req,
-                        uct_device_ep_t *&device_ep,
-                        const uct_device_local_mem_list_elem_t *&src_uct_elem,
-                        const uct_device_mem_element_t *&uct_elem,
-                        uct_device_completion_t *&comp)
+UCS_F_DEVICE ucs_status_t ucp_device_prepare_send(
+        ucp_device_local_mem_list_h src_mem_list_h, unsigned src_mem_list_index,
+        ucp_device_remote_mem_list_h dst_mem_list_h,
+        unsigned dst_mem_list_index, const void *&address,
+        uint64_t &remote_address, ucp_device_request_t *req,
+        uct_device_ep_t *&device_ep,
+        const uct_device_local_mem_list_elem_t *&src_uct_elem,
+        const uct_device_mem_element_t *&uct_elem,
+        uct_device_completion_t *&comp)
 {
     const size_t elem_size = ucs_offsetof(uct_device_local_mem_list_elem_t,
                                           uct_mem_element) +
@@ -277,9 +276,8 @@ UCS_F_DEVICE ucs_status_t ucp_device_put_single(
  */
 template<ucs_device_level_t level = UCS_DEVICE_LEVEL_THREAD>
 UCS_F_DEVICE ucs_status_t ucp_device_put(
-        ucp_device_local_mem_list_handle_h src_mem_list_h,
-        unsigned src_mem_list_index, size_t src_offset,
-        ucp_device_remote_mem_list_handle_h dst_mem_list_h,
+        ucp_device_local_mem_list_h src_mem_list_h, unsigned src_mem_list_index,
+        size_t src_offset, ucp_device_remote_mem_list_h dst_mem_list_h,
         unsigned dst_mem_list_index, size_t dst_offset, size_t length,
         unsigned channel_id, uint64_t flags, ucp_device_request_t *req)
 {
@@ -398,7 +396,7 @@ UCS_F_DEVICE ucs_status_t ucp_device_counter_inc(
  */
 template<ucs_device_level_t level = UCS_DEVICE_LEVEL_THREAD>
 UCS_F_DEVICE ucs_status_t ucp_device_counter_inc(
-        uint64_t inc_value, ucp_device_remote_mem_list_handle_h dst_mem_list_h,
+        uint64_t inc_value, ucp_device_remote_mem_list_h dst_mem_list_h,
         unsigned dst_mem_list_index, size_t remote_offset, unsigned channel_id,
         uint64_t flags, ucp_device_request_t *req)
 {
@@ -436,7 +434,7 @@ UCS_F_DEVICE ucs_status_t ucp_device_counter_inc(
  * @return Error code as defined by @ref ucs_status_t
  */
 UCS_F_DEVICE ucs_status_t
-ucp_device_get_ptr(ucp_device_remote_mem_list_handle_h mem_list_h,
+ucp_device_get_ptr(ucp_device_remote_mem_list_h mem_list_h,
                    unsigned mem_list_index, void **addr_p)
 {
     const size_t elem_size = ucs_offsetof(uct_device_remote_mem_list_elem_t,

src/ucp/api/device/ucp_device_types.h

@@ -98,7 +98,7 @@ typedef struct ucp_device_mem_list_handle {
  * The handle and most of its content is stored on GPU memory, with the intent
  * to be as memory-local as possible.
  */
-typedef struct ucp_device_remote_mem_list_handle {
+typedef struct ucp_device_remote_mem_list {
     /**
      * Structure version. Allow runtime ABI compatibility checks between host
      * and device code.
@@ -114,7 +114,7 @@ typedef struct ucp_device_remote_mem_list_handle {
      * UCT memory element objects are allocated contiguously.
      */
     uct_device_remote_mem_list_elem_t mem_elements[0];
-} ucp_device_remote_mem_list_handle_t;
+} ucp_device_remote_mem_list_t;
 
 
 /**
@@ -127,7 +127,7 @@ typedef struct ucp_device_remote_mem_list_handle {
  * The handle and most of its content is stored on GPU memory, with the intent
  * to be as memory-local as possible.
  */
-typedef struct ucp_device_local_mem_list_handle {
+typedef struct ucp_device_local_mem_list {
     /**
      * Structure version. Allow runtime ABI compatibility checks between host
      * and device code.
@@ -140,6 +140,6 @@ typedef struct ucp_device_local_mem_list_handle {
     uint32_t                         mem_list_length;
 
     uct_device_local_mem_list_elem_t mem_elements[0];
-} ucp_device_local_mem_list_handle_t;
+} ucp_device_local_mem_list_t;
 
 #endif /* UCP_DEVICE_TYPES_H */

src/ucp/api/device/ucp_host.h

@@ -189,14 +189,14 @@ ucp_device_mem_list_create(ucp_ep_h ep,
  * It can be used repeatedly, until finally released by calling @ref
  * ucp_device_mem_list_release.
  *
- * @param [in]  params    Parameters used to create the handle.
- * @param [out] handle    Created descriptor list handle.
+ * @param [in]  params     Parameters used to create the handle.
+ * @param [out] mem_list_h Created descriptor list handle.
  *
  * @return Error code as defined by @ref ucs_status_t.
  */
 ucs_status_t
 ucp_device_local_mem_list_create(const ucp_device_mem_list_params_t *params,
-                                 ucp_device_local_mem_list_handle_h *handle);
+                                 ucp_device_local_mem_list_h *mem_list_h);
 
 
 /**
@@ -211,26 +211,25 @@ ucp_device_local_mem_list_create(const ucp_device_mem_list_params_t *params,
  * It can be used repeatedly, until finally released by calling @ref
  * ucp_device_mem_list_release.
  *
- * @param [in]  params    Parameters used to create the handle.
- * @param [out] handle    Created descriptor list handle.
+ * @param [in]  params     Parameters used to create the handle.
+ * @param [out] mem_list_h Created descriptor list handle.
  *
  * @return Error code as defined by @ref ucs_status_t.
  */
 ucs_status_t
 ucp_device_remote_mem_list_create(const ucp_device_mem_list_params_t *params,
-                                  ucp_device_remote_mem_list_handle_h *handle);
+                                  ucp_device_remote_mem_list_h *mem_list_h);
 
 
 /**
  * @ingroup UCP_DEVICE
  * @brief Return the number of elements in the descriptors mem list handle.
  *
- * @param [in] handle     Descriptors list handle.
+ * @param [in] mem_list_h Descriptors list handle.
  *
  * @return Descriptors mem list length.
  */
-uint32_t
-ucp_device_get_mem_list_length(const void* handle);
+uint32_t ucp_device_get_mem_list_length(const void *mem_list_h);
 
 
 /**
@@ -240,9 +239,9 @@ ucp_device_get_mem_list_length(const void* handle);
  * This function releases the handle that was created using @ref
  * ucp_device_mem_list_create.
  *
- * @param [in] handle     Created handle to release.
+ * @param [in] mem_list_h Created handle to release.
  */
-void ucp_device_mem_list_release(void *handle);
+void ucp_device_mem_list_release(void *mem_list_h);
 
 
 /**

src/ucp/api/ucp_def.h

@@ -876,9 +876,7 @@ typedef struct {
 
 
 typedef struct ucp_device_mem_list_handle *ucp_device_mem_list_handle_h;
-typedef struct ucp_device_local_mem_list_handle
-        *ucp_device_local_mem_list_handle_h;
-typedef struct ucp_device_remote_mem_list_handle
-        *ucp_device_remote_mem_list_handle_h;
+typedef struct ucp_device_local_mem_list *ucp_device_local_mem_list_h;
+typedef struct ucp_device_remote_mem_list *ucp_device_remote_mem_list_h;
 
 #endif

src/ucp/core/ucp_device.c

@@ -590,7 +590,7 @@ static ucs_status_t ucp_device_local_mem_list_create_handle(
     size_t handle_size         = 0;
     const ucp_device_mem_list_elem_t *ucp_element;
     const ucp_worker_iface_t *wiface;
-    ucp_device_local_mem_list_handle_t handle;
+    ucp_device_local_mem_list_t handle;
     uct_device_local_mem_list_elem_t *uct_element;
     size_t i;
     ucs_status_t status;
@@ -600,9 +600,9 @@ static ucs_status_t ucp_device_local_mem_list_create_handle(
                                    UCT_MD_MEM_ACCESS_LOCAL_READ |
                                            UCT_MD_MEM_ACCESS_LOCAL_WRITE,
                                    mem_type, local_sys_dev,
-                                   "ucp_device_remote_mem_list_handle_t", mem);
+                                   "ucp_device_remote_mem_list_t", mem);
     if (status != UCS_OK) {
-        ucs_error("failed to allocate ucp_device_remote_mem_list_handle_t: %s",
+        ucs_error("failed to allocate ucp_device_remote_mem_list_t: %s",
                   ucs_status_string(status));
         return status;
     }
@@ -693,7 +693,7 @@ static ucs_status_t ucp_device_local_mem_list_params_check(
 
 ucs_status_t
 ucp_device_local_mem_list_create(const ucp_device_mem_list_params_t *params,
-                                 ucp_device_local_mem_list_handle_h *handle_p)
+                                 ucp_device_local_mem_list_h *mem_list_h)
 {
     const ucs_memory_type_t export_mem_type = UCS_MEMORY_TYPE_CUDA;
     ucs_status_t status;
@@ -721,7 +721,7 @@ ucp_device_local_mem_list_create(const ucp_device_mem_list_params_t *params,
     if (status != UCS_OK) {
         uct_mem_free(&mem);
     } else {
-        *handle_p = mem.address;
+        *mem_list_h = mem.address;
     }
 
     return status;
@@ -832,7 +832,7 @@ static ucs_status_t ucp_device_remote_mem_list_create_handle(
     size_t handle_size         = 0;
     const ucp_device_mem_list_elem_t *ucp_element;
     ucp_context_h context;
-    ucp_device_remote_mem_list_handle_t handle;
+    ucp_device_remote_mem_list_t handle;
     uct_device_remote_mem_list_elem_t *uct_element;
     ucs_sys_device_t local_sys_dev;
     size_t i;
@@ -854,9 +854,9 @@ static ucs_status_t ucp_device_remote_mem_list_create_handle(
                                    UCT_MD_MEM_ACCESS_LOCAL_READ |
                                            UCT_MD_MEM_ACCESS_LOCAL_WRITE,
                                    mem_type, local_sys_dev,
-                                   "ucp_device_remote_mem_list_handle_t", mem);
+                                   "ucp_device_remote_mem_list_t", mem);
     if (status != UCS_OK) {
-        ucs_error("failed to allocate ucp_device_remote_mem_list_handle_t: %s",
+        ucs_error("failed to allocate ucp_device_remote_mem_list_t: %s",
                   ucs_status_string(status));
         return status;
     }
@@ -952,7 +952,7 @@ static ucs_status_t ucp_device_remote_mem_list_params_check(
 
 ucs_status_t
 ucp_device_remote_mem_list_create(const ucp_device_mem_list_params_t *params,
-                                  ucp_device_remote_mem_list_handle_h *handle_p)
+                                  ucp_device_remote_mem_list_h *mem_list_h)
 {
     const ucs_memory_type_t export_mem_type = UCS_MEMORY_TYPE_CUDA;
     ucs_status_t status;
@@ -982,7 +982,7 @@ ucp_device_remote_mem_list_create(const ucp_device_mem_list_params_t *params,
     if (status != UCS_OK) {
         uct_mem_free(&mem);
     } else {
-        *handle_p = mem.address;
+        *mem_list_h = mem.address;
     }
 
     return status;
@@ -1060,29 +1060,29 @@ ucp_device_mem_list_create(ucp_ep_h ep,
     return status;
 }
 
-uint32_t ucp_device_get_mem_list_length(const void *handle)
+uint32_t ucp_device_get_mem_list_length(const void *mem_list_h)
 {
     khiter_t iter;
     uint32_t length;
 
-    ucs_assert(handle != NULL);
+    ucs_assert(mem_list_h != NULL);
 
     ucs_spin_lock(&ucp_device_handle_hash_lock);
     iter = kh_get(ucp_device_handle_allocs, &ucp_device_handle_hash,
-                  (void*)handle);
+                  (void*)mem_list_h);
     ucs_assertv_always((iter != kh_end(&ucp_device_handle_hash)), "handle=%p",
-                       handle);
+                       mem_list_h);
     length = kh_value(&ucp_device_handle_hash, iter).mem_list_length;
     ucs_spin_unlock(&ucp_device_handle_hash_lock);
 
     return length;
 }
 
-void ucp_device_mem_list_release(void *handle)
+void ucp_device_mem_list_release(void *mem_list_h)
 {
     uct_allocated_memory_t mem;
 
-    mem = ucp_device_mem_handle_hash_remove(handle);
+    mem = ucp_device_mem_handle_hash_remove(mem_list_h);
     uct_mem_free(&mem);
 }
 

test/gtest/ucp/cuda/test_kernels.h

@@ -22,17 +22,17 @@ typedef enum {
 } test_ucp_device_operation_t;
 
 typedef struct {
-    unsigned                            num_channels;
-    unsigned                            num_threads;
-    unsigned                            num_blocks;
-    test_ucp_device_operation_t         operation;
-    ucs_device_level_t                  level;
-    bool                                with_no_delay;
-    bool                                with_request;
-    size_t                              num_iters;
-    ucp_device_mem_list_handle_h        mem_list;
-    ucp_device_local_mem_list_handle_h  local_mem_list;
-    ucp_device_remote_mem_list_handle_h remote_mem_list;
+    unsigned                     num_channels;
+    unsigned                     num_threads;
+    unsigned                     num_blocks;
+    test_ucp_device_operation_t  operation;
+    ucs_device_level_t           level;
+    bool                         with_no_delay;
+    bool                         with_request;
+    size_t                       num_iters;
+    ucp_device_mem_list_handle_h mem_list;
+    ucp_device_local_mem_list_h  local_mem_list;
+    ucp_device_remote_mem_list_h remote_mem_list;
     union {
         struct {
             unsigned   mem_list_index;

test/gtest/ucp/test_ucp_device.cc

@@ -60,18 +60,18 @@ class test_ucp_device : public ucp_test {
 
         ucp_device_mem_list_handle_h handle() const;
 
-        ucp_device_local_mem_list_handle_h local_handle() const;
+        ucp_device_local_mem_list_h local_handle() const;
 
-        ucp_device_remote_mem_list_handle_h remote_handle() const;
+        ucp_device_remote_mem_list_h remote_handle() const;
 
         void dst_pattern_check(unsigned index, uint64_t seed) const;
 
     private:
         std::vector<std::unique_ptr<mapped_buffer>> m_src, m_dst;
-        std::vector<ucs::handle<ucp_rkey_h>>        m_rkeys;
-        ucp_device_mem_list_handle_h                m_mem_list_h;
-        ucp_device_local_mem_list_handle_h          m_local_mem_list_h;
-        ucp_device_remote_mem_list_handle_h         m_remote_mem_list_h;
+        std::vector<ucs::handle<ucp_rkey_h>> m_rkeys;
+        ucp_device_mem_list_handle_h m_mem_list_h;
+        ucp_device_local_mem_list_h m_local_mem_list_h;
+        ucp_device_remote_mem_list_h m_remote_mem_list_h;
     };
 
     size_t counter_size();
@@ -339,14 +339,12 @@ ucp_device_mem_list_handle_h test_ucp_device::mem_list::handle() const
     return m_mem_list_h;
 }
 
-ucp_device_local_mem_list_handle_h
-test_ucp_device::mem_list::local_handle() const
+ucp_device_local_mem_list_h test_ucp_device::mem_list::local_handle() const
 {
     return m_local_mem_list_h;
 }
 
-ucp_device_remote_mem_list_handle_h
-test_ucp_device::mem_list::remote_handle() const
+ucp_device_remote_mem_list_h test_ucp_device::mem_list::remote_handle() const
 {
     return m_remote_mem_list_h;
 }
@@ -485,7 +483,7 @@ UCS_TEST_P(test_ucp_device, create_fail)
 
 UCS_TEST_P(test_ucp_device, create_local_fail)
 {
-    ucp_device_local_mem_list_handle_h handle = nullptr;
+    ucp_device_local_mem_list_h handle = nullptr;
 
     scoped_log_handler wrap_err(wrap_errors_logger);
 
@@ -552,7 +550,7 @@ UCS_TEST_P(test_ucp_device, create_local_fail)
 
 UCS_TEST_P(test_ucp_device, create_remote_fail)
 {
-    ucp_device_remote_mem_list_handle_h handle = nullptr;
+    ucp_device_remote_mem_list_h handle = nullptr;
 
     scoped_log_handler wrap_err(wrap_errors_logger);