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;
  60
  61 /* hash table crap */
  62 struct dsthash_dst {
  63         union {
  64                 struct {
  65                         __be32 src;
  66                         __be32 dst;
  67                 } ip;
  68 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
  69                 struct {
  70                         __be32 src[4];
  71                         __be32 dst[4];
  72                 } ip6;
  73 #endif
  74         };
  75         __be16 src_port;
  76         __be16 dst_port;
  77 };
  78
  79 struct dsthash_ent {
  80         /* static / read-only parts in the beginning */
  81         struct hlist_node node;
  82         struct dsthash_dst dst;
  83
  84         /* modified structure members in the end */
  85         spinlock_t lock;
  86         unsigned long expires;          /* precalculated expiry time */
  87         struct {
  88                 unsigned long prev;     /* last modification */
  89                 u_int32_t credit;
  90                 u_int32_t credit_cap, cost;
  91         } rateinfo;
  92         struct rcu_head rcu;
  93 };
  94
  95 struct xt_hashlimit_htable {
  96         struct hlist_node node;         /* global list of all htables */
  97         int use;
  98         u_int8_t family;
  99         bool rnd_initialized;
 100
 101         struct hashlimit_cfg1 cfg;      /* config */
 102
 103         /* used internally */
 104         spinlock_t lock;                /* lock for list_head */
 105         u_int32_t rnd;                  /* random seed for hash */
 106         unsigned int count;             /* number entries in table */
 107         struct timer_list timer;        /* timer for gc */
 108
 109         /* seq_file stuff */
 110         struct proc_dir_entry *pde;
 111         struct net *net;
 112
 113         struct hlist_head hash[0];      /* hashtable itself */
 114 };
 115
 116 static DEFINE_MUTEX(hashlimit_mutex);   /* protects htables list */
 117 static struct kmem_cache *hashlimit_cachep __read_mostly;
 118
 119 static inline bool dst_cmp(const struct dsthash_ent *ent,
 120                            const struct dsthash_dst *b)
 121 {
 122         return !memcmp(&ent->dst, b, sizeof(ent->dst));
 123 }
 124
 125 static u_int32_t
 126 hash_dst(const struct xt_hashlimit_htable *ht, const struct dsthash_dst *dst)
 127 {
 128         u_int32_t hash = jhash2((const u32 *)dst,
 129                                 sizeof(*dst)/sizeof(u32),
 130                                 ht->rnd);
 131         /*
 132          * Instead of returning hash % ht->cfg.size (implying a divide)
 133          * we return the high 32 bits of the (hash * ht->cfg.size) that will
 134          * give results between [0 and cfg.size-1] and same hash distribution,
 135          * but using a multiply, less expensive than a divide
 136          */
 137         return ((u64)hash * ht->cfg.size) >> 32;
 138 }
 139
 140 static struct dsthash_ent *
 141 dsthash_find(const struct xt_hashlimit_htable *ht,
 142              const struct dsthash_dst *dst)
 143 {
 144         struct dsthash_ent *ent;
 145         u_int32_t hash = hash_dst(ht, dst);
 146
 147         if (!hlist_empty(&ht->hash[hash])) {
 148                 hlist_for_each_entry_rcu(ent, &ht->hash[hash], node)
 149                         if (dst_cmp(ent, dst)) {
 150                                 spin_lock(&ent->lock);
 151                                 return ent;
 152                         }
 153         }
 154         return NULL;
 155 }
 156
 157 /* allocate dsthash_ent, initialize dst, put in htable and lock it */
 158 static struct dsthash_ent *
 159 dsthash_alloc_init(struct xt_hashlimit_htable *ht,
 160                    const struct dsthash_dst *dst, bool *race)
 161 {
 162         struct dsthash_ent *ent;
 163
 164         spin_lock(&ht->lock);
 165
 166         /* Two or more packets may race to create the same entry in the
 167          * hashtable, double check if this packet lost race.
 168          */
 169         ent = dsthash_find(ht, dst);
 170         if (ent != NULL) {
 171                 spin_unlock(&ht->lock);
 172                 *race = true;
 173                 return ent;
 174         }
 175
 176         /* initialize hash with random val at the time we allocate
 177          * the first hashtable entry */
 178         if (unlikely(!ht->rnd_initialized)) {
 179                 get_random_bytes(&ht->rnd, sizeof(ht->rnd));
 180                 ht->rnd_initialized = true;
 181         }
 182
 183         if (ht->cfg.max && ht->count >= ht->cfg.max) {
 184                 /* FIXME: do something. question is what.. */
 185                 net_err_ratelimited("max count of %u reached\n", ht->cfg.max);
 186                 ent = NULL;
 187         } else
 188                 ent = kmem_cache_alloc(hashlimit_cachep, GFP_ATOMIC);
 189         if (ent) {
 190                 memcpy(&ent->dst, dst, sizeof(ent->dst));
 191                 spin_lock_init(&ent->lock);
 192
 193                 spin_lock(&ent->lock);
 194                 hlist_add_head_rcu(&ent->node, &ht->hash[hash_dst(ht, dst)]);
 195                 ht->count++;
 196         }
 197         spin_unlock(&ht->lock);
 198         return ent;
 199 }
 200
 201 static void dsthash_free_rcu(struct rcu_head *head)
 202 {
 203         struct dsthash_ent *ent = container_of(head, struct dsthash_ent, rcu);
 204
 205         kmem_cache_free(hashlimit_cachep, ent);
 206 }
 207
 208 static inline void
 209 dsthash_free(struct xt_hashlimit_htable *ht, struct dsthash_ent *ent)
 210 {
 211         hlist_del_rcu(&ent->node);
 212         call_rcu_bh(&ent->rcu, dsthash_free_rcu);
 213         ht->count--;
 214 }
 215 static void htable_gc(unsigned long htlong);
 216
 217 static int htable_create(struct net *net, struct xt_hashlimit_mtinfo1 *minfo,
 218                          u_int8_t family)
 219 {
 220         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 221         struct xt_hashlimit_htable *hinfo;
 222         unsigned int size;
 223         unsigned int i;
 224
 225         if (minfo->cfg.size) {
 226                 size = minfo->cfg.size;
 227         } else {
 228                 size = (totalram_pages << PAGE_SHIFT) / 16384 /
 229                        sizeof(struct list_head);
 230                 if (totalram_pages > 1024 * 1024 * 1024 / PAGE_SIZE)
 231                         size = 8192;
 232                 if (size < 16)
 233                         size = 16;
 234         }
 235         /* FIXME: don't use vmalloc() here or anywhere else -HW */
 236         hinfo = vmalloc(sizeof(struct xt_hashlimit_htable) +
 237                         sizeof(struct list_head) * size);
 238         if (hinfo == NULL)
 239                 return -ENOMEM;
 240         minfo->hinfo = hinfo;
 241
 242         /* copy match config into hashtable config */
 243         memcpy(&hinfo->cfg, &minfo->cfg, sizeof(hinfo->cfg));
 244         hinfo->cfg.size = size;
 245         if (hinfo->cfg.max == 0)
 246                 hinfo->cfg.max = 8 * hinfo->cfg.size;
 247         else if (hinfo->cfg.max < hinfo->cfg.size)
 248                 hinfo->cfg.max = hinfo->cfg.size;
 249
 250         for (i = 0; i < hinfo->cfg.size; i++)
 251                 INIT_HLIST_HEAD(&hinfo->hash[i]);
 252
 253         hinfo->use = 1;
 254         hinfo->count = 0;
 255         hinfo->family = family;
 256         hinfo->rnd_initialized = false;
 257         spin_lock_init(&hinfo->lock);
 258
 259         hinfo->pde = proc_create_data(minfo->name, 0,
 260                 (family == NFPROTO_IPV4) ?
 261                 hashlimit_net->ipt_hashlimit : hashlimit_net->ip6t_hashlimit,
 262                 &dl_file_ops, hinfo);
 263         if (hinfo->pde == NULL) {
 264                 vfree(hinfo);
 265                 return -ENOMEM;
 266         }
 267         hinfo->net = net;
 268
 269         setup_timer(&hinfo->timer, htable_gc, (unsigned long)hinfo);
 270         hinfo->timer.expires = jiffies + msecs_to_jiffies(hinfo->cfg.gc_interval);
 271         add_timer(&hinfo->timer);
 272
 273         hlist_add_head(&hinfo->node, &hashlimit_net->htables);
 274
 275         return 0;
 276 }
 277
 278 static bool select_all(const struct xt_hashlimit_htable *ht,
 279                        const struct dsthash_ent *he)
 280 {
 281         return 1;
 282 }
 283
 284 static bool select_gc(const struct xt_hashlimit_htable *ht,
 285                       const struct dsthash_ent *he)
 286 {
 287         return time_after_eq(jiffies, he->expires);
 288 }
 289
 290 static void htable_selective_cleanup(struct xt_hashlimit_htable *ht,
 291                         bool (*select)(const struct xt_hashlimit_htable *ht,
 292                                       const struct dsthash_ent *he))
 293 {
 294         unsigned int i;
 295
 296         /* lock hash table and iterate over it */
 297         spin_lock_bh(&ht->lock);
 298         for (i = 0; i < ht->cfg.size; i++) {
 299                 struct dsthash_ent *dh;
 300                 struct hlist_node *n;
 301                 hlist_for_each_entry_safe(dh, n, &ht->hash[i], node) {
 302                         if ((*select)(ht, dh))
 303                                 dsthash_free(ht, dh);
 304                 }
 305         }
 306         spin_unlock_bh(&ht->lock);
 307 }
 308
 309 /* hash table garbage collector, run by timer */
 310 static void htable_gc(unsigned long htlong)
 311 {
 312         struct xt_hashlimit_htable *ht = (struct xt_hashlimit_htable *)htlong;
 313
 314         htable_selective_cleanup(ht, select_gc);
 315
 316         /* re-add the timer accordingly */
 317         ht->timer.expires = jiffies + msecs_to_jiffies(ht->cfg.gc_interval);
 318         add_timer(&ht->timer);
 319 }
 320
 321 static void htable_destroy(struct xt_hashlimit_htable *hinfo)
 322 {
 323         struct hashlimit_net *hashlimit_net = hashlimit_pernet(hinfo->net);
 324         struct proc_dir_entry *parent;
 325
 326         del_timer_sync(&hinfo->timer);
 327
 328         if (hinfo->family == NFPROTO_IPV4)
 329                 parent = hashlimit_net->ipt_hashlimit;
 330         else
 331                 parent = hashlimit_net->ip6t_hashlimit;
 332
 333         if(parent != NULL)
 334                 remove_proc_entry(hinfo->pde->name, parent);
 335
 336         htable_selective_cleanup(hinfo, select_all);
 337         vfree(hinfo);
 338 }
 339
 340 static struct xt_hashlimit_htable *htable_find_get(struct net *net,
 341                                                    const char *name,
 342                                                    u_int8_t family)
 343 {
 344         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 345         struct xt_hashlimit_htable *hinfo;
 346
 347         hlist_for_each_entry(hinfo, &hashlimit_net->htables, node) {
 348                 if (!strcmp(name, hinfo->pde->name) &&
 349                     hinfo->family == family) {
 350                         hinfo->use++;
 351                         return hinfo;
 352                 }
 353         }
 354         return NULL;
 355 }
 356
 357 static void htable_put(struct xt_hashlimit_htable *hinfo)
 358 {
 359         mutex_lock(&hashlimit_mutex);
 360         if (--hinfo->use == 0) {
 361                 hlist_del(&hinfo->node);
 362                 htable_destroy(hinfo);
 363         }
 364         mutex_unlock(&hashlimit_mutex);
 365 }
 366
 367 /* The algorithm used is the Simple Token Bucket Filter (TBF)
 368  * see net/sched/sch_tbf.c in the linux source tree
 369  */
 370
 371 /* Rusty: This is my (non-mathematically-inclined) understanding of
 372    this algorithm.  The `average rate' in jiffies becomes your initial
 373    amount of credit `credit' and the most credit you can ever have
 374    `credit_cap'.  The `peak rate' becomes the cost of passing the
 375    test, `cost'.
 376
 377    `prev' tracks the last packet hit: you gain one credit per jiffy.
 378    If you get credit balance more than this, the extra credit is
 379    discarded.  Every time the match passes, you lose `cost' credits;
 380    if you don't have that many, the test fails.
 381
 382    See Alexey's formal explanation in net/sched/sch_tbf.c.
 383
 384    To get the maximum range, we multiply by this factor (ie. you get N
 385    credits per jiffy).  We want to allow a rate as low as 1 per day
 386    (slowest userspace tool allows), which means
 387    CREDITS_PER_JIFFY*HZ*60*60*24 < 2^32 ie.
 388 */
 389 #define MAX_CPJ (0xFFFFFFFF / (HZ*60*60*24))
 390
 391 /* Repeated shift and or gives us all 1s, final shift and add 1 gives
 392  * us the power of 2 below the theoretical max, so GCC simply does a
 393  * shift. */
 394 #define _POW2_BELOW2(x) ((x)|((x)>>1))
 395 #define _POW2_BELOW4(x) (_POW2_BELOW2(x)|_POW2_BELOW2((x)>>2))
 396 #define _POW2_BELOW8(x) (_POW2_BELOW4(x)|_POW2_BELOW4((x)>>4))
 397 #define _POW2_BELOW16(x) (_POW2_BELOW8(x)|_POW2_BELOW8((x)>>8))
 398 #define _POW2_BELOW32(x) (_POW2_BELOW16(x)|_POW2_BELOW16((x)>>16))
 399 #define POW2_BELOW32(x) ((_POW2_BELOW32(x)>>1) + 1)
 400
 401 #define CREDITS_PER_JIFFY POW2_BELOW32(MAX_CPJ)
 402
 403 /* in byte mode, the lowest possible rate is one packet/second.
 404  * credit_cap is used as a counter that tells us how many times we can
 405  * refill the "credits available" counter when it becomes empty.
 406  */
 407 #define MAX_CPJ_BYTES (0xFFFFFFFF / HZ)
 408 #define CREDITS_PER_JIFFY_BYTES POW2_BELOW32(MAX_CPJ_BYTES)
 409
 410 static u32 xt_hashlimit_len_to_chunks(u32 len)
 411 {
 412         return (len >> XT_HASHLIMIT_BYTE_SHIFT) + 1;
 413 }
 414
 415 /* Precision saver. */
 416 static u32 user2credits(u32 user)
 417 {
 418         /* If multiplying would overflow... */
 419         if (user > 0xFFFFFFFF / (HZ*CREDITS_PER_JIFFY))
 420                 /* Divide first. */
 421                 return (user / XT_HASHLIMIT_SCALE) * HZ * CREDITS_PER_JIFFY;
 422
 423         return (user * HZ * CREDITS_PER_JIFFY) / XT_HASHLIMIT_SCALE;
 424 }
 425
 426 static u32 user2credits_byte(u32 user)
 427 {
 428         u64 us = user;
 429         us *= HZ * CREDITS_PER_JIFFY_BYTES;
 430         return (u32) (us >> 32);
 431 }
 432
 433 static void rateinfo_recalc(struct dsthash_ent *dh, unsigned long now, u32 mode)
 434 {
 435         unsigned long delta = now - dh->rateinfo.prev;
 436         u32 cap;
 437
 438         if (delta == 0)
 439                 return;
 440
 441         dh->rateinfo.prev = now;
 442
 443         if (mode & XT_HASHLIMIT_BYTES) {
 444                 u32 tmp = dh->rateinfo.credit;
 445                 dh->rateinfo.credit += CREDITS_PER_JIFFY_BYTES * delta;
 446                 cap = CREDITS_PER_JIFFY_BYTES * HZ;
 447                 if (tmp >= dh->rateinfo.credit) {/* overflow */
 448                         dh->rateinfo.credit = cap;
 449                         return;
 450                 }
 451         } else {
 452                 dh->rateinfo.credit += delta * CREDITS_PER_JIFFY;
 453                 cap = dh->rateinfo.credit_cap;
 454         }
 455         if (dh->rateinfo.credit > cap)
 456                 dh->rateinfo.credit = cap;
 457 }
 458
 459 static void rateinfo_init(struct dsthash_ent *dh,
 460                           struct xt_hashlimit_htable *hinfo)
 461 {
 462         dh->rateinfo.prev = jiffies;
 463         if (hinfo->cfg.mode & XT_HASHLIMIT_BYTES) {
 464                 dh->rateinfo.credit = CREDITS_PER_JIFFY_BYTES * HZ;
 465                 dh->rateinfo.cost = user2credits_byte(hinfo->cfg.avg);
 466                 dh->rateinfo.credit_cap = hinfo->cfg.burst;
 467         } else {
 468                 dh->rateinfo.credit = user2credits(hinfo->cfg.avg *
 469                                                    hinfo->cfg.burst);
 470                 dh->rateinfo.cost = user2credits(hinfo->cfg.avg);
 471                 dh->rateinfo.credit_cap = dh->rateinfo.credit;
 472         }
 473 }
 474
 475 static inline __be32 maskl(__be32 a, unsigned int l)
 476 {
 477         return l ? htonl(ntohl(a) & ~0 << (32 - l)) : 0;
 478 }
 479
 480 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 481 static void hashlimit_ipv6_mask(__be32 *i, unsigned int p)
 482 {
 483         switch (p) {
 484         case 0 ... 31:
 485                 i[0] = maskl(i[0], p);
 486                 i[1] = i[2] = i[3] = 0;
 487                 break;
 488         case 32 ... 63:
 489                 i[1] = maskl(i[1], p - 32);
 490                 i[2] = i[3] = 0;
 491                 break;
 492         case 64 ... 95:
 493                 i[2] = maskl(i[2], p - 64);
 494                 i[3] = 0;
 495                 break;
 496         case 96 ... 127:
 497                 i[3] = maskl(i[3], p - 96);
 498                 break;
 499         case 128:
 500                 break;
 501         }
 502 }
 503 #endif
 504
 505 static int
 506 hashlimit_init_dst(const struct xt_hashlimit_htable *hinfo,
 507                    struct dsthash_dst *dst,
 508                    const struct sk_buff *skb, unsigned int protoff)
 509 {
 510         __be16 _ports[2], *ports;
 511         u8 nexthdr;
 512         int poff;
 513
 514         memset(dst, 0, sizeof(*dst));
 515
 516         switch (hinfo->family) {
 517         case NFPROTO_IPV4:
 518                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DIP)
 519                         dst->ip.dst = maskl(ip_hdr(skb)->daddr,
 520                                       hinfo->cfg.dstmask);
 521                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SIP)
 522                         dst->ip.src = maskl(ip_hdr(skb)->saddr,
 523                                       hinfo->cfg.srcmask);
 524
 525                 if (!(hinfo->cfg.mode &
 526                       (XT_HASHLIMIT_HASH_DPT | XT_HASHLIMIT_HASH_SPT)))
 527                         return 0;
 528                 nexthdr = ip_hdr(skb)->protocol;
 529                 break;
 530 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 531         case NFPROTO_IPV6:
 532         {
 533                 __be16 frag_off;
 534
 535                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DIP) {
 536                         memcpy(&dst->ip6.dst, &ipv6_hdr(skb)->daddr,
 537                                sizeof(dst->ip6.dst));
 538                         hashlimit_ipv6_mask(dst->ip6.dst, hinfo->cfg.dstmask);
 539                 }
 540                 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SIP) {
 541                         memcpy(&dst->ip6.src, &ipv6_hdr(skb)->saddr,
 542                                sizeof(dst->ip6.src));
 543                         hashlimit_ipv6_mask(dst->ip6.src, hinfo->cfg.srcmask);
 544                 }
 545
 546                 if (!(hinfo->cfg.mode &
 547                       (XT_HASHLIMIT_HASH_DPT | XT_HASHLIMIT_HASH_SPT)))
 548                         return 0;
 549                 nexthdr = ipv6_hdr(skb)->nexthdr;
 550                 protoff = ipv6_skip_exthdr(skb, sizeof(struct ipv6hdr), &nexthdr, &frag_off);
 551                 if ((int)protoff < 0)
 552                         return -1;
 553                 break;
 554         }
 555 #endif
 556         default:
 557                 BUG();
 558                 return 0;
 559         }
 560
 561         poff = proto_ports_offset(nexthdr);
 562         if (poff >= 0) {
 563                 ports = skb_header_pointer(skb, protoff + poff, sizeof(_ports),
 564                                            &_ports);
 565         } else {
 566                 _ports[0] = _ports[1] = 0;
 567                 ports = _ports;
 568         }
 569         if (!ports)
 570                 return -1;
 571         if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SPT)
 572                 dst->src_port = ports[0];
 573         if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DPT)
 574                 dst->dst_port = ports[1];
 575         return 0;
 576 }
 577
 578 static u32 hashlimit_byte_cost(unsigned int len, struct dsthash_ent *dh)
 579 {
 580         u64 tmp = xt_hashlimit_len_to_chunks(len);
 581         tmp = tmp * dh->rateinfo.cost;
 582
 583         if (unlikely(tmp > CREDITS_PER_JIFFY_BYTES * HZ))
 584                 tmp = CREDITS_PER_JIFFY_BYTES * HZ;
 585
 586         if (dh->rateinfo.credit < tmp && dh->rateinfo.credit_cap) {
 587                 dh->rateinfo.credit_cap--;
 588                 dh->rateinfo.credit = CREDITS_PER_JIFFY_BYTES * HZ;
 589         }
 590         return (u32) tmp;
 591 }
 592
 593 static bool
 594 hashlimit_mt(const struct sk_buff *skb, struct xt_action_param *par)
 595 {
 596         const struct xt_hashlimit_mtinfo1 *info = par->matchinfo;
 597         struct xt_hashlimit_htable *hinfo = info->hinfo;
 598         unsigned long now = jiffies;
 599         struct dsthash_ent *dh;
 600         struct dsthash_dst dst;
 601         bool race = false;
 602         u32 cost;
 603
 604         if (hashlimit_init_dst(hinfo, &dst, skb, par->thoff) < 0)
 605                 goto hotdrop;
 606
 607         rcu_read_lock_bh();
 608         dh = dsthash_find(hinfo, &dst);
 609         if (dh == NULL) {
 610                 dh = dsthash_alloc_init(hinfo, &dst, &race);
 611                 if (dh == NULL) {
 612                         rcu_read_unlock_bh();
 613                         goto hotdrop;
 614                 } else if (race) {
 615                         /* Already got an entry, update expiration timeout */
 616                         dh->expires = now + msecs_to_jiffies(hinfo->cfg.expire);
 617                         rateinfo_recalc(dh, now, hinfo->cfg.mode);
 618                 } else {
 619                         dh->expires = jiffies + msecs_to_jiffies(hinfo->cfg.expire);
 620                         rateinfo_init(dh, hinfo);
 621                 }
 622         } else {
 623                 /* update expiration timeout */
 624                 dh->expires = now + msecs_to_jiffies(hinfo->cfg.expire);
 625                 rateinfo_recalc(dh, now, hinfo->cfg.mode);
 626         }
 627
 628         if (info->cfg.mode & XT_HASHLIMIT_BYTES)
 629                 cost = hashlimit_byte_cost(skb->len, dh);
 630         else
 631                 cost = dh->rateinfo.cost;
 632
 633         if (dh->rateinfo.credit >= cost) {
 634                 /* below the limit */
 635                 dh->rateinfo.credit -= cost;
 636                 spin_unlock(&dh->lock);
 637                 rcu_read_unlock_bh();
 638                 return !(info->cfg.mode & XT_HASHLIMIT_INVERT);
 639         }
 640
 641         spin_unlock(&dh->lock);
 642         rcu_read_unlock_bh();
 643         /* default match is underlimit - so over the limit, we need to invert */
 644         return info->cfg.mode & XT_HASHLIMIT_INVERT;
 645
 646  hotdrop:
 647         par->hotdrop = true;
 648         return false;
 649 }
 650
 651 static int hashlimit_mt_check(const struct xt_mtchk_param *par)
 652 {
 653         struct net *net = par->net;
 654         struct xt_hashlimit_mtinfo1 *info = par->matchinfo;
 655         int ret;
 656
 657         if (info->cfg.gc_interval == 0 || info->cfg.expire == 0)
 658                 return -EINVAL;
 659         if (info->name[sizeof(info->name)-1] != '\0')
 660                 return -EINVAL;
 661         if (par->family == NFPROTO_IPV4) {
 662                 if (info->cfg.srcmask > 32 || info->cfg.dstmask > 32)
 663                         return -EINVAL;
 664         } else {
 665                 if (info->cfg.srcmask > 128 || info->cfg.dstmask > 128)
 666                         return -EINVAL;
 667         }
 668
 669         if (info->cfg.mode & ~XT_HASHLIMIT_ALL) {
 670                 pr_info("Unknown mode mask %X, kernel too old?\n",
 671                                                 info->cfg.mode);
 672                 return -EINVAL;
 673         }
 674
 675         /* Check for overflow. */
 676         if (info->cfg.mode & XT_HASHLIMIT_BYTES) {
 677                 if (user2credits_byte(info->cfg.avg) == 0) {
 678                         pr_info("overflow, rate too high: %u\n", info->cfg.avg);
 679                         return -EINVAL;
 680                 }
 681         } else if (info->cfg.burst == 0 ||
 682                     user2credits(info->cfg.avg * info->cfg.burst) <
 683                     user2credits(info->cfg.avg)) {
 684                         pr_info("overflow, try lower: %u/%u\n",
 685                                 info->cfg.avg, info->cfg.burst);
 686                         return -ERANGE;
 687         }
 688
 689         mutex_lock(&hashlimit_mutex);
 690         info->hinfo = htable_find_get(net, info->name, par->family);
 691         if (info->hinfo == NULL) {
 692                 ret = htable_create(net, info, par->family);
 693                 if (ret < 0) {
 694                         mutex_unlock(&hashlimit_mutex);
 695                         return ret;
 696                 }
 697         }
 698         mutex_unlock(&hashlimit_mutex);
 699         return 0;
 700 }
 701
 702 static void hashlimit_mt_destroy(const struct xt_mtdtor_param *par)
 703 {
 704         const struct xt_hashlimit_mtinfo1 *info = par->matchinfo;
 705
 706         htable_put(info->hinfo);
 707 }
 708
 709 static struct xt_match hashlimit_mt_reg[] __read_mostly = {
 710         {
 711                 .name           = "hashlimit",
 712                 .revision       = 1,
 713                 .family         = NFPROTO_IPV4,
 714                 .match          = hashlimit_mt,
 715                 .matchsize      = sizeof(struct xt_hashlimit_mtinfo1),
 716                 .checkentry     = hashlimit_mt_check,
 717                 .destroy        = hashlimit_mt_destroy,
 718                 .me             = THIS_MODULE,
 719         },
 720 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 721         {
 722                 .name           = "hashlimit",
 723                 .revision       = 1,
 724                 .family         = NFPROTO_IPV6,
 725                 .match          = hashlimit_mt,
 726                 .matchsize      = sizeof(struct xt_hashlimit_mtinfo1),
 727                 .checkentry     = hashlimit_mt_check,
 728                 .destroy        = hashlimit_mt_destroy,
 729                 .me             = THIS_MODULE,
 730         },
 731 #endif
 732 };
 733
 734 /* PROC stuff */
 735 static void *dl_seq_start(struct seq_file *s, loff_t *pos)
 736         __acquires(htable->lock)
 737 {
 738         struct xt_hashlimit_htable *htable = s->private;
 739         unsigned int *bucket;
 740
 741         spin_lock_bh(&htable->lock);
 742         if (*pos >= htable->cfg.size)
 743                 return NULL;
 744
 745         bucket = kmalloc(sizeof(unsigned int), GFP_ATOMIC);
 746         if (!bucket)
 747                 return ERR_PTR(-ENOMEM);
 748
 749         *bucket = *pos;
 750         return bucket;
 751 }
 752
 753 static void *dl_seq_next(struct seq_file *s, void *v, loff_t *pos)
 754 {
 755         struct xt_hashlimit_htable *htable = s->private;
 756         unsigned int *bucket = (unsigned int *)v;
 757
 758         *pos = ++(*bucket);
 759         if (*pos >= htable->cfg.size) {
 760                 kfree(v);
 761                 return NULL;
 762         }
 763         return bucket;
 764 }
 765
 766 static void dl_seq_stop(struct seq_file *s, void *v)
 767         __releases(htable->lock)
 768 {
 769         struct xt_hashlimit_htable *htable = s->private;
 770         unsigned int *bucket = (unsigned int *)v;
 771
 772         if (!IS_ERR(bucket))
 773                 kfree(bucket);
 774         spin_unlock_bh(&htable->lock);
 775 }
 776
 777 static int dl_seq_real_show(struct dsthash_ent *ent, u_int8_t family,
 778                                    struct seq_file *s)
 779 {
 780         int res;
 781         const struct xt_hashlimit_htable *ht = s->private;
 782
 783         spin_lock(&ent->lock);
 784         /* recalculate to show accurate numbers */
 785         rateinfo_recalc(ent, jiffies, ht->cfg.mode);
 786
 787         switch (family) {
 788         case NFPROTO_IPV4:
 789                 res = seq_printf(s, "%ld %pI4:%u->%pI4:%u %u %u %u\n",
 790                                  (long)(ent->expires - jiffies)/HZ,
 791                                  &ent->dst.ip.src,
 792                                  ntohs(ent->dst.src_port),
 793                                  &ent->dst.ip.dst,
 794                                  ntohs(ent->dst.dst_port),
 795                                  ent->rateinfo.credit, ent->rateinfo.credit_cap,
 796                                  ent->rateinfo.cost);
 797                 break;
 798 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 799         case NFPROTO_IPV6:
 800                 res = seq_printf(s, "%ld %pI6:%u->%pI6:%u %u %u %u\n",
 801                                  (long)(ent->expires - jiffies)/HZ,
 802                                  &ent->dst.ip6.src,
 803                                  ntohs(ent->dst.src_port),
 804                                  &ent->dst.ip6.dst,
 805                                  ntohs(ent->dst.dst_port),
 806                                  ent->rateinfo.credit, ent->rateinfo.credit_cap,
 807                                  ent->rateinfo.cost);
 808                 break;
 809 #endif
 810         default:
 811                 BUG();
 812                 res = 0;
 813         }
 814         spin_unlock(&ent->lock);
 815         return res;
 816 }
 817
 818 static int dl_seq_show(struct seq_file *s, void *v)
 819 {
 820         struct xt_hashlimit_htable *htable = s->private;
 821         unsigned int *bucket = (unsigned int *)v;
 822         struct dsthash_ent *ent;
 823
 824         if (!hlist_empty(&htable->hash[*bucket])) {
 825                 hlist_for_each_entry(ent, &htable->hash[*bucket], node)
 826                         if (dl_seq_real_show(ent, htable->family, s))
 827                                 return -1;
 828         }
 829         return 0;
 830 }
 831
 832 static const struct seq_operations dl_seq_ops = {
 833         .start = dl_seq_start,
 834         .next  = dl_seq_next,
 835         .stop  = dl_seq_stop,
 836         .show  = dl_seq_show
 837 };
 838
 839 static int dl_proc_open(struct inode *inode, struct file *file)
 840 {
 841         int ret = seq_open(file, &dl_seq_ops);
 842
 843         if (!ret) {
 844                 struct seq_file *sf = file->private_data;
 845                 sf->private = PDE(inode)->data;
 846         }
 847         return ret;
 848 }
 849
 850 static const struct file_operations dl_file_ops = {
 851         .owner   = THIS_MODULE,
 852         .open    = dl_proc_open,
 853         .read    = seq_read,
 854         .llseek  = seq_lseek,
 855         .release = seq_release
 856 };
 857
 858 static int __net_init hashlimit_proc_net_init(struct net *net)
 859 {
 860         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 861
 862         hashlimit_net->ipt_hashlimit = proc_mkdir("ipt_hashlimit", net->proc_net);
 863         if (!hashlimit_net->ipt_hashlimit)
 864                 return -ENOMEM;
 865 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 866         hashlimit_net->ip6t_hashlimit = proc_mkdir("ip6t_hashlimit", net->proc_net);
 867         if (!hashlimit_net->ip6t_hashlimit) {
 868                 remove_proc_entry("ipt_hashlimit", net->proc_net);
 869                 return -ENOMEM;
 870         }
 871 #endif
 872         return 0;
 873 }
 874
 875 static void __net_exit hashlimit_proc_net_exit(struct net *net)
 876 {
 877         struct xt_hashlimit_htable *hinfo;
 878         struct proc_dir_entry *pde;
 879         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 880
 881         /* recent_net_exit() is called before recent_mt_destroy(). Make sure
 882          * that the parent xt_recent proc entry is is empty before trying to
 883          * remove it.
 884          */
 885         mutex_lock(&hashlimit_mutex);
 886         pde = hashlimit_net->ipt_hashlimit;
 887         if (pde == NULL)
 888                 pde = hashlimit_net->ip6t_hashlimit;
 889
 890         hlist_for_each_entry(hinfo, &hashlimit_net->htables, node)
 891                 remove_proc_entry(hinfo->pde->name, pde);
 892
 893         hashlimit_net->ipt_hashlimit = NULL;
 894         hashlimit_net->ip6t_hashlimit = NULL;
 895         mutex_unlock(&hashlimit_mutex);
 896
 897         remove_proc_entry("ipt_hashlimit", net->proc_net);
 898 #if IS_ENABLED(CONFIG_IP6_NF_IPTABLES)
 899         remove_proc_entry("ip6t_hashlimit", net->proc_net);
 900 #endif
 901 }
 902
 903 static int __net_init hashlimit_net_init(struct net *net)
 904 {
 905         struct hashlimit_net *hashlimit_net = hashlimit_pernet(net);
 906
 907         INIT_HLIST_HEAD(&hashlimit_net->htables);
 908         return hashlimit_proc_net_init(net);
 909 }
 910
 911 static void __net_exit hashlimit_net_exit(struct net *net)
 912 {
 913         hashlimit_proc_net_exit(net);
 914 }
 915
 916 static struct pernet_operations hashlimit_net_ops = {
 917         .init   = hashlimit_net_init,
 918         .exit   = hashlimit_net_exit,
 919         .id     = &hashlimit_net_id,
 920         .size   = sizeof(struct hashlimit_net),
 921 };
 922
 923 static int __init hashlimit_mt_init(void)
 924 {
 925         int err;
 926
 927         err = register_pernet_subsys(&hashlimit_net_ops);
 928         if (err < 0)
 929                 return err;
 930         err = xt_register_matches(hashlimit_mt_reg,
 931               ARRAY_SIZE(hashlimit_mt_reg));
 932         if (err < 0)
 933                 goto err1;
 934
 935         err = -ENOMEM;
 936         hashlimit_cachep = kmem_cache_create("xt_hashlimit",
 937                                             sizeof(struct dsthash_ent), 0, 0,
 938                                             NULL);
 939         if (!hashlimit_cachep) {
 940                 pr_warning("unable to create slab cache\n");
 941                 goto err2;
 942         }
 943         return 0;
 944
 945 err2:
 946         xt_unregister_matches(hashlimit_mt_reg, ARRAY_SIZE(hashlimit_mt_reg));
 947 err1:
 948         unregister_pernet_subsys(&hashlimit_net_ops);
 949         return err;
 950
 951 }
 952
 953 static void __exit hashlimit_mt_exit(void)
 954 {
 955         xt_unregister_matches(hashlimit_mt_reg, ARRAY_SIZE(hashlimit_mt_reg));
 956         unregister_pernet_subsys(&hashlimit_net_ops);
 957
 958         rcu_barrier_bh();
 959         kmem_cache_destroy(hashlimit_cachep);
 960 }
 961
 962 module_init(hashlimit_mt_init);
 963 module_exit(hashlimit_mt_exit);