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