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"
37 #include "ovs-thread.h"
39 #include "socket-util.h"
43 VLOG_DEFINE_THIS_MODULE(ofp_parse
);
45 /* Parses 'str' as an 8-bit unsigned integer into '*valuep'.
47 * 'name' describes the value parsed in an error message, if any.
49 * Returns NULL if successful, otherwise a malloc()'d string describing the
50 * error. The caller is responsible for freeing the returned string. */
51 static char * WARN_UNUSED_RESULT
52 str_to_u8(const char *str
, const char *name
, uint8_t *valuep
)
56 if (!str_to_int(str
, 0, &value
) || value
< 0 || value
> 255) {
57 return xasprintf("invalid %s \"%s\"", name
, str
);
63 /* Parses 'str' as a 16-bit unsigned integer into '*valuep'.
65 * 'name' describes the value parsed in an error message, if any.
67 * Returns NULL if successful, otherwise a malloc()'d string describing the
68 * error. The caller is responsible for freeing the returned string. */
69 static char * WARN_UNUSED_RESULT
70 str_to_u16(const char *str
, const char *name
, uint16_t *valuep
)
74 if (!str_to_int(str
, 0, &value
) || value
< 0 || value
> 65535) {
75 return xasprintf("invalid %s \"%s\"", name
, str
);
81 /* Parses 'str' as a 32-bit unsigned integer into '*valuep'.
83 * Returns NULL if successful, otherwise a malloc()'d string describing the
84 * error. The caller is responsible for freeing the returned string. */
85 static char * WARN_UNUSED_RESULT
86 str_to_u32(const char *str
, uint32_t *valuep
)
92 return xstrdup("missing required numeric argument");
96 value
= strtoul(str
, &tail
, 0);
97 if (errno
== EINVAL
|| errno
== ERANGE
|| *tail
) {
98 return xasprintf("invalid numeric format %s", str
);
104 /* Parses 'str' as an 64-bit unsigned integer into '*valuep'.
106 * Returns NULL if successful, otherwise a malloc()'d string describing the
107 * error. The caller is responsible for freeing the returned string. */
108 static char * WARN_UNUSED_RESULT
109 str_to_u64(const char *str
, uint64_t *valuep
)
115 return xstrdup("missing required numeric argument");
119 value
= strtoull(str
, &tail
, 0);
120 if (errno
== EINVAL
|| errno
== ERANGE
|| *tail
) {
121 return xasprintf("invalid numeric format %s", str
);
127 /* Parses 'str' as an 64-bit unsigned integer in network byte order into
130 * Returns NULL if successful, otherwise a malloc()'d string describing the
131 * error. The caller is responsible for freeing the returned string. */
132 static char * WARN_UNUSED_RESULT
133 str_to_be64(const char *str
, ovs_be64
*valuep
)
138 error
= str_to_u64(str
, &value
);
140 *valuep
= htonll(value
);
145 /* Parses 'str' as an Ethernet address into 'mac'.
147 * Returns NULL if successful, otherwise a malloc()'d string describing the
148 * error. The caller is responsible for freeing the returned string. */
149 static char * WARN_UNUSED_RESULT
150 str_to_mac(const char *str
, uint8_t mac
[6])
152 if (sscanf(str
, ETH_ADDR_SCAN_FMT
, ETH_ADDR_SCAN_ARGS(mac
))
153 != ETH_ADDR_SCAN_COUNT
) {
154 return xasprintf("invalid mac address %s", str
);
159 /* Parses 'str' as an IP address into '*ip'.
161 * Returns NULL if successful, otherwise a malloc()'d string describing the
162 * error. The caller is responsible for freeing the returned string. */
163 static char * WARN_UNUSED_RESULT
164 str_to_ip(const char *str
, ovs_be32
*ip
)
166 struct in_addr in_addr
;
168 if (lookup_ip(str
, &in_addr
)) {
169 return xasprintf("%s: could not convert to IP address", str
);
171 *ip
= in_addr
.s_addr
;
175 /* Parses 'arg' as the argument to an "enqueue" action, and appends such an
176 * action to 'ofpacts'.
178 * Returns NULL if successful, otherwise a malloc()'d string describing the
179 * error. The caller is responsible for freeing the returned string. */
180 static char * WARN_UNUSED_RESULT
181 parse_enqueue(char *arg
, struct ofpbuf
*ofpacts
)
184 char *port
= strtok_r(arg
, ":q", &sp
);
185 char *queue
= strtok_r(NULL
, "", &sp
);
186 struct ofpact_enqueue
*enqueue
;
188 if (port
== NULL
|| queue
== NULL
) {
189 return xstrdup("\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
192 enqueue
= ofpact_put_ENQUEUE(ofpacts
);
193 if (!ofputil_port_from_string(port
, &enqueue
->port
)) {
194 return xasprintf("%s: enqueue to unknown port", port
);
196 return str_to_u32(queue
, &enqueue
->queue
);
199 /* Parses 'arg' as the argument to an "output" action, and appends such an
200 * action to 'ofpacts'.
202 * Returns NULL if successful, otherwise a malloc()'d string describing the
203 * error. The caller is responsible for freeing the returned string. */
204 static char * WARN_UNUSED_RESULT
205 parse_output(const char *arg
, struct ofpbuf
*ofpacts
)
207 if (strchr(arg
, '[')) {
208 struct ofpact_output_reg
*output_reg
;
210 output_reg
= ofpact_put_OUTPUT_REG(ofpacts
);
211 output_reg
->max_len
= UINT16_MAX
;
212 return mf_parse_subfield(&output_reg
->src
, arg
);
214 struct ofpact_output
*output
;
216 output
= ofpact_put_OUTPUT(ofpacts
);
217 output
->max_len
= output
->port
== OFPP_CONTROLLER
? UINT16_MAX
: 0;
218 if (!ofputil_port_from_string(arg
, &output
->port
)) {
219 return xasprintf("%s: output to unknown port", arg
);
225 /* Parses 'arg' as the argument to an "resubmit" action, and appends such an
226 * action to 'ofpacts'.
228 * Returns NULL if successful, otherwise a malloc()'d string describing the
229 * error. The caller is responsible for freeing the returned string. */
230 static char * WARN_UNUSED_RESULT
231 parse_resubmit(char *arg
, struct ofpbuf
*ofpacts
)
233 struct ofpact_resubmit
*resubmit
;
234 char *in_port_s
, *table_s
;
236 resubmit
= ofpact_put_RESUBMIT(ofpacts
);
238 in_port_s
= strsep(&arg
, ",");
239 if (in_port_s
&& in_port_s
[0]) {
240 if (!ofputil_port_from_string(in_port_s
, &resubmit
->in_port
)) {
241 return xasprintf("%s: resubmit to unknown port", in_port_s
);
244 resubmit
->in_port
= OFPP_IN_PORT
;
247 table_s
= strsep(&arg
, ",");
248 if (table_s
&& table_s
[0]) {
249 uint32_t table_id
= 0;
252 error
= str_to_u32(table_s
, &table_id
);
256 resubmit
->table_id
= table_id
;
258 resubmit
->table_id
= 255;
261 if (resubmit
->in_port
== OFPP_IN_PORT
&& resubmit
->table_id
== 255) {
262 return xstrdup("at least one \"in_port\" or \"table\" must be "
263 "specified on resubmit");
268 /* Parses 'arg' as the argument to a "note" action, and appends such an action
271 * Returns NULL if successful, otherwise a malloc()'d string describing the
272 * error. The caller is responsible for freeing the returned string. */
273 static char * WARN_UNUSED_RESULT
274 parse_note(const char *arg
, struct ofpbuf
*ofpacts
)
276 struct ofpact_note
*note
;
278 note
= ofpact_put_NOTE(ofpacts
);
279 while (*arg
!= '\0') {
290 byte
= hexits_value(arg
, 2, &ok
);
292 return xstrdup("bad hex digit in `note' argument");
294 ofpbuf_put(ofpacts
, &byte
, 1);
301 ofpact_update_len(ofpacts
, ¬e
->ofpact
);
305 /* Parses 'arg' as the argument to a "fin_timeout" action, and appends such an
306 * action to 'ofpacts'.
308 * Returns NULL if successful, otherwise a malloc()'d string describing the
309 * error. The caller is responsible for freeing the returned string. */
310 static char * WARN_UNUSED_RESULT
311 parse_fin_timeout(struct ofpbuf
*b
, char *arg
)
313 struct ofpact_fin_timeout
*oft
= ofpact_put_FIN_TIMEOUT(b
);
316 while (ofputil_parse_key_value(&arg
, &key
, &value
)) {
319 if (!strcmp(key
, "idle_timeout")) {
320 error
= str_to_u16(value
, key
, &oft
->fin_idle_timeout
);
321 } else if (!strcmp(key
, "hard_timeout")) {
322 error
= str_to_u16(value
, key
, &oft
->fin_hard_timeout
);
324 error
= xasprintf("invalid key '%s' in 'fin_timeout' argument",
335 /* Parses 'arg' as the argument to a "controller" action, and appends such an
336 * action to 'ofpacts'.
338 * Returns NULL if successful, otherwise a malloc()'d string describing the
339 * error. The caller is responsible for freeing the returned string. */
340 static char * WARN_UNUSED_RESULT
341 parse_controller(struct ofpbuf
*b
, char *arg
)
343 enum ofp_packet_in_reason reason
= OFPR_ACTION
;
344 uint16_t controller_id
= 0;
345 uint16_t max_len
= UINT16_MAX
;
349 } else if (strspn(arg
, "0123456789") == strlen(arg
)) {
350 char *error
= str_to_u16(arg
, "max_len", &max_len
);
357 while (ofputil_parse_key_value(&arg
, &name
, &value
)) {
358 if (!strcmp(name
, "reason")) {
359 if (!ofputil_packet_in_reason_from_string(value
, &reason
)) {
360 return xasprintf("unknown reason \"%s\"", value
);
362 } else if (!strcmp(name
, "max_len")) {
363 char *error
= str_to_u16(value
, "max_len", &max_len
);
367 } else if (!strcmp(name
, "id")) {
368 char *error
= str_to_u16(value
, "id", &controller_id
);
373 return xasprintf("unknown key \"%s\" parsing controller "
379 if (reason
== OFPR_ACTION
&& controller_id
== 0) {
380 struct ofpact_output
*output
;
382 output
= ofpact_put_OUTPUT(b
);
383 output
->port
= OFPP_CONTROLLER
;
384 output
->max_len
= max_len
;
386 struct ofpact_controller
*controller
;
388 controller
= ofpact_put_CONTROLLER(b
);
389 controller
->max_len
= max_len
;
390 controller
->reason
= reason
;
391 controller
->controller_id
= controller_id
;
398 parse_noargs_dec_ttl(struct ofpbuf
*b
)
400 struct ofpact_cnt_ids
*ids
;
403 ids
= ofpact_put_DEC_TTL(b
);
404 ofpbuf_put(b
, &id
, sizeof id
);
406 ids
->n_controllers
++;
407 ofpact_update_len(b
, &ids
->ofpact
);
410 /* Parses 'arg' as the argument to a "dec_ttl" action, and appends such an
411 * action to 'ofpacts'.
413 * Returns NULL if successful, otherwise a malloc()'d string describing the
414 * error. The caller is responsible for freeing the returned string. */
415 static char * WARN_UNUSED_RESULT
416 parse_dec_ttl(struct ofpbuf
*b
, char *arg
)
419 parse_noargs_dec_ttl(b
);
421 struct ofpact_cnt_ids
*ids
;
424 ids
= ofpact_put_DEC_TTL(b
);
425 ids
->ofpact
.compat
= OFPUTIL_NXAST_DEC_TTL_CNT_IDS
;
426 for (cntr
= strtok_r(arg
, ", ", &arg
); cntr
!= NULL
;
427 cntr
= strtok_r(NULL
, ", ", &arg
)) {
428 uint16_t id
= atoi(cntr
);
430 ofpbuf_put(b
, &id
, sizeof id
);
432 ids
->n_controllers
++;
434 if (!ids
->n_controllers
) {
435 return xstrdup("dec_ttl_cnt_ids: expected at least one controller "
438 ofpact_update_len(b
, &ids
->ofpact
);
443 /* Parses 'arg' as the argument to a "set_mpls_ttl" action, and appends such an
444 * action to 'ofpacts'.
446 * Returns NULL if successful, otherwise a malloc()'d string describing the
447 * error. The caller is responsible for freeing the returned string. */
448 static char * WARN_UNUSED_RESULT
449 parse_set_mpls_ttl(struct ofpbuf
*b
, const char *arg
)
451 struct ofpact_mpls_ttl
*mpls_ttl
= ofpact_put_SET_MPLS_TTL(b
);
454 return xstrdup("parse_set_mpls_ttl: expected ttl.");
457 mpls_ttl
->ttl
= atoi(arg
);
461 /* Parses a "set_field" action with argument 'arg', appending the parsed
462 * action to 'ofpacts'.
464 * Returns NULL if successful, otherwise a malloc()'d string describing the
465 * error. The caller is responsible for freeing the returned string. */
466 static char * WARN_UNUSED_RESULT
467 set_field_parse__(char *arg
, struct ofpbuf
*ofpacts
,
468 enum ofputil_protocol
*usable_protocols
)
470 struct ofpact_reg_load
*load
= ofpact_put_REG_LOAD(ofpacts
);
474 const struct mf_field
*mf
;
476 union mf_value mf_value
;
479 delim
= strstr(arg
, "->");
481 return xasprintf("%s: missing `->'", arg
);
483 if (strlen(delim
) <= strlen("->")) {
484 return xasprintf("%s: missing field name following `->'", arg
);
487 key
= delim
+ strlen("->");
488 mf
= mf_from_name(key
);
490 return xasprintf("%s is not a valid OXM field name", key
);
493 return xasprintf("%s is read-only", key
);
497 error
= mf_parse_value(mf
, value
, &mf_value
);
501 if (!mf_is_value_valid(mf
, &mf_value
)) {
502 return xasprintf("%s is not a valid value for field %s", value
, key
);
504 ofpact_set_field_init(load
, mf
, &mf_value
);
506 *usable_protocols
&= mf
->usable_protocols
;
510 /* Parses 'arg' as the argument to a "set_field" action, and appends such an
511 * action to 'ofpacts'.
513 * Returns NULL if successful, otherwise a malloc()'d string describing the
514 * error. The caller is responsible for freeing the returned string. */
515 static char * WARN_UNUSED_RESULT
516 set_field_parse(const char *arg
, struct ofpbuf
*ofpacts
,
517 enum ofputil_protocol
*usable_protocols
)
519 char *copy
= xstrdup(arg
);
520 char *error
= set_field_parse__(copy
, ofpacts
, usable_protocols
);
525 /* Parses 'arg' as the argument to a "write_metadata" instruction, and appends
526 * such an action to 'ofpacts'.
528 * Returns NULL if successful, otherwise a malloc()'d string describing the
529 * error. The caller is responsible for freeing the returned string. */
530 static char * WARN_UNUSED_RESULT
531 parse_metadata(struct ofpbuf
*b
, char *arg
)
533 struct ofpact_metadata
*om
;
534 char *mask
= strchr(arg
, '/');
536 om
= ofpact_put_WRITE_METADATA(b
);
542 error
= str_to_be64(mask
+ 1, &om
->mask
);
547 om
->mask
= OVS_BE64_MAX
;
550 return str_to_be64(arg
, &om
->metadata
);
553 /* Parses 'arg' as the argument to a "sample" action, and appends such an
554 * action to 'ofpacts'.
556 * Returns NULL if successful, otherwise a malloc()'d string describing the
557 * error. The caller is responsible for freeing the returned string. */
558 static char * WARN_UNUSED_RESULT
559 parse_sample(struct ofpbuf
*b
, char *arg
)
561 struct ofpact_sample
*os
= ofpact_put_SAMPLE(b
);
564 while (ofputil_parse_key_value(&arg
, &key
, &value
)) {
567 if (!strcmp(key
, "probability")) {
568 error
= str_to_u16(value
, "probability", &os
->probability
);
569 if (!error
&& os
->probability
== 0) {
570 error
= xasprintf("invalid probability value \"%s\"", value
);
572 } else if (!strcmp(key
, "collector_set_id")) {
573 error
= str_to_u32(value
, &os
->collector_set_id
);
574 } else if (!strcmp(key
, "obs_domain_id")) {
575 error
= str_to_u32(value
, &os
->obs_domain_id
);
576 } else if (!strcmp(key
, "obs_point_id")) {
577 error
= str_to_u32(value
, &os
->obs_point_id
);
579 error
= xasprintf("invalid key \"%s\" in \"sample\" argument",
586 if (os
->probability
== 0) {
587 return xstrdup("non-zero \"probability\" must be specified on sample");
592 /* Parses 'arg' as the argument to action 'code', and appends such an action to
595 * Returns NULL if successful, otherwise a malloc()'d string describing the
596 * error. The caller is responsible for freeing the returned string. */
597 static char * WARN_UNUSED_RESULT
598 parse_named_action(enum ofputil_action_code code
,
599 char *arg
, struct ofpbuf
*ofpacts
,
600 enum ofputil_protocol
*usable_protocols
)
602 size_t orig_size
= ofpacts
->size
;
603 struct ofpact_tunnel
*tunnel
;
605 uint16_t ethertype
= 0;
611 case OFPUTIL_ACTION_INVALID
:
614 case OFPUTIL_OFPAT10_OUTPUT
:
615 case OFPUTIL_OFPAT11_OUTPUT
:
616 error
= parse_output(arg
, ofpacts
);
619 case OFPUTIL_OFPAT10_SET_VLAN_VID
:
620 case OFPUTIL_OFPAT11_SET_VLAN_VID
:
621 error
= str_to_u16(arg
, "VLAN VID", &vid
);
626 if (vid
& ~VLAN_VID_MASK
) {
627 return xasprintf("%s: not a valid VLAN VID", arg
);
629 ofpact_put_SET_VLAN_VID(ofpacts
)->vlan_vid
= vid
;
632 case OFPUTIL_OFPAT10_SET_VLAN_PCP
:
633 case OFPUTIL_OFPAT11_SET_VLAN_PCP
:
634 error
= str_to_u8(arg
, "VLAN PCP", &pcp
);
640 return xasprintf("%s: not a valid VLAN PCP", arg
);
642 ofpact_put_SET_VLAN_PCP(ofpacts
)->vlan_pcp
= pcp
;
645 case OFPUTIL_OFPAT12_SET_FIELD
:
646 return set_field_parse(arg
, ofpacts
, usable_protocols
);
648 case OFPUTIL_OFPAT10_STRIP_VLAN
:
649 case OFPUTIL_OFPAT11_POP_VLAN
:
650 ofpact_put_STRIP_VLAN(ofpacts
);
653 case OFPUTIL_OFPAT11_PUSH_VLAN
:
654 *usable_protocols
&= OFPUTIL_P_OF11_UP
;
655 error
= str_to_u16(arg
, "ethertype", ðertype
);
660 if (ethertype
!= ETH_TYPE_VLAN_8021Q
) {
661 /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
662 return xasprintf("%s: not a valid VLAN ethertype", arg
);
665 ofpact_put_PUSH_VLAN(ofpacts
);
668 case OFPUTIL_OFPAT11_SET_QUEUE
:
669 error
= str_to_u32(arg
, &ofpact_put_SET_QUEUE(ofpacts
)->queue_id
);
672 case OFPUTIL_OFPAT10_SET_DL_SRC
:
673 case OFPUTIL_OFPAT11_SET_DL_SRC
:
674 error
= str_to_mac(arg
, ofpact_put_SET_ETH_SRC(ofpacts
)->mac
);
677 case OFPUTIL_OFPAT10_SET_DL_DST
:
678 case OFPUTIL_OFPAT11_SET_DL_DST
:
679 error
= str_to_mac(arg
, ofpact_put_SET_ETH_DST(ofpacts
)->mac
);
682 case OFPUTIL_OFPAT10_SET_NW_SRC
:
683 case OFPUTIL_OFPAT11_SET_NW_SRC
:
684 error
= str_to_ip(arg
, &ofpact_put_SET_IPV4_SRC(ofpacts
)->ipv4
);
687 case OFPUTIL_OFPAT10_SET_NW_DST
:
688 case OFPUTIL_OFPAT11_SET_NW_DST
:
689 error
= str_to_ip(arg
, &ofpact_put_SET_IPV4_DST(ofpacts
)->ipv4
);
692 case OFPUTIL_OFPAT10_SET_NW_TOS
:
693 case OFPUTIL_OFPAT11_SET_NW_TOS
:
694 error
= str_to_u8(arg
, "TOS", &tos
);
699 if (tos
& ~IP_DSCP_MASK
) {
700 return xasprintf("%s: not a valid TOS", arg
);
702 ofpact_put_SET_IPV4_DSCP(ofpacts
)->dscp
= tos
;
705 case OFPUTIL_OFPAT11_DEC_NW_TTL
:
708 case OFPUTIL_OFPAT10_SET_TP_SRC
:
709 case OFPUTIL_OFPAT11_SET_TP_SRC
:
710 error
= str_to_u16(arg
, "source port",
711 &ofpact_put_SET_L4_SRC_PORT(ofpacts
)->port
);
714 case OFPUTIL_OFPAT10_SET_TP_DST
:
715 case OFPUTIL_OFPAT11_SET_TP_DST
:
716 error
= str_to_u16(arg
, "destination port",
717 &ofpact_put_SET_L4_DST_PORT(ofpacts
)->port
);
720 case OFPUTIL_OFPAT10_ENQUEUE
:
721 error
= parse_enqueue(arg
, ofpacts
);
724 case OFPUTIL_NXAST_RESUBMIT
:
725 error
= parse_resubmit(arg
, ofpacts
);
728 case OFPUTIL_NXAST_SET_TUNNEL
:
729 case OFPUTIL_NXAST_SET_TUNNEL64
:
730 tunnel
= ofpact_put_SET_TUNNEL(ofpacts
);
731 tunnel
->ofpact
.compat
= code
;
732 error
= str_to_u64(arg
, &tunnel
->tun_id
);
735 case OFPUTIL_NXAST_WRITE_METADATA
:
736 error
= parse_metadata(ofpacts
, arg
);
739 case OFPUTIL_NXAST_SET_QUEUE
:
740 error
= str_to_u32(arg
, &ofpact_put_SET_QUEUE(ofpacts
)->queue_id
);
743 case OFPUTIL_NXAST_POP_QUEUE
:
744 ofpact_put_POP_QUEUE(ofpacts
);
747 case OFPUTIL_NXAST_REG_MOVE
:
748 error
= nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts
), arg
);
751 case OFPUTIL_NXAST_REG_LOAD
:
752 error
= nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts
), arg
);
755 case OFPUTIL_NXAST_NOTE
:
756 error
= parse_note(arg
, ofpacts
);
759 case OFPUTIL_NXAST_MULTIPATH
:
760 error
= multipath_parse(ofpact_put_MULTIPATH(ofpacts
), arg
);
763 case OFPUTIL_NXAST_BUNDLE
:
764 error
= bundle_parse(arg
, ofpacts
);
767 case OFPUTIL_NXAST_BUNDLE_LOAD
:
768 error
= bundle_parse_load(arg
, ofpacts
);
771 case OFPUTIL_NXAST_RESUBMIT_TABLE
:
772 case OFPUTIL_NXAST_OUTPUT_REG
:
773 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS
:
776 case OFPUTIL_NXAST_LEARN
:
777 error
= learn_parse(arg
, ofpacts
);
780 case OFPUTIL_NXAST_EXIT
:
781 ofpact_put_EXIT(ofpacts
);
784 case OFPUTIL_NXAST_DEC_TTL
:
785 error
= parse_dec_ttl(ofpacts
, arg
);
788 case OFPUTIL_NXAST_SET_MPLS_TTL
:
789 case OFPUTIL_OFPAT11_SET_MPLS_TTL
:
790 error
= parse_set_mpls_ttl(ofpacts
, arg
);
793 case OFPUTIL_OFPAT11_DEC_MPLS_TTL
:
794 case OFPUTIL_NXAST_DEC_MPLS_TTL
:
795 ofpact_put_DEC_MPLS_TTL(ofpacts
);
798 case OFPUTIL_NXAST_FIN_TIMEOUT
:
799 error
= parse_fin_timeout(ofpacts
, arg
);
802 case OFPUTIL_NXAST_CONTROLLER
:
803 error
= parse_controller(ofpacts
, arg
);
806 case OFPUTIL_OFPAT11_PUSH_MPLS
:
807 case OFPUTIL_NXAST_PUSH_MPLS
:
808 error
= str_to_u16(arg
, "push_mpls", ðertype
);
810 ofpact_put_PUSH_MPLS(ofpacts
)->ethertype
= htons(ethertype
);
814 case OFPUTIL_OFPAT11_POP_MPLS
:
815 case OFPUTIL_NXAST_POP_MPLS
:
816 error
= str_to_u16(arg
, "pop_mpls", ðertype
);
818 ofpact_put_POP_MPLS(ofpacts
)->ethertype
= htons(ethertype
);
822 case OFPUTIL_OFPAT11_GROUP
:
823 error
= str_to_u32(arg
, &ofpact_put_GROUP(ofpacts
)->group_id
);
826 case OFPUTIL_NXAST_STACK_PUSH
:
827 error
= nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts
), arg
);
829 case OFPUTIL_NXAST_STACK_POP
:
830 error
= nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts
), arg
);
833 case OFPUTIL_NXAST_SAMPLE
:
834 error
= parse_sample(ofpacts
, arg
);
839 ofpacts
->size
= orig_size
;
844 /* Parses action 'act', with argument 'arg', and appends a parsed version to
847 * 'n_actions' specifies the number of actions already parsed (for proper
848 * handling of "drop" actions).
850 * Returns NULL if successful, otherwise a malloc()'d string describing the
851 * error. The caller is responsible for freeing the returned string. */
852 static char * WARN_UNUSED_RESULT
853 str_to_ofpact__(char *pos
, char *act
, char *arg
,
854 struct ofpbuf
*ofpacts
, int n_actions
,
855 enum ofputil_protocol
*usable_protocols
)
857 int code
= ofputil_action_code_from_name(act
);
859 return parse_named_action(code
, arg
, ofpacts
, usable_protocols
);
860 } else if (!strcasecmp(act
, "drop")) {
862 return xstrdup("Drop actions must not be preceded by other "
864 } else if (ofputil_parse_key_value(&pos
, &act
, &arg
)) {
865 return xstrdup("Drop actions must not be followed by other "
870 if (ofputil_port_from_string(act
, &port
)) {
871 ofpact_put_OUTPUT(ofpacts
)->port
= port
;
873 return xasprintf("Unknown action: %s", act
);
880 /* Parses 'str' as a series of actions, and appends them to 'ofpacts'.
882 * Returns NULL if successful, otherwise a malloc()'d string describing the
883 * error. The caller is responsible for freeing the returned string. */
884 static char * WARN_UNUSED_RESULT
885 str_to_ofpacts(char *str
, struct ofpbuf
*ofpacts
,
886 enum ofputil_protocol
*usable_protocols
)
888 size_t orig_size
= ofpacts
->size
;
889 char *pos
, *act
, *arg
;
895 while (ofputil_parse_key_value(&pos
, &act
, &arg
)) {
896 char *error
= str_to_ofpact__(pos
, act
, arg
, ofpacts
, n_actions
,
899 ofpacts
->size
= orig_size
;
905 error
= ofpacts_verify(ofpacts
->data
, ofpacts
->size
);
907 ofpacts
->size
= orig_size
;
908 return xstrdup("Incorrect action ordering");
915 /* Parses 'arg' as the argument to instruction 'type', and appends such an
916 * instruction to 'ofpacts'.
918 * Returns NULL if successful, otherwise a malloc()'d string describing the
919 * error. The caller is responsible for freeing the returned string. */
920 static char * WARN_UNUSED_RESULT
921 parse_named_instruction(enum ovs_instruction_type type
,
922 char *arg
, struct ofpbuf
*ofpacts
,
923 enum ofputil_protocol
*usable_protocols
)
925 char *error_s
= NULL
;
928 *usable_protocols
&= OFPUTIL_P_OF11_UP
;
931 case OVSINST_OFPIT11_APPLY_ACTIONS
:
932 NOT_REACHED(); /* This case is handled by str_to_inst_ofpacts() */
935 case OVSINST_OFPIT11_WRITE_ACTIONS
:
937 error_s
= xstrdup("instruction write-actions is not supported yet");
940 case OVSINST_OFPIT11_CLEAR_ACTIONS
:
941 ofpact_put_CLEAR_ACTIONS(ofpacts
);
944 case OVSINST_OFPIT13_METER
:
945 *usable_protocols
&= OFPUTIL_P_OF13_UP
;
946 error_s
= str_to_u32(arg
, &ofpact_put_METER(ofpacts
)->meter_id
);
949 case OVSINST_OFPIT11_WRITE_METADATA
:
950 *usable_protocols
&= OFPUTIL_P_NXM_OF11_UP
;
951 error_s
= parse_metadata(ofpacts
, arg
);
954 case OVSINST_OFPIT11_GOTO_TABLE
: {
955 struct ofpact_goto_table
*ogt
= ofpact_put_GOTO_TABLE(ofpacts
);
956 char *table_s
= strsep(&arg
, ",");
957 if (!table_s
|| !table_s
[0]) {
958 return xstrdup("instruction goto-table needs table id");
960 error_s
= str_to_u8(table_s
, "table", &ogt
->table_id
);
969 /* If write_metadata is specified as an action AND an instruction, ofpacts
971 error
= ofpacts_verify(ofpacts
->data
, ofpacts
->size
);
973 return xstrdup("Incorrect instruction ordering");
978 /* Parses 'str' as a series of instructions, and appends them to 'ofpacts'.
980 * Returns NULL if successful, otherwise a malloc()'d string describing the
981 * error. The caller is responsible for freeing the returned string. */
982 static char * WARN_UNUSED_RESULT
983 str_to_inst_ofpacts(char *str
, struct ofpbuf
*ofpacts
,
984 enum ofputil_protocol
*usable_protocols
)
986 size_t orig_size
= ofpacts
->size
;
987 char *pos
, *inst
, *arg
;
989 const char *prev_inst
= NULL
;
994 while (ofputil_parse_key_value(&pos
, &inst
, &arg
)) {
995 type
= ovs_instruction_type_from_name(inst
);
997 char *error
= str_to_ofpact__(pos
, inst
, arg
, ofpacts
, n_actions
,
1000 ofpacts
->size
= orig_size
;
1004 type
= OVSINST_OFPIT11_APPLY_ACTIONS
;
1005 if (prev_type
== type
) {
1009 } else if (type
== OVSINST_OFPIT11_APPLY_ACTIONS
) {
1010 ofpacts
->size
= orig_size
;
1011 return xasprintf("%s isn't supported. Just write actions then "
1012 "it is interpreted as apply_actions", inst
);
1014 char *error
= parse_named_instruction(type
, arg
, ofpacts
,
1017 ofpacts
->size
= orig_size
;
1022 if (type
<= prev_type
) {
1023 ofpacts
->size
= orig_size
;
1024 if (type
== prev_type
) {
1025 return xasprintf("instruction %s may be specified only once",
1028 return xasprintf("instruction %s must be specified before %s",
1037 ofpact_pad(ofpacts
);
1049 parse_protocol(const char *name
, const struct protocol
**p_out
)
1051 static const struct protocol protocols
[] = {
1052 { "ip", ETH_TYPE_IP
, 0 },
1053 { "arp", ETH_TYPE_ARP
, 0 },
1054 { "icmp", ETH_TYPE_IP
, IPPROTO_ICMP
},
1055 { "tcp", ETH_TYPE_IP
, IPPROTO_TCP
},
1056 { "udp", ETH_TYPE_IP
, IPPROTO_UDP
},
1057 { "sctp", ETH_TYPE_IP
, IPPROTO_SCTP
},
1058 { "ipv6", ETH_TYPE_IPV6
, 0 },
1059 { "ip6", ETH_TYPE_IPV6
, 0 },
1060 { "icmp6", ETH_TYPE_IPV6
, IPPROTO_ICMPV6
},
1061 { "tcp6", ETH_TYPE_IPV6
, IPPROTO_TCP
},
1062 { "udp6", ETH_TYPE_IPV6
, IPPROTO_UDP
},
1063 { "sctp6", ETH_TYPE_IPV6
, IPPROTO_SCTP
},
1064 { "rarp", ETH_TYPE_RARP
, 0},
1065 { "mpls", ETH_TYPE_MPLS
, 0 },
1066 { "mplsm", ETH_TYPE_MPLS_MCAST
, 0 },
1068 const struct protocol
*p
;
1070 for (p
= protocols
; p
< &protocols
[ARRAY_SIZE(protocols
)]; p
++) {
1071 if (!strcmp(p
->name
, name
)) {
1080 /* Parses 's' as the (possibly masked) value of field 'mf', and updates
1081 * 'match' appropriately. Restricts the set of usable protocols to ones
1082 * supporting the parsed field.
1084 * Returns NULL if successful, otherwise a malloc()'d string describing the
1085 * error. The caller is responsible for freeing the returned string. */
1086 static char * WARN_UNUSED_RESULT
1087 parse_field(const struct mf_field
*mf
, const char *s
, struct match
*match
,
1088 enum ofputil_protocol
*usable_protocols
)
1090 union mf_value value
, mask
;
1093 error
= mf_parse(mf
, s
, &value
, &mask
);
1095 *usable_protocols
&= mf_set(mf
, &value
, &mask
, match
);
1100 static char * WARN_UNUSED_RESULT
1101 parse_ofp_str__(struct ofputil_flow_mod
*fm
, int command
, char *string
,
1102 enum ofputil_protocol
*usable_protocols
)
1105 F_OUT_PORT
= 1 << 0,
1108 F_PRIORITY
= 1 << 4,
1111 char *save_ptr
= NULL
;
1112 char *act_str
= NULL
;
1115 *usable_protocols
= OFPUTIL_P_ANY
;
1119 fields
= F_OUT_PORT
;
1123 fields
= F_ACTIONS
| F_TIMEOUT
| F_PRIORITY
| F_FLAGS
;
1127 fields
= F_OUT_PORT
;
1130 case OFPFC_DELETE_STRICT
:
1131 fields
= F_OUT_PORT
| F_PRIORITY
;
1135 fields
= F_ACTIONS
| F_TIMEOUT
| F_PRIORITY
| F_FLAGS
;
1138 case OFPFC_MODIFY_STRICT
:
1139 fields
= F_ACTIONS
| F_TIMEOUT
| F_PRIORITY
| F_FLAGS
;
1146 match_init_catchall(&fm
->match
);
1147 fm
->priority
= OFP_DEFAULT_PRIORITY
;
1148 fm
->cookie
= htonll(0);
1149 fm
->cookie_mask
= htonll(0);
1150 if (command
== OFPFC_MODIFY
|| command
== OFPFC_MODIFY_STRICT
) {
1151 /* For modify, by default, don't update the cookie. */
1152 fm
->new_cookie
= OVS_BE64_MAX
;
1154 fm
->new_cookie
= htonll(0);
1156 fm
->modify_cookie
= false;
1157 fm
->table_id
= 0xff;
1158 fm
->command
= command
;
1159 fm
->idle_timeout
= OFP_FLOW_PERMANENT
;
1160 fm
->hard_timeout
= OFP_FLOW_PERMANENT
;
1161 fm
->buffer_id
= UINT32_MAX
;
1162 fm
->out_port
= OFPP_ANY
;
1164 fm
->out_group
= OFPG11_ANY
;
1165 if (fields
& F_ACTIONS
) {
1166 act_str
= strstr(string
, "action");
1168 return xstrdup("must specify an action");
1172 act_str
= strchr(act_str
+ 1, '=');
1174 return xstrdup("must specify an action");
1179 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
1180 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1181 const struct protocol
*p
;
1184 if (parse_protocol(name
, &p
)) {
1185 match_set_dl_type(&fm
->match
, htons(p
->dl_type
));
1187 match_set_nw_proto(&fm
->match
, p
->nw_proto
);
1189 } else if (fields
& F_FLAGS
&& !strcmp(name
, "send_flow_rem")) {
1190 fm
->flags
|= OFPUTIL_FF_SEND_FLOW_REM
;
1191 } else if (fields
& F_FLAGS
&& !strcmp(name
, "check_overlap")) {
1192 fm
->flags
|= OFPUTIL_FF_CHECK_OVERLAP
;
1193 } else if (fields
& F_FLAGS
&& !strcmp(name
, "reset_counts")) {
1194 fm
->flags
|= OFPUTIL_FF_RESET_COUNTS
;
1195 *usable_protocols
&= OFPUTIL_P_OF12_UP
;
1196 } else if (fields
& F_FLAGS
&& !strcmp(name
, "no_packet_counts")) {
1197 fm
->flags
|= OFPUTIL_FF_NO_PKT_COUNTS
;
1198 *usable_protocols
&= OFPUTIL_P_OF13_UP
;
1199 } else if (fields
& F_FLAGS
&& !strcmp(name
, "no_byte_counts")) {
1200 fm
->flags
|= OFPUTIL_FF_NO_BYT_COUNTS
;
1201 *usable_protocols
&= OFPUTIL_P_OF13_UP
;
1205 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1207 return xasprintf("field %s missing value", name
);
1210 if (!strcmp(name
, "table")) {
1211 error
= str_to_u8(value
, "table", &fm
->table_id
);
1212 if (fm
->table_id
!= 0xff) {
1213 *usable_protocols
&= OFPUTIL_P_TID
;
1215 } else if (!strcmp(name
, "out_port")) {
1216 if (!ofputil_port_from_string(value
, &fm
->out_port
)) {
1217 error
= xasprintf("%s is not a valid OpenFlow port",
1220 } else if (fields
& F_PRIORITY
&& !strcmp(name
, "priority")) {
1221 uint16_t priority
= 0;
1223 error
= str_to_u16(value
, name
, &priority
);
1224 fm
->priority
= priority
;
1225 } else if (fields
& F_TIMEOUT
&& !strcmp(name
, "idle_timeout")) {
1226 error
= str_to_u16(value
, name
, &fm
->idle_timeout
);
1227 } else if (fields
& F_TIMEOUT
&& !strcmp(name
, "hard_timeout")) {
1228 error
= str_to_u16(value
, name
, &fm
->hard_timeout
);
1229 } else if (!strcmp(name
, "cookie")) {
1230 char *mask
= strchr(value
, '/');
1233 /* A mask means we're searching for a cookie. */
1234 if (command
== OFPFC_ADD
) {
1235 return xstrdup("flow additions cannot use "
1239 error
= str_to_be64(value
, &fm
->cookie
);
1243 error
= str_to_be64(mask
+ 1, &fm
->cookie_mask
);
1245 /* Matching of the cookie is only supported through NXM or
1247 if (fm
->cookie_mask
!= htonll(0)) {
1248 *usable_protocols
&= OFPUTIL_P_NXM_OF11_UP
;
1251 /* No mask means that the cookie is being set. */
1252 if (command
!= OFPFC_ADD
&& command
!= OFPFC_MODIFY
1253 && command
!= OFPFC_MODIFY_STRICT
) {
1254 return xstrdup("cannot set cookie");
1256 error
= str_to_be64(value
, &fm
->new_cookie
);
1257 fm
->modify_cookie
= true;
1259 } else if (mf_from_name(name
)) {
1260 error
= parse_field(mf_from_name(name
), value
, &fm
->match
,
1262 } else if (!strcmp(name
, "duration")
1263 || !strcmp(name
, "n_packets")
1264 || !strcmp(name
, "n_bytes")
1265 || !strcmp(name
, "idle_age")
1266 || !strcmp(name
, "hard_age")) {
1267 /* Ignore these, so that users can feed the output of
1268 * "ovs-ofctl dump-flows" back into commands that parse
1271 error
= xasprintf("unknown keyword %s", name
);
1279 /* Check for usable protocol interdependencies between match fields. */
1280 if (fm
->match
.flow
.dl_type
== htons(ETH_TYPE_IPV6
)) {
1281 const struct flow_wildcards
*wc
= &fm
->match
.wc
;
1282 /* Only NXM and OXM support matching L3 and L4 fields within IPv6.
1284 * (IPv6 specific fields as well as arp_sha, arp_tha, nw_frag, and
1285 * nw_ttl are covered elsewhere so they don't need to be included in
1288 if (wc
->masks
.nw_proto
|| wc
->masks
.nw_tos
1289 || wc
->masks
.tp_src
|| wc
->masks
.tp_dst
) {
1290 *usable_protocols
&= OFPUTIL_P_NXM_OXM_ANY
;
1293 if (!fm
->cookie_mask
&& fm
->new_cookie
== OVS_BE64_MAX
1294 && (command
== OFPFC_MODIFY
|| command
== OFPFC_MODIFY_STRICT
)) {
1295 /* On modifies without a mask, we are supposed to add a flow if
1296 * one does not exist. If a cookie wasn't been specified, use a
1297 * default of zero. */
1298 fm
->new_cookie
= htonll(0);
1300 if (fields
& F_ACTIONS
) {
1301 struct ofpbuf ofpacts
;
1304 ofpbuf_init(&ofpacts
, 32);
1305 error
= str_to_inst_ofpacts(act_str
, &ofpacts
, usable_protocols
);
1309 err
= ofpacts_check(ofpacts
.data
, ofpacts
.size
, &fm
->match
.flow
,
1312 error
= xasprintf("actions are invalid with specified match "
1313 "(%s)", ofperr_to_string(err
));
1317 ofpbuf_uninit(&ofpacts
);
1321 fm
->ofpacts_len
= ofpacts
.size
;
1322 fm
->ofpacts
= ofpbuf_steal_data(&ofpacts
);
1324 fm
->ofpacts_len
= 0;
1331 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1332 * page) into 'fm' for sending the specified flow_mod 'command' to a switch.
1333 * Returns the set of usable protocols in '*usable_protocols'.
1335 * To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
1336 * constant for 'command'. To parse syntax for an OFPST_FLOW or
1337 * OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'.
1339 * Returns NULL if successful, otherwise a malloc()'d string describing the
1340 * error. The caller is responsible for freeing the returned string. */
1341 char * WARN_UNUSED_RESULT
1342 parse_ofp_str(struct ofputil_flow_mod
*fm
, int command
, const char *str_
,
1343 enum ofputil_protocol
*usable_protocols
)
1345 char *string
= xstrdup(str_
);
1348 error
= parse_ofp_str__(fm
, command
, string
, usable_protocols
);
1351 fm
->ofpacts_len
= 0;
1358 static char * WARN_UNUSED_RESULT
1359 parse_ofp_meter_mod_str__(struct ofputil_meter_mod
*mm
, char *string
,
1360 struct ofpbuf
*bands
, int command
,
1361 enum ofputil_protocol
*usable_protocols
)
1368 char *save_ptr
= NULL
;
1369 char *band_str
= NULL
;
1372 /* Meters require at least OF 1.3. */
1373 *usable_protocols
= OFPUTIL_P_OF13_UP
;
1381 fields
= F_METER
| F_FLAGS
| F_BANDS
;
1384 case OFPMC13_DELETE
:
1388 case OFPMC13_MODIFY
:
1389 fields
= F_METER
| F_FLAGS
| F_BANDS
;
1396 mm
->command
= command
;
1397 mm
->meter
.meter_id
= 0;
1398 mm
->meter
.flags
= 0;
1399 if (fields
& F_BANDS
) {
1400 band_str
= strstr(string
, "band");
1402 return xstrdup("must specify bands");
1406 band_str
= strchr(band_str
+ 1, '=');
1408 return xstrdup("must specify bands");
1413 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
1414 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1416 if (fields
& F_FLAGS
&& !strcmp(name
, "kbps")) {
1417 mm
->meter
.flags
|= OFPMF13_KBPS
;
1418 } else if (fields
& F_FLAGS
&& !strcmp(name
, "pktps")) {
1419 mm
->meter
.flags
|= OFPMF13_PKTPS
;
1420 } else if (fields
& F_FLAGS
&& !strcmp(name
, "burst")) {
1421 mm
->meter
.flags
|= OFPMF13_BURST
;
1422 } else if (fields
& F_FLAGS
&& !strcmp(name
, "stats")) {
1423 mm
->meter
.flags
|= OFPMF13_STATS
;
1427 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1429 return xasprintf("field %s missing value", name
);
1432 if (!strcmp(name
, "meter")) {
1433 if (!strcmp(value
, "all")) {
1434 mm
->meter
.meter_id
= OFPM13_ALL
;
1435 } else if (!strcmp(value
, "controller")) {
1436 mm
->meter
.meter_id
= OFPM13_CONTROLLER
;
1437 } else if (!strcmp(value
, "slowpath")) {
1438 mm
->meter
.meter_id
= OFPM13_SLOWPATH
;
1440 char *error
= str_to_u32(value
, &mm
->meter
.meter_id
);
1444 if (mm
->meter
.meter_id
> OFPM13_MAX
) {
1445 return xasprintf("invalid value for %s", name
);
1449 return xasprintf("unknown keyword %s", name
);
1453 if (fields
& F_METER
&& !mm
->meter
.meter_id
) {
1454 return xstrdup("must specify 'meter'");
1456 if (fields
& F_FLAGS
&& !mm
->meter
.flags
) {
1457 return xstrdup("meter must specify either 'kbps' or 'pktps'");
1460 if (fields
& F_BANDS
) {
1461 uint16_t n_bands
= 0;
1462 struct ofputil_meter_band
*band
= NULL
;
1465 for (name
= strtok_r(band_str
, "=, \t\r\n", &save_ptr
); name
;
1466 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1470 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1472 return xasprintf("field %s missing value", name
);
1475 if (!strcmp(name
, "type")) {
1476 /* Start a new band */
1477 band
= ofpbuf_put_zeros(bands
, sizeof *band
);
1480 if (!strcmp(value
, "drop")) {
1481 band
->type
= OFPMBT13_DROP
;
1482 } else if (!strcmp(value
, "dscp_remark")) {
1483 band
->type
= OFPMBT13_DSCP_REMARK
;
1485 return xasprintf("field %s unknown value %s", name
, value
);
1487 } else if (!band
|| !band
->type
) {
1488 return xstrdup("band must start with the 'type' keyword");
1489 } else if (!strcmp(name
, "rate")) {
1490 char *error
= str_to_u32(value
, &band
->rate
);
1494 } else if (!strcmp(name
, "burst_size")) {
1495 char *error
= str_to_u32(value
, &band
->burst_size
);
1499 } else if (!strcmp(name
, "prec_level")) {
1500 char *error
= str_to_u8(value
, name
, &band
->prec_level
);
1505 return xasprintf("unknown keyword %s", name
);
1508 /* validate bands */
1510 return xstrdup("meter must have bands");
1513 mm
->meter
.n_bands
= n_bands
;
1514 mm
->meter
.bands
= ofpbuf_steal_data(bands
);
1516 for (i
= 0; i
< n_bands
; ++i
) {
1517 band
= &mm
->meter
.bands
[i
];
1520 return xstrdup("band must have 'type'");
1522 if (band
->type
== OFPMBT13_DSCP_REMARK
) {
1523 if (!band
->prec_level
) {
1524 return xstrdup("'dscp_remark' band must have"
1528 if (band
->prec_level
) {
1529 return xstrdup("Only 'dscp_remark' band may have"
1534 return xstrdup("band must have 'rate'");
1536 if (mm
->meter
.flags
& OFPMF13_BURST
) {
1537 if (!band
->burst_size
) {
1538 return xstrdup("band must have 'burst_size' "
1539 "when 'burst' flag is set");
1542 if (band
->burst_size
) {
1543 return xstrdup("band may have 'burst_size' only "
1544 "when 'burst' flag is set");
1549 mm
->meter
.n_bands
= 0;
1550 mm
->meter
.bands
= NULL
;
1556 /* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1557 * page) into 'mm' for sending the specified meter_mod 'command' to a switch.
1559 * Returns NULL if successful, otherwise a malloc()'d string describing the
1560 * error. The caller is responsible for freeing the returned string. */
1561 char * WARN_UNUSED_RESULT
1562 parse_ofp_meter_mod_str(struct ofputil_meter_mod
*mm
, const char *str_
,
1563 int command
, enum ofputil_protocol
*usable_protocols
)
1565 struct ofpbuf bands
;
1569 ofpbuf_init(&bands
, 64);
1570 string
= xstrdup(str_
);
1572 error
= parse_ofp_meter_mod_str__(mm
, string
, &bands
, command
,
1576 ofpbuf_uninit(&bands
);
1581 static char * WARN_UNUSED_RESULT
1582 parse_flow_monitor_request__(struct ofputil_flow_monitor_request
*fmr
,
1583 const char *str_
, char *string
,
1584 enum ofputil_protocol
*usable_protocols
)
1586 static atomic_uint32_t id
= ATOMIC_VAR_INIT(0);
1587 char *save_ptr
= NULL
;
1590 atomic_add(&id
, 1, &fmr
->id
);
1592 fmr
->flags
= (NXFMF_INITIAL
| NXFMF_ADD
| NXFMF_DELETE
| NXFMF_MODIFY
1593 | NXFMF_OWN
| NXFMF_ACTIONS
);
1594 fmr
->out_port
= OFPP_NONE
;
1595 fmr
->table_id
= 0xff;
1596 match_init_catchall(&fmr
->match
);
1598 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
1599 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
1600 const struct protocol
*p
;
1602 if (!strcmp(name
, "!initial")) {
1603 fmr
->flags
&= ~NXFMF_INITIAL
;
1604 } else if (!strcmp(name
, "!add")) {
1605 fmr
->flags
&= ~NXFMF_ADD
;
1606 } else if (!strcmp(name
, "!delete")) {
1607 fmr
->flags
&= ~NXFMF_DELETE
;
1608 } else if (!strcmp(name
, "!modify")) {
1609 fmr
->flags
&= ~NXFMF_MODIFY
;
1610 } else if (!strcmp(name
, "!actions")) {
1611 fmr
->flags
&= ~NXFMF_ACTIONS
;
1612 } else if (!strcmp(name
, "!own")) {
1613 fmr
->flags
&= ~NXFMF_OWN
;
1614 } else if (parse_protocol(name
, &p
)) {
1615 match_set_dl_type(&fmr
->match
, htons(p
->dl_type
));
1617 match_set_nw_proto(&fmr
->match
, p
->nw_proto
);
1622 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
1624 return xasprintf("%s: field %s missing value", str_
, name
);
1627 if (!strcmp(name
, "table")) {
1628 char *error
= str_to_u8(value
, "table", &fmr
->table_id
);
1632 } else if (!strcmp(name
, "out_port")) {
1633 fmr
->out_port
= u16_to_ofp(atoi(value
));
1634 } else if (mf_from_name(name
)) {
1637 error
= parse_field(mf_from_name(name
), value
, &fmr
->match
,
1643 return xasprintf("%s: unknown keyword %s", str_
, name
);
1650 /* Convert 'str_' (as described in the documentation for the "monitor" command
1651 * in the ovs-ofctl man page) into 'fmr'.
1653 * Returns NULL if successful, otherwise a malloc()'d string describing the
1654 * error. The caller is responsible for freeing the returned string. */
1655 char * WARN_UNUSED_RESULT
1656 parse_flow_monitor_request(struct ofputil_flow_monitor_request
*fmr
,
1658 enum ofputil_protocol
*usable_protocols
)
1660 char *string
= xstrdup(str_
);
1661 char *error
= parse_flow_monitor_request__(fmr
, str_
, string
,
1667 /* Parses 's' as a set of OpenFlow actions and appends the actions to
1670 * Returns NULL if successful, otherwise a malloc()'d string describing the
1671 * error. The caller is responsible for freeing the returned string. */
1672 char * WARN_UNUSED_RESULT
1673 parse_ofpacts(const char *s_
, struct ofpbuf
*ofpacts
,
1674 enum ofputil_protocol
*usable_protocols
)
1676 char *s
= xstrdup(s_
);
1679 *usable_protocols
= OFPUTIL_P_ANY
;
1681 error
= str_to_ofpacts(s
, ofpacts
, usable_protocols
);
1687 /* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1688 * (one of OFPFC_*) into 'fm'.
1690 * Returns NULL if successful, otherwise a malloc()'d string describing the
1691 * error. The caller is responsible for freeing the returned string. */
1692 char * WARN_UNUSED_RESULT
1693 parse_ofp_flow_mod_str(struct ofputil_flow_mod
*fm
, const char *string
,
1695 enum ofputil_protocol
*usable_protocols
)
1697 char *error
= parse_ofp_str(fm
, command
, string
, usable_protocols
);
1699 /* Normalize a copy of the match. This ensures that non-normalized
1700 * flows get logged but doesn't affect what gets sent to the switch, so
1701 * that the switch can do whatever it likes with the flow. */
1702 struct match match_copy
= fm
->match
;
1703 ofputil_normalize_match(&match_copy
);
1709 /* Convert 'table_id' and 'flow_miss_handling' (as described for the
1710 * "mod-table" command in the ovs-ofctl man page) into 'tm' for sending the
1711 * specified table_mod 'command' to a switch.
1713 * Returns NULL if successful, otherwise a malloc()'d string describing the
1714 * error. The caller is responsible for freeing the returned string. */
1715 char * WARN_UNUSED_RESULT
1716 parse_ofp_table_mod(struct ofputil_table_mod
*tm
, const char *table_id
,
1717 const char *flow_miss_handling
,
1718 enum ofputil_protocol
*usable_protocols
)
1720 /* Table mod requires at least OF 1.1. */
1721 *usable_protocols
= OFPUTIL_P_OF11_UP
;
1723 if (!strcasecmp(table_id
, "all")) {
1726 char *error
= str_to_u8(table_id
, "table_id", &tm
->table_id
);
1732 if (strcmp(flow_miss_handling
, "controller") == 0) {
1733 tm
->config
= OFPTC11_TABLE_MISS_CONTROLLER
;
1734 } else if (strcmp(flow_miss_handling
, "continue") == 0) {
1735 tm
->config
= OFPTC11_TABLE_MISS_CONTINUE
;
1736 } else if (strcmp(flow_miss_handling
, "drop") == 0) {
1737 tm
->config
= OFPTC11_TABLE_MISS_DROP
;
1739 return xasprintf("invalid flow_miss_handling %s", flow_miss_handling
);
1742 if (tm
->table_id
== 0xfe && tm
->config
== OFPTC11_TABLE_MISS_CONTINUE
) {
1743 return xstrdup("last table's flow miss handling can not be continue");
1750 /* Opens file 'file_name' and reads each line as a flow_mod of the specified
1751 * type (one of OFPFC_*). Stores each flow_mod in '*fm', an array allocated
1752 * on the caller's behalf, and the number of flow_mods in '*n_fms'.
1754 * Returns NULL if successful, otherwise a malloc()'d string describing the
1755 * error. The caller is responsible for freeing the returned string. */
1756 char * WARN_UNUSED_RESULT
1757 parse_ofp_flow_mod_file(const char *file_name
, uint16_t command
,
1758 struct ofputil_flow_mod
**fms
, size_t *n_fms
,
1759 enum ofputil_protocol
*usable_protocols
)
1761 size_t allocated_fms
;
1766 *usable_protocols
= OFPUTIL_P_ANY
;
1771 stream
= !strcmp(file_name
, "-") ? stdin
: fopen(file_name
, "r");
1772 if (stream
== NULL
) {
1773 return xasprintf("%s: open failed (%s)",
1774 file_name
, ovs_strerror(errno
));
1777 allocated_fms
= *n_fms
;
1780 while (!ds_get_preprocessed_line(&s
, stream
, &line_number
)) {
1782 enum ofputil_protocol usable
;
1784 if (*n_fms
>= allocated_fms
) {
1785 *fms
= x2nrealloc(*fms
, &allocated_fms
, sizeof **fms
);
1787 error
= parse_ofp_flow_mod_str(&(*fms
)[*n_fms
], ds_cstr(&s
), command
,
1792 for (i
= 0; i
< *n_fms
; i
++) {
1793 free((*fms
)[i
].ofpacts
);
1800 if (stream
!= stdin
) {
1804 return xasprintf("%s:%d: %s", file_name
, line_number
, error
);
1806 *usable_protocols
&= usable
; /* Each line can narrow the set. */
1811 if (stream
!= stdin
) {
1817 char * WARN_UNUSED_RESULT
1818 parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request
*fsr
,
1819 bool aggregate
, const char *string
,
1820 enum ofputil_protocol
*usable_protocols
)
1822 struct ofputil_flow_mod fm
;
1825 error
= parse_ofp_str(&fm
, -1, string
, usable_protocols
);
1830 /* Special table ID support not required for stats requests. */
1831 if (*usable_protocols
& OFPUTIL_P_OF10_STD_TID
) {
1832 *usable_protocols
|= OFPUTIL_P_OF10_STD
;
1834 if (*usable_protocols
& OFPUTIL_P_OF10_NXM_TID
) {
1835 *usable_protocols
|= OFPUTIL_P_OF10_NXM
;
1838 fsr
->aggregate
= aggregate
;
1839 fsr
->cookie
= fm
.cookie
;
1840 fsr
->cookie_mask
= fm
.cookie_mask
;
1841 fsr
->match
= fm
.match
;
1842 fsr
->out_port
= fm
.out_port
;
1843 fsr
->out_group
= fm
.out_group
;
1844 fsr
->table_id
= fm
.table_id
;
1848 /* Parses a specification of a flow from 's' into 'flow'. 's' must take the
1849 * form FIELD=VALUE[,FIELD=VALUE]... where each FIELD is the name of a
1850 * mf_field. Fields must be specified in a natural order for satisfying
1853 * Returns NULL on success, otherwise a malloc()'d string that explains the
1856 parse_ofp_exact_flow(struct flow
*flow
, const char *s
)
1858 char *pos
, *key
, *value_s
;
1862 memset(flow
, 0, sizeof *flow
);
1864 pos
= copy
= xstrdup(s
);
1865 while (ofputil_parse_key_value(&pos
, &key
, &value_s
)) {
1866 const struct protocol
*p
;
1867 if (parse_protocol(key
, &p
)) {
1868 if (flow
->dl_type
) {
1869 error
= xasprintf("%s: Ethernet type set multiple times", s
);
1872 flow
->dl_type
= htons(p
->dl_type
);
1875 if (flow
->nw_proto
) {
1876 error
= xasprintf("%s: network protocol set "
1877 "multiple times", s
);
1880 flow
->nw_proto
= p
->nw_proto
;
1883 const struct mf_field
*mf
;
1884 union mf_value value
;
1887 mf
= mf_from_name(key
);
1889 error
= xasprintf("%s: unknown field %s", s
, key
);
1893 if (!mf_are_prereqs_ok(mf
, flow
)) {
1894 error
= xasprintf("%s: prerequisites not met for setting %s",
1899 if (!mf_is_zero(mf
, flow
)) {
1900 error
= xasprintf("%s: field %s set multiple times", s
, key
);
1904 field_error
= mf_parse_value(mf
, value_s
, &value
);
1906 error
= xasprintf("%s: bad value for %s (%s)",
1907 s
, key
, field_error
);
1912 mf_set_flow_value(mf
, &value
, flow
);
1916 if (!flow
->in_port
.ofp_port
) {
1917 flow
->in_port
.ofp_port
= OFPP_NONE
;
1924 memset(flow
, 0, sizeof *flow
);
1929 static char * WARN_UNUSED_RESULT
1930 parse_bucket_str(struct ofputil_bucket
*bucket
, char *str_
,
1931 enum ofputil_protocol
*usable_protocols
)
1933 struct ofpbuf ofpacts
;
1934 char *pos
, *act
, *arg
;
1938 bucket
->watch_port
= OFPP_ANY
;
1939 bucket
->watch_group
= OFPG11_ANY
;
1943 ofpbuf_init(&ofpacts
, 64);
1944 while (ofputil_parse_key_value(&pos
, &act
, &arg
)) {
1947 if (!strcasecmp(act
, "weight")) {
1948 error
= str_to_u16(arg
, "weight", &bucket
->weight
);
1949 } else if (!strcasecmp(act
, "watch_port")) {
1950 if (!ofputil_port_from_string(arg
, &bucket
->watch_port
)
1951 || (ofp_to_u16(bucket
->watch_port
) >= ofp_to_u16(OFPP_MAX
)
1952 && bucket
->watch_port
!= OFPP_ANY
)) {
1953 error
= xasprintf("%s: invalid watch_port", arg
);
1955 } else if (!strcasecmp(act
, "watch_group")) {
1956 error
= str_to_u32(arg
, &bucket
->watch_group
);
1957 if (!error
&& bucket
->watch_group
> OFPG_MAX
) {
1958 error
= xasprintf("invalid watch_group id %"PRIu32
,
1959 bucket
->watch_group
);
1962 error
= str_to_ofpact__(pos
, act
, arg
, &ofpacts
, n_actions
,
1968 ofpbuf_uninit(&ofpacts
);
1973 ofpact_pad(&ofpacts
);
1974 bucket
->ofpacts
= ofpacts
.data
;
1975 bucket
->ofpacts_len
= ofpacts
.size
;
1980 static char * WARN_UNUSED_RESULT
1981 parse_ofp_group_mod_str__(struct ofputil_group_mod
*gm
, uint16_t command
,
1983 enum ofputil_protocol
*usable_protocols
)
1986 F_GROUP_TYPE
= 1 << 0,
1989 char *save_ptr
= NULL
;
1990 bool had_type
= false;
1992 struct ofputil_bucket
*bucket
;
1995 *usable_protocols
= OFPUTIL_P_OF11_UP
;
1999 fields
= F_GROUP_TYPE
| F_BUCKETS
;
2002 case OFPGC11_DELETE
:
2006 case OFPGC11_MODIFY
:
2007 fields
= F_GROUP_TYPE
| F_BUCKETS
;
2014 memset(gm
, 0, sizeof *gm
);
2015 gm
->command
= command
;
2016 gm
->group_id
= OFPG_ANY
;
2017 list_init(&gm
->buckets
);
2018 if (command
== OFPGC11_DELETE
&& string
[0] == '\0') {
2019 gm
->group_id
= OFPG_ALL
;
2023 *usable_protocols
= OFPUTIL_P_OF11_UP
;
2025 if (fields
& F_BUCKETS
) {
2026 char *bkt_str
= strstr(string
, "bucket");
2035 bkt_str
= strchr(bkt_str
+ 1, '=');
2037 error
= xstrdup("must specify bucket content");
2042 next_bkt_str
= strstr(bkt_str
, "bucket");
2044 *next_bkt_str
= '\0';
2047 bucket
= xzalloc(sizeof(struct ofputil_bucket
));
2048 error
= parse_bucket_str(bucket
, bkt_str
, usable_protocols
);
2053 list_push_back(&gm
->buckets
, &bucket
->list_node
);
2055 bkt_str
= next_bkt_str
;
2059 for (name
= strtok_r(string
, "=, \t\r\n", &save_ptr
); name
;
2060 name
= strtok_r(NULL
, "=, \t\r\n", &save_ptr
)) {
2063 value
= strtok_r(NULL
, ", \t\r\n", &save_ptr
);
2065 error
= xasprintf("field %s missing value", name
);
2069 if (!strcmp(name
, "group_id")) {
2070 if(!strcmp(value
, "all")) {
2071 gm
->group_id
= OFPG_ALL
;
2073 char *error
= str_to_u32(value
, &gm
->group_id
);
2077 if (gm
->group_id
!= OFPG_ALL
&& gm
->group_id
> OFPG_MAX
) {
2078 error
= xasprintf("invalid group id %"PRIu32
,
2083 } else if (!strcmp(name
, "type")){
2084 if (!(fields
& F_GROUP_TYPE
)) {
2085 error
= xstrdup("type is not needed");
2088 if (!strcmp(value
, "all")) {
2089 gm
->type
= OFPGT11_ALL
;
2090 } else if (!strcmp(value
, "select")) {
2091 gm
->type
= OFPGT11_SELECT
;
2092 } else if (!strcmp(value
, "indirect")) {
2093 gm
->type
= OFPGT11_INDIRECT
;
2094 } else if (!strcmp(value
, "ff") ||
2095 !strcmp(value
, "fast_failover")) {
2096 gm
->type
= OFPGT11_FF
;
2098 error
= xasprintf("invalid group type %s", value
);
2102 } else if (!strcmp(name
, "bucket")) {
2103 error
= xstrdup("bucket is not needed");
2106 error
= xasprintf("unknown keyword %s", name
);
2110 if (gm
->group_id
== OFPG_ANY
) {
2111 error
= xstrdup("must specify a group_id");
2114 if (fields
& F_GROUP_TYPE
&& !had_type
) {
2115 error
= xstrdup("must specify a type");
2119 /* Validate buckets. */
2120 LIST_FOR_EACH (bucket
, list_node
, &gm
->buckets
) {
2121 if (bucket
->weight
!= 1 && gm
->type
!= OFPGT11_SELECT
) {
2122 error
= xstrdup("Only select groups can have bucket weights.");
2126 if (gm
->type
== OFPGT11_INDIRECT
&& !list_is_short(&gm
->buckets
)) {
2127 error
= xstrdup("Indirect groups can have at most one bucket.");
2133 ofputil_bucket_list_destroy(&gm
->buckets
);
2137 char * WARN_UNUSED_RESULT
2138 parse_ofp_group_mod_str(struct ofputil_group_mod
*gm
, uint16_t command
,
2140 enum ofputil_protocol
*usable_protocols
)
2142 char *string
= xstrdup(str_
);
2143 char *error
= parse_ofp_group_mod_str__(gm
, command
, string
,
2148 ofputil_bucket_list_destroy(&gm
->buckets
);
2153 char * WARN_UNUSED_RESULT
2154 parse_ofp_group_mod_file(const char *file_name
, uint16_t command
,
2155 struct ofputil_group_mod
**gms
, size_t *n_gms
,
2156 enum ofputil_protocol
*usable_protocols
)
2158 size_t allocated_gms
;
2166 stream
= !strcmp(file_name
, "-") ? stdin
: fopen(file_name
, "r");
2167 if (stream
== NULL
) {
2168 return xasprintf("%s: open failed (%s)",
2169 file_name
, ovs_strerror(errno
));
2172 allocated_gms
= *n_gms
;
2175 *usable_protocols
= OFPUTIL_P_OF11_UP
;
2176 while (!ds_get_preprocessed_line(&s
, stream
, &line_number
)) {
2177 enum ofputil_protocol usable
;
2180 if (*n_gms
>= allocated_gms
) {
2181 *gms
= x2nrealloc(*gms
, &allocated_gms
, sizeof **gms
);
2183 error
= parse_ofp_group_mod_str(&(*gms
)[*n_gms
], command
, ds_cstr(&s
),
2188 for (i
= 0; i
< *n_gms
; i
++) {
2189 ofputil_bucket_list_destroy(&(*gms
)[i
].buckets
);
2196 if (stream
!= stdin
) {
2200 return xasprintf("%s:%d: %s", file_name
, line_number
, error
);
2202 *usable_protocols
&= usable
;
2207 if (stream
!= stdin
) {