xref: /openbmc/linux/net/sched/act_simple.c (revision 56d06fa2)
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 
22 #define TCA_ACT_SIMP 22
23 
24 #include <linux/tc_act/tc_defact.h>
25 #include <net/tc_act/tc_defact.h>
26 
27 #define SIMP_TAB_MASK     7
28 
29 static int simp_net_id;
30 
31 #define SIMP_MAX_DATA	32
32 static int tcf_simp(struct sk_buff *skb, const struct tc_action *a,
33 		    struct tcf_result *res)
34 {
35 	struct tcf_defact *d = a->priv;
36 
37 	spin_lock(&d->tcf_lock);
38 	d->tcf_tm.lastuse = jiffies;
39 	bstats_update(&d->tcf_bstats, skb);
40 
41 	/* print policy string followed by _ then packet count
42 	 * Example if this was the 3rd packet and the string was "hello"
43 	 * then it would look like "hello_3" (without quotes)
44 	 */
45 	pr_info("simple: %s_%d\n",
46 	       (char *)d->tcfd_defdata, d->tcf_bstats.packets);
47 	spin_unlock(&d->tcf_lock);
48 	return d->tcf_action;
49 }
50 
51 static void tcf_simp_release(struct tc_action *a, int bind)
52 {
53 	struct tcf_defact *d = to_defact(a);
54 	kfree(d->tcfd_defdata);
55 }
56 
57 static int alloc_defdata(struct tcf_defact *d, char *defdata)
58 {
59 	d->tcfd_defdata = kzalloc(SIMP_MAX_DATA, GFP_KERNEL);
60 	if (unlikely(!d->tcfd_defdata))
61 		return -ENOMEM;
62 	strlcpy(d->tcfd_defdata, defdata, SIMP_MAX_DATA);
63 	return 0;
64 }
65 
66 static void reset_policy(struct tcf_defact *d, char *defdata,
67 			 struct tc_defact *p)
68 {
69 	spin_lock_bh(&d->tcf_lock);
70 	d->tcf_action = p->action;
71 	memset(d->tcfd_defdata, 0, SIMP_MAX_DATA);
72 	strlcpy(d->tcfd_defdata, defdata, SIMP_MAX_DATA);
73 	spin_unlock_bh(&d->tcf_lock);
74 }
75 
76 static const struct nla_policy simple_policy[TCA_DEF_MAX + 1] = {
77 	[TCA_DEF_PARMS]	= { .len = sizeof(struct tc_defact) },
78 	[TCA_DEF_DATA]	= { .type = NLA_STRING, .len = SIMP_MAX_DATA },
79 };
80 
81 static int tcf_simp_init(struct net *net, struct nlattr *nla,
82 			 struct nlattr *est, struct tc_action *a,
83 			 int ovr, int bind)
84 {
85 	struct tc_action_net *tn = net_generic(net, simp_net_id);
86 	struct nlattr *tb[TCA_DEF_MAX + 1];
87 	struct tc_defact *parm;
88 	struct tcf_defact *d;
89 	char *defdata;
90 	int ret = 0, err;
91 
92 	if (nla == NULL)
93 		return -EINVAL;
94 
95 	err = nla_parse_nested(tb, TCA_DEF_MAX, nla, simple_policy);
96 	if (err < 0)
97 		return err;
98 
99 	if (tb[TCA_DEF_PARMS] == NULL)
100 		return -EINVAL;
101 
102 	if (tb[TCA_DEF_DATA] == NULL)
103 		return -EINVAL;
104 
105 	parm = nla_data(tb[TCA_DEF_PARMS]);
106 	defdata = nla_data(tb[TCA_DEF_DATA]);
107 
108 	if (!tcf_hash_check(tn, parm->index, a, bind)) {
109 		ret = tcf_hash_create(tn, parm->index, est, a,
110 				      sizeof(*d), bind, false);
111 		if (ret)
112 			return ret;
113 
114 		d = to_defact(a);
115 		ret = alloc_defdata(d, defdata);
116 		if (ret < 0) {
117 			tcf_hash_cleanup(a, est);
118 			return ret;
119 		}
120 		d->tcf_action = parm->action;
121 		ret = ACT_P_CREATED;
122 	} else {
123 		d = to_defact(a);
124 
125 		if (bind)
126 			return 0;
127 		tcf_hash_release(a, bind);
128 		if (!ovr)
129 			return -EEXIST;
130 
131 		reset_policy(d, defdata, parm);
132 	}
133 
134 	if (ret == ACT_P_CREATED)
135 		tcf_hash_insert(tn, a);
136 	return ret;
137 }
138 
139 static int tcf_simp_dump(struct sk_buff *skb, struct tc_action *a,
140 			 int bind, int ref)
141 {
142 	unsigned char *b = skb_tail_pointer(skb);
143 	struct tcf_defact *d = a->priv;
144 	struct tc_defact opt = {
145 		.index   = d->tcf_index,
146 		.refcnt  = d->tcf_refcnt - ref,
147 		.bindcnt = d->tcf_bindcnt - bind,
148 		.action  = d->tcf_action,
149 	};
150 	struct tcf_t t;
151 
152 	if (nla_put(skb, TCA_DEF_PARMS, sizeof(opt), &opt) ||
153 	    nla_put_string(skb, TCA_DEF_DATA, d->tcfd_defdata))
154 		goto nla_put_failure;
155 	t.install = jiffies_to_clock_t(jiffies - d->tcf_tm.install);
156 	t.lastuse = jiffies_to_clock_t(jiffies - d->tcf_tm.lastuse);
157 	t.expires = jiffies_to_clock_t(d->tcf_tm.expires);
158 	if (nla_put(skb, TCA_DEF_TM, sizeof(t), &t))
159 		goto nla_put_failure;
160 	return skb->len;
161 
162 nla_put_failure:
163 	nlmsg_trim(skb, b);
164 	return -1;
165 }
166 
167 static int tcf_simp_walker(struct net *net, struct sk_buff *skb,
168 			   struct netlink_callback *cb, int type,
169 			   struct tc_action *a)
170 {
171 	struct tc_action_net *tn = net_generic(net, simp_net_id);
172 
173 	return tcf_generic_walker(tn, skb, cb, type, a);
174 }
175 
176 static int tcf_simp_search(struct net *net, struct tc_action *a, u32 index)
177 {
178 	struct tc_action_net *tn = net_generic(net, simp_net_id);
179 
180 	return tcf_hash_search(tn, a, index);
181 }
182 
183 static struct tc_action_ops act_simp_ops = {
184 	.kind		=	"simple",
185 	.type		=	TCA_ACT_SIMP,
186 	.owner		=	THIS_MODULE,
187 	.act		=	tcf_simp,
188 	.dump		=	tcf_simp_dump,
189 	.cleanup	=	tcf_simp_release,
190 	.init		=	tcf_simp_init,
191 	.walk		=	tcf_simp_walker,
192 	.lookup		=	tcf_simp_search,
193 };
194 
195 static __net_init int simp_init_net(struct net *net)
196 {
197 	struct tc_action_net *tn = net_generic(net, simp_net_id);
198 
199 	return tc_action_net_init(tn, &act_simp_ops, SIMP_TAB_MASK);
200 }
201 
202 static void __net_exit simp_exit_net(struct net *net)
203 {
204 	struct tc_action_net *tn = net_generic(net, simp_net_id);
205 
206 	tc_action_net_exit(tn);
207 }
208 
209 static struct pernet_operations simp_net_ops = {
210 	.init = simp_init_net,
211 	.exit = simp_exit_net,
212 	.id   = &simp_net_id,
213 	.size = sizeof(struct tc_action_net),
214 };
215 
216 MODULE_AUTHOR("Jamal Hadi Salim(2005)");
217 MODULE_DESCRIPTION("Simple example action");
218 MODULE_LICENSE("GPL");
219 
220 static int __init simp_init_module(void)
221 {
222 	int ret = tcf_register_action(&act_simp_ops, &simp_net_ops);
223 	if (!ret)
224 		pr_info("Simple TC action Loaded\n");
225 	return ret;
226 }
227 
228 static void __exit simp_cleanup_module(void)
229 {
230 	tcf_unregister_action(&act_simp_ops, &simp_net_ops);
231 }
232 
233 module_init(simp_init_module);
234 module_exit(simp_cleanup_module);
235