dummynet/ipfw2_mod.c

   1 /*
   2  * Copyright (C) 2009 Luigi Rizzo, Marta Carbone, Universita` di Pisa
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  */
  25
  26 /*
  27  * $Id$
  28  *
  29  * The main interface to build ipfw+dummynet as a linux module.
  30  * (and possibly as a windows module as well, though that part
  31  * is not complete yet).
  32  *
  33  * The control interface uses the sockopt mechanism
  34  * on a socket(AF_INET, SOCK_RAW, IPPROTO_RAW).
  35  *
  36  * The data interface uses the netfilter interface, at the moment
  37  * hooked to the PRE_ROUTING and POST_ROUTING hooks.
  38  * Unfortunately the netfilter interface is a moving target,
  39  * so we need a set of macros to adapt to the various cases.
  40  *
  41  * In the netfilter hook we just mark packet as 'QUEUE' and then
  42  * let the queue handler to do the whole work (filtering and
  43  * possibly emulation).
  44  * As we receive packets, we wrap them with an mbuf descriptor
  45  * so the existing ipfw+dummynet code runs unmodified.
  46  */
  47
  48 #include <sys/cdefs.h>
  49 #include <sys/mbuf.h>                   /* sizeof struct mbuf */
  50 #include <sys/param.h>                  /* NGROUPS */
  51
  52 #ifdef __linux__
  53 #include <linux/module.h>
  54 #include <linux/kernel.h>
  55 #include <linux/netfilter.h>
  56 #include <linux/netfilter_ipv4.h>       /* NF_IP_PRI_FILTER */
  57
  58 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
  59 #include <net/netfilter/nf_queue.h>     /* nf_queue */
  60 #endif
  61
  62 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,17)
  63 #define __read_mostly
  64 #endif
  65
  66 #endif /* !__linux__ */
  67
  68 #include <netinet/in.h>                 /* in_addr */
  69 #include <netinet/ip_fw.h>              /* ip_fw_ctl_t, ip_fw_chk_t */
  70 #include <netinet/ip_dummynet.h>        /* ip_dn_ctl_t, ip_dn_io_t */
  71 #include <net/pfil.h>                   /* PFIL_IN, PFIL_OUT */
  72 #include <net/inet_hashtables.h>        /* inet_lookup */
  73 #include <net/route.h>                  /* inet_iif */
  74
  75 /*
  76  * Here we allocate some global variables used in the firewall.
  77  */
  78 ip_dn_ctl_t    *ip_dn_ctl_ptr;
  79 ip_fw_ctl_t    *ip_fw_ctl_ptr;
  80
  81 ip_dn_io_t     *ip_dn_io_ptr;
  82 ip_fw_chk_t    *ip_fw_chk_ptr;
  83
  84 void            (*bridge_dn_p)(struct mbuf *, struct ifnet *);
  85
  86 /*---
  87  * Glue code to implement the registration of children with the parent.
  88  * Each child should call my_mod_register() when linking, so that
  89  * module_init() and module_exit() can call init_children() and
  90  * fini_children() to provide the necessary initialization.
  91  */
  92 #include <sys/module.h>
  93 struct mod_args {
  94         struct moduledata *mod;
  95         const char *name;
  96         int order;
  97 };
  98
  99 static unsigned int mod_idx;
 100 static struct mod_args mods[10];        /* hard limit to 10 modules */
 101
 102 /*
 103  * Data structure to cache our ucred related
 104  * information. This structure only gets used if
 105  * the user specified UID/GID based constraints in
 106  * a firewall rule.
 107  */
 108 struct ip_fw_ugid {
 109         gid_t           fw_groups[NGROUPS];
 110         int             fw_ngroups;
 111         uid_t           fw_uid;
 112         int             fw_prid;
 113 };
 114
 115 /*
 116  * my_mod_register should be called automatically as the init
 117  * functions in the submodules. Unfortunately this compiler/linker
 118  * trick is not supported yet so we call it manually.
 119  */
 120 int
 121 my_mod_register(struct moduledata *mod, const char *name, int order)
 122 {
 123         struct mod_args m = { mod, name, order };
 124
 125         printf("%s %s called\n", __FUNCTION__, name);
 126         if (mod_idx < sizeof(mods) / sizeof(mods[0]))
 127                 mods[mod_idx++] = m;
 128         return 0;
 129 }
 130
 131 static void
 132 init_children(void)
 133 {
 134         unsigned int i;
 135
 136         /* Call the functions registered at init time. */
 137         printf("%s mod_idx value %d\n", __FUNCTION__, mod_idx);
 138         for (i = 0; i < mod_idx; i++) {
 139                 printf("+++ start module %d %s %s at %p order 0x%x\n",
 140                         i, mods[i].name, mods[i].mod->name,
 141                         mods[i].mod, mods[i].order);
 142                 mods[i].mod->evhand(NULL, MOD_LOAD, mods[i].mod->priv);
 143         }
 144 }
 145
 146 static void
 147 fini_children(void)
 148 {
 149         int i;
 150
 151         /* Call the functions registered at init time. */
 152         for (i = mod_idx - 1; i >= 0; i--) {
 153                 printf("+++ end module %d %s %s at %p order 0x%x\n",
 154                         i, mods[i].name, mods[i].mod->name,
 155                         mods[i].mod, mods[i].order);
 156                 mods[i].mod->evhand(NULL, MOD_UNLOAD, mods[i].mod->priv);
 157         }
 158 }
 159 /*--- end of module bindinghelper functions ---*/
 160
 161 /*---
 162  * Control hooks:
 163  * ipfw_ctl_h() is a wrapper for linux to FreeBSD sockopt call convention.
 164  * then call the ipfw handler in order to manage requests.
 165  * In turn this is called by the linux set/get handlers.
 166  */
 167 static int
 168 ipfw_ctl_h(struct sockopt *s, int cmd, int dir, int len, void __user *user)
 169 {
 170         struct thread t;
 171         int ret = EINVAL;
 172
 173         memset(s, 0, sizeof(s));
 174         s->sopt_name = cmd;
 175         s->sopt_dir = dir;
 176         s->sopt_valsize = len;
 177         s->sopt_val = user;
 178
 179         /* sopt_td is not used but it is referenced */
 180         memset(&t, 0, sizeof(t));
 181         s->sopt_td = &t;
 182
 183         printf("%s called with cmd %d len %d\n", __FUNCTION__, cmd, len);
 184
 185         if (cmd < IP_DUMMYNET_CONFIGURE && ip_fw_ctl_ptr)
 186                 ret = ip_fw_ctl_ptr(s);
 187         else if (cmd >= IP_DUMMYNET_CONFIGURE && ip_dn_ctl_ptr)
 188                 ret = ip_dn_ctl_ptr(s);
 189
 190         return -ret;    /* errors are < 0 on linux */
 191 }
 192
 193 #ifdef _WIN32
 194
 195 void
 196 netisr_dispatch(int __unused num, struct mbuf *m)
 197 {
 198 }
 199
 200 int
 201 ip_output(struct mbuf *m, struct mbuf __unused *opt,
 202         struct route __unused *ro, int __unused flags,
 203     struct ip_moptions __unused *imo, struct inpcb __unused *inp)
 204 {
 205         netisr_dispatch(0, m);
 206         return 0;
 207 }
 208
 209 #else /* this is the linux glue */
 210 /*
 211  * setsockopt hook has no return value other than the error code.
 212  */
 213 static int
 214 do_ipfw_set_ctl(struct sock __unused *sk, int cmd,
 215         void __user *user, unsigned int len)
 216 {
 217         struct sockopt s;       /* pass arguments */
 218
 219         return ipfw_ctl_h(&s, cmd, SOPT_SET, len, user);
 220 }
 221
 222 /*
 223  * getsockopt can can return a block of data in response.
 224  */
 225 static int
 226 do_ipfw_get_ctl(struct sock __unused *sk,
 227         int cmd, void __user *user, int *len)
 228 {
 229         struct sockopt s;       /* pass arguments */
 230         int ret = ipfw_ctl_h(&s, cmd, SOPT_GET, *len, user);
 231
 232         *len = s.sopt_valsize;  /* return lenght back to the caller */
 233         return ret;
 234 }
 235
 236 /*
 237  * declare our [get|set]sockopt hooks
 238  */
 239 static struct nf_sockopt_ops ipfw_sockopts = {
 240         .pf             = PF_INET,
 241         .set_optmin     = _IPFW_SOCKOPT_BASE,
 242         .set_optmax     = _IPFW_SOCKOPT_END,
 243         .set            = do_ipfw_set_ctl,
 244         .get_optmin     = _IPFW_SOCKOPT_BASE,
 245         .get_optmax     = _IPFW_SOCKOPT_END,
 246         .get            = do_ipfw_get_ctl,
 247 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 248         .owner          = THIS_MODULE,
 249 #endif
 250 };
 251
 252 /*----
 253  * We need a number of macros to adapt to the various APIs in
 254  * different linux versions. Among them:
 255  *
 256  * - the hook names change between macros (NF_IP*) and enum NF_INET_*
 257  *
 258  * - the second argument to the netfilter hook is
 259  *     struct sk_buff ** in kernels <= 2.6.22
 260  *     struct sk_buff * in kernels > 2.6.22
 261  *
 262  * - NF_STOP is not defined before 2.6 so we remap it to NF_ACCEPT
 263  *
 264  * - the packet descriptor passed to the queue handler is
 265  *     struct nf_info          in kernels <= 2.6.24
 266  *     struct nf_queue_entry   in kernels <= 2.6.24
 267  *
 268  * - the arguments to the queue handler also change;
 269  */
 270
 271 /*
 272  * declare hook to grab packets from the netfilter interface.
 273  * The NF_* names change in different versions of linux, in some
 274  * cases they are #defines, in others they are enum, so we
 275  * need to adapt.
 276  */
 277 #ifndef NF_IP_PRE_ROUTING
 278 #define NF_IP_PRE_ROUTING       NF_INET_PRE_ROUTING
 279 #endif
 280 #ifndef NF_IP_POST_ROUTING
 281 #define NF_IP_POST_ROUTING      NF_INET_POST_ROUTING
 282 #endif
 283
 284 /*
 285  * The main netfilter hook.
 286  * To make life simple, we queue everything and then do all the
 287  * decision in the queue handler.
 288  *
 289  * XXX note that in 2.4 and up to 2.6.22 the skbuf is passed as sk_buff**
 290  * so we have an #ifdef to set the proper argument type.
 291  */
 292 static unsigned int
 293 call_ipfw(unsigned int __unused hooknum,
 294 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23) // in 2.6.22 we have **
 295         struct sk_buff  __unused **skb,
 296 #else
 297         struct sk_buff  __unused *skb,
 298 #endif
 299         const struct net_device  __unused *in,
 300         const struct net_device  __unused *out,
 301         int __unused (*okfn)(struct sk_buff *))
 302 {
 303         return NF_QUEUE;
 304 }
 305
 306 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0)
 307 #define NF_STOP         NF_ACCEPT
 308 #endif
 309
 310 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
 311
 312 /*
 313  * nf_queue_entry is a recent addition, in previous versions
 314  * of the code the struct is called nf_info.
 315  */
 316 #define nf_queue_entry  nf_info /* for simplicity */
 317
 318 /* also, 2.4 and perhaps something else have different arguments */
 319 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0)  /* unsure on the exact boundary */
 320 /* on 2.4 we use nf_info */
 321 #define QH_ARGS         struct sk_buff *skb, struct nf_info *info, void *data
 322 #else   /* 2.6.1.. 2.6.24 */
 323 #define QH_ARGS         struct sk_buff *skb, struct nf_info *info, unsigned int qnum, void *data
 324 #endif
 325
 326 #define DEFINE_SKB      /* nothing, already an argument */
 327 #define REINJECT(_inf, _verd)   nf_reinject(skb, _inf, _verd)
 328
 329 #else   /* 2.6.25 and above */
 330
 331 #define QH_ARGS         struct nf_queue_entry *info, unsigned int queuenum
 332 #define DEFINE_SKB      struct sk_buff *skb = info->skb;
 333 #define REINJECT(_inf, _verd)   nf_reinject(_inf, _verd)
 334 #endif
 335
 336 /*
 337  * used by dummynet when dropping packets
 338  * XXX use dummynet_send()
 339  */
 340 void
 341 reinject_drop(struct mbuf* m)
 342 {
 343 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25) /* unsure on the exact boundary */
 344         struct sk_buff *skb = (struct sk_buff *)m;
 345 #endif
 346         REINJECT(m->queue_entry, NF_DROP);
 347 }
 348
 349 /*
 350  * The real call to the firewall. nf_queue_entry points to the skbuf,
 351  * and eventually we need to return both through nf_reinject().
 352  */
 353 static int
 354 ipfw2_queue_handler(QH_ARGS)
 355 {
 356         DEFINE_SKB      /* no semicolon here, goes in the macro */
 357         int ret = 0;    /* return value */
 358         struct mbuf *m;
 359
 360 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0)
 361         if (skb->nh.iph == NULL) {
 362                 printf("null dp, len %d reinject now\n", skb->len);
 363                 REINJECT(info, NF_ACCEPT);
 364                 return 0;
 365         }
 366 #endif
 367         m = malloc(sizeof(*m), 0, 0);
 368         if (m == NULL) {
 369                 printf("malloc fail, len %d reinject now\n", skb->len);
 370                 REINJECT(info, NF_ACCEPT);
 371                 return 0;
 372         }
 373
 374         m->m_skb = skb;
 375         m->m_len = skb->len;            /* len in this skbuf */
 376         m->m_pkthdr.len = skb->len;     /* total packet len */
 377         m->m_pkthdr.rcvif = info->indev;
 378         m->queue_entry = info;
 379 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0)
 380         m->m_data = skb->nh.iph;
 381 #else
 382         m->m_data = skb_network_header(skb);
 383 #endif
 384
 385         /* XXX add the interface */
 386         if (info->hook == NF_IP_PRE_ROUTING) {
 387                 ret = ipfw_check_in(NULL, &m, info->indev, PFIL_IN, NULL);
 388         } else {
 389                 ret = ipfw_check_out(NULL, &m, info->outdev, PFIL_OUT, NULL);
 390         }
 391
 392         if (m != NULL) {        /* Accept. reinject and free the mbuf */
 393                 REINJECT(info, NF_STOP);
 394                 m_freem(m);
 395         } else if (ret == 0) {
 396                 /* dummynet has kept the packet, will reinject later. */
 397         } else {
 398                 /*
 399                  * Packet dropped by ipfw or dummynet, reinject as NF_DROP
 400                  * mbuf already released by ipfw itself
 401                  */
 402                 REINJECT(info, NF_DROP);
 403         }
 404         return 0;
 405 }
 406
 407 struct route;
 408 struct ip_moptions;
 409 struct inpcb;
 410
 411
 412 /* XXX should include prototypes for netisr_dispatch and ip_output */
 413 /*
 414  * The reinjection routine after a packet comes out from dummynet.
 415  * We must update the skb timestamp so ping reports the right time.
 416  */
 417 void
 418 netisr_dispatch(int num, struct mbuf *m)
 419 {
 420         struct nf_queue_entry *info = m->queue_entry;
 421         struct sk_buff *skb = m->m_skb; /* always used */
 422
 423         m_freem(m);
 424
 425         KASSERT((info != NULL), ("%s info null!\n", __FUNCTION__));
 426 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)        // XXX above 2.6.x ?
 427         __net_timestamp(skb);   /* update timestamp */
 428 #endif
 429
 430         /* XXX to obey one-pass, possibly call the queue handler here */
 431         REINJECT(info, ((num == -1)?NF_DROP:NF_STOP));  /* accept but no more firewall */
 432 }
 433
 434 int
 435 ip_output(struct mbuf *m, struct mbuf __unused *opt,
 436         struct route __unused *ro, int __unused flags,
 437     struct ip_moptions __unused *imo, struct inpcb __unused *inp)
 438 {
 439         netisr_dispatch(0, m);
 440         return 0;
 441 }
 442
 443 /*
 444  * socket lookup function for linux.
 445  * This code is used to associate uid, gid, jail/xid to packets,
 446  * and store the info in a cache *ugp where they can be accessed quickly.
 447  * The function returns 1 if the info is found, -1 otherwise.
 448  *
 449  * We do this only on selected protocols: TCP, ...
 450  *
 451  * Note- for locally generated, outgoing packets we don't need to
 452  * do a lookup because the sk_buff already points to the socket where
 453  * the info is.
 454  */
 455 extern struct inet_hashinfo tcp_hashinfo;
 456 int
 457 linux_lookup(const int proto, const __be32 saddr, const __be16 sport,
 458                 const __be32 daddr, const __be16 dport,
 459                 struct sk_buff *skb, int dir, struct ip_fw_ugid *ugp)
 460 {
 461         struct sock *sk;
 462         int ret = -1;   /* default return value */
 463
 464         if (proto != IPPROTO_TCP)
 465                 return -1;
 466
 467         if ((dir ? (void *)skb->dst : (void *)skb->dev) == NULL) {
 468                 panic(" -- this should not happen\n");
 469                 return -1;
 470         }
 471
 472         /*
 473          * inet_lookup above 2.6.24 has an additional 'net' parameter
 474          * so we use a macro to conditionally supply it.
 475          * Also we need to switch dst and src depending on the direction.
 476          */
 477 #if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,24)
 478 #define _OPT_NET_ARG
 479 #else    /* 2.6.25 and above */
 480 #define _OPT_NET_ARG dev_net(skb->dev),
 481 #endif
 482
 483         sk =  (dir) ?
 484                 inet_lookup(_OPT_NET_ARG &tcp_hashinfo,
 485                         daddr, dport, saddr, sport,     // matches outgoing for server sockets
 486                         net_iif(skb)) :
 487                 inet_lookup(_OPT_NET_ARG &tcp_hashinfo,
 488                         saddr, sport, daddr, dport,     // matches incoming for server sockets
 489                         skb->dev->ifindex);
 490
 491 #undef _OPT_NET_ARG
 492         /* no match, nothing to be done */
 493         if (sk == NULL)
 494                 return -1;
 495
 496         /*
 497          * On a match, sk is returned with a refcount.
 498          * In tcp states less that TCP_TIME_WAIT sk references a struct sock
 499          * which is what we want,
 500          * otherwise it references a struct inet_timewait_sock which does
 501          * not point to credentials.
 502          * Once again we need conditional code because the UID and GID
 503          * location changes between the two kernels.
 504          */
 505 #if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,28)
 506 /* use the current's real uid/gid */
 507 #define _CURR_UID f_uid
 508 #define _CURR_GID f_gid
 509 #else /* 2.6.29 and above */
 510 /* use the current's file access real uid/gid */
 511 #define _CURR_UID f_cred->fsuid
 512 #define _CURR_GID f_cred->fsgid
 513 #endif
 514         if (sk->sk_state < TCP_TIME_WAIT && sk->sk_socket && sk->sk_socket->file) {
 515                 ugp->fw_uid = sk->sk_socket->file->_CURR_UID;
 516                 ret = 1;
 517         }
 518         sock_put(sk);
 519 #undef _CURR_UID
 520 #undef _CURR_GID
 521
 522         //printf("%s dir %d skb->dst %p skb->dev %p ret %d\n", __FUNCTION__, dir, skb->dst, skb->dev, ret);
 523         return ret;
 524 }
 525
 526 /*
 527  * Now prepare to hook the various functions.
 528  * Linux 2.4 has a different API so we need some adaptation
 529  * for register and unregister hooks
 530  *
 531  * the unregister function changed arguments between 2.6.22 and 2.6.24
 532  */
 533 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0)
 534 static int
 535 nf_register_hooks(struct nf_hook_ops *ops, int n)
 536 {
 537         int i, ret = 0;
 538         for (i = 0; i < n; i++) {
 539                 ret = nf_register_hook(ops + i);
 540                 if (ret < 0)
 541                         break;
 542         }
 543         return ret;
 544 }
 545
 546 static void
 547 nf_unregister_hooks(struct nf_hook_ops *ops, int n)
 548 {
 549         int i;
 550         for (i = 0; i < n; i++) {
 551                 nf_unregister_hook(ops + i);
 552         }
 553 }
 554 #define REG_QH_ARG(fn)  fn, NULL        /* argument for nf_[un]register_queue_handler */
 555 #define UNREG_QH_ARG(fn) //fn   /* argument for nf_[un]register_queue_handler */
 556 #define SET_MOD_OWNER
 557
 558 #else /* linux >= 2.6.0 */
 559
 560 struct nf_queue_handler ipfw2_queue_handler_desc = {
 561         .outfn = ipfw2_queue_handler,
 562         .name = "ipfw2 dummynet queue",
 563 };
 564 #define REG_QH_ARG(fn)  &(fn ## _desc)
 565
 566 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24)
 567 #define UNREG_QH_ARG(fn) //fn   /* argument for nf_[un]register_queue_handler */
 568 #else
 569 #define UNREG_QH_ARG(fn)        , &(fn ## _desc)
 570 #endif /* 2.6.0 < LINUX > 2.6.24 */
 571
 572 #define SET_MOD_OWNER   .owner = THIS_MODULE,
 573
 574 #endif  /* !LINUX < 2.6.0 */
 575
 576 static struct nf_hook_ops ipfw_ops[] __read_mostly = {
 577         {
 578                 .hook           = call_ipfw,
 579                 .pf             = PF_INET,
 580                 .hooknum        = NF_IP_PRE_ROUTING,
 581                 .priority       = NF_IP_PRI_FILTER,
 582                 SET_MOD_OWNER
 583         },
 584         {
 585                 .hook           = call_ipfw,
 586                 .pf             = PF_INET,
 587                 .hooknum        = NF_IP_POST_ROUTING,
 588                 .priority       = NF_IP_PRI_FILTER,
 589                 SET_MOD_OWNER
 590         },
 591 };
 592 #endif /* !__linux__ */
 593
 594 /* descriptors for the children */
 595 extern moduledata_t *moddesc_ipfw;
 596 extern moduledata_t *moddesc_dummynet;
 597
 598 /*
 599  * Module glue - init and exit function.
 600  */
 601 static int __init
 602 ipfw_module_init(void)
 603 {
 604         int ret = 0;
 605
 606         printf("%s called\n", __FUNCTION__);
 607
 608         my_mod_register(moddesc_ipfw, "ipfw",  1);
 609         my_mod_register(moddesc_dummynet, "dummynet",  2);
 610         init_children();
 611
 612 #ifdef _WIN32
 613         return ret;
 614
 615 #else  /* linux hook */
 616         /* sockopt register, in order to talk with user space */
 617         ret = nf_register_sockopt(&ipfw_sockopts);
 618         if (ret < 0) {
 619                 printf("error %d in nf_register_sockopt\n", ret);
 620                 goto clean_modules;
 621         }
 622
 623         /* queue handler registration, in order to get network
 624          * packet under a private queue */
 625         ret = nf_register_queue_handler(PF_INET, REG_QH_ARG(ipfw2_queue_handler) );
 626         if (ret < 0)    /* queue busy */
 627                 goto unregister_sockopt;
 628
 629         ret = nf_register_hooks(ipfw_ops, ARRAY_SIZE(ipfw_ops));
 630         if (ret < 0)
 631                 goto unregister_sockopt;
 632
 633         printf("%s loaded\n", __FUNCTION__);
 634         return 0;
 635
 636
 637 /* handle errors on load */
 638 unregister_sockopt:
 639         nf_unregister_queue_handler(PF_INET  UNREG_QH_ARG(ipfw2_queue_handler) );
 640         nf_unregister_sockopt(&ipfw_sockopts);
 641
 642 clean_modules:
 643         fini_children();
 644         printf("%s error\n", __FUNCTION__);
 645
 646         return ret;
 647 #endif  /* linux */
 648 }
 649
 650 /* module shutdown */
 651 static void __exit
 652 ipfw_module_exit(void)
 653 {
 654 #ifdef _WIN32
 655 #else  /* linux hook */
 656         nf_unregister_hooks(ipfw_ops, ARRAY_SIZE(ipfw_ops));
 657         /* maybe drain the queue before unregistering ? */
 658         nf_unregister_queue_handler(PF_INET  UNREG_QH_ARG(ipfw2_queue_handler) );
 659         nf_unregister_sockopt(&ipfw_sockopts);
 660 #endif  /* linux */
 661
 662         fini_children();
 663
 664         printf("%s unloaded\n", __FUNCTION__);
 665 }
 666
 667 #ifdef __linux__
 668 module_init(ipfw_module_init)
 669 module_exit(ipfw_module_exit)
 670 MODULE_LICENSE("Dual BSD/GPL"); /* the code here is all BSD. */
 671 #endif