1RDMA_REG_MSGS(3) Librdmacm Programmer's Manual RDMA_REG_MSGS(3)
2
6 rdma_reg_msgs - register data buffer(s) for sending or receiving mes‐
7 sages.
8
10 #include <rdma/rdma_verbs.h>
11 struct ibv_mr * rdma_reg_msgs (struct rdma_cm_id *id, void *addr,
13 size_t length);
14
16 id A reference to a communication identifier where the message
17 buffer(s) will be used.
18 addr The address of the memory buffer(s) to register.
20 length The total length of the memory to register.
22
24 Registers an array of memory buffers used for sending and receiving
25 messages or for RDMA operations. Memory buffers registered using
26 rdma_reg_msgs may be posted to an rdma_cm_id using rdma_post_send or
27 rdma_post_recv, or specified as the target of an RDMA read operation or
28 the source of an RDMA write reqeust.
29
31 Returns a reference to the registered memory region on success, or NULL
32 on error. If an error occurs, errno will be set to indicate the fail‐
33 ure reason.
34
36 rdma_reg_msgs is used to register an array of data buffers that will be
37 used send and/or receive messages on a queue pair associated with an
38 rdma_cm_id. The memory buffer is registered with the proteection
39 domain associated with the idenfier. The start of the data buffer
40 array is specified through the addr parameter, and the total size of
41 the array is given by length.
42 All data buffers should be registered before being posted as a work
44 request. Users must deregister all registered memory by calling
45 rdma_dereg_mr.
46
48 rdma_cm(7), rdma_create_id(3), rdma_create_ep(3), rdma_reg_read(3),
49 rdma_reg_write(3), ibv_reg_mr(3), ibv_dereg_mr(3), rdma_post_send(3),
50 rdma_post_recv(3), rdma_post_read(3), rdma_post_readv(3),
51 rdma_post_write(3), rdma_post_writev(3)
52librdmacm 2010-07-19 RDMA_REG_MSGS(3)