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 "socket-util.h"
  40 #include "vconn.h"
  41 #include "vlog.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(ofp_parse);
  44
  45 /* Parses 'str' as an 8-bit unsigned integer into '*valuep'.
  46  *
  47  * 'name' describes the value parsed in an error message, if any.
  48  *
  49  * Returns NULL if successful, otherwise a malloc()'d string describing the
  50  * error.  The caller is responsible for freeing the returned string. */
  51 static char * WARN_UNUSED_RESULT
  52 str_to_u8(const char *str, const char *name, uint8_t *valuep)
  53 {
  54     int value;
  55
  56     if (!str_to_int(str, 0, &value) || value < 0 || value > 255) {
  57         return xasprintf("invalid %s \"%s\"", name, str);
  58     }
  59     *valuep = value;
  60     return NULL;
  61 }
  62
  63 /* Parses 'str' as a 16-bit unsigned integer into '*valuep'.
  64  *
  65  * 'name' describes the value parsed in an error message, if any.
  66  *
  67  * Returns NULL if successful, otherwise a malloc()'d string describing the
  68  * error.  The caller is responsible for freeing the returned string. */
  69 static char * WARN_UNUSED_RESULT
  70 str_to_u16(const char *str, const char *name, uint16_t *valuep)
  71 {
  72     int value;
  73
  74     if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
  75         return xasprintf("invalid %s \"%s\"", name, str);
  76     }
  77     *valuep = value;
  78     return NULL;
  79 }
  80
  81 /* Parses 'str' as a 32-bit unsigned integer into '*valuep'.
  82  *
  83  * Returns NULL if successful, otherwise a malloc()'d string describing the
  84  * error.  The caller is responsible for freeing the returned string. */
  85 static char * WARN_UNUSED_RESULT
  86 str_to_u32(const char *str, uint32_t *valuep)
  87 {
  88     char *tail;
  89     uint32_t value;
  90
  91     if (!str[0]) {
  92         return xstrdup("missing required numeric argument");
  93     }
  94
  95     errno = 0;
  96     value = strtoul(str, &tail, 0);
  97     if (errno == EINVAL || errno == ERANGE || *tail) {
  98         return xasprintf("invalid numeric format %s", str);
  99     }
 100     *valuep = value;
 101     return NULL;
 102 }
 103
 104 /* Parses 'str' as an 64-bit unsigned integer into '*valuep'.
 105  *
 106  * Returns NULL if successful, otherwise a malloc()'d string describing the
 107  * error.  The caller is responsible for freeing the returned string. */
 108 static char * WARN_UNUSED_RESULT
 109 str_to_u64(const char *str, uint64_t *valuep)
 110 {
 111     char *tail;
 112     uint64_t value;
 113
 114     if (!str[0]) {
 115         return xstrdup("missing required numeric argument");
 116     }
 117
 118     errno = 0;
 119     value = strtoull(str, &tail, 0);
 120     if (errno == EINVAL || errno == ERANGE || *tail) {
 121         return xasprintf("invalid numeric format %s", str);
 122     }
 123     *valuep = value;
 124     return NULL;
 125 }
 126
 127 /* Parses 'str' as an 64-bit unsigned integer in network byte order into
 128  * '*valuep'.
 129  *
 130  * Returns NULL if successful, otherwise a malloc()'d string describing the
 131  * error.  The caller is responsible for freeing the returned string. */
 132 static char * WARN_UNUSED_RESULT
 133 str_to_be64(const char *str, ovs_be64 *valuep)
 134 {
 135     uint64_t value = 0;
 136     char *error;
 137
 138     error = str_to_u64(str, &value);
 139     if (!error) {
 140         *valuep = htonll(value);
 141     }
 142     return error;
 143 }
 144
 145 /* Parses 'str' as an Ethernet address into 'mac'.
 146  *
 147  * Returns NULL if successful, otherwise a malloc()'d string describing the
 148  * error.  The caller is responsible for freeing the returned string. */
 149 static char * WARN_UNUSED_RESULT
 150 str_to_mac(const char *str, uint8_t mac[6])
 151 {
 152     if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
 153         != ETH_ADDR_SCAN_COUNT) {
 154         return xasprintf("invalid mac address %s", str);
 155     }
 156     return NULL;
 157 }
 158
 159 /* Parses 'str' as an IP address into '*ip'.
 160  *
 161  * Returns NULL if successful, otherwise a malloc()'d string describing the
 162  * error.  The caller is responsible for freeing the returned string. */
 163 static char * WARN_UNUSED_RESULT
 164 str_to_ip(const char *str, ovs_be32 *ip)
 165 {
 166     struct in_addr in_addr;
 167
 168     if (lookup_ip(str, &in_addr)) {
 169         return xasprintf("%s: could not convert to IP address", str);
 170     }
 171     *ip = in_addr.s_addr;
 172     return NULL;
 173 }
 174
 175 /* Parses 'arg' as the argument to an "enqueue" action, and appends such an
 176  * action to 'ofpacts'.
 177  *
 178  * Returns NULL if successful, otherwise a malloc()'d string describing the
 179  * error.  The caller is responsible for freeing the returned string. */
 180 static char * WARN_UNUSED_RESULT
 181 parse_enqueue(char *arg, struct ofpbuf *ofpacts)
 182 {
 183     char *sp = NULL;
 184     char *port = strtok_r(arg, ":q", &sp);
 185     char *queue = strtok_r(NULL, "", &sp);
 186     struct ofpact_enqueue *enqueue;
 187
 188     if (port == NULL || queue == NULL) {
 189         return xstrdup("\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
 190     }
 191
 192     enqueue = ofpact_put_ENQUEUE(ofpacts);
 193     if (!ofputil_port_from_string(port, &enqueue->port)) {
 194         return xasprintf("%s: enqueue to unknown port", port);
 195     }
 196     return str_to_u32(queue, &enqueue->queue);
 197 }
 198
 199 /* Parses 'arg' as the argument to an "output" action, and appends such an
 200  * action to 'ofpacts'.
 201  *
 202  * Returns NULL if successful, otherwise a malloc()'d string describing the
 203  * error.  The caller is responsible for freeing the returned string. */
 204 static char * WARN_UNUSED_RESULT
 205 parse_output(const char *arg, struct ofpbuf *ofpacts)
 206 {
 207     if (strchr(arg, '[')) {
 208         struct ofpact_output_reg *output_reg;
 209
 210         output_reg = ofpact_put_OUTPUT_REG(ofpacts);
 211         output_reg->max_len = UINT16_MAX;
 212         return mf_parse_subfield(&output_reg->src, arg);
 213     } else {
 214         struct ofpact_output *output;
 215
 216         output = ofpact_put_OUTPUT(ofpacts);
 217         output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
 218         if (!ofputil_port_from_string(arg, &output->port)) {
 219             return xasprintf("%s: output to unknown port", arg);
 220         }
 221         return NULL;
 222     }
 223 }
 224
 225 /* Parses 'arg' as the argument to an "resubmit" action, and appends such an
 226  * action to 'ofpacts'.
 227  *
 228  * Returns NULL if successful, otherwise a malloc()'d string describing the
 229  * error.  The caller is responsible for freeing the returned string. */
 230 static char * WARN_UNUSED_RESULT
 231 parse_resubmit(char *arg, struct ofpbuf *ofpacts)
 232 {
 233     struct ofpact_resubmit *resubmit;
 234     char *in_port_s, *table_s;
 235
 236     resubmit = ofpact_put_RESUBMIT(ofpacts);
 237
 238     in_port_s = strsep(&arg, ",");
 239     if (in_port_s && in_port_s[0]) {
 240         if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
 241             return xasprintf("%s: resubmit to unknown port", in_port_s);
 242         }
 243     } else {
 244         resubmit->in_port = OFPP_IN_PORT;
 245     }
 246
 247     table_s = strsep(&arg, ",");
 248     if (table_s && table_s[0]) {
 249         uint32_t table_id = 0;
 250         char *error;
 251
 252         error = str_to_u32(table_s, &table_id);
 253         if (error) {
 254             return error;
 255         }
 256         resubmit->table_id = table_id;
 257     } else {
 258         resubmit->table_id = 255;
 259     }
 260
 261     if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
 262         return xstrdup("at least one \"in_port\" or \"table\" must be "
 263                        "specified  on resubmit");
 264     }
 265     return NULL;
 266 }
 267
 268 /* Parses 'arg' as the argument to a "note" action, and appends such an action
 269  * to 'ofpacts'.
 270  *
 271  * Returns NULL if successful, otherwise a malloc()'d string describing the
 272  * error.  The caller is responsible for freeing the returned string. */
 273 static char * WARN_UNUSED_RESULT
 274 parse_note(const char *arg, struct ofpbuf *ofpacts)
 275 {
 276     struct ofpact_note *note;
 277
 278     note = ofpact_put_NOTE(ofpacts);
 279     while (*arg != '\0') {
 280         uint8_t byte;
 281         bool ok;
 282
 283         if (*arg == '.') {
 284             arg++;
 285         }
 286         if (*arg == '\0') {
 287             break;
 288         }
 289
 290         byte = hexits_value(arg, 2, &ok);
 291         if (!ok) {
 292             return xstrdup("bad hex digit in `note' argument");
 293         }
 294         ofpbuf_put(ofpacts, &byte, 1);
 295
 296         note = ofpacts->l2;
 297         note->length++;
 298
 299         arg += 2;
 300     }
 301     ofpact_update_len(ofpacts, &note->ofpact);
 302     return NULL;
 303 }
 304
 305 /* Parses 'arg' as the argument to a "fin_timeout" action, and appends such an
 306  * action to 'ofpacts'.
 307  *
 308  * Returns NULL if successful, otherwise a malloc()'d string describing the
 309  * error.  The caller is responsible for freeing the returned string. */
 310 static char * WARN_UNUSED_RESULT
 311 parse_fin_timeout(struct ofpbuf *b, char *arg)
 312 {
 313     struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
 314     char *key, *value;
 315
 316     while (ofputil_parse_key_value(&arg, &key, &value)) {
 317         char *error;
 318
 319         if (!strcmp(key, "idle_timeout")) {
 320             error =  str_to_u16(value, key, &oft->fin_idle_timeout);
 321         } else if (!strcmp(key, "hard_timeout")) {
 322             error = str_to_u16(value, key, &oft->fin_hard_timeout);
 323         } else {
 324             error = xasprintf("invalid key '%s' in 'fin_timeout' argument",
 325                               key);
 326         }
 327
 328         if (error) {
 329             return error;
 330         }
 331     }
 332     return NULL;
 333 }
 334
 335 /* Parses 'arg' as the argument to a "controller" action, and appends such an
 336  * action to 'ofpacts'.
 337  *
 338  * Returns NULL if successful, otherwise a malloc()'d string describing the
 339  * error.  The caller is responsible for freeing the returned string. */
 340 static char * WARN_UNUSED_RESULT
 341 parse_controller(struct ofpbuf *b, char *arg)
 342 {
 343     enum ofp_packet_in_reason reason = OFPR_ACTION;
 344     uint16_t controller_id = 0;
 345     uint16_t max_len = UINT16_MAX;
 346
 347     if (!arg[0]) {
 348         /* Use defaults. */
 349     } else if (strspn(arg, "0123456789") == strlen(arg)) {
 350         char *error = str_to_u16(arg, "max_len", &max_len);
 351         if (error) {
 352             return error;
 353         }
 354     } else {
 355         char *name, *value;
 356
 357         while (ofputil_parse_key_value(&arg, &name, &value)) {
 358             if (!strcmp(name, "reason")) {
 359                 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
 360                     return xasprintf("unknown reason \"%s\"", value);
 361                 }
 362             } else if (!strcmp(name, "max_len")) {
 363                 char *error = str_to_u16(value, "max_len", &max_len);
 364                 if (error) {
 365                     return error;
 366                 }
 367             } else if (!strcmp(name, "id")) {
 368                 char *error = str_to_u16(value, "id", &controller_id);
 369                 if (error) {
 370                     return error;
 371                 }
 372             } else {
 373                 return xasprintf("unknown key \"%s\" parsing controller "
 374                                  "action", name);
 375             }
 376         }
 377     }
 378
 379     if (reason == OFPR_ACTION && controller_id == 0) {
 380         struct ofpact_output *output;
 381
 382         output = ofpact_put_OUTPUT(b);
 383         output->port = OFPP_CONTROLLER;
 384         output->max_len = max_len;
 385     } else {
 386         struct ofpact_controller *controller;
 387
 388         controller = ofpact_put_CONTROLLER(b);
 389         controller->max_len = max_len;
 390         controller->reason = reason;
 391         controller->controller_id = controller_id;
 392     }
 393
 394     return NULL;
 395 }
 396
 397 static void
 398 parse_noargs_dec_ttl(struct ofpbuf *b)
 399 {
 400     struct ofpact_cnt_ids *ids;
 401     uint16_t id = 0;
 402
 403     ids = ofpact_put_DEC_TTL(b);
 404     ofpbuf_put(b, &id, sizeof id);
 405     ids = b->l2;
 406     ids->n_controllers++;
 407     ofpact_update_len(b, &ids->ofpact);
 408 }
 409
 410 /* Parses 'arg' as the argument to a "dec_ttl" action, and appends such an
 411  * action to 'ofpacts'.
 412  *
 413  * Returns NULL if successful, otherwise a malloc()'d string describing the
 414  * error.  The caller is responsible for freeing the returned string. */
 415 static char * WARN_UNUSED_RESULT
 416 parse_dec_ttl(struct ofpbuf *b, char *arg)
 417 {
 418     if (*arg == '\0') {
 419         parse_noargs_dec_ttl(b);
 420     } else {
 421         struct ofpact_cnt_ids *ids;
 422         char *cntr;
 423
 424         ids = ofpact_put_DEC_TTL(b);
 425         ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
 426         for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
 427              cntr = strtok_r(NULL, ", ", &arg)) {
 428             uint16_t id = atoi(cntr);
 429
 430             ofpbuf_put(b, &id, sizeof id);
 431             ids = b->l2;
 432             ids->n_controllers++;
 433         }
 434         if (!ids->n_controllers) {
 435             return xstrdup("dec_ttl_cnt_ids: expected at least one controller "
 436                            "id.");
 437         }
 438         ofpact_update_len(b, &ids->ofpact);
 439     }
 440     return NULL;
 441 }
 442
 443 /* Parses 'arg' as the argument to a "set_mpls_ttl" action, and appends such an
 444  * action to 'ofpacts'.
 445  *
 446  * Returns NULL if successful, otherwise a malloc()'d string describing the
 447  * error.  The caller is responsible for freeing the returned string. */
 448 static char * WARN_UNUSED_RESULT
 449 parse_set_mpls_ttl(struct ofpbuf *b, const char *arg)
 450 {
 451     struct ofpact_mpls_ttl *mpls_ttl = ofpact_put_SET_MPLS_TTL(b);
 452
 453     if (*arg == '\0') {
 454         return xstrdup("parse_set_mpls_ttl: expected ttl.");
 455     }
 456
 457     mpls_ttl->ttl = atoi(arg);
 458     return NULL;
 459 }
 460
 461 /* Parses a "set_field" action with argument 'arg', appending the parsed
 462  * action to 'ofpacts'.
 463  *
 464  * Returns NULL if successful, otherwise a malloc()'d string describing the
 465  * error.  The caller is responsible for freeing the returned string. */
 466 static char * WARN_UNUSED_RESULT
 467 set_field_parse__(char *arg, struct ofpbuf *ofpacts,
 468                   enum ofputil_protocol *usable_protocols)
 469 {
 470     struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
 471     char *value;
 472     char *delim;
 473     char *key;
 474     const struct mf_field *mf;
 475     char *error;
 476     union mf_value mf_value;
 477
 478     value = arg;
 479     delim = strstr(arg, "->");
 480     if (!delim) {
 481         return xasprintf("%s: missing `->'", arg);
 482     }
 483     if (strlen(delim) <= strlen("->")) {
 484         return xasprintf("%s: missing field name following `->'", arg);
 485     }
 486
 487     key = delim + strlen("->");
 488     mf = mf_from_name(key);
 489     if (!mf) {
 490         return xasprintf("%s is not a valid OXM field name", key);
 491     }
 492     if (!mf->writable) {
 493         return xasprintf("%s is read-only", key);
 494     }
 495
 496     delim[0] = '\0';
 497     error = mf_parse_value(mf, value, &mf_value);
 498     if (error) {
 499         return error;
 500     }
 501     if (!mf_is_value_valid(mf, &mf_value)) {
 502         return xasprintf("%s is not a valid value for field %s", value, key);
 503     }
 504     ofpact_set_field_init(load, mf, &mf_value);
 505
 506     *usable_protocols &= mf->usable_protocols;
 507     return NULL;
 508 }
 509
 510 /* Parses 'arg' as the argument to a "set_field" action, and appends such an
 511  * action to 'ofpacts'.
 512  *
 513  * Returns NULL if successful, otherwise a malloc()'d string describing the
 514  * error.  The caller is responsible for freeing the returned string. */
 515 static char * WARN_UNUSED_RESULT
 516 set_field_parse(const char *arg, struct ofpbuf *ofpacts,
 517                 enum ofputil_protocol *usable_protocols)
 518 {
 519     char *copy = xstrdup(arg);
 520     char *error = set_field_parse__(copy, ofpacts, usable_protocols);
 521     free(copy);
 522     return error;
 523 }
 524
 525 /* Parses 'arg' as the argument to a "write_metadata" instruction, and appends
 526  * such an action to 'ofpacts'.
 527  *
 528  * Returns NULL if successful, otherwise a malloc()'d string describing the
 529  * error.  The caller is responsible for freeing the returned string. */
 530 static char * WARN_UNUSED_RESULT
 531 parse_metadata(struct ofpbuf *b, char *arg)
 532 {
 533     struct ofpact_metadata *om;
 534     char *mask = strchr(arg, '/');
 535
 536     om = ofpact_put_WRITE_METADATA(b);
 537
 538     if (mask) {
 539         char *error;
 540
 541         *mask = '\0';
 542         error = str_to_be64(mask + 1, &om->mask);
 543         if (error) {
 544             return error;
 545         }
 546     } else {
 547         om->mask = htonll(UINT64_MAX);
 548     }
 549
 550     return str_to_be64(arg, &om->metadata);
 551 }
 552
 553 /* Parses 'arg' as the argument to a "sample" action, and appends such an
 554  * action to 'ofpacts'.
 555  *
 556  * Returns NULL if successful, otherwise a malloc()'d string describing the
 557  * error.  The caller is responsible for freeing the returned string. */
 558 static char * WARN_UNUSED_RESULT
 559 parse_sample(struct ofpbuf *b, char *arg)
 560 {
 561     struct ofpact_sample *os = ofpact_put_SAMPLE(b);
 562     char *key, *value;
 563
 564     while (ofputil_parse_key_value(&arg, &key, &value)) {
 565         char *error = NULL;
 566
 567         if (!strcmp(key, "probability")) {
 568             error = str_to_u16(value, "probability", &os->probability);
 569             if (!error && os->probability == 0) {
 570                 error = xasprintf("invalid probability value \"%s\"", value);
 571             }
 572         } else if (!strcmp(key, "collector_set_id")) {
 573             error = str_to_u32(value, &os->collector_set_id);
 574         } else if (!strcmp(key, "obs_domain_id")) {
 575             error = str_to_u32(value, &os->obs_domain_id);
 576         } else if (!strcmp(key, "obs_point_id")) {
 577             error = str_to_u32(value, &os->obs_point_id);
 578         } else {
 579             error = xasprintf("invalid key \"%s\" in \"sample\" argument",
 580                               key);
 581         }
 582         if (error) {
 583             return error;
 584         }
 585     }
 586     if (os->probability == 0) {
 587         return xstrdup("non-zero \"probability\" must be specified on sample");
 588     }
 589     return NULL;
 590 }
 591
 592 /* Parses 'arg' as the argument to action 'code', and appends such an action to
 593  * 'ofpacts'.
 594  *
 595  * Returns NULL if successful, otherwise a malloc()'d string describing the
 596  * error.  The caller is responsible for freeing the returned string. */
 597 static char * WARN_UNUSED_RESULT
 598 parse_named_action(enum ofputil_action_code code,
 599                    char *arg, struct ofpbuf *ofpacts,
 600                    enum ofputil_protocol *usable_protocols)
 601 {
 602     size_t orig_size = ofpacts->size;
 603     struct ofpact_tunnel *tunnel;
 604     char *error = NULL;
 605     uint16_t ethertype = 0;
 606     uint16_t vid = 0;
 607     uint8_t tos = 0;
 608     uint8_t pcp = 0;
 609
 610     switch (code) {
 611     case OFPUTIL_ACTION_INVALID:
 612         NOT_REACHED();
 613
 614     case OFPUTIL_OFPAT10_OUTPUT:
 615     case OFPUTIL_OFPAT11_OUTPUT:
 616         error = parse_output(arg, ofpacts);
 617         break;
 618
 619     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 620     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 621         error = str_to_u16(arg, "VLAN VID", &vid);
 622         if (error) {
 623             return error;
 624         }
 625
 626         if (vid & ~VLAN_VID_MASK) {
 627             return xasprintf("%s: not a valid VLAN VID", arg);
 628         }
 629         ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
 630         break;
 631
 632     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 633     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 634         error = str_to_u8(arg, "VLAN PCP", &pcp);
 635         if (error) {
 636             return error;
 637         }
 638
 639         if (pcp & ~7) {
 640             return xasprintf("%s: not a valid VLAN PCP", arg);
 641         }
 642         ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
 643         break;
 644
 645     case OFPUTIL_OFPAT12_SET_FIELD:
 646         return set_field_parse(arg, ofpacts, usable_protocols);
 647
 648     case OFPUTIL_OFPAT10_STRIP_VLAN:
 649     case OFPUTIL_OFPAT11_POP_VLAN:
 650         ofpact_put_STRIP_VLAN(ofpacts);
 651         break;
 652
 653     case OFPUTIL_OFPAT11_PUSH_VLAN:
 654         *usable_protocols &= OFPUTIL_P_OF11_UP;
 655         error = str_to_u16(arg, "ethertype", &ethertype);
 656         if (error) {
 657             return error;
 658         }
 659
 660         if (ethertype != ETH_TYPE_VLAN_8021Q) {
 661             /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
 662             return xasprintf("%s: not a valid VLAN ethertype", arg);
 663         }
 664
 665         ofpact_put_PUSH_VLAN(ofpacts);
 666         break;
 667
 668     case OFPUTIL_OFPAT11_SET_QUEUE:
 669         error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
 670         break;
 671
 672     case OFPUTIL_OFPAT10_SET_DL_SRC:
 673     case OFPUTIL_OFPAT11_SET_DL_SRC:
 674         error = str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
 675         break;
 676
 677     case OFPUTIL_OFPAT10_SET_DL_DST:
 678     case OFPUTIL_OFPAT11_SET_DL_DST:
 679         error = str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
 680         break;
 681
 682     case OFPUTIL_OFPAT10_SET_NW_SRC:
 683     case OFPUTIL_OFPAT11_SET_NW_SRC:
 684         error = str_to_ip(arg, &ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4);
 685         break;
 686
 687     case OFPUTIL_OFPAT10_SET_NW_DST:
 688     case OFPUTIL_OFPAT11_SET_NW_DST:
 689         error = str_to_ip(arg, &ofpact_put_SET_IPV4_DST(ofpacts)->ipv4);
 690         break;
 691
 692     case OFPUTIL_OFPAT10_SET_NW_TOS:
 693     case OFPUTIL_OFPAT11_SET_NW_TOS:
 694         error = str_to_u8(arg, "TOS", &tos);
 695         if (error) {
 696             return error;
 697         }
 698
 699         if (tos & ~IP_DSCP_MASK) {
 700             return xasprintf("%s: not a valid TOS", arg);
 701         }
 702         ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
 703         break;
 704
 705     case OFPUTIL_OFPAT11_DEC_NW_TTL:
 706         NOT_REACHED();
 707
 708     case OFPUTIL_OFPAT10_SET_TP_SRC:
 709     case OFPUTIL_OFPAT11_SET_TP_SRC:
 710         error = str_to_u16(arg, "source port",
 711                            &ofpact_put_SET_L4_SRC_PORT(ofpacts)->port);
 712         break;
 713
 714     case OFPUTIL_OFPAT10_SET_TP_DST:
 715     case OFPUTIL_OFPAT11_SET_TP_DST:
 716         error = str_to_u16(arg, "destination port",
 717                            &ofpact_put_SET_L4_DST_PORT(ofpacts)->port);
 718         break;
 719
 720     case OFPUTIL_OFPAT10_ENQUEUE:
 721         error = parse_enqueue(arg, ofpacts);
 722         break;
 723
 724     case OFPUTIL_NXAST_RESUBMIT:
 725         error = parse_resubmit(arg, ofpacts);
 726         break;
 727
 728     case OFPUTIL_NXAST_SET_TUNNEL:
 729     case OFPUTIL_NXAST_SET_TUNNEL64:
 730         tunnel = ofpact_put_SET_TUNNEL(ofpacts);
 731         tunnel->ofpact.compat = code;
 732         error = str_to_u64(arg, &tunnel->tun_id);
 733         break;
 734
 735     case OFPUTIL_NXAST_WRITE_METADATA:
 736         error = parse_metadata(ofpacts, arg);
 737         break;
 738
 739     case OFPUTIL_NXAST_SET_QUEUE:
 740         error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
 741         break;
 742
 743     case OFPUTIL_NXAST_POP_QUEUE:
 744         ofpact_put_POP_QUEUE(ofpacts);
 745         break;
 746
 747     case OFPUTIL_NXAST_REG_MOVE:
 748         error = nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
 749         break;
 750
 751     case OFPUTIL_NXAST_REG_LOAD:
 752         error = nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
 753         break;
 754
 755     case OFPUTIL_NXAST_NOTE:
 756         error = parse_note(arg, ofpacts);
 757         break;
 758
 759     case OFPUTIL_NXAST_MULTIPATH:
 760         error = multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
 761         break;
 762
 763     case OFPUTIL_NXAST_BUNDLE:
 764         error = bundle_parse(arg, ofpacts);
 765         break;
 766
 767     case OFPUTIL_NXAST_BUNDLE_LOAD:
 768         error = bundle_parse_load(arg, ofpacts);
 769         break;
 770
 771     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 772     case OFPUTIL_NXAST_OUTPUT_REG:
 773     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 774         NOT_REACHED();
 775
 776     case OFPUTIL_NXAST_LEARN:
 777         error = learn_parse(arg, ofpacts);
 778         break;
 779
 780     case OFPUTIL_NXAST_EXIT:
 781         ofpact_put_EXIT(ofpacts);
 782         break;
 783
 784     case OFPUTIL_NXAST_DEC_TTL:
 785         error = parse_dec_ttl(ofpacts, arg);
 786         break;
 787
 788     case OFPUTIL_NXAST_SET_MPLS_TTL:
 789     case OFPUTIL_OFPAT11_SET_MPLS_TTL:
 790         error = parse_set_mpls_ttl(ofpacts, arg);
 791         break;
 792
 793     case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
 794     case OFPUTIL_NXAST_DEC_MPLS_TTL:
 795         ofpact_put_DEC_MPLS_TTL(ofpacts);
 796         break;
 797
 798     case OFPUTIL_NXAST_FIN_TIMEOUT:
 799         error = parse_fin_timeout(ofpacts, arg);
 800         break;
 801
 802     case OFPUTIL_NXAST_CONTROLLER:
 803         error = parse_controller(ofpacts, arg);
 804         break;
 805
 806     case OFPUTIL_OFPAT11_PUSH_MPLS:
 807     case OFPUTIL_NXAST_PUSH_MPLS:
 808         error = str_to_u16(arg, "push_mpls", &ethertype);
 809         if (!error) {
 810             ofpact_put_PUSH_MPLS(ofpacts)->ethertype = htons(ethertype);
 811         }
 812         break;
 813
 814     case OFPUTIL_OFPAT11_POP_MPLS:
 815     case OFPUTIL_NXAST_POP_MPLS:
 816         error = str_to_u16(arg, "pop_mpls", &ethertype);
 817         if (!error) {
 818             ofpact_put_POP_MPLS(ofpacts)->ethertype = htons(ethertype);
 819         }
 820         break;
 821
 822     case OFPUTIL_NXAST_STACK_PUSH:
 823         error = nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts), arg);
 824         break;
 825     case OFPUTIL_NXAST_STACK_POP:
 826         error = nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts), arg);
 827         break;
 828
 829     case OFPUTIL_NXAST_SAMPLE:
 830         error = parse_sample(ofpacts, arg);
 831         break;
 832     }
 833
 834     if (error) {
 835         ofpacts->size = orig_size;
 836     }
 837     return error;
 838 }
 839
 840 /* Parses action 'act', with argument 'arg', and appends a parsed version to
 841  * 'ofpacts'.
 842  *
 843  * 'n_actions' specifies the number of actions already parsed (for proper
 844  * handling of "drop" actions).
 845  *
 846  * Returns NULL if successful, otherwise a malloc()'d string describing the
 847  * error.  The caller is responsible for freeing the returned string. */
 848 static char * WARN_UNUSED_RESULT
 849 str_to_ofpact__(char *pos, char *act, char *arg,
 850                 struct ofpbuf *ofpacts, int n_actions,
 851                 enum ofputil_protocol *usable_protocols)
 852 {
 853     int code = ofputil_action_code_from_name(act);
 854     if (code >= 0) {
 855         return parse_named_action(code, arg, ofpacts, usable_protocols);
 856     } else if (!strcasecmp(act, "drop")) {
 857         if (n_actions) {
 858             return xstrdup("Drop actions must not be preceded by other "
 859                            "actions");
 860         } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
 861             return xstrdup("Drop actions must not be followed by other "
 862                            "actions");
 863         }
 864     } else {
 865         ofp_port_t port;
 866         if (ofputil_port_from_string(act, &port)) {
 867             ofpact_put_OUTPUT(ofpacts)->port = port;
 868         } else {
 869             return xasprintf("Unknown action: %s", act);
 870         }
 871     }
 872
 873     return NULL;
 874 }
 875
 876 /* Parses 'str' as a series of actions, and appends them to 'ofpacts'.
 877  *
 878  * Returns NULL if successful, otherwise a malloc()'d string describing the
 879  * error.  The caller is responsible for freeing the returned string. */
 880 static char * WARN_UNUSED_RESULT
 881 str_to_ofpacts(char *str, struct ofpbuf *ofpacts,
 882                enum ofputil_protocol *usable_protocols)
 883 {
 884     size_t orig_size = ofpacts->size;
 885     char *pos, *act, *arg;
 886     enum ofperr error;
 887     int n_actions;
 888
 889     pos = str;
 890     n_actions = 0;
 891     while (ofputil_parse_key_value(&pos, &act, &arg)) {
 892         char *error = str_to_ofpact__(pos, act, arg, ofpacts, n_actions,
 893                                       usable_protocols);
 894         if (error) {
 895             ofpacts->size = orig_size;
 896             return error;
 897         }
 898         n_actions++;
 899     }
 900
 901     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 902     if (error) {
 903         ofpacts->size = orig_size;
 904         return xstrdup("Incorrect action ordering");
 905     }
 906
 907     ofpact_pad(ofpacts);
 908     return NULL;
 909 }
 910
 911 /* Parses 'arg' as the argument to instruction 'type', and appends such an
 912  * instruction to 'ofpacts'.
 913  *
 914  * Returns NULL if successful, otherwise a malloc()'d string describing the
 915  * error.  The caller is responsible for freeing the returned string. */
 916 static char * WARN_UNUSED_RESULT
 917 parse_named_instruction(enum ovs_instruction_type type,
 918                         char *arg, struct ofpbuf *ofpacts,
 919                         enum ofputil_protocol *usable_protocols)
 920 {
 921     char *error_s = NULL;
 922     enum ofperr error;
 923
 924     *usable_protocols &= OFPUTIL_P_OF11_UP;
 925
 926     switch (type) {
 927     case OVSINST_OFPIT11_APPLY_ACTIONS:
 928         NOT_REACHED();  /* This case is handled by str_to_inst_ofpacts() */
 929         break;
 930
 931     case OVSINST_OFPIT11_WRITE_ACTIONS:
 932         /* XXX */
 933         error_s = xstrdup("instruction write-actions is not supported yet");
 934         break;
 935
 936     case OVSINST_OFPIT11_CLEAR_ACTIONS:
 937         ofpact_put_CLEAR_ACTIONS(ofpacts);
 938         break;
 939
 940     case OVSINST_OFPIT13_METER:
 941         *usable_protocols &= OFPUTIL_P_OF13_UP;
 942         error_s = str_to_u32(arg, &ofpact_put_METER(ofpacts)->meter_id);
 943         break;
 944
 945     case OVSINST_OFPIT11_WRITE_METADATA:
 946         *usable_protocols &= OFPUTIL_P_NXM_OF11_UP;
 947         error_s = parse_metadata(ofpacts, arg);
 948         break;
 949
 950     case OVSINST_OFPIT11_GOTO_TABLE: {
 951         struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
 952         char *table_s = strsep(&arg, ",");
 953         if (!table_s || !table_s[0]) {
 954             return xstrdup("instruction goto-table needs table id");
 955         }
 956         error_s = str_to_u8(table_s, "table", &ogt->table_id);
 957         break;
 958     }
 959     }
 960
 961     if (error_s) {
 962         return error_s;
 963     }
 964
 965     /* If write_metadata is specified as an action AND an instruction, ofpacts
 966        could be invalid. */
 967     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 968     if (error) {
 969         return xstrdup("Incorrect instruction ordering");
 970     }
 971     return NULL;
 972 }
 973
 974 /* Parses 'str' as a series of instructions, and appends them to 'ofpacts'.
 975  *
 976  * Returns NULL if successful, otherwise a malloc()'d string describing the
 977  * error.  The caller is responsible for freeing the returned string. */
 978 static char * WARN_UNUSED_RESULT
 979 str_to_inst_ofpacts(char *str, struct ofpbuf *ofpacts,
 980                     enum ofputil_protocol *usable_protocols)
 981 {
 982     size_t orig_size = ofpacts->size;
 983     char *pos, *inst, *arg;
 984     int type;
 985     const char *prev_inst = NULL;
 986     int prev_type = -1;
 987     int n_actions = 0;
 988
 989     pos = str;
 990     while (ofputil_parse_key_value(&pos, &inst, &arg)) {
 991         type = ovs_instruction_type_from_name(inst);
 992         if (type < 0) {
 993             char *error = str_to_ofpact__(pos, inst, arg, ofpacts, n_actions,
 994                                           usable_protocols);
 995             if (error) {
 996                 ofpacts->size = orig_size;
 997                 return error;
 998             }
 999
1000             type = OVSINST_OFPIT11_APPLY_ACTIONS;
1001             if (prev_type == type) {
1002                 n_actions++;
1003                 continue;
1004             }
1005         } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
1006             ofpacts->size = orig_size;
1007             return xasprintf("%s isn't supported. Just write actions then "
1008                              "it is interpreted as apply_actions", inst);
1009         } else {
1010             char *error = parse_named_instruction(type, arg, ofpacts,
1011                                                   usable_protocols);
1012             if (error) {
1013                 ofpacts->size = orig_size;
1014                 return error;
1015             }
1016         }
1017
1018         if (type <= prev_type) {
1019             ofpacts->size = orig_size;
1020             if (type == prev_type) {
1021                 return xasprintf("instruction %s may be specified only once",
1022                                  inst);
1023             } else {
1024                 return xasprintf("instruction %s must be specified before %s",
1025                                  inst, prev_inst);
1026             }
1027         }
1028
1029         prev_inst = inst;
1030         prev_type = type;
1031         n_actions++;
1032     }
1033     ofpact_pad(ofpacts);
1034
1035     return NULL;
1036 }
1037
1038 struct protocol {
1039     const char *name;
1040     uint16_t dl_type;
1041     uint8_t nw_proto;
1042 };
1043
1044 static bool
1045 parse_protocol(const char *name, const struct protocol **p_out)
1046 {
1047     static const struct protocol protocols[] = {
1048         { "ip", ETH_TYPE_IP, 0 },
1049         { "arp", ETH_TYPE_ARP, 0 },
1050         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
1051         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
1052         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
1053         { "sctp", ETH_TYPE_IP, IPPROTO_SCTP },
1054         { "ipv6", ETH_TYPE_IPV6, 0 },
1055         { "ip6", ETH_TYPE_IPV6, 0 },
1056         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
1057         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
1058         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
1059         { "sctp6", ETH_TYPE_IPV6, IPPROTO_SCTP },
1060         { "rarp", ETH_TYPE_RARP, 0},
1061         { "mpls", ETH_TYPE_MPLS, 0 },
1062         { "mplsm", ETH_TYPE_MPLS_MCAST, 0 },
1063     };
1064     const struct protocol *p;
1065
1066     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
1067         if (!strcmp(p->name, name)) {
1068             *p_out = p;
1069             return true;
1070         }
1071     }
1072     *p_out = NULL;
1073     return false;
1074 }
1075
1076 /* Parses 's' as the (possibly masked) value of field 'mf', and updates
1077  * 'match' appropriately.  Restricts the set of usable protocols to ones
1078  * supporting the parsed field.
1079  *
1080  * Returns NULL if successful, otherwise a malloc()'d string describing the
1081  * error.  The caller is responsible for freeing the returned string. */
1082 static char * WARN_UNUSED_RESULT
1083 parse_field(const struct mf_field *mf, const char *s, struct match *match,
1084             enum ofputil_protocol *usable_protocols)
1085 {
1086     union mf_value value, mask;
1087     char *error;
1088
1089     error = mf_parse(mf, s, &value, &mask);
1090     if (!error) {
1091         *usable_protocols &= mf_set(mf, &value, &mask, match);
1092     }
1093     return error;
1094 }
1095
1096 static char * WARN_UNUSED_RESULT
1097 parse_ofp_str__(struct ofputil_flow_mod *fm, int command, char *string,
1098                 enum ofputil_protocol *usable_protocols)
1099 {
1100     enum {
1101         F_OUT_PORT = 1 << 0,
1102         F_ACTIONS = 1 << 1,
1103         F_TIMEOUT = 1 << 3,
1104         F_PRIORITY = 1 << 4,
1105         F_FLAGS = 1 << 5,
1106     } fields;
1107     char *save_ptr = NULL;
1108     char *act_str = NULL;
1109     char *name;
1110
1111     *usable_protocols = OFPUTIL_P_ANY;
1112
1113     switch (command) {
1114     case -1:
1115         fields = F_OUT_PORT;
1116         break;
1117
1118     case OFPFC_ADD:
1119         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1120         break;
1121
1122     case OFPFC_DELETE:
1123         fields = F_OUT_PORT;
1124         break;
1125
1126     case OFPFC_DELETE_STRICT:
1127         fields = F_OUT_PORT | F_PRIORITY;
1128         break;
1129
1130     case OFPFC_MODIFY:
1131         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1132         break;
1133
1134     case OFPFC_MODIFY_STRICT:
1135         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1136         break;
1137
1138     default:
1139         NOT_REACHED();
1140     }
1141
1142     match_init_catchall(&fm->match);
1143     fm->priority = OFP_DEFAULT_PRIORITY;
1144     fm->cookie = htonll(0);
1145     fm->cookie_mask = htonll(0);
1146     if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
1147         /* For modify, by default, don't update the cookie. */
1148         fm->new_cookie = htonll(UINT64_MAX);
1149     } else{
1150         fm->new_cookie = htonll(0);
1151     }
1152     fm->modify_cookie = false;
1153     fm->table_id = 0xff;
1154     fm->command = command;
1155     fm->idle_timeout = OFP_FLOW_PERMANENT;
1156     fm->hard_timeout = OFP_FLOW_PERMANENT;
1157     fm->buffer_id = UINT32_MAX;
1158     fm->out_port = OFPP_ANY;
1159     fm->flags = 0;
1160     if (fields & F_ACTIONS) {
1161         act_str = strstr(string, "action");
1162         if (!act_str) {
1163             return xstrdup("must specify an action");
1164         }
1165         *act_str = '\0';
1166
1167         act_str = strchr(act_str + 1, '=');
1168         if (!act_str) {
1169             return xstrdup("must specify an action");
1170         }
1171
1172         act_str++;
1173     }
1174     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1175          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1176         const struct protocol *p;
1177         char *error = NULL;
1178
1179         if (parse_protocol(name, &p)) {
1180             match_set_dl_type(&fm->match, htons(p->dl_type));
1181             if (p->nw_proto) {
1182                 match_set_nw_proto(&fm->match, p->nw_proto);
1183             }
1184         } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
1185             fm->flags |= OFPUTIL_FF_SEND_FLOW_REM;
1186         } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
1187             fm->flags |= OFPUTIL_FF_CHECK_OVERLAP;
1188         } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
1189             fm->flags |= OFPUTIL_FF_RESET_COUNTS;
1190             *usable_protocols &= OFPUTIL_P_OF12_UP;
1191         } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
1192             fm->flags |= OFPUTIL_FF_NO_PKT_COUNTS;
1193             *usable_protocols &= OFPUTIL_P_OF13_UP;
1194         } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
1195             fm->flags |= OFPUTIL_FF_NO_BYT_COUNTS;
1196             *usable_protocols &= OFPUTIL_P_OF13_UP;
1197         } else {
1198             char *value;
1199
1200             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1201             if (!value) {
1202                 return xasprintf("field %s missing value", name);
1203             }
1204
1205             if (!strcmp(name, "table")) {
1206                 error = str_to_u8(value, "table", &fm->table_id);
1207                 if (fm->table_id != 0xff) {
1208                     *usable_protocols &= OFPUTIL_P_TID;
1209                 }
1210             } else if (!strcmp(name, "out_port")) {
1211                 if (!ofputil_port_from_string(value, &fm->out_port)) {
1212                     error = xasprintf("%s is not a valid OpenFlow port",
1213                                       value);
1214                 }
1215             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
1216                 uint16_t priority = 0;
1217
1218                 error = str_to_u16(value, name, &priority);
1219                 fm->priority = priority;
1220             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
1221                 error = str_to_u16(value, name, &fm->idle_timeout);
1222             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
1223                 error = str_to_u16(value, name, &fm->hard_timeout);
1224             } else if (!strcmp(name, "cookie")) {
1225                 char *mask = strchr(value, '/');
1226
1227                 if (mask) {
1228                     /* A mask means we're searching for a cookie. */
1229                     if (command == OFPFC_ADD) {
1230                         return xstrdup("flow additions cannot use "
1231                                        "a cookie mask");
1232                     }
1233                     *mask = '\0';
1234                     error = str_to_be64(value, &fm->cookie);
1235                     if (error) {
1236                         return error;
1237                     }
1238                     error = str_to_be64(mask + 1, &fm->cookie_mask);
1239
1240                     /* Matching of the cookie is only supported through NXM or
1241                      * OF1.1+. */
1242                     if (fm->cookie_mask != htonll(0)) {
1243                         *usable_protocols &= OFPUTIL_P_NXM_OF11_UP;
1244                     }
1245                 } else {
1246                     /* No mask means that the cookie is being set. */
1247                     if (command != OFPFC_ADD && command != OFPFC_MODIFY
1248                         && command != OFPFC_MODIFY_STRICT) {
1249                         return xstrdup("cannot set cookie");
1250                     }
1251                     error = str_to_be64(value, &fm->new_cookie);
1252                     fm->modify_cookie = true;
1253                 }
1254             } else if (mf_from_name(name)) {
1255                 error = parse_field(mf_from_name(name), value, &fm->match,
1256                                     usable_protocols);
1257             } else if (!strcmp(name, "duration")
1258                        || !strcmp(name, "n_packets")
1259                        || !strcmp(name, "n_bytes")
1260                        || !strcmp(name, "idle_age")
1261                        || !strcmp(name, "hard_age")) {
1262                 /* Ignore these, so that users can feed the output of
1263                  * "ovs-ofctl dump-flows" back into commands that parse
1264                  * flows. */
1265             } else {
1266                 error = xasprintf("unknown keyword %s", name);
1267             }
1268
1269             if (error) {
1270                 return error;
1271             }
1272         }
1273     }
1274     /* Check for usable protocol interdependencies between match fields. */
1275     if (fm->match.flow.dl_type == htons(ETH_TYPE_IPV6)) {
1276         const struct flow_wildcards *wc = &fm->match.wc;
1277         /* Only NXM and OXM support matching L3 and L4 fields within IPv6.
1278          *
1279          * (IPv6 specific fields as well as arp_sha, arp_tha, nw_frag, and
1280          *  nw_ttl are covered elsewhere so they don't need to be included in
1281          *  this test too.)
1282          */
1283         if (wc->masks.nw_proto || wc->masks.nw_tos
1284             || wc->masks.tp_src || wc->masks.tp_dst) {
1285             *usable_protocols &= OFPUTIL_P_NXM_OXM_ANY;
1286         }
1287     }
1288     if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
1289         && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
1290         /* On modifies without a mask, we are supposed to add a flow if
1291          * one does not exist.  If a cookie wasn't been specified, use a
1292          * default of zero. */
1293         fm->new_cookie = htonll(0);
1294     }
1295     if (fields & F_ACTIONS) {
1296         struct ofpbuf ofpacts;
1297         char *error;
1298
1299         ofpbuf_init(&ofpacts, 32);
1300         error = str_to_inst_ofpacts(act_str, &ofpacts, usable_protocols);
1301         if (!error) {
1302             enum ofperr err;
1303
1304             err = ofpacts_check(ofpacts.data, ofpacts.size, &fm->match.flow,
1305                                 OFPP_MAX, 0);
1306             if (err) {
1307                 error = xasprintf("actions are invalid with specified match "
1308                                   "(%s)", ofperr_to_string(err));
1309             }
1310         }
1311         if (error) {
1312             ofpbuf_uninit(&ofpacts);
1313             return error;
1314         }
1315
1316         fm->ofpacts_len = ofpacts.size;
1317         fm->ofpacts = ofpbuf_steal_data(&ofpacts);
1318     } else {
1319         fm->ofpacts_len = 0;
1320         fm->ofpacts = NULL;
1321     }
1322
1323     return NULL;
1324 }
1325
1326 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1327  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
1328  * Returns the set of usable protocols in '*usable_protocols'.
1329  *
1330  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
1331  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
1332  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'.
1333  *
1334  * Returns NULL if successful, otherwise a malloc()'d string describing the
1335  * error.  The caller is responsible for freeing the returned string. */
1336 char * WARN_UNUSED_RESULT
1337 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
1338               enum ofputil_protocol *usable_protocols)
1339 {
1340     char *string = xstrdup(str_);
1341     char *error;
1342
1343     error = parse_ofp_str__(fm, command, string, usable_protocols);
1344     if (error) {
1345         fm->ofpacts = NULL;
1346         fm->ofpacts_len = 0;
1347     }
1348
1349     free(string);
1350     return error;
1351 }
1352
1353 static char * WARN_UNUSED_RESULT
1354 parse_ofp_meter_mod_str__(struct ofputil_meter_mod *mm, char *string,
1355                           struct ofpbuf *bands, int command,
1356                           enum ofputil_protocol *usable_protocols)
1357 {
1358     enum {
1359         F_METER = 1 << 0,
1360         F_FLAGS = 1 << 1,
1361         F_BANDS = 1 << 2,
1362     } fields;
1363     char *save_ptr = NULL;
1364     char *band_str = NULL;
1365     char *name;
1366
1367     /* Meters require at least OF 1.3. */
1368     *usable_protocols &= OFPUTIL_P_OF13_UP;
1369
1370     switch (command) {
1371     case -1:
1372         fields = F_METER;
1373         break;
1374
1375     case OFPMC13_ADD:
1376         fields = F_METER | F_FLAGS | F_BANDS;
1377         break;
1378
1379     case OFPMC13_DELETE:
1380         fields = F_METER;
1381         break;
1382
1383     case OFPMC13_MODIFY:
1384         fields = F_METER | F_FLAGS | F_BANDS;
1385         break;
1386
1387     default:
1388         NOT_REACHED();
1389     }
1390
1391     mm->command = command;
1392     mm->meter.meter_id = 0;
1393     mm->meter.flags = 0;
1394     if (fields & F_BANDS) {
1395         band_str = strstr(string, "band");
1396         if (!band_str) {
1397             return xstrdup("must specify bands");
1398         }
1399         *band_str = '\0';
1400
1401         band_str = strchr(band_str + 1, '=');
1402         if (!band_str) {
1403             return xstrdup("must specify bands");
1404         }
1405
1406         band_str++;
1407     }
1408     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1409          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1410
1411         if (fields & F_FLAGS && !strcmp(name, "kbps")) {
1412             mm->meter.flags |= OFPMF13_KBPS;
1413         } else if (fields & F_FLAGS && !strcmp(name, "pktps")) {
1414             mm->meter.flags |= OFPMF13_PKTPS;
1415         } else if (fields & F_FLAGS && !strcmp(name, "burst")) {
1416             mm->meter.flags |= OFPMF13_BURST;
1417         } else if (fields & F_FLAGS && !strcmp(name, "stats")) {
1418             mm->meter.flags |= OFPMF13_STATS;
1419         } else {
1420             char *value;
1421
1422             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1423             if (!value) {
1424                 return xasprintf("field %s missing value", name);
1425             }
1426
1427             if (!strcmp(name, "meter")) {
1428                 if (!strcmp(value, "all")) {
1429                     mm->meter.meter_id = OFPM13_ALL;
1430                 } else if (!strcmp(value, "controller")) {
1431                     mm->meter.meter_id = OFPM13_CONTROLLER;
1432                 } else if (!strcmp(value, "slowpath")) {
1433                     mm->meter.meter_id = OFPM13_SLOWPATH;
1434                 } else {
1435                     char *error = str_to_u32(value, &mm->meter.meter_id);
1436                     if (error) {
1437                         return error;
1438                     }
1439                     if (mm->meter.meter_id > OFPM13_MAX) {
1440                         return xasprintf("invalid value for %s", name);
1441                     }
1442                 }
1443             } else {
1444                 return xasprintf("unknown keyword %s", name);
1445             }
1446         }
1447     }
1448     if (fields & F_METER && !mm->meter.meter_id) {
1449         return xstrdup("must specify 'meter'");
1450     }
1451     if (fields & F_FLAGS && !mm->meter.flags) {
1452         return xstrdup("meter must specify either 'kbps' or 'pktps'");
1453     }
1454
1455     if (fields & F_BANDS) {
1456         uint16_t n_bands = 0;
1457         struct ofputil_meter_band *band = NULL;
1458         int i;
1459
1460         for (name = strtok_r(band_str, "=, \t\r\n", &save_ptr); name;
1461              name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1462
1463             char *value;
1464
1465             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1466             if (!value) {
1467                 return xasprintf("field %s missing value", name);
1468             }
1469
1470             if (!strcmp(name, "type")) {
1471                 /* Start a new band */
1472                 band = ofpbuf_put_zeros(bands, sizeof *band);
1473                 n_bands++;
1474
1475                 if (!strcmp(value, "drop")) {
1476                     band->type = OFPMBT13_DROP;
1477                 } else if (!strcmp(value, "dscp_remark")) {
1478                     band->type = OFPMBT13_DSCP_REMARK;
1479                 } else {
1480                     return xasprintf("field %s unknown value %s", name, value);
1481                 }
1482             } else if (!band || !band->type) {
1483                 return xstrdup("band must start with the 'type' keyword");
1484             } else if (!strcmp(name, "rate")) {
1485                 char *error = str_to_u32(value, &band->rate);
1486                 if (error) {
1487                     return error;
1488                 }
1489             } else if (!strcmp(name, "burst_size")) {
1490                 char *error = str_to_u32(value, &band->burst_size);
1491                 if (error) {
1492                     return error;
1493                 }
1494             } else if (!strcmp(name, "prec_level")) {
1495                 char *error = str_to_u8(value, name, &band->prec_level);
1496                 if (error) {
1497                     return error;
1498                 }
1499             } else {
1500                 return xasprintf("unknown keyword %s", name);
1501             }
1502         }
1503         /* validate bands */
1504         if (!n_bands) {
1505             return xstrdup("meter must have bands");
1506         }
1507
1508         mm->meter.n_bands = n_bands;
1509         mm->meter.bands = ofpbuf_steal_data(bands);
1510
1511         for (i = 0; i < n_bands; ++i) {
1512             band = &mm->meter.bands[i];
1513
1514             if (!band->type) {
1515                 return xstrdup("band must have 'type'");
1516             }
1517             if (band->type == OFPMBT13_DSCP_REMARK) {
1518                 if (!band->prec_level) {
1519                     return xstrdup("'dscp_remark' band must have"
1520                                    " 'prec_level'");
1521                 }
1522             } else {
1523                 if (band->prec_level) {
1524                     return xstrdup("Only 'dscp_remark' band may have"
1525                                    " 'prec_level'");
1526                 }
1527             }
1528             if (!band->rate) {
1529                 return xstrdup("band must have 'rate'");
1530             }
1531             if (mm->meter.flags & OFPMF13_BURST) {
1532                 if (!band->burst_size) {
1533                     return xstrdup("band must have 'burst_size' "
1534                                    "when 'burst' flag is set");
1535                 }
1536             } else {
1537                 if (band->burst_size) {
1538                     return xstrdup("band may have 'burst_size' only "
1539                                    "when 'burst' flag is set");
1540                 }
1541             }
1542         }
1543     } else {
1544         mm->meter.n_bands = 0;
1545         mm->meter.bands = NULL;
1546     }
1547
1548     return NULL;
1549 }
1550
1551 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1552  * page) into 'mm' for sending the specified meter_mod 'command' to a switch.
1553  *
1554  * Returns NULL if successful, otherwise a malloc()'d string describing the
1555  * error.  The caller is responsible for freeing the returned string. */
1556 char * WARN_UNUSED_RESULT
1557 parse_ofp_meter_mod_str(struct ofputil_meter_mod *mm, const char *str_,
1558                         int command, enum ofputil_protocol *usable_protocols)
1559 {
1560     struct ofpbuf bands;
1561     char *string;
1562     char *error;
1563
1564     ofpbuf_init(&bands, 64);
1565     string = xstrdup(str_);
1566
1567     error = parse_ofp_meter_mod_str__(mm, string, &bands, command,
1568                                       usable_protocols);
1569
1570     free(string);
1571     ofpbuf_uninit(&bands);
1572
1573     return error;
1574 }
1575
1576 static char * WARN_UNUSED_RESULT
1577 parse_flow_monitor_request__(struct ofputil_flow_monitor_request *fmr,
1578                              const char *str_, char *string,
1579                              enum ofputil_protocol *usable_protocols)
1580 {
1581     static atomic_uint32_t id = ATOMIC_VAR_INIT(0);
1582     char *save_ptr = NULL;
1583     char *name;
1584
1585     atomic_add(&id, 1, &fmr->id);
1586
1587     fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
1588                   | NXFMF_OWN | NXFMF_ACTIONS);
1589     fmr->out_port = OFPP_NONE;
1590     fmr->table_id = 0xff;
1591     match_init_catchall(&fmr->match);
1592
1593     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1594          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1595         const struct protocol *p;
1596
1597         if (!strcmp(name, "!initial")) {
1598             fmr->flags &= ~NXFMF_INITIAL;
1599         } else if (!strcmp(name, "!add")) {
1600             fmr->flags &= ~NXFMF_ADD;
1601         } else if (!strcmp(name, "!delete")) {
1602             fmr->flags &= ~NXFMF_DELETE;
1603         } else if (!strcmp(name, "!modify")) {
1604             fmr->flags &= ~NXFMF_MODIFY;
1605         } else if (!strcmp(name, "!actions")) {
1606             fmr->flags &= ~NXFMF_ACTIONS;
1607         } else if (!strcmp(name, "!own")) {
1608             fmr->flags &= ~NXFMF_OWN;
1609         } else if (parse_protocol(name, &p)) {
1610             match_set_dl_type(&fmr->match, htons(p->dl_type));
1611             if (p->nw_proto) {
1612                 match_set_nw_proto(&fmr->match, p->nw_proto);
1613             }
1614         } else {
1615             char *value;
1616
1617             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1618             if (!value) {
1619                 return xasprintf("%s: field %s missing value", str_, name);
1620             }
1621
1622             if (!strcmp(name, "table")) {
1623                 char *error = str_to_u8(value, "table", &fmr->table_id);
1624                 if (error) {
1625                     return error;
1626                 }
1627             } else if (!strcmp(name, "out_port")) {
1628                 fmr->out_port = u16_to_ofp(atoi(value));
1629             } else if (mf_from_name(name)) {
1630                 char *error;
1631
1632                 error = parse_field(mf_from_name(name), value, &fmr->match,
1633                                     usable_protocols);
1634                 if (error) {
1635                     return error;
1636                 }
1637             } else {
1638                 return xasprintf("%s: unknown keyword %s", str_, name);
1639             }
1640         }
1641     }
1642     return NULL;
1643 }
1644
1645 /* Convert 'str_' (as described in the documentation for the "monitor" command
1646  * in the ovs-ofctl man page) into 'fmr'.
1647  *
1648  * Returns NULL if successful, otherwise a malloc()'d string describing the
1649  * error.  The caller is responsible for freeing the returned string. */
1650 char * WARN_UNUSED_RESULT
1651 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
1652                            const char *str_,
1653                            enum ofputil_protocol *usable_protocols)
1654 {
1655     char *string = xstrdup(str_);
1656     char *error = parse_flow_monitor_request__(fmr, str_, string,
1657                                                usable_protocols);
1658     free(string);
1659     return error;
1660 }
1661
1662 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1663  * 'actions'.
1664  *
1665  * Returns NULL if successful, otherwise a malloc()'d string describing the
1666  * error.  The caller is responsible for freeing the returned string. */
1667 char * WARN_UNUSED_RESULT
1668 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts,
1669               enum ofputil_protocol *usable_protocols)
1670 {
1671     char *s = xstrdup(s_);
1672     char *error;
1673
1674     *usable_protocols = OFPUTIL_P_ANY;
1675
1676     error = str_to_ofpacts(s, ofpacts, usable_protocols);
1677     free(s);
1678
1679     return error;
1680 }
1681
1682 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1683  * (one of OFPFC_*) into 'fm'.
1684  *
1685  * Returns NULL if successful, otherwise a malloc()'d string describing the
1686  * error.  The caller is responsible for freeing the returned string. */
1687 char * WARN_UNUSED_RESULT
1688 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1689                        uint16_t command,
1690                        enum ofputil_protocol *usable_protocols)
1691 {
1692     char *error = parse_ofp_str(fm, command, string, usable_protocols);
1693     if (!error) {
1694         /* Normalize a copy of the match.  This ensures that non-normalized
1695          * flows get logged but doesn't affect what gets sent to the switch, so
1696          * that the switch can do whatever it likes with the flow. */
1697         struct match match_copy = fm->match;
1698         ofputil_normalize_match(&match_copy);
1699     }
1700
1701     return error;
1702 }
1703
1704 /* Opens file 'file_name' and reads each line as a flow_mod of the specified
1705  * type (one of OFPFC_*).  Stores each flow_mod in '*fm', an array allocated
1706  * on the caller's behalf, and the number of flow_mods in '*n_fms'.
1707  *
1708  * Returns NULL if successful, otherwise a malloc()'d string describing the
1709  * error.  The caller is responsible for freeing the returned string. */
1710 char * WARN_UNUSED_RESULT
1711 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1712                         struct ofputil_flow_mod **fms, size_t *n_fms,
1713                         enum ofputil_protocol *usable_protocols)
1714 {
1715     size_t allocated_fms;
1716     int line_number;
1717     FILE *stream;
1718     struct ds s;
1719
1720     *usable_protocols = OFPUTIL_P_ANY;
1721
1722     *fms = NULL;
1723     *n_fms = 0;
1724
1725     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1726     if (stream == NULL) {
1727         return xasprintf("%s: open failed (%s)",
1728                          file_name, ovs_strerror(errno));
1729     }
1730
1731     allocated_fms = *n_fms;
1732     ds_init(&s);
1733     line_number = 0;
1734     while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
1735         char *error;
1736         enum ofputil_protocol usable;
1737
1738         if (*n_fms >= allocated_fms) {
1739             *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1740         }
1741         error = parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command,
1742                                        &usable);
1743         if (error) {
1744             size_t i;
1745
1746             for (i = 0; i < *n_fms; i++) {
1747                 free((*fms)[i].ofpacts);
1748             }
1749             free(*fms);
1750             *fms = NULL;
1751             *n_fms = 0;
1752
1753             ds_destroy(&s);
1754             if (stream != stdin) {
1755                 fclose(stream);
1756             }
1757
1758             return xasprintf("%s:%d: %s", file_name, line_number, error);
1759         }
1760         *usable_protocols &= usable; /* Each line can narrow the set. */
1761         *n_fms += 1;
1762     }
1763
1764     ds_destroy(&s);
1765     if (stream != stdin) {
1766         fclose(stream);
1767     }
1768     return NULL;
1769 }
1770
1771 char * WARN_UNUSED_RESULT
1772 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1773                                  bool aggregate, const char *string,
1774                                  enum ofputil_protocol *usable_protocols)
1775 {
1776     struct ofputil_flow_mod fm;
1777     char *error;
1778
1779     error = parse_ofp_str(&fm, -1, string, usable_protocols);
1780     if (error) {
1781         return error;
1782     }
1783
1784     /* Special table ID support not required for stats requests. */
1785     if (*usable_protocols & OFPUTIL_P_OF10_STD_TID) {
1786         *usable_protocols |= OFPUTIL_P_OF10_STD;
1787     }
1788     if (*usable_protocols & OFPUTIL_P_OF10_NXM_TID) {
1789         *usable_protocols |= OFPUTIL_P_OF10_NXM;
1790     }
1791
1792     fsr->aggregate = aggregate;
1793     fsr->cookie = fm.cookie;
1794     fsr->cookie_mask = fm.cookie_mask;
1795     fsr->match = fm.match;
1796     fsr->out_port = fm.out_port;
1797     fsr->table_id = fm.table_id;
1798     return NULL;
1799 }
1800
1801 /* Parses a specification of a flow from 's' into 'flow'.  's' must take the
1802  * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1803  * mf_field.  Fields must be specified in a natural order for satisfying
1804  * prerequisites.
1805  *
1806  * Returns NULL on success, otherwise a malloc()'d string that explains the
1807  * problem. */
1808 char *
1809 parse_ofp_exact_flow(struct flow *flow, const char *s)
1810 {
1811     char *pos, *key, *value_s;
1812     char *error = NULL;
1813     char *copy;
1814
1815     memset(flow, 0, sizeof *flow);
1816
1817     pos = copy = xstrdup(s);
1818     while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1819         const struct protocol *p;
1820         if (parse_protocol(key, &p)) {
1821             if (flow->dl_type) {
1822                 error = xasprintf("%s: Ethernet type set multiple times", s);
1823                 goto exit;
1824             }
1825             flow->dl_type = htons(p->dl_type);
1826
1827             if (p->nw_proto) {
1828                 if (flow->nw_proto) {
1829                     error = xasprintf("%s: network protocol set "
1830                                       "multiple times", s);
1831                     goto exit;
1832                 }
1833                 flow->nw_proto = p->nw_proto;
1834             }
1835         } else {
1836             const struct mf_field *mf;
1837             union mf_value value;
1838             char *field_error;
1839
1840             mf = mf_from_name(key);
1841             if (!mf) {
1842                 error = xasprintf("%s: unknown field %s", s, key);
1843                 goto exit;
1844             }
1845
1846             if (!mf_are_prereqs_ok(mf, flow)) {
1847                 error = xasprintf("%s: prerequisites not met for setting %s",
1848                                   s, key);
1849                 goto exit;
1850             }
1851
1852             if (!mf_is_zero(mf, flow)) {
1853                 error = xasprintf("%s: field %s set multiple times", s, key);
1854                 goto exit;
1855             }
1856
1857             field_error = mf_parse_value(mf, value_s, &value);
1858             if (field_error) {
1859                 error = xasprintf("%s: bad value for %s (%s)",
1860                                   s, key, field_error);
1861                 free(field_error);
1862                 goto exit;
1863             }
1864
1865             mf_set_flow_value(mf, &value, flow);
1866         }
1867     }
1868
1869     if (!flow->in_port.ofp_port) {
1870         flow->in_port.ofp_port = OFPP_NONE;
1871     }
1872
1873 exit:
1874     free(copy);
1875
1876     if (error) {
1877         memset(flow, 0, sizeof *flow);
1878     }
1879     return error;
1880 }