X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fclassifier.h;h=3f89196f94c578acc6829183caa02c9aba9e39f1;hb=b0fb94a346e52f36aeef238dd5f9bef9a10c14ef;hp=a632fb02452b7b71459e3ddd277a8d9d04d8833f;hpb=064af42167bf4fc9aaea2702d80ce08074b889c0;p=sliver-openvswitch.git diff --git a/lib/classifier.h b/lib/classifier.h index a632fb024..3f89196f9 100644 --- a/lib/classifier.h +++ b/lib/classifier.h @@ -1,17 +1,17 @@ /* - * Copyright (c) 2009 Nicira Networks. + * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc. * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ #ifndef CLASSIFIER_H @@ -19,131 +19,144 @@ /* Flow classifier. * - * This flow classifier assumes that we can arrange the fields in a flow in an - * order such that the set of wildcarded fields in a rule tend to fall toward - * the end of the ordering. That is, if field F is wildcarded, then all the - * fields after F tend to be wildcarded as well. If this assumption is - * violated, then the classifier will still classify flows correctly, but its - * performance will suffer. - */ + * A classifier is a "struct classifier", + * a hash map from a set of wildcards to a "struct cls_table", + * a hash map from fixed field values to "struct cls_rule", + * which can contain a list of otherwise identical rules + * with lower priorities. + * + * Thread-safety + * ============= + * + * When locked properly, the classifier is thread safe as long as the following + * conditions are satisfied. + * - Only the main thread calls functions requiring a write lock. + * - Only the main thread is allowed to iterate over rules. */ #include "flow.h" #include "hmap.h" #include "list.h" +#include "match.h" +#include "openflow/nicira-ext.h" #include "openflow/openflow.h" +#include "ovs-thread.h" +#include "util.h" -/* Number of bytes of fields in a rule. */ -#define CLS_N_BYTES 31 - -/* Fields in a rule. - * - * This definition sets the ordering of fields, which is important for - * performance (see above). To adjust the ordering, change the order of the - * lines. */ -#define CLS_FIELDS \ - /* flow_t all-caps */ \ - /* wildcard bit(s) member name name */ \ - /* ----------------- ----------- -------- */ \ - CLS_FIELD(OFPFW_IN_PORT, in_port, IN_PORT) \ - CLS_FIELD(OFPFW_DL_VLAN, dl_vlan, DL_VLAN) \ - CLS_FIELD(OFPFW_DL_SRC, dl_src, DL_SRC) \ - CLS_FIELD(OFPFW_DL_DST, dl_dst, DL_DST) \ - CLS_FIELD(OFPFW_DL_TYPE, dl_type, DL_TYPE) \ - CLS_FIELD(OFPFW_NW_SRC_MASK, nw_src, NW_SRC) \ - CLS_FIELD(OFPFW_NW_DST_MASK, nw_dst, NW_DST) \ - CLS_FIELD(OFPFW_NW_PROTO, nw_proto, NW_PROTO) \ - CLS_FIELD(OFPFW_TP_SRC, tp_src, TP_SRC) \ - CLS_FIELD(OFPFW_TP_DST, tp_dst, TP_DST) - -/* Field indexes. - * - * (These are also indexed into struct classifier's 'tables' array.) */ -enum { -#define CLS_FIELD(WILDCARDS, MEMBER, NAME) CLS_F_IDX_##NAME, - CLS_FIELDS -#undef CLS_FIELD - CLS_F_IDX_EXACT, /* Exact-match table. */ - CLS_N_FIELDS = CLS_F_IDX_EXACT -}; - -/* Field information. */ -struct cls_field { - int ofs; /* Offset in flow_t. */ - int len; /* Length in bytes. */ - uint32_t wildcards; /* OFPFW_* bit or bits for this field. */ - const char *name; /* Name (for debugging). */ -}; -extern const struct cls_field cls_fields[CLS_N_FIELDS + 1]; +#ifdef __cplusplus +extern "C" { +#endif /* A flow classifier. */ struct classifier { - int n_rules; /* Sum of hmap_count() over tables[]. */ - struct hmap tables[CLS_N_FIELDS]; /* Contain cls_bucket elements. */ - struct hmap exact_table; /* Contain cls_rule elements. */ + int n_rules; /* Total number of rules. */ + struct hmap tables; /* Contains "struct cls_table"s. */ + struct list tables_priority; /* Tables in descending priority order */ + struct ovs_rwlock rwlock; }; -/* A group of rules with the same fixed values for initial fields. */ -struct cls_bucket { - struct hmap_node hmap_node; /* Within struct classifier 'tables'. */ - struct list rules; /* In order from highest to lowest priority. */ - flow_t fixed; /* Values for fixed fields. */ +/* A set of rules that all have the same fields wildcarded. */ +struct cls_table { + struct hmap_node hmap_node; /* Within struct classifier 'tables' hmap. */ + struct list list_node; /* Within classifier 'tables_priority_list' */ + struct hmap rules; /* Contains "struct cls_rule"s. */ + struct minimask mask; /* Wildcards for fields. */ + int n_table_rules; /* Number of rules, including duplicates. */ + unsigned int max_priority; /* Max priority of any rule in the table. */ + unsigned int max_count; /* Count of max_priority rules. */ }; -/* A flow classification rule. - * - * Use cls_rule_from_flow() or cls_rule_from_match() to initialize a cls_rule - * or you will almost certainly not initialize 'table_idx' correctly, with - * disastrous results! */ +/* Returns true if 'table' is a "catch-all" table that will match every + * packet (if there is no higher-priority match). */ +static inline bool +cls_table_is_catchall(const struct cls_table *table) +{ + return minimask_is_catchall(&table->mask); +} + +/* A rule in a "struct classifier". */ struct cls_rule { - union { - struct list list; /* Within struct cls_bucket 'rules'. */ - struct hmap_node hmap; /* Within struct classifier 'exact_table'. */ - } node; - flow_t flow; /* All field values. */ - struct flow_wildcards wc; /* Wildcards for fields. */ + struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */ + struct list list; /* List of identical, lower-priority rules. */ + struct minimatch match; /* Matching rule. */ unsigned int priority; /* Larger numbers are higher priorities. */ - unsigned int table_idx; /* Index into struct classifier 'tables'. */ }; -void cls_rule_from_flow(struct cls_rule *, const flow_t *, uint32_t wildcards, - unsigned int priority); -void cls_rule_from_match(struct cls_rule *, const struct ofp_match *, - unsigned int priority); -void cls_rule_print(const struct cls_rule *); -void cls_rule_moved(struct classifier *, - struct cls_rule *old, struct cls_rule *new); -void cls_rule_replace(struct classifier *, const struct cls_rule *old, - struct cls_rule *new); - -void classifier_init(struct classifier *); +void cls_rule_init(struct cls_rule *, const struct match *, + unsigned int priority); +void cls_rule_init_from_minimatch(struct cls_rule *, const struct minimatch *, + unsigned int priority); +void cls_rule_clone(struct cls_rule *, const struct cls_rule *); +void cls_rule_destroy(struct cls_rule *); + +bool cls_rule_equal(const struct cls_rule *, const struct cls_rule *); +uint32_t cls_rule_hash(const struct cls_rule *, uint32_t basis); + +void cls_rule_format(const struct cls_rule *, struct ds *); + +bool cls_rule_is_catchall(const struct cls_rule *); + +bool cls_rule_is_loose_match(const struct cls_rule *rule, + const struct minimatch *criteria); + +void classifier_init(struct classifier *cls); void classifier_destroy(struct classifier *); -bool classifier_is_empty(const struct classifier *); -int classifier_count(const struct classifier *); -int classifier_count_exact(const struct classifier *); -struct cls_rule *classifier_insert(struct classifier *, struct cls_rule *); -void classifier_insert_exact(struct classifier *, struct cls_rule *); -void classifier_remove(struct classifier *, struct cls_rule *); -struct cls_rule *classifier_lookup(const struct classifier *, const flow_t *); -struct cls_rule *classifier_lookup_wild(const struct classifier *, - const flow_t *); -struct cls_rule *classifier_lookup_exact(const struct classifier *, - const flow_t *); +bool classifier_is_empty(const struct classifier *cls) + OVS_REQ_RDLOCK(cls->rwlock); +int classifier_count(const struct classifier *cls) + OVS_REQ_RDLOCK(cls->rwlock); +void classifier_insert(struct classifier *cls, struct cls_rule *) + OVS_REQ_WRLOCK(cls->rwlock); +struct cls_rule *classifier_replace(struct classifier *cls, struct cls_rule *) + OVS_REQ_WRLOCK(cls->rwlock); +void classifier_remove(struct classifier *cls, struct cls_rule *) + OVS_REQ_WRLOCK(cls->rwlock); +struct cls_rule *classifier_lookup(const struct classifier *cls, + const struct flow *, + struct flow_wildcards *) + OVS_REQ_RDLOCK(cls->rwlock); +bool classifier_rule_overlaps(const struct classifier *cls, + const struct cls_rule *) + OVS_REQ_RDLOCK(cls->rwlock); typedef void cls_cb_func(struct cls_rule *, void *aux); -enum { - CLS_INC_EXACT = 1 << 0, /* Include exact-match flows? */ - CLS_INC_WILD = 1 << 1, /* Include flows with wildcards? */ - CLS_INC_ALL = CLS_INC_EXACT | CLS_INC_WILD +struct cls_rule *classifier_find_rule_exactly(const struct classifier *cls, + const struct cls_rule *) + OVS_REQ_RDLOCK(cls->rwlock); +struct cls_rule *classifier_find_match_exactly(const struct classifier *cls, + const struct match *, + unsigned int priority) + OVS_REQ_RDLOCK(cls->rwlock); + +/* Iteration. */ + +struct cls_cursor { + const struct classifier *cls; + const struct cls_table *table; + const struct cls_rule *target; }; -void classifier_for_each(const struct classifier *, int include, - cls_cb_func *, void *aux); -void classifier_for_each_match(const struct classifier *, - const struct cls_rule *, - int include, cls_cb_func *, void *aux); -struct cls_rule *classifier_find_rule_exactly(const struct classifier *, - const flow_t *target, - uint32_t wildcards, - unsigned int priority); + +void cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls, + const struct cls_rule *match) OVS_REQ_RDLOCK(cls->rwlock); +struct cls_rule *cls_cursor_first(struct cls_cursor *cursor); +struct cls_rule *cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *); + +#define CLS_CURSOR_FOR_EACH(RULE, MEMBER, CURSOR) \ + for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \ + RULE != OBJECT_CONTAINING(NULL, RULE, MEMBER); \ + ASSIGN_CONTAINER(RULE, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \ + MEMBER)) + +#define CLS_CURSOR_FOR_EACH_SAFE(RULE, NEXT, MEMBER, CURSOR) \ + for (ASSIGN_CONTAINER(RULE, cls_cursor_first(CURSOR), MEMBER); \ + (RULE != OBJECT_CONTAINING(NULL, RULE, MEMBER) \ + ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \ + MEMBER), 1 \ + : 0); \ + (RULE) = (NEXT)) + +#ifdef __cplusplus +} +#endif #endif /* classifier.h */