Skip to content

Commit 1224c82

Browse files
ofiwg-botj-xiong
authored andcommitted
Updated nroff-generated man pages
Signed-off-by: OFIWG Bot <[email protected]>
1 parent 21898d1 commit 1224c82

File tree

1 file changed

+49
-11
lines changed

1 file changed

+49
-11
lines changed

man/man7/fi_opx.7

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "fi_opx" "7" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
17+
.TH "fi_opx" "7" "2025\-02\-28" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
1818
.hy
1919
.PP
2020
{%include JB/setup %}
@@ -137,7 +137,7 @@ This variable can be set with FI_OPX_UUID=${RANDOM} The default UUID is
137137
00112233445566778899aabbccddeeff.
138138
.TP
139139
\f[I]FI_OPX_FORCE_CPUAFFINITY\f[R]
140-
Boolean (0/1, on/off, true/false, yes/no).
140+
Boolean (1/0, on/off, true/false, yes/no).
141141
Causes the thread to bind itself to the cpu core it is running on.
142142
Defaults to \[lq]No\[rq]
143143
.TP
@@ -180,7 +180,7 @@ Default setting is 4.
180180
Range of valid values is 1-65535.
181181
.TP
182182
\f[I]FI_OPX_SELINUX\f[R]
183-
Boolean (0/1, on/off, true/false, yes/no).
183+
Boolean (1/0, on/off, true/false, yes/no).
184184
Set to true if you\[cq]re running a security-enhanced Linux.
185185
This enables updating the Jkey used based on system settings.
186186
Defaults to \[lq]No\[rq]
@@ -255,6 +255,14 @@ default selection logic.
255255
- \f[V]FI_OPX_HFI_SELECT=default,core:1:0\f[R] all callers will use
256256
default HFI selection logic.
257257
.TP
258+
\f[I]FI_OPX_PORT\f[R]
259+
Integer.
260+
HFI1 port number.
261+
If the specified port is not available, a default active port will be
262+
selected.
263+
Special value 0 indicates any available port.
264+
Defaults to port 1 on OPA100 and any port on CN5000.
265+
.TP
258266
\f[I]FI_OPX_DELIVERY_COMPLETION_THRESHOLD\f[R]
259267
Integer.
260268
Will be deprecated.
@@ -270,9 +278,9 @@ Value must be between 16385 and 2147483646.
270278
Defaults to 16385.
271279
.TP
272280
\f[I]FI_OPX_SDMA_DISABLE\f[R]
273-
Integer.
281+
Boolean (1/0, on/off, true/false, yes/no).
274282
Disables SDMA offload hardware.
275-
Default is 0
283+
Default is 0.
276284
.TP
277285
\f[I]FI_OPX_SDMA_MIN_PAYLOAD_BYTES\f[R]
278286
Integer.
@@ -299,15 +307,18 @@ Value must be between 64 and 65536.
299307
Defaults to 16385.
300308
.TP
301309
\f[I]FI_OPX_MP_EAGER_DISABLE\f[R]
302-
Integer.
310+
Boolean (1/0, on/off, true/false, yes/no).
303311
Disables multi-packet eager.
304312
Defaults to 0.
305313
.TP
314+
\f[I]FI_OPX_TID_DISABLE\f[R]
315+
Boolean (1/0, on/off, true/false, yes/no).
316+
Disables using Token ID (TID).
317+
Defaults to 0.
318+
.TP
306319
\f[I]FI_OPX_EXPECTED_RECEIVE_ENABLE\f[R]
307-
Boolean (0/1, on/off, true/false, yes/no).
308-
Enables expected receive rendezvous using Token ID (TID).
309-
Defaults to \[lq]No\[rq].
310-
This feature is not currently supported.
320+
Deprecated.
321+
Use FI_OPX_TID_DISABLE instead.
311322
.TP
312323
\f[I]FI_OPX_PROG_AFFINITY\f[R]
313324
String.
@@ -327,7 +338,8 @@ Default is 1.
327338
\f[I]FI_OPX_PKEY\f[R]
328339
Integer.
329340
Partition key, a 2 byte positive integer.
330-
Default is 0x8001
341+
Default is the Pkey in the index 0 of the Pkey table of the unit and
342+
port on which context is created.
331343
.TP
332344
\f[I]FI_OPX_SL\f[R]
333345
Integer.
@@ -356,6 +368,32 @@ Integer.
356368
Indicates that the network is a mix of OPA100 and CN5000.
357369
Needs to be set to 1 in case of mixed network.
358370
Default is 0.
371+
.TP
372+
\f[I]FI_OPX_ROUTE_CONTROL\f[R]
373+
Integer.
374+
Specify the route control for each packet type.
375+
The format is -
376+
\f[V]<inject packet type value>:<eager packet type value>:<multi-packet eager packet type value>:<dput packet type value>:<rendezvous control packet value>:<rendezvous data packet value>\f[R].
377+
.PP
378+
Each value can range from 0-7.
379+
0-3 is used for in-order and 4-7 is used for out-of-order.
380+
If Token ID (TID) is enabled the out-of-order route controls are
381+
disabled.
382+
.PP
383+
Default is \f[V]0:0:0:0:0:0\f[R] on OPA100 and \f[V]4:4:4:4:0:4\f[R] on
384+
CN5000.
385+
.TP
386+
\f[I]FI_OPX_SHM_ENABLE\f[R]
387+
Boolean (1/0, on/off, true/false, yes/no).
388+
Enables shm across all ports and hfi units on the node.
389+
Setting it to NO disables shm except peers with same lid and same hfi1
390+
(loopback).
391+
Defaults to: \[lq]YES\[rq]
392+
.TP
393+
\f[I]FI_OPX_LINK_DOWN_WAIT_TIME_MAX_SEC\f[R]
394+
Integer.
395+
The maximum time in seconds to wait for a link to come back up.
396+
Default is 70 seconds.
359397
.SH SEE ALSO
360398
.PP
361399
\f[V]fabric\f[R](7), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](7),

0 commit comments

Comments
 (0)