2 * net/sched/act_police.c Input police filter
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.
9 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
10 * J Hadi Salim (action changes)
13 #include <linux/module.h>
14 #include <linux/types.h>
15 #include <linux/kernel.h>
16 #include <linux/string.h>
17 #include <linux/errno.h>
18 #include <linux/skbuff.h>
19 #include <linux/rtnetlink.h>
20 #include <linux/init.h>
21 #include <linux/slab.h>
22 #include <net/act_api.h>
23 #include <net/netlink.h>
25 struct tcf_police_params
{
31 struct psched_ratecfg rate
;
33 struct psched_ratecfg peak
;
39 struct tc_action common
;
40 struct tcf_police_params __rcu
*params
;
42 spinlock_t tcfp_lock ____cacheline_aligned_in_smp
;
48 #define to_police(pc) ((struct tcf_police *)pc)
50 /* old policer structure from before tc actions */
51 struct tc_police_compat
{
57 struct tc_ratespec rate
;
58 struct tc_ratespec peakrate
;
61 /* Each policer is serialized by its individual spinlock */
63 static unsigned int police_net_id
;
64 static struct tc_action_ops act_police_ops
;
66 static int tcf_police_walker(struct net
*net
, struct sk_buff
*skb
,
67 struct netlink_callback
*cb
, int type
,
68 const struct tc_action_ops
*ops
,
69 struct netlink_ext_ack
*extack
)
71 struct tc_action_net
*tn
= net_generic(net
, police_net_id
);
73 return tcf_generic_walker(tn
, skb
, cb
, type
, ops
, extack
);
76 static const struct nla_policy police_policy
[TCA_POLICE_MAX
+ 1] = {
77 [TCA_POLICE_RATE
] = { .len
= TC_RTAB_SIZE
},
78 [TCA_POLICE_PEAKRATE
] = { .len
= TC_RTAB_SIZE
},
79 [TCA_POLICE_AVRATE
] = { .type
= NLA_U32
},
80 [TCA_POLICE_RESULT
] = { .type
= NLA_U32
},
83 static int tcf_police_init(struct net
*net
, struct nlattr
*nla
,
84 struct nlattr
*est
, struct tc_action
**a
,
85 int ovr
, int bind
, bool rtnl_held
,
86 struct netlink_ext_ack
*extack
)
88 int ret
= 0, tcfp_result
= TC_ACT_OK
, err
, size
;
89 struct nlattr
*tb
[TCA_POLICE_MAX
+ 1];
90 struct tc_police
*parm
;
91 struct tcf_police
*police
;
92 struct qdisc_rate_table
*R_tab
= NULL
, *P_tab
= NULL
;
93 struct tc_action_net
*tn
= net_generic(net
, police_net_id
);
94 struct tcf_police_params
*new;
100 err
= nla_parse_nested(tb
, TCA_POLICE_MAX
, nla
, police_policy
, NULL
);
104 if (tb
[TCA_POLICE_TBF
] == NULL
)
106 size
= nla_len(tb
[TCA_POLICE_TBF
]);
107 if (size
!= sizeof(*parm
) && size
!= sizeof(struct tc_police_compat
))
110 parm
= nla_data(tb
[TCA_POLICE_TBF
]);
111 err
= tcf_idr_check_alloc(tn
, &parm
->index
, a
, bind
);
119 ret
= tcf_idr_create(tn
, parm
->index
, NULL
, a
,
120 &act_police_ops
, bind
, true);
122 tcf_idr_cleanup(tn
, parm
->index
);
126 spin_lock_init(&(to_police(*a
)->tcfp_lock
));
128 tcf_idr_release(*a
, bind
);
132 police
= to_police(*a
);
133 if (parm
->rate
.rate
) {
135 R_tab
= qdisc_get_rtab(&parm
->rate
, tb
[TCA_POLICE_RATE
], NULL
);
139 if (parm
->peakrate
.rate
) {
140 P_tab
= qdisc_get_rtab(&parm
->peakrate
,
141 tb
[TCA_POLICE_PEAKRATE
], NULL
);
148 err
= gen_replace_estimator(&police
->tcf_bstats
,
149 police
->common
.cpu_bstats
,
150 &police
->tcf_rate_est
,
155 } else if (tb
[TCA_POLICE_AVRATE
] &&
156 (ret
== ACT_P_CREATED
||
157 !gen_estimator_active(&police
->tcf_rate_est
))) {
162 if (tb
[TCA_POLICE_RESULT
]) {
163 tcfp_result
= nla_get_u32(tb
[TCA_POLICE_RESULT
]);
164 if (TC_ACT_EXT_CMP(tcfp_result
, TC_ACT_GOTO_CHAIN
)) {
165 NL_SET_ERR_MSG(extack
,
166 "goto chain not allowed on fallback");
172 new = kzalloc(sizeof(*new), GFP_KERNEL
);
173 if (unlikely(!new)) {
178 /* No failure allowed after this point */
179 new->tcfp_result
= tcfp_result
;
180 new->tcfp_mtu
= parm
->mtu
;
181 if (!new->tcfp_mtu
) {
184 new->tcfp_mtu
= 255 << R_tab
->rate
.cell_log
;
187 new->rate_present
= true;
188 psched_ratecfg_precompute(&new->rate
, &R_tab
->rate
, 0);
189 qdisc_put_rtab(R_tab
);
191 new->rate_present
= false;
194 new->peak_present
= true;
195 psched_ratecfg_precompute(&new->peak
, &P_tab
->rate
, 0);
196 qdisc_put_rtab(P_tab
);
198 new->peak_present
= false;
201 new->tcfp_burst
= PSCHED_TICKS2NS(parm
->burst
);
202 if (new->peak_present
)
203 new->tcfp_mtu_ptoks
= (s64
)psched_l2t_ns(&new->peak
,
206 if (tb
[TCA_POLICE_AVRATE
])
207 new->tcfp_ewma_rate
= nla_get_u32(tb
[TCA_POLICE_AVRATE
]);
209 spin_lock_bh(&police
->tcf_lock
);
210 spin_lock_bh(&police
->tcfp_lock
);
211 police
->tcfp_t_c
= ktime_get_ns();
212 police
->tcfp_toks
= new->tcfp_burst
;
213 if (new->peak_present
)
214 police
->tcfp_ptoks
= new->tcfp_mtu_ptoks
;
215 spin_unlock_bh(&police
->tcfp_lock
);
216 police
->tcf_action
= parm
->action
;
217 rcu_swap_protected(police
->params
,
219 lockdep_is_held(&police
->tcf_lock
));
220 spin_unlock_bh(&police
->tcf_lock
);
225 if (ret
== ACT_P_CREATED
)
226 tcf_idr_insert(tn
, *a
);
230 qdisc_put_rtab(P_tab
);
231 qdisc_put_rtab(R_tab
);
232 tcf_idr_release(*a
, bind
);
236 static int tcf_police_act(struct sk_buff
*skb
, const struct tc_action
*a
,
237 struct tcf_result
*res
)
239 struct tcf_police
*police
= to_police(a
);
240 struct tcf_police_params
*p
;
241 s64 now
, toks
, ptoks
= 0;
244 tcf_lastuse_update(&police
->tcf_tm
);
245 bstats_cpu_update(this_cpu_ptr(police
->common
.cpu_bstats
), skb
);
247 ret
= READ_ONCE(police
->tcf_action
);
248 p
= rcu_dereference_bh(police
->params
);
250 if (p
->tcfp_ewma_rate
) {
251 struct gnet_stats_rate_est64 sample
;
253 if (!gen_estimator_read(&police
->tcf_rate_est
, &sample
) ||
254 sample
.bps
>= p
->tcfp_ewma_rate
)
258 if (qdisc_pkt_len(skb
) <= p
->tcfp_mtu
) {
259 if (!p
->rate_present
) {
260 ret
= p
->tcfp_result
;
264 now
= ktime_get_ns();
265 spin_lock_bh(&police
->tcfp_lock
);
266 toks
= min_t(s64
, now
- police
->tcfp_t_c
, p
->tcfp_burst
);
267 if (p
->peak_present
) {
268 ptoks
= toks
+ police
->tcfp_ptoks
;
269 if (ptoks
> p
->tcfp_mtu_ptoks
)
270 ptoks
= p
->tcfp_mtu_ptoks
;
271 ptoks
-= (s64
)psched_l2t_ns(&p
->peak
,
274 toks
+= police
->tcfp_toks
;
275 if (toks
> p
->tcfp_burst
)
276 toks
= p
->tcfp_burst
;
277 toks
-= (s64
)psched_l2t_ns(&p
->rate
, qdisc_pkt_len(skb
));
278 if ((toks
|ptoks
) >= 0) {
279 police
->tcfp_t_c
= now
;
280 police
->tcfp_toks
= toks
;
281 police
->tcfp_ptoks
= ptoks
;
282 spin_unlock_bh(&police
->tcfp_lock
);
283 ret
= p
->tcfp_result
;
286 spin_unlock_bh(&police
->tcfp_lock
);
290 qstats_overlimit_inc(this_cpu_ptr(police
->common
.cpu_qstats
));
292 if (ret
== TC_ACT_SHOT
)
293 qstats_drop_inc(this_cpu_ptr(police
->common
.cpu_qstats
));
298 static void tcf_police_cleanup(struct tc_action
*a
)
300 struct tcf_police
*police
= to_police(a
);
301 struct tcf_police_params
*p
;
303 p
= rcu_dereference_protected(police
->params
, 1);
308 static int tcf_police_dump(struct sk_buff
*skb
, struct tc_action
*a
,
311 unsigned char *b
= skb_tail_pointer(skb
);
312 struct tcf_police
*police
= to_police(a
);
313 struct tcf_police_params
*p
;
314 struct tc_police opt
= {
315 .index
= police
->tcf_index
,
316 .refcnt
= refcount_read(&police
->tcf_refcnt
) - ref
,
317 .bindcnt
= atomic_read(&police
->tcf_bindcnt
) - bind
,
321 spin_lock_bh(&police
->tcf_lock
);
322 opt
.action
= police
->tcf_action
;
323 p
= rcu_dereference_protected(police
->params
,
324 lockdep_is_held(&police
->tcf_lock
));
325 opt
.mtu
= p
->tcfp_mtu
;
326 opt
.burst
= PSCHED_NS2TICKS(p
->tcfp_burst
);
328 psched_ratecfg_getrate(&opt
.rate
, &p
->rate
);
330 psched_ratecfg_getrate(&opt
.peakrate
, &p
->peak
);
331 if (nla_put(skb
, TCA_POLICE_TBF
, sizeof(opt
), &opt
))
332 goto nla_put_failure
;
333 if (p
->tcfp_result
&&
334 nla_put_u32(skb
, TCA_POLICE_RESULT
, p
->tcfp_result
))
335 goto nla_put_failure
;
336 if (p
->tcfp_ewma_rate
&&
337 nla_put_u32(skb
, TCA_POLICE_AVRATE
, p
->tcfp_ewma_rate
))
338 goto nla_put_failure
;
340 t
.install
= jiffies_to_clock_t(jiffies
- police
->tcf_tm
.install
);
341 t
.lastuse
= jiffies_to_clock_t(jiffies
- police
->tcf_tm
.lastuse
);
342 t
.firstuse
= jiffies_to_clock_t(jiffies
- police
->tcf_tm
.firstuse
);
343 t
.expires
= jiffies_to_clock_t(police
->tcf_tm
.expires
);
344 if (nla_put_64bit(skb
, TCA_POLICE_TM
, sizeof(t
), &t
, TCA_POLICE_PAD
))
345 goto nla_put_failure
;
346 spin_unlock_bh(&police
->tcf_lock
);
351 spin_unlock_bh(&police
->tcf_lock
);
356 static int tcf_police_search(struct net
*net
, struct tc_action
**a
, u32 index
)
358 struct tc_action_net
*tn
= net_generic(net
, police_net_id
);
360 return tcf_idr_search(tn
, a
, index
);
363 MODULE_AUTHOR("Alexey Kuznetsov");
364 MODULE_DESCRIPTION("Policing actions");
365 MODULE_LICENSE("GPL");
367 static struct tc_action_ops act_police_ops
= {
369 .type
= TCA_ID_POLICE
,
370 .owner
= THIS_MODULE
,
371 .act
= tcf_police_act
,
372 .dump
= tcf_police_dump
,
373 .init
= tcf_police_init
,
374 .walk
= tcf_police_walker
,
375 .lookup
= tcf_police_search
,
376 .cleanup
= tcf_police_cleanup
,
377 .size
= sizeof(struct tcf_police
),
380 static __net_init
int police_init_net(struct net
*net
)
382 struct tc_action_net
*tn
= net_generic(net
, police_net_id
);
384 return tc_action_net_init(tn
, &act_police_ops
);
387 static void __net_exit
police_exit_net(struct list_head
*net_list
)
389 tc_action_net_exit(net_list
, police_net_id
);
392 static struct pernet_operations police_net_ops
= {
393 .init
= police_init_net
,
394 .exit_batch
= police_exit_net
,
395 .id
= &police_net_id
,
396 .size
= sizeof(struct tc_action_net
),
399 static int __init
police_init_module(void)
401 return tcf_register_action(&act_police_ops
, &police_net_ops
);
404 static void __exit
police_cleanup_module(void)
406 tcf_unregister_action(&act_police_ops
, &police_net_ops
);
409 module_init(police_init_module
);
410 module_exit(police_cleanup_module
);