2 * Copyright (c) 2009, 2010, 2011, 2012 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 *);
41 void match_init_exact(struct match *, const struct flow *);
43 void match_zero_wildcarded_fields(struct match *);
45 void match_set_reg(struct match *, unsigned int reg_idx, uint32_t value);
46 void match_set_reg_masked(struct match *, unsigned int reg_idx,
47 uint32_t value, uint32_t mask);
48 void match_set_metadata(struct match *, ovs_be64 metadata);
49 void match_set_metadata_masked(struct match *,
50 ovs_be64 metadata, ovs_be64 mask);
51 void match_set_tun_id(struct match *, ovs_be64 tun_id);
52 void match_set_tun_id_masked(struct match *, ovs_be64 tun_id, ovs_be64 mask);
53 void match_set_tun_src(struct match *match, ovs_be32 src);
54 void match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask);
55 void match_set_tun_dst(struct match *match, ovs_be32 dst);
56 void match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask);
57 void match_set_tun_ttl(struct match *match, uint8_t ttl);
58 void match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask);
59 void match_set_tun_tos(struct match *match, uint8_t tos);
60 void match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask);
61 void match_set_tun_flags(struct match *match, uint16_t flags);
62 void match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask);
63 void match_set_in_port(struct match *, uint16_t ofp_port);
64 void match_set_dl_type(struct match *, ovs_be16);
65 void match_set_dl_src(struct match *, const uint8_t[6]);
66 void match_set_dl_src_masked(struct match *, const uint8_t dl_src[6],
67 const uint8_t mask[6]);
68 void match_set_dl_dst(struct match *, const uint8_t[6]);
69 void match_set_dl_dst_masked(struct match *, const uint8_t dl_dst[6],
70 const uint8_t mask[6]);
71 void match_set_dl_tci(struct match *, ovs_be16 tci);
72 void match_set_dl_tci_masked(struct match *, ovs_be16 tci, ovs_be16 mask);
73 void match_set_any_vid(struct match *);
74 void match_set_dl_vlan(struct match *, ovs_be16);
75 void match_set_vlan_vid(struct match *, ovs_be16);
76 void match_set_vlan_vid_masked(struct match *, ovs_be16 vid, ovs_be16 mask);
77 void match_set_any_pcp(struct match *);
78 void match_set_dl_vlan_pcp(struct match *, uint8_t);
79 void match_set_tp_src(struct match *, ovs_be16);
80 void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
81 void match_set_tp_dst(struct match *, ovs_be16);
82 void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
83 void match_set_nw_proto(struct match *, uint8_t);
84 void match_set_nw_src(struct match *, ovs_be32);
85 void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
86 void match_set_nw_dst(struct match *, ovs_be32);
87 void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
88 void match_set_nw_dscp(struct match *, uint8_t);
89 void match_set_nw_ecn(struct match *, uint8_t);
90 void match_set_nw_ttl(struct match *, uint8_t);
91 void match_set_nw_frag(struct match *, uint8_t nw_frag);
92 void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
93 void match_set_icmp_type(struct match *, uint8_t);
94 void match_set_icmp_code(struct match *, uint8_t);
95 void match_set_arp_sha(struct match *, const uint8_t[6]);
96 void match_set_arp_sha_masked(struct match *,
97 const uint8_t arp_sha[6],
98 const uint8_t mask[6]);
99 void match_set_arp_tha(struct match *, const uint8_t[6]);
100 void match_set_arp_tha_masked(struct match *,
101 const uint8_t arp_tha[6],
102 const uint8_t mask[6]);
103 void match_set_ipv6_src(struct match *, const struct in6_addr *);
104 void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
105 const struct in6_addr *);
106 void match_set_ipv6_dst(struct match *, const struct in6_addr *);
107 void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
108 const struct in6_addr *);
109 void match_set_ipv6_label(struct match *, ovs_be32);
110 void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
111 void match_set_nd_target(struct match *, const struct in6_addr *);
112 void match_set_nd_target_masked(struct match *, const struct in6_addr *,
113 const struct in6_addr *);
115 bool match_equal(const struct match *, const struct match *);
116 uint32_t match_hash(const struct match *, uint32_t basis);
118 void match_format(const struct match *, struct ds *, unsigned int priority);
119 char *match_to_string(const struct match *, unsigned int priority);
120 void match_print(const struct match *);
122 /* Compressed match. */
124 /* A sparse representation of a "struct match".
126 * This has the same invariant as "struct match", that is, a 1-bit in the
127 * 'flow' must correspond to a 1-bit in 'mask'.
129 * The invariants for the underlying miniflow and minimask are also maintained,
130 * which means that 'flow' and 'mask' can have different 'map's. In
131 * particular, if the match checks that a given 32-bit field has value 0, then
132 * 'map' will have a 1-bit in 'mask' but a 0-bit in 'flow' for that field. */
134 struct miniflow flow;
135 struct minimask mask;
138 void minimatch_init(struct minimatch *, const struct match *);
139 void minimatch_clone(struct minimatch *, const struct minimatch *);
140 void minimatch_destroy(struct minimatch *);
142 void minimatch_expand(const struct minimatch *, struct match *);
144 bool minimatch_equal(const struct minimatch *a, const struct minimatch *b);
145 uint32_t minimatch_hash(const struct minimatch *, uint32_t basis);
147 void minimatch_format(const struct minimatch *, struct ds *,
148 unsigned int priority);
149 char *minimatch_to_string(const struct minimatch *, unsigned int priority);