Document IBV_SEND_INLINE buffer ownership

If the IBV_SEND_INLINE flag is set in a work request posted with
ibv_post_send(), the data buffers can be reused immediately after the
call returns.  Document this.

Signed-off-by: Or Gerlitz <ogerlitz@voltaire.com>
Signed-off-by: Roland Dreier <rolandd@cisco.com>

diff --git a/include/infiniband/verbs.h b/include/infiniband/verbs.h
index acc1b8246608a84722d96b7d91fedc242e0081a8..a51bb9d6fccca17dcf380d456bce21436d92c16f 100644 (file)
--- a/include/infiniband/verbs.h
+++ b/include/infiniband/verbs.h
@@ -989,6 +989,9 @@ int ibv_destroy_qp(struct ibv_qp *qp);
 
 /**
  * ibv_post_send - Post a list of work requests to a send queue.
+ *
+ * If IBV_SEND_INLINE flag is set, the data buffers can be reused
+ * immediately after the call returns.
  */
 static inline int ibv_post_send(struct ibv_qp *qp, struct ibv_send_wr *wr,
                                struct ibv_send_wr **bad_wr)

diff --git a/man/ibv_post_send.3 b/man/ibv_post_send.3
index d1b04fd6bc117f98c832beef954274d1af2cd2c5..8c7b0eb35eb52c3f206ede1c51236d59a114ae5d 100644 (file)
--- a/man/ibv_post_send.3
+++ b/man/ibv_post_send.3
@@ -109,7 +109,9 @@ behavior.
 .PP
 The buffers used by a WR can only be safely reused after WR the
 request is fully executed and a work completion has been retrieved
-from the corresponding completion queue (CQ).
+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.
 .SH "SEE ALSO"
 .BR ibv_create_qp (3),
 .BR ibv_create_ah (3),