Added OFPFC_MODIFY_STRICT flow mod command.
[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                         t->n_matched++;
77                         return flow;
78                 }
79         }
80         return NULL;
81 }
82
83 /* Inserts 'flow' into 'chain', replacing any duplicate flow.  Returns 0 if
84  * successful or a negative error.
85  *
86  * If successful, 'flow' becomes owned by the chain, otherwise it is retained
87  * by the caller.
88  *
89  * Caller must hold dp_mutex. */
90 int chain_insert(struct sw_chain *chain, struct sw_flow *flow)
91 {
92         int i;
93
94         might_sleep();
95         for (i = 0; i < chain->n_tables; i++) {
96                 struct sw_table *t = chain->tables[i];
97                 if (t->insert(t, flow))
98                         return 0;
99         }
100
101         return -ENOBUFS;
102 }
103
104 /* Modifies actions in 'chain' that match 'key'.  If 'strict' set, wildcards 
105  * and priority must match.  Returns the number of flows that were modified.
106  *
107  * Expensive in the general case as currently implemented, since it requires
108  * iterating through the entire contents of each table for keys that contain
109  * wildcards.  Relatively cheap for fully specified keys. */
110 int
111 chain_modify(struct sw_chain *chain, const struct sw_flow_key *key, 
112                 uint16_t priority, int strict,
113                 const struct ofp_action *actions, int n_actions)
114 {
115         int count = 0;
116         int i;
117
118         for (i = 0; i < chain->n_tables; i++) {
119                 struct sw_table *t = chain->tables[i];
120                 count += t->modify(t, key, priority, strict, actions, n_actions);
121         }
122
123         return count;
124 }
125
126 /* Deletes from 'chain' any and all flows that match 'key'.  If 'strict' set, 
127  * wildcards and priority must match.  Returns the number of flows that were 
128  * deleted.
129  *
130  * Expensive in the general case as currently implemented, since it requires
131  * iterating through the entire contents of each table for keys that contain
132  * wildcards.  Relatively cheap for fully specified keys.
133  *
134  * Caller must hold dp_mutex. */
135 int chain_delete(struct sw_chain *chain, const struct sw_flow_key *key, 
136                 uint16_t priority, int strict)
137 {
138         int count = 0;
139         int i;
140
141         might_sleep();
142         for (i = 0; i < chain->n_tables; i++) {
143                 struct sw_table *t = chain->tables[i];
144                 count += t->delete(t, key, priority, strict);
145         }
146
147         return count;
148 }
149
150 /* Performs timeout processing on all the tables in 'chain'.  Returns the
151  * number of flow entries deleted through expiration.
152  *
153  * Expensive as currently implemented, since it iterates through the entire
154  * contents of each table.
155  *
156  * Caller must not hold dp_mutex, because individual tables take and release it
157  * as necessary. */
158 int chain_timeout(struct sw_chain *chain)
159 {
160         int count = 0;
161         int i;
162
163         might_sleep();
164         for (i = 0; i < chain->n_tables; i++) {
165                 struct sw_table *t = chain->tables[i];
166                 count += t->timeout(chain->dp, t);
167         }
168         return count;
169 }
170
171 /* Destroys 'chain', which must not have any users. */
172 void chain_destroy(struct sw_chain *chain)
173 {
174         int i;
175
176         synchronize_rcu();
177         for (i = 0; i < chain->n_tables; i++) {
178                 struct sw_table *t = chain->tables[i];
179                 if (t->destroy)
180                         t->destroy(t);
181         }
182         module_put(chain->owner);
183         kfree(chain);
184 }
185
186 int chain_set_hw_hook(struct sw_table *(*create_hw_table)(void),
187                       struct module *owner)
188 {
189         int retval = -EBUSY;
190
191         spin_lock(&hook_lock);
192         if (!create_hw_table_hook) {
193                 create_hw_table_hook = create_hw_table;
194                 hw_table_owner = owner;
195                 retval = 0;
196         }
197         spin_unlock(&hook_lock);
198
199         return retval;
200 }
201 EXPORT_SYMBOL(chain_set_hw_hook);
202
203 void chain_clear_hw_hook(void)
204 {
205         create_hw_table_hook = NULL;
206         hw_table_owner = NULL;
207 }
208 EXPORT_SYMBOL(chain_clear_hw_hook);