9f3b2eecc0076e7762d9acece5e63ff916e47c9c
[openvswitch] / lib / meta-flow.h
1 /*
2  * Copyright (c) 2011 Nicira Networks.
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 "packets.h"
25
26 struct cls_rule;
27 struct ds;
28
29 /* The comment on each of these indicates the member in "union mf_value" used
30  * to represent its value. */
31 enum mf_field_id {
32     /* Metadata. */
33     MFF_TUN_ID,                 /* be64 */
34     MFF_IN_PORT,                /* be16 */
35
36 #if FLOW_N_REGS > 0
37     MFF_REG0,                   /* be32 */
38 #endif
39 #if FLOW_N_REGS > 1
40     MFF_REG1,                   /* be32 */
41 #endif
42 #if FLOW_N_REGS > 2
43     MFF_REG2,                   /* be32 */
44 #endif
45 #if FLOW_N_REGS > 3
46     MFF_REG3,                   /* be32 */
47 #endif
48 #if FLOW_N_REGS > 4
49     MFF_REG4,                   /* be32 */
50 #endif
51 #if FLOW_N_REGS > 5
52 #error
53 #endif
54
55     /* L2. */
56     MFF_ETH_SRC,                /* mac */
57     MFF_ETH_DST,                /* mac */
58     MFF_ETH_TYPE,               /* be16 */
59
60     MFF_VLAN_TCI,               /* be16 */
61     MFF_VLAN_VID,               /* be16 */
62     MFF_VLAN_PCP,               /* u8 */
63
64     /* L3. */
65     MFF_IPV4_SRC,               /* be32 */
66     MFF_IPV4_DST,               /* be32 */
67
68     MFF_IPV6_SRC,               /* ipv6 */
69     MFF_IPV6_DST,               /* ipv6 */
70
71     MFF_IP_PROTO,               /* u8 (used for IPv4 or IPv6) */
72     MFF_IP_TOS,                 /* u8 (used for IPv4 or IPv6) */
73     MFF_IP_FRAG,                /* u8 (used for IPv4 or IPv6) */
74
75     MFF_ARP_OP,                 /* be16 */
76     MFF_ARP_SPA,                /* be32 */
77     MFF_ARP_TPA,                /* be32 */
78     MFF_ARP_SHA,                /* mac */
79     MFF_ARP_THA,                /* mac */
80
81     /* L4. */
82     MFF_TCP_SRC,                /* be16 (used for IPv4 or IPv6) */
83     MFF_TCP_DST,                /* be16 (used for IPv4 or IPv6) */
84
85     MFF_UDP_SRC,                /* be16 (used for IPv4 or IPv6) */
86     MFF_UDP_DST,                /* be16 (used for IPv4 or IPv6) */
87
88     MFF_ICMP_TYPE,              /* u8 (used for IPv4 or IPv6) */
89     MFF_ICMP_CODE,              /* u8 (used for IPv4 or IPv6) */
90
91     /* ICMPv6 Neighbor Discovery. */
92     MFF_ND_TARGET,              /* ipv6 */
93     MFF_ND_SLL,                 /* mac */
94     MFF_ND_TLL,                 /* mac */
95
96     MFF_N_IDS
97 };
98
99 /* Prerequisites for matching a field.
100  *
101  * A field may only be matched if the correct lower-level protocols are also
102  * matched.  For example, the TCP port may be matched only if the Ethernet type
103  * matches ETH_TYPE_IP and the IP protocol matches IPPROTO_TCP. */
104 enum mf_prereqs {
105     MFP_NONE,
106
107     /* L2 requirements. */
108     MFP_ARP,
109     MFP_IPV4,
110     MFP_IPV6,
111     MFP_IP_ANY,
112
113     /* L2+L3 requirements. */
114     MFP_TCP,                    /* On IPv4 or IPv6. */
115     MFP_UDP,                    /* On IPv4 or IPv6. */
116     MFP_ICMPV6,
117     MFP_ICMP_ANY,
118
119     /* L2+L3+L4 requirements. */
120     MFP_ND,
121     MFP_ND_SOLICIT,
122     MFP_ND_ADVERT
123 };
124
125 /* Forms of partial-field masking allowed for a field.
126  *
127  * Every field may be masked as a whole. */
128 enum mf_maskable {
129     MFM_NONE,                   /* No sub-field masking. */
130     MFM_FULLY,                  /* Every bit is individually maskable. */
131     MFM_CIDR,                   /* Contiguous low-order bits may be masked. */
132     MFM_MCAST                   /* Byte 0, bit 0 is separately maskable. */
133 };
134
135 /* How to format or parse a field's value. */
136 enum mf_string {
137     /* Integer formats.
138      *
139      * The particular MFS_* constant sets the output format.  On input, either
140      * decimal or hexadecimal (prefixed with 0x) is accepted. */
141     MFS_DECIMAL,
142     MFS_HEXADECIMAL,
143
144     /* Other formats. */
145     MFS_ETHERNET,
146     MFS_IPV4,
147     MFS_IPV6,
148     MFS_OFP_PORT,               /* An OpenFlow port number or name. */
149     MFS_FRAG                    /* no, yes, first, later, not_later */
150 };
151
152 struct mf_field {
153     /* Identification. */
154     enum mf_field_id id;        /* MFF_*. */
155     const char *name;           /* Name of this field, e.g. "eth_type". */
156     const char *extra_name;     /* Alternate name, e.g. "dl_type", or NULL. */
157
158     /* Size.
159      *
160      * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
161      *
162      *     - "dl_vlan" is 2 bytes but only 12 bits.
163      *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
164      *     - "is_frag" is 1 byte but only 2 bits.
165      */
166     unsigned int n_bytes;       /* Width of the field in bytes. */
167     unsigned int n_bits;        /* Number of significant bits in field. */
168
169     /* Properties. */
170     enum mf_maskable maskable;
171     flow_wildcards_t fww_bit;   /* Either 0 or exactly one FWW_* bit. */
172     enum mf_string string;
173     enum mf_prereqs prereqs;
174     uint32_t nxm_header;        /* An NXM_* constant (a few fields have 0). */
175 };
176
177 /* The representation of a field's value. */
178 union mf_value {
179     uint8_t u8;
180     ovs_be16 be16;
181     ovs_be32 be32;
182     ovs_be64 be64;
183     uint8_t mac[ETH_ADDR_LEN];
184     struct in6_addr ipv6;
185 };
186
187 /* Finding mf_fields. */
188 const struct mf_field *mf_from_id(enum mf_field_id);
189 const struct mf_field *mf_from_name(const char *name);
190
191 /* Inspecting wildcarded bits. */
192 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
193
194 bool mf_is_mask_valid(const struct mf_field *, const union mf_value *mask);
195 void mf_get_mask(const struct mf_field *, const struct flow_wildcards *,
196                  union mf_value *mask);
197
198 /* Prerequisites. */
199 bool mf_are_prereqs_ok(const struct mf_field *, const struct flow *);
200 void mf_force_prereqs(const struct mf_field *, struct cls_rule *);
201
202 /* Field values. */
203 bool mf_is_value_valid(const struct mf_field *, const union mf_value *value);
204
205 void mf_get_value(const struct mf_field *, const struct flow *,
206                   union mf_value *value);
207 void mf_set_value(const struct mf_field *, const union mf_value *value,
208                   struct cls_rule *);
209
210 void mf_get(const struct mf_field *, const struct cls_rule *,
211             union mf_value *value, union mf_value *mask);
212 void mf_set(const struct mf_field *,
213             const union mf_value *value, const union mf_value *mask,
214             struct cls_rule *);
215 void mf_set_subfield(const struct mf_field *, uint64_t value, unsigned int ofs,
216                      unsigned int n_bits, struct cls_rule *);
217
218 void mf_set_wild(const struct mf_field *, struct cls_rule *);
219
220 void mf_random_value(const struct mf_field *, union mf_value *value);
221
222 /* Parsing and formatting. */
223 char *mf_parse(const struct mf_field *, const char *,
224                union mf_value *value, union mf_value *mask);
225 char *mf_parse_value(const struct mf_field *, const char *, union mf_value *);
226 void mf_format(const struct mf_field *,
227                const union mf_value *value, const union mf_value *mask,
228                struct ds *);
229
230 #endif /* meta-flow.h */