net/netfilter/xt_RATEEST.c

   1 /*
   2  * (C) 2007 Patrick McHardy <kaber@trash.net>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  */
   8 #include <linux/module.h>
   9 #include <linux/skbuff.h>
  10 #include <linux/gen_stats.h>
  11 #include <linux/jhash.h>
  12 #include <linux/rtnetlink.h>
  13 #include <linux/random.h>
  14 #include <linux/slab.h>
  15 #include <net/gen_stats.h>
  16 #include <net/netlink.h>
  17
  18 #include <linux/netfilter/x_tables.h>
  19 #include <linux/netfilter/xt_RATEEST.h>
  20 #include <net/netfilter/xt_rateest.h>
  21
  22 static DEFINE_MUTEX(xt_rateest_mutex);
  23
  24 #define RATEEST_HSIZE   16
  25 static struct hlist_head rateest_hash[RATEEST_HSIZE] __read_mostly;
  26 static unsigned int jhash_rnd __read_mostly;
  27 static bool rnd_inited __read_mostly;
  28
  29 static unsigned int xt_rateest_hash(const char *name)
  30 {
  31         return jhash(name, FIELD_SIZEOF(struct xt_rateest, name), jhash_rnd) &
  32                (RATEEST_HSIZE - 1);
  33 }
  34
  35 static void xt_rateest_hash_insert(struct xt_rateest *est)
  36 {
  37         unsigned int h;
  38
  39         h = xt_rateest_hash(est->name);
  40         hlist_add_head(&est->list, &rateest_hash[h]);
  41 }
  42
  43 struct xt_rateest *xt_rateest_lookup(const char *name)
  44 {
  45         struct xt_rateest *est;
  46         struct hlist_node *n;
  47         unsigned int h;
  48
  49         h = xt_rateest_hash(name);
  50         mutex_lock(&xt_rateest_mutex);
  51         hlist_for_each_entry(est, n, &rateest_hash[h], list) {
  52                 if (strcmp(est->name, name) == 0) {
  53                         est->refcnt++;
  54                         mutex_unlock(&xt_rateest_mutex);
  55                         return est;
  56                 }
  57         }
  58         mutex_unlock(&xt_rateest_mutex);
  59         return NULL;
  60 }
  61 EXPORT_SYMBOL_GPL(xt_rateest_lookup);
  62
  63 void xt_rateest_put(struct xt_rateest *est)
  64 {
  65         mutex_lock(&xt_rateest_mutex);
  66         if (--est->refcnt == 0) {
  67                 hlist_del(&est->list);
  68                 gen_kill_estimator(&est->bstats, &est->rstats);
  69                 kfree(est);
  70         }
  71         mutex_unlock(&xt_rateest_mutex);
  72 }
  73 EXPORT_SYMBOL_GPL(xt_rateest_put);
  74
  75 static unsigned int
  76 xt_rateest_tg(struct sk_buff *skb, const struct xt_action_param *par)
  77 {
  78         const struct xt_rateest_target_info *info = par->targinfo;
  79         struct gnet_stats_basic_packed *stats = &info->est->bstats;
  80
  81         spin_lock_bh(&info->est->lock);
  82         stats->bytes += skb->len;
  83         stats->packets++;
  84         spin_unlock_bh(&info->est->lock);
  85
  86         return XT_CONTINUE;
  87 }
  88
  89 static int xt_rateest_tg_checkentry(const struct xt_tgchk_param *par)
  90 {
  91         struct xt_rateest_target_info *info = par->targinfo;
  92         struct xt_rateest *est;
  93         struct {
  94                 struct nlattr           opt;
  95                 struct gnet_estimator   est;
  96         } cfg;
  97         int ret;
  98
  99         if (unlikely(!rnd_inited)) {
 100                 get_random_bytes(&jhash_rnd, sizeof(jhash_rnd));
 101                 rnd_inited = true;
 102         }
 103
 104         est = xt_rateest_lookup(info->name);
 105         if (est) {
 106                 /*
 107                  * If estimator parameters are specified, they must match the
 108                  * existing estimator.
 109                  */
 110                 if ((!info->interval && !info->ewma_log) ||
 111                     (info->interval != est->params.interval ||
 112                      info->ewma_log != est->params.ewma_log)) {
 113                         xt_rateest_put(est);
 114                         return -EINVAL;
 115                 }
 116                 info->est = est;
 117                 return 0;
 118         }
 119
 120         ret = -ENOMEM;
 121         est = kzalloc(sizeof(*est), GFP_KERNEL);
 122         if (!est)
 123                 goto err1;
 124
 125         strlcpy(est->name, info->name, sizeof(est->name));
 126         spin_lock_init(&est->lock);
 127         est->refcnt             = 1;
 128         est->params.interval    = info->interval;
 129         est->params.ewma_log    = info->ewma_log;
 130
 131         cfg.opt.nla_len         = nla_attr_size(sizeof(cfg.est));
 132         cfg.opt.nla_type        = TCA_STATS_RATE_EST;
 133         cfg.est.interval        = info->interval;
 134         cfg.est.ewma_log        = info->ewma_log;
 135
 136         ret = gen_new_estimator(&est->bstats, &est->rstats,
 137                                 &est->lock, &cfg.opt);
 138         if (ret < 0)
 139                 goto err2;
 140
 141         info->est = est;
 142         xt_rateest_hash_insert(est);
 143         return 0;
 144
 145 err2:
 146         kfree(est);
 147 err1:
 148         return ret;
 149 }
 150
 151 static void xt_rateest_tg_destroy(const struct xt_tgdtor_param *par)
 152 {
 153         struct xt_rateest_target_info *info = par->targinfo;
 154
 155         xt_rateest_put(info->est);
 156 }
 157
 158 static struct xt_target xt_rateest_tg_reg __read_mostly = {
 159         .name       = "RATEEST",
 160         .revision   = 0,
 161         .family     = NFPROTO_UNSPEC,
 162         .target     = xt_rateest_tg,
 163         .checkentry = xt_rateest_tg_checkentry,
 164         .destroy    = xt_rateest_tg_destroy,
 165         .targetsize = sizeof(struct xt_rateest_target_info),
 166         .me         = THIS_MODULE,
 167 };
 168
 169 static int __init xt_rateest_tg_init(void)
 170 {
 171         unsigned int i;
 172
 173         for (i = 0; i < ARRAY_SIZE(rateest_hash); i++)
 174                 INIT_HLIST_HEAD(&rateest_hash[i]);
 175
 176         return xt_register_target(&xt_rateest_tg_reg);
 177 }
 178
 179 static void __exit xt_rateest_tg_fini(void)
 180 {
 181         xt_unregister_target(&xt_rateest_tg_reg);
 182 }
 183
 184
 185 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
 186 MODULE_LICENSE("GPL");
 187 MODULE_DESCRIPTION("Xtables: packet rate estimator");
 188 MODULE_ALIAS("ipt_RATEEST");
 189 MODULE_ALIAS("ip6t_RATEEST");
 190 module_init(xt_rateest_tg_init);
 191 module_exit(xt_rateest_tg_fini);