Section 3: library functions
rdma_notify – Notifies the librdmacm of an asynchronous event. Synopsis #include <rdma/rdma_cma.h> int rdma_notify (struct rdma_cm_id *id, enum ibv_event_type event); Arguments id RDMA identifier. event Asynchronous event. Description Used to notify the librdmacm of asynchronous events that have occurred on a QP associated with the rdma_cm_id. Return Value Returns 0 on success, or -1 on…
rdma_migrate_id – Move a communication identifer to a different event channel. Synopsis #include <rdma/rdma_cma.h> int rdma_migrate_id (struct rdma_cm_id *id, struct rdma_event_channel *channel); Arguments id An existing communication identifier to migrate. channel The communication channel that events associated with the allocated rdma_cm_id will be reported on. May be NULL. Description Migrates a communication identifier to a…
rdma_listen – Listen for incoming connection requests. Synopsis #include <rdma/rdma_cma.h> int rdma_listen (struct rdma_cm_id *id, int backlog); Arguments id RDMA identifier. backlog backlog of incoming connection requests. Description Initiates a listen for incoming connection requests or datagram service lookup. The listen will be restricted to the locally bound source address. Return Value Returns 0 on…
rdma_leave_multicast – Leaves a multicast group. Synopsis #include <rdma/rdma_cma.h> int rdma_leave_multicast (struct rdma_cm_id *id, struct sockaddr *addr); Arguments id Communication identifier associated with the request. addr Multicast address identifying the group to leave. Description Leaves a multicast group and detaches an associated QP from the group. Return Value Returns 0 on success, or -1 on…
rdma_join_multicast – Joins a multicast group. Synopsis #include <rdma/rdma_cma.h> int rdma_join_multicast (struct rdma_cm_id *id, struct sockaddr *addr, void *context); Arguments id Communication identifier associated with the request. addr Multicast address identifying the group to join. context User-defined context associated with the join request. Description Joins a multicast group and attaches an associated QP to the…
rdma_getaddrinfo – Provides transport independent address translation. Synopsis #include <rdma/rdma_cma.h> int rdma_getaddrinfo (char *node, char *service, struct rdma_addrinfo *hints, struct rdma_addrinfo **res); Arguments node Optional, name, dotted-decimal IPv4, or IPv6 hex address to resolve. service Service name or port number of address. hints Reference to an rdma_addrinfo structure containing hints about the type of service…
rdma_get_src_port – Returns the local port number of a bound rdma_cm_id. Synopsis #include <rdma/rdma_cma.h> uint16_t rdma_get_src_port (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Returns the local port number for an rdma_cm_id that has been bound to a local address. Return Value Returns the 16-bit port identifier associated with the local endpoint. If the rdma_cm_id…
rdma_get_send_comp – retrieves a completed send, read, or write request. Synopsis #include <rdma/rdma_verbs.h> int rdma_get_send_comp (struct rdma_cm_id *id, struct ibv_wc *wc); Arguments id A reference to a communication identifier to check for completions. wc A reference to a work completion structure to fill in. Description Retrieves a completed work request for a send, RDMA read,…
rdma_get_request – Retrieves the next pending connection request event. Synopsis #include <rdma/rdma_cma.h> int rdma_get_request (struct rdma_cm_id *listen, struct rdma_cm_id **id); Arguments listen Listening rdma_cm_id. id rdma_cm_id associated with the new connection. Description Retrieves a connection request event. If no requests are pending, the call will block until an event is received. Return Value Returns 0…
rdma_get_recv_comp – retrieves a completed receive request. Synopsis #include <rdma/rdma_verbs.h> int rdma_get_recv_comp (struct rdma_cm_id *id, struct ibv_wc *wc); Arguments id A reference to a communication identifier to check for completions. wc A reference to a work completion structure to fill in. Description Retrieves a completed work request for a receive operation. Information about the completed…
rdma_get_peer_addr – Returns the remote IP address of a bound rdma_cm_id. Synopsis #include <rdma/rdma_cma.h> struct sockaddr *rdma_get_peer_addr (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Returns the remote IP address associated with an rdma_cm_id. Return Value Returns a pointer to the sockaddr address of the connected peer. If the rdma_cm_id is not connected, the contents…
rdma_get_local_addr – Returns the local IP address of a bound rdma_cm_id. Synopsis #include <rdma/rdma_cma.h> struct sockaddr *rdma_get_local_addr (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Returns the local IP address for an rdma_cm_id that has been bound to a local device. Return Value Returns a pointer to the local sockaddr address of the rdma_cm_id. If…
rdma_get_dst_port – Returns the remote port number of a bound rdma_cm_id. Synopsis #include <rdma/rdma_cma.h> uint16_t rdma_get_dst_port (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Returns the remote port number for an rdma_cm_id that has been bound to a remote address. Return Value Returns the 16-bit port identifier associated with the peer endpoint. If the rdma_cm_id…
rdma_get_devices – Get a list of RDMA devices currently available. Synopsis #include <rdma/rdma_cma.h> struct ibv_context **rdma_get_devices (int *num_devices); Arguments num_devices If non-NULL, set to the number of devices returned. Description Return a NULL-terminated array of opened RDMA devices. Callers can use this routine to allocate resources on specific RDMA devices that will be shared across…
rdma_get_cm_event – Retrieves the next pending communication event. Synopsis #include <rdma/rdma_cma.h> int rdma_get_cm_event (struct rdma_event_channel *channel, struct rdma_cm_event **event); Arguments channel Event channel to check for events. event Allocated information about the next communication event. Description Retrieves a communication event. If no events are pending, by default, the call will block until an event is…
rdma_free_devices – Frees the list of devices returned by rdma_get_devices. Synopsis #include <rdma/rdma_cma.h> void rdma_free_devices (struct ibv_context **list); Arguments list List of devices returned from rdma_get_devices. Description Frees the device array returned by rdma_get_devices. Return Value None See Also rdma_get_devices(3)
rdma_event_str – Returns a string representation of an rdma cm event. Synopsis #include <rdma/rdma_cma.h> char *rdma_event_str (enumrdma_cm_event_type event); Arguments event Asynchronous event. Description Returns a string representation of an asynchronous event. Return Value Returns a pointer to a static character string corresponding to the event. See Also rdma_get_cm_event(3)
rdma_disconnect – This function disconnects a connection. Synopsis #include <rdma/rdma_cma.h> int rdma_disconnect (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Disconnects a connection and transitions any associated QP to the error state, which will flush any posted work requests to the completion queue. This routine should be called by both the client and server side…
rdma_destroy_srq – Deallocate a SRQ. Synopsis #include <rdma/rdma_verbs.h> void rdma_destroy_srq (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Destroy an SRQ allocated on the rdma_cm_id. Return Value Returns 0 on success, or -1 on error. If an error occurs, errno will be set to indicate the failure reason. Notes Users should destroy any SRQ associated…
rdma_destroy_qp – Deallocate a QP. Synopsis #include <rdma/rdma_cma.h> void rdma_destroy_qp (struct rdma_cm_id *id); Arguments id RDMA identifier. Description Destroy a QP allocated on the rdma_cm_id. Notes Users must destroy any QP associated with an rdma_cm_id before destroying the ID. See Also rdma_create_qp(3), rdma_destroy_id(3), ibv_destroy_qp(3)