lib/ofp-parse.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "ofp-parse.h"
  20
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <stdlib.h>
  24
  25 #include "bundle.h"
  26 #include "byte-order.h"
  27 #include "dynamic-string.h"
  28 #include "learn.h"
  29 #include "meta-flow.h"
  30 #include "multipath.h"
  31 #include "netdev.h"
  32 #include "nx-match.h"
  33 #include "ofp-actions.h"
  34 #include "ofp-util.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "ovs-thread.h"
  38 #include "packets.h"
  39 #include "simap.h"
  40 #include "socket-util.h"
  41 #include "vconn.h"
  42
  43 /* Parses 'str' as an 8-bit unsigned integer into '*valuep'.
  44  *
  45  * 'name' describes the value parsed in an error message, if any.
  46  *
  47  * Returns NULL if successful, otherwise a malloc()'d string describing the
  48  * error.  The caller is responsible for freeing the returned string. */
  49 static char * WARN_UNUSED_RESULT
  50 str_to_u8(const char *str, const char *name, uint8_t *valuep)
  51 {
  52     int value;
  53
  54     if (!str_to_int(str, 0, &value) || value < 0 || value > 255) {
  55         return xasprintf("invalid %s \"%s\"", name, str);
  56     }
  57     *valuep = value;
  58     return NULL;
  59 }
  60
  61 /* Parses 'str' as a 16-bit unsigned integer into '*valuep'.
  62  *
  63  * 'name' describes the value parsed in an error message, if any.
  64  *
  65  * Returns NULL if successful, otherwise a malloc()'d string describing the
  66  * error.  The caller is responsible for freeing the returned string. */
  67 static char * WARN_UNUSED_RESULT
  68 str_to_u16(const char *str, const char *name, uint16_t *valuep)
  69 {
  70     int value;
  71
  72     if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
  73         return xasprintf("invalid %s \"%s\"", name, str);
  74     }
  75     *valuep = value;
  76     return NULL;
  77 }
  78
  79 /* Parses 'str' as a 32-bit unsigned integer into '*valuep'.
  80  *
  81  * Returns NULL if successful, otherwise a malloc()'d string describing the
  82  * error.  The caller is responsible for freeing the returned string. */
  83 static char * WARN_UNUSED_RESULT
  84 str_to_u32(const char *str, uint32_t *valuep)
  85 {
  86     char *tail;
  87     uint32_t value;
  88
  89     if (!str[0]) {
  90         return xstrdup("missing required numeric argument");
  91     }
  92
  93     errno = 0;
  94     value = strtoul(str, &tail, 0);
  95     if (errno == EINVAL || errno == ERANGE || *tail) {
  96         return xasprintf("invalid numeric format %s", str);
  97     }
  98     *valuep = value;
  99     return NULL;
 100 }
 101
 102 /* Parses 'str' as an 64-bit unsigned integer into '*valuep'.
 103  *
 104  * Returns NULL if successful, otherwise a malloc()'d string describing the
 105  * error.  The caller is responsible for freeing the returned string. */
 106 static char * WARN_UNUSED_RESULT
 107 str_to_u64(const char *str, uint64_t *valuep)
 108 {
 109     char *tail;
 110     uint64_t value;
 111
 112     if (!str[0]) {
 113         return xstrdup("missing required numeric argument");
 114     }
 115
 116     errno = 0;
 117     value = strtoull(str, &tail, 0);
 118     if (errno == EINVAL || errno == ERANGE || *tail) {
 119         return xasprintf("invalid numeric format %s", str);
 120     }
 121     *valuep = value;
 122     return NULL;
 123 }
 124
 125 /* Parses 'str' as an 64-bit unsigned integer in network byte order into
 126  * '*valuep'.
 127  *
 128  * Returns NULL if successful, otherwise a malloc()'d string describing the
 129  * error.  The caller is responsible for freeing the returned string. */
 130 static char * WARN_UNUSED_RESULT
 131 str_to_be64(const char *str, ovs_be64 *valuep)
 132 {
 133     uint64_t value = 0;
 134     char *error;
 135
 136     error = str_to_u64(str, &value);
 137     if (!error) {
 138         *valuep = htonll(value);
 139     }
 140     return error;
 141 }
 142
 143 /* Parses 'str' as an Ethernet address into 'mac'.
 144  *
 145  * Returns NULL if successful, otherwise a malloc()'d string describing the
 146  * error.  The caller is responsible for freeing the returned string. */
 147 static char * WARN_UNUSED_RESULT
 148 str_to_mac(const char *str, uint8_t mac[6])
 149 {
 150     if (!ovs_scan(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))) {
 151         return xasprintf("invalid mac address %s", str);
 152     }
 153     return NULL;
 154 }
 155
 156 /* Parses 'str' as an IP address into '*ip'.
 157  *
 158  * Returns NULL if successful, otherwise a malloc()'d string describing the
 159  * error.  The caller is responsible for freeing the returned string. */
 160 static char * WARN_UNUSED_RESULT
 161 str_to_ip(const char *str, ovs_be32 *ip)
 162 {
 163     struct in_addr in_addr;
 164
 165     if (lookup_ip(str, &in_addr)) {
 166         return xasprintf("%s: could not convert to IP address", str);
 167     }
 168     *ip = in_addr.s_addr;
 169     return NULL;
 170 }
 171
 172 /* Parses 'arg' as the argument to an "enqueue" action, and appends such an
 173  * action to 'ofpacts'.
 174  *
 175  * Returns NULL if successful, otherwise a malloc()'d string describing the
 176  * error.  The caller is responsible for freeing the returned string. */
 177 static char * WARN_UNUSED_RESULT
 178 parse_enqueue(char *arg, struct ofpbuf *ofpacts)
 179 {
 180     char *sp = NULL;
 181     char *port = strtok_r(arg, ":q,", &sp);
 182     char *queue = strtok_r(NULL, "", &sp);
 183     struct ofpact_enqueue *enqueue;
 184
 185     if (port == NULL || queue == NULL) {
 186         return xstrdup("\"enqueue\" syntax is \"enqueue:PORT:QUEUE\" or "
 187                        "\"enqueue(PORT,QUEUE)\"");
 188     }
 189
 190     enqueue = ofpact_put_ENQUEUE(ofpacts);
 191     if (!ofputil_port_from_string(port, &enqueue->port)) {
 192         return xasprintf("%s: enqueue to unknown port", port);
 193     }
 194     return str_to_u32(queue, &enqueue->queue);
 195 }
 196
 197 /* Parses 'arg' as the argument to an "output" action, and appends such an
 198  * action to 'ofpacts'.
 199  *
 200  * Returns NULL if successful, otherwise a malloc()'d string describing the
 201  * error.  The caller is responsible for freeing the returned string. */
 202 static char * WARN_UNUSED_RESULT
 203 parse_output(const char *arg, struct ofpbuf *ofpacts)
 204 {
 205     if (strchr(arg, '[')) {
 206         struct ofpact_output_reg *output_reg;
 207
 208         output_reg = ofpact_put_OUTPUT_REG(ofpacts);
 209         output_reg->max_len = UINT16_MAX;
 210         return mf_parse_subfield(&output_reg->src, arg);
 211     } else {
 212         struct ofpact_output *output;
 213
 214         output = ofpact_put_OUTPUT(ofpacts);
 215         output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
 216         if (!ofputil_port_from_string(arg, &output->port)) {
 217             return xasprintf("%s: output to unknown port", arg);
 218         }
 219         return NULL;
 220     }
 221 }
 222
 223 /* Parses 'arg' as the argument to an "resubmit" action, and appends such an
 224  * action to 'ofpacts'.
 225  *
 226  * Returns NULL if successful, otherwise a malloc()'d string describing the
 227  * error.  The caller is responsible for freeing the returned string. */
 228 static char * WARN_UNUSED_RESULT
 229 parse_resubmit(char *arg, struct ofpbuf *ofpacts)
 230 {
 231     struct ofpact_resubmit *resubmit;
 232     char *in_port_s, *table_s;
 233
 234     resubmit = ofpact_put_RESUBMIT(ofpacts);
 235
 236     in_port_s = strsep(&arg, ",");
 237     if (in_port_s && in_port_s[0]) {
 238         if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
 239             return xasprintf("%s: resubmit to unknown port", in_port_s);
 240         }
 241     } else {
 242         resubmit->in_port = OFPP_IN_PORT;
 243     }
 244
 245     table_s = strsep(&arg, ",");
 246     if (table_s && table_s[0]) {
 247         uint32_t table_id = 0;
 248         char *error;
 249
 250         error = str_to_u32(table_s, &table_id);
 251         if (error) {
 252             return error;
 253         }
 254         resubmit->table_id = table_id;
 255     } else {
 256         resubmit->table_id = 255;
 257     }
 258
 259     if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
 260         return xstrdup("at least one \"in_port\" or \"table\" must be "
 261                        "specified  on resubmit");
 262     }
 263     return NULL;
 264 }
 265
 266 /* Parses 'arg' as the argument to a "note" action, and appends such an action
 267  * to 'ofpacts'.
 268  *
 269  * Returns NULL if successful, otherwise a malloc()'d string describing the
 270  * error.  The caller is responsible for freeing the returned string. */
 271 static char * WARN_UNUSED_RESULT
 272 parse_note(const char *arg, struct ofpbuf *ofpacts)
 273 {
 274     struct ofpact_note *note;
 275
 276     note = ofpact_put_NOTE(ofpacts);
 277     while (*arg != '\0') {
 278         uint8_t byte;
 279         bool ok;
 280
 281         if (*arg == '.') {
 282             arg++;
 283         }
 284         if (*arg == '\0') {
 285             break;
 286         }
 287
 288         byte = hexits_value(arg, 2, &ok);
 289         if (!ok) {
 290             return xstrdup("bad hex digit in `note' argument");
 291         }
 292         ofpbuf_put(ofpacts, &byte, 1);
 293
 294         note = ofpacts->l2;
 295         note->length++;
 296
 297         arg += 2;
 298     }
 299     ofpact_update_len(ofpacts, &note->ofpact);
 300     return NULL;
 301 }
 302
 303 /* Parses 'arg' as the argument to a "fin_timeout" action, and appends such an
 304  * action to 'ofpacts'.
 305  *
 306  * Returns NULL if successful, otherwise a malloc()'d string describing the
 307  * error.  The caller is responsible for freeing the returned string. */
 308 static char * WARN_UNUSED_RESULT
 309 parse_fin_timeout(struct ofpbuf *b, char *arg)
 310 {
 311     struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
 312     char *key, *value;
 313
 314     while (ofputil_parse_key_value(&arg, &key, &value)) {
 315         char *error;
 316
 317         if (!strcmp(key, "idle_timeout")) {
 318             error =  str_to_u16(value, key, &oft->fin_idle_timeout);
 319         } else if (!strcmp(key, "hard_timeout")) {
 320             error = str_to_u16(value, key, &oft->fin_hard_timeout);
 321         } else {
 322             error = xasprintf("invalid key '%s' in 'fin_timeout' argument",
 323                               key);
 324         }
 325
 326         if (error) {
 327             return error;
 328         }
 329     }
 330     return NULL;
 331 }
 332
 333 /* Parses 'arg' as the argument to a "controller" action, and appends such an
 334  * action to 'ofpacts'.
 335  *
 336  * Returns NULL if successful, otherwise a malloc()'d string describing the
 337  * error.  The caller is responsible for freeing the returned string. */
 338 static char * WARN_UNUSED_RESULT
 339 parse_controller(struct ofpbuf *b, char *arg)
 340 {
 341     enum ofp_packet_in_reason reason = OFPR_ACTION;
 342     uint16_t controller_id = 0;
 343     uint16_t max_len = UINT16_MAX;
 344
 345     if (!arg[0]) {
 346         /* Use defaults. */
 347     } else if (strspn(arg, "0123456789") == strlen(arg)) {
 348         char *error = str_to_u16(arg, "max_len", &max_len);
 349         if (error) {
 350             return error;
 351         }
 352     } else {
 353         char *name, *value;
 354
 355         while (ofputil_parse_key_value(&arg, &name, &value)) {
 356             if (!strcmp(name, "reason")) {
 357                 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
 358                     return xasprintf("unknown reason \"%s\"", value);
 359                 }
 360             } else if (!strcmp(name, "max_len")) {
 361                 char *error = str_to_u16(value, "max_len", &max_len);
 362                 if (error) {
 363                     return error;
 364                 }
 365             } else if (!strcmp(name, "id")) {
 366                 char *error = str_to_u16(value, "id", &controller_id);
 367                 if (error) {
 368                     return error;
 369                 }
 370             } else {
 371                 return xasprintf("unknown key \"%s\" parsing controller "
 372                                  "action", name);
 373             }
 374         }
 375     }
 376
 377     if (reason == OFPR_ACTION && controller_id == 0) {
 378         struct ofpact_output *output;
 379
 380         output = ofpact_put_OUTPUT(b);
 381         output->port = OFPP_CONTROLLER;
 382         output->max_len = max_len;
 383     } else {
 384         struct ofpact_controller *controller;
 385
 386         controller = ofpact_put_CONTROLLER(b);
 387         controller->max_len = max_len;
 388         controller->reason = reason;
 389         controller->controller_id = controller_id;
 390     }
 391
 392     return NULL;
 393 }
 394
 395 static void
 396 parse_noargs_dec_ttl(struct ofpbuf *b)
 397 {
 398     struct ofpact_cnt_ids *ids;
 399     uint16_t id = 0;
 400
 401     ids = ofpact_put_DEC_TTL(b);
 402     ofpbuf_put(b, &id, sizeof id);
 403     ids = b->l2;
 404     ids->n_controllers++;
 405     ofpact_update_len(b, &ids->ofpact);
 406 }
 407
 408 /* Parses 'arg' as the argument to a "dec_ttl" action, and appends such an
 409  * action to 'ofpacts'.
 410  *
 411  * Returns NULL if successful, otherwise a malloc()'d string describing the
 412  * error.  The caller is responsible for freeing the returned string. */
 413 static char * WARN_UNUSED_RESULT
 414 parse_dec_ttl(struct ofpbuf *b, char *arg)
 415 {
 416     if (*arg == '\0') {
 417         parse_noargs_dec_ttl(b);
 418     } else {
 419         struct ofpact_cnt_ids *ids;
 420         char *cntr;
 421
 422         ids = ofpact_put_DEC_TTL(b);
 423         ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
 424         for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
 425              cntr = strtok_r(NULL, ", ", &arg)) {
 426             uint16_t id = atoi(cntr);
 427
 428             ofpbuf_put(b, &id, sizeof id);
 429             ids = b->l2;
 430             ids->n_controllers++;
 431         }
 432         if (!ids->n_controllers) {
 433             return xstrdup("dec_ttl_cnt_ids: expected at least one controller "
 434                            "id.");
 435         }
 436         ofpact_update_len(b, &ids->ofpact);
 437     }
 438     return NULL;
 439 }
 440
 441 /* Parses 'arg' as the argument to a "set_mpls_label" action, and appends such
 442  * an action to 'b'.
 443  *
 444  * Returns NULL if successful, otherwise a malloc()'d string describing the
 445  * error.  The caller is responsible for freeing the returned string. */
 446 static char * WARN_UNUSED_RESULT
 447 parse_set_mpls_label(struct ofpbuf *b, const char *arg)
 448 {
 449     struct ofpact_mpls_label *mpls_label = ofpact_put_SET_MPLS_LABEL(b);
 450
 451     if (*arg == '\0') {
 452         return xstrdup("parse_set_mpls_label: expected label.");
 453     }
 454
 455     mpls_label->label = htonl(atoi(arg));
 456     return NULL;
 457 }
 458
 459 /* Parses 'arg' as the argument to a "set_mpls_tc" action, and appends such an
 460  * action to 'b'.
 461  *
 462  * Returns NULL if successful, otherwise a malloc()'d string describing the
 463  * error.  The caller is responsible for freeing the returned string. */
 464 static char * WARN_UNUSED_RESULT
 465 parse_set_mpls_tc(struct ofpbuf *b, const char *arg)
 466 {
 467     struct ofpact_mpls_tc *mpls_tc = ofpact_put_SET_MPLS_TC(b);
 468
 469     if (*arg == '\0') {
 470         return xstrdup("parse_set_mpls_tc: expected tc.");
 471     }
 472
 473     mpls_tc->tc = atoi(arg);
 474     return NULL;
 475 }
 476
 477 /* Parses 'arg' as the argument to a "set_mpls_ttl" action, and appends such an
 478  * action to 'ofpacts'.
 479  *
 480  * Returns NULL if successful, otherwise a malloc()'d string describing the
 481  * error.  The caller is responsible for freeing the returned string. */
 482 static char * WARN_UNUSED_RESULT
 483 parse_set_mpls_ttl(struct ofpbuf *b, const char *arg)
 484 {
 485     struct ofpact_mpls_ttl *mpls_ttl = ofpact_put_SET_MPLS_TTL(b);
 486
 487     if (*arg == '\0') {
 488         return xstrdup("parse_set_mpls_ttl: expected ttl.");
 489     }
 490
 491     mpls_ttl->ttl = atoi(arg);
 492     return NULL;
 493 }
 494
 495 /* Parses a "set_field" action with argument 'arg', appending the parsed
 496  * action to 'ofpacts'.
 497  *
 498  * Returns NULL if successful, otherwise a malloc()'d string describing the
 499  * error.  The caller is responsible for freeing the returned string. */
 500 static char * WARN_UNUSED_RESULT
 501 set_field_parse__(char *arg, struct ofpbuf *ofpacts,
 502                   enum ofputil_protocol *usable_protocols)
 503 {
 504     struct ofpact_set_field *sf = ofpact_put_SET_FIELD(ofpacts);
 505     char *value;
 506     char *delim;
 507     char *key;
 508     const struct mf_field *mf;
 509     char *error;
 510
 511     value = arg;
 512     delim = strstr(arg, "->");
 513     if (!delim) {
 514         return xasprintf("%s: missing `->'", arg);
 515     }
 516     if (strlen(delim) <= strlen("->")) {
 517         return xasprintf("%s: missing field name following `->'", arg);
 518     }
 519
 520     key = delim + strlen("->");
 521     mf = mf_from_name(key);
 522     if (!mf) {
 523         return xasprintf("%s is not a valid OXM field name", key);
 524     }
 525     if (!mf->writable) {
 526         return xasprintf("%s is read-only", key);
 527     }
 528     sf->field = mf;
 529     delim[0] = '\0';
 530     error = mf_parse_value(mf, value, &sf->value);
 531     if (error) {
 532         return error;
 533     }
 534
 535     if (!mf_is_value_valid(mf, &sf->value)) {
 536         return xasprintf("%s is not a valid value for field %s", value, key);
 537     }
 538
 539     *usable_protocols &= mf->usable_protocols;
 540     return NULL;
 541 }
 542
 543 /* Parses 'arg' as the argument to a "set_field" action, and appends such an
 544  * action to 'ofpacts'.
 545  *
 546  * Returns NULL if successful, otherwise a malloc()'d string describing the
 547  * error.  The caller is responsible for freeing the returned string. */
 548 static char * WARN_UNUSED_RESULT
 549 set_field_parse(const char *arg, struct ofpbuf *ofpacts,
 550                 enum ofputil_protocol *usable_protocols)
 551 {
 552     char *copy = xstrdup(arg);
 553     char *error = set_field_parse__(copy, ofpacts, usable_protocols);
 554     free(copy);
 555     return error;
 556 }
 557
 558 /* Parses 'arg' as the argument to a "write_metadata" instruction, and appends
 559  * such an action to 'ofpacts'.
 560  *
 561  * Returns NULL if successful, otherwise a malloc()'d string describing the
 562  * error.  The caller is responsible for freeing the returned string. */
 563 static char * WARN_UNUSED_RESULT
 564 parse_metadata(struct ofpbuf *b, char *arg)
 565 {
 566     struct ofpact_metadata *om;
 567     char *mask = strchr(arg, '/');
 568
 569     om = ofpact_put_WRITE_METADATA(b);
 570
 571     if (mask) {
 572         char *error;
 573
 574         *mask = '\0';
 575         error = str_to_be64(mask + 1, &om->mask);
 576         if (error) {
 577             return error;
 578         }
 579     } else {
 580         om->mask = OVS_BE64_MAX;
 581     }
 582
 583     return str_to_be64(arg, &om->metadata);
 584 }
 585
 586 /* Parses 'arg' as the argument to a "sample" action, and appends such an
 587  * action to 'ofpacts'.
 588  *
 589  * Returns NULL if successful, otherwise a malloc()'d string describing the
 590  * error.  The caller is responsible for freeing the returned string. */
 591 static char * WARN_UNUSED_RESULT
 592 parse_sample(struct ofpbuf *b, char *arg)
 593 {
 594     struct ofpact_sample *os = ofpact_put_SAMPLE(b);
 595     char *key, *value;
 596
 597     while (ofputil_parse_key_value(&arg, &key, &value)) {
 598         char *error = NULL;
 599
 600         if (!strcmp(key, "probability")) {
 601             error = str_to_u16(value, "probability", &os->probability);
 602             if (!error && os->probability == 0) {
 603                 error = xasprintf("invalid probability value \"%s\"", value);
 604             }
 605         } else if (!strcmp(key, "collector_set_id")) {
 606             error = str_to_u32(value, &os->collector_set_id);
 607         } else if (!strcmp(key, "obs_domain_id")) {
 608             error = str_to_u32(value, &os->obs_domain_id);
 609         } else if (!strcmp(key, "obs_point_id")) {
 610             error = str_to_u32(value, &os->obs_point_id);
 611         } else {
 612             error = xasprintf("invalid key \"%s\" in \"sample\" argument",
 613                               key);
 614         }
 615         if (error) {
 616             return error;
 617         }
 618     }
 619     if (os->probability == 0) {
 620         return xstrdup("non-zero \"probability\" must be specified on sample");
 621     }
 622     return NULL;
 623 }
 624
 625 /* Parses 'arg' as the argument to action 'code', and appends such an action to
 626  * 'ofpacts'.
 627  *
 628  * Returns NULL if successful, otherwise a malloc()'d string describing the
 629  * error.  The caller is responsible for freeing the returned string. */
 630 static char * WARN_UNUSED_RESULT
 631 parse_named_action(enum ofputil_action_code code,
 632                    char *arg, struct ofpbuf *ofpacts,
 633                    enum ofputil_protocol *usable_protocols)
 634 {
 635     size_t orig_size = ofpacts->size;
 636     struct ofpact_tunnel *tunnel;
 637     struct ofpact_vlan_vid *vlan_vid;
 638     struct ofpact_vlan_pcp *vlan_pcp;
 639     char *error = NULL;
 640     uint16_t ethertype = 0;
 641     uint16_t vid = 0;
 642     uint8_t tos = 0, ecn, ttl;
 643     uint8_t pcp = 0;
 644
 645     switch (code) {
 646     case OFPUTIL_ACTION_INVALID:
 647         NOT_REACHED();
 648
 649     case OFPUTIL_OFPAT10_OUTPUT:
 650     case OFPUTIL_OFPAT11_OUTPUT:
 651         error = parse_output(arg, ofpacts);
 652         break;
 653
 654     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 655     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 656         error = str_to_u16(arg, "VLAN VID", &vid);
 657         if (error) {
 658             return error;
 659         }
 660
 661         if (vid & ~VLAN_VID_MASK) {
 662             return xasprintf("%s: not a valid VLAN VID", arg);
 663         }
 664         vlan_vid = ofpact_put_SET_VLAN_VID(ofpacts);
 665         vlan_vid->vlan_vid = vid;
 666         vlan_vid->ofpact.compat = code;
 667         vlan_vid->push_vlan_if_needed = code == OFPUTIL_OFPAT10_SET_VLAN_VID;
 668         break;
 669
 670     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 671     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 672         error = str_to_u8(arg, "VLAN PCP", &pcp);
 673         if (error) {
 674             return error;
 675         }
 676
 677         if (pcp & ~7) {
 678             return xasprintf("%s: not a valid VLAN PCP", arg);
 679         }
 680         vlan_pcp = ofpact_put_SET_VLAN_PCP(ofpacts);
 681         vlan_pcp->vlan_pcp = pcp;
 682         vlan_pcp->ofpact.compat = code;
 683         vlan_pcp->push_vlan_if_needed = code == OFPUTIL_OFPAT10_SET_VLAN_PCP;
 684         break;
 685
 686     case OFPUTIL_OFPAT12_SET_FIELD:
 687         return set_field_parse(arg, ofpacts, usable_protocols);
 688
 689     case OFPUTIL_OFPAT10_STRIP_VLAN:
 690     case OFPUTIL_OFPAT11_POP_VLAN:
 691         ofpact_put_STRIP_VLAN(ofpacts)->ofpact.compat = code;
 692         break;
 693
 694     case OFPUTIL_OFPAT11_PUSH_VLAN:
 695         *usable_protocols &= OFPUTIL_P_OF11_UP;
 696         error = str_to_u16(arg, "ethertype", &ethertype);
 697         if (error) {
 698             return error;
 699         }
 700
 701         if (ethertype != ETH_TYPE_VLAN_8021Q) {
 702             /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
 703             return xasprintf("%s: not a valid VLAN ethertype", arg);
 704         }
 705
 706         ofpact_put_PUSH_VLAN(ofpacts);
 707         break;
 708
 709     case OFPUTIL_OFPAT11_SET_QUEUE:
 710         error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
 711         break;
 712
 713     case OFPUTIL_OFPAT10_SET_DL_SRC:
 714     case OFPUTIL_OFPAT11_SET_DL_SRC:
 715         error = str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
 716         break;
 717
 718     case OFPUTIL_OFPAT10_SET_DL_DST:
 719     case OFPUTIL_OFPAT11_SET_DL_DST:
 720         error = str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
 721         break;
 722
 723     case OFPUTIL_OFPAT10_SET_NW_SRC:
 724     case OFPUTIL_OFPAT11_SET_NW_SRC:
 725         error = str_to_ip(arg, &ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4);
 726         break;
 727
 728     case OFPUTIL_OFPAT10_SET_NW_DST:
 729     case OFPUTIL_OFPAT11_SET_NW_DST:
 730         error = str_to_ip(arg, &ofpact_put_SET_IPV4_DST(ofpacts)->ipv4);
 731         break;
 732
 733     case OFPUTIL_OFPAT10_SET_NW_TOS:
 734     case OFPUTIL_OFPAT11_SET_NW_TOS:
 735         error = str_to_u8(arg, "TOS", &tos);
 736         if (error) {
 737             return error;
 738         }
 739
 740         if (tos & ~IP_DSCP_MASK) {
 741             return xasprintf("%s: not a valid TOS", arg);
 742         }
 743         ofpact_put_SET_IP_DSCP(ofpacts)->dscp = tos;
 744         break;
 745
 746     case OFPUTIL_OFPAT11_SET_NW_ECN:
 747         error = str_to_u8(arg, "ECN", &ecn);
 748         if (error) {
 749             return error;
 750         }
 751
 752         if (ecn & ~IP_ECN_MASK) {
 753             return xasprintf("%s: not a valid ECN", arg);
 754         }
 755         ofpact_put_SET_IP_ECN(ofpacts)->ecn = ecn;
 756         break;
 757
 758     case OFPUTIL_OFPAT11_SET_NW_TTL:
 759         error = str_to_u8(arg, "TTL", &ttl);
 760         if (error) {
 761             return error;
 762         }
 763
 764         ofpact_put_SET_IP_TTL(ofpacts)->ttl = ttl;
 765         break;
 766
 767     case OFPUTIL_OFPAT11_DEC_NW_TTL:
 768         NOT_REACHED();
 769
 770     case OFPUTIL_OFPAT10_SET_TP_SRC:
 771     case OFPUTIL_OFPAT11_SET_TP_SRC:
 772         error = str_to_u16(arg, "source port",
 773                            &ofpact_put_SET_L4_SRC_PORT(ofpacts)->port);
 774         break;
 775
 776     case OFPUTIL_OFPAT10_SET_TP_DST:
 777     case OFPUTIL_OFPAT11_SET_TP_DST:
 778         error = str_to_u16(arg, "destination port",
 779                            &ofpact_put_SET_L4_DST_PORT(ofpacts)->port);
 780         break;
 781
 782     case OFPUTIL_OFPAT10_ENQUEUE:
 783         error = parse_enqueue(arg, ofpacts);
 784         break;
 785
 786     case OFPUTIL_NXAST_RESUBMIT:
 787         error = parse_resubmit(arg, ofpacts);
 788         break;
 789
 790     case OFPUTIL_NXAST_SET_TUNNEL:
 791     case OFPUTIL_NXAST_SET_TUNNEL64:
 792         tunnel = ofpact_put_SET_TUNNEL(ofpacts);
 793         tunnel->ofpact.compat = code;
 794         error = str_to_u64(arg, &tunnel->tun_id);
 795         break;
 796
 797     case OFPUTIL_NXAST_WRITE_METADATA:
 798         error = parse_metadata(ofpacts, arg);
 799         break;
 800
 801     case OFPUTIL_NXAST_SET_QUEUE:
 802         error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
 803         break;
 804
 805     case OFPUTIL_NXAST_POP_QUEUE:
 806         ofpact_put_POP_QUEUE(ofpacts);
 807         break;
 808
 809     case OFPUTIL_NXAST_REG_MOVE:
 810         error = nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
 811         break;
 812
 813     case OFPUTIL_NXAST_REG_LOAD:
 814         error = nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
 815         break;
 816
 817     case OFPUTIL_NXAST_NOTE:
 818         error = parse_note(arg, ofpacts);
 819         break;
 820
 821     case OFPUTIL_NXAST_MULTIPATH:
 822         error = multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
 823         break;
 824
 825     case OFPUTIL_NXAST_BUNDLE:
 826         error = bundle_parse(arg, ofpacts);
 827         break;
 828
 829     case OFPUTIL_NXAST_BUNDLE_LOAD:
 830         error = bundle_parse_load(arg, ofpacts);
 831         break;
 832
 833     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 834     case OFPUTIL_NXAST_OUTPUT_REG:
 835     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 836         NOT_REACHED();
 837
 838     case OFPUTIL_NXAST_LEARN:
 839         error = learn_parse(arg, ofpacts);
 840         break;
 841
 842     case OFPUTIL_NXAST_EXIT:
 843         ofpact_put_EXIT(ofpacts);
 844         break;
 845
 846     case OFPUTIL_NXAST_DEC_TTL:
 847         error = parse_dec_ttl(ofpacts, arg);
 848         break;
 849
 850     case OFPUTIL_NXAST_SET_MPLS_LABEL:
 851     case OFPUTIL_OFPAT11_SET_MPLS_LABEL:
 852         error = parse_set_mpls_label(ofpacts, arg);
 853         break;
 854
 855     case OFPUTIL_NXAST_SET_MPLS_TC:
 856     case OFPUTIL_OFPAT11_SET_MPLS_TC:
 857         error = parse_set_mpls_tc(ofpacts, arg);
 858         break;
 859
 860     case OFPUTIL_NXAST_SET_MPLS_TTL:
 861     case OFPUTIL_OFPAT11_SET_MPLS_TTL:
 862         error = parse_set_mpls_ttl(ofpacts, arg);
 863         break;
 864
 865     case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
 866     case OFPUTIL_NXAST_DEC_MPLS_TTL:
 867         ofpact_put_DEC_MPLS_TTL(ofpacts);
 868         break;
 869
 870     case OFPUTIL_NXAST_FIN_TIMEOUT:
 871         error = parse_fin_timeout(ofpacts, arg);
 872         break;
 873
 874     case OFPUTIL_NXAST_CONTROLLER:
 875         error = parse_controller(ofpacts, arg);
 876         break;
 877
 878     case OFPUTIL_OFPAT11_PUSH_MPLS:
 879     case OFPUTIL_NXAST_PUSH_MPLS:
 880         error = str_to_u16(arg, "push_mpls", &ethertype);
 881         if (!error) {
 882             ofpact_put_PUSH_MPLS(ofpacts)->ethertype = htons(ethertype);
 883         }
 884         break;
 885
 886     case OFPUTIL_OFPAT11_POP_MPLS:
 887     case OFPUTIL_NXAST_POP_MPLS:
 888         error = str_to_u16(arg, "pop_mpls", &ethertype);
 889         if (!error) {
 890             ofpact_put_POP_MPLS(ofpacts)->ethertype = htons(ethertype);
 891         }
 892         break;
 893
 894     case OFPUTIL_OFPAT11_GROUP:
 895         error = str_to_u32(arg, &ofpact_put_GROUP(ofpacts)->group_id);
 896         break;
 897
 898     case OFPUTIL_NXAST_STACK_PUSH:
 899         error = nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts), arg);
 900         break;
 901     case OFPUTIL_NXAST_STACK_POP:
 902         error = nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts), arg);
 903         break;
 904
 905     case OFPUTIL_NXAST_SAMPLE:
 906         error = parse_sample(ofpacts, arg);
 907         break;
 908     }
 909
 910     if (error) {
 911         ofpacts->size = orig_size;
 912     }
 913     return error;
 914 }
 915
 916 /* Parses action 'act', with argument 'arg', and appends a parsed version to
 917  * 'ofpacts'.
 918  *
 919  * 'n_actions' specifies the number of actions already parsed (for proper
 920  * handling of "drop" actions).
 921  *
 922  * Returns NULL if successful, otherwise a malloc()'d string describing the
 923  * error.  The caller is responsible for freeing the returned string. */
 924 static char * WARN_UNUSED_RESULT
 925 str_to_ofpact__(char *pos, char *act, char *arg,
 926                 struct ofpbuf *ofpacts, int n_actions,
 927                 enum ofputil_protocol *usable_protocols)
 928 {
 929     int code = ofputil_action_code_from_name(act);
 930     if (code >= 0) {
 931         return parse_named_action(code, arg, ofpacts, usable_protocols);
 932     } else if (!strcasecmp(act, "drop")) {
 933         if (n_actions) {
 934             return xstrdup("Drop actions must not be preceded by other "
 935                            "actions");
 936         } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
 937             return xstrdup("Drop actions must not be followed by other "
 938                            "actions");
 939         }
 940     } else {
 941         ofp_port_t port;
 942         if (ofputil_port_from_string(act, &port)) {
 943             ofpact_put_OUTPUT(ofpacts)->port = port;
 944         } else {
 945             return xasprintf("Unknown action: %s", act);
 946         }
 947     }
 948
 949     return NULL;
 950 }
 951
 952 /* Parses 'str' as a series of actions, and appends them to 'ofpacts'.
 953  *
 954  * Returns NULL if successful, otherwise a malloc()'d string describing the
 955  * error.  The caller is responsible for freeing the returned string. */
 956 static char * WARN_UNUSED_RESULT
 957 str_to_ofpacts__(char *str, struct ofpbuf *ofpacts,
 958                  enum ofputil_protocol *usable_protocols)
 959 {
 960     size_t orig_size = ofpacts->size;
 961     char *pos, *act, *arg;
 962     int n_actions;
 963
 964     pos = str;
 965     n_actions = 0;
 966     while (ofputil_parse_key_value(&pos, &act, &arg)) {
 967         char *error = str_to_ofpact__(pos, act, arg, ofpacts, n_actions,
 968                                       usable_protocols);
 969         if (error) {
 970             ofpacts->size = orig_size;
 971             return error;
 972         }
 973         n_actions++;
 974     }
 975
 976     ofpact_pad(ofpacts);
 977     return NULL;
 978 }
 979
 980
 981 /* Parses 'str' as a series of actions, and appends them to 'ofpacts'.
 982  *
 983  * Returns NULL if successful, otherwise a malloc()'d string describing the
 984  * error.  The caller is responsible for freeing the returned string. */
 985 static char * WARN_UNUSED_RESULT
 986 str_to_ofpacts(char *str, struct ofpbuf *ofpacts,
 987                enum ofputil_protocol *usable_protocols)
 988 {
 989     size_t orig_size = ofpacts->size;
 990     char *error_s;
 991     enum ofperr error;
 992
 993     error_s = str_to_ofpacts__(str, ofpacts, usable_protocols);
 994     if (error_s) {
 995         return error_s;
 996     }
 997
 998     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 999     if (error) {
1000         ofpacts->size = orig_size;
1001         return xstrdup("Incorrect action ordering");
1002     }
1003
1004     return NULL;
1005 }
1006
1007 /* Parses 'arg' as the argument to instruction 'type', and appends such an
1008  * instruction to 'ofpacts'.
1009  *
1010  * Returns NULL if successful, otherwise a malloc()'d string describing the
1011  * error.  The caller is responsible for freeing the returned string. */
1012 static char * WARN_UNUSED_RESULT
1013 parse_named_instruction(enum ovs_instruction_type type,
1014                         char *arg, struct ofpbuf *ofpacts,
1015                         enum ofputil_protocol *usable_protocols)
1016 {
1017     char *error_s = NULL;
1018     enum ofperr error;
1019
1020     *usable_protocols &= OFPUTIL_P_OF11_UP;
1021
1022     switch (type) {
1023     case OVSINST_OFPIT11_APPLY_ACTIONS:
1024         NOT_REACHED();  /* This case is handled by str_to_inst_ofpacts() */
1025         break;
1026
1027     case OVSINST_OFPIT11_WRITE_ACTIONS: {
1028         struct ofpact_nest *on;
1029         size_t ofs;
1030
1031         ofpact_pad(ofpacts);
1032         ofs = ofpacts->size;
1033         on = ofpact_put(ofpacts, OFPACT_WRITE_ACTIONS,
1034                         offsetof(struct ofpact_nest, actions));
1035         error_s = str_to_ofpacts__(arg, ofpacts, usable_protocols);
1036
1037         on = ofpbuf_at_assert(ofpacts, ofs, sizeof *on);
1038         on->ofpact.len = ofpacts->size - ofs;
1039
1040         if (error_s) {
1041             ofpacts->size = ofs;
1042         }
1043         break;
1044     }
1045
1046     case OVSINST_OFPIT11_CLEAR_ACTIONS:
1047         ofpact_put_CLEAR_ACTIONS(ofpacts);
1048         break;
1049
1050     case OVSINST_OFPIT13_METER:
1051         *usable_protocols &= OFPUTIL_P_OF13_UP;
1052         error_s = str_to_u32(arg, &ofpact_put_METER(ofpacts)->meter_id);
1053         break;
1054
1055     case OVSINST_OFPIT11_WRITE_METADATA:
1056         *usable_protocols &= OFPUTIL_P_NXM_OF11_UP;
1057         error_s = parse_metadata(ofpacts, arg);
1058         break;
1059
1060     case OVSINST_OFPIT11_GOTO_TABLE: {
1061         struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
1062         char *table_s = strsep(&arg, ",");
1063         if (!table_s || !table_s[0]) {
1064             return xstrdup("instruction goto-table needs table id");
1065         }
1066         error_s = str_to_u8(table_s, "table", &ogt->table_id);
1067         break;
1068     }
1069     }
1070
1071     if (error_s) {
1072         return error_s;
1073     }
1074
1075     /* If write_metadata is specified as an action AND an instruction, ofpacts
1076        could be invalid. */
1077     error = ofpacts_verify(ofpacts->data, ofpacts->size);
1078     if (error) {
1079         return xstrdup("Incorrect instruction ordering");
1080     }
1081     return NULL;
1082 }
1083
1084 /* Parses 'str' as a series of instructions, and appends them to 'ofpacts'.
1085  *
1086  * Returns NULL if successful, otherwise a malloc()'d string describing the
1087  * error.  The caller is responsible for freeing the returned string. */
1088 static char * WARN_UNUSED_RESULT
1089 str_to_inst_ofpacts(char *str, struct ofpbuf *ofpacts,
1090                     enum ofputil_protocol *usable_protocols)
1091 {
1092     size_t orig_size = ofpacts->size;
1093     char *pos, *inst, *arg;
1094     int type;
1095     const char *prev_inst = NULL;
1096     int prev_type = -1;
1097     int n_actions = 0;
1098
1099     pos = str;
1100     while (ofputil_parse_key_value(&pos, &inst, &arg)) {
1101         type = ovs_instruction_type_from_name(inst);
1102         if (type < 0) {
1103             char *error = str_to_ofpact__(pos, inst, arg, ofpacts, n_actions,
1104                                           usable_protocols);
1105             if (error) {
1106                 ofpacts->size = orig_size;
1107                 return error;
1108             }
1109
1110             type = OVSINST_OFPIT11_APPLY_ACTIONS;
1111             if (prev_type == type) {
1112                 n_actions++;
1113                 continue;
1114             }
1115         } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
1116             ofpacts->size = orig_size;
1117             return xasprintf("%s isn't supported. Just write actions then "
1118                              "it is interpreted as apply_actions", inst);
1119         } else {
1120             char *error = parse_named_instruction(type, arg, ofpacts,
1121                                                   usable_protocols);
1122             if (error) {
1123                 ofpacts->size = orig_size;
1124                 return error;
1125             }
1126         }
1127
1128         if (type <= prev_type) {
1129             ofpacts->size = orig_size;
1130             if (type == prev_type) {
1131                 return xasprintf("instruction %s may be specified only once",
1132                                  inst);
1133             } else {
1134                 return xasprintf("instruction %s must be specified before %s",
1135                                  inst, prev_inst);
1136             }
1137         }
1138
1139         prev_inst = inst;
1140         prev_type = type;
1141         n_actions++;
1142     }
1143     ofpact_pad(ofpacts);
1144
1145     return NULL;
1146 }
1147
1148 struct protocol {
1149     const char *name;
1150     uint16_t dl_type;
1151     uint8_t nw_proto;
1152 };
1153
1154 static bool
1155 parse_protocol(const char *name, const struct protocol **p_out)
1156 {
1157     static const struct protocol protocols[] = {
1158         { "ip", ETH_TYPE_IP, 0 },
1159         { "arp", ETH_TYPE_ARP, 0 },
1160         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
1161         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
1162         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
1163         { "sctp", ETH_TYPE_IP, IPPROTO_SCTP },
1164         { "ipv6", ETH_TYPE_IPV6, 0 },
1165         { "ip6", ETH_TYPE_IPV6, 0 },
1166         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
1167         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
1168         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
1169         { "sctp6", ETH_TYPE_IPV6, IPPROTO_SCTP },
1170         { "rarp", ETH_TYPE_RARP, 0},
1171         { "mpls", ETH_TYPE_MPLS, 0 },
1172         { "mplsm", ETH_TYPE_MPLS_MCAST, 0 },
1173     };
1174     const struct protocol *p;
1175
1176     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
1177         if (!strcmp(p->name, name)) {
1178             *p_out = p;
1179             return true;
1180         }
1181     }
1182     *p_out = NULL;
1183     return false;
1184 }
1185
1186 /* Parses 's' as the (possibly masked) value of field 'mf', and updates
1187  * 'match' appropriately.  Restricts the set of usable protocols to ones
1188  * supporting the parsed field.
1189  *
1190  * Returns NULL if successful, otherwise a malloc()'d string describing the
1191  * error.  The caller is responsible for freeing the returned string. */
1192 static char * WARN_UNUSED_RESULT
1193 parse_field(const struct mf_field *mf, const char *s, struct match *match,
1194             enum ofputil_protocol *usable_protocols)
1195 {
1196     union mf_value value, mask;
1197     char *error;
1198
1199     error = mf_parse(mf, s, &value, &mask);
1200     if (!error) {
1201         *usable_protocols &= mf_set(mf, &value, &mask, match);
1202     }
1203     return error;
1204 }
1205
1206 static char * WARN_UNUSED_RESULT
1207 parse_ofp_str__(struct ofputil_flow_mod *fm, int command, char *string,
1208                 enum ofputil_protocol *usable_protocols)
1209 {
1210     enum {
1211         F_OUT_PORT = 1 << 0,
1212         F_ACTIONS = 1 << 1,
1213         F_TIMEOUT = 1 << 3,
1214         F_PRIORITY = 1 << 4,
1215         F_FLAGS = 1 << 5,
1216     } fields;
1217     char *save_ptr = NULL;
1218     char *act_str = NULL;
1219     char *name;
1220
1221     *usable_protocols = OFPUTIL_P_ANY;
1222
1223     switch (command) {
1224     case -1:
1225         fields = F_OUT_PORT;
1226         break;
1227
1228     case OFPFC_ADD:
1229         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1230         break;
1231
1232     case OFPFC_DELETE:
1233         fields = F_OUT_PORT;
1234         break;
1235
1236     case OFPFC_DELETE_STRICT:
1237         fields = F_OUT_PORT | F_PRIORITY;
1238         break;
1239
1240     case OFPFC_MODIFY:
1241         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1242         break;
1243
1244     case OFPFC_MODIFY_STRICT:
1245         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1246         break;
1247
1248     default:
1249         NOT_REACHED();
1250     }
1251
1252     match_init_catchall(&fm->match);
1253     fm->priority = OFP_DEFAULT_PRIORITY;
1254     fm->cookie = htonll(0);
1255     fm->cookie_mask = htonll(0);
1256     if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
1257         /* For modify, by default, don't update the cookie. */
1258         fm->new_cookie = OVS_BE64_MAX;
1259     } else{
1260         fm->new_cookie = htonll(0);
1261     }
1262     fm->modify_cookie = false;
1263     fm->table_id = 0xff;
1264     fm->command = command;
1265     fm->idle_timeout = OFP_FLOW_PERMANENT;
1266     fm->hard_timeout = OFP_FLOW_PERMANENT;
1267     fm->buffer_id = UINT32_MAX;
1268     fm->out_port = OFPP_ANY;
1269     fm->flags = 0;
1270     fm->out_group = OFPG11_ANY;
1271     if (fields & F_ACTIONS) {
1272         act_str = strstr(string, "action");
1273         if (!act_str) {
1274             return xstrdup("must specify an action");
1275         }
1276         *act_str = '\0';
1277
1278         act_str = strchr(act_str + 1, '=');
1279         if (!act_str) {
1280             return xstrdup("must specify an action");
1281         }
1282
1283         act_str++;
1284     }
1285     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1286          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1287         const struct protocol *p;
1288         char *error = NULL;
1289
1290         if (parse_protocol(name, &p)) {
1291             match_set_dl_type(&fm->match, htons(p->dl_type));
1292             if (p->nw_proto) {
1293                 match_set_nw_proto(&fm->match, p->nw_proto);
1294             }
1295         } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
1296             fm->flags |= OFPUTIL_FF_SEND_FLOW_REM;
1297         } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
1298             fm->flags |= OFPUTIL_FF_CHECK_OVERLAP;
1299         } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
1300             fm->flags |= OFPUTIL_FF_RESET_COUNTS;
1301             *usable_protocols &= OFPUTIL_P_OF12_UP;
1302         } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
1303             fm->flags |= OFPUTIL_FF_NO_PKT_COUNTS;
1304             *usable_protocols &= OFPUTIL_P_OF13_UP;
1305         } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
1306             fm->flags |= OFPUTIL_FF_NO_BYT_COUNTS;
1307             *usable_protocols &= OFPUTIL_P_OF13_UP;
1308         } else {
1309             char *value;
1310
1311             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1312             if (!value) {
1313                 return xasprintf("field %s missing value", name);
1314             }
1315
1316             if (!strcmp(name, "table")) {
1317                 error = str_to_u8(value, "table", &fm->table_id);
1318                 if (fm->table_id != 0xff) {
1319                     *usable_protocols &= OFPUTIL_P_TID;
1320                 }
1321             } else if (!strcmp(name, "out_port")) {
1322                 if (!ofputil_port_from_string(value, &fm->out_port)) {
1323                     error = xasprintf("%s is not a valid OpenFlow port",
1324                                       value);
1325                 }
1326             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
1327                 uint16_t priority = 0;
1328
1329                 error = str_to_u16(value, name, &priority);
1330                 fm->priority = priority;
1331             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
1332                 error = str_to_u16(value, name, &fm->idle_timeout);
1333             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
1334                 error = str_to_u16(value, name, &fm->hard_timeout);
1335             } else if (!strcmp(name, "cookie")) {
1336                 char *mask = strchr(value, '/');
1337
1338                 if (mask) {
1339                     /* A mask means we're searching for a cookie. */
1340                     if (command == OFPFC_ADD) {
1341                         return xstrdup("flow additions cannot use "
1342                                        "a cookie mask");
1343                     }
1344                     *mask = '\0';
1345                     error = str_to_be64(value, &fm->cookie);
1346                     if (error) {
1347                         return error;
1348                     }
1349                     error = str_to_be64(mask + 1, &fm->cookie_mask);
1350
1351                     /* Matching of the cookie is only supported through NXM or
1352                      * OF1.1+. */
1353                     if (fm->cookie_mask != htonll(0)) {
1354                         *usable_protocols &= OFPUTIL_P_NXM_OF11_UP;
1355                     }
1356                 } else {
1357                     /* No mask means that the cookie is being set. */
1358                     if (command != OFPFC_ADD && command != OFPFC_MODIFY
1359                         && command != OFPFC_MODIFY_STRICT) {
1360                         return xstrdup("cannot set cookie");
1361                     }
1362                     error = str_to_be64(value, &fm->new_cookie);
1363                     fm->modify_cookie = true;
1364                 }
1365             } else if (mf_from_name(name)) {
1366                 error = parse_field(mf_from_name(name), value, &fm->match,
1367                                     usable_protocols);
1368             } else if (!strcmp(name, "duration")
1369                        || !strcmp(name, "n_packets")
1370                        || !strcmp(name, "n_bytes")
1371                        || !strcmp(name, "idle_age")
1372                        || !strcmp(name, "hard_age")) {
1373                 /* Ignore these, so that users can feed the output of
1374                  * "ovs-ofctl dump-flows" back into commands that parse
1375                  * flows. */
1376             } else {
1377                 error = xasprintf("unknown keyword %s", name);
1378             }
1379
1380             if (error) {
1381                 return error;
1382             }
1383         }
1384     }
1385     /* Check for usable protocol interdependencies between match fields. */
1386     if (fm->match.flow.dl_type == htons(ETH_TYPE_IPV6)) {
1387         const struct flow_wildcards *wc = &fm->match.wc;
1388         /* Only NXM and OXM support matching L3 and L4 fields within IPv6.
1389          *
1390          * (IPv6 specific fields as well as arp_sha, arp_tha, nw_frag, and
1391          *  nw_ttl are covered elsewhere so they don't need to be included in
1392          *  this test too.)
1393          */
1394         if (wc->masks.nw_proto || wc->masks.nw_tos
1395             || wc->masks.tp_src || wc->masks.tp_dst) {
1396             *usable_protocols &= OFPUTIL_P_NXM_OXM_ANY;
1397         }
1398     }
1399     if (!fm->cookie_mask && fm->new_cookie == OVS_BE64_MAX
1400         && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
1401         /* On modifies without a mask, we are supposed to add a flow if
1402          * one does not exist.  If a cookie wasn't been specified, use a
1403          * default of zero. */
1404         fm->new_cookie = htonll(0);
1405     }
1406     if (fields & F_ACTIONS) {
1407         struct ofpbuf ofpacts;
1408         char *error;
1409
1410         ofpbuf_init(&ofpacts, 32);
1411         error = str_to_inst_ofpacts(act_str, &ofpacts, usable_protocols);
1412         if (!error) {
1413             enum ofperr err;
1414
1415             err = ofpacts_check(ofpacts.data, ofpacts.size, &fm->match.flow,
1416                                 OFPP_MAX, fm->table_id, 255, usable_protocols);
1417             if (!err && !usable_protocols) {
1418                 err = OFPERR_OFPBAC_MATCH_INCONSISTENT;
1419             }
1420             if (err) {
1421                 error = xasprintf("actions are invalid with specified match "
1422                                   "(%s)", ofperr_to_string(err));
1423             }
1424
1425         }
1426         if (error) {
1427             ofpbuf_uninit(&ofpacts);
1428             return error;
1429         }
1430
1431         fm->ofpacts_len = ofpacts.size;
1432         fm->ofpacts = ofpbuf_steal_data(&ofpacts);
1433     } else {
1434         fm->ofpacts_len = 0;
1435         fm->ofpacts = NULL;
1436     }
1437
1438     return NULL;
1439 }
1440
1441 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1442  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
1443  * Returns the set of usable protocols in '*usable_protocols'.
1444  *
1445  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
1446  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
1447  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'.
1448  *
1449  * Returns NULL if successful, otherwise a malloc()'d string describing the
1450  * error.  The caller is responsible for freeing the returned string. */
1451 char * WARN_UNUSED_RESULT
1452 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
1453               enum ofputil_protocol *usable_protocols)
1454 {
1455     char *string = xstrdup(str_);
1456     char *error;
1457
1458     error = parse_ofp_str__(fm, command, string, usable_protocols);
1459     if (error) {
1460         fm->ofpacts = NULL;
1461         fm->ofpacts_len = 0;
1462     }
1463
1464     free(string);
1465     return error;
1466 }
1467
1468 static char * WARN_UNUSED_RESULT
1469 parse_ofp_meter_mod_str__(struct ofputil_meter_mod *mm, char *string,
1470                           struct ofpbuf *bands, int command,
1471                           enum ofputil_protocol *usable_protocols)
1472 {
1473     enum {
1474         F_METER = 1 << 0,
1475         F_FLAGS = 1 << 1,
1476         F_BANDS = 1 << 2,
1477     } fields;
1478     char *save_ptr = NULL;
1479     char *band_str = NULL;
1480     char *name;
1481
1482     /* Meters require at least OF 1.3. */
1483     *usable_protocols = OFPUTIL_P_OF13_UP;
1484
1485     switch (command) {
1486     case -1:
1487         fields = F_METER;
1488         break;
1489
1490     case OFPMC13_ADD:
1491         fields = F_METER | F_FLAGS | F_BANDS;
1492         break;
1493
1494     case OFPMC13_DELETE:
1495         fields = F_METER;
1496         break;
1497
1498     case OFPMC13_MODIFY:
1499         fields = F_METER | F_FLAGS | F_BANDS;
1500         break;
1501
1502     default:
1503         NOT_REACHED();
1504     }
1505
1506     mm->command = command;
1507     mm->meter.meter_id = 0;
1508     mm->meter.flags = 0;
1509     if (fields & F_BANDS) {
1510         band_str = strstr(string, "band");
1511         if (!band_str) {
1512             return xstrdup("must specify bands");
1513         }
1514         *band_str = '\0';
1515
1516         band_str = strchr(band_str + 1, '=');
1517         if (!band_str) {
1518             return xstrdup("must specify bands");
1519         }
1520
1521         band_str++;
1522     }
1523     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1524          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1525
1526         if (fields & F_FLAGS && !strcmp(name, "kbps")) {
1527             mm->meter.flags |= OFPMF13_KBPS;
1528         } else if (fields & F_FLAGS && !strcmp(name, "pktps")) {
1529             mm->meter.flags |= OFPMF13_PKTPS;
1530         } else if (fields & F_FLAGS && !strcmp(name, "burst")) {
1531             mm->meter.flags |= OFPMF13_BURST;
1532         } else if (fields & F_FLAGS && !strcmp(name, "stats")) {
1533             mm->meter.flags |= OFPMF13_STATS;
1534         } else {
1535             char *value;
1536
1537             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1538             if (!value) {
1539                 return xasprintf("field %s missing value", name);
1540             }
1541
1542             if (!strcmp(name, "meter")) {
1543                 if (!strcmp(value, "all")) {
1544                     mm->meter.meter_id = OFPM13_ALL;
1545                 } else if (!strcmp(value, "controller")) {
1546                     mm->meter.meter_id = OFPM13_CONTROLLER;
1547                 } else if (!strcmp(value, "slowpath")) {
1548                     mm->meter.meter_id = OFPM13_SLOWPATH;
1549                 } else {
1550                     char *error = str_to_u32(value, &mm->meter.meter_id);
1551                     if (error) {
1552                         return error;
1553                     }
1554                     if (mm->meter.meter_id > OFPM13_MAX) {
1555                         return xasprintf("invalid value for %s", name);
1556                     }
1557                 }
1558             } else {
1559                 return xasprintf("unknown keyword %s", name);
1560             }
1561         }
1562     }
1563     if (fields & F_METER && !mm->meter.meter_id) {
1564         return xstrdup("must specify 'meter'");
1565     }
1566     if (fields & F_FLAGS && !mm->meter.flags) {
1567         return xstrdup("meter must specify either 'kbps' or 'pktps'");
1568     }
1569
1570     if (fields & F_BANDS) {
1571         uint16_t n_bands = 0;
1572         struct ofputil_meter_band *band = NULL;
1573         int i;
1574
1575         for (name = strtok_r(band_str, "=, \t\r\n", &save_ptr); name;
1576              name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1577
1578             char *value;
1579
1580             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1581             if (!value) {
1582                 return xasprintf("field %s missing value", name);
1583             }
1584
1585             if (!strcmp(name, "type")) {
1586                 /* Start a new band */
1587                 band = ofpbuf_put_zeros(bands, sizeof *band);
1588                 n_bands++;
1589
1590                 if (!strcmp(value, "drop")) {
1591                     band->type = OFPMBT13_DROP;
1592                 } else if (!strcmp(value, "dscp_remark")) {
1593                     band->type = OFPMBT13_DSCP_REMARK;
1594                 } else {
1595                     return xasprintf("field %s unknown value %s", name, value);
1596                 }
1597             } else if (!band || !band->type) {
1598                 return xstrdup("band must start with the 'type' keyword");
1599             } else if (!strcmp(name, "rate")) {
1600                 char *error = str_to_u32(value, &band->rate);
1601                 if (error) {
1602                     return error;
1603                 }
1604             } else if (!strcmp(name, "burst_size")) {
1605                 char *error = str_to_u32(value, &band->burst_size);
1606                 if (error) {
1607                     return error;
1608                 }
1609             } else if (!strcmp(name, "prec_level")) {
1610                 char *error = str_to_u8(value, name, &band->prec_level);
1611                 if (error) {
1612                     return error;
1613                 }
1614             } else {
1615                 return xasprintf("unknown keyword %s", name);
1616             }
1617         }
1618         /* validate bands */
1619         if (!n_bands) {
1620             return xstrdup("meter must have bands");
1621         }
1622
1623         mm->meter.n_bands = n_bands;
1624         mm->meter.bands = ofpbuf_steal_data(bands);
1625
1626         for (i = 0; i < n_bands; ++i) {
1627             band = &mm->meter.bands[i];
1628
1629             if (!band->type) {
1630                 return xstrdup("band must have 'type'");
1631             }
1632             if (band->type == OFPMBT13_DSCP_REMARK) {
1633                 if (!band->prec_level) {
1634                     return xstrdup("'dscp_remark' band must have"
1635                                    " 'prec_level'");
1636                 }
1637             } else {
1638                 if (band->prec_level) {
1639                     return xstrdup("Only 'dscp_remark' band may have"
1640                                    " 'prec_level'");
1641                 }
1642             }
1643             if (!band->rate) {
1644                 return xstrdup("band must have 'rate'");
1645             }
1646             if (mm->meter.flags & OFPMF13_BURST) {
1647                 if (!band->burst_size) {
1648                     return xstrdup("band must have 'burst_size' "
1649                                    "when 'burst' flag is set");
1650                 }
1651             } else {
1652                 if (band->burst_size) {
1653                     return xstrdup("band may have 'burst_size' only "
1654                                    "when 'burst' flag is set");
1655                 }
1656             }
1657         }
1658     } else {
1659         mm->meter.n_bands = 0;
1660         mm->meter.bands = NULL;
1661     }
1662
1663     return NULL;
1664 }
1665
1666 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1667  * page) into 'mm' for sending the specified meter_mod 'command' to a switch.
1668  *
1669  * Returns NULL if successful, otherwise a malloc()'d string describing the
1670  * error.  The caller is responsible for freeing the returned string. */
1671 char * WARN_UNUSED_RESULT
1672 parse_ofp_meter_mod_str(struct ofputil_meter_mod *mm, const char *str_,
1673                         int command, enum ofputil_protocol *usable_protocols)
1674 {
1675     struct ofpbuf bands;
1676     char *string;
1677     char *error;
1678
1679     ofpbuf_init(&bands, 64);
1680     string = xstrdup(str_);
1681
1682     error = parse_ofp_meter_mod_str__(mm, string, &bands, command,
1683                                       usable_protocols);
1684
1685     free(string);
1686     ofpbuf_uninit(&bands);
1687
1688     return error;
1689 }
1690
1691 static char * WARN_UNUSED_RESULT
1692 parse_flow_monitor_request__(struct ofputil_flow_monitor_request *fmr,
1693                              const char *str_, char *string,
1694                              enum ofputil_protocol *usable_protocols)
1695 {
1696     static atomic_uint32_t id = ATOMIC_VAR_INIT(0);
1697     char *save_ptr = NULL;
1698     char *name;
1699
1700     atomic_add(&id, 1, &fmr->id);
1701
1702     fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
1703                   | NXFMF_OWN | NXFMF_ACTIONS);
1704     fmr->out_port = OFPP_NONE;
1705     fmr->table_id = 0xff;
1706     match_init_catchall(&fmr->match);
1707
1708     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1709          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1710         const struct protocol *p;
1711
1712         if (!strcmp(name, "!initial")) {
1713             fmr->flags &= ~NXFMF_INITIAL;
1714         } else if (!strcmp(name, "!add")) {
1715             fmr->flags &= ~NXFMF_ADD;
1716         } else if (!strcmp(name, "!delete")) {
1717             fmr->flags &= ~NXFMF_DELETE;
1718         } else if (!strcmp(name, "!modify")) {
1719             fmr->flags &= ~NXFMF_MODIFY;
1720         } else if (!strcmp(name, "!actions")) {
1721             fmr->flags &= ~NXFMF_ACTIONS;
1722         } else if (!strcmp(name, "!own")) {
1723             fmr->flags &= ~NXFMF_OWN;
1724         } else if (parse_protocol(name, &p)) {
1725             match_set_dl_type(&fmr->match, htons(p->dl_type));
1726             if (p->nw_proto) {
1727                 match_set_nw_proto(&fmr->match, p->nw_proto);
1728             }
1729         } else {
1730             char *value;
1731
1732             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1733             if (!value) {
1734                 return xasprintf("%s: field %s missing value", str_, name);
1735             }
1736
1737             if (!strcmp(name, "table")) {
1738                 char *error = str_to_u8(value, "table", &fmr->table_id);
1739                 if (error) {
1740                     return error;
1741                 }
1742             } else if (!strcmp(name, "out_port")) {
1743                 fmr->out_port = u16_to_ofp(atoi(value));
1744             } else if (mf_from_name(name)) {
1745                 char *error;
1746
1747                 error = parse_field(mf_from_name(name), value, &fmr->match,
1748                                     usable_protocols);
1749                 if (error) {
1750                     return error;
1751                 }
1752             } else {
1753                 return xasprintf("%s: unknown keyword %s", str_, name);
1754             }
1755         }
1756     }
1757     return NULL;
1758 }
1759
1760 /* Convert 'str_' (as described in the documentation for the "monitor" command
1761  * in the ovs-ofctl man page) into 'fmr'.
1762  *
1763  * Returns NULL if successful, otherwise a malloc()'d string describing the
1764  * error.  The caller is responsible for freeing the returned string. */
1765 char * WARN_UNUSED_RESULT
1766 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
1767                            const char *str_,
1768                            enum ofputil_protocol *usable_protocols)
1769 {
1770     char *string = xstrdup(str_);
1771     char *error = parse_flow_monitor_request__(fmr, str_, string,
1772                                                usable_protocols);
1773     free(string);
1774     return error;
1775 }
1776
1777 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1778  * 'actions'.
1779  *
1780  * Returns NULL if successful, otherwise a malloc()'d string describing the
1781  * error.  The caller is responsible for freeing the returned string. */
1782 char * WARN_UNUSED_RESULT
1783 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts,
1784               enum ofputil_protocol *usable_protocols)
1785 {
1786     char *s = xstrdup(s_);
1787     char *error;
1788
1789     *usable_protocols = OFPUTIL_P_ANY;
1790
1791     error = str_to_ofpacts(s, ofpacts, usable_protocols);
1792     free(s);
1793
1794     return error;
1795 }
1796
1797 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1798  * (one of OFPFC_*) into 'fm'.
1799  *
1800  * Returns NULL if successful, otherwise a malloc()'d string describing the
1801  * error.  The caller is responsible for freeing the returned string. */
1802 char * WARN_UNUSED_RESULT
1803 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1804                        uint16_t command,
1805                        enum ofputil_protocol *usable_protocols)
1806 {
1807     char *error = parse_ofp_str(fm, command, string, usable_protocols);
1808     if (!error) {
1809         /* Normalize a copy of the match.  This ensures that non-normalized
1810          * flows get logged but doesn't affect what gets sent to the switch, so
1811          * that the switch can do whatever it likes with the flow. */
1812         struct match match_copy = fm->match;
1813         ofputil_normalize_match(&match_copy);
1814     }
1815
1816     return error;
1817 }
1818
1819 /* Convert 'table_id' and 'flow_miss_handling' (as described for the
1820  * "mod-table" command in the ovs-ofctl man page) into 'tm' for sending the
1821  * specified table_mod 'command' to a switch.
1822  *
1823  * Returns NULL if successful, otherwise a malloc()'d string describing the
1824  * error.  The caller is responsible for freeing the returned string. */
1825 char * WARN_UNUSED_RESULT
1826 parse_ofp_table_mod(struct ofputil_table_mod *tm, const char *table_id,
1827                     const char *flow_miss_handling,
1828                     enum ofputil_protocol *usable_protocols)
1829 {
1830     /* Table mod requires at least OF 1.1. */
1831     *usable_protocols = OFPUTIL_P_OF11_UP;
1832
1833     if (!strcasecmp(table_id, "all")) {
1834         tm->table_id = OFPTT_ALL;
1835     } else {
1836         char *error = str_to_u8(table_id, "table_id", &tm->table_id);
1837         if (error) {
1838             return error;
1839         }
1840     }
1841
1842     if (strcmp(flow_miss_handling, "controller") == 0) {
1843         tm->config = OFPTC11_TABLE_MISS_CONTROLLER;
1844     } else if (strcmp(flow_miss_handling, "continue") == 0) {
1845         tm->config = OFPTC11_TABLE_MISS_CONTINUE;
1846     } else if (strcmp(flow_miss_handling, "drop") == 0) {
1847         tm->config = OFPTC11_TABLE_MISS_DROP;
1848     } else {
1849         return xasprintf("invalid flow_miss_handling %s", flow_miss_handling);
1850     }
1851
1852     if (tm->table_id == 0xfe && tm->config == OFPTC11_TABLE_MISS_CONTINUE) {
1853         return xstrdup("last table's flow miss handling can not be continue");
1854     }
1855
1856     return NULL;
1857 }
1858
1859
1860 /* Opens file 'file_name' and reads each line as a flow_mod of the specified
1861  * type (one of OFPFC_*).  Stores each flow_mod in '*fm', an array allocated
1862  * on the caller's behalf, and the number of flow_mods in '*n_fms'.
1863  *
1864  * Returns NULL if successful, otherwise a malloc()'d string describing the
1865  * error.  The caller is responsible for freeing the returned string. */
1866 char * WARN_UNUSED_RESULT
1867 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1868                         struct ofputil_flow_mod **fms, size_t *n_fms,
1869                         enum ofputil_protocol *usable_protocols)
1870 {
1871     size_t allocated_fms;
1872     int line_number;
1873     FILE *stream;
1874     struct ds s;
1875
1876     *usable_protocols = OFPUTIL_P_ANY;
1877
1878     *fms = NULL;
1879     *n_fms = 0;
1880
1881     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1882     if (stream == NULL) {
1883         return xasprintf("%s: open failed (%s)",
1884                          file_name, ovs_strerror(errno));
1885     }
1886
1887     allocated_fms = *n_fms;
1888     ds_init(&s);
1889     line_number = 0;
1890     while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
1891         char *error;
1892         enum ofputil_protocol usable;
1893
1894         if (*n_fms >= allocated_fms) {
1895             *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1896         }
1897         error = parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command,
1898                                        &usable);
1899         if (error) {
1900             size_t i;
1901
1902             for (i = 0; i < *n_fms; i++) {
1903                 free((*fms)[i].ofpacts);
1904             }
1905             free(*fms);
1906             *fms = NULL;
1907             *n_fms = 0;
1908
1909             ds_destroy(&s);
1910             if (stream != stdin) {
1911                 fclose(stream);
1912             }
1913
1914             return xasprintf("%s:%d: %s", file_name, line_number, error);
1915         }
1916         *usable_protocols &= usable; /* Each line can narrow the set. */
1917         *n_fms += 1;
1918     }
1919
1920     ds_destroy(&s);
1921     if (stream != stdin) {
1922         fclose(stream);
1923     }
1924     return NULL;
1925 }
1926
1927 char * WARN_UNUSED_RESULT
1928 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1929                                  bool aggregate, const char *string,
1930                                  enum ofputil_protocol *usable_protocols)
1931 {
1932     struct ofputil_flow_mod fm;
1933     char *error;
1934
1935     error = parse_ofp_str(&fm, -1, string, usable_protocols);
1936     if (error) {
1937         return error;
1938     }
1939
1940     /* Special table ID support not required for stats requests. */
1941     if (*usable_protocols & OFPUTIL_P_OF10_STD_TID) {
1942         *usable_protocols |= OFPUTIL_P_OF10_STD;
1943     }
1944     if (*usable_protocols & OFPUTIL_P_OF10_NXM_TID) {
1945         *usable_protocols |= OFPUTIL_P_OF10_NXM;
1946     }
1947
1948     fsr->aggregate = aggregate;
1949     fsr->cookie = fm.cookie;
1950     fsr->cookie_mask = fm.cookie_mask;
1951     fsr->match = fm.match;
1952     fsr->out_port = fm.out_port;
1953     fsr->out_group = fm.out_group;
1954     fsr->table_id = fm.table_id;
1955     return NULL;
1956 }
1957
1958 /* Parses a specification of a flow from 's' into 'flow'.  's' must take the
1959  * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1960  * mf_field.  Fields must be specified in a natural order for satisfying
1961  * prerequisites. If 'mask' is specified, fills the mask field for each of the
1962  * field specified in flow. If the map, 'names_portno' is specfied, converts
1963  * the in_port name into port no while setting the 'flow'.
1964  *
1965  * Returns NULL on success, otherwise a malloc()'d string that explains the
1966  * problem. */
1967 char *
1968 parse_ofp_exact_flow(struct flow *flow, struct flow *mask, const char *s,
1969                      const struct simap *portno_names)
1970 {
1971     char *pos, *key, *value_s;
1972     char *error = NULL;
1973     char *copy;
1974
1975     memset(flow, 0, sizeof *flow);
1976     if (mask) {
1977         memset(mask, 0, sizeof *mask);
1978     }
1979
1980     pos = copy = xstrdup(s);
1981     while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1982         const struct protocol *p;
1983         if (parse_protocol(key, &p)) {
1984             if (flow->dl_type) {
1985                 error = xasprintf("%s: Ethernet type set multiple times", s);
1986                 goto exit;
1987             }
1988             flow->dl_type = htons(p->dl_type);
1989             if (mask) {
1990                 mask->dl_type = OVS_BE16_MAX;
1991             }
1992
1993             if (p->nw_proto) {
1994                 if (flow->nw_proto) {
1995                     error = xasprintf("%s: network protocol set "
1996                                       "multiple times", s);
1997                     goto exit;
1998                 }
1999                 flow->nw_proto = p->nw_proto;
2000                 if (mask) {
2001                     mask->nw_proto = UINT8_MAX;
2002                 }
2003             }
2004         } else {
2005             const struct mf_field *mf;
2006             union mf_value value;
2007             char *field_error;
2008
2009             mf = mf_from_name(key);
2010             if (!mf) {
2011                 error = xasprintf("%s: unknown field %s", s, key);
2012                 goto exit;
2013             }
2014
2015             if (!mf_are_prereqs_ok(mf, flow)) {
2016                 error = xasprintf("%s: prerequisites not met for setting %s",
2017                                   s, key);
2018                 goto exit;
2019             }
2020
2021             if (!mf_is_zero(mf, flow)) {
2022                 error = xasprintf("%s: field %s set multiple times", s, key);
2023                 goto exit;
2024             }
2025
2026             if (!strcmp(key, "in_port")
2027                 && portno_names
2028                 && simap_contains(portno_names, value_s)) {
2029                 flow->in_port.ofp_port = u16_to_ofp(
2030                     simap_get(portno_names, value_s));
2031                 if (mask) {
2032                     mask->in_port.ofp_port = u16_to_ofp(ntohs(OVS_BE16_MAX));
2033                 }
2034             } else {
2035                 field_error = mf_parse_value(mf, value_s, &value);
2036                 if (field_error) {
2037                     error = xasprintf("%s: bad value for %s (%s)",
2038                                       s, key, field_error);
2039                     free(field_error);
2040                     goto exit;
2041                 }
2042
2043                 mf_set_flow_value(mf, &value, flow);
2044                 if (mask) {
2045                     mf_mask_field(mf, mask);
2046                 }
2047             }
2048         }
2049     }
2050
2051     if (!flow->in_port.ofp_port) {
2052         flow->in_port.ofp_port = OFPP_NONE;
2053     }
2054
2055 exit:
2056     free(copy);
2057
2058     if (error) {
2059         memset(flow, 0, sizeof *flow);
2060         if (mask) {
2061             memset(mask, 0, sizeof *mask);
2062         }
2063     }
2064     return error;
2065 }
2066
2067 static char * WARN_UNUSED_RESULT
2068 parse_bucket_str(struct ofputil_bucket *bucket, char *str_,
2069                   enum ofputil_protocol *usable_protocols)
2070 {
2071     struct ofpbuf ofpacts;
2072     char *pos, *act, *arg;
2073     int n_actions;
2074
2075     bucket->weight = 1;
2076     bucket->watch_port = OFPP_ANY;
2077     bucket->watch_group = OFPG11_ANY;
2078
2079     pos = str_;
2080     n_actions = 0;
2081     ofpbuf_init(&ofpacts, 64);
2082     while (ofputil_parse_key_value(&pos, &act, &arg)) {
2083         char *error = NULL;
2084
2085         if (!strcasecmp(act, "weight")) {
2086             error = str_to_u16(arg, "weight", &bucket->weight);
2087         } else if (!strcasecmp(act, "watch_port")) {
2088             if (!ofputil_port_from_string(arg, &bucket->watch_port)
2089                 || (ofp_to_u16(bucket->watch_port) >= ofp_to_u16(OFPP_MAX)
2090                     && bucket->watch_port != OFPP_ANY)) {
2091                 error = xasprintf("%s: invalid watch_port", arg);
2092             }
2093         } else if (!strcasecmp(act, "watch_group")) {
2094             error = str_to_u32(arg, &bucket->watch_group);
2095             if (!error && bucket->watch_group > OFPG_MAX) {
2096                 error = xasprintf("invalid watch_group id %"PRIu32,
2097                                   bucket->watch_group);
2098             }
2099         } else {
2100             error = str_to_ofpact__(pos, act, arg, &ofpacts, n_actions,
2101                                     usable_protocols);
2102             n_actions++;
2103         }
2104
2105         if (error) {
2106             ofpbuf_uninit(&ofpacts);
2107             return error;
2108         }
2109     }
2110
2111     ofpact_pad(&ofpacts);
2112     bucket->ofpacts = ofpacts.data;
2113     bucket->ofpacts_len = ofpacts.size;
2114
2115     return NULL;
2116 }
2117
2118 static char * WARN_UNUSED_RESULT
2119 parse_ofp_group_mod_str__(struct ofputil_group_mod *gm, uint16_t command,
2120                           char *string,
2121                           enum ofputil_protocol *usable_protocols)
2122 {
2123     enum {
2124         F_GROUP_TYPE  = 1 << 0,
2125         F_BUCKETS     = 1 << 1,
2126     } fields;
2127     char *save_ptr = NULL;
2128     bool had_type = false;
2129     char *name;
2130     struct ofputil_bucket *bucket;
2131     char *error = NULL;
2132
2133     *usable_protocols = OFPUTIL_P_OF11_UP;
2134
2135     switch (command) {
2136     case OFPGC11_ADD:
2137         fields = F_GROUP_TYPE | F_BUCKETS;
2138         break;
2139
2140     case OFPGC11_DELETE:
2141         fields = 0;
2142         break;
2143
2144     case OFPGC11_MODIFY:
2145         fields = F_GROUP_TYPE | F_BUCKETS;
2146         break;
2147
2148     default:
2149         NOT_REACHED();
2150     }
2151
2152     memset(gm, 0, sizeof *gm);
2153     gm->command = command;
2154     gm->group_id = OFPG_ANY;
2155     list_init(&gm->buckets);
2156     if (command == OFPGC11_DELETE && string[0] == '\0') {
2157         gm->group_id = OFPG_ALL;
2158         return NULL;
2159     }
2160
2161     *usable_protocols = OFPUTIL_P_OF11_UP;
2162
2163     if (fields & F_BUCKETS) {
2164         char *bkt_str = strstr(string, "bucket");
2165
2166         if (bkt_str) {
2167             *bkt_str = '\0';
2168         }
2169
2170         while (bkt_str) {
2171             char *next_bkt_str;
2172
2173             bkt_str = strchr(bkt_str + 1, '=');
2174             if (!bkt_str) {
2175                 error = xstrdup("must specify bucket content");
2176                 goto out;
2177             }
2178             bkt_str++;
2179
2180             next_bkt_str = strstr(bkt_str, "bucket");
2181             if (next_bkt_str) {
2182                 *next_bkt_str = '\0';
2183             }
2184
2185             bucket = xzalloc(sizeof(struct ofputil_bucket));
2186             error = parse_bucket_str(bucket, bkt_str, usable_protocols);
2187             if (error) {
2188                 free(bucket);
2189                 goto out;
2190             }
2191             list_push_back(&gm->buckets, &bucket->list_node);
2192
2193             bkt_str = next_bkt_str;
2194         }
2195     }
2196
2197     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
2198          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
2199         char *value;
2200
2201         value = strtok_r(NULL, ", \t\r\n", &save_ptr);
2202         if (!value) {
2203             error = xasprintf("field %s missing value", name);
2204             goto out;
2205         }
2206
2207         if (!strcmp(name, "group_id")) {
2208             if(!strcmp(value, "all")) {
2209                 gm->group_id = OFPG_ALL;
2210             } else {
2211                 char *error = str_to_u32(value, &gm->group_id);
2212                 if (error) {
2213                     goto out;
2214                 }
2215                 if (gm->group_id != OFPG_ALL && gm->group_id > OFPG_MAX) {
2216                     error = xasprintf("invalid group id %"PRIu32,
2217                                       gm->group_id);
2218                     goto out;
2219                 }
2220             }
2221         } else if (!strcmp(name, "type")){
2222             if (!(fields & F_GROUP_TYPE)) {
2223                 error = xstrdup("type is not needed");
2224                 goto out;
2225             }
2226             if (!strcmp(value, "all")) {
2227                 gm->type = OFPGT11_ALL;
2228             } else if (!strcmp(value, "select")) {
2229                 gm->type = OFPGT11_SELECT;
2230             } else if (!strcmp(value, "indirect")) {
2231                 gm->type = OFPGT11_INDIRECT;
2232             } else if (!strcmp(value, "ff") ||
2233                        !strcmp(value, "fast_failover")) {
2234                 gm->type = OFPGT11_FF;
2235             } else {
2236                 error = xasprintf("invalid group type %s", value);
2237                 goto out;
2238             }
2239             had_type = true;
2240         } else if (!strcmp(name, "bucket")) {
2241             error = xstrdup("bucket is not needed");
2242             goto out;
2243         } else {
2244             error = xasprintf("unknown keyword %s", name);
2245             goto out;
2246         }
2247     }
2248     if (gm->group_id == OFPG_ANY) {
2249         error = xstrdup("must specify a group_id");
2250         goto out;
2251     }
2252     if (fields & F_GROUP_TYPE && !had_type) {
2253         error = xstrdup("must specify a type");
2254         goto out;
2255     }
2256
2257     /* Validate buckets. */
2258     LIST_FOR_EACH (bucket, list_node, &gm->buckets) {
2259         if (bucket->weight != 1 && gm->type != OFPGT11_SELECT) {
2260             error = xstrdup("Only select groups can have bucket weights.");
2261             goto out;
2262         }
2263     }
2264     if (gm->type == OFPGT11_INDIRECT && !list_is_short(&gm->buckets)) {
2265         error = xstrdup("Indirect groups can have at most one bucket.");
2266         goto out;
2267     }
2268
2269     return NULL;
2270  out:
2271     ofputil_bucket_list_destroy(&gm->buckets);
2272     return error;
2273 }
2274
2275 char * WARN_UNUSED_RESULT
2276 parse_ofp_group_mod_str(struct ofputil_group_mod *gm, uint16_t command,
2277                         const char *str_,
2278                         enum ofputil_protocol *usable_protocols)
2279 {
2280     char *string = xstrdup(str_);
2281     char *error = parse_ofp_group_mod_str__(gm, command, string,
2282                                             usable_protocols);
2283     free(string);
2284
2285     if (error) {
2286         ofputil_bucket_list_destroy(&gm->buckets);
2287     }
2288     return error;
2289 }
2290
2291 char * WARN_UNUSED_RESULT
2292 parse_ofp_group_mod_file(const char *file_name, uint16_t command,
2293                          struct ofputil_group_mod **gms, size_t *n_gms,
2294                          enum ofputil_protocol *usable_protocols)
2295 {
2296     size_t allocated_gms;
2297     int line_number;
2298     FILE *stream;
2299     struct ds s;
2300
2301     *gms = NULL;
2302     *n_gms = 0;
2303
2304     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
2305     if (stream == NULL) {
2306         return xasprintf("%s: open failed (%s)",
2307                          file_name, ovs_strerror(errno));
2308     }
2309
2310     allocated_gms = *n_gms;
2311     ds_init(&s);
2312     line_number = 0;
2313     *usable_protocols = OFPUTIL_P_OF11_UP;
2314     while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
2315         enum ofputil_protocol usable;
2316         char *error;
2317
2318         if (*n_gms >= allocated_gms) {
2319             size_t i;
2320
2321             *gms = x2nrealloc(*gms, &allocated_gms, sizeof **gms);
2322             for (i = 0; i < *n_gms; i++) {
2323                 list_moved(&(*gms)[i].buckets);
2324             }
2325         }
2326         error = parse_ofp_group_mod_str(&(*gms)[*n_gms], command, ds_cstr(&s),
2327                                         &usable);
2328         if (error) {
2329             size_t i;
2330
2331             for (i = 0; i < *n_gms; i++) {
2332                 ofputil_bucket_list_destroy(&(*gms)[i].buckets);
2333             }
2334             free(*gms);
2335             *gms = NULL;
2336             *n_gms = 0;
2337
2338             ds_destroy(&s);
2339             if (stream != stdin) {
2340                 fclose(stream);
2341             }
2342
2343             return xasprintf("%s:%d: %s", file_name, line_number, error);
2344         }
2345         *usable_protocols &= usable;
2346         *n_gms += 1;
2347     }
2348
2349     ds_destroy(&s);
2350     if (stream != stdin) {
2351         fclose(stream);
2352     }
2353     return NULL;
2354 }