Function uct_rkey_ptr

Source
pub unsafe extern "C" fn uct_rkey_ptr(
    component: uct_component_h,
    rkey_ob: *mut uct_rkey_bundle_t,
    remote_addr: u64,
    addr_p: *mut *mut c_void,
) -> ucs_status_t
Expand description

@ingroup UCT_MD

@brief Get a local pointer to remote memory.

This routine returns a local pointer to the remote memory described by the rkey bundle. The MD must support @ref UCT_MD_FLAG_RKEY_PTR flag.

@param [in] component Component on which to obtain the pointer to the remote key. @param [in] rkey_ob A remote key bundle as returned by the @ref uct_rkey_unpack function. @param [in] remote_addr A remote address within the memory area described by the rkey_ob. @param [out] addr_p A pointer that can be used for direct access to the remote memory.

@note The component used to obtain a local pointer to the remote memory must be the same component that was used to pack the remote key. See notes section for @ref uct_rkey_unpack.

@return Error code if the remote memory cannot be accessed directly or the remote address is not valid.