ofproto: Allow the use of the OpenFlow 1.4 protocol
[sliver-openvswitch.git] / include / openflow / openflow-common.h
1 /* Copyright (c) 2008, 2011, 2012, 2013, 2014 The Board of Trustees of The Leland Stanford
2  * Junior University
3  *
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:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
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
27  * SOFTWARE.
28  *
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.
32  */
33
34 /*
35  * Copyright (c) 2008-2014 Nicira, Inc.
36  *
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:
40  *
41  *     http://www.apache.org/licenses/LICENSE-2.0
42  *
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.
48  */
49
50 #ifndef OPENFLOW_COMMON_H
51 #define OPENFLOW_COMMON_H 1
52
53 #include "openvswitch/types.h"
54
55 #ifdef SWIG
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 */
66
67 /* Version number:
68  * Non-experimental versions released: 0x01 0x02
69  * Experimental versions released: 0x81 -- 0x99
70  */
71 /* The most significant bit being set in the version field indicates an
72  * experimental OpenFlow version.
73  */
74 enum ofp_version {
75     OFP10_VERSION = 0x01,
76     OFP11_VERSION = 0x02,
77     OFP12_VERSION = 0x03,
78     OFP13_VERSION = 0x04,
79     OFP14_VERSION = 0x05
80
81     /* When we add real support for these versions, add them to the enum so
82      * that we get compiler warnings everywhere we might forget to provide
83      * support.  Until then, keep them as macros to avoid those warnings. */
84 #define OFP15_VERSION 0x06
85 };
86
87 /* Vendor (aka experimenter) IDs.
88  *
89  * These are used in various places in OpenFlow to identify an extension
90  * defined by some vendor, as opposed to a standardized part of the core
91  * OpenFlow protocol.
92  *
93  * Vendor IDs whose top 8 bits are 0 hold an Ethernet OUI in their low 24 bits.
94  * The Open Networking Foundation assigns vendor IDs whose top 8 bits are
95  * nonzero.
96  *
97  * A few vendor IDs are special:
98  *
99  *    - OF_VENDOR_ID is not a real vendor ID and does not appear in the
100  *      OpenFlow protocol itself.  It can occasionally be useful within Open
101  *      vSwitch to identify a standardized part of OpenFlow.
102  *
103  *    - ONF_VENDOR_ID is being used within the ONF "extensibility" working
104  *      group to identify extensions being proposed for standardization.
105  */
106 #define OF_VENDOR_ID    0
107 #define NX_VENDOR_ID    0x00002320 /* Nicira. */
108 #define ONF_VENDOR_ID   0x4f4e4600 /* Open Networking Foundation. */
109
110 #define OFP_MAX_TABLE_NAME_LEN 32
111 #define OFP_MAX_PORT_NAME_LEN  16
112
113 #define OFP_OLD_PORT  6633
114 #define OFP_PORT  6653
115
116 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
117
118 #define OFP_DEFAULT_MISS_SEND_LEN   128
119
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.
123  */
124 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
125
126 /* Value of dl_type to indicate that the frame does not include an
127  * Ethernet type.
128  */
129 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
130
131 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
132  * is permanent. */
133 #define OFP_FLOW_PERMANENT 0
134
135 /* By default, choose a priority in the middle. */
136 #define OFP_DEFAULT_PRIORITY 0x8000
137
138
139 /* Header on all OpenFlow packets. */
140 struct ofp_header {
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. */
147 };
148 OFP_ASSERT(sizeof(struct ofp_header) == 8);
149
150 /* OFPT_ERROR: Error message (datapath -> controller). */
151 struct ofp_error_msg {
152     ovs_be16 type;
153     ovs_be16 code;
154     uint8_t data[0];          /* Variable-length data.  Interpreted based
155                                  on the type and code. */
156 };
157 OFP_ASSERT(sizeof(struct ofp_error_msg) == 4);
158
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. */
165     OFPC_FRAG_MASK     = 3,
166
167     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OpenFlow 1.3 */
168
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. */
172 };
173
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. */
179 };
180 OFP_ASSERT(sizeof(struct ofp_switch_config) == 4);
181
182
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.
186  */
187 enum ofp_port_config {
188     OFPPC_PORT_DOWN    = 1 << 0,  /* Port is administratively down. */
189
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. */
193 };
194
195 /* Common current state of the physical port.  These are not configurable from
196  * the controller.
197  */
198 enum ofp_port_state {
199     OFPPS_LINK_DOWN    = 1 << 0,  /* No physical link present. */
200 };
201
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. */
211 };
212
213 enum ofp_queue_properties {
214     OFPQT_MIN_RATE = 1,          /* Minimum datarate guaranteed. */
215     OFPQT_MAX_RATE = 2,          /* Maximum guaranteed rate. */
216     OFPQT_EXPERIMENTER = 0xffff, /* Experimenter defined property. */
217 };
218
219 /* Common description for a queue. */
220 struct ofp_queue_prop_header {
221     ovs_be16 property; /* One of OFPQT_. */
222     ovs_be16 len;      /* Length of property, including this header. */
223     uint8_t pad[4];    /* 64-bit alignemnt. */
224 };
225 OFP_ASSERT(sizeof(struct ofp_queue_prop_header) == 8);
226
227 /* Min-Rate and Max-Rate queue property description (OFPQT_MIN and
228  * OFPQT_MAX). */
229 struct ofp_queue_prop_rate {
230     struct ofp_queue_prop_header prop_header;
231     ovs_be16 rate;        /* In 1/10 of a percent; >1000 -> disabled. */
232     uint8_t pad[6];       /* 64-bit alignment */
233 };
234 OFP_ASSERT(sizeof(struct ofp_queue_prop_rate) == 16);
235
236 /* Switch features. */
237 struct ofp_switch_features {
238     ovs_be64 datapath_id;   /* Datapath unique ID.  The lower 48-bits are for
239                                a MAC address, while the upper 16-bits are
240                                implementer-defined. */
241
242     ovs_be32 n_buffers;     /* Max packets buffered at once. */
243
244     uint8_t n_tables;       /* Number of tables supported by datapath. */
245     uint8_t auxiliary_id;   /* OF 1.3: Identify auxiliary connections */
246     uint8_t pad[2];         /* Align to 64-bits. */
247
248     /* Features. */
249     ovs_be32 capabilities;  /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
250     ovs_be32 actions;       /* Bitmap of supported "ofp_action_type"s.
251                              * DEPRECATED in OpenFlow 1.1 */
252
253     /* Followed by an array of struct ofp10_phy_port or struct ofp11_port
254      * structures.  The number is inferred from header.length.
255      * REMOVED in OpenFlow 1.3 */
256 };
257 OFP_ASSERT(sizeof(struct ofp_switch_features) == 24);
258
259 /* Common capabilities supported by the datapath (struct ofp_switch_features,
260  * member capabilities). */
261 enum ofp_capabilities {
262     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
263     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
264     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
265     OFPC_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
266     OFPC_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
267     OFPC_ARP_MATCH_IP   = 1 << 7   /* Match IP addresses in ARP
268                                       pkts. */
269 };
270
271 /* Why is this packet being sent to the controller? */
272 enum ofp_packet_in_reason {
273     OFPR_NO_MATCH,          /* No matching flow. */
274     OFPR_ACTION,            /* Action explicitly output to controller. */
275     OFPR_INVALID_TTL        /* Packet has invalid TTL. */,
276     OFPR_N_REASONS
277 };
278
279 enum ofp_flow_mod_command {
280     OFPFC_ADD,              /* New flow. */
281     OFPFC_MODIFY,           /* Modify all matching flows. */
282     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
283     OFPFC_DELETE,           /* Delete all matching flows. */
284     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
285 };
286
287 enum ofp_flow_mod_flags {
288     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
289                                     * expires or is deleted. */
290     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
291 };
292
293 /* Action header for OFPAT10_VENDOR and OFPAT11_EXPERIMEMNTER.
294  * The rest of the body is vendor-defined. */
295 struct ofp_action_vendor_header {
296     ovs_be16 type;                  /* OFPAT10_VENDOR. */
297     ovs_be16 len;                   /* Length is a multiple of 8. */
298     ovs_be32 vendor;                /* Vendor ID, which takes the same form
299                                        as in "struct ofp_vendor_header". */
300 };
301 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
302
303 /* Action header that is common to all actions.  The length includes the
304  * header and any padding used to make the action 64-bit aligned.
305  * NB: The length of an action *must* always be a multiple of eight. */
306 struct ofp_action_header {
307     ovs_be16 type;                  /* One of OFPAT*. */
308     ovs_be16 len;                   /* Length of action, including this
309                                        header.  This is the length of action,
310                                        including any padding to make it
311                                        64-bit aligned. */
312     uint8_t pad[4];
313 };
314 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
315
316 /* Action structure for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
317 struct ofp_action_vlan_vid {
318     ovs_be16 type;                  /* Type. */
319     ovs_be16 len;                   /* Length is 8. */
320     ovs_be16 vlan_vid;              /* VLAN id. */
321     uint8_t pad[2];
322 };
323 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
324
325 /* Action structure for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
326 struct ofp_action_vlan_pcp {
327     ovs_be16 type;                  /* Type. */
328     ovs_be16 len;                   /* Length is 8. */
329     uint8_t vlan_pcp;               /* VLAN priority. */
330     uint8_t pad[3];
331 };
332 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
333
334 /* Action structure for OFPAT10_SET_DL_SRC/DST and OFPAT11_SET_DL_SRC/DST. */
335 struct ofp_action_dl_addr {
336     ovs_be16 type;                  /* Type. */
337     ovs_be16 len;                   /* Length is 16. */
338     uint8_t dl_addr[OFP_ETH_ALEN];  /* Ethernet address. */
339     uint8_t pad[6];
340 };
341 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
342
343 /* Action structure for OFPAT10_SET_NW_SRC/DST and OFPAT11_SET_NW_SRC/DST. */
344 struct ofp_action_nw_addr {
345     ovs_be16 type;                  /* Type. */
346     ovs_be16 len;                   /* Length is 8. */
347     ovs_be32 nw_addr;               /* IP address. */
348 };
349 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
350
351 /* Action structure for OFPAT10_SET_NW_TOS and OFPAT11_SET_NW_TOS. */
352 struct ofp_action_nw_tos {
353     ovs_be16 type;                  /* Type.. */
354     ovs_be16 len;                   /* Length is 8. */
355     uint8_t nw_tos;                 /* DSCP in high 6 bits, rest ignored. */
356     uint8_t pad[3];
357 };
358 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
359
360 /* Action structure for OFPAT10_SET_TP_SRC/DST and OFPAT11_SET_TP_SRC/DST. */
361 struct ofp_action_tp_port {
362     ovs_be16 type;                  /* Type. */
363     ovs_be16 len;                   /* Length is 8. */
364     ovs_be16 tp_port;               /* TCP/UDP port. */
365     uint8_t pad[2];
366 };
367 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
368
369 /* Why was this flow removed? */
370 enum ofp_flow_removed_reason {
371     OFPRR_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
372     OFPRR_HARD_TIMEOUT,         /* Time exceeded hard_timeout. */
373     OFPRR_DELETE,               /* Evicted by a DELETE flow mod. */
374     OFPRR_GROUP_DELETE,         /* Group was removed. */
375     OFPRR_METER_DELETE,         /* Meter was removed. */
376     OFPRR_EVICTION,             /* Switch eviction to free resources. */
377 };
378
379 /* What changed about the physical port */
380 enum ofp_port_reason {
381     OFPPR_ADD,              /* The port was added. */
382     OFPPR_DELETE,           /* The port was removed. */
383     OFPPR_MODIFY            /* Some attribute of the port has changed. */
384 };
385
386 /* A physical port has changed in the datapath */
387 struct ofp_port_status {
388     uint8_t reason;          /* One of OFPPR_*. */
389     uint8_t pad[7];          /* Align to 64-bits. */
390     /* Followed by struct ofp10_phy_port or struct ofp11_port.  */
391 };
392 OFP_ASSERT(sizeof(struct ofp_port_status) == 8);
393
394 enum ofp_stats_reply_flags {
395     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
396 };
397
398 #define DESC_STR_LEN   256
399 #define SERIAL_NUM_LEN 32
400 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated ASCII
401  * string. */
402 struct ofp_desc_stats {
403     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
404     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
405     char sw_desc[DESC_STR_LEN];        /* Software description. */
406     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
407     char dp_desc[DESC_STR_LEN];        /* Human readable description of
408                                           the datapath. */
409 };
410 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
411
412 /* Reply to OFPST_AGGREGATE request. */
413 struct ofp_aggregate_stats_reply {
414     ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
415     ovs_32aligned_be64 byte_count;   /* Number of bytes in flows. */
416     ovs_be32 flow_count;      /* Number of flows. */
417     uint8_t pad[4];           /* Align to 64 bits. */
418 };
419 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
420
421 /* The match type indicates the match structure (set of fields that compose the
422  * match) in use. The match type is placed in the type field at the beginning
423  * of all match structures. The "OpenFlow Extensible Match" type corresponds
424  * to OXM TLV format described below and must be supported by all OpenFlow
425  * switches. Extensions that define other match types may be published on the
426  * ONF wiki. Support for extensions is optional.
427  */
428 enum ofp_match_type {
429     OFPMT_STANDARD = 0,         /* The match fields defined in the ofp11_match
430                                    structure apply */
431     OFPMT_OXM = 1,              /* OpenFlow Extensible Match */
432 };
433
434 /* Group numbering. Groups can use any number up to OFPG_MAX. */
435 enum ofp_group {
436     /* Last usable group number. */
437     OFPG_MAX        = 0xffffff00,
438
439     /* Fake groups. */
440     OFPG_ALL        = 0xfffffffc,  /* All groups, for group delete commands. */
441     OFPG_ANY        = 0xffffffff   /* Wildcard, for flow stats requests. */
442 };
443
444 /* Group configuration flags */
445 enum ofp_group_capabilities {
446     OFPGFC_SELECT_WEIGHT   = 1 << 0, /* Support weight for select groups */
447     OFPGFC_SELECT_LIVENESS = 1 << 1, /* Support liveness for select groups */
448     OFPGFC_CHAINING        = 1 << 2, /* Support chaining groups */
449     OFPGFC_CHAINING_CHECKS = 1 << 3, /* Check chaining for loops and delete */
450 };
451
452 enum ofp_hello_elem_type {
453     OFPHET_VERSIONBITMAP          = 1, /* Bitmap of version supported. */
454 };
455
456 /* Common header for all Hello Elements */
457 struct ofp_hello_elem_header {
458     ovs_be16    type;        /* One of OFPHET_*. */
459     ovs_be16    length;      /* Length in bytes of this element. */
460 };
461 OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
462
463 /* Vendor extension. */
464 struct ofp_vendor_header {
465     struct ofp_header header;   /* Type OFPT_VENDOR or OFPT_EXPERIMENTER. */
466     ovs_be32 vendor;            /* Vendor ID:
467                                  * - MSB 0: low-order bytes are IEEE OUI.
468                                  * - MSB != 0: defined by OpenFlow
469                                  *   consortium. */
470     /* Vendor-defined arbitrary additional data. */
471 };
472 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
473
474 /* Table numbering. Tables can use any number up to OFPT_MAX. */
475 enum ofp_table {
476     /* Last usable table number. */
477     OFPTT_MAX = 0xfe,
478
479     /* Fake tables. */
480     OFPTT_ALL = 0xff         /* Wildcard table used for table config,
481                                 flow stats and flow deletes. */
482 };
483
484 enum ofp_table_config {
485     /* OpenFlow 1.1 and 1.2 defined this field as shown.
486      * OpenFlow 1.3 and later mark this field as deprecated, but have not
487      * reused it for any new purpose. */
488     OFPTC11_TABLE_MISS_CONTROLLER = 0 << 0, /* Send to controller. */
489     OFPTC11_TABLE_MISS_CONTINUE   = 1 << 0, /* Go to next table, like OF1.0. */
490     OFPTC11_TABLE_MISS_DROP       = 2 << 0, /* Drop the packet. */
491     OFPTC11_TABLE_MISS_MASK       = 3 << 0,
492
493     /* OpenFlow 1.4. */
494     OFPTC14_EVICTION              = 1 << 2, /* Allow table to evict flows. */
495     OFPTC14_VACANCY_EVENTS        = 1 << 3, /* Enable vacancy events. */
496 };
497
498 #endif /* openflow/openflow-common.h */