Skip to content

Commit 0262d27

Browse files
ofiwg-botj-xiong
authored andcommitted
Updated nroff-generated man pages
Signed-off-by: OFIWG Bot <ofiwg@lists.openfabrics.org>
1 parent f02e49f commit 0262d27

File tree

4 files changed

+82
-4
lines changed

4 files changed

+82
-4
lines changed

man/man1/fi_info.1

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "fi_info" "1" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
17+
.TH "fi_info" "1" "2026\-02\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
1818
.hy
1919
.SH NAME
2020
.PP
@@ -213,6 +213,10 @@ fi_info:
213213
max_err_data: 0
214214
mr_cnt: 0
215215
tclass: 0x0
216+
max_ep_auth_key: 0
217+
max_group_id: 0
218+
max_cntr_value: 18446744073709551615
219+
max_err_cntr_value: 18446744073709551615
216220
fi_fabric_attr:
217221
name: IB-0xfe80000000000000
218222
prov_name: verbs;ofi_rxd

man/man3/fi_cntr.3

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "fi_cntr" "3" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
17+
.TH "fi_cntr" "3" "2026\-02\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
1818
.hy
1919
.SH NAME
2020
.PP
@@ -251,10 +251,37 @@ See fi_eq.3 for addition details using control with FI_GETWAIT.
251251
.SS fi_cntr_read
252252
.PP
253253
The fi_cntr_read call returns the current value of the counter.
254+
.PP
255+
Applications must manage counter values that approach the limit defined
256+
by the domain attribute \f[V]max_cntr_value\f[R].
257+
This value, which defaults to UINT64_MAX but may be lower due to
258+
provider limitations, defines the maximum value returned by
259+
fi_cntr_read().
260+
.PP
261+
When a counter reaches its maximum value and additional operations
262+
complete, the counter behavior will be undefined.
263+
Applications that need to track the total number of operations beyond
264+
the provider\[cq]s counter limits are responsible for detecting and
265+
handling this condition by resetting counters with \f[V]fi_cntr_set\f[R]
266+
before they reach the maximum, or it could result in incorrect values.
254267
.SS fi_cntr_readerr
255268
.PP
256269
The read error call returns the number of operations that completed in
257270
error and were unable to update the counter.
271+
.PP
272+
Applications must manage error counter values that approach the limit
273+
defined by the domain attribute \f[V]max_err_cntr_value\f[R].
274+
This value, which defaults to UINT64_MAX but may be lower due to
275+
provider limitations, defines the maximum value returned by
276+
fi_cntr_readerr().
277+
.PP
278+
When an error counter reaches its maximum value and additional error
279+
operations complete, the counter behavior will be undefined.
280+
Applications that need to track the total number of error operations
281+
beyond the provider\[cq]s counter limits are responsible for detecting
282+
and handling this condition by resetting the error counters with
283+
\f[V]fi_cntr_set\f[R] before they reach the maximum, or it could result
284+
in incorrect values.
258285
.SS fi_cntr_add
259286
.PP
260287
This adds the user-specified value to the counter.

man/man3/fi_domain.3

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
. ftr VB CB
1616
. ftr VBI CBI
1717
.\}
18-
.TH "fi_domain" "3" "2025\-03\-06" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
18+
.TH "fi_domain" "3" "2026\-02\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
1919
.hy
2020
.SH NAME
2121
.PP
@@ -228,6 +228,8 @@ struct fi_domain_attr {
228228
uint32_t tclass;
229229
size_t max_ep_auth_key;
230230
uint32_t max_group_id;
231+
uint64_t max_cntr_value;
232+
uint64_t max_err_cntr_value;
231233
};
232234
\f[R]
233235
.fi
@@ -1029,6 +1031,43 @@ Providers that cannot meet the requested max_group_id will fail
10291031
fi_getinfo().
10301032
On output, providers may return a value higher than that requested by
10311033
the application.
1034+
.SS Maximum Counter Value (max_cntr_value)
1035+
.PP
1036+
The maximum value returned by fi_cntr_read.
1037+
While counters use uint64_t, the full range may not be supported due to
1038+
hardware limitations.
1039+
This field allows providers to advertise their specific limits.
1040+
The default value is UINT64_MAX, which indicates the full counter range.
1041+
A value of 0 means the provider does not set the limit and should be
1042+
treated the same as the default value.
1043+
.PP
1044+
Applications may provide a non-zero max_cntr_value as input to
1045+
fi_getinfo to request a minimum supported counter range.
1046+
If the provider cannot satisfy the requested range, it should return
1047+
-FI_ENODATA.
1048+
The provider may return a value larger than the one requested.
1049+
.PP
1050+
Applications must manage counter values that approach this limit.
1051+
See \f[V]fi_cntr\f[R](3) for details on counter limit handling
1052+
responsibilities.
1053+
.SS Maximum Error Counter Value (max_err_cntr_value)
1054+
.PP
1055+
The maximum value returned by fi_cntr_readerr.
1056+
Similar to max_cntr_value, this addresses provider-specific limitations
1057+
for error counter ranges.
1058+
The default value is UINT64_MAX, which indicates the full counter range.
1059+
A value of 0 means the provider does not set the limit and should be
1060+
treated the same as the default value.
1061+
.PP
1062+
Applications may provide a non-zero max_err_cntr_value as input to
1063+
fi_getinfo to request a minimum supported error counter range.
1064+
If the provider cannot satisfy the requested range, it should return
1065+
-FI_ENODATA.
1066+
The provider may return a value larger than the one requested.
1067+
.PP
1068+
Applications must manage error counter values that approach this limit.
1069+
See \f[V]fi_cntr\f[R](3) for details on counter limit handling
1070+
responsibilities.
10321071
.SH RETURN VALUE
10331072
.PP
10341073
Returns 0 on success.
@@ -1054,5 +1093,6 @@ resources appropriately for the installed provider(s).
10541093
.PP
10551094
\f[V]fi_getinfo\f[R](3), \f[V]fi_endpoint\f[R](3), \f[V]fi_av\f[R](3),
10561095
\f[V]fi_eq\f[R](3), \f[V]fi_mr\f[R](3) \f[V]fi_peer\f[R](3)
1096+
\f[V]fi_cntr\f[R](3)
10571097
.SH AUTHORS
10581098
OpenFabrics.

man/man7/fabric.7

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. ftr VB CB
1515
. ftr VBI CBI
1616
.\}
17-
.TH "fabric" "7" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
17+
.TH "fabric" "7" "2026\-02\-11" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
1818
.hy
1919
.SH NAME
2020
.PP
@@ -521,6 +521,13 @@ Added new fields to the following attributes:
521521
.TP
522522
\f[I]fi_domain_attr\f[R]
523523
Added max_group_id
524+
.SS ABI 1.9
525+
.PP
526+
ABI version starting with libfabric 2.5.
527+
Added new fields to the following attributes:
528+
.TP
529+
\f[I]fi_domain_attr\f[R]
530+
Added max_cntr_value, max_err_cntr_value
524531
.SH SEE ALSO
525532
.PP
526533
\f[V]fi_info\f[R](1), \f[V]fi_provider\f[R](7), \f[V]fi_getinfo\f[R](3),

0 commit comments

Comments
 (0)