Simplify use of dp_mutex.
[openvswitch] / datapath / chain.c
1 /*
2  * Distributed under the terms of the GNU GPL version 2.
3  * Copyright (c) 2007, 2008 The Board of Trustees of The Leland 
4  * Stanford Junior University
5  */
6
7 #include "chain.h"
8 #include "flow.h"
9 #include "table.h"
10 #include <linux/module.h>
11 #include <linux/rcupdate.h>
12 #include <linux/slab.h>
13 #include <linux/spinlock.h>
14
15 static struct sw_table *(*create_hw_table_hook)(void);
16 static struct module *hw_table_owner;
17 static DEFINE_SPINLOCK(hook_lock);
18
19 /* Attempts to append 'table' to the set of tables in 'chain'.  Returns 0 or
20  * negative error.  If 'table' is null it is assumed that table creation failed
21  * due to out-of-memory. */
22 static int add_table(struct sw_chain *chain, struct sw_table *table)
23 {
24         if (table == NULL)
25                 return -ENOMEM;
26         if (chain->n_tables >= CHAIN_MAX_TABLES) {
27                 printk("too many tables in chain\n");
28                 table->destroy(table);
29                 return -ENOBUFS;
30         }
31         chain->tables[chain->n_tables++] = table;
32         return 0;
33 }
34
35 /* Creates and returns a new chain associated with 'dp'.  Returns NULL if the
36  * chain cannot be created. */
37 struct sw_chain *chain_create(struct datapath *dp)
38 {
39         struct sw_chain *chain = kzalloc(sizeof *chain, GFP_KERNEL);
40         if (chain == NULL)
41                 goto error;
42         chain->dp = dp;
43         chain->owner = try_module_get(hw_table_owner) ? hw_table_owner : NULL;
44         if (chain->owner && create_hw_table_hook) {
45                 struct sw_table *hwtable = create_hw_table_hook();
46                 if (!hwtable || add_table(chain, hwtable))
47                         goto error;
48         }
49
50         if (add_table(chain, table_hash2_create(0x1EDC6F41, TABLE_HASH_MAX_FLOWS,
51                                                 0x741B8CD7, TABLE_HASH_MAX_FLOWS))
52             || add_table(chain, table_linear_create(TABLE_LINEAR_MAX_FLOWS)))
53                 goto error;
54         return chain;
55
56 error:
57         if (chain)
58                 chain_destroy(chain);
59         return NULL;
60 }
61
62 /* Searches 'chain' for a flow matching 'key', which must not have any wildcard
63  * fields.  Returns the flow if successful, otherwise a null pointer.
64  *
65  * Caller must hold rcu_read_lock or dp_mutex. */
66 struct sw_flow *chain_lookup(struct sw_chain *chain,
67                          const struct sw_flow_key *key)
68 {
69         int i;
70
71         BUG_ON(key->wildcards);
72         for (i = 0; i < chain->n_tables; i++) {
73                 struct sw_table *t = chain->tables[i];
74                 struct sw_flow *flow = t->lookup(t, key);
75                 if (flow)
76                         return flow;
77         }
78         return NULL;
79 }
80
81 /* Inserts 'flow' into 'chain', replacing any duplicate flow.  Returns 0 if
82  * successful or a negative error.
83  *
84  * If successful, 'flow' becomes owned by the chain, otherwise it is retained
85  * by the caller.
86  *
87  * Caller must hold dp_mutex. */
88 int chain_insert(struct sw_chain *chain, struct sw_flow *flow)
89 {
90         int i;
91
92         for (i = 0; i < chain->n_tables; i++) {
93                 struct sw_table *t = chain->tables[i];
94                 if (t->insert(t, flow))
95                         return 0;
96         }
97
98         return -ENOBUFS;
99 }
100
101 /* Deletes from 'chain' any and all flows that match 'key'.  Returns the number
102  * of flows that were deleted.
103  *
104  * Expensive in the general case as currently implemented, since it requires
105  * iterating through the entire contents of each table for keys that contain
106  * wildcards.  Relatively cheap for fully specified keys.
107  *
108  * Caller must hold dp_mutex. */
109 int chain_delete(struct sw_chain *chain, const struct sw_flow_key *key, 
110                 uint16_t priority, int strict)
111 {
112         int count = 0;
113         int i;
114
115         for (i = 0; i < chain->n_tables; i++) {
116                 struct sw_table *t = chain->tables[i];
117                 count += t->delete(t, key, priority, strict);
118         }
119
120         return count;
121 }
122
123 /* Performs timeout processing on all the tables in 'chain'.  Returns the
124  * number of flow entries deleted through expiration.
125  *
126  * Expensive as currently implemented, since it iterates through the entire
127  * contents of each table.
128  *
129  * Caller must not hold dp_mutex, because individual tables take and release it
130  * as necessary. */
131 int chain_timeout(struct sw_chain *chain)
132 {
133         int count = 0;
134         int i;
135
136         for (i = 0; i < chain->n_tables; i++) {
137                 struct sw_table *t = chain->tables[i];
138                 count += t->timeout(chain->dp, t);
139         }
140         return count;
141 }
142
143 /* Destroys 'chain', which must not have any users. */
144 void chain_destroy(struct sw_chain *chain)
145 {
146         int i;
147
148         synchronize_rcu();
149         for (i = 0; i < chain->n_tables; i++) {
150                 struct sw_table *t = chain->tables[i];
151                 if (t->destroy)
152                         t->destroy(t);
153         }
154         module_put(chain->owner);
155         kfree(chain);
156 }
157
158 /* Prints statistics for each of the tables in 'chain'. */
159 void chain_print_stats(struct sw_chain *chain)
160 {
161         int i;
162
163         printk("\n");
164         for (i = 0; i < chain->n_tables; i++) {
165                 struct sw_table *t = chain->tables[i];
166                 struct sw_table_stats stats;
167                 t->stats(t, &stats);
168                 printk("%s: %lu/%lu flows\n",
169                                         stats.name, stats.n_flows, stats.max_flows);
170         }
171 }
172
173
174 int chain_set_hw_hook(struct sw_table *(*create_hw_table)(void),
175                       struct module *owner)
176 {
177         int retval = -EBUSY;
178
179         spin_lock(&hook_lock);
180         if (!create_hw_table_hook) {
181                 create_hw_table_hook = create_hw_table;
182                 hw_table_owner = owner;
183                 retval = 0;
184         }
185         spin_unlock(&hook_lock);
186
187         return retval;
188 }
189 EXPORT_SYMBOL(chain_set_hw_hook);
190
191 void chain_clear_hw_hook(void)
192 {
193         create_hw_table_hook = NULL;
194         hw_table_owner = NULL;
195 }
196 EXPORT_SYMBOL(chain_clear_hw_hook);