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 struct ofp14_port_mod {
100 struct eth_addr hw_addr;
102 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
103 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
104 /* Followed by 0 or more OFPPMPT14_* properties. */
106 OFP_ASSERT(sizeof(struct ofp14_port_mod) == 24);
108 /* ## --------------- ## */
109 /* ## ofp14_table_mod ## */
110 /* ## --------------- ## */
112 enum ofp14_table_mod_prop_type {
113 OFPTMPT14_EVICTION = 0x2, /* Eviction property. */
114 OFPTMPT14_VACANCY = 0x3, /* Vacancy property. */
115 OFPTMPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
118 enum ofp14_table_mod_prop_eviction_flag {
119 OFPTMPEF14_OTHER = 1 << 0, /* Using other factors. */
120 OFPTMPEF14_IMPORTANCE = 1 << 1, /* Using flow entry importance. */
121 OFPTMPEF14_LIFETIME = 1 << 2, /* Using flow entry lifetime. */
124 /* What changed about the table */
125 enum ofp14_table_reason {
126 OFPTR_VACANCY_DOWN = 3, /* Vacancy down threshold event. */
127 OFPTR_VACANCY_UP = 4, /* Vacancy up threshold event. */
128 OFPTR_N_REASONS /* Denotes number of reasons. */
131 struct ofp14_table_mod_prop_vacancy {
132 ovs_be16 type; /* OFPTMPT14_VACANCY. */
133 ovs_be16 length; /* Length in bytes of this property. */
134 uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
135 uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
136 uint8_t vacancy; /* Current vacancy (%) - only in ofp14_table_desc. */
137 uint8_t pad[1]; /* Align to 64 bits. */
139 OFP_ASSERT(sizeof(struct ofp14_table_mod_prop_vacancy) == 8);
141 struct ofp14_table_mod {
142 uint8_t table_id; /* ID of the table, OFPTT_ALL indicates all tables */
143 uint8_t pad[3]; /* Pad to 32 bits */
144 ovs_be32 config; /* Bitmap of OFPTC_* flags */
145 /* Followed by 0 or more OFPTMPT14_* properties. */
147 OFP_ASSERT(sizeof(struct ofp14_table_mod) == 8);
149 /* Body of reply to OFPMP_TABLE_DESC request. */
150 struct ofp14_table_desc {
151 ovs_be16 length; /* Length is padded to 64 bits. */
152 uint8_t table_id; /* Identifier of table. Lower numbered tables
153 are consulted first. */
154 uint8_t pad[1]; /* Align to 32-bits. */
155 ovs_be32 config; /* Bitmap of OFPTC_* values. */
156 /* Followed by 0 or more OFPTMPT14_* properties. */
158 OFP_ASSERT(sizeof(struct ofp14_table_desc) == 8);
160 /* ## ---------------- ## */
161 /* ## ofp14_port_stats ## */
162 /* ## ---------------- ## */
164 enum ofp14_port_stats_prop_type {
165 OFPPSPT14_ETHERNET = 0, /* Ethernet property. */
166 OFPPSPT14_OPTICAL = 1, /* Optical property. */
167 OFPPSPT14_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
170 struct ofp14_port_stats_prop_ethernet {
171 ovs_be16 type; /* OFPPSPT14_ETHERNET. */
172 ovs_be16 length; /* Length in bytes of this property. */
173 uint8_t pad[4]; /* Align to 64 bits. */
175 ovs_be64 rx_frame_err; /* Number of frame alignment errors. */
176 ovs_be64 rx_over_err; /* Number of packets with RX overrun. */
177 ovs_be64 rx_crc_err; /* Number of CRC errors. */
178 ovs_be64 collisions; /* Number of collisions. */
180 OFP_ASSERT(sizeof(struct ofp14_port_stats_prop_ethernet) == 40);
182 struct ofp14_port_stats {
183 ovs_be16 length; /* Length of this entry. */
184 uint8_t pad[2]; /* Align to 64 bits. */
186 ovs_be32 duration_sec; /* Time port has been alive in seconds. */
187 ovs_be32 duration_nsec; /* Time port has been alive in nanoseconds beyond
189 ovs_be64 rx_packets; /* Number of received packets. */
190 ovs_be64 tx_packets; /* Number of transmitted packets. */
191 ovs_be64 rx_bytes; /* Number of received bytes. */
192 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
194 ovs_be64 rx_dropped; /* Number of packets dropped by RX. */
195 ovs_be64 tx_dropped; /* Number of packets dropped by TX. */
196 ovs_be64 rx_errors; /* Number of receive errors. This is a super-set
197 of more specific receive errors and should be
198 greater than or equal to the sum of all
199 rx_*_err values in properties. */
200 ovs_be64 tx_errors; /* Number of transmit errors. This is a super-set
201 of more specific transmit errors and should be
202 greater than or equal to the sum of all
203 tx_*_err values (none currently defined.) */
204 /* Followed by 0 or more OFPPSPT14_* properties. */
206 OFP_ASSERT(sizeof(struct ofp14_port_stats) == 80);
209 /* ## ----------------- ## */
210 /* ## ofp14_queue_stats ## */
211 /* ## ----------------- ## */
213 struct ofp14_queue_stats {
214 ovs_be16 length; /* Length of this entry. */
215 uint8_t pad[6]; /* Align to 64 bits. */
216 struct ofp13_queue_stats qs;
217 /* Followed by 0 or more properties (none yet defined). */
219 OFP_ASSERT(sizeof(struct ofp14_queue_stats) == 48);
222 /* ## -------------- ## */
223 /* ## Miscellaneous. ## */
224 /* ## -------------- ## */
226 /* Common header for all async config Properties */
227 struct ofp14_async_config_prop_header {
228 ovs_be16 type; /* One of OFPACPT_*. */
229 ovs_be16 length; /* Length in bytes of this property. */
231 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_header) == 4);
232 /* Request forward reason */
233 enum ofp14_requestforward_reason {
234 OFPRFR_GROUP_MOD = 0, /* Forward group mod requests. */
235 OFPRFR_METER_MOD = 1, /* Forward meter mod requests. */
236 OFPRFR_N_REASONS /* Denotes number of reasons. */
239 /* Async Config property types.
240 * Low order bit cleared indicates a property for the slave role.
241 * Low order bit set indicates a property for the master/equal role.
243 enum ofp14_async_config_prop_type {
244 OFPACPT_PACKET_IN_SLAVE = 0, /* Packet-in mask for slave. */
245 OFPACPT_PACKET_IN_MASTER = 1, /* Packet-in mask for master. */
246 OFPACPT_PORT_STATUS_SLAVE = 2, /* Port-status mask for slave. */
247 OFPACPT_PORT_STATUS_MASTER = 3, /* Port-status mask for master. */
248 OFPACPT_FLOW_REMOVED_SLAVE = 4, /* Flow removed mask for slave. */
249 OFPACPT_FLOW_REMOVED_MASTER = 5, /* Flow removed mask for master. */
250 OFPACPT_ROLE_STATUS_SLAVE = 6, /* Role status mask for slave. */
251 OFPACPT_ROLE_STATUS_MASTER = 7, /* Role status mask for master. */
252 OFPACPT_TABLE_STATUS_SLAVE = 8, /* Table status mask for slave. */
253 OFPACPT_TABLE_STATUS_MASTER = 9, /* Table status mask for master. */
254 OFPACPT_REQUESTFORWARD_SLAVE = 10, /* RequestForward mask for slave. */
255 OFPACPT_REQUESTFORWARD_MASTER = 11, /* RequestForward mask for master. */
256 OFPTFPT_EXPERIMENTER_SLAVE = 0xFFFE, /* Experimenter for slave. */
257 OFPTFPT_EXPERIMENTER_MASTER = 0xFFFF, /* Experimenter for master. */
260 /* Experimenter async config property */
261 struct ofp14_async_config_prop_experimenter {
262 ovs_be16 type; /* One of OFPTFPT_EXPERIMENTER_SLAVE,
263 OFPTFPT_EXPERIMENTER_MASTER. */
264 ovs_be16 length; /* Length in bytes of this property. */
265 ovs_be32 experimenter; /* Experimenter ID which takes the same
267 ofp_experimenter_header. */
268 ovs_be32 exp_type; /* Experimenter defined. */
270 * - Exactly (length - 12) bytes containing the experimenter data, then
271 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
272 * bytes of all-zero bytes */
274 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_experimenter) == 12);
276 /* Common header for all Role Properties */
277 struct ofp14_role_prop_header {
278 ovs_be16 type; /* One of OFPRPT_*. */
279 ovs_be16 length; /* Length in bytes of this property. */
281 OFP_ASSERT(sizeof(struct ofp14_role_prop_header) == 4);
283 /* Role status event message. */
284 struct ofp14_role_status {
285 ovs_be32 role; /* One of OFPCR_ROLE_*. */
286 uint8_t reason; /* One of OFPCRR_*. */
287 uint8_t pad[3]; /* Align to 64 bits. */
288 ovs_be64 generation_id; /* Master Election Generation Id */
290 /* Followed by a list of struct ofp14_role_prop_header */
292 OFP_ASSERT(sizeof(struct ofp14_role_status) == 16);
294 /* What changed about the controller role */
295 enum ofp14_controller_role_reason {
296 OFPCRR_MASTER_REQUEST = 0, /* Another controller asked to be master. */
297 OFPCRR_CONFIG = 1, /* Configuration changed on the switch. */
298 OFPCRR_EXPERIMENTER = 2, /* Experimenter data changed. */
299 OFPCRR_N_REASONS /* Denotes number of reasons. */
302 /* Role property types.
304 enum ofp14_role_prop_type {
305 OFPRPT_EXPERIMENTER = 0xFFFF, /* Experimenter property. */
308 /* Experimenter role property */
309 struct ofp14_role_prop_experimenter {
310 ovs_be16 type; /* One of OFPRPT_EXPERIMENTER. */
311 ovs_be16 length; /* Length in bytes of this property. */
312 ovs_be32 experimenter; /* Experimenter ID which takes the same
314 ofp_experimenter_header. */
315 ovs_be32 exp_type; /* Experimenter defined. */
317 * - Exactly (length - 12) bytes containing the experimenter data, then
318 * - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
319 * bytes of all-zero bytes */
321 OFP_ASSERT(sizeof(struct ofp14_role_prop_experimenter) == 12);
323 /* Group/Meter request forwarding. */
324 struct ofp14_requestforward {
325 struct ofp_header request; /* Request being forwarded. */
327 OFP_ASSERT(sizeof(struct ofp14_requestforward) == 8);
329 /* Bundle control message types */
330 enum ofp14_bundle_ctrl_type {
331 OFPBCT_OPEN_REQUEST = 0,
332 OFPBCT_OPEN_REPLY = 1,
333 OFPBCT_CLOSE_REQUEST = 2,
334 OFPBCT_CLOSE_REPLY = 3,
335 OFPBCT_COMMIT_REQUEST = 4,
336 OFPBCT_COMMIT_REPLY = 5,
337 OFPBCT_DISCARD_REQUEST = 6,
338 OFPBCT_DISCARD_REPLY = 7,
341 /* Bundle configuration flags. */
342 enum ofp14_bundle_flags {
343 OFPBF_ATOMIC = 1 << 0, /* Execute atomically. */
344 OFPBF_ORDERED = 1 << 1, /* Execute in specified order. */
347 /* Message structure for OFPT_BUNDLE_CONTROL and OFPT_BUNDLE_ADD_MESSAGE. */
348 struct ofp14_bundle_ctrl_msg {
349 ovs_be32 bundle_id; /* Identify the bundle. */
350 ovs_be16 type; /* OFPT_BUNDLE_CONTROL: one of OFPBCT_*.
351 * OFPT_BUNDLE_ADD_MESSAGE: not used. */
352 ovs_be16 flags; /* Bitmap of OFPBF_* flags. */
354 * - For OFPT_BUNDLE_ADD_MESSAGE only, an encapsulated OpenFlow message,
355 * beginning with an ofp_header whose xid is identical to this message's
357 * - For OFPT_BUNDLE_ADD_MESSAGE only, and only if at least one property is
358 * present, 0 to 7 bytes of padding to align on a 64-bit boundary.
359 * - Zero or more properties (see struct ofp14_bundle_prop_header). */
361 OFP_ASSERT(sizeof(struct ofp14_bundle_ctrl_msg) == 8);
363 /* Body for ofp14_multipart_request of type OFPMP_FLOW_MONITOR.
365 * The OFPMP_FLOW_MONITOR request's body consists of an array of zero or more
366 * instances of this structure. The request arranges to monitor the flows
367 * that match the specified criteria, which are interpreted in the same way as
370 * 'id' identifies a particular monitor for the purpose of allowing it to be
371 * canceled later with OFPFMC_DELETE. 'id' must be unique among
372 * existing monitors that have not already been canceled.
374 struct ofp14_flow_monitor_request {
375 ovs_be32 monitor_id; /* Controller-assigned ID for this monitor. */
376 ovs_be32 out_port; /* Required output port, if not OFPP_ANY. */
377 ovs_be32 out_group; /* Required output port, if not OFPG_ANY. */
378 ovs_be16 flags; /* OFPMF14_*. */
379 uint8_t table_id; /* One table's ID or OFPTT_ALL (all tables). */
380 uint8_t command; /* One of OFPFMC14_*. */
381 /* Followed by an ofp11_match structure. */
383 OFP_ASSERT(sizeof(struct ofp14_flow_monitor_request) == 16);
385 /* Flow monitor commands */
386 enum ofp14_flow_monitor_command {
387 OFPFMC14_ADD = 0, /* New flow monitor. */
388 OFPFMC14_MODIFY = 1, /* Modify existing flow monitor. */
389 OFPFMC14_DELETE = 2, /* Delete/cancel existing flow monitor. */
392 /* 'flags' bits in struct of_flow_monitor_request. */
393 enum ofp14_flow_monitor_flags {
394 /* When to send updates. */
395 /* Common to NX and OpenFlow 1.4 */
396 OFPFMF14_INITIAL = 1 << 0, /* Initially matching flows. */
397 OFPFMF14_ADD = 1 << 1, /* New matching flows as they are added. */
398 OFPFMF14_REMOVED = 1 << 2, /* Old matching flows as they are removed. */
399 OFPFMF14_MODIFY = 1 << 3, /* Matching flows as they are changed. */
401 /* What to include in updates. */
402 /* Common to NX and OpenFlow 1.4 */
403 OFPFMF14_INSTRUCTIONS = 1 << 4, /* If set, instructions are included. */
404 OFPFMF14_NO_ABBREV = 1 << 5, /* If set, include own changes in full. */
406 OFPFMF14_ONLY_OWN = 1 << 6, /* If set, don't include other controllers.
410 #endif /* openflow/openflow-1.4.h */