1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net/sched/cls_route.c ROUTE4 classifier.
5 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
8 #include <linux/module.h>
9 #include <linux/slab.h>
10 #include <linux/types.h>
11 #include <linux/kernel.h>
12 #include <linux/string.h>
13 #include <linux/errno.h>
14 #include <linux/skbuff.h>
16 #include <net/route.h>
17 #include <net/netlink.h>
18 #include <net/act_api.h>
19 #include <net/pkt_cls.h>
20 #include <net/tc_wrapper.h>
23 * 1. For now we assume that route tags < 256.
24 * It allows to use direct table lookups, instead of hash tables.
25 * 2. For now we assume that "from TAG" and "fromdev DEV" statements
26 * are mutually exclusive.
27 * 3. "to TAG from ANY" has higher priority, than "to ANY from XXX"
29 struct route4_fastmap {
30 struct route4_filter *filter;
36 struct route4_fastmap fastmap[16];
37 struct route4_bucket __rcu *table[256 + 1];
41 struct route4_bucket {
42 /* 16 FROM buckets + 16 IIF buckets + 1 wildcard bucket */
43 struct route4_filter __rcu *ht[16 + 16 + 1];
47 struct route4_filter {
48 struct route4_filter __rcu *next;
52 struct tcf_result res;
55 struct route4_bucket *bkt;
57 struct rcu_work rwork;
60 #define ROUTE4_FAILURE ((struct route4_filter *)(-1L))
62 static inline int route4_fastmap_hash(u32 id, int iif)
67 static DEFINE_SPINLOCK(fastmap_lock);
69 route4_reset_fastmap(struct route4_head *head)
71 spin_lock_bh(&fastmap_lock);
72 memset(head->fastmap, 0, sizeof(head->fastmap));
73 spin_unlock_bh(&fastmap_lock);
77 route4_set_fastmap(struct route4_head *head, u32 id, int iif,
78 struct route4_filter *f)
80 int h = route4_fastmap_hash(id, iif);
82 /* fastmap updates must look atomic to aling id, iff, filter */
83 spin_lock_bh(&fastmap_lock);
84 head->fastmap[h].id = id;
85 head->fastmap[h].iif = iif;
86 head->fastmap[h].filter = f;
87 spin_unlock_bh(&fastmap_lock);
90 static inline int route4_hash_to(u32 id)
95 static inline int route4_hash_from(u32 id)
97 return (id >> 16) & 0xF;
100 static inline int route4_hash_iif(int iif)
102 return 16 + ((iif >> 16) & 0xF);
105 static inline int route4_hash_wild(void)
110 #define ROUTE4_APPLY_RESULT() \
113 if (tcf_exts_has_actions(&f->exts)) { \
114 int r = tcf_exts_exec(skb, &f->exts, res); \
120 } else if (!dont_cache) \
121 route4_set_fastmap(head, id, iif, f); \
125 TC_INDIRECT_SCOPE int route4_classify(struct sk_buff *skb,
126 const struct tcf_proto *tp,
127 struct tcf_result *res)
129 struct route4_head *head = rcu_dereference_bh(tp->root);
130 struct dst_entry *dst;
131 struct route4_bucket *b;
132 struct route4_filter *f;
134 int iif, dont_cache = 0;
144 h = route4_fastmap_hash(id, iif);
146 spin_lock(&fastmap_lock);
147 if (id == head->fastmap[h].id &&
148 iif == head->fastmap[h].iif &&
149 (f = head->fastmap[h].filter) != NULL) {
150 if (f == ROUTE4_FAILURE) {
151 spin_unlock(&fastmap_lock);
156 spin_unlock(&fastmap_lock);
159 spin_unlock(&fastmap_lock);
161 h = route4_hash_to(id);
164 b = rcu_dereference_bh(head->table[h]);
166 for (f = rcu_dereference_bh(b->ht[route4_hash_from(id)]);
168 f = rcu_dereference_bh(f->next))
170 ROUTE4_APPLY_RESULT();
172 for (f = rcu_dereference_bh(b->ht[route4_hash_iif(iif)]);
174 f = rcu_dereference_bh(f->next))
176 ROUTE4_APPLY_RESULT();
178 for (f = rcu_dereference_bh(b->ht[route4_hash_wild()]);
180 f = rcu_dereference_bh(f->next))
181 ROUTE4_APPLY_RESULT();
190 route4_set_fastmap(head, id, iif, ROUTE4_FAILURE);
195 static inline u32 to_hash(u32 id)
204 static inline u32 from_hash(u32 id)
209 if (!(id & 0x8000)) {
214 return 16 + (id & 0xF);
217 static void *route4_get(struct tcf_proto *tp, u32 handle)
219 struct route4_head *head = rtnl_dereference(tp->root);
220 struct route4_bucket *b;
221 struct route4_filter *f;
224 h1 = to_hash(handle);
228 h2 = from_hash(handle >> 16);
232 b = rtnl_dereference(head->table[h1]);
234 for (f = rtnl_dereference(b->ht[h2]);
236 f = rtnl_dereference(f->next))
237 if (f->handle == handle)
243 static int route4_init(struct tcf_proto *tp)
245 struct route4_head *head;
247 head = kzalloc(sizeof(struct route4_head), GFP_KERNEL);
251 rcu_assign_pointer(tp->root, head);
255 static void __route4_delete_filter(struct route4_filter *f)
257 tcf_exts_destroy(&f->exts);
258 tcf_exts_put_net(&f->exts);
262 static void route4_delete_filter_work(struct work_struct *work)
264 struct route4_filter *f = container_of(to_rcu_work(work),
265 struct route4_filter,
268 __route4_delete_filter(f);
272 static void route4_queue_work(struct route4_filter *f)
274 tcf_queue_work(&f->rwork, route4_delete_filter_work);
277 static void route4_destroy(struct tcf_proto *tp, bool rtnl_held,
278 struct netlink_ext_ack *extack)
280 struct route4_head *head = rtnl_dereference(tp->root);
286 for (h1 = 0; h1 <= 256; h1++) {
287 struct route4_bucket *b;
289 b = rtnl_dereference(head->table[h1]);
291 for (h2 = 0; h2 <= 32; h2++) {
292 struct route4_filter *f;
294 while ((f = rtnl_dereference(b->ht[h2])) != NULL) {
295 struct route4_filter *next;
297 next = rtnl_dereference(f->next);
298 RCU_INIT_POINTER(b->ht[h2], next);
299 tcf_unbind_filter(tp, &f->res);
300 if (tcf_exts_get_net(&f->exts))
301 route4_queue_work(f);
303 __route4_delete_filter(f);
306 RCU_INIT_POINTER(head->table[h1], NULL);
310 kfree_rcu(head, rcu);
313 static int route4_delete(struct tcf_proto *tp, void *arg, bool *last,
314 bool rtnl_held, struct netlink_ext_ack *extack)
316 struct route4_head *head = rtnl_dereference(tp->root);
317 struct route4_filter *f = arg;
318 struct route4_filter __rcu **fp;
319 struct route4_filter *nf;
320 struct route4_bucket *b;
330 fp = &b->ht[from_hash(h >> 16)];
331 for (nf = rtnl_dereference(*fp); nf;
332 fp = &nf->next, nf = rtnl_dereference(*fp)) {
335 RCU_INIT_POINTER(*fp, rtnl_dereference(f->next));
337 /* Remove any fastmap lookups that might ref filter
338 * notice we unlink'd the filter so we can't get it
339 * back in the fastmap.
341 route4_reset_fastmap(head);
344 tcf_unbind_filter(tp, &f->res);
345 tcf_exts_get_net(&f->exts);
346 tcf_queue_work(&f->rwork, route4_delete_filter_work);
348 /* Strip RTNL protected tree */
349 for (i = 0; i <= 32; i++) {
350 struct route4_filter *rt;
352 rt = rtnl_dereference(b->ht[i]);
357 /* OK, session has no flows */
358 RCU_INIT_POINTER(head->table[to_hash(h)], NULL);
366 for (h1 = 0; h1 <= 256; h1++) {
367 if (rcu_access_pointer(head->table[h1])) {
376 static const struct nla_policy route4_policy[TCA_ROUTE4_MAX + 1] = {
377 [TCA_ROUTE4_CLASSID] = { .type = NLA_U32 },
378 [TCA_ROUTE4_TO] = { .type = NLA_U32 },
379 [TCA_ROUTE4_FROM] = { .type = NLA_U32 },
380 [TCA_ROUTE4_IIF] = { .type = NLA_U32 },
383 static int route4_set_parms(struct net *net, struct tcf_proto *tp,
384 unsigned long base, struct route4_filter *f,
385 u32 handle, struct route4_head *head,
386 struct nlattr **tb, struct nlattr *est, int new,
387 u32 flags, struct netlink_ext_ack *extack)
389 u32 id = 0, to = 0, nhandle = 0x8000;
390 struct route4_filter *fp;
392 struct route4_bucket *b;
395 err = tcf_exts_validate(net, tp, tb, est, &f->exts, flags, extack);
399 if (tb[TCA_ROUTE4_TO]) {
400 if (new && handle & 0x8000)
402 to = nla_get_u32(tb[TCA_ROUTE4_TO]);
408 if (tb[TCA_ROUTE4_FROM]) {
409 if (tb[TCA_ROUTE4_IIF])
411 id = nla_get_u32(tb[TCA_ROUTE4_FROM]);
415 } else if (tb[TCA_ROUTE4_IIF]) {
416 id = nla_get_u32(tb[TCA_ROUTE4_IIF]);
419 nhandle |= (id | 0x8000) << 16;
421 nhandle |= 0xFFFF << 16;
424 nhandle |= handle & 0x7F00;
425 if (nhandle != handle)
430 NL_SET_ERR_MSG(extack, "Replacing with handle of 0 is invalid");
434 h1 = to_hash(nhandle);
435 b = rtnl_dereference(head->table[h1]);
437 b = kzalloc(sizeof(struct route4_bucket), GFP_KERNEL);
441 rcu_assign_pointer(head->table[h1], b);
443 unsigned int h2 = from_hash(nhandle >> 16);
445 for (fp = rtnl_dereference(b->ht[h2]);
447 fp = rtnl_dereference(fp->next))
448 if (fp->handle == f->handle)
452 if (tb[TCA_ROUTE4_TO])
455 if (tb[TCA_ROUTE4_FROM])
457 else if (tb[TCA_ROUTE4_IIF])
464 if (tb[TCA_ROUTE4_CLASSID]) {
465 f->res.classid = nla_get_u32(tb[TCA_ROUTE4_CLASSID]);
466 tcf_bind_filter(tp, &f->res, base);
472 static int route4_change(struct net *net, struct sk_buff *in_skb,
473 struct tcf_proto *tp, unsigned long base, u32 handle,
474 struct nlattr **tca, void **arg, u32 flags,
475 struct netlink_ext_ack *extack)
477 struct route4_head *head = rtnl_dereference(tp->root);
478 struct route4_filter __rcu **fp;
479 struct route4_filter *fold, *f1, *pfp, *f = NULL;
480 struct route4_bucket *b;
481 struct nlattr *opt = tca[TCA_OPTIONS];
482 struct nlattr *tb[TCA_ROUTE4_MAX + 1];
488 NL_SET_ERR_MSG(extack, "Creating with handle of 0 is invalid");
495 err = nla_parse_nested_deprecated(tb, TCA_ROUTE4_MAX, opt,
496 route4_policy, NULL);
501 if (fold && fold->handle != handle)
505 f = kzalloc(sizeof(struct route4_filter), GFP_KERNEL);
509 err = tcf_exts_init(&f->exts, net, TCA_ROUTE4_ACT, TCA_ROUTE4_POLICE);
516 f->handle = fold->handle;
523 err = route4_set_parms(net, tp, base, f, handle, head, tb,
524 tca[TCA_RATE], new, flags, extack);
528 h = from_hash(f->handle >> 16);
530 for (pfp = rtnl_dereference(*fp);
531 (f1 = rtnl_dereference(*fp)) != NULL;
533 if (f->handle < f1->handle)
536 tcf_block_netif_keep_dst(tp->chain->block);
537 rcu_assign_pointer(f->next, f1);
538 rcu_assign_pointer(*fp, f);
541 th = to_hash(fold->handle);
542 h = from_hash(fold->handle >> 16);
543 b = rtnl_dereference(head->table[th]);
546 for (pfp = rtnl_dereference(*fp); pfp;
547 fp = &pfp->next, pfp = rtnl_dereference(*fp)) {
549 rcu_assign_pointer(*fp, fold->next);
556 route4_reset_fastmap(head);
559 tcf_unbind_filter(tp, &fold->res);
560 tcf_exts_get_net(&fold->exts);
561 tcf_queue_work(&fold->rwork, route4_delete_filter_work);
567 tcf_exts_destroy(&f->exts);
572 static void route4_walk(struct tcf_proto *tp, struct tcf_walker *arg,
575 struct route4_head *head = rtnl_dereference(tp->root);
578 if (head == NULL || arg->stop)
581 for (h = 0; h <= 256; h++) {
582 struct route4_bucket *b = rtnl_dereference(head->table[h]);
585 for (h1 = 0; h1 <= 32; h1++) {
586 struct route4_filter *f;
588 for (f = rtnl_dereference(b->ht[h1]);
590 f = rtnl_dereference(f->next)) {
591 if (!tc_cls_stats_dump(tp, arg, f))
599 static int route4_dump(struct net *net, struct tcf_proto *tp, void *fh,
600 struct sk_buff *skb, struct tcmsg *t, bool rtnl_held)
602 struct route4_filter *f = fh;
609 t->tcm_handle = f->handle;
611 nest = nla_nest_start_noflag(skb, TCA_OPTIONS);
613 goto nla_put_failure;
615 if (!(f->handle & 0x8000)) {
617 if (nla_put_u32(skb, TCA_ROUTE4_TO, id))
618 goto nla_put_failure;
620 if (f->handle & 0x80000000) {
621 if ((f->handle >> 16) != 0xFFFF &&
622 nla_put_u32(skb, TCA_ROUTE4_IIF, f->iif))
623 goto nla_put_failure;
626 if (nla_put_u32(skb, TCA_ROUTE4_FROM, id))
627 goto nla_put_failure;
629 if (f->res.classid &&
630 nla_put_u32(skb, TCA_ROUTE4_CLASSID, f->res.classid))
631 goto nla_put_failure;
633 if (tcf_exts_dump(skb, &f->exts) < 0)
634 goto nla_put_failure;
636 nla_nest_end(skb, nest);
638 if (tcf_exts_dump_stats(skb, &f->exts) < 0)
639 goto nla_put_failure;
644 nla_nest_cancel(skb, nest);
648 static void route4_bind_class(void *fh, u32 classid, unsigned long cl, void *q,
651 struct route4_filter *f = fh;
653 tc_cls_bind_class(classid, cl, q, &f->res, base);
656 static struct tcf_proto_ops cls_route4_ops __read_mostly = {
658 .classify = route4_classify,
660 .destroy = route4_destroy,
662 .change = route4_change,
663 .delete = route4_delete,
666 .bind_class = route4_bind_class,
667 .owner = THIS_MODULE,
670 static int __init init_route4(void)
672 return register_tcf_proto_ops(&cls_route4_ops);
675 static void __exit exit_route4(void)
677 unregister_tcf_proto_ops(&cls_route4_ops);
680 module_init(init_route4)
681 module_exit(exit_route4)
682 MODULE_LICENSE("GPL");