2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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.
22 #include "tun-metadata.h"
26 /* A flow classification match.
28 * Use one of the match_*() functions to initialize a "struct match".
30 * The match_*() functions below maintain the following important invariant.
31 * If a bit or a field is wildcarded in 'wc', then the corresponding bit or
32 * field in 'flow' is set to all-0-bits. (The match_zero_wildcarded_fields()
33 * function can be used to restore this invariant after adding wildcards.) */
36 struct flow_wildcards wc;
37 struct tun_metadata_allocation tun_md;
40 /* Initializer for a "struct match" that matches every packet. */
41 #define MATCH_CATCHALL_INITIALIZER { .flow = { .dl_type = 0 } }
43 void match_init(struct match *,
44 const struct flow *, const struct flow_wildcards *);
45 void match_wc_init(struct match *match, const struct flow *flow);
46 void match_init_catchall(struct match *);
48 void match_zero_wildcarded_fields(struct match *);
50 void match_set_dp_hash(struct match *, uint32_t value);
51 void match_set_dp_hash_masked(struct match *, uint32_t value, uint32_t mask);
53 void match_set_recirc_id(struct match *, uint32_t value);
55 void match_set_conj_id(struct match *, uint32_t value);
57 void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
58 void match_set_reg_masked(struct match *, unsigned int reg_idx,
59 uint32_t value, uint32_t mask);
60 void match_set_xreg(struct match *, unsigned int xreg_idx, uint64_t value);
61 void match_set_xreg_masked(struct match *, unsigned int xreg_idx,
62 uint64_t value, uint64_t mask);
63 void match_set_actset_output(struct match *, ofp_port_t actset_output);
64 void match_set_metadata(struct match *, ovs_be64 metadata);
65 void match_set_metadata_masked(struct match *,
66 ovs_be64 metadata, ovs_be64 mask);
67 void match_set_tun_id(struct match *, ovs_be64 tun_id);
68 void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
69 void match_set_tun_src(struct match *match, ovs_be32 src);
70 void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask);
71 void match_set_tun_dst(struct match *match, ovs_be32 dst);
72 void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask);
73 void match_set_tun_ipv6_src(struct match *, const struct in6_addr *);
74 void match_set_tun_ipv6_src_masked(struct match *, const struct in6_addr *,
75 const struct in6_addr *);
76 void match_set_tun_ipv6_dst(struct match *, const struct in6_addr *);
77 void match_set_tun_ipv6_dst_masked(struct match *, const struct in6_addr *,
78 const struct in6_addr *);
79 void match_set_tun_ttl(struct match *match, uint8_t ttl);
80 void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask);
81 void match_set_tun_tos(struct match *match, uint8_t tos);
82 void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask);
83 void match_set_tun_flags(struct match *match, uint16_t flags);
84 void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask);
85 void match_set_tun_gbp_id_masked(struct match *match, ovs_be16 gbp_id, ovs_be16 mask);
86 void match_set_tun_gbp_id(struct match *match, ovs_be16 gbp_id);
87 void match_set_tun_gbp_flags_masked(struct match *match, uint8_t flags, uint8_t mask);
88 void match_set_tun_gbp_flags(struct match *match, uint8_t flags);
89 void match_set_in_port(struct match *, ofp_port_t ofp_port);
90 void match_set_pkt_mark(struct match *, uint32_t pkt_mark);
91 void match_set_pkt_mark_masked(struct match *, uint32_t pkt_mark, uint32_t mask);
92 void match_set_ct_state(struct match *, uint32_t ct_state);
93 void match_set_ct_state_masked(struct match *, uint32_t ct_state, uint32_t mask);
94 void match_set_ct_zone(struct match *, uint16_t ct_zone);
95 void match_set_ct_mark(struct match *, uint32_t ct_mark);
96 void match_set_ct_mark_masked(struct match *, uint32_t ct_mark, uint32_t mask);
97 void match_set_ct_label(struct match *, ovs_u128 ct_label);
98 void match_set_ct_label_masked(struct match *, ovs_u128 ct_label, ovs_u128 mask);
99 void match_set_skb_priority(struct match *, uint32_t skb_priority);
100 void match_set_dl_type(struct match *, ovs_be16);
101 void match_set_dl_src(struct match *, const struct eth_addr );
102 void match_set_dl_src_masked(struct match *, const struct eth_addr dl_src,
103 const struct eth_addr mask);
104 void match_set_dl_dst(struct match *, const struct eth_addr);
105 void match_set_dl_dst_masked(struct match *, const struct eth_addr dl_dst,
106 const struct eth_addr mask);
107 void match_set_dl_tci(struct match *, ovs_be16 tci);
108 void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
109 void match_set_any_vid(struct match *);
110 void match_set_dl_vlan(struct match *, ovs_be16);
111 void match_set_vlan_vid(struct match *, ovs_be16);
112 void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
113 void match_set_any_pcp(struct match *);
114 void match_set_dl_vlan_pcp(struct match *, uint8_t);
115 void match_set_any_mpls_lse(struct match *, int idx);
116 void match_set_mpls_lse(struct match *, int idx, ovs_be32);
117 void match_set_any_mpls_label(struct match *, int idx);
118 void match_set_mpls_label(struct match *, int idx, ovs_be32);
119 void match_set_any_mpls_tc(struct match *, int idx);
120 void match_set_mpls_tc(struct match *, int idx, uint8_t);
121 void match_set_any_mpls_bos(struct match *, int idx);
122 void match_set_mpls_bos(struct match *, int idx, uint8_t);
123 void match_set_any_mpls_ttl(struct match *, int idx);
124 void match_set_mpls_ttl(struct match *, int idx, uint8_t);
125 void match_set_tp_src(struct match *, ovs_be16);
126 void match_set_mpls_lse(struct match *, int idx, ovs_be32 lse);
127 void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
128 void match_set_tp_dst(struct match *, ovs_be16);
129 void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
130 void match_set_tcp_flags(struct match *, ovs_be16);
131 void match_set_tcp_flags_masked(struct match *, ovs_be16 flags, ovs_be16 mask);
132 void match_set_nw_proto(struct match *, uint8_t);
133 void match_set_nw_src(struct match *, ovs_be32);
134 void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
135 void match_set_nw_dst(struct match *, ovs_be32);
136 void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
137 void match_set_nw_dscp(struct match *, uint8_t);
138 void match_set_nw_ecn(struct match *, uint8_t);
139 void match_set_nw_ttl(struct match *, uint8_t);
140 void match_set_nw_frag(struct match *, uint8_t nw_frag);
141 void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
142 void match_set_icmp_type(struct match *, uint8_t);
143 void match_set_icmp_code(struct match *, uint8_t);
144 void match_set_arp_sha(struct match *, const struct eth_addr);
145 void match_set_arp_sha_masked(struct match *,
146 const struct eth_addr arp_sha,
147 const struct eth_addr mask);
148 void match_set_arp_tha(struct match *, const struct eth_addr);
149 void match_set_arp_tha_masked(struct match *,
150 const struct eth_addr arp_tha,
151 const struct eth_addr mask);
152 void match_set_ipv6_src(struct match *, const struct in6_addr *);
153 void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
154 const struct in6_addr *);
155 void match_set_ipv6_dst(struct match *, const struct in6_addr *);
156 void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
157 const struct in6_addr *);
158 void match_set_ipv6_label(struct match *, ovs_be32);
159 void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
160 void match_set_nd_target(struct match *, const struct in6_addr *);
161 void match_set_nd_target_masked(struct match *, const struct in6_addr *,
162 const struct in6_addr *);
164 bool match_equal(const struct match *, const struct match *);
165 uint32_t match_hash(const struct match *, uint32_t basis);
167 void match_init_hidden_fields(struct match *);
168 bool match_has_default_hidden_fields(const struct match *);
170 void match_format(const struct match *, struct ds *, int priority);
171 char *match_to_string(const struct match *, int priority);
172 void match_print(const struct match *);
174 /* Compressed match. */
176 /* A sparse representation of a "struct match".
178 * 'flows' is used for allocating both 'flow' and 'mask' with one
179 * miniflow_alloc() call.
181 * There are two invariants:
183 * - The same invariant as "struct match", that is, a 1-bit in the 'flow'
184 * must correspond to a 1-bit in 'mask'.
186 * - 'flow' and 'mask' have the same 'map'. This implies that 'flow' and
187 * 'mask' have the same part of "struct flow" at the same offset into
188 * 'values', which makes minimatch_matches_flow() faster.
193 struct miniflow *flow;
194 struct minimask *mask;
196 struct miniflow *flows[2];
200 void minimatch_init(struct minimatch *, const struct match *);
201 void minimatch_clone(struct minimatch *, const struct minimatch *);
202 void minimatch_move(struct minimatch *dst, struct minimatch *src);
203 void minimatch_destroy(struct minimatch *);
205 void minimatch_expand(const struct minimatch *, struct match *);
207 bool minimatch_equal(const struct minimatch *a, const struct minimatch *b);
209 bool minimatch_matches_flow(const struct minimatch *, const struct flow *);
211 void minimatch_format(const struct minimatch *, struct ds *, int priority);
212 char *minimatch_to_string(const struct minimatch *, int priority);