]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/classifier.h
2 * Copyright (c) 2009, 2010, 2011 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"
39 /* A flow classifier. */
41 int n_rules
; /* Total number of rules. */
42 struct hmap tables
; /* Contains "struct cls_table"s. */
45 /* A set of rules that all have the same fields wildcarded. */
47 struct hmap_node hmap_node
; /* Within struct classifier 'tables' hmap. */
48 struct hmap rules
; /* Contains "struct cls_rule"s. */
49 struct flow_wildcards wc
; /* Wildcards for fields. */
50 int n_table_rules
; /* Number of rules, including duplicates. */
53 /* Returns true if 'table' is a "catch-all" table that will match every
54 * packet (if there is no higher-priority match). */
56 cls_table_is_catchall(const struct cls_table
*table
)
58 /* A catch-all table can only have one rule, so use hmap_count() as a cheap
59 * check to rule out other kinds of match before doing the full check with
60 * flow_wildcards_is_catchall(). */
61 return (hmap_count(&table
->rules
) == 1
62 && flow_wildcards_is_catchall(&table
->wc
));
65 /* A flow classification rule.
67 * Use one of the cls_rule_*() functions to initialize a cls_rule.
69 * The cls_rule_*() functions below maintain the following important
70 * invariant that the classifier depends on:
72 * - If a bit or a field is wildcarded in 'wc', then the corresponding bit or
73 * field in 'flow' is set to all-0-bits. (The
74 * cls_rule_zero_wildcarded_fields() function can be used to restore this
75 * invariant after adding wildcards.)
78 struct hmap_node hmap_node
; /* Within struct cls_table 'rules'. */
79 struct list list
; /* List of identical, lower-priority rules. */
80 struct flow flow
; /* All field values. */
81 struct flow_wildcards wc
; /* Wildcards for fields. */
82 unsigned int priority
; /* Larger numbers are higher priorities. */
85 void cls_rule_init(const struct flow
*, const struct flow_wildcards
*,
86 unsigned int priority
, struct cls_rule
*);
87 void cls_rule_init_exact(const struct flow
*, unsigned int priority
,
89 void cls_rule_init_catchall(struct cls_rule
*, unsigned int priority
);
91 void cls_rule_zero_wildcarded_fields(struct cls_rule
*);
93 void cls_rule_set_reg(struct cls_rule
*, unsigned int reg_idx
, uint32_t value
);
94 void cls_rule_set_reg_masked(struct cls_rule
*, unsigned int reg_idx
,
95 uint32_t value
, uint32_t mask
);
96 void cls_rule_set_tun_id(struct cls_rule
*, ovs_be64 tun_id
);
97 void cls_rule_set_tun_id_masked(struct cls_rule
*,
98 ovs_be64 tun_id
, ovs_be64 mask
);
99 void cls_rule_set_in_port(struct cls_rule
*, uint16_t odp_port
);
100 void cls_rule_set_dl_type(struct cls_rule
*, ovs_be16
);
101 void cls_rule_set_dl_src(struct cls_rule
*, const uint8_t[6]);
102 void cls_rule_set_dl_dst(struct cls_rule
*, const uint8_t[6]);
103 void cls_rule_set_dl_dst_masked(struct cls_rule
*, const uint8_t dl_dst
[6],
104 const uint8_t mask
[6]);
105 void cls_rule_set_dl_tci(struct cls_rule
*, ovs_be16 tci
);
106 void cls_rule_set_dl_tci_masked(struct cls_rule
*,
107 ovs_be16 tci
, ovs_be16 mask
);
108 void cls_rule_set_any_vid(struct cls_rule
*);
109 void cls_rule_set_dl_vlan(struct cls_rule
*, ovs_be16
);
110 void cls_rule_set_any_pcp(struct cls_rule
*);
111 void cls_rule_set_dl_vlan_pcp(struct cls_rule
*, uint8_t);
112 void cls_rule_set_tp_src(struct cls_rule
*, ovs_be16
);
113 void cls_rule_set_tp_dst(struct cls_rule
*, ovs_be16
);
114 void cls_rule_set_nw_proto(struct cls_rule
*, uint8_t);
115 void cls_rule_set_nw_src(struct cls_rule
*, ovs_be32
);
116 bool cls_rule_set_nw_src_masked(struct cls_rule
*, ovs_be32 ip
, ovs_be32 mask
);
117 void cls_rule_set_nw_dst(struct cls_rule
*, ovs_be32
);
118 bool cls_rule_set_nw_dst_masked(struct cls_rule
*, ovs_be32 ip
, ovs_be32 mask
);
119 void cls_rule_set_nw_dscp(struct cls_rule
*, uint8_t);
120 void cls_rule_set_nw_ecn(struct cls_rule
*, uint8_t);
121 void cls_rule_set_frag(struct cls_rule
*, uint8_t frag
);
122 void cls_rule_set_frag_masked(struct cls_rule
*, uint8_t frag
, uint8_t mask
);
123 void cls_rule_set_icmp_type(struct cls_rule
*, uint8_t);
124 void cls_rule_set_icmp_code(struct cls_rule
*, uint8_t);
125 void cls_rule_set_arp_sha(struct cls_rule
*, const uint8_t[6]);
126 void cls_rule_set_arp_tha(struct cls_rule
*, const uint8_t[6]);
127 void cls_rule_set_ipv6_src(struct cls_rule
*, const struct in6_addr
*);
128 bool cls_rule_set_ipv6_src_masked(struct cls_rule
*, const struct in6_addr
*,
129 const struct in6_addr
*);
130 void cls_rule_set_ipv6_dst(struct cls_rule
*, const struct in6_addr
*);
131 bool cls_rule_set_ipv6_dst_masked(struct cls_rule
*, const struct in6_addr
*,
132 const struct in6_addr
*);
133 void cls_rule_set_ipv6_label(struct cls_rule
*, ovs_be32
);
134 void cls_rule_set_nd_target(struct cls_rule
*, const struct in6_addr
*);
136 bool cls_rule_equal(const struct cls_rule
*, const struct cls_rule
*);
137 uint32_t cls_rule_hash(const struct cls_rule
*, uint32_t basis
);
139 void cls_rule_format(const struct cls_rule
*, struct ds
*);
140 char *cls_rule_to_string(const struct cls_rule
*);
141 void cls_rule_print(const struct cls_rule
*);
143 void classifier_init(struct classifier
*);
144 void classifier_destroy(struct classifier
*);
145 bool classifier_is_empty(const struct classifier
*);
146 int classifier_count(const struct classifier
*);
147 void classifier_insert(struct classifier
*, struct cls_rule
*);
148 struct cls_rule
*classifier_replace(struct classifier
*, struct cls_rule
*);
149 void classifier_remove(struct classifier
*, struct cls_rule
*);
150 struct cls_rule
*classifier_lookup(const struct classifier
*,
151 const struct flow
*);
152 bool classifier_rule_overlaps(const struct classifier
*,
153 const struct cls_rule
*);
155 typedef void cls_cb_func(struct cls_rule
*, void *aux
);
157 struct cls_rule
*classifier_find_rule_exactly(const struct classifier
*,
158 const struct cls_rule
*);
163 const struct classifier
*cls
;
164 const struct cls_table
*table
;
165 const struct cls_rule
*target
;
168 void cls_cursor_init(struct cls_cursor
*, const struct classifier
*,
169 const struct cls_rule
*match
);
170 struct cls_rule
*cls_cursor_first(struct cls_cursor
*);
171 struct cls_rule
*cls_cursor_next(struct cls_cursor
*, struct cls_rule
*);
173 #define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR) \
174 for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
175 &(RULE)->MEMBER != NULL; \
176 ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
179 #define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR) \
180 for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \
181 (&(RULE)->MEMBER != NULL \
182 ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \
191 #endif /* classifier.h */