1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
34 /* OpenFlow: protocol between controller and datapath. */
40 #include <linux/types.h>
45 /* Maximum length of a OpenFlow packet. */
46 #define OFP_MAXLEN (sizeof(struct ofp_data_hello) \
47 + (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200)
50 #define OFP_MAX_TABLE_NAME_LEN 32
51 #define OFP_MAX_PORT_NAME_LEN 16
53 #define OFP_TCP_PORT 975
54 #define OFP_SSL_PORT 976
56 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
58 /* Port numbering. Physical ports are numbered starting from 0. */
60 /* Maximum number of physical switch ports. */
63 /* Fake output "ports". */
64 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
65 * NB: This can only be the destination
66 * port for packet-out messages.
68 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
69 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
70 those disabled by STP. */
71 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
72 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
73 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */ /* xxx Want?! */
74 OFPP_NONE = 0xffff /* Not associated with a physical port. */
78 OFPT_CONTROL_HELLO, /* 0 Controller/switch message */
79 OFPT_DATA_HELLO, /* 1 Controller/switch message */
80 OFPT_PACKET_IN, /* 2 Async message */
81 OFPT_PACKET_OUT, /* 3 Controller/switch message */
82 OFPT_FLOW_MOD, /* 4 Controller/switch message */
83 OFPT_FLOW_EXPIRED, /* 5 Async message */
84 OFPT_TABLE, /* 6 Controller/switch message */
85 OFPT_PORT_MOD, /* 7 Controller/switch message */
86 OFPT_PORT_STATUS, /* 8 Async message */
87 OFPT_FLOW_STAT_REQUEST, /* 9 Controller/switch message */
88 OFPT_FLOW_STAT_REPLY, /* 10 Controller/switch message */
89 OFPT_TABLE_STAT_REQUEST, /* 11 Controller/switch message */
90 OFPT_TABLE_STAT_REPLY, /* 12 Controller/switch message */
91 OFPT_PORT_STAT_REQUEST, /* 13 Controller/switch message */
92 OFPT_PORT_STAT_REPLY /* 14 Controller/switch message */
95 /* Header on all OpenFlow packets. */
97 uint8_t version; /* Always 1. */
98 uint8_t type; /* One of the OFPT_ constants. */
99 uint16_t length; /* Length including this ofp_header. */
100 uint32_t xid; /* Transactin id associated with this packet.
101 Replies use the same id as was in the request
102 to facilitate pairing. */
105 #define OFP_DEFAULT_MISS_SEND_LEN 128
106 #define OFP_MISS_SEND_LEN_UNCHANGED 0xffff
108 /* Flag to indicate that datapath should notify the controller of
109 * expired flow entries.
111 #define OFP_CHELLO_SEND_FLOW_EXP 0x0001
113 /* Controller hello (controller -> datapath). */
114 struct ofp_control_hello {
115 struct ofp_header header;
116 uint32_t version; /* Max supported protocol version (?) */
118 uint16_t miss_send_len; /* Max bytes of new flow that datapath should
119 send to the controller. A value of
120 OFP_MISS_SEND_LEN_UNCHANGED leaves the
121 currently configured value unchanged. */
124 /* Capabilities supported by the datapath. */
125 enum ofp_capabilities {
126 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
127 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
128 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
129 OFPC_STP = 1 << 3, /* 802.11d spanning tree. */
130 OFPC_MULTI_PHY_TX = 1 << 4 /* Supports transmitting through multiple
131 physical interfaces */
134 /* Flags to indicate behavior of the physical port */
135 enum ofp_port_flags {
136 OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding */
139 /* Features of physical ports available in a datapath. */
140 enum ofp_port_features {
141 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
142 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
143 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
144 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
145 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
146 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
147 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
151 /* Description of a physical port */
152 struct ofp_phy_port {
154 uint8_t hw_addr[OFP_ETH_ALEN];
155 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
156 uint32_t flags; /* Bitmap of "ofp_port_flags". */
157 uint32_t speed; /* Current speed in Mbps */
158 uint32_t features; /* Bitmap of supported "ofp_port_features"s. */
161 /* Datapath hello (datapath -> controller). */
162 struct ofp_data_hello {
163 struct ofp_header header;
164 uint64_t datapath_id; /* Datapath unique ID */
167 uint32_t n_exact; /* Max exact-match table entries. */
168 uint32_t n_mac_only; /* Max mac-only table entries. */
169 uint32_t n_compression; /* Max entries compressed on service port. */
170 uint32_t n_general; /* Max entries of arbitrary form. */
172 /* Buffer limits. A datapath that cannot buffer reports 0.*/
173 uint32_t buffer_mb; /* Space for buffering packets, in MB. */
174 uint32_t n_buffers; /* Max packets buffered at once. */
177 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
178 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
181 uint16_t miss_send_len; /* Currently configured value for max bytes
182 of new flow that datapath will send to the
184 uint8_t pad[2]; /* Align to 32-bits */
187 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
188 is inferred from the length field in
192 /* What changed about the phsyical port */
193 enum ofp_port_reason {
194 OFPPR_ADD, /* The port was added */
195 OFPPR_DELETE, /* The port was removed */
196 OFPPR_MOD /* Some attribute of the port has changed */
199 /* A physical port has changed in the datapath */
200 struct ofp_port_status {
201 struct ofp_header header;
202 uint8_t reason; /* One of OFPPR_* */
203 uint8_t pad[3]; /* Align to 32-bits */
204 struct ofp_phy_port desc;
207 /* Modify behavior of the physical port */
208 struct ofp_port_mod {
209 struct ofp_header header;
210 struct ofp_phy_port desc;
213 /* Why is this packet being sent to the controller? */
215 OFPR_NO_MATCH, /* No matching flow. */
216 OFPR_ACTION /* Action explicitly output to controller. */
219 /* Packet received on port (datapath -> controller). */
220 struct ofp_packet_in {
221 struct ofp_header header;
222 uint32_t buffer_id; /* ID assigned by datapath. */
223 uint16_t total_len; /* Full length of frame. */
224 uint16_t in_port; /* Port on which frame was received. */
225 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
227 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
228 so the IP header is 32-bit aligned. The
229 amount of data is inferred from the length
230 field in the header. Because of padding,
231 offsetof(struct ofp_packet_in, data) ==
232 sizeof(struct ofp_packet_in) - 2. */
235 enum ofp_action_type {
236 OFPAT_OUTPUT, /* Output to switch port. */
237 OFPAT_SET_DL_VLAN, /* VLAN. */
238 OFPAT_SET_DL_SRC, /* Ethernet source address. */
239 OFPAT_SET_DL_DST, /* Ethernet destination address. */
240 OFPAT_SET_NW_SRC, /* IP source address. */
241 OFPAT_SET_NW_DST, /* IP destination address. */
242 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
243 OFPAT_SET_TP_DST /* TCP/UDP destination port. */
246 /* An output action sends packets out 'port'. When the 'port' is the
247 * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
248 * send. A 'max_len' of zero means the entire packet should be sent. */
249 struct ofp_action_output {
254 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
255 * special conditions. All ones is used to indicate that no VLAN id was
256 * set, or if used as an action, that the VLAN header should be
259 #define OFP_VLAN_NONE 0xffff
262 uint16_t type; /* One of OFPAT_* */
264 struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
265 uint16_t vlan_id; /* OFPAT_SET_DL_VLAN: VLAN id. */
266 uint8_t dl_addr[OFP_ETH_ALEN]; /* OFPAT_SET_DL_SRC/DST */
267 uint32_t nw_addr; /* OFPAT_SET_NW_SRC/DST */
268 uint16_t tp; /* OFPAT_SET_TP_SRC/DST */
272 /* Send packet (controller -> datapath). */
273 struct ofp_packet_out {
274 struct ofp_header header;
275 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
276 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
277 uint16_t out_port; /* Output port (if buffer_id == -1). */
279 struct ofp_action actions[0]; /* buffer_id != -1 */
280 uint8_t data[0]; /* buffer_id == -1 */
284 enum ofp_flow_mod_command {
285 OFPFC_ADD, /* New flow. */
286 OFPFC_DELETE, /* Delete all matching flows. */
287 OFPFC_DELETE_STRICT /* Strictly match wildcards. */
290 /* Flow wildcards. */
291 enum ofp_flow_wildcards {
292 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
293 OFPFW_DL_VLAN = 1 << 1, /* VLAN. */
294 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
295 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
296 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
297 OFPFW_NW_SRC = 1 << 5, /* IP source address. */
298 OFPFW_NW_DST = 1 << 6, /* IP destination address. */
299 OFPFW_NW_PROTO = 1 << 7, /* IP protocol. */
300 OFPFW_TP_SRC = 1 << 8, /* TCP/UDP source port. */
301 OFPFW_TP_DST = 1 << 9, /* TCP/UDP destination port. */
302 OFPFW_ALL = (1 << 10) - 1
305 /* Values below this cutoff are 802.3 packets and the two bytes
306 * following MAC addresses are used as a frame length. Otherwise, the
307 * two bytes are used as the Ethernet type.
309 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
311 /* Value of dl_type to indicate that the frame does not include an
314 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
316 /* Fields to match against flows */
318 uint16_t wildcards; /* Wildcard fields. */
319 uint16_t in_port; /* Input switch port. */
320 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
321 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
322 uint16_t dl_vlan; /* Input VLAN. */
323 uint16_t dl_type; /* Ethernet frame type. */
324 uint32_t nw_src; /* IP source address. */
325 uint32_t nw_dst; /* IP destination address. */
326 uint8_t nw_proto; /* IP protocol. */
327 uint8_t pad[3]; /* Align to 32-bits */
328 uint16_t tp_src; /* TCP/UDP source port. */
329 uint16_t tp_dst; /* TCP/UDP destination port. */
332 /* Value used in "max_idle" to indicate that the entry is permanent */
333 #define OFP_FLOW_PERMANENT 0
335 /* Flow setup and teardown (controller -> datapath). */
336 struct ofp_flow_mod {
337 struct ofp_header header;
338 struct ofp_match match; /* Fields to match */
341 uint16_t command; /* One of OFPFC_*. */
342 uint16_t max_idle; /* Idle time before discarding (seconds). */
343 uint32_t buffer_id; /* Buffered packet to apply to (or -1). */
344 uint32_t group_id; /* Flow group ID (for QoS). */
345 struct ofp_action actions[0]; /* The number of actions is inferred from
346 the length field in the header. */
349 /* Flow expiration (datapath -> controller). */
350 struct ofp_flow_expired {
351 struct ofp_header header;
352 struct ofp_match match; /* Description of fields */
354 uint32_t duration; /* Time flow was alive in seconds. */
355 uint64_t packet_count;
359 /* Statistics about flows that match the "match" field */
360 struct ofp_flow_stats {
361 struct ofp_match match; /* Description of fields */
362 uint32_t duration; /* Time flow has been alive in seconds. Only
363 used for non-aggregated results. */
364 uint64_t packet_count;
369 OFPFS_INDIV, /* Send an entry for each matching flow */
370 OFPFS_AGGREGATE /* Aggregate matching flows */
373 /* Current flow statistics request */
374 struct ofp_flow_stat_request {
375 struct ofp_header header;
376 struct ofp_match match; /* Fields to match */
377 uint8_t type; /* One of OFPFS_ */
378 uint8_t pad[3]; /* Align to 32-bits */
381 /* Current flow statistics reply */
382 struct ofp_flow_stat_reply {
383 struct ofp_header header;
385 /* If request was of type OFPFS_INDIV, this will contain an array of
386 * flow statistic entries. The number of matching flows is likely
387 * much larger than can fit in a single OpenFlow message, so a
388 * a response with no flows included is sent to indicate the end.
389 * If it was a OFPFS_AGGREGATE request, only a single flow stats
390 * entry will be contained in the response.
392 struct ofp_flow_stats flows[0];
395 /* Table attributes collected at runtime */
397 struct ofp_header header;
398 char name[OFP_MAX_TABLE_NAME_LEN];
400 unsigned long int n_flows;
401 unsigned long int max_flows;
404 #endif /* openflow.h */