]>
Commit | Line | Data |
---|---|---|
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, <[email protected]> |
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 | 25 | static unsigned int police_net_id; |
a85a970a | 26 | static struct tc_action_ops act_police_ops; |
ddf97ccd | 27 | |
2ac06347 | 28 | static 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 |
38 | static 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 | 47 | static 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, |
abbb0d33 | 50 | struct tcf_proto *tp, u32 flags, |
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, |
e3822678 | 90 | &act_police_ops, bind, true, 0); |
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); |
445d3749 PM |
194 | new = rcu_replace_pointer(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 | |
1da177e4 LT |
204 | return ret; |
205 | ||
206 | failure: | |
3b69a4c9 YY |
207 | qdisc_put_rtab(P_tab); |
208 | qdisc_put_rtab(R_tab); | |
d6124d6b DC |
209 | if (goto_ch) |
210 | tcf_chain_put_by_act(goto_ch); | |
211 | release_idr: | |
4e8ddd7f | 212 | tcf_idr_release(*a, bind); |
1da177e4 LT |
213 | return err; |
214 | } | |
215 | ||
2ac06347 | 216 | static int tcf_police_act(struct sk_buff *skb, const struct tc_action *a, |
10297b99 | 217 | struct tcf_result *res) |
1da177e4 | 218 | { |
a85a970a | 219 | struct tcf_police *police = to_police(a); |
2d550dba | 220 | struct tcf_police_params *p; |
93be42f9 DC |
221 | s64 now, toks, ptoks = 0; |
222 | int ret; | |
1da177e4 | 223 | |
3d3ed181 | 224 | tcf_lastuse_update(&police->tcf_tm); |
93be42f9 | 225 | bstats_cpu_update(this_cpu_ptr(police->common.cpu_bstats), skb); |
1da177e4 | 226 | |
2d550dba DC |
227 | ret = READ_ONCE(police->tcf_action); |
228 | p = rcu_dereference_bh(police->params); | |
229 | ||
230 | if (p->tcfp_ewma_rate) { | |
1c0d32fd ED |
231 | struct gnet_stats_rate_est64 sample; |
232 | ||
233 | if (!gen_estimator_read(&police->tcf_rate_est, &sample) || | |
2d550dba | 234 | sample.bps >= p->tcfp_ewma_rate) |
93be42f9 | 235 | goto inc_overlimits; |
1da177e4 | 236 | } |
1da177e4 | 237 | |
2d550dba DC |
238 | if (qdisc_pkt_len(skb) <= p->tcfp_mtu) { |
239 | if (!p->rate_present) { | |
240 | ret = p->tcfp_result; | |
241 | goto end; | |
1da177e4 LT |
242 | } |
243 | ||
d2de875c | 244 | now = ktime_get_ns(); |
f2cbd485 DC |
245 | spin_lock_bh(&police->tcfp_lock); |
246 | toks = min_t(s64, now - police->tcfp_t_c, p->tcfp_burst); | |
2d550dba | 247 | if (p->peak_present) { |
f2cbd485 | 248 | ptoks = toks + police->tcfp_ptoks; |
2d550dba DC |
249 | if (ptoks > p->tcfp_mtu_ptoks) |
250 | ptoks = p->tcfp_mtu_ptoks; | |
251 | ptoks -= (s64)psched_l2t_ns(&p->peak, | |
252 | qdisc_pkt_len(skb)); | |
1da177e4 | 253 | } |
f2cbd485 | 254 | toks += police->tcfp_toks; |
2d550dba DC |
255 | if (toks > p->tcfp_burst) |
256 | toks = p->tcfp_burst; | |
257 | toks -= (s64)psched_l2t_ns(&p->rate, qdisc_pkt_len(skb)); | |
1da177e4 | 258 | if ((toks|ptoks) >= 0) { |
f2cbd485 DC |
259 | police->tcfp_t_c = now; |
260 | police->tcfp_toks = toks; | |
261 | police->tcfp_ptoks = ptoks; | |
262 | spin_unlock_bh(&police->tcfp_lock); | |
2d550dba | 263 | ret = p->tcfp_result; |
93be42f9 | 264 | goto inc_drops; |
1da177e4 | 265 | } |
f2cbd485 | 266 | spin_unlock_bh(&police->tcfp_lock); |
1da177e4 | 267 | } |
93be42f9 DC |
268 | |
269 | inc_overlimits: | |
270 | qstats_overlimit_inc(this_cpu_ptr(police->common.cpu_qstats)); | |
271 | inc_drops: | |
272 | if (ret == TC_ACT_SHOT) | |
273 | qstats_drop_inc(this_cpu_ptr(police->common.cpu_qstats)); | |
2d550dba | 274 | end: |
93be42f9 | 275 | return ret; |
1da177e4 LT |
276 | } |
277 | ||
2d550dba DC |
278 | static void tcf_police_cleanup(struct tc_action *a) |
279 | { | |
280 | struct tcf_police *police = to_police(a); | |
281 | struct tcf_police_params *p; | |
282 | ||
283 | p = rcu_dereference_protected(police->params, 1); | |
284 | if (p) | |
285 | kfree_rcu(p, rcu); | |
286 | } | |
287 | ||
12f02b6b | 288 | static void tcf_police_stats_update(struct tc_action *a, |
4b61d3e8 | 289 | u64 bytes, u64 packets, u64 drops, |
12f02b6b PJV |
290 | u64 lastuse, bool hw) |
291 | { | |
292 | struct tcf_police *police = to_police(a); | |
293 | struct tcf_t *tm = &police->tcf_tm; | |
294 | ||
4b61d3e8 | 295 | tcf_action_update_stats(a, bytes, packets, drops, hw); |
12f02b6b PJV |
296 | tm->lastuse = max_t(u64, tm->lastuse, lastuse); |
297 | } | |
298 | ||
2ac06347 | 299 | static int tcf_police_dump(struct sk_buff *skb, struct tc_action *a, |
5a7a5555 | 300 | int bind, int ref) |
1da177e4 | 301 | { |
27a884dc | 302 | unsigned char *b = skb_tail_pointer(skb); |
a85a970a | 303 | struct tcf_police *police = to_police(a); |
2d550dba | 304 | struct tcf_police_params *p; |
0f04cfd0 JM |
305 | struct tc_police opt = { |
306 | .index = police->tcf_index, | |
036bb443 VB |
307 | .refcnt = refcount_read(&police->tcf_refcnt) - ref, |
308 | .bindcnt = atomic_read(&police->tcf_bindcnt) - bind, | |
0f04cfd0 | 309 | }; |
3d3ed181 | 310 | struct tcf_t t; |
0f04cfd0 | 311 | |
e329bc42 VB |
312 | spin_lock_bh(&police->tcf_lock); |
313 | opt.action = police->tcf_action; | |
2d550dba DC |
314 | p = rcu_dereference_protected(police->params, |
315 | lockdep_is_held(&police->tcf_lock)); | |
316 | opt.mtu = p->tcfp_mtu; | |
317 | opt.burst = PSCHED_NS2TICKS(p->tcfp_burst); | |
d1967e49 | 318 | if (p->rate_present) { |
2d550dba | 319 | psched_ratecfg_getrate(&opt.rate, &p->rate); |
d1967e49 DD |
320 | if ((police->params->rate.rate_bytes_ps >= (1ULL << 32)) && |
321 | nla_put_u64_64bit(skb, TCA_POLICE_RATE64, | |
322 | police->params->rate.rate_bytes_ps, | |
323 | TCA_POLICE_PAD)) | |
324 | goto nla_put_failure; | |
325 | } | |
326 | if (p->peak_present) { | |
2d550dba | 327 | psched_ratecfg_getrate(&opt.peakrate, &p->peak); |
d1967e49 DD |
328 | if ((police->params->peak.rate_bytes_ps >= (1ULL << 32)) && |
329 | nla_put_u64_64bit(skb, TCA_POLICE_PEAKRATE64, | |
330 | police->params->peak.rate_bytes_ps, | |
331 | TCA_POLICE_PAD)) | |
332 | goto nla_put_failure; | |
333 | } | |
1b34ec43 DM |
334 | if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt)) |
335 | goto nla_put_failure; | |
2d550dba DC |
336 | if (p->tcfp_result && |
337 | nla_put_u32(skb, TCA_POLICE_RESULT, p->tcfp_result)) | |
1b34ec43 | 338 | goto nla_put_failure; |
2d550dba DC |
339 | if (p->tcfp_ewma_rate && |
340 | nla_put_u32(skb, TCA_POLICE_AVRATE, p->tcfp_ewma_rate)) | |
1b34ec43 | 341 | goto nla_put_failure; |
3d3ed181 | 342 | |
985fd98a | 343 | tcf_tm_dump(&t, &police->tcf_tm); |
3d3ed181 JHS |
344 | if (nla_put_64bit(skb, TCA_POLICE_TM, sizeof(t), &t, TCA_POLICE_PAD)) |
345 | goto nla_put_failure; | |
e329bc42 | 346 | spin_unlock_bh(&police->tcf_lock); |
3d3ed181 | 347 | |
1da177e4 LT |
348 | return skb->len; |
349 | ||
7ba699c6 | 350 | nla_put_failure: |
e329bc42 | 351 | spin_unlock_bh(&police->tcf_lock); |
dc5fc579 | 352 | nlmsg_trim(skb, b); |
1da177e4 LT |
353 | return -1; |
354 | } | |
355 | ||
f061b48c | 356 | static int tcf_police_search(struct net *net, struct tc_action **a, u32 index) |
ddf97ccd WC |
357 | { |
358 | struct tc_action_net *tn = net_generic(net, police_net_id); | |
359 | ||
65a206c0 | 360 | return tcf_idr_search(tn, a, index); |
ddf97ccd WC |
361 | } |
362 | ||
1da177e4 LT |
363 | MODULE_AUTHOR("Alexey Kuznetsov"); |
364 | MODULE_DESCRIPTION("Policing actions"); | |
365 | MODULE_LICENSE("GPL"); | |
366 | ||
367 | static struct tc_action_ops act_police_ops = { | |
368 | .kind = "police", | |
eddd2cf1 | 369 | .id = TCA_ID_POLICE, |
1da177e4 | 370 | .owner = THIS_MODULE, |
12f02b6b | 371 | .stats_update = tcf_police_stats_update, |
2ac06347 JHS |
372 | .act = tcf_police_act, |
373 | .dump = tcf_police_dump, | |
374 | .init = tcf_police_init, | |
375 | .walk = tcf_police_walker, | |
ddf97ccd | 376 | .lookup = tcf_police_search, |
2d550dba | 377 | .cleanup = tcf_police_cleanup, |
a85a970a | 378 | .size = sizeof(struct tcf_police), |
ddf97ccd WC |
379 | }; |
380 | ||
381 | static __net_init int police_init_net(struct net *net) | |
382 | { | |
383 | struct tc_action_net *tn = net_generic(net, police_net_id); | |
384 | ||
981471bd | 385 | return tc_action_net_init(net, tn, &act_police_ops); |
ddf97ccd WC |
386 | } |
387 | ||
039af9c6 | 388 | static void __net_exit police_exit_net(struct list_head *net_list) |
ddf97ccd | 389 | { |
039af9c6 | 390 | tc_action_net_exit(net_list, police_net_id); |
ddf97ccd WC |
391 | } |
392 | ||
393 | static struct pernet_operations police_net_ops = { | |
394 | .init = police_init_net, | |
039af9c6 | 395 | .exit_batch = police_exit_net, |
ddf97ccd WC |
396 | .id = &police_net_id, |
397 | .size = sizeof(struct tc_action_net), | |
1da177e4 LT |
398 | }; |
399 | ||
5a7a5555 | 400 | static int __init police_init_module(void) |
1da177e4 | 401 | { |
ddf97ccd | 402 | return tcf_register_action(&act_police_ops, &police_net_ops); |
1da177e4 LT |
403 | } |
404 | ||
5a7a5555 | 405 | static void __exit police_cleanup_module(void) |
1da177e4 | 406 | { |
ddf97ccd | 407 | tcf_unregister_action(&act_police_ops, &police_net_ops); |
1da177e4 LT |
408 | } |
409 | ||
410 | module_init(police_init_module); | |
411 | module_exit(police_cleanup_module); |