net/netfilter/xt_hashlimit.c

   1 /*
   2  *      xt_hashlimit - Netfilter module to limit the number of packets per time
   3  *      separately for each hashbucket (sourceip/sourceport/dstip/dstport)
   4  *
   5  *      (C) 2003-2004 by Harald Welte <laforge@netfilter.org>
   6  *      (C) 2006-2012 Patrick McHardy <kaber@trash.net>
   7  *      Copyright © CC Computer Consultants GmbH, 2007 - 2008
   8  *
   9  * Development of this code was funded by Astaro AG, http://www.astaro.com/
  10  */
  11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  12 #include <linux/module.h>
  13 #include <linux/spinlock.h>
  14 #include <linux/random.h>
  15 #include <linux/jhash.h>
  16 #include <linux/slab.h>
  17 #include <linux/vmalloc.h>
  18 #include <linux/proc_fs.h>
  19 #include <linux/seq_file.h>
  20 #include <linux/list.h>
  21 #include <linux/skbuff.h>
  22 #include <linux/mm.h>
  23 #include <linux/in.h>
  24 #include <linux/ip.h>
  25 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
  26 #include <linux/ipv6.h>
  27 #include <net/ipv6.h>
  28 #endif
  29
  30 #include <net/net_namespace.h>
  31 #include <net/netns/generic.h>
  32
  33 #include <linux/netfilter/x_tables.h>
  34 #include <linux/netfilter_ipv4/ip_tables.h>
  35 #include <linux/netfilter_ipv6/ip6_tables.h>
  36 #include <linux/netfilter/xt_hashlimit.h>
  37 #include <linux/mutex.h>
  38
  39 MODULE_LICENSE("GPL");
  40 MODULE_AUTHOR("Harald Welte <laforge@netfilter.org>");
  41 MODULE_AUTHOR("Jan Engelhardt <jengelh@medozas.de>");
  42 MODULE_DESCRIPTION("Xtables: per hash-bucket rate-limit match");
  43 MODULE_ALIAS("ipt_hashlimit");
  44 MODULE_ALIAS("ip6t_hashlimit");
  45
  46 struct hashlimit_net {
  47         struct hlist_head       htables;
  48         struct proc_dir_entry   *ipt_hashlimit;
  49         struct proc_dir_entry   *ip6t_hashlimit;
  50 };
  51
  52 static int hashlimit_net_id;
  53 static inline struct hashlimit_net *hashlimit_pernet(struct net *net)
  54 {
  55         return net_generic(net, hashlimit_net_id);
  56 }
  57
  58 /* need to declare this at the top */
  59 static const struct file_operations dl_file_ops_v1;
  60 static const struct file_operations dl_file_ops;
  61
  62 /* hash table crap */
  63 struct dsthash_dst {
  64         union {
  65                 struct {
  66                         __be32 src;
  67                         __be32 dst;
  68                 } ip;
  69 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
  70                 struct {
  71                         __be32 src[4];
  72                         __be32 dst[4];
  73                 } ip6;
  74 #endif
  75         };
  76         __be16 src_port;
  77         __be16 dst_port;
  78 };
  79
  80 struct dsthash_ent {
  81         /* static / read-only parts in the beginning */
  82         struct hlist_node node;
  83         struct dsthash_dst dst;
  84
  85         /* modified structure members in the end */
  86         spinlock_t lock;
  87         unsigned long expires;          /* precalculated expiry time */
  88         struct {
  89                 unsigned long prev;     /* last modification */
  90                 u_int64_t credit;
  91                 u_int64_t credit_cap, cost;
  92         } rateinfo;
  93         struct rcu_head rcu;
  94 };
  95
  96 struct xt_hashlimit_htable {
  97         struct hlist_node node;         /* global list of all htables */
  98         int use;
  99         u_int8_t family;
 100         bool rnd_initialized;
 101
 102         struct hashlimit_cfg2 cfg;      /* config */
 103
 104         /* used internally */
 105         spinlock_t lock;                /* lock for list_head */
 106         u_int32_t rnd;                  /* random seed for hash */
 107         unsigned int count;             /* number entries in table */
 108         struct delayed_work gc_work;
 109
 110         /* seq_file stuff */
 111         struct proc_dir_entry *pde;
 112         const char *name;
 113         struct net *net;
 114
 115         struct hlist_head hash[0];      /* hashtable itself */
 116 };
 117
 118 static int
 119 cfg_copy(struct hashlimit_cfg2 *to, void *from, int revision)
 120 {
 121         if (revision == 1) {
 122                 struct hashlimit_cfg1 *cfg = (struct hashlimit_cfg1 *)from;
 123
 124                 to->mode = cfg->mode;
 125                 to->avg = cfg->avg;
 126                 to->burst = cfg->burst;
 127                 to->size = cfg->size;
 128                 to->max = cfg->max;
 129                 to->gc_interval = cfg->gc_interval;
 130                 to->expire = cfg->expire;
 131                 to->srcmask = cfg->srcmask;
 132                 to->dstmask = cfg->dstmask;
 133         } else if (revision == 2) {
 134                 memcpy(to, from, sizeof(struct hashlimit_cfg2));
 135         } else {
 136                 return -EINVAL;
 137         }
 138
 139         return 0;
 140 }
 141
 142 static DEFINE_MUTEX(hashlimit_mutex);   /* protects htables list */
 143 static struct kmem_cache *hashlimit_cachep __read_mostly;
 144
 145 static inline bool dst_cmp(const struct dsthash_ent *ent,
 146                            const struct dsthash_dst *b)
 147 {
 148         return !memcmp(&ent->dst, b, sizeof(ent->dst));
 149 }
 150
 151 static u_int32_t
 152 hash_dst(const struct xt_hashlimit_htable *ht, const struct dsthash_dst *dst)
 153 {
 154         u_int32_t hash = jhash2((const u32 *)dst,
 155                                 sizeof(*dst)/sizeof(u32),
 156                                 ht->rnd);
 157         /*
 158          * Instead of returning hash % ht->cfg.size (implying a divide)
 159          * we return the high 32 bits of the (hash * ht->cfg.size) that will
 160          * give results between [0 and cfg.size-1] and same hash distribution,
 161          * but using a multiply, less expensive than a divide
 162          */
 163         return reciprocal_scale(hash, ht->cfg.size);
 164 }
 165
 166 static struct dsthash_ent *
 167 dsthash_find(const struct xt_hashlimit_htable *ht,
 168              const struct dsthash_dst *dst)
 169 {
 170         struct dsthash_ent *ent;
 171         u_int32_t hash = hash_dst(ht, dst);
 172
 173         if (!hlist_empty(&ht->hash[hash])) {
 174                 hlist_for_each_entry_rcu(ent, &ht->hash[hash], node)
 175                         if (dst_cmp(ent, dst)) {
 176                                 spin_lock(&ent->lock);
 177                                 return ent;
 178                         }
 179         }
 180         return NULL;
 181 }
 182
 183 /* allocate dsthash_ent, initialize dst, put in htable and lock it */
 184 static struct dsthash_ent *
 185 dsthash_alloc_init(struct xt_hashlimit_htable *ht,
 186                    const struct dsthash_dst *dst, bool *race)
 187 {
 188         struct dsthash_ent *ent;
 189
 190         spin_lock(&ht->lock);
 191
 192         /* Two or more packets may race to create the same entry in the
 193          * hashtable, double check if this packet lost race.
 194          */
 195         ent = dsthash_find(ht, dst);
 196         if (ent != NULL) {
 197                 spin_unlock(&ht->lock);
 198                 *race = true;
 199                 return ent;
 200         }
 201
 202         /* initialize hash with random val at the time we allocate
 203          * the first hashtable entry */
 204         if (unlikely(!ht->rnd_initialized)) {
 205                 get_random_bytes(&ht->rnd, sizeof(ht->rnd));
 206                 ht->rnd_initialized = true;
 207         }
 208
 209         if (ht->cfg.max && ht->count >= ht->cfg.max) {
 210                 /* FIXME: do something. question is what.. */
 211                 net_err_ratelimited("max count of %u reached\n", ht->cfg.max);
 212                 ent = NULL;
 213         } else
 214                 ent = kmem_cache_alloc(hashlimit_cachep, GFP_ATOMIC);
 215         if (ent) {
 216                 memcpy(&ent->dst, dst, sizeof(ent->dst));
 217                 spin_lock_init(&ent->lock);
 218
 219                 spin_lock(&ent->lock);
 220                 hlist_add_head_rcu(&ent->node, &ht->hash[hash_dst(ht, dst)]);
 221                 ht->count++;
 222         }
 223         spin_unlock(&ht->lock);
 224         return ent;
 225 }
 226
 227 static void dsthash_free_rcu(struct rcu_head *head)
 228 {
 229         struct dsthash_ent *ent = container_of(head, struct dsthash_ent, rcu);
 230
 231         kmem_cache_free(hashlimit_cachep, ent);
 232 }
 233
 234 static inline void
 235 dsthash_free(struct xt_hashlimit_htable *ht, struct dsthash_ent *ent)
 236 {
 237         hlist_del_rcu(&ent->node);
 238         call_rcu_bh(&ent->rcu, dsthash_free_rcu);
 239         ht->count--;
 240 }
 241 static void htable_gc(struct work_struct *work);
 242
 243 static int htable_create(struct net *net, struct hashlimit_cfg2 *cfg,
 244                          const char *name, u_int8_t family,
 245                          struct xt_hashlimit_htable **out_hinfo,
 246                          int revision)
 247 {
 248         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 249         struct xt_hashlimit_htable *hinfo;
 250         unsigned int size, i;
 251         int ret;
 252
 253         if (cfg->size) {
 254                 size = cfg->size;
 255         } else {
 256                 size = (totalram_pages << PAGE_SHIFT) / 16384 /
 257                        sizeof(struct list_head);
 258                 if (totalram_pages > 1024 * 1024 * 1024 / PAGE_SIZE)
 259                         size = 8192;
 260                 if (size < 16)
 261                         size = 16;
 262         }
 263         /* FIXME: don't use vmalloc() here or anywhere else -HW */
 264         hinfo = vmalloc(sizeof(struct xt_hashlimit_htable) +
 265                         sizeof(struct list_head) * size);
 266         if (hinfo == NULL)
 267                 return -ENOMEM;
 268         *out_hinfo = hinfo;
 269
 270         /* copy match config into hashtable config */
 271         ret = cfg_copy(&hinfo->cfg, (void *)cfg, 2);
 272
 273         if (ret)
 274                 return ret;
 275
 276         hinfo->cfg.size = size;
 277         if (hinfo->cfg.max == 0)
 278                 hinfo->cfg.max = 8 * hinfo->cfg.size;
 279         else if (hinfo->cfg.max < hinfo->cfg.size)
 280                 hinfo->cfg.max = hinfo->cfg.size;
 281
 282         for (i = 0; i < hinfo->cfg.size; i++)
 283                 INIT_HLIST_HEAD(&hinfo->hash[i]);
 284
 285         hinfo->use = 1;
 286         hinfo->count = 0;
 287         hinfo->family = family;
 288         hinfo->rnd_initialized = false;
 289         hinfo->name = kstrdup(name, GFP_KERNEL);
 290         if (!hinfo->name) {
 291                 vfree(hinfo);
 292                 return -ENOMEM;
 293         }
 294         spin_lock_init(&hinfo->lock);
 295
 296         hinfo->pde = proc_create_data(name, 0,
 297                 (family == NFPROTO_IPV4) ?
 298                 hashlimit_net->ipt_hashlimit : hashlimit_net->ip6t_hashlimit,
 299                 (revision == 1) ? &dl_file_ops_v1 : &dl_file_ops,
 300                 hinfo);
 301         if (hinfo->pde == NULL) {
 302                 kfree(hinfo->name);
 303                 vfree(hinfo);
 304                 return -ENOMEM;
 305         }
 306         hinfo->net = net;
 307
 308         INIT_DEFERRABLE_WORK(&hinfo->gc_work, htable_gc);
 309         queue_delayed_work(system_power_efficient_wq, &hinfo->gc_work,
 310                            msecs_to_jiffies(hinfo->cfg.gc_interval));
 311
 312         hlist_add_head(&hinfo->node, &hashlimit_net->htables);
 313
 314         return 0;
 315 }
 316
 317 static bool select_all(const struct xt_hashlimit_htable *ht,
 318                        const struct dsthash_ent *he)
 319 {
 320         return 1;
 321 }
 322
 323 static bool select_gc(const struct xt_hashlimit_htable *ht,
 324                       const struct dsthash_ent *he)
 325 {
 326         return time_after_eq(jiffies, he->expires);
 327 }
 328
 329 static void htable_selective_cleanup(struct xt_hashlimit_htable *ht,
 330                         bool (*select)(const struct xt_hashlimit_htable *ht,
 331                                       const struct dsthash_ent *he))
 332 {
 333         unsigned int i;
 334
 335         for (i = 0; i < ht->cfg.size; i++) {
 336                 struct dsthash_ent *dh;
 337                 struct hlist_node *n;
 338
 339                 spin_lock_bh(&ht->lock);
 340                 hlist_for_each_entry_safe(dh, n, &ht->hash[i], node) {
 341                         if ((*select)(ht, dh))
 342                                 dsthash_free(ht, dh);
 343                 }
 344                 spin_unlock_bh(&ht->lock);
 345                 cond_resched();
 346         }
 347 }
 348
 349 static void htable_gc(struct work_struct *work)
 350 {
 351         struct xt_hashlimit_htable *ht;
 352
 353         ht = container_of(work, struct xt_hashlimit_htable, gc_work.work);
 354
 355         htable_selective_cleanup(ht, select_gc);
 356
 357         queue_delayed_work(system_power_efficient_wq,
 358                            &ht->gc_work, msecs_to_jiffies(ht->cfg.gc_interval));
 359 }
 360
 361 static void htable_remove_proc_entry(struct xt_hashlimit_htable *hinfo)
 362 {
 363         struct hashlimit_net *hashlimit_net = hashlimit_pernet(hinfo->net);
 364         struct proc_dir_entry *parent;
 365
 366         if (hinfo->family == NFPROTO_IPV4)
 367                 parent = hashlimit_net->ipt_hashlimit;
 368         else
 369                 parent = hashlimit_net->ip6t_hashlimit;
 370
 371         if (parent != NULL)
 372                 remove_proc_entry(hinfo->name, parent);
 373 }
 374
 375 static void htable_destroy(struct xt_hashlimit_htable *hinfo)
 376 {
 377         cancel_delayed_work_sync(&hinfo->gc_work);
 378         htable_remove_proc_entry(hinfo);
 379         htable_selective_cleanup(hinfo, select_all);
 380         kfree(hinfo->name);
 381         vfree(hinfo);
 382 }
 383
 384 static struct xt_hashlimit_htable *htable_find_get(struct net *net,
 385                                                    const char *name,
 386                                                    u_int8_t family)
 387 {
 388         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 389         struct xt_hashlimit_htable *hinfo;
 390
 391         hlist_for_each_entry(hinfo, &hashlimit_net->htables, node) {
 392                 if (!strcmp(name, hinfo->name) &&
 393                     hinfo->family == family) {
 394                         hinfo->use++;
 395                         return hinfo;
 396                 }
 397         }
 398         return NULL;
 399 }
 400
 401 static void htable_put(struct xt_hashlimit_htable *hinfo)
 402 {
 403         mutex_lock(&hashlimit_mutex);
 404         if (--hinfo->use == 0) {
 405                 hlist_del(&hinfo->node);
 406                 htable_destroy(hinfo);
 407         }
 408         mutex_unlock(&hashlimit_mutex);
 409 }
 410
 411 /* The algorithm used is the Simple Token Bucket Filter (TBF)
 412  * see net/sched/sch_tbf.c in the linux source tree
 413  */
 414
 415 /* Rusty: This is my (non-mathematically-inclined) understanding of
 416    this algorithm.  The `average rate' in jiffies becomes your initial
 417    amount of credit `credit' and the most credit you can ever have
 418    `credit_cap'.  The `peak rate' becomes the cost of passing the
 419    test, `cost'.
 420
 421    `prev' tracks the last packet hit: you gain one credit per jiffy.
 422    If you get credit balance more than this, the extra credit is
 423    discarded.  Every time the match passes, you lose `cost' credits;
 424    if you don't have that many, the test fails.
 425
 426    See Alexey's formal explanation in net/sched/sch_tbf.c.
 427
 428    To get the maximum range, we multiply by this factor (ie. you get N
 429    credits per jiffy).  We want to allow a rate as low as 1 per day
 430    (slowest userspace tool allows), which means
 431    CREDITS_PER_JIFFY*HZ*60*60*24 < 2^32 ie.
 432 */
 433 #define MAX_CPJ_v1 (0xFFFFFFFF / (HZ*60*60*24))
 434 #define MAX_CPJ (0xFFFFFFFFFFFFFFFF / (HZ*60*60*24))
 435
 436 /* Repeated shift and or gives us all 1s, final shift and add 1 gives
 437  * us the power of 2 below the theoretical max, so GCC simply does a
 438  * shift. */
 439 #define _POW2_BELOW2(x) ((x)|((x)>>1))
 440 #define _POW2_BELOW4(x) (_POW2_BELOW2(x)|_POW2_BELOW2((x)>>2))
 441 #define _POW2_BELOW8(x) (_POW2_BELOW4(x)|_POW2_BELOW4((x)>>4))
 442 #define _POW2_BELOW16(x) (_POW2_BELOW8(x)|_POW2_BELOW8((x)>>8))
 443 #define _POW2_BELOW32(x) (_POW2_BELOW16(x)|_POW2_BELOW16((x)>>16))
 444 #define _POW2_BELOW64(x) (_POW2_BELOW32(x)|_POW2_BELOW32((x)>>32))
 445 #define POW2_BELOW32(x) ((_POW2_BELOW32(x)>>1) + 1)
 446 #define POW2_BELOW64(x) ((_POW2_BELOW64(x)>>1) + 1)
 447
 448 #define CREDITS_PER_JIFFY POW2_BELOW64(MAX_CPJ)
 449 #define CREDITS_PER_JIFFY_v1 POW2_BELOW32(MAX_CPJ_v1)
 450
 451 /* in byte mode, the lowest possible rate is one packet/second.
 452  * credit_cap is used as a counter that tells us how many times we can
 453  * refill the "credits available" counter when it becomes empty.
 454  */
 455 #define MAX_CPJ_BYTES (0xFFFFFFFF / HZ)
 456 #define CREDITS_PER_JIFFY_BYTES POW2_BELOW32(MAX_CPJ_BYTES)
 457
 458 static u32 xt_hashlimit_len_to_chunks(u32 len)
 459 {
 460         return (len >> XT_HASHLIMIT_BYTE_SHIFT) + 1;
 461 }
 462
 463 /* Precision saver. */
 464 static u64 user2credits(u64 user, int revision)
 465 {
 466         if (revision == 1) {
 467                 /* If multiplying would overflow... */
 468                 if (user > 0xFFFFFFFF / (HZ*CREDITS_PER_JIFFY_v1))
 469                         /* Divide first. */
 470                         return (user / XT_HASHLIMIT_SCALE) *\
 471                                                 HZ * CREDITS_PER_JIFFY_v1;
 472
 473                 return (user * HZ * CREDITS_PER_JIFFY_v1) \
 474                                                 / XT_HASHLIMIT_SCALE;
 475         } else {
 476                 if (user > 0xFFFFFFFFFFFFFFFF / (HZ*CREDITS_PER_JIFFY))
 477                         return (user / XT_HASHLIMIT_SCALE_v2) *\
 478                                                 HZ * CREDITS_PER_JIFFY;
 479
 480                 return (user * HZ * CREDITS_PER_JIFFY) / XT_HASHLIMIT_SCALE_v2;
 481         }
 482 }
 483
 484 static u32 user2credits_byte(u32 user)
 485 {
 486         u64 us = user;
 487         us *= HZ * CREDITS_PER_JIFFY_BYTES;
 488         return (u32) (us >> 32);
 489 }
 490
 491 static void rateinfo_recalc(struct dsthash_ent *dh, unsigned long now,
 492                             u32 mode, int revision)
 493 {
 494         unsigned long delta = now - dh->rateinfo.prev;
 495         u64 cap, cpj;
 496
 497         if (delta == 0)
 498                 return;
 499
 500         dh->rateinfo.prev = now;
 501
 502         if (mode & XT_HASHLIMIT_BYTES) {
 503                 u64 tmp = dh->rateinfo.credit;
 504                 dh->rateinfo.credit += CREDITS_PER_JIFFY_BYTES * delta;
 505                 cap = CREDITS_PER_JIFFY_BYTES * HZ;
 506                 if (tmp >= dh->rateinfo.credit) {/* overflow */
 507                         dh->rateinfo.credit = cap;
 508                         return;
 509                 }
 510         } else {
 511                 cpj = (revision == 1) ?
 512                         CREDITS_PER_JIFFY_v1 : CREDITS_PER_JIFFY;
 513                 dh->rateinfo.credit += delta * cpj;
 514                 cap = dh->rateinfo.credit_cap;
 515         }
 516         if (dh->rateinfo.credit > cap)
 517                 dh->rateinfo.credit = cap;
 518 }
 519
 520 static void rateinfo_init(struct dsthash_ent *dh,
 521                           struct xt_hashlimit_htable *hinfo, int revision)
 522 {
 523         dh->rateinfo.prev = jiffies;
 524         if (hinfo->cfg.mode & XT_HASHLIMIT_BYTES) {
 525                 dh->rateinfo.credit = CREDITS_PER_JIFFY_BYTES * HZ;
 526                 dh->rateinfo.cost = user2credits_byte(hinfo->cfg.avg);
 527                 dh->rateinfo.credit_cap = hinfo->cfg.burst;
 528         } else {
 529                 dh->rateinfo.credit = user2credits(hinfo->cfg.avg *
 530                                                    hinfo->cfg.burst, revision);
 531                 dh->rateinfo.cost = user2credits(hinfo->cfg.avg, revision);
 532                 dh->rateinfo.credit_cap = dh->rateinfo.credit;
 533         }
 534 }
 535
 536 static inline __be32 maskl(__be32 a, unsigned int l)
 537 {
 538         return l ? htonl(ntohl(a) & ~0 << (32 - l)) : 0;
 539 }
 540
 541 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 542 static void hashlimit_ipv6_mask(__be32 *i, unsigned int p)
 543 {
 544         switch (p) {
 545         case 0 ... 31:
 546                 i[0] = maskl(i[0], p);
 547                 i[1] = i[2] = i[3] = 0;
 548                 break;
 549         case 32 ... 63:
 550                 i[1] = maskl(i[1], p - 32);
 551                 i[2] = i[3] = 0;
 552                 break;
 553         case 64 ... 95:
 554                 i[2] = maskl(i[2], p - 64);
 555                 i[3] = 0;
 556                 break;
 557         case 96 ... 127:
 558                 i[3] = maskl(i[3], p - 96);
 559                 break;
 560         case 128:
 561                 break;
 562         }
 563 }
 564 #endif
 565
 566 static int
 567 hashlimit_init_dst(const struct xt_hashlimit_htable *hinfo,
 568                    struct dsthash_dst *dst,
 569                    const struct sk_buff *skb, unsigned int protoff)
 570 {
 571         __be16 _ports[2], *ports;
 572         u8 nexthdr;
 573         int poff;
 574
 575         memset(dst, 0, sizeof(*dst));
 576
 577         switch (hinfo->family) {
 578         case NFPROTO_IPV4:
 579                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DIP)
 580                         dst->ip.dst = maskl(ip_hdr(skb)->daddr,
 581                                       hinfo->cfg.dstmask);
 582                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SIP)
 583                         dst->ip.src = maskl(ip_hdr(skb)->saddr,
 584                                       hinfo->cfg.srcmask);
 585
 586                 if (!(hinfo->cfg.mode &
 587                       (XT_HASHLIMIT_HASH_DPT | XT_HASHLIMIT_HASH_SPT)))
 588                         return 0;
 589                 nexthdr = ip_hdr(skb)->protocol;
 590                 break;
 591 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 592         case NFPROTO_IPV6:
 593         {
 594                 __be16 frag_off;
 595
 596                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DIP) {
 597                         memcpy(&dst->ip6.dst, &ipv6_hdr(skb)->daddr,
 598                                sizeof(dst->ip6.dst));
 599                         hashlimit_ipv6_mask(dst->ip6.dst, hinfo->cfg.dstmask);
 600                 }
 601                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SIP) {
 602                         memcpy(&dst->ip6.src, &ipv6_hdr(skb)->saddr,
 603                                sizeof(dst->ip6.src));
 604                         hashlimit_ipv6_mask(dst->ip6.src, hinfo->cfg.srcmask);
 605                 }
 606
 607                 if (!(hinfo->cfg.mode &
 608                       (XT_HASHLIMIT_HASH_DPT | XT_HASHLIMIT_HASH_SPT)))
 609                         return 0;
 610                 nexthdr = ipv6_hdr(skb)->nexthdr;
 611                 protoff = ipv6_skip_exthdr(skb, sizeof(struct ipv6hdr), &nexthdr, &frag_off);
 612                 if ((int)protoff < 0)
 613                         return -1;
 614                 break;
 615         }
 616 #endif
 617         default:
 618                 BUG();
 619                 return 0;
 620         }
 621
 622         poff = proto_ports_offset(nexthdr);
 623         if (poff >= 0) {
 624                 ports = skb_header_pointer(skb, protoff + poff, sizeof(_ports),
 625                                            &_ports);
 626         } else {
 627                 _ports[0] = _ports[1] = 0;
 628                 ports = _ports;
 629         }
 630         if (!ports)
 631                 return -1;
 632         if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SPT)
 633                 dst->src_port = ports[0];
 634         if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DPT)
 635                 dst->dst_port = ports[1];
 636         return 0;
 637 }
 638
 639 static u32 hashlimit_byte_cost(unsigned int len, struct dsthash_ent *dh)
 640 {
 641         u64 tmp = xt_hashlimit_len_to_chunks(len);
 642         tmp = tmp * dh->rateinfo.cost;
 643
 644         if (unlikely(tmp > CREDITS_PER_JIFFY_BYTES * HZ))
 645                 tmp = CREDITS_PER_JIFFY_BYTES * HZ;
 646
 647         if (dh->rateinfo.credit < tmp && dh->rateinfo.credit_cap) {
 648                 dh->rateinfo.credit_cap--;
 649                 dh->rateinfo.credit = CREDITS_PER_JIFFY_BYTES * HZ;
 650         }
 651         return (u32) tmp;
 652 }
 653
 654 static bool
 655 hashlimit_mt_common(const struct sk_buff *skb, struct xt_action_param *par,
 656                     struct xt_hashlimit_htable *hinfo,
 657                     const struct hashlimit_cfg2 *cfg, int revision)
 658 {
 659         unsigned long now = jiffies;
 660         struct dsthash_ent *dh;
 661         struct dsthash_dst dst;
 662         bool race = false;
 663         u64 cost;
 664
 665         if (hashlimit_init_dst(hinfo, &dst, skb, par->thoff) < 0)
 666                 goto hotdrop;
 667
 668         rcu_read_lock_bh();
 669         dh = dsthash_find(hinfo, &dst);
 670         if (dh == NULL) {
 671                 dh = dsthash_alloc_init(hinfo, &dst, &race);
 672                 if (dh == NULL) {
 673                         rcu_read_unlock_bh();
 674                         goto hotdrop;
 675                 } else if (race) {
 676                         /* Already got an entry, update expiration timeout */
 677                         dh->expires = now + msecs_to_jiffies(hinfo->cfg.expire);
 678                         rateinfo_recalc(dh, now, hinfo->cfg.mode, revision);
 679                 } else {
 680                         dh->expires = jiffies + msecs_to_jiffies(hinfo->cfg.expire);
 681                         rateinfo_init(dh, hinfo, revision);
 682                 }
 683         } else {
 684                 /* update expiration timeout */
 685                 dh->expires = now + msecs_to_jiffies(hinfo->cfg.expire);
 686                 rateinfo_recalc(dh, now, hinfo->cfg.mode, revision);
 687         }
 688
 689         if (cfg->mode & XT_HASHLIMIT_BYTES)
 690                 cost = hashlimit_byte_cost(skb->len, dh);
 691         else
 692                 cost = dh->rateinfo.cost;
 693
 694         if (dh->rateinfo.credit >= cost) {
 695                 /* below the limit */
 696                 dh->rateinfo.credit -= cost;
 697                 spin_unlock(&dh->lock);
 698                 rcu_read_unlock_bh();
 699                 return !(cfg->mode & XT_HASHLIMIT_INVERT);
 700         }
 701
 702         spin_unlock(&dh->lock);
 703         rcu_read_unlock_bh();
 704         /* default match is underlimit - so over the limit, we need to invert */
 705         return cfg->mode & XT_HASHLIMIT_INVERT;
 706
 707  hotdrop:
 708         par->hotdrop = true;
 709         return false;
 710 }
 711
 712 static bool
 713 hashlimit_mt_v1(const struct sk_buff *skb, struct xt_action_param *par)
 714 {
 715         const struct xt_hashlimit_mtinfo1 *info = par->matchinfo;
 716         struct xt_hashlimit_htable *hinfo = info->hinfo;
 717         struct hashlimit_cfg2 cfg = {};
 718         int ret;
 719
 720         ret = cfg_copy(&cfg, (void *)&info->cfg, 1);
 721
 722         if (ret)
 723                 return ret;
 724
 725         return hashlimit_mt_common(skb, par, hinfo, &cfg, 1);
 726 }
 727
 728 static bool
 729 hashlimit_mt(const struct sk_buff *skb, struct xt_action_param *par)
 730 {
 731         const struct xt_hashlimit_mtinfo2 *info = par->matchinfo;
 732         struct xt_hashlimit_htable *hinfo = info->hinfo;
 733
 734         return hashlimit_mt_common(skb, par, hinfo, &info->cfg, 2);
 735 }
 736
 737 static int hashlimit_mt_check_common(const struct xt_mtchk_param *par,
 738                                      struct xt_hashlimit_htable **hinfo,
 739                                      struct hashlimit_cfg2 *cfg,
 740                                      const char *name, int revision)
 741 {
 742         struct net *net = par->net;
 743         int ret;
 744
 745         if (cfg->gc_interval == 0 || cfg->expire == 0)
 746                 return -EINVAL;
 747         if (par->family == NFPROTO_IPV4) {
 748                 if (cfg->srcmask > 32 || cfg->dstmask > 32)
 749                         return -EINVAL;
 750         } else {
 751                 if (cfg->srcmask > 128 || cfg->dstmask > 128)
 752                         return -EINVAL;
 753         }
 754
 755         if (cfg->mode & ~XT_HASHLIMIT_ALL) {
 756                 pr_info("Unknown mode mask %X, kernel too old?\n",
 757                                                 cfg->mode);
 758                 return -EINVAL;
 759         }
 760
 761         /* Check for overflow. */
 762         if (cfg->mode & XT_HASHLIMIT_BYTES) {
 763                 if (user2credits_byte(cfg->avg) == 0) {
 764                         pr_info("overflow, rate too high: %llu\n", cfg->avg);
 765                         return -EINVAL;
 766                 }
 767         } else if (cfg->burst == 0 ||
 768                     user2credits(cfg->avg * cfg->burst, revision) <
 769                     user2credits(cfg->avg, revision)) {
 770                         pr_info("overflow, try lower: %llu/%llu\n",
 771                                 cfg->avg, cfg->burst);
 772                         return -ERANGE;
 773         }
 774
 775         mutex_lock(&hashlimit_mutex);
 776         *hinfo = htable_find_get(net, name, par->family);
 777         if (*hinfo == NULL) {
 778                 ret = htable_create(net, cfg, name, par->family,
 779                                     hinfo, revision);
 780                 if (ret < 0) {
 781                         mutex_unlock(&hashlimit_mutex);
 782                         return ret;
 783                 }
 784         }
 785         mutex_unlock(&hashlimit_mutex);
 786
 787         return 0;
 788 }
 789
 790 static int hashlimit_mt_check_v1(const struct xt_mtchk_param *par)
 791 {
 792         struct xt_hashlimit_mtinfo1 *info = par->matchinfo;
 793         struct hashlimit_cfg2 cfg = {};
 794         int ret;
 795
 796         if (info->name[sizeof(info->name) - 1] != '\0')
 797                 return -EINVAL;
 798
 799         ret = cfg_copy(&cfg, (void *)&info->cfg, 1);
 800
 801         if (ret)
 802                 return ret;
 803
 804         return hashlimit_mt_check_common(par, &info->hinfo,
 805                                          &cfg, info->name, 1);
 806 }
 807
 808 static int hashlimit_mt_check(const struct xt_mtchk_param *par)
 809 {
 810         struct xt_hashlimit_mtinfo2 *info = par->matchinfo;
 811
 812         if (info->name[sizeof(info->name) - 1] != '\0')
 813                 return -EINVAL;
 814
 815         return hashlimit_mt_check_common(par, &info->hinfo, &info->cfg,
 816                                          info->name, 2);
 817 }
 818
 819 static void hashlimit_mt_destroy_v1(const struct xt_mtdtor_param *par)
 820 {
 821         const struct xt_hashlimit_mtinfo1 *info = par->matchinfo;
 822
 823         htable_put(info->hinfo);
 824 }
 825
 826 static void hashlimit_mt_destroy(const struct xt_mtdtor_param *par)
 827 {
 828         const struct xt_hashlimit_mtinfo2 *info = par->matchinfo;
 829
 830         htable_put(info->hinfo);
 831 }
 832
 833 static struct xt_match hashlimit_mt_reg[] __read_mostly = {
 834         {
 835                 .name           = "hashlimit",
 836                 .revision       = 1,
 837                 .family         = NFPROTO_IPV4,
 838                 .match          = hashlimit_mt_v1,
 839                 .matchsize      = sizeof(struct xt_hashlimit_mtinfo1),
 840                 .checkentry     = hashlimit_mt_check_v1,
 841                 .destroy        = hashlimit_mt_destroy_v1,
 842                 .me             = THIS_MODULE,
 843         },
 844         {
 845                 .name           = "hashlimit",
 846                 .revision       = 2,
 847                 .family         = NFPROTO_IPV4,
 848                 .match          = hashlimit_mt,
 849                 .matchsize      = sizeof(struct xt_hashlimit_mtinfo2),
 850                 .checkentry     = hashlimit_mt_check,
 851                 .destroy        = hashlimit_mt_destroy,
 852                 .me             = THIS_MODULE,
 853         },
 854 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 855         {
 856                 .name           = "hashlimit",
 857                 .revision       = 1,
 858                 .family         = NFPROTO_IPV6,
 859                 .match          = hashlimit_mt_v1,
 860                 .matchsize      = sizeof(struct xt_hashlimit_mtinfo1),
 861                 .checkentry     = hashlimit_mt_check_v1,
 862                 .destroy        = hashlimit_mt_destroy_v1,
 863                 .me             = THIS_MODULE,
 864         },
 865         {
 866                 .name           = "hashlimit",
 867                 .revision       = 2,
 868                 .family         = NFPROTO_IPV6,
 869                 .match          = hashlimit_mt,
 870                 .matchsize      = sizeof(struct xt_hashlimit_mtinfo2),
 871                 .checkentry     = hashlimit_mt_check,
 872                 .destroy        = hashlimit_mt_destroy,
 873                 .me             = THIS_MODULE,
 874         },
 875 #endif
 876 };
 877
 878 /* PROC stuff */
 879 static void *dl_seq_start(struct seq_file *s, loff_t *pos)
 880         __acquires(htable->lock)
 881 {
 882         struct xt_hashlimit_htable *htable = s->private;
 883         unsigned int *bucket;
 884
 885         spin_lock_bh(&htable->lock);
 886         if (*pos >= htable->cfg.size)
 887                 return NULL;
 888
 889         bucket = kmalloc(sizeof(unsigned int), GFP_ATOMIC);
 890         if (!bucket)
 891                 return ERR_PTR(-ENOMEM);
 892
 893         *bucket = *pos;
 894         return bucket;
 895 }
 896
 897 static void *dl_seq_next(struct seq_file *s, void *v, loff_t *pos)
 898 {
 899         struct xt_hashlimit_htable *htable = s->private;
 900         unsigned int *bucket = (unsigned int *)v;
 901
 902         *pos = ++(*bucket);
 903         if (*pos >= htable->cfg.size) {
 904                 kfree(v);
 905                 return NULL;
 906         }
 907         return bucket;
 908 }
 909
 910 static void dl_seq_stop(struct seq_file *s, void *v)
 911         __releases(htable->lock)
 912 {
 913         struct xt_hashlimit_htable *htable = s->private;
 914         unsigned int *bucket = (unsigned int *)v;
 915
 916         if (!IS_ERR(bucket))
 917                 kfree(bucket);
 918         spin_unlock_bh(&htable->lock);
 919 }
 920
 921 static void dl_seq_print(struct dsthash_ent *ent, u_int8_t family,
 922                          struct seq_file *s)
 923 {
 924         switch (family) {
 925         case NFPROTO_IPV4:
 926                 seq_printf(s, "%ld %pI4:%u->%pI4:%u %llu %llu %llu\n",
 927                            (long)(ent->expires - jiffies)/HZ,
 928                            &ent->dst.ip.src,
 929                            ntohs(ent->dst.src_port),
 930                            &ent->dst.ip.dst,
 931                            ntohs(ent->dst.dst_port),
 932                            ent->rateinfo.credit, ent->rateinfo.credit_cap,
 933                            ent->rateinfo.cost);
 934                 break;
 935 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 936         case NFPROTO_IPV6:
 937                 seq_printf(s, "%ld %pI6:%u->%pI6:%u %llu %llu %llu\n",
 938                            (long)(ent->expires - jiffies)/HZ,
 939                            &ent->dst.ip6.src,
 940                            ntohs(ent->dst.src_port),
 941                            &ent->dst.ip6.dst,
 942                            ntohs(ent->dst.dst_port),
 943                            ent->rateinfo.credit, ent->rateinfo.credit_cap,
 944                            ent->rateinfo.cost);
 945                 break;
 946 #endif
 947         default:
 948                 BUG();
 949         }
 950 }
 951
 952 static int dl_seq_real_show_v1(struct dsthash_ent *ent, u_int8_t family,
 953                                struct seq_file *s)
 954 {
 955         const struct xt_hashlimit_htable *ht = s->private;
 956
 957         spin_lock(&ent->lock);
 958         /* recalculate to show accurate numbers */
 959         rateinfo_recalc(ent, jiffies, ht->cfg.mode, 1);
 960
 961         dl_seq_print(ent, family, s);
 962
 963         spin_unlock(&ent->lock);
 964         return seq_has_overflowed(s);
 965 }
 966
 967 static int dl_seq_real_show(struct dsthash_ent *ent, u_int8_t family,
 968                             struct seq_file *s)
 969 {
 970         const struct xt_hashlimit_htable *ht = s->private;
 971
 972         spin_lock(&ent->lock);
 973         /* recalculate to show accurate numbers */
 974         rateinfo_recalc(ent, jiffies, ht->cfg.mode, 2);
 975
 976         dl_seq_print(ent, family, s);
 977
 978         spin_unlock(&ent->lock);
 979         return seq_has_overflowed(s);
 980 }
 981
 982 static int dl_seq_show_v1(struct seq_file *s, void *v)
 983 {
 984         struct xt_hashlimit_htable *htable = s->private;
 985         unsigned int *bucket = (unsigned int *)v;
 986         struct dsthash_ent *ent;
 987
 988         if (!hlist_empty(&htable->hash[*bucket])) {
 989                 hlist_for_each_entry(ent, &htable->hash[*bucket], node)
 990                         if (dl_seq_real_show_v1(ent, htable->family, s))
 991                                 return -1;
 992         }
 993         return 0;
 994 }
 995
 996 static int dl_seq_show(struct seq_file *s, void *v)
 997 {
 998         struct xt_hashlimit_htable *htable = s->private;
 999         unsigned int *bucket = (unsigned int *)v;
1000         struct dsthash_ent *ent;
1001
1002         if (!hlist_empty(&htable->hash[*bucket])) {
1003                 hlist_for_each_entry(ent, &htable->hash[*bucket], node)
1004                         if (dl_seq_real_show(ent, htable->family, s))
1005                                 return -1;
1006         }
1007         return 0;
1008 }
1009
1010 static const struct seq_operations dl_seq_ops_v1 = {
1011         .start = dl_seq_start,
1012         .next  = dl_seq_next,
1013         .stop  = dl_seq_stop,
1014         .show  = dl_seq_show_v1
1015 };
1016
1017 static const struct seq_operations dl_seq_ops = {
1018         .start = dl_seq_start,
1019         .next  = dl_seq_next,
1020         .stop  = dl_seq_stop,
1021         .show  = dl_seq_show
1022 };
1023
1024 static int dl_proc_open_v1(struct inode *inode, struct file *file)
1025 {
1026         int ret = seq_open(file, &dl_seq_ops_v1);
1027
1028         if (!ret) {
1029                 struct seq_file *sf = file->private_data;
1030                 sf->private = PDE_DATA(inode);
1031         }
1032         return ret;
1033 }
1034
1035 static int dl_proc_open(struct inode *inode, struct file *file)
1036 {
1037         int ret = seq_open(file, &dl_seq_ops);
1038
1039         if (!ret) {
1040                 struct seq_file *sf = file->private_data;
1041
1042                 sf->private = PDE_DATA(inode);
1043         }
1044         return ret;
1045 }
1046
1047 static const struct file_operations dl_file_ops_v1 = {
1048         .owner   = THIS_MODULE,
1049         .open    = dl_proc_open_v1,
1050         .read    = seq_read,
1051         .llseek  = seq_lseek,
1052         .release = seq_release
1053 };
1054
1055 static const struct file_operations dl_file_ops = {
1056         .owner   = THIS_MODULE,
1057         .open    = dl_proc_open,
1058         .read    = seq_read,
1059         .llseek  = seq_lseek,
1060         .release = seq_release
1061 };
1062
1063 static int __net_init hashlimit_proc_net_init(struct net *net)
1064 {
1065         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
1066
1067         hashlimit_net->ipt_hashlimit = proc_mkdir("ipt_hashlimit", net->proc_net);
1068         if (!hashlimit_net->ipt_hashlimit)
1069                 return -ENOMEM;
1070 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
1071         hashlimit_net->ip6t_hashlimit = proc_mkdir("ip6t_hashlimit", net->proc_net);
1072         if (!hashlimit_net->ip6t_hashlimit) {
1073                 remove_proc_entry("ipt_hashlimit", net->proc_net);
1074                 return -ENOMEM;
1075         }
1076 #endif
1077         return 0;
1078 }
1079
1080 static void __net_exit hashlimit_proc_net_exit(struct net *net)
1081 {
1082         struct xt_hashlimit_htable *hinfo;
1083         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
1084
1085         /* hashlimit_net_exit() is called before hashlimit_mt_destroy().
1086          * Make sure that the parent ipt_hashlimit and ip6t_hashlimit proc
1087          * entries is empty before trying to remove it.
1088          */
1089         mutex_lock(&hashlimit_mutex);
1090         hlist_for_each_entry(hinfo, &hashlimit_net->htables, node)
1091                 htable_remove_proc_entry(hinfo);
1092         hashlimit_net->ipt_hashlimit = NULL;
1093         hashlimit_net->ip6t_hashlimit = NULL;
1094         mutex_unlock(&hashlimit_mutex);
1095
1096         remove_proc_entry("ipt_hashlimit", net->proc_net);
1097 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
1098         remove_proc_entry("ip6t_hashlimit", net->proc_net);
1099 #endif
1100 }
1101
1102 static int __net_init hashlimit_net_init(struct net *net)
1103 {
1104         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
1105
1106         INIT_HLIST_HEAD(&hashlimit_net->htables);
1107         return hashlimit_proc_net_init(net);
1108 }
1109
1110 static void __net_exit hashlimit_net_exit(struct net *net)
1111 {
1112         hashlimit_proc_net_exit(net);
1113 }
1114
1115 static struct pernet_operations hashlimit_net_ops = {
1116         .init   = hashlimit_net_init,
1117         .exit   = hashlimit_net_exit,
1118         .id     = &hashlimit_net_id,
1119         .size   = sizeof(struct hashlimit_net),
1120 };
1121
1122 static int __init hashlimit_mt_init(void)
1123 {
1124         int err;
1125
1126         err = register_pernet_subsys(&hashlimit_net_ops);
1127         if (err < 0)
1128                 return err;
1129         err = xt_register_matches(hashlimit_mt_reg,
1130               ARRAY_SIZE(hashlimit_mt_reg));
1131         if (err < 0)
1132                 goto err1;
1133
1134         err = -ENOMEM;
1135         hashlimit_cachep = kmem_cache_create("xt_hashlimit",
1136                                             sizeof(struct dsthash_ent), 0, 0,
1137                                             NULL);
1138         if (!hashlimit_cachep) {
1139                 pr_warn("unable to create slab cache\n");
1140                 goto err2;
1141         }
1142         return 0;
1143
1144 err2:
1145         xt_unregister_matches(hashlimit_mt_reg, ARRAY_SIZE(hashlimit_mt_reg));
1146 err1:
1147         unregister_pernet_subsys(&hashlimit_net_ops);
1148         return err;
1149
1150 }
1151
1152 static void __exit hashlimit_mt_exit(void)
1153 {
1154         xt_unregister_matches(hashlimit_mt_reg, ARRAY_SIZE(hashlimit_mt_reg));
1155         unregister_pernet_subsys(&hashlimit_net_ops);
1156
1157         rcu_barrier_bh();
1158         kmem_cache_destroy(hashlimit_cachep);
1159 }
1160
1161 module_init(hashlimit_mt_init);
1162 module_exit(hashlimit_mt_exit);