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(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(PUSH_VLAN, ofpact_null, ofpact) \
64 DEFINE_OFPACT(SET_ETH_SRC, ofpact_mac, ofpact) \
65 DEFINE_OFPACT(SET_ETH_DST, ofpact_mac, ofpact) \
66 DEFINE_OFPACT(SET_IPV4_SRC, ofpact_ipv4, ofpact) \
67 DEFINE_OFPACT(SET_IPV4_DST, ofpact_ipv4, ofpact) \
68 DEFINE_OFPACT(SET_IPV4_DSCP, ofpact_dscp, ofpact) \
69 DEFINE_OFPACT(SET_L4_SRC_PORT, ofpact_l4_port, ofpact) \
70 DEFINE_OFPACT(SET_L4_DST_PORT, ofpact_l4_port, ofpact) \
71 DEFINE_OFPACT(REG_MOVE, ofpact_reg_move, ofpact) \
72 DEFINE_OFPACT(REG_LOAD, ofpact_reg_load, ofpact) \
73 DEFINE_OFPACT(STACK_PUSH, ofpact_stack, ofpact) \
74 DEFINE_OFPACT(STACK_POP, ofpact_stack, ofpact) \
75 DEFINE_OFPACT(DEC_TTL, ofpact_cnt_ids, cnt_ids) \
76 DEFINE_OFPACT(SET_MPLS_TTL, ofpact_mpls_ttl, ofpact) \
77 DEFINE_OFPACT(DEC_MPLS_TTL, ofpact_null, ofpact) \
78 DEFINE_OFPACT(PUSH_MPLS, ofpact_push_mpls, ofpact) \
79 DEFINE_OFPACT(POP_MPLS, ofpact_pop_mpls, ofpact) \
82 DEFINE_OFPACT(SET_TUNNEL, ofpact_tunnel, ofpact) \
83 DEFINE_OFPACT(SET_QUEUE, ofpact_queue, ofpact) \
84 DEFINE_OFPACT(POP_QUEUE, ofpact_null, ofpact) \
85 DEFINE_OFPACT(FIN_TIMEOUT, ofpact_fin_timeout, ofpact) \
87 /* Flow table interaction. */ \
88 DEFINE_OFPACT(RESUBMIT, ofpact_resubmit, ofpact) \
89 DEFINE_OFPACT(LEARN, ofpact_learn, specs) \
92 DEFINE_OFPACT(MULTIPATH, ofpact_multipath, ofpact) \
95 DEFINE_OFPACT(NOTE, ofpact_note, data) \
96 DEFINE_OFPACT(EXIT, ofpact_null, ofpact) \
99 /* XXX Write-Actions */ \
100 DEFINE_OFPACT(WRITE_METADATA, ofpact_metadata, ofpact) \
101 DEFINE_OFPACT(CLEAR_ACTIONS, ofpact_null, ofpact) \
102 DEFINE_OFPACT(GOTO_TABLE, ofpact_goto_table, ofpact)
104 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
105 enum OVS_PACKED_ENUM ofpact_type
{
106 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) OFPACT_##ENUM,
111 /* N_OFPACTS, the number of values of "enum ofpact_type". */
114 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) + 1
119 /* Header for an action.
121 * Each action is a structure "struct ofpact_*" that begins with "struct
122 * ofpact", usually followed by other data that describes the action. Actions
123 * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
125 * The 'compat' member is special:
127 * - Most "struct ofpact"s correspond to one particular kind of OpenFlow
128 * action, at least in a given OpenFlow version. For example,
129 * OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
132 * For such actions, the 'compat' member is not meaningful and generally
135 * - A few "struct ofpact"s correspond to multiple OpenFlow actions. For
136 * example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
137 * NXAST_SET_TUNNEL64. In these cases, if the "struct ofpact" originated
138 * from OpenFlow, then we want to make sure that, if it gets translated
139 * back to OpenFlow later, it is translated back to the same action type.
140 * (Otherwise, we'd violate the promise made in DESIGN, in the "Action
141 * Reproduction" section.)
143 * For such actions, the 'compat' member should be the original action
144 * type. (If the action didn't originate from OpenFlow, then setting
145 * 'compat' to zero should be fine: code to translate the ofpact to
146 * OpenFlow must tolerate this case.)
149 enum ofpact_type type
; /* OFPACT_*. */
150 enum ofputil_action_code compat
; /* Original type when added, if any. */
151 uint16_t len
; /* Length of the action, in bytes, including
152 * struct ofpact, excluding padding. */
156 /* Make sure that OVS_PACKED_ENUM really worked. */
157 BUILD_ASSERT_DECL(sizeof(struct ofpact
) == 4);
161 #define OFPACT_ALIGNTO 8
162 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
164 static inline struct ofpact
*
165 ofpact_next(const struct ofpact
*ofpact
)
167 return (void *) ((uint8_t *) ofpact
+ OFPACT_ALIGN(ofpact
->len
));
170 static inline struct ofpact
*
171 ofpact_end(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
173 return (void *) ((uint8_t *) ofpacts
+ ofpacts_len
);
176 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
177 * starting at OFPACTS. */
178 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN) \
179 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
180 (POS) = ofpact_next(POS))
182 /* Action structure for each OFPACT_*. */
184 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
186 * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
187 * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
189 * Action structure for actions that do not have any extra data beyond the
192 struct ofpact ofpact
;
197 * Used for OFPAT10_OUTPUT. */
198 struct ofpact_output
{
199 struct ofpact ofpact
;
200 uint16_t port
; /* Output port. */
201 uint16_t max_len
; /* Max send len, for port OFPP_CONTROLLER. */
204 /* OFPACT_CONTROLLER.
206 * Used for NXAST_CONTROLLER. */
207 struct ofpact_controller
{
208 struct ofpact ofpact
;
209 uint16_t max_len
; /* Maximum length to send to controller. */
210 uint16_t controller_id
; /* Controller ID to send packet-in. */
211 enum ofp_packet_in_reason reason
; /* Reason to put in packet-in. */
216 * Used for OFPAT10_ENQUEUE. */
217 struct ofpact_enqueue
{
218 struct ofpact ofpact
;
223 /* OFPACT_OUTPUT_REG.
225 * Used for NXAST_OUTPUT_REG. */
226 struct ofpact_output_reg
{
227 struct ofpact ofpact
;
228 struct mf_subfield src
;
234 * Used for NXAST_BUNDLE. */
235 struct ofpact_bundle
{
236 struct ofpact ofpact
;
238 /* Slave choice algorithm to apply to hash value. */
239 enum nx_bd_algorithm algorithm
;
241 /* What fields to hash and how. */
242 enum nx_hash_fields fields
;
243 uint16_t basis
; /* Universal hash parameter. */
245 struct mf_subfield dst
;
247 /* Slaves for output. */
248 unsigned int n_slaves
;
252 /* OFPACT_SET_VLAN_VID.
254 * Used for OFPAT10_SET_VLAN_VID. */
255 struct ofpact_vlan_vid
{
256 struct ofpact ofpact
;
257 uint16_t vlan_vid
; /* VLAN VID in low 12 bits, 0 in other bits. */
260 /* OFPACT_SET_VLAN_PCP.
262 * Used for OFPAT10_SET_VLAN_PCP. */
263 struct ofpact_vlan_pcp
{
264 struct ofpact ofpact
;
265 uint8_t vlan_pcp
; /* VLAN PCP in low 3 bits, 0 in other bits. */
268 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
270 * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
272 struct ofpact ofpact
;
273 uint8_t mac
[ETH_ADDR_LEN
];
276 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
278 * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
280 struct ofpact ofpact
;
284 /* OFPACT_SET_IPV4_DSCP.
286 * Used for OFPAT10_SET_NW_TOS. */
288 struct ofpact ofpact
;
289 uint8_t dscp
; /* DSCP in high 6 bits, rest ignored. */
292 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
294 * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
295 struct ofpact_l4_port
{
296 struct ofpact ofpact
;
297 uint16_t port
; /* TCP or UDP port number. */
302 * Used for NXAST_REG_MOVE. */
303 struct ofpact_reg_move
{
304 struct ofpact ofpact
;
305 struct mf_subfield src
;
306 struct mf_subfield dst
;
309 /* OFPACT_STACK_PUSH.
311 * Used for NXAST_STACK_PUSH and NXAST_STACK_POP. */
312 struct ofpact_stack
{
313 struct ofpact ofpact
;
314 struct mf_subfield subfield
;
319 * Used for NXAST_REG_LOAD, OFPAT12_SET_FIELD. */
320 struct ofpact_reg_load
{
321 struct ofpact ofpact
;
322 struct mf_subfield dst
;
323 union mf_subvalue subvalue
; /* Least-significant bits are used. */
326 /* OFPACT_PUSH_VLAN/MPLS/PBB
328 * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
329 struct ofpact_push_mpls
{
330 struct ofpact ofpact
;
336 * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
337 struct ofpact_pop_mpls
{
338 struct ofpact ofpact
;
342 /* OFPACT_SET_TUNNEL.
344 * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
345 struct ofpact_tunnel
{
346 struct ofpact ofpact
;
352 * Used for NXAST_SET_QUEUE. */
353 struct ofpact_queue
{
354 struct ofpact ofpact
;
358 /* OFPACT_FIN_TIMEOUT.
360 * Used for NXAST_FIN_TIMEOUT. */
361 struct ofpact_fin_timeout
{
362 struct ofpact ofpact
;
363 uint16_t fin_idle_timeout
;
364 uint16_t fin_hard_timeout
;
367 /* OFPACT_WRITE_METADATA.
369 * Used for NXAST_WRITE_METADATA. */
370 struct ofpact_metadata
{
371 struct ofpact ofpact
;
378 * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
379 struct ofpact_resubmit
{
380 struct ofpact ofpact
;
385 /* Part of struct ofpact_learn, below. */
386 struct ofpact_learn_spec
{
390 struct mf_subfield src
;
391 union mf_subvalue src_imm
;
394 struct mf_subfield dst
;
399 * Used for NXAST_LEARN. */
400 struct ofpact_learn
{
401 struct ofpact ofpact
;
403 uint16_t idle_timeout
; /* Idle time before discarding (seconds). */
404 uint16_t hard_timeout
; /* Max time before discarding (seconds). */
405 uint16_t priority
; /* Priority level of flow entry. */
406 uint64_t cookie
; /* Cookie for new flow. */
407 uint16_t flags
; /* Either 0 or OFPFF_SEND_FLOW_REM. */
408 uint8_t table_id
; /* Table to insert flow entry. */
409 uint16_t fin_idle_timeout
; /* Idle timeout after FIN, if nonzero. */
410 uint16_t fin_hard_timeout
; /* Hard timeout after FIN, if nonzero. */
412 unsigned int n_specs
;
413 struct ofpact_learn_spec specs
[];
418 * Used for NXAST_MULTIPATH. */
419 struct ofpact_multipath
{
420 struct ofpact ofpact
;
422 /* What fields to hash and how. */
423 enum nx_hash_fields fields
;
424 uint16_t basis
; /* Universal hash parameter. */
426 /* Multipath link choice algorithm to apply to hash value. */
427 enum nx_mp_algorithm algorithm
;
428 uint16_t max_link
; /* Number of output links, minus 1. */
429 uint32_t arg
; /* Algorithm-specific argument. */
431 /* Where to store the result. */
432 struct mf_subfield dst
;
437 * Used for NXAST_NOTE. */
439 struct ofpact ofpact
;
446 * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
447 struct ofpact_cnt_ids
{
448 struct ofpact ofpact
;
450 /* Controller ids. */
451 unsigned int n_controllers
;
455 /* OFPACT_SET_MPLS_TTL.
457 * Used for NXAST_SET_MPLS_TTL */
458 struct ofpact_mpls_ttl
{
459 struct ofpact ofpact
;
466 * Used for OFPIT11_GOTO_TABLE */
467 struct ofpact_goto_table
{
468 struct ofpact ofpact
;
472 /* Converting OpenFlow to ofpacts. */
473 enum ofperr
ofpacts_pull_openflow10(struct ofpbuf
*openflow
,
474 unsigned int actions_len
,
475 struct ofpbuf
*ofpacts
);
476 enum ofperr
ofpacts_pull_openflow11_actions(struct ofpbuf
*openflow
,
477 unsigned int actions_len
,
478 struct ofpbuf
*ofpacts
);
479 enum ofperr
ofpacts_pull_openflow11_instructions(struct ofpbuf
*openflow
,
480 unsigned int instructions_len
,
481 struct ofpbuf
*ofpacts
);
482 enum ofperr
ofpacts_check(const struct ofpact
[], size_t ofpacts_len
,
483 const struct flow
*, int max_ports
);
484 enum ofperr
ofpacts_verify(const struct ofpact ofpacts
[], size_t ofpacts_len
);
486 /* Converting ofpacts to OpenFlow. */
487 void ofpacts_put_openflow10(const struct ofpact
[], size_t ofpacts_len
,
488 struct ofpbuf
*openflow
);
489 size_t ofpacts_put_openflow11_actions(const struct ofpact
[], size_t ofpacts_len
,
490 struct ofpbuf
*openflow
);
491 void ofpacts_put_openflow11_instructions(const struct ofpact
[],
493 struct ofpbuf
*openflow
);
495 /* Working with ofpacts. */
496 bool ofpacts_output_to_port(const struct ofpact
[], size_t ofpacts_len
,
498 bool ofpacts_equal(const struct ofpact a
[], size_t a_len
,
499 const struct ofpact b
[], size_t b_len
);
501 /* Formatting ofpacts.
503 * (For parsing ofpacts, see ofp-parse.h.) */
504 void ofpacts_format(const struct ofpact
[], size_t ofpacts_len
, struct ds
*);
506 /* Internal use by the helpers below. */
507 void ofpact_init(struct ofpact
*, enum ofpact_type
, size_t len
);
508 void *ofpact_put(struct ofpbuf
*, enum ofpact_type
, size_t len
);
510 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
511 * the following commonly useful functions:
513 * struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
515 * Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
516 * initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
517 * 'ofpacts->l2' to the returned action.
519 * After using this function to add a variable-length action, add the
520 * elements of the flexible array (e.g. with ofpbuf_put()), then use
521 * ofpact_update_len() to update the length embedded into the action.
522 * (Keep in mind the need to refresh the structure from 'ofpacts->l2' after
523 * adding data to 'ofpacts'.)
525 * struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
527 * Returns 'ofpact' cast to "struct <STRUCT> *". 'ofpact->type' must be
530 * as well as the following more rarely useful definitions:
532 * void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
534 * Initializes the parts of 'ofpact' that identify it as having type
535 * OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
539 * The size of the action structure. For a fixed-length action, this is
540 * sizeof(struct <STRUCT>). For a variable-length action, this is the
541 * offset to the variable-length part.
545 * An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
546 * multiple of OFPACT_ALIGNTO.
548 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) \
549 BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
551 enum { OFPACT_##ENUM##_RAW_SIZE \
552 = (offsetof(struct STRUCT, MEMBER) \
553 ? offsetof(struct STRUCT, MEMBER) \
554 : sizeof(struct STRUCT)) }; \
556 enum { OFPACT_##ENUM##_SIZE \
557 = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) }; \
559 static inline struct STRUCT * \
560 ofpact_get_##ENUM(const struct ofpact *ofpact) \
562 ovs_assert(ofpact->type == OFPACT_##ENUM); \
563 return (struct STRUCT *) ofpact; \
566 static inline struct STRUCT * \
567 ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
569 return ofpact_put(ofpacts, OFPACT_##ENUM, \
570 OFPACT_##ENUM##_RAW_SIZE); \
574 ofpact_init_##ENUM(struct STRUCT *ofpact) \
576 ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
577 OFPACT_##ENUM##_RAW_SIZE); \
582 /* Functions to use after adding ofpacts to a buffer. */
583 void ofpact_update_len(struct ofpbuf
*, struct ofpact
*);
584 void ofpact_pad(struct ofpbuf
*);
586 /* OpenFlow 1.1 instructions.
587 * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
588 * It is enforced on parser from text string.
590 #define OVS_INSTRUCTIONS \
591 DEFINE_INST(OFPIT11_APPLY_ACTIONS, \
592 ofp11_instruction_actions, true, \
595 DEFINE_INST(OFPIT11_CLEAR_ACTIONS, \
596 ofp11_instruction, false, \
599 DEFINE_INST(OFPIT11_WRITE_ACTIONS, \
600 ofp11_instruction_actions, true, \
603 DEFINE_INST(OFPIT11_WRITE_METADATA, \
604 ofp11_instruction_write_metadata, false, \
607 DEFINE_INST(OFPIT11_GOTO_TABLE, \
608 ofp11_instruction_goto_table, false, \
611 enum ovs_instruction_type
{
612 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
618 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
619 N_OVS_INSTRUCTIONS
= OVS_INSTRUCTIONS
625 ofpact_is_instruction(const struct ofpact
*a
)
627 /* XXX Write-Actions */
628 return a
->type
== OFPACT_CLEAR_ACTIONS
629 || a
->type
== OFPACT_WRITE_METADATA
630 || a
->type
== OFPACT_GOTO_TABLE
;
633 const char *ofpact_instruction_name_from_type(enum ovs_instruction_type type
);
634 int ofpact_instruction_type_from_name(const char *name
);
636 void ofpact_set_field_init(struct ofpact_reg_load
*load
,
637 const struct mf_field
*mf
, const void *src
);
639 #endif /* ofp-actions.h */