-/* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
+/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
+ * Junior University
+ *
+ * We are making the OpenFlow specification and associated documentation
+ * (Software) available for public use and benefit with the expectation
+ * that others will use, modify and enhance the Software and contribute
+ * those enhancements back to the community. However, since we would
+ * like to make the Software available for broadest use, with as few
+ * restrictions as possible permission is hereby granted, free of
+ * charge, to any person obtaining a copy of this Software to deal in
+ * the Software under the copyrights without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * The name and trademarks of copyright holder(s) may NOT be used in
+ * advertising or publicity pertaining to the Software or any
+ * derivatives without specific, written prior permission.
*/
/* OpenFlow: protocol between controller and datapath. */
#include <stdint.h>
#endif
+#ifdef SWIG
+#define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
+#elif !defined(__cplusplus)
+/* Build-time assertion for use in a declaration context. */
+#define OFP_ASSERT(EXPR) \
+ extern int (*build_assert(void))[ sizeof(struct { \
+ unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
+#else /* __cplusplus */
+#include <boost/static_assert.hpp>
+#define OFP_ASSERT BOOST_STATIC_ASSERT
+#endif /* __cplusplus */
+
+#ifndef SWIG
+#define OFP_PACKED __attribute__((packed))
+#else
+#define OFP_PACKED /* SWIG doesn't understand __attribute. */
+#endif
+
/* Maximum length of a OpenFlow packet. */
-#define OFP_MAXLEN (sizeof(struct ofp_data_hello) \
+#define OFP_MAXLEN (sizeof(struct ofp_switch_features) \
+ (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200)
-#define OFP_VERSION 1
+
+/* The most significant bit being set in the version field indicates an
+ * experimental OpenFlow version.
+ */
+#define OFP_VERSION 0x89
+
#define OFP_MAX_TABLE_NAME_LEN 32
#define OFP_MAX_PORT_NAME_LEN 16
OFPP_MAX = 0x100,
/* Fake output "ports". */
- OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching */
+ OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
+ virtual port must be explicitly used
+ in order to send back out of the input
+ port. */
+ OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
+ NB: This can only be the destination
+ port for packet-out messages. */
+ OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
those disabled by STP. */
OFPP_ALL = 0xfffc, /* All physical ports except input port. */
OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
- OFPP_LOCAL = 0xfffe, /* Local openflow "port". */ /* xxx Want?! */
+ OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
OFPP_NONE = 0xffff /* Not associated with a physical port. */
};
enum ofp_type {
- OFPT_CONTROL_HELLO, /* 0 Controller/switch message */
- OFPT_DATA_HELLO, /* 1 Controller/switch message */
- OFPT_PACKET_IN, /* 2 Async message */
- OFPT_PACKET_OUT, /* 3 Controller/switch message */
- OFPT_FLOW_MOD, /* 4 Controller/switch message */
- OFPT_FLOW_EXPIRED, /* 5 Async message */
- OFPT_TABLE, /* 6 Controller/switch message */
- OFPT_PORT_MOD, /* 7 Controller/switch message */
- OFPT_PORT_STATUS, /* 8 Async message */
- OFPT_FLOW_STAT_REQUEST, /* 9 Controller/switch message */
- OFPT_FLOW_STAT_REPLY, /* 10 Controller/switch message */
- OFPT_TABLE_STAT_REQUEST, /* 11 Controller/switch message */
- OFPT_TABLE_STAT_REPLY, /* 12 Controller/switch message */
- OFPT_PORT_STAT_REQUEST, /* 13 Controller/switch message */
- OFPT_PORT_STAT_REPLY /* 14 Controller/switch message */
+ 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 */
};
/* Header on all OpenFlow packets. */
struct ofp_header {
- uint8_t version; /* Always 1. */
+ uint8_t version; /* OFP_VERSION. */
uint8_t type; /* One of the OFPT_ constants. */
uint16_t length; /* Length including this ofp_header. */
uint32_t xid; /* Transactin id associated with this packet.
Replies use the same id as was in the request
to facilitate pairing. */
};
+OFP_ASSERT(sizeof(struct ofp_header) == 8);
#define OFP_DEFAULT_MISS_SEND_LEN 128
-#define OFP_MISS_SEND_LEN_UNCHANGED 0xffff
-/* Flag to indicate that datapath should notify the controller of
- * expired flow entries.
- */
-#define OFP_CHELLO_SEND_FLOW_EXP 0x0001
+enum ofp_config_flags {
+ /* Tells datapath to notify the controller of expired flow entries. */
+ OFPC_SEND_FLOW_EXP = 1 << 0,
+
+ /* Handling of IP fragments. */
+ OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */
+ OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */
+ OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
+ OFPC_FRAG_MASK = 3 << 1
+};
-/* Controller hello (controller -> datapath). */
-struct ofp_control_hello {
+/* Switch configuration. */
+struct ofp_switch_config {
struct ofp_header header;
- uint32_t version; /* Max supported protocol version (?) */
- uint16_t flags;
- uint16_t miss_send_len; /* Max bytes of new flow that datapath should
- send to the controller. A value of
- OFP_MISS_SEND_LEN_UNCHANGED leaves the
- currently configured value unchanged. */
+ uint16_t flags; /* OFPC_* flags. */
+ uint16_t miss_send_len; /* Max bytes of new flow that datapath should
+ send to the controller. */
};
+OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
/* Capabilities supported by the datapath. */
enum ofp_capabilities {
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
+ 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 */
enum ofp_port_flags {
- OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding */
+ 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 */
};
/* Features of physical ports available in a datapath. */
uint32_t speed; /* Current speed in Mbps */
uint32_t features; /* Bitmap of supported "ofp_port_features"s. */
};
+OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
-/* Datapath hello (datapath -> controller). */
-struct ofp_data_hello {
+/* Switch features. */
+struct ofp_switch_features {
struct ofp_header header;
- uint64_t datapath_id; /* Datapath unique ID */
+ 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_mac_only; /* Max mac-only table entries. */
- uint32_t n_compression; /* Max entries compressed on service port. */
+ 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.*/
/* Features. */
uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
-
- /* Miscellany */
- uint16_t miss_send_len; /* Currently configured value for max bytes
- of new flow that datapath will send to the
- controller. */
- uint8_t pad[2]; /* Align to 32-bits */
+ 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
+ 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);
-/* What changed about the phsyical port */
+/* What changed about the physical port */
enum ofp_port_reason {
OFPPR_ADD, /* The port was added */
OFPPR_DELETE, /* The port was removed */
uint8_t pad[3]; /* Align to 32-bits */
struct ofp_phy_port desc;
};
+OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
/* 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;
};
+OFP_ASSERT(sizeof(struct ofp_port_mod) == 48);
/* Why is this packet being sent to the controller? */
-enum ofp_reason {
+enum ofp_packet_in_reason {
OFPR_NO_MATCH, /* No matching flow. */
OFPR_ACTION /* Action explicitly output to controller. */
};
offsetof(struct ofp_packet_in, data) ==
sizeof(struct ofp_packet_in) - 2. */
};
+OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
enum ofp_action_type {
OFPAT_OUTPUT, /* Output to switch port. */
uint16_t max_len;
uint16_t port;
};
+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
struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
uint16_t vlan_id; /* OFPAT_SET_DL_VLAN: VLAN id. */
uint8_t dl_addr[OFP_ETH_ALEN]; /* OFPAT_SET_DL_SRC/DST */
- uint32_t nw_addr; /* OFPAT_SET_NW_SRC/DST */
+ uint32_t nw_addr OFP_PACKED; /* OFPAT_SET_NW_SRC/DST */
uint16_t tp; /* OFPAT_SET_TP_SRC/DST */
} arg;
};
+OFP_ASSERT(sizeof(struct ofp_action) == 8);
/* Send packet (controller -> datapath). */
struct ofp_packet_out {
struct ofp_header header;
- uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
- uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
- uint16_t out_port; /* Output port (if buffer_id == -1). */
- union {
- struct ofp_action actions[0]; /* buffer_id != -1 */
- uint8_t data[0]; /* buffer_id == -1 */
- } u;
+ uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
+ uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
+ uint16_t n_actions; /* Number of actions. */
+ struct ofp_action actions[0]; /* Actions. */
+ /* uint8_t data[0]; */ /* Packet data. The length is inferred
+ from the length field in the header.
+ (Only meaningful if buffer_id == -1.) */
};
+OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
enum ofp_flow_mod_command {
OFPFC_ADD, /* New flow. */
OFPFC_DELETE, /* Delete all matching flows. */
- OFPFC_DELETE_STRICT /* Strictly match wildcards. */
+ OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
};
/* Flow wildcards. */
OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
- OFPFW_NW_SRC = 1 << 5, /* IP source address. */
- OFPFW_NW_DST = 1 << 6, /* IP destination address. */
- OFPFW_NW_PROTO = 1 << 7, /* IP protocol. */
- OFPFW_TP_SRC = 1 << 8, /* TCP/UDP source port. */
- OFPFW_TP_DST = 1 << 9, /* TCP/UDP destination port. */
- OFPFW_ALL = (1 << 10) - 1
+ OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
+ OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
+ OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
+
+ /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
+ * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
+ * the entire field. This is the *opposite* of the usual convention where
+ * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
+ OFPFW_NW_SRC_SHIFT = 8,
+ OFPFW_NW_SRC_BITS = 6,
+ OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
+ OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
+
+ /* IP destination address wildcard bit count. Same format as source. */
+ OFPFW_NW_DST_SHIFT = 14,
+ OFPFW_NW_DST_BITS = 6,
+ OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
+ OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
+
+ /* Wildcard all fields. */
+ OFPFW_ALL = ((1 << 20) - 1)
};
/* Values below this cutoff are 802.3 packets and the two bytes
/* Fields to match against flows */
struct ofp_match {
- uint16_t wildcards; /* Wildcard fields. */
+ uint32_t wildcards; /* Wildcard fields. */
uint16_t in_port; /* Input switch port. */
uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
uint16_t dl_vlan; /* Input VLAN. */
uint16_t dl_type; /* Ethernet frame type. */
+ uint8_t nw_proto; /* IP protocol. */
+ uint8_t pad; /* Align to 32-bits. */
uint32_t nw_src; /* IP source address. */
uint32_t nw_dst; /* IP destination address. */
- uint8_t nw_proto; /* IP protocol. */
- uint8_t pad[3]; /* Align to 32-bits */
uint16_t tp_src; /* TCP/UDP source port. */
uint16_t tp_dst; /* TCP/UDP destination port. */
};
+OFP_ASSERT(sizeof(struct ofp_match) == 36);
-/* Value used in "max_idle" to indicate that the entry is permanent */
+/* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
+ * is permanent. */
#define OFP_FLOW_PERMANENT 0
+/* By default, choose a priority in the middle */
+#define OFP_DEFAULT_PRIORITY 0x8000
+
/* Flow setup and teardown (controller -> datapath). */
struct ofp_flow_mod {
struct ofp_header header;
struct ofp_match match; /* Fields to match */
/* Flow actions. */
- uint16_t command; /* One of OFPFC_*. */
- uint16_t max_idle; /* Idle time before discarding (seconds). */
- uint32_t buffer_id; /* Buffered packet to apply to (or -1). */
- uint32_t group_id; /* Flow group ID (for QoS). */
+ uint16_t command; /* One of OFPFC_*. */
+ 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 reserved; /* Reserved for future use. */
struct ofp_action actions[0]; /* The number of actions is inferred from
the length field in the header. */
};
+OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
+
+/* Why did this flow expire? */
+enum ofp_flow_expired_reason {
+ OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
+ OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */
+};
/* Flow expiration (datapath -> controller). */
struct ofp_flow_expired {
struct ofp_header header;
struct ofp_match match; /* Description of fields */
+ uint16_t priority; /* Priority level of flow entry. */
+ uint8_t reason; /* One of OFPER_*. */
+ uint8_t pad[1]; /* Align to 32-bits. */
+
uint32_t duration; /* Time flow was alive in seconds. */
+ uint8_t pad2[4]; /* Align to 64-bits. */
uint64_t packet_count;
uint64_t byte_count;
};
+OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
-/* Statistics about flows that match the "match" field */
-struct ofp_flow_stats {
- struct ofp_match match; /* Description of fields */
- uint32_t duration; /* Time flow has been alive in seconds. Only
- used for non-aggregated results. */
- uint64_t packet_count;
- uint64_t byte_count;
+/* Error message (datapath -> controller). */
+struct ofp_error_msg {
+ struct ofp_header header;
+
+ uint16_t type;
+ uint16_t code;
+ uint8_t data[0]; /* Variable-length data. Interpreted based
+ on the type and code. */
+};
+OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
+
+enum ofp_stats_types {
+ /* Description of this OpenFlow switch.
+ * The request body is empty.
+ * The reply body is struct ofp_version_stats. */
+ OFPST_VERSION,
+
+ /* Individual flow statistics.
+ * The request body is struct ofp_flow_stats_request.
+ * The reply body is an array of struct ofp_flow_stats. */
+ OFPST_FLOW,
+
+ /* Aggregate flow statistics.
+ * The request body is struct ofp_aggregate_stats_request.
+ * The reply body is struct ofp_aggregate_stats_reply. */
+ OFPST_AGGREGATE,
+
+ /* Flow table statistics.
+ * The request body is empty.
+ * The reply body is an array of struct ofp_table_stats. */
+ OFPST_TABLE,
+
+ /* Physical port statistics.
+ * The request body is empty.
+ * 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
+};
+
+struct ofp_stats_request {
+ struct ofp_header header;
+ uint16_t type; /* One of the OFPST_* constants. */
+ uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
+ uint8_t body[0]; /* Body of the request. */
};
+OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
-enum {
- OFPFS_INDIV, /* Send an entry for each matching flow */
- OFPFS_AGGREGATE /* Aggregate matching flows */
+enum ofp_stats_reply_flags {
+ OFPSF_REPLY_MORE = 1 << 0, /* More replies to follow */
};
-/* Current flow statistics request */
-struct ofp_flow_stat_request {
+struct ofp_stats_reply {
struct ofp_header header;
+ uint16_t type; /* One of the OFPST_* constants. */
+ uint16_t flags; /* OFPSF_REPLY_* flags. */
+ uint8_t body[0]; /* Body of the reply. */
+};
+OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
+
+#define VERSION_STR_LEN 256
+/* Body of reply to OFPST_VERSION request. Each entry is a NULL-terminated
+ * ASCII string. */
+struct ofp_version_stats {
+ char mfr_desc[VERSION_STR_LEN]; /* Manufacturer description. */
+ char hw_desc[VERSION_STR_LEN]; /* Hardware description. */
+ char sw_desc[VERSION_STR_LEN]; /* Software description. */
+};
+OFP_ASSERT(sizeof(struct ofp_version_stats) == 768);
+
+/* Body for ofp_stats_request of type OFPST_FLOW. */
+struct ofp_flow_stats_request {
struct ofp_match match; /* Fields to match */
- uint8_t type; /* One of OFPFS_ */
- uint8_t pad[3]; /* Align to 32-bits */
+ uint8_t table_id; /* ID of table to read (from ofp_table_stats)
+ or 0xff for all tables. */
+ uint8_t pad[3]; /* Align to 32 bits. */
};
+OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
-/* Current flow statistics reply */
-struct ofp_flow_stat_reply {
- struct ofp_header header;
+/* Body of reply to OFPST_FLOW request. */
+struct ofp_flow_stats {
+ uint16_t length; /* Length of this entry. */
+ uint8_t table_id; /* ID of table flow came from. */
+ uint8_t pad;
+ struct ofp_match match; /* Description of fields. */
+ uint32_t duration; /* Time flow has been alive in seconds. */
+ uint16_t priority; /* Priority of the entry. Only meaningful
+ when this is not an exact-match entry. */
+ uint16_t idle_timeout; /* Number of seconds idle before expiration. */
+ uint16_t hard_timeout; /* Number of seconds before expiration. */
+ uint16_t pad2[3]; /* Pad to 64 bits. */
+ uint64_t packet_count; /* Number of packets in flow. */
+ uint64_t byte_count; /* Number of bytes in flow. */
+ struct ofp_action actions[0]; /* Actions. */
+};
+OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
+
+/* Body for ofp_stats_request of type OFPST_AGGREGATE. */
+struct ofp_aggregate_stats_request {
+ struct ofp_match match; /* Fields to match */
+ uint8_t table_id; /* ID of table to read (from ofp_table_stats)
+ or 0xff for all tables. */
+ uint8_t pad[3]; /* Align to 32 bits. */
+};
+OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
+
+/* Body of reply to OFPST_AGGREGATE request. */
+struct ofp_aggregate_stats_reply {
+ uint64_t packet_count; /* Number of packets in flows. */
+ uint64_t byte_count; /* Number of bytes in flows. */
+ uint32_t flow_count; /* Number of flows. */
+ uint8_t pad[4]; /* Align to 64 bits. */
+};
+OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
- /* If request was of type OFPFS_INDIV, this will contain an array of
- * flow statistic entries. The number of matching flows is likely
- * much larger than can fit in a single OpenFlow message, so a
- * a response with no flows included is sent to indicate the end.
- * If it was a OFPFS_AGGREGATE request, only a single flow stats
- * entry will be contained in the response.
- */
- struct ofp_flow_stats flows[0];
+/* Body of reply to OFPST_TABLE request. */
+struct ofp_table_stats {
+ uint8_t table_id;
+ uint8_t pad[3]; /* Align to 32-bits */
+ char name[OFP_MAX_TABLE_NAME_LEN];
+ 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 matched_count; /* Number of packets that hit table */
};
+OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
-/* Table attributes collected at runtime */
-struct ofp_table {
- struct ofp_header header;
- char name[OFP_MAX_TABLE_NAME_LEN];
- uint16_t table_id;
- unsigned long int n_flows;
- unsigned long int max_flows;
+/* Body of reply to OFPST_PORT request. If a counter is unsupported, set
+ * the field to all ones. */
+struct ofp_port_stats {
+ uint16_t port_no;
+ uint8_t pad[6]; /* Align to 64-bits. */
+ uint64_t rx_packets; /* Number of received packets. */
+ uint64_t tx_packets; /* Number of transmitted packets. */
+ uint64_t rx_bytes; /* Number of received bytes. */
+ uint64_t tx_bytes; /* Number of transmitted bytes. */
+ uint64_t rx_dropped; /* Number of packets dropped by RX. */
+ uint64_t tx_dropped; /* Number of packets dropped by TX. */
+ uint64_t rx_errors; /* Number of receive errors. This is a super-set
+ of receive errors and should be great than or
+ equal to the sum of al rx_*_err values. */
+ uint64_t tx_errors; /* Number of transmit errors. This is a super-set
+ of transmit errors. */
+ uint64_t rx_frame_err; /* Number of frame alignment errors. */
+ uint64_t rx_over_err; /* Number of packets with RX overrun. */
+ uint64_t rx_crc_err; /* Number of CRC errors. */
+ uint64_t collisions; /* Number of collisions. */
};
+OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
#endif /* openflow.h */
git://git.onelab.eu / sliver-openvswitch.git / blobdiff