ofp-util: Clean up cookie handling.
[sliver-openvswitch.git] / lib / ofp-parse.c
index c630ccd..73a70c6 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2011, 2012 Nicira Networks.
+ * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,6 +41,9 @@
 
 VLOG_DEFINE_THIS_MODULE(ofp_parse);
 
+static void ofp_fatal(const char *flow, bool verbose, const char *format, ...)
+    NO_RETURN;
+
 static uint8_t
 str_to_table_id(const char *str)
 {
@@ -124,7 +127,7 @@ put_output_action(struct ofpbuf *b, uint16_t port)
 {
     struct ofp_action_output *oao;
 
-    oao = ofputil_put_OFPAT_OUTPUT(b);
+    oao = ofputil_put_OFPAT10_OUTPUT(b);
     oao->port = htons(port);
     return oao;
 }
@@ -141,7 +144,7 @@ parse_enqueue(struct ofpbuf *b, char *arg)
         ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
     }
 
-    oae = ofputil_put_OFPAT_ENQUEUE(b);
+    oae = ofputil_put_OFPAT10_ENQUEUE(b);
     oae->port = htons(str_to_u32(port));
     oae->queue_id = htonl(str_to_u32(queue));
 }
@@ -320,47 +323,47 @@ parse_named_action(enum ofputil_action_code code, const struct flow *flow,
     struct ofp_action_tp_port *oata;
 
     switch (code) {
-    case OFPUTIL_OFPAT_OUTPUT:
+    case OFPUTIL_OFPAT10_OUTPUT:
         parse_output(b, arg);
         break;
 
-    case OFPUTIL_OFPAT_SET_VLAN_VID:
-        oavv = ofputil_put_OFPAT_SET_VLAN_VID(b);
+    case OFPUTIL_OFPAT10_SET_VLAN_VID:
+        oavv = ofputil_put_OFPAT10_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);
+    case OFPUTIL_OFPAT10_SET_VLAN_PCP:
+        oavp = ofputil_put_OFPAT10_SET_VLAN_PCP(b);
         oavp->vlan_pcp = str_to_u32(arg);
         break;
 
-    case OFPUTIL_OFPAT_STRIP_VLAN:
-        ofputil_put_OFPAT_STRIP_VLAN(b);
+    case OFPUTIL_OFPAT10_STRIP_VLAN:
+        ofputil_put_OFPAT10_STRIP_VLAN(b);
         break;
 
-    case OFPUTIL_OFPAT_SET_DL_SRC:
-    case OFPUTIL_OFPAT_SET_DL_DST:
+    case OFPUTIL_OFPAT10_SET_DL_SRC:
+    case OFPUTIL_OFPAT10_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:
+    case OFPUTIL_OFPAT10_SET_NW_SRC:
+    case OFPUTIL_OFPAT10_SET_NW_DST:
         oana = ofputil_put_action(code, b);
         str_to_ip(arg, &oana->nw_addr);
         break;
 
-    case OFPUTIL_OFPAT_SET_NW_TOS:
-        ofputil_put_OFPAT_SET_NW_TOS(b)->nw_tos = str_to_u32(arg);
+    case OFPUTIL_OFPAT10_SET_NW_TOS:
+        ofputil_put_OFPAT10_SET_NW_TOS(b)->nw_tos = str_to_u32(arg);
         break;
 
-    case OFPUTIL_OFPAT_SET_TP_SRC:
-    case OFPUTIL_OFPAT_SET_TP_DST:
+    case OFPUTIL_OFPAT10_SET_TP_SRC:
+    case OFPUTIL_OFPAT10_SET_TP_DST:
         oata = ofputil_put_action(code, b);
         oata->tp_port = htons(str_to_u32(arg));
         break;
 
-    case OFPUTIL_OFPAT_ENQUEUE:
+    case OFPUTIL_OFPAT10_ENQUEUE:
         parse_enqueue(b, arg);
         break;
 
@@ -589,6 +592,12 @@ parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
     cls_rule_init_catchall(&fm->cr, OFP_DEFAULT_PRIORITY);
     fm->cookie = htonll(0);
     fm->cookie_mask = htonll(0);
+    if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
+        /* For modify, by default, don't update the cookie. */
+        fm->new_cookie = htonll(UINT64_MAX);
+    } else{
+        fm->new_cookie = htonll(0);
+    }
     fm->table_id = 0xff;
     fm->command = command;
     fm->idle_timeout = OFP_FLOW_PERMANENT;
@@ -643,17 +652,24 @@ parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
                 fm->hard_timeout = str_to_u16(value, name);
             } else if (!strcmp(name, "cookie")) {
                 char *mask = strchr(value, '/');
+
                 if (mask) {
+                    /* A mask means we're searching for a cookie. */
                     if (command == OFPFC_ADD) {
                         ofp_fatal(str_, verbose, "flow additions cannot use "
                                   "a cookie mask");
                     }
                     *mask = '\0';
+                    fm->cookie = htonll(str_to_u64(value));
                     fm->cookie_mask = htonll(str_to_u64(mask+1));
                 } else {
-                    fm->cookie_mask = htonll(UINT64_MAX);
+                    /* No mask means that the cookie is being set. */
+                    if (command != OFPFC_ADD && command != OFPFC_MODIFY
+                            && command != OFPFC_MODIFY_STRICT) {
+                        ofp_fatal(str_, verbose, "cannot set cookie");
+                    }
+                    fm->new_cookie = htonll(str_to_u64(value));
                 }
-                fm->cookie = htonll(str_to_u64(value));
             } else if (mf_from_name(name)) {
                 parse_field(mf_from_name(name), value, &fm->cr);
             } else if (!strcmp(name, "duration")
@@ -667,6 +683,13 @@ parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
             }
         }
     }
+    if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
+            && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
+        /* On modifies without a mask, we are supposed to add a flow if
+         * one does not exist.  If a cookie wasn't been specified, use a
+         * default of zero. */
+        fm->new_cookie = htonll(0);
+    }
     if (fields & F_ACTIONS) {
         struct ofpbuf actions;
 
@@ -755,3 +778,80 @@ parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
     fsr->out_port = fm.out_port;
     fsr->table_id = fm.table_id;
 }
+
+/* Parses a specification of a flow from 's' into 'flow'.  's' must take the
+ * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
+ * mf_field.  Fields must be specified in a natural order for satisfying
+ * prerequisites.
+ *
+ * Returns NULL on success, otherwise a malloc()'d string that explains the
+ * problem. */
+char *
+parse_ofp_exact_flow(struct flow *flow, const char *s)
+{
+    char *pos, *key, *value_s;
+    char *error = NULL;
+    char *copy;
+
+    memset(flow, 0, sizeof *flow);
+
+    pos = copy = xstrdup(s);
+    while (ofputil_parse_key_value(&pos, &key, &value_s)) {
+        const struct protocol *p;
+        if (parse_protocol(key, &p)) {
+            if (flow->dl_type) {
+                error = xasprintf("%s: Ethernet type set multiple times", s);
+                goto exit;
+            }
+            flow->dl_type = htons(p->dl_type);
+
+            if (p->nw_proto) {
+                if (flow->nw_proto) {
+                    error = xasprintf("%s: network protocol set "
+                                      "multiple times", s);
+                    goto exit;
+                }
+                flow->nw_proto = p->nw_proto;
+            }
+        } else {
+            const struct mf_field *mf;
+            union mf_value value;
+            char *field_error;
+
+            mf = mf_from_name(key);
+            if (!mf) {
+                error = xasprintf("%s: unknown field %s", s, key);
+                goto exit;
+            }
+
+            if (!mf_are_prereqs_ok(mf, flow)) {
+                error = xasprintf("%s: prerequisites not met for setting %s",
+                                  s, key);
+                goto exit;
+            }
+
+            if (!mf_is_zero(mf, flow)) {
+                error = xasprintf("%s: field %s set multiple times", s, key);
+                goto exit;
+            }
+
+            field_error = mf_parse_value(mf, value_s, &value);
+            if (field_error) {
+                error = xasprintf("%s: bad value for %s (%s)",
+                                  s, key, field_error);
+                free(field_error);
+                goto exit;
+            }
+
+            mf_set_flow_value(mf, &value, flow);
+        }
+    }
+
+exit:
+    free(copy);
+
+    if (error) {
+        memset(flow, 0, sizeof *flow);
+    }
+    return error;
+}