2 * net/sched/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 #define L2T(p, L) qdisc_l2t((p)->tcfp_R_tab, L)
26 #define L2T_P(p, L) qdisc_l2t((p)->tcfp_P_tab, L)
28 #define POL_TAB_MASK 15
29 static struct tcf_common *tcf_police_ht[POL_TAB_MASK + 1];
30 static u32 police_idx_gen;
31 static DEFINE_RWLOCK(police_lock);
33 static struct tcf_hashinfo police_hash_info = {
34 .htab = tcf_police_ht,
35 .hmask = POL_TAB_MASK,
39 /* old policer structure from before tc actions */
40 struct tc_police_compat {
46 struct tc_ratespec rate;
47 struct tc_ratespec peakrate;
50 /* Each policer is serialized by its individual spinlock */
52 static int tcf_act_police_walker(struct sk_buff *skb, struct netlink_callback *cb,
53 int type, struct tc_action *a)
56 int err = 0, index = -1, i = 0, s_i = 0, n_i = 0;
59 read_lock_bh(&police_lock);
63 for (i = 0; i < (POL_TAB_MASK + 1); i++) {
64 p = tcf_police_ht[tcf_hash(i, POL_TAB_MASK)];
66 for (; p; p = p->tcfc_next) {
72 nest = nla_nest_start(skb, a->order);
75 if (type == RTM_DELACTION)
76 err = tcf_action_dump_1(skb, a, 0, 1);
78 err = tcf_action_dump_1(skb, a, 0, 0);
81 nla_nest_cancel(skb, nest);
84 nla_nest_end(skb, nest);
89 read_unlock_bh(&police_lock);
95 nla_nest_cancel(skb, nest);
99 static void tcf_police_destroy(struct tcf_police *p)
101 unsigned int h = tcf_hash(p->tcf_index, POL_TAB_MASK);
102 struct tcf_common **p1p;
104 for (p1p = &tcf_police_ht[h]; *p1p; p1p = &(*p1p)->tcfc_next) {
105 if (*p1p == &p->common) {
106 write_lock_bh(&police_lock);
108 write_unlock_bh(&police_lock);
109 gen_kill_estimator(&p->tcf_bstats,
112 qdisc_put_rtab(p->tcfp_R_tab);
114 qdisc_put_rtab(p->tcfp_P_tab);
116 * gen_estimator est_timer() might access p->tcf_lock
117 * or bstats, wait a RCU grace period before freeing p
119 kfree_rcu(p, tcf_rcu);
126 static const struct nla_policy police_policy[TCA_POLICE_MAX + 1] = {
127 [TCA_POLICE_RATE] = { .len = TC_RTAB_SIZE },
128 [TCA_POLICE_PEAKRATE] = { .len = TC_RTAB_SIZE },
129 [TCA_POLICE_AVRATE] = { .type = NLA_U32 },
130 [TCA_POLICE_RESULT] = { .type = NLA_U32 },
133 static int tcf_act_police_locate(struct net *net, struct nlattr *nla,
134 struct nlattr *est, struct tc_action *a,
139 struct nlattr *tb[TCA_POLICE_MAX + 1];
140 struct tc_police *parm;
141 struct tcf_police *police;
142 struct qdisc_rate_table *R_tab = NULL, *P_tab = NULL;
148 err = nla_parse_nested(tb, TCA_POLICE_MAX, nla, police_policy);
152 if (tb[TCA_POLICE_TBF] == NULL)
154 size = nla_len(tb[TCA_POLICE_TBF]);
155 if (size != sizeof(*parm) && size != sizeof(struct tc_police_compat))
157 parm = nla_data(tb[TCA_POLICE_TBF]);
160 struct tcf_common *pc;
162 pc = tcf_hash_lookup(parm->index, &police_hash_info);
165 police = to_police(pc);
167 police->tcf_bindcnt += 1;
168 police->tcf_refcnt += 1;
176 police = kzalloc(sizeof(*police), GFP_KERNEL);
180 police->tcf_refcnt = 1;
181 spin_lock_init(&police->tcf_lock);
183 police->tcf_bindcnt = 1;
185 if (parm->rate.rate) {
187 R_tab = qdisc_get_rtab(&parm->rate, tb[TCA_POLICE_RATE]);
191 if (parm->peakrate.rate) {
192 P_tab = qdisc_get_rtab(&parm->peakrate,
193 tb[TCA_POLICE_PEAKRATE]);
199 spin_lock_bh(&police->tcf_lock);
201 err = gen_replace_estimator(&police->tcf_bstats,
202 &police->tcf_rate_est,
203 &police->tcf_lock, est);
206 } else if (tb[TCA_POLICE_AVRATE] &&
207 (ret == ACT_P_CREATED ||
208 !gen_estimator_active(&police->tcf_bstats,
209 &police->tcf_rate_est))) {
214 /* No failure allowed after this point */
216 qdisc_put_rtab(police->tcfp_R_tab);
217 police->tcfp_R_tab = R_tab;
220 qdisc_put_rtab(police->tcfp_P_tab);
221 police->tcfp_P_tab = P_tab;
224 if (tb[TCA_POLICE_RESULT])
225 police->tcfp_result = nla_get_u32(tb[TCA_POLICE_RESULT]);
226 police->tcfp_toks = police->tcfp_burst = parm->burst;
227 police->tcfp_mtu = parm->mtu;
228 if (police->tcfp_mtu == 0) {
229 police->tcfp_mtu = ~0;
230 if (police->tcfp_R_tab)
231 police->tcfp_mtu = 255<<police->tcfp_R_tab->rate.cell_log;
233 if (police->tcfp_P_tab)
234 police->tcfp_ptoks = L2T_P(police, police->tcfp_mtu);
235 police->tcf_action = parm->action;
237 if (tb[TCA_POLICE_AVRATE])
238 police->tcfp_ewma_rate = nla_get_u32(tb[TCA_POLICE_AVRATE]);
240 spin_unlock_bh(&police->tcf_lock);
241 if (ret != ACT_P_CREATED)
244 police->tcfp_t_c = psched_get_time();
245 police->tcf_index = parm->index ? parm->index :
246 tcf_hash_new_index(&police_idx_gen, &police_hash_info);
247 h = tcf_hash(police->tcf_index, POL_TAB_MASK);
248 write_lock_bh(&police_lock);
249 police->tcf_next = tcf_police_ht[h];
250 tcf_police_ht[h] = &police->common;
251 write_unlock_bh(&police_lock);
257 spin_unlock_bh(&police->tcf_lock);
260 qdisc_put_rtab(P_tab);
262 qdisc_put_rtab(R_tab);
263 if (ret == ACT_P_CREATED)
268 static int tcf_act_police_cleanup(struct tc_action *a, int bind)
270 struct tcf_police *p = a->priv;
278 if (p->tcf_refcnt <= 0 && !p->tcf_bindcnt) {
279 tcf_police_destroy(p);
286 static int tcf_act_police(struct sk_buff *skb, const struct tc_action *a,
287 struct tcf_result *res)
289 struct tcf_police *police = a->priv;
294 spin_lock(&police->tcf_lock);
296 bstats_update(&police->tcf_bstats, skb);
298 if (police->tcfp_ewma_rate &&
299 police->tcf_rate_est.bps >= police->tcfp_ewma_rate) {
300 police->tcf_qstats.overlimits++;
301 if (police->tcf_action == TC_ACT_SHOT)
302 police->tcf_qstats.drops++;
303 spin_unlock(&police->tcf_lock);
304 return police->tcf_action;
307 if (qdisc_pkt_len(skb) <= police->tcfp_mtu) {
308 if (police->tcfp_R_tab == NULL) {
309 spin_unlock(&police->tcf_lock);
310 return police->tcfp_result;
313 now = psched_get_time();
314 toks = psched_tdiff_bounded(now, police->tcfp_t_c,
316 if (police->tcfp_P_tab) {
317 ptoks = toks + police->tcfp_ptoks;
318 if (ptoks > (long)L2T_P(police, police->tcfp_mtu))
319 ptoks = (long)L2T_P(police, police->tcfp_mtu);
320 ptoks -= L2T_P(police, qdisc_pkt_len(skb));
322 toks += police->tcfp_toks;
323 if (toks > (long)police->tcfp_burst)
324 toks = police->tcfp_burst;
325 toks -= L2T(police, qdisc_pkt_len(skb));
326 if ((toks|ptoks) >= 0) {
327 police->tcfp_t_c = now;
328 police->tcfp_toks = toks;
329 police->tcfp_ptoks = ptoks;
330 spin_unlock(&police->tcf_lock);
331 return police->tcfp_result;
335 police->tcf_qstats.overlimits++;
336 if (police->tcf_action == TC_ACT_SHOT)
337 police->tcf_qstats.drops++;
338 spin_unlock(&police->tcf_lock);
339 return police->tcf_action;
343 tcf_act_police_dump(struct sk_buff *skb, struct tc_action *a, int bind, int ref)
345 unsigned char *b = skb_tail_pointer(skb);
346 struct tcf_police *police = a->priv;
347 struct tc_police opt = {
348 .index = police->tcf_index,
349 .action = police->tcf_action,
350 .mtu = police->tcfp_mtu,
351 .burst = police->tcfp_burst,
352 .refcnt = police->tcf_refcnt - ref,
353 .bindcnt = police->tcf_bindcnt - bind,
356 if (police->tcfp_R_tab)
357 opt.rate = police->tcfp_R_tab->rate;
358 if (police->tcfp_P_tab)
359 opt.peakrate = police->tcfp_P_tab->rate;
360 if (nla_put(skb, TCA_POLICE_TBF, sizeof(opt), &opt))
361 goto nla_put_failure;
362 if (police->tcfp_result &&
363 nla_put_u32(skb, TCA_POLICE_RESULT, police->tcfp_result))
364 goto nla_put_failure;
365 if (police->tcfp_ewma_rate &&
366 nla_put_u32(skb, TCA_POLICE_AVRATE, police->tcfp_ewma_rate))
367 goto nla_put_failure;
375 MODULE_AUTHOR("Alexey Kuznetsov");
376 MODULE_DESCRIPTION("Policing actions");
377 MODULE_LICENSE("GPL");
379 static struct tc_action_ops act_police_ops = {
381 .hinfo = &police_hash_info,
382 .type = TCA_ID_POLICE,
383 .capab = TCA_CAP_NONE,
384 .owner = THIS_MODULE,
385 .act = tcf_act_police,
386 .dump = tcf_act_police_dump,
387 .cleanup = tcf_act_police_cleanup,
388 .lookup = tcf_hash_search,
389 .init = tcf_act_police_locate,
390 .walk = tcf_act_police_walker
394 police_init_module(void)
396 return tcf_register_action(&act_police_ops);
400 police_cleanup_module(void)
402 tcf_unregister_action(&act_police_ops);
405 module_init(police_init_module);
406 module_exit(police_cleanup_module);