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