X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fclassifier.h;h=3f89196f94c578acc6829183caa02c9aba9e39f1;hb=b0fb94a346e52f36aeef238dd5f9bef9a10c14ef;hp=7b347e7b992ef122b4c51a43b97b789c9b8c222d;hpb=8368c090cab8b604818cc3db321f1ed8531f27a4;p=sliver-openvswitch.git diff --git a/lib/classifier.h b/lib/classifier.h index 7b347e7b9..3f89196f9 100644 --- a/lib/classifier.h +++ b/lib/classifier.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, 2011 Nicira Networks. + * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,105 +24,109 @@ * 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" + +#ifdef __cplusplus +extern "C" { +#endif /* A flow classifier. */ struct classifier { 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 set of rules that all have the same fields wildcarded. */ struct cls_table { - struct hmap_node hmap_node; /* Within struct classifier 'wctables'. */ + 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 flow_wildcards wc; /* Wildcards for fields. */ + 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 one of the cls_rule_*() functions to initialize a cls_rule. - * - * The cls_rule_*() functions below maintain the following important - * invariant that the classifier depends on: - * - * - If a bit or a field is wildcarded in 'wc', then the corresponding bit or - * field in 'flow' is set to all-0-bits. (The - * cls_rule_zero_wildcarded_fields() function can be used to restore this - * invariant after adding wildcards.) - */ +/* 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 { struct hmap_node hmap_node; /* Within struct cls_table 'rules'. */ struct list list; /* List of identical, lower-priority rules. */ - struct flow flow; /* All field values. */ - struct flow_wildcards wc; /* Wildcards for fields. */ + struct minimatch match; /* Matching rule. */ unsigned int priority; /* Larger numbers are higher priorities. */ }; -void cls_rule_init(const struct flow *, const struct flow_wildcards *, - unsigned int priority, struct cls_rule *); -void cls_rule_init_exact(const struct flow *, unsigned int priority, - struct cls_rule *); -void cls_rule_init_catchall(struct cls_rule *, unsigned int priority); - -void cls_rule_zero_wildcarded_fields(struct cls_rule *); - -void cls_rule_set_reg(struct cls_rule *, unsigned int reg_idx, uint32_t value); -void cls_rule_set_reg_masked(struct cls_rule *, unsigned int reg_idx, - uint32_t value, uint32_t mask); -void cls_rule_set_tun_id(struct cls_rule *, ovs_be64 tun_id); -void cls_rule_set_tun_id_masked(struct cls_rule *, - ovs_be64 tun_id, ovs_be64 mask); -void cls_rule_set_in_port(struct cls_rule *, uint16_t odp_port); -void cls_rule_set_dl_type(struct cls_rule *, ovs_be16); -void cls_rule_set_dl_src(struct cls_rule *, const uint8_t[6]); -void cls_rule_set_dl_dst(struct cls_rule *, const uint8_t[6]); -void cls_rule_set_dl_tci(struct cls_rule *, ovs_be16 tci); -void cls_rule_set_dl_tci_masked(struct cls_rule *, - ovs_be16 tci, ovs_be16 mask); -void cls_rule_set_any_vid(struct cls_rule *); -void cls_rule_set_dl_vlan(struct cls_rule *, ovs_be16); -void cls_rule_set_any_pcp(struct cls_rule *); -void cls_rule_set_dl_vlan_pcp(struct cls_rule *, uint8_t); -void cls_rule_set_tp_src(struct cls_rule *, ovs_be16); -void cls_rule_set_tp_dst(struct cls_rule *, ovs_be16); -void cls_rule_set_nw_proto(struct cls_rule *, uint8_t); -void cls_rule_set_nw_src(struct cls_rule *, ovs_be32); -bool cls_rule_set_nw_src_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask); -void cls_rule_set_nw_dst(struct cls_rule *, ovs_be32); -bool cls_rule_set_nw_dst_masked(struct cls_rule *, ovs_be32 ip, ovs_be32 mask); -void cls_rule_set_nw_tos(struct cls_rule *, uint8_t); -void cls_rule_set_icmp_type(struct cls_rule *, uint8_t); -void cls_rule_set_icmp_code(struct cls_rule *, uint8_t); +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 *); -char *cls_rule_to_string(const struct cls_rule *); -void cls_rule_print(const struct cls_rule *); -void classifier_init(struct classifier *); +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 *); -struct cls_rule *classifier_insert(struct classifier *, struct cls_rule *); -void classifier_remove(struct classifier *, struct cls_rule *); -struct cls_rule *classifier_lookup(const struct classifier *, - const struct flow *); -bool classifier_rule_overlaps(const struct classifier *, - const struct cls_rule *); +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); -struct cls_rule *classifier_find_rule_exactly(const struct classifier *, - const struct cls_rule *); +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. */ @@ -132,23 +136,27 @@ struct cls_cursor { const struct cls_rule *target; }; -void cls_cursor_init(struct cls_cursor *, const struct classifier *, - const struct cls_rule *match); -struct cls_rule *cls_cursor_first(struct cls_cursor *); -struct cls_rule *cls_cursor_next(struct cls_cursor *, struct cls_rule *); +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)->MEMBER != NULL; \ + 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)->MEMBER != NULL \ + (RULE != OBJECT_CONTAINING(NULL, RULE, MEMBER) \ ? ASSIGN_CONTAINER(NEXT, cls_cursor_next(CURSOR, &(RULE)->MEMBER), \ - MEMBER) \ + MEMBER), 1 \ : 0); \ (RULE) = (NEXT)) +#ifdef __cplusplus +} +#endif + #endif /* classifier.h */