net/openvswitch/flow_table.c

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