2 * Copyright (c) 2012 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(CONTROLLER, ofpact_controller, ofpact) \
55 DEFINE_OFPACT(ENQUEUE, ofpact_enqueue, ofpact) \
56 DEFINE_OFPACT(OUTPUT_REG, ofpact_output_reg, ofpact) \
57 DEFINE_OFPACT(BUNDLE, ofpact_bundle, slaves) \
59 /* Header changes. */ \
60 DEFINE_OFPACT(SET_VLAN_VID, ofpact_vlan_vid, ofpact) \
61 DEFINE_OFPACT(SET_VLAN_PCP, ofpact_vlan_pcp, ofpact) \
62 DEFINE_OFPACT(STRIP_VLAN, ofpact_null, ofpact) \
63 DEFINE_OFPACT(SET_ETH_SRC, ofpact_mac, ofpact) \
64 DEFINE_OFPACT(SET_ETH_DST, ofpact_mac, ofpact) \
65 DEFINE_OFPACT(SET_IPV4_SRC, ofpact_ipv4, ofpact) \
66 DEFINE_OFPACT(SET_IPV4_DST, ofpact_ipv4, ofpact) \
67 DEFINE_OFPACT(SET_IPV4_DSCP, ofpact_dscp, ofpact) \
68 DEFINE_OFPACT(SET_L4_SRC_PORT, ofpact_l4_port, ofpact) \
69 DEFINE_OFPACT(SET_L4_DST_PORT, ofpact_l4_port, ofpact) \
70 DEFINE_OFPACT(REG_MOVE, ofpact_reg_move, ofpact) \
71 DEFINE_OFPACT(REG_LOAD, ofpact_reg_load, ofpact) \
72 DEFINE_OFPACT(DEC_TTL, ofpact_cnt_ids, cnt_ids) \
75 DEFINE_OFPACT(SET_TUNNEL, ofpact_tunnel, ofpact) \
76 DEFINE_OFPACT(SET_QUEUE, ofpact_queue, ofpact) \
77 DEFINE_OFPACT(POP_QUEUE, ofpact_null, ofpact) \
78 DEFINE_OFPACT(FIN_TIMEOUT, ofpact_fin_timeout, ofpact) \
80 /* Flow table interaction. */ \
81 DEFINE_OFPACT(RESUBMIT, ofpact_resubmit, ofpact) \
82 DEFINE_OFPACT(LEARN, ofpact_learn, specs) \
85 DEFINE_OFPACT(MULTIPATH, ofpact_multipath, ofpact) \
86 DEFINE_OFPACT(AUTOPATH, ofpact_autopath, ofpact) \
89 DEFINE_OFPACT(NOTE, ofpact_note, data) \
90 DEFINE_OFPACT(EXIT, ofpact_null, ofpact) \
93 /* TODO:XXX Write-Actions, Write-Metadata */ \
94 DEFINE_OFPACT(CLEAR_ACTIONS, ofpact_null, ofpact) \
95 DEFINE_OFPACT(GOTO_TABLE, ofpact_goto_table, ofpact)
97 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
98 enum OVS_PACKED_ENUM ofpact_type {
99 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) OFPACT_##ENUM,
104 /* N_OFPACTS, the number of values of "enum ofpact_type". */
107 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) + 1
112 /* Header for an action.
114 * Each action is a structure "struct ofpact_*" that begins with "struct
115 * ofpact", usually followed by other data that describes the action. Actions
116 * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
118 * The 'compat' member is special:
120 * - Most "struct ofpact"s correspond to one particular kind of OpenFlow
121 * action, at least in a given OpenFlow version. For example,
122 * OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
125 * For such actions, the 'compat' member is not meaningful and generally
128 * - A few "struct ofpact"s correspond to multiple OpenFlow actions. For
129 * example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
130 * NXAST_SET_TUNNEL64. In these cases, if the "struct ofpact" originated
131 * from OpenFlow, then we want to make sure that, if it gets translated
132 * back to OpenFlow later, it is translated back to the same action type.
133 * (Otherwise, we'd violate the promise made in DESIGN, in the "Action
134 * Reproduction" section.)
136 * For such actions, the 'compat' member should be the original action
137 * type. (If the action didn't originate from OpenFlow, then setting
138 * 'compat' to zero should be fine: code to translate the ofpact to
139 * OpenFlow must tolerate this case.)
142 enum ofpact_type type; /* OFPACT_*. */
143 enum ofputil_action_code compat; /* Original type when added, if any. */
144 uint16_t len; /* Length of the action, in bytes, including
145 * struct ofpact, excluding padding. */
149 /* Make sure that OVS_PACKED_ENUM really worked. */
150 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
154 #define OFPACT_ALIGNTO 8
155 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
157 static inline struct ofpact *
158 ofpact_next(const struct ofpact *ofpact)
160 return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
163 static inline struct ofpact *
164 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
166 return (void *) ((uint8_t *) ofpacts + ofpacts_len);
169 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
170 * starting at OFPACTS. */
171 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN) \
172 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
173 (POS) = ofpact_next(POS))
175 /* Action structure for each OFPACT_*. */
177 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
179 * Used for OFPAT10_STRIP_VLAN, NXAST_DEC_TTL, NXAST_POP_QUEUE, NXAST_EXIT,
180 * OFPIT11_CLEAR_ACTIONS.
182 * Action structure for actions that do not have any extra data beyond the
185 struct ofpact ofpact;
190 * Used for OFPAT10_OUTPUT. */
191 struct ofpact_output {
192 struct ofpact ofpact;
193 uint16_t port; /* Output port. */
194 uint16_t max_len; /* Max send len, for port OFPP_CONTROLLER. */
197 /* OFPACT_CONTROLLER.
199 * Used for NXAST_CONTROLLER. */
200 struct ofpact_controller {
201 struct ofpact ofpact;
202 uint16_t max_len; /* Maximum length to send to controller. */
203 uint16_t controller_id; /* Controller ID to send packet-in. */
204 enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
209 * Used for OFPAT10_ENQUEUE. */
210 struct ofpact_enqueue {
211 struct ofpact ofpact;
216 /* OFPACT_OUTPUT_REG.
218 * Used for NXAST_OUTPUT_REG. */
219 struct ofpact_output_reg {
220 struct ofpact ofpact;
221 struct mf_subfield src;
227 * Used for NXAST_BUNDLE. */
228 struct ofpact_bundle {
229 struct ofpact ofpact;
231 /* Slave choice algorithm to apply to hash value. */
232 enum nx_bd_algorithm algorithm;
234 /* What fields to hash and how. */
235 enum nx_hash_fields fields;
236 uint16_t basis; /* Universal hash parameter. */
238 struct mf_subfield dst;
240 /* Slaves for output. */
241 unsigned int n_slaves;
245 /* OFPACT_SET_VLAN_VID.
247 * Used for OFPAT10_SET_VLAN_VID. */
248 struct ofpact_vlan_vid {
249 struct ofpact ofpact;
250 uint16_t vlan_vid; /* VLAN VID in low 12 bits, 0 in other bits. */
253 /* OFPACT_SET_VLAN_PCP.
255 * Used for OFPAT10_SET_VLAN_PCP. */
256 struct ofpact_vlan_pcp {
257 struct ofpact ofpact;
258 uint8_t vlan_pcp; /* VLAN PCP in low 3 bits, 0 in other bits. */
261 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
263 * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
265 struct ofpact ofpact;
266 uint8_t mac[ETH_ADDR_LEN];
269 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
271 * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
273 struct ofpact ofpact;
277 /* OFPACT_SET_IPV4_DSCP.
279 * Used for OFPAT10_SET_NW_TOS. */
281 struct ofpact ofpact;
282 uint8_t dscp; /* DSCP in high 6 bits, rest ignored. */
285 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
287 * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
288 struct ofpact_l4_port {
289 struct ofpact ofpact;
290 uint16_t port; /* TCP or UDP port number. */
295 * Used for NXAST_REG_MOVE. */
296 struct ofpact_reg_move {
297 struct ofpact ofpact;
298 struct mf_subfield src;
299 struct mf_subfield dst;
304 * Used for NXAST_REG_LOAD, OFPAT12_SET_FIELD. */
305 struct ofpact_reg_load {
306 struct ofpact ofpact;
307 struct mf_subfield dst;
308 union mf_subvalue subvalue; /* Least-significant bits are used. */
311 /* OFPACT_SET_TUNNEL.
313 * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
314 struct ofpact_tunnel {
315 struct ofpact ofpact;
321 * Used for NXAST_SET_QUEUE. */
322 struct ofpact_queue {
323 struct ofpact ofpact;
327 /* OFPACT_FIN_TIMEOUT.
329 * Used for NXAST_FIN_TIMEOUT. */
330 struct ofpact_fin_timeout {
331 struct ofpact ofpact;
332 uint16_t fin_idle_timeout;
333 uint16_t fin_hard_timeout;
338 * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
339 struct ofpact_resubmit {
340 struct ofpact ofpact;
345 /* Part of struct ofpact_learn, below. */
346 struct ofpact_learn_spec {
350 struct mf_subfield src;
351 union mf_subvalue src_imm;
354 struct mf_subfield dst;
359 * Used for NXAST_LEARN. */
360 struct ofpact_learn {
361 struct ofpact ofpact;
363 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
364 uint16_t hard_timeout; /* Max time before discarding (seconds). */
365 uint16_t priority; /* Priority level of flow entry. */
366 uint64_t cookie; /* Cookie for new flow. */
367 uint16_t flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
368 uint8_t table_id; /* Table to insert flow entry. */
369 uint16_t fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
370 uint16_t fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
372 unsigned int n_specs;
373 struct ofpact_learn_spec specs[];
378 * Used for NXAST_MULTIPATH. */
379 struct ofpact_multipath {
380 struct ofpact ofpact;
382 /* What fields to hash and how. */
383 enum nx_hash_fields fields;
384 uint16_t basis; /* Universal hash parameter. */
386 /* Multipath link choice algorithm to apply to hash value. */
387 enum nx_mp_algorithm algorithm;
388 uint16_t max_link; /* Number of output links, minus 1. */
389 uint32_t arg; /* Algorithm-specific argument. */
391 /* Where to store the result. */
392 struct mf_subfield dst;
397 * Used for NXAST_AUTOPATH. */
398 struct ofpact_autopath {
399 struct ofpact ofpact;
400 struct mf_subfield dst;
406 * Used for NXAST_NOTE. */
408 struct ofpact ofpact;
415 * Used for NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
416 struct ofpact_cnt_ids {
417 struct ofpact ofpact;
419 /* Controller ids. */
420 unsigned int n_controllers;
426 * Used for OFPIT11_GOTO_TABLE */
427 struct ofpact_goto_table {
428 struct ofpact ofpact;
432 /* Converting OpenFlow to ofpacts. */
433 enum ofperr ofpacts_pull_openflow10(struct ofpbuf *openflow,
434 unsigned int actions_len,
435 struct ofpbuf *ofpacts);
436 enum ofperr ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
437 unsigned int actions_len,
438 struct ofpbuf *ofpacts);
439 enum ofperr ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
440 unsigned int instructions_len,
441 struct ofpbuf *ofpacts);
442 enum ofperr ofpacts_check(const struct ofpact[], size_t ofpacts_len,
443 const struct flow *, int max_ports);
445 /* Converting ofpacts to OpenFlow. */
446 void ofpacts_put_openflow10(const struct ofpact[], size_t ofpacts_len,
447 struct ofpbuf *openflow);
448 size_t ofpacts_put_openflow11_actions(const struct ofpact[], size_t ofpacts_len,
449 struct ofpbuf *openflow);
450 void ofpacts_put_openflow11_instructions(const struct ofpact[],
452 struct ofpbuf *openflow);
454 /* Working with ofpacts. */
455 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
457 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
458 const struct ofpact b[], size_t b_len);
460 /* Formatting ofpacts.
462 * (For parsing ofpacts, see ofp-parse.h.) */
463 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
465 /* Internal use by the helpers below. */
466 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
467 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
469 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
470 * the following commonly useful functions:
472 * struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
474 * Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
475 * initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
476 * 'ofpacts->l2' to the returned action.
478 * After using this function to add a variable-length action, add the
479 * elements of the flexible array (e.g. with ofpbuf_put()), then use
480 * ofpact_update_len() to update the length embedded into the action.
481 * (Keep in mind the need to refresh the structure from 'ofpacts->l2' after
482 * adding data to 'ofpacts'.)
484 * struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
486 * Returns 'ofpact' cast to "struct <STRUCT> *". 'ofpact->type' must be
489 * as well as the following more rarely useful definitions:
491 * void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
493 * Initializes the parts of 'ofpact' that identify it as having type
494 * OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
498 * The size of the action structure. For a fixed-length action, this is
499 * sizeof(struct <STRUCT>). For a variable-length action, this is the
500 * offset to the variable-length part.
504 * An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
505 * multiple of OFPACT_ALIGNTO.
507 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) \
508 BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
510 enum { OFPACT_##ENUM##_RAW_SIZE \
511 = (offsetof(struct STRUCT, MEMBER) \
512 ? offsetof(struct STRUCT, MEMBER) \
513 : sizeof(struct STRUCT)) }; \
515 enum { OFPACT_##ENUM##_SIZE \
516 = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) }; \
518 static inline struct STRUCT * \
519 ofpact_get_##ENUM(const struct ofpact *ofpact) \
521 assert(ofpact->type == OFPACT_##ENUM); \
522 return (struct STRUCT *) ofpact; \
525 static inline struct STRUCT * \
526 ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
528 return ofpact_put(ofpacts, OFPACT_##ENUM, \
529 OFPACT_##ENUM##_RAW_SIZE); \
533 ofpact_init_##ENUM(struct STRUCT *ofpact) \
535 ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
536 OFPACT_##ENUM##_RAW_SIZE); \
541 /* Functions to use after adding ofpacts to a buffer. */
542 void ofpact_update_len(struct ofpbuf *, struct ofpact *);
543 void ofpact_pad(struct ofpbuf *);
545 /* OpenFlow 1.1 instructions.
546 * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
547 * It is enforced on parser from text string.
549 #define OVS_INSTRUCTIONS \
550 DEFINE_INST(OFPIT11_APPLY_ACTIONS, \
551 ofp11_instruction_actions, true, \
554 DEFINE_INST(OFPIT11_CLEAR_ACTIONS, \
555 ofp11_instruction, false, \
558 DEFINE_INST(OFPIT11_WRITE_ACTIONS, \
559 ofp11_instruction_actions, true, \
562 DEFINE_INST(OFPIT11_WRITE_METADATA, \
563 ofp11_instruction_write_metadata, false, \
566 DEFINE_INST(OFPIT11_GOTO_TABLE, \
567 ofp11_instruction_goto_table, false, \
570 enum ovs_instruction_type {
571 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
577 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
578 N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
584 ofpact_is_instruction(const struct ofpact *a)
586 /* TODO:XXX Write-Actions, Write-Metadata */
587 return a->type == OFPACT_CLEAR_ACTIONS
588 || a->type == OFPACT_GOTO_TABLE;
591 const char *ofpact_instruction_name_from_type(enum ovs_instruction_type type);
592 int ofpact_instruction_type_from_name(const char *name);
594 void ofpact_set_field_init(struct ofpact_reg_load *load,
595 const struct mf_field *mf, const void *src);
597 #endif /* ofp-actions.h */