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