2 /* $NetBSD: pfil.h,v 1.22 2003/06/23 12:57:08 martin Exp $ */
5 * SPDX-License-Identifier: BSD-3-Clause
7 * Copyright (c) 1996 Matthew R. Green
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #include <sys/systm.h>
38 #include <sys/queue.h>
39 #include <sys/_lock.h>
40 #include <sys/_mutex.h>
42 #include <sys/rmlock.h>
49 typedef int (*pfil_func_t)(void *, struct mbuf **, struct ifnet *, int,
51 typedef int (*pfil_func_flags_t)(void *, struct mbuf **, struct ifnet *,
52 int, int, struct inpcb *);
55 * The packet filter hooks are designed for anything to call them to
56 * possibly intercept the packet. Multiple filter hooks are chained
57 * together and after each other in the specified order.
59 struct packet_filter_hook {
60 TAILQ_ENTRY(packet_filter_hook) pfil_chain;
61 pfil_func_t pfil_func;
62 pfil_func_flags_t pfil_func_flags;
66 #define PFIL_IN 0x00000001
67 #define PFIL_OUT 0x00000002
68 #define PFIL_WAITOK 0x00000004
69 #define PFIL_FWD 0x00000008
70 #define PFIL_ALL (PFIL_IN|PFIL_OUT)
72 typedef TAILQ_HEAD(pfil_chain, packet_filter_hook) pfil_chain_t;
74 #define PFIL_TYPE_AF 1 /* key is AF_* type */
75 #define PFIL_TYPE_IFNET 2 /* key is ifnet pointer */
77 #define PFIL_FLAG_PRIVATE_LOCK 0x01 /* Personal lock instead of global */
80 * A pfil head is created by each protocol or packet intercept point.
81 * For packet is then run through the hook chain for inspection.
88 #if defined( __linux__ ) || defined( _WIN32 )
91 struct rmlock *ph_plock; /* Pointer to the used lock */
92 struct rmlock ph_lock; /* Private lock storage */
99 #define ph_af ph_un.phu_val
100 #define ph_ifnet ph_un.phu_ptr
101 LIST_ENTRY(pfil_head) ph_list;
104 VNET_DECLARE(struct rmlock, pfil_lock);
105 #define V_pfil_lock VNET(pfil_lock)
107 /* Public functions for pfil hook management by packet filters. */
108 struct pfil_head *pfil_head_get(int, u_long);
109 int pfil_add_hook_flags(pfil_func_flags_t, void *, int, struct pfil_head *);
110 int pfil_add_hook(pfil_func_t, void *, int, struct pfil_head *);
111 int pfil_remove_hook_flags(pfil_func_flags_t, void *, int, struct pfil_head *);
112 int pfil_remove_hook(pfil_func_t, void *, int, struct pfil_head *);
113 #define PFIL_HOOKED(p) ((p)->ph_nhooks > 0)
115 /* Public functions to run the packet inspection by protocols. */
116 int pfil_run_hooks(struct pfil_head *, struct mbuf **, struct ifnet *, int,
117 int, struct inpcb *inp);
119 /* Public functions for pfil head management by protocols. */
120 int pfil_head_register(struct pfil_head *);
121 int pfil_head_unregister(struct pfil_head *);
123 /* Public pfil locking functions for self managed locks by packet filters. */
124 int pfil_try_rlock(struct pfil_head *, struct rm_priotracker *);
125 void pfil_rlock(struct pfil_head *, struct rm_priotracker *);
126 void pfil_runlock(struct pfil_head *, struct rm_priotracker *);
127 void pfil_wlock(struct pfil_head *);
128 void pfil_wunlock(struct pfil_head *);
129 int pfil_wowned(struct pfil_head *ph);
131 #endif /* _NET_PFIL_H_ */