[ofa-general] [PATCH] libibverbs: document IBV_SEND_INLINE buffer ownership relaxation

[Or Gerlitz]

if the IBV_SEND_INLINE flag is set in the WR provided to ibv_post_send,
the data buffers can be reused immediately after the call returns, document this.

Signed-off-by: Or Gerlitz <ogerlitz at voltaire.com>

Index: libibverbs/include/infiniband/verbs.h
===================================================================
--- libibverbs.orig/include/infiniband/verbs.h
+++ libibverbs/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 - low level libraries must confirm to this rule.
  */
 static inline int ibv_post_send(struct ibv_qp *qp, struct ibv_send_wr *wr,
 				struct ibv_send_wr **bad_wr)
Index: libibverbs/man/ibv_post_send.3
===================================================================
--- libibverbs.orig/man/ibv_post_send.3
+++ libibverbs/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),