2 * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
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"
26 #include "byte-order.h"
27 #include "dynamic-string.h"
29 #include "meta-flow.h"
30 #include "multipath.h"
33 #include "ofp-actions.h"
36 #include "openflow/openflow.h"
38 #include "socket-util.h"
42 VLOG_DEFINE_THIS_MODULE(ofp_parse);
44 static void ofp_fatal(const char *flow, bool verbose, const char *format, ...)
48 str_to_table_id(const char *str)
52 if (!str_to_int(str, 10, &table_id) || table_id < 0 || table_id > 255) {
53 ovs_fatal(0, "invalid table \"%s\"", str);
59 str_to_u16(const char *str, const char *name)
63 if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
64 ovs_fatal(0, "invalid %s \"%s\"", name, str);
70 str_to_u32(const char *str)
76 ovs_fatal(0, "missing required numeric argument");
80 value = strtoul(str, &tail, 0);
81 if (errno == EINVAL || errno == ERANGE || *tail) {
82 ovs_fatal(0, "invalid numeric format %s", str);
88 str_to_u64(const char *str)
94 ovs_fatal(0, "missing required numeric argument");
98 value = strtoull(str, &tail, 0);
99 if (errno == EINVAL || errno == ERANGE || *tail) {
100 ovs_fatal(0, "invalid numeric format %s", str);
106 str_to_mac(const char *str, uint8_t mac[6])
108 if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
109 != ETH_ADDR_SCAN_COUNT) {
110 ovs_fatal(0, "invalid mac address %s", str);
115 str_to_ip(const char *str, ovs_be32 *ip)
117 struct in_addr in_addr;
119 if (lookup_ip(str, &in_addr)) {
120 ovs_fatal(0, "%s: could not convert to IP address", str);
122 *ip = in_addr.s_addr;
126 parse_enqueue(char *arg, struct ofpbuf *ofpacts)
129 char *port = strtok_r(arg, ":q", &sp);
130 char *queue = strtok_r(NULL, "", &sp);
131 struct ofpact_enqueue *enqueue;
133 if (port == NULL || queue == NULL) {
134 ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
137 enqueue = ofpact_put_ENQUEUE(ofpacts);
138 enqueue->port = str_to_u32(port);
139 enqueue->queue = str_to_u32(queue);
143 parse_output(char *arg, struct ofpbuf *ofpacts)
145 if (strchr(arg, '[')) {
146 struct ofpact_output_reg *output_reg;
148 output_reg = ofpact_put_OUTPUT_REG(ofpacts);
149 mf_parse_subfield(&output_reg->src, arg);
150 output_reg->max_len = UINT16_MAX;
152 struct ofpact_output *output;
154 output = ofpact_put_OUTPUT(ofpacts);
155 output->port = str_to_u32(arg);
156 output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
161 parse_resubmit(char *arg, struct ofpbuf *ofpacts)
163 struct ofpact_resubmit *resubmit;
164 char *in_port_s, *table_s;
166 resubmit = ofpact_put_RESUBMIT(ofpacts);
168 in_port_s = strsep(&arg, ",");
169 if (in_port_s && in_port_s[0]) {
170 if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
171 ovs_fatal(0, "%s: resubmit to unknown port", in_port_s);
174 resubmit->in_port = OFPP_IN_PORT;
177 table_s = strsep(&arg, ",");
178 resubmit->table_id = table_s && table_s[0] ? str_to_u32(table_s) : 255;
180 if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
181 ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
187 parse_note(const char *arg, struct ofpbuf *ofpacts)
189 struct ofpact_note *note;
191 note = ofpact_put_NOTE(ofpacts);
192 while (*arg != '\0') {
203 byte = hexits_value(arg, 2, &ok);
205 ovs_fatal(0, "bad hex digit in `note' argument");
207 ofpbuf_put(ofpacts, &byte, 1);
214 ofpact_update_len(ofpacts, ¬e->ofpact);
218 parse_fin_timeout(struct ofpbuf *b, char *arg)
220 struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
223 while (ofputil_parse_key_value(&arg, &key, &value)) {
224 if (!strcmp(key, "idle_timeout")) {
225 oft->fin_idle_timeout = str_to_u16(value, key);
226 } else if (!strcmp(key, "hard_timeout")) {
227 oft->fin_hard_timeout = str_to_u16(value, key);
229 ovs_fatal(0, "invalid key '%s' in 'fin_timeout' argument", key);
235 parse_controller(struct ofpbuf *b, char *arg)
237 enum ofp_packet_in_reason reason = OFPR_ACTION;
238 uint16_t controller_id = 0;
239 uint16_t max_len = UINT16_MAX;
243 } else if (strspn(arg, "0123456789") == strlen(arg)) {
244 max_len = str_to_u16(arg, "max_len");
248 while (ofputil_parse_key_value(&arg, &name, &value)) {
249 if (!strcmp(name, "reason")) {
250 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
251 ovs_fatal(0, "unknown reason \"%s\"", value);
253 } else if (!strcmp(name, "max_len")) {
254 max_len = str_to_u16(value, "max_len");
255 } else if (!strcmp(name, "id")) {
256 controller_id = str_to_u16(value, "id");
258 ovs_fatal(0, "unknown key \"%s\" parsing controller action",
264 if (reason == OFPR_ACTION && controller_id == 0) {
265 struct ofpact_output *output;
267 output = ofpact_put_OUTPUT(b);
268 output->port = OFPP_CONTROLLER;
269 output->max_len = max_len;
271 struct ofpact_controller *controller;
273 controller = ofpact_put_CONTROLLER(b);
274 controller->max_len = max_len;
275 controller->reason = reason;
276 controller->controller_id = controller_id;
281 parse_noargs_dec_ttl(struct ofpbuf *b)
283 struct ofpact_cnt_ids *ids;
286 ids = ofpact_put_DEC_TTL(b);
287 ofpbuf_put(b, &id, sizeof id);
289 ids->n_controllers++;
290 ofpact_update_len(b, &ids->ofpact);
294 parse_dec_ttl(struct ofpbuf *b, char *arg)
297 parse_noargs_dec_ttl(b);
299 struct ofpact_cnt_ids *ids;
302 ids = ofpact_put_DEC_TTL(b);
303 ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
304 for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
305 cntr = strtok_r(NULL, ", ", &arg)) {
306 uint16_t id = atoi(cntr);
308 ofpbuf_put(b, &id, sizeof id);
310 ids->n_controllers++;
312 if (!ids->n_controllers) {
313 ovs_fatal(0, "dec_ttl_cnt_ids: expected at least one controller "
316 ofpact_update_len(b, &ids->ofpact);
321 set_field_parse(const char *arg, struct ofpbuf *ofpacts)
323 char *orig = xstrdup(arg);
324 struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
328 const struct mf_field *mf;
330 union mf_value mf_value;
333 delim = strstr(orig, "->");
335 ovs_fatal(0, "%s: missing `->'", orig);
337 if (strlen(delim) <= strlen("->")) {
338 ovs_fatal(0, "%s: missing field name following `->'", orig);
341 key = delim + strlen("->");
342 mf = mf_from_name(key);
344 ovs_fatal(0, "%s is not valid oxm field name", key);
347 ovs_fatal(0, "%s is not allowed to set", key);
351 error = mf_parse_value(mf, value, &mf_value);
353 ovs_fatal(0, "%s", error);
355 if (!mf_is_value_valid(mf, &mf_value)) {
356 ovs_fatal(0, "%s is not valid valid for field %s", value, key);
358 ofpact_set_field_init(load, mf, &mf_value);
363 parse_metadata(struct ofpbuf *b, char *arg)
365 struct ofpact_metadata *om;
366 char *mask = strchr(arg, '/');
368 om = ofpact_put_WRITE_METADATA(b);
372 om->mask = htonll(str_to_u64(mask + 1));
374 om->mask = htonll(UINT64_MAX);
377 om->metadata = htonll(str_to_u64(arg));
381 parse_named_action(enum ofputil_action_code code, const struct flow *flow,
382 char *arg, struct ofpbuf *ofpacts)
384 struct ofpact_tunnel *tunnel;
392 case OFPUTIL_ACTION_INVALID:
395 case OFPUTIL_OFPAT10_OUTPUT:
396 case OFPUTIL_OFPAT11_OUTPUT:
397 parse_output(arg, ofpacts);
400 case OFPUTIL_OFPAT10_SET_VLAN_VID:
401 case OFPUTIL_OFPAT11_SET_VLAN_VID:
402 vid = str_to_u32(arg);
403 if (vid & ~VLAN_VID_MASK) {
404 ovs_fatal(0, "%s: not a valid VLAN VID", arg);
406 ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
409 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
410 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
411 pcp = str_to_u32(arg);
413 ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
415 ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
418 case OFPUTIL_OFPAT12_SET_FIELD:
419 set_field_parse(arg, ofpacts);
422 case OFPUTIL_OFPAT10_STRIP_VLAN:
423 case OFPUTIL_OFPAT11_POP_VLAN:
424 ofpact_put_STRIP_VLAN(ofpacts);
427 case OFPUTIL_OFPAT11_PUSH_VLAN:
428 ethertype = str_to_u16(arg, "ethertype");
429 if (ethertype != ETH_TYPE_VLAN_8021Q) {
430 /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
431 ovs_fatal(0, "%s: not a valid VLAN ethertype", arg);
433 ofpact_put_PUSH_VLAN(ofpacts);
436 case OFPUTIL_OFPAT11_SET_QUEUE:
437 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
441 case OFPUTIL_OFPAT10_SET_DL_SRC:
442 case OFPUTIL_OFPAT11_SET_DL_SRC:
443 str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
446 case OFPUTIL_OFPAT10_SET_DL_DST:
447 case OFPUTIL_OFPAT11_SET_DL_DST:
448 str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
451 case OFPUTIL_OFPAT10_SET_NW_SRC:
452 case OFPUTIL_OFPAT11_SET_NW_SRC:
454 ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
457 case OFPUTIL_OFPAT10_SET_NW_DST:
458 case OFPUTIL_OFPAT11_SET_NW_DST:
460 ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
463 case OFPUTIL_OFPAT10_SET_NW_TOS:
464 case OFPUTIL_OFPAT11_SET_NW_TOS:
465 tos = str_to_u32(arg);
466 if (tos & ~IP_DSCP_MASK) {
467 ovs_fatal(0, "%s: not a valid TOS", arg);
469 ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
472 case OFPUTIL_OFPAT11_DEC_NW_TTL:
475 case OFPUTIL_OFPAT10_SET_TP_SRC:
476 case OFPUTIL_OFPAT11_SET_TP_SRC:
477 ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
480 case OFPUTIL_OFPAT10_SET_TP_DST:
481 case OFPUTIL_OFPAT11_SET_TP_DST:
482 ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
485 case OFPUTIL_OFPAT10_ENQUEUE:
486 parse_enqueue(arg, ofpacts);
489 case OFPUTIL_NXAST_RESUBMIT:
490 parse_resubmit(arg, ofpacts);
493 case OFPUTIL_NXAST_SET_TUNNEL:
494 case OFPUTIL_NXAST_SET_TUNNEL64:
495 tunnel = ofpact_put_SET_TUNNEL(ofpacts);
496 tunnel->ofpact.compat = code;
497 tunnel->tun_id = str_to_u64(arg);
500 case OFPUTIL_NXAST_WRITE_METADATA:
501 parse_metadata(ofpacts, arg);
504 case OFPUTIL_NXAST_SET_QUEUE:
505 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
508 case OFPUTIL_NXAST_POP_QUEUE:
509 ofpact_put_POP_QUEUE(ofpacts);
512 case OFPUTIL_NXAST_REG_MOVE:
513 nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
516 case OFPUTIL_NXAST_REG_LOAD:
517 nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
520 case OFPUTIL_NXAST_NOTE:
521 parse_note(arg, ofpacts);
524 case OFPUTIL_NXAST_MULTIPATH:
525 multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
528 case OFPUTIL_NXAST_BUNDLE:
529 bundle_parse(arg, ofpacts);
532 case OFPUTIL_NXAST_BUNDLE_LOAD:
533 bundle_parse_load(arg, ofpacts);
536 case OFPUTIL_NXAST_RESUBMIT_TABLE:
537 case OFPUTIL_NXAST_OUTPUT_REG:
538 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
541 case OFPUTIL_NXAST_LEARN:
542 learn_parse(arg, flow, ofpacts);
545 case OFPUTIL_NXAST_EXIT:
546 ofpact_put_EXIT(ofpacts);
549 case OFPUTIL_NXAST_DEC_TTL:
550 parse_dec_ttl(ofpacts, arg);
553 case OFPUTIL_NXAST_FIN_TIMEOUT:
554 parse_fin_timeout(ofpacts, arg);
557 case OFPUTIL_NXAST_CONTROLLER:
558 parse_controller(ofpacts, arg);
561 case OFPUTIL_OFPAT11_PUSH_MPLS:
562 case OFPUTIL_NXAST_PUSH_MPLS:
563 ofpact_put_PUSH_MPLS(ofpacts)->ethertype =
564 htons(str_to_u16(arg, "push_mpls"));
567 case OFPUTIL_OFPAT11_POP_MPLS:
568 case OFPUTIL_NXAST_POP_MPLS:
569 ofpact_put_POP_MPLS(ofpacts)->ethertype =
570 htons(str_to_u16(arg, "pop_mpls"));
576 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
577 struct ofpbuf *ofpacts, int n_actions)
579 int code = ofputil_action_code_from_name(act);
581 parse_named_action(code, flow, arg, ofpacts);
582 } else if (!strcasecmp(act, "drop")) {
584 ovs_fatal(0, "Drop actions must not be preceded by other "
586 } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
587 ovs_fatal(0, "Drop actions must not be followed by other "
593 if (ofputil_port_from_string(act, &port)) {
594 ofpact_put_OUTPUT(ofpacts)->port = port;
596 ovs_fatal(0, "Unknown action: %s", act);
604 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
606 char *pos, *act, *arg;
612 while (ofputil_parse_key_value(&pos, &act, &arg)) {
613 if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
619 error = ofpacts_verify(ofpacts->data, ofpacts->size);
621 ovs_fatal(0, "Incorrect action ordering");
628 parse_named_instruction(enum ovs_instruction_type type,
629 char *arg, struct ofpbuf *ofpacts)
634 case OVSINST_OFPIT11_APPLY_ACTIONS:
635 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
638 case OVSINST_OFPIT11_WRITE_ACTIONS:
640 ovs_fatal(0, "instruction write-actions is not supported yet");
643 case OVSINST_OFPIT11_CLEAR_ACTIONS:
644 ofpact_put_CLEAR_ACTIONS(ofpacts);
647 case OVSINST_OFPIT11_WRITE_METADATA:
648 parse_metadata(ofpacts, arg);
651 case OVSINST_OFPIT11_GOTO_TABLE: {
652 struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
653 char *table_s = strsep(&arg, ",");
654 if (!table_s || !table_s[0]) {
655 ovs_fatal(0, "instruction goto-table needs table id");
657 ogt->table_id = str_to_table_id(table_s);
662 /* If write_metadata is specified as an action AND an instruction, ofpacts
664 error = ofpacts_verify(ofpacts->data, ofpacts->size);
666 ovs_fatal(0, "Incorrect instruction ordering");
671 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
673 char *pos, *inst, *arg;
675 const char *prev_inst = NULL;
680 while (ofputil_parse_key_value(&pos, &inst, &arg)) {
681 type = ofpact_instruction_type_from_name(inst);
683 if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
687 type = OVSINST_OFPIT11_APPLY_ACTIONS;
688 if (prev_type == type) {
692 } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
693 ovs_fatal(0, "%s isn't supported. Just write actions then "
694 "it is interpreted as apply_actions", inst);
696 parse_named_instruction(type, arg, ofpacts);
699 if (type == prev_type) {
700 ovs_fatal(0, "instruction can be specified at most once: %s",
703 if (type <= prev_type) {
704 ovs_fatal(0, "Instruction %s must be specified before %s",
722 parse_protocol(const char *name, const struct protocol **p_out)
724 static const struct protocol protocols[] = {
725 { "ip", ETH_TYPE_IP, 0 },
726 { "arp", ETH_TYPE_ARP, 0 },
727 { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
728 { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
729 { "udp", ETH_TYPE_IP, IPPROTO_UDP },
730 { "ipv6", ETH_TYPE_IPV6, 0 },
731 { "ip6", ETH_TYPE_IPV6, 0 },
732 { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
733 { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
734 { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
735 { "rarp", ETH_TYPE_RARP, 0},
736 { "mpls", ETH_TYPE_MPLS, 0 },
737 { "mplsm", ETH_TYPE_MPLS_MCAST, 0 },
739 const struct protocol *p;
741 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
742 if (!strcmp(p->name, name)) {
752 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
757 fprintf(stderr, "%s:\n", flow);
760 va_start(args, format);
761 ovs_fatal_valist(0, format, args);
765 parse_field(const struct mf_field *mf, const char *s, struct match *match)
767 union mf_value value, mask;
770 error = mf_parse(mf, s, &value, &mask);
772 ovs_fatal(0, "%s", error);
775 mf_set(mf, &value, &mask, match);
778 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
779 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
780 * If 'actions' is specified, an action must be in 'string' and may be expanded
783 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
784 * constant for 'command'. To parse syntax for an OFPST_FLOW or
785 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
787 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
797 char *string = xstrdup(str_);
798 char *save_ptr = NULL;
799 char *act_str = NULL;
808 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
815 case OFPFC_DELETE_STRICT:
816 fields = F_OUT_PORT | F_PRIORITY;
820 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
823 case OFPFC_MODIFY_STRICT:
824 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
831 match_init_catchall(&fm->match);
832 fm->priority = OFP_DEFAULT_PRIORITY;
833 fm->cookie = htonll(0);
834 fm->cookie_mask = htonll(0);
835 if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
836 /* For modify, by default, don't update the cookie. */
837 fm->new_cookie = htonll(UINT64_MAX);
839 fm->new_cookie = htonll(0);
842 fm->command = command;
843 fm->idle_timeout = OFP_FLOW_PERMANENT;
844 fm->hard_timeout = OFP_FLOW_PERMANENT;
845 fm->buffer_id = UINT32_MAX;
846 fm->out_port = OFPP_ANY;
848 if (fields & F_ACTIONS) {
849 act_str = strstr(string, "action");
851 ofp_fatal(str_, verbose, "must specify an action");
855 act_str = strchr(act_str + 1, '=');
857 ofp_fatal(str_, verbose, "must specify an action");
862 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
863 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
864 const struct protocol *p;
866 if (parse_protocol(name, &p)) {
867 match_set_dl_type(&fm->match, htons(p->dl_type));
869 match_set_nw_proto(&fm->match, p->nw_proto);
871 } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
872 fm->flags |= OFPFF_SEND_FLOW_REM;
873 } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
874 fm->flags |= OFPFF_CHECK_OVERLAP;
875 } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
876 fm->flags |= OFPFF12_RESET_COUNTS;
877 } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
878 fm->flags |= OFPFF13_NO_PKT_COUNTS;
879 } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
880 fm->flags |= OFPFF13_NO_BYT_COUNTS;
884 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
886 ofp_fatal(str_, verbose, "field %s missing value", name);
889 if (!strcmp(name, "table")) {
890 fm->table_id = str_to_table_id(value);
891 } else if (!strcmp(name, "out_port")) {
892 if (!ofputil_port_from_string(name, &fm->out_port)) {
893 ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
896 } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
897 fm->priority = str_to_u16(value, name);
898 } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
899 fm->idle_timeout = str_to_u16(value, name);
900 } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
901 fm->hard_timeout = str_to_u16(value, name);
902 } else if (!strcmp(name, "cookie")) {
903 char *mask = strchr(value, '/');
906 /* A mask means we're searching for a cookie. */
907 if (command == OFPFC_ADD) {
908 ofp_fatal(str_, verbose, "flow additions cannot use "
912 fm->cookie = htonll(str_to_u64(value));
913 fm->cookie_mask = htonll(str_to_u64(mask+1));
915 /* No mask means that the cookie is being set. */
916 if (command != OFPFC_ADD && command != OFPFC_MODIFY
917 && command != OFPFC_MODIFY_STRICT) {
918 ofp_fatal(str_, verbose, "cannot set cookie");
920 fm->new_cookie = htonll(str_to_u64(value));
922 } else if (mf_from_name(name)) {
923 parse_field(mf_from_name(name), value, &fm->match);
924 } else if (!strcmp(name, "duration")
925 || !strcmp(name, "n_packets")
926 || !strcmp(name, "n_bytes")
927 || !strcmp(name, "idle_age")
928 || !strcmp(name, "hard_age")) {
929 /* Ignore these, so that users can feed the output of
930 * "ovs-ofctl dump-flows" back into commands that parse
933 ofp_fatal(str_, verbose, "unknown keyword %s", name);
937 if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
938 && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
939 /* On modifies without a mask, we are supposed to add a flow if
940 * one does not exist. If a cookie wasn't been specified, use a
941 * default of zero. */
942 fm->new_cookie = htonll(0);
944 if (fields & F_ACTIONS) {
945 struct ofpbuf ofpacts;
947 ofpbuf_init(&ofpacts, 32);
948 str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
949 fm->ofpacts_len = ofpacts.size;
950 fm->ofpacts = ofpbuf_steal_data(&ofpacts);
959 /* Convert 'str_' (as described in the documentation for the "monitor" command
960 * in the ovs-ofctl man page) into 'fmr'. */
962 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
967 char *string = xstrdup(str_);
968 char *save_ptr = NULL;
972 fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
973 | NXFMF_OWN | NXFMF_ACTIONS);
974 fmr->out_port = OFPP_NONE;
975 fmr->table_id = 0xff;
976 match_init_catchall(&fmr->match);
978 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
979 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
980 const struct protocol *p;
982 if (!strcmp(name, "!initial")) {
983 fmr->flags &= ~NXFMF_INITIAL;
984 } else if (!strcmp(name, "!add")) {
985 fmr->flags &= ~NXFMF_ADD;
986 } else if (!strcmp(name, "!delete")) {
987 fmr->flags &= ~NXFMF_DELETE;
988 } else if (!strcmp(name, "!modify")) {
989 fmr->flags &= ~NXFMF_MODIFY;
990 } else if (!strcmp(name, "!actions")) {
991 fmr->flags &= ~NXFMF_ACTIONS;
992 } else if (!strcmp(name, "!own")) {
993 fmr->flags &= ~NXFMF_OWN;
994 } else if (parse_protocol(name, &p)) {
995 match_set_dl_type(&fmr->match, htons(p->dl_type));
997 match_set_nw_proto(&fmr->match, p->nw_proto);
1002 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1004 ovs_fatal(0, "%s: field %s missing value", str_, name);
1007 if (!strcmp(name, "table")) {
1008 fmr->table_id = str_to_table_id(value);
1009 } else if (!strcmp(name, "out_port")) {
1010 fmr->out_port = atoi(value);
1011 } else if (mf_from_name(name)) {
1012 parse_field(mf_from_name(name), value, &fmr->match);
1014 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
1021 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1024 * Prints an error on stderr and aborts the program if 's' syntax is
1027 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
1029 char *s = xstrdup(s_);
1030 str_to_ofpacts(NULL, s, ofpacts);
1034 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1035 * (one of OFPFC_*) into 'fm'. */
1037 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1038 uint16_t command, bool verbose)
1040 struct match match_copy;
1042 parse_ofp_str(fm, command, string, verbose);
1044 /* Normalize a copy of the match. This ensures that non-normalized flows
1045 * get logged but doesn't affect what gets sent to the switch, so that the
1046 * switch can do whatever it likes with the flow. */
1047 match_copy = fm->match;
1048 ofputil_normalize_match(&match_copy);
1052 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1053 struct ofputil_flow_mod **fms, size_t *n_fms)
1055 size_t allocated_fms;
1059 stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1060 if (stream == NULL) {
1061 ovs_fatal(errno, "%s: open", file_name);
1064 allocated_fms = *n_fms;
1066 while (!ds_get_preprocessed_line(&s, stream)) {
1067 if (*n_fms >= allocated_fms) {
1068 *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1070 parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1075 if (stream != stdin) {
1081 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1082 bool aggregate, const char *string)
1084 struct ofputil_flow_mod fm;
1086 parse_ofp_str(&fm, -1, string, false);
1087 fsr->aggregate = aggregate;
1088 fsr->cookie = fm.cookie;
1089 fsr->cookie_mask = fm.cookie_mask;
1090 fsr->match = fm.match;
1091 fsr->out_port = fm.out_port;
1092 fsr->table_id = fm.table_id;
1095 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1096 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1097 * mf_field. Fields must be specified in a natural order for satisfying
1100 * Returns NULL on success, otherwise a malloc()'d string that explains the
1103 parse_ofp_exact_flow(struct flow *flow, const char *s)
1105 char *pos, *key, *value_s;
1109 memset(flow, 0, sizeof *flow);
1111 pos = copy = xstrdup(s);
1112 while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1113 const struct protocol *p;
1114 if (parse_protocol(key, &p)) {
1115 if (flow->dl_type) {
1116 error = xasprintf("%s: Ethernet type set multiple times", s);
1119 flow->dl_type = htons(p->dl_type);
1122 if (flow->nw_proto) {
1123 error = xasprintf("%s: network protocol set "
1124 "multiple times", s);
1127 flow->nw_proto = p->nw_proto;
1130 const struct mf_field *mf;
1131 union mf_value value;
1134 mf = mf_from_name(key);
1136 error = xasprintf("%s: unknown field %s", s, key);
1140 if (!mf_are_prereqs_ok(mf, flow)) {
1141 error = xasprintf("%s: prerequisites not met for setting %s",
1146 if (!mf_is_zero(mf, flow)) {
1147 error = xasprintf("%s: field %s set multiple times", s, key);
1151 field_error = mf_parse_value(mf, value_s, &value);
1153 error = xasprintf("%s: bad value for %s (%s)",
1154 s, key, field_error);
1159 mf_set_flow_value(mf, &value, flow);
1163 if (!flow->in_port) {
1164 flow->in_port = OFPP_NONE;
1171 memset(flow, 0, sizeof *flow);