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 ofp10_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 ofp10_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_OFPBAC_BAD_ARGUMENT;
723 ofpact_put_PUSH_VLAN(out);
726 case OFPUTIL_OFPAT11_POP_VLAN:
727 ofpact_put_STRIP_VLAN(out);
730 case OFPUTIL_OFPAT11_SET_QUEUE:
731 ofpact_put_SET_QUEUE(out)->queue_id =
732 ntohl(((const struct ofp11_action_set_queue *)a)->queue_id);
735 case OFPUTIL_OFPAT11_SET_DL_SRC:
736 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
737 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
740 case OFPUTIL_OFPAT11_SET_DL_DST:
741 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
742 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
745 case OFPUTIL_OFPAT11_DEC_NW_TTL:
746 dec_ttl_from_openflow(out, code);
749 case OFPUTIL_OFPAT11_SET_NW_SRC:
750 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
753 case OFPUTIL_OFPAT11_SET_NW_DST:
754 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
757 case OFPUTIL_OFPAT11_SET_NW_TOS:
758 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
759 return OFPERR_OFPBAC_BAD_ARGUMENT;
761 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
764 case OFPUTIL_OFPAT11_SET_TP_SRC:
765 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
768 case OFPUTIL_OFPAT11_SET_TP_DST:
769 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
772 case OFPUTIL_OFPAT12_SET_FIELD:
773 return nxm_reg_load_from_openflow12_set_field(
774 (const struct ofp12_action_set_field *)a, out);
776 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
777 #include "ofp-util.def"
778 return ofpact_from_nxast(a, code, out);
785 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
788 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
791 /* OpenFlow 1.1 instructions. */
793 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
794 static inline const struct STRUCT * \
795 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
797 assert(inst->type == htons(ENUM)); \
798 return (struct STRUCT *)inst; \
802 instruction_init_##ENUM(struct STRUCT *s) \
804 memset(s, 0, sizeof *s); \
805 s->type = htons(ENUM); \
806 s->len = htons(sizeof *s); \
809 static inline struct STRUCT * \
810 instruction_put_##ENUM(struct ofpbuf *buf) \
812 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
813 instruction_init_##ENUM(s); \
819 struct instruction_type_info {
820 enum ovs_instruction_type type;
824 static const struct instruction_type_info inst_info[] = {
825 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
831 ofpact_instruction_name_from_type(enum ovs_instruction_type type)
833 return inst_info[type].name;
837 ofpact_instruction_type_from_name(const char *name)
839 const struct instruction_type_info *p;
840 for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
841 if (!strcasecmp(name, p->name)) {
848 static inline struct ofp11_instruction *
849 instruction_next(const struct ofp11_instruction *inst)
851 return ((struct ofp11_instruction *) (void *)
852 ((uint8_t *) inst + ntohs(inst->len)));
856 instruction_is_valid(const struct ofp11_instruction *inst,
857 size_t n_instructions)
859 uint16_t len = ntohs(inst->len);
860 return (!(len % OFP11_INSTRUCTION_ALIGN)
861 && len >= sizeof *inst
862 && len / sizeof *inst <= n_instructions);
865 /* This macro is careful to check for instructions with bad lengths. */
866 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
867 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
868 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
869 ((LEFT) -= (ntohs((ITER)->len) \
870 / sizeof(struct ofp11_instruction)), \
871 (ITER) = instruction_next(ITER)))
874 decode_openflow11_instruction(const struct ofp11_instruction *inst,
875 enum ovs_instruction_type *type)
877 uint16_t len = ntohs(inst->len);
879 switch (inst->type) {
880 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
881 return OFPERR_OFPBIC_BAD_EXPERIMENTER;
883 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
884 case CONSTANT_HTONS(ENUM): \
886 ? len >= sizeof(struct STRUCT) \
887 : len == sizeof(struct STRUCT)) { \
888 *type = OVSINST_##ENUM; \
891 return OFPERR_OFPBIC_BAD_LEN; \
897 return OFPERR_OFPBIC_UNKNOWN_INST;
902 decode_openflow11_instructions(const struct ofp11_instruction insts[],
904 const struct ofp11_instruction *out[])
906 const struct ofp11_instruction *inst;
909 memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
910 INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
911 enum ovs_instruction_type type;
914 error = decode_openflow11_instruction(inst, &type);
920 return OFPERR_OFPBAC_UNSUPPORTED_ORDER; /* No specific code for
921 * a duplicate instruction
928 VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
929 (n_insts - left) * sizeof *inst);
930 return OFPERR_OFPBIC_BAD_LEN;
936 get_actions_from_instruction(const struct ofp11_instruction *inst,
937 const union ofp_action **actions,
940 *actions = (const union ofp_action *) (inst + 1);
941 *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
944 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
945 * front of 'openflow' into ofpacts. On success, replaces any existing content
946 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
947 * Returns 0 if successful, otherwise an OpenFlow error.
949 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
950 * instructions, so you should call ofpacts_pull_openflow11_instructions()
951 * instead of this function.
953 * The parsed actions are valid generically, but they may not be valid in a
954 * specific context. For example, port numbers up to OFPP_MAX are valid
955 * generically, but specific datapaths may only support port numbers in a
956 * smaller range. Use ofpacts_check() to additional check whether actions are
957 * valid in a specific context. */
959 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
960 unsigned int actions_len,
961 struct ofpbuf *ofpacts)
963 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
964 ofpacts_from_openflow11);
968 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
969 unsigned int instructions_len,
970 struct ofpbuf *ofpacts)
972 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
973 const struct ofp11_instruction *instructions;
974 const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
977 ofpbuf_clear(ofpacts);
979 if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
980 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
982 instructions_len, OFP11_INSTRUCTION_ALIGN);
983 error = OFPERR_OFPBIC_BAD_LEN;
987 instructions = ofpbuf_try_pull(openflow, instructions_len);
988 if (instructions == NULL) {
989 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
990 "remaining message length (%zu)",
991 instructions_len, openflow->size);
992 error = OFPERR_OFPBIC_BAD_LEN;
996 error = decode_openflow11_instructions(
997 instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
1003 if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
1004 const union ofp_action *actions;
1007 get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
1008 &actions, &n_actions);
1009 error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
1014 if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
1015 instruction_get_OFPIT11_CLEAR_ACTIONS(
1016 insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
1017 ofpact_put_CLEAR_ACTIONS(ofpacts);
1019 /* TODO:XXX Write-Actions */
1020 if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
1021 const struct ofp11_instruction_write_metadata *oiwm;
1022 struct ofpact_metadata *om;
1024 oiwm = (const struct ofp11_instruction_write_metadata *)
1025 insts[OVSINST_OFPIT11_WRITE_METADATA];
1027 om = ofpact_put_WRITE_METADATA(ofpacts);
1028 om->metadata = oiwm->metadata;
1029 om->mask = oiwm->metadata_mask;
1031 if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
1032 const struct ofp11_instruction_goto_table *oigt;
1033 struct ofpact_goto_table *ogt;
1035 oigt = instruction_get_OFPIT11_GOTO_TABLE(
1036 insts[OVSINST_OFPIT11_GOTO_TABLE]);
1037 ogt = ofpact_put_GOTO_TABLE(ofpacts);
1038 ogt->table_id = oigt->table_id;
1041 if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
1042 error = OFPERR_OFPBIC_UNSUP_INST;
1046 error = ofpacts_verify(ofpacts->data, ofpacts->size);
1049 ofpbuf_clear(ofpacts);
1055 ofpact_check__(const struct ofpact *a, const struct flow *flow, int max_ports)
1057 const struct ofpact_enqueue *enqueue;
1061 return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
1064 case OFPACT_CONTROLLER:
1067 case OFPACT_ENQUEUE:
1068 enqueue = ofpact_get_ENQUEUE(a);
1069 if (enqueue->port >= max_ports && enqueue->port != OFPP_IN_PORT
1070 && enqueue->port != OFPP_LOCAL) {
1071 return OFPERR_OFPBAC_BAD_OUT_PORT;
1075 case OFPACT_OUTPUT_REG:
1076 return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1079 return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1081 case OFPACT_SET_VLAN_VID:
1082 case OFPACT_SET_VLAN_PCP:
1083 case OFPACT_STRIP_VLAN:
1084 case OFPACT_PUSH_VLAN:
1085 case OFPACT_SET_ETH_SRC:
1086 case OFPACT_SET_ETH_DST:
1087 case OFPACT_SET_IPV4_SRC:
1088 case OFPACT_SET_IPV4_DST:
1089 case OFPACT_SET_IPV4_DSCP:
1090 case OFPACT_SET_L4_SRC_PORT:
1091 case OFPACT_SET_L4_DST_PORT:
1094 case OFPACT_REG_MOVE:
1095 return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1097 case OFPACT_REG_LOAD:
1098 return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1100 case OFPACT_DEC_TTL:
1101 case OFPACT_SET_TUNNEL:
1102 case OFPACT_SET_QUEUE:
1103 case OFPACT_POP_QUEUE:
1104 case OFPACT_FIN_TIMEOUT:
1105 case OFPACT_RESUBMIT:
1109 return learn_check(ofpact_get_LEARN(a), flow);
1111 case OFPACT_MULTIPATH:
1112 return multipath_check(ofpact_get_MULTIPATH(a), flow);
1114 case OFPACT_AUTOPATH:
1115 return autopath_check(ofpact_get_AUTOPATH(a), flow);
1121 case OFPACT_CLEAR_ACTIONS:
1122 case OFPACT_WRITE_METADATA:
1123 case OFPACT_GOTO_TABLE:
1131 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1132 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1133 * switch with no more than 'max_ports' ports. */
1135 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1136 const struct flow *flow, int max_ports)
1138 const struct ofpact *a;
1140 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1141 enum ofperr error = ofpact_check__(a, flow, max_ports);
1150 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1151 * in the appropriate order as defined by the OpenFlow spec. */
1153 ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len)
1155 const struct ofpact *a;
1156 const struct ofpact_metadata *om = NULL;
1158 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1160 if (a->type == OFPACT_WRITE_METADATA) {
1161 VLOG_WARN("duplicate write_metadata instruction specified");
1162 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1164 VLOG_WARN("write_metadata instruction must be specified after "
1165 "other instructions/actions");
1166 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1170 if (a->type == OFPACT_WRITE_METADATA) {
1171 om = (const struct ofpact_metadata *) a;
1178 /* Converting ofpacts to Nicira OpenFlow extensions. */
1181 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1184 struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1186 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1187 output_reg->src.n_bits);
1188 naor->src = htonl(output_reg->src.field->nxm_header);
1189 naor->max_len = htons(output_reg->max_len);
1193 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1196 struct nx_action_resubmit *nar;
1198 if (resubmit->table_id == 0xff
1199 && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1200 nar = ofputil_put_NXAST_RESUBMIT(out);
1202 nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1203 nar->table = resubmit->table_id;
1205 nar->in_port = htons(resubmit->in_port);
1209 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1212 uint64_t tun_id = tunnel->tun_id;
1214 if (tun_id <= UINT32_MAX
1215 && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1216 ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1218 ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1223 ofpact_write_metadata_to_nxast(const struct ofpact_metadata *om,
1226 struct nx_action_write_metadata *nawm;
1228 nawm = ofputil_put_NXAST_WRITE_METADATA(out);
1229 nawm->metadata = om->metadata;
1230 nawm->mask = om->mask;
1234 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1236 size_t start_ofs = out->size;
1237 struct nx_action_note *nan;
1238 unsigned int remainder;
1241 nan = ofputil_put_NXAST_NOTE(out);
1242 out->size -= sizeof nan->note;
1244 ofpbuf_put(out, note->data, note->length);
1246 len = out->size - start_ofs;
1247 remainder = len % OFP_ACTION_ALIGN;
1249 ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1251 nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1252 nan->len = htons(out->size - start_ofs);
1256 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1259 struct nx_action_controller *nac;
1261 nac = ofputil_put_NXAST_CONTROLLER(out);
1262 nac->max_len = htons(oc->max_len);
1263 nac->controller_id = htons(oc->controller_id);
1264 nac->reason = oc->reason;
1268 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1271 if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1272 ofputil_put_NXAST_DEC_TTL(out);
1274 struct nx_action_cnt_ids *nac_ids =
1275 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1276 int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1280 nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1281 nac_ids->n_controllers = htons(oc_ids->n_controllers);
1283 ids = ofpbuf_put_zeros(out, ids_len);
1284 for (i = 0; i < oc_ids->n_controllers; i++) {
1285 ids[i] = htons(oc_ids->cnt_ids[i]);
1291 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1294 struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1295 naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1296 naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1300 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1303 case OFPACT_CONTROLLER:
1304 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1307 case OFPACT_OUTPUT_REG:
1308 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1312 bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1315 case OFPACT_REG_MOVE:
1316 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1319 case OFPACT_REG_LOAD:
1320 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1323 case OFPACT_DEC_TTL:
1324 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1327 case OFPACT_SET_TUNNEL:
1328 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1331 case OFPACT_WRITE_METADATA:
1332 ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a), out);
1335 case OFPACT_SET_QUEUE:
1336 ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1337 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1340 case OFPACT_POP_QUEUE:
1341 ofputil_put_NXAST_POP_QUEUE(out);
1344 case OFPACT_FIN_TIMEOUT:
1345 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1348 case OFPACT_RESUBMIT:
1349 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1353 learn_to_nxast(ofpact_get_LEARN(a), out);
1356 case OFPACT_MULTIPATH:
1357 multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1360 case OFPACT_AUTOPATH:
1361 autopath_to_nxast(ofpact_get_AUTOPATH(a), out);
1365 ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1369 ofputil_put_NXAST_EXIT(out);
1373 case OFPACT_ENQUEUE:
1374 case OFPACT_SET_VLAN_VID:
1375 case OFPACT_SET_VLAN_PCP:
1376 case OFPACT_STRIP_VLAN:
1377 case OFPACT_PUSH_VLAN:
1378 case OFPACT_SET_ETH_SRC:
1379 case OFPACT_SET_ETH_DST:
1380 case OFPACT_SET_IPV4_SRC:
1381 case OFPACT_SET_IPV4_DST:
1382 case OFPACT_SET_IPV4_DSCP:
1383 case OFPACT_SET_L4_SRC_PORT:
1384 case OFPACT_SET_L4_DST_PORT:
1385 case OFPACT_CLEAR_ACTIONS:
1386 case OFPACT_GOTO_TABLE:
1391 /* Converting ofpacts to OpenFlow 1.0. */
1394 ofpact_output_to_openflow10(const struct ofpact_output *output,
1397 struct ofp10_action_output *oao;
1399 oao = ofputil_put_OFPAT10_OUTPUT(out);
1400 oao->port = htons(output->port);
1401 oao->max_len = htons(output->max_len);
1405 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1408 struct ofp10_action_enqueue *oae;
1410 oae = ofputil_put_OFPAT10_ENQUEUE(out);
1411 oae->port = htons(enqueue->port);
1412 oae->queue_id = htonl(enqueue->queue);
1416 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1420 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1423 case OFPACT_ENQUEUE:
1424 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1427 case OFPACT_SET_VLAN_VID:
1428 ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1429 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1432 case OFPACT_SET_VLAN_PCP:
1433 ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1434 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1437 case OFPACT_STRIP_VLAN:
1438 ofputil_put_OFPAT10_STRIP_VLAN(out);
1441 case OFPACT_SET_ETH_SRC:
1442 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1443 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1446 case OFPACT_SET_ETH_DST:
1447 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1448 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1451 case OFPACT_SET_IPV4_SRC:
1452 ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1453 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1456 case OFPACT_SET_IPV4_DST:
1457 ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1458 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1461 case OFPACT_SET_IPV4_DSCP:
1462 ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1463 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1466 case OFPACT_SET_L4_SRC_PORT:
1467 ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1468 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1471 case OFPACT_SET_L4_DST_PORT:
1472 ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1473 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1476 case OFPACT_PUSH_VLAN:
1477 case OFPACT_CLEAR_ACTIONS:
1478 case OFPACT_GOTO_TABLE:
1482 case OFPACT_CONTROLLER:
1483 case OFPACT_OUTPUT_REG:
1485 case OFPACT_REG_MOVE:
1486 case OFPACT_REG_LOAD:
1487 case OFPACT_DEC_TTL:
1488 case OFPACT_SET_TUNNEL:
1489 case OFPACT_WRITE_METADATA:
1490 case OFPACT_SET_QUEUE:
1491 case OFPACT_POP_QUEUE:
1492 case OFPACT_FIN_TIMEOUT:
1493 case OFPACT_RESUBMIT:
1495 case OFPACT_MULTIPATH:
1496 case OFPACT_AUTOPATH:
1499 ofpact_to_nxast(a, out);
1504 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1505 * actions in 'openflow', appending the actions to any existing data in
1508 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1509 struct ofpbuf *openflow)
1511 const struct ofpact *a;
1513 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1514 ofpact_to_openflow10(a, openflow);
1518 /* Converting ofpacts to OpenFlow 1.1. */
1521 ofpact_output_to_openflow11(const struct ofpact_output *output,
1524 struct ofp11_action_output *oao;
1526 oao = ofputil_put_OFPAT11_OUTPUT(out);
1527 oao->port = ofputil_port_to_ofp11(output->port);
1528 oao->max_len = htons(output->max_len);
1532 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids *dec_ttl,
1535 if (dec_ttl->n_controllers == 1 && dec_ttl->cnt_ids[0] == 0
1536 && (!dec_ttl->ofpact.compat ||
1537 dec_ttl->ofpact.compat == OFPUTIL_OFPAT11_DEC_NW_TTL)) {
1538 ofputil_put_OFPAT11_DEC_NW_TTL(out);
1540 ofpact_dec_ttl_to_nxast(dec_ttl, out);
1545 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1549 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1551 case OFPACT_ENQUEUE:
1555 case OFPACT_SET_VLAN_VID:
1556 ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1557 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1560 case OFPACT_SET_VLAN_PCP:
1561 ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1562 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1565 case OFPACT_STRIP_VLAN:
1566 ofputil_put_OFPAT11_POP_VLAN(out);
1569 case OFPACT_PUSH_VLAN:
1570 /* TODO:XXX ETH_TYPE_VLAN_8021AD case */
1571 ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype =
1572 htons(ETH_TYPE_VLAN_8021Q);
1575 case OFPACT_SET_QUEUE:
1576 ofputil_put_OFPAT11_SET_QUEUE(out)->queue_id
1577 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1580 case OFPACT_SET_ETH_SRC:
1581 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1582 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1585 case OFPACT_SET_ETH_DST:
1586 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1587 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1590 case OFPACT_SET_IPV4_SRC:
1591 ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1592 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1595 case OFPACT_SET_IPV4_DST:
1596 ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1597 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1600 case OFPACT_SET_IPV4_DSCP:
1601 ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1602 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1605 case OFPACT_SET_L4_SRC_PORT:
1606 ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1607 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1610 case OFPACT_SET_L4_DST_PORT:
1611 ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1612 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1615 case OFPACT_DEC_TTL:
1616 ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a), out);
1619 case OFPACT_WRITE_METADATA:
1620 /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
1623 case OFPACT_CLEAR_ACTIONS:
1624 case OFPACT_GOTO_TABLE:
1627 case OFPACT_CONTROLLER:
1628 case OFPACT_OUTPUT_REG:
1630 case OFPACT_REG_MOVE:
1631 case OFPACT_REG_LOAD:
1632 case OFPACT_SET_TUNNEL:
1633 case OFPACT_POP_QUEUE:
1634 case OFPACT_FIN_TIMEOUT:
1635 case OFPACT_RESUBMIT:
1637 case OFPACT_MULTIPATH:
1638 case OFPACT_AUTOPATH:
1641 ofpact_to_nxast(a, out);
1646 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1647 * 1.1 actions in 'openflow', appending the actions to any existing data in
1650 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1651 size_t ofpacts_len, struct ofpbuf *openflow)
1653 const struct ofpact *a;
1654 size_t start_size = openflow->size;
1656 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1657 ofpact_to_openflow11(a, openflow);
1660 return openflow->size - start_size;
1664 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
1666 struct ofp11_instruction_actions *oia;
1668 /* Update the instruction's length (or, if it's empty, delete it). */
1669 oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1670 if (openflow->size > ofs + sizeof *oia) {
1671 oia->len = htons(openflow->size - ofs);
1673 openflow->size = ofs;
1678 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1680 struct ofpbuf *openflow)
1682 const struct ofpact *a;
1684 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1685 /* TODO:XXX Write-Actions */
1687 if (a->type == OFPACT_CLEAR_ACTIONS) {
1688 instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
1689 } else if (a->type == OFPACT_GOTO_TABLE) {
1690 struct ofp11_instruction_goto_table *oigt;
1692 oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
1693 oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
1694 memset(oigt->pad, 0, sizeof oigt->pad);
1695 } else if (a->type == OFPACT_WRITE_METADATA) {
1696 const struct ofpact_metadata *om;
1697 struct ofp11_instruction_write_metadata *oiwm;
1699 om = ofpact_get_WRITE_METADATA(a);
1700 oiwm = instruction_put_OFPIT11_WRITE_METADATA(openflow);
1701 oiwm->metadata = om->metadata;
1702 oiwm->metadata_mask = om->mask;
1703 } else if (!ofpact_is_instruction(a)) {
1705 const size_t ofs = openflow->size;
1706 const size_t ofpacts_len_left =
1707 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
1708 const struct ofpact *action;
1709 const struct ofpact *processed = a;
1711 instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1712 OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
1713 if (ofpact_is_instruction(action)) {
1716 ofpact_to_openflow11(action, openflow);
1719 ofpacts_update_instruction_actions(openflow, ofs);
1725 /* Returns true if 'action' outputs to 'port', false otherwise. */
1727 ofpact_outputs_to_port(const struct ofpact *ofpact, uint16_t port)
1729 switch (ofpact->type) {
1731 return ofpact_get_OUTPUT(ofpact)->port == port;
1732 case OFPACT_ENQUEUE:
1733 return ofpact_get_ENQUEUE(ofpact)->port == port;
1734 case OFPACT_CONTROLLER:
1735 return port == OFPP_CONTROLLER;
1737 case OFPACT_OUTPUT_REG:
1739 case OFPACT_SET_VLAN_VID:
1740 case OFPACT_SET_VLAN_PCP:
1741 case OFPACT_STRIP_VLAN:
1742 case OFPACT_PUSH_VLAN:
1743 case OFPACT_SET_ETH_SRC:
1744 case OFPACT_SET_ETH_DST:
1745 case OFPACT_SET_IPV4_SRC:
1746 case OFPACT_SET_IPV4_DST:
1747 case OFPACT_SET_IPV4_DSCP:
1748 case OFPACT_SET_L4_SRC_PORT:
1749 case OFPACT_SET_L4_DST_PORT:
1750 case OFPACT_REG_MOVE:
1751 case OFPACT_REG_LOAD:
1752 case OFPACT_DEC_TTL:
1753 case OFPACT_SET_TUNNEL:
1754 case OFPACT_WRITE_METADATA:
1755 case OFPACT_SET_QUEUE:
1756 case OFPACT_POP_QUEUE:
1757 case OFPACT_FIN_TIMEOUT:
1758 case OFPACT_RESUBMIT:
1760 case OFPACT_MULTIPATH:
1761 case OFPACT_AUTOPATH:
1764 case OFPACT_CLEAR_ACTIONS:
1765 case OFPACT_GOTO_TABLE:
1771 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1772 * to 'port', false otherwise. */
1774 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
1777 const struct ofpact *a;
1779 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1780 if (ofpact_outputs_to_port(a, port)) {
1789 ofpacts_equal(const struct ofpact *a, size_t a_len,
1790 const struct ofpact *b, size_t b_len)
1792 return a_len == b_len && !memcmp(a, b, a_len);
1795 /* Formatting ofpacts. */
1798 print_note(const struct ofpact_note *note, struct ds *string)
1802 ds_put_cstr(string, "note:");
1803 for (i = 0; i < note->length; i++) {
1805 ds_put_char(string, '.');
1807 ds_put_format(string, "%02"PRIx8, note->data[i]);
1812 print_dec_ttl(const struct ofpact_cnt_ids *ids,
1817 ds_put_cstr(s, "dec_ttl");
1818 if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
1819 ds_put_cstr(s, "(");
1820 for (i = 0; i < ids->n_controllers; i++) {
1822 ds_put_cstr(s, ",");
1824 ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
1826 ds_put_cstr(s, ")");
1831 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
1834 ds_put_cstr(s, "fin_timeout(");
1835 if (fin_timeout->fin_idle_timeout) {
1836 ds_put_format(s, "idle_timeout=%"PRIu16",",
1837 fin_timeout->fin_idle_timeout);
1839 if (fin_timeout->fin_hard_timeout) {
1840 ds_put_format(s, "hard_timeout=%"PRIu16",",
1841 fin_timeout->fin_hard_timeout);
1844 ds_put_char(s, ')');
1848 ofpact_format(const struct ofpact *a, struct ds *s)
1850 const struct ofpact_enqueue *enqueue;
1851 const struct ofpact_resubmit *resubmit;
1852 const struct ofpact_autopath *autopath;
1853 const struct ofpact_controller *controller;
1854 const struct ofpact_metadata *metadata;
1855 const struct ofpact_tunnel *tunnel;
1860 port = ofpact_get_OUTPUT(a)->port;
1861 if (port < OFPP_MAX) {
1862 ds_put_format(s, "output:%"PRIu16, port);
1864 ofputil_format_port(port, s);
1865 if (port == OFPP_CONTROLLER) {
1866 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
1871 case OFPACT_CONTROLLER:
1872 controller = ofpact_get_CONTROLLER(a);
1873 if (controller->reason == OFPR_ACTION &&
1874 controller->controller_id == 0) {
1875 ds_put_format(s, "CONTROLLER:%"PRIu16,
1876 ofpact_get_CONTROLLER(a)->max_len);
1878 enum ofp_packet_in_reason reason = controller->reason;
1880 ds_put_cstr(s, "controller(");
1881 if (reason != OFPR_ACTION) {
1882 ds_put_format(s, "reason=%s,",
1883 ofputil_packet_in_reason_to_string(reason));
1885 if (controller->max_len != UINT16_MAX) {
1886 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
1888 if (controller->controller_id != 0) {
1889 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
1892 ds_put_char(s, ')');
1896 case OFPACT_ENQUEUE:
1897 enqueue = ofpact_get_ENQUEUE(a);
1898 ds_put_format(s, "enqueue:");
1899 ofputil_format_port(enqueue->port, s);
1900 ds_put_format(s, "q%"PRIu32, enqueue->queue);
1903 case OFPACT_OUTPUT_REG:
1904 ds_put_cstr(s, "output:");
1905 mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
1909 bundle_format(ofpact_get_BUNDLE(a), s);
1912 case OFPACT_SET_VLAN_VID:
1913 ds_put_format(s, "mod_vlan_vid:%"PRIu16,
1914 ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1917 case OFPACT_SET_VLAN_PCP:
1918 ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
1919 ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
1922 case OFPACT_STRIP_VLAN:
1923 ds_put_cstr(s, "strip_vlan");
1926 case OFPACT_PUSH_VLAN:
1927 /* TODO:XXX 802.1AD case*/
1928 ds_put_format(s, "push_vlan:%#"PRIx16, ETH_TYPE_VLAN_8021Q);
1931 case OFPACT_SET_ETH_SRC:
1932 ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
1933 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
1936 case OFPACT_SET_ETH_DST:
1937 ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
1938 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
1941 case OFPACT_SET_IPV4_SRC:
1942 ds_put_format(s, "mod_nw_src:"IP_FMT,
1943 IP_ARGS(&ofpact_get_SET_IPV4_SRC(a)->ipv4));
1946 case OFPACT_SET_IPV4_DST:
1947 ds_put_format(s, "mod_nw_dst:"IP_FMT,
1948 IP_ARGS(&ofpact_get_SET_IPV4_DST(a)->ipv4));
1951 case OFPACT_SET_IPV4_DSCP:
1952 ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
1955 case OFPACT_SET_L4_SRC_PORT:
1956 ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
1959 case OFPACT_SET_L4_DST_PORT:
1960 ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
1963 case OFPACT_REG_MOVE:
1964 nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
1967 case OFPACT_REG_LOAD:
1968 nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
1971 case OFPACT_DEC_TTL:
1972 print_dec_ttl(ofpact_get_DEC_TTL(a), s);
1975 case OFPACT_SET_TUNNEL:
1976 tunnel = ofpact_get_SET_TUNNEL(a);
1977 ds_put_format(s, "set_tunnel%s:%#"PRIx64,
1978 (tunnel->tun_id > UINT32_MAX
1979 || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
1983 case OFPACT_SET_QUEUE:
1984 ds_put_format(s, "set_queue:%"PRIu32,
1985 ofpact_get_SET_QUEUE(a)->queue_id);
1988 case OFPACT_POP_QUEUE:
1989 ds_put_cstr(s, "pop_queue");
1992 case OFPACT_FIN_TIMEOUT:
1993 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
1996 case OFPACT_RESUBMIT:
1997 resubmit = ofpact_get_RESUBMIT(a);
1998 if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
1999 ds_put_cstr(s, "resubmit:");
2000 ofputil_format_port(resubmit->in_port, s);
2002 ds_put_format(s, "resubmit(");
2003 if (resubmit->in_port != OFPP_IN_PORT) {
2004 ofputil_format_port(resubmit->in_port, s);
2006 ds_put_char(s, ',');
2007 if (resubmit->table_id != 255) {
2008 ds_put_format(s, "%"PRIu8, resubmit->table_id);
2010 ds_put_char(s, ')');
2015 learn_format(ofpact_get_LEARN(a), s);
2018 case OFPACT_MULTIPATH:
2019 multipath_format(ofpact_get_MULTIPATH(a), s);
2022 case OFPACT_AUTOPATH:
2023 autopath = ofpact_get_AUTOPATH(a);
2024 ds_put_cstr(s, "autopath(");
2025 ofputil_format_port(autopath->port, s);
2026 ds_put_char(s, ',');
2027 mf_format_subfield(&autopath->dst, s);
2028 ds_put_char(s, ')');
2032 print_note(ofpact_get_NOTE(a), s);
2036 ds_put_cstr(s, "exit");
2039 case OFPACT_CLEAR_ACTIONS:
2040 ds_put_format(s, "%s",
2041 ofpact_instruction_name_from_type(
2042 OVSINST_OFPIT11_CLEAR_ACTIONS));
2045 case OFPACT_WRITE_METADATA:
2046 metadata = ofpact_get_WRITE_METADATA(a);
2047 ds_put_format(s, "%s:%#"PRIx64,
2048 ofpact_instruction_name_from_type(
2049 OVSINST_OFPIT11_WRITE_METADATA),
2050 ntohll(metadata->metadata));
2051 if (metadata->mask != htonll(UINT64_MAX)) {
2052 ds_put_format(s, "/%#"PRIx64, ntohll(metadata->mask));
2056 case OFPACT_GOTO_TABLE:
2057 ds_put_format(s, "%s:%"PRIu8,
2058 ofpact_instruction_name_from_type(
2059 OVSINST_OFPIT11_GOTO_TABLE),
2060 ofpact_get_GOTO_TABLE(a)->table_id);
2065 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
2066 * 'ofpacts' to 'string'. */
2068 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
2071 ds_put_cstr(string, "actions=");
2073 ds_put_cstr(string, "drop");
2075 const struct ofpact *a;
2077 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2079 ds_put_cstr(string, ",");
2082 /* TODO:XXX write-actions */
2083 ofpact_format(a, string);
2088 /* Internal use by helpers. */
2091 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
2093 struct ofpact *ofpact;
2095 ofpact_pad(ofpacts);
2096 ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
2097 ofpact_init(ofpact, type, len);
2102 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
2104 memset(ofpact, 0, len);
2105 ofpact->type = type;
2106 ofpact->compat = OFPUTIL_ACTION_INVALID;
2110 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
2111 * starting at 'ofpact'.
2113 * This is the correct way to update a variable-length ofpact's length after
2114 * adding the variable-length part of the payload. (See the large comment
2115 * near the end of ofp-actions.h for more information.) */
2117 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
2119 assert(ofpact == ofpacts->l2);
2120 ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
2123 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
2124 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
2125 * client must call this itself after adding the final ofpact to an array of
2128 * (The consequences of failing to call this function are probably not dire.
2129 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
2130 * not dereference it. That's undefined behavior, technically, but it will not
2131 * cause a real problem on common systems. Still, it seems better to call
2134 ofpact_pad(struct ofpbuf *ofpacts)
2136 unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
2138 ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
2143 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
2146 load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
2147 load->dst.field = mf;
2149 load->dst.n_bits = mf->n_bits;
2150 bitwise_copy(src, mf->n_bytes, load->dst.ofs,
2151 &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);