flow: Remove flow_to/from_match() in favor of cls_rule_to/from_match().
[openvswitch] / lib / flow.c
index ca745187d20780ac3994085b7fda4eaa6b0b7d70..7c3ad5118fb5c21d02d3988f2af6447dc5cbfb9d 100644 (file)
@@ -24,6 +24,7 @@
 #include "coverage.h"
 #include "dynamic-string.h"
 #include "hash.h"
+#include "ofp-util.h"
 #include "ofpbuf.h"
 #include "openflow/openflow.h"
 #include "openvswitch/datapath-protocol.h"
@@ -249,64 +250,6 @@ flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
     stats->n_packets = 1;
 }
 
-/* Extract 'flow' with 'wildcards' into the OpenFlow match structure
- * 'match'. */
-void
-flow_to_match(const struct flow *flow, uint32_t wildcards,
-              bool tun_id_from_cookie, struct ofp_match *match)
-{
-    if (!tun_id_from_cookie) {
-        wildcards &= OFPFW_ALL;
-    }
-    match->wildcards = htonl(wildcards);
-
-    match->in_port = htons(flow->in_port == ODPP_LOCAL ? OFPP_LOCAL
-                           : flow->in_port);
-    match->dl_vlan = flow->dl_vlan;
-    match->dl_vlan_pcp = flow->dl_vlan_pcp;
-    memcpy(match->dl_src, flow->dl_src, ETH_ADDR_LEN);
-    memcpy(match->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
-    match->dl_type = flow->dl_type;
-    match->nw_src = flow->nw_src;
-    match->nw_dst = flow->nw_dst;
-    match->nw_tos = flow->nw_tos;
-    match->nw_proto = flow->nw_proto;
-    match->tp_src = flow->tp_src;
-    match->tp_dst = flow->tp_dst;
-    memset(match->pad1, '\0', sizeof match->pad1);
-    memset(match->pad2, '\0', sizeof match->pad2);
-}
-
-void
-flow_from_match(const struct ofp_match *match, bool tun_id_from_cookie,
-                ovs_be64 cookie, struct flow *flow, uint32_t *flow_wildcards)
-{
-       uint32_t wildcards = ntohl(match->wildcards);
-
-    flow->nw_src = match->nw_src;
-    flow->nw_dst = match->nw_dst;
-    if (tun_id_from_cookie && !(wildcards & NXFW_TUN_ID)) {
-        flow->tun_id = htonl(ntohll(cookie) >> 32);
-    } else {
-        wildcards |= NXFW_TUN_ID;
-        flow->tun_id = 0;
-    }
-    flow->in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL
-                     : ntohs(match->in_port));
-    flow->dl_vlan = match->dl_vlan;
-    flow->dl_vlan_pcp = match->dl_vlan_pcp;
-    flow->dl_type = match->dl_type;
-    flow->tp_src = match->tp_src;
-    flow->tp_dst = match->tp_dst;
-    memcpy(flow->dl_src, match->dl_src, ETH_ADDR_LEN);
-    memcpy(flow->dl_dst, match->dl_dst, ETH_ADDR_LEN);
-    flow->nw_tos = match->nw_tos;
-    flow->nw_proto = match->nw_proto;
-    if (flow_wildcards) {
-        *flow_wildcards = wildcards;
-    }
-}
-
 char *
 flow_to_string(const struct flow *flow)
 {
@@ -351,30 +294,39 @@ flow_print(FILE *stream, const struct flow *flow)
 \f
 /* flow_wildcards functions. */
 
-/* Given the wildcard bit count in bits 'shift' through 'shift + 5' (inclusive)
- * of 'wildcards', returns a 32-bit bit mask with a 1 in each bit that must
- * match and a 0 in each bit that is wildcarded.
+/* Return 'wildcards' in "normal form":
+ *
+ *   - Forces unknown bits to 0.
  *
- * The bits in 'wildcards' are in the format used in enum ofp_flow_wildcards: 0
- * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
- * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
- * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
- * wildcarded. */
-ovs_be32
-flow_nw_bits_to_mask(uint32_t wildcards, int shift)
+ *   - Forces nw_src and nw_dst masks greater than 32 to exactly 32.
+ */
+static inline uint32_t
+flow_wildcards_normalize(uint32_t wildcards)
 {
-    wildcards = (wildcards >> shift) & 0x3f;
-    return wildcards < 32 ? htonl(~((1u << wildcards) - 1)) : 0;
+    wildcards &= wildcards & (OVSFW_ALL | FWW_ALL);
+    if (wildcards & (0x20 << OFPFW_NW_SRC_SHIFT)) {
+        wildcards &= ~(0x1f << OFPFW_NW_SRC_SHIFT);
+    }
+    if (wildcards & (0x20 << OFPFW_NW_DST_SHIFT)) {
+        wildcards &= ~(0x1f << OFPFW_NW_DST_SHIFT);
+    }
+    return wildcards;
 }
 
 /* Initializes 'wc' from 'wildcards', which may be any combination of the
- * OFPFW_* and OVSFW_* wildcard bits. */
+ * OFPFW_* and OVSFW_* wildcard bits.
+ *
+ * All registers (NXM_NX_REG*) are always completely wildcarded, because
+ * 'wildcards' doesn't have enough bits to give the details on which
+ * particular bits should be wildcarded (if any).  The caller may use
+ * flow_wildcards_set_reg_mask() to update the register wildcard masks. */
 void
 flow_wildcards_init(struct flow_wildcards *wc, uint32_t wildcards)
 {
-    wc->wildcards = wildcards & OVSFW_ALL;
-    wc->nw_src_mask = flow_nw_bits_to_mask(wc->wildcards, OFPFW_NW_SRC_SHIFT);
-    wc->nw_dst_mask = flow_nw_bits_to_mask(wc->wildcards, OFPFW_NW_DST_SHIFT);
+    wc->wildcards = flow_wildcards_normalize(wildcards) | FWW_REGS;
+    wc->nw_src_mask = ofputil_wcbits_to_netmask(wildcards >> OFPFW_NW_SRC_SHIFT);
+    wc->nw_dst_mask = ofputil_wcbits_to_netmask(wildcards >> OFPFW_NW_DST_SHIFT);
+    memset(wc->reg_masks, 0, sizeof wc->reg_masks);
 }
 
 /* Initializes 'wc' as an exact-match set of wildcards; that is, 'wc' does not
@@ -382,33 +334,111 @@ flow_wildcards_init(struct flow_wildcards *wc, uint32_t wildcards)
 void
 flow_wildcards_init_exact(struct flow_wildcards *wc)
 {
-    flow_wildcards_init(wc, 0);
+    wc->wildcards = 0;
+    wc->nw_src_mask = htonl(UINT32_MAX);
+    wc->nw_dst_mask = htonl(UINT32_MAX);
+    memset(wc->reg_masks, 0xff, sizeof wc->reg_masks);
+}
+
+/* Returns true if 'wc' is exact-match, false if 'wc' wildcards any bits or
+ * fields. */
+bool
+flow_wildcards_is_exact(const struct flow_wildcards *wc)
+{
+    return !wc->wildcards;
+}
+
+static inline uint32_t
+combine_nw_bits(uint32_t wb1, uint32_t wb2, int shift)
+{
+    uint32_t sb1 = (wb1 >> shift) & 0x3f;
+    uint32_t sb2 = (wb2 >> shift) & 0x3f;
+    return MAX(sb1, sb2) << shift;
+}
+
+/* Initializes 'dst' as the combination of wildcards in 'src1' and 'src2'.
+ * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded in
+ * 'src1' or 'src2' or both.  */
+void
+flow_wildcards_combine(struct flow_wildcards *dst,
+                       const struct flow_wildcards *src1,
+                       const struct flow_wildcards *src2)
+{
+    uint32_t wb1 = src1->wildcards;
+    uint32_t wb2 = src2->wildcards;
+    int i;
+
+    dst->wildcards = (wb1 | wb2) & ~(OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK);
+    dst->wildcards |= combine_nw_bits(wb1, wb2, OFPFW_NW_SRC_SHIFT);
+    dst->wildcards |= combine_nw_bits(wb1, wb2, OFPFW_NW_DST_SHIFT);
+    dst->nw_src_mask = src1->nw_src_mask & src2->nw_src_mask;
+    dst->nw_dst_mask = src1->nw_dst_mask & src2->nw_dst_mask;
+    for (i = 0; i < FLOW_N_REGS; i++) {
+        dst->reg_masks[i] = src1->reg_masks[i] & src2->reg_masks[i];
+    }
 }
 
-static int
-count_ones(ovs_be32 mask)
+/* Returns a hash of the wildcards in 'wc'. */
+uint32_t
+flow_wildcards_hash(const struct flow_wildcards *wc)
+{
+    /* There is no need to include nw_src_mask or nw_dst_mask because they do
+     * not add any information (they can be computed from wc->wildcards).  */
+    BUILD_ASSERT_DECL(sizeof wc->wildcards == 4);
+    BUILD_ASSERT_DECL(sizeof wc->reg_masks == 4 * FLOW_N_REGS);
+    BUILD_ASSERT_DECL(offsetof(struct flow_wildcards, wildcards) == 0);
+    BUILD_ASSERT_DECL(offsetof(struct flow_wildcards, reg_masks) == 4);
+    return hash_words((const uint32_t *) wc, 1 + FLOW_N_REGS, 0);
+}
+
+/* Returns true if 'a' and 'b' represent the same wildcards, false if they are
+ * different. */
+bool
+flow_wildcards_equal(const struct flow_wildcards *a,
+                     const struct flow_wildcards *b)
 {
-#if __GNUC__ >= 4
-    return __builtin_popcount(mask);
-#else
-    int bits;
+    int i;
 
-    for (bits = 0; mask; bits++) {
-        mask &= mask - 1;
+    if (a->wildcards != b->wildcards) {
+        return false;
+    }
+
+    for (i = 0; i < FLOW_N_REGS; i++) {
+        if (a->reg_masks[i] != b->reg_masks[i]) {
+            return false;
+        }
     }
 
-    return bits;
-#endif
+    return true;
+}
+
+/* Returns true if at least one bit or field is wildcarded in 'a' but not in
+ * 'b', false otherwise. */
+bool
+flow_wildcards_has_extra(const struct flow_wildcards *a,
+                         const struct flow_wildcards *b)
+{
+    int i;
+
+    for (i = 0; i < FLOW_N_REGS; i++) {
+        if ((a->reg_masks[i] & b->reg_masks[i]) != b->reg_masks[i]) {
+            return true;
+        }
+    }
+
+#define OFPFW_NW_MASK (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK)
+    return ((a->wildcards & ~(b->wildcards | OFPFW_NW_MASK))
+            || (a->nw_src_mask & b->nw_src_mask) != b->nw_src_mask
+            || (a->nw_dst_mask & b->nw_dst_mask) != b->nw_dst_mask);
 }
 
 static bool
 set_nw_mask(struct flow_wildcards *wc, ovs_be32 mask,
             ovs_be32 *maskp, int shift)
 {
-    int wcbits = 32 - count_ones(mask);
-    if (flow_nw_bits_to_mask(wcbits, 0) == mask) {
+    if (ip_is_cidr(mask)) {
         wc->wildcards &= ~(0x3f << shift);
-        wc->wildcards |= wcbits << shift;
+        wc->wildcards |= ofputil_netmask_to_wcbits(mask) << shift;
         *maskp = mask;
         return true;
     } else {
@@ -433,3 +463,26 @@ flow_wildcards_set_nw_dst_mask(struct flow_wildcards *wc, ovs_be32 mask)
 {
     return set_nw_mask(wc, mask, &wc->nw_dst_mask, OFPFW_NW_DST_SHIFT);
 }
+
+/* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
+ * (A 0-bit indicates a wildcard bit.) */
+void
+flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
+{
+    if (mask != wc->reg_masks[idx]) {
+        wc->reg_masks[idx] = mask;
+        if (mask != UINT32_MAX) {
+            wc->wildcards |= FWW_REGS;
+        } else {
+            int i;
+
+            for (i = 0; i < FLOW_N_REGS; i++) {
+                if (wc->reg_masks[i] != UINT32_MAX) {
+                    wc->wildcards |= FWW_REGS;
+                    return;
+                }
+            }
+            wc->wildcards &= ~FWW_REGS;
+        }
+    }
+}