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_named_action(enum ofputil_action_code code, const struct flow *flow,
 365                    char *arg, struct ofpbuf *ofpacts)
 366 {
 367     struct ofpact_tunnel *tunnel;
 368     uint16_t vid;
 369     ovs_be32 ip;
 370     uint8_t pcp;
 371     uint8_t tos;
 372
 373     switch (code) {
 374     case OFPUTIL_ACTION_INVALID:
 375         NOT_REACHED();
 376
 377     case OFPUTIL_OFPAT10_OUTPUT:
 378     case OFPUTIL_OFPAT11_OUTPUT:
 379         parse_output(arg, ofpacts);
 380         break;
 381
 382     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 383     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 384         vid = str_to_u32(arg);
 385         if (vid & ~VLAN_VID_MASK) {
 386             ovs_fatal(0, "%s: not a valid VLAN VID", arg);
 387         }
 388         ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
 389         break;
 390
 391     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 392     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 393         pcp = str_to_u32(arg);
 394         if (pcp & ~7) {
 395             ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
 396         }
 397         ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
 398         break;
 399
 400     case OFPUTIL_OFPAT12_SET_FIELD:
 401         set_field_parse(arg, ofpacts);
 402         break;
 403
 404     case OFPUTIL_OFPAT10_STRIP_VLAN:
 405     case OFPUTIL_OFPAT11_POP_VLAN:
 406         ofpact_put_STRIP_VLAN(ofpacts);
 407         break;
 408
 409     case OFPUTIL_OFPAT10_SET_DL_SRC:
 410     case OFPUTIL_OFPAT11_SET_DL_SRC:
 411         str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
 412         break;
 413
 414     case OFPUTIL_OFPAT10_SET_DL_DST:
 415     case OFPUTIL_OFPAT11_SET_DL_DST:
 416         str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
 417         break;
 418
 419     case OFPUTIL_OFPAT10_SET_NW_SRC:
 420     case OFPUTIL_OFPAT11_SET_NW_SRC:
 421         str_to_ip(arg, &ip);
 422         ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
 423         break;
 424
 425     case OFPUTIL_OFPAT10_SET_NW_DST:
 426     case OFPUTIL_OFPAT11_SET_NW_DST:
 427         str_to_ip(arg, &ip);
 428         ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
 429         break;
 430
 431     case OFPUTIL_OFPAT10_SET_NW_TOS:
 432     case OFPUTIL_OFPAT11_SET_NW_TOS:
 433         tos = str_to_u32(arg);
 434         if (tos & ~IP_DSCP_MASK) {
 435             ovs_fatal(0, "%s: not a valid TOS", arg);
 436         }
 437         ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
 438         break;
 439
 440     case OFPUTIL_OFPAT11_DEC_NW_TTL:
 441         NOT_REACHED();
 442
 443     case OFPUTIL_OFPAT10_SET_TP_SRC:
 444     case OFPUTIL_OFPAT11_SET_TP_SRC:
 445         ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
 446         break;
 447
 448     case OFPUTIL_OFPAT10_SET_TP_DST:
 449     case OFPUTIL_OFPAT11_SET_TP_DST:
 450         ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
 451         break;
 452
 453     case OFPUTIL_OFPAT10_ENQUEUE:
 454         parse_enqueue(arg, ofpacts);
 455         break;
 456
 457     case OFPUTIL_NXAST_RESUBMIT:
 458         parse_resubmit(arg, ofpacts);
 459         break;
 460
 461     case OFPUTIL_NXAST_SET_TUNNEL:
 462     case OFPUTIL_NXAST_SET_TUNNEL64:
 463         tunnel = ofpact_put_SET_TUNNEL(ofpacts);
 464         tunnel->ofpact.compat = code;
 465         tunnel->tun_id = str_to_u64(arg);
 466         break;
 467
 468     case OFPUTIL_NXAST_SET_QUEUE:
 469         ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
 470         break;
 471
 472     case OFPUTIL_NXAST_POP_QUEUE:
 473         ofpact_put_POP_QUEUE(ofpacts);
 474         break;
 475
 476     case OFPUTIL_NXAST_REG_MOVE:
 477         nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
 478         break;
 479
 480     case OFPUTIL_NXAST_REG_LOAD:
 481         nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
 482         break;
 483
 484     case OFPUTIL_NXAST_NOTE:
 485         parse_note(arg, ofpacts);
 486         break;
 487
 488     case OFPUTIL_NXAST_MULTIPATH:
 489         multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
 490         break;
 491
 492     case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
 493         autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
 494         break;
 495
 496     case OFPUTIL_NXAST_BUNDLE:
 497         bundle_parse(arg, ofpacts);
 498         break;
 499
 500     case OFPUTIL_NXAST_BUNDLE_LOAD:
 501         bundle_parse_load(arg, ofpacts);
 502         break;
 503
 504     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 505     case OFPUTIL_NXAST_OUTPUT_REG:
 506     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 507         NOT_REACHED();
 508
 509     case OFPUTIL_NXAST_LEARN:
 510         learn_parse(arg, flow, ofpacts);
 511         break;
 512
 513     case OFPUTIL_NXAST_EXIT:
 514         ofpact_put_EXIT(ofpacts);
 515         break;
 516
 517     case OFPUTIL_NXAST_DEC_TTL:
 518         parse_dec_ttl(ofpacts, arg);
 519         break;
 520
 521     case OFPUTIL_NXAST_FIN_TIMEOUT:
 522         parse_fin_timeout(ofpacts, arg);
 523         break;
 524
 525     case OFPUTIL_NXAST_CONTROLLER:
 526         parse_controller(ofpacts, arg);
 527         break;
 528     }
 529 }
 530
 531 static bool
 532 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
 533                 struct ofpbuf *ofpacts, int n_actions)
 534 {
 535     int code = ofputil_action_code_from_name(act);
 536     if (code >= 0) {
 537         parse_named_action(code, flow, arg, ofpacts);
 538     } else if (!strcasecmp(act, "drop")) {
 539         if (n_actions) {
 540             ovs_fatal(0, "Drop actions must not be preceded by other "
 541                       "actions");
 542         } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
 543             ovs_fatal(0, "Drop actions must not be followed by other "
 544                       "actions");
 545         }
 546         return false;
 547     } else {
 548         uint16_t port;
 549         if (ofputil_port_from_string(act, &port)) {
 550             ofpact_put_OUTPUT(ofpacts)->port = port;
 551         } else {
 552             ovs_fatal(0, "Unknown action: %s", act);
 553         }
 554     }
 555
 556     return true;
 557 }
 558
 559 static void
 560 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
 561 {
 562     char *pos, *act, *arg;
 563     int n_actions;
 564
 565     pos = str;
 566     n_actions = 0;
 567     while (ofputil_parse_key_value(&pos, &act, &arg)) {
 568         if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
 569             break;
 570         }
 571         n_actions++;
 572     }
 573     ofpact_pad(ofpacts);
 574 }
 575
 576 static void
 577 parse_named_instruction(enum ovs_instruction_type type,
 578                         char *arg, struct ofpbuf *ofpacts)
 579 {
 580     switch (type) {
 581     case OVSINST_OFPIT11_APPLY_ACTIONS:
 582         NOT_REACHED();  /* This case is handled by str_to_inst_ofpacts() */
 583         break;
 584
 585     case OVSINST_OFPIT11_WRITE_ACTIONS:
 586         /* TODO:XXX */
 587         ovs_fatal(0, "instruction write-actions is not supported yet");
 588         break;
 589
 590     case OVSINST_OFPIT11_CLEAR_ACTIONS:
 591         ofpact_put_CLEAR_ACTIONS(ofpacts);
 592         break;
 593
 594     case OVSINST_OFPIT11_WRITE_METADATA:
 595         /* TODO:XXX */
 596         ovs_fatal(0, "instruction write-metadata is not supported yet");
 597         break;
 598
 599     case OVSINST_OFPIT11_GOTO_TABLE: {
 600         struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
 601         char *table_s = strsep(&arg, ",");
 602         if (!table_s || !table_s[0]) {
 603             ovs_fatal(0, "instruction goto-table needs table id");
 604         }
 605         ogt->table_id = str_to_table_id(table_s);
 606         break;
 607     }
 608     }
 609 }
 610
 611 static void
 612 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
 613 {
 614     char *pos, *inst, *arg;
 615     int type;
 616     const char *prev_inst = NULL;
 617     int prev_type = -1;
 618     int n_actions = 0;
 619
 620     pos = str;
 621     while (ofputil_parse_key_value(&pos, &inst, &arg)) {
 622         type = ofpact_instruction_type_from_name(inst);
 623         if (type < 0) {
 624             if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
 625                 break;
 626             }
 627
 628             type = OVSINST_OFPIT11_APPLY_ACTIONS;
 629             if (prev_type == type) {
 630                 n_actions++;
 631                 continue;
 632             }
 633         } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
 634             ovs_fatal(0, "%s isn't supported. Just write actions then "
 635                       "it is interpreted as apply_actions", inst);
 636         } else {
 637             parse_named_instruction(type, arg, ofpacts);
 638         }
 639
 640         if (type == prev_type) {
 641             ovs_fatal(0, "instruction can be specified at most once: %s",
 642                       inst);
 643         }
 644         if (type <= prev_type) {
 645             ovs_fatal(0, "Instruction %s must be specified before %s",
 646                       inst, prev_inst);
 647         }
 648
 649         prev_inst = inst;
 650         prev_type = type;
 651         n_actions++;
 652     }
 653     ofpact_pad(ofpacts);
 654 }
 655
 656 struct protocol {
 657     const char *name;
 658     uint16_t dl_type;
 659     uint8_t nw_proto;
 660 };
 661
 662 static bool
 663 parse_protocol(const char *name, const struct protocol **p_out)
 664 {
 665     static const struct protocol protocols[] = {
 666         { "ip", ETH_TYPE_IP, 0 },
 667         { "arp", ETH_TYPE_ARP, 0 },
 668         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
 669         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
 670         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
 671         { "ipv6", ETH_TYPE_IPV6, 0 },
 672         { "ip6", ETH_TYPE_IPV6, 0 },
 673         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
 674         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
 675         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
 676     };
 677     const struct protocol *p;
 678
 679     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
 680         if (!strcmp(p->name, name)) {
 681             *p_out = p;
 682             return true;
 683         }
 684     }
 685     *p_out = NULL;
 686     return false;
 687 }
 688
 689 static void
 690 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
 691 {
 692     va_list args;
 693
 694     if (verbose) {
 695         fprintf(stderr, "%s:\n", flow);
 696     }
 697
 698     va_start(args, format);
 699     ovs_fatal_valist(0, format, args);
 700 }
 701
 702 static void
 703 parse_field(const struct mf_field *mf, const char *s, struct match *match)
 704 {
 705     union mf_value value, mask;
 706     char *error;
 707
 708     error = mf_parse(mf, s, &value, &mask);
 709     if (error) {
 710         ovs_fatal(0, "%s", error);
 711     }
 712
 713     mf_set(mf, &value, &mask, match);
 714 }
 715
 716 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
 717  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
 718  * If 'actions' is specified, an action must be in 'string' and may be expanded
 719  * or reallocated.
 720  *
 721  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
 722  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
 723  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
 724 void
 725 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
 726               bool verbose)
 727 {
 728     enum {
 729         F_OUT_PORT = 1 << 0,
 730         F_ACTIONS = 1 << 1,
 731         F_TIMEOUT = 1 << 3,
 732         F_PRIORITY = 1 << 4,
 733         F_FLAGS = 1 << 5,
 734     } fields;
 735     char *string = xstrdup(str_);
 736     char *save_ptr = NULL;
 737     char *act_str = NULL;
 738     char *name;
 739
 740     switch (command) {
 741     case -1:
 742         fields = F_OUT_PORT;
 743         break;
 744
 745     case OFPFC_ADD:
 746         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 747         break;
 748
 749     case OFPFC_DELETE:
 750         fields = F_OUT_PORT;
 751         break;
 752
 753     case OFPFC_DELETE_STRICT:
 754         fields = F_OUT_PORT | F_PRIORITY;
 755         break;
 756
 757     case OFPFC_MODIFY:
 758         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 759         break;
 760
 761     case OFPFC_MODIFY_STRICT:
 762         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 763         break;
 764
 765     default:
 766         NOT_REACHED();
 767     }
 768
 769     match_init_catchall(&fm->match);
 770     fm->priority = OFP_DEFAULT_PRIORITY;
 771     fm->cookie = htonll(0);
 772     fm->cookie_mask = htonll(0);
 773     if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
 774         /* For modify, by default, don't update the cookie. */
 775         fm->new_cookie = htonll(UINT64_MAX);
 776     } else{
 777         fm->new_cookie = htonll(0);
 778     }
 779     fm->table_id = 0xff;
 780     fm->command = command;
 781     fm->idle_timeout = OFP_FLOW_PERMANENT;
 782     fm->hard_timeout = OFP_FLOW_PERMANENT;
 783     fm->buffer_id = UINT32_MAX;
 784     fm->out_port = OFPP_NONE;
 785     fm->flags = 0;
 786     if (fields & F_ACTIONS) {
 787         act_str = strstr(string, "action");
 788         if (!act_str) {
 789             ofp_fatal(str_, verbose, "must specify an action");
 790         }
 791         *act_str = '\0';
 792
 793         act_str = strchr(act_str + 1, '=');
 794         if (!act_str) {
 795             ofp_fatal(str_, verbose, "must specify an action");
 796         }
 797
 798         act_str++;
 799     }
 800     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 801          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 802         const struct protocol *p;
 803
 804         if (parse_protocol(name, &p)) {
 805             match_set_dl_type(&fm->match, htons(p->dl_type));
 806             if (p->nw_proto) {
 807                 match_set_nw_proto(&fm->match, p->nw_proto);
 808             }
 809         } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
 810             fm->flags |= OFPFF_SEND_FLOW_REM;
 811         } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
 812             fm->flags |= OFPFF_CHECK_OVERLAP;
 813         } else {
 814             char *value;
 815
 816             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 817             if (!value) {
 818                 ofp_fatal(str_, verbose, "field %s missing value", name);
 819             }
 820
 821             if (!strcmp(name, "table")) {
 822                 fm->table_id = str_to_table_id(value);
 823             } else if (!strcmp(name, "out_port")) {
 824                 if (!ofputil_port_from_string(name, &fm->out_port)) {
 825                     ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
 826                               name);
 827                 }
 828             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
 829                 fm->priority = str_to_u16(value, name);
 830             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
 831                 fm->idle_timeout = str_to_u16(value, name);
 832             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
 833                 fm->hard_timeout = str_to_u16(value, name);
 834             } else if (!strcmp(name, "cookie")) {
 835                 char *mask = strchr(value, '/');
 836
 837                 if (mask) {
 838                     /* A mask means we're searching for a cookie. */
 839                     if (command == OFPFC_ADD) {
 840                         ofp_fatal(str_, verbose, "flow additions cannot use "
 841                                   "a cookie mask");
 842                     }
 843                     *mask = '\0';
 844                     fm->cookie = htonll(str_to_u64(value));
 845                     fm->cookie_mask = htonll(str_to_u64(mask+1));
 846                 } else {
 847                     /* No mask means that the cookie is being set. */
 848                     if (command != OFPFC_ADD && command != OFPFC_MODIFY
 849                             && command != OFPFC_MODIFY_STRICT) {
 850                         ofp_fatal(str_, verbose, "cannot set cookie");
 851                     }
 852                     fm->new_cookie = htonll(str_to_u64(value));
 853                 }
 854             } else if (mf_from_name(name)) {
 855                 parse_field(mf_from_name(name), value, &fm->match);
 856             } else if (!strcmp(name, "duration")
 857                        || !strcmp(name, "n_packets")
 858                        || !strcmp(name, "n_bytes")) {
 859                 /* Ignore these, so that users can feed the output of
 860                  * "ovs-ofctl dump-flows" back into commands that parse
 861                  * flows. */
 862             } else {
 863                 ofp_fatal(str_, verbose, "unknown keyword %s", name);
 864             }
 865         }
 866     }
 867     if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
 868             && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
 869         /* On modifies without a mask, we are supposed to add a flow if
 870          * one does not exist.  If a cookie wasn't been specified, use a
 871          * default of zero. */
 872         fm->new_cookie = htonll(0);
 873     }
 874     if (fields & F_ACTIONS) {
 875         struct ofpbuf ofpacts;
 876
 877         ofpbuf_init(&ofpacts, 32);
 878         str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
 879         fm->ofpacts_len = ofpacts.size;
 880         fm->ofpacts = ofpbuf_steal_data(&ofpacts);
 881     } else {
 882         fm->ofpacts_len = 0;
 883         fm->ofpacts = NULL;
 884     }
 885
 886     free(string);
 887 }
 888
 889 /* Convert 'str_' (as described in the documentation for the "monitor" command
 890  * in the ovs-ofctl man page) into 'fmr'. */
 891 void
 892 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
 893                            const char *str_)
 894 {
 895     static uint32_t id;
 896
 897     char *string = xstrdup(str_);
 898     char *save_ptr = NULL;
 899     char *name;
 900
 901     fmr->id = id++;
 902     fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
 903                   | NXFMF_OWN | NXFMF_ACTIONS);
 904     fmr->out_port = OFPP_NONE;
 905     fmr->table_id = 0xff;
 906     match_init_catchall(&fmr->match);
 907
 908     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 909          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 910         const struct protocol *p;
 911
 912         if (!strcmp(name, "!initial")) {
 913             fmr->flags &= ~NXFMF_INITIAL;
 914         } else if (!strcmp(name, "!add")) {
 915             fmr->flags &= ~NXFMF_ADD;
 916         } else if (!strcmp(name, "!delete")) {
 917             fmr->flags &= ~NXFMF_DELETE;
 918         } else if (!strcmp(name, "!modify")) {
 919             fmr->flags &= ~NXFMF_MODIFY;
 920         } else if (!strcmp(name, "!actions")) {
 921             fmr->flags &= ~NXFMF_ACTIONS;
 922         } else if (!strcmp(name, "!own")) {
 923             fmr->flags &= ~NXFMF_OWN;
 924         } else if (parse_protocol(name, &p)) {
 925             match_set_dl_type(&fmr->match, htons(p->dl_type));
 926             if (p->nw_proto) {
 927                 match_set_nw_proto(&fmr->match, p->nw_proto);
 928             }
 929         } else {
 930             char *value;
 931
 932             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 933             if (!value) {
 934                 ovs_fatal(0, "%s: field %s missing value", str_, name);
 935             }
 936
 937             if (!strcmp(name, "table")) {
 938                 fmr->table_id = str_to_table_id(value);
 939             } else if (!strcmp(name, "out_port")) {
 940                 fmr->out_port = atoi(value);
 941             } else if (mf_from_name(name)) {
 942                 parse_field(mf_from_name(name), value, &fmr->match);
 943             } else {
 944                 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
 945             }
 946         }
 947     }
 948     free(string);
 949 }
 950
 951 /* Parses 's' as a set of OpenFlow actions and appends the actions to
 952  * 'actions'.
 953  *
 954  * Prints an error on stderr and aborts the program if 's' syntax is
 955  * invalid. */
 956 void
 957 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
 958 {
 959     char *s = xstrdup(s_);
 960     str_to_ofpacts(NULL, s, ofpacts);
 961     free(s);
 962 }
 963
 964 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
 965  * (one of OFPFC_*) into 'fm'. */
 966 void
 967 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
 968                        uint16_t command, bool verbose)
 969 {
 970     struct match match_copy;
 971
 972     parse_ofp_str(fm, command, string, verbose);
 973
 974     /* Normalize a copy of the match.  This ensures that non-normalized flows
 975      * get logged but doesn't affect what gets sent to the switch, so that the
 976      * switch can do whatever it likes with the flow. */
 977     match_copy = fm->match;
 978     ofputil_normalize_match(&match_copy);
 979 }
 980
 981 void
 982 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
 983                         struct ofputil_flow_mod **fms, size_t *n_fms)
 984 {
 985     size_t allocated_fms;
 986     FILE *stream;
 987     struct ds s;
 988
 989     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
 990     if (stream == NULL) {
 991         ovs_fatal(errno, "%s: open", file_name);
 992     }
 993
 994     allocated_fms = *n_fms;
 995     ds_init(&s);
 996     while (!ds_get_preprocessed_line(&s, stream)) {
 997         if (*n_fms >= allocated_fms) {
 998             *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
 999         }
1000         parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1001         *n_fms += 1;
1002     }
1003     ds_destroy(&s);
1004
1005     if (stream != stdin) {
1006         fclose(stream);
1007     }
1008 }
1009
1010 void
1011 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1012                                  bool aggregate, const char *string)
1013 {
1014     struct ofputil_flow_mod fm;
1015
1016     parse_ofp_str(&fm, -1, string, false);
1017     fsr->aggregate = aggregate;
1018     fsr->cookie = fm.cookie;
1019     fsr->cookie_mask = fm.cookie_mask;
1020     fsr->match = fm.match;
1021     fsr->out_port = fm.out_port;
1022     fsr->table_id = fm.table_id;
1023 }
1024
1025 /* Parses a specification of a flow from 's' into 'flow'.  's' must take the
1026  * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1027  * mf_field.  Fields must be specified in a natural order for satisfying
1028  * prerequisites.
1029  *
1030  * Returns NULL on success, otherwise a malloc()'d string that explains the
1031  * problem. */
1032 char *
1033 parse_ofp_exact_flow(struct flow *flow, const char *s)
1034 {
1035     char *pos, *key, *value_s;
1036     char *error = NULL;
1037     char *copy;
1038
1039     memset(flow, 0, sizeof *flow);
1040
1041     pos = copy = xstrdup(s);
1042     while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1043         const struct protocol *p;
1044         if (parse_protocol(key, &p)) {
1045             if (flow->dl_type) {
1046                 error = xasprintf("%s: Ethernet type set multiple times", s);
1047                 goto exit;
1048             }
1049             flow->dl_type = htons(p->dl_type);
1050
1051             if (p->nw_proto) {
1052                 if (flow->nw_proto) {
1053                     error = xasprintf("%s: network protocol set "
1054                                       "multiple times", s);
1055                     goto exit;
1056                 }
1057                 flow->nw_proto = p->nw_proto;
1058             }
1059         } else {
1060             const struct mf_field *mf;
1061             union mf_value value;
1062             char *field_error;
1063
1064             mf = mf_from_name(key);
1065             if (!mf) {
1066                 error = xasprintf("%s: unknown field %s", s, key);
1067                 goto exit;
1068             }
1069
1070             if (!mf_are_prereqs_ok(mf, flow)) {
1071                 error = xasprintf("%s: prerequisites not met for setting %s",
1072                                   s, key);
1073                 goto exit;
1074             }
1075
1076             if (!mf_is_zero(mf, flow)) {
1077                 error = xasprintf("%s: field %s set multiple times", s, key);
1078                 goto exit;
1079             }
1080
1081             field_error = mf_parse_value(mf, value_s, &value);
1082             if (field_error) {
1083                 error = xasprintf("%s: bad value for %s (%s)",
1084                                   s, key, field_error);
1085                 free(field_error);
1086                 goto exit;
1087             }
1088
1089             mf_set_flow_value(mf, &value, flow);
1090         }
1091     }
1092
1093 exit:
1094     free(copy);
1095
1096     if (error) {
1097         memset(flow, 0, sizeof *flow);
1098     }
1099     return error;
1100 }