ofp-util: New function for parsing key-value pairs.
[sliver-openvswitch.git] / lib / ofp-parse.c
index f0e7155..6ccabfe 100644 (file)
@@ -253,79 +253,63 @@ str_to_ipv6(const char *str_, struct in6_addr *addrp, struct in6_addr *maskp)
     free(str);
 }
 
-static void *
-put_action(struct ofpbuf *b, size_t size, uint16_t type)
-{
-    struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
-    ah->type = htons(type);
-    ah->len = htons(size);
-    return ah;
-}
-
 static struct ofp_action_output *
 put_output_action(struct ofpbuf *b, uint16_t port)
 {
-    struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
+    struct ofp_action_output *oao;
+
+    oao = ofputil_put_OFPAT_OUTPUT(b);
     oao->port = htons(port);
     return oao;
 }
 
 static void
-put_enqueue_action(struct ofpbuf *b, uint16_t port, uint32_t queue)
+parse_enqueue(struct ofpbuf *b, char *arg)
 {
-    struct ofp_action_enqueue *oae = put_action(b, sizeof *oae, OFPAT_ENQUEUE);
-    oae->port = htons(port);
-    oae->queue_id = htonl(queue);
+    char *sp = NULL;
+    char *port = strtok_r(arg, ":q", &sp);
+    char *queue = strtok_r(NULL, "", &sp);
+    struct ofp_action_enqueue *oae;
+
+    if (port == NULL || queue == NULL) {
+        ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
+    }
+
+    oae = ofputil_put_OFPAT_ENQUEUE(b);
+    oae->port = htons(str_to_u32(port));
+    oae->queue_id = htonl(str_to_u32(queue));
 }
 
 static void
-put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
+parse_output(struct ofpbuf *b, char *arg)
 {
-    struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
-    str_to_mac(addr, oada->dl_addr);
-}
+    if (strchr(arg, '[')) {
+        struct nx_action_output_reg *naor;
+        int ofs, n_bits;
+        uint32_t src;
 
-static bool
-parse_port_name(const char *name, uint16_t *port)
-{
-    struct pair {
-        const char *name;
-        uint16_t value;
-    };
-    static const struct pair pairs[] = {
-#define DEF_PAIR(NAME) {#NAME, OFPP_##NAME}
-        DEF_PAIR(IN_PORT),
-        DEF_PAIR(TABLE),
-        DEF_PAIR(NORMAL),
-        DEF_PAIR(FLOOD),
-        DEF_PAIR(ALL),
-        DEF_PAIR(CONTROLLER),
-        DEF_PAIR(LOCAL),
-        DEF_PAIR(NONE),
-#undef DEF_PAIR
-    };
-    static const int n_pairs = ARRAY_SIZE(pairs);
-    size_t i;
+        nxm_parse_field_bits(arg, &src, &ofs, &n_bits);
 
-    for (i = 0; i < n_pairs; i++) {
-        if (!strcasecmp(name, pairs[i].name)) {
-            *port = pairs[i].value;
-            return true;
-        }
+        naor = ofputil_put_NXAST_OUTPUT_REG(b);
+        naor->ofs_nbits = nxm_encode_ofs_nbits(ofs, n_bits);
+        naor->src = htonl(src);
+        naor->max_len = htons(UINT16_MAX);
+    } else {
+        put_output_action(b, str_to_u32(arg));
     }
-    return false;
 }
 
 static void
-parse_resubmit(struct nx_action_resubmit *nar, char *arg)
+parse_resubmit(struct ofpbuf *b, char *arg)
 {
+    struct nx_action_resubmit *nar;
     char *in_port_s, *table_s;
     uint16_t in_port;
     uint8_t table;
 
     in_port_s = strsep(&arg, ",");
     if (in_port_s && in_port_s[0]) {
-        if (!parse_port_name(in_port_s, &in_port)) {
+        if (!ofputil_port_from_string(in_port_s, &in_port)) {
             in_port = str_to_u32(in_port_s);
         }
     } else {
@@ -340,224 +324,200 @@ parse_resubmit(struct nx_action_resubmit *nar, char *arg)
                   " on resubmit");
     }
 
-    nar->vendor = htonl(NX_VENDOR_ID);
-    nar->in_port = htons(in_port);
     if (in_port != OFPP_IN_PORT && table == 255) {
-        nar->subtype = htons(NXAST_RESUBMIT);
+        nar = ofputil_put_NXAST_RESUBMIT(b);
     } else {
-        nar->subtype = htons(NXAST_RESUBMIT_TABLE);
+        nar = ofputil_put_NXAST_RESUBMIT_TABLE(b);
         nar->table = table;
     }
+    nar->in_port = htons(in_port);
 }
 
 static void
-str_to_action(char *str, struct ofpbuf *b)
+parse_set_tunnel(struct ofpbuf *b, const char *arg)
 {
-    bool drop = false;
-    int n_actions;
-    char *pos;
+    uint64_t tun_id = str_to_u64(arg);
+    if (tun_id > UINT32_MAX) {
+        ofputil_put_NXAST_SET_TUNNEL64(b)->tun_id = htonll(tun_id);
+    } else {
+        ofputil_put_NXAST_SET_TUNNEL(b)->tun_id = htonl(tun_id);
+    }
+}
 
-    pos = str;
-    n_actions = 0;
-    for (;;) {
-        char empty_string[] = "";
-        char *act, *arg;
-        size_t actlen;
-        uint16_t port;
+static void
+parse_note(struct ofpbuf *b, const char *arg)
+{
+    size_t start_ofs = b->size;
+    struct nx_action_note *nan;
+    int remainder;
+    size_t len;
+
+    nan = ofputil_put_NXAST_NOTE(b);
+
+    b->size -= sizeof nan->note;
+    while (*arg != '\0') {
+        uint8_t byte;
+        bool ok;
 
-        pos += strspn(pos, ", \t\r\n");
-        if (*pos == '\0') {
+        if (*arg == '.') {
+            arg++;
+        }
+        if (*arg == '\0') {
             break;
         }
 
-        if (drop) {
-            ovs_fatal(0, "Drop actions must not be followed by other actions");
+        byte = hexits_value(arg, 2, &ok);
+        if (!ok) {
+            ovs_fatal(0, "bad hex digit in `note' argument");
         }
+        ofpbuf_put(b, &byte, 1);
 
-        act = pos;
-        actlen = strcspn(pos, ":(, \t\r\n");
-        if (act[actlen] == ':') {
-            /* The argument can be separated by a colon. */
-            size_t arglen;
-
-            arg = act + actlen + 1;
-            arglen = strcspn(arg, ", \t\r\n");
-            pos = arg + arglen + (arg[arglen] != '\0');
-            arg[arglen] = '\0';
-        } else if (act[actlen] == '(') {
-            /* The argument can be surrounded by balanced parentheses.  The
-             * outermost set of parentheses is removed. */
-            int level = 1;
-            size_t arglen;
-
-            arg = act + actlen + 1;
-            for (arglen = 0; level > 0; arglen++) {
-                switch (arg[arglen]) {
-                case '\0':
-                    ovs_fatal(0, "unbalanced parentheses in argument to %s "
-                              "action", act);
-
-                case '(':
-                    level++;
-                    break;
-
-                case ')':
-                    level--;
-                    break;
-                }
-            }
-            arg[arglen - 1] = '\0';
-            pos = arg + arglen;
-        } else {
-            /* There might be no argument at all. */
-            arg = empty_string;
-            pos = act + actlen + (act[actlen] != '\0');
-        }
-        act[actlen] = '\0';
-
-        if (!strcasecmp(act, "mod_vlan_vid")) {
-            struct ofp_action_vlan_vid *va;
-            va = put_action(b, sizeof *va, OFPAT_SET_VLAN_VID);
-            va->vlan_vid = htons(str_to_u32(arg));
-        } else if (!strcasecmp(act, "mod_vlan_pcp")) {
-            struct ofp_action_vlan_pcp *va;
-            va = put_action(b, sizeof *va, OFPAT_SET_VLAN_PCP);
-            va->vlan_pcp = str_to_u32(arg);
-        } else if (!strcasecmp(act, "strip_vlan")) {
-            struct ofp_action_header *ah;
-            ah = put_action(b, sizeof *ah, OFPAT_STRIP_VLAN);
-            ah->type = htons(OFPAT_STRIP_VLAN);
-        } else if (!strcasecmp(act, "mod_dl_src")) {
-            put_dl_addr_action(b, OFPAT_SET_DL_SRC, arg);
-        } else if (!strcasecmp(act, "mod_dl_dst")) {
-            put_dl_addr_action(b, OFPAT_SET_DL_DST, arg);
-        } else if (!strcasecmp(act, "mod_nw_src")) {
-            struct ofp_action_nw_addr *na;
-            na = put_action(b, sizeof *na, OFPAT_SET_NW_SRC);
-            str_to_ip(arg, &na->nw_addr, NULL);
-        } else if (!strcasecmp(act, "mod_nw_dst")) {
-            struct ofp_action_nw_addr *na;
-            na = put_action(b, sizeof *na, OFPAT_SET_NW_DST);
-            str_to_ip(arg, &na->nw_addr, NULL);
-        } else if (!strcasecmp(act, "mod_tp_src")) {
-            struct ofp_action_tp_port *ta;
-            ta = put_action(b, sizeof *ta, OFPAT_SET_TP_SRC);
-            ta->tp_port = htons(str_to_u32(arg));
-        } else if (!strcasecmp(act, "mod_tp_dst")) {
-            struct ofp_action_tp_port *ta;
-            ta = put_action(b, sizeof *ta, OFPAT_SET_TP_DST);
-            ta->tp_port = htons(str_to_u32(arg));
-        } else if (!strcasecmp(act, "mod_nw_tos")) {
-            struct ofp_action_nw_tos *nt;
-            nt = put_action(b, sizeof *nt, OFPAT_SET_NW_TOS);
-            nt->nw_tos = str_to_u32(arg);
-        } else if (!strcasecmp(act, "resubmit")) {
-            struct nx_action_resubmit *nar;
-            nar = put_action(b, sizeof *nar, OFPAT_VENDOR);
-            parse_resubmit(nar, arg);
-        } else if (!strcasecmp(act, "set_tunnel")
-                   || !strcasecmp(act, "set_tunnel64")) {
-            uint64_t tun_id = str_to_u64(arg);
-            if (!strcasecmp(act, "set_tunnel64") || tun_id > UINT32_MAX) {
-                struct nx_action_set_tunnel64 *nast64;
-                nast64 = put_action(b, sizeof *nast64, OFPAT_VENDOR);
-                nast64->vendor = htonl(NX_VENDOR_ID);
-                nast64->subtype = htons(NXAST_SET_TUNNEL64);
-                nast64->tun_id = htonll(tun_id);
-            } else {
-                struct nx_action_set_tunnel *nast;
-                nast = put_action(b, sizeof *nast, OFPAT_VENDOR);
-                nast->vendor = htonl(NX_VENDOR_ID);
-                nast->subtype = htons(NXAST_SET_TUNNEL);
-                nast->tun_id = htonl(tun_id);
-            }
-        } else if (!strcasecmp(act, "set_queue")) {
-            struct nx_action_set_queue *nasq;
-            nasq = put_action(b, sizeof *nasq, OFPAT_VENDOR);
-            nasq->vendor = htonl(NX_VENDOR_ID);
-            nasq->subtype = htons(NXAST_SET_QUEUE);
-            nasq->queue_id = htonl(str_to_u32(arg));
-        } else if (!strcasecmp(act, "pop_queue")) {
-            struct nx_action_header *nah;
-            nah = put_action(b, sizeof *nah, OFPAT_VENDOR);
-            nah->vendor = htonl(NX_VENDOR_ID);
-            nah->subtype = htons(NXAST_POP_QUEUE);
-        } else if (!strcasecmp(act, "note")) {
-            size_t start_ofs = b->size;
-            struct nx_action_note *nan;
-            int remainder;
-            size_t len;
-
-            nan = put_action(b, sizeof *nan, OFPAT_VENDOR);
-            nan->vendor = htonl(NX_VENDOR_ID);
-            nan->subtype = htons(NXAST_NOTE);
-
-            b->size -= sizeof nan->note;
-            while (*arg != '\0') {
-                uint8_t byte;
-                bool ok;
-
-                if (*arg == '.') {
-                    arg++;
-                }
-                if (*arg == '\0') {
-                    break;
-                }
+        arg += 2;
+    }
 
-                byte = hexits_value(arg, 2, &ok);
-                if (!ok) {
-                    ovs_fatal(0, "bad hex digit in `note' argument");
-                }
-                ofpbuf_put(b, &byte, 1);
+    len = b->size - start_ofs;
+    remainder = len % OFP_ACTION_ALIGN;
+    if (remainder) {
+        ofpbuf_put_zeros(b, OFP_ACTION_ALIGN - remainder);
+    }
+    nan = (struct nx_action_note *)((char *)b->data + start_ofs);
+    nan->len = htons(b->size - start_ofs);
+}
 
-                arg += 2;
-            }
+static void
+parse_named_action(enum ofputil_action_code code, struct ofpbuf *b, char *arg)
+{
+    struct ofp_action_dl_addr *oada;
+    struct ofp_action_vlan_pcp *oavp;
+    struct ofp_action_vlan_vid *oavv;
+    struct ofp_action_nw_addr *oana;
+    struct ofp_action_tp_port *oata;
+
+    switch (code) {
+    case OFPUTIL_OFPAT_OUTPUT:
+        parse_output(b, arg);
+        break;
 
-            len = b->size - start_ofs;
-            remainder = len % OFP_ACTION_ALIGN;
-            if (remainder) {
-                ofpbuf_put_zeros(b, OFP_ACTION_ALIGN - remainder);
-            }
-            nan = (struct nx_action_note *)((char *)b->data + start_ofs);
-            nan->len = htons(b->size - start_ofs);
-        } else if (!strcasecmp(act, "move")) {
-            struct nx_action_reg_move *move;
-            move = ofpbuf_put_uninit(b, sizeof *move);
-            nxm_parse_reg_move(move, arg);
-        } else if (!strcasecmp(act, "load")) {
-            struct nx_action_reg_load *load;
-            load = ofpbuf_put_uninit(b, sizeof *load);
-            nxm_parse_reg_load(load, arg);
-        } else if (!strcasecmp(act, "multipath")) {
-            struct nx_action_multipath *nam;
-            nam = ofpbuf_put_uninit(b, sizeof *nam);
-            multipath_parse(nam, arg);
-        } else if (!strcasecmp(act, "autopath")) {
-            struct nx_action_autopath *naa;
-            naa = ofpbuf_put_uninit(b, sizeof *naa);
-            autopath_parse(naa, arg);
-        } else if (!strcasecmp(act, "bundle")) {
-            bundle_parse(b, arg);
-        } else if (!strcasecmp(act, "bundle_load")) {
-            bundle_parse_load(b, arg);
-        } else if (!strcasecmp(act, "output")) {
-            put_output_action(b, str_to_u32(arg));
-        } else if (!strcasecmp(act, "enqueue")) {
-            char *sp = NULL;
-            char *port_s = strtok_r(arg, ":q", &sp);
-            char *queue = strtok_r(NULL, "", &sp);
-            if (port_s == NULL || queue == NULL) {
-                ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
-            }
-            put_enqueue_action(b, str_to_u32(port_s), str_to_u32(queue));
+    case OFPUTIL_OFPAT_SET_VLAN_VID:
+        oavv = ofputil_put_OFPAT_SET_VLAN_VID(b);
+        oavv->vlan_vid = htons(str_to_u32(arg));
+        break;
+
+    case OFPUTIL_OFPAT_SET_VLAN_PCP:
+        oavp = ofputil_put_OFPAT_SET_VLAN_PCP(b);
+        oavp->vlan_pcp = str_to_u32(arg);
+        break;
+
+    case OFPUTIL_OFPAT_STRIP_VLAN:
+        ofputil_put_OFPAT_STRIP_VLAN(b);
+        break;
+
+    case OFPUTIL_OFPAT_SET_DL_SRC:
+    case OFPUTIL_OFPAT_SET_DL_DST:
+        oada = ofputil_put_action(code, b);
+        str_to_mac(arg, oada->dl_addr);
+        break;
+
+    case OFPUTIL_OFPAT_SET_NW_SRC:
+    case OFPUTIL_OFPAT_SET_NW_DST:
+        oana = ofputil_put_action(code, b);
+        str_to_ip(arg, &oana->nw_addr, NULL);
+        break;
+
+    case OFPUTIL_OFPAT_SET_NW_TOS:
+        ofputil_put_OFPAT_SET_NW_TOS(b)->nw_tos = str_to_u32(arg);
+        break;
+
+    case OFPUTIL_OFPAT_SET_TP_SRC:
+    case OFPUTIL_OFPAT_SET_TP_DST:
+        oata = ofputil_put_action(code, b);
+        oata->tp_port = htons(str_to_u32(arg));
+        break;
+
+    case OFPUTIL_OFPAT_ENQUEUE:
+        parse_enqueue(b, arg);
+        break;
+
+    case OFPUTIL_NXAST_RESUBMIT:
+        parse_resubmit(b, arg);
+        break;
+
+    case OFPUTIL_NXAST_SET_TUNNEL:
+        parse_set_tunnel(b, arg);
+        break;
+
+    case OFPUTIL_NXAST_SET_QUEUE:
+        ofputil_put_NXAST_SET_QUEUE(b)->queue_id = htonl(str_to_u32(arg));
+        break;
+
+    case OFPUTIL_NXAST_POP_QUEUE:
+        ofputil_put_NXAST_POP_QUEUE(b);
+        break;
+
+    case OFPUTIL_NXAST_REG_MOVE:
+        nxm_parse_reg_move(ofputil_put_NXAST_REG_MOVE(b), arg);
+        break;
+
+    case OFPUTIL_NXAST_REG_LOAD:
+        nxm_parse_reg_load(ofputil_put_NXAST_REG_LOAD(b), arg);
+        break;
+
+    case OFPUTIL_NXAST_NOTE:
+        parse_note(b, arg);
+        break;
+
+    case OFPUTIL_NXAST_SET_TUNNEL64:
+        ofputil_put_NXAST_SET_TUNNEL64(b)->tun_id = htonll(str_to_u64(arg));
+        break;
+
+    case OFPUTIL_NXAST_MULTIPATH:
+        multipath_parse(ofputil_put_NXAST_MULTIPATH(b), arg);
+        break;
+
+    case OFPUTIL_NXAST_AUTOPATH:
+        autopath_parse(ofputil_put_NXAST_AUTOPATH(b), arg);
+        break;
+
+    case OFPUTIL_NXAST_BUNDLE:
+        bundle_parse(b, arg);
+        break;
+
+    case OFPUTIL_NXAST_BUNDLE_LOAD:
+        bundle_parse_load(b, arg);
+        break;
+
+    case OFPUTIL_NXAST_RESUBMIT_TABLE:
+    case OFPUTIL_NXAST_OUTPUT_REG:
+        NOT_REACHED();
+    }
+}
+
+static void
+str_to_action(char *str, struct ofpbuf *b)
+{
+    char *pos, *act, *arg;
+    int n_actions;
+
+    pos = str;
+    n_actions = 0;
+    while (ofputil_parse_key_value(&pos, &act, &arg)) {
+        uint16_t port;
+        int code;
+
+        code = ofputil_action_code_from_name(act);
+        if (code >= 0) {
+            parse_named_action(code, b, arg);
         } else if (!strcasecmp(act, "drop")) {
             /* A drop action in OpenFlow occurs by just not setting
              * an action. */
-            drop = true;
             if (n_actions) {
                 ovs_fatal(0, "Drop actions must not be preceded by other "
                           "actions");
+            } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
+                ovs_fatal(0, "Drop actions must not be followed by other "
+                          "actions");
             }
+            break;
         } else if (!strcasecmp(act, "CONTROLLER")) {
             struct ofp_action_output *oao;
             oao = put_output_action(b, OFPP_CONTROLLER);
@@ -569,10 +529,8 @@ str_to_action(char *str, struct ofpbuf *b)
             } else {
                 oao->max_len = htons(UINT16_MAX);
             }
-        } else if (parse_port_name(act, &port)) {
+        } else if (ofputil_port_from_string(act, &port)) {
             put_output_action(b, port);
-        } else if (strspn(act, "0123456789") == strlen(act)) {
-            put_output_action(b, str_to_u32(act));
         } else {
             ovs_fatal(0, "Unknown action: %s", act);
         }
@@ -613,6 +571,7 @@ parse_protocol(const char *name, const struct protocol **p_out)
     return false;
 }
 
+BUILD_ASSERT_DECL(FLOW_WC_SEQ == 1);
 #define FIELDS                                              \
     FIELD(F_TUN_ID,      "tun_id",      0)                  \
     FIELD(F_IN_PORT,     "in_port",     FWW_IN_PORT)        \
@@ -702,7 +661,7 @@ parse_field_value(struct cls_rule *rule, enum field_index index,
         break;
 
     case F_IN_PORT:
-        if (!parse_port_name(value, &port_no)) {
+        if (!ofputil_port_from_string(value, &port_no)) {
             port_no = atoi(value);
         }
         cls_rule_set_in_port(rule, port_no);
@@ -791,7 +750,7 @@ parse_field_value(struct cls_rule *rule, enum field_index index,
 
     case F_ND_TARGET:
         str_to_ipv6(value, &ipv6, NULL);
-        cls_rule_set_nd_target(rule, ipv6);
+        cls_rule_set_nd_target(rule, &ipv6);
         break;
 
     case F_ND_SLL:
@@ -812,14 +771,20 @@ parse_field_value(struct cls_rule *rule, enum field_index index,
 static void
 parse_reg_value(struct cls_rule *rule, int reg_idx, const char *value)
 {
-    uint32_t reg_value, reg_mask;
+    /* This uses an oversized destination field (64 bits when 32 bits would do)
+     * because some sscanf() implementations truncate the range of %i
+     * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
+     * value of 0x7fff.  The other alternatives are to allow only a single
+     * radix (e.g. decimal or hexadecimal) or to write more sophisticated
+     * parsers. */
+    unsigned long long int reg_value, reg_mask;
 
     if (!strcmp(value, "ANY") || !strcmp(value, "*")) {
         cls_rule_set_reg_masked(rule, reg_idx, 0, 0);
-    } else if (sscanf(value, "%"SCNi32"/%"SCNi32,
+    } else if (sscanf(value, "%lli/%lli",
                       &reg_value, &reg_mask) == 2) {
         cls_rule_set_reg_masked(rule, reg_idx, reg_value, reg_mask);
-    } else if (sscanf(value, "%"SCNi32, &reg_value)) {
+    } else if (sscanf(value, "%lli", &reg_value)) {
         cls_rule_set_reg(rule, reg_idx, reg_value);
     } else {
         ovs_fatal(0, "register fields must take the form <value> "
@@ -1062,7 +1027,7 @@ parse_ofp_flow_mod_file(struct list *packets,
 }
 
 void
-parse_ofp_flow_stats_request_str(struct flow_stats_request *fsr,
+parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
                                  bool aggregate, char *string)
 {
     struct ofputil_flow_mod fm;