]> bbs.cooldavid.org Git - net-next-2.6.git/blame - net/bridge/netfilter/ebt_ulog.c
netfilter: add dummy members to Ebtables code to ease transition to Xtables
[net-next-2.6.git] / net / bridge / netfilter / ebt_ulog.c
CommitLineData
1da177e4
LT
1/*
2 * netfilter module for userspace bridged Ethernet frames logging daemons
3 *
4 * Authors:
5 * Bart De Schuymer <bdschuym@pandora.be>
d5228a4f 6 * Harald Welte <laforge@netfilter.org>
1da177e4
LT
7 *
8 * November, 2004
9 *
10 * Based on ipt_ULOG.c, which is
11 * (C) 2000-2002 by Harald Welte <laforge@netfilter.org>
12 *
9d6f229f
YH
13 * This module accepts two parameters:
14 *
1da177e4
LT
15 * nlbufsiz:
16 * The parameter specifies how big the buffer for each netlink multicast
17 * group is. e.g. If you say nlbufsiz=8192, up to eight kb of packets will
18 * get accumulated in the kernel until they are sent to userspace. It is
19 * NOT possible to allocate more than 128kB, and it is strongly discouraged,
20 * because atomically allocating 128kB inside the network rx softirq is not
21 * reliable. Please also keep in mind that this buffer size is allocated for
22 * each nlgroup you are using, so the total kernel memory usage increases
23 * by that factor.
24 *
25 * flushtimeout:
26 * Specify, after how many hundredths of a second the queue should be
27 * flushed even if it is not full yet.
28 *
29 */
30
31#include <linux/module.h>
1da177e4
LT
32#include <linux/spinlock.h>
33#include <linux/socket.h>
34#include <linux/skbuff.h>
35#include <linux/kernel.h>
36#include <linux/timer.h>
37#include <linux/netlink.h>
38#include <linux/netdevice.h>
18219d3f 39#include <linux/netfilter/x_tables.h>
1da177e4
LT
40#include <linux/netfilter_bridge/ebtables.h>
41#include <linux/netfilter_bridge/ebt_ulog.h>
f01ffbd6 42#include <net/netfilter/nf_log.h>
1da177e4
LT
43#include <net/sock.h>
44#include "../br_private.h"
45
46#define PRINTR(format, args...) do { if (net_ratelimit()) \
9d6f229f 47 printk(format , ## args); } while (0)
1da177e4 48
c2db2924 49static unsigned int nlbufsiz = NLMSG_GOODSIZE;
1da177e4
LT
50module_param(nlbufsiz, uint, 0600);
51MODULE_PARM_DESC(nlbufsiz, "netlink buffer size (number of bytes) "
9d6f229f 52 "(defaults to 4096)");
1da177e4
LT
53
54static unsigned int flushtimeout = 10;
55module_param(flushtimeout, uint, 0600);
56MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths ofa second) "
9d6f229f 57 "(defaults to 10)");
1da177e4
LT
58
59typedef struct {
60 unsigned int qlen; /* number of nlmsgs' in the skb */
61 struct nlmsghdr *lastnlh; /* netlink header of last msg in skb */
62 struct sk_buff *skb; /* the pre-allocated skb */
63 struct timer_list timer; /* the timer function */
64 spinlock_t lock; /* the per-queue lock */
65} ebt_ulog_buff_t;
66
67static ebt_ulog_buff_t ulog_buffers[EBT_ULOG_MAXNLGROUPS];
68static struct sock *ebtulognl;
69
70/* send one ulog_buff_t to userspace */
71static void ulog_send(unsigned int nlgroup)
72{
73 ebt_ulog_buff_t *ub = &ulog_buffers[nlgroup];
74
75 if (timer_pending(&ub->timer))
76 del_timer(&ub->timer);
77
dcb7cd97
MH
78 if (!ub->skb)
79 return;
80
1da177e4
LT
81 /* last nlmsg needs NLMSG_DONE */
82 if (ub->qlen > 1)
83 ub->lastnlh->nlmsg_type = NLMSG_DONE;
84
ac6d439d
PM
85 NETLINK_CB(ub->skb).dst_group = nlgroup + 1;
86 netlink_broadcast(ebtulognl, ub->skb, 0, nlgroup + 1, GFP_ATOMIC);
1da177e4
LT
87
88 ub->qlen = 0;
89 ub->skb = NULL;
90}
91
92/* timer function to flush queue in flushtimeout time */
93static void ulog_timer(unsigned long data)
94{
95 spin_lock_bh(&ulog_buffers[data].lock);
96 if (ulog_buffers[data].skb)
97 ulog_send(data);
98 spin_unlock_bh(&ulog_buffers[data].lock);
99}
100
101static struct sk_buff *ulog_alloc_skb(unsigned int size)
102{
103 struct sk_buff *skb;
ad2ad0f9 104 unsigned int n;
1da177e4 105
ad2ad0f9
PM
106 n = max(size, nlbufsiz);
107 skb = alloc_skb(n, GFP_ATOMIC);
1da177e4
LT
108 if (!skb) {
109 PRINTR(KERN_ERR "ebt_ulog: can't alloc whole buffer "
ad2ad0f9
PM
110 "of size %ub!\n", n);
111 if (n > size) {
1da177e4
LT
112 /* try to allocate only as much as we need for
113 * current packet */
114 skb = alloc_skb(size, GFP_ATOMIC);
115 if (!skb)
116 PRINTR(KERN_ERR "ebt_ulog: can't even allocate "
117 "buffer of size %ub\n", size);
118 }
119 }
120
121 return skb;
122}
123
d5228a4f 124static void ebt_ulog_packet(unsigned int hooknr, const struct sk_buff *skb,
1da177e4 125 const struct net_device *in, const struct net_device *out,
d5228a4f 126 const struct ebt_ulog_info *uloginfo, const char *prefix)
1da177e4
LT
127{
128 ebt_ulog_packet_msg_t *pm;
129 size_t size, copy_len;
130 struct nlmsghdr *nlh;
1da177e4
LT
131 unsigned int group = uloginfo->nlgroup;
132 ebt_ulog_buff_t *ub = &ulog_buffers[group];
133 spinlock_t *lock = &ub->lock;
b7aa0bf7 134 ktime_t kt;
1da177e4
LT
135
136 if ((uloginfo->cprange == 0) ||
137 (uloginfo->cprange > skb->len + ETH_HLEN))
138 copy_len = skb->len + ETH_HLEN;
139 else
140 copy_len = uloginfo->cprange;
141
142 size = NLMSG_SPACE(sizeof(*pm) + copy_len);
143 if (size > nlbufsiz) {
144 PRINTR("ebt_ulog: Size %Zd needed, but nlbufsiz=%d\n",
145 size, nlbufsiz);
146 return;
147 }
148
149 spin_lock_bh(lock);
150
151 if (!ub->skb) {
152 if (!(ub->skb = ulog_alloc_skb(size)))
153 goto alloc_failure;
154 } else if (size > skb_tailroom(ub->skb)) {
155 ulog_send(group);
156
157 if (!(ub->skb = ulog_alloc_skb(size)))
158 goto alloc_failure;
159 }
160
161 nlh = NLMSG_PUT(ub->skb, 0, ub->qlen, 0,
9d6f229f 162 size - NLMSG_ALIGN(sizeof(*nlh)));
1da177e4
LT
163 ub->qlen++;
164
165 pm = NLMSG_DATA(nlh);
166
167 /* Fill in the ulog data */
168 pm->version = EBT_ULOG_VERSION;
b7aa0bf7
ED
169 kt = ktime_get_real();
170 pm->stamp = ktime_to_timeval(kt);
1da177e4 171 if (ub->qlen == 1)
b7aa0bf7 172 ub->skb->tstamp = kt;
1da177e4 173 pm->data_len = copy_len;
82e91ffe 174 pm->mark = skb->mark;
1da177e4
LT
175 pm->hook = hooknr;
176 if (uloginfo->prefix != NULL)
177 strcpy(pm->prefix, uloginfo->prefix);
178 else
179 *(pm->prefix) = '\0';
180
181 if (in) {
182 strcpy(pm->physindev, in->name);
183 /* If in isn't a bridge, then physindev==indev */
184 if (in->br_port)
185 strcpy(pm->indev, in->br_port->br->dev->name);
186 else
187 strcpy(pm->indev, in->name);
188 } else
189 pm->indev[0] = pm->physindev[0] = '\0';
190
191 if (out) {
192 /* If out exists, then out is a bridge port */
193 strcpy(pm->physoutdev, out->name);
194 strcpy(pm->outdev, out->br_port->br->dev->name);
195 } else
196 pm->outdev[0] = pm->physoutdev[0] = '\0';
197
198 if (skb_copy_bits(skb, -ETH_HLEN, pm->data, copy_len) < 0)
199 BUG();
200
201 if (ub->qlen > 1)
202 ub->lastnlh->nlmsg_flags |= NLM_F_MULTI;
203
204 ub->lastnlh = nlh;
205
206 if (ub->qlen >= uloginfo->qthreshold)
207 ulog_send(group);
208 else if (!timer_pending(&ub->timer)) {
209 ub->timer.expires = jiffies + flushtimeout * HZ / 100;
210 add_timer(&ub->timer);
211 }
212
213unlock:
214 spin_unlock_bh(lock);
215
216 return;
217
218nlmsg_failure:
219 printk(KERN_CRIT "ebt_ulog: error during NLMSG_PUT. This should "
220 "not happen, please report to author.\n");
221 goto unlock;
222alloc_failure:
223 goto unlock;
224}
225
d5228a4f 226/* this function is registered with the netfilter core */
76108cea 227static void ebt_log_packet(u_int8_t pf, unsigned int hooknum,
d5228a4f
BDS
228 const struct sk_buff *skb, const struct net_device *in,
229 const struct net_device *out, const struct nf_loginfo *li,
230 const char *prefix)
231{
232 struct ebt_ulog_info loginfo;
233
234 if (!li || li->type != NF_LOG_TYPE_ULOG) {
235 loginfo.nlgroup = EBT_ULOG_DEFAULT_NLGROUP;
236 loginfo.cprange = 0;
237 loginfo.qthreshold = EBT_ULOG_DEFAULT_QTHRESHOLD;
238 loginfo.prefix[0] = '\0';
239 } else {
240 loginfo.nlgroup = li->u.ulog.group;
241 loginfo.cprange = li->u.ulog.copy_len;
242 loginfo.qthreshold = li->u.ulog.qthreshold;
243 strlcpy(loginfo.prefix, prefix, sizeof(loginfo.prefix));
244 }
245
246 ebt_ulog_packet(hooknum, skb, in, out, &loginfo, prefix);
247}
248
0ac6ab1f 249static unsigned int ebt_ulog(const struct sk_buff *skb, unsigned int hooknr,
d5228a4f
BDS
250 const struct net_device *in, const struct net_device *out,
251 const void *data, unsigned int datalen)
252{
abfdf1c4 253 const struct ebt_ulog_info *uloginfo = data;
d5228a4f
BDS
254
255 ebt_ulog_packet(hooknr, skb, in, out, uloginfo, NULL);
0ac6ab1f 256 return EBT_CONTINUE;
d5228a4f
BDS
257}
258
19eda879 259static bool ebt_ulog_check(const char *tablename, unsigned int hookmask,
1da177e4
LT
260 const struct ebt_entry *e, void *data, unsigned int datalen)
261{
abfdf1c4 262 struct ebt_ulog_info *uloginfo = data;
1da177e4 263
18219d3f 264 if (uloginfo->nlgroup > 31)
19eda879 265 return false;
1da177e4
LT
266
267 uloginfo->prefix[EBT_ULOG_PREFIX_LEN - 1] = '\0';
268
269 if (uloginfo->qthreshold > EBT_ULOG_MAX_QLEN)
270 uloginfo->qthreshold = EBT_ULOG_MAX_QLEN;
271
272 return 0;
273}
274
30083c95 275static struct ebt_watcher ulog __read_mostly = {
1da177e4 276 .name = EBT_ULOG_WATCHER,
001a18d3
JE
277 .revision = 0,
278 .family = NFPROTO_BRIDGE,
1da177e4
LT
279 .watcher = ebt_ulog,
280 .check = ebt_ulog_check,
18219d3f 281 .targetsize = XT_ALIGN(sizeof(struct ebt_ulog_info)),
1da177e4
LT
282 .me = THIS_MODULE,
283};
284
7b2f9631 285static const struct nf_logger ebt_ulog_logger = {
d5228a4f
BDS
286 .name = EBT_ULOG_WATCHER,
287 .logfn = &ebt_log_packet,
288 .me = THIS_MODULE,
289};
290
65b4b4e8 291static int __init ebt_ulog_init(void)
1da177e4 292{
19eda879
JE
293 bool ret = true;
294 int i;
1da177e4
LT
295
296 if (nlbufsiz >= 128*1024) {
297 printk(KERN_NOTICE "ebt_ulog: Netlink buffer has to be <= 128kB,"
298 " please try a smaller nlbufsiz parameter.\n");
19eda879 299 return false;
1da177e4
LT
300 }
301
302 /* initialize ulog_buffers */
303 for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
e6f689db 304 setup_timer(&ulog_buffers[i].timer, ulog_timer, i);
1da177e4
LT
305 spin_lock_init(&ulog_buffers[i].lock);
306 }
307
b4b51029
EB
308 ebtulognl = netlink_kernel_create(&init_net, NETLINK_NFLOG,
309 EBT_ULOG_MAXNLGROUPS, NULL, NULL,
310 THIS_MODULE);
19eda879
JE
311 if (!ebtulognl) {
312 printk(KERN_WARNING KBUILD_MODNAME ": out of memory trying to "
313 "call netlink_kernel_create\n");
314 ret = false;
315 } else if (ebt_register_watcher(&ulog) != 0) {
b7c6ba6e 316 netlink_kernel_release(ebtulognl);
19eda879 317 }
1da177e4 318
19eda879 319 if (ret)
ee999d8b 320 nf_log_register(NFPROTO_BRIDGE, &ebt_ulog_logger);
d5228a4f 321
1da177e4
LT
322 return ret;
323}
324
65b4b4e8 325static void __exit ebt_ulog_fini(void)
1da177e4
LT
326{
327 ebt_ulog_buff_t *ub;
328 int i;
329
e92ad99c 330 nf_log_unregister(&ebt_ulog_logger);
1da177e4
LT
331 ebt_unregister_watcher(&ulog);
332 for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
333 ub = &ulog_buffers[i];
334 if (timer_pending(&ub->timer))
335 del_timer(&ub->timer);
336 spin_lock_bh(&ub->lock);
337 if (ub->skb) {
338 kfree_skb(ub->skb);
339 ub->skb = NULL;
340 }
341 spin_unlock_bh(&ub->lock);
342 }
b7c6ba6e 343 netlink_kernel_release(ebtulognl);
1da177e4
LT
344}
345
65b4b4e8
AM
346module_init(ebt_ulog_init);
347module_exit(ebt_ulog_fini);
1da177e4
LT
348MODULE_LICENSE("GPL");
349MODULE_AUTHOR("Bart De Schuymer <bdschuym@pandora.be>");
f776c4cd 350MODULE_DESCRIPTION("Ebtables: Packet logging to netlink using ULOG");