2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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.
24 /* A flow classification match.
26 * Use one of the match_*() functions to initialize a "struct match".
28 * The match_*() functions below maintain the following important invariant.
29 * If a bit or a field is wildcarded in 'wc', then the corresponding bit or
30 * field in 'flow' is set to all-0-bits. (The match_zero_wildcarded_fields()
31 * function can be used to restore this invariant after adding wildcards.) */
34 struct flow_wildcards wc;
37 void match_init(struct match *,
38 const struct flow *, const struct flow_wildcards *);
39 void match_wc_init(struct match *match, const struct flow *flow);
40 void match_init_catchall(struct match *);
42 void match_zero_wildcarded_fields(struct match *);
44 void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
45 void match_set_reg_masked(struct match *, unsigned int reg_idx,
46 uint32_t value, uint32_t mask);
47 void match_set_metadata(struct match *, ovs_be64 metadata);
48 void match_set_metadata_masked(struct match *,
49 ovs_be64 metadata, ovs_be64 mask);
50 void match_set_tun_id(struct match *, ovs_be64 tun_id);
51 void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
52 void match_set_tun_src(struct match *match, ovs_be32 src);
53 void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask);
54 void match_set_tun_dst(struct match *match, ovs_be32 dst);
55 void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask);
56 void match_set_tun_ttl(struct match *match, uint8_t ttl);
57 void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask);
58 void match_set_tun_tos(struct match *match, uint8_t tos);
59 void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask);
60 void match_set_tun_flags(struct match *match, uint16_t flags);
61 void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask);
62 void match_set_in_port(struct match *, ofp_port_t ofp_port);
63 void match_set_pkt_mark(struct match *, uint32_t pkt_mark);
64 void match_set_pkt_mark_masked(struct match *, uint32_t pkt_mark, uint32_t mask);
65 void match_set_skb_priority(struct match *, uint32_t skb_priority);
66 void match_set_dl_type(struct match *, ovs_be16);
67 void match_set_dl_src(struct match *, const uint8_t[6]);
68 void match_set_dl_src_masked(struct match *, const uint8_t dl_src[6],
69 const uint8_t mask[6]);
70 void match_set_dl_dst(struct match *, const uint8_t[6]);
71 void match_set_dl_dst_masked(struct match *, const uint8_t dl_dst[6],
72 const uint8_t mask[6]);
73 void match_set_dl_tci(struct match *, ovs_be16 tci);
74 void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
75 void match_set_any_vid(struct match *);
76 void match_set_dl_vlan(struct match *, ovs_be16);
77 void match_set_vlan_vid(struct match *, ovs_be16);
78 void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
79 void match_set_any_pcp(struct match *);
80 void match_set_dl_vlan_pcp(struct match *, uint8_t);
81 void match_set_any_mpls_lse(struct match *, int idx);
82 void match_set_mpls_lse(struct match *, int idx, ovs_be32);
83 void match_set_any_mpls_label(struct match *, int idx);
84 void match_set_mpls_label(struct match *, int idx, ovs_be32);
85 void match_set_any_mpls_tc(struct match *, int idx);
86 void match_set_mpls_tc(struct match *, int idx, uint8_t);
87 void match_set_any_mpls_bos(struct match *, int idx);
88 void match_set_mpls_bos(struct match *, int idx, uint8_t);
89 void match_set_tp_src(struct match *, ovs_be16);
90 void match_set_mpls_lse(struct match *, int idx, ovs_be32 lse);
91 void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
92 void match_set_tp_dst(struct match *, ovs_be16);
93 void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
94 void match_set_tcp_flags(struct match *, ovs_be16);
95 void match_set_tcp_flags_masked(struct match *, ovs_be16 flags, ovs_be16 mask);
96 void match_set_nw_proto(struct match *, uint8_t);
97 void match_set_nw_src(struct match *, ovs_be32);
98 void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
99 void match_set_nw_dst(struct match *, ovs_be32);
100 void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
101 void match_set_nw_dscp(struct match *, uint8_t);
102 void match_set_nw_ecn(struct match *, uint8_t);
103 void match_set_nw_ttl(struct match *, uint8_t);
104 void match_set_nw_frag(struct match *, uint8_t nw_frag);
105 void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
106 void match_set_icmp_type(struct match *, uint8_t);
107 void match_set_icmp_code(struct match *, uint8_t);
108 void match_set_arp_sha(struct match *, const uint8_t[6]);
109 void match_set_arp_sha_masked(struct match *,
110 const uint8_t arp_sha[6],
111 const uint8_t mask[6]);
112 void match_set_arp_tha(struct match *, const uint8_t[6]);
113 void match_set_arp_tha_masked(struct match *,
114 const uint8_t arp_tha[6],
115 const uint8_t mask[6]);
116 void match_set_ipv6_src(struct match *, const struct in6_addr *);
117 void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
118 const struct in6_addr *);
119 void match_set_ipv6_dst(struct match *, const struct in6_addr *);
120 void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
121 const struct in6_addr *);
122 void match_set_ipv6_label(struct match *, ovs_be32);
123 void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
124 void match_set_nd_target(struct match *, const struct in6_addr *);
125 void match_set_nd_target_masked(struct match *, const struct in6_addr *,
126 const struct in6_addr *);
128 bool match_equal(const struct match *, const struct match *);
129 uint32_t match_hash(const struct match *, uint32_t basis);
131 void match_format(const struct match *, struct ds *, unsigned int priority);
132 char *match_to_string(const struct match *, unsigned int priority);
133 void match_print(const struct match *);
135 /* Compressed match. */
137 /* A sparse representation of a "struct match".
139 * There are two invariants:
141 * - The same invariant as "struct match", that is, a 1-bit in the 'flow'
142 * must correspond to a 1-bit in 'mask'.
144 * - 'flow' and 'mask' have the same 'map'. This implies that 'flow' and
145 * 'mask' have the same part of "struct flow" at the same offset into
146 * 'values', which makes minimatch_matches_flow() faster.
149 struct miniflow flow;
150 struct minimask mask;
153 void minimatch_init(struct minimatch *, const struct match *);
154 void minimatch_clone(struct minimatch *, const struct minimatch *);
155 void minimatch_move(struct minimatch *dst, struct minimatch *src);
156 void minimatch_destroy(struct minimatch *);
158 void minimatch_expand(const struct minimatch *, struct match *);
160 bool minimatch_equal(const struct minimatch *a, const struct minimatch *b);
161 uint32_t minimatch_hash(const struct minimatch *, uint32_t basis);
163 bool minimatch_matches_flow(const struct minimatch *, const struct flow *);
165 uint32_t minimatch_hash_range(const struct minimatch *,
166 uint8_t start, uint8_t end, uint32_t *basis);
168 void minimatch_format(const struct minimatch *, struct ds *,
169 unsigned int priority);
170 char *minimatch_to_string(const struct minimatch *, unsigned int priority);