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_METADATA, /* be64 */
36 MFF_IN_PORT, /* be16 */
64 MFF_ETH_SRC, /* mac */
65 MFF_ETH_DST, /* mac */
66 MFF_ETH_TYPE, /* be16 */
68 MFF_VLAN_TCI, /* be16 */
69 MFF_VLAN_VID, /* be16 */
70 MFF_VLAN_PCP, /* u8 */
73 MFF_IPV4_SRC, /* be32 */
74 MFF_IPV4_DST, /* be32 */
76 MFF_IPV6_SRC, /* ipv6 */
77 MFF_IPV6_DST, /* ipv6 */
78 MFF_IPV6_LABEL, /* be32 */
80 MFF_IP_PROTO, /* u8 (used for IPv4 or IPv6) */
81 MFF_IP_DSCP, /* u8 (used for IPv4 or IPv6) */
82 MFF_IP_ECN, /* u8 (used for IPv4 or IPv6) */
83 MFF_IP_TTL, /* u8 (used for IPv4 or IPv6) */
84 MFF_IP_FRAG, /* u8 (used for IPv4 or IPv6) */
86 MFF_ARP_OP, /* be16 */
87 MFF_ARP_SPA, /* be32 */
88 MFF_ARP_TPA, /* be32 */
89 MFF_ARP_SHA, /* mac */
90 MFF_ARP_THA, /* mac */
93 MFF_TCP_SRC, /* be16 (used for IPv4 or IPv6) */
94 MFF_TCP_DST, /* be16 (used for IPv4 or IPv6) */
96 MFF_UDP_SRC, /* be16 (used for IPv4 or IPv6) */
97 MFF_UDP_DST, /* be16 (used for IPv4 or IPv6) */
99 MFF_ICMPV4_TYPE, /* u8 */
100 MFF_ICMPV4_CODE, /* u8 */
102 MFF_ICMPV6_TYPE, /* u8 */
103 MFF_ICMPV6_CODE, /* u8 */
105 /* ICMPv6 Neighbor Discovery. */
106 MFF_ND_TARGET, /* ipv6 */
107 MFF_ND_SLL, /* mac */
108 MFF_ND_TLL, /* mac */
113 /* Use this macro as CASE_MFF_REGS: in a switch statement to choose all of the
116 # define CASE_MFF_REGS \
118 #elif FLOW_N_REGS == 2
119 # define CASE_MFF_REGS \
120 case MFF_REG0: case MFF_REG1
121 #elif FLOW_N_REGS == 3
122 # define CASE_MFF_REGS \
123 case MFF_REG0: case MFF_REG1: case MFF_REG2
124 #elif FLOW_N_REGS == 4
125 # define CASE_MFF_REGS \
126 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3
127 #elif FLOW_N_REGS == 5
128 # define CASE_MFF_REGS \
129 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
131 #elif FLOW_N_REGS == 6
132 # define CASE_MFF_REGS \
133 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
134 case MFF_REG4: case MFF_REG5
135 #elif FLOW_N_REGS == 7
136 # define CASE_MFF_REGS \
137 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
138 case MFF_REG4: case MFF_REG5: case MFF_REG6
139 #elif FLOW_N_REGS == 8
140 # define CASE_MFF_REGS \
141 case MFF_REG0: case MFF_REG1: case MFF_REG2: case MFF_REG3: \
142 case MFF_REG4: case MFF_REG5: case MFF_REG6: case MFF_REG7
147 /* Prerequisites for matching a field.
149 * A field may only be matched if the correct lower-level protocols are also
150 * matched. For example, the TCP port may be matched only if the Ethernet type
151 * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
155 /* L2 requirements. */
161 /* L2+L3 requirements. */
162 MFP_TCP, /* On IPv4 or IPv6. */
163 MFP_UDP, /* On IPv4 or IPv6. */
167 /* L2+L3+L4 requirements. */
173 /* Forms of partial-field masking allowed for a field.
175 * Every field may be masked as a whole. */
177 MFM_NONE, /* No sub-field masking. */
178 MFM_FULLY, /* Every bit is individually maskable. */
181 /* How to format or parse a field's value. */
185 * The particular MFS_* constant sets the output format. On input, either
186 * decimal or hexadecimal (prefixed with 0x) is accepted. */
194 MFS_OFP_PORT, /* An OpenFlow port number or name. */
195 MFS_FRAG /* no, yes, first, later, not_later */
199 /* Identification. */
200 enum mf_field_id id; /* MFF_*. */
201 const char *name; /* Name of this field, e.g. "eth_type". */
202 const char *extra_name; /* Alternate name, e.g. "dl_type", or NULL. */
206 * Most fields have n_bytes * 8 == n_bits. There are a few exceptions:
208 * - "dl_vlan" is 2 bytes but only 12 bits.
209 * - "dl_vlan_pcp" is 1 byte but only 3 bits.
210 * - "is_frag" is 1 byte but only 2 bits.
211 * - "ipv6_label" is 4 bytes but only 20 bits.
213 unsigned int n_bytes; /* Width of the field in bytes. */
214 unsigned int n_bits; /* Number of significant bits in field. */
217 enum mf_maskable maskable;
218 flow_wildcards_t fww_bit; /* Either 0 or exactly one FWW_* bit. */
219 enum mf_string string;
220 enum mf_prereqs prereqs;
221 bool writable; /* May be written by actions? */
223 /* NXM and OXM properties.
225 * There are the following possibilities for these members for a given
228 * - Neither NXM nor OXM defines such a field: these members will all be
231 * - NXM and OXM both define such a field: nxm_header and oxm_header will
232 * both be nonzero and different, similarly for nxm_name and oxm_name.
234 * - Only NXM or only OXM defines such a field: nxm_header and oxm_header
235 * will both have the same value (either an OXM_* or NXM_* value) and
236 * similarly for nxm_name and oxm_name.
238 * Thus, 'nxm_header' is the appropriate header to use when outputting an
239 * NXM formatted match, since it will be an NXM_* constant when possible
240 * for compatibility with OpenFlow implementations that expect that, with
241 * OXM_* constants used for fields that OXM adds. Conversely, 'oxm_header'
242 * is the header to use when outputting an OXM formatted match. */
243 uint32_t nxm_header; /* An NXM_* (or OXM_*) constant. */
244 const char *nxm_name; /* The nxm_header constant's name. */
245 uint32_t oxm_header; /* An OXM_* (or NXM_*) constant. */
246 const char *oxm_name; /* The oxm_header constant's name */
249 /* The representation of a field's value. */
255 uint8_t mac[ETH_ADDR_LEN];
256 struct in6_addr ipv6;
258 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
260 /* Part of a field. */
262 const struct mf_field *field;
263 unsigned int ofs; /* Bit offset. */
264 unsigned int n_bits; /* Number of bits. */
267 /* Data for some part of an mf_field.
269 * The data is stored "right-justified". For example, if "union mf_subvalue
270 * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
271 * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
278 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
280 /* Finding mf_fields. */
281 const struct mf_field *mf_from_id(enum mf_field_id);
282 const struct mf_field *mf_from_name(const char *name);
283 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
284 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
286 /* Inspecting wildcarded bits. */
287 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
289 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
290 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
291 union mf_value *mask);
294 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
295 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
298 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
300 void mf_get_value(const struct mf_field *, const struct flow *,
301 union mf_value *value);
302 void mf_set_value(const struct mf_field *, const union mf_value *value,
304 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
306 bool mf_is_zero(const struct mf_field *, const struct flow *);
308 void mf_get(const struct mf_field *, const struct cls_rule *,
309 union mf_value *value, union mf_value *mask);
310 void mf_set(const struct mf_field *,
311 const union mf_value *value, const union mf_value *mask,
314 void mf_set_wild(const struct mf_field *, struct cls_rule *);
316 void mf_random_value(const struct mf_field *, union mf_value *value);
319 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
322 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
323 union mf_subvalue *);
324 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
327 void mf_format_subfield(const struct mf_subfield *, struct ds *);
328 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
329 const char *mf_parse_subfield(struct mf_subfield *, const char *);
331 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
332 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
334 /* Parsing and formatting. */
335 char *mf_parse(const struct mf_field *, const char *,
336 union mf_value *value, union mf_value *mask);
337 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
338 void mf_format(const struct mf_field *,
339 const union mf_value *value, const union mf_value *mask,
342 #endif /* meta-flow.h */