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 MASK_ARRAY_SIZE_MIN     16
  51 #define REHASH_INTERVAL         (10 * 60 * HZ)
  52
  53 #define MC_HASH_SHIFT           8
  54 #define MC_HASH_ENTRIES         (1u << MC_HASH_SHIFT)
  55 #define MC_HASH_SEGS            ((sizeof(uint32_t) * 8) / MC_HASH_SHIFT)
  56
  57 static struct kmem_cache *flow_cache;
  58 struct kmem_cache *flow_stats_cache __read_mostly;
  59
  60 static u16 range_n_bytes(const struct sw_flow_key_range *range)
  61 {
  62         return range->end - range->start;
  63 }
  64
  65 void ovs_flow_mask_key(struct sw_flow_key *dst, const struct sw_flow_key *src,
  66                        const struct sw_flow_mask *mask)
  67 {
  68         const long *m = (const long *)((const u8 *)&mask->key +
  69                                 mask->range.start);
  70         const long *s = (const long *)((const u8 *)src +
  71                                 mask->range.start);
  72         long *d = (long *)((u8 *)dst + mask->range.start);
  73         int i;
  74
  75         /* The memory outside of the 'mask->range' are not set since
  76          * further operations on 'dst' only uses contents within
  77          * 'mask->range'.
  78          */
  79         for (i = 0; i < range_n_bytes(&mask->range); i += sizeof(long))
  80                 *d++ = *s++ & *m++;
  81 }
  82
  83 struct sw_flow *ovs_flow_alloc(void)
  84 {
  85         struct sw_flow *flow;
  86         struct flow_stats *stats;
  87         int node;
  88
  89         flow = kmem_cache_alloc(flow_cache, GFP_KERNEL);
  90         if (!flow)
  91                 return ERR_PTR(-ENOMEM);
  92
  93         flow->sf_acts = NULL;
  94         flow->mask = NULL;
  95         flow->stats_last_writer = NUMA_NO_NODE;
  96
  97         /* Initialize the default stat node. */
  98         stats = kmem_cache_alloc_node(flow_stats_cache,
  99                                       GFP_KERNEL | __GFP_ZERO, 0);
 100         if (!stats)
 101                 goto err;
 102
 103         spin_lock_init(&stats->lock);
 104
 105         RCU_INIT_POINTER(flow->stats[0], stats);
 106
 107         for_each_node(node)
 108                 if (node != 0)
 109                         RCU_INIT_POINTER(flow->stats[node], NULL);
 110
 111         return flow;
 112 err:
 113         kmem_cache_free(flow_cache, flow);
 114         return ERR_PTR(-ENOMEM);
 115 }
 116
 117 int ovs_flow_tbl_count(struct flow_table *table)
 118 {
 119         return table->count;
 120 }
 121
 122 static struct flex_array *alloc_buckets(unsigned int n_buckets)
 123 {
 124         struct flex_array *buckets;
 125         int i, err;
 126
 127         buckets = flex_array_alloc(sizeof(struct hlist_head),
 128                                    n_buckets, GFP_KERNEL);
 129         if (!buckets)
 130                 return NULL;
 131
 132         err = flex_array_prealloc(buckets, 0, n_buckets, GFP_KERNEL);
 133         if (err) {
 134                 flex_array_free(buckets);
 135                 return NULL;
 136         }
 137
 138         for (i = 0; i < n_buckets; i++)
 139                 INIT_HLIST_HEAD((struct hlist_head *)
 140                                         flex_array_get(buckets, i));
 141
 142         return buckets;
 143 }
 144
 145 static void flow_free(struct sw_flow *flow)
 146 {
 147         int node;
 148
 149         kfree((struct sw_flow_actions __force *)flow->sf_acts);
 150         for_each_node(node)
 151                 if (flow->stats[node])
 152                         kmem_cache_free(flow_stats_cache,
 153                                         (struct flow_stats __force *)flow->stats[node]);
 154         kmem_cache_free(flow_cache, flow);
 155 }
 156
 157 static void rcu_free_flow_callback(struct rcu_head *rcu)
 158 {
 159         struct sw_flow *flow = container_of(rcu, struct sw_flow, rcu);
 160
 161         flow_free(flow);
 162 }
 163
 164 static void rcu_free_sw_flow_mask_cb(struct rcu_head *rcu)
 165 {
 166         struct sw_flow_mask *mask = container_of(rcu, struct sw_flow_mask, rcu);
 167
 168         kfree(mask);
 169 }
 170
 171 void ovs_flow_free(struct sw_flow *flow, bool deferred)
 172 {
 173         if (!flow)
 174                 return;
 175
 176         if (deferred)
 177                 call_rcu(&flow->rcu, rcu_free_flow_callback);
 178         else
 179                 flow_free(flow);
 180 }
 181
 182 static void free_buckets(struct flex_array *buckets)
 183 {
 184         flex_array_free(buckets);
 185 }
 186
 187
 188 static void __table_instance_destroy(struct table_instance *ti)
 189 {
 190         free_buckets(ti->buckets);
 191         kfree(ti);
 192 }
 193
 194 static struct table_instance *table_instance_alloc(int new_size)
 195 {
 196         struct table_instance *ti = kmalloc(sizeof(*ti), GFP_KERNEL);
 197
 198         if (!ti)
 199                 return NULL;
 200
 201         ti->buckets = alloc_buckets(new_size);
 202
 203         if (!ti->buckets) {
 204                 kfree(ti);
 205                 return NULL;
 206         }
 207         ti->n_buckets = new_size;
 208         ti->node_ver = 0;
 209         ti->keep_flows = false;
 210         get_random_bytes(&ti->hash_seed, sizeof(u32));
 211
 212         return ti;
 213 }
 214
 215 static void mask_array_rcu_cb(struct rcu_head *rcu)
 216 {
 217         struct mask_array *ma = container_of(rcu, struct mask_array, rcu);
 218
 219         kfree(ma);
 220 }
 221
 222 static struct mask_array *tbl_mask_array_alloc(int size)
 223 {
 224         struct mask_array *new;
 225
 226         size = max(MASK_ARRAY_SIZE_MIN, size);
 227         new = kzalloc(sizeof(struct mask_array) +
 228                       sizeof(struct sw_flow_mask *) * size, GFP_KERNEL);
 229         if (!new)
 230                 return NULL;
 231
 232         new->count = 0;
 233         new->max = size;
 234
 235         return new;
 236 }
 237
 238 static int tbl_mask_array_realloc(struct flow_table *tbl, int size)
 239 {
 240         struct mask_array *old;
 241         struct mask_array *new;
 242
 243         new = tbl_mask_array_alloc(size);
 244         if (!new)
 245                 return -ENOMEM;
 246
 247         old = ovsl_dereference(tbl->mask_array);
 248         if (old) {
 249                 int i, count = 0;
 250
 251                 for (i = 0; i < old->max; i++) {
 252                         if (ovsl_dereference(old->masks[i]))
 253                                 new->masks[count++] = old->masks[i];
 254                 }
 255
 256                 new->count = count;
 257         }
 258         rcu_assign_pointer(tbl->mask_array, new);
 259
 260         if (old)
 261                 call_rcu(&old->rcu, mask_array_rcu_cb);
 262
 263         return 0;
 264 }
 265
 266 int ovs_flow_tbl_init(struct flow_table *table)
 267 {
 268         struct table_instance *ti;
 269         struct mask_array *ma;
 270
 271         table->mask_cache = __alloc_percpu(sizeof(struct mask_cache_entry) *
 272                                           MC_HASH_ENTRIES, __alignof__(struct mask_cache_entry));
 273         if (!table->mask_cache)
 274                 return -ENOMEM;
 275
 276         ma = tbl_mask_array_alloc(MASK_ARRAY_SIZE_MIN);
 277         if (!ma)
 278                 goto free_mask_cache;
 279
 280         ti = table_instance_alloc(TBL_MIN_BUCKETS);
 281         if (!ti)
 282                 goto free_mask_array;
 283
 284         rcu_assign_pointer(table->ti, ti);
 285         rcu_assign_pointer(table->mask_array, ma);
 286         table->last_rehash = jiffies;
 287         table->count = 0;
 288         return 0;
 289
 290 free_mask_array:
 291         kfree(ma);
 292 free_mask_cache:
 293         free_percpu(table->mask_cache);
 294         return -ENOMEM;
 295 }
 296
 297 static void flow_tbl_destroy_rcu_cb(struct rcu_head *rcu)
 298 {
 299         struct table_instance *ti = container_of(rcu, struct table_instance, rcu);
 300
 301         __table_instance_destroy(ti);
 302 }
 303
 304 static void table_instance_destroy(struct table_instance *ti, bool deferred)
 305 {
 306         int i;
 307
 308         if (!ti)
 309                 return;
 310
 311         if (ti->keep_flows)
 312                 goto skip_flows;
 313
 314         for (i = 0; i < ti->n_buckets; i++) {
 315                 struct sw_flow *flow;
 316                 struct hlist_head *head = flex_array_get(ti->buckets, i);
 317                 struct hlist_node *n;
 318                 int ver = ti->node_ver;
 319
 320                 hlist_for_each_entry_safe(flow, n, head, hash_node[ver]) {
 321                         hlist_del_rcu(&flow->hash_node[ver]);
 322                         ovs_flow_free(flow, deferred);
 323                 }
 324         }
 325
 326 skip_flows:
 327         if (deferred)
 328                 call_rcu(&ti->rcu, flow_tbl_destroy_rcu_cb);
 329         else
 330                 __table_instance_destroy(ti);
 331 }
 332
 333 /* No need for locking this function is called from RCU callback or
 334  * error path. */
 335 void ovs_flow_tbl_destroy(struct flow_table *table)
 336 {
 337         struct table_instance *ti = (struct table_instance __force *)table->ti;
 338
 339         free_percpu(table->mask_cache);
 340         kfree((struct mask_array __force *)table->mask_array);
 341         table_instance_destroy(ti, false);
 342 }
 343
 344 struct sw_flow *ovs_flow_tbl_dump_next(struct table_instance *ti,
 345                                        u32 *bucket, u32 *last)
 346 {
 347         struct sw_flow *flow;
 348         struct hlist_head *head;
 349         int ver;
 350         int i;
 351
 352         ver = ti->node_ver;
 353         while (*bucket < ti->n_buckets) {
 354                 i = 0;
 355                 head = flex_array_get(ti->buckets, *bucket);
 356                 hlist_for_each_entry_rcu(flow, head, hash_node[ver]) {
 357                         if (i < *last) {
 358                                 i++;
 359                                 continue;
 360                         }
 361                         *last = i + 1;
 362                         return flow;
 363                 }
 364                 (*bucket)++;
 365                 *last = 0;
 366         }
 367
 368         return NULL;
 369 }
 370
 371 static struct hlist_head *find_bucket(struct table_instance *ti, u32 hash)
 372 {
 373         hash = jhash_1word(hash, ti->hash_seed);
 374         return flex_array_get(ti->buckets,
 375                                 (hash & (ti->n_buckets - 1)));
 376 }
 377
 378 static void table_instance_insert(struct table_instance *ti, struct sw_flow *flow)
 379 {
 380         struct hlist_head *head;
 381
 382         head = find_bucket(ti, flow->hash);
 383         hlist_add_head_rcu(&flow->hash_node[ti->node_ver], head);
 384 }
 385
 386 static void flow_table_copy_flows(struct table_instance *old,
 387                                   struct table_instance *new)
 388 {
 389         int old_ver;
 390         int i;
 391
 392         old_ver = old->node_ver;
 393         new->node_ver = !old_ver;
 394
 395         /* Insert in new table. */
 396         for (i = 0; i < old->n_buckets; i++) {
 397                 struct sw_flow *flow;
 398                 struct hlist_head *head;
 399
 400                 head = flex_array_get(old->buckets, i);
 401
 402                 hlist_for_each_entry(flow, head, hash_node[old_ver])
 403                         table_instance_insert(new, flow);
 404         }
 405
 406         old->keep_flows = true;
 407 }
 408
 409 static struct table_instance *table_instance_rehash(struct table_instance *ti,
 410                                             int n_buckets)
 411 {
 412         struct table_instance *new_ti;
 413
 414         new_ti = table_instance_alloc(n_buckets);
 415         if (!new_ti)
 416                 return NULL;
 417
 418         flow_table_copy_flows(ti, new_ti);
 419
 420         return new_ti;
 421 }
 422
 423 int ovs_flow_tbl_flush(struct flow_table *flow_table)
 424 {
 425         struct table_instance *old_ti;
 426         struct table_instance *new_ti;
 427
 428         old_ti = ovsl_dereference(flow_table->ti);
 429         new_ti = table_instance_alloc(TBL_MIN_BUCKETS);
 430         if (!new_ti)
 431                 return -ENOMEM;
 432
 433         rcu_assign_pointer(flow_table->ti, new_ti);
 434         flow_table->last_rehash = jiffies;
 435         flow_table->count = 0;
 436
 437         table_instance_destroy(old_ti, true);
 438         return 0;
 439 }
 440
 441 static u32 flow_hash(const struct sw_flow_key *key, int key_start,
 442                      int key_end)
 443 {
 444         const u32 *hash_key = (const u32 *)((const u8 *)key + key_start);
 445         int hash_u32s = (key_end - key_start) >> 2;
 446
 447         /* Make sure number of hash bytes are multiple of u32. */
 448         BUILD_BUG_ON(sizeof(long) % sizeof(u32));
 449
 450         return arch_fast_hash2(hash_key, hash_u32s, 0);
 451 }
 452
 453 static int flow_key_start(const struct sw_flow_key *key)
 454 {
 455         if (key->tun_key.ipv4_dst)
 456                 return 0;
 457         else
 458                 return rounddown(offsetof(struct sw_flow_key, phy),
 459                                           sizeof(long));
 460 }
 461
 462 static bool cmp_key(const struct sw_flow_key *key1,
 463                     const struct sw_flow_key *key2,
 464                     int key_start, int key_end)
 465 {
 466         const long *cp1 = (const long *)((const u8 *)key1 + key_start);
 467         const long *cp2 = (const long *)((const u8 *)key2 + key_start);
 468         long diffs = 0;
 469         int i;
 470
 471         for (i = key_start; i < key_end;  i += sizeof(long))
 472                 diffs |= *cp1++ ^ *cp2++;
 473
 474         return diffs == 0;
 475 }
 476
 477 static bool flow_cmp_masked_key(const struct sw_flow *flow,
 478                                 const struct sw_flow_key *key,
 479                                 int key_start, int key_end)
 480 {
 481         return cmp_key(&flow->key, key, key_start, key_end);
 482 }
 483
 484 bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
 485                                struct sw_flow_match *match)
 486 {
 487         struct sw_flow_key *key = match->key;
 488         int key_start = flow_key_start(key);
 489         int key_end = match->range.end;
 490
 491         return cmp_key(&flow->unmasked_key, key, key_start, key_end);
 492 }
 493
 494 static struct sw_flow *masked_flow_lookup(struct table_instance *ti,
 495                                           const struct sw_flow_key *unmasked,
 496                                           struct sw_flow_mask *mask,
 497                                           u32 *n_mask_hit)
 498 {
 499         struct sw_flow *flow;
 500         struct hlist_head *head;
 501         int key_start = mask->range.start;
 502         int key_end = mask->range.end;
 503         u32 hash;
 504         struct sw_flow_key masked_key;
 505
 506         ovs_flow_mask_key(&masked_key, unmasked, mask);
 507         hash = flow_hash(&masked_key, key_start, key_end);
 508         head = find_bucket(ti, hash);
 509         (*n_mask_hit)++;
 510         hlist_for_each_entry_rcu(flow, head, hash_node[ti->node_ver]) {
 511                 if (flow->mask == mask && flow->hash == hash &&
 512                     flow_cmp_masked_key(flow, &masked_key,
 513                                           key_start, key_end))
 514                         return flow;
 515         }
 516         return NULL;
 517 }
 518
 519 /* Flow lookup does full lookup on flow table. It starts with
 520  * mask from index passed in *index.
 521  */
 522 static struct sw_flow *flow_lookup(struct flow_table *tbl,
 523                                    struct table_instance *ti,
 524                                    struct mask_array *ma,
 525                                    const struct sw_flow_key *key,
 526                                    u32 *n_mask_hit,
 527                                    u32 *index)
 528 {
 529         struct sw_flow_mask *mask;
 530         struct sw_flow *flow;
 531         int i;
 532
 533         if (*index < ma->max) {
 534                 mask = rcu_dereference_ovsl(ma->masks[*index]);
 535                 if (mask) {
 536                         flow = masked_flow_lookup(ti, key, mask, n_mask_hit);
 537                         if (flow)
 538                                 return flow;
 539                 }
 540         }
 541
 542         for (i = 0; i < ma->max; i++)  {
 543
 544                 if (i == *index)
 545                         continue;
 546
 547                 mask = rcu_dereference_ovsl(ma->masks[i]);
 548                 if (!mask)
 549                         continue;
 550
 551                 flow = masked_flow_lookup(ti, key, mask, n_mask_hit);
 552                 if (flow) { /* Found */
 553                         *index = i;
 554                         return flow;
 555                 }
 556         }
 557
 558         return NULL;
 559 }
 560
 561 /*
 562  * mask_cache maps flow to probable mask. This cache is not tightly
 563  * coupled cache, It means updates to  mask list can result in inconsistent
 564  * cache entry in mask cache.
 565  * This is per cpu cache and is divided in MC_HASH_SEGS segments.
 566  * In case of a hash collision the entry is hashed in next segment.
 567  * */
 568 struct sw_flow *ovs_flow_tbl_lookup_stats(struct flow_table *tbl,
 569                                           const struct sw_flow_key *key,
 570                                           u32 skb_hash,
 571                                           u32 *n_mask_hit)
 572 {
 573         struct mask_array *ma = rcu_dereference(tbl->mask_array);
 574         struct table_instance *ti = rcu_dereference(tbl->ti);
 575         struct mask_cache_entry *entries, *ce;
 576         struct sw_flow *flow;
 577         u32 hash = skb_hash;
 578         int seg;
 579
 580         *n_mask_hit = 0;
 581         if (unlikely(!skb_hash)) {
 582                 u32 mask_index = 0;
 583
 584                 return flow_lookup(tbl, ti, ma, key, n_mask_hit, &mask_index);
 585         }
 586
 587         ce = NULL;
 588         entries = this_cpu_ptr(tbl->mask_cache);
 589
 590         /* Find the cache entry 'ce' to operate on. */
 591         for (seg = 0; seg < MC_HASH_SEGS; seg++) {
 592                 int index = hash & (MC_HASH_ENTRIES - 1);
 593                 struct mask_cache_entry *e;
 594
 595                 e = &entries[index];
 596                 if (e->skb_hash == skb_hash) {
 597                         flow = flow_lookup(tbl, ti, ma, key, n_mask_hit,
 598                                            &e->mask_index);
 599                         if (!flow)
 600                                 e->skb_hash = 0;
 601                         return flow;
 602                 }
 603
 604                 if (!ce || e->skb_hash < ce->skb_hash)
 605                         ce = e;  /* A better replacement cache candidate. */
 606
 607                 hash >>= MC_HASH_SHIFT;
 608         }
 609
 610         /* Cache miss, do full lookup. */
 611         flow = flow_lookup(tbl, ti, ma, key, n_mask_hit, &ce->mask_index);
 612         if (flow)
 613                 ce->skb_hash = skb_hash;
 614
 615         return flow;
 616 }
 617
 618 struct sw_flow *ovs_flow_tbl_lookup(struct flow_table *tbl,
 619                                     const struct sw_flow_key *key)
 620 {
 621         struct table_instance *ti = rcu_dereference_ovsl(tbl->ti);
 622         struct mask_array *ma = rcu_dereference_ovsl(tbl->mask_array);
 623         u32 __always_unused n_mask_hit;
 624         u32 index = 0;
 625
 626         return flow_lookup(tbl, ti, ma, key, &n_mask_hit, &index);
 627 }
 628
 629 struct sw_flow *ovs_flow_tbl_lookup_exact(struct flow_table *tbl,
 630                                           struct sw_flow_match *match)
 631 {
 632         struct mask_array *ma = ovsl_dereference(tbl->mask_array);
 633         int i;
 634
 635         /* Always called under ovs-mutex. */
 636         for (i = 0; i < ma->max; i++) {
 637                 struct table_instance *ti = ovsl_dereference(tbl->ti);
 638                 u32 __always_unused n_mask_hit;
 639                 struct sw_flow_mask *mask;
 640                 struct sw_flow *flow;
 641
 642                 mask = ovsl_dereference(ma->masks[i]);
 643                 if (!mask)
 644                         continue;
 645                 flow = masked_flow_lookup(ti, match->key, mask, &n_mask_hit);
 646                 if (flow && ovs_flow_cmp_unmasked_key(flow, match))
 647                         return flow;
 648         }
 649         return NULL;
 650 }
 651
 652 int ovs_flow_tbl_num_masks(const struct flow_table *table)
 653 {
 654         struct mask_array *ma;
 655
 656         ma = rcu_dereference_ovsl(table->mask_array);
 657         return ma->count;
 658 }
 659
 660 static struct table_instance *table_instance_expand(struct table_instance *ti)
 661 {
 662         return table_instance_rehash(ti, ti->n_buckets * 2);
 663 }
 664
 665 static void tbl_mask_array_delete_mask(struct mask_array *ma,
 666                                        struct sw_flow_mask *mask)
 667 {
 668         int i;
 669
 670         /* Remove the deleted mask pointers from the array */
 671         for (i = 0; i < ma->max; i++) {
 672                 if (mask == ovsl_dereference(ma->masks[i])) {
 673                         RCU_INIT_POINTER(ma->masks[i], NULL);
 674                         ma->count--;
 675                         call_rcu(&mask->rcu, rcu_free_sw_flow_mask_cb);
 676                         return;
 677                 }
 678         }
 679         BUG();
 680 }
 681
 682 /* Remove 'mask' from the mask list, if it is not needed any more. */
 683 static void flow_mask_remove(struct flow_table *tbl, struct sw_flow_mask *mask)
 684 {
 685         if (mask) {
 686                 /* ovs-lock is required to protect mask-refcount and
 687                  * mask list.
 688                  */
 689                 ASSERT_OVSL();
 690                 BUG_ON(!mask->ref_count);
 691                 mask->ref_count--;
 692
 693                 if (!mask->ref_count) {
 694                         struct mask_array *ma;
 695
 696                         ma = ovsl_dereference(tbl->mask_array);
 697                         tbl_mask_array_delete_mask(ma, mask);
 698
 699                         /* Shrink the mask array if necessary. */
 700                         if (ma->max >= (MASK_ARRAY_SIZE_MIN * 2) &&
 701                             ma->count <= (ma->max / 3))
 702                                 tbl_mask_array_realloc(tbl, ma->max / 2);
 703
 704                 }
 705         }
 706 }
 707
 708 /* Must be called with OVS mutex held. */
 709 void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow)
 710 {
 711         struct table_instance *ti = ovsl_dereference(table->ti);
 712
 713         BUG_ON(table->count == 0);
 714         hlist_del_rcu(&flow->hash_node[ti->node_ver]);
 715         table->count--;
 716
 717         /* RCU delete the mask. 'flow->mask' is not NULLed, as it should be
 718          * accessible as long as the RCU read lock is held. */
 719         flow_mask_remove(table, flow->mask);
 720 }
 721
 722 static struct sw_flow_mask *mask_alloc(void)
 723 {
 724         struct sw_flow_mask *mask;
 725
 726         mask = kmalloc(sizeof(*mask), GFP_KERNEL);
 727         if (mask)
 728                 mask->ref_count = 1;
 729
 730         return mask;
 731 }
 732
 733 static bool mask_equal(const struct sw_flow_mask *a,
 734                        const struct sw_flow_mask *b)
 735 {
 736         const u8 *a_ = (const u8 *)&a->key + a->range.start;
 737         const u8 *b_ = (const u8 *)&b->key + b->range.start;
 738
 739         return  (a->range.end == b->range.end)
 740                 && (a->range.start == b->range.start)
 741                 && (memcmp(a_, b_, range_n_bytes(&a->range)) == 0);
 742 }
 743
 744 static struct sw_flow_mask *flow_mask_find(const struct flow_table *tbl,
 745                                            const struct sw_flow_mask *mask)
 746 {
 747         struct mask_array *ma;
 748         int i;
 749
 750         ma = ovsl_dereference(tbl->mask_array);
 751         for (i = 0; i < ma->max; i++) {
 752                 struct sw_flow_mask *t;
 753
 754                 t = ovsl_dereference(ma->masks[i]);
 755                 if (t && mask_equal(mask, t))
 756                         return t;
 757         }
 758
 759         return NULL;
 760 }
 761
 762 /* Add 'mask' into the mask list, if it is not already there. */
 763 static int flow_mask_insert(struct flow_table *tbl, struct sw_flow *flow,
 764                             struct sw_flow_mask *new)
 765 {
 766         struct sw_flow_mask *mask;
 767
 768         mask = flow_mask_find(tbl, new);
 769         if (!mask) {
 770                 struct mask_array *ma;
 771                 int i;
 772
 773                 /* Allocate a new mask if none exsits. */
 774                 mask = mask_alloc();
 775                 if (!mask)
 776                         return -ENOMEM;
 777
 778                 mask->key = new->key;
 779                 mask->range = new->range;
 780
 781                 /* Add mask to mask-list. */
 782                 ma = ovsl_dereference(tbl->mask_array);
 783                 if (ma->count >= ma->max) {
 784                         int err;
 785
 786                         err = tbl_mask_array_realloc(tbl, ma->max +
 787                                                           MASK_ARRAY_SIZE_MIN);
 788                         if (err) {
 789                                 kfree(mask);
 790                                 return err;
 791                         }
 792                         ma = ovsl_dereference(tbl->mask_array);
 793                 }
 794
 795                 for (i = 0; i < ma->max; i++) {
 796                         struct sw_flow_mask *t;
 797
 798                         t = ovsl_dereference(ma->masks[i]);
 799                         if (!t) {
 800                                 rcu_assign_pointer(ma->masks[i], mask);
 801                                 ma->count++;
 802                                 break;
 803                         }
 804                 }
 805
 806         } else {
 807                 BUG_ON(!mask->ref_count);
 808                 mask->ref_count++;
 809         }
 810
 811         flow->mask = mask;
 812         return 0;
 813 }
 814
 815 /* Must be called with OVS mutex held. */
 816 int ovs_flow_tbl_insert(struct flow_table *table, struct sw_flow *flow,
 817                         struct sw_flow_mask *mask)
 818 {
 819         struct table_instance *new_ti = NULL;
 820         struct table_instance *ti;
 821         int err;
 822
 823         err = flow_mask_insert(table, flow, mask);
 824         if (err)
 825                 return err;
 826
 827         flow->hash = flow_hash(&flow->key, flow->mask->range.start,
 828                         flow->mask->range.end);
 829         ti = ovsl_dereference(table->ti);
 830         table_instance_insert(ti, flow);
 831         table->count++;
 832
 833         /* Expand table, if necessary, to make room. */
 834         if (table->count > ti->n_buckets)
 835                 new_ti = table_instance_expand(ti);
 836         else if (time_after(jiffies, table->last_rehash + REHASH_INTERVAL))
 837                 new_ti = table_instance_rehash(ti, ti->n_buckets);
 838
 839         if (new_ti) {
 840                 rcu_assign_pointer(table->ti, new_ti);
 841                 table_instance_destroy(ti, true);
 842                 table->last_rehash = jiffies;
 843         }
 844         return 0;
 845 }
 846
 847 /* Initializes the flow module.
 848  * Returns zero if successful or a negative error code. */
 849 int ovs_flow_init(void)
 850 {
 851         BUILD_BUG_ON(__alignof__(struct sw_flow_key) % __alignof__(long));
 852         BUILD_BUG_ON(sizeof(struct sw_flow_key) % sizeof(long));
 853
 854         flow_cache = kmem_cache_create("sw_flow", sizeof(struct sw_flow)
 855                                        + (num_possible_nodes()
 856                                           * sizeof(struct flow_stats *)),
 857                                        0, 0, NULL);
 858         if (flow_cache == NULL)
 859                 return -ENOMEM;
 860
 861         flow_stats_cache
 862                 = kmem_cache_create("sw_flow_stats", sizeof(struct flow_stats),
 863                                     0, SLAB_HWCACHE_ALIGN, NULL);
 864         if (flow_stats_cache == NULL) {
 865                 kmem_cache_destroy(flow_cache);
 866                 flow_cache = NULL;
 867                 return -ENOMEM;
 868         }
 869
 870         return 0;
 871 }
 872
 873 /* Uninitializes the flow module. */
 874 void ovs_flow_exit(void)
 875 {
 876         kmem_cache_destroy(flow_stats_cache);
 877         kmem_cache_destroy(flow_cache);
 878 }