rdma_reg_read(3) [debian man page]

RDMA_REG_READ(3)					   Librdmacm Programmer's Manual					  RDMA_REG_READ(3)

NAME

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

SYNOPSIS

       #include <rdma/rdma_verbs.h>

       struct ibv_mr * rdma_reg_read (struct rdma_cm_id *id, void *addr, size_t length);

ARGUMENTS

       id	   A reference to a communication identifier where the message buffer(s) will be used.

       addr	   The address of the memory buffer(s) to register.

       length	   The total length of the memory to register.

DESCRIPTION

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

RETURN VALUE

       Returns	a  reference  to the registered memory region on success, or NULL on error.  If an error occurs, errno will be set to indicate the
       failure reason.

NOTES

       rdma_reg_read is used to register a data buffer that will be the target of an RDMA read operation  on  a  queue	pair  associated  with	an
       rdma_cm_id.   The  memory  buffer  is registered with the proteection domain associated with the idenfier.  The start of the data buffer is
       specified through the addr parameter, and the total size of the buffer is given by length.

       All data buffers should be registered before being posted as a work request.  Users  must  deregister  all  registered  memory  by  calling
       rdma_dereg_mr.

SEE ALSO

       rdma_cm(7), rdma_create_id(3), rdma_create_ep(3), rdma_reg_msgs(3), rdma_reg_write(3), ibv_reg_mr(3), ibv_dereg_mr(3), rdma_post_read(3)

librdmacm							    2010-07-19							  RDMA_REG_READ(3)

RDMA_POST_WRITE(3)					   Librdmacm Programmer's Manual					RDMA_POST_WRITE(3)

NAME

       rdma_post_write - post an RDMA write work request.

SYNOPSIS

       #include <rdma/rdma_verbs.h>

       int  rdma_post_write  (struct rdma_cm_id *id, void *context, void *addr, size_t length, struct ibv_mr *mr, int flags, uint64_t remote_addr,
       uint32_t rkey);

ARGUMENTS

       id	   A reference to a communication identifier where the request will be posted.

       context	   User-defined context associated with the request.

       addr	   The local address of the source of the write request.

       length	   The length of the write operation.

       mr	   Optional memory region associated with the local buffer.

       flags	   Optional flags used to control the write operation.

       remote_addr The address of the remote registered memory to write into.

       rkey	   The registered memory key associated with the remote address.

DESCRIPTION

       Posts a work request to the send queue of the queue pair associated with the rdma_cm_id.  The contents of the local  data  buffer  will	be
       writen into the remote memory region.

RETURN VALUE

       Returns 0 on success, or -1 on error.  If an error occurs, errno will be set to indicate the failure reason.

NOTES

       For  a list of supported flags, see ibv_post_send.  Unless inline data is specified, the local data buffer must have been registered before
       the write is issued, and the buffer must remain registered until the write completes.  The remote buffer must always be registered.

       Write operations may not be posted to an rdma_cm_id or the corresponding queue pair until it has been connected.

       The user-defined context associated with the write request will be returned to the user through the work  completion  wr_id,  work  request
       identifier, field.

SEE ALSO

       rdma_cm(7), rdma_connect(3), rdma_accept(3), ibv_post_send(3), rdma_post_writev(3), rdma_reg_write(3), rdma_reg_msgs(3)

librdmacm							    2010-07-19							RDMA_POST_WRITE(3)