1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
34 #include <linux/module.h>
35 #include <linux/rcupdate.h>
36 #include <linux/slab.h>
37 #include <linux/list.h>
38 #include <linux/delay.h>
39 #include <linux/if_arp.h>
47 /* Max number of flow entries supported by the hardware */
48 #define DUMMY_MAX_FLOW 8192
51 /* sw_flow private data for dummy table entries. */
52 struct sw_flow_dummy {
53 struct list_head node;
55 /* xxx If per-entry data is needed, define it here. */
58 struct sw_table_dummy {
61 unsigned int max_flows;
63 struct list_head flows;
64 struct list_head iter_flows;
65 unsigned long int next_serial;
69 static struct sw_flow *table_dummy_lookup(struct sw_table *swt,
70 const struct sw_flow_key *key)
72 struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
74 list_for_each_entry (flow, &td->flows, node) {
75 if (flow_matches(&flow->key, key)) {
82 static int table_dummy_insert(struct sw_table *swt, struct sw_flow *flow)
84 /* xxx Use a data cache? */
85 flow->private = kzalloc(sizeof(struct sw_flow_dummy), GFP_ATOMIC);
86 if (flow->private == NULL)
89 /* xxx Do whatever needs to be done to insert an entry in hardware.
90 * xxx If the entry can't be inserted, return 0. This stub code
91 * xxx doesn't do anything yet, so we're going to return 0...you
92 * xxx shouldn't (and you should update n_flows in struct
93 * xxx sw_table_dummy, too).
100 static int do_delete(struct sw_table *swt, struct sw_flow *flow)
102 /* xxx Remove the entry from hardware. If you need to do any other
103 * xxx clean-up associated with the entry, do it here.
105 list_del_rcu(&flow->node);
106 list_del_rcu(&flow->iter_node);
110 static int table_dummy_delete(struct sw_table *swt,
111 const struct sw_flow_key *key, uint16_t priority, int strict)
113 struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
114 struct sw_flow *flow;
115 unsigned int count = 0;
117 list_for_each_entry (flow, &td->flows, node) {
118 if (flow_del_matches(&flow->key, key, strict)
119 && (!strict || (flow->priority == priority)))
120 count += do_delete(swt, flow);
122 td->n_flows -= count;
127 static int table_dummy_timeout(struct datapath *dp, struct sw_table *swt)
129 struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
130 struct sw_flow *flow;
132 uint64_t packet_count = 0;
135 mutex_lock(&dp_mutex);
136 list_for_each_entry (flow, &td->flows, node) {
137 /* xxx Retrieve the packet count associated with this entry
138 * xxx and store it in "packet_count".
141 if ((packet_count > flow->packet_count)
142 && (flow->max_idle != OFP_FLOW_PERMANENT)) {
143 flow->packet_count = packet_count;
144 flow->timeout = jiffies + HZ * flow->max_idle;
147 if (flow_timeout(flow)) {
148 if (dp->flags & OFPC_SEND_FLOW_EXP) {
149 /* xxx Get byte count */
150 flow->byte_count = 0;
151 dp_send_flow_expired(dp, flow);
153 del_count += do_delete(swt, flow);
157 mutex_unlock(&dp_mutex);
159 td->n_flows -= del_count;
164 static void table_dummy_destroy(struct sw_table *swt)
166 struct sw_table_dummy *td = (struct sw_table_dummy *)swt;
169 /* xxx This table is being destroyed, so free any data that you
170 * xxx don't want to leak.
175 while (!list_empty(&td->flows)) {
176 struct sw_flow *flow = list_entry(td->flows.next,
177 struct sw_flow, node);
178 list_del(&flow->node);
185 static int table_dummy_iterate(struct sw_table *swt,
186 const struct sw_flow_key *key,
187 struct sw_table_position *position,
188 int (*callback)(struct sw_flow *, void *),
191 struct sw_table_dummy *tl = (struct sw_table_dummy *) swt;
192 struct sw_flow *flow;
195 start = ~position->private[0];
196 list_for_each_entry (flow, &tl->iter_flows, iter_node) {
197 if (flow->serial <= start && flow_matches(key, &flow->key)) {
198 int error = callback(flow, private);
200 position->private[0] = ~flow->serial;
208 static void table_dummy_stats(struct sw_table *swt,
209 struct sw_table_stats *stats)
211 struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
212 stats->name = "dummy";
213 stats->n_flows = td->n_flows;
214 stats->max_flows = td->max_flows;
218 static struct sw_table *table_dummy_create(void)
220 struct sw_table_dummy *td;
221 struct sw_table *swt;
223 td = kzalloc(sizeof *td, GFP_KERNEL);
228 swt->lookup = table_dummy_lookup;
229 swt->insert = table_dummy_insert;
230 swt->delete = table_dummy_delete;
231 swt->timeout = table_dummy_timeout;
232 swt->destroy = table_dummy_destroy;
233 swt->iterate = table_dummy_iterate;
234 swt->stats = table_dummy_stats;
236 td->max_flows = DUMMY_MAX_FLOW;
238 INIT_LIST_HEAD(&td->flows);
239 INIT_LIST_HEAD(&td->iter_flows);
245 static int __init dummy_init(void)
247 return chain_set_hw_hook(table_dummy_create, THIS_MODULE);
249 module_init(dummy_init);
251 static void dummy_cleanup(void)
253 chain_clear_hw_hook();
255 module_exit(dummy_cleanup);
257 MODULE_DESCRIPTION("Dummy hardware table driver");
258 MODULE_AUTHOR("Copyright (c) 2008 The Board of Trustees of The Leland Stanford Junior University");
259 MODULE_LICENSE("Stanford License");