xref: /openbmc/linux/net/sched/act_mirred.c (revision 78700c0a)
1 /*
2  * net/sched/act_mirred.c	packet mirroring and redirect actions
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 (2002-4)
10  *
11  * TODO: Add ingress support (and socket redirect support)
12  *
13  */
14 
15 #include <linux/types.h>
16 #include <linux/kernel.h>
17 #include <linux/string.h>
18 #include <linux/errno.h>
19 #include <linux/skbuff.h>
20 #include <linux/rtnetlink.h>
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/gfp.h>
24 #include <net/net_namespace.h>
25 #include <net/netlink.h>
26 #include <net/pkt_sched.h>
27 #include <linux/tc_act/tc_mirred.h>
28 #include <net/tc_act/tc_mirred.h>
29 
30 #include <linux/if_arp.h>
31 
32 #define MIRRED_TAB_MASK     7
33 static LIST_HEAD(mirred_list);
34 static DEFINE_SPINLOCK(mirred_list_lock);
35 
36 static void tcf_mirred_release(struct tc_action *a, int bind)
37 {
38 	struct tcf_mirred *m = to_mirred(a);
39 	struct net_device *dev;
40 
41 	/* We could be called either in a RCU callback or with RTNL lock held. */
42 	spin_lock_bh(&mirred_list_lock);
43 	list_del(&m->tcfm_list);
44 	dev = rcu_dereference_protected(m->tcfm_dev, 1);
45 	if (dev)
46 		dev_put(dev);
47 	spin_unlock_bh(&mirred_list_lock);
48 }
49 
50 static const struct nla_policy mirred_policy[TCA_MIRRED_MAX + 1] = {
51 	[TCA_MIRRED_PARMS]	= { .len = sizeof(struct tc_mirred) },
52 };
53 
54 static int mirred_net_id;
55 
56 static int tcf_mirred_init(struct net *net, struct nlattr *nla,
57 			   struct nlattr *est, struct tc_action *a, int ovr,
58 			   int bind)
59 {
60 	struct tc_action_net *tn = net_generic(net, mirred_net_id);
61 	struct nlattr *tb[TCA_MIRRED_MAX + 1];
62 	struct tc_mirred *parm;
63 	struct tcf_mirred *m;
64 	struct net_device *dev;
65 	int ret, ok_push = 0, exists = 0;
66 
67 	if (nla == NULL)
68 		return -EINVAL;
69 	ret = nla_parse_nested(tb, TCA_MIRRED_MAX, nla, mirred_policy);
70 	if (ret < 0)
71 		return ret;
72 	if (tb[TCA_MIRRED_PARMS] == NULL)
73 		return -EINVAL;
74 	parm = nla_data(tb[TCA_MIRRED_PARMS]);
75 
76 	exists = tcf_hash_check(tn, parm->index, a, bind);
77 	if (exists && bind)
78 		return 0;
79 
80 	switch (parm->eaction) {
81 	case TCA_EGRESS_MIRROR:
82 	case TCA_EGRESS_REDIR:
83 		break;
84 	default:
85 		if (exists)
86 			tcf_hash_release(a, bind);
87 		return -EINVAL;
88 	}
89 	if (parm->ifindex) {
90 		dev = __dev_get_by_index(net, parm->ifindex);
91 		if (dev == NULL) {
92 			if (exists)
93 				tcf_hash_release(a, bind);
94 			return -ENODEV;
95 		}
96 		switch (dev->type) {
97 		case ARPHRD_TUNNEL:
98 		case ARPHRD_TUNNEL6:
99 		case ARPHRD_SIT:
100 		case ARPHRD_IPGRE:
101 		case ARPHRD_VOID:
102 		case ARPHRD_NONE:
103 			ok_push = 0;
104 			break;
105 		default:
106 			ok_push = 1;
107 			break;
108 		}
109 	} else {
110 		dev = NULL;
111 	}
112 
113 	if (!exists) {
114 		if (dev == NULL)
115 			return -EINVAL;
116 		ret = tcf_hash_create(tn, parm->index, est, a,
117 				      sizeof(*m), bind, true);
118 		if (ret)
119 			return ret;
120 		ret = ACT_P_CREATED;
121 	} else {
122 		tcf_hash_release(a, bind);
123 		if (!ovr)
124 			return -EEXIST;
125 	}
126 	m = to_mirred(a);
127 
128 	ASSERT_RTNL();
129 	m->tcf_action = parm->action;
130 	m->tcfm_eaction = parm->eaction;
131 	if (dev != NULL) {
132 		m->tcfm_ifindex = parm->ifindex;
133 		if (ret != ACT_P_CREATED)
134 			dev_put(rcu_dereference_protected(m->tcfm_dev, 1));
135 		dev_hold(dev);
136 		rcu_assign_pointer(m->tcfm_dev, dev);
137 		m->tcfm_ok_push = ok_push;
138 	}
139 
140 	if (ret == ACT_P_CREATED) {
141 		spin_lock_bh(&mirred_list_lock);
142 		list_add(&m->tcfm_list, &mirred_list);
143 		spin_unlock_bh(&mirred_list_lock);
144 		tcf_hash_insert(tn, a);
145 	}
146 
147 	return ret;
148 }
149 
150 static int tcf_mirred(struct sk_buff *skb, const struct tc_action *a,
151 		      struct tcf_result *res)
152 {
153 	struct tcf_mirred *m = a->priv;
154 	struct net_device *dev;
155 	struct sk_buff *skb2;
156 	int retval, err;
157 	u32 at;
158 
159 	tcf_lastuse_update(&m->tcf_tm);
160 
161 	bstats_cpu_update(this_cpu_ptr(m->common.cpu_bstats), skb);
162 
163 	rcu_read_lock();
164 	retval = READ_ONCE(m->tcf_action);
165 	dev = rcu_dereference(m->tcfm_dev);
166 	if (unlikely(!dev)) {
167 		pr_notice_once("tc mirred: target device is gone\n");
168 		goto out;
169 	}
170 
171 	if (unlikely(!(dev->flags & IFF_UP))) {
172 		net_notice_ratelimited("tc mirred to Houston: device %s is down\n",
173 				       dev->name);
174 		goto out;
175 	}
176 
177 	at = G_TC_AT(skb->tc_verd);
178 	skb2 = skb_clone(skb, GFP_ATOMIC);
179 	if (!skb2)
180 		goto out;
181 
182 	if (!(at & AT_EGRESS)) {
183 		if (m->tcfm_ok_push)
184 			skb_push(skb2, skb->mac_len);
185 	}
186 
187 	/* mirror is always swallowed */
188 	if (m->tcfm_eaction != TCA_EGRESS_MIRROR)
189 		skb2->tc_verd = SET_TC_FROM(skb2->tc_verd, at);
190 
191 	skb2->skb_iif = skb->dev->ifindex;
192 	skb2->dev = dev;
193 	err = dev_queue_xmit(skb2);
194 
195 	if (err) {
196 out:
197 		qstats_overlimit_inc(this_cpu_ptr(m->common.cpu_qstats));
198 		if (m->tcfm_eaction != TCA_EGRESS_MIRROR)
199 			retval = TC_ACT_SHOT;
200 	}
201 	rcu_read_unlock();
202 
203 	return retval;
204 }
205 
206 static int tcf_mirred_dump(struct sk_buff *skb, struct tc_action *a, int bind, int ref)
207 {
208 	unsigned char *b = skb_tail_pointer(skb);
209 	struct tcf_mirred *m = a->priv;
210 	struct tc_mirred opt = {
211 		.index   = m->tcf_index,
212 		.action  = m->tcf_action,
213 		.refcnt  = m->tcf_refcnt - ref,
214 		.bindcnt = m->tcf_bindcnt - bind,
215 		.eaction = m->tcfm_eaction,
216 		.ifindex = m->tcfm_ifindex,
217 	};
218 	struct tcf_t t;
219 
220 	if (nla_put(skb, TCA_MIRRED_PARMS, sizeof(opt), &opt))
221 		goto nla_put_failure;
222 	t.install = jiffies_to_clock_t(jiffies - m->tcf_tm.install);
223 	t.lastuse = jiffies_to_clock_t(jiffies - m->tcf_tm.lastuse);
224 	t.expires = jiffies_to_clock_t(m->tcf_tm.expires);
225 	if (nla_put_64bit(skb, TCA_MIRRED_TM, sizeof(t), &t, TCA_MIRRED_PAD))
226 		goto nla_put_failure;
227 	return skb->len;
228 
229 nla_put_failure:
230 	nlmsg_trim(skb, b);
231 	return -1;
232 }
233 
234 static int tcf_mirred_walker(struct net *net, struct sk_buff *skb,
235 			     struct netlink_callback *cb, int type,
236 			     struct tc_action *a)
237 {
238 	struct tc_action_net *tn = net_generic(net, mirred_net_id);
239 
240 	return tcf_generic_walker(tn, skb, cb, type, a);
241 }
242 
243 static int tcf_mirred_search(struct net *net, struct tc_action *a, u32 index)
244 {
245 	struct tc_action_net *tn = net_generic(net, mirred_net_id);
246 
247 	return tcf_hash_search(tn, a, index);
248 }
249 
250 static int mirred_device_event(struct notifier_block *unused,
251 			       unsigned long event, void *ptr)
252 {
253 	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
254 	struct tcf_mirred *m;
255 
256 	ASSERT_RTNL();
257 	if (event == NETDEV_UNREGISTER) {
258 		spin_lock_bh(&mirred_list_lock);
259 		list_for_each_entry(m, &mirred_list, tcfm_list) {
260 			if (rcu_access_pointer(m->tcfm_dev) == dev) {
261 				dev_put(dev);
262 				/* Note : no rcu grace period necessary, as
263 				 * net_device are already rcu protected.
264 				 */
265 				RCU_INIT_POINTER(m->tcfm_dev, NULL);
266 			}
267 		}
268 		spin_unlock_bh(&mirred_list_lock);
269 	}
270 
271 	return NOTIFY_DONE;
272 }
273 
274 static struct notifier_block mirred_device_notifier = {
275 	.notifier_call = mirred_device_event,
276 };
277 
278 static struct tc_action_ops act_mirred_ops = {
279 	.kind		=	"mirred",
280 	.type		=	TCA_ACT_MIRRED,
281 	.owner		=	THIS_MODULE,
282 	.act		=	tcf_mirred,
283 	.dump		=	tcf_mirred_dump,
284 	.cleanup	=	tcf_mirred_release,
285 	.init		=	tcf_mirred_init,
286 	.walk		=	tcf_mirred_walker,
287 	.lookup		=	tcf_mirred_search,
288 };
289 
290 static __net_init int mirred_init_net(struct net *net)
291 {
292 	struct tc_action_net *tn = net_generic(net, mirred_net_id);
293 
294 	return tc_action_net_init(tn, &act_mirred_ops, MIRRED_TAB_MASK);
295 }
296 
297 static void __net_exit mirred_exit_net(struct net *net)
298 {
299 	struct tc_action_net *tn = net_generic(net, mirred_net_id);
300 
301 	tc_action_net_exit(tn);
302 }
303 
304 static struct pernet_operations mirred_net_ops = {
305 	.init = mirred_init_net,
306 	.exit = mirred_exit_net,
307 	.id   = &mirred_net_id,
308 	.size = sizeof(struct tc_action_net),
309 };
310 
311 MODULE_AUTHOR("Jamal Hadi Salim(2002)");
312 MODULE_DESCRIPTION("Device Mirror/redirect actions");
313 MODULE_LICENSE("GPL");
314 
315 static int __init mirred_init_module(void)
316 {
317 	int err = register_netdevice_notifier(&mirred_device_notifier);
318 	if (err)
319 		return err;
320 
321 	pr_info("Mirror/redirect action on\n");
322 	return tcf_register_action(&act_mirred_ops, &mirred_net_ops);
323 }
324 
325 static void __exit mirred_cleanup_module(void)
326 {
327 	tcf_unregister_action(&act_mirred_ops, &mirred_net_ops);
328 	unregister_netdevice_notifier(&mirred_device_notifier);
329 }
330 
331 module_init(mirred_init_module);
332 module_exit(mirred_cleanup_module);
333