summaryrefslogtreecommitdiff
path: root/include/openflow
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2014-08-11 12:50:36 -0700
committerBen Pfaff <blp@nicira.com>2014-08-11 12:57:17 -0700
commitc2d936a44fa612e88c743c6e7b367a9813093202 (patch)
tree4d95eb5499b40791c87bf8e6aa1003cf06ef4a43 /include/openflow
parent8f2cded496c13307eff2d8bd0f01dee389cf6166 (diff)
downloadopenvswitch-c2d936a44fa612e88c743c6e7b367a9813093202.tar.gz
ofp-actions: Centralize all OpenFlow action code for maintainability.
Until now, knowledge about OpenFlow has been somewhat scattered around the tree. Some of it is in ofp-actions, some of it is in ofp-util, some in separate files for individual actions, and most of the wire format declarations are in include/openflow. This commit centralizes all of that in ofp-actions. Encoding and decoding OpenFlow actions was previously broken up by OpenFlow version. This was OK with only OpenFlow 1.0 and 1.1, but each additional version added a new wrapper around the existing ones, which started to become hard to understand. This commit merges all of the processing for the different versions, to the extent that they are similar, making the version differences clearer. Previously, ofp-actions contained OpenFlow encoding and decoding, plus ofpact formatting, but OpenFlow parsing was separated into ofp-parse, which seems an odd division. This commit moves the parsing code into ofp-actions with the rest of the code. Before this commit, the four main bits of code associated with a particular ofpact--OpenFlow encoding and decoding, ofpact formatting and parsing--were all found far away from each other. This often made it hard to see what was going on for a particular ofpact, since you had to search around to many different pieces of code. This commit reorganizes so that all of the code for a given ofpact is in a single place. As a code refactoring, this commit has little visible behavioral change. The update to ofproto-dpif.at illustrates one minor bug fix as a side effect: a flow that was added with the action "dec_ttl" (a standard OpenFlow action) was previously formatted as "dec_ttl(0)" (using a Nicira extension to specifically direct packets bounced to the controller because of too-low TTL), but after this commit it is correctly formatted as "dec_ttl". The other visible effect is to drop support for the Nicira extension dec_ttl action in OpenFlow 1.1 and later in favor of the equivalent standard action. It seems unlikely that anyone was really using the Nicira extension in OF1.1 or later. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Jarno Rajahalme <jrajahalme@nicira.com>
Diffstat (limited to 'include/openflow')
-rw-r--r--include/openflow/nicira-ext.h1014
-rw-r--r--include/openflow/openflow-1.0.h50
-rw-r--r--include/openflow/openflow-1.1.h123
-rw-r--r--include/openflow/openflow-1.2.h20
-rw-r--r--include/openflow/openflow-1.3.h21
-rw-r--r--include/openflow/openflow-common.h76
6 files changed, 5 insertions, 1299 deletions
diff --git a/include/openflow/nicira-ext.h b/include/openflow/nicira-ext.h
index 3bd2b15ec..bbf3388fa 100644
--- a/include/openflow/nicira-ext.h
+++ b/include/openflow/nicira-ext.h
@@ -279,902 +279,6 @@ struct nx_async_config {
};
OFP_ASSERT(sizeof(struct nx_async_config) == 24);
-/* Nicira vendor flow actions. */
-
-enum nx_action_subtype {
- NXAST_SNAT__OBSOLETE, /* No longer used. */
- NXAST_RESUBMIT, /* struct nx_action_resubmit */
- NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
- NXAST_DROP_SPOOFED_ARP__OBSOLETE,
- NXAST_SET_QUEUE, /* struct nx_action_set_queue */
- NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
- NXAST_REG_MOVE, /* struct nx_action_reg_move */
- NXAST_REG_LOAD, /* struct nx_action_reg_load */
- NXAST_NOTE, /* struct nx_action_note */
- NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
- NXAST_MULTIPATH, /* struct nx_action_multipath */
- NXAST_AUTOPATH__OBSOLETE, /* No longer used. */
- NXAST_BUNDLE, /* struct nx_action_bundle */
- NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
- NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
- NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
- NXAST_LEARN, /* struct nx_action_learn */
- NXAST_EXIT, /* struct nx_action_header */
- NXAST_DEC_TTL, /* struct nx_action_header */
- NXAST_FIN_TIMEOUT, /* struct nx_action_fin_timeout */
- NXAST_CONTROLLER, /* struct nx_action_controller */
- NXAST_DEC_TTL_CNT_IDS, /* struct nx_action_cnt_ids */
- NXAST_WRITE_METADATA, /* struct nx_action_write_metadata */
- NXAST_PUSH_MPLS, /* struct nx_action_push_mpls */
- NXAST_POP_MPLS, /* struct nx_action_pop_mpls */
- NXAST_SET_MPLS_TTL, /* struct nx_action_ttl */
- NXAST_DEC_MPLS_TTL, /* struct nx_action_header */
- NXAST_STACK_PUSH, /* struct nx_action_stack */
- NXAST_STACK_POP, /* struct nx_action_stack */
- NXAST_SAMPLE, /* struct nx_action_sample */
- NXAST_SET_MPLS_LABEL, /* struct nx_action_ttl */
- NXAST_SET_MPLS_TC, /* struct nx_action_ttl */
-};
-
-/* Header for Nicira-defined actions. */
-struct nx_action_header {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_*. */
- uint8_t pad[6];
-};
-OFP_ASSERT(sizeof(struct nx_action_header) == 16);
-
-/* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
- *
- * These actions search one of the switch's flow tables:
- *
- * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
- * it specifies the table to search.
- *
- * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
- * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
- * table, that is, the OpenFlow flow table that contains the flow from
- * which this action was obtained. If this action did not come from a
- * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
- * is the current table.
- *
- * The flow table lookup uses a flow that may be slightly modified from the
- * original lookup:
- *
- * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
- * is used as the flow's in_port.
- *
- * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
- * then its value is used as the flow's in_port. Otherwise, the original
- * in_port is used.
- *
- * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
- * resubmit action, then the flow is updated with the new values.
- *
- * Following the lookup, the original in_port is restored.
- *
- * If the modified flow matched in the flow table, then the corresponding
- * actions are executed. Afterward, actions following the resubmit in the
- * original set of actions, if any, are executed; any changes made to the
- * packet (e.g. changes to VLAN) by secondary actions persist when those
- * actions are executed, although the original in_port is restored.
- *
- * Resubmit actions may be used any number of times within a set of actions.
- *
- * Resubmit actions may nest to an implementation-defined depth. Beyond this
- * implementation-defined depth, further resubmit actions are simply ignored.
- *
- * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
- * 'pad' to be all-bits-zero.
- *
- * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
- * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
- */
-struct nx_action_resubmit {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_RESUBMIT. */
- ovs_be16 in_port; /* New in_port for checking flow table. */
- uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
-
-/* Action structure for NXAST_SET_TUNNEL.
- *
- * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
- * bits of the tunnel ID are set to 0. */
-struct nx_action_set_tunnel {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
- uint8_t pad[2];
- ovs_be32 tun_id; /* Tunnel ID. */
-};
-OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
-
-/* Action structure for NXAST_SET_TUNNEL64.
- *
- * Sets the encapsulating tunnel ID to a 64-bit value. */
-struct nx_action_set_tunnel64 {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 24. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
- uint8_t pad[6];
- ovs_be64 tun_id; /* Tunnel ID. */
-};
-OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
-
-/* Action structure for NXAST_SET_QUEUE.
- *
- * Set the queue that should be used when packets are output. This is similar
- * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
- * an argument. This allows the queue to be defined before the port is
- * known. */
-struct nx_action_set_queue {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SET_QUEUE. */
- uint8_t pad[2];
- ovs_be32 queue_id; /* Where to enqueue packets. */
-};
-OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
-
-/* Action structure for NXAST_POP_QUEUE.
- *
- * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
- * were used. Only the original queue can be restored this way; no stack is
- * maintained. */
-struct nx_action_pop_queue {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_POP_QUEUE. */
- uint8_t pad[6];
-};
-OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
-
-/* Action structure for NXAST_REG_MOVE.
- *
- * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
- * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
- * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
- * the next most significant bit, and so on.
- *
- * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
- * sense to use nxm_hasmask=1 because the action does not do any kind of
- * matching; it uses the actual value of a field.)
- *
- * The following nxm_header values are potentially acceptable as 'src':
- *
- * - NXM_OF_IN_PORT
- * - NXM_OF_ETH_DST
- * - NXM_OF_ETH_SRC
- * - NXM_OF_ETH_TYPE
- * - NXM_OF_VLAN_TCI
- * - NXM_OF_IP_TOS
- * - NXM_OF_IP_PROTO
- * - NXM_OF_IP_SRC
- * - NXM_OF_IP_DST
- * - NXM_OF_TCP_SRC
- * - NXM_OF_TCP_DST
- * - NXM_OF_UDP_SRC
- * - NXM_OF_UDP_DST
- * - NXM_OF_ICMP_TYPE
- * - NXM_OF_ICMP_CODE
- * - NXM_OF_ARP_OP
- * - NXM_OF_ARP_SPA
- * - NXM_OF_ARP_TPA
- * - NXM_NX_TUN_ID
- * - NXM_NX_ARP_SHA
- * - NXM_NX_ARP_THA
- * - NXM_NX_ICMPV6_TYPE
- * - NXM_NX_ICMPV6_CODE
- * - NXM_NX_ND_SLL
- * - NXM_NX_ND_TLL
- * - NXM_NX_REG(idx) for idx in the switch's accepted range.
- * - NXM_NX_PKT_MARK
- * - NXM_NX_TUN_IPV4_SRC
- * - NXM_NX_TUN_IPV4_DST
- *
- * The following nxm_header values are potentially acceptable as 'dst':
- *
- * - NXM_OF_ETH_DST
- * - NXM_OF_ETH_SRC
- * - NXM_OF_IP_TOS
- * - NXM_OF_IP_SRC
- * - NXM_OF_IP_DST
- * - NXM_OF_TCP_SRC
- * - NXM_OF_TCP_DST
- * - NXM_OF_UDP_SRC
- * - NXM_OF_UDP_DST
- * - NXM_NX_ARP_SHA
- * - NXM_NX_ARP_THA
- * - NXM_OF_ARP_OP
- * - NXM_OF_ARP_SPA
- * - NXM_OF_ARP_TPA
- * Modifying any of the above fields changes the corresponding packet
- * header.
- *
- * - NXM_OF_IN_PORT
- *
- * - NXM_NX_REG(idx) for idx in the switch's accepted range.
- *
- * - NXM_NX_PKT_MARK
- *
- * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
- * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
- * header (if any), ignoring the other bits. Setting a value with CFI=1
- * adds or modifies the 802.1Q header appropriately, setting the TCI field
- * to the field's new value (with the CFI bit masked out).
- *
- * - NXM_NX_TUN_ID, NXM_NX_TUN_IPV4_SRC, NXM_NX_TUN_IPV4_DST. Modifying
- * any of these values modifies the corresponding tunnel header field used
- * for the packet's next tunnel encapsulation, if allowed by the
- * configuration of the output tunnel port.
- *
- * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
- * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
- * used only if the flow's nx_match includes an nxm_entry that specifies
- * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
- *
- * The switch will reject actions for which src_ofs+n_bits is greater than the
- * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
- * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
- *
- * This action behaves properly when 'src' overlaps with 'dst', that is, it
- * behaves as if 'src' were copied out to a temporary buffer, then the
- * temporary buffer copied to 'dst'.
- */
-struct nx_action_reg_move {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 24. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_REG_MOVE. */
- ovs_be16 n_bits; /* Number of bits. */
- ovs_be16 src_ofs; /* Starting bit offset in source. */
- ovs_be16 dst_ofs; /* Starting bit offset in destination. */
- ovs_be32 src; /* Source register. */
- ovs_be32 dst; /* Destination register. */
-};
-OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
-
-/* Action structure for NXAST_REG_LOAD.
- *
- * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
- * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
- * starts at 0 for the least-significant bit, 1 for the next most significant
- * bit, and so on.
- *
- * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
- * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
- * loading them.
- *
- * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
- * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
- * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
- * also stored as one less than its true value:
- *
- * 15 6 5 0
- * +------------------------------+------------------+
- * | ofs | n_bits - 1 |
- * +------------------------------+------------------+
- *
- * The switch will reject actions for which ofs+n_bits is greater than the
- * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
- * greater are set to 1, with error type OFPET_BAD_ACTION, code
- * OFPBAC_BAD_ARGUMENT.
- */
-struct nx_action_reg_load {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 24. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_REG_LOAD. */
- ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
- ovs_be32 dst; /* Destination register. */
- ovs_be64 value; /* Immediate value. */
-};
-OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
-
-/* Action structure for NXAST_STACK_PUSH and NXAST_STACK_POP.
- *
- * Pushes (or pops) field[offset: offset + n_bits] to (or from)
- * top of the stack.
- */
-struct nx_action_stack {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_STACK_PUSH or NXAST_STACK_POP. */
- ovs_be16 offset; /* Bit offset into the field. */
- ovs_be32 field; /* The field used for push or pop. */
- ovs_be16 n_bits; /* (n_bits + 1) bits of the field. */
- uint8_t zero[6]; /* Reserved, must be zero. */
-};
-OFP_ASSERT(sizeof(struct nx_action_stack) == 24);
-
-/* Action structure for NXAST_NOTE.
- *
- * This action has no effect. It is variable length. The switch does not
- * attempt to interpret the user-defined 'note' data in any way. A controller
- * can use this action to attach arbitrary metadata to a flow.
- *
- * This action might go away in the future.
- */
-struct nx_action_note {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* A multiple of 8, but at least 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_NOTE. */
- uint8_t note[6]; /* Start of user-defined data. */
- /* Possibly followed by additional user-defined data. */
-};
-OFP_ASSERT(sizeof(struct nx_action_note) == 16);
-
-/* Action structure for NXAST_MULTIPATH.
- *
- * This action performs the following steps in sequence:
- *
- * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
- * Refer to the definition of "enum nx_mp_fields" for details.
- *
- * The 'basis' value is used as a universal hash parameter, that is,
- * different values of 'basis' yield different hash functions. The
- * particular universal hash function used is implementation-defined.
- *
- * The hashed fields' values are drawn from the current state of the
- * flow, including all modifications that have been made by actions up to
- * this point.
- *
- * 2. Applies the multipath link choice algorithm specified by 'algorithm',
- * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
- * for details.
- *
- * The output of the algorithm is 'link', an unsigned integer less than
- * or equal to 'max_link'.
- *
- * Some algorithms use 'arg' as an additional argument.
- *
- * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
- * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
- * action.
- *
- * The switch will reject actions that have an unknown 'fields', or an unknown
- * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
- * in which 'max_link' is greater than or equal to 2**n_bits, with error type
- * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
- */
-struct nx_action_multipath {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 32. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_MULTIPATH. */
-
- /* What fields to hash and how. */
- ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
- ovs_be16 basis; /* Universal hash parameter. */
- ovs_be16 pad0;
-
- /* Multipath link choice algorithm to apply to hash value. */
- ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
- ovs_be16 max_link; /* Number of output links, minus 1. */
- ovs_be32 arg; /* Algorithm-specific argument. */
- ovs_be16 pad1;
-
- /* Where to store the result. */
- ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
- ovs_be32 dst; /* Destination. */
-};
-OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
-
-/* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
- *
- * In the descriptions below, 'n_links' is max_link + 1. */
-enum nx_mp_algorithm {
- /* link = hash(flow) % n_links.
- *
- * Redistributes all traffic when n_links changes. O(1) performance. See
- * RFC 2992.
- *
- * Use UINT16_MAX for max_link to get a raw hash value. */
- NX_MP_ALG_MODULO_N,
-
- /* link = hash(flow) / (MAX_HASH / n_links).
- *
- * Redistributes between one-quarter and one-half of traffic when n_links
- * changes. O(1) performance. See RFC 2992.
- */
- NX_MP_ALG_HASH_THRESHOLD,
-
- /* for i in [0,n_links):
- * weights[i] = hash(flow, i)
- * link = { i such that weights[i] >= weights[j] for all j != i }
- *
- * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
- * performance. If n_links is greater than a threshold (currently 64, but
- * subject to change), Open vSwitch will substitute another algorithm
- * automatically. See RFC 2992. */
- NX_MP_ALG_HRW, /* Highest Random Weight. */
-
- /* i = 0
- * repeat:
- * i = i + 1
- * link = hash(flow, i) % arg
- * while link > max_link
- *
- * Redistributes 1/n_links of traffic when n_links changes. O(1)
- * performance when arg/max_link is bounded by a constant.
- *
- * Redistributes all traffic when arg changes.
- *
- * arg must be greater than max_link and for best performance should be no
- * more than approximately max_link * 2. If arg is outside the acceptable
- * range, Open vSwitch will automatically substitute the least power of 2
- * greater than max_link.
- *
- * This algorithm is specific to Open vSwitch.
- */
- NX_MP_ALG_ITER_HASH /* Iterative Hash. */
-};
-
-/* Action structure for NXAST_LEARN.
- *
- * This action adds or modifies a flow in an OpenFlow table, similar to
- * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
- * specified idle timeout, hard timeout, priority, cookie, and flags. The new
- * flow's match criteria and actions are built by applying each of the series
- * of flow_mod_spec elements included as part of the action.
- *
- * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
- * a no-op used for padding the action as a whole to a multiple of 8 bytes in
- * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
- * bits from a source to a destination. In this case, the header contains
- * multiple fields:
- *
- * 15 14 13 12 11 10 0
- * +------+---+------+---------------------------------+
- * | 0 |src| dst | n_bits |
- * +------+---+------+---------------------------------+
- *
- * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
- * following table summarizes the meaning of each possible combination.
- * Details follow the table:
- *
- * src dst meaning
- * --- --- ----------------------------------------------------------
- * 0 0 Add match criteria based on value in a field.
- * 1 0 Add match criteria based on an immediate value.
- * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
- * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
- * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
- * All other combinations are undefined and not allowed.
- *
- * The flow_mod_spec header is followed by a source specification and a
- * destination specification. The format and meaning of the source
- * specification depends on 'src':
- *
- * - If 'src' is 0, the source bits are taken from a field in the flow to
- * which this action is attached. (This should be a wildcarded field. If
- * its value is fully specified then the source bits being copied have
- * constant values.)
- *
- * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
- * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
- * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
- * 'field' and 'ofs' are subject to the same restrictions as the source
- * field in NXAST_REG_MOVE.
- *
- * - If 'src' is 1, the source bits are a constant value. The source
- * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
- * number in network order, the source bits are the 'n_bits'
- * least-significant bits. The switch will report an error if other bits
- * in the constant are nonzero.
- *
- * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
- * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
- * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
- * meaning of the flow_mod_spec depends on 'dst':
- *
- * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
- * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
- * packet equal the source bits. 'field' may be any nxm_header with
- * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
- *
- * Order is significant. Earlier flow_mod_specs must satisfy any
- * prerequisites for matching fields specified later, by copying constant
- * values into prerequisite fields.
- *
- * The switch will reject flow_mod_specs that do not satisfy NXM masking
- * restrictions.
- *
- * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
- * the new flow. The new flow copies the source bits into
- * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
- * flow_mod_specs.
- *
- * A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
- * greater than 64 yields multiple NXAST_REG_LOAD actions.
- *
- * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
- * empty. It has the following meaning:
- *
- * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
- * The new flow outputs to the OpenFlow port specified by the source field.
- * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
- * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
- * may not be used.
- *
- * Resource Management
- * -------------------
- *
- * A switch has a finite amount of flow table space available for learning.
- * When this space is exhausted, no new learning table entries will be learned
- * until some existing flow table entries expire. The controller should be
- * prepared to handle this by flooding (which can be implemented as a
- * low-priority flow).
- *
- * If a learned flow matches a single TCP stream with a relatively long
- * timeout, one may make the best of resource constraints by setting
- * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
- * both, to shorter timeouts. When either of these is specified as a nonzero
- * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
- * the learned flow.
- *
- * Examples
- * --------
- *
- * The following examples give a prose description of the flow_mod_specs along
- * with informal notation for how those would be represented and a hex dump of
- * the bytes that would be required.
- *
- * These examples could work with various nx_action_learn parameters. Typical
- * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
- * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
- *
- * 1. Learn input port based on the source MAC, with lookup into
- * NXM_NX_REG1[16:31] by resubmit to in_port=99:
- *
- * Match on in_port=99:
- * ovs_be16(src=1, dst=0, n_bits=16), 20 10
- * ovs_be16(99), 00 63
- * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
- *
- * Match Ethernet destination on Ethernet source from packet:
- * ovs_be16(src=0, dst=0, n_bits=48), 00 30
- * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
- * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
- *
- * Set NXM_NX_REG1[16:31] to the packet's input port:
- * ovs_be16(src=0, dst=1, n_bits=16), 08 10
- * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
- * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
- *
- * Given a packet that arrived on port A with Ethernet source address B,
- * this would set up the flow "in_port=99, dl_dst=B,
- * actions=load:A->NXM_NX_REG1[16..31]".
- *
- * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
- * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
- * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
- *
- * 2. Output to input port based on the source MAC and VLAN VID, with lookup
- * into NXM_NX_REG1[16:31]:
- *
- * Match on same VLAN ID as packet:
- * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
- * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
- * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
- *
- * Match Ethernet destination on Ethernet source from packet:
- * ovs_be16(src=0, dst=0, n_bits=48), 00 30
- * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
- * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
- *
- * Output to the packet's input port:
- * ovs_be16(src=0, dst=2, n_bits=16), 10 10
- * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
- *
- * Given a packet that arrived on port A with Ethernet source address B in
- * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
- * actions=output:A".
- *
- * In syntax accepted by ovs-ofctl, this action is:
- * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
- * output:NXM_OF_IN_PORT[])
- *
- * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
- * 10-second MAC expiration time to make it easier to see what's going on
- *
- * ovs-vsctl del-controller br0
- * ovs-ofctl del-flows br0
- * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
- hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
- NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
- output:NXM_OF_IN_PORT[]), resubmit(,1)"
- * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
- *
- * You can then dump the MAC learning table with:
- *
- * ovs-ofctl dump-flows br0 table=1
- *
- * Usage Advice
- * ------------
- *
- * For best performance, segregate learned flows into a table that is not used
- * for any other flows except possibly for a lowest-priority "catch-all" flow
- * (a flow with no match criteria). If different learning actions specify
- * different match criteria, use different tables for the learned flows.
- *
- * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
- * These timeouts apply to the flow that is added, which means that a flow with
- * an idle timeout will expire when no traffic has been sent *to* the learned
- * address. This is not usually the intent in MAC learning; instead, we want
- * the MAC learn entry to expire when no traffic has been sent *from* the
- * learned address. Use a hard timeout for that.
- */
-struct nx_action_learn {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* At least 24. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_LEARN. */
- ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
- ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
- ovs_be16 priority; /* Priority level of flow entry. */
- ovs_be64 cookie; /* Cookie for new flow. */
- ovs_be16 flags; /* NX_LEARN_F_*. */
- uint8_t table_id; /* Table to insert flow entry. */
- uint8_t pad; /* Must be zero. */
- ovs_be16 fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
- ovs_be16 fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
- /* Followed by a sequence of flow_mod_spec elements, as described above,
- * until the end of the action is reached. */
-};
-OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
-
-/* Bits for 'flags' in struct nx_action_learn.
- *
- * If NX_LEARN_F_SEND_FLOW_REM is set, then the learned flows will have their
- * OFPFF_SEND_FLOW_REM flag set.
- *
- * If NX_LEARN_F_DELETE_LEARNED is set, then removing this action will delete
- * all the flows from the learn action's 'table_id' that have the learn
- * action's 'cookie'. Important points:
- *
- * - The deleted flows include those created by this action, those created
- * by other learn actions with the same 'table_id' and 'cookie', those
- * created by flow_mod requests by a controller in the specified table
- * with the specified cookie, and those created through any other
- * means.
- *
- * - If multiple flows specify "learn" actions with
- * NX_LEARN_F_DELETE_LEARNED with the same 'table_id' and 'cookie', then
- * no deletion occurs until all of those "learn" actions are deleted.
- *
- * - Deleting a flow that contains a learn action is the most obvious way
- * to delete a learn action. Modifying a flow's actions, or replacing it
- * by a new flow, can also delete a learn action. Finally, replacing a
- * learn action with NX_LEARN_F_DELETE_LEARNED with a learn action
- * without that flag also effectively deletes the learn action and can
- * trigger flow deletion.
- *
- * NX_LEARN_F_DELETE_LEARNED was added in Open vSwitch 2.4. */
-enum nx_learn_flags {
- NX_LEARN_F_SEND_FLOW_REM = 1 << 0,
- NX_LEARN_F_DELETE_LEARNED = 1 << 1,
-};
-
-#define NX_LEARN_N_BITS_MASK 0x3ff
-
-#define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
-#define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
-#define NX_LEARN_SRC_MASK (1 << 13)
-
-#define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
-#define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
-#define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
-#define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
-#define NX_LEARN_DST_MASK (3 << 11)
-
-/* Action structure for NXAST_FIN_TIMEOUT.
- *
- * This action changes the idle timeout or hard timeout, or both, of this
- * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
- * When such a packet is observed, the action reduces the rule's idle timeout
- * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'. This
- * action has no effect on an existing timeout that is already shorter than the
- * one that the action specifies. A 'fin_idle_timeout' or 'fin_hard_timeout'
- * of zero has no effect on the respective timeout.
- *
- * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
- * 'fin_hard_timeout' specifies time since the flow's creation, not since the
- * receipt of the FIN or RST.
- *
- * This is useful for quickly discarding learned TCP flows that otherwise will
- * take a long time to expire.
- *
- * This action is intended for use with an OpenFlow rule that matches only a
- * single TCP flow. If the rule matches multiple TCP flows (e.g. it wildcards
- * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
- * RST in any of those flows will cause the entire OpenFlow rule to expire
- * early, which is not normally desirable.
- */
-struct nx_action_fin_timeout {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_FIN_TIMEOUT. */
- ovs_be16 fin_idle_timeout; /* New idle timeout, if nonzero. */
- ovs_be16 fin_hard_timeout; /* New hard timeout, if nonzero. */
- ovs_be16 pad; /* Must be zero. */
-};
-OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
-
-/* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
- *
- * The bundle actions choose a slave from a supplied list of options.
- * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
- * selection to a register.
- *
- * The list of possible slaves follows the nx_action_bundle structure. The size
- * of each slave is governed by its type as indicated by the 'slave_type'
- * parameter. The list of slaves should be padded at its end with zeros to make
- * the total length of the action a multiple of 8.
- *
- * Switches infer from the 'slave_type' parameter the size of each slave. All
- * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
- * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
- * 2 byte width. Switches should reject actions which indicate unknown or
- * unsupported slave types.
- *
- * Switches use a strategy dictated by the 'algorithm' parameter to choose a
- * slave. If the switch does not support the specified 'algorithm' parameter,
- * it should reject the action.
- *
- * Several algorithms take into account liveness when selecting slaves. The
- * liveness of a slave is implementation defined (with one exception), but will
- * generally take into account things like its carrier status and the results
- * of any link monitoring protocols which happen to be running on it. In order
- * to give controllers a place-holder value, the OFPP_NONE port is always
- * considered live.
- *
- * Some slave selection strategies require the use of a hash function, in which
- * case the 'fields' and 'basis' parameters should be populated. The 'fields'
- * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
- * hash. Refer to the definition of "enum nx_hash_fields" for details. The
- * 'basis' parameter is used as a universal hash parameter. Different values
- * of 'basis' yield different hash results.
- *
- * The 'zero' parameter at the end of the action structure is reserved for
- * future use. Switches are required to reject actions which have nonzero
- * bytes in the 'zero' field.
- *
- * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
- * should reject actions which have nonzero bytes in either of these fields.
- *
- * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
- * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
- * similar to those for the NXAST_REG_LOAD action. */
-struct nx_action_bundle {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length including slaves. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
-
- /* Slave choice algorithm to apply to hash value. */
- ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
-
- /* What fields to hash and how. */
- ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
- ovs_be16 basis; /* Universal hash parameter. */
-
- ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
- ovs_be16 n_slaves; /* Number of slaves. */
-
- ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
- ovs_be32 dst; /* Destination. */
-
- uint8_t zero[4]; /* Reserved. Must be zero. */
-};
-OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
-
-/* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
- *
- * In the descriptions below, 'slaves' is the list of possible slaves in the
- * order they appear in the OpenFlow action. */
-enum nx_bd_algorithm {
- /* Chooses the first live slave listed in the bundle.
- *
- * O(n_slaves) performance. */
- NX_BD_ALG_ACTIVE_BACKUP,
-
- /* for i in [0,n_slaves):
- * weights[i] = hash(flow, i)
- * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
- *
- * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
- * O(n_slaves) performance.
- *
- * Uses the 'fields' and 'basis' parameters. */
- NX_BD_ALG_HRW /* Highest Random Weight. */
-};
-
-
-/* Action structure for NXAST_DEC_TTL_CNT_IDS.
- *
- * If the packet is not IPv4 or IPv6, does nothing. For IPv4 or IPv6, if the
- * TTL or hop limit is at least 2, decrements it by 1. Otherwise, if TTL or
- * hop limit is 0 or 1, sends a packet-in to the controllers with each of the
- * 'n_controllers' controller IDs specified in 'cnt_ids'.
- *
- * (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is
- * sent only to controllers with id 0.)
- */
-struct nx_action_cnt_ids {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length including slaves. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_DEC_TTL_CNT_IDS. */
-
- ovs_be16 n_controllers; /* Number of controllers. */
- uint8_t zeros[4]; /* Must be zero. */
-
- /* Followed by 1 or more controller ids.
- *
- * uint16_t cnt_ids[]; // Controller ids.
- * uint8_t pad[]; // Must be 0 to 8-byte align cnt_ids[].
- */
-};
-OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16);
-
-
-/* Action structure for NXAST_OUTPUT_REG.
- *
- * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
- *
- * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
- * the NXAST_REG_LOAD action.
- *
- * The acceptable nxm_header values for 'src' are the same as the acceptable
- * nxm_header values for the 'src' field of NXAST_REG_MOVE.
- *
- * The 'max_len' field indicates the number of bytes to send when the chosen
- * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
- * field of OFPAT_OUTPUT.
- *
- * The 'zero' field is required to be zeroed for forward compatibility. */
-struct nx_action_output_reg {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* 24. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
-
- ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
- ovs_be32 src; /* Source. */
-
- ovs_be16 max_len; /* Max length to send to controller. */
-
- uint8_t zero[6]; /* Reserved, must be zero. */
-};
-OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
-
-/* NXAST_EXIT
- *
- * Discontinues action processing.
- *
- * The NXAST_EXIT action causes the switch to immediately halt processing
- * actions for the flow. Any actions which have already been processed are
- * executed by the switch. However, any further actions, including those which
- * may be in different tables, or different levels of the NXAST_RESUBMIT
- * hierarchy, will be ignored.
- *
- * Uses the nx_action_header structure. */
-
/* Flexible flow specifications (aka NXM = Nicira Extended Match).
*
* OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches. This
@@ -2044,30 +1148,6 @@ struct nx_controller_id {
ovs_be16 controller_id; /* New controller connection ID. */
};
OFP_ASSERT(sizeof(struct nx_controller_id) == 8);
-
-/* Action structure for NXAST_CONTROLLER.
- *
- * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER. In
- * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
- * specifying:
- *
- * - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
- *
- * - 'controller_id': The ID of the controller connection to which the
- * ofp_packet_in should be sent. The ofp_packet_in or nx_packet_in is
- * sent only to controllers that have the specified controller connection
- * ID. See "struct nx_controller_id" for more information. */
-struct nx_action_controller {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_CONTROLLER. */
- ovs_be16 max_len; /* Maximum length to send to controller. */
- ovs_be16 controller_id; /* Controller ID to send packet-in. */
- uint8_t reason; /* enum ofp_packet_in_reason (OFPR_*). */
- uint8_t zero; /* Must be zero. */
-};
-OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
/* Flow Table Monitoring
* =====================
@@ -2309,98 +1389,4 @@ struct nx_flow_monitor_cancel {
};
OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 4);
-/* Action structure for NXAST_WRITE_METADATA.
- *
- * Modifies the 'mask' bits of the metadata value. */
-struct nx_action_write_metadata {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 32. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_WRITE_METADATA. */
- uint8_t zeros[6]; /* Must be zero. */
- ovs_be64 metadata; /* Metadata register. */
- ovs_be64 mask; /* Metadata mask. */
-};
-OFP_ASSERT(sizeof(struct nx_action_write_metadata) == 32);
-
-/* Action structure for NXAST_PUSH_MPLS. */
-struct nx_action_push_mpls {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_PUSH_MPLS. */
- ovs_be16 ethertype; /* Ethertype */
- uint8_t pad[4];
-};
-OFP_ASSERT(sizeof(struct nx_action_push_mpls) == 16);
-
-/* Action structure for NXAST_POP_MPLS. */
-struct nx_action_pop_mpls {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_POP_MPLS. */
- ovs_be16 ethertype; /* Ethertype */
- uint8_t pad[4];
-};
-OFP_ASSERT(sizeof(struct nx_action_pop_mpls) == 16);
-
-/* Action structure for NXAST_SET_MPLS_LABEL. */
-struct nx_action_mpls_label {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SET_MPLS_LABEL. */
- uint8_t zeros[2]; /* Must be zero. */
- ovs_be32 label; /* LABEL */
-};
-OFP_ASSERT(sizeof(struct nx_action_mpls_label) == 16);
-
-/* Action structure for NXAST_SET_MPLS_TC. */
-struct nx_action_mpls_tc {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SET_MPLS_TC. */
- uint8_t tc; /* TC */
- uint8_t pad[5];
-};
-OFP_ASSERT(sizeof(struct nx_action_mpls_tc) == 16);
-
-/* Action structure for NXAST_SET_MPLS_TTL. */
-struct nx_action_mpls_ttl {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SET_MPLS_TTL. */
- uint8_t ttl; /* TTL */
- uint8_t pad[5];
-};
-OFP_ASSERT(sizeof(struct nx_action_mpls_ttl) == 16);
-
-/* Action structure for NXAST_SAMPLE.
- *
- * Samples matching packets with the given probability and sends them
- * each to the set of collectors identified with the given ID. The
- * probability is expressed as a number of packets to be sampled out
- * of USHRT_MAX packets, and must be >0.
- *
- * When sending packet samples to IPFIX collectors, the IPFIX flow
- * record sent for each sampled packet is associated with the given
- * observation domain ID and observation point ID. Each IPFIX flow
- * record contain the sampled packet's headers when executing this
- * rule. If a sampled packet's headers are modified by previous
- * actions in the flow, those modified headers are sent. */
-struct nx_action_sample {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 24. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_SAMPLE. */
- ovs_be16 probability; /* Fraction of packets to sample. */
- ovs_be32 collector_set_id; /* ID of collector set in OVSDB. */
- ovs_be32 obs_domain_id; /* ID of sampling observation domain. */
- ovs_be32 obs_point_id; /* ID of sampling observation point. */
-};
-OFP_ASSERT(sizeof(struct nx_action_sample) == 24);
-
#endif /* openflow/nicira-ext.h */
diff --git a/include/openflow/openflow-1.0.h b/include/openflow/openflow-1.0.h
index 002c75d46..c67edd97c 100644
--- a/include/openflow/openflow-1.0.h
+++ b/include/openflow/openflow-1.0.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -170,46 +170,6 @@ struct ofp10_packet_in {
};
OFP_ASSERT(sizeof(struct ofp10_packet_in) == 12);
-enum ofp10_action_type {
- OFPAT10_OUTPUT, /* Output to switch port. */
- OFPAT10_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
- OFPAT10_SET_VLAN_PCP, /* Set the 802.1q priority. */
- OFPAT10_STRIP_VLAN, /* Strip the 802.1q header. */
- OFPAT10_SET_DL_SRC, /* Ethernet source address. */
- OFPAT10_SET_DL_DST, /* Ethernet destination address. */
- OFPAT10_SET_NW_SRC, /* IP source address. */
- OFPAT10_SET_NW_DST, /* IP destination address. */
- OFPAT10_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
- OFPAT10_SET_TP_SRC, /* TCP/UDP source port. */
- OFPAT10_SET_TP_DST, /* TCP/UDP destination port. */
- OFPAT10_ENQUEUE, /* Output to queue. */
- OFPAT10_VENDOR = 0xffff
-};
-
-/* Action structure for OFPAT10_OUTPUT, which sends packets out 'port'.
- * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
- * number of bytes to send. A 'max_len' of zero means no bytes of the
- * packet should be sent. */
-struct ofp10_action_output {
- ovs_be16 type; /* OFPAT10_OUTPUT. */
- ovs_be16 len; /* Length is 8. */
- ovs_be16 port; /* Output port. */
- ovs_be16 max_len; /* Max length to send to controller. */
-};
-OFP_ASSERT(sizeof(struct ofp10_action_output) == 8);
-
-/* OFPAT10_ENQUEUE action struct: send packets to given queue on port. */
-struct ofp10_action_enqueue {
- ovs_be16 type; /* OFPAT10_ENQUEUE. */
- ovs_be16 len; /* Len is 16. */
- ovs_be16 port; /* Port that queue belongs. Should
- refer to a valid physical port
- (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
- uint8_t pad[6]; /* Pad for 64-bit alignment. */
- ovs_be32 queue_id; /* Where to enqueue the packets. */
-};
-OFP_ASSERT(sizeof(struct ofp10_action_enqueue) == 16);
-
/* Send packet (controller -> datapath). */
struct ofp10_packet_out {
ovs_be32 buffer_id; /* ID assigned by datapath or UINT32_MAX. */
@@ -311,9 +271,9 @@ struct ofp10_flow_mod {
output port. A value of OFPP_NONE
indicates no restriction. */
ovs_be16 flags; /* One of OFPFF_*. */
- struct ofp_action_header actions[0]; /* The action length is inferred
- from the length field in the
- header. */
+
+ /* Followed by OpenFlow actions whose length is inferred from the length
+ * field in the OpenFlow header. */
};
OFP_ASSERT(sizeof(struct ofp10_flow_mod) == 64);
@@ -374,7 +334,7 @@ struct ofp10_flow_stats {
ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
- struct ofp_action_header actions[0]; /* Actions. */
+ /* Followed by OpenFlow actions whose length is inferred from 'length'. */
};
OFP_ASSERT(sizeof(struct ofp10_flow_stats) == 88);
diff --git a/include/openflow/openflow-1.1.h b/include/openflow/openflow-1.1.h
index 5e618c9ef..f87c5cfb3 100644
--- a/include/openflow/openflow-1.1.h
+++ b/include/openflow/openflow-1.1.h
@@ -181,38 +181,6 @@ enum ofp11_capabilities {
OFPC11_GROUP_STATS = 1 << 3, /* Group statistics. */
};
-enum ofp11_action_type {
- OFPAT11_OUTPUT, /* Output to switch port. */
- OFPAT11_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
- OFPAT11_SET_VLAN_PCP, /* Set the 802.1q priority. */
- OFPAT11_SET_DL_SRC, /* Ethernet source address. */
- OFPAT11_SET_DL_DST, /* Ethernet destination address. */
- OFPAT11_SET_NW_SRC, /* IP source address. */
- OFPAT11_SET_NW_DST, /* IP destination address. */
- OFPAT11_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
- OFPAT11_SET_NW_ECN, /* IP ECN (2 bits). */
- OFPAT11_SET_TP_SRC, /* TCP/UDP/SCTP source port. */
- OFPAT11_SET_TP_DST, /* TCP/UDP/SCTP destination port. */
- OFPAT11_COPY_TTL_OUT, /* Copy TTL "outwards" -- from next-to-outermost
- to outermost */
- OFPAT11_COPY_TTL_IN, /* Copy TTL "inwards" -- from outermost to
- next-to-outermost */
- OFPAT11_SET_MPLS_LABEL, /* MPLS label */
- OFPAT11_SET_MPLS_TC, /* MPLS TC */
- OFPAT11_SET_MPLS_TTL, /* MPLS TTL */
- OFPAT11_DEC_MPLS_TTL, /* Decrement MPLS TTL */
-
- OFPAT11_PUSH_VLAN, /* Push a new VLAN tag */
- OFPAT11_POP_VLAN, /* Pop the outer VLAN tag */
- OFPAT11_PUSH_MPLS, /* Push a new MPLS Label Stack Entry */
- OFPAT11_POP_MPLS, /* Pop the outer MPLS Label Stack Entry */
- OFPAT11_SET_QUEUE, /* Set queue id when outputting to a port */
- OFPAT11_GROUP, /* Apply group. */
- OFPAT11_SET_NW_TTL, /* IP TTL. */
- OFPAT11_DEC_NW_TTL, /* Decrement IP TTL. */
- OFPAT11_EXPERIMENTER = 0xffff
-};
-
#define OFPMT11_STANDARD_LENGTH 88
struct ofp11_match_header {
@@ -340,97 +308,6 @@ struct ofp11_instruction_experimenter {
};
OFP_ASSERT(sizeof(struct ofp11_instruction_experimenter) == 8);
-/* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
- * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
- * number of bytes to send. A 'max_len' of zero means no bytes of the
- * packet should be sent.*/
-struct ofp11_action_output {
- ovs_be16 type; /* OFPAT11_OUTPUT. */
- ovs_be16 len; /* Length is 16. */
- ovs_be32 port; /* Output port. */
- ovs_be16 max_len; /* Max length to send to controller. */
- uint8_t pad[6]; /* Pad to 64 bits. */
-};
-OFP_ASSERT(sizeof(struct ofp11_action_output) == 16);
-
-/* Action structure for OFPAT_GROUP. */
-struct ofp11_action_group {
- ovs_be16 type; /* OFPAT11_GROUP. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 group_id; /* Group identifier. */
-};
-OFP_ASSERT(sizeof(struct ofp11_action_group) == 8);
-
-/* OFPAT_SET_QUEUE action struct: send packets to given queue on port. */
-struct ofp11_action_set_queue {
- ovs_be16 type; /* OFPAT11_SET_QUEUE. */
- ovs_be16 len; /* Len is 8. */
- ovs_be32 queue_id; /* Queue id for the packets. */
-};
-OFP_ASSERT(sizeof(struct ofp11_action_set_queue) == 8);
-
-/* Action structure for OFPAT11_SET_MPLS_LABEL. */
-struct ofp11_action_mpls_label {
- ovs_be16 type; /* OFPAT11_SET_MPLS_LABEL. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 mpls_label; /* MPLS label */
-};
-OFP_ASSERT(sizeof(struct ofp11_action_mpls_label) == 8);
-
-/* Action structure for OFPAT11_SET_MPLS_TC. */
-struct ofp11_action_mpls_tc {
- ovs_be16 type; /* OFPAT11_SET_MPLS_TC. */
- ovs_be16 len; /* Length is 8. */
- uint8_t mpls_tc; /* MPLS TC */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct ofp11_action_mpls_tc) == 8);
-
-/* Action structure for OFPAT11_SET_MPLS_TTL. */
-struct ofp11_action_mpls_ttl {
- ovs_be16 type; /* OFPAT11_SET_MPLS_TTL. */
- ovs_be16 len; /* Length is 8. */
- uint8_t mpls_ttl; /* MPLS TTL */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct ofp11_action_mpls_ttl) == 8);
-
-/* Action structure for OFPAT11_SET_NW_ECN. */
-struct ofp11_action_nw_ecn {
- ovs_be16 type; /* OFPAT11_SET_TW_SRC/DST. */
- ovs_be16 len; /* Length is 8. */
- uint8_t nw_ecn; /* IP ECN (2 bits). */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct ofp11_action_nw_ecn) == 8);
-
-/* Action structure for OFPAT11_SET_NW_TTL. */
-struct ofp11_action_nw_ttl {
- ovs_be16 type; /* OFPAT11_SET_NW_TTL. */
- ovs_be16 len; /* Length is 8. */
- uint8_t nw_ttl; /* IP TTL */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct ofp11_action_nw_ttl) == 8);
-
-/* Action structure for OFPAT11_PUSH_VLAN/MPLS. */
-struct ofp11_action_push {
- ovs_be16 type; /* OFPAT11_PUSH_VLAN/MPLS. */
- ovs_be16 len; /* Length is 8. */
- ovs_be16 ethertype; /* Ethertype */
- uint8_t pad[2];
-};
-OFP_ASSERT(sizeof(struct ofp11_action_push) == 8);
-
-/* Action structure for OFPAT11_POP_MPLS. */
-struct ofp11_action_pop_mpls {
- ovs_be16 type; /* OFPAT11_POP_MPLS. */
- ovs_be16 len; /* Length is 8. */
- ovs_be16 ethertype; /* Ethertype */
- uint8_t pad[2];
-};
-OFP_ASSERT(sizeof(struct ofp11_action_pop_mpls) == 8);
-
/* Configure/Modify behavior of a flow table */
struct ofp11_table_mod {
uint8_t table_id; /* ID of the table, 0xFF indicates all tables */
diff --git a/include/openflow/openflow-1.2.h b/include/openflow/openflow-1.2.h
index c7ba6fda6..58be0b57b 100644
--- a/include/openflow/openflow-1.2.h
+++ b/include/openflow/openflow-1.2.h
@@ -110,22 +110,18 @@ enum oxm12_ofb_match_fields {
OFPXMT12_OFB_IPV6_ND_TLL, /* Target link-layer for ND. */
OFPXMT12_OFB_MPLS_LABEL, /* MPLS label. */
OFPXMT12_OFB_MPLS_TC, /* MPLS TC. */
-#define OFPXMT12_MASK ((1ULL << (OFPXMT12_OFB_MPLS_TC + 1)) - 1)
/* Following added in OpenFlow 1.3 */
OFPXMT13_OFB_MPLS_BOS, /* MPLS BoS bit. */
OFPXMT13_OFB_PBB_ISID, /* PBB I-SID. */
OFPXMT13_OFB_TUNNEL_ID, /* Logical Port Metadata */
OFPXMT13_OFB_IPV6_EXTHDR, /* IPv6 Extension Header pseudo-field */
-#define OFPXMT13_MASK ((1ULL << (OFPXMT13_OFB_IPV6_EXTHDR + 1)) - 1)
/* Following added in OpenFlow 1.4. */
OFPXMT14_OFB_PBB_UCA = 41, /* PBB UCA header field. */
-#define OFPXMT14_MASK (1ULL << OFPXMT14_OFB_PBB_UCA)
/* Following added in OpenFlow 1.5. */
OFPXMT15_OFB_TCP_FLAGS = 42, /* TCP flags. */
-#define OFPXMT15_MASK (1ULL << OFPXMT15_OFB_TCP_FLAGS)
};
/* OXM implementation makes use of NXM as they are the same format
@@ -230,10 +226,6 @@ struct ofp12_oxm_experimenter_header {
};
OFP_ASSERT(sizeof(struct ofp12_oxm_experimenter_header) == 8);
-enum ofp12_action_type {
- OFPAT12_SET_FIELD = 25, /* Set a header field using OXM TLV format. */
-};
-
enum ofp12_controller_max_len {
OFPCML12_MAX = 0xffe5, /* maximum max_len value which can be used
* to request a specific byte length. */
@@ -242,18 +234,6 @@ enum ofp12_controller_max_len {
* sent to the controller. */
};
-/* Action structure for OFPAT12_SET_FIELD. */
-struct ofp12_action_set_field {
- ovs_be16 type; /* OFPAT12_SET_FIELD. */
- ovs_be16 len; /* Length is padded to 64 bits. */
- ovs_be32 dst; /* OXM TLV header */
- /* Followed by:
- * - Exactly ((oxm_len + 4) + 7)/8*8 - (oxm_len + 4) (between 0 and 7)
- * bytes of all-zero bytes
- */
-};
-OFP_ASSERT(sizeof(struct ofp12_action_set_field) == 8);
-
/* OpenFlow 1.2 specific flags
* (struct ofp12_flow_mod, member flags). */
enum ofp12_flow_mod_flags {
diff --git a/include/openflow/openflow-1.3.h b/include/openflow/openflow-1.3.h
index 39de5b3bd..caae674fd 100644
--- a/include/openflow/openflow-1.3.h
+++ b/include/openflow/openflow-1.3.h
@@ -99,27 +99,6 @@ struct ofp13_instruction_meter {
};
OFP_ASSERT(sizeof(struct ofp13_instruction_meter) == 8);
-enum ofp13_action_type {
- OFPAT13_OUTPUT = 0, /* Output to switch port. */
- OFPAT13_COPY_TTL_OUT = 11, /* Copy TTL "outwards" -- from next-to-outermost
- to outermost */
- OFPAT13_COPY_TTL_IN = 12, /* Copy TTL "inwards" -- from outermost to
- next-to-outermost */
- OFPAT13_SET_MPLS_TTL = 15, /* MPLS TTL */
- OFPAT13_DEC_MPLS_TTL = 16, /* Decrement MPLS TTL */
- OFPAT13_PUSH_VLAN = 17, /* Push a new VLAN tag */
- OFPAT13_POP_VLAN = 18, /* Pop the outer VLAN tag */
- OFPAT13_PUSH_MPLS = 19, /* Push a new MPLS Label Stack Entry */
- OFPAT13_POP_MPLS = 20, /* Pop the outer MPLS Label Stack Entry */
- OFPAT13_SET_QUEUE = 21, /* Set queue id when outputting to a port */
- OFPAT13_GROUP = 22, /* Apply group. */
- OFPAT13_SET_NW_TTL = 23, /* IP TTL. */
- OFPAT13_DEC_NW_TTL = 24, /* Decrement IP TTL. */
- OFPAT13_SET_FIELD = 25, /* Set a header field using OXM TLV format. */
- OFPAT13_PUSH_PBB = 26, /* Push a new PBB service tag (I-TAG) */
- OFPAT13_POP_PBB = 27 /* Pop the outer PBB service tag (I-TAG) */
-};
-
/* enum ofp_config_flags value OFPC_INVALID_TTL_TO_CONTROLLER
* is deprecated in OpenFlow 1.3 */
diff --git a/include/openflow/openflow-common.h b/include/openflow/openflow-common.h
index 75cf41342..05d53680a 100644
--- a/include/openflow/openflow-common.h
+++ b/include/openflow/openflow-common.h
@@ -286,82 +286,6 @@ enum ofp_flow_mod_flags {
OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
};
-/* Action header for OFPAT10_VENDOR and OFPAT11_EXPERIMEMNTER.
- * The rest of the body is vendor-defined. */
-struct ofp_action_vendor_header {
- ovs_be16 type; /* OFPAT10_VENDOR. */
- ovs_be16 len; /* Length is a multiple of 8. */
- ovs_be32 vendor; /* Vendor ID, which takes the same form
- as in "struct ofp_vendor_header". */
-};
-OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
-
-/* Action header that is common to all actions. The length includes the
- * header and any padding used to make the action 64-bit aligned.
- * NB: The length of an action *must* always be a multiple of eight. */
-struct ofp_action_header {
- ovs_be16 type; /* One of OFPAT*. */
- ovs_be16 len; /* Length of action, including this
- header. This is the length of action,
- including any padding to make it
- 64-bit aligned. */
- uint8_t pad[4];
-};
-OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
-
-/* Action structure for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
-struct ofp_action_vlan_vid {
- ovs_be16 type; /* Type. */
- ovs_be16 len; /* Length is 8. */
- ovs_be16 vlan_vid; /* VLAN id. */
- uint8_t pad[2];
-};
-OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
-
-/* Action structure for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
-struct ofp_action_vlan_pcp {
- ovs_be16 type; /* Type. */
- ovs_be16 len; /* Length is 8. */
- uint8_t vlan_pcp; /* VLAN priority. */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
-
-/* Action structure for OFPAT10_SET_DL_SRC/DST and OFPAT11_SET_DL_SRC/DST. */
-struct ofp_action_dl_addr {
- ovs_be16 type; /* Type. */
- ovs_be16 len; /* Length is 16. */
- uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
- uint8_t pad[6];
-};
-OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
-
-/* Action structure for OFPAT10_SET_NW_SRC/DST and OFPAT11_SET_NW_SRC/DST. */
-struct ofp_action_nw_addr {
- ovs_be16 type; /* Type. */
- ovs_be16 len; /* Length is 8. */
- ovs_be32 nw_addr; /* IP address. */
-};
-OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
-
-/* Action structure for OFPAT10_SET_NW_TOS and OFPAT11_SET_NW_TOS. */
-struct ofp_action_nw_tos {
- ovs_be16 type; /* Type.. */
- ovs_be16 len; /* Length is 8. */
- uint8_t nw_tos; /* DSCP in high 6 bits, rest ignored. */
- uint8_t pad[3];
-};
-OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
-
-/* Action structure for OFPAT10_SET_TP_SRC/DST and OFPAT11_SET_TP_SRC/DST. */
-struct ofp_action_tp_port {
- ovs_be16 type; /* Type. */
- ovs_be16 len; /* Length is 8. */
- ovs_be16 tp_port; /* TCP/UDP port. */
- uint8_t pad[2];
-};
-OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
-
/* Why was this flow removed? */
enum ofp_flow_removed_reason {
OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */