2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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...0xfff7 "reserved" but not assigned a meaning by OpenFlow 1.0
29 * 0xfff8...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(0xfff8) /* First assigned reserved port. */
35 #define OFPP_LAST_RESV OFP_PORT_C(0xffff) /* Last assigned reserved port. */
37 /* Reserved output "ports". */
38 #define OFPP_IN_PORT OFP_PORT_C(0xfff8) /* Where the packet came in. */
39 #define OFPP_TABLE OFP_PORT_C(0xfff9) /* Perform actions in flow table. */
40 #define OFPP_NORMAL OFP_PORT_C(0xfffa) /* Process with normal L2/L3. */
41 #define OFPP_FLOOD OFP_PORT_C(0xfffb) /* All ports except input port and
42 * ports disabled by STP. */
43 #define OFPP_ALL OFP_PORT_C(0xfffc) /* All ports except input port. */
44 #define OFPP_CONTROLLER OFP_PORT_C(0xfffd) /* Send to controller. */
45 #define OFPP_LOCAL OFP_PORT_C(0xfffe) /* Local openflow "port". */
46 #define OFPP_NONE OFP_PORT_C(0xffff) /* Not associated with any port. */
48 /* OpenFlow 1.0 specific capabilities supported by the datapath (struct
49 * ofp_switch_features, member capabilities). */
50 enum ofp10_capabilities {
51 OFPC10_STP = 1 << 3, /* 802.1d spanning tree. */
52 OFPC10_RESERVED = 1 << 4, /* Reserved, must not be set. */
55 /* OpenFlow 1.0 specific flags to indicate behavior of the physical port.
56 * These flags are used in ofp10_phy_port to describe the current
57 * configuration. They are used in the ofp10_port_mod message to configure the
60 enum ofp10_port_config {
61 OFPPC10_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
62 OFPPC10_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
63 OFPPC10_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
64 #define OFPPC10_ALL (OFPPC_PORT_DOWN | OFPPC10_NO_STP | OFPPC_NO_RECV | \
65 OFPPC10_NO_RECV_STP | OFPPC10_NO_FLOOD | OFPPC_NO_FWD | \
69 /* OpenFlow 1.0 specific current state of the physical port. These are not
70 * configurable from the controller.
72 enum ofp10_port_state {
73 /* The OFPPS10_STP_* bits have no effect on switch operation. The
74 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
75 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
77 OFPPS10_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
78 OFPPS10_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
79 OFPPS10_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
80 OFPPS10_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
81 OFPPS10_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
83 #define OFPPS10_ALL (OFPPS_LINK_DOWN | OFPPS10_STP_MASK)
86 /* OpenFlow 1.0 specific features of physical ports available in a datapath. */
87 enum ofp10_port_features {
88 OFPPF10_COPPER = 1 << 7, /* Copper medium. */
89 OFPPF10_FIBER = 1 << 8, /* Fiber medium. */
90 OFPPF10_AUTONEG = 1 << 9, /* Auto-negotiation. */
91 OFPPF10_PAUSE = 1 << 10, /* Pause. */
92 OFPPF10_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
95 /* Description of a physical port */
96 struct ofp10_phy_port {
98 uint8_t hw_addr[OFP_ETH_ALEN];
99 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
101 ovs_be32 config; /* Bitmap of OFPPC_* and OFPPC10_* flags. */
102 ovs_be32 state; /* Bitmap of OFPPS_* and OFPPS10_* flags. */
104 /* Bitmaps of OFPPF_* and OFPPF10_* that describe features. All bits
105 * zeroed if unsupported or unavailable. */
106 ovs_be32 curr; /* Current features. */
107 ovs_be32 advertised; /* Features being advertised by the port. */
108 ovs_be32 supported; /* Features supported by the port. */
109 ovs_be32 peer; /* Features advertised by peer. */
111 OFP_ASSERT(sizeof(struct ofp10_phy_port) == 48);
113 /* Modify behavior of the physical port */
114 struct ofp10_port_mod {
116 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
117 configurable. This is used to
118 sanity-check the request, so it must
119 be the same as returned in an
120 ofp10_phy_port struct. */
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 /* Query for port queue configuration. */
132 struct ofp10_queue_get_config_request {
133 ovs_be16 port; /* Port to be queried. Should refer
134 to a valid physical port (i.e. < OFPP_MAX) */
136 /* 32-bit alignment. */
138 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_request) == 4);
140 /* Queue configuration for a given port. */
141 struct ofp10_queue_get_config_reply {
144 /* struct ofp10_packet_queue queues[0]; List of configured queues. */
146 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_reply) == 8);
148 /* Packet received on port (datapath -> controller). */
149 struct ofp10_packet_in {
150 ovs_be32 buffer_id; /* ID assigned by datapath. */
151 ovs_be16 total_len; /* Full length of frame. */
152 ovs_be16 in_port; /* Port on which frame was received. */
153 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
155 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
156 so the IP header is 32-bit aligned. The
157 amount of data is inferred from the length
158 field in the header. Because of padding,
159 offsetof(struct ofp_packet_in, data) ==
160 sizeof(struct ofp_packet_in) - 2. */
162 OFP_ASSERT(sizeof(struct ofp10_packet_in) == 12);
164 enum ofp10_action_type {
165 OFPAT10_OUTPUT, /* Output to switch port. */
166 OFPAT10_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
167 OFPAT10_SET_VLAN_PCP, /* Set the 802.1q priority. */
168 OFPAT10_STRIP_VLAN, /* Strip the 802.1q header. */
169 OFPAT10_SET_DL_SRC, /* Ethernet source address. */
170 OFPAT10_SET_DL_DST, /* Ethernet destination address. */
171 OFPAT10_SET_NW_SRC, /* IP source address. */
172 OFPAT10_SET_NW_DST, /* IP destination address. */
173 OFPAT10_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
174 OFPAT10_SET_TP_SRC, /* TCP/UDP source port. */
175 OFPAT10_SET_TP_DST, /* TCP/UDP destination port. */
176 OFPAT10_ENQUEUE, /* Output to queue. */
177 OFPAT10_VENDOR = 0xffff
180 /* Action structure for OFPAT10_OUTPUT, which sends packets out 'port'.
181 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
182 * number of bytes to send. A 'max_len' of zero means no bytes of the
183 * packet should be sent. */
184 struct ofp10_action_output {
185 ovs_be16 type; /* OFPAT10_OUTPUT. */
186 ovs_be16 len; /* Length is 8. */
187 ovs_be16 port; /* Output port. */
188 ovs_be16 max_len; /* Max length to send to controller. */
190 OFP_ASSERT(sizeof(struct ofp10_action_output) == 8);
192 /* OFPAT10_ENQUEUE action struct: send packets to given queue on port. */
193 struct ofp10_action_enqueue {
194 ovs_be16 type; /* OFPAT10_ENQUEUE. */
195 ovs_be16 len; /* Len is 16. */
196 ovs_be16 port; /* Port that queue belongs. Should
197 refer to a valid physical port
198 (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
199 uint8_t pad[6]; /* Pad for 64-bit alignment. */
200 ovs_be32 queue_id; /* Where to enqueue the packets. */
202 OFP_ASSERT(sizeof(struct ofp10_action_enqueue) == 16);
204 /* Send packet (controller -> datapath). */
205 struct ofp10_packet_out {
206 ovs_be32 buffer_id; /* ID assigned by datapath or UINT32_MAX. */
207 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
208 ovs_be16 actions_len; /* Size of action array in bytes. */
210 * - Exactly 'actions_len' bytes (possibly 0 bytes, and always a multiple
211 * of 8) containing actions.
212 * - If 'buffer_id' == UINT32_MAX, packet data to fill out the remainder
213 * of the message length.
216 OFP_ASSERT(sizeof(struct ofp10_packet_out) == 8);
218 /* Flow wildcards. */
219 enum ofp10_flow_wildcards {
220 OFPFW10_IN_PORT = 1 << 0, /* Switch input port. */
221 OFPFW10_DL_VLAN = 1 << 1, /* VLAN vid. */
222 OFPFW10_DL_SRC = 1 << 2, /* Ethernet source address. */
223 OFPFW10_DL_DST = 1 << 3, /* Ethernet destination address. */
224 OFPFW10_DL_TYPE = 1 << 4, /* Ethernet frame type. */
225 OFPFW10_NW_PROTO = 1 << 5, /* IP protocol. */
226 OFPFW10_TP_SRC = 1 << 6, /* TCP/UDP source port. */
227 OFPFW10_TP_DST = 1 << 7, /* TCP/UDP destination port. */
229 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
230 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
231 * the entire field. This is the *opposite* of the usual convention where
232 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
233 OFPFW10_NW_SRC_SHIFT = 8,
234 OFPFW10_NW_SRC_BITS = 6,
235 OFPFW10_NW_SRC_MASK = (((1 << OFPFW10_NW_SRC_BITS) - 1)
236 << OFPFW10_NW_SRC_SHIFT),
237 OFPFW10_NW_SRC_ALL = 32 << OFPFW10_NW_SRC_SHIFT,
239 /* IP destination address wildcard bit count. Same format as source. */
240 OFPFW10_NW_DST_SHIFT = 14,
241 OFPFW10_NW_DST_BITS = 6,
242 OFPFW10_NW_DST_MASK = (((1 << OFPFW10_NW_DST_BITS) - 1)
243 << OFPFW10_NW_DST_SHIFT),
244 OFPFW10_NW_DST_ALL = 32 << OFPFW10_NW_DST_SHIFT,
246 OFPFW10_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
247 OFPFW10_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
249 /* Wildcard all fields. */
250 OFPFW10_ALL = ((1 << 22) - 1)
253 /* The wildcards for ICMP type and code fields use the transport source
254 * and destination port fields, respectively. */
255 #define OFPFW10_ICMP_TYPE OFPFW10_TP_SRC
256 #define OFPFW10_ICMP_CODE OFPFW10_TP_DST
258 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
259 * special conditions. All ones indicates that 802.1Q header is not present.
261 #define OFP10_VLAN_NONE 0xffff
263 /* Fields to match against flows */
265 ovs_be32 wildcards; /* Wildcard fields. */
266 ovs_be16 in_port; /* Input switch port. */
267 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
268 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
269 ovs_be16 dl_vlan; /* Input VLAN. */
270 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
271 uint8_t pad1[1]; /* Align to 64-bits. */
272 ovs_be16 dl_type; /* Ethernet frame type. */
273 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
274 uint8_t nw_proto; /* IP protocol or lower 8 bits of
276 uint8_t pad2[2]; /* Align to 64-bits. */
277 ovs_be32 nw_src; /* IP source address. */
278 ovs_be32 nw_dst; /* IP destination address. */
279 ovs_be16 tp_src; /* TCP/UDP source port. */
280 ovs_be16 tp_dst; /* TCP/UDP destination port. */
282 OFP_ASSERT(sizeof(struct ofp10_match) == 40);
284 enum ofp10_flow_mod_flags {
285 OFPFF10_EMERG = 1 << 2 /* Part of "emergency flow cache". */
288 /* Flow setup and teardown (controller -> datapath). */
289 struct ofp10_flow_mod {
290 struct ofp10_match match; /* Fields to match */
291 ovs_be64 cookie; /* Opaque controller-issued identifier. */
294 ovs_be16 command; /* One of OFPFC_*. */
295 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
296 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
297 ovs_be16 priority; /* Priority level of flow entry. */
298 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
299 Not meaningful for OFPFC_DELETE*. */
300 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
301 matching entries to include this as an
302 output port. A value of OFPP_NONE
303 indicates no restriction. */
304 ovs_be16 flags; /* One of OFPFF_*. */
305 struct ofp_action_header actions[0]; /* The action length is inferred
306 from the length field in the
309 OFP_ASSERT(sizeof(struct ofp10_flow_mod) == 64);
311 /* Flow removed (datapath -> controller). */
312 struct ofp10_flow_removed {
313 struct ofp10_match match; /* Description of fields. */
314 ovs_be64 cookie; /* Opaque controller-issued identifier. */
316 ovs_be16 priority; /* Priority level of flow entry. */
317 uint8_t reason; /* One of OFPRR_*. */
318 uint8_t pad[1]; /* Align to 32-bits. */
320 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
321 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
323 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
324 uint8_t pad2[2]; /* Align to 64-bits. */
325 ovs_be64 packet_count;
328 OFP_ASSERT(sizeof(struct ofp10_flow_removed) == 80);
330 /* Statistics request or reply message. */
331 struct ofp10_stats_msg {
332 struct ofp_header header;
333 ovs_be16 type; /* One of the OFPST_* constants. */
334 ovs_be16 flags; /* Requests: always 0.
335 * Replies: 0 or OFPSF_REPLY_MORE. */
337 OFP_ASSERT(sizeof(struct ofp10_stats_msg) == 12);
339 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
340 struct ofp10_flow_stats_request {
341 struct ofp10_match match; /* Fields to match. */
342 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
343 or 0xff for all tables. */
344 uint8_t pad; /* Align to 32 bits. */
345 ovs_be16 out_port; /* Require matching entries to include this
346 as an output port. A value of OFPP_NONE
347 indicates no restriction. */
349 OFP_ASSERT(sizeof(struct ofp10_flow_stats_request) == 44);
351 /* Body of reply to OFPST_FLOW request. */
352 struct ofp10_flow_stats {
353 ovs_be16 length; /* Length of this entry. */
354 uint8_t table_id; /* ID of table flow came from. */
356 struct ofp10_match match; /* Description of fields. */
357 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
358 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
359 beyond duration_sec. */
360 ovs_be16 priority; /* Priority of the entry. Only meaningful
361 when this is not an exact-match entry. */
362 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
363 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
364 uint8_t pad2[6]; /* Align to 64 bits. */
365 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
366 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
367 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
368 struct ofp_action_header actions[0]; /* Actions. */
370 OFP_ASSERT(sizeof(struct ofp10_flow_stats) == 88);
372 /* Body of reply to OFPST_TABLE request. */
373 struct ofp10_table_stats {
374 uint8_t table_id; /* Identifier of table. Lower numbered tables
375 are consulted first. */
376 uint8_t pad[3]; /* Align to 32-bits. */
377 char name[OFP_MAX_TABLE_NAME_LEN];
378 ovs_be32 wildcards; /* Bitmap of OFPFW10_* wildcards that are
379 supported by the table. */
380 ovs_be32 max_entries; /* Max number of entries supported. */
381 ovs_be32 active_count; /* Number of active entries. */
382 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
383 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
385 OFP_ASSERT(sizeof(struct ofp10_table_stats) == 64);
387 /* Stats request of type OFPST_PORT. */
388 struct ofp10_port_stats_request {
389 ovs_be16 port_no; /* OFPST_PORT message may request statistics
390 for a single port (specified with port_no)
391 or for all ports (port_no == OFPP_NONE). */
394 OFP_ASSERT(sizeof(struct ofp10_port_stats_request) == 8);
396 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
397 * the field to all ones. */
398 struct ofp10_port_stats {
400 uint8_t pad[6]; /* Align to 64-bits. */
401 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
402 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
403 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
404 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
405 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
406 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
407 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
408 super-set of receive errors and should be
409 great than or equal to the sum of all
411 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
412 super-set of transmit errors. */
413 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
414 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
415 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
416 ovs_32aligned_be64 collisions; /* Number of collisions. */
418 OFP_ASSERT(sizeof(struct ofp10_port_stats) == 104);
420 /* All ones is used to indicate all queues in a port (for stats retrieval). */
421 #define OFPQ_ALL 0xffffffff
423 /* Body for stats request of type OFPST_QUEUE. */
424 struct ofp10_queue_stats_request {
425 ovs_be16 port_no; /* All ports if OFPP_ALL. */
426 uint8_t pad[2]; /* Align to 32-bits. */
427 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
429 OFP_ASSERT(sizeof(struct ofp10_queue_stats_request) == 8);
431 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
433 struct ofp10_queue_stats {
435 uint8_t pad[2]; /* Align to 32-bits. */
436 ovs_be32 queue_id; /* Queue id. */
437 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
438 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
439 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
441 OFP_ASSERT(sizeof(struct ofp10_queue_stats) == 32);
443 /* Vendor extension stats message. */
444 struct ofp10_vendor_stats_msg {
445 struct ofp10_stats_msg osm; /* Type OFPST_VENDOR. */
446 ovs_be32 vendor; /* Vendor ID:
447 * - MSB 0: low-order bytes are IEEE OUI.
448 * - MSB != 0: defined by OpenFlow
450 /* Followed by vendor-defined arbitrary additional data. */
452 OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg) == 16);
454 #endif /* openflow/openflow-1.0.h */