Implement arbitrary bitwise masks for tun_id field.
[sliver-openvswitch.git] / lib / nx-match.c
index bcb6482..392ea86 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010 Nicira Networks.
+ * Copyright (c) 2010, 2011 Nicira Networks.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -46,7 +46,8 @@ enum {
 /* For each NXM_* field, define NFI_NXM_* as consecutive integers starting from
  * zero. */
 enum nxm_field_index {
-#define DEFINE_FIELD(HEADER, WILDCARD, DL_TYPE, NW_PROTO) NFI_NXM_##HEADER,
+#define DEFINE_FIELD(HEADER, WILDCARD, DL_TYPE, NW_PROTO, WRITABLE) \
+        NFI_NXM_##HEADER,
 #include "nx-match.def"
     N_NXM_FIELDS
 };
@@ -59,13 +60,14 @@ struct nxm_field {
     ovs_be16 dl_type;           /* dl_type prerequisite, if nonzero. */
     uint8_t nw_proto;           /* nw_proto prerequisite, if nonzero. */
     const char *name;           /* "NXM_*" string. */
+    bool writable;              /* Writable with NXAST_REG_{MOVE,LOAD}? */
 };
 
 /* All the known fields. */
 static struct nxm_field nxm_fields[N_NXM_FIELDS] = {
-#define DEFINE_FIELD(HEADER, WILDCARD, DL_TYPE, NW_PROTO) \
+#define DEFINE_FIELD(HEADER, WILDCARD, DL_TYPE, NW_PROTO, WRITABLE)     \
     { HMAP_NODE_NULL_INITIALIZER, NFI_NXM_##HEADER, NXM_##HEADER, WILDCARD, \
-      CONSTANT_HTONS(DL_TYPE), NW_PROTO, "NXM_" #HEADER },
+      CONSTANT_HTONS(DL_TYPE), NW_PROTO, "NXM_" #HEADER, WRITABLE },
 #include "nx-match.def"
 };
 
@@ -97,7 +99,7 @@ nxm_init(void)
         /* Verify that the header values are unique (duplicate "case" values
          * cause a compile error). */
         switch (0) {
-#define DEFINE_FIELD(HEADER, WILDCARD, DL_TYPE, NW_PROTO) \
+#define DEFINE_FIELD(HEADER, WILDCARD, DL_TYPE, NW_PROTO, WRITABLE)  \
         case NXM_##HEADER: break;
 #include "nx-match.def"
         }
@@ -123,7 +125,7 @@ nxm_field_lookup(uint32_t header)
 
 /* Returns the width of the data for a field with the given 'header', in
  * bytes. */
-static int
+int
 nxm_field_bytes(uint32_t header)
 {
     unsigned int length = NXM_LENGTH(header);
@@ -132,7 +134,7 @@ nxm_field_bytes(uint32_t header)
 
 /* Returns the width of the data for a field with the given 'header', in
  * bits. */
-static int
+int
 nxm_field_bits(uint32_t header)
 {
     return nxm_field_bytes(header) * 8;
@@ -318,8 +320,21 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
 
         /* Tunnel ID. */
     case NFI_NXM_NX_TUN_ID:
-        flow->tun_id = htonl(ntohll(get_unaligned_be64(value)));
-        return 0;
+        if (wc->tun_id_mask) {
+            return NXM_DUP_TYPE;
+        } else {
+            cls_rule_set_tun_id(rule, get_unaligned_be64(value));
+            return 0;
+        }
+    case NFI_NXM_NX_TUN_ID_W:
+        if (wc->tun_id_mask) {
+            return NXM_DUP_TYPE;
+        } else {
+            ovs_be64 tun_id = get_unaligned_be64(value);
+            ovs_be64 tun_mask = get_unaligned_be64(mask);
+            cls_rule_set_tun_id_masked(rule, tun_id, tun_mask);
+            return 0;
+        }
 
         /* Registers. */
     case NFI_NXM_NX_REG0:
@@ -395,7 +410,7 @@ nx_pull_match(struct ofpbuf *b, unsigned int match_len, uint16_t priority,
 
     p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
     if (!p) {
-        VLOG_DBG_RL(&rl, "nx_match length %zu, rounded up to a "
+        VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
                     "multiple of 8, is longer than space in message (max "
                     "length %zu)", match_len, b->size);
         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
@@ -531,6 +546,31 @@ nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
     ofpbuf_put(b, &value, sizeof value);
 }
 
+static void
+nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
+{
+    nxm_put_header(b, header);
+    ofpbuf_put(b, &value, sizeof value);
+    ofpbuf_put(b, &mask, sizeof mask);
+}
+
+static void
+nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
+{
+    switch (mask) {
+    case 0:
+        break;
+
+    case CONSTANT_HTONLL(UINT64_MAX):
+        nxm_put_64(b, header, value);
+        break;
+
+    default:
+        nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
+        break;
+    }
+}
+
 static void
 nxm_put_eth(struct ofpbuf *b, uint32_t header,
             const uint8_t value[ETH_ADDR_LEN])
@@ -562,6 +602,16 @@ nxm_put_eth_dst(struct ofpbuf *b,
     }
 }
 
+/* Appends to 'b' the nx_match format that expresses 'cr' (except for
+ * 'cr->priority', because priority is not part of nx_match), plus enough
+ * zero bytes to pad the nx_match out to a multiple of 8.
+ *
+ * This function can cause 'b''s data to be reallocated.
+ *
+ * Returns the number of bytes appended to 'b', excluding padding.
+ *
+ * If 'cr' is a catch-all rule that matches every packet, then this function
+ * appends nothing to 'b' and returns 0. */
 int
 nx_put_match(struct ofpbuf *b, const struct cls_rule *cr)
 {
@@ -645,9 +695,7 @@ nx_put_match(struct ofpbuf *b, const struct cls_rule *cr)
     }
 
     /* Tunnel ID. */
-    if (!(wc & FWW_TUN_ID)) {
-        nxm_put_64(b, NXM_NX_TUN_ID, htonll(ntohl(flow->tun_id)));
-    }
+    nxm_put_64m(b, NXM_NX_TUN_ID, flow->tun_id, cr->wc.tun_id_mask);
 
     /* Registers. */
     for (i = 0; i < FLOW_N_REGS; i++) {
@@ -749,25 +797,6 @@ parse_nxm_field_name(const char *name, int name_len)
 
     return 0;
 }
-
-static const char *
-parse_hex_bytes(struct ofpbuf *b, const char *s, unsigned int n)
-{
-    while (n--) {
-        uint8_t byte;
-        bool ok;
-
-        s += strspn(s, " ");
-        byte = hexits_value(s, 2, &ok);
-        if (!ok) {
-            ovs_fatal(0, "%.2s: hex digits expected", s);
-        }
-
-        ofpbuf_put(b, &byte, 1);
-        s += 2;
-    }
-    return s;
-}
 \f
 /* nx_match_from_string(). */
 
@@ -788,6 +817,7 @@ nx_match_from_string(const char *s, struct ofpbuf *b)
         const char *name;
         uint32_t header;
         int name_len;
+        size_t n;
 
         name = s;
         name_len = strcspn(s, "(");
@@ -803,14 +833,20 @@ nx_match_from_string(const char *s, struct ofpbuf *b)
         s += name_len + 1;
 
         nxm_put_header(b, header);
-        s = parse_hex_bytes(b, s, nxm_field_bytes(header));
+        s = ofpbuf_put_hex(b, s, &n);
+        if (n != nxm_field_bytes(header)) {
+            ovs_fatal(0, "%.2s: hex digits expected", s);
+        }
         if (NXM_HASMASK(header)) {
             s += strspn(s, " ");
             if (*s != '/') {
                 ovs_fatal(0, "%s: missing / in masked field %.*s",
                           full_s, name_len, name);
             }
-            s = parse_hex_bytes(b, s + 1, nxm_field_bytes(header));
+            s = ofpbuf_put_hex(b, s + 1, &n);
+            if (n != nxm_field_bytes(header)) {
+                ovs_fatal(0, "%.2s: hex digits expected", s);
+            }
         }
 
         s += strspn(s, " ");
@@ -826,8 +862,8 @@ nx_match_from_string(const char *s, struct ofpbuf *b)
     return match_len;
 }
 \f
-static const char *
-parse_nxm_field_bits(const char *s, uint32_t *headerp, int *ofsp, int *n_bitsp)
+const char *
+nxm_parse_field_bits(const char *s, uint32_t *headerp, int *ofsp, int *n_bitsp)
 {
     const char *full_s = s;
     const char *name;
@@ -888,12 +924,12 @@ nxm_parse_reg_move(struct nx_action_reg_move *move, const char *s)
     int src_ofs, dst_ofs;
     int src_n_bits, dst_n_bits;
 
-    s = parse_nxm_field_bits(s, &src, &src_ofs, &src_n_bits);
+    s = nxm_parse_field_bits(s, &src, &src_ofs, &src_n_bits);
     if (strncmp(s, "->", 2)) {
         ovs_fatal(0, "%s: missing `->' following source", full_s);
     }
     s += 2;
-    s = parse_nxm_field_bits(s, &dst, &dst_ofs, &dst_n_bits);
+    s = nxm_parse_field_bits(s, &dst, &dst_ofs, &dst_n_bits);
     if (*s != '\0') {
         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
     }
@@ -927,13 +963,13 @@ nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
         ovs_fatal(0, "%s: missing `->' following value", full_s);
     }
     s += 2;
-    s = parse_nxm_field_bits(s, &dst, &ofs, &n_bits);
+    s = nxm_parse_field_bits(s, &dst, &ofs, &n_bits);
     if (*s != '\0') {
         ovs_fatal(0, "%s: trailing garbage following destination", full_s);
     }
 
     if (n_bits < 64 && (value >> n_bits) != 0) {
-        ovs_fatal(0, "%s: value %llu does not fit into %d bits",
+        ovs_fatal(0, "%s: value %"PRIu64" does not fit into %d bits",
                   full_s, value, n_bits);
     }
 
@@ -941,21 +977,23 @@ nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
     load->len = htons(sizeof *load);
     load->vendor = htonl(NX_VENDOR_ID);
     load->subtype = htons(NXAST_REG_LOAD);
-    load->ofs_nbits = htons((ofs << 6) | (n_bits - 1));
+    load->ofs_nbits = nxm_encode_ofs_nbits(ofs, n_bits);
     load->dst = htonl(dst);
     load->value = htonll(value);
 }
 \f
 /* nxm_format_reg_move(), nxm_format_reg_load(). */
 
-static void
-format_nxm_field_bits(struct ds *s, uint32_t header, int ofs, int n_bits)
+void
+nxm_format_field_bits(struct ds *s, uint32_t header, int ofs, int n_bits)
 {
     format_nxm_field_name(s, header);
-    if (n_bits != 1) {
-        ds_put_format(s, "[%d..%d]", ofs, ofs + n_bits - 1);
-    } else {
+    if (ofs == 0 && n_bits == nxm_field_bits(header)) {
+        ds_put_cstr(s, "[]");
+    } else if (n_bits == 1) {
         ds_put_format(s, "[%d]", ofs);
+    } else {
+        ds_put_format(s, "[%d..%d]", ofs, ofs + n_bits - 1);
     }
 }
 
@@ -969,22 +1007,21 @@ nxm_format_reg_move(const struct nx_action_reg_move *move, struct ds *s)
     uint32_t dst = ntohl(move->dst);
 
     ds_put_format(s, "move:");
-    format_nxm_field_bits(s, src, src_ofs, n_bits);
+    nxm_format_field_bits(s, src, src_ofs, n_bits);
     ds_put_cstr(s, "->");
-    format_nxm_field_bits(s, dst, dst_ofs, n_bits);
+    nxm_format_field_bits(s, dst, dst_ofs, n_bits);
 }
 
 void
 nxm_format_reg_load(const struct nx_action_reg_load *load, struct ds *s)
 {
-    uint16_t ofs_nbits = ntohs(load->ofs_nbits);
-    int ofs = ofs_nbits >> 6;
-    int n_bits = (ofs_nbits & 0x3f) + 1;
+    int ofs = nxm_decode_ofs(load->ofs_nbits);
+    int n_bits = nxm_decode_n_bits(load->ofs_nbits);
     uint32_t dst = ntohl(load->dst);
     uint64_t value = ntohll(load->value);
 
-    ds_put_format(s, "load:%"PRIu64"->", value);
-    format_nxm_field_bits(s, dst, ofs, n_bits);
+    ds_put_format(s, "load:%#"PRIx64"->", value);
+    nxm_format_field_bits(s, dst, ofs, n_bits);
 }
 \f
 /* nxm_check_reg_move(), nxm_check_reg_load(). */
@@ -1017,9 +1054,7 @@ nxm_check_reg_move(const struct nx_action_reg_move *action,
         return BAD_ARGUMENT;
     }
 
-    if (!NXM_IS_NX_REG(dst->header)
-        && dst->header != NXM_OF_VLAN_TCI
-        && dst->header != NXM_NX_TUN_ID) {
+    if (!dst->writable) {
         return BAD_ARGUMENT;
     }
 
@@ -1033,8 +1068,8 @@ nxm_check_reg_load(const struct nx_action_reg_load *action,
     const struct nxm_field *dst;
     int ofs, n_bits;
 
-    ofs = ntohs(action->ofs_nbits) >> 6;
-    n_bits = (ntohs(action->ofs_nbits) & 0x3f) + 1;
+    ofs = nxm_decode_ofs(action->ofs_nbits);
+    n_bits = nxm_decode_n_bits(action->ofs_nbits);
     dst = nxm_field_lookup(ntohl(action->dst));
     if (!field_ok(dst, flow, ofs + n_bits)) {
         return BAD_ARGUMENT;
@@ -1046,7 +1081,7 @@ nxm_check_reg_load(const struct nx_action_reg_load *action,
         return BAD_ARGUMENT;
     }
 
-    if (!NXM_IS_NX_REG(dst->header)) {
+    if (!dst->writable) {
         return BAD_ARGUMENT;
     }
 
@@ -1104,7 +1139,7 @@ nxm_read_field(const struct nxm_field *src, const struct flow *flow)
         return ntohs(flow->tp_dst) & 0xff;
 
     case NFI_NXM_NX_TUN_ID:
-        return ntohl(flow->tun_id);
+        return ntohll(flow->tun_id);
 
 #define NXM_READ_REGISTER(IDX)                  \
     case NFI_NXM_NX_REG##IDX:                   \
@@ -1126,6 +1161,7 @@ nxm_read_field(const struct nxm_field *src, const struct flow *flow)
 #error
 #endif
 
+    case NFI_NXM_NX_TUN_ID_W:
     case NFI_NXM_OF_ETH_DST_W:
     case NFI_NXM_OF_VLAN_TCI_W:
     case NFI_NXM_OF_IP_SRC_W:
@@ -1139,6 +1175,69 @@ nxm_read_field(const struct nxm_field *src, const struct flow *flow)
     NOT_REACHED();
 }
 
+static void
+nxm_write_field(const struct nxm_field *dst, struct flow *flow,
+                uint64_t new_value)
+{
+    switch (dst->index) {
+    case NFI_NXM_OF_VLAN_TCI:
+        flow->vlan_tci = htons(new_value);
+        break;
+
+    case NFI_NXM_NX_TUN_ID:
+        flow->tun_id = htonll(new_value);
+        break;
+
+#define NXM_WRITE_REGISTER(IDX)                 \
+    case NFI_NXM_NX_REG##IDX:                   \
+        flow->regs[IDX] = new_value;            \
+        break;                                  \
+    case NFI_NXM_NX_REG##IDX##_W:               \
+        NOT_REACHED();
+
+    NXM_WRITE_REGISTER(0);
+#if FLOW_N_REGS >= 2
+    NXM_WRITE_REGISTER(1);
+#endif
+#if FLOW_N_REGS >= 3
+    NXM_WRITE_REGISTER(2);
+#endif
+#if FLOW_N_REGS >= 4
+    NXM_WRITE_REGISTER(3);
+#endif
+#if FLOW_N_REGS > 4
+#error
+#endif
+
+    case NFI_NXM_OF_IN_PORT:
+    case NFI_NXM_OF_ETH_DST:
+    case NFI_NXM_OF_ETH_SRC:
+    case NFI_NXM_OF_ETH_TYPE:
+    case NFI_NXM_OF_IP_TOS:
+    case NFI_NXM_OF_IP_PROTO:
+    case NFI_NXM_OF_ARP_OP:
+    case NFI_NXM_OF_IP_SRC:
+    case NFI_NXM_OF_ARP_SPA:
+    case NFI_NXM_OF_IP_DST:
+    case NFI_NXM_OF_ARP_TPA:
+    case NFI_NXM_OF_TCP_SRC:
+    case NFI_NXM_OF_UDP_SRC:
+    case NFI_NXM_OF_TCP_DST:
+    case NFI_NXM_OF_UDP_DST:
+    case NFI_NXM_OF_ICMP_TYPE:
+    case NFI_NXM_OF_ICMP_CODE:
+    case NFI_NXM_NX_TUN_ID_W:
+    case NFI_NXM_OF_ETH_DST_W:
+    case NFI_NXM_OF_VLAN_TCI_W:
+    case NFI_NXM_OF_IP_SRC_W:
+    case NFI_NXM_OF_IP_DST_W:
+    case NFI_NXM_OF_ARP_SPA_W:
+    case NFI_NXM_OF_ARP_TPA_W:
+    case N_NXM_FIELDS:
+        NOT_REACHED();
+    }
+}
+
 void
 nxm_execute_reg_move(const struct nx_action_reg_move *action,
                      struct flow *flow)
@@ -1160,16 +1259,7 @@ nxm_execute_reg_move(const struct nx_action_reg_move *action,
     /* Get the final value. */
     uint64_t new_data = dst_data | ((src_data >> src_ofs) << dst_ofs);
 
-    /* Store the result. */
-    if (NXM_IS_NX_REG(dst->header)) {
-        flow->regs[NXM_NX_REG_IDX(dst->header)] = new_data;
-    } else if (dst->header == NXM_OF_VLAN_TCI) {
-        flow->vlan_tci = htons(new_data);
-    } else if (dst->header == NXM_NX_TUN_ID) {
-        flow->tun_id = htonl(new_data);
-    } else {
-        NOT_REACHED();
-    }
+    nxm_write_field(dst, flow, new_data);
 }
 
 void
@@ -1177,16 +1267,19 @@ nxm_execute_reg_load(const struct nx_action_reg_load *action,
                      struct flow *flow)
 {
     /* Preparation. */
-    int n_bits = (ntohs(action->ofs_nbits) & 0x3f) + 1;
-    uint32_t mask = n_bits == 32 ? UINT32_MAX : (UINT32_C(1) << n_bits) - 1;
-    uint32_t *reg = &flow->regs[NXM_NX_REG_IDX(ntohl(action->dst))];
+    int n_bits = nxm_decode_n_bits(action->ofs_nbits);
+    uint64_t mask = n_bits == 64 ? UINT64_MAX : (UINT64_C(1) << n_bits) - 1;
 
     /* Get source data. */
-    uint32_t src_data = ntohll(action->value);
+    uint64_t src_data = ntohll(action->value);
 
     /* Get remaining bits of the destination field. */
-    int dst_ofs = ntohs(action->ofs_nbits) >> 6;
-    uint32_t dst_data = *reg & ~(mask << dst_ofs);
+    const struct nxm_field *dst = nxm_field_lookup(ntohl(action->dst));
+    int dst_ofs = nxm_decode_ofs(action->ofs_nbits);
+    uint64_t dst_data = nxm_read_field(dst, flow) & ~(mask << dst_ofs);
+
+    /* Get the final value. */
+    uint64_t new_data = dst_data | (src_data << dst_ofs);
 
-    *reg = dst_data | (src_data << dst_ofs);
+    nxm_write_field(dst, flow, new_data);
 }