[NETFILTER]: ULOG/nfnetlink_log: Use better default value for 'nlbufsiz'
[linux-2.6.git] / net / ipv4 / netfilter / ipt_ULOG.c
1 /*
2  * netfilter module for userspace packet logging daemons
3  *
4  * (C) 2000-2004 by Harald Welte <laforge@netfilter.org>
5  *
6  * 2000/09/22 ulog-cprange feature added
7  * 2001/01/04 in-kernel queue as proposed by Sebastian Zander 
8  *                                              <zander@fokus.gmd.de>
9  * 2001/01/30 per-rule nlgroup conflicts with global queue. 
10  *            nlgroup now global (sysctl)
11  * 2001/04/19 ulog-queue reworked, now fixed buffer size specified at
12  *            module loadtime -HW
13  * 2002/07/07 remove broken nflog_rcv() function -HW
14  * 2002/08/29 fix shifted/unshifted nlgroup bug -HW
15  * 2002/10/30 fix uninitialized mac_len field - <Anders K. Pedersen>
16  * 2004/10/25 fix erroneous calculation of 'len' parameter to NLMSG_PUT
17  *            resulting in bogus 'error during NLMSG_PUT' messages.
18  *
19  * (C) 1999-2001 Paul `Rusty' Russell
20  * (C) 2002-2004 Netfilter Core Team <coreteam@netfilter.org>
21  *
22  * This program is free software; you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License version 2 as
24  * published by the Free Software Foundation.
25  *
26  * This module accepts two parameters: 
27  * 
28  * nlbufsiz:
29  *   The parameter specifies how big the buffer for each netlink multicast
30  * group is. e.g. If you say nlbufsiz=8192, up to eight kb of packets will
31  * get accumulated in the kernel until they are sent to userspace. It is
32  * NOT possible to allocate more than 128kB, and it is strongly discouraged,
33  * because atomically allocating 128kB inside the network rx softirq is not
34  * reliable. Please also keep in mind that this buffer size is allocated for
35  * each nlgroup you are using, so the total kernel memory usage increases
36  * by that factor.
37  *
38  * Actually you should use nlbufsiz a bit smaller than PAGE_SIZE, since
39  * nlbufsiz is used with alloc_skb, which adds another
40  * sizeof(struct skb_shared_info).  Use NLMSG_GOODSIZE instead.
41  *
42  * flushtimeout:
43  *   Specify, after how many hundredths of a second the queue should be
44  *   flushed even if it is not full yet.
45  *
46  * ipt_ULOG.c,v 1.22 2002/10/30 09:07:31 laforge Exp
47  */
48
49 #include <linux/module.h>
50 #include <linux/config.h>
51 #include <linux/spinlock.h>
52 #include <linux/socket.h>
53 #include <linux/skbuff.h>
54 #include <linux/kernel.h>
55 #include <linux/timer.h>
56 #include <linux/netlink.h>
57 #include <linux/netdevice.h>
58 #include <linux/mm.h>
59 #include <linux/moduleparam.h>
60 #include <linux/netfilter.h>
61 #include <linux/netfilter_ipv4/ip_tables.h>
62 #include <linux/netfilter_ipv4/ipt_ULOG.h>
63 #include <net/sock.h>
64 #include <linux/bitops.h>
65
66 MODULE_LICENSE("GPL");
67 MODULE_AUTHOR("Harald Welte <laforge@gnumonks.org>");
68 MODULE_DESCRIPTION("iptables userspace logging module");
69 MODULE_ALIAS_NET_PF_PROTO(PF_NETLINK, NETLINK_NFLOG);
70
71 #define ULOG_NL_EVENT           111             /* Harald's favorite number */
72 #define ULOG_MAXNLGROUPS        32              /* numer of nlgroups */
73
74 #if 0
75 #define DEBUGP(format, args...) printk("%s:%s:" format, \
76                                        __FILE__, __FUNCTION__ , ## args)
77 #else
78 #define DEBUGP(format, args...)
79 #endif
80
81 #define PRINTR(format, args...) do { if (net_ratelimit()) printk(format , ## args); } while (0)
82
83 static unsigned int nlbufsiz = NLMSG_GOODSIZE;
84 module_param(nlbufsiz, uint, 0400);
85 MODULE_PARM_DESC(nlbufsiz, "netlink buffer size");
86
87 static unsigned int flushtimeout = 10;
88 module_param(flushtimeout, uint, 0600);
89 MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths of a second)");
90
91 static int nflog = 1;
92 module_param(nflog, bool, 0400);
93 MODULE_PARM_DESC(nflog, "register as internal netfilter logging module");
94
95 /* global data structures */
96
97 typedef struct {
98         unsigned int qlen;              /* number of nlmsgs' in the skb */
99         struct nlmsghdr *lastnlh;       /* netlink header of last msg in skb */
100         struct sk_buff *skb;            /* the pre-allocated skb */
101         struct timer_list timer;        /* the timer function */
102 } ulog_buff_t;
103
104 static ulog_buff_t ulog_buffers[ULOG_MAXNLGROUPS];      /* array of buffers */
105
106 static struct sock *nflognl;            /* our socket */
107 static DEFINE_SPINLOCK(ulog_lock);      /* spinlock */
108
109 /* send one ulog_buff_t to userspace */
110 static void ulog_send(unsigned int nlgroupnum)
111 {
112         ulog_buff_t *ub = &ulog_buffers[nlgroupnum];
113
114         if (timer_pending(&ub->timer)) {
115                 DEBUGP("ipt_ULOG: ulog_send: timer was pending, deleting\n");
116                 del_timer(&ub->timer);
117         }
118
119         /* last nlmsg needs NLMSG_DONE */
120         if (ub->qlen > 1)
121                 ub->lastnlh->nlmsg_type = NLMSG_DONE;
122
123         NETLINK_CB(ub->skb).dst_group = nlgroupnum + 1;
124         DEBUGP("ipt_ULOG: throwing %d packets to netlink group %u\n",
125                 ub->qlen, nlgroupnum + 1);
126         netlink_broadcast(nflognl, ub->skb, 0, nlgroupnum + 1, GFP_ATOMIC);
127
128         ub->qlen = 0;
129         ub->skb = NULL;
130         ub->lastnlh = NULL;
131
132 }
133
134
135 /* timer function to flush queue in flushtimeout time */
136 static void ulog_timer(unsigned long data)
137 {
138         DEBUGP("ipt_ULOG: timer function called, calling ulog_send\n");
139
140         /* lock to protect against somebody modifying our structure
141          * from ipt_ulog_target at the same time */
142         spin_lock_bh(&ulog_lock);
143         ulog_send(data);
144         spin_unlock_bh(&ulog_lock);
145 }
146
147 static struct sk_buff *ulog_alloc_skb(unsigned int size)
148 {
149         struct sk_buff *skb;
150
151         /* alloc skb which should be big enough for a whole
152          * multipart message. WARNING: has to be <= 131000
153          * due to slab allocator restrictions */
154
155         skb = alloc_skb(nlbufsiz, GFP_ATOMIC);
156         if (!skb) {
157                 PRINTR("ipt_ULOG: can't alloc whole buffer %ub!\n",
158                         nlbufsiz);
159
160                 /* try to allocate only as much as we need for 
161                  * current packet */
162
163                 skb = alloc_skb(size, GFP_ATOMIC);
164                 if (!skb)
165                         PRINTR("ipt_ULOG: can't even allocate %ub\n", size);
166         }
167
168         return skb;
169 }
170
171 static void ipt_ulog_packet(unsigned int hooknum,
172                             const struct sk_buff *skb,
173                             const struct net_device *in,
174                             const struct net_device *out,
175                             const struct ipt_ulog_info *loginfo,
176                             const char *prefix)
177 {
178         ulog_buff_t *ub;
179         ulog_packet_msg_t *pm;
180         size_t size, copy_len;
181         struct nlmsghdr *nlh;
182
183         /* ffs == find first bit set, necessary because userspace
184          * is already shifting groupnumber, but we need unshifted.
185          * ffs() returns [1..32], we need [0..31] */
186         unsigned int groupnum = ffs(loginfo->nl_group) - 1;
187
188         /* calculate the size of the skb needed */
189         if ((loginfo->copy_range == 0) ||
190             (loginfo->copy_range > skb->len)) {
191                 copy_len = skb->len;
192         } else {
193                 copy_len = loginfo->copy_range;
194         }
195
196         size = NLMSG_SPACE(sizeof(*pm) + copy_len);
197
198         ub = &ulog_buffers[groupnum];
199         
200         spin_lock_bh(&ulog_lock);
201
202         if (!ub->skb) {
203                 if (!(ub->skb = ulog_alloc_skb(size)))
204                         goto alloc_failure;
205         } else if (ub->qlen >= loginfo->qthreshold ||
206                    size > skb_tailroom(ub->skb)) {
207                 /* either the queue len is too high or we don't have 
208                  * enough room in nlskb left. send it to userspace. */
209
210                 ulog_send(groupnum);
211
212                 if (!(ub->skb = ulog_alloc_skb(size)))
213                         goto alloc_failure;
214         }
215
216         DEBUGP("ipt_ULOG: qlen %d, qthreshold %d\n", ub->qlen, 
217                 loginfo->qthreshold);
218
219         /* NLMSG_PUT contains a hidden goto nlmsg_failure !!! */
220         nlh = NLMSG_PUT(ub->skb, 0, ub->qlen, ULOG_NL_EVENT, 
221                         sizeof(*pm)+copy_len);
222         ub->qlen++;
223
224         pm = NLMSG_DATA(nlh);
225
226         /* We might not have a timestamp, get one */
227         if (skb->tstamp.off_sec == 0)
228                 __net_timestamp((struct sk_buff *)skb);
229
230         /* copy hook, prefix, timestamp, payload, etc. */
231         pm->data_len = copy_len;
232         pm->timestamp_sec = skb->tstamp.off_sec;
233         pm->timestamp_usec = skb->tstamp.off_usec;
234         pm->mark = skb->nfmark;
235         pm->hook = hooknum;
236         if (prefix != NULL)
237                 strncpy(pm->prefix, prefix, sizeof(pm->prefix));
238         else if (loginfo->prefix[0] != '\0')
239                 strncpy(pm->prefix, loginfo->prefix, sizeof(pm->prefix));
240         else
241                 *(pm->prefix) = '\0';
242
243         if (in && in->hard_header_len > 0
244             && skb->mac.raw != (void *) skb->nh.iph
245             && in->hard_header_len <= ULOG_MAC_LEN) {
246                 memcpy(pm->mac, skb->mac.raw, in->hard_header_len);
247                 pm->mac_len = in->hard_header_len;
248         } else
249                 pm->mac_len = 0;
250
251         if (in)
252                 strncpy(pm->indev_name, in->name, sizeof(pm->indev_name));
253         else
254                 pm->indev_name[0] = '\0';
255
256         if (out)
257                 strncpy(pm->outdev_name, out->name, sizeof(pm->outdev_name));
258         else
259                 pm->outdev_name[0] = '\0';
260
261         /* copy_len <= skb->len, so can't fail. */
262         if (skb_copy_bits(skb, 0, pm->payload, copy_len) < 0)
263                 BUG();
264         
265         /* check if we are building multi-part messages */
266         if (ub->qlen > 1) {
267                 ub->lastnlh->nlmsg_flags |= NLM_F_MULTI;
268         }
269
270         ub->lastnlh = nlh;
271
272         /* if timer isn't already running, start it */
273         if (!timer_pending(&ub->timer)) {
274                 ub->timer.expires = jiffies + flushtimeout * HZ / 100;
275                 add_timer(&ub->timer);
276         }
277
278         /* if threshold is reached, send message to userspace */
279         if (ub->qlen >= loginfo->qthreshold) {
280                 if (loginfo->qthreshold > 1)
281                         nlh->nlmsg_type = NLMSG_DONE;
282                 ulog_send(groupnum);
283         }
284
285         spin_unlock_bh(&ulog_lock);
286
287         return;
288
289 nlmsg_failure:
290         PRINTR("ipt_ULOG: error during NLMSG_PUT\n");
291
292 alloc_failure:
293         PRINTR("ipt_ULOG: Error building netlink message\n");
294
295         spin_unlock_bh(&ulog_lock);
296 }
297
298 static unsigned int ipt_ulog_target(struct sk_buff **pskb,
299                                     const struct net_device *in,
300                                     const struct net_device *out,
301                                     unsigned int hooknum,
302                                     const void *targinfo, void *userinfo)
303 {
304         struct ipt_ulog_info *loginfo = (struct ipt_ulog_info *) targinfo;
305
306         ipt_ulog_packet(hooknum, *pskb, in, out, loginfo, NULL);
307  
308         return IPT_CONTINUE;
309 }
310  
311 static void ipt_logfn(unsigned int pf,
312                       unsigned int hooknum,
313                       const struct sk_buff *skb,
314                       const struct net_device *in,
315                       const struct net_device *out,
316                       const struct nf_loginfo *li,
317                       const char *prefix)
318 {
319         struct ipt_ulog_info loginfo;
320
321         if (!li || li->type != NF_LOG_TYPE_ULOG) {
322                 loginfo.nl_group = ULOG_DEFAULT_NLGROUP;
323                 loginfo.copy_range = 0;
324                 loginfo.qthreshold = ULOG_DEFAULT_QTHRESHOLD;
325                 loginfo.prefix[0] = '\0';
326         } else {
327                 loginfo.nl_group = li->u.ulog.group;
328                 loginfo.copy_range = li->u.ulog.copy_len;
329                 loginfo.qthreshold = li->u.ulog.qthreshold;
330                 strlcpy(loginfo.prefix, prefix, sizeof(loginfo.prefix));
331         }
332
333         ipt_ulog_packet(hooknum, skb, in, out, &loginfo, prefix);
334 }
335
336 static int ipt_ulog_checkentry(const char *tablename,
337                                const void *e,
338                                void *targinfo,
339                                unsigned int targinfosize,
340                                unsigned int hookmask)
341 {
342         struct ipt_ulog_info *loginfo = (struct ipt_ulog_info *) targinfo;
343
344         if (targinfosize != IPT_ALIGN(sizeof(struct ipt_ulog_info))) {
345                 DEBUGP("ipt_ULOG: targinfosize %u != 0\n", targinfosize);
346                 return 0;
347         }
348
349         if (loginfo->prefix[sizeof(loginfo->prefix) - 1] != '\0') {
350                 DEBUGP("ipt_ULOG: prefix term %i\n",
351                        loginfo->prefix[sizeof(loginfo->prefix) - 1]);
352                 return 0;
353         }
354
355         if (loginfo->qthreshold > ULOG_MAX_QLEN) {
356                 DEBUGP("ipt_ULOG: queue threshold %i > MAX_QLEN\n",
357                         loginfo->qthreshold);
358                 return 0;
359         }
360
361         return 1;
362 }
363
364 static struct ipt_target ipt_ulog_reg = {
365         .name           = "ULOG",
366         .target         = ipt_ulog_target,
367         .checkentry     = ipt_ulog_checkentry,
368         .me             = THIS_MODULE,
369 };
370
371 static struct nf_logger ipt_ulog_logger = {
372         .name           = "ipt_ULOG",
373         .logfn          = &ipt_logfn,
374         .me             = THIS_MODULE,
375 };
376
377 static int __init init(void)
378 {
379         int i;
380
381         DEBUGP("ipt_ULOG: init module\n");
382
383         if (nlbufsiz > 128*1024) {
384                 printk("Netlink buffer has to be <= 128kB\n");
385                 return -EINVAL;
386         }
387
388         /* initialize ulog_buffers */
389         for (i = 0; i < ULOG_MAXNLGROUPS; i++) {
390                 init_timer(&ulog_buffers[i].timer);
391                 ulog_buffers[i].timer.function = ulog_timer;
392                 ulog_buffers[i].timer.data = i;
393         }
394
395         nflognl = netlink_kernel_create(NETLINK_NFLOG, ULOG_MAXNLGROUPS, NULL,
396                                         THIS_MODULE);
397         if (!nflognl)
398                 return -ENOMEM;
399
400         if (ipt_register_target(&ipt_ulog_reg) != 0) {
401                 sock_release(nflognl->sk_socket);
402                 return -EINVAL;
403         }
404         if (nflog)
405                 nf_log_register(PF_INET, &ipt_ulog_logger);
406         
407         return 0;
408 }
409
410 static void __exit fini(void)
411 {
412         ulog_buff_t *ub;
413         int i;
414
415         DEBUGP("ipt_ULOG: cleanup_module\n");
416
417         if (nflog)
418                 nf_log_unregister_logger(&ipt_ulog_logger);
419         ipt_unregister_target(&ipt_ulog_reg);
420         sock_release(nflognl->sk_socket);
421
422         /* remove pending timers and free allocated skb's */
423         for (i = 0; i < ULOG_MAXNLGROUPS; i++) {
424                 ub = &ulog_buffers[i];
425                 if (timer_pending(&ub->timer)) {
426                         DEBUGP("timer was pending, deleting\n");
427                         del_timer(&ub->timer);
428                 }
429
430                 if (ub->skb) {
431                         kfree_skb(ub->skb);
432                         ub->skb = NULL;
433                 }
434         }
435
436 }
437
438 module_init(init);
439 module_exit(fini);