ofp-errors: New error code ONFBIC_DUP_INSTRUCTION.
[sliver-openvswitch.git] / lib / match.h
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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 MATCH_H
18 #define MATCH_H 1
19
20 #include "flow.h"
21
22 struct ds;
23
24 /* A flow classification match.
25  *
26  * Use one of the match_*() functions to initialize a "struct match".
27  *
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.) */
32 struct match {
33     struct flow flow;
34     struct flow_wildcards wc;
35 };
36
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 *);
42
43 void match_zero_wildcarded_fields(struct match *);
44
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 *, ofp_port_t ofp_port);
64 void match_set_skb_mark(struct match *, uint32_t skb_mark);
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_label(struct match *);
82 void match_set_mpls_label(struct match *, ovs_be32);
83 void match_set_any_mpls_tc(struct match *);
84 void match_set_mpls_tc(struct match *, uint8_t);
85 void match_set_any_mpls_bos(struct match *);
86 void match_set_mpls_bos(struct match *, uint8_t);
87 void match_set_tp_src(struct match *, ovs_be16);
88 void match_set_tp_src_masked(struct match *, ovs_be16 port, ovs_be16 mask);
89 void match_set_tp_dst(struct match *, ovs_be16);
90 void match_set_tp_dst_masked(struct match *, ovs_be16 port, ovs_be16 mask);
91 void match_set_nw_proto(struct match *, uint8_t);
92 void match_set_nw_src(struct match *, ovs_be32);
93 void match_set_nw_src_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
94 void match_set_nw_dst(struct match *, ovs_be32);
95 void match_set_nw_dst_masked(struct match *, ovs_be32 ip, ovs_be32 mask);
96 void match_set_nw_dscp(struct match *, uint8_t);
97 void match_set_nw_ecn(struct match *, uint8_t);
98 void match_set_nw_ttl(struct match *, uint8_t);
99 void match_set_nw_frag(struct match *, uint8_t nw_frag);
100 void match_set_nw_frag_masked(struct match *, uint8_t nw_frag, uint8_t mask);
101 void match_set_icmp_type(struct match *, uint8_t);
102 void match_set_icmp_code(struct match *, uint8_t);
103 void match_set_arp_sha(struct match *, const uint8_t[6]);
104 void match_set_arp_sha_masked(struct match *,
105                               const uint8_t arp_sha[6],
106                               const uint8_t mask[6]);
107 void match_set_arp_tha(struct match *, const uint8_t[6]);
108 void match_set_arp_tha_masked(struct match *,
109                               const uint8_t arp_tha[6],
110                               const uint8_t mask[6]);
111 void match_set_ipv6_src(struct match *, const struct in6_addr *);
112 void match_set_ipv6_src_masked(struct match *, const struct in6_addr *,
113                                const struct in6_addr *);
114 void match_set_ipv6_dst(struct match *, const struct in6_addr *);
115 void match_set_ipv6_dst_masked(struct match *, const struct in6_addr *,
116                                const struct in6_addr *);
117 void match_set_ipv6_label(struct match *, ovs_be32);
118 void match_set_ipv6_label_masked(struct match *, ovs_be32, ovs_be32);
119 void match_set_nd_target(struct match *, const struct in6_addr *);
120 void match_set_nd_target_masked(struct match *, const struct in6_addr *,
121                                 const struct in6_addr *);
122
123 bool match_equal(const struct match *, const struct match *);
124 uint32_t match_hash(const struct match *, uint32_t basis);
125
126 void match_format(const struct match *, struct ds *, unsigned int priority);
127 char *match_to_string(const struct match *, unsigned int priority);
128 void match_print(const struct match *);
129 \f
130 /* Compressed match. */
131
132 /* A sparse representation of a "struct match".
133  *
134  * This has the same invariant as "struct match", that is, a 1-bit in the
135  * 'flow' must correspond to a 1-bit in 'mask'.
136  *
137  * The invariants for the underlying miniflow and minimask are also maintained,
138  * which means that 'flow' and 'mask' can have different 'map's.  In
139  * particular, if the match checks that a given 32-bit field has value 0, then
140  * 'map' will have a 1-bit in 'mask' but a 0-bit in 'flow' for that field. */
141 struct minimatch {
142     struct miniflow flow;
143     struct minimask mask;
144 };
145
146 void minimatch_init(struct minimatch *, const struct match *);
147 void minimatch_clone(struct minimatch *, const struct minimatch *);
148 void minimatch_destroy(struct minimatch *);
149
150 void minimatch_expand(const struct minimatch *, struct match *);
151
152 bool minimatch_equal(const struct minimatch *a, const struct minimatch *b);
153 uint32_t minimatch_hash(const struct minimatch *, uint32_t basis);
154
155 void minimatch_format(const struct minimatch *, struct ds *,
156                       unsigned int priority);
157 char *minimatch_to_string(const struct minimatch *, unsigned int priority);
158
159 #endif /* match.h */