[NETFILTER]: ip_nat_snmp_basic annotations.
[linux-2.6/linux-mips.git] / net / netfilter / nfnetlink_log.c
blobbd3ffa6f1a6d525da26753a06c03368eec1d29e5
1 /*
2 * This is a module which is used for logging packets to userspace via
3 * nfetlink.
5 * (C) 2005 by Harald Welte <laforge@netfilter.org>
7 * Based on the old ipv4-only ipt_ULOG.c:
8 * (C) 2000-2004 by Harald Welte <laforge@netfilter.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * 2006-01-26 Harald Welte <laforge@netfilter.org>
15 * - Add optional local and global sequence number to detect lost
16 * events from userspace
19 #include <linux/module.h>
20 #include <linux/skbuff.h>
21 #include <linux/init.h>
22 #include <linux/ip.h>
23 #include <linux/ipv6.h>
24 #include <linux/netdevice.h>
25 #include <linux/netfilter.h>
26 #include <linux/netlink.h>
27 #include <linux/netfilter/nfnetlink.h>
28 #include <linux/netfilter/nfnetlink_log.h>
29 #include <linux/spinlock.h>
30 #include <linux/sysctl.h>
31 #include <linux/proc_fs.h>
32 #include <linux/security.h>
33 #include <linux/list.h>
34 #include <linux/jhash.h>
35 #include <linux/random.h>
36 #include <net/sock.h>
38 #include <asm/atomic.h>
40 #ifdef CONFIG_BRIDGE_NETFILTER
41 #include "../bridge/br_private.h"
42 #endif
44 #define NFULNL_NLBUFSIZ_DEFAULT NLMSG_GOODSIZE
45 #define NFULNL_TIMEOUT_DEFAULT 100 /* every second */
46 #define NFULNL_QTHRESH_DEFAULT 100 /* 100 packets */
48 #define PRINTR(x, args...) do { if (net_ratelimit()) \
49 printk(x, ## args); } while (0);
51 #if 0
52 #define UDEBUG(x, args ...) printk(KERN_DEBUG "%s(%d):%s(): " x, \
53 __FILE__, __LINE__, __FUNCTION__, \
54 ## args)
55 #else
56 #define UDEBUG(x, ...)
57 #endif
59 struct nfulnl_instance {
60 struct hlist_node hlist; /* global list of instances */
61 spinlock_t lock;
62 atomic_t use; /* use count */
64 unsigned int qlen; /* number of nlmsgs in skb */
65 struct sk_buff *skb; /* pre-allocatd skb */
66 struct nlmsghdr *lastnlh; /* netlink header of last msg in skb */
67 struct timer_list timer;
68 int peer_pid; /* PID of the peer process */
70 /* configurable parameters */
71 unsigned int flushtimeout; /* timeout until queue flush */
72 unsigned int nlbufsiz; /* netlink buffer allocation size */
73 unsigned int qthreshold; /* threshold of the queue */
74 u_int32_t copy_range;
75 u_int32_t seq; /* instance-local sequential counter */
76 u_int16_t group_num; /* number of this queue */
77 u_int16_t flags;
78 u_int8_t copy_mode;
81 static DEFINE_RWLOCK(instances_lock);
82 static atomic_t global_seq;
84 #define INSTANCE_BUCKETS 16
85 static struct hlist_head instance_table[INSTANCE_BUCKETS];
86 static unsigned int hash_init;
88 static inline u_int8_t instance_hashfn(u_int16_t group_num)
90 return ((group_num & 0xff) % INSTANCE_BUCKETS);
93 static struct nfulnl_instance *
94 __instance_lookup(u_int16_t group_num)
96 struct hlist_head *head;
97 struct hlist_node *pos;
98 struct nfulnl_instance *inst;
100 UDEBUG("entering (group_num=%u)\n", group_num);
102 head = &instance_table[instance_hashfn(group_num)];
103 hlist_for_each_entry(inst, pos, head, hlist) {
104 if (inst->group_num == group_num)
105 return inst;
107 return NULL;
110 static inline void
111 instance_get(struct nfulnl_instance *inst)
113 atomic_inc(&inst->use);
116 static struct nfulnl_instance *
117 instance_lookup_get(u_int16_t group_num)
119 struct nfulnl_instance *inst;
121 read_lock_bh(&instances_lock);
122 inst = __instance_lookup(group_num);
123 if (inst)
124 instance_get(inst);
125 read_unlock_bh(&instances_lock);
127 return inst;
130 static void
131 instance_put(struct nfulnl_instance *inst)
133 if (inst && atomic_dec_and_test(&inst->use)) {
134 UDEBUG("kfree(inst=%p)\n", inst);
135 kfree(inst);
139 static void nfulnl_timer(unsigned long data);
141 static struct nfulnl_instance *
142 instance_create(u_int16_t group_num, int pid)
144 struct nfulnl_instance *inst;
146 UDEBUG("entering (group_num=%u, pid=%d)\n", group_num,
147 pid);
149 write_lock_bh(&instances_lock);
150 if (__instance_lookup(group_num)) {
151 inst = NULL;
152 UDEBUG("aborting, instance already exists\n");
153 goto out_unlock;
156 inst = kzalloc(sizeof(*inst), GFP_ATOMIC);
157 if (!inst)
158 goto out_unlock;
160 INIT_HLIST_NODE(&inst->hlist);
161 spin_lock_init(&inst->lock);
162 /* needs to be two, since we _put() after creation */
163 atomic_set(&inst->use, 2);
165 init_timer(&inst->timer);
166 inst->timer.function = nfulnl_timer;
167 inst->timer.data = (unsigned long)inst;
168 /* don't start timer yet. (re)start it with every packet */
170 inst->peer_pid = pid;
171 inst->group_num = group_num;
173 inst->qthreshold = NFULNL_QTHRESH_DEFAULT;
174 inst->flushtimeout = NFULNL_TIMEOUT_DEFAULT;
175 inst->nlbufsiz = NFULNL_NLBUFSIZ_DEFAULT;
176 inst->copy_mode = NFULNL_COPY_PACKET;
177 inst->copy_range = 0xffff;
179 if (!try_module_get(THIS_MODULE))
180 goto out_free;
182 hlist_add_head(&inst->hlist,
183 &instance_table[instance_hashfn(group_num)]);
185 UDEBUG("newly added node: %p, next=%p\n", &inst->hlist,
186 inst->hlist.next);
188 write_unlock_bh(&instances_lock);
190 return inst;
192 out_free:
193 instance_put(inst);
194 out_unlock:
195 write_unlock_bh(&instances_lock);
196 return NULL;
199 static int __nfulnl_send(struct nfulnl_instance *inst);
201 static void
202 _instance_destroy2(struct nfulnl_instance *inst, int lock)
204 /* first pull it out of the global list */
205 if (lock)
206 write_lock_bh(&instances_lock);
208 UDEBUG("removing instance %p (queuenum=%u) from hash\n",
209 inst, inst->group_num);
211 hlist_del(&inst->hlist);
213 if (lock)
214 write_unlock_bh(&instances_lock);
216 /* then flush all pending packets from skb */
218 spin_lock_bh(&inst->lock);
219 if (inst->skb) {
220 if (inst->qlen)
221 __nfulnl_send(inst);
222 if (inst->skb) {
223 kfree_skb(inst->skb);
224 inst->skb = NULL;
227 spin_unlock_bh(&inst->lock);
229 /* and finally put the refcount */
230 instance_put(inst);
232 module_put(THIS_MODULE);
235 static inline void
236 __instance_destroy(struct nfulnl_instance *inst)
238 _instance_destroy2(inst, 0);
241 static inline void
242 instance_destroy(struct nfulnl_instance *inst)
244 _instance_destroy2(inst, 1);
247 static int
248 nfulnl_set_mode(struct nfulnl_instance *inst, u_int8_t mode,
249 unsigned int range)
251 int status = 0;
253 spin_lock_bh(&inst->lock);
255 switch (mode) {
256 case NFULNL_COPY_NONE:
257 case NFULNL_COPY_META:
258 inst->copy_mode = mode;
259 inst->copy_range = 0;
260 break;
262 case NFULNL_COPY_PACKET:
263 inst->copy_mode = mode;
264 /* we're using struct nfattr which has 16bit nfa_len */
265 if (range > 0xffff)
266 inst->copy_range = 0xffff;
267 else
268 inst->copy_range = range;
269 break;
271 default:
272 status = -EINVAL;
273 break;
276 spin_unlock_bh(&inst->lock);
278 return status;
281 static int
282 nfulnl_set_nlbufsiz(struct nfulnl_instance *inst, u_int32_t nlbufsiz)
284 int status;
286 spin_lock_bh(&inst->lock);
287 if (nlbufsiz < NFULNL_NLBUFSIZ_DEFAULT)
288 status = -ERANGE;
289 else if (nlbufsiz > 131072)
290 status = -ERANGE;
291 else {
292 inst->nlbufsiz = nlbufsiz;
293 status = 0;
295 spin_unlock_bh(&inst->lock);
297 return status;
300 static int
301 nfulnl_set_timeout(struct nfulnl_instance *inst, u_int32_t timeout)
303 spin_lock_bh(&inst->lock);
304 inst->flushtimeout = timeout;
305 spin_unlock_bh(&inst->lock);
307 return 0;
310 static int
311 nfulnl_set_qthresh(struct nfulnl_instance *inst, u_int32_t qthresh)
313 spin_lock_bh(&inst->lock);
314 inst->qthreshold = qthresh;
315 spin_unlock_bh(&inst->lock);
317 return 0;
320 static int
321 nfulnl_set_flags(struct nfulnl_instance *inst, u_int16_t flags)
323 spin_lock_bh(&inst->lock);
324 inst->flags = flags;
325 spin_unlock_bh(&inst->lock);
327 return 0;
330 static struct sk_buff *nfulnl_alloc_skb(unsigned int inst_size,
331 unsigned int pkt_size)
333 struct sk_buff *skb;
334 unsigned int n;
336 UDEBUG("entered (%u, %u)\n", inst_size, pkt_size);
338 /* alloc skb which should be big enough for a whole multipart
339 * message. WARNING: has to be <= 128k due to slab restrictions */
341 n = max(inst_size, pkt_size);
342 skb = alloc_skb(n, GFP_ATOMIC);
343 if (!skb) {
344 PRINTR("nfnetlink_log: can't alloc whole buffer (%u bytes)\n",
345 inst_size);
347 if (n > pkt_size) {
348 /* try to allocate only as much as we need for current
349 * packet */
351 skb = alloc_skb(pkt_size, GFP_ATOMIC);
352 if (!skb)
353 PRINTR("nfnetlink_log: can't even alloc %u "
354 "bytes\n", pkt_size);
358 return skb;
361 static int
362 __nfulnl_send(struct nfulnl_instance *inst)
364 int status;
366 if (timer_pending(&inst->timer))
367 del_timer(&inst->timer);
369 if (!inst->skb)
370 return 0;
372 if (inst->qlen > 1)
373 inst->lastnlh->nlmsg_type = NLMSG_DONE;
375 status = nfnetlink_unicast(inst->skb, inst->peer_pid, MSG_DONTWAIT);
376 if (status < 0) {
377 UDEBUG("netlink_unicast() failed\n");
378 /* FIXME: statistics */
381 inst->qlen = 0;
382 inst->skb = NULL;
383 inst->lastnlh = NULL;
385 return status;
388 static void nfulnl_timer(unsigned long data)
390 struct nfulnl_instance *inst = (struct nfulnl_instance *)data;
392 UDEBUG("timer function called, flushing buffer\n");
394 spin_lock_bh(&inst->lock);
395 __nfulnl_send(inst);
396 instance_put(inst);
397 spin_unlock_bh(&inst->lock);
400 /* This is an inline function, we don't really care about a long
401 * list of arguments */
402 static inline int
403 __build_packet_message(struct nfulnl_instance *inst,
404 const struct sk_buff *skb,
405 unsigned int data_len,
406 unsigned int pf,
407 unsigned int hooknum,
408 const struct net_device *indev,
409 const struct net_device *outdev,
410 const struct nf_loginfo *li,
411 const char *prefix)
413 unsigned char *old_tail;
414 struct nfulnl_msg_packet_hdr pmsg;
415 struct nlmsghdr *nlh;
416 struct nfgenmsg *nfmsg;
417 __be32 tmp_uint;
419 UDEBUG("entered\n");
421 old_tail = inst->skb->tail;
422 nlh = NLMSG_PUT(inst->skb, 0, 0,
423 NFNL_SUBSYS_ULOG << 8 | NFULNL_MSG_PACKET,
424 sizeof(struct nfgenmsg));
425 nfmsg = NLMSG_DATA(nlh);
426 nfmsg->nfgen_family = pf;
427 nfmsg->version = NFNETLINK_V0;
428 nfmsg->res_id = htons(inst->group_num);
430 pmsg.hw_protocol = skb->protocol;
431 pmsg.hook = hooknum;
433 NFA_PUT(inst->skb, NFULA_PACKET_HDR, sizeof(pmsg), &pmsg);
435 if (prefix) {
436 int slen = strlen(prefix);
437 if (slen > NFULNL_PREFIXLEN)
438 slen = NFULNL_PREFIXLEN;
439 NFA_PUT(inst->skb, NFULA_PREFIX, slen, prefix);
442 if (indev) {
443 tmp_uint = htonl(indev->ifindex);
444 #ifndef CONFIG_BRIDGE_NETFILTER
445 NFA_PUT(inst->skb, NFULA_IFINDEX_INDEV, sizeof(tmp_uint),
446 &tmp_uint);
447 #else
448 if (pf == PF_BRIDGE) {
449 /* Case 1: outdev is physical input device, we need to
450 * look for bridge group (when called from
451 * netfilter_bridge) */
452 NFA_PUT(inst->skb, NFULA_IFINDEX_PHYSINDEV,
453 sizeof(tmp_uint), &tmp_uint);
454 /* this is the bridge group "brX" */
455 tmp_uint = htonl(indev->br_port->br->dev->ifindex);
456 NFA_PUT(inst->skb, NFULA_IFINDEX_INDEV,
457 sizeof(tmp_uint), &tmp_uint);
458 } else {
459 /* Case 2: indev is bridge group, we need to look for
460 * physical device (when called from ipv4) */
461 NFA_PUT(inst->skb, NFULA_IFINDEX_INDEV,
462 sizeof(tmp_uint), &tmp_uint);
463 if (skb->nf_bridge && skb->nf_bridge->physindev) {
464 tmp_uint =
465 htonl(skb->nf_bridge->physindev->ifindex);
466 NFA_PUT(inst->skb, NFULA_IFINDEX_PHYSINDEV,
467 sizeof(tmp_uint), &tmp_uint);
470 #endif
473 if (outdev) {
474 tmp_uint = htonl(outdev->ifindex);
475 #ifndef CONFIG_BRIDGE_NETFILTER
476 NFA_PUT(inst->skb, NFULA_IFINDEX_OUTDEV, sizeof(tmp_uint),
477 &tmp_uint);
478 #else
479 if (pf == PF_BRIDGE) {
480 /* Case 1: outdev is physical output device, we need to
481 * look for bridge group (when called from
482 * netfilter_bridge) */
483 NFA_PUT(inst->skb, NFULA_IFINDEX_PHYSOUTDEV,
484 sizeof(tmp_uint), &tmp_uint);
485 /* this is the bridge group "brX" */
486 tmp_uint = htonl(outdev->br_port->br->dev->ifindex);
487 NFA_PUT(inst->skb, NFULA_IFINDEX_OUTDEV,
488 sizeof(tmp_uint), &tmp_uint);
489 } else {
490 /* Case 2: indev is a bridge group, we need to look
491 * for physical device (when called from ipv4) */
492 NFA_PUT(inst->skb, NFULA_IFINDEX_OUTDEV,
493 sizeof(tmp_uint), &tmp_uint);
494 if (skb->nf_bridge) {
495 tmp_uint =
496 htonl(skb->nf_bridge->physoutdev->ifindex);
497 NFA_PUT(inst->skb, NFULA_IFINDEX_PHYSOUTDEV,
498 sizeof(tmp_uint), &tmp_uint);
501 #endif
504 if (skb->mark) {
505 tmp_uint = htonl(skb->mark);
506 NFA_PUT(inst->skb, NFULA_MARK, sizeof(tmp_uint), &tmp_uint);
509 if (indev && skb->dev && skb->dev->hard_header_parse) {
510 struct nfulnl_msg_packet_hw phw;
511 int len = skb->dev->hard_header_parse((struct sk_buff *)skb,
512 phw.hw_addr);
513 phw.hw_addrlen = htons(len);
514 NFA_PUT(inst->skb, NFULA_HWADDR, sizeof(phw), &phw);
517 if (skb->tstamp.off_sec) {
518 struct nfulnl_msg_packet_timestamp ts;
520 ts.sec = cpu_to_be64(skb->tstamp.off_sec);
521 ts.usec = cpu_to_be64(skb->tstamp.off_usec);
523 NFA_PUT(inst->skb, NFULA_TIMESTAMP, sizeof(ts), &ts);
526 /* UID */
527 if (skb->sk) {
528 read_lock_bh(&skb->sk->sk_callback_lock);
529 if (skb->sk->sk_socket && skb->sk->sk_socket->file) {
530 __be32 uid = htonl(skb->sk->sk_socket->file->f_uid);
531 /* need to unlock here since NFA_PUT may goto */
532 read_unlock_bh(&skb->sk->sk_callback_lock);
533 NFA_PUT(inst->skb, NFULA_UID, sizeof(uid), &uid);
534 } else
535 read_unlock_bh(&skb->sk->sk_callback_lock);
538 /* local sequence number */
539 if (inst->flags & NFULNL_CFG_F_SEQ) {
540 tmp_uint = htonl(inst->seq++);
541 NFA_PUT(inst->skb, NFULA_SEQ, sizeof(tmp_uint), &tmp_uint);
543 /* global sequence number */
544 if (inst->flags & NFULNL_CFG_F_SEQ_GLOBAL) {
545 tmp_uint = htonl(atomic_inc_return(&global_seq));
546 NFA_PUT(inst->skb, NFULA_SEQ_GLOBAL, sizeof(tmp_uint), &tmp_uint);
549 if (data_len) {
550 struct nfattr *nfa;
551 int size = NFA_LENGTH(data_len);
553 if (skb_tailroom(inst->skb) < (int)NFA_SPACE(data_len)) {
554 printk(KERN_WARNING "nfnetlink_log: no tailroom!\n");
555 goto nlmsg_failure;
558 nfa = (struct nfattr *)skb_put(inst->skb, NFA_ALIGN(size));
559 nfa->nfa_type = NFULA_PAYLOAD;
560 nfa->nfa_len = size;
562 if (skb_copy_bits(skb, 0, NFA_DATA(nfa), data_len))
563 BUG();
566 nlh->nlmsg_len = inst->skb->tail - old_tail;
567 return 0;
569 nlmsg_failure:
570 UDEBUG("nlmsg_failure\n");
571 nfattr_failure:
572 PRINTR(KERN_ERR "nfnetlink_log: error creating log nlmsg\n");
573 return -1;
576 #define RCV_SKB_FAIL(err) do { netlink_ack(skb, nlh, (err)); return; } while (0)
578 static struct nf_loginfo default_loginfo = {
579 .type = NF_LOG_TYPE_ULOG,
580 .u = {
581 .ulog = {
582 .copy_len = 0xffff,
583 .group = 0,
584 .qthreshold = 1,
589 /* log handler for internal netfilter logging api */
590 static void
591 nfulnl_log_packet(unsigned int pf,
592 unsigned int hooknum,
593 const struct sk_buff *skb,
594 const struct net_device *in,
595 const struct net_device *out,
596 const struct nf_loginfo *li_user,
597 const char *prefix)
599 unsigned int size, data_len;
600 struct nfulnl_instance *inst;
601 const struct nf_loginfo *li;
602 unsigned int qthreshold;
603 unsigned int nlbufsiz;
605 if (li_user && li_user->type == NF_LOG_TYPE_ULOG)
606 li = li_user;
607 else
608 li = &default_loginfo;
610 inst = instance_lookup_get(li->u.ulog.group);
611 if (!inst)
612 inst = instance_lookup_get(0);
613 if (!inst) {
614 PRINTR("nfnetlink_log: trying to log packet, "
615 "but no instance for group %u\n", li->u.ulog.group);
616 return;
619 /* all macros expand to constant values at compile time */
620 /* FIXME: do we want to make the size calculation conditional based on
621 * what is actually present? way more branches and checks, but more
622 * memory efficient... */
623 size = NLMSG_SPACE(sizeof(struct nfgenmsg))
624 + NFA_SPACE(sizeof(struct nfulnl_msg_packet_hdr))
625 + NFA_SPACE(sizeof(u_int32_t)) /* ifindex */
626 + NFA_SPACE(sizeof(u_int32_t)) /* ifindex */
627 #ifdef CONFIG_BRIDGE_NETFILTER
628 + NFA_SPACE(sizeof(u_int32_t)) /* ifindex */
629 + NFA_SPACE(sizeof(u_int32_t)) /* ifindex */
630 #endif
631 + NFA_SPACE(sizeof(u_int32_t)) /* mark */
632 + NFA_SPACE(sizeof(u_int32_t)) /* uid */
633 + NFA_SPACE(NFULNL_PREFIXLEN) /* prefix */
634 + NFA_SPACE(sizeof(struct nfulnl_msg_packet_hw))
635 + NFA_SPACE(sizeof(struct nfulnl_msg_packet_timestamp));
637 UDEBUG("initial size=%u\n", size);
639 spin_lock_bh(&inst->lock);
641 if (inst->flags & NFULNL_CFG_F_SEQ)
642 size += NFA_SPACE(sizeof(u_int32_t));
643 if (inst->flags & NFULNL_CFG_F_SEQ_GLOBAL)
644 size += NFA_SPACE(sizeof(u_int32_t));
646 qthreshold = inst->qthreshold;
647 /* per-rule qthreshold overrides per-instance */
648 if (qthreshold > li->u.ulog.qthreshold)
649 qthreshold = li->u.ulog.qthreshold;
651 switch (inst->copy_mode) {
652 case NFULNL_COPY_META:
653 case NFULNL_COPY_NONE:
654 data_len = 0;
655 break;
657 case NFULNL_COPY_PACKET:
658 if (inst->copy_range == 0
659 || inst->copy_range > skb->len)
660 data_len = skb->len;
661 else
662 data_len = inst->copy_range;
664 size += NFA_SPACE(data_len);
665 UDEBUG("copy_packet, therefore size now %u\n", size);
666 break;
668 default:
669 spin_unlock_bh(&inst->lock);
670 instance_put(inst);
671 return;
674 if (size > inst->nlbufsiz)
675 nlbufsiz = size;
676 else
677 nlbufsiz = inst->nlbufsiz;
679 if (!inst->skb) {
680 if (!(inst->skb = nfulnl_alloc_skb(nlbufsiz, size))) {
681 UDEBUG("error in nfulnl_alloc_skb(%u, %u)\n",
682 inst->nlbufsiz, size);
683 goto alloc_failure;
685 } else if (inst->qlen >= qthreshold ||
686 size > skb_tailroom(inst->skb)) {
687 /* either the queue len is too high or we don't have
688 * enough room in the skb left. flush to userspace. */
689 UDEBUG("flushing old skb\n");
691 __nfulnl_send(inst);
693 if (!(inst->skb = nfulnl_alloc_skb(nlbufsiz, size))) {
694 UDEBUG("error in nfulnl_alloc_skb(%u, %u)\n",
695 inst->nlbufsiz, size);
696 goto alloc_failure;
700 UDEBUG("qlen %d, qthreshold %d\n", inst->qlen, qthreshold);
701 inst->qlen++;
703 __build_packet_message(inst, skb, data_len, pf,
704 hooknum, in, out, li, prefix);
706 /* timer_pending always called within inst->lock, so there
707 * is no chance of a race here */
708 if (!timer_pending(&inst->timer)) {
709 instance_get(inst);
710 inst->timer.expires = jiffies + (inst->flushtimeout*HZ/100);
711 add_timer(&inst->timer);
713 spin_unlock_bh(&inst->lock);
715 return;
717 alloc_failure:
718 spin_unlock_bh(&inst->lock);
719 instance_put(inst);
720 UDEBUG("error allocating skb\n");
721 /* FIXME: statistics */
724 static int
725 nfulnl_rcv_nl_event(struct notifier_block *this,
726 unsigned long event, void *ptr)
728 struct netlink_notify *n = ptr;
730 if (event == NETLINK_URELEASE &&
731 n->protocol == NETLINK_NETFILTER && n->pid) {
732 int i;
734 /* destroy all instances for this pid */
735 write_lock_bh(&instances_lock);
736 for (i = 0; i < INSTANCE_BUCKETS; i++) {
737 struct hlist_node *tmp, *t2;
738 struct nfulnl_instance *inst;
739 struct hlist_head *head = &instance_table[i];
741 hlist_for_each_entry_safe(inst, tmp, t2, head, hlist) {
742 UDEBUG("node = %p\n", inst);
743 if (n->pid == inst->peer_pid)
744 __instance_destroy(inst);
747 write_unlock_bh(&instances_lock);
749 return NOTIFY_DONE;
752 static struct notifier_block nfulnl_rtnl_notifier = {
753 .notifier_call = nfulnl_rcv_nl_event,
756 static int
757 nfulnl_recv_unsupp(struct sock *ctnl, struct sk_buff *skb,
758 struct nlmsghdr *nlh, struct nfattr *nfqa[], int *errp)
760 return -ENOTSUPP;
763 static struct nf_logger nfulnl_logger = {
764 .name = "nfnetlink_log",
765 .logfn = &nfulnl_log_packet,
766 .me = THIS_MODULE,
769 static const int nfula_min[NFULA_MAX] = {
770 [NFULA_PACKET_HDR-1] = sizeof(struct nfulnl_msg_packet_hdr),
771 [NFULA_MARK-1] = sizeof(u_int32_t),
772 [NFULA_TIMESTAMP-1] = sizeof(struct nfulnl_msg_packet_timestamp),
773 [NFULA_IFINDEX_INDEV-1] = sizeof(u_int32_t),
774 [NFULA_IFINDEX_OUTDEV-1]= sizeof(u_int32_t),
775 [NFULA_IFINDEX_PHYSINDEV-1] = sizeof(u_int32_t),
776 [NFULA_IFINDEX_PHYSOUTDEV-1] = sizeof(u_int32_t),
777 [NFULA_HWADDR-1] = sizeof(struct nfulnl_msg_packet_hw),
778 [NFULA_PAYLOAD-1] = 0,
779 [NFULA_PREFIX-1] = 0,
780 [NFULA_UID-1] = sizeof(u_int32_t),
781 [NFULA_SEQ-1] = sizeof(u_int32_t),
782 [NFULA_SEQ_GLOBAL-1] = sizeof(u_int32_t),
785 static const int nfula_cfg_min[NFULA_CFG_MAX] = {
786 [NFULA_CFG_CMD-1] = sizeof(struct nfulnl_msg_config_cmd),
787 [NFULA_CFG_MODE-1] = sizeof(struct nfulnl_msg_config_mode),
788 [NFULA_CFG_TIMEOUT-1] = sizeof(u_int32_t),
789 [NFULA_CFG_QTHRESH-1] = sizeof(u_int32_t),
790 [NFULA_CFG_NLBUFSIZ-1] = sizeof(u_int32_t),
791 [NFULA_CFG_FLAGS-1] = sizeof(u_int16_t),
794 static int
795 nfulnl_recv_config(struct sock *ctnl, struct sk_buff *skb,
796 struct nlmsghdr *nlh, struct nfattr *nfula[], int *errp)
798 struct nfgenmsg *nfmsg = NLMSG_DATA(nlh);
799 u_int16_t group_num = ntohs(nfmsg->res_id);
800 struct nfulnl_instance *inst;
801 int ret = 0;
803 UDEBUG("entering for msg %u\n", NFNL_MSG_TYPE(nlh->nlmsg_type));
805 if (nfattr_bad_size(nfula, NFULA_CFG_MAX, nfula_cfg_min)) {
806 UDEBUG("bad attribute size\n");
807 return -EINVAL;
810 inst = instance_lookup_get(group_num);
811 if (nfula[NFULA_CFG_CMD-1]) {
812 u_int8_t pf = nfmsg->nfgen_family;
813 struct nfulnl_msg_config_cmd *cmd;
814 cmd = NFA_DATA(nfula[NFULA_CFG_CMD-1]);
815 UDEBUG("found CFG_CMD for\n");
817 switch (cmd->command) {
818 case NFULNL_CFG_CMD_BIND:
819 if (inst) {
820 ret = -EBUSY;
821 goto out_put;
824 inst = instance_create(group_num,
825 NETLINK_CB(skb).pid);
826 if (!inst) {
827 ret = -EINVAL;
828 goto out_put;
830 break;
831 case NFULNL_CFG_CMD_UNBIND:
832 if (!inst) {
833 ret = -ENODEV;
834 goto out_put;
837 if (inst->peer_pid != NETLINK_CB(skb).pid) {
838 ret = -EPERM;
839 goto out_put;
842 instance_destroy(inst);
843 break;
844 case NFULNL_CFG_CMD_PF_BIND:
845 UDEBUG("registering log handler for pf=%u\n", pf);
846 ret = nf_log_register(pf, &nfulnl_logger);
847 break;
848 case NFULNL_CFG_CMD_PF_UNBIND:
849 UDEBUG("unregistering log handler for pf=%u\n", pf);
850 /* This is a bug and a feature. We cannot unregister
851 * other handlers, like nfnetlink_inst can */
852 nf_log_unregister_pf(pf);
853 break;
854 default:
855 ret = -EINVAL;
856 break;
858 } else {
859 if (!inst) {
860 UDEBUG("no config command, and no instance for "
861 "group=%u pid=%u =>ENOENT\n",
862 group_num, NETLINK_CB(skb).pid);
863 ret = -ENOENT;
864 goto out_put;
867 if (inst->peer_pid != NETLINK_CB(skb).pid) {
868 UDEBUG("no config command, and wrong pid\n");
869 ret = -EPERM;
870 goto out_put;
874 if (nfula[NFULA_CFG_MODE-1]) {
875 struct nfulnl_msg_config_mode *params;
876 params = NFA_DATA(nfula[NFULA_CFG_MODE-1]);
878 nfulnl_set_mode(inst, params->copy_mode,
879 ntohl(params->copy_range));
882 if (nfula[NFULA_CFG_TIMEOUT-1]) {
883 __be32 timeout =
884 *(__be32 *)NFA_DATA(nfula[NFULA_CFG_TIMEOUT-1]);
886 nfulnl_set_timeout(inst, ntohl(timeout));
889 if (nfula[NFULA_CFG_NLBUFSIZ-1]) {
890 __be32 nlbufsiz =
891 *(__be32 *)NFA_DATA(nfula[NFULA_CFG_NLBUFSIZ-1]);
893 nfulnl_set_nlbufsiz(inst, ntohl(nlbufsiz));
896 if (nfula[NFULA_CFG_QTHRESH-1]) {
897 __be32 qthresh =
898 *(__be32 *)NFA_DATA(nfula[NFULA_CFG_QTHRESH-1]);
900 nfulnl_set_qthresh(inst, ntohl(qthresh));
903 if (nfula[NFULA_CFG_FLAGS-1]) {
904 __be16 flags =
905 *(__be16 *)NFA_DATA(nfula[NFULA_CFG_FLAGS-1]);
906 nfulnl_set_flags(inst, ntohs(flags));
909 out_put:
910 instance_put(inst);
911 return ret;
914 static struct nfnl_callback nfulnl_cb[NFULNL_MSG_MAX] = {
915 [NFULNL_MSG_PACKET] = { .call = nfulnl_recv_unsupp,
916 .attr_count = NFULA_MAX, },
917 [NFULNL_MSG_CONFIG] = { .call = nfulnl_recv_config,
918 .attr_count = NFULA_CFG_MAX, },
921 static struct nfnetlink_subsystem nfulnl_subsys = {
922 .name = "log",
923 .subsys_id = NFNL_SUBSYS_ULOG,
924 .cb_count = NFULNL_MSG_MAX,
925 .cb = nfulnl_cb,
928 #ifdef CONFIG_PROC_FS
929 struct iter_state {
930 unsigned int bucket;
933 static struct hlist_node *get_first(struct seq_file *seq)
935 struct iter_state *st = seq->private;
937 if (!st)
938 return NULL;
940 for (st->bucket = 0; st->bucket < INSTANCE_BUCKETS; st->bucket++) {
941 if (!hlist_empty(&instance_table[st->bucket]))
942 return instance_table[st->bucket].first;
944 return NULL;
947 static struct hlist_node *get_next(struct seq_file *seq, struct hlist_node *h)
949 struct iter_state *st = seq->private;
951 h = h->next;
952 while (!h) {
953 if (++st->bucket >= INSTANCE_BUCKETS)
954 return NULL;
956 h = instance_table[st->bucket].first;
958 return h;
961 static struct hlist_node *get_idx(struct seq_file *seq, loff_t pos)
963 struct hlist_node *head;
964 head = get_first(seq);
966 if (head)
967 while (pos && (head = get_next(seq, head)))
968 pos--;
969 return pos ? NULL : head;
972 static void *seq_start(struct seq_file *seq, loff_t *pos)
974 read_lock_bh(&instances_lock);
975 return get_idx(seq, *pos);
978 static void *seq_next(struct seq_file *s, void *v, loff_t *pos)
980 (*pos)++;
981 return get_next(s, v);
984 static void seq_stop(struct seq_file *s, void *v)
986 read_unlock_bh(&instances_lock);
989 static int seq_show(struct seq_file *s, void *v)
991 const struct nfulnl_instance *inst = v;
993 return seq_printf(s, "%5d %6d %5d %1d %5d %6d %2d\n",
994 inst->group_num,
995 inst->peer_pid, inst->qlen,
996 inst->copy_mode, inst->copy_range,
997 inst->flushtimeout, atomic_read(&inst->use));
1000 static struct seq_operations nful_seq_ops = {
1001 .start = seq_start,
1002 .next = seq_next,
1003 .stop = seq_stop,
1004 .show = seq_show,
1007 static int nful_open(struct inode *inode, struct file *file)
1009 struct seq_file *seq;
1010 struct iter_state *is;
1011 int ret;
1013 is = kzalloc(sizeof(*is), GFP_KERNEL);
1014 if (!is)
1015 return -ENOMEM;
1016 ret = seq_open(file, &nful_seq_ops);
1017 if (ret < 0)
1018 goto out_free;
1019 seq = file->private_data;
1020 seq->private = is;
1021 return ret;
1022 out_free:
1023 kfree(is);
1024 return ret;
1027 static struct file_operations nful_file_ops = {
1028 .owner = THIS_MODULE,
1029 .open = nful_open,
1030 .read = seq_read,
1031 .llseek = seq_lseek,
1032 .release = seq_release_private,
1035 #endif /* PROC_FS */
1037 static int __init nfnetlink_log_init(void)
1039 int i, status = -ENOMEM;
1040 #ifdef CONFIG_PROC_FS
1041 struct proc_dir_entry *proc_nful;
1042 #endif
1044 for (i = 0; i < INSTANCE_BUCKETS; i++)
1045 INIT_HLIST_HEAD(&instance_table[i]);
1047 /* it's not really all that important to have a random value, so
1048 * we can do this from the init function, even if there hasn't
1049 * been that much entropy yet */
1050 get_random_bytes(&hash_init, sizeof(hash_init));
1052 netlink_register_notifier(&nfulnl_rtnl_notifier);
1053 status = nfnetlink_subsys_register(&nfulnl_subsys);
1054 if (status < 0) {
1055 printk(KERN_ERR "log: failed to create netlink socket\n");
1056 goto cleanup_netlink_notifier;
1059 #ifdef CONFIG_PROC_FS
1060 proc_nful = create_proc_entry("nfnetlink_log", 0440,
1061 proc_net_netfilter);
1062 if (!proc_nful)
1063 goto cleanup_subsys;
1064 proc_nful->proc_fops = &nful_file_ops;
1065 #endif
1066 return status;
1068 #ifdef CONFIG_PROC_FS
1069 cleanup_subsys:
1070 nfnetlink_subsys_unregister(&nfulnl_subsys);
1071 #endif
1072 cleanup_netlink_notifier:
1073 netlink_unregister_notifier(&nfulnl_rtnl_notifier);
1074 return status;
1077 static void __exit nfnetlink_log_fini(void)
1079 nf_log_unregister_logger(&nfulnl_logger);
1080 #ifdef CONFIG_PROC_FS
1081 remove_proc_entry("nfnetlink_log", proc_net_netfilter);
1082 #endif
1083 nfnetlink_subsys_unregister(&nfulnl_subsys);
1084 netlink_unregister_notifier(&nfulnl_rtnl_notifier);
1087 MODULE_DESCRIPTION("netfilter userspace logging");
1088 MODULE_AUTHOR("Harald Welte <laforge@netfilter.org>");
1089 MODULE_LICENSE("GPL");
1090 MODULE_ALIAS_NFNL_SUBSYS(NFNL_SUBSYS_ULOG);
1092 module_init(nfnetlink_log_init);
1093 module_exit(nfnetlink_log_fini);