]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - net/sched/act_police.c
net: core: protect rate estimator statistics pointer with lock
[mirror_ubuntu-hirsute-kernel.git] / net / sched / act_police.c
CommitLineData
1da177e4 1/*
0c6965dd 2 * net/sched/act_police.c Input police filter
1da177e4
LT
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: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
10 * J Hadi Salim (action changes)
11 */
12
1da177e4
LT
13#include <linux/module.h>
14#include <linux/types.h>
15#include <linux/kernel.h>
1da177e4 16#include <linux/string.h>
1da177e4 17#include <linux/errno.h>
1da177e4 18#include <linux/skbuff.h>
1da177e4
LT
19#include <linux/rtnetlink.h>
20#include <linux/init.h>
5a0e3ad6 21#include <linux/slab.h>
1da177e4 22#include <net/act_api.h>
dc5fc579 23#include <net/netlink.h>
1da177e4 24
0e243218 25struct tcf_police {
ec0595cc 26 struct tc_action common;
0e243218
JP
27 int tcfp_result;
28 u32 tcfp_ewma_rate;
c6d14ff1 29 s64 tcfp_burst;
0e243218 30 u32 tcfp_mtu;
c6d14ff1
JP
31 s64 tcfp_toks;
32 s64 tcfp_ptoks;
33 s64 tcfp_mtu_ptoks;
34 s64 tcfp_t_c;
35 struct psched_ratecfg rate;
36 bool rate_present;
37 struct psched_ratecfg peak;
38 bool peak_present;
0e243218 39};
a85a970a
WC
40
41#define to_police(pc) ((struct tcf_police *)pc)
0e243218 42
1e9b3d53 43/* old policer structure from before tc actions */
cc7ec456 44struct tc_police_compat {
1e9b3d53
PM
45 u32 index;
46 int action;
47 u32 limit;
48 u32 burst;
49 u32 mtu;
50 struct tc_ratespec rate;
51 struct tc_ratespec peakrate;
52};
53
e9ce1cd3 54/* Each policer is serialized by its individual spinlock */
1da177e4 55
c7d03a00 56static unsigned int police_net_id;
a85a970a 57static struct tc_action_ops act_police_ops;
ddf97ccd
WC
58
59static int tcf_act_police_walker(struct net *net, struct sk_buff *skb,
60 struct netlink_callback *cb, int type,
41780105
AA
61 const struct tc_action_ops *ops,
62 struct netlink_ext_ack *extack)
1da177e4 63{
ddf97ccd 64 struct tc_action_net *tn = net_generic(net, police_net_id);
1da177e4 65
b3620145 66 return tcf_generic_walker(tn, skb, cb, type, ops, extack);
1da177e4 67}
1da177e4 68
53b2bf3f
PM
69static const struct nla_policy police_policy[TCA_POLICE_MAX + 1] = {
70 [TCA_POLICE_RATE] = { .len = TC_RTAB_SIZE },
71 [TCA_POLICE_PEAKRATE] = { .len = TC_RTAB_SIZE },
72 [TCA_POLICE_AVRATE] = { .type = NLA_U32 },
73 [TCA_POLICE_RESULT] = { .type = NLA_U32 },
74};
75
d9fa17ef 76static int tcf_act_police_init(struct net *net, struct nlattr *nla,
a85a970a 77 struct nlattr *est, struct tc_action **a,
789871bb 78 int ovr, int bind, bool rtnl_held,
589dad6d 79 struct netlink_ext_ack *extack)
1da177e4 80{
1da177e4 81 int ret = 0, err;
7ba699c6 82 struct nlattr *tb[TCA_POLICE_MAX + 1];
1da177e4 83 struct tc_police *parm;
e9ce1cd3 84 struct tcf_police *police;
1da177e4 85 struct qdisc_rate_table *R_tab = NULL, *P_tab = NULL;
ddf97ccd 86 struct tc_action_net *tn = net_generic(net, police_net_id);
0852e455 87 bool exists = false;
1e9b3d53 88 int size;
1da177e4 89
cee63723 90 if (nla == NULL)
1da177e4
LT
91 return -EINVAL;
92
fceb6435 93 err = nla_parse_nested(tb, TCA_POLICE_MAX, nla, police_policy, NULL);
cee63723
PM
94 if (err < 0)
95 return err;
96
7ba699c6 97 if (tb[TCA_POLICE_TBF] == NULL)
1e9b3d53 98 return -EINVAL;
7ba699c6 99 size = nla_len(tb[TCA_POLICE_TBF]);
1e9b3d53 100 if (size != sizeof(*parm) && size != sizeof(struct tc_police_compat))
1da177e4 101 return -EINVAL;
0852e455 102
7ba699c6 103 parm = nla_data(tb[TCA_POLICE_TBF]);
0190c1d4
VB
104 err = tcf_idr_check_alloc(tn, &parm->index, a, bind);
105 if (err < 0)
106 return err;
107 exists = err;
0852e455
WC
108 if (exists && bind)
109 return 0;
1da177e4 110
0852e455 111 if (!exists) {
65a206c0
CM
112 ret = tcf_idr_create(tn, parm->index, NULL, a,
113 &act_police_ops, bind, false);
0190c1d4
VB
114 if (ret) {
115 tcf_idr_cleanup(tn, parm->index);
a03e6fe5 116 return ret;
0190c1d4 117 }
a03e6fe5 118 ret = ACT_P_CREATED;
4e8ddd7f 119 } else if (!ovr) {
65a206c0 120 tcf_idr_release(*a, bind);
4e8ddd7f 121 return -EEXIST;
1da177e4
LT
122 }
123
a85a970a 124 police = to_police(*a);
1da177e4
LT
125 if (parm->rate.rate) {
126 err = -ENOMEM;
e9bc3fa2 127 R_tab = qdisc_get_rtab(&parm->rate, tb[TCA_POLICE_RATE], NULL);
1da177e4
LT
128 if (R_tab == NULL)
129 goto failure;
c1b56878 130
1da177e4
LT
131 if (parm->peakrate.rate) {
132 P_tab = qdisc_get_rtab(&parm->peakrate,
e9bc3fa2 133 tb[TCA_POLICE_PEAKRATE], NULL);
71bcb09a 134 if (P_tab == NULL)
1da177e4 135 goto failure;
1da177e4
LT
136 }
137 }
71bcb09a 138
71bcb09a 139 if (est) {
22e0f8b9 140 err = gen_replace_estimator(&police->tcf_bstats, NULL,
71bcb09a 141 &police->tcf_rate_est,
edb09eb1
ED
142 &police->tcf_lock,
143 NULL, est);
71bcb09a 144 if (err)
74030603 145 goto failure;
a883bf56
JP
146 } else if (tb[TCA_POLICE_AVRATE] &&
147 (ret == ACT_P_CREATED ||
1c0d32fd 148 !gen_estimator_active(&police->tcf_rate_est))) {
a883bf56 149 err = -EINVAL;
74030603 150 goto failure;
71bcb09a
SH
151 }
152
74030603 153 spin_lock_bh(&police->tcf_lock);
71bcb09a 154 /* No failure allowed after this point */
c6d14ff1
JP
155 police->tcfp_mtu = parm->mtu;
156 if (police->tcfp_mtu == 0) {
157 police->tcfp_mtu = ~0;
158 if (R_tab)
159 police->tcfp_mtu = 255 << R_tab->rate.cell_log;
160 }
161 if (R_tab) {
162 police->rate_present = true;
3e1e3aae 163 psched_ratecfg_precompute(&police->rate, &R_tab->rate, 0);
c6d14ff1
JP
164 qdisc_put_rtab(R_tab);
165 } else {
166 police->rate_present = false;
1da177e4 167 }
c6d14ff1
JP
168 if (P_tab) {
169 police->peak_present = true;
3e1e3aae 170 psched_ratecfg_precompute(&police->peak, &P_tab->rate, 0);
c6d14ff1
JP
171 qdisc_put_rtab(P_tab);
172 } else {
173 police->peak_present = false;
1da177e4
LT
174 }
175
7ba699c6 176 if (tb[TCA_POLICE_RESULT])
1587bac4 177 police->tcfp_result = nla_get_u32(tb[TCA_POLICE_RESULT]);
c6d14ff1
JP
178 police->tcfp_burst = PSCHED_TICKS2NS(parm->burst);
179 police->tcfp_toks = police->tcfp_burst;
180 if (police->peak_present) {
181 police->tcfp_mtu_ptoks = (s64) psched_l2t_ns(&police->peak,
182 police->tcfp_mtu);
183 police->tcfp_ptoks = police->tcfp_mtu_ptoks;
1da177e4 184 }
e9ce1cd3 185 police->tcf_action = parm->action;
1da177e4 186
7ba699c6 187 if (tb[TCA_POLICE_AVRATE])
1587bac4 188 police->tcfp_ewma_rate = nla_get_u32(tb[TCA_POLICE_AVRATE]);
1da177e4 189
e9ce1cd3 190 spin_unlock_bh(&police->tcf_lock);
1da177e4
LT
191 if (ret != ACT_P_CREATED)
192 return ret;
193
d2de875c 194 police->tcfp_t_c = ktime_get_ns();
65a206c0 195 tcf_idr_insert(tn, *a);
1da177e4 196
1da177e4
LT
197 return ret;
198
199failure:
3b69a4c9
YY
200 qdisc_put_rtab(P_tab);
201 qdisc_put_rtab(R_tab);
4e8ddd7f 202 tcf_idr_release(*a, bind);
1da177e4
LT
203 return err;
204}
205
dc7f9f6e 206static int tcf_act_police(struct sk_buff *skb, const struct tc_action *a,
10297b99 207 struct tcf_result *res)
1da177e4 208{
a85a970a 209 struct tcf_police *police = to_police(a);
c6d14ff1
JP
210 s64 now;
211 s64 toks;
212 s64 ptoks = 0;
1da177e4 213
e9ce1cd3 214 spin_lock(&police->tcf_lock);
1da177e4 215
bfe0d029 216 bstats_update(&police->tcf_bstats, skb);
3d3ed181 217 tcf_lastuse_update(&police->tcf_tm);
1da177e4 218
1c0d32fd
ED
219 if (police->tcfp_ewma_rate) {
220 struct gnet_stats_rate_est64 sample;
221
222 if (!gen_estimator_read(&police->tcf_rate_est, &sample) ||
223 sample.bps >= police->tcfp_ewma_rate) {
224 police->tcf_qstats.overlimits++;
225 if (police->tcf_action == TC_ACT_SHOT)
226 police->tcf_qstats.drops++;
227 spin_unlock(&police->tcf_lock);
228 return police->tcf_action;
229 }
1da177e4 230 }
1da177e4 231
0abf77e5 232 if (qdisc_pkt_len(skb) <= police->tcfp_mtu) {
c6d14ff1 233 if (!police->rate_present) {
e9ce1cd3
DM
234 spin_unlock(&police->tcf_lock);
235 return police->tcfp_result;
1da177e4
LT
236 }
237
d2de875c 238 now = ktime_get_ns();
c6d14ff1
JP
239 toks = min_t(s64, now - police->tcfp_t_c,
240 police->tcfp_burst);
241 if (police->peak_present) {
e9ce1cd3 242 ptoks = toks + police->tcfp_ptoks;
c6d14ff1
JP
243 if (ptoks > police->tcfp_mtu_ptoks)
244 ptoks = police->tcfp_mtu_ptoks;
245 ptoks -= (s64) psched_l2t_ns(&police->peak,
246 qdisc_pkt_len(skb));
1da177e4 247 }
e9ce1cd3 248 toks += police->tcfp_toks;
c6d14ff1 249 if (toks > police->tcfp_burst)
e9ce1cd3 250 toks = police->tcfp_burst;
c6d14ff1 251 toks -= (s64) psched_l2t_ns(&police->rate, qdisc_pkt_len(skb));
1da177e4 252 if ((toks|ptoks) >= 0) {
e9ce1cd3
DM
253 police->tcfp_t_c = now;
254 police->tcfp_toks = toks;
255 police->tcfp_ptoks = ptoks;
f71b109f
RM
256 if (police->tcfp_result == TC_ACT_SHOT)
257 police->tcf_qstats.drops++;
e9ce1cd3
DM
258 spin_unlock(&police->tcf_lock);
259 return police->tcfp_result;
1da177e4
LT
260 }
261 }
262
e9ce1cd3 263 police->tcf_qstats.overlimits++;
b9647580
JP
264 if (police->tcf_action == TC_ACT_SHOT)
265 police->tcf_qstats.drops++;
e9ce1cd3
DM
266 spin_unlock(&police->tcf_lock);
267 return police->tcf_action;
1da177e4
LT
268}
269
5a7a5555
JHS
270static int tcf_act_police_dump(struct sk_buff *skb, struct tc_action *a,
271 int bind, int ref)
1da177e4 272{
27a884dc 273 unsigned char *b = skb_tail_pointer(skb);
a85a970a 274 struct tcf_police *police = to_police(a);
0f04cfd0
JM
275 struct tc_police opt = {
276 .index = police->tcf_index,
277 .action = police->tcf_action,
278 .mtu = police->tcfp_mtu,
c6d14ff1 279 .burst = PSCHED_NS2TICKS(police->tcfp_burst),
036bb443
VB
280 .refcnt = refcount_read(&police->tcf_refcnt) - ref,
281 .bindcnt = atomic_read(&police->tcf_bindcnt) - bind,
0f04cfd0 282 };
3d3ed181 283 struct tcf_t t;
0f04cfd0 284
c6d14ff1 285 if (police->rate_present)
01cb71d2 286 psched_ratecfg_getrate(&opt.rate, &police->rate);
c6d14ff1 287 if (police->peak_present)
01cb71d2 288 psched_ratecfg_getrate(&opt.peakrate, &police->peak);
1b34ec43
DM
289 if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt))
290 goto nla_put_failure;
291 if (police->tcfp_result &&
292 nla_put_u32(skb, TCA_POLICE_RESULT, police->tcfp_result))
293 goto nla_put_failure;
294 if (police->tcfp_ewma_rate &&
295 nla_put_u32(skb, TCA_POLICE_AVRATE, police->tcfp_ewma_rate))
296 goto nla_put_failure;
3d3ed181
JHS
297
298 t.install = jiffies_to_clock_t(jiffies - police->tcf_tm.install);
299 t.lastuse = jiffies_to_clock_t(jiffies - police->tcf_tm.lastuse);
53eb440f 300 t.firstuse = jiffies_to_clock_t(jiffies - police->tcf_tm.firstuse);
3d3ed181
JHS
301 t.expires = jiffies_to_clock_t(police->tcf_tm.expires);
302 if (nla_put_64bit(skb, TCA_POLICE_TM, sizeof(t), &t, TCA_POLICE_PAD))
303 goto nla_put_failure;
304
1da177e4
LT
305 return skb->len;
306
7ba699c6 307nla_put_failure:
dc5fc579 308 nlmsg_trim(skb, b);
1da177e4
LT
309 return -1;
310}
311
331a9295
AA
312static int tcf_police_search(struct net *net, struct tc_action **a, u32 index,
313 struct netlink_ext_ack *extack)
ddf97ccd
WC
314{
315 struct tc_action_net *tn = net_generic(net, police_net_id);
316
65a206c0 317 return tcf_idr_search(tn, a, index);
ddf97ccd
WC
318}
319
b409074e
VB
320static int tcf_police_delete(struct net *net, u32 index)
321{
322 struct tc_action_net *tn = net_generic(net, police_net_id);
323
324 return tcf_idr_delete_index(tn, index);
325}
326
1da177e4
LT
327MODULE_AUTHOR("Alexey Kuznetsov");
328MODULE_DESCRIPTION("Policing actions");
329MODULE_LICENSE("GPL");
330
331static struct tc_action_ops act_police_ops = {
332 .kind = "police",
333 .type = TCA_ID_POLICE,
1da177e4
LT
334 .owner = THIS_MODULE,
335 .act = tcf_act_police,
336 .dump = tcf_act_police_dump,
d9fa17ef 337 .init = tcf_act_police_init,
ddf97ccd
WC
338 .walk = tcf_act_police_walker,
339 .lookup = tcf_police_search,
b409074e 340 .delete = tcf_police_delete,
a85a970a 341 .size = sizeof(struct tcf_police),
ddf97ccd
WC
342};
343
344static __net_init int police_init_net(struct net *net)
345{
346 struct tc_action_net *tn = net_generic(net, police_net_id);
347
c7e460ce 348 return tc_action_net_init(tn, &act_police_ops);
ddf97ccd
WC
349}
350
039af9c6 351static void __net_exit police_exit_net(struct list_head *net_list)
ddf97ccd 352{
039af9c6 353 tc_action_net_exit(net_list, police_net_id);
ddf97ccd
WC
354}
355
356static struct pernet_operations police_net_ops = {
357 .init = police_init_net,
039af9c6 358 .exit_batch = police_exit_net,
ddf97ccd
WC
359 .id = &police_net_id,
360 .size = sizeof(struct tc_action_net),
1da177e4
LT
361};
362
5a7a5555 363static int __init police_init_module(void)
1da177e4 364{
ddf97ccd 365 return tcf_register_action(&act_police_ops, &police_net_ops);
1da177e4
LT
366}
367
5a7a5555 368static void __exit police_cleanup_module(void)
1da177e4 369{
ddf97ccd 370 tcf_unregister_action(&act_police_ops, &police_net_ops);
1da177e4
LT
371}
372
373module_init(police_init_module);
374module_exit(police_cleanup_module);