ovsdb: Correct specification inconsistency between "lock" and "assert".
[openvswitch] / lib / classifier.h
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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 CLASSIFIER_H
18 #define CLASSIFIER_H 1
19
20 /* Flow classifier.
21  *
22  * A classifier is a "struct classifier",
23  *      a hash map from a set of wildcards to a "struct cls_table",
24  *              a hash map from fixed field values to "struct cls_rule",
25  *                      which can contain a list of otherwise identical rules
26  *                      with lower priorities.
27  */
28
29 #include "flow.h"
30 #include "hmap.h"
31 #include "list.h"
32 #include "openflow/nicira-ext.h"
33 #include "openflow/openflow.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* A flow classifier. */
40 struct classifier {
41     int n_rules;                /* Total number of rules. */
42     struct hmap tables;         /* Contains "struct cls_table"s.  */
43 };
44
45 /* A set of rules that all have the same fields wildcarded. */
46 struct cls_table {
47     struct hmap_node hmap_node; /* Within struct classifier 'wctables'. */
48     struct hmap rules;          /* Contains "struct cls_rule"s. */
49     struct flow_wildcards wc;   /* Wildcards for fields. */
50     int n_table_rules;          /* Number of rules, including duplicates. */
51 };
52
53 /* A flow classification rule.
54  *
55  * Use one of the cls_rule_*() functions to initialize a cls_rule.
56  *
57  * The cls_rule_*() functions below maintain the following important
58  * invariant that the classifier depends on:
59  *
60  *   - If a bit or a field is wildcarded in 'wc', then the corresponding bit or
61  *     field in 'flow' is set to all-0-bits.  (The
62  *     cls_rule_zero_wildcarded_fields() function can be used to restore this
63  *     invariant after adding wildcards.)
64  */
65 struct cls_rule {
66     struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
67     struct list list;           /* List of identical, lower-priority rules. */
68     struct flow flow;           /* All field values. */
69     struct flow_wildcards wc;   /* Wildcards for fields. */
70     unsigned int priority;      /* Larger numbers are higher priorities. */
71 };
72
73 void cls_rule_init(const struct flow *, const struct flow_wildcards *,
74                    unsigned int priority, struct cls_rule *);
75 void cls_rule_init_exact(const struct flow *, unsigned int priority,
76                          struct cls_rule *);
77 void cls_rule_init_catchall(struct cls_rule *, unsigned int priority);
78
79 void cls_rule_zero_wildcarded_fields(struct cls_rule *);
80
81 void cls_rule_set_reg(struct cls_rule *, unsigned int reg_idx, uint32_t value);
82 void cls_rule_set_reg_masked(struct cls_rule *, unsigned int reg_idx,
83                              uint32_t value, uint32_t mask);
84 void cls_rule_set_tun_id(struct cls_rule *, ovs_be64 tun_id);
85 void cls_rule_set_tun_id_masked(struct cls_rule *,
86                                 ovs_be64 tun_id, ovs_be64 mask);
87 void cls_rule_set_in_port(struct cls_rule *, uint16_t odp_port);
88 void cls_rule_set_dl_type(struct cls_rule *, ovs_be16);
89 void cls_rule_set_dl_src(struct cls_rule *, const uint8_t[6]);
90 void cls_rule_set_dl_dst(struct cls_rule *, const uint8_t[6]);
91 void cls_rule_set_dl_dst_masked(struct cls_rule *, const uint8_t dl_dst[6],
92                                 const uint8_t mask[6]);
93 void cls_rule_set_dl_tci(struct cls_rule *, ovs_be16 tci);
94 void cls_rule_set_dl_tci_masked(struct cls_rule *,
95                                 ovs_be16 tci, ovs_be16 mask);
96 void cls_rule_set_any_vid(struct cls_rule *);
97 void cls_rule_set_dl_vlan(struct cls_rule *, ovs_be16);
98 void cls_rule_set_any_pcp(struct cls_rule *);
99 void cls_rule_set_dl_vlan_pcp(struct cls_rule *, uint8_t);
100 void cls_rule_set_tp_src(struct cls_rule *, ovs_be16);
101 void cls_rule_set_tp_dst(struct cls_rule *, ovs_be16);
102 void cls_rule_set_nw_proto(struct cls_rule *, uint8_t);
103 void cls_rule_set_nw_src(struct cls_rule *, ovs_be32);
104 bool cls_rule_set_nw_src_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
105 void cls_rule_set_nw_dst(struct cls_rule *, ovs_be32);
106 bool cls_rule_set_nw_dst_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
107 void cls_rule_set_nw_tos(struct cls_rule *, uint8_t);
108 void cls_rule_set_icmp_type(struct cls_rule *, uint8_t);
109 void cls_rule_set_icmp_code(struct cls_rule *, uint8_t);
110 void cls_rule_set_arp_sha(struct cls_rule *, const uint8_t[6]);
111 void cls_rule_set_arp_tha(struct cls_rule *, const uint8_t[6]);
112 void cls_rule_set_ipv6_src(struct cls_rule *, const struct in6_addr *);
113 bool cls_rule_set_ipv6_src_masked(struct cls_rule *, const struct in6_addr *,
114                                   const struct in6_addr *);
115 void cls_rule_set_ipv6_dst(struct cls_rule *, const struct in6_addr *);
116 bool cls_rule_set_ipv6_dst_masked(struct cls_rule *, const struct in6_addr *,
117                                   const struct in6_addr *);
118 void cls_rule_set_nd_target(struct cls_rule *, const struct in6_addr);
119
120 bool cls_rule_equal(const struct cls_rule *, const struct cls_rule *);
121 uint32_t cls_rule_hash(const struct cls_rule *, uint32_t basis);
122
123 void cls_rule_format(const struct cls_rule *, struct ds *);
124 char *cls_rule_to_string(const struct cls_rule *);
125 void cls_rule_print(const struct cls_rule *);
126
127 void classifier_init(struct classifier *);
128 void classifier_destroy(struct classifier *);
129 bool classifier_is_empty(const struct classifier *);
130 int classifier_count(const struct classifier *);
131 void classifier_insert(struct classifier *, struct cls_rule *);
132 struct cls_rule *classifier_replace(struct classifier *, struct cls_rule *);
133 void classifier_remove(struct classifier *, struct cls_rule *);
134 struct cls_rule *classifier_lookup(const struct classifier *,
135                                    const struct flow *);
136 bool classifier_rule_overlaps(const struct classifier *,
137                               const struct cls_rule *);
138
139 typedef void cls_cb_func(struct cls_rule *, void *aux);
140
141 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
142                                               const struct cls_rule *);
143 \f
144 /* Iteration. */
145
146 struct cls_cursor {
147     const struct classifier *cls;
148     const struct cls_table *table;
149     const struct cls_rule *target;
150 };
151
152 void cls_cursor_init(struct cls_cursor *, const struct classifier *,
153                      const struct cls_rule *match);
154 struct cls_rule *cls_cursor_first(struct cls_cursor *);
155 struct cls_rule *cls_cursor_next(struct cls_cursor *, struct cls_rule *);
156
157 #define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR)                       \
158     for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER);      \
159          &(RULE)->MEMBER != NULL;                                       \
160          ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
161                           MEMBER))
162
163 #define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR)            \
164     for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER);      \
165          (&(RULE)->MEMBER != NULL                                       \
166           ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
167                              MEMBER)                                    \
168           : 0);                                                         \
169          (RULE) = (NEXT))
170
171 #ifdef __cplusplus
172 }
173 #endif
174
175 #endif /* classifier.h */