1RDMA_REG_READ(3)         Librdmacm Programmer's Manual        RDMA_REG_READ(3)
2
3
4

NAME

6       rdma_reg_read - register data buffer(s) for remote RDMA read access.
7

SYNOPSIS

9       #include <rdma/rdma_verbs.h>
10
11       struct  ibv_mr  *  rdma_reg_read  (struct  rdma_cm_id  *id, void *addr,
12       size_t length);
13

ARGUMENTS

15       id          A reference to a communication identifier where the message
16                   buffer(s) will be used.
17
18       addr        The address of the memory buffer(s) to register.
19
20       length      The total length of the memory to register.
21

DESCRIPTION

23       Registers  a  memory buffer that will be accessed by a remote RDMA read
24       operation.  Memory buffers registered using rdma_reg_read may  be  tar‐
25       geted  in  an RDMA read request, allowing the buffer to be specified on
26       the  remote  side  of  an  RDMA  connection  as  the   remote_addr   of
27       rdma_post_read, or similar call.
28

RETURN VALUE

30       Returns a reference to the registered memory region on success, or NULL
31       on error.  If an error occurs, errno will be set to indicate the  fail‐
32       ure reason.
33

NOTES

35       rdma_reg_read is used to register a data buffer that will be the target
36       of  an  RDMA  read  operation  on  a  queue  pair  associated  with  an
37       rdma_cm_id.   The  memory  buffer  is  registered  with the proteection
38       domain associated with the idenfier.  The start of the data  buffer  is
39       specified  through the addr parameter, and the total size of the buffer
40       is given by length.
41
42       All data buffers should be registered before being  posted  as  a  work
43       request.   Users  must  deregister  all  registered  memory  by calling
44       rdma_dereg_mr.
45

SEE ALSO

47       rdma_cm(7),  rdma_create_id(3),  rdma_create_ep(3),   rdma_reg_msgs(3),
48       rdma_reg_write(3), ibv_reg_mr(3), ibv_dereg_mr(3), rdma_post_read(3)
49
50
51
52librdmacm                         2010-07-19                  RDMA_REG_READ(3)
Impressum