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_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)
rdma_destroy_id – Release a communication identifier. Synopsis #include <rdma/rdma_cma.h> int rdma_destroy_id (struct rdma_cm_id *id); Arguments id The communication identifier to destroy. Description Destroys the specified rdma_cm_id and cancels any outstanding asynchronous operation. Return Value Returns 0 on success, or -1 on error. If an error occurs, errno will be set to indicate the failure reason….
rdma_destroy_event_channel – Close an event communication channel. Synopsis #include <rdma/rdma_cma.h> void rdma_destroy_event_channel (struct rdma_event_channel *channel); Arguments channel The communication channel to destroy. Description Release all resources associated with an event channel and closes the associated file descriptor. Return Value Returns 0 on success, or -1 on error. If an error occurs, errno will be set…
rdma_destroy_ep – Release a communication identifier. Synopsis #include <rdma/rdma_cma.h> void rdma_destroy_ep (struct rdma_cm_id *id); Arguments id The communication identifier to destroy. Description Destroys the specified rdma_cm_id and all associated resources Notes rdma_destroy_ep will automatically destroy any QP and SRQ associated with the rdma_cm_id. See Also rdma_create_ep(3)
rdma_dereg_mr – deregisters a registered memory region. Synopsis #include <rdma/rdma_verbs.h> struct ibv_mr *rdma_dereg_mr (struct ibv_mr *mr); Arguments mr A reference to a registered memory buffer. Description Deregisters a memory buffer that had been registered for RDMA or message operations. A user should call rdma_dereg_mr for all registered memory associated with an rdma_cm_id before destroying the…
rdma_create_srq – Allocate a shared receive queue. Synopsis #include <rdma/rdma_verbs.h> int rdma_create_srq (struct rdma_cm_id *id, struct ibv_pd *pd, struct ibv_srq_init_attr *attr); Arguments id RDMA identifier. pd Optional protection domain for the SRQ. attr Initial SRQ attributes. Description Allocate a SRQ associated with the specified rdma_cm_id. Return Value Returns 0 on success, or -1 on error….
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…
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…
rdma_create_event_channel – Open a channel used to report communication events. Synopsis #include <rdma/rdma_cma.h> struct rdma_event_channel *rdma_create_event_channel (void); Arguments void no arguments Description Asynchronous events are reported to users through event channels. Return Value Returns a pointer to the created event channel, or NULL if the request fails. On failure, errno will be set to indicate…
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…
rdma_connect – Initiate an active connection request. Synopsis #include <rdma/rdma_cma.h> int rdma_connect (struct rdma_cm_id *id, struct rdma_conn_param *conn_param); Arguments id RDMA identifier. conn_param connection parameters. See CONNECTION PROPERTIES below for details. Description For an rdma_cm_id of type RDMA_PS_TCP, this call initiates a connection request to a remote destination. For an rdma_cm_id of type RDMA_PS_UDP, it…
rdma_bind_addr – Bind an RDMA identifier to a source address. Synopsis #include <rdma/rdma_cma.h> int rdma_bind_addr (struct rdma_cm_id *id, struct sockaddr *addr); Arguments id RDMA identifier. addr Local address information. Wildcard values are permitted. Description Associates a source address with an rdma_cm_id. The address may be wildcarded. If binding to a specific local address, the rdma_cm_id…
rdma_ack_cm_event – Free a communication event. Synopsis #include <rdma/rdma_cma.h> int rdma_ack_cm_event (struct rdma_cm_event *event); Arguments event Event to be released. Description All events which are allocated by rdma_get_cm_event must be released, there should be a one-to-one correspondence between successful gets and acks. This call frees the event structure and any memory that it references. Return…
rdma_accept – Called to accept a connection request. Synopsis #include <rdma/rdma_cma.h> int rdma_accept (struct rdma_cm_id *id, struct rdma_conn_param *conn_param); Arguments id Connection identifier associated with the request. conn_param Information needed to establish the connection. See CONNECTION PROPERTIES below for details. Description Called from the listening side to accept a connection or datagram service lookup request….
rcmd, rresvport, iruserok, ruserok, rcmd_af, rresvport_af, iruserok_af, ruserok_af – routines for returning a stream to a remote command Synopsis #include <netdb.h> /* Or <unistd.h> on some systems */ int rcmd(char **ahost, unsigned short inport, const char *locuser, const char *remuser, const char *cmd, int *fd2p); int rresvport(int *port); int iruserok(uint32_t raddr, int superuser, const char…
rcmd, rresvport, iruserok, ruserok, rcmd_af, rresvport_af, iruserok_af, ruserok_af – routines for returning a stream to a remote command Synopsis #include <netdb.h> /* Or <unistd.h> on some systems */ int rcmd(char **ahost, unsigned short inport, const char *locuser, const char *remuser, const char *cmd, int *fd2p); int rresvport(int *port); int iruserok(uint32_t raddr, int superuser, const char…