From: Leon Romanovsky <leonro@xxxxxxxxxxxx> Add manual pages for librdmacm part of ECE. Signed-off-by: Leon Romanovsky <leonro@xxxxxxxxxxxx> --- librdmacm/man/CMakeLists.txt | 2 + librdmacm/man/rdma_cm.7 | 14 +++++- librdmacm/man/rdma_get_remote_ece.3.md | 61 +++++++++++++++++++++++++ librdmacm/man/rdma_set_local_ece.3.md | 62 ++++++++++++++++++++++++++ 4 files changed, 138 insertions(+), 1 deletion(-) create mode 100644 librdmacm/man/rdma_get_remote_ece.3.md create mode 100644 librdmacm/man/rdma_set_local_ece.3.md diff --git a/librdmacm/man/CMakeLists.txt b/librdmacm/man/CMakeLists.txt index 2d1efbff..6159c3e3 100644 --- a/librdmacm/man/CMakeLists.txt +++ b/librdmacm/man/CMakeLists.txt @@ -29,6 +29,7 @@ rdma_man_pages( rdma_get_local_addr.3 rdma_get_peer_addr.3 rdma_get_recv_comp.3 + rdma_get_remote_ece.3.md rdma_get_request.3 rdma_get_send_comp.3 rdma_get_src_port.3 @@ -56,6 +57,7 @@ rdma_man_pages( rdma_resolve_addr.3 rdma_resolve_route.3 rdma_server.1 + rdma_set_local_ece.3.md rdma_set_option.3 rdma_xclient.1 rdma_xserver.1 diff --git a/librdmacm/man/rdma_cm.7 b/librdmacm/man/rdma_cm.7 index 8e5ad99e..122c96f0 100644 --- a/librdmacm/man/rdma_cm.7 +++ b/librdmacm/man/rdma_cm.7 @@ -26,6 +26,10 @@ parameter in specific calls. If an event channel is provided, an rdma_cm identi will report its event data (results of connecting, for example), on that channel. If a channel is not provided, then all rdma_cm operations for the selected rdma_cm identifier will block until they complete. +.P +The RDMA CM gives an option to different libibverbs providers to advertise and +use various specific to that provider QP configuration options. This functionality +is called ECE (enhanced connection establishment). .SH "RDMA VERBS" The rdma_cm supports the full range of verbs available through the libibverbs library and interfaces. However, it also provides wrapper functions for some @@ -111,6 +115,8 @@ destroy the QP release the rdma_cm_id .IP rdma_destroy_event_channel release the event channel +.IP rdma_set_local_ece +set desired ECE options .P An almost identical process is used to setup unreliable datagram (UD) communication between nodes. No actual connection is formed between QPs @@ -157,6 +163,10 @@ release the connected rdma_cm_id release the listening rdma_cm_id .IP rdma_destroy_event_channel release the event channel +.IP rdma_get_remote_ece +get ECe options sent by the client +.IP rdma_set_local_ece +set desired ECE options .SH "RETURN CODES" .IP "= 0" success @@ -198,6 +208,7 @@ rdma_get_dst_port(3), rdma_get_local_addr(3), rdma_get_peer_addr(3), rdma_get_recv_comp(3), +rdma_get_remote_ece(3), rdma_get_request(3), rdma_get_send_comp(3), rdma_get_src_port(3), @@ -221,7 +232,8 @@ rdma_reg_write(3), rdma_reject(3), rdma_resolve_addr(3), rdma_resolve_route(3), -rdma_set_option(3) +rdma_get_remote_ece(3), +rdma_set_option(3), mckey(1), rdma_client(1), rdma_server(1), diff --git a/librdmacm/man/rdma_get_remote_ece.3.md b/librdmacm/man/rdma_get_remote_ece.3.md new file mode 100644 index 00000000..1db1f8ee --- /dev/null +++ b/librdmacm/man/rdma_get_remote_ece.3.md @@ -0,0 +1,61 @@ +--- +date: 2020-02-02 +footer: librdmacm +header: "Librdmacm Programmer's Manual" +layout: page +license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' +section: 3 +title: RDMA_GET_REMOTE_ECE +--- + +# NAME + +rdma_get_remote_ece - Get remote ECE paraemters as received from the peer. + +# SYNOPSIS + +```c +#include <rdma/rdma_cma.h> + +int rdma_get_remote_ece(struct rdma_cm_id *id, struct ibv_ece *ece); +``` +# DESCRIPTION + +**rdma_get_remote_ece()** get ECE parameters as were received from the communication peer. + +This function is suppose to be used by the users of external QPs. The call needs +to be performed before replying to the peer and needed to allow for the passive +side to know ECE options of other side. + +Being used by external QP and RDMA_CM doesn't manage that QP, the peer needs +to call to libibverbs API by itself. + +Usual flow for the passive side will be: + + * ibv_create_qp() <- create data QP. + * ece = rdma_get_remote_ece() <- get ECE options from remote peer + * ibv_set_ece(ece) <- set local ECE options with data received from the peer. + * ibv_modify_qp() <- enable data QP. + * rdma_set_local_ece(ece) <- set desired ECE options after respective + libibverbs provider masked unsupported options. + * rdma_accept()/rdma_establish()/rdma_reject_ece() + +# ARGUMENTS + +*id +: RDMA communication identifier. + +*ece +: ECE struct to be filled. + +# RETURN VALUE + +**rdma_get_remote_ece()** returns 0 on success, or -1 on error. If an error occurs, errno will be set to indicate the failure reason. + +# SEE ALSO + +**rdma_cm**(7), rdma_set_local_ece(3) + +# AUTHOR + +Leon Romanovsky <leonro@xxxxxxxxxxxx> diff --git a/librdmacm/man/rdma_set_local_ece.3.md b/librdmacm/man/rdma_set_local_ece.3.md new file mode 100644 index 00000000..253e60df --- /dev/null +++ b/librdmacm/man/rdma_set_local_ece.3.md @@ -0,0 +1,62 @@ +--- +date: 2020-02-02 +footer: librdmacm +header: "Librdmacm Programmer's Manual" +layout: page +license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' +section: 3 +title: RDMA_SET_LOCAL_ECE +--- + +# NAME + +rdma_set_local_ece - Set local ECE paraemters to be used for REQ/REP communication. + +# SYNOPSIS + +```c +#include <rdma/rdma_cma.h> + +int rdma_set_local_ece(struct rdma_cm_id *id, struct ibv_ece *ece); +``` +# DESCRIPTION + +**rdma_set_local_ece()** set local ECE parameters. + +This function is suppose to be used by the users of external QPs. The call needs +to be performed before replying to the peer and needed to configure RDMA_CM with +desired ECE options. + +Being used by external QP and RDMA_CM doesn't manage that QP, the peer needs +to call to libibverbs API by itself. + +Usual flow for the passive side will be: + + * ibv_create_qp() <- create data QP. + * ece = ibv_get_ece() <- get ECE from libibvers provider. + * rdma_set_local_ece(ece) <- set desired ECE options. + * rdma_connect() <- send connection request + * ece = rdma_get_remote_ece() <- get ECE options from remote peer + * ibv_set_ece(ece) <- set local ECE options with data received from the peer. + * ibv_modify_qp() <- enable data QP. + * rdma_accept()/rdma_establish()/rdma_reject_ece() + +# ARGUMENTS + +*id* +: RDMA communication identifier. + +*ece +: ECE parameters. + +# RETURN VALUE + +**rdma_set_local_ece()** returns 0 on success, or -1 on error. If an error occurs, errno will be set to indicate the failure reason. + +# SEE ALSO + +**rdma_cm**(7), rdma_get_remote_ece(3) + +# AUTHOR + +Leon Romanovsky <leonro@xxxxxxxxxxxx> -- 2.24.1
