cfm: Warn when delayed sending CCMs.
[openvswitch] / 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_IN_PORT,                /* be16 */
36
37 #if FLOW_N_REGS > 0
38     MFF_REG0,                   /* be32 */
39 #endif
40 #if FLOW_N_REGS > 1
41     MFF_REG1,                   /* be32 */
42 #endif
43 #if FLOW_N_REGS > 2
44     MFF_REG2,                   /* be32 */
45 #endif
46 #if FLOW_N_REGS > 3
47     MFF_REG3,                   /* be32 */
48 #endif
49 #if FLOW_N_REGS > 4
50     MFF_REG4,                   /* be32 */
51 #endif
52 #if FLOW_N_REGS > 5
53     MFF_REG5,                   /* be32 */
54 #endif
55 #if FLOW_N_REGS > 6
56     MFF_REG6,                   /* be32 */
57 #endif
58 #if FLOW_N_REGS > 7
59     MFF_REG7,                   /* be32 */
60 #endif
61 #if FLOW_N_REGS > 8
62 #error
63 #endif
64
65     /* L2. */
66     MFF_ETH_SRC,                /* mac */
67     MFF_ETH_DST,                /* mac */
68     MFF_ETH_TYPE,               /* be16 */
69
70     MFF_VLAN_TCI,               /* be16 */
71     MFF_VLAN_VID,               /* be16 */
72     MFF_VLAN_PCP,               /* u8 */
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 /* Prerequisites for matching a field.
116  *
117  * A field may only be matched if the correct lower-level protocols are also
118  * matched.  For example, the TCP port may be matched only if the Ethernet type
119  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
120 enum mf_prereqs {
121     MFP_NONE,
122
123     /* L2 requirements. */
124     MFP_ARP,
125     MFP_IPV4,
126     MFP_IPV6,
127     MFP_IP_ANY,
128
129     /* L2+L3 requirements. */
130     MFP_TCP,                    /* On IPv4 or IPv6. */
131     MFP_UDP,                    /* On IPv4 or IPv6. */
132     MFP_ICMPV4,
133     MFP_ICMPV6,
134
135     /* L2+L3+L4 requirements. */
136     MFP_ND,
137     MFP_ND_SOLICIT,
138     MFP_ND_ADVERT
139 };
140
141 /* Forms of partial-field masking allowed for a field.
142  *
143  * Every field may be masked as a whole. */
144 enum mf_maskable {
145     MFM_NONE,                   /* No sub-field masking. */
146     MFM_FULLY,                  /* Every bit is individually maskable. */
147 };
148
149 /* How to format or parse a field's value. */
150 enum mf_string {
151     /* Integer formats.
152      *
153      * The particular MFS_* constant sets the output format.  On input, either
154      * decimal or hexadecimal (prefixed with 0x) is accepted. */
155     MFS_DECIMAL,
156     MFS_HEXADECIMAL,
157
158     /* Other formats. */
159     MFS_ETHERNET,
160     MFS_IPV4,
161     MFS_IPV6,
162     MFS_OFP_PORT,               /* An OpenFlow port number or name. */
163     MFS_FRAG                    /* no, yes, first, later, not_later */
164 };
165
166 struct mf_field {
167     /* Identification. */
168     enum mf_field_id id;        /* MFF_*. */
169     const char *name;           /* Name of this field, e.g. "eth_type". */
170     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
171
172     /* Size.
173      *
174      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
175      *
176      *     - "dl_vlan" is 2 bytes but only 12 bits.
177      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
178      *     - "is_frag" is 1 byte but only 2 bits.
179      *     - "ipv6_label" is 4 bytes but only 20 bits.
180      */
181     unsigned int n_bytes;       /* Width of the field in bytes. */
182     unsigned int n_bits;        /* Number of significant bits in field. */
183
184     /* Properties. */
185     enum mf_maskable maskable;
186     flow_wildcards_t fww_bit;   /* Either 0 or exactly one FWW_* bit. */
187     enum mf_string string;
188     enum mf_prereqs prereqs;
189     bool writable;              /* May be written by actions? */
190
191     /* NXM properties.
192      *
193      * A few "mf_field"s don't correspond to NXM fields.  Those have 0 and
194      * NULL for the following members, respectively. */
195     uint32_t nxm_header;        /* An NXM_* constant (a few fields have 0). */
196     const char *nxm_name;       /* The "NXM_*" constant's name. */
197
198     /* OXM properties */
199     uint32_t oxm_header;        /* Field id in the OXM basic class,
200                                  * an OXM_* constant.
201                                  * Ignored if oxm_name is NULL */
202     const char *oxm_name;       /* The OXM_* constant's name,
203                                  * NULL if the field is not present
204                                  * in the OXM basic class */
205
206 };
207
208 /* The representation of a field's value. */
209 union mf_value {
210     uint8_t u8;
211     ovs_be16 be16;
212     ovs_be32 be32;
213     ovs_be64 be64;
214     uint8_t mac[ETH_ADDR_LEN];
215     struct in6_addr ipv6;
216 };
217 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
218
219 /* Part of a field. */
220 struct mf_subfield {
221     const struct mf_field *field;
222     unsigned int ofs;           /* Bit offset. */
223     unsigned int n_bits;        /* Number of bits. */
224 };
225
226 /* Data for some part of an mf_field.
227  *
228  * The data is stored "right-justified".  For example, if "union mf_subvalue
229  * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
230  * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
231 union mf_subvalue {
232     uint8_t u8[16];
233     ovs_be16 be16[8];
234     ovs_be32 be32[4];
235     ovs_be64 be64[2];
236 };
237 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
238
239 /* Finding mf_fields. */
240 const struct mf_field *mf_from_id(enum mf_field_id);
241 const struct mf_field *mf_from_name(const char *name);
242 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
243 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
244
245 /* Inspecting wildcarded bits. */
246 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
247
248 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
249 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
250                  union mf_value *mask);
251
252 /* Prerequisites. */
253 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
254 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
255
256 /* Field values. */
257 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
258
259 void mf_get_value(const struct mf_field *, const struct flow *,
260                   union mf_value *value);
261 void mf_set_value(const struct mf_field *, const union mf_value *value,
262                   struct cls_rule *);
263 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
264                        struct flow *);
265 bool mf_is_zero(const struct mf_field *, const struct flow *);
266
267 void mf_get(const struct mf_field *, const struct cls_rule *,
268             union mf_value *value, union mf_value *mask);
269 void mf_set(const struct mf_field *,
270             const union mf_value *value, const union mf_value *mask,
271             struct cls_rule *);
272
273 void mf_set_wild(const struct mf_field *, struct cls_rule *);
274
275 void mf_random_value(const struct mf_field *, union mf_value *value);
276
277 /* Subfields. */
278 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
279                        struct cls_rule *);
280 void mf_set_subfield(const struct mf_subfield *, uint64_t value,
281                      struct cls_rule *);
282 void mf_set_subfield_value(const struct mf_subfield *, uint64_t value,
283                            struct flow *);
284
285 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
286                       union mf_subvalue *);
287 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
288
289
290 void mf_format_subfield(const struct mf_subfield *, struct ds *);
291 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
292 const char *mf_parse_subfield(struct mf_subfield *, const char *);
293
294 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
295 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
296
297 /* Parsing and formatting. */
298 char *mf_parse(const struct mf_field *, const char *,
299                union mf_value *value, union mf_value *mask);
300 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
301 void mf_format(const struct mf_field *,
302                const union mf_value *value, const union mf_value *mask,
303                struct ds *);
304
305 #endif /* meta-flow.h */