1fi_tcp(7)                      Libfabric v1.17.0                     fi_tcp(7)
2
3
4

NAME

6       fi_tcp - The msg sockets Fabric Provider
7

OVERVIEW

9       The  tcp  provider can be used on any system that supports TCP sockets.
10       The provider is not intended to provide performance  improvements  over
11       regular  TCP sockets, but rather to allow developers to write, test,and
12       debug application code even on platforms that do not have  high-perfor‐
13       mance fabric hardware.
14

SUPPORTED FEATURES

16       The following features are supported
17
18       Endpoint types
19              FI_EP_MSG  is  the only supported endpoint type.  Reliable data‐
20              gram endpoint over TCP sockets can be achieved by  layering  RxM
21              over  tcp  provider.  FI_EP_RDM is supported by layering ofi_rxm
22              provider on top of the tcp provider.
23
24       Endpoint capabilities
25              The tcp provider currently supports FI_MSG, FI_RMA
26
27       Progress
28              Currently tcp provider supports only FI_PROGRESS_MANUAL
29
30       Shared Rx Context
31              The tcp provider supports shared receive context
32
33       Multi recv buffers
34              The tcp provider supports multi recv buffers
35

RUNTIME PARAMETERS

37       The tcp provider check for the following environment variables -
38
39       FI_TCP_IFACE
40              A specific network interface can be requested with this variable
41
42       FI_TCP_PORT_LOW_RANGE/FI_TCP_PORT_HIGH_RANGE
43              These variables are used to set the range of ports to be used by
44              the  tcp  provider  for  its passive endpoint creation.  This is
45              useful where only a range of ports are allowed by  firewall  for
46              tcp connections.
47
48       FI_TCP_TX_SIZE
49              Default tx context size (default: 256)
50
51       FI_TCP_RX_SIZE
52              Default rx context size (default: 256)
53

LIMITATIONS

55       The  tcp  provider is implemented over TCP sockets to emulate libfabric
56       API.  Hence the performance may be lower than what an application might
57       see  implementing  to  sockets directly, depending on the types of data
58       transfers the application is trying to achieve.
59

SEE ALSO

61       fabric(7), fi_provider(7), fi_getinfo(3)
62

AUTHORS

64       OpenFabrics.
65
66
67
68Libfabric Programmer’s Manual     2022-12-11                         fi_tcp(7)