lib/ofp-parse.c

   1 /*
   2  * Copyright (c) 2010, 2011 Nicira Networks.
   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 "netdev.h"
  30 #include "multipath.h"
  31 #include "nx-match.h"
  32 #include "ofp-util.h"
  33 #include "ofpbuf.h"
  34 #include "openflow/openflow.h"
  35 #include "packets.h"
  36 #include "socket-util.h"
  37 #include "vconn.h"
  38 #include "vlog.h"
  39
  40 VLOG_DEFINE_THIS_MODULE(ofp_parse);
  41
  42 static uint32_t
  43 str_to_u32(const char *str)
  44 {
  45     char *tail;
  46     uint32_t value;
  47
  48     if (!str[0]) {
  49         ovs_fatal(0, "missing required numeric argument");
  50     }
  51
  52     errno = 0;
  53     value = strtoul(str, &tail, 0);
  54     if (errno == EINVAL || errno == ERANGE || *tail) {
  55         ovs_fatal(0, "invalid numeric format %s", str);
  56     }
  57     return value;
  58 }
  59
  60 static uint64_t
  61 str_to_u64(const char *str)
  62 {
  63     char *tail;
  64     uint64_t value;
  65
  66     if (!str[0]) {
  67         ovs_fatal(0, "missing required numeric argument");
  68     }
  69
  70     errno = 0;
  71     value = strtoull(str, &tail, 0);
  72     if (errno == EINVAL || errno == ERANGE || *tail) {
  73         ovs_fatal(0, "invalid numeric format %s", str);
  74     }
  75     return value;
  76 }
  77
  78 static void
  79 str_to_mac(const char *str, uint8_t mac[6])
  80 {
  81     if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
  82         != ETH_ADDR_SCAN_COUNT) {
  83         ovs_fatal(0, "invalid mac address %s", str);
  84     }
  85 }
  86
  87 static void
  88 str_to_eth_dst(const char *str,
  89                uint8_t mac[ETH_ADDR_LEN], uint8_t mask[ETH_ADDR_LEN])
  90 {
  91     if (sscanf(str, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
  92                ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))
  93         == ETH_ADDR_SCAN_COUNT * 2) {
  94         if (!flow_wildcards_is_dl_dst_mask_valid(mask)) {
  95             ovs_fatal(0, "%s: invalid Ethernet destination mask (only "
  96                       "00:00:00:00:00:00, 01:00:00:00:00:00, "
  97                       "fe:ff:ff:ff:ff:ff, and ff:ff:ff:ff:ff:ff are allowed)",
  98                       str);
  99         }
 100     } else if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
 101                == ETH_ADDR_SCAN_COUNT) {
 102         memset(mask, 0xff, ETH_ADDR_LEN);
 103     } else {
 104         ovs_fatal(0, "invalid mac address %s", str);
 105     }
 106 }
 107
 108 static void
 109 str_to_ip(const char *str_, ovs_be32 *ip, ovs_be32 *maskp)
 110 {
 111     char *str = xstrdup(str_);
 112     char *save_ptr = NULL;
 113     const char *name, *netmask;
 114     struct in_addr in_addr;
 115     ovs_be32 mask;
 116     int retval;
 117
 118     name = strtok_r(str, "/", &save_ptr);
 119     retval = name ? lookup_ip(name, &in_addr) : EINVAL;
 120     if (retval) {
 121         ovs_fatal(0, "%s: could not convert to IP address", str);
 122     }
 123     *ip = in_addr.s_addr;
 124
 125     netmask = strtok_r(NULL, "/", &save_ptr);
 126     if (netmask) {
 127         uint8_t o[4];
 128         if (sscanf(netmask, "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8,
 129                    &o[0], &o[1], &o[2], &o[3]) == 4) {
 130             mask = htonl((o[0] << 24) | (o[1] << 16) | (o[2] << 8) | o[3]);
 131         } else {
 132             int prefix = atoi(netmask);
 133             if (prefix <= 0 || prefix > 32) {
 134                 ovs_fatal(0, "%s: network prefix bits not between 1 and 32",
 135                           str);
 136             } else if (prefix == 32) {
 137                 mask = htonl(UINT32_MAX);
 138             } else {
 139                 mask = htonl(((1u << prefix) - 1) << (32 - prefix));
 140             }
 141         }
 142     } else {
 143         mask = htonl(UINT32_MAX);
 144     }
 145     *ip &= mask;
 146
 147     if (maskp) {
 148         *maskp = mask;
 149     } else {
 150         if (mask != htonl(UINT32_MAX)) {
 151             ovs_fatal(0, "%s: netmask not allowed here", str_);
 152         }
 153     }
 154
 155     free(str);
 156 }
 157
 158 static void
 159 str_to_tun_id(const char *str, ovs_be64 *tun_idp, ovs_be64 *maskp)
 160 {
 161     uint64_t tun_id, mask;
 162     char *tail;
 163
 164     errno = 0;
 165     tun_id = strtoull(str, &tail, 0);
 166     if (errno || (*tail != '\0' && *tail != '/')) {
 167         goto error;
 168     }
 169
 170     if (*tail == '/') {
 171         mask = strtoull(tail + 1, &tail, 0);
 172         if (errno || *tail != '\0') {
 173             goto error;
 174         }
 175     } else {
 176         mask = UINT64_MAX;
 177     }
 178
 179     *tun_idp = htonll(tun_id);
 180     *maskp = htonll(mask);
 181     return;
 182
 183 error:
 184     ovs_fatal(0, "%s: bad syntax for tunnel id", str);
 185 }
 186
 187 static void
 188 str_to_vlan_tci(const char *str, ovs_be16 *vlan_tcip, ovs_be16 *maskp)
 189 {
 190     uint16_t vlan_tci, mask;
 191     char *tail;
 192
 193     errno = 0;
 194     vlan_tci = strtol(str, &tail, 0);
 195     if (errno || (*tail != '\0' && *tail != '/')) {
 196         goto error;
 197     }
 198
 199     if (*tail == '/') {
 200         mask = strtol(tail + 1, &tail, 0);
 201         if (errno || *tail != '\0') {
 202             goto error;
 203         }
 204     } else {
 205         mask = UINT16_MAX;
 206     }
 207
 208     *vlan_tcip = htons(vlan_tci);
 209     *maskp = htons(mask);
 210     return;
 211
 212 error:
 213     ovs_fatal(0, "%s: bad syntax for vlan_tci", str);
 214 }
 215
 216 static void
 217 str_to_ipv6(const char *str_, struct in6_addr *addrp, struct in6_addr *maskp)
 218 {
 219     char *str = xstrdup(str_);
 220     char *save_ptr = NULL;
 221     const char *name, *netmask;
 222     struct in6_addr addr, mask;
 223     int retval;
 224
 225     name = strtok_r(str, "/", &save_ptr);
 226     retval = name ? lookup_ipv6(name, &addr) : EINVAL;
 227     if (retval) {
 228         ovs_fatal(0, "%s: could not convert to IPv6 address", str);
 229     }
 230
 231     netmask = strtok_r(NULL, "/", &save_ptr);
 232     if (netmask) {
 233         int prefix = atoi(netmask);
 234         if (prefix <= 0 || prefix > 128) {
 235             ovs_fatal(0, "%s: network prefix bits not between 1 and 128",
 236                       str);
 237         } else {
 238             mask = ipv6_create_mask(prefix);
 239         }
 240     } else {
 241         mask = in6addr_exact;
 242     }
 243     *addrp = ipv6_addr_bitand(&addr, &mask);
 244
 245     if (maskp) {
 246         *maskp = mask;
 247     } else {
 248         if (!ipv6_mask_is_exact(&mask)) {
 249             ovs_fatal(0, "%s: netmask not allowed here", str_);
 250         }
 251     }
 252
 253     free(str);
 254 }
 255
 256 static void *
 257 put_action(struct ofpbuf *b, size_t size, uint16_t type)
 258 {
 259     struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
 260     ah->type = htons(type);
 261     ah->len = htons(size);
 262     return ah;
 263 }
 264
 265 static struct ofp_action_output *
 266 put_output_action(struct ofpbuf *b, uint16_t port)
 267 {
 268     struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
 269     oao->port = htons(port);
 270     return oao;
 271 }
 272
 273 static void
 274 put_enqueue_action(struct ofpbuf *b, uint16_t port, uint32_t queue)
 275 {
 276     struct ofp_action_enqueue *oae = put_action(b, sizeof *oae, OFPAT_ENQUEUE);
 277     oae->port = htons(port);
 278     oae->queue_id = htonl(queue);
 279 }
 280
 281 static void
 282 put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
 283 {
 284     struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
 285     str_to_mac(addr, oada->dl_addr);
 286 }
 287
 288 static void
 289 parse_output(struct ofpbuf *b, char *arg)
 290 {
 291     if (strchr(arg, '[')) {
 292         struct nx_action_output_reg *naor;
 293         int ofs, n_bits;
 294         uint32_t src;
 295
 296         nxm_parse_field_bits(arg, &src, &ofs, &n_bits);
 297
 298         naor = put_action(b, sizeof *naor, OFPAT_VENDOR);
 299         naor->vendor = htonl(NX_VENDOR_ID);
 300         naor->subtype = htons(NXAST_OUTPUT_REG);
 301         naor->ofs_nbits = nxm_encode_ofs_nbits(ofs, n_bits);
 302         naor->src = htonl(src);
 303         naor->max_len = htons(UINT16_MAX);
 304     } else {
 305         put_output_action(b, str_to_u32(arg));
 306     }
 307 }
 308
 309 static void
 310 parse_resubmit(struct nx_action_resubmit *nar, char *arg)
 311 {
 312     char *in_port_s, *table_s;
 313     uint16_t in_port;
 314     uint8_t table;
 315
 316     in_port_s = strsep(&arg, ",");
 317     if (in_port_s && in_port_s[0]) {
 318         if (!ofputil_port_from_string(in_port_s, &in_port)) {
 319             in_port = str_to_u32(in_port_s);
 320         }
 321     } else {
 322         in_port = OFPP_IN_PORT;
 323     }
 324
 325     table_s = strsep(&arg, ",");
 326     table = table_s && table_s[0] ? str_to_u32(table_s) : 255;
 327
 328     if (in_port == OFPP_IN_PORT && table == 255) {
 329         ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
 330                   " on resubmit");
 331     }
 332
 333     nar->vendor = htonl(NX_VENDOR_ID);
 334     nar->in_port = htons(in_port);
 335     if (in_port != OFPP_IN_PORT && table == 255) {
 336         nar->subtype = htons(NXAST_RESUBMIT);
 337     } else {
 338         nar->subtype = htons(NXAST_RESUBMIT_TABLE);
 339         nar->table = table;
 340     }
 341 }
 342
 343 static void
 344 str_to_action(char *str, struct ofpbuf *b)
 345 {
 346     bool drop = false;
 347     int n_actions;
 348     char *pos;
 349
 350     pos = str;
 351     n_actions = 0;
 352     for (;;) {
 353         char empty_string[] = "";
 354         char *act, *arg;
 355         size_t actlen;
 356         uint16_t port;
 357
 358         pos += strspn(pos, ", \t\r\n");
 359         if (*pos == '\0') {
 360             break;
 361         }
 362
 363         if (drop) {
 364             ovs_fatal(0, "Drop actions must not be followed by other actions");
 365         }
 366
 367         act = pos;
 368         actlen = strcspn(pos, ":(, \t\r\n");
 369         if (act[actlen] == ':') {
 370             /* The argument can be separated by a colon. */
 371             size_t arglen;
 372
 373             arg = act + actlen + 1;
 374             arglen = strcspn(arg, ", \t\r\n");
 375             pos = arg + arglen + (arg[arglen] != '\0');
 376             arg[arglen] = '\0';
 377         } else if (act[actlen] == '(') {
 378             /* The argument can be surrounded by balanced parentheses.  The
 379              * outermost set of parentheses is removed. */
 380             int level = 1;
 381             size_t arglen;
 382
 383             arg = act + actlen + 1;
 384             for (arglen = 0; level > 0; arglen++) {
 385                 switch (arg[arglen]) {
 386                 case '\0':
 387                     ovs_fatal(0, "unbalanced parentheses in argument to %s "
 388                               "action", act);
 389
 390                 case '(':
 391                     level++;
 392                     break;
 393
 394                 case ')':
 395                     level--;
 396                     break;
 397                 }
 398             }
 399             arg[arglen - 1] = '\0';
 400             pos = arg + arglen;
 401         } else {
 402             /* There might be no argument at all. */
 403             arg = empty_string;
 404             pos = act + actlen + (act[actlen] != '\0');
 405         }
 406         act[actlen] = '\0';
 407
 408         if (!strcasecmp(act, "mod_vlan_vid")) {
 409             struct ofp_action_vlan_vid *va;
 410             va = put_action(b, sizeof *va, OFPAT_SET_VLAN_VID);
 411             va->vlan_vid = htons(str_to_u32(arg));
 412         } else if (!strcasecmp(act, "mod_vlan_pcp")) {
 413             struct ofp_action_vlan_pcp *va;
 414             va = put_action(b, sizeof *va, OFPAT_SET_VLAN_PCP);
 415             va->vlan_pcp = str_to_u32(arg);
 416         } else if (!strcasecmp(act, "strip_vlan")) {
 417             struct ofp_action_header *ah;
 418             ah = put_action(b, sizeof *ah, OFPAT_STRIP_VLAN);
 419             ah->type = htons(OFPAT_STRIP_VLAN);
 420         } else if (!strcasecmp(act, "mod_dl_src")) {
 421             put_dl_addr_action(b, OFPAT_SET_DL_SRC, arg);
 422         } else if (!strcasecmp(act, "mod_dl_dst")) {
 423             put_dl_addr_action(b, OFPAT_SET_DL_DST, arg);
 424         } else if (!strcasecmp(act, "mod_nw_src")) {
 425             struct ofp_action_nw_addr *na;
 426             na = put_action(b, sizeof *na, OFPAT_SET_NW_SRC);
 427             str_to_ip(arg, &na->nw_addr, NULL);
 428         } else if (!strcasecmp(act, "mod_nw_dst")) {
 429             struct ofp_action_nw_addr *na;
 430             na = put_action(b, sizeof *na, OFPAT_SET_NW_DST);
 431             str_to_ip(arg, &na->nw_addr, NULL);
 432         } else if (!strcasecmp(act, "mod_tp_src")) {
 433             struct ofp_action_tp_port *ta;
 434             ta = put_action(b, sizeof *ta, OFPAT_SET_TP_SRC);
 435             ta->tp_port = htons(str_to_u32(arg));
 436         } else if (!strcasecmp(act, "mod_tp_dst")) {
 437             struct ofp_action_tp_port *ta;
 438             ta = put_action(b, sizeof *ta, OFPAT_SET_TP_DST);
 439             ta->tp_port = htons(str_to_u32(arg));
 440         } else if (!strcasecmp(act, "mod_nw_tos")) {
 441             struct ofp_action_nw_tos *nt;
 442             nt = put_action(b, sizeof *nt, OFPAT_SET_NW_TOS);
 443             nt->nw_tos = str_to_u32(arg);
 444         } else if (!strcasecmp(act, "resubmit")) {
 445             struct nx_action_resubmit *nar;
 446             nar = put_action(b, sizeof *nar, OFPAT_VENDOR);
 447             parse_resubmit(nar, arg);
 448         } else if (!strcasecmp(act, "set_tunnel")
 449                    || !strcasecmp(act, "set_tunnel64")) {
 450             uint64_t tun_id = str_to_u64(arg);
 451             if (!strcasecmp(act, "set_tunnel64") || tun_id > UINT32_MAX) {
 452                 struct nx_action_set_tunnel64 *nast64;
 453                 nast64 = put_action(b, sizeof *nast64, OFPAT_VENDOR);
 454                 nast64->vendor = htonl(NX_VENDOR_ID);
 455                 nast64->subtype = htons(NXAST_SET_TUNNEL64);
 456                 nast64->tun_id = htonll(tun_id);
 457             } else {
 458                 struct nx_action_set_tunnel *nast;
 459                 nast = put_action(b, sizeof *nast, OFPAT_VENDOR);
 460                 nast->vendor = htonl(NX_VENDOR_ID);
 461                 nast->subtype = htons(NXAST_SET_TUNNEL);
 462                 nast->tun_id = htonl(tun_id);
 463             }
 464         } else if (!strcasecmp(act, "set_queue")) {
 465             struct nx_action_set_queue *nasq;
 466             nasq = put_action(b, sizeof *nasq, OFPAT_VENDOR);
 467             nasq->vendor = htonl(NX_VENDOR_ID);
 468             nasq->subtype = htons(NXAST_SET_QUEUE);
 469             nasq->queue_id = htonl(str_to_u32(arg));
 470         } else if (!strcasecmp(act, "pop_queue")) {
 471             struct nx_action_header *nah;
 472             nah = put_action(b, sizeof *nah, OFPAT_VENDOR);
 473             nah->vendor = htonl(NX_VENDOR_ID);
 474             nah->subtype = htons(NXAST_POP_QUEUE);
 475         } else if (!strcasecmp(act, "note")) {
 476             size_t start_ofs = b->size;
 477             struct nx_action_note *nan;
 478             int remainder;
 479             size_t len;
 480
 481             nan = put_action(b, sizeof *nan, OFPAT_VENDOR);
 482             nan->vendor = htonl(NX_VENDOR_ID);
 483             nan->subtype = htons(NXAST_NOTE);
 484
 485             b->size -= sizeof nan->note;
 486             while (*arg != '\0') {
 487                 uint8_t byte;
 488                 bool ok;
 489
 490                 if (*arg == '.') {
 491                     arg++;
 492                 }
 493                 if (*arg == '\0') {
 494                     break;
 495                 }
 496
 497                 byte = hexits_value(arg, 2, &ok);
 498                 if (!ok) {
 499                     ovs_fatal(0, "bad hex digit in `note' argument");
 500                 }
 501                 ofpbuf_put(b, &byte, 1);
 502
 503                 arg += 2;
 504             }
 505
 506             len = b->size - start_ofs;
 507             remainder = len % OFP_ACTION_ALIGN;
 508             if (remainder) {
 509                 ofpbuf_put_zeros(b, OFP_ACTION_ALIGN - remainder);
 510             }
 511             nan = (struct nx_action_note *)((char *)b->data + start_ofs);
 512             nan->len = htons(b->size - start_ofs);
 513         } else if (!strcasecmp(act, "move")) {
 514             struct nx_action_reg_move *move;
 515             move = ofpbuf_put_uninit(b, sizeof *move);
 516             nxm_parse_reg_move(move, arg);
 517         } else if (!strcasecmp(act, "load")) {
 518             struct nx_action_reg_load *load;
 519             load = ofpbuf_put_uninit(b, sizeof *load);
 520             nxm_parse_reg_load(load, arg);
 521         } else if (!strcasecmp(act, "multipath")) {
 522             struct nx_action_multipath *nam;
 523             nam = ofpbuf_put_uninit(b, sizeof *nam);
 524             multipath_parse(nam, arg);
 525         } else if (!strcasecmp(act, "autopath")) {
 526             struct nx_action_autopath *naa;
 527             naa = ofpbuf_put_uninit(b, sizeof *naa);
 528             autopath_parse(naa, arg);
 529         } else if (!strcasecmp(act, "bundle")) {
 530             bundle_parse(b, arg);
 531         } else if (!strcasecmp(act, "bundle_load")) {
 532             bundle_parse_load(b, arg);
 533         } else if (!strcasecmp(act, "output")) {
 534             parse_output(b, arg);
 535         } else if (!strcasecmp(act, "enqueue")) {
 536             char *sp = NULL;
 537             char *port_s = strtok_r(arg, ":q", &sp);
 538             char *queue = strtok_r(NULL, "", &sp);
 539             if (port_s == NULL || queue == NULL) {
 540                 ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
 541             }
 542             put_enqueue_action(b, str_to_u32(port_s), str_to_u32(queue));
 543         } else if (!strcasecmp(act, "drop")) {
 544             /* A drop action in OpenFlow occurs by just not setting
 545              * an action. */
 546             drop = true;
 547             if (n_actions) {
 548                 ovs_fatal(0, "Drop actions must not be preceded by other "
 549                           "actions");
 550             }
 551         } else if (!strcasecmp(act, "CONTROLLER")) {
 552             struct ofp_action_output *oao;
 553             oao = put_output_action(b, OFPP_CONTROLLER);
 554
 555             /* Unless a numeric argument is specified, we send the whole
 556              * packet to the controller. */
 557             if (arg[0] && (strspn(arg, "0123456789") == strlen(arg))) {
 558                oao->max_len = htons(str_to_u32(arg));
 559             } else {
 560                 oao->max_len = htons(UINT16_MAX);
 561             }
 562         } else if (ofputil_port_from_string(act, &port)) {
 563             put_output_action(b, port);
 564         } else {
 565             ovs_fatal(0, "Unknown action: %s", act);
 566         }
 567         n_actions++;
 568     }
 569 }
 570
 571 struct protocol {
 572     const char *name;
 573     uint16_t dl_type;
 574     uint8_t nw_proto;
 575 };
 576
 577 static bool
 578 parse_protocol(const char *name, const struct protocol **p_out)
 579 {
 580     static const struct protocol protocols[] = {
 581         { "ip", ETH_TYPE_IP, 0 },
 582         { "arp", ETH_TYPE_ARP, 0 },
 583         { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
 584         { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
 585         { "udp", ETH_TYPE_IP, IPPROTO_UDP },
 586         { "ipv6", ETH_TYPE_IPV6, 0 },
 587         { "ip6", ETH_TYPE_IPV6, 0 },
 588         { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
 589         { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
 590         { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
 591     };
 592     const struct protocol *p;
 593
 594     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
 595         if (!strcmp(p->name, name)) {
 596             *p_out = p;
 597             return true;
 598         }
 599     }
 600     *p_out = NULL;
 601     return false;
 602 }
 603
 604 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 1);
 605 #define FIELDS                                              \
 606     FIELD(F_TUN_ID,      "tun_id",      0)                  \
 607     FIELD(F_IN_PORT,     "in_port",     FWW_IN_PORT)        \
 608     FIELD(F_DL_VLAN,     "dl_vlan",     0)                  \
 609     FIELD(F_DL_VLAN_PCP, "dl_vlan_pcp", 0)                  \
 610     FIELD(F_VLAN_TCI,    "vlan_tci",    0)                  \
 611     FIELD(F_DL_SRC,      "dl_src",      FWW_DL_SRC)         \
 612     FIELD(F_DL_DST,      "dl_dst",      FWW_DL_DST | FWW_ETH_MCAST) \
 613     FIELD(F_DL_TYPE,     "dl_type",     FWW_DL_TYPE)        \
 614     FIELD(F_NW_SRC,      "nw_src",      0)                  \
 615     FIELD(F_NW_DST,      "nw_dst",      0)                  \
 616     FIELD(F_NW_PROTO,    "nw_proto",    FWW_NW_PROTO)       \
 617     FIELD(F_NW_TOS,      "nw_tos",      FWW_NW_TOS)         \
 618     FIELD(F_TP_SRC,      "tp_src",      FWW_TP_SRC)         \
 619     FIELD(F_TP_DST,      "tp_dst",      FWW_TP_DST)         \
 620     FIELD(F_ICMP_TYPE,   "icmp_type",   FWW_TP_SRC)         \
 621     FIELD(F_ICMP_CODE,   "icmp_code",   FWW_TP_DST)         \
 622     FIELD(F_ARP_SHA,     "arp_sha",     FWW_ARP_SHA)        \
 623     FIELD(F_ARP_THA,     "arp_tha",     FWW_ARP_THA)        \
 624     FIELD(F_IPV6_SRC,    "ipv6_src",    0)                  \
 625     FIELD(F_IPV6_DST,    "ipv6_dst",    0)                  \
 626     FIELD(F_ND_TARGET,   "nd_target",   FWW_ND_TARGET)      \
 627     FIELD(F_ND_SLL,      "nd_sll",      FWW_ARP_SHA)        \
 628     FIELD(F_ND_TLL,      "nd_tll",      FWW_ARP_THA)
 629
 630 enum field_index {
 631 #define FIELD(ENUM, NAME, WILDCARD) ENUM,
 632     FIELDS
 633 #undef FIELD
 634     N_FIELDS
 635 };
 636
 637 struct field {
 638     enum field_index index;
 639     const char *name;
 640     flow_wildcards_t wildcard;  /* FWW_* bit. */
 641 };
 642
 643 static void
 644 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
 645 {
 646     va_list args;
 647
 648     if (verbose) {
 649         fprintf(stderr, "%s:\n", flow);
 650     }
 651
 652     va_start(args, format);
 653     ovs_fatal_valist(0, format, args);
 654 }
 655
 656 static bool
 657 parse_field_name(const char *name, const struct field **f_out)
 658 {
 659     static const struct field fields[N_FIELDS] = {
 660 #define FIELD(ENUM, NAME, WILDCARD) { ENUM, NAME, WILDCARD },
 661         FIELDS
 662 #undef FIELD
 663     };
 664     const struct field *f;
 665
 666     for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
 667         if (!strcmp(f->name, name)) {
 668             *f_out = f;
 669             return true;
 670         }
 671     }
 672     *f_out = NULL;
 673     return false;
 674 }
 675
 676 static void
 677 parse_field_value(struct cls_rule *rule, enum field_index index,
 678                   const char *value)
 679 {
 680     uint8_t mac[ETH_ADDR_LEN], mac_mask[ETH_ADDR_LEN];
 681     ovs_be64 tun_id, tun_mask;
 682     ovs_be32 ip, mask;
 683     ovs_be16 tci, tci_mask;
 684     struct in6_addr ipv6, ipv6_mask;
 685     uint16_t port_no;
 686
 687     switch (index) {
 688     case F_TUN_ID:
 689         str_to_tun_id(value, &tun_id, &tun_mask);
 690         cls_rule_set_tun_id_masked(rule, tun_id, tun_mask);
 691         break;
 692
 693     case F_IN_PORT:
 694         if (!ofputil_port_from_string(value, &port_no)) {
 695             port_no = atoi(value);
 696         }
 697         cls_rule_set_in_port(rule, port_no);
 698         break;
 699
 700     case F_DL_VLAN:
 701         cls_rule_set_dl_vlan(rule, htons(str_to_u32(value)));
 702         break;
 703
 704     case F_DL_VLAN_PCP:
 705         cls_rule_set_dl_vlan_pcp(rule, str_to_u32(value));
 706         break;
 707
 708     case F_VLAN_TCI:
 709         str_to_vlan_tci(value, &tci, &tci_mask);
 710         cls_rule_set_dl_tci_masked(rule, tci, tci_mask);
 711         break;
 712
 713     case F_DL_SRC:
 714         str_to_mac(value, mac);
 715         cls_rule_set_dl_src(rule, mac);
 716         break;
 717
 718     case F_DL_DST:
 719         str_to_eth_dst(value, mac, mac_mask);
 720         cls_rule_set_dl_dst_masked(rule, mac, mac_mask);
 721         break;
 722
 723     case F_DL_TYPE:
 724         cls_rule_set_dl_type(rule, htons(str_to_u32(value)));
 725         break;
 726
 727     case F_NW_SRC:
 728         str_to_ip(value, &ip, &mask);
 729         cls_rule_set_nw_src_masked(rule, ip, mask);
 730         break;
 731
 732     case F_NW_DST:
 733         str_to_ip(value, &ip, &mask);
 734         cls_rule_set_nw_dst_masked(rule, ip, mask);
 735         break;
 736
 737     case F_NW_PROTO:
 738         cls_rule_set_nw_proto(rule, str_to_u32(value));
 739         break;
 740
 741     case F_NW_TOS:
 742         cls_rule_set_nw_tos(rule, str_to_u32(value));
 743         break;
 744
 745     case F_TP_SRC:
 746         cls_rule_set_tp_src(rule, htons(str_to_u32(value)));
 747         break;
 748
 749     case F_TP_DST:
 750         cls_rule_set_tp_dst(rule, htons(str_to_u32(value)));
 751         break;
 752
 753     case F_ICMP_TYPE:
 754         cls_rule_set_icmp_type(rule, str_to_u32(value));
 755         break;
 756
 757     case F_ICMP_CODE:
 758         cls_rule_set_icmp_code(rule, str_to_u32(value));
 759         break;
 760
 761     case F_ARP_SHA:
 762         str_to_mac(value, mac);
 763         cls_rule_set_arp_sha(rule, mac);
 764         break;
 765
 766     case F_ARP_THA:
 767         str_to_mac(value, mac);
 768         cls_rule_set_arp_tha(rule, mac);
 769         break;
 770
 771     case F_IPV6_SRC:
 772         str_to_ipv6(value, &ipv6, &ipv6_mask);
 773         cls_rule_set_ipv6_src_masked(rule, &ipv6, &ipv6_mask);
 774         break;
 775
 776     case F_IPV6_DST:
 777         str_to_ipv6(value, &ipv6, &ipv6_mask);
 778         cls_rule_set_ipv6_dst_masked(rule, &ipv6, &ipv6_mask);
 779         break;
 780
 781     case F_ND_TARGET:
 782         str_to_ipv6(value, &ipv6, NULL);
 783         cls_rule_set_nd_target(rule, &ipv6);
 784         break;
 785
 786     case F_ND_SLL:
 787         str_to_mac(value, mac);
 788         cls_rule_set_arp_sha(rule, mac);
 789         break;
 790
 791     case F_ND_TLL:
 792         str_to_mac(value, mac);
 793         cls_rule_set_arp_tha(rule, mac);
 794         break;
 795
 796     case N_FIELDS:
 797         NOT_REACHED();
 798     }
 799 }
 800
 801 static void
 802 parse_reg_value(struct cls_rule *rule, int reg_idx, const char *value)
 803 {
 804     /* This uses an oversized destination field (64 bits when 32 bits would do)
 805      * because some sscanf() implementations truncate the range of %i
 806      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
 807      * value of 0x7fff.  The other alternatives are to allow only a single
 808      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
 809      * parsers. */
 810     unsigned long long int reg_value, reg_mask;
 811
 812     if (!strcmp(value, "ANY") || !strcmp(value, "*")) {
 813         cls_rule_set_reg_masked(rule, reg_idx, 0, 0);
 814     } else if (sscanf(value, "%lli/%lli",
 815                       &reg_value, &reg_mask) == 2) {
 816         cls_rule_set_reg_masked(rule, reg_idx, reg_value, reg_mask);
 817     } else if (sscanf(value, "%lli", &reg_value)) {
 818         cls_rule_set_reg(rule, reg_idx, reg_value);
 819     } else {
 820         ovs_fatal(0, "register fields must take the form <value> "
 821                   "or <value>/<mask>");
 822     }
 823 }
 824
 825 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
 826  * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
 827  * If 'actions' is specified, an action must be in 'string' and may be expanded
 828  * or reallocated.
 829  *
 830  * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
 831  * constant for 'command'.  To parse syntax for an OFPST_FLOW or
 832  * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
 833 void
 834 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
 835               bool verbose)
 836 {
 837     enum {
 838         F_OUT_PORT = 1 << 0,
 839         F_ACTIONS = 1 << 1,
 840         F_COOKIE = 1 << 2,
 841         F_TIMEOUT = 1 << 3,
 842         F_PRIORITY = 1 << 4
 843     } fields;
 844     char *string = xstrdup(str_);
 845     char *save_ptr = NULL;
 846     char *name;
 847
 848     switch (command) {
 849     case -1:
 850         fields = F_OUT_PORT;
 851         break;
 852
 853     case OFPFC_ADD:
 854         fields = F_ACTIONS | F_COOKIE | F_TIMEOUT | F_PRIORITY;
 855         break;
 856
 857     case OFPFC_DELETE:
 858         fields = F_OUT_PORT;
 859         break;
 860
 861     case OFPFC_DELETE_STRICT:
 862         fields = F_OUT_PORT | F_PRIORITY;
 863         break;
 864
 865     case OFPFC_MODIFY:
 866         fields = F_ACTIONS | F_COOKIE;
 867         break;
 868
 869     case OFPFC_MODIFY_STRICT:
 870         fields = F_ACTIONS | F_COOKIE | F_PRIORITY;
 871         break;
 872
 873     default:
 874         NOT_REACHED();
 875     }
 876
 877     cls_rule_init_catchall(&fm->cr, OFP_DEFAULT_PRIORITY);
 878     fm->cookie = htonll(0);
 879     fm->table_id = 0xff;
 880     fm->command = command;
 881     fm->idle_timeout = OFP_FLOW_PERMANENT;
 882     fm->hard_timeout = OFP_FLOW_PERMANENT;
 883     fm->buffer_id = UINT32_MAX;
 884     fm->out_port = OFPP_NONE;
 885     fm->flags = 0;
 886     if (fields & F_ACTIONS) {
 887         struct ofpbuf actions;
 888         char *act_str;
 889
 890         act_str = strstr(string, "action");
 891         if (!act_str) {
 892             ofp_fatal(str_, verbose, "must specify an action");
 893         }
 894         *act_str = '\0';
 895
 896         act_str = strchr(act_str + 1, '=');
 897         if (!act_str) {
 898             ofp_fatal(str_, verbose, "must specify an action");
 899         }
 900
 901         act_str++;
 902
 903         ofpbuf_init(&actions, sizeof(union ofp_action));
 904         str_to_action(act_str, &actions);
 905         fm->actions = ofpbuf_steal_data(&actions);
 906         fm->n_actions = actions.size / sizeof(union ofp_action);
 907     } else {
 908         fm->actions = NULL;
 909         fm->n_actions = 0;
 910     }
 911     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 912          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 913         const struct protocol *p;
 914
 915         if (parse_protocol(name, &p)) {
 916             cls_rule_set_dl_type(&fm->cr, htons(p->dl_type));
 917             if (p->nw_proto) {
 918                 cls_rule_set_nw_proto(&fm->cr, p->nw_proto);
 919             }
 920         } else {
 921             const struct field *f;
 922             char *value;
 923
 924             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 925             if (!value) {
 926                 ofp_fatal(str_, verbose, "field %s missing value", name);
 927             }
 928
 929             if (!strcmp(name, "table")) {
 930                 fm->table_id = atoi(value);
 931             } else if (!strcmp(name, "out_port")) {
 932                 fm->out_port = atoi(value);
 933             } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
 934                 fm->cr.priority = atoi(value);
 935             } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
 936                 fm->idle_timeout = atoi(value);
 937             } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
 938                 fm->hard_timeout = atoi(value);
 939             } else if (fields & F_COOKIE && !strcmp(name, "cookie")) {
 940                 fm->cookie = htonll(str_to_u64(value));
 941             } else if (parse_field_name(name, &f)) {
 942                 if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
 943                     if (f->wildcard) {
 944                         fm->cr.wc.wildcards |= f->wildcard;
 945                         cls_rule_zero_wildcarded_fields(&fm->cr);
 946                     } else if (f->index == F_NW_SRC) {
 947                         cls_rule_set_nw_src_masked(&fm->cr, 0, 0);
 948                     } else if (f->index == F_NW_DST) {
 949                         cls_rule_set_nw_dst_masked(&fm->cr, 0, 0);
 950                     } else if (f->index == F_IPV6_SRC) {
 951                         cls_rule_set_ipv6_src_masked(&fm->cr,
 952                                 &in6addr_any, &in6addr_any);
 953                     } else if (f->index == F_IPV6_DST) {
 954                         cls_rule_set_ipv6_dst_masked(&fm->cr,
 955                                 &in6addr_any, &in6addr_any);
 956                     } else if (f->index == F_DL_VLAN) {
 957                         cls_rule_set_any_vid(&fm->cr);
 958                     } else if (f->index == F_DL_VLAN_PCP) {
 959                         cls_rule_set_any_pcp(&fm->cr);
 960                     } else {
 961                         NOT_REACHED();
 962                     }
 963                 } else {
 964                     parse_field_value(&fm->cr, f->index, value);
 965                 }
 966             } else if (!strncmp(name, "reg", 3)
 967                        && isdigit((unsigned char) name[3])) {
 968                 unsigned int reg_idx = atoi(name + 3);
 969                 if (reg_idx >= FLOW_N_REGS) {
 970                     if (verbose) {
 971                         fprintf(stderr, "%s:\n", str_);
 972                     }
 973                     ofp_fatal(str_, verbose, "only %d registers supported", FLOW_N_REGS);
 974                 }
 975                 parse_reg_value(&fm->cr, reg_idx, value);
 976             } else if (!strcmp(name, "duration")
 977                        || !strcmp(name, "n_packets")
 978                        || !strcmp(name, "n_bytes")) {
 979                 /* Ignore these, so that users can feed the output of
 980                  * "ovs-ofctl dump-flows" back into commands that parse
 981                  * flows. */
 982             } else {
 983                 ofp_fatal(str_, verbose, "unknown keyword %s", name);
 984             }
 985         }
 986     }
 987
 988     free(string);
 989 }
 990
 991 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
 992  * (one of OFPFC_*) and appends the parsed OpenFlow message to 'packets'.
 993  * '*cur_format' should initially contain the flow format currently configured
 994  * on the connection; this function will add a message to change the flow
 995  * format and update '*cur_format', if this is necessary to add the parsed
 996  * flow. */
 997 void
 998 parse_ofp_flow_mod_str(struct list *packets, enum nx_flow_format *cur_format,
 999                        bool *flow_mod_table_id, char *string, uint16_t command,
1000                        bool verbose)
1001 {
1002     enum nx_flow_format min_format, next_format;
1003     struct cls_rule rule_copy;
1004     struct ofpbuf actions;
1005     struct ofpbuf *ofm;
1006     struct ofputil_flow_mod fm;
1007
1008     ofpbuf_init(&actions, 64);
1009     parse_ofp_str(&fm, command, string, verbose);
1010
1011     min_format = ofputil_min_flow_format(&fm.cr);
1012     next_format = MAX(*cur_format, min_format);
1013     if (next_format != *cur_format) {
1014         struct ofpbuf *sff = ofputil_make_set_flow_format(next_format);
1015         list_push_back(packets, &sff->list_node);
1016         *cur_format = next_format;
1017     }
1018
1019     /* Normalize a copy of the rule.  This ensures that non-normalized flows
1020      * get logged but doesn't affect what gets sent to the switch, so that the
1021      * switch can do whatever it likes with the flow. */
1022     rule_copy = fm.cr;
1023     ofputil_normalize_rule(&rule_copy, next_format);
1024
1025     if (fm.table_id != 0xff && !*flow_mod_table_id) {
1026         struct ofpbuf *sff = ofputil_make_flow_mod_table_id(true);
1027         list_push_back(packets, &sff->list_node);
1028         *flow_mod_table_id = true;
1029     }
1030
1031     ofm = ofputil_encode_flow_mod(&fm, *cur_format, *flow_mod_table_id);
1032     list_push_back(packets, &ofm->list_node);
1033
1034     ofpbuf_uninit(&actions);
1035 }
1036
1037 /* Similar to parse_ofp_flow_mod_str(), except that the string is read from
1038  * 'stream' and the command is always OFPFC_ADD.  Returns false if end-of-file
1039  * is reached before reading a flow, otherwise true. */
1040 bool
1041 parse_ofp_flow_mod_file(struct list *packets,
1042                         enum nx_flow_format *cur, bool *flow_mod_table_id,
1043                         FILE *stream, uint16_t command)
1044 {
1045     struct ds s;
1046     bool ok;
1047
1048     ds_init(&s);
1049     ok = ds_get_preprocessed_line(&s, stream) == 0;
1050     if (ok) {
1051         parse_ofp_flow_mod_str(packets, cur, flow_mod_table_id,
1052                                ds_cstr(&s), command, true);
1053     }
1054     ds_destroy(&s);
1055
1056     return ok;
1057 }
1058
1059 void
1060 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1061                                  bool aggregate, char *string)
1062 {
1063     struct ofputil_flow_mod fm;
1064
1065     parse_ofp_str(&fm, -1, string, false);
1066     fsr->aggregate = aggregate;
1067     fsr->match = fm.cr;
1068     fsr->out_port = fm.out_port;
1069     fsr->table_id = fm.table_id;
1070 }