#define OFP_PACKED /* SWIG doesn't understand __attribute. */
#endif
-/* Maximum length of a OpenFlow packet. */
-#define OFP_MAXLEN (sizeof(struct ofp_switch_features) \
- + (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200)
-
-
/* The most significant bit being set in the version field indicates an
* experimental OpenFlow version.
*/
-#define OFP_VERSION 0x89
+#define OFP_VERSION 0x94
#define OFP_MAX_TABLE_NAME_LEN 32
#define OFP_MAX_PORT_NAME_LEN 16
/* Port numbering. Physical ports are numbered starting from 0. */
enum ofp_port {
/* Maximum number of physical switch ports. */
- OFPP_MAX = 0x100,
+ OFPP_MAX = 255,
/* Fake output "ports". */
OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
};
enum ofp_type {
- OFPT_FEATURES_REQUEST, /* 0 Controller/switch message */
- OFPT_FEATURES_REPLY, /* 1 Controller/switch message */
- OFPT_GET_CONFIG_REQUEST, /* 2 Controller/switch message */
- OFPT_GET_CONFIG_REPLY, /* 3 Controller/switch message */
- OFPT_SET_CONFIG, /* 4 Controller/switch message */
- OFPT_PACKET_IN, /* 5 Async message */
- OFPT_PACKET_OUT, /* 6 Controller/switch message */
- OFPT_FLOW_MOD, /* 7 Controller/switch message */
- OFPT_FLOW_EXPIRED, /* 8 Async message */
- OFPT_TABLE, /* 9 Controller/switch message */
- OFPT_PORT_MOD, /* 10 Controller/switch message */
- OFPT_PORT_STATUS, /* 11 Async message */
- OFPT_ERROR_MSG, /* 12 Async message */
- OFPT_STATS_REQUEST, /* 13 Controller/switch message */
- OFPT_STATS_REPLY, /* 14 Controller/switch message */
- OFPT_ECHO_REQUEST, /* 15 Symmetric message */
- OFPT_ECHO_REPLY /* 16 Symmetric message */
+ /* Immutable messages. */
+ OFPT_HELLO, /* Symmetric message */
+ OFPT_ERROR, /* Symmetric message */
+ OFPT_ECHO_REQUEST, /* Symmetric message */
+ OFPT_ECHO_REPLY, /* Symmetric message */
+ OFPT_VENDOR, /* Symmetric message */
+
+ /* Switch configuration messages. */
+ OFPT_FEATURES_REQUEST, /* Controller/switch message */
+ OFPT_FEATURES_REPLY, /* Controller/switch message */
+ OFPT_GET_CONFIG_REQUEST, /* Controller/switch message */
+ OFPT_GET_CONFIG_REPLY, /* Controller/switch message */
+ OFPT_SET_CONFIG, /* Controller/switch message */
+
+ /* Asynchronous messages. */
+ OFPT_PACKET_IN, /* Async message */
+ OFPT_FLOW_EXPIRED, /* Async message */
+ OFPT_PORT_STATUS, /* Async message */
+
+ /* Controller command messages. */
+ OFPT_PACKET_OUT, /* Controller/switch message */
+ OFPT_FLOW_MOD, /* Controller/switch message */
+ OFPT_PORT_MOD, /* Controller/switch message */
+ OFPT_TABLE, /* Controller/switch message */
+
+ /* Statistics messages. */
+ OFPT_STATS_REQUEST, /* Controller/switch message */
+ OFPT_STATS_REPLY /* Controller/switch message */
};
/* Header on all OpenFlow packets. */
};
OFP_ASSERT(sizeof(struct ofp_header) == 8);
+/* OFPT_HELLO. This message has an empty body, but implementations must
+ * ignore any data included in the body, to allow for future extensions. */
+struct ofp_hello {
+ struct ofp_header header;
+};
+
#define OFP_DEFAULT_MISS_SEND_LEN 128
enum ofp_config_flags {
/* Capabilities supported by the datapath. */
enum ofp_capabilities {
- OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
- OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
- OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
- OFPC_STP = 1 << 3, /* 802.11d spanning tree. */
- OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
- physical interfaces */
- OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
+ OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
+ OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
+ OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
+ OFPC_STP = 1 << 3, /* 802.1d spanning tree. */
+ OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
+ physical interfaces */
+ OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
+};
+
+/* Flags to indicate behavior of the physical port. These flags are
+ * used in ofp_phy_port to describe the current configuration. They are
+ * used in the ofp_port_mod message to configure the port's behavior.
+ */
+enum ofp_port_config {
+ OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
+
+ OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
+ OFPPC_NO_RECV = 1 << 2, /* Drop most packets received on port. */
+ OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
+ OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
+ OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
+ OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
};
-/* Flags to indicate behavior of the physical port */
-enum ofp_port_flags {
- OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding. */
- OFPPFL_PORT_DOWN = 1 << 1, /* Port is configured down. */
- OFPPFL_LINK_DOWN = 1 << 2, /* No physical link on interface.
- NOTE: Non-settable field */
+/* Current state of the physical port. These are not configurable from
+ * the controller.
+ */
+enum ofp_port_state {
+ OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
+
+ /* The OFPPS_STP_* bits have no effect on switch operation. The
+ * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
+ * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
+ * tree. */
+ OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
+ OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
+ OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
+ OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
+ OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
};
/* Features of physical ports available in a datapath. */
enum ofp_port_features {
- OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
- OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
- OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
- OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
- OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
- OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
- OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
+ OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
+ OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
+ OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
+ OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
+ OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
+ OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
+ OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
+ OFPPF_COPPER = 1 << 7, /* Copper medium */
+ OFPPF_FIBER = 1 << 8, /* Fiber medium */
+ OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation */
+ OFPPF_PAUSE = 1 << 10, /* Pause */
+ OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause */
};
-
/* Description of a physical port */
struct ofp_phy_port {
uint16_t port_no;
uint8_t hw_addr[OFP_ETH_ALEN];
uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
- uint32_t flags; /* Bitmap of "ofp_port_flags". */
- uint32_t speed; /* Current speed in Mbps */
- uint32_t features; /* Bitmap of supported "ofp_port_features"s. */
+
+ uint32_t config; /* Bitmap of OFPPC_* flags. */
+ uint32_t state; /* Bitmap of OFPPS_* flags. */
+
+ /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
+ * unsupported or unavailable. */
+ uint32_t curr; /* Current features. */
+ uint32_t advertised; /* Features being advertised by the port. */
+ uint32_t supported; /* Features supported by the port. */
+ uint32_t peer; /* Features advertised by peer. */
};
-OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
+OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
/* Switch features. */
struct ofp_switch_features {
uint64_t datapath_id; /* Datapath unique ID. Only the lower 48-bits
are meaningful. */
- /* Table info. */
- uint32_t n_exact; /* Max exact-match table entries. */
- uint32_t n_compression; /* Max entries compressed on service port. */
- uint32_t n_general; /* Max entries of arbitrary form. */
-
- /* Buffer limits. A datapath that cannot buffer reports 0.*/
- uint32_t buffer_mb; /* Space for buffering packets, in MB. */
uint32_t n_buffers; /* Max packets buffered at once. */
+ uint8_t n_tables; /* Number of tables supported by datapath. */
+ uint8_t pad[3]; /* Align to 64-bits. */
+
/* Features. */
uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
- uint8_t pad[4]; /* Align to 64-bits. */
/* Port info.*/
struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
is inferred from the length field in
the header. */
};
-OFP_ASSERT(sizeof(struct ofp_switch_features) == 48);
+OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
/* What changed about the physical port */
enum ofp_port_reason {
OFPPR_ADD, /* The port was added */
OFPPR_DELETE, /* The port was removed */
- OFPPR_MOD /* Some attribute of the port has changed */
+ OFPPR_MODIFY /* Some attribute of the port has changed */
};
/* A physical port has changed in the datapath */
struct ofp_port_status {
struct ofp_header header;
uint8_t reason; /* One of OFPPR_* */
- uint8_t pad[3]; /* Align to 32-bits */
+ uint8_t pad[7]; /* Align to 64-bits */
struct ofp_phy_port desc;
};
-OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
+OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
/* Modify behavior of the physical port */
struct ofp_port_mod {
struct ofp_header header;
- uint32_t mask; /* Bitmap of "ofp_port_flags" that should be
- changed. */
- struct ofp_phy_port desc;
+ uint16_t port_no;
+ uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
+ configurable. This is used to
+ sanity-check the request, so it must
+ be the same as returned in an
+ ofp_phy_port struct. */
+
+ uint32_t config; /* Bitmap of OFPPC_* flags. */
+ uint32_t mask; /* Bitmap of OFPPC_* flags to be changed. */
+
+ uint32_t advertise; /* Bitmap of "ofp_port_features"s. Zero all
+ bits to prevent any action taking place. */
+ uint8_t pad[4]; /* Pad to 64-bits. */
};
-OFP_ASSERT(sizeof(struct ofp_port_mod) == 48);
+OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
/* Why is this packet being sent to the controller? */
enum ofp_packet_in_reason {
OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
enum ofp_action_type {
- OFPAT_OUTPUT, /* Output to switch port. */
- OFPAT_SET_DL_VLAN, /* VLAN. */
- OFPAT_SET_DL_SRC, /* Ethernet source address. */
- OFPAT_SET_DL_DST, /* Ethernet destination address. */
- OFPAT_SET_NW_SRC, /* IP source address. */
- OFPAT_SET_NW_DST, /* IP destination address. */
- OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
- OFPAT_SET_TP_DST /* TCP/UDP destination port. */
+ OFPAT_OUTPUT, /* Output to switch port. */
+ OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
+ OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
+ OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
+ OFPAT_SET_DL_SRC, /* Ethernet source address. */
+ OFPAT_SET_DL_DST, /* Ethernet destination address. */
+ OFPAT_SET_NW_SRC, /* IP source address. */
+ OFPAT_SET_NW_DST, /* IP destination address. */
+ OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
+ OFPAT_SET_TP_DST /* TCP/UDP destination port. */
};
/* An output action sends packets out 'port'. When the 'port' is the
};
OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
-/* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
- * special conditions. All ones is used to indicate that no VLAN id was
- * set, or if used as an action, that the VLAN header should be
- * stripped.
- */
-#define OFP_VLAN_NONE 0xffff
-
struct ofp_action {
uint16_t type; /* One of OFPAT_* */
union {
struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
- uint16_t vlan_id; /* OFPAT_SET_DL_VLAN: VLAN id. */
+ uint8_t vlan_pcp; /* OFPAT_SET_VLAN_PCP: priority. */
+ uint16_t vlan_vid; /* OFPAT_SET_VLAN_VID: VLAN id. */
uint8_t dl_addr[OFP_ETH_ALEN]; /* OFPAT_SET_DL_SRC/DST */
uint32_t nw_addr OFP_PACKED; /* OFPAT_SET_NW_SRC/DST */
uint16_t tp; /* OFPAT_SET_TP_SRC/DST */
enum ofp_flow_mod_command {
OFPFC_ADD, /* New flow. */
+ OFPFC_MODIFY, /* Modify all matching flows. */
+ OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
OFPFC_DELETE, /* Delete all matching flows. */
OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
};
*/
#define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
+/* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
+ * special conditions. All ones indicates that no VLAN id was set.
+ */
+#define OFP_VLAN_NONE 0xffff
+
/* Fields to match against flows */
struct ofp_match {
uint32_t wildcards; /* Wildcard fields. */
uint16_t idle_timeout; /* Idle time before discarding (seconds). */
uint16_t hard_timeout; /* Max time before discarding (seconds). */
uint16_t priority; /* Priority level of flow entry. */
- uint32_t buffer_id; /* Buffered packet to apply to (or -1). */
+ uint32_t buffer_id; /* Buffered packet to apply to (or -1).
+ Not meaningful for OFPFC_DELETE*. */
uint32_t reserved; /* Reserved for future use. */
struct ofp_action actions[0]; /* The number of actions is inferred from
- the length field in the header. */
+ the length field in the header. */
};
OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
};
OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
-/* Error message (datapath -> controller). */
+/* Values for 'type' in ofp_error_message. These values are immutable: they
+ * will not change in future versions of the protocol (although new values may
+ * be added). */
+enum ofp_error_type {
+ OFPET_HELLO_FAILED, /* Hello protocol failed. */
+ OFPET_BAD_REQUEST /* Request was not understood. */
+};
+
+/* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
+ * ASCII text string that may give failure details. */
+enum ofp_hello_failed_code {
+ OFPHFC_INCOMPATIBLE /* No compatible version. */
+};
+
+/* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
+ * the first 64 bytes of the failed request. */
+enum ofp_bad_request_code {
+ OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
+ OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
+ OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
+ OFPBRC_BAD_VENDOR /* Vendor not supported (in ofp_vendor or
+ * ofp_stats_request or ofp_stats_reply). */
+};
+
+/* OFPT_ERROR: Error message (datapath -> controller). */
struct ofp_error_msg {
struct ofp_header header;
* The reply body is an array of struct ofp_port_stats. */
OFPST_PORT,
- /* Switch status.
- * The request body is an ASCII string that specifies a prefix of the key
- * names to include in the output; if it is the null string, then all
- * key-value pairs are included.
- * The reply body is an ASCII string of key-value pairs in the form
- * "key=value\n". */
- OFPST_SWITCH
+ /* Vendor extension.
+ * The request and reply bodies begin with a 32-bit vendor ID, which takes
+ * the same form as in "struct ofp_vendor". The request and reply bodies
+ * are otherwise vendor-defined. */
+ OFPST_VENDOR = 0xffff
};
struct ofp_stats_request {
OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
enum ofp_stats_reply_flags {
- OFPSF_REPLY_MORE = 1 << 0, /* More replies to follow */
+ OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow */
};
struct ofp_stats_reply {
/* Body of reply to OFPST_TABLE request. */
struct ofp_table_stats {
- uint8_t table_id;
+ uint8_t table_id; /* Identifier of table. Lower numbered tables
+ are consulted first. */
uint8_t pad[3]; /* Align to 32-bits */
char name[OFP_MAX_TABLE_NAME_LEN];
+ uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
+ supported by the table. */
uint32_t max_entries; /* Max number of entries supported */
uint32_t active_count; /* Number of active entries */
- uint8_t pad2[4]; /* Align to 64 bits. */
+ uint64_t lookup_count; /* Number of packets looked up in table */
uint64_t matched_count; /* Number of packets that hit table */
};
-OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
+OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
/* Body of reply to OFPST_PORT request. If a counter is unsupported, set
* the field to all ones. */
};
OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
+/* Vendor extension. */
+struct ofp_vendor {
+ struct ofp_header header; /* Type OFPT_VENDOR. */
+ uint32_t vendor; /* Vendor ID:
+ * - MSB 0: low-order bytes are IEEE OUI.
+ * - MSB != 0: defined by OpenFlow
+ * consortium. */
+ /* Vendor-defined arbitrary additional data. */
+};
+OFP_ASSERT(sizeof(struct ofp_vendor) == 12);
+
#endif /* openflow.h */
git://git.onelab.eu / sliver-openvswitch.git / blobdiff