Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

rdma_create_ep(3) [centos man page]

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

NAME

       rdma_create_ep - Allocate a communication identifier and optional QP.

SYNOPSIS

       #include <rdma/rdma_cma.h>

       int rdma_create_ep (struct rdma_cm_id **id, struct rdma_addrinfo *res, struct ibv_pd  *pd, struct ibv_qp_init_attr *qp_init_attr);

ARGUMENTS

       id	   A reference where the allocated communication identifier will be returned.

       res	   Address information associated with the rdma_cm_id returned from rdma_getaddrinfo.

       pd	   Optional protection domain if a QP is associated with the rdma_cm_id.

       qp_init_attr
		   Optional initial QP attributes.

DESCRIPTION

       Creates an identifier that is used to track communication information.

RETURN VALUE

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

NOTES

       After resolving address information using rdma_getaddrinfo, a user may use this call to allocate an rdma_cm_id based on the results.

       If  the rdma_cm_id will be used on the active side of a connection, meaning that res->ai_flag does not have RAI_PASSIVE set, rdma_create_ep
       will automatically create a QP on the rdma_cm_id if qp_init_attr is not NULL.  The QP will be  associated  with	the  specified	protection
       domain,	if  provided,  or  a  default  protection  domain  if  not.   Users should see rdma_create_qp for details on the use of the pd and
       qp_init_attr parameters.  After calling rdma_create_ep, the returned rdma_cm_id may be connected by calling rdma_connect.  The active  side
       calls rdma_resolve_addr and rdma_resolve_route are not necessary.

       If  the	rdma_cm_id will be used on the passive side of a connection, indicated by having res->ai_flag RAI_PASSIVE set, this call will save
       the provided pd and qp_init_attr parameters.  When a new connection request is retrieved by calling rdma_get_request, the rdma_cm_id  asso-
       ciated  with  the  new  connection  will  automatically	be  associated	with a QP using the pd and qp_init_attr parameters.  After calling
       rdma_create_ep, the returned rdma_cm_id may be placed into a listening state by immediately calling rdma_listen.   The  passive	side  call
       rdma_bind_addr is not necessary.  Connection requests may then be retrieved by calling rdma_get_request.

       The  newly created rdma_cm_id will be set to use synchronous operation.	Users that wish asynchronous operation must migrate the rdma_cm_id
       to a user created event channel using rdma_migrate_id.

       Users must release the created rdma_cm_id by calling rdma_destroy_ep.

SEE ALSO

       rdma_cm(7), rdma_getaddrinfo(3), rdma_create_event_channel(3), rdma_connect(3), rdma_listen(3), rdma_destroy_ep(3), rdma_migrate_id(3)

librdmacm							    2010-07-19							 RDMA_CREATE_EP(3)

Check Out this Related Man Page

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

NAME

       rdma_post_recv - post a work request to receive an incoming message.

SYNOPSIS

       #include <rdma/rdma_verbs.h>

       int rdma_post_recv (struct rdma_cm_id *id, void *context, void *addr, size_t length, struct ibv_mr *mr);

ARGUMENTS

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

       context	   User-defined context associated with the request.

       addr	   The address of the memory buffer to post.

       length	   The length of the memory buffer.

       mr	   A registered memory region associated with the posted buffer.

DESCRIPTION

       Posts a work request to the receive queue of the queue pair associated with the rdma_cm_id.  The posted buffer will be queued to receive an
       incoming message sent by the remote peer.

RETURN VALUE

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

NOTES

       The user is responsible for ensuring that a receive buffer is posted and large enough to contain all sent data before the  peer	posts  the
       corresponding send message.  The message buffer must have been registered before being posted, with the mr parameter referencing the regis-
       tration.  The buffer must remain registered until the receive completes.

       Messages may be posted to an rdma_cm_id only after a queue pair has been associated with it.  A queue pair is bound to an rdma_cm_id  after
       calling rdma_create_ep or rdma_create_qp, if the rdma_cm_id is allocated using rdma_create_id.

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

SEE ALSO

       rdma_cm(7), rdma_create_id(3), rdma_create_ep(3), rdma_create_qp(3), rdma_reg_read(3), ibv_reg_mr(3), ibv_dereg_mr(3),  rdma_post_recvv(3),
       rdma_post_send(3)

librdmacm							    2010-07-19							 RDMA_POST_RECV(3)
Man Page