2 * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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
28 #ifndef _IPFW2_PRIVATE_H
29 #define _IPFW2_PRIVATE_H
32 * Internal constants and data structures used by ipfw components
33 * and not meant to be exported outside the kernel.
39 * For platforms that do not have SYSCTL support, we wrap the
40 * SYSCTL_* into a function (one per file) to collect the values
41 * into an array at module initialization. The wrapping macros,
42 * SYSBEGIN() and SYSEND, are empty in the default case.
51 /* Return values from ipfw_chk() */
65 * Structure for collecting parameters to dummynet for ip6_output forwarding
68 struct ip6_pktopts *opt_or;
69 struct route_in6 ro_or;
71 struct ip6_moptions *im6o_or;
72 struct ifnet *origifp_or;
74 struct sockaddr_in6 dst_or;
76 struct route_in6 ro_pmtu_or;
81 * Arguments for calling ipfw_chk() and dummynet_io(). We put them
82 * all into a structure because this way it is easier and more
83 * efficient to pass variables around and extend the interface.
86 struct mbuf *m; /* the mbuf chain */
87 struct ifnet *oif; /* output interface */
88 struct sockaddr_in *next_hop; /* forward address */
89 struct sockaddr_in6 *next_hop6; /* ipv6 forward address */
92 * On return, it points to the matching rule.
93 * On entry, rule.slot > 0 means the info is valid and
94 * contains the starting rule for an ipfw search.
95 * If chain_id == chain->id && slot >0 then jump to that slot.
96 * Otherwise, we locate the first rule >= rulenum:rule_id
98 struct ipfw_rule_ref rule; /* match/restart info */
100 struct ether_header *eh; /* for bridged packets */
102 struct ipfw_flow_id f_id; /* grabbed from IP header */
103 //uint32_t cookie; /* a cookie depending on rule action */
106 struct _ip6dn_args dummypar; /* dummynet->ip6_output */
107 struct sockaddr_in hopstore; /* store here if cannot use a pointer */
110 MALLOC_DECLARE(M_IPFW);
113 * Hooks sometime need to know the direction of the packet
114 * (divert, dummynet, netgraph, ...)
115 * We use a generic definition here, with bit0-1 indicating the
116 * direction, bit 2 indicating layer2 or 3, bit 3-4 indicating the
118 * indicating the protocol (if necessary)
126 PROTO_LAYER2 = 0x4, /* set for layer 2 */
127 /* PROTO_DEFAULT = 0, */
130 PROTO_IFB = 0x0c, /* layer2 + ifbridge */
131 /* PROTO_OLDBDG = 0x14, unused, old bridge */
134 /* wrapper for freeing a packet, in case we need to do more work */
136 #if defined(__linux__) || defined(_WIN32)
137 #define FREE_PKT(m) netisr_dispatch(-1, m)
139 #define FREE_PKT(m) m_freem(m)
141 #endif /* !FREE_PKT */
144 * Function definitions.
147 /* attach (arg = 1) or detach (arg = 0) hooks */
148 int ipfw_attach_hooks(int);
150 void ipfw_nat_destroy(void);
155 void ipfw_log_bpf(int);
156 void ipfw_log(struct ip_fw *f, u_int hlen, struct ip_fw_args *args,
157 struct mbuf *m, struct ifnet *oif, u_short offset, uint32_t tablearg,
159 VNET_DECLARE(u_int64_t, norule_counter);
160 #define V_norule_counter VNET(norule_counter)
161 VNET_DECLARE(int, verbose_limit);
162 #define V_verbose_limit VNET(verbose_limit)
164 /* In ip_fw_dynamic.c */
166 enum { /* result for matching dynamic rules */
174 * The lock for dynamic rules is only used once outside the file,
175 * and only to release the result of lookup_dyn_rule().
176 * Eventually we may implement it with a callback on the function.
179 void ipfw_expire_dyn_rules(struct ip_fw_chain *, struct ip_fw *, int);
180 void ipfw_dyn_unlock(ipfw_dyn_rule *q);
183 struct mbuf *ipfw_send_pkt(struct mbuf *, struct ipfw_flow_id *,
184 u_int32_t, u_int32_t, int);
185 int ipfw_install_state(struct ip_fw *rule, ipfw_insn_limit *cmd,
186 struct ip_fw_args *args, uint32_t tablearg);
187 ipfw_dyn_rule *ipfw_lookup_dyn_rule(struct ipfw_flow_id *pkt,
188 int *match_direction, struct tcphdr *tcp);
189 void ipfw_remove_dyn_children(struct ip_fw *rule);
190 void ipfw_get_dynamic(struct ip_fw_chain *chain, char **bp, const char *ep);
192 void ipfw_dyn_init(struct ip_fw_chain *); /* per-vnet initialization */
193 void ipfw_dyn_uninit(int); /* per-vnet deinitialization */
194 int ipfw_dyn_len(void);
196 /* common variables */
197 VNET_DECLARE(int, fw_one_pass);
198 #define V_fw_one_pass VNET(fw_one_pass)
200 VNET_DECLARE(int, fw_verbose);
201 #define V_fw_verbose VNET(fw_verbose)
203 VNET_DECLARE(struct ip_fw_chain, layer3_chain);
204 #define V_layer3_chain VNET(layer3_chain)
206 VNET_DECLARE(u_int32_t, set_disable);
207 #define V_set_disable VNET(set_disable)
209 VNET_DECLARE(int, autoinc_step);
210 #define V_autoinc_step VNET(autoinc_step)
212 VNET_DECLARE(unsigned int, fw_tables_max);
213 #define V_fw_tables_max VNET(fw_tables_max)
216 struct ip_fw **map; /* array of rule ptrs to ease lookup */
217 uint32_t id; /* ruleset id */
218 int n_rules; /* number of static rules */
219 LIST_HEAD(nat_list, cfg_nat) nat; /* list of nat entries */
220 struct radix_node_head **tables; /* IPv4 tables */
221 struct radix_node_head **xtables; /* extended tables */
222 uint8_t *tabletype; /* Array of table types */
223 #if defined( __linux__ ) || defined( _WIN32 )
228 int static_len; /* total len of static rules */
229 uint32_t gencnt; /* NAT generation count */
230 struct ip_fw *reap; /* list of rules to reap */
231 struct ip_fw *default_rule;
232 #if defined( __linux__ ) || defined( _WIN32 )
235 struct rwlock uh_lock; /* lock for upper half */
239 struct sockopt; /* used by tcp_var.h */
241 /* Macro for working with various counters */
242 #define IPFW_INC_RULE_COUNTER(_cntr, _bytes) do { \
244 (_cntr)->bcnt += _bytes; \
245 (_cntr)->timestamp = time_uptime; \
248 #define IPFW_INC_DYN_COUNTER(_cntr, _bytes) do { \
250 (_cntr)->bcnt += _bytes; \
253 #define IPFW_ZERO_RULE_COUNTER(_cntr) do { \
256 (_cntr)->timestamp = 0; \
259 #define IPFW_ZERO_DYN_COUNTER(_cntr) do { \
264 #define IP_FW_ARG_TABLEARG(a) ((a) == IP_FW_TABLEARG) ? tablearg : (a)
266 * The lock is heavily used by ip_fw2.c (the main file) and ip_fw_nat.c
267 * so the variable and the macros must be here.
270 #define IPFW_LOCK_INIT(_chain) do { \
271 rw_init(&(_chain)->rwmtx, "IPFW static rules"); \
272 rw_init(&(_chain)->uh_lock, "IPFW UH lock"); \
275 #define IPFW_LOCK_DESTROY(_chain) do { \
276 rw_destroy(&(_chain)->rwmtx); \
277 rw_destroy(&(_chain)->uh_lock); \
280 #define IPFW_RLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_RLOCKED)
281 #define IPFW_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_WLOCKED)
283 #define IPFW_RLOCK(p) rw_rlock(&(p)->rwmtx)
284 #define IPFW_RUNLOCK(p) rw_runlock(&(p)->rwmtx)
285 #define IPFW_WLOCK(p) rw_wlock(&(p)->rwmtx)
286 #define IPFW_WUNLOCK(p) rw_wunlock(&(p)->rwmtx)
288 #define IPFW_UH_RLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_RLOCKED)
289 #define IPFW_UH_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_WLOCKED)
291 #define IPFW_UH_RLOCK(p) rw_rlock(&(p)->uh_lock)
292 #define IPFW_UH_RUNLOCK(p) rw_runlock(&(p)->uh_lock)
293 #define IPFW_UH_WLOCK(p) rw_wlock(&(p)->uh_lock)
294 #define IPFW_UH_WUNLOCK(p) rw_wunlock(&(p)->uh_lock)
296 /* In ip_fw_sockopt.c */
297 int ipfw_find_rule(struct ip_fw_chain *chain, uint32_t key, uint32_t id);
298 int ipfw_add_rule(struct ip_fw_chain *chain, struct ip_fw *input_rule);
299 int ipfw_ctl(struct sockopt *sopt);
300 int ipfw_chk(struct ip_fw_args *args);
301 void ipfw_reap_rules(struct ip_fw *head);
304 int ipfw_check_hook(void *arg, struct mbuf **m0, struct ifnet *ifp, int dir,
307 /* In ip_fw_table.c */
309 int ipfw_lookup_table(struct ip_fw_chain *ch, uint16_t tbl, in_addr_t addr,
311 int ipfw_lookup_table_extended(struct ip_fw_chain *ch, uint16_t tbl, void *paddr,
312 uint32_t *val, int type);
313 int ipfw_init_tables(struct ip_fw_chain *ch);
314 void ipfw_destroy_tables(struct ip_fw_chain *ch);
315 int ipfw_flush_table(struct ip_fw_chain *ch, uint16_t tbl);
316 int ipfw_add_table_entry(struct ip_fw_chain *ch, uint16_t tbl, void *paddr,
317 uint8_t plen, uint8_t mlen, uint8_t type, uint32_t value);
318 int ipfw_del_table_entry(struct ip_fw_chain *ch, uint16_t tbl, void *paddr,
319 uint8_t plen, uint8_t mlen, uint8_t type);
320 int ipfw_count_table(struct ip_fw_chain *ch, uint32_t tbl, uint32_t *cnt);
321 int ipfw_dump_table_entry(struct radix_node *rn, void *arg);
322 int ipfw_dump_table(struct ip_fw_chain *ch, ipfw_table *tbl);
323 int ipfw_count_xtable(struct ip_fw_chain *ch, uint32_t tbl, uint32_t *cnt);
324 int ipfw_dump_xtable(struct ip_fw_chain *ch, ipfw_xtable *tbl);
325 int ipfw_resize_tables(struct ip_fw_chain *ch, unsigned int ntables);
327 /* In ip_fw_nat.c -- XXX to be moved to ip_var.h */
329 extern struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int);
331 typedef int ipfw_nat_t(struct ip_fw_args *, struct cfg_nat *, struct mbuf *);
332 typedef int ipfw_nat_cfg_t(struct sockopt *);
334 VNET_DECLARE(int, ipfw_nat_ready);
335 #define V_ipfw_nat_ready VNET(ipfw_nat_ready)
336 #define IPFW_NAT_LOADED (V_ipfw_nat_ready)
338 extern ipfw_nat_t *ipfw_nat_ptr;
339 extern ipfw_nat_cfg_t *ipfw_nat_cfg_ptr;
340 extern ipfw_nat_cfg_t *ipfw_nat_del_ptr;
341 extern ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr;
342 extern ipfw_nat_cfg_t *ipfw_nat_get_log_ptr;
345 #endif /* _IPFW2_PRIVATE_H */