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