xref: /freebsd/sys/netpfil/ipfw/ip_fw_private.h (revision ec0e626bafb335b30c499d06066997f54b10c092)
1 /*-
2  * Copyright (c) 2002-2009 Luigi Rizzo, 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  * $FreeBSD$
26  */
27 
28 #ifndef _IPFW2_PRIVATE_H
29 #define _IPFW2_PRIVATE_H
30 
31 /*
32  * Internal constants and data structures used by ipfw components
33  * and not meant to be exported outside the kernel.
34  */
35 
36 #ifdef _KERNEL
37 
38 /*
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.
43  */
44 #ifndef SYSBEGIN
45 #define SYSBEGIN(x)
46 #endif
47 #ifndef SYSEND
48 #define SYSEND
49 #endif
50 
51 /* Return values from ipfw_chk() */
52 enum {
53 	IP_FW_PASS = 0,
54 	IP_FW_DENY,
55 	IP_FW_DIVERT,
56 	IP_FW_TEE,
57 	IP_FW_DUMMYNET,
58 	IP_FW_NETGRAPH,
59 	IP_FW_NGTEE,
60 	IP_FW_NAT,
61 	IP_FW_REASS,
62 };
63 
64 /*
65  * Structure for collecting parameters to dummynet for ip6_output forwarding
66  */
67 struct _ip6dn_args {
68        struct ip6_pktopts *opt_or;
69        int flags_or;
70        struct ip6_moptions *im6o_or;
71        struct ifnet *origifp_or;
72        struct ifnet *ifp_or;
73        struct sockaddr_in6 dst_or;
74        u_long mtu_or;
75 };
76 
77 
78 /*
79  * Arguments for calling ipfw_chk() and dummynet_io(). We put them
80  * all into a structure because this way it is easier and more
81  * efficient to pass variables around and extend the interface.
82  */
83 struct ip_fw_args {
84 	struct mbuf	*m;		/* the mbuf chain		*/
85 	struct ifnet	*oif;		/* output interface		*/
86 	struct sockaddr_in *next_hop;	/* forward address		*/
87 	struct sockaddr_in6 *next_hop6; /* ipv6 forward address		*/
88 
89 	/*
90 	 * On return, it points to the matching rule.
91 	 * On entry, rule.slot > 0 means the info is valid and
92 	 * contains the starting rule for an ipfw search.
93 	 * If chain_id == chain->id && slot >0 then jump to that slot.
94 	 * Otherwise, we locate the first rule >= rulenum:rule_id
95 	 */
96 	struct ipfw_rule_ref rule;	/* match/restart info		*/
97 
98 	struct ether_header *eh;	/* for bridged packets		*/
99 
100 	struct ipfw_flow_id f_id;	/* grabbed from IP header	*/
101 	//uint32_t	cookie;		/* a cookie depending on rule action */
102 	struct inpcb	*inp;
103 
104 	struct _ip6dn_args	dummypar; /* dummynet->ip6_output */
105 	union {		/* store here if cannot use a pointer */
106 		struct sockaddr_in hopstore;
107 		struct sockaddr_in6 hopstore6;
108 	};
109 };
110 
111 MALLOC_DECLARE(M_IPFW);
112 
113 /*
114  * Hooks sometime need to know the direction of the packet
115  * (divert, dummynet, netgraph, ...)
116  * We use a generic definition here, with bit0-1 indicating the
117  * direction, bit 2 indicating layer2 or 3, bit 3-4 indicating the
118  * specific protocol
119  * indicating the protocol (if necessary)
120  */
121 enum {
122 	DIR_MASK =	0x3,
123 	DIR_OUT =	0,
124 	DIR_IN =	1,
125 	DIR_FWD =	2,
126 	DIR_DROP =	3,
127 	PROTO_LAYER2 =	0x4, /* set for layer 2 */
128 	/* PROTO_DEFAULT = 0, */
129 	PROTO_IPV4 =	0x08,
130 	PROTO_IPV6 =	0x10,
131 	PROTO_IFB =	0x0c, /* layer2 + ifbridge */
132    /*	PROTO_OLDBDG =	0x14, unused, old bridge */
133 };
134 
135 /* wrapper for freeing a packet, in case we need to do more work */
136 #ifndef FREE_PKT
137 #if defined(__linux__) || defined(_WIN32)
138 #define FREE_PKT(m)	netisr_dispatch(-1, m)
139 #else
140 #define FREE_PKT(m)	m_freem(m)
141 #endif
142 #endif /* !FREE_PKT */
143 
144 /*
145  * Function definitions.
146  */
147 
148 /* attach (arg = 1) or detach (arg = 0) hooks */
149 int ipfw_attach_hooks(int);
150 #ifdef NOTYET
151 void ipfw_nat_destroy(void);
152 #endif
153 
154 /* In ip_fw_log.c */
155 struct ip;
156 struct ip_fw_chain;
157 void ipfw_log_bpf(int);
158 void ipfw_log(struct ip_fw_chain *chain, struct ip_fw *f, u_int hlen,
159     struct ip_fw_args *args, struct mbuf *m, struct ifnet *oif,
160     u_short offset, uint32_t tablearg, struct ip *ip);
161 VNET_DECLARE(u_int64_t, norule_counter);
162 #define	V_norule_counter	VNET(norule_counter)
163 VNET_DECLARE(int, verbose_limit);
164 #define	V_verbose_limit		VNET(verbose_limit)
165 
166 /* In ip_fw_dynamic.c */
167 
168 enum { /* result for matching dynamic rules */
169 	MATCH_REVERSE = 0,
170 	MATCH_FORWARD,
171 	MATCH_NONE,
172 	MATCH_UNKNOWN,
173 };
174 
175 /*
176  * The lock for dynamic rules is only used once outside the file,
177  * and only to release the result of lookup_dyn_rule().
178  * Eventually we may implement it with a callback on the function.
179  */
180 struct ip_fw_chain;
181 struct sockopt_data;
182 int ipfw_is_dyn_rule(struct ip_fw *rule);
183 void ipfw_expire_dyn_rules(struct ip_fw_chain *, ipfw_range_tlv *);
184 void ipfw_dyn_unlock(ipfw_dyn_rule *q);
185 
186 struct tcphdr;
187 struct mbuf *ipfw_send_pkt(struct mbuf *, struct ipfw_flow_id *,
188     u_int32_t, u_int32_t, int);
189 int ipfw_install_state(struct ip_fw_chain *chain, struct ip_fw *rule,
190     ipfw_insn_limit *cmd, struct ip_fw_args *args, uint32_t tablearg);
191 ipfw_dyn_rule *ipfw_lookup_dyn_rule(struct ipfw_flow_id *pkt,
192 	int *match_direction, struct tcphdr *tcp);
193 void ipfw_remove_dyn_children(struct ip_fw *rule);
194 void ipfw_get_dynamic(struct ip_fw_chain *chain, char **bp, const char *ep);
195 int ipfw_dump_states(struct ip_fw_chain *chain, struct sockopt_data *sd);
196 
197 void ipfw_dyn_init(struct ip_fw_chain *);	/* per-vnet initialization */
198 void ipfw_dyn_uninit(int);	/* per-vnet deinitialization */
199 int ipfw_dyn_len(void);
200 int ipfw_dyn_get_count(void);
201 
202 /* common variables */
203 VNET_DECLARE(int, fw_one_pass);
204 #define	V_fw_one_pass		VNET(fw_one_pass)
205 
206 VNET_DECLARE(int, fw_verbose);
207 #define	V_fw_verbose		VNET(fw_verbose)
208 
209 VNET_DECLARE(struct ip_fw_chain, layer3_chain);
210 #define	V_layer3_chain		VNET(layer3_chain)
211 
212 VNET_DECLARE(int, ipfw_vnet_ready);
213 #define	V_ipfw_vnet_ready	VNET(ipfw_vnet_ready)
214 
215 VNET_DECLARE(u_int32_t, set_disable);
216 #define	V_set_disable		VNET(set_disable)
217 
218 VNET_DECLARE(int, autoinc_step);
219 #define V_autoinc_step		VNET(autoinc_step)
220 
221 VNET_DECLARE(unsigned int, fw_tables_max);
222 #define V_fw_tables_max		VNET(fw_tables_max)
223 
224 VNET_DECLARE(unsigned int, fw_tables_sets);
225 #define V_fw_tables_sets	VNET(fw_tables_sets)
226 
227 struct tables_config;
228 
229 #ifdef _KERNEL
230 /*
231  * Here we have the structure representing an ipfw rule.
232  *
233  * It starts with a general area
234  * followed by an array of one or more instructions, which the code
235  * accesses as an array of 32-bit values.
236  *
237  * Given a rule pointer  r:
238  *
239  *  r->cmd		is the start of the first instruction.
240  *  ACTION_PTR(r)	is the start of the first action (things to do
241  *			once a rule matched).
242  */
243 
244 struct ip_fw {
245 	uint16_t	act_ofs;	/* offset of action in 32-bit units */
246 	uint16_t	cmd_len;	/* # of 32-bit words in cmd	*/
247 	uint16_t	rulenum;	/* rule number			*/
248 	uint8_t		set;		/* rule set (0..31)		*/
249 	uint8_t		flags;		/* currently unused		*/
250 	counter_u64_t	cntr;		/* Pointer to rule counters	*/
251 	uint32_t	timestamp;	/* tv_sec of last match		*/
252 	uint32_t	id;		/* rule id			*/
253 	uint32_t	cached_id;	/* used by jump_fast		*/
254 	uint32_t	cached_pos;	/* used by jump_fast		*/
255 
256 	ipfw_insn	cmd[1];		/* storage for commands		*/
257 };
258 
259 #define	IPFW_RULE_CNTR_SIZE	(2 * sizeof(counter_u64_t))
260 
261 #endif
262 
263 struct ip_fw_chain {
264 	struct ip_fw	**map;		/* array of rule ptrs to ease lookup */
265 	uint32_t	id;		/* ruleset id */
266 	int		n_rules;	/* number of static rules */
267 	LIST_HEAD(nat_list, cfg_nat) nat;       /* list of nat entries */
268 	void		*tablestate;	/* runtime table info */
269 	void		*valuestate;	/* runtime table value info */
270 	int		*idxmap;	/* skipto array of rules */
271 #if defined( __linux__ ) || defined( _WIN32 )
272 	spinlock_t rwmtx;
273 #else
274 	struct rmlock	rwmtx;
275 #endif
276 	int		static_len;	/* total len of static rules (v0) */
277 	uint32_t	gencnt;		/* NAT generation count */
278 	struct ip_fw	*default_rule;
279 	struct tables_config *tblcfg;	/* tables module data */
280 	void		*ifcfg;		/* interface module data */
281 	int		*idxmap_back;	/* standby skipto array of rules */
282 #if defined( __linux__ ) || defined( _WIN32 )
283 	spinlock_t uh_lock;
284 #else
285 	struct rwlock	uh_lock;	/* lock for upper half */
286 #endif
287 };
288 
289 /* 64-byte structure representing multi-field table value */
290 struct table_value {
291 	uint32_t	tag;		/* O_TAG/O_TAGGED */
292 	uint32_t	pipe;		/* O_PIPE/O_QUEUE */
293 	uint16_t	divert;		/* O_DIVERT/O_TEE */
294 	uint16_t	skipto;		/* skipto, CALLRET */
295 	uint32_t	netgraph;	/* O_NETGRAPH/O_NGTEE */
296 	uint32_t	fib;		/* O_SETFIB */
297 	uint32_t	nat;		/* O_NAT */
298 	uint32_t	nh4;
299 	uint8_t		dscp;
300 	uint8_t		spare0;
301 	uint16_t	spare1;
302 	/* -- 32 bytes -- */
303 	struct in6_addr	nh6;
304 	uint32_t	limit;		/* O_LIMIT */
305 	uint32_t	zoneid;		/* scope zone id for nh6 */
306 	uint64_t	refcnt;		/* Number of references */
307 };
308 
309 struct namedobj_instance;
310 
311 struct named_object {
312 	TAILQ_ENTRY(named_object)	nn_next;	/* namehash */
313 	TAILQ_ENTRY(named_object)	nv_next;	/* valuehash */
314 	char			*name;	/* object name */
315 	uint8_t			type;	/* object type */
316 	uint8_t			compat;	/* Object name is number */
317 	uint16_t		kidx;	/* object kernel index */
318 	uint16_t		uidx;	/* userland idx for compat records */
319 	uint32_t		set;	/* set object belongs to */
320 	uint32_t		refcnt;	/* number of references */
321 };
322 TAILQ_HEAD(namedobjects_head, named_object);
323 
324 struct sockopt;	/* used by tcp_var.h */
325 struct sockopt_data {
326 	caddr_t		kbuf;		/* allocated buffer */
327 	size_t		ksize;		/* given buffer size */
328 	size_t		koff;		/* data already used */
329 	size_t		kavail;		/* number of bytes available */
330 	size_t		ktotal;		/* total bytes pushed */
331 	struct sockopt	*sopt;		/* socket data */
332 	caddr_t		sopt_val;	/* sopt user buffer */
333 	size_t		valsize;	/* original data size */
334 };
335 
336 struct ipfw_ifc;
337 
338 typedef void (ipfw_ifc_cb)(struct ip_fw_chain *ch, void *cbdata,
339     uint16_t ifindex);
340 
341 struct ipfw_iface {
342 	struct named_object	no;
343 	char ifname[64];
344 	int resolved;
345 	uint16_t ifindex;
346 	uint16_t spare;
347 	uint64_t gencnt;
348 	TAILQ_HEAD(, ipfw_ifc)	consumers;
349 };
350 
351 struct ipfw_ifc {
352 	TAILQ_ENTRY(ipfw_ifc)	next;
353 	struct ipfw_iface	*iface;
354 	ipfw_ifc_cb		*cb;
355 	void			*cbdata;
356 };
357 
358 /* Macro for working with various counters */
359 #define	IPFW_INC_RULE_COUNTER(_cntr, _bytes)	do {	\
360 	counter_u64_add((_cntr)->cntr, 1);		\
361 	counter_u64_add((_cntr)->cntr + 1, _bytes);	\
362 	if ((_cntr)->timestamp != time_uptime)		\
363 		(_cntr)->timestamp = time_uptime;	\
364 	} while (0)
365 
366 #define	IPFW_INC_DYN_COUNTER(_cntr, _bytes)	do {		\
367 	(_cntr)->pcnt++;				\
368 	(_cntr)->bcnt += _bytes;			\
369 	} while (0)
370 
371 #define	IPFW_ZERO_RULE_COUNTER(_cntr) do {		\
372 	counter_u64_zero((_cntr)->cntr);		\
373 	counter_u64_zero((_cntr)->cntr + 1);		\
374 	(_cntr)->timestamp = 0;				\
375 	} while (0)
376 
377 #define	IPFW_ZERO_DYN_COUNTER(_cntr) do {		\
378 	(_cntr)->pcnt = 0;				\
379 	(_cntr)->bcnt = 0;				\
380 	} while (0)
381 
382 #define	TARG_VAL(ch, k, f)	((struct table_value *)((ch)->valuestate))[k].f
383 #define	IP_FW_ARG_TABLEARG(ch, a, f)	\
384 	(((a) == IP_FW_TARG) ? TARG_VAL(ch, tablearg, f) : (a))
385 /*
386  * The lock is heavily used by ip_fw2.c (the main file) and ip_fw_nat.c
387  * so the variable and the macros must be here.
388  */
389 
390 #if defined( __linux__ ) || defined( _WIN32 )
391 #define	IPFW_LOCK_INIT(_chain) do {			\
392 	rw_init(&(_chain)->rwmtx, "IPFW static rules");	\
393 	rw_init(&(_chain)->uh_lock, "IPFW UH lock");	\
394 	} while (0)
395 
396 #define	IPFW_LOCK_DESTROY(_chain) do {			\
397 	rw_destroy(&(_chain)->rwmtx);			\
398 	rw_destroy(&(_chain)->uh_lock);			\
399 	} while (0)
400 
401 #define	IPFW_RLOCK_ASSERT(_chain)	rw_assert(&(_chain)->rwmtx, RA_RLOCKED)
402 #define	IPFW_WLOCK_ASSERT(_chain)	rw_assert(&(_chain)->rwmtx, RA_WLOCKED)
403 
404 #define	IPFW_RLOCK_TRACKER
405 #define	IPFW_RLOCK(p)			rw_rlock(&(p)->rwmtx)
406 #define	IPFW_RUNLOCK(p)			rw_runlock(&(p)->rwmtx)
407 #define	IPFW_WLOCK(p)			rw_wlock(&(p)->rwmtx)
408 #define	IPFW_WUNLOCK(p)			rw_wunlock(&(p)->rwmtx)
409 #define	IPFW_PF_RLOCK(p)		IPFW_RLOCK(p)
410 #define	IPFW_PF_RUNLOCK(p)		IPFW_RUNLOCK(p)
411 #else /* FreeBSD */
412 #define	IPFW_LOCK_INIT(_chain) do {			\
413 	rm_init(&(_chain)->rwmtx, "IPFW static rules");	\
414 	rw_init(&(_chain)->uh_lock, "IPFW UH lock");	\
415 	} while (0)
416 
417 #define	IPFW_LOCK_DESTROY(_chain) do {			\
418 	rm_destroy(&(_chain)->rwmtx);			\
419 	rw_destroy(&(_chain)->uh_lock);			\
420 	} while (0)
421 
422 #define	IPFW_RLOCK_ASSERT(_chain)	rm_assert(&(_chain)->rwmtx, RA_RLOCKED)
423 #define	IPFW_WLOCK_ASSERT(_chain)	rm_assert(&(_chain)->rwmtx, RA_WLOCKED)
424 
425 #define	IPFW_RLOCK_TRACKER		struct rm_priotracker _tracker
426 #define	IPFW_RLOCK(p)			rm_rlock(&(p)->rwmtx, &_tracker)
427 #define	IPFW_RUNLOCK(p)			rm_runlock(&(p)->rwmtx, &_tracker)
428 #define	IPFW_WLOCK(p)			rm_wlock(&(p)->rwmtx)
429 #define	IPFW_WUNLOCK(p)			rm_wunlock(&(p)->rwmtx)
430 #define	IPFW_PF_RLOCK(p)		IPFW_RLOCK(p)
431 #define	IPFW_PF_RUNLOCK(p)		IPFW_RUNLOCK(p)
432 #endif
433 
434 #define	IPFW_UH_RLOCK_ASSERT(_chain)	rw_assert(&(_chain)->uh_lock, RA_RLOCKED)
435 #define	IPFW_UH_WLOCK_ASSERT(_chain)	rw_assert(&(_chain)->uh_lock, RA_WLOCKED)
436 #define	IPFW_UH_UNLOCK_ASSERT(_chain)	rw_assert(&(_chain)->uh_lock, RA_UNLOCKED)
437 
438 #define IPFW_UH_RLOCK(p) rw_rlock(&(p)->uh_lock)
439 #define IPFW_UH_RUNLOCK(p) rw_runlock(&(p)->uh_lock)
440 #define IPFW_UH_WLOCK(p) rw_wlock(&(p)->uh_lock)
441 #define IPFW_UH_WUNLOCK(p) rw_wunlock(&(p)->uh_lock)
442 
443 struct obj_idx {
444 	uint16_t	uidx;	/* internal index supplied by userland */
445 	uint16_t	kidx;	/* kernel object index */
446 	uint16_t	off;	/* tlv offset from rule end in 4-byte words */
447 	uint8_t		spare;
448 	uint8_t		type;	/* object type within its category */
449 };
450 
451 struct rule_check_info {
452 	uint16_t	flags;		/* rule-specific check flags */
453 	uint16_t	table_opcodes;	/* count of opcodes referencing table */
454 	uint16_t	urule_numoff;	/* offset of rulenum in bytes */
455 	uint8_t		version;	/* rule version */
456 	uint8_t		spare;
457 	ipfw_obj_ctlv	*ctlv;		/* name TLV containter */
458 	struct ip_fw	*krule;		/* resulting rule pointer */
459 	caddr_t		urule;		/* original rule pointer */
460 	struct obj_idx	obuf[8];	/* table references storage */
461 };
462 
463 /* Legacy interface support */
464 /*
465  * FreeBSD 8 export rule format
466  */
467 struct ip_fw_rule0 {
468 	struct ip_fw	*x_next;	/* linked list of rules		*/
469 	struct ip_fw	*next_rule;	/* ptr to next [skipto] rule	*/
470 	/* 'next_rule' is used to pass up 'set_disable' status		*/
471 
472 	uint16_t	act_ofs;	/* offset of action in 32-bit units */
473 	uint16_t	cmd_len;	/* # of 32-bit words in cmd	*/
474 	uint16_t	rulenum;	/* rule number			*/
475 	uint8_t		set;		/* rule set (0..31)		*/
476 	uint8_t		_pad;		/* padding			*/
477 	uint32_t	id;		/* rule id */
478 
479 	/* These fields are present in all rules.			*/
480 	uint64_t	pcnt;		/* Packet counter		*/
481 	uint64_t	bcnt;		/* Byte counter			*/
482 	uint32_t	timestamp;	/* tv_sec of last match		*/
483 
484 	ipfw_insn	cmd[1];		/* storage for commands		*/
485 };
486 
487 struct ip_fw_bcounter0 {
488 	uint64_t	pcnt;		/* Packet counter		*/
489 	uint64_t	bcnt;		/* Byte counter			*/
490 	uint32_t	timestamp;	/* tv_sec of last match		*/
491 };
492 
493 /* Kernel rule length */
494 /*
495  * RULE _K_ SIZE _V_ ->
496  * get kernel size from userland rool version _V_.
497  * RULE _U_ SIZE _V_ ->
498  * get user size version _V_ from kernel rule
499  * RULESIZE _V_ ->
500  * get user size rule length
501  */
502 /* FreeBSD8 <> current kernel format */
503 #define	RULEUSIZE0(r)	(sizeof(struct ip_fw_rule0) + (r)->cmd_len * 4 - 4)
504 #define	RULEKSIZE0(r)	roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8)
505 /* FreeBSD11 <> current kernel format */
506 #define	RULEUSIZE1(r)	(roundup2(sizeof(struct ip_fw_rule) + \
507     (r)->cmd_len * 4 - 4, 8))
508 #define	RULEKSIZE1(r)	roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8)
509 
510 
511 /* In ip_fw_iface.c */
512 int ipfw_iface_init(void);
513 void ipfw_iface_destroy(void);
514 void vnet_ipfw_iface_destroy(struct ip_fw_chain *ch);
515 int ipfw_iface_ref(struct ip_fw_chain *ch, char *name,
516     struct ipfw_ifc *ic);
517 void ipfw_iface_unref(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
518 void ipfw_iface_add_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
519 void ipfw_iface_del_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
520 
521 /* In ip_fw_sockopt.c */
522 void ipfw_init_skipto_cache(struct ip_fw_chain *chain);
523 void ipfw_destroy_skipto_cache(struct ip_fw_chain *chain);
524 int ipfw_find_rule(struct ip_fw_chain *chain, uint32_t key, uint32_t id);
525 int ipfw_ctl3(struct sockopt *sopt);
526 int ipfw_chk(struct ip_fw_args *args);
527 void ipfw_reap_add(struct ip_fw_chain *chain, struct ip_fw **head,
528     struct ip_fw *rule);
529 void ipfw_reap_rules(struct ip_fw *head);
530 void ipfw_init_counters(void);
531 void ipfw_destroy_counters(void);
532 struct ip_fw *ipfw_alloc_rule(struct ip_fw_chain *chain, size_t rulesize);
533 int ipfw_match_range(struct ip_fw *rule, ipfw_range_tlv *rt);
534 
535 typedef int (sopt_handler_f)(struct ip_fw_chain *ch,
536     ip_fw3_opheader *op3, struct sockopt_data *sd);
537 struct ipfw_sopt_handler {
538 	uint16_t	opcode;
539 	uint8_t		version;
540 	uint8_t		dir;
541 	sopt_handler_f	*handler;
542 	uint64_t	refcnt;
543 };
544 #define	HDIR_SET	0x01	/* Handler is used to set some data */
545 #define	HDIR_GET	0x02	/* Handler is used to retrieve data */
546 #define	HDIR_BOTH	HDIR_GET|HDIR_SET
547 
548 void ipfw_init_sopt_handler(void);
549 void ipfw_destroy_sopt_handler(void);
550 void ipfw_add_sopt_handler(struct ipfw_sopt_handler *sh, size_t count);
551 int ipfw_del_sopt_handler(struct ipfw_sopt_handler *sh, size_t count);
552 caddr_t ipfw_get_sopt_space(struct sockopt_data *sd, size_t needed);
553 caddr_t ipfw_get_sopt_header(struct sockopt_data *sd, size_t needed);
554 #define	IPFW_ADD_SOPT_HANDLER(f, c)	do {	\
555 	if ((f) != 0) 				\
556 		ipfw_add_sopt_handler(c,	\
557 		    sizeof(c) / sizeof(c[0]));	\
558 	} while(0)
559 #define	IPFW_DEL_SOPT_HANDLER(l, c)	do {	\
560 	if ((l) != 0) 				\
561 		ipfw_del_sopt_handler(c,	\
562 		    sizeof(c) / sizeof(c[0]));	\
563 	} while(0)
564 
565 typedef void (objhash_cb_t)(struct namedobj_instance *ni, struct named_object *,
566     void *arg);
567 typedef uint32_t (objhash_hash_f)(struct namedobj_instance *ni, void *key,
568     uint32_t kopt);
569 typedef int (objhash_cmp_f)(struct named_object *no, void *key, uint32_t kopt);
570 struct namedobj_instance *ipfw_objhash_create(uint32_t items);
571 void ipfw_objhash_destroy(struct namedobj_instance *);
572 void ipfw_objhash_bitmap_alloc(uint32_t items, void **idx, int *pblocks);
573 void ipfw_objhash_bitmap_merge(struct namedobj_instance *ni,
574     void **idx, int *blocks);
575 void ipfw_objhash_bitmap_swap(struct namedobj_instance *ni,
576     void **idx, int *blocks);
577 void ipfw_objhash_bitmap_free(void *idx, int blocks);
578 void ipfw_objhash_set_hashf(struct namedobj_instance *ni, objhash_hash_f *f);
579 struct named_object *ipfw_objhash_lookup_name(struct namedobj_instance *ni,
580     uint32_t set, char *name);
581 struct named_object *ipfw_objhash_lookup_kidx(struct namedobj_instance *ni,
582     uint16_t idx);
583 int ipfw_objhash_same_name(struct namedobj_instance *ni, struct named_object *a,
584     struct named_object *b);
585 void ipfw_objhash_add(struct namedobj_instance *ni, struct named_object *no);
586 void ipfw_objhash_del(struct namedobj_instance *ni, struct named_object *no);
587 uint32_t ipfw_objhash_count(struct namedobj_instance *ni);
588 void ipfw_objhash_foreach(struct namedobj_instance *ni, objhash_cb_t *f,
589     void *arg);
590 int ipfw_objhash_free_idx(struct namedobj_instance *ni, uint16_t idx);
591 int ipfw_objhash_alloc_idx(void *n, uint16_t *pidx);
592 void ipfw_objhash_set_funcs(struct namedobj_instance *ni,
593     objhash_hash_f *hash_f, objhash_cmp_f *cmp_f);
594 
595 /* In ip_fw_table.c */
596 struct table_info;
597 
598 typedef int (table_lookup_t)(struct table_info *ti, void *key, uint32_t keylen,
599     uint32_t *val);
600 
601 int ipfw_lookup_table(struct ip_fw_chain *ch, uint16_t tbl, in_addr_t addr,
602     uint32_t *val);
603 int ipfw_lookup_table_extended(struct ip_fw_chain *ch, uint16_t tbl, uint16_t plen,
604     void *paddr, uint32_t *val);
605 int ipfw_init_tables(struct ip_fw_chain *ch, int first);
606 int ipfw_resize_tables(struct ip_fw_chain *ch, unsigned int ntables);
607 int ipfw_switch_tables_namespace(struct ip_fw_chain *ch, unsigned int nsets);
608 void ipfw_destroy_tables(struct ip_fw_chain *ch, int last);
609 
610 /* In ip_fw_nat.c -- XXX to be moved to ip_var.h */
611 
612 extern struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int);
613 
614 typedef int ipfw_nat_t(struct ip_fw_args *, struct cfg_nat *, struct mbuf *);
615 typedef int ipfw_nat_cfg_t(struct sockopt *);
616 
617 VNET_DECLARE(int, ipfw_nat_ready);
618 #define	V_ipfw_nat_ready	VNET(ipfw_nat_ready)
619 #define	IPFW_NAT_LOADED	(V_ipfw_nat_ready)
620 
621 extern ipfw_nat_t *ipfw_nat_ptr;
622 extern ipfw_nat_cfg_t *ipfw_nat_cfg_ptr;
623 extern ipfw_nat_cfg_t *ipfw_nat_del_ptr;
624 extern ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr;
625 extern ipfw_nat_cfg_t *ipfw_nat_get_log_ptr;
626 
627 #endif /* _KERNEL */
628 #endif /* _IPFW2_PRIVATE_H */
629