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