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_from_flow(const struct flow *, uint32_t wildcards,
77 unsigned int priority, struct cls_rule *);
78 void cls_rule_from_match(const struct ofp_match *, unsigned int priority,
79 int flow_format, uint64_t cookie, struct cls_rule *);
80 void cls_rule_init_catchall(struct cls_rule *, unsigned int priority);
82 void cls_rule_zero_wildcarded_fields(struct cls_rule *);
84 char *cls_rule_to_string(const struct cls_rule *);
85 void cls_rule_print(const struct cls_rule *);
87 void classifier_init(struct classifier *);
88 void classifier_destroy(struct classifier *);
89 bool classifier_is_empty(const struct classifier *);
90 int classifier_count(const struct classifier *);
91 int classifier_count_exact(const struct classifier *);
92 struct cls_rule *classifier_insert(struct classifier *, struct cls_rule *);
93 void classifier_insert_exact(struct classifier *, struct cls_rule *);
94 void classifier_remove(struct classifier *, struct cls_rule *);
95 struct cls_rule *classifier_lookup(const struct classifier *,
96 const struct flow *, int include);
97 bool classifier_rule_overlaps(const struct classifier *,
98 const struct cls_rule *);
100 typedef void cls_cb_func(struct cls_rule *, void *aux);
102 void classifier_for_each(const struct classifier *, int include,
103 cls_cb_func *, void *aux);
104 void classifier_for_each_match(const struct classifier *,
105 const struct cls_rule *,
106 int include, cls_cb_func *, void *aux);
107 struct cls_rule *classifier_find_rule_exactly(const struct classifier *,
108 const struct cls_rule *);
110 /* Iteration shorthands. */
112 struct cls_table *classifier_exact_table(const struct classifier *);
113 struct cls_rule *cls_table_first_rule(const struct cls_table *);
114 struct cls_rule *cls_table_next_rule(const struct cls_table *,
115 const struct cls_rule *);
117 #define CLS_TABLE_FOR_EACH_RULE(RULE, MEMBER, TABLE) \
118 for ((RULE) = OBJECT_CONTAINING(cls_table_first_rule(TABLE), \
120 &(RULE)->MEMBER != NULL; \
121 (RULE) = OBJECT_CONTAINING(cls_table_next_rule(TABLE, \
125 #define CLASSIFIER_FOR_EACH_EXACT_RULE(RULE, MEMBER, CLS) \
126 CLS_TABLE_FOR_EACH_RULE (RULE, MEMBER, classifier_exact_table(CLS))
128 #endif /* classifier.h */