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 metadata_from_nxast(const struct nx_action_write_metadata *nawm,
142 struct ofpact_metadata *om;
144 if (!is_all_zeros(nawm->zeros, sizeof nawm->zeros)) {
145 return OFPERR_NXBRC_MUST_BE_ZERO;
148 om = ofpact_put_WRITE_METADATA(out);
149 om->metadata = nawm->metadata;
150 om->mask = nawm->mask;
156 note_from_openflow(const struct nx_action_note *nan, struct ofpbuf *out)
158 struct ofpact_note *note;
161 length = ntohs(nan->len) - offsetof(struct nx_action_note, note);
162 note = ofpact_put(out, OFPACT_NOTE,
163 offsetof(struct ofpact_note, data) + length);
164 note->length = length;
165 memcpy(note->data, nan->note, length);
169 dec_ttl_from_openflow(struct ofpbuf *out, enum ofputil_action_code compat)
172 struct ofpact_cnt_ids *ids;
173 enum ofperr error = 0;
175 ids = ofpact_put_DEC_TTL(out);
176 ids->ofpact.compat = compat;
177 ids->n_controllers = 1;
178 ofpbuf_put(out, &id, sizeof id);
180 ofpact_update_len(out, &ids->ofpact);
185 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids *nac_ids,
188 struct ofpact_cnt_ids *ids;
192 ids = ofpact_put_DEC_TTL(out);
193 ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
194 ids->n_controllers = ntohs(nac_ids->n_controllers);
195 ids_size = ntohs(nac_ids->len) - sizeof *nac_ids;
197 if (!is_all_zeros(nac_ids->zeros, sizeof nac_ids->zeros)) {
198 return OFPERR_NXBRC_MUST_BE_ZERO;
201 if (ids_size < ids->n_controllers * sizeof(ovs_be16)) {
202 VLOG_WARN_RL(&rl, "Nicira action dec_ttl_cnt_ids only has %zu bytes "
203 "allocated for controller ids. %zu bytes are required for "
204 "%"PRIu16" controllers.", ids_size,
205 ids->n_controllers * sizeof(ovs_be16), ids->n_controllers);
206 return OFPERR_OFPBAC_BAD_LEN;
209 for (i = 0; i < ids->n_controllers; i++) {
210 uint16_t id = ntohs(((ovs_be16 *)(nac_ids + 1))[i]);
211 ofpbuf_put(out, &id, sizeof id);
215 ofpact_update_len(out, &ids->ofpact);
221 decode_nxast_action(const union ofp_action *a, enum ofputil_action_code *code)
223 const struct nx_action_header *nah = (const struct nx_action_header *) a;
224 uint16_t len = ntohs(a->header.len);
226 if (len < sizeof(struct nx_action_header)) {
227 return OFPERR_OFPBAC_BAD_LEN;
228 } else if (a->vendor.vendor != CONSTANT_HTONL(NX_VENDOR_ID)) {
229 return OFPERR_OFPBAC_BAD_VENDOR;
232 switch (nah->subtype) {
233 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
234 case CONSTANT_HTONS(ENUM): \
236 ? len >= sizeof(struct STRUCT) \
237 : len == sizeof(struct STRUCT)) { \
238 *code = OFPUTIL_##ENUM; \
241 return OFPERR_OFPBAC_BAD_LEN; \
244 #include "ofp-util.def"
246 case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE):
247 case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE):
249 return OFPERR_OFPBAC_BAD_TYPE;
253 /* Parses 'a' to determine its type. On success stores the correct type into
254 * '*code' and returns 0. On failure returns an OFPERR_* error code and
255 * '*code' is indeterminate.
257 * The caller must have already verified that 'a''s length is potentially
258 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
259 * ofp_action) and no longer than the amount of space allocated to 'a').
261 * This function verifies that 'a''s length is correct for the type of action
262 * that it represents. */
264 decode_openflow10_action(const union ofp_action *a,
265 enum ofputil_action_code *code)
268 case CONSTANT_HTONS(OFPAT10_VENDOR):
269 return decode_nxast_action(a, code);
271 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
272 case CONSTANT_HTONS(ENUM): \
273 if (a->header.len == htons(sizeof(struct STRUCT))) { \
274 *code = OFPUTIL_##ENUM; \
277 return OFPERR_OFPBAC_BAD_LEN; \
280 #include "ofp-util.def"
283 return OFPERR_OFPBAC_BAD_TYPE;
288 ofpact_from_nxast(const union ofp_action *a, enum ofputil_action_code code,
291 const struct nx_action_resubmit *nar;
292 const struct nx_action_set_tunnel *nast;
293 const struct nx_action_set_queue *nasq;
294 const struct nx_action_note *nan;
295 const struct nx_action_set_tunnel64 *nast64;
296 const struct nx_action_write_metadata *nawm;
297 struct ofpact_tunnel *tunnel;
298 enum ofperr error = 0;
301 case OFPUTIL_ACTION_INVALID:
302 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
303 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
304 #include "ofp-util.def"
307 case OFPUTIL_NXAST_RESUBMIT:
308 resubmit_from_openflow((const struct nx_action_resubmit *) a, out);
311 case OFPUTIL_NXAST_SET_TUNNEL:
312 nast = (const struct nx_action_set_tunnel *) a;
313 tunnel = ofpact_put_SET_TUNNEL(out);
314 tunnel->ofpact.compat = code;
315 tunnel->tun_id = ntohl(nast->tun_id);
318 case OFPUTIL_NXAST_WRITE_METADATA:
319 nawm = (const struct nx_action_write_metadata *) a;
320 error = metadata_from_nxast(nawm, out);
323 case OFPUTIL_NXAST_SET_QUEUE:
324 nasq = (const struct nx_action_set_queue *) a;
325 ofpact_put_SET_QUEUE(out)->queue_id = ntohl(nasq->queue_id);
328 case OFPUTIL_NXAST_POP_QUEUE:
329 ofpact_put_POP_QUEUE(out);
332 case OFPUTIL_NXAST_REG_MOVE:
333 error = nxm_reg_move_from_openflow(
334 (const struct nx_action_reg_move *) a, out);
337 case OFPUTIL_NXAST_REG_LOAD:
338 error = nxm_reg_load_from_openflow(
339 (const struct nx_action_reg_load *) a, out);
342 case OFPUTIL_NXAST_NOTE:
343 nan = (const struct nx_action_note *) a;
344 note_from_openflow(nan, out);
347 case OFPUTIL_NXAST_SET_TUNNEL64:
348 nast64 = (const struct nx_action_set_tunnel64 *) a;
349 tunnel = ofpact_put_SET_TUNNEL(out);
350 tunnel->ofpact.compat = code;
351 tunnel->tun_id = ntohll(nast64->tun_id);
354 case OFPUTIL_NXAST_MULTIPATH:
355 error = multipath_from_openflow((const struct nx_action_multipath *) a,
356 ofpact_put_MULTIPATH(out));
359 case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
360 error = autopath_from_openflow((const struct nx_action_autopath *) a,
361 ofpact_put_AUTOPATH(out));
364 case OFPUTIL_NXAST_BUNDLE:
365 case OFPUTIL_NXAST_BUNDLE_LOAD:
366 error = bundle_from_openflow((const struct nx_action_bundle *) a, out);
369 case OFPUTIL_NXAST_OUTPUT_REG:
370 error = output_reg_from_openflow(
371 (const struct nx_action_output_reg *) a, out);
374 case OFPUTIL_NXAST_RESUBMIT_TABLE:
375 nar = (const struct nx_action_resubmit *) a;
376 error = resubmit_table_from_openflow(nar, out);
379 case OFPUTIL_NXAST_LEARN:
380 error = learn_from_openflow((const struct nx_action_learn *) a, out);
383 case OFPUTIL_NXAST_EXIT:
384 ofpact_put_EXIT(out);
387 case OFPUTIL_NXAST_DEC_TTL:
388 error = dec_ttl_from_openflow(out, code);
391 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
392 error = dec_ttl_cnt_ids_from_openflow(
393 (const struct nx_action_cnt_ids *) a, out);
396 case OFPUTIL_NXAST_FIN_TIMEOUT:
397 fin_timeout_from_openflow(
398 (const struct nx_action_fin_timeout *) a, out);
401 case OFPUTIL_NXAST_CONTROLLER:
402 controller_from_openflow((const struct nx_action_controller *) a, out);
410 ofpact_from_openflow10(const union ofp_action *a, struct ofpbuf *out)
412 enum ofputil_action_code code;
415 error = decode_openflow10_action(a, &code);
421 case OFPUTIL_ACTION_INVALID:
422 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
423 #include "ofp-util.def"
426 case OFPUTIL_OFPAT10_OUTPUT:
427 return output_from_openflow10(&a->output10, out);
429 case OFPUTIL_OFPAT10_SET_VLAN_VID:
430 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
431 return OFPERR_OFPBAC_BAD_ARGUMENT;
433 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
436 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
437 if (a->vlan_pcp.vlan_pcp & ~7) {
438 return OFPERR_OFPBAC_BAD_ARGUMENT;
440 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
443 case OFPUTIL_OFPAT10_STRIP_VLAN:
444 ofpact_put_STRIP_VLAN(out);
447 case OFPUTIL_OFPAT10_SET_DL_SRC:
448 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
449 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
452 case OFPUTIL_OFPAT10_SET_DL_DST:
453 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
454 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
457 case OFPUTIL_OFPAT10_SET_NW_SRC:
458 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
461 case OFPUTIL_OFPAT10_SET_NW_DST:
462 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
465 case OFPUTIL_OFPAT10_SET_NW_TOS:
466 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
467 return OFPERR_OFPBAC_BAD_ARGUMENT;
469 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
472 case OFPUTIL_OFPAT10_SET_TP_SRC:
473 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
476 case OFPUTIL_OFPAT10_SET_TP_DST:
477 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
481 case OFPUTIL_OFPAT10_ENQUEUE:
482 error = enqueue_from_openflow10((const struct ofp_action_enqueue *) a,
486 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
487 #include "ofp-util.def"
488 return ofpact_from_nxast(a, code, out);
494 static inline union ofp_action *
495 action_next(const union ofp_action *a)
497 return ((union ofp_action *) (void *)
498 ((uint8_t *) a + ntohs(a->header.len)));
502 action_is_valid(const union ofp_action *a, size_t n_actions)
504 uint16_t len = ntohs(a->header.len);
505 return (!(len % OFP_ACTION_ALIGN)
507 && len / sizeof *a <= n_actions);
510 /* This macro is careful to check for actions with bad lengths. */
511 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
512 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
513 (LEFT) > 0 && action_is_valid(ITER, LEFT); \
514 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
515 (ITER) = action_next(ITER)))
518 log_bad_action(const union ofp_action *actions, size_t n_actions, size_t ofs,
521 if (!VLOG_DROP_WARN(&rl)) {
525 ds_put_hex_dump(&s, actions, n_actions * sizeof *actions, 0, false);
526 VLOG_WARN("bad action at offset %#zx (%s):\n%s",
527 ofs * sizeof *actions, ofperr_get_name(error), ds_cstr(&s));
533 ofpacts_from_openflow(const union ofp_action *in, size_t n_in,
535 enum ofperr (*ofpact_from_openflow)(
536 const union ofp_action *a, struct ofpbuf *out))
538 const union ofp_action *a;
541 ACTION_FOR_EACH (a, left, in, n_in) {
542 enum ofperr error = ofpact_from_openflow(a, out);
544 log_bad_action(in, n_in, a - in, error);
549 enum ofperr error = OFPERR_OFPBAC_BAD_LEN;
550 log_bad_action(in, n_in, n_in - left, error);
559 ofpacts_from_openflow10(const union ofp_action *in, size_t n_in,
562 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow10);
566 ofpacts_pull_actions(struct ofpbuf *openflow, unsigned int actions_len,
567 struct ofpbuf *ofpacts,
568 enum ofperr (*translate)(const union ofp_action *actions,
570 struct ofpbuf *ofpacts))
572 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
573 const union ofp_action *actions;
576 ofpbuf_clear(ofpacts);
578 if (actions_len % OFP_ACTION_ALIGN != 0) {
579 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
580 "multiple of %d", actions_len, OFP_ACTION_ALIGN);
581 return OFPERR_OFPBRC_BAD_LEN;
584 actions = ofpbuf_try_pull(openflow, actions_len);
585 if (actions == NULL) {
586 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
587 "remaining message length (%zu)",
588 actions_len, openflow->size);
589 return OFPERR_OFPBRC_BAD_LEN;
592 error = translate(actions, actions_len / OFP_ACTION_ALIGN, ofpacts);
594 ofpbuf_clear(ofpacts);
598 error = ofpacts_verify(ofpacts->data, ofpacts->size);
600 ofpbuf_clear(ofpacts);
605 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.0 actions from the
606 * front of 'openflow' into ofpacts. On success, replaces any existing content
607 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
608 * Returns 0 if successful, otherwise an OpenFlow error.
610 * The parsed actions are valid generically, but they may not be valid in a
611 * specific context. For example, port numbers up to OFPP_MAX are valid
612 * generically, but specific datapaths may only support port numbers in a
613 * smaller range. Use ofpacts_check() to additional check whether actions are
614 * valid in a specific context. */
616 ofpacts_pull_openflow10(struct ofpbuf *openflow, unsigned int actions_len,
617 struct ofpbuf *ofpacts)
619 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
620 ofpacts_from_openflow10);
623 /* OpenFlow 1.1 actions. */
625 /* Parses 'a' to determine its type. On success stores the correct type into
626 * '*code' and returns 0. On failure returns an OFPERR_* error code and
627 * '*code' is indeterminate.
629 * The caller must have already verified that 'a''s length is potentially
630 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
631 * ofp_action) and no longer than the amount of space allocated to 'a').
633 * This function verifies that 'a''s length is correct for the type of action
634 * that it represents. */
636 decode_openflow11_action(const union ofp_action *a,
637 enum ofputil_action_code *code)
642 case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
643 return decode_nxast_action(a, code);
645 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
646 case CONSTANT_HTONS(ENUM): \
647 len = ntohs(a->header.len); \
649 ? len >= sizeof(struct STRUCT) \
650 : len == sizeof(struct STRUCT)) { \
651 *code = OFPUTIL_##ENUM; \
654 return OFPERR_OFPBAC_BAD_LEN; \
657 #include "ofp-util.def"
660 return OFPERR_OFPBAC_BAD_TYPE;
665 output_from_openflow11(const struct ofp11_action_output *oao,
668 struct ofpact_output *output;
671 output = ofpact_put_OUTPUT(out);
672 output->max_len = ntohs(oao->max_len);
674 error = ofputil_port_from_ofp11(oao->port, &output->port);
679 return ofputil_check_output_port(output->port, OFPP_MAX);
683 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
685 enum ofputil_action_code code;
688 error = decode_openflow11_action(a, &code);
694 case OFPUTIL_ACTION_INVALID:
695 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
696 #include "ofp-util.def"
699 case OFPUTIL_OFPAT11_OUTPUT:
700 return output_from_openflow11((const struct ofp11_action_output *) a,
703 case OFPUTIL_OFPAT11_SET_VLAN_VID:
704 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
705 return OFPERR_OFPBAC_BAD_ARGUMENT;
707 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
710 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
711 if (a->vlan_pcp.vlan_pcp & ~7) {
712 return OFPERR_OFPBAC_BAD_ARGUMENT;
714 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
717 case OFPUTIL_OFPAT11_PUSH_VLAN:
718 if (((const struct ofp11_action_push *)a)->ethertype !=
719 htons(ETH_TYPE_VLAN_8021Q)) {
720 /* TODO:XXX 802.1AD(QinQ) isn't supported at the moment */
721 return OFPERR_OFPET_BAD_ACTION;
723 ofpact_put_PUSH_VLAN(out);
726 case OFPUTIL_OFPAT11_POP_VLAN:
727 ofpact_put_STRIP_VLAN(out);
730 case OFPUTIL_OFPAT11_SET_DL_SRC:
731 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
732 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
735 case OFPUTIL_OFPAT11_SET_DL_DST:
736 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
737 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
740 case OFPUTIL_OFPAT11_DEC_NW_TTL:
741 dec_ttl_from_openflow(out, code);
744 case OFPUTIL_OFPAT11_SET_NW_SRC:
745 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
748 case OFPUTIL_OFPAT11_SET_NW_DST:
749 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
752 case OFPUTIL_OFPAT11_SET_NW_TOS:
753 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
754 return OFPERR_OFPBAC_BAD_ARGUMENT;
756 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
759 case OFPUTIL_OFPAT11_SET_TP_SRC:
760 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
763 case OFPUTIL_OFPAT11_SET_TP_DST:
764 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
767 case OFPUTIL_OFPAT12_SET_FIELD:
768 return nxm_reg_load_from_openflow12_set_field(
769 (const struct ofp12_action_set_field *)a, out);
771 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
772 #include "ofp-util.def"
773 return ofpact_from_nxast(a, code, out);
780 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
783 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
786 /* OpenFlow 1.1 instructions. */
788 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
789 static inline const struct STRUCT * \
790 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
792 assert(inst->type == htons(ENUM)); \
793 return (struct STRUCT *)inst; \
797 instruction_init_##ENUM(struct STRUCT *s) \
799 memset(s, 0, sizeof *s); \
800 s->type = htons(ENUM); \
801 s->len = htons(sizeof *s); \
804 static inline struct STRUCT * \
805 instruction_put_##ENUM(struct ofpbuf *buf) \
807 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
808 instruction_init_##ENUM(s); \
814 struct instruction_type_info {
815 enum ovs_instruction_type type;
819 static const struct instruction_type_info inst_info[] = {
820 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
826 ofpact_instruction_name_from_type(enum ovs_instruction_type type)
828 return inst_info[type].name;
832 ofpact_instruction_type_from_name(const char *name)
834 const struct instruction_type_info *p;
835 for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
836 if (!strcasecmp(name, p->name)) {
843 static inline struct ofp11_instruction *
844 instruction_next(const struct ofp11_instruction *inst)
846 return ((struct ofp11_instruction *) (void *)
847 ((uint8_t *) inst + ntohs(inst->len)));
851 instruction_is_valid(const struct ofp11_instruction *inst,
852 size_t n_instructions)
854 uint16_t len = ntohs(inst->len);
855 return (!(len % OFP11_INSTRUCTION_ALIGN)
856 && len >= sizeof *inst
857 && len / sizeof *inst <= n_instructions);
860 /* This macro is careful to check for instructions with bad lengths. */
861 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
862 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
863 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
864 ((LEFT) -= (ntohs((ITER)->len) \
865 / sizeof(struct ofp11_instruction)), \
866 (ITER) = instruction_next(ITER)))
869 decode_openflow11_instruction(const struct ofp11_instruction *inst,
870 enum ovs_instruction_type *type)
872 uint16_t len = ntohs(inst->len);
874 switch (inst->type) {
875 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
876 return OFPERR_OFPBIC_BAD_EXPERIMENTER;
878 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
879 case CONSTANT_HTONS(ENUM): \
881 ? len >= sizeof(struct STRUCT) \
882 : len == sizeof(struct STRUCT)) { \
883 *type = OVSINST_##ENUM; \
886 return OFPERR_OFPBIC_BAD_LEN; \
892 return OFPERR_OFPBIC_UNKNOWN_INST;
897 decode_openflow11_instructions(const struct ofp11_instruction insts[],
899 const struct ofp11_instruction *out[])
901 const struct ofp11_instruction *inst;
904 memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
905 INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
906 enum ovs_instruction_type type;
909 error = decode_openflow11_instruction(inst, &type);
915 return OFPERR_OFPIT_BAD_INSTRUCTION;
921 VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
922 (n_insts - left) * sizeof *inst);
923 return OFPERR_OFPBIC_BAD_LEN;
929 get_actions_from_instruction(const struct ofp11_instruction *inst,
930 const union ofp_action **actions,
933 *actions = (const union ofp_action *) (inst + 1);
934 *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
937 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
938 * front of 'openflow' into ofpacts. On success, replaces any existing content
939 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
940 * Returns 0 if successful, otherwise an OpenFlow error.
942 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
943 * instructions, so you should call ofpacts_pull_openflow11_instructions()
944 * instead of this function.
946 * The parsed actions are valid generically, but they may not be valid in a
947 * specific context. For example, port numbers up to OFPP_MAX are valid
948 * generically, but specific datapaths may only support port numbers in a
949 * smaller range. Use ofpacts_check() to additional check whether actions are
950 * valid in a specific context. */
952 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
953 unsigned int actions_len,
954 struct ofpbuf *ofpacts)
956 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
957 ofpacts_from_openflow11);
961 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
962 unsigned int instructions_len,
963 struct ofpbuf *ofpacts)
965 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
966 const struct ofp11_instruction *instructions;
967 const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
970 ofpbuf_clear(ofpacts);
972 if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
973 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
975 instructions_len, OFP11_INSTRUCTION_ALIGN);
976 error = OFPERR_OFPBIC_BAD_LEN;
980 instructions = ofpbuf_try_pull(openflow, instructions_len);
981 if (instructions == NULL) {
982 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
983 "remaining message length (%zu)",
984 instructions_len, openflow->size);
985 error = OFPERR_OFPBIC_BAD_LEN;
989 error = decode_openflow11_instructions(
990 instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
996 if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
997 const union ofp_action *actions;
1000 get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
1001 &actions, &n_actions);
1002 error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
1007 if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
1008 instruction_get_OFPIT11_CLEAR_ACTIONS(
1009 insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
1010 ofpact_put_CLEAR_ACTIONS(ofpacts);
1012 /* TODO:XXX Write-Actions */
1013 if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
1014 const struct ofp11_instruction_write_metadata *oiwm;
1015 struct ofpact_metadata *om;
1017 oiwm = (const struct ofp11_instruction_write_metadata *)
1018 insts[OVSINST_OFPIT11_WRITE_METADATA];
1020 om = ofpact_put_WRITE_METADATA(ofpacts);
1021 om->metadata = oiwm->metadata;
1022 om->mask = oiwm->metadata_mask;
1024 if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
1025 const struct ofp11_instruction_goto_table *oigt;
1026 struct ofpact_goto_table *ogt;
1028 oigt = instruction_get_OFPIT11_GOTO_TABLE(
1029 insts[OVSINST_OFPIT11_GOTO_TABLE]);
1030 ogt = ofpact_put_GOTO_TABLE(ofpacts);
1031 ogt->table_id = oigt->table_id;
1034 if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
1035 error = OFPERR_OFPBIC_UNSUP_INST;
1039 error = ofpacts_verify(ofpacts->data, ofpacts->size);
1042 ofpbuf_clear(ofpacts);
1048 ofpact_check__(const struct ofpact *a, const struct flow *flow, int max_ports)
1050 const struct ofpact_enqueue *enqueue;
1054 return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
1057 case OFPACT_CONTROLLER:
1060 case OFPACT_ENQUEUE:
1061 enqueue = ofpact_get_ENQUEUE(a);
1062 if (enqueue->port >= max_ports && enqueue->port != OFPP_IN_PORT
1063 && enqueue->port != OFPP_LOCAL) {
1064 return OFPERR_OFPBAC_BAD_OUT_PORT;
1068 case OFPACT_OUTPUT_REG:
1069 return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1072 return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1074 case OFPACT_SET_VLAN_VID:
1075 case OFPACT_SET_VLAN_PCP:
1076 case OFPACT_STRIP_VLAN:
1077 case OFPACT_PUSH_VLAN:
1078 case OFPACT_SET_ETH_SRC:
1079 case OFPACT_SET_ETH_DST:
1080 case OFPACT_SET_IPV4_SRC:
1081 case OFPACT_SET_IPV4_DST:
1082 case OFPACT_SET_IPV4_DSCP:
1083 case OFPACT_SET_L4_SRC_PORT:
1084 case OFPACT_SET_L4_DST_PORT:
1087 case OFPACT_REG_MOVE:
1088 return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1090 case OFPACT_REG_LOAD:
1091 return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1093 case OFPACT_DEC_TTL:
1094 case OFPACT_SET_TUNNEL:
1095 case OFPACT_SET_QUEUE:
1096 case OFPACT_POP_QUEUE:
1097 case OFPACT_FIN_TIMEOUT:
1098 case OFPACT_RESUBMIT:
1102 return learn_check(ofpact_get_LEARN(a), flow);
1104 case OFPACT_MULTIPATH:
1105 return multipath_check(ofpact_get_MULTIPATH(a), flow);
1107 case OFPACT_AUTOPATH:
1108 return autopath_check(ofpact_get_AUTOPATH(a), flow);
1114 case OFPACT_CLEAR_ACTIONS:
1115 case OFPACT_WRITE_METADATA:
1116 case OFPACT_GOTO_TABLE:
1124 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1125 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1126 * switch with no more than 'max_ports' ports. */
1128 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1129 const struct flow *flow, int max_ports)
1131 const struct ofpact *a;
1133 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1134 enum ofperr error = ofpact_check__(a, flow, max_ports);
1143 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1144 * in the appropriate order as defined by the OpenFlow spec. */
1146 ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len)
1148 const struct ofpact *a;
1149 const struct ofpact_metadata *om = NULL;
1151 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1153 if (a->type == OFPACT_WRITE_METADATA) {
1154 VLOG_WARN("duplicate write_metadata instruction specified");
1155 /* should be OFPERR_OFPET_BAD_ACTION? */
1156 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1158 VLOG_WARN("write_metadata instruction must be specified after "
1159 "other instructions/actions");
1160 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1164 if (a->type == OFPACT_WRITE_METADATA) {
1165 om = (const struct ofpact_metadata *) a;
1172 /* Converting ofpacts to Nicira OpenFlow extensions. */
1175 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1178 struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1180 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1181 output_reg->src.n_bits);
1182 naor->src = htonl(output_reg->src.field->nxm_header);
1183 naor->max_len = htons(output_reg->max_len);
1187 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1190 struct nx_action_resubmit *nar;
1192 if (resubmit->table_id == 0xff
1193 && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1194 nar = ofputil_put_NXAST_RESUBMIT(out);
1196 nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1197 nar->table = resubmit->table_id;
1199 nar->in_port = htons(resubmit->in_port);
1203 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1206 uint64_t tun_id = tunnel->tun_id;
1208 if (tun_id <= UINT32_MAX
1209 && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1210 ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1212 ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1217 ofpact_write_metadata_to_nxast(const struct ofpact_metadata *om,
1220 struct nx_action_write_metadata *nawm;
1222 nawm = ofputil_put_NXAST_WRITE_METADATA(out);
1223 nawm->metadata = om->metadata;
1224 nawm->mask = om->mask;
1228 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1230 size_t start_ofs = out->size;
1231 struct nx_action_note *nan;
1232 unsigned int remainder;
1235 nan = ofputil_put_NXAST_NOTE(out);
1236 out->size -= sizeof nan->note;
1238 ofpbuf_put(out, note->data, note->length);
1240 len = out->size - start_ofs;
1241 remainder = len % OFP_ACTION_ALIGN;
1243 ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1245 nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1246 nan->len = htons(out->size - start_ofs);
1250 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1253 struct nx_action_controller *nac;
1255 nac = ofputil_put_NXAST_CONTROLLER(out);
1256 nac->max_len = htons(oc->max_len);
1257 nac->controller_id = htons(oc->controller_id);
1258 nac->reason = oc->reason;
1262 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1265 if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1266 ofputil_put_NXAST_DEC_TTL(out);
1268 struct nx_action_cnt_ids *nac_ids =
1269 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1270 int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1274 nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1275 nac_ids->n_controllers = htons(oc_ids->n_controllers);
1277 ids = ofpbuf_put_zeros(out, ids_len);
1278 for (i = 0; i < oc_ids->n_controllers; i++) {
1279 ids[i] = htons(oc_ids->cnt_ids[i]);
1285 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1288 struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1289 naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1290 naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1294 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1297 case OFPACT_CONTROLLER:
1298 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1301 case OFPACT_OUTPUT_REG:
1302 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1306 bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1309 case OFPACT_REG_MOVE:
1310 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1313 case OFPACT_REG_LOAD:
1314 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1317 case OFPACT_DEC_TTL:
1318 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1321 case OFPACT_SET_TUNNEL:
1322 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1325 case OFPACT_WRITE_METADATA:
1326 ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a), out);
1329 case OFPACT_SET_QUEUE:
1330 ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1331 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1334 case OFPACT_POP_QUEUE:
1335 ofputil_put_NXAST_POP_QUEUE(out);
1338 case OFPACT_FIN_TIMEOUT:
1339 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1342 case OFPACT_RESUBMIT:
1343 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1347 learn_to_nxast(ofpact_get_LEARN(a), out);
1350 case OFPACT_MULTIPATH:
1351 multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1354 case OFPACT_AUTOPATH:
1355 autopath_to_nxast(ofpact_get_AUTOPATH(a), out);
1359 ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1363 ofputil_put_NXAST_EXIT(out);
1367 case OFPACT_ENQUEUE:
1368 case OFPACT_SET_VLAN_VID:
1369 case OFPACT_SET_VLAN_PCP:
1370 case OFPACT_STRIP_VLAN:
1371 case OFPACT_PUSH_VLAN:
1372 case OFPACT_SET_ETH_SRC:
1373 case OFPACT_SET_ETH_DST:
1374 case OFPACT_SET_IPV4_SRC:
1375 case OFPACT_SET_IPV4_DST:
1376 case OFPACT_SET_IPV4_DSCP:
1377 case OFPACT_SET_L4_SRC_PORT:
1378 case OFPACT_SET_L4_DST_PORT:
1379 case OFPACT_CLEAR_ACTIONS:
1380 case OFPACT_GOTO_TABLE:
1385 /* Converting ofpacts to OpenFlow 1.0. */
1388 ofpact_output_to_openflow10(const struct ofpact_output *output,
1391 struct ofp10_action_output *oao;
1393 oao = ofputil_put_OFPAT10_OUTPUT(out);
1394 oao->port = htons(output->port);
1395 oao->max_len = htons(output->max_len);
1399 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1402 struct ofp_action_enqueue *oae;
1404 oae = ofputil_put_OFPAT10_ENQUEUE(out);
1405 oae->port = htons(enqueue->port);
1406 oae->queue_id = htonl(enqueue->queue);
1410 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1414 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1417 case OFPACT_ENQUEUE:
1418 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1421 case OFPACT_SET_VLAN_VID:
1422 ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1423 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1426 case OFPACT_SET_VLAN_PCP:
1427 ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1428 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1431 case OFPACT_STRIP_VLAN:
1432 ofputil_put_OFPAT10_STRIP_VLAN(out);
1435 case OFPACT_SET_ETH_SRC:
1436 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1437 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1440 case OFPACT_SET_ETH_DST:
1441 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1442 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1445 case OFPACT_SET_IPV4_SRC:
1446 ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1447 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1450 case OFPACT_SET_IPV4_DST:
1451 ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1452 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1455 case OFPACT_SET_IPV4_DSCP:
1456 ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1457 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1460 case OFPACT_SET_L4_SRC_PORT:
1461 ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1462 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1465 case OFPACT_SET_L4_DST_PORT:
1466 ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1467 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1470 case OFPACT_PUSH_VLAN:
1471 case OFPACT_CLEAR_ACTIONS:
1472 case OFPACT_GOTO_TABLE:
1476 case OFPACT_CONTROLLER:
1477 case OFPACT_OUTPUT_REG:
1479 case OFPACT_REG_MOVE:
1480 case OFPACT_REG_LOAD:
1481 case OFPACT_DEC_TTL:
1482 case OFPACT_SET_TUNNEL:
1483 case OFPACT_WRITE_METADATA:
1484 case OFPACT_SET_QUEUE:
1485 case OFPACT_POP_QUEUE:
1486 case OFPACT_FIN_TIMEOUT:
1487 case OFPACT_RESUBMIT:
1489 case OFPACT_MULTIPATH:
1490 case OFPACT_AUTOPATH:
1493 ofpact_to_nxast(a, out);
1498 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1499 * actions in 'openflow', appending the actions to any existing data in
1502 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1503 struct ofpbuf *openflow)
1505 const struct ofpact *a;
1507 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1508 ofpact_to_openflow10(a, openflow);
1512 /* Converting ofpacts to OpenFlow 1.1. */
1515 ofpact_output_to_openflow11(const struct ofpact_output *output,
1518 struct ofp11_action_output *oao;
1520 oao = ofputil_put_OFPAT11_OUTPUT(out);
1521 oao->port = ofputil_port_to_ofp11(output->port);
1522 oao->max_len = htons(output->max_len);
1526 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids *dec_ttl,
1529 if (dec_ttl->n_controllers == 1 && dec_ttl->cnt_ids[0] == 0
1530 && (!dec_ttl->ofpact.compat ||
1531 dec_ttl->ofpact.compat == OFPUTIL_OFPAT11_DEC_NW_TTL)) {
1532 ofputil_put_OFPAT11_DEC_NW_TTL(out);
1534 ofpact_dec_ttl_to_nxast(dec_ttl, out);
1539 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1543 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1545 case OFPACT_ENQUEUE:
1549 case OFPACT_SET_VLAN_VID:
1550 ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1551 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1554 case OFPACT_SET_VLAN_PCP:
1555 ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1556 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1559 case OFPACT_STRIP_VLAN:
1560 ofputil_put_OFPAT11_POP_VLAN(out);
1563 case OFPACT_PUSH_VLAN:
1564 /* TODO:XXX ETH_TYPE_VLAN_8021AD case */
1565 ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype =
1566 htons(ETH_TYPE_VLAN_8021Q);
1569 case OFPACT_SET_ETH_SRC:
1570 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1571 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1574 case OFPACT_SET_ETH_DST:
1575 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1576 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1579 case OFPACT_SET_IPV4_SRC:
1580 ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1581 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1584 case OFPACT_SET_IPV4_DST:
1585 ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1586 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1589 case OFPACT_SET_IPV4_DSCP:
1590 ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1591 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1594 case OFPACT_SET_L4_SRC_PORT:
1595 ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1596 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1599 case OFPACT_SET_L4_DST_PORT:
1600 ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1601 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1604 case OFPACT_DEC_TTL:
1605 ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a), out);
1608 case OFPACT_WRITE_METADATA:
1609 /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
1612 case OFPACT_CLEAR_ACTIONS:
1613 case OFPACT_GOTO_TABLE:
1616 case OFPACT_CONTROLLER:
1617 case OFPACT_OUTPUT_REG:
1619 case OFPACT_REG_MOVE:
1620 case OFPACT_REG_LOAD:
1621 case OFPACT_SET_TUNNEL:
1622 case OFPACT_SET_QUEUE:
1623 case OFPACT_POP_QUEUE:
1624 case OFPACT_FIN_TIMEOUT:
1625 case OFPACT_RESUBMIT:
1627 case OFPACT_MULTIPATH:
1628 case OFPACT_AUTOPATH:
1631 ofpact_to_nxast(a, out);
1636 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1637 * 1.1 actions in 'openflow', appending the actions to any existing data in
1640 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1641 size_t ofpacts_len, struct ofpbuf *openflow)
1643 const struct ofpact *a;
1644 size_t start_size = openflow->size;
1646 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1647 ofpact_to_openflow11(a, openflow);
1650 return openflow->size - start_size;
1654 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
1656 struct ofp11_instruction_actions *oia;
1658 /* Update the instruction's length (or, if it's empty, delete it). */
1659 oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1660 if (openflow->size > ofs + sizeof *oia) {
1661 oia->len = htons(openflow->size - ofs);
1663 openflow->size = ofs;
1668 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1670 struct ofpbuf *openflow)
1672 const struct ofpact *a;
1674 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1675 /* TODO:XXX Write-Actions */
1677 if (a->type == OFPACT_CLEAR_ACTIONS) {
1678 instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
1679 } else if (a->type == OFPACT_GOTO_TABLE) {
1680 struct ofp11_instruction_goto_table *oigt;
1682 oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
1683 oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
1684 memset(oigt->pad, 0, sizeof oigt->pad);
1685 } else if (a->type == OFPACT_WRITE_METADATA) {
1686 const struct ofpact_metadata *om;
1687 struct ofp11_instruction_write_metadata *oiwm;
1689 om = ofpact_get_WRITE_METADATA(a);
1690 oiwm = instruction_put_OFPIT11_WRITE_METADATA(openflow);
1691 oiwm->metadata = om->metadata;
1692 oiwm->metadata_mask = om->mask;
1693 } else if (!ofpact_is_instruction(a)) {
1695 const size_t ofs = openflow->size;
1696 const size_t ofpacts_len_left =
1697 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
1698 const struct ofpact *action;
1699 const struct ofpact *processed = a;
1701 instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1702 OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
1703 if (ofpact_is_instruction(action)) {
1706 ofpact_to_openflow11(action, openflow);
1709 ofpacts_update_instruction_actions(openflow, ofs);
1715 /* Returns true if 'action' outputs to 'port', false otherwise. */
1717 ofpact_outputs_to_port(const struct ofpact *ofpact, uint16_t port)
1719 switch (ofpact->type) {
1721 return ofpact_get_OUTPUT(ofpact)->port == port;
1722 case OFPACT_ENQUEUE:
1723 return ofpact_get_ENQUEUE(ofpact)->port == port;
1724 case OFPACT_CONTROLLER:
1725 return port == OFPP_CONTROLLER;
1727 case OFPACT_OUTPUT_REG:
1729 case OFPACT_SET_VLAN_VID:
1730 case OFPACT_SET_VLAN_PCP:
1731 case OFPACT_STRIP_VLAN:
1732 case OFPACT_PUSH_VLAN:
1733 case OFPACT_SET_ETH_SRC:
1734 case OFPACT_SET_ETH_DST:
1735 case OFPACT_SET_IPV4_SRC:
1736 case OFPACT_SET_IPV4_DST:
1737 case OFPACT_SET_IPV4_DSCP:
1738 case OFPACT_SET_L4_SRC_PORT:
1739 case OFPACT_SET_L4_DST_PORT:
1740 case OFPACT_REG_MOVE:
1741 case OFPACT_REG_LOAD:
1742 case OFPACT_DEC_TTL:
1743 case OFPACT_SET_TUNNEL:
1744 case OFPACT_WRITE_METADATA:
1745 case OFPACT_SET_QUEUE:
1746 case OFPACT_POP_QUEUE:
1747 case OFPACT_FIN_TIMEOUT:
1748 case OFPACT_RESUBMIT:
1750 case OFPACT_MULTIPATH:
1751 case OFPACT_AUTOPATH:
1754 case OFPACT_CLEAR_ACTIONS:
1755 case OFPACT_GOTO_TABLE:
1761 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1762 * to 'port', false otherwise. */
1764 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
1767 const struct ofpact *a;
1769 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1770 if (ofpact_outputs_to_port(a, port)) {
1779 ofpacts_equal(const struct ofpact *a, size_t a_len,
1780 const struct ofpact *b, size_t b_len)
1782 return a_len == b_len && !memcmp(a, b, a_len);
1785 /* Formatting ofpacts. */
1788 print_note(const struct ofpact_note *note, struct ds *string)
1792 ds_put_cstr(string, "note:");
1793 for (i = 0; i < note->length; i++) {
1795 ds_put_char(string, '.');
1797 ds_put_format(string, "%02"PRIx8, note->data[i]);
1802 print_dec_ttl(const struct ofpact_cnt_ids *ids,
1807 ds_put_cstr(s, "dec_ttl");
1808 if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
1809 ds_put_cstr(s, "(");
1810 for (i = 0; i < ids->n_controllers; i++) {
1812 ds_put_cstr(s, ",");
1814 ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
1816 ds_put_cstr(s, ")");
1821 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
1824 ds_put_cstr(s, "fin_timeout(");
1825 if (fin_timeout->fin_idle_timeout) {
1826 ds_put_format(s, "idle_timeout=%"PRIu16",",
1827 fin_timeout->fin_idle_timeout);
1829 if (fin_timeout->fin_hard_timeout) {
1830 ds_put_format(s, "hard_timeout=%"PRIu16",",
1831 fin_timeout->fin_hard_timeout);
1834 ds_put_char(s, ')');
1838 ofpact_format(const struct ofpact *a, struct ds *s)
1840 const struct ofpact_enqueue *enqueue;
1841 const struct ofpact_resubmit *resubmit;
1842 const struct ofpact_autopath *autopath;
1843 const struct ofpact_controller *controller;
1844 const struct ofpact_metadata *metadata;
1845 const struct ofpact_tunnel *tunnel;
1850 port = ofpact_get_OUTPUT(a)->port;
1851 if (port < OFPP_MAX) {
1852 ds_put_format(s, "output:%"PRIu16, port);
1854 ofputil_format_port(port, s);
1855 if (port == OFPP_CONTROLLER) {
1856 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
1861 case OFPACT_CONTROLLER:
1862 controller = ofpact_get_CONTROLLER(a);
1863 if (controller->reason == OFPR_ACTION &&
1864 controller->controller_id == 0) {
1865 ds_put_format(s, "CONTROLLER:%"PRIu16,
1866 ofpact_get_CONTROLLER(a)->max_len);
1868 enum ofp_packet_in_reason reason = controller->reason;
1870 ds_put_cstr(s, "controller(");
1871 if (reason != OFPR_ACTION) {
1872 ds_put_format(s, "reason=%s,",
1873 ofputil_packet_in_reason_to_string(reason));
1875 if (controller->max_len != UINT16_MAX) {
1876 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
1878 if (controller->controller_id != 0) {
1879 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
1882 ds_put_char(s, ')');
1886 case OFPACT_ENQUEUE:
1887 enqueue = ofpact_get_ENQUEUE(a);
1888 ds_put_format(s, "enqueue:");
1889 ofputil_format_port(enqueue->port, s);
1890 ds_put_format(s, "q%"PRIu32, enqueue->queue);
1893 case OFPACT_OUTPUT_REG:
1894 ds_put_cstr(s, "output:");
1895 mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
1899 bundle_format(ofpact_get_BUNDLE(a), s);
1902 case OFPACT_SET_VLAN_VID:
1903 ds_put_format(s, "mod_vlan_vid:%"PRIu16,
1904 ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1907 case OFPACT_SET_VLAN_PCP:
1908 ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
1909 ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
1912 case OFPACT_STRIP_VLAN:
1913 ds_put_cstr(s, "strip_vlan");
1916 case OFPACT_PUSH_VLAN:
1917 /* TODO:XXX 802.1AD case*/
1918 ds_put_format(s, "push_vlan:%#"PRIx16, ETH_TYPE_VLAN_8021Q);
1921 case OFPACT_SET_ETH_SRC:
1922 ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
1923 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
1926 case OFPACT_SET_ETH_DST:
1927 ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
1928 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
1931 case OFPACT_SET_IPV4_SRC:
1932 ds_put_format(s, "mod_nw_src:"IP_FMT,
1933 IP_ARGS(&ofpact_get_SET_IPV4_SRC(a)->ipv4));
1936 case OFPACT_SET_IPV4_DST:
1937 ds_put_format(s, "mod_nw_dst:"IP_FMT,
1938 IP_ARGS(&ofpact_get_SET_IPV4_DST(a)->ipv4));
1941 case OFPACT_SET_IPV4_DSCP:
1942 ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
1945 case OFPACT_SET_L4_SRC_PORT:
1946 ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
1949 case OFPACT_SET_L4_DST_PORT:
1950 ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
1953 case OFPACT_REG_MOVE:
1954 nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
1957 case OFPACT_REG_LOAD:
1958 nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
1961 case OFPACT_DEC_TTL:
1962 print_dec_ttl(ofpact_get_DEC_TTL(a), s);
1965 case OFPACT_SET_TUNNEL:
1966 tunnel = ofpact_get_SET_TUNNEL(a);
1967 ds_put_format(s, "set_tunnel%s:%#"PRIx64,
1968 (tunnel->tun_id > UINT32_MAX
1969 || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
1973 case OFPACT_SET_QUEUE:
1974 ds_put_format(s, "set_queue:%"PRIu32,
1975 ofpact_get_SET_QUEUE(a)->queue_id);
1978 case OFPACT_POP_QUEUE:
1979 ds_put_cstr(s, "pop_queue");
1982 case OFPACT_FIN_TIMEOUT:
1983 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
1986 case OFPACT_RESUBMIT:
1987 resubmit = ofpact_get_RESUBMIT(a);
1988 if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
1989 ds_put_cstr(s, "resubmit:");
1990 ofputil_format_port(resubmit->in_port, s);
1992 ds_put_format(s, "resubmit(");
1993 if (resubmit->in_port != OFPP_IN_PORT) {
1994 ofputil_format_port(resubmit->in_port, s);
1996 ds_put_char(s, ',');
1997 if (resubmit->table_id != 255) {
1998 ds_put_format(s, "%"PRIu8, resubmit->table_id);
2000 ds_put_char(s, ')');
2005 learn_format(ofpact_get_LEARN(a), s);
2008 case OFPACT_MULTIPATH:
2009 multipath_format(ofpact_get_MULTIPATH(a), s);
2012 case OFPACT_AUTOPATH:
2013 autopath = ofpact_get_AUTOPATH(a);
2014 ds_put_cstr(s, "autopath(");
2015 ofputil_format_port(autopath->port, s);
2016 ds_put_char(s, ',');
2017 mf_format_subfield(&autopath->dst, s);
2018 ds_put_char(s, ')');
2022 print_note(ofpact_get_NOTE(a), s);
2026 ds_put_cstr(s, "exit");
2029 case OFPACT_CLEAR_ACTIONS:
2030 ds_put_format(s, "%s",
2031 ofpact_instruction_name_from_type(
2032 OVSINST_OFPIT11_CLEAR_ACTIONS));
2035 case OFPACT_WRITE_METADATA:
2036 metadata = ofpact_get_WRITE_METADATA(a);
2037 ds_put_format(s, "%s:%#"PRIx64,
2038 ofpact_instruction_name_from_type(
2039 OVSINST_OFPIT11_WRITE_METADATA),
2040 ntohll(metadata->metadata));
2041 if (metadata->mask != htonll(UINT64_MAX)) {
2042 ds_put_format(s, "/%#"PRIx64, ntohll(metadata->mask));
2046 case OFPACT_GOTO_TABLE:
2047 ds_put_format(s, "%s:%"PRIu8,
2048 ofpact_instruction_name_from_type(
2049 OVSINST_OFPIT11_GOTO_TABLE),
2050 ofpact_get_GOTO_TABLE(a)->table_id);
2055 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
2056 * 'ofpacts' to 'string'. */
2058 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
2061 ds_put_cstr(string, "actions=");
2063 ds_put_cstr(string, "drop");
2065 const struct ofpact *a;
2067 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2069 ds_put_cstr(string, ",");
2072 /* TODO:XXX write-actions */
2073 ofpact_format(a, string);
2078 /* Internal use by helpers. */
2081 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
2083 struct ofpact *ofpact;
2085 ofpact_pad(ofpacts);
2086 ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
2087 ofpact_init(ofpact, type, len);
2092 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
2094 memset(ofpact, 0, len);
2095 ofpact->type = type;
2096 ofpact->compat = OFPUTIL_ACTION_INVALID;
2100 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
2101 * starting at 'ofpact'.
2103 * This is the correct way to update a variable-length ofpact's length after
2104 * adding the variable-length part of the payload. (See the large comment
2105 * near the end of ofp-actions.h for more information.) */
2107 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
2109 assert(ofpact == ofpacts->l2);
2110 ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
2113 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
2114 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
2115 * client must call this itself after adding the final ofpact to an array of
2118 * (The consequences of failing to call this function are probably not dire.
2119 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
2120 * not dereference it. That's undefined behavior, technically, but it will not
2121 * cause a real problem on common systems. Still, it seems better to call
2124 ofpact_pad(struct ofpbuf *ofpacts)
2126 unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
2128 ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
2133 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
2136 load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
2137 load->dst.field = mf;
2139 load->dst.n_bits = mf->n_bits;
2140 bitwise_copy(src, mf->n_bytes, load->dst.ofs,
2141 &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);