/*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#ifndef OPENFLOW_NICIRA_EXT_H
#define OPENFLOW_NICIRA_EXT_H 1
-#include "openflow/openflow.h"
-#include "openvswitch/types.h"
+#include <openflow/openflow.h>
+#include <openvswitch/types.h>
-/* The following vendor extensions, proposed by Nicira Networks, are not yet
+/* The following vendor extensions, proposed by Nicira, are not yet
* standardized, so they are not included in openflow.h. Some of them may be
* suitable for standardization; others we never expect to standardize. */
-#define NX_VENDOR_ID 0x00002320
\f
/* Nicira vendor-specific error messages extension.
*
/* Followed by at least the first 64 bytes of the failed request. */
};
\f
-/* Specific Nicira extension error numbers.
- *
- * These are the "code" values used in nx_vendor_error. So far, the "type"
- * values in nx_vendor_error are the same as those in ofp_error_msg. That is,
- * at Nicira so far we've only needed additional vendor-specific 'code' values,
- * so we're using the existing 'type' values to avoid having to invent new ones
- * that duplicate the current ones' meanings. */
-
-/* Additional "code" values for OFPET_BAD_REQUEST. */
-enum nx_bad_request_code {
-/* Nicira Extended Match (NXM) errors. */
-
- /* Generic error code used when there is an error in an NXM sent to the
- * switch. The switch may use one of the more specific error codes below,
- * if there is an appropriate one, to simplify debugging, but it is not
- * required to do so. */
- NXBRC_NXM_INVALID = 0x100,
-
- /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or
- * nxm_length or both, is invalid or not implemented. */
- NXBRC_NXM_BAD_TYPE = 0x101,
-
- /* Invalid nxm_value. */
- NXBRC_NXM_BAD_VALUE = 0x102,
-
- /* Invalid nxm_mask. */
- NXBRC_NXM_BAD_MASK = 0x103,
-
- /* A prerequisite was not met. */
- NXBRC_NXM_BAD_PREREQ = 0x104,
-
- /* A given nxm_type was specified more than once. */
- NXBRC_NXM_DUP_TYPE = 0x105
-};
-
-/* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
-enum nx_flow_mod_failed_code {
- /* Generic hardware error. */
- NXFMFC_HARDWARE = 0x100,
-
- /* A nonexistent table ID was specified in the "command" field of struct
- * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
- NXFMFC_BAD_TABLE_ID = 0x101
-};
-\f
/* Nicira vendor requests and replies. */
/* Header for Nicira vendor requests and replies. */
struct nicira_header {
struct ofp_header header;
ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be32 subtype; /* One of NXT_* below. */
+ ovs_be32 subtype; /* See the NXT numbers in ofp-msgs.h. */
};
OFP_ASSERT(sizeof(struct nicira_header) == 16);
-/* Values for the 'subtype' member of struct nicira_header. */
-enum nicira_type {
- /* No longer used. */
- NXT_STATUS_REQUEST__OBSOLETE = 0,
- NXT_STATUS_REPLY__OBSOLETE = 1,
- NXT_ACT_SET_CONFIG__OBSOLETE = 2,
- NXT_ACT_GET_CONFIG__OBSOLETE = 3,
- NXT_COMMAND_REQUEST__OBSOLETE = 4,
- NXT_COMMAND_REPLY__OBSOLETE = 5,
- NXT_FLOW_END_CONFIG__OBSOLETE = 6,
- NXT_FLOW_END__OBSOLETE = 7,
- NXT_MGMT__OBSOLETE = 8,
- NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
-
- /* Controller role support. The request body is struct nx_role_request.
- * The reply echos the request. */
- NXT_ROLE_REQUEST = 10,
- NXT_ROLE_REPLY = 11,
-
- /* Flexible flow specification (aka NXM = Nicira Extended Match). */
- NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
- NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
- NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
-
- /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
- * designate the table to which a flow is to be added? See the big comment
- * on struct nxt_flow_mod_table_id for more information. */
- NXT_FLOW_MOD_TABLE_ID = 15
-};
-
-/* Header for Nicira vendor stats request and reply messages. */
-struct nicira_stats_msg {
- struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
+/* Header for Nicira vendor stats request and reply messages in OpenFlow
+ * 1.0. */
+struct nicira10_stats_msg {
+ struct ofp10_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
ovs_be32 subtype; /* One of NXST_* below. */
uint8_t pad[4]; /* Align to 64-bits. */
};
-OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
+OFP_ASSERT(sizeof(struct nicira10_stats_msg) == 24);
-/* Values for the 'subtype' member of struct nicira_stats_msg. */
-enum nicira_stats_type {
- /* Flexible flow specification (aka NXM = Nicira Extended Match). */
- NXST_FLOW, /* Analogous to OFPST_FLOW. */
- NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
+/* Header for Nicira vendor stats request and reply messages in OpenFlow
+ * 1.1. */
+struct nicira11_stats_msg {
+ struct ofp11_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
+ ovs_be32 subtype; /* One of NXST_* below. */
};
+OFP_ASSERT(sizeof(struct nicira11_stats_msg) == 24);
/* Fields to use when hashing flows. */
enum nx_hash_fields {
* - NXM_OF_IP_SRC / NXM_OF_IP_DST
* - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
*/
- NX_HASH_FIELDS_SYMMETRIC_L4
+ NX_HASH_FIELDS_SYMMETRIC_L4,
+
+ /* L3+L4 only, including the following fields:
+ *
+ * - NXM_OF_IP_PROTO
+ * - NXM_OF_IP_SRC / NXM_OF_IP_DST
+ * - NXM_OF_SCTP_SRC / NXM_OF_SCTP_DST
+ * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
+ */
+ NX_HASH_FIELDS_SYMMETRIC_L3L4,
+
+ /* L3+L4 only with UDP ports, including the following fields:
+ *
+ * - NXM_OF_IP_PROTO
+ * - NXM_OF_IP_SRC / NXM_OF_IP_DST
+ * - NXM_OF_SCTP_SRC / NXM_OF_SCTP_DST
+ * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
+ * - NXM_OF_UDP_SRC / NXM_OF_UDP_DST
+ */
+ NX_HASH_FIELDS_SYMMETRIC_L3L4_UDP
+
+
};
/* This command enables or disables an Open vSwitch extension that allows a
* controller to specify the OpenFlow table to which a flow should be added,
* instead of having the switch decide which table is most appropriate as
- * required by OpenFlow 1.0. By default, the extension is disabled.
+ * required by OpenFlow 1.0. Because NXM was designed as an extension to
+ * OpenFlow 1.0, the extension applies equally to ofp10_flow_mod and
+ * nx_flow_mod. By default, the extension is disabled.
*
- * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
- * 16-bit 'command' member as two separate fields. The upper 8 bits are used
- * as the table ID, the lower 8 bits specify the command as usual. A table ID
- * of 0xff is treated like a wildcarded table ID.
+ * When this feature is enabled, Open vSwitch treats struct ofp10_flow_mod's
+ * and struct nx_flow_mod's 16-bit 'command' member as two separate fields.
+ * The upper 8 bits are used as the table ID, the lower 8 bits specify the
+ * command as usual. A table ID of 0xff is treated like a wildcarded table ID.
*
* The specific treatment of the table ID depends on the type of flow mod:
*
* table. If an identical flow already exists in that table only, then it
* is replaced. If the flow cannot be placed in the specified table,
* either because the table is full or because the table cannot support
- * flows of the given type, the switch replies with an
- * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
- * cases by comparing the current and maximum number of entries reported
- * in ofp_table_stats.)
+ * flows of the given type, the switch replies with an OFPFMFC_TABLE_FULL
+ * error. (A controller can distinguish these cases by comparing the
+ * current and maximum number of entries reported in ofp_table_stats.)
*
* If the table ID is wildcarded, the switch picks an appropriate table
* itself. If an identical flow already exist in the selected flow table,
* matches, then it is modified or deleted; if flows in more than one
* table match, then none is modified or deleted.
*/
-struct nxt_flow_mod_table_id {
- struct ofp_header header;
- uint32_t vendor; /* NX_VENDOR_ID. */
- uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
+struct nx_flow_mod_table_id {
uint8_t set; /* Nonzero to enable, zero to disable. */
uint8_t pad[7];
};
-OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
+OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 8);
+
+enum nx_packet_in_format {
+ NXPIF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
+ NXPIF_NXM = 1 /* Nicira Extended. */
+};
+
+/* NXT_SET_PACKET_IN_FORMAT request. */
+struct nx_set_packet_in_format {
+ ovs_be32 format; /* One of NXPIF_*. */
+};
+OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 4);
+
+/* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
+ *
+ * NXT_PACKET_IN is similar to the OpenFlow 1.2 OFPT_PACKET_IN. The
+ * differences are:
+ *
+ * - NXT_PACKET_IN includes the cookie of the rule that triggered the
+ * message. (OpenFlow 1.3 OFPT_PACKET_IN also includes the cookie.)
+ *
+ * - The metadata fields use NXM (instead of OXM) field numbers.
+ *
+ * Open vSwitch 1.9.0 and later omits metadata fields that are zero (as allowed
+ * by OpenFlow 1.2). Earlier versions included all implemented metadata
+ * fields.
+ *
+ * Open vSwitch does not include non-metadata in the nx_match, because by
+ * definition that information can be found in the packet itself. The format
+ * and the standards allow this, however, so controllers should be prepared to
+ * tolerate future changes.
+ *
+ * The NXM format is convenient for reporting metadata values, but it is
+ * important not to interpret the format as matching against a flow, because it
+ * does not. Nothing is being matched; arbitrary metadata masks would not be
+ * meaningful.
+ *
+ * Whereas in most cases a controller can expect to only get back NXM fields
+ * that it set up itself (e.g. flow dumps will ordinarily report only NXM
+ * fields from flows that the controller added), NXT_PACKET_IN messages might
+ * contain fields that the controller does not understand, because the switch
+ * might support fields (new registers, new protocols, etc.) that the
+ * controller does not. The controller must prepared to tolerate these.
+ *
+ * The 'cookie' field has no meaning when 'reason' is OFPR_NO_MATCH. In this
+ * case it should be UINT64_MAX. */
+struct nx_packet_in {
+ ovs_be32 buffer_id; /* ID assigned by datapath. */
+ ovs_be16 total_len; /* Full length of frame. */
+ uint8_t reason; /* Reason packet is sent (one of OFPR_*). */
+ uint8_t table_id; /* ID of the table that was looked up. */
+ ovs_be64 cookie; /* Cookie of the rule that was looked up. */
+ ovs_be16 match_len; /* Size of nx_match. */
+ uint8_t pad[6]; /* Align to 64-bits. */
+ /* Followed by:
+ * - Exactly match_len (possibly 0) bytes containing the nx_match, then
+ * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
+ * all-zero bytes, then
+ * - Exactly 2 all-zero padding bytes, then
+ * - An Ethernet frame whose length is inferred from nxh.header.length.
+ *
+ * The padding bytes preceding the Ethernet frame ensure that the IP
+ * header (if any) following the Ethernet header is 32-bit aligned. */
+
+ /* uint8_t nxm_fields[...]; */ /* NXM headers. */
+ /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */
+ /* uint8_t data[0]; */ /* Ethernet frame. */
+};
+OFP_ASSERT(sizeof(struct nx_packet_in) == 24);
/* Configures the "role" of the sending controller. The default role is:
*
* messages, but they do receive OFPT_PORT_STATUS messages.
*/
struct nx_role_request {
- struct nicira_header nxh;
ovs_be32 role; /* One of NX_ROLE_*. */
};
+OFP_ASSERT(sizeof(struct nx_role_request) == 4);
enum nx_role {
NX_ROLE_OTHER, /* Default role, full access. */
NX_ROLE_MASTER, /* Full access, at most one. */
NX_ROLE_SLAVE /* Read-only access. */
};
-\f
-/* 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, /* struct nx_action_autopath */
- NXAST_BUNDLE, /* struct nx_action_bundle */
- NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
- NXAST_RESUBMIT_TABLE /* struct nx_action_resubmit */
-};
-
-/* 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 16. */
- 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.
- *
- * 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
- * Modifying any of the above fields changes the corresponding packet
- * header.
- *
- * - NXM_NX_REG(idx) for idx in the switch's accepted range.
- *
- * - 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. Modifying this value modifies the tunnel ID used for the
- * packet's next tunnel encapsulation.
- *
- * 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.
- */
-struct nx_action_reg_move {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 16. */
- 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 16. */
- 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_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. */
-};
-\f
-/* Action structure for NXAST_AUTOPATH.
+/* NXT_SET_ASYNC_CONFIG.
*
- * This action performs the following steps in sequence:
+ * Sent by a controller, this message configures the asynchronous messages that
+ * the controller wants to receive. Element 0 in each array specifies messages
+ * of interest when the controller has an "other" or "master" role; element 1,
+ * when the controller has a "slave" role.
*
- * 1. Hashes the flow using an implementation-defined hash function.
+ * Each array element is a bitmask in which a 0-bit disables receiving a
+ * particular message and a 1-bit enables receiving it. Each bit controls the
+ * message whose 'reason' corresponds to the bit index. For example, the bit
+ * with value 1<<2 == 4 in port_status_mask[1] determines whether the
+ * controller will receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY
+ * (value 2) when the controller has a "slave" role.
*
- * 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. Selects an OpenFlow 'port'.
- *
- * 'port' is selected in an implementation-defined manner, taking into
- * account 'id' and the hash value calculated in step 1.
- *
- * Generally a switch will have been configured with a set of ports that
- * may be chosen given 'id'. The switch may take into account any number
- * of factors when choosing 'port' from its configured set. Factors may
- * include carrier, load, and the results of configuration protocols such
- * as LACP.
- *
- * 3. Stores 'port' 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 in which ofs+n_bits is greater than the width
- * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
+ * As a side effect, for service controllers, this message changes the
+ * miss_send_len from default of zero to OFP_DEFAULT_MISS_SEND_LEN (128).
*/
-struct nx_action_autopath {
- ovs_be16 type; /* OFPAT_VENDOR. */
- ovs_be16 len; /* Length is 20. */
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be16 subtype; /* NXAST_AUTOPATH. */
-
- /* Where to store the result. */
- ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
- ovs_be32 dst; /* Destination. */
-
- ovs_be32 id; /* Autopath ID. */
- ovs_be32 pad;
-};
-OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
-\f
-/* 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.
- *
- * 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. */
-
- /* 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_BD_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. */
+struct nx_async_config {
+ ovs_be32 packet_in_mask[2]; /* Bitmasks of OFPR_* values. */
+ ovs_be32 port_status_mask[2]; /* Bitmasks of OFPRR_* values. */
+ ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */
};
+OFP_ASSERT(sizeof(struct nx_async_config) == 24);
\f
/* Flexible flow specifications (aka NXM = Nicira Extended Match).
*
- * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
+ * OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches. This
* structure is fixed-length and hence difficult to extend. This section
* describes a more flexible, variable-length flow match, called "nx_match" for
* short, that is also supported by Open vSwitch. This section also defines a
- * replacement for each OpenFlow message that includes struct ofp_match.
+ * replacement for each OpenFlow message that includes struct ofp10_match.
+ *
+ * OpenFlow 1.2+ introduced OpenFlow Extensible Match (OXM), adapting
+ * the design of NXM. The format of NXM and OXM are compatible.
*
*
* Format
* +----------------------------------+---------------+--+------------------+
*
* The most-significant 23 bits of the header are collectively "nxm_type".
- * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
- * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
- * designates a protocol header, such as the Ethernet type, but it can also
- * refer to packet metadata, such as the switch port on which a packet arrived.
+ * Bits 16...31 are "nxm_vendor", one of OFPXMC12_* values. In case of
+ * NXM, it's either OFPXMC12_NXM_0 or OFPXMC12_NXM_1.
+ * Bits 9...15 are "nxm_field", which is a vendor-specific value. nxm_type
+ * normally designates a protocol header, such as the Ethernet type, but it
+ * can also refer to packet metadata, such as the switch port on which a packet
+ * arrived.
*
* Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
* of this bit is explained later.
* value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
* nx_match matches only packets for which bit J in the given field's value
* matches bit J in nxm_value. A 0-bit in nxm_mask causes the
- * corresponding bits in nxm_value and the field's value to be ignored.
- * (The sense of the nxm_mask bits is the opposite of that used by the
- * "wildcards" member of struct ofp_match.)
+ * corresponding bit in nxm_value is ignored (it should be 0; Open vSwitch
+ * may enforce this someday), as is the corresponding bit in the field's
+ * value. (The sense of the nxm_mask bits is the opposite of that used by
+ * the "wildcards" member of struct ofp10_match.)
*
* When nxm_hasmask is 1, nxm_length is always even.
*
* and nxm_value=0x0800. That is, matching on the IP source address is
* allowed only if the Ethernet type is explicitly set to IP.
*
- * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
- * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
- * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
- * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
- * source port is allowed only if the Ethernet type is IP and the IP
- * protocol is TCP.
+ * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
+ * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
+ * nxm_value either 0x0800 or 0x86dd, and another with
+ * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
+ * That is, matching on the TCP source port is allowed only if the Ethernet
+ * type is IP or IPv6 and the IP protocol is TCP.
*
* These restrictions should be noted in specifications for individual fields.
* A switch may implement relaxed versions of these restrictions. A switch
* nx_match error.
*/
-#define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
- (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
-#define NXM_HEADER(VENDOR, FIELD, LENGTH) \
- NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
-#define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
- NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
-#define NXM_VENDOR(HEADER) ((HEADER) >> 16)
-#define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
-#define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
-#define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
-#define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
-
-#define NXM_MAKE_WILD_HEADER(HEADER) \
- NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
-
-/* ## ------------------------------- ## */
-/* ## OpenFlow 1.0-compatible fields. ## */
-/* ## ------------------------------- ## */
-
-/* Physical or virtual port on which the packet was received.
- *
- * Prereqs: None.
- *
- * Format: 16-bit integer in network byte order.
- *
- * Masking: Not maskable. */
-#define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
-
-/* Source or destination address in Ethernet header.
- *
- * Prereqs: None.
- *
- * Format: 48-bit Ethernet MAC address.
- *
- * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
- * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
- * are all-0-bits or all-1-bits). Support for other patterns and for masking
- * of NXM_OF_ETH_SRC is optional. */
-#define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
-#define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
-#define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
-
-/* Packet's Ethernet type.
- *
- * For an Ethernet II packet this is taken from the Ethernet header. For an
- * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
- * A packet that has neither format has value 0x05ff
- * (OFP_DL_TYPE_NOT_ETH_TYPE).
- *
- * For a packet with an 802.1Q header, this is the type of the encapsulated
- * frame.
- *
- * Prereqs: None.
- *
- * Format: 16-bit integer in network byte order.
- *
- * Masking: Not maskable. */
-#define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
-
-/* 802.1Q TCI.
- *
- * For a packet with an 802.1Q header, this is the Tag Control Information
- * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
- * header, this has value 0.
- *
- * Prereqs: None.
- *
- * Format: 16-bit integer in network byte order.
- *
- * Masking: Arbitrary masks.
- *
- * This field can be used in various ways:
- *
- * - If it is not constrained at all, the nx_match matches packets without
- * an 802.1Q header or with an 802.1Q header that has any TCI value.
- *
- * - Testing for an exact match with 0 matches only packets without an
- * 802.1Q header.
- *
- * - Testing for an exact match with a TCI value with CFI=1 matches packets
- * that have an 802.1Q header with a specified VID and PCP.
- *
- * - Testing for an exact match with a nonzero TCI value with CFI=0 does
- * not make sense. The switch may reject this combination.
- *
- * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
- * packets that have an 802.1Q header with that VID (and any PCP).
- *
- * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
- * packets that have an 802.1Q header with that PCP (and any VID).
- *
- * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
- * header or with an 802.1Q header with a VID of 0.
- *
- * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
- * header or with an 802.1Q header with a PCP of 0.
- *
- * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
- * header or with an 802.1Q header with both VID and PCP of 0.
- */
-#define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
-#define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
-
-/* The "type of service" byte of the IP header, with the ECN bits forced to 0.
- *
- * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
- *
- * Format: 8-bit integer with 2 least-significant bits forced to 0.
- *
- * Masking: Not maskable. */
-#define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
-
-/* The "protocol" byte in the IP header.
- *
- * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
- *
- * Format: 8-bit integer.
- *
- * Masking: Not maskable. */
-#define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
-
-/* The source or destination address in the IP header.
- *
- * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
- *
- * Format: 32-bit integer in network byte order.
- *
- * Masking: Only CIDR masks are allowed, that is, masks that consist of N
- * high-order bits set to 1 and the other 32-N bits set to 0. */
-#define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
-#define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
-#define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
-#define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
-
-/* The source or destination port in the TCP header.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
- * NXM_OF_IP_PROTO must match 6 exactly.
- *
- * Format: 16-bit integer in network byte order.
- *
- * Masking: Not maskable. */
-#define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
-#define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
-
-/* The source or destination port in the UDP header.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
- * NXM_OF_IP_PROTO must match 17 exactly.
- *
- * Format: 16-bit integer in network byte order.
- *
- * Masking: Not maskable. */
-#define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
-#define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
-
-/* The type or code in the ICMP header.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must match 0x0800 exactly.
- * NXM_OF_IP_PROTO must match 1 exactly.
- *
- * Format: 8-bit integer.
- *
- * Masking: Not maskable. */
-#define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
-#define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
-
-/* ARP opcode.
- *
- * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
- * otherwise. Only ARP opcodes between 1 and 255 should be specified for
- * matching.
- *
- * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
- *
- * Format: 16-bit integer in network byte order.
- *
- * Masking: Not maskable. */
-#define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
-
-/* For an Ethernet+IP ARP packet, the source or target protocol address
- * in the ARP header. Always 0 otherwise.
- *
- * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
- *
- * Format: 32-bit integer in network byte order.
- *
- * Masking: Only CIDR masks are allowed, that is, masks that consist of N
- * high-order bits set to 1 and the other 32-N bits set to 0. */
-#define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
-#define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
-#define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
-#define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
-
-/* ## ------------------------ ## */
-/* ## Nicira match extensions. ## */
-/* ## ------------------------ ## */
-
-/* Metadata registers.
- *
- * Registers initially have value 0. Actions allow register values to be
- * manipulated.
- *
- * Prereqs: None.
- *
- * Format: Array of 32-bit integer registers. Space is reserved for up to
- * NXM_NX_MAX_REGS registers, but switches may implement fewer.
- *
- * Masking: Arbitrary masks. */
+/* Number of registers allocated NXM field IDs. */
#define NXM_NX_MAX_REGS 16
-#define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
-#define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
-#define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
-#define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
-#define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
-#define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
-#define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
-#define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
-#define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
-#define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
-#define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
-#define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
-#define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
-/* Tunnel ID.
- *
- * For a packet received via GRE tunnel including a (32-bit) key, the key is
- * stored in the low 32-bits and the high bits are zeroed. For other packets,
- * the value is 0.
- *
- * Prereqs: None.
- *
- * Format: 64-bit integer in network byte order.
- *
- * Masking: Arbitrary masks. */
-#define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
-#define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
-
-/* For an Ethernet+IP ARP packet, the source or target hardware address
- * in the ARP header. Always 0 otherwise.
- *
- * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
- *
- * Format: 48-bit Ethernet MAC address.
- *
- * Masking: Not maskable. */
-#define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
-#define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
-
-/* The source or destination address in the IPv6 header.
- *
- * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
- *
- * Format: 128-bit IPv6 address.
- *
- * Masking: Only CIDR masks are allowed, that is, masks that consist of N
- * high-order bits set to 1 and the other 128-N bits set to 0. */
-#define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
-#define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
-#define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
-#define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
-
-/* The type or code in the ICMPv6 header.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must match 0x86dd exactly.
- * NXM_OF_IP_PROTO must match 58 exactly.
- *
- * Format: 8-bit integer.
- *
- * Masking: Not maskable. */
-#define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
-#define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
-
-/* The target address in an IPv6 Neighbor Discovery message.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must match 0x86dd exactly.
- * NXM_OF_IP_PROTO must match 58 exactly.
- * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
- *
- * Format: 128-bit IPv6 address.
- *
- * Masking: Not maskable. */
-#define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
-
-/* The source link-layer address option in an IPv6 Neighbor Discovery
- * message.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must match 0x86dd exactly.
- * NXM_OF_IP_PROTO must match 58 exactly.
- * NXM_OF_ICMPV6_TYPE must be exactly 135.
- *
- * Format: 48-bit Ethernet MAC address.
- *
- * Masking: Not maskable. */
-#define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
-
-/* The target link-layer address option in an IPv6 Neighbor Discovery
- * message.
- *
- * Prereqs:
- * NXM_OF_ETH_TYPE must match 0x86dd exactly.
- * NXM_OF_IP_PROTO must match 58 exactly.
- * NXM_OF_ICMPV6_TYPE must be exactly 136.
- *
- * Format: 48-bit Ethernet MAC address.
- *
- * Masking: Not maskable. */
-#define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
+/* Bits in the value of NXM_NX_IP_FRAG. */
+#define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
+#define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
+/* Bits in the value of NXM_NX_TUN_FLAGS. */
+#define NX_TUN_FLAG_OAM (1 << 0) /* Is this an OAM packet? */
/* ## --------------------- ## */
/* ## Requests and replies. ## */
};
/* NXT_SET_FLOW_FORMAT request. */
-struct nxt_set_flow_format {
- struct ofp_header header;
- ovs_be32 vendor; /* NX_VENDOR_ID. */
- ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
+struct nx_set_flow_format {
ovs_be32 format; /* One of NXFF_*. */
};
-OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
+OFP_ASSERT(sizeof(struct nx_set_flow_format) == 4);
-/* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
+/* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
+ *
+ * It is possible to limit flow deletions and modifications to certain
+ * cookies by using the NXM_NX_COOKIE(_W) matches. The "cookie" field
+ * is used only to add or modify flow cookies.
+ */
struct nx_flow_mod {
- struct nicira_header nxh;
ovs_be64 cookie; /* Opaque controller-issued identifier. */
- ovs_be16 command; /* One of OFPFC_*. */
+ ovs_be16 command; /* OFPFC_* + possibly a table ID (see comment
+ * on struct nx_flow_mod_table_id). */
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. */
* multiple of 8).
*/
};
-OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
+OFP_ASSERT(sizeof(struct nx_flow_mod) == 32);
-/* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
+/* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED).
+ *
+ * 'table_id' is present only in Open vSwitch 1.11 and later. In earlier
+ * versions of Open vSwitch, this is a padding byte that is always zeroed.
+ * Therefore, a 'table_id' value of 0 indicates that the table ID is not known,
+ * and other values may be interpreted as one more than the flow's former table
+ * ID. */
struct nx_flow_removed {
- struct nicira_header nxh;
ovs_be64 cookie; /* Opaque controller-issued identifier. */
ovs_be16 priority; /* Priority level of flow entry. */
uint8_t reason; /* One of OFPRR_*. */
- uint8_t pad[1]; /* Align to 32-bits. */
+ uint8_t table_id; /* Flow's former table ID, plus one. */
ovs_be32 duration_sec; /* Time flow was alive in seconds. */
ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
duration_sec. */
* - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
* all-zero bytes. */
};
-OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
+OFP_ASSERT(sizeof(struct nx_flow_removed) == 40);
/* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
- * request). */
+ * request).
+ *
+ * It is possible to limit matches to certain cookies by using the
+ * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
+ */
struct nx_flow_stats_request {
- struct nicira_stats_msg nsm;
ovs_be16 out_port; /* Require matching entries to include this
as an output port. A value of OFPP_NONE
indicates no restriction. */
* message.
*/
};
-OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
+OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 8);
/* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
- * OFPST_FLOW reply). */
+ * OFPST_FLOW reply).
+ *
+ * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
+ * a switch that implements the NXT_FLOW_AGE extension. Zero means that the
+ * true value is unknown, perhaps because hardware does not track the value.
+ * (Zero is also the value that one should ordinarily expect to see talking to
+ * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
+ * padding bytes that these fields replaced.) A nonzero value X represents X-1
+ * seconds. A value of 65535 represents 65534 or more seconds.
+ *
+ * 'idle_age' is the number of seconds that the flow has been idle, that is,
+ * the number of seconds since a packet passed through the flow. 'hard_age' is
+ * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
+ * OFPFC_MODIFY_STRICT). (The 'duration_*' fields are the elapsed time since
+ * the flow was added, regardless of subsequent modifications.)
+ *
+ * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
+ * respectively, will ordinarily be smaller than the timeout, but flow
+ * expiration times are only approximate and so one must be prepared to
+ * tolerate expirations that occur somewhat early or late.
+ */
struct nx_flow_stats {
ovs_be16 length; /* Length of this entry. */
uint8_t table_id; /* ID of table flow came from. */
ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
beyond duration_sec. */
- ovs_be16 priority; /* Priority of the entry. Only meaningful
- when this is not an exact-match entry. */
+ ovs_be16 priority; /* Priority of the entry. */
ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
ovs_be16 hard_timeout; /* Number of seconds before expiration. */
ovs_be16 match_len; /* Length of nx_match. */
- uint8_t pad2[4]; /* Align to 64 bits. */
+ ovs_be16 idle_age; /* Seconds since last packet, plus one. */
+ ovs_be16 hard_age; /* Seconds since last modification, plus one. */
ovs_be64 cookie; /* Opaque controller-issued identifier. */
ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
/* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
- * OFPST_AGGREGATE request). */
+ * OFPST_AGGREGATE request).
+ *
+ * The reply format is identical to the reply format for OFPST_AGGREGATE,
+ * except for the header. */
struct nx_aggregate_stats_request {
- struct nicira_stats_msg nsm;
ovs_be16 out_port; /* Require matching entries to include this
as an output port. A value of OFPP_NONE
indicates no restriction. */
* message.
*/
};
-OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
-
-/* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
- * OFPST_AGGREGATE reply). */
-struct nx_aggregate_stats_reply {
- struct nicira_stats_msg nsm;
- ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
- ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
- ovs_be32 flow_count; /* Number of flows. */
- uint8_t pad[4]; /* Align to 64 bits. */
+OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 8);
+\f
+/* NXT_SET_CONTROLLER_ID.
+ *
+ * Each OpenFlow controller connection has a 16-bit identifier that is
+ * initially 0. This message changes the connection's ID to 'id'.
+ *
+ * Controller connection IDs need not be unique.
+ *
+ * The NXAST_CONTROLLER action is the only current user of controller
+ * connection IDs. */
+struct nx_controller_id {
+ uint8_t zero[6]; /* Must be zero. */
+ ovs_be16 controller_id; /* New controller connection ID. */
};
-OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
+OFP_ASSERT(sizeof(struct nx_controller_id) == 8);
+\f
+/* Flow Table Monitoring
+ * =====================
+ *
+ * NXST_FLOW_MONITOR allows a controller to keep track of changes to OpenFlow
+ * flow table(s) or subsets of them, with the following workflow:
+ *
+ * 1. The controller sends an NXST_FLOW_MONITOR request to begin monitoring
+ * flows. The 'id' in the request must be unique among all monitors that
+ * the controller has started and not yet canceled on this OpenFlow
+ * connection.
+ *
+ * 2. The switch responds with an NXST_FLOW_MONITOR reply. If the request's
+ * 'flags' included NXFMF_INITIAL, the reply includes all the flows that
+ * matched the request at the time of the request (with event NXFME_ADDED).
+ * If 'flags' did not include NXFMF_INITIAL, the reply is empty.
+ *
+ * The reply uses the xid of the request (as do all replies to OpenFlow
+ * requests).
+ *
+ * 3. Whenever a change to a flow table entry matches some outstanding monitor
+ * request's criteria and flags, the switch sends a notification to the
+ * controller as an additional NXST_FLOW_MONITOR reply with xid 0.
+ *
+ * When multiple outstanding monitors match a single change, only a single
+ * notification is sent. This merged notification includes the information
+ * requested in any of the individual monitors. That is, if any of the
+ * matching monitors requests actions (NXFMF_ACTIONS), the notification
+ * includes actions, and if any of the monitors request full changes for the
+ * controller's own changes (NXFMF_OWN), the controller's own changes will
+ * be included in full.
+ *
+ * 4. The controller may cancel a monitor with NXT_FLOW_MONITOR_CANCEL. No
+ * further notifications will be sent on the basis of the canceled monitor
+ * afterward.
+ *
+ *
+ * Buffer Management
+ * =================
+ *
+ * OpenFlow messages for flow monitor notifications can overflow the buffer
+ * space available to the switch, either temporarily (e.g. due to network
+ * conditions slowing OpenFlow traffic) or more permanently (e.g. the sustained
+ * rate of flow table change exceeds the network bandwidth between switch and
+ * controller).
+ *
+ * When Open vSwitch's notification buffer space reaches a limiting threshold,
+ * OVS reacts as follows:
+ *
+ * 1. OVS sends an NXT_FLOW_MONITOR_PAUSED message to the controller, following
+ * all the already queued notifications. After it receives this message,
+ * the controller knows that its view of the flow table, as represented by
+ * flow monitor notifications, is incomplete.
+ *
+ * 2. As long as the notification buffer is not empty:
+ *
+ * - NXMFE_ADD and NXFME_MODIFIED notifications will not be sent.
+ *
+ * - NXFME_DELETED notifications will still be sent, but only for flows
+ * that existed before OVS sent NXT_FLOW_MONITOR_PAUSED.
+ *
+ * - NXFME_ABBREV notifications will not be sent. They are treated as
+ * the expanded version (and therefore only the NXFME_DELETED
+ * components, if any, are sent).
+ *
+ * 3. When the notification buffer empties, OVS sends NXFME_ADD notifications
+ * for flows added since the buffer reached its limit and NXFME_MODIFIED
+ * notifications for flows that existed before the limit was reached and
+ * changed after the limit was reached.
+ *
+ * 4. OVS sends an NXT_FLOW_MONITOR_RESUMED message to the controller. After
+ * it receives this message, the controller knows that its view of the flow
+ * table, as represented by flow monitor notifications, is again complete.
+ *
+ * This allows the maximum buffer space requirement for notifications to be
+ * bounded by the limit plus the maximum number of supported flows.
+ *
+ *
+ * "Flow Removed" messages
+ * =======================
+ *
+ * The flow monitor mechanism is independent of OFPT_FLOW_REMOVED and
+ * NXT_FLOW_REMOVED. Flow monitor updates for deletion are sent if
+ * NXFMF_DELETE is set on a monitor, regardless of whether the
+ * OFPFF_SEND_FLOW_REM flag was set when the flow was added. */
+
+/* NXST_FLOW_MONITOR request.
+ *
+ * The NXST_FLOW_MONITOR request's body consists of an array of zero or more
+ * instances of this structure. The request arranges to monitor the flows
+ * that match the specified criteria, which are interpreted in the same way as
+ * for NXST_FLOW.
+ *
+ * 'id' identifies a particular monitor for the purpose of allowing it to be
+ * canceled later with NXT_FLOW_MONITOR_CANCEL. 'id' must be unique among
+ * existing monitors that have not already been canceled.
+ *
+ * The reply includes the initial flow matches for monitors that have the
+ * NXFMF_INITIAL flag set. No single flow will be included in the reply more
+ * than once, even if more than one requested monitor matches that flow. The
+ * reply will be empty if none of the monitors has NXFMF_INITIAL set or if none
+ * of the monitors initially matches any flows.
+ *
+ * For NXFMF_ADD, an event will be reported if 'out_port' matches against the
+ * actions of the flow being added or, for a flow that is replacing an existing
+ * flow, if 'out_port' matches against the actions of the flow being replaced.
+ * For NXFMF_DELETE, 'out_port' matches against the actions of a flow being
+ * deleted. For NXFMF_MODIFY, an event will be reported if 'out_port' matches
+ * either the old or the new actions. */
+struct nx_flow_monitor_request {
+ ovs_be32 id; /* Controller-assigned ID for this monitor. */
+ ovs_be16 flags; /* NXFMF_*. */
+ ovs_be16 out_port; /* Required output port, if not OFPP_NONE. */
+ ovs_be16 match_len; /* Length of nx_match. */
+ uint8_t table_id; /* One table's ID or 0xff for all tables. */
+ uint8_t zeros[5]; /* Align to 64 bits (must be zero). */
+ /* Followed by:
+ * - Exactly match_len (possibly 0) bytes containing the nx_match, then
+ * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
+ * all-zero bytes. */
+};
+OFP_ASSERT(sizeof(struct nx_flow_monitor_request) == 16);
+
+/* 'flags' bits in struct nx_flow_monitor_request. */
+enum nx_flow_monitor_flags {
+ /* When to send updates. */
+ NXFMF_INITIAL = 1 << 0, /* Initially matching flows. */
+ NXFMF_ADD = 1 << 1, /* New matching flows as they are added. */
+ NXFMF_DELETE = 1 << 2, /* Old matching flows as they are removed. */
+ NXFMF_MODIFY = 1 << 3, /* Matching flows as they are changed. */
+
+ /* What to include in updates. */
+ NXFMF_ACTIONS = 1 << 4, /* If set, actions are included. */
+ NXFMF_OWN = 1 << 5, /* If set, include own changes in full. */
+};
+
+/* NXST_FLOW_MONITOR reply header.
+ *
+ * The body of an NXST_FLOW_MONITOR reply is an array of variable-length
+ * structures, each of which begins with this header. The 'length' member may
+ * be used to traverse the array, and the 'event' member may be used to
+ * determine the particular structure.
+ *
+ * Every instance is a multiple of 8 bytes long. */
+struct nx_flow_update_header {
+ ovs_be16 length; /* Length of this entry. */
+ ovs_be16 event; /* One of NXFME_*. */
+ /* ...other data depending on 'event'... */
+};
+OFP_ASSERT(sizeof(struct nx_flow_update_header) == 4);
+
+/* 'event' values in struct nx_flow_update_header. */
+enum nx_flow_update_event {
+ /* struct nx_flow_update_full. */
+ NXFME_ADDED = 0, /* Flow was added. */
+ NXFME_DELETED = 1, /* Flow was deleted. */
+ NXFME_MODIFIED = 2, /* Flow (generally its actions) was changed. */
+
+ /* struct nx_flow_update_abbrev. */
+ NXFME_ABBREV = 3, /* Abbreviated reply. */
+};
+
+/* NXST_FLOW_MONITOR reply for NXFME_ADDED, NXFME_DELETED, and
+ * NXFME_MODIFIED. */
+struct nx_flow_update_full {
+ ovs_be16 length; /* Length is 24. */
+ ovs_be16 event; /* One of NXFME_*. */
+ ovs_be16 reason; /* OFPRR_* for NXFME_DELETED, else zero. */
+ ovs_be16 priority; /* Priority of the entry. */
+ ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
+ ovs_be16 hard_timeout; /* Number of seconds before expiration. */
+ ovs_be16 match_len; /* Length of nx_match. */
+ uint8_t table_id; /* ID of flow's table. */
+ uint8_t pad; /* Reserved, currently zeroed. */
+ ovs_be64 cookie; /* Opaque controller-issued identifier. */
+ /* Followed by:
+ * - Exactly match_len (possibly 0) bytes containing the nx_match, then
+ * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
+ * all-zero bytes, then
+ * - Actions to fill out the remainder 'length' bytes (always a multiple
+ * of 8). If NXFMF_ACTIONS was not specified, or 'event' is
+ * NXFME_DELETED, no actions are included.
+ */
+};
+OFP_ASSERT(sizeof(struct nx_flow_update_full) == 24);
+
+/* NXST_FLOW_MONITOR reply for NXFME_ABBREV.
+ *
+ * When the controller does not specify NXFMF_OWN in a monitor request, any
+ * flow tables changes due to the controller's own requests (on the same
+ * OpenFlow channel) will be abbreviated, when possible, to this form, which
+ * simply specifies the 'xid' of the OpenFlow request (e.g. an OFPT_FLOW_MOD or
+ * NXT_FLOW_MOD) that caused the change.
+ *
+ * Some changes cannot be abbreviated and will be sent in full:
+ *
+ * - Changes that only partially succeed. This can happen if, for example,
+ * a flow_mod with type OFPFC_MODIFY affects multiple flows, but only some
+ * of those modifications succeed (e.g. due to hardware limitations).
+ *
+ * This cannot occur with the Open vSwitch software datapath. This also
+ * cannot occur in Open vSwitch 2.4 and later, because these versions only
+ * execute any flow modifications if all of them will succeed.
+ *
+ * - Changes that race with conflicting changes made by other controllers or
+ * other flow_mods (not separated by barriers) by the same controller.
+ *
+ * This cannot occur with the current Open vSwitch implementation
+ * (regardless of datapath) because Open vSwitch internally serializes
+ * potentially conflicting changes.
+ *
+ * - Changes that occur when flow notification is paused (see "Buffer
+ * Management" above).
+ *
+ * A flow_mod that does not change the flow table will not trigger any
+ * notification, even an abbreviated one. For example, a "modify" or "delete"
+ * flow_mod that does not match any flows will not trigger a notification.
+ * Whether an "add" or "modify" that specifies all the same parameters that a
+ * flow already has triggers a notification is unspecified and subject to
+ * change in future versions of Open vSwitch.
+ *
+ * OVS will always send the notifications for a given flow table change before
+ * the reply to a OFPT_BARRIER_REQUEST request that follows the flow table
+ * change. Thus, if the controller does not receive an abbreviated (or
+ * unabbreviated) notification for a flow_mod before the next
+ * OFPT_BARRIER_REPLY, it will never receive one. */
+struct nx_flow_update_abbrev {
+ ovs_be16 length; /* Length is 8. */
+ ovs_be16 event; /* NXFME_ABBREV. */
+ ovs_be32 xid; /* Controller-specified xid from flow_mod. */
+};
+OFP_ASSERT(sizeof(struct nx_flow_update_abbrev) == 8);
+
+/* NXT_FLOW_MONITOR_CANCEL.
+ *
+ * Used by a controller to cancel an outstanding monitor. */
+struct nx_flow_monitor_cancel {
+ ovs_be32 id; /* 'id' from nx_flow_monitor_request. */
+};
+OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 4);
+
+/* Variable-length option TLV table maintenance commands.
+ *
+ * The option in Type-Length-Value format is widely used in tunnel options,
+ * e.g., the base Geneve header is followed by zero or more options in TLV
+ * format. Each option consists of a four byte option header and a variable
+ * amount of option data interpreted according to the type. The generic TLV
+ * format in tunnel options is as following:
+ *
+ * 0 1 2 3
+ * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Option Class | Type |R|R|R| Length |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Variable Option Data |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ *
+ * In order to work with this variable-length options in TLV format in
+ * tunnel options, we need to maintain a mapping table between an option
+ * TLV (defined by <class, type, length>) and an NXM field that can be
+ * operated on for the purposes of matches, actions, etc. This mapping
+ * must be explicitly specified by the user.
+ *
+ * There are two primary groups of OpenFlow messages that are introduced
+ * as Nicira extensions: modification commands (add, delete, clear mappings)
+ * and table status request/reply to dump the current table along with switch
+ * information.
+ *
+ * Note that mappings should not be changed while they are in active use by
+ * a flow. The result of doing so is undefined. */
+
+/* TLV table commands */
+enum nx_tlv_table_mod_command {
+ NXTTMC_ADD, /* New mappings (fails if an option is already
+ mapped). */
+ NXTTMC_DELETE, /* Delete mappings, identified by index
+ * (unmapped options are ignored). */
+ NXTTMC_CLEAR, /* Clear all mappings. Additional information
+ in this command is ignored. */
+};
+
+/* Map between an option TLV and an NXM field. */
+struct nx_tlv_map {
+ ovs_be16 option_class; /* TLV class. */
+ uint8_t option_type; /* TLV type. */
+ uint8_t option_len; /* TLV length (multiple of 4). */
+ ovs_be16 index; /* NXM_NX_TUN_METADATA<n> index */
+ uint8_t pad[2];
+};
+OFP_ASSERT(sizeof(struct nx_tlv_map) == 8);
+
+/* NXT_TLV_TABLE_MOD.
+ *
+ * Use to configure a mapping between option TLVs (class, type, length)
+ * and NXM fields (NXM_NX_TUN_METADATA<n> where 'index' is <n>).
+ *
+ * This command is atomic: all operations on different options will
+ * either succeed or fail. */
+struct nx_tlv_table_mod {
+ ovs_be16 command; /* One of NTTTMC_* */
+ uint8_t pad[6];
+ /* struct nx_tlv_map[0]; Array of maps between indicies and option
+ TLVs. The number of elements is inferred
+ from the length field in the header. */
+};
+OFP_ASSERT(sizeof(struct nx_tlv_table_mod) == 8);
+
+/* NXT_TLV_TABLE_REPLY.
+ *
+ * Issued in reponse to an NXT_TLV_TABLE_REQUEST to give information
+ * about the current status of the TLV table in the switch. Provides
+ * both static information about the switch's capabilities as well as
+ * the configured TLV table. */
+struct nx_tlv_table_reply {
+ ovs_be32 max_option_space; /* Maximum total of option sizes supported. */
+ ovs_be16 max_fields; /* Maximum number of match fields supported. */
+ uint8_t reserved[10];
+ /* struct nx_tlv_map[0]; Array of maps between indicies and option
+ TLVs. The number of elements is inferred
+ from the length field in the header. */
+};
+OFP_ASSERT(sizeof(struct nx_tlv_table_reply) == 16);
#endif /* openflow/nicira-ext.h */