ofp-actions: helper functions for of12 set-field action
[sliver-openvswitch.git] / include / openflow / openflow-1.2.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, 2012 Nicira, Inc.
36  * Copyright (c) 2012 Horms Solutions Ltd.
37  *
38  * Licensed under the Apache License, Version 2.0 (the "License");
39  * you may not use this file except in compliance with the License.
40  * You may obtain a copy of the License at:
41  *
42  *     http://www.apache.org/licenses/LICENSE-2.0
43  *
44  * Unless required by applicable law or agreed to in writing, software
45  * distributed under the License is distributed on an "AS IS" BASIS,
46  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
47  * See the License for the specific language governing permissions and
48  * limitations under the License.
49  */
50
51 /* OpenFlow: protocol between controller and datapath. */
52
53 #ifndef OPENFLOW_12_H
54 #define OPENFLOW_12_H 1
55
56 #include "openflow/openflow-1.1.h"
57
58 /*
59  * OXM Class IDs.
60  * The high order bit differentiate reserved classes from member classes.
61  * Classes 0x0000 to 0x7FFF are member classes, allocated by ONF.
62  * Classes 0x8000 to 0xFFFE are reserved classes, reserved for standardisation.
63  */
64 enum ofp12_oxm_class {
65     OFPXMC12_NXM_0          = 0x0000, /* Backward compatibility with NXM */
66     OFPXMC12_NXM_1          = 0x0001, /* Backward compatibility with NXM */
67     OFPXMC12_OPENFLOW_BASIC = 0x8000, /* Basic class for OpenFlow */
68     OFPXMC12_EXPERIMENTER   = 0xffff, /* Experimenter class */
69 };
70
71 /* OXM Flow match field types for OpenFlow basic class. */
72 enum oxm12_ofb_match_fields {
73     OFPXMT12_OFB_IN_PORT,        /* Switch input port. */
74     OFPXMT12_OFB_IN_PHY_PORT,    /* Switch physical input port. */
75     OFPXMT12_OFB_METADATA,       /* Metadata passed between tables. */
76     OFPXMT12_OFB_ETH_DST,        /* Ethernet destination address. */
77     OFPXMT12_OFB_ETH_SRC,        /* Ethernet source address. */
78     OFPXMT12_OFB_ETH_TYPE,       /* Ethernet frame type. */
79     OFPXMT12_OFB_VLAN_VID,       /* VLAN id. */
80     OFPXMT12_OFB_VLAN_PCP,       /* VLAN priority. */
81     OFPXMT12_OFB_IP_DSCP,        /* IP DSCP (6 bits in ToS field). */
82     OFPXMT12_OFB_IP_ECN,         /* IP ECN (2 bits in ToS field). */
83     OFPXMT12_OFB_IP_PROTO,       /* IP protocol. */
84     OFPXMT12_OFB_IPV4_SRC,       /* IPv4 source address. */
85     OFPXMT12_OFB_IPV4_DST,       /* IPv4 destination address. */
86     OFPXMT12_OFB_TCP_SRC,        /* TCP source port. */
87     OFPXMT12_OFB_TCP_DST,        /* TCP destination port. */
88     OFPXMT12_OFB_UDP_SRC,        /* UDP source port. */
89     OFPXMT12_OFB_UDP_DST,        /* UDP destination port. */
90     OFPXMT12_OFB_SCTP_SRC,       /* SCTP source port. */
91     OFPXMT12_OFB_SCTP_DST,       /* SCTP destination port. */
92     OFPXMT12_OFB_ICMPV4_TYPE,    /* ICMP type. */
93     OFPXMT12_OFB_ICMPV4_CODE,    /* ICMP code. */
94     OFPXMT12_OFB_ARP_OP,         /* ARP opcode. */
95     OFPXMT12_OFB_ARP_SPA,        /* ARP source IPv4 address. */
96     OFPXMT12_OFB_ARP_TPA,        /* ARP target IPv4 address. */
97     OFPXMT12_OFB_ARP_SHA,        /* ARP source hardware address. */
98     OFPXMT12_OFB_ARP_THA,        /* ARP target hardware address. */
99     OFPXMT12_OFB_IPV6_SRC,       /* IPv6 source address. */
100     OFPXMT12_OFB_IPV6_DST,       /* IPv6 destination address. */
101     OFPXMT12_OFB_IPV6_FLABEL,    /* IPv6 Flow Label */
102     OFPXMT12_OFB_ICMPV6_TYPE,    /* ICMPv6 type. */
103     OFPXMT12_OFB_ICMPV6_CODE,    /* ICMPv6 code. */
104     OFPXMT12_OFB_IPV6_ND_TARGET, /* Target address for ND. */
105     OFPXMT12_OFB_IPV6_ND_SLL,    /* Source link-layer for ND. */
106     OFPXMT12_OFB_IPV6_ND_TLL,    /* Target link-layer for ND. */
107     OFPXMT12_OFB_MPLS_LABEL,     /* MPLS label. */
108     OFPXMT12_OFB_MPLS_TC,        /* MPLS TC. */
109
110     /* End Marker */
111     OFPXMT12_OFB_MAX,
112 };
113
114 #define OFPXMT12_MASK ((1ULL << OFPXMT12_OFB_MAX) - 1)
115
116 /* OXM implementation makes use of NXM as they are the same format
117  * with different field definitions
118  */
119
120 #define OXM_HEADER(FIELD, LENGTH) \
121     NXM_HEADER(OFPXMC12_OPENFLOW_BASIC, FIELD, LENGTH)
122 #define OXM_HEADER_W(FIELD, LENGTH) \
123     NXM_HEADER_W(OFPXMC12_OPENFLOW_BASIC, FIELD, LENGTH)
124
125 #define IS_OXM_HEADER(header) (NXM_VENDOR(header) == OFPXMC12_OPENFLOW_BASIC)
126
127 #define OXM_OF_IN_PORT        OXM_HEADER   (OFPXMT12_OFB_IN_PORT, 4)
128 #define OXM_OF_IN_PHY_PORT    OXM_HEADER   (OFPXMT12_OFB_IN_PHY_PORT, 4)
129 #define OXM_OF_METADATA       OXM_HEADER   (OFPXMT12_OFB_METADATA, 8)
130 #define OXM_OF_ETH_DST        OXM_HEADER   (OFPXMT12_OFB_ETH_DST, 6)
131 #define OXM_OF_ETH_DST_W      OXM_HEADER_W (OFPXMT12_OFB_ETH_DST, 6)
132 #define OXM_OF_ETH_SRC        OXM_HEADER   (OFPXMT12_OFB_ETH_SRC, 6)
133 #define OXM_OF_ETH_SRC_W      OXM_HEADER_W (OFPXMT12_OFB_ETH_SRC, 6)
134 #define OXM_OF_ETH_TYPE       OXM_HEADER   (OFPXMT12_OFB_ETH_TYPE, 2)
135 #define OXM_OF_VLAN_VID       OXM_HEADER   (OFPXMT12_OFB_VLAN_VID, 2)
136 #define OXM_OF_VLAN_VID_W     OXM_HEADER_W (OFPXMT12_OFB_VLAN_VID, 2)
137 #define OXM_OF_VLAN_PCP       OXM_HEADER   (OFPXMT12_OFB_VLAN_PCP, 1)
138 #define OXM_OF_IP_DSCP        OXM_HEADER   (OFPXMT12_OFB_IP_DSCP, 1)
139 #define OXM_OF_IP_ECN         OXM_HEADER   (OFPXMT12_OFB_IP_ECN, 1)
140 #define OXM_OF_IP_PROTO       OXM_HEADER   (OFPXMT12_OFB_IP_PROTO, 1)
141 #define OXM_OF_IPV4_SRC       OXM_HEADER   (OFPXMT12_OFB_IPV4_SRC, 4)
142 #define OXM_OF_IPV4_SRC_W     OXM_HEADER_W (OFPXMT12_OFB_IPV4_SRC, 4)
143 #define OXM_OF_IPV4_DST       OXM_HEADER   (OFPXMT12_OFB_IPV4_DST, 4)
144 #define OXM_OF_IPV4_DST_W     OXM_HEADER_W (OFPXMT12_OFB_IPV4_DST, 4)
145 #define OXM_OF_TCP_SRC        OXM_HEADER   (OFPXMT12_OFB_TCP_SRC, 2)
146 #define OXM_OF_TCP_DST        OXM_HEADER   (OFPXMT12_OFB_TCP_DST, 2)
147 #define OXM_OF_UDP_SRC        OXM_HEADER   (OFPXMT12_OFB_UDP_SRC, 2)
148 #define OXM_OF_UDP_DST        OXM_HEADER   (OFPXMT12_OFB_UDP_DST, 2)
149 #define OXM_OF_SCTP_SRC       OXM_HEADER   (OFPXMT12_OFB_SCTP_SRC, 2)
150 #define OXM_OF_SCTP_DST       OXM_HEADER   (OFPXMT12_OFB_SCTP_DST, 2)
151 #define OXM_OF_ICMPV4_TYPE    OXM_HEADER   (OFPXMT12_OFB_ICMPV4_TYPE, 1)
152 #define OXM_OF_ICMPV4_CODE    OXM_HEADER   (OFPXMT12_OFB_ICMPV4_CODE, 1)
153 #define OXM_OF_ARP_OP         OXM_HEADER   (OFPXMT12_OFB_ARP_OP, 2)
154 #define OXM_OF_ARP_SPA        OXM_HEADER   (OFPXMT12_OFB_ARP_SPA, 4)
155 #define OXM_OF_ARP_SPA_W      OXM_HEADER_W (OFPXMT12_OFB_ARP_SPA, 4)
156 #define OXM_OF_ARP_TPA        OXM_HEADER   (OFPXMT12_OFB_ARP_TPA, 4)
157 #define OXM_OF_ARP_TPA_W      OXM_HEADER_W (OFPXMT12_OFB_ARP_TPA, 4)
158 #define OXM_OF_ARP_SHA        OXM_HEADER   (OFPXMT12_OFB_ARP_SHA, 6)
159 #define OXM_OF_ARP_SHA_W      OXM_HEADER_W (OFPXMT12_OFB_ARP_SHA, 6)
160 #define OXM_OF_ARP_THA        OXM_HEADER   (OFPXMT12_OFB_ARP_THA, 6)
161 #define OXM_OF_ARP_THA_W      OXM_HEADER_W (OFPXMT12_OFB_ARP_THA, 6)
162 #define OXM_OF_IPV6_SRC       OXM_HEADER   (OFPXMT12_OFB_IPV6_SRC, 16)
163 #define OXM_OF_IPV6_SRC_W     OXM_HEADER_W (OFPXMT12_OFB_IPV6_SRC, 16)
164 #define OXM_OF_IPV6_DST       OXM_HEADER   (OFPXMT12_OFB_IPV6_DST, 16)
165 #define OXM_OF_IPV6_DST_W     OXM_HEADER_W (OFPXMT12_OFB_IPV6_DST, 16)
166 #define OXM_OF_IPV6_FLABEL    OXM_HEADER   (OFPXMT12_OFB_IPV6_FLABEL, 4)
167 #define OXM_OF_IPV6_FLABEL_W  OXM_HEADER_W (OFPXMT12_OFB_IPV6_FLABEL, 4)
168 #define OXM_OF_ICMPV6_TYPE    OXM_HEADER   (OFPXMT12_OFB_ICMPV6_TYPE, 1)
169 #define OXM_OF_ICMPV6_CODE    OXM_HEADER   (OFPXMT12_OFB_ICMPV6_CODE, 1)
170 #define OXM_OF_IPV6_ND_TARGET OXM_HEADER   (OFPXMT12_OFB_IPV6_ND_TARGET, 16)
171 #define OXM_OF_IPV6_ND_SLL    OXM_HEADER   (OFPXMT12_OFB_IPV6_ND_SLL, 6)
172 #define OXM_OF_IPV6_ND_TLL    OXM_HEADER   (OFPXMT12_OFB_IPV6_ND_TLL, 6)
173 #define OXM_OF_MPLS_LABEL     OXM_HEADER   (OFPXMT12_OFB_MPLS_LABEL, 4)
174 #define OXM_OF_MPLS_TC        OXM_HEADER   (OFPXMT12_OFB_MPLS_TC, 1)
175
176 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
177  * special conditions.
178  */
179 enum ofp12_vlan_id {
180     OFPVID12_PRESENT = 0x1000, /* Bit that indicate that a VLAN id is set */
181     OFPVID12_NONE    = 0x0000, /* No VLAN id was set. */
182 };
183
184 /* Header for OXM experimenter match fields. */
185 struct ofp12_oxm_experimenter_header {
186     ovs_be32 oxm_header;   /* oxm_class = OFPXMC_EXPERIMENTER */
187     ovs_be32 experimenter; /* Experimenter ID which takes the same
188                               form as in struct ofp11_experimenter_header. */
189 };
190 OFP_ASSERT(sizeof(struct ofp12_oxm_experimenter_header) == 8);
191
192 enum ofp12_action_type {
193     OFPAT12_OUTPUT       = 0,  /* Output to switch port. */
194     OFPAT12_COPY_TTL_OUT = 11, /* Copy TTL "outwards" -- from next-to-outermost
195                                   to outermost */
196     OFPAT12_COPY_TTL_IN,       /* Copy TTL "inwards" -- from outermost to
197                                   next-to-outermost */
198     OFPAT12_SET_MPLS_TTL = 15, /* MPLS TTL */
199     OFPAT12_DEC_MPLS_TTL,      /* Decrement MPLS TTL */
200     OFPAT12_PUSH_VLAN,         /* Push a new VLAN tag */
201     OFPAT12_POP_VLAN,          /* Pop the outer VLAN tag */
202     OFPAT12_PUSH_MPLS,         /* Push a new MPLS tag */
203     OFPAT12_POP_MPLS,          /* Pop the outer MPLS tag */
204     OFPAT12_SET_QUEUE,         /* Set queue id when outputting to a port */
205     OFPAT12_GROUP,             /* Apply group. */
206     OFPAT12_SET_NW_TTL,        /* IP TTL. */
207     OFPAT12_DEC_NW_TTL,        /* Decrement IP TTL. */
208     OFPAT12_SET_FIELD,         /* Set a header field using OXM TLV format. */
209     OFPAT12_EXPERIMENTER = 0xffff
210 };
211
212 enum ofp12_controller_max_len {
213     OFPCML12_MAX       = 0xffe5, /* maximum max_len value which can be used
214                                   * to request a specific byte length. */
215     OFPCML12_NO_BUFFER = 0xffff  /* indicates that no buffering should be
216                                   * applied and the whole packet is to be
217                                   * sent to the controller. */
218 };
219
220 /* Action structure for OFPAT12_SET_FIELD. */
221 struct ofp12_action_set_field {
222     ovs_be16 type;                  /* OFPAT12_SET_FIELD. */
223     ovs_be16 len;                   /* Length is padded to 64 bits. */
224     ovs_be32 dst;                   /* OXM TLV header */
225     /* Followed by:
226      * - Exactly ((oxm_len + 4) + 7)/8*8 - (oxm_len + 4) (between 0 and 7)
227      *   bytes of all-zero bytes
228      */
229 };
230 OFP_ASSERT(sizeof(struct ofp12_action_set_field) == 8);
231
232 /* OpenFlow 1.2 specific flags
233  * (struct ofp12_flow_mod, member flags). */
234 enum ofp12_flow_mod_flags {
235     OFPFF12_RESET_COUNTS  = 1 << 2   /* Reset flow packet and byte counts. */
236 };
237
238 /* OpenFlow 1.2 specific capabilities
239  * (struct ofp_switch_features, member capabilities). */
240 enum ofp12_capabilities {
241     OFPC12_PORT_BLOCKED   = 1 << 8   /* Switch will block looping ports. */
242 };
243
244 /* OpenFlow 1.2 specific types
245  * (struct ofp11_stats_request/reply, member type). */
246 enum ofp12_stats_types {
247     /* Group features.
248      * The request body is empty.
249      * The reply body is struct ofp12_group_features_stats. */
250     OFPST12_GROUP_FEATURES = 8
251 };
252
253 /* OpenFlow 1.2 specific properties
254  * (struct ofp_queue_prop_header member property). */
255 enum ofp12_queue_properties {
256     OFPQT12_MIN_RATE = 1,         /* Minimum datarate guaranteed. */
257     OFPQT12_MAX_RATE = 2,         /* Maximum datarate. */
258     OFPQT12_EXPERIMENTER = 0xffff /* Experimenter defined property. */
259 };
260
261 /* Body of reply to OFPST_TABLE request. */
262 struct ofp12_table_stats {
263     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
264                                 are consulted first. */
265     uint8_t pad[7];          /* Align to 64-bits. */
266     char name[OFP_MAX_TABLE_NAME_LEN];
267     ovs_be64 match;          /* Bitmap of (1 << OFPXMT_*) that indicate the
268                                 fields the table can match on. */
269     ovs_be64 wildcards;      /* Bitmap of (1 << OFPXMT_*) wildcards that are
270                                 supported by the table. */
271     ovs_be32 write_actions;  /* Bitmap of OFPAT_* that are supported
272                                 by the table with OFPIT_WRITE_ACTIONS. */
273     ovs_be32 apply_actions;  /* Bitmap of OFPAT_* that are supported
274                                 by the table with OFPIT_APPLY_ACTIONS. */
275     ovs_be64 write_setfields;/* Bitmap of (1 << OFPXMT_*) header fields that
276                                 can be set with OFPIT_WRITE_ACTIONS. */
277     ovs_be64 apply_setfields;/* Bitmap of (1 << OFPXMT_*) header fields that
278                                 can be set with OFPIT_APPLY_ACTIONS. */
279     ovs_be64 metadata_match; /* Bits of metadata table can match. */
280     ovs_be64 metadata_write; /* Bits of metadata table can write. */
281     ovs_be32 instructions;   /* Bitmap of OFPIT_* values supported. */
282     ovs_be32 config;         /* Bitmap of OFPTC_* values */
283     ovs_be32 max_entries;    /* Max number of entries supported. */
284     ovs_be32 active_count;   /* Number of active entries. */
285     ovs_be64 lookup_count;   /* Number of packets looked up in table. */
286     ovs_be64 matched_count;  /* Number of packets that hit table. */
287 };
288 OFP_ASSERT(sizeof(struct ofp12_table_stats) == 128);
289
290 /* Body of reply to OFPST12_GROUP_FEATURES request. Group features. */
291 struct ofp12_group_features_stats {
292     ovs_be32  types;           /* Bitmap of OFPGT_* values supported. */
293     ovs_be32  capabilities;    /* Bitmap of OFPGFC12_* capability supported. */
294     ovs_be32  max_groups[4];   /* Maximum number of groups for each type. */
295     ovs_be32  actions[4];      /* Bitmaps of OFPAT_* that are supported. */
296 };
297 OFP_ASSERT(sizeof(struct ofp12_group_features_stats) == 40);
298
299 /* Group configuration flags */
300 enum ofp12_group_capabilities {
301     OFPGFC12_SELECT_WEIGHT   = 1 << 0, /* Support weight for select groups */
302     OFPGFC12_SELECT_LIVENESS = 1 << 1, /* Support liveness for select groups */
303     OFPGFC12_CHAINING        = 1 << 2, /* Support chaining groups */
304     OFPGFC12_CHAINING_CHECKS = 1 << 3, /* Check chaining for loops and delete */
305 };
306
307 /* Body for ofp12_stats_request/reply of type OFPST_EXPERIMENTER. */
308 struct ofp12_experimenter_stats_header {
309     ovs_be32 experimenter;    /* Experimenter ID which takes the same form
310                                  as in struct ofp_experimenter_header. */
311     ovs_be32 exp_type;        /* Experimenter defined. */
312     /* Experimenter-defined arbitrary additional data. */
313 };
314 OFP_ASSERT(sizeof(struct ofp12_experimenter_stats_header) == 8);
315
316 /* Role request and reply message. */
317 struct ofp12_role_request {
318     ovs_be32 role;            /* One of OFPCR12_ROLE_*. */
319     uint8_t pad[4];           /* Align to 64 bits. */
320     ovs_be64 generation_id;   /* Master Election Generation Id */
321 };
322 OFP_ASSERT(sizeof(struct ofp12_role_request) == 16);
323
324 /* Controller roles. */
325 enum ofp12_controller_role {
326     OFPCR12_ROLE_NOCHANGE,    /* Don't change current role. */
327     OFPCR12_ROLE_EQUAL,       /* Default role, full access. */
328     OFPCR12_ROLE_MASTER,      /* Full access, at most one master. */
329     OFPCR12_ROLE_SLAVE,       /* Read-only access. */
330 };
331
332 /* Packet received on port (datapath -> controller). */
333 struct ofp12_packet_in {
334     ovs_be32 buffer_id;     /* ID assigned by datapath. */
335     ovs_be16 total_len;     /* Full length of frame. */
336     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
337     uint8_t table_id;       /* ID of the table that was looked up */
338     /* Followed by:
339      *   - Match
340      *   - Exactly 2 all-zero padding bytes, then
341      *   - An Ethernet frame whose length is inferred from header.length.
342      * The padding bytes preceding the Ethernet frame ensure that the IP
343      * header (if any) following the Ethernet header is 32-bit aligned.
344      */
345     /* struct ofp12_match match; */
346     /* uint8_t pad[2];         Align to 64 bit + 16 bit */
347     /* uint8_t data[0];        Ethernet frame */
348 };
349 OFP_ASSERT(sizeof(struct ofp12_packet_in) == 8);
350
351 /* Flow removed (datapath -> controller). */
352 struct ofp12_flow_removed {
353     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
354
355     ovs_be16 priority;        /* Priority level of flow entry. */
356     uint8_t reason;           /* One of OFPRR_*. */
357     uint8_t table_id;         /* ID of the table */
358
359     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
360     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
361                                  duration_sec. */
362     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
363     ovs_be16 hard_timeout;    /* Hard timeout from original flow mod. */
364     ovs_be64 packet_count;
365     ovs_be64 byte_count;
366     /* struct ofp12_match match;  Description of fields. Variable size. */
367 };
368 OFP_ASSERT(sizeof(struct ofp12_flow_removed) == 40);
369
370 #endif /* openflow/openflow-1.2.h */