lib/ofp-parse.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 #include <netinet/in.h>
  25
  26 #include "byte-order.h"
  27 #include "dynamic-string.h"
  28 #include "learn.h"
  29 #include "meta-flow.h"
  30 #include "multipath.h"
  31 #include "netdev.h"
  32 #include "nx-match.h"
  33 #include "ofp-actions.h"
  34 #include "ofp-util.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "ovs-thread.h"
  38 #include "packets.h"
  39 #include "simap.h"
  40 #include "socket-util.h"
  41 #include "openvswitch/vconn.h"
  42
  43 /* Parses 'str' as an 8-bit unsigned integer into '*valuep'.
  44  *
  45  * 'name' describes the value parsed in an error message, if any.
  46  *
  47  * Returns NULL if successful, otherwise a malloc()'d string describing the
  48  * error.  The caller is responsible for freeing the returned string. */
  49 char * OVS_WARN_UNUSED_RESULT
  50 str_to_u8(const char *str, const char *name, uint8_t *valuep)
  51 {
  52     int value;
  53
  54     if (!str_to_int(str, 0, &value) || value < 0 || value > 255) {
  55         return xasprintf("invalid %s \"%s\"", name, str);
  56     }
  57     *valuep = value;
  58     return NULL;
  59 }
  60
  61 /* Parses 'str' as a 16-bit unsigned integer into '*valuep'.
  62  *
  63  * 'name' describes the value parsed in an error message, if any.
  64  *
  65  * Returns NULL if successful, otherwise a malloc()'d string describing the
  66  * error.  The caller is responsible for freeing the returned string. */
  67 char * OVS_WARN_UNUSED_RESULT
  68 str_to_u16(const char *str, const char *name, uint16_t *valuep)
  69 {
  70     int value;
  71
  72     if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
  73         return xasprintf("invalid %s \"%s\"", name, str);
  74     }
  75     *valuep = value;
  76     return NULL;
  77 }
  78
  79 /* Parses 'str' as a 32-bit unsigned integer into '*valuep'.
  80  *
  81  * Returns NULL if successful, otherwise a malloc()'d string describing the
  82  * error.  The caller is responsible for freeing the returned string. */
  83 char * OVS_WARN_UNUSED_RESULT
  84 str_to_u32(const char *str, uint32_t *valuep)
  85 {
  86     char *tail;
  87     uint32_t value;
  88
  89     if (!str[0]) {
  90         return xstrdup("missing required numeric argument");
  91     }
  92
  93     errno = 0;
  94     value = strtoul(str, &tail, 0);
  95     if (errno == EINVAL || errno == ERANGE || *tail) {
  96         return xasprintf("invalid numeric format %s", str);
  97     }
  98     *valuep = value;
  99     return NULL;
 100 }
 101
 102 /* Parses 'str' as an 64-bit unsigned integer into '*valuep'.
 103  *
 104  * Returns NULL if successful, otherwise a malloc()'d string describing the
 105  * error.  The caller is responsible for freeing the returned string. */
 106 char * OVS_WARN_UNUSED_RESULT
 107 str_to_u64(const char *str, uint64_t *valuep)
 108 {
 109     char *tail;
 110     uint64_t value;
 111
 112     if (!str[0]) {
 113         return xstrdup("missing required numeric argument");
 114     }
 115
 116     errno = 0;
 117     value = strtoull(str, &tail, 0);
 118     if (errno == EINVAL || errno == ERANGE || *tail) {
 119         return xasprintf("invalid numeric format %s", str);
 120     }
 121     *valuep = value;
 122     return NULL;
 123 }
 124
 125 /* Parses 'str' as an 64-bit unsigned integer in network byte order into
 126  * '*valuep'.
 127  *
 128  * Returns NULL if successful, otherwise a malloc()'d string describing the
 129  * error.  The caller is responsible for freeing the returned string. */
 130 char * OVS_WARN_UNUSED_RESULT
 131 str_to_be64(const char *str, ovs_be64 *valuep)
 132 {
 133     uint64_t value = 0;
 134     char *error;
 135
 136     error = str_to_u64(str, &value);
 137     if (!error) {
 138         *valuep = htonll(value);
 139     }
 140     return error;
 141 }
 142
 143 /* Parses 'str' as an Ethernet address into 'mac'.
 144  *
 145  * Returns NULL if successful, otherwise a malloc()'d string describing the
 146  * error.  The caller is responsible for freeing the returned string. */
 147 char * OVS_WARN_UNUSED_RESULT
 148 str_to_mac(const char *str, struct eth_addr *mac)
 149 {
 150     if (!ovs_scan(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(*mac))) {
 151         return xasprintf("invalid mac address %s", str);
 152     }
 153     return NULL;
 154 }
 155
 156 /* Parses 'str' as an IP address into '*ip'.
 157  *
 158  * Returns NULL if successful, otherwise a malloc()'d string describing the
 159  * error.  The caller is responsible for freeing the returned string. */
 160 char * OVS_WARN_UNUSED_RESULT
 161 str_to_ip(const char *str, ovs_be32 *ip)
 162 {
 163     struct in_addr in_addr;
 164
 165     if (lookup_ip(str, &in_addr)) {
 166         return xasprintf("%s: could not convert to IP address", str);
 167     }
 168     *ip = in_addr.s_addr;
 169     return NULL;
 170 }
 171
 172 /* Parses 'str' as a conntrack helper into 'alg'.
 173  *
 174  * Returns NULL if successful, otherwise a malloc()'d string describing the
 175  * error.  The caller is responsible for freeing the returned string. */
 176 char * OVS_WARN_UNUSED_RESULT
 177 str_to_connhelper(const char *str, uint16_t *alg)
 178 {
 179     if (!strcmp(str, "ftp")) {
 180         *alg = IPPORT_FTP;
 181         return NULL;
 182     }
 183     return xasprintf("invalid conntrack helper \"%s\"", str);
 184 }
 185
 186 struct protocol {
 187     const char *name;
 188     uint16_t dl_type;
 189     uint8_t nw_proto;
 190 };
 191
 192 static bool
 193 parse_protocol(const char *name, const struct protocol **p_out)
 194 {
 195     static const struct protocol protocols[] = {
 196         { "ip", ETH_TYPE_IP, 0 },
 197         { "ipv4", ETH_TYPE_IP, 0 },
 198         { "ip4", ETH_TYPE_IP, 0 },
 199         { "arp", ETH_TYPE_ARP, 0 },
 200         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
 201         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
 202         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
 203         { "sctp", ETH_TYPE_IP, IPPROTO_SCTP },
 204         { "ipv6", ETH_TYPE_IPV6, 0 },
 205         { "ip6", ETH_TYPE_IPV6, 0 },
 206         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
 207         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
 208         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
 209         { "sctp6", ETH_TYPE_IPV6, IPPROTO_SCTP },
 210         { "rarp", ETH_TYPE_RARP, 0},
 211         { "mpls", ETH_TYPE_MPLS, 0 },
 212         { "mplsm", ETH_TYPE_MPLS_MCAST, 0 },
 213     };
 214     const struct protocol *p;
 215
 216     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
 217         if (!strcmp(p->name, name)) {
 218             *p_out = p;
 219             return true;
 220         }
 221     }
 222     *p_out = NULL;
 223     return false;
 224 }
 225
 226 /* Parses 's' as the (possibly masked) value of field 'mf', and updates
 227  * 'match' appropriately.  Restricts the set of usable protocols to ones
 228  * supporting the parsed field.
 229  *
 230  * Returns NULL if successful, otherwise a malloc()'d string describing the
 231  * error.  The caller is responsible for freeing the returned string. */
 232 static char * OVS_WARN_UNUSED_RESULT
 233 parse_field(const struct mf_field *mf, const char *s, struct match *match,
 234             enum ofputil_protocol *usable_protocols)
 235 {
 236     union mf_value value, mask;
 237     char *error;
 238
 239     if (!*s) {
 240         /* If there's no string, we're just trying to match on the
 241          * existence of the field, so use a no-op value. */
 242         s = "0/0";
 243     }
 244
 245     error = mf_parse(mf, s, &value, &mask);
 246     if (!error) {
 247         *usable_protocols &= mf_set(mf, &value, &mask, match, &error);
 248     }
 249     return error;
 250 }
 251
 252 static char *
 253 extract_actions(char *s)
 254 {
 255     s = strstr(s, "action");
 256     if (s) {
 257         *s = '\0';
 258         s = strchr(s + 1, '=');
 259         return s ? s + 1 : NULL;
 260     } else {
 261         return NULL;
 262     }
 263 }
 264
 265
 266 static char * OVS_WARN_UNUSED_RESULT
 267 parse_ofp_str__(struct ofputil_flow_mod *fm, int command, char *string,
 268                 enum ofputil_protocol *usable_protocols)
 269 {
 270     enum {
 271         F_OUT_PORT = 1 << 0,
 272         F_ACTIONS = 1 << 1,
 273         F_IMPORTANCE = 1 << 2,
 274         F_TIMEOUT = 1 << 3,
 275         F_PRIORITY = 1 << 4,
 276         F_FLAGS = 1 << 5,
 277     } fields;
 278     char *act_str = NULL;
 279     char *name, *value;
 280
 281     *usable_protocols = OFPUTIL_P_ANY;
 282
 283     if (command == -2) {
 284         size_t len;
 285
 286         string += strspn(string, " \t\r\n");   /* Skip white space. */
 287         len = strcspn(string, ", \t\r\n"); /* Get length of the first token. */
 288
 289         if (!strncmp(string, "add", len)) {
 290             command = OFPFC_ADD;
 291         } else if (!strncmp(string, "delete", len)) {
 292             command = OFPFC_DELETE;
 293         } else if (!strncmp(string, "delete_strict", len)) {
 294             command = OFPFC_DELETE_STRICT;
 295         } else if (!strncmp(string, "modify", len)) {
 296             command = OFPFC_MODIFY;
 297         } else if (!strncmp(string, "modify_strict", len)) {
 298             command = OFPFC_MODIFY_STRICT;
 299         } else {
 300             len = 0;
 301             command = OFPFC_ADD;
 302         }
 303         string += len;
 304     }
 305
 306     switch (command) {
 307     case -1:
 308         fields = F_OUT_PORT;
 309         break;
 310
 311     case OFPFC_ADD:
 312         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS | F_IMPORTANCE;
 313         break;
 314
 315     case OFPFC_DELETE:
 316         fields = F_OUT_PORT;
 317         break;
 318
 319     case OFPFC_DELETE_STRICT:
 320         fields = F_OUT_PORT | F_PRIORITY;
 321         break;
 322
 323     case OFPFC_MODIFY:
 324         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 325         break;
 326
 327     case OFPFC_MODIFY_STRICT:
 328         fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
 329         break;
 330
 331     default:
 332         OVS_NOT_REACHED();
 333     }
 334
 335     *fm = (struct ofputil_flow_mod) {
 336         .match = MATCH_CATCHALL_INITIALIZER,
 337         .priority = OFP_DEFAULT_PRIORITY,
 338         .table_id = 0xff,
 339         .command = command,
 340         .buffer_id = UINT32_MAX,
 341         .out_port = OFPP_ANY,
 342         .out_group = OFPG_ANY,
 343         .delete_reason = OFPRR_DELETE,
 344     };
 345     /* For modify, by default, don't update the cookie. */
 346     if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
 347         fm->new_cookie = OVS_BE64_MAX;
 348     }
 349
 350     if (fields & F_ACTIONS) {
 351         act_str = extract_actions(string);
 352         if (!act_str) {
 353             return xstrdup("must specify an action");
 354         }
 355     }
 356
 357     while (ofputil_parse_key_value(&string, &name, &value)) {
 358         const struct protocol *p;
 359         char *error = NULL;
 360
 361         if (parse_protocol(name, &p)) {
 362             match_set_dl_type(&fm->match, htons(p->dl_type));
 363             if (p->nw_proto) {
 364                 match_set_nw_proto(&fm->match, p->nw_proto);
 365             }
 366         } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
 367             fm->flags |= OFPUTIL_FF_SEND_FLOW_REM;
 368         } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
 369             fm->flags |= OFPUTIL_FF_CHECK_OVERLAP;
 370         } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
 371             fm->flags |= OFPUTIL_FF_RESET_COUNTS;
 372             *usable_protocols &= OFPUTIL_P_OF12_UP;
 373         } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
 374             fm->flags |= OFPUTIL_FF_NO_PKT_COUNTS;
 375             *usable_protocols &= OFPUTIL_P_OF13_UP;
 376         } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
 377             fm->flags |= OFPUTIL_FF_NO_BYT_COUNTS;
 378             *usable_protocols &= OFPUTIL_P_OF13_UP;
 379         } else if (!strcmp(name, "no_readonly_table")
 380                    || !strcmp(name, "allow_hidden_fields")) {
 381              /* ignore these fields. */
 382         } else if (mf_from_name(name)) {
 383             error = parse_field(mf_from_name(name), value, &fm->match,
 384                                 usable_protocols);
 385         } else {
 386             if (!*value) {
 387                 return xasprintf("field %s missing value", name);
 388             }
 389
 390             if (!strcmp(name, "table")) {
 391                 error = str_to_u8(value, "table", &fm->table_id);
 392                 if (fm->table_id != 0xff) {
 393                     *usable_protocols &= OFPUTIL_P_TID;
 394                 }
 395             } else if (fields & F_OUT_PORT && !strcmp(name, "out_port")) {
 396                 if (!ofputil_port_from_string(value, &fm->out_port)) {
 397                     error = xasprintf("%s is not a valid OpenFlow port",
 398                                       value);
 399                 }
 400             } else if (fields & F_OUT_PORT && !strcmp(name, "out_group")) {
 401                 *usable_protocols &= OFPUTIL_P_OF11_UP;
 402                 if (!ofputil_group_from_string(value, &fm->out_group)) {
 403                     error = xasprintf("%s is not a valid OpenFlow group",
 404                                       value);
 405                 }
 406             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
 407                 uint16_t priority = 0;
 408
 409                 error = str_to_u16(value, name, &priority);
 410                 fm->priority = priority;
 411             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
 412                 error = str_to_u16(value, name, &fm->idle_timeout);
 413             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
 414                 error = str_to_u16(value, name, &fm->hard_timeout);
 415             } else if (fields & F_IMPORTANCE && !strcmp(name, "importance")) {
 416                 error = str_to_u16(value, name, &fm->importance);
 417             } else if (!strcmp(name, "cookie")) {
 418                 char *mask = strchr(value, '/');
 419
 420                 if (mask) {
 421                     /* A mask means we're searching for a cookie. */
 422                     if (command == OFPFC_ADD) {
 423                         return xstrdup("flow additions cannot use "
 424                                        "a cookie mask");
 425                     }
 426                     *mask = '\0';
 427                     error = str_to_be64(value, &fm->cookie);
 428                     if (error) {
 429                         return error;
 430                     }
 431                     error = str_to_be64(mask + 1, &fm->cookie_mask);
 432
 433                     /* Matching of the cookie is only supported through NXM or
 434                      * OF1.1+. */
 435                     if (fm->cookie_mask != htonll(0)) {
 436                         *usable_protocols &= OFPUTIL_P_NXM_OF11_UP;
 437                     }
 438                 } else {
 439                     /* No mask means that the cookie is being set. */
 440                     if (command != OFPFC_ADD && command != OFPFC_MODIFY
 441                         && command != OFPFC_MODIFY_STRICT) {
 442                         return xstrdup("cannot set cookie");
 443                     }
 444                     error = str_to_be64(value, &fm->new_cookie);
 445                     fm->modify_cookie = true;
 446                 }
 447             } else if (!strcmp(name, "duration")
 448                        || !strcmp(name, "n_packets")
 449                        || !strcmp(name, "n_bytes")
 450                        || !strcmp(name, "idle_age")
 451                        || !strcmp(name, "hard_age")) {
 452                 /* Ignore these, so that users can feed the output of
 453                  * "ovs-ofctl dump-flows" back into commands that parse
 454                  * flows. */
 455             } else {
 456                 error = xasprintf("unknown keyword %s", name);
 457             }
 458         }
 459
 460         if (error) {
 461             return error;
 462         }
 463     }
 464     /* Check for usable protocol interdependencies between match fields. */
 465     if (fm->match.flow.dl_type == htons(ETH_TYPE_IPV6)) {
 466         const struct flow_wildcards *wc = &fm->match.wc;
 467         /* Only NXM and OXM support matching L3 and L4 fields within IPv6.
 468          *
 469          * (IPv6 specific fields as well as arp_sha, arp_tha, nw_frag, and
 470          *  nw_ttl are covered elsewhere so they don't need to be included in
 471          *  this test too.)
 472          */
 473         if (wc->masks.nw_proto || wc->masks.nw_tos
 474             || wc->masks.tp_src || wc->masks.tp_dst) {
 475             *usable_protocols &= OFPUTIL_P_NXM_OXM_ANY;
 476         }
 477     }
 478     if (!fm->cookie_mask && fm->new_cookie == OVS_BE64_MAX
 479         && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
 480         /* On modifies without a mask, we are supposed to add a flow if
 481          * one does not exist.  If a cookie wasn't been specified, use a
 482          * default of zero. */
 483         fm->new_cookie = htonll(0);
 484     }
 485     if (fields & F_ACTIONS) {
 486         enum ofputil_protocol action_usable_protocols;
 487         struct ofpbuf ofpacts;
 488         char *error;
 489
 490         ofpbuf_init(&ofpacts, 32);
 491         error = ofpacts_parse_instructions(act_str, &ofpacts,
 492                                            &action_usable_protocols);
 493         *usable_protocols &= action_usable_protocols;
 494         if (!error) {
 495             enum ofperr err;
 496
 497             err = ofpacts_check(ofpacts.data, ofpacts.size, &fm->match.flow,
 498                                 OFPP_MAX, fm->table_id, 255, usable_protocols);
 499             if (!err && !*usable_protocols) {
 500                 err = OFPERR_OFPBAC_MATCH_INCONSISTENT;
 501             }
 502             if (err) {
 503                 error = xasprintf("actions are invalid with specified match "
 504                                   "(%s)", ofperr_to_string(err));
 505             }
 506
 507         }
 508         if (error) {
 509             ofpbuf_uninit(&ofpacts);
 510             return error;
 511         }
 512
 513         fm->ofpacts_len = ofpacts.size;
 514         fm->ofpacts = ofpbuf_steal_data(&ofpacts);
 515     } else {
 516         fm->ofpacts_len = 0;
 517         fm->ofpacts = NULL;
 518     }
 519
 520     return NULL;
 521 }
 522
 523 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
 524  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
 525  * Returns the set of usable protocols in '*usable_protocols'.
 526  *
 527  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
 528  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
 529  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'.
 530  *
 531  * If 'command' is given as -2, 'str_' may begin with a command name ("add",
 532  * "modify", "delete", "modify_strict", or "delete_strict").  A missing command
 533  * name is treated as "add".
 534  *
 535  * Returns NULL if successful, otherwise a malloc()'d string describing the
 536  * error.  The caller is responsible for freeing the returned string. */
 537 char * OVS_WARN_UNUSED_RESULT
 538 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
 539               enum ofputil_protocol *usable_protocols)
 540 {
 541     char *string = xstrdup(str_);
 542     char *error;
 543
 544     error = parse_ofp_str__(fm, command, string, usable_protocols);
 545     if (error) {
 546         fm->ofpacts = NULL;
 547         fm->ofpacts_len = 0;
 548     }
 549
 550     free(string);
 551     return error;
 552 }
 553
 554 static char * OVS_WARN_UNUSED_RESULT
 555 parse_ofp_meter_mod_str__(struct ofputil_meter_mod *mm, char *string,
 556                           struct ofpbuf *bands, int command,
 557                           enum ofputil_protocol *usable_protocols)
 558 {
 559     enum {
 560         F_METER = 1 << 0,
 561         F_FLAGS = 1 << 1,
 562         F_BANDS = 1 << 2,
 563     } fields;
 564     char *save_ptr = NULL;
 565     char *band_str = NULL;
 566     char *name;
 567
 568     /* Meters require at least OF 1.3. */
 569     *usable_protocols = OFPUTIL_P_OF13_UP;
 570
 571     switch (command) {
 572     case -1:
 573         fields = F_METER;
 574         break;
 575
 576     case OFPMC13_ADD:
 577         fields = F_METER | F_FLAGS | F_BANDS;
 578         break;
 579
 580     case OFPMC13_DELETE:
 581         fields = F_METER;
 582         break;
 583
 584     case OFPMC13_MODIFY:
 585         fields = F_METER | F_FLAGS | F_BANDS;
 586         break;
 587
 588     default:
 589         OVS_NOT_REACHED();
 590     }
 591
 592     mm->command = command;
 593     mm->meter.meter_id = 0;
 594     mm->meter.flags = 0;
 595     if (fields & F_BANDS) {
 596         band_str = strstr(string, "band");
 597         if (!band_str) {
 598             return xstrdup("must specify bands");
 599         }
 600         *band_str = '\0';
 601
 602         band_str = strchr(band_str + 1, '=');
 603         if (!band_str) {
 604             return xstrdup("must specify bands");
 605         }
 606
 607         band_str++;
 608     }
 609     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 610          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 611
 612         if (fields & F_FLAGS && !strcmp(name, "kbps")) {
 613             mm->meter.flags |= OFPMF13_KBPS;
 614         } else if (fields & F_FLAGS && !strcmp(name, "pktps")) {
 615             mm->meter.flags |= OFPMF13_PKTPS;
 616         } else if (fields & F_FLAGS && !strcmp(name, "burst")) {
 617             mm->meter.flags |= OFPMF13_BURST;
 618         } else if (fields & F_FLAGS && !strcmp(name, "stats")) {
 619             mm->meter.flags |= OFPMF13_STATS;
 620         } else {
 621             char *value;
 622
 623             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 624             if (!value) {
 625                 return xasprintf("field %s missing value", name);
 626             }
 627
 628             if (!strcmp(name, "meter")) {
 629                 if (!strcmp(value, "all")) {
 630                     mm->meter.meter_id = OFPM13_ALL;
 631                 } else if (!strcmp(value, "controller")) {
 632                     mm->meter.meter_id = OFPM13_CONTROLLER;
 633                 } else if (!strcmp(value, "slowpath")) {
 634                     mm->meter.meter_id = OFPM13_SLOWPATH;
 635                 } else {
 636                     char *error = str_to_u32(value, &mm->meter.meter_id);
 637                     if (error) {
 638                         return error;
 639                     }
 640                     if (mm->meter.meter_id > OFPM13_MAX
 641                         || !mm->meter.meter_id) {
 642                         return xasprintf("invalid value for %s", name);
 643                     }
 644                 }
 645             } else {
 646                 return xasprintf("unknown keyword %s", name);
 647             }
 648         }
 649     }
 650     if (fields & F_METER && !mm->meter.meter_id) {
 651         return xstrdup("must specify 'meter'");
 652     }
 653     if (fields & F_FLAGS && !mm->meter.flags) {
 654         return xstrdup("meter must specify either 'kbps' or 'pktps'");
 655     }
 656
 657     if (fields & F_BANDS) {
 658         uint16_t n_bands = 0;
 659         struct ofputil_meter_band *band = NULL;
 660         int i;
 661
 662         for (name = strtok_r(band_str, "=, \t\r\n", &save_ptr); name;
 663              name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 664
 665             char *value;
 666
 667             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 668             if (!value) {
 669                 return xasprintf("field %s missing value", name);
 670             }
 671
 672             if (!strcmp(name, "type")) {
 673                 /* Start a new band */
 674                 band = ofpbuf_put_zeros(bands, sizeof *band);
 675                 n_bands++;
 676
 677                 if (!strcmp(value, "drop")) {
 678                     band->type = OFPMBT13_DROP;
 679                 } else if (!strcmp(value, "dscp_remark")) {
 680                     band->type = OFPMBT13_DSCP_REMARK;
 681                 } else {
 682                     return xasprintf("field %s unknown value %s", name, value);
 683                 }
 684             } else if (!band || !band->type) {
 685                 return xstrdup("band must start with the 'type' keyword");
 686             } else if (!strcmp(name, "rate")) {
 687                 char *error = str_to_u32(value, &band->rate);
 688                 if (error) {
 689                     return error;
 690                 }
 691             } else if (!strcmp(name, "burst_size")) {
 692                 char *error = str_to_u32(value, &band->burst_size);
 693                 if (error) {
 694                     return error;
 695                 }
 696             } else if (!strcmp(name, "prec_level")) {
 697                 char *error = str_to_u8(value, name, &band->prec_level);
 698                 if (error) {
 699                     return error;
 700                 }
 701             } else {
 702                 return xasprintf("unknown keyword %s", name);
 703             }
 704         }
 705         /* validate bands */
 706         if (!n_bands) {
 707             return xstrdup("meter must have bands");
 708         }
 709
 710         mm->meter.n_bands = n_bands;
 711         mm->meter.bands = ofpbuf_steal_data(bands);
 712
 713         for (i = 0; i < n_bands; ++i) {
 714             band = &mm->meter.bands[i];
 715
 716             if (!band->type) {
 717                 return xstrdup("band must have 'type'");
 718             }
 719             if (band->type == OFPMBT13_DSCP_REMARK) {
 720                 if (!band->prec_level) {
 721                     return xstrdup("'dscp_remark' band must have"
 722                                    " 'prec_level'");
 723                 }
 724             } else {
 725                 if (band->prec_level) {
 726                     return xstrdup("Only 'dscp_remark' band may have"
 727                                    " 'prec_level'");
 728                 }
 729             }
 730             if (!band->rate) {
 731                 return xstrdup("band must have 'rate'");
 732             }
 733             if (mm->meter.flags & OFPMF13_BURST) {
 734                 if (!band->burst_size) {
 735                     return xstrdup("band must have 'burst_size' "
 736                                    "when 'burst' flag is set");
 737                 }
 738             } else {
 739                 if (band->burst_size) {
 740                     return xstrdup("band may have 'burst_size' only "
 741                                    "when 'burst' flag is set");
 742                 }
 743             }
 744         }
 745     } else {
 746         mm->meter.n_bands = 0;
 747         mm->meter.bands = NULL;
 748     }
 749
 750     return NULL;
 751 }
 752
 753 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
 754  * page) into 'mm' for sending the specified meter_mod 'command' to a switch.
 755  *
 756  * Returns NULL if successful, otherwise a malloc()'d string describing the
 757  * error.  The caller is responsible for freeing the returned string. */
 758 char * OVS_WARN_UNUSED_RESULT
 759 parse_ofp_meter_mod_str(struct ofputil_meter_mod *mm, const char *str_,
 760                         int command, enum ofputil_protocol *usable_protocols)
 761 {
 762     struct ofpbuf bands;
 763     char *string;
 764     char *error;
 765
 766     ofpbuf_init(&bands, 64);
 767     string = xstrdup(str_);
 768
 769     error = parse_ofp_meter_mod_str__(mm, string, &bands, command,
 770                                       usable_protocols);
 771
 772     free(string);
 773     ofpbuf_uninit(&bands);
 774
 775     return error;
 776 }
 777
 778 static char * OVS_WARN_UNUSED_RESULT
 779 parse_flow_monitor_request__(struct ofputil_flow_monitor_request *fmr,
 780                              const char *str_, char *string,
 781                              enum ofputil_protocol *usable_protocols)
 782 {
 783     static atomic_count id = ATOMIC_COUNT_INIT(0);
 784     char *name, *value;
 785
 786     fmr->id = atomic_count_inc(&id);
 787
 788     fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
 789                   | NXFMF_OWN | NXFMF_ACTIONS);
 790     fmr->out_port = OFPP_NONE;
 791     fmr->table_id = 0xff;
 792     match_init_catchall(&fmr->match);
 793
 794     while (ofputil_parse_key_value(&string, &name, &value)) {
 795         const struct protocol *p;
 796         char *error = NULL;
 797
 798         if (!strcmp(name, "!initial")) {
 799             fmr->flags &= ~NXFMF_INITIAL;
 800         } else if (!strcmp(name, "!add")) {
 801             fmr->flags &= ~NXFMF_ADD;
 802         } else if (!strcmp(name, "!delete")) {
 803             fmr->flags &= ~NXFMF_DELETE;
 804         } else if (!strcmp(name, "!modify")) {
 805             fmr->flags &= ~NXFMF_MODIFY;
 806         } else if (!strcmp(name, "!actions")) {
 807             fmr->flags &= ~NXFMF_ACTIONS;
 808         } else if (!strcmp(name, "!own")) {
 809             fmr->flags &= ~NXFMF_OWN;
 810         } else if (parse_protocol(name, &p)) {
 811             match_set_dl_type(&fmr->match, htons(p->dl_type));
 812             if (p->nw_proto) {
 813                 match_set_nw_proto(&fmr->match, p->nw_proto);
 814             }
 815         } else if (mf_from_name(name)) {
 816             error = parse_field(mf_from_name(name), value, &fmr->match,
 817                                 usable_protocols);
 818         } else {
 819             if (!*value) {
 820                 return xasprintf("%s: field %s missing value", str_, name);
 821             }
 822
 823             if (!strcmp(name, "table")) {
 824                 error = str_to_u8(value, "table", &fmr->table_id);
 825             } else if (!strcmp(name, "out_port")) {
 826                 fmr->out_port = u16_to_ofp(atoi(value));
 827             } else {
 828                 return xasprintf("%s: unknown keyword %s", str_, name);
 829             }
 830         }
 831
 832         if (error) {
 833             return error;
 834         }
 835     }
 836     return NULL;
 837 }
 838
 839 /* Convert 'str_' (as described in the documentation for the "monitor" command
 840  * in the ovs-ofctl man page) into 'fmr'.
 841  *
 842  * Returns NULL if successful, otherwise a malloc()'d string describing the
 843  * error.  The caller is responsible for freeing the returned string. */
 844 char * OVS_WARN_UNUSED_RESULT
 845 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
 846                            const char *str_,
 847                            enum ofputil_protocol *usable_protocols)
 848 {
 849     char *string = xstrdup(str_);
 850     char *error = parse_flow_monitor_request__(fmr, str_, string,
 851                                                usable_protocols);
 852     free(string);
 853     return error;
 854 }
 855
 856 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
 857  * (one of OFPFC_*) into 'fm'.
 858  *
 859  * If 'command' is given as -2, 'string' may begin with a command name ("add",
 860  * "modify", "delete", "modify_strict", or "delete_strict").  A missing command
 861  * name is treated as "add".
 862  *
 863  * Returns NULL if successful, otherwise a malloc()'d string describing the
 864  * error.  The caller is responsible for freeing the returned string. */
 865 char * OVS_WARN_UNUSED_RESULT
 866 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
 867                        int command,
 868                        enum ofputil_protocol *usable_protocols)
 869 {
 870     char *error = parse_ofp_str(fm, command, string, usable_protocols);
 871
 872     if (!error) {
 873         /* Normalize a copy of the match.  This ensures that non-normalized
 874          * flows get logged but doesn't affect what gets sent to the switch, so
 875          * that the switch can do whatever it likes with the flow. */
 876         struct match match_copy = fm->match;
 877         ofputil_normalize_match(&match_copy);
 878     }
 879
 880     return error;
 881 }
 882
 883 /* Convert 'setting' (as described for the "mod-table" command
 884  * in ovs-ofctl man page) into 'tm->table_vacancy->vacancy_up' and
 885  * 'tm->table_vacancy->vacancy_down' threshold values.
 886  * For the two threshold values, value of vacancy_up is always greater
 887  * than value of vacancy_down.
 888  *
 889  * Returns NULL if successful, otherwise a malloc()'d string describing the
 890  * error.  The caller is responsible for freeing the returned string. */
 891 char * OVS_WARN_UNUSED_RESULT
 892 parse_ofp_table_vacancy(struct ofputil_table_mod *tm, const char *setting)
 893 {
 894     char *save_ptr = NULL;
 895     char *vac_up, *vac_down;
 896     char *value = strdup(setting);
 897     int vacancy_up, vacancy_down;
 898
 899     strtok_r(value, ":", &save_ptr);
 900     vac_down = strtok_r(NULL, ",", &save_ptr);
 901     if (!vac_down) {
 902         return xasprintf("Vacancy down value missing");
 903     }
 904     if (!str_to_int(vac_down, 0, &vacancy_down) ||
 905         vacancy_down < 0 || vacancy_down > 100) {
 906         return xasprintf("Invalid vacancy down value \"%s\"", vac_down);
 907     }
 908     vac_up = strtok_r(NULL, ",", &save_ptr);
 909     if (!vac_up) {
 910         return xasprintf("Vacancy up value missing");
 911     }
 912     if (!str_to_int(vac_up, 0, &vacancy_up) ||
 913         vacancy_up < 0 || vacancy_up > 100) {
 914         return xasprintf("Invalid vacancy up value \"%s\"", vac_up);
 915     }
 916     if (vacancy_down > vacancy_up) {
 917         return xasprintf("Invalid vacancy range, vacancy up should be greater"
 918                          " than vacancy down ""(%s)",
 919                          ofperr_to_string(OFPERR_OFPBPC_BAD_VALUE));
 920     }
 921     tm->table_vacancy.vacancy_down = vacancy_down;
 922     tm->table_vacancy.vacancy_up = vacancy_up;
 923     return NULL;
 924 }
 925
 926 /* Convert 'table_id' and 'setting' (as described for the "mod-table" command
 927  * in the ovs-ofctl man page) into 'tm' for sending a table_mod command to a
 928  * switch.
 929  *
 930  * Stores a bitmap of the OpenFlow versions that are usable for 'tm' into
 931  * '*usable_versions'.
 932  *
 933  * Returns NULL if successful, otherwise a malloc()'d string describing the
 934  * error.  The caller is responsible for freeing the returned string. */
 935 char * OVS_WARN_UNUSED_RESULT
 936 parse_ofp_table_mod(struct ofputil_table_mod *tm, const char *table_id,
 937                     const char *setting, uint32_t *usable_versions)
 938 {
 939     *usable_versions = 0;
 940     if (!strcasecmp(table_id, "all")) {
 941         tm->table_id = OFPTT_ALL;
 942     } else {
 943         char *error = str_to_u8(table_id, "table_id", &tm->table_id);
 944         if (error) {
 945             return error;
 946         }
 947     }
 948
 949     tm->miss = OFPUTIL_TABLE_MISS_DEFAULT;
 950     tm->eviction = OFPUTIL_TABLE_EVICTION_DEFAULT;
 951     tm->eviction_flags = UINT32_MAX;
 952     tm->vacancy = OFPUTIL_TABLE_VACANCY_DEFAULT;
 953     tm->table_vacancy.vacancy_down = 0;
 954     tm->table_vacancy.vacancy_up = 0;
 955     tm->table_vacancy.vacancy = 0;
 956     /* Only OpenFlow 1.1 and 1.2 can configure table-miss via table_mod.
 957      * Only OpenFlow 1.4+ can configure eviction and vacancy events
 958      * via table_mod.
 959      */
 960     if (!strcmp(setting, "controller")) {
 961         tm->miss = OFPUTIL_TABLE_MISS_CONTROLLER;
 962         *usable_versions = (1u << OFP11_VERSION) | (1u << OFP12_VERSION);
 963     } else if (!strcmp(setting, "continue")) {
 964         tm->miss = OFPUTIL_TABLE_MISS_CONTINUE;
 965         *usable_versions = (1u << OFP11_VERSION) | (1u << OFP12_VERSION);
 966     } else if (!strcmp(setting, "drop")) {
 967         tm->miss = OFPUTIL_TABLE_MISS_DROP;
 968         *usable_versions = (1u << OFP11_VERSION) | (1u << OFP12_VERSION);
 969     } else if (!strcmp(setting, "evict")) {
 970         tm->eviction = OFPUTIL_TABLE_EVICTION_ON;
 971         *usable_versions = (1 << OFP14_VERSION) | (1u << OFP15_VERSION);
 972     } else if (!strcmp(setting, "noevict")) {
 973         tm->eviction = OFPUTIL_TABLE_EVICTION_OFF;
 974         *usable_versions = (1 << OFP14_VERSION) | (1u << OFP15_VERSION);
 975     } else if (!strncmp(setting, "vacancy", strcspn(setting, ":"))) {
 976         tm->vacancy = OFPUTIL_TABLE_VACANCY_ON;
 977         *usable_versions = (1 << OFP14_VERSION) | (1u << OFP15_VERSION);
 978         char *error = parse_ofp_table_vacancy(tm, setting);
 979         if (error) {
 980             return error;
 981         }
 982     } else if (!strcmp(setting, "novacancy")) {
 983         tm->vacancy = OFPUTIL_TABLE_VACANCY_OFF;
 984         *usable_versions = (1 << OFP14_VERSION) | (1u << OFP15_VERSION);
 985     } else {
 986         return xasprintf("invalid table_mod setting %s", setting);
 987     }
 988
 989     if (tm->table_id == 0xfe
 990         && tm->miss == OFPUTIL_TABLE_MISS_CONTINUE) {
 991         return xstrdup("last table's flow miss handling can not be continue");
 992     }
 993
 994     return NULL;
 995 }
 996
 997
 998 /* Opens file 'file_name' and reads each line as a flow_mod of the specified
 999  * type (one of OFPFC_*).  Stores each flow_mod in '*fm', an array allocated
1000  * on the caller's behalf, and the number of flow_mods in '*n_fms'.
1001  *
1002  * If 'command' is given as -2, each line may start with a command name
1003  * ("add", "modify", "delete", "modify_strict", or "delete_strict").  A missing
1004  * command name is treated as "add".
1005  *
1006  * Returns NULL if successful, otherwise a malloc()'d string describing the
1007  * error.  The caller is responsible for freeing the returned string. */
1008 char * OVS_WARN_UNUSED_RESULT
1009 parse_ofp_flow_mod_file(const char *file_name, int command,
1010                         struct ofputil_flow_mod **fms, size_t *n_fms,
1011                         enum ofputil_protocol *usable_protocols)
1012 {
1013     size_t allocated_fms;
1014     int line_number;
1015     FILE *stream;
1016     struct ds s;
1017
1018     *usable_protocols = OFPUTIL_P_ANY;
1019
1020     *fms = NULL;
1021     *n_fms = 0;
1022
1023     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1024     if (stream == NULL) {
1025         return xasprintf("%s: open failed (%s)",
1026                          file_name, ovs_strerror(errno));
1027     }
1028
1029     allocated_fms = *n_fms;
1030     ds_init(&s);
1031     line_number = 0;
1032     while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
1033         char *error;
1034         enum ofputil_protocol usable;
1035
1036         if (*n_fms >= allocated_fms) {
1037             *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1038         }
1039         error = parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command,
1040                                        &usable);
1041         if (error) {
1042             size_t i;
1043
1044             for (i = 0; i < *n_fms; i++) {
1045                 free(CONST_CAST(struct ofpact *, (*fms)[i].ofpacts));
1046             }
1047             free(*fms);
1048             *fms = NULL;
1049             *n_fms = 0;
1050
1051             ds_destroy(&s);
1052             if (stream != stdin) {
1053                 fclose(stream);
1054             }
1055
1056             return xasprintf("%s:%d: %s", file_name, line_number, error);
1057         }
1058         *usable_protocols &= usable; /* Each line can narrow the set. */
1059         *n_fms += 1;
1060     }
1061
1062     ds_destroy(&s);
1063     if (stream != stdin) {
1064         fclose(stream);
1065     }
1066     return NULL;
1067 }
1068
1069 char * OVS_WARN_UNUSED_RESULT
1070 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1071                                  bool aggregate, const char *string,
1072                                  enum ofputil_protocol *usable_protocols)
1073 {
1074     struct ofputil_flow_mod fm;
1075     char *error;
1076
1077     error = parse_ofp_str(&fm, -1, string, usable_protocols);
1078     if (error) {
1079         return error;
1080     }
1081
1082     /* Special table ID support not required for stats requests. */
1083     if (*usable_protocols & OFPUTIL_P_OF10_STD_TID) {
1084         *usable_protocols |= OFPUTIL_P_OF10_STD;
1085     }
1086     if (*usable_protocols & OFPUTIL_P_OF10_NXM_TID) {
1087         *usable_protocols |= OFPUTIL_P_OF10_NXM;
1088     }
1089
1090     fsr->aggregate = aggregate;
1091     fsr->cookie = fm.cookie;
1092     fsr->cookie_mask = fm.cookie_mask;
1093     fsr->match = fm.match;
1094     fsr->out_port = fm.out_port;
1095     fsr->out_group = fm.out_group;
1096     fsr->table_id = fm.table_id;
1097     return NULL;
1098 }
1099
1100 /* Parses a specification of a flow from 's' into 'flow'.  's' must take the
1101  * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1102  * mf_field.  Fields must be specified in a natural order for satisfying
1103  * prerequisites. If 'mask' is specified, fills the mask field for each of the
1104  * field specified in flow. If the map, 'names_portno' is specfied, converts
1105  * the in_port name into port no while setting the 'flow'.
1106  *
1107  * Returns NULL on success, otherwise a malloc()'d string that explains the
1108  * problem. */
1109 char *
1110 parse_ofp_exact_flow(struct flow *flow, struct flow *mask, const char *s,
1111                      const struct simap *portno_names)
1112 {
1113     char *pos, *key, *value_s;
1114     char *error = NULL;
1115     char *copy;
1116
1117     memset(flow, 0, sizeof *flow);
1118     if (mask) {
1119         memset(mask, 0, sizeof *mask);
1120     }
1121
1122     pos = copy = xstrdup(s);
1123     while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1124         const struct protocol *p;
1125         if (parse_protocol(key, &p)) {
1126             if (flow->dl_type) {
1127                 error = xasprintf("%s: Ethernet type set multiple times", s);
1128                 goto exit;
1129             }
1130             flow->dl_type = htons(p->dl_type);
1131             if (mask) {
1132                 mask->dl_type = OVS_BE16_MAX;
1133             }
1134
1135             if (p->nw_proto) {
1136                 if (flow->nw_proto) {
1137                     error = xasprintf("%s: network protocol set "
1138                                       "multiple times", s);
1139                     goto exit;
1140                 }
1141                 flow->nw_proto = p->nw_proto;
1142                 if (mask) {
1143                     mask->nw_proto = UINT8_MAX;
1144                 }
1145             }
1146         } else {
1147             const struct mf_field *mf;
1148             union mf_value value;
1149             char *field_error;
1150
1151             mf = mf_from_name(key);
1152             if (!mf) {
1153                 error = xasprintf("%s: unknown field %s", s, key);
1154                 goto exit;
1155             }
1156
1157             if (!mf_are_prereqs_ok(mf, flow)) {
1158                 error = xasprintf("%s: prerequisites not met for setting %s",
1159                                   s, key);
1160                 goto exit;
1161             }
1162
1163             if (mf_is_set(mf, flow)) {
1164                 error = xasprintf("%s: field %s set multiple times", s, key);
1165                 goto exit;
1166             }
1167
1168             if (!strcmp(key, "in_port")
1169                 && portno_names
1170                 && simap_contains(portno_names, value_s)) {
1171                 flow->in_port.ofp_port = u16_to_ofp(
1172                     simap_get(portno_names, value_s));
1173                 if (mask) {
1174                     mask->in_port.ofp_port = u16_to_ofp(ntohs(OVS_BE16_MAX));
1175                 }
1176             } else {
1177                 field_error = mf_parse_value(mf, value_s, &value);
1178                 if (field_error) {
1179                     error = xasprintf("%s: bad value for %s (%s)",
1180                                       s, key, field_error);
1181                     free(field_error);
1182                     goto exit;
1183                 }
1184
1185                 mf_set_flow_value(mf, &value, flow);
1186                 if (mask) {
1187                     mf_mask_field(mf, mask);
1188                 }
1189             }
1190         }
1191     }
1192
1193     if (!flow->in_port.ofp_port) {
1194         flow->in_port.ofp_port = OFPP_NONE;
1195     }
1196
1197 exit:
1198     free(copy);
1199
1200     if (error) {
1201         memset(flow, 0, sizeof *flow);
1202         if (mask) {
1203             memset(mask, 0, sizeof *mask);
1204         }
1205     }
1206     return error;
1207 }
1208
1209 static char * OVS_WARN_UNUSED_RESULT
1210 parse_bucket_str(struct ofputil_bucket *bucket, char *str_, uint8_t group_type,
1211                   enum ofputil_protocol *usable_protocols)
1212 {
1213     char *pos, *key, *value;
1214     struct ofpbuf ofpacts;
1215     struct ds actions;
1216     char *error;
1217
1218     bucket->weight = group_type == OFPGT11_SELECT ? 1 : 0;
1219     bucket->bucket_id = OFPG15_BUCKET_ALL;
1220     bucket->watch_port = OFPP_ANY;
1221     bucket->watch_group = OFPG_ANY;
1222
1223     ds_init(&actions);
1224
1225     pos = str_;
1226     error = NULL;
1227     while (ofputil_parse_key_value(&pos, &key, &value)) {
1228         if (!strcasecmp(key, "weight")) {
1229             error = str_to_u16(value, "weight", &bucket->weight);
1230         } else if (!strcasecmp(key, "watch_port")) {
1231             if (!ofputil_port_from_string(value, &bucket->watch_port)
1232                 || (ofp_to_u16(bucket->watch_port) >= ofp_to_u16(OFPP_MAX)
1233                     && bucket->watch_port != OFPP_ANY)) {
1234                 error = xasprintf("%s: invalid watch_port", value);
1235             }
1236         } else if (!strcasecmp(key, "watch_group")) {
1237             error = str_to_u32(value, &bucket->watch_group);
1238             if (!error && bucket->watch_group > OFPG_MAX) {
1239                 error = xasprintf("invalid watch_group id %"PRIu32,
1240                                   bucket->watch_group);
1241             }
1242         } else if (!strcasecmp(key, "bucket_id")) {
1243             error = str_to_u32(value, &bucket->bucket_id);
1244             if (!error && bucket->bucket_id > OFPG15_BUCKET_MAX) {
1245                 error = xasprintf("invalid bucket_id id %"PRIu32,
1246                                   bucket->bucket_id);
1247             }
1248             *usable_protocols &= OFPUTIL_P_OF15_UP;
1249         } else if (!strcasecmp(key, "action") || !strcasecmp(key, "actions")) {
1250             ds_put_format(&actions, "%s,", value);
1251         } else {
1252             ds_put_format(&actions, "%s(%s),", key, value);
1253         }
1254
1255         if (error) {
1256             ds_destroy(&actions);
1257             return error;
1258         }
1259     }
1260
1261     if (!actions.length) {
1262         return xstrdup("bucket must specify actions");
1263     }
1264     ds_chomp(&actions, ',');
1265
1266     ofpbuf_init(&ofpacts, 0);
1267     error = ofpacts_parse_actions(ds_cstr(&actions), &ofpacts,
1268                                   usable_protocols);
1269     ds_destroy(&actions);
1270     if (error) {
1271         ofpbuf_uninit(&ofpacts);
1272         return error;
1273     }
1274     bucket->ofpacts = ofpacts.data;
1275     bucket->ofpacts_len = ofpacts.size;
1276
1277     return NULL;
1278 }
1279
1280 static char * OVS_WARN_UNUSED_RESULT
1281 parse_select_group_field(char *s, struct field_array *fa,
1282                          enum ofputil_protocol *usable_protocols)
1283 {
1284     char *name, *value_str;
1285
1286     while (ofputil_parse_key_value(&s, &name, &value_str)) {
1287         const struct mf_field *mf = mf_from_name(name);
1288
1289         if (mf) {
1290             char *error;
1291             union mf_value value;
1292
1293             if (bitmap_is_set(fa->used.bm, mf->id)) {
1294                 return xasprintf("%s: duplicate field", name);
1295             }
1296
1297             if (*value_str) {
1298                 error = mf_parse_value(mf, value_str, &value);
1299                 if (error) {
1300                     return error;
1301                 }
1302
1303                 /* The mask cannot be all-zeros */
1304                 if (!mf_is_tun_metadata(mf) &&
1305                     is_all_zeros(&value, mf->n_bytes)) {
1306                     return xasprintf("%s: values are wildcards here "
1307                                      "and must not be all-zeros", s);
1308                 }
1309
1310                 /* The values parsed are masks for fields used
1311                  * by the selection method */
1312                 if (!mf_is_mask_valid(mf, &value)) {
1313                     return xasprintf("%s: invalid mask for field %s",
1314                                      value_str, mf->name);
1315                 }
1316             } else {
1317                 memset(&value, 0xff, mf->n_bytes);
1318             }
1319
1320             field_array_set(mf->id, &value, fa);
1321
1322             if (is_all_ones(&value, mf->n_bytes)) {
1323                 *usable_protocols &= mf->usable_protocols_exact;
1324             } else if (mf->usable_protocols_bitwise == mf->usable_protocols_cidr
1325                        || ip_is_cidr(value.be32)) {
1326                 *usable_protocols &= mf->usable_protocols_cidr;
1327             } else {
1328                 *usable_protocols &= mf->usable_protocols_bitwise;
1329             }
1330         } else {
1331             return xasprintf("%s: unknown field %s", s, name);
1332         }
1333     }
1334
1335     return NULL;
1336 }
1337
1338 static char * OVS_WARN_UNUSED_RESULT
1339 parse_ofp_group_mod_str__(struct ofputil_group_mod *gm, uint16_t command,
1340                           char *string,
1341                           enum ofputil_protocol *usable_protocols)
1342 {
1343     enum {
1344         F_GROUP_TYPE            = 1 << 0,
1345         F_BUCKETS               = 1 << 1,
1346         F_COMMAND_BUCKET_ID     = 1 << 2,
1347         F_COMMAND_BUCKET_ID_ALL = 1 << 3,
1348     } fields;
1349     bool had_type = false;
1350     bool had_command_bucket_id = false;
1351     struct ofputil_bucket *bucket;
1352     char *error = NULL;
1353
1354     *usable_protocols = OFPUTIL_P_OF11_UP;
1355
1356     switch (command) {
1357     case OFPGC11_ADD:
1358         fields = F_GROUP_TYPE | F_BUCKETS;
1359         break;
1360
1361     case OFPGC11_DELETE:
1362         fields = 0;
1363         break;
1364
1365     case OFPGC11_MODIFY:
1366         fields = F_GROUP_TYPE | F_BUCKETS;
1367         break;
1368
1369     case OFPGC15_INSERT_BUCKET:
1370         fields = F_BUCKETS | F_COMMAND_BUCKET_ID;
1371         *usable_protocols &= OFPUTIL_P_OF15_UP;
1372         break;
1373
1374     case OFPGC15_REMOVE_BUCKET:
1375         fields = F_COMMAND_BUCKET_ID | F_COMMAND_BUCKET_ID_ALL;
1376         *usable_protocols &= OFPUTIL_P_OF15_UP;
1377         break;
1378
1379     default:
1380         OVS_NOT_REACHED();
1381     }
1382
1383     memset(gm, 0, sizeof *gm);
1384     gm->command = command;
1385     gm->group_id = OFPG_ANY;
1386     gm->command_bucket_id = OFPG15_BUCKET_ALL;
1387     list_init(&gm->buckets);
1388     if (command == OFPGC11_DELETE && string[0] == '\0') {
1389         gm->group_id = OFPG_ALL;
1390         return NULL;
1391     }
1392
1393     *usable_protocols = OFPUTIL_P_OF11_UP;
1394
1395     /* Strip the buckets off the end of 'string', if there are any, saving a
1396      * pointer for later.  We want to parse the buckets last because the bucket
1397      * type influences bucket defaults. */
1398     char *bkt_str = strstr(string, "bucket=");
1399     if (bkt_str) {
1400         if (!(fields & F_BUCKETS)) {
1401             error = xstrdup("bucket is not needed");
1402             goto out;
1403         }
1404         *bkt_str = '\0';
1405     }
1406
1407     /* Parse everything before the buckets. */
1408     char *pos = string;
1409     char *name, *value;
1410     while (ofputil_parse_key_value(&pos, &name, &value)) {
1411         if (!strcmp(name, "command_bucket_id")) {
1412             if (!(fields & F_COMMAND_BUCKET_ID)) {
1413                 error = xstrdup("command bucket id is not needed");
1414                 goto out;
1415             }
1416             if (!strcmp(value, "all")) {
1417                 gm->command_bucket_id = OFPG15_BUCKET_ALL;
1418             } else if (!strcmp(value, "first")) {
1419                 gm->command_bucket_id = OFPG15_BUCKET_FIRST;
1420             } else if (!strcmp(value, "last")) {
1421                 gm->command_bucket_id = OFPG15_BUCKET_LAST;
1422             } else {
1423                 error = str_to_u32(value, &gm->command_bucket_id);
1424                 if (error) {
1425                     goto out;
1426                 }
1427                 if (gm->command_bucket_id > OFPG15_BUCKET_MAX
1428                     && (gm->command_bucket_id != OFPG15_BUCKET_FIRST
1429                         && gm->command_bucket_id != OFPG15_BUCKET_LAST
1430                         && gm->command_bucket_id != OFPG15_BUCKET_ALL)) {
1431                     error = xasprintf("invalid command bucket id %"PRIu32,
1432                                       gm->command_bucket_id);
1433                     goto out;
1434                 }
1435             }
1436             if (gm->command_bucket_id == OFPG15_BUCKET_ALL
1437                 && !(fields & F_COMMAND_BUCKET_ID_ALL)) {
1438                 error = xstrdup("command_bucket_id=all is not permitted");
1439                 goto out;
1440             }
1441             had_command_bucket_id = true;
1442         } else if (!strcmp(name, "group_id")) {
1443             if(!strcmp(value, "all")) {
1444                 gm->group_id = OFPG_ALL;
1445             } else {
1446                 error = str_to_u32(value, &gm->group_id);
1447                 if (error) {
1448                     goto out;
1449                 }
1450                 if (gm->group_id != OFPG_ALL && gm->group_id > OFPG_MAX) {
1451                     error = xasprintf("invalid group id %"PRIu32,
1452                                       gm->group_id);
1453                     goto out;
1454                 }
1455             }
1456         } else if (!strcmp(name, "type")){
1457             if (!(fields & F_GROUP_TYPE)) {
1458                 error = xstrdup("type is not needed");
1459                 goto out;
1460             }
1461             if (!strcmp(value, "all")) {
1462                 gm->type = OFPGT11_ALL;
1463             } else if (!strcmp(value, "select")) {
1464                 gm->type = OFPGT11_SELECT;
1465             } else if (!strcmp(value, "indirect")) {
1466                 gm->type = OFPGT11_INDIRECT;
1467             } else if (!strcmp(value, "ff") ||
1468                        !strcmp(value, "fast_failover")) {
1469                 gm->type = OFPGT11_FF;
1470             } else {
1471                 error = xasprintf("invalid group type %s", value);
1472                 goto out;
1473             }
1474             had_type = true;
1475         } else if (!strcmp(name, "selection_method")) {
1476             if (!(fields & F_GROUP_TYPE)) {
1477                 error = xstrdup("selection method is not needed");
1478                 goto out;
1479             }
1480             if (strlen(value) >= NTR_MAX_SELECTION_METHOD_LEN) {
1481                 error = xasprintf("selection method is longer than %u"
1482                                   " bytes long",
1483                                   NTR_MAX_SELECTION_METHOD_LEN - 1);
1484                 goto out;
1485             }
1486             memset(gm->props.selection_method, '\0',
1487                    NTR_MAX_SELECTION_METHOD_LEN);
1488             strcpy(gm->props.selection_method, value);
1489             *usable_protocols &= OFPUTIL_P_OF15_UP;
1490         } else if (!strcmp(name, "selection_method_param")) {
1491             if (!(fields & F_GROUP_TYPE)) {
1492                 error = xstrdup("selection method param is not needed");
1493                 goto out;
1494             }
1495             error = str_to_u64(value, &gm->props.selection_method_param);
1496             if (error) {
1497                 goto out;
1498             }
1499             *usable_protocols &= OFPUTIL_P_OF15_UP;
1500         } else if (!strcmp(name, "fields")) {
1501             if (!(fields & F_GROUP_TYPE)) {
1502                 error = xstrdup("fields are not needed");
1503                 goto out;
1504             }
1505             error = parse_select_group_field(value, &gm->props.fields,
1506                                              usable_protocols);
1507             if (error) {
1508                 goto out;
1509             }
1510             *usable_protocols &= OFPUTIL_P_OF15_UP;
1511         } else {
1512             error = xasprintf("unknown keyword %s", name);
1513             goto out;
1514         }
1515     }
1516     if (gm->group_id == OFPG_ANY) {
1517         error = xstrdup("must specify a group_id");
1518         goto out;
1519     }
1520     if (fields & F_GROUP_TYPE && !had_type) {
1521         error = xstrdup("must specify a type");
1522         goto out;
1523     }
1524
1525     if (fields & F_COMMAND_BUCKET_ID) {
1526         if (!(fields & F_COMMAND_BUCKET_ID_ALL || had_command_bucket_id)) {
1527             error = xstrdup("must specify a command bucket id");
1528             goto out;
1529         }
1530     } else if (had_command_bucket_id) {
1531         error = xstrdup("command bucket id is not needed");
1532         goto out;
1533     }
1534
1535     /* Now parse the buckets, if any. */
1536     while (bkt_str) {
1537         char *next_bkt_str;
1538
1539         bkt_str = strchr(bkt_str + 1, '=');
1540         if (!bkt_str) {
1541             error = xstrdup("must specify bucket content");
1542             goto out;
1543         }
1544         bkt_str++;
1545
1546         next_bkt_str = strstr(bkt_str, "bucket=");
1547         if (next_bkt_str) {
1548             *next_bkt_str = '\0';
1549         }
1550
1551         bucket = xzalloc(sizeof(struct ofputil_bucket));
1552         error = parse_bucket_str(bucket, bkt_str, gm->type, usable_protocols);
1553         if (error) {
1554             free(bucket);
1555             goto out;
1556         }
1557         list_push_back(&gm->buckets, &bucket->list_node);
1558
1559         if (gm->type != OFPGT11_SELECT && bucket->weight) {
1560             error = xstrdup("Only select groups can have bucket weights.");
1561             goto out;
1562         }
1563
1564         bkt_str = next_bkt_str;
1565     }
1566     if (gm->type == OFPGT11_INDIRECT && !list_is_short(&gm->buckets)) {
1567         error = xstrdup("Indirect groups can have at most one bucket.");
1568         goto out;
1569     }
1570
1571     return NULL;
1572  out:
1573     ofputil_bucket_list_destroy(&gm->buckets);
1574     return error;
1575 }
1576
1577 char * OVS_WARN_UNUSED_RESULT
1578 parse_ofp_group_mod_str(struct ofputil_group_mod *gm, uint16_t command,
1579                         const char *str_,
1580                         enum ofputil_protocol *usable_protocols)
1581 {
1582     char *string = xstrdup(str_);
1583     char *error = parse_ofp_group_mod_str__(gm, command, string,
1584                                             usable_protocols);
1585     free(string);
1586
1587     if (error) {
1588         ofputil_bucket_list_destroy(&gm->buckets);
1589     }
1590     return error;
1591 }
1592
1593 char * OVS_WARN_UNUSED_RESULT
1594 parse_ofp_group_mod_file(const char *file_name, uint16_t command,
1595                          struct ofputil_group_mod **gms, size_t *n_gms,
1596                          enum ofputil_protocol *usable_protocols)
1597 {
1598     size_t allocated_gms;
1599     int line_number;
1600     FILE *stream;
1601     struct ds s;
1602
1603     *gms = NULL;
1604     *n_gms = 0;
1605
1606     stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1607     if (stream == NULL) {
1608         return xasprintf("%s: open failed (%s)",
1609                          file_name, ovs_strerror(errno));
1610     }
1611
1612     allocated_gms = *n_gms;
1613     ds_init(&s);
1614     line_number = 0;
1615     *usable_protocols = OFPUTIL_P_OF11_UP;
1616     while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
1617         enum ofputil_protocol usable;
1618         char *error;
1619
1620         if (*n_gms >= allocated_gms) {
1621             struct ofputil_group_mod *new_gms;
1622             size_t i;
1623
1624             new_gms = x2nrealloc(*gms, &allocated_gms, sizeof **gms);
1625             for (i = 0; i < *n_gms; i++) {
1626                 list_moved(&new_gms[i].buckets, &(*gms)[i].buckets);
1627             }
1628             *gms = new_gms;
1629         }
1630         error = parse_ofp_group_mod_str(&(*gms)[*n_gms], command, ds_cstr(&s),
1631                                         &usable);
1632         if (error) {
1633             size_t i;
1634
1635             for (i = 0; i < *n_gms; i++) {
1636                 ofputil_bucket_list_destroy(&(*gms)[i].buckets);
1637             }
1638             free(*gms);
1639             *gms = NULL;
1640             *n_gms = 0;
1641
1642             ds_destroy(&s);
1643             if (stream != stdin) {
1644                 fclose(stream);
1645             }
1646
1647             return xasprintf("%s:%d: %s", file_name, line_number, error);
1648         }
1649         *usable_protocols &= usable;
1650         *n_gms += 1;
1651     }
1652
1653     ds_destroy(&s);
1654     if (stream != stdin) {
1655         fclose(stream);
1656     }
1657     return NULL;
1658 }
1659
1660 char * OVS_WARN_UNUSED_RESULT
1661 parse_ofp_tlv_table_mod_str(struct ofputil_tlv_table_mod *ttm,
1662                                uint16_t command, const char *s,
1663                                enum ofputil_protocol *usable_protocols)
1664 {
1665     *usable_protocols = OFPUTIL_P_NXM_OXM_ANY;
1666
1667     ttm->command = command;
1668     list_init(&ttm->mappings);
1669
1670     while (*s) {
1671         struct ofputil_tlv_map *map = xmalloc(sizeof *map);
1672         int n;
1673
1674         if (*s == ',') {
1675             s++;
1676         }
1677
1678         list_push_back(&ttm->mappings, &map->list_node);
1679
1680         if (!ovs_scan(s, "{class=%"SCNi16",type=%"SCNi8",len=%"SCNi8"}->tun_metadata%"SCNi16"%n",
1681                       &map->option_class, &map->option_type, &map->option_len,
1682                       &map->index, &n)) {
1683             ofputil_uninit_tlv_table(&ttm->mappings);
1684             return xstrdup("invalid tlv mapping");
1685         }
1686
1687         s += n;
1688     }
1689
1690     return NULL;
1691 }