1 /* iptables match extension to limit the number of packets per second
2 * seperately for each hashbucket (sourceip/sourceport/dstip/dstport)
4 * (C) 2003-2004 by Harald Welte <laforge@netfilter.org>
6 * $Id: ipt_hashlimit.c 3244 2004-10-20 16:24:29Z laforge@netfilter.org $
8 * Development of this code was funded by Astaro AG, http://www.astaro.com/
10 #include <linux/module.h>
11 #include <linux/spinlock.h>
12 #include <linux/random.h>
13 #include <linux/jhash.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
16 #include <linux/proc_fs.h>
17 #include <linux/seq_file.h>
18 #include <linux/list.h>
19 #include <linux/skbuff.h>
23 #include <linux/ipv6.h>
25 #include <linux/netfilter/x_tables.h>
26 #include <linux/netfilter_ipv4/ip_tables.h>
27 #include <linux/netfilter_ipv6/ip6_tables.h>
28 #include <linux/netfilter/xt_hashlimit.h>
29 #include <linux/mutex.h>
31 MODULE_LICENSE("GPL");
32 MODULE_AUTHOR("Harald Welte <laforge@netfilter.org>");
33 MODULE_DESCRIPTION("iptables match for limiting per hash-bucket");
34 MODULE_ALIAS("ipt_hashlimit");
35 MODULE_ALIAS("ip6t_hashlimit");
37 /* need to declare this at the top */
38 static struct proc_dir_entry *hashlimit_procdir4;
39 static struct proc_dir_entry *hashlimit_procdir6;
40 static const struct file_operations dl_file_ops;
59 /* static / read-only parts in the beginning */
60 struct hlist_node node;
61 struct dsthash_dst dst;
63 /* modified structure members in the end */
64 unsigned long expires; /* precalculated expiry time */
66 unsigned long prev; /* last modification */
68 u_int32_t credit_cap, cost;
72 struct xt_hashlimit_htable {
73 struct hlist_node node; /* global list of all htables */
77 struct hashlimit_cfg cfg; /* config */
80 spinlock_t lock; /* lock for list_head */
81 u_int32_t rnd; /* random seed for hash */
83 unsigned int count; /* number entries in table */
84 struct timer_list timer; /* timer for gc */
87 struct proc_dir_entry *pde;
89 struct hlist_head hash[0]; /* hashtable itself */
92 static DEFINE_SPINLOCK(hashlimit_lock); /* protects htables list */
93 static DEFINE_MUTEX(hlimit_mutex); /* additional checkentry protection */
94 static HLIST_HEAD(hashlimit_htables);
95 static struct kmem_cache *hashlimit_cachep __read_mostly;
97 static inline int dst_cmp(const struct dsthash_ent *ent, struct dsthash_dst *b)
99 return !memcmp(&ent->dst, b, sizeof(ent->dst));
103 hash_dst(const struct xt_hashlimit_htable *ht, const struct dsthash_dst *dst)
105 return jhash(dst, sizeof(*dst), ht->rnd) % ht->cfg.size;
108 static struct dsthash_ent *
109 dsthash_find(const struct xt_hashlimit_htable *ht, struct dsthash_dst *dst)
111 struct dsthash_ent *ent;
112 struct hlist_node *pos;
113 u_int32_t hash = hash_dst(ht, dst);
115 if (!hlist_empty(&ht->hash[hash])) {
116 hlist_for_each_entry(ent, pos, &ht->hash[hash], node)
117 if (dst_cmp(ent, dst))
123 /* allocate dsthash_ent, initialize dst, put in htable and lock it */
124 static struct dsthash_ent *
125 dsthash_alloc_init(struct xt_hashlimit_htable *ht, struct dsthash_dst *dst)
127 struct dsthash_ent *ent;
129 /* initialize hash with random val at the time we allocate
130 * the first hashtable entry */
131 if (!ht->rnd_initialized) {
132 get_random_bytes(&ht->rnd, 4);
133 ht->rnd_initialized = 1;
136 if (ht->cfg.max && ht->count >= ht->cfg.max) {
137 /* FIXME: do something. question is what.. */
140 "xt_hashlimit: max count of %u reached\n",
145 ent = kmem_cache_alloc(hashlimit_cachep, GFP_ATOMIC);
149 "xt_hashlimit: can't allocate dsthash_ent\n");
152 memcpy(&ent->dst, dst, sizeof(ent->dst));
154 hlist_add_head(&ent->node, &ht->hash[hash_dst(ht, dst)]);
160 dsthash_free(struct xt_hashlimit_htable *ht, struct dsthash_ent *ent)
162 hlist_del(&ent->node);
163 kmem_cache_free(hashlimit_cachep, ent);
166 static void htable_gc(unsigned long htlong);
168 static int htable_create(struct xt_hashlimit_info *minfo, int family)
170 struct xt_hashlimit_htable *hinfo;
175 size = minfo->cfg.size;
177 size = ((num_physpages << PAGE_SHIFT) / 16384) /
178 sizeof(struct list_head);
179 if (num_physpages > (1024 * 1024 * 1024 / PAGE_SIZE))
184 /* FIXME: don't use vmalloc() here or anywhere else -HW */
185 hinfo = vmalloc(sizeof(struct xt_hashlimit_htable) +
186 sizeof(struct list_head) * size);
188 printk(KERN_ERR "xt_hashlimit: unable to create hashtable\n");
191 minfo->hinfo = hinfo;
193 /* copy match config into hashtable config */
194 memcpy(&hinfo->cfg, &minfo->cfg, sizeof(hinfo->cfg));
195 hinfo->cfg.size = size;
197 hinfo->cfg.max = 8 * hinfo->cfg.size;
198 else if (hinfo->cfg.max < hinfo->cfg.size)
199 hinfo->cfg.max = hinfo->cfg.size;
201 for (i = 0; i < hinfo->cfg.size; i++)
202 INIT_HLIST_HEAD(&hinfo->hash[i]);
204 atomic_set(&hinfo->use, 1);
206 hinfo->family = family;
207 hinfo->rnd_initialized = 0;
208 spin_lock_init(&hinfo->lock);
209 hinfo->pde = create_proc_entry(minfo->name, 0,
210 family == AF_INET ? hashlimit_procdir4 :
216 hinfo->pde->proc_fops = &dl_file_ops;
217 hinfo->pde->data = hinfo;
219 init_timer(&hinfo->timer);
220 hinfo->timer.expires = jiffies + msecs_to_jiffies(hinfo->cfg.gc_interval);
221 hinfo->timer.data = (unsigned long )hinfo;
222 hinfo->timer.function = htable_gc;
223 add_timer(&hinfo->timer);
225 spin_lock_bh(&hashlimit_lock);
226 hlist_add_head(&hinfo->node, &hashlimit_htables);
227 spin_unlock_bh(&hashlimit_lock);
232 static int select_all(struct xt_hashlimit_htable *ht, struct dsthash_ent *he)
237 static int select_gc(struct xt_hashlimit_htable *ht, struct dsthash_ent *he)
239 return (jiffies >= he->expires);
242 static void htable_selective_cleanup(struct xt_hashlimit_htable *ht,
243 int (*select)(struct xt_hashlimit_htable *ht,
244 struct dsthash_ent *he))
248 /* lock hash table and iterate over it */
249 spin_lock_bh(&ht->lock);
250 for (i = 0; i < ht->cfg.size; i++) {
251 struct dsthash_ent *dh;
252 struct hlist_node *pos, *n;
253 hlist_for_each_entry_safe(dh, pos, n, &ht->hash[i], node) {
254 if ((*select)(ht, dh))
255 dsthash_free(ht, dh);
258 spin_unlock_bh(&ht->lock);
261 /* hash table garbage collector, run by timer */
262 static void htable_gc(unsigned long htlong)
264 struct xt_hashlimit_htable *ht = (struct xt_hashlimit_htable *)htlong;
266 htable_selective_cleanup(ht, select_gc);
268 /* re-add the timer accordingly */
269 ht->timer.expires = jiffies + msecs_to_jiffies(ht->cfg.gc_interval);
270 add_timer(&ht->timer);
273 static void htable_destroy(struct xt_hashlimit_htable *hinfo)
275 /* remove timer, if it is pending */
276 if (timer_pending(&hinfo->timer))
277 del_timer(&hinfo->timer);
279 /* remove proc entry */
280 remove_proc_entry(hinfo->pde->name,
281 hinfo->family == AF_INET ? hashlimit_procdir4 :
283 htable_selective_cleanup(hinfo, select_all);
287 static struct xt_hashlimit_htable *htable_find_get(char *name, int family)
289 struct xt_hashlimit_htable *hinfo;
290 struct hlist_node *pos;
292 spin_lock_bh(&hashlimit_lock);
293 hlist_for_each_entry(hinfo, pos, &hashlimit_htables, node) {
294 if (!strcmp(name, hinfo->pde->name) &&
295 hinfo->family == family) {
296 atomic_inc(&hinfo->use);
297 spin_unlock_bh(&hashlimit_lock);
301 spin_unlock_bh(&hashlimit_lock);
305 static void htable_put(struct xt_hashlimit_htable *hinfo)
307 if (atomic_dec_and_test(&hinfo->use)) {
308 spin_lock_bh(&hashlimit_lock);
309 hlist_del(&hinfo->node);
310 spin_unlock_bh(&hashlimit_lock);
311 htable_destroy(hinfo);
315 /* The algorithm used is the Simple Token Bucket Filter (TBF)
316 * see net/sched/sch_tbf.c in the linux source tree
319 /* Rusty: This is my (non-mathematically-inclined) understanding of
320 this algorithm. The `average rate' in jiffies becomes your initial
321 amount of credit `credit' and the most credit you can ever have
322 `credit_cap'. The `peak rate' becomes the cost of passing the
325 `prev' tracks the last packet hit: you gain one credit per jiffy.
326 If you get credit balance more than this, the extra credit is
327 discarded. Every time the match passes, you lose `cost' credits;
328 if you don't have that many, the test fails.
330 See Alexey's formal explanation in net/sched/sch_tbf.c.
332 To get the maximum range, we multiply by this factor (ie. you get N
333 credits per jiffy). We want to allow a rate as low as 1 per day
334 (slowest userspace tool allows), which means
335 CREDITS_PER_JIFFY*HZ*60*60*24 < 2^32 ie.
337 #define MAX_CPJ (0xFFFFFFFF / (HZ*60*60*24))
339 /* Repeated shift and or gives us all 1s, final shift and add 1 gives
340 * us the power of 2 below the theoretical max, so GCC simply does a
342 #define _POW2_BELOW2(x) ((x)|((x)>>1))
343 #define _POW2_BELOW4(x) (_POW2_BELOW2(x)|_POW2_BELOW2((x)>>2))
344 #define _POW2_BELOW8(x) (_POW2_BELOW4(x)|_POW2_BELOW4((x)>>4))
345 #define _POW2_BELOW16(x) (_POW2_BELOW8(x)|_POW2_BELOW8((x)>>8))
346 #define _POW2_BELOW32(x) (_POW2_BELOW16(x)|_POW2_BELOW16((x)>>16))
347 #define POW2_BELOW32(x) ((_POW2_BELOW32(x)>>1) + 1)
349 #define CREDITS_PER_JIFFY POW2_BELOW32(MAX_CPJ)
351 /* Precision saver. */
352 static inline u_int32_t
353 user2credits(u_int32_t user)
355 /* If multiplying would overflow... */
356 if (user > 0xFFFFFFFF / (HZ*CREDITS_PER_JIFFY))
358 return (user / XT_HASHLIMIT_SCALE) * HZ * CREDITS_PER_JIFFY;
360 return (user * HZ * CREDITS_PER_JIFFY) / XT_HASHLIMIT_SCALE;
363 static inline void rateinfo_recalc(struct dsthash_ent *dh, unsigned long now)
365 dh->rateinfo.credit += (now - dh->rateinfo.prev) * CREDITS_PER_JIFFY;
366 if (dh->rateinfo.credit > dh->rateinfo.credit_cap)
367 dh->rateinfo.credit = dh->rateinfo.credit_cap;
368 dh->rateinfo.prev = now;
372 hashlimit_init_dst(struct xt_hashlimit_htable *hinfo, struct dsthash_dst *dst,
373 const struct sk_buff *skb, unsigned int protoff)
375 __be16 _ports[2], *ports;
378 memset(dst, 0, sizeof(*dst));
380 switch (hinfo->family) {
382 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DIP)
383 dst->addr.ip.dst = skb->nh.iph->daddr;
384 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SIP)
385 dst->addr.ip.src = skb->nh.iph->saddr;
387 if (!(hinfo->cfg.mode &
388 (XT_HASHLIMIT_HASH_DPT | XT_HASHLIMIT_HASH_SPT)))
390 nexthdr = skb->nh.iph->protocol;
392 #if defined(CONFIG_IP6_NF_IPTABLES) || defined(CONFIG_IP6_NF_IPTABLES_MODULE)
394 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DIP)
395 memcpy(&dst->addr.ip6.dst, &skb->nh.ipv6h->daddr,
396 sizeof(dst->addr.ip6.dst));
397 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SIP)
398 memcpy(&dst->addr.ip6.src, &skb->nh.ipv6h->saddr,
399 sizeof(dst->addr.ip6.src));
401 if (!(hinfo->cfg.mode &
402 (XT_HASHLIMIT_HASH_DPT | XT_HASHLIMIT_HASH_SPT)))
404 nexthdr = ipv6_find_hdr(skb, &protoff, -1, NULL);
417 case IPPROTO_UDPLITE:
420 ports = skb_header_pointer(skb, protoff, sizeof(_ports),
424 _ports[0] = _ports[1] = 0;
430 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_SPT)
431 dst->src_port = ports[0];
432 if (hinfo->cfg.mode & XT_HASHLIMIT_HASH_DPT)
433 dst->dst_port = ports[1];
438 hashlimit_match(const struct sk_buff *skb,
439 const struct net_device *in,
440 const struct net_device *out,
441 const struct xt_match *match,
442 const void *matchinfo,
444 unsigned int protoff,
447 struct xt_hashlimit_info *r =
448 ((struct xt_hashlimit_info *)matchinfo)->u.master;
449 struct xt_hashlimit_htable *hinfo = r->hinfo;
450 unsigned long now = jiffies;
451 struct dsthash_ent *dh;
452 struct dsthash_dst dst;
454 if (hashlimit_init_dst(hinfo, &dst, skb, protoff) < 0)
457 spin_lock_bh(&hinfo->lock);
458 dh = dsthash_find(hinfo, &dst);
460 dh = dsthash_alloc_init(hinfo, &dst);
462 spin_unlock_bh(&hinfo->lock);
466 dh->expires = jiffies + msecs_to_jiffies(hinfo->cfg.expire);
467 dh->rateinfo.prev = jiffies;
468 dh->rateinfo.credit = user2credits(hinfo->cfg.avg *
470 dh->rateinfo.credit_cap = user2credits(hinfo->cfg.avg *
472 dh->rateinfo.cost = user2credits(hinfo->cfg.avg);
474 /* update expiration timeout */
475 dh->expires = now + msecs_to_jiffies(hinfo->cfg.expire);
476 rateinfo_recalc(dh, now);
479 if (dh->rateinfo.credit >= dh->rateinfo.cost) {
480 /* We're underlimit. */
481 dh->rateinfo.credit -= dh->rateinfo.cost;
482 spin_unlock_bh(&hinfo->lock);
486 spin_unlock_bh(&hinfo->lock);
488 /* default case: we're overlimit, thus don't match */
497 hashlimit_checkentry(const char *tablename,
499 const struct xt_match *match,
501 unsigned int hook_mask)
503 struct xt_hashlimit_info *r = matchinfo;
505 /* Check for overflow. */
506 if (r->cfg.burst == 0 ||
507 user2credits(r->cfg.avg * r->cfg.burst) < user2credits(r->cfg.avg)) {
508 printk(KERN_ERR "xt_hashlimit: overflow, try lower: %u/%u\n",
509 r->cfg.avg, r->cfg.burst);
512 if (r->cfg.mode == 0 ||
513 r->cfg.mode > (XT_HASHLIMIT_HASH_DPT |
514 XT_HASHLIMIT_HASH_DIP |
515 XT_HASHLIMIT_HASH_SIP |
516 XT_HASHLIMIT_HASH_SPT))
518 if (!r->cfg.gc_interval)
522 if (r->name[sizeof(r->name) - 1] != '\0')
525 /* This is the best we've got: We cannot release and re-grab lock,
526 * since checkentry() is called before x_tables.c grabs xt_mutex.
527 * We also cannot grab the hashtable spinlock, since htable_create will
528 * call vmalloc, and that can sleep. And we cannot just re-search
529 * the list of htable's in htable_create(), since then we would
530 * create duplicate proc files. -HW */
531 mutex_lock(&hlimit_mutex);
532 r->hinfo = htable_find_get(r->name, match->family);
533 if (!r->hinfo && htable_create(r, match->family) != 0) {
534 mutex_unlock(&hlimit_mutex);
537 mutex_unlock(&hlimit_mutex);
539 /* Ugly hack: For SMP, we only want to use one set */
545 hashlimit_destroy(const struct xt_match *match, void *matchinfo)
547 struct xt_hashlimit_info *r = matchinfo;
549 htable_put(r->hinfo);
553 struct compat_xt_hashlimit_info {
555 struct hashlimit_cfg cfg;
557 compat_uptr_t master;
560 static void compat_from_user(void *dst, void *src)
562 int off = offsetof(struct compat_xt_hashlimit_info, hinfo);
564 memcpy(dst, src, off);
565 memset(dst + off, 0, sizeof(struct compat_xt_hashlimit_info) - off);
568 static int compat_to_user(void __user *dst, void *src)
570 int off = offsetof(struct compat_xt_hashlimit_info, hinfo);
572 return copy_to_user(dst, src, off) ? -EFAULT : 0;
576 static struct xt_match xt_hashlimit[] = {
580 .match = hashlimit_match,
581 .matchsize = sizeof(struct xt_hashlimit_info),
583 .compatsize = sizeof(struct compat_xt_hashlimit_info),
584 .compat_from_user = compat_from_user,
585 .compat_to_user = compat_to_user,
587 .checkentry = hashlimit_checkentry,
588 .destroy = hashlimit_destroy,
594 .match = hashlimit_match,
595 .matchsize = sizeof(struct xt_hashlimit_info),
597 .compatsize = sizeof(struct compat_xt_hashlimit_info),
598 .compat_from_user = compat_from_user,
599 .compat_to_user = compat_to_user,
601 .checkentry = hashlimit_checkentry,
602 .destroy = hashlimit_destroy,
608 static void *dl_seq_start(struct seq_file *s, loff_t *pos)
610 struct proc_dir_entry *pde = s->private;
611 struct xt_hashlimit_htable *htable = pde->data;
612 unsigned int *bucket;
614 spin_lock_bh(&htable->lock);
615 if (*pos >= htable->cfg.size)
618 bucket = kmalloc(sizeof(unsigned int), GFP_ATOMIC);
620 return ERR_PTR(-ENOMEM);
626 static void *dl_seq_next(struct seq_file *s, void *v, loff_t *pos)
628 struct proc_dir_entry *pde = s->private;
629 struct xt_hashlimit_htable *htable = pde->data;
630 unsigned int *bucket = (unsigned int *)v;
633 if (*pos >= htable->cfg.size) {
640 static void dl_seq_stop(struct seq_file *s, void *v)
642 struct proc_dir_entry *pde = s->private;
643 struct xt_hashlimit_htable *htable = pde->data;
644 unsigned int *bucket = (unsigned int *)v;
647 spin_unlock_bh(&htable->lock);
650 static int dl_seq_real_show(struct dsthash_ent *ent, int family,
653 /* recalculate to show accurate numbers */
654 rateinfo_recalc(ent, jiffies);
658 return seq_printf(s, "%ld %u.%u.%u.%u:%u->"
659 "%u.%u.%u.%u:%u %u %u %u\n",
660 (long)(ent->expires - jiffies)/HZ,
661 NIPQUAD(ent->dst.addr.ip.src),
662 ntohs(ent->dst.src_port),
663 NIPQUAD(ent->dst.addr.ip.dst),
664 ntohs(ent->dst.dst_port),
665 ent->rateinfo.credit, ent->rateinfo.credit_cap,
668 return seq_printf(s, "%ld " NIP6_FMT ":%u->"
669 NIP6_FMT ":%u %u %u %u\n",
670 (long)(ent->expires - jiffies)/HZ,
671 NIP6(*(struct in6_addr *)&ent->dst.addr.ip6.src),
672 ntohs(ent->dst.src_port),
673 NIP6(*(struct in6_addr *)&ent->dst.addr.ip6.dst),
674 ntohs(ent->dst.dst_port),
675 ent->rateinfo.credit, ent->rateinfo.credit_cap,
683 static int dl_seq_show(struct seq_file *s, void *v)
685 struct proc_dir_entry *pde = s->private;
686 struct xt_hashlimit_htable *htable = pde->data;
687 unsigned int *bucket = (unsigned int *)v;
688 struct dsthash_ent *ent;
689 struct hlist_node *pos;
691 if (!hlist_empty(&htable->hash[*bucket])) {
692 hlist_for_each_entry(ent, pos, &htable->hash[*bucket], node)
693 if (dl_seq_real_show(ent, htable->family, s))
699 static struct seq_operations dl_seq_ops = {
700 .start = dl_seq_start,
706 static int dl_proc_open(struct inode *inode, struct file *file)
708 int ret = seq_open(file, &dl_seq_ops);
711 struct seq_file *sf = file->private_data;
712 sf->private = PDE(inode);
717 static const struct file_operations dl_file_ops = {
718 .owner = THIS_MODULE,
719 .open = dl_proc_open,
722 .release = seq_release
725 static int __init xt_hashlimit_init(void)
729 err = xt_register_matches(xt_hashlimit, ARRAY_SIZE(xt_hashlimit));
734 hashlimit_cachep = kmem_cache_create("xt_hashlimit",
735 sizeof(struct dsthash_ent), 0, 0,
737 if (!hashlimit_cachep) {
738 printk(KERN_ERR "xt_hashlimit: unable to create slab cache\n");
741 hashlimit_procdir4 = proc_mkdir("ipt_hashlimit", proc_net);
742 if (!hashlimit_procdir4) {
743 printk(KERN_ERR "xt_hashlimit: unable to create proc dir "
747 hashlimit_procdir6 = proc_mkdir("ip6t_hashlimit", proc_net);
748 if (!hashlimit_procdir6) {
749 printk(KERN_ERR "xt_hashlimit: unable to create proc dir "
755 remove_proc_entry("ipt_hashlimit", proc_net);
757 kmem_cache_destroy(hashlimit_cachep);
759 xt_unregister_matches(xt_hashlimit, ARRAY_SIZE(xt_hashlimit));
765 static void __exit xt_hashlimit_fini(void)
767 remove_proc_entry("ipt_hashlimit", proc_net);
768 remove_proc_entry("ip6t_hashlimit", proc_net);
769 kmem_cache_destroy(hashlimit_cachep);
770 xt_unregister_matches(xt_hashlimit, ARRAY_SIZE(xt_hashlimit));
773 module_init(xt_hashlimit_init);
774 module_exit(xt_hashlimit_fini);