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/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>
  39 #include <linux/module.h>
  40 #include <linux/netfilter_bridge/ebtables.h>
  41 #include <linux/netfilter_bridge/ebt_ulog.h>
  42 #include <net/sock.h>
  43 #include "../br_private.h"
  44
  45 #define PRINTR(format, args...) do { if (net_ratelimit()) \
  46                                 printk(format , ## args); } while (0)
  47
  48 static unsigned int nlbufsiz = NLMSG_GOODSIZE;
  49 module_param(nlbufsiz, uint, 0600);
  50 MODULE_PARM_DESC(nlbufsiz, "netlink buffer size (number of bytes) "
  51                            "(defaults to 4096)");
  52
  53 static unsigned int flushtimeout = 10;
  54 module_param(flushtimeout, uint, 0600);
  55 MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths ofa second) "
  56                                "(defaults to 10)");
  57
  58 typedef struct {
  59         unsigned int qlen;              /* number of nlmsgs' in the skb */
  60         struct nlmsghdr *lastnlh;       /* netlink header of last msg in skb */
  61         struct sk_buff *skb;            /* the pre-allocated skb */
  62         struct timer_list timer;        /* the timer function */
  63         spinlock_t lock;                /* the per-queue lock */
  64 } ebt_ulog_buff_t;
  65
  66 static ebt_ulog_buff_t ulog_buffers[EBT_ULOG_MAXNLGROUPS];
  67 static struct sock *ebtulognl;
  68
  69 /* send one ulog_buff_t to userspace */
  70 static void ulog_send(unsigned int nlgroup)
  71 {
  72         ebt_ulog_buff_t *ub = &ulog_buffers[nlgroup];
  73
  74         if (timer_pending(&ub->timer))
  75                 del_timer(&ub->timer);
  76
  77         if (!ub->skb)
  78                 return;
  79
  80         /* last nlmsg needs NLMSG_DONE */
  81         if (ub->qlen > 1)
  82                 ub->lastnlh->nlmsg_type = NLMSG_DONE;
  83
  84         if (!ub->skb)
  85                 return;
  86
  87         NETLINK_CB(ub->skb).dst_group = nlgroup + 1;
  88         netlink_broadcast(ebtulognl, ub->skb, 0, nlgroup + 1, GFP_ATOMIC);
  89
  90         ub->qlen = 0;
  91         ub->skb = NULL;
  92 }
  93
  94 /* timer function to flush queue in flushtimeout time */
  95 static void ulog_timer(unsigned long data)
  96 {
  97         spin_lock_bh(&ulog_buffers[data].lock);
  98         if (ulog_buffers[data].skb)
  99                 ulog_send(data);
 100         spin_unlock_bh(&ulog_buffers[data].lock);
 101 }
 102
 103 static struct sk_buff *ulog_alloc_skb(unsigned int size)
 104 {
 105         struct sk_buff *skb;
 106         unsigned int n;
 107
 108         n = max(size, nlbufsiz);
 109         skb = alloc_skb(n, GFP_ATOMIC);
 110         if (!skb) {
 111                 PRINTR(KERN_ERR "ebt_ulog: can't alloc whole buffer "
 112                        "of size %ub!\n", n);
 113                 if (n > size) {
 114                         /* try to allocate only as much as we need for
 115                          * current packet */
 116                         skb = alloc_skb(size, GFP_ATOMIC);
 117                         if (!skb)
 118                                 PRINTR(KERN_ERR "ebt_ulog: can't even allocate "
 119                                        "buffer of size %ub\n", size);
 120                 }
 121         }
 122
 123         return skb;
 124 }
 125
 126 static void ebt_ulog_packet(unsigned int hooknr, const struct sk_buff *skb,
 127    const struct net_device *in, const struct net_device *out,
 128    const struct ebt_ulog_info *uloginfo, const char *prefix)
 129 {
 130         ebt_ulog_packet_msg_t *pm;
 131         size_t size, copy_len;
 132         struct nlmsghdr *nlh;
 133         unsigned int group = uloginfo->nlgroup;
 134         ebt_ulog_buff_t *ub = &ulog_buffers[group];
 135         spinlock_t *lock = &ub->lock;
 136
 137         if ((uloginfo->cprange == 0) ||
 138             (uloginfo->cprange > skb->len + ETH_HLEN))
 139                 copy_len = skb->len + ETH_HLEN;
 140         else
 141                 copy_len = uloginfo->cprange;
 142
 143         size = NLMSG_SPACE(sizeof(*pm) + copy_len);
 144         if (size > nlbufsiz) {
 145                 PRINTR("ebt_ulog: Size %Zd needed, but nlbufsiz=%d\n",
 146                        size, nlbufsiz);
 147                 return;
 148         }
 149
 150         spin_lock_bh(lock);
 151
 152         if (!ub->skb) {
 153                 if (!(ub->skb = ulog_alloc_skb(size)))
 154                         goto alloc_failure;
 155         } else if (size > skb_tailroom(ub->skb)) {
 156                 ulog_send(group);
 157
 158                 if (!(ub->skb = ulog_alloc_skb(size)))
 159                         goto alloc_failure;
 160         }
 161
 162         nlh = NLMSG_PUT(ub->skb, 0, ub->qlen, 0,
 163                         size - NLMSG_ALIGN(sizeof(*nlh)));
 164         ub->qlen++;
 165
 166         pm = NLMSG_DATA(nlh);
 167
 168         /* Fill in the ulog data */
 169         pm->version = EBT_ULOG_VERSION;
 170         do_gettimeofday(&pm->stamp);
 171         if (ub->qlen == 1)
 172                 skb_set_timestamp(ub->skb, &pm->stamp);
 173         pm->data_len = copy_len;
 174         pm->mark = skb->mark;
 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
 213 unlock:
 214         spin_unlock_bh(lock);
 215
 216         return;
 217
 218 nlmsg_failure:
 219         printk(KERN_CRIT "ebt_ulog: error during NLMSG_PUT. This should "
 220                "not happen, please report to author.\n");
 221         goto unlock;
 222 alloc_failure:
 223         goto unlock;
 224 }
 225
 226 /* this function is registered with the netfilter core */
 227 static void ebt_log_packet(unsigned int pf, unsigned int hooknum,
 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
 249 static void ebt_ulog(const struct sk_buff *skb, unsigned int hooknr,
 250    const struct net_device *in, const struct net_device *out,
 251    const void *data, unsigned int datalen)
 252 {
 253         struct ebt_ulog_info *uloginfo = (struct ebt_ulog_info *)data;
 254
 255         ebt_ulog_packet(hooknr, skb, in, out, uloginfo, NULL);
 256 }
 257
 258
 259 static int ebt_ulog_check(const char *tablename, unsigned int hookmask,
 260    const struct ebt_entry *e, void *data, unsigned int datalen)
 261 {
 262         struct ebt_ulog_info *uloginfo = (struct ebt_ulog_info *)data;
 263
 264         if (datalen != EBT_ALIGN(sizeof(struct ebt_ulog_info)) ||
 265             uloginfo->nlgroup > 31)
 266                 return -EINVAL;
 267
 268         uloginfo->prefix[EBT_ULOG_PREFIX_LEN - 1] = '\0';
 269
 270         if (uloginfo->qthreshold > EBT_ULOG_MAX_QLEN)
 271                 uloginfo->qthreshold = EBT_ULOG_MAX_QLEN;
 272
 273         return 0;
 274 }
 275
 276 static struct ebt_watcher ulog = {
 277         .name           = EBT_ULOG_WATCHER,
 278         .watcher        = ebt_ulog,
 279         .check          = ebt_ulog_check,
 280         .me             = THIS_MODULE,
 281 };
 282
 283 static struct nf_logger ebt_ulog_logger = {
 284         .name           = EBT_ULOG_WATCHER,
 285         .logfn          = &ebt_log_packet,
 286         .me             = THIS_MODULE,
 287 };
 288
 289 static int __init ebt_ulog_init(void)
 290 {
 291         int i, ret = 0;
 292
 293         if (nlbufsiz >= 128*1024) {
 294                 printk(KERN_NOTICE "ebt_ulog: Netlink buffer has to be <= 128kB,"
 295                        " please try a smaller nlbufsiz parameter.\n");
 296                 return -EINVAL;
 297         }
 298
 299         /* initialize ulog_buffers */
 300         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 301                 init_timer(&ulog_buffers[i].timer);
 302                 ulog_buffers[i].timer.function = ulog_timer;
 303                 ulog_buffers[i].timer.data = i;
 304                 spin_lock_init(&ulog_buffers[i].lock);
 305         }
 306
 307         ebtulognl = netlink_kernel_create(NETLINK_NFLOG, EBT_ULOG_MAXNLGROUPS,
 308                                           NULL, THIS_MODULE);
 309         if (!ebtulognl)
 310                 ret = -ENOMEM;
 311         else if ((ret = ebt_register_watcher(&ulog)))
 312                 sock_release(ebtulognl->sk_socket);
 313
 314         if (nf_log_register(PF_BRIDGE, &ebt_ulog_logger) < 0) {
 315                 printk(KERN_WARNING "ebt_ulog: not logging via ulog "
 316                        "since somebody else already registered for PF_BRIDGE\n");
 317                 /* we cannot make module load fail here, since otherwise
 318                  * ebtables userspace would abort */
 319         }
 320
 321         return ret;
 322 }
 323
 324 static void __exit ebt_ulog_fini(void)
 325 {
 326         ebt_ulog_buff_t *ub;
 327         int i;
 328
 329         nf_log_unregister_logger(&ebt_ulog_logger);
 330         ebt_unregister_watcher(&ulog);
 331         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 332                 ub = &ulog_buffers[i];
 333                 if (timer_pending(&ub->timer))
 334                         del_timer(&ub->timer);
 335                 spin_lock_bh(&ub->lock);
 336                 if (ub->skb) {
 337                         kfree_skb(ub->skb);
 338                         ub->skb = NULL;
 339                 }
 340                 spin_unlock_bh(&ub->lock);
 341         }
 342         sock_release(ebtulognl->sk_socket);
 343 }
 344
 345 module_init(ebt_ulog_init);
 346 module_exit(ebt_ulog_fini);
 347 MODULE_LICENSE("GPL");
 348 MODULE_AUTHOR("Bart De Schuymer <bdschuym@pandora.be>");
 349 MODULE_DESCRIPTION("ebtables userspace logging module for bridged Ethernet"
 350                    " frames");