1 /* Copyright (c) 2008, 2011, 2012, 2013 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, 2009, 2010, 2011, 2012 Nicira, Inc.
36 * Copyright (c) 2012 Horms Solutions Ltd.
38 * Licensed under the Apache License, Version 2.0 (the "License");
39 * you may not use this file except in compliance with the License.
40 * You may obtain a copy of the License at:
42 * http://www.apache.org/licenses/LICENSE-2.0
44 * Unless required by applicable law or agreed to in writing, software
45 * distributed under the License is distributed on an "AS IS" BASIS,
46 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
47 * See the License for the specific language governing permissions and
48 * limitations under the License.
51 /* OpenFlow: protocol between controller and datapath. */
54 #define OPENFLOW_12_H 1
56 #include "openflow/openflow-1.1.h"
58 /* Error type for experimenter error messages. */
59 #define OFPET12_EXPERIMENTER 0xffff
63 * The high order bit differentiate reserved classes from member classes.
64 * Classes 0x0000 to 0x7FFF are member classes, allocated by ONF.
65 * Classes 0x8000 to 0xFFFE are reserved classes, reserved for standardisation.
67 enum ofp12_oxm_class {
68 OFPXMC12_NXM_0 = 0x0000, /* Backward compatibility with NXM */
69 OFPXMC12_NXM_1 = 0x0001, /* Backward compatibility with NXM */
70 OFPXMC12_OPENFLOW_BASIC = 0x8000, /* Basic class for OpenFlow */
71 OFPXMC12_EXPERIMENTER = 0xffff, /* Experimenter class */
74 /* OXM Flow match field types for OpenFlow basic class. */
75 enum oxm12_ofb_match_fields {
76 OFPXMT12_OFB_IN_PORT, /* Switch input port. */
77 OFPXMT12_OFB_IN_PHY_PORT, /* Switch physical input port. */
78 OFPXMT12_OFB_METADATA, /* Metadata passed between tables. */
79 OFPXMT12_OFB_ETH_DST, /* Ethernet destination address. */
80 OFPXMT12_OFB_ETH_SRC, /* Ethernet source address. */
81 OFPXMT12_OFB_ETH_TYPE, /* Ethernet frame type. */
82 OFPXMT12_OFB_VLAN_VID, /* VLAN id. */
83 OFPXMT12_OFB_VLAN_PCP, /* VLAN priority. */
84 OFPXMT12_OFB_IP_DSCP, /* IP DSCP (6 bits in ToS field). */
85 OFPXMT12_OFB_IP_ECN, /* IP ECN (2 bits in ToS field). */
86 OFPXMT12_OFB_IP_PROTO, /* IP protocol. */
87 OFPXMT12_OFB_IPV4_SRC, /* IPv4 source address. */
88 OFPXMT12_OFB_IPV4_DST, /* IPv4 destination address. */
89 OFPXMT12_OFB_TCP_SRC, /* TCP source port. */
90 OFPXMT12_OFB_TCP_DST, /* TCP destination port. */
91 OFPXMT12_OFB_UDP_SRC, /* UDP source port. */
92 OFPXMT12_OFB_UDP_DST, /* UDP destination port. */
93 OFPXMT12_OFB_SCTP_SRC, /* SCTP source port. */
94 OFPXMT12_OFB_SCTP_DST, /* SCTP destination port. */
95 OFPXMT12_OFB_ICMPV4_TYPE, /* ICMP type. */
96 OFPXMT12_OFB_ICMPV4_CODE, /* ICMP code. */
97 OFPXMT12_OFB_ARP_OP, /* ARP opcode. */
98 OFPXMT12_OFB_ARP_SPA, /* ARP source IPv4 address. */
99 OFPXMT12_OFB_ARP_TPA, /* ARP target IPv4 address. */
100 OFPXMT12_OFB_ARP_SHA, /* ARP source hardware address. */
101 OFPXMT12_OFB_ARP_THA, /* ARP target hardware address. */
102 OFPXMT12_OFB_IPV6_SRC, /* IPv6 source address. */
103 OFPXMT12_OFB_IPV6_DST, /* IPv6 destination address. */
104 OFPXMT12_OFB_IPV6_FLABEL, /* IPv6 Flow Label */
105 OFPXMT12_OFB_ICMPV6_TYPE, /* ICMPv6 type. */
106 OFPXMT12_OFB_ICMPV6_CODE, /* ICMPv6 code. */
107 OFPXMT12_OFB_IPV6_ND_TARGET, /* Target address for ND. */
108 OFPXMT12_OFB_IPV6_ND_SLL, /* Source link-layer for ND. */
109 OFPXMT12_OFB_IPV6_ND_TLL, /* Target link-layer for ND. */
110 OFPXMT12_OFB_MPLS_LABEL, /* MPLS label. */
111 OFPXMT12_OFB_MPLS_TC, /* MPLS TC. */
112 /* Following added in OpenFlow 1.3 */
113 OFPXMT12_OFB_MPLS_BOS, /* MPLS BoS bit. */
114 OFPXMT12_OFB_PBB_ISID, /* PBB I-SID. */
115 OFPXMT12_OFB_TUNNEL_ID, /* Logical Port Metadata */
116 OFPXMT12_OFB_IPV6_EXTHDR, /* IPv6 Extension Header pseudo-field */
122 #define OFPXMT12_MASK ((1ULL << OFPXMT12_OFB_MAX) - 1)
124 /* OXM implementation makes use of NXM as they are the same format
125 * with different field definitions
128 #define OXM_HEADER(FIELD, LENGTH) \
129 NXM_HEADER(OFPXMC12_OPENFLOW_BASIC, FIELD, LENGTH)
130 #define OXM_HEADER_W(FIELD, LENGTH) \
131 NXM_HEADER_W(OFPXMC12_OPENFLOW_BASIC, FIELD, LENGTH)
133 #define IS_OXM_HEADER(header) (NXM_VENDOR(header) == OFPXMC12_OPENFLOW_BASIC)
135 #define OXM_OF_IN_PORT OXM_HEADER (OFPXMT12_OFB_IN_PORT, 4)
136 #define OXM_OF_IN_PHY_PORT OXM_HEADER (OFPXMT12_OFB_IN_PHY_PORT, 4)
137 #define OXM_OF_METADATA OXM_HEADER (OFPXMT12_OFB_METADATA, 8)
138 #define OXM_OF_ETH_DST OXM_HEADER (OFPXMT12_OFB_ETH_DST, 6)
139 #define OXM_OF_ETH_DST_W OXM_HEADER_W (OFPXMT12_OFB_ETH_DST, 6)
140 #define OXM_OF_ETH_SRC OXM_HEADER (OFPXMT12_OFB_ETH_SRC, 6)
141 #define OXM_OF_ETH_SRC_W OXM_HEADER_W (OFPXMT12_OFB_ETH_SRC, 6)
142 #define OXM_OF_ETH_TYPE OXM_HEADER (OFPXMT12_OFB_ETH_TYPE, 2)
143 #define OXM_OF_VLAN_VID OXM_HEADER (OFPXMT12_OFB_VLAN_VID, 2)
144 #define OXM_OF_VLAN_VID_W OXM_HEADER_W (OFPXMT12_OFB_VLAN_VID, 2)
145 #define OXM_OF_VLAN_PCP OXM_HEADER (OFPXMT12_OFB_VLAN_PCP, 1)
146 #define OXM_OF_IP_DSCP OXM_HEADER (OFPXMT12_OFB_IP_DSCP, 1)
147 #define OXM_OF_IP_ECN OXM_HEADER (OFPXMT12_OFB_IP_ECN, 1)
148 #define OXM_OF_IP_PROTO OXM_HEADER (OFPXMT12_OFB_IP_PROTO, 1)
149 #define OXM_OF_IPV4_SRC OXM_HEADER (OFPXMT12_OFB_IPV4_SRC, 4)
150 #define OXM_OF_IPV4_SRC_W OXM_HEADER_W (OFPXMT12_OFB_IPV4_SRC, 4)
151 #define OXM_OF_IPV4_DST OXM_HEADER (OFPXMT12_OFB_IPV4_DST, 4)
152 #define OXM_OF_IPV4_DST_W OXM_HEADER_W (OFPXMT12_OFB_IPV4_DST, 4)
153 #define OXM_OF_TCP_SRC OXM_HEADER (OFPXMT12_OFB_TCP_SRC, 2)
154 #define OXM_OF_TCP_DST OXM_HEADER (OFPXMT12_OFB_TCP_DST, 2)
155 #define OXM_OF_UDP_SRC OXM_HEADER (OFPXMT12_OFB_UDP_SRC, 2)
156 #define OXM_OF_UDP_DST OXM_HEADER (OFPXMT12_OFB_UDP_DST, 2)
157 #define OXM_OF_SCTP_SRC OXM_HEADER (OFPXMT12_OFB_SCTP_SRC, 2)
158 #define OXM_OF_SCTP_DST OXM_HEADER (OFPXMT12_OFB_SCTP_DST, 2)
159 #define OXM_OF_ICMPV4_TYPE OXM_HEADER (OFPXMT12_OFB_ICMPV4_TYPE, 1)
160 #define OXM_OF_ICMPV4_CODE OXM_HEADER (OFPXMT12_OFB_ICMPV4_CODE, 1)
161 #define OXM_OF_ARP_OP OXM_HEADER (OFPXMT12_OFB_ARP_OP, 2)
162 #define OXM_OF_ARP_SPA OXM_HEADER (OFPXMT12_OFB_ARP_SPA, 4)
163 #define OXM_OF_ARP_SPA_W OXM_HEADER_W (OFPXMT12_OFB_ARP_SPA, 4)
164 #define OXM_OF_ARP_TPA OXM_HEADER (OFPXMT12_OFB_ARP_TPA, 4)
165 #define OXM_OF_ARP_TPA_W OXM_HEADER_W (OFPXMT12_OFB_ARP_TPA, 4)
166 #define OXM_OF_ARP_SHA OXM_HEADER (OFPXMT12_OFB_ARP_SHA, 6)
167 #define OXM_OF_ARP_SHA_W OXM_HEADER_W (OFPXMT12_OFB_ARP_SHA, 6)
168 #define OXM_OF_ARP_THA OXM_HEADER (OFPXMT12_OFB_ARP_THA, 6)
169 #define OXM_OF_ARP_THA_W OXM_HEADER_W (OFPXMT12_OFB_ARP_THA, 6)
170 #define OXM_OF_IPV6_SRC OXM_HEADER (OFPXMT12_OFB_IPV6_SRC, 16)
171 #define OXM_OF_IPV6_SRC_W OXM_HEADER_W (OFPXMT12_OFB_IPV6_SRC, 16)
172 #define OXM_OF_IPV6_DST OXM_HEADER (OFPXMT12_OFB_IPV6_DST, 16)
173 #define OXM_OF_IPV6_DST_W OXM_HEADER_W (OFPXMT12_OFB_IPV6_DST, 16)
174 #define OXM_OF_IPV6_FLABEL OXM_HEADER (OFPXMT12_OFB_IPV6_FLABEL, 4)
175 #define OXM_OF_IPV6_FLABEL_W OXM_HEADER_W (OFPXMT12_OFB_IPV6_FLABEL, 4)
176 #define OXM_OF_ICMPV6_TYPE OXM_HEADER (OFPXMT12_OFB_ICMPV6_TYPE, 1)
177 #define OXM_OF_ICMPV6_CODE OXM_HEADER (OFPXMT12_OFB_ICMPV6_CODE, 1)
178 #define OXM_OF_IPV6_ND_TARGET OXM_HEADER (OFPXMT12_OFB_IPV6_ND_TARGET, 16)
179 #define OXM_OF_IPV6_ND_SLL OXM_HEADER (OFPXMT12_OFB_IPV6_ND_SLL, 6)
180 #define OXM_OF_IPV6_ND_TLL OXM_HEADER (OFPXMT12_OFB_IPV6_ND_TLL, 6)
181 #define OXM_OF_MPLS_LABEL OXM_HEADER (OFPXMT12_OFB_MPLS_LABEL, 4)
182 #define OXM_OF_MPLS_TC OXM_HEADER (OFPXMT12_OFB_MPLS_TC, 1)
183 #define OXM_OF_MPLS_BOS OXM_HEADER (OFPXMT12_OFB_MPLS_BOS, 1)
184 #define OXM_OF_PBB_ISID OXM_HEADER (OFPXMT12_OFB_PBB_ISID, 4)
185 #define OXM_OF_PBB_ISID_W OXM_HEADER_W (OFPXMT12_OFB_PBB_ISID, 4)
186 #define OXM_OF_TUNNEL_ID OXM_HEADER (OFPXMT12_OFB_TUNNEL_ID, 8)
187 #define OXM_OF_TUNNEL_ID_W OXM_HEADER_W (OFPXMT12_OFB_TUNNEL_ID, 8)
188 #define OXM_OF_IPV6_EXTHDR OXM_HEADER (OFPXMT12_OFB_IPV6_EXTHDR, 2)
189 #define OXM_OF_IPV6_EXTHDR_W OXM_HEADER_W (OFPXMT12_OFB_IPV6_EXTHDR, 2)
191 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
192 * special conditions.
195 OFPVID12_PRESENT = 0x1000, /* Bit that indicate that a VLAN id is set */
196 OFPVID12_NONE = 0x0000, /* No VLAN id was set. */
199 /* Bit definitions for IPv6 Extension Header pseudo-field. */
200 enum ofp12_ipv6exthdr_flags {
201 OFPIEH12_NONEXT = 1 << 0, /* "No next header" encountered. */
202 OFPIEH12_ESP = 1 << 1, /* Encrypted Sec Payload header present. */
203 OFPIEH12_AUTH = 1 << 2, /* Authentication header present. */
204 OFPIEH12_DEST = 1 << 3, /* 1 or 2 dest headers present. */
205 OFPIEH12_FRAG = 1 << 4, /* Fragment header present. */
206 OFPIEH12_ROUTER = 1 << 5, /* Router header present. */
207 OFPIEH12_HOP = 1 << 6, /* Hop-by-hop header present. */
208 OFPIEH12_UNREP = 1 << 7, /* Unexpected repeats encountered. */
209 OFPIEH12_UNSEQ = 1 << 8 /* Unexpected sequencing encountered. */
212 /* Header for OXM experimenter match fields. */
213 struct ofp12_oxm_experimenter_header {
214 ovs_be32 oxm_header; /* oxm_class = OFPXMC_EXPERIMENTER */
215 ovs_be32 experimenter; /* Experimenter ID which takes the same
216 form as in struct ofp11_experimenter_header. */
218 OFP_ASSERT(sizeof(struct ofp12_oxm_experimenter_header) == 8);
220 enum ofp12_action_type {
221 OFPAT12_SET_FIELD = 25, /* Set a header field using OXM TLV format. */
224 enum ofp12_controller_max_len {
225 OFPCML12_MAX = 0xffe5, /* maximum max_len value which can be used
226 * to request a specific byte length. */
227 OFPCML12_NO_BUFFER = 0xffff /* indicates that no buffering should be
228 * applied and the whole packet is to be
229 * sent to the controller. */
232 /* Action structure for OFPAT12_SET_FIELD. */
233 struct ofp12_action_set_field {
234 ovs_be16 type; /* OFPAT12_SET_FIELD. */
235 ovs_be16 len; /* Length is padded to 64 bits. */
236 ovs_be32 dst; /* OXM TLV header */
238 * - Exactly ((oxm_len + 4) + 7)/8*8 - (oxm_len + 4) (between 0 and 7)
239 * bytes of all-zero bytes
242 OFP_ASSERT(sizeof(struct ofp12_action_set_field) == 8);
244 /* OpenFlow 1.2 specific flags
245 * (struct ofp12_flow_mod, member flags). */
246 enum ofp12_flow_mod_flags {
247 OFPFF12_RESET_COUNTS = 1 << 2 /* Reset flow packet and byte counts. */
250 /* OpenFlow 1.2 specific capabilities
251 * (struct ofp_switch_features, member capabilities). */
252 enum ofp12_capabilities {
253 OFPC12_PORT_BLOCKED = 1 << 8 /* Switch will block looping ports. */
256 /* OpenFlow 1.2 specific types
257 * (struct ofp11_stats_request/reply, member type). */
258 enum ofp12_stats_types {
260 * The request body is empty.
261 * The reply body is struct ofp12_group_features_stats. */
262 OFPST12_GROUP_FEATURES = 8
265 /* OpenFlow 1.2 specific properties
266 * (struct ofp_queue_prop_header member property). */
267 enum ofp12_queue_properties {
268 OFPQT12_MIN_RATE = 1, /* Minimum datarate guaranteed. */
269 OFPQT12_MAX_RATE = 2, /* Maximum datarate. */
270 OFPQT12_EXPERIMENTER = 0xffff /* Experimenter defined property. */
273 /* Body of reply to OFPST_TABLE request. */
274 struct ofp12_table_stats {
275 uint8_t table_id; /* Identifier of table. Lower numbered tables
276 are consulted first. */
277 uint8_t pad[7]; /* Align to 64-bits. */
278 char name[OFP_MAX_TABLE_NAME_LEN];
279 ovs_be64 match; /* Bitmap of (1 << OFPXMT_*) that indicate the
280 fields the table can match on. */
281 ovs_be64 wildcards; /* Bitmap of (1 << OFPXMT_*) wildcards that are
282 supported by the table. */
283 ovs_be32 write_actions; /* Bitmap of OFPAT_* that are supported
284 by the table with OFPIT_WRITE_ACTIONS. */
285 ovs_be32 apply_actions; /* Bitmap of OFPAT_* that are supported
286 by the table with OFPIT_APPLY_ACTIONS. */
287 ovs_be64 write_setfields;/* Bitmap of (1 << OFPXMT_*) header fields that
288 can be set with OFPIT_WRITE_ACTIONS. */
289 ovs_be64 apply_setfields;/* Bitmap of (1 << OFPXMT_*) header fields that
290 can be set with OFPIT_APPLY_ACTIONS. */
291 ovs_be64 metadata_match; /* Bits of metadata table can match. */
292 ovs_be64 metadata_write; /* Bits of metadata table can write. */
293 ovs_be32 instructions; /* Bitmap of OFPIT_* values supported. */
294 ovs_be32 config; /* Bitmap of OFPTC_* values */
295 ovs_be32 max_entries; /* Max number of entries supported. */
296 ovs_be32 active_count; /* Number of active entries. */
297 ovs_be64 lookup_count; /* Number of packets looked up in table. */
298 ovs_be64 matched_count; /* Number of packets that hit table. */
300 OFP_ASSERT(sizeof(struct ofp12_table_stats) == 128);
302 /* Body of reply to OFPST12_GROUP_FEATURES request. Group features. */
303 struct ofp12_group_features_stats {
304 ovs_be32 types; /* Bitmap of OFPGT_* values supported. */
305 ovs_be32 capabilities; /* Bitmap of OFPGFC12_* capability supported. */
306 ovs_be32 max_groups[4]; /* Maximum number of groups for each type. */
307 ovs_be32 actions[4]; /* Bitmaps of OFPAT_* that are supported. */
309 OFP_ASSERT(sizeof(struct ofp12_group_features_stats) == 40);
311 /* Group configuration flags */
312 enum ofp12_group_capabilities {
313 OFPGFC12_SELECT_WEIGHT = 1 << 0, /* Support weight for select groups */
314 OFPGFC12_SELECT_LIVENESS = 1 << 1, /* Support liveness for select groups */
315 OFPGFC12_CHAINING = 1 << 2, /* Support chaining groups */
316 OFPGFC12_CHAINING_CHECKS = 1 << 3, /* Check chaining for loops and delete */
319 /* Body for ofp12_stats_request/reply of type OFPST_EXPERIMENTER. */
320 struct ofp12_experimenter_stats_header {
321 ovs_be32 experimenter; /* Experimenter ID which takes the same form
322 as in struct ofp_experimenter_header. */
323 ovs_be32 exp_type; /* Experimenter defined. */
324 /* Experimenter-defined arbitrary additional data. */
326 OFP_ASSERT(sizeof(struct ofp12_experimenter_stats_header) == 8);
328 /* Role request and reply message. */
329 struct ofp12_role_request {
330 ovs_be32 role; /* One of OFPCR12_ROLE_*. */
331 uint8_t pad[4]; /* Align to 64 bits. */
332 ovs_be64 generation_id; /* Master Election Generation Id */
334 OFP_ASSERT(sizeof(struct ofp12_role_request) == 16);
336 /* Controller roles. */
337 enum ofp12_controller_role {
338 OFPCR12_ROLE_NOCHANGE, /* Don't change current role. */
339 OFPCR12_ROLE_EQUAL, /* Default role, full access. */
340 OFPCR12_ROLE_MASTER, /* Full access, at most one master. */
341 OFPCR12_ROLE_SLAVE, /* Read-only access. */
344 /* Packet received on port (datapath -> controller). */
345 struct ofp12_packet_in {
346 ovs_be32 buffer_id; /* ID assigned by datapath. */
347 ovs_be16 total_len; /* Full length of frame. */
348 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
349 uint8_t table_id; /* ID of the table that was looked up */
352 * - Exactly 2 all-zero padding bytes, then
353 * - An Ethernet frame whose length is inferred from header.length.
354 * The padding bytes preceding the Ethernet frame ensure that the IP
355 * header (if any) following the Ethernet header is 32-bit aligned.
357 /* struct ofp12_match match; */
358 /* uint8_t pad[2]; Align to 64 bit + 16 bit */
359 /* uint8_t data[0]; Ethernet frame */
361 OFP_ASSERT(sizeof(struct ofp12_packet_in) == 8);
363 /* Flow removed (datapath -> controller). */
364 struct ofp12_flow_removed {
365 ovs_be64 cookie; /* Opaque controller-issued identifier. */
367 ovs_be16 priority; /* Priority level of flow entry. */
368 uint8_t reason; /* One of OFPRR_*. */
369 uint8_t table_id; /* ID of the table */
371 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
372 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
374 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
375 ovs_be16 hard_timeout; /* Hard timeout from original flow mod. */
376 ovs_be64 packet_count;
378 /* struct ofp12_match match; Description of fields. Variable size. */
380 OFP_ASSERT(sizeof(struct ofp12_flow_removed) == 40);
382 #endif /* openflow/openflow-1.2.h */