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. */
44 struct list tables_priority; /* Tables in descending priority order */
47 /* A set of rules that all have the same fields wildcarded. */
49 struct hmap_node hmap_node; /* Within struct classifier 'tables' hmap. */
50 struct list list_node; /* Within classifier 'tables_priority_list' */
51 struct hmap rules; /* Contains "struct cls_rule"s. */
52 struct minimask mask; /* Wildcards for fields. */
53 int n_table_rules; /* Number of rules, including duplicates. */
54 unsigned int max_priority; /* Max priority of any rule in the table. */
55 unsigned int max_count; /* Count of max_priority rules. */
58 /* Returns true if 'table' is a "catch-all" table that will match every
59 * packet (if there is no higher-priority match). */
61 cls_table_is_catchall(const struct cls_table *table)
63 return minimask_is_catchall(&table->mask);
66 /* A rule in a "struct classifier". */
68 struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */
69 struct list list; /* List of identical, lower-priority rules. */
70 struct minimatch match; /* Matching rule. */
71 unsigned int priority; /* Larger numbers are higher priorities. */
74 void cls_rule_init(struct cls_rule *, const struct match *,
75 unsigned int priority);
76 void cls_rule_init_from_minimatch(struct cls_rule *, const struct minimatch *,
77 unsigned int priority);
78 void cls_rule_clone(struct cls_rule *, const struct cls_rule *);
79 void cls_rule_destroy(struct cls_rule *);
81 bool cls_rule_equal(const struct cls_rule *, const struct cls_rule *);
82 uint32_t cls_rule_hash(const struct cls_rule *, uint32_t basis);
84 void cls_rule_format(const struct cls_rule *, struct ds *);
86 bool cls_rule_is_catchall(const struct cls_rule *);
88 bool cls_rule_is_loose_match(const struct cls_rule *rule,
89 const struct minimatch *criteria);
91 void classifier_init(struct classifier *);
92 void classifier_destroy(struct classifier *);
93 bool classifier_is_empty(const struct classifier *);
94 int classifier_count(const struct classifier *);
95 void classifier_insert(struct classifier *, struct cls_rule *);
96 struct cls_rule *classifier_replace(struct classifier *, struct cls_rule *);
97 void classifier_remove(struct classifier *, struct cls_rule *);
98 struct cls_rule *classifier_lookup(const struct classifier *,
100 bool classifier_rule_overlaps(const struct classifier *,
101 const struct cls_rule *);
103 typedef void cls_cb_func(struct cls_rule *, void *aux);
105 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
106 const struct cls_rule *);
107 struct cls_rule *classifier_find_match_exactly(const struct classifier *,
108 const struct match *,
109 unsigned int priority);
114 const struct classifier *cls;
115 const struct cls_table *table;
116 const struct cls_rule *target;
119 void cls_cursor_init(struct cls_cursor *, const struct classifier *,
120 const struct cls_rule *match);
121 struct cls_rule *cls_cursor_first(struct cls_cursor *);
122 struct cls_rule *cls_cursor_next(struct cls_cursor *, struct cls_rule *);
124 #define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR) \
125 for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
126 &(RULE)->MEMBER != NULL; \
127 ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
130 #define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR) \
131 for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
132 (&(RULE)->MEMBER != NULL \
133 ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
142 #endif /* classifier.h */