sys/net/pfil.h

   1 /*      $FreeBSD$ */
   2 /*      $NetBSD: pfil.h,v 1.22 2003/06/23 12:57:08 martin Exp $ */
   3
   4 /*-
   5  * Copyright (c) 1996 Matthew R. Green
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. The name of the author may not be used to endorse or promote products
  17  *    derived from this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef _NET_PFIL_H_
  33 #define _NET_PFIL_H_
  34
  35 #include <sys/systm.h>
  36 #include <sys/queue.h>
  37 #include <sys/_lock.h>
  38 #include <sys/_mutex.h>
  39 #include <sys/lock.h>
  40 #include <sys/rmlock.h>
  41 #include <net/vnet.h>
  42
  43 struct mbuf;
  44 struct ifnet;
  45 struct inpcb;
  46
  47 VNET_DECLARE(int, pfilforward);
  48 #define V_pfilforward           VNET(pfilforward)
  49 /*
  50  * The packet filter hooks are designed for anything to call them to
  51  * possibly intercept the packet.
  52  */
  53 struct packet_filter_hook {
  54         TAILQ_ENTRY(packet_filter_hook) pfil_link;
  55         int     (*pfil_func)(void *, struct mbuf **, struct ifnet *, int,
  56                     struct inpcb *);
  57         void    *pfil_arg;
  58 };
  59
  60 #define PFIL_IN         0x00000001
  61 #define PFIL_OUT        0x00000002
  62 #define PFIL_WAITOK     0x00000004
  63 #define PFIL_ALL        (PFIL_IN|PFIL_OUT)
  64
  65 typedef TAILQ_HEAD(pfil_list, packet_filter_hook) pfil_list_t;
  66
  67 #define PFIL_TYPE_AF            1       /* key is AF_* type */
  68 #define PFIL_TYPE_IFNET         2       /* key is ifnet pointer */
  69
  70 #define PFIL_FLAG_PRIVATE_LOCK  0x01    /* Personal lock instead of global */
  71
  72 struct pfil_head {
  73         pfil_list_t     ph_in;
  74         pfil_list_t     ph_out;
  75         int             ph_type;
  76         int             ph_nhooks;
  77 #if defined( __linux__ ) || defined( _WIN32 )
  78         rwlock_t        ph_mtx;
  79 #else
  80         struct rmlock   *ph_plock;      /* Pointer to the used lock */
  81         struct rmlock   ph_lock;        /* Private lock storage */
  82         int             flags;
  83 #endif
  84         union {
  85                 u_long          phu_val;
  86                 void            *phu_ptr;
  87         } ph_un;
  88 #define ph_af           ph_un.phu_val
  89 #define ph_ifnet        ph_un.phu_ptr
  90         LIST_ENTRY(pfil_head) ph_list;
  91 };
  92
  93 int     pfil_add_hook(int (*func)(void *, struct mbuf **, struct ifnet *,
  94             int, struct inpcb *), void *, int, struct pfil_head *);
  95 int     pfil_remove_hook(int (*func)(void *, struct mbuf **, struct ifnet *,
  96             int, struct inpcb *), void *, int, struct pfil_head *);
  97 int     pfil_run_hooks(struct pfil_head *, struct mbuf **, struct ifnet *,
  98             int, struct inpcb *inp);
  99
 100 struct rm_priotracker;  /* Do not require including rmlock header */
 101 int pfil_try_rlock(struct pfil_head *, struct rm_priotracker *);
 102 void pfil_rlock(struct pfil_head *, struct rm_priotracker *);
 103 void pfil_runlock(struct pfil_head *, struct rm_priotracker *);
 104 void pfil_wlock(struct pfil_head *);
 105 void pfil_wunlock(struct pfil_head *);
 106 int pfil_wowned(struct pfil_head *ph);
 107
 108 int     pfil_head_register(struct pfil_head *);
 109 int     pfil_head_unregister(struct pfil_head *);
 110
 111 struct pfil_head *pfil_head_get(int, u_long);
 112
 113 #define PFIL_HOOKED(p) ((p)->ph_nhooks > 0)
 114 #define PFIL_LOCK_INIT_REAL(l, t)       \
 115         rm_init_flags(l, "PFil " t " rmlock", RM_RECURSE)
 116 #define PFIL_LOCK_DESTROY_REAL(l)       \
 117         rm_destroy(l)
 118 #define PFIL_LOCK_INIT(p)       do {                    \
 119         if ((p)->flags & PFIL_FLAG_PRIVATE_LOCK) {      \
 120                 PFIL_LOCK_INIT_REAL(&(p)->ph_lock, "private");  \
 121                 (p)->ph_plock = &(p)->ph_lock;          \
 122         } else                                          \
 123                 (p)->ph_plock = &V_pfil_lock;           \
 124 } while (0)
 125 #define PFIL_LOCK_DESTROY(p)    do {                    \
 126         if ((p)->flags & PFIL_FLAG_PRIVATE_LOCK)        \
 127                 PFIL_LOCK_DESTROY_REAL((p)->ph_plock);  \
 128 } while (0)
 129 #define PFIL_TRY_RLOCK(p, t)    rm_try_rlock((p)->ph_plock, (t))
 130 #define PFIL_RLOCK(p, t)        rm_rlock((p)->ph_plock, (t))
 131 #define PFIL_WLOCK(p)           rm_wlock((p)->ph_plock)
 132 #define PFIL_RUNLOCK(p, t)      rm_runlock((p)->ph_plock, (t))
 133 #define PFIL_WUNLOCK(p)         rm_wunlock((p)->ph_plock)
 134 #define PFIL_WOWNED(p)          rm_wowned((p)->ph_plock)
 135 #define PFIL_LIST_LOCK()        mtx_lock(&pfil_global_lock)
 136 #define PFIL_LIST_UNLOCK()      mtx_unlock(&pfil_global_lock)
 137
 138 static __inline struct packet_filter_hook *
 139 pfil_hook_get(int dir, struct pfil_head *ph)
 140 {
 141
 142         if (dir == PFIL_IN)
 143                 return (TAILQ_FIRST(&ph->ph_in));
 144         else if (dir == PFIL_OUT)
 145                 return (TAILQ_FIRST(&ph->ph_out));
 146         else
 147                 return (NULL);
 148 }
 149
 150 #endif /* _NET_PFIL_H_ */