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 uint8_t hw_addr[OFP_ETH_ALEN];
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 uint8_t hw_addr[OFP_ETH_ALEN];
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 struct ofp14_table_mod_prop_eviction {
134 ovs_be16 type; /* OFPTMPT14_EVICTION. */
135 ovs_be16 length; /* Length in bytes of this property. */
136 ovs_be32 flags; /* Bitmap of OFPTMPEF14_* flags */
138 OFP_ASSERT(sizeof(struct ofp14_table_mod_prop_eviction) == 8);
140 struct ofp14_table_mod_prop_vacancy {
141 ovs_be16 type; /* OFPTMPT14_VACANCY. */
142 ovs_be16 length; /* Length in bytes of this property. */
143 uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
144 uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
145 uint8_t vacancy; /* Current vacancy (%) - only in ofp14_table_desc. */
146 uint8_t pad[1]; /* Align to 64 bits. */
148 OFP_ASSERT(sizeof(struct ofp14_table_mod_prop_vacancy) == 8);
150 struct ofp14_table_mod {
151 uint8_t table_id; /* ID of the table, OFPTT_ALL indicates all tables */
152 uint8_t pad[3]; /* Pad to 32 bits */
153 ovs_be32 config; /* Bitmap of OFPTC_* flags */
154 /* Followed by 0 or more OFPTMPT14_* properties. */
156 OFP_ASSERT(sizeof(struct ofp14_table_mod) == 8);
159 /* ## ---------------- ## */
160 /* ## ofp14_port_stats ## */
161 /* ## ---------------- ## */
163 enum ofp14_port_stats_prop_type {
164 OFPPSPT14_ETHERNET = 0, /* Ethernet property. */
165 OFPPSPT14_OPTICAL = 1, /* Optical property. */
166 OFPPSPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
169 struct ofp14_port_stats_prop_ethernet {
170 ovs_be16 type; /* OFPPSPT14_ETHERNET. */
171 ovs_be16 length; /* Length in bytes of this property. */
172 uint8_t pad[4]; /* Align to 64 bits. */
174 ovs_be64 rx_frame_err; /* Number of frame alignment errors. */
175 ovs_be64 rx_over_err; /* Number of packets with RX overrun. */
176 ovs_be64 rx_crc_err; /* Number of CRC errors. */
177 ovs_be64 collisions; /* Number of collisions. */
179 OFP_ASSERT(sizeof(struct ofp14_port_stats_prop_ethernet) == 40);
181 struct ofp14_port_stats {
182 ovs_be16 length; /* Length of this entry. */
183 uint8_t pad[2]; /* Align to 64 bits. */
185 ovs_be32 duration_sec; /* Time port has been alive in seconds. */
186 ovs_be32 duration_nsec; /* Time port has been alive in nanoseconds beyond
188 ovs_be64 rx_packets; /* Number of received packets. */
189 ovs_be64 tx_packets; /* Number of transmitted packets. */
190 ovs_be64 rx_bytes; /* Number of received bytes. */
191 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
193 ovs_be64 rx_dropped; /* Number of packets dropped by RX. */
194 ovs_be64 tx_dropped; /* Number of packets dropped by TX. */
195 ovs_be64 rx_errors; /* Number of receive errors. This is a super-set
196 of more specific receive errors and should be
197 greater than or equal to the sum of all
198 rx_*_err values in properties. */
199 ovs_be64 tx_errors; /* Number of transmit errors. This is a super-set
200 of more specific transmit errors and should be
201 greater than or equal to the sum of all
202 tx_*_err values (none currently defined.) */
203 /* Followed by 0 or more OFPPSPT14_* properties. */
205 OFP_ASSERT(sizeof(struct ofp14_port_stats) == 80);
208 /* ## ----------------- ## */
209 /* ## ofp14_queue_stats ## */
210 /* ## ----------------- ## */
212 struct ofp14_queue_stats {
213 ovs_be16 length; /* Length of this entry. */
214 uint8_t pad[6]; /* Align to 64 bits. */
215 struct ofp13_queue_stats qs;
216 /* Followed by 0 or more properties (none yet defined). */
218 OFP_ASSERT(sizeof(struct ofp14_queue_stats) == 48);
221 /* ## -------------- ## */
222 /* ## Miscellaneous. ## */
223 /* ## -------------- ## */
225 /* Common header for all async config Properties */
226 struct ofp14_async_config_prop_header {
227 ovs_be16 type; /* One of OFPACPT_*. */
228 ovs_be16 length; /* Length in bytes of this property. */
230 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_header) == 4);
232 /* Asynchronous message configuration.
233 * OFPT_GET_ASYNC_REPLY or OFPT_SET_ASYNC.
235 struct ofp14_async_config {
236 struct ofp_header header;
237 /* Async config Property list - 0 or more */
238 struct ofp14_async_config_prop_header properties[0];
240 OFP_ASSERT(sizeof(struct ofp14_async_config) == 8);
242 /* Async Config property types.
243 * Low order bit cleared indicates a property for the slave role.
244 * Low order bit set indicates a property for the master/equal role.
246 enum ofp14_async_config_prop_type {
247 OFPACPT_PACKET_IN_SLAVE = 0, /* Packet-in mask for slave. */
248 OFPACPT_PACKET_IN_MASTER = 1, /* Packet-in mask for master. */
249 OFPACPT_PORT_STATUS_SLAVE = 2, /* Port-status mask for slave. */
250 OFPACPT_PORT_STATUS_MASTER = 3, /* Port-status mask for master. */
251 OFPACPT_FLOW_REMOVED_SLAVE = 4, /* Flow removed mask for slave. */
252 OFPACPT_FLOW_REMOVED_MASTER = 5, /* Flow removed mask for master. */
253 OFPACPT_ROLE_STATUS_SLAVE = 6, /* Role status mask for slave. */
254 OFPACPT_ROLE_STATUS_MASTER = 7, /* Role status mask for master. */
255 OFPACPT_TABLE_STATUS_SLAVE = 8, /* Table status mask for slave. */
256 OFPACPT_TABLE_STATUS_MASTER = 9, /* Table status mask for master. */
257 OFPACPT_REQUESTFORWARD_SLAVE = 10, /* RequestForward mask for slave. */
258 OFPACPT_REQUESTFORWARD_MASTER = 11, /* RequestForward mask for master. */
259 OFPTFPT_EXPERIMENTER_SLAVE = 0xFFFE, /* Experimenter for slave. */
260 OFPTFPT_EXPERIMENTER_MASTER = 0xFFFF, /* Experimenter for master. */
263 /* Various reason based properties */
264 struct ofp14_async_config_prop_reasons {
265 /* 'type' is one of OFPACPT_PACKET_IN_*, OFPACPT_PORT_STATUS_*,
266 * OFPACPT_FLOW_REMOVED_*, OFPACPT_ROLE_STATUS_*,
267 * OFPACPT_TABLE_STATUS_*, OFPACPT_REQUESTFORWARD_*. */
269 ovs_be16 length; /* Length in bytes of this property. */
270 ovs_be32 mask; /* Bitmasks of reason values. */
272 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_reasons) == 8);
274 /* Experimenter async config property */
275 struct ofp14_async_config_prop_experimenter {
276 ovs_be16 type; /* One of OFPTFPT_EXPERIMENTER_SLAVE,
277 OFPTFPT_EXPERIMENTER_MASTER. */
278 ovs_be16 length; /* Length in bytes of this property. */
279 ovs_be32 experimenter; /* Experimenter ID which takes the same
281 ofp_experimenter_header. */
282 ovs_be32 exp_type; /* Experimenter defined. */
284 * - Exactly (length - 12) bytes containing the experimenter data, then
285 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
286 * bytes of all-zero bytes */
288 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_experimenter) == 12);
290 /* Common header for all Role Properties */
291 struct ofp14_role_prop_header {
292 ovs_be16 type; /* One of OFPRPT_*. */
293 ovs_be16 length; /* Length in bytes of this property. */
295 OFP_ASSERT(sizeof(struct ofp14_role_prop_header) == 4);
297 /* Role status event message. */
298 struct ofp14_role_status {
299 ovs_be32 role; /* One of OFPCR_ROLE_*. */
300 uint8_t reason; /* One of OFPCRR_*. */
301 uint8_t pad[3]; /* Align to 64 bits. */
302 ovs_be64 generation_id; /* Master Election Generation Id */
304 /* Followed by a list of struct ofp14_role_prop_header */
306 OFP_ASSERT(sizeof(struct ofp14_role_status) == 16);
308 /* What changed about the controller role */
309 enum ofp14_controller_role_reason {
310 OFPCRR_MASTER_REQUEST = 0, /* Another controller asked to be master. */
311 OFPCRR_CONFIG = 1, /* Configuration changed on the switch. */
312 OFPCRR_EXPERIMENTER = 2, /* Experimenter data changed. */
315 /* Role property types.
317 enum ofp14_role_prop_type {
318 OFPRPT_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
321 /* Experimenter role property */
322 struct ofp14_role_prop_experimenter {
323 ovs_be16 type; /* One of OFPRPT_EXPERIMENTER. */
324 ovs_be16 length; /* Length in bytes of this property. */
325 ovs_be32 experimenter; /* Experimenter ID which takes the same
327 ofp_experimenter_header. */
328 ovs_be32 exp_type; /* Experimenter defined. */
330 * - Exactly (length - 12) bytes containing the experimenter data, then
331 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
332 * bytes of all-zero bytes */
334 OFP_ASSERT(sizeof(struct ofp14_role_prop_experimenter) == 12);
336 /* Bundle control message types */
337 enum ofp14_bundle_ctrl_type {
338 OFPBCT_OPEN_REQUEST = 0,
339 OFPBCT_OPEN_REPLY = 1,
340 OFPBCT_CLOSE_REQUEST = 2,
341 OFPBCT_CLOSE_REPLY = 3,
342 OFPBCT_COMMIT_REQUEST = 4,
343 OFPBCT_COMMIT_REPLY = 5,
344 OFPBCT_DISCARD_REQUEST = 6,
345 OFPBCT_DISCARD_REPLY = 7,
348 /* Bundle configuration flags. */
349 enum ofp14_bundle_flags {
350 OFPBF_ATOMIC = 1 << 0, /* Execute atomically. */
351 OFPBF_ORDERED = 1 << 1, /* Execute in specified order. */
354 /* Message structure for OFPT_BUNDLE_CONTROL and OFPT_BUNDLE_ADD_MESSAGE. */
355 struct ofp14_bundle_ctrl_msg {
356 ovs_be32 bundle_id; /* Identify the bundle. */
357 ovs_be16 type; /* OFPT_BUNDLE_CONTROL: one of OFPBCT_*.
358 * OFPT_BUNDLE_ADD_MESSAGE: not used. */
359 ovs_be16 flags; /* Bitmap of OFPBF_* flags. */
361 * - For OFPT_BUNDLE_ADD_MESSAGE only, an encapsulated OpenFlow message,
362 * beginning with an ofp_header whose xid is identical to this message's
364 * - For OFPT_BUNDLE_ADD_MESSAGE only, and only if at least one property is
365 * present, 0 to 7 bytes of padding to align on a 64-bit boundary.
366 * - Zero or more properties (see struct ofp14_bundle_prop_header). */
368 OFP_ASSERT(sizeof(struct ofp14_bundle_ctrl_msg) == 8);
370 /* Body for ofp14_multipart_request of type OFPMP_FLOW_MONITOR.
372 * The OFPMP_FLOW_MONITOR request's body consists of an array of zero or more
373 * instances of this structure. The request arranges to monitor the flows
374 * that match the specified criteria, which are interpreted in the same way as
377 * 'id' identifies a particular monitor for the purpose of allowing it to be
378 * canceled later with OFPFMC_DELETE. 'id' must be unique among
379 * existing monitors that have not already been canceled.
381 struct ofp14_flow_monitor_request {
382 ovs_be32 monitor_id; /* Controller-assigned ID for this monitor. */
383 ovs_be32 out_port; /* Required output port, if not OFPP_ANY. */
384 ovs_be32 out_group; /* Required output port, if not OFPG_ANY. */
385 ovs_be16 flags; /* OFPMF14_*. */
386 uint8_t table_id; /* One table's ID or OFPTT_ALL (all tables). */
387 uint8_t command; /* One of OFPFMC14_*. */
388 /* Followed by an ofp11_match structure. */
390 OFP_ASSERT(sizeof(struct ofp14_flow_monitor_request) == 16);
392 /* Flow monitor commands */
393 enum ofp14_flow_monitor_command {
394 OFPFMC14_ADD = 0, /* New flow monitor. */
395 OFPFMC14_MODIFY = 1, /* Modify existing flow monitor. */
396 OFPFMC14_DELETE = 2, /* Delete/cancel existing flow monitor. */
399 /* 'flags' bits in struct of_flow_monitor_request. */
400 enum ofp14_flow_monitor_flags {
401 /* When to send updates. */
402 /* Common to NX and OpenFlow 1.4 */
403 OFPFMF14_INITIAL = 1 << 0, /* Initially matching flows. */
404 OFPFMF14_ADD = 1 << 1, /* New matching flows as they are added. */
405 OFPFMF14_REMOVED = 1 << 2, /* Old matching flows as they are removed. */
406 OFPFMF14_MODIFY = 1 << 3, /* Matching flows as they are changed. */
408 /* What to include in updates. */
409 /* Common to NX and OpenFlow 1.4 */
410 OFPFMF14_INSTRUCTIONS = 1 << 4, /* If set, instructions are included. */
411 OFPFMF14_NO_ABBREV = 1 << 5, /* If set, include own changes in full. */
413 OFPFMF14_ONLY_OWN = 1 << 6, /* If set, don't include other controllers.
417 #endif /* openflow/openflow-1.4.h */