1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright (C) 2013 Jozsef Kadlecsik <kadlec@netfilter.org> */
4 #ifndef __IP_SET_BITMAP_IP_GEN_H
5 #define __IP_SET_BITMAP_IP_GEN_H
7 #define mtype_do_test IPSET_TOKEN(MTYPE, _do_test)
8 #define mtype_gc_test IPSET_TOKEN(MTYPE, _gc_test)
9 #define mtype_is_filled IPSET_TOKEN(MTYPE, _is_filled)
10 #define mtype_do_add IPSET_TOKEN(MTYPE, _do_add)
11 #define mtype_ext_cleanup IPSET_TOKEN(MTYPE, _ext_cleanup)
12 #define mtype_do_del IPSET_TOKEN(MTYPE, _do_del)
13 #define mtype_do_list IPSET_TOKEN(MTYPE, _do_list)
14 #define mtype_do_head IPSET_TOKEN(MTYPE, _do_head)
15 #define mtype_adt_elem IPSET_TOKEN(MTYPE, _adt_elem)
16 #define mtype_add_timeout IPSET_TOKEN(MTYPE, _add_timeout)
17 #define mtype_gc_init IPSET_TOKEN(MTYPE, _gc_init)
18 #define mtype_kadt IPSET_TOKEN(MTYPE, _kadt)
19 #define mtype_uadt IPSET_TOKEN(MTYPE, _uadt)
20 #define mtype_destroy IPSET_TOKEN(MTYPE, _destroy)
21 #define mtype_memsize IPSET_TOKEN(MTYPE, _memsize)
22 #define mtype_flush IPSET_TOKEN(MTYPE, _flush)
23 #define mtype_head IPSET_TOKEN(MTYPE, _head)
24 #define mtype_same_set IPSET_TOKEN(MTYPE, _same_set)
25 #define mtype_elem IPSET_TOKEN(MTYPE, _elem)
26 #define mtype_test IPSET_TOKEN(MTYPE, _test)
27 #define mtype_add IPSET_TOKEN(MTYPE, _add)
28 #define mtype_del IPSET_TOKEN(MTYPE, _del)
29 #define mtype_list IPSET_TOKEN(MTYPE, _list)
30 #define mtype_gc IPSET_TOKEN(MTYPE, _gc)
33 #define get_ext(set, map, id) ((map)->extensions + ((set)->dsize * (id)))
36 mtype_gc_init(struct ip_set *set, void (*gc)(struct timer_list *t))
38 struct mtype *map = set->data;
40 timer_setup(&map->gc, gc, 0);
41 mod_timer(&map->gc, jiffies + IPSET_GC_PERIOD(set->timeout) * HZ);
45 mtype_ext_cleanup(struct ip_set *set)
47 struct mtype *map = set->data;
50 for (id = 0; id < map->elements; id++)
51 if (test_bit(id, map->members))
52 ip_set_ext_destroy(set, get_ext(set, map, id));
56 mtype_destroy(struct ip_set *set)
58 struct mtype *map = set->data;
60 if (SET_WITH_TIMEOUT(set))
61 del_timer_sync(&map->gc);
63 if (set->dsize && set->extensions & IPSET_EXT_DESTROY)
64 mtype_ext_cleanup(set);
65 ip_set_free(map->members);
72 mtype_flush(struct ip_set *set)
74 struct mtype *map = set->data;
76 if (set->extensions & IPSET_EXT_DESTROY)
77 mtype_ext_cleanup(set);
78 bitmap_zero(map->members, map->elements);
83 /* Calculate the actual memory size of the set data */
85 mtype_memsize(const struct mtype *map, size_t dsize)
87 return sizeof(*map) + map->memsize +
88 map->elements * dsize;
92 mtype_head(struct ip_set *set, struct sk_buff *skb)
94 const struct mtype *map = set->data;
95 struct nlattr *nested;
96 size_t memsize = mtype_memsize(map, set->dsize) + set->ext_size;
98 nested = nla_nest_start(skb, IPSET_ATTR_DATA);
100 goto nla_put_failure;
101 if (mtype_do_head(skb, map) ||
102 nla_put_net32(skb, IPSET_ATTR_REFERENCES, htonl(set->ref)) ||
103 nla_put_net32(skb, IPSET_ATTR_MEMSIZE, htonl(memsize)) ||
104 nla_put_net32(skb, IPSET_ATTR_ELEMENTS, htonl(set->elements)))
105 goto nla_put_failure;
106 if (unlikely(ip_set_put_flags(skb, set)))
107 goto nla_put_failure;
108 nla_nest_end(skb, nested);
116 mtype_test(struct ip_set *set, void *value, const struct ip_set_ext *ext,
117 struct ip_set_ext *mext, u32 flags)
119 struct mtype *map = set->data;
120 const struct mtype_adt_elem *e = value;
121 void *x = get_ext(set, map, e->id);
122 int ret = mtype_do_test(e, map, set->dsize);
126 return ip_set_match_extensions(set, ext, mext, flags, x);
130 mtype_add(struct ip_set *set, void *value, const struct ip_set_ext *ext,
131 struct ip_set_ext *mext, u32 flags)
133 struct mtype *map = set->data;
134 const struct mtype_adt_elem *e = value;
135 void *x = get_ext(set, map, e->id);
136 int ret = mtype_do_add(e, map, flags, set->dsize);
138 if (ret == IPSET_ADD_FAILED) {
139 if (SET_WITH_TIMEOUT(set) &&
140 ip_set_timeout_expired(ext_timeout(x, set))) {
143 } else if (!(flags & IPSET_FLAG_EXIST)) {
144 set_bit(e->id, map->members);
145 return -IPSET_ERR_EXIST;
147 /* Element is re-added, cleanup extensions */
148 ip_set_ext_destroy(set, x);
153 if (SET_WITH_TIMEOUT(set))
154 #ifdef IP_SET_BITMAP_STORED_TIMEOUT
155 mtype_add_timeout(ext_timeout(x, set), e, ext, set, map, ret);
157 ip_set_timeout_set(ext_timeout(x, set), ext->timeout);
160 if (SET_WITH_COUNTER(set))
161 ip_set_init_counter(ext_counter(x, set), ext);
162 if (SET_WITH_COMMENT(set))
163 ip_set_init_comment(set, ext_comment(x, set), ext);
164 if (SET_WITH_SKBINFO(set))
165 ip_set_init_skbinfo(ext_skbinfo(x, set), ext);
167 /* Activate element */
168 set_bit(e->id, map->members);
175 mtype_del(struct ip_set *set, void *value, const struct ip_set_ext *ext,
176 struct ip_set_ext *mext, u32 flags)
178 struct mtype *map = set->data;
179 const struct mtype_adt_elem *e = value;
180 void *x = get_ext(set, map, e->id);
182 if (mtype_do_del(e, map))
183 return -IPSET_ERR_EXIST;
185 ip_set_ext_destroy(set, x);
187 if (SET_WITH_TIMEOUT(set) &&
188 ip_set_timeout_expired(ext_timeout(x, set)))
189 return -IPSET_ERR_EXIST;
194 #ifndef IP_SET_BITMAP_STORED_TIMEOUT
196 mtype_is_filled(const struct mtype_elem *x)
203 mtype_list(const struct ip_set *set,
204 struct sk_buff *skb, struct netlink_callback *cb)
206 struct mtype *map = set->data;
207 struct nlattr *adt, *nested;
209 u32 id, first = cb->args[IPSET_CB_ARG0];
212 adt = nla_nest_start(skb, IPSET_ATTR_ADT);
215 /* Extensions may be replaced */
217 for (; cb->args[IPSET_CB_ARG0] < map->elements;
218 cb->args[IPSET_CB_ARG0]++) {
220 id = cb->args[IPSET_CB_ARG0];
221 x = get_ext(set, map, id);
222 if (!test_bit(id, map->members) ||
223 (SET_WITH_TIMEOUT(set) &&
224 #ifdef IP_SET_BITMAP_STORED_TIMEOUT
225 mtype_is_filled(x) &&
227 ip_set_timeout_expired(ext_timeout(x, set))))
229 nested = nla_nest_start(skb, IPSET_ATTR_DATA);
232 nla_nest_cancel(skb, adt);
237 goto nla_put_failure;
239 if (mtype_do_list(skb, map, id, set->dsize))
240 goto nla_put_failure;
241 if (ip_set_put_extensions(skb, set, x, mtype_is_filled(x)))
242 goto nla_put_failure;
243 nla_nest_end(skb, nested);
245 nla_nest_end(skb, adt);
247 /* Set listing finished */
248 cb->args[IPSET_CB_ARG0] = 0;
253 nla_nest_cancel(skb, nested);
254 if (unlikely(id == first)) {
255 cb->args[IPSET_CB_ARG0] = 0;
258 nla_nest_end(skb, adt);
265 mtype_gc(struct timer_list *t)
267 struct mtype *map = from_timer(map, t, gc);
268 struct ip_set *set = map->set;
272 /* We run parallel with other readers (test element)
273 * but adding/deleting new entries is locked out
275 spin_lock_bh(&set->lock);
276 for (id = 0; id < map->elements; id++)
277 if (mtype_gc_test(id, map, set->dsize)) {
278 x = get_ext(set, map, id);
279 if (ip_set_timeout_expired(ext_timeout(x, set))) {
280 clear_bit(id, map->members);
281 ip_set_ext_destroy(set, x);
285 spin_unlock_bh(&set->lock);
287 map->gc.expires = jiffies + IPSET_GC_PERIOD(set->timeout) * HZ;
291 static const struct ip_set_type_variant mtype = {
295 [IPSET_ADD] = mtype_add,
296 [IPSET_DEL] = mtype_del,
297 [IPSET_TEST] = mtype_test,
299 .destroy = mtype_destroy,
300 .flush = mtype_flush,
303 .same_set = mtype_same_set,
306 #endif /* __IP_SET_BITMAP_IP_GEN_H */