classifier: Allow CLS_CURSOR_FOR_EACH to use a const-qualified iterator.
[cascardo/ovs.git] / lib / classifier.c
index 5ab8ba9..36eb1f0 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * 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.
@@ -25,6 +25,7 @@
 #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 minimask *);
@@ -33,11 +34,19 @@ static struct cls_table *insert_table(struct classifier *,
 
 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 miniflow *, uint32_t hash);
-static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
+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)                               \
@@ -80,7 +89,7 @@ cls_rule_init_from_minimatch(struct cls_rule *rule,
 
 /* 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)
 {
@@ -88,6 +97,16 @@ cls_rule_clone(struct cls_rule *dst, const struct cls_rule *src)
     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
  * normally embedded into a larger structure).
  *
@@ -135,6 +154,7 @@ classifier_init(struct classifier *cls)
     cls->n_rules = 0;
     hmap_init(&cls->tables);
     list_init(&cls->tables_priority);
+    ovs_rwlock_init(&cls->rwlock);
 }
 
 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
@@ -149,6 +169,7 @@ classifier_destroy(struct classifier *cls)
             destroy_table(cls, table);
         }
         hmap_destroy(&cls->tables);
+        ovs_rwlock_destroy(&cls->rwlock);
     }
 }
 
@@ -166,52 +187,6 @@ classifier_count(const struct classifier *cls)
     return cls->n_rules;
 }
 
-static void
-classifier_update_table_max_priority(struct classifier *cls,
-                                     struct cls_table *table,
-                                     unsigned int priority)
-{
-    struct cls_table *iter = table;
-
-    if (priority > table->max_priority) {
-        /* 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). */
-        LIST_FOR_EACH_REVERSE_CONTINUE (iter, list_node,
-                                        &cls->tables_priority) {
-            if (iter->max_priority >= 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);
-        }
-    } else if (priority < table->max_priority) {
-        /* Possibly move 'table' earlier 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). */
-        LIST_FOR_EACH_CONTINUE (iter, list_node, &cls->tables_priority) {
-            if (iter->max_priority <= 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);
-        }
-    }
-    table->max_priority = priority;
-}
-
 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
  * must not modify or free it.
  *
@@ -236,16 +211,7 @@ classifier_replace(struct classifier *cls, struct cls_rule *rule)
         table = insert_table(cls, &rule->match.mask);
     }
 
-    old_rule = insert_rule(table, rule);
-
-    if (rule->priority > table->max_priority) {
-        classifier_update_table_max_priority(cls, table, rule->priority);
-        table->max_count = 1;
-    } else if (!old_rule && rule->priority == table->max_priority) {
-        /* Only if we are not replacing an old entry. */
-        ++table->max_count;
-    }
-
+    old_rule = insert_rule(cls, table, rule);
     if (!old_rule) {
         table->n_table_rules++;
         cls->n_rules++;
@@ -291,29 +257,23 @@ classifier_remove(struct classifier *cls, struct cls_rule *rule)
 
     if (--table->n_table_rules == 0) {
         destroy_table(cls, table);
-    } else if (rule->priority == table->max_priority
-               && --table->max_count == 0) {
-        /* Maintain table's max_priority. */
-        struct cls_rule *head;
-        unsigned int new_max_priority = 0;
-        HMAP_FOR_EACH (head, hmap_node, &table->rules) {
-            if (head->priority > new_max_priority) {
-                new_max_priority = head->priority;
-                table->max_count = 1;
-            } else if (head->priority == new_max_priority) {
-                ++table->max_count;
-            }
-        }
-        classifier_update_table_max_priority(cls, table, new_max_priority);
+    } 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)
 {
     struct cls_table *table;
     struct cls_rule *best;
@@ -321,6 +281,10 @@ classifier_lookup(const struct classifier *cls, const struct flow *flow)
     best = NULL;
     LIST_FOR_EACH (table, list_node, &cls->tables_priority) {
         struct cls_rule *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) {
@@ -330,6 +294,9 @@ classifier_lookup(const struct classifier *cls, const struct flow *flow)
                     return best;
                 }
                 rule = find_match(table, flow);
+                if (wc) {
+                    flow_wildcards_fold_minimask(wc, &table->mask);
+                }
                 if (rule && rule->priority > best->priority) {
                     best = rule;
                 }
@@ -533,8 +500,9 @@ cls_cursor_first(struct cls_cursor *cursor)
 /* 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;
 
@@ -603,6 +571,96 @@ destroy_table(struct classifier *cls, struct cls_table *table)
     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)
 {
@@ -633,9 +691,11 @@ find_equal(struct cls_table *table, const struct miniflow *flow, uint32_t hash)
 }
 
 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 = miniflow_hash_in_minimask(&new->match.flow,
                                                     &new->match.mask, 0);
@@ -644,7 +704,7 @@ insert_rule(struct cls_table *table, struct cls_rule *new)
     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. */
@@ -659,18 +719,24 @@ insert_rule(struct cls_table *table, struct cls_rule *new)
 
                 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 *