2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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.
18 #include "ofp-actions.h"
20 #include "byte-order.h"
22 #include "dynamic-string.h"
24 #include "meta-flow.h"
25 #include "multipath.h"
32 VLOG_DEFINE_THIS_MODULE(ofp_actions
);
34 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
36 /* Converting OpenFlow 1.0 to ofpacts. */
40 struct ofp_action_header header
;
41 struct ofp_action_vendor_header vendor
;
42 struct ofp10_action_output output10
;
43 struct ofp_action_vlan_vid vlan_vid
;
44 struct ofp_action_vlan_pcp vlan_pcp
;
45 struct ofp_action_nw_addr nw_addr
;
46 struct ofp_action_nw_tos nw_tos
;
47 struct ofp11_action_nw_ecn nw_ecn
;
48 struct ofp11_action_nw_ttl nw_ttl
;
49 struct ofp_action_tp_port tp_port
;
50 struct ofp_action_dl_addr dl_addr
;
51 struct ofp10_action_enqueue enqueue
;
52 struct ofp11_action_output ofp11_output
;
53 struct ofp11_action_push push
;
54 struct ofp11_action_pop_mpls ofp11_pop_mpls
;
55 struct ofp11_action_set_queue ofp11_set_queue
;
56 struct ofp11_action_mpls_label ofp11_mpls_label
;
57 struct ofp11_action_mpls_tc ofp11_mpls_tc
;
58 struct ofp11_action_mpls_ttl ofp11_mpls_ttl
;
59 struct ofp11_action_group group
;
60 struct ofp12_action_set_field set_field
;
61 struct nx_action_header nxa_header
;
62 struct nx_action_resubmit resubmit
;
63 struct nx_action_set_tunnel set_tunnel
;
64 struct nx_action_set_tunnel64 set_tunnel64
;
65 struct nx_action_write_metadata write_metadata
;
66 struct nx_action_set_queue set_queue
;
67 struct nx_action_reg_move reg_move
;
68 struct nx_action_reg_load reg_load
;
69 struct nx_action_stack stack
;
70 struct nx_action_note note
;
71 struct nx_action_multipath multipath
;
72 struct nx_action_bundle bundle
;
73 struct nx_action_output_reg output_reg
;
74 struct nx_action_cnt_ids cnt_ids
;
75 struct nx_action_fin_timeout fin_timeout
;
76 struct nx_action_controller controller
;
77 struct nx_action_push_mpls push_mpls
;
78 struct nx_action_mpls_ttl mpls_ttl
;
79 struct nx_action_pop_mpls pop_mpls
;
80 struct nx_action_sample sample
;
81 struct nx_action_learn learn
;
82 struct nx_action_mpls_label mpls_label
;
83 struct nx_action_mpls_tc mpls_tc
;
87 output_from_openflow10(const struct ofp10_action_output
*oao
,
90 struct ofpact_output
*output
;
92 output
= ofpact_put_OUTPUT(out
);
93 output
->port
= u16_to_ofp(ntohs(oao
->port
));
94 output
->max_len
= ntohs(oao
->max_len
);
96 return ofpact_check_output_port(output
->port
, OFPP_MAX
);
100 enqueue_from_openflow10(const struct ofp10_action_enqueue
*oae
,
103 struct ofpact_enqueue
*enqueue
;
105 enqueue
= ofpact_put_ENQUEUE(out
);
106 enqueue
->port
= u16_to_ofp(ntohs(oae
->port
));
107 enqueue
->queue
= ntohl(oae
->queue_id
);
108 if (ofp_to_u16(enqueue
->port
) >= ofp_to_u16(OFPP_MAX
)
109 && enqueue
->port
!= OFPP_IN_PORT
110 && enqueue
->port
!= OFPP_LOCAL
) {
111 return OFPERR_OFPBAC_BAD_OUT_PORT
;
117 resubmit_from_openflow(const struct nx_action_resubmit
*nar
,
120 struct ofpact_resubmit
*resubmit
;
122 resubmit
= ofpact_put_RESUBMIT(out
);
123 resubmit
->ofpact
.compat
= OFPUTIL_NXAST_RESUBMIT
;
124 resubmit
->in_port
= u16_to_ofp(ntohs(nar
->in_port
));
125 resubmit
->table_id
= 0xff;
129 resubmit_table_from_openflow(const struct nx_action_resubmit
*nar
,
132 struct ofpact_resubmit
*resubmit
;
134 if (nar
->pad
[0] || nar
->pad
[1] || nar
->pad
[2]) {
135 return OFPERR_OFPBAC_BAD_ARGUMENT
;
138 resubmit
= ofpact_put_RESUBMIT(out
);
139 resubmit
->ofpact
.compat
= OFPUTIL_NXAST_RESUBMIT_TABLE
;
140 resubmit
->in_port
= u16_to_ofp(ntohs(nar
->in_port
));
141 resubmit
->table_id
= nar
->table
;
146 output_reg_from_openflow(const struct nx_action_output_reg
*naor
,
149 struct ofpact_output_reg
*output_reg
;
151 if (!is_all_zeros(naor
->zero
, sizeof naor
->zero
)) {
152 return OFPERR_OFPBAC_BAD_ARGUMENT
;
155 output_reg
= ofpact_put_OUTPUT_REG(out
);
156 output_reg
->src
.field
= mf_from_nxm_header(ntohl(naor
->src
));
157 output_reg
->src
.ofs
= nxm_decode_ofs(naor
->ofs_nbits
);
158 output_reg
->src
.n_bits
= nxm_decode_n_bits(naor
->ofs_nbits
);
159 output_reg
->max_len
= ntohs(naor
->max_len
);
161 return mf_check_src(&output_reg
->src
, NULL
);
165 fin_timeout_from_openflow(const struct nx_action_fin_timeout
*naft
,
168 struct ofpact_fin_timeout
*oft
;
170 oft
= ofpact_put_FIN_TIMEOUT(out
);
171 oft
->fin_idle_timeout
= ntohs(naft
->fin_idle_timeout
);
172 oft
->fin_hard_timeout
= ntohs(naft
->fin_hard_timeout
);
176 controller_from_openflow(const struct nx_action_controller
*nac
,
179 struct ofpact_controller
*oc
;
181 oc
= ofpact_put_CONTROLLER(out
);
182 oc
->max_len
= ntohs(nac
->max_len
);
183 oc
->controller_id
= ntohs(nac
->controller_id
);
184 oc
->reason
= nac
->reason
;
188 metadata_from_nxast(const struct nx_action_write_metadata
*nawm
,
191 struct ofpact_metadata
*om
;
193 if (!is_all_zeros(nawm
->zeros
, sizeof nawm
->zeros
)) {
194 return OFPERR_NXBRC_MUST_BE_ZERO
;
197 om
= ofpact_put_WRITE_METADATA(out
);
198 om
->metadata
= nawm
->metadata
;
199 om
->mask
= nawm
->mask
;
205 note_from_openflow(const struct nx_action_note
*nan
, struct ofpbuf
*out
)
207 struct ofpact_note
*note
;
210 length
= ntohs(nan
->len
) - offsetof(struct nx_action_note
, note
);
211 note
= ofpact_put(out
, OFPACT_NOTE
,
212 offsetof(struct ofpact_note
, data
) + length
);
213 note
->length
= length
;
214 memcpy(note
->data
, nan
->note
, length
);
218 dec_ttl_from_openflow(struct ofpbuf
*out
, enum ofputil_action_code compat
)
221 struct ofpact_cnt_ids
*ids
;
222 enum ofperr error
= 0;
224 ids
= ofpact_put_DEC_TTL(out
);
225 ids
->ofpact
.compat
= compat
;
226 ids
->n_controllers
= 1;
227 ofpbuf_put(out
, &id
, sizeof id
);
229 ofpact_update_len(out
, &ids
->ofpact
);
234 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids
*nac_ids
,
237 struct ofpact_cnt_ids
*ids
;
241 ids
= ofpact_put_DEC_TTL(out
);
242 ids
->ofpact
.compat
= OFPUTIL_NXAST_DEC_TTL_CNT_IDS
;
243 ids
->n_controllers
= ntohs(nac_ids
->n_controllers
);
244 ids_size
= ntohs(nac_ids
->len
) - sizeof *nac_ids
;
246 if (!is_all_zeros(nac_ids
->zeros
, sizeof nac_ids
->zeros
)) {
247 return OFPERR_NXBRC_MUST_BE_ZERO
;
250 if (ids_size
< ids
->n_controllers
* sizeof(ovs_be16
)) {
251 VLOG_WARN_RL(&rl
, "Nicira action dec_ttl_cnt_ids only has %"PRIuSIZE
" bytes "
252 "allocated for controller ids. %"PRIuSIZE
" bytes are required for "
253 "%"PRIu16
" controllers.", ids_size
,
254 ids
->n_controllers
* sizeof(ovs_be16
), ids
->n_controllers
);
255 return OFPERR_OFPBAC_BAD_LEN
;
258 for (i
= 0; i
< ids
->n_controllers
; i
++) {
259 uint16_t id
= ntohs(((ovs_be16
*)(nac_ids
+ 1))[i
]);
260 ofpbuf_put(out
, &id
, sizeof id
);
264 ofpact_update_len(out
, &ids
->ofpact
);
270 sample_from_openflow(const struct nx_action_sample
*nas
,
273 struct ofpact_sample
*sample
;
275 sample
= ofpact_put_SAMPLE(out
);
276 sample
->probability
= ntohs(nas
->probability
);
277 sample
->collector_set_id
= ntohl(nas
->collector_set_id
);
278 sample
->obs_domain_id
= ntohl(nas
->obs_domain_id
);
279 sample
->obs_point_id
= ntohl(nas
->obs_point_id
);
281 if (sample
->probability
== 0) {
282 return OFPERR_OFPBAC_BAD_ARGUMENT
;
289 push_mpls_from_openflow(ovs_be16 ethertype
, struct ofpbuf
*out
)
291 struct ofpact_push_mpls
*oam
;
293 if (!eth_type_mpls(ethertype
)) {
294 return OFPERR_OFPBAC_BAD_ARGUMENT
;
296 oam
= ofpact_put_PUSH_MPLS(out
);
297 oam
->ethertype
= ethertype
;
303 decode_nxast_action(const union ofp_action
*a
, enum ofputil_action_code
*code
)
305 const struct nx_action_header
*nah
= &a
->nxa_header
;
306 uint16_t len
= ntohs(a
->header
.len
);
308 if (len
< sizeof(struct nx_action_header
)) {
309 return OFPERR_OFPBAC_BAD_LEN
;
310 } else if (a
->vendor
.vendor
!= CONSTANT_HTONL(NX_VENDOR_ID
)) {
311 return OFPERR_OFPBAC_BAD_VENDOR
;
314 switch (nah
->subtype
) {
315 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
316 case CONSTANT_HTONS(ENUM): \
318 ? len >= sizeof(struct STRUCT) \
319 : len == sizeof(struct STRUCT)) { \
320 *code = OFPUTIL_##ENUM; \
323 return OFPERR_OFPBAC_BAD_LEN; \
326 #include "ofp-util.def"
328 case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE
):
329 case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE
):
331 return OFPERR_OFPBAC_BAD_TYPE
;
335 /* Parses 'a' to determine its type. On success stores the correct type into
336 * '*code' and returns 0. On failure returns an OFPERR_* error code and
337 * '*code' is indeterminate.
339 * The caller must have already verified that 'a''s length is potentially
340 * correct (that is, a->header.len is nonzero and a multiple of
341 * OFP_ACTION_ALIGN and no longer than the amount of space allocated to 'a').
343 * This function verifies that 'a''s length is correct for the type of action
344 * that it represents. */
346 decode_openflow10_action(const union ofp_action
*a
,
347 enum ofputil_action_code
*code
)
350 case CONSTANT_HTONS(OFPAT10_VENDOR
):
351 return decode_nxast_action(a
, code
);
353 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
354 case CONSTANT_HTONS(ENUM): \
355 if (a->header.len == htons(sizeof(struct STRUCT))) { \
356 *code = OFPUTIL_##ENUM; \
359 return OFPERR_OFPBAC_BAD_LEN; \
362 #include "ofp-util.def"
365 return OFPERR_OFPBAC_BAD_TYPE
;
370 ofpact_from_nxast(const union ofp_action
*a
, enum ofputil_action_code code
,
373 struct ofpact_tunnel
*tunnel
;
374 enum ofperr error
= 0;
377 case OFPUTIL_ACTION_INVALID
:
378 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
379 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
380 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
381 #include "ofp-util.def"
384 case OFPUTIL_NXAST_RESUBMIT
:
385 resubmit_from_openflow(&a
->resubmit
, out
);
388 case OFPUTIL_NXAST_SET_TUNNEL
:
389 tunnel
= ofpact_put_SET_TUNNEL(out
);
390 tunnel
->ofpact
.compat
= code
;
391 tunnel
->tun_id
= ntohl(a
->set_tunnel
.tun_id
);
394 case OFPUTIL_NXAST_WRITE_METADATA
:
395 error
= metadata_from_nxast(&a
->write_metadata
, out
);
398 case OFPUTIL_NXAST_SET_QUEUE
:
399 ofpact_put_SET_QUEUE(out
)->queue_id
= ntohl(a
->set_queue
.queue_id
);
402 case OFPUTIL_NXAST_POP_QUEUE
:
403 ofpact_put_POP_QUEUE(out
);
406 case OFPUTIL_NXAST_REG_MOVE
:
407 error
= nxm_reg_move_from_openflow(&a
->reg_move
, out
);
410 case OFPUTIL_NXAST_REG_LOAD
:
411 error
= nxm_reg_load_from_openflow(&a
->reg_load
, out
);
414 case OFPUTIL_NXAST_STACK_PUSH
:
415 error
= nxm_stack_push_from_openflow(&a
->stack
, out
);
418 case OFPUTIL_NXAST_STACK_POP
:
419 error
= nxm_stack_pop_from_openflow(&a
->stack
, out
);
422 case OFPUTIL_NXAST_NOTE
:
423 note_from_openflow(&a
->note
, out
);
426 case OFPUTIL_NXAST_SET_TUNNEL64
:
427 tunnel
= ofpact_put_SET_TUNNEL(out
);
428 tunnel
->ofpact
.compat
= code
;
429 tunnel
->tun_id
= ntohll(a
->set_tunnel64
.tun_id
);
432 case OFPUTIL_NXAST_MULTIPATH
:
433 error
= multipath_from_openflow(&a
->multipath
,
434 ofpact_put_MULTIPATH(out
));
437 case OFPUTIL_NXAST_BUNDLE
:
438 case OFPUTIL_NXAST_BUNDLE_LOAD
:
439 error
= bundle_from_openflow(&a
->bundle
, out
);
442 case OFPUTIL_NXAST_OUTPUT_REG
:
443 error
= output_reg_from_openflow(&a
->output_reg
, out
);
446 case OFPUTIL_NXAST_RESUBMIT_TABLE
:
447 error
= resubmit_table_from_openflow(&a
->resubmit
, out
);
450 case OFPUTIL_NXAST_LEARN
:
451 error
= learn_from_openflow(&a
->learn
, out
);
454 case OFPUTIL_NXAST_EXIT
:
455 ofpact_put_EXIT(out
);
458 case OFPUTIL_NXAST_DEC_TTL
:
459 error
= dec_ttl_from_openflow(out
, code
);
462 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS
:
463 error
= dec_ttl_cnt_ids_from_openflow(&a
->cnt_ids
, out
);
466 case OFPUTIL_NXAST_FIN_TIMEOUT
:
467 fin_timeout_from_openflow(&a
->fin_timeout
, out
);
470 case OFPUTIL_NXAST_CONTROLLER
:
471 controller_from_openflow(&a
->controller
, out
);
474 case OFPUTIL_NXAST_PUSH_MPLS
:
475 error
= push_mpls_from_openflow(a
->push_mpls
.ethertype
, out
);
478 case OFPUTIL_NXAST_SET_MPLS_LABEL
:
479 ofpact_put_SET_MPLS_LABEL(out
)->label
= a
->mpls_label
.label
;
482 case OFPUTIL_NXAST_SET_MPLS_TC
:
483 ofpact_put_SET_MPLS_TC(out
)->tc
= a
->mpls_tc
.tc
;
486 case OFPUTIL_NXAST_SET_MPLS_TTL
:
487 ofpact_put_SET_MPLS_TTL(out
)->ttl
= a
->mpls_ttl
.ttl
;
490 case OFPUTIL_NXAST_DEC_MPLS_TTL
:
491 ofpact_put_DEC_MPLS_TTL(out
);
494 case OFPUTIL_NXAST_POP_MPLS
:
495 if (eth_type_mpls(a
->pop_mpls
.ethertype
)) {
496 return OFPERR_OFPBAC_BAD_ARGUMENT
;
498 ofpact_put_POP_MPLS(out
)->ethertype
= a
->pop_mpls
.ethertype
;
501 case OFPUTIL_NXAST_SAMPLE
:
502 error
= sample_from_openflow(&a
->sample
, out
);
510 ofpact_from_openflow10(const union ofp_action
*a
,
511 enum ofp_version version OVS_UNUSED
,
514 enum ofputil_action_code code
;
516 struct ofpact_vlan_vid
*vlan_vid
;
517 struct ofpact_vlan_pcp
*vlan_pcp
;
519 error
= decode_openflow10_action(a
, &code
);
525 case OFPUTIL_ACTION_INVALID
:
526 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
527 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
528 #include "ofp-util.def"
531 case OFPUTIL_OFPAT10_OUTPUT
:
532 return output_from_openflow10(&a
->output10
, out
);
534 case OFPUTIL_OFPAT10_SET_VLAN_VID
:
535 if (a
->vlan_vid
.vlan_vid
& ~htons(0xfff)) {
536 return OFPERR_OFPBAC_BAD_ARGUMENT
;
538 vlan_vid
= ofpact_put_SET_VLAN_VID(out
);
539 vlan_vid
->vlan_vid
= ntohs(a
->vlan_vid
.vlan_vid
);
540 vlan_vid
->push_vlan_if_needed
= true;
541 vlan_vid
->ofpact
.compat
= code
;
544 case OFPUTIL_OFPAT10_SET_VLAN_PCP
:
545 if (a
->vlan_pcp
.vlan_pcp
& ~7) {
546 return OFPERR_OFPBAC_BAD_ARGUMENT
;
548 vlan_pcp
= ofpact_put_SET_VLAN_PCP(out
);
549 vlan_pcp
->vlan_pcp
= a
->vlan_pcp
.vlan_pcp
;
550 vlan_pcp
->push_vlan_if_needed
= true;
551 vlan_pcp
->ofpact
.compat
= code
;
554 case OFPUTIL_OFPAT10_STRIP_VLAN
:
555 ofpact_put_STRIP_VLAN(out
)->ofpact
.compat
= code
;
558 case OFPUTIL_OFPAT10_SET_DL_SRC
:
559 memcpy(ofpact_put_SET_ETH_SRC(out
)->mac
, a
->dl_addr
.dl_addr
,
563 case OFPUTIL_OFPAT10_SET_DL_DST
:
564 memcpy(ofpact_put_SET_ETH_DST(out
)->mac
, a
->dl_addr
.dl_addr
,
568 case OFPUTIL_OFPAT10_SET_NW_SRC
:
569 ofpact_put_SET_IPV4_SRC(out
)->ipv4
= a
->nw_addr
.nw_addr
;
572 case OFPUTIL_OFPAT10_SET_NW_DST
:
573 ofpact_put_SET_IPV4_DST(out
)->ipv4
= a
->nw_addr
.nw_addr
;
576 case OFPUTIL_OFPAT10_SET_NW_TOS
:
577 if (a
->nw_tos
.nw_tos
& ~IP_DSCP_MASK
) {
578 return OFPERR_OFPBAC_BAD_ARGUMENT
;
580 ofpact_put_SET_IP_DSCP(out
)->dscp
= a
->nw_tos
.nw_tos
;
583 case OFPUTIL_OFPAT10_SET_TP_SRC
:
584 ofpact_put_SET_L4_SRC_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
587 case OFPUTIL_OFPAT10_SET_TP_DST
:
588 ofpact_put_SET_L4_DST_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
592 case OFPUTIL_OFPAT10_ENQUEUE
:
593 error
= enqueue_from_openflow10(&a
->enqueue
, out
);
596 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
597 #include "ofp-util.def"
598 return ofpact_from_nxast(a
, code
, out
);
604 static enum ofperr
ofpact_from_openflow11(const union ofp_action
*,
608 static inline union ofp_action
*
609 action_next(const union ofp_action
*a
)
611 return ((union ofp_action
*) (void *)
612 ((uint8_t *) a
+ ntohs(a
->header
.len
)));
616 action_is_valid(const union ofp_action
*a
, size_t max_actions
)
618 uint16_t len
= ntohs(a
->header
.len
);
619 return (!(len
% OFP_ACTION_ALIGN
)
620 && len
>= OFP_ACTION_ALIGN
621 && len
/ OFP_ACTION_ALIGN
<= max_actions
);
624 /* This macro is careful to check for actions with bad lengths. */
625 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, MAX_ACTIONS) \
626 for ((ITER) = (ACTIONS), (LEFT) = (MAX_ACTIONS); \
627 (LEFT) > 0 && action_is_valid(ITER, LEFT); \
628 ((LEFT) -= ntohs((ITER)->header.len) / OFP_ACTION_ALIGN, \
629 (ITER) = action_next(ITER)))
632 log_bad_action(const union ofp_action
*actions
, size_t max_actions
,
633 const union ofp_action
*bad_action
, enum ofperr error
)
635 if (!VLOG_DROP_WARN(&rl
)) {
639 ds_put_hex_dump(&s
, actions
, max_actions
* OFP_ACTION_ALIGN
, 0, false);
640 VLOG_WARN("bad action at offset %#"PRIxPTR
" (%s):\n%s",
641 (char *)bad_action
- (char *)actions
,
642 ofperr_get_name(error
), ds_cstr(&s
));
648 ofpacts_from_openflow(const union ofp_action
*in
, size_t n_in
,
649 enum ofp_version version
, struct ofpbuf
*out
)
651 const union ofp_action
*a
;
654 enum ofperr (*ofpact_from_openflow
)(const union ofp_action
*a
,
656 struct ofpbuf
*out
) =
657 (version
== OFP10_VERSION
) ?
658 ofpact_from_openflow10
: ofpact_from_openflow11
;
660 ACTION_FOR_EACH (a
, left
, in
, n_in
) {
661 enum ofperr error
= ofpact_from_openflow(a
, version
, out
);
663 log_bad_action(in
, n_in
, a
, error
);
668 enum ofperr error
= OFPERR_OFPBAC_BAD_LEN
;
669 log_bad_action(in
, n_in
, a
, error
);
677 /* Attempts to convert 'actions_len' bytes of OpenFlow actions from the
678 * front of 'openflow' into ofpacts. On success, replaces any existing content
679 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
680 * Returns 0 if successful, otherwise an OpenFlow error.
682 * Actions are processed according to their OpenFlow version which
683 * is provided in the 'version' parameter.
685 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
686 * instructions, so you should call ofpacts_pull_openflow_instructions()
687 * instead of this function.
689 * The parsed actions are valid generically, but they may not be valid in a
690 * specific context. For example, port numbers up to OFPP_MAX are valid
691 * generically, but specific datapaths may only support port numbers in a
692 * smaller range. Use ofpacts_check() to additional check whether actions are
693 * valid in a specific context. */
695 ofpacts_pull_openflow_actions(struct ofpbuf
*openflow
,
696 unsigned int actions_len
,
697 enum ofp_version version
,
698 struct ofpbuf
*ofpacts
) {
699 const union ofp_action
*actions
;
702 ofpbuf_clear(ofpacts
);
704 if (actions_len
% OFP_ACTION_ALIGN
!= 0) {
705 VLOG_WARN_RL(&rl
, "OpenFlow message actions length %u is not a "
706 "multiple of %d", actions_len
, OFP_ACTION_ALIGN
);
707 return OFPERR_OFPBRC_BAD_LEN
;
710 actions
= ofpbuf_try_pull(openflow
, actions_len
);
711 if (actions
== NULL
) {
712 VLOG_WARN_RL(&rl
, "OpenFlow message actions length %u exceeds "
713 "remaining message length (%"PRIu32
")",
714 actions_len
, ofpbuf_size(openflow
));
715 return OFPERR_OFPBRC_BAD_LEN
;
718 error
= ofpacts_from_openflow(actions
, actions_len
/ OFP_ACTION_ALIGN
,
721 ofpbuf_clear(ofpacts
);
725 error
= ofpacts_verify(ofpbuf_data(ofpacts
), ofpbuf_size(ofpacts
));
727 ofpbuf_clear(ofpacts
);
733 /* OpenFlow 1.1 actions. */
735 /* Parses 'a' to determine its type. On success stores the correct type into
736 * '*code' and returns 0. On failure returns an OFPERR_* error code and
737 * '*code' is indeterminate.
739 * The caller must have already verified that 'a''s length is potentially
740 * correct (that is, a->header.len is nonzero and a multiple of
741 * OFP_ACTION_ALIGN and no longer than the amount of space allocated to 'a').
743 * This function verifies that 'a''s length is correct for the type of action
744 * that it represents. */
746 decode_openflow11_action(const union ofp_action
*a
,
747 enum ofputil_action_code
*code
)
752 case CONSTANT_HTONS(OFPAT11_EXPERIMENTER
):
753 return decode_nxast_action(a
, code
);
755 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
756 case CONSTANT_HTONS(ENUM): \
757 len = ntohs(a->header.len); \
759 ? len >= sizeof(struct STRUCT) \
760 : len == sizeof(struct STRUCT)) { \
761 *code = OFPUTIL_##ENUM; \
764 return OFPERR_OFPBAC_BAD_LEN; \
767 #include "ofp-util.def"
770 return OFPERR_OFPBAC_BAD_TYPE
;
775 set_field_from_openflow(const struct ofp12_action_set_field
*oasf
,
776 struct ofpbuf
*ofpacts
)
778 uint16_t oasf_len
= ntohs(oasf
->len
);
779 uint32_t oxm_header
= ntohl(oasf
->dst
);
780 uint8_t oxm_length
= NXM_LENGTH(oxm_header
);
781 struct ofpact_set_field
*sf
;
782 const struct mf_field
*mf
;
784 /* ofp12_action_set_field is padded to 64 bits by zero */
785 if (oasf_len
!= ROUND_UP(sizeof *oasf
+ oxm_length
, 8)) {
786 return OFPERR_OFPBAC_BAD_SET_LEN
;
788 if (!is_all_zeros((const uint8_t *)oasf
+ sizeof *oasf
+ oxm_length
,
789 oasf_len
- oxm_length
- sizeof *oasf
)) {
790 return OFPERR_OFPBAC_BAD_SET_ARGUMENT
;
793 if (NXM_HASMASK(oxm_header
)) {
794 return OFPERR_OFPBAC_BAD_SET_TYPE
;
796 mf
= mf_from_nxm_header(oxm_header
);
798 return OFPERR_OFPBAC_BAD_SET_TYPE
;
800 ovs_assert(mf
->n_bytes
== oxm_length
);
801 /* oxm_length is now validated to be compatible with mf_value. */
803 VLOG_WARN_RL(&rl
, "destination field %s is not writable", mf
->name
);
804 return OFPERR_OFPBAC_BAD_SET_ARGUMENT
;
806 sf
= ofpact_put_SET_FIELD(ofpacts
);
808 memcpy(&sf
->value
, oasf
+ 1, mf
->n_bytes
);
810 /* The value must be valid for match and must have the OFPVID_PRESENT bit
811 * on for OXM_OF_VLAN_VID. */
812 if (!mf_is_value_valid(mf
, &sf
->value
)
813 || (mf
->id
== MFF_VLAN_VID
814 && !(sf
->value
.be16
& htons(OFPVID12_PRESENT
)))) {
815 struct ds ds
= DS_EMPTY_INITIALIZER
;
816 mf_format(mf
, &sf
->value
, NULL
, &ds
);
817 VLOG_WARN_RL(&rl
, "Invalid value for set field %s: %s",
818 mf
->name
, ds_cstr(&ds
));
821 return OFPERR_OFPBAC_BAD_SET_ARGUMENT
;
827 set_field_to_openflow12(const struct ofpact_set_field
*sf
,
828 struct ofpbuf
*openflow
,
829 enum ofp_version version
)
831 uint16_t padded_value_len
= ROUND_UP(sf
->field
->n_bytes
, 8);
832 struct ofp12_action_set_field
*oasf
;
835 oasf
= ofputil_put_OFPAT12_SET_FIELD(openflow
);
836 oasf
->dst
= htonl(mf_oxm_header(sf
->field
->id
, version
));
837 oasf
->len
= htons(sizeof *oasf
+ padded_value_len
);
839 value
= ofpbuf_put_zeros(openflow
, padded_value_len
);
840 memcpy(value
, &sf
->value
, sf
->field
->n_bytes
);
843 /* Convert 'sf' to one or two REG_LOADs. */
845 set_field_to_nxast(const struct ofpact_set_field
*sf
, struct ofpbuf
*openflow
)
847 const struct mf_field
*mf
= sf
->field
;
848 struct nx_action_reg_load
*narl
;
850 if (mf
->n_bits
> 64) {
851 ovs_assert(mf
->n_bytes
== 16); /* IPv6 addr. */
852 /* Split into 64bit chunks */
853 /* Lower bits first. */
854 narl
= ofputil_put_NXAST_REG_LOAD(openflow
);
855 narl
->ofs_nbits
= nxm_encode_ofs_nbits(0, 64);
856 narl
->dst
= htonl(mf
->nxm_header
);
857 memcpy(&narl
->value
, &sf
->value
.ipv6
.s6_addr
[8], sizeof narl
->value
);
858 /* Higher bits next. */
859 narl
= ofputil_put_NXAST_REG_LOAD(openflow
);
860 narl
->ofs_nbits
= nxm_encode_ofs_nbits(64, mf
->n_bits
- 64);
861 narl
->dst
= htonl(mf
->nxm_header
);
862 memcpy(&narl
->value
, &sf
->value
.ipv6
.s6_addr
[0], sizeof narl
->value
);
864 narl
= ofputil_put_NXAST_REG_LOAD(openflow
);
865 narl
->ofs_nbits
= nxm_encode_ofs_nbits(0, mf
->n_bits
);
866 narl
->dst
= htonl(mf
->nxm_header
);
867 memset(&narl
->value
, 0, 8 - mf
->n_bytes
);
868 memcpy((char*)&narl
->value
+ (8 - mf
->n_bytes
),
869 &sf
->value
, mf
->n_bytes
);
873 /* Convert 'sf' to standard OpenFlow 1.1 actions, if we can, falling back
874 * to Nicira extensions if we must.
876 * We check only meta-flow types that can appear within set field actions and
877 * that have a mapping to compatible action types. These struct mf_field
878 * definitions have a defined OXM or NXM header value and specify the field as
881 set_field_to_openflow11(const struct ofpact_set_field
*sf
,
882 struct ofpbuf
*openflow
)
884 switch ((int) sf
->field
->id
) {
886 /* NXM_OF_VLAN_TCI to OpenFlow 1.1 mapping:
888 * If CFI=1, Add or modify VLAN VID & PCP.
889 * OpenFlow 1.1 set actions only apply if the packet
890 * already has VLAN tags. To be sure that is the case
891 * we have to push a VLAN header. As we do not support
892 * multiple layers of VLANs, this is a no-op, if a VLAN
893 * header already exists. This may backfire, however,
894 * when we start supporting multiple layers of VLANs.
895 * If CFI=0, strip VLAN header, if any.
897 if (sf
->value
.be16
& htons(VLAN_CFI
)) {
898 /* Push a VLAN tag, if one was not seen at action validation
900 if (!sf
->flow_has_vlan
) {
901 ofputil_put_OFPAT11_PUSH_VLAN(openflow
)->ethertype
902 = htons(ETH_TYPE_VLAN_8021Q
);
904 ofputil_put_OFPAT11_SET_VLAN_VID(openflow
)->vlan_vid
905 = sf
->value
.be16
& htons(VLAN_VID_MASK
);
906 ofputil_put_OFPAT11_SET_VLAN_PCP(openflow
)->vlan_pcp
907 = vlan_tci_to_pcp(sf
->value
.be16
);
909 /* If the flow did not match on vlan, we have no way of
910 * knowing if the vlan tag exists, so we must POP just to be
912 ofputil_put_OFPAT11_POP_VLAN(openflow
);
917 /* OXM VLAN_PCP to OpenFlow 1.1.
918 * Set field on OXM_OF_VLAN_VID onlyapplies to an existing vlan
919 * tag. Clear the OFPVID_PRESENT bit.
921 ofputil_put_OFPAT11_SET_VLAN_VID(openflow
)->vlan_vid
922 = sf
->value
.be16
& htons(VLAN_VID_MASK
);
926 /* OXM VLAN_PCP to OpenFlow 1.1.
927 * OXM_OF_VLAN_PCP only applies to existing vlan tag. */
928 ofputil_put_OFPAT11_SET_VLAN_PCP(openflow
)->vlan_pcp
= sf
->value
.u8
;
932 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(openflow
)->dl_addr
,
933 sf
->value
.mac
, ETH_ADDR_LEN
);
937 memcpy(ofputil_put_OFPAT11_SET_DL_DST(openflow
)->dl_addr
,
938 sf
->value
.mac
, ETH_ADDR_LEN
);
942 ofputil_put_OFPAT11_SET_MPLS_LABEL(openflow
)->mpls_label
=
947 ofputil_put_OFPAT11_SET_MPLS_TC(openflow
)->mpls_tc
= sf
->value
.u8
;
951 ofputil_put_OFPAT11_SET_NW_SRC(openflow
)->nw_addr
= sf
->value
.be32
;
955 ofputil_put_OFPAT11_SET_NW_DST(openflow
)->nw_addr
= sf
->value
.be32
;
959 ofputil_put_OFPAT11_SET_NW_TOS(openflow
)->nw_tos
= sf
->value
.u8
;
962 case MFF_IP_DSCP_SHIFTED
:
963 ofputil_put_OFPAT11_SET_NW_TOS(openflow
)->nw_tos
= sf
->value
.u8
<< 2;
967 ofputil_put_OFPAT11_SET_NW_ECN(openflow
)->nw_ecn
= sf
->value
.u8
;
971 ofputil_put_OFPAT11_SET_NW_TTL(openflow
)->nw_ttl
= sf
->value
.u8
;
977 ofputil_put_OFPAT11_SET_TP_SRC(openflow
)->tp_port
= sf
->value
.be16
;
983 ofputil_put_OFPAT11_SET_TP_DST(openflow
)->tp_port
= sf
->value
.be16
;
987 set_field_to_nxast(sf
, openflow
);
992 /* Convert 'sf' to standard OpenFlow 1.0 actions, if we can, falling back
993 * to Nicira extensions if we must.
995 * We check only meta-flow types that can appear within set field actions and
996 * that have a mapping to compatible action types. These struct mf_field
997 * definitions have a defined OXM or NXM header value and specify the field as
1000 set_field_to_openflow10(const struct ofpact_set_field
*sf
,
1001 struct ofpbuf
*openflow
)
1003 switch ((int) sf
->field
->id
) {
1005 /* NXM_OF_VLAN_TCI to OpenFlow 1.0 mapping:
1007 * If CFI=1, Add or modify VLAN VID & PCP.
1008 * If CFI=0, strip VLAN header, if any.
1010 if (sf
->value
.be16
& htons(VLAN_CFI
)) {
1011 ofputil_put_OFPAT10_SET_VLAN_VID(openflow
)->vlan_vid
1012 = sf
->value
.be16
& htons(VLAN_VID_MASK
);
1013 ofputil_put_OFPAT10_SET_VLAN_PCP(openflow
)->vlan_pcp
1014 = vlan_tci_to_pcp(sf
->value
.be16
);
1016 ofputil_put_OFPAT10_STRIP_VLAN(openflow
);
1021 /* OXM VLAN_VID to OpenFlow 1.0.
1022 * Set field on OXM_OF_VLAN_VID onlyapplies to an existing vlan
1023 * tag. Clear the OFPVID_PRESENT bit.
1025 ofputil_put_OFPAT10_SET_VLAN_VID(openflow
)->vlan_vid
1026 = sf
->value
.be16
& htons(VLAN_VID_MASK
);
1030 /* OXM VLAN_PCP to OpenFlow 1.0.
1031 * OXM_OF_VLAN_PCP only applies to existing vlan tag. */
1032 ofputil_put_OFPAT10_SET_VLAN_PCP(openflow
)->vlan_pcp
= sf
->value
.u8
;
1036 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(openflow
)->dl_addr
,
1037 sf
->value
.mac
, ETH_ADDR_LEN
);
1041 memcpy(ofputil_put_OFPAT10_SET_DL_DST(openflow
)->dl_addr
,
1042 sf
->value
.mac
, ETH_ADDR_LEN
);
1046 ofputil_put_OFPAT10_SET_NW_SRC(openflow
)->nw_addr
= sf
->value
.be32
;
1050 ofputil_put_OFPAT10_SET_NW_DST(openflow
)->nw_addr
= sf
->value
.be32
;
1054 ofputil_put_OFPAT10_SET_NW_TOS(openflow
)->nw_tos
= sf
->value
.u8
;
1057 case MFF_IP_DSCP_SHIFTED
:
1058 ofputil_put_OFPAT10_SET_NW_TOS(openflow
)->nw_tos
= sf
->value
.u8
<< 2;
1063 ofputil_put_OFPAT10_SET_TP_SRC(openflow
)->tp_port
= sf
->value
.be16
;
1068 ofputil_put_OFPAT10_SET_TP_DST(openflow
)->tp_port
= sf
->value
.be16
;
1072 set_field_to_nxast(sf
, openflow
);
1078 set_field_to_openflow(const struct ofpact_set_field
*sf
,
1079 struct ofpbuf
*openflow
)
1081 struct ofp_header
*oh
= (struct ofp_header
*)openflow
->frame
;
1083 if (oh
->version
>= OFP12_VERSION
) {
1084 set_field_to_openflow12(sf
, openflow
, oh
->version
);
1085 } else if (oh
->version
== OFP11_VERSION
) {
1086 set_field_to_openflow11(sf
, openflow
);
1087 } else if (oh
->version
== OFP10_VERSION
) {
1088 set_field_to_openflow10(sf
, openflow
);
1095 output_from_openflow11(const struct ofp11_action_output
*oao
,
1098 struct ofpact_output
*output
;
1101 output
= ofpact_put_OUTPUT(out
);
1102 output
->max_len
= ntohs(oao
->max_len
);
1104 error
= ofputil_port_from_ofp11(oao
->port
, &output
->port
);
1109 return ofpact_check_output_port(output
->port
, OFPP_MAX
);
1113 ofpact_from_openflow11(const union ofp_action
*a
, enum ofp_version version
,
1116 enum ofputil_action_code code
;
1118 struct ofpact_vlan_vid
*vlan_vid
;
1119 struct ofpact_vlan_pcp
*vlan_pcp
;
1121 error
= decode_openflow11_action(a
, &code
);
1126 if (version
>= OFP12_VERSION
) {
1127 switch ((int)code
) {
1128 case OFPUTIL_OFPAT11_SET_VLAN_VID
:
1129 case OFPUTIL_OFPAT11_SET_VLAN_PCP
:
1130 case OFPUTIL_OFPAT11_SET_DL_SRC
:
1131 case OFPUTIL_OFPAT11_SET_DL_DST
:
1132 case OFPUTIL_OFPAT11_SET_NW_SRC
:
1133 case OFPUTIL_OFPAT11_SET_NW_DST
:
1134 case OFPUTIL_OFPAT11_SET_NW_TOS
:
1135 case OFPUTIL_OFPAT11_SET_NW_ECN
:
1136 case OFPUTIL_OFPAT11_SET_TP_SRC
:
1137 case OFPUTIL_OFPAT11_SET_TP_DST
:
1138 VLOG_WARN_RL(&rl
, "Deprecated action %s received over %s",
1139 ofputil_action_name_from_code(code
),
1140 ofputil_version_to_string(version
));
1145 case OFPUTIL_ACTION_INVALID
:
1146 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
1147 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
1148 #include "ofp-util.def"
1151 case OFPUTIL_OFPAT11_OUTPUT
:
1152 return output_from_openflow11(&a
->ofp11_output
, out
);
1154 case OFPUTIL_OFPAT11_SET_VLAN_VID
:
1155 if (a
->vlan_vid
.vlan_vid
& ~htons(0xfff)) {
1156 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1158 vlan_vid
= ofpact_put_SET_VLAN_VID(out
);
1159 vlan_vid
->vlan_vid
= ntohs(a
->vlan_vid
.vlan_vid
);
1160 vlan_vid
->push_vlan_if_needed
= false;
1161 vlan_vid
->ofpact
.compat
= code
;
1164 case OFPUTIL_OFPAT11_SET_VLAN_PCP
:
1165 if (a
->vlan_pcp
.vlan_pcp
& ~7) {
1166 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1168 vlan_pcp
= ofpact_put_SET_VLAN_PCP(out
);
1169 vlan_pcp
->vlan_pcp
= a
->vlan_pcp
.vlan_pcp
;
1170 vlan_pcp
->push_vlan_if_needed
= false;
1171 vlan_pcp
->ofpact
.compat
= code
;
1174 case OFPUTIL_OFPAT11_PUSH_VLAN
:
1175 if (a
->push
.ethertype
!= htons(ETH_TYPE_VLAN_8021Q
)) {
1176 /* XXX 802.1AD(QinQ) isn't supported at the moment */
1177 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1179 ofpact_put_PUSH_VLAN(out
);
1182 case OFPUTIL_OFPAT11_POP_VLAN
:
1183 ofpact_put_STRIP_VLAN(out
)->ofpact
.compat
= code
;
1186 case OFPUTIL_OFPAT11_SET_QUEUE
:
1187 ofpact_put_SET_QUEUE(out
)->queue_id
=
1188 ntohl(a
->ofp11_set_queue
.queue_id
);
1191 case OFPUTIL_OFPAT11_SET_DL_SRC
:
1192 memcpy(ofpact_put_SET_ETH_SRC(out
)->mac
, a
->dl_addr
.dl_addr
,
1196 case OFPUTIL_OFPAT11_SET_DL_DST
:
1197 memcpy(ofpact_put_SET_ETH_DST(out
)->mac
, a
->dl_addr
.dl_addr
,
1201 case OFPUTIL_OFPAT11_DEC_NW_TTL
:
1202 dec_ttl_from_openflow(out
, code
);
1205 case OFPUTIL_OFPAT11_SET_NW_SRC
:
1206 ofpact_put_SET_IPV4_SRC(out
)->ipv4
= a
->nw_addr
.nw_addr
;
1209 case OFPUTIL_OFPAT11_SET_NW_DST
:
1210 ofpact_put_SET_IPV4_DST(out
)->ipv4
= a
->nw_addr
.nw_addr
;
1213 case OFPUTIL_OFPAT11_SET_NW_TOS
:
1214 if (a
->nw_tos
.nw_tos
& ~IP_DSCP_MASK
) {
1215 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1217 ofpact_put_SET_IP_DSCP(out
)->dscp
= a
->nw_tos
.nw_tos
;
1220 case OFPUTIL_OFPAT11_SET_NW_ECN
:
1221 if (a
->nw_ecn
.nw_ecn
& ~IP_ECN_MASK
) {
1222 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1224 ofpact_put_SET_IP_ECN(out
)->ecn
= a
->nw_ecn
.nw_ecn
;
1227 case OFPUTIL_OFPAT11_SET_NW_TTL
:
1228 ofpact_put_SET_IP_TTL(out
)->ttl
= a
->nw_ttl
.nw_ttl
;
1231 case OFPUTIL_OFPAT11_SET_TP_SRC
:
1232 ofpact_put_SET_L4_SRC_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
1235 case OFPUTIL_OFPAT11_SET_TP_DST
:
1236 ofpact_put_SET_L4_DST_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
1239 case OFPUTIL_OFPAT12_SET_FIELD
:
1240 return set_field_from_openflow(&a
->set_field
, out
);
1242 case OFPUTIL_OFPAT11_SET_MPLS_LABEL
:
1243 ofpact_put_SET_MPLS_LABEL(out
)->label
= a
->ofp11_mpls_label
.mpls_label
;
1246 case OFPUTIL_OFPAT11_SET_MPLS_TC
:
1247 ofpact_put_SET_MPLS_TC(out
)->tc
= a
->ofp11_mpls_tc
.mpls_tc
;
1250 case OFPUTIL_OFPAT11_SET_MPLS_TTL
:
1251 ofpact_put_SET_MPLS_TTL(out
)->ttl
= a
->ofp11_mpls_ttl
.mpls_ttl
;
1254 case OFPUTIL_OFPAT11_DEC_MPLS_TTL
:
1255 ofpact_put_DEC_MPLS_TTL(out
);
1258 case OFPUTIL_OFPAT11_PUSH_MPLS
:
1259 error
= push_mpls_from_openflow(a
->push
.ethertype
, out
);
1262 case OFPUTIL_OFPAT11_POP_MPLS
:
1263 if (eth_type_mpls(a
->ofp11_pop_mpls
.ethertype
)) {
1264 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1266 ofpact_put_POP_MPLS(out
)->ethertype
= a
->ofp11_pop_mpls
.ethertype
;
1269 case OFPUTIL_OFPAT11_GROUP
:
1270 ofpact_put_GROUP(out
)->group_id
= ntohl(a
->group
.group_id
);
1273 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
1274 #include "ofp-util.def"
1275 return ofpact_from_nxast(a
, code
, out
);
1281 /* True if an action sets the value of a field
1282 * in a way that is compatibile with the action set.
1283 * False otherwise. */
1285 ofpact_is_set_action(const struct ofpact
*a
)
1288 case OFPACT_SET_FIELD
:
1289 case OFPACT_REG_LOAD
:
1290 case OFPACT_SET_ETH_DST
:
1291 case OFPACT_SET_ETH_SRC
:
1292 case OFPACT_SET_IP_DSCP
:
1293 case OFPACT_SET_IP_ECN
:
1294 case OFPACT_SET_IP_TTL
:
1295 case OFPACT_SET_IPV4_DST
:
1296 case OFPACT_SET_IPV4_SRC
:
1297 case OFPACT_SET_L4_DST_PORT
:
1298 case OFPACT_SET_L4_SRC_PORT
:
1299 case OFPACT_SET_MPLS_LABEL
:
1300 case OFPACT_SET_MPLS_TC
:
1301 case OFPACT_SET_MPLS_TTL
:
1302 case OFPACT_SET_QUEUE
:
1303 case OFPACT_SET_TUNNEL
:
1304 case OFPACT_SET_VLAN_PCP
:
1305 case OFPACT_SET_VLAN_VID
:
1308 case OFPACT_CLEAR_ACTIONS
:
1309 case OFPACT_CONTROLLER
:
1310 case OFPACT_DEC_MPLS_TTL
:
1311 case OFPACT_DEC_TTL
:
1312 case OFPACT_ENQUEUE
:
1314 case OFPACT_FIN_TIMEOUT
:
1315 case OFPACT_GOTO_TABLE
:
1319 case OFPACT_MULTIPATH
:
1322 case OFPACT_OUTPUT_REG
:
1323 case OFPACT_POP_MPLS
:
1324 case OFPACT_POP_QUEUE
:
1325 case OFPACT_PUSH_MPLS
:
1326 case OFPACT_PUSH_VLAN
:
1327 case OFPACT_REG_MOVE
:
1328 case OFPACT_RESUBMIT
:
1330 case OFPACT_STACK_POP
:
1331 case OFPACT_STACK_PUSH
:
1332 case OFPACT_STRIP_VLAN
:
1333 case OFPACT_WRITE_ACTIONS
:
1334 case OFPACT_WRITE_METADATA
:
1341 /* True if an action is allowed in the action set.
1342 * False otherwise. */
1344 ofpact_is_allowed_in_actions_set(const struct ofpact
*a
)
1347 case OFPACT_DEC_MPLS_TTL
:
1348 case OFPACT_DEC_TTL
:
1351 case OFPACT_POP_MPLS
:
1352 case OFPACT_PUSH_MPLS
:
1353 case OFPACT_PUSH_VLAN
:
1354 case OFPACT_REG_LOAD
:
1355 case OFPACT_SET_FIELD
:
1356 case OFPACT_SET_ETH_DST
:
1357 case OFPACT_SET_ETH_SRC
:
1358 case OFPACT_SET_IP_DSCP
:
1359 case OFPACT_SET_IP_ECN
:
1360 case OFPACT_SET_IP_TTL
:
1361 case OFPACT_SET_IPV4_DST
:
1362 case OFPACT_SET_IPV4_SRC
:
1363 case OFPACT_SET_L4_DST_PORT
:
1364 case OFPACT_SET_L4_SRC_PORT
:
1365 case OFPACT_SET_MPLS_LABEL
:
1366 case OFPACT_SET_MPLS_TC
:
1367 case OFPACT_SET_MPLS_TTL
:
1368 case OFPACT_SET_QUEUE
:
1369 case OFPACT_SET_TUNNEL
:
1370 case OFPACT_SET_VLAN_PCP
:
1371 case OFPACT_SET_VLAN_VID
:
1372 case OFPACT_STRIP_VLAN
:
1375 /* In general these actions are excluded because they are not part of
1376 * the OpenFlow specification nor map to actions that are defined in
1377 * the specification. Thus the order in which they should be applied
1378 * in the action set is undefined. */
1380 case OFPACT_CONTROLLER
:
1381 case OFPACT_ENQUEUE
:
1383 case OFPACT_FIN_TIMEOUT
:
1385 case OFPACT_MULTIPATH
:
1387 case OFPACT_OUTPUT_REG
:
1388 case OFPACT_POP_QUEUE
:
1389 case OFPACT_REG_MOVE
:
1390 case OFPACT_RESUBMIT
:
1392 case OFPACT_STACK_POP
:
1393 case OFPACT_STACK_PUSH
:
1395 /* The action set may only include actions and thus
1396 * may not include any instructions */
1397 case OFPACT_CLEAR_ACTIONS
:
1398 case OFPACT_GOTO_TABLE
:
1400 case OFPACT_WRITE_ACTIONS
:
1401 case OFPACT_WRITE_METADATA
:
1408 /* Append ofpact 'a' onto the tail of 'out' */
1410 ofpact_copy(struct ofpbuf
*out
, const struct ofpact
*a
)
1412 ofpbuf_put(out
, a
, OFPACT_ALIGN(a
->len
));
1415 /* Copies the last ofpact whose type is 'filter' from 'in' to 'out'. */
1417 ofpacts_copy_last(struct ofpbuf
*out
, const struct ofpbuf
*in
,
1418 enum ofpact_type filter
)
1420 const struct ofpact
*target
;
1421 const struct ofpact
*a
;
1424 OFPACT_FOR_EACH (a
, ofpbuf_data(in
), ofpbuf_size(in
)) {
1425 if (a
->type
== filter
) {
1430 ofpact_copy(out
, target
);
1432 return target
!= NULL
;
1435 /* Append all ofpacts, for which 'filter' returns true, from 'in' to 'out'.
1436 * The order of appended ofpacts is preserved between 'in' and 'out' */
1438 ofpacts_copy_all(struct ofpbuf
*out
, const struct ofpbuf
*in
,
1439 bool (*filter
)(const struct ofpact
*))
1441 const struct ofpact
*a
;
1443 OFPACT_FOR_EACH (a
, ofpbuf_data(in
), ofpbuf_size(in
)) {
1445 ofpact_copy(out
, a
);
1450 /* Reads 'action_set', which contains ofpacts accumulated by
1451 * OFPACT_WRITE_ACTIONS instructions, and writes equivalent actions to be
1452 * executed directly into 'action_list'. (These names correspond to the
1453 * "Action Set" and "Action List" terms used in OpenFlow 1.1+.)
1455 * In general this involves appending the last instance of each action that is
1456 * adimissible in the action set in the order described in the OpenFlow
1460 * + output action is only appended if no group action was present in 'in'.
1461 * + As a simplification all set actions are copied in the order the are
1462 * provided in 'in' as many set actions applied to a field has the same
1463 * affect as only applying the last action that sets a field and
1464 * duplicates are removed by do_xlate_actions().
1465 * This has an unwanted side-effect of compsoting multiple
1466 * LOAD_REG actions that touch different regions of the same field. */
1468 ofpacts_execute_action_set(struct ofpbuf
*action_list
,
1469 const struct ofpbuf
*action_set
)
1471 /* The OpenFlow spec "Action Set" section specifies this order. */
1472 ofpacts_copy_last(action_list
, action_set
, OFPACT_STRIP_VLAN
);
1473 ofpacts_copy_last(action_list
, action_set
, OFPACT_POP_MPLS
);
1474 ofpacts_copy_last(action_list
, action_set
, OFPACT_PUSH_MPLS
);
1475 ofpacts_copy_last(action_list
, action_set
, OFPACT_PUSH_VLAN
);
1476 ofpacts_copy_last(action_list
, action_set
, OFPACT_DEC_TTL
);
1477 ofpacts_copy_last(action_list
, action_set
, OFPACT_DEC_MPLS_TTL
);
1478 ofpacts_copy_all(action_list
, action_set
, ofpact_is_set_action
);
1479 ofpacts_copy_last(action_list
, action_set
, OFPACT_SET_QUEUE
);
1481 /* If both OFPACT_GROUP and OFPACT_OUTPUT are present, OpenFlow says that
1482 * we should execute only OFPACT_GROUP.
1484 * If neither OFPACT_GROUP nor OFPACT_OUTPUT is present, then we can drop
1485 * all the actions because there's no point in modifying a packet that will
1486 * not be sent anywhere. */
1487 if (!ofpacts_copy_last(action_list
, action_set
, OFPACT_GROUP
) &&
1488 !ofpacts_copy_last(action_list
, action_set
, OFPACT_OUTPUT
)) {
1489 ofpbuf_clear(action_list
);
1495 ofpacts_from_openflow11_for_action_set(const union ofp_action
*in
,
1496 size_t n_in
, enum ofp_version version
,
1501 size_t start
= ofpbuf_size(out
);
1503 error
= ofpacts_from_openflow(in
, n_in
, version
, out
);
1509 OFPACT_FOR_EACH (a
, ofpact_end(ofpbuf_data(out
), start
), ofpbuf_size(out
) - start
) {
1510 if (!ofpact_is_allowed_in_actions_set(a
)) {
1511 VLOG_WARN_RL(&rl
, "disallowed action in action set");
1512 return OFPERR_OFPBAC_BAD_TYPE
;
1520 /* OpenFlow 1.1 instructions. */
1522 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
1523 static inline const struct STRUCT * OVS_UNUSED \
1524 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
1526 ovs_assert(inst->type == htons(ENUM)); \
1527 return ALIGNED_CAST(struct STRUCT *, inst); \
1530 static inline void OVS_UNUSED \
1531 instruction_init_##ENUM(struct STRUCT *s) \
1533 memset(s, 0, sizeof *s); \
1534 s->type = htons(ENUM); \
1535 s->len = htons(sizeof *s); \
1538 static inline struct STRUCT * OVS_UNUSED \
1539 instruction_put_##ENUM(struct ofpbuf *buf) \
1541 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
1542 instruction_init_##ENUM(s); \
1548 struct instruction_type_info
{
1549 enum ovs_instruction_type type
;
1553 static const struct instruction_type_info inst_info
[] = {
1554 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
1560 ovs_instruction_name_from_type(enum ovs_instruction_type type
)
1562 return inst_info
[type
].name
;
1566 ovs_instruction_type_from_name(const char *name
)
1568 const struct instruction_type_info
*p
;
1569 for (p
= inst_info
; p
< &inst_info
[ARRAY_SIZE(inst_info
)]; p
++) {
1570 if (!strcasecmp(name
, p
->name
)) {
1577 enum ovs_instruction_type
1578 ovs_instruction_type_from_ofpact_type(enum ofpact_type type
)
1582 return OVSINST_OFPIT13_METER
;
1583 case OFPACT_CLEAR_ACTIONS
:
1584 return OVSINST_OFPIT11_CLEAR_ACTIONS
;
1585 case OFPACT_WRITE_ACTIONS
:
1586 return OVSINST_OFPIT11_WRITE_ACTIONS
;
1587 case OFPACT_WRITE_METADATA
:
1588 return OVSINST_OFPIT11_WRITE_METADATA
;
1589 case OFPACT_GOTO_TABLE
:
1590 return OVSINST_OFPIT11_GOTO_TABLE
;
1593 case OFPACT_CONTROLLER
:
1594 case OFPACT_ENQUEUE
:
1595 case OFPACT_OUTPUT_REG
:
1597 case OFPACT_SET_VLAN_VID
:
1598 case OFPACT_SET_VLAN_PCP
:
1599 case OFPACT_STRIP_VLAN
:
1600 case OFPACT_PUSH_VLAN
:
1601 case OFPACT_SET_ETH_SRC
:
1602 case OFPACT_SET_ETH_DST
:
1603 case OFPACT_SET_IPV4_SRC
:
1604 case OFPACT_SET_IPV4_DST
:
1605 case OFPACT_SET_IP_DSCP
:
1606 case OFPACT_SET_IP_ECN
:
1607 case OFPACT_SET_IP_TTL
:
1608 case OFPACT_SET_L4_SRC_PORT
:
1609 case OFPACT_SET_L4_DST_PORT
:
1610 case OFPACT_REG_MOVE
:
1611 case OFPACT_REG_LOAD
:
1612 case OFPACT_SET_FIELD
:
1613 case OFPACT_STACK_PUSH
:
1614 case OFPACT_STACK_POP
:
1615 case OFPACT_DEC_TTL
:
1616 case OFPACT_SET_MPLS_LABEL
:
1617 case OFPACT_SET_MPLS_TC
:
1618 case OFPACT_SET_MPLS_TTL
:
1619 case OFPACT_DEC_MPLS_TTL
:
1620 case OFPACT_PUSH_MPLS
:
1621 case OFPACT_POP_MPLS
:
1622 case OFPACT_SET_TUNNEL
:
1623 case OFPACT_SET_QUEUE
:
1624 case OFPACT_POP_QUEUE
:
1625 case OFPACT_FIN_TIMEOUT
:
1626 case OFPACT_RESUBMIT
:
1628 case OFPACT_MULTIPATH
:
1633 return OVSINST_OFPIT11_APPLY_ACTIONS
;
1638 ovs_instruction_type_from_inst_type(enum ovs_instruction_type
*instruction_type
,
1639 const uint16_t inst_type
)
1641 switch (inst_type
) {
1643 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
1645 *instruction_type = OVSINST_##ENUM; \
1651 return OFPERR_OFPBIC_UNKNOWN_INST
;
1655 static inline struct ofp11_instruction
*
1656 instruction_next(const struct ofp11_instruction
*inst
)
1658 return ((struct ofp11_instruction
*) (void *)
1659 ((uint8_t *) inst
+ ntohs(inst
->len
)));
1663 instruction_is_valid(const struct ofp11_instruction
*inst
,
1664 size_t n_instructions
)
1666 uint16_t len
= ntohs(inst
->len
);
1667 return (!(len
% OFP11_INSTRUCTION_ALIGN
)
1668 && len
>= sizeof *inst
1669 && len
/ sizeof *inst
<= n_instructions
);
1672 /* This macro is careful to check for instructions with bad lengths. */
1673 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
1674 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
1675 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
1676 ((LEFT) -= (ntohs((ITER)->len) \
1677 / sizeof(struct ofp11_instruction)), \
1678 (ITER) = instruction_next(ITER)))
1681 decode_openflow11_instruction(const struct ofp11_instruction
*inst
,
1682 enum ovs_instruction_type
*type
)
1684 uint16_t len
= ntohs(inst
->len
);
1686 switch (inst
->type
) {
1687 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER
):
1688 return OFPERR_OFPBIC_BAD_EXPERIMENTER
;
1690 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
1691 case CONSTANT_HTONS(ENUM): \
1693 ? len >= sizeof(struct STRUCT) \
1694 : len == sizeof(struct STRUCT)) { \
1695 *type = OVSINST_##ENUM; \
1698 return OFPERR_OFPBIC_BAD_LEN; \
1704 return OFPERR_OFPBIC_UNKNOWN_INST
;
1709 decode_openflow11_instructions(const struct ofp11_instruction insts
[],
1711 const struct ofp11_instruction
*out
[])
1713 const struct ofp11_instruction
*inst
;
1716 memset(out
, 0, N_OVS_INSTRUCTIONS
* sizeof *out
);
1717 INSTRUCTION_FOR_EACH (inst
, left
, insts
, n_insts
) {
1718 enum ovs_instruction_type type
;
1721 error
= decode_openflow11_instruction(inst
, &type
);
1727 return OFPERR_ONFBIC_DUP_INSTRUCTION
;
1733 VLOG_WARN_RL(&rl
, "bad instruction format at offset %"PRIuSIZE
,
1734 (n_insts
- left
) * sizeof *inst
);
1735 return OFPERR_OFPBIC_BAD_LEN
;
1741 get_actions_from_instruction(const struct ofp11_instruction
*inst
,
1742 const union ofp_action
**actions
,
1743 size_t *max_actions
)
1745 *actions
= ALIGNED_CAST(const union ofp_action
*, inst
+ 1);
1746 *max_actions
= (ntohs(inst
->len
) - sizeof *inst
) / OFP11_INSTRUCTION_ALIGN
;
1750 ofpacts_pull_openflow_instructions(struct ofpbuf
*openflow
,
1751 unsigned int instructions_len
,
1752 enum ofp_version version
,
1753 struct ofpbuf
*ofpacts
)
1755 const struct ofp11_instruction
*instructions
;
1756 const struct ofp11_instruction
*insts
[N_OVS_INSTRUCTIONS
];
1759 ofpbuf_clear(ofpacts
);
1761 if (instructions_len
% OFP11_INSTRUCTION_ALIGN
!= 0) {
1762 VLOG_WARN_RL(&rl
, "OpenFlow message instructions length %u is not a "
1764 instructions_len
, OFP11_INSTRUCTION_ALIGN
);
1765 error
= OFPERR_OFPBIC_BAD_LEN
;
1769 instructions
= ofpbuf_try_pull(openflow
, instructions_len
);
1770 if (instructions
== NULL
) {
1771 VLOG_WARN_RL(&rl
, "OpenFlow message instructions length %u exceeds "
1772 "remaining message length (%"PRIu32
")",
1773 instructions_len
, ofpbuf_size(openflow
));
1774 error
= OFPERR_OFPBIC_BAD_LEN
;
1778 error
= decode_openflow11_instructions(
1779 instructions
, instructions_len
/ OFP11_INSTRUCTION_ALIGN
,
1785 if (insts
[OVSINST_OFPIT13_METER
]) {
1786 const struct ofp13_instruction_meter
*oim
;
1787 struct ofpact_meter
*om
;
1789 oim
= ALIGNED_CAST(const struct ofp13_instruction_meter
*,
1790 insts
[OVSINST_OFPIT13_METER
]);
1792 om
= ofpact_put_METER(ofpacts
);
1793 om
->meter_id
= ntohl(oim
->meter_id
);
1795 if (insts
[OVSINST_OFPIT11_APPLY_ACTIONS
]) {
1796 const union ofp_action
*actions
;
1799 get_actions_from_instruction(insts
[OVSINST_OFPIT11_APPLY_ACTIONS
],
1800 &actions
, &max_actions
);
1801 error
= ofpacts_from_openflow(actions
, max_actions
, version
, ofpacts
);
1806 if (insts
[OVSINST_OFPIT11_CLEAR_ACTIONS
]) {
1807 instruction_get_OFPIT11_CLEAR_ACTIONS(
1808 insts
[OVSINST_OFPIT11_CLEAR_ACTIONS
]);
1809 ofpact_put_CLEAR_ACTIONS(ofpacts
);
1811 if (insts
[OVSINST_OFPIT11_WRITE_ACTIONS
]) {
1812 struct ofpact_nest
*on
;
1813 const union ofp_action
*actions
;
1817 ofpact_pad(ofpacts
);
1818 start
= ofpbuf_size(ofpacts
);
1819 on
= ofpact_put(ofpacts
, OFPACT_WRITE_ACTIONS
,
1820 offsetof(struct ofpact_nest
, actions
));
1821 get_actions_from_instruction(insts
[OVSINST_OFPIT11_WRITE_ACTIONS
],
1822 &actions
, &max_actions
);
1823 error
= ofpacts_from_openflow11_for_action_set(actions
, max_actions
,
1828 on
= ofpbuf_at_assert(ofpacts
, start
, sizeof *on
);
1829 on
->ofpact
.len
= ofpbuf_size(ofpacts
) - start
;
1831 if (insts
[OVSINST_OFPIT11_WRITE_METADATA
]) {
1832 const struct ofp11_instruction_write_metadata
*oiwm
;
1833 struct ofpact_metadata
*om
;
1835 oiwm
= ALIGNED_CAST(const struct ofp11_instruction_write_metadata
*,
1836 insts
[OVSINST_OFPIT11_WRITE_METADATA
]);
1838 om
= ofpact_put_WRITE_METADATA(ofpacts
);
1839 om
->metadata
= oiwm
->metadata
;
1840 om
->mask
= oiwm
->metadata_mask
;
1842 if (insts
[OVSINST_OFPIT11_GOTO_TABLE
]) {
1843 const struct ofp11_instruction_goto_table
*oigt
;
1844 struct ofpact_goto_table
*ogt
;
1846 oigt
= instruction_get_OFPIT11_GOTO_TABLE(
1847 insts
[OVSINST_OFPIT11_GOTO_TABLE
]);
1848 ogt
= ofpact_put_GOTO_TABLE(ofpacts
);
1849 ogt
->table_id
= oigt
->table_id
;
1852 error
= ofpacts_verify(ofpbuf_data(ofpacts
), ofpbuf_size(ofpacts
));
1855 ofpbuf_clear(ofpacts
);
1860 /* Checks that 'port' is a valid output port for OFPACT_OUTPUT, given that the
1861 * switch will never have more than 'max_ports' ports. Returns 0 if 'port' is
1862 * valid, otherwise an OpenFlow error code. */
1864 ofpact_check_output_port(ofp_port_t port
, ofp_port_t max_ports
)
1872 case OFPP_CONTROLLER
:
1878 if (ofp_to_u16(port
) < ofp_to_u16(max_ports
)) {
1881 return OFPERR_OFPBAC_BAD_OUT_PORT
;
1885 /* Removes the protocols that require consistency between match and actions
1886 * (that's everything but OpenFlow 1.0) from '*usable_protocols'.
1888 * (An example of an inconsistency between match and actions is a flow that
1889 * does not match on an MPLS Ethertype but has an action that pops an MPLS
1892 inconsistent_match(enum ofputil_protocol
*usable_protocols
)
1894 *usable_protocols
&= OFPUTIL_P_OF10_ANY
;
1897 /* May modify flow->dl_type, flow->nw_proto and flow->vlan_tci,
1898 * caller must restore them.
1900 * Modifies some actions, filling in fields that could not be properly set
1901 * without context. */
1903 ofpact_check__(enum ofputil_protocol
*usable_protocols
, struct ofpact
*a
,
1904 struct flow
*flow
, ofp_port_t max_ports
,
1905 uint8_t table_id
, uint8_t n_tables
)
1907 const struct ofpact_enqueue
*enqueue
;
1908 const struct mf_field
*mf
;
1912 return ofpact_check_output_port(ofpact_get_OUTPUT(a
)->port
,
1915 case OFPACT_CONTROLLER
:
1918 case OFPACT_ENQUEUE
:
1919 enqueue
= ofpact_get_ENQUEUE(a
);
1920 if (ofp_to_u16(enqueue
->port
) >= ofp_to_u16(max_ports
)
1921 && enqueue
->port
!= OFPP_IN_PORT
1922 && enqueue
->port
!= OFPP_LOCAL
) {
1923 return OFPERR_OFPBAC_BAD_OUT_PORT
;
1927 case OFPACT_OUTPUT_REG
:
1928 return mf_check_src(&ofpact_get_OUTPUT_REG(a
)->src
, flow
);
1931 return bundle_check(ofpact_get_BUNDLE(a
), max_ports
, flow
);
1933 case OFPACT_SET_VLAN_VID
:
1934 /* Remember if we saw a vlan tag in the flow to aid translating to
1935 * OpenFlow 1.1+ if need be. */
1936 ofpact_get_SET_VLAN_VID(a
)->flow_has_vlan
=
1937 (flow
->vlan_tci
& htons(VLAN_CFI
)) == htons(VLAN_CFI
);
1938 if (!(flow
->vlan_tci
& htons(VLAN_CFI
)) &&
1939 !ofpact_get_SET_VLAN_VID(a
)->push_vlan_if_needed
) {
1940 inconsistent_match(usable_protocols
);
1942 /* Temporary mark that we have a vlan tag. */
1943 flow
->vlan_tci
|= htons(VLAN_CFI
);
1946 case OFPACT_SET_VLAN_PCP
:
1947 /* Remember if we saw a vlan tag in the flow to aid translating to
1948 * OpenFlow 1.1+ if need be. */
1949 ofpact_get_SET_VLAN_PCP(a
)->flow_has_vlan
=
1950 (flow
->vlan_tci
& htons(VLAN_CFI
)) == htons(VLAN_CFI
);
1951 if (!(flow
->vlan_tci
& htons(VLAN_CFI
)) &&
1952 !ofpact_get_SET_VLAN_PCP(a
)->push_vlan_if_needed
) {
1953 inconsistent_match(usable_protocols
);
1955 /* Temporary mark that we have a vlan tag. */
1956 flow
->vlan_tci
|= htons(VLAN_CFI
);
1959 case OFPACT_STRIP_VLAN
:
1960 if (!(flow
->vlan_tci
& htons(VLAN_CFI
))) {
1961 inconsistent_match(usable_protocols
);
1963 /* Temporary mark that we have no vlan tag. */
1964 flow
->vlan_tci
= htons(0);
1967 case OFPACT_PUSH_VLAN
:
1968 if (flow
->vlan_tci
& htons(VLAN_CFI
)) {
1969 /* Multiple VLAN headers not supported. */
1970 return OFPERR_OFPBAC_BAD_TAG
;
1972 /* Temporary mark that we have a vlan tag. */
1973 flow
->vlan_tci
|= htons(VLAN_CFI
);
1976 case OFPACT_SET_ETH_SRC
:
1977 case OFPACT_SET_ETH_DST
:
1980 case OFPACT_SET_IPV4_SRC
:
1981 case OFPACT_SET_IPV4_DST
:
1982 if (flow
->dl_type
!= htons(ETH_TYPE_IP
)) {
1983 inconsistent_match(usable_protocols
);
1987 case OFPACT_SET_IP_DSCP
:
1988 case OFPACT_SET_IP_ECN
:
1989 case OFPACT_SET_IP_TTL
:
1990 case OFPACT_DEC_TTL
:
1991 if (!is_ip_any(flow
)) {
1992 inconsistent_match(usable_protocols
);
1996 case OFPACT_SET_L4_SRC_PORT
:
1997 if (!is_ip_any(flow
) ||
1998 (flow
->nw_proto
!= IPPROTO_TCP
&& flow
->nw_proto
!= IPPROTO_UDP
1999 && flow
->nw_proto
!= IPPROTO_SCTP
)) {
2000 inconsistent_match(usable_protocols
);
2002 /* Note on which transport protocol the port numbers are set.
2003 * This allows this set action to be converted to an OF1.2 set field
2005 ofpact_get_SET_L4_SRC_PORT(a
)->flow_ip_proto
= flow
->nw_proto
;
2008 case OFPACT_SET_L4_DST_PORT
:
2009 if (!is_ip_any(flow
) ||
2010 (flow
->nw_proto
!= IPPROTO_TCP
&& flow
->nw_proto
!= IPPROTO_UDP
2011 && flow
->nw_proto
!= IPPROTO_SCTP
)) {
2012 inconsistent_match(usable_protocols
);
2014 /* Note on which transport protocol the port numbers are set.
2015 * This allows this set action to be converted to an OF1.2 set field
2017 ofpact_get_SET_L4_DST_PORT(a
)->flow_ip_proto
= flow
->nw_proto
;
2020 case OFPACT_REG_MOVE
:
2021 return nxm_reg_move_check(ofpact_get_REG_MOVE(a
), flow
);
2023 case OFPACT_REG_LOAD
:
2024 return nxm_reg_load_check(ofpact_get_REG_LOAD(a
), flow
);
2026 case OFPACT_SET_FIELD
:
2027 mf
= ofpact_get_SET_FIELD(a
)->field
;
2028 /* Require OXM_OF_VLAN_VID to have an existing VLAN header. */
2029 if (!mf_are_prereqs_ok(mf
, flow
) ||
2030 (mf
->id
== MFF_VLAN_VID
&& !(flow
->vlan_tci
& htons(VLAN_CFI
)))) {
2031 VLOG_WARN_RL(&rl
, "set_field %s lacks correct prerequisities",
2033 return OFPERR_OFPBAC_MATCH_INCONSISTENT
;
2035 /* Remember if we saw a vlan tag in the flow to aid translating to
2036 * OpenFlow 1.1 if need be. */
2037 ofpact_get_SET_FIELD(a
)->flow_has_vlan
=
2038 (flow
->vlan_tci
& htons(VLAN_CFI
)) == htons(VLAN_CFI
);
2039 if (mf
->id
== MFF_VLAN_TCI
) {
2040 /* The set field may add or remove the vlan tag,
2041 * Mark the status temporarily. */
2042 flow
->vlan_tci
= ofpact_get_SET_FIELD(a
)->value
.be16
;
2046 case OFPACT_STACK_PUSH
:
2047 return nxm_stack_push_check(ofpact_get_STACK_PUSH(a
), flow
);
2049 case OFPACT_STACK_POP
:
2050 return nxm_stack_pop_check(ofpact_get_STACK_POP(a
), flow
);
2052 case OFPACT_SET_MPLS_LABEL
:
2053 case OFPACT_SET_MPLS_TC
:
2054 case OFPACT_SET_MPLS_TTL
:
2055 case OFPACT_DEC_MPLS_TTL
:
2056 if (!eth_type_mpls(flow
->dl_type
)) {
2057 inconsistent_match(usable_protocols
);
2061 case OFPACT_SET_TUNNEL
:
2062 case OFPACT_SET_QUEUE
:
2063 case OFPACT_POP_QUEUE
:
2064 case OFPACT_RESUBMIT
:
2067 case OFPACT_FIN_TIMEOUT
:
2068 if (flow
->nw_proto
!= IPPROTO_TCP
) {
2069 inconsistent_match(usable_protocols
);
2074 return learn_check(ofpact_get_LEARN(a
), flow
);
2076 case OFPACT_MULTIPATH
:
2077 return multipath_check(ofpact_get_MULTIPATH(a
), flow
);
2083 case OFPACT_PUSH_MPLS
:
2084 flow
->dl_type
= ofpact_get_PUSH_MPLS(a
)->ethertype
;
2085 /* The packet is now MPLS and the MPLS payload is opaque.
2086 * Thus nothing can be assumed about the network protocol.
2087 * Temporarily mark that we have no nw_proto. */
2091 case OFPACT_POP_MPLS
:
2092 if (!eth_type_mpls(flow
->dl_type
)) {
2093 inconsistent_match(usable_protocols
);
2095 flow
->dl_type
= ofpact_get_POP_MPLS(a
)->ethertype
;
2101 case OFPACT_CLEAR_ACTIONS
:
2104 case OFPACT_WRITE_ACTIONS
: {
2105 /* Use a temporary copy of 'usable_protocols' because we can't check
2106 * consistency of an action set. */
2107 struct ofpact_nest
*on
= ofpact_get_WRITE_ACTIONS(a
);
2108 enum ofputil_protocol p
= *usable_protocols
;
2109 return ofpacts_check(on
->actions
, ofpact_nest_get_action_len(on
),
2110 flow
, max_ports
, table_id
, n_tables
, &p
);
2113 case OFPACT_WRITE_METADATA
:
2116 case OFPACT_METER
: {
2117 uint32_t mid
= ofpact_get_METER(a
)->meter_id
;
2118 if (mid
== 0 || mid
> OFPM13_MAX
) {
2119 return OFPERR_OFPMMFC_INVALID_METER
;
2124 case OFPACT_GOTO_TABLE
: {
2125 uint8_t goto_table
= ofpact_get_GOTO_TABLE(a
)->table_id
;
2126 if ((table_id
!= 255 && goto_table
<= table_id
)
2127 || (n_tables
!= 255 && goto_table
>= n_tables
)) {
2128 return OFPERR_OFPBRC_BAD_TABLE_ID
;
2141 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
2142 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
2143 * switch with no more than 'max_ports' ports.
2145 * If 'ofpacts' and 'flow' are inconsistent with one another, un-sets in
2146 * '*usable_protocols' the protocols that forbid the inconsistency. (An
2147 * example of an inconsistency between match and actions is a flow that does
2148 * not match on an MPLS Ethertype but has an action that pops an MPLS label.)
2150 * May annotate ofpacts with information gathered from the 'flow'.
2152 * May temporarily modify 'flow', but restores the changes before returning. */
2154 ofpacts_check(struct ofpact ofpacts
[], size_t ofpacts_len
,
2155 struct flow
*flow
, ofp_port_t max_ports
,
2156 uint8_t table_id
, uint8_t n_tables
,
2157 enum ofputil_protocol
*usable_protocols
)
2160 ovs_be16 dl_type
= flow
->dl_type
;
2161 ovs_be16 vlan_tci
= flow
->vlan_tci
;
2162 uint8_t nw_proto
= flow
->nw_proto
;
2163 enum ofperr error
= 0;
2165 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
2166 error
= ofpact_check__(usable_protocols
, a
, flow
,
2167 max_ports
, table_id
, n_tables
);
2172 /* Restore fields that may have been modified. */
2173 flow
->dl_type
= dl_type
;
2174 flow
->vlan_tci
= vlan_tci
;
2175 flow
->nw_proto
= nw_proto
;
2179 /* Like ofpacts_check(), but reports inconsistencies as
2180 * OFPERR_OFPBAC_MATCH_INCONSISTENT rather than clearing bits. */
2182 ofpacts_check_consistency(struct ofpact ofpacts
[], size_t ofpacts_len
,
2183 struct flow
*flow
, ofp_port_t max_ports
,
2184 uint8_t table_id
, uint8_t n_tables
,
2185 enum ofputil_protocol usable_protocols
)
2187 enum ofputil_protocol p
= usable_protocols
;
2190 error
= ofpacts_check(ofpacts
, ofpacts_len
, flow
, max_ports
,
2191 table_id
, n_tables
, &p
);
2192 return (error
? error
2193 : p
!= usable_protocols
? OFPERR_OFPBAC_MATCH_INCONSISTENT
2197 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
2198 * in the appropriate order as defined by the OpenFlow spec. */
2200 ofpacts_verify(const struct ofpact ofpacts
[], size_t ofpacts_len
)
2202 const struct ofpact
*a
;
2203 enum ovs_instruction_type inst
;
2205 inst
= OVSINST_OFPIT13_METER
;
2206 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
2207 enum ovs_instruction_type next
;
2209 next
= ovs_instruction_type_from_ofpact_type(a
->type
);
2211 && (inst
== OVSINST_OFPIT11_APPLY_ACTIONS
2214 const char *name
= ovs_instruction_name_from_type(inst
);
2215 const char *next_name
= ovs_instruction_name_from_type(next
);
2218 VLOG_WARN("duplicate %s instruction not allowed, for OpenFlow "
2219 "1.1+ compatibility", name
);
2221 VLOG_WARN("invalid instruction ordering: %s must appear "
2222 "before %s, for OpenFlow 1.1+ compatibility",
2225 return OFPERR_OFPBAC_UNSUPPORTED_ORDER
;
2234 /* Converting ofpacts to Nicira OpenFlow extensions. */
2237 ofpact_output_reg_to_nxast(const struct ofpact_output_reg
*output_reg
,
2240 struct nx_action_output_reg
*naor
= ofputil_put_NXAST_OUTPUT_REG(out
);
2242 naor
->ofs_nbits
= nxm_encode_ofs_nbits(output_reg
->src
.ofs
,
2243 output_reg
->src
.n_bits
);
2244 naor
->src
= htonl(output_reg
->src
.field
->nxm_header
);
2245 naor
->max_len
= htons(output_reg
->max_len
);
2249 ofpact_resubmit_to_nxast(const struct ofpact_resubmit
*resubmit
,
2252 struct nx_action_resubmit
*nar
;
2254 if (resubmit
->table_id
== 0xff
2255 && resubmit
->ofpact
.compat
!= OFPUTIL_NXAST_RESUBMIT_TABLE
) {
2256 nar
= ofputil_put_NXAST_RESUBMIT(out
);
2258 nar
= ofputil_put_NXAST_RESUBMIT_TABLE(out
);
2259 nar
->table
= resubmit
->table_id
;
2261 nar
->in_port
= htons(ofp_to_u16(resubmit
->in_port
));
2265 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel
*tunnel
,
2268 uint64_t tun_id
= tunnel
->tun_id
;
2270 if (tun_id
<= UINT32_MAX
2271 && tunnel
->ofpact
.compat
!= OFPUTIL_NXAST_SET_TUNNEL64
) {
2272 ofputil_put_NXAST_SET_TUNNEL(out
)->tun_id
= htonl(tun_id
);
2274 ofputil_put_NXAST_SET_TUNNEL64(out
)->tun_id
= htonll(tun_id
);
2279 ofpact_write_metadata_to_nxast(const struct ofpact_metadata
*om
,
2282 struct nx_action_write_metadata
*nawm
;
2284 nawm
= ofputil_put_NXAST_WRITE_METADATA(out
);
2285 nawm
->metadata
= om
->metadata
;
2286 nawm
->mask
= om
->mask
;
2290 ofpact_note_to_nxast(const struct ofpact_note
*note
, struct ofpbuf
*out
)
2292 size_t start_ofs
= ofpbuf_size(out
);
2293 struct nx_action_note
*nan
;
2294 unsigned int remainder
;
2297 nan
= ofputil_put_NXAST_NOTE(out
);
2298 ofpbuf_set_size(out
, ofpbuf_size(out
) - sizeof nan
->note
);
2300 ofpbuf_put(out
, note
->data
, note
->length
);
2302 len
= ofpbuf_size(out
) - start_ofs
;
2303 remainder
= len
% OFP_ACTION_ALIGN
;
2305 ofpbuf_put_zeros(out
, OFP_ACTION_ALIGN
- remainder
);
2307 nan
= ofpbuf_at(out
, start_ofs
, sizeof *nan
);
2308 nan
->len
= htons(ofpbuf_size(out
) - start_ofs
);
2312 ofpact_controller_to_nxast(const struct ofpact_controller
*oc
,
2315 struct nx_action_controller
*nac
;
2317 nac
= ofputil_put_NXAST_CONTROLLER(out
);
2318 nac
->max_len
= htons(oc
->max_len
);
2319 nac
->controller_id
= htons(oc
->controller_id
);
2320 nac
->reason
= oc
->reason
;
2324 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids
*oc_ids
,
2327 if (oc_ids
->ofpact
.compat
== OFPUTIL_NXAST_DEC_TTL
) {
2328 ofputil_put_NXAST_DEC_TTL(out
);
2330 struct nx_action_cnt_ids
*nac_ids
=
2331 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out
);
2332 int ids_len
= ROUND_UP(2 * oc_ids
->n_controllers
, OFP_ACTION_ALIGN
);
2336 nac_ids
->len
= htons(ntohs(nac_ids
->len
) + ids_len
);
2337 nac_ids
->n_controllers
= htons(oc_ids
->n_controllers
);
2339 ids
= ofpbuf_put_zeros(out
, ids_len
);
2340 for (i
= 0; i
< oc_ids
->n_controllers
; i
++) {
2341 ids
[i
] = htons(oc_ids
->cnt_ids
[i
]);
2347 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout
*fin_timeout
,
2350 struct nx_action_fin_timeout
*naft
= ofputil_put_NXAST_FIN_TIMEOUT(out
);
2351 naft
->fin_idle_timeout
= htons(fin_timeout
->fin_idle_timeout
);
2352 naft
->fin_hard_timeout
= htons(fin_timeout
->fin_hard_timeout
);
2356 ofpact_sample_to_nxast(const struct ofpact_sample
*os
,
2359 struct nx_action_sample
*nas
;
2361 nas
= ofputil_put_NXAST_SAMPLE(out
);
2362 nas
->probability
= htons(os
->probability
);
2363 nas
->collector_set_id
= htonl(os
->collector_set_id
);
2364 nas
->obs_domain_id
= htonl(os
->obs_domain_id
);
2365 nas
->obs_point_id
= htonl(os
->obs_point_id
);
2369 ofpact_to_nxast(const struct ofpact
*a
, struct ofpbuf
*out
)
2372 case OFPACT_CONTROLLER
:
2373 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a
), out
);
2376 case OFPACT_OUTPUT_REG
:
2377 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a
), out
);
2381 bundle_to_nxast(ofpact_get_BUNDLE(a
), out
);
2384 case OFPACT_REG_MOVE
:
2385 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a
), out
);
2388 case OFPACT_REG_LOAD
:
2389 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a
), out
);
2392 case OFPACT_STACK_PUSH
:
2393 nxm_stack_push_to_nxast(ofpact_get_STACK_PUSH(a
), out
);
2396 case OFPACT_STACK_POP
:
2397 nxm_stack_pop_to_nxast(ofpact_get_STACK_POP(a
), out
);
2400 case OFPACT_DEC_TTL
:
2401 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a
), out
);
2404 case OFPACT_SET_MPLS_LABEL
:
2405 ofputil_put_NXAST_SET_MPLS_LABEL(out
)->label
2406 = ofpact_get_SET_MPLS_LABEL(a
)->label
;
2409 case OFPACT_SET_MPLS_TC
:
2410 ofputil_put_NXAST_SET_MPLS_TC(out
)->tc
2411 = ofpact_get_SET_MPLS_TC(a
)->tc
;
2414 case OFPACT_SET_MPLS_TTL
:
2415 ofputil_put_NXAST_SET_MPLS_TTL(out
)->ttl
2416 = ofpact_get_SET_MPLS_TTL(a
)->ttl
;
2419 case OFPACT_DEC_MPLS_TTL
:
2420 ofputil_put_NXAST_DEC_MPLS_TTL(out
);
2423 case OFPACT_SET_TUNNEL
:
2424 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a
), out
);
2427 case OFPACT_WRITE_METADATA
:
2428 ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a
), out
);
2431 case OFPACT_SET_QUEUE
:
2432 ofputil_put_NXAST_SET_QUEUE(out
)->queue_id
2433 = htonl(ofpact_get_SET_QUEUE(a
)->queue_id
);
2436 case OFPACT_POP_QUEUE
:
2437 ofputil_put_NXAST_POP_QUEUE(out
);
2440 case OFPACT_FIN_TIMEOUT
:
2441 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a
), out
);
2444 case OFPACT_RESUBMIT
:
2445 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a
), out
);
2449 learn_to_nxast(ofpact_get_LEARN(a
), out
);
2452 case OFPACT_MULTIPATH
:
2453 multipath_to_nxast(ofpact_get_MULTIPATH(a
), out
);
2457 ofpact_note_to_nxast(ofpact_get_NOTE(a
), out
);
2461 ofputil_put_NXAST_EXIT(out
);
2464 case OFPACT_PUSH_MPLS
:
2465 ofputil_put_NXAST_PUSH_MPLS(out
)->ethertype
=
2466 ofpact_get_PUSH_MPLS(a
)->ethertype
;
2469 case OFPACT_POP_MPLS
:
2470 ofputil_put_NXAST_POP_MPLS(out
)->ethertype
=
2471 ofpact_get_POP_MPLS(a
)->ethertype
;
2475 ofpact_sample_to_nxast(ofpact_get_SAMPLE(a
), out
);
2480 case OFPACT_ENQUEUE
:
2481 case OFPACT_SET_VLAN_VID
:
2482 case OFPACT_SET_VLAN_PCP
:
2483 case OFPACT_STRIP_VLAN
:
2484 case OFPACT_PUSH_VLAN
:
2485 case OFPACT_SET_ETH_SRC
:
2486 case OFPACT_SET_ETH_DST
:
2487 case OFPACT_SET_IPV4_SRC
:
2488 case OFPACT_SET_IPV4_DST
:
2489 case OFPACT_SET_IP_DSCP
:
2490 case OFPACT_SET_IP_ECN
:
2491 case OFPACT_SET_IP_TTL
:
2492 case OFPACT_SET_L4_SRC_PORT
:
2493 case OFPACT_SET_L4_DST_PORT
:
2494 case OFPACT_WRITE_ACTIONS
:
2495 case OFPACT_CLEAR_ACTIONS
:
2496 case OFPACT_GOTO_TABLE
:
2498 case OFPACT_SET_FIELD
:
2503 /* Converting ofpacts to OpenFlow 1.0. */
2506 ofpact_output_to_openflow10(const struct ofpact_output
*output
,
2509 struct ofp10_action_output
*oao
;
2511 oao
= ofputil_put_OFPAT10_OUTPUT(out
);
2512 oao
->port
= htons(ofp_to_u16(output
->port
));
2513 oao
->max_len
= htons(output
->max_len
);
2517 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue
*enqueue
,
2520 struct ofp10_action_enqueue
*oae
;
2522 oae
= ofputil_put_OFPAT10_ENQUEUE(out
);
2523 oae
->port
= htons(ofp_to_u16(enqueue
->port
));
2524 oae
->queue_id
= htonl(enqueue
->queue
);
2528 ofpact_to_openflow10(const struct ofpact
*a
, struct ofpbuf
*out
)
2532 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a
), out
);
2535 case OFPACT_ENQUEUE
:
2536 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a
), out
);
2539 case OFPACT_SET_VLAN_VID
:
2540 ofputil_put_OFPAT10_SET_VLAN_VID(out
)->vlan_vid
2541 = htons(ofpact_get_SET_VLAN_VID(a
)->vlan_vid
);
2544 case OFPACT_SET_VLAN_PCP
:
2545 ofputil_put_OFPAT10_SET_VLAN_PCP(out
)->vlan_pcp
2546 = ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
;
2549 case OFPACT_STRIP_VLAN
:
2550 ofputil_put_OFPAT10_STRIP_VLAN(out
);
2553 case OFPACT_SET_ETH_SRC
:
2554 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out
)->dl_addr
,
2555 ofpact_get_SET_ETH_SRC(a
)->mac
, ETH_ADDR_LEN
);
2558 case OFPACT_SET_ETH_DST
:
2559 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out
)->dl_addr
,
2560 ofpact_get_SET_ETH_DST(a
)->mac
, ETH_ADDR_LEN
);
2563 case OFPACT_SET_IPV4_SRC
:
2564 ofputil_put_OFPAT10_SET_NW_SRC(out
)->nw_addr
2565 = ofpact_get_SET_IPV4_SRC(a
)->ipv4
;
2568 case OFPACT_SET_IPV4_DST
:
2569 ofputil_put_OFPAT10_SET_NW_DST(out
)->nw_addr
2570 = ofpact_get_SET_IPV4_DST(a
)->ipv4
;
2573 case OFPACT_SET_IP_DSCP
:
2574 ofputil_put_OFPAT10_SET_NW_TOS(out
)->nw_tos
2575 = ofpact_get_SET_IP_DSCP(a
)->dscp
;
2578 case OFPACT_SET_L4_SRC_PORT
:
2579 ofputil_put_OFPAT10_SET_TP_SRC(out
)->tp_port
2580 = htons(ofpact_get_SET_L4_SRC_PORT(a
)->port
);
2583 case OFPACT_SET_L4_DST_PORT
:
2584 ofputil_put_OFPAT10_SET_TP_DST(out
)->tp_port
2585 = htons(ofpact_get_SET_L4_DST_PORT(a
)->port
);
2588 case OFPACT_PUSH_VLAN
:
2589 /* PUSH is a side effect of a SET_VLAN_VID/PCP, which should
2590 * follow this action. */
2593 case OFPACT_SET_IP_ECN
:
2594 case OFPACT_SET_IP_TTL
:
2595 case OFPACT_CLEAR_ACTIONS
:
2596 case OFPACT_WRITE_ACTIONS
:
2597 case OFPACT_GOTO_TABLE
:
2605 case OFPACT_SET_FIELD
:
2606 set_field_to_openflow(ofpact_get_SET_FIELD(a
), out
);
2609 case OFPACT_CONTROLLER
:
2610 case OFPACT_OUTPUT_REG
:
2612 case OFPACT_REG_MOVE
:
2613 case OFPACT_REG_LOAD
:
2614 case OFPACT_STACK_PUSH
:
2615 case OFPACT_STACK_POP
:
2616 case OFPACT_DEC_TTL
:
2617 case OFPACT_SET_MPLS_LABEL
:
2618 case OFPACT_SET_MPLS_TC
:
2619 case OFPACT_SET_MPLS_TTL
:
2620 case OFPACT_DEC_MPLS_TTL
:
2621 case OFPACT_SET_TUNNEL
:
2622 case OFPACT_WRITE_METADATA
:
2623 case OFPACT_SET_QUEUE
:
2624 case OFPACT_POP_QUEUE
:
2625 case OFPACT_FIN_TIMEOUT
:
2626 case OFPACT_RESUBMIT
:
2628 case OFPACT_MULTIPATH
:
2631 case OFPACT_PUSH_MPLS
:
2632 case OFPACT_POP_MPLS
:
2634 ofpact_to_nxast(a
, out
);
2639 /* Converting ofpacts to OpenFlow 1.1. */
2642 ofpact_output_to_openflow11(const struct ofpact_output
*output
,
2645 struct ofp11_action_output
*oao
;
2647 oao
= ofputil_put_OFPAT11_OUTPUT(out
);
2648 oao
->port
= ofputil_port_to_ofp11(output
->port
);
2649 oao
->max_len
= htons(output
->max_len
);
2653 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids
*dec_ttl
,
2656 if (dec_ttl
->n_controllers
== 1 && dec_ttl
->cnt_ids
[0] == 0
2657 && (!dec_ttl
->ofpact
.compat
||
2658 dec_ttl
->ofpact
.compat
== OFPUTIL_OFPAT11_DEC_NW_TTL
)) {
2659 ofputil_put_OFPAT11_DEC_NW_TTL(out
);
2661 ofpact_dec_ttl_to_nxast(dec_ttl
, out
);
2666 ofpact_to_openflow11(const struct ofpact
*a
, struct ofpbuf
*out
)
2670 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a
), out
);
2672 case OFPACT_ENQUEUE
:
2676 case OFPACT_SET_VLAN_VID
:
2677 /* Push a VLAN tag, if one was not seen at action validation time. */
2678 if (!ofpact_get_SET_VLAN_VID(a
)->flow_has_vlan
2679 && ofpact_get_SET_VLAN_VID(a
)->push_vlan_if_needed
) {
2680 ofputil_put_OFPAT11_PUSH_VLAN(out
)->ethertype
2681 = htons(ETH_TYPE_VLAN_8021Q
);
2683 ofputil_put_OFPAT11_SET_VLAN_VID(out
)->vlan_vid
2684 = htons(ofpact_get_SET_VLAN_VID(a
)->vlan_vid
);
2687 case OFPACT_SET_VLAN_PCP
:
2688 /* Push a VLAN tag, if one was not seen at action validation time. */
2689 if (!ofpact_get_SET_VLAN_PCP(a
)->flow_has_vlan
2690 && ofpact_get_SET_VLAN_PCP(a
)->push_vlan_if_needed
) {
2691 ofputil_put_OFPAT11_PUSH_VLAN(out
)->ethertype
2692 = htons(ETH_TYPE_VLAN_8021Q
);
2694 ofputil_put_OFPAT11_SET_VLAN_PCP(out
)->vlan_pcp
2695 = ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
;
2698 case OFPACT_STRIP_VLAN
:
2699 ofputil_put_OFPAT11_POP_VLAN(out
);
2702 case OFPACT_PUSH_VLAN
:
2703 /* XXX ETH_TYPE_VLAN_8021AD case */
2704 ofputil_put_OFPAT11_PUSH_VLAN(out
)->ethertype
=
2705 htons(ETH_TYPE_VLAN_8021Q
);
2708 case OFPACT_SET_QUEUE
:
2709 ofputil_put_OFPAT11_SET_QUEUE(out
)->queue_id
2710 = htonl(ofpact_get_SET_QUEUE(a
)->queue_id
);
2713 case OFPACT_SET_ETH_SRC
:
2714 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out
)->dl_addr
,
2715 ofpact_get_SET_ETH_SRC(a
)->mac
, ETH_ADDR_LEN
);
2718 case OFPACT_SET_ETH_DST
:
2719 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out
)->dl_addr
,
2720 ofpact_get_SET_ETH_DST(a
)->mac
, ETH_ADDR_LEN
);
2723 case OFPACT_SET_IPV4_SRC
:
2724 ofputil_put_OFPAT11_SET_NW_SRC(out
)->nw_addr
2725 = ofpact_get_SET_IPV4_SRC(a
)->ipv4
;
2728 case OFPACT_SET_IPV4_DST
:
2729 ofputil_put_OFPAT11_SET_NW_DST(out
)->nw_addr
2730 = ofpact_get_SET_IPV4_DST(a
)->ipv4
;
2733 case OFPACT_SET_IP_DSCP
:
2734 ofputil_put_OFPAT11_SET_NW_TOS(out
)->nw_tos
2735 = ofpact_get_SET_IP_DSCP(a
)->dscp
;
2738 case OFPACT_SET_IP_ECN
:
2739 ofputil_put_OFPAT11_SET_NW_ECN(out
)->nw_ecn
2740 = ofpact_get_SET_IP_ECN(a
)->ecn
;
2743 case OFPACT_SET_IP_TTL
:
2744 ofputil_put_OFPAT11_SET_NW_TTL(out
)->nw_ttl
2745 = ofpact_get_SET_IP_TTL(a
)->ttl
;
2748 case OFPACT_SET_L4_SRC_PORT
:
2749 ofputil_put_OFPAT11_SET_TP_SRC(out
)->tp_port
2750 = htons(ofpact_get_SET_L4_SRC_PORT(a
)->port
);
2753 case OFPACT_SET_L4_DST_PORT
:
2754 ofputil_put_OFPAT11_SET_TP_DST(out
)->tp_port
2755 = htons(ofpact_get_SET_L4_DST_PORT(a
)->port
);
2758 case OFPACT_DEC_TTL
:
2759 ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a
), out
);
2762 case OFPACT_SET_MPLS_LABEL
:
2763 ofputil_put_OFPAT11_SET_MPLS_LABEL(out
)->mpls_label
2764 = ofpact_get_SET_MPLS_LABEL(a
)->label
;
2767 case OFPACT_SET_MPLS_TC
:
2768 ofputil_put_OFPAT11_SET_MPLS_TC(out
)->mpls_tc
2769 = ofpact_get_SET_MPLS_TC(a
)->tc
;
2772 case OFPACT_SET_MPLS_TTL
:
2773 ofputil_put_OFPAT11_SET_MPLS_TTL(out
)->mpls_ttl
2774 = ofpact_get_SET_MPLS_TTL(a
)->ttl
;
2777 case OFPACT_DEC_MPLS_TTL
:
2778 ofputil_put_OFPAT11_DEC_MPLS_TTL(out
);
2781 case OFPACT_WRITE_METADATA
:
2782 /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
2785 case OFPACT_PUSH_MPLS
:
2786 ofputil_put_OFPAT11_PUSH_MPLS(out
)->ethertype
=
2787 ofpact_get_PUSH_MPLS(a
)->ethertype
;
2790 case OFPACT_POP_MPLS
:
2791 ofputil_put_OFPAT11_POP_MPLS(out
)->ethertype
=
2792 ofpact_get_POP_MPLS(a
)->ethertype
;
2796 case OFPACT_CLEAR_ACTIONS
:
2797 case OFPACT_WRITE_ACTIONS
:
2798 case OFPACT_GOTO_TABLE
:
2803 ofputil_put_OFPAT11_GROUP(out
)->group_id
=
2804 htonl(ofpact_get_GROUP(a
)->group_id
);
2807 case OFPACT_SET_FIELD
:
2808 set_field_to_openflow(ofpact_get_SET_FIELD(a
), out
);
2811 case OFPACT_CONTROLLER
:
2812 case OFPACT_OUTPUT_REG
:
2814 case OFPACT_REG_MOVE
:
2815 case OFPACT_REG_LOAD
:
2816 case OFPACT_STACK_PUSH
:
2817 case OFPACT_STACK_POP
:
2818 case OFPACT_SET_TUNNEL
:
2819 case OFPACT_POP_QUEUE
:
2820 case OFPACT_FIN_TIMEOUT
:
2821 case OFPACT_RESUBMIT
:
2823 case OFPACT_MULTIPATH
:
2827 ofpact_to_nxast(a
, out
);
2832 /* Output deprecated set actions as set_field actions. */
2834 ofpact_to_openflow12(const struct ofpact
*a
, struct ofpbuf
*out
)
2836 enum mf_field_id field
;
2837 union mf_value value
;
2838 struct ofpact_l4_port
*l4port
;
2842 * Convert actions deprecated in OpenFlow 1.2 to Set Field actions,
2845 switch ((int)a
->type
) {
2846 case OFPACT_SET_VLAN_VID
:
2847 case OFPACT_SET_VLAN_PCP
:
2848 case OFPACT_SET_ETH_SRC
:
2849 case OFPACT_SET_ETH_DST
:
2850 case OFPACT_SET_IPV4_SRC
:
2851 case OFPACT_SET_IPV4_DST
:
2852 case OFPACT_SET_IP_DSCP
:
2853 case OFPACT_SET_IP_ECN
:
2854 case OFPACT_SET_L4_SRC_PORT
:
2855 case OFPACT_SET_L4_DST_PORT
:
2856 case OFPACT_SET_MPLS_LABEL
:
2857 case OFPACT_SET_MPLS_TC
:
2858 case OFPACT_SET_TUNNEL
: /* Convert to a set_field, too. */
2860 switch ((int)a
->type
) {
2862 case OFPACT_SET_VLAN_VID
:
2863 if (!ofpact_get_SET_VLAN_VID(a
)->flow_has_vlan
&&
2864 ofpact_get_SET_VLAN_VID(a
)->push_vlan_if_needed
) {
2865 ofputil_put_OFPAT11_PUSH_VLAN(out
)->ethertype
2866 = htons(ETH_TYPE_VLAN_8021Q
);
2868 field
= MFF_VLAN_VID
;
2869 /* Set-Field on OXM_OF_VLAN_VID must have OFPVID_PRESENT set. */
2870 value
.be16
= htons(ofpact_get_SET_VLAN_VID(a
)->vlan_vid
2871 | OFPVID12_PRESENT
);
2874 case OFPACT_SET_VLAN_PCP
:
2875 if (!ofpact_get_SET_VLAN_PCP(a
)->flow_has_vlan
&&
2876 ofpact_get_SET_VLAN_PCP(a
)->push_vlan_if_needed
) {
2877 ofputil_put_OFPAT11_PUSH_VLAN(out
)->ethertype
2878 = htons(ETH_TYPE_VLAN_8021Q
);
2880 field
= MFF_VLAN_PCP
;
2881 value
.u8
= ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
;
2884 case OFPACT_SET_ETH_SRC
:
2885 field
= MFF_ETH_SRC
;
2886 memcpy(value
.mac
, ofpact_get_SET_ETH_SRC(a
)->mac
, ETH_ADDR_LEN
);
2889 case OFPACT_SET_ETH_DST
:
2890 field
= MFF_ETH_DST
;
2891 memcpy(value
.mac
, ofpact_get_SET_ETH_DST(a
)->mac
, ETH_ADDR_LEN
);
2894 case OFPACT_SET_IPV4_SRC
:
2895 field
= MFF_IPV4_SRC
;
2896 value
.be32
= ofpact_get_SET_IPV4_SRC(a
)->ipv4
;
2899 case OFPACT_SET_IPV4_DST
:
2900 field
= MFF_IPV4_DST
;
2901 value
.be32
= ofpact_get_SET_IPV4_DST(a
)->ipv4
;
2904 case OFPACT_SET_IP_DSCP
:
2905 field
= MFF_IP_DSCP_SHIFTED
; /* OXM_OF_IP_DSCP */
2906 value
.u8
= ofpact_get_SET_IP_DSCP(a
)->dscp
>> 2;
2909 case OFPACT_SET_IP_ECN
:
2911 value
.u8
= ofpact_get_SET_IP_ECN(a
)->ecn
;
2914 case OFPACT_SET_L4_SRC_PORT
:
2915 /* We keep track of IP protocol while translating actions to be
2916 * able to translate to the proper OXM type.
2917 * If the IP protocol type is unknown, the translation cannot
2918 * be performed and we will send the action using the original
2920 l4port
= ofpact_get_SET_L4_SRC_PORT(a
);
2921 proto
= l4port
->flow_ip_proto
;
2922 field
= proto
== IPPROTO_TCP
? MFF_TCP_SRC
2923 : proto
== IPPROTO_UDP
? MFF_UDP_SRC
2924 : proto
== IPPROTO_SCTP
? MFF_SCTP_SRC
2925 : MFF_N_IDS
; /* RFC: Unknown IP proto, do not translate. */
2926 value
.be16
= htons(l4port
->port
);
2929 case OFPACT_SET_L4_DST_PORT
:
2930 l4port
= ofpact_get_SET_L4_DST_PORT(a
);
2931 proto
= l4port
->flow_ip_proto
;
2932 field
= proto
== IPPROTO_TCP
? MFF_TCP_DST
2933 : proto
== IPPROTO_UDP
? MFF_UDP_DST
2934 : proto
== IPPROTO_SCTP
? MFF_SCTP_DST
2935 : MFF_N_IDS
; /* RFC: Unknown IP proto, do not translate. */
2936 value
.be16
= htons(l4port
->port
);
2939 case OFPACT_SET_MPLS_LABEL
:
2940 field
= MFF_MPLS_LABEL
;
2941 value
.be32
= ofpact_get_SET_MPLS_LABEL(a
)->label
;
2944 case OFPACT_SET_MPLS_TC
:
2945 field
= MFF_MPLS_TC
;
2946 value
.u8
= ofpact_get_SET_MPLS_TC(a
)->tc
;
2949 case OFPACT_SET_TUNNEL
:
2951 value
.be64
= htonll(ofpact_get_SET_TUNNEL(a
)->tun_id
);
2958 /* Put the action out as a set field action, if possible. */
2959 if (field
< MFF_N_IDS
) {
2960 uint64_t ofpacts_stub
[128 / 8];
2961 struct ofpbuf sf_act
;
2962 struct ofpact_set_field
*sf
;
2964 ofpbuf_use_stub(&sf_act
, ofpacts_stub
, sizeof ofpacts_stub
);
2965 sf
= ofpact_put_SET_FIELD(&sf_act
);
2966 sf
->field
= mf_from_id(field
);
2967 memcpy(&sf
->value
, &value
, sf
->field
->n_bytes
);
2968 set_field_to_openflow(sf
, out
);
2973 ofpact_to_openflow11(a
, out
);
2976 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow
2977 * actions in 'openflow', appending the actions to any existing data in
2980 ofpacts_put_openflow_actions(const struct ofpact ofpacts
[], size_t ofpacts_len
,
2981 struct ofpbuf
*openflow
,
2982 enum ofp_version ofp_version
)
2984 const struct ofpact
*a
;
2985 size_t start_size
= ofpbuf_size(openflow
);
2987 void (*translate
)(const struct ofpact
*a
, struct ofpbuf
*out
) =
2988 (ofp_version
== OFP10_VERSION
) ? ofpact_to_openflow10
:
2989 (ofp_version
== OFP11_VERSION
) ? ofpact_to_openflow11
:
2990 ofpact_to_openflow12
;
2992 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
2993 translate(a
, openflow
);
2995 return ofpbuf_size(openflow
) - start_size
;
2999 ofpacts_update_instruction_actions(struct ofpbuf
*openflow
, size_t ofs
)
3001 struct ofp11_instruction_actions
*oia
;
3003 /* Update the instruction's length (or, if it's empty, delete it). */
3004 oia
= ofpbuf_at_assert(openflow
, ofs
, sizeof *oia
);
3005 if (ofpbuf_size(openflow
) > ofs
+ sizeof *oia
) {
3006 oia
->len
= htons(ofpbuf_size(openflow
) - ofs
);
3008 ofpbuf_set_size(openflow
, ofs
);
3013 ofpacts_put_openflow_instructions(const struct ofpact ofpacts
[],
3015 struct ofpbuf
*openflow
,
3016 enum ofp_version ofp_version
)
3018 const struct ofpact
*a
;
3020 ovs_assert(ofp_version
>= OFP11_VERSION
);
3022 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3023 switch (ovs_instruction_type_from_ofpact_type(a
->type
)) {
3024 case OVSINST_OFPIT11_CLEAR_ACTIONS
:
3025 instruction_put_OFPIT11_CLEAR_ACTIONS(openflow
);
3028 case OVSINST_OFPIT11_GOTO_TABLE
: {
3029 struct ofp11_instruction_goto_table
*oigt
;
3030 oigt
= instruction_put_OFPIT11_GOTO_TABLE(openflow
);
3031 oigt
->table_id
= ofpact_get_GOTO_TABLE(a
)->table_id
;
3032 memset(oigt
->pad
, 0, sizeof oigt
->pad
);
3036 case OVSINST_OFPIT11_WRITE_METADATA
: {
3037 const struct ofpact_metadata
*om
;
3038 struct ofp11_instruction_write_metadata
*oiwm
;
3040 om
= ofpact_get_WRITE_METADATA(a
);
3041 oiwm
= instruction_put_OFPIT11_WRITE_METADATA(openflow
);
3042 oiwm
->metadata
= om
->metadata
;
3043 oiwm
->metadata_mask
= om
->mask
;
3047 case OVSINST_OFPIT13_METER
:
3048 if (ofp_version
>= OFP13_VERSION
) {
3049 const struct ofpact_meter
*om
;
3050 struct ofp13_instruction_meter
*oim
;
3052 om
= ofpact_get_METER(a
);
3053 oim
= instruction_put_OFPIT13_METER(openflow
);
3054 oim
->meter_id
= htonl(om
->meter_id
);
3058 case OVSINST_OFPIT11_APPLY_ACTIONS
: {
3059 const size_t ofs
= ofpbuf_size(openflow
);
3060 const size_t ofpacts_len_left
=
3061 (uint8_t*)ofpact_end(ofpacts
, ofpacts_len
) - (uint8_t*)a
;
3062 const struct ofpact
*action
;
3063 const struct ofpact
*processed
= a
;
3065 instruction_put_OFPIT11_APPLY_ACTIONS(openflow
);
3066 OFPACT_FOR_EACH(action
, a
, ofpacts_len_left
) {
3067 if (ovs_instruction_type_from_ofpact_type(action
->type
)
3068 != OVSINST_OFPIT11_APPLY_ACTIONS
) {
3071 if (ofp_version
== OFP11_VERSION
) {
3072 ofpact_to_openflow11(action
, openflow
);
3074 ofpact_to_openflow12(action
, openflow
);
3078 ofpacts_update_instruction_actions(openflow
, ofs
);
3083 case OVSINST_OFPIT11_WRITE_ACTIONS
: {
3084 const size_t ofs
= ofpbuf_size(openflow
);
3085 const struct ofpact_nest
*on
;
3087 on
= ofpact_get_WRITE_ACTIONS(a
);
3088 instruction_put_OFPIT11_WRITE_ACTIONS(openflow
);
3089 ofpacts_put_openflow_actions(on
->actions
,
3090 ofpact_nest_get_action_len(on
),
3091 openflow
, ofp_version
);
3092 ofpacts_update_instruction_actions(openflow
, ofs
);
3100 /* Returns true if 'action' outputs to 'port', false otherwise. */
3102 ofpact_outputs_to_port(const struct ofpact
*ofpact
, ofp_port_t port
)
3104 switch (ofpact
->type
) {
3106 return ofpact_get_OUTPUT(ofpact
)->port
== port
;
3107 case OFPACT_ENQUEUE
:
3108 return ofpact_get_ENQUEUE(ofpact
)->port
== port
;
3109 case OFPACT_CONTROLLER
:
3110 return port
== OFPP_CONTROLLER
;
3112 case OFPACT_OUTPUT_REG
:
3114 case OFPACT_SET_VLAN_VID
:
3115 case OFPACT_SET_VLAN_PCP
:
3116 case OFPACT_STRIP_VLAN
:
3117 case OFPACT_PUSH_VLAN
:
3118 case OFPACT_SET_ETH_SRC
:
3119 case OFPACT_SET_ETH_DST
:
3120 case OFPACT_SET_IPV4_SRC
:
3121 case OFPACT_SET_IPV4_DST
:
3122 case OFPACT_SET_IP_DSCP
:
3123 case OFPACT_SET_IP_ECN
:
3124 case OFPACT_SET_IP_TTL
:
3125 case OFPACT_SET_L4_SRC_PORT
:
3126 case OFPACT_SET_L4_DST_PORT
:
3127 case OFPACT_REG_MOVE
:
3128 case OFPACT_REG_LOAD
:
3129 case OFPACT_SET_FIELD
:
3130 case OFPACT_STACK_PUSH
:
3131 case OFPACT_STACK_POP
:
3132 case OFPACT_DEC_TTL
:
3133 case OFPACT_SET_MPLS_LABEL
:
3134 case OFPACT_SET_MPLS_TC
:
3135 case OFPACT_SET_MPLS_TTL
:
3136 case OFPACT_DEC_MPLS_TTL
:
3137 case OFPACT_SET_TUNNEL
:
3138 case OFPACT_WRITE_METADATA
:
3139 case OFPACT_SET_QUEUE
:
3140 case OFPACT_POP_QUEUE
:
3141 case OFPACT_FIN_TIMEOUT
:
3142 case OFPACT_RESUBMIT
:
3144 case OFPACT_MULTIPATH
:
3147 case OFPACT_PUSH_MPLS
:
3148 case OFPACT_POP_MPLS
:
3150 case OFPACT_CLEAR_ACTIONS
:
3151 case OFPACT_WRITE_ACTIONS
:
3152 case OFPACT_GOTO_TABLE
:
3160 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
3161 * to 'port', false otherwise. */
3163 ofpacts_output_to_port(const struct ofpact
*ofpacts
, size_t ofpacts_len
,
3166 const struct ofpact
*a
;
3168 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3169 if (ofpact_outputs_to_port(a
, port
)) {
3177 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
3178 * to 'group', false otherwise. */
3180 ofpacts_output_to_group(const struct ofpact
*ofpacts
, size_t ofpacts_len
,
3183 const struct ofpact
*a
;
3185 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3186 if (a
->type
== OFPACT_GROUP
3187 && ofpact_get_GROUP(a
)->group_id
== group_id
) {
3196 ofpacts_equal(const struct ofpact
*a
, size_t a_len
,
3197 const struct ofpact
*b
, size_t b_len
)
3199 return a_len
== b_len
&& !memcmp(a
, b
, a_len
);
3202 /* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
3203 * 'ofpacts'. If found, returns its meter ID; if not, returns 0.
3205 * This function relies on the order of 'ofpacts' being correct (as checked by
3206 * ofpacts_verify()). */
3208 ofpacts_get_meter(const struct ofpact ofpacts
[], size_t ofpacts_len
)
3210 const struct ofpact
*a
;
3212 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3213 enum ovs_instruction_type inst
;
3215 inst
= ovs_instruction_type_from_ofpact_type(a
->type
);
3216 if (a
->type
== OFPACT_METER
) {
3217 return ofpact_get_METER(a
)->meter_id
;
3218 } else if (inst
> OVSINST_OFPIT13_METER
) {
3226 /* Formatting ofpacts. */
3229 print_note(const struct ofpact_note
*note
, struct ds
*string
)
3233 ds_put_cstr(string
, "note:");
3234 for (i
= 0; i
< note
->length
; i
++) {
3236 ds_put_char(string
, '.');
3238 ds_put_format(string
, "%02"PRIx8
, note
->data
[i
]);
3243 print_dec_ttl(const struct ofpact_cnt_ids
*ids
,
3248 ds_put_cstr(s
, "dec_ttl");
3249 if (ids
->ofpact
.compat
== OFPUTIL_NXAST_DEC_TTL_CNT_IDS
) {
3250 ds_put_cstr(s
, "(");
3251 for (i
= 0; i
< ids
->n_controllers
; i
++) {
3253 ds_put_cstr(s
, ",");
3255 ds_put_format(s
, "%"PRIu16
, ids
->cnt_ids
[i
]);
3257 ds_put_cstr(s
, ")");
3262 print_fin_timeout(const struct ofpact_fin_timeout
*fin_timeout
,
3265 ds_put_cstr(s
, "fin_timeout(");
3266 if (fin_timeout
->fin_idle_timeout
) {
3267 ds_put_format(s
, "idle_timeout=%"PRIu16
",",
3268 fin_timeout
->fin_idle_timeout
);
3270 if (fin_timeout
->fin_hard_timeout
) {
3271 ds_put_format(s
, "hard_timeout=%"PRIu16
",",
3272 fin_timeout
->fin_hard_timeout
);
3275 ds_put_char(s
, ')');
3279 ofpact_format(const struct ofpact
*a
, struct ds
*s
)
3281 const struct ofpact_enqueue
*enqueue
;
3282 const struct ofpact_resubmit
*resubmit
;
3283 const struct ofpact_controller
*controller
;
3284 const struct ofpact_metadata
*metadata
;
3285 const struct ofpact_tunnel
*tunnel
;
3286 const struct ofpact_sample
*sample
;
3287 const struct ofpact_set_field
*set_field
;
3288 const struct mf_field
*mf
;
3293 port
= ofpact_get_OUTPUT(a
)->port
;
3294 if (ofp_to_u16(port
) < ofp_to_u16(OFPP_MAX
)) {
3295 ds_put_format(s
, "output:%"PRIu16
, port
);
3297 ofputil_format_port(port
, s
);
3298 if (port
== OFPP_CONTROLLER
) {
3299 ds_put_format(s
, ":%"PRIu16
, ofpact_get_OUTPUT(a
)->max_len
);
3304 case OFPACT_CONTROLLER
:
3305 controller
= ofpact_get_CONTROLLER(a
);
3306 if (controller
->reason
== OFPR_ACTION
&&
3307 controller
->controller_id
== 0) {
3308 ds_put_format(s
, "CONTROLLER:%"PRIu16
,
3309 ofpact_get_CONTROLLER(a
)->max_len
);
3311 enum ofp_packet_in_reason reason
= controller
->reason
;
3313 ds_put_cstr(s
, "controller(");
3314 if (reason
!= OFPR_ACTION
) {
3315 char reasonbuf
[OFPUTIL_PACKET_IN_REASON_BUFSIZE
];
3317 ds_put_format(s
, "reason=%s,",
3318 ofputil_packet_in_reason_to_string(
3319 reason
, reasonbuf
, sizeof reasonbuf
));
3321 if (controller
->max_len
!= UINT16_MAX
) {
3322 ds_put_format(s
, "max_len=%"PRIu16
",", controller
->max_len
);
3324 if (controller
->controller_id
!= 0) {
3325 ds_put_format(s
, "id=%"PRIu16
",", controller
->controller_id
);
3328 ds_put_char(s
, ')');
3332 case OFPACT_ENQUEUE
:
3333 enqueue
= ofpact_get_ENQUEUE(a
);
3334 ds_put_format(s
, "enqueue:");
3335 ofputil_format_port(enqueue
->port
, s
);
3336 ds_put_format(s
, ":%"PRIu32
, enqueue
->queue
);
3339 case OFPACT_OUTPUT_REG
:
3340 ds_put_cstr(s
, "output:");
3341 mf_format_subfield(&ofpact_get_OUTPUT_REG(a
)->src
, s
);
3345 bundle_format(ofpact_get_BUNDLE(a
), s
);
3348 case OFPACT_SET_VLAN_VID
:
3349 ds_put_format(s
, "%s:%"PRIu16
,
3350 (a
->compat
== OFPUTIL_OFPAT11_SET_VLAN_VID
3353 ofpact_get_SET_VLAN_VID(a
)->vlan_vid
);
3356 case OFPACT_SET_VLAN_PCP
:
3357 ds_put_format(s
, "%s:%"PRIu8
,
3358 (a
->compat
== OFPUTIL_OFPAT11_SET_VLAN_PCP
3361 ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
);
3364 case OFPACT_STRIP_VLAN
:
3365 ds_put_cstr(s
, a
->compat
== OFPUTIL_OFPAT11_POP_VLAN
3366 ? "pop_vlan" : "strip_vlan");
3369 case OFPACT_PUSH_VLAN
:
3370 /* XXX 802.1AD case*/
3371 ds_put_format(s
, "push_vlan:%#"PRIx16
, ETH_TYPE_VLAN_8021Q
);
3374 case OFPACT_SET_ETH_SRC
:
3375 ds_put_format(s
, "mod_dl_src:"ETH_ADDR_FMT
,
3376 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a
)->mac
));
3379 case OFPACT_SET_ETH_DST
:
3380 ds_put_format(s
, "mod_dl_dst:"ETH_ADDR_FMT
,
3381 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a
)->mac
));
3384 case OFPACT_SET_IPV4_SRC
:
3385 ds_put_format(s
, "mod_nw_src:"IP_FMT
,
3386 IP_ARGS(ofpact_get_SET_IPV4_SRC(a
)->ipv4
));
3389 case OFPACT_SET_IPV4_DST
:
3390 ds_put_format(s
, "mod_nw_dst:"IP_FMT
,
3391 IP_ARGS(ofpact_get_SET_IPV4_DST(a
)->ipv4
));
3394 case OFPACT_SET_IP_DSCP
:
3395 ds_put_format(s
, "mod_nw_tos:%d", ofpact_get_SET_IP_DSCP(a
)->dscp
);
3398 case OFPACT_SET_IP_ECN
:
3399 ds_put_format(s
, "mod_nw_ecn:%d", ofpact_get_SET_IP_ECN(a
)->ecn
);
3402 case OFPACT_SET_IP_TTL
:
3403 ds_put_format(s
, "mod_nw_ttl:%d", ofpact_get_SET_IP_TTL(a
)->ttl
);
3406 case OFPACT_SET_L4_SRC_PORT
:
3407 ds_put_format(s
, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a
)->port
);
3410 case OFPACT_SET_L4_DST_PORT
:
3411 ds_put_format(s
, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a
)->port
);
3414 case OFPACT_REG_MOVE
:
3415 nxm_format_reg_move(ofpact_get_REG_MOVE(a
), s
);
3418 case OFPACT_REG_LOAD
:
3419 nxm_format_reg_load(ofpact_get_REG_LOAD(a
), s
);
3422 case OFPACT_SET_FIELD
:
3423 set_field
= ofpact_get_SET_FIELD(a
);
3424 mf
= set_field
->field
;
3425 ds_put_format(s
, "set_field:");
3426 mf_format(mf
, &set_field
->value
, NULL
, s
);
3427 ds_put_format(s
, "->%s", mf
->name
);
3430 case OFPACT_STACK_PUSH
:
3431 nxm_format_stack_push(ofpact_get_STACK_PUSH(a
), s
);
3434 case OFPACT_STACK_POP
:
3435 nxm_format_stack_pop(ofpact_get_STACK_POP(a
), s
);
3438 case OFPACT_DEC_TTL
:
3439 print_dec_ttl(ofpact_get_DEC_TTL(a
), s
);
3442 case OFPACT_SET_MPLS_LABEL
:
3443 ds_put_format(s
, "set_mpls_label(%"PRIu32
")",
3444 ntohl(ofpact_get_SET_MPLS_LABEL(a
)->label
));
3447 case OFPACT_SET_MPLS_TC
:
3448 ds_put_format(s
, "set_mpls_ttl(%"PRIu8
")",
3449 ofpact_get_SET_MPLS_TC(a
)->tc
);
3452 case OFPACT_SET_MPLS_TTL
:
3453 ds_put_format(s
, "set_mpls_ttl(%"PRIu8
")",
3454 ofpact_get_SET_MPLS_TTL(a
)->ttl
);
3457 case OFPACT_DEC_MPLS_TTL
:
3458 ds_put_cstr(s
, "dec_mpls_ttl");
3461 case OFPACT_SET_TUNNEL
:
3462 tunnel
= ofpact_get_SET_TUNNEL(a
);
3463 ds_put_format(s
, "set_tunnel%s:%#"PRIx64
,
3464 (tunnel
->tun_id
> UINT32_MAX
3465 || a
->compat
== OFPUTIL_NXAST_SET_TUNNEL64
? "64" : ""),
3469 case OFPACT_SET_QUEUE
:
3470 ds_put_format(s
, "set_queue:%"PRIu32
,
3471 ofpact_get_SET_QUEUE(a
)->queue_id
);
3474 case OFPACT_POP_QUEUE
:
3475 ds_put_cstr(s
, "pop_queue");
3478 case OFPACT_FIN_TIMEOUT
:
3479 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a
), s
);
3482 case OFPACT_RESUBMIT
:
3483 resubmit
= ofpact_get_RESUBMIT(a
);
3484 if (resubmit
->in_port
!= OFPP_IN_PORT
&& resubmit
->table_id
== 255) {
3485 ds_put_cstr(s
, "resubmit:");
3486 ofputil_format_port(resubmit
->in_port
, s
);
3488 ds_put_format(s
, "resubmit(");
3489 if (resubmit
->in_port
!= OFPP_IN_PORT
) {
3490 ofputil_format_port(resubmit
->in_port
, s
);
3492 ds_put_char(s
, ',');
3493 if (resubmit
->table_id
!= 255) {
3494 ds_put_format(s
, "%"PRIu8
, resubmit
->table_id
);
3496 ds_put_char(s
, ')');
3501 learn_format(ofpact_get_LEARN(a
), s
);
3504 case OFPACT_MULTIPATH
:
3505 multipath_format(ofpact_get_MULTIPATH(a
), s
);
3509 print_note(ofpact_get_NOTE(a
), s
);
3512 case OFPACT_PUSH_MPLS
:
3513 ds_put_format(s
, "push_mpls:0x%04"PRIx16
,
3514 ntohs(ofpact_get_PUSH_MPLS(a
)->ethertype
));
3517 case OFPACT_POP_MPLS
:
3518 ds_put_format(s
, "pop_mpls:0x%04"PRIx16
,
3519 ntohs(ofpact_get_POP_MPLS(a
)->ethertype
));
3523 ds_put_cstr(s
, "exit");
3527 sample
= ofpact_get_SAMPLE(a
);
3529 s
, "sample(probability=%"PRIu16
",collector_set_id=%"PRIu32
3530 ",obs_domain_id=%"PRIu32
",obs_point_id=%"PRIu32
")",
3531 sample
->probability
, sample
->collector_set_id
,
3532 sample
->obs_domain_id
, sample
->obs_point_id
);
3535 case OFPACT_WRITE_ACTIONS
: {
3536 struct ofpact_nest
*on
= ofpact_get_WRITE_ACTIONS(a
);
3537 ds_put_format(s
, "%s(",
3538 ovs_instruction_name_from_type(
3539 OVSINST_OFPIT11_WRITE_ACTIONS
));
3540 ofpacts_format(on
->actions
, ofpact_nest_get_action_len(on
), s
);
3541 ds_put_char(s
, ')');
3545 case OFPACT_CLEAR_ACTIONS
:
3546 ds_put_format(s
, "%s",
3547 ovs_instruction_name_from_type(
3548 OVSINST_OFPIT11_CLEAR_ACTIONS
));
3551 case OFPACT_WRITE_METADATA
:
3552 metadata
= ofpact_get_WRITE_METADATA(a
);
3553 ds_put_format(s
, "%s:%#"PRIx64
,
3554 ovs_instruction_name_from_type(
3555 OVSINST_OFPIT11_WRITE_METADATA
),
3556 ntohll(metadata
->metadata
));
3557 if (metadata
->mask
!= OVS_BE64_MAX
) {
3558 ds_put_format(s
, "/%#"PRIx64
, ntohll(metadata
->mask
));
3562 case OFPACT_GOTO_TABLE
:
3563 ds_put_format(s
, "%s:%"PRIu8
,
3564 ovs_instruction_name_from_type(
3565 OVSINST_OFPIT11_GOTO_TABLE
),
3566 ofpact_get_GOTO_TABLE(a
)->table_id
);
3570 ds_put_format(s
, "%s:%"PRIu32
,
3571 ovs_instruction_name_from_type(OVSINST_OFPIT13_METER
),
3572 ofpact_get_METER(a
)->meter_id
);
3576 ds_put_format(s
, "group:%"PRIu32
,
3577 ofpact_get_GROUP(a
)->group_id
);
3582 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
3583 * 'ofpacts' to 'string'. */
3585 ofpacts_format(const struct ofpact
*ofpacts
, size_t ofpacts_len
,
3589 ds_put_cstr(string
, "drop");
3591 const struct ofpact
*a
;
3593 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3595 ds_put_cstr(string
, ",");
3598 /* XXX write-actions */
3599 ofpact_format(a
, string
);
3604 /* Internal use by helpers. */
3607 ofpact_put(struct ofpbuf
*ofpacts
, enum ofpact_type type
, size_t len
)
3609 struct ofpact
*ofpact
;
3611 ofpact_pad(ofpacts
);
3612 ofpact
= ofpacts
->frame
= ofpbuf_put_uninit(ofpacts
, len
);
3613 ofpact_init(ofpact
, type
, len
);
3618 ofpact_init(struct ofpact
*ofpact
, enum ofpact_type type
, size_t len
)
3620 memset(ofpact
, 0, len
);
3621 ofpact
->type
= type
;
3622 ofpact
->compat
= OFPUTIL_ACTION_INVALID
;
3626 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
3627 * starting at 'ofpact'.
3629 * This is the correct way to update a variable-length ofpact's length after
3630 * adding the variable-length part of the payload. (See the large comment
3631 * near the end of ofp-actions.h for more information.) */
3633 ofpact_update_len(struct ofpbuf
*ofpacts
, struct ofpact
*ofpact
)
3635 ovs_assert(ofpact
== ofpacts
->frame
);
3636 ofpact
->len
= (char *) ofpbuf_tail(ofpacts
) - (char *) ofpact
;
3639 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
3640 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
3641 * client must call this itself after adding the final ofpact to an array of
3644 * (The consequences of failing to call this function are probably not dire.
3645 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
3646 * not dereference it. That's undefined behavior, technically, but it will not
3647 * cause a real problem on common systems. Still, it seems better to call
3650 ofpact_pad(struct ofpbuf
*ofpacts
)
3652 unsigned int pad
= PAD_SIZE(ofpbuf_size(ofpacts
), OFPACT_ALIGNTO
);
3654 ofpbuf_put_zeros(ofpacts
, pad
);