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;
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_OFPAT10_SET_DL_SRC:
428 case OFPUTIL_OFPAT11_SET_DL_SRC:
429 str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
432 case OFPUTIL_OFPAT10_SET_DL_DST:
433 case OFPUTIL_OFPAT11_SET_DL_DST:
434 str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
437 case OFPUTIL_OFPAT10_SET_NW_SRC:
438 case OFPUTIL_OFPAT11_SET_NW_SRC:
440 ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
443 case OFPUTIL_OFPAT10_SET_NW_DST:
444 case OFPUTIL_OFPAT11_SET_NW_DST:
446 ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
449 case OFPUTIL_OFPAT10_SET_NW_TOS:
450 case OFPUTIL_OFPAT11_SET_NW_TOS:
451 tos = str_to_u32(arg);
452 if (tos & ~IP_DSCP_MASK) {
453 ovs_fatal(0, "%s: not a valid TOS", arg);
455 ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
458 case OFPUTIL_OFPAT11_DEC_NW_TTL:
461 case OFPUTIL_OFPAT10_SET_TP_SRC:
462 case OFPUTIL_OFPAT11_SET_TP_SRC:
463 ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
466 case OFPUTIL_OFPAT10_SET_TP_DST:
467 case OFPUTIL_OFPAT11_SET_TP_DST:
468 ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
471 case OFPUTIL_OFPAT10_ENQUEUE:
472 parse_enqueue(arg, ofpacts);
475 case OFPUTIL_NXAST_RESUBMIT:
476 parse_resubmit(arg, ofpacts);
479 case OFPUTIL_NXAST_SET_TUNNEL:
480 case OFPUTIL_NXAST_SET_TUNNEL64:
481 tunnel = ofpact_put_SET_TUNNEL(ofpacts);
482 tunnel->ofpact.compat = code;
483 tunnel->tun_id = str_to_u64(arg);
486 case OFPUTIL_NXAST_WRITE_METADATA:
487 parse_metadata(ofpacts, arg);
490 case OFPUTIL_NXAST_SET_QUEUE:
491 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
494 case OFPUTIL_NXAST_POP_QUEUE:
495 ofpact_put_POP_QUEUE(ofpacts);
498 case OFPUTIL_NXAST_REG_MOVE:
499 nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
502 case OFPUTIL_NXAST_REG_LOAD:
503 nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
506 case OFPUTIL_NXAST_NOTE:
507 parse_note(arg, ofpacts);
510 case OFPUTIL_NXAST_MULTIPATH:
511 multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
514 case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
515 autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
518 case OFPUTIL_NXAST_BUNDLE:
519 bundle_parse(arg, ofpacts);
522 case OFPUTIL_NXAST_BUNDLE_LOAD:
523 bundle_parse_load(arg, ofpacts);
526 case OFPUTIL_NXAST_RESUBMIT_TABLE:
527 case OFPUTIL_NXAST_OUTPUT_REG:
528 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
531 case OFPUTIL_NXAST_LEARN:
532 learn_parse(arg, flow, ofpacts);
535 case OFPUTIL_NXAST_EXIT:
536 ofpact_put_EXIT(ofpacts);
539 case OFPUTIL_NXAST_DEC_TTL:
540 parse_dec_ttl(ofpacts, arg);
543 case OFPUTIL_NXAST_FIN_TIMEOUT:
544 parse_fin_timeout(ofpacts, arg);
547 case OFPUTIL_NXAST_CONTROLLER:
548 parse_controller(ofpacts, arg);
554 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
555 struct ofpbuf *ofpacts, int n_actions)
557 int code = ofputil_action_code_from_name(act);
559 parse_named_action(code, flow, arg, ofpacts);
560 } else if (!strcasecmp(act, "drop")) {
562 ovs_fatal(0, "Drop actions must not be preceded by other "
564 } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
565 ovs_fatal(0, "Drop actions must not be followed by other "
571 if (ofputil_port_from_string(act, &port)) {
572 ofpact_put_OUTPUT(ofpacts)->port = port;
574 ovs_fatal(0, "Unknown action: %s", act);
582 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
584 char *pos, *act, *arg;
590 while (ofputil_parse_key_value(&pos, &act, &arg)) {
591 if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
597 error = ofpacts_verify(ofpacts->data, ofpacts->size);
599 ovs_fatal(0, "Incorrect action ordering");
606 parse_named_instruction(enum ovs_instruction_type type,
607 char *arg, struct ofpbuf *ofpacts)
612 case OVSINST_OFPIT11_APPLY_ACTIONS:
613 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
616 case OVSINST_OFPIT11_WRITE_ACTIONS:
618 ovs_fatal(0, "instruction write-actions is not supported yet");
621 case OVSINST_OFPIT11_CLEAR_ACTIONS:
622 ofpact_put_CLEAR_ACTIONS(ofpacts);
625 case OVSINST_OFPIT11_WRITE_METADATA:
626 parse_metadata(ofpacts, arg);
629 case OVSINST_OFPIT11_GOTO_TABLE: {
630 struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
631 char *table_s = strsep(&arg, ",");
632 if (!table_s || !table_s[0]) {
633 ovs_fatal(0, "instruction goto-table needs table id");
635 ogt->table_id = str_to_table_id(table_s);
640 /* If write_metadata is specified as an action AND an instruction, ofpacts
642 error = ofpacts_verify(ofpacts->data, ofpacts->size);
644 ovs_fatal(0, "Incorrect instruction ordering");
649 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
651 char *pos, *inst, *arg;
653 const char *prev_inst = NULL;
658 while (ofputil_parse_key_value(&pos, &inst, &arg)) {
659 type = ofpact_instruction_type_from_name(inst);
661 if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
665 type = OVSINST_OFPIT11_APPLY_ACTIONS;
666 if (prev_type == type) {
670 } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
671 ovs_fatal(0, "%s isn't supported. Just write actions then "
672 "it is interpreted as apply_actions", inst);
674 parse_named_instruction(type, arg, ofpacts);
677 if (type == prev_type) {
678 ovs_fatal(0, "instruction can be specified at most once: %s",
681 if (type <= prev_type) {
682 ovs_fatal(0, "Instruction %s must be specified before %s",
700 parse_protocol(const char *name, const struct protocol **p_out)
702 static const struct protocol protocols[] = {
703 { "ip", ETH_TYPE_IP, 0 },
704 { "arp", ETH_TYPE_ARP, 0 },
705 { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
706 { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
707 { "udp", ETH_TYPE_IP, IPPROTO_UDP },
708 { "ipv6", ETH_TYPE_IPV6, 0 },
709 { "ip6", ETH_TYPE_IPV6, 0 },
710 { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
711 { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
712 { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
714 const struct protocol *p;
716 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
717 if (!strcmp(p->name, name)) {
727 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
732 fprintf(stderr, "%s:\n", flow);
735 va_start(args, format);
736 ovs_fatal_valist(0, format, args);
740 parse_field(const struct mf_field *mf, const char *s, struct match *match)
742 union mf_value value, mask;
745 error = mf_parse(mf, s, &value, &mask);
747 ovs_fatal(0, "%s", error);
750 mf_set(mf, &value, &mask, match);
753 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
754 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
755 * If 'actions' is specified, an action must be in 'string' and may be expanded
758 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
759 * constant for 'command'. To parse syntax for an OFPST_FLOW or
760 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
762 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
772 char *string = xstrdup(str_);
773 char *save_ptr = NULL;
774 char *act_str = NULL;
783 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
790 case OFPFC_DELETE_STRICT:
791 fields = F_OUT_PORT | F_PRIORITY;
795 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
798 case OFPFC_MODIFY_STRICT:
799 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
806 match_init_catchall(&fm->match);
807 fm->priority = OFP_DEFAULT_PRIORITY;
808 fm->cookie = htonll(0);
809 fm->cookie_mask = htonll(0);
810 if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
811 /* For modify, by default, don't update the cookie. */
812 fm->new_cookie = htonll(UINT64_MAX);
814 fm->new_cookie = htonll(0);
817 fm->command = command;
818 fm->idle_timeout = OFP_FLOW_PERMANENT;
819 fm->hard_timeout = OFP_FLOW_PERMANENT;
820 fm->buffer_id = UINT32_MAX;
821 fm->out_port = OFPP_NONE;
823 if (fields & F_ACTIONS) {
824 act_str = strstr(string, "action");
826 ofp_fatal(str_, verbose, "must specify an action");
830 act_str = strchr(act_str + 1, '=');
832 ofp_fatal(str_, verbose, "must specify an action");
837 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
838 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
839 const struct protocol *p;
841 if (parse_protocol(name, &p)) {
842 match_set_dl_type(&fm->match, htons(p->dl_type));
844 match_set_nw_proto(&fm->match, p->nw_proto);
846 } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
847 fm->flags |= OFPFF_SEND_FLOW_REM;
848 } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
849 fm->flags |= OFPFF_CHECK_OVERLAP;
853 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
855 ofp_fatal(str_, verbose, "field %s missing value", name);
858 if (!strcmp(name, "table")) {
859 fm->table_id = str_to_table_id(value);
860 } else if (!strcmp(name, "out_port")) {
861 if (!ofputil_port_from_string(name, &fm->out_port)) {
862 ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
865 } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
866 fm->priority = str_to_u16(value, name);
867 } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
868 fm->idle_timeout = str_to_u16(value, name);
869 } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
870 fm->hard_timeout = str_to_u16(value, name);
871 } else if (!strcmp(name, "cookie")) {
872 char *mask = strchr(value, '/');
875 /* A mask means we're searching for a cookie. */
876 if (command == OFPFC_ADD) {
877 ofp_fatal(str_, verbose, "flow additions cannot use "
881 fm->cookie = htonll(str_to_u64(value));
882 fm->cookie_mask = htonll(str_to_u64(mask+1));
884 /* No mask means that the cookie is being set. */
885 if (command != OFPFC_ADD && command != OFPFC_MODIFY
886 && command != OFPFC_MODIFY_STRICT) {
887 ofp_fatal(str_, verbose, "cannot set cookie");
889 fm->new_cookie = htonll(str_to_u64(value));
891 } else if (mf_from_name(name)) {
892 parse_field(mf_from_name(name), value, &fm->match);
893 } else if (!strcmp(name, "duration")
894 || !strcmp(name, "n_packets")
895 || !strcmp(name, "n_bytes")) {
896 /* Ignore these, so that users can feed the output of
897 * "ovs-ofctl dump-flows" back into commands that parse
900 ofp_fatal(str_, verbose, "unknown keyword %s", name);
904 if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
905 && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
906 /* On modifies without a mask, we are supposed to add a flow if
907 * one does not exist. If a cookie wasn't been specified, use a
908 * default of zero. */
909 fm->new_cookie = htonll(0);
911 if (fields & F_ACTIONS) {
912 struct ofpbuf ofpacts;
914 ofpbuf_init(&ofpacts, 32);
915 str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
916 fm->ofpacts_len = ofpacts.size;
917 fm->ofpacts = ofpbuf_steal_data(&ofpacts);
926 /* Convert 'str_' (as described in the documentation for the "monitor" command
927 * in the ovs-ofctl man page) into 'fmr'. */
929 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
934 char *string = xstrdup(str_);
935 char *save_ptr = NULL;
939 fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
940 | NXFMF_OWN | NXFMF_ACTIONS);
941 fmr->out_port = OFPP_NONE;
942 fmr->table_id = 0xff;
943 match_init_catchall(&fmr->match);
945 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
946 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
947 const struct protocol *p;
949 if (!strcmp(name, "!initial")) {
950 fmr->flags &= ~NXFMF_INITIAL;
951 } else if (!strcmp(name, "!add")) {
952 fmr->flags &= ~NXFMF_ADD;
953 } else if (!strcmp(name, "!delete")) {
954 fmr->flags &= ~NXFMF_DELETE;
955 } else if (!strcmp(name, "!modify")) {
956 fmr->flags &= ~NXFMF_MODIFY;
957 } else if (!strcmp(name, "!actions")) {
958 fmr->flags &= ~NXFMF_ACTIONS;
959 } else if (!strcmp(name, "!own")) {
960 fmr->flags &= ~NXFMF_OWN;
961 } else if (parse_protocol(name, &p)) {
962 match_set_dl_type(&fmr->match, htons(p->dl_type));
964 match_set_nw_proto(&fmr->match, p->nw_proto);
969 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
971 ovs_fatal(0, "%s: field %s missing value", str_, name);
974 if (!strcmp(name, "table")) {
975 fmr->table_id = str_to_table_id(value);
976 } else if (!strcmp(name, "out_port")) {
977 fmr->out_port = atoi(value);
978 } else if (mf_from_name(name)) {
979 parse_field(mf_from_name(name), value, &fmr->match);
981 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
988 /* Parses 's' as a set of OpenFlow actions and appends the actions to
991 * Prints an error on stderr and aborts the program if 's' syntax is
994 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
996 char *s = xstrdup(s_);
997 str_to_ofpacts(NULL, s, ofpacts);
1001 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1002 * (one of OFPFC_*) into 'fm'. */
1004 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1005 uint16_t command, bool verbose)
1007 struct match match_copy;
1009 parse_ofp_str(fm, command, string, verbose);
1011 /* Normalize a copy of the match. This ensures that non-normalized flows
1012 * get logged but doesn't affect what gets sent to the switch, so that the
1013 * switch can do whatever it likes with the flow. */
1014 match_copy = fm->match;
1015 ofputil_normalize_match(&match_copy);
1019 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1020 struct ofputil_flow_mod **fms, size_t *n_fms)
1022 size_t allocated_fms;
1026 stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1027 if (stream == NULL) {
1028 ovs_fatal(errno, "%s: open", file_name);
1031 allocated_fms = *n_fms;
1033 while (!ds_get_preprocessed_line(&s, stream)) {
1034 if (*n_fms >= allocated_fms) {
1035 *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1037 parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1042 if (stream != stdin) {
1048 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1049 bool aggregate, const char *string)
1051 struct ofputil_flow_mod fm;
1053 parse_ofp_str(&fm, -1, string, false);
1054 fsr->aggregate = aggregate;
1055 fsr->cookie = fm.cookie;
1056 fsr->cookie_mask = fm.cookie_mask;
1057 fsr->match = fm.match;
1058 fsr->out_port = fm.out_port;
1059 fsr->table_id = fm.table_id;
1062 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1063 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1064 * mf_field. Fields must be specified in a natural order for satisfying
1067 * Returns NULL on success, otherwise a malloc()'d string that explains the
1070 parse_ofp_exact_flow(struct flow *flow, const char *s)
1072 char *pos, *key, *value_s;
1076 memset(flow, 0, sizeof *flow);
1078 pos = copy = xstrdup(s);
1079 while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1080 const struct protocol *p;
1081 if (parse_protocol(key, &p)) {
1082 if (flow->dl_type) {
1083 error = xasprintf("%s: Ethernet type set multiple times", s);
1086 flow->dl_type = htons(p->dl_type);
1089 if (flow->nw_proto) {
1090 error = xasprintf("%s: network protocol set "
1091 "multiple times", s);
1094 flow->nw_proto = p->nw_proto;
1097 const struct mf_field *mf;
1098 union mf_value value;
1101 mf = mf_from_name(key);
1103 error = xasprintf("%s: unknown field %s", s, key);
1107 if (!mf_are_prereqs_ok(mf, flow)) {
1108 error = xasprintf("%s: prerequisites not met for setting %s",
1113 if (!mf_is_zero(mf, flow)) {
1114 error = xasprintf("%s: field %s set multiple times", s, key);
1118 field_error = mf_parse_value(mf, value_s, &value);
1120 error = xasprintf("%s: bad value for %s (%s)",
1121 s, key, field_error);
1126 mf_set_flow_value(mf, &value, flow);
1134 memset(flow, 0, sizeof *flow);