1 /* Copyright (c) 2008, 2011, 2012, 2013, 2014, 2016 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.
35 * Copyright (c) 2008-2015 Nicira, Inc.
37 * Licensed under the Apache License, Version 2.0 (the "License");
38 * you may not use this file except in compliance with the License.
39 * You may obtain a copy of the License at:
41 * http://www.apache.org/licenses/LICENSE-2.0
43 * Unless required by applicable law or agreed to in writing, software
44 * distributed under the License is distributed on an "AS IS" BASIS,
45 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
46 * See the License for the specific language governing permissions and
47 * limitations under the License.
50 #ifndef OPENFLOW_COMMON_H
51 #define OPENFLOW_COMMON_H 1
53 #include <openvswitch/types.h>
56 #define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
57 #elif !defined(__cplusplus)
58 /* Build-time assertion for use in a declaration context. */
59 #define OFP_ASSERT(EXPR) \
60 extern int (*build_assert(void))[ sizeof(struct { \
61 unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
62 #else /* __cplusplus */
63 #include <boost/static_assert.hpp>
64 #define OFP_ASSERT BOOST_STATIC_ASSERT
65 #endif /* __cplusplus */
68 * Non-experimental versions released: 0x01 0x02
69 * Experimental versions released: 0x81 -- 0x99
71 /* The most significant bit being set in the version field indicates an
72 * experimental OpenFlow version.
84 /* Vendor (aka experimenter) IDs.
86 * These are used in various places in OpenFlow to identify an extension
87 * defined by some vendor, as opposed to a standardized part of the core
90 * Vendor IDs whose top 8 bits are 0 hold an Ethernet OUI in their low 24 bits.
91 * The Open Networking Foundation assigns vendor IDs whose top 8 bits are
94 * A few vendor IDs are special:
96 * - OF_VENDOR_ID is not a real vendor ID and does not appear in the
97 * OpenFlow protocol itself. It can occasionally be useful within Open
98 * vSwitch to identify a standardized part of OpenFlow.
100 * - ONF_VENDOR_ID is being used within the ONF "extensibility" working
101 * group to identify extensions being proposed for standardization.
103 * The list is sorted numerically.
105 #define OF_VENDOR_ID 0
106 #define HPL_VENDOR_ID 0x000004EA /* HP Labs. */
107 #define NTR_VENDOR_ID 0x0000154d /* Netronome. */
108 #define NTR_COMPAT_VENDOR_ID 0x00001540 /* Incorrect value used in v2.4. */
109 #define NX_VENDOR_ID 0x00002320 /* Nicira. */
110 #define ONF_VENDOR_ID 0x4f4e4600 /* Open Networking Foundation. */
111 #define INTEL_VENDOR_ID 0x0000AA01 /* Intel */
113 #define OFP_MAX_TABLE_NAME_LEN 32
115 #define OFP_OLD_PORT 6633
116 #define OFP_PORT 6653
118 #define OFP_DEFAULT_MISS_SEND_LEN 128
120 /* Values below this cutoff are 802.3 packets and the two bytes
121 * following MAC addresses are used as a frame length. Otherwise, the
122 * two bytes are used as the Ethernet type.
124 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
126 /* Value of dl_type to indicate that the frame does not include an
129 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
131 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
133 #define OFP_FLOW_PERMANENT 0
135 /* By default, choose a priority in the middle. */
136 #define OFP_DEFAULT_PRIORITY 0x8000
139 /* Header on all OpenFlow packets. */
141 uint8_t version
; /* An OpenFlow version number, e.g. OFP10_VERSION. */
142 uint8_t type
; /* One of the OFPT_ constants. */
143 ovs_be16 length
; /* Length including this ofp_header. */
144 ovs_be32 xid
; /* Transaction id associated with this packet.
145 Replies use the same id as was in the request
146 to facilitate pairing. */
148 OFP_ASSERT(sizeof(struct ofp_header
) == 8);
150 /* OFPT_ERROR: Error message (datapath -> controller). */
151 struct ofp_error_msg
{
154 uint8_t data
[0]; /* Variable-length data. Interpreted based
155 on the type and code. */
157 OFP_ASSERT(sizeof(struct ofp_error_msg
) == 4);
159 enum ofp_config_flags
{
160 /* Handling of IP fragments. */
161 OFPC_FRAG_NORMAL
= 0, /* No special handling for fragments. */
162 OFPC_FRAG_DROP
= 1, /* Drop fragments. */
163 OFPC_FRAG_REASM
= 2, /* Reassemble (only if OFPC_IP_REASM set). */
164 OFPC_FRAG_NX_MATCH
= 3, /* Make first fragments available for matching. */
167 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OpenFlow 1.3 */
169 /* TTL processing - applicable for IP and MPLS packets. */
170 OFPC_INVALID_TTL_TO_CONTROLLER
= 1 << 2, /* Send packets with invalid TTL
171 to the controller. */
174 /* Switch configuration. */
175 struct ofp_switch_config
{
176 ovs_be16 flags
; /* OFPC_* flags. */
177 ovs_be16 miss_send_len
; /* Max bytes of new flow that datapath should
178 send to the controller. */
180 OFP_ASSERT(sizeof(struct ofp_switch_config
) == 4);
183 /* Common flags to indicate behavior of the physical port. These flags are
184 * used in ofp_port to describe the current configuration. They are used in
185 * the ofp_port_mod message to configure the port's behavior.
187 enum ofp_port_config
{
188 OFPPC_PORT_DOWN
= 1 << 0, /* Port is administratively down. */
190 OFPPC_NO_RECV
= 1 << 2, /* Drop all packets received by port. */
191 OFPPC_NO_FWD
= 1 << 5, /* Drop packets forwarded to port. */
192 OFPPC_NO_PACKET_IN
= 1 << 6 /* Do not send packet-in msgs for port. */
195 /* Common current state of the physical port. These are not configurable from
198 enum ofp_port_state
{
199 OFPPS_LINK_DOWN
= 1 << 0, /* No physical link present. */
202 /* Common features of physical ports available in a datapath. */
203 enum ofp_port_features
{
204 OFPPF_10MB_HD
= 1 << 0, /* 10 Mb half-duplex rate support. */
205 OFPPF_10MB_FD
= 1 << 1, /* 10 Mb full-duplex rate support. */
206 OFPPF_100MB_HD
= 1 << 2, /* 100 Mb half-duplex rate support. */
207 OFPPF_100MB_FD
= 1 << 3, /* 100 Mb full-duplex rate support. */
208 OFPPF_1GB_HD
= 1 << 4, /* 1 Gb half-duplex rate support. */
209 OFPPF_1GB_FD
= 1 << 5, /* 1 Gb full-duplex rate support. */
210 OFPPF_10GB_FD
= 1 << 6, /* 10 Gb full-duplex rate support. */
213 /* Generic OpenFlow property header, as used by various messages in OF1.3+, and
214 * especially in OF1.4.
216 * The OpenFlow specs prefer to define a new structure with a specialized name
217 * each time this property structure comes up: struct
218 * ofp_port_desc_prop_header, struct ofp_controller_status_prop_header, struct
219 * ofp_table_mod_prop_header, and more. They're all the same, so it's easier
222 struct ofp_prop_header
{
226 * - 'len - 4' bytes of payload.
227 * - PAD_SIZE(len, 8) bytes of zeros. */
229 OFP_ASSERT(sizeof(struct ofp_prop_header
) == 4);
231 /* Generic OpenFlow experimenter property header.
233 * Again the OpenFlow specs define this over and over again and it's easier to
235 struct ofp_prop_experimenter
{
236 ovs_be16 type
; /* Generally 0xffff (in one case 0xfffe). */
237 ovs_be16 len
; /* Length in bytes of this property. */
238 ovs_be32 experimenter
; /* Experimenter ID which takes the same form as
239 * in struct ofp_experimenter_header. */
240 ovs_be32 exp_type
; /* Experimenter defined. */
242 * - 'len - 12' bytes of payload.
243 * - PAD_SIZE(len, 8) bytes of zeros. */
245 OFP_ASSERT(sizeof(struct ofp_prop_experimenter
) == 12);
247 /* Switch features. */
248 struct ofp_switch_features
{
249 ovs_be64 datapath_id
; /* Datapath unique ID. The lower 48-bits are for
250 a MAC address, while the upper 16-bits are
251 implementer-defined. */
253 ovs_be32 n_buffers
; /* Max packets buffered at once. */
255 uint8_t n_tables
; /* Number of tables supported by datapath. */
256 uint8_t auxiliary_id
; /* OF 1.3: Identify auxiliary connections */
257 uint8_t pad
[2]; /* Align to 64-bits. */
260 ovs_be32 capabilities
; /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
261 ovs_be32 actions
; /* Bitmap of supported "ofp_action_type"s.
262 * DEPRECATED in OpenFlow 1.1 */
264 /* Followed by an array of struct ofp10_phy_port or struct ofp11_port
265 * structures. The number is inferred from header.length.
266 * REMOVED in OpenFlow 1.3 */
268 OFP_ASSERT(sizeof(struct ofp_switch_features
) == 24);
270 /* Common capabilities supported by the datapath (struct ofp_switch_features,
271 * member capabilities). */
272 enum ofp_capabilities
{
273 OFPC_FLOW_STATS
= 1 << 0, /* Flow statistics. */
274 OFPC_TABLE_STATS
= 1 << 1, /* Table statistics. */
275 OFPC_PORT_STATS
= 1 << 2, /* Port statistics. */
276 OFPC_IP_REASM
= 1 << 5, /* Can reassemble IP fragments. */
277 OFPC_QUEUE_STATS
= 1 << 6, /* Queue statistics. */
278 OFPC_ARP_MATCH_IP
= 1 << 7 /* Match IP addresses in ARP
282 /* Why is this packet being sent to the controller? */
283 enum ofp_packet_in_reason
{
284 /* Standard reasons. */
285 OFPR_NO_MATCH
, /* No matching flow. */
286 OFPR_ACTION
, /* Action explicitly output to controller. */
287 OFPR_INVALID_TTL
, /* Packet has invalid TTL. */
288 OFPR_ACTION_SET
, /* Output to controller in action set */
289 OFPR_GROUP
, /* Output to controller in group bucket */
290 OFPR_PACKET_OUT
, /* Output to controller in packet-out */
292 #define OFPR10_BITS \
293 ((1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION) | (1u << OFPR_INVALID_TTL))
295 /* From OF1.4+, OFPR_ACTION is split into four more descriptive reasons,
296 * OFPR_APPLY_ACTION, OFPR_ACTION_SET, OFPR_GROUP, and OFPR_PACKET_OUT.
297 * OFPR_APPLY_ACTION shares the same number as OFPR_ACTION. */
298 #define OFPR14_ACTION_BITS \
299 ((1u << OFPR_ACTION_SET) | (1u << OFPR_GROUP) | (1u << OFPR_PACKET_OUT))
300 #define OFPR14_BITS \
301 (OFPR10_BITS | OFPR14_ACTION_BITS)
303 /* Nonstandard reason--not exposed via OpenFlow. */
310 enum ofp_flow_mod_command
{
311 OFPFC_ADD
, /* New flow. */
312 OFPFC_MODIFY
, /* Modify all matching flows. */
313 OFPFC_MODIFY_STRICT
, /* Modify entry strictly matching wildcards */
314 OFPFC_DELETE
, /* Delete all matching flows. */
315 OFPFC_DELETE_STRICT
/* Strictly match wildcards and priority. */
318 enum ofp_flow_mod_flags
{
319 OFPFF_SEND_FLOW_REM
= 1 << 0, /* Send flow removed message when flow
320 * expires or is deleted. */
321 OFPFF_CHECK_OVERLAP
= 1 << 1, /* Check for overlapping entries first. */
324 /* Why was this flow removed? */
325 enum ofp_flow_removed_reason
{
326 OFPRR_IDLE_TIMEOUT
, /* Flow idle time exceeded idle_timeout. */
327 OFPRR_HARD_TIMEOUT
, /* Time exceeded hard_timeout. */
328 OFPRR_DELETE
, /* Evicted by a DELETE flow mod. */
329 OFPRR_GROUP_DELETE
, /* Group was removed. */
330 OFPRR_METER_DELETE
, /* Meter was removed. */
331 OFPRR_EVICTION
, /* Switch eviction to free resources. */
333 #define OFPRR10_BITS \
334 ((1u << OFPRR_IDLE_TIMEOUT) | \
335 (1u << OFPRR_HARD_TIMEOUT) | \
336 (1u << OFPRR_DELETE))
337 #define OFPRR14_BITS \
339 (1u << OFPRR_GROUP_DELETE) | \
340 (1u << OFPRR_METER_DELETE) | \
341 (1u << OFPRR_EVICTION))
343 OVS_OFPRR_NONE
/* OVS internal_use only, keep last!. */
346 /* What changed about the physical port */
347 enum ofp_port_reason
{
348 OFPPR_ADD
, /* The port was added. */
349 OFPPR_DELETE
, /* The port was removed. */
350 OFPPR_MODIFY
, /* Some attribute of the port has changed. */
352 #define OFPPR_BITS ((1u << OFPPR_ADD) | \
353 (1u << OFPPR_DELETE) | \
354 (1u << OFPPR_MODIFY))
356 OFPPR_N_REASONS
/* Denotes number of reasons. */
359 /* A physical port has changed in the datapath */
360 struct ofp_port_status
{
361 uint8_t reason
; /* One of OFPPR_*. */
362 uint8_t pad
[7]; /* Align to 64-bits. */
363 /* Followed by struct ofp10_phy_port, struct ofp11_port, or struct
366 OFP_ASSERT(sizeof(struct ofp_port_status
) == 8);
368 enum ofp_stats_reply_flags
{
369 OFPSF_REPLY_MORE
= 1 << 0 /* More replies to follow. */
372 #define DESC_STR_LEN 256
373 #define SERIAL_NUM_LEN 32
374 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated ASCII
376 struct ofp_desc_stats
{
377 char mfr_desc
[DESC_STR_LEN
]; /* Manufacturer description. */
378 char hw_desc
[DESC_STR_LEN
]; /* Hardware description. */
379 char sw_desc
[DESC_STR_LEN
]; /* Software description. */
380 char serial_num
[SERIAL_NUM_LEN
]; /* Serial number. */
381 char dp_desc
[DESC_STR_LEN
]; /* Human readable description of
384 OFP_ASSERT(sizeof(struct ofp_desc_stats
) == 1056);
386 /* Reply to OFPST_AGGREGATE request. */
387 struct ofp_aggregate_stats_reply
{
388 ovs_32aligned_be64 packet_count
; /* Number of packets in flows. */
389 ovs_32aligned_be64 byte_count
; /* Number of bytes in flows. */
390 ovs_be32 flow_count
; /* Number of flows. */
391 uint8_t pad
[4]; /* Align to 64 bits. */
393 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply
) == 24);
395 /* The match type indicates the match structure (set of fields that compose the
396 * match) in use. The match type is placed in the type field at the beginning
397 * of all match structures. The "OpenFlow Extensible Match" type corresponds
398 * to OXM TLV format described below and must be supported by all OpenFlow
399 * switches. Extensions that define other match types may be published on the
400 * ONF wiki. Support for extensions is optional.
402 enum ofp_match_type
{
403 OFPMT_STANDARD
= 0, /* The match fields defined in the ofp11_match
405 OFPMT_OXM
= 1, /* OpenFlow Extensible Match */
408 /* Group numbering. Groups can use any number up to OFPG_MAX. */
410 /* Last usable group number. */
411 OFPG_MAX
= 0xffffff00,
414 OFPG_ALL
= 0xfffffffc, /* All groups, for group delete commands. */
415 OFPG_ANY
= 0xffffffff /* Wildcard, for flow stats requests. */
418 /* Group configuration flags */
419 enum ofp_group_capabilities
{
420 OFPGFC_SELECT_WEIGHT
= 1 << 0, /* Support weight for select groups */
421 OFPGFC_SELECT_LIVENESS
= 1 << 1, /* Support liveness for select groups */
422 OFPGFC_CHAINING
= 1 << 2, /* Support chaining groups */
423 OFPGFC_CHAINING_CHECKS
= 1 << 3, /* Check chaining for loops and delete */
426 enum ofp_hello_elem_type
{
427 OFPHET_VERSIONBITMAP
= 1, /* Bitmap of version supported. */
430 /* Common header for all Hello Elements */
431 struct ofp_hello_elem_header
{
432 ovs_be16 type
; /* One of OFPHET_*. */
433 ovs_be16 length
; /* Length in bytes of this element. */
435 OFP_ASSERT(sizeof(struct ofp_hello_elem_header
) == 4);
437 /* Table numbering. Tables can use any number up to OFPT_MAX. */
439 /* Last usable table number. */
443 OFPTT_ALL
= 0xff /* Wildcard table used for table config,
444 flow stats and flow deletes. */
447 enum ofp_table_config
{
448 /* OpenFlow 1.1 and 1.2 defined this field as shown.
449 * OpenFlow 1.3 and later mark this field as deprecated, but have not
450 * reused it for any new purpose. */
451 OFPTC11_TABLE_MISS_CONTROLLER
= 0 << 0, /* Send to controller. */
452 OFPTC11_TABLE_MISS_CONTINUE
= 1 << 0, /* Go to next table, like OF1.0. */
453 OFPTC11_TABLE_MISS_DROP
= 2 << 0, /* Drop the packet. */
454 OFPTC11_TABLE_MISS_MASK
= 3 << 0,
457 OFPTC14_EVICTION
= 1 << 2, /* Allow table to evict flows. */
458 OFPTC14_VACANCY_EVENTS
= 1 << 3, /* Enable vacancy events. */
461 #endif /* openflow/openflow-common.h */