]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/sched/act_police.c
crush: remove an obsolete comment
[mirror_ubuntu-bionic-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
e9ce1cd3 43#define POL_TAB_MASK 15
1da177e4 44
1e9b3d53 45/* old policer structure from before tc actions */
cc7ec456 46struct tc_police_compat {
1e9b3d53
PM
47 u32 index;
48 int action;
49 u32 limit;
50 u32 burst;
51 u32 mtu;
52 struct tc_ratespec rate;
53 struct tc_ratespec peakrate;
54};
55
e9ce1cd3 56/* Each policer is serialized by its individual spinlock */
1da177e4 57
c7d03a00 58static unsigned int police_net_id;
a85a970a 59static struct tc_action_ops act_police_ops;
ddf97ccd
WC
60
61static int tcf_act_police_walker(struct net *net, struct sk_buff *skb,
62 struct netlink_callback *cb, int type,
a85a970a 63 const struct tc_action_ops *ops)
1da177e4 64{
ddf97ccd 65 struct tc_action_net *tn = net_generic(net, police_net_id);
1da177e4 66
b5ac8518 67 return tcf_generic_walker(tn, skb, cb, type, ops);
1da177e4 68}
1da177e4 69
53b2bf3f
PM
70static const struct nla_policy police_policy[TCA_POLICE_MAX + 1] = {
71 [TCA_POLICE_RATE] = { .len = TC_RTAB_SIZE },
72 [TCA_POLICE_PEAKRATE] = { .len = TC_RTAB_SIZE },
73 [TCA_POLICE_AVRATE] = { .type = NLA_U32 },
74 [TCA_POLICE_RESULT] = { .type = NLA_U32 },
75};
76
d9fa17ef 77static int tcf_act_police_init(struct net *net, struct nlattr *nla,
a85a970a 78 struct nlattr *est, struct tc_action **a,
d9fa17ef 79 int ovr, int bind)
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]);
0852e455
WC
104 exists = tcf_hash_check(tn, parm->index, a, bind);
105 if (exists && bind)
106 return 0;
1da177e4 107
0852e455 108 if (!exists) {
a03e6fe5 109 ret = tcf_hash_create(tn, parm->index, NULL, a,
a85a970a 110 &act_police_ops, bind, false);
a03e6fe5
WC
111 if (ret)
112 return ret;
113 ret = ACT_P_CREATED;
0852e455
WC
114 } else {
115 tcf_hash_release(*a, bind);
116 if (!ovr)
117 return -EEXIST;
1da177e4
LT
118 }
119
a85a970a 120 police = to_police(*a);
1da177e4
LT
121 if (parm->rate.rate) {
122 err = -ENOMEM;
7ba699c6 123 R_tab = qdisc_get_rtab(&parm->rate, tb[TCA_POLICE_RATE]);
1da177e4
LT
124 if (R_tab == NULL)
125 goto failure;
c1b56878 126
1da177e4
LT
127 if (parm->peakrate.rate) {
128 P_tab = qdisc_get_rtab(&parm->peakrate,
7ba699c6 129 tb[TCA_POLICE_PEAKRATE]);
71bcb09a 130 if (P_tab == NULL)
1da177e4 131 goto failure;
1da177e4
LT
132 }
133 }
71bcb09a 134
71bcb09a 135 if (est) {
22e0f8b9 136 err = gen_replace_estimator(&police->tcf_bstats, NULL,
71bcb09a 137 &police->tcf_rate_est,
edb09eb1
ED
138 &police->tcf_lock,
139 NULL, est);
71bcb09a 140 if (err)
74030603 141 goto failure;
a883bf56
JP
142 } else if (tb[TCA_POLICE_AVRATE] &&
143 (ret == ACT_P_CREATED ||
1c0d32fd 144 !gen_estimator_active(&police->tcf_rate_est))) {
a883bf56 145 err = -EINVAL;
74030603 146 goto failure;
71bcb09a
SH
147 }
148
74030603 149 spin_lock_bh(&police->tcf_lock);
71bcb09a 150 /* No failure allowed after this point */
c6d14ff1
JP
151 police->tcfp_mtu = parm->mtu;
152 if (police->tcfp_mtu == 0) {
153 police->tcfp_mtu = ~0;
154 if (R_tab)
155 police->tcfp_mtu = 255 << R_tab->rate.cell_log;
156 }
157 if (R_tab) {
158 police->rate_present = true;
3e1e3aae 159 psched_ratecfg_precompute(&police->rate, &R_tab->rate, 0);
c6d14ff1
JP
160 qdisc_put_rtab(R_tab);
161 } else {
162 police->rate_present = false;
1da177e4 163 }
c6d14ff1
JP
164 if (P_tab) {
165 police->peak_present = true;
3e1e3aae 166 psched_ratecfg_precompute(&police->peak, &P_tab->rate, 0);
c6d14ff1
JP
167 qdisc_put_rtab(P_tab);
168 } else {
169 police->peak_present = false;
1da177e4
LT
170 }
171
7ba699c6 172 if (tb[TCA_POLICE_RESULT])
1587bac4 173 police->tcfp_result = nla_get_u32(tb[TCA_POLICE_RESULT]);
c6d14ff1
JP
174 police->tcfp_burst = PSCHED_TICKS2NS(parm->burst);
175 police->tcfp_toks = police->tcfp_burst;
176 if (police->peak_present) {
177 police->tcfp_mtu_ptoks = (s64) psched_l2t_ns(&police->peak,
178 police->tcfp_mtu);
179 police->tcfp_ptoks = police->tcfp_mtu_ptoks;
1da177e4 180 }
e9ce1cd3 181 police->tcf_action = parm->action;
1da177e4 182
7ba699c6 183 if (tb[TCA_POLICE_AVRATE])
1587bac4 184 police->tcfp_ewma_rate = nla_get_u32(tb[TCA_POLICE_AVRATE]);
1da177e4 185
e9ce1cd3 186 spin_unlock_bh(&police->tcf_lock);
1da177e4
LT
187 if (ret != ACT_P_CREATED)
188 return ret;
189
d2de875c 190 police->tcfp_t_c = ktime_get_ns();
a85a970a 191 tcf_hash_insert(tn, *a);
1da177e4 192
1da177e4
LT
193 return ret;
194
195failure:
3b69a4c9
YY
196 qdisc_put_rtab(P_tab);
197 qdisc_put_rtab(R_tab);
1da177e4 198 if (ret == ACT_P_CREATED)
a85a970a 199 tcf_hash_cleanup(*a, est);
1da177e4
LT
200 return err;
201}
202
dc7f9f6e 203static int tcf_act_police(struct sk_buff *skb, const struct tc_action *a,
10297b99 204 struct tcf_result *res)
1da177e4 205{
a85a970a 206 struct tcf_police *police = to_police(a);
c6d14ff1
JP
207 s64 now;
208 s64 toks;
209 s64 ptoks = 0;
1da177e4 210
e9ce1cd3 211 spin_lock(&police->tcf_lock);
1da177e4 212
bfe0d029 213 bstats_update(&police->tcf_bstats, skb);
3d3ed181 214 tcf_lastuse_update(&police->tcf_tm);
1da177e4 215
1c0d32fd
ED
216 if (police->tcfp_ewma_rate) {
217 struct gnet_stats_rate_est64 sample;
218
219 if (!gen_estimator_read(&police->tcf_rate_est, &sample) ||
220 sample.bps >= police->tcfp_ewma_rate) {
221 police->tcf_qstats.overlimits++;
222 if (police->tcf_action == TC_ACT_SHOT)
223 police->tcf_qstats.drops++;
224 spin_unlock(&police->tcf_lock);
225 return police->tcf_action;
226 }
1da177e4 227 }
1da177e4 228
0abf77e5 229 if (qdisc_pkt_len(skb) <= police->tcfp_mtu) {
c6d14ff1 230 if (!police->rate_present) {
e9ce1cd3
DM
231 spin_unlock(&police->tcf_lock);
232 return police->tcfp_result;
1da177e4
LT
233 }
234
d2de875c 235 now = ktime_get_ns();
c6d14ff1
JP
236 toks = min_t(s64, now - police->tcfp_t_c,
237 police->tcfp_burst);
238 if (police->peak_present) {
e9ce1cd3 239 ptoks = toks + police->tcfp_ptoks;
c6d14ff1
JP
240 if (ptoks > police->tcfp_mtu_ptoks)
241 ptoks = police->tcfp_mtu_ptoks;
242 ptoks -= (s64) psched_l2t_ns(&police->peak,
243 qdisc_pkt_len(skb));
1da177e4 244 }
e9ce1cd3 245 toks += police->tcfp_toks;
c6d14ff1 246 if (toks > police->tcfp_burst)
e9ce1cd3 247 toks = police->tcfp_burst;
c6d14ff1 248 toks -= (s64) psched_l2t_ns(&police->rate, qdisc_pkt_len(skb));
1da177e4 249 if ((toks|ptoks) >= 0) {
e9ce1cd3
DM
250 police->tcfp_t_c = now;
251 police->tcfp_toks = toks;
252 police->tcfp_ptoks = ptoks;
f71b109f
RM
253 if (police->tcfp_result == TC_ACT_SHOT)
254 police->tcf_qstats.drops++;
e9ce1cd3
DM
255 spin_unlock(&police->tcf_lock);
256 return police->tcfp_result;
1da177e4
LT
257 }
258 }
259
e9ce1cd3 260 police->tcf_qstats.overlimits++;
b9647580
JP
261 if (police->tcf_action == TC_ACT_SHOT)
262 police->tcf_qstats.drops++;
e9ce1cd3
DM
263 spin_unlock(&police->tcf_lock);
264 return police->tcf_action;
1da177e4
LT
265}
266
5a7a5555
JHS
267static int tcf_act_police_dump(struct sk_buff *skb, struct tc_action *a,
268 int bind, int ref)
1da177e4 269{
27a884dc 270 unsigned char *b = skb_tail_pointer(skb);
a85a970a 271 struct tcf_police *police = to_police(a);
0f04cfd0
JM
272 struct tc_police opt = {
273 .index = police->tcf_index,
274 .action = police->tcf_action,
275 .mtu = police->tcfp_mtu,
c6d14ff1 276 .burst = PSCHED_NS2TICKS(police->tcfp_burst),
0f04cfd0
JM
277 .refcnt = police->tcf_refcnt - ref,
278 .bindcnt = police->tcf_bindcnt - bind,
279 };
3d3ed181 280 struct tcf_t t;
0f04cfd0 281
c6d14ff1 282 if (police->rate_present)
01cb71d2 283 psched_ratecfg_getrate(&opt.rate, &police->rate);
c6d14ff1 284 if (police->peak_present)
01cb71d2 285 psched_ratecfg_getrate(&opt.peakrate, &police->peak);
1b34ec43
DM
286 if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt))
287 goto nla_put_failure;
288 if (police->tcfp_result &&
289 nla_put_u32(skb, TCA_POLICE_RESULT, police->tcfp_result))
290 goto nla_put_failure;
291 if (police->tcfp_ewma_rate &&
292 nla_put_u32(skb, TCA_POLICE_AVRATE, police->tcfp_ewma_rate))
293 goto nla_put_failure;
3d3ed181
JHS
294
295 t.install = jiffies_to_clock_t(jiffies - police->tcf_tm.install);
296 t.lastuse = jiffies_to_clock_t(jiffies - police->tcf_tm.lastuse);
53eb440f 297 t.firstuse = jiffies_to_clock_t(jiffies - police->tcf_tm.firstuse);
3d3ed181
JHS
298 t.expires = jiffies_to_clock_t(police->tcf_tm.expires);
299 if (nla_put_64bit(skb, TCA_POLICE_TM, sizeof(t), &t, TCA_POLICE_PAD))
300 goto nla_put_failure;
301
1da177e4
LT
302 return skb->len;
303
7ba699c6 304nla_put_failure:
dc5fc579 305 nlmsg_trim(skb, b);
1da177e4
LT
306 return -1;
307}
308
a85a970a 309static int tcf_police_search(struct net *net, struct tc_action **a, u32 index)
ddf97ccd
WC
310{
311 struct tc_action_net *tn = net_generic(net, police_net_id);
312
313 return tcf_hash_search(tn, a, index);
314}
315
1da177e4
LT
316MODULE_AUTHOR("Alexey Kuznetsov");
317MODULE_DESCRIPTION("Policing actions");
318MODULE_LICENSE("GPL");
319
320static struct tc_action_ops act_police_ops = {
321 .kind = "police",
322 .type = TCA_ID_POLICE,
1da177e4
LT
323 .owner = THIS_MODULE,
324 .act = tcf_act_police,
325 .dump = tcf_act_police_dump,
d9fa17ef 326 .init = tcf_act_police_init,
ddf97ccd
WC
327 .walk = tcf_act_police_walker,
328 .lookup = tcf_police_search,
a85a970a 329 .size = sizeof(struct tcf_police),
ddf97ccd
WC
330};
331
332static __net_init int police_init_net(struct net *net)
333{
334 struct tc_action_net *tn = net_generic(net, police_net_id);
335
336 return tc_action_net_init(tn, &act_police_ops, POL_TAB_MASK);
337}
338
339static void __net_exit police_exit_net(struct net *net)
340{
341 struct tc_action_net *tn = net_generic(net, police_net_id);
342
343 tc_action_net_exit(tn);
344}
345
346static struct pernet_operations police_net_ops = {
347 .init = police_init_net,
348 .exit = police_exit_net,
349 .id = &police_net_id,
350 .size = sizeof(struct tc_action_net),
1da177e4
LT
351};
352
5a7a5555 353static int __init police_init_module(void)
1da177e4 354{
ddf97ccd 355 return tcf_register_action(&act_police_ops, &police_net_ops);
1da177e4
LT
356}
357
5a7a5555 358static void __exit police_cleanup_module(void)
1da177e4 359{
ddf97ccd 360 tcf_unregister_action(&act_police_ops, &police_net_ops);
1da177e4
LT
361}
362
363module_init(police_init_module);
364module_exit(police_cleanup_module);