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.
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.
33 #include "openflow/nicira-ext.h"
34 #include "openflow/openflow.h"
40 /* A flow classifier. */
42 int n_rules; /* Total number of rules. */
43 struct hmap tables; /* Contains "struct cls_table"s. */
46 /* A set of rules that all have the same fields wildcarded. */
48 struct hmap_node hmap_node; /* Within struct classifier 'tables' hmap. */
49 struct hmap rules; /* Contains "struct cls_rule"s. */
50 struct flow_wildcards wc; /* Wildcards for fields. */
51 int n_table_rules; /* Number of rules, including duplicates. */
52 bool is_catchall; /* True if this table wildcards every field. */
55 /* Returns true if 'table' is a "catch-all" table that will match every
56 * packet (if there is no higher-priority match). */
58 cls_table_is_catchall(const struct cls_table *table)
60 return table->is_catchall;
63 /* A rule in a "struct classifier" */
65 struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
66 struct list list; /* List of identical, lower-priority rules. */
67 struct match match; /* Matching rule. */
68 unsigned int priority; /* Larger numbers are higher priorities. */
71 void cls_rule_init(struct cls_rule *,
72 const struct match *, unsigned int priority);
73 void cls_rule_clone(struct cls_rule *, const struct cls_rule *);
74 void cls_rule_destroy(struct cls_rule *);
76 bool cls_rule_equal(const struct cls_rule *, const struct cls_rule *);
77 uint32_t cls_rule_hash(const struct cls_rule *, uint32_t basis);
79 void cls_rule_format(const struct cls_rule *, struct ds *);
81 bool cls_rule_is_catchall(const struct cls_rule *);
83 bool cls_rule_is_loose_match(const struct cls_rule *rule,
84 const struct match *criteria);
86 void classifier_init(struct classifier *);
87 void classifier_destroy(struct classifier *);
88 bool classifier_is_empty(const struct classifier *);
89 int classifier_count(const struct classifier *);
90 void classifier_insert(struct classifier *, struct cls_rule *);
91 struct cls_rule *classifier_replace(struct classifier *, struct cls_rule *);
92 void classifier_remove(struct classifier *, struct cls_rule *);
93 struct cls_rule *classifier_lookup(const struct classifier *,
95 bool classifier_rule_overlaps(const struct classifier *,
96 const struct cls_rule *);
98 typedef void cls_cb_func(struct cls_rule *, void *aux);
100 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
101 const struct cls_rule *);
102 struct cls_rule *classifier_find_match_exactly(const struct classifier *,
103 const struct match *,
104 unsigned int priority);
109 const struct classifier *cls;
110 const struct cls_table *table;
111 const struct cls_rule *target;
114 void cls_cursor_init(struct cls_cursor *, const struct classifier *,
115 const struct cls_rule *match);
116 struct cls_rule *cls_cursor_first(struct cls_cursor *);
117 struct cls_rule *cls_cursor_next(struct cls_cursor *, struct cls_rule *);
119 #define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR) \
120 for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
121 &(RULE)->MEMBER != NULL; \
122 ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
125 #define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR) \
126 for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
127 (&(RULE)->MEMBER != NULL \
128 ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
137 #endif /* classifier.h */