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