/*
- * Copyright (c) 2012, 2013, 2014, 2015 Nicira, Inc.
+ * Copyright (c) 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
/* Output. */ \
OFPACT(OUTPUT, ofpact_output, ofpact, "output") \
OFPACT(GROUP, ofpact_group, ofpact, "group") \
- OFPACT(CONTROLLER, ofpact_controller, ofpact, "controller") \
+ OFPACT(CONTROLLER, ofpact_controller, userdata, "controller") \
OFPACT(ENQUEUE, ofpact_enqueue, ofpact, "enqueue") \
OFPACT(OUTPUT_REG, ofpact_output_reg, ofpact, "output_reg") \
OFPACT(BUNDLE, ofpact_bundle, slaves, "bundle") \
#define OFPACT_ALIGNTO 8
#define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
+/* Expands to an anonymous union that contains:
+ *
+ * - MEMBERS in a nested anonymous struct.
+ *
+ * - An array as large as MEMBERS plus padding to a multiple of 8 bytes.
+ *
+ * The effect is to pad MEMBERS to a multiple of 8 bytes. */
+#define OFPACT_PADDED_MEMBERS(MEMBERS) \
+ union { \
+ struct { MEMBERS }; \
+ uint8_t pad[OFPACT_ALIGN(sizeof(struct { MEMBERS }))]; \
+ }
+
/* Returns the ofpact following 'ofpact'. */
static inline struct ofpact *
ofpact_next(const struct ofpact *ofpact)
uint16_t max_len; /* Maximum length to send to controller. */
uint16_t controller_id; /* Controller ID to send packet-in. */
enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
+
+ /* If true, this action freezes packet traversal of the OpenFlow tables and
+ * adds a continuation to the packet-in message, that a controller can use
+ * to resume that traversal. */
+ bool pause;
+
+ /* Arbitrary data to include in the packet-in message (currently, only in
+ * NXT_PACKET_IN2). */
+ uint16_t userdata_len;
+ uint8_t userdata[];
};
/* OFPACT_ENQUEUE.
*
* Used for OFPIT11_WRITE_ACTIONS. */
struct ofpact_nest {
- struct ofpact ofpact;
- uint8_t pad[PAD_SIZE(sizeof(struct ofpact), OFPACT_ALIGNTO)];
+ OFPACT_PADDED_MEMBERS(struct ofpact ofpact;);
struct ofpact actions[];
};
BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions) % OFPACT_ALIGNTO == 0);
* that the packet should not be recirculated. */
#define NX_CT_RECIRC_NONE OFPTT_ALL
-/* We want to determine the size of these elements at compile time to ensure
- * actions alignment, but we also want to allow ofpact_conntrack to have
- * basic _put(), _get(), etc accessors defined below which access these
- * members directly from ofpact_conntrack. An anonymous struct will serve
- * both of these purposes. */
-#define CT_MEMBERS \
-struct { \
- struct ofpact ofpact; \
- uint16_t flags; \
- uint16_t zone_imm; \
- struct mf_subfield zone_src; \
- uint16_t alg; \
- uint8_t recirc_table; \
-}
-
#if !defined(IPPORT_FTP)
#define IPPORT_FTP 21
#endif
*
* Used for NXAST_CT. */
struct ofpact_conntrack {
- union {
- CT_MEMBERS;
- uint8_t pad[OFPACT_ALIGN(sizeof(CT_MEMBERS))];
- };
+ OFPACT_PADDED_MEMBERS(
+ struct ofpact ofpact;
+ uint16_t flags;
+ uint16_t zone_imm;
+ struct mf_subfield zone_src;
+ uint16_t alg;
+ uint8_t recirc_table;
+ );
struct ofpact actions[0];
};
BUILD_ASSERT_DECL(offsetof(struct ofpact_conntrack, actions)
*
* struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
*
- * Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
+ * Appends a new 'ofpact', of length OFPACT_<ENUM>_SIZE, to 'ofpacts',
* initializes it with ofpact_init_<ENUM>(), and returns it. Also sets
* 'ofpacts->header' to the returned action.
*
* After using this function to add a variable-length action, add the
* elements of the flexible array (e.g. with ofpbuf_put()), then use
- * ofpact_update_len() to update the length embedded into the action.
- * (Keep in mind the need to refresh the structure from 'ofpacts->frame'
- * after adding data to 'ofpacts'.)
+ * ofpact_finish() to pad the action to a multiple of OFPACT_ALIGNTO bytes
+ * and update its embedded length field. (Keep in mind the need to refresh
+ * the structure from 'ofpacts->header' after adding data to 'ofpacts'.)
*
* struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
*
* void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
*
* Initializes the parts of 'ofpact' that identify it as having type
- * OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
- *
- * <ENUM>_RAW_SIZE
- *
- * The size of the action structure. For a fixed-length action, this is
- * sizeof(struct <STRUCT>). For a variable-length action, this is the
- * offset to the variable-length part.
+ * OFPACT_<ENUM> and length OFPACT_<ENUM>_SIZE and zeros the rest.
*
* <ENUM>_SIZE
*
- * An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
- * multiple of OFPACT_ALIGNTO.
+ * The size of the action structure. For a fixed-length action, this is
+ * sizeof(struct <STRUCT>) rounded up to a multiple of OFPACT_ALIGNTO. For
+ * a variable-length action, this is the offset to the variable-length
+ * part.
*/
#define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0); \
\
- enum { OFPACT_##ENUM##_RAW_SIZE \
+ enum { OFPACT_##ENUM##_SIZE \
= (offsetof(struct STRUCT, MEMBER) \
? offsetof(struct STRUCT, MEMBER) \
- : sizeof(struct STRUCT)) }; \
- \
- enum { OFPACT_##ENUM##_SIZE \
- = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) }; \
+ : OFPACT_ALIGN(sizeof(struct STRUCT))) }; \
\
static inline struct STRUCT * \
ofpact_get_##ENUM(const struct ofpact *ofpact) \
ofpact_put_##ENUM(struct ofpbuf *ofpacts) \
{ \
return ofpact_put(ofpacts, OFPACT_##ENUM, \
- OFPACT_##ENUM##_RAW_SIZE); \
+ OFPACT_##ENUM##_SIZE); \
} \
\
static inline void \
ofpact_init_##ENUM(struct STRUCT *ofpact) \
{ \
ofpact_init(&ofpact->ofpact, OFPACT_##ENUM, \
- OFPACT_##ENUM##_RAW_SIZE); \
+ OFPACT_##ENUM##_SIZE); \
}
OFPACTS
#undef OFPACT
-/* Functions to use after adding ofpacts to a buffer. */
-void ofpact_update_len(struct ofpbuf *, struct ofpact *);
-void ofpact_pad(struct ofpbuf *);
+/* Call after adding the variable-length part to a variable-length action. */
+void ofpact_finish(struct ofpbuf *, struct ofpact *);
/* Additional functions for composing ofpacts. */
struct ofpact_set_field *ofpact_put_reg_load(struct ofpbuf *ofpacts);