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, EXTENSIBLE, 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, EXTENSIBLE, 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)
613 case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
614 return decode_nxast_action(a, code);
616 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
617 case CONSTANT_HTONS(ENUM): \
618 len = ntohs(a->header.len); \
620 ? len >= sizeof(struct STRUCT) \
621 : len == sizeof(struct STRUCT)) { \
622 *code = OFPUTIL_##ENUM; \
625 return OFPERR_OFPBAC_BAD_LEN; \
628 #include "ofp-util.def"
631 return OFPERR_OFPBAC_BAD_TYPE;
636 output_from_openflow11(const struct ofp11_action_output *oao,
639 struct ofpact_output *output;
642 output = ofpact_put_OUTPUT(out);
643 output->max_len = ntohs(oao->max_len);
645 error = ofputil_port_from_ofp11(oao->port, &output->port);
650 return ofputil_check_output_port(output->port, OFPP_MAX);
654 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
656 enum ofputil_action_code code;
659 error = decode_openflow11_action(a, &code);
665 case OFPUTIL_ACTION_INVALID:
666 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
667 #include "ofp-util.def"
670 case OFPUTIL_OFPAT11_OUTPUT:
671 return output_from_openflow11((const struct ofp11_action_output *) a,
674 case OFPUTIL_OFPAT11_SET_VLAN_VID:
675 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
676 return OFPERR_OFPBAC_BAD_ARGUMENT;
678 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
681 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
682 if (a->vlan_pcp.vlan_pcp & ~7) {
683 return OFPERR_OFPBAC_BAD_ARGUMENT;
685 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
688 case OFPUTIL_OFPAT11_SET_DL_SRC:
689 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
690 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
693 case OFPUTIL_OFPAT11_SET_DL_DST:
694 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
695 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
698 case OFPUTIL_OFPAT11_SET_NW_SRC:
699 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
702 case OFPUTIL_OFPAT11_SET_NW_DST:
703 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
706 case OFPUTIL_OFPAT11_SET_NW_TOS:
707 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
708 return OFPERR_OFPBAC_BAD_ARGUMENT;
710 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
713 case OFPUTIL_OFPAT11_SET_TP_SRC:
714 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
717 case OFPUTIL_OFPAT11_SET_TP_DST:
718 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
721 case OFPUTIL_OFPAT12_SET_FIELD:
722 return nxm_reg_load_from_openflow12_set_field(
723 (const struct ofp12_action_set_field *)a, out);
725 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
726 #include "ofp-util.def"
727 return ofpact_from_nxast(a, code, out);
734 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
737 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
740 /* OpenFlow 1.1 instructions. */
742 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
743 static inline const struct STRUCT * \
744 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
746 assert(inst->type == htons(ENUM)); \
747 return (struct STRUCT *)inst; \
751 instruction_init_##ENUM(struct STRUCT *s) \
753 memset(s, 0, sizeof *s); \
754 s->type = htons(ENUM); \
755 s->len = htons(sizeof *s); \
758 static inline struct STRUCT * \
759 instruction_put_##ENUM(struct ofpbuf *buf) \
761 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
762 instruction_init_##ENUM(s); \
768 struct instruction_type_info {
769 enum ovs_instruction_type type;
773 static const struct instruction_type_info inst_info[] = {
774 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
780 ofpact_instruction_name_from_type(enum ovs_instruction_type type)
782 return inst_info[type].name;
786 ofpact_instruction_type_from_name(const char *name)
788 const struct instruction_type_info *p;
789 for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
790 if (!strcasecmp(name, p->name)) {
797 static inline struct ofp11_instruction *
798 instruction_next(const struct ofp11_instruction *inst)
800 return ((struct ofp11_instruction *) (void *)
801 ((uint8_t *) inst + ntohs(inst->len)));
805 instruction_is_valid(const struct ofp11_instruction *inst,
806 size_t n_instructions)
808 uint16_t len = ntohs(inst->len);
809 return (!(len % OFP11_INSTRUCTION_ALIGN)
810 && len >= sizeof *inst
811 && len / sizeof *inst <= n_instructions);
814 /* This macro is careful to check for instructions with bad lengths. */
815 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
816 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
817 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
818 ((LEFT) -= (ntohs((ITER)->len) \
819 / sizeof(struct ofp11_instruction)), \
820 (ITER) = instruction_next(ITER)))
823 decode_openflow11_instruction(const struct ofp11_instruction *inst,
824 enum ovs_instruction_type *type)
826 uint16_t len = ntohs(inst->len);
828 switch (inst->type) {
829 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
830 return OFPERR_OFPBIC_BAD_EXPERIMENTER;
832 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
833 case CONSTANT_HTONS(ENUM): \
835 ? len >= sizeof(struct STRUCT) \
836 : len == sizeof(struct STRUCT)) { \
837 *type = OVSINST_##ENUM; \
840 return OFPERR_OFPBIC_BAD_LEN; \
846 return OFPERR_OFPBIC_UNKNOWN_INST;
851 decode_openflow11_instructions(const struct ofp11_instruction insts[],
853 const struct ofp11_instruction *out[])
855 const struct ofp11_instruction *inst;
858 memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
859 INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
860 enum ovs_instruction_type type;
863 error = decode_openflow11_instruction(inst, &type);
869 return OFPERR_OFPIT_BAD_INSTRUCTION;
875 VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
876 (n_insts - left) * sizeof *inst);
877 return OFPERR_OFPBIC_BAD_LEN;
883 get_actions_from_instruction(const struct ofp11_instruction *inst,
884 const union ofp_action **actions,
887 *actions = (const union ofp_action *) (inst + 1);
888 *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
891 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
892 * front of 'openflow' into ofpacts. On success, replaces any existing content
893 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
894 * Returns 0 if successful, otherwise an OpenFlow error.
896 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
897 * instructions, so you should call ofpacts_pull_openflow11_instructions()
898 * instead of this function.
900 * The parsed actions are valid generically, but they may not be valid in a
901 * specific context. For example, port numbers up to OFPP_MAX are valid
902 * generically, but specific datapaths may only support port numbers in a
903 * smaller range. Use ofpacts_check() to additional check whether actions are
904 * valid in a specific context. */
906 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
907 unsigned int actions_len,
908 struct ofpbuf *ofpacts)
910 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
911 ofpacts_from_openflow11);
915 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
916 unsigned int instructions_len,
917 struct ofpbuf *ofpacts)
919 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
920 const struct ofp11_instruction *instructions;
921 const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
924 ofpbuf_clear(ofpacts);
926 if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
927 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
929 instructions_len, OFP11_INSTRUCTION_ALIGN);
930 error = OFPERR_OFPBIC_BAD_LEN;
934 instructions = ofpbuf_try_pull(openflow, instructions_len);
935 if (instructions == NULL) {
936 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
937 "remaining message length (%zu)",
938 instructions_len, openflow->size);
939 error = OFPERR_OFPBIC_BAD_LEN;
943 error = decode_openflow11_instructions(
944 instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
950 if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
951 const union ofp_action *actions;
954 get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
955 &actions, &n_actions);
956 error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
961 if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
962 instruction_get_OFPIT11_CLEAR_ACTIONS(
963 insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
964 ofpact_put_CLEAR_ACTIONS(ofpacts);
966 /* TODO:XXX Write-Actions */
967 /* TODO:XXX Write-Metadata */
968 if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
969 const struct ofp11_instruction_goto_table *oigt;
970 struct ofpact_goto_table *ogt;
972 oigt = instruction_get_OFPIT11_GOTO_TABLE(
973 insts[OVSINST_OFPIT11_GOTO_TABLE]);
974 ogt = ofpact_put_GOTO_TABLE(ofpacts);
975 ogt->table_id = oigt->table_id;
978 if (insts[OVSINST_OFPIT11_WRITE_METADATA] ||
979 insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
980 error = OFPERR_OFPBIC_UNSUP_INST;
986 ofpbuf_clear(ofpacts);
992 ofpact_check__(const struct ofpact *a, const struct flow *flow, int max_ports)
994 const struct ofpact_enqueue *enqueue;
998 return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
1001 case OFPACT_CONTROLLER:
1004 case OFPACT_ENQUEUE:
1005 enqueue = ofpact_get_ENQUEUE(a);
1006 if (enqueue->port >= max_ports && enqueue->port != OFPP_IN_PORT
1007 && enqueue->port != OFPP_LOCAL) {
1008 return OFPERR_OFPBAC_BAD_OUT_PORT;
1012 case OFPACT_OUTPUT_REG:
1013 return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1016 return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1018 case OFPACT_SET_VLAN_VID:
1019 case OFPACT_SET_VLAN_PCP:
1020 case OFPACT_STRIP_VLAN:
1021 case OFPACT_SET_ETH_SRC:
1022 case OFPACT_SET_ETH_DST:
1023 case OFPACT_SET_IPV4_SRC:
1024 case OFPACT_SET_IPV4_DST:
1025 case OFPACT_SET_IPV4_DSCP:
1026 case OFPACT_SET_L4_SRC_PORT:
1027 case OFPACT_SET_L4_DST_PORT:
1030 case OFPACT_REG_MOVE:
1031 return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1033 case OFPACT_REG_LOAD:
1034 return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1036 case OFPACT_DEC_TTL:
1037 case OFPACT_SET_TUNNEL:
1038 case OFPACT_SET_QUEUE:
1039 case OFPACT_POP_QUEUE:
1040 case OFPACT_FIN_TIMEOUT:
1041 case OFPACT_RESUBMIT:
1045 return learn_check(ofpact_get_LEARN(a), flow);
1047 case OFPACT_MULTIPATH:
1048 return multipath_check(ofpact_get_MULTIPATH(a), flow);
1050 case OFPACT_AUTOPATH:
1051 return autopath_check(ofpact_get_AUTOPATH(a), flow);
1057 case OFPACT_CLEAR_ACTIONS:
1058 case OFPACT_GOTO_TABLE:
1066 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1067 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1068 * switch with no more than 'max_ports' ports. */
1070 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1071 const struct flow *flow, int max_ports)
1073 const struct ofpact *a;
1075 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1076 enum ofperr error = ofpact_check__(a, flow, max_ports);
1085 /* Converting ofpacts to Nicira OpenFlow extensions. */
1088 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1091 struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1093 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1094 output_reg->src.n_bits);
1095 naor->src = htonl(output_reg->src.field->nxm_header);
1096 naor->max_len = htons(output_reg->max_len);
1100 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1103 struct nx_action_resubmit *nar;
1105 if (resubmit->table_id == 0xff
1106 && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1107 nar = ofputil_put_NXAST_RESUBMIT(out);
1109 nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1110 nar->table = resubmit->table_id;
1112 nar->in_port = htons(resubmit->in_port);
1116 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1119 uint64_t tun_id = tunnel->tun_id;
1121 if (tun_id <= UINT32_MAX
1122 && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1123 ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1125 ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1130 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1132 size_t start_ofs = out->size;
1133 struct nx_action_note *nan;
1134 unsigned int remainder;
1137 nan = ofputil_put_NXAST_NOTE(out);
1138 out->size -= sizeof nan->note;
1140 ofpbuf_put(out, note->data, note->length);
1142 len = out->size - start_ofs;
1143 remainder = len % OFP_ACTION_ALIGN;
1145 ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1147 nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1148 nan->len = htons(out->size - start_ofs);
1152 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1155 struct nx_action_controller *nac;
1157 nac = ofputil_put_NXAST_CONTROLLER(out);
1158 nac->max_len = htons(oc->max_len);
1159 nac->controller_id = htons(oc->controller_id);
1160 nac->reason = oc->reason;
1164 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1167 if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1168 ofputil_put_NXAST_DEC_TTL(out);
1170 struct nx_action_cnt_ids *nac_ids =
1171 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1172 int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1176 nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1177 nac_ids->n_controllers = htons(oc_ids->n_controllers);
1179 ids = ofpbuf_put_zeros(out, ids_len);
1180 for (i = 0; i < oc_ids->n_controllers; i++) {
1181 ids[i] = htons(oc_ids->cnt_ids[i]);
1187 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1190 struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1191 naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1192 naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1196 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1199 case OFPACT_CONTROLLER:
1200 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1203 case OFPACT_OUTPUT_REG:
1204 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1208 bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1211 case OFPACT_REG_MOVE:
1212 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1215 case OFPACT_REG_LOAD:
1216 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1219 case OFPACT_DEC_TTL:
1220 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1223 case OFPACT_SET_TUNNEL:
1224 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1227 case OFPACT_SET_QUEUE:
1228 ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1229 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1232 case OFPACT_POP_QUEUE:
1233 ofputil_put_NXAST_POP_QUEUE(out);
1236 case OFPACT_FIN_TIMEOUT:
1237 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1240 case OFPACT_RESUBMIT:
1241 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1245 learn_to_nxast(ofpact_get_LEARN(a), out);
1248 case OFPACT_MULTIPATH:
1249 multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1252 case OFPACT_AUTOPATH:
1253 autopath_to_nxast(ofpact_get_AUTOPATH(a), out);
1257 ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1261 ofputil_put_NXAST_EXIT(out);
1265 case OFPACT_ENQUEUE:
1266 case OFPACT_SET_VLAN_VID:
1267 case OFPACT_SET_VLAN_PCP:
1268 case OFPACT_STRIP_VLAN:
1269 case OFPACT_SET_ETH_SRC:
1270 case OFPACT_SET_ETH_DST:
1271 case OFPACT_SET_IPV4_SRC:
1272 case OFPACT_SET_IPV4_DST:
1273 case OFPACT_SET_IPV4_DSCP:
1274 case OFPACT_SET_L4_SRC_PORT:
1275 case OFPACT_SET_L4_DST_PORT:
1276 case OFPACT_CLEAR_ACTIONS:
1277 case OFPACT_GOTO_TABLE:
1282 /* Converting ofpacts to OpenFlow 1.0. */
1285 ofpact_output_to_openflow10(const struct ofpact_output *output,
1288 struct ofp10_action_output *oao;
1290 oao = ofputil_put_OFPAT10_OUTPUT(out);
1291 oao->port = htons(output->port);
1292 oao->max_len = htons(output->max_len);
1296 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1299 struct ofp_action_enqueue *oae;
1301 oae = ofputil_put_OFPAT10_ENQUEUE(out);
1302 oae->port = htons(enqueue->port);
1303 oae->queue_id = htonl(enqueue->queue);
1307 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1311 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1314 case OFPACT_ENQUEUE:
1315 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1318 case OFPACT_SET_VLAN_VID:
1319 ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1320 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1323 case OFPACT_SET_VLAN_PCP:
1324 ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1325 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1328 case OFPACT_STRIP_VLAN:
1329 ofputil_put_OFPAT10_STRIP_VLAN(out);
1332 case OFPACT_SET_ETH_SRC:
1333 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1334 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1337 case OFPACT_SET_ETH_DST:
1338 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1339 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1342 case OFPACT_SET_IPV4_SRC:
1343 ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1344 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1347 case OFPACT_SET_IPV4_DST:
1348 ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1349 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1352 case OFPACT_SET_IPV4_DSCP:
1353 ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1354 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1357 case OFPACT_SET_L4_SRC_PORT:
1358 ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1359 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1362 case OFPACT_SET_L4_DST_PORT:
1363 ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1364 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1367 case OFPACT_CLEAR_ACTIONS:
1368 case OFPACT_GOTO_TABLE:
1372 case OFPACT_CONTROLLER:
1373 case OFPACT_OUTPUT_REG:
1375 case OFPACT_REG_MOVE:
1376 case OFPACT_REG_LOAD:
1377 case OFPACT_DEC_TTL:
1378 case OFPACT_SET_TUNNEL:
1379 case OFPACT_SET_QUEUE:
1380 case OFPACT_POP_QUEUE:
1381 case OFPACT_FIN_TIMEOUT:
1382 case OFPACT_RESUBMIT:
1384 case OFPACT_MULTIPATH:
1385 case OFPACT_AUTOPATH:
1388 ofpact_to_nxast(a, out);
1393 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1394 * actions in 'openflow', appending the actions to any existing data in
1397 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1398 struct ofpbuf *openflow)
1400 const struct ofpact *a;
1402 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1403 ofpact_to_openflow10(a, openflow);
1407 /* Converting ofpacts to OpenFlow 1.1. */
1410 ofpact_output_to_openflow11(const struct ofpact_output *output,
1413 struct ofp11_action_output *oao;
1415 oao = ofputil_put_OFPAT11_OUTPUT(out);
1416 oao->port = ofputil_port_to_ofp11(output->port);
1417 oao->max_len = htons(output->max_len);
1421 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1425 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1427 case OFPACT_ENQUEUE:
1431 case OFPACT_SET_VLAN_VID:
1432 ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1433 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1436 case OFPACT_SET_VLAN_PCP:
1437 ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1438 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1441 case OFPACT_STRIP_VLAN:
1445 case OFPACT_SET_ETH_SRC:
1446 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1447 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1450 case OFPACT_SET_ETH_DST:
1451 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1452 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1455 case OFPACT_SET_IPV4_SRC:
1456 ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1457 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1460 case OFPACT_SET_IPV4_DST:
1461 ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1462 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1465 case OFPACT_SET_IPV4_DSCP:
1466 ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1467 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1470 case OFPACT_SET_L4_SRC_PORT:
1471 ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1472 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1475 case OFPACT_SET_L4_DST_PORT:
1476 ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1477 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1480 case OFPACT_CLEAR_ACTIONS:
1481 case OFPACT_GOTO_TABLE:
1484 case OFPACT_CONTROLLER:
1485 case OFPACT_OUTPUT_REG:
1487 case OFPACT_REG_MOVE:
1488 case OFPACT_REG_LOAD:
1489 case OFPACT_DEC_TTL:
1490 case OFPACT_SET_TUNNEL:
1491 case OFPACT_SET_QUEUE:
1492 case OFPACT_POP_QUEUE:
1493 case OFPACT_FIN_TIMEOUT:
1494 case OFPACT_RESUBMIT:
1496 case OFPACT_MULTIPATH:
1497 case OFPACT_AUTOPATH:
1500 ofpact_to_nxast(a, out);
1505 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1506 * 1.1 actions in 'openflow', appending the actions to any existing data in
1509 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1510 size_t ofpacts_len, struct ofpbuf *openflow)
1512 const struct ofpact *a;
1513 size_t start_size = openflow->size;
1515 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1516 ofpact_to_openflow11(a, openflow);
1519 return openflow->size - start_size;
1523 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
1525 struct ofp11_instruction_actions *oia;
1527 /* Update the instruction's length (or, if it's empty, delete it). */
1528 oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1529 if (openflow->size > ofs + sizeof *oia) {
1530 oia->len = htons(openflow->size - ofs);
1532 openflow->size = ofs;
1537 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1539 struct ofpbuf *openflow)
1541 const struct ofpact *a;
1543 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1544 /* TODO:XXX Write-Actions */
1545 /* TODO:XXX Write-Metadata */
1546 if (a->type == OFPACT_CLEAR_ACTIONS) {
1547 struct ofp11_instruction *oi;
1548 oi = instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
1549 } else if (a->type == OFPACT_GOTO_TABLE) {
1550 struct ofp11_instruction_goto_table *oigt;
1552 oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
1553 oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
1554 memset(oigt->pad, 0, sizeof oigt->pad);
1555 } else if (!ofpact_is_instruction(a)) {
1557 const size_t ofs = openflow->size;
1558 const size_t ofpacts_len_left =
1559 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
1560 const struct ofpact *action;
1561 const struct ofpact *processed = a;
1563 instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1564 OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
1565 if (ofpact_is_instruction(action)) {
1568 ofpact_to_openflow11(action, openflow);
1571 ofpacts_update_instruction_actions(openflow, ofs);
1577 /* Returns true if 'action' outputs to 'port', false otherwise. */
1579 ofpact_outputs_to_port(const struct ofpact *ofpact, uint16_t port)
1581 switch (ofpact->type) {
1583 return ofpact_get_OUTPUT(ofpact)->port == port;
1584 case OFPACT_ENQUEUE:
1585 return ofpact_get_ENQUEUE(ofpact)->port == port;
1586 case OFPACT_CONTROLLER:
1587 return port == OFPP_CONTROLLER;
1589 case OFPACT_OUTPUT_REG:
1591 case OFPACT_SET_VLAN_VID:
1592 case OFPACT_SET_VLAN_PCP:
1593 case OFPACT_STRIP_VLAN:
1594 case OFPACT_SET_ETH_SRC:
1595 case OFPACT_SET_ETH_DST:
1596 case OFPACT_SET_IPV4_SRC:
1597 case OFPACT_SET_IPV4_DST:
1598 case OFPACT_SET_IPV4_DSCP:
1599 case OFPACT_SET_L4_SRC_PORT:
1600 case OFPACT_SET_L4_DST_PORT:
1601 case OFPACT_REG_MOVE:
1602 case OFPACT_REG_LOAD:
1603 case OFPACT_DEC_TTL:
1604 case OFPACT_SET_TUNNEL:
1605 case OFPACT_SET_QUEUE:
1606 case OFPACT_POP_QUEUE:
1607 case OFPACT_FIN_TIMEOUT:
1608 case OFPACT_RESUBMIT:
1610 case OFPACT_MULTIPATH:
1611 case OFPACT_AUTOPATH:
1614 case OFPACT_CLEAR_ACTIONS:
1615 case OFPACT_GOTO_TABLE:
1621 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1622 * to 'port', false otherwise. */
1624 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
1627 const struct ofpact *a;
1629 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1630 if (ofpact_outputs_to_port(a, port)) {
1639 ofpacts_equal(const struct ofpact *a, size_t a_len,
1640 const struct ofpact *b, size_t b_len)
1642 return a_len == b_len && !memcmp(a, b, a_len);
1645 /* Formatting ofpacts. */
1648 print_note(const struct ofpact_note *note, struct ds *string)
1652 ds_put_cstr(string, "note:");
1653 for (i = 0; i < note->length; i++) {
1655 ds_put_char(string, '.');
1657 ds_put_format(string, "%02"PRIx8, note->data[i]);
1662 print_dec_ttl(const struct ofpact_cnt_ids *ids,
1667 ds_put_cstr(s, "dec_ttl");
1668 if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
1669 ds_put_cstr(s, "(");
1670 for (i = 0; i < ids->n_controllers; i++) {
1672 ds_put_cstr(s, ",");
1674 ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
1676 ds_put_cstr(s, ")");
1681 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
1684 ds_put_cstr(s, "fin_timeout(");
1685 if (fin_timeout->fin_idle_timeout) {
1686 ds_put_format(s, "idle_timeout=%"PRIu16",",
1687 fin_timeout->fin_idle_timeout);
1689 if (fin_timeout->fin_hard_timeout) {
1690 ds_put_format(s, "hard_timeout=%"PRIu16",",
1691 fin_timeout->fin_hard_timeout);
1694 ds_put_char(s, ')');
1698 ofpact_format(const struct ofpact *a, struct ds *s)
1700 const struct ofpact_enqueue *enqueue;
1701 const struct ofpact_resubmit *resubmit;
1702 const struct ofpact_autopath *autopath;
1703 const struct ofpact_controller *controller;
1704 const struct ofpact_tunnel *tunnel;
1709 port = ofpact_get_OUTPUT(a)->port;
1710 if (port < OFPP_MAX) {
1711 ds_put_format(s, "output:%"PRIu16, port);
1713 ofputil_format_port(port, s);
1714 if (port == OFPP_CONTROLLER) {
1715 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
1720 case OFPACT_CONTROLLER:
1721 controller = ofpact_get_CONTROLLER(a);
1722 if (controller->reason == OFPR_ACTION &&
1723 controller->controller_id == 0) {
1724 ds_put_format(s, "CONTROLLER:%"PRIu16,
1725 ofpact_get_CONTROLLER(a)->max_len);
1727 enum ofp_packet_in_reason reason = controller->reason;
1729 ds_put_cstr(s, "controller(");
1730 if (reason != OFPR_ACTION) {
1731 ds_put_format(s, "reason=%s,",
1732 ofputil_packet_in_reason_to_string(reason));
1734 if (controller->max_len != UINT16_MAX) {
1735 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
1737 if (controller->controller_id != 0) {
1738 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
1741 ds_put_char(s, ')');
1745 case OFPACT_ENQUEUE:
1746 enqueue = ofpact_get_ENQUEUE(a);
1747 ds_put_format(s, "enqueue:");
1748 ofputil_format_port(enqueue->port, s);
1749 ds_put_format(s, "q%"PRIu32, enqueue->queue);
1752 case OFPACT_OUTPUT_REG:
1753 ds_put_cstr(s, "output:");
1754 mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
1758 bundle_format(ofpact_get_BUNDLE(a), s);
1761 case OFPACT_SET_VLAN_VID:
1762 ds_put_format(s, "mod_vlan_vid:%"PRIu16,
1763 ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1766 case OFPACT_SET_VLAN_PCP:
1767 ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
1768 ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
1771 case OFPACT_STRIP_VLAN:
1772 ds_put_cstr(s, "strip_vlan");
1775 case OFPACT_SET_ETH_SRC:
1776 ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
1777 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
1780 case OFPACT_SET_ETH_DST:
1781 ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
1782 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
1785 case OFPACT_SET_IPV4_SRC:
1786 ds_put_format(s, "mod_nw_src:"IP_FMT,
1787 IP_ARGS(&ofpact_get_SET_IPV4_SRC(a)->ipv4));
1790 case OFPACT_SET_IPV4_DST:
1791 ds_put_format(s, "mod_nw_dst:"IP_FMT,
1792 IP_ARGS(&ofpact_get_SET_IPV4_DST(a)->ipv4));
1795 case OFPACT_SET_IPV4_DSCP:
1796 ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
1799 case OFPACT_SET_L4_SRC_PORT:
1800 ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
1803 case OFPACT_SET_L4_DST_PORT:
1804 ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
1807 case OFPACT_REG_MOVE:
1808 nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
1811 case OFPACT_REG_LOAD:
1812 nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
1815 case OFPACT_DEC_TTL:
1816 print_dec_ttl(ofpact_get_DEC_TTL(a), s);
1819 case OFPACT_SET_TUNNEL:
1820 tunnel = ofpact_get_SET_TUNNEL(a);
1821 ds_put_format(s, "set_tunnel%s:%#"PRIx64,
1822 (tunnel->tun_id > UINT32_MAX
1823 || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
1827 case OFPACT_SET_QUEUE:
1828 ds_put_format(s, "set_queue:%"PRIu32,
1829 ofpact_get_SET_QUEUE(a)->queue_id);
1832 case OFPACT_POP_QUEUE:
1833 ds_put_cstr(s, "pop_queue");
1836 case OFPACT_FIN_TIMEOUT:
1837 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
1840 case OFPACT_RESUBMIT:
1841 resubmit = ofpact_get_RESUBMIT(a);
1842 if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
1843 ds_put_cstr(s, "resubmit:");
1844 ofputil_format_port(resubmit->in_port, s);
1846 ds_put_format(s, "resubmit(");
1847 if (resubmit->in_port != OFPP_IN_PORT) {
1848 ofputil_format_port(resubmit->in_port, s);
1850 ds_put_char(s, ',');
1851 if (resubmit->table_id != 255) {
1852 ds_put_format(s, "%"PRIu8, resubmit->table_id);
1854 ds_put_char(s, ')');
1859 learn_format(ofpact_get_LEARN(a), s);
1862 case OFPACT_MULTIPATH:
1863 multipath_format(ofpact_get_MULTIPATH(a), s);
1866 case OFPACT_AUTOPATH:
1867 autopath = ofpact_get_AUTOPATH(a);
1868 ds_put_cstr(s, "autopath(");
1869 ofputil_format_port(autopath->port, s);
1870 ds_put_char(s, ',');
1871 mf_format_subfield(&autopath->dst, s);
1872 ds_put_char(s, ')');
1876 print_note(ofpact_get_NOTE(a), s);
1880 ds_put_cstr(s, "exit");
1883 case OFPACT_CLEAR_ACTIONS:
1884 ds_put_format(s, "%s",
1885 ofpact_instruction_name_from_type(
1886 OVSINST_OFPIT11_CLEAR_ACTIONS));
1889 case OFPACT_GOTO_TABLE:
1890 ds_put_format(s, "%s:%"PRIu8,
1891 ofpact_instruction_name_from_type(
1892 OVSINST_OFPIT11_GOTO_TABLE),
1893 ofpact_get_GOTO_TABLE(a)->table_id);
1898 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
1899 * 'ofpacts' to 'string'. */
1901 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
1904 ds_put_cstr(string, "actions=");
1906 ds_put_cstr(string, "drop");
1908 const struct ofpact *a;
1910 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1912 ds_put_cstr(string, ",");
1915 /* TODO:XXX write-actions */
1916 /* TODO:XXX write-metadata */
1917 ofpact_format(a, string);
1922 /* Internal use by helpers. */
1925 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
1927 struct ofpact *ofpact;
1929 ofpact_pad(ofpacts);
1930 ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
1931 ofpact_init(ofpact, type, len);
1936 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
1938 memset(ofpact, 0, len);
1939 ofpact->type = type;
1940 ofpact->compat = OFPUTIL_ACTION_INVALID;
1944 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
1945 * starting at 'ofpact'.
1947 * This is the correct way to update a variable-length ofpact's length after
1948 * adding the variable-length part of the payload. (See the large comment
1949 * near the end of ofp-actions.h for more information.) */
1951 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
1953 assert(ofpact == ofpacts->l2);
1954 ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
1957 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
1958 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
1959 * client must call this itself after adding the final ofpact to an array of
1962 * (The consequences of failing to call this function are probably not dire.
1963 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
1964 * not dereference it. That's undefined behavior, technically, but it will not
1965 * cause a real problem on common systems. Still, it seems better to call
1968 ofpact_pad(struct ofpbuf *ofpacts)
1970 unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
1972 ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
1977 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
1980 load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
1981 load->dst.field = mf;
1983 load->dst.n_bits = mf->n_bits;
1984 bitwise_copy(src, mf->n_bytes, load->dst.ofs,
1985 &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);