]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/sched/act_mirred.c
net: sched: extract bstats update code into function
[mirror_ubuntu-jammy-kernel.git] / net / sched / act_mirred.c
CommitLineData
2874c5fd 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 2/*
0c6965dd 3 * net/sched/act_mirred.c packet mirroring and redirect actions
1da177e4 4 *
1da177e4
LT
5 * Authors: Jamal Hadi Salim (2002-4)
6 *
7 * TODO: Add ingress support (and socket redirect support)
1da177e4
LT
8 */
9
1da177e4
LT
10#include <linux/types.h>
11#include <linux/kernel.h>
1da177e4 12#include <linux/string.h>
1da177e4 13#include <linux/errno.h>
1da177e4
LT
14#include <linux/skbuff.h>
15#include <linux/rtnetlink.h>
16#include <linux/module.h>
17#include <linux/init.h>
5a0e3ad6 18#include <linux/gfp.h>
c491680f 19#include <linux/if_arp.h>
881d966b 20#include <net/net_namespace.h>
dc5fc579 21#include <net/netlink.h>
1da177e4 22#include <net/pkt_sched.h>
e5cf1baf 23#include <net/pkt_cls.h>
1da177e4
LT
24#include <linux/tc_act/tc_mirred.h>
25#include <net/tc_act/tc_mirred.h>
26
3b87956e 27static LIST_HEAD(mirred_list);
4e232818 28static DEFINE_SPINLOCK(mirred_list_lock);
1da177e4 29
e2ca070f
JH
30#define MIRRED_RECURSION_LIMIT 4
31static DEFINE_PER_CPU(unsigned int, mirred_rec_level);
32
53592b36
SL
33static bool tcf_mirred_is_act_redirect(int action)
34{
35 return action == TCA_EGRESS_REDIR || action == TCA_INGRESS_REDIR;
36}
37
8dc07fdb 38static bool tcf_mirred_act_wants_ingress(int action)
53592b36
SL
39{
40 switch (action) {
41 case TCA_EGRESS_REDIR:
42 case TCA_EGRESS_MIRROR:
8dc07fdb 43 return false;
53592b36
SL
44 case TCA_INGRESS_REDIR:
45 case TCA_INGRESS_MIRROR:
8dc07fdb 46 return true;
53592b36
SL
47 default:
48 BUG();
49 }
50}
51
e5cf1baf
PA
52static bool tcf_mirred_can_reinsert(int action)
53{
54 switch (action) {
55 case TC_ACT_SHOT:
56 case TC_ACT_STOLEN:
57 case TC_ACT_QUEUED:
58 case TC_ACT_TRAP:
59 return true;
60 }
61 return false;
62}
63
4e232818
VB
64static struct net_device *tcf_mirred_dev_dereference(struct tcf_mirred *m)
65{
66 return rcu_dereference_protected(m->tcfm_dev,
67 lockdep_is_held(&m->tcf_lock));
68}
69
9a63b255 70static void tcf_mirred_release(struct tc_action *a)
1da177e4 71{
86062033 72 struct tcf_mirred *m = to_mirred(a);
dc327f89 73 struct net_device *dev;
2ee22a90 74
4e232818 75 spin_lock(&mirred_list_lock);
a5b5c958 76 list_del(&m->tcfm_list);
4e232818
VB
77 spin_unlock(&mirred_list_lock);
78
79 /* last reference to action, no need to lock */
80 dev = rcu_dereference_protected(m->tcfm_dev, 1);
2ee22a90
ED
81 if (dev)
82 dev_put(dev);
1da177e4
LT
83}
84
53b2bf3f
PM
85static const struct nla_policy mirred_policy[TCA_MIRRED_MAX + 1] = {
86 [TCA_MIRRED_PARMS] = { .len = sizeof(struct tc_mirred) },
87};
88
c7d03a00 89static unsigned int mirred_net_id;
a85a970a 90static struct tc_action_ops act_mirred_ops;
ddf97ccd 91
c1b52739 92static int tcf_mirred_init(struct net *net, struct nlattr *nla,
789871bb
VB
93 struct nlattr *est, struct tc_action **a,
94 int ovr, int bind, bool rtnl_held,
85d0966f 95 struct tcf_proto *tp,
789871bb 96 struct netlink_ext_ack *extack)
1da177e4 97{
ddf97ccd 98 struct tc_action_net *tn = net_generic(net, mirred_net_id);
7ba699c6 99 struct nlattr *tb[TCA_MIRRED_MAX + 1];
ff9721d3 100 struct tcf_chain *goto_ch = NULL;
16577923 101 bool mac_header_xmit = false;
1da177e4 102 struct tc_mirred *parm;
e9ce1cd3 103 struct tcf_mirred *m;
b76965e0 104 struct net_device *dev;
b2313077 105 bool exists = false;
0190c1d4 106 int ret, err;
7be8ef2c 107 u32 index;
1da177e4 108
1d4760c7
AA
109 if (!nla) {
110 NL_SET_ERR_MSG_MOD(extack, "Mirred requires attributes to be passed");
1da177e4 111 return -EINVAL;
1d4760c7 112 }
8cb08174
JB
113 ret = nla_parse_nested_deprecated(tb, TCA_MIRRED_MAX, nla,
114 mirred_policy, extack);
b76965e0
CG
115 if (ret < 0)
116 return ret;
1d4760c7
AA
117 if (!tb[TCA_MIRRED_PARMS]) {
118 NL_SET_ERR_MSG_MOD(extack, "Missing required mirred parameters");
1da177e4 119 return -EINVAL;
1d4760c7 120 }
7ba699c6 121 parm = nla_data(tb[TCA_MIRRED_PARMS]);
7be8ef2c
DL
122 index = parm->index;
123 err = tcf_idr_check_alloc(tn, &index, a, bind);
0190c1d4
VB
124 if (err < 0)
125 return err;
126 exists = err;
87dfbdc6
JHS
127 if (exists && bind)
128 return 0;
129
b76965e0
CG
130 switch (parm->eaction) {
131 case TCA_EGRESS_MIRROR:
132 case TCA_EGRESS_REDIR:
53592b36
SL
133 case TCA_INGRESS_REDIR:
134 case TCA_INGRESS_MIRROR:
b76965e0
CG
135 break;
136 default:
87dfbdc6 137 if (exists)
65a206c0 138 tcf_idr_release(*a, bind);
0190c1d4 139 else
7be8ef2c 140 tcf_idr_cleanup(tn, index);
1d4760c7 141 NL_SET_ERR_MSG_MOD(extack, "Unknown mirred option");
b76965e0
CG
142 return -EINVAL;
143 }
1da177e4 144
87dfbdc6 145 if (!exists) {
4e232818 146 if (!parm->ifindex) {
7be8ef2c 147 tcf_idr_cleanup(tn, index);
1d4760c7 148 NL_SET_ERR_MSG_MOD(extack, "Specified device does not exist");
1da177e4 149 return -EINVAL;
1d4760c7 150 }
7be8ef2c 151 ret = tcf_idr_create(tn, index, est, a,
65a206c0 152 &act_mirred_ops, bind, true);
0190c1d4 153 if (ret) {
7be8ef2c 154 tcf_idr_cleanup(tn, index);
86062033 155 return ret;
0190c1d4 156 }
1da177e4 157 ret = ACT_P_CREATED;
4e8ddd7f 158 } else if (!ovr) {
65a206c0 159 tcf_idr_release(*a, bind);
4e8ddd7f 160 return -EEXIST;
1da177e4 161 }
064c5d68
JH
162
163 m = to_mirred(*a);
164 if (ret == ACT_P_CREATED)
165 INIT_LIST_HEAD(&m->tcfm_list);
166
ff9721d3
DC
167 err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
168 if (err < 0)
169 goto release_idr;
170
653cd284 171 spin_lock_bh(&m->tcf_lock);
4e232818
VB
172
173 if (parm->ifindex) {
174 dev = dev_get_by_index(net, parm->ifindex);
175 if (!dev) {
653cd284 176 spin_unlock_bh(&m->tcf_lock);
ff9721d3
DC
177 err = -ENODEV;
178 goto put_chain;
4e232818
VB
179 }
180 mac_header_xmit = dev_is_mac_header_xmit(dev);
181 rcu_swap_protected(m->tcfm_dev, dev,
182 lockdep_is_held(&m->tcf_lock));
183 if (dev)
184 dev_put(dev);
16577923 185 m->tcfm_mac_header_xmit = mac_header_xmit;
1da177e4 186 }
ff9721d3
DC
187 goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
188 m->tcfm_eaction = parm->eaction;
653cd284 189 spin_unlock_bh(&m->tcf_lock);
ff9721d3
DC
190 if (goto_ch)
191 tcf_chain_put_by_act(goto_ch);
2ee22a90 192
3b87956e 193 if (ret == ACT_P_CREATED) {
4e232818 194 spin_lock(&mirred_list_lock);
3b87956e 195 list_add(&m->tcfm_list, &mirred_list);
4e232818
VB
196 spin_unlock(&mirred_list_lock);
197
65a206c0 198 tcf_idr_insert(tn, *a);
3b87956e 199 }
1da177e4 200
1da177e4 201 return ret;
ff9721d3
DC
202put_chain:
203 if (goto_ch)
204 tcf_chain_put_by_act(goto_ch);
205release_idr:
206 tcf_idr_release(*a, bind);
207 return err;
1da177e4
LT
208}
209
7c5790c4
JHS
210static int tcf_mirred_act(struct sk_buff *skb, const struct tc_action *a,
211 struct tcf_result *res)
1da177e4 212{
a85a970a 213 struct tcf_mirred *m = to_mirred(a);
e5cf1baf 214 struct sk_buff *skb2 = skb;
53592b36 215 bool m_mac_header_xmit;
1da177e4 216 struct net_device *dev;
e2ca070f 217 unsigned int rec_level;
53592b36 218 int retval, err = 0;
e5cf1baf
PA
219 bool use_reinsert;
220 bool want_ingress;
221 bool is_redirect;
53592b36
SL
222 int m_eaction;
223 int mac_len;
1da177e4 224
e2ca070f
JH
225 rec_level = __this_cpu_inc_return(mirred_rec_level);
226 if (unlikely(rec_level > MIRRED_RECURSION_LIMIT)) {
227 net_warn_ratelimited("Packet exceeded mirred recursion limit on dev %s\n",
228 netdev_name(skb->dev));
229 __this_cpu_dec(mirred_rec_level);
230 return TC_ACT_SHOT;
231 }
232
2ee22a90 233 tcf_lastuse_update(&m->tcf_tm);
5e1ad95b 234 tcf_action_update_bstats(&m->common, skb);
1da177e4 235
53592b36
SL
236 m_mac_header_xmit = READ_ONCE(m->tcfm_mac_header_xmit);
237 m_eaction = READ_ONCE(m->tcfm_eaction);
2ee22a90 238 retval = READ_ONCE(m->tcf_action);
7fd4b288 239 dev = rcu_dereference_bh(m->tcfm_dev);
2ee22a90
ED
240 if (unlikely(!dev)) {
241 pr_notice_once("tc mirred: target device is gone\n");
3b87956e 242 goto out;
243 }
244
2ee22a90 245 if (unlikely(!(dev->flags & IFF_UP))) {
e87cc472
JP
246 net_notice_ratelimited("tc mirred to Houston: device %s is down\n",
247 dev->name);
feed1f17 248 goto out;
1da177e4
LT
249 }
250
e5cf1baf
PA
251 /* we could easily avoid the clone only if called by ingress and clsact;
252 * since we can't easily detect the clsact caller, skip clone only for
253 * ingress - that covers the TC S/W datapath.
254 */
255 is_redirect = tcf_mirred_is_act_redirect(m_eaction);
256 use_reinsert = skb_at_tc_ingress(skb) && is_redirect &&
257 tcf_mirred_can_reinsert(retval);
258 if (!use_reinsert) {
259 skb2 = skb_clone(skb, GFP_ATOMIC);
260 if (!skb2)
261 goto out;
262 }
1da177e4 263
53592b36
SL
264 /* If action's target direction differs than filter's direction,
265 * and devices expect a mac header on xmit, then mac push/pull is
266 * needed.
267 */
e5cf1baf
PA
268 want_ingress = tcf_mirred_act_wants_ingress(m_eaction);
269 if (skb_at_tc_ingress(skb) != want_ingress && m_mac_header_xmit) {
a5135bcf 270 if (!skb_at_tc_ingress(skb)) {
53592b36
SL
271 /* caught at egress, act ingress: pull mac */
272 mac_len = skb_network_header(skb) - skb_mac_header(skb);
273 skb_pull_rcsum(skb2, mac_len);
274 } else {
275 /* caught at ingress, act egress: push mac */
82a31b92 276 skb_push_rcsum(skb2, skb->mac_len);
53592b36 277 }
feed1f17 278 }
1da177e4 279
e5cf1baf
PA
280 skb2->skb_iif = skb->dev->ifindex;
281 skb2->dev = dev;
282
1da177e4 283 /* mirror is always swallowed */
e5cf1baf 284 if (is_redirect) {
bc31c905
WB
285 skb2->tc_redirected = 1;
286 skb2->tc_from_ingress = skb2->tc_at_ingress;
7236ead1
ED
287 if (skb2->tc_from_ingress)
288 skb2->tstamp = 0;
e5cf1baf
PA
289 /* let's the caller reinsert the packet, if possible */
290 if (use_reinsert) {
291 res->ingress = want_ingress;
292 res->qstats = this_cpu_ptr(m->common.cpu_qstats);
720f22fe 293 skb_tc_reinsert(skb, res);
e2ca070f 294 __this_cpu_dec(mirred_rec_level);
720f22fe 295 return TC_ACT_CONSUMED;
e5cf1baf 296 }
bc31c905 297 }
1da177e4 298
e5cf1baf 299 if (!want_ingress)
53592b36
SL
300 err = dev_queue_xmit(skb2);
301 else
302 err = netif_receive_skb(skb2);
feed1f17 303
feed1f17 304 if (err) {
2ee22a90
ED
305out:
306 qstats_overlimit_inc(this_cpu_ptr(m->common.cpu_qstats));
53592b36 307 if (tcf_mirred_is_act_redirect(m_eaction))
16c0b164 308 retval = TC_ACT_SHOT;
2ee22a90 309 }
e2ca070f 310 __this_cpu_dec(mirred_rec_level);
feed1f17
CG
311
312 return retval;
1da177e4
LT
313}
314
9798e6fe 315static void tcf_stats_update(struct tc_action *a, u64 bytes, u32 packets,
28169aba 316 u64 lastuse, bool hw)
9798e6fe 317{
5712bf9c
PB
318 struct tcf_mirred *m = to_mirred(a);
319 struct tcf_t *tm = &m->tcf_tm;
320
c8ecebd0 321 tcf_action_update_stats(a, bytes, packets, false, hw);
3bb23421 322 tm->lastuse = max_t(u64, tm->lastuse, lastuse);
9798e6fe
JK
323}
324
5a7a5555
JHS
325static int tcf_mirred_dump(struct sk_buff *skb, struct tc_action *a, int bind,
326 int ref)
1da177e4 327{
27a884dc 328 unsigned char *b = skb_tail_pointer(skb);
a85a970a 329 struct tcf_mirred *m = to_mirred(a);
1c40be12
ED
330 struct tc_mirred opt = {
331 .index = m->tcf_index,
036bb443
VB
332 .refcnt = refcount_read(&m->tcf_refcnt) - ref,
333 .bindcnt = atomic_read(&m->tcf_bindcnt) - bind,
1c40be12 334 };
4e232818 335 struct net_device *dev;
1da177e4
LT
336 struct tcf_t t;
337
653cd284 338 spin_lock_bh(&m->tcf_lock);
4e232818
VB
339 opt.action = m->tcf_action;
340 opt.eaction = m->tcfm_eaction;
341 dev = tcf_mirred_dev_dereference(m);
342 if (dev)
343 opt.ifindex = dev->ifindex;
344
1b34ec43
DM
345 if (nla_put(skb, TCA_MIRRED_PARMS, sizeof(opt), &opt))
346 goto nla_put_failure;
48d8ee16
JHS
347
348 tcf_tm_dump(&t, &m->tcf_tm);
9854518e 349 if (nla_put_64bit(skb, TCA_MIRRED_TM, sizeof(t), &t, TCA_MIRRED_PAD))
1b34ec43 350 goto nla_put_failure;
653cd284 351 spin_unlock_bh(&m->tcf_lock);
4e232818 352
1da177e4
LT
353 return skb->len;
354
7ba699c6 355nla_put_failure:
653cd284 356 spin_unlock_bh(&m->tcf_lock);
dc5fc579 357 nlmsg_trim(skb, b);
1da177e4
LT
358 return -1;
359}
360
ddf97ccd
WC
361static int tcf_mirred_walker(struct net *net, struct sk_buff *skb,
362 struct netlink_callback *cb, int type,
41780105
AA
363 const struct tc_action_ops *ops,
364 struct netlink_ext_ack *extack)
ddf97ccd
WC
365{
366 struct tc_action_net *tn = net_generic(net, mirred_net_id);
367
b3620145 368 return tcf_generic_walker(tn, skb, cb, type, ops, extack);
ddf97ccd
WC
369}
370
f061b48c 371static int tcf_mirred_search(struct net *net, struct tc_action **a, u32 index)
ddf97ccd
WC
372{
373 struct tc_action_net *tn = net_generic(net, mirred_net_id);
374
65a206c0 375 return tcf_idr_search(tn, a, index);
ddf97ccd
WC
376}
377
3b87956e 378static int mirred_device_event(struct notifier_block *unused,
379 unsigned long event, void *ptr)
380{
351638e7 381 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3b87956e 382 struct tcf_mirred *m;
383
2ee22a90 384 ASSERT_RTNL();
6bd00b85 385 if (event == NETDEV_UNREGISTER) {
4e232818 386 spin_lock(&mirred_list_lock);
3b87956e 387 list_for_each_entry(m, &mirred_list, tcfm_list) {
653cd284 388 spin_lock_bh(&m->tcf_lock);
4e232818 389 if (tcf_mirred_dev_dereference(m) == dev) {
3b87956e 390 dev_put(dev);
2ee22a90
ED
391 /* Note : no rcu grace period necessary, as
392 * net_device are already rcu protected.
393 */
394 RCU_INIT_POINTER(m->tcfm_dev, NULL);
3b87956e 395 }
653cd284 396 spin_unlock_bh(&m->tcf_lock);
3b87956e 397 }
4e232818 398 spin_unlock(&mirred_list_lock);
6bd00b85 399 }
3b87956e 400
401 return NOTIFY_DONE;
402}
403
404static struct notifier_block mirred_device_notifier = {
405 .notifier_call = mirred_device_event,
406};
407
470d5060
VB
408static void tcf_mirred_dev_put(void *priv)
409{
410 struct net_device *dev = priv;
411
412 dev_put(dev);
413}
414
415static struct net_device *
416tcf_mirred_get_dev(const struct tc_action *a,
417 tc_action_priv_destructor *destructor)
255cb304 418{
843e79d0 419 struct tcf_mirred *m = to_mirred(a);
4e232818 420 struct net_device *dev;
84a75b32 421
4e232818
VB
422 rcu_read_lock();
423 dev = rcu_dereference(m->tcfm_dev);
470d5060 424 if (dev) {
84a75b32 425 dev_hold(dev);
470d5060
VB
426 *destructor = tcf_mirred_dev_put;
427 }
4e232818 428 rcu_read_unlock();
255cb304 429
84a75b32
VB
430 return dev;
431}
432
b84b2d4e
RM
433static size_t tcf_mirred_get_fill_size(const struct tc_action *act)
434{
435 return nla_total_size(sizeof(struct tc_mirred));
436}
437
1da177e4
LT
438static struct tc_action_ops act_mirred_ops = {
439 .kind = "mirred",
eddd2cf1 440 .id = TCA_ID_MIRRED,
1da177e4 441 .owner = THIS_MODULE,
7c5790c4 442 .act = tcf_mirred_act,
9798e6fe 443 .stats_update = tcf_stats_update,
1da177e4 444 .dump = tcf_mirred_dump,
86062033 445 .cleanup = tcf_mirred_release,
1da177e4 446 .init = tcf_mirred_init,
ddf97ccd
WC
447 .walk = tcf_mirred_walker,
448 .lookup = tcf_mirred_search,
b84b2d4e 449 .get_fill_size = tcf_mirred_get_fill_size,
a85a970a 450 .size = sizeof(struct tcf_mirred),
843e79d0 451 .get_dev = tcf_mirred_get_dev,
ddf97ccd
WC
452};
453
454static __net_init int mirred_init_net(struct net *net)
455{
456 struct tc_action_net *tn = net_generic(net, mirred_net_id);
457
981471bd 458 return tc_action_net_init(net, tn, &act_mirred_ops);
ddf97ccd
WC
459}
460
039af9c6 461static void __net_exit mirred_exit_net(struct list_head *net_list)
ddf97ccd 462{
039af9c6 463 tc_action_net_exit(net_list, mirred_net_id);
ddf97ccd
WC
464}
465
466static struct pernet_operations mirred_net_ops = {
467 .init = mirred_init_net,
039af9c6 468 .exit_batch = mirred_exit_net,
ddf97ccd
WC
469 .id = &mirred_net_id,
470 .size = sizeof(struct tc_action_net),
1da177e4
LT
471};
472
473MODULE_AUTHOR("Jamal Hadi Salim(2002)");
474MODULE_DESCRIPTION("Device Mirror/redirect actions");
475MODULE_LICENSE("GPL");
476
e9ce1cd3 477static int __init mirred_init_module(void)
1da177e4 478{
3b87956e 479 int err = register_netdevice_notifier(&mirred_device_notifier);
480 if (err)
481 return err;
482
6ff9c364 483 pr_info("Mirror/redirect action on\n");
11c9a7d3
Y
484 err = tcf_register_action(&act_mirred_ops, &mirred_net_ops);
485 if (err)
486 unregister_netdevice_notifier(&mirred_device_notifier);
487
488 return err;
1da177e4
LT
489}
490
e9ce1cd3 491static void __exit mirred_cleanup_module(void)
1da177e4 492{
ddf97ccd 493 tcf_unregister_action(&act_mirred_ops, &mirred_net_ops);
568a153a 494 unregister_netdevice_notifier(&mirred_device_notifier);
1da177e4
LT
495}
496
497module_init(mirred_init_module);
498module_exit(mirred_cleanup_module);