]>
Commit | Line | Data |
---|---|---|
81a76618 | 1 | /* |
50f96b10 | 2 | * Copyright (c) 2009-2017 Nicira, Inc. |
81a76618 BP |
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 | ||
e29747e4 BW |
17 | #ifndef OPENVSWITCH_MATCH_H |
18 | #define OPENVSWITCH_MATCH_H 1 | |
81a76618 | 19 | |
e29747e4 BW |
20 | #include "openvswitch/flow.h" |
21 | #include "openvswitch/packets.h" | |
22 | #include "openvswitch/tun-metadata.h" | |
81a76618 | 23 | |
ec30ca5f BP |
24 | #ifdef __cplusplus |
25 | extern "C" { | |
26 | #endif | |
27 | ||
5cb7a798 | 28 | struct ds; |
50f96b10 | 29 | struct ofputil_port_map; |
3d4b2e6e | 30 | struct mf_field; |
5cb7a798 | 31 | |
81a76618 BP |
32 | /* A flow classification match. |
33 | * | |
34 | * Use one of the match_*() functions to initialize a "struct match". | |
35 | * | |
36 | * The match_*() functions below maintain the following important invariant. | |
37 | * If a bit or a field is wildcarded in 'wc', then the corresponding bit or | |
38 | * field in 'flow' is set to all-0-bits. (The match_zero_wildcarded_fields() | |
39 | * function can be used to restore this invariant after adding wildcards.) */ | |
40 | struct match { | |
41 | struct flow flow; | |
42 | struct flow_wildcards wc; | |
9558d2a5 | 43 | struct tun_metadata_allocation tun_md; |
81a76618 BP |
44 | }; |
45 | ||
01f8894c | 46 | /* Initializer for a "struct match" that matches every packet. */ |
ccccabda | 47 | #define MATCH_CATCHALL_INITIALIZER { .flow = { .dl_type = 0 } } |
01f8894c | 48 | |
3d2fbd70 JS |
49 | #define MATCH_SET_FIELD_MASKED(match, field, value, msk) \ |
50 | do { \ | |
51 | (match)->wc.masks.field = (msk); \ | |
52 | (match)->flow.field = (value) & (msk); \ | |
53 | } while (0) | |
54 | ||
55 | #define MATCH_SET_FIELD_UINT8(match, field, value) \ | |
56 | MATCH_SET_FIELD_MASKED(match, field, value, UINT8_MAX) | |
57 | ||
58 | #define MATCH_SET_FIELD_BE32(match, field, value) \ | |
59 | MATCH_SET_FIELD_MASKED(match, field, value, OVS_BE32_MAX) | |
60 | ||
81a76618 BP |
61 | void match_init(struct match *, |
62 | const struct flow *, const struct flow_wildcards *); | |
aa6c9932 | 63 | void match_wc_init(struct match *match, const struct flow *flow); |
81a76618 | 64 | void match_init_catchall(struct match *); |
81a76618 BP |
65 | |
66 | void match_zero_wildcarded_fields(struct match *); | |
67 | ||
a79f29f2 AZ |
68 | void match_set_dp_hash(struct match *, uint32_t value); |
69 | void match_set_dp_hash_masked(struct match *, uint32_t value, uint32_t mask); | |
70 | ||
71 | void match_set_recirc_id(struct match *, uint32_t value); | |
18080541 BP |
72 | |
73 | void match_set_conj_id(struct match *, uint32_t value); | |
a79f29f2 | 74 | |
81a76618 BP |
75 | void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value); |
76 | void match_set_reg_masked(struct match *, unsigned int reg_idx, | |
77 | uint32_t value, uint32_t mask); | |
79fe0f46 BP |
78 | void match_set_xreg(struct match *, unsigned int xreg_idx, uint64_t value); |
79 | void match_set_xreg_masked(struct match *, unsigned int xreg_idx, | |
80 | uint64_t value, uint64_t mask); | |
b23ada8e JP |
81 | void match_set_xxreg(struct match *, unsigned int xxreg_idx, ovs_u128 value); |
82 | void match_set_xxreg_masked(struct match *, unsigned int xxreg_idx, | |
83 | ovs_u128 value, ovs_u128 mask); | |
c61f3870 | 84 | void match_set_actset_output(struct match *, ofp_port_t actset_output); |
81a76618 BP |
85 | void match_set_metadata(struct match *, ovs_be64 metadata); |
86 | void match_set_metadata_masked(struct match *, | |
87 | ovs_be64 metadata, ovs_be64 mask); | |
88 | void match_set_tun_id(struct match *, ovs_be64 tun_id); | |
89 | void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask); | |
4fe3445a PS |
90 | void match_set_tun_src(struct match *match, ovs_be32 src); |
91 | void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask); | |
92 | void match_set_tun_dst(struct match *match, ovs_be32 dst); | |
93 | void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask); | |
ffe4c74f JB |
94 | void match_set_tun_ipv6_src(struct match *, const struct in6_addr *); |
95 | void match_set_tun_ipv6_src_masked(struct match *, const struct in6_addr *, | |
96 | const struct in6_addr *); | |
97 | void match_set_tun_ipv6_dst(struct match *, const struct in6_addr *); | |
98 | void match_set_tun_ipv6_dst_masked(struct match *, const struct in6_addr *, | |
99 | const struct in6_addr *); | |
4fe3445a PS |
100 | void match_set_tun_ttl(struct match *match, uint8_t ttl); |
101 | void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask); | |
102 | void match_set_tun_tos(struct match *match, uint8_t tos); | |
103 | void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask); | |
104 | void match_set_tun_flags(struct match *match, uint16_t flags); | |
105 | void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask); | |
3def36a8 RD |
106 | void match_set_tun_tp_dst(struct match *match, ovs_be16 tp_dst); |
107 | void match_set_tun_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask); | |
ac6073e3 MC |
108 | void match_set_tun_gbp_id_masked(struct match *match, ovs_be16 gbp_id, ovs_be16 mask); |
109 | void match_set_tun_gbp_id(struct match *match, ovs_be16 gbp_id); | |
110 | void match_set_tun_gbp_flags_masked(struct match *match, uint8_t flags, uint8_t mask); | |
111 | void match_set_tun_gbp_flags(struct match *match, uint8_t flags); | |
7dc18ae9 WT |
112 | void match_set_tun_erspan_ver(struct match *match, uint8_t ver); |
113 | void match_set_tun_erspan_ver_masked(struct match *match, uint8_t ver, | |
114 | uint8_t mask); | |
115 | void match_set_tun_erspan_idx(struct match *match, uint32_t idx); | |
116 | void match_set_tun_erspan_idx_masked(struct match *match, uint32_t idx, | |
117 | uint32_t mask); | |
118 | void match_set_tun_erspan_dir(struct match *match, uint8_t dir); | |
119 | void match_set_tun_erspan_dir_masked(struct match *match, uint8_t dir, | |
120 | uint8_t mask); | |
121 | void match_set_tun_erspan_hwid(struct match *match, uint8_t hwid); | |
122 | void match_set_tun_erspan_hwid_masked(struct match *match, uint8_t hwid, | |
123 | uint8_t mask); | |
4e022ec0 | 124 | void match_set_in_port(struct match *, ofp_port_t ofp_port); |
1362e248 | 125 | void match_set_pkt_mark(struct match *, uint32_t pkt_mark); |
ac923e91 | 126 | void match_set_pkt_mark_masked(struct match *, uint32_t pkt_mark, uint32_t mask); |
07659514 JS |
127 | void match_set_ct_state(struct match *, uint32_t ct_state); |
128 | void match_set_ct_state_masked(struct match *, uint32_t ct_state, uint32_t mask); | |
129 | void match_set_ct_zone(struct match *, uint16_t ct_zone); | |
8e53fe8c JS |
130 | void match_set_ct_mark(struct match *, uint32_t ct_mark); |
131 | void match_set_ct_mark_masked(struct match *, uint32_t ct_mark, uint32_t mask); | |
9daf2348 JS |
132 | void match_set_ct_label(struct match *, ovs_u128 ct_label); |
133 | void match_set_ct_label_masked(struct match *, ovs_u128 ct_label, ovs_u128 mask); | |
daf4d3c1 JR |
134 | void match_set_ct_nw_src(struct match *, ovs_be32); |
135 | void match_set_ct_nw_src_masked(struct match *, ovs_be32, ovs_be32 mask); | |
136 | void match_set_ct_nw_dst(struct match *, ovs_be32); | |
137 | void match_set_ct_nw_dst_masked(struct match *, ovs_be32, ovs_be32 mask); | |
138 | void match_set_ct_nw_proto(struct match *, uint8_t); | |
139 | void match_set_ct_tp_src(struct match *, ovs_be16); | |
140 | void match_set_ct_tp_src_masked(struct match *, ovs_be16, ovs_be16 mask); | |
141 | void match_set_ct_tp_dst(struct match *, ovs_be16); | |
142 | void match_set_ct_tp_dst_masked(struct match *, ovs_be16, ovs_be16 mask); | |
143 | void match_set_ct_ipv6_src(struct match *, const struct in6_addr *); | |
144 | void match_set_ct_ipv6_src_masked(struct match *, const struct in6_addr *, | |
145 | const struct in6_addr *); | |
146 | void match_set_ct_ipv6_dst(struct match *, const struct in6_addr *); | |
147 | void match_set_ct_ipv6_dst_masked(struct match *, const struct in6_addr *, | |
148 | const struct in6_addr *); | |
149 | ||
beb75a40 | 150 | void match_set_packet_type(struct match *, ovs_be32 packet_type); |
3d4b2e6e JS |
151 | void match_set_default_packet_type(struct match *); |
152 | bool match_has_default_packet_type(const struct match *); | |
153 | void match_add_ethernet_prereq(struct match *, const struct mf_field *); | |
154 | ||
1b567fb9 | 155 | void match_set_skb_priority(struct match *, uint32_t skb_priority); |
81a76618 | 156 | void match_set_dl_type(struct match *, ovs_be16); |
74ff3298 JR |
157 | void match_set_dl_src(struct match *, const struct eth_addr ); |
158 | void match_set_dl_src_masked(struct match *, const struct eth_addr dl_src, | |
159 | const struct eth_addr mask); | |
160 | void match_set_dl_dst(struct match *, const struct eth_addr); | |
161 | void match_set_dl_dst_masked(struct match *, const struct eth_addr dl_dst, | |
162 | const struct eth_addr mask); | |
81a76618 BP |
163 | void match_set_dl_tci(struct match *, ovs_be16 tci); |
164 | void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask); | |
165 | void match_set_any_vid(struct match *); | |
2f9366be | 166 | void match_set_dl_vlan(struct match *, ovs_be16, int id); |
81a76618 BP |
167 | void match_set_vlan_vid(struct match *, ovs_be16); |
168 | void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask); | |
169 | void match_set_any_pcp(struct match *); | |
2f9366be | 170 | void match_set_dl_vlan_pcp(struct match *, uint8_t, int id); |
8bfd0fda BP |
171 | void match_set_any_mpls_lse(struct match *, int idx); |
172 | void match_set_mpls_lse(struct match *, int idx, ovs_be32); | |
173 | void match_set_any_mpls_label(struct match *, int idx); | |
174 | void match_set_mpls_label(struct match *, int idx, ovs_be32); | |
175 | void match_set_any_mpls_tc(struct match *, int idx); | |
176 | void match_set_mpls_tc(struct match *, int idx, uint8_t); | |
177 | void match_set_any_mpls_bos(struct match *, int idx); | |
178 | void match_set_mpls_bos(struct match *, int idx, uint8_t); | |
bef3f465 BP |
179 | void match_set_any_mpls_ttl(struct match *, int idx); |
180 | void match_set_mpls_ttl(struct match *, int idx, uint8_t); | |
81a76618 | 181 | void match_set_tp_src(struct match *, ovs_be16); |
8bfd0fda | 182 | void match_set_mpls_lse(struct match *, int idx, ovs_be32 lse); |
81a76618 BP |
183 | void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask); |
184 | void match_set_tp_dst(struct match *, ovs_be16); | |
185 | void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask); | |
dc235f7f JR |
186 | void match_set_tcp_flags(struct match *, ovs_be16); |
187 | void match_set_tcp_flags_masked(struct match *, ovs_be16 flags, ovs_be16 mask); | |
81a76618 BP |
188 | void match_set_nw_proto(struct match *, uint8_t); |
189 | void match_set_nw_src(struct match *, ovs_be32); | |
190 | void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask); | |
191 | void match_set_nw_dst(struct match *, ovs_be32); | |
192 | void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask); | |
193 | void match_set_nw_dscp(struct match *, uint8_t); | |
194 | void match_set_nw_ecn(struct match *, uint8_t); | |
c489ad67 PB |
195 | void match_set_nw_ttl(struct match *, uint8_t nw_ttl); |
196 | void match_set_nw_ttl_masked(struct match *, uint8_t nw_ttl, uint8_t mask); | |
dfa2ccdb | 197 | void match_set_nw_tos_masked(struct match *, uint8_t nw_tos, uint8_t mask); |
81a76618 BP |
198 | void match_set_nw_frag(struct match *, uint8_t nw_frag); |
199 | void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask); | |
200 | void match_set_icmp_type(struct match *, uint8_t); | |
201 | void match_set_icmp_code(struct match *, uint8_t); | |
74ff3298 | 202 | void match_set_arp_sha(struct match *, const struct eth_addr); |
81a76618 | 203 | void match_set_arp_sha_masked(struct match *, |
74ff3298 JR |
204 | const struct eth_addr arp_sha, |
205 | const struct eth_addr mask); | |
206 | void match_set_arp_tha(struct match *, const struct eth_addr); | |
81a76618 | 207 | void match_set_arp_tha_masked(struct match *, |
74ff3298 JR |
208 | const struct eth_addr arp_tha, |
209 | const struct eth_addr mask); | |
81a76618 BP |
210 | void match_set_ipv6_src(struct match *, const struct in6_addr *); |
211 | void match_set_ipv6_src_masked(struct match *, const struct in6_addr *, | |
212 | const struct in6_addr *); | |
213 | void match_set_ipv6_dst(struct match *, const struct in6_addr *); | |
214 | void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *, | |
215 | const struct in6_addr *); | |
216 | void match_set_ipv6_label(struct match *, ovs_be32); | |
217 | void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32); | |
218 | void match_set_nd_target(struct match *, const struct in6_addr *); | |
219 | void match_set_nd_target_masked(struct match *, const struct in6_addr *, | |
220 | const struct in6_addr *); | |
221 | ||
222 | bool match_equal(const struct match *, const struct match *); | |
223 | uint32_t match_hash(const struct match *, uint32_t basis); | |
224 | ||
adcf00ba AZ |
225 | void match_init_hidden_fields(struct match *); |
226 | bool match_has_default_hidden_fields(const struct match *); | |
227 | ||
50f96b10 BP |
228 | void match_format(const struct match *, const struct ofputil_port_map *, |
229 | struct ds *, int priority); | |
230 | char *match_to_string(const struct match *, const struct ofputil_port_map *, | |
231 | int priority); | |
232 | void match_print(const struct match *, const struct ofputil_port_map *); | |
5cb7a798 BP |
233 | \f |
234 | /* Compressed match. */ | |
235 | ||
236 | /* A sparse representation of a "struct match". | |
ceb3bd67 JR |
237 | * |
238 | * 'flows' is used for allocating both 'flow' and 'mask' with one | |
239 | * miniflow_alloc() call. | |
5cb7a798 | 240 | * |
df40c152 | 241 | * There are two invariants: |
5cb7a798 | 242 | * |
df40c152 BP |
243 | * - The same invariant as "struct match", that is, a 1-bit in the 'flow' |
244 | * must correspond to a 1-bit in 'mask'. | |
245 | * | |
246 | * - 'flow' and 'mask' have the same 'map'. This implies that 'flow' and | |
247 | * 'mask' have the same part of "struct flow" at the same offset into | |
248 | * 'values', which makes minimatch_matches_flow() faster. | |
249 | */ | |
5cb7a798 | 250 | struct minimatch { |
ceb3bd67 JR |
251 | union { |
252 | struct { | |
253 | struct miniflow *flow; | |
254 | struct minimask *mask; | |
255 | }; | |
256 | struct miniflow *flows[2]; | |
257 | }; | |
1f7270d7 | 258 | struct tun_metadata_allocation *tun_md; |
5cb7a798 BP |
259 | }; |
260 | ||
261 | void minimatch_init(struct minimatch *, const struct match *); | |
1dc1ec24 | 262 | void minimatch_init_catchall(struct minimatch *); |
5cb7a798 | 263 | void minimatch_clone(struct minimatch *, const struct minimatch *); |
b2c1f00b | 264 | void minimatch_move(struct minimatch *dst, struct minimatch *src); |
5cb7a798 BP |
265 | void minimatch_destroy(struct minimatch *); |
266 | ||
267 | void minimatch_expand(const struct minimatch *, struct match *); | |
268 | ||
269 | bool minimatch_equal(const struct minimatch *a, const struct minimatch *b); | |
1dc1ec24 | 270 | uint32_t minimatch_hash(const struct minimatch *, uint32_t basis); |
5cb7a798 | 271 | |
df40c152 BP |
272 | bool minimatch_matches_flow(const struct minimatch *, const struct flow *); |
273 | ||
8d8ab6c2 | 274 | void minimatch_format(const struct minimatch *, const struct tun_table *, |
50f96b10 | 275 | const struct ofputil_port_map *, |
8d8ab6c2 | 276 | struct ds *, int priority); |
50f96b10 BP |
277 | char *minimatch_to_string(const struct minimatch *, |
278 | const struct ofputil_port_map *, int priority); | |
81a76618 | 279 | |
1dc1ec24 BP |
280 | bool minimatch_has_default_hidden_fields(const struct minimatch *); |
281 | ||
ec30ca5f BP |
282 | #ifdef __cplusplus |
283 | } | |
284 | #endif | |
285 | ||
81a76618 | 286 | #endif /* match.h */ |