net/netfilter/xt_IDLETIMER.c

   1 /*
   2  * linux/net/netfilter/xt_IDLETIMER.c
   3  *
   4  * Netfilter module to trigger a timer when packet matches.
   5  * After timer expires a kevent will be sent.
   6  *
   7  * Copyright (C) 2004, 2010 Nokia Corporation
   8  * Written by Timo Teras <ext-timo.teras@nokia.com>
   9  *
  10  * Converted to x_tables and reworked for upstream inclusion
  11  * by Luciano Coelho <luciano.coelho@nokia.com>
  12  *
  13  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
  14  *
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * version 2 as published by the Free Software Foundation.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22  * General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  27  * 02110-1301 USA
  28  */
  29
  30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31
  32 #include <linux/module.h>
  33 #include <linux/timer.h>
  34 #include <linux/list.h>
  35 #include <linux/mutex.h>
  36 #include <linux/netfilter.h>
  37 #include <linux/netfilter/x_tables.h>
  38 #include <linux/netfilter/xt_IDLETIMER.h>
  39 #include <linux/kdev_t.h>
  40 #include <linux/kobject.h>
  41 #include <linux/workqueue.h>
  42 #include <linux/sysfs.h>
  43
  44 struct idletimer_tg_attr {
  45         struct attribute attr;
  46         ssize_t (*show)(struct kobject *kobj,
  47                         struct attribute *attr, char *buf);
  48 };
  49
  50 struct idletimer_tg {
  51         struct list_head entry;
  52         struct timer_list timer;
  53         struct work_struct work;
  54
  55         struct kobject *kobj;
  56         struct idletimer_tg_attr attr;
  57
  58         unsigned int refcnt;
  59 };
  60
  61 static LIST_HEAD(idletimer_tg_list);
  62 static DEFINE_MUTEX(list_mutex);
  63
  64 static struct kobject *idletimer_tg_kobj;
  65
  66 static
  67 struct idletimer_tg *__idletimer_tg_find_by_label(const char *label)
  68 {
  69         struct idletimer_tg *entry;
  70
  71         BUG_ON(!label);
  72
  73         list_for_each_entry(entry, &idletimer_tg_list, entry) {
  74                 if (!strcmp(label, entry->attr.attr.name))
  75                         return entry;
  76         }
  77
  78         return NULL;
  79 }
  80
  81 static ssize_t idletimer_tg_show(struct kobject *kobj, struct attribute *attr,
  82                                  char *buf)
  83 {
  84         struct idletimer_tg *timer;
  85         unsigned long expires = 0;
  86
  87         mutex_lock(&list_mutex);
  88
  89         timer = __idletimer_tg_find_by_label(attr->name);
  90         if (timer)
  91                 expires = timer->timer.expires;
  92
  93         mutex_unlock(&list_mutex);
  94
  95         if (time_after(expires, jiffies))
  96                 return sprintf(buf, "%u\n",
  97                                jiffies_to_msecs(expires - jiffies) / 1000);
  98
  99         return sprintf(buf, "0\n");
 100 }
 101
 102 static void idletimer_tg_work(struct work_struct *work)
 103 {
 104         struct idletimer_tg *timer = container_of(work, struct idletimer_tg,
 105                                                   work);
 106
 107         sysfs_notify(idletimer_tg_kobj, NULL, timer->attr.attr.name);
 108 }
 109
 110 static void idletimer_tg_expired(unsigned long data)
 111 {
 112         struct idletimer_tg *timer = (struct idletimer_tg *) data;
 113
 114         pr_debug("timer %s expired\n", timer->attr.attr.name);
 115
 116         schedule_work(&timer->work);
 117 }
 118
 119 static int idletimer_check_sysfs_name(const char *name, unsigned int size)
 120 {
 121         int ret;
 122
 123         ret = xt_check_proc_name(name, size);
 124         if (ret < 0)
 125                 return ret;
 126
 127         if (!strcmp(name, "power") ||
 128             !strcmp(name, "subsystem") ||
 129             !strcmp(name, "uevent"))
 130                 return -EINVAL;
 131
 132         return 0;
 133 }
 134
 135 static int idletimer_tg_create(struct idletimer_tg_info *info)
 136 {
 137         int ret;
 138
 139         info->timer = kmalloc(sizeof(*info->timer), GFP_KERNEL);
 140         if (!info->timer) {
 141                 ret = -ENOMEM;
 142                 goto out;
 143         }
 144
 145         ret = idletimer_check_sysfs_name(info->label, sizeof(info->label));
 146         if (ret < 0)
 147                 goto out_free_timer;
 148
 149         sysfs_attr_init(&info->timer->attr.attr);
 150         info->timer->attr.attr.name = kstrdup(info->label, GFP_KERNEL);
 151         if (!info->timer->attr.attr.name) {
 152                 ret = -ENOMEM;
 153                 goto out_free_timer;
 154         }
 155         info->timer->attr.attr.mode = S_IRUGO;
 156         info->timer->attr.show = idletimer_tg_show;
 157
 158         ret = sysfs_create_file(idletimer_tg_kobj, &info->timer->attr.attr);
 159         if (ret < 0) {
 160                 pr_debug("couldn't add file to sysfs");
 161                 goto out_free_attr;
 162         }
 163
 164         list_add(&info->timer->entry, &idletimer_tg_list);
 165
 166         setup_timer(&info->timer->timer, idletimer_tg_expired,
 167                     (unsigned long) info->timer);
 168         info->timer->refcnt = 1;
 169
 170         INIT_WORK(&info->timer->work, idletimer_tg_work);
 171
 172         mod_timer(&info->timer->timer,
 173                   msecs_to_jiffies(info->timeout * 1000) + jiffies);
 174
 175         return 0;
 176
 177 out_free_attr:
 178         kfree(info->timer->attr.attr.name);
 179 out_free_timer:
 180         kfree(info->timer);
 181 out:
 182         return ret;
 183 }
 184
 185 /*
 186  * The actual xt_tables plugin.
 187  */
 188 static unsigned int idletimer_tg_target(struct sk_buff *skb,
 189                                          const struct xt_action_param *par)
 190 {
 191         const struct idletimer_tg_info *info = par->targinfo;
 192
 193         pr_debug("resetting timer %s, timeout period %u\n",
 194                  info->label, info->timeout);
 195
 196         BUG_ON(!info->timer);
 197
 198         mod_timer(&info->timer->timer,
 199                   msecs_to_jiffies(info->timeout * 1000) + jiffies);
 200
 201         return XT_CONTINUE;
 202 }
 203
 204 static int idletimer_tg_checkentry(const struct xt_tgchk_param *par)
 205 {
 206         struct idletimer_tg_info *info = par->targinfo;
 207         int ret;
 208
 209         pr_debug("checkentry targinfo%s\n", info->label);
 210
 211         if (info->timeout == 0) {
 212                 pr_debug("timeout value is zero\n");
 213                 return -EINVAL;
 214         }
 215         if (info->timeout >= INT_MAX / 1000) {
 216                 pr_debug("timeout value is too big\n");
 217                 return -EINVAL;
 218         }
 219         if (info->label[0] == '\0' ||
 220             strnlen(info->label,
 221                     MAX_IDLETIMER_LABEL_SIZE) == MAX_IDLETIMER_LABEL_SIZE) {
 222                 pr_debug("label is empty or not nul-terminated\n");
 223                 return -EINVAL;
 224         }
 225
 226         mutex_lock(&list_mutex);
 227
 228         info->timer = __idletimer_tg_find_by_label(info->label);
 229         if (info->timer) {
 230                 info->timer->refcnt++;
 231                 mod_timer(&info->timer->timer,
 232                           msecs_to_jiffies(info->timeout * 1000) + jiffies);
 233
 234                 pr_debug("increased refcnt of timer %s to %u\n",
 235                          info->label, info->timer->refcnt);
 236         } else {
 237                 ret = idletimer_tg_create(info);
 238                 if (ret < 0) {
 239                         pr_debug("failed to create timer\n");
 240                         mutex_unlock(&list_mutex);
 241                         return ret;
 242                 }
 243         }
 244
 245         mutex_unlock(&list_mutex);
 246         return 0;
 247 }
 248
 249 static void idletimer_tg_destroy(const struct xt_tgdtor_param *par)
 250 {
 251         const struct idletimer_tg_info *info = par->targinfo;
 252
 253         pr_debug("destroy targinfo %s\n", info->label);
 254
 255         mutex_lock(&list_mutex);
 256
 257         if (--info->timer->refcnt == 0) {
 258                 pr_debug("deleting timer %s\n", info->label);
 259
 260                 list_del(&info->timer->entry);
 261                 del_timer_sync(&info->timer->timer);
 262                 sysfs_remove_file(idletimer_tg_kobj, &info->timer->attr.attr);
 263                 kfree(info->timer->attr.attr.name);
 264                 kfree(info->timer);
 265         } else {
 266                 pr_debug("decreased refcnt of timer %s to %u\n",
 267                          info->label, info->timer->refcnt);
 268         }
 269
 270         mutex_unlock(&list_mutex);
 271 }
 272
 273 static struct xt_target idletimer_tg __read_mostly = {
 274         .name           = "IDLETIMER",
 275         .family         = NFPROTO_UNSPEC,
 276         .target         = idletimer_tg_target,
 277         .targetsize     = sizeof(struct idletimer_tg_info),
 278         .checkentry     = idletimer_tg_checkentry,
 279         .destroy        = idletimer_tg_destroy,
 280         .me             = THIS_MODULE,
 281 };
 282
 283 static struct class *idletimer_tg_class;
 284
 285 static struct device *idletimer_tg_device;
 286
 287 static int __init idletimer_tg_init(void)
 288 {
 289         int err;
 290
 291         idletimer_tg_class = class_create(THIS_MODULE, "xt_idletimer");
 292         err = PTR_ERR(idletimer_tg_class);
 293         if (IS_ERR(idletimer_tg_class)) {
 294                 pr_debug("couldn't register device class\n");
 295                 goto out;
 296         }
 297
 298         idletimer_tg_device = device_create(idletimer_tg_class, NULL,
 299                                             MKDEV(0, 0), NULL, "timers");
 300         err = PTR_ERR(idletimer_tg_device);
 301         if (IS_ERR(idletimer_tg_device)) {
 302                 pr_debug("couldn't register system device\n");
 303                 goto out_class;
 304         }
 305
 306         idletimer_tg_kobj = &idletimer_tg_device->kobj;
 307
 308         err =  xt_register_target(&idletimer_tg);
 309         if (err < 0) {
 310                 pr_debug("couldn't register xt target\n");
 311                 goto out_dev;
 312         }
 313
 314         return 0;
 315 out_dev:
 316         device_destroy(idletimer_tg_class, MKDEV(0, 0));
 317 out_class:
 318         class_destroy(idletimer_tg_class);
 319 out:
 320         return err;
 321 }
 322
 323 static void __exit idletimer_tg_exit(void)
 324 {
 325         xt_unregister_target(&idletimer_tg);
 326
 327         device_destroy(idletimer_tg_class, MKDEV(0, 0));
 328         class_destroy(idletimer_tg_class);
 329 }
 330
 331 module_init(idletimer_tg_init);
 332 module_exit(idletimer_tg_exit);
 333
 334 MODULE_AUTHOR("Timo Teras <ext-timo.teras@nokia.com>");
 335 MODULE_AUTHOR("Luciano Coelho <luciano.coelho@nokia.com>");
 336 MODULE_DESCRIPTION("Xtables: idle time monitor");
 337 MODULE_LICENSE("GPL v2");
 338 MODULE_ALIAS("ipt_IDLETIMER");
 339 MODULE_ALIAS("ip6t_IDLETIMER");