Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

rdma_create_id(3) [debian man page]

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

rdma_create_id - Allocate a communication identifier. SYNOPSIS
#include <rdma/rdma_cma.h> int rdma_create_id (struct rdma_event_channel *channel, struct rdma_cm_id **id, void *context, enum rdma_port_space ps); ARGUMENTS
channel The communication channel that events associated with the allocated rdma_cm_id will be reported on. This may be NULL. id A reference where the allocated communication identifier will be returned. context User specified context associated with the rdma_cm_id. ps RDMA port space. 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
Rdma_cm_id's are conceptually equivalent to a socket for RDMA communication. The difference is that RDMA communication requires explicitly binding to a specified RDMA device before communication can occur, and most operations are asynchronous in nature. Asynchronous communica- tion events on an rdma_cm_id are reported through the associated event channel. If the channel parameter is NULL, the rdma_cm_id will be placed into synchronous operation. While operating synchronously, calls that result in an event will block until the operation completes. The event will be returned to the user through the rdma_cm_id structure, and be available for access until another rdma_cm call is made. Users must release the rdma_cm_id by calling rdma_destroy_id. PORT SPACE
Details of the services provided by the different port spaces are outlined below. RDMA_PS_TCP Provides reliable, connection-oriented QP communication. Unlike TCP, the RDMA port space provides message, not stream, based commu- nication. RDMA_PS_UDP Provides unreliable, connectionless QP communication. Supports both datagram and multicast communication. SEE ALSO
rdma_cm(7), rdma_create_event_channel(3), rdma_destroy_id(3), rdma_get_devices(3), rdma_bind_addr(3), rdma_resolve_addr(3), rdma_con- nect(3), rdma_listen(3), rdma_set_option(3) librdmacm 2010-07-19 RDMA_CREATE_ID(3)

Check Out this Related Man Page

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

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

Featured Tech Videos