2 * Copyright (c) 2011 Nicira Networks.
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>
29 /* The comment on each of these indicates the member in "union mf_value" used
30 * to represent its value. */
33 MFF_TUN_ID, /* be64 */
34 MFF_IN_PORT, /* be16 */
56 MFF_ETH_SRC, /* mac */
57 MFF_ETH_DST, /* mac */
58 MFF_ETH_TYPE, /* be16 */
60 MFF_VLAN_TCI, /* be16 */
61 MFF_VLAN_VID, /* be16 */
62 MFF_VLAN_PCP, /* u8 */
65 MFF_IPV4_SRC, /* be32 */
66 MFF_IPV4_DST, /* be32 */
68 MFF_IPV6_SRC, /* ipv6 */
69 MFF_IPV6_DST, /* ipv6 */
70 MFF_IPV6_LABEL, /* be32 */
72 MFF_IP_PROTO, /* u8 (used for IPv4 or IPv6) */
73 MFF_IP_DSCP, /* u8 (used for IPv4 or IPv6) */
74 MFF_IP_ECN, /* u8 (used for IPv4 or IPv6) */
75 MFF_IP_TTL, /* u8 (used for IPv4 or IPv6) */
76 MFF_IP_FRAG, /* u8 (used for IPv4 or IPv6) */
78 MFF_ARP_OP, /* be16 */
79 MFF_ARP_SPA, /* be32 */
80 MFF_ARP_TPA, /* be32 */
81 MFF_ARP_SHA, /* mac */
82 MFF_ARP_THA, /* mac */
85 MFF_TCP_SRC, /* be16 (used for IPv4 or IPv6) */
86 MFF_TCP_DST, /* be16 (used for IPv4 or IPv6) */
88 MFF_UDP_SRC, /* be16 (used for IPv4 or IPv6) */
89 MFF_UDP_DST, /* be16 (used for IPv4 or IPv6) */
91 MFF_ICMPV4_TYPE, /* u8 */
92 MFF_ICMPV4_CODE, /* u8 */
94 MFF_ICMPV6_TYPE, /* u8 */
95 MFF_ICMPV6_CODE, /* u8 */
97 /* ICMPv6 Neighbor Discovery. */
98 MFF_ND_TARGET, /* ipv6 */
100 MFF_ND_TLL, /* mac */
105 /* Prerequisites for matching a field.
107 * A field may only be matched if the correct lower-level protocols are also
108 * matched. For example, the TCP port may be matched only if the Ethernet type
109 * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
113 /* L2 requirements. */
119 /* L2+L3 requirements. */
120 MFP_TCP, /* On IPv4 or IPv6. */
121 MFP_UDP, /* On IPv4 or IPv6. */
125 /* L2+L3+L4 requirements. */
131 /* Forms of partial-field masking allowed for a field.
133 * Every field may be masked as a whole. */
135 MFM_NONE, /* No sub-field masking. */
136 MFM_FULLY, /* Every bit is individually maskable. */
137 MFM_CIDR, /* Contiguous low-order bits may be masked. */
138 MFM_MCAST /* Byte 0, bit 0 is separately maskable. */
141 /* How to format or parse a field's value. */
145 * The particular MFS_* constant sets the output format. On input, either
146 * decimal or hexadecimal (prefixed with 0x) is accepted. */
154 MFS_OFP_PORT, /* An OpenFlow port number or name. */
155 MFS_FRAG /* no, yes, first, later, not_later */
159 /* Identification. */
160 enum mf_field_id id; /* MFF_*. */
161 const char *name; /* Name of this field, e.g. "eth_type". */
162 const char *extra_name; /* Alternate name, e.g. "dl_type", or NULL. */
166 * Most fields have n_bytes * 8 == n_bits. There are a few exceptions:
168 * - "dl_vlan" is 2 bytes but only 12 bits.
169 * - "dl_vlan_pcp" is 1 byte but only 3 bits.
170 * - "is_frag" is 1 byte but only 2 bits.
171 * - "ipv6_label" is 4 bytes but only 20 bits.
173 unsigned int n_bytes; /* Width of the field in bytes. */
174 unsigned int n_bits; /* Number of significant bits in field. */
177 enum mf_maskable maskable;
178 flow_wildcards_t fww_bit; /* Either 0 or exactly one FWW_* bit. */
179 enum mf_string string;
180 enum mf_prereqs prereqs;
181 bool writable; /* May be written by actions? */
185 * A few "mf_field"s don't correspond to NXM fields. Those have 0 and
186 * NULL for the following members, respectively. */
187 uint32_t nxm_header; /* An NXM_* constant (a few fields have 0). */
188 const char *nxm_name; /* The "NXM_*" constant's name. */
191 /* The representation of a field's value. */
197 uint8_t mac[ETH_ADDR_LEN];
198 struct in6_addr ipv6;
201 /* Finding mf_fields. */
202 const struct mf_field *mf_from_id(enum mf_field_id);
203 const struct mf_field *mf_from_name(const char *name);
204 const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
205 const struct mf_field *mf_from_nxm_name(const char *nxm_name);
207 /* Inspecting wildcarded bits. */
208 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
210 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
211 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
212 union mf_value *mask);
215 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
216 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
219 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
221 void mf_get_value(const struct mf_field *, const struct flow *,
222 union mf_value *value);
223 void mf_set_value(const struct mf_field *, const union mf_value *value,
225 void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
228 void mf_get(const struct mf_field *, const struct cls_rule *,
229 union mf_value *value, union mf_value *mask);
230 void mf_set(const struct mf_field *,
231 const union mf_value *value, const union mf_value *mask,
233 void mf_set_subfield(const struct mf_field *, uint64_t value, unsigned int ofs,
234 unsigned int n_bits, struct cls_rule *);
236 void mf_set_wild(const struct mf_field *, struct cls_rule *);
238 void mf_random_value(const struct mf_field *, union mf_value *value);
240 /* Parsing and formatting. */
241 char *mf_parse(const struct mf_field *, const char *,
242 union mf_value *value, union mf_value *mask);
243 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
244 void mf_format(const struct mf_field *,
245 const union mf_value *value, const union mf_value *mask,
248 #endif /* meta-flow.h */