summaryrefslogtreecommitdiffstats
path: root/kernel/ip_set_hash_ip.c
blob: d99c99b4dbc3eb70c5deacdd7bc013e7d0f1fbe8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
/* Copyright (C) 2003-2010 Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

/* Kernel module implementing an IP set type: the hash:ip type */

#include <linux/module.h>
#include <linux/ip.h>
#include <linux/skbuff.h>
#include <linux/errno.h>
#include <asm/uaccess.h>
#include <asm/bitops.h>
#include <linux/spinlock.h>
#include <linux/random.h>
#include <net/ip.h>
#include <net/ipv6.h>
#include <net/netlink.h>
#include <net/pfxlen.h>

#include <linux/netfilter.h>
#include <linux/netfilter/ip_set.h>
#include <linux/netfilter/ip_set_timeout.h>
#include <linux/netfilter/ip_set_hash.h>

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>");
MODULE_DESCRIPTION("hash:ip type of IP sets");
MODULE_ALIAS("ip_set_hash:ip");

/* Member elements without timeout */
struct ip4_elem {
	uint32_t ip;
};

struct ip6_elem {
	union nf_inet_addr ip;
};

/* Member elements with timeout support */
struct ip4_elem_timeout {
	uint32_t ip;
	unsigned long timeout;
};

struct ip6_elem_timeout {
	union nf_inet_addr ip;
	unsigned long timeout;
};

/* The hash:ip type structure */
struct hash_ip {
	void *members;			/* the set members */
	uint32_t hashsize;		/* hash size */
	uint32_t maxelem;		/* max number of elements/hashsize */
	uint8_t probes;			/* max number of probes  */
	uint8_t resize;			/* resize factor in percent */
	uint8_t netmask;		/* netmask */
	uint32_t timeout;		/* timeout value */
	uint32_t elements;		/* number of elements */
	struct timer_list gc;		/* garbage collector */
	size_t elem_size;		/* size of element */
	initval_t initval[0];		/* initvals for jhash_1word */
};

static inline void *
hash_ip_elem(const struct hash_ip *map, uint32_t id)
{
	return (void *)((char *)map->members + id * map->elem_size);
}

static inline unsigned long
get_ip4_elem_timeout(const struct ip4_elem *elem)
{
	return ((const struct ip4_elem_timeout *)elem)->timeout;
}

static inline unsigned long
get_ip6_elem_timeout(const struct ip6_elem *elem)
{
	return ((const struct ip6_elem_timeout *)elem)->timeout;
}

static inline uint32_t
ip4_hash(struct ip4_elem *elem, initval_t initval, uint32_t hashsize)
{
	return jhash_1word(elem->ip, initval) % hashsize;
}

static inline uint32_t
ip6_hash(struct ip6_elem *elem, initval_t initval, uint32_t hashsize)
{
	return jhash2((u32 *)&elem->ip, 4, initval) % hashsize;
}

static inline bool
ip4_cmp(struct ip4_elem *ip1, struct ip4_elem *ip2)
{
	return ip1->ip == ip2->ip;
}

static inline bool
ip6_cmp(struct ip6_elem *ip1, struct ip6_elem *ip2)
{
	return ipv6_addr_cmp(&ip1->ip.in6, &ip2->ip.in6);
}

static inline bool
ip4_null(struct ip4_elem *elem)
{
	return elem->ip == 0;
}

static inline bool
ip6_null(struct ip6_elem *elem)
{
	return ipv6_addr_any(&elem->ip.in6);
}

static inline void
ip4_cpy(struct ip4_elem *dst, const struct ip4_elem *src)
{
	dst->ip = src->ip;
}

static inline void
ip6_cpy(struct ip6_elem *dst, const struct ip6_elem *src)
{
	ipv6_addr_copy(&dst->ip.in6, &src->ip.in6);
}

/* Zero valued IP addresses (network order) cannot be stored */
static inline void
ip4_zero_out(struct ip4_elem *elem)
{
	elem->ip = 0;
}

static inline void
ip6_zero_out(struct ip6_elem *elem)
{
	ipv6_addr_set(&elem->ip.in6, 0, 0, 0, 0);
}

static inline void
ip6_netmask(union nf_inet_addr *ip, uint8_t prefix)
{
	ip->ip6[0] &= NETMASK6(prefix)[0];
	ip->ip6[1] &= NETMASK6(prefix)[1];
	ip->ip6[2] &= NETMASK6(prefix)[2];
	ip->ip6[3] &= NETMASK6(prefix)[3];
}

/* The type variant functions: generic ones */

static void
hash_ip_destroy(struct ip_set *set)
{
	struct hash_ip *map = set->data;

	/* gc might be running: del_timer_sync can't be used */
	if (set->flags & IP_SET_FLAG_TIMEOUT)
		while (!del_timer(&map->gc))
			msleep(IPSET_DESTROY_TIMER_SLEEP);

	ip_set_free(map->members, set->flags);
	kfree(map);
	
	set->data = NULL;
}

#define hash_ip4_destroy	hash_ip_destroy
#define hash_ip6_destroy	hash_ip_destroy

static void
hash_ip_flush(struct ip_set *set)
{
	struct hash_ip *map = set->data;
	
	memset(map->members, 0, map->hashsize * map->elem_size);
	map->elements = 0;
}

#define hash_ip4_flush		hash_ip_flush
#define hash_ip6_flush		hash_ip_flush

/* IPv4 variant */

#define PF	4
#include "ip_set_hash_ip_src.c"
#undef PF

static int
hash_ip4_kadt(struct ip_set *set, const struct sk_buff *skb,
	      enum ipset_adt adt, uint8_t pf, const uint8_t *flags)
{
	struct hash_ip *map = set->data;
	bool with_timeout = set->flags & IP_SET_FLAG_TIMEOUT;
	uint32_t ip;
	
	if (pf != AF_INET)
		return -EINVAL;

	ip4addrptr(skb, flags, &ip);
	ip &= NETMASK(map->netmask);
	if (ip == 0)
		return -EINVAL;

	switch (adt) {
	case IPSET_TEST:
		return hash_ip4_test(map, with_timeout,
				     (struct ip4_elem *)&ip);
	case IPSET_ADD:
		return hash_ip4_add(map, with_timeout,
				    (struct ip4_elem *)&ip, map->timeout);
	case IPSET_DEL:
		return hash_ip4_del(map, with_timeout, (struct ip4_elem *)&ip);
	default:
		BUG();
	}
	return 0;
}

static const struct nla_policy
hash_ip4_adt_policy[IPSET_ATTR_ADT_MAX + 1] __read_mostly = {
	[IPSET_ATTR_IP]		= { .type = NLA_U32 },
	[IPSET_ATTR_TIMEOUT]	= { .type = NLA_U32 },
};

static int
hash_ip4_uadt(struct ip_set *set, struct nlattr *head, int len,
	      enum ipset_adt adt, uint32_t *lineno, uint32_t flags)
{
	struct hash_ip *map = set->data;
	struct nlattr *tb[IPSET_ATTR_ADT_MAX];
	bool with_timeout = set->flags & IP_SET_FLAG_TIMEOUT;
	uint32_t ip, timeout = map->timeout;

	if (nla_parse(tb, IPSET_ATTR_ADT_MAX, head, len,
		      hash_ip4_adt_policy))
		return -IPSET_ERR_PROTOCOL;

	if (tb[IPSET_ATTR_IP])
		ip = ip_set_get_n32(tb[IPSET_ATTR_IP]);
	else
		return -IPSET_ERR_PROTOCOL;

	ip &= NETMASK(map->netmask);
	if (ip == 0)
		return -IPSET_ERR_HASH_ELEM;

	if (tb[IPSET_ATTR_TIMEOUT]) {
		if (!with_timeout)
			return -IPSET_ERR_TIMEOUT;
		timeout = ip_set_get_h32(tb[IPSET_ATTR_TIMEOUT]);
	}

	switch (adt) {
	case IPSET_TEST:
		return hash_ip4_test(map, with_timeout,
				     (struct ip4_elem *)&ip);
	case IPSET_ADD:
		return hash_ip4_add(map, with_timeout,
				    (struct ip4_elem *)&ip, timeout);
	case IPSET_DEL:
		return hash_ip4_del(map, with_timeout,
				    (struct ip4_elem *)&ip);
	default:
		BUG();
	}

	return 0;
}

/* IPv6 variants */

#define PF	6
#include "ip_set_hash_ip_src.c"
#undef PF

static int
hash_ip6_kadt(struct ip_set *set, const struct sk_buff *skb,
	      enum ipset_adt adt, uint8_t pf, const uint8_t *flags)
{
	struct hash_ip *map = set->data;
	bool with_timeout = set->flags & IP_SET_FLAG_TIMEOUT;
	union nf_inet_addr ip;

	if (pf != AF_INET6)
		return -EINVAL;

	ip6addrptr(skb, flags, &ip.in6);
	ip6_netmask(&ip, map->netmask);
	if (ipv6_addr_any(&ip.in6))
		return -EINVAL;

	switch (adt) {
	case IPSET_TEST:
		return hash_ip6_test(map, with_timeout,
				     (struct ip6_elem *)&ip);
	case IPSET_ADD:
		return hash_ip6_add(map, with_timeout,
				    (struct ip6_elem *)&ip, map->timeout);
	case IPSET_DEL:
		return hash_ip6_del(map, with_timeout,
				    (struct ip6_elem *)&ip);
	default:
		BUG();
	}
	return 0;
}

static const struct nla_policy
hash_ip6_adt_policy[IPSET_ATTR_ADT_MAX + 1] __read_mostly = {
	[IPSET_ATTR_IP]		= { .type = NLA_BINARY,
				    .len = sizeof(struct in6_addr) },
	[IPSET_ATTR_TIMEOUT]	= { .type = NLA_U32 },
};

static int
hash_ip6_uadt(struct ip_set *set, struct nlattr *head, int len,
	      enum ipset_adt adt, uint32_t *lineno, uint32_t flags)
{
	struct hash_ip *map = set->data;
	struct nlattr *tb[IPSET_ATTR_ADT_MAX];
	union nf_inet_addr *ip;
	bool with_timeout = set->flags & IP_SET_FLAG_TIMEOUT;
	uint32_t timeout = map->timeout;

	if (nla_parse(tb, IPSET_ATTR_ADT_MAX, head, len,
		      hash_ip6_adt_policy))
		return -IPSET_ERR_PROTOCOL;

	if (tb[IPSET_ATTR_IP])
		ip = nla_data(tb[IPSET_ATTR_IP]);
	else
		return -IPSET_ERR_PROTOCOL;

	ip6_netmask(ip, map->netmask);
	if (ipv6_addr_any(&ip->in6))
		return -IPSET_ERR_HASH_ELEM;

	if (tb[IPSET_ATTR_TIMEOUT]) {
		if (!with_timeout)
			return -IPSET_ERR_TIMEOUT;
		timeout = ip_set_get_h32(tb[IPSET_ATTR_TIMEOUT]);
	}

	switch (adt) {
	case IPSET_TEST:
		return hash_ip6_test(map, with_timeout,
				     (struct ip6_elem *)ip);
	case IPSET_ADD:
		return hash_ip6_add(map, with_timeout,
				    (struct ip6_elem *)ip, timeout);
	case IPSET_DEL:
		return hash_ip6_del(map, with_timeout,
				    (struct ip6_elem *)ip);
	default:
		BUG();
	}
	
	return 0;
}

/* Create hash:ip type of sets */

static const struct nla_policy
hash_ip_create_policy[IPSET_ATTR_CREATE_MAX+1] __read_mostly = {
	[IPSET_ATTR_HASHSIZE]	= { .type = NLA_U32 },
	[IPSET_ATTR_MAXELEM]	= { .type = NLA_U32 },
	[IPSET_ATTR_PROBES]	= { .type = NLA_U8 },
	[IPSET_ATTR_RESIZE]	= { .type = NLA_U8  },
	[IPSET_ATTR_TIMEOUT]	= { .type = NLA_U32 },
};

static bool
init_map_ip(struct ip_set *set, struct hash_ip *map, uint32_t maxelem,
	    uint32_t probes, uint32_t resize, uint8_t netmask, uint8_t family)
{
	map->members = ip_set_alloc(map->hashsize * map->elem_size,
				    GFP_KERNEL, &set->flags);
	if (!map->members)
		return false;

	map->maxelem = maxelem;
	map->probes = probes;
	map->resize = resize;
	map->netmask = netmask;

	set->data = map;
	set->family = family;
	
	return true;
}

static int
hash_ip_create(struct ip_set *set, struct nlattr *head, int len,
		 uint32_t flags)
{
	struct nlattr *tb[IPSET_ATTR_CREATE_MAX];
	uint32_t hashsize, maxelem;
	uint8_t probes, resize, netmask, family, i;
	struct hash_ip *map;

	if (nla_parse(tb, IPSET_ATTR_CREATE_MAX, head, len,
		      hash_ip_create_policy))
		return -IPSET_ERR_PROTOCOL;

	hashsize = IPSET_DEFAULT_HASHSIZE;
	maxelem = IPSET_DEFAULT_MAXELEM;
	probes = IPSET_DEFAULT_PROBES;
	resize = IPSET_DEFAULT_RESIZE;
	family = AF_INET;

	if (tb[IPSET_ATTR_HASHSIZE])
		hashsize = ip_set_get_h32(tb[IPSET_ATTR_HASHSIZE]);

	if (tb[IPSET_ATTR_MAXELEM])
		maxelem = ip_set_get_h32(tb[IPSET_ATTR_MAXELEM]);

	if (tb[IPSET_ATTR_PROBES])
		probes = nla_get_u8(tb[IPSET_ATTR_PROBES]);

	if (tb[IPSET_ATTR_RESIZE])
		resize = nla_get_u8(tb[IPSET_ATTR_RESIZE]);

	if (tb[IPSET_ATTR_FAMILY])
		family = nla_get_u8(tb[IPSET_ATTR_FAMILY]);
	if (!(family == AF_INET || family == AF_INET6))
		return -IPSET_ERR_INVALID_FAMILY;
	netmask = family == AF_INET ? 32 : 128;

	if (tb[IPSET_ATTR_NETMASK]) {
		netmask = nla_get_u8(tb[IPSET_ATTR_NETMASK]);
		
		if ((family == AF_INET && netmask > 32)
		    || (family == AF_INET6 && netmask > 128))
			return -IPSET_ERR_INVALID_NETMASK;
	}

	map = kzalloc(sizeof(*map) + probes * sizeof(initval_t), GFP_KERNEL);
	if (!map)
		return -ENOMEM;
		
	map->hashsize = hashsize;
	if (tb[IPSET_ATTR_TIMEOUT]) {
		map->elem_size = family == AF_INET
					? sizeof(struct ip4_elem_timeout)
					: sizeof(struct ip6_elem_timeout);

		if (!init_map_ip(set, map, maxelem, probes, resize, netmask, 
				 family)) {
			kfree(map);
			return -ENOMEM;
		}

		map->timeout = ip_set_get_h32(tb[IPSET_ATTR_TIMEOUT]);
		set->flags |= IP_SET_FLAG_TIMEOUT;
		
		if (family == AF_INET)
			hash_ip4_gc_init(set);
		else
			hash_ip6_gc_init(set);
	} else {
		map->elem_size = family == AF_INET
					? sizeof(struct ip4_elem)
					: sizeof(struct ip6_elem);

		if (!init_map_ip(set, map, maxelem, probes, resize, netmask,
				 family)) {
			kfree(map);
			return -ENOMEM;
		}
	}
	for (i = 0; i < map->probes; i++)
		get_random_bytes(((initval_t *) map->initval)+i,
				 sizeof(initval_t));
	
	set->variant = family == AF_INET ? &hash_ip4 : &hash_ip6;
	D("create %s hashsize %u maxelem %u probes %u resize %u",
	   set->name, map->hashsize, map->maxelem, map->probes, map->resize);
	   
	return 0;
}

static struct ip_set_type hash_ip_type = {
	.name		= "hash:ip",
	.protocol	= IPSET_PROTOCOL,
	.features	= IPSET_TYPE_IP,
	.family		= AF_UNSPEC,
	.revision	= 0,
	.create		= hash_ip_create,
	.me		= THIS_MODULE,
};

static int __init
hash_ip_init(void)
{
	return ip_set_type_register(&hash_ip_type);
}

static void __exit
hash_ip_fini(void)
{
	ip_set_type_unregister(&hash_ip_type);
}

module_init(hash_ip_init);
module_exit(hash_ip_fini);