2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /* OpenFlow: protocol between controller and datapath. */
19 #ifndef OPENFLOW_OPENFLOW10_H
20 #define OPENFLOW_OPENFLOW10_H 1
22 #include <openflow/openflow-common.h>
24 /* Port number(s) meaning
25 * --------------- --------------------------------------
26 * 0x0000 not assigned a meaning by OpenFlow 1.0
27 * 0x0001...0xfeff "physical" ports
28 * 0xff00...0xfff6 "reserved" but not assigned a meaning by OpenFlow 1.x
29 * 0xfff7...0xffff "reserved" OFPP_* ports with assigned meanings
33 #define OFPP_MAX OFP_PORT_C(0xff00) /* Max # of switch ports. */
34 #define OFPP_FIRST_RESV OFP_PORT_C(0xfff7) /* First assigned reserved port. */
35 #define OFPP_LAST_RESV OFP_PORT_C(0xffff) /* Last assigned reserved port. */
37 /* Reserved output "ports". */
38 #define OFPP_UNSET OFP_PORT_C(0xfff7) /* For OXM_OF_ACTSET_OUTPUT only. */
39 #define OFPP_IN_PORT OFP_PORT_C(0xfff8) /* Where the packet came in. */
40 #define OFPP_TABLE OFP_PORT_C(0xfff9) /* Perform actions in flow table. */
41 #define OFPP_NORMAL OFP_PORT_C(0xfffa) /* Process with normal L2/L3. */
42 #define OFPP_FLOOD OFP_PORT_C(0xfffb) /* All ports except input port and
43 * ports disabled by STP. */
44 #define OFPP_ALL OFP_PORT_C(0xfffc) /* All ports except input port. */
45 #define OFPP_CONTROLLER OFP_PORT_C(0xfffd) /* Send to controller. */
46 #define OFPP_LOCAL OFP_PORT_C(0xfffe) /* Local openflow "port". */
47 #define OFPP_NONE OFP_PORT_C(0xffff) /* Not associated with any port. */
49 /* OpenFlow 1.0 specific capabilities supported by the datapath (struct
50 * ofp_switch_features, member capabilities). */
51 enum ofp10_capabilities {
52 OFPC10_STP = 1 << 3, /* 802.1d spanning tree. */
53 OFPC10_RESERVED = 1 << 4, /* Reserved, must not be set. */
56 /* OpenFlow 1.0 specific flags to indicate behavior of the physical port.
57 * These flags are used in ofp10_phy_port to describe the current
58 * configuration. They are used in the ofp10_port_mod message to configure the
61 enum ofp10_port_config {
62 OFPPC10_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
63 OFPPC10_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
64 OFPPC10_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
65 #define OFPPC10_ALL (OFPPC_PORT_DOWN | OFPPC10_NO_STP | OFPPC_NO_RECV | \
66 OFPPC10_NO_RECV_STP | OFPPC10_NO_FLOOD | OFPPC_NO_FWD | \
70 /* OpenFlow 1.0 specific current state of the physical port. These are not
71 * configurable from the controller.
73 enum ofp10_port_state {
74 /* The OFPPS10_STP_* bits have no effect on switch operation. The
75 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
76 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
78 OFPPS10_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
79 OFPPS10_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
80 OFPPS10_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
81 OFPPS10_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
82 OFPPS10_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
84 #define OFPPS10_ALL (OFPPS_LINK_DOWN | OFPPS10_STP_MASK)
87 /* OpenFlow 1.0 specific features of physical ports available in a datapath. */
88 enum ofp10_port_features {
89 OFPPF10_COPPER = 1 << 7, /* Copper medium. */
90 OFPPF10_FIBER = 1 << 8, /* Fiber medium. */
91 OFPPF10_AUTONEG = 1 << 9, /* Auto-negotiation. */
92 OFPPF10_PAUSE = 1 << 10, /* Pause. */
93 OFPPF10_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
96 /* Description of a physical port */
97 struct ofp10_phy_port {
99 struct eth_addr hw_addr;
100 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
102 ovs_be32 config; /* Bitmap of OFPPC_* and OFPPC10_* flags. */
103 ovs_be32 state; /* Bitmap of OFPPS_* and OFPPS10_* flags. */
105 /* Bitmaps of OFPPF_* and OFPPF10_* that describe features. All bits
106 * zeroed if unsupported or unavailable. */
107 ovs_be32 curr; /* Current features. */
108 ovs_be32 advertised; /* Features being advertised by the port. */
109 ovs_be32 supported; /* Features supported by the port. */
110 ovs_be32 peer; /* Features advertised by peer. */
112 OFP_ASSERT(sizeof(struct ofp10_phy_port) == 48);
114 /* Modify behavior of the physical port */
115 struct ofp10_port_mod {
117 struct eth_addr hw_addr; /* The hardware address is not configurable. This
118 is used to sanity-check the request, so it must
119 be the same as returned in an ofp10_phy_port
122 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
123 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
125 ovs_be32 advertise; /* Bitmap of "ofp_port_features"s. Zero all
126 bits to prevent any action taking place. */
127 uint8_t pad[4]; /* Pad to 64-bits. */
129 OFP_ASSERT(sizeof(struct ofp10_port_mod) == 24);
131 struct ofp10_packet_queue {
132 ovs_be32 queue_id; /* id for the specific queue. */
133 ovs_be16 len; /* Length in bytes of this queue desc. */
134 uint8_t pad[2]; /* 64-bit alignment. */
135 /* Followed by any number of queue properties expressed using
136 * ofp_queue_prop_header, to fill out a total of 'len' bytes. */
138 OFP_ASSERT(sizeof(struct ofp10_packet_queue) == 8);
140 /* Queue properties for OF1.0 to OF1.3.
142 * OF1.4+ use the same numbers but rename them and change the property formats
143 * in incompatible ways, so there's not much benefit to sharing the names. */
144 enum ofp10_queue_properties {
145 /* Introduced in OF1.0. */
146 OFPQT10_MIN_RATE = 1, /* Minimum datarate guaranteed. */
148 /* Introduced in OF1.1. */
149 OFPQT11_MAX_RATE = 2, /* Maximum guaranteed rate. */
150 OFPQT11_EXPERIMENTER = 0xffff, /* Experimenter defined property. */
153 /* Description for a queue in OpenFlow 1.0 to 1.3.
155 * OF1.4+ also use a TLV format but an incompatible one. */
156 struct ofp10_queue_prop_header {
157 ovs_be16 property; /* One of OFPQT*. */
158 ovs_be16 len; /* Length of property, including this header. */
159 uint8_t pad[4]; /* 64-bit alignemnt. */
161 OFP_ASSERT(sizeof(struct ofp10_queue_prop_header) == 8);
163 /* Min-Rate and Max-Rate queue property description (OFPQT10_MIN and
166 * OF1.4+ use similar TLVs but they are incompatible due to different padding.
168 struct ofp10_queue_prop_rate {
169 struct ofp10_queue_prop_header prop_header;
170 ovs_be16 rate; /* In 1/10 of a percent; >1000 -> disabled. */
171 uint8_t pad[6]; /* 64-bit alignment */
173 OFP_ASSERT(sizeof(struct ofp10_queue_prop_rate) == 16);
175 /* Query for port queue configuration. */
176 struct ofp10_queue_get_config_request {
177 ovs_be16 port; /* Port to be queried. Should refer
178 to a valid physical port (i.e. < OFPP_MAX) */
180 /* 32-bit alignment. */
182 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_request) == 4);
184 /* Queue configuration for a given port. */
185 struct ofp10_queue_get_config_reply {
188 /* struct ofp10_packet_queue queues[0]; List of configured queues. */
190 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_reply) == 8);
192 /* Packet received on port (datapath -> controller). */
193 struct ofp10_packet_in {
194 ovs_be32 buffer_id; /* ID assigned by datapath. */
195 ovs_be16 total_len; /* Full length of frame. */
196 ovs_be16 in_port; /* Port on which frame was received. */
197 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
199 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
200 so the IP header is 32-bit aligned. The
201 amount of data is inferred from the length
202 field in the header. Because of padding,
203 offsetof(struct ofp_packet_in, data) ==
204 sizeof(struct ofp_packet_in) - 2. */
206 OFP_ASSERT(sizeof(struct ofp10_packet_in) == 12);
208 /* Send packet (controller -> datapath). */
209 struct ofp10_packet_out {
210 ovs_be32 buffer_id; /* ID assigned by datapath or UINT32_MAX. */
211 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
212 ovs_be16 actions_len; /* Size of action array in bytes. */
214 * - Exactly 'actions_len' bytes (possibly 0 bytes, and always a multiple
215 * of 8) containing actions.
216 * - If 'buffer_id' == UINT32_MAX, packet data to fill out the remainder
217 * of the message length.
220 OFP_ASSERT(sizeof(struct ofp10_packet_out) == 8);
222 /* Flow wildcards. */
223 enum ofp10_flow_wildcards {
224 OFPFW10_IN_PORT = 1 << 0, /* Switch input port. */
225 OFPFW10_DL_VLAN = 1 << 1, /* VLAN vid. */
226 OFPFW10_DL_SRC = 1 << 2, /* Ethernet source address. */
227 OFPFW10_DL_DST = 1 << 3, /* Ethernet destination address. */
228 OFPFW10_DL_TYPE = 1 << 4, /* Ethernet frame type. */
229 OFPFW10_NW_PROTO = 1 << 5, /* IP protocol. */
230 OFPFW10_TP_SRC = 1 << 6, /* TCP/UDP source port. */
231 OFPFW10_TP_DST = 1 << 7, /* TCP/UDP destination port. */
233 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
234 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
235 * the entire field. This is the *opposite* of the usual convention where
236 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
237 OFPFW10_NW_SRC_SHIFT = 8,
238 OFPFW10_NW_SRC_BITS = 6,
239 OFPFW10_NW_SRC_MASK = (((1 << OFPFW10_NW_SRC_BITS) - 1)
240 << OFPFW10_NW_SRC_SHIFT),
241 OFPFW10_NW_SRC_ALL = 32 << OFPFW10_NW_SRC_SHIFT,
243 /* IP destination address wildcard bit count. Same format as source. */
244 OFPFW10_NW_DST_SHIFT = 14,
245 OFPFW10_NW_DST_BITS = 6,
246 OFPFW10_NW_DST_MASK = (((1 << OFPFW10_NW_DST_BITS) - 1)
247 << OFPFW10_NW_DST_SHIFT),
248 OFPFW10_NW_DST_ALL = 32 << OFPFW10_NW_DST_SHIFT,
250 OFPFW10_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
251 OFPFW10_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
253 /* Wildcard all fields. */
254 OFPFW10_ALL = ((1 << 22) - 1)
257 /* The wildcards for ICMP type and code fields use the transport source
258 * and destination port fields, respectively. */
259 #define OFPFW10_ICMP_TYPE OFPFW10_TP_SRC
260 #define OFPFW10_ICMP_CODE OFPFW10_TP_DST
262 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
263 * special conditions. All ones indicates that 802.1Q header is not present.
265 #define OFP10_VLAN_NONE 0xffff
267 /* Fields to match against flows */
269 ovs_be32 wildcards; /* Wildcard fields. */
270 ovs_be16 in_port; /* Input switch port. */
271 struct eth_addr dl_src; /* Ethernet source address. */
272 struct eth_addr dl_dst; /* Ethernet destination address. */
273 ovs_be16 dl_vlan; /* Input VLAN. */
274 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
275 uint8_t pad1[1]; /* Align to 64-bits. */
276 ovs_be16 dl_type; /* Ethernet frame type. */
277 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
278 uint8_t nw_proto; /* IP protocol or lower 8 bits of
280 uint8_t pad2[2]; /* Align to 64-bits. */
281 ovs_be32 nw_src; /* IP source address. */
282 ovs_be32 nw_dst; /* IP destination address. */
283 ovs_be16 tp_src; /* TCP/UDP source port. */
284 ovs_be16 tp_dst; /* TCP/UDP destination port. */
286 OFP_ASSERT(sizeof(struct ofp10_match) == 40);
288 enum ofp10_flow_mod_flags {
289 OFPFF10_EMERG = 1 << 2 /* Part of "emergency flow cache". */
292 /* Flow setup and teardown (controller -> datapath). */
293 struct ofp10_flow_mod {
294 struct ofp10_match match; /* Fields to match */
295 ovs_be64 cookie; /* Opaque controller-issued identifier. */
298 ovs_be16 command; /* One of OFPFC_*. */
299 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
300 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
301 ovs_be16 priority; /* Priority level of flow entry. */
302 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
303 Not meaningful for OFPFC_DELETE*. */
304 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
305 matching entries to include this as an
306 output port. A value of OFPP_NONE
307 indicates no restriction. */
308 ovs_be16 flags; /* One of OFPFF_*. */
310 /* Followed by OpenFlow actions whose length is inferred from the length
311 * field in the OpenFlow header. */
313 OFP_ASSERT(sizeof(struct ofp10_flow_mod) == 64);
315 /* Flow removed (datapath -> controller). */
316 struct ofp10_flow_removed {
317 struct ofp10_match match; /* Description of fields. */
318 ovs_be64 cookie; /* Opaque controller-issued identifier. */
320 ovs_be16 priority; /* Priority level of flow entry. */
321 uint8_t reason; /* One of OFPRR_*. */
322 uint8_t pad[1]; /* Align to 32-bits. */
324 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
325 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
327 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
328 uint8_t pad2[2]; /* Align to 64-bits. */
329 ovs_be64 packet_count;
332 OFP_ASSERT(sizeof(struct ofp10_flow_removed) == 80);
334 /* Statistics request or reply message. */
335 struct ofp10_stats_msg {
336 struct ofp_header header;
337 ovs_be16 type; /* One of the OFPST_* constants. */
338 ovs_be16 flags; /* Requests: always 0.
339 * Replies: 0 or OFPSF_REPLY_MORE. */
341 OFP_ASSERT(sizeof(struct ofp10_stats_msg) == 12);
343 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
344 struct ofp10_flow_stats_request {
345 struct ofp10_match match; /* Fields to match. */
346 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
347 or 0xff for all tables. */
348 uint8_t pad; /* Align to 32 bits. */
349 ovs_be16 out_port; /* Require matching entries to include this
350 as an output port. A value of OFPP_NONE
351 indicates no restriction. */
353 OFP_ASSERT(sizeof(struct ofp10_flow_stats_request) == 44);
355 /* Body of reply to OFPST_FLOW request. */
356 struct ofp10_flow_stats {
357 ovs_be16 length; /* Length of this entry. */
358 uint8_t table_id; /* ID of table flow came from. */
360 struct ofp10_match match; /* Description of fields. */
361 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
362 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
363 beyond duration_sec. */
364 ovs_be16 priority; /* Priority of the entry. Only meaningful
365 when this is not an exact-match entry. */
366 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
367 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
368 uint8_t pad2[6]; /* Align to 64 bits. */
369 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
370 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
371 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
372 /* Followed by OpenFlow actions whose length is inferred from 'length'. */
374 OFP_ASSERT(sizeof(struct ofp10_flow_stats) == 88);
376 /* Body of reply to OFPST_TABLE request. */
377 struct ofp10_table_stats {
378 uint8_t table_id; /* Identifier of table. Lower numbered tables
379 are consulted first. */
380 uint8_t pad[3]; /* Align to 32-bits. */
381 char name[OFP_MAX_TABLE_NAME_LEN];
382 ovs_be32 wildcards; /* Bitmap of OFPFW10_* wildcards that are
383 supported by the table. */
384 ovs_be32 max_entries; /* Max number of entries supported. */
385 ovs_be32 active_count; /* Number of active entries. */
386 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
387 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
389 OFP_ASSERT(sizeof(struct ofp10_table_stats) == 64);
391 /* Stats request of type OFPST_PORT. */
392 struct ofp10_port_stats_request {
393 ovs_be16 port_no; /* OFPST_PORT message may request statistics
394 for a single port (specified with port_no)
395 or for all ports (port_no == OFPP_NONE). */
398 OFP_ASSERT(sizeof(struct ofp10_port_stats_request) == 8);
400 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
401 * the field to all ones. */
402 struct ofp10_port_stats {
404 uint8_t pad[6]; /* Align to 64-bits. */
405 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
406 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
407 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
408 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
409 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
410 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
411 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
412 super-set of receive errors and should be
413 great than or equal to the sum of all
415 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
416 super-set of transmit errors. */
417 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
418 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
419 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
420 ovs_32aligned_be64 collisions; /* Number of collisions. */
422 OFP_ASSERT(sizeof(struct ofp10_port_stats) == 104);
424 /* All ones is used to indicate all queues in a port (for stats retrieval). */
425 #define OFPQ_ALL 0xffffffff
427 /* Body for stats request of type OFPST_QUEUE. */
428 struct ofp10_queue_stats_request {
429 ovs_be16 port_no; /* All ports if OFPP_ALL. */
430 uint8_t pad[2]; /* Align to 32-bits. */
431 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
433 OFP_ASSERT(sizeof(struct ofp10_queue_stats_request) == 8);
435 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
437 struct ofp10_queue_stats {
439 uint8_t pad[2]; /* Align to 32-bits. */
440 ovs_be32 queue_id; /* Queue id. */
441 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
442 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
443 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
445 OFP_ASSERT(sizeof(struct ofp10_queue_stats) == 32);
447 /* Vendor extension stats message. */
448 struct ofp10_vendor_stats_msg {
449 struct ofp10_stats_msg osm; /* Type OFPST_VENDOR. */
450 ovs_be32 vendor; /* Vendor ID:
451 * - MSB 0: low-order bytes are IEEE OUI.
452 * - MSB != 0: defined by OpenFlow
454 /* Followed by vendor-defined arbitrary additional data. */
456 OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg) == 16);
458 #endif /* openflow/openflow-1.0.h */