contrib/ofed/librdmacm/man/rdma_reg_read.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_REG_READ" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_reg_read \- register data buffer(s) for remote RDMA read access.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_verbs.h>"
   7 .P
   8 .B "struct ibv_mr *" rdma_reg_read
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "void *" addr ","
  11 .BI "size_t " length ");"
  12 .SH ARGUMENTS
  13 .IP "id" 12
  14 A reference to a communication identifier where the message buffer(s)
  15 will be used.
  16 .IP "addr" 12
  17 The address of the memory buffer(s) to register.
  18 .IP "length" 12
  19 The total length of the memory to register.
  20 .SH "DESCRIPTION"
  21 Registers a memory buffer that will be accessed by a remote RDMA read
  22 operation.  Memory buffers registered using rdma_reg_read may be
  23 targeted in an RDMA read request, allowing the buffer to be
  24 specified on the remote side of an RDMA connection as the remote_addr
  25 of rdma_post_read, or similar call.
  26 .SH "RETURN VALUE"
  27 Returns a reference to the registered memory region on success, or NULL on
  28 error.  If an error occurs, errno will be set to indicate the failure reason.
  29 .SH "NOTES"
  30 rdma_reg_read is used to register a data buffer that will be the
  31 target of an RDMA read operation on a queue pair associated with
  32 an rdma_cm_id.  The memory buffer is registered with the proteection
  33 domain associated with the idenfier.  The start of the data buffer
  34 is specified through the addr parameter, and the total size of the buffer
  35 is given by length.
  36 .P
  37 All data buffers should be registered before being posted as a work request.
  38 Users must deregister all registered memory by calling rdma_dereg_mr.
  39 .SH "SEE ALSO"
  40 rdma_cm(7), rdma_create_id(3), rdma_create_ep(3),
  41 rdma_reg_msgs(3), rdma_reg_write(3),
  42 ibv_reg_mr(3), ibv_dereg_mr(3), rdma_post_read(3)