2 * Copyright (c) 2012, 2013, 2014, 2015 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 #define OFP_ACTIONS_H 1
22 #include "meta-flow.h"
23 #include "ofp-errors.h"
25 #include "openflow/openflow.h"
26 #include "openflow/nicira-ext.h"
27 #include "openvswitch/types.h"
29 /* List of OVS abstracted actions.
31 * This macro is used directly only internally by this header, but the list is
32 * still of interest to developers.
34 * Each OFPACT invocation has the following parameters:
36 * 1. <ENUM>, used below in the enum definition of OFPACT_<ENUM>, and
39 * 2. <STRUCT> corresponding to a structure "struct <STRUCT>", that must be
40 * defined below. This structure must be an abstract definition of the
41 * action. Its first member must have type "struct ofpact" and name
42 * "ofpact". It may be fixed length or end with a flexible array member
43 * (e.g. "int member[];").
45 * 3. <MEMBER>, which has one of two possible values:
47 * - If "struct <STRUCT>" is fixed-length, it must be "ofpact".
49 * - If "struct <STRUCT>" is variable-length, it must be the name of the
50 * flexible array member.
52 * 4. <NAME>, a quoted string that gives the name of the action, for use in
53 * parsing actions from text.
57 OFPACT(OUTPUT, ofpact_output, ofpact, "output") \
58 OFPACT(GROUP, ofpact_group, ofpact, "group") \
59 OFPACT(CONTROLLER, ofpact_controller, ofpact, "controller") \
60 OFPACT(ENQUEUE, ofpact_enqueue, ofpact, "enqueue") \
61 OFPACT(OUTPUT_REG, ofpact_output_reg, ofpact, "output_reg") \
62 OFPACT(BUNDLE, ofpact_bundle, slaves, "bundle") \
64 /* Header changes. */ \
65 OFPACT(SET_FIELD, ofpact_set_field, ofpact, "set_field") \
66 OFPACT(SET_VLAN_VID, ofpact_vlan_vid, ofpact, "set_vlan_vid") \
67 OFPACT(SET_VLAN_PCP, ofpact_vlan_pcp, ofpact, "set_vlan_pcp") \
68 OFPACT(STRIP_VLAN, ofpact_null, ofpact, "strip_vlan") \
69 OFPACT(PUSH_VLAN, ofpact_null, ofpact, "push_vlan") \
70 OFPACT(SET_ETH_SRC, ofpact_mac, ofpact, "mod_dl_src") \
71 OFPACT(SET_ETH_DST, ofpact_mac, ofpact, "mod_dl_dst") \
72 OFPACT(SET_IPV4_SRC, ofpact_ipv4, ofpact, "mod_nw_src") \
73 OFPACT(SET_IPV4_DST, ofpact_ipv4, ofpact, "mod_nw_dst") \
74 OFPACT(SET_IP_DSCP, ofpact_dscp, ofpact, "mod_nw_tos") \
75 OFPACT(SET_IP_ECN, ofpact_ecn, ofpact, "mod_nw_ecn") \
76 OFPACT(SET_IP_TTL, ofpact_ip_ttl, ofpact, "mod_nw_ttl") \
77 OFPACT(SET_L4_SRC_PORT, ofpact_l4_port, ofpact, "mod_tp_src") \
78 OFPACT(SET_L4_DST_PORT, ofpact_l4_port, ofpact, "mod_tp_dst") \
79 OFPACT(REG_MOVE, ofpact_reg_move, ofpact, "move") \
80 OFPACT(STACK_PUSH, ofpact_stack, ofpact, "push") \
81 OFPACT(STACK_POP, ofpact_stack, ofpact, "pop") \
82 OFPACT(DEC_TTL, ofpact_cnt_ids, cnt_ids, "dec_ttl") \
83 OFPACT(SET_MPLS_LABEL, ofpact_mpls_label, ofpact, "set_mpls_label") \
84 OFPACT(SET_MPLS_TC, ofpact_mpls_tc, ofpact, "set_mpls_tc") \
85 OFPACT(SET_MPLS_TTL, ofpact_mpls_ttl, ofpact, "set_mpls_ttl") \
86 OFPACT(DEC_MPLS_TTL, ofpact_null, ofpact, "dec_mpls_ttl") \
87 OFPACT(PUSH_MPLS, ofpact_push_mpls, ofpact, "push_mpls") \
88 OFPACT(POP_MPLS, ofpact_pop_mpls, ofpact, "pop_mpls") \
91 OFPACT(SET_TUNNEL, ofpact_tunnel, ofpact, "set_tunnel") \
92 OFPACT(SET_QUEUE, ofpact_queue, ofpact, "set_queue") \
93 OFPACT(POP_QUEUE, ofpact_null, ofpact, "pop_queue") \
94 OFPACT(FIN_TIMEOUT, ofpact_fin_timeout, ofpact, "fin_timeout") \
96 /* Flow table interaction. */ \
97 OFPACT(RESUBMIT, ofpact_resubmit, ofpact, "resubmit") \
98 OFPACT(LEARN, ofpact_learn, specs, "learn") \
99 OFPACT(CONJUNCTION, ofpact_conjunction, ofpact, "conjunction") \
102 OFPACT(MULTIPATH, ofpact_multipath, ofpact, "multipath") \
105 OFPACT(NOTE, ofpact_note, data, "note") \
106 OFPACT(EXIT, ofpact_null, ofpact, "exit") \
107 OFPACT(SAMPLE, ofpact_sample, ofpact, "sample") \
109 /* Instructions. */ \
110 OFPACT(METER, ofpact_meter, ofpact, "meter") \
111 OFPACT(CLEAR_ACTIONS, ofpact_null, ofpact, "clear_actions") \
112 OFPACT(WRITE_ACTIONS, ofpact_nest, ofpact, "write_actions") \
113 OFPACT(WRITE_METADATA, ofpact_metadata, ofpact, "write_metadata") \
114 OFPACT(GOTO_TABLE, ofpact_goto_table, ofpact, "goto_table")
116 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
117 enum OVS_PACKED_ENUM ofpact_type {
118 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) OFPACT_##ENUM,
123 /* Define N_OFPACTS to the number of types of ofpacts. */
125 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) + 1
130 /* Header for an action.
132 * Each action is a structure "struct ofpact_*" that begins with "struct
133 * ofpact", usually followed by other data that describes the action. Actions
134 * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
136 * The 'raw' member is special:
138 * - Most "struct ofpact"s correspond to one particular kind of OpenFlow
139 * action, at least in a given OpenFlow version. For example,
140 * OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
143 * For such actions, the 'raw' member is not meaningful and generally
146 * - A few "struct ofpact"s correspond to multiple OpenFlow actions. For
147 * example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
148 * NXAST_SET_TUNNEL64. In these cases, if the "struct ofpact" originated
149 * from OpenFlow, then we want to make sure that, if it gets translated
150 * back to OpenFlow later, it is translated back to the same action type.
151 * (Otherwise, we'd violate the promise made in DESIGN, in the "Action
152 * Reproduction" section.)
154 * For such actions, the 'raw' member should be the "enum ofp_raw_action"
155 * originally extracted from the OpenFlow action. (If the action didn't
156 * originate from OpenFlow, then setting 'raw' to zero should be fine:
157 * code to translate the ofpact to OpenFlow must tolerate this case.)
160 /* We want the space advantage of an 8-bit type here on every
161 * implementation, without giving up the advantage of having a useful type
162 * on implementations that support packed enums. */
163 #ifdef HAVE_PACKED_ENUM
164 enum ofpact_type type; /* OFPACT_*. */
166 uint8_t type; /* OFPACT_* */
169 uint8_t raw; /* Original type when added, if any. */
170 uint16_t len; /* Length of the action, in bytes, including
171 * struct ofpact, excluding padding. */
173 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
176 #define OFPACT_ALIGNTO 8
177 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
179 static inline struct ofpact *
180 ofpact_next(const struct ofpact *ofpact)
182 return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
185 static inline struct ofpact *
186 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
188 return (void *) ((uint8_t *) ofpacts + ofpacts_len);
191 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
192 * starting at OFPACTS. */
193 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN) \
194 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
195 (POS) = ofpact_next(POS))
197 /* Action structure for each OFPACT_*. */
199 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
201 * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
202 * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
204 * Action structure for actions that do not have any extra data beyond the
207 struct ofpact ofpact;
212 * Used for OFPAT10_OUTPUT. */
213 struct ofpact_output {
214 struct ofpact ofpact;
215 ofp_port_t port; /* Output port. */
216 uint16_t max_len; /* Max send len, for port OFPP_CONTROLLER. */
219 /* OFPACT_CONTROLLER.
221 * Used for NXAST_CONTROLLER. */
222 struct ofpact_controller {
223 struct ofpact ofpact;
224 uint16_t max_len; /* Maximum length to send to controller. */
225 uint16_t controller_id; /* Controller ID to send packet-in. */
226 enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
231 * Used for OFPAT10_ENQUEUE. */
232 struct ofpact_enqueue {
233 struct ofpact ofpact;
238 /* OFPACT_OUTPUT_REG.
240 * Used for NXAST_OUTPUT_REG. */
241 struct ofpact_output_reg {
242 struct ofpact ofpact;
244 struct mf_subfield src;
247 /* Bundle slave choice algorithm to apply.
249 * In the descriptions below, 'slaves' is the list of possible slaves in the
250 * order they appear in the OpenFlow action. */
251 enum nx_bd_algorithm {
252 /* Chooses the first live slave listed in the bundle.
254 * O(n_slaves) performance. */
255 NX_BD_ALG_ACTIVE_BACKUP = 0,
257 /* Highest Random Weight.
259 * for i in [0,n_slaves):
260 * weights[i] = hash(flow, i)
261 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
263 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
264 * O(n_slaves) performance.
266 * Uses the 'fields' and 'basis' parameters. */
272 * Used for NXAST_BUNDLE. */
273 struct ofpact_bundle {
274 struct ofpact ofpact;
276 /* Slave choice algorithm to apply to hash value. */
277 enum nx_bd_algorithm algorithm;
279 /* What fields to hash and how. */
280 enum nx_hash_fields fields;
281 uint16_t basis; /* Universal hash parameter. */
283 struct mf_subfield dst;
285 /* Slaves for output. */
286 unsigned int n_slaves;
290 /* OFPACT_SET_VLAN_VID.
292 * We keep track if vlan was present at action validation time to avoid a
293 * PUSH_VLAN when translating to OpenFlow 1.1+.
295 * We also keep the originating OFPUTIL action code in ofpact.compat.
297 * Used for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
298 struct ofpact_vlan_vid {
299 struct ofpact ofpact;
300 uint16_t vlan_vid; /* VLAN VID in low 12 bits, 0 in other bits. */
301 bool push_vlan_if_needed; /* OF 1.0 semantics if true. */
302 bool flow_has_vlan; /* VLAN present at action validation time? */
305 /* OFPACT_SET_VLAN_PCP.
307 * We keep track if vlan was present at action validation time to avoid a
308 * PUSH_VLAN when translating to OpenFlow 1.1+.
310 * We also keep the originating OFPUTIL action code in ofpact.compat.
312 * Used for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
313 struct ofpact_vlan_pcp {
314 struct ofpact ofpact;
315 uint8_t vlan_pcp; /* VLAN PCP in low 3 bits, 0 in other bits. */
316 bool push_vlan_if_needed; /* OF 1.0 semantics if true. */
317 bool flow_has_vlan; /* VLAN present at action validation time? */
320 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
322 * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
324 struct ofpact ofpact;
325 uint8_t mac[ETH_ADDR_LEN];
328 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
330 * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
332 struct ofpact ofpact;
336 /* OFPACT_SET_IP_DSCP.
338 * Used for OFPAT10_SET_NW_TOS. */
340 struct ofpact ofpact;
341 uint8_t dscp; /* DSCP in high 6 bits, rest ignored. */
344 /* OFPACT_SET_IP_ECN.
346 * Used for OFPAT11_SET_NW_ECN. */
348 struct ofpact ofpact;
349 uint8_t ecn; /* ECN in low 2 bits, rest ignored. */
352 /* OFPACT_SET_IP_TTL.
354 * Used for OFPAT11_SET_NW_TTL. */
355 struct ofpact_ip_ttl {
356 struct ofpact ofpact;
360 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
362 * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
363 struct ofpact_l4_port {
364 struct ofpact ofpact;
365 uint16_t port; /* TCP, UDP or SCTP port number. */
366 uint8_t flow_ip_proto; /* IP proto from corresponding match, or 0 */
371 * Used for NXAST_REG_MOVE. */
372 struct ofpact_reg_move {
373 struct ofpact ofpact;
374 struct mf_subfield src;
375 struct mf_subfield dst;
378 /* OFPACT_STACK_PUSH.
380 * Used for NXAST_STACK_PUSH and NXAST_STACK_POP. */
381 struct ofpact_stack {
382 struct ofpact ofpact;
383 struct mf_subfield subfield;
388 * Used for NXAST_REG_LOAD and OFPAT12_SET_FIELD. */
389 struct ofpact_set_field {
390 struct ofpact ofpact;
391 const struct mf_field *field;
392 bool flow_has_vlan; /* VLAN present at action validation time. */
393 union mf_value value;
397 /* OFPACT_PUSH_VLAN/MPLS/PBB
399 * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
400 struct ofpact_push_mpls {
401 struct ofpact ofpact;
407 * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
408 struct ofpact_pop_mpls {
409 struct ofpact ofpact;
413 /* OFPACT_SET_TUNNEL.
415 * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
416 struct ofpact_tunnel {
417 struct ofpact ofpact;
423 * Used for NXAST_SET_QUEUE. */
424 struct ofpact_queue {
425 struct ofpact ofpact;
429 /* OFPACT_FIN_TIMEOUT.
431 * Used for NXAST_FIN_TIMEOUT. */
432 struct ofpact_fin_timeout {
433 struct ofpact ofpact;
434 uint16_t fin_idle_timeout;
435 uint16_t fin_hard_timeout;
438 /* OFPACT_WRITE_METADATA.
440 * Used for NXAST_WRITE_METADATA. */
441 struct ofpact_metadata {
442 struct ofpact ofpact;
449 * Used for OFPIT13_METER. */
450 struct ofpact_meter {
451 struct ofpact ofpact;
455 /* OFPACT_WRITE_ACTIONS.
457 * Used for OFPIT11_WRITE_ACTIONS. */
459 struct ofpact ofpact;
460 uint8_t pad[PAD_SIZE(sizeof(struct ofpact), OFPACT_ALIGNTO)];
461 struct ofpact actions[];
463 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions) % OFPACT_ALIGNTO == 0);
464 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions)
465 == sizeof(struct ofpact_nest));
468 ofpact_nest_get_action_len(const struct ofpact_nest *on)
470 return on->ofpact.len - offsetof(struct ofpact_nest, actions);
473 void ofpacts_execute_action_set(struct ofpbuf *action_list,
474 const struct ofpbuf *action_set);
478 * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
479 struct ofpact_resubmit {
480 struct ofpact ofpact;
485 /* Part of struct ofpact_learn, below. */
486 struct ofpact_learn_spec {
487 int n_bits; /* Number of bits in source and dest. */
489 int src_type; /* One of NX_LEARN_SRC_*. */
490 struct mf_subfield src; /* NX_LEARN_SRC_FIELD only. */
491 union mf_subvalue src_imm; /* NX_LEARN_SRC_IMMEDIATE only. */
493 int dst_type; /* One of NX_LEARN_DST_*. */
494 struct mf_subfield dst; /* NX_LEARN_DST_MATCH, NX_LEARN_DST_LOAD only. */
498 /* Bits for 'flags' in struct nx_action_learn.
500 * If NX_LEARN_F_SEND_FLOW_REM is set, then the learned flows will have their
501 * OFPFF_SEND_FLOW_REM flag set.
503 * If NX_LEARN_F_DELETE_LEARNED is set, then removing this action will delete
504 * all the flows from the learn action's 'table_id' that have the learn
505 * action's 'cookie'. Important points:
507 * - The deleted flows include those created by this action, those created
508 * by other learn actions with the same 'table_id' and 'cookie', those
509 * created by flow_mod requests by a controller in the specified table
510 * with the specified cookie, and those created through any other
513 * - If multiple flows specify "learn" actions with
514 * NX_LEARN_F_DELETE_LEARNED with the same 'table_id' and 'cookie', then
515 * no deletion occurs until all of those "learn" actions are deleted.
517 * - Deleting a flow that contains a learn action is the most obvious way
518 * to delete a learn action. Modifying a flow's actions, or replacing it
519 * by a new flow, can also delete a learn action. Finally, replacing a
520 * learn action with NX_LEARN_F_DELETE_LEARNED with a learn action
521 * without that flag also effectively deletes the learn action and can
522 * trigger flow deletion.
524 * NX_LEARN_F_DELETE_LEARNED was added in Open vSwitch 2.4. */
525 enum nx_learn_flags {
526 NX_LEARN_F_SEND_FLOW_REM = 1 << 0,
527 NX_LEARN_F_DELETE_LEARNED = 1 << 1,
530 #define NX_LEARN_N_BITS_MASK 0x3ff
532 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
533 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
534 #define NX_LEARN_SRC_MASK (1 << 13)
536 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
537 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
538 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
539 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
540 #define NX_LEARN_DST_MASK (3 << 11)
544 * Used for NXAST_LEARN. */
545 struct ofpact_learn {
546 struct ofpact ofpact;
548 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
549 uint16_t hard_timeout; /* Max time before discarding (seconds). */
550 uint16_t priority; /* Priority level of flow entry. */
551 uint8_t table_id; /* Table to insert flow entry. */
552 ovs_be64 cookie; /* Cookie for new flow. */
553 enum nx_learn_flags flags; /* NX_LEARN_F_*. */
554 uint16_t fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
555 uint16_t fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
557 unsigned int n_specs;
558 struct ofpact_learn_spec specs[];
561 /* Multipath link choice algorithm to apply.
563 * In the descriptions below, 'n_links' is max_link + 1. */
564 enum nx_mp_algorithm {
565 /* link = hash(flow) % n_links.
567 * Redistributes all traffic when n_links changes. O(1) performance. See
570 * Use UINT16_MAX for max_link to get a raw hash value. */
571 NX_MP_ALG_MODULO_N = 0,
573 /* link = hash(flow) / (MAX_HASH / n_links).
575 * Redistributes between one-quarter and one-half of traffic when n_links
576 * changes. O(1) performance. See RFC 2992.
578 NX_MP_ALG_HASH_THRESHOLD = 1,
580 /* Highest Random Weight.
582 * for i in [0,n_links):
583 * weights[i] = hash(flow, i)
584 * link = { i such that weights[i] >= weights[j] for all j != i }
586 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
587 * performance. If n_links is greater than a threshold (currently 64, but
588 * subject to change), Open vSwitch will substitute another algorithm
589 * automatically. See RFC 2992. */
597 * link = hash(flow, i) % arg
598 * while link > max_link
600 * Redistributes 1/n_links of traffic when n_links changes. O(1)
601 * performance when arg/max_link is bounded by a constant.
603 * Redistributes all traffic when arg changes.
605 * arg must be greater than max_link and for best performance should be no
606 * more than approximately max_link * 2. If arg is outside the acceptable
607 * range, Open vSwitch will automatically substitute the least power of 2
608 * greater than max_link.
610 * This algorithm is specific to Open vSwitch.
612 NX_MP_ALG_ITER_HASH = 3,
615 /* OFPACT_CONJUNCTION.
617 * Used for NXAST_CONJUNCTION. */
618 struct ofpact_conjunction {
619 struct ofpact ofpact;
627 * Used for NXAST_MULTIPATH. */
628 struct ofpact_multipath {
629 struct ofpact ofpact;
631 /* What fields to hash and how. */
632 enum nx_hash_fields fields;
633 uint16_t basis; /* Universal hash parameter. */
635 /* Multipath link choice algorithm to apply to hash value. */
636 enum nx_mp_algorithm algorithm;
637 uint16_t max_link; /* Number of output links, minus 1. */
638 uint32_t arg; /* Algorithm-specific argument. */
640 /* Where to store the result. */
641 struct mf_subfield dst;
646 * Used for NXAST_NOTE. */
648 struct ofpact ofpact;
655 * Used for NXAST_SAMPLE. */
656 struct ofpact_sample {
657 struct ofpact ofpact;
658 uint16_t probability; // Always >0.
659 uint32_t collector_set_id;
660 uint32_t obs_domain_id;
661 uint32_t obs_point_id;
666 * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
667 struct ofpact_cnt_ids {
668 struct ofpact ofpact;
670 /* Controller ids. */
671 unsigned int n_controllers;
675 /* OFPACT_SET_MPLS_LABEL.
677 * Used for OFPAT11_SET_MPLS_LABEL and NXAST_SET_MPLS_LABEL */
678 struct ofpact_mpls_label {
679 struct ofpact ofpact;
684 /* OFPACT_SET_MPLS_TC.
686 * Used for OFPAT11_SET_MPLS_TC and NXAST_SET_MPLS_TC */
687 struct ofpact_mpls_tc {
688 struct ofpact ofpact;
693 /* OFPACT_SET_MPLS_TTL.
695 * Used for OFPAT11_SET_MPLS_TTL and NXAST_SET_MPLS_TTL */
696 struct ofpact_mpls_ttl {
697 struct ofpact ofpact;
704 * Used for OFPIT11_GOTO_TABLE */
705 struct ofpact_goto_table {
706 struct ofpact ofpact;
712 * Used for OFPAT11_GROUP. */
713 struct ofpact_group {
714 struct ofpact ofpact;
718 /* Converting OpenFlow to ofpacts. */
719 enum ofperr ofpacts_pull_openflow_actions(struct ofpbuf *openflow,
720 unsigned int actions_len,
721 enum ofp_version version,
722 struct ofpbuf *ofpacts);
723 enum ofperr ofpacts_pull_openflow_instructions(struct ofpbuf *openflow,
724 unsigned int instructions_len,
725 enum ofp_version version,
726 struct ofpbuf *ofpacts);
727 enum ofperr ofpacts_check(struct ofpact[], size_t ofpacts_len,
728 struct flow *, ofp_port_t max_ports,
729 uint8_t table_id, uint8_t n_tables,
730 enum ofputil_protocol *usable_protocols);
731 enum ofperr ofpacts_check_consistency(struct ofpact[], size_t ofpacts_len,
732 struct flow *, ofp_port_t max_ports,
733 uint8_t table_id, uint8_t n_tables,
734 enum ofputil_protocol usable_protocols);
735 enum ofperr ofpact_check_output_port(ofp_port_t port, ofp_port_t max_ports);
737 /* Converting ofpacts to OpenFlow. */
738 size_t ofpacts_put_openflow_actions(const struct ofpact[], size_t ofpacts_len,
739 struct ofpbuf *openflow, enum ofp_version);
740 void ofpacts_put_openflow_instructions(const struct ofpact[],
742 struct ofpbuf *openflow,
743 enum ofp_version ofp_version);
745 /* Sets of supported actions. */
746 ovs_be32 ofpact_bitmap_to_openflow(uint64_t ofpacts_bitmap, enum ofp_version);
747 uint64_t ofpact_bitmap_from_openflow(ovs_be32 ofpat_bitmap, enum ofp_version);
748 void ofpact_bitmap_format(uint64_t ofpacts_bitmap, struct ds *);
750 /* Working with ofpacts. */
751 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
753 bool ofpacts_output_to_group(const struct ofpact[], size_t ofpacts_len,
755 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
756 const struct ofpact b[], size_t b_len);
757 uint32_t ofpacts_get_meter(const struct ofpact[], size_t ofpacts_len);
759 /* Formatting and parsing ofpacts. */
760 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
761 char *ofpacts_parse_actions(const char *, struct ofpbuf *ofpacts,
762 enum ofputil_protocol *usable_protocols)
763 OVS_WARN_UNUSED_RESULT;
764 char *ofpacts_parse_instructions(const char *, struct ofpbuf *ofpacts,
765 enum ofputil_protocol *usable_protocols)
766 OVS_WARN_UNUSED_RESULT;
767 const char *ofpact_name(enum ofpact_type);
769 /* Internal use by the helpers below. */
770 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
771 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
773 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
774 * the following commonly useful functions:
776 * struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
778 * Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
779 * initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
780 * 'ofpacts->l2' to the returned action.
782 * After using this function to add a variable-length action, add the
783 * elements of the flexible array (e.g. with ofpbuf_put()), then use
784 * ofpact_update_len() to update the length embedded into the action.
785 * (Keep in mind the need to refresh the structure from 'ofpacts->frame'
786 * after adding data to 'ofpacts'.)
788 * struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
790 * Returns 'ofpact' cast to "struct <STRUCT> *". 'ofpact->type' must be
793 * as well as the following more rarely useful definitions:
795 * void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
797 * Initializes the parts of 'ofpact' that identify it as having type
798 * OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
802 * The size of the action structure. For a fixed-length action, this is
803 * sizeof(struct <STRUCT>). For a variable-length action, this is the
804 * offset to the variable-length part.
808 * An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
809 * multiple of OFPACT_ALIGNTO.
811 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
812 BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
814 enum { OFPACT_##ENUM##_RAW_SIZE \
815 = (offsetof(struct STRUCT, MEMBER) \
816 ? offsetof(struct STRUCT, MEMBER) \
817 : sizeof(struct STRUCT)) }; \
819 enum { OFPACT_##ENUM##_SIZE \
820 = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) }; \
822 static inline struct STRUCT * \
823 ofpact_get_##ENUM(const struct ofpact *ofpact) \
825 ovs_assert(ofpact->type == OFPACT_##ENUM); \
826 return ALIGNED_CAST(struct STRUCT *, ofpact); \
829 static inline struct STRUCT * \
830 ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
832 return ofpact_put(ofpacts, OFPACT_##ENUM, \
833 OFPACT_##ENUM##_RAW_SIZE); \
837 ofpact_init_##ENUM(struct STRUCT *ofpact) \
839 ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
840 OFPACT_##ENUM##_RAW_SIZE); \
845 /* Functions to use after adding ofpacts to a buffer. */
846 void ofpact_update_len(struct ofpbuf *, struct ofpact *);
847 void ofpact_pad(struct ofpbuf *);
849 /* Additional functions for composing ofpacts. */
850 struct ofpact_set_field *ofpact_put_reg_load(struct ofpbuf *ofpacts);
852 /* OpenFlow 1.1 instructions.
853 * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
854 * It is enforced on parser from text string.
856 #define OVS_INSTRUCTIONS \
857 DEFINE_INST(OFPIT13_METER, \
858 ofp13_instruction_meter, false, \
861 DEFINE_INST(OFPIT11_APPLY_ACTIONS, \
862 ofp11_instruction_actions, true, \
865 DEFINE_INST(OFPIT11_CLEAR_ACTIONS, \
866 ofp11_instruction, false, \
869 DEFINE_INST(OFPIT11_WRITE_ACTIONS, \
870 ofp11_instruction_actions, true, \
873 DEFINE_INST(OFPIT11_WRITE_METADATA, \
874 ofp11_instruction_write_metadata, false, \
877 DEFINE_INST(OFPIT11_GOTO_TABLE, \
878 ofp11_instruction_goto_table, false, \
881 enum ovs_instruction_type {
882 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
888 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
889 N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
893 const char *ovs_instruction_name_from_type(enum ovs_instruction_type type);
894 int ovs_instruction_type_from_name(const char *name);
895 enum ovs_instruction_type ovs_instruction_type_from_ofpact_type(
897 enum ofperr ovs_instruction_type_from_inst_type(
898 enum ovs_instruction_type *instruction_type, const uint16_t inst_type);
900 ovs_be32 ovsinst_bitmap_to_openflow(uint32_t ovsinst_bitmap, enum ofp_version);
901 uint32_t ovsinst_bitmap_from_openflow(ovs_be32 ofpit_bitmap,
904 #endif /* ofp-actions.h */