xref: /linux/net/sched/act_simple.c (revision 7fcfa9a2d9a7c1b428d61992c2deaa9e37a437b0)
1 /*
2  * net/sched/act_simple.c	Simple example of an action
3  *
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.
8  *
9  * Authors:	Jamal Hadi Salim (2005-8)
10  *
11  */
12 
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/skbuff.h>
18 #include <linux/rtnetlink.h>
19 #include <net/netlink.h>
20 #include <net/pkt_sched.h>
21 #include <net/pkt_cls.h>
22 
23 #include <linux/tc_act/tc_defact.h>
24 #include <net/tc_act/tc_defact.h>
25 
26 static unsigned int simp_net_id;
27 static struct tc_action_ops act_simp_ops;
28 
29 #define SIMP_MAX_DATA	32
30 static int tcf_simp_act(struct sk_buff *skb, const struct tc_action *a,
31 			struct tcf_result *res)
32 {
33 	struct tcf_defact *d = to_defact(a);
34 
35 	spin_lock(&d->tcf_lock);
36 	tcf_lastuse_update(&d->tcf_tm);
37 	bstats_update(&d->tcf_bstats, skb);
38 
39 	/* print policy string followed by _ then packet count
40 	 * Example if this was the 3rd packet and the string was "hello"
41 	 * then it would look like "hello_3" (without quotes)
42 	 */
43 	pr_info("simple: %s_%d\n",
44 	       (char *)d->tcfd_defdata, d->tcf_bstats.packets);
45 	spin_unlock(&d->tcf_lock);
46 	return d->tcf_action;
47 }
48 
49 static void tcf_simp_release(struct tc_action *a)
50 {
51 	struct tcf_defact *d = to_defact(a);
52 	kfree(d->tcfd_defdata);
53 }
54 
55 static int alloc_defdata(struct tcf_defact *d, const struct nlattr *defdata)
56 {
57 	d->tcfd_defdata = kzalloc(SIMP_MAX_DATA, GFP_KERNEL);
58 	if (unlikely(!d->tcfd_defdata))
59 		return -ENOMEM;
60 	nla_strlcpy(d->tcfd_defdata, defdata, SIMP_MAX_DATA);
61 	return 0;
62 }
63 
64 static int reset_policy(struct tc_action *a, const struct nlattr *defdata,
65 			struct tc_defact *p, struct tcf_proto *tp,
66 			struct netlink_ext_ack *extack)
67 {
68 	struct tcf_chain *goto_ch = NULL;
69 	struct tcf_defact *d;
70 	int err;
71 
72 	err = tcf_action_check_ctrlact(p->action, tp, &goto_ch, extack);
73 	if (err < 0)
74 		return err;
75 	d = to_defact(a);
76 	spin_lock_bh(&d->tcf_lock);
77 	goto_ch = tcf_action_set_ctrlact(a, p->action, goto_ch);
78 	memset(d->tcfd_defdata, 0, SIMP_MAX_DATA);
79 	nla_strlcpy(d->tcfd_defdata, defdata, SIMP_MAX_DATA);
80 	spin_unlock_bh(&d->tcf_lock);
81 	if (goto_ch)
82 		tcf_chain_put_by_act(goto_ch);
83 	return 0;
84 }
85 
86 static const struct nla_policy simple_policy[TCA_DEF_MAX + 1] = {
87 	[TCA_DEF_PARMS]	= { .len = sizeof(struct tc_defact) },
88 	[TCA_DEF_DATA]	= { .type = NLA_STRING, .len = SIMP_MAX_DATA },
89 };
90 
91 static int tcf_simp_init(struct net *net, struct nlattr *nla,
92 			 struct nlattr *est, struct tc_action **a,
93 			 int ovr, int bind, bool rtnl_held,
94 			 struct tcf_proto *tp, struct netlink_ext_ack *extack)
95 {
96 	struct tc_action_net *tn = net_generic(net, simp_net_id);
97 	struct nlattr *tb[TCA_DEF_MAX + 1];
98 	struct tcf_chain *goto_ch = NULL;
99 	struct tc_defact *parm;
100 	struct tcf_defact *d;
101 	bool exists = false;
102 	int ret = 0, err;
103 
104 	if (nla == NULL)
105 		return -EINVAL;
106 
107 	err = nla_parse_nested(tb, TCA_DEF_MAX, nla, simple_policy, NULL);
108 	if (err < 0)
109 		return err;
110 
111 	if (tb[TCA_DEF_PARMS] == NULL)
112 		return -EINVAL;
113 
114 	parm = nla_data(tb[TCA_DEF_PARMS]);
115 	err = tcf_idr_check_alloc(tn, &parm->index, a, bind);
116 	if (err < 0)
117 		return err;
118 	exists = err;
119 	if (exists && bind)
120 		return 0;
121 
122 	if (tb[TCA_DEF_DATA] == NULL) {
123 		if (exists)
124 			tcf_idr_release(*a, bind);
125 		else
126 			tcf_idr_cleanup(tn, parm->index);
127 		return -EINVAL;
128 	}
129 
130 	if (!exists) {
131 		ret = tcf_idr_create(tn, parm->index, est, a,
132 				     &act_simp_ops, bind, false);
133 		if (ret) {
134 			tcf_idr_cleanup(tn, parm->index);
135 			return ret;
136 		}
137 
138 		d = to_defact(*a);
139 		err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch,
140 					       extack);
141 		if (err < 0)
142 			goto release_idr;
143 
144 		err = alloc_defdata(d, tb[TCA_DEF_DATA]);
145 		if (err < 0)
146 			goto put_chain;
147 
148 		tcf_action_set_ctrlact(*a, parm->action, goto_ch);
149 		ret = ACT_P_CREATED;
150 	} else {
151 		if (!ovr) {
152 			err = -EEXIST;
153 			goto release_idr;
154 		}
155 
156 		err = reset_policy(*a, tb[TCA_DEF_DATA], parm, tp, extack);
157 		if (err)
158 			goto release_idr;
159 	}
160 
161 	if (ret == ACT_P_CREATED)
162 		tcf_idr_insert(tn, *a);
163 	return ret;
164 put_chain:
165 	if (goto_ch)
166 		tcf_chain_put_by_act(goto_ch);
167 release_idr:
168 	tcf_idr_release(*a, bind);
169 	return err;
170 }
171 
172 static int tcf_simp_dump(struct sk_buff *skb, struct tc_action *a,
173 			 int bind, int ref)
174 {
175 	unsigned char *b = skb_tail_pointer(skb);
176 	struct tcf_defact *d = to_defact(a);
177 	struct tc_defact opt = {
178 		.index   = d->tcf_index,
179 		.refcnt  = refcount_read(&d->tcf_refcnt) - ref,
180 		.bindcnt = atomic_read(&d->tcf_bindcnt) - bind,
181 	};
182 	struct tcf_t t;
183 
184 	spin_lock_bh(&d->tcf_lock);
185 	opt.action = d->tcf_action;
186 	if (nla_put(skb, TCA_DEF_PARMS, sizeof(opt), &opt) ||
187 	    nla_put_string(skb, TCA_DEF_DATA, d->tcfd_defdata))
188 		goto nla_put_failure;
189 
190 	tcf_tm_dump(&t, &d->tcf_tm);
191 	if (nla_put_64bit(skb, TCA_DEF_TM, sizeof(t), &t, TCA_DEF_PAD))
192 		goto nla_put_failure;
193 	spin_unlock_bh(&d->tcf_lock);
194 
195 	return skb->len;
196 
197 nla_put_failure:
198 	spin_unlock_bh(&d->tcf_lock);
199 	nlmsg_trim(skb, b);
200 	return -1;
201 }
202 
203 static int tcf_simp_walker(struct net *net, struct sk_buff *skb,
204 			   struct netlink_callback *cb, int type,
205 			   const struct tc_action_ops *ops,
206 			   struct netlink_ext_ack *extack)
207 {
208 	struct tc_action_net *tn = net_generic(net, simp_net_id);
209 
210 	return tcf_generic_walker(tn, skb, cb, type, ops, extack);
211 }
212 
213 static int tcf_simp_search(struct net *net, struct tc_action **a, u32 index)
214 {
215 	struct tc_action_net *tn = net_generic(net, simp_net_id);
216 
217 	return tcf_idr_search(tn, a, index);
218 }
219 
220 static struct tc_action_ops act_simp_ops = {
221 	.kind		=	"simple",
222 	.id		=	TCA_ID_SIMP,
223 	.owner		=	THIS_MODULE,
224 	.act		=	tcf_simp_act,
225 	.dump		=	tcf_simp_dump,
226 	.cleanup	=	tcf_simp_release,
227 	.init		=	tcf_simp_init,
228 	.walk		=	tcf_simp_walker,
229 	.lookup		=	tcf_simp_search,
230 	.size		=	sizeof(struct tcf_defact),
231 };
232 
233 static __net_init int simp_init_net(struct net *net)
234 {
235 	struct tc_action_net *tn = net_generic(net, simp_net_id);
236 
237 	return tc_action_net_init(tn, &act_simp_ops);
238 }
239 
240 static void __net_exit simp_exit_net(struct list_head *net_list)
241 {
242 	tc_action_net_exit(net_list, simp_net_id);
243 }
244 
245 static struct pernet_operations simp_net_ops = {
246 	.init = simp_init_net,
247 	.exit_batch = simp_exit_net,
248 	.id   = &simp_net_id,
249 	.size = sizeof(struct tc_action_net),
250 };
251 
252 MODULE_AUTHOR("Jamal Hadi Salim(2005)");
253 MODULE_DESCRIPTION("Simple example action");
254 MODULE_LICENSE("GPL");
255 
256 static int __init simp_init_module(void)
257 {
258 	int ret = tcf_register_action(&act_simp_ops, &simp_net_ops);
259 	if (!ret)
260 		pr_info("Simple TC action Loaded\n");
261 	return ret;
262 }
263 
264 static void __exit simp_cleanup_module(void)
265 {
266 	tcf_unregister_action(&act_simp_ops, &simp_net_ops);
267 }
268 
269 module_init(simp_init_module);
270 module_exit(simp_cleanup_module);
271