.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "fi_sockets" "7" "2022\-12\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.hy
.SH NAME
.PP
fi_sockets - The Sockets Fabric Provider
.SH OVERVIEW
.PP
The sockets provider is being deprecated in favor of the tcp, udp, and
utility providers.
Further work on the sockets provider will be minimal.
Most applications should instead use the tcp provider instead.
.PP
The sockets provider is a general purpose provider that can be used on
any system that supports TCP sockets.
The provider is not intended to provide performance improvements over
regular TCP sockets, but rather to allow developers to write, test, and
debug application code even on platforms that do not have
high-performance fabric hardware.
The sockets provider supports all libfabric provider requirements and
interfaces.
.SH SUPPORTED FEATURES
.PP
The sockets provider supports all the features defined for the libfabric
API.
Key features include:
.TP
\f[I]Endpoint types\f[R]
The provider supports all endpoint types: \f[I]FI_EP_MSG\f[R],
\f[I]FI_EP_RDM\f[R], and \f[I]FI_EP_DGRAM\f[R].
.TP
\f[I]Endpoint capabilities\f[R]
The following data transfer interface is supported for a all endpoint
types: \f[I]fi_msg\f[R].
Additionally, these interfaces are supported for reliable endpoints
(\f[I]FI_EP_MSG\f[R] and \f[I]FI_EP_RDM\f[R]): \f[I]fi_tagged\f[R],
\f[I]fi_atomic\f[R], and \f[I]fi_rma\f[R].
.TP
\f[I]Modes\f[R]
The sockets provider supports all operational modes including
\f[I]FI_CONTEXT\f[R] and \f[I]FI_MSG_PREFIX\f[R].
.TP
\f[I]Progress\f[R]
Sockets provider supports both \f[I]FI_PROGRESS_AUTO\f[R] and
\f[I]FI_PROGRESS_MANUAL\f[R], with a default set to auto.
When progress is set to auto, a background thread runs to ensure that
progress is made for asynchronous requests.
.SH LIMITATIONS
.PP
Sockets provider attempts to emulate the entire API set, including all
defined options.
In order to support development on a wide range of systems, it is
implemented over TCP sockets.
As a result, the performance numbers are lower compared to other
providers implemented over high-speed fabric, and lower than what an
application might see implementing to sockets directly.
.PP
Does not support FI_ADDR_STR address format.
.SH RUNTIME PARAMETERS
.PP
The sockets provider checks for the following environment variables -
.TP
\f[I]FI_SOCKETS_PE_WAITTIME\f[R]
An integer value that specifies how many milliseconds to spin while
waiting for progress in \f[I]FI_PROGRESS_AUTO\f[R] mode.
.TP
\f[I]FI_SOCKETS_CONN_TIMEOUT\f[R]
An integer value that specifies how many milliseconds to wait for one
connection establishment.
.TP
\f[I]FI_SOCKETS_MAX_CONN_RETRY\f[R]
An integer value that specifies the number of socket connection retries
before reporting as failure.
.TP
\f[I]FI_SOCKETS_DEF_CONN_MAP_SZ\f[R]
An integer to specify the default connection map size.
.TP
\f[I]FI_SOCKETS_DEF_AV_SZ\f[R]
An integer to specify the default address vector size.
.TP
\f[I]FI_SOCKETS_DEF_CQ_SZ\f[R]
An integer to specify the default completion queue size.
.TP
\f[I]FI_SOCKETS_DEF_EQ_SZ\f[R]
An integer to specify the default event queue size.
.TP
\f[I]FI_SOCKETS_DGRAM_DROP_RATE\f[R]
An integer value to specify the drop rate of dgram frame when endpoint
is \f[I]FI_EP_DGRAM\f[R].
This is for debugging purpose only.
.TP
\f[I]FI_SOCKETS_PE_AFFINITY\f[R]
If specified, progress thread is bound to the indicated range(s) of
Linux virtual processor ID(s).
This option is currently not supported on OS X.
The usage is - id_start[-id_end[:stride]][,].
.TP
\f[I]FI_SOCKETS_KEEPALIVE_ENABLE\f[R]
A boolean to enable the keepalive support.
.TP
\f[I]FI_SOCKETS_KEEPALIVE_TIME\f[R]
An integer to specify the idle time in seconds before sending the first
keepalive probe.
Only relevant if \f[I]FI_SOCKETS_KEEPALIVE_ENABLE\f[R] is enabled.
.TP
\f[I]FI_SOCKETS_KEEPALIVE_INTVL\f[R]
An integer to specify the time in seconds between individual keepalive
probes.
Only relevant if \f[I]FI_SOCKETS_KEEPALIVE_ENABLE\f[R] is enabled.
.TP
\f[I]FI_SOCKETS_KEEPALIVE_PROBES\f[R]
An integer to specify the maximum number of keepalive probes sent before
dropping the connection.
Only relevant if \f[I]FI_SOCKETS_KEEPALIVE_ENABLE\f[R] is enabled.
.TP
\f[I]FI_SOCKETS_IFACE\f[R]
The prefix or the name of the network interface (default: any)
.SH LARGE SCALE JOBS
.PP
For large scale runs one can use these environment variables to set the
default parameters e.g.\ size of the address vector(AV), completion
queue (CQ), connection map etc.
that satisfies the requirement of the particular benchmark.
The recommended parameters for large scale runs are
\f[I]FI_SOCKETS_MAX_CONN_RETRY\f[R],
\f[I]FI_SOCKETS_DEF_CONN_MAP_SZ\f[R], \f[I]FI_SOCKETS_DEF_AV_SZ\f[R],
\f[I]FI_SOCKETS_DEF_CQ_SZ\f[R], \f[I]FI_SOCKETS_DEF_EQ_SZ\f[R].
.SH SEE ALSO
.PP
\f[C]fabric\f[R](7), \f[C]fi_provider\f[R](7), \f[C]fi_getinfo\f[R](3)
.SH AUTHORS
OpenFabrics.