/*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
/* 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,
-
-/* Other errors. */
-
- /* A request specified a nonexistent table ID. (But NXFMFC_BAD_TABLE_ID is
- * used instead, when it is appropriate, because that is such a special
- * case.) */
- NXBRC_BAD_TABLE_ID = 0x200,
-
- /* NXT_ROLE_REQUEST specified an invalid role. */
- NXBRC_BAD_ROLE = 0x201,
-
- /* The in_port in an ofp_packet_out request is invalid. */
- NXBRC_BAD_IN_PORT = 0x202
-};
-
-/* 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. */
/* 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
+ * on struct nx_flow_mod_table_id for more information. */
+ NXT_FLOW_MOD_TABLE_ID = 15,
+
+ /* Alternative PACKET_IN message formats. */
+ NXT_SET_PACKET_IN_FORMAT = 16, /* Set Packet In format. */
+ NXT_PACKET_IN = 17 /* Nicira Packet In. */
};
/* Header for Nicira vendor stats request and reply messages. */
* 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 nx_flow_mod_table_id {
struct ofp_header header;
uint32_t vendor; /* NX_VENDOR_ID. */
uint32_t subtype; /* NXT_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) == 24);
+
+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 {
+ struct nicira_header nxh;
+ ovs_be32 format; /* One of NXPIF_*. */
+};
+OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 20);
+
+/* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
+ *
+ * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN
+ * with some minor tweaks. Most notably NXT_PACKET_IN includes the cookie of
+ * the rule which triggered the NXT_PACKET_IN message, and the match fields are
+ * in NXM format.
+ *
+ * The match fields in the NXT_PACKET_IN are intended to contain flow
+ * processing metadata collected at the time the NXT_PACKET_IN message was
+ * triggered. It is minimally required to contain the NXM_OF_IN_PORT of the
+ * packet, but may include other NXM headers such as flow registers. The match
+ * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc).
+ * However, this information can typically be found in the packet directly, so
+ * it may be redundant.
+ *
+ * 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' and 'table_id' fields have no meaning when 'reason' is
+ * OFPR_NO_MATCH. In this case they should be set to 0. */
+struct nx_packet_in {
+ struct nicira_header nxh;
+ 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[...]; */ /* Match. */
+ /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */
+ /* uint8_t data[0]; */ /* Ethernet frame. */
+};
+OFP_ASSERT(sizeof(struct nx_packet_in) == 40);
/* Configures the "role" of the sending controller. The default role is:
*
struct nicira_header nxh;
ovs_be32 role; /* One of NX_ROLE_*. */
};
+OFP_ASSERT(sizeof(struct nx_role_request) == 20);
enum nx_role {
NX_ROLE_OTHER, /* Default role, full access. */
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_EXIT, /* struct nx_action_header */
+ NXAST_DEC_TTL, /* struct nx_action_header */
};
/* Header for Nicira-defined actions. */
* Masking: Not maskable. */
#define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
+/* Flow cookie.
+ *
+ * This may be used to gain the OpenFlow 1.1-like ability to restrict
+ * certain NXM-based Flow Mod and Flow Stats Request messages to flows
+ * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
+ * structure definitions for more details. This match is otherwise not
+ * allowed.
+ *
+ * Prereqs: None.
+ *
+ * Format: 64-bit integer in network byte order.
+ *
+ * Masking: Arbitrary masks. */
+#define NXM_NX_COOKIE NXM_HEADER (0x0001, 30, 8)
+#define NXM_NX_COOKIE_W NXM_HEADER_W(0x0001, 30, 8)
+
/* ## --------------------- ## */
/* ## Requests and replies. ## */
/* ## --------------------- ## */
};
/* NXT_SET_FLOW_FORMAT request. */
-struct nxt_set_flow_format {
+struct nx_set_flow_format {
struct ofp_header header;
ovs_be32 vendor; /* NX_VENDOR_ID. */
ovs_be32 subtype; /* NXT_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) == 20);
-/* 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 and NXM_NX_COOKIE_W matches. For
+ * these commands, the "cookie" field is always ignored. Flow additions
+ * make use of the "cookie" field and ignore any NXM_NX_COOKIE*
+ * definitions.
+ */
struct nx_flow_mod {
struct nicira_header nxh;
ovs_be64 cookie; /* Opaque controller-issued identifier. */
OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
/* 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
git://git.onelab.eu / sliver-openvswitch.git / blobdiff