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