-/* Copyright (c) 2008, 2011 The Board of Trustees of The Leland Stanford
+/* Copyright (c) 2008, 2011, 2012, 2013, 2014 The Board of Trustees of The Leland Stanford
* Junior University
*
* We are making the OpenFlow specification and associated documentation
*/
/*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
+ * Copyright (c) 2008-2014 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#ifndef OPENFLOW_COMMON_H
#define OPENFLOW_COMMON_H 1
-#include "openvswitch/types.h"
+#include <openvswitch/types.h>
#ifdef SWIG
#define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
/* The most significant bit being set in the version field indicates an
* experimental OpenFlow version.
*/
-#define OFP10_VERSION 0x01
-#define OFP11_VERSION 0x02
-#define OFP12_VERSION 0x03
+enum ofp_version {
+ OFP10_VERSION = 0x01,
+ OFP11_VERSION = 0x02,
+ OFP12_VERSION = 0x03,
+ OFP13_VERSION = 0x04,
+ OFP14_VERSION = 0x05,
+ OFP15_VERSION = 0x06
+};
+
+/* Vendor (aka experimenter) IDs.
+ *
+ * These are used in various places in OpenFlow to identify an extension
+ * defined by some vendor, as opposed to a standardized part of the core
+ * OpenFlow protocol.
+ *
+ * Vendor IDs whose top 8 bits are 0 hold an Ethernet OUI in their low 24 bits.
+ * The Open Networking Foundation assigns vendor IDs whose top 8 bits are
+ * nonzero.
+ *
+ * A few vendor IDs are special:
+ *
+ * - OF_VENDOR_ID is not a real vendor ID and does not appear in the
+ * OpenFlow protocol itself. It can occasionally be useful within Open
+ * vSwitch to identify a standardized part of OpenFlow.
+ *
+ * - ONF_VENDOR_ID is being used within the ONF "extensibility" working
+ * group to identify extensions being proposed for standardization.
+ *
+ * The list is sorted numerically.
+ */
+#define OF_VENDOR_ID 0
+#define HPL_VENDOR_ID 0x000004EA /* HP Labs. */
+#define NTR_VENDOR_ID 0x00001540 /* Netronome. */
+#define NX_VENDOR_ID 0x00002320 /* Nicira. */
+#define ONF_VENDOR_ID 0x4f4e4600 /* Open Networking Foundation. */
#define OFP_MAX_TABLE_NAME_LEN 32
#define OFP_MAX_PORT_NAME_LEN 16
-#define OFP_TCP_PORT 6633
-#define OFP_SSL_PORT 6633
-
-#define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
-
-/* Common OpenFlow message types. */
-enum ofp_type {
- /* 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_REMOVED, /* Async message */
- OFPT_PORT_STATUS, /* Async message */
-
- /* Controller command messages. */
- OFPT_PACKET_OUT, /* Controller/switch message */
- OFPT_FLOW_MOD, /* Controller/switch message */
-};
+#define OFP_OLD_PORT 6633
+#define OFP_PORT 6653
+
+#define OFP_DEFAULT_MISS_SEND_LEN 128
+
+/* Values below this cutoff are 802.3 packets and the two bytes
+ * following MAC addresses are used as a frame length. Otherwise, the
+ * two bytes are used as the Ethernet type.
+ */
+#define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
+
+/* Value of dl_type to indicate that the frame does not include an
+ * Ethernet type.
+ */
+#define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
+
+/* 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
+
/* Header on all OpenFlow packets. */
struct ofp_header {
};
OFP_ASSERT(sizeof(struct ofp_header) == 8);
+/* OFPT_ERROR: Error message (datapath -> controller). */
+struct ofp_error_msg {
+ ovs_be16 type;
+ ovs_be16 code;
+ uint8_t data[0]; /* Variable-length data. Interpreted based
+ on the type and code. */
+};
+OFP_ASSERT(sizeof(struct ofp_error_msg) == 4);
+
+enum ofp_config_flags {
+ /* Handling of IP fragments. */
+ OFPC_FRAG_NORMAL = 0, /* No special handling for fragments. */
+ OFPC_FRAG_DROP = 1, /* Drop fragments. */
+ OFPC_FRAG_REASM = 2, /* Reassemble (only if OFPC_IP_REASM set). */
+ OFPC_FRAG_NX_MATCH = 3, /* Make first fragments available for matching. */
+ OFPC_FRAG_MASK = 3,
+
+ /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OpenFlow 1.3 */
+
+ /* TTL processing - applicable for IP and MPLS packets. */
+ OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
+ to the controller. */
+};
+
+/* Switch configuration. */
+struct ofp_switch_config {
+ ovs_be16 flags; /* OFPC_* flags. */
+ ovs_be16 miss_send_len; /* Max bytes of new flow that datapath should
+ send to the controller. */
+};
+OFP_ASSERT(sizeof(struct ofp_switch_config) == 4);
+
+
/* Common flags to indicate behavior of the physical port. These flags are
* used in ofp_port to describe the current configuration. They are used in
* the ofp_port_mod message to configure the port's behavior.
OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
};
-struct ofp_packet_queue {
- ovs_be32 queue_id; /* id for the specific queue. */
- ovs_be16 len; /* Length in bytes of this queue desc. */
- uint8_t pad[2]; /* 64-bit alignment. */
- /* struct ofp_queue_prop_header properties[0]; List of properties. */
-};
-OFP_ASSERT(sizeof(struct ofp_packet_queue) == 8);
-
enum ofp_queue_properties {
- OFPQT_NONE = 0, /* No property defined for queue (default). */
- OFPQT_MIN_RATE, /* Minimum datarate guaranteed. */
- /* Other types should be added here
- * (i.e. max rate, precedence, etc). */
+ OFPQT_MIN_RATE = 1, /* Minimum datarate guaranteed. */
+ OFPQT_MAX_RATE = 2, /* Maximum guaranteed rate. */
+ OFPQT_EXPERIMENTER = 0xffff, /* Experimenter defined property. */
};
/* Common description for a queue. */
};
OFP_ASSERT(sizeof(struct ofp_queue_prop_header) == 8);
-/* Min-Rate queue property description. */
-struct ofp_queue_prop_min_rate {
- struct ofp_queue_prop_header prop_header; /* prop: OFPQT_MIN, len: 16. */
+/* Min-Rate and Max-Rate queue property description (OFPQT_MIN and
+ * OFPQT_MAX). */
+struct ofp_queue_prop_rate {
+ struct ofp_queue_prop_header prop_header;
ovs_be16 rate; /* In 1/10 of a percent; >1000 -> disabled. */
uint8_t pad[6]; /* 64-bit alignment */
};
-OFP_ASSERT(sizeof(struct ofp_queue_prop_min_rate) == 16);
+OFP_ASSERT(sizeof(struct ofp_queue_prop_rate) == 16);
/* Switch features. */
struct ofp_switch_features {
- struct ofp_header header;
ovs_be64 datapath_id; /* Datapath unique ID. The lower 48-bits are for
a MAC address, while the upper 16-bits are
implementer-defined. */
ovs_be32 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. */
+ uint8_t auxiliary_id; /* OF 1.3: Identify auxiliary connections */
+ uint8_t pad[2]; /* Align to 64-bits. */
/* Features. */
ovs_be32 capabilities; /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
- ovs_be32 actions; /* Bitmap of supported "ofp_action_type"s. */
+ ovs_be32 actions; /* Bitmap of supported "ofp_action_type"s.
+ * DEPRECATED in OpenFlow 1.1 */
/* Followed by an array of struct ofp10_phy_port or struct ofp11_port
- * structures. The number is inferred from header.length. */
+ * structures. The number is inferred from header.length.
+ * REMOVED in OpenFlow 1.3 */
};
-OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
+OFP_ASSERT(sizeof(struct ofp_switch_features) == 24);
/* Common capabilities supported by the datapath (struct ofp_switch_features,
* member capabilities). */
enum ofp_packet_in_reason {
OFPR_NO_MATCH, /* No matching flow. */
OFPR_ACTION, /* Action explicitly output to controller. */
- OFPR_INVALID_TTL /* Packet has invalid TTL. */,
+ OFPR_INVALID_TTL, /* Packet has invalid TTL. */
+ OFPR_ACTION_SET, /* Output to controller in action set */
+ OFPR_GROUP, /* Output to controller in group bucket */
+ OFPR_PACKET_OUT, /* Output to controller in packet-out */
OFPR_N_REASONS
};
+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. */
+};
+
+enum ofp_flow_mod_flags {
+ OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
+ * expires or is deleted. */
+ OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
+};
+
/* Why was this flow removed? */
enum ofp_flow_removed_reason {
OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
OFPRR_DELETE, /* Evicted by a DELETE flow mod. */
- OFPRR_GROUP_DELETE /* Group was removed. */
+ OFPRR_GROUP_DELETE, /* Group was removed. */
+ OFPRR_METER_DELETE, /* Meter was removed. */
+ OFPRR_EVICTION, /* Switch eviction to free resources. */
+
+ OVS_OFPRR_NONE /* OVS internal_use only, keep last!. */
};
/* What changed about the physical port */
/* 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[7]; /* Align to 64-bits. */
- /* Followed by struct ofp10_phy_port or struct ofp11_port. */
+ /* Followed by struct ofp10_phy_port, struct ofp11_port, or struct
+ * ofp14_port. */
};
-OFP_ASSERT(sizeof(struct ofp_port_status) == 16);
-
-enum ofp_stats_types {
- /* Description of this OpenFlow switch. (OFPMP_DESC)
- * The OF1.0 request is struct ofp_stats_msg.
- * The OF1.0 reply is struct ofp_desc_stats. */
- OFPST_DESC = 0,
-
- /* Individual flow statistics. (OFPMP_FLOW)
- * The OF1.0 request is struct ofp_flow_stats_request.
- * The OF1.0 reply body is an array of struct ofp_flow_stats. */
- OFPST_FLOW = 1,
-
- /* Aggregate flow statistics. (OFPMP_AGGREGATE)
- * The OF1.0 request is struct ofp_flow_stats_request.
- * The OF1.0 reply is struct ofp_aggregate_stats_reply. */
- OFPST_AGGREGATE = 2,
-
- /* Flow table statistics. (OFPMP_TABLE)
- * The OF1.0 request is struct ofp_stats_msg.
- * The OF1.0 reply body is an array of struct ofp_table_stats. */
- OFPST_TABLE = 3,
-
- /* Physical port statistics. (OFPMP_PORT_STATS)
- * The OF1.0 request is struct ofp_port_stats_request.
- * The OF1.0 reply body is an array of struct ofp_port_stats. */
- OFPST_PORT = 4,
-
- /* Queue statistics for a port. (OFPMP_QUEUE)
- * The OF1.0 request is struct ofp_stats_msg.
- * The OF1.0 reply body is an array of struct ofp_queue_stats. */
- OFPST_QUEUE = 5,
-
- /* Port description. (OFPMP_PORT_DESC)
- * This was introduced as part of OF1.3, but is useful for bridges
- * with many ports, so we support it with OF1.0, too.
- * The OF1.0 request is struct ofp_stats_msg.
- * The OF1.0 reply body is an array of struct ofp10_phy_port. */
- OFPST_PORT_DESC = 13,
-
- /* Vendor extension.
- * The OF1.0 request and reply begin with struct ofp_vendor_stats. */
- OFPST_VENDOR = 0xffff
+OFP_ASSERT(sizeof(struct ofp_port_status) == 8);
+
+enum ofp_stats_reply_flags {
+ OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
+};
+
+#define DESC_STR_LEN 256
+#define SERIAL_NUM_LEN 32
+/* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated ASCII
+ * string. */
+struct ofp_desc_stats {
+ char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
+ char hw_desc[DESC_STR_LEN]; /* Hardware description. */
+ char sw_desc[DESC_STR_LEN]; /* Software description. */
+ char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
+ char dp_desc[DESC_STR_LEN]; /* Human readable description of
+ the datapath. */
};
+OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
+
+/* Reply to OFPST_AGGREGATE request. */
+struct ofp_aggregate_stats_reply {
+ ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
+ ovs_32aligned_be64 byte_count; /* Number of bytes in flows. */
+ ovs_be32 flow_count; /* Number of flows. */
+ uint8_t pad[4]; /* Align to 64 bits. */
+};
+OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
/* The match type indicates the match structure (set of fields that compose the
* match) in use. The match type is placed in the type field at the beginning
OFPMT_OXM = 1, /* OpenFlow Extensible Match */
};
+/* Group numbering. Groups can use any number up to OFPG_MAX. */
+enum ofp_group {
+ /* Last usable group number. */
+ OFPG_MAX = 0xffffff00,
+
+ /* Fake groups. */
+ OFPG_ALL = 0xfffffffc, /* All groups, for group delete commands. */
+ OFPG_ANY = 0xffffffff /* Wildcard, for flow stats requests. */
+};
+
+/* Group configuration flags */
+enum ofp_group_capabilities {
+ OFPGFC_SELECT_WEIGHT = 1 << 0, /* Support weight for select groups */
+ OFPGFC_SELECT_LIVENESS = 1 << 1, /* Support liveness for select groups */
+ OFPGFC_CHAINING = 1 << 2, /* Support chaining groups */
+ OFPGFC_CHAINING_CHECKS = 1 << 3, /* Check chaining for loops and delete */
+};
+
+enum ofp_hello_elem_type {
+ OFPHET_VERSIONBITMAP = 1, /* Bitmap of version supported. */
+};
+
+/* Common header for all Hello Elements */
+struct ofp_hello_elem_header {
+ ovs_be16 type; /* One of OFPHET_*. */
+ ovs_be16 length; /* Length in bytes of this element. */
+};
+OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
+
+/* Vendor extension. */
+struct ofp_vendor_header {
+ struct ofp_header header; /* Type OFPT_VENDOR or OFPT_EXPERIMENTER. */
+ ovs_be32 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_header) == 12);
+
+/* Table numbering. Tables can use any number up to OFPT_MAX. */
+enum ofp_table {
+ /* Last usable table number. */
+ OFPTT_MAX = 0xfe,
+
+ /* Fake tables. */
+ OFPTT_ALL = 0xff /* Wildcard table used for table config,
+ flow stats and flow deletes. */
+};
+
+enum ofp_table_config {
+ /* OpenFlow 1.1 and 1.2 defined this field as shown.
+ * OpenFlow 1.3 and later mark this field as deprecated, but have not
+ * reused it for any new purpose. */
+ OFPTC11_TABLE_MISS_CONTROLLER = 0 << 0, /* Send to controller. */
+ OFPTC11_TABLE_MISS_CONTINUE = 1 << 0, /* Go to next table, like OF1.0. */
+ OFPTC11_TABLE_MISS_DROP = 2 << 0, /* Drop the packet. */
+ OFPTC11_TABLE_MISS_MASK = 3 << 0,
+
+ /* OpenFlow 1.4. */
+ OFPTC14_EVICTION = 1 << 2, /* Allow table to evict flows. */
+ OFPTC14_VACANCY_EVENTS = 1 << 3, /* Enable vacancy events. */
+};
+
#endif /* openflow/openflow-common.h */
projects / cascardo / ovs.git / blobdiff