ofp-actions: Add decoding and encoding OF1.1 instructions and actions.
[openvswitch] / include / openflow / openflow-common.h
1 /* Copyright (c) 2008, 2011, 2012 The Board of Trustees of The Leland Stanford
2  * Junior University
3  *
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:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
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
27  * SOFTWARE.
28  *
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.
32  */
33
34 /*
35  * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
36  *
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:
40  *
41  *     http://www.apache.org/licenses/LICENSE-2.0
42  *
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.
48  */
49
50 #ifndef OPENFLOW_COMMON_H
51 #define OPENFLOW_COMMON_H 1
52
53 #include "openvswitch/types.h"
54
55 #ifdef SWIG
56 #define OFP_ASSERT(EXPR)        /* SWIG can't handle OFP_ASSERT. */
57 #elif !defined(__cplusplus)
58 /* Build-time assertion for use in a declaration context. */
59 #define OFP_ASSERT(EXPR)                                                \
60         extern int (*build_assert(void))[ sizeof(struct {               \
61                     unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
62 #else /* __cplusplus */
63 #include <boost/static_assert.hpp>
64 #define OFP_ASSERT BOOST_STATIC_ASSERT
65 #endif /* __cplusplus */
66
67 /* Version number:
68  * Non-experimental versions released: 0x01 0x02
69  * Experimental versions released: 0x81 -- 0x99
70  */
71 /* The most significant bit being set in the version field indicates an
72  * experimental OpenFlow version.
73  */
74 #define OFP10_VERSION   0x01
75 #define OFP11_VERSION   0x02
76 #define OFP12_VERSION   0x03
77
78 #define OFP_MAX_TABLE_NAME_LEN 32
79 #define OFP_MAX_PORT_NAME_LEN  16
80
81 #define OFP_TCP_PORT  6633
82 #define OFP_SSL_PORT  6633
83
84 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
85
86 /* Common OpenFlow message types. */
87 enum ofp_type {
88     /* Immutable messages. */
89     OFPT_HELLO,               /* Symmetric message */
90     OFPT_ERROR,               /* Symmetric message */
91     OFPT_ECHO_REQUEST,        /* Symmetric message */
92     OFPT_ECHO_REPLY,          /* Symmetric message */
93     OFPT_VENDOR,              /* Symmetric message */
94
95     /* Switch configuration messages. */
96     OFPT_FEATURES_REQUEST,    /* Controller/switch message */
97     OFPT_FEATURES_REPLY,      /* Controller/switch message */
98     OFPT_GET_CONFIG_REQUEST,  /* Controller/switch message */
99     OFPT_GET_CONFIG_REPLY,    /* Controller/switch message */
100     OFPT_SET_CONFIG,          /* Controller/switch message */
101
102     /* Asynchronous messages. */
103     OFPT_PACKET_IN,           /* Async message */
104     OFPT_FLOW_REMOVED,        /* Async message */
105     OFPT_PORT_STATUS,         /* Async message */
106
107     /* Controller command messages. */
108     OFPT_PACKET_OUT,          /* Controller/switch message */
109     OFPT_FLOW_MOD,            /* Controller/switch message */
110 };
111
112 /* Header on all OpenFlow packets. */
113 struct ofp_header {
114     uint8_t version;    /* An OpenFlow version number, e.g. OFP10_VERSION. */
115     uint8_t type;       /* One of the OFPT_ constants. */
116     ovs_be16 length;    /* Length including this ofp_header. */
117     ovs_be32 xid;       /* Transaction id associated with this packet.
118                            Replies use the same id as was in the request
119                            to facilitate pairing. */
120 };
121 OFP_ASSERT(sizeof(struct ofp_header) == 8);
122
123 /* Common flags to indicate behavior of the physical port.  These flags are
124  * used in ofp_port to describe the current configuration.  They are used in
125  * the ofp_port_mod message to configure the port's behavior.
126  */
127 enum ofp_port_config {
128     OFPPC_PORT_DOWN    = 1 << 0,  /* Port is administratively down. */
129
130     OFPPC_NO_RECV      = 1 << 2,  /* Drop all packets received by port. */
131     OFPPC_NO_FWD       = 1 << 5,  /* Drop packets forwarded to port. */
132     OFPPC_NO_PACKET_IN = 1 << 6   /* Do not send packet-in msgs for port. */
133 };
134
135 /* Common current state of the physical port.  These are not configurable from
136  * the controller.
137  */
138 enum ofp_port_state {
139     OFPPS_LINK_DOWN    = 1 << 0,  /* No physical link present. */
140 };
141
142 /* Common features of physical ports available in a datapath. */
143 enum ofp_port_features {
144     OFPPF_10MB_HD    = 1 << 0,  /* 10 Mb half-duplex rate support. */
145     OFPPF_10MB_FD    = 1 << 1,  /* 10 Mb full-duplex rate support. */
146     OFPPF_100MB_HD   = 1 << 2,  /* 100 Mb half-duplex rate support. */
147     OFPPF_100MB_FD   = 1 << 3,  /* 100 Mb full-duplex rate support. */
148     OFPPF_1GB_HD     = 1 << 4,  /* 1 Gb half-duplex rate support. */
149     OFPPF_1GB_FD     = 1 << 5,  /* 1 Gb full-duplex rate support. */
150     OFPPF_10GB_FD    = 1 << 6,  /* 10 Gb full-duplex rate support. */
151 };
152
153 struct ofp_packet_queue {
154     ovs_be32 queue_id;          /* id for the specific queue. */
155     ovs_be16 len;               /* Length in bytes of this queue desc. */
156     uint8_t pad[2];             /* 64-bit alignment. */
157     /* struct ofp_queue_prop_header properties[0]; List of properties.  */
158 };
159 OFP_ASSERT(sizeof(struct ofp_packet_queue) == 8);
160
161 enum ofp_queue_properties {
162     OFPQT_NONE = 0,       /* No property defined for queue (default). */
163     OFPQT_MIN_RATE,       /* Minimum datarate guaranteed. */
164                           /* Other types should be added here
165                            * (i.e. max rate, precedence, etc). */
166 };
167
168 /* Common description for a queue. */
169 struct ofp_queue_prop_header {
170     ovs_be16 property; /* One of OFPQT_. */
171     ovs_be16 len;      /* Length of property, including this header. */
172     uint8_t pad[4];    /* 64-bit alignemnt. */
173 };
174 OFP_ASSERT(sizeof(struct ofp_queue_prop_header) == 8);
175
176 /* Min-Rate queue property description. */
177 struct ofp_queue_prop_min_rate {
178     struct ofp_queue_prop_header prop_header; /* prop: OFPQT_MIN, len: 16. */
179     ovs_be16 rate;        /* In 1/10 of a percent; >1000 -> disabled. */
180     uint8_t pad[6];       /* 64-bit alignment */
181 };
182 OFP_ASSERT(sizeof(struct ofp_queue_prop_min_rate) == 16);
183
184 /* Switch features. */
185 struct ofp_switch_features {
186     struct ofp_header header;
187     ovs_be64 datapath_id;   /* Datapath unique ID.  The lower 48-bits are for
188                                a MAC address, while the upper 16-bits are
189                                implementer-defined. */
190
191     ovs_be32 n_buffers;     /* Max packets buffered at once. */
192
193     uint8_t n_tables;       /* Number of tables supported by datapath. */
194     uint8_t pad[3];         /* Align to 64-bits. */
195
196     /* Features. */
197     ovs_be32 capabilities;  /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
198     ovs_be32 actions;       /* Bitmap of supported "ofp_action_type"s. */
199
200     /* Followed by an array of struct ofp10_phy_port or struct ofp11_port
201      * structures.  The number is inferred from header.length. */
202 };
203 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
204
205 /* Common capabilities supported by the datapath (struct ofp_switch_features,
206  * member capabilities). */
207 enum ofp_capabilities {
208     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
209     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
210     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
211     OFPC_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
212     OFPC_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
213     OFPC_ARP_MATCH_IP   = 1 << 7   /* Match IP addresses in ARP
214                                       pkts. */
215 };
216
217 /* Why is this packet being sent to the controller? */
218 enum ofp_packet_in_reason {
219     OFPR_NO_MATCH,          /* No matching flow. */
220     OFPR_ACTION,            /* Action explicitly output to controller. */
221     OFPR_INVALID_TTL        /* Packet has invalid TTL. */,
222     OFPR_N_REASONS
223 };
224
225 /* Action structure for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
226 struct ofp_action_vlan_vid {
227     ovs_be16 type;                  /* Type. */
228     ovs_be16 len;                   /* Length is 8. */
229     ovs_be16 vlan_vid;              /* VLAN id. */
230     uint8_t pad[2];
231 };
232 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
233
234 /* Action structure for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
235 struct ofp_action_vlan_pcp {
236     ovs_be16 type;                  /* Type. */
237     ovs_be16 len;                   /* Length is 8. */
238     uint8_t vlan_pcp;               /* VLAN priority. */
239     uint8_t pad[3];
240 };
241 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
242
243 /* Action structure for OFPAT10_SET_DL_SRC/DST and OFPAT11_SET_DL_SRC/DST. */
244 struct ofp_action_dl_addr {
245     ovs_be16 type;                  /* Type. */
246     ovs_be16 len;                   /* Length is 16. */
247     uint8_t dl_addr[OFP_ETH_ALEN];  /* Ethernet address. */
248     uint8_t pad[6];
249 };
250 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
251
252 /* Action structure for OFPAT10_SET_NW_SRC/DST and OFPAT11_SET_NW_SRC/DST. */
253 struct ofp_action_nw_addr {
254     ovs_be16 type;                  /* Type. */
255     ovs_be16 len;                   /* Length is 8. */
256     ovs_be32 nw_addr;               /* IP address. */
257 };
258 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
259
260 /* Action structure for OFPAT10_SET_NW_TOS and OFPAT11_SET_NW_TOS. */
261 struct ofp_action_nw_tos {
262     ovs_be16 type;                  /* Type.. */
263     ovs_be16 len;                   /* Length is 8. */
264     uint8_t nw_tos;                 /* DSCP in high 6 bits, rest ignored. */
265     uint8_t pad[3];
266 };
267 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
268
269 /* Action structure for OFPAT10_SET_TP_SRC/DST and OFPAT11_SET_TP_SRC/DST. */
270 struct ofp_action_tp_port {
271     ovs_be16 type;                  /* Type. */
272     ovs_be16 len;                   /* Length is 8. */
273     ovs_be16 tp_port;               /* TCP/UDP port. */
274     uint8_t pad[2];
275 };
276 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
277
278 /* Why was this flow removed? */
279 enum ofp_flow_removed_reason {
280     OFPRR_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
281     OFPRR_HARD_TIMEOUT,         /* Time exceeded hard_timeout. */
282     OFPRR_DELETE,               /* Evicted by a DELETE flow mod. */
283     OFPRR_GROUP_DELETE          /* Group was removed. */
284 };
285
286 /* What changed about the physical port */
287 enum ofp_port_reason {
288     OFPPR_ADD,              /* The port was added. */
289     OFPPR_DELETE,           /* The port was removed. */
290     OFPPR_MODIFY            /* Some attribute of the port has changed. */
291 };
292
293 /* A physical port has changed in the datapath */
294 struct ofp_port_status {
295     struct ofp_header header;
296     uint8_t reason;          /* One of OFPPR_*. */
297     uint8_t pad[7];          /* Align to 64-bits. */
298     /* Followed by struct ofp10_phy_port or struct ofp11_port.  */
299 };
300 OFP_ASSERT(sizeof(struct ofp_port_status) == 16);
301
302 enum ofp_stats_types {
303     /* Description of this OpenFlow switch. (OFPMP_DESC)
304      * The OF1.0 request is struct ofp_stats_msg.
305      * The OF1.0 reply is struct ofp_desc_stats. */
306     OFPST_DESC = 0,
307
308     /* Individual flow statistics. (OFPMP_FLOW)
309      * The OF1.0 request is struct ofp_flow_stats_request.
310      * The OF1.0 reply body is an array of struct ofp_flow_stats. */
311     OFPST_FLOW = 1,
312
313     /* Aggregate flow statistics. (OFPMP_AGGREGATE)
314      * The OF1.0 request is struct ofp_flow_stats_request.
315      * The OF1.0 reply is struct ofp_aggregate_stats_reply. */
316     OFPST_AGGREGATE = 2,
317
318     /* Flow table statistics. (OFPMP_TABLE)
319      * The OF1.0 request is struct ofp_stats_msg.
320      * The OF1.0 reply body is an array of struct ofp_table_stats. */
321     OFPST_TABLE = 3,
322
323     /* Physical port statistics. (OFPMP_PORT_STATS)
324      * The OF1.0 request is struct ofp_port_stats_request.
325      * The OF1.0 reply body is an array of struct ofp_port_stats. */
326     OFPST_PORT = 4,
327
328     /* Queue statistics for a port. (OFPMP_QUEUE)
329      * The OF1.0 request is struct ofp_stats_msg.
330      * The OF1.0 reply body is an array of struct ofp_queue_stats. */
331     OFPST_QUEUE = 5,
332
333     /* Port description. (OFPMP_PORT_DESC)
334      * This was introduced as part of OF1.3, but is useful for bridges
335      * with many ports, so we support it with OF1.0, too.
336      * The OF1.0 request is struct ofp_stats_msg.
337      * The OF1.0 reply body is an array of struct ofp10_phy_port. */
338     OFPST_PORT_DESC = 13,
339
340     /* Vendor extension.
341      * The OF1.0 request and reply begin with struct ofp_vendor_stats. */
342     OFPST_VENDOR = 0xffff
343 };
344
345 /* The match type indicates the match structure (set of fields that compose the
346  * match) in use. The match type is placed in the type field at the beginning
347  * of all match structures. The "OpenFlow Extensible Match" type corresponds
348  * to OXM TLV format described below and must be supported by all OpenFlow
349  * switches. Extensions that define other match types may be published on the
350  * ONF wiki. Support for extensions is optional.
351  */
352 enum ofp_match_type {
353     OFPMT_STANDARD = 0,         /* The match fields defined in the ofp11_match
354                                    structure apply */
355     OFPMT_OXM = 1,              /* OpenFlow Extensible Match */
356 };
357
358 #endif /* openflow/openflow-common.h */