Makefile.am: Clean flake8-check too.
[cascardo/ovs.git] / lib / multipath.c
index dbd5704..0a58c06 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
+ * Copyright (c) 2010, 2011, 2012, 2013, 2014 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-util.h"
 #include "openflow/nicira-ext.h"
 #include "packets.h"
-#include "vlog.h"
-
-VLOG_DEFINE_THIS_MODULE(multipath);
-
-static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 \f
-/* Converts 'nam' into 'mp'.  Returns 0 if successful, otherwise an
- * OFPERR_*. */
-enum ofperr
-multipath_from_openflow(const struct nx_action_multipath *nam,
-                        struct ofpact_multipath *mp)
-{
-    uint32_t n_links = ntohs(nam->max_link) + 1;
-    size_t min_n_bits = log_2_ceil(n_links);
-
-    ofpact_init_MULTIPATH(mp);
-    mp->fields = ntohs(nam->fields);
-    mp->basis = ntohs(nam->basis);
-    mp->algorithm = ntohs(nam->algorithm);
-    mp->max_link = ntohs(nam->max_link);
-    mp->arg = ntohl(nam->arg);
-    mp->dst.field = mf_from_nxm_header(ntohl(nam->dst));
-    mp->dst.ofs = nxm_decode_ofs(nam->ofs_nbits);
-    mp->dst.n_bits = nxm_decode_n_bits(nam->ofs_nbits);
-
-    if (!flow_hash_fields_valid(mp->fields)) {
-        VLOG_WARN_RL(&rl, "unsupported fields %d", (int) mp->fields);
-        return OFPERR_OFPBAC_BAD_ARGUMENT;
-    } else if (mp->algorithm != NX_MP_ALG_MODULO_N
-               && mp->algorithm != NX_MP_ALG_HASH_THRESHOLD
-               && mp->algorithm != NX_MP_ALG_HRW
-               && mp->algorithm != NX_MP_ALG_ITER_HASH) {
-        VLOG_WARN_RL(&rl, "unsupported algorithm %d", (int) mp->algorithm);
-        return OFPERR_OFPBAC_BAD_ARGUMENT;
-    } else if (mp->dst.n_bits < min_n_bits) {
-        VLOG_WARN_RL(&rl, "multipath action requires at least %zu bits for "
-                     "%"PRIu32" links", min_n_bits, n_links);
-        return OFPERR_OFPBAC_BAD_ARGUMENT;
-    }
-
-    return multipath_check(mp, NULL);
-}
-
 /* Checks that 'mp' is valid on flow.  Returns 0 if it is valid, otherwise an
  * OFPERR_*. */
 enum ofperr
@@ -79,22 +37,6 @@ multipath_check(const struct ofpact_multipath *mp,
 {
     return mf_check_dst(&mp->dst, flow);
 }
-
-/* Converts 'mp' into an OpenFlow NXAST_MULTIPATH action, which it appends to
- * 'openflow'. */
-void
-multipath_to_nxast(const struct ofpact_multipath *mp, struct ofpbuf *openflow)
-{
-    struct nx_action_multipath *nam = ofputil_put_NXAST_MULTIPATH(openflow);
-
-    nam->fields = htons(mp->fields);
-    nam->basis = htons(mp->basis);
-    nam->algorithm = htons(mp->algorithm);
-    nam->max_link = htons(mp->max_link);
-    nam->arg = htonl(mp->arg);
-    nam->ofs_nbits = nxm_encode_ofs_nbits(mp->dst.ofs, mp->dst.n_bits);
-    nam->dst = htonl(mp->dst.field->nxm_header);
-}
 \f
 /* multipath_execute(). */
 
@@ -113,8 +55,8 @@ multipath_execute(const struct ofpact_multipath *mp, struct flow *flow,
     uint16_t link = multipath_algorithm(hash, mp->algorithm,
                                         mp->max_link + 1, mp->arg);
 
-    flow_mask_hash_fields(wc, mp->fields);
-    nxm_reg_load(&mp->dst, link, flow);
+    flow_mask_hash_fields(flow, wc, mp->fields);
+    nxm_reg_load(&mp->dst, link, flow, wc);
 }
 
 static uint16_t
@@ -189,20 +131,20 @@ multipath_algorithm(uint32_t hash, enum nx_mp_algorithm algorithm,
         return algorithm_iter_hash(hash, n_links, arg);
     }
 
-    NOT_REACHED();
+    OVS_NOT_REACHED();
 }
 \f
 /* Parses 's_' as a set of arguments to the "multipath" action and initializes
  * 'mp' accordingly.  ovs-ofctl(8) describes the format parsed.
  *
- * Prints an error on stderr and aborts the program if 's_' syntax is
- * invalid. */
-void
-multipath_parse(struct ofpact_multipath *mp, const char *s_)
+ * 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
+multipath_parse__(struct ofpact_multipath *mp, const char *s_, char *s)
 {
-    char *s = xstrdup(s_);
     char *save_ptr = NULL;
     char *fields, *basis, *algorithm, *n_links_str, *arg, *dst;
+    char *error;
     int n_links;
 
     fields = strtok_r(s, ", ", &save_ptr);
@@ -212,7 +154,7 @@ multipath_parse(struct ofpact_multipath *mp, const char *s_)
     arg = strtok_r(NULL, ", ", &save_ptr);
     dst = strtok_r(NULL, ", ", &save_ptr);
     if (!dst) {
-        ovs_fatal(0, "%s: not enough arguments to multipath action", s_);
+        return xasprintf("%s: not enough arguments to multipath action", s_);
     }
 
     ofpact_init_MULTIPATH(mp);
@@ -220,8 +162,12 @@ multipath_parse(struct ofpact_multipath *mp, const char *s_)
         mp->fields = NX_HASH_FIELDS_ETH_SRC;
     } else if (!strcasecmp(fields, "symmetric_l4")) {
         mp->fields = NX_HASH_FIELDS_SYMMETRIC_L4;
+    } else if (!strcasecmp(fields, "symmetric_l3l4")) {
+        mp->fields = NX_HASH_FIELDS_SYMMETRIC_L3L4;
+    } else if (!strcasecmp(fields, "symmetric_l3l4+udp")) {
+        mp->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);
     }
     mp->basis = atoi(basis);
     if (!strcasecmp(algorithm, "modulo_n")) {
@@ -233,24 +179,45 @@ multipath_parse(struct ofpact_multipath *mp, const char *s_)
     } else if (!strcasecmp(algorithm, "iter_hash")) {
         mp->algorithm = NX_MP_ALG_ITER_HASH;
     } else {
-        ovs_fatal(0, "%s: unknown algorithm `%s'", s_, algorithm);
+        return xasprintf("%s: unknown algorithm `%s'", s_, algorithm);
     }
     n_links = atoi(n_links_str);
     if (n_links < 1 || n_links > 65536) {
-        ovs_fatal(0, "%s: n_links %d is not in valid range 1 to 65536",
-                  s_, n_links);
+        return xasprintf("%s: n_links %d is not in valid range 1 to 65536",
+                         s_, n_links);
     }
     mp->max_link = n_links - 1;
     mp->arg = atoi(arg);
 
-    mf_parse_subfield(&mp->dst, dst);
+    error = mf_parse_subfield(&mp->dst, dst);
+    if (error) {
+        return error;
+    }
+    if (!mf_nxm_header(mp->dst.field->id)) {
+        return xasprintf("%s: experimenter OXM field '%s' not supported",
+                         s, dst);
+    }
     if (mp->dst.n_bits < 16 && n_links > (1u << mp->dst.n_bits)) {
-        ovs_fatal(0, "%s: %d-bit destination field has %u possible values, "
-                  "less than specified n_links %d",
-                  s_, mp->dst.n_bits, 1u << mp->dst.n_bits, n_links);
+        return xasprintf("%s: %d-bit destination field has %u possible "
+                         "values, less than specified n_links %d",
+                         s_, mp->dst.n_bits, 1u << mp->dst.n_bits, n_links);
     }
 
+    return NULL;
+}
+
+/* Parses 's_' as a set of arguments to the "multipath" action and initializes
+ * 'mp' accordingly.  ovs-ofctl(8) describes the format parsed.
+ *
+ * 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
+multipath_parse(struct ofpact_multipath *mp, const char *s_)
+{
+    char *s = xstrdup(s_);
+    char *error = multipath_parse__(mp, s_, s);
     free(s);
+    return error;
 }
 
 /* Appends a description of 'mp' to 's', in the format that ovs-ofctl(8)