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_named_action(enum ofputil_action_code code, const struct flow *flow,
365 char *arg, struct ofpbuf *ofpacts)
367 struct ofpact_tunnel *tunnel;
374 case OFPUTIL_ACTION_INVALID:
377 case OFPUTIL_OFPAT10_OUTPUT:
378 case OFPUTIL_OFPAT11_OUTPUT:
379 parse_output(arg, ofpacts);
382 case OFPUTIL_OFPAT10_SET_VLAN_VID:
383 case OFPUTIL_OFPAT11_SET_VLAN_VID:
384 vid = str_to_u32(arg);
385 if (vid & ~VLAN_VID_MASK) {
386 ovs_fatal(0, "%s: not a valid VLAN VID", arg);
388 ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
391 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
392 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
393 pcp = str_to_u32(arg);
395 ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
397 ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
400 case OFPUTIL_OFPAT12_SET_FIELD:
401 set_field_parse(arg, ofpacts);
404 case OFPUTIL_OFPAT10_STRIP_VLAN:
405 case OFPUTIL_OFPAT11_POP_VLAN:
406 ofpact_put_STRIP_VLAN(ofpacts);
409 case OFPUTIL_OFPAT10_SET_DL_SRC:
410 case OFPUTIL_OFPAT11_SET_DL_SRC:
411 str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
414 case OFPUTIL_OFPAT10_SET_DL_DST:
415 case OFPUTIL_OFPAT11_SET_DL_DST:
416 str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
419 case OFPUTIL_OFPAT10_SET_NW_SRC:
420 case OFPUTIL_OFPAT11_SET_NW_SRC:
422 ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
425 case OFPUTIL_OFPAT10_SET_NW_DST:
426 case OFPUTIL_OFPAT11_SET_NW_DST:
428 ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
431 case OFPUTIL_OFPAT10_SET_NW_TOS:
432 case OFPUTIL_OFPAT11_SET_NW_TOS:
433 tos = str_to_u32(arg);
434 if (tos & ~IP_DSCP_MASK) {
435 ovs_fatal(0, "%s: not a valid TOS", arg);
437 ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
440 case OFPUTIL_OFPAT11_DEC_NW_TTL:
443 case OFPUTIL_OFPAT10_SET_TP_SRC:
444 case OFPUTIL_OFPAT11_SET_TP_SRC:
445 ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
448 case OFPUTIL_OFPAT10_SET_TP_DST:
449 case OFPUTIL_OFPAT11_SET_TP_DST:
450 ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
453 case OFPUTIL_OFPAT10_ENQUEUE:
454 parse_enqueue(arg, ofpacts);
457 case OFPUTIL_NXAST_RESUBMIT:
458 parse_resubmit(arg, ofpacts);
461 case OFPUTIL_NXAST_SET_TUNNEL:
462 case OFPUTIL_NXAST_SET_TUNNEL64:
463 tunnel = ofpact_put_SET_TUNNEL(ofpacts);
464 tunnel->ofpact.compat = code;
465 tunnel->tun_id = str_to_u64(arg);
468 case OFPUTIL_NXAST_SET_QUEUE:
469 ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
472 case OFPUTIL_NXAST_POP_QUEUE:
473 ofpact_put_POP_QUEUE(ofpacts);
476 case OFPUTIL_NXAST_REG_MOVE:
477 nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
480 case OFPUTIL_NXAST_REG_LOAD:
481 nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
484 case OFPUTIL_NXAST_NOTE:
485 parse_note(arg, ofpacts);
488 case OFPUTIL_NXAST_MULTIPATH:
489 multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
492 case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
493 autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
496 case OFPUTIL_NXAST_BUNDLE:
497 bundle_parse(arg, ofpacts);
500 case OFPUTIL_NXAST_BUNDLE_LOAD:
501 bundle_parse_load(arg, ofpacts);
504 case OFPUTIL_NXAST_RESUBMIT_TABLE:
505 case OFPUTIL_NXAST_OUTPUT_REG:
506 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
509 case OFPUTIL_NXAST_LEARN:
510 learn_parse(arg, flow, ofpacts);
513 case OFPUTIL_NXAST_EXIT:
514 ofpact_put_EXIT(ofpacts);
517 case OFPUTIL_NXAST_DEC_TTL:
518 parse_dec_ttl(ofpacts, arg);
521 case OFPUTIL_NXAST_FIN_TIMEOUT:
522 parse_fin_timeout(ofpacts, arg);
525 case OFPUTIL_NXAST_CONTROLLER:
526 parse_controller(ofpacts, arg);
532 str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
533 struct ofpbuf *ofpacts, int n_actions)
535 int code = ofputil_action_code_from_name(act);
537 parse_named_action(code, flow, arg, ofpacts);
538 } else if (!strcasecmp(act, "drop")) {
540 ovs_fatal(0, "Drop actions must not be preceded by other "
542 } else if (ofputil_parse_key_value(&pos, &act, &arg)) {
543 ovs_fatal(0, "Drop actions must not be followed by other "
549 if (ofputil_port_from_string(act, &port)) {
550 ofpact_put_OUTPUT(ofpacts)->port = port;
552 ovs_fatal(0, "Unknown action: %s", act);
560 str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
562 char *pos, *act, *arg;
567 while (ofputil_parse_key_value(&pos, &act, &arg)) {
568 if (!str_to_ofpact__(flow, pos, act, arg, ofpacts, n_actions)) {
577 parse_named_instruction(enum ovs_instruction_type type,
578 char *arg, struct ofpbuf *ofpacts)
581 case OVSINST_OFPIT11_APPLY_ACTIONS:
582 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
585 case OVSINST_OFPIT11_WRITE_ACTIONS:
587 ovs_fatal(0, "instruction write-actions is not supported yet");
590 case OVSINST_OFPIT11_CLEAR_ACTIONS:
591 ofpact_put_CLEAR_ACTIONS(ofpacts);
594 case OVSINST_OFPIT11_WRITE_METADATA:
596 ovs_fatal(0, "instruction write-metadata is not supported yet");
599 case OVSINST_OFPIT11_GOTO_TABLE: {
600 struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
601 char *table_s = strsep(&arg, ",");
602 if (!table_s || !table_s[0]) {
603 ovs_fatal(0, "instruction goto-table needs table id");
605 ogt->table_id = str_to_table_id(table_s);
612 str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
614 char *pos, *inst, *arg;
616 const char *prev_inst = NULL;
621 while (ofputil_parse_key_value(&pos, &inst, &arg)) {
622 type = ofpact_instruction_type_from_name(inst);
624 if (!str_to_ofpact__(flow, pos, inst, arg, ofpacts, n_actions)) {
628 type = OVSINST_OFPIT11_APPLY_ACTIONS;
629 if (prev_type == type) {
633 } else if (type == OVSINST_OFPIT11_APPLY_ACTIONS) {
634 ovs_fatal(0, "%s isn't supported. Just write actions then "
635 "it is interpreted as apply_actions", inst);
637 parse_named_instruction(type, arg, ofpacts);
640 if (type == prev_type) {
641 ovs_fatal(0, "instruction can be specified at most once: %s",
644 if (type <= prev_type) {
645 ovs_fatal(0, "Instruction %s must be specified before %s",
663 parse_protocol(const char *name, const struct protocol **p_out)
665 static const struct protocol protocols[] = {
666 { "ip", ETH_TYPE_IP, 0 },
667 { "arp", ETH_TYPE_ARP, 0 },
668 { "icmp", ETH_TYPE_IP, IPPROTO_ICMP },
669 { "tcp", ETH_TYPE_IP, IPPROTO_TCP },
670 { "udp", ETH_TYPE_IP, IPPROTO_UDP },
671 { "ipv6", ETH_TYPE_IPV6, 0 },
672 { "ip6", ETH_TYPE_IPV6, 0 },
673 { "icmp6", ETH_TYPE_IPV6, IPPROTO_ICMPV6 },
674 { "tcp6", ETH_TYPE_IPV6, IPPROTO_TCP },
675 { "udp6", ETH_TYPE_IPV6, IPPROTO_UDP },
677 const struct protocol *p;
679 for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
680 if (!strcmp(p->name, name)) {
690 ofp_fatal(const char *flow, bool verbose, const char *format, ...)
695 fprintf(stderr, "%s:\n", flow);
698 va_start(args, format);
699 ovs_fatal_valist(0, format, args);
703 parse_field(const struct mf_field *mf, const char *s, struct match *match)
705 union mf_value value, mask;
708 error = mf_parse(mf, s, &value, &mask);
710 ovs_fatal(0, "%s", error);
713 mf_set(mf, &value, &mask, match);
716 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
717 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
718 * If 'actions' is specified, an action must be in 'string' and may be expanded
721 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
722 * constant for 'command'. To parse syntax for an OFPST_FLOW or
723 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
725 parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
735 char *string = xstrdup(str_);
736 char *save_ptr = NULL;
737 char *act_str = NULL;
746 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
753 case OFPFC_DELETE_STRICT:
754 fields = F_OUT_PORT | F_PRIORITY;
758 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
761 case OFPFC_MODIFY_STRICT:
762 fields = F_ACTIONS | F_TIMEOUT | F_PRIORITY | F_FLAGS;
769 match_init_catchall(&fm->match);
770 fm->priority = OFP_DEFAULT_PRIORITY;
771 fm->cookie = htonll(0);
772 fm->cookie_mask = htonll(0);
773 if (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT) {
774 /* For modify, by default, don't update the cookie. */
775 fm->new_cookie = htonll(UINT64_MAX);
777 fm->new_cookie = htonll(0);
780 fm->command = command;
781 fm->idle_timeout = OFP_FLOW_PERMANENT;
782 fm->hard_timeout = OFP_FLOW_PERMANENT;
783 fm->buffer_id = UINT32_MAX;
784 fm->out_port = OFPP_NONE;
786 if (fields & F_ACTIONS) {
787 act_str = strstr(string, "action");
789 ofp_fatal(str_, verbose, "must specify an action");
793 act_str = strchr(act_str + 1, '=');
795 ofp_fatal(str_, verbose, "must specify an action");
800 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
801 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
802 const struct protocol *p;
804 if (parse_protocol(name, &p)) {
805 match_set_dl_type(&fm->match, htons(p->dl_type));
807 match_set_nw_proto(&fm->match, p->nw_proto);
809 } else if (fields & F_FLAGS && !strcmp(name, "send_flow_rem")) {
810 fm->flags |= OFPFF_SEND_FLOW_REM;
811 } else if (fields & F_FLAGS && !strcmp(name, "check_overlap")) {
812 fm->flags |= OFPFF_CHECK_OVERLAP;
816 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
818 ofp_fatal(str_, verbose, "field %s missing value", name);
821 if (!strcmp(name, "table")) {
822 fm->table_id = str_to_table_id(value);
823 } else if (!strcmp(name, "out_port")) {
824 if (!ofputil_port_from_string(name, &fm->out_port)) {
825 ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
828 } else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
829 fm->priority = str_to_u16(value, name);
830 } else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
831 fm->idle_timeout = str_to_u16(value, name);
832 } else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
833 fm->hard_timeout = str_to_u16(value, name);
834 } else if (!strcmp(name, "cookie")) {
835 char *mask = strchr(value, '/');
838 /* A mask means we're searching for a cookie. */
839 if (command == OFPFC_ADD) {
840 ofp_fatal(str_, verbose, "flow additions cannot use "
844 fm->cookie = htonll(str_to_u64(value));
845 fm->cookie_mask = htonll(str_to_u64(mask+1));
847 /* No mask means that the cookie is being set. */
848 if (command != OFPFC_ADD && command != OFPFC_MODIFY
849 && command != OFPFC_MODIFY_STRICT) {
850 ofp_fatal(str_, verbose, "cannot set cookie");
852 fm->new_cookie = htonll(str_to_u64(value));
854 } else if (mf_from_name(name)) {
855 parse_field(mf_from_name(name), value, &fm->match);
856 } else if (!strcmp(name, "duration")
857 || !strcmp(name, "n_packets")
858 || !strcmp(name, "n_bytes")) {
859 /* Ignore these, so that users can feed the output of
860 * "ovs-ofctl dump-flows" back into commands that parse
863 ofp_fatal(str_, verbose, "unknown keyword %s", name);
867 if (!fm->cookie_mask && fm->new_cookie == htonll(UINT64_MAX)
868 && (command == OFPFC_MODIFY || command == OFPFC_MODIFY_STRICT)) {
869 /* On modifies without a mask, we are supposed to add a flow if
870 * one does not exist. If a cookie wasn't been specified, use a
871 * default of zero. */
872 fm->new_cookie = htonll(0);
874 if (fields & F_ACTIONS) {
875 struct ofpbuf ofpacts;
877 ofpbuf_init(&ofpacts, 32);
878 str_to_inst_ofpacts(&fm->match.flow, act_str, &ofpacts);
879 fm->ofpacts_len = ofpacts.size;
880 fm->ofpacts = ofpbuf_steal_data(&ofpacts);
889 /* Convert 'str_' (as described in the documentation for the "monitor" command
890 * in the ovs-ofctl man page) into 'fmr'. */
892 parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
897 char *string = xstrdup(str_);
898 char *save_ptr = NULL;
902 fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
903 | NXFMF_OWN | NXFMF_ACTIONS);
904 fmr->out_port = OFPP_NONE;
905 fmr->table_id = 0xff;
906 match_init_catchall(&fmr->match);
908 for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
909 name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
910 const struct protocol *p;
912 if (!strcmp(name, "!initial")) {
913 fmr->flags &= ~NXFMF_INITIAL;
914 } else if (!strcmp(name, "!add")) {
915 fmr->flags &= ~NXFMF_ADD;
916 } else if (!strcmp(name, "!delete")) {
917 fmr->flags &= ~NXFMF_DELETE;
918 } else if (!strcmp(name, "!modify")) {
919 fmr->flags &= ~NXFMF_MODIFY;
920 } else if (!strcmp(name, "!actions")) {
921 fmr->flags &= ~NXFMF_ACTIONS;
922 } else if (!strcmp(name, "!own")) {
923 fmr->flags &= ~NXFMF_OWN;
924 } else if (parse_protocol(name, &p)) {
925 match_set_dl_type(&fmr->match, htons(p->dl_type));
927 match_set_nw_proto(&fmr->match, p->nw_proto);
932 value = strtok_r(NULL, ", \t\r\n", &save_ptr);
934 ovs_fatal(0, "%s: field %s missing value", str_, name);
937 if (!strcmp(name, "table")) {
938 fmr->table_id = str_to_table_id(value);
939 } else if (!strcmp(name, "out_port")) {
940 fmr->out_port = atoi(value);
941 } else if (mf_from_name(name)) {
942 parse_field(mf_from_name(name), value, &fmr->match);
944 ovs_fatal(0, "%s: unknown keyword %s", str_, name);
951 /* Parses 's' as a set of OpenFlow actions and appends the actions to
954 * Prints an error on stderr and aborts the program if 's' syntax is
957 parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
959 char *s = xstrdup(s_);
960 str_to_ofpacts(NULL, s, ofpacts);
964 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
965 * (one of OFPFC_*) into 'fm'. */
967 parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
968 uint16_t command, bool verbose)
970 struct match match_copy;
972 parse_ofp_str(fm, command, string, verbose);
974 /* Normalize a copy of the match. This ensures that non-normalized flows
975 * get logged but doesn't affect what gets sent to the switch, so that the
976 * switch can do whatever it likes with the flow. */
977 match_copy = fm->match;
978 ofputil_normalize_match(&match_copy);
982 parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
983 struct ofputil_flow_mod **fms, size_t *n_fms)
985 size_t allocated_fms;
989 stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
990 if (stream == NULL) {
991 ovs_fatal(errno, "%s: open", file_name);
994 allocated_fms = *n_fms;
996 while (!ds_get_preprocessed_line(&s, stream)) {
997 if (*n_fms >= allocated_fms) {
998 *fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1000 parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1005 if (stream != stdin) {
1011 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1012 bool aggregate, const char *string)
1014 struct ofputil_flow_mod fm;
1016 parse_ofp_str(&fm, -1, string, false);
1017 fsr->aggregate = aggregate;
1018 fsr->cookie = fm.cookie;
1019 fsr->cookie_mask = fm.cookie_mask;
1020 fsr->match = fm.match;
1021 fsr->out_port = fm.out_port;
1022 fsr->table_id = fm.table_id;
1025 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1026 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1027 * mf_field. Fields must be specified in a natural order for satisfying
1030 * Returns NULL on success, otherwise a malloc()'d string that explains the
1033 parse_ofp_exact_flow(struct flow *flow, const char *s)
1035 char *pos, *key, *value_s;
1039 memset(flow, 0, sizeof *flow);
1041 pos = copy = xstrdup(s);
1042 while (ofputil_parse_key_value(&pos, &key, &value_s)) {
1043 const struct protocol *p;
1044 if (parse_protocol(key, &p)) {
1045 if (flow->dl_type) {
1046 error = xasprintf("%s: Ethernet type set multiple times", s);
1049 flow->dl_type = htons(p->dl_type);
1052 if (flow->nw_proto) {
1053 error = xasprintf("%s: network protocol set "
1054 "multiple times", s);
1057 flow->nw_proto = p->nw_proto;
1060 const struct mf_field *mf;
1061 union mf_value value;
1064 mf = mf_from_name(key);
1066 error = xasprintf("%s: unknown field %s", s, key);
1070 if (!mf_are_prereqs_ok(mf, flow)) {
1071 error = xasprintf("%s: prerequisites not met for setting %s",
1076 if (!mf_is_zero(mf, flow)) {
1077 error = xasprintf("%s: field %s set multiple times", s, key);
1081 field_error = mf_parse_value(mf, value_s, &value);
1083 error = xasprintf("%s: bad value for %s (%s)",
1084 s, key, field_error);
1089 mf_set_flow_value(mf, &value, flow);
1097 memset(flow, 0, sizeof *flow);