2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "ofp-actions.h"
20 #include "byte-order.h"
22 #include "dynamic-string.h"
24 #include "meta-flow.h"
25 #include "multipath.h"
32 VLOG_DEFINE_THIS_MODULE(ofp_actions);
34 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
36 /* Converting OpenFlow 1.0 to ofpacts. */
39 output_from_openflow10(const struct ofp10_action_output *oao,
42 struct ofpact_output *output;
44 output = ofpact_put_OUTPUT(out);
45 output->port = u16_to_ofp(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 = u16_to_ofp(ntohs(oae->port));
59 enqueue->queue = ntohl(oae->queue_id);
60 if (ofp_to_u16(enqueue->port) >= ofp_to_u16(OFPP_MAX)
61 && enqueue->port != OFPP_IN_PORT
62 && enqueue->port != OFPP_LOCAL) {
63 return OFPERR_OFPBAC_BAD_OUT_PORT;
69 resubmit_from_openflow(const struct nx_action_resubmit *nar,
72 struct ofpact_resubmit *resubmit;
74 resubmit = ofpact_put_RESUBMIT(out);
75 resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT;
76 resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
77 resubmit->table_id = 0xff;
81 resubmit_table_from_openflow(const struct nx_action_resubmit *nar,
84 struct ofpact_resubmit *resubmit;
86 if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
87 return OFPERR_OFPBAC_BAD_ARGUMENT;
90 resubmit = ofpact_put_RESUBMIT(out);
91 resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT_TABLE;
92 resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
93 resubmit->table_id = nar->table;
98 output_reg_from_openflow(const struct nx_action_output_reg *naor,
101 struct ofpact_output_reg *output_reg;
103 if (!is_all_zeros(naor->zero, sizeof naor->zero)) {
104 return OFPERR_OFPBAC_BAD_ARGUMENT;
107 output_reg = ofpact_put_OUTPUT_REG(out);
108 output_reg->src.field = mf_from_nxm_header(ntohl(naor->src));
109 output_reg->src.ofs = nxm_decode_ofs(naor->ofs_nbits);
110 output_reg->src.n_bits = nxm_decode_n_bits(naor->ofs_nbits);
111 output_reg->max_len = ntohs(naor->max_len);
113 return mf_check_src(&output_reg->src, NULL);
117 fin_timeout_from_openflow(const struct nx_action_fin_timeout *naft,
120 struct ofpact_fin_timeout *oft;
122 oft = ofpact_put_FIN_TIMEOUT(out);
123 oft->fin_idle_timeout = ntohs(naft->fin_idle_timeout);
124 oft->fin_hard_timeout = ntohs(naft->fin_hard_timeout);
128 controller_from_openflow(const struct nx_action_controller *nac,
131 struct ofpact_controller *oc;
133 oc = ofpact_put_CONTROLLER(out);
134 oc->max_len = ntohs(nac->max_len);
135 oc->controller_id = ntohs(nac->controller_id);
136 oc->reason = nac->reason;
140 metadata_from_nxast(const struct nx_action_write_metadata *nawm,
143 struct ofpact_metadata *om;
145 if (!is_all_zeros(nawm->zeros, sizeof nawm->zeros)) {
146 return OFPERR_NXBRC_MUST_BE_ZERO;
149 om = ofpact_put_WRITE_METADATA(out);
150 om->metadata = nawm->metadata;
151 om->mask = nawm->mask;
157 note_from_openflow(const struct nx_action_note *nan, struct ofpbuf *out)
159 struct ofpact_note *note;
162 length = ntohs(nan->len) - offsetof(struct nx_action_note, note);
163 note = ofpact_put(out, OFPACT_NOTE,
164 offsetof(struct ofpact_note, data) + length);
165 note->length = length;
166 memcpy(note->data, nan->note, length);
170 dec_ttl_from_openflow(struct ofpbuf *out, enum ofputil_action_code compat)
173 struct ofpact_cnt_ids *ids;
174 enum ofperr error = 0;
176 ids = ofpact_put_DEC_TTL(out);
177 ids->ofpact.compat = compat;
178 ids->n_controllers = 1;
179 ofpbuf_put(out, &id, sizeof id);
181 ofpact_update_len(out, &ids->ofpact);
186 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids *nac_ids,
189 struct ofpact_cnt_ids *ids;
193 ids = ofpact_put_DEC_TTL(out);
194 ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
195 ids->n_controllers = ntohs(nac_ids->n_controllers);
196 ids_size = ntohs(nac_ids->len) - sizeof *nac_ids;
198 if (!is_all_zeros(nac_ids->zeros, sizeof nac_ids->zeros)) {
199 return OFPERR_NXBRC_MUST_BE_ZERO;
202 if (ids_size < ids->n_controllers * sizeof(ovs_be16)) {
203 VLOG_WARN_RL(&rl, "Nicira action dec_ttl_cnt_ids only has %zu bytes "
204 "allocated for controller ids. %zu bytes are required for "
205 "%"PRIu16" controllers.", ids_size,
206 ids->n_controllers * sizeof(ovs_be16), ids->n_controllers);
207 return OFPERR_OFPBAC_BAD_LEN;
210 for (i = 0; i < ids->n_controllers; i++) {
211 uint16_t id = ntohs(((ovs_be16 *)(nac_ids + 1))[i]);
212 ofpbuf_put(out, &id, sizeof id);
216 ofpact_update_len(out, &ids->ofpact);
222 sample_from_openflow(const struct nx_action_sample *nas,
225 struct ofpact_sample *sample;
227 sample = ofpact_put_SAMPLE(out);
228 sample->probability = ntohs(nas->probability);
229 sample->collector_set_id = ntohl(nas->collector_set_id);
230 sample->obs_domain_id = ntohl(nas->obs_domain_id);
231 sample->obs_point_id = ntohl(nas->obs_point_id);
233 if (sample->probability == 0) {
234 return OFPERR_OFPBAC_BAD_ARGUMENT;
241 decode_nxast_action(const union ofp_action *a, enum ofputil_action_code *code)
243 const struct nx_action_header *nah = (const struct nx_action_header *) a;
244 uint16_t len = ntohs(a->header.len);
246 if (len < sizeof(struct nx_action_header)) {
247 return OFPERR_OFPBAC_BAD_LEN;
248 } else if (a->vendor.vendor != CONSTANT_HTONL(NX_VENDOR_ID)) {
249 return OFPERR_OFPBAC_BAD_VENDOR;
252 switch (nah->subtype) {
253 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
254 case CONSTANT_HTONS(ENUM): \
256 ? len >= sizeof(struct STRUCT) \
257 : len == sizeof(struct STRUCT)) { \
258 *code = OFPUTIL_##ENUM; \
261 return OFPERR_OFPBAC_BAD_LEN; \
264 #include "ofp-util.def"
266 case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE):
267 case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE):
269 return OFPERR_OFPBAC_BAD_TYPE;
273 /* Parses 'a' to determine its type. On success stores the correct type into
274 * '*code' and returns 0. On failure returns an OFPERR_* error code and
275 * '*code' is indeterminate.
277 * The caller must have already verified that 'a''s length is potentially
278 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
279 * ofp_action) and no longer than the amount of space allocated to 'a').
281 * This function verifies that 'a''s length is correct for the type of action
282 * that it represents. */
284 decode_openflow10_action(const union ofp_action *a,
285 enum ofputil_action_code *code)
288 case CONSTANT_HTONS(OFPAT10_VENDOR):
289 return decode_nxast_action(a, code);
291 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
292 case CONSTANT_HTONS(ENUM): \
293 if (a->header.len == htons(sizeof(struct STRUCT))) { \
294 *code = OFPUTIL_##ENUM; \
297 return OFPERR_OFPBAC_BAD_LEN; \
300 #include "ofp-util.def"
303 return OFPERR_OFPBAC_BAD_TYPE;
308 ofpact_from_nxast(const union ofp_action *a, enum ofputil_action_code code,
311 const struct nx_action_resubmit *nar;
312 const struct nx_action_set_tunnel *nast;
313 const struct nx_action_set_queue *nasq;
314 const struct nx_action_note *nan;
315 const struct nx_action_set_tunnel64 *nast64;
316 const struct nx_action_write_metadata *nawm;
317 struct ofpact_tunnel *tunnel;
318 enum ofperr error = 0;
321 case OFPUTIL_ACTION_INVALID:
322 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
323 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
324 #include "ofp-util.def"
327 case OFPUTIL_NXAST_RESUBMIT:
328 resubmit_from_openflow((const struct nx_action_resubmit *) a, out);
331 case OFPUTIL_NXAST_SET_TUNNEL:
332 nast = (const struct nx_action_set_tunnel *) a;
333 tunnel = ofpact_put_SET_TUNNEL(out);
334 tunnel->ofpact.compat = code;
335 tunnel->tun_id = ntohl(nast->tun_id);
338 case OFPUTIL_NXAST_WRITE_METADATA:
339 nawm = (const struct nx_action_write_metadata *) a;
340 error = metadata_from_nxast(nawm, out);
343 case OFPUTIL_NXAST_SET_QUEUE:
344 nasq = (const struct nx_action_set_queue *) a;
345 ofpact_put_SET_QUEUE(out)->queue_id = ntohl(nasq->queue_id);
348 case OFPUTIL_NXAST_POP_QUEUE:
349 ofpact_put_POP_QUEUE(out);
352 case OFPUTIL_NXAST_REG_MOVE:
353 error = nxm_reg_move_from_openflow(
354 (const struct nx_action_reg_move *) a, out);
357 case OFPUTIL_NXAST_REG_LOAD:
358 error = nxm_reg_load_from_openflow(
359 (const struct nx_action_reg_load *) a, out);
362 case OFPUTIL_NXAST_STACK_PUSH:
363 error = nxm_stack_push_from_openflow(
364 (const struct nx_action_stack *) a, out);
367 case OFPUTIL_NXAST_STACK_POP:
368 error = nxm_stack_pop_from_openflow(
369 (const struct nx_action_stack *) a, out);
372 case OFPUTIL_NXAST_NOTE:
373 nan = (const struct nx_action_note *) a;
374 note_from_openflow(nan, out);
377 case OFPUTIL_NXAST_SET_TUNNEL64:
378 nast64 = (const struct nx_action_set_tunnel64 *) a;
379 tunnel = ofpact_put_SET_TUNNEL(out);
380 tunnel->ofpact.compat = code;
381 tunnel->tun_id = ntohll(nast64->tun_id);
384 case OFPUTIL_NXAST_MULTIPATH:
385 error = multipath_from_openflow((const struct nx_action_multipath *) a,
386 ofpact_put_MULTIPATH(out));
389 case OFPUTIL_NXAST_BUNDLE:
390 case OFPUTIL_NXAST_BUNDLE_LOAD:
391 error = bundle_from_openflow((const struct nx_action_bundle *) a, out);
394 case OFPUTIL_NXAST_OUTPUT_REG:
395 error = output_reg_from_openflow(
396 (const struct nx_action_output_reg *) a, out);
399 case OFPUTIL_NXAST_RESUBMIT_TABLE:
400 nar = (const struct nx_action_resubmit *) a;
401 error = resubmit_table_from_openflow(nar, out);
404 case OFPUTIL_NXAST_LEARN:
405 error = learn_from_openflow((const struct nx_action_learn *) a, out);
408 case OFPUTIL_NXAST_EXIT:
409 ofpact_put_EXIT(out);
412 case OFPUTIL_NXAST_DEC_TTL:
413 error = dec_ttl_from_openflow(out, code);
416 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
417 error = dec_ttl_cnt_ids_from_openflow(
418 (const struct nx_action_cnt_ids *) a, out);
421 case OFPUTIL_NXAST_FIN_TIMEOUT:
422 fin_timeout_from_openflow(
423 (const struct nx_action_fin_timeout *) a, out);
426 case OFPUTIL_NXAST_CONTROLLER:
427 controller_from_openflow((const struct nx_action_controller *) a, out);
430 case OFPUTIL_NXAST_PUSH_MPLS: {
431 struct nx_action_push_mpls *nxapm = (struct nx_action_push_mpls *)a;
432 if (!eth_type_mpls(nxapm->ethertype)) {
433 return OFPERR_OFPBAC_BAD_ARGUMENT;
435 ofpact_put_PUSH_MPLS(out)->ethertype = nxapm->ethertype;
439 case OFPUTIL_NXAST_SET_MPLS_TTL: {
440 struct nx_action_mpls_ttl *nxamt = (struct nx_action_mpls_ttl *)a;
441 ofpact_put_SET_MPLS_TTL(out)->ttl = nxamt->ttl;
445 case OFPUTIL_NXAST_DEC_MPLS_TTL:
446 ofpact_put_DEC_MPLS_TTL(out);
449 case OFPUTIL_NXAST_POP_MPLS: {
450 struct nx_action_pop_mpls *nxapm = (struct nx_action_pop_mpls *)a;
451 if (eth_type_mpls(nxapm->ethertype)) {
452 return OFPERR_OFPBAC_BAD_ARGUMENT;
454 ofpact_put_POP_MPLS(out)->ethertype = nxapm->ethertype;
458 case OFPUTIL_NXAST_SAMPLE:
459 error = sample_from_openflow(
460 (const struct nx_action_sample *) a, out);
468 ofpact_from_openflow10(const union ofp_action *a, struct ofpbuf *out)
470 enum ofputil_action_code code;
473 error = decode_openflow10_action(a, &code);
479 case OFPUTIL_ACTION_INVALID:
480 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
481 #include "ofp-util.def"
484 case OFPUTIL_OFPAT10_OUTPUT:
485 return output_from_openflow10(&a->output10, out);
487 case OFPUTIL_OFPAT10_SET_VLAN_VID:
488 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
489 return OFPERR_OFPBAC_BAD_ARGUMENT;
491 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
494 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
495 if (a->vlan_pcp.vlan_pcp & ~7) {
496 return OFPERR_OFPBAC_BAD_ARGUMENT;
498 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
501 case OFPUTIL_OFPAT10_STRIP_VLAN:
502 ofpact_put_STRIP_VLAN(out);
505 case OFPUTIL_OFPAT10_SET_DL_SRC:
506 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
507 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
510 case OFPUTIL_OFPAT10_SET_DL_DST:
511 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
512 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
515 case OFPUTIL_OFPAT10_SET_NW_SRC:
516 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
519 case OFPUTIL_OFPAT10_SET_NW_DST:
520 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
523 case OFPUTIL_OFPAT10_SET_NW_TOS:
524 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
525 return OFPERR_OFPBAC_BAD_ARGUMENT;
527 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
530 case OFPUTIL_OFPAT10_SET_TP_SRC:
531 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
534 case OFPUTIL_OFPAT10_SET_TP_DST:
535 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
539 case OFPUTIL_OFPAT10_ENQUEUE:
540 error = enqueue_from_openflow10((const struct ofp10_action_enqueue *) a,
544 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
545 #include "ofp-util.def"
546 return ofpact_from_nxast(a, code, out);
552 static inline union ofp_action *
553 action_next(const union ofp_action *a)
555 return ((union ofp_action *) (void *)
556 ((uint8_t *) a + ntohs(a->header.len)));
560 action_is_valid(const union ofp_action *a, size_t n_actions)
562 uint16_t len = ntohs(a->header.len);
563 return (!(len % OFP_ACTION_ALIGN)
565 && len / sizeof *a <= n_actions);
568 /* This macro is careful to check for actions with bad lengths. */
569 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
570 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
571 (LEFT) > 0 && action_is_valid(ITER, LEFT); \
572 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
573 (ITER) = action_next(ITER)))
576 log_bad_action(const union ofp_action *actions, size_t n_actions, size_t ofs,
579 if (!VLOG_DROP_WARN(&rl)) {
583 ds_put_hex_dump(&s, actions, n_actions * sizeof *actions, 0, false);
584 VLOG_WARN("bad action at offset %#zx (%s):\n%s",
585 ofs * sizeof *actions, ofperr_get_name(error), ds_cstr(&s));
591 ofpacts_from_openflow(const union ofp_action *in, size_t n_in,
593 enum ofperr (*ofpact_from_openflow)(
594 const union ofp_action *a, struct ofpbuf *out))
596 const union ofp_action *a;
599 ACTION_FOR_EACH (a, left, in, n_in) {
600 enum ofperr error = ofpact_from_openflow(a, out);
602 log_bad_action(in, n_in, a - in, error);
607 enum ofperr error = OFPERR_OFPBAC_BAD_LEN;
608 log_bad_action(in, n_in, n_in - left, error);
617 ofpacts_from_openflow10(const union ofp_action *in, size_t n_in,
620 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow10);
624 ofpacts_pull_actions(struct ofpbuf *openflow, unsigned int actions_len,
625 struct ofpbuf *ofpacts,
626 enum ofperr (*translate)(const union ofp_action *actions,
628 struct ofpbuf *ofpacts))
630 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
631 const union ofp_action *actions;
634 ofpbuf_clear(ofpacts);
636 if (actions_len % OFP_ACTION_ALIGN != 0) {
637 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
638 "multiple of %d", actions_len, OFP_ACTION_ALIGN);
639 return OFPERR_OFPBRC_BAD_LEN;
642 actions = ofpbuf_try_pull(openflow, actions_len);
643 if (actions == NULL) {
644 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
645 "remaining message length (%zu)",
646 actions_len, openflow->size);
647 return OFPERR_OFPBRC_BAD_LEN;
650 error = translate(actions, actions_len / OFP_ACTION_ALIGN, ofpacts);
652 ofpbuf_clear(ofpacts);
656 error = ofpacts_verify(ofpacts->data, ofpacts->size);
658 ofpbuf_clear(ofpacts);
663 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.0 actions from the
664 * front of 'openflow' into ofpacts. On success, replaces any existing content
665 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
666 * Returns 0 if successful, otherwise an OpenFlow error.
668 * The parsed actions are valid generically, but they may not be valid in a
669 * specific context. For example, port numbers up to OFPP_MAX are valid
670 * generically, but specific datapaths may only support port numbers in a
671 * smaller range. Use ofpacts_check() to additional check whether actions are
672 * valid in a specific context. */
674 ofpacts_pull_openflow10(struct ofpbuf *openflow, unsigned int actions_len,
675 struct ofpbuf *ofpacts)
677 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
678 ofpacts_from_openflow10);
681 /* OpenFlow 1.1 actions. */
683 /* Parses 'a' to determine its type. On success stores the correct type into
684 * '*code' and returns 0. On failure returns an OFPERR_* error code and
685 * '*code' is indeterminate.
687 * The caller must have already verified that 'a''s length is potentially
688 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
689 * ofp_action) and no longer than the amount of space allocated to 'a').
691 * This function verifies that 'a''s length is correct for the type of action
692 * that it represents. */
694 decode_openflow11_action(const union ofp_action *a,
695 enum ofputil_action_code *code)
700 case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
701 return decode_nxast_action(a, code);
703 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
704 case CONSTANT_HTONS(ENUM): \
705 len = ntohs(a->header.len); \
707 ? len >= sizeof(struct STRUCT) \
708 : len == sizeof(struct STRUCT)) { \
709 *code = OFPUTIL_##ENUM; \
712 return OFPERR_OFPBAC_BAD_LEN; \
715 #include "ofp-util.def"
718 return OFPERR_OFPBAC_BAD_TYPE;
723 output_from_openflow11(const struct ofp11_action_output *oao,
726 struct ofpact_output *output;
729 output = ofpact_put_OUTPUT(out);
730 output->max_len = ntohs(oao->max_len);
732 error = ofputil_port_from_ofp11(oao->port, &output->port);
737 return ofputil_check_output_port(output->port, OFPP_MAX);
741 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
743 enum ofputil_action_code code;
746 error = decode_openflow11_action(a, &code);
752 case OFPUTIL_ACTION_INVALID:
753 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
754 #include "ofp-util.def"
757 case OFPUTIL_OFPAT11_OUTPUT:
758 return output_from_openflow11((const struct ofp11_action_output *) a,
761 case OFPUTIL_OFPAT11_SET_VLAN_VID:
762 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
763 return OFPERR_OFPBAC_BAD_ARGUMENT;
765 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
768 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
769 if (a->vlan_pcp.vlan_pcp & ~7) {
770 return OFPERR_OFPBAC_BAD_ARGUMENT;
772 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
775 case OFPUTIL_OFPAT11_PUSH_VLAN:
776 if (((const struct ofp11_action_push *)a)->ethertype !=
777 htons(ETH_TYPE_VLAN_8021Q)) {
778 /* XXX 802.1AD(QinQ) isn't supported at the moment */
779 return OFPERR_OFPBAC_BAD_ARGUMENT;
781 ofpact_put_PUSH_VLAN(out);
784 case OFPUTIL_OFPAT11_POP_VLAN:
785 ofpact_put_STRIP_VLAN(out);
788 case OFPUTIL_OFPAT11_SET_QUEUE:
789 ofpact_put_SET_QUEUE(out)->queue_id =
790 ntohl(((const struct ofp11_action_set_queue *)a)->queue_id);
793 case OFPUTIL_OFPAT11_SET_DL_SRC:
794 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
795 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
798 case OFPUTIL_OFPAT11_SET_DL_DST:
799 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
800 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
803 case OFPUTIL_OFPAT11_DEC_NW_TTL:
804 dec_ttl_from_openflow(out, code);
807 case OFPUTIL_OFPAT11_SET_NW_SRC:
808 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
811 case OFPUTIL_OFPAT11_SET_NW_DST:
812 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
815 case OFPUTIL_OFPAT11_SET_NW_TOS:
816 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
817 return OFPERR_OFPBAC_BAD_ARGUMENT;
819 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
822 case OFPUTIL_OFPAT11_SET_TP_SRC:
823 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
826 case OFPUTIL_OFPAT11_SET_TP_DST:
827 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
830 case OFPUTIL_OFPAT12_SET_FIELD:
831 return nxm_reg_load_from_openflow12_set_field(
832 (const struct ofp12_action_set_field *)a, out);
834 case OFPUTIL_OFPAT11_SET_MPLS_TTL: {
835 struct ofp11_action_mpls_ttl *oamt = (struct ofp11_action_mpls_ttl *)a;
836 ofpact_put_SET_MPLS_TTL(out)->ttl = oamt->mpls_ttl;
840 case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
841 ofpact_put_DEC_MPLS_TTL(out);
844 case OFPUTIL_OFPAT11_PUSH_MPLS: {
845 struct ofp11_action_push *oap = (struct ofp11_action_push *)a;
846 if (!eth_type_mpls(oap->ethertype)) {
847 return OFPERR_OFPBAC_BAD_ARGUMENT;
849 ofpact_put_PUSH_MPLS(out)->ethertype = oap->ethertype;
853 case OFPUTIL_OFPAT11_POP_MPLS: {
854 struct ofp11_action_pop_mpls *oapm = (struct ofp11_action_pop_mpls *)a;
855 if (eth_type_mpls(oapm->ethertype)) {
856 return OFPERR_OFPBAC_BAD_ARGUMENT;
858 ofpact_put_POP_MPLS(out)->ethertype = oapm->ethertype;
862 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
863 #include "ofp-util.def"
864 return ofpact_from_nxast(a, code, out);
871 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
874 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
877 /* OpenFlow 1.1 instructions. */
879 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
880 static inline const struct STRUCT * \
881 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
883 ovs_assert(inst->type == htons(ENUM)); \
884 return (struct STRUCT *)inst; \
888 instruction_init_##ENUM(struct STRUCT *s) \
890 memset(s, 0, sizeof *s); \
891 s->type = htons(ENUM); \
892 s->len = htons(sizeof *s); \
895 static inline struct STRUCT * \
896 instruction_put_##ENUM(struct ofpbuf *buf) \
898 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
899 instruction_init_##ENUM(s); \
905 struct instruction_type_info {
906 enum ovs_instruction_type type;
910 static const struct instruction_type_info inst_info[] = {
911 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
917 ofpact_instruction_name_from_type(enum ovs_instruction_type type)
919 return inst_info[type].name;
923 ofpact_instruction_type_from_name(const char *name)
925 const struct instruction_type_info *p;
926 for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
927 if (!strcasecmp(name, p->name)) {
934 static inline struct ofp11_instruction *
935 instruction_next(const struct ofp11_instruction *inst)
937 return ((struct ofp11_instruction *) (void *)
938 ((uint8_t *) inst + ntohs(inst->len)));
942 instruction_is_valid(const struct ofp11_instruction *inst,
943 size_t n_instructions)
945 uint16_t len = ntohs(inst->len);
946 return (!(len % OFP11_INSTRUCTION_ALIGN)
947 && len >= sizeof *inst
948 && len / sizeof *inst <= n_instructions);
951 /* This macro is careful to check for instructions with bad lengths. */
952 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
953 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
954 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
955 ((LEFT) -= (ntohs((ITER)->len) \
956 / sizeof(struct ofp11_instruction)), \
957 (ITER) = instruction_next(ITER)))
960 decode_openflow11_instruction(const struct ofp11_instruction *inst,
961 enum ovs_instruction_type *type)
963 uint16_t len = ntohs(inst->len);
965 switch (inst->type) {
966 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
967 return OFPERR_OFPBIC_BAD_EXPERIMENTER;
969 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
970 case CONSTANT_HTONS(ENUM): \
972 ? len >= sizeof(struct STRUCT) \
973 : len == sizeof(struct STRUCT)) { \
974 *type = OVSINST_##ENUM; \
977 return OFPERR_OFPBIC_BAD_LEN; \
983 return OFPERR_OFPBIC_UNKNOWN_INST;
988 decode_openflow11_instructions(const struct ofp11_instruction insts[],
990 const struct ofp11_instruction *out[])
992 const struct ofp11_instruction *inst;
995 memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
996 INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
997 enum ovs_instruction_type type;
1000 error = decode_openflow11_instruction(inst, &type);
1006 return OFPERR_ONFBIC_DUP_INSTRUCTION;
1012 VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
1013 (n_insts - left) * sizeof *inst);
1014 return OFPERR_OFPBIC_BAD_LEN;
1020 get_actions_from_instruction(const struct ofp11_instruction *inst,
1021 const union ofp_action **actions,
1024 *actions = (const union ofp_action *) (inst + 1);
1025 *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
1028 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
1029 * front of 'openflow' into ofpacts. On success, replaces any existing content
1030 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
1031 * Returns 0 if successful, otherwise an OpenFlow error.
1033 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
1034 * instructions, so you should call ofpacts_pull_openflow11_instructions()
1035 * instead of this function.
1037 * The parsed actions are valid generically, but they may not be valid in a
1038 * specific context. For example, port numbers up to OFPP_MAX are valid
1039 * generically, but specific datapaths may only support port numbers in a
1040 * smaller range. Use ofpacts_check() to additional check whether actions are
1041 * valid in a specific context. */
1043 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
1044 unsigned int actions_len,
1045 struct ofpbuf *ofpacts)
1047 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
1048 ofpacts_from_openflow11);
1052 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
1053 unsigned int instructions_len,
1055 struct ofpbuf *ofpacts)
1057 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1058 const struct ofp11_instruction *instructions;
1059 const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
1062 ofpbuf_clear(ofpacts);
1064 if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
1065 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
1067 instructions_len, OFP11_INSTRUCTION_ALIGN);
1068 error = OFPERR_OFPBIC_BAD_LEN;
1072 instructions = ofpbuf_try_pull(openflow, instructions_len);
1073 if (instructions == NULL) {
1074 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
1075 "remaining message length (%zu)",
1076 instructions_len, openflow->size);
1077 error = OFPERR_OFPBIC_BAD_LEN;
1081 error = decode_openflow11_instructions(
1082 instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
1088 if (insts[OVSINST_OFPIT13_METER]) {
1089 const struct ofp13_instruction_meter *oim;
1090 struct ofpact_meter *om;
1092 oim = (const struct ofp13_instruction_meter *)
1093 insts[OVSINST_OFPIT13_METER];
1095 om = ofpact_put_METER(ofpacts);
1096 om->meter_id = ntohl(oim->meter_id);
1098 if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
1099 const union ofp_action *actions;
1102 get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
1103 &actions, &n_actions);
1104 error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
1109 if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
1110 instruction_get_OFPIT11_CLEAR_ACTIONS(
1111 insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
1112 ofpact_put_CLEAR_ACTIONS(ofpacts);
1114 /* XXX Write-Actions */
1115 if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
1116 const struct ofp11_instruction_write_metadata *oiwm;
1117 struct ofpact_metadata *om;
1119 oiwm = (const struct ofp11_instruction_write_metadata *)
1120 insts[OVSINST_OFPIT11_WRITE_METADATA];
1122 om = ofpact_put_WRITE_METADATA(ofpacts);
1123 om->metadata = oiwm->metadata;
1124 om->mask = oiwm->metadata_mask;
1126 if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
1127 const struct ofp11_instruction_goto_table *oigt;
1128 struct ofpact_goto_table *ogt;
1130 oigt = instruction_get_OFPIT11_GOTO_TABLE(
1131 insts[OVSINST_OFPIT11_GOTO_TABLE]);
1132 if (table_id >= oigt->table_id) {
1133 error = OFPERR_OFPBRC_BAD_TABLE_ID;
1136 ogt = ofpact_put_GOTO_TABLE(ofpacts);
1137 ogt->table_id = oigt->table_id;
1140 if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
1141 error = OFPERR_OFPBIC_UNSUP_INST;
1145 error = ofpacts_verify(ofpacts->data, ofpacts->size);
1148 ofpbuf_clear(ofpacts);
1153 /* May modify flow->dl_type, caller must restore it. */
1155 ofpact_check__(const struct ofpact *a, struct flow *flow, ofp_port_t max_ports)
1157 const struct ofpact_enqueue *enqueue;
1161 return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
1164 case OFPACT_CONTROLLER:
1167 case OFPACT_ENQUEUE:
1168 enqueue = ofpact_get_ENQUEUE(a);
1169 if (ofp_to_u16(enqueue->port) >= ofp_to_u16(max_ports)
1170 && enqueue->port != OFPP_IN_PORT
1171 && enqueue->port != OFPP_LOCAL) {
1172 return OFPERR_OFPBAC_BAD_OUT_PORT;
1176 case OFPACT_OUTPUT_REG:
1177 return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1180 return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1182 case OFPACT_SET_VLAN_VID:
1183 case OFPACT_SET_VLAN_PCP:
1184 case OFPACT_STRIP_VLAN:
1185 case OFPACT_PUSH_VLAN:
1186 case OFPACT_SET_ETH_SRC:
1187 case OFPACT_SET_ETH_DST:
1188 case OFPACT_SET_IPV4_SRC:
1189 case OFPACT_SET_IPV4_DST:
1190 case OFPACT_SET_IPV4_DSCP:
1191 case OFPACT_SET_L4_SRC_PORT:
1192 case OFPACT_SET_L4_DST_PORT:
1195 case OFPACT_REG_MOVE:
1196 return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1198 case OFPACT_REG_LOAD:
1199 return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1201 case OFPACT_STACK_PUSH:
1202 return nxm_stack_push_check(ofpact_get_STACK_PUSH(a), flow);
1204 case OFPACT_STACK_POP:
1205 return nxm_stack_pop_check(ofpact_get_STACK_POP(a), flow);
1207 case OFPACT_DEC_TTL:
1208 case OFPACT_SET_MPLS_TTL:
1209 case OFPACT_DEC_MPLS_TTL:
1210 case OFPACT_SET_TUNNEL:
1211 case OFPACT_SET_QUEUE:
1212 case OFPACT_POP_QUEUE:
1213 case OFPACT_FIN_TIMEOUT:
1214 case OFPACT_RESUBMIT:
1218 return learn_check(ofpact_get_LEARN(a), flow);
1220 case OFPACT_MULTIPATH:
1221 return multipath_check(ofpact_get_MULTIPATH(a), flow);
1227 case OFPACT_PUSH_MPLS:
1228 flow->dl_type = ofpact_get_PUSH_MPLS(a)->ethertype;
1231 case OFPACT_POP_MPLS:
1232 flow->dl_type = ofpact_get_POP_MPLS(a)->ethertype;
1238 case OFPACT_CLEAR_ACTIONS:
1239 case OFPACT_WRITE_METADATA:
1241 case OFPACT_GOTO_TABLE:
1249 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1250 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1251 * switch with no more than 'max_ports' ports.
1253 * May temporarily modify 'flow', but restores the changes before returning. */
1255 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1256 struct flow *flow, ofp_port_t max_ports)
1258 const struct ofpact *a;
1259 ovs_be16 dl_type = flow->dl_type;
1260 enum ofperr error = 0;
1262 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1263 error = ofpact_check__(a, flow, max_ports);
1268 flow->dl_type = dl_type; /* Restore. */
1272 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1273 * in the appropriate order as defined by the OpenFlow spec. */
1275 ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len)
1277 const struct ofpact *a;
1278 enum ovs_instruction_type inst;
1280 inst = OVSINST_OFPIT11_APPLY_ACTIONS;
1281 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1282 enum ovs_instruction_type next;
1284 if (a->type == OFPACT_METER) {
1285 next = OVSINST_OFPIT13_METER;
1286 } else if (a->type == OFPACT_CLEAR_ACTIONS) {
1287 next = OVSINST_OFPIT11_CLEAR_ACTIONS;
1288 } else if (a->type == OFPACT_WRITE_METADATA) {
1289 next = OVSINST_OFPIT11_WRITE_METADATA;
1290 } else if (a->type == OFPACT_GOTO_TABLE) {
1291 next = OVSINST_OFPIT11_GOTO_TABLE;
1293 next = OVSINST_OFPIT11_APPLY_ACTIONS;
1296 if (inst != OVSINST_OFPIT11_APPLY_ACTIONS && next <= inst) {
1297 const char *name = ofpact_instruction_name_from_type(inst);
1298 const char *next_name = ofpact_instruction_name_from_type(next);
1301 VLOG_WARN("duplicate %s instruction not allowed, for OpenFlow "
1302 "1.1+ compatibility", name);
1304 VLOG_WARN("invalid instruction ordering: %s must appear "
1305 "before %s, for OpenFlow 1.1+ compatibility",
1308 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1317 /* Converting ofpacts to Nicira OpenFlow extensions. */
1320 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1323 struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1325 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1326 output_reg->src.n_bits);
1327 naor->src = htonl(output_reg->src.field->nxm_header);
1328 naor->max_len = htons(output_reg->max_len);
1332 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1335 struct nx_action_resubmit *nar;
1337 if (resubmit->table_id == 0xff
1338 && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1339 nar = ofputil_put_NXAST_RESUBMIT(out);
1341 nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1342 nar->table = resubmit->table_id;
1344 nar->in_port = htons(ofp_to_u16(resubmit->in_port));
1348 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1351 uint64_t tun_id = tunnel->tun_id;
1353 if (tun_id <= UINT32_MAX
1354 && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1355 ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1357 ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1362 ofpact_write_metadata_to_nxast(const struct ofpact_metadata *om,
1365 struct nx_action_write_metadata *nawm;
1367 nawm = ofputil_put_NXAST_WRITE_METADATA(out);
1368 nawm->metadata = om->metadata;
1369 nawm->mask = om->mask;
1373 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1375 size_t start_ofs = out->size;
1376 struct nx_action_note *nan;
1377 unsigned int remainder;
1380 nan = ofputil_put_NXAST_NOTE(out);
1381 out->size -= sizeof nan->note;
1383 ofpbuf_put(out, note->data, note->length);
1385 len = out->size - start_ofs;
1386 remainder = len % OFP_ACTION_ALIGN;
1388 ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1390 nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1391 nan->len = htons(out->size - start_ofs);
1395 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1398 struct nx_action_controller *nac;
1400 nac = ofputil_put_NXAST_CONTROLLER(out);
1401 nac->max_len = htons(oc->max_len);
1402 nac->controller_id = htons(oc->controller_id);
1403 nac->reason = oc->reason;
1407 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1410 if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1411 ofputil_put_NXAST_DEC_TTL(out);
1413 struct nx_action_cnt_ids *nac_ids =
1414 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1415 int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1419 nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1420 nac_ids->n_controllers = htons(oc_ids->n_controllers);
1422 ids = ofpbuf_put_zeros(out, ids_len);
1423 for (i = 0; i < oc_ids->n_controllers; i++) {
1424 ids[i] = htons(oc_ids->cnt_ids[i]);
1430 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1433 struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1434 naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1435 naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1439 ofpact_sample_to_nxast(const struct ofpact_sample *os,
1442 struct nx_action_sample *nas;
1444 nas = ofputil_put_NXAST_SAMPLE(out);
1445 nas->probability = htons(os->probability);
1446 nas->collector_set_id = htonl(os->collector_set_id);
1447 nas->obs_domain_id = htonl(os->obs_domain_id);
1448 nas->obs_point_id = htonl(os->obs_point_id);
1452 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1455 case OFPACT_CONTROLLER:
1456 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1459 case OFPACT_OUTPUT_REG:
1460 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1464 bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1467 case OFPACT_REG_MOVE:
1468 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1471 case OFPACT_REG_LOAD:
1472 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1475 case OFPACT_STACK_PUSH:
1476 nxm_stack_push_to_nxast(ofpact_get_STACK_PUSH(a), out);
1479 case OFPACT_STACK_POP:
1480 nxm_stack_pop_to_nxast(ofpact_get_STACK_POP(a), out);
1483 case OFPACT_DEC_TTL:
1484 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1487 case OFPACT_SET_MPLS_TTL:
1488 ofputil_put_NXAST_SET_MPLS_TTL(out)->ttl
1489 = ofpact_get_SET_MPLS_TTL(a)->ttl;
1492 case OFPACT_DEC_MPLS_TTL:
1493 ofputil_put_NXAST_DEC_MPLS_TTL(out);
1496 case OFPACT_SET_TUNNEL:
1497 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1500 case OFPACT_WRITE_METADATA:
1501 ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a), out);
1504 case OFPACT_SET_QUEUE:
1505 ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1506 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1509 case OFPACT_POP_QUEUE:
1510 ofputil_put_NXAST_POP_QUEUE(out);
1513 case OFPACT_FIN_TIMEOUT:
1514 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1517 case OFPACT_RESUBMIT:
1518 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1522 learn_to_nxast(ofpact_get_LEARN(a), out);
1525 case OFPACT_MULTIPATH:
1526 multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1530 ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1534 ofputil_put_NXAST_EXIT(out);
1537 case OFPACT_PUSH_MPLS:
1538 ofputil_put_NXAST_PUSH_MPLS(out)->ethertype =
1539 ofpact_get_PUSH_MPLS(a)->ethertype;
1542 case OFPACT_POP_MPLS:
1543 ofputil_put_NXAST_POP_MPLS(out)->ethertype =
1544 ofpact_get_POP_MPLS(a)->ethertype;
1548 ofpact_sample_to_nxast(ofpact_get_SAMPLE(a), out);
1552 case OFPACT_ENQUEUE:
1553 case OFPACT_SET_VLAN_VID:
1554 case OFPACT_SET_VLAN_PCP:
1555 case OFPACT_STRIP_VLAN:
1556 case OFPACT_PUSH_VLAN:
1557 case OFPACT_SET_ETH_SRC:
1558 case OFPACT_SET_ETH_DST:
1559 case OFPACT_SET_IPV4_SRC:
1560 case OFPACT_SET_IPV4_DST:
1561 case OFPACT_SET_IPV4_DSCP:
1562 case OFPACT_SET_L4_SRC_PORT:
1563 case OFPACT_SET_L4_DST_PORT:
1564 case OFPACT_CLEAR_ACTIONS:
1565 case OFPACT_GOTO_TABLE:
1571 /* Converting ofpacts to OpenFlow 1.0. */
1574 ofpact_output_to_openflow10(const struct ofpact_output *output,
1577 struct ofp10_action_output *oao;
1579 oao = ofputil_put_OFPAT10_OUTPUT(out);
1580 oao->port = htons(ofp_to_u16(output->port));
1581 oao->max_len = htons(output->max_len);
1585 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1588 struct ofp10_action_enqueue *oae;
1590 oae = ofputil_put_OFPAT10_ENQUEUE(out);
1591 oae->port = htons(ofp_to_u16(enqueue->port));
1592 oae->queue_id = htonl(enqueue->queue);
1596 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1600 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1603 case OFPACT_ENQUEUE:
1604 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1607 case OFPACT_SET_VLAN_VID:
1608 ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1609 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1612 case OFPACT_SET_VLAN_PCP:
1613 ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1614 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1617 case OFPACT_STRIP_VLAN:
1618 ofputil_put_OFPAT10_STRIP_VLAN(out);
1621 case OFPACT_SET_ETH_SRC:
1622 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1623 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1626 case OFPACT_SET_ETH_DST:
1627 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1628 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1631 case OFPACT_SET_IPV4_SRC:
1632 ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1633 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1636 case OFPACT_SET_IPV4_DST:
1637 ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1638 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1641 case OFPACT_SET_IPV4_DSCP:
1642 ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1643 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1646 case OFPACT_SET_L4_SRC_PORT:
1647 ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1648 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1651 case OFPACT_SET_L4_DST_PORT:
1652 ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1653 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1656 case OFPACT_PUSH_VLAN:
1657 case OFPACT_CLEAR_ACTIONS:
1658 case OFPACT_GOTO_TABLE:
1663 case OFPACT_CONTROLLER:
1664 case OFPACT_OUTPUT_REG:
1666 case OFPACT_REG_MOVE:
1667 case OFPACT_REG_LOAD:
1668 case OFPACT_STACK_PUSH:
1669 case OFPACT_STACK_POP:
1670 case OFPACT_DEC_TTL:
1671 case OFPACT_SET_MPLS_TTL:
1672 case OFPACT_DEC_MPLS_TTL:
1673 case OFPACT_SET_TUNNEL:
1674 case OFPACT_WRITE_METADATA:
1675 case OFPACT_SET_QUEUE:
1676 case OFPACT_POP_QUEUE:
1677 case OFPACT_FIN_TIMEOUT:
1678 case OFPACT_RESUBMIT:
1680 case OFPACT_MULTIPATH:
1683 case OFPACT_PUSH_MPLS:
1684 case OFPACT_POP_MPLS:
1686 ofpact_to_nxast(a, out);
1691 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1692 * actions in 'openflow', appending the actions to any existing data in
1695 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1696 struct ofpbuf *openflow)
1698 const struct ofpact *a;
1700 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1701 ofpact_to_openflow10(a, openflow);
1705 /* Converting ofpacts to OpenFlow 1.1. */
1708 ofpact_output_to_openflow11(const struct ofpact_output *output,
1711 struct ofp11_action_output *oao;
1713 oao = ofputil_put_OFPAT11_OUTPUT(out);
1714 oao->port = ofputil_port_to_ofp11(output->port);
1715 oao->max_len = htons(output->max_len);
1719 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids *dec_ttl,
1722 if (dec_ttl->n_controllers == 1 && dec_ttl->cnt_ids[0] == 0
1723 && (!dec_ttl->ofpact.compat ||
1724 dec_ttl->ofpact.compat == OFPUTIL_OFPAT11_DEC_NW_TTL)) {
1725 ofputil_put_OFPAT11_DEC_NW_TTL(out);
1727 ofpact_dec_ttl_to_nxast(dec_ttl, out);
1732 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1736 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1738 case OFPACT_ENQUEUE:
1742 case OFPACT_SET_VLAN_VID:
1743 ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1744 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1747 case OFPACT_SET_VLAN_PCP:
1748 ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1749 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1752 case OFPACT_STRIP_VLAN:
1753 ofputil_put_OFPAT11_POP_VLAN(out);
1756 case OFPACT_PUSH_VLAN:
1757 /* XXX ETH_TYPE_VLAN_8021AD case */
1758 ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype =
1759 htons(ETH_TYPE_VLAN_8021Q);
1762 case OFPACT_SET_QUEUE:
1763 ofputil_put_OFPAT11_SET_QUEUE(out)->queue_id
1764 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1767 case OFPACT_SET_ETH_SRC:
1768 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1769 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1772 case OFPACT_SET_ETH_DST:
1773 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1774 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1777 case OFPACT_SET_IPV4_SRC:
1778 ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1779 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1782 case OFPACT_SET_IPV4_DST:
1783 ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1784 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1787 case OFPACT_SET_IPV4_DSCP:
1788 ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1789 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1792 case OFPACT_SET_L4_SRC_PORT:
1793 ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1794 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1797 case OFPACT_SET_L4_DST_PORT:
1798 ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1799 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1802 case OFPACT_DEC_TTL:
1803 ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a), out);
1806 case OFPACT_SET_MPLS_TTL:
1807 ofputil_put_OFPAT11_SET_MPLS_TTL(out)->mpls_ttl
1808 = ofpact_get_SET_MPLS_TTL(a)->ttl;
1811 case OFPACT_DEC_MPLS_TTL:
1812 ofputil_put_OFPAT11_DEC_MPLS_TTL(out);
1815 case OFPACT_WRITE_METADATA:
1816 /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
1819 case OFPACT_PUSH_MPLS:
1820 ofputil_put_OFPAT11_PUSH_MPLS(out)->ethertype =
1821 ofpact_get_PUSH_MPLS(a)->ethertype;
1824 case OFPACT_POP_MPLS:
1825 ofputil_put_OFPAT11_POP_MPLS(out)->ethertype =
1826 ofpact_get_POP_MPLS(a)->ethertype;
1830 case OFPACT_CLEAR_ACTIONS:
1831 case OFPACT_GOTO_TABLE:
1835 case OFPACT_CONTROLLER:
1836 case OFPACT_OUTPUT_REG:
1838 case OFPACT_REG_MOVE:
1839 case OFPACT_REG_LOAD:
1840 case OFPACT_STACK_PUSH:
1841 case OFPACT_STACK_POP:
1842 case OFPACT_SET_TUNNEL:
1843 case OFPACT_POP_QUEUE:
1844 case OFPACT_FIN_TIMEOUT:
1845 case OFPACT_RESUBMIT:
1847 case OFPACT_MULTIPATH:
1851 ofpact_to_nxast(a, out);
1856 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1857 * 1.1 actions in 'openflow', appending the actions to any existing data in
1860 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1861 size_t ofpacts_len, struct ofpbuf *openflow)
1863 const struct ofpact *a;
1864 size_t start_size = openflow->size;
1866 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1867 ofpact_to_openflow11(a, openflow);
1870 return openflow->size - start_size;
1874 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
1876 struct ofp11_instruction_actions *oia;
1878 /* Update the instruction's length (or, if it's empty, delete it). */
1879 oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1880 if (openflow->size > ofs + sizeof *oia) {
1881 oia->len = htons(openflow->size - ofs);
1883 openflow->size = ofs;
1888 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1890 struct ofpbuf *openflow)
1892 const struct ofpact *a;
1894 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1895 /* XXX Write-Actions */
1897 if (a->type == OFPACT_CLEAR_ACTIONS) {
1898 instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
1899 } else if (a->type == OFPACT_GOTO_TABLE) {
1900 struct ofp11_instruction_goto_table *oigt;
1902 oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
1903 oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
1904 memset(oigt->pad, 0, sizeof oigt->pad);
1905 } else if (a->type == OFPACT_WRITE_METADATA) {
1906 const struct ofpact_metadata *om;
1907 struct ofp11_instruction_write_metadata *oiwm;
1909 om = ofpact_get_WRITE_METADATA(a);
1910 oiwm = instruction_put_OFPIT11_WRITE_METADATA(openflow);
1911 oiwm->metadata = om->metadata;
1912 oiwm->metadata_mask = om->mask;
1913 } else if (a->type == OFPACT_METER) {
1914 const struct ofpact_meter *om;
1915 struct ofp13_instruction_meter *oim;
1917 om = ofpact_get_METER(a);
1918 oim = instruction_put_OFPIT13_METER(openflow);
1919 oim->meter_id = htonl(om->meter_id);
1920 } else if (!ofpact_is_instruction(a)) {
1922 const size_t ofs = openflow->size;
1923 const size_t ofpacts_len_left =
1924 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
1925 const struct ofpact *action;
1926 const struct ofpact *processed = a;
1928 instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1929 OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
1930 if (ofpact_is_instruction(action)) {
1933 ofpact_to_openflow11(action, openflow);
1936 ofpacts_update_instruction_actions(openflow, ofs);
1942 /* Returns true if 'action' outputs to 'port', false otherwise. */
1944 ofpact_outputs_to_port(const struct ofpact *ofpact, ofp_port_t port)
1946 switch (ofpact->type) {
1948 return ofpact_get_OUTPUT(ofpact)->port == port;
1949 case OFPACT_ENQUEUE:
1950 return ofpact_get_ENQUEUE(ofpact)->port == port;
1951 case OFPACT_CONTROLLER:
1952 return port == OFPP_CONTROLLER;
1954 case OFPACT_OUTPUT_REG:
1956 case OFPACT_SET_VLAN_VID:
1957 case OFPACT_SET_VLAN_PCP:
1958 case OFPACT_STRIP_VLAN:
1959 case OFPACT_PUSH_VLAN:
1960 case OFPACT_SET_ETH_SRC:
1961 case OFPACT_SET_ETH_DST:
1962 case OFPACT_SET_IPV4_SRC:
1963 case OFPACT_SET_IPV4_DST:
1964 case OFPACT_SET_IPV4_DSCP:
1965 case OFPACT_SET_L4_SRC_PORT:
1966 case OFPACT_SET_L4_DST_PORT:
1967 case OFPACT_REG_MOVE:
1968 case OFPACT_REG_LOAD:
1969 case OFPACT_STACK_PUSH:
1970 case OFPACT_STACK_POP:
1971 case OFPACT_DEC_TTL:
1972 case OFPACT_SET_MPLS_TTL:
1973 case OFPACT_DEC_MPLS_TTL:
1974 case OFPACT_SET_TUNNEL:
1975 case OFPACT_WRITE_METADATA:
1976 case OFPACT_SET_QUEUE:
1977 case OFPACT_POP_QUEUE:
1978 case OFPACT_FIN_TIMEOUT:
1979 case OFPACT_RESUBMIT:
1981 case OFPACT_MULTIPATH:
1984 case OFPACT_PUSH_MPLS:
1985 case OFPACT_POP_MPLS:
1987 case OFPACT_CLEAR_ACTIONS:
1988 case OFPACT_GOTO_TABLE:
1995 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1996 * to 'port', false otherwise. */
1998 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
2001 const struct ofpact *a;
2003 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2004 if (ofpact_outputs_to_port(a, port)) {
2013 ofpacts_equal(const struct ofpact *a, size_t a_len,
2014 const struct ofpact *b, size_t b_len)
2016 return a_len == b_len && !memcmp(a, b, a_len);
2019 /* Formatting ofpacts. */
2022 print_note(const struct ofpact_note *note, struct ds *string)
2026 ds_put_cstr(string, "note:");
2027 for (i = 0; i < note->length; i++) {
2029 ds_put_char(string, '.');
2031 ds_put_format(string, "%02"PRIx8, note->data[i]);
2036 print_dec_ttl(const struct ofpact_cnt_ids *ids,
2041 ds_put_cstr(s, "dec_ttl");
2042 if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
2043 ds_put_cstr(s, "(");
2044 for (i = 0; i < ids->n_controllers; i++) {
2046 ds_put_cstr(s, ",");
2048 ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
2050 ds_put_cstr(s, ")");
2055 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
2058 ds_put_cstr(s, "fin_timeout(");
2059 if (fin_timeout->fin_idle_timeout) {
2060 ds_put_format(s, "idle_timeout=%"PRIu16",",
2061 fin_timeout->fin_idle_timeout);
2063 if (fin_timeout->fin_hard_timeout) {
2064 ds_put_format(s, "hard_timeout=%"PRIu16",",
2065 fin_timeout->fin_hard_timeout);
2068 ds_put_char(s, ')');
2072 ofpact_format(const struct ofpact *a, struct ds *s)
2074 const struct ofpact_enqueue *enqueue;
2075 const struct ofpact_resubmit *resubmit;
2076 const struct ofpact_controller *controller;
2077 const struct ofpact_metadata *metadata;
2078 const struct ofpact_tunnel *tunnel;
2079 const struct ofpact_sample *sample;
2084 port = ofpact_get_OUTPUT(a)->port;
2085 if (ofp_to_u16(port) < ofp_to_u16(OFPP_MAX)) {
2086 ds_put_format(s, "output:%"PRIu16, port);
2088 ofputil_format_port(port, s);
2089 if (port == OFPP_CONTROLLER) {
2090 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
2095 case OFPACT_CONTROLLER:
2096 controller = ofpact_get_CONTROLLER(a);
2097 if (controller->reason == OFPR_ACTION &&
2098 controller->controller_id == 0) {
2099 ds_put_format(s, "CONTROLLER:%"PRIu16,
2100 ofpact_get_CONTROLLER(a)->max_len);
2102 enum ofp_packet_in_reason reason = controller->reason;
2104 ds_put_cstr(s, "controller(");
2105 if (reason != OFPR_ACTION) {
2106 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
2108 ds_put_format(s, "reason=%s,",
2109 ofputil_packet_in_reason_to_string(
2110 reason, reasonbuf, sizeof reasonbuf));
2112 if (controller->max_len != UINT16_MAX) {
2113 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
2115 if (controller->controller_id != 0) {
2116 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
2119 ds_put_char(s, ')');
2123 case OFPACT_ENQUEUE:
2124 enqueue = ofpact_get_ENQUEUE(a);
2125 ds_put_format(s, "enqueue:");
2126 ofputil_format_port(enqueue->port, s);
2127 ds_put_format(s, "q%"PRIu32, enqueue->queue);
2130 case OFPACT_OUTPUT_REG:
2131 ds_put_cstr(s, "output:");
2132 mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
2136 bundle_format(ofpact_get_BUNDLE(a), s);
2139 case OFPACT_SET_VLAN_VID:
2140 ds_put_format(s, "mod_vlan_vid:%"PRIu16,
2141 ofpact_get_SET_VLAN_VID(a)->vlan_vid);
2144 case OFPACT_SET_VLAN_PCP:
2145 ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
2146 ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
2149 case OFPACT_STRIP_VLAN:
2150 ds_put_cstr(s, "strip_vlan");
2153 case OFPACT_PUSH_VLAN:
2154 /* XXX 802.1AD case*/
2155 ds_put_format(s, "push_vlan:%#"PRIx16, ETH_TYPE_VLAN_8021Q);
2158 case OFPACT_SET_ETH_SRC:
2159 ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
2160 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
2163 case OFPACT_SET_ETH_DST:
2164 ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
2165 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
2168 case OFPACT_SET_IPV4_SRC:
2169 ds_put_format(s, "mod_nw_src:"IP_FMT,
2170 IP_ARGS(ofpact_get_SET_IPV4_SRC(a)->ipv4));
2173 case OFPACT_SET_IPV4_DST:
2174 ds_put_format(s, "mod_nw_dst:"IP_FMT,
2175 IP_ARGS(ofpact_get_SET_IPV4_DST(a)->ipv4));
2178 case OFPACT_SET_IPV4_DSCP:
2179 ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
2182 case OFPACT_SET_L4_SRC_PORT:
2183 ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
2186 case OFPACT_SET_L4_DST_PORT:
2187 ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
2190 case OFPACT_REG_MOVE:
2191 nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
2194 case OFPACT_REG_LOAD:
2195 nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
2198 case OFPACT_STACK_PUSH:
2199 nxm_format_stack_push(ofpact_get_STACK_PUSH(a), s);
2202 case OFPACT_STACK_POP:
2203 nxm_format_stack_pop(ofpact_get_STACK_POP(a), s);
2206 case OFPACT_DEC_TTL:
2207 print_dec_ttl(ofpact_get_DEC_TTL(a), s);
2210 case OFPACT_SET_MPLS_TTL:
2211 ds_put_format(s, "set_mpls_ttl(%"PRIu8")",
2212 ofpact_get_SET_MPLS_TTL(a)->ttl);
2215 case OFPACT_DEC_MPLS_TTL:
2216 ds_put_cstr(s, "dec_mpls_ttl");
2219 case OFPACT_SET_TUNNEL:
2220 tunnel = ofpact_get_SET_TUNNEL(a);
2221 ds_put_format(s, "set_tunnel%s:%#"PRIx64,
2222 (tunnel->tun_id > UINT32_MAX
2223 || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
2227 case OFPACT_SET_QUEUE:
2228 ds_put_format(s, "set_queue:%"PRIu32,
2229 ofpact_get_SET_QUEUE(a)->queue_id);
2232 case OFPACT_POP_QUEUE:
2233 ds_put_cstr(s, "pop_queue");
2236 case OFPACT_FIN_TIMEOUT:
2237 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
2240 case OFPACT_RESUBMIT:
2241 resubmit = ofpact_get_RESUBMIT(a);
2242 if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
2243 ds_put_cstr(s, "resubmit:");
2244 ofputil_format_port(resubmit->in_port, s);
2246 ds_put_format(s, "resubmit(");
2247 if (resubmit->in_port != OFPP_IN_PORT) {
2248 ofputil_format_port(resubmit->in_port, s);
2250 ds_put_char(s, ',');
2251 if (resubmit->table_id != 255) {
2252 ds_put_format(s, "%"PRIu8, resubmit->table_id);
2254 ds_put_char(s, ')');
2259 learn_format(ofpact_get_LEARN(a), s);
2262 case OFPACT_MULTIPATH:
2263 multipath_format(ofpact_get_MULTIPATH(a), s);
2267 print_note(ofpact_get_NOTE(a), s);
2270 case OFPACT_PUSH_MPLS:
2271 ds_put_format(s, "push_mpls:0x%04"PRIx16,
2272 ntohs(ofpact_get_PUSH_MPLS(a)->ethertype));
2275 case OFPACT_POP_MPLS:
2276 ds_put_format(s, "pop_mpls:0x%04"PRIx16,
2277 ntohs(ofpact_get_POP_MPLS(a)->ethertype));
2281 ds_put_cstr(s, "exit");
2285 sample = ofpact_get_SAMPLE(a);
2287 s, "sample(probability=%"PRIu16",collector_set_id=%"PRIu32
2288 ",obs_domain_id=%"PRIu32",obs_point_id=%"PRIu32")",
2289 sample->probability, sample->collector_set_id,
2290 sample->obs_domain_id, sample->obs_point_id);
2293 case OFPACT_CLEAR_ACTIONS:
2294 ds_put_format(s, "%s",
2295 ofpact_instruction_name_from_type(
2296 OVSINST_OFPIT11_CLEAR_ACTIONS));
2299 case OFPACT_WRITE_METADATA:
2300 metadata = ofpact_get_WRITE_METADATA(a);
2301 ds_put_format(s, "%s:%#"PRIx64,
2302 ofpact_instruction_name_from_type(
2303 OVSINST_OFPIT11_WRITE_METADATA),
2304 ntohll(metadata->metadata));
2305 if (metadata->mask != htonll(UINT64_MAX)) {
2306 ds_put_format(s, "/%#"PRIx64, ntohll(metadata->mask));
2310 case OFPACT_GOTO_TABLE:
2311 ds_put_format(s, "%s:%"PRIu8,
2312 ofpact_instruction_name_from_type(
2313 OVSINST_OFPIT11_GOTO_TABLE),
2314 ofpact_get_GOTO_TABLE(a)->table_id);
2318 ds_put_format(s, "%s:%"PRIu32,
2319 ofpact_instruction_name_from_type(OVSINST_OFPIT13_METER),
2320 ofpact_get_METER(a)->meter_id);
2325 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
2326 * 'ofpacts' to 'string'. */
2328 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
2331 ds_put_cstr(string, "actions=");
2333 ds_put_cstr(string, "drop");
2335 const struct ofpact *a;
2337 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2339 ds_put_cstr(string, ",");
2342 /* XXX write-actions */
2343 ofpact_format(a, string);
2348 /* Internal use by helpers. */
2351 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
2353 struct ofpact *ofpact;
2355 ofpact_pad(ofpacts);
2356 ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
2357 ofpact_init(ofpact, type, len);
2362 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
2364 memset(ofpact, 0, len);
2365 ofpact->type = type;
2366 ofpact->compat = OFPUTIL_ACTION_INVALID;
2370 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
2371 * starting at 'ofpact'.
2373 * This is the correct way to update a variable-length ofpact's length after
2374 * adding the variable-length part of the payload. (See the large comment
2375 * near the end of ofp-actions.h for more information.) */
2377 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
2379 ovs_assert(ofpact == ofpacts->l2);
2380 ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
2383 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
2384 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
2385 * client must call this itself after adding the final ofpact to an array of
2388 * (The consequences of failing to call this function are probably not dire.
2389 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
2390 * not dereference it. That's undefined behavior, technically, but it will not
2391 * cause a real problem on common systems. Still, it seems better to call
2394 ofpact_pad(struct ofpbuf *ofpacts)
2396 unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
2398 ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
2403 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
2406 load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
2407 load->dst.field = mf;
2409 load->dst.n_bits = mf->n_bits;
2410 bitwise_copy(src, mf->n_bytes, load->dst.ofs,
2411 &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);