2 * Copyright (c) 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "ofp-parse.h"
27 #include "byte-order.h"
28 #include "dynamic-string.h"
30 #include "multipath.h"
34 #include "openflow/openflow.h"
36 #include "socket-util.h"
40 VLOG_DEFINE_THIS_MODULE(ofp_parse);
43 str_to_u32(const char *str)
49 ovs_fatal(0, "missing required numeric argument");
53 value = strtoul(str, &tail, 0);
54 if (errno == EINVAL || errno == ERANGE || *tail) {
55 ovs_fatal(0, "invalid numeric format %s", str);
61 str_to_u64(const char *str)
67 ovs_fatal(0, "missing required numeric argument");
71 value = strtoull(str, &tail, 0);
72 if (errno == EINVAL || errno == ERANGE || *tail) {
73 ovs_fatal(0, "invalid numeric format %s", str);
79 str_to_mac(const char *str, uint8_t mac[6])
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);
88 str_to_eth_dst(const char *str,
89 uint8_t mac[ETH_ADDR_LEN], uint8_t mask[ETH_ADDR_LEN])
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)",
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);
104 ovs_fatal(0, "invalid mac address %s", str);
109 str_to_ip(const char *str_, ovs_be32 *ip, ovs_be32 *maskp)
111 char *str = xstrdup(str_);
112 char *save_ptr = NULL;
113 const char *name, *netmask;
114 struct in_addr in_addr;
118 name = strtok_r(str, "/", &save_ptr);
119 retval = name ? lookup_ip(name, &in_addr) : EINVAL;
121 ovs_fatal(0, "%s: could not convert to IP address", str);
123 *ip = in_addr.s_addr;
125 netmask = strtok_r(NULL, "/", &save_ptr);
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]);
132 int prefix = atoi(netmask);
133 if (prefix <= 0 || prefix > 32) {
134 ovs_fatal(0, "%s: network prefix bits not between 1 and 32",
136 } else if (prefix == 32) {
137 mask = htonl(UINT32_MAX);
139 mask = htonl(((1u << prefix) - 1) << (32 - prefix));
143 mask = htonl(UINT32_MAX);
150 if (mask != htonl(UINT32_MAX)) {
151 ovs_fatal(0, "%s: netmask not allowed here", str_);
159 str_to_tun_id(const char *str, ovs_be64 *tun_idp, ovs_be64 *maskp)
161 uint64_t tun_id, mask;
165 tun_id = strtoull(str, &tail, 0);
166 if (errno || (*tail != '\0' && *tail != '/')) {
171 mask = strtoull(tail + 1, &tail, 0);
172 if (errno || *tail != '\0') {
179 *tun_idp = htonll(tun_id);
180 *maskp = htonll(mask);
184 ovs_fatal(0, "%s: bad syntax for tunnel id", str);
188 str_to_vlan_tci(const char *str, ovs_be16 *vlan_tcip, ovs_be16 *maskp)
190 uint16_t vlan_tci, mask;
194 vlan_tci = strtol(str, &tail, 0);
195 if (errno || (*tail != '\0' && *tail != '/')) {
200 mask = strtol(tail + 1, &tail, 0);
201 if (errno || *tail != '\0') {
208 *vlan_tcip = htons(vlan_tci);
209 *maskp = htons(mask);
213 ovs_fatal(0, "%s: bad syntax for vlan_tci", str);
217 str_to_ipv6(const char *str_, struct in6_addr *addrp, struct in6_addr *maskp)
219 char *str = xstrdup(str_);
220 char *save_ptr = NULL;
221 const char *name, *netmask;
222 struct in6_addr addr, mask;
225 name = strtok_r(str, "/", &save_ptr);
226 retval = name ? lookup_ipv6(name, &addr) : EINVAL;
228 ovs_fatal(0, "%s: could not convert to IPv6 address", str);
231 netmask = strtok_r(NULL, "/", &save_ptr);
233 int prefix = atoi(netmask);
234 if (prefix <= 0 || prefix > 128) {
235 ovs_fatal(0, "%s: network prefix bits not between 1 and 128",
238 mask = ipv6_create_mask(prefix);
241 mask = in6addr_exact;
243 *addrp = ipv6_addr_bitand(&addr, &mask);
248 if (!ipv6_mask_is_exact(&mask)) {
249 ovs_fatal(0, "%s: netmask not allowed here", str_);
257 put_action(struct ofpbuf *b, size_t size, uint16_t type)
259 struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
260 ah->type = htons(type);
261 ah->len = htons(size);
265 static struct ofp_action_output *
266 put_output_action(struct ofpbuf *b, uint16_t port)
268 struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
269 oao->port = htons(port);
274 put_enqueue_action(struct ofpbuf *b, uint16_t port, uint32_t queue)
276 struct ofp_action_enqueue *oae = put_action(b, sizeof *oae, OFPAT_ENQUEUE);
277 oae->port = htons(port);
278 oae->queue_id = htonl(queue);
282 put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
284 struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
285 str_to_mac(addr, oada->dl_addr);
289 parse_output(struct ofpbuf *b, char *arg)
291 if (strchr(arg, '[')) {
292 struct nx_action_output_reg *naor;
296 nxm_parse_field_bits(arg, &src, &ofs, &n_bits);
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);
305 put_output_action(b, str_to_u32(arg));
310 parse_resubmit(struct nx_action_resubmit *nar, char *arg)
312 char *in_port_s, *table_s;
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);
322 in_port = OFPP_IN_PORT;
325 table_s = strsep(&arg, ",");
326 table = table_s && table_s[0] ? str_to_u32(table_s) : 255;
328 if (in_port == OFPP_IN_PORT && table == 255) {
329 ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
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);
338 nar->subtype = htons(NXAST_RESUBMIT_TABLE);
344 str_to_action(char *str, struct ofpbuf *b)
353 char empty_string[] = "";
358 pos += strspn(pos, ", \t\r\n");
364 ovs_fatal(0, "Drop actions must not be followed by other actions");
368 actlen = strcspn(pos, ":(, \t\r\n");
369 if (act[actlen] == ':') {
370 /* The argument can be separated by a colon. */
373 arg = act + actlen + 1;
374 arglen = strcspn(arg, ", \t\r\n");
375 pos = arg + arglen + (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. */
383 arg = act + actlen + 1;
384 for (arglen = 0; level > 0; arglen++) {
385 switch (arg[arglen]) {
387 ovs_fatal(0, "unbalanced parentheses in argument to %s "
399 arg[arglen - 1] = '\0';
402 /* There might be no argument at all. */
404 pos = act + actlen + (act[actlen] != '\0');
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);
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);
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;
481 nan = put_action(b, sizeof *nan, OFPAT_VENDOR);
482 nan->vendor = htonl(NX_VENDOR_ID);
483 nan->subtype = htons(NXAST_NOTE);
485 b->size -= sizeof nan->note;
486 while (*arg != '\0') {
497 byte = hexits_value(arg, 2, &ok);
499 ovs_fatal(0, "bad hex digit in `note' argument");
501 ofpbuf_put(b, &byte, 1);
506 len = b->size - start_ofs;
507 remainder = len % OFP_ACTION_ALIGN;
509 ofpbuf_put_zeros(b, OFP_ACTION_ALIGN - remainder);
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")) {
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\"");
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
548 ovs_fatal(0, "Drop actions must not be preceded by other "
551 } else if (!strcasecmp(act, "CONTROLLER")) {
552 struct ofp_action_output *oao;
553 oao = put_output_action(b, OFPP_CONTROLLER);
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));
560 oao->max_len = htons(UINT16_MAX);
562 } else if (ofputil_port_from_string(act, &port)) {
563 put_output_action(b, port);
565 ovs_fatal(0, "Unknown action: %s", act);
578 parse_protocol(const char *name, const struct protocol **p_out)
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 },
592 const struct protocol *p;
594 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
595 if (!strcmp(p->name, name)) {
604 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 1);
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)
631 #define FIELD(ENUM, NAME, WILDCARD) ENUM,
638 enum field_index index;
640 flow_wildcards_t wildcard; /* FWW_* bit. */
644 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
649 fprintf(stderr, "%s:\n", flow);
652 va_start(args, format);
653 ovs_fatal_valist(0, format, args);
657 parse_field_name(const char *name, const struct field **f_out)
659 static const struct field fields[N_FIELDS] = {
660 #define FIELD(ENUM, NAME, WILDCARD) { ENUM, NAME, WILDCARD },
664 const struct field *f;
666 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
667 if (!strcmp(f->name, name)) {
677 parse_field_value(struct cls_rule *rule, enum field_index index,
680 uint8_t mac[ETH_ADDR_LEN], mac_mask[ETH_ADDR_LEN];
681 ovs_be64 tun_id, tun_mask;
683 ovs_be16 tci, tci_mask;
684 struct in6_addr ipv6, ipv6_mask;
689 str_to_tun_id(value, &tun_id, &tun_mask);
690 cls_rule_set_tun_id_masked(rule, tun_id, tun_mask);
694 if (!ofputil_port_from_string(value, &port_no)) {
695 port_no = atoi(value);
697 cls_rule_set_in_port(rule, port_no);
701 cls_rule_set_dl_vlan(rule, htons(str_to_u32(value)));
705 cls_rule_set_dl_vlan_pcp(rule, str_to_u32(value));
709 str_to_vlan_tci(value, &tci, &tci_mask);
710 cls_rule_set_dl_tci_masked(rule, tci, tci_mask);
714 str_to_mac(value, mac);
715 cls_rule_set_dl_src(rule, mac);
719 str_to_eth_dst(value, mac, mac_mask);
720 cls_rule_set_dl_dst_masked(rule, mac, mac_mask);
724 cls_rule_set_dl_type(rule, htons(str_to_u32(value)));
728 str_to_ip(value, &ip, &mask);
729 cls_rule_set_nw_src_masked(rule, ip, mask);
733 str_to_ip(value, &ip, &mask);
734 cls_rule_set_nw_dst_masked(rule, ip, mask);
738 cls_rule_set_nw_proto(rule, str_to_u32(value));
742 cls_rule_set_nw_tos(rule, str_to_u32(value));
746 cls_rule_set_tp_src(rule, htons(str_to_u32(value)));
750 cls_rule_set_tp_dst(rule, htons(str_to_u32(value)));
754 cls_rule_set_icmp_type(rule, str_to_u32(value));
758 cls_rule_set_icmp_code(rule, str_to_u32(value));
762 str_to_mac(value, mac);
763 cls_rule_set_arp_sha(rule, mac);
767 str_to_mac(value, mac);
768 cls_rule_set_arp_tha(rule, mac);
772 str_to_ipv6(value, &ipv6, &ipv6_mask);
773 cls_rule_set_ipv6_src_masked(rule, &ipv6, &ipv6_mask);
777 str_to_ipv6(value, &ipv6, &ipv6_mask);
778 cls_rule_set_ipv6_dst_masked(rule, &ipv6, &ipv6_mask);
782 str_to_ipv6(value, &ipv6, NULL);
783 cls_rule_set_nd_target(rule, &ipv6);
787 str_to_mac(value, mac);
788 cls_rule_set_arp_sha(rule, mac);
792 str_to_mac(value, mac);
793 cls_rule_set_arp_tha(rule, mac);
802 parse_reg_value(struct cls_rule *rule, int reg_idx, const char *value)
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
810 unsigned long long int reg_value, reg_mask;
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 ®_value, ®_mask) == 2) {
816 cls_rule_set_reg_masked(rule, reg_idx, reg_value, reg_mask);
817 } else if (sscanf(value, "%lli", ®_value)) {
818 cls_rule_set_reg(rule, reg_idx, reg_value);
820 ovs_fatal(0, "register fields must take the form <value> "
821 "or <value>/<mask>");
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
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'. */
834 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
844 char *string = xstrdup(str_);
845 char *save_ptr = NULL;
854 fields = F_ACTIONS | F_COOKIE | F_TIMEOUT | F_PRIORITY;
861 case OFPFC_DELETE_STRICT:
862 fields = F_OUT_PORT | F_PRIORITY;
866 fields = F_ACTIONS | F_COOKIE;
869 case OFPFC_MODIFY_STRICT:
870 fields = F_ACTIONS | F_COOKIE | F_PRIORITY;
877 cls_rule_init_catchall(&fm->cr, OFP_DEFAULT_PRIORITY);
878 fm->cookie = htonll(0);
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;
886 if (fields & F_ACTIONS) {
887 struct ofpbuf actions;
890 act_str = strstr(string, "action");
892 ofp_fatal(str_, verbose, "must specify an action");
896 act_str = strchr(act_str + 1, '=');
898 ofp_fatal(str_, verbose, "must specify an action");
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);
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;
915 if (parse_protocol(name, &p)) {
916 cls_rule_set_dl_type(&fm->cr, htons(p->dl_type));
918 cls_rule_set_nw_proto(&fm->cr, p->nw_proto);
921 const struct field *f;
924 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
926 ofp_fatal(str_, verbose, "field %s missing value", name);
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")) {
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);
964 parse_field_value(&fm->cr, f->index, value);
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) {
971 fprintf(stderr, "%s:\n", str_);
973 ofp_fatal(str_, verbose, "only %d registers supported", FLOW_N_REGS);
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
983 ofp_fatal(str_, verbose, "unknown keyword %s", name);
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
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,
1002 enum nx_flow_format min_format, next_format;
1003 struct cls_rule rule_copy;
1004 struct ofpbuf actions;
1006 struct ofputil_flow_mod fm;
1008 ofpbuf_init(&actions, 64);
1009 parse_ofp_str(&fm, command, string, verbose);
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;
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. */
1023 ofputil_normalize_rule(&rule_copy, next_format);
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;
1031 ofm = ofputil_encode_flow_mod(&fm, *cur_format, *flow_mod_table_id);
1032 list_push_back(packets, &ofm->list_node);
1034 ofpbuf_uninit(&actions);
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. */
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)
1049 ok = ds_get_preprocessed_line(&s, stream) == 0;
1051 parse_ofp_flow_mod_str(packets, cur, flow_mod_table_id,
1052 ds_cstr(&s), command, true);
1060 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1061 bool aggregate, char *string)
1063 struct ofputil_flow_mod fm;
1065 parse_ofp_str(&fm, -1, string, false);
1066 fsr->aggregate = aggregate;
1068 fsr->out_port = fm.out_port;
1069 fsr->table_id = fm.table_id;