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(DEC_TTL, ofpact_cnt_ids, cnt_ids) \
74 DEFINE_OFPACT(PUSH_MPLS, ofpact_push_mpls, ofpact) \
75 DEFINE_OFPACT(POP_MPLS, ofpact_pop_mpls, ofpact) \
78 DEFINE_OFPACT(SET_TUNNEL, ofpact_tunnel, ofpact) \
79 DEFINE_OFPACT(SET_QUEUE, ofpact_queue, ofpact) \
80 DEFINE_OFPACT(POP_QUEUE, ofpact_null, ofpact) \
81 DEFINE_OFPACT(FIN_TIMEOUT, ofpact_fin_timeout, ofpact) \
83 /* Flow table interaction. */ \
84 DEFINE_OFPACT(RESUBMIT, ofpact_resubmit, ofpact) \
85 DEFINE_OFPACT(LEARN, ofpact_learn, specs) \
88 DEFINE_OFPACT(MULTIPATH, ofpact_multipath, ofpact) \
91 DEFINE_OFPACT(NOTE, ofpact_note, data) \
92 DEFINE_OFPACT(EXIT, ofpact_null, ofpact) \
95 /* XXX Write-Actions */ \
96 DEFINE_OFPACT(WRITE_METADATA, ofpact_metadata, ofpact) \
97 DEFINE_OFPACT(CLEAR_ACTIONS, ofpact_null, ofpact) \
98 DEFINE_OFPACT(GOTO_TABLE, ofpact_goto_table, ofpact)
100 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
101 enum OVS_PACKED_ENUM ofpact_type {
102 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) OFPACT_##ENUM,
107 /* N_OFPACTS, the number of values of "enum ofpact_type". */
110 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) + 1
115 /* Header for an action.
117 * Each action is a structure "struct ofpact_*" that begins with "struct
118 * ofpact", usually followed by other data that describes the action. Actions
119 * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
121 * The 'compat' member is special:
123 * - Most "struct ofpact"s correspond to one particular kind of OpenFlow
124 * action, at least in a given OpenFlow version. For example,
125 * OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
128 * For such actions, the 'compat' member is not meaningful and generally
131 * - A few "struct ofpact"s correspond to multiple OpenFlow actions. For
132 * example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
133 * NXAST_SET_TUNNEL64. In these cases, if the "struct ofpact" originated
134 * from OpenFlow, then we want to make sure that, if it gets translated
135 * back to OpenFlow later, it is translated back to the same action type.
136 * (Otherwise, we'd violate the promise made in DESIGN, in the "Action
137 * Reproduction" section.)
139 * For such actions, the 'compat' member should be the original action
140 * type. (If the action didn't originate from OpenFlow, then setting
141 * 'compat' to zero should be fine: code to translate the ofpact to
142 * OpenFlow must tolerate this case.)
145 enum ofpact_type type; /* OFPACT_*. */
146 enum ofputil_action_code compat; /* Original type when added, if any. */
147 uint16_t len; /* Length of the action, in bytes, including
148 * struct ofpact, excluding padding. */
152 /* Make sure that OVS_PACKED_ENUM really worked. */
153 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
157 #define OFPACT_ALIGNTO 8
158 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
160 static inline struct ofpact *
161 ofpact_next(const struct ofpact *ofpact)
163 return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
166 static inline struct ofpact *
167 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
169 return (void *) ((uint8_t *) ofpacts + ofpacts_len);
172 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
173 * starting at OFPACTS. */
174 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN) \
175 for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN); \
176 (POS) = ofpact_next(POS))
178 /* Action structure for each OFPACT_*. */
180 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
182 * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
183 * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
185 * Action structure for actions that do not have any extra data beyond the
188 struct ofpact ofpact;
193 * Used for OFPAT10_OUTPUT. */
194 struct ofpact_output {
195 struct ofpact ofpact;
196 uint16_t port; /* Output port. */
197 uint16_t max_len; /* Max send len, for port OFPP_CONTROLLER. */
200 /* OFPACT_CONTROLLER.
202 * Used for NXAST_CONTROLLER. */
203 struct ofpact_controller {
204 struct ofpact ofpact;
205 uint16_t max_len; /* Maximum length to send to controller. */
206 uint16_t controller_id; /* Controller ID to send packet-in. */
207 enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
212 * Used for OFPAT10_ENQUEUE. */
213 struct ofpact_enqueue {
214 struct ofpact ofpact;
219 /* OFPACT_OUTPUT_REG.
221 * Used for NXAST_OUTPUT_REG. */
222 struct ofpact_output_reg {
223 struct ofpact ofpact;
224 struct mf_subfield src;
230 * Used for NXAST_BUNDLE. */
231 struct ofpact_bundle {
232 struct ofpact ofpact;
234 /* Slave choice algorithm to apply to hash value. */
235 enum nx_bd_algorithm algorithm;
237 /* What fields to hash and how. */
238 enum nx_hash_fields fields;
239 uint16_t basis; /* Universal hash parameter. */
241 struct mf_subfield dst;
243 /* Slaves for output. */
244 unsigned int n_slaves;
248 /* OFPACT_SET_VLAN_VID.
250 * Used for OFPAT10_SET_VLAN_VID. */
251 struct ofpact_vlan_vid {
252 struct ofpact ofpact;
253 uint16_t vlan_vid; /* VLAN VID in low 12 bits, 0 in other bits. */
256 /* OFPACT_SET_VLAN_PCP.
258 * Used for OFPAT10_SET_VLAN_PCP. */
259 struct ofpact_vlan_pcp {
260 struct ofpact ofpact;
261 uint8_t vlan_pcp; /* VLAN PCP in low 3 bits, 0 in other bits. */
264 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
266 * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
268 struct ofpact ofpact;
269 uint8_t mac[ETH_ADDR_LEN];
272 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
274 * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
276 struct ofpact ofpact;
280 /* OFPACT_SET_IPV4_DSCP.
282 * Used for OFPAT10_SET_NW_TOS. */
284 struct ofpact ofpact;
285 uint8_t dscp; /* DSCP in high 6 bits, rest ignored. */
288 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
290 * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
291 struct ofpact_l4_port {
292 struct ofpact ofpact;
293 uint16_t port; /* TCP or UDP port number. */
298 * Used for NXAST_REG_MOVE. */
299 struct ofpact_reg_move {
300 struct ofpact ofpact;
301 struct mf_subfield src;
302 struct mf_subfield dst;
307 * Used for NXAST_REG_LOAD, OFPAT12_SET_FIELD. */
308 struct ofpact_reg_load {
309 struct ofpact ofpact;
310 struct mf_subfield dst;
311 union mf_subvalue subvalue; /* Least-significant bits are used. */
314 /* OFPACT_PUSH_VLAN/MPLS/PBB
316 * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
317 struct ofpact_push_mpls {
318 struct ofpact ofpact;
324 * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
325 struct ofpact_pop_mpls {
326 struct ofpact ofpact;
330 /* OFPACT_SET_TUNNEL.
332 * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
333 struct ofpact_tunnel {
334 struct ofpact ofpact;
340 * Used for NXAST_SET_QUEUE. */
341 struct ofpact_queue {
342 struct ofpact ofpact;
346 /* OFPACT_FIN_TIMEOUT.
348 * Used for NXAST_FIN_TIMEOUT. */
349 struct ofpact_fin_timeout {
350 struct ofpact ofpact;
351 uint16_t fin_idle_timeout;
352 uint16_t fin_hard_timeout;
355 /* OFPACT_WRITE_METADATA.
357 * Used for NXAST_WRITE_METADATA. */
358 struct ofpact_metadata {
359 struct ofpact ofpact;
366 * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
367 struct ofpact_resubmit {
368 struct ofpact ofpact;
373 /* Part of struct ofpact_learn, below. */
374 struct ofpact_learn_spec {
378 struct mf_subfield src;
379 union mf_subvalue src_imm;
382 struct mf_subfield dst;
387 * Used for NXAST_LEARN. */
388 struct ofpact_learn {
389 struct ofpact ofpact;
391 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
392 uint16_t hard_timeout; /* Max time before discarding (seconds). */
393 uint16_t priority; /* Priority level of flow entry. */
394 uint64_t cookie; /* Cookie for new flow. */
395 uint16_t flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
396 uint8_t table_id; /* Table to insert flow entry. */
397 uint16_t fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
398 uint16_t fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
400 unsigned int n_specs;
401 struct ofpact_learn_spec specs[];
406 * Used for NXAST_MULTIPATH. */
407 struct ofpact_multipath {
408 struct ofpact ofpact;
410 /* What fields to hash and how. */
411 enum nx_hash_fields fields;
412 uint16_t basis; /* Universal hash parameter. */
414 /* Multipath link choice algorithm to apply to hash value. */
415 enum nx_mp_algorithm algorithm;
416 uint16_t max_link; /* Number of output links, minus 1. */
417 uint32_t arg; /* Algorithm-specific argument. */
419 /* Where to store the result. */
420 struct mf_subfield dst;
425 * Used for NXAST_NOTE. */
427 struct ofpact ofpact;
434 * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
435 struct ofpact_cnt_ids {
436 struct ofpact ofpact;
438 /* Controller ids. */
439 unsigned int n_controllers;
445 * Used for OFPIT11_GOTO_TABLE */
446 struct ofpact_goto_table {
447 struct ofpact ofpact;
451 /* Converting OpenFlow to ofpacts. */
452 enum ofperr ofpacts_pull_openflow10(struct ofpbuf *openflow,
453 unsigned int actions_len,
454 struct ofpbuf *ofpacts);
455 enum ofperr ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
456 unsigned int actions_len,
457 struct ofpbuf *ofpacts);
458 enum ofperr ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
459 unsigned int instructions_len,
460 struct ofpbuf *ofpacts);
461 enum ofperr ofpacts_check(const struct ofpact[], size_t ofpacts_len,
462 const struct flow *, int max_ports);
463 enum ofperr ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len);
465 /* Converting ofpacts to OpenFlow. */
466 void ofpacts_put_openflow10(const struct ofpact[], size_t ofpacts_len,
467 struct ofpbuf *openflow);
468 size_t ofpacts_put_openflow11_actions(const struct ofpact[], size_t ofpacts_len,
469 struct ofpbuf *openflow);
470 void ofpacts_put_openflow11_instructions(const struct ofpact[],
472 struct ofpbuf *openflow);
474 /* Working with ofpacts. */
475 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
477 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
478 const struct ofpact b[], size_t b_len);
480 /* Formatting ofpacts.
482 * (For parsing ofpacts, see ofp-parse.h.) */
483 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
485 /* Internal use by the helpers below. */
486 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
487 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
489 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
490 * the following commonly useful functions:
492 * struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
494 * Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
495 * initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
496 * 'ofpacts->l2' to the returned action.
498 * After using this function to add a variable-length action, add the
499 * elements of the flexible array (e.g. with ofpbuf_put()), then use
500 * ofpact_update_len() to update the length embedded into the action.
501 * (Keep in mind the need to refresh the structure from 'ofpacts->l2' after
502 * adding data to 'ofpacts'.)
504 * struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
506 * Returns 'ofpact' cast to "struct <STRUCT> *". 'ofpact->type' must be
509 * as well as the following more rarely useful definitions:
511 * void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
513 * Initializes the parts of 'ofpact' that identify it as having type
514 * OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
518 * The size of the action structure. For a fixed-length action, this is
519 * sizeof(struct <STRUCT>). For a variable-length action, this is the
520 * offset to the variable-length part.
524 * An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
525 * multiple of OFPACT_ALIGNTO.
527 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) \
528 BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
530 enum { OFPACT_##ENUM##_RAW_SIZE \
531 = (offsetof(struct STRUCT, MEMBER) \
532 ? offsetof(struct STRUCT, MEMBER) \
533 : sizeof(struct STRUCT)) }; \
535 enum { OFPACT_##ENUM##_SIZE \
536 = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) }; \
538 static inline struct STRUCT * \
539 ofpact_get_##ENUM(const struct ofpact *ofpact) \
541 ovs_assert(ofpact->type == OFPACT_##ENUM); \
542 return (struct STRUCT *) ofpact; \
545 static inline struct STRUCT * \
546 ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
548 return ofpact_put(ofpacts, OFPACT_##ENUM, \
549 OFPACT_##ENUM##_RAW_SIZE); \
553 ofpact_init_##ENUM(struct STRUCT *ofpact) \
555 ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
556 OFPACT_##ENUM##_RAW_SIZE); \
561 /* Functions to use after adding ofpacts to a buffer. */
562 void ofpact_update_len(struct ofpbuf *, struct ofpact *);
563 void ofpact_pad(struct ofpbuf *);
565 /* OpenFlow 1.1 instructions.
566 * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
567 * It is enforced on parser from text string.
569 #define OVS_INSTRUCTIONS \
570 DEFINE_INST(OFPIT11_APPLY_ACTIONS, \
571 ofp11_instruction_actions, true, \
574 DEFINE_INST(OFPIT11_CLEAR_ACTIONS, \
575 ofp11_instruction, false, \
578 DEFINE_INST(OFPIT11_WRITE_ACTIONS, \
579 ofp11_instruction_actions, true, \
582 DEFINE_INST(OFPIT11_WRITE_METADATA, \
583 ofp11_instruction_write_metadata, false, \
586 DEFINE_INST(OFPIT11_GOTO_TABLE, \
587 ofp11_instruction_goto_table, false, \
590 enum ovs_instruction_type {
591 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
597 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
598 N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
604 ofpact_is_instruction(const struct ofpact *a)
606 /* XXX Write-Actions */
607 return a->type == OFPACT_CLEAR_ACTIONS
608 || a->type == OFPACT_WRITE_METADATA
609 || a->type == OFPACT_GOTO_TABLE;
612 const char *ofpact_instruction_name_from_type(enum ovs_instruction_type type);
613 int ofpact_instruction_type_from_name(const char *name);
615 void ofpact_set_field_init(struct ofpact_reg_load *load,
616 const struct mf_field *mf, const void *src);
618 #endif /* ofp-actions.h */