1 /* Copyright (C) 2003-2011 Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 as
5 * published by the Free Software Foundation.
8 /* Kernel module implementing an IP set type: the hash:ip type */
10 #include <linux/jhash.h>
11 #include <linux/module.h>
13 #include <linux/skbuff.h>
14 #include <linux/errno.h>
15 #include <linux/random.h>
18 #include <net/netlink.h>
21 #include <linux/netfilter.h>
22 #include <linux/netfilter/ipset/pfxlen.h>
23 #include <linux/netfilter/ipset/ip_set.h>
24 #include <linux/netfilter/ipset/ip_set_timeout.h>
25 #include <linux/netfilter/ipset/ip_set_hash.h>
27 MODULE_LICENSE("GPL");
28 MODULE_AUTHOR("Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>");
29 MODULE_DESCRIPTION("hash:ip type of IP sets");
30 MODULE_ALIAS("ip_set_hash:ip");
32 /* Type specific function prefix */
36 hash_ip_same_set(const struct ip_set *a, const struct ip_set *b);
38 #define hash_ip4_same_set hash_ip_same_set
39 #define hash_ip6_same_set hash_ip_same_set
41 /* The type variant functions: IPv4 */
43 /* Member elements without timeout */
44 struct hash_ip4_elem {
48 /* Member elements with timeout support */
49 struct hash_ip4_telem {
51 unsigned long timeout;
55 hash_ip4_data_equal(const struct hash_ip4_elem *ip1,
56 const struct hash_ip4_elem *ip2,
59 return ip1->ip == ip2->ip;
63 hash_ip4_data_isnull(const struct hash_ip4_elem *elem)
69 hash_ip4_data_copy(struct hash_ip4_elem *dst, const struct hash_ip4_elem *src)
74 /* Zero valued IP addresses cannot be stored */
76 hash_ip4_data_zero_out(struct hash_ip4_elem *elem)
82 hash_ip4_data_list(struct sk_buff *skb, const struct hash_ip4_elem *data)
84 NLA_PUT_IPADDR4(skb, IPSET_ATTR_IP, data->ip);
92 hash_ip4_data_tlist(struct sk_buff *skb, const struct hash_ip4_elem *data)
94 const struct hash_ip4_telem *tdata =
95 (const struct hash_ip4_telem *)data;
97 NLA_PUT_IPADDR4(skb, IPSET_ATTR_IP, tdata->ip);
98 NLA_PUT_NET32(skb, IPSET_ATTR_TIMEOUT,
99 htonl(ip_set_timeout_get(tdata->timeout)));
107 #define IP_SET_HASH_WITH_NETMASK
110 #include <linux/netfilter/ipset/ip_set_ahash.h>
113 hash_ip4_data_next(struct ip_set_hash *h, const struct hash_ip4_elem *d)
115 h->next.ip = ntohl(d->ip);
119 hash_ip4_kadt(struct ip_set *set, const struct sk_buff *skb,
120 const struct xt_action_param *par,
121 enum ipset_adt adt, const struct ip_set_adt_opt *opt)
123 const struct ip_set_hash *h = set->data;
124 ipset_adtfn adtfn = set->variant->adt[adt];
127 ip4addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &ip);
128 ip &= ip_set_netmask(h->netmask);
132 return adtfn(set, &ip, opt_timeout(opt, h), opt->cmdflags);
136 hash_ip4_uadt(struct ip_set *set, struct nlattr *tb[],
137 enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
139 const struct ip_set_hash *h = set->data;
140 ipset_adtfn adtfn = set->variant->adt[adt];
141 u32 ip, ip_to, hosts, timeout = h->timeout;
145 if (unlikely(!tb[IPSET_ATTR_IP] ||
146 !ip_set_optattr_netorder(tb, IPSET_ATTR_TIMEOUT)))
147 return -IPSET_ERR_PROTOCOL;
149 if (tb[IPSET_ATTR_LINENO])
150 *lineno = nla_get_u32(tb[IPSET_ATTR_LINENO]);
152 ret = ip_set_get_hostipaddr4(tb[IPSET_ATTR_IP], &ip);
156 ip &= ip_set_hostmask(h->netmask);
158 if (tb[IPSET_ATTR_TIMEOUT]) {
159 if (!with_timeout(h->timeout))
160 return -IPSET_ERR_TIMEOUT;
161 timeout = ip_set_timeout_uget(tb[IPSET_ATTR_TIMEOUT]);
164 if (adt == IPSET_TEST) {
167 return -IPSET_ERR_HASH_ELEM;
168 return adtfn(set, &nip, timeout, flags);
171 if (tb[IPSET_ATTR_IP_TO]) {
172 ret = ip_set_get_hostipaddr4(tb[IPSET_ATTR_IP_TO], &ip_to);
177 } else if (tb[IPSET_ATTR_CIDR]) {
178 u8 cidr = nla_get_u8(tb[IPSET_ATTR_CIDR]);
181 return -IPSET_ERR_INVALID_CIDR;
182 ip_set_mask_from_to(ip, ip_to, cidr);
186 hosts = h->netmask == 32 ? 1 : 2 << (32 - h->netmask - 1);
190 for (; !before(ip_to, ip); ip += hosts) {
193 return -IPSET_ERR_HASH_ELEM;
194 ret = adtfn(set, &nip, timeout, flags);
196 if (ret && !ip_set_eexist(ret, flags))
205 hash_ip_same_set(const struct ip_set *a, const struct ip_set *b)
207 const struct ip_set_hash *x = a->data;
208 const struct ip_set_hash *y = b->data;
210 /* Resizing changes htable_bits, so we ignore it */
211 return x->maxelem == y->maxelem &&
212 x->timeout == y->timeout &&
213 x->netmask == y->netmask;
216 /* The type variant functions: IPv6 */
218 struct hash_ip6_elem {
219 union nf_inet_addr ip;
222 struct hash_ip6_telem {
223 union nf_inet_addr ip;
224 unsigned long timeout;
228 hash_ip6_data_equal(const struct hash_ip6_elem *ip1,
229 const struct hash_ip6_elem *ip2,
232 return ipv6_addr_cmp(&ip1->ip.in6, &ip2->ip.in6) == 0;
236 hash_ip6_data_isnull(const struct hash_ip6_elem *elem)
238 return ipv6_addr_any(&elem->ip.in6);
242 hash_ip6_data_copy(struct hash_ip6_elem *dst, const struct hash_ip6_elem *src)
244 ipv6_addr_copy(&dst->ip.in6, &src->ip.in6);
248 hash_ip6_data_zero_out(struct hash_ip6_elem *elem)
250 ipv6_addr_set(&elem->ip.in6, 0, 0, 0, 0);
254 ip6_netmask(union nf_inet_addr *ip, u8 prefix)
256 ip->ip6[0] &= ip_set_netmask6(prefix)[0];
257 ip->ip6[1] &= ip_set_netmask6(prefix)[1];
258 ip->ip6[2] &= ip_set_netmask6(prefix)[2];
259 ip->ip6[3] &= ip_set_netmask6(prefix)[3];
263 hash_ip6_data_list(struct sk_buff *skb, const struct hash_ip6_elem *data)
265 NLA_PUT_IPADDR6(skb, IPSET_ATTR_IP, &data->ip);
273 hash_ip6_data_tlist(struct sk_buff *skb, const struct hash_ip6_elem *data)
275 const struct hash_ip6_telem *e =
276 (const struct hash_ip6_telem *)data;
278 NLA_PUT_IPADDR6(skb, IPSET_ATTR_IP, &e->ip);
279 NLA_PUT_NET32(skb, IPSET_ATTR_TIMEOUT,
280 htonl(ip_set_timeout_get(e->timeout)));
291 #define HOST_MASK 128
292 #include <linux/netfilter/ipset/ip_set_ahash.h>
295 hash_ip6_data_next(struct ip_set_hash *h, const struct hash_ip6_elem *d)
300 hash_ip6_kadt(struct ip_set *set, const struct sk_buff *skb,
301 const struct xt_action_param *par,
302 enum ipset_adt adt, const struct ip_set_adt_opt *opt)
304 const struct ip_set_hash *h = set->data;
305 ipset_adtfn adtfn = set->variant->adt[adt];
306 union nf_inet_addr ip;
308 ip6addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &ip.in6);
309 ip6_netmask(&ip, h->netmask);
310 if (ipv6_addr_any(&ip.in6))
313 return adtfn(set, &ip, opt_timeout(opt, h), opt->cmdflags);
316 static const struct nla_policy hash_ip6_adt_policy[IPSET_ATTR_ADT_MAX + 1] = {
317 [IPSET_ATTR_IP] = { .type = NLA_NESTED },
318 [IPSET_ATTR_TIMEOUT] = { .type = NLA_U32 },
319 [IPSET_ATTR_LINENO] = { .type = NLA_U32 },
323 hash_ip6_uadt(struct ip_set *set, struct nlattr *tb[],
324 enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
326 const struct ip_set_hash *h = set->data;
327 ipset_adtfn adtfn = set->variant->adt[adt];
328 union nf_inet_addr ip;
329 u32 timeout = h->timeout;
332 if (unlikely(!tb[IPSET_ATTR_IP] ||
333 !ip_set_optattr_netorder(tb, IPSET_ATTR_TIMEOUT) ||
334 tb[IPSET_ATTR_IP_TO] ||
335 tb[IPSET_ATTR_CIDR]))
336 return -IPSET_ERR_PROTOCOL;
338 if (tb[IPSET_ATTR_LINENO])
339 *lineno = nla_get_u32(tb[IPSET_ATTR_LINENO]);
341 ret = ip_set_get_ipaddr6(tb[IPSET_ATTR_IP], &ip);
345 ip6_netmask(&ip, h->netmask);
346 if (ipv6_addr_any(&ip.in6))
347 return -IPSET_ERR_HASH_ELEM;
349 if (tb[IPSET_ATTR_TIMEOUT]) {
350 if (!with_timeout(h->timeout))
351 return -IPSET_ERR_TIMEOUT;
352 timeout = ip_set_timeout_uget(tb[IPSET_ATTR_TIMEOUT]);
355 ret = adtfn(set, &ip, timeout, flags);
357 return ip_set_eexist(ret, flags) ? 0 : ret;
360 /* Create hash:ip type of sets */
363 hash_ip_create(struct ip_set *set, struct nlattr *tb[], u32 flags)
365 u32 hashsize = IPSET_DEFAULT_HASHSIZE, maxelem = IPSET_DEFAULT_MAXELEM;
367 struct ip_set_hash *h;
369 if (!(set->family == AF_INET || set->family == AF_INET6))
370 return -IPSET_ERR_INVALID_FAMILY;
371 netmask = set->family == AF_INET ? 32 : 128;
372 pr_debug("Create set %s with family %s\n",
373 set->name, set->family == AF_INET ? "inet" : "inet6");
375 if (unlikely(!ip_set_optattr_netorder(tb, IPSET_ATTR_HASHSIZE) ||
376 !ip_set_optattr_netorder(tb, IPSET_ATTR_MAXELEM) ||
377 !ip_set_optattr_netorder(tb, IPSET_ATTR_TIMEOUT)))
378 return -IPSET_ERR_PROTOCOL;
380 if (tb[IPSET_ATTR_HASHSIZE]) {
381 hashsize = ip_set_get_h32(tb[IPSET_ATTR_HASHSIZE]);
382 if (hashsize < IPSET_MIMINAL_HASHSIZE)
383 hashsize = IPSET_MIMINAL_HASHSIZE;
386 if (tb[IPSET_ATTR_MAXELEM])
387 maxelem = ip_set_get_h32(tb[IPSET_ATTR_MAXELEM]);
389 if (tb[IPSET_ATTR_NETMASK]) {
390 netmask = nla_get_u8(tb[IPSET_ATTR_NETMASK]);
392 if ((set->family == AF_INET && netmask > 32) ||
393 (set->family == AF_INET6 && netmask > 128) ||
395 return -IPSET_ERR_INVALID_NETMASK;
398 h = kzalloc(sizeof(*h), GFP_KERNEL);
402 h->maxelem = maxelem;
403 h->netmask = netmask;
404 get_random_bytes(&h->initval, sizeof(h->initval));
405 h->timeout = IPSET_NO_TIMEOUT;
407 hbits = htable_bits(hashsize);
408 h->table = ip_set_alloc(
409 sizeof(struct htable)
410 + jhash_size(hbits) * sizeof(struct hbucket));
415 h->table->htable_bits = hbits;
419 if (tb[IPSET_ATTR_TIMEOUT]) {
420 h->timeout = ip_set_timeout_uget(tb[IPSET_ATTR_TIMEOUT]);
422 set->variant = set->family == AF_INET
423 ? &hash_ip4_tvariant : &hash_ip6_tvariant;
425 if (set->family == AF_INET)
426 hash_ip4_gc_init(set);
428 hash_ip6_gc_init(set);
430 set->variant = set->family == AF_INET
431 ? &hash_ip4_variant : &hash_ip6_variant;
434 pr_debug("create %s hashsize %u (%u) maxelem %u: %p(%p)\n",
435 set->name, jhash_size(h->table->htable_bits),
436 h->table->htable_bits, h->maxelem, set->data, h->table);
441 static struct ip_set_type hash_ip_type __read_mostly = {
443 .protocol = IPSET_PROTOCOL,
444 .features = IPSET_TYPE_IP,
445 .dimension = IPSET_DIM_ONE,
449 .create = hash_ip_create,
451 [IPSET_ATTR_HASHSIZE] = { .type = NLA_U32 },
452 [IPSET_ATTR_MAXELEM] = { .type = NLA_U32 },
453 [IPSET_ATTR_PROBES] = { .type = NLA_U8 },
454 [IPSET_ATTR_RESIZE] = { .type = NLA_U8 },
455 [IPSET_ATTR_TIMEOUT] = { .type = NLA_U32 },
456 [IPSET_ATTR_NETMASK] = { .type = NLA_U8 },
459 [IPSET_ATTR_IP] = { .type = NLA_NESTED },
460 [IPSET_ATTR_IP_TO] = { .type = NLA_NESTED },
461 [IPSET_ATTR_CIDR] = { .type = NLA_U8 },
462 [IPSET_ATTR_TIMEOUT] = { .type = NLA_U32 },
463 [IPSET_ATTR_LINENO] = { .type = NLA_U32 },
471 return ip_set_type_register(&hash_ip_type);
477 ip_set_type_unregister(&hash_ip_type);
480 module_init(hash_ip_init);
481 module_exit(hash_ip_fini);