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) [debian 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_RESOLVE_ADDR(3)					   Librdmacm Programmer's Manual				      RDMA_RESOLVE_ADDR(3)

NAME

       rdma_resolve_addr - Resolve destination and optional source addresses.

SYNOPSIS

       #include <rdma/rdma_cma.h>

       int rdma_resolve_addr (struct rdma_cm_id *id, struct sockaddr *src_addr, struct sockaddr *dst_addr, int timeout_ms);

ARGUMENTS

       id	   RDMA identifier.

       src_addr    Source address information.	This parameter may be NULL.

       dst_addr    Destination address information.

       timeout_ms  Time to wait for resolution to complete.

DESCRIPTION

       Resolve	destination  and  optional source addresses from IP addresses to an RDMA address.  If successful, the specified rdma_cm_id will be
       bound to a local device.

RETURN VALUE

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

NOTES

       This call is used to map a given destination IP address to a usable RDMA address.  The IP to RDMA address mapping is done using	the  local
       routing	tables,  or  via  ARP.	 If a source address is given, the rdma_cm_id is bound to that address, the same as if rdma_bind_addr were
       called.	If no source address is given, and the rdma_cm_id has not yet been bound to a device, then the	rdma_cm_id  will  be  bound  to  a
       source address based on the local routing tables.  After this call, the rdma_cm_id will be bound to an RDMA device.  This call is typically
       made from the active side of a connection before calling rdma_resolve_route and rdma_connect.

INFINIBAND SPECIFIC

       This call maps the destination and, if given, source IP addresses to GIDs.  In order to perform the mapping, IPoIB must be running on  both
       the local and remote nodes.

SEE ALSO

       rdma_create_id(3),      rdma_resolve_route(3),	  rdma_connect(3),     rdma_create_qp(3),     rdma_get_cm_event(3),	rdma_bind_addr(3),
       rdma_get_src_port(3), rdma_get_dst_port(3), rdma_get_local_addr(3), rdma_get_peer_addr(3)

librdmacm							    2007-10-31						      RDMA_RESOLVE_ADDR(3)
Man Page