/*
- * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
+ * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <config.h>
#include "classifier.h"
-#include <assert.h>
#include <errno.h>
#include <netinet/in.h>
#include "byte-order.h"
#include "odp-util.h"
#include "ofp-util.h"
#include "packets.h"
+#include "ovs-thread.h"
static struct cls_table *find_table(const struct classifier *,
- const struct flow_wildcards *);
+ const struct minimask *);
static struct cls_table *insert_table(struct classifier *,
- const struct flow_wildcards *);
+ const struct minimask *);
static void destroy_table(struct classifier *, struct cls_table *);
+static void update_tables_after_insertion(struct classifier *,
+ struct cls_table *,
+ unsigned int new_priority);
+static void update_tables_after_removal(struct classifier *,
+ struct cls_table *,
+ unsigned int del_priority);
+
static struct cls_rule *find_match(const struct cls_table *,
const struct flow *);
-static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
- uint32_t hash);
-static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
+static struct cls_rule *find_equal(struct cls_table *,
+ const struct miniflow *, uint32_t hash);
+static struct cls_rule *insert_rule(struct classifier *,
+ struct cls_table *, struct cls_rule *);
/* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
#define FOR_EACH_RULE_IN_LIST(RULE, HEAD) \
/* cls_rule. */
/* Initializes 'rule' to match packets specified by 'match' at the given
- * 'priority'.
+ * 'priority'. 'match' must satisfy the invariant described in the comment at
+ * the definition of struct match.
*
* The caller must eventually destroy 'rule' with cls_rule_destroy().
*
- * 'match' must satisfy the invariant described in the comment at the
- * definition of struct match.
- *
* (OpenFlow uses priorities between 0 and UINT16_MAX, inclusive, but
* internally Open vSwitch supports a wider range.) */
void
cls_rule_init(struct cls_rule *rule,
const struct match *match, unsigned int priority)
{
- rule->match = *match;
+ minimatch_init(&rule->match, match);
+ rule->priority = priority;
+}
+
+/* Same as cls_rule_init() for initialization from a "struct minimatch". */
+void
+cls_rule_init_from_minimatch(struct cls_rule *rule,
+ const struct minimatch *match,
+ unsigned int priority)
+{
+ minimatch_clone(&rule->match, match);
rule->priority = priority;
}
/* Initializes 'dst' as a copy of 'src'.
*
- * The caller must eventually destroy 'rule' with cls_rule_destroy(). */
+ * The caller must eventually destroy 'dst' with cls_rule_destroy(). */
void
cls_rule_clone(struct cls_rule *dst, const struct cls_rule *src)
{
- *dst = *src;
+ minimatch_clone(&dst->match, &src->match);
+ dst->priority = src->priority;
+}
+
+/* Initializes 'dst' with the data in 'src', destroying 'src'.
+ *
+ * The caller must eventually destroy 'dst' with cls_rule_destroy(). */
+void
+cls_rule_move(struct cls_rule *dst, struct cls_rule *src)
+{
+ minimatch_move(&dst->match, &src->match);
+ dst->priority = src->priority;
}
/* Frees memory referenced by 'rule'. Doesn't free 'rule' itself (it's
*
* ('rule' must not currently be in a classifier.) */
void
-cls_rule_destroy(struct cls_rule *rule OVS_UNUSED)
+cls_rule_destroy(struct cls_rule *rule)
{
- /* Nothing to do yet. */
+ minimatch_destroy(&rule->match);
}
/* Returns true if 'a' and 'b' match the same packets at the same priority,
bool
cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
{
- return a->priority == b->priority && match_equal(&a->match, &b->match);
+ return a->priority == b->priority && minimatch_equal(&a->match, &b->match);
}
/* Returns a hash value for 'rule', folding in 'basis'. */
uint32_t
cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
{
- return match_hash(&rule->match, hash_int(rule->priority, basis));
+ return minimatch_hash(&rule->match, hash_int(rule->priority, basis));
}
/* Appends a string describing 'rule' to 's'. */
void
cls_rule_format(const struct cls_rule *rule, struct ds *s)
{
- match_format(&rule->match, s, rule->priority);
+ minimatch_format(&rule->match, s, rule->priority);
}
/* Returns true if 'rule' matches every packet, false otherwise. */
bool
cls_rule_is_catchall(const struct cls_rule *rule)
{
- return flow_wildcards_is_catchall(&rule->match.wc);
+ return minimask_is_catchall(&rule->match.mask);
}
\f
/* Initializes 'cls' as a classifier that initially contains no classification
{
cls->n_rules = 0;
hmap_init(&cls->tables);
+ list_init(&cls->tables_priority);
+ hmap_init(&cls->partitions);
+ ovs_rwlock_init(&cls->rwlock);
}
/* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
classifier_destroy(struct classifier *cls)
{
if (cls) {
+ struct cls_table *partition, *next_partition;
struct cls_table *table, *next_table;
HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
- hmap_destroy(&table->rules);
- hmap_remove(&cls->tables, &table->hmap_node);
- free(table);
+ destroy_table(cls, table);
}
hmap_destroy(&cls->tables);
+
+ HMAP_FOR_EACH_SAFE (partition, next_partition, hmap_node,
+ &cls->partitions) {
+ hmap_remove(&cls->partitions, &partition->hmap_node);
+ free(partition);
+ }
+ hmap_destroy(&cls->partitions);
+ ovs_rwlock_destroy(&cls->rwlock);
}
}
return cls->n_rules;
}
+static uint32_t
+hash_metadata(ovs_be64 metadata_)
+{
+ uint64_t metadata = (OVS_FORCE uint64_t) metadata_;
+ return hash_2words(metadata, metadata >> 32);
+}
+
+static struct cls_partition *
+find_partition(const struct classifier *cls, ovs_be64 metadata, uint32_t hash)
+{
+ struct cls_partition *partition;
+
+ HMAP_FOR_EACH_IN_BUCKET (partition, hmap_node, hash, &cls->partitions) {
+ if (partition->metadata == metadata) {
+ return partition;
+ }
+ }
+
+ return NULL;
+}
+
+static struct cls_partition *
+create_partition(struct classifier *cls, struct cls_table *table,
+ ovs_be64 metadata)
+{
+ uint32_t hash = hash_metadata(metadata);
+ struct cls_partition *partition = find_partition(cls, metadata, hash);
+ if (!partition) {
+ partition = xmalloc(sizeof *partition);
+ partition->metadata = metadata;
+ partition->tags = 0;
+ tag_tracker_init(&partition->tracker);
+ hmap_insert(&cls->partitions, &partition->hmap_node, hash);
+ }
+ tag_tracker_add(&partition->tracker, &partition->tags, table->tag);
+ return partition;
+}
+
/* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
* must not modify or free it.
*
struct cls_rule *old_rule;
struct cls_table *table;
- table = find_table(cls, &rule->match.wc);
+ table = find_table(cls, &rule->match.mask);
if (!table) {
- table = insert_table(cls, &rule->match.wc);
+ table = insert_table(cls, &rule->match.mask);
}
- old_rule = insert_rule(table, rule);
+ old_rule = insert_rule(cls, table, rule);
if (!old_rule) {
+ if (minimask_get_metadata_mask(&rule->match.mask) == OVS_BE64_MAX) {
+ ovs_be64 metadata = miniflow_get_metadata(&rule->match.flow);
+ rule->partition = create_partition(cls, table, metadata);
+ } else {
+ rule->partition = NULL;
+ }
+
table->n_table_rules++;
cls->n_rules++;
+ } else {
+ rule->partition = old_rule->partition;
}
return old_rule;
}
classifier_insert(struct classifier *cls, struct cls_rule *rule)
{
struct cls_rule *displaced_rule = classifier_replace(cls, rule);
- assert(!displaced_rule);
+ ovs_assert(!displaced_rule);
}
/* Removes 'rule' from 'cls'. It is the caller's responsibility to destroy
void
classifier_remove(struct classifier *cls, struct cls_rule *rule)
{
+ struct cls_partition *partition;
struct cls_rule *head;
struct cls_table *table;
- table = find_table(cls, &rule->match.wc);
+ table = find_table(cls, &rule->match.mask);
head = find_equal(table, &rule->match.flow, rule->hmap_node.hash);
if (head != rule) {
list_remove(&rule->list);
hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
}
+ partition = rule->partition;
+ if (partition) {
+ tag_tracker_subtract(&partition->tracker, &partition->tags,
+ table->tag);
+ if (!partition->tags) {
+ hmap_remove(&cls->partitions, &partition->hmap_node);
+ free(partition);
+ }
+ }
+
if (--table->n_table_rules == 0) {
destroy_table(cls, table);
+ } else {
+ update_tables_after_removal(cls, table, rule->priority);
}
-
cls->n_rules--;
}
/* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
* Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
- * of equal priority match 'flow', returns one arbitrarily. */
+ * of equal priority match 'flow', returns one arbitrarily.
+ *
+ * If a rule is found and 'wc' is non-null, bitwise-OR's 'wc' with the
+ * set of bits that were significant in the lookup. At some point
+ * earlier, 'wc' should have been initialized (e.g., by
+ * flow_wildcards_init_catchall()). */
struct cls_rule *
-classifier_lookup(const struct classifier *cls, const struct flow *flow)
+classifier_lookup(const struct classifier *cls, const struct flow *flow,
+ struct flow_wildcards *wc)
{
+ const struct cls_partition *partition;
struct cls_table *table;
struct cls_rule *best;
+ tag_type tags;
+
+ /* Determine 'tags' such that, if 'table->tag' doesn't intersect them, then
+ * 'flow' cannot possibly match in 'table':
+ *
+ * - If flow->metadata maps to a given 'partition', then we can use
+ * 'tags' for 'partition->tags'.
+ *
+ * - If flow->metadata has no partition, then no rule in 'cls' has an
+ * exact-match for flow->metadata. That means that we don't need to
+ * search any table that includes flow->metadata in its mask.
+ *
+ * In either case, we always need to search any cls_tables that do not
+ * include flow->metadata in its mask. One way to do that would be to
+ * check the "cls_table"s explicitly for that, but that would require an
+ * extra branch per table. Instead, we mark such a cls_table's 'tags' as
+ * TAG_ALL and make sure that 'tags' is never empty. This means that
+ * 'tags' always intersects such a cls_table's 'tags', so we don't need a
+ * special case.
+ */
+ partition = (hmap_is_empty(&cls->partitions)
+ ? NULL
+ : find_partition(cls, flow->metadata,
+ hash_metadata(flow->metadata)));
+ tags = partition ? partition->tags : TAG_ARBITRARY;
best = NULL;
- HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
- struct cls_rule *rule = find_match(table, flow);
- if (rule && (!best || rule->priority > best->priority)) {
+ LIST_FOR_EACH (table, list_node, &cls->tables_priority) {
+ struct cls_rule *rule;
+
+ if (!tag_intersects(tags, table->tag)) {
+ continue;
+ }
+
+ rule = find_match(table, flow);
+ if (wc) {
+ flow_wildcards_fold_minimask(wc, &table->mask);
+ }
+ if (rule) {
best = rule;
+ LIST_FOR_EACH_CONTINUE (table, list_node, &cls->tables_priority) {
+ if (table->max_priority <= best->priority) {
+ /* Tables in descending priority order,
+ * can not find anything better. */
+ return best;
+ }
+ if (!tag_intersects(tags, table->tag)) {
+ continue;
+ }
+
+ rule = find_match(table, flow);
+ if (wc) {
+ flow_wildcards_fold_minimask(wc, &table->mask);
+ }
+ if (rule && rule->priority > best->priority) {
+ best = rule;
+ }
+ }
+ break;
}
}
return best;
struct cls_rule *head, *rule;
struct cls_table *table;
- table = find_table(cls, &target->match.wc);
+ table = find_table(cls, &target->match.mask);
if (!table) {
return NULL;
}
+ /* Skip if there is no hope. */
+ if (target->priority > table->max_priority) {
+ return NULL;
+ }
+
head = find_equal(table, &target->match.flow,
- flow_hash(&target->match.flow, 0));
+ miniflow_hash_in_minimask(&target->match.flow,
+ &target->match.mask, 0));
FOR_EACH_RULE_IN_LIST (rule, head) {
if (target->priority >= rule->priority) {
return target->priority == rule->priority ? rule : NULL;
{
struct cls_table *table;
- HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
- struct flow_wildcards wc;
+ /* Iterate tables in the descending max priority order. */
+ LIST_FOR_EACH (table, list_node, &cls->tables_priority) {
+ uint32_t storage[FLOW_U32S];
+ struct minimask mask;
struct cls_rule *head;
- flow_wildcards_combine(&wc, &target->match.wc, &table->wc);
+ if (target->priority > table->max_priority) {
+ break; /* Can skip this and the rest of the tables. */
+ }
+
+ minimask_combine(&mask, &target->match.mask, &table->mask, storage);
HMAP_FOR_EACH (head, hmap_node, &table->rules) {
struct cls_rule *rule;
FOR_EACH_RULE_IN_LIST (rule, head) {
+ if (rule->priority < target->priority) {
+ break; /* Rules in descending priority order. */
+ }
if (rule->priority == target->priority
- && flow_equal_except(&target->match.flow,
- &rule->match.flow, &wc)) {
+ && miniflow_equal_in_minimask(&target->match.flow,
+ &rule->match.flow, &mask)) {
return true;
}
}
* Ignores rule->priority. */
bool
cls_rule_is_loose_match(const struct cls_rule *rule,
- const struct match *criteria)
+ const struct minimatch *criteria)
{
- return (!flow_wildcards_has_extra(&rule->match.wc, &criteria->wc)
- && flow_equal_except(&rule->match.flow, &criteria->flow,
- &criteria->wc));
+ return (!minimask_has_extra(&rule->match.mask, &criteria->mask)
+ && miniflow_equal_in_minimask(&rule->match.flow, &criteria->flow,
+ &criteria->mask));
}
\f
/* Iteration. */
rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
{
return (!target
- || flow_equal_except(&rule->match.flow, &target->match.flow,
- &target->match.wc));
+ || miniflow_equal_in_minimask(&rule->match.flow,
+ &target->match.flow,
+ &target->match.mask));
}
static struct cls_rule *
search_table(const struct cls_table *table, const struct cls_rule *target)
{
- if (!target || !flow_wildcards_has_extra(&table->wc, &target->match.wc)) {
+ if (!target || !minimask_has_extra(&table->mask, &target->match.mask)) {
struct cls_rule *rule;
HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
/* Returns the next matching cls_rule in 'cursor''s iteration, or a null
* pointer if there are no more matches. */
struct cls_rule *
-cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
+cls_cursor_next(struct cls_cursor *cursor, const struct cls_rule *rule_)
{
+ struct cls_rule *rule = CONST_CAST(struct cls_rule *, rule_);
const struct cls_table *table;
struct cls_rule *next;
}
\f
static struct cls_table *
-find_table(const struct classifier *cls, const struct flow_wildcards *wc)
+find_table(const struct classifier *cls, const struct minimask *mask)
{
struct cls_table *table;
- HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
+ HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, minimask_hash(mask, 0),
&cls->tables) {
- if (flow_wildcards_equal(wc, &table->wc)) {
+ if (minimask_equal(mask, &table->mask)) {
return table;
}
}
}
static struct cls_table *
-insert_table(struct classifier *cls, const struct flow_wildcards *wc)
+insert_table(struct classifier *cls, const struct minimask *mask)
{
+ uint32_t hash = minimask_hash(mask, 0);
struct cls_table *table;
table = xzalloc(sizeof *table);
hmap_init(&table->rules);
- table->wc = *wc;
- table->is_catchall = flow_wildcards_is_catchall(&table->wc);
- hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
+ minimask_clone(&table->mask, mask);
+ hmap_insert(&cls->tables, &table->hmap_node, minimask_hash(mask, 0));
+ list_push_back(&cls->tables_priority, &table->list_node);
+ table->tag = (minimask_get_metadata_mask(mask) == OVS_BE64_MAX
+ ? tag_create_deterministic(hash)
+ : TAG_ALL);
return table;
}
static void
destroy_table(struct classifier *cls, struct cls_table *table)
{
+ minimask_destroy(&table->mask);
hmap_remove(&cls->tables, &table->hmap_node);
hmap_destroy(&table->rules);
+ list_remove(&table->list_node);
free(table);
}
+/* This function performs the following updates for 'table' in 'cls' following
+ * the addition of a new rule with priority 'new_priority' to 'table':
+ *
+ * - Update 'table->max_priority' and 'table->max_count' if necessary.
+ *
+ * - Update 'table''s position in 'cls->tables_priority' if necessary.
+ *
+ * This function should only be called after adding a new rule, not after
+ * replacing a rule by an identical one or modifying a rule in-place. */
+static void
+update_tables_after_insertion(struct classifier *cls, struct cls_table *table,
+ unsigned int new_priority)
+{
+ if (new_priority == table->max_priority) {
+ ++table->max_count;
+ } else if (new_priority > table->max_priority) {
+ struct cls_table *iter;
+
+ table->max_priority = new_priority;
+ table->max_count = 1;
+
+ /* Possibly move 'table' earlier in the priority list. If we break out
+ * of the loop, then 'table' should be moved just after that 'iter'.
+ * If the loop terminates normally, then 'iter' will be the list head
+ * and we'll move table just after that (e.g. to the front of the
+ * list). */
+ iter = table;
+ LIST_FOR_EACH_REVERSE_CONTINUE (iter, list_node,
+ &cls->tables_priority) {
+ if (iter->max_priority >= table->max_priority) {
+ break;
+ }
+ }
+
+ /* Move 'table' just after 'iter' (unless it's already there). */
+ if (iter->list_node.next != &table->list_node) {
+ list_splice(iter->list_node.next,
+ &table->list_node, table->list_node.next);
+ }
+ }
+}
+
+/* This function performs the following updates for 'table' in 'cls' following
+ * the deletion of a rule with priority 'del_priority' from 'table':
+ *
+ * - Update 'table->max_priority' and 'table->max_count' if necessary.
+ *
+ * - Update 'table''s position in 'cls->tables_priority' if necessary.
+ *
+ * This function should only be called after removing a rule, not after
+ * replacing a rule by an identical one or modifying a rule in-place. */
+static void
+update_tables_after_removal(struct classifier *cls, struct cls_table *table,
+ unsigned int del_priority)
+{
+ struct cls_table *iter;
+
+ if (del_priority == table->max_priority && --table->max_count == 0) {
+ struct cls_rule *head;
+
+ table->max_priority = 0;
+ HMAP_FOR_EACH (head, hmap_node, &table->rules) {
+ if (head->priority > table->max_priority) {
+ table->max_priority = head->priority;
+ table->max_count = 1;
+ } else if (head->priority == table->max_priority) {
+ ++table->max_count;
+ }
+ }
+
+ /* Possibly move 'table' later in the priority list. If we break out
+ * of the loop, then 'table' should be moved just before that 'iter'.
+ * If the loop terminates normally, then 'iter' will be the list head
+ * and we'll move table just before that (e.g. to the back of the
+ * list). */
+ iter = table;
+ LIST_FOR_EACH_CONTINUE (iter, list_node, &cls->tables_priority) {
+ if (iter->max_priority <= table->max_priority) {
+ break;
+ }
+ }
+
+ /* Move 'table' just before 'iter' (unless it's already there). */
+ if (iter->list_node.prev != &table->list_node) {
+ list_splice(&iter->list_node,
+ &table->list_node, table->list_node.next);
+ }
+ }
+}
+
static struct cls_rule *
find_match(const struct cls_table *table, const struct flow *flow)
{
+ uint32_t hash = flow_hash_in_minimask(flow, &table->mask, 0);
struct cls_rule *rule;
- if (table->is_catchall) {
- HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
+ HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, hash, &table->rules) {
+ if (minimatch_matches_flow(&rule->match, flow)) {
return rule;
}
- } else {
- struct flow f;
-
- f = *flow;
- flow_zero_wildcards(&f, &table->wc);
- HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
- &table->rules) {
- if (flow_equal(&f, &rule->match.flow)) {
- return rule;
- }
- }
}
return NULL;
}
static struct cls_rule *
-find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
+find_equal(struct cls_table *table, const struct miniflow *flow, uint32_t hash)
{
struct cls_rule *head;
HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
- if (flow_equal(&head->match.flow, flow)) {
+ if (miniflow_equal(&head->match.flow, flow)) {
return head;
}
}
}
static struct cls_rule *
-insert_rule(struct cls_table *table, struct cls_rule *new)
+insert_rule(struct classifier *cls,
+ struct cls_table *table, struct cls_rule *new)
{
struct cls_rule *head;
+ struct cls_rule *old = NULL;
- new->hmap_node.hash = flow_hash(&new->match.flow, 0);
+ new->hmap_node.hash = miniflow_hash_in_minimask(&new->match.flow,
+ &new->match.mask, 0);
head = find_equal(table, &new->match.flow, new->hmap_node.hash);
if (!head) {
hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
list_init(&new->list);
- return NULL;
+ goto out;
} else {
/* Scan the list for the insertion point that will keep the list in
* order of decreasing priority. */
if (new->priority == rule->priority) {
list_replace(&new->list, &rule->list);
- return rule;
+ old = rule;
+ goto out;
} else {
list_insert(&rule->list, &new->list);
- return NULL;
+ goto out;
}
}
}
/* Insert 'new' at the end of the list. */
list_push_back(&head->list, &new->list);
- return NULL;
}
+
+ out:
+ if (!old) {
+ update_tables_after_insertion(cls, table, new->priority);
+ }
+ return old;
}
static struct cls_rule *