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)

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_CREATE_QP(3)					   Librdmacm Programmer's Manual					 RDMA_CREATE_QP(3)

rdma_create_qp - Allocate a QP. SYNOPSIS
#include <rdma/rdma_cma.h> int rdma_create_qp (struct rdma_cm_id *id, struct ibv_pd *pd, struct ibv_qp_init_attr *qp_init_attr); ARGUMENTS
id RDMA identifier. pd Optional protection domain for the QP. qp_init_attr Initial QP attributes. DESCRIPTION
Allocate a QP associated with the specified rdma_cm_id and transition it for sending and receiving. 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 rdma_cm_id must be bound to a local RDMA device before calling this function, and the protection domain must be for that same device. QPs allocated to an rdma_cm_id are automatically transitioned by the librdmacm through their states. After being allocated, the QP will be ready to handle posting of receives. If the QP is unconnected, it will be ready to post sends. If a protection domain is not given - pd parameter is NULL - then the rdma_cm_id will be created using a default protection domain. One default protection domain is allocated per RDMA device. The initial QP attributes are specified by the qp_init_attr parameter. The send_cq and recv_cq fields in the ibv_qp_init_attr are optional. If a send or receive completion queue is not specified, then a CQ will be allocated by the rdma_cm for the QP, along with corre- sponding completion channels. Completion channels and CQ data created by the rdma_cm are exposed to the user through the rdma_cm_id struc- ture. The actual capabilities and properties of the created QP will be returned to the user through the qp_init_attr parameter. An rdma_cm_id may only be associated with a single QP. SEE ALSO
rdma_bind_addr(3), rdma_resolve_addr(3), rdma_destroy_qp(3), ibv_create_qp(3), ibv_modify_qp(3) librdmacm 2007-05-15 RDMA_CREATE_QP(3)
Man Page