datapath/hwtable_dummy/hwtable_dummy.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   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:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  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
  27  * SOFTWARE.
  28  *
  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.
  32  */
  33
  34 #include <linux/module.h>
  35 #include <linux/rcupdate.h>
  36 #include <linux/slab.h>
  37 #include <linux/list.h>
  38 #include <linux/rculist.h>
  39 #include <linux/delay.h>
  40 #include <linux/if_arp.h>
  41
  42 #include "chain.h"
  43 #include "table.h"
  44 #include "flow.h"
  45 #include "datapath.h"
  46
  47
  48 /* Max number of flow entries supported by the hardware */
  49 #define DUMMY_MAX_FLOW   8192
  50
  51
  52 /* sw_flow private data for dummy table entries.  */
  53 struct sw_flow_dummy {
  54         struct list_head node;
  55
  56         /* xxx If per-entry data is needed, define it here. */
  57 };
  58
  59 struct sw_table_dummy {
  60         struct sw_table swt;
  61
  62         unsigned int max_flows;
  63         unsigned int n_flows;
  64         struct list_head flows;
  65         struct list_head iter_flows;
  66         unsigned long int next_serial;
  67 };
  68
  69
  70 static struct sw_flow *table_dummy_lookup(struct sw_table *swt,
  71                                           const struct sw_flow_key *key)
  72 {
  73         struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
  74         struct sw_flow *flow;
  75         list_for_each_entry (flow, &td->flows, node) {
  76                 if (flow_matches_1wild(key, &flow->key)) {
  77                         return flow;
  78                 }
  79         }
  80         return NULL;
  81 }
  82
  83 static int table_dummy_insert(struct sw_table *swt, struct sw_flow *flow)
  84 {
  85         /* xxx Use a data cache? */
  86         flow->private = kzalloc(sizeof(struct sw_flow_dummy), GFP_ATOMIC);
  87         if (flow->private == NULL)
  88                 return 0;
  89
  90         /* xxx Do whatever needs to be done to insert an entry in hardware.
  91          * xxx If the entry can't be inserted, return 0.  This stub code
  92          * xxx doesn't do anything yet, so we're going to return 0...you
  93          * xxx shouldn't (and you should update n_flows in struct
  94          * xxx sw_table_dummy, too).
  95          */
  96         kfree(flow->private);
  97         return 0;
  98 }
  99
 100
 101 static int do_delete(struct sw_table *swt, struct sw_flow *flow)
 102 {
 103         /* xxx Remove the entry from hardware.  If you need to do any other
 104          * xxx clean-up associated with the entry, do it here.
 105          */
 106         list_del_rcu(&flow->node);
 107         list_del_rcu(&flow->iter_node);
 108         flow_deferred_free(flow);
 109         return 1;
 110 }
 111
 112 static int table_dummy_delete(struct sw_table *swt,
 113                               const struct sw_flow_key *key, uint16_t priority, int strict)
 114 {
 115         struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
 116         struct sw_flow *flow;
 117         unsigned int count = 0;
 118
 119         list_for_each_entry (flow, &td->flows, node) {
 120                 if (flow_del_matches(&flow->key, key, strict)
 121                     && (!strict || (flow->priority == priority)))
 122                         count += do_delete(swt, flow);
 123         }
 124         td->n_flows -= count;
 125         return count;
 126 }
 127
 128
 129 static int table_dummy_timeout(struct datapath *dp, struct sw_table *swt)
 130 {
 131         struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
 132         struct sw_flow *flow;
 133         int del_count = 0;
 134         uint64_t packet_count = 0;
 135         uint64_t byte_count = 0;
 136         int reason;
 137
 138         mutex_lock(&dp_mutex);
 139         list_for_each_entry (flow, &td->flows, node) {
 140                 /* xxx Retrieve the packet and byte counts associated with this
 141                  * entry xxx and store them in "packet_count" and "byte_count".
 142                  */
 143
 144                 if (packet_count != flow->packet_count) {
 145                         flow->packet_count = packet_count;
 146                         flow->byte_count = byte_count;
 147                         flow->used = jiffies;
 148                 }
 149
 150                 reason = flow_timeout(flow);
 151                 if (reason >= 0) {
 152                         if (dp->flags & OFPC_SEND_FLOW_EXP) {
 153                                 /* xxx Get byte count */
 154                                 flow->byte_count = 0;
 155                                 dp_send_flow_expired(dp, flow, reason);
 156                         }
 157                         del_count += do_delete(swt, flow);
 158                 }
 159         }
 160         mutex_unlock(&dp_mutex);
 161
 162         td->n_flows -= del_count;
 163         return del_count;
 164 }
 165
 166
 167 static void table_dummy_destroy(struct sw_table *swt)
 168 {
 169         struct sw_table_dummy *td = (struct sw_table_dummy *)swt;
 170
 171
 172         /* xxx This table is being destroyed, so free any data that you
 173          * xxx don't want to leak.
 174          */
 175
 176
 177         if (td) {
 178                 while (!list_empty(&td->flows)) {
 179                         struct sw_flow *flow = list_entry(td->flows.next,
 180                                                           struct sw_flow, node);
 181                         list_del(&flow->node);
 182                         flow_free(flow);
 183                 }
 184                 kfree(td);
 185         }
 186 }
 187
 188 static int table_dummy_iterate(struct sw_table *swt,
 189                                const struct sw_flow_key *key,
 190                                struct sw_table_position *position,
 191                                int (*callback)(struct sw_flow *, void *),
 192                                void *private)
 193 {
 194         struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
 195         struct sw_flow *flow;
 196         unsigned long start;
 197
 198         start = ~position->private[0];
 199         list_for_each_entry (flow, &td->iter_flows, iter_node) {
 200                 if (flow->serial <= start && flow_matches_2wild(key,
 201                                                                 &flow->key)) {
 202                         int error = callback(flow, private);
 203                         if (error) {
 204                                 position->private[0] = ~flow->serial;
 205                                 return error;
 206                         }
 207                 }
 208         }
 209         return 0;
 210 }
 211
 212 static void table_dummy_stats(struct sw_table *swt,
 213                               struct sw_table_stats *stats)
 214 {
 215         struct sw_table_dummy *td = (struct sw_table_dummy *) swt;
 216         stats->name = "dummy";
 217         stats->wildcards = OFPFW_ALL;      /* xxx Set this appropriately */
 218         stats->n_flows   = td->n_flows;
 219         stats->max_flows = td->max_flows;
 220         stats->n_matched = swt->n_matched;
 221 }
 222
 223
 224 static struct sw_table *table_dummy_create(void)
 225 {
 226         struct sw_table_dummy *td;
 227         struct sw_table *swt;
 228
 229         td = kzalloc(sizeof *td, GFP_KERNEL);
 230         if (td == NULL)
 231                 return NULL;
 232
 233         swt = &td->swt;
 234         swt->lookup = table_dummy_lookup;
 235         swt->insert = table_dummy_insert;
 236         swt->delete = table_dummy_delete;
 237         swt->timeout = table_dummy_timeout;
 238         swt->destroy = table_dummy_destroy;
 239         swt->iterate = table_dummy_iterate;
 240         swt->stats = table_dummy_stats;
 241
 242         td->max_flows = DUMMY_MAX_FLOW;
 243         td->n_flows = 0;
 244         INIT_LIST_HEAD(&td->flows);
 245         INIT_LIST_HEAD(&td->iter_flows);
 246         td->next_serial = 0;
 247
 248         return swt;
 249 }
 250
 251 static int __init dummy_init(void)
 252 {
 253         return chain_set_hw_hook(table_dummy_create, THIS_MODULE);
 254 }
 255 module_init(dummy_init);
 256
 257 static void dummy_cleanup(void)
 258 {
 259         chain_clear_hw_hook();
 260 }
 261 module_exit(dummy_cleanup);
 262
 263 MODULE_DESCRIPTION("Dummy hardware table driver");
 264 MODULE_AUTHOR("Copyright (c) 2008 The Board of Trustees of The Leland Stanford Junior University");
 265 MODULE_LICENSE("Stanford License");