401497279130263de8ee1aabdac83b3ac0725c2d
[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 /* A flow classifier. */
36 struct classifier {
37     int n_rules;                /* Total number of rules. */
38     struct hmap tables;         /* Contains "struct cls_table"s.  */
39 };
40
41 /* A set of rules that all have the same fields wildcarded. */
42 struct cls_table {
43     struct hmap_node hmap_node; /* Within struct classifier 'wctables'. */
44     struct hmap rules;          /* Contains "struct cls_rule"s. */
45     struct flow_wildcards wc;   /* Wildcards for fields. */
46     int n_table_rules;          /* Number of rules, including duplicates. */
47 };
48
49 /* A flow classification rule.
50  *
51  * Use one of the cls_rule_*() functions to initialize a cls_rule.
52  *
53  * The cls_rule_*() functions below maintain the following important
54  * invariant that the classifier depends on:
55  *
56  *   - If a bit or a field is wildcarded in 'wc', then the corresponding bit or
57  *     field in 'flow' is set to all-0-bits.  (The
58  *     cls_rule_zero_wildcarded_fields() function can be used to restore this
59  *     invariant after adding wildcards.)
60  */
61 struct cls_rule {
62     struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
63     struct list list;           /* List of identical, lower-priority rules. */
64     struct flow flow;           /* All field values. */
65     struct flow_wildcards wc;   /* Wildcards for fields. */
66     unsigned int priority;      /* Larger numbers are higher priorities. */
67 };
68
69 void cls_rule_init(const struct flow *, const struct flow_wildcards *,
70                    unsigned int priority, struct cls_rule *);
71 void cls_rule_init_exact(const struct flow *, unsigned int priority,
72                          struct cls_rule *);
73 void cls_rule_init_catchall(struct cls_rule *, unsigned int priority);
74
75 void cls_rule_zero_wildcarded_fields(struct cls_rule *);
76
77 void cls_rule_set_reg(struct cls_rule *, unsigned int reg_idx, uint32_t value);
78 void cls_rule_set_reg_masked(struct cls_rule *, unsigned int reg_idx,
79                              uint32_t value, uint32_t mask);
80 void cls_rule_set_tun_id(struct cls_rule *, ovs_be64 tun_id);
81 void cls_rule_set_tun_id_masked(struct cls_rule *,
82                                 ovs_be64 tun_id, ovs_be64 mask);
83 void cls_rule_set_in_port(struct cls_rule *, uint16_t odp_port);
84 void cls_rule_set_dl_type(struct cls_rule *, ovs_be16);
85 void cls_rule_set_dl_src(struct cls_rule *, const uint8_t[6]);
86 void cls_rule_set_dl_dst(struct cls_rule *, const uint8_t[6]);
87 void cls_rule_set_dl_tci(struct cls_rule *, ovs_be16 tci);
88 void cls_rule_set_dl_tci_masked(struct cls_rule *,
89                                 ovs_be16 tci, ovs_be16 mask);
90 void cls_rule_set_any_vid(struct cls_rule *);
91 void cls_rule_set_dl_vlan(struct cls_rule *, ovs_be16);
92 void cls_rule_set_any_pcp(struct cls_rule *);
93 void cls_rule_set_dl_vlan_pcp(struct cls_rule *, uint8_t);
94 void cls_rule_set_tp_src(struct cls_rule *, ovs_be16);
95 void cls_rule_set_tp_dst(struct cls_rule *, ovs_be16);
96 void cls_rule_set_nw_proto(struct cls_rule *, uint8_t);
97 void cls_rule_set_nw_src(struct cls_rule *, ovs_be32);
98 bool cls_rule_set_nw_src_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
99 void cls_rule_set_nw_dst(struct cls_rule *, ovs_be32);
100 bool cls_rule_set_nw_dst_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
101 void cls_rule_set_nw_tos(struct cls_rule *, uint8_t);
102 void cls_rule_set_icmp_type(struct cls_rule *, uint8_t);
103 void cls_rule_set_icmp_code(struct cls_rule *, uint8_t);
104 void cls_rule_set_arp_sha(struct cls_rule *, const uint8_t[6]);
105 void cls_rule_set_arp_tha(struct cls_rule *, const uint8_t[6]);
106
107 bool cls_rule_equal(const struct cls_rule *, const struct cls_rule *);
108
109 void cls_rule_format(const struct cls_rule *, struct ds *);
110 char *cls_rule_to_string(const struct cls_rule *);
111 void cls_rule_print(const struct cls_rule *);
112
113 void classifier_init(struct classifier *);
114 void classifier_destroy(struct classifier *);
115 bool classifier_is_empty(const struct classifier *);
116 int classifier_count(const struct classifier *);
117 struct cls_rule *classifier_insert(struct classifier *, struct cls_rule *);
118 void classifier_remove(struct classifier *, struct cls_rule *);
119 struct cls_rule *classifier_lookup(const struct classifier *,
120                                    const struct flow *);
121 bool classifier_rule_overlaps(const struct classifier *,
122                               const struct cls_rule *);
123
124 typedef void cls_cb_func(struct cls_rule *, void *aux);
125
126 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
127                                               const struct cls_rule *);
128 \f
129 /* Iteration. */
130
131 struct cls_cursor {
132     const struct classifier *cls;
133     const struct cls_table *table;
134     const struct cls_rule *target;
135 };
136
137 void cls_cursor_init(struct cls_cursor *, const struct classifier *,
138                      const struct cls_rule *match);
139 struct cls_rule *cls_cursor_first(struct cls_cursor *);
140 struct cls_rule *cls_cursor_next(struct cls_cursor *, struct cls_rule *);
141
142 #define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR)                       \
143     for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER);      \
144          &(RULE)->MEMBER != NULL;                                       \
145          ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
146                           MEMBER))
147
148 #define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR)            \
149     for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER);      \
150          (&(RULE)->MEMBER != NULL                                       \
151           ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
152                              MEMBER)                                    \
153           : 0);                                                         \
154          (RULE) = (NEXT))
155
156 #endif /* classifier.h */