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