2 * net/sched/act_api.c Packet action 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 * Author: Jamal Hadi Salim
14 #include <linux/types.h>
15 #include <linux/kernel.h>
16 #include <linux/string.h>
17 #include <linux/errno.h>
18 #include <linux/skbuff.h>
19 #include <linux/init.h>
20 #include <linux/kmod.h>
21 #include <linux/err.h>
22 #include <net/net_namespace.h>
24 #include <net/sch_generic.h>
25 #include <net/act_api.h>
26 #include <net/netlink.h>
28 void tcf_hash_destroy(struct tcf_common *p, struct tcf_hashinfo *hinfo)
30 unsigned int h = tcf_hash(p->tcfc_index, hinfo->hmask);
31 struct tcf_common **p1p;
33 for (p1p = &hinfo->htab[h]; *p1p; p1p = &(*p1p)->tcfc_next) {
35 write_lock_bh(hinfo->lock);
37 write_unlock_bh(hinfo->lock);
38 gen_kill_estimator(&p->tcfc_bstats,
46 EXPORT_SYMBOL(tcf_hash_destroy);
48 int tcf_hash_release(struct tcf_common *p, int bind,
49 struct tcf_hashinfo *hinfo)
58 if (p->tcfc_bindcnt <= 0 && p->tcfc_refcnt <= 0) {
59 tcf_hash_destroy(p, hinfo);
65 EXPORT_SYMBOL(tcf_hash_release);
67 static int tcf_dump_walker(struct sk_buff *skb, struct netlink_callback *cb,
68 struct tc_action *a, struct tcf_hashinfo *hinfo)
71 int err = 0, index = -1,i = 0, s_i = 0, n_i = 0;
74 read_lock_bh(hinfo->lock);
78 for (i = 0; i < (hinfo->hmask + 1); i++) {
79 p = hinfo->htab[tcf_hash(i, hinfo->hmask)];
81 for (; p; p = p->tcfc_next) {
88 nest = nla_nest_start(skb, a->order);
91 err = tcf_action_dump_1(skb, a, 0, 0);
94 nlmsg_trim(skb, nest);
97 nla_nest_end(skb, nest);
99 if (n_i >= TCA_ACT_MAX_PRIO)
104 read_unlock_bh(hinfo->lock);
110 nla_nest_cancel(skb, nest);
114 static int tcf_del_walker(struct sk_buff *skb, struct tc_action *a,
115 struct tcf_hashinfo *hinfo)
117 struct tcf_common *p, *s_p;
121 nest = nla_nest_start(skb, a->order);
123 goto nla_put_failure;
124 NLA_PUT_STRING(skb, TCA_KIND, a->ops->kind);
125 for (i = 0; i < (hinfo->hmask + 1); i++) {
126 p = hinfo->htab[tcf_hash(i, hinfo->hmask)];
130 if (ACT_P_DELETED == tcf_hash_release(p, 0, hinfo))
131 module_put(a->ops->owner);
136 NLA_PUT_U32(skb, TCA_FCNT, n_i);
137 nla_nest_end(skb, nest);
141 nla_nest_cancel(skb, nest);
145 int tcf_generic_walker(struct sk_buff *skb, struct netlink_callback *cb,
146 int type, struct tc_action *a)
148 struct tcf_hashinfo *hinfo = a->ops->hinfo;
150 if (type == RTM_DELACTION) {
151 return tcf_del_walker(skb, a, hinfo);
152 } else if (type == RTM_GETACTION) {
153 return tcf_dump_walker(skb, cb, a, hinfo);
155 printk("tcf_generic_walker: unknown action %d\n", type);
159 EXPORT_SYMBOL(tcf_generic_walker);
161 struct tcf_common *tcf_hash_lookup(u32 index, struct tcf_hashinfo *hinfo)
163 struct tcf_common *p;
165 read_lock_bh(hinfo->lock);
166 for (p = hinfo->htab[tcf_hash(index, hinfo->hmask)]; p;
168 if (p->tcfc_index == index)
171 read_unlock_bh(hinfo->lock);
175 EXPORT_SYMBOL(tcf_hash_lookup);
177 u32 tcf_hash_new_index(u32 *idx_gen, struct tcf_hashinfo *hinfo)
184 } while (tcf_hash_lookup(val, hinfo));
186 return (*idx_gen = val);
188 EXPORT_SYMBOL(tcf_hash_new_index);
190 int tcf_hash_search(struct tc_action *a, u32 index)
192 struct tcf_hashinfo *hinfo = a->ops->hinfo;
193 struct tcf_common *p = tcf_hash_lookup(index, hinfo);
201 EXPORT_SYMBOL(tcf_hash_search);
203 struct tcf_common *tcf_hash_check(u32 index, struct tc_action *a, int bind,
204 struct tcf_hashinfo *hinfo)
206 struct tcf_common *p = NULL;
207 if (index && (p = tcf_hash_lookup(index, hinfo)) != NULL) {
215 EXPORT_SYMBOL(tcf_hash_check);
217 struct tcf_common *tcf_hash_create(u32 index, struct nlattr *est, struct tc_action *a, int size, int bind, u32 *idx_gen, struct tcf_hashinfo *hinfo)
219 struct tcf_common *p = kzalloc(size, GFP_KERNEL);
227 spin_lock_init(&p->tcfc_lock);
228 p->tcfc_index = index ? index : tcf_hash_new_index(idx_gen, hinfo);
229 p->tcfc_tm.install = jiffies;
230 p->tcfc_tm.lastuse = jiffies;
232 gen_new_estimator(&p->tcfc_bstats, &p->tcfc_rate_est,
234 a->priv = (void *) p;
237 EXPORT_SYMBOL(tcf_hash_create);
239 void tcf_hash_insert(struct tcf_common *p, struct tcf_hashinfo *hinfo)
241 unsigned int h = tcf_hash(p->tcfc_index, hinfo->hmask);
243 write_lock_bh(hinfo->lock);
244 p->tcfc_next = hinfo->htab[h];
246 write_unlock_bh(hinfo->lock);
248 EXPORT_SYMBOL(tcf_hash_insert);
250 static struct tc_action_ops *act_base = NULL;
251 static DEFINE_RWLOCK(act_mod_lock);
253 int tcf_register_action(struct tc_action_ops *act)
255 struct tc_action_ops *a, **ap;
257 write_lock(&act_mod_lock);
258 for (ap = &act_base; (a = *ap) != NULL; ap = &a->next) {
259 if (act->type == a->type || (strcmp(act->kind, a->kind) == 0)) {
260 write_unlock(&act_mod_lock);
266 write_unlock(&act_mod_lock);
269 EXPORT_SYMBOL(tcf_register_action);
271 int tcf_unregister_action(struct tc_action_ops *act)
273 struct tc_action_ops *a, **ap;
276 write_lock(&act_mod_lock);
277 for (ap = &act_base; (a = *ap) != NULL; ap = &a->next)
285 write_unlock(&act_mod_lock);
288 EXPORT_SYMBOL(tcf_unregister_action);
291 static struct tc_action_ops *tc_lookup_action_n(char *kind)
293 struct tc_action_ops *a = NULL;
296 read_lock(&act_mod_lock);
297 for (a = act_base; a; a = a->next) {
298 if (strcmp(kind, a->kind) == 0) {
299 if (!try_module_get(a->owner)) {
300 read_unlock(&act_mod_lock);
306 read_unlock(&act_mod_lock);
311 /* lookup by nlattr */
312 static struct tc_action_ops *tc_lookup_action(struct nlattr *kind)
314 struct tc_action_ops *a = NULL;
317 read_lock(&act_mod_lock);
318 for (a = act_base; a; a = a->next) {
319 if (nla_strcmp(kind, a->kind) == 0) {
320 if (!try_module_get(a->owner)) {
321 read_unlock(&act_mod_lock);
327 read_unlock(&act_mod_lock);
334 static struct tc_action_ops *tc_lookup_action_id(u32 type)
336 struct tc_action_ops *a = NULL;
339 read_lock(&act_mod_lock);
340 for (a = act_base; a; a = a->next) {
341 if (a->type == type) {
342 if (!try_module_get(a->owner)) {
343 read_unlock(&act_mod_lock);
349 read_unlock(&act_mod_lock);
355 int tcf_action_exec(struct sk_buff *skb, struct tc_action *act,
356 struct tcf_result *res)
361 if (skb->tc_verd & TC_NCLS) {
362 skb->tc_verd = CLR_TC_NCLS(skb->tc_verd);
366 while ((a = act) != NULL) {
368 if (a->ops && a->ops->act) {
369 ret = a->ops->act(skb, a, res);
370 if (TC_MUNGED & skb->tc_verd) {
371 /* copied already, allow trampling */
372 skb->tc_verd = SET_TC_OK2MUNGE(skb->tc_verd);
373 skb->tc_verd = CLR_TC_MUNGED(skb->tc_verd);
375 if (ret == TC_ACT_REPEAT)
376 goto repeat; /* we need a ttl - JHS */
377 if (ret != TC_ACT_PIPE)
385 EXPORT_SYMBOL(tcf_action_exec);
387 void tcf_action_destroy(struct tc_action *act, int bind)
391 for (a = act; a; a = act) {
392 if (a->ops && a->ops->cleanup) {
393 if (a->ops->cleanup(a, bind) == ACT_P_DELETED)
394 module_put(a->ops->owner);
397 } else { /*FIXME: Remove later - catch insertion bugs*/
398 printk("tcf_action_destroy: BUG? destroying NULL ops\n");
406 tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int bind, int ref)
410 if (a->ops == NULL || a->ops->dump == NULL)
412 return a->ops->dump(skb, a, bind, ref);
416 tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int bind, int ref)
419 unsigned char *b = skb_tail_pointer(skb);
422 if (a->ops == NULL || a->ops->dump == NULL)
425 NLA_PUT_STRING(skb, TCA_KIND, a->ops->kind);
426 if (tcf_action_copy_stats(skb, a, 0))
427 goto nla_put_failure;
428 nest = nla_nest_start(skb, TCA_OPTIONS);
430 goto nla_put_failure;
431 if ((err = tcf_action_dump_old(skb, a, bind, ref)) > 0) {
432 nla_nest_end(skb, nest);
440 EXPORT_SYMBOL(tcf_action_dump_1);
443 tcf_action_dump(struct sk_buff *skb, struct tc_action *act, int bind, int ref)
449 while ((a = act) != NULL) {
451 nest = nla_nest_start(skb, a->order);
453 goto nla_put_failure;
454 err = tcf_action_dump_1(skb, a, bind, ref);
457 nla_nest_end(skb, nest);
465 nla_nest_cancel(skb, nest);
469 struct tc_action *tcf_action_init_1(struct nlattr *nla, struct nlattr *est,
470 char *name, int ovr, int bind)
473 struct tc_action_ops *a_o;
474 char act_name[IFNAMSIZ];
475 struct nlattr *tb[TCA_ACT_MAX+1];
480 err = nla_parse_nested(tb, TCA_ACT_MAX, nla, NULL);
484 kind = tb[TCA_ACT_KIND];
487 if (nla_strlcpy(act_name, kind, IFNAMSIZ) >= IFNAMSIZ)
491 if (strlcpy(act_name, name, IFNAMSIZ) >= IFNAMSIZ)
495 a_o = tc_lookup_action_n(act_name);
499 request_module("act_%s", act_name);
502 a_o = tc_lookup_action_n(act_name);
504 /* We dropped the RTNL semaphore in order to
505 * perform the module load. So, even if we
506 * succeeded in loading the module we have to
507 * tell the caller to replay the request. We
508 * indicate this using -EAGAIN.
520 a = kzalloc(sizeof(*a), GFP_KERNEL);
524 /* backward compatibility for policer */
526 err = a_o->init(tb[TCA_ACT_OPTIONS], est, a, ovr, bind);
528 err = a_o->init(nla, est, a, ovr, bind);
532 /* module count goes up only when brand new policy is created
533 if it exists and is only bound to in a_o->init() then
534 ACT_P_CREATED is not returned (a zero is).
536 if (err != ACT_P_CREATED)
537 module_put(a_o->owner);
545 module_put(a_o->owner);
550 struct tc_action *tcf_action_init(struct nlattr *nla, struct nlattr *est,
551 char *name, int ovr, int bind)
553 struct nlattr *tb[TCA_ACT_MAX_PRIO+1];
554 struct tc_action *head = NULL, *act, *act_prev = NULL;
558 err = nla_parse_nested(tb, TCA_ACT_MAX_PRIO, nla, NULL);
562 for (i = 1; i <= TCA_ACT_MAX_PRIO && tb[i]; i++) {
563 act = tcf_action_init_1(tb[i], est, name, ovr, bind);
571 act_prev->next = act;
578 tcf_action_destroy(head, bind);
582 int tcf_action_copy_stats(struct sk_buff *skb, struct tc_action *a,
587 struct tcf_act_hdr *h = a->priv;
592 /* compat_mode being true specifies a call that is supposed
593 * to add additional backward compatiblity statistic TLVs.
596 if (a->type == TCA_OLD_COMPAT)
597 err = gnet_stats_start_copy_compat(skb, 0,
598 TCA_STATS, TCA_XSTATS, &h->tcf_lock, &d);
602 err = gnet_stats_start_copy(skb, TCA_ACT_STATS,
608 if (a->ops != NULL && a->ops->get_stats != NULL)
609 if (a->ops->get_stats(skb, a) < 0)
612 if (gnet_stats_copy_basic(&d, &h->tcf_bstats) < 0 ||
613 gnet_stats_copy_rate_est(&d, &h->tcf_rate_est) < 0 ||
614 gnet_stats_copy_queue(&d, &h->tcf_qstats) < 0)
617 if (gnet_stats_finish_copy(&d) < 0)
627 tca_get_fill(struct sk_buff *skb, struct tc_action *a, u32 pid, u32 seq,
628 u16 flags, int event, int bind, int ref)
631 struct nlmsghdr *nlh;
632 unsigned char *b = skb_tail_pointer(skb);
635 nlh = NLMSG_NEW(skb, pid, seq, event, sizeof(*t), flags);
638 t->tca_family = AF_UNSPEC;
642 nest = nla_nest_start(skb, TCA_ACT_TAB);
644 goto nla_put_failure;
646 if (tcf_action_dump(skb, a, bind, ref) < 0)
647 goto nla_put_failure;
649 nla_nest_end(skb, nest);
651 nlh->nlmsg_len = skb_tail_pointer(skb) - b;
661 act_get_notify(u32 pid, struct nlmsghdr *n, struct tc_action *a, int event)
665 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
668 if (tca_get_fill(skb, a, pid, n->nlmsg_seq, 0, event, 0, 0) <= 0) {
673 return rtnl_unicast(skb, &init_net, pid);
676 static struct tc_action *
677 tcf_action_get_1(struct nlattr *nla, struct nlmsghdr *n, u32 pid)
679 struct nlattr *tb[TCA_ACT_MAX+1];
684 err = nla_parse_nested(tb, TCA_ACT_MAX, nla, NULL);
689 if (tb[TCA_ACT_INDEX] == NULL ||
690 nla_len(tb[TCA_ACT_INDEX]) < sizeof(index))
692 index = nla_get_u32(tb[TCA_ACT_INDEX]);
695 a = kzalloc(sizeof(struct tc_action), GFP_KERNEL);
700 a->ops = tc_lookup_action(tb[TCA_ACT_KIND]);
703 if (a->ops->lookup == NULL)
706 if (a->ops->lookup(a, index) == 0)
709 module_put(a->ops->owner);
713 module_put(a->ops->owner);
720 static void cleanup_a(struct tc_action *act)
724 for (a = act; a; a = act) {
730 static struct tc_action *create_a(int i)
732 struct tc_action *act;
734 act = kzalloc(sizeof(*act), GFP_KERNEL);
736 printk("create_a: failed to alloc!\n");
743 static int tca_action_flush(struct nlattr *nla, struct nlmsghdr *n, u32 pid)
747 struct nlmsghdr *nlh;
749 struct netlink_callback dcb;
751 struct nlattr *tb[TCA_ACT_MAX+1];
753 struct tc_action *a = create_a(0);
757 printk("tca_action_flush: couldnt create tc_action\n");
761 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
763 printk("tca_action_flush: failed skb alloc\n");
768 b = skb_tail_pointer(skb);
770 err = nla_parse_nested(tb, TCA_ACT_MAX, nla, NULL);
775 kind = tb[TCA_ACT_KIND];
776 a->ops = tc_lookup_action(kind);
780 nlh = NLMSG_PUT(skb, pid, n->nlmsg_seq, RTM_DELACTION, sizeof(*t));
782 t->tca_family = AF_UNSPEC;
786 nest = nla_nest_start(skb, TCA_ACT_TAB);
788 goto nla_put_failure;
790 err = a->ops->walk(skb, &dcb, RTM_DELACTION, a);
792 goto nla_put_failure;
794 nla_nest_end(skb, nest);
796 nlh->nlmsg_len = skb_tail_pointer(skb) - b;
797 nlh->nlmsg_flags |= NLM_F_ROOT;
798 module_put(a->ops->owner);
800 err = rtnetlink_send(skb, &init_net, pid, RTNLGRP_TC, n->nlmsg_flags&NLM_F_ECHO);
808 module_put(a->ops->owner);
816 tca_action_gd(struct nlattr *nla, struct nlmsghdr *n, u32 pid, int event)
819 struct nlattr *tb[TCA_ACT_MAX_PRIO+1];
820 struct tc_action *head = NULL, *act, *act_prev = NULL;
822 ret = nla_parse_nested(tb, TCA_ACT_MAX_PRIO, nla, NULL);
826 if (event == RTM_DELACTION && n->nlmsg_flags&NLM_F_ROOT) {
827 if (tb[0] != NULL && tb[1] == NULL)
828 return tca_action_flush(tb[0], n, pid);
831 for (i = 1; i <= TCA_ACT_MAX_PRIO && tb[i]; i++) {
832 act = tcf_action_get_1(tb[i], n, pid);
842 act_prev->next = act;
846 if (event == RTM_GETACTION)
847 ret = act_get_notify(pid, n, head, event);
851 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
857 if (tca_get_fill(skb, head, pid, n->nlmsg_seq, 0, event,
864 /* now do the delete */
865 tcf_action_destroy(head, 0);
866 ret = rtnetlink_send(skb, &init_net, pid, RTNLGRP_TC,
867 n->nlmsg_flags&NLM_F_ECHO);
877 static int tcf_add_notify(struct tc_action *a, u32 pid, u32 seq, int event,
881 struct nlmsghdr *nlh;
887 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
891 b = skb_tail_pointer(skb);
893 nlh = NLMSG_NEW(skb, pid, seq, event, sizeof(*t), flags);
895 t->tca_family = AF_UNSPEC;
899 nest = nla_nest_start(skb, TCA_ACT_TAB);
901 goto nla_put_failure;
903 if (tcf_action_dump(skb, a, 0, 0) < 0)
904 goto nla_put_failure;
906 nla_nest_end(skb, nest);
908 nlh->nlmsg_len = skb_tail_pointer(skb) - b;
909 NETLINK_CB(skb).dst_group = RTNLGRP_TC;
911 err = rtnetlink_send(skb, &init_net, pid, RTNLGRP_TC, flags&NLM_F_ECHO);
924 tcf_action_add(struct nlattr *nla, struct nlmsghdr *n, u32 pid, int ovr)
927 struct tc_action *act;
929 u32 seq = n->nlmsg_seq;
931 act = tcf_action_init(nla, NULL, NULL, ovr, 0);
939 /* dump then free all the actions after update; inserted policy
942 ret = tcf_add_notify(act, pid, seq, RTM_NEWACTION, n->nlmsg_flags);
943 for (a = act; a; a = act) {
951 static int tc_ctl_action(struct sk_buff *skb, struct nlmsghdr *n, void *arg)
953 struct net *net = sock_net(skb->sk);
954 struct nlattr *tca[TCA_ACT_MAX + 1];
955 u32 pid = skb ? NETLINK_CB(skb).pid : 0;
956 int ret = 0, ovr = 0;
958 if (net != &init_net)
961 ret = nlmsg_parse(n, sizeof(struct tcamsg), tca, TCA_ACT_MAX, NULL);
965 if (tca[TCA_ACT_TAB] == NULL) {
966 printk("tc_ctl_action: received NO action attribs\n");
970 /* n->nlmsg_flags&NLM_F_CREATE
972 switch (n->nlmsg_type) {
974 /* we are going to assume all other flags
975 * imply create only if it doesnt exist
976 * Note that CREATE | EXCL implies that
977 * but since we want avoid ambiguity (eg when flags
978 * is zero) then just set this
980 if (n->nlmsg_flags&NLM_F_REPLACE)
983 ret = tcf_action_add(tca[TCA_ACT_TAB], n, pid, ovr);
988 ret = tca_action_gd(tca[TCA_ACT_TAB], n, pid, RTM_DELACTION);
991 ret = tca_action_gd(tca[TCA_ACT_TAB], n, pid, RTM_GETACTION);
1000 static struct nlattr *
1001 find_dump_kind(struct nlmsghdr *n)
1003 struct nlattr *tb1, *tb2[TCA_ACT_MAX+1];
1004 struct nlattr *tb[TCA_ACT_MAX_PRIO + 1];
1005 struct nlattr *nla[TCAA_MAX + 1];
1006 struct nlattr *kind;
1008 if (nlmsg_parse(n, sizeof(struct tcamsg), nla, TCAA_MAX, NULL) < 0)
1010 tb1 = nla[TCA_ACT_TAB];
1014 if (nla_parse(tb, TCA_ACT_MAX_PRIO, nla_data(tb1),
1015 NLMSG_ALIGN(nla_len(tb1)), NULL) < 0)
1020 if (nla_parse(tb2, TCA_ACT_MAX, nla_data(tb[1]),
1021 nla_len(tb[1]), NULL) < 0)
1023 kind = tb2[TCA_ACT_KIND];
1029 tc_dump_action(struct sk_buff *skb, struct netlink_callback *cb)
1031 struct net *net = sock_net(skb->sk);
1032 struct nlmsghdr *nlh;
1033 unsigned char *b = skb_tail_pointer(skb);
1034 struct nlattr *nest;
1035 struct tc_action_ops *a_o;
1038 struct tcamsg *t = (struct tcamsg *) NLMSG_DATA(cb->nlh);
1039 struct nlattr *kind = find_dump_kind(cb->nlh);
1041 if (net != &init_net)
1045 printk("tc_dump_action: action bad kind\n");
1049 a_o = tc_lookup_action(kind);
1054 memset(&a, 0, sizeof(struct tc_action));
1057 if (a_o->walk == NULL) {
1058 printk("tc_dump_action: %s !capable of dumping table\n", a_o->kind);
1059 goto nla_put_failure;
1062 nlh = NLMSG_PUT(skb, NETLINK_CB(cb->skb).pid, cb->nlh->nlmsg_seq,
1063 cb->nlh->nlmsg_type, sizeof(*t));
1064 t = NLMSG_DATA(nlh);
1065 t->tca_family = AF_UNSPEC;
1069 nest = nla_nest_start(skb, TCA_ACT_TAB);
1071 goto nla_put_failure;
1073 ret = a_o->walk(skb, cb, RTM_GETACTION, &a);
1075 goto nla_put_failure;
1078 nla_nest_end(skb, nest);
1081 nla_nest_cancel(skb, nest);
1083 nlh->nlmsg_len = skb_tail_pointer(skb) - b;
1084 if (NETLINK_CB(cb->skb).pid && ret)
1085 nlh->nlmsg_flags |= NLM_F_MULTI;
1086 module_put(a_o->owner);
1091 module_put(a_o->owner);
1096 static int __init tc_action_init(void)
1098 rtnl_register(PF_UNSPEC, RTM_NEWACTION, tc_ctl_action, NULL);
1099 rtnl_register(PF_UNSPEC, RTM_DELACTION, tc_ctl_action, NULL);
1100 rtnl_register(PF_UNSPEC, RTM_GETACTION, tc_ctl_action, tc_dump_action);
1105 subsys_initcall(tc_action_init);