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