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