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