1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2008-2014 Patrick McHardy <kaber@trash.net>
5 * Development of this code funded by Astaro AG (http://www.astaro.com/)
8 #include <linux/kernel.h>
9 #include <linux/init.h>
10 #include <linux/module.h>
11 #include <linux/list.h>
12 #include <linux/log2.h>
13 #include <linux/jhash.h>
14 #include <linux/netlink.h>
15 #include <linux/workqueue.h>
16 #include <linux/rhashtable.h>
17 #include <linux/netfilter.h>
18 #include <linux/netfilter/nf_tables.h>
19 #include <net/netfilter/nf_tables_core.h>
21 /* We target a hash table size of 4, element hint is 75% of final size */
22 #define NFT_RHASH_ELEMENT_HINT 3
26 struct delayed_work gc_work;
29 struct nft_rhash_elem {
30 struct rhash_head node;
31 struct nft_set_ext ext;
34 struct nft_rhash_cmp_arg {
35 const struct nft_set *set;
40 static inline u32 nft_rhash_key(const void *data, u32 len, u32 seed)
42 const struct nft_rhash_cmp_arg *arg = data;
44 return jhash(arg->key, len, seed);
47 static inline u32 nft_rhash_obj(const void *data, u32 len, u32 seed)
49 const struct nft_rhash_elem *he = data;
51 return jhash(nft_set_ext_key(&he->ext), len, seed);
54 static inline int nft_rhash_cmp(struct rhashtable_compare_arg *arg,
57 const struct nft_rhash_cmp_arg *x = arg->key;
58 const struct nft_rhash_elem *he = ptr;
60 if (memcmp(nft_set_ext_key(&he->ext), x->key, x->set->klen))
62 if (nft_set_elem_expired(&he->ext))
64 if (!nft_set_elem_active(&he->ext, x->genmask))
69 static const struct rhashtable_params nft_rhash_params = {
70 .head_offset = offsetof(struct nft_rhash_elem, node),
71 .hashfn = nft_rhash_key,
72 .obj_hashfn = nft_rhash_obj,
73 .obj_cmpfn = nft_rhash_cmp,
74 .automatic_shrinking = true,
77 static bool nft_rhash_lookup(const struct net *net, const struct nft_set *set,
78 const u32 *key, const struct nft_set_ext **ext)
80 struct nft_rhash *priv = nft_set_priv(set);
81 const struct nft_rhash_elem *he;
82 struct nft_rhash_cmp_arg arg = {
83 .genmask = nft_genmask_cur(net),
88 he = rhashtable_lookup(&priv->ht, &arg, nft_rhash_params);
95 static void *nft_rhash_get(const struct net *net, const struct nft_set *set,
96 const struct nft_set_elem *elem, unsigned int flags)
98 struct nft_rhash *priv = nft_set_priv(set);
99 struct nft_rhash_elem *he;
100 struct nft_rhash_cmp_arg arg = {
101 .genmask = nft_genmask_cur(net),
103 .key = elem->key.val.data,
106 he = rhashtable_lookup(&priv->ht, &arg, nft_rhash_params);
110 return ERR_PTR(-ENOENT);
113 static bool nft_rhash_update(struct nft_set *set, const u32 *key,
114 void *(*new)(struct nft_set *,
115 const struct nft_expr *,
116 struct nft_regs *regs),
117 const struct nft_expr *expr,
118 struct nft_regs *regs,
119 const struct nft_set_ext **ext)
121 struct nft_rhash *priv = nft_set_priv(set);
122 struct nft_rhash_elem *he, *prev;
123 struct nft_rhash_cmp_arg arg = {
124 .genmask = NFT_GENMASK_ANY,
129 he = rhashtable_lookup(&priv->ht, &arg, nft_rhash_params);
133 he = new(set, expr, regs);
137 prev = rhashtable_lookup_get_insert_key(&priv->ht, &arg, &he->node,
142 /* Another cpu may race to insert the element with the same key */
144 nft_set_elem_destroy(set, he, true);
153 nft_set_elem_destroy(set, he, true);
158 static int nft_rhash_insert(const struct net *net, const struct nft_set *set,
159 const struct nft_set_elem *elem,
160 struct nft_set_ext **ext)
162 struct nft_rhash *priv = nft_set_priv(set);
163 struct nft_rhash_elem *he = elem->priv;
164 struct nft_rhash_cmp_arg arg = {
165 .genmask = nft_genmask_next(net),
167 .key = elem->key.val.data,
169 struct nft_rhash_elem *prev;
171 prev = rhashtable_lookup_get_insert_key(&priv->ht, &arg, &he->node,
174 return PTR_ERR(prev);
182 static void nft_rhash_activate(const struct net *net, const struct nft_set *set,
183 const struct nft_set_elem *elem)
185 struct nft_rhash_elem *he = elem->priv;
187 nft_set_elem_change_active(net, set, &he->ext);
188 nft_set_elem_clear_busy(&he->ext);
191 static bool nft_rhash_flush(const struct net *net,
192 const struct nft_set *set, void *priv)
194 struct nft_rhash_elem *he = priv;
196 if (!nft_set_elem_mark_busy(&he->ext) ||
197 !nft_is_active(net, &he->ext)) {
198 nft_set_elem_change_active(net, set, &he->ext);
204 static void *nft_rhash_deactivate(const struct net *net,
205 const struct nft_set *set,
206 const struct nft_set_elem *elem)
208 struct nft_rhash *priv = nft_set_priv(set);
209 struct nft_rhash_elem *he;
210 struct nft_rhash_cmp_arg arg = {
211 .genmask = nft_genmask_next(net),
213 .key = elem->key.val.data,
217 he = rhashtable_lookup(&priv->ht, &arg, nft_rhash_params);
219 !nft_rhash_flush(net, set, he))
227 static void nft_rhash_remove(const struct net *net,
228 const struct nft_set *set,
229 const struct nft_set_elem *elem)
231 struct nft_rhash *priv = nft_set_priv(set);
232 struct nft_rhash_elem *he = elem->priv;
234 rhashtable_remove_fast(&priv->ht, &he->node, nft_rhash_params);
237 static bool nft_rhash_delete(const struct nft_set *set,
240 struct nft_rhash *priv = nft_set_priv(set);
241 struct nft_rhash_cmp_arg arg = {
242 .genmask = NFT_GENMASK_ANY,
246 struct nft_rhash_elem *he;
248 he = rhashtable_lookup(&priv->ht, &arg, nft_rhash_params);
252 return rhashtable_remove_fast(&priv->ht, &he->node, nft_rhash_params) == 0;
255 static void nft_rhash_walk(const struct nft_ctx *ctx, struct nft_set *set,
256 struct nft_set_iter *iter)
258 struct nft_rhash *priv = nft_set_priv(set);
259 struct nft_rhash_elem *he;
260 struct rhashtable_iter hti;
261 struct nft_set_elem elem;
263 rhashtable_walk_enter(&priv->ht, &hti);
264 rhashtable_walk_start(&hti);
266 while ((he = rhashtable_walk_next(&hti))) {
268 if (PTR_ERR(he) != -EAGAIN) {
269 iter->err = PTR_ERR(he);
276 if (iter->count < iter->skip)
278 if (nft_set_elem_expired(&he->ext))
280 if (!nft_set_elem_active(&he->ext, iter->genmask))
285 iter->err = iter->fn(ctx, set, iter, &elem);
292 rhashtable_walk_stop(&hti);
293 rhashtable_walk_exit(&hti);
296 static void nft_rhash_gc(struct work_struct *work)
299 struct nft_rhash_elem *he;
300 struct nft_rhash *priv;
301 struct nft_set_gc_batch *gcb = NULL;
302 struct rhashtable_iter hti;
304 priv = container_of(work, struct nft_rhash, gc_work.work);
305 set = nft_set_container_of(priv);
307 rhashtable_walk_enter(&priv->ht, &hti);
308 rhashtable_walk_start(&hti);
310 while ((he = rhashtable_walk_next(&hti))) {
312 if (PTR_ERR(he) != -EAGAIN)
317 if (nft_set_ext_exists(&he->ext, NFT_SET_EXT_EXPR)) {
318 struct nft_expr *expr = nft_set_ext_expr(&he->ext);
321 expr->ops->gc(read_pnet(&set->net), expr))
324 if (!nft_set_elem_expired(&he->ext))
327 if (nft_set_elem_mark_busy(&he->ext))
330 gcb = nft_set_gc_batch_check(set, gcb, GFP_ATOMIC);
333 rhashtable_remove_fast(&priv->ht, &he->node, nft_rhash_params);
334 atomic_dec(&set->nelems);
335 nft_set_gc_batch_add(gcb, he);
337 rhashtable_walk_stop(&hti);
338 rhashtable_walk_exit(&hti);
340 nft_set_gc_batch_complete(gcb);
341 queue_delayed_work(system_power_efficient_wq, &priv->gc_work,
342 nft_set_gc_interval(set));
345 static u64 nft_rhash_privsize(const struct nlattr * const nla[],
346 const struct nft_set_desc *desc)
348 return sizeof(struct nft_rhash);
351 static void nft_rhash_gc_init(const struct nft_set *set)
353 struct nft_rhash *priv = nft_set_priv(set);
355 queue_delayed_work(system_power_efficient_wq, &priv->gc_work,
356 nft_set_gc_interval(set));
359 static int nft_rhash_init(const struct nft_set *set,
360 const struct nft_set_desc *desc,
361 const struct nlattr * const tb[])
363 struct nft_rhash *priv = nft_set_priv(set);
364 struct rhashtable_params params = nft_rhash_params;
367 params.nelem_hint = desc->size ?: NFT_RHASH_ELEMENT_HINT;
368 params.key_len = set->klen;
370 err = rhashtable_init(&priv->ht, ¶ms);
374 INIT_DEFERRABLE_WORK(&priv->gc_work, nft_rhash_gc);
375 if (set->flags & NFT_SET_TIMEOUT)
376 nft_rhash_gc_init(set);
381 static void nft_rhash_elem_destroy(void *ptr, void *arg)
383 nft_set_elem_destroy(arg, ptr, true);
386 static void nft_rhash_destroy(const struct nft_set *set)
388 struct nft_rhash *priv = nft_set_priv(set);
390 cancel_delayed_work_sync(&priv->gc_work);
392 rhashtable_free_and_destroy(&priv->ht, nft_rhash_elem_destroy,
396 static u32 nft_hash_buckets(u32 size)
398 return roundup_pow_of_two(size * 4 / 3);
401 static bool nft_rhash_estimate(const struct nft_set_desc *desc, u32 features,
402 struct nft_set_estimate *est)
405 est->lookup = NFT_SET_CLASS_O_1;
406 est->space = NFT_SET_CLASS_O_N;
414 struct hlist_head table[];
417 struct nft_hash_elem {
418 struct hlist_node node;
419 struct nft_set_ext ext;
422 static bool nft_hash_lookup(const struct net *net, const struct nft_set *set,
423 const u32 *key, const struct nft_set_ext **ext)
425 struct nft_hash *priv = nft_set_priv(set);
426 u8 genmask = nft_genmask_cur(net);
427 const struct nft_hash_elem *he;
430 hash = jhash(key, set->klen, priv->seed);
431 hash = reciprocal_scale(hash, priv->buckets);
432 hlist_for_each_entry_rcu(he, &priv->table[hash], node) {
433 if (!memcmp(nft_set_ext_key(&he->ext), key, set->klen) &&
434 nft_set_elem_active(&he->ext, genmask)) {
442 static void *nft_hash_get(const struct net *net, const struct nft_set *set,
443 const struct nft_set_elem *elem, unsigned int flags)
445 struct nft_hash *priv = nft_set_priv(set);
446 u8 genmask = nft_genmask_cur(net);
447 struct nft_hash_elem *he;
450 hash = jhash(elem->key.val.data, set->klen, priv->seed);
451 hash = reciprocal_scale(hash, priv->buckets);
452 hlist_for_each_entry_rcu(he, &priv->table[hash], node) {
453 if (!memcmp(nft_set_ext_key(&he->ext), elem->key.val.data, set->klen) &&
454 nft_set_elem_active(&he->ext, genmask))
457 return ERR_PTR(-ENOENT);
460 static bool nft_hash_lookup_fast(const struct net *net,
461 const struct nft_set *set,
462 const u32 *key, const struct nft_set_ext **ext)
464 struct nft_hash *priv = nft_set_priv(set);
465 u8 genmask = nft_genmask_cur(net);
466 const struct nft_hash_elem *he;
470 hash = jhash_1word(k1, priv->seed);
471 hash = reciprocal_scale(hash, priv->buckets);
472 hlist_for_each_entry_rcu(he, &priv->table[hash], node) {
473 k2 = *(u32 *)nft_set_ext_key(&he->ext)->data;
475 nft_set_elem_active(&he->ext, genmask)) {
483 static u32 nft_jhash(const struct nft_set *set, const struct nft_hash *priv,
484 const struct nft_set_ext *ext)
486 const struct nft_data *key = nft_set_ext_key(ext);
489 if (set->klen == 4) {
491 hash = jhash_1word(k1, priv->seed);
493 hash = jhash(key, set->klen, priv->seed);
495 hash = reciprocal_scale(hash, priv->buckets);
500 static int nft_hash_insert(const struct net *net, const struct nft_set *set,
501 const struct nft_set_elem *elem,
502 struct nft_set_ext **ext)
504 struct nft_hash_elem *this = elem->priv, *he;
505 struct nft_hash *priv = nft_set_priv(set);
506 u8 genmask = nft_genmask_next(net);
509 hash = nft_jhash(set, priv, &this->ext);
510 hlist_for_each_entry(he, &priv->table[hash], node) {
511 if (!memcmp(nft_set_ext_key(&this->ext),
512 nft_set_ext_key(&he->ext), set->klen) &&
513 nft_set_elem_active(&he->ext, genmask)) {
518 hlist_add_head_rcu(&this->node, &priv->table[hash]);
522 static void nft_hash_activate(const struct net *net, const struct nft_set *set,
523 const struct nft_set_elem *elem)
525 struct nft_hash_elem *he = elem->priv;
527 nft_set_elem_change_active(net, set, &he->ext);
530 static bool nft_hash_flush(const struct net *net,
531 const struct nft_set *set, void *priv)
533 struct nft_hash_elem *he = priv;
535 nft_set_elem_change_active(net, set, &he->ext);
539 static void *nft_hash_deactivate(const struct net *net,
540 const struct nft_set *set,
541 const struct nft_set_elem *elem)
543 struct nft_hash *priv = nft_set_priv(set);
544 struct nft_hash_elem *this = elem->priv, *he;
545 u8 genmask = nft_genmask_next(net);
548 hash = nft_jhash(set, priv, &this->ext);
549 hlist_for_each_entry(he, &priv->table[hash], node) {
550 if (!memcmp(nft_set_ext_key(&he->ext), &elem->key.val,
552 nft_set_elem_active(&he->ext, genmask)) {
553 nft_set_elem_change_active(net, set, &he->ext);
560 static void nft_hash_remove(const struct net *net,
561 const struct nft_set *set,
562 const struct nft_set_elem *elem)
564 struct nft_hash_elem *he = elem->priv;
566 hlist_del_rcu(&he->node);
569 static void nft_hash_walk(const struct nft_ctx *ctx, struct nft_set *set,
570 struct nft_set_iter *iter)
572 struct nft_hash *priv = nft_set_priv(set);
573 struct nft_hash_elem *he;
574 struct nft_set_elem elem;
577 for (i = 0; i < priv->buckets; i++) {
578 hlist_for_each_entry_rcu(he, &priv->table[i], node) {
579 if (iter->count < iter->skip)
581 if (!nft_set_elem_active(&he->ext, iter->genmask))
586 iter->err = iter->fn(ctx, set, iter, &elem);
595 static u64 nft_hash_privsize(const struct nlattr * const nla[],
596 const struct nft_set_desc *desc)
598 return sizeof(struct nft_hash) +
599 nft_hash_buckets(desc->size) * sizeof(struct hlist_head);
602 static int nft_hash_init(const struct nft_set *set,
603 const struct nft_set_desc *desc,
604 const struct nlattr * const tb[])
606 struct nft_hash *priv = nft_set_priv(set);
608 priv->buckets = nft_hash_buckets(desc->size);
609 get_random_bytes(&priv->seed, sizeof(priv->seed));
614 static void nft_hash_destroy(const struct nft_set *set)
616 struct nft_hash *priv = nft_set_priv(set);
617 struct nft_hash_elem *he;
618 struct hlist_node *next;
621 for (i = 0; i < priv->buckets; i++) {
622 hlist_for_each_entry_safe(he, next, &priv->table[i], node) {
623 hlist_del_rcu(&he->node);
624 nft_set_elem_destroy(set, he, true);
629 static bool nft_hash_estimate(const struct nft_set_desc *desc, u32 features,
630 struct nft_set_estimate *est)
638 est->size = sizeof(struct nft_hash) +
639 nft_hash_buckets(desc->size) * sizeof(struct hlist_head) +
640 desc->size * sizeof(struct nft_hash_elem);
641 est->lookup = NFT_SET_CLASS_O_1;
642 est->space = NFT_SET_CLASS_O_N;
647 static bool nft_hash_fast_estimate(const struct nft_set_desc *desc, u32 features,
648 struct nft_set_estimate *est)
656 est->size = sizeof(struct nft_hash) +
657 nft_hash_buckets(desc->size) * sizeof(struct hlist_head) +
658 desc->size * sizeof(struct nft_hash_elem);
659 est->lookup = NFT_SET_CLASS_O_1;
660 est->space = NFT_SET_CLASS_O_N;
665 const struct nft_set_type nft_set_rhash_type = {
666 .features = NFT_SET_MAP | NFT_SET_OBJECT |
667 NFT_SET_TIMEOUT | NFT_SET_EVAL,
669 .privsize = nft_rhash_privsize,
670 .elemsize = offsetof(struct nft_rhash_elem, ext),
671 .estimate = nft_rhash_estimate,
672 .init = nft_rhash_init,
673 .gc_init = nft_rhash_gc_init,
674 .destroy = nft_rhash_destroy,
675 .insert = nft_rhash_insert,
676 .activate = nft_rhash_activate,
677 .deactivate = nft_rhash_deactivate,
678 .flush = nft_rhash_flush,
679 .remove = nft_rhash_remove,
680 .lookup = nft_rhash_lookup,
681 .update = nft_rhash_update,
682 .delete = nft_rhash_delete,
683 .walk = nft_rhash_walk,
684 .get = nft_rhash_get,
688 const struct nft_set_type nft_set_hash_type = {
689 .features = NFT_SET_MAP | NFT_SET_OBJECT,
691 .privsize = nft_hash_privsize,
692 .elemsize = offsetof(struct nft_hash_elem, ext),
693 .estimate = nft_hash_estimate,
694 .init = nft_hash_init,
695 .destroy = nft_hash_destroy,
696 .insert = nft_hash_insert,
697 .activate = nft_hash_activate,
698 .deactivate = nft_hash_deactivate,
699 .flush = nft_hash_flush,
700 .remove = nft_hash_remove,
701 .lookup = nft_hash_lookup,
702 .walk = nft_hash_walk,
707 const struct nft_set_type nft_set_hash_fast_type = {
708 .features = NFT_SET_MAP | NFT_SET_OBJECT,
710 .privsize = nft_hash_privsize,
711 .elemsize = offsetof(struct nft_hash_elem, ext),
712 .estimate = nft_hash_fast_estimate,
713 .init = nft_hash_init,
714 .destroy = nft_hash_destroy,
715 .insert = nft_hash_insert,
716 .activate = nft_hash_activate,
717 .deactivate = nft_hash_deactivate,
718 .flush = nft_hash_flush,
719 .remove = nft_hash_remove,
720 .lookup = nft_hash_lookup_fast,
721 .walk = nft_hash_walk,