2 * net/sched/act_mirred.c packet mirroring and redirect actions
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 * Authors: Jamal Hadi Salim (2002-4)
11 * TODO: Add ingress support (and socket redirect support)
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 <linux/if_arp.h>
25 #include <net/net_namespace.h>
26 #include <net/netlink.h>
27 #include <net/pkt_sched.h>
28 #include <net/pkt_cls.h>
29 #include <linux/tc_act/tc_mirred.h>
30 #include <net/tc_act/tc_mirred.h>
32 static LIST_HEAD(mirred_list);
33 static DEFINE_SPINLOCK(mirred_list_lock);
35 static bool tcf_mirred_is_act_redirect(int action)
37 return action == TCA_EGRESS_REDIR || action == TCA_INGRESS_REDIR;
40 static bool tcf_mirred_act_wants_ingress(int action)
43 case TCA_EGRESS_REDIR:
44 case TCA_EGRESS_MIRROR:
46 case TCA_INGRESS_REDIR:
47 case TCA_INGRESS_MIRROR:
54 static bool tcf_mirred_can_reinsert(int action)
66 static struct net_device *tcf_mirred_dev_dereference(struct tcf_mirred *m)
68 return rcu_dereference_protected(m->tcfm_dev,
69 lockdep_is_held(&m->tcf_lock));
72 static void tcf_mirred_release(struct tc_action *a)
74 struct tcf_mirred *m = to_mirred(a);
75 struct net_device *dev;
77 spin_lock(&mirred_list_lock);
78 list_del(&m->tcfm_list);
79 spin_unlock(&mirred_list_lock);
81 /* last reference to action, no need to lock */
82 dev = rcu_dereference_protected(m->tcfm_dev, 1);
87 static const struct nla_policy mirred_policy[TCA_MIRRED_MAX + 1] = {
88 [TCA_MIRRED_PARMS] = { .len = sizeof(struct tc_mirred) },
91 static unsigned int mirred_net_id;
92 static struct tc_action_ops act_mirred_ops;
94 static int tcf_mirred_init(struct net *net, struct nlattr *nla,
95 struct nlattr *est, struct tc_action **a,
96 int ovr, int bind, bool rtnl_held,
98 struct netlink_ext_ack *extack)
100 struct tc_action_net *tn = net_generic(net, mirred_net_id);
101 struct nlattr *tb[TCA_MIRRED_MAX + 1];
102 struct tcf_chain *goto_ch = NULL;
103 bool mac_header_xmit = false;
104 struct tc_mirred *parm;
105 struct tcf_mirred *m;
106 struct net_device *dev;
111 NL_SET_ERR_MSG_MOD(extack, "Mirred requires attributes to be passed");
114 ret = nla_parse_nested_deprecated(tb, TCA_MIRRED_MAX, nla,
115 mirred_policy, extack);
118 if (!tb[TCA_MIRRED_PARMS]) {
119 NL_SET_ERR_MSG_MOD(extack, "Missing required mirred parameters");
122 parm = nla_data(tb[TCA_MIRRED_PARMS]);
124 err = tcf_idr_check_alloc(tn, &parm->index, a, bind);
131 switch (parm->eaction) {
132 case TCA_EGRESS_MIRROR:
133 case TCA_EGRESS_REDIR:
134 case TCA_INGRESS_REDIR:
135 case TCA_INGRESS_MIRROR:
139 tcf_idr_release(*a, bind);
141 tcf_idr_cleanup(tn, parm->index);
142 NL_SET_ERR_MSG_MOD(extack, "Unknown mirred option");
147 if (!parm->ifindex) {
148 tcf_idr_cleanup(tn, parm->index);
149 NL_SET_ERR_MSG_MOD(extack, "Specified device does not exist");
152 ret = tcf_idr_create(tn, parm->index, est, a,
153 &act_mirred_ops, bind, true);
155 tcf_idr_cleanup(tn, parm->index);
160 tcf_idr_release(*a, bind);
165 if (ret == ACT_P_CREATED)
166 INIT_LIST_HEAD(&m->tcfm_list);
168 err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
172 spin_lock_bh(&m->tcf_lock);
175 dev = dev_get_by_index(net, parm->ifindex);
177 spin_unlock_bh(&m->tcf_lock);
181 mac_header_xmit = dev_is_mac_header_xmit(dev);
182 rcu_swap_protected(m->tcfm_dev, dev,
183 lockdep_is_held(&m->tcf_lock));
186 m->tcfm_mac_header_xmit = mac_header_xmit;
188 goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
189 m->tcfm_eaction = parm->eaction;
190 spin_unlock_bh(&m->tcf_lock);
192 tcf_chain_put_by_act(goto_ch);
194 if (ret == ACT_P_CREATED) {
195 spin_lock(&mirred_list_lock);
196 list_add(&m->tcfm_list, &mirred_list);
197 spin_unlock(&mirred_list_lock);
199 tcf_idr_insert(tn, *a);
205 tcf_chain_put_by_act(goto_ch);
207 tcf_idr_release(*a, bind);
211 static int tcf_mirred_act(struct sk_buff *skb, const struct tc_action *a,
212 struct tcf_result *res)
214 struct tcf_mirred *m = to_mirred(a);
215 struct sk_buff *skb2 = skb;
216 bool m_mac_header_xmit;
217 struct net_device *dev;
225 tcf_lastuse_update(&m->tcf_tm);
226 bstats_cpu_update(this_cpu_ptr(m->common.cpu_bstats), skb);
228 m_mac_header_xmit = READ_ONCE(m->tcfm_mac_header_xmit);
229 m_eaction = READ_ONCE(m->tcfm_eaction);
230 retval = READ_ONCE(m->tcf_action);
231 dev = rcu_dereference_bh(m->tcfm_dev);
232 if (unlikely(!dev)) {
233 pr_notice_once("tc mirred: target device is gone\n");
237 if (unlikely(!(dev->flags & IFF_UP))) {
238 net_notice_ratelimited("tc mirred to Houston: device %s is down\n",
243 /* we could easily avoid the clone only if called by ingress and clsact;
244 * since we can't easily detect the clsact caller, skip clone only for
245 * ingress - that covers the TC S/W datapath.
247 is_redirect = tcf_mirred_is_act_redirect(m_eaction);
248 use_reinsert = skb_at_tc_ingress(skb) && is_redirect &&
249 tcf_mirred_can_reinsert(retval);
251 skb2 = skb_clone(skb, GFP_ATOMIC);
256 /* If action's target direction differs than filter's direction,
257 * and devices expect a mac header on xmit, then mac push/pull is
260 want_ingress = tcf_mirred_act_wants_ingress(m_eaction);
261 if (skb_at_tc_ingress(skb) != want_ingress && m_mac_header_xmit) {
262 if (!skb_at_tc_ingress(skb)) {
263 /* caught at egress, act ingress: pull mac */
264 mac_len = skb_network_header(skb) - skb_mac_header(skb);
265 skb_pull_rcsum(skb2, mac_len);
267 /* caught at ingress, act egress: push mac */
268 skb_push_rcsum(skb2, skb->mac_len);
272 skb2->skb_iif = skb->dev->ifindex;
275 /* mirror is always swallowed */
277 skb2->tc_redirected = 1;
278 skb2->tc_from_ingress = skb2->tc_at_ingress;
279 if (skb2->tc_from_ingress)
281 /* let's the caller reinsert the packet, if possible */
283 res->ingress = want_ingress;
284 res->qstats = this_cpu_ptr(m->common.cpu_qstats);
285 return TC_ACT_REINSERT;
290 err = dev_queue_xmit(skb2);
292 err = netif_receive_skb(skb2);
296 qstats_overlimit_inc(this_cpu_ptr(m->common.cpu_qstats));
297 if (tcf_mirred_is_act_redirect(m_eaction))
298 retval = TC_ACT_SHOT;
304 static void tcf_stats_update(struct tc_action *a, u64 bytes, u32 packets,
305 u64 lastuse, bool hw)
307 struct tcf_mirred *m = to_mirred(a);
308 struct tcf_t *tm = &m->tcf_tm;
310 _bstats_cpu_update(this_cpu_ptr(a->cpu_bstats), bytes, packets);
312 _bstats_cpu_update(this_cpu_ptr(a->cpu_bstats_hw),
314 tm->lastuse = max_t(u64, tm->lastuse, lastuse);
317 static int tcf_mirred_dump(struct sk_buff *skb, struct tc_action *a, int bind,
320 unsigned char *b = skb_tail_pointer(skb);
321 struct tcf_mirred *m = to_mirred(a);
322 struct tc_mirred opt = {
323 .index = m->tcf_index,
324 .refcnt = refcount_read(&m->tcf_refcnt) - ref,
325 .bindcnt = atomic_read(&m->tcf_bindcnt) - bind,
327 struct net_device *dev;
330 spin_lock_bh(&m->tcf_lock);
331 opt.action = m->tcf_action;
332 opt.eaction = m->tcfm_eaction;
333 dev = tcf_mirred_dev_dereference(m);
335 opt.ifindex = dev->ifindex;
337 if (nla_put(skb, TCA_MIRRED_PARMS, sizeof(opt), &opt))
338 goto nla_put_failure;
340 tcf_tm_dump(&t, &m->tcf_tm);
341 if (nla_put_64bit(skb, TCA_MIRRED_TM, sizeof(t), &t, TCA_MIRRED_PAD))
342 goto nla_put_failure;
343 spin_unlock_bh(&m->tcf_lock);
348 spin_unlock_bh(&m->tcf_lock);
353 static int tcf_mirred_walker(struct net *net, struct sk_buff *skb,
354 struct netlink_callback *cb, int type,
355 const struct tc_action_ops *ops,
356 struct netlink_ext_ack *extack)
358 struct tc_action_net *tn = net_generic(net, mirred_net_id);
360 return tcf_generic_walker(tn, skb, cb, type, ops, extack);
363 static int tcf_mirred_search(struct net *net, struct tc_action **a, u32 index)
365 struct tc_action_net *tn = net_generic(net, mirred_net_id);
367 return tcf_idr_search(tn, a, index);
370 static int mirred_device_event(struct notifier_block *unused,
371 unsigned long event, void *ptr)
373 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
374 struct tcf_mirred *m;
377 if (event == NETDEV_UNREGISTER) {
378 spin_lock(&mirred_list_lock);
379 list_for_each_entry(m, &mirred_list, tcfm_list) {
380 spin_lock_bh(&m->tcf_lock);
381 if (tcf_mirred_dev_dereference(m) == dev) {
383 /* Note : no rcu grace period necessary, as
384 * net_device are already rcu protected.
386 RCU_INIT_POINTER(m->tcfm_dev, NULL);
388 spin_unlock_bh(&m->tcf_lock);
390 spin_unlock(&mirred_list_lock);
396 static struct notifier_block mirred_device_notifier = {
397 .notifier_call = mirred_device_event,
400 static struct net_device *tcf_mirred_get_dev(const struct tc_action *a)
402 struct tcf_mirred *m = to_mirred(a);
403 struct net_device *dev;
406 dev = rcu_dereference(m->tcfm_dev);
414 static void tcf_mirred_put_dev(struct net_device *dev)
419 static struct tc_action_ops act_mirred_ops = {
422 .owner = THIS_MODULE,
423 .act = tcf_mirred_act,
424 .stats_update = tcf_stats_update,
425 .dump = tcf_mirred_dump,
426 .cleanup = tcf_mirred_release,
427 .init = tcf_mirred_init,
428 .walk = tcf_mirred_walker,
429 .lookup = tcf_mirred_search,
430 .size = sizeof(struct tcf_mirred),
431 .get_dev = tcf_mirred_get_dev,
432 .put_dev = tcf_mirred_put_dev,
435 static __net_init int mirred_init_net(struct net *net)
437 struct tc_action_net *tn = net_generic(net, mirred_net_id);
439 return tc_action_net_init(tn, &act_mirred_ops);
442 static void __net_exit mirred_exit_net(struct list_head *net_list)
444 tc_action_net_exit(net_list, mirred_net_id);
447 static struct pernet_operations mirred_net_ops = {
448 .init = mirred_init_net,
449 .exit_batch = mirred_exit_net,
450 .id = &mirred_net_id,
451 .size = sizeof(struct tc_action_net),
454 MODULE_AUTHOR("Jamal Hadi Salim(2002)");
455 MODULE_DESCRIPTION("Device Mirror/redirect actions");
456 MODULE_LICENSE("GPL");
458 static int __init mirred_init_module(void)
460 int err = register_netdevice_notifier(&mirred_device_notifier);
464 pr_info("Mirror/redirect action on\n");
465 return tcf_register_action(&act_mirred_ops, &mirred_net_ops);
468 static void __exit mirred_cleanup_module(void)
470 tcf_unregister_action(&act_mirred_ops, &mirred_net_ops);
471 unregister_netdevice_notifier(&mirred_device_notifier);
474 module_init(mirred_init_module);
475 module_exit(mirred_cleanup_module);