The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
rdma_post_send – post a work request to send a message. Synopsis #include <rdma/rdma_verbs.h> int rdma_post_send (struct rdma_cm_id *id, void *context, void *addr, size_t length, struct ibv_mr *mr, int flags); 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…
rdma_post_recvv – post a work request to receive incoming messages. Synopsis #include <rdma/rdma_verbs.h> int rdma_post_recvv (struct rdma_cm_id *id, void *context, struct ibv_sge *sgl, int nsge); Arguments id A reference to a communication identifier where the message buffer(s) will be posted. context User-defined context associated with the request. sgl A scatter-gather list of memory buffers posted…
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…
rdma_post_readv – post an RDMA read work request. Synopsis #include <rdma/rdma_verbs.h> int rdma_post_readv (struct rdma_cm_id *id, void *context, struct ibv_sge *sgl, int nsge, int flags, uint64_t remote_addr, uint32_t rkey); Arguments id A reference to a communication identifier where the request will be posted. context User-defined context associated with the request. sgl A scatter-gather list of…
rdma_post_read – post an RDMA read work request. Synopsis #include <rdma/rdma_verbs.h> int rdma_post_read (struct rdma_cm_id *id, void *context, void *addr, size_t length, struct ibv_mr *mr, int flags, uint64_t remote_addr, uint32_t rkey); Arguments id A reference to a communication identifier where the request will be posted. context User-defined context associated with the request. addr The address…
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…