datapath/flow_table.c

   1 /*
   2  * Copyright (c) 2007-2013 Nicira, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301, USA
  17  */
  18
  19 #include "flow.h"
  20 #include "datapath.h"
  21 #include <linux/uaccess.h>
  22 #include <linux/netdevice.h>
  23 #include <linux/etherdevice.h>
  24 #include <linux/if_ether.h>
  25 #include <linux/if_vlan.h>
  26 #include <net/llc_pdu.h>
  27 #include <linux/kernel.h>
  28 #include <linux/hash.h>
  29 #include <linux/jiffies.h>
  30 #include <linux/llc.h>
  31 #include <linux/module.h>
  32 #include <linux/in.h>
  33 #include <linux/rcupdate.h>
  34 #include <linux/if_arp.h>
  35 #include <linux/ip.h>
  36 #include <linux/ipv6.h>
  37 #include <linux/sctp.h>
  38 #include <linux/tcp.h>
  39 #include <linux/udp.h>
  40 #include <linux/icmp.h>
  41 #include <linux/icmpv6.h>
  42 #include <linux/rculist.h>
  43 #include <net/ip.h>
  44 #include <net/ipv6.h>
  45 #include <net/ndisc.h>
  46
  47 #include "vlan.h"
  48
  49 #define TBL_MIN_BUCKETS         1024
  50 #define REHASH_INTERVAL         (10 * 60 * HZ)
  51
  52 static struct kmem_cache *flow_cache;
  53
  54 static u16 range_n_bytes(const struct sw_flow_key_range *range)
  55 {
  56         return range->end - range->start;
  57 }
  58
  59 void ovs_flow_mask_key(struct sw_flow_key *dst, const struct sw_flow_key *src,
  60                        const struct sw_flow_mask *mask)
  61 {
  62         const long *m = (long *)((u8 *)&mask->key + mask->range.start);
  63         const long *s = (long *)((u8 *)src + mask->range.start);
  64         long *d = (long *)((u8 *)dst + mask->range.start);
  65         int i;
  66
  67         /* The memory outside of the 'mask->range' are not set since
  68          * further operations on 'dst' only uses contents within
  69          * 'mask->range'.
  70          */
  71         for (i = 0; i < range_n_bytes(&mask->range); i += sizeof(long))
  72                 *d++ = *s++ & *m++;
  73 }
  74
  75 struct sw_flow *ovs_flow_alloc(bool percpu_stats)
  76 {
  77         struct sw_flow *flow;
  78         int cpu;
  79
  80         flow = kmem_cache_alloc(flow_cache, GFP_KERNEL);
  81         if (!flow)
  82                 return ERR_PTR(-ENOMEM);
  83
  84         flow->sf_acts = NULL;
  85         flow->mask = NULL;
  86
  87         flow->stats.is_percpu = percpu_stats;
  88
  89         if (!percpu_stats) {
  90                 flow->stats.stat = kzalloc(sizeof(*flow->stats.stat), GFP_KERNEL);
  91                 if (!flow->stats.stat)
  92                         goto err;
  93
  94                 spin_lock_init(&flow->stats.stat->lock);
  95         } else {
  96                 flow->stats.cpu_stats = alloc_percpu(struct flow_stats);
  97                 if (!flow->stats.cpu_stats)
  98                         goto err;
  99
 100                 for_each_possible_cpu(cpu) {
 101                         struct flow_stats *cpu_stats;
 102
 103                         cpu_stats = per_cpu_ptr(flow->stats.cpu_stats, cpu);
 104                         spin_lock_init(&cpu_stats->lock);
 105                 }
 106         }
 107         return flow;
 108 err:
 109         kmem_cache_free(flow_cache, flow);
 110         return ERR_PTR(-ENOMEM);
 111 }
 112
 113 int ovs_flow_tbl_count(struct flow_table *table)
 114 {
 115         return table->count;
 116 }
 117
 118 static struct flex_array *alloc_buckets(unsigned int n_buckets)
 119 {
 120         struct flex_array *buckets;
 121         int i, err;
 122
 123         buckets = flex_array_alloc(sizeof(struct hlist_head),
 124                                    n_buckets, GFP_KERNEL);
 125         if (!buckets)
 126                 return NULL;
 127
 128         err = flex_array_prealloc(buckets, 0, n_buckets, GFP_KERNEL);
 129         if (err) {
 130                 flex_array_free(buckets);
 131                 return NULL;
 132         }
 133
 134         for (i = 0; i < n_buckets; i++)
 135                 INIT_HLIST_HEAD((struct hlist_head *)
 136                                         flex_array_get(buckets, i));
 137
 138         return buckets;
 139 }
 140
 141 static void flow_free(struct sw_flow *flow)
 142 {
 143         kfree((struct sf_flow_acts __force *)flow->sf_acts);
 144         if (flow->stats.is_percpu)
 145                 free_percpu(flow->stats.cpu_stats);
 146         else
 147                 kfree(flow->stats.stat);
 148         kmem_cache_free(flow_cache, flow);
 149 }
 150
 151 static void rcu_free_flow_callback(struct rcu_head *rcu)
 152 {
 153         struct sw_flow *flow = container_of(rcu, struct sw_flow, rcu);
 154
 155         flow_free(flow);
 156 }
 157
 158 static void rcu_free_sw_flow_mask_cb(struct rcu_head *rcu)
 159 {
 160         struct sw_flow_mask *mask = container_of(rcu, struct sw_flow_mask, rcu);
 161
 162         kfree(mask);
 163 }
 164
 165 void ovs_flow_free(struct sw_flow *flow, bool deferred)
 166 {
 167         if (!flow)
 168                 return;
 169
 170         ASSERT_OVSL();
 171
 172         if (flow->mask) {
 173                 struct sw_flow_mask *mask = flow->mask;
 174
 175                 BUG_ON(!mask->ref_count);
 176                 mask->ref_count--;
 177
 178                 if (!mask->ref_count) {
 179                         list_del_rcu(&mask->list);
 180                         if (deferred)
 181                                 call_rcu(&mask->rcu, rcu_free_sw_flow_mask_cb);
 182                         else
 183                                 kfree(mask);
 184                 }
 185         }
 186
 187         if (deferred)
 188                 call_rcu(&flow->rcu, rcu_free_flow_callback);
 189         else
 190                 flow_free(flow);
 191 }
 192
 193 static void free_buckets(struct flex_array *buckets)
 194 {
 195         flex_array_free(buckets);
 196 }
 197
 198
 199 static void __table_instance_destroy(struct table_instance *ti)
 200 {
 201         free_buckets(ti->buckets);
 202         kfree(ti);
 203 }
 204
 205 static struct table_instance *table_instance_alloc(int new_size)
 206 {
 207         struct table_instance *ti = kmalloc(sizeof(*ti), GFP_KERNEL);
 208
 209         if (!ti)
 210                 return NULL;
 211
 212         ti->buckets = alloc_buckets(new_size);
 213
 214         if (!ti->buckets) {
 215                 kfree(ti);
 216                 return NULL;
 217         }
 218         ti->n_buckets = new_size;
 219         ti->node_ver = 0;
 220         ti->keep_flows = false;
 221         get_random_bytes(&ti->hash_seed, sizeof(u32));
 222
 223         return ti;
 224 }
 225
 226 int ovs_flow_tbl_init(struct flow_table *table)
 227 {
 228         struct table_instance *ti;
 229
 230         ti = table_instance_alloc(TBL_MIN_BUCKETS);
 231
 232         if (!ti)
 233                 return -ENOMEM;
 234
 235         rcu_assign_pointer(table->ti, ti);
 236         INIT_LIST_HEAD(&table->mask_list);
 237         table->last_rehash = jiffies;
 238         table->count = 0;
 239         return 0;
 240 }
 241
 242 static void flow_tbl_destroy_rcu_cb(struct rcu_head *rcu)
 243 {
 244         struct table_instance *ti = container_of(rcu, struct table_instance, rcu);
 245
 246         __table_instance_destroy(ti);
 247 }
 248
 249 static void table_instance_destroy(struct table_instance *ti, bool deferred)
 250 {
 251         int i;
 252
 253         if (!ti)
 254                 return;
 255
 256         if (ti->keep_flows)
 257                 goto skip_flows;
 258
 259         for (i = 0; i < ti->n_buckets; i++) {
 260                 struct sw_flow *flow;
 261                 struct hlist_head *head = flex_array_get(ti->buckets, i);
 262                 struct hlist_node *n;
 263                 int ver = ti->node_ver;
 264
 265                 hlist_for_each_entry_safe(flow, n, head, hash_node[ver]) {
 266                         hlist_del_rcu(&flow->hash_node[ver]);
 267                         ovs_flow_free(flow, deferred);
 268                 }
 269         }
 270
 271 skip_flows:
 272         if (deferred)
 273                 call_rcu(&ti->rcu, flow_tbl_destroy_rcu_cb);
 274         else
 275                 __table_instance_destroy(ti);
 276 }
 277
 278 void ovs_flow_tbl_destroy(struct flow_table *table, bool deferred)
 279 {
 280         struct table_instance *ti = ovsl_dereference(table->ti);
 281
 282         table_instance_destroy(ti, deferred);
 283 }
 284
 285 struct sw_flow *ovs_flow_tbl_dump_next(struct table_instance *ti,
 286                                        u32 *bucket, u32 *last)
 287 {
 288         struct sw_flow *flow;
 289         struct hlist_head *head;
 290         int ver;
 291         int i;
 292
 293         ver = ti->node_ver;
 294         while (*bucket < ti->n_buckets) {
 295                 i = 0;
 296                 head = flex_array_get(ti->buckets, *bucket);
 297                 hlist_for_each_entry_rcu(flow, head, hash_node[ver]) {
 298                         if (i < *last) {
 299                                 i++;
 300                                 continue;
 301                         }
 302                         *last = i + 1;
 303                         return flow;
 304                 }
 305                 (*bucket)++;
 306                 *last = 0;
 307         }
 308
 309         return NULL;
 310 }
 311
 312 static struct hlist_head *find_bucket(struct table_instance *ti, u32 hash)
 313 {
 314         hash = jhash_1word(hash, ti->hash_seed);
 315         return flex_array_get(ti->buckets,
 316                                 (hash & (ti->n_buckets - 1)));
 317 }
 318
 319 static void table_instance_insert(struct table_instance *ti, struct sw_flow *flow)
 320 {
 321         struct hlist_head *head;
 322
 323         head = find_bucket(ti, flow->hash);
 324         hlist_add_head_rcu(&flow->hash_node[ti->node_ver], head);
 325 }
 326
 327 static void flow_table_copy_flows(struct table_instance *old,
 328                                   struct table_instance *new)
 329 {
 330         int old_ver;
 331         int i;
 332
 333         old_ver = old->node_ver;
 334         new->node_ver = !old_ver;
 335
 336         /* Insert in new table. */
 337         for (i = 0; i < old->n_buckets; i++) {
 338                 struct sw_flow *flow;
 339                 struct hlist_head *head;
 340
 341                 head = flex_array_get(old->buckets, i);
 342
 343                 hlist_for_each_entry(flow, head, hash_node[old_ver])
 344                         table_instance_insert(new, flow);
 345         }
 346
 347         old->keep_flows = true;
 348 }
 349
 350 static struct table_instance *table_instance_rehash(struct table_instance *ti,
 351                                             int n_buckets)
 352 {
 353         struct table_instance *new_ti;
 354
 355         new_ti = table_instance_alloc(n_buckets);
 356         if (!new_ti)
 357                 return NULL;
 358
 359         flow_table_copy_flows(ti, new_ti);
 360
 361         return new_ti;
 362 }
 363
 364 int ovs_flow_tbl_flush(struct flow_table *flow_table)
 365 {
 366         struct table_instance *old_ti;
 367         struct table_instance *new_ti;
 368
 369         old_ti = ovsl_dereference(flow_table->ti);
 370         new_ti = table_instance_alloc(TBL_MIN_BUCKETS);
 371         if (!new_ti)
 372                 return -ENOMEM;
 373
 374         rcu_assign_pointer(flow_table->ti, new_ti);
 375         flow_table->last_rehash = jiffies;
 376         flow_table->count = 0;
 377
 378         table_instance_destroy(old_ti, true);
 379         return 0;
 380 }
 381
 382 static u32 flow_hash(const struct sw_flow_key *key, int key_start,
 383                      int key_end)
 384 {
 385         u32 *hash_key = (u32 *)((u8 *)key + key_start);
 386         int hash_u32s = (key_end - key_start) >> 2;
 387
 388         /* Make sure number of hash bytes are multiple of u32. */
 389         BUILD_BUG_ON(sizeof(long) % sizeof(u32));
 390
 391         return arch_fast_hash2(hash_key, hash_u32s, 0);
 392 }
 393
 394 static int flow_key_start(const struct sw_flow_key *key)
 395 {
 396         if (key->tun_key.ipv4_dst)
 397                 return 0;
 398         else
 399                 return rounddown(offsetof(struct sw_flow_key, phy),
 400                                           sizeof(long));
 401 }
 402
 403 static bool cmp_key(const struct sw_flow_key *key1,
 404                     const struct sw_flow_key *key2,
 405                     int key_start, int key_end)
 406 {
 407         const long *cp1 = (long *)((u8 *)key1 + key_start);
 408         const long *cp2 = (long *)((u8 *)key2 + key_start);
 409         long diffs = 0;
 410         int i;
 411
 412         for (i = key_start; i < key_end;  i += sizeof(long))
 413                 diffs |= *cp1++ ^ *cp2++;
 414
 415         return diffs == 0;
 416 }
 417
 418 static bool flow_cmp_masked_key(const struct sw_flow *flow,
 419                                 const struct sw_flow_key *key,
 420                                 int key_start, int key_end)
 421 {
 422         return cmp_key(&flow->key, key, key_start, key_end);
 423 }
 424
 425 bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
 426                                struct sw_flow_match *match)
 427 {
 428         struct sw_flow_key *key = match->key;
 429         int key_start = flow_key_start(key);
 430         int key_end = match->range.end;
 431
 432         return cmp_key(&flow->unmasked_key, key, key_start, key_end);
 433 }
 434
 435 static struct sw_flow *masked_flow_lookup(struct table_instance *ti,
 436                                           const struct sw_flow_key *unmasked,
 437                                           struct sw_flow_mask *mask)
 438 {
 439         struct sw_flow *flow;
 440         struct hlist_head *head;
 441         int key_start = mask->range.start;
 442         int key_end = mask->range.end;
 443         u32 hash;
 444         struct sw_flow_key masked_key;
 445
 446         ovs_flow_mask_key(&masked_key, unmasked, mask);
 447         hash = flow_hash(&masked_key, key_start, key_end);
 448         head = find_bucket(ti, hash);
 449         hlist_for_each_entry_rcu(flow, head, hash_node[ti->node_ver]) {
 450                 if (flow->mask == mask && flow->hash == hash &&
 451                     flow_cmp_masked_key(flow, &masked_key,
 452                                           key_start, key_end))
 453                         return flow;
 454         }
 455         return NULL;
 456 }
 457
 458 struct sw_flow *ovs_flow_tbl_lookup_stats(struct flow_table *tbl,
 459                                     const struct sw_flow_key *key,
 460                                     u32 *n_mask_hit)
 461 {
 462         struct table_instance *ti = rcu_dereference_ovsl(tbl->ti);
 463         struct sw_flow_mask *mask;
 464         struct sw_flow *flow;
 465
 466         *n_mask_hit = 0;
 467         list_for_each_entry_rcu(mask, &tbl->mask_list, list) {
 468                 (*n_mask_hit)++;
 469                 flow = masked_flow_lookup(ti, key, mask);
 470                 if (flow)  /* Found */
 471                         return flow;
 472         }
 473         return NULL;
 474 }
 475
 476 struct sw_flow *ovs_flow_tbl_lookup(struct flow_table *tbl,
 477                                     const struct sw_flow_key *key)
 478 {
 479         u32 __always_unused n_mask_hit;
 480
 481         return ovs_flow_tbl_lookup_stats(tbl, key, &n_mask_hit);
 482 }
 483
 484 int ovs_flow_tbl_num_masks(const struct flow_table *table)
 485 {
 486         struct sw_flow_mask *mask;
 487         int num = 0;
 488
 489         list_for_each_entry(mask, &table->mask_list, list)
 490                 num++;
 491
 492         return num;
 493 }
 494
 495 static struct table_instance *table_instance_expand(struct table_instance *ti)
 496 {
 497         return table_instance_rehash(ti, ti->n_buckets * 2);
 498 }
 499
 500 void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow)
 501 {
 502         struct table_instance *ti = ovsl_dereference(table->ti);
 503
 504         BUG_ON(table->count == 0);
 505         hlist_del_rcu(&flow->hash_node[ti->node_ver]);
 506         table->count--;
 507 }
 508
 509 static struct sw_flow_mask *mask_alloc(void)
 510 {
 511         struct sw_flow_mask *mask;
 512
 513         mask = kmalloc(sizeof(*mask), GFP_KERNEL);
 514         if (mask)
 515                 mask->ref_count = 1;
 516
 517         return mask;
 518 }
 519
 520 static bool mask_equal(const struct sw_flow_mask *a,
 521                        const struct sw_flow_mask *b)
 522 {
 523         u8 *a_ = (u8 *)&a->key + a->range.start;
 524         u8 *b_ = (u8 *)&b->key + b->range.start;
 525
 526         return  (a->range.end == b->range.end)
 527                 && (a->range.start == b->range.start)
 528                 && (memcmp(a_, b_, range_n_bytes(&a->range)) == 0);
 529 }
 530
 531 static struct sw_flow_mask *flow_mask_find(const struct flow_table *tbl,
 532                                            const struct sw_flow_mask *mask)
 533 {
 534         struct list_head *ml;
 535
 536         list_for_each(ml, &tbl->mask_list) {
 537                 struct sw_flow_mask *m;
 538                 m = container_of(ml, struct sw_flow_mask, list);
 539                 if (mask_equal(mask, m))
 540                         return m;
 541         }
 542
 543         return NULL;
 544 }
 545
 546 /* Add 'mask' into the mask list, if it is not already there. */
 547 static int flow_mask_insert(struct flow_table *tbl, struct sw_flow *flow,
 548                             struct sw_flow_mask *new)
 549 {
 550         struct sw_flow_mask *mask;
 551         mask = flow_mask_find(tbl, new);
 552         if (!mask) {
 553                 /* Allocate a new mask if none exsits. */
 554                 mask = mask_alloc();
 555                 if (!mask)
 556                         return -ENOMEM;
 557                 mask->key = new->key;
 558                 mask->range = new->range;
 559                 list_add_rcu(&mask->list, &tbl->mask_list);
 560         } else {
 561                 BUG_ON(!mask->ref_count);
 562                 mask->ref_count++;
 563         }
 564
 565         flow->mask = mask;
 566         return 0;
 567 }
 568
 569 int ovs_flow_tbl_insert(struct flow_table *table, struct sw_flow *flow,
 570                         struct sw_flow_mask *mask)
 571 {
 572         struct table_instance *new_ti = NULL;
 573         struct table_instance *ti;
 574         int err;
 575
 576         err = flow_mask_insert(table, flow, mask);
 577         if (err)
 578                 return err;
 579
 580         flow->hash = flow_hash(&flow->key, flow->mask->range.start,
 581                         flow->mask->range.end);
 582         ti = ovsl_dereference(table->ti);
 583         table_instance_insert(ti, flow);
 584         table->count++;
 585
 586         /* Expand table, if necessary, to make room. */
 587         if (table->count > ti->n_buckets)
 588                 new_ti = table_instance_expand(ti);
 589         else if (time_after(jiffies, table->last_rehash + REHASH_INTERVAL))
 590                 new_ti = table_instance_rehash(ti, ti->n_buckets);
 591
 592         if (new_ti) {
 593                 rcu_assign_pointer(table->ti, new_ti);
 594                 table_instance_destroy(ti, true);
 595                 table->last_rehash = jiffies;
 596         }
 597         return 0;
 598 }
 599
 600 /* Initializes the flow module.
 601  * Returns zero if successful or a negative error code. */
 602 int ovs_flow_init(void)
 603 {
 604         BUILD_BUG_ON(__alignof__(struct sw_flow_key) % __alignof__(long));
 605         BUILD_BUG_ON(sizeof(struct sw_flow_key) % sizeof(long));
 606
 607         flow_cache = kmem_cache_create("sw_flow", sizeof(struct sw_flow), 0,
 608                                         0, NULL);
 609         if (flow_cache == NULL)
 610                 return -ENOMEM;
 611
 612         return 0;
 613 }
 614
 615 /* Uninitializes the flow module. */
 616 void ovs_flow_exit(void)
 617 {
 618         kmem_cache_destroy(flow_cache);
 619 }