switch/table-hash.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 <config.h>
  35 #include "table.h"
  36 #include <assert.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include "crc32.h"
  40 #include "flow.h"
  41 #include "datapath.h"
  42
  43 struct sw_table_hash {
  44     struct sw_table swt;
  45     struct crc32 crc32;
  46     unsigned int n_flows;
  47     unsigned int bucket_mask; /* Number of buckets minus 1. */
  48     struct sw_flow **buckets;
  49 };
  50
  51 static struct sw_flow **find_bucket(struct sw_table *swt,
  52                                     const struct sw_flow_key *key)
  53 {
  54     struct sw_table_hash *th = (struct sw_table_hash *) swt;
  55     unsigned int crc = crc32_calculate(&th->crc32, key,
  56             offsetof(struct sw_flow_key, wildcards));
  57     return &th->buckets[crc & th->bucket_mask];
  58 }
  59
  60 static struct sw_flow *table_hash_lookup(struct sw_table *swt,
  61                                          const struct sw_flow_key *key)
  62 {
  63     struct sw_flow *flow = *find_bucket(swt, key);
  64     return flow && !flow_compare(&flow->key.flow, &key->flow) ? flow : NULL;
  65 }
  66
  67 static int table_hash_insert(struct sw_table *swt, struct sw_flow *flow)
  68 {
  69     struct sw_table_hash *th = (struct sw_table_hash *) swt;
  70     struct sw_flow **bucket;
  71     int retval;
  72
  73     if (flow->key.wildcards != 0)
  74         return 0;
  75
  76     bucket = find_bucket(swt, &flow->key);
  77     if (*bucket == NULL) {
  78         th->n_flows++;
  79         *bucket = flow;
  80         retval = 1;
  81     } else {
  82         struct sw_flow *old_flow = *bucket;
  83         if (!flow_compare(&old_flow->key.flow, &flow->key.flow)) {
  84             *bucket = flow;
  85             flow_free(old_flow);
  86             retval = 1;
  87         } else {
  88             retval = 0;
  89         }
  90     }
  91     return retval;
  92 }
  93
  94 /* Caller must update n_flows. */
  95 static void
  96 do_delete(struct sw_flow **bucket)
  97 {
  98     flow_free(*bucket);
  99     *bucket = NULL;
 100 }
 101
 102 /* Returns number of deleted flows.  We can igonre the priority
 103  * argument, since all exact-match entries are the same (highest)
 104  * priority. */
 105 static int table_hash_delete(struct sw_table *swt,
 106                              const struct sw_flow_key *key,
 107                              uint16_t priority, int strict)
 108 {
 109     struct sw_table_hash *th = (struct sw_table_hash *) swt;
 110     unsigned int count = 0;
 111
 112     if (key->wildcards == 0) {
 113         struct sw_flow **bucket = find_bucket(swt, key);
 114         struct sw_flow *flow = *bucket;
 115         if (flow && !flow_compare(&flow->key.flow, &key->flow)) {
 116             do_delete(bucket);
 117             count = 1;
 118         }
 119     } else {
 120         unsigned int i;
 121
 122         for (i = 0; i <= th->bucket_mask; i++) {
 123             struct sw_flow **bucket = &th->buckets[i];
 124             struct sw_flow *flow = *bucket;
 125             if (flow && flow_del_matches(&flow->key, key, strict)) {
 126                 do_delete(bucket);
 127                 count++;
 128             }
 129         }
 130     }
 131     th->n_flows -= count;
 132     return count;
 133 }
 134
 135 static void table_hash_timeout(struct sw_table *swt, struct list *deleted)
 136 {
 137     struct sw_table_hash *th = (struct sw_table_hash *) swt;
 138     unsigned int i;
 139
 140     for (i = 0; i <= th->bucket_mask; i++) {
 141         struct sw_flow **bucket = &th->buckets[i];
 142         struct sw_flow *flow = *bucket;
 143         if (flow && flow_timeout(flow)) {
 144             list_push_back(deleted, &flow->node);
 145             *bucket = NULL;
 146             th->n_flows--;
 147         }
 148     }
 149 }
 150
 151 static void table_hash_destroy(struct sw_table *swt)
 152 {
 153     struct sw_table_hash *th = (struct sw_table_hash *) swt;
 154     unsigned int i;
 155     for (i = 0; i <= th->bucket_mask; i++) {
 156         if (th->buckets[i]) {
 157             flow_free(th->buckets[i]);
 158         }
 159     }
 160     free(th->buckets);
 161     free(th);
 162 }
 163
 164 static int table_hash_iterate(struct sw_table *swt,
 165                               const struct sw_flow_key *key,
 166                               struct sw_table_position *position,
 167                               int (*callback)(struct sw_flow *, void *private),
 168                               void *private)
 169 {
 170     struct sw_table_hash *th = (struct sw_table_hash *) swt;
 171
 172     if (position->private[0] > th->bucket_mask)
 173         return 0;
 174
 175     if (key->wildcards == 0) {
 176         struct sw_flow *flow = table_hash_lookup(swt, key);
 177         position->private[0] = -1;
 178         return flow ? callback(flow, private) : 0;
 179     } else {
 180         int i;
 181
 182         for (i = position->private[0]; i <= th->bucket_mask; i++) {
 183             struct sw_flow *flow = th->buckets[i];
 184             if (flow && flow_matches_1wild(&flow->key, key)) {
 185                 int error = callback(flow, private);
 186                 if (error) {
 187                     position->private[0] = i + 1;
 188                     return error;
 189                 }
 190             }
 191         }
 192         return 0;
 193     }
 194 }
 195
 196 static void table_hash_stats(struct sw_table *swt,
 197                              struct sw_table_stats *stats)
 198 {
 199     struct sw_table_hash *th = (struct sw_table_hash *) swt;
 200     stats->name = "hash";
 201     stats->wildcards = 0;        /* No wildcards are supported. */
 202     stats->n_flows   = th->n_flows;
 203     stats->max_flows = th->bucket_mask + 1;
 204     stats->n_matched = swt->n_matched;
 205 }
 206
 207 struct sw_table *table_hash_create(unsigned int polynomial,
 208                                    unsigned int n_buckets)
 209 {
 210     struct sw_table_hash *th;
 211     struct sw_table *swt;
 212
 213     th = malloc(sizeof *th);
 214     if (th == NULL)
 215         return NULL;
 216     memset(th, '\0', sizeof *th);
 217
 218     assert(!(n_buckets & (n_buckets - 1)));
 219     th->buckets = calloc(n_buckets, sizeof *th->buckets);
 220     if (th->buckets == NULL) {
 221         printf("failed to allocate %u buckets\n", n_buckets);
 222         free(th);
 223         return NULL;
 224     }
 225     th->n_flows = 0;
 226     th->bucket_mask = n_buckets - 1;
 227
 228     swt = &th->swt;
 229     swt->lookup = table_hash_lookup;
 230     swt->insert = table_hash_insert;
 231     swt->delete = table_hash_delete;
 232     swt->timeout = table_hash_timeout;
 233     swt->destroy = table_hash_destroy;
 234     swt->iterate = table_hash_iterate;
 235     swt->stats = table_hash_stats;
 236
 237     crc32_init(&th->crc32, polynomial);
 238
 239     return swt;
 240 }
 241
 242 /* Double-hashing table. */
 243
 244 struct sw_table_hash2 {
 245     struct sw_table swt;
 246     struct sw_table *subtable[2];
 247 };
 248
 249 static struct sw_flow *table_hash2_lookup(struct sw_table *swt,
 250                                           const struct sw_flow_key *key)
 251 {
 252     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 253     int i;
 254
 255     for (i = 0; i < 2; i++) {
 256         struct sw_flow *flow = *find_bucket(t2->subtable[i], key);
 257         if (flow && !flow_compare(&flow->key.flow, &key->flow))
 258             return flow;
 259     }
 260     return NULL;
 261 }
 262
 263 static int table_hash2_insert(struct sw_table *swt, struct sw_flow *flow)
 264 {
 265     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 266
 267     if (table_hash_insert(t2->subtable[0], flow))
 268         return 1;
 269     return table_hash_insert(t2->subtable[1], flow);
 270 }
 271
 272 static int table_hash2_delete(struct sw_table *swt,
 273                               const struct sw_flow_key *key,
 274                               uint16_t priority, int strict)
 275 {
 276     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 277     return (table_hash_delete(t2->subtable[0], key, priority, strict)
 278             + table_hash_delete(t2->subtable[1], key, priority, strict));
 279 }
 280
 281 static void table_hash2_timeout(struct sw_table *swt, struct list *deleted)
 282 {
 283     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 284     table_hash_timeout(t2->subtable[0], deleted);
 285     table_hash_timeout(t2->subtable[1], deleted);
 286 }
 287
 288 static void table_hash2_destroy(struct sw_table *swt)
 289 {
 290     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 291     table_hash_destroy(t2->subtable[0]);
 292     table_hash_destroy(t2->subtable[1]);
 293     free(t2);
 294 }
 295
 296 static int table_hash2_iterate(struct sw_table *swt,
 297                                const struct sw_flow_key *key,
 298                                struct sw_table_position *position,
 299                                int (*callback)(struct sw_flow *, void *),
 300                                void *private)
 301 {
 302     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 303     int i;
 304
 305     for (i = position->private[1]; i < 2; i++) {
 306         int error = table_hash_iterate(t2->subtable[i], key, position,
 307                                        callback, private);
 308         if (error) {
 309             return error;
 310         }
 311         position->private[0] = 0;
 312         position->private[1]++;
 313     }
 314     return 0;
 315 }
 316
 317 static void table_hash2_stats(struct sw_table *swt,
 318                               struct sw_table_stats *stats)
 319 {
 320     struct sw_table_hash2 *t2 = (struct sw_table_hash2 *) swt;
 321     struct sw_table_stats substats[2];
 322     int i;
 323
 324     for (i = 0; i < 2; i++)
 325         table_hash_stats(t2->subtable[i], &substats[i]);
 326     stats->name = "hash2";
 327     stats->wildcards = 0;        /* No wildcards are supported. */
 328     stats->n_flows   = substats[0].n_flows + substats[1].n_flows;
 329     stats->max_flows = substats[0].max_flows + substats[1].max_flows;
 330     stats->n_matched = swt->n_matched;
 331 }
 332
 333 struct sw_table *table_hash2_create(unsigned int poly0, unsigned int buckets0,
 334                                     unsigned int poly1, unsigned int buckets1)
 335
 336 {
 337     struct sw_table_hash2 *t2;
 338     struct sw_table *swt;
 339
 340     t2 = malloc(sizeof *t2);
 341     if (t2 == NULL)
 342         return NULL;
 343     memset(t2, '\0', sizeof *t2);
 344
 345     t2->subtable[0] = table_hash_create(poly0, buckets0);
 346     if (t2->subtable[0] == NULL)
 347         goto out_free_t2;
 348
 349     t2->subtable[1] = table_hash_create(poly1, buckets1);
 350     if (t2->subtable[1] == NULL)
 351         goto out_free_subtable0;
 352
 353     swt = &t2->swt;
 354     swt->lookup = table_hash2_lookup;
 355     swt->insert = table_hash2_insert;
 356     swt->delete = table_hash2_delete;
 357     swt->timeout = table_hash2_timeout;
 358     swt->destroy = table_hash2_destroy;
 359     swt->iterate = table_hash2_iterate;
 360     swt->stats = table_hash2_stats;
 361
 362     return swt;
 363
 364 out_free_subtable0:
 365     table_hash_destroy(t2->subtable[0]);
 366 out_free_t2:
 367     free(t2);
 368     return NULL;
 369 }