2 * Copyright (c) 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include <sys/types.h>
21 #include <netinet/in.h>
22 #include <netinet/ip6.h>
24 #include "ofp-errors.h"
30 /* The comment on each of these indicates the member in "union mf_value" used
31 * to represent its value. */
34 MFF_TUN_ID, /* be64 */
35 MFF_TUN_SRC, /* be32 */
36 MFF_TUN_DST, /* be32 */
37 MFF_TUN_FLAGS, /* be16 */
40 MFF_METADATA, /* be64 */
41 MFF_IN_PORT, /* be16 */
42 MFF_SKB_PRIORITY, /* be32 */
43 MFF_SKB_MARK, /* be32 */
71 MFF_ETH_SRC, /* mac */
72 MFF_ETH_DST, /* mac */
73 MFF_ETH_TYPE, /* be16 */
75 MFF_VLAN_TCI, /* be16 */
76 MFF_DL_VLAN, /* be16 (OpenFlow 1.0 compatibility) */
77 MFF_VLAN_VID, /* be16 (OpenFlow 1.2 compatibility) */
78 MFF_DL_VLAN_PCP, /* u8 (OpenFlow 1.0 compatibility) */
79 MFF_VLAN_PCP, /* be16 (OpenFlow 1.2 compatibility) */
82 MFF_IPV4_SRC, /* be32 */
83 MFF_IPV4_DST, /* be32 */
85 MFF_IPV6_SRC, /* ipv6 */
86 MFF_IPV6_DST, /* ipv6 */
87 MFF_IPV6_LABEL, /* be32 */
89 MFF_IP_PROTO, /* u8 (used for IPv4 or IPv6) */
90 MFF_IP_DSCP, /* u8 (used for IPv4 or IPv6) */
91 MFF_IP_ECN, /* u8 (used for IPv4 or IPv6) */
92 MFF_IP_TTL, /* u8 (used for IPv4 or IPv6) */
93 MFF_IP_FRAG, /* u8 (used for IPv4 or IPv6) */
95 MFF_ARP_OP, /* be16 */
96 MFF_ARP_SPA, /* be32 */
97 MFF_ARP_TPA, /* be32 */
98 MFF_ARP_SHA, /* mac */
99 MFF_ARP_THA, /* mac */
102 MFF_TCP_SRC, /* be16 (used for IPv4 or IPv6) */
103 MFF_TCP_DST, /* be16 (used for IPv4 or IPv6) */
105 MFF_UDP_SRC, /* be16 (used for IPv4 or IPv6) */
106 MFF_UDP_DST, /* be16 (used for IPv4 or IPv6) */
108 MFF_ICMPV4_TYPE, /* u8 */
109 MFF_ICMPV4_CODE, /* u8 */
111 MFF_ICMPV6_TYPE, /* u8 */
112 MFF_ICMPV6_CODE, /* u8 */
114 /* ICMPv6 Neighbor Discovery. */
115 MFF_ND_TARGET, /* ipv6 */
116 MFF_ND_SLL, /* mac */
117 MFF_ND_TLL, /* mac */
122 /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the
125 # define CASE_MFF_REGS \
127 #elif FLOW_N_REGS == 2
128 # define CASE_MFF_REGS \
129 case MFF_REG0: case MFF_REG1
130 #elif FLOW_N_REGS == 3
131 # define CASE_MFF_REGS \
132 case MFF_REG0: case MFF_REG1: case MFF_REG2
133 #elif FLOW_N_REGS == 4
134 # define CASE_MFF_REGS \
135 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3
136 #elif FLOW_N_REGS == 5
137 # define CASE_MFF_REGS \
138 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
140 #elif FLOW_N_REGS == 6
141 # define CASE_MFF_REGS \
142 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
143 case MFF_REG4: case MFF_REG5
144 #elif FLOW_N_REGS == 7
145 # define CASE_MFF_REGS \
146 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
147 case MFF_REG4: case MFF_REG5: case MFF_REG6
148 #elif FLOW_N_REGS == 8
149 # define CASE_MFF_REGS \
150 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
151 case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7
156 /* Prerequisites for matching a field.
158 * A field may only be matched if the correct lower-level protocols are also
159 * matched. For example, the TCP port may be matched only if the Ethernet type
160 * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
164 /* L2 requirements. */
171 /* L2+L3 requirements. */
172 MFP_TCP, /* On IPv4 or IPv6. */
173 MFP_UDP, /* On IPv4 or IPv6. */
177 /* L2+L3+L4 requirements. */
183 /* Forms of partial-field masking allowed for a field.
185 * Every field may be masked as a whole. */
187 MFM_NONE, /* No sub-field masking. */
188 MFM_FULLY, /* Every bit is individually maskable. */
191 /* How to format or parse a field's value. */
195 * The particular MFS_* constant sets the output format. On input, either
196 * decimal or hexadecimal (prefixed with 0x) is accepted. */
204 MFS_OFP_PORT, /* An OpenFlow port number or name. */
205 MFS_FRAG, /* no, yes, first, later, not_later */
206 MFS_TNL_FLAGS, /* FLOW_TNL_F_* flags */
210 /* Identification. */
211 enum mf_field_id id; /* MFF_*. */
212 const char *name; /* Name of this field, e.g. "eth_type". */
213 const char *extra_name; /* Alternate name, e.g. "dl_type", or NULL. */
217 * Most fields have n_bytes * 8 == n_bits. There are a few exceptions:
219 * - "dl_vlan" is 2 bytes but only 12 bits.
220 * - "dl_vlan_pcp" is 1 byte but only 3 bits.
221 * - "is_frag" is 1 byte but only 2 bits.
222 * - "ipv6_label" is 4 bytes but only 20 bits.
224 unsigned int n_bytes; /* Width of the field in bytes. */
225 unsigned int n_bits; /* Number of significant bits in field. */
228 enum mf_maskable maskable;
229 enum mf_string string;
230 enum mf_prereqs prereqs;
231 bool writable; /* May be written by actions? */
233 /* NXM and OXM properties.
235 * There are the following possibilities for these members for a given
238 * - Neither NXM nor OXM defines such a field: these members will all be
241 * - NXM and OXM both define such a field: nxm_header and oxm_header will
242 * both be nonzero and different, similarly for nxm_name and oxm_name.
244 * - Only NXM or only OXM defines such a field: nxm_header and oxm_header
245 * will both have the same value (either an OXM_* or NXM_* value) and
246 * similarly for nxm_name and oxm_name.
248 * Thus, 'nxm_header' is the appropriate header to use when outputting an
249 * NXM formatted match, since it will be an NXM_* constant when possible
250 * for compatibility with OpenFlow implementations that expect that, with
251 * OXM_* constants used for fields that OXM adds. Conversely, 'oxm_header'
252 * is the header to use when outputting an OXM formatted match. */
253 uint32_t nxm_header; /* An NXM_* (or OXM_*) constant. */
254 const char *nxm_name; /* The nxm_header constant's name. */
255 uint32_t oxm_header; /* An OXM_* (or NXM_*) constant. */
256 const char *oxm_name; /* The oxm_header constant's name */
259 /* The representation of a field's value. */
265 uint8_t mac[ETH_ADDR_LEN];
266 struct in6_addr ipv6;
268 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
270 /* Part of a field. */
272 const struct mf_field *field;
273 unsigned int ofs; /* Bit offset. */
274 unsigned int n_bits; /* Number of bits. */
277 /* Data for some part of an mf_field.
279 * The data is stored "right-justified". For example, if "union mf_subvalue
280 * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
281 * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
288 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
290 /* Finding mf_fields. */
291 const struct mf_field *mf_from_id(enum mf_field_id);
292 const struct mf_field *mf_from_name(const char *name);
293 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
294 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
296 /* Inspecting wildcarded bits. */
297 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
299 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
300 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
301 union mf_value *mask);
304 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
305 void mf_force_prereqs(const struct mf_field *, struct match *);
308 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
310 void mf_get_value(const struct mf_field *, const struct flow *,
311 union mf_value *value);
312 void mf_set_value(const struct mf_field *, const union mf_value *value,
314 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
316 bool mf_is_zero(const struct mf_field *, const struct flow *);
318 void mf_get(const struct mf_field *, const struct match *,
319 union mf_value *value, union mf_value *mask);
320 void mf_set(const struct mf_field *,
321 const union mf_value *value, const union mf_value *mask,
324 void mf_set_wild(const struct mf_field *, struct match *);
326 void mf_random_value(const struct mf_field *, union mf_value *value);
329 void mf_write_subfield_flow(const struct mf_subfield *,
330 const union mf_subvalue *, struct flow *);
331 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
334 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
335 union mf_subvalue *);
336 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
339 void mf_format_subfield(const struct mf_subfield *, struct ds *);
340 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
341 const char *mf_parse_subfield(struct mf_subfield *, const char *);
343 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
344 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
346 /* Parsing and formatting. */
347 char *mf_parse(const struct mf_field *, const char *,
348 union mf_value *value, union mf_value *mask);
349 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
350 void mf_format(const struct mf_field *,
351 const union mf_value *value, const union mf_value *mask,
353 void mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s);
355 #endif /* meta-flow.h */