2 * linux/net/netfilter/xt_IDLETIMER.c
4 * Netfilter module to trigger a timer when packet matches.
5 * After timer expires a kevent will be sent.
7 * Copyright (C) 2004, 2010 Nokia Corporation
8 * Written by Timo Teras <ext-timo.teras@nokia.com>
10 * Converted to x_tables and reworked for upstream inclusion
11 * by Luciano Coelho <luciano.coelho@nokia.com>
13 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
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.
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.
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
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
44 struct idletimer_tg_attr {
45 struct attribute attr;
46 ssize_t (*show)(struct kobject *kobj,
47 struct attribute *attr, char *buf);
51 struct list_head entry;
52 struct timer_list timer;
53 struct work_struct work;
56 struct idletimer_tg_attr attr;
61 static LIST_HEAD(idletimer_tg_list);
62 static DEFINE_MUTEX(list_mutex);
64 static struct kobject *idletimer_tg_kobj;
67 struct idletimer_tg *__idletimer_tg_find_by_label(const char *label)
69 struct idletimer_tg *entry;
73 list_for_each_entry(entry, &idletimer_tg_list, entry) {
74 if (!strcmp(label, entry->attr.attr.name))
81 static ssize_t idletimer_tg_show(struct kobject *kobj, struct attribute *attr,
84 struct idletimer_tg *timer;
85 unsigned long expires = 0;
87 mutex_lock(&list_mutex);
89 timer = __idletimer_tg_find_by_label(attr->name);
91 expires = timer->timer.expires;
93 mutex_unlock(&list_mutex);
95 if (time_after(expires, jiffies))
96 return sprintf(buf, "%u\n",
97 jiffies_to_msecs(expires - jiffies) / 1000);
99 return sprintf(buf, "0\n");
102 static void idletimer_tg_work(struct work_struct *work)
104 struct idletimer_tg *timer = container_of(work, struct idletimer_tg,
107 sysfs_notify(idletimer_tg_kobj, NULL, timer->attr.attr.name);
110 static void idletimer_tg_expired(unsigned long data)
112 struct idletimer_tg *timer = (struct idletimer_tg *) data;
114 pr_debug("timer %s expired\n", timer->attr.attr.name);
116 schedule_work(&timer->work);
119 static int idletimer_check_sysfs_name(const char *name, unsigned int size)
123 ret = xt_check_proc_name(name, size);
127 if (!strcmp(name, "power") ||
128 !strcmp(name, "subsystem") ||
129 !strcmp(name, "uevent"))
135 static int idletimer_tg_create(struct idletimer_tg_info *info)
139 info->timer = kmalloc(sizeof(*info->timer), GFP_KERNEL);
145 ret = idletimer_check_sysfs_name(info->label, sizeof(info->label));
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) {
155 info->timer->attr.attr.mode = S_IRUGO;
156 info->timer->attr.show = idletimer_tg_show;
158 ret = sysfs_create_file(idletimer_tg_kobj, &info->timer->attr.attr);
160 pr_debug("couldn't add file to sysfs");
164 list_add(&info->timer->entry, &idletimer_tg_list);
166 setup_timer(&info->timer->timer, idletimer_tg_expired,
167 (unsigned long) info->timer);
168 info->timer->refcnt = 1;
170 INIT_WORK(&info->timer->work, idletimer_tg_work);
172 mod_timer(&info->timer->timer,
173 msecs_to_jiffies(info->timeout * 1000) + jiffies);
178 kfree(info->timer->attr.attr.name);
186 * The actual xt_tables plugin.
188 static unsigned int idletimer_tg_target(struct sk_buff *skb,
189 const struct xt_action_param *par)
191 const struct idletimer_tg_info *info = par->targinfo;
193 pr_debug("resetting timer %s, timeout period %u\n",
194 info->label, info->timeout);
196 BUG_ON(!info->timer);
198 mod_timer(&info->timer->timer,
199 msecs_to_jiffies(info->timeout * 1000) + jiffies);
204 static int idletimer_tg_checkentry(const struct xt_tgchk_param *par)
206 struct idletimer_tg_info *info = par->targinfo;
209 pr_debug("checkentry targinfo%s\n", info->label);
211 if (info->timeout == 0) {
212 pr_debug("timeout value is zero\n");
215 if (info->timeout >= INT_MAX / 1000) {
216 pr_debug("timeout value is too big\n");
219 if (info->label[0] == '\0' ||
221 MAX_IDLETIMER_LABEL_SIZE) == MAX_IDLETIMER_LABEL_SIZE) {
222 pr_debug("label is empty or not nul-terminated\n");
226 mutex_lock(&list_mutex);
228 info->timer = __idletimer_tg_find_by_label(info->label);
230 info->timer->refcnt++;
231 mod_timer(&info->timer->timer,
232 msecs_to_jiffies(info->timeout * 1000) + jiffies);
234 pr_debug("increased refcnt of timer %s to %u\n",
235 info->label, info->timer->refcnt);
237 ret = idletimer_tg_create(info);
239 pr_debug("failed to create timer\n");
240 mutex_unlock(&list_mutex);
245 mutex_unlock(&list_mutex);
249 static void idletimer_tg_destroy(const struct xt_tgdtor_param *par)
251 const struct idletimer_tg_info *info = par->targinfo;
253 pr_debug("destroy targinfo %s\n", info->label);
255 mutex_lock(&list_mutex);
257 if (--info->timer->refcnt == 0) {
258 pr_debug("deleting timer %s\n", info->label);
260 list_del(&info->timer->entry);
261 del_timer_sync(&info->timer->timer);
262 cancel_work_sync(&info->timer->work);
263 sysfs_remove_file(idletimer_tg_kobj, &info->timer->attr.attr);
264 kfree(info->timer->attr.attr.name);
267 pr_debug("decreased refcnt of timer %s to %u\n",
268 info->label, info->timer->refcnt);
271 mutex_unlock(&list_mutex);
274 static struct xt_target idletimer_tg __read_mostly = {
276 .family = NFPROTO_UNSPEC,
277 .target = idletimer_tg_target,
278 .targetsize = sizeof(struct idletimer_tg_info),
279 .checkentry = idletimer_tg_checkentry,
280 .destroy = idletimer_tg_destroy,
284 static struct class *idletimer_tg_class;
286 static struct device *idletimer_tg_device;
288 static int __init idletimer_tg_init(void)
292 idletimer_tg_class = class_create(THIS_MODULE, "xt_idletimer");
293 err = PTR_ERR(idletimer_tg_class);
294 if (IS_ERR(idletimer_tg_class)) {
295 pr_debug("couldn't register device class\n");
299 idletimer_tg_device = device_create(idletimer_tg_class, NULL,
300 MKDEV(0, 0), NULL, "timers");
301 err = PTR_ERR(idletimer_tg_device);
302 if (IS_ERR(idletimer_tg_device)) {
303 pr_debug("couldn't register system device\n");
307 idletimer_tg_kobj = &idletimer_tg_device->kobj;
309 err = xt_register_target(&idletimer_tg);
311 pr_debug("couldn't register xt target\n");
317 device_destroy(idletimer_tg_class, MKDEV(0, 0));
319 class_destroy(idletimer_tg_class);
324 static void __exit idletimer_tg_exit(void)
326 xt_unregister_target(&idletimer_tg);
328 device_destroy(idletimer_tg_class, MKDEV(0, 0));
329 class_destroy(idletimer_tg_class);
332 module_init(idletimer_tg_init);
333 module_exit(idletimer_tg_exit);
335 MODULE_AUTHOR("Timo Teras <ext-timo.teras@nokia.com>");
336 MODULE_AUTHOR("Luciano Coelho <luciano.coelho@nokia.com>");
337 MODULE_DESCRIPTION("Xtables: idle time monitor");
338 MODULE_LICENSE("GPL v2");
339 MODULE_ALIAS("ipt_IDLETIMER");
340 MODULE_ALIAS("ip6t_IDLETIMER");