route-table: Handle route updates more robustly.
[sliver-openvswitch.git] / lib / nx-match.c
index 6c8ee13..f887cdb 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.
@@ -123,7 +123,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 +132,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;
@@ -151,9 +151,9 @@ parse_nx_reg(const struct nxm_field *f,
     } else {
         flow_wildcards_set_reg_mask(wc, idx,
                                     (NXM_HASMASK(f->header)
-                                     ? ntohl(get_unaligned_u32(maskp))
+                                     ? ntohl(get_unaligned_be32(maskp))
                                      : UINT32_MAX));
-        flow->regs[idx] = ntohl(get_unaligned_u32(value));
+        flow->regs[idx] = ntohl(get_unaligned_be32(value));
         flow->regs[idx] &= wc->reg_masks[idx];
         return 0;
     }
@@ -169,7 +169,7 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
     switch (f->index) {
         /* Metadata. */
     case NFI_NXM_OF_IN_PORT:
-        flow->in_port = ntohs(get_unaligned_u16(value));
+        flow->in_port = ntohs(get_unaligned_be16(value));
         if (flow->in_port == OFPP_LOCAL) {
             flow->in_port = ODPP_LOCAL;
         }
@@ -209,7 +209,7 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
         memcpy(flow->dl_src, value, ETH_ADDR_LEN);
         return 0;
     case NFI_NXM_OF_ETH_TYPE:
-        flow->dl_type = get_unaligned_u16(value);
+        flow->dl_type = get_unaligned_be16(value);
         return 0;
 
         /* 802.1Q header. */
@@ -217,15 +217,15 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
         if (wc->vlan_tci_mask) {
             return NXM_DUP_TYPE;
         } else {
-            cls_rule_set_dl_tci(rule, get_unaligned_u16(value));
+            cls_rule_set_dl_tci(rule, get_unaligned_be16(value));
             return 0;
         }
     case NFI_NXM_OF_VLAN_TCI_W:
         if (wc->vlan_tci_mask) {
             return NXM_DUP_TYPE;
         } else {
-            cls_rule_set_dl_tci_masked(rule, get_unaligned_u16(value),
-                                       get_unaligned_u16(mask));
+            cls_rule_set_dl_tci_masked(rule, get_unaligned_be16(value),
+                                       get_unaligned_be16(mask));
             return 0;
         }
 
@@ -247,7 +247,7 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
         if (wc->nw_src_mask) {
             return NXM_DUP_TYPE;
         } else {
-            cls_rule_set_nw_src(rule, get_unaligned_u32(value));
+            cls_rule_set_nw_src(rule, get_unaligned_be32(value));
             return 0;
         }
     case NFI_NXM_OF_IP_SRC_W:
@@ -255,8 +255,8 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
         if (wc->nw_src_mask) {
             return NXM_DUP_TYPE;
         } else {
-            ovs_be32 ip = get_unaligned_u32(value);
-            ovs_be32 netmask = get_unaligned_u32(mask);
+            ovs_be32 ip = get_unaligned_be32(value);
+            ovs_be32 netmask = get_unaligned_be32(mask);
             if (!cls_rule_set_nw_src_masked(rule, ip, netmask)) {
                 return NXM_BAD_MASK;
             }
@@ -267,7 +267,7 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
         if (wc->nw_dst_mask) {
             return NXM_DUP_TYPE;
         } else {
-            cls_rule_set_nw_dst(rule, get_unaligned_u32(value));
+            cls_rule_set_nw_dst(rule, get_unaligned_be32(value));
             return 0;
         }
     case NFI_NXM_OF_IP_DST_W:
@@ -275,8 +275,8 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
         if (wc->nw_dst_mask) {
             return NXM_DUP_TYPE;
         } else {
-            ovs_be32 ip = get_unaligned_u32(value);
-            ovs_be32 netmask = get_unaligned_u32(mask);
+            ovs_be32 ip = get_unaligned_be32(value);
+            ovs_be32 netmask = get_unaligned_be32(mask);
             if (!cls_rule_set_nw_dst_masked(rule, ip, netmask)) {
                 return NXM_BAD_MASK;
             }
@@ -285,18 +285,18 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
 
         /* TCP header. */
     case NFI_NXM_OF_TCP_SRC:
-        flow->tp_src = get_unaligned_u16(value);
+        flow->tp_src = get_unaligned_be16(value);
         return 0;
     case NFI_NXM_OF_TCP_DST:
-        flow->tp_dst = get_unaligned_u16(value);
+        flow->tp_dst = get_unaligned_be16(value);
         return 0;
 
         /* UDP header. */
     case NFI_NXM_OF_UDP_SRC:
-        flow->tp_src = get_unaligned_u16(value);
+        flow->tp_src = get_unaligned_be16(value);
         return 0;
     case NFI_NXM_OF_UDP_DST:
-        flow->tp_dst = get_unaligned_u16(value);
+        flow->tp_dst = get_unaligned_be16(value);
         return 0;
 
         /* ICMP header. */
@@ -309,16 +309,16 @@ parse_nxm_entry(struct cls_rule *rule, const struct nxm_field *f,
 
         /* ARP header. */
     case NFI_NXM_OF_ARP_OP:
-        if (ntohs(get_unaligned_u16(value)) > 255) {
+        if (ntohs(get_unaligned_be16(value)) > 255) {
             return NXM_BAD_VALUE;
         } else {
-            flow->nw_proto = ntohs(get_unaligned_u16(value));
+            flow->nw_proto = ntohs(get_unaligned_be16(value));
             return 0;
         }
 
         /* Tunnel ID. */
     case NFI_NXM_NX_TUN_ID:
-        flow->tun_id = htonl(ntohll(get_unaligned_u64(value)));
+        flow->tun_id = get_unaligned_be64(value);
         return 0;
 
         /* Registers. */
@@ -395,7 +395,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);
@@ -562,6 +562,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)
 {
@@ -646,7 +656,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_64(b, NXM_NX_TUN_ID, flow->tun_id);
     }
 
     /* Registers. */
@@ -662,6 +672,8 @@ nx_put_match(struct ofpbuf *b, const struct cls_rule *cr)
 \f
 /* nx_match_to_string() and helpers. */
 
+static void format_nxm_field_name(struct ds *, uint32_t header);
+
 char *
 nx_match_to_string(const uint8_t *p, unsigned int match_len)
 {
@@ -678,20 +690,13 @@ nx_match_to_string(const uint8_t *p, unsigned int match_len)
         unsigned int value_len = nxm_field_bytes(header);
         const uint8_t *value = p + 4;
         const uint8_t *mask = value + value_len;
-        const struct nxm_field *f;
         unsigned int i;
 
         if (s.length) {
             ds_put_cstr(&s, ", ");
         }
 
-        f = nxm_field_lookup(header);
-        if (f) {
-            ds_put_cstr(&s, f->name);
-        } else {
-            ds_put_format(&s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
-        }
-
+        format_nxm_field_name(&s, header);
         ds_put_char(&s, '(');
 
         for (i = 0; i < value_len; i++) {
@@ -720,37 +725,39 @@ nx_match_to_string(const uint8_t *p, unsigned int match_len)
     return ds_steal_cstr(&s);
 }
 
-static const struct nxm_field *
-lookup_nxm_field(const char *name, int name_len)
+static void
+format_nxm_field_name(struct ds *s, uint32_t header)
+{
+    const struct nxm_field *f = nxm_field_lookup(header);
+    if (f) {
+        ds_put_cstr(s, f->name);
+    } else {
+        ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
+    }
+}
+
+static uint32_t
+parse_nxm_field_name(const char *name, int name_len)
 {
     const struct nxm_field *f;
 
+    /* Check whether it's a field name. */
     for (f = nxm_fields; f < &nxm_fields[ARRAY_SIZE(nxm_fields)]; f++) {
         if (!strncmp(f->name, name, name_len) && f->name[name_len] == '\0') {
-            return f;
+            return f->header;
         }
     }
 
-    return NULL;
-}
-
-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);
+    /* Check whether it's a 32-bit field header value as hex.
+     * (This isn't ordinarily useful except for testing error behavior.) */
+    if (name_len == 8) {
+        uint32_t header = hexits_value(name, name_len, NULL);
+        if (header != UINT_MAX) {
+            return header;
         }
-
-        ofpbuf_put(b, &byte, 1);
-        s += 2;
     }
-    return s;
+
+    return 0;
 }
 \f
 /* nx_match_from_string(). */
@@ -769,35 +776,45 @@ nx_match_from_string(const char *s, struct ofpbuf *b)
     }
 
     for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
-        const struct nxm_field *f;
+        const char *name;
+        uint32_t header;
         int name_len;
+        size_t n;
 
+        name = s;
         name_len = strcspn(s, "(");
         if (s[name_len] != '(') {
             ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
         }
 
-        f = lookup_nxm_field(s, name_len);
-        if (!f) {
+        header = parse_nxm_field_name(name, name_len);
+        if (!header) {
             ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
         }
 
         s += name_len + 1;
 
-        nxm_put_header(b, f->header);
-        s = parse_hex_bytes(b, s, nxm_field_bytes(f->header));
-        if (NXM_HASMASK(f->header)) {
+        nxm_put_header(b, 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, f->name);
+                ovs_fatal(0, "%s: missing / in masked field %.*s",
+                          full_s, name_len, name);
+            }
+            s = ofpbuf_put_hex(b, s + 1, &n);
+            if (n != nxm_field_bytes(header)) {
+                ovs_fatal(0, "%.2s: hex digits expected", s);
             }
-            s = parse_hex_bytes(b, s + 1, nxm_field_bytes(f->header));
         }
 
         s += strspn(s, " ");
         if (*s != ')') {
-            ovs_fatal(0, "%s: missing ) following field %s", full_s, f->name);
+            ovs_fatal(0, "%s: missing ) following field %.*s",
+                      full_s, name_len, name);
         }
         s++;
     }
@@ -807,6 +824,168 @@ nx_match_from_string(const char *s, struct ofpbuf *b)
     return match_len;
 }
 \f
+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;
+    uint32_t header;
+    int start, end;
+    int name_len;
+    int width;
+
+    name = s;
+    name_len = strcspn(s, "[");
+    if (s[name_len] != '[') {
+        ovs_fatal(0, "%s: missing [ looking for field name", full_s);
+    }
+
+    header = parse_nxm_field_name(name, name_len);
+    if (!header) {
+        ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
+    }
+    width = nxm_field_bits(header);
+
+    s += name_len;
+    if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
+        /* Nothing to do. */
+    } else if (sscanf(s, "[%d]", &start) == 1) {
+        end = start;
+    } else if (!strncmp(s, "[]", 2)) {
+        start = 0;
+        end = width - 1;
+    } else {
+        ovs_fatal(0, "%s: syntax error expecting [] or [<bit>] or "
+                  "[<start>..<end>]", full_s);
+    }
+    s = strchr(s, ']') + 1;
+
+    if (start > end) {
+        ovs_fatal(0, "%s: starting bit %d is after ending bit %d",
+                  full_s, start, end);
+    } else if (start >= width) {
+        ovs_fatal(0, "%s: starting bit %d is not valid because field is only "
+                  "%d bits wide", full_s, start, width);
+    } else if (end >= width){
+        ovs_fatal(0, "%s: ending bit %d is not valid because field is only "
+                  "%d bits wide", full_s, end, width);
+    }
+
+    *headerp = header;
+    *ofsp = start;
+    *n_bitsp = end - start + 1;
+
+    return s;
+}
+
+void
+nxm_parse_reg_move(struct nx_action_reg_move *move, const char *s)
+{
+    const char *full_s = s;
+    uint32_t src, dst;
+    int src_ofs, dst_ofs;
+    int src_n_bits, dst_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 = nxm_parse_field_bits(s, &dst, &dst_ofs, &dst_n_bits);
+    if (*s != '\0') {
+        ovs_fatal(0, "%s: trailing garbage following destination", full_s);
+    }
+
+    if (src_n_bits != dst_n_bits) {
+        ovs_fatal(0, "%s: source field is %d bits wide but destination is "
+                  "%d bits wide", full_s, src_n_bits, dst_n_bits);
+    }
+
+    move->type = htons(OFPAT_VENDOR);
+    move->len = htons(sizeof *move);
+    move->vendor = htonl(NX_VENDOR_ID);
+    move->subtype = htons(NXAST_REG_MOVE);
+    move->n_bits = htons(src_n_bits);
+    move->src_ofs = htons(src_ofs);
+    move->dst_ofs = htons(dst_ofs);
+    move->src = htonl(src);
+    move->dst = htonl(dst);
+}
+
+void
+nxm_parse_reg_load(struct nx_action_reg_load *load, const char *s)
+{
+    const char *full_s = s;
+    uint32_t dst;
+    int ofs, n_bits;
+    uint64_t value;
+
+    value = strtoull(s, (char **) &s, 0);
+    if (strncmp(s, "->", 2)) {
+        ovs_fatal(0, "%s: missing `->' following value", full_s);
+    }
+    s += 2;
+    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 %"PRIu64" does not fit into %d bits",
+                  full_s, value, n_bits);
+    }
+
+    load->type = htons(OFPAT_VENDOR);
+    load->len = htons(sizeof *load);
+    load->vendor = htonl(NX_VENDOR_ID);
+    load->subtype = htons(NXAST_REG_LOAD);
+    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(). */
+
+void
+nxm_format_field_bits(struct ds *s, uint32_t header, int ofs, int n_bits)
+{
+    format_nxm_field_name(s, header);
+    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);
+    }
+}
+
+void
+nxm_format_reg_move(const struct nx_action_reg_move *move, struct ds *s)
+{
+    int n_bits = ntohs(move->n_bits);
+    int src_ofs = ntohs(move->src_ofs);
+    int dst_ofs = ntohs(move->dst_ofs);
+    uint32_t src = ntohl(move->src);
+    uint32_t dst = ntohl(move->dst);
+
+    ds_put_format(s, "move:");
+    nxm_format_field_bits(s, src, src_ofs, n_bits);
+    ds_put_cstr(s, "->");
+    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)
+{
+    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:%#"PRIx64"->", value);
+    nxm_format_field_bits(s, dst, ofs, n_bits);
+}
+\f
 /* nxm_check_reg_move(), nxm_check_reg_load(). */
 
 static bool
@@ -853,8 +1032,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;
@@ -924,7 +1103,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:                   \
@@ -986,7 +1165,7 @@ nxm_execute_reg_move(const struct nx_action_reg_move *action,
     } 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);
+        flow->tun_id = htonll(new_data);
     } else {
         NOT_REACHED();
     }
@@ -997,7 +1176,7 @@ nxm_execute_reg_load(const struct nx_action_reg_load *action,
                      struct flow *flow)
 {
     /* Preparation. */
-    int n_bits = (ntohs(action->ofs_nbits) & 0x3f) + 1;
+    int n_bits = nxm_decode_n_bits(action->ofs_nbits);
     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))];
 
@@ -1005,7 +1184,7 @@ nxm_execute_reg_load(const struct nx_action_reg_load *action,
     uint32_t src_data = ntohll(action->value);
 
     /* Get remaining bits of the destination field. */
-    int dst_ofs = ntohs(action->ofs_nbits) >> 6;
+    int dst_ofs = nxm_decode_ofs(action->ofs_nbits);
     uint32_t dst_data = *reg & ~(mask << dst_ofs);
 
     *reg = dst_data | (src_data << dst_ofs);