2 * Copyright (c) 2012, 2013, 2014, 2015, 2016 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, userdata, "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") \
108 OFPACT(UNROLL_XLATE, ofpact_unroll_xlate, ofpact, "unroll_xlate") \
109 OFPACT(CT, ofpact_conntrack, ofpact, "ct") \
110 OFPACT(NAT, ofpact_nat, ofpact, "nat") \
112 /* Debugging actions. \
114 * These are intentionally undocumented, subject to change, and \
115 * only accepted if ovs-vswitchd is started with --enable-dummy. */ \
116 OFPACT(DEBUG_RECIRC, ofpact_null, ofpact, "debug_recirc") \
118 /* Instructions. */ \
119 OFPACT(METER, ofpact_meter, ofpact, "meter") \
120 OFPACT(CLEAR_ACTIONS, ofpact_null, ofpact, "clear_actions") \
121 OFPACT(WRITE_ACTIONS, ofpact_nest, ofpact, "write_actions") \
122 OFPACT(WRITE_METADATA, ofpact_metadata, ofpact, "write_metadata") \
123 OFPACT(GOTO_TABLE, ofpact_goto_table, ofpact, "goto_table")
125 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
126 enum OVS_PACKED_ENUM ofpact_type {
127 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) OFPACT_##ENUM,
132 /* Define N_OFPACTS to the number of types of ofpacts. */
134 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) + 1
139 /* Header for an action.
141 * Each action is a structure "struct ofpact_*" that begins with "struct
142 * ofpact", usually followed by other data that describes the action. Actions
143 * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
145 * The 'raw' member is special:
147 * - Most "struct ofpact"s correspond to one particular kind of OpenFlow
148 * action, at least in a given OpenFlow version. For example,
149 * OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
152 * For such actions, the 'raw' member is not meaningful and generally
155 * - A few "struct ofpact"s correspond to multiple OpenFlow actions. For
156 * example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
157 * NXAST_SET_TUNNEL64. In these cases, if the "struct ofpact" originated
158 * from OpenFlow, then we want to make sure that, if it gets translated
159 * back to OpenFlow later, it is translated back to the same action type.
160 * (Otherwise, we'd violate the promise made in DESIGN, in the "Action
161 * Reproduction" section.)
163 * For such actions, the 'raw' member should be the "enum ofp_raw_action"
164 * originally extracted from the OpenFlow action. (If the action didn't
165 * originate from OpenFlow, then setting 'raw' to zero should be fine:
166 * code to translate the ofpact to OpenFlow must tolerate this case.)
169 /* We want the space advantage of an 8-bit type here on every
170 * implementation, without giving up the advantage of having a useful type
171 * on implementations that support packed enums. */
172 #ifdef HAVE_PACKED_ENUM
173 enum ofpact_type type; /* OFPACT_*. */
175 uint8_t type; /* OFPACT_* */
178 uint8_t raw; /* Original type when added, if any. */
179 uint16_t len; /* Length of the action, in bytes, including
180 * struct ofpact, excluding padding. */
182 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
185 #define OFPACT_ALIGNTO 8
186 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
188 /* Returns the ofpact following 'ofpact'. */
189 static inline struct ofpact *
190 ofpact_next(const struct ofpact *ofpact)
192 return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
195 struct ofpact *ofpact_next_flattened(const struct ofpact *);
197 static inline struct ofpact *
198 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
200 return (void *) ((uint8_t *) ofpacts + ofpacts_len);
203 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
204 * starting at OFPACTS. */
205 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN) \
206 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
207 (POS) = ofpact_next(POS))
209 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
210 * starting at OFPACTS.
212 * For ofpacts that contain nested ofpacts, this visits each of the inner
213 * ofpacts as well. */
214 #define OFPACT_FOR_EACH_FLATTENED(POS, OFPACTS, OFPACTS_LEN) \
215 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
216 (POS) = ofpact_next_flattened(POS))
218 /* Action structure for each OFPACT_*. */
220 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
222 * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
223 * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
225 * Action structure for actions that do not have any extra data beyond the
228 struct ofpact ofpact;
233 * Used for OFPAT10_OUTPUT. */
234 struct ofpact_output {
235 struct ofpact ofpact;
236 ofp_port_t port; /* Output port. */
237 uint16_t max_len; /* Max send len, for port OFPP_CONTROLLER. */
240 /* OFPACT_CONTROLLER.
242 * Used for NXAST_CONTROLLER. */
243 struct ofpact_controller {
244 struct ofpact ofpact;
245 uint16_t max_len; /* Maximum length to send to controller. */
246 uint16_t controller_id; /* Controller ID to send packet-in. */
247 enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
249 /* If true, this action freezes packet traversal of the OpenFlow tables and
250 * adds a continuation to the packet-in message, that a controller can use
251 * to resume that traversal. */
254 /* Arbitrary data to include in the packet-in message (currently, only in
255 * NXT_PACKET_IN2). */
256 uint16_t userdata_len;
262 * Used for OFPAT10_ENQUEUE. */
263 struct ofpact_enqueue {
264 struct ofpact ofpact;
269 /* OFPACT_OUTPUT_REG.
271 * Used for NXAST_OUTPUT_REG. */
272 struct ofpact_output_reg {
273 struct ofpact ofpact;
275 struct mf_subfield src;
278 /* Bundle slave choice algorithm to apply.
280 * In the descriptions below, 'slaves' is the list of possible slaves in the
281 * order they appear in the OpenFlow action. */
282 enum nx_bd_algorithm {
283 /* Chooses the first live slave listed in the bundle.
285 * O(n_slaves) performance. */
286 NX_BD_ALG_ACTIVE_BACKUP = 0,
288 /* Highest Random Weight.
290 * for i in [0,n_slaves):
291 * weights[i] = hash(flow, i)
292 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
294 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
295 * O(n_slaves) performance.
297 * Uses the 'fields' and 'basis' parameters. */
303 * Used for NXAST_BUNDLE. */
304 struct ofpact_bundle {
305 struct ofpact ofpact;
307 /* Slave choice algorithm to apply to hash value. */
308 enum nx_bd_algorithm algorithm;
310 /* What fields to hash and how. */
311 enum nx_hash_fields fields;
312 uint16_t basis; /* Universal hash parameter. */
314 struct mf_subfield dst;
316 /* Slaves for output. */
317 unsigned int n_slaves;
321 /* OFPACT_SET_VLAN_VID.
323 * We keep track if vlan was present at action validation time to avoid a
324 * PUSH_VLAN when translating to OpenFlow 1.1+.
326 * We also keep the originating OFPUTIL action code in ofpact.compat.
328 * Used for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
329 struct ofpact_vlan_vid {
330 struct ofpact ofpact;
331 uint16_t vlan_vid; /* VLAN VID in low 12 bits, 0 in other bits. */
332 bool push_vlan_if_needed; /* OF 1.0 semantics if true. */
333 bool flow_has_vlan; /* VLAN present at action validation time? */
336 /* OFPACT_SET_VLAN_PCP.
338 * We keep track if vlan was present at action validation time to avoid a
339 * PUSH_VLAN when translating to OpenFlow 1.1+.
341 * We also keep the originating OFPUTIL action code in ofpact.compat.
343 * Used for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
344 struct ofpact_vlan_pcp {
345 struct ofpact ofpact;
346 uint8_t vlan_pcp; /* VLAN PCP in low 3 bits, 0 in other bits. */
347 bool push_vlan_if_needed; /* OF 1.0 semantics if true. */
348 bool flow_has_vlan; /* VLAN present at action validation time? */
351 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
353 * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
355 struct ofpact ofpact;
359 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
361 * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
363 struct ofpact ofpact;
367 /* OFPACT_SET_IP_DSCP.
369 * Used for OFPAT10_SET_NW_TOS. */
371 struct ofpact ofpact;
372 uint8_t dscp; /* DSCP in high 6 bits, rest ignored. */
375 /* OFPACT_SET_IP_ECN.
377 * Used for OFPAT11_SET_NW_ECN. */
379 struct ofpact ofpact;
380 uint8_t ecn; /* ECN in low 2 bits, rest ignored. */
383 /* OFPACT_SET_IP_TTL.
385 * Used for OFPAT11_SET_NW_TTL. */
386 struct ofpact_ip_ttl {
387 struct ofpact ofpact;
391 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
393 * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
394 struct ofpact_l4_port {
395 struct ofpact ofpact;
396 uint16_t port; /* TCP, UDP or SCTP port number. */
397 uint8_t flow_ip_proto; /* IP proto from corresponding match, or 0 */
402 * Used for NXAST_REG_MOVE. */
403 struct ofpact_reg_move {
404 struct ofpact ofpact;
405 struct mf_subfield src;
406 struct mf_subfield dst;
409 /* OFPACT_STACK_PUSH.
411 * Used for NXAST_STACK_PUSH and NXAST_STACK_POP. */
412 struct ofpact_stack {
413 struct ofpact ofpact;
414 struct mf_subfield subfield;
419 * Used for NXAST_REG_LOAD and OFPAT12_SET_FIELD. */
420 struct ofpact_set_field {
421 struct ofpact ofpact;
422 const struct mf_field *field;
423 bool flow_has_vlan; /* VLAN present at action validation time. */
424 union mf_value value;
428 /* OFPACT_PUSH_VLAN/MPLS/PBB
430 * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
431 struct ofpact_push_mpls {
432 struct ofpact ofpact;
438 * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
439 struct ofpact_pop_mpls {
440 struct ofpact ofpact;
444 /* OFPACT_SET_TUNNEL.
446 * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
447 struct ofpact_tunnel {
448 struct ofpact ofpact;
454 * Used for NXAST_SET_QUEUE. */
455 struct ofpact_queue {
456 struct ofpact ofpact;
460 /* OFPACT_FIN_TIMEOUT.
462 * Used for NXAST_FIN_TIMEOUT. */
463 struct ofpact_fin_timeout {
464 struct ofpact ofpact;
465 uint16_t fin_idle_timeout;
466 uint16_t fin_hard_timeout;
469 /* OFPACT_WRITE_METADATA.
471 * Used for NXAST_WRITE_METADATA. */
472 struct ofpact_metadata {
473 struct ofpact ofpact;
480 * Used for OFPIT13_METER. */
481 struct ofpact_meter {
482 struct ofpact ofpact;
486 /* OFPACT_WRITE_ACTIONS.
488 * Used for OFPIT11_WRITE_ACTIONS. */
490 struct ofpact ofpact;
491 uint8_t pad[PAD_SIZE(sizeof(struct ofpact), OFPACT_ALIGNTO)];
492 struct ofpact actions[];
494 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions) % OFPACT_ALIGNTO == 0);
495 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions)
496 == sizeof(struct ofpact_nest));
498 /* Bits for 'flags' in struct nx_action_conntrack.
500 * If NX_CT_F_COMMIT is set, then the connection entry is moved from the
501 * unconfirmed to confirmed list in the tracker. */
502 enum nx_conntrack_flags {
503 NX_CT_F_COMMIT = 1 << 0,
506 /* Magic value for struct nx_action_conntrack 'recirc_table' field, to specify
507 * that the packet should not be recirculated. */
508 #define NX_CT_RECIRC_NONE OFPTT_ALL
510 /* We want to determine the size of these elements at compile time to ensure
511 * actions alignment, but we also want to allow ofpact_conntrack to have
512 * basic _put(), _get(), etc accessors defined below which access these
513 * members directly from ofpact_conntrack. An anonymous struct will serve
514 * both of these purposes. */
517 struct ofpact ofpact; \
520 struct mf_subfield zone_src; \
522 uint8_t recirc_table; \
525 #if !defined(IPPORT_FTP)
526 #define IPPORT_FTP 21
531 * Used for NXAST_CT. */
532 struct ofpact_conntrack {
535 uint8_t pad[OFPACT_ALIGN(sizeof(CT_MEMBERS))];
537 struct ofpact actions[0];
539 BUILD_ASSERT_DECL(offsetof(struct ofpact_conntrack, actions)
540 % OFPACT_ALIGNTO == 0);
541 BUILD_ASSERT_DECL(offsetof(struct ofpact_conntrack, actions)
542 == sizeof(struct ofpact_conntrack));
545 ofpact_ct_get_action_len(const struct ofpact_conntrack *oc)
547 return oc->ofpact.len - offsetof(struct ofpact_conntrack, actions);
551 ofpact_nest_get_action_len(const struct ofpact_nest *on)
553 return on->ofpact.len - offsetof(struct ofpact_nest, actions);
556 void ofpacts_execute_action_set(struct ofpbuf *action_list,
557 const struct ofpbuf *action_set);
559 /* Bits for 'flags' in struct nx_action_nat.
562 NX_NAT_F_SRC = 1 << 0,
563 NX_NAT_F_DST = 1 << 1,
564 NX_NAT_F_PERSISTENT = 1 << 2,
565 NX_NAT_F_PROTO_HASH = 1 << 3,
566 NX_NAT_F_PROTO_RANDOM = 1 << 4,
571 * Used for NXAST_NAT. */
573 struct ofpact ofpact;
574 uint8_t range_af; /* AF_UNSPEC, AF_INET, or AF_INET6 */
575 uint16_t flags; /* NX_NAT_F_* */
597 * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
598 struct ofpact_resubmit {
599 struct ofpact ofpact;
604 /* Part of struct ofpact_learn, below. */
605 struct ofpact_learn_spec {
606 int n_bits; /* Number of bits in source and dest. */
608 int src_type; /* One of NX_LEARN_SRC_*. */
609 struct mf_subfield src; /* NX_LEARN_SRC_FIELD only. */
610 union mf_subvalue src_imm; /* NX_LEARN_SRC_IMMEDIATE only. */
612 int dst_type; /* One of NX_LEARN_DST_*. */
613 struct mf_subfield dst; /* NX_LEARN_DST_MATCH, NX_LEARN_DST_LOAD only. */
617 /* Bits for 'flags' in struct nx_action_learn.
619 * If NX_LEARN_F_SEND_FLOW_REM is set, then the learned flows will have their
620 * OFPFF_SEND_FLOW_REM flag set.
622 * If NX_LEARN_F_DELETE_LEARNED is set, then removing this action will delete
623 * all the flows from the learn action's 'table_id' that have the learn
624 * action's 'cookie'. Important points:
626 * - The deleted flows include those created by this action, those created
627 * by other learn actions with the same 'table_id' and 'cookie', those
628 * created by flow_mod requests by a controller in the specified table
629 * with the specified cookie, and those created through any other
632 * - If multiple flows specify "learn" actions with
633 * NX_LEARN_F_DELETE_LEARNED with the same 'table_id' and 'cookie', then
634 * no deletion occurs until all of those "learn" actions are deleted.
636 * - Deleting a flow that contains a learn action is the most obvious way
637 * to delete a learn action. Modifying a flow's actions, or replacing it
638 * by a new flow, can also delete a learn action. Finally, replacing a
639 * learn action with NX_LEARN_F_DELETE_LEARNED with a learn action
640 * without that flag also effectively deletes the learn action and can
641 * trigger flow deletion.
643 * NX_LEARN_F_DELETE_LEARNED was added in Open vSwitch 2.4. */
644 enum nx_learn_flags {
645 NX_LEARN_F_SEND_FLOW_REM = 1 << 0,
646 NX_LEARN_F_DELETE_LEARNED = 1 << 1,
649 #define NX_LEARN_N_BITS_MASK 0x3ff
651 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
652 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
653 #define NX_LEARN_SRC_MASK (1 << 13)
655 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
656 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
657 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
658 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
659 #define NX_LEARN_DST_MASK (3 << 11)
663 * Used for NXAST_LEARN. */
664 struct ofpact_learn {
665 struct ofpact ofpact;
667 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
668 uint16_t hard_timeout; /* Max time before discarding (seconds). */
669 uint16_t priority; /* Priority level of flow entry. */
670 uint8_t table_id; /* Table to insert flow entry. */
671 ovs_be64 cookie; /* Cookie for new flow. */
672 enum nx_learn_flags flags; /* NX_LEARN_F_*. */
673 uint16_t fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
674 uint16_t fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
676 unsigned int n_specs;
677 struct ofpact_learn_spec specs[];
680 /* Multipath link choice algorithm to apply.
682 * In the descriptions below, 'n_links' is max_link + 1. */
683 enum nx_mp_algorithm {
684 /* link = hash(flow) % n_links.
686 * Redistributes all traffic when n_links changes. O(1) performance. See
689 * Use UINT16_MAX for max_link to get a raw hash value. */
690 NX_MP_ALG_MODULO_N = 0,
692 /* link = hash(flow) / (MAX_HASH / n_links).
694 * Redistributes between one-quarter and one-half of traffic when n_links
695 * changes. O(1) performance. See RFC 2992.
697 NX_MP_ALG_HASH_THRESHOLD = 1,
699 /* Highest Random Weight.
701 * for i in [0,n_links):
702 * weights[i] = hash(flow, i)
703 * link = { i such that weights[i] >= weights[j] for all j != i }
705 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
706 * performance. If n_links is greater than a threshold (currently 64, but
707 * subject to change), Open vSwitch will substitute another algorithm
708 * automatically. See RFC 2992. */
716 * link = hash(flow, i) % arg
717 * while link > max_link
719 * Redistributes 1/n_links of traffic when n_links changes. O(1)
720 * performance when arg/max_link is bounded by a constant.
722 * Redistributes all traffic when arg changes.
724 * arg must be greater than max_link and for best performance should be no
725 * more than approximately max_link * 2. If arg is outside the acceptable
726 * range, Open vSwitch will automatically substitute the least power of 2
727 * greater than max_link.
729 * This algorithm is specific to Open vSwitch.
731 NX_MP_ALG_ITER_HASH = 3,
734 /* OFPACT_CONJUNCTION.
736 * Used for NXAST_CONJUNCTION. */
737 struct ofpact_conjunction {
738 struct ofpact ofpact;
746 * Used for NXAST_MULTIPATH. */
747 struct ofpact_multipath {
748 struct ofpact ofpact;
750 /* What fields to hash and how. */
751 enum nx_hash_fields fields;
752 uint16_t basis; /* Universal hash parameter. */
754 /* Multipath link choice algorithm to apply to hash value. */
755 enum nx_mp_algorithm algorithm;
756 uint16_t max_link; /* Number of output links, minus 1. */
757 uint32_t arg; /* Algorithm-specific argument. */
759 /* Where to store the result. */
760 struct mf_subfield dst;
765 * Used for NXAST_NOTE. */
767 struct ofpact ofpact;
774 * Used for NXAST_SAMPLE. */
775 struct ofpact_sample {
776 struct ofpact ofpact;
777 uint16_t probability; // Always >0.
778 uint32_t collector_set_id;
779 uint32_t obs_domain_id;
780 uint32_t obs_point_id;
785 * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
786 struct ofpact_cnt_ids {
787 struct ofpact ofpact;
789 /* Controller ids. */
790 unsigned int n_controllers;
794 /* OFPACT_SET_MPLS_LABEL.
796 * Used for OFPAT11_SET_MPLS_LABEL and NXAST_SET_MPLS_LABEL */
797 struct ofpact_mpls_label {
798 struct ofpact ofpact;
803 /* OFPACT_SET_MPLS_TC.
805 * Used for OFPAT11_SET_MPLS_TC and NXAST_SET_MPLS_TC */
806 struct ofpact_mpls_tc {
807 struct ofpact ofpact;
812 /* OFPACT_SET_MPLS_TTL.
814 * Used for OFPAT11_SET_MPLS_TTL and NXAST_SET_MPLS_TTL */
815 struct ofpact_mpls_ttl {
816 struct ofpact ofpact;
823 * Used for OFPIT11_GOTO_TABLE */
824 struct ofpact_goto_table {
825 struct ofpact ofpact;
831 * Used for OFPAT11_GROUP. */
832 struct ofpact_group {
833 struct ofpact ofpact;
837 /* OFPACT_UNROLL_XLATE.
839 * Used only internally. */
840 struct ofpact_unroll_xlate {
841 struct ofpact ofpact;
843 /* Metadata in xlate context, visible to controller via PACKET_INs. */
844 uint8_t rule_table_id; /* 0xFF if none. */
845 ovs_be64 rule_cookie; /* OVS_BE64_MAX if none. */
848 /* Converting OpenFlow to ofpacts. */
849 enum ofperr ofpacts_pull_openflow_actions(struct ofpbuf *openflow,
850 unsigned int actions_len,
851 enum ofp_version version,
852 struct ofpbuf *ofpacts);
853 enum ofperr ofpacts_pull_openflow_instructions(struct ofpbuf *openflow,
854 unsigned int instructions_len,
855 enum ofp_version version,
856 struct ofpbuf *ofpacts);
857 enum ofperr ofpacts_check(struct ofpact[], size_t ofpacts_len,
858 struct flow *, ofp_port_t max_ports,
859 uint8_t table_id, uint8_t n_tables,
860 enum ofputil_protocol *usable_protocols);
861 enum ofperr ofpacts_check_consistency(struct ofpact[], size_t ofpacts_len,
862 struct flow *, ofp_port_t max_ports,
863 uint8_t table_id, uint8_t n_tables,
864 enum ofputil_protocol usable_protocols);
865 enum ofperr ofpact_check_output_port(ofp_port_t port, ofp_port_t max_ports);
867 /* Converting ofpacts to OpenFlow. */
868 size_t ofpacts_put_openflow_actions(const struct ofpact[], size_t ofpacts_len,
869 struct ofpbuf *openflow, enum ofp_version);
870 void ofpacts_put_openflow_instructions(const struct ofpact[],
872 struct ofpbuf *openflow,
873 enum ofp_version ofp_version);
875 /* Sets of supported actions. */
876 ovs_be32 ofpact_bitmap_to_openflow(uint64_t ofpacts_bitmap, enum ofp_version);
877 uint64_t ofpact_bitmap_from_openflow(ovs_be32 ofpat_bitmap, enum ofp_version);
878 void ofpact_bitmap_format(uint64_t ofpacts_bitmap, struct ds *);
880 /* Working with ofpacts. */
881 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
883 bool ofpacts_output_to_group(const struct ofpact[], size_t ofpacts_len,
885 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
886 const struct ofpact b[], size_t b_len);
887 const struct mf_field *ofpact_get_mf_dst(const struct ofpact *ofpact);
888 uint32_t ofpacts_get_meter(const struct ofpact[], size_t ofpacts_len);
890 /* Formatting and parsing ofpacts. */
891 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
892 char *ofpacts_parse_actions(const char *, struct ofpbuf *ofpacts,
893 enum ofputil_protocol *usable_protocols)
894 OVS_WARN_UNUSED_RESULT;
895 char *ofpacts_parse_instructions(const char *, struct ofpbuf *ofpacts,
896 enum ofputil_protocol *usable_protocols)
897 OVS_WARN_UNUSED_RESULT;
898 const char *ofpact_name(enum ofpact_type);
900 /* Internal use by the helpers below. */
901 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
902 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
904 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
905 * the following commonly useful functions:
907 * struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
909 * Appends a new 'ofpact', of length OFPACT_<ENUM>_SIZE, to 'ofpacts',
910 * initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
911 * 'ofpacts->header' to the returned action.
913 * After using this function to add a variable-length action, add the
914 * elements of the flexible array (e.g. with ofpbuf_put()), then use
915 * ofpact_finish() to pad the action to a multiple of OFPACT_ALIGNTO bytes
916 * and update its embedded length field. (Keep in mind the need to refresh
917 * the structure from 'ofpacts->header' after adding data to 'ofpacts'.)
919 * struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
921 * Returns 'ofpact' cast to "struct <STRUCT> *". 'ofpact->type' must be
924 * as well as the following more rarely useful definitions:
926 * void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
928 * Initializes the parts of 'ofpact' that identify it as having type
929 * OFPACT_<ENUM> and length OFPACT_<ENUM>_SIZE and zeros the rest.
933 * The size of the action structure. For a fixed-length action, this is
934 * sizeof(struct <STRUCT>) rounded up to a multiple of OFPACT_ALIGNTO. For
935 * a variable-length action, this is the offset to the variable-length
938 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
939 BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
941 enum { OFPACT_##ENUM##_SIZE \
942 = (offsetof(struct STRUCT, MEMBER) \
943 ? offsetof(struct STRUCT, MEMBER) \
944 : OFPACT_ALIGN(sizeof(struct STRUCT))) }; \
946 static inline struct STRUCT * \
947 ofpact_get_##ENUM(const struct ofpact *ofpact) \
949 ovs_assert(ofpact->type == OFPACT_##ENUM); \
950 return ALIGNED_CAST(struct STRUCT *, ofpact); \
953 static inline struct STRUCT * \
954 ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
956 return ofpact_put(ofpacts, OFPACT_##ENUM, \
957 OFPACT_##ENUM##_SIZE); \
961 ofpact_init_##ENUM(struct STRUCT *ofpact) \
963 ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
964 OFPACT_##ENUM##_SIZE); \
969 /* Call after adding the variable-length part to a variable-length action. */
970 void ofpact_finish(struct ofpbuf *, struct ofpact *);
972 /* Additional functions for composing ofpacts. */
973 struct ofpact_set_field *ofpact_put_reg_load(struct ofpbuf *ofpacts);
975 /* OpenFlow 1.1 instructions.
976 * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
977 * It is enforced on parser from text string.
979 #define OVS_INSTRUCTIONS \
980 DEFINE_INST(OFPIT13_METER, \
981 ofp13_instruction_meter, false, \
984 DEFINE_INST(OFPIT11_APPLY_ACTIONS, \
985 ofp11_instruction_actions, true, \
988 DEFINE_INST(OFPIT11_CLEAR_ACTIONS, \
989 ofp11_instruction, false, \
992 DEFINE_INST(OFPIT11_WRITE_ACTIONS, \
993 ofp11_instruction_actions, true, \
996 DEFINE_INST(OFPIT11_WRITE_METADATA, \
997 ofp11_instruction_write_metadata, false, \
1000 DEFINE_INST(OFPIT11_GOTO_TABLE, \
1001 ofp11_instruction_goto_table, false, \
1004 enum ovs_instruction_type {
1005 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
1011 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
1012 N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
1016 const char *ovs_instruction_name_from_type(enum ovs_instruction_type type);
1017 int ovs_instruction_type_from_name(const char *name);
1018 enum ovs_instruction_type ovs_instruction_type_from_ofpact_type(
1020 enum ofperr ovs_instruction_type_from_inst_type(
1021 enum ovs_instruction_type *instruction_type, const uint16_t inst_type);
1023 ovs_be32 ovsinst_bitmap_to_openflow(uint32_t ovsinst_bitmap, enum ofp_version);
1024 uint32_t ovsinst_bitmap_from_openflow(ovs_be32 ofpit_bitmap,
1027 #endif /* ofp-actions.h */