2 * net/sched/cls_api.c Packet classifier API.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
13 * Eduardo J. Blanco <ejbs@netlabs.com.uy> :990222: kmod support
17 #include <linux/module.h>
18 #include <linux/types.h>
19 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/errno.h>
22 #include <linux/err.h>
23 #include <linux/skbuff.h>
24 #include <linux/init.h>
25 #include <linux/kmod.h>
26 #include <linux/err.h>
27 #include <linux/slab.h>
28 #include <net/net_namespace.h>
30 #include <net/netlink.h>
31 #include <net/pkt_sched.h>
32 #include <net/pkt_cls.h>
34 /* The list of all installed classifier types */
35 static LIST_HEAD(tcf_proto_base);
37 /* Protects list of registered TC modules. It is pure SMP lock. */
38 static DEFINE_RWLOCK(cls_mod_lock);
40 /* Find classifier type by string name */
42 static const struct tcf_proto_ops *tcf_proto_lookup_ops(const char *kind)
44 const struct tcf_proto_ops *t, *res = NULL;
47 read_lock(&cls_mod_lock);
48 list_for_each_entry(t, &tcf_proto_base, head) {
49 if (strcmp(kind, t->kind) == 0) {
50 if (try_module_get(t->owner))
55 read_unlock(&cls_mod_lock);
60 /* Register(unregister) new classifier type */
62 int register_tcf_proto_ops(struct tcf_proto_ops *ops)
64 struct tcf_proto_ops *t;
67 write_lock(&cls_mod_lock);
68 list_for_each_entry(t, &tcf_proto_base, head)
69 if (!strcmp(ops->kind, t->kind))
72 list_add_tail(&ops->head, &tcf_proto_base);
75 write_unlock(&cls_mod_lock);
78 EXPORT_SYMBOL(register_tcf_proto_ops);
80 int unregister_tcf_proto_ops(struct tcf_proto_ops *ops)
82 struct tcf_proto_ops *t;
85 /* Wait for outstanding call_rcu()s, if any, from a
86 * tcf_proto_ops's destroy() handler.
90 write_lock(&cls_mod_lock);
91 list_for_each_entry(t, &tcf_proto_base, head) {
98 write_unlock(&cls_mod_lock);
101 EXPORT_SYMBOL(unregister_tcf_proto_ops);
103 static int tfilter_notify(struct net *net, struct sk_buff *oskb,
104 struct nlmsghdr *n, struct tcf_proto *tp,
105 unsigned long fh, int event, bool unicast);
107 static void tfilter_notify_chain(struct net *net, struct sk_buff *oskb,
109 struct tcf_proto __rcu **chain, int event)
111 struct tcf_proto __rcu **it_chain;
112 struct tcf_proto *tp;
114 for (it_chain = chain; (tp = rtnl_dereference(*it_chain)) != NULL;
115 it_chain = &tp->next)
116 tfilter_notify(net, oskb, n, tp, 0, event, false);
119 /* Select new prio value from the range, managed by kernel. */
121 static inline u32 tcf_auto_prio(struct tcf_proto *tp)
123 u32 first = TC_H_MAKE(0xC0000000U, 0U);
126 first = tp->prio - 1;
131 static struct tcf_proto *tcf_proto_create(const char *kind, u32 protocol,
132 u32 prio, u32 parent, struct Qdisc *q)
134 struct tcf_proto *tp;
137 tp = kzalloc(sizeof(*tp), GFP_KERNEL);
139 return ERR_PTR(-ENOBUFS);
142 tp->ops = tcf_proto_lookup_ops(kind);
144 #ifdef CONFIG_MODULES
146 request_module("cls_%s", kind);
148 tp->ops = tcf_proto_lookup_ops(kind);
149 /* We dropped the RTNL semaphore in order to perform
150 * the module load. So, even if we succeeded in loading
151 * the module we have to replay the request. We indicate
152 * this using -EAGAIN.
155 module_put(tp->ops->owner);
163 tp->classify = tp->ops->classify;
164 tp->protocol = protocol;
166 tp->classid = parent;
169 err = tp->ops->init(tp);
171 module_put(tp->ops->owner);
181 static bool tcf_proto_destroy(struct tcf_proto *tp, bool force)
183 if (tp->ops->destroy(tp, force)) {
184 module_put(tp->ops->owner);
191 void tcf_destroy_chain(struct tcf_proto __rcu **fl)
193 struct tcf_proto *tp;
195 while ((tp = rtnl_dereference(*fl)) != NULL) {
196 RCU_INIT_POINTER(*fl, tp->next);
197 tcf_proto_destroy(tp, true);
200 EXPORT_SYMBOL(tcf_destroy_chain);
202 /* Add/change/delete/get a filter node */
204 static int tc_ctl_tfilter(struct sk_buff *skb, struct nlmsghdr *n,
205 struct netlink_ext_ack *extack)
207 struct net *net = sock_net(skb->sk);
208 struct nlattr *tca[TCA_MAX + 1];
214 struct net_device *dev;
216 struct tcf_proto __rcu **back;
217 struct tcf_proto __rcu **chain;
218 struct tcf_proto *next;
219 struct tcf_proto *tp;
220 const struct Qdisc_class_ops *cops;
226 if ((n->nlmsg_type != RTM_GETTFILTER) &&
227 !netlink_ns_capable(skb, net->user_ns, CAP_NET_ADMIN))
233 err = nlmsg_parse(n, sizeof(*t), tca, TCA_MAX, NULL, extack);
238 protocol = TC_H_MIN(t->tcm_info);
239 prio = TC_H_MAJ(t->tcm_info);
241 parent = t->tcm_parent;
245 switch (n->nlmsg_type) {
247 if (protocol || t->tcm_handle || tca[TCA_KIND])
251 /* If no priority is provided by the user,
254 if (n->nlmsg_flags & NLM_F_CREATE) {
255 prio = TC_H_MAKE(0x80000000U, 0U);
264 /* Find head of filter chain. */
267 dev = __dev_get_by_index(net, t->tcm_ifindex);
276 q = qdisc_lookup(dev, TC_H_MAJ(t->tcm_parent));
281 /* Is it classful? */
282 cops = q->ops->cl_ops;
286 if (cops->tcf_chain == NULL)
289 /* Do we search for filter, attached to class? */
290 if (TC_H_MIN(parent)) {
291 cl = cops->get(q, parent);
296 /* And the last stroke */
297 chain = cops->tcf_chain(q, cl);
302 if (n->nlmsg_type == RTM_DELTFILTER && prio == 0) {
303 tfilter_notify_chain(net, skb, n, chain, RTM_DELTFILTER);
304 tcf_destroy_chain(chain);
309 /* Check the chain for existence of proto-tcf with this priority */
311 (tp = rtnl_dereference(*back)) != NULL;
313 if (tp->prio >= prio) {
314 if (tp->prio == prio) {
316 (tp->protocol != protocol && protocol)) {
328 /* Proto-tcf does not exist, create new one */
330 if (tca[TCA_KIND] == NULL || !protocol) {
335 if (n->nlmsg_type != RTM_NEWTFILTER ||
336 !(n->nlmsg_flags & NLM_F_CREATE)) {
342 nprio = TC_H_MAJ(tcf_auto_prio(rtnl_dereference(*back)));
344 tp = tcf_proto_create(nla_data(tca[TCA_KIND]),
345 protocol, nprio, parent, q);
351 } else if (tca[TCA_KIND] && nla_strcmp(tca[TCA_KIND], tp->ops->kind)) {
356 fh = tp->ops->get(tp, t->tcm_handle);
359 if (n->nlmsg_type == RTM_DELTFILTER && t->tcm_handle == 0) {
360 next = rtnl_dereference(tp->next);
361 RCU_INIT_POINTER(*back, next);
362 tfilter_notify(net, skb, n, tp, fh,
363 RTM_DELTFILTER, false);
364 tcf_proto_destroy(tp, true);
369 if (n->nlmsg_type != RTM_NEWTFILTER ||
370 !(n->nlmsg_flags & NLM_F_CREATE)) {
375 switch (n->nlmsg_type) {
377 if (n->nlmsg_flags & NLM_F_EXCL) {
379 tcf_proto_destroy(tp, true);
385 err = tp->ops->delete(tp, fh);
388 next = rtnl_dereference(tp->next);
389 tfilter_notify(net, skb, n, tp, t->tcm_handle,
390 RTM_DELTFILTER, false);
391 if (tcf_proto_destroy(tp, false))
392 RCU_INIT_POINTER(*back, next);
395 err = tfilter_notify(net, skb, n, tp, fh,
396 RTM_NEWTFILTER, true);
404 err = tp->ops->change(net, skb, tp, cl, t->tcm_handle, tca, &fh,
405 n->nlmsg_flags & NLM_F_CREATE ? TCA_ACT_NOREPLACE : TCA_ACT_REPLACE);
408 RCU_INIT_POINTER(tp->next, rtnl_dereference(*back));
409 rcu_assign_pointer(*back, tp);
411 tfilter_notify(net, skb, n, tp, fh, RTM_NEWTFILTER, false);
414 tcf_proto_destroy(tp, true);
421 /* Replay the request. */
426 static int tcf_fill_node(struct net *net, struct sk_buff *skb,
427 struct tcf_proto *tp, unsigned long fh, u32 portid,
428 u32 seq, u16 flags, int event)
431 struct nlmsghdr *nlh;
432 unsigned char *b = skb_tail_pointer(skb);
434 nlh = nlmsg_put(skb, portid, seq, event, sizeof(*tcm), flags);
437 tcm = nlmsg_data(nlh);
438 tcm->tcm_family = AF_UNSPEC;
441 tcm->tcm_ifindex = qdisc_dev(tp->q)->ifindex;
442 tcm->tcm_parent = tp->classid;
443 tcm->tcm_info = TC_H_MAKE(tp->prio, tp->protocol);
444 if (nla_put_string(skb, TCA_KIND, tp->ops->kind))
445 goto nla_put_failure;
446 tcm->tcm_handle = fh;
447 if (RTM_DELTFILTER != event) {
449 if (tp->ops->dump && tp->ops->dump(net, tp, fh, skb, tcm) < 0)
450 goto nla_put_failure;
452 nlh->nlmsg_len = skb_tail_pointer(skb) - b;
461 static int tfilter_notify(struct net *net, struct sk_buff *oskb,
462 struct nlmsghdr *n, struct tcf_proto *tp,
463 unsigned long fh, int event, bool unicast)
466 u32 portid = oskb ? NETLINK_CB(oskb).portid : 0;
468 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
472 if (tcf_fill_node(net, skb, tp, fh, portid, n->nlmsg_seq,
473 n->nlmsg_flags, event) <= 0) {
479 return netlink_unicast(net->rtnl, skb, portid, MSG_DONTWAIT);
481 return rtnetlink_send(skb, net, portid, RTNLGRP_TC,
482 n->nlmsg_flags & NLM_F_ECHO);
485 struct tcf_dump_args {
488 struct netlink_callback *cb;
491 static int tcf_node_dump(struct tcf_proto *tp, unsigned long n,
492 struct tcf_walker *arg)
494 struct tcf_dump_args *a = (void *)arg;
495 struct net *net = sock_net(a->skb->sk);
497 return tcf_fill_node(net, a->skb, tp, n, NETLINK_CB(a->cb->skb).portid,
498 a->cb->nlh->nlmsg_seq, NLM_F_MULTI,
502 /* called with RTNL */
503 static int tc_dump_tfilter(struct sk_buff *skb, struct netlink_callback *cb)
505 struct net *net = sock_net(skb->sk);
508 struct net_device *dev;
510 struct tcf_proto *tp, __rcu **chain;
511 struct tcmsg *tcm = nlmsg_data(cb->nlh);
512 unsigned long cl = 0;
513 const struct Qdisc_class_ops *cops;
514 struct tcf_dump_args arg;
516 if (nlmsg_len(cb->nlh) < sizeof(*tcm))
518 dev = __dev_get_by_index(net, tcm->tcm_ifindex);
522 if (!tcm->tcm_parent)
525 q = qdisc_lookup(dev, TC_H_MAJ(tcm->tcm_parent));
528 cops = q->ops->cl_ops;
531 if (cops->tcf_chain == NULL)
533 if (TC_H_MIN(tcm->tcm_parent)) {
534 cl = cops->get(q, tcm->tcm_parent);
538 chain = cops->tcf_chain(q, cl);
544 for (tp = rtnl_dereference(*chain), t = 0;
545 tp; tp = rtnl_dereference(tp->next), t++) {
548 if (TC_H_MAJ(tcm->tcm_info) &&
549 TC_H_MAJ(tcm->tcm_info) != tp->prio)
551 if (TC_H_MIN(tcm->tcm_info) &&
552 TC_H_MIN(tcm->tcm_info) != tp->protocol)
555 memset(&cb->args[1], 0,
556 sizeof(cb->args)-sizeof(cb->args[0]));
557 if (cb->args[1] == 0) {
558 if (tcf_fill_node(net, skb, tp, 0,
559 NETLINK_CB(cb->skb).portid,
560 cb->nlh->nlmsg_seq, NLM_F_MULTI,
561 RTM_NEWTFILTER) <= 0)
566 if (tp->ops->walk == NULL)
568 arg.w.fn = tcf_node_dump;
572 arg.w.skip = cb->args[1] - 1;
574 tp->ops->walk(tp, &arg.w);
575 cb->args[1] = arg.w.count + 1;
589 void tcf_exts_destroy(struct tcf_exts *exts)
591 #ifdef CONFIG_NET_CLS_ACT
594 tcf_exts_to_list(exts, &actions);
595 tcf_action_destroy(&actions, TCA_ACT_UNBIND);
596 kfree(exts->actions);
597 exts->nr_actions = 0;
600 EXPORT_SYMBOL(tcf_exts_destroy);
602 int tcf_exts_validate(struct net *net, struct tcf_proto *tp, struct nlattr **tb,
603 struct nlattr *rate_tlv, struct tcf_exts *exts, bool ovr)
605 #ifdef CONFIG_NET_CLS_ACT
607 struct tc_action *act;
609 if (exts->police && tb[exts->police]) {
610 act = tcf_action_init_1(net, tb[exts->police], rate_tlv,
611 "police", ovr, TCA_ACT_BIND);
615 act->type = exts->type = TCA_OLD_COMPAT;
616 exts->actions[0] = act;
617 exts->nr_actions = 1;
618 } else if (exts->action && tb[exts->action]) {
622 err = tcf_action_init(net, tb[exts->action], rate_tlv,
623 NULL, ovr, TCA_ACT_BIND,
627 list_for_each_entry(act, &actions, list)
628 exts->actions[i++] = act;
629 exts->nr_actions = i;
633 if ((exts->action && tb[exts->action]) ||
634 (exts->police && tb[exts->police]))
640 EXPORT_SYMBOL(tcf_exts_validate);
642 void tcf_exts_change(struct tcf_proto *tp, struct tcf_exts *dst,
643 struct tcf_exts *src)
645 #ifdef CONFIG_NET_CLS_ACT
646 struct tcf_exts old = *dst;
649 dst->nr_actions = src->nr_actions;
650 dst->actions = src->actions;
651 dst->type = src->type;
654 tcf_exts_destroy(&old);
657 EXPORT_SYMBOL(tcf_exts_change);
659 #ifdef CONFIG_NET_CLS_ACT
660 static struct tc_action *tcf_exts_first_act(struct tcf_exts *exts)
662 if (exts->nr_actions == 0)
665 return exts->actions[0];
669 int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts)
671 #ifdef CONFIG_NET_CLS_ACT
674 if (exts->action && exts->nr_actions) {
676 * again for backward compatible mode - we want
677 * to work with both old and new modes of entering
678 * tc data even if iproute2 was newer - jhs
680 if (exts->type != TCA_OLD_COMPAT) {
683 nest = nla_nest_start(skb, exts->action);
685 goto nla_put_failure;
687 tcf_exts_to_list(exts, &actions);
688 if (tcf_action_dump(skb, &actions, 0, 0) < 0)
689 goto nla_put_failure;
690 nla_nest_end(skb, nest);
691 } else if (exts->police) {
692 struct tc_action *act = tcf_exts_first_act(exts);
693 nest = nla_nest_start(skb, exts->police);
694 if (nest == NULL || !act)
695 goto nla_put_failure;
696 if (tcf_action_dump_old(skb, act, 0, 0) < 0)
697 goto nla_put_failure;
698 nla_nest_end(skb, nest);
704 nla_nest_cancel(skb, nest);
710 EXPORT_SYMBOL(tcf_exts_dump);
713 int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts)
715 #ifdef CONFIG_NET_CLS_ACT
716 struct tc_action *a = tcf_exts_first_act(exts);
717 if (a != NULL && tcf_action_copy_stats(skb, a, 1) < 0)
722 EXPORT_SYMBOL(tcf_exts_dump_stats);
724 int tcf_exts_get_dev(struct net_device *dev, struct tcf_exts *exts,
725 struct net_device **hw_dev)
727 #ifdef CONFIG_NET_CLS_ACT
728 const struct tc_action *a;
731 if (tc_no_actions(exts))
734 tcf_exts_to_list(exts, &actions);
735 list_for_each_entry(a, &actions, list) {
736 if (a->ops->get_dev) {
737 a->ops->get_dev(a, dev_net(dev), hw_dev);
746 EXPORT_SYMBOL(tcf_exts_get_dev);
748 static int __init tc_filter_init(void)
750 rtnl_register(PF_UNSPEC, RTM_NEWTFILTER, tc_ctl_tfilter, NULL, NULL);
751 rtnl_register(PF_UNSPEC, RTM_DELTFILTER, tc_ctl_tfilter, NULL, NULL);
752 rtnl_register(PF_UNSPEC, RTM_GETTFILTER, tc_ctl_tfilter,
753 tc_dump_tfilter, NULL);
758 subsys_initcall(tc_filter_init);