2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 uint8_t hw_addr[OFP_ETH_ALEN];
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 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
118 configurable. This is used to
119 sanity-check the request, so it must
120 be the same as returned in an
121 ofp10_phy_port struct. */
123 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
124 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
126 ovs_be32 advertise; /* Bitmap of "ofp_port_features"s. Zero all
127 bits to prevent any action taking place. */
128 uint8_t pad[4]; /* Pad to 64-bits. */
130 OFP_ASSERT(sizeof(struct ofp10_port_mod) == 24);
132 struct ofp10_packet_queue {
133 ovs_be32 queue_id; /* id for the specific queue. */
134 ovs_be16 len; /* Length in bytes of this queue desc. */
135 uint8_t pad[2]; /* 64-bit alignment. */
136 /* Followed by any number of queue properties expressed using
137 * ofp_queue_prop_header, to fill out a total of 'len' bytes. */
139 OFP_ASSERT(sizeof(struct ofp10_packet_queue) == 8);
141 /* Query for port queue configuration. */
142 struct ofp10_queue_get_config_request {
143 ovs_be16 port; /* Port to be queried. Should refer
144 to a valid physical port (i.e. < OFPP_MAX) */
146 /* 32-bit alignment. */
148 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_request) == 4);
150 /* Queue configuration for a given port. */
151 struct ofp10_queue_get_config_reply {
154 /* struct ofp10_packet_queue queues[0]; List of configured queues. */
156 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_reply) == 8);
158 /* Packet received on port (datapath -> controller). */
159 struct ofp10_packet_in {
160 ovs_be32 buffer_id; /* ID assigned by datapath. */
161 ovs_be16 total_len; /* Full length of frame. */
162 ovs_be16 in_port; /* Port on which frame was received. */
163 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
165 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
166 so the IP header is 32-bit aligned. The
167 amount of data is inferred from the length
168 field in the header. Because of padding,
169 offsetof(struct ofp_packet_in, data) ==
170 sizeof(struct ofp_packet_in) - 2. */
172 OFP_ASSERT(sizeof(struct ofp10_packet_in) == 12);
174 /* Send packet (controller -> datapath). */
175 struct ofp10_packet_out {
176 ovs_be32 buffer_id; /* ID assigned by datapath or UINT32_MAX. */
177 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
178 ovs_be16 actions_len; /* Size of action array in bytes. */
180 * - Exactly 'actions_len' bytes (possibly 0 bytes, and always a multiple
181 * of 8) containing actions.
182 * - If 'buffer_id' == UINT32_MAX, packet data to fill out the remainder
183 * of the message length.
186 OFP_ASSERT(sizeof(struct ofp10_packet_out) == 8);
188 /* Flow wildcards. */
189 enum ofp10_flow_wildcards {
190 OFPFW10_IN_PORT = 1 << 0, /* Switch input port. */
191 OFPFW10_DL_VLAN = 1 << 1, /* VLAN vid. */
192 OFPFW10_DL_SRC = 1 << 2, /* Ethernet source address. */
193 OFPFW10_DL_DST = 1 << 3, /* Ethernet destination address. */
194 OFPFW10_DL_TYPE = 1 << 4, /* Ethernet frame type. */
195 OFPFW10_NW_PROTO = 1 << 5, /* IP protocol. */
196 OFPFW10_TP_SRC = 1 << 6, /* TCP/UDP source port. */
197 OFPFW10_TP_DST = 1 << 7, /* TCP/UDP destination port. */
199 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
200 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
201 * the entire field. This is the *opposite* of the usual convention where
202 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
203 OFPFW10_NW_SRC_SHIFT = 8,
204 OFPFW10_NW_SRC_BITS = 6,
205 OFPFW10_NW_SRC_MASK = (((1 << OFPFW10_NW_SRC_BITS) - 1)
206 << OFPFW10_NW_SRC_SHIFT),
207 OFPFW10_NW_SRC_ALL = 32 << OFPFW10_NW_SRC_SHIFT,
209 /* IP destination address wildcard bit count. Same format as source. */
210 OFPFW10_NW_DST_SHIFT = 14,
211 OFPFW10_NW_DST_BITS = 6,
212 OFPFW10_NW_DST_MASK = (((1 << OFPFW10_NW_DST_BITS) - 1)
213 << OFPFW10_NW_DST_SHIFT),
214 OFPFW10_NW_DST_ALL = 32 << OFPFW10_NW_DST_SHIFT,
216 OFPFW10_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
217 OFPFW10_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
219 /* Wildcard all fields. */
220 OFPFW10_ALL = ((1 << 22) - 1)
223 /* The wildcards for ICMP type and code fields use the transport source
224 * and destination port fields, respectively. */
225 #define OFPFW10_ICMP_TYPE OFPFW10_TP_SRC
226 #define OFPFW10_ICMP_CODE OFPFW10_TP_DST
228 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
229 * special conditions. All ones indicates that 802.1Q header is not present.
231 #define OFP10_VLAN_NONE 0xffff
233 /* Fields to match against flows */
235 ovs_be32 wildcards; /* Wildcard fields. */
236 ovs_be16 in_port; /* Input switch port. */
237 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
238 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
239 ovs_be16 dl_vlan; /* Input VLAN. */
240 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
241 uint8_t pad1[1]; /* Align to 64-bits. */
242 ovs_be16 dl_type; /* Ethernet frame type. */
243 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
244 uint8_t nw_proto; /* IP protocol or lower 8 bits of
246 uint8_t pad2[2]; /* Align to 64-bits. */
247 ovs_be32 nw_src; /* IP source address. */
248 ovs_be32 nw_dst; /* IP destination address. */
249 ovs_be16 tp_src; /* TCP/UDP source port. */
250 ovs_be16 tp_dst; /* TCP/UDP destination port. */
252 OFP_ASSERT(sizeof(struct ofp10_match) == 40);
254 enum ofp10_flow_mod_flags {
255 OFPFF10_EMERG = 1 << 2 /* Part of "emergency flow cache". */
258 /* Flow setup and teardown (controller -> datapath). */
259 struct ofp10_flow_mod {
260 struct ofp10_match match; /* Fields to match */
261 ovs_be64 cookie; /* Opaque controller-issued identifier. */
264 ovs_be16 command; /* One of OFPFC_*. */
265 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
266 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
267 ovs_be16 priority; /* Priority level of flow entry. */
268 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
269 Not meaningful for OFPFC_DELETE*. */
270 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
271 matching entries to include this as an
272 output port. A value of OFPP_NONE
273 indicates no restriction. */
274 ovs_be16 flags; /* One of OFPFF_*. */
276 /* Followed by OpenFlow actions whose length is inferred from the length
277 * field in the OpenFlow header. */
279 OFP_ASSERT(sizeof(struct ofp10_flow_mod) == 64);
281 /* Flow removed (datapath -> controller). */
282 struct ofp10_flow_removed {
283 struct ofp10_match match; /* Description of fields. */
284 ovs_be64 cookie; /* Opaque controller-issued identifier. */
286 ovs_be16 priority; /* Priority level of flow entry. */
287 uint8_t reason; /* One of OFPRR_*. */
288 uint8_t pad[1]; /* Align to 32-bits. */
290 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
291 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
293 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
294 uint8_t pad2[2]; /* Align to 64-bits. */
295 ovs_be64 packet_count;
298 OFP_ASSERT(sizeof(struct ofp10_flow_removed) == 80);
300 /* Statistics request or reply message. */
301 struct ofp10_stats_msg {
302 struct ofp_header header;
303 ovs_be16 type; /* One of the OFPST_* constants. */
304 ovs_be16 flags; /* Requests: always 0.
305 * Replies: 0 or OFPSF_REPLY_MORE. */
307 OFP_ASSERT(sizeof(struct ofp10_stats_msg) == 12);
309 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
310 struct ofp10_flow_stats_request {
311 struct ofp10_match match; /* Fields to match. */
312 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
313 or 0xff for all tables. */
314 uint8_t pad; /* Align to 32 bits. */
315 ovs_be16 out_port; /* Require matching entries to include this
316 as an output port. A value of OFPP_NONE
317 indicates no restriction. */
319 OFP_ASSERT(sizeof(struct ofp10_flow_stats_request) == 44);
321 /* Body of reply to OFPST_FLOW request. */
322 struct ofp10_flow_stats {
323 ovs_be16 length; /* Length of this entry. */
324 uint8_t table_id; /* ID of table flow came from. */
326 struct ofp10_match match; /* Description of fields. */
327 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
328 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
329 beyond duration_sec. */
330 ovs_be16 priority; /* Priority of the entry. Only meaningful
331 when this is not an exact-match entry. */
332 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
333 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
334 uint8_t pad2[6]; /* Align to 64 bits. */
335 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
336 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
337 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
338 /* Followed by OpenFlow actions whose length is inferred from 'length'. */
340 OFP_ASSERT(sizeof(struct ofp10_flow_stats) == 88);
342 /* Body of reply to OFPST_TABLE request. */
343 struct ofp10_table_stats {
344 uint8_t table_id; /* Identifier of table. Lower numbered tables
345 are consulted first. */
346 uint8_t pad[3]; /* Align to 32-bits. */
347 char name[OFP_MAX_TABLE_NAME_LEN];
348 ovs_be32 wildcards; /* Bitmap of OFPFW10_* wildcards that are
349 supported by the table. */
350 ovs_be32 max_entries; /* Max number of entries supported. */
351 ovs_be32 active_count; /* Number of active entries. */
352 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
353 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
355 OFP_ASSERT(sizeof(struct ofp10_table_stats) == 64);
357 /* Stats request of type OFPST_PORT. */
358 struct ofp10_port_stats_request {
359 ovs_be16 port_no; /* OFPST_PORT message may request statistics
360 for a single port (specified with port_no)
361 or for all ports (port_no == OFPP_NONE). */
364 OFP_ASSERT(sizeof(struct ofp10_port_stats_request) == 8);
366 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
367 * the field to all ones. */
368 struct ofp10_port_stats {
370 uint8_t pad[6]; /* Align to 64-bits. */
371 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
372 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
373 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
374 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
375 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
376 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
377 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
378 super-set of receive errors and should be
379 great than or equal to the sum of all
381 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
382 super-set of transmit errors. */
383 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
384 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
385 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
386 ovs_32aligned_be64 collisions; /* Number of collisions. */
388 OFP_ASSERT(sizeof(struct ofp10_port_stats) == 104);
390 /* All ones is used to indicate all queues in a port (for stats retrieval). */
391 #define OFPQ_ALL 0xffffffff
393 /* Body for stats request of type OFPST_QUEUE. */
394 struct ofp10_queue_stats_request {
395 ovs_be16 port_no; /* All ports if OFPP_ALL. */
396 uint8_t pad[2]; /* Align to 32-bits. */
397 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
399 OFP_ASSERT(sizeof(struct ofp10_queue_stats_request) == 8);
401 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
403 struct ofp10_queue_stats {
405 uint8_t pad[2]; /* Align to 32-bits. */
406 ovs_be32 queue_id; /* Queue id. */
407 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
408 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
409 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
411 OFP_ASSERT(sizeof(struct ofp10_queue_stats) == 32);
413 /* Vendor extension stats message. */
414 struct ofp10_vendor_stats_msg {
415 struct ofp10_stats_msg osm; /* Type OFPST_VENDOR. */
416 ovs_be32 vendor; /* Vendor ID:
417 * - MSB 0: low-order bytes are IEEE OUI.
418 * - MSB != 0: defined by OpenFlow
420 /* Followed by vendor-defined arbitrary additional data. */
422 OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg) == 16);
424 #endif /* openflow/openflow-1.0.h */