lib/ofp-parse.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012 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 "autopath.h"
  26 #include "bundle.h"
  27 #include "byte-order.h"
  28 #include "dynamic-string.h"
  29 #include "learn.h"
  30 #include "meta-flow.h"
  31 #include "multipath.h"
  32 #include "netdev.h"
  33 #include "nx-match.h"
  34 #include "ofp-actions.h"
  35 #include "ofp-util.h"
  36 #include "ofpbuf.h"
  37 #include "openflow/openflow.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 static void ofp_fatal(const char *flow, bool verbose, const char *format, ...)
  46     NO_RETURN;
  47
  48 static uint8_t
  49 str_to_table_id(const char *str)
  50 {
  51     int table_id;
  52
  53     if (!str_to_int(str, 10, &table_id) || table_id < 0 || table_id > 255) {
  54         ovs_fatal(0, "invalid table \"%s\"", str);
  55     }
  56     return table_id;
  57 }
  58
  59 static uint16_t
  60 str_to_u16(const char *str, const char *name)
  61 {
  62     int value;
  63
  64     if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
  65         ovs_fatal(0, "invalid %s \"%s\"", name, str);
  66     }
  67     return value;
  68 }
  69
  70 static uint32_t
  71 str_to_u32(const char *str)
  72 {
  73     char *tail;
  74     uint32_t value;
  75
  76     if (!str[0]) {
  77         ovs_fatal(0, "missing required numeric argument");
  78     }
  79
  80     errno = 0;
  81     value = strtoul(str, &tail, 0);
  82     if (errno == EINVAL || errno == ERANGE || *tail) {
  83         ovs_fatal(0, "invalid numeric format %s", str);
  84     }
  85     return value;
  86 }
  87
  88 static uint64_t
  89 str_to_u64(const char *str)
  90 {
  91     char *tail;
  92     uint64_t value;
  93
  94     if (!str[0]) {
  95         ovs_fatal(0, "missing required numeric argument");
  96     }
  97
  98     errno = 0;
  99     value = strtoull(str, &tail, 0);
 100     if (errno == EINVAL || errno == ERANGE || *tail) {
 101         ovs_fatal(0, "invalid numeric format %s", str);
 102     }
 103     return value;
 104 }
 105
 106 static void
 107 str_to_mac(const char *str, uint8_t mac[6])
 108 {
 109     if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
 110         != ETH_ADDR_SCAN_COUNT) {
 111         ovs_fatal(0, "invalid mac address %s", str);
 112     }
 113 }
 114
 115 static void
 116 str_to_ip(const char *str, ovs_be32 *ip)
 117 {
 118     struct in_addr in_addr;
 119
 120     if (lookup_ip(str, &in_addr)) {
 121         ovs_fatal(0, "%s: could not convert to IP address", str);
 122     }
 123     *ip = in_addr.s_addr;
 124 }
 125
 126 static void
 127 parse_enqueue(char *arg, struct ofpbuf *ofpacts)
 128 {
 129     char *sp = NULL;
 130     char *port = strtok_r(arg, ":q", &sp);
 131     char *queue = strtok_r(NULL, "", &sp);
 132     struct ofpact_enqueue *enqueue;
 133
 134     if (port == NULL || queue == NULL) {
 135         ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
 136     }
 137
 138     enqueue = ofpact_put_ENQUEUE(ofpacts);
 139     enqueue->port = str_to_u32(port);
 140     enqueue->queue = str_to_u32(queue);
 141 }
 142
 143 static void
 144 parse_output(char *arg, struct ofpbuf *ofpacts)
 145 {
 146     if (strchr(arg, '[')) {
 147         struct ofpact_output_reg *output_reg;
 148
 149         output_reg = ofpact_put_OUTPUT_REG(ofpacts);
 150         mf_parse_subfield(&output_reg->src, arg);
 151         output_reg->max_len = UINT16_MAX;
 152     } else {
 153         struct ofpact_output *output;
 154
 155         output = ofpact_put_OUTPUT(ofpacts);
 156         output->port = str_to_u32(arg);
 157         output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
 158     }
 159 }
 160
 161 static void
 162 parse_resubmit(char *arg, struct ofpbuf *ofpacts)
 163 {
 164     struct ofpact_resubmit *resubmit;
 165     char *in_port_s, *table_s;
 166
 167     resubmit = ofpact_put_RESUBMIT(ofpacts);
 168
 169     in_port_s = strsep(&arg, ",");
 170     if (in_port_s && in_port_s[0]) {
 171         if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
 172             ovs_fatal(0, "%s: resubmit to unknown port", in_port_s);
 173         }
 174     } else {
 175         resubmit->in_port = OFPP_IN_PORT;
 176     }
 177
 178     table_s = strsep(&arg, ",");
 179     resubmit->table_id = table_s && table_s[0] ? str_to_u32(table_s) : 255;
 180
 181     if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
 182         ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
 183                   " on resubmit");
 184     }
 185 }
 186
 187 static void
 188 parse_note(const char *arg, struct ofpbuf *ofpacts)
 189 {
 190     struct ofpact_note *note;
 191
 192     note = ofpact_put_NOTE(ofpacts);
 193     while (*arg != '\0') {
 194         uint8_t byte;
 195         bool ok;
 196
 197         if (*arg == '.') {
 198             arg++;
 199         }
 200         if (*arg == '\0') {
 201             break;
 202         }
 203
 204         byte = hexits_value(arg, 2, &ok);
 205         if (!ok) {
 206             ovs_fatal(0, "bad hex digit in `note' argument");
 207         }
 208         ofpbuf_put(ofpacts, &byte, 1);
 209
 210         note = ofpacts->l2;
 211         note->length++;
 212
 213         arg += 2;
 214     }
 215     ofpact_update_len(ofpacts, &note->ofpact);
 216 }
 217
 218 static void
 219 parse_fin_timeout(struct ofpbuf *b, char *arg)
 220 {
 221     struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
 222     char *key, *value;
 223
 224     while (ofputil_parse_key_value(&arg, &key, &value)) {
 225         if (!strcmp(key, "idle_timeout")) {
 226             oft->fin_idle_timeout = str_to_u16(value, key);
 227         } else if (!strcmp(key, "hard_timeout")) {
 228             oft->fin_hard_timeout = str_to_u16(value, key);
 229         } else {
 230             ovs_fatal(0, "invalid key '%s' in 'fin_timeout' argument", key);
 231         }
 232     }
 233 }
 234
 235 static void
 236 parse_controller(struct ofpbuf *b, char *arg)
 237 {
 238     enum ofp_packet_in_reason reason = OFPR_ACTION;
 239     uint16_t controller_id = 0;
 240     uint16_t max_len = UINT16_MAX;
 241
 242     if (!arg[0]) {
 243         /* Use defaults. */
 244     } else if (strspn(arg, "0123456789") == strlen(arg)) {
 245         max_len = str_to_u16(arg, "max_len");
 246     } else {
 247         char *name, *value;
 248
 249         while (ofputil_parse_key_value(&arg, &name, &value)) {
 250             if (!strcmp(name, "reason")) {
 251                 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
 252                     ovs_fatal(0, "unknown reason \"%s\"", value);
 253                 }
 254             } else if (!strcmp(name, "max_len")) {
 255                 max_len = str_to_u16(value, "max_len");
 256             } else if (!strcmp(name, "id")) {
 257                 controller_id = str_to_u16(value, "id");
 258             } else {
 259                 ovs_fatal(0, "unknown key \"%s\" parsing controller action",
 260                           name);
 261             }
 262         }
 263     }
 264
 265     if (reason == OFPR_ACTION && controller_id == 0) {
 266         struct ofpact_output *output;
 267
 268         output = ofpact_put_OUTPUT(b);
 269         output->port = OFPP_CONTROLLER;
 270         output->max_len = max_len;
 271     } else {
 272         struct ofpact_controller *controller;
 273
 274         controller = ofpact_put_CONTROLLER(b);
 275         controller->max_len = max_len;
 276         controller->reason = reason;
 277         controller->controller_id = controller_id;
 278     }
 279 }
 280
 281 static void
 282 parse_noargs_dec_ttl(struct ofpbuf *b)
 283 {
 284     struct ofpact_cnt_ids *ids;
 285     uint16_t id = 0;
 286
 287     ids = ofpact_put_DEC_TTL(b);
 288     ofpbuf_put(b, &id, sizeof id);
 289     ids = b->l2;
 290     ids->n_controllers++;
 291     ofpact_update_len(b, &ids->ofpact);
 292 }
 293
 294 static void
 295 parse_dec_ttl(struct ofpbuf *b, char *arg)
 296 {
 297     if (*arg == '\0') {
 298         parse_noargs_dec_ttl(b);
 299     } else {
 300         struct ofpact_cnt_ids *ids;
 301         char *cntr;
 302
 303         ids = ofpact_put_DEC_TTL(b);
 304         ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
 305         for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
 306              cntr = strtok_r(NULL, ", ", &arg)) {
 307             uint16_t id = atoi(cntr);
 308
 309             ofpbuf_put(b, &id, sizeof id);
 310             ids = b->l2;
 311             ids->n_controllers++;
 312         }
 313         if (!ids->n_controllers) {
 314             ovs_fatal(0, "dec_ttl_cnt_ids: expected at least one controller "
 315                       "id.");
 316         }
 317         ofpact_update_len(b, &ids->ofpact);
 318     }
 319 }
 320
 321 static void
 322 set_field_parse(const char *arg, struct ofpbuf *ofpacts)
 323 {
 324     char *orig = xstrdup(arg);
 325     struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
 326     char *value;
 327     char *delim;
 328     char *key;
 329     const struct mf_field *mf;
 330     const char *error;
 331     union mf_value mf_value;
 332
 333     value = orig;
 334     delim = strstr(orig, "->");
 335     if (!delim) {
 336         ovs_fatal(0, "%s: missing `->'", orig);
 337     }
 338     if (strlen(delim) <= strlen("->")) {
 339         ovs_fatal(0, "%s: missing field name following `->'", orig);
 340     }
 341
 342     key = delim + strlen("->");
 343     mf = mf_from_name(key);
 344     if (!mf) {
 345         ovs_fatal(0, "%s is not valid oxm field name", key);
 346     }
 347     if (!mf->writable) {
 348         ovs_fatal(0, "%s is not allowed to set", key);
 349     }
 350
 351     delim[0] = '\0';
 352     error = mf_parse_value(mf, value, &mf_value);
 353     if (error) {
 354         ovs_fatal(0, "%s", error);
 355     }
 356     if (!mf_is_value_valid(mf, &mf_value)) {
 357         ovs_fatal(0, "%s is not valid valid for field %s", value, key);
 358     }
 359     ofpact_set_field_init(load, mf, &mf_value);
 360     free(orig);
 361 }
 362
 363 static void
 364 parse_metadata(struct ofpbuf *b, char *arg)
 365 {
 366     struct ofpact_metadata *om;
 367     char *mask = strchr(arg, '/');
 368
 369     om = ofpact_put_WRITE_METADATA(b);
 370
 371     if (mask) {
 372         *mask = '\0';
 373         om->mask = htonll(str_to_u64(mask + 1));
 374     } else {
 375         om->mask = htonll(UINT64_MAX);
 376     }
 377
 378     om->metadata = htonll(str_to_u64(arg));
 379 }
 380
 381 static void
 382 parse_named_action(enum ofputil_action_code code, const struct flow *flow,
 383                    char *arg, struct ofpbuf *ofpacts)
 384 {
 385     struct ofpact_tunnel *tunnel;
 386     uint16_t vid;
 387     uint16_t ethertype;
 388     ovs_be32 ip;
 389     uint8_t pcp;
 390     uint8_t tos;
 391
 392     switch (code) {
 393     case OFPUTIL_ACTION_INVALID:
 394         NOT_REACHED();
 395
 396     case OFPUTIL_OFPAT10_OUTPUT:
 397     case OFPUTIL_OFPAT11_OUTPUT:
 398         parse_output(arg, ofpacts);
 399         break;
 400
 401     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 402     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 403         vid = str_to_u32(arg);
 404         if (vid & ~VLAN_VID_MASK) {
 405             ovs_fatal(0, "%s: not a valid VLAN VID", arg);
 406         }
 407         ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
 408         break;
 409
 410     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 411     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 412         pcp = str_to_u32(arg);
 413         if (pcp & ~7) {
 414             ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
 415         }
 416         ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
 417         break;
 418
 419     case OFPUTIL_OFPAT12_SET_FIELD:
 420         set_field_parse(arg, ofpacts);
 421         break;
 422
 423     case OFPUTIL_OFPAT10_STRIP_VLAN:
 424     case OFPUTIL_OFPAT11_POP_VLAN:
 425         ofpact_put_STRIP_VLAN(ofpacts);
 426         break;
 427
 428     case OFPUTIL_OFPAT11_PUSH_VLAN:
 429         ethertype = str_to_u16(arg, "ethertype");
 430         if (ethertype != ETH_TYPE_VLAN_8021Q) {
 431             /* TODO:XXXX ETH_TYPE_VLAN_8021AD case isn't supported */
 432             ovs_fatal(0, "%s: not a valid VLAN ethertype", arg);
 433         }
 434         ofpact_put_PUSH_VLAN(ofpacts);
 435         break;
 436
 437     case OFPUTIL_OFPAT11_SET_QUEUE:
 438         ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
 439         break;
 440
 441
 442     case OFPUTIL_OFPAT10_SET_DL_SRC:
 443     case OFPUTIL_OFPAT11_SET_DL_SRC:
 444         str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
 445         break;
 446
 447     case OFPUTIL_OFPAT10_SET_DL_DST:
 448     case OFPUTIL_OFPAT11_SET_DL_DST:
 449         str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
 450         break;
 451
 452     case OFPUTIL_OFPAT10_SET_NW_SRC:
 453     case OFPUTIL_OFPAT11_SET_NW_SRC:
 454         str_to_ip(arg, &ip);
 455         ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
 456         break;
 457
 458     case OFPUTIL_OFPAT10_SET_NW_DST:
 459     case OFPUTIL_OFPAT11_SET_NW_DST:
 460         str_to_ip(arg, &ip);
 461         ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
 462         break;
 463
 464     case OFPUTIL_OFPAT10_SET_NW_TOS:
 465     case OFPUTIL_OFPAT11_SET_NW_TOS:
 466         tos = str_to_u32(arg);
 467         if (tos & ~IP_DSCP_MASK) {
 468             ovs_fatal(0, "%s: not a valid TOS", arg);
 469         }
 470         ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
 471         break;
 472
 473     case OFPUTIL_OFPAT11_DEC_NW_TTL:
 474         NOT_REACHED();
 475
 476     case OFPUTIL_OFPAT10_SET_TP_SRC:
 477     case OFPUTIL_OFPAT11_SET_TP_SRC:
 478         ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
 479         break;
 480
 481     case OFPUTIL_OFPAT10_SET_TP_DST:
 482     case OFPUTIL_OFPAT11_SET_TP_DST:
 483         ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
 484         break;
 485
 486     case OFPUTIL_OFPAT10_ENQUEUE:
 487         parse_enqueue(arg, ofpacts);
 488         break;
 489
 490     case OFPUTIL_NXAST_RESUBMIT:
 491         parse_resubmit(arg, ofpacts);
 492         break;
 493
 494     case OFPUTIL_NXAST_SET_TUNNEL:
 495     case OFPUTIL_NXAST_SET_TUNNEL64:
 496         tunnel = ofpact_put_SET_TUNNEL(ofpacts);
 497         tunnel->ofpact.compat = code;
 498         tunnel->tun_id = str_to_u64(arg);
 499         break;
 500
 501     case OFPUTIL_NXAST_WRITE_METADATA:
 502         parse_metadata(ofpacts, arg);
 503         break;
 504
 505     case OFPUTIL_NXAST_SET_QUEUE:
 506         ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
 507         break;
 508
 509     case OFPUTIL_NXAST_POP_QUEUE:
 510         ofpact_put_POP_QUEUE(ofpacts);
 511         break;
 512
 513     case OFPUTIL_NXAST_REG_MOVE:
 514         nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
 515         break;
 516
 517     case OFPUTIL_NXAST_REG_LOAD:
 518         nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
 519         break;
 520
 521     case OFPUTIL_NXAST_NOTE:
 522         parse_note(arg, ofpacts);
 523         break;
 524
 525     case OFPUTIL_NXAST_MULTIPATH:
 526         multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
 527         break;
 528
 529     case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
 530         autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
 531         break;
 532
 533     case OFPUTIL_NXAST_BUNDLE:
 534         bundle_parse(arg, ofpacts);
 535         break;
 536
 537     case OFPUTIL_NXAST_BUNDLE_LOAD:
 538         bundle_parse_load(arg, ofpacts);
 539         break;
 540
 541     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 542     case OFPUTIL_NXAST_OUTPUT_REG:
 543     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 544         NOT_REACHED();
 545
 546     case OFPUTIL_NXAST_LEARN:
 547         learn_parse(arg, flow, ofpacts);
 548         break;
 549
 550     case OFPUTIL_NXAST_EXIT:
 551         ofpact_put_EXIT(ofpacts);
 552         break;
 553
 554     case OFPUTIL_NXAST_DEC_TTL:
 555         parse_dec_ttl(ofpacts, arg);
 556         break;
 557
 558     case OFPUTIL_NXAST_FIN_TIMEOUT:
 559         parse_fin_timeout(ofpacts, arg);
 560         break;
 561
 562     case OFPUTIL_NXAST_CONTROLLER:
 563         parse_controller(ofpacts, arg);
 564         break;
 565     }
 566 }
 567
 568 static bool
 569 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
 570                 struct ofpbuf *ofpacts, int n_actions)
 571 {
 572     int code = ofputil_action_code_from_name(act);
 573     if (code >= 0) {
 574         parse_named_action(code, flow, arg, ofpacts);
 575     } else if (!strcasecmp(act, "drop")) {
 576         if (n_actions) {
 577             ovs_fatal(0, "Drop actions must not be preceded by other "
 578                       "actions");
 579         } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
 580             ovs_fatal(0, "Drop actions must not be followed by other "
 581                       "actions");
 582         }
 583         return false;
 584     } else {
 585         uint16_t port;
 586         if (ofputil_port_from_string(act, &port)) {
 587             ofpact_put_OUTPUT(ofpacts)->port = port;
 588         } else {
 589             ovs_fatal(0, "Unknown action: %s", act);
 590         }
 591     }
 592
 593     return true;
 594 }
 595
 596 static void
 597 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
 598 {
 599     char *pos, *act, *arg;
 600     enum ofperr error;
 601     int n_actions;
 602
 603     pos = str;
 604     n_actions = 0;
 605     while (ofputil_parse_key_value(&pos, &act, &arg)) {
 606         if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
 607             break;
 608         }
 609         n_actions++;
 610     }
 611
 612     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 613     if (error) {
 614         ovs_fatal(0, "Incorrect action ordering");
 615     }
 616
 617     ofpact_pad(ofpacts);
 618 }
 619
 620 static void
 621 parse_named_instruction(enum ovs_instruction_type type,
 622                         char *arg, struct ofpbuf *ofpacts)
 623 {
 624     enum ofperr error;
 625
 626     switch (type) {
 627     case OVSINST_OFPIT11_APPLY_ACTIONS:
 628         NOT_REACHED();  /* This case is handled by str_to_inst_ofpacts() */
 629         break;
 630
 631     case OVSINST_OFPIT11_WRITE_ACTIONS:
 632         /* TODO:XXX */
 633         ovs_fatal(0, "instruction write-actions is not supported yet");
 634         break;
 635
 636     case OVSINST_OFPIT11_CLEAR_ACTIONS:
 637         ofpact_put_CLEAR_ACTIONS(ofpacts);
 638         break;
 639
 640     case OVSINST_OFPIT11_WRITE_METADATA:
 641         parse_metadata(ofpacts, arg);
 642         break;
 643
 644     case OVSINST_OFPIT11_GOTO_TABLE: {
 645         struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
 646         char *table_s = strsep(&arg, ",");
 647         if (!table_s || !table_s[0]) {
 648             ovs_fatal(0, "instruction goto-table needs table id");
 649         }
 650         ogt->table_id = str_to_table_id(table_s);
 651         break;
 652     }
 653     }
 654
 655     /* If write_metadata is specified as an action AND an instruction, ofpacts
 656        could be invalid. */
 657     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 658     if (error) {
 659         ovs_fatal(0, "Incorrect instruction ordering");
 660     }
 661 }
 662
 663 static void
 664 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
 665 {
 666     char *pos, *inst, *arg;
 667     int type;
 668     const char *prev_inst = NULL;
 669     int prev_type = -1;
 670     int n_actions = 0;
 671
 672     pos = str;
 673     while (ofputil_parse_key_value(&pos, &inst, &arg)) {
 674         type = ofpact_instruction_type_from_name(inst);
 675         if (type < 0) {
 676             if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
 677                 break;
 678             }
 679
 680             type = OVSINST_OFPIT11_APPLY_ACTIONS;
 681             if (prev_type == type) {
 682                 n_actions++;
 683                 continue;
 684             }
 685         } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
 686             ovs_fatal(0, "%s isn't supported. Just write actions then "
 687                       "it is interpreted as apply_actions", inst);
 688         } else {
 689             parse_named_instruction(type, arg, ofpacts);
 690         }
 691
 692         if (type == prev_type) {
 693             ovs_fatal(0, "instruction can be specified at most once: %s",
 694                       inst);
 695         }
 696         if (type <= prev_type) {
 697             ovs_fatal(0, "Instruction %s must be specified before %s",
 698                       inst, prev_inst);
 699         }
 700
 701         prev_inst = inst;
 702         prev_type = type;
 703         n_actions++;
 704     }
 705     ofpact_pad(ofpacts);
 706 }
 707
 708 struct protocol {
 709     const char *name;
 710     uint16_t dl_type;
 711     uint8_t nw_proto;
 712 };
 713
 714 static bool
 715 parse_protocol(const char *name, const struct protocol **p_out)
 716 {
 717     static const struct protocol protocols[] = {
 718         { "ip", ETH_TYPE_IP, 0 },
 719         { "arp", ETH_TYPE_ARP, 0 },
 720         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
 721         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
 722         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
 723         { "ipv6", ETH_TYPE_IPV6, 0 },
 724         { "ip6", ETH_TYPE_IPV6, 0 },
 725         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
 726         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
 727         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
 728         { "rarp", ETH_TYPE_RARP, 0},
 729 };
 730     const struct protocol *p;
 731
 732     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
 733         if (!strcmp(p->name, name)) {
 734             *p_out = p;
 735             return true;
 736         }
 737     }
 738     *p_out = NULL;
 739     return false;
 740 }
 741
 742 static void
 743 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
 744 {
 745     va_list args;
 746
 747     if (verbose) {
 748         fprintf(stderr, "%s:\n", flow);
 749     }
 750
 751     va_start(args, format);
 752     ovs_fatal_valist(0, format, args);
 753 }
 754
 755 static void
 756 parse_field(const struct mf_field *mf, const char *s, struct match *match)
 757 {
 758     union mf_value value, mask;
 759     char *error;
 760
 761     error = mf_parse(mf, s, &value, &mask);
 762     if (error) {
 763         ovs_fatal(0, "%s", error);
 764     }
 765
 766     mf_set(mf, &value, &mask, match);
 767 }
 768
 769 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
 770  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
 771  * If 'actions' is specified, an action must be in 'string' and may be expanded
 772  * or reallocated.
 773  *
 774  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
 775  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
 776  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
 777 void
 778 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
 779               bool verbose)
 780 {
 781     enum {
 782         F_OUT_PORT = 1 << 0,
 783         F_ACTIONS = 1 << 1,
 784         F_TIMEOUT = 1 << 3,
 785         F_PRIORITY = 1 << 4,
 786         F_FLAGS = 1 << 5,
 787     } fields;
 788     char *string = xstrdup(str_);
 789     char *save_ptr = NULL;
 790     char *act_str = NULL;
 791     char *name;
 792
 793     switch (command) {
 794     case -1:
 795         fields = F_OUT_PORT;
 796         break;
 797
 798     case OFPFC_ADD:
 799         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 800         break;
 801
 802     case OFPFC_DELETE:
 803         fields = F_OUT_PORT;
 804         break;
 805
 806     case OFPFC_DELETE_STRICT:
 807         fields = F_OUT_PORT | F_PRIORITY;
 808         break;
 809
 810     case OFPFC_MODIFY:
 811         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 812         break;
 813
 814     case OFPFC_MODIFY_STRICT:
 815         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 816         break;
 817
 818     default:
 819         NOT_REACHED();
 820     }
 821
 822     match_init_catchall(&fm->match);
 823     fm->priority = OFP_DEFAULT_PRIORITY;
 824     fm->cookie = htonll(0);
 825     fm->cookie_mask = htonll(0);
 826     if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
 827         /* For modify, by default, don't update the cookie. */
 828         fm->new_cookie = htonll(UINT64_MAX);
 829     } else{
 830         fm->new_cookie = htonll(0);
 831     }
 832     fm->table_id = 0xff;
 833     fm->command = command;
 834     fm->idle_timeout = OFP_FLOW_PERMANENT;
 835     fm->hard_timeout = OFP_FLOW_PERMANENT;
 836     fm->buffer_id = UINT32_MAX;
 837     fm->out_port = OFPP_ANY;
 838     fm->flags = 0;
 839     if (fields & F_ACTIONS) {
 840         act_str = strstr(string, "action");
 841         if (!act_str) {
 842             ofp_fatal(str_, verbose, "must specify an action");
 843         }
 844         *act_str = '\0';
 845
 846         act_str = strchr(act_str + 1, '=');
 847         if (!act_str) {
 848             ofp_fatal(str_, verbose, "must specify an action");
 849         }
 850
 851         act_str++;
 852     }
 853     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 854          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 855         const struct protocol *p;
 856
 857         if (parse_protocol(name, &p)) {
 858             match_set_dl_type(&fm->match, htons(p->dl_type));
 859             if (p->nw_proto) {
 860                 match_set_nw_proto(&fm->match, p->nw_proto);
 861             }
 862         } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
 863             fm->flags |= OFPFF_SEND_FLOW_REM;
 864         } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
 865             fm->flags |= OFPFF_CHECK_OVERLAP;
 866         } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
 867             fm->flags |= OFPFF12_RESET_COUNTS;
 868         } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
 869             fm->flags |= OFPFF13_NO_PKT_COUNTS;
 870         } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
 871             fm->flags |= OFPFF13_NO_BYT_COUNTS;
 872         } else {
 873             char *value;
 874
 875             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 876             if (!value) {
 877                 ofp_fatal(str_, verbose, "field %s missing value", name);
 878             }
 879
 880             if (!strcmp(name, "table")) {
 881                 fm->table_id = str_to_table_id(value);
 882             } else if (!strcmp(name, "out_port")) {
 883                 if (!ofputil_port_from_string(name, &fm->out_port)) {
 884                     ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
 885                               name);
 886                 }
 887             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
 888                 fm->priority = str_to_u16(value, name);
 889             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
 890                 fm->idle_timeout = str_to_u16(value, name);
 891             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
 892                 fm->hard_timeout = str_to_u16(value, name);
 893             } else if (!strcmp(name, "cookie")) {
 894                 char *mask = strchr(value, '/');
 895
 896                 if (mask) {
 897                     /* A mask means we're searching for a cookie. */
 898                     if (command == OFPFC_ADD) {
 899                         ofp_fatal(str_, verbose, "flow additions cannot use "
 900                                   "a cookie mask");
 901                     }
 902                     *mask = '\0';
 903                     fm->cookie = htonll(str_to_u64(value));
 904                     fm->cookie_mask = htonll(str_to_u64(mask+1));
 905                 } else {
 906                     /* No mask means that the cookie is being set. */
 907                     if (command != OFPFC_ADD && command != OFPFC_MODIFY
 908                             && command != OFPFC_MODIFY_STRICT) {
 909                         ofp_fatal(str_, verbose, "cannot set cookie");
 910                     }
 911                     fm->new_cookie = htonll(str_to_u64(value));
 912                 }
 913             } else if (mf_from_name(name)) {
 914                 parse_field(mf_from_name(name), value, &fm->match);
 915             } else if (!strcmp(name, "duration")
 916                        || !strcmp(name, "n_packets")
 917                        || !strcmp(name, "n_bytes")) {
 918                 /* Ignore these, so that users can feed the output of
 919                  * "ovs-ofctl dump-flows" back into commands that parse
 920                  * flows. */
 921             } else {
 922                 ofp_fatal(str_, verbose, "unknown keyword %s", name);
 923             }
 924         }
 925     }
 926     if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
 927             && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
 928         /* On modifies without a mask, we are supposed to add a flow if
 929          * one does not exist.  If a cookie wasn't been specified, use a
 930          * default of zero. */
 931         fm->new_cookie = htonll(0);
 932     }
 933     if (fields & F_ACTIONS) {
 934         struct ofpbuf ofpacts;
 935
 936         ofpbuf_init(&ofpacts, 32);
 937         str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
 938         fm->ofpacts_len = ofpacts.size;
 939         fm->ofpacts = ofpbuf_steal_data(&ofpacts);
 940     } else {
 941         fm->ofpacts_len = 0;
 942         fm->ofpacts = NULL;
 943     }
 944
 945     free(string);
 946 }
 947
 948 /* Convert 'str_' (as described in the documentation for the "monitor" command
 949  * in the ovs-ofctl man page) into 'fmr'. */
 950 void
 951 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
 952                            const char *str_)
 953 {
 954     static uint32_t id;
 955
 956     char *string = xstrdup(str_);
 957     char *save_ptr = NULL;
 958     char *name;
 959
 960     fmr->id = id++;
 961     fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
 962                   | NXFMF_OWN | NXFMF_ACTIONS);
 963     fmr->out_port = OFPP_NONE;
 964     fmr->table_id = 0xff;
 965     match_init_catchall(&fmr->match);
 966
 967     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 968          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 969         const struct protocol *p;
 970
 971         if (!strcmp(name, "!initial")) {
 972             fmr->flags &= ~NXFMF_INITIAL;
 973         } else if (!strcmp(name, "!add")) {
 974             fmr->flags &= ~NXFMF_ADD;
 975         } else if (!strcmp(name, "!delete")) {
 976             fmr->flags &= ~NXFMF_DELETE;
 977         } else if (!strcmp(name, "!modify")) {
 978             fmr->flags &= ~NXFMF_MODIFY;
 979         } else if (!strcmp(name, "!actions")) {
 980             fmr->flags &= ~NXFMF_ACTIONS;
 981         } else if (!strcmp(name, "!own")) {
 982             fmr->flags &= ~NXFMF_OWN;
 983         } else if (parse_protocol(name, &p)) {
 984             match_set_dl_type(&fmr->match, htons(p->dl_type));
 985             if (p->nw_proto) {
 986                 match_set_nw_proto(&fmr->match, p->nw_proto);
 987             }
 988         } else {
 989             char *value;
 990
 991             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 992             if (!value) {
 993                 ovs_fatal(0, "%s: field %s missing value", str_, name);
 994             }
 995
 996             if (!strcmp(name, "table")) {
 997                 fmr->table_id = str_to_table_id(value);
 998             } else if (!strcmp(name, "out_port")) {
 999                 fmr->out_port = atoi(value);
1000             } else if (mf_from_name(name)) {
1001                 parse_field(mf_from_name(name), value, &fmr->match);
1002             } else {
1003                 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
1004             }
1005         }
1006     }
1007     free(string);
1008 }
1009
1010 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1011  * 'actions'.
1012  *
1013  * Prints an error on stderr and aborts the program if 's' syntax is
1014  * invalid. */
1015 void
1016 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
1017 {
1018     char *s = xstrdup(s_);
1019     str_to_ofpacts(NULL, s, ofpacts);
1020     free(s);
1021 }
1022
1023 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1024  * (one of OFPFC_*) into 'fm'. */
1025 void
1026 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1027                        uint16_t command, bool verbose)
1028 {
1029     struct match match_copy;
1030
1031     parse_ofp_str(fm, command, string, verbose);
1032
1033     /* Normalize a copy of the match.  This ensures that non-normalized flows
1034      * get logged but doesn't affect what gets sent to the switch, so that the
1035      * switch can do whatever it likes with the flow. */
1036     match_copy = fm->match;
1037     ofputil_normalize_match(&match_copy);
1038 }
1039
1040 void
1041 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1042                         struct ofputil_flow_mod **fms, size_t *n_fms)
1043 {
1044     size_t allocated_fms;
1045     FILE *stream;
1046     struct ds s;
1047
1048     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1049     if (stream == NULL) {
1050         ovs_fatal(errno, "%s: open", file_name);
1051     }
1052
1053     allocated_fms = *n_fms;
1054     ds_init(&s);
1055     while (!ds_get_preprocessed_line(&s, stream)) {
1056         if (*n_fms >= allocated_fms) {
1057             *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1058         }
1059         parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1060         *n_fms += 1;
1061     }
1062     ds_destroy(&s);
1063
1064     if (stream != stdin) {
1065         fclose(stream);
1066     }
1067 }
1068
1069 void
1070 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1071                                  bool aggregate, const char *string)
1072 {
1073     struct ofputil_flow_mod fm;
1074
1075     parse_ofp_str(&fm, -1, string, false);
1076     fsr->aggregate = aggregate;
1077     fsr->cookie = fm.cookie;
1078     fsr->cookie_mask = fm.cookie_mask;
1079     fsr->match = fm.match;
1080     fsr->out_port = fm.out_port;
1081     fsr->table_id = fm.table_id;
1082 }
1083
1084 /* Parses a specification of a flow from 's' into 'flow'.  's' must take the
1085  * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1086  * mf_field.  Fields must be specified in a natural order for satisfying
1087  * prerequisites.
1088  *
1089  * Returns NULL on success, otherwise a malloc()'d string that explains the
1090  * problem. */
1091 char *
1092 parse_ofp_exact_flow(struct flow *flow, const char *s)
1093 {
1094     char *pos, *key, *value_s;
1095     char *error = NULL;
1096     char *copy;
1097
1098     memset(flow, 0, sizeof *flow);
1099
1100     pos = copy = xstrdup(s);
1101     while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1102         const struct protocol *p;
1103         if (parse_protocol(key, &p)) {
1104             if (flow->dl_type) {
1105                 error = xasprintf("%s: Ethernet type set multiple times", s);
1106                 goto exit;
1107             }
1108             flow->dl_type = htons(p->dl_type);
1109
1110             if (p->nw_proto) {
1111                 if (flow->nw_proto) {
1112                     error = xasprintf("%s: network protocol set "
1113                                       "multiple times", s);
1114                     goto exit;
1115                 }
1116                 flow->nw_proto = p->nw_proto;
1117             }
1118         } else {
1119             const struct mf_field *mf;
1120             union mf_value value;
1121             char *field_error;
1122
1123             mf = mf_from_name(key);
1124             if (!mf) {
1125                 error = xasprintf("%s: unknown field %s", s, key);
1126                 goto exit;
1127             }
1128
1129             if (!mf_are_prereqs_ok(mf, flow)) {
1130                 error = xasprintf("%s: prerequisites not met for setting %s",
1131                                   s, key);
1132                 goto exit;
1133             }
1134
1135             if (!mf_is_zero(mf, flow)) {
1136                 error = xasprintf("%s: field %s set multiple times", s, key);
1137                 goto exit;
1138             }
1139
1140             field_error = mf_parse_value(mf, value_s, &value);
1141             if (field_error) {
1142                 error = xasprintf("%s: bad value for %s (%s)",
1143                                   s, key, field_error);
1144                 free(field_error);
1145                 goto exit;
1146             }
1147
1148             mf_set_flow_value(mf, &value, flow);
1149         }
1150     }
1151
1152 exit:
1153     free(copy);
1154
1155     if (error) {
1156         memset(flow, 0, sizeof *flow);
1157     }
1158     return error;
1159 }