Skip to content

Commit

Permalink
man/fi_peer: update peer fid initialization language
Browse files Browse the repository at this point in the history
Add clarification in the man page indicating that the owner is
responsible for creating unique fi_peer_*_contexts for each peer
and that the peers are only allowed to set the peer ops of that
context.

Signed-off-by: Alexia Ingerson <[email protected]>
  • Loading branch information
aingerson authored and shijin-aws committed Oct 11, 2024
1 parent ed239a5 commit dbc685d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions man/fi_peer.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,20 @@ similar, independent from the object being shared. However, because the goal
of using peer providers is to avoid overhead, providers must be explicitly
written to support the peer provider mechanisms.
When importing any shared fabric object into a peer, the owner will create a
separate fid_peer_* for each peer provider it intends to import into. The owner
will pass this unique fid_peer_* into each peer through the context parameter of
the init call for the resource (i.e. fi_cq_open, fi_srx_context, fi_cntr_open,
etc). The fi_peer_*_context will indicate the owner-allocated fid_peer_* for
the peer to use but is temporary for the init call and may not be accessed by
the peer after initialization. The peer will set just the peer_ops of the
owner-allocated fid and save a reference to the imported fid_peer_* for use in
the peer API flow. The peer will allocate its own fid for internal uses and
return that fid to the owner through the regular fid parameter of the init call
(as if it were just another opened resource). The owner is responsible for
saving the returned peer fid from the open call in order to close it later
(or to drive progress in the case of the cq_fid).
There are two peer provider models. In the example listed above, both peers
are full providers in their own right and usable in a stand-alone fashion.
In a second model, one of the peers is known as an offload provider. An
Expand Down

0 comments on commit dbc685d

Please sign in to comment.