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 resubmit->in_port = ofputil_port_from_string(in_port_s);
172 if (!resubmit->in_port) {
173 ovs_fatal(0, "%s: resubmit to unknown port", in_port_s);
176 resubmit->in_port = OFPP_IN_PORT;
179 table_s = strsep(&arg, ",");
180 resubmit->table_id = table_s && table_s[0] ? str_to_u32(table_s) : 255;
182 if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
183 ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
189 parse_note(const char *arg, struct ofpbuf *ofpacts)
191 struct ofpact_note *note;
193 note = ofpact_put_NOTE(ofpacts);
194 while (*arg != '\0') {
205 byte = hexits_value(arg, 2, &ok);
207 ovs_fatal(0, "bad hex digit in `note' argument");
209 ofpbuf_put(ofpacts, &byte, 1);
216 ofpact_update_len(ofpacts, ¬e->ofpact);
220 parse_fin_timeout(struct ofpbuf *b, char *arg)
222 struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
225 while (ofputil_parse_key_value(&arg, &key, &value)) {
226 if (!strcmp(key, "idle_timeout")) {
227 oft->fin_idle_timeout = str_to_u16(value, key);
228 } else if (!strcmp(key, "hard_timeout")) {
229 oft->fin_hard_timeout = str_to_u16(value, key);
231 ovs_fatal(0, "invalid key '%s' in 'fin_timeout' argument", key);
237 parse_controller(struct ofpbuf *b, char *arg)
239 enum ofp_packet_in_reason reason = OFPR_ACTION;
240 uint16_t controller_id = 0;
241 uint16_t max_len = UINT16_MAX;
245 } else if (strspn(arg, "0123456789") == strlen(arg)) {
246 max_len = str_to_u16(arg, "max_len");
250 while (ofputil_parse_key_value(&arg, &name, &value)) {
251 if (!strcmp(name, "reason")) {
252 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
253 ovs_fatal(0, "unknown reason \"%s\"", value);
255 } else if (!strcmp(name, "max_len")) {
256 max_len = str_to_u16(value, "max_len");
257 } else if (!strcmp(name, "id")) {
258 controller_id = str_to_u16(value, "id");
260 ovs_fatal(0, "unknown key \"%s\" parsing controller action",
266 if (reason == OFPR_ACTION && controller_id == 0) {
267 struct ofpact_output *output;
269 output = ofpact_put_OUTPUT(b);
270 output->port = OFPP_CONTROLLER;
271 output->max_len = max_len;
273 struct ofpact_controller *controller;
275 controller = ofpact_put_CONTROLLER(b);
276 controller->max_len = max_len;
277 controller->reason = reason;
278 controller->controller_id = controller_id;
283 parse_noargs_dec_ttl(struct ofpbuf *b, enum ofputil_action_code compat)
285 struct ofpact_cnt_ids *ids;
288 ids = ofpact_put_DEC_TTL(b);
289 ids->ofpact.compat = compat;
290 ofpbuf_put(b, &id, sizeof id);
292 ids->n_controllers++;
293 ofpact_update_len(b, &ids->ofpact);
297 parse_dec_ttl(struct ofpbuf *b, char *arg, enum ofputil_action_code compat)
300 parse_noargs_dec_ttl(b, compat);
302 struct ofpact_cnt_ids *ids;
305 ids = ofpact_put_DEC_TTL(b);
306 ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
307 for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
308 cntr = strtok_r(NULL, ", ", &arg)) {
309 uint16_t id = atoi(cntr);
311 ofpbuf_put(b, &id, sizeof id);
313 ids->n_controllers++;
315 if (!ids->n_controllers) {
316 ovs_fatal(0, "dec_ttl_cnt_ids: expected at least one controller "
319 ofpact_update_len(b, &ids->ofpact);
324 set_field_parse(const char *arg, struct ofpbuf *ofpacts)
326 char *orig = xstrdup(arg);
327 struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
331 const struct mf_field *mf;
333 union mf_value mf_value;
336 delim = strstr(orig, "->");
338 ovs_fatal(0, "%s: missing `->'", orig);
340 if (strlen(delim) <= strlen("->")) {
341 ovs_fatal(0, "%s: missing field name following `->'", orig);
344 key = delim + strlen("->");
345 mf = mf_from_name(key);
347 ovs_fatal(0, "%s is not valid oxm field name", key);
350 ovs_fatal(0, "%s is not allowed to set", key);
354 error = mf_parse_value(mf, value, &mf_value);
356 ovs_fatal(0, "%s", error);
358 if (!mf_is_value_valid(mf, &mf_value)) {
359 ovs_fatal(0, "%s is not valid valid for field %s", value, key);
361 ofpact_set_field_init(load, mf, &mf_value);
366 parse_named_action(enum ofputil_action_code code, const struct flow *flow,
367 char *arg, struct ofpbuf *ofpacts)
369 struct ofpact_tunnel *tunnel;
376 case OFPUTIL_ACTION_INVALID:
379 case OFPUTIL_OFPAT10_OUTPUT:
380 case OFPUTIL_OFPAT11_OUTPUT:
381 parse_output(arg, ofpacts);
384 case OFPUTIL_OFPAT10_SET_VLAN_VID:
385 case OFPUTIL_OFPAT11_SET_VLAN_VID:
386 vid = str_to_u32(arg);
387 if (vid & ~VLAN_VID_MASK) {
388 ovs_fatal(0, "%s: not a valid VLAN VID", arg);
390 ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
393 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
394 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
395 pcp = str_to_u32(arg);
397 ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
399 ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
402 case OFPUTIL_OFPAT12_SET_FIELD:
403 set_field_parse(arg, ofpacts);
406 case OFPUTIL_OFPAT10_STRIP_VLAN:
407 ofpact_put_STRIP_VLAN(ofpacts);
410 case OFPUTIL_OFPAT10_SET_DL_SRC:
411 case OFPUTIL_OFPAT11_SET_DL_SRC:
412 str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
415 case OFPUTIL_OFPAT10_SET_DL_DST:
416 case OFPUTIL_OFPAT11_SET_DL_DST:
417 str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
420 case OFPUTIL_OFPAT10_SET_NW_SRC:
421 case OFPUTIL_OFPAT11_SET_NW_SRC:
423 ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
426 case OFPUTIL_OFPAT10_SET_NW_DST:
427 case OFPUTIL_OFPAT11_SET_NW_DST:
429 ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
432 case OFPUTIL_OFPAT10_SET_NW_TOS:
433 case OFPUTIL_OFPAT11_SET_NW_TOS:
434 tos = str_to_u32(arg);
435 if (tos & ~IP_DSCP_MASK) {
436 ovs_fatal(0, "%s: not a valid TOS", arg);
438 ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
441 case OFPUTIL_OFPAT11_DEC_NW_TTL:
442 parse_noargs_dec_ttl(ofpacts, code);
445 case OFPUTIL_OFPAT10_SET_TP_SRC:
446 case OFPUTIL_OFPAT11_SET_TP_SRC:
447 ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
450 case OFPUTIL_OFPAT10_SET_TP_DST:
451 case OFPUTIL_OFPAT11_SET_TP_DST:
452 ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
455 case OFPUTIL_OFPAT10_ENQUEUE:
456 parse_enqueue(arg, ofpacts);
459 case OFPUTIL_NXAST_RESUBMIT:
460 parse_resubmit(arg, ofpacts);
463 case OFPUTIL_NXAST_SET_TUNNEL:
464 case OFPUTIL_NXAST_SET_TUNNEL64:
465 tunnel = ofpact_put_SET_TUNNEL(ofpacts);
466 tunnel->ofpact.compat = code;
467 tunnel->tun_id = str_to_u64(arg);
470 case OFPUTIL_NXAST_SET_QUEUE:
471 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
474 case OFPUTIL_NXAST_POP_QUEUE:
475 ofpact_put_POP_QUEUE(ofpacts);
478 case OFPUTIL_NXAST_REG_MOVE:
479 nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
482 case OFPUTIL_NXAST_REG_LOAD:
483 nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
486 case OFPUTIL_NXAST_NOTE:
487 parse_note(arg, ofpacts);
490 case OFPUTIL_NXAST_MULTIPATH:
491 multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
494 case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
495 autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
498 case OFPUTIL_NXAST_BUNDLE:
499 bundle_parse(arg, ofpacts);
502 case OFPUTIL_NXAST_BUNDLE_LOAD:
503 bundle_parse_load(arg, ofpacts);
506 case OFPUTIL_NXAST_RESUBMIT_TABLE:
507 case OFPUTIL_NXAST_OUTPUT_REG:
508 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
511 case OFPUTIL_NXAST_LEARN:
512 learn_parse(arg, flow, ofpacts);
515 case OFPUTIL_NXAST_EXIT:
516 ofpact_put_EXIT(ofpacts);
519 case OFPUTIL_NXAST_DEC_TTL:
520 parse_dec_ttl(ofpacts, arg, code);
523 case OFPUTIL_NXAST_FIN_TIMEOUT:
524 parse_fin_timeout(ofpacts, arg);
527 case OFPUTIL_NXAST_CONTROLLER:
528 parse_controller(ofpacts, arg);
534 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
535 struct ofpbuf *ofpacts, int n_actions)
537 int code = ofputil_action_code_from_name(act);
539 parse_named_action(code, flow, arg, ofpacts);
540 } else if (!strcasecmp(act, "drop")) {
542 ovs_fatal(0, "Drop actions must not be preceded by other "
544 } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
545 ovs_fatal(0, "Drop actions must not be followed by other "
550 uint16_t port = ofputil_port_from_string(act);
552 ofpact_put_OUTPUT(ofpacts)->port = port;
554 ovs_fatal(0, "Unknown action: %s", act);
562 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
564 char *pos, *act, *arg;
569 while (ofputil_parse_key_value(&pos, &act, &arg)) {
570 if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
579 parse_named_instruction(enum ovs_instruction_type type,
580 char *arg, struct ofpbuf *ofpacts)
583 case OVSINST_OFPIT11_APPLY_ACTIONS:
584 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
587 case OVSINST_OFPIT11_WRITE_ACTIONS:
589 ovs_fatal(0, "instruction write-actions is not supported yet");
592 case OVSINST_OFPIT11_CLEAR_ACTIONS:
593 ofpact_put_CLEAR_ACTIONS(ofpacts);
596 case OVSINST_OFPIT11_WRITE_METADATA:
598 ovs_fatal(0, "instruction write-metadata is not supported yet");
601 case OVSINST_OFPIT11_GOTO_TABLE: {
602 struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
603 char *table_s = strsep(&arg, ",");
604 if (!table_s || !table_s[0]) {
605 ovs_fatal(0, "instruction goto-table needs table id");
607 ogt->table_id = str_to_table_id(table_s);
614 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
616 char *pos, *inst, *arg;
618 const char *prev_inst = NULL;
623 while (ofputil_parse_key_value(&pos, &inst, &arg)) {
624 type = ofpact_instruction_type_from_name(inst);
626 if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
630 type = OVSINST_OFPIT11_APPLY_ACTIONS;
631 if (prev_type == type) {
635 } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
636 ovs_fatal(0, "%s isn't supported. Just write actions then "
637 "it is interpreted as apply_actions", inst);
639 parse_named_instruction(type, arg, ofpacts);
642 if (type == prev_type) {
643 ovs_fatal(0, "instruction can be specified at most once: %s",
646 if (type <= prev_type) {
647 ovs_fatal(0, "Instruction %s must be specified before %s",
665 parse_protocol(const char *name, const struct protocol **p_out)
667 static const struct protocol protocols[] = {
668 { "ip", ETH_TYPE_IP, 0 },
669 { "arp", ETH_TYPE_ARP, 0 },
670 { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
671 { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
672 { "udp", ETH_TYPE_IP, IPPROTO_UDP },
673 { "ipv6", ETH_TYPE_IPV6, 0 },
674 { "ip6", ETH_TYPE_IPV6, 0 },
675 { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
676 { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
677 { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
679 const struct protocol *p;
681 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
682 if (!strcmp(p->name, name)) {
692 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
697 fprintf(stderr, "%s:\n", flow);
700 va_start(args, format);
701 ovs_fatal_valist(0, format, args);
705 parse_field(const struct mf_field *mf, const char *s, struct match *match)
707 union mf_value value, mask;
710 error = mf_parse(mf, s, &value, &mask);
712 ovs_fatal(0, "%s", error);
715 mf_set(mf, &value, &mask, match);
718 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
719 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
720 * If 'actions' is specified, an action must be in 'string' and may be expanded
723 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
724 * constant for 'command'. To parse syntax for an OFPST_FLOW or
725 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
727 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
737 char *string = xstrdup(str_);
738 char *save_ptr = NULL;
739 char *act_str = NULL;
748 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
755 case OFPFC_DELETE_STRICT:
756 fields = F_OUT_PORT | F_PRIORITY;
760 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
763 case OFPFC_MODIFY_STRICT:
764 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
771 match_init_catchall(&fm->match);
772 fm->priority = OFP_DEFAULT_PRIORITY;
773 fm->cookie = htonll(0);
774 fm->cookie_mask = htonll(0);
775 if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
776 /* For modify, by default, don't update the cookie. */
777 fm->new_cookie = htonll(UINT64_MAX);
779 fm->new_cookie = htonll(0);
782 fm->command = command;
783 fm->idle_timeout = OFP_FLOW_PERMANENT;
784 fm->hard_timeout = OFP_FLOW_PERMANENT;
785 fm->buffer_id = UINT32_MAX;
786 fm->out_port = OFPP_NONE;
788 if (fields & F_ACTIONS) {
789 act_str = strstr(string, "action");
791 ofp_fatal(str_, verbose, "must specify an action");
795 act_str = strchr(act_str + 1, '=');
797 ofp_fatal(str_, verbose, "must specify an action");
802 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
803 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
804 const struct protocol *p;
806 if (parse_protocol(name, &p)) {
807 match_set_dl_type(&fm->match, htons(p->dl_type));
809 match_set_nw_proto(&fm->match, p->nw_proto);
811 } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
812 fm->flags |= OFPFF_SEND_FLOW_REM;
813 } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
814 fm->flags |= OFPFF_CHECK_OVERLAP;
818 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
820 ofp_fatal(str_, verbose, "field %s missing value", name);
823 if (!strcmp(name, "table")) {
824 fm->table_id = str_to_table_id(value);
825 } else if (!strcmp(name, "out_port")) {
826 fm->out_port = ofputil_port_from_string(name);
828 ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
831 } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
832 fm->priority = str_to_u16(value, name);
833 } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
834 fm->idle_timeout = str_to_u16(value, name);
835 } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
836 fm->hard_timeout = str_to_u16(value, name);
837 } else if (!strcmp(name, "cookie")) {
838 char *mask = strchr(value, '/');
841 /* A mask means we're searching for a cookie. */
842 if (command == OFPFC_ADD) {
843 ofp_fatal(str_, verbose, "flow additions cannot use "
847 fm->cookie = htonll(str_to_u64(value));
848 fm->cookie_mask = htonll(str_to_u64(mask+1));
850 /* No mask means that the cookie is being set. */
851 if (command != OFPFC_ADD && command != OFPFC_MODIFY
852 && command != OFPFC_MODIFY_STRICT) {
853 ofp_fatal(str_, verbose, "cannot set cookie");
855 fm->new_cookie = htonll(str_to_u64(value));
857 } else if (mf_from_name(name)) {
858 parse_field(mf_from_name(name), value, &fm->match);
859 } else if (!strcmp(name, "duration")
860 || !strcmp(name, "n_packets")
861 || !strcmp(name, "n_bytes")) {
862 /* Ignore these, so that users can feed the output of
863 * "ovs-ofctl dump-flows" back into commands that parse
866 ofp_fatal(str_, verbose, "unknown keyword %s", name);
870 if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
871 && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
872 /* On modifies without a mask, we are supposed to add a flow if
873 * one does not exist. If a cookie wasn't been specified, use a
874 * default of zero. */
875 fm->new_cookie = htonll(0);
877 if (fields & F_ACTIONS) {
878 struct ofpbuf ofpacts;
880 ofpbuf_init(&ofpacts, 32);
881 str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
882 fm->ofpacts_len = ofpacts.size;
883 fm->ofpacts = ofpbuf_steal_data(&ofpacts);
892 /* Convert 'str_' (as described in the documentation for the "monitor" command
893 * in the ovs-ofctl man page) into 'fmr'. */
895 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
900 char *string = xstrdup(str_);
901 char *save_ptr = NULL;
905 fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
906 | NXFMF_OWN | NXFMF_ACTIONS);
907 fmr->out_port = OFPP_NONE;
908 fmr->table_id = 0xff;
909 match_init_catchall(&fmr->match);
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 (!strcmp(name, "!initial")) {
916 fmr->flags &= ~NXFMF_INITIAL;
917 } else if (!strcmp(name, "!add")) {
918 fmr->flags &= ~NXFMF_ADD;
919 } else if (!strcmp(name, "!delete")) {
920 fmr->flags &= ~NXFMF_DELETE;
921 } else if (!strcmp(name, "!modify")) {
922 fmr->flags &= ~NXFMF_MODIFY;
923 } else if (!strcmp(name, "!actions")) {
924 fmr->flags &= ~NXFMF_ACTIONS;
925 } else if (!strcmp(name, "!own")) {
926 fmr->flags &= ~NXFMF_OWN;
927 } else if (parse_protocol(name, &p)) {
928 match_set_dl_type(&fmr->match, htons(p->dl_type));
930 match_set_nw_proto(&fmr->match, p->nw_proto);
935 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
937 ovs_fatal(0, "%s: field %s missing value", str_, name);
940 if (!strcmp(name, "table")) {
941 fmr->table_id = str_to_table_id(value);
942 } else if (!strcmp(name, "out_port")) {
943 fmr->out_port = atoi(value);
944 } else if (mf_from_name(name)) {
945 parse_field(mf_from_name(name), value, &fmr->match);
947 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
954 /* Parses 's' as a set of OpenFlow actions and appends the actions to
957 * Prints an error on stderr and aborts the program if 's' syntax is
960 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
962 char *s = xstrdup(s_);
963 str_to_ofpacts(NULL, s, ofpacts);
967 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
968 * (one of OFPFC_*) into 'fm'. */
970 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
971 uint16_t command, bool verbose)
973 struct match match_copy;
975 parse_ofp_str(fm, command, string, verbose);
977 /* Normalize a copy of the match. This ensures that non-normalized flows
978 * get logged but doesn't affect what gets sent to the switch, so that the
979 * switch can do whatever it likes with the flow. */
980 match_copy = fm->match;
981 ofputil_normalize_match(&match_copy);
985 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
986 struct ofputil_flow_mod **fms, size_t *n_fms)
988 size_t allocated_fms;
992 stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
993 if (stream == NULL) {
994 ovs_fatal(errno, "%s: open", file_name);
997 allocated_fms = *n_fms;
999 while (!ds_get_preprocessed_line(&s, stream)) {
1000 if (*n_fms >= allocated_fms) {
1001 *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1003 parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1008 if (stream != stdin) {
1014 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1015 bool aggregate, const char *string)
1017 struct ofputil_flow_mod fm;
1019 parse_ofp_str(&fm, -1, string, false);
1020 fsr->aggregate = aggregate;
1021 fsr->cookie = fm.cookie;
1022 fsr->cookie_mask = fm.cookie_mask;
1023 fsr->match = fm.match;
1024 fsr->out_port = fm.out_port;
1025 fsr->table_id = fm.table_id;
1028 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1029 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1030 * mf_field. Fields must be specified in a natural order for satisfying
1033 * Returns NULL on success, otherwise a malloc()'d string that explains the
1036 parse_ofp_exact_flow(struct flow *flow, const char *s)
1038 char *pos, *key, *value_s;
1042 memset(flow, 0, sizeof *flow);
1044 pos = copy = xstrdup(s);
1045 while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1046 const struct protocol *p;
1047 if (parse_protocol(key, &p)) {
1048 if (flow->dl_type) {
1049 error = xasprintf("%s: Ethernet type set multiple times", s);
1052 flow->dl_type = htons(p->dl_type);
1055 if (flow->nw_proto) {
1056 error = xasprintf("%s: network protocol set "
1057 "multiple times", s);
1060 flow->nw_proto = p->nw_proto;
1063 const struct mf_field *mf;
1064 union mf_value value;
1067 mf = mf_from_name(key);
1069 error = xasprintf("%s: unknown field %s", s, key);
1073 if (!mf_are_prereqs_ok(mf, flow)) {
1074 error = xasprintf("%s: prerequisites not met for setting %s",
1079 if (!mf_is_zero(mf, flow)) {
1080 error = xasprintf("%s: field %s set multiple times", s, key);
1084 field_error = mf_parse_value(mf, value_s, &value);
1086 error = xasprintf("%s: bad value for %s (%s)",
1087 s, key, field_error);
1092 mf_set_flow_value(mf, &value, flow);
1100 memset(flow, 0, sizeof *flow);