summaryrefslogtreecommitdiff
path: root/lib/dpif-provider.h
diff options
context:
space:
mode:
authorJoe Stringer <joestringer@nicira.com>2014-07-15 12:04:52 +0000
committerJoe Stringer <joestringer@nicira.com>2014-07-16 13:59:22 +1200
commit58df55ce45ca98f8ddfb8f079254cd0caa5284c0 (patch)
tree3577d96d8bb9f1fb1b24590d5f70074e2beeee07 /lib/dpif-provider.h
parentbdba1947ed631d3ad6d35b9733e7b17aa0ca4559 (diff)
downloadopenvswitch-58df55ce45ca98f8ddfb8f079254cd0caa5284c0.tar.gz
dpif: Update documentation for RCU-protected actions.
The userspace datapath returns RCU-protected actions from flow_get() and flow_dump_next(). This doesn't cause any trouble for current users of these functions, but it imposes additional constraints on their use. This patch makes the dpif documentation more explicit about how the results of these functions can be used. Signed-off-by: Joe Stringer <joestringer@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'lib/dpif-provider.h')
-rw-r--r--lib/dpif-provider.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/dpif-provider.h b/lib/dpif-provider.h
index 2a765de4d..6a06cf8dd 100644
--- a/lib/dpif-provider.h
+++ b/lib/dpif-provider.h
@@ -253,11 +253,13 @@ struct dpif_class {
*
* If 'maskp' is nonnull, then on success '*maskp' will point to the
* Netlink attributes for the flow's mask. '*mask_len' will be set to the
- * length of the mask attributes.
+ * length of the mask attributes. Implementations may opt to point 'maskp'
+ * at RCU-protected data rather than making a copy in '*bufp'.
*
* If 'actionsp' is nonnull, then on success '*actionsp' will point to the
* Netlink attributes for the flow's actions. '*actions_len' will be set to
- * the length of the actions attributes.
+ * the length of the actions attributes. Implementations may opt to point
+ * 'actionsp' at RCU-protected data rather than making a copy in '*bufp'.
*
* If 'stats' is nonnull, then on success it must be updated with the
* flow's statistics. */