2 * Copyright (c) 2009, 2010 Nicira Networks.
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.
18 #define CLASSIFIER_H 1
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.
32 #include "openflow/nicira-ext.h"
33 #include "openflow/openflow.h"
35 /* A flow classifier. */
37 int n_rules; /* Total number of rules. */
38 struct hmap tables; /* Contains "struct cls_table"s. */
41 /* A set of rules that all have the same fields wildcarded. */
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 int n_refs; /* Reference count used during iteration. */
50 /* A flow classification rule.
52 * Use one of the cls_rule_*() functions to initialize a cls_rule.
54 * The cls_rule_*() functions below maintain the following important
55 * invariant that the classifier depends on:
57 * - If a bit or a field is wildcarded in 'wc', then the corresponding bit or
58 * field in 'flow' is set to all-0-bits. (The
59 * cls_rule_zero_wildcarded_fields() function can be used to restore this
60 * invariant after adding wildcards.)
63 struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
64 struct list list; /* List of identical, lower-priority rules. */
65 struct flow flow; /* All field values. */
66 struct flow_wildcards wc; /* Wildcards for fields. */
67 unsigned int priority; /* Larger numbers are higher priorities. */
71 CLS_INC_EXACT = 1 << 0, /* Include exact-match flows? */
72 CLS_INC_WILD = 1 << 1, /* Include flows with wildcards? */
73 CLS_INC_ALL = CLS_INC_EXACT | CLS_INC_WILD
76 void cls_rule_init(const struct flow *, const struct flow_wildcards *,
77 unsigned int priority, struct cls_rule *);
78 void cls_rule_init_exact(const struct flow *, unsigned int priority,
80 void cls_rule_from_match(const struct ofp_match *, unsigned int priority,
81 int flow_format, uint64_t cookie, struct cls_rule *);
82 void cls_rule_init_catchall(struct cls_rule *, unsigned int priority);
84 void cls_rule_zero_wildcarded_fields(struct cls_rule *);
86 void cls_rule_set_in_port(struct cls_rule *, uint16_t odp_port);
87 void cls_rule_set_dl_type(struct cls_rule *, ovs_be16);
88 void cls_rule_set_dl_src(struct cls_rule *, const uint8_t[6]);
89 void cls_rule_set_dl_dst(struct cls_rule *, const uint8_t[6]);
90 bool cls_rule_set_dl_tci(struct cls_rule *, ovs_be16 tci);
91 bool cls_rule_set_dl_tci_masked(struct cls_rule *,
92 ovs_be16 tci, ovs_be16 mask);
93 void cls_rule_set_dl_vlan(struct cls_rule *, ovs_be16);
94 void cls_rule_set_dl_vlan_pcp(struct cls_rule *, uint8_t);
95 void cls_rule_set_tp_src(struct cls_rule *, ovs_be16);
96 void cls_rule_set_tp_dst(struct cls_rule *, ovs_be16);
97 void cls_rule_set_nw_proto(struct cls_rule *, uint8_t);
98 void cls_rule_set_nw_src(struct cls_rule *, ovs_be32);
99 bool cls_rule_set_nw_src_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
100 void cls_rule_set_nw_dst(struct cls_rule *, ovs_be32);
101 bool cls_rule_set_nw_dst_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask);
102 void cls_rule_set_nw_tos(struct cls_rule *, uint8_t);
103 void cls_rule_set_icmp_type(struct cls_rule *, uint8_t);
104 void cls_rule_set_icmp_code(struct cls_rule *, uint8_t);
106 char *cls_rule_to_string(const struct cls_rule *);
107 void cls_rule_print(const struct cls_rule *);
109 void classifier_init(struct classifier *);
110 void classifier_destroy(struct classifier *);
111 bool classifier_is_empty(const struct classifier *);
112 int classifier_count(const struct classifier *);
113 int classifier_count_exact(const struct classifier *);
114 struct cls_rule *classifier_insert(struct classifier *, struct cls_rule *);
115 void classifier_insert_exact(struct classifier *, struct cls_rule *);
116 void classifier_remove(struct classifier *, struct cls_rule *);
117 struct cls_rule *classifier_lookup(const struct classifier *,
118 const struct flow *, int include);
119 bool classifier_rule_overlaps(const struct classifier *,
120 const struct cls_rule *);
122 typedef void cls_cb_func(struct cls_rule *, void *aux);
124 void classifier_for_each(const struct classifier *, int include,
125 cls_cb_func *, void *aux);
126 void classifier_for_each_match(const struct classifier *,
127 const struct cls_rule *,
128 int include, cls_cb_func *, void *aux);
129 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
130 const struct cls_rule *);
132 /* Iteration shorthands. */
134 struct cls_table *classifier_exact_table(const struct classifier *);
135 struct cls_rule *cls_table_first_rule(const struct cls_table *);
136 struct cls_rule *cls_table_next_rule(const struct cls_table *,
137 const struct cls_rule *);
139 #define CLS_TABLE_FOR_EACH_RULE(RULE, MEMBER, TABLE) \
140 for ((RULE) = OBJECT_CONTAINING(cls_table_first_rule(TABLE), \
142 &(RULE)->MEMBER != NULL; \
143 (RULE) = OBJECT_CONTAINING(cls_table_next_rule(TABLE, \
147 #define CLASSIFIER_FOR_EACH_EXACT_RULE(RULE, MEMBER, CLS) \
148 CLS_TABLE_FOR_EACH_RULE (RULE, MEMBER, classifier_exact_table(CLS))
150 #endif /* classifier.h */