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 Networks.
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 /* OpenFlow 1.1 specific message types, in addition to the common message
76 /* Controller command messages. */
77 OFPT11_PACKET_OUT = 13, /* Controller/switch message */
78 OFPT11_FLOW_MOD, /* Controller/switch message */
79 OFPT11_GROUP_MOD, /* Controller/switch message */
80 OFPT11_PORT_MOD, /* Controller/switch message */
81 OFPT11_TABLE_MOD, /* Controller/switch message */
83 /* Statistics messages. */
84 OFPT11_STATS_REQUEST, /* Controller/switch message */
85 OFPT11_STATS_REPLY, /* Controller/switch message */
87 /* Barrier messages. */
88 OFPT11_BARRIER_REQUEST, /* Controller/switch message */
89 OFPT11_BARRIER_REPLY, /* Controller/switch message */
91 /* Queue Configuration messages. */
92 OFPT11_QUEUE_GET_CONFIG_REQUEST, /* Controller/switch message */
93 OFPT11_QUEUE_GET_CONFIG_REPLY, /* Controller/switch message */
96 /* OpenFlow 1.1 port config flags are just the common flags. */
98 (OFPPC_PORT_DOWN | OFPPC_NO_RECV | OFPPC_NO_FWD | OFPPC_NO_PACKET_IN)
100 /* OpenFlow 1.1 specific current state of the physical port. These are not
101 * configurable from the controller.
103 enum ofp11_port_state {
104 OFPPS11_BLOCKED = 1 << 1, /* Port is blocked */
105 OFPPS11_LIVE = 1 << 2, /* Live for Fast Failover Group. */
106 #define OFPPS11_ALL (OFPPS_LINK_DOWN | OFPPS11_BLOCKED | OFPPS11_LIVE)
109 /* OpenFlow 1.1 specific features of ports available in a datapath. */
110 enum ofp11_port_features {
111 OFPPF11_40GB_FD = 1 << 7, /* 40 Gb full-duplex rate support. */
112 OFPPF11_100GB_FD = 1 << 8, /* 100 Gb full-duplex rate support. */
113 OFPPF11_1TB_FD = 1 << 9, /* 1 Tb full-duplex rate support. */
114 OFPPF11_OTHER = 1 << 10, /* Other rate, not in the list. */
116 OFPPF11_COPPER = 1 << 11, /* Copper medium. */
117 OFPPF11_FIBER = 1 << 12, /* Fiber medium. */
118 OFPPF11_AUTONEG = 1 << 13, /* Auto-negotiation. */
119 OFPPF11_PAUSE = 1 << 14, /* Pause. */
120 OFPPF11_PAUSE_ASYM = 1 << 15 /* Asymmetric pause. */
121 #define OFPPF11_ALL ((1 << 16) - 1)
124 /* Description of a port */
128 uint8_t hw_addr[OFP_ETH_ALEN];
129 uint8_t pad2[2]; /* Align to 64 bits. */
130 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
132 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
133 ovs_be32 state; /* Bitmap of OFPPS_* and OFPPS11_* flags. */
135 /* Bitmaps of OFPPF_* and OFPPF11_* that describe features. All bits
136 * zeroed if unsupported or unavailable. */
137 ovs_be32 curr; /* Current features. */
138 ovs_be32 advertised; /* Features being advertised by the port. */
139 ovs_be32 supported; /* Features supported by the port. */
140 ovs_be32 peer; /* Features advertised by peer. */
142 ovs_be32 curr_speed; /* Current port bitrate in kbps. */
143 ovs_be32 max_speed; /* Max port bitrate in kbps */
146 /* Modify behavior of the physical port */
147 struct ofp11_port_mod {
148 struct ofp_header header;
151 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
152 configurable. This is used to
153 sanity-check the request, so it must
154 be the same as returned in an
155 ofp11_port struct. */
156 uint8_t pad2[2]; /* Pad to 64 bits. */
157 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
158 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
160 ovs_be32 advertise; /* Bitmap of OFPPF_* and OFPPF11_*. Zero all bits
161 to prevent any action taking place. */
162 uint8_t pad3[4]; /* Pad to 64 bits. */
164 OFP_ASSERT(sizeof(struct ofp11_port_mod) == 40);
166 /* OpenFlow 1.1 specific capabilities supported by the datapath (struct
167 * ofp_switch_features, member capabilities). */
168 enum ofp11_capabilities {
169 OFPC11_GROUP_STATS = 1 << 3, /* Group statistics. */
172 enum ofp11_action_type {
173 OFPAT11_OUTPUT, /* Output to switch port. */
174 OFPAT11_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
175 OFPAT11_SET_VLAN_PCP, /* Set the 802.1q priority. */
176 OFPAT11_SET_DL_SRC, /* Ethernet source address. */
177 OFPAT11_SET_DL_DST, /* Ethernet destination address. */
178 OFPAT11_SET_NW_SRC, /* IP source address. */
179 OFPAT11_SET_NW_DST, /* IP destination address. */
180 OFPAT11_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
181 OFPAT11_SET_NW_ECN, /* IP ECN (2 bits). */
182 OFPAT11_SET_TP_SRC, /* TCP/UDP/SCTP source port. */
183 OFPAT11_SET_TP_DST, /* TCP/UDP/SCTP destination port. */
184 OFPAT11_COPY_TTL_OUT, /* Copy TTL "outwards" -- from next-to-outermost
186 OFPAT11_COPY_TTL_IN, /* Copy TTL "inwards" -- from outermost to
188 OFPAT11_SET_MPLS_LABEL, /* MPLS label */
189 OFPAT11_SET_MPLS_TC, /* MPLS TC */
190 OFPAT11_SET_MPLS_TTL, /* MPLS TTL */
191 OFPAT11_DEC_MPLS_TTL, /* Decrement MPLS TTL */
193 OFPAT11_PUSH_VLAN, /* Push a new VLAN tag */
194 OFPAT11_POP_VLAN, /* Pop the outer VLAN tag */
195 OFPAT11_PUSH_MPLS, /* Push a new MPLS tag */
196 OFPAT11_POP_MPLS, /* Pop the outer MPLS tag */
197 OFPAT11_SET_QUEUE, /* Set queue id when outputting to a port */
198 OFPAT11_GROUP, /* Apply group. */
199 OFPAT11_SET_NW_TTL, /* IP TTL. */
200 OFPAT11_DEC_NW_TTL, /* Decrement IP TTL. */
201 OFPAT11_EXPERIMENTER = 0xffff
204 #endif /* openflow/openflow-1.1.h */