ofpbuf: Fix use-after-free in bundle parse.
[cascardo/ovs.git] / lib / bundle.c
index e0f8e6b..1451e92 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2011, 2012 Nicira, Inc.
+/* Copyright (c) 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include "ofp-errors.h"
 #include "ofp-util.h"
 #include "openflow/nicira-ext.h"
-#include "vlog.h"
-
-#define BUNDLE_MAX_SLAVES 2048
+#include "openvswitch/vlog.h"
 
 VLOG_DEFINE_THIS_MODULE(bundle);
 
-static uint16_t
+static ofp_port_t
 execute_ab(const struct ofpact_bundle *bundle,
-           bool (*slave_enabled)(uint16_t ofp_port, void *aux), void *aux)
+           bool (*slave_enabled)(ofp_port_t ofp_port, void *aux), void *aux)
 {
     size_t i;
 
     for (i = 0; i < bundle->n_slaves; i++) {
-        uint16_t slave = bundle->slaves[i];
+        ofp_port_t slave = bundle->slaves[i];
         if (slave_enabled(slave, aux)) {
             return slave;
         }
@@ -51,13 +49,18 @@ execute_ab(const struct ofpact_bundle *bundle,
     return OFPP_NONE;
 }
 
-static uint16_t
-execute_hrw(const struct ofpact_bundle *bundle, const struct flow *flow,
-            bool (*slave_enabled)(uint16_t ofp_port, void *aux), void *aux)
+static ofp_port_t
+execute_hrw(const struct ofpact_bundle *bundle,
+            const struct flow *flow, struct flow_wildcards *wc,
+            bool (*slave_enabled)(ofp_port_t ofp_port, void *aux), void *aux)
 {
     uint32_t flow_hash, best_hash;
     int best, i;
 
+    if (bundle->n_slaves > 1) {
+        flow_mask_hash_fields(flow, wc, bundle->fields);
+    }
+
     flow_hash = flow_hash_fields(flow, bundle->fields, bundle->basis);
     best = -1;
     best_hash = 0;
@@ -76,110 +79,30 @@ execute_hrw(const struct ofpact_bundle *bundle, const struct flow *flow,
     return best >= 0 ? bundle->slaves[best] : OFPP_NONE;
 }
 
-/* Executes 'bundle' on 'flow'.  Uses 'slave_enabled' to determine if the slave
- * designated by 'ofp_port' is up.  Returns the chosen slave, or OFPP_NONE if
- * none of the slaves are acceptable. */
-uint16_t
-bundle_execute(const struct ofpact_bundle *bundle, const struct flow *flow,
-               bool (*slave_enabled)(uint16_t ofp_port, void *aux), void *aux)
+/* Executes 'bundle' on 'flow'.  Sets fields in 'wc' that were used to
+ * calculate the result.  Uses 'slave_enabled' to determine if the slave
+ * designated by 'ofp_port' is up.  Returns the chosen slave, or
+ * OFPP_NONE if none of the slaves are acceptable. */
+ofp_port_t
+bundle_execute(const struct ofpact_bundle *bundle,
+               const struct flow *flow, struct flow_wildcards *wc,
+               bool (*slave_enabled)(ofp_port_t ofp_port, void *aux),
+               void *aux)
 {
     switch (bundle->algorithm) {
     case NX_BD_ALG_HRW:
-        return execute_hrw(bundle, flow, slave_enabled, aux);
+        return execute_hrw(bundle, flow, wc, slave_enabled, aux);
 
     case NX_BD_ALG_ACTIVE_BACKUP:
         return execute_ab(bundle, slave_enabled, aux);
 
     default:
-        NOT_REACHED();
-    }
-}
-
-/* Checks that 'nab' specifies a bundle action which is supported by this
- * bundle module.  Uses the 'max_ports' parameter to validate each port using
- * ofputil_check_output_port().  Returns 0 if 'nab' is supported, otherwise an
- * OFPERR_* error code. */
-enum ofperr
-bundle_from_openflow(const struct nx_action_bundle *nab,
-                     struct ofpbuf *ofpacts)
-{
-    static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
-    struct ofpact_bundle *bundle;
-    uint16_t subtype;
-    uint32_t slave_type;
-    size_t slaves_size, i;
-    enum ofperr error;
-
-    bundle = ofpact_put_BUNDLE(ofpacts);
-
-    subtype = ntohs(nab->subtype);
-    bundle->n_slaves = ntohs(nab->n_slaves);
-    bundle->basis = ntohs(nab->basis);
-    bundle->fields = ntohs(nab->fields);
-    bundle->algorithm = ntohs(nab->algorithm);
-    slave_type = ntohl(nab->slave_type);
-    slaves_size = ntohs(nab->len) - sizeof *nab;
-
-    error = OFPERR_OFPBAC_BAD_ARGUMENT;
-    if (!flow_hash_fields_valid(bundle->fields)) {
-        VLOG_WARN_RL(&rl, "unsupported fields %d", (int) bundle->fields);
-    } else if (bundle->n_slaves > BUNDLE_MAX_SLAVES) {
-        VLOG_WARN_RL(&rl, "too may slaves");
-    } else if (bundle->algorithm != NX_BD_ALG_HRW
-               && bundle->algorithm != NX_BD_ALG_ACTIVE_BACKUP) {
-        VLOG_WARN_RL(&rl, "unsupported algorithm %d", (int) bundle->algorithm);
-    } else if (slave_type != NXM_OF_IN_PORT) {
-        VLOG_WARN_RL(&rl, "unsupported slave type %"PRIu16, slave_type);
-    } else {
-        error = 0;
-    }
-
-    if (!is_all_zeros(nab->zero, sizeof nab->zero)) {
-        VLOG_WARN_RL(&rl, "reserved field is nonzero");
-        error = OFPERR_OFPBAC_BAD_ARGUMENT;
+        OVS_NOT_REACHED();
     }
-
-    if (subtype == NXAST_BUNDLE && (nab->ofs_nbits || nab->dst)) {
-        VLOG_WARN_RL(&rl, "bundle action has nonzero reserved fields");
-        error = OFPERR_OFPBAC_BAD_ARGUMENT;
-    }
-
-    if (subtype == NXAST_BUNDLE_LOAD) {
-        bundle->dst.field = mf_from_nxm_header(ntohl(nab->dst));
-        bundle->dst.ofs = nxm_decode_ofs(nab->ofs_nbits);
-        bundle->dst.n_bits = nxm_decode_n_bits(nab->ofs_nbits);
-
-        if (bundle->dst.n_bits < 16) {
-            VLOG_WARN_RL(&rl, "bundle_load action requires at least 16 bit "
-                         "destination.");
-            error = OFPERR_OFPBAC_BAD_ARGUMENT;
-        }
-    }
-
-    if (slaves_size < bundle->n_slaves * sizeof(ovs_be16)) {
-        VLOG_WARN_RL(&rl, "Nicira action %"PRIu16" only has %zu bytes "
-                     "allocated for slaves.  %zu bytes are required for "
-                     "%"PRIu16" slaves.", subtype, slaves_size,
-                     bundle->n_slaves * sizeof(ovs_be16), bundle->n_slaves);
-        error = OFPERR_OFPBAC_BAD_LEN;
-    }
-
-    for (i = 0; i < bundle->n_slaves; i++) {
-        uint16_t ofp_port = ntohs(((ovs_be16 *)(nab + 1))[i]);
-        ofpbuf_put(ofpacts, &ofp_port, sizeof ofp_port);
-    }
-
-    bundle = ofpacts->l2;
-    ofpact_update_len(ofpacts, &bundle->ofpact);
-
-    if (!error) {
-        error = bundle_check(bundle, OFPP_MAX, NULL);
-    }
-    return error;
 }
 
 enum ofperr
-bundle_check(const struct ofpact_bundle *bundle, int max_ports,
+bundle_check(const struct ofpact_bundle *bundle, ofp_port_t max_ports,
              const struct flow *flow)
 {
     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
@@ -193,15 +116,15 @@ bundle_check(const struct ofpact_bundle *bundle, int max_ports,
     }
 
     for (i = 0; i < bundle->n_slaves; i++) {
-        uint16_t ofp_port = bundle->slaves[i];
-        enum ofperr error;
+        ofp_port_t ofp_port = bundle->slaves[i];
 
-        error = ofputil_check_output_port(ofp_port, max_ports);
-        if (error) {
-            VLOG_WARN_RL(&rl, "invalid slave %"PRIu16, ofp_port);
-            return error;
+        if (ofp_port != OFPP_NONE) {
+            enum ofperr error = ofpact_check_output_port(ofp_port, max_ports);
+            if (error) {
+                VLOG_WARN_RL(&rl, "invalid slave %"PRIu16, ofp_port);
+                return error;
+            }
         }
-
         /* Controller slaves are unsupported due to the lack of a max_len
          * argument. This may or may not change in the future.  There doesn't
          * seem to be a real-world use-case for supporting it. */
@@ -214,37 +137,12 @@ bundle_check(const struct ofpact_bundle *bundle, int max_ports,
     return 0;
 }
 
-void
-bundle_to_nxast(const struct ofpact_bundle *bundle, struct ofpbuf *openflow)
-{
-    int slaves_len = ROUND_UP(2 * bundle->n_slaves, OFP_ACTION_ALIGN);
-    struct nx_action_bundle *nab;
-    ovs_be16 *slaves;
-    size_t i;
 
-    nab = (bundle->dst.field
-           ? ofputil_put_NXAST_BUNDLE_LOAD(openflow)
-           : ofputil_put_NXAST_BUNDLE(openflow));
-    nab->len = htons(ntohs(nab->len) + slaves_len);
-    nab->algorithm = htons(bundle->algorithm);
-    nab->fields = htons(bundle->fields);
-    nab->basis = htons(bundle->basis);
-    nab->slave_type = htonl(NXM_OF_IN_PORT);
-    nab->n_slaves = htons(bundle->n_slaves);
-    if (bundle->dst.field) {
-        nab->ofs_nbits = nxm_encode_ofs_nbits(bundle->dst.ofs,
-                                              bundle->dst.n_bits);
-        nab->dst = htonl(bundle->dst.field->nxm_header);
-    }
-
-    slaves = ofpbuf_put_zeros(openflow, slaves_len);
-    for (i = 0; i < bundle->n_slaves; i++) {
-        slaves[i] = htons(bundle->slaves[i]);
-    }
-}
-
-/* Helper for bundle_parse and bundle_parse_load. */
-static void
+/* Helper for bundle_parse and bundle_parse_load.
+ *
+ * Returns NULL if successful, otherwise a malloc()'d string describing the
+ * error.  The caller is responsible for freeing the returned string.*/
+static char * OVS_WARN_UNUSED_RESULT
 bundle_parse__(const char *s, char **save_ptr,
                const char *fields, const char *basis, const char *algorithm,
                const char *slave_type, const char *dst,
@@ -253,41 +151,48 @@ bundle_parse__(const char *s, char **save_ptr,
     struct ofpact_bundle *bundle;
 
     if (!slave_delim) {
-        ovs_fatal(0, "%s: not enough arguments to bundle action", s);
+        return xasprintf("%s: not enough arguments to bundle action", s);
     }
 
     if (strcasecmp(slave_delim, "slaves")) {
-        ovs_fatal(0, "%s: missing slave delimiter, expected `slaves' got `%s'",
-                   s, slave_delim);
+        return xasprintf("%s: missing slave delimiter, expected `slaves' "
+                         "got `%s'", s, slave_delim);
     }
 
     bundle = ofpact_put_BUNDLE(ofpacts);
 
     for (;;) {
-        uint16_t slave_port;
+        ofp_port_t slave_port;
         char *slave;
 
-        slave = strtok_r(NULL, ", [", save_ptr);
+        slave = strtok_r(NULL, ", []", save_ptr);
         if (!slave || bundle->n_slaves >= BUNDLE_MAX_SLAVES) {
             break;
         }
 
-        slave_port = atoi(slave);
+        if (!ofputil_port_from_string(slave, &slave_port)) {
+            return xasprintf("%s: bad port number", slave);
+        }
         ofpbuf_put(ofpacts, &slave_port, sizeof slave_port);
 
-        bundle = ofpacts->l2;
+        bundle = ofpacts->header;
         bundle->n_slaves++;
     }
-    ofpact_update_len(ofpacts, &bundle->ofpact);
+    ofpact_finish(ofpacts, &bundle->ofpact);
 
+    bundle = ofpacts->header;
     bundle->basis = atoi(basis);
 
     if (!strcasecmp(fields, "eth_src")) {
         bundle->fields = NX_HASH_FIELDS_ETH_SRC;
     } else if (!strcasecmp(fields, "symmetric_l4")) {
         bundle->fields = NX_HASH_FIELDS_SYMMETRIC_L4;
+    } else if (!strcasecmp(fields, "symmetric_l3l4")) {
+        bundle->fields = NX_HASH_FIELDS_SYMMETRIC_L3L4;
+    } else if (!strcasecmp(fields, "symmetric_l3l4+udp")) {
+        bundle->fields = NX_HASH_FIELDS_SYMMETRIC_L3L4_UDP;
     } else {
-        ovs_fatal(0, "%s: unknown fields `%s'", s, fields);
+        return xasprintf("%s: unknown fields `%s'", s, fields);
     }
 
     if (!strcasecmp(algorithm, "active_backup")) {
@@ -295,25 +200,39 @@ bundle_parse__(const char *s, char **save_ptr,
     } else if (!strcasecmp(algorithm, "hrw")) {
         bundle->algorithm = NX_BD_ALG_HRW;
     } else {
-        ovs_fatal(0, "%s: unknown algorithm `%s'", s, algorithm);
+        return xasprintf("%s: unknown algorithm `%s'", s, algorithm);
     }
 
     if (strcasecmp(slave_type, "ofport")) {
-        ovs_fatal(0, "%s: unknown slave_type `%s'", s, slave_type);
+        return xasprintf("%s: unknown slave_type `%s'", s, slave_type);
     }
 
     if (dst) {
-        mf_parse_subfield(&bundle->dst, dst);
+        char *error = mf_parse_subfield(&bundle->dst, dst);
+        if (error) {
+            return error;
+        }
+
+        if (!mf_nxm_header(bundle->dst.field->id)) {
+            return xasprintf("%s: experimenter OXM field '%s' not supported",
+                             s, dst);
+        }
     }
+
+    return NULL;
 }
 
 /* Converts a bundle action string contained in 's' to an nx_action_bundle and
- * stores it in 'b'.  Sets 'b''s l2 pointer to NULL. */
-void
+ * stores it in 'b'.  Sets 'b''s l2 pointer to NULL.
+ *
+ * Returns NULL if successful, otherwise a malloc()'d string describing the
+ * error.  The caller is responsible for freeing the returned string. */
+char * OVS_WARN_UNUSED_RESULT
 bundle_parse(const char *s, struct ofpbuf *ofpacts)
 {
     char *fields, *basis, *algorithm, *slave_type, *slave_delim;
     char *tokstr, *save_ptr;
+    char *error;
 
     save_ptr = NULL;
     tokstr = xstrdup(s);
@@ -323,18 +242,24 @@ bundle_parse(const char *s, struct ofpbuf *ofpacts)
     slave_type = strtok_r(NULL, ", ", &save_ptr);
     slave_delim = strtok_r(NULL, ": ", &save_ptr);
 
-    bundle_parse__(s, &save_ptr, fields, basis, algorithm, slave_type, NULL,
-                   slave_delim, ofpacts);
+    error = bundle_parse__(s, &save_ptr, fields, basis, algorithm, slave_type,
+                           NULL, slave_delim, ofpacts);
     free(tokstr);
+
+    return error;
 }
 
 /* Converts a bundle_load action string contained in 's' to an nx_action_bundle
- * and stores it in 'b'.  Sets 'b''s l2 pointer to NULL. */
-void
+ * and stores it in 'b'.  Sets 'b''s l2 pointer to NULL.
+ *
+ * Returns NULL if successful, otherwise a malloc()'d string describing the
+ * error.  The caller is responsible for freeing the returned string.*/
+char * OVS_WARN_UNUSED_RESULT
 bundle_parse_load(const char *s, struct ofpbuf *ofpacts)
 {
     char *fields, *basis, *algorithm, *slave_type, *dst, *slave_delim;
     char *tokstr, *save_ptr;
+    char *error;
 
     save_ptr = NULL;
     tokstr = xstrdup(s);
@@ -345,10 +270,12 @@ bundle_parse_load(const char *s, struct ofpbuf *ofpacts)
     dst = strtok_r(NULL, ", ", &save_ptr);
     slave_delim = strtok_r(NULL, ": ", &save_ptr);
 
-    bundle_parse__(s, &save_ptr, fields, basis, algorithm, slave_type, dst,
-                   slave_delim, ofpacts);
+    error = bundle_parse__(s, &save_ptr, fields, basis, algorithm, slave_type,
+                           dst, slave_delim, ofpacts);
 
     free(tokstr);
+
+    return error;
 }
 
 /* Appends a human-readable representation of 'nab' to 's'. */
@@ -387,7 +314,7 @@ bundle_format(const struct ofpact_bundle *bundle, struct ds *s)
             ds_put_cstr(s, ",");
         }
 
-        ds_put_format(s, "%"PRIu16, bundle->slaves[i]);
+        ofputil_format_port(bundle->slaves[i], s);
     }
 
     ds_put_cstr(s, ")");