2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "ofp-actions.h"
21 #include "byte-order.h"
23 #include "dynamic-string.h"
25 #include "meta-flow.h"
26 #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. */
39 output_from_openflow10(const struct ofp10_action_output
*oao
,
42 struct ofpact_output
*output
;
44 output
= ofpact_put_OUTPUT(out
);
45 output
->port
= ntohs(oao
->port
);
46 output
->max_len
= ntohs(oao
->max_len
);
48 return ofputil_check_output_port(output
->port
, OFPP_MAX
);
52 enqueue_from_openflow10(const struct ofp_action_enqueue
*oae
,
55 struct ofpact_enqueue
*enqueue
;
57 enqueue
= ofpact_put_ENQUEUE(out
);
58 enqueue
->port
= ntohs(oae
->port
);
59 enqueue
->queue
= ntohl(oae
->queue_id
);
60 if (enqueue
->port
>= OFPP_MAX
&& enqueue
->port
!= OFPP_IN_PORT
61 && enqueue
->port
!= OFPP_LOCAL
) {
62 return OFPERR_OFPBAC_BAD_OUT_PORT
;
68 resubmit_from_openflow(const struct nx_action_resubmit
*nar
,
71 struct ofpact_resubmit
*resubmit
;
73 resubmit
= ofpact_put_RESUBMIT(out
);
74 resubmit
->ofpact
.compat
= OFPUTIL_NXAST_RESUBMIT
;
75 resubmit
->in_port
= ntohs(nar
->in_port
);
76 resubmit
->table_id
= 0xff;
80 resubmit_table_from_openflow(const struct nx_action_resubmit
*nar
,
83 struct ofpact_resubmit
*resubmit
;
85 if (nar
->pad
[0] || nar
->pad
[1] || nar
->pad
[2]) {
86 return OFPERR_OFPBAC_BAD_ARGUMENT
;
89 resubmit
= ofpact_put_RESUBMIT(out
);
90 resubmit
->ofpact
.compat
= OFPUTIL_NXAST_RESUBMIT_TABLE
;
91 resubmit
->in_port
= ntohs(nar
->in_port
);
92 resubmit
->table_id
= nar
->table
;
97 output_reg_from_openflow(const struct nx_action_output_reg
*naor
,
100 struct ofpact_output_reg
*output_reg
;
102 if (!is_all_zeros(naor
->zero
, sizeof naor
->zero
)) {
103 return OFPERR_OFPBAC_BAD_ARGUMENT
;
106 output_reg
= ofpact_put_OUTPUT_REG(out
);
107 output_reg
->src
.field
= mf_from_nxm_header(ntohl(naor
->src
));
108 output_reg
->src
.ofs
= nxm_decode_ofs(naor
->ofs_nbits
);
109 output_reg
->src
.n_bits
= nxm_decode_n_bits(naor
->ofs_nbits
);
110 output_reg
->max_len
= ntohs(naor
->max_len
);
112 return mf_check_src(&output_reg
->src
, NULL
);
116 fin_timeout_from_openflow(const struct nx_action_fin_timeout
*naft
,
119 struct ofpact_fin_timeout
*oft
;
121 oft
= ofpact_put_FIN_TIMEOUT(out
);
122 oft
->fin_idle_timeout
= ntohs(naft
->fin_idle_timeout
);
123 oft
->fin_hard_timeout
= ntohs(naft
->fin_hard_timeout
);
127 controller_from_openflow(const struct nx_action_controller
*nac
,
130 struct ofpact_controller
*oc
;
132 oc
= ofpact_put_CONTROLLER(out
);
133 oc
->max_len
= ntohs(nac
->max_len
);
134 oc
->controller_id
= ntohs(nac
->controller_id
);
135 oc
->reason
= nac
->reason
;
139 note_from_openflow(const struct nx_action_note
*nan
, struct ofpbuf
*out
)
141 struct ofpact_note
*note
;
144 length
= ntohs(nan
->len
) - offsetof(struct nx_action_note
, note
);
145 note
= ofpact_put(out
, OFPACT_NOTE
,
146 offsetof(struct ofpact_note
, data
) + length
);
147 note
->length
= length
;
148 memcpy(note
->data
, nan
->note
, length
);
152 dec_ttl_from_openflow(struct ofpbuf
*out
)
155 struct ofpact_cnt_ids
*ids
;
156 enum ofperr error
= 0;
158 ids
= ofpact_put_DEC_TTL(out
);
159 ids
->ofpact
.compat
= OFPUTIL_NXAST_DEC_TTL
;
160 ids
->n_controllers
= 1;
161 ofpbuf_put(out
, &id
, sizeof id
);
163 ofpact_update_len(out
, &ids
->ofpact
);
168 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids
*nac_ids
,
171 struct ofpact_cnt_ids
*ids
;
175 ids
= ofpact_put_DEC_TTL(out
);
176 ids
->ofpact
.compat
= OFPUTIL_NXAST_DEC_TTL_CNT_IDS
;
177 ids
->n_controllers
= ntohs(nac_ids
->n_controllers
);
178 ids_size
= ntohs(nac_ids
->len
) - sizeof *nac_ids
;
180 if (!is_all_zeros(nac_ids
->zeros
, sizeof nac_ids
->zeros
)) {
181 return OFPERR_NXBRC_MUST_BE_ZERO
;
184 if (ids_size
< ids
->n_controllers
* sizeof(ovs_be16
)) {
185 VLOG_WARN_RL(&rl
, "Nicira action dec_ttl_cnt_ids only has %zu bytes "
186 "allocated for controller ids. %zu bytes are required for "
187 "%"PRIu16
" controllers.", ids_size
,
188 ids
->n_controllers
* sizeof(ovs_be16
), ids
->n_controllers
);
189 return OFPERR_OFPBAC_BAD_LEN
;
192 for (i
= 0; i
< ids
->n_controllers
; i
++) {
193 uint16_t id
= ntohs(((ovs_be16
*)(nac_ids
+ 1))[i
]);
194 ofpbuf_put(out
, &id
, sizeof id
);
198 ofpact_update_len(out
, &ids
->ofpact
);
204 decode_nxast_action(const union ofp_action
*a
, enum ofputil_action_code
*code
)
206 const struct nx_action_header
*nah
= (const struct nx_action_header
*) a
;
207 uint16_t len
= ntohs(a
->header
.len
);
209 if (len
< sizeof(struct nx_action_header
)) {
210 return OFPERR_OFPBAC_BAD_LEN
;
211 } else if (a
->vendor
.vendor
!= CONSTANT_HTONL(NX_VENDOR_ID
)) {
212 return OFPERR_OFPBAC_BAD_VENDOR
;
215 switch (nah
->subtype
) {
216 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
217 case CONSTANT_HTONS(ENUM): \
219 ? len >= sizeof(struct STRUCT) \
220 : len == sizeof(struct STRUCT)) { \
221 *code = OFPUTIL_##ENUM; \
224 return OFPERR_OFPBAC_BAD_LEN; \
227 #include "ofp-util.def"
229 case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE
):
230 case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE
):
232 return OFPERR_OFPBAC_BAD_TYPE
;
236 /* Parses 'a' to determine its type. On success stores the correct type into
237 * '*code' and returns 0. On failure returns an OFPERR_* error code and
238 * '*code' is indeterminate.
240 * The caller must have already verified that 'a''s length is potentially
241 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
242 * ofp_action) and no longer than the amount of space allocated to 'a').
244 * This function verifies that 'a''s length is correct for the type of action
245 * that it represents. */
247 decode_openflow10_action(const union ofp_action
*a
,
248 enum ofputil_action_code
*code
)
251 case CONSTANT_HTONS(OFPAT10_VENDOR
):
252 return decode_nxast_action(a
, code
);
254 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
255 case CONSTANT_HTONS(ENUM): \
256 if (a->header.len == htons(sizeof(struct STRUCT))) { \
257 *code = OFPUTIL_##ENUM; \
260 return OFPERR_OFPBAC_BAD_LEN; \
263 #include "ofp-util.def"
266 return OFPERR_OFPBAC_BAD_TYPE
;
271 ofpact_from_nxast(const union ofp_action
*a
, enum ofputil_action_code code
,
274 const struct nx_action_resubmit
*nar
;
275 const struct nx_action_set_tunnel
*nast
;
276 const struct nx_action_set_queue
*nasq
;
277 const struct nx_action_note
*nan
;
278 const struct nx_action_set_tunnel64
*nast64
;
279 struct ofpact_tunnel
*tunnel
;
280 enum ofperr error
= 0;
283 case OFPUTIL_ACTION_INVALID
:
284 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
285 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
286 #include "ofp-util.def"
289 case OFPUTIL_NXAST_RESUBMIT
:
290 resubmit_from_openflow((const struct nx_action_resubmit
*) a
, out
);
293 case OFPUTIL_NXAST_SET_TUNNEL
:
294 nast
= (const struct nx_action_set_tunnel
*) a
;
295 tunnel
= ofpact_put_SET_TUNNEL(out
);
296 tunnel
->ofpact
.compat
= code
;
297 tunnel
->tun_id
= ntohl(nast
->tun_id
);
300 case OFPUTIL_NXAST_SET_QUEUE
:
301 nasq
= (const struct nx_action_set_queue
*) a
;
302 ofpact_put_SET_QUEUE(out
)->queue_id
= ntohl(nasq
->queue_id
);
305 case OFPUTIL_NXAST_POP_QUEUE
:
306 ofpact_put_POP_QUEUE(out
);
309 case OFPUTIL_NXAST_REG_MOVE
:
310 error
= nxm_reg_move_from_openflow(
311 (const struct nx_action_reg_move
*) a
, out
);
314 case OFPUTIL_NXAST_REG_LOAD
:
315 error
= nxm_reg_load_from_openflow(
316 (const struct nx_action_reg_load
*) a
, out
);
319 case OFPUTIL_NXAST_NOTE
:
320 nan
= (const struct nx_action_note
*) a
;
321 note_from_openflow(nan
, out
);
324 case OFPUTIL_NXAST_SET_TUNNEL64
:
325 nast64
= (const struct nx_action_set_tunnel64
*) a
;
326 tunnel
= ofpact_put_SET_TUNNEL(out
);
327 tunnel
->ofpact
.compat
= code
;
328 tunnel
->tun_id
= ntohll(nast64
->tun_id
);
331 case OFPUTIL_NXAST_MULTIPATH
:
332 error
= multipath_from_openflow((const struct nx_action_multipath
*) a
,
333 ofpact_put_MULTIPATH(out
));
336 case OFPUTIL_NXAST_AUTOPATH__DEPRECATED
:
337 error
= autopath_from_openflow((const struct nx_action_autopath
*) a
,
338 ofpact_put_AUTOPATH(out
));
341 case OFPUTIL_NXAST_BUNDLE
:
342 case OFPUTIL_NXAST_BUNDLE_LOAD
:
343 error
= bundle_from_openflow((const struct nx_action_bundle
*) a
, out
);
346 case OFPUTIL_NXAST_OUTPUT_REG
:
347 error
= output_reg_from_openflow(
348 (const struct nx_action_output_reg
*) a
, out
);
351 case OFPUTIL_NXAST_RESUBMIT_TABLE
:
352 nar
= (const struct nx_action_resubmit
*) a
;
353 error
= resubmit_table_from_openflow(nar
, out
);
356 case OFPUTIL_NXAST_LEARN
:
357 error
= learn_from_openflow((const struct nx_action_learn
*) a
, out
);
360 case OFPUTIL_NXAST_EXIT
:
361 ofpact_put_EXIT(out
);
364 case OFPUTIL_NXAST_DEC_TTL
:
365 error
= dec_ttl_from_openflow(out
);
368 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS
:
369 error
= dec_ttl_cnt_ids_from_openflow(
370 (const struct nx_action_cnt_ids
*) a
, out
);
373 case OFPUTIL_NXAST_FIN_TIMEOUT
:
374 fin_timeout_from_openflow(
375 (const struct nx_action_fin_timeout
*) a
, out
);
378 case OFPUTIL_NXAST_CONTROLLER
:
379 controller_from_openflow((const struct nx_action_controller
*) a
, out
);
387 ofpact_from_openflow10(const union ofp_action
*a
, struct ofpbuf
*out
)
389 enum ofputil_action_code code
;
392 error
= decode_openflow10_action(a
, &code
);
398 case OFPUTIL_ACTION_INVALID
:
399 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
400 #include "ofp-util.def"
403 case OFPUTIL_OFPAT10_OUTPUT
:
404 return output_from_openflow10(&a
->output10
, out
);
406 case OFPUTIL_OFPAT10_SET_VLAN_VID
:
407 if (a
->vlan_vid
.vlan_vid
& ~htons(0xfff)) {
408 return OFPERR_OFPBAC_BAD_ARGUMENT
;
410 ofpact_put_SET_VLAN_VID(out
)->vlan_vid
= ntohs(a
->vlan_vid
.vlan_vid
);
413 case OFPUTIL_OFPAT10_SET_VLAN_PCP
:
414 if (a
->vlan_pcp
.vlan_pcp
& ~7) {
415 return OFPERR_OFPBAC_BAD_ARGUMENT
;
417 ofpact_put_SET_VLAN_PCP(out
)->vlan_pcp
= a
->vlan_pcp
.vlan_pcp
;
420 case OFPUTIL_OFPAT10_STRIP_VLAN
:
421 ofpact_put_STRIP_VLAN(out
);
424 case OFPUTIL_OFPAT10_SET_DL_SRC
:
425 memcpy(ofpact_put_SET_ETH_SRC(out
)->mac
,
426 ((const struct ofp_action_dl_addr
*) a
)->dl_addr
, ETH_ADDR_LEN
);
429 case OFPUTIL_OFPAT10_SET_DL_DST
:
430 memcpy(ofpact_put_SET_ETH_DST(out
)->mac
,
431 ((const struct ofp_action_dl_addr
*) a
)->dl_addr
, ETH_ADDR_LEN
);
434 case OFPUTIL_OFPAT10_SET_NW_SRC
:
435 ofpact_put_SET_IPV4_SRC(out
)->ipv4
= a
->nw_addr
.nw_addr
;
438 case OFPUTIL_OFPAT10_SET_NW_DST
:
439 ofpact_put_SET_IPV4_DST(out
)->ipv4
= a
->nw_addr
.nw_addr
;
442 case OFPUTIL_OFPAT10_SET_NW_TOS
:
443 if (a
->nw_tos
.nw_tos
& ~IP_DSCP_MASK
) {
444 return OFPERR_OFPBAC_BAD_ARGUMENT
;
446 ofpact_put_SET_IPV4_DSCP(out
)->dscp
= a
->nw_tos
.nw_tos
;
449 case OFPUTIL_OFPAT10_SET_TP_SRC
:
450 ofpact_put_SET_L4_SRC_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
453 case OFPUTIL_OFPAT10_SET_TP_DST
:
454 ofpact_put_SET_L4_DST_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
458 case OFPUTIL_OFPAT10_ENQUEUE
:
459 error
= enqueue_from_openflow10((const struct ofp_action_enqueue
*) a
,
463 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
464 #include "ofp-util.def"
465 return ofpact_from_nxast(a
, code
, out
);
471 static inline union ofp_action
*
472 action_next(const union ofp_action
*a
)
474 return ((union ofp_action
*) (void *)
475 ((uint8_t *) a
+ ntohs(a
->header
.len
)));
479 action_is_valid(const union ofp_action
*a
, size_t n_actions
)
481 uint16_t len
= ntohs(a
->header
.len
);
482 return (!(len
% OFP_ACTION_ALIGN
)
484 && len
/ sizeof *a
<= n_actions
);
487 /* This macro is careful to check for actions with bad lengths. */
488 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
489 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
490 (LEFT) > 0 && action_is_valid(ITER, LEFT); \
491 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
492 (ITER) = action_next(ITER)))
495 log_bad_action(const union ofp_action
*actions
, size_t n_actions
, size_t ofs
,
498 if (!VLOG_DROP_WARN(&rl
)) {
502 ds_put_hex_dump(&s
, actions
, n_actions
* sizeof *actions
, 0, false);
503 VLOG_WARN("bad action at offset %#zx (%s):\n%s",
504 ofs
* sizeof *actions
, ofperr_get_name(error
), ds_cstr(&s
));
510 ofpacts_from_openflow(const union ofp_action
*in
, size_t n_in
,
512 enum ofperr (*ofpact_from_openflow
)(
513 const union ofp_action
*a
, struct ofpbuf
*out
))
515 const union ofp_action
*a
;
518 ACTION_FOR_EACH (a
, left
, in
, n_in
) {
519 enum ofperr error
= ofpact_from_openflow(a
, out
);
521 log_bad_action(in
, n_in
, a
- in
, error
);
526 enum ofperr error
= OFPERR_OFPBAC_BAD_LEN
;
527 log_bad_action(in
, n_in
, n_in
- left
, error
);
536 ofpacts_from_openflow10(const union ofp_action
*in
, size_t n_in
,
539 return ofpacts_from_openflow(in
, n_in
, out
, ofpact_from_openflow10
);
543 ofpacts_pull_actions(struct ofpbuf
*openflow
, unsigned int actions_len
,
544 struct ofpbuf
*ofpacts
,
545 enum ofperr (*translate
)(const union ofp_action
*actions
,
547 struct ofpbuf
*ofpacts
))
549 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
550 const union ofp_action
*actions
;
553 ofpbuf_clear(ofpacts
);
555 if (actions_len
% OFP_ACTION_ALIGN
!= 0) {
556 VLOG_WARN_RL(&rl
, "OpenFlow message actions length %u is not a "
557 "multiple of %d", actions_len
, OFP_ACTION_ALIGN
);
558 return OFPERR_OFPBRC_BAD_LEN
;
561 actions
= ofpbuf_try_pull(openflow
, actions_len
);
562 if (actions
== NULL
) {
563 VLOG_WARN_RL(&rl
, "OpenFlow message actions length %u exceeds "
564 "remaining message length (%zu)",
565 actions_len
, openflow
->size
);
566 return OFPERR_OFPBRC_BAD_LEN
;
569 error
= translate(actions
, actions_len
/ OFP_ACTION_ALIGN
, ofpacts
);
571 ofpbuf_clear(ofpacts
);
576 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.0 actions from the
577 * front of 'openflow' into ofpacts. On success, replaces any existing content
578 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
579 * Returns 0 if successful, otherwise an OpenFlow error.
581 * The parsed actions are valid generically, but they may not be valid in a
582 * specific context. For example, port numbers up to OFPP_MAX are valid
583 * generically, but specific datapaths may only support port numbers in a
584 * smaller range. Use ofpacts_check() to additional check whether actions are
585 * valid in a specific context. */
587 ofpacts_pull_openflow10(struct ofpbuf
*openflow
, unsigned int actions_len
,
588 struct ofpbuf
*ofpacts
)
590 return ofpacts_pull_actions(openflow
, actions_len
, ofpacts
,
591 ofpacts_from_openflow10
);
594 /* OpenFlow 1.1 actions. */
596 /* Parses 'a' to determine its type. On success stores the correct type into
597 * '*code' and returns 0. On failure returns an OFPERR_* error code and
598 * '*code' is indeterminate.
600 * The caller must have already verified that 'a''s length is potentially
601 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
602 * ofp_action) and no longer than the amount of space allocated to 'a').
604 * This function verifies that 'a''s length is correct for the type of action
605 * that it represents. */
607 decode_openflow11_action(const union ofp_action
*a
,
608 enum ofputil_action_code
*code
)
611 case CONSTANT_HTONS(OFPAT11_EXPERIMENTER
):
612 return decode_nxast_action(a
, code
);
614 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) \
615 case CONSTANT_HTONS(ENUM): \
616 if (a->header.len == htons(sizeof(struct STRUCT))) { \
617 *code = OFPUTIL_##ENUM; \
620 return OFPERR_OFPBAC_BAD_LEN; \
623 #include "ofp-util.def"
626 return OFPERR_OFPBAC_BAD_TYPE
;
631 output_from_openflow11(const struct ofp11_action_output
*oao
,
634 struct ofpact_output
*output
;
637 output
= ofpact_put_OUTPUT(out
);
638 output
->max_len
= ntohs(oao
->max_len
);
640 error
= ofputil_port_from_ofp11(oao
->port
, &output
->port
);
645 return ofputil_check_output_port(output
->port
, OFPP_MAX
);
649 ofpact_from_openflow11(const union ofp_action
*a
, struct ofpbuf
*out
)
651 enum ofputil_action_code code
;
654 error
= decode_openflow11_action(a
, &code
);
660 case OFPUTIL_ACTION_INVALID
:
661 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
662 #include "ofp-util.def"
665 case OFPUTIL_OFPAT11_OUTPUT
:
666 return output_from_openflow11((const struct ofp11_action_output
*) a
,
669 case OFPUTIL_OFPAT11_SET_VLAN_VID
:
670 if (a
->vlan_vid
.vlan_vid
& ~htons(0xfff)) {
671 return OFPERR_OFPBAC_BAD_ARGUMENT
;
673 ofpact_put_SET_VLAN_VID(out
)->vlan_vid
= ntohs(a
->vlan_vid
.vlan_vid
);
676 case OFPUTIL_OFPAT11_SET_VLAN_PCP
:
677 if (a
->vlan_pcp
.vlan_pcp
& ~7) {
678 return OFPERR_OFPBAC_BAD_ARGUMENT
;
680 ofpact_put_SET_VLAN_PCP(out
)->vlan_pcp
= a
->vlan_pcp
.vlan_pcp
;
683 case OFPUTIL_OFPAT11_SET_DL_SRC
:
684 memcpy(ofpact_put_SET_ETH_SRC(out
)->mac
,
685 ((const struct ofp_action_dl_addr
*) a
)->dl_addr
, ETH_ADDR_LEN
);
688 case OFPUTIL_OFPAT11_SET_DL_DST
:
689 memcpy(ofpact_put_SET_ETH_DST(out
)->mac
,
690 ((const struct ofp_action_dl_addr
*) a
)->dl_addr
, ETH_ADDR_LEN
);
693 case OFPUTIL_OFPAT11_SET_NW_SRC
:
694 ofpact_put_SET_IPV4_SRC(out
)->ipv4
= a
->nw_addr
.nw_addr
;
697 case OFPUTIL_OFPAT11_SET_NW_DST
:
698 ofpact_put_SET_IPV4_DST(out
)->ipv4
= a
->nw_addr
.nw_addr
;
701 case OFPUTIL_OFPAT11_SET_NW_TOS
:
702 if (a
->nw_tos
.nw_tos
& ~IP_DSCP_MASK
) {
703 return OFPERR_OFPBAC_BAD_ARGUMENT
;
705 ofpact_put_SET_IPV4_DSCP(out
)->dscp
= a
->nw_tos
.nw_tos
;
708 case OFPUTIL_OFPAT11_SET_TP_SRC
:
709 ofpact_put_SET_L4_SRC_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
712 case OFPUTIL_OFPAT11_SET_TP_DST
:
713 ofpact_put_SET_L4_DST_PORT(out
)->port
= ntohs(a
->tp_port
.tp_port
);
716 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
717 #include "ofp-util.def"
718 return ofpact_from_nxast(a
, code
, out
);
725 ofpacts_from_openflow11(const union ofp_action
*in
, size_t n_in
,
728 return ofpacts_from_openflow(in
, n_in
, out
, ofpact_from_openflow11
);
731 /* OpenFlow 1.1 instructions. */
733 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
734 static inline const struct STRUCT * \
735 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
737 assert(inst->type == htons(ENUM)); \
738 return (struct STRUCT *)inst; \
742 instruction_init_##ENUM(struct STRUCT *s) \
744 memset(s, 0, sizeof *s); \
745 s->type = htons(ENUM); \
746 s->len = htons(sizeof *s); \
749 static inline struct STRUCT * \
750 instruction_put_##ENUM(struct ofpbuf *buf) \
752 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
753 instruction_init_##ENUM(s); \
759 struct instruction_type_info
{
760 enum ovs_instruction_type type
;
764 static const struct instruction_type_info inst_info
[] = {
765 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
771 ofpact_instruction_name_from_type(enum ovs_instruction_type type
)
773 return inst_info
[type
].name
;
777 ofpact_instruction_type_from_name(const char *name
)
779 const struct instruction_type_info
*p
;
780 for (p
= inst_info
; p
< &inst_info
[ARRAY_SIZE(inst_info
)]; p
++) {
781 if (!strcasecmp(name
, p
->name
)) {
788 static inline struct ofp11_instruction
*
789 instruction_next(const struct ofp11_instruction
*inst
)
791 return ((struct ofp11_instruction
*) (void *)
792 ((uint8_t *) inst
+ ntohs(inst
->len
)));
796 instruction_is_valid(const struct ofp11_instruction
*inst
,
797 size_t n_instructions
)
799 uint16_t len
= ntohs(inst
->len
);
800 return (!(len
% OFP11_INSTRUCTION_ALIGN
)
801 && len
>= sizeof *inst
802 && len
/ sizeof *inst
<= n_instructions
);
805 /* This macro is careful to check for instructions with bad lengths. */
806 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
807 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
808 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
809 ((LEFT) -= (ntohs((ITER)->len) \
810 / sizeof(struct ofp11_instruction)), \
811 (ITER) = instruction_next(ITER)))
814 decode_openflow11_instruction(const struct ofp11_instruction
*inst
,
815 enum ovs_instruction_type
*type
)
817 uint16_t len
= ntohs(inst
->len
);
819 switch (inst
->type
) {
820 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER
):
821 return OFPERR_OFPBIC_BAD_EXPERIMENTER
;
823 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
824 case CONSTANT_HTONS(ENUM): \
826 ? len >= sizeof(struct STRUCT) \
827 : len == sizeof(struct STRUCT)) { \
828 *type = OVSINST_##ENUM; \
831 return OFPERR_OFPBIC_BAD_LEN; \
837 return OFPERR_OFPBIC_UNKNOWN_INST
;
842 decode_openflow11_instructions(const struct ofp11_instruction insts
[],
844 const struct ofp11_instruction
*out
[])
846 const struct ofp11_instruction
*inst
;
849 memset(out
, 0, N_OVS_INSTRUCTIONS
* sizeof *out
);
850 INSTRUCTION_FOR_EACH (inst
, left
, insts
, n_insts
) {
851 enum ovs_instruction_type type
;
854 error
= decode_openflow11_instruction(inst
, &type
);
860 return OFPERR_OFPIT_BAD_INSTRUCTION
;
866 VLOG_WARN_RL(&rl
, "bad instruction format at offset %zu",
867 (n_insts
- left
) * sizeof *inst
);
868 return OFPERR_OFPBIC_BAD_LEN
;
874 get_actions_from_instruction(const struct ofp11_instruction
*inst
,
875 const union ofp_action
**actions
,
878 *actions
= (const union ofp_action
*) (inst
+ 1);
879 *n_actions
= (ntohs(inst
->len
) - sizeof *inst
) / OFP11_INSTRUCTION_ALIGN
;
882 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
883 * front of 'openflow' into ofpacts. On success, replaces any existing content
884 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
885 * Returns 0 if successful, otherwise an OpenFlow error.
887 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
888 * instructions, so you should call ofpacts_pull_openflow11_instructions()
889 * instead of this function.
891 * The parsed actions are valid generically, but they may not be valid in a
892 * specific context. For example, port numbers up to OFPP_MAX are valid
893 * generically, but specific datapaths may only support port numbers in a
894 * smaller range. Use ofpacts_check() to additional check whether actions are
895 * valid in a specific context. */
897 ofpacts_pull_openflow11_actions(struct ofpbuf
*openflow
,
898 unsigned int actions_len
,
899 struct ofpbuf
*ofpacts
)
901 return ofpacts_pull_actions(openflow
, actions_len
, ofpacts
,
902 ofpacts_from_openflow11
);
906 ofpacts_pull_openflow11_instructions(struct ofpbuf
*openflow
,
907 unsigned int instructions_len
,
908 struct ofpbuf
*ofpacts
)
910 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
911 const struct ofp11_instruction
*instructions
;
912 const struct ofp11_instruction
*insts
[N_OVS_INSTRUCTIONS
];
915 ofpbuf_clear(ofpacts
);
917 if (instructions_len
% OFP11_INSTRUCTION_ALIGN
!= 0) {
918 VLOG_WARN_RL(&rl
, "OpenFlow message instructions length %u is not a "
920 instructions_len
, OFP11_INSTRUCTION_ALIGN
);
921 error
= OFPERR_OFPBIC_BAD_LEN
;
925 instructions
= ofpbuf_try_pull(openflow
, instructions_len
);
926 if (instructions
== NULL
) {
927 VLOG_WARN_RL(&rl
, "OpenFlow message instructions length %u exceeds "
928 "remaining message length (%zu)",
929 instructions_len
, openflow
->size
);
930 error
= OFPERR_OFPBIC_BAD_LEN
;
934 error
= decode_openflow11_instructions(
935 instructions
, instructions_len
/ OFP11_INSTRUCTION_ALIGN
,
941 if (insts
[OVSINST_OFPIT11_APPLY_ACTIONS
]) {
942 const union ofp_action
*actions
;
945 get_actions_from_instruction(insts
[OVSINST_OFPIT11_APPLY_ACTIONS
],
946 &actions
, &n_actions
);
947 error
= ofpacts_from_openflow11(actions
, n_actions
, ofpacts
);
953 if (insts
[OVSINST_OFPIT11_GOTO_TABLE
] ||
954 insts
[OVSINST_OFPIT11_WRITE_METADATA
] ||
955 insts
[OVSINST_OFPIT11_WRITE_ACTIONS
] ||
956 insts
[OVSINST_OFPIT11_CLEAR_ACTIONS
]) {
957 error
= OFPERR_OFPBIC_UNSUP_INST
;
963 ofpbuf_clear(ofpacts
);
969 ofpact_check__(const struct ofpact
*a
, const struct flow
*flow
, int max_ports
)
971 const struct ofpact_enqueue
*enqueue
;
975 return ofputil_check_output_port(ofpact_get_OUTPUT(a
)->port
,
978 case OFPACT_CONTROLLER
:
982 enqueue
= ofpact_get_ENQUEUE(a
);
983 if (enqueue
->port
>= max_ports
&& enqueue
->port
!= OFPP_IN_PORT
984 && enqueue
->port
!= OFPP_LOCAL
) {
985 return OFPERR_OFPBAC_BAD_OUT_PORT
;
989 case OFPACT_OUTPUT_REG
:
990 return mf_check_src(&ofpact_get_OUTPUT_REG(a
)->src
, flow
);
993 return bundle_check(ofpact_get_BUNDLE(a
), max_ports
, flow
);
995 case OFPACT_SET_VLAN_VID
:
996 case OFPACT_SET_VLAN_PCP
:
997 case OFPACT_STRIP_VLAN
:
998 case OFPACT_SET_ETH_SRC
:
999 case OFPACT_SET_ETH_DST
:
1000 case OFPACT_SET_IPV4_SRC
:
1001 case OFPACT_SET_IPV4_DST
:
1002 case OFPACT_SET_IPV4_DSCP
:
1003 case OFPACT_SET_L4_SRC_PORT
:
1004 case OFPACT_SET_L4_DST_PORT
:
1007 case OFPACT_REG_MOVE
:
1008 return nxm_reg_move_check(ofpact_get_REG_MOVE(a
), flow
);
1010 case OFPACT_REG_LOAD
:
1011 return nxm_reg_load_check(ofpact_get_REG_LOAD(a
), flow
);
1013 case OFPACT_DEC_TTL
:
1014 case OFPACT_SET_TUNNEL
:
1015 case OFPACT_SET_QUEUE
:
1016 case OFPACT_POP_QUEUE
:
1017 case OFPACT_FIN_TIMEOUT
:
1018 case OFPACT_RESUBMIT
:
1022 return learn_check(ofpact_get_LEARN(a
), flow
);
1024 case OFPACT_MULTIPATH
:
1025 return multipath_check(ofpact_get_MULTIPATH(a
), flow
);
1027 case OFPACT_AUTOPATH
:
1028 return autopath_check(ofpact_get_AUTOPATH(a
), flow
);
1039 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1040 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1041 * switch with no more than 'max_ports' ports. */
1043 ofpacts_check(const struct ofpact ofpacts
[], size_t ofpacts_len
,
1044 const struct flow
*flow
, int max_ports
)
1046 const struct ofpact
*a
;
1048 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
1049 enum ofperr error
= ofpact_check__(a
, flow
, max_ports
);
1058 /* Converting ofpacts to Nicira OpenFlow extensions. */
1061 ofpact_output_reg_to_nxast(const struct ofpact_output_reg
*output_reg
,
1064 struct nx_action_output_reg
*naor
= ofputil_put_NXAST_OUTPUT_REG(out
);
1066 naor
->ofs_nbits
= nxm_encode_ofs_nbits(output_reg
->src
.ofs
,
1067 output_reg
->src
.n_bits
);
1068 naor
->src
= htonl(output_reg
->src
.field
->nxm_header
);
1069 naor
->max_len
= htons(output_reg
->max_len
);
1073 ofpact_resubmit_to_nxast(const struct ofpact_resubmit
*resubmit
,
1076 struct nx_action_resubmit
*nar
;
1078 if (resubmit
->table_id
== 0xff
1079 && resubmit
->ofpact
.compat
!= OFPUTIL_NXAST_RESUBMIT_TABLE
) {
1080 nar
= ofputil_put_NXAST_RESUBMIT(out
);
1082 nar
= ofputil_put_NXAST_RESUBMIT_TABLE(out
);
1083 nar
->table
= resubmit
->table_id
;
1085 nar
->in_port
= htons(resubmit
->in_port
);
1089 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel
*tunnel
,
1092 uint64_t tun_id
= tunnel
->tun_id
;
1094 if (tun_id
<= UINT32_MAX
1095 && tunnel
->ofpact
.compat
!= OFPUTIL_NXAST_SET_TUNNEL64
) {
1096 ofputil_put_NXAST_SET_TUNNEL(out
)->tun_id
= htonl(tun_id
);
1098 ofputil_put_NXAST_SET_TUNNEL64(out
)->tun_id
= htonll(tun_id
);
1103 ofpact_note_to_nxast(const struct ofpact_note
*note
, struct ofpbuf
*out
)
1105 size_t start_ofs
= out
->size
;
1106 struct nx_action_note
*nan
;
1107 unsigned int remainder
;
1110 nan
= ofputil_put_NXAST_NOTE(out
);
1111 out
->size
-= sizeof nan
->note
;
1113 ofpbuf_put(out
, note
->data
, note
->length
);
1115 len
= out
->size
- start_ofs
;
1116 remainder
= len
% OFP_ACTION_ALIGN
;
1118 ofpbuf_put_zeros(out
, OFP_ACTION_ALIGN
- remainder
);
1120 nan
= (struct nx_action_note
*)((char *)out
->data
+ start_ofs
);
1121 nan
->len
= htons(out
->size
- start_ofs
);
1125 ofpact_controller_to_nxast(const struct ofpact_controller
*oc
,
1128 struct nx_action_controller
*nac
;
1130 nac
= ofputil_put_NXAST_CONTROLLER(out
);
1131 nac
->max_len
= htons(oc
->max_len
);
1132 nac
->controller_id
= htons(oc
->controller_id
);
1133 nac
->reason
= oc
->reason
;
1137 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids
*oc_ids
,
1140 if (oc_ids
->ofpact
.compat
== OFPUTIL_NXAST_DEC_TTL
) {
1141 ofputil_put_NXAST_DEC_TTL(out
);
1143 struct nx_action_cnt_ids
*nac_ids
=
1144 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out
);
1145 int ids_len
= ROUND_UP(2 * oc_ids
->n_controllers
, OFP_ACTION_ALIGN
);
1149 nac_ids
->len
= htons(ntohs(nac_ids
->len
) + ids_len
);
1150 nac_ids
->n_controllers
= htons(oc_ids
->n_controllers
);
1152 ids
= ofpbuf_put_zeros(out
, ids_len
);
1153 for (i
= 0; i
< oc_ids
->n_controllers
; i
++) {
1154 ids
[i
] = htons(oc_ids
->cnt_ids
[i
]);
1160 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout
*fin_timeout
,
1163 struct nx_action_fin_timeout
*naft
= ofputil_put_NXAST_FIN_TIMEOUT(out
);
1164 naft
->fin_idle_timeout
= htons(fin_timeout
->fin_idle_timeout
);
1165 naft
->fin_hard_timeout
= htons(fin_timeout
->fin_hard_timeout
);
1169 ofpact_to_nxast(const struct ofpact
*a
, struct ofpbuf
*out
)
1172 case OFPACT_CONTROLLER
:
1173 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a
), out
);
1176 case OFPACT_OUTPUT_REG
:
1177 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a
), out
);
1181 bundle_to_nxast(ofpact_get_BUNDLE(a
), out
);
1184 case OFPACT_REG_MOVE
:
1185 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a
), out
);
1188 case OFPACT_REG_LOAD
:
1189 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a
), out
);
1192 case OFPACT_DEC_TTL
:
1193 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a
), out
);
1196 case OFPACT_SET_TUNNEL
:
1197 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a
), out
);
1200 case OFPACT_SET_QUEUE
:
1201 ofputil_put_NXAST_SET_QUEUE(out
)->queue_id
1202 = htonl(ofpact_get_SET_QUEUE(a
)->queue_id
);
1205 case OFPACT_POP_QUEUE
:
1206 ofputil_put_NXAST_POP_QUEUE(out
);
1209 case OFPACT_FIN_TIMEOUT
:
1210 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a
), out
);
1213 case OFPACT_RESUBMIT
:
1214 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a
), out
);
1218 learn_to_nxast(ofpact_get_LEARN(a
), out
);
1221 case OFPACT_MULTIPATH
:
1222 multipath_to_nxast(ofpact_get_MULTIPATH(a
), out
);
1225 case OFPACT_AUTOPATH
:
1226 autopath_to_nxast(ofpact_get_AUTOPATH(a
), out
);
1230 ofpact_note_to_nxast(ofpact_get_NOTE(a
), out
);
1234 ofputil_put_NXAST_EXIT(out
);
1238 case OFPACT_ENQUEUE
:
1239 case OFPACT_SET_VLAN_VID
:
1240 case OFPACT_SET_VLAN_PCP
:
1241 case OFPACT_STRIP_VLAN
:
1242 case OFPACT_SET_ETH_SRC
:
1243 case OFPACT_SET_ETH_DST
:
1244 case OFPACT_SET_IPV4_SRC
:
1245 case OFPACT_SET_IPV4_DST
:
1246 case OFPACT_SET_IPV4_DSCP
:
1247 case OFPACT_SET_L4_SRC_PORT
:
1248 case OFPACT_SET_L4_DST_PORT
:
1253 /* Converting ofpacts to OpenFlow 1.0. */
1256 ofpact_output_to_openflow10(const struct ofpact_output
*output
,
1259 struct ofp10_action_output
*oao
;
1261 oao
= ofputil_put_OFPAT10_OUTPUT(out
);
1262 oao
->port
= htons(output
->port
);
1263 oao
->max_len
= htons(output
->max_len
);
1267 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue
*enqueue
,
1270 struct ofp_action_enqueue
*oae
;
1272 oae
= ofputil_put_OFPAT10_ENQUEUE(out
);
1273 oae
->port
= htons(enqueue
->port
);
1274 oae
->queue_id
= htonl(enqueue
->queue
);
1278 ofpact_to_openflow10(const struct ofpact
*a
, struct ofpbuf
*out
)
1282 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a
), out
);
1285 case OFPACT_ENQUEUE
:
1286 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a
), out
);
1289 case OFPACT_SET_VLAN_VID
:
1290 ofputil_put_OFPAT10_SET_VLAN_VID(out
)->vlan_vid
1291 = htons(ofpact_get_SET_VLAN_VID(a
)->vlan_vid
);
1294 case OFPACT_SET_VLAN_PCP
:
1295 ofputil_put_OFPAT10_SET_VLAN_PCP(out
)->vlan_pcp
1296 = ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
;
1299 case OFPACT_STRIP_VLAN
:
1300 ofputil_put_OFPAT10_STRIP_VLAN(out
);
1303 case OFPACT_SET_ETH_SRC
:
1304 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out
)->dl_addr
,
1305 ofpact_get_SET_ETH_SRC(a
)->mac
, ETH_ADDR_LEN
);
1308 case OFPACT_SET_ETH_DST
:
1309 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out
)->dl_addr
,
1310 ofpact_get_SET_ETH_DST(a
)->mac
, ETH_ADDR_LEN
);
1313 case OFPACT_SET_IPV4_SRC
:
1314 ofputil_put_OFPAT10_SET_NW_SRC(out
)->nw_addr
1315 = ofpact_get_SET_IPV4_SRC(a
)->ipv4
;
1318 case OFPACT_SET_IPV4_DST
:
1319 ofputil_put_OFPAT10_SET_NW_DST(out
)->nw_addr
1320 = ofpact_get_SET_IPV4_DST(a
)->ipv4
;
1323 case OFPACT_SET_IPV4_DSCP
:
1324 ofputil_put_OFPAT10_SET_NW_TOS(out
)->nw_tos
1325 = ofpact_get_SET_IPV4_DSCP(a
)->dscp
;
1328 case OFPACT_SET_L4_SRC_PORT
:
1329 ofputil_put_OFPAT10_SET_TP_SRC(out
)->tp_port
1330 = htons(ofpact_get_SET_L4_SRC_PORT(a
)->port
);
1333 case OFPACT_SET_L4_DST_PORT
:
1334 ofputil_put_OFPAT10_SET_TP_DST(out
)->tp_port
1335 = htons(ofpact_get_SET_L4_DST_PORT(a
)->port
);
1338 case OFPACT_CONTROLLER
:
1339 case OFPACT_OUTPUT_REG
:
1341 case OFPACT_REG_MOVE
:
1342 case OFPACT_REG_LOAD
:
1343 case OFPACT_DEC_TTL
:
1344 case OFPACT_SET_TUNNEL
:
1345 case OFPACT_SET_QUEUE
:
1346 case OFPACT_POP_QUEUE
:
1347 case OFPACT_FIN_TIMEOUT
:
1348 case OFPACT_RESUBMIT
:
1350 case OFPACT_MULTIPATH
:
1351 case OFPACT_AUTOPATH
:
1354 ofpact_to_nxast(a
, out
);
1359 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1360 * actions in 'openflow', appending the actions to any existing data in
1363 ofpacts_put_openflow10(const struct ofpact ofpacts
[], size_t ofpacts_len
,
1364 struct ofpbuf
*openflow
)
1366 const struct ofpact
*a
;
1368 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
1369 ofpact_to_openflow10(a
, openflow
);
1373 /* Converting ofpacts to OpenFlow 1.1. */
1376 ofpact_output_to_openflow11(const struct ofpact_output
*output
,
1379 struct ofp11_action_output
*oao
;
1381 oao
= ofputil_put_OFPAT11_OUTPUT(out
);
1382 oao
->port
= ofputil_port_to_ofp11(output
->port
);
1383 oao
->max_len
= htons(output
->max_len
);
1387 ofpact_to_openflow11(const struct ofpact
*a
, struct ofpbuf
*out
)
1391 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a
), out
);
1393 case OFPACT_ENQUEUE
:
1397 case OFPACT_SET_VLAN_VID
:
1398 ofputil_put_OFPAT11_SET_VLAN_VID(out
)->vlan_vid
1399 = htons(ofpact_get_SET_VLAN_VID(a
)->vlan_vid
);
1402 case OFPACT_SET_VLAN_PCP
:
1403 ofputil_put_OFPAT11_SET_VLAN_PCP(out
)->vlan_pcp
1404 = ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
;
1407 case OFPACT_STRIP_VLAN
:
1411 case OFPACT_SET_ETH_SRC
:
1412 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out
)->dl_addr
,
1413 ofpact_get_SET_ETH_SRC(a
)->mac
, ETH_ADDR_LEN
);
1416 case OFPACT_SET_ETH_DST
:
1417 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out
)->dl_addr
,
1418 ofpact_get_SET_ETH_DST(a
)->mac
, ETH_ADDR_LEN
);
1421 case OFPACT_SET_IPV4_SRC
:
1422 ofputil_put_OFPAT11_SET_NW_SRC(out
)->nw_addr
1423 = ofpact_get_SET_IPV4_SRC(a
)->ipv4
;
1426 case OFPACT_SET_IPV4_DST
:
1427 ofputil_put_OFPAT11_SET_NW_DST(out
)->nw_addr
1428 = ofpact_get_SET_IPV4_DST(a
)->ipv4
;
1431 case OFPACT_SET_IPV4_DSCP
:
1432 ofputil_put_OFPAT11_SET_NW_TOS(out
)->nw_tos
1433 = ofpact_get_SET_IPV4_DSCP(a
)->dscp
;
1436 case OFPACT_SET_L4_SRC_PORT
:
1437 ofputil_put_OFPAT11_SET_TP_SRC(out
)->tp_port
1438 = htons(ofpact_get_SET_L4_SRC_PORT(a
)->port
);
1441 case OFPACT_SET_L4_DST_PORT
:
1442 ofputil_put_OFPAT11_SET_TP_DST(out
)->tp_port
1443 = htons(ofpact_get_SET_L4_DST_PORT(a
)->port
);
1446 case OFPACT_CONTROLLER
:
1447 case OFPACT_OUTPUT_REG
:
1449 case OFPACT_REG_MOVE
:
1450 case OFPACT_REG_LOAD
:
1451 case OFPACT_DEC_TTL
:
1452 case OFPACT_SET_TUNNEL
:
1453 case OFPACT_SET_QUEUE
:
1454 case OFPACT_POP_QUEUE
:
1455 case OFPACT_FIN_TIMEOUT
:
1456 case OFPACT_RESUBMIT
:
1458 case OFPACT_MULTIPATH
:
1459 case OFPACT_AUTOPATH
:
1462 ofpact_to_nxast(a
, out
);
1467 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1468 * 1.1 actions in 'openflow', appending the actions to any existing data in
1471 ofpacts_put_openflow11_actions(const struct ofpact ofpacts
[],
1472 size_t ofpacts_len
, struct ofpbuf
*openflow
)
1474 const struct ofpact
*a
;
1475 size_t start_size
= openflow
->size
;
1477 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
1478 ofpact_to_openflow11(a
, openflow
);
1481 return openflow
->size
- start_size
;
1485 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts
[],
1487 struct ofpbuf
*openflow
)
1489 struct ofp11_instruction_actions
*oia
;
1492 /* Put an OFPIT11_APPLY_ACTIONS instruction and fill it in. */
1493 ofs
= openflow
->size
;
1494 instruction_put_OFPIT11_APPLY_ACTIONS(openflow
);
1495 ofpacts_put_openflow11_actions(ofpacts
, ofpacts_len
, openflow
);
1497 /* Update the instruction's length (or, if it's empty, delete it). */
1498 oia
= ofpbuf_at_assert(openflow
, ofs
, sizeof *oia
);
1499 if (openflow
->size
> ofs
+ sizeof *oia
) {
1500 oia
->len
= htons(openflow
->size
- ofs
);
1502 openflow
->size
= ofs
;
1506 /* Returns true if 'action' outputs to 'port', false otherwise. */
1508 ofpact_outputs_to_port(const struct ofpact
*ofpact
, uint16_t port
)
1510 switch (ofpact
->type
) {
1512 return ofpact_get_OUTPUT(ofpact
)->port
== port
;
1513 case OFPACT_ENQUEUE
:
1514 return ofpact_get_ENQUEUE(ofpact
)->port
== port
;
1515 case OFPACT_CONTROLLER
:
1516 return port
== OFPP_CONTROLLER
;
1518 case OFPACT_OUTPUT_REG
:
1520 case OFPACT_SET_VLAN_VID
:
1521 case OFPACT_SET_VLAN_PCP
:
1522 case OFPACT_STRIP_VLAN
:
1523 case OFPACT_SET_ETH_SRC
:
1524 case OFPACT_SET_ETH_DST
:
1525 case OFPACT_SET_IPV4_SRC
:
1526 case OFPACT_SET_IPV4_DST
:
1527 case OFPACT_SET_IPV4_DSCP
:
1528 case OFPACT_SET_L4_SRC_PORT
:
1529 case OFPACT_SET_L4_DST_PORT
:
1530 case OFPACT_REG_MOVE
:
1531 case OFPACT_REG_LOAD
:
1532 case OFPACT_DEC_TTL
:
1533 case OFPACT_SET_TUNNEL
:
1534 case OFPACT_SET_QUEUE
:
1535 case OFPACT_POP_QUEUE
:
1536 case OFPACT_FIN_TIMEOUT
:
1537 case OFPACT_RESUBMIT
:
1539 case OFPACT_MULTIPATH
:
1540 case OFPACT_AUTOPATH
:
1548 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1549 * to 'port', false otherwise. */
1551 ofpacts_output_to_port(const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1554 const struct ofpact
*a
;
1556 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
1557 if (ofpact_outputs_to_port(a
, port
)) {
1566 ofpacts_equal(const struct ofpact
*a
, size_t a_len
,
1567 const struct ofpact
*b
, size_t b_len
)
1569 return a_len
== b_len
&& !memcmp(a
, b
, a_len
);
1572 /* Formatting ofpacts. */
1575 print_note(const struct ofpact_note
*note
, struct ds
*string
)
1579 ds_put_cstr(string
, "note:");
1580 for (i
= 0; i
< note
->length
; i
++) {
1582 ds_put_char(string
, '.');
1584 ds_put_format(string
, "%02"PRIx8
, note
->data
[i
]);
1589 print_dec_ttl(const struct ofpact_cnt_ids
*ids
,
1594 ds_put_cstr(s
, "dec_ttl");
1595 if (ids
->ofpact
.compat
== OFPUTIL_NXAST_DEC_TTL_CNT_IDS
) {
1596 ds_put_cstr(s
, "(");
1597 for (i
= 0; i
< ids
->n_controllers
; i
++) {
1599 ds_put_cstr(s
, ",");
1601 ds_put_format(s
, "%"PRIu16
, ids
->cnt_ids
[i
]);
1603 ds_put_cstr(s
, ")");
1608 print_fin_timeout(const struct ofpact_fin_timeout
*fin_timeout
,
1611 ds_put_cstr(s
, "fin_timeout(");
1612 if (fin_timeout
->fin_idle_timeout
) {
1613 ds_put_format(s
, "idle_timeout=%"PRIu16
",",
1614 fin_timeout
->fin_idle_timeout
);
1616 if (fin_timeout
->fin_hard_timeout
) {
1617 ds_put_format(s
, "hard_timeout=%"PRIu16
",",
1618 fin_timeout
->fin_hard_timeout
);
1621 ds_put_char(s
, ')');
1625 ofpact_format(const struct ofpact
*a
, struct ds
*s
)
1627 const struct ofpact_enqueue
*enqueue
;
1628 const struct ofpact_resubmit
*resubmit
;
1629 const struct ofpact_autopath
*autopath
;
1630 const struct ofpact_controller
*controller
;
1631 const struct ofpact_tunnel
*tunnel
;
1636 port
= ofpact_get_OUTPUT(a
)->port
;
1637 if (port
< OFPP_MAX
) {
1638 ds_put_format(s
, "output:%"PRIu16
, port
);
1640 ofputil_format_port(port
, s
);
1641 if (port
== OFPP_CONTROLLER
) {
1642 ds_put_format(s
, ":%"PRIu16
, ofpact_get_OUTPUT(a
)->max_len
);
1647 case OFPACT_CONTROLLER
:
1648 controller
= ofpact_get_CONTROLLER(a
);
1649 if (controller
->reason
== OFPR_ACTION
&&
1650 controller
->controller_id
== 0) {
1651 ds_put_format(s
, "CONTROLLER:%"PRIu16
,
1652 ofpact_get_CONTROLLER(a
)->max_len
);
1654 enum ofp_packet_in_reason reason
= controller
->reason
;
1656 ds_put_cstr(s
, "controller(");
1657 if (reason
!= OFPR_ACTION
) {
1658 ds_put_format(s
, "reason=%s,",
1659 ofputil_packet_in_reason_to_string(reason
));
1661 if (controller
->max_len
!= UINT16_MAX
) {
1662 ds_put_format(s
, "max_len=%"PRIu16
",", controller
->max_len
);
1664 if (controller
->controller_id
!= 0) {
1665 ds_put_format(s
, "id=%"PRIu16
",", controller
->controller_id
);
1668 ds_put_char(s
, ')');
1672 case OFPACT_ENQUEUE
:
1673 enqueue
= ofpact_get_ENQUEUE(a
);
1674 ds_put_format(s
, "enqueue:");
1675 ofputil_format_port(enqueue
->port
, s
);
1676 ds_put_format(s
, "q%"PRIu32
, enqueue
->queue
);
1679 case OFPACT_OUTPUT_REG
:
1680 ds_put_cstr(s
, "output:");
1681 mf_format_subfield(&ofpact_get_OUTPUT_REG(a
)->src
, s
);
1685 bundle_format(ofpact_get_BUNDLE(a
), s
);
1688 case OFPACT_SET_VLAN_VID
:
1689 ds_put_format(s
, "mod_vlan_vid:%"PRIu16
,
1690 ofpact_get_SET_VLAN_VID(a
)->vlan_vid
);
1693 case OFPACT_SET_VLAN_PCP
:
1694 ds_put_format(s
, "mod_vlan_pcp:%"PRIu8
,
1695 ofpact_get_SET_VLAN_PCP(a
)->vlan_pcp
);
1698 case OFPACT_STRIP_VLAN
:
1699 ds_put_cstr(s
, "strip_vlan");
1702 case OFPACT_SET_ETH_SRC
:
1703 ds_put_format(s
, "mod_dl_src:"ETH_ADDR_FMT
,
1704 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a
)->mac
));
1707 case OFPACT_SET_ETH_DST
:
1708 ds_put_format(s
, "mod_dl_dst:"ETH_ADDR_FMT
,
1709 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a
)->mac
));
1712 case OFPACT_SET_IPV4_SRC
:
1713 ds_put_format(s
, "mod_nw_src:"IP_FMT
,
1714 IP_ARGS(&ofpact_get_SET_IPV4_SRC(a
)->ipv4
));
1717 case OFPACT_SET_IPV4_DST
:
1718 ds_put_format(s
, "mod_nw_dst:"IP_FMT
,
1719 IP_ARGS(&ofpact_get_SET_IPV4_DST(a
)->ipv4
));
1722 case OFPACT_SET_IPV4_DSCP
:
1723 ds_put_format(s
, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a
)->dscp
);
1726 case OFPACT_SET_L4_SRC_PORT
:
1727 ds_put_format(s
, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a
)->port
);
1730 case OFPACT_SET_L4_DST_PORT
:
1731 ds_put_format(s
, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a
)->port
);
1734 case OFPACT_REG_MOVE
:
1735 nxm_format_reg_move(ofpact_get_REG_MOVE(a
), s
);
1738 case OFPACT_REG_LOAD
:
1739 nxm_format_reg_load(ofpact_get_REG_LOAD(a
), s
);
1742 case OFPACT_DEC_TTL
:
1743 print_dec_ttl(ofpact_get_DEC_TTL(a
), s
);
1746 case OFPACT_SET_TUNNEL
:
1747 tunnel
= ofpact_get_SET_TUNNEL(a
);
1748 ds_put_format(s
, "set_tunnel%s:%#"PRIx64
,
1749 (tunnel
->tun_id
> UINT32_MAX
1750 || a
->compat
== OFPUTIL_NXAST_SET_TUNNEL64
? "64" : ""),
1754 case OFPACT_SET_QUEUE
:
1755 ds_put_format(s
, "set_queue:%"PRIu32
,
1756 ofpact_get_SET_QUEUE(a
)->queue_id
);
1759 case OFPACT_POP_QUEUE
:
1760 ds_put_cstr(s
, "pop_queue");
1763 case OFPACT_FIN_TIMEOUT
:
1764 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a
), s
);
1767 case OFPACT_RESUBMIT
:
1768 resubmit
= ofpact_get_RESUBMIT(a
);
1769 if (resubmit
->in_port
!= OFPP_IN_PORT
&& resubmit
->table_id
== 255) {
1770 ds_put_format(s
, "resubmit:%"PRIu16
, resubmit
->in_port
);
1772 ds_put_format(s
, "resubmit(");
1773 if (resubmit
->in_port
!= OFPP_IN_PORT
) {
1774 ofputil_format_port(resubmit
->in_port
, s
);
1776 ds_put_char(s
, ',');
1777 if (resubmit
->table_id
!= 255) {
1778 ds_put_format(s
, "%"PRIu8
, resubmit
->table_id
);
1780 ds_put_char(s
, ')');
1785 learn_format(ofpact_get_LEARN(a
), s
);
1788 case OFPACT_MULTIPATH
:
1789 multipath_format(ofpact_get_MULTIPATH(a
), s
);
1792 case OFPACT_AUTOPATH
:
1793 autopath
= ofpact_get_AUTOPATH(a
);
1794 ds_put_format(s
, "autopath(%u,", autopath
->port
);
1795 mf_format_subfield(&autopath
->dst
, s
);
1796 ds_put_char(s
, ')');
1800 print_note(ofpact_get_NOTE(a
), s
);
1804 ds_put_cstr(s
, "exit");
1809 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
1810 * 'ofpacts' to 'string'. */
1812 ofpacts_format(const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1815 ds_put_cstr(string
, "actions=");
1817 ds_put_cstr(string
, "drop");
1819 const struct ofpact
*a
;
1821 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
1823 ds_put_cstr(string
, ",");
1825 ofpact_format(a
, string
);
1830 /* Internal use by helpers. */
1833 ofpact_put(struct ofpbuf
*ofpacts
, enum ofpact_type type
, size_t len
)
1835 struct ofpact
*ofpact
;
1837 ofpact_pad(ofpacts
);
1838 ofpact
= ofpacts
->l2
= ofpbuf_put_uninit(ofpacts
, len
);
1839 ofpact_init(ofpact
, type
, len
);
1844 ofpact_init(struct ofpact
*ofpact
, enum ofpact_type type
, size_t len
)
1846 memset(ofpact
, 0, len
);
1847 ofpact
->type
= type
;
1848 ofpact
->compat
= OFPUTIL_ACTION_INVALID
;
1852 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
1853 * starting at 'ofpact'.
1855 * This is the correct way to update a variable-length ofpact's length after
1856 * adding the variable-length part of the payload. (See the large comment
1857 * near the end of ofp-actions.h for more information.) */
1859 ofpact_update_len(struct ofpbuf
*ofpacts
, struct ofpact
*ofpact
)
1861 assert(ofpact
== ofpacts
->l2
);
1862 ofpact
->len
= (char *) ofpbuf_tail(ofpacts
) - (char *) ofpact
;
1865 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
1866 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
1867 * client must call this itself after adding the final ofpact to an array of
1870 * (The consequences of failing to call this function are probably not dire.
1871 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
1872 * not dereference it. That's undefined behavior, technically, but it will not
1873 * cause a real problem on common systems. Still, it seems better to call
1876 ofpact_pad(struct ofpbuf
*ofpacts
)
1878 unsigned int rem
= ofpacts
->size
% OFPACT_ALIGNTO
;
1880 ofpbuf_put_zeros(ofpacts
, OFPACT_ALIGNTO
- rem
);