vswitchd: Document map members as separate columns

[openvswitch] / lib / flow.h

diff --git a/lib/flow.h b/lib/flow.h
index f5f965c5b45bbacb8e6d85a70cae48131ada91b9..5cbfca580cf15438b7dd1146634558a68f10cff7 100644 (file)
--- a/lib/flow.h
+++ b/lib/flow.h
@@ -24,7 +24,6 @@
 #include "openflow/nicira-ext.h"
 #include "openflow/openflow.h"
 #include "hash.h"
-#include "openvswitch/datapath-protocol.h"
 #include "util.h"
 
 struct dpif_flow_stats;
@@ -33,7 +32,12 @@ struct flow_wildcards;
 struct ofp_match;
 struct ofpbuf;
 
-#define FLOW_N_REGS 4
+/* This sequence number should be incremented whenever anything involving flows
+ * or the wildcarding of flows changes.  This will cause build assertion
+ * failures in places which likely need to be updated. */
+#define FLOW_WC_SEQ 1
+
+#define FLOW_N_REGS 5
 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
 
 /* Used for struct flow's dl_type member for frames that have no Ethernet
@@ -70,10 +74,13 @@ BUILD_ASSERT_DECL(offsetof(struct flow, nd_target) == FLOW_SIG_SIZE - 16);
 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nd_target) == 16);
 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
 
-int flow_extract(struct ofpbuf *, uint64_t tun_id, uint16_t in_port,
+/* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
+BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 120 && FLOW_WC_SEQ == 1);
+
+int flow_extract(struct ofpbuf *, ovs_be64 tun_id, uint16_t in_port,
                  struct flow *);
-void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
-                        struct dpif_flow_stats *);
+void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
+
 char *flow_to_string(const struct flow *);
 void flow_format(struct ds *, const struct flow *);
 void flow_print(FILE *, const struct flow *);
@@ -81,6 +88,8 @@ static inline int flow_compare(const struct flow *, const struct flow *);
 static inline bool flow_equal(const struct flow *, const struct flow *);
 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 
+void flow_compose(struct ofpbuf *, const struct flow *);
+
 static inline int
 flow_compare(const struct flow *a, const struct flow *b)
 {
@@ -118,7 +127,7 @@ typedef unsigned int OVS_BITWISE flow_wildcards_t;
 #define FWW_TP_DST      ((OVS_FORCE flow_wildcards_t) (1 << 7))
 /* Same meanings as corresponding OFPFW_* bits, but differ in value. */
 #define FWW_NW_TOS      ((OVS_FORCE flow_wildcards_t) (1 << 1))
-/* No corresponding OFPFW_* or OVSFW_* bits. */
+/* No corresponding OFPFW_* bits. */
 #define FWW_ETH_MCAST   ((OVS_FORCE flow_wildcards_t) (1 << 8))
                                                        /* multicast bit only */
 #define FWW_ARP_SHA     ((OVS_FORCE flow_wildcards_t) (1 << 9))
@@ -126,6 +135,9 @@ typedef unsigned int OVS_BITWISE flow_wildcards_t;
 #define FWW_ND_TARGET   ((OVS_FORCE flow_wildcards_t) (1 << 11))
 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 12)) - 1))
 
+/* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */
+BUILD_ASSERT_DECL(FWW_ALL == ((1 << 12) - 1) && FLOW_WC_SEQ == 1);
+
 /* Information on wildcards for a flow, as a supplement to "struct flow".
  *
  * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
@@ -142,10 +154,14 @@ struct flow_wildcards {
     uint16_t zero;              /* Padding field set to zero. */
 };
 
+/* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */
+BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 76 && FLOW_WC_SEQ == 1);
+
 void flow_wildcards_init_catchall(struct flow_wildcards *);
 void flow_wildcards_init_exact(struct flow_wildcards *);
 
 bool flow_wildcards_is_exact(const struct flow_wildcards *);
+bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 
 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
@@ -162,9 +178,18 @@ void flow_wildcards_combine(struct flow_wildcards *dst,
 bool flow_wildcards_has_extra(const struct flow_wildcards *,
                               const struct flow_wildcards *);
 
-uint32_t flow_wildcards_hash(const struct flow_wildcards *);
+uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 bool flow_wildcards_equal(const struct flow_wildcards *,
                           const struct flow_wildcards *);
 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 
+const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t);
+bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]);
+flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t,
+                                                const uint8_t mask[6]);
+uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
+                          uint16_t basis);
+const char *flow_hash_fields_to_str(enum nx_hash_fields);
+bool flow_hash_fields_valid(enum nx_hash_fields);
+
 #endif /* flow.h */