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 = ALIGNED_CAST(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 ALIGNED_CAST(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 = ALIGNED_CAST(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(
406 ALIGNED_CAST(const struct nx_action_learn *, a), out);
409 case OFPUTIL_NXAST_EXIT:
410 ofpact_put_EXIT(out);
413 case OFPUTIL_NXAST_DEC_TTL:
414 error = dec_ttl_from_openflow(out, code);
417 case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
418 error = dec_ttl_cnt_ids_from_openflow(
419 (const struct nx_action_cnt_ids *) a, out);
422 case OFPUTIL_NXAST_FIN_TIMEOUT:
423 fin_timeout_from_openflow(
424 (const struct nx_action_fin_timeout *) a, out);
427 case OFPUTIL_NXAST_CONTROLLER:
428 controller_from_openflow((const struct nx_action_controller *) a, out);
431 case OFPUTIL_NXAST_PUSH_MPLS: {
432 struct nx_action_push_mpls *nxapm = (struct nx_action_push_mpls *)a;
433 if (!eth_type_mpls(nxapm->ethertype)) {
434 return OFPERR_OFPBAC_BAD_ARGUMENT;
436 ofpact_put_PUSH_MPLS(out)->ethertype = nxapm->ethertype;
440 case OFPUTIL_NXAST_SET_MPLS_TTL: {
441 struct nx_action_mpls_ttl *nxamt = (struct nx_action_mpls_ttl *)a;
442 ofpact_put_SET_MPLS_TTL(out)->ttl = nxamt->ttl;
446 case OFPUTIL_NXAST_DEC_MPLS_TTL:
447 ofpact_put_DEC_MPLS_TTL(out);
450 case OFPUTIL_NXAST_POP_MPLS: {
451 struct nx_action_pop_mpls *nxapm = (struct nx_action_pop_mpls *)a;
452 if (eth_type_mpls(nxapm->ethertype)) {
453 return OFPERR_OFPBAC_BAD_ARGUMENT;
455 ofpact_put_POP_MPLS(out)->ethertype = nxapm->ethertype;
459 case OFPUTIL_NXAST_SAMPLE:
460 error = sample_from_openflow(
461 (const struct nx_action_sample *) a, out);
469 ofpact_from_openflow10(const union ofp_action *a, struct ofpbuf *out)
471 enum ofputil_action_code code;
474 error = decode_openflow10_action(a, &code);
480 case OFPUTIL_ACTION_INVALID:
481 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
482 #include "ofp-util.def"
485 case OFPUTIL_OFPAT10_OUTPUT:
486 return output_from_openflow10(&a->output10, out);
488 case OFPUTIL_OFPAT10_SET_VLAN_VID:
489 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
490 return OFPERR_OFPBAC_BAD_ARGUMENT;
492 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
495 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
496 if (a->vlan_pcp.vlan_pcp & ~7) {
497 return OFPERR_OFPBAC_BAD_ARGUMENT;
499 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
502 case OFPUTIL_OFPAT10_STRIP_VLAN:
503 ofpact_put_STRIP_VLAN(out);
506 case OFPUTIL_OFPAT10_SET_DL_SRC:
507 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
508 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
511 case OFPUTIL_OFPAT10_SET_DL_DST:
512 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
513 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
516 case OFPUTIL_OFPAT10_SET_NW_SRC:
517 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
520 case OFPUTIL_OFPAT10_SET_NW_DST:
521 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
524 case OFPUTIL_OFPAT10_SET_NW_TOS:
525 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
526 return OFPERR_OFPBAC_BAD_ARGUMENT;
528 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
531 case OFPUTIL_OFPAT10_SET_TP_SRC:
532 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
535 case OFPUTIL_OFPAT10_SET_TP_DST:
536 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
540 case OFPUTIL_OFPAT10_ENQUEUE:
541 error = enqueue_from_openflow10((const struct ofp10_action_enqueue *) a,
545 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
546 #include "ofp-util.def"
547 return ofpact_from_nxast(a, code, out);
553 static inline union ofp_action *
554 action_next(const union ofp_action *a)
556 return ((union ofp_action *) (void *)
557 ((uint8_t *) a + ntohs(a->header.len)));
561 action_is_valid(const union ofp_action *a, size_t n_actions)
563 uint16_t len = ntohs(a->header.len);
564 return (!(len % OFP_ACTION_ALIGN)
566 && len / sizeof *a <= n_actions);
569 /* This macro is careful to check for actions with bad lengths. */
570 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
571 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
572 (LEFT) > 0 && action_is_valid(ITER, LEFT); \
573 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
574 (ITER) = action_next(ITER)))
577 log_bad_action(const union ofp_action *actions, size_t n_actions, size_t ofs,
580 if (!VLOG_DROP_WARN(&rl)) {
584 ds_put_hex_dump(&s, actions, n_actions * sizeof *actions, 0, false);
585 VLOG_WARN("bad action at offset %#zx (%s):\n%s",
586 ofs * sizeof *actions, ofperr_get_name(error), ds_cstr(&s));
592 ofpacts_from_openflow(const union ofp_action *in, size_t n_in,
594 enum ofperr (*ofpact_from_openflow)(
595 const union ofp_action *a, struct ofpbuf *out))
597 const union ofp_action *a;
600 ACTION_FOR_EACH (a, left, in, n_in) {
601 enum ofperr error = ofpact_from_openflow(a, out);
603 log_bad_action(in, n_in, a - in, error);
608 enum ofperr error = OFPERR_OFPBAC_BAD_LEN;
609 log_bad_action(in, n_in, n_in - left, error);
618 ofpacts_from_openflow10(const union ofp_action *in, size_t n_in,
621 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow10);
625 ofpacts_pull_actions(struct ofpbuf *openflow, unsigned int actions_len,
626 struct ofpbuf *ofpacts,
627 enum ofperr (*translate)(const union ofp_action *actions,
629 struct ofpbuf *ofpacts))
631 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
632 const union ofp_action *actions;
635 ofpbuf_clear(ofpacts);
637 if (actions_len % OFP_ACTION_ALIGN != 0) {
638 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
639 "multiple of %d", actions_len, OFP_ACTION_ALIGN);
640 return OFPERR_OFPBRC_BAD_LEN;
643 actions = ofpbuf_try_pull(openflow, actions_len);
644 if (actions == NULL) {
645 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
646 "remaining message length (%zu)",
647 actions_len, openflow->size);
648 return OFPERR_OFPBRC_BAD_LEN;
651 error = translate(actions, actions_len / OFP_ACTION_ALIGN, ofpacts);
653 ofpbuf_clear(ofpacts);
657 error = ofpacts_verify(ofpacts->data, ofpacts->size);
659 ofpbuf_clear(ofpacts);
664 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.0 actions from the
665 * front of 'openflow' into ofpacts. On success, replaces any existing content
666 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
667 * Returns 0 if successful, otherwise an OpenFlow error.
669 * The parsed actions are valid generically, but they may not be valid in a
670 * specific context. For example, port numbers up to OFPP_MAX are valid
671 * generically, but specific datapaths may only support port numbers in a
672 * smaller range. Use ofpacts_check() to additional check whether actions are
673 * valid in a specific context. */
675 ofpacts_pull_openflow10(struct ofpbuf *openflow, unsigned int actions_len,
676 struct ofpbuf *ofpacts)
678 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
679 ofpacts_from_openflow10);
682 /* OpenFlow 1.1 actions. */
684 /* Parses 'a' to determine its type. On success stores the correct type into
685 * '*code' and returns 0. On failure returns an OFPERR_* error code and
686 * '*code' is indeterminate.
688 * The caller must have already verified that 'a''s length is potentially
689 * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
690 * ofp_action) and no longer than the amount of space allocated to 'a').
692 * This function verifies that 'a''s length is correct for the type of action
693 * that it represents. */
695 decode_openflow11_action(const union ofp_action *a,
696 enum ofputil_action_code *code)
701 case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
702 return decode_nxast_action(a, code);
704 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
705 case CONSTANT_HTONS(ENUM): \
706 len = ntohs(a->header.len); \
708 ? len >= sizeof(struct STRUCT) \
709 : len == sizeof(struct STRUCT)) { \
710 *code = OFPUTIL_##ENUM; \
713 return OFPERR_OFPBAC_BAD_LEN; \
716 #include "ofp-util.def"
719 return OFPERR_OFPBAC_BAD_TYPE;
724 output_from_openflow11(const struct ofp11_action_output *oao,
727 struct ofpact_output *output;
730 output = ofpact_put_OUTPUT(out);
731 output->max_len = ntohs(oao->max_len);
733 error = ofputil_port_from_ofp11(oao->port, &output->port);
738 return ofputil_check_output_port(output->port, OFPP_MAX);
742 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
744 enum ofputil_action_code code;
747 error = decode_openflow11_action(a, &code);
753 case OFPUTIL_ACTION_INVALID:
754 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
755 #include "ofp-util.def"
758 case OFPUTIL_OFPAT11_OUTPUT:
759 return output_from_openflow11((const struct ofp11_action_output *) a,
762 case OFPUTIL_OFPAT11_SET_VLAN_VID:
763 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
764 return OFPERR_OFPBAC_BAD_ARGUMENT;
766 ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
769 case OFPUTIL_OFPAT11_SET_VLAN_PCP:
770 if (a->vlan_pcp.vlan_pcp & ~7) {
771 return OFPERR_OFPBAC_BAD_ARGUMENT;
773 ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
776 case OFPUTIL_OFPAT11_PUSH_VLAN:
777 if (((const struct ofp11_action_push *)a)->ethertype !=
778 htons(ETH_TYPE_VLAN_8021Q)) {
779 /* XXX 802.1AD(QinQ) isn't supported at the moment */
780 return OFPERR_OFPBAC_BAD_ARGUMENT;
782 ofpact_put_PUSH_VLAN(out);
785 case OFPUTIL_OFPAT11_POP_VLAN:
786 ofpact_put_STRIP_VLAN(out);
789 case OFPUTIL_OFPAT11_SET_QUEUE:
790 ofpact_put_SET_QUEUE(out)->queue_id =
791 ntohl(((const struct ofp11_action_set_queue *)a)->queue_id);
794 case OFPUTIL_OFPAT11_SET_DL_SRC:
795 memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
796 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
799 case OFPUTIL_OFPAT11_SET_DL_DST:
800 memcpy(ofpact_put_SET_ETH_DST(out)->mac,
801 ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
804 case OFPUTIL_OFPAT11_DEC_NW_TTL:
805 dec_ttl_from_openflow(out, code);
808 case OFPUTIL_OFPAT11_SET_NW_SRC:
809 ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
812 case OFPUTIL_OFPAT11_SET_NW_DST:
813 ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
816 case OFPUTIL_OFPAT11_SET_NW_TOS:
817 if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
818 return OFPERR_OFPBAC_BAD_ARGUMENT;
820 ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
823 case OFPUTIL_OFPAT11_SET_TP_SRC:
824 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
827 case OFPUTIL_OFPAT11_SET_TP_DST:
828 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
831 case OFPUTIL_OFPAT12_SET_FIELD:
832 return nxm_reg_load_from_openflow12_set_field(
833 (const struct ofp12_action_set_field *)a, out);
835 case OFPUTIL_OFPAT11_SET_MPLS_TTL: {
836 struct ofp11_action_mpls_ttl *oamt = (struct ofp11_action_mpls_ttl *)a;
837 ofpact_put_SET_MPLS_TTL(out)->ttl = oamt->mpls_ttl;
841 case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
842 ofpact_put_DEC_MPLS_TTL(out);
845 case OFPUTIL_OFPAT11_PUSH_MPLS: {
846 struct ofp11_action_push *oap = (struct ofp11_action_push *)a;
847 if (!eth_type_mpls(oap->ethertype)) {
848 return OFPERR_OFPBAC_BAD_ARGUMENT;
850 ofpact_put_PUSH_MPLS(out)->ethertype = oap->ethertype;
854 case OFPUTIL_OFPAT11_POP_MPLS: {
855 struct ofp11_action_pop_mpls *oapm = (struct ofp11_action_pop_mpls *)a;
856 if (eth_type_mpls(oapm->ethertype)) {
857 return OFPERR_OFPBAC_BAD_ARGUMENT;
859 ofpact_put_POP_MPLS(out)->ethertype = oapm->ethertype;
863 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
864 #include "ofp-util.def"
865 return ofpact_from_nxast(a, code, out);
872 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
875 return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
878 /* OpenFlow 1.1 instructions. */
880 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
881 static inline const struct STRUCT * \
882 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
884 ovs_assert(inst->type == htons(ENUM)); \
885 return ALIGNED_CAST(struct STRUCT *, inst); \
889 instruction_init_##ENUM(struct STRUCT *s) \
891 memset(s, 0, sizeof *s); \
892 s->type = htons(ENUM); \
893 s->len = htons(sizeof *s); \
896 static inline struct STRUCT * \
897 instruction_put_##ENUM(struct ofpbuf *buf) \
899 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
900 instruction_init_##ENUM(s); \
906 struct instruction_type_info {
907 enum ovs_instruction_type type;
911 static const struct instruction_type_info inst_info[] = {
912 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
918 ovs_instruction_name_from_type(enum ovs_instruction_type type)
920 return inst_info[type].name;
924 ovs_instruction_type_from_name(const char *name)
926 const struct instruction_type_info *p;
927 for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
928 if (!strcasecmp(name, p->name)) {
935 enum ovs_instruction_type
936 ovs_instruction_type_from_ofpact_type(enum ofpact_type type)
940 return OVSINST_OFPIT13_METER;
941 case OFPACT_CLEAR_ACTIONS:
942 return OVSINST_OFPIT11_CLEAR_ACTIONS;
943 case OFPACT_WRITE_METADATA:
944 return OVSINST_OFPIT11_WRITE_METADATA;
945 case OFPACT_GOTO_TABLE:
946 return OVSINST_OFPIT11_GOTO_TABLE;
948 case OFPACT_CONTROLLER:
950 case OFPACT_OUTPUT_REG:
952 case OFPACT_SET_VLAN_VID:
953 case OFPACT_SET_VLAN_PCP:
954 case OFPACT_STRIP_VLAN:
955 case OFPACT_PUSH_VLAN:
956 case OFPACT_SET_ETH_SRC:
957 case OFPACT_SET_ETH_DST:
958 case OFPACT_SET_IPV4_SRC:
959 case OFPACT_SET_IPV4_DST:
960 case OFPACT_SET_IPV4_DSCP:
961 case OFPACT_SET_L4_SRC_PORT:
962 case OFPACT_SET_L4_DST_PORT:
963 case OFPACT_REG_MOVE:
964 case OFPACT_REG_LOAD:
965 case OFPACT_STACK_PUSH:
966 case OFPACT_STACK_POP:
968 case OFPACT_SET_MPLS_TTL:
969 case OFPACT_DEC_MPLS_TTL:
970 case OFPACT_PUSH_MPLS:
971 case OFPACT_POP_MPLS:
972 case OFPACT_SET_TUNNEL:
973 case OFPACT_SET_QUEUE:
974 case OFPACT_POP_QUEUE:
975 case OFPACT_FIN_TIMEOUT:
976 case OFPACT_RESUBMIT:
978 case OFPACT_MULTIPATH:
983 return OVSINST_OFPIT11_APPLY_ACTIONS;
987 static inline struct ofp11_instruction *
988 instruction_next(const struct ofp11_instruction *inst)
990 return ((struct ofp11_instruction *) (void *)
991 ((uint8_t *) inst + ntohs(inst->len)));
995 instruction_is_valid(const struct ofp11_instruction *inst,
996 size_t n_instructions)
998 uint16_t len = ntohs(inst->len);
999 return (!(len % OFP11_INSTRUCTION_ALIGN)
1000 && len >= sizeof *inst
1001 && len / sizeof *inst <= n_instructions);
1004 /* This macro is careful to check for instructions with bad lengths. */
1005 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
1006 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
1007 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
1008 ((LEFT) -= (ntohs((ITER)->len) \
1009 / sizeof(struct ofp11_instruction)), \
1010 (ITER) = instruction_next(ITER)))
1013 decode_openflow11_instruction(const struct ofp11_instruction *inst,
1014 enum ovs_instruction_type *type)
1016 uint16_t len = ntohs(inst->len);
1018 switch (inst->type) {
1019 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
1020 return OFPERR_OFPBIC_BAD_EXPERIMENTER;
1022 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
1023 case CONSTANT_HTONS(ENUM): \
1025 ? len >= sizeof(struct STRUCT) \
1026 : len == sizeof(struct STRUCT)) { \
1027 *type = OVSINST_##ENUM; \
1030 return OFPERR_OFPBIC_BAD_LEN; \
1036 return OFPERR_OFPBIC_UNKNOWN_INST;
1041 decode_openflow11_instructions(const struct ofp11_instruction insts[],
1043 const struct ofp11_instruction *out[])
1045 const struct ofp11_instruction *inst;
1048 memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
1049 INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
1050 enum ovs_instruction_type type;
1053 error = decode_openflow11_instruction(inst, &type);
1059 return OFPERR_ONFBIC_DUP_INSTRUCTION;
1065 VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
1066 (n_insts - left) * sizeof *inst);
1067 return OFPERR_OFPBIC_BAD_LEN;
1073 get_actions_from_instruction(const struct ofp11_instruction *inst,
1074 const union ofp_action **actions,
1077 *actions = ALIGNED_CAST(const union ofp_action *, inst + 1);
1078 *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
1081 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
1082 * front of 'openflow' into ofpacts. On success, replaces any existing content
1083 * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
1084 * Returns 0 if successful, otherwise an OpenFlow error.
1086 * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
1087 * instructions, so you should call ofpacts_pull_openflow11_instructions()
1088 * instead of this function.
1090 * The parsed actions are valid generically, but they may not be valid in a
1091 * specific context. For example, port numbers up to OFPP_MAX are valid
1092 * generically, but specific datapaths may only support port numbers in a
1093 * smaller range. Use ofpacts_check() to additional check whether actions are
1094 * valid in a specific context. */
1096 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
1097 unsigned int actions_len,
1098 struct ofpbuf *ofpacts)
1100 return ofpacts_pull_actions(openflow, actions_len, ofpacts,
1101 ofpacts_from_openflow11);
1105 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
1106 unsigned int instructions_len,
1107 struct ofpbuf *ofpacts)
1109 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1110 const struct ofp11_instruction *instructions;
1111 const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
1114 ofpbuf_clear(ofpacts);
1116 if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
1117 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
1119 instructions_len, OFP11_INSTRUCTION_ALIGN);
1120 error = OFPERR_OFPBIC_BAD_LEN;
1124 instructions = ofpbuf_try_pull(openflow, instructions_len);
1125 if (instructions == NULL) {
1126 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
1127 "remaining message length (%zu)",
1128 instructions_len, openflow->size);
1129 error = OFPERR_OFPBIC_BAD_LEN;
1133 error = decode_openflow11_instructions(
1134 instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
1140 if (insts[OVSINST_OFPIT13_METER]) {
1141 const struct ofp13_instruction_meter *oim;
1142 struct ofpact_meter *om;
1144 oim = ALIGNED_CAST(const struct ofp13_instruction_meter *,
1145 insts[OVSINST_OFPIT13_METER]);
1147 om = ofpact_put_METER(ofpacts);
1148 om->meter_id = ntohl(oim->meter_id);
1150 if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
1151 const union ofp_action *actions;
1154 get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
1155 &actions, &n_actions);
1156 error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
1161 if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
1162 instruction_get_OFPIT11_CLEAR_ACTIONS(
1163 insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
1164 ofpact_put_CLEAR_ACTIONS(ofpacts);
1166 /* XXX Write-Actions */
1167 if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
1168 const struct ofp11_instruction_write_metadata *oiwm;
1169 struct ofpact_metadata *om;
1171 oiwm = ALIGNED_CAST(const struct ofp11_instruction_write_metadata *,
1172 insts[OVSINST_OFPIT11_WRITE_METADATA]);
1174 om = ofpact_put_WRITE_METADATA(ofpacts);
1175 om->metadata = oiwm->metadata;
1176 om->mask = oiwm->metadata_mask;
1178 if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
1179 const struct ofp11_instruction_goto_table *oigt;
1180 struct ofpact_goto_table *ogt;
1182 oigt = instruction_get_OFPIT11_GOTO_TABLE(
1183 insts[OVSINST_OFPIT11_GOTO_TABLE]);
1184 ogt = ofpact_put_GOTO_TABLE(ofpacts);
1185 ogt->table_id = oigt->table_id;
1188 if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
1189 error = OFPERR_OFPBIC_UNSUP_INST;
1193 error = ofpacts_verify(ofpacts->data, ofpacts->size);
1196 ofpbuf_clear(ofpacts);
1201 /* May modify flow->dl_type, caller must restore it. */
1203 ofpact_check__(const struct ofpact *a, struct flow *flow, ofp_port_t max_ports,
1206 const struct ofpact_enqueue *enqueue;
1210 return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
1213 case OFPACT_CONTROLLER:
1216 case OFPACT_ENQUEUE:
1217 enqueue = ofpact_get_ENQUEUE(a);
1218 if (ofp_to_u16(enqueue->port) >= ofp_to_u16(max_ports)
1219 && enqueue->port != OFPP_IN_PORT
1220 && enqueue->port != OFPP_LOCAL) {
1221 return OFPERR_OFPBAC_BAD_OUT_PORT;
1225 case OFPACT_OUTPUT_REG:
1226 return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1229 return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1231 case OFPACT_SET_VLAN_VID:
1232 case OFPACT_SET_VLAN_PCP:
1233 case OFPACT_STRIP_VLAN:
1234 case OFPACT_PUSH_VLAN:
1235 case OFPACT_SET_ETH_SRC:
1236 case OFPACT_SET_ETH_DST:
1237 case OFPACT_SET_IPV4_SRC:
1238 case OFPACT_SET_IPV4_DST:
1239 case OFPACT_SET_IPV4_DSCP:
1240 case OFPACT_SET_L4_SRC_PORT:
1241 case OFPACT_SET_L4_DST_PORT:
1244 case OFPACT_REG_MOVE:
1245 return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1247 case OFPACT_REG_LOAD:
1248 return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1250 case OFPACT_STACK_PUSH:
1251 return nxm_stack_push_check(ofpact_get_STACK_PUSH(a), flow);
1253 case OFPACT_STACK_POP:
1254 return nxm_stack_pop_check(ofpact_get_STACK_POP(a), flow);
1256 case OFPACT_DEC_TTL:
1257 case OFPACT_SET_MPLS_TTL:
1258 case OFPACT_DEC_MPLS_TTL:
1259 case OFPACT_SET_TUNNEL:
1260 case OFPACT_SET_QUEUE:
1261 case OFPACT_POP_QUEUE:
1262 case OFPACT_FIN_TIMEOUT:
1263 case OFPACT_RESUBMIT:
1267 return learn_check(ofpact_get_LEARN(a), flow);
1269 case OFPACT_MULTIPATH:
1270 return multipath_check(ofpact_get_MULTIPATH(a), flow);
1276 case OFPACT_PUSH_MPLS:
1277 flow->dl_type = ofpact_get_PUSH_MPLS(a)->ethertype;
1280 case OFPACT_POP_MPLS:
1281 flow->dl_type = ofpact_get_POP_MPLS(a)->ethertype;
1287 case OFPACT_CLEAR_ACTIONS:
1288 case OFPACT_WRITE_METADATA:
1291 case OFPACT_METER: {
1292 uint32_t mid = ofpact_get_METER(a)->meter_id;
1293 if (mid == 0 || mid > OFPM13_MAX) {
1294 return OFPERR_OFPMMFC_INVALID_METER;
1299 case OFPACT_GOTO_TABLE:
1300 if (ofpact_get_GOTO_TABLE(a)->table_id <= table_id) {
1301 return OFPERR_OFPBRC_BAD_TABLE_ID;
1310 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1311 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1312 * switch with no more than 'max_ports' ports.
1314 * May temporarily modify 'flow', but restores the changes before returning. */
1316 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1317 struct flow *flow, ofp_port_t max_ports, uint8_t table_id)
1319 const struct ofpact *a;
1320 ovs_be16 dl_type = flow->dl_type;
1321 enum ofperr error = 0;
1323 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1324 error = ofpact_check__(a, flow, max_ports, table_id);
1329 flow->dl_type = dl_type; /* Restore. */
1333 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1334 * in the appropriate order as defined by the OpenFlow spec. */
1336 ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len)
1338 const struct ofpact *a;
1339 enum ovs_instruction_type inst;
1341 inst = OVSINST_OFPIT11_APPLY_ACTIONS;
1342 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1343 enum ovs_instruction_type next;
1345 next = ovs_instruction_type_from_ofpact_type(a->type);
1346 if (inst != OVSINST_OFPIT11_APPLY_ACTIONS && next <= inst) {
1347 const char *name = ovs_instruction_name_from_type(inst);
1348 const char *next_name = ovs_instruction_name_from_type(next);
1351 VLOG_WARN("duplicate %s instruction not allowed, for OpenFlow "
1352 "1.1+ compatibility", name);
1354 VLOG_WARN("invalid instruction ordering: %s must appear "
1355 "before %s, for OpenFlow 1.1+ compatibility",
1358 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1367 /* Converting ofpacts to Nicira OpenFlow extensions. */
1370 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1373 struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1375 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1376 output_reg->src.n_bits);
1377 naor->src = htonl(output_reg->src.field->nxm_header);
1378 naor->max_len = htons(output_reg->max_len);
1382 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1385 struct nx_action_resubmit *nar;
1387 if (resubmit->table_id == 0xff
1388 && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1389 nar = ofputil_put_NXAST_RESUBMIT(out);
1391 nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1392 nar->table = resubmit->table_id;
1394 nar->in_port = htons(ofp_to_u16(resubmit->in_port));
1398 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1401 uint64_t tun_id = tunnel->tun_id;
1403 if (tun_id <= UINT32_MAX
1404 && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1405 ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1407 ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1412 ofpact_write_metadata_to_nxast(const struct ofpact_metadata *om,
1415 struct nx_action_write_metadata *nawm;
1417 nawm = ofputil_put_NXAST_WRITE_METADATA(out);
1418 nawm->metadata = om->metadata;
1419 nawm->mask = om->mask;
1423 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1425 size_t start_ofs = out->size;
1426 struct nx_action_note *nan;
1427 unsigned int remainder;
1430 nan = ofputil_put_NXAST_NOTE(out);
1431 out->size -= sizeof nan->note;
1433 ofpbuf_put(out, note->data, note->length);
1435 len = out->size - start_ofs;
1436 remainder = len % OFP_ACTION_ALIGN;
1438 ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1440 nan = ofpbuf_at(out, start_ofs, sizeof *nan);
1441 nan->len = htons(out->size - start_ofs);
1445 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1448 struct nx_action_controller *nac;
1450 nac = ofputil_put_NXAST_CONTROLLER(out);
1451 nac->max_len = htons(oc->max_len);
1452 nac->controller_id = htons(oc->controller_id);
1453 nac->reason = oc->reason;
1457 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1460 if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1461 ofputil_put_NXAST_DEC_TTL(out);
1463 struct nx_action_cnt_ids *nac_ids =
1464 ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1465 int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1469 nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1470 nac_ids->n_controllers = htons(oc_ids->n_controllers);
1472 ids = ofpbuf_put_zeros(out, ids_len);
1473 for (i = 0; i < oc_ids->n_controllers; i++) {
1474 ids[i] = htons(oc_ids->cnt_ids[i]);
1480 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1483 struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1484 naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1485 naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1489 ofpact_sample_to_nxast(const struct ofpact_sample *os,
1492 struct nx_action_sample *nas;
1494 nas = ofputil_put_NXAST_SAMPLE(out);
1495 nas->probability = htons(os->probability);
1496 nas->collector_set_id = htonl(os->collector_set_id);
1497 nas->obs_domain_id = htonl(os->obs_domain_id);
1498 nas->obs_point_id = htonl(os->obs_point_id);
1502 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1505 case OFPACT_CONTROLLER:
1506 ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1509 case OFPACT_OUTPUT_REG:
1510 ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1514 bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1517 case OFPACT_REG_MOVE:
1518 nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1521 case OFPACT_REG_LOAD:
1522 nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1525 case OFPACT_STACK_PUSH:
1526 nxm_stack_push_to_nxast(ofpact_get_STACK_PUSH(a), out);
1529 case OFPACT_STACK_POP:
1530 nxm_stack_pop_to_nxast(ofpact_get_STACK_POP(a), out);
1533 case OFPACT_DEC_TTL:
1534 ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1537 case OFPACT_SET_MPLS_TTL:
1538 ofputil_put_NXAST_SET_MPLS_TTL(out)->ttl
1539 = ofpact_get_SET_MPLS_TTL(a)->ttl;
1542 case OFPACT_DEC_MPLS_TTL:
1543 ofputil_put_NXAST_DEC_MPLS_TTL(out);
1546 case OFPACT_SET_TUNNEL:
1547 ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1550 case OFPACT_WRITE_METADATA:
1551 ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a), out);
1554 case OFPACT_SET_QUEUE:
1555 ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1556 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1559 case OFPACT_POP_QUEUE:
1560 ofputil_put_NXAST_POP_QUEUE(out);
1563 case OFPACT_FIN_TIMEOUT:
1564 ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1567 case OFPACT_RESUBMIT:
1568 ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1572 learn_to_nxast(ofpact_get_LEARN(a), out);
1575 case OFPACT_MULTIPATH:
1576 multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1580 ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1584 ofputil_put_NXAST_EXIT(out);
1587 case OFPACT_PUSH_MPLS:
1588 ofputil_put_NXAST_PUSH_MPLS(out)->ethertype =
1589 ofpact_get_PUSH_MPLS(a)->ethertype;
1592 case OFPACT_POP_MPLS:
1593 ofputil_put_NXAST_POP_MPLS(out)->ethertype =
1594 ofpact_get_POP_MPLS(a)->ethertype;
1598 ofpact_sample_to_nxast(ofpact_get_SAMPLE(a), out);
1602 case OFPACT_ENQUEUE:
1603 case OFPACT_SET_VLAN_VID:
1604 case OFPACT_SET_VLAN_PCP:
1605 case OFPACT_STRIP_VLAN:
1606 case OFPACT_PUSH_VLAN:
1607 case OFPACT_SET_ETH_SRC:
1608 case OFPACT_SET_ETH_DST:
1609 case OFPACT_SET_IPV4_SRC:
1610 case OFPACT_SET_IPV4_DST:
1611 case OFPACT_SET_IPV4_DSCP:
1612 case OFPACT_SET_L4_SRC_PORT:
1613 case OFPACT_SET_L4_DST_PORT:
1614 case OFPACT_CLEAR_ACTIONS:
1615 case OFPACT_GOTO_TABLE:
1621 /* Converting ofpacts to OpenFlow 1.0. */
1624 ofpact_output_to_openflow10(const struct ofpact_output *output,
1627 struct ofp10_action_output *oao;
1629 oao = ofputil_put_OFPAT10_OUTPUT(out);
1630 oao->port = htons(ofp_to_u16(output->port));
1631 oao->max_len = htons(output->max_len);
1635 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1638 struct ofp10_action_enqueue *oae;
1640 oae = ofputil_put_OFPAT10_ENQUEUE(out);
1641 oae->port = htons(ofp_to_u16(enqueue->port));
1642 oae->queue_id = htonl(enqueue->queue);
1646 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1650 ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1653 case OFPACT_ENQUEUE:
1654 ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1657 case OFPACT_SET_VLAN_VID:
1658 ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1659 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1662 case OFPACT_SET_VLAN_PCP:
1663 ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1664 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1667 case OFPACT_STRIP_VLAN:
1668 ofputil_put_OFPAT10_STRIP_VLAN(out);
1671 case OFPACT_SET_ETH_SRC:
1672 memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1673 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1676 case OFPACT_SET_ETH_DST:
1677 memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1678 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1681 case OFPACT_SET_IPV4_SRC:
1682 ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1683 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1686 case OFPACT_SET_IPV4_DST:
1687 ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1688 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1691 case OFPACT_SET_IPV4_DSCP:
1692 ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1693 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1696 case OFPACT_SET_L4_SRC_PORT:
1697 ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1698 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1701 case OFPACT_SET_L4_DST_PORT:
1702 ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1703 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1706 case OFPACT_PUSH_VLAN:
1707 case OFPACT_CLEAR_ACTIONS:
1708 case OFPACT_GOTO_TABLE:
1713 case OFPACT_CONTROLLER:
1714 case OFPACT_OUTPUT_REG:
1716 case OFPACT_REG_MOVE:
1717 case OFPACT_REG_LOAD:
1718 case OFPACT_STACK_PUSH:
1719 case OFPACT_STACK_POP:
1720 case OFPACT_DEC_TTL:
1721 case OFPACT_SET_MPLS_TTL:
1722 case OFPACT_DEC_MPLS_TTL:
1723 case OFPACT_SET_TUNNEL:
1724 case OFPACT_WRITE_METADATA:
1725 case OFPACT_SET_QUEUE:
1726 case OFPACT_POP_QUEUE:
1727 case OFPACT_FIN_TIMEOUT:
1728 case OFPACT_RESUBMIT:
1730 case OFPACT_MULTIPATH:
1733 case OFPACT_PUSH_MPLS:
1734 case OFPACT_POP_MPLS:
1736 ofpact_to_nxast(a, out);
1741 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1742 * actions in 'openflow', appending the actions to any existing data in
1745 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1746 struct ofpbuf *openflow)
1748 const struct ofpact *a;
1750 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1751 ofpact_to_openflow10(a, openflow);
1755 /* Converting ofpacts to OpenFlow 1.1. */
1758 ofpact_output_to_openflow11(const struct ofpact_output *output,
1761 struct ofp11_action_output *oao;
1763 oao = ofputil_put_OFPAT11_OUTPUT(out);
1764 oao->port = ofputil_port_to_ofp11(output->port);
1765 oao->max_len = htons(output->max_len);
1769 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids *dec_ttl,
1772 if (dec_ttl->n_controllers == 1 && dec_ttl->cnt_ids[0] == 0
1773 && (!dec_ttl->ofpact.compat ||
1774 dec_ttl->ofpact.compat == OFPUTIL_OFPAT11_DEC_NW_TTL)) {
1775 ofputil_put_OFPAT11_DEC_NW_TTL(out);
1777 ofpact_dec_ttl_to_nxast(dec_ttl, out);
1782 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1786 return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1788 case OFPACT_ENQUEUE:
1792 case OFPACT_SET_VLAN_VID:
1793 ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1794 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1797 case OFPACT_SET_VLAN_PCP:
1798 ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1799 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1802 case OFPACT_STRIP_VLAN:
1803 ofputil_put_OFPAT11_POP_VLAN(out);
1806 case OFPACT_PUSH_VLAN:
1807 /* XXX ETH_TYPE_VLAN_8021AD case */
1808 ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype =
1809 htons(ETH_TYPE_VLAN_8021Q);
1812 case OFPACT_SET_QUEUE:
1813 ofputil_put_OFPAT11_SET_QUEUE(out)->queue_id
1814 = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1817 case OFPACT_SET_ETH_SRC:
1818 memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1819 ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1822 case OFPACT_SET_ETH_DST:
1823 memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1824 ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1827 case OFPACT_SET_IPV4_SRC:
1828 ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1829 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1832 case OFPACT_SET_IPV4_DST:
1833 ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1834 = ofpact_get_SET_IPV4_DST(a)->ipv4;
1837 case OFPACT_SET_IPV4_DSCP:
1838 ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1839 = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1842 case OFPACT_SET_L4_SRC_PORT:
1843 ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1844 = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1847 case OFPACT_SET_L4_DST_PORT:
1848 ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1849 = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1852 case OFPACT_DEC_TTL:
1853 ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a), out);
1856 case OFPACT_SET_MPLS_TTL:
1857 ofputil_put_OFPAT11_SET_MPLS_TTL(out)->mpls_ttl
1858 = ofpact_get_SET_MPLS_TTL(a)->ttl;
1861 case OFPACT_DEC_MPLS_TTL:
1862 ofputil_put_OFPAT11_DEC_MPLS_TTL(out);
1865 case OFPACT_WRITE_METADATA:
1866 /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
1869 case OFPACT_PUSH_MPLS:
1870 ofputil_put_OFPAT11_PUSH_MPLS(out)->ethertype =
1871 ofpact_get_PUSH_MPLS(a)->ethertype;
1874 case OFPACT_POP_MPLS:
1875 ofputil_put_OFPAT11_POP_MPLS(out)->ethertype =
1876 ofpact_get_POP_MPLS(a)->ethertype;
1880 case OFPACT_CLEAR_ACTIONS:
1881 case OFPACT_GOTO_TABLE:
1885 case OFPACT_CONTROLLER:
1886 case OFPACT_OUTPUT_REG:
1888 case OFPACT_REG_MOVE:
1889 case OFPACT_REG_LOAD:
1890 case OFPACT_STACK_PUSH:
1891 case OFPACT_STACK_POP:
1892 case OFPACT_SET_TUNNEL:
1893 case OFPACT_POP_QUEUE:
1894 case OFPACT_FIN_TIMEOUT:
1895 case OFPACT_RESUBMIT:
1897 case OFPACT_MULTIPATH:
1901 ofpact_to_nxast(a, out);
1906 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1907 * 1.1 actions in 'openflow', appending the actions to any existing data in
1910 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1911 size_t ofpacts_len, struct ofpbuf *openflow)
1913 const struct ofpact *a;
1914 size_t start_size = openflow->size;
1916 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1917 ofpact_to_openflow11(a, openflow);
1920 return openflow->size - start_size;
1924 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
1926 struct ofp11_instruction_actions *oia;
1928 /* Update the instruction's length (or, if it's empty, delete it). */
1929 oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1930 if (openflow->size > ofs + sizeof *oia) {
1931 oia->len = htons(openflow->size - ofs);
1933 openflow->size = ofs;
1938 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1940 struct ofpbuf *openflow)
1942 const struct ofpact *a;
1944 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1945 switch (ovs_instruction_type_from_ofpact_type(a->type)) {
1946 case OVSINST_OFPIT11_CLEAR_ACTIONS:
1947 instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
1950 case OVSINST_OFPIT11_GOTO_TABLE: {
1951 struct ofp11_instruction_goto_table *oigt;
1952 oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
1953 oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
1954 memset(oigt->pad, 0, sizeof oigt->pad);
1958 case OVSINST_OFPIT11_WRITE_METADATA: {
1959 const struct ofpact_metadata *om;
1960 struct ofp11_instruction_write_metadata *oiwm;
1962 om = ofpact_get_WRITE_METADATA(a);
1963 oiwm = instruction_put_OFPIT11_WRITE_METADATA(openflow);
1964 oiwm->metadata = om->metadata;
1965 oiwm->metadata_mask = om->mask;
1969 case OVSINST_OFPIT13_METER: {
1970 const struct ofpact_meter *om;
1971 struct ofp13_instruction_meter *oim;
1973 om = ofpact_get_METER(a);
1974 oim = instruction_put_OFPIT13_METER(openflow);
1975 oim->meter_id = htonl(om->meter_id);
1979 case OVSINST_OFPIT11_APPLY_ACTIONS: {
1980 const size_t ofs = openflow->size;
1981 const size_t ofpacts_len_left =
1982 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
1983 const struct ofpact *action;
1984 const struct ofpact *processed = a;
1986 instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1987 OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
1988 if (ovs_instruction_type_from_ofpact_type(action->type)
1989 != OVSINST_OFPIT11_APPLY_ACTIONS) {
1992 ofpact_to_openflow11(action, openflow);
1995 ofpacts_update_instruction_actions(openflow, ofs);
2000 case OVSINST_OFPIT11_WRITE_ACTIONS:
2006 /* Returns true if 'action' outputs to 'port', false otherwise. */
2008 ofpact_outputs_to_port(const struct ofpact *ofpact, ofp_port_t port)
2010 switch (ofpact->type) {
2012 return ofpact_get_OUTPUT(ofpact)->port == port;
2013 case OFPACT_ENQUEUE:
2014 return ofpact_get_ENQUEUE(ofpact)->port == port;
2015 case OFPACT_CONTROLLER:
2016 return port == OFPP_CONTROLLER;
2018 case OFPACT_OUTPUT_REG:
2020 case OFPACT_SET_VLAN_VID:
2021 case OFPACT_SET_VLAN_PCP:
2022 case OFPACT_STRIP_VLAN:
2023 case OFPACT_PUSH_VLAN:
2024 case OFPACT_SET_ETH_SRC:
2025 case OFPACT_SET_ETH_DST:
2026 case OFPACT_SET_IPV4_SRC:
2027 case OFPACT_SET_IPV4_DST:
2028 case OFPACT_SET_IPV4_DSCP:
2029 case OFPACT_SET_L4_SRC_PORT:
2030 case OFPACT_SET_L4_DST_PORT:
2031 case OFPACT_REG_MOVE:
2032 case OFPACT_REG_LOAD:
2033 case OFPACT_STACK_PUSH:
2034 case OFPACT_STACK_POP:
2035 case OFPACT_DEC_TTL:
2036 case OFPACT_SET_MPLS_TTL:
2037 case OFPACT_DEC_MPLS_TTL:
2038 case OFPACT_SET_TUNNEL:
2039 case OFPACT_WRITE_METADATA:
2040 case OFPACT_SET_QUEUE:
2041 case OFPACT_POP_QUEUE:
2042 case OFPACT_FIN_TIMEOUT:
2043 case OFPACT_RESUBMIT:
2045 case OFPACT_MULTIPATH:
2048 case OFPACT_PUSH_MPLS:
2049 case OFPACT_POP_MPLS:
2051 case OFPACT_CLEAR_ACTIONS:
2052 case OFPACT_GOTO_TABLE:
2059 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
2060 * to 'port', false otherwise. */
2062 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
2065 const struct ofpact *a;
2067 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2068 if (ofpact_outputs_to_port(a, port)) {
2077 ofpacts_equal(const struct ofpact *a, size_t a_len,
2078 const struct ofpact *b, size_t b_len)
2080 return a_len == b_len && !memcmp(a, b, a_len);
2083 /* Formatting ofpacts. */
2086 print_note(const struct ofpact_note *note, struct ds *string)
2090 ds_put_cstr(string, "note:");
2091 for (i = 0; i < note->length; i++) {
2093 ds_put_char(string, '.');
2095 ds_put_format(string, "%02"PRIx8, note->data[i]);
2100 print_dec_ttl(const struct ofpact_cnt_ids *ids,
2105 ds_put_cstr(s, "dec_ttl");
2106 if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
2107 ds_put_cstr(s, "(");
2108 for (i = 0; i < ids->n_controllers; i++) {
2110 ds_put_cstr(s, ",");
2112 ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
2114 ds_put_cstr(s, ")");
2119 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
2122 ds_put_cstr(s, "fin_timeout(");
2123 if (fin_timeout->fin_idle_timeout) {
2124 ds_put_format(s, "idle_timeout=%"PRIu16",",
2125 fin_timeout->fin_idle_timeout);
2127 if (fin_timeout->fin_hard_timeout) {
2128 ds_put_format(s, "hard_timeout=%"PRIu16",",
2129 fin_timeout->fin_hard_timeout);
2132 ds_put_char(s, ')');
2136 ofpact_format(const struct ofpact *a, struct ds *s)
2138 const struct ofpact_enqueue *enqueue;
2139 const struct ofpact_resubmit *resubmit;
2140 const struct ofpact_controller *controller;
2141 const struct ofpact_metadata *metadata;
2142 const struct ofpact_tunnel *tunnel;
2143 const struct ofpact_sample *sample;
2148 port = ofpact_get_OUTPUT(a)->port;
2149 if (ofp_to_u16(port) < ofp_to_u16(OFPP_MAX)) {
2150 ds_put_format(s, "output:%"PRIu16, port);
2152 ofputil_format_port(port, s);
2153 if (port == OFPP_CONTROLLER) {
2154 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
2159 case OFPACT_CONTROLLER:
2160 controller = ofpact_get_CONTROLLER(a);
2161 if (controller->reason == OFPR_ACTION &&
2162 controller->controller_id == 0) {
2163 ds_put_format(s, "CONTROLLER:%"PRIu16,
2164 ofpact_get_CONTROLLER(a)->max_len);
2166 enum ofp_packet_in_reason reason = controller->reason;
2168 ds_put_cstr(s, "controller(");
2169 if (reason != OFPR_ACTION) {
2170 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
2172 ds_put_format(s, "reason=%s,",
2173 ofputil_packet_in_reason_to_string(
2174 reason, reasonbuf, sizeof reasonbuf));
2176 if (controller->max_len != UINT16_MAX) {
2177 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
2179 if (controller->controller_id != 0) {
2180 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
2183 ds_put_char(s, ')');
2187 case OFPACT_ENQUEUE:
2188 enqueue = ofpact_get_ENQUEUE(a);
2189 ds_put_format(s, "enqueue:");
2190 ofputil_format_port(enqueue->port, s);
2191 ds_put_format(s, "q%"PRIu32, enqueue->queue);
2194 case OFPACT_OUTPUT_REG:
2195 ds_put_cstr(s, "output:");
2196 mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
2200 bundle_format(ofpact_get_BUNDLE(a), s);
2203 case OFPACT_SET_VLAN_VID:
2204 ds_put_format(s, "mod_vlan_vid:%"PRIu16,
2205 ofpact_get_SET_VLAN_VID(a)->vlan_vid);
2208 case OFPACT_SET_VLAN_PCP:
2209 ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
2210 ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
2213 case OFPACT_STRIP_VLAN:
2214 ds_put_cstr(s, "strip_vlan");
2217 case OFPACT_PUSH_VLAN:
2218 /* XXX 802.1AD case*/
2219 ds_put_format(s, "push_vlan:%#"PRIx16, ETH_TYPE_VLAN_8021Q);
2222 case OFPACT_SET_ETH_SRC:
2223 ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
2224 ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
2227 case OFPACT_SET_ETH_DST:
2228 ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
2229 ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
2232 case OFPACT_SET_IPV4_SRC:
2233 ds_put_format(s, "mod_nw_src:"IP_FMT,
2234 IP_ARGS(ofpact_get_SET_IPV4_SRC(a)->ipv4));
2237 case OFPACT_SET_IPV4_DST:
2238 ds_put_format(s, "mod_nw_dst:"IP_FMT,
2239 IP_ARGS(ofpact_get_SET_IPV4_DST(a)->ipv4));
2242 case OFPACT_SET_IPV4_DSCP:
2243 ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
2246 case OFPACT_SET_L4_SRC_PORT:
2247 ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
2250 case OFPACT_SET_L4_DST_PORT:
2251 ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
2254 case OFPACT_REG_MOVE:
2255 nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
2258 case OFPACT_REG_LOAD:
2259 nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
2262 case OFPACT_STACK_PUSH:
2263 nxm_format_stack_push(ofpact_get_STACK_PUSH(a), s);
2266 case OFPACT_STACK_POP:
2267 nxm_format_stack_pop(ofpact_get_STACK_POP(a), s);
2270 case OFPACT_DEC_TTL:
2271 print_dec_ttl(ofpact_get_DEC_TTL(a), s);
2274 case OFPACT_SET_MPLS_TTL:
2275 ds_put_format(s, "set_mpls_ttl(%"PRIu8")",
2276 ofpact_get_SET_MPLS_TTL(a)->ttl);
2279 case OFPACT_DEC_MPLS_TTL:
2280 ds_put_cstr(s, "dec_mpls_ttl");
2283 case OFPACT_SET_TUNNEL:
2284 tunnel = ofpact_get_SET_TUNNEL(a);
2285 ds_put_format(s, "set_tunnel%s:%#"PRIx64,
2286 (tunnel->tun_id > UINT32_MAX
2287 || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
2291 case OFPACT_SET_QUEUE:
2292 ds_put_format(s, "set_queue:%"PRIu32,
2293 ofpact_get_SET_QUEUE(a)->queue_id);
2296 case OFPACT_POP_QUEUE:
2297 ds_put_cstr(s, "pop_queue");
2300 case OFPACT_FIN_TIMEOUT:
2301 print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
2304 case OFPACT_RESUBMIT:
2305 resubmit = ofpact_get_RESUBMIT(a);
2306 if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
2307 ds_put_cstr(s, "resubmit:");
2308 ofputil_format_port(resubmit->in_port, s);
2310 ds_put_format(s, "resubmit(");
2311 if (resubmit->in_port != OFPP_IN_PORT) {
2312 ofputil_format_port(resubmit->in_port, s);
2314 ds_put_char(s, ',');
2315 if (resubmit->table_id != 255) {
2316 ds_put_format(s, "%"PRIu8, resubmit->table_id);
2318 ds_put_char(s, ')');
2323 learn_format(ofpact_get_LEARN(a), s);
2326 case OFPACT_MULTIPATH:
2327 multipath_format(ofpact_get_MULTIPATH(a), s);
2331 print_note(ofpact_get_NOTE(a), s);
2334 case OFPACT_PUSH_MPLS:
2335 ds_put_format(s, "push_mpls:0x%04"PRIx16,
2336 ntohs(ofpact_get_PUSH_MPLS(a)->ethertype));
2339 case OFPACT_POP_MPLS:
2340 ds_put_format(s, "pop_mpls:0x%04"PRIx16,
2341 ntohs(ofpact_get_POP_MPLS(a)->ethertype));
2345 ds_put_cstr(s, "exit");
2349 sample = ofpact_get_SAMPLE(a);
2351 s, "sample(probability=%"PRIu16",collector_set_id=%"PRIu32
2352 ",obs_domain_id=%"PRIu32",obs_point_id=%"PRIu32")",
2353 sample->probability, sample->collector_set_id,
2354 sample->obs_domain_id, sample->obs_point_id);
2357 case OFPACT_CLEAR_ACTIONS:
2358 ds_put_format(s, "%s",
2359 ovs_instruction_name_from_type(
2360 OVSINST_OFPIT11_CLEAR_ACTIONS));
2363 case OFPACT_WRITE_METADATA:
2364 metadata = ofpact_get_WRITE_METADATA(a);
2365 ds_put_format(s, "%s:%#"PRIx64,
2366 ovs_instruction_name_from_type(
2367 OVSINST_OFPIT11_WRITE_METADATA),
2368 ntohll(metadata->metadata));
2369 if (metadata->mask != htonll(UINT64_MAX)) {
2370 ds_put_format(s, "/%#"PRIx64, ntohll(metadata->mask));
2374 case OFPACT_GOTO_TABLE:
2375 ds_put_format(s, "%s:%"PRIu8,
2376 ovs_instruction_name_from_type(
2377 OVSINST_OFPIT11_GOTO_TABLE),
2378 ofpact_get_GOTO_TABLE(a)->table_id);
2382 ds_put_format(s, "%s:%"PRIu32,
2383 ovs_instruction_name_from_type(OVSINST_OFPIT13_METER),
2384 ofpact_get_METER(a)->meter_id);
2389 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
2390 * 'ofpacts' to 'string'. */
2392 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
2395 ds_put_cstr(string, "actions=");
2397 ds_put_cstr(string, "drop");
2399 const struct ofpact *a;
2401 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2403 ds_put_cstr(string, ",");
2406 /* XXX write-actions */
2407 ofpact_format(a, string);
2412 /* Internal use by helpers. */
2415 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
2417 struct ofpact *ofpact;
2419 ofpact_pad(ofpacts);
2420 ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
2421 ofpact_init(ofpact, type, len);
2426 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
2428 memset(ofpact, 0, len);
2429 ofpact->type = type;
2430 ofpact->compat = OFPUTIL_ACTION_INVALID;
2434 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
2435 * starting at 'ofpact'.
2437 * This is the correct way to update a variable-length ofpact's length after
2438 * adding the variable-length part of the payload. (See the large comment
2439 * near the end of ofp-actions.h for more information.) */
2441 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
2443 ovs_assert(ofpact == ofpacts->l2);
2444 ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
2447 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length. Each
2448 * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
2449 * client must call this itself after adding the final ofpact to an array of
2452 * (The consequences of failing to call this function are probably not dire.
2453 * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
2454 * not dereference it. That's undefined behavior, technically, but it will not
2455 * cause a real problem on common systems. Still, it seems better to call
2458 ofpact_pad(struct ofpbuf *ofpacts)
2460 unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
2462 ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
2467 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
2470 load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
2471 load->dst.field = mf;
2473 load->dst.n_bits = mf->n_bits;
2474 bitwise_copy(src, mf->n_bytes, load->dst.ofs,
2475 &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);