From 0f7cc83b5e4449afa4115b2a402c3ae58fcd099e Mon Sep 17 00:00:00 2001 From: OFIWG Bot Date: Thu, 17 Oct 2024 18:01:35 +0000 Subject: [PATCH] Updated nroff-generated man pages Signed-off-by: OFIWG Bot --- fabtests/man/man7/fabtests.7 | 28 +++-------- man/man1/fi_info.1 | 28 +++-------- man/man1/fi_pingpong.1 | 48 +++++++----------- man/man1/fi_strerror.1 | 26 +++------- man/man3/fi_atomic.3 | 30 +++-------- man/man3/fi_av.3 | 74 +++++++++++---------------- man/man3/fi_av_set.3 | 24 ++------- man/man3/fi_cm.3 | 24 ++------- man/man3/fi_cntr.3 | 28 +++-------- man/man3/fi_collective.3 | 38 +++++--------- man/man3/fi_control.3 | 22 ++------- man/man3/fi_cq.3 | 44 ++++++----------- man/man3/fi_domain.3 | 48 +++++++----------- man/man3/fi_endpoint.3 | 78 ++++++++++++----------------- man/man3/fi_eq.3 | 34 ++++--------- man/man3/fi_errno.3 | 20 ++------ man/man3/fi_fabric.3 | 32 ++++-------- man/man3/fi_getinfo.3 | 52 +++++++------------ man/man3/fi_mr.3 | 36 +++++--------- man/man3/fi_msg.3 | 32 ++++-------- man/man3/fi_nic.3 | 28 +++-------- man/man3/fi_peer.3 | 30 +++-------- man/man3/fi_poll.3 | 24 ++------- man/man3/fi_profile.3 | 20 ++------ man/man3/fi_provider.3 | 28 +++-------- man/man3/fi_rma.3 | 30 +++-------- man/man3/fi_tagged.3 | 32 ++++-------- man/man3/fi_trigger.3 | 22 ++------- man/man3/fi_version.3 | 20 ++------ man/man7/fabric.7 | 52 +++++++------------ man/man7/fi_arch.7 | 18 +------ man/man7/fi_cxi.7 | 96 +++++++++++++++++------------------- man/man7/fi_direct.7 | 22 ++------- man/man7/fi_efa.7 | 50 +++++++------------ man/man7/fi_guide.7 | 24 ++------- man/man7/fi_hook.7 | 20 ++------ man/man7/fi_intro.7 | 28 +++-------- man/man7/fi_lpp.7 | 20 ++------ man/man7/fi_mrail.7 | 30 +++-------- man/man7/fi_opx.7 | 78 ++++++++++++----------------- man/man7/fi_provider.7 | 50 +++++++------------ man/man7/fi_psm2.7 | 28 +++-------- man/man7/fi_psm3.7 | 30 +++-------- man/man7/fi_rxd.7 | 20 ++------ man/man7/fi_rxm.7 | 22 ++------- man/man7/fi_setup.7 | 23 ++------- man/man7/fi_shm.7 | 22 ++------- man/man7/fi_sockets.7 | 20 ++------ man/man7/fi_tcp.7 | 20 ++------ man/man7/fi_ucx.7 | 20 ++------ man/man7/fi_udp.7 | 20 ++------ man/man7/fi_usnic.7 | 72 +++++++++++---------------- man/man7/fi_verbs.7 | 22 ++------- 53 files changed, 525 insertions(+), 1262 deletions(-) diff --git a/fabtests/man/man7/fabtests.7 b/fabtests/man/man7/fabtests.7 index ec2d2c07aae..567ef27e978 100644 --- a/fabtests/man/man7/fabtests.7 +++ b/fabtests/man/man7/fabtests.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fabtests" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fabtests" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -282,7 +268,7 @@ FI_ENORX) can be read by the application, if RNR happens. \f[I]fi_efa_rnr_queue_resend\f[R] This test modifies the RNR retry count (rnr_retry) to 0 via fi_setopt, and then tests RNR queue/re-send logic for different packet types. -To run the test, one needs to use \f[V]-c\f[R] option to specify the +To run the test, one needs to use \f[C]-c\f[R] option to specify the category of packet types. .SS Component tests .PP @@ -462,9 +448,9 @@ The default endpoint type is rdm. Allocate data buffers on the specified device, rather than in host memory. Valid options are ze, cuda and synapseai. -.TP *-a -The name of a shared address vector. +.IP \[bu] 2 +: The name of a shared address vector. This option only applies to tests that support shared address vectors. .TP \f[I]-B \f[R] @@ -476,9 +462,9 @@ endpoints to the server. .TP \f[I]-P \f[R] Specifies the port number of the peer endpoint, overriding the default. -.TP *-s -Specifies the address of the local endpoint. +.IP \[bu] 2 +: Specifies the address of the local endpoint. .TP *-F Specifies the address format. diff --git a/man/man1/fi_info.1 b/man/man1/fi_info.1 index ac741a93b27..b0d5f5aa8c9 100644 --- a/man/man1/fi_info.1 +++ b/man/man1/fi_info.1 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_info" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_info" "1" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -70,7 +56,7 @@ For more information on address formats, see fi_getinfo(3). .TP \f[I]-p, \[en]provider=\f[R] Filter fabric interfaces by the provider implementation. -For a list of providers, see the \f[V]--list\f[R] option. +For a list of providers, see the \f[C]--list\f[R] option. .TP \f[I]-d, \[en]domain=\f[R] Filter interfaces to only those with the given domain name. @@ -144,7 +130,7 @@ provider: tcp \f[R] .fi .PP -To see the full fi_info structure, specify the \f[V]-v\f[R] option. +To see the full fi_info structure, specify the \f[C]-v\f[R] option. .IP .nf \f[C] @@ -237,7 +223,7 @@ fi_info: \f[R] .fi .PP -To see libfabric related environment variables \f[V]-e\f[R] option. +To see libfabric related environment variables \f[C]-e\f[R] option. .IP .nf \f[C] @@ -257,7 +243,7 @@ $ ./fi_info -e .fi .PP To see libfabric related environment variables with substring use -\f[V]-g\f[R] option. +\f[C]-g\f[R] option. .IP .nf \f[C] @@ -295,6 +281,6 @@ $ ./fi_info -g tcp .fi .SH SEE ALSO .PP -\f[V]fi_getinfo(3)\f[R], \f[V]fi_endpoint(3)\f[R] +\f[C]fi_getinfo(3)\f[R], \f[C]fi_endpoint(3)\f[R] .SH AUTHORS OpenFabrics. diff --git a/man/man1/fi_pingpong.1 b/man/man1/fi_pingpong.1 index 419269ebf71..671ec872133 100644 --- a/man/man1/fi_pingpong.1 +++ b/man/man1/fi_pingpong.1 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_pingpong" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_pingpong" "1" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -35,7 +21,7 @@ fi_pingpong also displays aggregated statistics after each test run, and can additionally verify data integrity upon receipt. .PP By default, the datagram (FI_EP_DGRAM) endpoint is used for the test, -unless otherwise specified via \f[V]-e\f[R]. +unless otherwise specified via \f[C]-e\f[R]. .SH HOW TO RUN TESTS .PP Two copies of the program must be launched: first, one copy must be @@ -61,15 +47,15 @@ client$ fi_pingpong .PP The server and client must be able to communicate properly for the fi_pingpong utility to function. -If any of the \f[V]-e\f[R], \f[V]-I\f[R], \f[V]-S\f[R], or \f[V]-p\f[R] +If any of the \f[C]-e\f[R], \f[C]-I\f[R], \f[C]-S\f[R], or \f[C]-p\f[R] options are used, then they must be specified on the invocation for both the server and the client process. -If the \f[V]-d\f[R] option is specified on the server, then the client +If the \f[C]-d\f[R] option is specified on the server, then the client will select the appropriate domain if no hint is provided on the client side. -If the \f[V]-d\f[R] option is specified on the client, then it must also +If the \f[C]-d\f[R] option is specified on the client, then it must also be specified on the server. -If both the server and client specify the \f[V]-d\f[R] option and the +If both the server and client specify the \f[C]-d\f[R] option and the given domains cannot communicate, then the application will fail. .SS Control Messaging .TP @@ -124,19 +110,19 @@ Activate output debugging (warning: highly verbose) Displays help output for the pingpong test. .SH USAGE EXAMPLES .SS A simple example -.SS Server: \f[V]fi_pingpong -p \f[R] +.SS Server: \f[C]fi_pingpong -p \f[R] .PP -\f[V]server$ fi_pingpong -p sockets\f[R] -.SS Client: \f[V]fi_pingpong -p \f[R] +\f[C]server$ fi_pingpong -p sockets\f[R] +.SS Client: \f[C]fi_pingpong -p \f[R] .PP -\f[V]client$ fi_pingpong -p sockets 192.168.0.123\f[R] +\f[C]client$ fi_pingpong -p sockets 192.168.0.123\f[R] .SS An example with various options .SS Server: .PP -\f[V]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R] +\f[C]server$ fi_pingpong -p usnic -I 1000 -S 1024\f[R] .SS Client: .PP -\f[V]client$ fi_pingpong -p usnic -I 1000 -S 1024 192.168.0.123\f[R] +\f[C]client$ fi_pingpong -p usnic -I 1000 -S 1024 192.168.0.123\f[R] .PP Specifically, this will run a pingpong test with: .IP \[bu] 2 @@ -150,14 +136,14 @@ server node as 192.168.0.123 .SS A longer test .SS Server: .PP -\f[V]server$ fi_pingpong -p usnic -I 10000 -S all\f[R] +\f[C]server$ fi_pingpong -p usnic -I 10000 -S all\f[R] .SS Client: .PP -\f[V]client$ fi_pingpong -p usnic -I 10000 -S all 192.168.0.123\f[R] +\f[C]client$ fi_pingpong -p usnic -I 10000 -S all 192.168.0.123\f[R] .SH DEFAULTS .PP There is no default provider; if a provider is not specified via the -\f[V]-p\f[R] switch, the test will pick one from the list of available +\f[C]-p\f[R] switch, the test will pick one from the list of available providers (as returned by fi_getinfo(3)). .PP If no endpoint type is specified, `dgram' is used. @@ -192,6 +178,6 @@ client per second .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3) \f[V]fabric\f[R](7), +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3) \f[C]fabric\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man1/fi_strerror.1 b/man/man1/fi_strerror.1 index 70605dabbd6..80cb05cd760 100644 --- a/man/man1/fi_strerror.1 +++ b/man/man1/fi_strerror.1 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_strerror" "1" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_strerror" "1" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -28,16 +14,16 @@ fi_strerror FI_ERROR_CODE .fi .SH DESCRIPTION .PP -Display the error string for the given numeric \f[V]FI_ERROR_CODE\f[R]. -\f[V]FI_ERROR_CODE\f[R] may be a hexadecimal, octal, or decimal +Display the error string for the given numeric \f[C]FI_ERROR_CODE\f[R]. +\f[C]FI_ERROR_CODE\f[R] may be a hexadecimal, octal, or decimal constant. -Although the \f[V]fi_strerror\f[R](3) library function only accepts +Although the \f[C]fi_strerror\f[R](3) library function only accepts positive error values, for convenience this utility accepts both positive and negative error values. .PP This is primarily a convenience tool for developers. .SH SEE ALSO .PP -\f[V]fabric\f[R](7) \f[V]fi_errno\f[R](3) +\f[C]fabric\f[R](7) \f[C]fi_errno\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_atomic.3 b/man/man3/fi_atomic.3 index a1b0bd7c716..2054cbbfe1c 100644 --- a/man/man3/fi_atomic.3 +++ b/man/man3/fi_atomic.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_atomic" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_atomic" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -143,7 +129,7 @@ Local data buffer to store initial value of remote buffer \f[I]desc / compare_desc / result_desc\f[R] Data descriptor associated with the local data buffer, local compare buffer, and local result buffer, respectively. -See \f[V]fi_mr\f[R](3). +See \f[C]fi_mr\f[R](3). .TP \f[I]dest_addr\f[R] Destination address for connectionless atomic operations. @@ -707,11 +693,11 @@ parameter specifying the tag. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .TP \f[I]-FI_EAGAIN\f[R] -See \f[V]fi_msg\f[R](3) for a detailed description of handling +See \f[C]fi_msg\f[R](3) for a detailed description of handling FI_EAGAIN. .TP \f[I]-FI_EOPNOTSUPP\f[R] @@ -755,11 +741,11 @@ assigned to the transmitting and receiving endpoints. Both message and data ordering are required if the results of two atomic operations to the same memory buffers are to reflect the second operation acting on the results of the first. -See \f[V]fi_endpoint\f[R](3) for further details and message size +See \f[C]fi_endpoint\f[R](3) for further details and message size restrictions. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3), \f[V]fi_rma\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3), \f[C]fi_rma\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_av.3 b/man/man3/fi_av.3 index 866d0d635cc..41870d477c5 100644 --- a/man/man3/fi_av.3 +++ b/man/man3/fi_av.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_av" "3" "2024\-10\-15" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_av" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -163,14 +149,14 @@ been deprecated, see below). See the NOTES section for AV restrictions on duplicate addresses. .PP \f[B]Deprecated\f[R]: AV operations may be set to operate asynchronously -by specifying the FI_EVENT flag to \f[V]fi_av_open\f[R]. +by specifying the FI_EVENT flag to \f[C]fi_av_open\f[R]. When requesting asynchronous operation, the application must first bind an event queue to the AV before inserting addresses. .SS fi_av_open .PP fi_av_open allocates or opens an address vector. The properties and behavior of the address vector are defined by -\f[V]struct fi_av_attr\f[R]. +\f[C]struct fi_av_attr\f[R]. .IP .nf \f[C] @@ -301,7 +287,7 @@ The context field in all completions will be the context specified to the insert call, and the data field in the final completion entry will report the number of addresses successfully inserted. If an error occurs during the asynchronous insertion, an error -completion entry is returned (see \f[V]fi_eq\f[R](3) for a discussion of +completion entry is returned (see \f[C]fi_eq\f[R](3) for a discussion of the fi_eq_err_entry error completion struct). The context field of the error completion will be the context that was specified in the insert call; the data field will contain the index of @@ -361,10 +347,10 @@ the call will return -FI_EBUSY. .SS fi_av_bind (deprecated) .PP Associates an event queue with the AV. -If an AV has been opened with \f[V]FI_EVENT\f[R], then an event queue +If an AV has been opened with \f[C]FI_EVENT\f[R], then an event queue must be bound to the AV before any insertion calls are attempted. Any calls to insert addresses before an event queue has been bound will -fail with \f[V]-FI_ENOEQ\f[R]. +fail with \f[C]-FI_ENOEQ\f[R]. Flags are reserved for future use and must be 0. .SS fi_av_insert .PP @@ -375,7 +361,7 @@ AV. Addresses inserted into an address vector must be in the same format as specified in the addr_format field of the fi_info struct provided when opening the corresponding domain. -When using the \f[V]FI_ADDR_STR\f[R] format, the \f[V]addr\f[R] +When using the \f[C]FI_ADDR_STR\f[R] format, the \f[C]addr\f[R] parameter should reference an array of strings (char **). .PP \f[B]Deprecated\f[R]: For AV\[cq]s of type FI_AV_MAP, once inserted @@ -409,14 +395,14 @@ buffer must remain valid until the insertion operation completes. Note that if fi_addr is NULL and synchronous operation is requested without using FI_SYNC_ERR flag, individual insertion failures cannot be reported and the application must use other calls, such as -\f[V]fi_av_lookup\f[R] to learn which specific addresses failed to +\f[C]fi_av_lookup\f[R] to learn which specific addresses failed to insert. .PP If the address vector is configured with authorization keys, the fi_addr parameter may be used as input to define the authorization keys associated with the endpoint addresses being inserted. This is done by setting the fi_addr to an authorization key fi_addr_t -generated from \f[V]fi_av_insert_auth_key\f[R] and setting the +generated from \f[C]fi_av_insert_auth_key\f[R] and setting the FI_AUTH_KEY flag. If the FI_AUTH_KEY flag is not set, addresses being inserted will not be associated with any authorization keys. @@ -430,8 +416,8 @@ authorization keys. These fi_addr_t\[cq]s can be used as the target for local data transfer operations. .PP -If the endpoint supports \f[V]FI_DIRECTED_RECV\f[R] or -\f[V]FI_TAGGED_DIRECTED_RECV\f[R], these fi_addr_t\[cq]s can be used to +If the endpoint supports \f[C]FI_DIRECTED_RECV\f[R] or +\f[C]FI_TAGGED_DIRECTED_RECV\f[R], these fi_addr_t\[cq]s can be used to restrict receive buffers to a specific endpoint address and authorization key. .PP @@ -494,10 +480,10 @@ Node should be a string that corresponds to a hostname or network address. The service string corresponds to a textual representation of a transport address. -Applications may also pass in an \f[V]FI_ADDR_STR\f[R] formatted address +Applications may also pass in an \f[C]FI_ADDR_STR\f[R] formatted address as the node parameter. In such cases, the service parameter must be NULL. -See fi_getinfo.3 for details on using \f[V]FI_ADDR_STR\f[R]. +See fi_getinfo.3 for details on using \f[C]FI_ADDR_STR\f[R]. Supported flags are the same as for fi_av_insert. .SS fi_av_insertsym .PP @@ -541,7 +527,7 @@ Note that removing an address may not disable receiving data from the peer endpoint. fi_av_close will automatically cleanup any associated resource. .PP -If the address being removed came from \f[V]fi_av_insert_auth_key\f[R], +If the address being removed came from \f[C]fi_av_insert_auth_key\f[R], the address will only be removed if all endpoints, which have been enabled against the corresponding authorization key, have been closed. If all endpoints are not closed, -FI_EBUSY will be returned. @@ -591,8 +577,8 @@ fi_av_straddr returns a pointer to buf. .SS fi_av_insert_auth_key .PP This function associates authorization keys with an address vector. -This requires the domain to be opened with \f[V]FI_AV_AUTH_KEY\f[R]. -\f[V]FI_AV_AUTH_KEY\f[R] enables endpoints and memory regions to be +This requires the domain to be opened with \f[C]FI_AV_AUTH_KEY\f[R]. +\f[C]FI_AV_AUTH_KEY\f[R] enables endpoints and memory regions to be associated with authorization keys from the address vector. This behavior enables a single endpoint or memory region to be associated with multiple authorization keys. @@ -602,38 +588,38 @@ address vector authorization keys at that point in time. Later authorization key insertions will not propagate to already enabled endpoints and memory regions. .PP -The \f[V]auth_key\f[R] and \f[V]auth_key_size\f[R] parameters are used +The \f[C]auth_key\f[R] and \f[C]auth_key_size\f[R] parameters are used to input the authorization key into the address vector. The structure of the authorization key is provider specific. -If the \f[V]auth_key_size\f[R] does not align with provider specific +If the \f[C]auth_key_size\f[R] does not align with provider specific structure, -FI_EINVAL will be returned. .PP -The output of \f[V]fi_av_insert_auth_key\f[R] is an authorization key +The output of \f[C]fi_av_insert_auth_key\f[R] is an authorization key fi_addr_t handle representing all endpoint addresses against this specific authorization key. For all operations, including address vector, memory registration, and data transfers, which may accept an authorization key fi_addr_t as input, the FI_AUTH_KEY flag must be specified. Otherwise, the fi_addr_t will be treated as an fi_addr_t returned from -the \f[V]fi_av_insert\f[R] and related functions. +the \f[C]fi_av_insert\f[R] and related functions. .PP For endpoints enabled with FI_DIRECTED_RECV, authorization key fi_addr_t\[cq]s can be used to restrict incoming messages to only endpoint addresses within the authorization key. This will require passing in the FI_AUTH_KEY flag to -\f[V]fi_recvmsg\f[R] and \f[V]fi_trecvmsg\f[R]. +\f[C]fi_recvmsg\f[R] and \f[C]fi_trecvmsg\f[R]. .PP For domains enabled with FI_DIRECTED_RECV, authorization key fi_addr_t\[cq]s can be used to restrict memory region access to only endpoint addresses within the authorization key. This will require passing in the FI_AUTH_KEY flag to -\f[V]fi_mr_regattr\f[R]. +\f[C]fi_mr_regattr\f[R]. .PP These authorization key fi_addr_t\[cq]s can later be used an input for endpoint address insertion functions to generate an fi_addr_t for a specific endpoint address and authorization key. This will require passing in the FI_AUTH_KEY flag to -\f[V]fi_av_insert\f[R] and related functions. +\f[C]fi_av_insert\f[R] and related functions. .PP For address vectors configured with FI_AV_USER_ID and endpoints with FI_SOURCE_ERR, all subsequent FI_EADDRNOTAVAIL error events will return @@ -651,7 +637,7 @@ Flags are reserved for future use and must be 0. This functions returns the authorization key associated with a fi_addr_t. Acceptable fi_addr_t\[cq]s input are the output of -\f[V]fi_av_insert_auth_key\f[R] and AV address insertion functions. +\f[C]fi_av_insert_auth_key\f[R] and AV address insertion functions. The returned authorization key is in a provider specific format. On input, the auth_key_size parameter should indicate the size of the auth_key buffer. @@ -760,14 +746,14 @@ function. This function is used to set the group ID portion of an fi_addr_t. .SH RETURN VALUES .PP -Insertion calls, excluding \f[V]fi_av_insert_auth_key\f[R], for an AV +Insertion calls, excluding \f[C]fi_av_insert_auth_key\f[R], for an AV opened for synchronous operation will return the number of addresses that were successfully inserted. In the case of failure, the return value will be less than the number of addresses that was specified. .PP \f[B]Deprecated\f[R]: Insertion calls, excluding -\f[V]fi_av_insert_auth_key\f[R], for an AV opened for asynchronous +\f[C]fi_av_insert_auth_key\f[R], for an AV opened for asynchronous operation (with FI_EVENT flag specified) will return FI_SUCCESS if the operation was successfully initiated. In the case of failure, a negative fabric errno will be returned. @@ -782,10 +768,10 @@ FI_ADDR_NOTAVAIL. .PP All other calls return FI_SUCCESS on success, or a negative value corresponding to fabric errno on error. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_eq\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_eq\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_av_set.3 b/man/man3/fi_av_set.3 index 71cff544452..04742ab2629 100644 --- a/man/man3/fi_av_set.3 +++ b/man/man3/fi_av_set.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_av_set" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_av_set" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -106,7 +92,7 @@ The creation and manipulation of an AV set is a local operation. No fabric traffic is exchanged between peers. As a result, each peer is responsible for creating matching AV sets as part of their collective membership definition. -See \f[V]fi_collective\f[R](3) for a discussion of membership models. +See \f[C]fi_collective\f[R](3) for a discussion of membership models. .SS fi_av_set .PP The fi_av_set call creates a new AV set. @@ -277,9 +263,9 @@ It is an error for a user to request an unsupported collective. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH SEE ALSO .PP -\f[V]fi_av\f[R](3), \f[V]fi_collective\f[R](3) +\f[C]fi_av\f[R](3), \f[C]fi_collective\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_cm.3 b/man/man3/fi_cm.3 index 36fff256d99..7723f65eb7e 100644 --- a/man/man3/fi_cm.3 +++ b/man/man3/fi_cm.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_cm" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_cm" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -275,7 +261,7 @@ or an error will occur. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .SH NOTES .PP @@ -293,7 +279,7 @@ events, or as additional err_data to fi_eq_err_entry, in the case of a rejected connection. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_eq\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_eq\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_cntr.3 b/man/man3/fi_cntr.3 index 53c35f5b5fe..2dcdb911498 100644 --- a/man/man3/fi_cntr.3 +++ b/man/man3/fi_cntr.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_cntr" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_cntr" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -105,14 +91,14 @@ That is, a counter actually stores two distinct values, with error completions updating an error specific value. .PP Counters are updated following the completion event semantics defined in -\f[V]fi_cq\f[R](3). +\f[C]fi_cq\f[R](3). The timing of the update is based on the type of transfer and any specified operation flags. .SS fi_cntr_open .PP fi_cntr_open allocates a new fabric counter. The properties and behavior of the counter are defined by -\f[V]struct fi_cntr_attr\f[R]. +\f[C]struct fi_cntr_attr\f[R]. .IP .nf \f[C] @@ -292,7 +278,7 @@ On error, a negative value corresponding to fabric errno is returned. fi_cntr_read / fi_cntr_readerr Returns the current value of the counter. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH NOTES .PP In order to support a variety of counter implementations, updates made @@ -314,7 +300,7 @@ fi_cntr_set / fi_cntr_seterr and results of related operations are reflected in the observed value of the counter. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_eq\f[R](3), \f[V]fi_poll\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_eq\f[R](3), \f[C]fi_poll\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_collective.3 b/man/man3/fi_collective.3 index 13627bb8a9c..58e3121c6b2 100644 --- a/man/man3/fi_collective.3 +++ b/man/man3/fi_collective.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_collective" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_collective" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .TP @@ -166,7 +152,7 @@ be used for required input. .PP In general collective operations can be thought of as coordinated atomic operations between a set of peer endpoints. -Readers should refer to the \f[V]fi_atomic\f[R](3) man page for details +Readers should refer to the \f[C]fi_atomic\f[R](3) man page for details on the atomic operations and datatypes defined by libfabric. .PP A collective operation is a group communication exchange. @@ -213,7 +199,7 @@ provider by creating and configuring an address vector set (AV set). An AV set represents an ordered subset of addresses in an address vector (AV). Details on creating and configuring an AV set are available in -\f[V]fi_av_set\f[R](3). +\f[C]fi_av_set\f[R](3). .PP Once an AV set has been programmed with the collective membership information, an endpoint is joined to the set. @@ -272,7 +258,7 @@ Applications must call fi_close on the collective group to disconnect the endpoint from the group. After a join operation has completed, the fi_mc_addr call may be used to retrieve the address associated with the multicast group. -See \f[V]fi_cm\f[R](3) for additional details on fi_mc_addr(). +See \f[C]fi_cm\f[R](3) for additional details on fi_mc_addr(). .SS Barrier (fi_barrier) .PP The fi_barrier operation provides a mechanism to synchronize peers. @@ -523,7 +509,7 @@ struct fi_collective_attr { \f[R] .fi .PP -For a description of struct fi_atomic_attr, see \f[V]fi_atomic\f[R](3). +For a description of struct fi_atomic_attr, see \f[C]fi_atomic\f[R](3). .TP \f[I]op\f[R] On input, this specifies the atomic operation involved with the @@ -566,7 +552,7 @@ collective operation through the provider. .PP Collective operations map to underlying fi_atomic operations. For a discussion of atomic completion semantics, see -\f[V]fi_atomic\f[R](3). +\f[C]fi_atomic\f[R](3). The completion, ordering, and atomicity of collective operations match those defined for point to point atomic operations. .SH FLAGS @@ -581,11 +567,11 @@ collective operation. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .TP \f[I]-FI_EAGAIN\f[R] -See \f[V]fi_msg\f[R](3) for a detailed description of handling +See \f[C]fi_msg\f[R](3) for a detailed description of handling FI_EAGAIN. .TP \f[I]-FI_EOPNOTSUPP\f[R] @@ -601,11 +587,11 @@ As such, they follow most of the conventions and restrictions as peer to peer atomic operations. This includes data atomicity, data alignment, and message ordering semantics. -See \f[V]fi_atomic\f[R](3) for additional information on the datatypes +See \f[C]fi_atomic\f[R](3) for additional information on the datatypes and operations defined for atomic and collective operations. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_av\f[R](3), \f[V]fi_atomic\f[R](3), -\f[V]fi_cm\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_av\f[R](3), \f[C]fi_atomic\f[R](3), +\f[C]fi_cm\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_control.3 b/man/man3/fi_control.3 index 27d8a52afd9..65b0890e0f8 100644 --- a/man/man3/fi_control.3 +++ b/man/man3/fi_control.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_control" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_control" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -64,7 +50,7 @@ header files (\[cq]rdma/fi_ext_*.h\[cq]). Please refer to the provider man pages for details. .SH SEE ALSO .PP -\f[V]fi_endpoint\f[R](3), \f[V]fi_cm\f[R](3), \f[V]fi_cntr\f[R](3), -\f[V]fi_cq\f[R](3), \f[V]fi_eq\f[R](3), +\f[C]fi_endpoint\f[R](3), \f[C]fi_cm\f[R](3), \f[C]fi_cntr\f[R](3), +\f[C]fi_cq\f[R](3), \f[C]fi_eq\f[R](3), .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_cq.3 b/man/man3/fi_cq.3 index d788b5af76f..f3bce7ce489 100644 --- a/man/man3/fi_cq.3 +++ b/man/man3/fi_cq.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_cq" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_cq" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -137,7 +123,7 @@ Unlike event queues, completion queues are associated with a resource domain and may be offloaded entirely in provider hardware. .PP The properties and behavior of a completion queue are defined by -\f[V]struct fi_cq_attr\f[R]. +\f[C]struct fi_cq_attr\f[R]. .IP .nf \f[C] @@ -368,9 +354,8 @@ Multiple completions may be retrieved from a CQ in a single call. The maximum number of entries to return is limited to the specified count parameter, with the number of entries successfully read from the CQ returned by the call. -(See return values section below.) -A count value of 0 may be used to drive progress on associated endpoints -when manual progress is enabled. +(See return values section below.) A count value of 0 may be used to +drive progress on associated endpoints when manual progress is enabled. .PP CQs are optimized to report operations which have completed successfully. @@ -444,7 +429,7 @@ fi_cq_readerr is a non-blocking call, returning immediately whether an error completion was found or not. .PP Error information is reported to the user through -\f[V]struct fi_cq_err_entry\f[R]. +\f[C]struct fi_cq_err_entry\f[R]. The format of this structure is defined below. .IP .nf @@ -537,9 +522,8 @@ Flags are set for all relevant completions. .TP \f[I]len\f[R] This len field applies to completed receive operations (e.g.\ fi_recv, -fi_trecv, etc.) -and the completed write with remote cq data on the responder side -(e.g.\ fi_write, with FI_REMOTE_CQ_DATA flag). +fi_trecv, etc.) and the completed write with remote cq data on the +responder side (e.g.\ fi_write, with FI_REMOTE_CQ_DATA flag). It indicates the size of transferred \f[I]message\f[R] data \[en] i.e.\ how many data bytes were placed into the associated receive/target buffer by a corresponding fi_send/fi_tsend/fi_write et al call. @@ -970,7 +954,7 @@ When heterogenous memory is involved, the concept of memory domains come into play. Memory domains identify the physical separation of memory, which may or may not be accessible through the same virtual address space. -See the \f[V]fi_mr\f[R](3) man page for further details on memory +See the \f[C]fi_mr\f[R](3) man page for further details on memory domains. .PP Completion ordering and data visibility are only well-defined for @@ -1030,7 +1014,7 @@ As a result, applications can request a lower completion semantic when posting receives. That indicates to the provider that the application will be responsible for handling any device specific flush operations that might be needed. -See \f[V]fi_msg\f[R](3) FLAGS. +See \f[C]fi_msg\f[R](3) FLAGS. .PP For data transfers that do not generate a completion at the target, such as RMA or atomics, it is the responsibility of the application to ensure @@ -1133,11 +1117,11 @@ returns -FI_EAGAIN. : Returns a character string interpretation of the provider specific error returned with a completion. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_eq\f[R](3), \f[V]fi_cntr\f[R](3), -\f[V]fi_poll\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_eq\f[R](3), \f[C]fi_cntr\f[R](3), +\f[C]fi_poll\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_domain.3 b/man/man3/fi_domain.3 index c3a1b104a28..c8f9721e562 100644 --- a/man/man3/fi_domain.3 +++ b/man/man3/fi_domain.3 @@ -1,21 +1,7 @@ -'\" t -.\" Automatically generated by Pandoc 3.1.3 +.\"t +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_domain" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_domain" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -90,7 +76,7 @@ parameter. .PP Similar to fi_domain, but accepts an extra parameter \f[I]flags\f[R]. Mainly used for opening peer domain. -See \f[V]fi_peer\f[R](3). +See \f[C]fi_peer\f[R](3). .SS fi_open_ops .PP fi_open_ops is used to open provider specific interfaces. @@ -187,9 +173,9 @@ through the event queue. If an event queue is not bound to the domain with the FI_REG_MR flag, then memory registration requests complete synchronously. .PP -See \f[V]fi_av_bind\f[R](3), \f[V]fi_ep_bind\f[R](3), -\f[V]fi_mr_bind\f[R](3), \f[V]fi_pep_bind\f[R](3), and -\f[V]fi_scalable_ep_bind\f[R](3) for more information. +See \f[C]fi_av_bind\f[R](3), \f[C]fi_ep_bind\f[R](3), +\f[C]fi_mr_bind\f[R](3), \f[C]fi_pep_bind\f[R](3), and +\f[C]fi_scalable_ep_bind\f[R](3) for more information. .SS fi_close .PP The fi_close call is used to release all resources associated with a @@ -198,7 +184,7 @@ All objects associated with the opened domain must be released prior to calling fi_close, otherwise the call will return -FI_EBUSY. .SH DOMAIN ATTRIBUTES .PP -The \f[V]fi_domain_attr\f[R] structure defines the set of attributes +The \f[C]fi_domain_attr\f[R] structure defines the set of attributes associated with a domain. .IP .nf @@ -663,7 +649,7 @@ size as the endpoint queue(s) that are bound to it. .SS AV Type (av_type) .PP Specifies the type of address vectors that are usable with this domain. -For additional details on AV type, see \f[V]fi_av\f[R](3). +For additional details on AV type, see \f[C]fi_av\f[R](3). The following values may be specified. .TP \f[I]FI_AV_MAP\f[R] (deprecated) @@ -687,7 +673,7 @@ optimal AV type supported by this domain. .SS Memory Registration Mode (mr_mode) .PP Defines memory registration specific mode bits used with this domain. -Full details on MR mode options are available in \f[V]fi_mr\f[R](3). +Full details on MR mode options are available in \f[C]fi_mr\f[R](3). The following values may be specified. .TP \f[I]FI_MR_ALLOCATED\f[R] @@ -868,7 +854,7 @@ If this domain capability is not set, address vectors cannot be opened with FI_AV_USER_ID. Note that FI_AV_USER_ID can still be supported through the AV insert calls without this domain capability set. -See \f[V]fi_av\f[R](3). +See \f[C]fi_av\f[R](3). .TP \f[I]FI_PEER\f[R] Specifies that the domain must support importing resources to be used in @@ -899,7 +885,7 @@ provider, for example. Indicates that the domain supports the ability to share address vectors among multiple processes using the named address vector feature. .PP -See \f[V]fi_getinfo\f[R](3) for a discussion on primary versus secondary +See \f[C]fi_getinfo\f[R](3) for a discussion on primary versus secondary capabilities. .SS Default authorization key (auth_key) .PP @@ -946,7 +932,7 @@ cache or lookup tables. .PP This specifies the default traffic class that will be associated any endpoints created within the domain. -See \f[V]fi_endpoint\f[R](3) for additional information. +See \f[C]fi_endpoint\f[R](3) for additional information. .SS Max Authorization Keys per Endpoint (max_ep_auth_key) .PP The maximum number of authorization keys which can be supported per @@ -955,7 +941,7 @@ connectionless endpoint. .PP The maximum value that a peer group may be assigned, inclusive. Valid peer group id\[cq]s must be between 0 and max_group_id. -See \f[V]fi_av\f[R](3) for additional information on peer groups and +See \f[C]fi_av\f[R](3) for additional information on peer groups and their use. Users may request support for peer groups by setting this to a non-zero value. @@ -967,7 +953,7 @@ the application. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH NOTES .PP Users should call fi_close to release all resources allocated to the @@ -986,7 +972,7 @@ lightly loaded systems, without an administrator configuring system resources appropriately for the installed provider(s). .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), \f[V]fi_av\f[R](3), -\f[V]fi_eq\f[R](3), \f[V]fi_mr\f[R](3) \f[V]fi_peer\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), \f[C]fi_av\f[R](3), +\f[C]fi_eq\f[R](3), \f[C]fi_mr\f[R](3) \f[C]fi_peer\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_endpoint.3 b/man/man3/fi_endpoint.3 index ea3b4076c9f..cbc4a28a885 100644 --- a/man/man3/fi_endpoint.3 +++ b/man/man3/fi_endpoint.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_endpoint" "3" "2024\-10\-15" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_endpoint" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -277,7 +263,7 @@ been used. .PP Similar to fi_endpoint, buf accepts an extra parameter \f[I]flags\f[R]. Mainly used for opening endpoints that use peer transfer feature. -See \f[V]fi_peer\f[R](3) +See \f[C]fi_peer\f[R](3) .SS fi_close .PP Closes an endpoint and release all resources associated with it. @@ -590,7 +576,7 @@ FI_HMEM_P2P_DISABLED: Peer to peer support should not be used. fi_setopt() will return -FI_EOPNOTSUPP if the mode requested cannot be supported by the provider. The FI_HMEM_DISABLE_P2P environment variable discussed in -\f[V]fi_mr\f[R](3) takes precedence over this setopt option. +\f[C]fi_mr\f[R](3) takes precedence over this setopt option. .RE \[bu] .RS 2 .TP @@ -623,10 +609,10 @@ Define the maximum message size that can be transferred by the endpoint in a single untagged message. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]ep_attr->max_msg_size\f[R]. +\f[C]ep_attr->max_msg_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]ep_attr->max_msg_size\f[R] should be used. +In that case, \f[C]ep_attr->max_msg_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -635,10 +621,10 @@ Define the maximum message size that can be transferred by the endpoint in a single tagged message. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]ep_attr->max_msg_size\f[R]. +\f[C]ep_attr->max_msg_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]ep_attr->max_msg_size\f[R] should be used. +In that case, \f[C]ep_attr->max_msg_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -647,10 +633,10 @@ Define the maximum message size that can be transferred by the endpoint via a single RMA operation. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]ep_attr->max_msg_size\f[R]. +\f[C]ep_attr->max_msg_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]ep_attr->max_msg_size\f[R] should be used. +In that case, \f[C]ep_attr->max_msg_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -659,10 +645,10 @@ Define the maximum data size that can be transferred by the endpoint via a single atomic operation. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]ep_attr->max_msg_size\f[R]. +\f[C]ep_attr->max_msg_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]ep_attr->max_msg_size\f[R] should be used. +In that case, \f[C]ep_attr->max_msg_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -671,10 +657,10 @@ Define the maximum message size that can be injected by the endpoint in a single untagged message. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]tx_attr->inject_size\f[R]. +\f[C]tx_attr->inject_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]tx_attr->inject_size\f[R] should be used. +In that case, \f[C]tx_attr->inject_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -683,10 +669,10 @@ Define the maximum message size that can be injected by the endpoint in a single tagged message. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]tx_attr->inject_size\f[R]. +\f[C]tx_attr->inject_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]tx_attr->inject_size\f[R] should be used. +In that case, \f[C]tx_attr->inject_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -695,10 +681,10 @@ Define the maximum data size that can be injected by the endpoint in a single RMA operation. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]tx_attr->inject_size\f[R]. +\f[C]tx_attr->inject_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]tx_attr->inject_size\f[R] should be used. +In that case, \f[C]tx_attr->inject_size\f[R] should be used. .RE \[bu] .RS 2 .TP @@ -707,10 +693,10 @@ Define the maximum data size that can be injected by the endpoint in a single atomic operation. The size is limited by the endpoint\[cq]s configuration and the provider\[cq]s capabilities, and must be less than or equal to -\f[V]tx_attr->inject_size\f[R]. +\f[C]tx_attr->inject_size\f[R]. Providers that don\[cq]t support this option will return -FI_ENOPROTOOPT. -In that case, \f[V]tx_attr->inject_size\f[R] should be used. +In that case, \f[C]tx_attr->inject_size\f[R] should be used. .RE .SS fi_tc_dscp_set .PP @@ -1793,7 +1779,7 @@ value of transmit or receive context attributes of an endpoint. \f[I]FI_COMMIT_COMPLETE\f[R] Indicates that a completion should not be generated (locally or at the peer) until the result of an operation have been made persistent. -See \f[V]fi_cq\f[R](3) for additional details on completion semantics. +See \f[C]fi_cq\f[R](3) for additional details on completion semantics. .TP \f[I]FI_COMPLETION\f[R] Indicates that a completion queue entry should be written for data @@ -1806,7 +1792,7 @@ See the fi_ep_bind section above for more detail. \f[I]FI_DELIVERY_COMPLETE\f[R] Indicates that a completion should be generated when the operation has been processed by the destination endpoint(s). -See \f[V]fi_cq\f[R](3) for additional details on completion semantics. +See \f[C]fi_cq\f[R](3) for additional details on completion semantics. .TP \f[I]FI_INJECT\f[R] Indicates that all outbound data buffers should be returned to the @@ -1821,7 +1807,7 @@ This limit is indicated using inject_size (see inject_size above). \f[I]FI_INJECT_COMPLETE\f[R] Indicates that a completion should be generated when the source buffer(s) may be reused. -See \f[V]fi_cq\f[R](3) for additional details on completion semantics. +See \f[C]fi_cq\f[R](3) for additional details on completion semantics. .TP \f[I]FI_MULTICAST\f[R] Indicates that data transfers will target multicast addresses by @@ -1845,7 +1831,7 @@ space falls below the specified minimum (see FI_OPT_MIN_MULTI_RECV). \f[I]FI_TRANSMIT_COMPLETE\f[R] Indicates that a completion should be generated when the transmit operation has completed relative to the local provider. -See \f[V]fi_cq\f[R](3) for additional details on completion semantics. +See \f[C]fi_cq\f[R](3) for additional details on completion semantics. .SH NOTES .PP Users should call fi_close to release all resources allocated to the @@ -1854,10 +1840,10 @@ fabric endpoint. Endpoints allocated with the FI_CONTEXT or FI_CONTEXT2 mode bits set must typically provide struct fi_context(2) as their per operation context parameter. -(See fi_getinfo.3 for details.) -However, when FI_SELECTIVE_COMPLETION is enabled to suppress CQ -completion entries, and an operation is initiated without the -FI_COMPLETION flag set, then the context parameter is ignored. +(See fi_getinfo.3 for details.) However, when FI_SELECTIVE_COMPLETION is +enabled to suppress CQ completion entries, and an operation is initiated +without the FI_COMPLETION flag set, then the context parameter is +ignored. An application does not need to pass in a valid struct fi_context(2) into such data transfers. .PP @@ -1896,7 +1882,7 @@ submitted for processing. For fi_setopt/fi_getopt, a return value of -FI_ENOPROTOOPT indicates the provider does not support the requested option. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .TP \f[I]-FI_EDOMAIN\f[R] @@ -1910,8 +1896,8 @@ The endpoint has not been configured with necessary completion queue. The endpoint\[cq]s state does not permit the requested operation. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3) -\f[V]fi_msg\f[R](3), \f[V]fi_tagged\f[R](3), \f[V]fi_rma\f[R](3) -\f[V]fi_peer\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3) +\f[C]fi_msg\f[R](3), \f[C]fi_tagged\f[R](3), \f[C]fi_rma\f[R](3) +\f[C]fi_peer\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_eq.3 b/man/man3/fi_eq.3 index 359feed69b9..0622ffbbf62 100644 --- a/man/man3/fi_eq.3 +++ b/man/man3/fi_eq.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_eq" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_eq" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -123,7 +109,7 @@ as listening for connection requests. fi_eq_open allocates a new event queue. .PP The properties and behavior of an event queue are defined by -\f[V]struct fi_eq_attr\f[R]. +\f[C]struct fi_eq_attr\f[R]. .IP .nf \f[C] @@ -273,7 +259,7 @@ These include the following types of events: memory registration, address vector resolution, and multicast joins. .PP Control requests report their completion by inserting a -\f[V]struct fi_eq_entry\f[R] into the EQ. +\f[C]struct fi_eq_entry\f[R] into the EQ. The format of this structure is: .IP .nf @@ -297,7 +283,7 @@ The context field will be set to the context specified as part of the operation, if available, otherwise the context will be associated with the fabric descriptor. The data field will be set as described in the man page for the -corresponding object type (e.g., see \f[V]fi_av\f[R](3) for a +corresponding object type (e.g., see \f[C]fi_av\f[R](3) for a description of how asynchronous address vector insertions are completed). .TP @@ -307,7 +293,7 @@ setup or tear down connections between endpoints. There are three connection notification events: FI_CONNREQ, FI_CONNECTED, and FI_SHUTDOWN. Connection notifications are reported using -\f[V]struct fi_eq_cm_entry\f[R]: +\f[C]struct fi_eq_cm_entry\f[R]: .IP .nf \f[C] @@ -446,7 +432,7 @@ The context field will be set to the context specified as part of the operation. .PP The data field will be set as described in the man page for the -corresponding object type (e.g., see \f[V]fi_av\f[R](3) for a +corresponding object type (e.g., see \f[C]fi_av\f[R](3) for a description of how asynchronous address vector insertions are completed). .PP @@ -572,10 +558,10 @@ fi_eq_strerror Returns a character string interpretation of the provider specific error returned with a completion. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_cntr\f[R](3), \f[V]fi_poll\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_cntr\f[R](3), \f[C]fi_poll\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_errno.3 b/man/man3/fi_errno.3 index e73772c435f..be13272dd97 100644 --- a/man/man3/fi_errno.3 +++ b/man/man3/fi_errno.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_errno" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_errno" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -198,6 +184,6 @@ Receiver not ready, no receive buffers available Memory registration limit exceeded .SH SEE ALSO .PP -\f[V]fabric\f[R](7) +\f[C]fabric\f[R](7) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_fabric.3 b/man/man3/fi_fabric.3 index 205a8d96691..cc2a0e63219 100644 --- a/man/man3/fi_fabric.3 +++ b/man/man3/fi_fabric.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_fabric" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_fabric" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -160,11 +146,11 @@ The data parameter is ignored. .TP \f[I]FI_TYPE_EQ_EVENT\f[R] uint32_t event parameter returned from fi_eq_read(). -See \f[V]fi_eq(3)\f[R] for a list of known values. +See \f[C]fi_eq(3)\f[R] for a list of known values. .TP \f[I]FI_TYPE_CQ_EVENT_FLAGS\f[R] uint64_t flags field in fi_cq_xxx_entry structures. -See \f[V]fi_cq(3)\f[R] for valid flags. +See \f[C]fi_cq(3)\f[R] for valid flags. .TP \f[I]FI_TYPE_MR_MODE\f[R] struct fi_domain_attr::mr_mode flags @@ -259,7 +245,7 @@ these environment variables in a production setting. Version information for the fabric provider, in a major.minor format. The use of the FI_MAJOR() and FI_MINOR() version macros may be used to extract the major and minor version data. -See \f[V]fi_version(3)\f[R]. +See \f[C]fi_version(3)\f[R]. .PP In case of an utility provider layered over a core provider, the version would always refer to that of the utility provider. @@ -267,16 +253,16 @@ would always refer to that of the utility provider. .PP The interface version requested by the application. This value corresponds to the version parameter passed into -\f[V]fi_getinfo(3)\f[R]. +\f[C]fi_getinfo(3)\f[R]. .SH RETURN VALUE .PP Returns FI_SUCCESS on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_getinfo\f[R](3), \f[V]fi_domain\f[R](3), -\f[V]fi_eq\f[R](3), \f[V]fi_endpoint\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_getinfo\f[R](3), \f[C]fi_domain\f[R](3), +\f[C]fi_eq\f[R](3), \f[C]fi_endpoint\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_getinfo.3 b/man/man3/fi_getinfo.3 index c4ee256d526..8c531815b94 100644 --- a/man/man3/fi_getinfo.3 +++ b/man/man3/fi_getinfo.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_getinfo" "3" "2024\-10\-15" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_getinfo" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -232,8 +218,8 @@ manner. The fi_info::handle field is also used by fi_endpoint() and fi_reject() calls when processing connection requests or to inherit another endpoint\[cq]s attributes. -See \f[V]fi_eq\f[R](3), \f[V]fi_reject\f[R](3), and -\f[V]fi_endpoint\f[R](3). +See \f[C]fi_eq\f[R](3), \f[C]fi_reject\f[R](3), and +\f[C]fi_endpoint\f[R](3). The info->handle field will be ignored by fi_dupinfo and fi_freeinfo. .TP \f[I]tx_attr - transmit context attributes\f[R] @@ -266,7 +252,7 @@ set. On output, the actual endpoint attributes that can be provided will be returned. Output values will be greater than or equal to requested input values. -See \f[V]fi_endpoint\f[R](3) for details. +See \f[C]fi_endpoint\f[R](3) for details. .TP \f[I]domain_attr - domain attributes\f[R] Optionally supplied domain attributes. @@ -276,7 +262,7 @@ be set. On output, the actual domain attributes that can be provided will be returned. Output values will be greater than or equal to requested input values. -See \f[V]fi_domain\f[R](3) for details. +See \f[C]fi_domain\f[R](3) for details. .TP \f[I]fabric_attr - fabric attributes\f[R] Optionally supplied fabric attributes. @@ -285,14 +271,14 @@ When provided as hints, requested values of struct fi_fabric_attr should be set. On output, the actual fabric attributes that can be provided will be returned. -See \f[V]fi_fabric\f[R](3) for details. +See \f[C]fi_fabric\f[R](3) for details. .TP \f[I]nic - network interface details\f[R] Optional attributes related to the hardware NIC associated with the specified fabric, domain, and endpoint data. This field is only valid for providers where the corresponding attributes are closely associated with a hardware NIC. -See \f[V]fi_nic\f[R](3) for details. +See \f[C]fi_nic\f[R](3) for details. .SH CAPABILITIES .PP Interface capabilities are obtained by OR-ing the following flags @@ -324,12 +310,12 @@ Requests that the provider support the association of a user specified identifier with each address vector (AV) address. User identifiers are returned with completion data in place of the AV address. -See \f[V]fi_domain\f[R](3) and \f[V]fi_av\f[R](3) for more details. +See \f[C]fi_domain\f[R](3) and \f[C]fi_av\f[R](3) for more details. .TP \f[I]FI_COLLECTIVE\f[R] Requests support for collective operations. Endpoints that support this capability support the collective operations -defined in \f[V]fi_collective\f[R](3). +defined in \f[C]fi_collective\f[R](3). .TP \f[I]FI_DIRECTED_RECV\f[R] Requests that the communication endpoint use the source address of an @@ -511,7 +497,7 @@ endpoint as send-only or receive-only. \f[I]FI_TRIGGER\f[R] Indicates that the endpoint should support triggered operations. Endpoints support this capability must meet the usage model as described -by \f[V]fi_trigger\f[R](3). +by \f[C]fi_trigger\f[R](3). .TP \f[I]FI_WRITE\f[R] Indicates that the user requires an endpoint capable of initiating @@ -522,7 +508,7 @@ This flag requires that FI_RMA and/or FI_ATOMIC be set. Specifies that the endpoint should support transfers that may be initiated from heterogenous computation devices, such as GPUs. This flag requires that FI_TRIGGER be set. -For additional details on XPU triggers see \f[V]fi_trigger\f[R](3). +For additional details on XPU triggers see \f[C]fi_trigger\f[R](3). .PP Capabilities may be grouped into three general categories: primary, secondary, and primary modifiers. @@ -626,8 +612,8 @@ application for access domains opened with this capability. This flag is defined for compatibility and is ignored if the application version is 1.5 or later and the domain mr_mode is set to anything other than FI_MR_BASIC or FI_MR_SCALABLE. -See the domain attribute mr_mode \f[V]fi_domain\f[R](3) and -\f[V]fi_mr\f[R](3). +See the domain attribute mr_mode \f[C]fi_domain\f[R](3) and +\f[C]fi_mr\f[R](3). .TP \f[I]FI_MSG_PREFIX\f[R] Message prefix mode indicates that an application will provide buffer @@ -687,7 +673,7 @@ these operations. A provider may support one or more of the following addressing formats. In some cases, a selected addressing format may need to be translated or mapped into an address which is native to the fabric. -See \f[V]fi_av\f[R](3). +See \f[C]fi_av\f[R](3). .TP \f[I]FI_ADDR_EFA\f[R] Address is an Amazon Elastic Fabric Adapter (EFA) proprietary format. @@ -775,7 +761,7 @@ This flag is often used with passive endpoints. fi_getinfo() returns 0 on success. On error, fi_getinfo() returns a negative value corresponding to fabric errno. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .PP fi_allocinfo() returns a pointer to a new fi_info structure on success, or NULL on error. @@ -830,11 +816,11 @@ by fi_getinfo. If neither node, service or hints are provided, then fi_getinfo simply returns the list all available communication interfaces. .PP -Multiple threads may call \f[V]fi_getinfo\f[R] simultaneously, without +Multiple threads may call \f[C]fi_getinfo\f[R] simultaneously, without any requirement for serialization. .SH SEE ALSO .PP -\f[V]fi_open\f[R](3), \f[V]fi_endpoint\f[R](3), \f[V]fi_domain\f[R](3), -\f[V]fi_nic\f[R](3) \f[V]fi_trigger\f[R](3) +\f[C]fi_open\f[R](3), \f[C]fi_endpoint\f[R](3), \f[C]fi_domain\f[R](3), +\f[C]fi_nic\f[R](3) \f[C]fi_trigger\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_mr.3 b/man/man3/fi_mr.3 index c651e29d73d..3c11b40fe5f 100644 --- a/man/man3/fi_mr.3 +++ b/man/man3/fi_mr.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_mr" "3" "2024\-10\-15" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_mr" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -717,7 +703,7 @@ specifying the FI_MR_DMABUF flag. The number of entries in the mr_iov array. The maximum number of memory buffers that may be associated with a single memory region is specified as the mr_iov_limit domain attribute. -See \f[V]fi_domain(3)\f[R]. +See \f[C]fi_domain(3)\f[R]. .SS access .PP Indicates the type of \f[I]operations\f[R] that the local or a peer @@ -799,7 +785,7 @@ This field is ignored unless the fabric is opened with API version 1.5 or greater. .PP If the domain is opened with FI_AV_AUTH_KEY, auth_key_size must equal -\f[V]sizeof(struct fi_mr_auth_key)\f[R]. +\f[C]sizeof(struct fi_mr_auth_key)\f[R]. .SS auth_key .PP Indicates the key to associate with this memory registration. @@ -812,7 +798,7 @@ This field is ignored unless the fabric is opened with API version 1.5 or greater. .PP If the domain is opened with FI_AV_AUTH_KEY, auth_key must point to a -user-defined \f[V]struct fi_mr_auth_key\f[R]. +user-defined \f[C]struct fi_mr_auth_key\f[R]. .SS iface .PP Indicates the software interfaces used by the application to allocate @@ -941,7 +927,7 @@ keys in the AV. .PP If the domain was opened with FI_DIRECTED_RECV, addr can be used to limit the memory region to a specific fi_addr_t, including -fi_addr_t\[cq]s return from \f[V]fi_av_insert_auth_key\f[R]. +fi_addr_t\[cq]s return from \f[C]fi_av_insert_auth_key\f[R]. .SH NOTES .PP Direct access to an application\[cq]s memory by a remote peer requires @@ -1071,7 +1057,7 @@ For example, the physical pages referenced by a virtual address range could migrate between host memory and GPU memory, depending on which computational unit is actively using it. .PP -See the \f[V]fi_endpoint\f[R](3) and \f[V]fi_cq\f[R](3) man pages for +See the \f[C]fi_endpoint\f[R](3) and \f[C]fi_cq\f[R](3) man pages for addition discussion on message, data, and completion ordering semantics, including the impact of memory domains. .SH RETURN VALUES @@ -1079,7 +1065,7 @@ including the impact of memory domains. Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .TP \f[I]-FI_ENOKEY\f[R] @@ -1185,8 +1171,8 @@ Some level of control over the cache is possible through the above mentioned environment variables. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_rma\f[R](3), \f[V]fi_msg\f[R](3), -\f[V]fi_atomic\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_rma\f[R](3), \f[C]fi_msg\f[R](3), +\f[C]fi_atomic\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_msg.3 b/man/man3/fi_msg.3 index 4343f68e1ad..5919225afc4 100644 --- a/man/man3/fi_msg.3 +++ b/man/man3/fi_msg.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_msg" "3" "2024\-10\-15" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_msg" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -79,7 +65,7 @@ Count of vectored data entries. .TP \f[I]desc\f[R] Descriptor associated with the data buffer. -See \f[V]fi_mr\f[R](3). +See \f[C]fi_mr\f[R](3). .TP \f[I]data\f[R] Remote CQ data to transfer with the sent message. @@ -156,7 +142,7 @@ parameter to a remote endpoint as a single message. The fi_sendmsg call supports data transfers over both connected and connectionless endpoints, with the ability to control the send operation per call through the use of flags. -The fi_sendmsg function takes a \f[V]struct fi_msg\f[R] as input. +The fi_sendmsg function takes a \f[C]struct fi_msg\f[R] as input. .IP .nf \f[C] @@ -279,7 +265,7 @@ Note that an entry to the associated receive completion queue will always be generated when the buffer has been consumed, even if other receive completions have been suppressed (i.e.\ the Rx context has been configured for FI_SELECTIVE_COMPLETION). -See the FI_MULTI_RECV completion flag \f[V]fi_cq\f[R](3). +See the FI_MULTI_RECV completion flag \f[C]fi_cq\f[R](3). .TP \f[I]FI_INJECT_COMPLETE\f[R] Applies to fi_sendmsg. @@ -294,7 +280,7 @@ tracked by the provider. For receive operations, indicates that a completion may be generated as soon as the message has been processed by the local provider, even if the message data may not be visible to all processing elements. -See \f[V]fi_cq\f[R](3) for target side completion semantics. +See \f[C]fi_cq\f[R](3) for target side completion semantics. .TP \f[I]FI_DELIVERY_COMPLETE\f[R] Applies to fi_sendmsg. @@ -340,7 +326,7 @@ buffer length. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .PP See the discussion below for details handling FI_EAGAIN. .SH ERRORS @@ -373,7 +359,7 @@ acknowledgements or flow control messages may need to be processed in order to resume execution. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_nic.3 b/man/man3/fi_nic.3 index c04a55d30e1..e64dfe31473 100644 --- a/man/man3/fi_nic.3 +++ b/man/man3/fi_nic.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_nic" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_nic" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -23,7 +9,7 @@ fi_nic - Fabric network interface card attributes .PP The fid_nic structure defines attributes for a struct fi_info that is directly associated with underlying networking hardware and may be -returned directly from calling \f[V]fi_getinfo\f[R](3). +returned directly from calling \f[C]fi_getinfo\f[R](3). The format of fid_nic and the related substructures are defined below. .PP Note that not all fields of all structures may be available. @@ -149,7 +135,7 @@ Ethernet or InfiniBand. .PP Provider attributes reference provider specific details of the device. These attributes are both provider and device specific. -The attributes can be interpreted by \f[V]fi_tostr\f[R](3). +The attributes can be interpreted by \f[C]fi_tostr\f[R](3). Applications may also use the other attribute fields, such as related fi_fabric_attr: prov_name field, to determine an appropriate structure to cast the attributes. @@ -159,10 +145,10 @@ specific header file included with libfabric package. .SH NOTES .PP The fid_nic structure is returned as part of a call to -\f[V]fi_getinfo\f[R](3). -It is automatically freed as part of calling \f[V]fi_freeinfo\f[R](3) +\f[C]fi_getinfo\f[R](3). +It is automatically freed as part of calling \f[C]fi_freeinfo\f[R](3) .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3) +\f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_peer.3 b/man/man3/fi_peer.3 index 1279c23dcd2..24b6464f9f3 100644 --- a/man/man3/fi_peer.3 +++ b/man/man3/fi_peer.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_peer" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_peer" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .TP @@ -287,8 +273,8 @@ If manual progress is needed on the peer CQ, the owner should drive progress by using the fi_cq_read() function with the buf parameter set to NULL and count equal 0. The peer provider should set other functions that attempt to read the -peer\[cq]s CQ (i.e.\ fi_cq_readerr, fi_cq_sread, etc.) -to return -FI_ENOSYS. +peer\[cq]s CQ (i.e.\ fi_cq_readerr, fi_cq_sread, etc.) to return +-FI_ENOSYS. .SS fi_ops_cq_owner::write() .PP This call directs the owner to insert new completions into the CQ. @@ -379,8 +365,8 @@ Similar to the peer CQ, if manual progress is needed on the peer counter, the owner should drive progress by using the fi_cntr_read() and the fi_cntr_read() should do nothing but progress the peer cntr. The peer provider should set other functions that attempt to access the -peer\[cq]s cntr (i.e.\ fi_cntr_readerr, fi_cntr_set, etc.) -to return -FI_ENOSYS. +peer\[cq]s cntr (i.e.\ fi_cntr_readerr, fi_cntr_set, etc.) to return +-FI_ENOSYS. .SS fi_ops_cntr_owner::inc() .PP This call directs the owner to increment the value of the cntr. @@ -815,9 +801,9 @@ callbacks. .PP Returns FI_SUCCESS on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH SEE ALSO .PP -\f[V]fi_provider\f[R](7), \f[V]fi_provider\f[R](3), \f[V]fi_cq\f[R](3), +\f[C]fi_provider\f[R](7), \f[C]fi_provider\f[R](3), \f[C]fi_cq\f[R](3), .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_poll.3 b/man/man3/fi_poll.3 index b49b9d35174..a3ee5cbbcb0 100644 --- a/man/man3/fi_poll.3 +++ b/man/man3/fi_poll.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_poll" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_poll" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -329,7 +315,7 @@ or fid. Returns FI_SUCCESS on success. On error, a negative value corresponding to fabric errno is returned. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .TP fi_poll On success, if events are available, returns the number of entries @@ -406,7 +392,7 @@ The use of the fi_trywait() function is still required if accessing wait objects directly. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_domain\f[R](3), \f[V]fi_cntr\f[R](3), -\f[V]fi_eq\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_domain\f[R](3), \f[C]fi_cntr\f[R](3), +\f[C]fi_eq\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_profile.3 b/man/man3/fi_profile.3 index f24305abf82..234a5a10f54 100644 --- a/man/man3/fi_profile.3 +++ b/man/man3/fi_profile.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_profile" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_profile" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -337,6 +323,6 @@ be returned. For fi_profile_query_vars and fi_profile_query_events, a positive return value indicates the number of variables or events returned in the list. .PP -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_provider.3 b/man/man3/fi_provider.3 index 0f123ba3246..4814ef7b6d8 100644 --- a/man/man3/fi_provider.3 +++ b/man/man3/fi_provider.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_provider" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_provider" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -197,7 +183,7 @@ the service or resource to which they correspond. The mr_cache object references the internal memory registration cache used by the different providers. Additional information on the cache is available in the -\f[V]fi_mr(3)\f[R] man page. +\f[C]fi_mr(3)\f[R] man page. .TP \f[I]logging\f[R] The logging object references the internal logging subsystem used by the @@ -207,8 +193,8 @@ Can be opened only once and only the last import is used if imported multiple times. .SS fi_import .PP -This helper function is a combination of \f[V]fi_open\f[R] and -\f[V]fi_import_fid\f[R]. +This helper function is a combination of \f[C]fi_open\f[R] and +\f[C]fi_import_fid\f[R]. It may be used to import a fabric object created and owned by the libfabric user. This allows the upper level libraries or the application to override or @@ -278,9 +264,9 @@ For integrated providers .PP Returns FI_SUCCESS on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_getinfo\f[R](3) \f[V]fi_mr\f[R](3), +\f[C]fabric\f[R](7), \f[C]fi_getinfo\f[R](3) \f[C]fi_mr\f[R](3), .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_rma.3 b/man/man3/fi_rma.3 index dea50502f69..236b922f418 100644 --- a/man/man3/fi_rma.3 +++ b/man/man3/fi_rma.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_rma" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_rma" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -92,7 +78,7 @@ FI_MR_SCALABLE. Protection key associated with the remote memory. .TP \f[I]desc\f[R] -Descriptor associated with the local data buffer See \f[V]fi_mr\f[R](3). +Descriptor associated with the local data buffer See \f[C]fi_mr\f[R](3). .TP \f[I]data\f[R] Remote CQ data to transfer with the operation. @@ -189,7 +175,7 @@ struct fi_rma_iov { .PP The write inject call is an optimized version of fi_write. It provides similar completion semantics as fi_inject -\f[V]fi_msg\f[R](3). +\f[C]fi_msg\f[R](3). .SS fi_writedata .PP The write data call is similar to fi_write, but allows for the sending @@ -290,15 +276,15 @@ operation (inclusive) to the posting of a subsequent fenced operation .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. -Fabric errno values are defined in \f[V]rdma/fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[R]. .SH ERRORS .TP \f[I]-FI_EAGAIN\f[R] -See \f[V]fi_msg\f[R](3) for a detailed description of handling +See \f[C]fi_msg\f[R](3) for a detailed description of handling FI_EAGAIN. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_tagged.3 b/man/man3/fi_tagged.3 index 399c4d278f9..7e11b18b037 100644 --- a/man/man3/fi_tagged.3 +++ b/man/man3/fi_tagged.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_tagged" "3" "2024\-10\-15" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_tagged" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -88,7 +74,7 @@ Mask of bits to ignore applied to the tag for receive operations. .TP \f[I]desc\f[R] Memory descriptor associated with the data buffer. -See \f[V]fi_mr\f[R](3). +See \f[C]fi_mr\f[R](3). .TP \f[I]data\f[R] Remote CQ data to transfer with the sent data. @@ -213,7 +199,7 @@ struct fi_msg_tagged { .PP The tagged inject call is an optimized version of fi_tsend. It provides similar completion semantics as fi_inject -\f[V]fi_msg\f[R](3). +\f[C]fi_msg\f[R](3). .SS fi_tsenddata .PP The tagged send data call is similar to fi_tsend, but allows for the @@ -301,7 +287,7 @@ Note that an entry to the associated receive completion queue will always be generated when the buffer has been consumed, even if other receive completions have been suppressed (i.e.\ the Rx context has been configured for FI_SELECTIVE_COMPLETION). -See the FI_MULTI_RECV completion flag \f[V]fi_cq\f[R](3). +See the FI_MULTI_RECV completion flag \f[C]fi_cq\f[R](3). .TP \f[I]FI_INJECT_COMPLETE\f[R] Applies to fi_tsendmsg. @@ -395,11 +381,11 @@ ignored. The tagged send and receive calls return 0 on success. On error, a negative value corresponding to fabric \f[I]errno \f[R] is returned. -Fabric errno values are defined in \f[V]fi_errno.h\f[R]. +Fabric errno values are defined in \f[C]fi_errno.h\f[R]. .SH ERRORS .TP \f[I]-FI_EAGAIN\f[R] -See \f[V]fi_msg\f[R](3) for a detailed description of handling +See \f[C]fi_msg\f[R](3) for a detailed description of handling FI_EAGAIN. .TP \f[I]-FI_EINVAL\f[R] @@ -409,7 +395,7 @@ Indicates that an invalid argument was supplied by the user. Indicates that an unspecified error occurred. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3), \f[V]fi_cq\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3), \f[C]fi_cq\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_trigger.3 b/man/man3/fi_trigger.3 index fea5833b591..38e85f16bfb 100644 --- a/man/man3/fi_trigger.3 +++ b/man/man3/fi_trigger.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_trigger" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_trigger" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -213,7 +199,7 @@ If a specific request is not supported by the provider, it will fail the operation with -FI_ENOSYS. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), \f[V]fi_mr\f[R](3), -\f[V]fi_alias\f[R](3), \f[V]fi_cntr\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), \f[C]fi_mr\f[R](3), +\f[C]fi_alias\f[R](3), \f[C]fi_cntr\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man3/fi_version.3 b/man/man3/fi_version.3 index 5352c05255e..b046adf9132 100644 --- a/man/man3/fi_version.3 +++ b/man/man3/fi_version.3 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_version" "3" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_version" "3" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -48,6 +34,6 @@ The upper 16-bits of the version correspond to the major number, and the lower 16-bits correspond with the minor number. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fabric.7 b/man/man7/fabric.7 index 73ed2109b19..b928c04ed89 100644 --- a/man/man7/fabric.7 +++ b/man/man7/fabric.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fabric" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fabric" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -30,7 +16,7 @@ fabric - Fabric Interface Library Libfabric is a high-performance fabric software library designed to provide low-latency interfaces to fabric hardware. For an in-depth discussion of the motivation and design see -\f[V]fi_guide\f[R](7). +\f[C]fi_guide\f[R](7). .SH OVERVIEW .PP Libfabric provides `process direct I/O' to application software @@ -51,7 +37,7 @@ All fabric hardware devices and their software drivers are required to support this framework. Devices and the drivers that plug into the libfabric framework are referred to as fabric providers, or simply providers. -Provider details may be found in \f[V]fi_provider\f[R](7). +Provider details may be found in \f[C]fi_provider\f[R](7). .TP \f[I]Fabric Interfaces\f[R] The second component is a set of communication operations. @@ -296,18 +282,18 @@ If the list begins with the `\[ha]' symbol, then the list will be negated. .PP Example: To enable the udp and tcp providers only, set: -\f[V]FI_PROVIDER=\[dq]udp,tcp\[dq]\f[R] +\f[C]FI_PROVIDER=\[dq]udp,tcp\[dq]\f[R] .PP When libfabric is installed, DL providers are put under the \f[I]default provider path\f[R], which is determined by how libfabric is built and installed. Usually the default provider path is -\f[V]/lib/libfabric\f[R] or -\f[V]/lib64/libfabric\f[R]. +\f[C]/lib/libfabric\f[R] or +\f[C]/lib64/libfabric\f[R]. By default, libfabric tries to find DL providers in the following order: .IP "1." 3 Use `dlopen' to load provider libraries named -\f[V]lib-fi.so\f[R] for all providers enabled at build time. +\f[C]lib-fi.so\f[R] for all providers enabled at build time. The search path of `ld.so' is used to locate the files. This step is skipped if libfabric is configured with the option `\[en]enable-restricted-dl'. @@ -377,7 +363,7 @@ can be used to retrieve information about which providers are available in the system. Additionally, it can retrieve a list of all environment variables that may be used to configure libfabric and each provider. -See \f[V]fi_info\f[R](1) for more details. +See \f[C]fi_info\f[R](1) for more details. .SH ENVIRONMENT VARIABLE CONTROLS .PP Core features of libfabric and its providers may be configured by an @@ -414,22 +400,22 @@ may not be available in a child process because of copy on write restrictions. .SS CUDA deadlock .PP -In some cases, calls to \f[V]cudaMemcpy()\f[R] within libfabric may +In some cases, calls to \f[C]cudaMemcpy()\f[R] within libfabric may result in a deadlock. This typically occurs when a CUDA kernel blocks until a -\f[V]cudaMemcpy\f[R] on the host completes. +\f[C]cudaMemcpy\f[R] on the host completes. Applications which can cause such behavior can restrict Libfabric\[cq]s ability to invoke CUDA API operations with the endpoint option -\f[V]FI_OPT_CUDA_API_PERMITTED\f[R]. -See \f[V]fi_endpoint\f[R](3) for more details. +\f[C]FI_OPT_CUDA_API_PERMITTED\f[R]. +See \f[C]fi_endpoint\f[R](3) for more details. .PP Another mechanism which can be used to avoid deadlock is Nvidia\[cq]s GDRCopy. Using GDRCopy requires an external library and kernel module available at https://github.com/NVIDIA/gdrcopy. Libfabric must be configured with GDRCopy support using the -\f[V]--with-gdrcopy\f[R] option, and be run with -\f[V]FI_HMEM_CUDA_USE_GDRCOPY=1\f[R]. +\f[C]--with-gdrcopy\f[R] option, and be run with +\f[C]FI_HMEM_CUDA_USE_GDRCOPY=1\f[R]. This may not be supported by all providers. .SH ABI CHANGES .PP @@ -523,9 +509,9 @@ Added new fields to the following attributes: Added max_group_id .SH SEE ALSO .PP -\f[V]fi_info\f[R](1), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3), -\f[V]fi_endpoint\f[R](3), \f[V]fi_domain\f[R](3), \f[V]fi_av\f[R](3), -\f[V]fi_eq\f[R](3), \f[V]fi_cq\f[R](3), \f[V]fi_cntr\f[R](3), -\f[V]fi_mr\f[R](3) +\f[C]fi_info\f[R](1), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3), +\f[C]fi_endpoint\f[R](3), \f[C]fi_domain\f[R](3), \f[C]fi_av\f[R](3), +\f[C]fi_eq\f[R](3), \f[C]fi_cq\f[R](3), \f[C]fi_cntr\f[R](3), +\f[C]fi_mr\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_arch.7 b/man/man7/fi_arch.7 index 6bd4ad0abc5..fe62ebd155b 100644 --- a/man/man7/fi_arch.7 +++ b/man/man7/fi_arch.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_arch" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_arch" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .IP .nf diff --git a/man/man7/fi_cxi.7 b/man/man7/fi_cxi.7 index 0360e4cb466..a81b6dd18b7 100644 --- a/man/man7/fi_cxi.7 +++ b/man/man7/fi_cxi.7 @@ -1,21 +1,7 @@ -'\" t -.\" Automatically generated by Pandoc 3.1.3 +.\"t +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_cxi" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_cxi" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -190,7 +176,7 @@ Classes. .PP While a libfabric user provided authorization key is optional, it is highly encouraged that libfabric users provide an authorization key -through the domain attribute hints during \f[V]fi_getinfo()\f[R]. +through the domain attribute hints during \f[C]fi_getinfo()\f[R]. How libfabric users acquire the authorization key may vary between the users and is outside the scope of this document. .PP @@ -206,18 +192,18 @@ authorization key using them. .IP \[bu] 2 \f[I]SLINGSHOT_VNIS\f[R]: Comma separated list of VNIs. The CXI provider will only use the first VNI if multiple are provide. -Example: \f[V]SLINGSHOT_VNIS=234\f[R]. +Example: \f[C]SLINGSHOT_VNIS=234\f[R]. .IP \[bu] 2 \f[I]SLINGSHOT_DEVICES\f[R]: Comma separated list of device names. Each device index will use the same index to lookup the service ID in \f[I]SLINGSHOT_SVC_IDS\f[R]. -Example: \f[V]SLINGSHOT_DEVICES=cxi0,cxi1\f[R]. +Example: \f[C]SLINGSHOT_DEVICES=cxi0,cxi1\f[R]. .IP \[bu] 2 \f[I]SLINGSHOT_SVC_IDS\f[R]: Comma separated list of pre-configured CXI service IDs. Each service ID index will use the same index to lookup the CXI device in \f[I]SLINGSHOT_DEVICES\f[R]. -Example: \f[V]SLINGSHOT_SVC_IDS=5,6\f[R]. +Example: \f[C]SLINGSHOT_SVC_IDS=5,6\f[R]. .PP \f[B]Note:\f[R] How valid VNIs and device services are configured is outside the responsibility of the CXI provider. @@ -622,7 +608,7 @@ into the fi_control(FI_QUEUE_WORK) critical path. The following subsections outline the CXI provider fork support. .SS RDMA and Fork Overview .PP -Under Linux, \f[V]fork()\f[R] is implemented using copy-on-write (COW) +Under Linux, \f[C]fork()\f[R] is implemented using copy-on-write (COW) pages, so the only penalty that it incurs is the time and memory required to duplicate the parent\[cq]s page tables, mark all of the process\[cq]s page structs as read only and COW, and create a unique @@ -665,22 +651,22 @@ The crux of the issue is the parent issuing forks while trying to do RDMA operations to registered memory regions. Excluding software RDMA emulation, two options exist for RDMA NIC vendors to resolve this data corruption issue. -- Linux \f[V]madvise()\f[R] MADV_DONTFORK and MADV_DOFORK - RDMA NIC +- Linux \f[C]madvise()\f[R] MADV_DONTFORK and MADV_DOFORK - RDMA NIC support for on-demand paging (ODP) .SS Linux madvise() MADV_DONTFORK and MADV_DOFORK .PP The generic (i.e.\ non-vendor specific) RDMA NIC solution to the Linux COW fork policy and RDMA problem is to use the following -\f[V]madvise()\f[R] operations during memory registration and +\f[C]madvise()\f[R] operations during memory registration and deregistration: - MADV_DONTFORK: Do not make the pages in this range -available to the child after a \f[V]fork()\f[R]. +available to the child after a \f[C]fork()\f[R]. This is useful to prevent copy-on-write semantics from changing the physical location of a page if the parent writes to it after a -\f[V]fork()\f[R]. +\f[C]fork()\f[R]. (Such page relocations cause problems for hardware that DMAs into the -page.) -- MADV_DOFORK: Undo the effect of MADV_DONTFORK, restoring the default -behavior, whereby a mapping is inherited across \f[V]fork()\f[R]. +page.) - MADV_DOFORK: Undo the effect of MADV_DONTFORK, restoring the +default behavior, whereby a mapping is inherited across +\f[C]fork()\f[R]. .PP In the Linux kernel, MADV_DONTFORK will result in the virtual memory area struct (VMA) being marked with the VM_DONTCOPY flag. @@ -691,14 +677,14 @@ Should the child reference the virtual address corresponding to the VMA which was not duplicated, it will segfault. .PP In the previous example, if Process A issued -\f[V]madvise(0xffff0000, 4096, MADV_DONTFORK)\f[R] before performing +\f[C]madvise(0xffff0000, 4096, MADV_DONTFORK)\f[R] before performing RDMA memory registration, the physical address 0x1000 would have remained with Process A. This would prevent the Process A data corruption as well. If Process B were to reference virtual address 0xffff0000, it will segfault due to the hole in the virtual address space. .PP -Using \f[V]madvise()\f[R] with MADV_DONTFORK may be problematic for +Using \f[C]madvise()\f[R] with MADV_DONTFORK may be problematic for applications performing RDMA and page aliasing. Paging aliasing is where the parent process uses part or all of a page to share information with the child process. @@ -752,7 +738,7 @@ The CXI provider is subjected to the Linux COW fork policy and RDMA issues described in section \f[I]RDMA and Fork Overview\f[R]. To prevent data corruption with fork, the CXI provider supports the following options: - CXI specific fork environment variables to enable -\f[V]madvise()\f[R] MADV_DONTFORK and MADV_DOFORK - ODP Support* +\f[C]madvise()\f[R] MADV_DONTFORK and MADV_DOFORK - ODP Support* .PP **Formal ODP support pending.* .SS CXI Specific Fork Environment Variables @@ -760,27 +746,27 @@ following options: - CXI specific fork environment variables to enable The CXI software stack has two environment variables related to fork: 0 CXI_FORK_SAFE: Enables base fork safe support. With this environment variable set, regardless of value, libcxi will -issue \f[V]madvise()\f[R] with MADV_DONTFORK on the virtual address +issue \f[C]madvise()\f[R] with MADV_DONTFORK on the virtual address range being registered for RDMA. -In addition, libcxi always align the \f[V]madvise()\f[R] to the system +In addition, libcxi always align the \f[C]madvise()\f[R] to the system default page size. On x86, this is 4 KiB. -To prevent redundant \f[V]madvise()\f[R] calls with MADV_DONTFORK +To prevent redundant \f[C]madvise()\f[R] calls with MADV_DONTFORK against the same virtual address region, reference counting is used -against each tracked \f[V]madvise()\f[R] region. -In addition, libcxi will spilt and merge tracked \f[V]madvise()\f[R] +against each tracked \f[C]madvise()\f[R] region. +In addition, libcxi will spilt and merge tracked \f[C]madvise()\f[R] regions if needed. Once the reference count reaches zero, libcxi will call -\f[V]madvise()\f[R] with MADV_DOFORK, and no longer track the region. +\f[C]madvise()\f[R] with MADV_DOFORK, and no longer track the region. - CXI_FORK_SAFE_HP: With this environment variable set, in conjunction with CXI_FORK_SAFE, libcxi will not assume the page size is system default page size. -Instead, libcxi will walk \f[V]/proc//smaps\f[R] to determine the -correct page size and align the \f[V]madvise()\f[R] calls accordingly. +Instead, libcxi will walk \f[C]/proc//smaps\f[R] to determine the +correct page size and align the \f[C]madvise()\f[R] calls accordingly. This environment variable should be set if huge pages are being used for RDMA. To amortize the per memory registration walk of -\f[V]/proc//smaps\f[R], the libfabric MR cache should be used. +\f[C]/proc//smaps\f[R], the libfabric MR cache should be used. .PP Setting these environment variables will prevent data corruption when the parent issues a fork. @@ -814,7 +800,7 @@ transfer. The following is the CXI provider fork support guidance: - Enable CXI_FORK_SAFE. If huge pages are also used, CXI_FORK_SAFE_HP should be enabled as well. -Since enabling this will result in \f[V]madvice()\f[R] with +Since enabling this will result in \f[C]madvice()\f[R] with MADV_DONTFORK, the following steps should be taken to prevent a child process segfault: - Avoid using stack memory for RDMA - Avoid child process having to access a virtual address range the parent process is @@ -1565,6 +1551,14 @@ GPU direct RDMA may or may not work in this case. Enable enforcement of triggered operation limit. Doing this can prevent fi_control(FI_QUEUE_WORK) deadlocking at the cost of performance. +.TP +\f[I]FI_CXI_MR_CACHE_EVENTS_DISABLE_POLL_NSECS\f[R] +Max amount of time to poll when disabling an MR configured with MR match +events. +.TP +\f[I]FI_CXI_MR_CACHE_EVENTS_DISABLE_LE_POLL_NSECS\f[R] +Max amount of time to poll when LE invalidate disabling an MR configured +with MR match events. .PP Note: Use the fi_info utility to query provider environment variables: fi_info -p cxi -e @@ -1630,7 +1624,7 @@ It can only be changed prior to any MR being created. .PP CXI domain extensions have been named \f[I]FI_CXI_DOM_OPS_6\f[R]. The flags parameter is ignored. -The fi_open_ops function takes a \f[V]struct fi_cxi_dom_ops\f[R]. +The fi_open_ops function takes a \f[C]struct fi_cxi_dom_ops\f[R]. See an example of usage below: .IP .nf @@ -1660,10 +1654,10 @@ struct fi_cxi_dom_ops { \f[R] .fi .PP -\f[I]cntr_read\f[R] extension is used to read hardware counter values. -Valid values of the cntr argument are found in the Cassini-specific -header file cassini_cntr_defs.h. -Note that Counter accesses by applications may be rate-limited to 1HZ. +\f[I]cntr_read\f[R] extension is used to read Cassini Telemetry items +that consists of counters and gauges. +The items available and their content are dependent upon the Cassini +ASIC version and Cassini Driver version. .PP \f[I]topology\f[R] extension is used to return CXI NIC address topology information for the domain. @@ -1723,7 +1717,7 @@ removed from the domain opts prior to software release 2.2. .PP CXI counter extensions have been named \f[I]FI_CXI_COUNTER_OPS\f[R]. The flags parameter is ignored. -The fi_open_ops function takes a \f[V]struct fi_cxi_cntr_ops\f[R]. +The fi_open_ops function takes a \f[C]struct fi_cxi_cntr_ops\f[R]. See an example of usage below. .IP .nf @@ -1852,7 +1846,7 @@ memory operation as a PCIe operation as compared to a NIC operation. The CXI provider extension flag FI_CXI_PCIE_AMO is used to signify this. .PP Since not all libfabric atomic memory operations can be executed as a -PCIe atomic memory operation, \f[V]fi_query_atomic()\f[R] could be used +PCIe atomic memory operation, \f[C]fi_query_atomic()\f[R] could be used to query if a given libfabric atomic memory operation could be executed as PCIe atomic memory operation. .PP @@ -1902,7 +1896,7 @@ module parameter must be set to non-zero. .IP .nf \f[C] -/sys/module/cxi_core/parameters/amo_remap_to_pcie_fadd +/sys/module/cxi_ss1/parameters/amo_remap_to_pcie_fadd \f[R] .fi .PP @@ -2170,6 +2164,6 @@ In this case, the target NIC is reachable. FI_EIO: Catch all errno. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_direct.7 b/man/man7/fi_direct.7 index c014a10b104..3f9c6a34870 100644 --- a/man/man7/fi_direct.7 +++ b/man/man7/fi_direct.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_direct" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_direct" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -85,7 +71,7 @@ The provider sets FI_LOCAL_MR for fi_info:mode. See fi_getinfo for additional details. .SH SEE ALSO .PP -\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), -\f[V]fi_domain\f[R](3) +\f[C]fi_getinfo\f[R](3), \f[C]fi_endpoint\f[R](3), +\f[C]fi_domain\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_efa.7 b/man/man7/fi_efa.7 index 24809adde15..ed99b5a3e8a 100644 --- a/man/man7/fi_efa.7 +++ b/man/man7/fi_efa.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_efa" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_efa" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -109,7 +95,7 @@ No support for counters for the DGRAM endpoint. No support for inject. .SS zero-copy receive mode .IP \[bu] 2 -The receive operation cannot be cancelled via \f[V]fi_cancel()\f[R]. +The receive operation cannot be cancelled via \f[C]fi_cancel()\f[R]. .IP \[bu] 2 Zero-copy receive mode can be enabled only if SHM transfer is disabled. .IP \[bu] 2 @@ -180,12 +166,12 @@ If endpoint is not able to support this feature, it will return .PP The efa provider exports extensions for operations that are not provided by the standard libfabric interface. -These extensions are available via the \[lq]\f[V]fi_ext_efa.h\f[R]\[rq] +These extensions are available via the \[lq]\f[C]fi_ext_efa.h\f[R]\[rq] header file. .SS Domain Operation Extension .PP -Domain operation extension is obtained by calling \f[V]fi_open_ops\f[R] -(see \f[V]fi_domain(3)\f[R]) +Domain operation extension is obtained by calling \f[C]fi_open_ops\f[R] +(see \f[C]fi_domain(3)\f[R]) .IP .nf \f[C] @@ -194,9 +180,9 @@ int fi_open_ops(struct fid *domain, const char *name, uint64_t flags, \f[R] .fi .PP -and requesting \f[V]FI_EFA_DOMAIN_OPS\f[R] in \f[V]name\f[R]. -\f[V]fi_open_ops\f[R] returns \f[V]ops\f[R] as the pointer to the -function table \f[V]fi_efa_ops_domain\f[R] defined as follows: +and requesting \f[C]FI_EFA_DOMAIN_OPS\f[R] in \f[C]name\f[R]. +\f[C]fi_open_ops\f[R] returns \f[C]ops\f[R] as the pointer to the +function table \f[C]fi_efa_ops_domain\f[R] defined as follows: .IP .nf \f[C] @@ -238,20 +224,20 @@ FI_EFA_MR_ATTR_RDMA_RECV_IC_ID: rdma_recv_ic_id has a valid value. \f[I]recv_ic_id\f[R] Physical interconnect used by the device to reach the MR for receive operation. -It is only valid when \f[V]ic_id_validity\f[R] has the -\f[V]FI_EFA_MR_ATTR_RECV_IC_ID\f[R] bit. +It is only valid when \f[C]ic_id_validity\f[R] has the +\f[C]FI_EFA_MR_ATTR_RECV_IC_ID\f[R] bit. .TP \f[I]rdma_read_ic_id\f[R] Physical interconnect used by the device to reach the MR for RDMA read operation. -It is only valid when \f[V]ic_id_validity\f[R] has the -\f[V]FI_EFA_MR_ATTR_RDMA_READ_IC_ID\f[R] bit. +It is only valid when \f[C]ic_id_validity\f[R] has the +\f[C]FI_EFA_MR_ATTR_RDMA_READ_IC_ID\f[R] bit. .TP \f[I]rdma_recv_ic_id\f[R] Physical interconnect used by the device to reach the MR for RDMA write receive. -It is only valid when \f[V]ic_id_validity\f[R] has the -\f[V]FI_EFA_MR_ATTR_RDMA_RECV_IC_ID\f[R] bit. +It is only valid when \f[C]ic_id_validity\f[R] has the +\f[C]FI_EFA_MR_ATTR_RDMA_RECV_IC_ID\f[R] bit. .SS Return value .PP \f[B]query_mr()\f[R] returns 0 on success, or the value of errno on @@ -259,7 +245,7 @@ failure (which indicates the failure reason). .SH Traffic Class (tclass) in EFA .PP To prioritize the messages from a given endpoint, user can specify -\f[V]fi_info->tx_attr->tclass = FI_TC_LOW_LATENCY\f[R] in the +\f[C]fi_info->tx_attr->tclass = FI_TC_LOW_LATENCY\f[R] in the fi_endpoint() call to set the service level in rdma-core. All other tclass values will be ignored. .SH RUNTIME PARAMETERS @@ -342,7 +328,7 @@ to a peer after a receiver not ready error. Enable SHM provider to provide the communication across all intra-node processes. SHM transfer will be disabled in the case where -\f[V]ptrace protection\f[R] is turned on. +\f[C]ptrace protection\f[R] is turned on. You can turn it off to enable shm transfer. .PP FI_EFA_ENABLE_SHM_TRANSFER is parsed during the fi_domain call and is @@ -437,6 +423,6 @@ available. Setting this environment variable to 0 can disable this feature. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_guide.7 b/man/man7/fi_guide.7 index 00befca6279..3917b17b1ea 100644 --- a/man/man7/fi_guide.7 +++ b/man/man7/fi_guide.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_guide" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_guide" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -34,16 +20,16 @@ This guide describes the libfabric architecture and interfaces. Due to the length of the guide, it has been broken into multiple pages. These sections are: .TP -\f[I]Introduction \f[VI]fi_intro\f[I](7)\f[R] +\f[I]Introduction \f[BI]\f[CBI]fi_intro\f[BI]\f[I](7)\f[R] This section provides insight into the motivation for the libfabric design and underlying networking features that are being exposed through the API. .TP -\f[I]Architecture \f[VI]fi_arch\f[I](7)\f[R] +\f[I]Architecture \f[BI]\f[CBI]fi_arch\f[BI]\f[I](7)\f[R] This describes the exposed architecture of libfabric, including the object-model and their related operations .TP -\f[I]Setup \f[VI]fi_setup\f[I](7)\f[R] +\f[I]Setup \f[BI]\f[CBI]fi_setup\f[BI]\f[I](7)\f[R] This provides basic bootstrapping and setup for using the libfabric API. .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_hook.7 b/man/man7/fi_hook.7 index 6e52f716321..714c8a1f46b 100644 --- a/man/man7/fi_hook.7 +++ b/man/man7/fi_hook.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_hook" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_hook" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -180,6 +166,6 @@ Application that use FI_TRIGGER operations that attempt to hook calls will likely crash. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_intro.7 b/man/man7/fi_intro.7 index e15ccf34126..c6965739ae0 100644 --- a/man/man7/fi_intro.7 +++ b/man/man7/fi_intro.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_intro" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_intro" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -22,7 +8,7 @@ fi_intro - libfabric introduction .SH OVERVIEW .PP This introduction is part of the libfabric\[cq]s programmer\[cq]s guide. -See \f[V]fi_guide\f[R](7). +See \f[C]fi_guide\f[R](7). This section provides insight into the motivation for the libfabric design and underlying networking features that are being exposed through the API. @@ -1138,9 +1124,9 @@ If an application is using 1000 endpoints and posts 100 buffers, each 4 KB, that results in 400 MB of memory space being consumed to receive data. (We can start to realize that by eliminating memory copies, one of the -trade offs is increased memory consumption.) -While 400 MB seems like a lot of memory, there is less than half a -megabyte allocated to a single receive queue. +trade offs is increased memory consumption.) While 400 MB seems like a +lot of memory, there is less than half a megabyte allocated to a single +receive queue. At today\[cq]s networking speeds, that amount of space can be consumed within milliseconds. The result is that if only a few endpoints are in use, the application @@ -1429,6 +1415,6 @@ but it does allow for optimizing network utilization. Libfabric is well architected to support the previously discussed features. For further information on the libfabric architecture, see the next -programmer\[cq]s guide section: \f[V]fi_arch\f[R](7). +programmer\[cq]s guide section: \f[C]fi_arch\f[R](7). .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_lpp.7 b/man/man7/fi_lpp.7 index 5b8626464bc..05e0d9a3f03 100644 --- a/man/man7/fi_lpp.7 +++ b/man/man7/fi_lpp.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_lpp" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_lpp" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -88,6 +74,6 @@ Use the memcpy implementation in the system libc rather than provider-specific memcpy. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_mrail.7 b/man/man7/fi_mrail.7 index cd608b1e134..2939f3b6f30 100644 --- a/man/man7/fi_mrail.7 +++ b/man/man7/fi_mrail.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_mrail" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_mrail" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -97,18 +83,18 @@ Deprecated. Replaced by \f[I]FI_OFI_MRAIL_ADDR\f[R]. .TP \f[I]FI_OFI_MRAIL_CONFIG\f[R] -Comma separated list of \f[V]:\f[R] pairs, sorted in -ascending order of \f[V]\f[R]. +Comma separated list of \f[C]:\f[R] pairs, sorted in +ascending order of \f[C]\f[R]. Each pair indicated the rail sharing policy to be used for messages up -to the size \f[V]\f[R] and not covered by all previous pairs. -The value of \f[V]\f[R] can be \f[I]fixed\f[R] (a fixed rail is +to the size \f[C]\f[R] and not covered by all previous pairs. +The value of \f[C]\f[R] can be \f[I]fixed\f[R] (a fixed rail is used), \f[I]round-robin\f[R] (one rail per message, selected in round-robin fashion), or \f[I]striping\f[R] (striping across all the rails). -The default configuration is \f[V]16384:fixed,ULONG_MAX:striping\f[R]. +The default configuration is \f[C]16384:fixed,ULONG_MAX:striping\f[R]. The value ULONG_MAX can be input as -1. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_opx.7 b/man/man7/fi_opx.7 index 170ed2bdccc..2a5fbf57c42 100644 --- a/man/man7/fi_opx.7 +++ b/man/man7/fi_opx.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_opx" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_opx" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .PP {%include JB/setup %} @@ -172,35 +158,35 @@ Defaults to \[lq]No\[rq] \f[I]FI_OPX_HFI_SELECT\f[R] String. Controls how OPX chooses which HFI to use when opening a context. -Has two forms: - \f[V]\f[R] Force OPX provider to use -\f[V]hfi-unit\f[R]. -- \f[V][,[,...,]]\f[R] Select HFI based -on first matching \f[V]selector\f[R] +Has two forms: - \f[C]\f[R] Force OPX provider to use +\f[C]hfi-unit\f[R]. +- \f[C][,[,...,]]\f[R] Select HFI based +on first matching \f[C]selector\f[R] .PP -Where \f[V]selector\f[R] is one of the following forms: - -\f[V]default\f[R] to use the default logic - \f[V]fixed:\f[R] -to fix to one \f[V]hfi-unit\f[R] - -\f[V]::\f[R] +Where \f[C]selector\f[R] is one of the following forms: - +\f[C]default\f[R] to use the default logic - \f[C]fixed:\f[R] +to fix to one \f[C]hfi-unit\f[R] - +\f[C]::\f[R] .PP -The above fields have the following meaning: - \f[V]selector-type\f[R] +The above fields have the following meaning: - \f[C]selector-type\f[R] The selector criteria the caller opening the context is evaluated against. -- \f[V]hfi-unit\f[R] The HFI to use if the caller matches the selector. -- \f[V]selector-data\f[R] Data the caller must match (e.g.\ NUMA node +- \f[C]hfi-unit\f[R] The HFI to use if the caller matches the selector. +- \f[C]selector-data\f[R] Data the caller must match (e.g.\ NUMA node ID). .PP -Where \f[V]selector-type\f[R] is one of the following: - \f[V]numa\f[R] +Where \f[C]selector-type\f[R] is one of the following: - \f[C]numa\f[R] True when caller is local to the NUMA node ID given by -\f[V]selector-data\f[R]. -- \f[V]core\f[R] True when caller is local to the CPU core given by -\f[V]selector-data\f[R]. +\f[C]selector-data\f[R]. +- \f[C]core\f[R] True when caller is local to the CPU core given by +\f[C]selector-data\f[R]. .PP -And \f[V]selector-data\f[R] is one of the following: - \f[V]value\f[R] -The specific value to match - \f[V]-\f[R] +And \f[C]selector-data\f[R] is one of the following: - \f[C]value\f[R] +The specific value to match - \f[C]-\f[R] Matches with any value in that range .PP In the second form, when opening a context, OPX uses the -\f[V]hfi-unit\f[R] of the first-matching selector. +\f[C]hfi-unit\f[R] of the first-matching selector. Selectors are evaluated left-to-right. OPX will return an error if the caller does not match any selector. .PP @@ -216,27 +202,27 @@ For the second form, as which HFI is selected depends on properties of the caller, deterministic HFI selection requires deterministic caller properties. E.g. -for the \f[V]numa\f[R] selector, if the caller can migrate between NUMA +for the \f[C]numa\f[R] selector, if the caller can migrate between NUMA domains, then HFI selection will not be deterministic. .PP The logic used will always be the first valid in a selector list. -For example, \f[V]default\f[R] and \f[V]fixed\f[R] will match all +For example, \f[C]default\f[R] and \f[C]fixed\f[R] will match all callers, so if either are in the beginning of a selector list, you will -only use \f[V]fixed\f[R] or \f[V]default\f[R] regardles of if there are +only use \f[C]fixed\f[R] or \f[C]default\f[R] regardles of if there are any more selectors. .PP -Examples: - \f[V]FI_OPX_HFI_SELECT=0\f[R] all callers will open contexts +Examples: - \f[C]FI_OPX_HFI_SELECT=0\f[R] all callers will open contexts on HFI 0. -- \f[V]FI_OPX_HFI_SELECT=1\f[R] all callers will open contexts on HFI 1. -- \f[V]FI_OPX_HFI_SELECT=numa:0:0,numa:1:1,numa:0:2,numa:1:3\f[R] +- \f[C]FI_OPX_HFI_SELECT=1\f[R] all callers will open contexts on HFI 1. +- \f[C]FI_OPX_HFI_SELECT=numa:0:0,numa:1:1,numa:0:2,numa:1:3\f[R] callers local to NUMA nodes 0 and 2 will use HFI 0, callers local to NUMA domains 1 and 3 will use HFI 1. -- \f[V]FI_OPX_HFI_SELECT=numa:0:0-3,default\f[R] callers local to NUMA +- \f[C]FI_OPX_HFI_SELECT=numa:0:0-3,default\f[R] callers local to NUMA nodes 0 thru 3 (including 0 and 3) will use HFI 0, and all else will use default selection logic. -- \f[V]FI_OPX_HFI_SELECT=core:1:0,fixed:0\f[R] callers local to CPU core +- \f[C]FI_OPX_HFI_SELECT=core:1:0,fixed:0\f[R] callers local to CPU core 0 will use HFI 1, and all others will use HFI 0. -- \f[V]FI_OPX_HFI_SELECT=default,core:1:0\f[R] all callers will use +- \f[C]FI_OPX_HFI_SELECT=default,core:1:0\f[R] all callers will use default HFI selection logic. .TP \f[I]FI_OPX_DELIVERY_COMPLETION_THRESHOLD\f[R] @@ -288,9 +274,9 @@ This feature is not currently supported. \f[I]FI_OPX_PROG_AFFINITY\f[R] String. This sets the affinity to be used for any progress threads. -Set as a colon-separated triplet as \f[V]start:end:stride\f[R], where +Set as a colon-separated triplet as \f[C]start:end:stride\f[R], where stride controls the interval between selected cores. -For example, \f[V]1:5:2\f[R] will have cores 1, 3, and 5 as valid cores +For example, \f[C]1:5:2\f[R] will have cores 1, 3, and 5 as valid cores for progress threads. By default no affinity is set. .TP @@ -334,6 +320,6 @@ Needs to be set to 1 in case of mixed network. Default is 0. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_provider.7 b/man/man7/fi_provider.7 index 7d71f23f586..571ec75e21f 100644 --- a/man/man7/fi_provider.7 +++ b/man/man7/fi_provider.7 @@ -1,27 +1,13 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_provider" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_provider" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP fi_provider - Fabric Interface Providers .SH OVERVIEW .PP -See \f[V]fi_arch\f[R](7) for a brief description of how providers fit +See \f[C]fi_arch\f[R](7) for a brief description of how providers fit into the libfabric architecture. .PP Conceptually, a fabric provider implements and maps the libfabric API @@ -88,52 +74,52 @@ This list is not exhaustive. .TP \f[I]CXI\f[R] Provider for Cray\[cq]s Slingshot network. -See \f[V]fi_cxi\f[R](7) for more information. +See \f[C]fi_cxi\f[R](7) for more information. .TP \f[I]EFA\f[R] A provider for the Amazon EC2 Elastic Fabric Adapter (EFA) (https://aws.amazon.com/hpc/efa/), a custom-built OS bypass hardware interface for inter-instance communication on EC2. -See \f[V]fi_efa\f[R](7) for more information. +See \f[C]fi_efa\f[R](7) for more information. .TP \f[I]OPX\f[R] Supports Omni-Path networking from Cornelis Networks. -See \f[V]fi_opx\f[R](7) for more information. +See \f[C]fi_opx\f[R](7) for more information. .TP \f[I]PSM2\f[R] Older provider for Omni-Path networks. -See \f[V]fi_psm2\f[R](7) for more information. +See \f[C]fi_psm2\f[R](7) for more information. .TP \f[I]PSM3\f[R] Provider for Ethernet networking from Intel. -See \f[V]fi_psm3\f[R](7) for more information. +See \f[C]fi_psm3\f[R](7) for more information. .TP \f[I]SHM\f[R] A provider for intra-node communication using shared memory. -See \f[V]fi_shm\f[R](7) for more information. +See \f[C]fi_shm\f[R](7) for more information. .TP \f[I]TCP\f[R] A provider which runs over the TCP/IP protocol and is available on multiple operating systems. This provider enables develop of libfabric applications on most platforms. -See \f[V]fi_tcp\f[R](7) for more information. +See \f[C]fi_tcp\f[R](7) for more information. .TP \f[I]UCX\f[R] A provider which runs over the UCX library which is currently supported by Infiniband fabrics from NVIDIA. -See \f[V]fi_ucx\f[R](7) for more information. +See \f[C]fi_ucx\f[R](7) for more information. .TP \f[I]UDP\f[R] A provider which runs over the UDP/IP protocol and is available on multiple operating systems. This provider enables develop of libfabric applications on most platforms. -See \f[V]fi_udp\f[R](7) for more information. +See \f[C]fi_udp\f[R](7) for more information. .TP \f[I]Verbs\f[R] This provider targets RDMA NICs for both Linux and Windows platforms. -See \f[V]fi_verbs\f[R](7) for more information. +See \f[C]fi_verbs\f[R](7) for more information. .SH Utility Providers .PP Utility providers are named with a starting prefix of \[lq]ofi_\[rq]. @@ -146,17 +132,17 @@ simpler endpoint type. .PP Utility providers show up as part of the return\[cq]s provider\[cq]s name. -See \f[V]fi_fabric\f[R](3). +See \f[C]fi_fabric\f[R](3). Utility providers are enabled automatically for core providers that do not support the feature set requested by an application. .TP \f[I]RxM\f[R] Implements RDM endpoint semantics over MSG endpoints. -See \f[V]fi_rxm\f[R](7) for more information. +See \f[C]fi_rxm\f[R](7) for more information. .TP \f[I]RxD\f[R] Implements RDM endpoint semantis over DGRAM endpoints. -See \f[V]fi_rxd\f[R](7) for more information. +See \f[C]fi_rxd\f[R](7) for more information. .SH Hooking Providers .PP Hooking providers are mostly used for debugging purposes. @@ -167,7 +153,7 @@ Hooking providers can layer over all other providers and intercept, or hook, their calls in order to perform some dedicated task, such as gathering performance data on call paths or providing debug output. .PP -See \f[V]fi_hook\f[R](7) for more information. +See \f[C]fi_hook\f[R](7) for more information. .SH Offload Providers .PP Offload providers start with the naming prefix \[lq]off_\[rq]. @@ -179,6 +165,6 @@ have been offloaded into hardware, though actual hardware offload support is not a requirement. .SH SEE ALSO .PP -\f[V]fabric\f[R](7) \f[V]fi_provider\f[R](3) +\f[C]fabric\f[R](7) \f[C]fi_provider\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_psm2.7 b/man/man7/fi_psm2.7 index a64cc54a270..8233bc835ab 100644 --- a/man/man7/fi_psm2.7 +++ b/man/man7/fi_psm2.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_psm2" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_psm2" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -228,11 +214,11 @@ See \f[I]FI_PSM2_PROG_AFFINITY\f[R]. When set, specify the set of CPU cores to set the progress thread affinity to. The format is -\f[V][:[:]][,[:[:]]]*\f[R], -where each triplet \f[V]::\f[R] defines a block of +\f[C][:[:]][,[:[:]]]*\f[R], +where each triplet \f[C]::\f[R] defines a block of core_ids. -Both \f[V]\f[R] and \f[V]\f[R] can be either the -\f[V]core_id\f[R] (when >=0) or \f[V]core_id - num_cores\f[R] (when <0). +Both \f[C]\f[R] and \f[C]\f[R] can be either the +\f[C]core_id\f[R] (when >=0) or \f[C]core_id - num_cores\f[R] (when <0). .PP By default affinity is not set. .TP @@ -338,6 +324,6 @@ Valid parameter names are defined in the header file \f[I]rdma/fi_ext_psm2.h\f[R]. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_psm3\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_psm3\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_psm3.7 b/man/man7/fi_psm3.7 index 2b95e16ebc9..892fea3f805 100644 --- a/man/man7/fi_psm3.7 +++ b/man/man7/fi_psm3.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_psm3" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_psm3" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -25,7 +11,7 @@ The \f[I]psm3\f[R] provider implements a Performance Scaled Messaging capability which supports most verbs UD and sockets devices. Additional features and optimizations can be enabled when running over Intel\[cq]s E810 Ethernet NICs and/or using Intel\[cq]s rendezvous -kernel module (\f[V]rv\f[R]). +kernel module (\f[C]rv\f[R]). PSM 3.x fully integrates the OFI provider and the underlying PSM3 protocols/implementation and only exports the OFI APIs. .SH SUPPORTED FEATURES @@ -223,11 +209,11 @@ See \f[I]FI_PSM3_PROG_AFFINITY\f[R]. When set, specify the set of CPU cores to set the progress thread affinity to. The format is -\f[V][:[:]][,[:[:]]]*\f[R], -where each triplet \f[V]::\f[R] defines a block of +\f[C][:[:]][,[:[:]]]*\f[R], +where each triplet \f[C]::\f[R] defines a block of core_ids. -Both \f[V]\f[R] and \f[V]\f[R] can be either the -\f[V]core_id\f[R] (when >=0) or \f[V]core_id - num_cores\f[R] (when <0). +Both \f[C]\f[R] and \f[C]\f[R] can be either the +\f[C]core_id\f[R] (when >=0) or \f[C]core_id - num_cores\f[R] (when <0). .PP By default affinity is not set. .TP @@ -318,6 +304,6 @@ Notice that if the provider is compiled with macro runtime option will be disabled. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_psm2\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_psm2\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_rxd.7 b/man/man7/fi_rxd.7 index a87b61ac96b..1bf65d50151 100644 --- a/man/man7/fi_rxd.7 +++ b/man/man7/fi_rxd.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_rxd" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_rxd" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -75,6 +61,6 @@ Maximum number of packets (per peer) to send at a time. Default: 128 .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_rxm.7 b/man/man7/fi_rxm.7 index 33c293ebb01..c683dde87b1 100644 --- a/man/man7/fi_rxm.7 +++ b/man/man7/fi_rxm.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_rxm" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_rxm" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -226,7 +212,7 @@ to only required values. .PP The data transfer API may return -FI_EAGAIN during on-demand connection setup of the core provider FI_MSG_EP. -See \f[V]fi_msg\f[R](3) for a detailed description of handling +See \f[C]fi_msg\f[R](3) for a detailed description of handling FI_EAGAIN. .SH Troubleshooting / Known issues .PP @@ -243,6 +229,6 @@ The workaround is to use shared receive contexts for the MSG provider (FI_OFI_RXM_MSG_TX_SIZE / FI_OFI_RXM_MSG_RX_SIZE). .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_setup.7 b/man/man7/fi_setup.7 index a7126fbdd89..44cad0029c6 100644 --- a/man/man7/fi_setup.7 +++ b/man/man7/fi_setup.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_setup" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_setup" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -473,9 +459,8 @@ libfabric defines a unique threading model. The libfabric design is heavily influenced by object-oriented programming concepts. A multi-threaded application must determine how libfabric objects -(domains, endpoints, completion queues, etc.) -will be allocated among its threads, or if any thread can access any -object. +(domains, endpoints, completion queues, etc.) will be allocated among +its threads, or if any thread can access any object. For example, an application may spawn a new thread to handle each new connected endpoint. The domain threading field provides a mechanism for an application to diff --git a/man/man7/fi_shm.7 b/man/man7/fi_shm.7 index 7b9d24db54d..ff7c5f241bb 100644 --- a/man/man7/fi_shm.7 +++ b/man/man7/fi_shm.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_shm" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_shm" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -103,7 +89,7 @@ was provided by the application), no supplemental information is required to make it unique and it will remain with only the application-defined address. Note that the actual endpoint name will not include the FI_ADDR_STR -\[lq]*://\[rq] prefix since it cannot be included in any shared memory +\[dq]*://\[dq] prefix since it cannot be included in any shared memory region names. The provider will strip off the prefix before setting the endpoint name. As a result, the addresses \[lq]fi_prefix1://my_node:my_service\[rq] and @@ -218,6 +204,6 @@ different systems. Default 262144 .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_sockets.7 b/man/man7/fi_sockets.7 index bd9b568ce93..1af06fc6eba 100644 --- a/man/man7/fi_sockets.7 +++ b/man/man7/fi_sockets.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_sockets" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_sockets" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -142,6 +128,6 @@ The recommended parameters for large scale runs are \f[I]FI_SOCKETS_DEF_CQ_SZ\f[R], \f[I]FI_SOCKETS_DEF_EQ_SZ\f[R]. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_tcp.7 b/man/man7/fi_tcp.7 index 3f661e6ec0b..7d291ccae3e 100644 --- a/man/man7/fi_tcp.7 +++ b/man/man7/fi_tcp.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_tcp" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_tcp" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -128,6 +114,6 @@ from the tcp provider. This will provide the best performance. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_ucx.7 b/man/man7/fi_ucx.7 index d160b304a13..a4928235e12 100644 --- a/man/man7/fi_ucx.7 +++ b/man/man7/fi_ucx.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_ucx" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_ucx" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -66,6 +52,6 @@ any). Check request leak (default: disabled). .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_udp.7 b/man/man7/fi_udp.7 index 5c5a5915e0f..8da3619cb8d 100644 --- a/man/man7/fi_udp.7 +++ b/man/man7/fi_udp.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_udp" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_udp" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -65,6 +51,6 @@ No support for counters. No runtime parameters are currently defined. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3) +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3) .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_usnic.7 b/man/man7/fi_usnic.7 index 01f035652b5..c351d23f01b 100644 --- a/man/man7/fi_usnic.7 +++ b/man/man7/fi_usnic.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_usnic" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_usnic" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -43,7 +29,7 @@ installing libnl from RPM or other packaging system, install the If you have libnl (either v1 or v3) installed in a non-standard location (e.g., not in /usr/lib or /usr/lib64), you may need to tell libfabric\[cq]s configure where to find libnl via the -\f[V]--with-libnl=DIR\f[R] command line option (where DIR is the +\f[C]--with-libnl=DIR\f[R] command line option (where DIR is the installation prefix of the libnl package). .RE .IP \[bu] 2 @@ -70,7 +56,7 @@ In particular, there are known bugs in RDM support in the presence of congestion or packet loss (issue 1621). RMA is not yet supported. .IP \[bu] 2 -\f[V]fi_provider\f[R](7) lists requirements for all providers. +\f[C]fi_provider\f[R](7) lists requirements for all providers. The following limitations exist in the \f[I]usnic\f[R] provider: .RS 2 .IP \[bu] 2 @@ -83,13 +69,13 @@ CM operations. Passive endpoints only support listen, setname, and getname CM operations. .IP \[bu] 2 -\f[I]FI_EP_DGRAM\f[R] endpoints support \f[V]fi_sendmsg()\f[R] and -\f[V]fi_recvmsg()\f[R], but some flags are ignored. -\f[V]fi_sendmsg()\f[R] supports \f[V]FI_INJECT\f[R] and -\f[V]FI_COMPLETION\f[R]. -\f[V]fi_recvmsg()\f[R] supports \f[V]FI_MORE\f[R]. +\f[I]FI_EP_DGRAM\f[R] endpoints support \f[C]fi_sendmsg()\f[R] and +\f[C]fi_recvmsg()\f[R], but some flags are ignored. +\f[C]fi_sendmsg()\f[R] supports \f[C]FI_INJECT\f[R] and +\f[C]FI_COMPLETION\f[R]. +\f[C]fi_recvmsg()\f[R] supports \f[C]FI_MORE\f[R]. .IP \[bu] 2 -Address vectors only support \f[V]FI_AV_MAP\f[R]. +Address vectors only support \f[C]FI_AV_MAP\f[R]. .IP \[bu] 2 No counters are supported. .IP \[bu] 2 @@ -133,19 +119,19 @@ file. Version 2 of the \[lq]fabric getinfo\[rq] extension was introduced in Libfabric release v1.3.0 and can be used to retrieve IP and SR-IOV information about a usNIC device obtained from the -\f[V]fi_getinfo\f[R](3) function. +\f[C]fi_getinfo\f[R](3) function. .PP The \[lq]fabric getinfo\[rq] extension is obtained by calling -\f[V]fi_open_ops\f[R] and requesting \f[V]FI_USNIC_FABRIC_OPS_1\f[R] to +\f[C]fi_open_ops\f[R] and requesting \f[C]FI_USNIC_FABRIC_OPS_1\f[R] to get the usNIC fabric extension operations. -The \f[V]getinfo\f[R] function accepts a version parameter that can be +The \f[C]getinfo\f[R] function accepts a version parameter that can be used to select different versions of the extension. The information returned by the \[lq]fabric getinfo\[rq] extension is -accessible through a \f[V]fi_usnic_info\f[R] struct that uses a version +accessible through a \f[C]fi_usnic_info\f[R] struct that uses a version tagged union. The accessed union member must correspond with the requested version. It is recommended that applications explicitly request a version rather -than using the header provided \f[V]FI_EXT_USNIC_INFO_VERSION\f[R]. +than using the header provided \f[C]FI_EXT_USNIC_INFO_VERSION\f[R]. Although there is a version 1 of the extension, its use is discouraged, and it may not be available in future releases. .SS Compatibility issues @@ -258,8 +244,8 @@ struct fi_usnic_info_v1 { .fi .PP Version 1 of the \[lq]fabric getinfo\[rq] extension can be used by -explicitly requesting it in the call to \f[V]getinfo\f[R] and accessing -the \f[V]v1\f[R] portion of the \f[V]fi_usnic_info.ui\f[R] union. +explicitly requesting it in the call to \f[C]getinfo\f[R] and accessing +the \f[C]v1\f[R] portion of the \f[C]fi_usnic_info.ui\f[R] union. Use of version 1 is not recommended and it may be removed from future releases. .PP @@ -341,7 +327,7 @@ Libfabric release v1.0.0 and can be used to retrieve the network distance of an address. .PP The \[lq]get_distance\[rq] extension is obtained by calling -\f[V]fi_open_ops\f[R] and requesting \f[V]FI_USNIC_AV_OPS_1\f[R] to get +\f[C]fi_open_ops\f[R] and requesting \f[C]FI_USNIC_AV_OPS_1\f[R] to get the usNIC address vector extension operations. .IP .nf @@ -357,9 +343,9 @@ Address vector Destination address .TP \f[I]metric\f[R] -On output this will contain \f[V]-1\f[R] if the destination host is -unreachable, \f[V]0\f[R] is the destination host is locally connected, -and \f[V]1\f[R] otherwise. +On output this will contain \f[C]-1\f[R] if the destination host is +unreachable, \f[C]0\f[R] is the destination host is locally connected, +and \f[C]1\f[R] otherwise. .PP See fi_ext_usnic.h for more details. .SH VERSION DIFFERENCES @@ -369,28 +355,28 @@ The release of libfabric v1.4 introduced a new naming convention for fabric and domain. However the usNIC provider remains backward compatible with applications supporting the old scheme and decides which one to use based on the -version passed to \f[V]fi_getinfo\f[R]: +version passed to \f[C]fi_getinfo\f[R]: .IP \[bu] 2 -When \f[V]FI_VERSION(1,4)\f[R] or higher is used: +When \f[C]FI_VERSION(1,4)\f[R] or higher is used: .RS 2 .IP \[bu] 2 fabric name is the network address with the CIDR notation (i.e., -\f[V]a.b.c.d/e\f[R]) +\f[C]a.b.c.d/e\f[R]) .IP \[bu] 2 -domain name is the usNIC Linux interface name (i.e., \f[V]usnic_X\f[R]) +domain name is the usNIC Linux interface name (i.e., \f[C]usnic_X\f[R]) .RE .IP \[bu] 2 -When a lower version number is used, like \f[V]FI_VERSION(1, 3)\f[R], it +When a lower version number is used, like \f[C]FI_VERSION(1, 3)\f[R], it follows the same behavior the usNIC provider exhibited in libfabric <= v1.3: .RS 2 .IP \[bu] 2 -fabric name is the usNIC Linux interface name (i.e., \f[V]usnic_X\f[R]) +fabric name is the usNIC Linux interface name (i.e., \f[C]usnic_X\f[R]) .IP \[bu] 2 -domain name is \f[V]NULL\f[R] +domain name is \f[C]NULL\f[R] .RE .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_open_ops\f[R](3), \f[V]fi_provider\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_open_ops\f[R](3), \f[C]fi_provider\f[R](7), .SH AUTHORS OpenFabrics. diff --git a/man/man7/fi_verbs.7 b/man/man7/fi_verbs.7 index 866829ed8e0..c5ffb67d719 100644 --- a/man/man7/fi_verbs.7 +++ b/man/man7/fi_verbs.7 @@ -1,20 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.3 +.\" Automatically generated by Pandoc 2.9.2.1 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "fi_verbs" "7" "2024\-10\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_verbs" "7" "2024\-10\-17" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -161,7 +147,7 @@ to be re-mapped when the process is forked (MADV_DONTFORK). .PP The XRC transport is intended to be used when layered with the RXM provider and requires the use of shared receive contexts. -See \f[V]fi_rxm\f[R](7). +See \f[C]fi_rxm\f[R](7). To enable XRC, the following environment variables must usually be set: FI_VERBS_PREFER_XRC and FI_OFI_RXM_USE_SRX. .SH RUNTIME PARAMETERS @@ -294,6 +280,6 @@ post excess receives without draining the CQ. CQ overruns can make the MSG endpoints unusable. .SH SEE ALSO .PP -\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), +\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), .SH AUTHORS OpenFabrics.