diff mbox

libibverbs/doc: clarify selective signaling (Re: using IBV_SEND_SIGNALED)

Message ID 4CF60ED0.6000502@Voltaire.com (mailing list archive)
State New, archived
Headers show

Commit Message

Or Gerlitz Dec. 1, 2010, 9:01 a.m. UTC
None
diff mbox

Patch

Index: libibverbs/man/ibv_post_send.3
===================================================================
--- libibverbs.orig/man/ibv_post_send.3
+++ libibverbs/man/ibv_post_send.3
@@ -112,6 +112,15 @@  request is fully executed and a work com
 from the corresponding completion queue (CQ). However, if the
 IBV_SEND_INLINE flag was set, the buffer can be reused immediately
 after the call returns.
+.PP
+Applications which use selective signaling can only assume that
+unsignaled WRs are complete once a completion for a later signaled WR
+is received. In practice this means that a signaled WR must be
+used periodically, and that the send queue should never be filled with
+unsignaled WRs. Such periodic signaling is also a requirement of most rdma
+devices. In the presence of completion with error, WCs are generated
+also for unsignaled WRs, so applications should make sure to provide a valid
+id (cookie) for all posted WRs.
 .SH "SEE ALSO"
 .BR ibv_create_qp (3),
 .BR ibv_create_ah (3),