ofp-util: Allow decoding of Open Flow 1.2 Flow Statistics Response Messages
[sliver-openvswitch.git] / lib / meta-flow.h
1 /*
2  * Copyright (c) 2011, 2012 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef META_FLOW_H
18 #define META_FLOW_H 1
19
20 #include <sys/types.h>
21 #include <netinet/in.h>
22 #include <netinet/ip6.h>
23 #include "flow.h"
24 #include "ofp-errors.h"
25 #include "packets.h"
26
27 struct cls_rule;
28 struct ds;
29
30 /* The comment on each of these indicates the member in "union mf_value" used
31  * to represent its value. */
32 enum mf_field_id {
33     /* Metadata. */
34     MFF_TUN_ID,                 /* be64 */
35     MFF_METADATA,               /* be64 */
36     MFF_IN_PORT,                /* be16 */
37
38 #if FLOW_N_REGS > 0
39     MFF_REG0,                   /* be32 */
40 #endif
41 #if FLOW_N_REGS > 1
42     MFF_REG1,                   /* be32 */
43 #endif
44 #if FLOW_N_REGS > 2
45     MFF_REG2,                   /* be32 */
46 #endif
47 #if FLOW_N_REGS > 3
48     MFF_REG3,                   /* be32 */
49 #endif
50 #if FLOW_N_REGS > 4
51     MFF_REG4,                   /* be32 */
52 #endif
53 #if FLOW_N_REGS > 5
54     MFF_REG5,                   /* be32 */
55 #endif
56 #if FLOW_N_REGS > 6
57     MFF_REG6,                   /* be32 */
58 #endif
59 #if FLOW_N_REGS > 7
60     MFF_REG7,                   /* be32 */
61 #endif
62
63     /* L2. */
64     MFF_ETH_SRC,                /* mac */
65     MFF_ETH_DST,                /* mac */
66     MFF_ETH_TYPE,               /* be16 */
67
68     MFF_VLAN_TCI,               /* be16 */
69     MFF_DL_VLAN,                /* be16 (OpenFlow 1.0 compatibility) */
70     MFF_VLAN_VID,               /* be16 (OpenFlow 1.2 compatibility) */
71     MFF_DL_VLAN_PCP,            /* u8 (OpenFlow 1.0 compatibility) */
72     MFF_VLAN_PCP,               /* be16 (OpenFlow 1.2 compatibility) */
73
74     /* L3. */
75     MFF_IPV4_SRC,               /* be32 */
76     MFF_IPV4_DST,               /* be32 */
77
78     MFF_IPV6_SRC,               /* ipv6 */
79     MFF_IPV6_DST,               /* ipv6 */
80     MFF_IPV6_LABEL,             /* be32 */
81
82     MFF_IP_PROTO,               /* u8 (used for IPv4 or IPv6) */
83     MFF_IP_DSCP,                /* u8 (used for IPv4 or IPv6) */
84     MFF_IP_ECN,                 /* u8 (used for IPv4 or IPv6) */
85     MFF_IP_TTL,                 /* u8 (used for IPv4 or IPv6) */
86     MFF_IP_FRAG,                /* u8 (used for IPv4 or IPv6) */
87
88     MFF_ARP_OP,                 /* be16 */
89     MFF_ARP_SPA,                /* be32 */
90     MFF_ARP_TPA,                /* be32 */
91     MFF_ARP_SHA,                /* mac */
92     MFF_ARP_THA,                /* mac */
93
94     /* L4. */
95     MFF_TCP_SRC,                /* be16 (used for IPv4 or IPv6) */
96     MFF_TCP_DST,                /* be16 (used for IPv4 or IPv6) */
97
98     MFF_UDP_SRC,                /* be16 (used for IPv4 or IPv6) */
99     MFF_UDP_DST,                /* be16 (used for IPv4 or IPv6) */
100
101     MFF_ICMPV4_TYPE,            /* u8 */
102     MFF_ICMPV4_CODE,            /* u8 */
103
104     MFF_ICMPV6_TYPE,            /* u8 */
105     MFF_ICMPV6_CODE,            /* u8 */
106
107     /* ICMPv6 Neighbor Discovery. */
108     MFF_ND_TARGET,              /* ipv6 */
109     MFF_ND_SLL,                 /* mac */
110     MFF_ND_TLL,                 /* mac */
111
112     MFF_N_IDS
113 };
114
115 /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the
116  * MFF_REGx cases. */
117 #if FLOW_N_REGS == 1
118 # define CASE_MFF_REGS                                          \
119     case MFF_REG0
120 #elif FLOW_N_REGS == 2
121 # define CASE_MFF_REGS                                          \
122     case MFF_REG0: case MFF_REG1
123 #elif FLOW_N_REGS == 3
124 # define CASE_MFF_REGS                                          \
125     case MFF_REG0: case MFF_REG1: case MFF_REG2
126 #elif FLOW_N_REGS == 4
127 # define CASE_MFF_REGS                                          \
128     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3
129 #elif FLOW_N_REGS == 5
130 # define CASE_MFF_REGS                                          \
131     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
132     case MFF_REG4
133 #elif FLOW_N_REGS == 6
134 # define CASE_MFF_REGS                                          \
135     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
136     case MFF_REG4: case MFF_REG5
137 #elif FLOW_N_REGS == 7
138 # define CASE_MFF_REGS                                          \
139     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
140     case MFF_REG4: case MFF_REG5: case MFF_REG6
141 #elif FLOW_N_REGS == 8
142 # define CASE_MFF_REGS                                          \
143     case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
144     case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7
145 #else
146 # error
147 #endif
148
149 /* Prerequisites for matching a field.
150  *
151  * A field may only be matched if the correct lower-level protocols are also
152  * matched.  For example, the TCP port may be matched only if the Ethernet type
153  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
154 enum mf_prereqs {
155     MFP_NONE,
156
157     /* L2 requirements. */
158     MFP_ARP,
159     MFP_VLAN_VID,
160     MFP_IPV4,
161     MFP_IPV6,
162     MFP_IP_ANY,
163
164     /* L2+L3 requirements. */
165     MFP_TCP,                    /* On IPv4 or IPv6. */
166     MFP_UDP,                    /* On IPv4 or IPv6. */
167     MFP_ICMPV4,
168     MFP_ICMPV6,
169
170     /* L2+L3+L4 requirements. */
171     MFP_ND,
172     MFP_ND_SOLICIT,
173     MFP_ND_ADVERT
174 };
175
176 /* Forms of partial-field masking allowed for a field.
177  *
178  * Every field may be masked as a whole. */
179 enum mf_maskable {
180     MFM_NONE,                   /* No sub-field masking. */
181     MFM_FULLY,                  /* Every bit is individually maskable. */
182 };
183
184 /* How to format or parse a field's value. */
185 enum mf_string {
186     /* Integer formats.
187      *
188      * The particular MFS_* constant sets the output format.  On input, either
189      * decimal or hexadecimal (prefixed with 0x) is accepted. */
190     MFS_DECIMAL,
191     MFS_HEXADECIMAL,
192
193     /* Other formats. */
194     MFS_ETHERNET,
195     MFS_IPV4,
196     MFS_IPV6,
197     MFS_OFP_PORT,               /* An OpenFlow port number or name. */
198     MFS_FRAG                    /* no, yes, first, later, not_later */
199 };
200
201 struct mf_field {
202     /* Identification. */
203     enum mf_field_id id;        /* MFF_*. */
204     const char *name;           /* Name of this field, e.g. "eth_type". */
205     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
206
207     /* Size.
208      *
209      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
210      *
211      *     - "dl_vlan" is 2 bytes but only 12 bits.
212      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
213      *     - "is_frag" is 1 byte but only 2 bits.
214      *     - "ipv6_label" is 4 bytes but only 20 bits.
215      */
216     unsigned int n_bytes;       /* Width of the field in bytes. */
217     unsigned int n_bits;        /* Number of significant bits in field. */
218
219     /* Properties. */
220     enum mf_maskable maskable;
221     flow_wildcards_t fww_bit;   /* Either 0 or exactly one FWW_* bit. */
222     enum mf_string string;
223     enum mf_prereqs prereqs;
224     bool writable;              /* May be written by actions? */
225
226     /* NXM and OXM properties.
227      *
228      * There are the following possibilities for these members for a given
229      * mf_field:
230      *
231      *   - Neither NXM nor OXM defines such a field: these members will all be
232      *     zero or NULL.
233      *
234      *   - NXM and OXM both define such a field: nxm_header and oxm_header will
235      *     both be nonzero and different, similarly for nxm_name and oxm_name.
236      *
237      *   - Only NXM or only OXM defines such a field: nxm_header and oxm_header
238      *     will both have the same value (either an OXM_* or NXM_* value) and
239      *     similarly for nxm_name and oxm_name.
240      *
241      * Thus, 'nxm_header' is the appropriate header to use when outputting an
242      * NXM formatted match, since it will be an NXM_* constant when possible
243      * for compatibility with OpenFlow implementations that expect that, with
244      * OXM_* constants used for fields that OXM adds.  Conversely, 'oxm_header'
245      * is the header to use when outputting an OXM formatted match. */
246     uint32_t nxm_header;        /* An NXM_* (or OXM_*) constant. */
247     const char *nxm_name;       /* The nxm_header constant's name. */
248     uint32_t oxm_header;        /* An OXM_* (or NXM_*) constant. */
249     const char *oxm_name;           /* The oxm_header constant's name */
250 };
251
252 /* The representation of a field's value. */
253 union mf_value {
254     uint8_t u8;
255     ovs_be16 be16;
256     ovs_be32 be32;
257     ovs_be64 be64;
258     uint8_t mac[ETH_ADDR_LEN];
259     struct in6_addr ipv6;
260 };
261 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
262
263 /* Part of a field. */
264 struct mf_subfield {
265     const struct mf_field *field;
266     unsigned int ofs;           /* Bit offset. */
267     unsigned int n_bits;        /* Number of bits. */
268 };
269
270 /* Data for some part of an mf_field.
271  *
272  * The data is stored "right-justified".  For example, if "union mf_subvalue
273  * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
274  * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
275 union mf_subvalue {
276     uint8_t u8[16];
277     ovs_be16 be16[8];
278     ovs_be32 be32[4];
279     ovs_be64 be64[2];
280 };
281 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
282
283 /* Finding mf_fields. */
284 const struct mf_field *mf_from_id(enum mf_field_id);
285 const struct mf_field *mf_from_name(const char *name);
286 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
287 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
288
289 /* Inspecting wildcarded bits. */
290 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
291
292 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
293 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
294                  union mf_value *mask);
295
296 /* Prerequisites. */
297 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
298 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
299
300 /* Field values. */
301 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
302
303 void mf_get_value(const struct mf_field *, const struct flow *,
304                   union mf_value *value);
305 void mf_set_value(const struct mf_field *, const union mf_value *value,
306                   struct cls_rule *);
307 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
308                        struct flow *);
309 bool mf_is_zero(const struct mf_field *, const struct flow *);
310
311 void mf_get(const struct mf_field *, const struct cls_rule *,
312             union mf_value *value, union mf_value *mask);
313 void mf_set(const struct mf_field *,
314             const union mf_value *value, const union mf_value *mask,
315             struct cls_rule *);
316
317 void mf_set_wild(const struct mf_field *, struct cls_rule *);
318
319 void mf_random_value(const struct mf_field *, union mf_value *value);
320
321 /* Subfields. */
322 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
323                        struct cls_rule *);
324
325 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
326                       union mf_subvalue *);
327 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
328
329
330 void mf_format_subfield(const struct mf_subfield *, struct ds *);
331 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
332 const char *mf_parse_subfield(struct mf_subfield *, const char *);
333
334 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
335 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
336
337 /* Parsing and formatting. */
338 char *mf_parse(const struct mf_field *, const char *,
339                union mf_value *value, union mf_value *mask);
340 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
341 void mf_format(const struct mf_field *,
342                const union mf_value *value, const union mf_value *mask,
343                struct ds *);
344
345 #endif /* meta-flow.h */