2 * Copyright (c) 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "ofp-parse.h"
26 #include "byte-order.h"
27 #include "dynamic-string.h"
29 #include "meta-flow.h"
30 #include "multipath.h"
33 #include "ofp-actions.h"
36 #include "openflow/openflow.h"
38 #include "socket-util.h"
42 VLOG_DEFINE_THIS_MODULE(ofp_parse
);
44 static void ofp_fatal(const char *flow
, bool verbose
, const char *format
, ...)
48 str_to_u8(const char *str
, const char *name
)
52 if (!str_to_int(str
, 10, &value
) || value
< 0 || value
> 255) {
53 ovs_fatal(0, "invalid %s \"%s\"", name
, str
);
59 str_to_u16(const char *str
, const char *name
)
63 if (!str_to_int(str
, 0, &value
) || value
< 0 || value
> 65535) {
64 ovs_fatal(0, "invalid %s \"%s\"", name
, str
);
70 str_to_u32(const char *str
)
76 ovs_fatal(0, "missing required numeric argument");
80 value
= strtoul(str
, &tail
, 0);
81 if (errno
== EINVAL
|| errno
== ERANGE
|| *tail
) {
82 ovs_fatal(0, "invalid numeric format %s", str
);
88 str_to_u64(const char *str
)
94 ovs_fatal(0, "missing required numeric argument");
98 value
= strtoull(str
, &tail
, 0);
99 if (errno
== EINVAL
|| errno
== ERANGE
|| *tail
) {
100 ovs_fatal(0, "invalid numeric format %s", str
);
106 str_to_mac(const char *str
, uint8_t mac
[6])
108 if (sscanf(str
, ETH_ADDR_SCAN_FMT
, ETH_ADDR_SCAN_ARGS(mac
))
109 != ETH_ADDR_SCAN_COUNT
) {
110 ovs_fatal(0, "invalid mac address %s", str
);
115 str_to_ip(const char *str
, ovs_be32
*ip
)
117 struct in_addr in_addr
;
119 if (lookup_ip(str
, &in_addr
)) {
120 ovs_fatal(0, "%s: could not convert to IP address", str
);
122 *ip
= in_addr
.s_addr
;
126 parse_enqueue(char *arg
, struct ofpbuf
*ofpacts
)
129 char *port
= strtok_r(arg
, ":q", &sp
);
130 char *queue
= strtok_r(NULL
, "", &sp
);
131 struct ofpact_enqueue
*enqueue
;
133 if (port
== NULL
|| queue
== NULL
) {
134 ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
137 enqueue
= ofpact_put_ENQUEUE(ofpacts
);
138 enqueue
->port
= u16_to_ofp(str_to_u32(port
));
139 enqueue
->queue
= str_to_u32(queue
);
143 parse_output(char *arg
, struct ofpbuf
*ofpacts
)
145 if (strchr(arg
, '[')) {
146 struct ofpact_output_reg
*output_reg
;
148 output_reg
= ofpact_put_OUTPUT_REG(ofpacts
);
149 mf_parse_subfield(&output_reg
->src
, arg
);
150 output_reg
->max_len
= UINT16_MAX
;
152 struct ofpact_output
*output
;
154 output
= ofpact_put_OUTPUT(ofpacts
);
155 output
->port
= u16_to_ofp(str_to_u32(arg
));
156 output
->max_len
= output
->port
== OFPP_CONTROLLER
? UINT16_MAX
: 0;
161 parse_resubmit(char *arg
, struct ofpbuf
*ofpacts
)
163 struct ofpact_resubmit
*resubmit
;
164 char *in_port_s
, *table_s
;
166 resubmit
= ofpact_put_RESUBMIT(ofpacts
);
168 in_port_s
= strsep(&arg
, ",");
169 if (in_port_s
&& in_port_s
[0]) {
170 if (!ofputil_port_from_string(in_port_s
, &resubmit
->in_port
)) {
171 ovs_fatal(0, "%s: resubmit to unknown port", in_port_s
);
174 resubmit
->in_port
= OFPP_IN_PORT
;
177 table_s
= strsep(&arg
, ",");
178 resubmit
->table_id
= table_s
&& table_s
[0] ? str_to_u32(table_s
) : 255;
180 if (resubmit
->in_port
== OFPP_IN_PORT
&& resubmit
->table_id
== 255) {
181 ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
187 parse_note(const char *arg
, struct ofpbuf
*ofpacts
)
189 struct ofpact_note
*note
;
191 note
= ofpact_put_NOTE(ofpacts
);
192 while (*arg
!= '\0') {
203 byte
= hexits_value(arg
, 2, &ok
);
205 ovs_fatal(0, "bad hex digit in `note' argument");
207 ofpbuf_put(ofpacts
, &byte
, 1);
214 ofpact_update_len(ofpacts
, ¬e
->ofpact
);
218 parse_fin_timeout(struct ofpbuf
*b
, char *arg
)
220 struct ofpact_fin_timeout
*oft
= ofpact_put_FIN_TIMEOUT(b
);
223 while (ofputil_parse_key_value(&arg
, &key
, &value
)) {
224 if (!strcmp(key
, "idle_timeout")) {
225 oft
->fin_idle_timeout
= str_to_u16(value
, key
);
226 } else if (!strcmp(key
, "hard_timeout")) {
227 oft
->fin_hard_timeout
= str_to_u16(value
, key
);
229 ovs_fatal(0, "invalid key '%s' in 'fin_timeout' argument", key
);
235 parse_controller(struct ofpbuf
*b
, char *arg
)
237 enum ofp_packet_in_reason reason
= OFPR_ACTION
;
238 uint16_t controller_id
= 0;
239 uint16_t max_len
= UINT16_MAX
;
243 } else if (strspn(arg
, "0123456789") == strlen(arg
)) {
244 max_len
= str_to_u16(arg
, "max_len");
248 while (ofputil_parse_key_value(&arg
, &name
, &value
)) {
249 if (!strcmp(name
, "reason")) {
250 if (!ofputil_packet_in_reason_from_string(value
, &reason
)) {
251 ovs_fatal(0, "unknown reason \"%s\"", value
);
253 } else if (!strcmp(name
, "max_len")) {
254 max_len
= str_to_u16(value
, "max_len");
255 } else if (!strcmp(name
, "id")) {
256 controller_id
= str_to_u16(value
, "id");
258 ovs_fatal(0, "unknown key \"%s\" parsing controller action",
264 if (reason
== OFPR_ACTION
&& controller_id
== 0) {
265 struct ofpact_output
*output
;
267 output
= ofpact_put_OUTPUT(b
);
268 output
->port
= OFPP_CONTROLLER
;
269 output
->max_len
= max_len
;
271 struct ofpact_controller
*controller
;
273 controller
= ofpact_put_CONTROLLER(b
);
274 controller
->max_len
= max_len
;
275 controller
->reason
= reason
;
276 controller
->controller_id
= controller_id
;
281 parse_noargs_dec_ttl(struct ofpbuf
*b
)
283 struct ofpact_cnt_ids
*ids
;
286 ids
= ofpact_put_DEC_TTL(b
);
287 ofpbuf_put(b
, &id
, sizeof id
);
289 ids
->n_controllers
++;
290 ofpact_update_len(b
, &ids
->ofpact
);
294 parse_dec_ttl(struct ofpbuf
*b
, char *arg
)
297 parse_noargs_dec_ttl(b
);
299 struct ofpact_cnt_ids
*ids
;
302 ids
= ofpact_put_DEC_TTL(b
);
303 ids
->ofpact
.compat
= OFPUTIL_NXAST_DEC_TTL_CNT_IDS
;
304 for (cntr
= strtok_r(arg
, ", ", &arg
); cntr
!= NULL
;
305 cntr
= strtok_r(NULL
, ", ", &arg
)) {
306 uint16_t id
= atoi(cntr
);
308 ofpbuf_put(b
, &id
, sizeof id
);
310 ids
->n_controllers
++;
312 if (!ids
->n_controllers
) {
313 ovs_fatal(0, "dec_ttl_cnt_ids: expected at least one controller "
316 ofpact_update_len(b
, &ids
->ofpact
);
321 parse_set_mpls_ttl(struct ofpbuf
*b
, const char *arg
)
323 struct ofpact_mpls_ttl
*mpls_ttl
= ofpact_put_SET_MPLS_TTL(b
);
326 ovs_fatal(0, "parse_set_mpls_ttl: expected ttl.");
329 mpls_ttl
->ttl
= atoi(arg
);
333 set_field_parse(const char *arg
, struct ofpbuf
*ofpacts
)
335 char *orig
= xstrdup(arg
);
336 struct ofpact_reg_load
*load
= ofpact_put_REG_LOAD(ofpacts
);
340 const struct mf_field
*mf
;
342 union mf_value mf_value
;
345 delim
= strstr(orig
, "->");
347 ovs_fatal(0, "%s: missing `->'", orig
);
349 if (strlen(delim
) <= strlen("->")) {
350 ovs_fatal(0, "%s: missing field name following `->'", orig
);
353 key
= delim
+ strlen("->");
354 mf
= mf_from_name(key
);
356 ovs_fatal(0, "%s is not valid oxm field name", key
);
359 ovs_fatal(0, "%s is not allowed to set", key
);
363 error
= mf_parse_value(mf
, value
, &mf_value
);
365 ovs_fatal(0, "%s", error
);
367 if (!mf_is_value_valid(mf
, &mf_value
)) {
368 ovs_fatal(0, "%s is not valid valid for field %s", value
, key
);
370 ofpact_set_field_init(load
, mf
, &mf_value
);
375 parse_metadata(struct ofpbuf
*b
, char *arg
)
377 struct ofpact_metadata
*om
;
378 char *mask
= strchr(arg
, '/');
380 om
= ofpact_put_WRITE_METADATA(b
);
384 om
->mask
= htonll(str_to_u64(mask
+ 1));
386 om
->mask
= htonll(UINT64_MAX
);
389 om
->metadata
= htonll(str_to_u64(arg
));
393 parse_sample(struct ofpbuf
*b
, char *arg
)
395 struct ofpact_sample
*os
= ofpact_put_SAMPLE(b
);
398 while (ofputil_parse_key_value(&arg
, &key
, &value
)) {
399 if (!strcmp(key
, "probability")) {
400 os
->probability
= str_to_u16(value
, "probability");
401 if (os
->probability
== 0) {
402 ovs_fatal(0, "invalid probability value \"%s\"", value
);
404 } else if (!strcmp(key
, "collector_set_id")) {
405 os
->collector_set_id
= str_to_u32(value
);
406 } else if (!strcmp(key
, "obs_domain_id")) {
407 os
->obs_domain_id
= str_to_u32(value
);
408 } else if (!strcmp(key
, "obs_point_id")) {
409 os
->obs_point_id
= str_to_u32(value
);
411 ovs_fatal(0, "invalid key \"%s\" in \"sample\" argument",
415 if (os
->probability
== 0) {
416 ovs_fatal(0, "non-zero \"probability\" must be specified on sample");
421 parse_named_action(enum ofputil_action_code code
,
422 char *arg
, struct ofpbuf
*ofpacts
)
424 struct ofpact_tunnel
*tunnel
;
432 case OFPUTIL_ACTION_INVALID
:
435 case OFPUTIL_OFPAT10_OUTPUT
:
436 case OFPUTIL_OFPAT11_OUTPUT
:
437 parse_output(arg
, ofpacts
);
440 case OFPUTIL_OFPAT10_SET_VLAN_VID
:
441 case OFPUTIL_OFPAT11_SET_VLAN_VID
:
442 vid
= str_to_u32(arg
);
443 if (vid
& ~VLAN_VID_MASK
) {
444 ovs_fatal(0, "%s: not a valid VLAN VID", arg
);
446 ofpact_put_SET_VLAN_VID(ofpacts
)->vlan_vid
= vid
;
449 case OFPUTIL_OFPAT10_SET_VLAN_PCP
:
450 case OFPUTIL_OFPAT11_SET_VLAN_PCP
:
451 pcp
= str_to_u32(arg
);
453 ovs_fatal(0, "%s: not a valid VLAN PCP", arg
);
455 ofpact_put_SET_VLAN_PCP(ofpacts
)->vlan_pcp
= pcp
;
458 case OFPUTIL_OFPAT12_SET_FIELD
:
459 set_field_parse(arg
, ofpacts
);
462 case OFPUTIL_OFPAT10_STRIP_VLAN
:
463 case OFPUTIL_OFPAT11_POP_VLAN
:
464 ofpact_put_STRIP_VLAN(ofpacts
);
467 case OFPUTIL_OFPAT11_PUSH_VLAN
:
468 ethertype
= str_to_u16(arg
, "ethertype");
469 if (ethertype
!= ETH_TYPE_VLAN_8021Q
) {
470 /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
471 ovs_fatal(0, "%s: not a valid VLAN ethertype", arg
);
473 ofpact_put_PUSH_VLAN(ofpacts
);
476 case OFPUTIL_OFPAT11_SET_QUEUE
:
477 ofpact_put_SET_QUEUE(ofpacts
)->queue_id
= str_to_u32(arg
);
481 case OFPUTIL_OFPAT10_SET_DL_SRC
:
482 case OFPUTIL_OFPAT11_SET_DL_SRC
:
483 str_to_mac(arg
, ofpact_put_SET_ETH_SRC(ofpacts
)->mac
);
486 case OFPUTIL_OFPAT10_SET_DL_DST
:
487 case OFPUTIL_OFPAT11_SET_DL_DST
:
488 str_to_mac(arg
, ofpact_put_SET_ETH_DST(ofpacts
)->mac
);
491 case OFPUTIL_OFPAT10_SET_NW_SRC
:
492 case OFPUTIL_OFPAT11_SET_NW_SRC
:
494 ofpact_put_SET_IPV4_SRC(ofpacts
)->ipv4
= ip
;
497 case OFPUTIL_OFPAT10_SET_NW_DST
:
498 case OFPUTIL_OFPAT11_SET_NW_DST
:
500 ofpact_put_SET_IPV4_DST(ofpacts
)->ipv4
= ip
;
503 case OFPUTIL_OFPAT10_SET_NW_TOS
:
504 case OFPUTIL_OFPAT11_SET_NW_TOS
:
505 tos
= str_to_u32(arg
);
506 if (tos
& ~IP_DSCP_MASK
) {
507 ovs_fatal(0, "%s: not a valid TOS", arg
);
509 ofpact_put_SET_IPV4_DSCP(ofpacts
)->dscp
= tos
;
512 case OFPUTIL_OFPAT11_DEC_NW_TTL
:
515 case OFPUTIL_OFPAT10_SET_TP_SRC
:
516 case OFPUTIL_OFPAT11_SET_TP_SRC
:
517 ofpact_put_SET_L4_SRC_PORT(ofpacts
)->port
= str_to_u32(arg
);
520 case OFPUTIL_OFPAT10_SET_TP_DST
:
521 case OFPUTIL_OFPAT11_SET_TP_DST
:
522 ofpact_put_SET_L4_DST_PORT(ofpacts
)->port
= str_to_u32(arg
);
525 case OFPUTIL_OFPAT10_ENQUEUE
:
526 parse_enqueue(arg
, ofpacts
);
529 case OFPUTIL_NXAST_RESUBMIT
:
530 parse_resubmit(arg
, ofpacts
);
533 case OFPUTIL_NXAST_SET_TUNNEL
:
534 case OFPUTIL_NXAST_SET_TUNNEL64
:
535 tunnel
= ofpact_put_SET_TUNNEL(ofpacts
);
536 tunnel
->ofpact
.compat
= code
;
537 tunnel
->tun_id
= str_to_u64(arg
);
540 case OFPUTIL_NXAST_WRITE_METADATA
:
541 parse_metadata(ofpacts
, arg
);
544 case OFPUTIL_NXAST_SET_QUEUE
:
545 ofpact_put_SET_QUEUE(ofpacts
)->queue_id
= str_to_u32(arg
);
548 case OFPUTIL_NXAST_POP_QUEUE
:
549 ofpact_put_POP_QUEUE(ofpacts
);
552 case OFPUTIL_NXAST_REG_MOVE
:
553 nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts
), arg
);
556 case OFPUTIL_NXAST_REG_LOAD
:
557 nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts
), arg
);
560 case OFPUTIL_NXAST_NOTE
:
561 parse_note(arg
, ofpacts
);
564 case OFPUTIL_NXAST_MULTIPATH
:
565 multipath_parse(ofpact_put_MULTIPATH(ofpacts
), arg
);
568 case OFPUTIL_NXAST_BUNDLE
:
569 bundle_parse(arg
, ofpacts
);
572 case OFPUTIL_NXAST_BUNDLE_LOAD
:
573 bundle_parse_load(arg
, ofpacts
);
576 case OFPUTIL_NXAST_RESUBMIT_TABLE
:
577 case OFPUTIL_NXAST_OUTPUT_REG
:
578 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS
:
581 case OFPUTIL_NXAST_LEARN
:
582 learn_parse(arg
, ofpacts
);
585 case OFPUTIL_NXAST_EXIT
:
586 ofpact_put_EXIT(ofpacts
);
589 case OFPUTIL_NXAST_DEC_TTL
:
590 parse_dec_ttl(ofpacts
, arg
);
593 case OFPUTIL_NXAST_SET_MPLS_TTL
:
594 case OFPUTIL_OFPAT11_SET_MPLS_TTL
:
595 parse_set_mpls_ttl(ofpacts
, arg
);
598 case OFPUTIL_OFPAT11_DEC_MPLS_TTL
:
599 case OFPUTIL_NXAST_DEC_MPLS_TTL
:
600 ofpact_put_DEC_MPLS_TTL(ofpacts
);
603 case OFPUTIL_NXAST_FIN_TIMEOUT
:
604 parse_fin_timeout(ofpacts
, arg
);
607 case OFPUTIL_NXAST_CONTROLLER
:
608 parse_controller(ofpacts
, arg
);
611 case OFPUTIL_OFPAT11_PUSH_MPLS
:
612 case OFPUTIL_NXAST_PUSH_MPLS
:
613 ofpact_put_PUSH_MPLS(ofpacts
)->ethertype
=
614 htons(str_to_u16(arg
, "push_mpls"));
617 case OFPUTIL_OFPAT11_POP_MPLS
:
618 case OFPUTIL_NXAST_POP_MPLS
:
619 ofpact_put_POP_MPLS(ofpacts
)->ethertype
=
620 htons(str_to_u16(arg
, "pop_mpls"));
623 case OFPUTIL_NXAST_STACK_PUSH
:
624 nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts
), arg
);
626 case OFPUTIL_NXAST_STACK_POP
:
627 nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts
), arg
);
630 case OFPUTIL_NXAST_SAMPLE
:
631 parse_sample(ofpacts
, arg
);
637 str_to_ofpact__(char *pos
, char *act
, char *arg
,
638 struct ofpbuf
*ofpacts
, int n_actions
)
640 int code
= ofputil_action_code_from_name(act
);
642 parse_named_action(code
, arg
, ofpacts
);
643 } else if (!strcasecmp(act
, "drop")) {
645 ovs_fatal(0, "Drop actions must not be preceded by other "
647 } else if (ofputil_parse_key_value(&pos
, &act
, &arg
)) {
648 ovs_fatal(0, "Drop actions must not be followed by other "
654 if (ofputil_port_from_string(act
, &port
)) {
655 ofpact_put_OUTPUT(ofpacts
)->port
= port
;
657 ovs_fatal(0, "Unknown action: %s", act
);
665 str_to_ofpacts(char *str
, struct ofpbuf
*ofpacts
)
667 char *pos
, *act
, *arg
;
673 while (ofputil_parse_key_value(&pos
, &act
, &arg
)) {
674 if (!str_to_ofpact__(pos
, act
, arg
, ofpacts
, n_actions
)) {
680 error
= ofpacts_verify(ofpacts
->data
, ofpacts
->size
);
682 ovs_fatal(0, "Incorrect action ordering");
689 parse_named_instruction(enum ovs_instruction_type type
,
690 char *arg
, struct ofpbuf
*ofpacts
)
695 case OVSINST_OFPIT11_APPLY_ACTIONS
:
696 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
699 case OVSINST_OFPIT11_WRITE_ACTIONS
:
701 ovs_fatal(0, "instruction write-actions is not supported yet");
704 case OVSINST_OFPIT11_CLEAR_ACTIONS
:
705 ofpact_put_CLEAR_ACTIONS(ofpacts
);
708 case OVSINST_OFPIT13_METER
:
709 ofpact_put_METER(ofpacts
)->meter_id
= str_to_u32(arg
);
712 case OVSINST_OFPIT11_WRITE_METADATA
:
713 parse_metadata(ofpacts
, arg
);
716 case OVSINST_OFPIT11_GOTO_TABLE
: {
717 struct ofpact_goto_table
*ogt
= ofpact_put_GOTO_TABLE(ofpacts
);
718 char *table_s
= strsep(&arg
, ",");
719 if (!table_s
|| !table_s
[0]) {
720 ovs_fatal(0, "instruction goto-table needs table id");
722 ogt
->table_id
= str_to_u8(table_s
, "table");
727 /* If write_metadata is specified as an action AND an instruction, ofpacts
729 error
= ofpacts_verify(ofpacts
->data
, ofpacts
->size
);
731 ovs_fatal(0, "Incorrect instruction ordering");
736 str_to_inst_ofpacts(char *str
, struct ofpbuf
*ofpacts
)
738 char *pos
, *inst
, *arg
;
740 const char *prev_inst
= NULL
;
745 while (ofputil_parse_key_value(&pos
, &inst
, &arg
)) {
746 type
= ovs_instruction_type_from_name(inst
);
748 if (!str_to_ofpact__(pos
, inst
, arg
, ofpacts
, n_actions
)) {
752 type
= OVSINST_OFPIT11_APPLY_ACTIONS
;
753 if (prev_type
== type
) {
757 } else if (type
== OVSINST_OFPIT11_APPLY_ACTIONS
) {
758 ovs_fatal(0, "%s isn't supported. Just write actions then "
759 "it is interpreted as apply_actions", inst
);
761 parse_named_instruction(type
, arg
, ofpacts
);
764 if (type
== prev_type
) {
765 ovs_fatal(0, "instruction can be specified at most once: %s",
768 if (type
<= prev_type
) {
769 ovs_fatal(0, "Instruction %s must be specified before %s",
787 parse_protocol(const char *name
, const struct protocol
**p_out
)
789 static const struct protocol protocols
[] = {
790 { "ip", ETH_TYPE_IP
, 0 },
791 { "arp", ETH_TYPE_ARP
, 0 },
792 { "icmp", ETH_TYPE_IP
, IPPROTO_ICMP
},
793 { "tcp", ETH_TYPE_IP
, IPPROTO_TCP
},
794 { "udp", ETH_TYPE_IP
, IPPROTO_UDP
},
795 { "ipv6", ETH_TYPE_IPV6
, 0 },
796 { "ip6", ETH_TYPE_IPV6
, 0 },
797 { "icmp6", ETH_TYPE_IPV6
, IPPROTO_ICMPV6
},
798 { "tcp6", ETH_TYPE_IPV6
, IPPROTO_TCP
},
799 { "udp6", ETH_TYPE_IPV6
, IPPROTO_UDP
},
800 { "rarp", ETH_TYPE_RARP
, 0},
801 { "mpls", ETH_TYPE_MPLS
, 0 },
802 { "mplsm", ETH_TYPE_MPLS_MCAST
, 0 },
804 const struct protocol
*p
;
806 for (p
= protocols
; p
< &protocols
[ARRAY_SIZE(protocols
)]; p
++) {
807 if (!strcmp(p
->name
, name
)) {
817 ofp_fatal(const char *flow
, bool verbose
, const char *format
, ...)
822 fprintf(stderr
, "%s:\n", flow
);
825 va_start(args
, format
);
826 ovs_fatal_valist(0, format
, args
);
830 parse_field(const struct mf_field
*mf
, const char *s
, struct match
*match
)
832 union mf_value value
, mask
;
835 error
= mf_parse(mf
, s
, &value
, &mask
);
837 ovs_fatal(0, "%s", error
);
840 mf_set(mf
, &value
, &mask
, match
);
843 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
844 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
845 * If 'actions' is specified, an action must be in 'string' and may be expanded
848 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
849 * constant for 'command'. To parse syntax for an OFPST_FLOW or
850 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
852 parse_ofp_str(struct ofputil_flow_mod
*fm
, int command
, const char *str_
,
862 char *string
= xstrdup(str_
);
863 char *save_ptr
= NULL
;
864 char *act_str
= NULL
;
873 fields
= F_ACTIONS
| F_TIMEOUT
| F_PRIORITY
| F_FLAGS
;
880 case OFPFC_DELETE_STRICT
:
881 fields
= F_OUT_PORT
| F_PRIORITY
;
885 fields
= F_ACTIONS
| F_TIMEOUT
| F_PRIORITY
| F_FLAGS
;
888 case OFPFC_MODIFY_STRICT
:
889 fields
= F_ACTIONS
| F_TIMEOUT
| F_PRIORITY
| F_FLAGS
;
896 match_init_catchall(&fm
->match
);
897 fm
->priority
= OFP_DEFAULT_PRIORITY
;
898 fm
->cookie
= htonll(0);
899 fm
->cookie_mask
= htonll(0);
900 if (command
== OFPFC_MODIFY
|| command
== OFPFC_MODIFY_STRICT
) {
901 /* For modify, by default, don't update the cookie. */
902 fm
->new_cookie
= htonll(UINT64_MAX
);
904 fm
->new_cookie
= htonll(0);
907 fm
->command
= command
;
908 fm
->idle_timeout
= OFP_FLOW_PERMANENT
;
909 fm
->hard_timeout
= OFP_FLOW_PERMANENT
;
910 fm
->buffer_id
= UINT32_MAX
;
911 fm
->out_port
= OFPP_ANY
;
913 if (fields
& F_ACTIONS
) {
914 act_str
= strstr(string
, "action");
916 ofp_fatal(str_
, verbose
, "must specify an action");
920 act_str
= strchr(act_str
+ 1, '=');
922 ofp_fatal(str_
, verbose
, "must specify an action");
927 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
928 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
929 const struct protocol
*p
;
931 if (parse_protocol(name
, &p
)) {
932 match_set_dl_type(&fm
->match
, htons(p
->dl_type
));
934 match_set_nw_proto(&fm
->match
, p
->nw_proto
);
936 } else if (fields
& F_FLAGS
&& !strcmp(name
, "send_flow_rem")) {
937 fm
->flags
|= OFPFF_SEND_FLOW_REM
;
938 } else if (fields
& F_FLAGS
&& !strcmp(name
, "check_overlap")) {
939 fm
->flags
|= OFPFF_CHECK_OVERLAP
;
940 } else if (fields
& F_FLAGS
&& !strcmp(name
, "reset_counts")) {
941 fm
->flags
|= OFPFF12_RESET_COUNTS
;
942 } else if (fields
& F_FLAGS
&& !strcmp(name
, "no_packet_counts")) {
943 fm
->flags
|= OFPFF13_NO_PKT_COUNTS
;
944 } else if (fields
& F_FLAGS
&& !strcmp(name
, "no_byte_counts")) {
945 fm
->flags
|= OFPFF13_NO_BYT_COUNTS
;
949 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
951 ofp_fatal(str_
, verbose
, "field %s missing value", name
);
954 if (!strcmp(name
, "table")) {
955 fm
->table_id
= str_to_u8(value
, name
);
956 } else if (!strcmp(name
, "out_port")) {
957 if (!ofputil_port_from_string(value
, &fm
->out_port
)) {
958 ofp_fatal(str_
, verbose
, "%s is not a valid OpenFlow port",
961 } else if (fields
& F_PRIORITY
&& !strcmp(name
, "priority")) {
962 fm
->priority
= str_to_u16(value
, name
);
963 } else if (fields
& F_TIMEOUT
&& !strcmp(name
, "idle_timeout")) {
964 fm
->idle_timeout
= str_to_u16(value
, name
);
965 } else if (fields
& F_TIMEOUT
&& !strcmp(name
, "hard_timeout")) {
966 fm
->hard_timeout
= str_to_u16(value
, name
);
967 } else if (!strcmp(name
, "cookie")) {
968 char *mask
= strchr(value
, '/');
971 /* A mask means we're searching for a cookie. */
972 if (command
== OFPFC_ADD
) {
973 ofp_fatal(str_
, verbose
, "flow additions cannot use "
977 fm
->cookie
= htonll(str_to_u64(value
));
978 fm
->cookie_mask
= htonll(str_to_u64(mask
+1));
980 /* No mask means that the cookie is being set. */
981 if (command
!= OFPFC_ADD
&& command
!= OFPFC_MODIFY
982 && command
!= OFPFC_MODIFY_STRICT
) {
983 ofp_fatal(str_
, verbose
, "cannot set cookie");
985 fm
->new_cookie
= htonll(str_to_u64(value
));
987 } else if (mf_from_name(name
)) {
988 parse_field(mf_from_name(name
), value
, &fm
->match
);
989 } else if (!strcmp(name
, "duration")
990 || !strcmp(name
, "n_packets")
991 || !strcmp(name
, "n_bytes")
992 || !strcmp(name
, "idle_age")
993 || !strcmp(name
, "hard_age")) {
994 /* Ignore these, so that users can feed the output of
995 * "ovs-ofctl dump-flows" back into commands that parse
998 ofp_fatal(str_
, verbose
, "unknown keyword %s", name
);
1002 if (!fm
->cookie_mask
&& fm
->new_cookie
== htonll(UINT64_MAX
)
1003 && (command
== OFPFC_MODIFY
|| command
== OFPFC_MODIFY_STRICT
)) {
1004 /* On modifies without a mask, we are supposed to add a flow if
1005 * one does not exist. If a cookie wasn't been specified, use a
1006 * default of zero. */
1007 fm
->new_cookie
= htonll(0);
1009 if (fields
& F_ACTIONS
) {
1010 struct ofpbuf ofpacts
;
1013 ofpbuf_init(&ofpacts
, 32);
1014 str_to_inst_ofpacts(act_str
, &ofpacts
);
1015 fm
->ofpacts_len
= ofpacts
.size
;
1016 fm
->ofpacts
= ofpbuf_steal_data(&ofpacts
);
1018 err
= ofpacts_check(fm
->ofpacts
, fm
->ofpacts_len
, &fm
->match
.flow
,
1025 fm
->ofpacts_len
= 0;
1032 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1033 * page) into 'mm' for sending the specified meter_mod 'command' to a switch.
1036 parse_ofp_meter_mod_str(struct ofputil_meter_mod
*mm
, const char *str_
,
1037 int command
, bool verbose
)
1044 char *string
= xstrdup(str_
);
1045 char *save_ptr
= NULL
;
1046 char *band_str
= NULL
;
1055 fields
= F_METER
| F_FLAGS
| F_BANDS
;
1058 case OFPMC13_DELETE
:
1062 case OFPMC13_MODIFY
:
1063 fields
= F_METER
| F_FLAGS
| F_BANDS
;
1070 mm
->command
= command
;
1071 mm
->meter
.meter_id
= 0;
1072 mm
->meter
.flags
= 0;
1073 if (fields
& F_BANDS
) {
1074 band_str
= strstr(string
, "band");
1076 ofp_fatal(str_
, verbose
, "must specify bands");
1080 band_str
= strchr(band_str
+ 1, '=');
1082 ofp_fatal(str_
, verbose
, "must specify bands");
1087 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
1088 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1090 if (fields
& F_FLAGS
&& !strcmp(name
, "kbps")) {
1091 mm
->meter
.flags
|= OFPMF13_KBPS
;
1092 } else if (fields
& F_FLAGS
&& !strcmp(name
, "pktps")) {
1093 mm
->meter
.flags
|= OFPMF13_PKTPS
;
1094 } else if (fields
& F_FLAGS
&& !strcmp(name
, "burst")) {
1095 mm
->meter
.flags
|= OFPMF13_BURST
;
1096 } else if (fields
& F_FLAGS
&& !strcmp(name
, "stats")) {
1097 mm
->meter
.flags
|= OFPMF13_STATS
;
1101 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1103 ofp_fatal(str_
, verbose
, "field %s missing value", name
);
1106 if (!strcmp(name
, "meter")) {
1107 if (!strcmp(value
, "all")) {
1108 mm
->meter
.meter_id
= OFPM13_ALL
;
1109 } else if (!strcmp(value
, "controller")) {
1110 mm
->meter
.meter_id
= OFPM13_CONTROLLER
;
1111 } else if (!strcmp(value
, "slowpath")) {
1112 mm
->meter
.meter_id
= OFPM13_SLOWPATH
;
1114 mm
->meter
.meter_id
= str_to_u32(value
);
1115 if (mm
->meter
.meter_id
> OFPM13_MAX
) {
1116 ofp_fatal(str_
, verbose
, "invalid value for %s", name
);
1120 ofp_fatal(str_
, verbose
, "unknown keyword %s", name
);
1124 if (fields
& F_METER
&& !mm
->meter
.meter_id
) {
1125 ofp_fatal(str_
, verbose
, "must specify 'meter'");
1127 if (fields
& F_FLAGS
&& !mm
->meter
.flags
) {
1128 ofp_fatal(str_
, verbose
,
1129 "meter must specify either 'kbps' or 'pktps'");
1132 if (fields
& F_BANDS
) {
1133 struct ofpbuf bands
;
1134 uint16_t n_bands
= 0;
1135 struct ofputil_meter_band
*band
= NULL
;
1138 ofpbuf_init(&bands
, 64);
1140 for (name
= strtok_r(band_str
, "=, \t\r\n", &save_ptr
); name
;
1141 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1145 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1147 ofp_fatal(str_
, verbose
, "field %s missing value", name
);
1150 if (!strcmp(name
, "type")) {
1151 /* Start a new band */
1152 band
= ofpbuf_put_zeros(&bands
, sizeof *band
);
1155 if (!strcmp(value
, "drop")) {
1156 band
->type
= OFPMBT13_DROP
;
1157 } else if (!strcmp(value
, "dscp_remark")) {
1158 band
->type
= OFPMBT13_DSCP_REMARK
;
1160 ofp_fatal(str_
, verbose
, "field %s unknown value %s", name
,
1163 } else if (!band
|| !band
->type
) {
1164 ofp_fatal(str_
, verbose
,
1165 "band must start with the 'type' keyword");
1166 } else if (!strcmp(name
, "rate")) {
1167 band
->rate
= str_to_u32(value
);
1168 } else if (!strcmp(name
, "burst_size")) {
1169 band
->burst_size
= str_to_u32(value
);
1170 } else if (!strcmp(name
, "prec_level")) {
1171 band
->prec_level
= str_to_u8(value
, name
);
1173 ofp_fatal(str_
, verbose
, "unknown keyword %s", name
);
1176 /* validate bands */
1178 ofp_fatal(str_
, verbose
, "meter must have bands");
1181 mm
->meter
.n_bands
= n_bands
;
1182 mm
->meter
.bands
= ofpbuf_steal_data(&bands
);
1184 for (i
= 0; i
< n_bands
; ++i
) {
1185 band
= &mm
->meter
.bands
[i
];
1188 ofp_fatal(str_
, verbose
, "band must have 'type'");
1190 if (band
->type
== OFPMBT13_DSCP_REMARK
) {
1191 if (!band
->prec_level
) {
1192 ofp_fatal(str_
, verbose
, "'dscp_remark' band must have"
1196 if (band
->prec_level
) {
1197 ofp_fatal(str_
, verbose
, "Only 'dscp_remark' band may have"
1202 ofp_fatal(str_
, verbose
, "band must have 'rate'");
1204 if (mm
->meter
.flags
& OFPMF13_BURST
) {
1205 if (!band
->burst_size
) {
1206 ofp_fatal(str_
, verbose
, "band must have 'burst_size' "
1207 "when 'burst' flag is set");
1210 if (band
->burst_size
) {
1211 ofp_fatal(str_
, verbose
, "band may have 'burst_size' only "
1212 "when 'burst' flag is set");
1217 mm
->meter
.n_bands
= 0;
1218 mm
->meter
.bands
= NULL
;
1224 /* Convert 'str_' (as described in the documentation for the "monitor" command
1225 * in the ovs-ofctl man page) into 'fmr'. */
1227 parse_flow_monitor_request(struct ofputil_flow_monitor_request
*fmr
,
1232 char *string
= xstrdup(str_
);
1233 char *save_ptr
= NULL
;
1237 fmr
->flags
= (NXFMF_INITIAL
| NXFMF_ADD
| NXFMF_DELETE
| NXFMF_MODIFY
1238 | NXFMF_OWN
| NXFMF_ACTIONS
);
1239 fmr
->out_port
= OFPP_NONE
;
1240 fmr
->table_id
= 0xff;
1241 match_init_catchall(&fmr
->match
);
1243 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
1244 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1245 const struct protocol
*p
;
1247 if (!strcmp(name
, "!initial")) {
1248 fmr
->flags
&= ~NXFMF_INITIAL
;
1249 } else if (!strcmp(name
, "!add")) {
1250 fmr
->flags
&= ~NXFMF_ADD
;
1251 } else if (!strcmp(name
, "!delete")) {
1252 fmr
->flags
&= ~NXFMF_DELETE
;
1253 } else if (!strcmp(name
, "!modify")) {
1254 fmr
->flags
&= ~NXFMF_MODIFY
;
1255 } else if (!strcmp(name
, "!actions")) {
1256 fmr
->flags
&= ~NXFMF_ACTIONS
;
1257 } else if (!strcmp(name
, "!own")) {
1258 fmr
->flags
&= ~NXFMF_OWN
;
1259 } else if (parse_protocol(name
, &p
)) {
1260 match_set_dl_type(&fmr
->match
, htons(p
->dl_type
));
1262 match_set_nw_proto(&fmr
->match
, p
->nw_proto
);
1267 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1269 ovs_fatal(0, "%s: field %s missing value", str_
, name
);
1272 if (!strcmp(name
, "table")) {
1273 fmr
->table_id
= str_to_u8(value
, name
);
1274 } else if (!strcmp(name
, "out_port")) {
1275 fmr
->out_port
= u16_to_ofp(atoi(value
));
1276 } else if (mf_from_name(name
)) {
1277 parse_field(mf_from_name(name
), value
, &fmr
->match
);
1279 ovs_fatal(0, "%s: unknown keyword %s", str_
, name
);
1286 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1289 * Prints an error on stderr and aborts the program if 's' syntax is
1292 parse_ofpacts(const char *s_
, struct ofpbuf
*ofpacts
)
1294 char *s
= xstrdup(s_
);
1295 str_to_ofpacts(s
, ofpacts
);
1299 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1300 * (one of OFPFC_*) into 'fm'. */
1302 parse_ofp_flow_mod_str(struct ofputil_flow_mod
*fm
, const char *string
,
1303 uint16_t command
, bool verbose
)
1305 struct match match_copy
;
1307 parse_ofp_str(fm
, command
, string
, verbose
);
1309 /* Normalize a copy of the match. This ensures that non-normalized flows
1310 * get logged but doesn't affect what gets sent to the switch, so that the
1311 * switch can do whatever it likes with the flow. */
1312 match_copy
= fm
->match
;
1313 ofputil_normalize_match(&match_copy
);
1317 parse_ofp_flow_mod_file(const char *file_name
, uint16_t command
,
1318 struct ofputil_flow_mod
**fms
, size_t *n_fms
)
1320 size_t allocated_fms
;
1324 stream
= !strcmp(file_name
, "-") ? stdin
: fopen(file_name
, "r");
1325 if (stream
== NULL
) {
1326 ovs_fatal(errno
, "%s: open", file_name
);
1329 allocated_fms
= *n_fms
;
1331 while (!ds_get_preprocessed_line(&s
, stream
)) {
1332 if (*n_fms
>= allocated_fms
) {
1333 *fms
= x2nrealloc(*fms
, &allocated_fms
, sizeof **fms
);
1335 parse_ofp_flow_mod_str(&(*fms
)[*n_fms
], ds_cstr(&s
), command
, false);
1340 if (stream
!= stdin
) {
1346 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request
*fsr
,
1347 bool aggregate
, const char *string
)
1349 struct ofputil_flow_mod fm
;
1351 parse_ofp_str(&fm
, -1, string
, false);
1352 fsr
->aggregate
= aggregate
;
1353 fsr
->cookie
= fm
.cookie
;
1354 fsr
->cookie_mask
= fm
.cookie_mask
;
1355 fsr
->match
= fm
.match
;
1356 fsr
->out_port
= fm
.out_port
;
1357 fsr
->table_id
= fm
.table_id
;
1360 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1361 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1362 * mf_field. Fields must be specified in a natural order for satisfying
1365 * Returns NULL on success, otherwise a malloc()'d string that explains the
1368 parse_ofp_exact_flow(struct flow
*flow
, const char *s
)
1370 char *pos
, *key
, *value_s
;
1374 memset(flow
, 0, sizeof *flow
);
1376 pos
= copy
= xstrdup(s
);
1377 while (ofputil_parse_key_value(&pos
, &key
, &value_s
)) {
1378 const struct protocol
*p
;
1379 if (parse_protocol(key
, &p
)) {
1380 if (flow
->dl_type
) {
1381 error
= xasprintf("%s: Ethernet type set multiple times", s
);
1384 flow
->dl_type
= htons(p
->dl_type
);
1387 if (flow
->nw_proto
) {
1388 error
= xasprintf("%s: network protocol set "
1389 "multiple times", s
);
1392 flow
->nw_proto
= p
->nw_proto
;
1395 const struct mf_field
*mf
;
1396 union mf_value value
;
1399 mf
= mf_from_name(key
);
1401 error
= xasprintf("%s: unknown field %s", s
, key
);
1405 if (!mf_are_prereqs_ok(mf
, flow
)) {
1406 error
= xasprintf("%s: prerequisites not met for setting %s",
1411 if (!mf_is_zero(mf
, flow
)) {
1412 error
= xasprintf("%s: field %s set multiple times", s
, key
);
1416 field_error
= mf_parse_value(mf
, value_s
, &value
);
1418 error
= xasprintf("%s: bad value for %s (%s)",
1419 s
, key
, field_error
);
1424 mf_set_flow_value(mf
, &value
, flow
);
1428 if (!flow
->in_port
.ofp_port
) {
1429 flow
->in_port
.ofp_port
= OFPP_NONE
;
1436 memset(flow
, 0, sizeof *flow
);