2 * Copyright (c) 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 #define OFP_ACTIONS_H 1
21 #include "meta-flow.h"
22 #include "ofp-errors.h"
24 #include "openflow/openflow.h"
25 #include "openflow/nicira-ext.h"
26 #include "openvswitch/types.h"
28 /* List of OVS abstracted actions.
30 * This macro is used directly only internally by this header, but the list is
31 * still of interest to developers.
33 * Each DEFINE_OFPACT invocation has the following parameters:
35 * 1. <ENUM>, used below in the enum definition of OFPACT_<ENUM>, and
38 * 2. <STRUCT> corresponding to a structure "struct <STRUCT>", that must be
39 * defined below. This structure must be an abstract definition of the
40 * action. Its first member must have type "struct ofpact" and name
41 * "ofpact". It may be fixed length or end with a flexible array member
42 * (e.g. "int member[];").
44 * 3. <MEMBER>, which has one of two possible values:
46 * - If "struct <STRUCT>" is fixed-length, it must be "ofpact".
48 * - If "struct <STRUCT>" is variable-length, it must be the name of the
49 * flexible array member.
53 DEFINE_OFPACT(OUTPUT, ofpact_output, ofpact) \
54 DEFINE_OFPACT(GROUP, ofpact_group, ofpact) \
55 DEFINE_OFPACT(CONTROLLER, ofpact_controller, ofpact) \
56 DEFINE_OFPACT(ENQUEUE, ofpact_enqueue, ofpact) \
57 DEFINE_OFPACT(OUTPUT_REG, ofpact_output_reg, ofpact) \
58 DEFINE_OFPACT(BUNDLE, ofpact_bundle, slaves) \
60 /* Header changes. */ \
61 DEFINE_OFPACT(SET_VLAN_VID, ofpact_vlan_vid, ofpact) \
62 DEFINE_OFPACT(SET_VLAN_PCP, ofpact_vlan_pcp, ofpact) \
63 DEFINE_OFPACT(STRIP_VLAN, ofpact_null, ofpact) \
64 DEFINE_OFPACT(PUSH_VLAN, ofpact_null, ofpact) \
65 DEFINE_OFPACT(SET_ETH_SRC, ofpact_mac, ofpact) \
66 DEFINE_OFPACT(SET_ETH_DST, ofpact_mac, ofpact) \
67 DEFINE_OFPACT(SET_IPV4_SRC, ofpact_ipv4, ofpact) \
68 DEFINE_OFPACT(SET_IPV4_DST, ofpact_ipv4, ofpact) \
69 DEFINE_OFPACT(SET_IPV4_DSCP, ofpact_dscp, ofpact) \
70 DEFINE_OFPACT(SET_L4_SRC_PORT, ofpact_l4_port, ofpact) \
71 DEFINE_OFPACT(SET_L4_DST_PORT, ofpact_l4_port, ofpact) \
72 DEFINE_OFPACT(REG_MOVE, ofpact_reg_move, ofpact) \
73 DEFINE_OFPACT(REG_LOAD, ofpact_reg_load, ofpact) \
74 DEFINE_OFPACT(STACK_PUSH, ofpact_stack, ofpact) \
75 DEFINE_OFPACT(STACK_POP, ofpact_stack, ofpact) \
76 DEFINE_OFPACT(DEC_TTL, ofpact_cnt_ids, cnt_ids) \
77 DEFINE_OFPACT(SET_MPLS_TTL, ofpact_mpls_ttl, ofpact) \
78 DEFINE_OFPACT(DEC_MPLS_TTL, ofpact_null, ofpact) \
79 DEFINE_OFPACT(PUSH_MPLS, ofpact_push_mpls, ofpact) \
80 DEFINE_OFPACT(POP_MPLS, ofpact_pop_mpls, ofpact) \
83 DEFINE_OFPACT(SET_TUNNEL, ofpact_tunnel, ofpact) \
84 DEFINE_OFPACT(SET_QUEUE, ofpact_queue, ofpact) \
85 DEFINE_OFPACT(POP_QUEUE, ofpact_null, ofpact) \
86 DEFINE_OFPACT(FIN_TIMEOUT, ofpact_fin_timeout, ofpact) \
88 /* Flow table interaction. */ \
89 DEFINE_OFPACT(RESUBMIT, ofpact_resubmit, ofpact) \
90 DEFINE_OFPACT(LEARN, ofpact_learn, specs) \
93 DEFINE_OFPACT(MULTIPATH, ofpact_multipath, ofpact) \
96 DEFINE_OFPACT(NOTE, ofpact_note, data) \
97 DEFINE_OFPACT(EXIT, ofpact_null, ofpact) \
98 DEFINE_OFPACT(SAMPLE, ofpact_sample, ofpact) \
101 DEFINE_OFPACT(METER, ofpact_meter, ofpact) \
102 /* XXX Write-Actions */ \
103 DEFINE_OFPACT(CLEAR_ACTIONS, ofpact_null, ofpact) \
104 DEFINE_OFPACT(WRITE_METADATA, ofpact_metadata, ofpact) \
105 DEFINE_OFPACT(GOTO_TABLE, ofpact_goto_table, ofpact)
107 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
108 enum OVS_PACKED_ENUM ofpact_type {
109 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) OFPACT_##ENUM,
114 /* N_OFPACTS, the number of values of "enum ofpact_type". */
117 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) + 1
122 /* Header for an action.
124 * Each action is a structure "struct ofpact_*" that begins with "struct
125 * ofpact", usually followed by other data that describes the action. Actions
126 * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
128 * The 'compat' member is special:
130 * - Most "struct ofpact"s correspond to one particular kind of OpenFlow
131 * action, at least in a given OpenFlow version. For example,
132 * OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
135 * For such actions, the 'compat' member is not meaningful and generally
138 * - A few "struct ofpact"s correspond to multiple OpenFlow actions. For
139 * example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
140 * NXAST_SET_TUNNEL64. In these cases, if the "struct ofpact" originated
141 * from OpenFlow, then we want to make sure that, if it gets translated
142 * back to OpenFlow later, it is translated back to the same action type.
143 * (Otherwise, we'd violate the promise made in DESIGN, in the "Action
144 * Reproduction" section.)
146 * For such actions, the 'compat' member should be the original action
147 * type. (If the action didn't originate from OpenFlow, then setting
148 * 'compat' to zero should be fine: code to translate the ofpact to
149 * OpenFlow must tolerate this case.)
152 enum ofpact_type type; /* OFPACT_*. */
153 enum ofputil_action_code compat; /* Original type when added, if any. */
154 uint16_t len; /* Length of the action, in bytes, including
155 * struct ofpact, excluding padding. */
159 /* Make sure that OVS_PACKED_ENUM really worked. */
160 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
164 #define OFPACT_ALIGNTO 8
165 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
167 static inline struct ofpact *
168 ofpact_next(const struct ofpact *ofpact)
170 return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
173 static inline struct ofpact *
174 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
176 return (void *) ((uint8_t *) ofpacts + ofpacts_len);
179 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
180 * starting at OFPACTS. */
181 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN) \
182 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
183 (POS) = ofpact_next(POS))
185 /* Action structure for each OFPACT_*. */
187 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
189 * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
190 * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
192 * Action structure for actions that do not have any extra data beyond the
195 struct ofpact ofpact;
200 * Used for OFPAT10_OUTPUT. */
201 struct ofpact_output {
202 struct ofpact ofpact;
203 ofp_port_t port; /* Output port. */
204 uint16_t max_len; /* Max send len, for port OFPP_CONTROLLER. */
207 /* OFPACT_CONTROLLER.
209 * Used for NXAST_CONTROLLER. */
210 struct ofpact_controller {
211 struct ofpact ofpact;
212 uint16_t max_len; /* Maximum length to send to controller. */
213 uint16_t controller_id; /* Controller ID to send packet-in. */
214 enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
219 * Used for OFPAT10_ENQUEUE. */
220 struct ofpact_enqueue {
221 struct ofpact ofpact;
226 /* OFPACT_OUTPUT_REG.
228 * Used for NXAST_OUTPUT_REG. */
229 struct ofpact_output_reg {
230 struct ofpact ofpact;
231 struct mf_subfield src;
237 * Used for NXAST_BUNDLE. */
238 struct ofpact_bundle {
239 struct ofpact ofpact;
241 /* Slave choice algorithm to apply to hash value. */
242 enum nx_bd_algorithm algorithm;
244 /* What fields to hash and how. */
245 enum nx_hash_fields fields;
246 uint16_t basis; /* Universal hash parameter. */
248 struct mf_subfield dst;
250 /* Slaves for output. */
251 unsigned int n_slaves;
255 /* OFPACT_SET_VLAN_VID.
257 * Used for OFPAT10_SET_VLAN_VID. */
258 struct ofpact_vlan_vid {
259 struct ofpact ofpact;
260 uint16_t vlan_vid; /* VLAN VID in low 12 bits, 0 in other bits. */
263 /* OFPACT_SET_VLAN_PCP.
265 * Used for OFPAT10_SET_VLAN_PCP. */
266 struct ofpact_vlan_pcp {
267 struct ofpact ofpact;
268 uint8_t vlan_pcp; /* VLAN PCP in low 3 bits, 0 in other bits. */
271 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
273 * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
275 struct ofpact ofpact;
276 uint8_t mac[ETH_ADDR_LEN];
279 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
281 * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
283 struct ofpact ofpact;
287 /* OFPACT_SET_IPV4_DSCP.
289 * Used for OFPAT10_SET_NW_TOS. */
291 struct ofpact ofpact;
292 uint8_t dscp; /* DSCP in high 6 bits, rest ignored. */
295 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
297 * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
298 struct ofpact_l4_port {
299 struct ofpact ofpact;
300 uint16_t port; /* TCP or UDP port number. */
305 * Used for NXAST_REG_MOVE. */
306 struct ofpact_reg_move {
307 struct ofpact ofpact;
308 struct mf_subfield src;
309 struct mf_subfield dst;
312 /* OFPACT_STACK_PUSH.
314 * Used for NXAST_STACK_PUSH and NXAST_STACK_POP. */
315 struct ofpact_stack {
316 struct ofpact ofpact;
317 struct mf_subfield subfield;
322 * Used for NXAST_REG_LOAD, OFPAT12_SET_FIELD. */
323 struct ofpact_reg_load {
324 struct ofpact ofpact;
325 struct mf_subfield dst;
326 union mf_subvalue subvalue; /* Least-significant bits are used. */
329 /* OFPACT_PUSH_VLAN/MPLS/PBB
331 * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
332 struct ofpact_push_mpls {
333 struct ofpact ofpact;
339 * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
340 struct ofpact_pop_mpls {
341 struct ofpact ofpact;
345 /* OFPACT_SET_TUNNEL.
347 * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
348 struct ofpact_tunnel {
349 struct ofpact ofpact;
355 * Used for NXAST_SET_QUEUE. */
356 struct ofpact_queue {
357 struct ofpact ofpact;
361 /* OFPACT_FIN_TIMEOUT.
363 * Used for NXAST_FIN_TIMEOUT. */
364 struct ofpact_fin_timeout {
365 struct ofpact ofpact;
366 uint16_t fin_idle_timeout;
367 uint16_t fin_hard_timeout;
370 /* OFPACT_WRITE_METADATA.
372 * Used for NXAST_WRITE_METADATA. */
373 struct ofpact_metadata {
374 struct ofpact ofpact;
381 * Used for OFPIT13_METER. */
382 struct ofpact_meter {
383 struct ofpact ofpact;
389 * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
390 struct ofpact_resubmit {
391 struct ofpact ofpact;
396 /* Part of struct ofpact_learn, below. */
397 struct ofpact_learn_spec {
398 int n_bits; /* Number of bits in source and dest. */
400 int src_type; /* One of NX_LEARN_SRC_*. */
401 struct mf_subfield src; /* NX_LEARN_SRC_FIELD only. */
402 union mf_subvalue src_imm; /* NX_LEARN_SRC_IMMEDIATE only. */
404 int dst_type; /* One of NX_LEARN_DST_*. */
405 struct mf_subfield dst; /* NX_LEARN_DST_MATCH, NX_LEARN_DST_LOAD only. */
410 * Used for NXAST_LEARN. */
411 struct ofpact_learn {
412 struct ofpact ofpact;
414 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
415 uint16_t hard_timeout; /* Max time before discarding (seconds). */
416 uint16_t priority; /* Priority level of flow entry. */
417 uint64_t cookie; /* Cookie for new flow. */
418 enum ofputil_flow_mod_flags flags;
419 uint8_t table_id; /* Table to insert flow entry. */
420 uint16_t fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
421 uint16_t fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
423 unsigned int n_specs;
424 struct ofpact_learn_spec specs[];
429 * Used for NXAST_MULTIPATH. */
430 struct ofpact_multipath {
431 struct ofpact ofpact;
433 /* What fields to hash and how. */
434 enum nx_hash_fields fields;
435 uint16_t basis; /* Universal hash parameter. */
437 /* Multipath link choice algorithm to apply to hash value. */
438 enum nx_mp_algorithm algorithm;
439 uint16_t max_link; /* Number of output links, minus 1. */
440 uint32_t arg; /* Algorithm-specific argument. */
442 /* Where to store the result. */
443 struct mf_subfield dst;
448 * Used for NXAST_NOTE. */
450 struct ofpact ofpact;
457 * Used for NXAST_SAMPLE. */
458 struct ofpact_sample {
459 struct ofpact ofpact;
460 uint16_t probability; // Always >0.
461 uint32_t collector_set_id;
462 uint32_t obs_domain_id;
463 uint32_t obs_point_id;
468 * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
469 struct ofpact_cnt_ids {
470 struct ofpact ofpact;
472 /* Controller ids. */
473 unsigned int n_controllers;
477 /* OFPACT_SET_MPLS_TTL.
479 * Used for NXAST_SET_MPLS_TTL */
480 struct ofpact_mpls_ttl {
481 struct ofpact ofpact;
488 * Used for OFPIT11_GOTO_TABLE */
489 struct ofpact_goto_table {
490 struct ofpact ofpact;
496 * Used for OFPAT11_GROUP. */
497 struct ofpact_group {
498 struct ofpact ofpact;
502 /* Converting OpenFlow to ofpacts. */
503 enum ofperr ofpacts_pull_openflow10(struct ofpbuf *openflow,
504 unsigned int actions_len,
505 struct ofpbuf *ofpacts);
506 enum ofperr ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
507 unsigned int actions_len,
508 struct ofpbuf *ofpacts);
509 enum ofperr ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
510 unsigned int instructions_len,
511 struct ofpbuf *ofpacts);
512 enum ofperr ofpacts_check(const struct ofpact[], size_t ofpacts_len,
513 struct flow *, ofp_port_t max_ports,
515 enum ofperr ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len);
517 /* Converting ofpacts to OpenFlow. */
518 void ofpacts_put_openflow10(const struct ofpact[], size_t ofpacts_len,
519 struct ofpbuf *openflow);
520 size_t ofpacts_put_openflow11_actions(const struct ofpact[], size_t ofpacts_len,
521 struct ofpbuf *openflow);
522 void ofpacts_put_openflow11_instructions(const struct ofpact[],
524 struct ofpbuf *openflow);
526 /* Working with ofpacts. */
527 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
529 bool ofpacts_output_to_group(const struct ofpact[], size_t ofpacts_len,
531 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
532 const struct ofpact b[], size_t b_len);
533 uint32_t ofpacts_get_meter(const struct ofpact[], size_t ofpacts_len);
535 /* Formatting ofpacts.
537 * (For parsing ofpacts, see ofp-parse.h.) */
538 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
540 /* Internal use by the helpers below. */
541 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
542 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
544 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
545 * the following commonly useful functions:
547 * struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
549 * Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
550 * initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
551 * 'ofpacts->l2' to the returned action.
553 * After using this function to add a variable-length action, add the
554 * elements of the flexible array (e.g. with ofpbuf_put()), then use
555 * ofpact_update_len() to update the length embedded into the action.
556 * (Keep in mind the need to refresh the structure from 'ofpacts->l2' after
557 * adding data to 'ofpacts'.)
559 * struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
561 * Returns 'ofpact' cast to "struct <STRUCT> *". 'ofpact->type' must be
564 * as well as the following more rarely useful definitions:
566 * void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
568 * Initializes the parts of 'ofpact' that identify it as having type
569 * OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
573 * The size of the action structure. For a fixed-length action, this is
574 * sizeof(struct <STRUCT>). For a variable-length action, this is the
575 * offset to the variable-length part.
579 * An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
580 * multiple of OFPACT_ALIGNTO.
582 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) \
583 BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
585 enum { OFPACT_##ENUM##_RAW_SIZE \
586 = (offsetof(struct STRUCT, MEMBER) \
587 ? offsetof(struct STRUCT, MEMBER) \
588 : sizeof(struct STRUCT)) }; \
590 enum { OFPACT_##ENUM##_SIZE \
591 = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) }; \
593 static inline struct STRUCT * \
594 ofpact_get_##ENUM(const struct ofpact *ofpact) \
596 ovs_assert(ofpact->type == OFPACT_##ENUM); \
597 return ALIGNED_CAST(struct STRUCT *, ofpact); \
600 static inline struct STRUCT * \
601 ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
603 return ofpact_put(ofpacts, OFPACT_##ENUM, \
604 OFPACT_##ENUM##_RAW_SIZE); \
608 ofpact_init_##ENUM(struct STRUCT *ofpact) \
610 ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
611 OFPACT_##ENUM##_RAW_SIZE); \
616 /* Functions to use after adding ofpacts to a buffer. */
617 void ofpact_update_len(struct ofpbuf *, struct ofpact *);
618 void ofpact_pad(struct ofpbuf *);
620 /* OpenFlow 1.1 instructions.
621 * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
622 * It is enforced on parser from text string.
624 #define OVS_INSTRUCTIONS \
625 DEFINE_INST(OFPIT13_METER, \
626 ofp13_instruction_meter, false, \
629 DEFINE_INST(OFPIT11_APPLY_ACTIONS, \
630 ofp11_instruction_actions, true, \
633 DEFINE_INST(OFPIT11_CLEAR_ACTIONS, \
634 ofp11_instruction, false, \
637 DEFINE_INST(OFPIT11_WRITE_ACTIONS, \
638 ofp11_instruction_actions, true, \
641 DEFINE_INST(OFPIT11_WRITE_METADATA, \
642 ofp11_instruction_write_metadata, false, \
645 DEFINE_INST(OFPIT11_GOTO_TABLE, \
646 ofp11_instruction_goto_table, false, \
649 enum ovs_instruction_type {
650 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
656 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
657 N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
661 const char *ovs_instruction_name_from_type(enum ovs_instruction_type type);
662 int ovs_instruction_type_from_name(const char *name);
663 enum ovs_instruction_type ovs_instruction_type_from_ofpact_type(
666 void ofpact_set_field_init(struct ofpact_reg_load *load,
667 const struct mf_field *mf, const void *src);
669 #endif /* ofp-actions.h */