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