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);
206 struct ofp_action_header header;
207 struct ofp_action_vendor_header vendor;
208 struct ofp10_action_output output10;
209 struct ofp_action_vlan_vid vlan_vid;
210 struct ofp_action_vlan_pcp vlan_pcp;
211 struct ofp_action_nw_addr nw_addr;
212 struct ofp_action_nw_tos nw_tos;
213 struct ofp_action_tp_port tp_port;
215 OFP_ASSERT(sizeof(union ofp_action) == 8);
217 /* Send packet (controller -> datapath). */
218 struct ofp10_packet_out {
219 ovs_be32 buffer_id; /* ID assigned by datapath or UINT32_MAX. */
220 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
221 ovs_be16 actions_len; /* Size of action array in bytes. */
223 * - Exactly 'actions_len' bytes (possibly 0 bytes, and always a multiple
224 * of 8) containing actions.
225 * - If 'buffer_id' == UINT32_MAX, packet data to fill out the remainder
226 * of the message length.
229 OFP_ASSERT(sizeof(struct ofp10_packet_out) == 8);
231 /* Flow wildcards. */
232 enum ofp10_flow_wildcards {
233 OFPFW10_IN_PORT = 1 << 0, /* Switch input port. */
234 OFPFW10_DL_VLAN = 1 << 1, /* VLAN vid. */
235 OFPFW10_DL_SRC = 1 << 2, /* Ethernet source address. */
236 OFPFW10_DL_DST = 1 << 3, /* Ethernet destination address. */
237 OFPFW10_DL_TYPE = 1 << 4, /* Ethernet frame type. */
238 OFPFW10_NW_PROTO = 1 << 5, /* IP protocol. */
239 OFPFW10_TP_SRC = 1 << 6, /* TCP/UDP source port. */
240 OFPFW10_TP_DST = 1 << 7, /* TCP/UDP destination port. */
242 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
243 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
244 * the entire field. This is the *opposite* of the usual convention where
245 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
246 OFPFW10_NW_SRC_SHIFT = 8,
247 OFPFW10_NW_SRC_BITS = 6,
248 OFPFW10_NW_SRC_MASK = (((1 << OFPFW10_NW_SRC_BITS) - 1)
249 << OFPFW10_NW_SRC_SHIFT),
250 OFPFW10_NW_SRC_ALL = 32 << OFPFW10_NW_SRC_SHIFT,
252 /* IP destination address wildcard bit count. Same format as source. */
253 OFPFW10_NW_DST_SHIFT = 14,
254 OFPFW10_NW_DST_BITS = 6,
255 OFPFW10_NW_DST_MASK = (((1 << OFPFW10_NW_DST_BITS) - 1)
256 << OFPFW10_NW_DST_SHIFT),
257 OFPFW10_NW_DST_ALL = 32 << OFPFW10_NW_DST_SHIFT,
259 OFPFW10_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
260 OFPFW10_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
262 /* Wildcard all fields. */
263 OFPFW10_ALL = ((1 << 22) - 1)
266 /* The wildcards for ICMP type and code fields use the transport source
267 * and destination port fields, respectively. */
268 #define OFPFW10_ICMP_TYPE OFPFW10_TP_SRC
269 #define OFPFW10_ICMP_CODE OFPFW10_TP_DST
271 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
272 * special conditions. All ones indicates that 802.1Q header is not present.
274 #define OFP10_VLAN_NONE 0xffff
276 /* Fields to match against flows */
278 ovs_be32 wildcards; /* Wildcard fields. */
279 ovs_be16 in_port; /* Input switch port. */
280 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
281 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
282 ovs_be16 dl_vlan; /* Input VLAN. */
283 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
284 uint8_t pad1[1]; /* Align to 64-bits. */
285 ovs_be16 dl_type; /* Ethernet frame type. */
286 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
287 uint8_t nw_proto; /* IP protocol or lower 8 bits of
289 uint8_t pad2[2]; /* Align to 64-bits. */
290 ovs_be32 nw_src; /* IP source address. */
291 ovs_be32 nw_dst; /* IP destination address. */
292 ovs_be16 tp_src; /* TCP/UDP source port. */
293 ovs_be16 tp_dst; /* TCP/UDP destination port. */
295 OFP_ASSERT(sizeof(struct ofp10_match) == 40);
297 enum ofp10_flow_mod_flags {
298 OFPFF10_EMERG = 1 << 2 /* Ramark this is for emergency. */
301 /* Flow setup and teardown (controller -> datapath). */
302 struct ofp10_flow_mod {
303 struct ofp10_match match; /* Fields to match */
304 ovs_be64 cookie; /* Opaque controller-issued identifier. */
307 ovs_be16 command; /* One of OFPFC_*. */
308 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
309 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
310 ovs_be16 priority; /* Priority level of flow entry. */
311 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
312 Not meaningful for OFPFC_DELETE*. */
313 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
314 matching entries to include this as an
315 output port. A value of OFPP_NONE
316 indicates no restriction. */
317 ovs_be16 flags; /* One of OFPFF_*. */
318 struct ofp_action_header actions[0]; /* The action length is inferred
319 from the length field in the
322 OFP_ASSERT(sizeof(struct ofp10_flow_mod) == 64);
324 /* Flow removed (datapath -> controller). */
325 struct ofp10_flow_removed {
326 struct ofp10_match match; /* Description of fields. */
327 ovs_be64 cookie; /* Opaque controller-issued identifier. */
329 ovs_be16 priority; /* Priority level of flow entry. */
330 uint8_t reason; /* One of OFPRR_*. */
331 uint8_t pad[1]; /* Align to 32-bits. */
333 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
334 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
336 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
337 uint8_t pad2[2]; /* Align to 64-bits. */
338 ovs_be64 packet_count;
341 OFP_ASSERT(sizeof(struct ofp10_flow_removed) == 80);
343 /* Statistics request or reply message. */
344 struct ofp10_stats_msg {
345 struct ofp_header header;
346 ovs_be16 type; /* One of the OFPST_* constants. */
347 ovs_be16 flags; /* Requests: always 0.
348 * Replies: 0 or OFPSF_REPLY_MORE. */
350 OFP_ASSERT(sizeof(struct ofp10_stats_msg) == 12);
352 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
353 struct ofp10_flow_stats_request {
354 struct ofp10_match match; /* Fields to match. */
355 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
356 or 0xff for all tables. */
357 uint8_t pad; /* Align to 32 bits. */
358 ovs_be16 out_port; /* Require matching entries to include this
359 as an output port. A value of OFPP_NONE
360 indicates no restriction. */
362 OFP_ASSERT(sizeof(struct ofp10_flow_stats_request) == 44);
364 /* Body of reply to OFPST_FLOW request. */
365 struct ofp10_flow_stats {
366 ovs_be16 length; /* Length of this entry. */
367 uint8_t table_id; /* ID of table flow came from. */
369 struct ofp10_match match; /* Description of fields. */
370 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
371 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
372 beyond duration_sec. */
373 ovs_be16 priority; /* Priority of the entry. Only meaningful
374 when this is not an exact-match entry. */
375 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
376 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
377 uint8_t pad2[6]; /* Align to 64 bits. */
378 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
379 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
380 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
381 struct ofp_action_header actions[0]; /* Actions. */
383 OFP_ASSERT(sizeof(struct ofp10_flow_stats) == 88);
385 /* Body of reply to OFPST_TABLE request. */
386 struct ofp10_table_stats {
387 uint8_t table_id; /* Identifier of table. Lower numbered tables
388 are consulted first. */
389 uint8_t pad[3]; /* Align to 32-bits. */
390 char name[OFP_MAX_TABLE_NAME_LEN];
391 ovs_be32 wildcards; /* Bitmap of OFPFW10_* wildcards that are
392 supported by the table. */
393 ovs_be32 max_entries; /* Max number of entries supported. */
394 ovs_be32 active_count; /* Number of active entries. */
395 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
396 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
398 OFP_ASSERT(sizeof(struct ofp10_table_stats) == 64);
400 /* Stats request of type OFPST_PORT. */
401 struct ofp10_port_stats_request {
402 ovs_be16 port_no; /* OFPST_PORT message may request statistics
403 for a single port (specified with port_no)
404 or for all ports (port_no == OFPP_NONE). */
407 OFP_ASSERT(sizeof(struct ofp10_port_stats_request) == 8);
409 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
410 * the field to all ones. */
411 struct ofp10_port_stats {
413 uint8_t pad[6]; /* Align to 64-bits. */
414 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
415 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
416 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
417 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
418 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
419 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
420 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
421 super-set of receive errors and should be
422 great than or equal to the sum of all
424 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
425 super-set of transmit errors. */
426 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
427 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
428 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
429 ovs_32aligned_be64 collisions; /* Number of collisions. */
431 OFP_ASSERT(sizeof(struct ofp10_port_stats) == 104);
433 /* All ones is used to indicate all queues in a port (for stats retrieval). */
434 #define OFPQ_ALL 0xffffffff
436 /* Body for stats request of type OFPST_QUEUE. */
437 struct ofp10_queue_stats_request {
438 ovs_be16 port_no; /* All ports if OFPP_ALL. */
439 uint8_t pad[2]; /* Align to 32-bits. */
440 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
442 OFP_ASSERT(sizeof(struct ofp10_queue_stats_request) == 8);
444 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
446 struct ofp10_queue_stats {
448 uint8_t pad[2]; /* Align to 32-bits. */
449 ovs_be32 queue_id; /* Queue id. */
450 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
451 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
452 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
454 OFP_ASSERT(sizeof(struct ofp10_queue_stats) == 32);
456 /* Vendor extension stats message. */
457 struct ofp10_vendor_stats_msg {
458 struct ofp10_stats_msg osm; /* Type OFPST_VENDOR. */
459 ovs_be32 vendor; /* Vendor ID:
460 * - MSB 0: low-order bytes are IEEE OUI.
461 * - MSB != 0: defined by OpenFlow
463 /* Followed by vendor-defined arbitrary additional data. */
465 OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg) == 16);
467 #endif /* openflow/openflow-1.0.h */