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"
27 #include "byte-order.h"
28 #include "dynamic-string.h"
30 #include "meta-flow.h"
31 #include "multipath.h"
34 #include "ofp-actions.h"
37 #include "openflow/openflow.h"
39 #include "socket-util.h"
43 VLOG_DEFINE_THIS_MODULE(ofp_parse);
45 static void ofp_fatal(const char *flow, bool verbose, const char *format, ...)
49 str_to_table_id(const char *str)
53 if (!str_to_int(str, 10, &table_id) || table_id < 0 || table_id > 255) {
54 ovs_fatal(0, "invalid table \"%s\"", str);
60 str_to_u16(const char *str, const char *name)
64 if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
65 ovs_fatal(0, "invalid %s \"%s\"", name, str);
71 str_to_u32(const char *str)
77 ovs_fatal(0, "missing required numeric argument");
81 value = strtoul(str, &tail, 0);
82 if (errno == EINVAL || errno == ERANGE || *tail) {
83 ovs_fatal(0, "invalid numeric format %s", str);
89 str_to_u64(const char *str)
95 ovs_fatal(0, "missing required numeric argument");
99 value = strtoull(str, &tail, 0);
100 if (errno == EINVAL || errno == ERANGE || *tail) {
101 ovs_fatal(0, "invalid numeric format %s", str);
107 str_to_mac(const char *str, uint8_t mac[6])
109 if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
110 != ETH_ADDR_SCAN_COUNT) {
111 ovs_fatal(0, "invalid mac address %s", str);
116 str_to_ip(const char *str, ovs_be32 *ip)
118 struct in_addr in_addr;
120 if (lookup_ip(str, &in_addr)) {
121 ovs_fatal(0, "%s: could not convert to IP address", str);
123 *ip = in_addr.s_addr;
127 parse_enqueue(char *arg, struct ofpbuf *ofpacts)
130 char *port = strtok_r(arg, ":q", &sp);
131 char *queue = strtok_r(NULL, "", &sp);
132 struct ofpact_enqueue *enqueue;
134 if (port == NULL || queue == NULL) {
135 ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
138 enqueue = ofpact_put_ENQUEUE(ofpacts);
139 enqueue->port = str_to_u32(port);
140 enqueue->queue = str_to_u32(queue);
144 parse_output(char *arg, struct ofpbuf *ofpacts)
146 if (strchr(arg, '[')) {
147 struct ofpact_output_reg *output_reg;
149 output_reg = ofpact_put_OUTPUT_REG(ofpacts);
150 mf_parse_subfield(&output_reg->src, arg);
151 output_reg->max_len = UINT16_MAX;
153 struct ofpact_output *output;
155 output = ofpact_put_OUTPUT(ofpacts);
156 output->port = str_to_u32(arg);
157 output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
162 parse_resubmit(char *arg, struct ofpbuf *ofpacts)
164 struct ofpact_resubmit *resubmit;
165 char *in_port_s, *table_s;
167 resubmit = ofpact_put_RESUBMIT(ofpacts);
169 in_port_s = strsep(&arg, ",");
170 if (in_port_s && in_port_s[0]) {
171 if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
172 ovs_fatal(0, "%s: resubmit to unknown port", in_port_s);
175 resubmit->in_port = OFPP_IN_PORT;
178 table_s = strsep(&arg, ",");
179 resubmit->table_id = table_s && table_s[0] ? str_to_u32(table_s) : 255;
181 if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
182 ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
188 parse_note(const char *arg, struct ofpbuf *ofpacts)
190 struct ofpact_note *note;
192 note = ofpact_put_NOTE(ofpacts);
193 while (*arg != '\0') {
204 byte = hexits_value(arg, 2, &ok);
206 ovs_fatal(0, "bad hex digit in `note' argument");
208 ofpbuf_put(ofpacts, &byte, 1);
215 ofpact_update_len(ofpacts, ¬e->ofpact);
219 parse_fin_timeout(struct ofpbuf *b, char *arg)
221 struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
224 while (ofputil_parse_key_value(&arg, &key, &value)) {
225 if (!strcmp(key, "idle_timeout")) {
226 oft->fin_idle_timeout = str_to_u16(value, key);
227 } else if (!strcmp(key, "hard_timeout")) {
228 oft->fin_hard_timeout = str_to_u16(value, key);
230 ovs_fatal(0, "invalid key '%s' in 'fin_timeout' argument", key);
236 parse_controller(struct ofpbuf *b, char *arg)
238 enum ofp_packet_in_reason reason = OFPR_ACTION;
239 uint16_t controller_id = 0;
240 uint16_t max_len = UINT16_MAX;
244 } else if (strspn(arg, "0123456789") == strlen(arg)) {
245 max_len = str_to_u16(arg, "max_len");
249 while (ofputil_parse_key_value(&arg, &name, &value)) {
250 if (!strcmp(name, "reason")) {
251 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
252 ovs_fatal(0, "unknown reason \"%s\"", value);
254 } else if (!strcmp(name, "max_len")) {
255 max_len = str_to_u16(value, "max_len");
256 } else if (!strcmp(name, "id")) {
257 controller_id = str_to_u16(value, "id");
259 ovs_fatal(0, "unknown key \"%s\" parsing controller action",
265 if (reason == OFPR_ACTION && controller_id == 0) {
266 struct ofpact_output *output;
268 output = ofpact_put_OUTPUT(b);
269 output->port = OFPP_CONTROLLER;
270 output->max_len = max_len;
272 struct ofpact_controller *controller;
274 controller = ofpact_put_CONTROLLER(b);
275 controller->max_len = max_len;
276 controller->reason = reason;
277 controller->controller_id = controller_id;
282 parse_noargs_dec_ttl(struct ofpbuf *b)
284 struct ofpact_cnt_ids *ids;
287 ids = ofpact_put_DEC_TTL(b);
288 ofpbuf_put(b, &id, sizeof id);
290 ids->n_controllers++;
291 ofpact_update_len(b, &ids->ofpact);
295 parse_dec_ttl(struct ofpbuf *b, char *arg)
298 parse_noargs_dec_ttl(b);
300 struct ofpact_cnt_ids *ids;
303 ids = ofpact_put_DEC_TTL(b);
304 ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
305 for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
306 cntr = strtok_r(NULL, ", ", &arg)) {
307 uint16_t id = atoi(cntr);
309 ofpbuf_put(b, &id, sizeof id);
311 ids->n_controllers++;
313 if (!ids->n_controllers) {
314 ovs_fatal(0, "dec_ttl_cnt_ids: expected at least one controller "
317 ofpact_update_len(b, &ids->ofpact);
322 set_field_parse(const char *arg, struct ofpbuf *ofpacts)
324 char *orig = xstrdup(arg);
325 struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
329 const struct mf_field *mf;
331 union mf_value mf_value;
334 delim = strstr(orig, "->");
336 ovs_fatal(0, "%s: missing `->'", orig);
338 if (strlen(delim) <= strlen("->")) {
339 ovs_fatal(0, "%s: missing field name following `->'", orig);
342 key = delim + strlen("->");
343 mf = mf_from_name(key);
345 ovs_fatal(0, "%s is not valid oxm field name", key);
348 ovs_fatal(0, "%s is not allowed to set", key);
352 error = mf_parse_value(mf, value, &mf_value);
354 ovs_fatal(0, "%s", error);
356 if (!mf_is_value_valid(mf, &mf_value)) {
357 ovs_fatal(0, "%s is not valid valid for field %s", value, key);
359 ofpact_set_field_init(load, mf, &mf_value);
364 parse_metadata(struct ofpbuf *b, char *arg)
366 struct ofpact_metadata *om;
367 char *mask = strchr(arg, '/');
369 om = ofpact_put_WRITE_METADATA(b);
373 om->mask = htonll(str_to_u64(mask + 1));
375 om->mask = htonll(UINT64_MAX);
378 om->metadata = htonll(str_to_u64(arg));
382 parse_named_action(enum ofputil_action_code code, const struct flow *flow,
383 char *arg, struct ofpbuf *ofpacts)
385 struct ofpact_tunnel *tunnel;
393 case OFPUTIL_ACTION_INVALID:
396 case OFPUTIL_OFPAT10_OUTPUT:
397 case OFPUTIL_OFPAT11_OUTPUT:
398 parse_output(arg, ofpacts);
401 case OFPUTIL_OFPAT10_SET_VLAN_VID:
402 case OFPUTIL_OFPAT11_SET_VLAN_VID:
403 vid = str_to_u32(arg);
404 if (vid & ~VLAN_VID_MASK) {
405 ovs_fatal(0, "%s: not a valid VLAN VID", arg);
407 ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
410 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
411 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
412 pcp = str_to_u32(arg);
414 ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
416 ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
419 case OFPUTIL_OFPAT12_SET_FIELD:
420 set_field_parse(arg, ofpacts);
423 case OFPUTIL_OFPAT10_STRIP_VLAN:
424 case OFPUTIL_OFPAT11_POP_VLAN:
425 ofpact_put_STRIP_VLAN(ofpacts);
428 case OFPUTIL_OFPAT11_PUSH_VLAN:
429 ethertype = str_to_u16(arg, "ethertype");
430 if (ethertype != ETH_TYPE_VLAN_8021Q) {
431 /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
432 ovs_fatal(0, "%s: not a valid VLAN ethertype", arg);
434 ofpact_put_PUSH_VLAN(ofpacts);
437 case OFPUTIL_OFPAT11_SET_QUEUE:
438 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
442 case OFPUTIL_OFPAT10_SET_DL_SRC:
443 case OFPUTIL_OFPAT11_SET_DL_SRC:
444 str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
447 case OFPUTIL_OFPAT10_SET_DL_DST:
448 case OFPUTIL_OFPAT11_SET_DL_DST:
449 str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
452 case OFPUTIL_OFPAT10_SET_NW_SRC:
453 case OFPUTIL_OFPAT11_SET_NW_SRC:
455 ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
458 case OFPUTIL_OFPAT10_SET_NW_DST:
459 case OFPUTIL_OFPAT11_SET_NW_DST:
461 ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
464 case OFPUTIL_OFPAT10_SET_NW_TOS:
465 case OFPUTIL_OFPAT11_SET_NW_TOS:
466 tos = str_to_u32(arg);
467 if (tos & ~IP_DSCP_MASK) {
468 ovs_fatal(0, "%s: not a valid TOS", arg);
470 ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
473 case OFPUTIL_OFPAT11_DEC_NW_TTL:
476 case OFPUTIL_OFPAT10_SET_TP_SRC:
477 case OFPUTIL_OFPAT11_SET_TP_SRC:
478 ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
481 case OFPUTIL_OFPAT10_SET_TP_DST:
482 case OFPUTIL_OFPAT11_SET_TP_DST:
483 ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
486 case OFPUTIL_OFPAT10_ENQUEUE:
487 parse_enqueue(arg, ofpacts);
490 case OFPUTIL_NXAST_RESUBMIT:
491 parse_resubmit(arg, ofpacts);
494 case OFPUTIL_NXAST_SET_TUNNEL:
495 case OFPUTIL_NXAST_SET_TUNNEL64:
496 tunnel = ofpact_put_SET_TUNNEL(ofpacts);
497 tunnel->ofpact.compat = code;
498 tunnel->tun_id = str_to_u64(arg);
501 case OFPUTIL_NXAST_WRITE_METADATA:
502 parse_metadata(ofpacts, arg);
505 case OFPUTIL_NXAST_SET_QUEUE:
506 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
509 case OFPUTIL_NXAST_POP_QUEUE:
510 ofpact_put_POP_QUEUE(ofpacts);
513 case OFPUTIL_NXAST_REG_MOVE:
514 nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
517 case OFPUTIL_NXAST_REG_LOAD:
518 nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
521 case OFPUTIL_NXAST_NOTE:
522 parse_note(arg, ofpacts);
525 case OFPUTIL_NXAST_MULTIPATH:
526 multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
529 case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
530 autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
533 case OFPUTIL_NXAST_BUNDLE:
534 bundle_parse(arg, ofpacts);
537 case OFPUTIL_NXAST_BUNDLE_LOAD:
538 bundle_parse_load(arg, ofpacts);
541 case OFPUTIL_NXAST_RESUBMIT_TABLE:
542 case OFPUTIL_NXAST_OUTPUT_REG:
543 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
546 case OFPUTIL_NXAST_LEARN:
547 learn_parse(arg, flow, ofpacts);
550 case OFPUTIL_NXAST_EXIT:
551 ofpact_put_EXIT(ofpacts);
554 case OFPUTIL_NXAST_DEC_TTL:
555 parse_dec_ttl(ofpacts, arg);
558 case OFPUTIL_NXAST_FIN_TIMEOUT:
559 parse_fin_timeout(ofpacts, arg);
562 case OFPUTIL_NXAST_CONTROLLER:
563 parse_controller(ofpacts, arg);
569 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
570 struct ofpbuf *ofpacts, int n_actions)
572 int code = ofputil_action_code_from_name(act);
574 parse_named_action(code, flow, arg, ofpacts);
575 } else if (!strcasecmp(act, "drop")) {
577 ovs_fatal(0, "Drop actions must not be preceded by other "
579 } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
580 ovs_fatal(0, "Drop actions must not be followed by other "
586 if (ofputil_port_from_string(act, &port)) {
587 ofpact_put_OUTPUT(ofpacts)->port = port;
589 ovs_fatal(0, "Unknown action: %s", act);
597 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
599 char *pos, *act, *arg;
605 while (ofputil_parse_key_value(&pos, &act, &arg)) {
606 if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
612 error = ofpacts_verify(ofpacts->data, ofpacts->size);
614 ovs_fatal(0, "Incorrect action ordering");
621 parse_named_instruction(enum ovs_instruction_type type,
622 char *arg, struct ofpbuf *ofpacts)
627 case OVSINST_OFPIT11_APPLY_ACTIONS:
628 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
631 case OVSINST_OFPIT11_WRITE_ACTIONS:
633 ovs_fatal(0, "instruction write-actions is not supported yet");
636 case OVSINST_OFPIT11_CLEAR_ACTIONS:
637 ofpact_put_CLEAR_ACTIONS(ofpacts);
640 case OVSINST_OFPIT11_WRITE_METADATA:
641 parse_metadata(ofpacts, arg);
644 case OVSINST_OFPIT11_GOTO_TABLE: {
645 struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
646 char *table_s = strsep(&arg, ",");
647 if (!table_s || !table_s[0]) {
648 ovs_fatal(0, "instruction goto-table needs table id");
650 ogt->table_id = str_to_table_id(table_s);
655 /* If write_metadata is specified as an action AND an instruction, ofpacts
657 error = ofpacts_verify(ofpacts->data, ofpacts->size);
659 ovs_fatal(0, "Incorrect instruction ordering");
664 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
666 char *pos, *inst, *arg;
668 const char *prev_inst = NULL;
673 while (ofputil_parse_key_value(&pos, &inst, &arg)) {
674 type = ofpact_instruction_type_from_name(inst);
676 if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
680 type = OVSINST_OFPIT11_APPLY_ACTIONS;
681 if (prev_type == type) {
685 } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
686 ovs_fatal(0, "%s isn't supported. Just write actions then "
687 "it is interpreted as apply_actions", inst);
689 parse_named_instruction(type, arg, ofpacts);
692 if (type == prev_type) {
693 ovs_fatal(0, "instruction can be specified at most once: %s",
696 if (type <= prev_type) {
697 ovs_fatal(0, "Instruction %s must be specified before %s",
715 parse_protocol(const char *name, const struct protocol **p_out)
717 static const struct protocol protocols[] = {
718 { "ip", ETH_TYPE_IP, 0 },
719 { "arp", ETH_TYPE_ARP, 0 },
720 { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
721 { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
722 { "udp", ETH_TYPE_IP, IPPROTO_UDP },
723 { "ipv6", ETH_TYPE_IPV6, 0 },
724 { "ip6", ETH_TYPE_IPV6, 0 },
725 { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
726 { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
727 { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
728 { "rarp", ETH_TYPE_RARP, 0},
730 const struct protocol *p;
732 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
733 if (!strcmp(p->name, name)) {
743 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
748 fprintf(stderr, "%s:\n", flow);
751 va_start(args, format);
752 ovs_fatal_valist(0, format, args);
756 parse_field(const struct mf_field *mf, const char *s, struct match *match)
758 union mf_value value, mask;
761 error = mf_parse(mf, s, &value, &mask);
763 ovs_fatal(0, "%s", error);
766 mf_set(mf, &value, &mask, match);
769 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
770 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
771 * If 'actions' is specified, an action must be in 'string' and may be expanded
774 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
775 * constant for 'command'. To parse syntax for an OFPST_FLOW or
776 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
778 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
788 char *string = xstrdup(str_);
789 char *save_ptr = NULL;
790 char *act_str = NULL;
799 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
806 case OFPFC_DELETE_STRICT:
807 fields = F_OUT_PORT | F_PRIORITY;
811 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
814 case OFPFC_MODIFY_STRICT:
815 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
822 match_init_catchall(&fm->match);
823 fm->priority = OFP_DEFAULT_PRIORITY;
824 fm->cookie = htonll(0);
825 fm->cookie_mask = htonll(0);
826 if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
827 /* For modify, by default, don't update the cookie. */
828 fm->new_cookie = htonll(UINT64_MAX);
830 fm->new_cookie = htonll(0);
833 fm->command = command;
834 fm->idle_timeout = OFP_FLOW_PERMANENT;
835 fm->hard_timeout = OFP_FLOW_PERMANENT;
836 fm->buffer_id = UINT32_MAX;
837 fm->out_port = OFPP_ANY;
839 if (fields & F_ACTIONS) {
840 act_str = strstr(string, "action");
842 ofp_fatal(str_, verbose, "must specify an action");
846 act_str = strchr(act_str + 1, '=');
848 ofp_fatal(str_, verbose, "must specify an action");
853 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
854 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
855 const struct protocol *p;
857 if (parse_protocol(name, &p)) {
858 match_set_dl_type(&fm->match, htons(p->dl_type));
860 match_set_nw_proto(&fm->match, p->nw_proto);
862 } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
863 fm->flags |= OFPFF_SEND_FLOW_REM;
864 } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
865 fm->flags |= OFPFF_CHECK_OVERLAP;
866 } else if (fields & F_FLAGS && !strcmp(name, "reset_counts")) {
867 fm->flags |= OFPFF12_RESET_COUNTS;
868 } else if (fields & F_FLAGS && !strcmp(name, "no_packet_counts")) {
869 fm->flags |= OFPFF13_NO_PKT_COUNTS;
870 } else if (fields & F_FLAGS && !strcmp(name, "no_byte_counts")) {
871 fm->flags |= OFPFF13_NO_BYT_COUNTS;
875 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
877 ofp_fatal(str_, verbose, "field %s missing value", name);
880 if (!strcmp(name, "table")) {
881 fm->table_id = str_to_table_id(value);
882 } else if (!strcmp(name, "out_port")) {
883 if (!ofputil_port_from_string(name, &fm->out_port)) {
884 ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
887 } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
888 fm->priority = str_to_u16(value, name);
889 } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
890 fm->idle_timeout = str_to_u16(value, name);
891 } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
892 fm->hard_timeout = str_to_u16(value, name);
893 } else if (!strcmp(name, "cookie")) {
894 char *mask = strchr(value, '/');
897 /* A mask means we're searching for a cookie. */
898 if (command == OFPFC_ADD) {
899 ofp_fatal(str_, verbose, "flow additions cannot use "
903 fm->cookie = htonll(str_to_u64(value));
904 fm->cookie_mask = htonll(str_to_u64(mask+1));
906 /* No mask means that the cookie is being set. */
907 if (command != OFPFC_ADD && command != OFPFC_MODIFY
908 && command != OFPFC_MODIFY_STRICT) {
909 ofp_fatal(str_, verbose, "cannot set cookie");
911 fm->new_cookie = htonll(str_to_u64(value));
913 } else if (mf_from_name(name)) {
914 parse_field(mf_from_name(name), value, &fm->match);
915 } else if (!strcmp(name, "duration")
916 || !strcmp(name, "n_packets")
917 || !strcmp(name, "n_bytes")) {
918 /* Ignore these, so that users can feed the output of
919 * "ovs-ofctl dump-flows" back into commands that parse
922 ofp_fatal(str_, verbose, "unknown keyword %s", name);
926 if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
927 && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
928 /* On modifies without a mask, we are supposed to add a flow if
929 * one does not exist. If a cookie wasn't been specified, use a
930 * default of zero. */
931 fm->new_cookie = htonll(0);
933 if (fields & F_ACTIONS) {
934 struct ofpbuf ofpacts;
936 ofpbuf_init(&ofpacts, 32);
937 str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
938 fm->ofpacts_len = ofpacts.size;
939 fm->ofpacts = ofpbuf_steal_data(&ofpacts);
948 /* Convert 'str_' (as described in the documentation for the "monitor" command
949 * in the ovs-ofctl man page) into 'fmr'. */
951 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
956 char *string = xstrdup(str_);
957 char *save_ptr = NULL;
961 fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
962 | NXFMF_OWN | NXFMF_ACTIONS);
963 fmr->out_port = OFPP_NONE;
964 fmr->table_id = 0xff;
965 match_init_catchall(&fmr->match);
967 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
968 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
969 const struct protocol *p;
971 if (!strcmp(name, "!initial")) {
972 fmr->flags &= ~NXFMF_INITIAL;
973 } else if (!strcmp(name, "!add")) {
974 fmr->flags &= ~NXFMF_ADD;
975 } else if (!strcmp(name, "!delete")) {
976 fmr->flags &= ~NXFMF_DELETE;
977 } else if (!strcmp(name, "!modify")) {
978 fmr->flags &= ~NXFMF_MODIFY;
979 } else if (!strcmp(name, "!actions")) {
980 fmr->flags &= ~NXFMF_ACTIONS;
981 } else if (!strcmp(name, "!own")) {
982 fmr->flags &= ~NXFMF_OWN;
983 } else if (parse_protocol(name, &p)) {
984 match_set_dl_type(&fmr->match, htons(p->dl_type));
986 match_set_nw_proto(&fmr->match, p->nw_proto);
991 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
993 ovs_fatal(0, "%s: field %s missing value", str_, name);
996 if (!strcmp(name, "table")) {
997 fmr->table_id = str_to_table_id(value);
998 } else if (!strcmp(name, "out_port")) {
999 fmr->out_port = atoi(value);
1000 } else if (mf_from_name(name)) {
1001 parse_field(mf_from_name(name), value, &fmr->match);
1003 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
1010 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1013 * Prints an error on stderr and aborts the program if 's' syntax is
1016 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
1018 char *s = xstrdup(s_);
1019 str_to_ofpacts(NULL, s, ofpacts);
1023 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1024 * (one of OFPFC_*) into 'fm'. */
1026 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1027 uint16_t command, bool verbose)
1029 struct match match_copy;
1031 parse_ofp_str(fm, command, string, verbose);
1033 /* Normalize a copy of the match. This ensures that non-normalized flows
1034 * get logged but doesn't affect what gets sent to the switch, so that the
1035 * switch can do whatever it likes with the flow. */
1036 match_copy = fm->match;
1037 ofputil_normalize_match(&match_copy);
1041 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1042 struct ofputil_flow_mod **fms, size_t *n_fms)
1044 size_t allocated_fms;
1048 stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1049 if (stream == NULL) {
1050 ovs_fatal(errno, "%s: open", file_name);
1053 allocated_fms = *n_fms;
1055 while (!ds_get_preprocessed_line(&s, stream)) {
1056 if (*n_fms >= allocated_fms) {
1057 *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1059 parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1064 if (stream != stdin) {
1070 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1071 bool aggregate, const char *string)
1073 struct ofputil_flow_mod fm;
1075 parse_ofp_str(&fm, -1, string, false);
1076 fsr->aggregate = aggregate;
1077 fsr->cookie = fm.cookie;
1078 fsr->cookie_mask = fm.cookie_mask;
1079 fsr->match = fm.match;
1080 fsr->out_port = fm.out_port;
1081 fsr->table_id = fm.table_id;
1084 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1085 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1086 * mf_field. Fields must be specified in a natural order for satisfying
1089 * Returns NULL on success, otherwise a malloc()'d string that explains the
1092 parse_ofp_exact_flow(struct flow *flow, const char *s)
1094 char *pos, *key, *value_s;
1098 memset(flow, 0, sizeof *flow);
1100 pos = copy = xstrdup(s);
1101 while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1102 const struct protocol *p;
1103 if (parse_protocol(key, &p)) {
1104 if (flow->dl_type) {
1105 error = xasprintf("%s: Ethernet type set multiple times", s);
1108 flow->dl_type = htons(p->dl_type);
1111 if (flow->nw_proto) {
1112 error = xasprintf("%s: network protocol set "
1113 "multiple times", s);
1116 flow->nw_proto = p->nw_proto;
1119 const struct mf_field *mf;
1120 union mf_value value;
1123 mf = mf_from_name(key);
1125 error = xasprintf("%s: unknown field %s", s, key);
1129 if (!mf_are_prereqs_ok(mf, flow)) {
1130 error = xasprintf("%s: prerequisites not met for setting %s",
1135 if (!mf_is_zero(mf, flow)) {
1136 error = xasprintf("%s: field %s set multiple times", s, key);
1140 field_error = mf_parse_value(mf, value_s, &value);
1142 error = xasprintf("%s: bad value for %s (%s)",
1143 s, key, field_error);
1148 mf_set_flow_value(mf, &value, flow);
1156 memset(flow, 0, sizeof *flow);