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 {
 469     struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
 470     char *value;
 471     char *delim;
 472     char *key;
 473     const struct mf_field *mf;
 474     char *error;
 475     union mf_value mf_value;
 476
 477     value = arg;
 478     delim = strstr(arg, "->");
 479     if (!delim) {
 480         return xasprintf("%s: missing `->'", arg);
 481     }
 482     if (strlen(delim) <= strlen("->")) {
 483         return xasprintf("%s: missing field name following `->'", arg);
 484     }
 485
 486     key = delim + strlen("->");
 487     mf = mf_from_name(key);
 488     if (!mf) {
 489         return xasprintf("%s is not a valid OXM field name", key);
 490     }
 491     if (!mf->writable) {
 492         return xasprintf("%s is read-only", key);
 493     }
 494
 495     delim[0] = '\0';
 496     error = mf_parse_value(mf, value, &mf_value);
 497     if (error) {
 498         return error;
 499     }
 500     if (!mf_is_value_valid(mf, &mf_value)) {
 501         return xasprintf("%s is not a valid value for field %s", value, key);
 502     }
 503     ofpact_set_field_init(load, mf, &mf_value);
 504
 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 {
 516     char *copy = xstrdup(arg);
 517     char *error = set_field_parse__(copy, ofpacts);
 518     free(copy);
 519     return error;
 520 }
 521
 522 /* Parses 'arg' as the argument to a "write_metadata" instruction, and appends
 523  * such an action to 'ofpacts'.
 524  *
 525  * Returns NULL if successful, otherwise a malloc()'d string describing the
 526  * error.  The caller is responsible for freeing the returned string. */
 527 static char * WARN_UNUSED_RESULT
 528 parse_metadata(struct ofpbuf *b, char *arg)
 529 {
 530     struct ofpact_metadata *om;
 531     char *mask = strchr(arg, '/');
 532
 533     om = ofpact_put_WRITE_METADATA(b);
 534
 535     if (mask) {
 536         char *error;
 537
 538         *mask = '\0';
 539         error = str_to_be64(mask + 1, &om->mask);
 540         if (error) {
 541             return error;
 542         }
 543     } else {
 544         om->mask = htonll(UINT64_MAX);
 545     }
 546
 547     return str_to_be64(arg, &om->metadata);
 548 }
 549
 550 /* Parses 'arg' as the argument to a "sample" action, and appends such an
 551  * action to 'ofpacts'.
 552  *
 553  * Returns NULL if successful, otherwise a malloc()'d string describing the
 554  * error.  The caller is responsible for freeing the returned string. */
 555 static char * WARN_UNUSED_RESULT
 556 parse_sample(struct ofpbuf *b, char *arg)
 557 {
 558     struct ofpact_sample *os = ofpact_put_SAMPLE(b);
 559     char *key, *value;
 560
 561     while (ofputil_parse_key_value(&arg, &key, &value)) {
 562         char *error = NULL;
 563
 564         if (!strcmp(key, "probability")) {
 565             error = str_to_u16(value, "probability", &os->probability);
 566             if (!error && os->probability == 0) {
 567                 error = xasprintf("invalid probability value \"%s\"", value);
 568             }
 569         } else if (!strcmp(key, "collector_set_id")) {
 570             error = str_to_u32(value, &os->collector_set_id);
 571         } else if (!strcmp(key, "obs_domain_id")) {
 572             error = str_to_u32(value, &os->obs_domain_id);
 573         } else if (!strcmp(key, "obs_point_id")) {
 574             error = str_to_u32(value, &os->obs_point_id);
 575         } else {
 576             error = xasprintf("invalid key \"%s\" in \"sample\" argument",
 577                               key);
 578         }
 579         if (error) {
 580             return error;
 581         }
 582     }
 583     if (os->probability == 0) {
 584         return xstrdup("non-zero \"probability\" must be specified on sample");
 585     }
 586     return NULL;
 587 }
 588
 589 /* Parses 'arg' as the argument to action 'code', and appends such an action to
 590  * 'ofpacts'.
 591  *
 592  * Returns NULL if successful, otherwise a malloc()'d string describing the
 593  * error.  The caller is responsible for freeing the returned string. */
 594 static char * WARN_UNUSED_RESULT
 595 parse_named_action(enum ofputil_action_code code,
 596                    char *arg, struct ofpbuf *ofpacts)
 597 {
 598     size_t orig_size = ofpacts->size;
 599     struct ofpact_tunnel *tunnel;
 600     char *error = NULL;
 601     uint16_t ethertype = 0;
 602     uint16_t vid = 0;
 603     uint8_t tos = 0;
 604     uint8_t pcp = 0;
 605
 606     switch (code) {
 607     case OFPUTIL_ACTION_INVALID:
 608         NOT_REACHED();
 609
 610     case OFPUTIL_OFPAT10_OUTPUT:
 611     case OFPUTIL_OFPAT11_OUTPUT:
 612         error = parse_output(arg, ofpacts);
 613         break;
 614
 615     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 616     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 617         error = str_to_u16(arg, "VLAN VID", &vid);
 618         if (error) {
 619             return error;
 620         }
 621
 622         if (vid & ~VLAN_VID_MASK) {
 623             return xasprintf("%s: not a valid VLAN VID", arg);
 624         }
 625         ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
 626         break;
 627
 628     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 629     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 630         error = str_to_u8(arg, "VLAN PCP", &pcp);
 631         if (error) {
 632             return error;
 633         }
 634
 635         if (pcp & ~7) {
 636             return xasprintf("%s: not a valid VLAN PCP", arg);
 637         }
 638         ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
 639         break;
 640
 641     case OFPUTIL_OFPAT12_SET_FIELD:
 642         return set_field_parse(arg, ofpacts);
 643
 644     case OFPUTIL_OFPAT10_STRIP_VLAN:
 645     case OFPUTIL_OFPAT11_POP_VLAN:
 646         ofpact_put_STRIP_VLAN(ofpacts);
 647         break;
 648
 649     case OFPUTIL_OFPAT11_PUSH_VLAN:
 650         error = str_to_u16(arg, "ethertype", &ethertype);
 651         if (error) {
 652             return error;
 653         }
 654
 655         if (ethertype != ETH_TYPE_VLAN_8021Q) {
 656             /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
 657             return xasprintf("%s: not a valid VLAN ethertype", arg);
 658         }
 659
 660         ofpact_put_PUSH_VLAN(ofpacts);
 661         break;
 662
 663     case OFPUTIL_OFPAT11_SET_QUEUE:
 664         error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
 665         break;
 666
 667     case OFPUTIL_OFPAT10_SET_DL_SRC:
 668     case OFPUTIL_OFPAT11_SET_DL_SRC:
 669         error = str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
 670         break;
 671
 672     case OFPUTIL_OFPAT10_SET_DL_DST:
 673     case OFPUTIL_OFPAT11_SET_DL_DST:
 674         error = str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
 675         break;
 676
 677     case OFPUTIL_OFPAT10_SET_NW_SRC:
 678     case OFPUTIL_OFPAT11_SET_NW_SRC:
 679         error = str_to_ip(arg, &ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4);
 680         break;
 681
 682     case OFPUTIL_OFPAT10_SET_NW_DST:
 683     case OFPUTIL_OFPAT11_SET_NW_DST:
 684         error = str_to_ip(arg, &ofpact_put_SET_IPV4_DST(ofpacts)->ipv4);
 685         break;
 686
 687     case OFPUTIL_OFPAT10_SET_NW_TOS:
 688     case OFPUTIL_OFPAT11_SET_NW_TOS:
 689         error = str_to_u8(arg, "TOS", &tos);
 690         if (error) {
 691             return error;
 692         }
 693
 694         if (tos & ~IP_DSCP_MASK) {
 695             return xasprintf("%s: not a valid TOS", arg);
 696         }
 697         ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
 698         break;
 699
 700     case OFPUTIL_OFPAT11_DEC_NW_TTL:
 701         NOT_REACHED();
 702
 703     case OFPUTIL_OFPAT10_SET_TP_SRC:
 704     case OFPUTIL_OFPAT11_SET_TP_SRC:
 705         error = str_to_u16(arg, "source port",
 706                            &ofpact_put_SET_L4_SRC_PORT(ofpacts)->port);
 707         break;
 708
 709     case OFPUTIL_OFPAT10_SET_TP_DST:
 710     case OFPUTIL_OFPAT11_SET_TP_DST:
 711         error = str_to_u16(arg, "destination port",
 712                            &ofpact_put_SET_L4_DST_PORT(ofpacts)->port);
 713         break;
 714
 715     case OFPUTIL_OFPAT10_ENQUEUE:
 716         error = parse_enqueue(arg, ofpacts);
 717         break;
 718
 719     case OFPUTIL_NXAST_RESUBMIT:
 720         error = parse_resubmit(arg, ofpacts);
 721         break;
 722
 723     case OFPUTIL_NXAST_SET_TUNNEL:
 724     case OFPUTIL_NXAST_SET_TUNNEL64:
 725         tunnel = ofpact_put_SET_TUNNEL(ofpacts);
 726         tunnel->ofpact.compat = code;
 727         error = str_to_u64(arg, &tunnel->tun_id);
 728         break;
 729
 730     case OFPUTIL_NXAST_WRITE_METADATA:
 731         error = parse_metadata(ofpacts, arg);
 732         break;
 733
 734     case OFPUTIL_NXAST_SET_QUEUE:
 735         error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
 736         break;
 737
 738     case OFPUTIL_NXAST_POP_QUEUE:
 739         ofpact_put_POP_QUEUE(ofpacts);
 740         break;
 741
 742     case OFPUTIL_NXAST_REG_MOVE:
 743         error = nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
 744         break;
 745
 746     case OFPUTIL_NXAST_REG_LOAD:
 747         error = nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
 748         break;
 749
 750     case OFPUTIL_NXAST_NOTE:
 751         error = parse_note(arg, ofpacts);
 752         break;
 753
 754     case OFPUTIL_NXAST_MULTIPATH:
 755         error = multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
 756         break;
 757
 758     case OFPUTIL_NXAST_BUNDLE:
 759         error = bundle_parse(arg, ofpacts);
 760         break;
 761
 762     case OFPUTIL_NXAST_BUNDLE_LOAD:
 763         error = bundle_parse_load(arg, ofpacts);
 764         break;
 765
 766     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 767     case OFPUTIL_NXAST_OUTPUT_REG:
 768     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 769         NOT_REACHED();
 770
 771     case OFPUTIL_NXAST_LEARN:
 772         error = learn_parse(arg, ofpacts);
 773         break;
 774
 775     case OFPUTIL_NXAST_EXIT:
 776         ofpact_put_EXIT(ofpacts);
 777         break;
 778
 779     case OFPUTIL_NXAST_DEC_TTL:
 780         error = parse_dec_ttl(ofpacts, arg);
 781         break;
 782
 783     case OFPUTIL_NXAST_SET_MPLS_TTL:
 784     case OFPUTIL_OFPAT11_SET_MPLS_TTL:
 785         error = parse_set_mpls_ttl(ofpacts, arg);
 786         break;
 787
 788     case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
 789     case OFPUTIL_NXAST_DEC_MPLS_TTL:
 790         ofpact_put_DEC_MPLS_TTL(ofpacts);
 791         break;
 792
 793     case OFPUTIL_NXAST_FIN_TIMEOUT:
 794         error = parse_fin_timeout(ofpacts, arg);
 795         break;
 796
 797     case OFPUTIL_NXAST_CONTROLLER:
 798         error = parse_controller(ofpacts, arg);
 799         break;
 800
 801     case OFPUTIL_OFPAT11_PUSH_MPLS:
 802     case OFPUTIL_NXAST_PUSH_MPLS:
 803         error = str_to_u16(arg, "push_mpls", &ethertype);
 804         if (!error) {
 805             ofpact_put_PUSH_MPLS(ofpacts)->ethertype = htons(ethertype);
 806         }
 807         break;
 808
 809     case OFPUTIL_OFPAT11_POP_MPLS:
 810     case OFPUTIL_NXAST_POP_MPLS:
 811         error = str_to_u16(arg, "pop_mpls", &ethertype);
 812         if (!error) {
 813             ofpact_put_POP_MPLS(ofpacts)->ethertype = htons(ethertype);
 814         }
 815         break;
 816
 817     case OFPUTIL_NXAST_STACK_PUSH:
 818         error = nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts), arg);
 819         break;
 820     case OFPUTIL_NXAST_STACK_POP:
 821         error = nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts), arg);
 822         break;
 823
 824     case OFPUTIL_NXAST_SAMPLE:
 825         error = parse_sample(ofpacts, arg);
 826         break;
 827     }
 828
 829     if (error) {
 830         ofpacts->size = orig_size;
 831     }
 832     return error;
 833 }
 834
 835 /* Parses action 'act', with argument 'arg', and appends a parsed version to
 836  * 'ofpacts'.
 837  *
 838  * 'n_actions' specifies the number of actions already parsed (for proper
 839  * handling of "drop" actions).
 840  *
 841  * Returns NULL if successful, otherwise a malloc()'d string describing the
 842  * error.  The caller is responsible for freeing the returned string. */
 843 static char * WARN_UNUSED_RESULT
 844 str_to_ofpact__(char *pos, char *act, char *arg,
 845                 struct ofpbuf *ofpacts, int n_actions)
 846 {
 847     int code = ofputil_action_code_from_name(act);
 848     if (code >= 0) {
 849         return parse_named_action(code, arg, ofpacts);
 850     } else if (!strcasecmp(act, "drop")) {
 851         if (n_actions) {
 852             return xstrdup("Drop actions must not be preceded by other "
 853                            "actions");
 854         } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
 855             return xstrdup("Drop actions must not be followed by other "
 856                            "actions");
 857         }
 858     } else {
 859         ofp_port_t port;
 860         if (ofputil_port_from_string(act, &port)) {
 861             ofpact_put_OUTPUT(ofpacts)->port = port;
 862         } else {
 863             return xasprintf("Unknown action: %s", act);
 864         }
 865     }
 866
 867     return NULL;
 868 }
 869
 870 /* Parses 'str' as a series of actions, and appends them to 'ofpacts'.
 871  *
 872  * Returns NULL if successful, otherwise a malloc()'d string describing the
 873  * error.  The caller is responsible for freeing the returned string. */
 874 static char * WARN_UNUSED_RESULT
 875 str_to_ofpacts(char *str, struct ofpbuf *ofpacts)
 876 {
 877     size_t orig_size = ofpacts->size;
 878     char *pos, *act, *arg;
 879     enum ofperr error;
 880     int n_actions;
 881
 882     pos = str;
 883     n_actions = 0;
 884     while (ofputil_parse_key_value(&pos, &act, &arg)) {
 885         char *error = str_to_ofpact__(pos, act, arg, ofpacts, n_actions);
 886         if (error) {
 887             ofpacts->size = orig_size;
 888             return error;
 889         }
 890         n_actions++;
 891     }
 892
 893     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 894     if (error) {
 895         ofpacts->size = orig_size;
 896         return xstrdup("Incorrect action ordering");
 897     }
 898
 899     ofpact_pad(ofpacts);
 900     return NULL;
 901 }
 902
 903 /* Parses 'arg' as the argument to instruction 'type', and appends such an
 904  * instruction to 'ofpacts'.
 905  *
 906  * Returns NULL if successful, otherwise a malloc()'d string describing the
 907  * error.  The caller is responsible for freeing the returned string. */
 908 static char * WARN_UNUSED_RESULT
 909 parse_named_instruction(enum ovs_instruction_type type,
 910                         char *arg, struct ofpbuf *ofpacts)
 911 {
 912     char *error_s = NULL;
 913     enum ofperr error;
 914
 915     switch (type) {
 916     case OVSINST_OFPIT11_APPLY_ACTIONS:
 917         NOT_REACHED();  /* This case is handled by str_to_inst_ofpacts() */
 918         break;
 919
 920     case OVSINST_OFPIT11_WRITE_ACTIONS:
 921         /* XXX */
 922         error_s = xstrdup("instruction write-actions is not supported yet");
 923         break;
 924
 925     case OVSINST_OFPIT11_CLEAR_ACTIONS:
 926         ofpact_put_CLEAR_ACTIONS(ofpacts);
 927         break;
 928
 929     case OVSINST_OFPIT13_METER:
 930         error_s = str_to_u32(arg, &ofpact_put_METER(ofpacts)->meter_id);
 931         break;
 932
 933     case OVSINST_OFPIT11_WRITE_METADATA:
 934         error_s = parse_metadata(ofpacts, arg);
 935         break;
 936
 937     case OVSINST_OFPIT11_GOTO_TABLE: {
 938         struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
 939         char *table_s = strsep(&arg, ",");
 940         if (!table_s || !table_s[0]) {
 941             return xstrdup("instruction goto-table needs table id");
 942         }
 943         error_s = str_to_u8(table_s, "table", &ogt->table_id);
 944         break;
 945     }
 946     }
 947
 948     if (error_s) {
 949         return error_s;
 950     }
 951
 952     /* If write_metadata is specified as an action AND an instruction, ofpacts
 953        could be invalid. */
 954     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 955     if (error) {
 956         return xstrdup("Incorrect instruction ordering");
 957     }
 958     return NULL;
 959 }
 960
 961 /* Parses 'str' as a series of instructions, and appends them to 'ofpacts'.
 962  *
 963  * Returns NULL if successful, otherwise a malloc()'d string describing the
 964  * error.  The caller is responsible for freeing the returned string. */
 965 static char * WARN_UNUSED_RESULT
 966 str_to_inst_ofpacts(char *str, struct ofpbuf *ofpacts)
 967 {
 968     size_t orig_size = ofpacts->size;
 969     char *pos, *inst, *arg;
 970     int type;
 971     const char *prev_inst = NULL;
 972     int prev_type = -1;
 973     int n_actions = 0;
 974
 975     pos = str;
 976     while (ofputil_parse_key_value(&pos, &inst, &arg)) {
 977         type = ovs_instruction_type_from_name(inst);
 978         if (type < 0) {
 979             char *error = str_to_ofpact__(pos, inst, arg, ofpacts, n_actions);
 980             if (error) {
 981                 ofpacts->size = orig_size;
 982                 return error;
 983             }
 984
 985             type = OVSINST_OFPIT11_APPLY_ACTIONS;
 986             if (prev_type == type) {
 987                 n_actions++;
 988                 continue;
 989             }
 990         } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
 991             ofpacts->size = orig_size;
 992             return xasprintf("%s isn't supported. Just write actions then "
 993                              "it is interpreted as apply_actions", inst);
 994         } else {
 995             char *error = parse_named_instruction(type, arg, ofpacts);
 996             if (error) {
 997                 ofpacts->size = orig_size;
 998                 return error;
 999             }
1000         }
1001
1002         if (type <= prev_type) {
1003             ofpacts->size = orig_size;
1004             if (type == prev_type) {
1005                 return xasprintf("instruction %s may be specified only once",
1006                                  inst);
1007             } else {
1008                 return xasprintf("instruction %s must be specified before %s",
1009                                  inst, prev_inst);
1010             }
1011         }
1012
1013         prev_inst = inst;
1014         prev_type = type;
1015         n_actions++;
1016     }
1017     ofpact_pad(ofpacts);
1018
1019     return NULL;
1020 }
1021
1022 struct protocol {
1023     const char *name;
1024     uint16_t dl_type;
1025     uint8_t nw_proto;
1026 };
1027
1028 static bool
1029 parse_protocol(const char *name, const struct protocol **p_out)
1030 {
1031     static const struct protocol protocols[] = {
1032         { "ip", ETH_TYPE_IP, 0 },
1033         { "arp", ETH_TYPE_ARP, 0 },
1034         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
1035         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
1036         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
1037         { "ipv6", ETH_TYPE_IPV6, 0 },
1038         { "ip6", ETH_TYPE_IPV6, 0 },
1039         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
1040         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
1041         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
1042         { "rarp", ETH_TYPE_RARP, 0},
1043         { "mpls", ETH_TYPE_MPLS, 0 },
1044         { "mplsm", ETH_TYPE_MPLS_MCAST, 0 },
1045     };
1046     const struct protocol *p;
1047
1048     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
1049         if (!strcmp(p->name, name)) {
1050             *p_out = p;
1051             return true;
1052         }
1053     }
1054     *p_out = NULL;
1055     return false;
1056 }
1057
1058 /* Parses 's' as the (possibly masked) value of field 'mf', and updates
1059  * 'match' appropriately.
1060  *
1061  * Returns NULL if successful, otherwise a malloc()'d string describing the
1062  * error.  The caller is responsible for freeing the returned string. */
1063 static char * WARN_UNUSED_RESULT
1064 parse_field(const struct mf_field *mf, const char *s, struct match *match)
1065 {
1066     union mf_value value, mask;
1067     char *error;
1068
1069     error = mf_parse(mf, s, &value, &mask);
1070     if (!error) {
1071         mf_set(mf, &value, &mask, match);
1072     }
1073     return error;
1074 }
1075
1076 static char * WARN_UNUSED_RESULT
1077 parse_ofp_str__(struct ofputil_flow_mod *fm, int command, char *string)
1078 {
1079     enum {
1080         F_OUT_PORT = 1 << 0,
1081         F_ACTIONS = 1 << 1,
1082         F_TIMEOUT = 1 << 3,
1083         F_PRIORITY = 1 << 4,
1084         F_FLAGS = 1 << 5,
1085     } fields;
1086     char *save_ptr = NULL;
1087     char *act_str = NULL;
1088     char *name;
1089
1090     switch (command) {
1091     case -1:
1092         fields = F_OUT_PORT;
1093         break;
1094
1095     case OFPFC_ADD:
1096         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1097         break;
1098
1099     case OFPFC_DELETE:
1100         fields = F_OUT_PORT;
1101         break;
1102
1103     case OFPFC_DELETE_STRICT:
1104         fields = F_OUT_PORT | F_PRIORITY;
1105         break;
1106
1107     case OFPFC_MODIFY:
1108         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1109         break;
1110
1111     case OFPFC_MODIFY_STRICT:
1112         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
1113         break;
1114
1115     default:
1116         NOT_REACHED();
1117     }
1118
1119     match_init_catchall(&fm->match);
1120     fm->priority = OFP_DEFAULT_PRIORITY;
1121     fm->cookie = htonll(0);
1122     fm->cookie_mask = htonll(0);
1123     if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
1124         /* For modify, by default, don't update the cookie. */
1125         fm->new_cookie = htonll(UINT64_MAX);
1126     } else{
1127         fm->new_cookie = htonll(0);
1128     }
1129     fm->modify_cookie = false;
1130     fm->table_id = 0xff;
1131     fm->command = command;
1132     fm->idle_timeout = OFP_FLOW_PERMANENT;
1133     fm->hard_timeout = OFP_FLOW_PERMANENT;
1134     fm->buffer_id = UINT32_MAX;
1135     fm->out_port = OFPP_ANY;
1136     fm->flags = 0;
1137     if (fields & F_ACTIONS) {
1138         act_str = strstr(string, "action");
1139         if (!act_str) {
1140             return xstrdup("must specify an action");
1141         }
1142         *act_str = '\0';
1143
1144         act_str = strchr(act_str + 1, '=');
1145         if (!act_str) {
1146             return xstrdup("must specify an action");
1147         }
1148
1149         act_str++;
1150     }
1151     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1152          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1153         const struct protocol *p;
1154         char *error = NULL;
1155
1156         if (parse_protocol(name, &p)) {
1157             match_set_dl_type(&fm->match, htons(p->dl_type));
1158             if (p->nw_proto) {
1159                 match_set_nw_proto(&fm->match, p->nw_proto);
1160             }
1161         } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
1162             fm->flags |= OFPFF_SEND_FLOW_REM;
1163         } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
1164             fm->flags |= OFPFF_CHECK_OVERLAP;
1165         } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
1166             fm->flags |= OFPFF12_RESET_COUNTS;
1167         } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
1168             fm->flags |= OFPFF13_NO_PKT_COUNTS;
1169         } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
1170             fm->flags |= OFPFF13_NO_BYT_COUNTS;
1171         } else {
1172             char *value;
1173
1174             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1175             if (!value) {
1176                 return xasprintf("field %s missing value", name);
1177             }
1178
1179             if (!strcmp(name, "table")) {
1180                 error = str_to_u8(value, "table", &fm->table_id);
1181             } else if (!strcmp(name, "out_port")) {
1182                 if (!ofputil_port_from_string(value, &fm->out_port)) {
1183                     error = xasprintf("%s is not a valid OpenFlow port",
1184                                       value);
1185                 }
1186             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
1187                 uint16_t priority = 0;
1188
1189                 error = str_to_u16(value, name, &priority);
1190                 fm->priority = priority;
1191             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
1192                 error = str_to_u16(value, name, &fm->idle_timeout);
1193             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
1194                 error = str_to_u16(value, name, &fm->hard_timeout);
1195             } else if (!strcmp(name, "cookie")) {
1196                 char *mask = strchr(value, '/');
1197
1198                 if (mask) {
1199                     /* A mask means we're searching for a cookie. */
1200                     if (command == OFPFC_ADD) {
1201                         return xstrdup("flow additions cannot use "
1202                                        "a cookie mask");
1203                     }
1204                     *mask = '\0';
1205                     error = str_to_be64(value, &fm->cookie);
1206                     if (error) {
1207                         return error;
1208                     }
1209                     error = str_to_be64(mask + 1, &fm->cookie_mask);
1210                 } else {
1211                     /* No mask means that the cookie is being set. */
1212                     if (command != OFPFC_ADD && command != OFPFC_MODIFY
1213                         && command != OFPFC_MODIFY_STRICT) {
1214                         return xstrdup("cannot set cookie");
1215                     }
1216                     error = str_to_be64(value, &fm->new_cookie);
1217                     fm->modify_cookie = true;
1218                 }
1219             } else if (mf_from_name(name)) {
1220                 error = parse_field(mf_from_name(name), value, &fm->match);
1221             } else if (!strcmp(name, "duration")
1222                        || !strcmp(name, "n_packets")
1223                        || !strcmp(name, "n_bytes")
1224                        || !strcmp(name, "idle_age")
1225                        || !strcmp(name, "hard_age")) {
1226                 /* Ignore these, so that users can feed the output of
1227                  * "ovs-ofctl dump-flows" back into commands that parse
1228                  * flows. */
1229             } else {
1230                 error = xasprintf("unknown keyword %s", name);
1231             }
1232
1233             if (error) {
1234                 return error;
1235             }
1236         }
1237     }
1238     if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
1239         && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
1240         /* On modifies without a mask, we are supposed to add a flow if
1241          * one does not exist.  If a cookie wasn't been specified, use a
1242          * default of zero. */
1243         fm->new_cookie = htonll(0);
1244     }
1245     if (fields & F_ACTIONS) {
1246         struct ofpbuf ofpacts;
1247         char *error;
1248
1249         ofpbuf_init(&ofpacts, 32);
1250         error = str_to_inst_ofpacts(act_str, &ofpacts);
1251         if (!error) {
1252             enum ofperr err;
1253
1254             err = ofpacts_check(ofpacts.data, ofpacts.size, &fm->match.flow,
1255                                 OFPP_MAX, 0);
1256             if (err) {
1257                 error = xasprintf("actions are invalid with specified match "
1258                                   "(%s)", ofperr_to_string(err));
1259             }
1260         }
1261         if (error) {
1262             ofpbuf_uninit(&ofpacts);
1263             return error;
1264         }
1265
1266         fm->ofpacts_len = ofpacts.size;
1267         fm->ofpacts = ofpbuf_steal_data(&ofpacts);
1268     } else {
1269         fm->ofpacts_len = 0;
1270         fm->ofpacts = NULL;
1271     }
1272
1273     return NULL;
1274 }
1275
1276 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1277  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
1278  *
1279  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
1280  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
1281  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'.
1282  *
1283  * Returns NULL if successful, otherwise a malloc()'d string describing the
1284  * error.  The caller is responsible for freeing the returned string. */
1285 char * WARN_UNUSED_RESULT
1286 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_)
1287 {
1288     char *string = xstrdup(str_);
1289     char *error;
1290
1291     error = parse_ofp_str__(fm, command, string);
1292     if (error) {
1293         fm->ofpacts = NULL;
1294         fm->ofpacts_len = 0;
1295     }
1296
1297     free(string);
1298     return error;
1299 }
1300
1301 static char * WARN_UNUSED_RESULT
1302 parse_ofp_meter_mod_str__(struct ofputil_meter_mod *mm, char *string,
1303                           struct ofpbuf *bands, int command)
1304 {
1305     enum {
1306         F_METER = 1 << 0,
1307         F_FLAGS = 1 << 1,
1308         F_BANDS = 1 << 2,
1309     } fields;
1310     char *save_ptr = NULL;
1311     char *band_str = NULL;
1312     char *name;
1313
1314     switch (command) {
1315     case -1:
1316         fields = F_METER;
1317         break;
1318
1319     case OFPMC13_ADD:
1320         fields = F_METER | F_FLAGS | F_BANDS;
1321         break;
1322
1323     case OFPMC13_DELETE:
1324         fields = F_METER;
1325         break;
1326
1327     case OFPMC13_MODIFY:
1328         fields = F_METER | F_FLAGS | F_BANDS;
1329         break;
1330
1331     default:
1332         NOT_REACHED();
1333     }
1334
1335     mm->command = command;
1336     mm->meter.meter_id = 0;
1337     mm->meter.flags = 0;
1338     if (fields & F_BANDS) {
1339         band_str = strstr(string, "band");
1340         if (!band_str) {
1341             return xstrdup("must specify bands");
1342         }
1343         *band_str = '\0';
1344
1345         band_str = strchr(band_str + 1, '=');
1346         if (!band_str) {
1347             return xstrdup("must specify bands");
1348         }
1349
1350         band_str++;
1351     }
1352     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1353          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1354
1355         if (fields & F_FLAGS && !strcmp(name, "kbps")) {
1356             mm->meter.flags |= OFPMF13_KBPS;
1357         } else if (fields & F_FLAGS && !strcmp(name, "pktps")) {
1358             mm->meter.flags |= OFPMF13_PKTPS;
1359         } else if (fields & F_FLAGS && !strcmp(name, "burst")) {
1360             mm->meter.flags |= OFPMF13_BURST;
1361         } else if (fields & F_FLAGS && !strcmp(name, "stats")) {
1362             mm->meter.flags |= OFPMF13_STATS;
1363         } else {
1364             char *value;
1365
1366             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1367             if (!value) {
1368                 return xasprintf("field %s missing value", name);
1369             }
1370
1371             if (!strcmp(name, "meter")) {
1372                 if (!strcmp(value, "all")) {
1373                     mm->meter.meter_id = OFPM13_ALL;
1374                 } else if (!strcmp(value, "controller")) {
1375                     mm->meter.meter_id = OFPM13_CONTROLLER;
1376                 } else if (!strcmp(value, "slowpath")) {
1377                     mm->meter.meter_id = OFPM13_SLOWPATH;
1378                 } else {
1379                     char *error = str_to_u32(value, &mm->meter.meter_id);
1380                     if (error) {
1381                         return error;
1382                     }
1383                     if (mm->meter.meter_id > OFPM13_MAX) {
1384                         return xasprintf("invalid value for %s", name);
1385                     }
1386                 }
1387             } else {
1388                 return xasprintf("unknown keyword %s", name);
1389             }
1390         }
1391     }
1392     if (fields & F_METER && !mm->meter.meter_id) {
1393         return xstrdup("must specify 'meter'");
1394     }
1395     if (fields & F_FLAGS && !mm->meter.flags) {
1396         return xstrdup("meter must specify either 'kbps' or 'pktps'");
1397     }
1398
1399     if (fields & F_BANDS) {
1400         uint16_t n_bands = 0;
1401         struct ofputil_meter_band *band = NULL;
1402         int i;
1403
1404         for (name = strtok_r(band_str, "=, \t\r\n", &save_ptr); name;
1405              name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1406
1407             char *value;
1408
1409             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1410             if (!value) {
1411                 return xasprintf("field %s missing value", name);
1412             }
1413
1414             if (!strcmp(name, "type")) {
1415                 /* Start a new band */
1416                 band = ofpbuf_put_zeros(bands, sizeof *band);
1417                 n_bands++;
1418
1419                 if (!strcmp(value, "drop")) {
1420                     band->type = OFPMBT13_DROP;
1421                 } else if (!strcmp(value, "dscp_remark")) {
1422                     band->type = OFPMBT13_DSCP_REMARK;
1423                 } else {
1424                     return xasprintf("field %s unknown value %s", name, value);
1425                 }
1426             } else if (!band || !band->type) {
1427                 return xstrdup("band must start with the 'type' keyword");
1428             } else if (!strcmp(name, "rate")) {
1429                 char *error = str_to_u32(value, &band->rate);
1430                 if (error) {
1431                     return error;
1432                 }
1433             } else if (!strcmp(name, "burst_size")) {
1434                 char *error = str_to_u32(value, &band->burst_size);
1435                 if (error) {
1436                     return error;
1437                 }
1438             } else if (!strcmp(name, "prec_level")) {
1439                 char *error = str_to_u8(value, name, &band->prec_level);
1440                 if (error) {
1441                     return error;
1442                 }
1443             } else {
1444                 return xasprintf("unknown keyword %s", name);
1445             }
1446         }
1447         /* validate bands */
1448         if (!n_bands) {
1449             return xstrdup("meter must have bands");
1450         }
1451
1452         mm->meter.n_bands = n_bands;
1453         mm->meter.bands = ofpbuf_steal_data(bands);
1454
1455         for (i = 0; i < n_bands; ++i) {
1456             band = &mm->meter.bands[i];
1457
1458             if (!band->type) {
1459                 return xstrdup("band must have 'type'");
1460             }
1461             if (band->type == OFPMBT13_DSCP_REMARK) {
1462                 if (!band->prec_level) {
1463                     return xstrdup("'dscp_remark' band must have"
1464                                    " 'prec_level'");
1465                 }
1466             } else {
1467                 if (band->prec_level) {
1468                     return xstrdup("Only 'dscp_remark' band may have"
1469                                    " 'prec_level'");
1470                 }
1471             }
1472             if (!band->rate) {
1473                 return xstrdup("band must have 'rate'");
1474             }
1475             if (mm->meter.flags & OFPMF13_BURST) {
1476                 if (!band->burst_size) {
1477                     return xstrdup("band must have 'burst_size' "
1478                                    "when 'burst' flag is set");
1479                 }
1480             } else {
1481                 if (band->burst_size) {
1482                     return xstrdup("band may have 'burst_size' only "
1483                                    "when 'burst' flag is set");
1484                 }
1485             }
1486         }
1487     } else {
1488         mm->meter.n_bands = 0;
1489         mm->meter.bands = NULL;
1490     }
1491
1492     return NULL;
1493 }
1494
1495 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1496  * page) into 'mm' for sending the specified meter_mod 'command' to a switch.
1497  *
1498  * Returns NULL if successful, otherwise a malloc()'d string describing the
1499  * error.  The caller is responsible for freeing the returned string. */
1500 char * WARN_UNUSED_RESULT
1501 parse_ofp_meter_mod_str(struct ofputil_meter_mod *mm, const char *str_,
1502                         int command)
1503 {
1504     struct ofpbuf bands;
1505     char *string;
1506     char *error;
1507
1508     ofpbuf_init(&bands, 64);
1509     string = xstrdup(str_);
1510
1511     error = parse_ofp_meter_mod_str__(mm, string, &bands, command);
1512
1513     free(string);
1514     ofpbuf_uninit(&bands);
1515
1516     return error;
1517 }
1518
1519 static char * WARN_UNUSED_RESULT
1520 parse_flow_monitor_request__(struct ofputil_flow_monitor_request *fmr,
1521                              const char *str_, char *string)
1522 {
1523     static atomic_uint32_t id = ATOMIC_VAR_INIT(0);
1524     char *save_ptr = NULL;
1525     char *name;
1526
1527     atomic_add(&id, 1, &fmr->id);
1528
1529     fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
1530                   | NXFMF_OWN | NXFMF_ACTIONS);
1531     fmr->out_port = OFPP_NONE;
1532     fmr->table_id = 0xff;
1533     match_init_catchall(&fmr->match);
1534
1535     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1536          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1537         const struct protocol *p;
1538
1539         if (!strcmp(name, "!initial")) {
1540             fmr->flags &= ~NXFMF_INITIAL;
1541         } else if (!strcmp(name, "!add")) {
1542             fmr->flags &= ~NXFMF_ADD;
1543         } else if (!strcmp(name, "!delete")) {
1544             fmr->flags &= ~NXFMF_DELETE;
1545         } else if (!strcmp(name, "!modify")) {
1546             fmr->flags &= ~NXFMF_MODIFY;
1547         } else if (!strcmp(name, "!actions")) {
1548             fmr->flags &= ~NXFMF_ACTIONS;
1549         } else if (!strcmp(name, "!own")) {
1550             fmr->flags &= ~NXFMF_OWN;
1551         } else if (parse_protocol(name, &p)) {
1552             match_set_dl_type(&fmr->match, htons(p->dl_type));
1553             if (p->nw_proto) {
1554                 match_set_nw_proto(&fmr->match, p->nw_proto);
1555             }
1556         } else {
1557             char *value;
1558
1559             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1560             if (!value) {
1561                 return xasprintf("%s: field %s missing value", str_, name);
1562             }
1563
1564             if (!strcmp(name, "table")) {
1565                 char *error = str_to_u8(value, "table", &fmr->table_id);
1566                 if (error) {
1567                     return error;
1568                 }
1569             } else if (!strcmp(name, "out_port")) {
1570                 fmr->out_port = u16_to_ofp(atoi(value));
1571             } else if (mf_from_name(name)) {
1572                 char *error;
1573
1574                 error = parse_field(mf_from_name(name), value, &fmr->match);
1575                 if (error) {
1576                     return error;
1577                 }
1578             } else {
1579                 return xasprintf("%s: unknown keyword %s", str_, name);
1580             }
1581         }
1582     }
1583     return NULL;
1584 }
1585
1586 /* Convert 'str_' (as described in the documentation for the "monitor" command
1587  * in the ovs-ofctl man page) into 'fmr'.
1588  *
1589  * Returns NULL if successful, otherwise a malloc()'d string describing the
1590  * error.  The caller is responsible for freeing the returned string. */
1591 char * WARN_UNUSED_RESULT
1592 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
1593                            const char *str_)
1594 {
1595     char *string = xstrdup(str_);
1596     char *error = parse_flow_monitor_request__(fmr, str_, string);
1597     free(string);
1598     return error;
1599 }
1600
1601 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1602  * 'actions'.
1603  *
1604  * Returns NULL if successful, otherwise a malloc()'d string describing the
1605  * error.  The caller is responsible for freeing the returned string. */
1606 char * WARN_UNUSED_RESULT
1607 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
1608 {
1609     char *s = xstrdup(s_);
1610     char *error = str_to_ofpacts(s, ofpacts);
1611     free(s);
1612
1613     return error;
1614 }
1615
1616 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1617  * (one of OFPFC_*) into 'fm'.
1618  *
1619  * Returns NULL if successful, otherwise a malloc()'d string describing the
1620  * error.  The caller is responsible for freeing the returned string. */
1621 char * WARN_UNUSED_RESULT
1622 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1623                        uint16_t command)
1624 {
1625     char *error = parse_ofp_str(fm, command, string);
1626     if (!error) {
1627         /* Normalize a copy of the match.  This ensures that non-normalized
1628          * flows get logged but doesn't affect what gets sent to the switch, so
1629          * that the switch can do whatever it likes with the flow. */
1630         struct match match_copy = fm->match;
1631         ofputil_normalize_match(&match_copy);
1632     }
1633
1634     return error;
1635 }
1636
1637 /* Opens file 'file_name' and reads each line as a flow_mod of the specified
1638  * type (one of OFPFC_*).  Stores each flow_mod in '*fm', an array allocated
1639  * on the caller's behalf, and the number of flow_mods in '*n_fms'.
1640  *
1641  * Returns NULL if successful, otherwise a malloc()'d string describing the
1642  * error.  The caller is responsible for freeing the returned string. */
1643 char * WARN_UNUSED_RESULT
1644 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1645                         struct ofputil_flow_mod **fms, size_t *n_fms)
1646 {
1647     size_t allocated_fms;
1648     int line_number;
1649     FILE *stream;
1650     struct ds s;
1651
1652     *fms = NULL;
1653     *n_fms = 0;
1654
1655     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1656     if (stream == NULL) {
1657         return xasprintf("%s: open failed (%s)",
1658                          file_name, ovs_strerror(errno));
1659     }
1660
1661     allocated_fms = *n_fms;
1662     ds_init(&s);
1663     line_number = 0;
1664     while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
1665         char *error;
1666
1667         if (*n_fms >= allocated_fms) {
1668             *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1669         }
1670         error = parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command);
1671         if (error) {
1672             size_t i;
1673
1674             for (i = 0; i < *n_fms; i++) {
1675                 free((*fms)[i].ofpacts);
1676             }
1677             free(*fms);
1678             *fms = NULL;
1679             *n_fms = 0;
1680
1681             ds_destroy(&s);
1682             if (stream != stdin) {
1683                 fclose(stream);
1684             }
1685
1686             return xasprintf("%s:%d: %s", file_name, line_number, error);
1687         }
1688         *n_fms += 1;
1689     }
1690
1691     ds_destroy(&s);
1692     if (stream != stdin) {
1693         fclose(stream);
1694     }
1695     return NULL;
1696 }
1697
1698 char * WARN_UNUSED_RESULT
1699 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1700                                  bool aggregate, const char *string)
1701 {
1702     struct ofputil_flow_mod fm;
1703     char *error;
1704
1705     error = parse_ofp_str(&fm, -1, string);
1706     if (error) {
1707         return error;
1708     }
1709
1710     fsr->aggregate = aggregate;
1711     fsr->cookie = fm.cookie;
1712     fsr->cookie_mask = fm.cookie_mask;
1713     fsr->match = fm.match;
1714     fsr->out_port = fm.out_port;
1715     fsr->table_id = fm.table_id;
1716     return NULL;
1717 }
1718
1719 /* Parses a specification of a flow from 's' into 'flow'.  's' must take the
1720  * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1721  * mf_field.  Fields must be specified in a natural order for satisfying
1722  * prerequisites.
1723  *
1724  * Returns NULL on success, otherwise a malloc()'d string that explains the
1725  * problem. */
1726 char *
1727 parse_ofp_exact_flow(struct flow *flow, const char *s)
1728 {
1729     char *pos, *key, *value_s;
1730     char *error = NULL;
1731     char *copy;
1732
1733     memset(flow, 0, sizeof *flow);
1734
1735     pos = copy = xstrdup(s);
1736     while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1737         const struct protocol *p;
1738         if (parse_protocol(key, &p)) {
1739             if (flow->dl_type) {
1740                 error = xasprintf("%s: Ethernet type set multiple times", s);
1741                 goto exit;
1742             }
1743             flow->dl_type = htons(p->dl_type);
1744
1745             if (p->nw_proto) {
1746                 if (flow->nw_proto) {
1747                     error = xasprintf("%s: network protocol set "
1748                                       "multiple times", s);
1749                     goto exit;
1750                 }
1751                 flow->nw_proto = p->nw_proto;
1752             }
1753         } else {
1754             const struct mf_field *mf;
1755             union mf_value value;
1756             char *field_error;
1757
1758             mf = mf_from_name(key);
1759             if (!mf) {
1760                 error = xasprintf("%s: unknown field %s", s, key);
1761                 goto exit;
1762             }
1763
1764             if (!mf_are_prereqs_ok(mf, flow)) {
1765                 error = xasprintf("%s: prerequisites not met for setting %s",
1766                                   s, key);
1767                 goto exit;
1768             }
1769
1770             if (!mf_is_zero(mf, flow)) {
1771                 error = xasprintf("%s: field %s set multiple times", s, key);
1772                 goto exit;
1773             }
1774
1775             field_error = mf_parse_value(mf, value_s, &value);
1776             if (field_error) {
1777                 error = xasprintf("%s: bad value for %s (%s)",
1778                                   s, key, field_error);
1779                 free(field_error);
1780                 goto exit;
1781             }
1782
1783             mf_set_flow_value(mf, &value, flow);
1784         }
1785     }
1786
1787     if (!flow->in_port.ofp_port) {
1788         flow->in_port.ofp_port = OFPP_NONE;
1789     }
1790
1791 exit:
1792     free(copy);
1793
1794     if (error) {
1795         memset(flow, 0, sizeof *flow);
1796     }
1797     return error;
1798 }