1 /* Copyright (c) 2008, 2014 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_14_H 1
40 #include <openflow/openflow-1.3.h>
43 /* ## ---------- ## */
44 /* ## ofp14_port ## */
45 /* ## ---------- ## */
47 /* Port description property types. */
48 enum ofp_port_desc_prop_type {
49 OFPPDPT14_ETHERNET = 0, /* Ethernet property. */
50 OFPPDPT14_OPTICAL = 1, /* Optical property. */
51 OFPPDPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
54 /* Ethernet port description property. */
55 struct ofp14_port_desc_prop_ethernet {
56 ovs_be16 type; /* OFPPDPT14_ETHERNET. */
57 ovs_be16 length; /* Length in bytes of this property. */
58 uint8_t pad[4]; /* Align to 64 bits. */
59 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
60 * unsupported or unavailable. */
61 ovs_be32 curr; /* Current features. */
62 ovs_be32 advertised; /* Features being advertised by the port. */
63 ovs_be32 supported; /* Features supported by the port. */
64 ovs_be32 peer; /* Features advertised by peer. */
66 ovs_be32 curr_speed; /* Current port bitrate in kbps. */
67 ovs_be32 max_speed; /* Max port bitrate in kbps */
69 OFP_ASSERT(sizeof(struct ofp14_port_desc_prop_ethernet) == 32);
75 struct eth_addr hw_addr;
76 uint8_t pad2[2]; /* Align to 64 bits. */
77 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
79 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
80 ovs_be32 state; /* Bitmap of OFPPS_* flags. */
82 /* Followed by 0 or more OFPPDPT14_* properties. */
84 OFP_ASSERT(sizeof(struct ofp14_port) == 40);
87 /* ## -------------- ## */
88 /* ## ofp14_port_mod ## */
89 /* ## -------------- ## */
91 enum ofp14_port_mod_prop_type {
92 OFPPMPT14_ETHERNET = 0, /* Ethernet property. */
93 OFPPMPT14_OPTICAL = 1, /* Optical property. */
94 OFPPMPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
97 /* Ethernet port mod property. */
98 struct ofp14_port_mod_prop_ethernet {
99 ovs_be16 type; /* OFPPMPT14_ETHERNET. */
100 ovs_be16 length; /* Length in bytes of this property. */
101 ovs_be32 advertise; /* Bitmap of OFPPF_*. Zero all bits to prevent
102 any action taking place. */
104 OFP_ASSERT(sizeof(struct ofp14_port_mod_prop_ethernet) == 8);
106 struct ofp14_port_mod {
109 struct eth_addr hw_addr;
111 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
112 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
113 /* Followed by 0 or more OFPPMPT14_* properties. */
115 OFP_ASSERT(sizeof(struct ofp14_port_mod) == 24);
117 /* ## --------------- ## */
118 /* ## ofp14_table_mod ## */
119 /* ## --------------- ## */
121 enum ofp14_table_mod_prop_type {
122 OFPTMPT14_EVICTION = 0x2, /* Eviction property. */
123 OFPTMPT14_VACANCY = 0x3, /* Vacancy property. */
124 OFPTMPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
127 enum ofp14_table_mod_prop_eviction_flag {
128 OFPTMPEF14_OTHER = 1 << 0, /* Using other factors. */
129 OFPTMPEF14_IMPORTANCE = 1 << 1, /* Using flow entry importance. */
130 OFPTMPEF14_LIFETIME = 1 << 2, /* Using flow entry lifetime. */
133 /* What changed about the table */
134 enum ofp14_table_reason {
135 OFPTR_VACANCY_DOWN = 3, /* Vacancy down threshold event. */
136 OFPTR_VACANCY_UP = 4, /* Vacancy up threshold event. */
137 OFPTR_N_REASONS /* Denotes number of reasons. */
140 struct ofp14_table_mod_prop_eviction {
141 ovs_be16 type; /* OFPTMPT14_EVICTION. */
142 ovs_be16 length; /* Length in bytes of this property. */
143 ovs_be32 flags; /* Bitmap of OFPTMPEF14_* flags */
145 OFP_ASSERT(sizeof(struct ofp14_table_mod_prop_eviction) == 8);
147 struct ofp14_table_mod_prop_vacancy {
148 ovs_be16 type; /* OFPTMPT14_VACANCY. */
149 ovs_be16 length; /* Length in bytes of this property. */
150 uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
151 uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
152 uint8_t vacancy; /* Current vacancy (%) - only in ofp14_table_desc. */
153 uint8_t pad[1]; /* Align to 64 bits. */
155 OFP_ASSERT(sizeof(struct ofp14_table_mod_prop_vacancy) == 8);
157 struct ofp14_table_mod {
158 uint8_t table_id; /* ID of the table, OFPTT_ALL indicates all tables */
159 uint8_t pad[3]; /* Pad to 32 bits */
160 ovs_be32 config; /* Bitmap of OFPTC_* flags */
161 /* Followed by 0 or more OFPTMPT14_* properties. */
163 OFP_ASSERT(sizeof(struct ofp14_table_mod) == 8);
165 /* Body of reply to OFPMP_TABLE_DESC request. */
166 struct ofp14_table_desc {
167 ovs_be16 length; /* Length is padded to 64 bits. */
168 uint8_t table_id; /* Identifier of table. Lower numbered tables
169 are consulted first. */
170 uint8_t pad[1]; /* Align to 32-bits. */
171 ovs_be32 config; /* Bitmap of OFPTC_* values. */
172 /* Followed by 0 or more OFPTMPT14_* properties. */
174 OFP_ASSERT(sizeof(struct ofp14_table_desc) == 8);
176 /* ## ---------------- ## */
177 /* ## ofp14_port_stats ## */
178 /* ## ---------------- ## */
180 enum ofp14_port_stats_prop_type {
181 OFPPSPT14_ETHERNET = 0, /* Ethernet property. */
182 OFPPSPT14_OPTICAL = 1, /* Optical property. */
183 OFPPSPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
186 struct ofp14_port_stats_prop_ethernet {
187 ovs_be16 type; /* OFPPSPT14_ETHERNET. */
188 ovs_be16 length; /* Length in bytes of this property. */
189 uint8_t pad[4]; /* Align to 64 bits. */
191 ovs_be64 rx_frame_err; /* Number of frame alignment errors. */
192 ovs_be64 rx_over_err; /* Number of packets with RX overrun. */
193 ovs_be64 rx_crc_err; /* Number of CRC errors. */
194 ovs_be64 collisions; /* Number of collisions. */
196 OFP_ASSERT(sizeof(struct ofp14_port_stats_prop_ethernet) == 40);
198 struct ofp14_port_stats {
199 ovs_be16 length; /* Length of this entry. */
200 uint8_t pad[2]; /* Align to 64 bits. */
202 ovs_be32 duration_sec; /* Time port has been alive in seconds. */
203 ovs_be32 duration_nsec; /* Time port has been alive in nanoseconds beyond
205 ovs_be64 rx_packets; /* Number of received packets. */
206 ovs_be64 tx_packets; /* Number of transmitted packets. */
207 ovs_be64 rx_bytes; /* Number of received bytes. */
208 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
210 ovs_be64 rx_dropped; /* Number of packets dropped by RX. */
211 ovs_be64 tx_dropped; /* Number of packets dropped by TX. */
212 ovs_be64 rx_errors; /* Number of receive errors. This is a super-set
213 of more specific receive errors and should be
214 greater than or equal to the sum of all
215 rx_*_err values in properties. */
216 ovs_be64 tx_errors; /* Number of transmit errors. This is a super-set
217 of more specific transmit errors and should be
218 greater than or equal to the sum of all
219 tx_*_err values (none currently defined.) */
220 /* Followed by 0 or more OFPPSPT14_* properties. */
222 OFP_ASSERT(sizeof(struct ofp14_port_stats) == 80);
225 /* ## ----------------- ## */
226 /* ## ofp14_queue_stats ## */
227 /* ## ----------------- ## */
229 struct ofp14_queue_stats {
230 ovs_be16 length; /* Length of this entry. */
231 uint8_t pad[6]; /* Align to 64 bits. */
232 struct ofp13_queue_stats qs;
233 /* Followed by 0 or more properties (none yet defined). */
235 OFP_ASSERT(sizeof(struct ofp14_queue_stats) == 48);
238 /* ## -------------- ## */
239 /* ## Miscellaneous. ## */
240 /* ## -------------- ## */
242 /* Common header for all async config Properties */
243 struct ofp14_async_config_prop_header {
244 ovs_be16 type; /* One of OFPACPT_*. */
245 ovs_be16 length; /* Length in bytes of this property. */
247 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_header) == 4);
249 /* Asynchronous message configuration.
250 * OFPT_GET_ASYNC_REPLY or OFPT_SET_ASYNC.
252 struct ofp14_async_config {
253 struct ofp_header header;
254 /* Async config Property list - 0 or more */
255 struct ofp14_async_config_prop_header properties[0];
257 OFP_ASSERT(sizeof(struct ofp14_async_config) == 8);
259 /* Request forward reason */
260 enum ofp14_requestforward_reason {
261 OFPRFR_GROUP_MOD = 0, /* Forward group mod requests. */
262 OFPRFR_METER_MOD = 1, /* Forward meter mod requests. */
263 OFPRFR_N_REASONS /* Denotes number of reasons. */
266 /* Async Config property types.
267 * Low order bit cleared indicates a property for the slave role.
268 * Low order bit set indicates a property for the master/equal role.
270 enum ofp14_async_config_prop_type {
271 OFPACPT_PACKET_IN_SLAVE = 0, /* Packet-in mask for slave. */
272 OFPACPT_PACKET_IN_MASTER = 1, /* Packet-in mask for master. */
273 OFPACPT_PORT_STATUS_SLAVE = 2, /* Port-status mask for slave. */
274 OFPACPT_PORT_STATUS_MASTER = 3, /* Port-status mask for master. */
275 OFPACPT_FLOW_REMOVED_SLAVE = 4, /* Flow removed mask for slave. */
276 OFPACPT_FLOW_REMOVED_MASTER = 5, /* Flow removed mask for master. */
277 OFPACPT_ROLE_STATUS_SLAVE = 6, /* Role status mask for slave. */
278 OFPACPT_ROLE_STATUS_MASTER = 7, /* Role status mask for master. */
279 OFPACPT_TABLE_STATUS_SLAVE = 8, /* Table status mask for slave. */
280 OFPACPT_TABLE_STATUS_MASTER = 9, /* Table status mask for master. */
281 OFPACPT_REQUESTFORWARD_SLAVE = 10, /* RequestForward mask for slave. */
282 OFPACPT_REQUESTFORWARD_MASTER = 11, /* RequestForward mask for master. */
283 OFPTFPT_EXPERIMENTER_SLAVE = 0xFFFE, /* Experimenter for slave. */
284 OFPTFPT_EXPERIMENTER_MASTER = 0xFFFF, /* Experimenter for master. */
287 /* Various reason based properties */
288 struct ofp14_async_config_prop_reasons {
289 /* 'type' is one of OFPACPT_PACKET_IN_*, OFPACPT_PORT_STATUS_*,
290 * OFPACPT_FLOW_REMOVED_*, OFPACPT_ROLE_STATUS_*,
291 * OFPACPT_TABLE_STATUS_*, OFPACPT_REQUESTFORWARD_*. */
293 ovs_be16 length; /* Length in bytes of this property. */
294 ovs_be32 mask; /* Bitmasks of reason values. */
296 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_reasons) == 8);
298 /* Experimenter async config property */
299 struct ofp14_async_config_prop_experimenter {
300 ovs_be16 type; /* One of OFPTFPT_EXPERIMENTER_SLAVE,
301 OFPTFPT_EXPERIMENTER_MASTER. */
302 ovs_be16 length; /* Length in bytes of this property. */
303 ovs_be32 experimenter; /* Experimenter ID which takes the same
305 ofp_experimenter_header. */
306 ovs_be32 exp_type; /* Experimenter defined. */
308 * - Exactly (length - 12) bytes containing the experimenter data, then
309 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
310 * bytes of all-zero bytes */
312 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_experimenter) == 12);
314 /* Common header for all Role Properties */
315 struct ofp14_role_prop_header {
316 ovs_be16 type; /* One of OFPRPT_*. */
317 ovs_be16 length; /* Length in bytes of this property. */
319 OFP_ASSERT(sizeof(struct ofp14_role_prop_header) == 4);
321 /* Role status event message. */
322 struct ofp14_role_status {
323 ovs_be32 role; /* One of OFPCR_ROLE_*. */
324 uint8_t reason; /* One of OFPCRR_*. */
325 uint8_t pad[3]; /* Align to 64 bits. */
326 ovs_be64 generation_id; /* Master Election Generation Id */
328 /* Followed by a list of struct ofp14_role_prop_header */
330 OFP_ASSERT(sizeof(struct ofp14_role_status) == 16);
332 /* What changed about the controller role */
333 enum ofp14_controller_role_reason {
334 OFPCRR_MASTER_REQUEST = 0, /* Another controller asked to be master. */
335 OFPCRR_CONFIG = 1, /* Configuration changed on the switch. */
336 OFPCRR_EXPERIMENTER = 2, /* Experimenter data changed. */
337 OFPCRR_N_REASONS /* Denotes number of reasons. */
340 /* Role property types.
342 enum ofp14_role_prop_type {
343 OFPRPT_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
346 /* Experimenter role property */
347 struct ofp14_role_prop_experimenter {
348 ovs_be16 type; /* One of OFPRPT_EXPERIMENTER. */
349 ovs_be16 length; /* Length in bytes of this property. */
350 ovs_be32 experimenter; /* Experimenter ID which takes the same
352 ofp_experimenter_header. */
353 ovs_be32 exp_type; /* Experimenter defined. */
355 * - Exactly (length - 12) bytes containing the experimenter data, then
356 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
357 * bytes of all-zero bytes */
359 OFP_ASSERT(sizeof(struct ofp14_role_prop_experimenter) == 12);
361 /* Group/Meter request forwarding. */
362 struct ofp14_requestforward {
363 struct ofp_header request; /* Request being forwarded. */
365 OFP_ASSERT(sizeof(struct ofp14_requestforward) == 8);
367 /* Bundle control message types */
368 enum ofp14_bundle_ctrl_type {
369 OFPBCT_OPEN_REQUEST = 0,
370 OFPBCT_OPEN_REPLY = 1,
371 OFPBCT_CLOSE_REQUEST = 2,
372 OFPBCT_CLOSE_REPLY = 3,
373 OFPBCT_COMMIT_REQUEST = 4,
374 OFPBCT_COMMIT_REPLY = 5,
375 OFPBCT_DISCARD_REQUEST = 6,
376 OFPBCT_DISCARD_REPLY = 7,
379 /* Bundle configuration flags. */
380 enum ofp14_bundle_flags {
381 OFPBF_ATOMIC = 1 << 0, /* Execute atomically. */
382 OFPBF_ORDERED = 1 << 1, /* Execute in specified order. */
385 /* Message structure for OFPT_BUNDLE_CONTROL and OFPT_BUNDLE_ADD_MESSAGE. */
386 struct ofp14_bundle_ctrl_msg {
387 ovs_be32 bundle_id; /* Identify the bundle. */
388 ovs_be16 type; /* OFPT_BUNDLE_CONTROL: one of OFPBCT_*.
389 * OFPT_BUNDLE_ADD_MESSAGE: not used. */
390 ovs_be16 flags; /* Bitmap of OFPBF_* flags. */
392 * - For OFPT_BUNDLE_ADD_MESSAGE only, an encapsulated OpenFlow message,
393 * beginning with an ofp_header whose xid is identical to this message's
395 * - For OFPT_BUNDLE_ADD_MESSAGE only, and only if at least one property is
396 * present, 0 to 7 bytes of padding to align on a 64-bit boundary.
397 * - Zero or more properties (see struct ofp14_bundle_prop_header). */
399 OFP_ASSERT(sizeof(struct ofp14_bundle_ctrl_msg) == 8);
401 /* Body for ofp14_multipart_request of type OFPMP_FLOW_MONITOR.
403 * The OFPMP_FLOW_MONITOR request's body consists of an array of zero or more
404 * instances of this structure. The request arranges to monitor the flows
405 * that match the specified criteria, which are interpreted in the same way as
408 * 'id' identifies a particular monitor for the purpose of allowing it to be
409 * canceled later with OFPFMC_DELETE. 'id' must be unique among
410 * existing monitors that have not already been canceled.
412 struct ofp14_flow_monitor_request {
413 ovs_be32 monitor_id; /* Controller-assigned ID for this monitor. */
414 ovs_be32 out_port; /* Required output port, if not OFPP_ANY. */
415 ovs_be32 out_group; /* Required output port, if not OFPG_ANY. */
416 ovs_be16 flags; /* OFPMF14_*. */
417 uint8_t table_id; /* One table's ID or OFPTT_ALL (all tables). */
418 uint8_t command; /* One of OFPFMC14_*. */
419 /* Followed by an ofp11_match structure. */
421 OFP_ASSERT(sizeof(struct ofp14_flow_monitor_request) == 16);
423 /* Flow monitor commands */
424 enum ofp14_flow_monitor_command {
425 OFPFMC14_ADD = 0, /* New flow monitor. */
426 OFPFMC14_MODIFY = 1, /* Modify existing flow monitor. */
427 OFPFMC14_DELETE = 2, /* Delete/cancel existing flow monitor. */
430 /* 'flags' bits in struct of_flow_monitor_request. */
431 enum ofp14_flow_monitor_flags {
432 /* When to send updates. */
433 /* Common to NX and OpenFlow 1.4 */
434 OFPFMF14_INITIAL = 1 << 0, /* Initially matching flows. */
435 OFPFMF14_ADD = 1 << 1, /* New matching flows as they are added. */
436 OFPFMF14_REMOVED = 1 << 2, /* Old matching flows as they are removed. */
437 OFPFMF14_MODIFY = 1 << 3, /* Matching flows as they are changed. */
439 /* What to include in updates. */
440 /* Common to NX and OpenFlow 1.4 */
441 OFPFMF14_INSTRUCTIONS = 1 << 4, /* If set, instructions are included. */
442 OFPFMF14_NO_ABBREV = 1 << 5, /* If set, include own changes in full. */
444 OFPFMF14_ONLY_OWN = 1 << 6, /* If set, don't include other controllers.
448 #endif /* openflow/openflow-1.4.h */