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 */
67 MFF_ETH_SRC, /* mac */
68 MFF_ETH_DST, /* mac */
69 MFF_ETH_TYPE, /* be16 */
71 MFF_VLAN_TCI, /* be16 */
72 MFF_VLAN_VID, /* be16 */
73 MFF_VLAN_PCP, /* u8 */
76 MFF_IPV4_SRC, /* be32 */
77 MFF_IPV4_DST, /* be32 */
79 MFF_IPV6_SRC, /* ipv6 */
80 MFF_IPV6_DST, /* ipv6 */
81 MFF_IPV6_LABEL, /* be32 */
83 MFF_IP_PROTO, /* u8 (used for IPv4 or IPv6) */
84 MFF_IP_DSCP, /* u8 (used for IPv4 or IPv6) */
85 MFF_IP_ECN, /* u8 (used for IPv4 or IPv6) */
86 MFF_IP_TTL, /* u8 (used for IPv4 or IPv6) */
87 MFF_IP_FRAG, /* u8 (used for IPv4 or IPv6) */
89 MFF_ARP_OP, /* be16 */
90 MFF_ARP_SPA, /* be32 */
91 MFF_ARP_TPA, /* be32 */
92 MFF_ARP_SHA, /* mac */
93 MFF_ARP_THA, /* mac */
96 MFF_TCP_SRC, /* be16 (used for IPv4 or IPv6) */
97 MFF_TCP_DST, /* be16 (used for IPv4 or IPv6) */
99 MFF_UDP_SRC, /* be16 (used for IPv4 or IPv6) */
100 MFF_UDP_DST, /* be16 (used for IPv4 or IPv6) */
102 MFF_ICMPV4_TYPE, /* u8 */
103 MFF_ICMPV4_CODE, /* u8 */
105 MFF_ICMPV6_TYPE, /* u8 */
106 MFF_ICMPV6_CODE, /* u8 */
108 /* ICMPv6 Neighbor Discovery. */
109 MFF_ND_TARGET, /* ipv6 */
110 MFF_ND_SLL, /* mac */
111 MFF_ND_TLL, /* mac */
116 /* Prerequisites for matching a field.
118 * A field may only be matched if the correct lower-level protocols are also
119 * matched. For example, the TCP port may be matched only if the Ethernet type
120 * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
124 /* L2 requirements. */
130 /* L2+L3 requirements. */
131 MFP_TCP, /* On IPv4 or IPv6. */
132 MFP_UDP, /* On IPv4 or IPv6. */
136 /* L2+L3+L4 requirements. */
142 /* Forms of partial-field masking allowed for a field.
144 * Every field may be masked as a whole. */
146 MFM_NONE, /* No sub-field masking. */
147 MFM_FULLY, /* Every bit is individually maskable. */
150 /* How to format or parse a field's value. */
154 * The particular MFS_* constant sets the output format. On input, either
155 * decimal or hexadecimal (prefixed with 0x) is accepted. */
163 MFS_OFP_PORT, /* An OpenFlow port number or name. */
164 MFS_FRAG /* no, yes, first, later, not_later */
168 /* Identification. */
169 enum mf_field_id id; /* MFF_*. */
170 const char *name; /* Name of this field, e.g. "eth_type". */
171 const char *extra_name; /* Alternate name, e.g. "dl_type", or NULL. */
175 * Most fields have n_bytes * 8 == n_bits. There are a few exceptions:
177 * - "dl_vlan" is 2 bytes but only 12 bits.
178 * - "dl_vlan_pcp" is 1 byte but only 3 bits.
179 * - "is_frag" is 1 byte but only 2 bits.
180 * - "ipv6_label" is 4 bytes but only 20 bits.
182 unsigned int n_bytes; /* Width of the field in bytes. */
183 unsigned int n_bits; /* Number of significant bits in field. */
186 enum mf_maskable maskable;
187 flow_wildcards_t fww_bit; /* Either 0 or exactly one FWW_* bit. */
188 enum mf_string string;
189 enum mf_prereqs prereqs;
190 bool writable; /* May be written by actions? */
192 /* NXM and OXM properties.
194 * There are the following possibilities for these members for a given
197 * - Neither NXM nor OXM defines such a field: these members will all be
200 * - NXM and OXM both define such a field: nxm_header and oxm_header will
201 * both be nonzero and different, similarly for nxm_name and oxm_name.
203 * - Only NXM or only OXM defines such a field: nxm_header and oxm_header
204 * will both have the same value (either an OXM_* or NXM_* value) and
205 * similarly for nxm_name and oxm_name.
207 * Thus, 'nxm_header' is the appropriate header to use when outputting an
208 * NXM formatted match, since it will be an NXM_* constant when possible
209 * for compatibility with OpenFlow implementations that expect that, with
210 * OXM_* constants used for fields that OXM adds. Conversely, 'oxm_header'
211 * is the header to use when outputting an OXM formatted match. */
212 uint32_t nxm_header; /* An NXM_* (or OXM_*) constant. */
213 const char *nxm_name; /* The nxm_header constant's name. */
214 uint32_t oxm_header; /* An OXM_* (or NXM_*) constant. */
215 const char *oxm_name; /* The oxm_header constant's name */
218 /* The representation of a field's value. */
224 uint8_t mac[ETH_ADDR_LEN];
225 struct in6_addr ipv6;
227 BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
229 /* Part of a field. */
231 const struct mf_field *field;
232 unsigned int ofs; /* Bit offset. */
233 unsigned int n_bits; /* Number of bits. */
236 /* Data for some part of an mf_field.
238 * The data is stored "right-justified". For example, if "union mf_subvalue
239 * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
240 * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
247 BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
249 /* Finding mf_fields. */
250 const struct mf_field *mf_from_id(enum mf_field_id);
251 const struct mf_field *mf_from_name(const char *name);
252 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
253 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
255 /* Inspecting wildcarded bits. */
256 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
258 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
259 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
260 union mf_value *mask);
263 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
264 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
267 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
269 void mf_get_value(const struct mf_field *, const struct flow *,
270 union mf_value *value);
271 void mf_set_value(const struct mf_field *, const union mf_value *value,
273 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
275 bool mf_is_zero(const struct mf_field *, const struct flow *);
277 void mf_get(const struct mf_field *, const struct cls_rule *,
278 union mf_value *value, union mf_value *mask);
279 void mf_set(const struct mf_field *,
280 const union mf_value *value, const union mf_value *mask,
283 void mf_set_wild(const struct mf_field *, struct cls_rule *);
285 void mf_random_value(const struct mf_field *, union mf_value *value);
288 void mf_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
290 void mf_set_subfield(const struct mf_subfield *, uint64_t value,
292 void mf_set_subfield_value(const struct mf_subfield *, uint64_t value,
295 void mf_read_subfield(const struct mf_subfield *, const struct flow *,
296 union mf_subvalue *);
297 uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
300 void mf_format_subfield(const struct mf_subfield *, struct ds *);
301 char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
302 const char *mf_parse_subfield(struct mf_subfield *, const char *);
304 enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
305 enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
307 /* Parsing and formatting. */
308 char *mf_parse(const struct mf_field *, const char *,
309 union mf_value *value, union mf_value *mask);
310 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
311 void mf_format(const struct mf_field *,
312 const union mf_value *value, const union mf_value *mask,
315 #endif /* meta-flow.h */