net/bridge/netfilter/ebt_ulog.c

   1 /*
   2  * netfilter module for userspace bridged Ethernet frames logging daemons
   3  *
   4  *      Authors:
   5  *      Bart De Schuymer <bdschuym@pandora.be>
   6  *      Harald Welte <laforge@netfilter.org>
   7  *
   8  *  November, 2004
   9  *
  10  * Based on ipt_ULOG.c, which is
  11  * (C) 2000-2002 by Harald Welte <laforge@netfilter.org>
  12  *
  13  * This module accepts two parameters:
  14  *
  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>
  32 #include <linux/config.h>
  33 #include <linux/spinlock.h>
  34 #include <linux/socket.h>
  35 #include <linux/skbuff.h>
  36 #include <linux/kernel.h>
  37 #include <linux/timer.h>
  38 #include <linux/netlink.h>
  39 #include <linux/netdevice.h>
  40 #include <linux/module.h>
  41 #include <linux/netfilter_bridge/ebtables.h>
  42 #include <linux/netfilter_bridge/ebt_ulog.h>
  43 #include <net/sock.h>
  44 #include "../br_private.h"
  45
  46 #define PRINTR(format, args...) do { if (net_ratelimit()) \
  47                                 printk(format , ## args); } while (0)
  48
  49 static unsigned int nlbufsiz = NLMSG_GOODSIZE;
  50 module_param(nlbufsiz, uint, 0600);
  51 MODULE_PARM_DESC(nlbufsiz, "netlink buffer size (number of bytes) "
  52                            "(defaults to 4096)");
  53
  54 static unsigned int flushtimeout = 10;
  55 module_param(flushtimeout, uint, 0600);
  56 MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths ofa second) "
  57                                "(defaults to 10)");
  58
  59 typedef 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
  67 static ebt_ulog_buff_t ulog_buffers[EBT_ULOG_MAXNLGROUPS];
  68 static struct sock *ebtulognl;
  69
  70 /* send one ulog_buff_t to userspace */
  71 static 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
  78         if (!ub->skb)
  79                 return;
  80
  81         /* last nlmsg needs NLMSG_DONE */
  82         if (ub->qlen > 1)
  83                 ub->lastnlh->nlmsg_type = NLMSG_DONE;
  84
  85         if (!ub->skb)
  86                 return;
  87
  88         NETLINK_CB(ub->skb).dst_group = nlgroup + 1;
  89         netlink_broadcast(ebtulognl, ub->skb, 0, nlgroup + 1, GFP_ATOMIC);
  90
  91         ub->qlen = 0;
  92         ub->skb = NULL;
  93 }
  94
  95 /* timer function to flush queue in flushtimeout time */
  96 static void ulog_timer(unsigned long data)
  97 {
  98         spin_lock_bh(&ulog_buffers[data].lock);
  99         if (ulog_buffers[data].skb)
 100                 ulog_send(data);
 101         spin_unlock_bh(&ulog_buffers[data].lock);
 102 }
 103
 104 static struct sk_buff *ulog_alloc_skb(unsigned int size)
 105 {
 106         struct sk_buff *skb;
 107         unsigned int n;
 108
 109         n = max(size, nlbufsiz);
 110         skb = alloc_skb(n, GFP_ATOMIC);
 111         if (!skb) {
 112                 PRINTR(KERN_ERR "ebt_ulog: can't alloc whole buffer "
 113                        "of size %ub!\n", n);
 114                 if (n > size) {
 115                         /* try to allocate only as much as we need for
 116                          * current packet */
 117                         skb = alloc_skb(size, GFP_ATOMIC);
 118                         if (!skb)
 119                                 PRINTR(KERN_ERR "ebt_ulog: can't even allocate "
 120                                        "buffer of size %ub\n", size);
 121                 }
 122         }
 123
 124         return skb;
 125 }
 126
 127 static void ebt_ulog_packet(unsigned int hooknr, const struct sk_buff *skb,
 128    const struct net_device *in, const struct net_device *out,
 129    const struct ebt_ulog_info *uloginfo, const char *prefix)
 130 {
 131         ebt_ulog_packet_msg_t *pm;
 132         size_t size, copy_len;
 133         struct nlmsghdr *nlh;
 134         unsigned int group = uloginfo->nlgroup;
 135         ebt_ulog_buff_t *ub = &ulog_buffers[group];
 136         spinlock_t *lock = &ub->lock;
 137
 138         if ((uloginfo->cprange == 0) ||
 139             (uloginfo->cprange > skb->len + ETH_HLEN))
 140                 copy_len = skb->len + ETH_HLEN;
 141         else
 142                 copy_len = uloginfo->cprange;
 143
 144         size = NLMSG_SPACE(sizeof(*pm) + copy_len);
 145         if (size > nlbufsiz) {
 146                 PRINTR("ebt_ulog: Size %Zd needed, but nlbufsiz=%d\n",
 147                        size, nlbufsiz);
 148                 return;
 149         }
 150
 151         spin_lock_bh(lock);
 152
 153         if (!ub->skb) {
 154                 if (!(ub->skb = ulog_alloc_skb(size)))
 155                         goto alloc_failure;
 156         } else if (size > skb_tailroom(ub->skb)) {
 157                 ulog_send(group);
 158
 159                 if (!(ub->skb = ulog_alloc_skb(size)))
 160                         goto alloc_failure;
 161         }
 162
 163         nlh = NLMSG_PUT(ub->skb, 0, ub->qlen, 0,
 164                         size - NLMSG_ALIGN(sizeof(*nlh)));
 165         ub->qlen++;
 166
 167         pm = NLMSG_DATA(nlh);
 168
 169         /* Fill in the ulog data */
 170         pm->version = EBT_ULOG_VERSION;
 171         do_gettimeofday(&pm->stamp);
 172         if (ub->qlen == 1)
 173                 skb_set_timestamp(ub->skb, &pm->stamp);
 174         pm->data_len = copy_len;
 175         pm->mark = skb->nfmark;
 176         pm->hook = hooknr;
 177         if (uloginfo->prefix != NULL)
 178                 strcpy(pm->prefix, uloginfo->prefix);
 179         else
 180                 *(pm->prefix) = '\0';
 181
 182         if (in) {
 183                 strcpy(pm->physindev, in->name);
 184                 /* If in isn't a bridge, then physindev==indev */
 185                 if (in->br_port)
 186                         strcpy(pm->indev, in->br_port->br->dev->name);
 187                 else
 188                         strcpy(pm->indev, in->name);
 189         } else
 190                 pm->indev[0] = pm->physindev[0] = '\0';
 191
 192         if (out) {
 193                 /* If out exists, then out is a bridge port */
 194                 strcpy(pm->physoutdev, out->name);
 195                 strcpy(pm->outdev, out->br_port->br->dev->name);
 196         } else
 197                 pm->outdev[0] = pm->physoutdev[0] = '\0';
 198
 199         if (skb_copy_bits(skb, -ETH_HLEN, pm->data, copy_len) < 0)
 200                 BUG();
 201
 202         if (ub->qlen > 1)
 203                 ub->lastnlh->nlmsg_flags |= NLM_F_MULTI;
 204
 205         ub->lastnlh = nlh;
 206
 207         if (ub->qlen >= uloginfo->qthreshold)
 208                 ulog_send(group);
 209         else if (!timer_pending(&ub->timer)) {
 210                 ub->timer.expires = jiffies + flushtimeout * HZ / 100;
 211                 add_timer(&ub->timer);
 212         }
 213
 214 unlock:
 215         spin_unlock_bh(lock);
 216
 217         return;
 218
 219 nlmsg_failure:
 220         printk(KERN_CRIT "ebt_ulog: error during NLMSG_PUT. This should "
 221                "not happen, please report to author.\n");
 222         goto unlock;
 223 alloc_failure:
 224         goto unlock;
 225 }
 226
 227 /* this function is registered with the netfilter core */
 228 static void ebt_log_packet(unsigned int pf, unsigned int hooknum,
 229    const struct sk_buff *skb, const struct net_device *in,
 230    const struct net_device *out, const struct nf_loginfo *li,
 231    const char *prefix)
 232 {
 233         struct ebt_ulog_info loginfo;
 234
 235         if (!li || li->type != NF_LOG_TYPE_ULOG) {
 236                 loginfo.nlgroup = EBT_ULOG_DEFAULT_NLGROUP;
 237                 loginfo.cprange = 0;
 238                 loginfo.qthreshold = EBT_ULOG_DEFAULT_QTHRESHOLD;
 239                 loginfo.prefix[0] = '\0';
 240         } else {
 241                 loginfo.nlgroup = li->u.ulog.group;
 242                 loginfo.cprange = li->u.ulog.copy_len;
 243                 loginfo.qthreshold = li->u.ulog.qthreshold;
 244                 strlcpy(loginfo.prefix, prefix, sizeof(loginfo.prefix));
 245         }
 246
 247         ebt_ulog_packet(hooknum, skb, in, out, &loginfo, prefix);
 248 }
 249
 250 static void ebt_ulog(const struct sk_buff *skb, unsigned int hooknr,
 251    const struct net_device *in, const struct net_device *out,
 252    const void *data, unsigned int datalen)
 253 {
 254         struct ebt_ulog_info *uloginfo = (struct ebt_ulog_info *)data;
 255
 256         ebt_ulog_packet(hooknr, skb, in, out, uloginfo, NULL);
 257 }
 258
 259
 260 static int ebt_ulog_check(const char *tablename, unsigned int hookmask,
 261    const struct ebt_entry *e, void *data, unsigned int datalen)
 262 {
 263         struct ebt_ulog_info *uloginfo = (struct ebt_ulog_info *)data;
 264
 265         if (datalen != EBT_ALIGN(sizeof(struct ebt_ulog_info)) ||
 266             uloginfo->nlgroup > 31)
 267                 return -EINVAL;
 268
 269         uloginfo->prefix[EBT_ULOG_PREFIX_LEN - 1] = '\0';
 270
 271         if (uloginfo->qthreshold > EBT_ULOG_MAX_QLEN)
 272                 uloginfo->qthreshold = EBT_ULOG_MAX_QLEN;
 273
 274         return 0;
 275 }
 276
 277 static struct ebt_watcher ulog = {
 278         .name           = EBT_ULOG_WATCHER,
 279         .watcher        = ebt_ulog,
 280         .check          = ebt_ulog_check,
 281         .me             = THIS_MODULE,
 282 };
 283
 284 static struct nf_logger ebt_ulog_logger = {
 285         .name           = EBT_ULOG_WATCHER,
 286         .logfn          = &ebt_log_packet,
 287         .me             = THIS_MODULE,
 288 };
 289
 290 static int __init init(void)
 291 {
 292         int i, ret = 0;
 293
 294         if (nlbufsiz >= 128*1024) {
 295                 printk(KERN_NOTICE "ebt_ulog: Netlink buffer has to be <= 128kB,"
 296                        " please try a smaller nlbufsiz parameter.\n");
 297                 return -EINVAL;
 298         }
 299
 300         /* initialize ulog_buffers */
 301         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 302                 init_timer(&ulog_buffers[i].timer);
 303                 ulog_buffers[i].timer.function = ulog_timer;
 304                 ulog_buffers[i].timer.data = i;
 305                 spin_lock_init(&ulog_buffers[i].lock);
 306         }
 307
 308         ebtulognl = netlink_kernel_create(NETLINK_NFLOG, EBT_ULOG_MAXNLGROUPS,
 309                                           NULL, THIS_MODULE);
 310         if (!ebtulognl)
 311                 ret = -ENOMEM;
 312         else if ((ret = ebt_register_watcher(&ulog)))
 313                 sock_release(ebtulognl->sk_socket);
 314
 315         if (nf_log_register(PF_BRIDGE, &ebt_ulog_logger) < 0) {
 316                 printk(KERN_WARNING "ebt_ulog: not logging via ulog "
 317                        "since somebody else already registered for PF_BRIDGE\n");
 318                 /* we cannot make module load fail here, since otherwise
 319                  * ebtables userspace would abort */
 320         }
 321
 322         return ret;
 323 }
 324
 325 static void __exit fini(void)
 326 {
 327         ebt_ulog_buff_t *ub;
 328         int i;
 329
 330         nf_log_unregister_logger(&ebt_ulog_logger);
 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         }
 343         sock_release(ebtulognl->sk_socket);
 344 }
 345
 346 module_init(init);
 347 module_exit(fini);
 348 MODULE_LICENSE("GPL");
 349 MODULE_AUTHOR("Bart De Schuymer <bdschuym@pandora.be>");
 350 MODULE_DESCRIPTION("ebtables userspace logging module for bridged Ethernet"
 351                    " frames");