1 /* Copyright (c) 2008, 2011, 2012 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 Nicira, Inc.
37 * Licensed under the Apache License, Version 2.0 (the "License");
38 * you may not use this file except in compliance with the License.
39 * You may obtain a copy of the License at:
41 * http://www.apache.org/licenses/LICENSE-2.0
43 * Unless required by applicable law or agreed to in writing, software
44 * distributed under the License is distributed on an "AS IS" BASIS,
45 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
46 * See the License for the specific language governing permissions and
47 * limitations under the License.
50 /* OpenFlow: protocol between controller and datapath. */
53 #define OPENFLOW_11_H 1
55 #include "openflow/openflow-common.h"
57 /* OpenFlow 1.1 uses 32-bit port numbers. Open vSwitch, for now, uses OpenFlow
58 * 1.0 port numbers internally. We map them to OpenFlow 1.0 as follows:
61 * ----------------------- ---------------
62 * 0x00000000...0x0000feff <=> 0x0000...0xfeff "physical" ports
63 * 0x0000ff00...0xfffffeff <=> not supported
64 * 0xffffff00...0xffffffff <=> 0xff00...0xffff "reserved" OFPP_* ports
66 * OFPP11_OFFSET is the value that must be added or subtracted to convert
67 * an OpenFlow 1.0 reserved port number to or from, respectively, the
68 * corresponding OpenFlow 1.1 reserved port number.
70 #define OFPP11_MAX 0xffffff00
71 #define OFPP11_OFFSET (OFPP11_MAX - OFPP_MAX)
73 /* Reserved wildcard port used only for flow mod (delete) and flow stats
74 * requests. Selects all flows regardless of output port
75 * (including flows with no output port)
77 * Define it via OFPP_NONE (0xFFFF) so that OFPP_ANY is still an enum ofp_port
79 #define OFPP_ANY OFPP_NONE
81 /* OpenFlow 1.1 port config flags are just the common flags. */
83 (OFPPC_PORT_DOWN | OFPPC_NO_RECV | OFPPC_NO_FWD | OFPPC_NO_PACKET_IN)
85 /* OpenFlow 1.1 specific current state of the physical port. These are not
86 * configurable from the controller.
88 enum ofp11_port_state {
89 OFPPS11_BLOCKED = 1 << 1, /* Port is blocked */
90 OFPPS11_LIVE = 1 << 2, /* Live for Fast Failover Group. */
91 #define OFPPS11_ALL (OFPPS_LINK_DOWN | OFPPS11_BLOCKED | OFPPS11_LIVE)
94 /* OpenFlow 1.1 specific features of ports available in a datapath. */
95 enum ofp11_port_features {
96 OFPPF11_40GB_FD = 1 << 7, /* 40 Gb full-duplex rate support. */
97 OFPPF11_100GB_FD = 1 << 8, /* 100 Gb full-duplex rate support. */
98 OFPPF11_1TB_FD = 1 << 9, /* 1 Tb full-duplex rate support. */
99 OFPPF11_OTHER = 1 << 10, /* Other rate, not in the list. */
101 OFPPF11_COPPER = 1 << 11, /* Copper medium. */
102 OFPPF11_FIBER = 1 << 12, /* Fiber medium. */
103 OFPPF11_AUTONEG = 1 << 13, /* Auto-negotiation. */
104 OFPPF11_PAUSE = 1 << 14, /* Pause. */
105 OFPPF11_PAUSE_ASYM = 1 << 15 /* Asymmetric pause. */
106 #define OFPPF11_ALL ((1 << 16) - 1)
109 /* Description of a port */
113 uint8_t hw_addr[OFP_ETH_ALEN];
114 uint8_t pad2[2]; /* Align to 64 bits. */
115 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
117 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
118 ovs_be32 state; /* Bitmap of OFPPS_* and OFPPS11_* flags. */
120 /* Bitmaps of OFPPF_* and OFPPF11_* that describe features. All bits
121 * zeroed if unsupported or unavailable. */
122 ovs_be32 curr; /* Current features. */
123 ovs_be32 advertised; /* Features being advertised by the port. */
124 ovs_be32 supported; /* Features supported by the port. */
125 ovs_be32 peer; /* Features advertised by peer. */
127 ovs_be32 curr_speed; /* Current port bitrate in kbps. */
128 ovs_be32 max_speed; /* Max port bitrate in kbps */
131 /* Modify behavior of the physical port */
132 struct ofp11_port_mod {
135 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
136 configurable. This is used to
137 sanity-check the request, so it must
138 be the same as returned in an
139 ofp11_port struct. */
140 uint8_t pad2[2]; /* Pad to 64 bits. */
141 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
142 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
144 ovs_be32 advertise; /* Bitmap of OFPPF_* and OFPPF11_*. Zero all bits
145 to prevent any action taking place. */
146 uint8_t pad3[4]; /* Pad to 64 bits. */
148 OFP_ASSERT(sizeof(struct ofp11_port_mod) == 32);
150 /* Group setup and teardown (controller -> datapath). */
151 struct ofp11_group_mod {
152 ovs_be16 command; /* One of OFPGC_*. */
153 uint8_t type; /* One of OFPGT_*. */
154 uint8_t pad; /* Pad to 64 bits. */
155 ovs_be32 group_id; /* Group identifier. */
156 /* struct ofp11_bucket buckets[0]; The bucket length is inferred from the
157 length field in the header. */
159 OFP_ASSERT(sizeof(struct ofp11_group_mod) == 8);
161 /* Query for port queue configuration. */
162 struct ofp11_queue_get_config_request {
164 /* Port to be queried. Should refer
165 to a valid physical port (i.e. < OFPP_MAX) */
168 OFP_ASSERT(sizeof(struct ofp11_queue_get_config_request) == 8);
171 enum ofp11_group_mod_command {
172 OFPGC11_ADD, /* New group. */
173 OFPGC11_MODIFY, /* Modify all matching groups. */
174 OFPGC11_DELETE, /* Delete all matching groups. */
177 /* OpenFlow 1.1 specific capabilities supported by the datapath (struct
178 * ofp_switch_features, member capabilities). */
179 enum ofp11_capabilities {
180 OFPC11_GROUP_STATS = 1 << 3, /* Group statistics. */
183 enum ofp11_action_type {
184 OFPAT11_OUTPUT, /* Output to switch port. */
185 OFPAT11_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
186 OFPAT11_SET_VLAN_PCP, /* Set the 802.1q priority. */
187 OFPAT11_SET_DL_SRC, /* Ethernet source address. */
188 OFPAT11_SET_DL_DST, /* Ethernet destination address. */
189 OFPAT11_SET_NW_SRC, /* IP source address. */
190 OFPAT11_SET_NW_DST, /* IP destination address. */
191 OFPAT11_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
192 OFPAT11_SET_NW_ECN, /* IP ECN (2 bits). */
193 OFPAT11_SET_TP_SRC, /* TCP/UDP/SCTP source port. */
194 OFPAT11_SET_TP_DST, /* TCP/UDP/SCTP destination port. */
195 OFPAT11_COPY_TTL_OUT, /* Copy TTL "outwards" -- from next-to-outermost
197 OFPAT11_COPY_TTL_IN, /* Copy TTL "inwards" -- from outermost to
199 OFPAT11_SET_MPLS_LABEL, /* MPLS label */
200 OFPAT11_SET_MPLS_TC, /* MPLS TC */
201 OFPAT11_SET_MPLS_TTL, /* MPLS TTL */
202 OFPAT11_DEC_MPLS_TTL, /* Decrement MPLS TTL */
204 OFPAT11_PUSH_VLAN, /* Push a new VLAN tag */
205 OFPAT11_POP_VLAN, /* Pop the outer VLAN tag */
206 OFPAT11_PUSH_MPLS, /* Push a new MPLS tag */
207 OFPAT11_POP_MPLS, /* Pop the outer MPLS tag */
208 OFPAT11_SET_QUEUE, /* Set queue id when outputting to a port */
209 OFPAT11_GROUP, /* Apply group. */
210 OFPAT11_SET_NW_TTL, /* IP TTL. */
211 OFPAT11_DEC_NW_TTL, /* Decrement IP TTL. */
212 OFPAT11_EXPERIMENTER = 0xffff
215 #define OFPMT11_STANDARD_LENGTH 88
217 struct ofp11_match_header {
218 ovs_be16 type; /* One of OFPMT_* */
219 ovs_be16 length; /* Length of match */
221 OFP_ASSERT(sizeof(struct ofp11_match_header) == 4);
223 /* Fields to match against flows */
225 struct ofp11_match_header omh;
226 ovs_be32 in_port; /* Input switch port. */
227 ovs_be32 wildcards; /* Wildcard fields. */
228 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
229 uint8_t dl_src_mask[OFP_ETH_ALEN]; /* Ethernet source address mask. */
230 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
231 uint8_t dl_dst_mask[OFP_ETH_ALEN]; /* Ethernet destination address mask. */
232 ovs_be16 dl_vlan; /* Input VLAN id. */
233 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
234 uint8_t pad1[1]; /* Align to 32-bits */
235 ovs_be16 dl_type; /* Ethernet frame type. */
236 uint8_t nw_tos; /* IP ToS (actually DSCP field, 6 bits). */
237 uint8_t nw_proto; /* IP protocol or lower 8 bits of ARP opcode. */
238 ovs_be32 nw_src; /* IP source address. */
239 ovs_be32 nw_src_mask; /* IP source address mask. */
240 ovs_be32 nw_dst; /* IP destination address. */
241 ovs_be32 nw_dst_mask; /* IP destination address mask. */
242 ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */
243 ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port. */
244 ovs_be32 mpls_label; /* MPLS label. */
245 uint8_t mpls_tc; /* MPLS TC. */
246 uint8_t pad2[3]; /* Align to 64-bits */
247 ovs_be64 metadata; /* Metadata passed between tables. */
248 ovs_be64 metadata_mask; /* Mask for metadata. */
250 OFP_ASSERT(sizeof(struct ofp11_match) == OFPMT11_STANDARD_LENGTH);
252 /* Flow wildcards. */
253 enum ofp11_flow_wildcards {
254 OFPFW11_IN_PORT = 1 << 0, /* Switch input port. */
255 OFPFW11_DL_VLAN = 1 << 1, /* VLAN id. */
256 OFPFW11_DL_VLAN_PCP = 1 << 2, /* VLAN priority. */
257 OFPFW11_DL_TYPE = 1 << 3, /* Ethernet frame type. */
258 OFPFW11_NW_TOS = 1 << 4, /* IP ToS (DSCP field, 6 bits). */
259 OFPFW11_NW_PROTO = 1 << 5, /* IP protocol. */
260 OFPFW11_TP_SRC = 1 << 6, /* TCP/UDP/SCTP source port. */
261 OFPFW11_TP_DST = 1 << 7, /* TCP/UDP/SCTP destination port. */
262 OFPFW11_MPLS_LABEL = 1 << 8, /* MPLS label. */
263 OFPFW11_MPLS_TC = 1 << 9, /* MPLS TC. */
265 /* Wildcard all fields. */
266 OFPFW11_ALL = ((1 << 10) - 1)
269 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
270 * special conditions.
273 OFPVID11_ANY = 0xfffe, /* Indicate that a VLAN id is set but don't care
274 about it's value. Note: only valid when
275 specifying the VLAN id in a match */
276 OFPVID11_NONE = 0xffff, /* No VLAN id was set. */
279 enum ofp11_instruction_type {
280 OFPIT11_GOTO_TABLE = 1, /* Setup the next table in the lookup
282 OFPIT11_WRITE_METADATA = 2, /* Setup the metadata field for use later
284 OFPIT11_WRITE_ACTIONS = 3, /* Write the action(s) onto the datapath
286 OFPIT11_APPLY_ACTIONS = 4, /* Applies the action(s) immediately */
287 OFPIT11_CLEAR_ACTIONS = 5, /* Clears all actions from the datapath
289 OFPIT11_EXPERIMENTER = 0xFFFF /* Experimenter instruction */
292 #define OFPIT11_ALL (OFPIT11_GOTO_TABLE | OFPIT11_WRITE_METADATA | \
293 OFPIT11_WRITE_ACTIONS | OFPIT11_APPLY_ACTIONS | \
294 OFPIT11_CLEAR_ACTIONS)
296 #define OFP11_INSTRUCTION_ALIGN 8
298 /* Generic ofp_instruction structure. */
299 struct ofp11_instruction {
300 ovs_be16 type; /* Instruction type */
301 ovs_be16 len; /* Length of this struct in bytes. */
302 uint8_t pad[4]; /* Align to 64-bits */
304 OFP_ASSERT(sizeof(struct ofp11_instruction) == 8);
306 /* Instruction structure for OFPIT_GOTO_TABLE */
307 struct ofp11_instruction_goto_table {
308 ovs_be16 type; /* OFPIT_GOTO_TABLE */
309 ovs_be16 len; /* Length of this struct in bytes. */
310 uint8_t table_id; /* Set next table in the lookup pipeline */
311 uint8_t pad[3]; /* Pad to 64 bits. */
313 OFP_ASSERT(sizeof(struct ofp11_instruction_goto_table) == 8);
315 /* Instruction structure for OFPIT_WRITE_METADATA */
316 struct ofp11_instruction_write_metadata {
317 ovs_be16 type; /* OFPIT_WRITE_METADATA */
318 ovs_be16 len; /* Length of this struct in bytes. */
319 uint8_t pad[4]; /* Align to 64-bits */
320 ovs_be64 metadata; /* Metadata value to write */
321 ovs_be64 metadata_mask; /* Metadata write bitmask */
323 OFP_ASSERT(sizeof(struct ofp11_instruction_write_metadata) == 24);
325 /* Instruction structure for OFPIT_WRITE/APPLY/CLEAR_ACTIONS */
326 struct ofp11_instruction_actions {
327 ovs_be16 type; /* One of OFPIT_*_ACTIONS */
328 ovs_be16 len; /* Length of this struct in bytes. */
329 uint8_t pad[4]; /* Align to 64-bits */
330 /* struct ofp_action_header actions[0]; Actions associated with
331 OFPIT_WRITE_ACTIONS and
332 OFPIT_APPLY_ACTIONS */
334 OFP_ASSERT(sizeof(struct ofp11_instruction_actions) == 8);
336 /* Instruction structure for experimental instructions */
337 struct ofp11_instruction_experimenter {
338 ovs_be16 type; /* OFPIT11_EXPERIMENTER */
339 ovs_be16 len; /* Length of this struct in bytes */
340 ovs_be32 experimenter; /* Experimenter ID which takes the same form
341 as in struct ofp_vendor_header. */
342 /* Experimenter-defined arbitrary additional data. */
344 OFP_ASSERT(sizeof(struct ofp11_instruction_experimenter) == 8);
346 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
347 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
348 * number of bytes to send. A 'max_len' of zero means no bytes of the
349 * packet should be sent.*/
350 struct ofp11_action_output {
351 ovs_be16 type; /* OFPAT11_OUTPUT. */
352 ovs_be16 len; /* Length is 16. */
353 ovs_be32 port; /* Output port. */
354 ovs_be16 max_len; /* Max length to send to controller. */
355 uint8_t pad[6]; /* Pad to 64 bits. */
357 OFP_ASSERT(sizeof(struct ofp11_action_output) == 16);
359 /* Action structure for OFPAT_GROUP. */
360 struct ofp11_action_group {
361 ovs_be16 type; /* OFPAT11_GROUP. */
362 ovs_be16 len; /* Length is 8. */
363 ovs_be32 group_id; /* Group identifier. */
365 OFP_ASSERT(sizeof(struct ofp11_action_group) == 8);
367 /* OFPAT_SET_QUEUE action struct: send packets to given queue on port. */
368 struct ofp11_action_set_queue {
369 ovs_be16 type; /* OFPAT11_SET_QUEUE. */
370 ovs_be16 len; /* Len is 8. */
371 ovs_be32 queue_id; /* Queue id for the packets. */
373 OFP_ASSERT(sizeof(struct ofp11_action_set_queue) == 8);
375 /* Action structure for OFPAT11_SET_MPLS_LABEL. */
376 struct ofp11_action_mpls_label {
377 ovs_be16 type; /* OFPAT11_SET_MPLS_LABEL. */
378 ovs_be16 len; /* Length is 8. */
379 ovs_be32 mpls_label; /* MPLS label */
381 OFP_ASSERT(sizeof(struct ofp11_action_mpls_label) == 8);
383 /* Action structure for OFPAT11_SET_MPLS_TC. */
384 struct ofp11_action_mpls_tc {
385 ovs_be16 type; /* OFPAT11_SET_MPLS_TC. */
386 ovs_be16 len; /* Length is 8. */
387 uint8_t mpls_tc; /* MPLS TC */
390 OFP_ASSERT(sizeof(struct ofp11_action_mpls_tc) == 8);
392 /* Action structure for OFPAT11_SET_MPLS_TTL. */
393 struct ofp11_action_mpls_ttl {
394 ovs_be16 type; /* OFPAT11_SET_MPLS_TTL. */
395 ovs_be16 len; /* Length is 8. */
396 uint8_t mpls_ttl; /* MPLS TTL */
399 OFP_ASSERT(sizeof(struct ofp11_action_mpls_ttl) == 8);
401 /* Action structure for OFPAT11_SET_NW_ECN. */
402 struct ofp11_action_nw_ecn {
403 ovs_be16 type; /* OFPAT11_SET_TW_SRC/DST. */
404 ovs_be16 len; /* Length is 8. */
405 uint8_t nw_ecn; /* IP ECN (2 bits). */
408 OFP_ASSERT(sizeof(struct ofp11_action_nw_ecn) == 8);
410 /* Action structure for OFPAT11_SET_NW_TTL. */
411 struct ofp11_action_nw_ttl {
412 ovs_be16 type; /* OFPAT11_SET_NW_TTL. */
413 ovs_be16 len; /* Length is 8. */
414 uint8_t nw_ttl; /* IP TTL */
417 OFP_ASSERT(sizeof(struct ofp11_action_nw_ttl) == 8);
419 /* Action structure for OFPAT11_PUSH_VLAN/MPLS. */
420 struct ofp11_action_push {
421 ovs_be16 type; /* OFPAT11_PUSH_VLAN/MPLS. */
422 ovs_be16 len; /* Length is 8. */
423 ovs_be16 ethertype; /* Ethertype */
426 OFP_ASSERT(sizeof(struct ofp11_action_push) == 8);
428 /* Action structure for OFPAT11_POP_MPLS. */
429 struct ofp11_action_pop_mpls {
430 ovs_be16 type; /* OFPAT11_POP_MPLS. */
431 ovs_be16 len; /* Length is 8. */
432 ovs_be16 ethertype; /* Ethertype */
435 OFP_ASSERT(sizeof(struct ofp11_action_pop_mpls) == 8);
437 /* Configure/Modify behavior of a flow table */
438 struct ofp11_table_mod {
439 uint8_t table_id; /* ID of the table, 0xFF indicates all tables */
440 uint8_t pad[3]; /* Pad to 32 bits */
441 ovs_be32 config; /* Bitmap of OFPTC_* flags */
443 OFP_ASSERT(sizeof(struct ofp11_table_mod) == 8);
445 /* Flags to indicate behavior of the flow table for unmatched packets.
446 These flags are used in ofp_table_stats messages to describe the current
447 configuration and in ofp_table_mod messages to configure table behavior. */
448 enum ofp11_table_config {
449 OFPTC11_TABLE_MISS_CONTROLLER = 0, /* Send to controller. */
450 OFPTC11_TABLE_MISS_CONTINUE = 1 << 0, /* Continue to the next table in the
451 pipeline (OpenFlow 1.0
453 OFPTC11_TABLE_MISS_DROP = 1 << 1, /* Drop the packet. */
454 OFPTC11_TABLE_MISS_MASK = 3
457 /* Flow setup and teardown (controller -> datapath). */
458 struct ofp11_flow_mod {
459 ovs_be64 cookie; /* Opaque controller-issued identifier. */
460 ovs_be64 cookie_mask; /* Mask used to restrict the cookie bits
461 that must match when the command is
462 OFPFC_MODIFY* or OFPFC_DELETE*. A value
463 of 0 indicates no restriction. */
465 uint8_t table_id; /* ID of the table to put the flow in */
466 uint8_t command; /* One of OFPFC_*. */
467 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
468 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
469 ovs_be16 priority; /* Priority level of flow entry. */
470 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
471 Not meaningful for OFPFC_DELETE*. */
472 ovs_be32 out_port; /* For OFPFC_DELETE* commands, require
473 matching entries to include this as an
474 output port. A value of OFPP_ANY
475 indicates no restriction. */
476 ovs_be32 out_group; /* For OFPFC_DELETE* commands, require
477 matching entries to include this as an
478 output group. A value of OFPG11_ANY
479 indicates no restriction. */
480 ovs_be16 flags; /* One of OFPFF_*. */
482 /* Followed by an ofp11_match structure. */
483 /* Followed by an instruction set. */
485 OFP_ASSERT(sizeof(struct ofp11_flow_mod) == 40);
487 /* Group types. Values in the range [128, 255] are reserved for experimental
489 enum ofp11_group_type {
490 OFPGT11_ALL, /* All (multicast/broadcast) group. */
491 OFPGT11_SELECT, /* Select group. */
492 OFPGT11_INDIRECT, /* Indirect group. */
493 OFPGT11_FF /* Fast failover group. */
496 /* Group numbering. Groups can use any number up to OFPG_MAX. */
498 /* Last usable group number. */
499 OFPG11_MAX = 0xffffff00,
502 OFPG11_ALL = 0xfffffffc, /* Represents all groups for group delete
504 OFPG11_ANY = 0xffffffff /* Wildcard group used only for flow stats
505 requests. Selects all flows regardless
506 of group (including flows with no
510 /* Bucket for use in groups. */
511 struct ofp11_bucket {
512 ovs_be16 len; /* Length the bucket in bytes, including
513 this header and any padding to make it
515 ovs_be16 weight; /* Relative weight of bucket. Only
516 defined for select groups. */
517 ovs_be32 watch_port; /* Port whose state affects whether this
518 bucket is live. Only required for fast
520 ovs_be32 watch_group; /* Group whose state affects whether this
521 bucket is live. Only required for fast
524 /* struct ofp_action_header actions[0]; The action length is inferred
525 from the length field in the
528 OFP_ASSERT(sizeof(struct ofp11_bucket) == 16);
530 /* Queue configuration for a given port. */
531 struct ofp11_queue_get_config_reply {
534 /* struct ofp_packet_queue queues[0]; List of configured queues. */
536 OFP_ASSERT(sizeof(struct ofp11_queue_get_config_reply) == 8);
538 struct ofp11_stats_msg {
539 struct ofp_header header;
540 ovs_be16 type; /* One of the OFPST_* constants. */
541 ovs_be16 flags; /* OFPSF_REQ_* flags (none yet defined). */
543 /* Followed by the body of the request. */
545 OFP_ASSERT(sizeof(struct ofp11_stats_msg) == 16);
547 /* Vendor extension stats message. */
548 struct ofp11_vendor_stats_msg {
549 struct ofp11_stats_msg osm; /* Type OFPST_VENDOR. */
550 ovs_be32 vendor; /* Vendor ID:
551 * - MSB 0: low-order bytes are IEEE OUI.
552 * - MSB != 0: defined by OpenFlow
554 /* Followed by vendor-defined arbitrary additional data. */
556 OFP_ASSERT(sizeof(struct ofp11_vendor_stats_msg) == 20);
558 /* Stats request of type OFPST_FLOW. */
559 struct ofp11_flow_stats_request {
560 uint8_t table_id; /* ID of table to read (from ofp_table_stats),
561 0xff for all tables. */
562 uint8_t pad[3]; /* Align to 64 bits. */
563 ovs_be32 out_port; /* Require matching entries to include this
564 as an output port. A value of OFPP_ANY
565 indicates no restriction. */
566 ovs_be32 out_group; /* Require matching entries to include this
567 as an output group. A value of OFPG11_ANY
568 indicates no restriction. */
569 uint8_t pad2[4]; /* Align to 64 bits. */
570 ovs_be64 cookie; /* Require matching entries to contain this
572 ovs_be64 cookie_mask; /* Mask used to restrict the cookie bits that
573 must match. A value of 0 indicates
575 /* Followed by an ofp11_match structure. */
577 OFP_ASSERT(sizeof(struct ofp11_flow_stats_request) == 32);
579 /* Body of reply to OFPST_FLOW request. */
580 struct ofp11_flow_stats {
581 ovs_be16 length; /* Length of this entry. */
582 uint8_t table_id; /* ID of table flow came from. */
584 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
585 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds beyond
587 ovs_be16 priority; /* Priority of the entry. Only meaningful
588 when this is not an exact-match entry. */
589 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
590 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
591 uint8_t pad2[6]; /* Align to 64-bits. */
592 ovs_be64 cookie; /* Opaque controller-issued identifier. */
593 ovs_be64 packet_count; /* Number of packets in flow. */
594 ovs_be64 byte_count; /* Number of bytes in flow. */
595 /* Open Flow version specific match */
596 /* struct ofp11_instruction instructions[0]; Instruction set. */
598 OFP_ASSERT(sizeof(struct ofp11_flow_stats) == 48);
600 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
601 /* Identical to ofp11_flow_stats_request */
603 /* Flow match fields. */
604 enum ofp11_flow_match_fields {
605 OFPFMF11_IN_PORT = 1 << 0, /* Switch input port. */
606 OFPFMF11_DL_VLAN = 1 << 1, /* VLAN id. */
607 OFPFMF11_DL_VLAN_PCP = 1 << 2, /* VLAN priority. */
608 OFPFMF11_DL_TYPE = 1 << 3, /* Ethernet frame type. */
609 OFPFMF11_NW_TOS = 1 << 4, /* IP ToS (DSCP field, 6 bits). */
610 OFPFMF11_NW_PROTO = 1 << 5, /* IP protocol. */
611 OFPFMF11_TP_SRC = 1 << 6, /* TCP/UDP/SCTP source port. */
612 OFPFMF11_TP_DST = 1 << 7, /* TCP/UDP/SCTP destination port. */
613 OFPFMF11_MPLS_LABEL = 1 << 8, /* MPLS label. */
614 OFPFMF11_MPLS_TC = 1 << 9, /* MPLS TC. */
615 OFPFMF11_TYPE = 1 << 10, /* Match type. */
616 OFPFMF11_DL_SRC = 1 << 11, /* Ethernet source address. */
617 OFPFMF11_DL_DST = 1 << 12, /* Ethernet destination address. */
618 OFPFMF11_NW_SRC = 1 << 13, /* IP source address. */
619 OFPFMF11_NW_DST = 1 << 14, /* IP destination address. */
620 OFPFMF11_METADATA = 1 << 15, /* Metadata passed between tables. */
623 /* Body of reply to OFPST_TABLE request. */
624 struct ofp11_table_stats {
625 uint8_t table_id; /* Identifier of table. Lower numbered tables
626 are consulted first. */
627 uint8_t pad[7]; /* Align to 64-bits. */
628 char name[OFP_MAX_TABLE_NAME_LEN];
629 ovs_be32 wildcards; /* Bitmap of OFPFMF_* wildcards that are
630 supported by the table. */
631 ovs_be32 match; /* Bitmap of OFPFMF_* that indicate the fields
632 the table can match on. */
633 ovs_be32 instructions; /* Bitmap of OFPIT_* values supported. */
634 ovs_be32 write_actions; /* Bitmap of OFPAT_* that are supported
635 by the table with OFPIT_WRITE_ACTIONS. */
636 ovs_be32 apply_actions; /* Bitmap of OFPAT_* that are supported
637 by the table with OFPIT_APPLY_ACTIONS. */
638 ovs_be32 config; /* Bitmap of OFPTC_* values */
639 ovs_be32 max_entries; /* Max number of entries supported. */
640 ovs_be32 active_count; /* Number of active entries. */
641 ovs_be64 lookup_count; /* Number of packets looked up in table. */
642 ovs_be64 matched_count; /* Number of packets that hit table. */
644 OFP_ASSERT(sizeof(struct ofp11_table_stats) == 88);
646 /* Body for ofp_stats_request of type OFPST_PORT. */
647 struct ofp11_port_stats_request {
648 ovs_be32 port_no; /* OFPST_PORT message must request statistics
649 * either for a single port (specified in
650 * port_no) or for all ports (if port_no ==
654 OFP_ASSERT(sizeof(struct ofp11_port_stats_request) == 8);
656 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
657 * the field to all ones. */
658 struct ofp11_port_stats {
660 uint8_t pad[4]; /* Align to 64-bits. */
661 ovs_be64 rx_packets; /* Number of received packets. */
662 ovs_be64 tx_packets; /* Number of transmitted packets. */
663 ovs_be64 rx_bytes; /* Number of received bytes. */
664 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
665 ovs_be64 rx_dropped; /* Number of packets dropped by RX. */
666 ovs_be64 tx_dropped; /* Number of packets dropped by TX. */
667 ovs_be64 rx_errors; /* Number of receive errors. This is a
668 super-set of receive errors and should be
669 great than or equal to the sum of all
671 ovs_be64 tx_errors; /* Number of transmit errors. This is a
672 super-set of transmit errors. */
673 ovs_be64 rx_frame_err; /* Number of frame alignment errors. */
674 ovs_be64 rx_over_err; /* Number of packets with RX overrun. */
675 ovs_be64 rx_crc_err; /* Number of CRC errors. */
676 ovs_be64 collisions; /* Number of collisions. */
678 OFP_ASSERT(sizeof(struct ofp11_port_stats) == 104);
680 struct ofp11_queue_stats_request {
681 ovs_be32 port_no; /* All ports if OFPP_ANY. */
682 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
684 OFP_ASSERT(sizeof(struct ofp11_queue_stats_request) == 8);
686 struct ofp11_queue_stats {
688 ovs_be32 queue_id; /* Queue id. */
689 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
690 ovs_be64 tx_packets; /* Number of transmitted packets. */
691 ovs_be64 tx_errors; /* # of packets dropped due to overrun. */
693 OFP_ASSERT(sizeof(struct ofp11_queue_stats) == 32);
695 struct ofp11_group_stats_request {
696 ovs_be32 group_id; /* All groups if OFPG_ALL. */
697 uint8_t pad[4]; /* Align to 64 bits. */
699 OFP_ASSERT(sizeof(struct ofp11_group_stats_request) == 8);
701 /* Body of reply to OFPST11_GROUP request */
702 struct ofp11_group_stats {
703 ovs_be16 length; /* Length of this entry. */
704 uint8_t pad[2]; /* Align to 64 bits. */
705 ovs_be32 group_id; /* Group identifier. */
706 ovs_be32 ref_count; /* Number of flows or groups that
707 directly forward to this group. */
708 uint8_t pad2[4]; /* Align to 64 bits. */
709 ovs_be64 packet_count; /* Number of packets processed by group. */
710 ovs_be64 byte_count; /* Number of bytes processed by group. */
711 /* struct ofp11_bucket_counter bucket_stats[0]; */
714 OFP_ASSERT(sizeof(struct ofp11_group_stats) == 32);
716 /* Used in group stats replies. */
717 struct ofp11_bucket_counter {
718 ovs_be64 packet_count; /* Number of packets processed by bucket. */
719 ovs_be64 byte_count; /* Number of bytes processed by bucket. */
721 OFP_ASSERT(sizeof(struct ofp11_bucket_counter) == 16);
723 /* Body of reply to OFPST11_GROUP_DESC request. */
724 struct ofp11_group_desc_stats {
725 ovs_be16 length; /* Length of this entry. */
726 uint8_t type; /* One of OFPGT_*. */
727 uint8_t pad; /* Pad to 64 bits. */
728 ovs_be32 group_id; /* Group identifier. */
729 /* struct ofp11_bucket buckets[0]; */
731 OFP_ASSERT(sizeof(struct ofp11_group_desc_stats) == 8);
733 /* Send packet (controller -> datapath). */
734 struct ofp11_packet_out {
735 ovs_be32 buffer_id; /* ID assigned by datapath (-1 if none). */
736 ovs_be32 in_port; /* Packet's input port or OFPP_CONTROLLER. */
737 ovs_be16 actions_len; /* Size of action array in bytes. */
739 /* struct ofp_action_header actions[0]; Action list. */
740 /* uint8_t data[0]; */ /* Packet data. The length is inferred
741 from the length field in the header.
742 (Only meaningful if buffer_id == -1.) */
744 OFP_ASSERT(sizeof(struct ofp11_packet_out) == 16);
746 /* Packet received on port (datapath -> controller). */
747 struct ofp11_packet_in {
748 ovs_be32 buffer_id; /* ID assigned by datapath. */
749 ovs_be32 in_port; /* Port on which frame was received. */
750 ovs_be32 in_phy_port; /* Physical Port on which frame was received. */
751 ovs_be16 total_len; /* Full length of frame. */
752 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
753 uint8_t table_id; /* ID of the table that was looked up */
754 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
755 so the IP header is 32-bit aligned. The
756 amount of data is inferred from the length
757 field in the header. Because of padding,
758 offsetof(struct ofp_packet_in, data) ==
759 sizeof(struct ofp_packet_in) - 2. */
761 OFP_ASSERT(sizeof(struct ofp11_packet_in) == 16);
763 /* Flow removed (datapath -> controller). */
764 struct ofp11_flow_removed {
765 ovs_be64 cookie; /* Opaque controller-issued identifier. */
767 ovs_be16 priority; /* Priority level of flow entry. */
768 uint8_t reason; /* One of OFPRR_*. */
769 uint8_t table_id; /* ID of the table */
771 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
772 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
774 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
775 uint8_t pad2[2]; /* Align to 64-bits. */
776 ovs_be64 packet_count;
778 /* Followed by an ofp11_match structure. */
780 OFP_ASSERT(sizeof(struct ofp11_flow_removed) == 40);
782 #endif /* openflow/openflow-1.1.h */