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 sw_flow_actions __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 (deferred)
 172                 call_rcu(&flow->rcu, rcu_free_flow_callback);
 173         else
 174                 flow_free(flow);
 175 }
 176
 177 static void free_buckets(struct flex_array *buckets)
 178 {
 179         flex_array_free(buckets);
 180 }
 181
 182
 183 static void __table_instance_destroy(struct table_instance *ti)
 184 {
 185         free_buckets(ti->buckets);
 186         kfree(ti);
 187 }
 188
 189 static struct table_instance *table_instance_alloc(int new_size)
 190 {
 191         struct table_instance *ti = kmalloc(sizeof(*ti), GFP_KERNEL);
 192
 193         if (!ti)
 194                 return NULL;
 195
 196         ti->buckets = alloc_buckets(new_size);
 197
 198         if (!ti->buckets) {
 199                 kfree(ti);
 200                 return NULL;
 201         }
 202         ti->n_buckets = new_size;
 203         ti->node_ver = 0;
 204         ti->keep_flows = false;
 205         get_random_bytes(&ti->hash_seed, sizeof(u32));
 206
 207         return ti;
 208 }
 209
 210 int ovs_flow_tbl_init(struct flow_table *table)
 211 {
 212         struct table_instance *ti;
 213
 214         ti = table_instance_alloc(TBL_MIN_BUCKETS);
 215
 216         if (!ti)
 217                 return -ENOMEM;
 218
 219         rcu_assign_pointer(table->ti, ti);
 220         INIT_LIST_HEAD(&table->mask_list);
 221         table->last_rehash = jiffies;
 222         table->count = 0;
 223         return 0;
 224 }
 225
 226 static void flow_tbl_destroy_rcu_cb(struct rcu_head *rcu)
 227 {
 228         struct table_instance *ti = container_of(rcu, struct table_instance, rcu);
 229
 230         __table_instance_destroy(ti);
 231 }
 232
 233 static void table_instance_destroy(struct table_instance *ti, bool deferred)
 234 {
 235         int i;
 236
 237         if (!ti)
 238                 return;
 239
 240         if (ti->keep_flows)
 241                 goto skip_flows;
 242
 243         for (i = 0; i < ti->n_buckets; i++) {
 244                 struct sw_flow *flow;
 245                 struct hlist_head *head = flex_array_get(ti->buckets, i);
 246                 struct hlist_node *n;
 247                 int ver = ti->node_ver;
 248
 249                 hlist_for_each_entry_safe(flow, n, head, hash_node[ver]) {
 250                         hlist_del_rcu(&flow->hash_node[ver]);
 251                         ovs_flow_free(flow, deferred);
 252                 }
 253         }
 254
 255 skip_flows:
 256         if (deferred)
 257                 call_rcu(&ti->rcu, flow_tbl_destroy_rcu_cb);
 258         else
 259                 __table_instance_destroy(ti);
 260 }
 261
 262 /* No need for locking this function is called from RCU callback or
 263  * error path. */
 264 void ovs_flow_tbl_destroy(struct flow_table *table)
 265 {
 266         struct table_instance *ti = (struct table_instance __force *)table->ti;
 267
 268         table_instance_destroy(ti, false);
 269 }
 270
 271 struct sw_flow *ovs_flow_tbl_dump_next(struct table_instance *ti,
 272                                        u32 *bucket, u32 *last)
 273 {
 274         struct sw_flow *flow;
 275         struct hlist_head *head;
 276         int ver;
 277         int i;
 278
 279         ver = ti->node_ver;
 280         while (*bucket < ti->n_buckets) {
 281                 i = 0;
 282                 head = flex_array_get(ti->buckets, *bucket);
 283                 hlist_for_each_entry_rcu(flow, head, hash_node[ver]) {
 284                         if (i < *last) {
 285                                 i++;
 286                                 continue;
 287                         }
 288                         *last = i + 1;
 289                         return flow;
 290                 }
 291                 (*bucket)++;
 292                 *last = 0;
 293         }
 294
 295         return NULL;
 296 }
 297
 298 static struct hlist_head *find_bucket(struct table_instance *ti, u32 hash)
 299 {
 300         hash = jhash_1word(hash, ti->hash_seed);
 301         return flex_array_get(ti->buckets,
 302                                 (hash & (ti->n_buckets - 1)));
 303 }
 304
 305 static void table_instance_insert(struct table_instance *ti, struct sw_flow *flow)
 306 {
 307         struct hlist_head *head;
 308
 309         head = find_bucket(ti, flow->hash);
 310         hlist_add_head_rcu(&flow->hash_node[ti->node_ver], head);
 311 }
 312
 313 static void flow_table_copy_flows(struct table_instance *old,
 314                                   struct table_instance *new)
 315 {
 316         int old_ver;
 317         int i;
 318
 319         old_ver = old->node_ver;
 320         new->node_ver = !old_ver;
 321
 322         /* Insert in new table. */
 323         for (i = 0; i < old->n_buckets; i++) {
 324                 struct sw_flow *flow;
 325                 struct hlist_head *head;
 326
 327                 head = flex_array_get(old->buckets, i);
 328
 329                 hlist_for_each_entry(flow, head, hash_node[old_ver])
 330                         table_instance_insert(new, flow);
 331         }
 332
 333         old->keep_flows = true;
 334 }
 335
 336 static struct table_instance *table_instance_rehash(struct table_instance *ti,
 337                                             int n_buckets)
 338 {
 339         struct table_instance *new_ti;
 340
 341         new_ti = table_instance_alloc(n_buckets);
 342         if (!new_ti)
 343                 return NULL;
 344
 345         flow_table_copy_flows(ti, new_ti);
 346
 347         return new_ti;
 348 }
 349
 350 int ovs_flow_tbl_flush(struct flow_table *flow_table)
 351 {
 352         struct table_instance *old_ti;
 353         struct table_instance *new_ti;
 354
 355         old_ti = ovsl_dereference(flow_table->ti);
 356         new_ti = table_instance_alloc(TBL_MIN_BUCKETS);
 357         if (!new_ti)
 358                 return -ENOMEM;
 359
 360         rcu_assign_pointer(flow_table->ti, new_ti);
 361         flow_table->last_rehash = jiffies;
 362         flow_table->count = 0;
 363
 364         table_instance_destroy(old_ti, true);
 365         return 0;
 366 }
 367
 368 static u32 flow_hash(const struct sw_flow_key *key, int key_start,
 369                      int key_end)
 370 {
 371         const u32 *hash_key = (const u32 *)((const u8 *)key + key_start);
 372         int hash_u32s = (key_end - key_start) >> 2;
 373
 374         /* Make sure number of hash bytes are multiple of u32. */
 375         BUILD_BUG_ON(sizeof(long) % sizeof(u32));
 376
 377         return arch_fast_hash2(hash_key, hash_u32s, 0);
 378 }
 379
 380 static int flow_key_start(const struct sw_flow_key *key)
 381 {
 382         if (key->tun_key.ipv4_dst)
 383                 return 0;
 384         else
 385                 return rounddown(offsetof(struct sw_flow_key, phy),
 386                                           sizeof(long));
 387 }
 388
 389 static bool cmp_key(const struct sw_flow_key *key1,
 390                     const struct sw_flow_key *key2,
 391                     int key_start, int key_end)
 392 {
 393         const long *cp1 = (const long *)((const u8 *)key1 + key_start);
 394         const long *cp2 = (const long *)((const u8 *)key2 + key_start);
 395         long diffs = 0;
 396         int i;
 397
 398         for (i = key_start; i < key_end;  i += sizeof(long))
 399                 diffs |= *cp1++ ^ *cp2++;
 400
 401         return diffs == 0;
 402 }
 403
 404 static bool flow_cmp_masked_key(const struct sw_flow *flow,
 405                                 const struct sw_flow_key *key,
 406                                 int key_start, int key_end)
 407 {
 408         return cmp_key(&flow->key, key, key_start, key_end);
 409 }
 410
 411 bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
 412                                struct sw_flow_match *match)
 413 {
 414         struct sw_flow_key *key = match->key;
 415         int key_start = flow_key_start(key);
 416         int key_end = match->range.end;
 417
 418         return cmp_key(&flow->unmasked_key, key, key_start, key_end);
 419 }
 420
 421 static struct sw_flow *masked_flow_lookup(struct table_instance *ti,
 422                                           const struct sw_flow_key *unmasked,
 423                                           struct sw_flow_mask *mask)
 424 {
 425         struct sw_flow *flow;
 426         struct hlist_head *head;
 427         int key_start = mask->range.start;
 428         int key_end = mask->range.end;
 429         u32 hash;
 430         struct sw_flow_key masked_key;
 431
 432         ovs_flow_mask_key(&masked_key, unmasked, mask);
 433         hash = flow_hash(&masked_key, key_start, key_end);
 434         head = find_bucket(ti, hash);
 435         hlist_for_each_entry_rcu(flow, head, hash_node[ti->node_ver]) {
 436                 if (flow->mask == mask && flow->hash == hash &&
 437                     flow_cmp_masked_key(flow, &masked_key,
 438                                           key_start, key_end))
 439                         return flow;
 440         }
 441         return NULL;
 442 }
 443
 444 struct sw_flow *ovs_flow_tbl_lookup_stats(struct flow_table *tbl,
 445                                     const struct sw_flow_key *key,
 446                                     u32 *n_mask_hit)
 447 {
 448         struct table_instance *ti = rcu_dereference_ovsl(tbl->ti);
 449         struct sw_flow_mask *mask;
 450         struct sw_flow *flow;
 451
 452         *n_mask_hit = 0;
 453         list_for_each_entry_rcu(mask, &tbl->mask_list, list) {
 454                 (*n_mask_hit)++;
 455                 flow = masked_flow_lookup(ti, key, mask);
 456                 if (flow)  /* Found */
 457                         return flow;
 458         }
 459         return NULL;
 460 }
 461
 462 struct sw_flow *ovs_flow_tbl_lookup(struct flow_table *tbl,
 463                                     const struct sw_flow_key *key)
 464 {
 465         u32 __always_unused n_mask_hit;
 466
 467         return ovs_flow_tbl_lookup_stats(tbl, key, &n_mask_hit);
 468 }
 469
 470 int ovs_flow_tbl_num_masks(const struct flow_table *table)
 471 {
 472         struct sw_flow_mask *mask;
 473         int num = 0;
 474
 475         list_for_each_entry(mask, &table->mask_list, list)
 476                 num++;
 477
 478         return num;
 479 }
 480
 481 static struct table_instance *table_instance_expand(struct table_instance *ti)
 482 {
 483         return table_instance_rehash(ti, ti->n_buckets * 2);
 484 }
 485
 486 /* Remove 'mask' from the mask list, if it is not needed any more. */
 487 static void flow_mask_remove(struct flow_table *tbl, struct sw_flow_mask *mask)
 488 {
 489         if (mask) {
 490                 /* ovs-lock is required to protect mask-refcount and
 491                  * mask list.
 492                  */
 493                 ASSERT_OVSL();
 494                 BUG_ON(!mask->ref_count);
 495                 mask->ref_count--;
 496
 497                 if (!mask->ref_count) {
 498                         list_del_rcu(&mask->list);
 499                         call_rcu(&mask->rcu, rcu_free_sw_flow_mask_cb);
 500                 }
 501         }
 502 }
 503
 504 /* Must be called with OVS mutex held. */
 505 void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow)
 506 {
 507         struct table_instance *ti = ovsl_dereference(table->ti);
 508
 509         BUG_ON(table->count == 0);
 510         hlist_del_rcu(&flow->hash_node[ti->node_ver]);
 511         table->count--;
 512
 513         /* RCU delete the mask. 'flow->mask' is not NULLed, as it should be
 514          * accessible as long as the RCU read lock is held. */
 515         flow_mask_remove(table, flow->mask);
 516 }
 517
 518 static struct sw_flow_mask *mask_alloc(void)
 519 {
 520         struct sw_flow_mask *mask;
 521
 522         mask = kmalloc(sizeof(*mask), GFP_KERNEL);
 523         if (mask)
 524                 mask->ref_count = 1;
 525
 526         return mask;
 527 }
 528
 529 static bool mask_equal(const struct sw_flow_mask *a,
 530                        const struct sw_flow_mask *b)
 531 {
 532         const u8 *a_ = (const u8 *)&a->key + a->range.start;
 533         const u8 *b_ = (const u8 *)&b->key + b->range.start;
 534
 535         return  (a->range.end == b->range.end)
 536                 && (a->range.start == b->range.start)
 537                 && (memcmp(a_, b_, range_n_bytes(&a->range)) == 0);
 538 }
 539
 540 static struct sw_flow_mask *flow_mask_find(const struct flow_table *tbl,
 541                                            const struct sw_flow_mask *mask)
 542 {
 543         struct list_head *ml;
 544
 545         list_for_each(ml, &tbl->mask_list) {
 546                 struct sw_flow_mask *m;
 547                 m = container_of(ml, struct sw_flow_mask, list);
 548                 if (mask_equal(mask, m))
 549                         return m;
 550         }
 551
 552         return NULL;
 553 }
 554
 555 /* Add 'mask' into the mask list, if it is not already there. */
 556 static int flow_mask_insert(struct flow_table *tbl, struct sw_flow *flow,
 557                             struct sw_flow_mask *new)
 558 {
 559         struct sw_flow_mask *mask;
 560         mask = flow_mask_find(tbl, new);
 561         if (!mask) {
 562                 /* Allocate a new mask if none exsits. */
 563                 mask = mask_alloc();
 564                 if (!mask)
 565                         return -ENOMEM;
 566                 mask->key = new->key;
 567                 mask->range = new->range;
 568                 list_add_rcu(&mask->list, &tbl->mask_list);
 569         } else {
 570                 BUG_ON(!mask->ref_count);
 571                 mask->ref_count++;
 572         }
 573
 574         flow->mask = mask;
 575         return 0;
 576 }
 577
 578 /* Must be called with OVS mutex held. */
 579 int ovs_flow_tbl_insert(struct flow_table *table, struct sw_flow *flow,
 580                         struct sw_flow_mask *mask)
 581 {
 582         struct table_instance *new_ti = NULL;
 583         struct table_instance *ti;
 584         int err;
 585
 586         err = flow_mask_insert(table, flow, mask);
 587         if (err)
 588                 return err;
 589
 590         flow->hash = flow_hash(&flow->key, flow->mask->range.start,
 591                         flow->mask->range.end);
 592         ti = ovsl_dereference(table->ti);
 593         table_instance_insert(ti, flow);
 594         table->count++;
 595
 596         /* Expand table, if necessary, to make room. */
 597         if (table->count > ti->n_buckets)
 598                 new_ti = table_instance_expand(ti);
 599         else if (time_after(jiffies, table->last_rehash + REHASH_INTERVAL))
 600                 new_ti = table_instance_rehash(ti, ti->n_buckets);
 601
 602         if (new_ti) {
 603                 rcu_assign_pointer(table->ti, new_ti);
 604                 table_instance_destroy(ti, true);
 605                 table->last_rehash = jiffies;
 606         }
 607         return 0;
 608 }
 609
 610 /* Initializes the flow module.
 611  * Returns zero if successful or a negative error code. */
 612 int ovs_flow_init(void)
 613 {
 614         BUILD_BUG_ON(__alignof__(struct sw_flow_key) % __alignof__(long));
 615         BUILD_BUG_ON(sizeof(struct sw_flow_key) % sizeof(long));
 616
 617         flow_cache = kmem_cache_create("sw_flow", sizeof(struct sw_flow)
 618                                        + (num_possible_nodes()
 619                                           * sizeof(struct flow_stats *)),
 620                                        0, 0, NULL);
 621         if (flow_cache == NULL)
 622                 return -ENOMEM;
 623
 624         flow_stats_cache
 625                 = kmem_cache_create("sw_flow_stats", sizeof(struct flow_stats),
 626                                     0, SLAB_HWCACHE_ALIGN, NULL);
 627         if (flow_stats_cache == NULL) {
 628                 kmem_cache_destroy(flow_cache);
 629                 flow_cache = NULL;
 630                 return -ENOMEM;
 631         }
 632
 633         return 0;
 634 }
 635
 636 /* Uninitializes the flow module. */
 637 void ovs_flow_exit(void)
 638 {
 639         kmem_cache_destroy(flow_stats_cache);
 640         kmem_cache_destroy(flow_cache);
 641 }