Skip to content

Commit 0863238

Browse files
committed
Updated nroff-generated man pages
Signed-off-by: OFIWG Bot <[email protected]>
1 parent 6c52996 commit 0863238

File tree

1 file changed

+83
-13
lines changed

1 file changed

+83
-13
lines changed

man/man3/fi_domain.3

Lines changed: 83 additions & 13 deletions
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\-01\-30" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
18+
.TH "fi_domain" "3" "2025\-03\-06" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
1919
.hy
2020
.SH NAME
2121
.PP
@@ -444,17 +444,21 @@ The table assumes that all peers enable or disable RM the same.
444444
.PP
445445
.TS
446446
tab(@);
447-
cw(7.7n) cw(16.2n) cw(16.2n) cw(15.4n) cw(14.6n).
447+
cw(5.4n) cw(11.3n) cw(11.3n) cw(10.8n) cw(10.2n) cw(10.8n) cw(10.2n).
448448
T{
449449
Resource
450450
T}@T{
451451
DGRAM EP-no RM
452452
T}@T{
453453
DGRAM EP-with RM
454454
T}@T{
455-
RDM/MSG EP-no RM
455+
MSG EP-no RM
456456
T}@T{
457-
RDM/MSG EP-with RM
457+
MSG EP-with RM
458+
T}@T{
459+
RDM EP-no RM
460+
T}@T{
461+
RDM EP-with RM
458462
T}
459463
_
460464
T{
@@ -467,6 +471,10 @@ T}@T{
467471
undefined error
468472
T}@T{
469473
EAGAIN
474+
T}@T{
475+
undefined error
476+
T}@T{
477+
EAGAIN
470478
T}
471479
T{
472480
Rx Ctx
@@ -478,6 +486,10 @@ T}@T{
478486
undefined error
479487
T}@T{
480488
EAGAIN
489+
T}@T{
490+
undefined error
491+
T}@T{
492+
EAGAIN
481493
T}
482494
T{
483495
Tx CQ
@@ -489,6 +501,10 @@ T}@T{
489501
undefined error
490502
T}@T{
491503
EAGAIN
504+
T}@T{
505+
undefined error
506+
T}@T{
507+
EAGAIN
492508
T}
493509
T{
494510
Rx CQ
@@ -500,6 +516,10 @@ T}@T{
500516
undefined error
501517
T}@T{
502518
EAGAIN
519+
T}@T{
520+
undefined error
521+
T}@T{
522+
EAGAIN
503523
T}
504524
T{
505525
Target EP
@@ -511,6 +531,10 @@ T}@T{
511531
transmit error
512532
T}@T{
513533
retried
534+
T}@T{
535+
transmit error
536+
T}@T{
537+
retried
514538
T}
515539
T{
516540
No Rx Buffer
@@ -522,6 +546,10 @@ T}@T{
522546
transmit error
523547
T}@T{
524548
retried
549+
T}@T{
550+
transmit error
551+
T}@T{
552+
retried
525553
T}
526554
T{
527555
Rx Buf Overrun
@@ -533,6 +561,10 @@ T}@T{
533561
truncate or error
534562
T}@T{
535563
truncate or error
564+
T}@T{
565+
truncate or error
566+
T}@T{
567+
truncate or error
536568
T}
537569
T{
538570
Unmatched RMA
@@ -544,6 +576,10 @@ T}@T{
544576
transmit error
545577
T}@T{
546578
transmit error
579+
T}@T{
580+
transmit error
581+
T}@T{
582+
transmit error
547583
T}
548584
T{
549585
RMA Overrun
@@ -555,6 +591,25 @@ T}@T{
555591
transmit error
556592
T}@T{
557593
transmit error
594+
T}@T{
595+
transmit error
596+
T}@T{
597+
transmit error
598+
T}
599+
T{
600+
Unreachable EP
601+
T}@T{
602+
dropped
603+
T}@T{
604+
dropped
605+
T}@T{
606+
not applicable
607+
T}@T{
608+
not applicable
609+
T}@T{
610+
transmit error
611+
T}@T{
612+
transmit error
558613
T}
559614
.TE
560615
.PP
@@ -627,15 +682,30 @@ Unlike send operations, RMA operations that attempt to access a memory
627682
address that is either not registered for such operations, or attempt to
628683
access outside of the target memory region will fail, resulting in a
629684
transmit error.
630-
.PP
631-
When a resource management error occurs on an endpoint, the endpoint is
632-
transitioned into a disabled state.
633-
Any operations which have not already completed will fail and be
634-
discarded.
635-
For connectionless endpoints, the endpoint must be re-enabled before it
636-
will accept new data transfer operations.
637-
For connected endpoints, the connection is torn down and must be
638-
re-established.
685+
.TP
686+
\f[I]Unreachable EP\f[R]
687+
Unreachable endpoint is a connectionless specific scenario where
688+
transmit operations are issued to unreachable target endpoints.
689+
Such scenarios include no-route-to-host or down target NIC.
690+
For FI_EP_DGRAM endpoints, transmit operations targeting an unreachable
691+
endpoint will have operation dropped.
692+
For FI_EP_RDM, target operations targeting an unreachable endpoint will
693+
result in a transmit error.
694+
.PP
695+
When a resource management error occurs on an a connected endpoint, the
696+
endpoint will transition into a disabled state and the connection torn
697+
down.
698+
A disabled endpoint will drop any queued or inflight operations.
699+
.PP
700+
The behavior of resource management errors on connectionless endpoints
701+
depends on the type of error.
702+
If RM is disabled and one of the following errors occur, the endpoint
703+
will be disabled: Tx Ctx, Rx Ctx, Tx CQ, or Rx CQ.
704+
For other errors (Target EP, No Rx Buffer, etc.), the operation may
705+
fail, but the endpoint will remain enabled.
706+
A disabled endpoint will drop or fail any queued or inflight operations.
707+
In addition, a disabled endpoint must be re-enabled before it will
708+
accept new data transfer operations.
639709
.PP
640710
There is one notable restriction on the protections offered by resource
641711
management.

0 commit comments

Comments
 (0)