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