[Pkg-ofed-commits] [libfabric] 66/123: Update manpage to clarify FI_PEEK behavior
Ana Beatriz Guerrero López
ana at moszumanska.debian.org
Sat Oct 22 12:28:31 UTC 2016
This is an automated email from the git hooks/post-receive script.
ana pushed a commit to annotated tag v1.1.1
in repository libfabric.
Author: Jithin Jose <jithin.jose at intel.com>
Date: Tue Sep 15 14:54:33 2015 -0700
Update manpage to clarify FI_PEEK behavior
Signed-off-by: Sayantan Sur <sayantan.sur at intel.com>
Signed-off-by: Jithin Jose <jithin.jose at intel.com>
man/fi_tagged.3.md | 29 ++++++++++++++++++-----------
1 file changed, 18 insertions(+), 11 deletions(-)
diff --git a/man/fi_tagged.3.md b/man/fi_tagged.3.md
index 92840d3..b613ded 100644
@@ -271,9 +271,12 @@ The following flags may be used with fi_trecvmsg.
A peek request is often useful on endpoints that have provider
allocated buffering enabled (see fi_rx_attr total_buffered_recv).
Unlike standard receive operations, a receive operation with the FI_PEEK
- flag set does not remain queued with the provider until the peek completes
- successfully. If no data is available, the FI_PEEK receive will result in
- a completion queue error entry with err field set to FI_ENOMSG.
+ flag set does not remain queued with the provider after the peek completes
+ successfully. The peek operation operates asynchronously, and the results
+ of the peek operation are available in the completion queue associated with
+ the endpoint. If no message is found matching the tags specified in the peek
+ request, then a completion queue error entry with err field set to FI_ENOMSG
+ will be available.
If a peek request locates a matching message, the operation will complete
successfully. The returned completion data will indicate the meta-data
@@ -281,14 +284,18 @@ The following flags may be used with fi_trecvmsg.
available CQ data, tag, and source address. The data available is subject to
the completion entry format (e.g. struct fi_cq_tagged_entry).
- An application may supply a buffer as part of the peek operation. If
- given, the provider may return a copy of the message data. The returned data
- is limited to the size of the input buffer(s) or the message size, if
- smaller. A provider indicates if data is available by setting the buf
- field of the CQ entry to the user's first input buffer. If buf is NULL, no
- data was available to return. A provider may return NULL even if the
- peek operation completes successfully. Note that the CQ entry len field
- will reference the size of the message, not necessarily the size of the
+ An application may supply a buffer if it desires to receive data as
+ a part of the peek operation. In order to receive data as a part of
+ the peek operation, the buf and len fields must be available in the
+ CQ format. In particular, FI_CQ_FORMAT_CONTEXT and FI_CQ_FORMAT_MSG
+ cannot be used if peek operations desire to obtain a copy of the
+ data. The returned data is limited to the size of the input
+ buffer(s) or the message size, if smaller. A provider indicates if
+ data is available by setting the buf field of the CQ entry to the
+ user's first input buffer. If buf is NULL, no data was available to
+ return. A provider may return NULL even if the peek operation
+ completes successfully. Note that the CQ entry len field will
+ reference the size of the message, not necessarily the size of the
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ofed/libfabric.git
More information about the Pkg-ofed-commits