1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
3 * Copyright (c) 2011, 2012 Open Networking Foundation
5 * We are making the OpenFlow specification and associated documentation
6 * (Software) available for public use and benefit with the expectation
7 * that others will use, modify and enhance the Software and contribute
8 * those enhancements back to the community. However, since we would
9 * like to make the Software available for broadest use, with as few
10 * restrictions as possible permission is hereby granted, free of
11 * charge, to any person obtaining a copy of this Software to deal in
12 * the Software under the copyrights without restriction, including
13 * without limitation the rights to use, copy, modify, merge, publish,
14 * distribute, sublicense, and/or sell copies of the Software, and to
15 * permit persons to whom the Software is furnished to do so, subject to
16 * the following conditions:
18 * The above copyright notice and this permission notice shall be
19 * included in all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
25 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
26 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
27 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 * The name and trademarks of copyright holder(s) may NOT be used in
31 * advertising or publicity pertaining to the Software or any
32 * derivatives without specific, written prior permission.
35 /* OpenFlow: protocol between controller and datapath. */
38 #define OPENFLOW_13_H 1
40 #include <openflow/openflow-1.2.h>
43 * OpenFlow 1.3 modifies the syntax of the following message types:
45 * OFPT_FEATURES_REPLY = 6 (opf13_switch_features)
46 * - new field: auxiliary_id
47 * - removed: ofp_ports at the end
49 * OFPT_PACKET_IN = 10 (ofp13_packet_in) new field: cookie
51 * OpenFlow 1.3 adds following new message types:
53 * * Asynchronous message configuration. *
54 * OFPT13_GET_ASYNC_REQUEST = 26 (void)
55 * OFPT13_GET_ASYNC_REPLY = 27 (ofp13_async_config)
56 * OFPT13_SET_ASYNC = 28 (ofp13_async_config)
58 * * Meters and rate limiters configuration messages. *
59 * OFPT13_METER_MOD = 29 (ofp13_meter_mod)
61 * OpenFlow 1.3 modifies the syntax of the following statistics message types
62 * (now called multipart message types):
64 * OFPMP13_FLOW_REPLY = 1 (struct ofp13_flow_stats[])
65 * OFPMP13_TABLE_REPLY = 3 (struct ofp13_table_stats[])
66 * OFPMP13_PORT_REPLY = 4 (struct ofp13_port_stats[])
67 * OFPMP13_QUEUE_REPLY = 5, (struct ofp13_queue_stats[])
68 * OFPMP13_GROUP_REPLY = 6, (struct ofp13_group_stats[])
70 * OpenFlow 1.3 adds the following multipart message types
73 * OFPMP13_METER_REQUEST = 9, (struct ofp13_meter_multipart_request)
74 * OFPMP13_METER_REPLY = 9, (struct ofp13_meter_stats[])
76 * Meter configuration:
77 * OFPMP13_METER_CONFIG_REQUEST = 10, (struct ofp13_meter_multipart_request)
78 * OFPMP13_METER_CONFIG_REPLY = 10, (struct ofp13_meter_config[])
81 * OFPMP13_METER_FEATURES_REQUEST = 11 (void)
82 * OFPMP13_METER_FEATURES_REPLY = 11 (struct ofp13_meter_features)
85 * OFPMP13_TABLE_FEATURES_REQUEST = 12, (struct ofp13_table_features[])
86 * OFPMP13_TABLE_FEATURES_REPLY = 12, (struct ofp13_table_features[])
90 enum ofp13_instruction_type {
91 OFPIT13_METER = 6 /* Apply meter (rate limiter) */
94 /* Instruction structure for OFPIT_METER */
95 struct ofp13_instruction_meter {
96 ovs_be16 type; /* OFPIT13_METER */
97 ovs_be16 len; /* Length is 8. */
98 ovs_be32 meter_id; /* Meter instance. */
100 OFP_ASSERT(sizeof(struct ofp13_instruction_meter) == 8);
102 /* enum ofp_config_flags value OFPC_INVALID_TTL_TO_CONTROLLER
103 * is deprecated in OpenFlow 1.3 */
105 /* Flags to configure the table. Reserved for future use. */
106 enum ofp13_table_config {
107 OFPTC13_DEPRECATED_MASK = 3 /* Deprecated bits */
110 /* OpenFlow 1.3 specific flags for flow_mod messages. */
111 enum ofp13_flow_mod_flags {
112 OFPFF13_NO_PKT_COUNTS = 1 << 3, /* Don't keep track of packet count. */
113 OFPFF13_NO_BYT_COUNTS = 1 << 4 /* Don't keep track of byte count. */
116 /* Common header for all meter bands */
117 struct ofp13_meter_band_header {
118 ovs_be16 type; /* One of OFPMBT_*. */
119 ovs_be16 len; /* Length in bytes of this band. */
120 ovs_be32 rate; /* Rate for this band. */
121 ovs_be32 burst_size; /* Size of bursts. */
123 OFP_ASSERT(sizeof(struct ofp13_meter_band_header) == 12);
125 /* Meter configuration. OFPT_METER_MOD. */
126 struct ofp13_meter_mod {
127 ovs_be16 command; /* One of OFPMC_*. */
128 ovs_be16 flags; /* Set of OFPMF_*. */
129 ovs_be32 meter_id; /* Meter instance. */
130 /* struct ofp13_meter_band_header bands[0]; The bands length is inferred
131 from the length field in the
134 OFP_ASSERT(sizeof(struct ofp13_meter_mod) == 8);
136 /* Meter numbering. Flow meters can use any number up to OFPM_MAX. */
138 /* Last usable meter. */
139 OFPM13_MAX = 0xffff0000,
140 /* Virtual meters. */
141 OFPM13_SLOWPATH = 0xfffffffd, /* Meter for slow datapath. */
142 OFPM13_CONTROLLER = 0xfffffffe, /* Meter for controller connection. */
143 OFPM13_ALL = 0xffffffff, /* Represents all meters for stat requests
148 enum ofp13_meter_mod_command {
149 OFPMC13_ADD, /* New meter. */
150 OFPMC13_MODIFY, /* Modify specified meter. */
151 OFPMC13_DELETE /* Delete specified meter. */
154 /* Meter configuration flags */
155 enum ofp13_meter_flags {
156 OFPMF13_KBPS = 1 << 0, /* Rate value in kb/s (kilo-bit per second). */
157 OFPMF13_PKTPS = 1 << 1, /* Rate value in packet/sec. */
158 OFPMF13_BURST = 1 << 2, /* Do burst size. */
159 OFPMF13_STATS = 1 << 3 /* Collect statistics. */
162 /* Meter band types */
163 enum ofp13_meter_band_type {
164 OFPMBT13_DROP = 1, /* Drop packet. */
165 OFPMBT13_DSCP_REMARK = 2, /* Remark DSCP in the IP header. */
166 OFPMBT13_EXPERIMENTER = 0xFFFF /* Experimenter meter band. */
169 /* OFPMBT_DROP band - drop packets */
170 struct ofp13_meter_band_drop {
171 ovs_be16 type; /* OFPMBT_DROP. */
172 ovs_be16 len; /* Length in bytes of this band. */
173 ovs_be32 rate; /* Rate for dropping packets. */
174 ovs_be32 burst_size; /* Size of bursts. */
177 OFP_ASSERT(sizeof(struct ofp13_meter_band_drop) == 16);
179 /* OFPMBT_DSCP_REMARK band - Remark DSCP in the IP header */
180 struct ofp13_meter_band_dscp_remark {
181 ovs_be16 type; /* OFPMBT_DSCP_REMARK. */
182 ovs_be16 len; /* Length in bytes of this band. */
183 ovs_be32 rate; /* Rate for remarking packets. */
184 ovs_be32 burst_size; /* Size of bursts. */
185 uint8_t prec_level; /* Number of drop precedence level to add. */
188 OFP_ASSERT(sizeof(struct ofp13_meter_band_dscp_remark) == 16);
190 /* OFPMBT_EXPERIMENTER band - Write actions in action set */
191 struct ofp13_meter_band_experimenter {
192 ovs_be16 type; /* OFPMBT_EXPERIMENTER. */
193 ovs_be16 len; /* Length in bytes of this band. */
194 ovs_be32 rate; /* Rate for dropping packets. */
195 ovs_be32 burst_size; /* Size of bursts. */
196 ovs_be32 experimenter; /* Experimenter ID which takes the same form as
197 in struct ofp_experimenter_header. */
199 OFP_ASSERT(sizeof(struct ofp13_meter_band_experimenter) == 16);
201 /* OF 1.3 adds MORE flag also for requests */
202 enum ofp13_multipart_request_flags {
203 OFPMPF13_REQ_MORE = 1 << 0 /* More requests to follow. */
206 /* OF 1.3 splits table features off the ofp_table_stats */
207 /* Body of reply to OFPMP13_TABLE request. */
208 struct ofp13_table_stats {
209 uint8_t table_id; /* Identifier of table. Lower numbered tables are
211 uint8_t pad[3]; /* Align to 32-bits. */
212 ovs_be32 active_count; /* Number of active entries. */
213 ovs_be64 lookup_count; /* Number of packets looked up in table. */
214 ovs_be64 matched_count; /* Number of packets that hit table. */
216 OFP_ASSERT(sizeof(struct ofp13_table_stats) == 24);
218 /* Common header for all Table Feature Properties */
219 struct ofp13_table_feature_prop_header {
220 ovs_be16 type; /* One of OFPTFPT_*. */
221 ovs_be16 length; /* Length in bytes of this property. */
223 OFP_ASSERT(sizeof(struct ofp13_table_feature_prop_header) == 4);
225 /* Body for ofp_multipart_request of type OFPMP_TABLE_FEATURES./
226 * Body of reply to OFPMP_TABLE_FEATURES request. */
227 struct ofp13_table_features {
228 ovs_be16 length; /* Length is padded to 64 bits. */
229 uint8_t table_id; /* Identifier of table. Lower numbered tables
230 are consulted first. */
231 uint8_t pad[5]; /* Align to 64-bits. */
232 char name[OFP_MAX_TABLE_NAME_LEN];
233 ovs_be64 metadata_match; /* Bits of metadata table can match. */
234 ovs_be64 metadata_write; /* Bits of metadata table can write. */
236 /* In OF1.3 this field was named 'config' and it was useless because OF1.3
237 * did not define any OFPTC_* bits.
239 * OF1.4 renamed this field to 'capabilities' and added OFPTC14_EVICTION
240 * and OFPTC14_VACANCY_EVENTS. */
241 ovs_be32 capabilities; /* Bitmap of OFPTC_* values */
243 ovs_be32 max_entries; /* Max number of entries supported. */
245 /* Table Feature Property list */
246 /* struct ofp13_table_feature_prop_header properties[0]; */
248 OFP_ASSERT(sizeof(struct ofp13_table_features) == 64);
250 /* Table Feature property types.
251 * Low order bit cleared indicates a property for a regular Flow Entry.
252 * Low order bit set indicates a property for the Table-Miss Flow Entry. */
253 enum ofp13_table_feature_prop_type {
254 OFPTFPT13_INSTRUCTIONS = 0, /* Instructions property. */
255 OFPTFPT13_INSTRUCTIONS_MISS = 1, /* Instructions for table-miss. */
256 OFPTFPT13_NEXT_TABLES = 2, /* Next Table property. */
257 OFPTFPT13_NEXT_TABLES_MISS = 3, /* Next Table for table-miss. */
258 OFPTFPT13_WRITE_ACTIONS = 4, /* Write Actions property. */
259 OFPTFPT13_WRITE_ACTIONS_MISS = 5, /* Write Actions for table-miss. */
260 OFPTFPT13_APPLY_ACTIONS = 6, /* Apply Actions property. */
261 OFPTFPT13_APPLY_ACTIONS_MISS = 7, /* Apply Actions for table-miss. */
262 OFPTFPT13_MATCH = 8, /* Match property. */
263 OFPTFPT13_WILDCARDS = 10, /* Wildcards property. */
264 OFPTFPT13_WRITE_SETFIELD = 12, /* Write Set-Field property. */
265 OFPTFPT13_WRITE_SETFIELD_MISS = 13, /* Write Set-Field for table-miss. */
266 OFPTFPT13_APPLY_SETFIELD = 14, /* Apply Set-Field property. */
267 OFPTFPT13_APPLY_SETFIELD_MISS = 15, /* Apply Set-Field for table-miss. */
268 OFPTFPT13_EXPERIMENTER = 0xFFFE, /* Experimenter property. */
269 OFPTFPT13_EXPERIMENTER_MISS = 0xFFFF, /* Experimenter for table-miss. */
272 /* Instructions property */
273 struct ofp13_table_feature_prop_instructions {
274 ovs_be16 type; /* One of OFPTFPT13_INSTRUCTIONS,
275 OFPTFPT13_INSTRUCTIONS_MISS. */
276 ovs_be16 length; /* Length in bytes of this property. */
278 * - Exactly (length - 4) bytes containing the instruction ids, then
279 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
280 * bytes of all-zero bytes */
281 /* struct ofp11_instruction instruction_ids[0]; List of instructions
284 OFP_ASSERT(sizeof(struct ofp13_table_feature_prop_instructions) == 4);
286 /* Next Tables property */
287 struct ofp13_table_feature_prop_next_tables {
288 ovs_be16 type; /* One of OFPTFPT13_NEXT_TABLES,
289 OFPTFPT13_NEXT_TABLES_MISS. */
290 ovs_be16 length; /* Length in bytes of this property. */
292 * - Exactly (length - 4) bytes containing the table_ids, then
293 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
294 * bytes of all-zero bytes */
295 /* uint8_t next_table_ids[0]; */
297 OFP_ASSERT(sizeof(struct ofp13_table_feature_prop_next_tables) == 4);
299 /* Actions property */
300 struct ofp13_table_feature_prop_actions {
301 ovs_be16 type; /* One of OFPTFPT13_WRITE_ACTIONS,
302 OFPTFPT13_WRITE_ACTIONS_MISS,
303 OFPTFPT13_APPLY_ACTIONS,
304 OFPTFPT13_APPLY_ACTIONS_MISS. */
305 ovs_be16 length; /* Length in bytes of this property. */
307 * - Exactly (length - 4) bytes containing the action_ids, then
308 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
309 * bytes of all-zero bytes */
310 /* struct ofp_action_header action_ids[0]; List of actions
313 OFP_ASSERT(sizeof(struct ofp13_table_feature_prop_actions) == 4);
316 /* Match, Wildcard or Set-Field property */
317 struct ofp13_table_feature_prop_oxm {
318 ovs_be16 type; /* One of OFPTFPT13_MATCH, OFPTFPT13_WILDCARDS,
319 OFPTFPT13_WRITE_SETFIELD,
320 OFPTFPT13_WRITE_SETFIELD_MISS,
321 OFPTFPT13_APPLY_SETFIELD,
322 OFPTFPT13_APPLY_SETFIELD_MISS. */
323 ovs_be16 length; /* Length in bytes of this property. */
325 * - Exactly (length - 4) bytes containing the oxm_ids, then
326 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
327 * bytes of all-zero bytes */
328 /* ovs_be32 oxm_ids[0]; Array of OXM headers */
330 OFP_ASSERT(sizeof(struct ofp13_table_feature_prop_oxm) == 4);
332 /* Experimenter table feature property */
333 struct ofp13_table_feature_prop_experimenter {
334 ovs_be16 type; /* One of OFPTFPT13_EXPERIMENTER,
335 OFPTFPT13_EXPERIMENTER_MISS. */
336 ovs_be16 length; /* Length in bytes of this property. */
337 ovs_be32 experimenter; /* Experimenter ID which takes the same form
338 as in struct ofp_experimenter_header. */
339 ovs_be32 exp_type; /* Experimenter defined. */
341 * - Exactly (length - 12) bytes containing the experimenter data, then
342 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
343 * bytes of all-zero bytes */
344 /* ovs_be32 experimenter_data[0]; */
346 OFP_ASSERT(sizeof(struct ofp13_table_feature_prop_experimenter) == 12);
348 /* Body of reply to OFPMP13_PORT request. If a counter is unsupported, set
349 * the field to all ones. */
350 struct ofp13_port_stats {
351 struct ofp11_port_stats ps;
352 ovs_be32 duration_sec; /* Time port has been alive in seconds. */
353 ovs_be32 duration_nsec; /* Time port has been alive in nanoseconds
354 beyond duration_sec. */
356 OFP_ASSERT(sizeof(struct ofp13_port_stats) == 112);
358 /* Body of reply to OFPMP13_QUEUE request */
359 struct ofp13_queue_stats {
360 struct ofp11_queue_stats qs;
361 ovs_be32 duration_sec; /* Time queue has been alive in seconds. */
362 ovs_be32 duration_nsec; /* Time queue has been alive in nanoseconds
363 beyond duration_sec. */
365 OFP_ASSERT(sizeof(struct ofp13_queue_stats) == 40);
367 /* Body of reply to OFPMP13_GROUP request */
368 struct ofp13_group_stats {
369 struct ofp11_group_stats gs;
370 ovs_be32 duration_sec; /* Time group has been alive in seconds. */
371 ovs_be32 duration_nsec; /* Time group has been alive in nanoseconds
372 beyond duration_sec. */
373 /* struct ofp11_bucket_counter bucket_stats[]; */
375 OFP_ASSERT(sizeof(struct ofp13_group_stats) == 40);
377 /* Body of OFPMP13_METER and OFPMP13_METER_CONFIG requests. */
378 struct ofp13_meter_multipart_request {
379 ovs_be32 meter_id; /* Meter instance, or OFPM_ALL. */
380 uint8_t pad[4]; /* Align to 64 bits. */
382 OFP_ASSERT(sizeof(struct ofp13_meter_multipart_request) == 8);
384 /* Statistics for each meter band */
385 struct ofp13_meter_band_stats {
386 ovs_be64 packet_band_count; /* Number of packets in band. */
387 ovs_be64 byte_band_count; /* Number of bytes in band. */
389 OFP_ASSERT(sizeof(struct ofp13_meter_band_stats) == 16);
391 /* Body of reply to OFPMP13_METER request. Meter statistics. */
392 struct ofp13_meter_stats {
393 ovs_be32 meter_id; /* Meter instance. */
394 ovs_be16 len; /* Length in bytes of this stats. */
396 ovs_be32 flow_count; /* Number of flows bound to meter. */
397 ovs_be64 packet_in_count; /* Number of packets in input. */
398 ovs_be64 byte_in_count; /* Number of bytes in input. */
399 ovs_be32 duration_sec; /* Time meter has been alive in seconds. */
400 ovs_be32 duration_nsec; /* Time meter has been alive in nanoseconds
401 beyond duration_sec. */
402 struct ofp13_meter_band_stats band_stats[0]; /* The band_stats length is
403 inferred from the length field. */
405 OFP_ASSERT(sizeof(struct ofp13_meter_stats) == 40);
407 /* Body of reply to OFPMP13_METER_CONFIG request. Meter configuration. */
408 struct ofp13_meter_config {
409 ovs_be16 length; /* Length of this entry. */
410 ovs_be16 flags; /* Set of OFPMC_* that apply. */
411 ovs_be32 meter_id; /* Meter instance. */
412 /* struct ofp13_meter_band_header bands[0]; The bands length is inferred
413 from the length field. */
415 OFP_ASSERT(sizeof(struct ofp13_meter_config) == 8);
417 /* Body of reply to OFPMP13_METER_FEATURES request. Meter features. */
418 struct ofp13_meter_features {
419 ovs_be32 max_meter; /* Maximum number of meters. */
420 ovs_be32 band_types; /* Bitmaps of OFPMBT13_* values supported. */
421 ovs_be32 capabilities; /* Bitmaps of "ofp13_meter_flags". */
422 uint8_t max_bands; /* Maximum bands per meters */
423 uint8_t max_color; /* Maximum color value */
426 OFP_ASSERT(sizeof(struct ofp13_meter_features) == 16);
428 /* Asynchronous message configuration. */
429 /* The body of this is the same as nx_async_config */
430 /* OFPT_GET_ASYNC_REPLY or OFPT_SET_ASYNC. */
431 struct ofp13_async_config {
432 ovs_be32 packet_in_mask[2]; /* Bitmasks of OFPR_* values. */
433 ovs_be32 port_status_mask[2]; /* Bitmasks of OFPPR_* values. */
434 ovs_be32 flow_removed_mask[2];/* Bitmasks of OFPRR_* values. */
436 OFP_ASSERT(sizeof(struct ofp13_async_config) == 24);
439 /* Packet received on port (datapath -> controller). */
440 struct ofp13_packet_in {
441 struct ofp12_packet_in pi;
442 ovs_be64 cookie; /* Cookie of the flow entry that was looked up */
445 * - Exactly 2 all-zero padding bytes, then
446 * - An Ethernet frame whose length is inferred from header.length.
447 * The padding bytes preceding the Ethernet frame ensure that the IP
448 * header (if any) following the Ethernet header is 32-bit aligned.
450 /* struct ofp12_match match; */
451 /* uint8_t pad[2]; Align to 64 bit + 16 bit */
452 /* uint8_t data[0]; Ethernet frame */
454 OFP_ASSERT(sizeof(struct ofp13_packet_in) == 16);
457 #endif /* openflow/openflow-1.3.h */