]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - net/sched/act_police.c
Merge tag 'nios2-v5.4-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/lftan...
[mirror_ubuntu-hirsute-kernel.git] / net / sched / act_police.c
CommitLineData
2874c5fd 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 2/*
0c6965dd 3 * net/sched/act_police.c Input police filter
1da177e4 4 *
1da177e4
LT
5 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
6 * J Hadi Salim (action changes)
7 */
8
1da177e4
LT
9#include <linux/module.h>
10#include <linux/types.h>
11#include <linux/kernel.h>
1da177e4 12#include <linux/string.h>
1da177e4 13#include <linux/errno.h>
1da177e4 14#include <linux/skbuff.h>
1da177e4
LT
15#include <linux/rtnetlink.h>
16#include <linux/init.h>
5a0e3ad6 17#include <linux/slab.h>
1da177e4 18#include <net/act_api.h>
dc5fc579 19#include <net/netlink.h>
d6124d6b 20#include <net/pkt_cls.h>
fa762da9 21#include <net/tc_act/tc_police.h>
1e9b3d53 22
e9ce1cd3 23/* Each policer is serialized by its individual spinlock */
1da177e4 24
c7d03a00 25static unsigned int police_net_id;
a85a970a 26static struct tc_action_ops act_police_ops;
ddf97ccd 27
2ac06347 28static int tcf_police_walker(struct net *net, struct sk_buff *skb,
ddf97ccd 29 struct netlink_callback *cb, int type,
41780105
AA
30 const struct tc_action_ops *ops,
31 struct netlink_ext_ack *extack)
1da177e4 32{
ddf97ccd 33 struct tc_action_net *tn = net_generic(net, police_net_id);
1da177e4 34
b3620145 35 return tcf_generic_walker(tn, skb, cb, type, ops, extack);
1da177e4 36}
1da177e4 37
53b2bf3f
PM
38static const struct nla_policy police_policy[TCA_POLICE_MAX + 1] = {
39 [TCA_POLICE_RATE] = { .len = TC_RTAB_SIZE },
40 [TCA_POLICE_PEAKRATE] = { .len = TC_RTAB_SIZE },
41 [TCA_POLICE_AVRATE] = { .type = NLA_U32 },
42 [TCA_POLICE_RESULT] = { .type = NLA_U32 },
d1967e49
DD
43 [TCA_POLICE_RATE64] = { .type = NLA_U64 },
44 [TCA_POLICE_PEAKRATE64] = { .type = NLA_U64 },
53b2bf3f
PM
45};
46
2ac06347 47static int tcf_police_init(struct net *net, struct nlattr *nla,
a85a970a 48 struct nlattr *est, struct tc_action **a,
789871bb 49 int ovr, int bind, bool rtnl_held,
85d0966f 50 struct tcf_proto *tp,
589dad6d 51 struct netlink_ext_ack *extack)
1da177e4 52{
fd6d4338 53 int ret = 0, tcfp_result = TC_ACT_OK, err, size;
7ba699c6 54 struct nlattr *tb[TCA_POLICE_MAX + 1];
d6124d6b 55 struct tcf_chain *goto_ch = NULL;
1da177e4 56 struct tc_police *parm;
e9ce1cd3 57 struct tcf_police *police;
1da177e4 58 struct qdisc_rate_table *R_tab = NULL, *P_tab = NULL;
ddf97ccd 59 struct tc_action_net *tn = net_generic(net, police_net_id);
2d550dba 60 struct tcf_police_params *new;
0852e455 61 bool exists = false;
7be8ef2c 62 u32 index;
d1967e49 63 u64 rate64, prate64;
1da177e4 64
cee63723 65 if (nla == NULL)
1da177e4
LT
66 return -EINVAL;
67
8cb08174
JB
68 err = nla_parse_nested_deprecated(tb, TCA_POLICE_MAX, nla,
69 police_policy, NULL);
cee63723
PM
70 if (err < 0)
71 return err;
72
7ba699c6 73 if (tb[TCA_POLICE_TBF] == NULL)
1e9b3d53 74 return -EINVAL;
7ba699c6 75 size = nla_len(tb[TCA_POLICE_TBF]);
1e9b3d53 76 if (size != sizeof(*parm) && size != sizeof(struct tc_police_compat))
1da177e4 77 return -EINVAL;
0852e455 78
7ba699c6 79 parm = nla_data(tb[TCA_POLICE_TBF]);
7be8ef2c
DL
80 index = parm->index;
81 err = tcf_idr_check_alloc(tn, &index, a, bind);
0190c1d4
VB
82 if (err < 0)
83 return err;
84 exists = err;
0852e455
WC
85 if (exists && bind)
86 return 0;
1da177e4 87
0852e455 88 if (!exists) {
7be8ef2c 89 ret = tcf_idr_create(tn, index, NULL, a,
93be42f9 90 &act_police_ops, bind, true);
0190c1d4 91 if (ret) {
7be8ef2c 92 tcf_idr_cleanup(tn, index);
a03e6fe5 93 return ret;
0190c1d4 94 }
a03e6fe5 95 ret = ACT_P_CREATED;
484afd1b 96 spin_lock_init(&(to_police(*a)->tcfp_lock));
4e8ddd7f 97 } else if (!ovr) {
65a206c0 98 tcf_idr_release(*a, bind);
4e8ddd7f 99 return -EEXIST;
1da177e4 100 }
d6124d6b
DC
101 err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
102 if (err < 0)
103 goto release_idr;
1da177e4 104
a85a970a 105 police = to_police(*a);
1da177e4
LT
106 if (parm->rate.rate) {
107 err = -ENOMEM;
e9bc3fa2 108 R_tab = qdisc_get_rtab(&parm->rate, tb[TCA_POLICE_RATE], NULL);
1da177e4
LT
109 if (R_tab == NULL)
110 goto failure;
c1b56878 111
1da177e4
LT
112 if (parm->peakrate.rate) {
113 P_tab = qdisc_get_rtab(&parm->peakrate,
e9bc3fa2 114 tb[TCA_POLICE_PEAKRATE], NULL);
71bcb09a 115 if (P_tab == NULL)
1da177e4 116 goto failure;
1da177e4
LT
117 }
118 }
71bcb09a 119
71bcb09a 120 if (est) {
93be42f9
DC
121 err = gen_replace_estimator(&police->tcf_bstats,
122 police->common.cpu_bstats,
71bcb09a 123 &police->tcf_rate_est,
edb09eb1
ED
124 &police->tcf_lock,
125 NULL, est);
71bcb09a 126 if (err)
74030603 127 goto failure;
a883bf56
JP
128 } else if (tb[TCA_POLICE_AVRATE] &&
129 (ret == ACT_P_CREATED ||
1c0d32fd 130 !gen_estimator_active(&police->tcf_rate_est))) {
a883bf56 131 err = -EINVAL;
74030603 132 goto failure;
71bcb09a
SH
133 }
134
fd6d4338
DC
135 if (tb[TCA_POLICE_RESULT]) {
136 tcfp_result = nla_get_u32(tb[TCA_POLICE_RESULT]);
137 if (TC_ACT_EXT_CMP(tcfp_result, TC_ACT_GOTO_CHAIN)) {
138 NL_SET_ERR_MSG(extack,
139 "goto chain not allowed on fallback");
140 err = -EINVAL;
141 goto failure;
142 }
143 }
144
2d550dba
DC
145 new = kzalloc(sizeof(*new), GFP_KERNEL);
146 if (unlikely(!new)) {
147 err = -ENOMEM;
148 goto failure;
149 }
150
71bcb09a 151 /* No failure allowed after this point */
fd6d4338 152 new->tcfp_result = tcfp_result;
2d550dba
DC
153 new->tcfp_mtu = parm->mtu;
154 if (!new->tcfp_mtu) {
155 new->tcfp_mtu = ~0;
c6d14ff1 156 if (R_tab)
2d550dba 157 new->tcfp_mtu = 255 << R_tab->rate.cell_log;
c6d14ff1
JP
158 }
159 if (R_tab) {
2d550dba 160 new->rate_present = true;
d1967e49
DD
161 rate64 = tb[TCA_POLICE_RATE64] ?
162 nla_get_u64(tb[TCA_POLICE_RATE64]) : 0;
163 psched_ratecfg_precompute(&new->rate, &R_tab->rate, rate64);
c6d14ff1
JP
164 qdisc_put_rtab(R_tab);
165 } else {
2d550dba 166 new->rate_present = false;
1da177e4 167 }
c6d14ff1 168 if (P_tab) {
2d550dba 169 new->peak_present = true;
d1967e49
DD
170 prate64 = tb[TCA_POLICE_PEAKRATE64] ?
171 nla_get_u64(tb[TCA_POLICE_PEAKRATE64]) : 0;
172 psched_ratecfg_precompute(&new->peak, &P_tab->rate, prate64);
c6d14ff1
JP
173 qdisc_put_rtab(P_tab);
174 } else {
2d550dba 175 new->peak_present = false;
1da177e4
LT
176 }
177
2d550dba 178 new->tcfp_burst = PSCHED_TICKS2NS(parm->burst);
f2cbd485 179 if (new->peak_present)
2d550dba
DC
180 new->tcfp_mtu_ptoks = (s64)psched_l2t_ns(&new->peak,
181 new->tcfp_mtu);
1da177e4 182
7ba699c6 183 if (tb[TCA_POLICE_AVRATE])
2d550dba 184 new->tcfp_ewma_rate = nla_get_u32(tb[TCA_POLICE_AVRATE]);
1da177e4 185
2d550dba 186 spin_lock_bh(&police->tcf_lock);
f2cbd485
DC
187 spin_lock_bh(&police->tcfp_lock);
188 police->tcfp_t_c = ktime_get_ns();
189 police->tcfp_toks = new->tcfp_burst;
190 if (new->peak_present)
191 police->tcfp_ptoks = new->tcfp_mtu_ptoks;
192 spin_unlock_bh(&police->tcfp_lock);
d6124d6b 193 goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
2d550dba
DC
194 rcu_swap_protected(police->params,
195 new,
196 lockdep_is_held(&police->tcf_lock));
e9ce1cd3 197 spin_unlock_bh(&police->tcf_lock);
1da177e4 198
d6124d6b
DC
199 if (goto_ch)
200 tcf_chain_put_by_act(goto_ch);
2d550dba
DC
201 if (new)
202 kfree_rcu(new, rcu);
1da177e4 203
2d550dba
DC
204 if (ret == ACT_P_CREATED)
205 tcf_idr_insert(tn, *a);
1da177e4
LT
206 return ret;
207
208failure:
3b69a4c9
YY
209 qdisc_put_rtab(P_tab);
210 qdisc_put_rtab(R_tab);
d6124d6b
DC
211 if (goto_ch)
212 tcf_chain_put_by_act(goto_ch);
213release_idr:
4e8ddd7f 214 tcf_idr_release(*a, bind);
1da177e4
LT
215 return err;
216}
217
2ac06347 218static int tcf_police_act(struct sk_buff *skb, const struct tc_action *a,
10297b99 219 struct tcf_result *res)
1da177e4 220{
a85a970a 221 struct tcf_police *police = to_police(a);
2d550dba 222 struct tcf_police_params *p;
93be42f9
DC
223 s64 now, toks, ptoks = 0;
224 int ret;
1da177e4 225
3d3ed181 226 tcf_lastuse_update(&police->tcf_tm);
93be42f9 227 bstats_cpu_update(this_cpu_ptr(police->common.cpu_bstats), skb);
1da177e4 228
2d550dba
DC
229 ret = READ_ONCE(police->tcf_action);
230 p = rcu_dereference_bh(police->params);
231
232 if (p->tcfp_ewma_rate) {
1c0d32fd
ED
233 struct gnet_stats_rate_est64 sample;
234
235 if (!gen_estimator_read(&police->tcf_rate_est, &sample) ||
2d550dba 236 sample.bps >= p->tcfp_ewma_rate)
93be42f9 237 goto inc_overlimits;
1da177e4 238 }
1da177e4 239
2d550dba
DC
240 if (qdisc_pkt_len(skb) <= p->tcfp_mtu) {
241 if (!p->rate_present) {
242 ret = p->tcfp_result;
243 goto end;
1da177e4
LT
244 }
245
d2de875c 246 now = ktime_get_ns();
f2cbd485
DC
247 spin_lock_bh(&police->tcfp_lock);
248 toks = min_t(s64, now - police->tcfp_t_c, p->tcfp_burst);
2d550dba 249 if (p->peak_present) {
f2cbd485 250 ptoks = toks + police->tcfp_ptoks;
2d550dba
DC
251 if (ptoks > p->tcfp_mtu_ptoks)
252 ptoks = p->tcfp_mtu_ptoks;
253 ptoks -= (s64)psched_l2t_ns(&p->peak,
254 qdisc_pkt_len(skb));
1da177e4 255 }
f2cbd485 256 toks += police->tcfp_toks;
2d550dba
DC
257 if (toks > p->tcfp_burst)
258 toks = p->tcfp_burst;
259 toks -= (s64)psched_l2t_ns(&p->rate, qdisc_pkt_len(skb));
1da177e4 260 if ((toks|ptoks) >= 0) {
f2cbd485
DC
261 police->tcfp_t_c = now;
262 police->tcfp_toks = toks;
263 police->tcfp_ptoks = ptoks;
264 spin_unlock_bh(&police->tcfp_lock);
2d550dba 265 ret = p->tcfp_result;
93be42f9 266 goto inc_drops;
1da177e4 267 }
f2cbd485 268 spin_unlock_bh(&police->tcfp_lock);
1da177e4 269 }
93be42f9
DC
270
271inc_overlimits:
272 qstats_overlimit_inc(this_cpu_ptr(police->common.cpu_qstats));
273inc_drops:
274 if (ret == TC_ACT_SHOT)
275 qstats_drop_inc(this_cpu_ptr(police->common.cpu_qstats));
2d550dba 276end:
93be42f9 277 return ret;
1da177e4
LT
278}
279
2d550dba
DC
280static void tcf_police_cleanup(struct tc_action *a)
281{
282 struct tcf_police *police = to_police(a);
283 struct tcf_police_params *p;
284
285 p = rcu_dereference_protected(police->params, 1);
286 if (p)
287 kfree_rcu(p, rcu);
288}
289
12f02b6b
PJV
290static void tcf_police_stats_update(struct tc_action *a,
291 u64 bytes, u32 packets,
292 u64 lastuse, bool hw)
293{
294 struct tcf_police *police = to_police(a);
295 struct tcf_t *tm = &police->tcf_tm;
296
297 _bstats_cpu_update(this_cpu_ptr(a->cpu_bstats), bytes, packets);
298 if (hw)
299 _bstats_cpu_update(this_cpu_ptr(a->cpu_bstats_hw),
300 bytes, packets);
301 tm->lastuse = max_t(u64, tm->lastuse, lastuse);
302}
303
2ac06347 304static int tcf_police_dump(struct sk_buff *skb, struct tc_action *a,
5a7a5555 305 int bind, int ref)
1da177e4 306{
27a884dc 307 unsigned char *b = skb_tail_pointer(skb);
a85a970a 308 struct tcf_police *police = to_police(a);
2d550dba 309 struct tcf_police_params *p;
0f04cfd0
JM
310 struct tc_police opt = {
311 .index = police->tcf_index,
036bb443
VB
312 .refcnt = refcount_read(&police->tcf_refcnt) - ref,
313 .bindcnt = atomic_read(&police->tcf_bindcnt) - bind,
0f04cfd0 314 };
3d3ed181 315 struct tcf_t t;
0f04cfd0 316
e329bc42
VB
317 spin_lock_bh(&police->tcf_lock);
318 opt.action = police->tcf_action;
2d550dba
DC
319 p = rcu_dereference_protected(police->params,
320 lockdep_is_held(&police->tcf_lock));
321 opt.mtu = p->tcfp_mtu;
322 opt.burst = PSCHED_NS2TICKS(p->tcfp_burst);
d1967e49 323 if (p->rate_present) {
2d550dba 324 psched_ratecfg_getrate(&opt.rate, &p->rate);
d1967e49
DD
325 if ((police->params->rate.rate_bytes_ps >= (1ULL << 32)) &&
326 nla_put_u64_64bit(skb, TCA_POLICE_RATE64,
327 police->params->rate.rate_bytes_ps,
328 TCA_POLICE_PAD))
329 goto nla_put_failure;
330 }
331 if (p->peak_present) {
2d550dba 332 psched_ratecfg_getrate(&opt.peakrate, &p->peak);
d1967e49
DD
333 if ((police->params->peak.rate_bytes_ps >= (1ULL << 32)) &&
334 nla_put_u64_64bit(skb, TCA_POLICE_PEAKRATE64,
335 police->params->peak.rate_bytes_ps,
336 TCA_POLICE_PAD))
337 goto nla_put_failure;
338 }
1b34ec43
DM
339 if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt))
340 goto nla_put_failure;
2d550dba
DC
341 if (p->tcfp_result &&
342 nla_put_u32(skb, TCA_POLICE_RESULT, p->tcfp_result))
1b34ec43 343 goto nla_put_failure;
2d550dba
DC
344 if (p->tcfp_ewma_rate &&
345 nla_put_u32(skb, TCA_POLICE_AVRATE, p->tcfp_ewma_rate))
1b34ec43 346 goto nla_put_failure;
3d3ed181
JHS
347
348 t.install = jiffies_to_clock_t(jiffies - police->tcf_tm.install);
349 t.lastuse = jiffies_to_clock_t(jiffies - police->tcf_tm.lastuse);
53eb440f 350 t.firstuse = jiffies_to_clock_t(jiffies - police->tcf_tm.firstuse);
3d3ed181
JHS
351 t.expires = jiffies_to_clock_t(police->tcf_tm.expires);
352 if (nla_put_64bit(skb, TCA_POLICE_TM, sizeof(t), &t, TCA_POLICE_PAD))
353 goto nla_put_failure;
e329bc42 354 spin_unlock_bh(&police->tcf_lock);
3d3ed181 355
1da177e4
LT
356 return skb->len;
357
7ba699c6 358nla_put_failure:
e329bc42 359 spin_unlock_bh(&police->tcf_lock);
dc5fc579 360 nlmsg_trim(skb, b);
1da177e4
LT
361 return -1;
362}
363
f061b48c 364static int tcf_police_search(struct net *net, struct tc_action **a, u32 index)
ddf97ccd
WC
365{
366 struct tc_action_net *tn = net_generic(net, police_net_id);
367
65a206c0 368 return tcf_idr_search(tn, a, index);
ddf97ccd
WC
369}
370
1da177e4
LT
371MODULE_AUTHOR("Alexey Kuznetsov");
372MODULE_DESCRIPTION("Policing actions");
373MODULE_LICENSE("GPL");
374
375static struct tc_action_ops act_police_ops = {
376 .kind = "police",
eddd2cf1 377 .id = TCA_ID_POLICE,
1da177e4 378 .owner = THIS_MODULE,
12f02b6b 379 .stats_update = tcf_police_stats_update,
2ac06347
JHS
380 .act = tcf_police_act,
381 .dump = tcf_police_dump,
382 .init = tcf_police_init,
383 .walk = tcf_police_walker,
ddf97ccd 384 .lookup = tcf_police_search,
2d550dba 385 .cleanup = tcf_police_cleanup,
a85a970a 386 .size = sizeof(struct tcf_police),
ddf97ccd
WC
387};
388
389static __net_init int police_init_net(struct net *net)
390{
391 struct tc_action_net *tn = net_generic(net, police_net_id);
392
981471bd 393 return tc_action_net_init(net, tn, &act_police_ops);
ddf97ccd
WC
394}
395
039af9c6 396static void __net_exit police_exit_net(struct list_head *net_list)
ddf97ccd 397{
039af9c6 398 tc_action_net_exit(net_list, police_net_id);
ddf97ccd
WC
399}
400
401static struct pernet_operations police_net_ops = {
402 .init = police_init_net,
039af9c6 403 .exit_batch = police_exit_net,
ddf97ccd
WC
404 .id = &police_net_id,
405 .size = sizeof(struct tc_action_net),
1da177e4
LT
406};
407
5a7a5555 408static int __init police_init_module(void)
1da177e4 409{
ddf97ccd 410 return tcf_register_action(&act_police_ops, &police_net_ops);
1da177e4
LT
411}
412
5a7a5555 413static void __exit police_cleanup_module(void)
1da177e4 414{
ddf97ccd 415 tcf_unregister_action(&act_police_ops, &police_net_ops);
1da177e4
LT
416}
417
418module_init(police_init_module);
419module_exit(police_cleanup_module);