pfvar.h revision 171168
1223013Sdim/*	$FreeBSD: head/sys/contrib/pf/net/pfvar.h 171168 2007-07-03 12:16:07Z mlaier $	*/
2223013Sdim/*	$OpenBSD: pfvar.h,v 1.244 2007/02/23 21:31:51 deraadt Exp $ */
3223013Sdim
4223013Sdim/*
5223013Sdim * Copyright (c) 2001 Daniel Hartmeier
6223013Sdim * All rights reserved.
7223013Sdim *
8223013Sdim * Redistribution and use in source and binary forms, with or without
9223013Sdim * modification, are permitted provided that the following conditions
10223013Sdim * are met:
11223013Sdim *
12223013Sdim *    - Redistributions of source code must retain the above copyright
13223013Sdim *      notice, this list of conditions and the following disclaimer.
14223013Sdim *    - Redistributions in binary form must reproduce the above
15223013Sdim *      copyright notice, this list of conditions and the following
16223013Sdim *      disclaimer in the documentation and/or other materials provided
17223013Sdim *      with the distribution.
18243830Sdim *
19223013Sdim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20243830Sdim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21234353Sdim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22223013Sdim * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23223013Sdim * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24249423Sdim * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25223013Sdim * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26223013Sdim * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27223013Sdim * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28234353Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29234353Sdim * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30234353Sdim * POSSIBILITY OF SUCH DAMAGE.
31234353Sdim *
32223013Sdim */
33223013Sdim
34223013Sdim#ifndef _NET_PFVAR_H_
35223013Sdim#define _NET_PFVAR_H_
36223013Sdim
37223013Sdim#include <sys/param.h>
38223013Sdim#include <sys/types.h>
39223013Sdim#include <sys/queue.h>
40223013Sdim#include <sys/tree.h>
41223013Sdim#ifdef __FreeBSD__
42223013Sdim#include <sys/lock.h>
43263508Sdim#include <sys/sx.h>
44263508Sdim#else
45263508Sdim#include <sys/rwlock.h>
46223013Sdim#endif
47223013Sdim
48223013Sdim#include <net/radix.h>
49223013Sdim#include <net/route.h>
50249423Sdim#ifdef __FreeBSD__
51223013Sdim#include <net/if_clone.h>
52223013Sdim#include <net/pf_mtag.h>
53223013Sdim#include <vm/uma.h>
54223013Sdim#else
55223013Sdim#include <netinet/ip_ipsp.h>
56223013Sdim#endif
57239462Sdim
58239462Sdim#ifdef __FreeBSD__
59223013Sdim#include <netinet/in.h>
60223013Sdim#endif
61223013Sdim
62223013Sdim#include <netinet/tcp_fsm.h>
63223013Sdim
64243830Sdimstruct ip;
65243830Sdimstruct ip6_hdr;
66223013Sdim#ifdef __FreeBSD__
67243830Sdimstruct inpcb;
68243830Sdim#endif
69223013Sdim
70223013Sdim#define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
71223013Sdim#define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
72223013Sdim
73223013Sdim#define	PF_MD5_DIGEST_LENGTH	16
74223013Sdim#ifdef MD5_DIGEST_LENGTH
75223013Sdim#if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
76223013Sdim#error
77223013Sdim#endif
78223013Sdim#endif
79223013Sdim
80223013Sdimenum	{ PF_INOUT, PF_IN, PF_OUT };
81223013Sdimenum	{ PF_LAN_EXT, PF_EXT_GWY, PF_ID };
82223013Sdimenum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
83223013Sdim	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
84223013Sdimenum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
85249423Sdim	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
86223013Sdimenum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
87223013Sdim	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
88249423Sdimenum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
89249423Sdimenum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
90249423Sdim	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
91249423Sdim	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
92223013Sdimenum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
93223013Sdim
94223013Sdim/*
95249423Sdim * Note about PFTM_*: real indices into pf_rule.timeout[] come before
96224145Sdim * PFTM_MAX, special cases afterwards. See pf_state_expires().
97224145Sdim */
98223013Sdimenum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
99223013Sdim	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
100223013Sdim	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
101249423Sdim	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
102249423Sdim	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
103249423Sdim	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
104223013Sdim	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
105223013Sdim	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
106223013Sdim	  PFTM_UNTIL_PACKET };
107249423Sdim
108249423Sdim/* PFTM default values */
109249423Sdim#define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
110223013Sdim#define PFTM_TCP_OPENING_VAL		30	/* No response yet */
111249423Sdim#define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
112249423Sdim#define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
113223013Sdim#define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
114223013Sdim#define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
115223013Sdim#define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
116223013Sdim#define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
117223013Sdim#define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
118249423Sdim#define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
119249423Sdim#define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
120249423Sdim#define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
121249423Sdim#define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
122249423Sdim#define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
123249423Sdim#define PFTM_FRAG_VAL			30	/* Fragment expire */
124249423Sdim#define PFTM_INTERVAL_VAL		10	/* Expire interval */
125249423Sdim#define PFTM_SRC_NODE_VAL		0	/* Source tracking */
126223013Sdim#define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
127234353Sdim
128234353Sdimenum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
129234353Sdimenum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
130234353Sdim	  PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
131226633Sdim#define PF_POOL_IDMASK		0x0f
132226633Sdimenum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
133226633Sdim	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
134226633Sdimenum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
135226633Sdim	  PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED };
136249423Sdim#define PF_POOL_TYPEMASK	0x0f
137249423Sdim#define PF_POOL_STICKYADDR	0x20
138249423Sdim#define	PF_WSCALE_FLAG		0x80
139223013Sdim#define	PF_WSCALE_MASK		0x0f
140223013Sdim
141224145Sdim#define	PF_LOG			0x01
142223013Sdim#define	PF_LOG_ALL		0x02
143226633Sdim#define	PF_LOG_SOCKET_LOOKUP	0x04
144223013Sdim
145223013Sdimstruct pf_addr {
146223013Sdim	union {
147223013Sdim		struct in_addr		v4;
148223013Sdim		struct in6_addr		v6;
149223013Sdim		u_int8_t		addr8[16];
150263508Sdim		u_int16_t		addr16[8];
151263508Sdim		u_int32_t		addr32[4];
152263508Sdim	} pfa;		    /* 128-bit address */
153263508Sdim#define v4	pfa.v4
154263508Sdim#define v6	pfa.v6
155263508Sdim#define addr8	pfa.addr8
156263508Sdim#define addr16	pfa.addr16
157263508Sdim#define addr32	pfa.addr32
158263508Sdim};
159263508Sdim
160263508Sdim#define	PF_TABLE_NAME_SIZE	 32
161263508Sdim
162263508Sdim#define PFI_AFLAG_NETWORK	0x01
163263508Sdim#define PFI_AFLAG_BROADCAST	0x02
164263508Sdim#define PFI_AFLAG_PEER		0x04
165263508Sdim#define PFI_AFLAG_MODEMASK	0x07
166263508Sdim#define PFI_AFLAG_NOALIAS	0x08
167263508Sdim
168263508Sdimstruct pf_addr_wrap {
169263508Sdim	union {
170263508Sdim		struct {
171263508Sdim			struct pf_addr		 addr;
172263508Sdim			struct pf_addr		 mask;
173263508Sdim		}			 a;
174263508Sdim		char			 ifname[IFNAMSIZ];
175263508Sdim		char			 tblname[PF_TABLE_NAME_SIZE];
176263508Sdim#ifdef __FreeBSD__
177263508Sdim#define	RTLABEL_LEN	32
178263508Sdim#endif
179		char			 rtlabelname[RTLABEL_LEN];
180		u_int32_t		 rtlabel;
181	}			 v;
182	union {
183		struct pfi_dynaddr	*dyn;
184		struct pfr_ktable	*tbl;
185		int			 dyncnt;
186		int			 tblcnt;
187	}			 p;
188	u_int8_t		 type;		/* PF_ADDR_* */
189	u_int8_t		 iflags;	/* PFI_AFLAG_* */
190};
191
192#ifdef _KERNEL
193
194struct pfi_dynaddr {
195	TAILQ_ENTRY(pfi_dynaddr)	 entry;
196	struct pf_addr			 pfid_addr4;
197	struct pf_addr			 pfid_mask4;
198	struct pf_addr			 pfid_addr6;
199	struct pf_addr			 pfid_mask6;
200	struct pfr_ktable		*pfid_kt;
201	struct pfi_kif			*pfid_kif;
202	void				*pfid_hook_cookie;
203	int				 pfid_net;	/* mask or 128 */
204	int				 pfid_acnt4;	/* address count IPv4 */
205	int				 pfid_acnt6;	/* address count IPv6 */
206	sa_family_t			 pfid_af;	/* rule af */
207	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
208};
209
210/*
211 * Address manipulation macros
212 */
213
214#ifdef __FreeBSD__
215#define splsoftnet()	splnet()
216
217#define	HTONL(x)	(x) = htonl((__uint32_t)(x))
218#define	HTONS(x)	(x) = htons((__uint16_t)(x))
219#define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
220#define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
221
222#define PF_NAME		"pf"
223
224#define PR_NOWAIT	M_NOWAIT
225#define pool_get(p, f)	uma_zalloc(*(p), (f))
226#define pool_put(p, o)	uma_zfree(*(p), (o))
227
228#define UMA_CREATE(var, type, desc) \
229		var = uma_zcreate(desc, sizeof(type),	\
230			NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0); \
231		if (var == NULL) break
232#define UMA_DESTROY(var) \
233		if(var) uma_zdestroy(var)
234
235extern struct mtx pf_task_mtx;
236
237#define	PF_ASSERT(h) mtx_assert(&pf_task_mtx, (h))
238
239#define PF_LOCK()	do {			\
240	PF_ASSERT(MA_NOTOWNED);			\
241	mtx_lock(&pf_task_mtx);			\
242} while(0)
243#define PF_UNLOCK()	do {			\
244	PF_ASSERT(MA_OWNED);			\
245	mtx_unlock(&pf_task_mtx);		\
246} while(0)
247
248#define PF_COPYIN(uaddr, kaddr, len, r) do {	\
249	PF_UNLOCK();				\
250	r = copyin((uaddr), (kaddr), (len));	\
251	PF_LOCK();				\
252} while(0)
253
254#define PF_COPYOUT(kaddr, uaddr, len, r) do {	\
255	PF_UNLOCK();				\
256	r = copyout((kaddr), (uaddr), (len));	\
257	PF_LOCK();				\
258} while(0)
259
260extern void init_pf_mutex(void);
261extern void destroy_pf_mutex(void);
262
263#define PF_MODVER	1
264#define PFLOG_MODVER	1
265#define PFSYNC_MODVER	1
266
267#define PFLOG_MINVER	1
268#define PFLOG_PREFVER	PFLOG_MODVER
269#define PFLOG_MAXVER	1
270#define PFSYNC_MINVER	1
271#define PFSYNC_PREFVER	PFSYNC_MODVER
272#define PFSYNC_MAXVER	1
273#endif	/* __FreeBSD__ */
274
275#ifdef INET
276#ifndef INET6
277#define PF_INET_ONLY
278#endif /* ! INET6 */
279#endif /* INET */
280
281#ifdef INET6
282#ifndef INET
283#define PF_INET6_ONLY
284#endif /* ! INET */
285#endif /* INET6 */
286
287#ifdef INET
288#ifdef INET6
289#define PF_INET_INET6
290#endif /* INET6 */
291#endif /* INET */
292
293#else
294
295#define PF_INET_INET6
296
297#endif /* _KERNEL */
298
299/* Both IPv4 and IPv6 */
300#ifdef PF_INET_INET6
301
302#define PF_AEQ(a, b, c) \
303	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
304	((a)->addr32[3] == (b)->addr32[3] && \
305	(a)->addr32[2] == (b)->addr32[2] && \
306	(a)->addr32[1] == (b)->addr32[1] && \
307	(a)->addr32[0] == (b)->addr32[0])) \
308
309#define PF_ANEQ(a, b, c) \
310	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
311	((a)->addr32[3] != (b)->addr32[3] || \
312	(a)->addr32[2] != (b)->addr32[2] || \
313	(a)->addr32[1] != (b)->addr32[1] || \
314	(a)->addr32[0] != (b)->addr32[0])) \
315
316#define PF_AZERO(a, c) \
317	((c == AF_INET && !(a)->addr32[0]) || \
318	(!(a)->addr32[0] && !(a)->addr32[1] && \
319	!(a)->addr32[2] && !(a)->addr32[3] )) \
320
321#define PF_MATCHA(n, a, m, b, f) \
322	pf_match_addr(n, a, m, b, f)
323
324#define PF_ACPY(a, b, f) \
325	pf_addrcpy(a, b, f)
326
327#define PF_AINC(a, f) \
328	pf_addr_inc(a, f)
329
330#define PF_POOLMASK(a, b, c, d, f) \
331	pf_poolmask(a, b, c, d, f)
332
333#else
334
335/* Just IPv6 */
336
337#ifdef PF_INET6_ONLY
338
339#define PF_AEQ(a, b, c) \
340	((a)->addr32[3] == (b)->addr32[3] && \
341	(a)->addr32[2] == (b)->addr32[2] && \
342	(a)->addr32[1] == (b)->addr32[1] && \
343	(a)->addr32[0] == (b)->addr32[0]) \
344
345#define PF_ANEQ(a, b, c) \
346	((a)->addr32[3] != (b)->addr32[3] || \
347	(a)->addr32[2] != (b)->addr32[2] || \
348	(a)->addr32[1] != (b)->addr32[1] || \
349	(a)->addr32[0] != (b)->addr32[0]) \
350
351#define PF_AZERO(a, c) \
352	(!(a)->addr32[0] && \
353	!(a)->addr32[1] && \
354	!(a)->addr32[2] && \
355	!(a)->addr32[3] ) \
356
357#define PF_MATCHA(n, a, m, b, f) \
358	pf_match_addr(n, a, m, b, f)
359
360#define PF_ACPY(a, b, f) \
361	pf_addrcpy(a, b, f)
362
363#define PF_AINC(a, f) \
364	pf_addr_inc(a, f)
365
366#define PF_POOLMASK(a, b, c, d, f) \
367	pf_poolmask(a, b, c, d, f)
368
369#else
370
371/* Just IPv4 */
372#ifdef PF_INET_ONLY
373
374#define PF_AEQ(a, b, c) \
375	((a)->addr32[0] == (b)->addr32[0])
376
377#define PF_ANEQ(a, b, c) \
378	((a)->addr32[0] != (b)->addr32[0])
379
380#define PF_AZERO(a, c) \
381	(!(a)->addr32[0])
382
383#define PF_MATCHA(n, a, m, b, f) \
384	pf_match_addr(n, a, m, b, f)
385
386#define PF_ACPY(a, b, f) \
387	(a)->v4.s_addr = (b)->v4.s_addr
388
389#define PF_AINC(a, f) \
390	do { \
391		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
392	} while (0)
393
394#define PF_POOLMASK(a, b, c, d, f) \
395	do { \
396		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
397		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
398	} while (0)
399
400#endif /* PF_INET_ONLY */
401#endif /* PF_INET6_ONLY */
402#endif /* PF_INET_INET6 */
403
404#define	PF_MISMATCHAW(aw, x, af, neg, ifp)				\
405	(								\
406		(((aw)->type == PF_ADDR_NOROUTE &&			\
407		    pf_routable((x), (af), NULL)) ||			\
408		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
409		    pf_routable((x), (af), (ifp))) ||			\
410		((aw)->type == PF_ADDR_RTLABEL &&			\
411		    !pf_rtlabel_match((x), (af), (aw))) ||		\
412		((aw)->type == PF_ADDR_TABLE &&				\
413		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
414		((aw)->type == PF_ADDR_DYNIFTL &&			\
415		    !pfi_match_addr((aw)->p.dyn, (x), (af))) || 	\
416		((aw)->type == PF_ADDR_ADDRMASK &&			\
417		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
418		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
419		    &(aw)->v.a.mask, (x), (af))))) !=			\
420		(neg)							\
421	)
422
423
424struct pf_rule_uid {
425	uid_t		 uid[2];
426	u_int8_t	 op;
427};
428
429struct pf_rule_gid {
430	uid_t		 gid[2];
431	u_int8_t	 op;
432};
433
434struct pf_rule_addr {
435	struct pf_addr_wrap	 addr;
436	u_int16_t		 port[2];
437	u_int8_t		 neg;
438	u_int8_t		 port_op;
439};
440
441struct pf_pooladdr {
442	struct pf_addr_wrap		 addr;
443	TAILQ_ENTRY(pf_pooladdr)	 entries;
444	char				 ifname[IFNAMSIZ];
445	struct pfi_kif			*kif;
446};
447
448TAILQ_HEAD(pf_palist, pf_pooladdr);
449
450struct pf_poolhashkey {
451	union {
452		u_int8_t		key8[16];
453		u_int16_t		key16[8];
454		u_int32_t		key32[4];
455	} pfk;		    /* 128-bit hash key */
456#define key8	pfk.key8
457#define key16	pfk.key16
458#define key32	pfk.key32
459};
460
461struct pf_pool {
462	struct pf_palist	 list;
463	struct pf_pooladdr	*cur;
464	struct pf_poolhashkey	 key;
465	struct pf_addr		 counter;
466	int			 tblidx;
467	u_int16_t		 proxy_port[2];
468	u_int8_t		 port_op;
469	u_int8_t		 opts;
470};
471
472
473/* A packed Operating System description for fingerprinting */
474typedef u_int32_t pf_osfp_t;
475#define PF_OSFP_ANY	((pf_osfp_t)0)
476#define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
477#define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
478
479struct pf_osfp_entry {
480	SLIST_ENTRY(pf_osfp_entry) fp_entry;
481	pf_osfp_t		fp_os;
482	int			fp_enflags;
483#define PF_OSFP_EXPANDED	0x001		/* expanded entry */
484#define PF_OSFP_GENERIC		0x002		/* generic signature */
485#define PF_OSFP_NODETAIL	0x004		/* no p0f details */
486#define PF_OSFP_LEN	32
487	char			fp_class_nm[PF_OSFP_LEN];
488	char			fp_version_nm[PF_OSFP_LEN];
489	char			fp_subtype_nm[PF_OSFP_LEN];
490};
491#define PF_OSFP_ENTRY_EQ(a, b) \
492    ((a)->fp_os == (b)->fp_os && \
493    memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
494    memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
495    memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
496
497/* handle pf_osfp_t packing */
498#define _FP_RESERVED_BIT	1  /* For the special negative #defines */
499#define _FP_UNUSED_BITS		1
500#define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
501#define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
502#define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
503#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
504	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
505	    ((1 << _FP_CLASS_BITS) - 1); \
506	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
507	    ((1 << _FP_VERSION_BITS) - 1);\
508	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
509} while(0)
510#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
511	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
512	    + _FP_SUBTYPE_BITS); \
513	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
514	    _FP_SUBTYPE_BITS; \
515	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
516} while(0)
517
518/* the fingerprint of an OSes TCP SYN packet */
519typedef u_int64_t	pf_tcpopts_t;
520struct pf_os_fingerprint {
521	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
522	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
523	u_int16_t		fp_wsize;	/* TCP window size */
524	u_int16_t		fp_psize;	/* ip->ip_len */
525	u_int16_t		fp_mss;		/* TCP MSS */
526	u_int16_t		fp_flags;
527#define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
528#define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
529#define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
530#define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
531#define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
532#define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
533#define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
534#define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
535#define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
536#define PF_OSFP_MSS		0x0200		/* TCP MSS */
537#define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
538#define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
539#define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
540#define PF_OSFP_TS0		0x2000		/* Zero timestamp */
541#define PF_OSFP_INET6		0x4000		/* IPv6 */
542	u_int8_t		fp_optcnt;	/* TCP option count */
543	u_int8_t		fp_wscale;	/* TCP window scaling */
544	u_int8_t		fp_ttl;		/* IPv4 TTL */
545#define PF_OSFP_MAXTTL_OFFSET	40
546/* TCP options packing */
547#define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
548#define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
549#define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
550#define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
551#define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
552#define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
553#define PF_OSFP_MAX_OPTS \
554    (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
555    / PF_OSFP_TCPOPT_BITS
556
557	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
558};
559
560struct pf_osfp_ioctl {
561	struct pf_osfp_entry	fp_os;
562	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
563	u_int16_t		fp_wsize;	/* TCP window size */
564	u_int16_t		fp_psize;	/* ip->ip_len */
565	u_int16_t		fp_mss;		/* TCP MSS */
566	u_int16_t		fp_flags;
567	u_int8_t		fp_optcnt;	/* TCP option count */
568	u_int8_t		fp_wscale;	/* TCP window scaling */
569	u_int8_t		fp_ttl;		/* IPv4 TTL */
570
571	int			fp_getnum;	/* DIOCOSFPGET number */
572};
573
574
575union pf_rule_ptr {
576	struct pf_rule		*ptr;
577	u_int32_t		 nr;
578};
579
580#define	PF_ANCHOR_NAME_SIZE	 64
581
582struct pf_rule {
583	struct pf_rule_addr	 src;
584	struct pf_rule_addr	 dst;
585#define PF_SKIP_IFP		0
586#define PF_SKIP_DIR		1
587#define PF_SKIP_AF		2
588#define PF_SKIP_PROTO		3
589#define PF_SKIP_SRC_ADDR	4
590#define PF_SKIP_SRC_PORT	5
591#define PF_SKIP_DST_ADDR	6
592#define PF_SKIP_DST_PORT	7
593#define PF_SKIP_COUNT		8
594	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
595#define PF_RULE_LABEL_SIZE	 64
596	char			 label[PF_RULE_LABEL_SIZE];
597#define PF_QNAME_SIZE		 64
598	char			 ifname[IFNAMSIZ];
599	char			 qname[PF_QNAME_SIZE];
600	char			 pqname[PF_QNAME_SIZE];
601#define	PF_TAG_NAME_SIZE	 64
602	char			 tagname[PF_TAG_NAME_SIZE];
603	char			 match_tagname[PF_TAG_NAME_SIZE];
604
605	char			 overload_tblname[PF_TABLE_NAME_SIZE];
606
607	TAILQ_ENTRY(pf_rule)	 entries;
608	struct pf_pool		 rpool;
609
610	u_int64_t		 evaluations;
611	u_int64_t		 packets[2];
612	u_int64_t		 bytes[2];
613
614	struct pfi_kif		*kif;
615	struct pf_anchor	*anchor;
616	struct pfr_ktable	*overload_tbl;
617
618	pf_osfp_t		 os_fingerprint;
619
620	int			 rtableid;
621	u_int32_t		 timeout[PFTM_MAX];
622	u_int32_t		 states;
623	u_int32_t		 max_states;
624	u_int32_t		 src_nodes;
625	u_int32_t		 max_src_nodes;
626	u_int32_t		 max_src_states;
627	u_int32_t		 max_src_conn;
628	struct {
629		u_int32_t		limit;
630		u_int32_t		seconds;
631	}			 max_src_conn_rate;
632	u_int32_t		 qid;
633	u_int32_t		 pqid;
634	u_int32_t		 rt_listid;
635	u_int32_t		 nr;
636	u_int32_t		 prob;
637	uid_t			 cuid;
638	pid_t			 cpid;
639
640	u_int16_t		 return_icmp;
641	u_int16_t		 return_icmp6;
642	u_int16_t		 max_mss;
643	u_int16_t		 tag;
644	u_int16_t		 match_tag;
645
646	struct pf_rule_uid	 uid;
647	struct pf_rule_gid	 gid;
648
649	u_int32_t		 rule_flag;
650	u_int8_t		 action;
651	u_int8_t		 direction;
652	u_int8_t		 log;
653	u_int8_t		 logif;
654	u_int8_t		 quick;
655	u_int8_t		 ifnot;
656	u_int8_t		 match_tag_not;
657	u_int8_t		 natpass;
658
659#define PF_STATE_NORMAL		0x1
660#define PF_STATE_MODULATE	0x2
661#define PF_STATE_SYNPROXY	0x3
662	u_int8_t		 keep_state;
663	sa_family_t		 af;
664	u_int8_t		 proto;
665	u_int8_t		 type;
666	u_int8_t		 code;
667	u_int8_t		 flags;
668	u_int8_t		 flagset;
669	u_int8_t		 min_ttl;
670	u_int8_t		 allow_opts;
671	u_int8_t		 rt;
672	u_int8_t		 return_ttl;
673	u_int8_t		 tos;
674	u_int8_t		 anchor_relative;
675	u_int8_t		 anchor_wildcard;
676
677#define PF_FLUSH		0x01
678#define PF_FLUSH_GLOBAL		0x02
679	u_int8_t		 flush;
680};
681
682/* rule flags */
683#define	PFRULE_DROP		0x0000
684#define	PFRULE_RETURNRST	0x0001
685#define	PFRULE_FRAGMENT		0x0002
686#define	PFRULE_RETURNICMP	0x0004
687#define	PFRULE_RETURN		0x0008
688#define	PFRULE_NOSYNC		0x0010
689#define PFRULE_SRCTRACK		0x0020  /* track source states */
690#define PFRULE_RULESRCTRACK	0x0040  /* per rule */
691
692/* scrub flags */
693#define	PFRULE_NODF		0x0100
694#define	PFRULE_FRAGCROP		0x0200	/* non-buffering frag cache */
695#define	PFRULE_FRAGDROP		0x0400	/* drop funny fragments */
696#define PFRULE_RANDOMID		0x0800
697#define PFRULE_REASSEMBLE_TCP	0x1000
698
699/* rule flags again */
700#define PFRULE_IFBOUND		0x00010000	/* if-bound */
701
702#define PFSTATE_HIWAT		10000	/* default state table size */
703#define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
704#define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
705
706
707struct pf_threshold {
708	u_int32_t	limit;
709#define	PF_THRESHOLD_MULT	1000
710#define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
711	u_int32_t	seconds;
712	u_int32_t	count;
713	u_int32_t	last;
714};
715
716struct pf_src_node {
717	RB_ENTRY(pf_src_node) entry;
718	struct pf_addr	 addr;
719	struct pf_addr	 raddr;
720	union pf_rule_ptr rule;
721	struct pfi_kif	*kif;
722	u_int64_t	 bytes[2];
723	u_int64_t	 packets[2];
724	u_int32_t	 states;
725	u_int32_t	 conn;
726	struct pf_threshold	conn_rate;
727	u_int32_t	 creation;
728	u_int32_t	 expire;
729	sa_family_t	 af;
730	u_int8_t	 ruletype;
731};
732
733#define PFSNODE_HIWAT		10000	/* default source node table size */
734
735struct pf_state_scrub {
736	struct timeval	pfss_last;	/* time received last packet	*/
737	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
738	u_int32_t	pfss_tsval;	/* largest timestamp		*/
739	u_int32_t	pfss_tsval0;	/* original timestamp		*/
740	u_int16_t	pfss_flags;
741#define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
742#define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
743#define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
744#define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
745#define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
746	u_int8_t	pfss_ttl;	/* stashed TTL			*/
747	u_int8_t	pad;
748	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
749};
750
751struct pf_state_host {
752	struct pf_addr	addr;
753	u_int16_t	port;
754	u_int16_t	pad;
755};
756
757struct pf_state_peer {
758	u_int32_t	seqlo;		/* Max sequence number sent	*/
759	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
760	u_int32_t	seqdiff;	/* Sequence number modulator	*/
761	u_int16_t	max_win;	/* largest window (pre scaling)	*/
762	u_int8_t	state;		/* active state level		*/
763	u_int8_t	wscale;		/* window scaling factor	*/
764	u_int16_t	mss;		/* Maximum segment size option	*/
765	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
766	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
767	u_int8_t	pad[3];
768};
769
770TAILQ_HEAD(pf_state_queue, pf_state);
771
772/* keep synced with struct pf_state, used in RB_FIND */
773struct pf_state_cmp {
774	u_int64_t	 id;
775	u_int32_t	 creatorid;
776	struct pf_state_host lan;
777	struct pf_state_host gwy;
778	struct pf_state_host ext;
779	sa_family_t	 af;
780	u_int8_t	 proto;
781	u_int8_t	 direction;
782	u_int8_t	 pad;
783};
784
785struct pf_state {
786	u_int64_t	 id;
787	u_int32_t	 creatorid;
788	struct pf_state_host lan;
789	struct pf_state_host gwy;
790	struct pf_state_host ext;
791	sa_family_t	 af;
792	u_int8_t	 proto;
793	u_int8_t	 direction;
794#ifdef __FreeBSD__
795	u_int8_t	 local_flags;
796#define	PFSTATE_EXPIRING 0x01
797#else
798	u_int8_t	 pad;
799#endif
800	u_int8_t	 log;
801	u_int8_t	 allow_opts;
802	u_int8_t	 timeout;
803	u_int8_t	 sync_flags;
804#define	PFSTATE_NOSYNC	 0x01
805#define	PFSTATE_FROMSYNC 0x02
806#define	PFSTATE_STALE	 0x04
807	union {
808		struct {
809			RB_ENTRY(pf_state)	 entry_lan_ext;
810			RB_ENTRY(pf_state)	 entry_ext_gwy;
811			RB_ENTRY(pf_state)	 entry_id;
812			TAILQ_ENTRY(pf_state)	 entry_list;
813			struct pfi_kif		*kif;
814		} s;
815		char	 ifname[IFNAMSIZ];
816	} u;
817	struct pf_state_peer src;
818	struct pf_state_peer dst;
819	union pf_rule_ptr rule;
820	union pf_rule_ptr anchor;
821	union pf_rule_ptr nat_rule;
822	struct pf_addr	 rt_addr;
823	struct pfi_kif	*rt_kif;
824	struct pf_src_node	*src_node;
825	struct pf_src_node	*nat_src_node;
826	u_int64_t	 packets[2];
827	u_int64_t	 bytes[2];
828	u_int32_t	 creation;
829	u_int32_t	 expire;
830	u_int32_t	 pfsync_time;
831	u_int16_t	 tag;
832};
833
834TAILQ_HEAD(pf_rulequeue, pf_rule);
835
836struct pf_anchor;
837
838struct pf_ruleset {
839	struct {
840		struct pf_rulequeue	 queues[2];
841		struct {
842			struct pf_rulequeue	*ptr;
843			struct pf_rule		**ptr_array;
844			u_int32_t		 rcount;
845			u_int32_t		 ticket;
846			int			 open;
847		}			 active, inactive;
848	}			 rules[PF_RULESET_MAX];
849	struct pf_anchor	*anchor;
850	u_int32_t		 tticket;
851	int			 tables;
852	int			 topen;
853};
854
855RB_HEAD(pf_anchor_global, pf_anchor);
856RB_HEAD(pf_anchor_node, pf_anchor);
857struct pf_anchor {
858	RB_ENTRY(pf_anchor)	 entry_global;
859	RB_ENTRY(pf_anchor)	 entry_node;
860	struct pf_anchor	*parent;
861	struct pf_anchor_node	 children;
862	char			 name[PF_ANCHOR_NAME_SIZE];
863	char			 path[MAXPATHLEN];
864	struct pf_ruleset	 ruleset;
865	int			 refcnt;	/* anchor rules */
866	int			 match;
867};
868RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
869RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
870
871#define PF_RESERVED_ANCHOR	"_pf"
872
873#define PFR_TFLAG_PERSIST	0x00000001
874#define PFR_TFLAG_CONST		0x00000002
875#define PFR_TFLAG_ACTIVE	0x00000004
876#define PFR_TFLAG_INACTIVE	0x00000008
877#define PFR_TFLAG_REFERENCED	0x00000010
878#define PFR_TFLAG_REFDANCHOR	0x00000020
879#define PFR_TFLAG_USRMASK	0x00000003
880#define PFR_TFLAG_SETMASK	0x0000003C
881#define PFR_TFLAG_ALLMASK	0x0000003F
882
883struct pfr_table {
884	char			 pfrt_anchor[MAXPATHLEN];
885	char			 pfrt_name[PF_TABLE_NAME_SIZE];
886	u_int32_t		 pfrt_flags;
887	u_int8_t		 pfrt_fback;
888};
889
890enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
891	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
892	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
893
894struct pfr_addr {
895	union {
896		struct in_addr	 _pfra_ip4addr;
897		struct in6_addr	 _pfra_ip6addr;
898	}		 pfra_u;
899	u_int8_t	 pfra_af;
900	u_int8_t	 pfra_net;
901	u_int8_t	 pfra_not;
902	u_int8_t	 pfra_fback;
903};
904#define	pfra_ip4addr	pfra_u._pfra_ip4addr
905#define	pfra_ip6addr	pfra_u._pfra_ip6addr
906
907enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
908enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
909#define PFR_OP_XPASS	PFR_OP_ADDR_MAX
910
911struct pfr_astats {
912	struct pfr_addr	 pfras_a;
913	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
914	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
915	long		 pfras_tzero;
916};
917
918enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
919
920struct pfr_tstats {
921	struct pfr_table pfrts_t;
922	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
923	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
924	u_int64_t	 pfrts_match;
925	u_int64_t	 pfrts_nomatch;
926	long		 pfrts_tzero;
927	int		 pfrts_cnt;
928	int		 pfrts_refcnt[PFR_REFCNT_MAX];
929};
930#define	pfrts_name	pfrts_t.pfrt_name
931#define pfrts_flags	pfrts_t.pfrt_flags
932
933#ifndef _SOCKADDR_UNION_DEFINED
934#define	_SOCKADDR_UNION_DEFINED
935union sockaddr_union {
936	struct sockaddr		sa;
937	struct sockaddr_in	sin;
938	struct sockaddr_in6	sin6;
939};
940#endif /* _SOCKADDR_UNION_DEFINED */
941
942SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
943struct pfr_kentry {
944	struct radix_node	 pfrke_node[2];
945	union sockaddr_union	 pfrke_sa;
946	u_int64_t		 pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
947	u_int64_t		 pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
948	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
949	long			 pfrke_tzero;
950	u_int8_t		 pfrke_af;
951	u_int8_t		 pfrke_net;
952	u_int8_t		 pfrke_not;
953	u_int8_t		 pfrke_mark;
954	u_int8_t		 pfrke_intrpool;
955};
956
957SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
958RB_HEAD(pfr_ktablehead, pfr_ktable);
959struct pfr_ktable {
960	struct pfr_tstats	 pfrkt_ts;
961	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
962	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
963	struct radix_node_head	*pfrkt_ip4;
964	struct radix_node_head	*pfrkt_ip6;
965	struct pfr_ktable	*pfrkt_shadow;
966	struct pfr_ktable	*pfrkt_root;
967	struct pf_ruleset	*pfrkt_rs;
968	long			 pfrkt_larg;
969	int			 pfrkt_nflags;
970};
971#define pfrkt_t		pfrkt_ts.pfrts_t
972#define pfrkt_name	pfrkt_t.pfrt_name
973#define pfrkt_anchor	pfrkt_t.pfrt_anchor
974#define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
975#define pfrkt_flags	pfrkt_t.pfrt_flags
976#define pfrkt_cnt	pfrkt_ts.pfrts_cnt
977#define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
978#define pfrkt_packets	pfrkt_ts.pfrts_packets
979#define pfrkt_bytes	pfrkt_ts.pfrts_bytes
980#define pfrkt_match	pfrkt_ts.pfrts_match
981#define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
982#define pfrkt_tzero	pfrkt_ts.pfrts_tzero
983
984RB_HEAD(pf_state_tree_lan_ext, pf_state);
985RB_PROTOTYPE(pf_state_tree_lan_ext, pf_state,
986    u.s.entry_lan_ext, pf_state_compare_lan_ext);
987
988RB_HEAD(pf_state_tree_ext_gwy, pf_state);
989RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state,
990    u.s.entry_ext_gwy, pf_state_compare_ext_gwy);
991
992TAILQ_HEAD(pfi_statehead, pfi_kif);
993RB_HEAD(pfi_ifhead, pfi_kif);
994
995/* keep synced with pfi_kif, used in RB_FIND */
996struct pfi_kif_cmp {
997	char				 pfik_name[IFNAMSIZ];
998};
999
1000struct pfi_kif {
1001	char				 pfik_name[IFNAMSIZ];
1002	RB_ENTRY(pfi_kif)		 pfik_tree;
1003	u_int64_t			 pfik_packets[2][2][2];
1004	u_int64_t			 pfik_bytes[2][2][2];
1005	u_int32_t			 pfik_tzero;
1006	int				 pfik_flags;
1007	struct pf_state_tree_lan_ext	 pfik_lan_ext;
1008	struct pf_state_tree_ext_gwy	 pfik_ext_gwy;
1009	TAILQ_ENTRY(pfi_kif)		 pfik_w_states;
1010#ifndef __FreeBSD__
1011	void				*pfik_ah_cookie;
1012#endif
1013	struct ifnet			*pfik_ifp;
1014	struct ifg_group		*pfik_group;
1015	int				 pfik_states;
1016	int				 pfik_rules;
1017	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1018};
1019
1020enum pfi_kif_refs {
1021	PFI_KIF_REF_NONE,
1022	PFI_KIF_REF_STATE,
1023	PFI_KIF_REF_RULE
1024};
1025
1026#define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1027/* XXX: revisist */
1028#define PFI_IFLAG_SETABLE_MASK	0x0100	/* setable via DIOC{SET,CLR}IFFLAG */
1029#define PFI_IFLAG_PLACEHOLDER	0x8000	/* placeholder group/interface */
1030
1031struct pf_pdesc {
1032	struct {
1033		int	 done;
1034		uid_t	 uid;
1035		gid_t	 gid;
1036		pid_t	 pid;
1037	}		 lookup;
1038	u_int64_t	 tot_len;	/* Make Mickey money */
1039	union {
1040		struct tcphdr		*tcp;
1041		struct udphdr		*udp;
1042		struct icmp		*icmp;
1043#ifdef INET6
1044		struct icmp6_hdr	*icmp6;
1045#endif /* INET6 */
1046		void			*any;
1047	} hdr;
1048	struct pf_addr	 baddr;		/* address before translation */
1049	struct pf_addr	 naddr;		/* address after translation */
1050	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1051	struct pf_addr	*src;
1052	struct pf_addr	*dst;
1053	struct ether_header
1054			*eh;
1055	struct pf_mtag	*pf_mtag;
1056	u_int16_t	*ip_sum;
1057	u_int32_t	 p_len;		/* total length of payload */
1058	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1059					 * state code. Easier than tags */
1060#define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1061#define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1062	sa_family_t	 af;
1063	u_int8_t	 proto;
1064	u_int8_t	 tos;
1065};
1066
1067/* flags for RDR options */
1068#define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1069#define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1070
1071/* Reasons code for passing/dropping a packet */
1072#define PFRES_MATCH	0		/* Explicit match of a rule */
1073#define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1074#define PFRES_FRAG	2		/* Dropping following fragment */
1075#define PFRES_SHORT	3		/* Dropping short packet */
1076#define PFRES_NORM	4		/* Dropping by normalizer */
1077#define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1078#define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1079#define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1080#define PFRES_IPOPTIONS 8		/* IP option */
1081#define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1082#define PFRES_BADSTATE	10		/* State mismatch */
1083#define PFRES_STATEINS	11		/* State insertion failure */
1084#define PFRES_MAXSTATES	12		/* State limit */
1085#define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1086#define PFRES_SYNPROXY	14		/* SYN proxy */
1087#define PFRES_MAX	15		/* total+1 */
1088
1089#define PFRES_NAMES { \
1090	"match", \
1091	"bad-offset", \
1092	"fragment", \
1093	"short", \
1094	"normalize", \
1095	"memory", \
1096	"bad-timestamp", \
1097	"congestion", \
1098	"ip-option", \
1099	"proto-cksum", \
1100	"state-mismatch", \
1101	"state-insert", \
1102	"state-limit", \
1103	"src-limit", \
1104	"synproxy", \
1105	NULL \
1106}
1107
1108/* Counters for other things we want to keep track of */
1109#define LCNT_STATES		0	/* states */
1110#define LCNT_SRCSTATES		1	/* max-src-states */
1111#define LCNT_SRCNODES		2	/* max-src-nodes */
1112#define LCNT_SRCCONN		3	/* max-src-conn */
1113#define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1114#define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1115#define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1116#define LCNT_MAX		7	/* total+1 */
1117
1118#define LCNT_NAMES { \
1119	"max states per rule", \
1120	"max-src-states", \
1121	"max-src-nodes", \
1122	"max-src-conn", \
1123	"max-src-conn-rate", \
1124	"overload table insertion", \
1125	"overload flush states", \
1126	NULL \
1127}
1128
1129/* UDP state enumeration */
1130#define PFUDPS_NO_TRAFFIC	0
1131#define PFUDPS_SINGLE		1
1132#define PFUDPS_MULTIPLE		2
1133
1134#define PFUDPS_NSTATES		3	/* number of state levels */
1135
1136#define PFUDPS_NAMES { \
1137	"NO_TRAFFIC", \
1138	"SINGLE", \
1139	"MULTIPLE", \
1140	NULL \
1141}
1142
1143/* Other protocol state enumeration */
1144#define PFOTHERS_NO_TRAFFIC	0
1145#define PFOTHERS_SINGLE		1
1146#define PFOTHERS_MULTIPLE	2
1147
1148#define PFOTHERS_NSTATES	3	/* number of state levels */
1149
1150#define PFOTHERS_NAMES { \
1151	"NO_TRAFFIC", \
1152	"SINGLE", \
1153	"MULTIPLE", \
1154	NULL \
1155}
1156
1157#define FCNT_STATE_SEARCH	0
1158#define FCNT_STATE_INSERT	1
1159#define FCNT_STATE_REMOVALS	2
1160#define FCNT_MAX		3
1161
1162#define SCNT_SRC_NODE_SEARCH	0
1163#define SCNT_SRC_NODE_INSERT	1
1164#define SCNT_SRC_NODE_REMOVALS	2
1165#define SCNT_MAX		3
1166
1167#define ACTION_SET(a, x) \
1168	do { \
1169		if ((a) != NULL) \
1170			*(a) = (x); \
1171	} while (0)
1172
1173#define REASON_SET(a, x) \
1174	do { \
1175		if ((a) != NULL) \
1176			*(a) = (x); \
1177		if (x < PFRES_MAX) \
1178			pf_status.counters[x]++; \
1179	} while (0)
1180
1181struct pf_status {
1182	u_int64_t	counters[PFRES_MAX];
1183	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1184	u_int64_t	fcounters[FCNT_MAX];
1185	u_int64_t	scounters[SCNT_MAX];
1186	u_int64_t	pcounters[2][2][3];
1187	u_int64_t	bcounters[2][2];
1188	u_int64_t	stateid;
1189	u_int32_t	running;
1190	u_int32_t	states;
1191	u_int32_t	src_nodes;
1192	u_int32_t	since;
1193	u_int32_t	debug;
1194	u_int32_t	hostid;
1195	char		ifname[IFNAMSIZ];
1196	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1197};
1198
1199struct cbq_opts {
1200	u_int		minburst;
1201	u_int		maxburst;
1202	u_int		pktsize;
1203	u_int		maxpktsize;
1204	u_int		ns_per_byte;
1205	u_int		maxidle;
1206	int		minidle;
1207	u_int		offtime;
1208	int		flags;
1209};
1210
1211struct priq_opts {
1212	int		flags;
1213};
1214
1215struct hfsc_opts {
1216	/* real-time service curve */
1217	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
1218	u_int		rtsc_d;		/* the x-projection of m1 in msec */
1219	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
1220	/* link-sharing service curve */
1221	u_int		lssc_m1;
1222	u_int		lssc_d;
1223	u_int		lssc_m2;
1224	/* upper-limit service curve */
1225	u_int		ulsc_m1;
1226	u_int		ulsc_d;
1227	u_int		ulsc_m2;
1228	int		flags;
1229};
1230
1231struct pf_altq {
1232	char			 ifname[IFNAMSIZ];
1233
1234	void			*altq_disc;	/* discipline-specific state */
1235	TAILQ_ENTRY(pf_altq)	 entries;
1236
1237	/* scheduler spec */
1238	u_int8_t		 scheduler;	/* scheduler type */
1239	u_int16_t		 tbrsize;	/* tokenbucket regulator size */
1240	u_int32_t		 ifbandwidth;	/* interface bandwidth */
1241
1242	/* queue spec */
1243	char			 qname[PF_QNAME_SIZE];	/* queue name */
1244	char			 parent[PF_QNAME_SIZE];	/* parent name */
1245	u_int32_t		 parent_qid;	/* parent queue id */
1246	u_int32_t		 bandwidth;	/* queue bandwidth */
1247	u_int8_t		 priority;	/* priority */
1248	u_int16_t		 qlimit;	/* queue size limit */
1249	u_int16_t		 flags;		/* misc flags */
1250	union {
1251		struct cbq_opts		 cbq_opts;
1252		struct priq_opts	 priq_opts;
1253		struct hfsc_opts	 hfsc_opts;
1254	} pq_u;
1255
1256	u_int32_t		 qid;		/* return value */
1257};
1258
1259#ifndef __FreeBSD__
1260
1261#define	PF_TAG_GENERATED		0x01
1262#define	PF_TAG_FRAGCACHE		0x02
1263#define	PF_TAG_TRANSLATE_LOCALHOST	0x04
1264
1265struct pf_mtag {
1266	void		*hdr;		/* saved hdr pos in mbuf, for ECN */
1267	u_int		 rtableid;	/* alternate routing table id */
1268	u_int32_t	 qid;		/* queue id */
1269	u_int16_t	 tag;		/* tag id */
1270	u_int8_t	 flags;
1271	u_int8_t	 routed;
1272	sa_family_t	 af;		/* for ECN */
1273};
1274#endif
1275
1276struct pf_tag {
1277	u_int16_t	tag;		/* tag id */
1278};
1279
1280struct pf_tagname {
1281	TAILQ_ENTRY(pf_tagname)	entries;
1282	char			name[PF_TAG_NAME_SIZE];
1283	u_int16_t		tag;
1284	int			ref;
1285};
1286
1287#define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1288#define PFFRAG_FRAG_HIWAT	1000	/* Number of fragmented packets */
1289#define PFFRAG_FRCENT_HIWAT	50000	/* Number of fragment cache entries */
1290#define PFFRAG_FRCACHE_HIWAT	10000	/* Number of fragment descriptors */
1291
1292#define PFR_KTABLE_HIWAT	1000	/* Number of tables */
1293#define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1294#define PFR_KENTRY_HIWAT_SMALL	100000	/* Number of table entries (tiny hosts) */
1295
1296/*
1297 * ioctl parameter structures
1298 */
1299
1300struct pfioc_pooladdr {
1301	u_int32_t		 action;
1302	u_int32_t		 ticket;
1303	u_int32_t		 nr;
1304	u_int32_t		 r_num;
1305	u_int8_t		 r_action;
1306	u_int8_t		 r_last;
1307	u_int8_t		 af;
1308	char			 anchor[MAXPATHLEN];
1309	struct pf_pooladdr	 addr;
1310};
1311
1312struct pfioc_rule {
1313	u_int32_t	 action;
1314	u_int32_t	 ticket;
1315	u_int32_t	 pool_ticket;
1316	u_int32_t	 nr;
1317	char		 anchor[MAXPATHLEN];
1318	char		 anchor_call[MAXPATHLEN];
1319	struct pf_rule	 rule;
1320};
1321
1322struct pfioc_natlook {
1323	struct pf_addr	 saddr;
1324	struct pf_addr	 daddr;
1325	struct pf_addr	 rsaddr;
1326	struct pf_addr	 rdaddr;
1327	u_int16_t	 sport;
1328	u_int16_t	 dport;
1329	u_int16_t	 rsport;
1330	u_int16_t	 rdport;
1331	sa_family_t	 af;
1332	u_int8_t	 proto;
1333	u_int8_t	 direction;
1334};
1335
1336struct pfioc_state {
1337	u_int32_t	 nr;
1338	struct pf_state	 state;
1339};
1340
1341struct pfioc_src_node_kill {
1342	/* XXX returns the number of src nodes killed in psnk_af */
1343	sa_family_t psnk_af;
1344	struct pf_rule_addr psnk_src;
1345	struct pf_rule_addr psnk_dst;
1346};
1347
1348struct pfioc_state_kill {
1349	/* XXX returns the number of states killed in psk_af */
1350	sa_family_t		psk_af;
1351	int			psk_proto;
1352	struct pf_rule_addr	psk_src;
1353	struct pf_rule_addr	psk_dst;
1354	char			psk_ifname[IFNAMSIZ];
1355};
1356
1357struct pfioc_states {
1358	int	ps_len;
1359	union {
1360		caddr_t		 psu_buf;
1361		struct pf_state	*psu_states;
1362	} ps_u;
1363#define ps_buf		ps_u.psu_buf
1364#define ps_states	ps_u.psu_states
1365};
1366
1367struct pfioc_src_nodes {
1368	int	psn_len;
1369	union {
1370		caddr_t		 psu_buf;
1371		struct pf_src_node	*psu_src_nodes;
1372	} psn_u;
1373#define psn_buf		psn_u.psu_buf
1374#define psn_src_nodes	psn_u.psu_src_nodes
1375};
1376
1377struct pfioc_if {
1378	char		 ifname[IFNAMSIZ];
1379};
1380
1381struct pfioc_tm {
1382	int		 timeout;
1383	int		 seconds;
1384};
1385
1386struct pfioc_limit {
1387	int		 index;
1388	unsigned	 limit;
1389};
1390
1391struct pfioc_altq {
1392	u_int32_t	 action;
1393	u_int32_t	 ticket;
1394	u_int32_t	 nr;
1395	struct pf_altq	 altq;
1396};
1397
1398struct pfioc_qstats {
1399	u_int32_t	 ticket;
1400	u_int32_t	 nr;
1401	void		*buf;
1402	int		 nbytes;
1403	u_int8_t	 scheduler;
1404};
1405
1406struct pfioc_ruleset {
1407	u_int32_t	 nr;
1408	char		 path[MAXPATHLEN];
1409	char		 name[PF_ANCHOR_NAME_SIZE];
1410};
1411
1412#define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1413#define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1414struct pfioc_trans {
1415	int		 size;	/* number of elements */
1416	int		 esize; /* size of each element in bytes */
1417	struct pfioc_trans_e {
1418		int		rs_num;
1419		char		anchor[MAXPATHLEN];
1420		u_int32_t	ticket;
1421	}		*array;
1422};
1423
1424#define PFR_FLAG_ATOMIC		0x00000001
1425#define PFR_FLAG_DUMMY		0x00000002
1426#define PFR_FLAG_FEEDBACK	0x00000004
1427#define PFR_FLAG_CLSTATS	0x00000008
1428#define PFR_FLAG_ADDRSTOO	0x00000010
1429#define PFR_FLAG_REPLACE	0x00000020
1430#define PFR_FLAG_ALLRSETS	0x00000040
1431#define PFR_FLAG_ALLMASK	0x0000007F
1432#ifdef _KERNEL
1433#define PFR_FLAG_USERIOCTL	0x10000000
1434#endif
1435
1436struct pfioc_table {
1437	struct pfr_table	 pfrio_table;
1438	void			*pfrio_buffer;
1439	int			 pfrio_esize;
1440	int			 pfrio_size;
1441	int			 pfrio_size2;
1442	int			 pfrio_nadd;
1443	int			 pfrio_ndel;
1444	int			 pfrio_nchange;
1445	int			 pfrio_flags;
1446	u_int32_t		 pfrio_ticket;
1447};
1448#define	pfrio_exists	pfrio_nadd
1449#define	pfrio_nzero	pfrio_nadd
1450#define	pfrio_nmatch	pfrio_nadd
1451#define pfrio_naddr	pfrio_size2
1452#define pfrio_setflag	pfrio_size2
1453#define pfrio_clrflag	pfrio_nadd
1454
1455struct pfioc_iface {
1456	char	 pfiio_name[IFNAMSIZ];
1457	void	*pfiio_buffer;
1458	int	 pfiio_esize;
1459	int	 pfiio_size;
1460	int	 pfiio_nzero;
1461	int	 pfiio_flags;
1462};
1463
1464
1465/*
1466 * ioctl operations
1467 */
1468
1469#define DIOCSTART	_IO  ('D',  1)
1470#define DIOCSTOP	_IO  ('D',  2)
1471#define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1472#define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1473#define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1474/* XXX cut 8 - 17 */
1475#define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1476#define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1477#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1478#define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1479#define DIOCCLRSTATUS	_IO  ('D', 22)
1480#define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1481#define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1482#define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1483#define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1484/* XXX cut 26 - 28 */
1485#define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1486#define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1487#define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1488#define DIOCCLRRULECTRS	_IO  ('D', 38)
1489#define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1490#define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1491#define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1492#define DIOCSTARTALTQ	_IO  ('D', 42)
1493#define DIOCSTOPALTQ	_IO  ('D', 43)
1494#define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1495#define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1496#define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1497#define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1498#define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1499#define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1500#define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1501#define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1502#define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1503#define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1504/* XXX cut 55 - 57 */
1505#define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1506#define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1507#define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1508#define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1509#define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1510#define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1511#define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1512#define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1513#define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1514#define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1515#define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1516#define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1517#define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1518#define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1519#define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1520#define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1521#define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1522#define DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1523#define DIOCOSFPFLUSH	_IO('D', 78)
1524#define DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1525#define DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1526#define DIOCXBEGIN      _IOWR('D', 81, struct pfioc_trans)
1527#define DIOCXCOMMIT     _IOWR('D', 82, struct pfioc_trans)
1528#define DIOCXROLLBACK   _IOWR('D', 83, struct pfioc_trans)
1529#define DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1530#define DIOCCLRSRCNODES	_IO('D', 85)
1531#define DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1532#define DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1533#define DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1534#define DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1535#define DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1536#ifdef __FreeBSD__
1537struct pf_ifspeed {
1538	char			ifname[IFNAMSIZ];
1539	u_int32_t		baudrate;
1540};
1541#define DIOCGIFSPEED	_IOWR('D', 92, struct pf_ifspeed)
1542#endif
1543
1544#ifdef _KERNEL
1545RB_HEAD(pf_src_tree, pf_src_node);
1546RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1547extern struct pf_src_tree tree_src_tracking;
1548
1549RB_HEAD(pf_state_tree_id, pf_state);
1550RB_PROTOTYPE(pf_state_tree_id, pf_state,
1551    entry_id, pf_state_compare_id);
1552extern struct pf_state_tree_id tree_id;
1553extern struct pf_state_queue state_list;
1554
1555TAILQ_HEAD(pf_poolqueue, pf_pool);
1556extern struct pf_poolqueue		  pf_pools[2];
1557TAILQ_HEAD(pf_altqqueue, pf_altq);
1558extern struct pf_altqqueue		  pf_altqs[2];
1559extern struct pf_palist			  pf_pabuf;
1560
1561extern u_int32_t		 ticket_altqs_active;
1562extern u_int32_t		 ticket_altqs_inactive;
1563extern int			 altqs_inactive_open;
1564extern u_int32_t		 ticket_pabuf;
1565extern struct pf_altqqueue	*pf_altqs_active;
1566extern struct pf_altqqueue	*pf_altqs_inactive;
1567extern struct pf_poolqueue	*pf_pools_active;
1568extern struct pf_poolqueue	*pf_pools_inactive;
1569extern int			 pf_tbladdr_setup(struct pf_ruleset *,
1570				    struct pf_addr_wrap *);
1571extern void			 pf_tbladdr_remove(struct pf_addr_wrap *);
1572extern void			 pf_tbladdr_copyout(struct pf_addr_wrap *);
1573extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1574#ifdef __FreeBSD__
1575extern uma_zone_t		 pf_src_tree_pl, pf_rule_pl;
1576extern uma_zone_t		 pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1577extern uma_zone_t		 pfr_ktable_pl, pfr_kentry_pl, pfr_kentry_pl2;
1578extern uma_zone_t		 pf_cache_pl, pf_cent_pl;
1579extern uma_zone_t		 pf_state_scrub_pl;
1580extern uma_zone_t		 pfi_addr_pl;
1581#else
1582extern struct pool		 pf_src_tree_pl, pf_rule_pl;
1583extern struct pool		 pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1584extern struct pool		 pf_state_scrub_pl;
1585#endif
1586extern void			 pf_purge_thread(void *);
1587extern void			 pf_purge_expired_src_nodes(int);
1588extern void			 pf_purge_expired_states(u_int32_t);
1589extern void			 pf_unlink_state(struct pf_state *);
1590extern void			 pf_free_state(struct pf_state *);
1591extern int			 pf_insert_state(struct pfi_kif *,
1592				    struct pf_state *);
1593extern int			 pf_insert_src_node(struct pf_src_node **,
1594				    struct pf_rule *, struct pf_addr *,
1595				    sa_family_t);
1596void				 pf_src_tree_remove_state(struct pf_state *);
1597extern struct pf_state		*pf_find_state_byid(struct pf_state_cmp *);
1598extern struct pf_state		*pf_find_state_all(struct pf_state_cmp *key,
1599				    u_int8_t tree, int *more);
1600extern void			 pf_print_state(struct pf_state *);
1601extern void			 pf_print_flags(u_int8_t);
1602extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1603				    u_int8_t);
1604
1605extern struct ifnet		*sync_ifp;
1606extern struct pf_rule		 pf_default_rule;
1607extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1608				    u_int8_t);
1609void				 pf_rm_rule(struct pf_rulequeue *,
1610				    struct pf_rule *);
1611
1612#ifdef INET
1613#ifdef __FreeBSD__
1614int	pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *,
1615    struct inpcb *);
1616#else
1617int	pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *);
1618#endif
1619#endif /* INET */
1620
1621#ifdef INET6
1622#ifdef __FreeBSD__
1623int	pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *,
1624    struct inpcb *);
1625#else
1626int	pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *);
1627#endif
1628void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1629	    struct pf_addr *, struct pf_addr *, u_int8_t);
1630void	pf_addr_inc(struct pf_addr *, sa_family_t);
1631#endif /* INET6 */
1632
1633#ifdef __FreeBSD__
1634u_int32_t	pf_new_isn(struct pf_state *);
1635#endif
1636void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1637	    sa_family_t);
1638void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1639int	pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1640	    u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *,
1641	    struct pf_pdesc *);
1642int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1643	    struct pf_addr *, sa_family_t);
1644int	pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1645int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1646int	pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1647int	pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1648
1649void	pf_normalize_init(void);
1650int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1651	    struct pf_pdesc *);
1652int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1653	    struct pf_pdesc *);
1654int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1655	    struct pf_pdesc *);
1656void	pf_normalize_tcp_cleanup(struct pf_state *);
1657int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1658	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1659int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1660	    u_short *, struct tcphdr *, struct pf_state *,
1661	    struct pf_state_peer *, struct pf_state_peer *, int *);
1662u_int32_t
1663	pf_state_expires(const struct pf_state *);
1664void	pf_purge_expired_fragments(void);
1665int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *);
1666int	pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *);
1667#ifdef __FreeBSD__
1668int	pf_socket_lookup(int, struct pf_pdesc *, struct inpcb *);
1669#else
1670int	pf_socket_lookup(int, struct pf_pdesc *);
1671#endif
1672void	pfr_initialize(void);
1673int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1674void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1675	    u_int64_t, int, int, int);
1676int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1677	    struct pf_addr **, struct pf_addr **, sa_family_t);
1678void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1679struct pfr_ktable *
1680	pfr_attach_table(struct pf_ruleset *, char *);
1681void	pfr_detach_table(struct pfr_ktable *);
1682int	pfr_clr_tables(struct pfr_table *, int *, int);
1683int	pfr_add_tables(struct pfr_table *, int, int *, int);
1684int	pfr_del_tables(struct pfr_table *, int, int *, int);
1685int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1686int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1687int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1688int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1689int	pfr_clr_addrs(struct pfr_table *, int *, int);
1690int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1691int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1692	    int);
1693int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1694	    int);
1695int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1696	    int *, int *, int *, int, u_int32_t);
1697int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1698int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1699int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1700	    int);
1701int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1702	    int);
1703int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1704int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1705int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1706int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1707	    int *, u_int32_t, int);
1708
1709extern struct pfi_statehead	 pfi_statehead;
1710extern struct pfi_kif		*pfi_all;
1711
1712void		 pfi_initialize(void);
1713#ifdef __FreeBSD__
1714void		 pfi_cleanup(void);
1715#endif
1716struct pfi_kif	*pfi_kif_get(const char *);
1717void		 pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1718void		 pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1719int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1720void		 pfi_attach_ifnet(struct ifnet *);
1721void		 pfi_detach_ifnet(struct ifnet *);
1722void		 pfi_attach_ifgroup(struct ifg_group *);
1723void		 pfi_detach_ifgroup(struct ifg_group *);
1724void		 pfi_group_change(const char *);
1725int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1726		    sa_family_t);
1727int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1728void		 pfi_dynaddr_remove(struct pf_addr_wrap *);
1729void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1730void		 pfi_fill_oldstatus(struct pf_status *);
1731int		 pfi_clr_istats(const char *);
1732int		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1733int		 pfi_set_flags(const char *, int);
1734int		 pfi_clear_flags(const char *, int);
1735
1736u_int16_t	 pf_tagname2tag(char *);
1737void		 pf_tag2tagname(u_int16_t, char *);
1738void		 pf_tag_ref(u_int16_t);
1739void		 pf_tag_unref(u_int16_t);
1740int		 pf_tag_packet(struct mbuf *, struct pf_mtag *, int, int);
1741u_int32_t	 pf_qname2qid(char *);
1742void		 pf_qid2qname(u_int32_t, char *);
1743void		 pf_qid_unref(u_int32_t);
1744#ifndef __FreeBSD__
1745struct pf_mtag	*pf_find_mtag(struct mbuf *);
1746struct pf_mtag	*pf_get_mtag(struct mbuf *);
1747#endif
1748
1749extern struct pf_status	pf_status;
1750
1751#ifdef __FreeBSD__
1752extern uma_zone_t	pf_frent_pl, pf_frag_pl;
1753extern struct sx	pf_consistency_lock;
1754#else
1755extern struct pool	pf_frent_pl, pf_frag_pl;
1756extern struct rwlock	pf_consistency_lock;
1757#endif
1758
1759struct pf_pool_limit {
1760	void		*pp;
1761	unsigned	 limit;
1762};
1763extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
1764
1765#ifdef __FreeBSD__
1766struct pf_frent {
1767	LIST_ENTRY(pf_frent) fr_next;
1768	struct ip *fr_ip;
1769	struct mbuf *fr_m;
1770};
1771
1772struct pf_frcache {
1773	LIST_ENTRY(pf_frcache) fr_next;
1774	uint16_t        fr_off;
1775	uint16_t        fr_end;
1776};
1777
1778struct pf_fragment {
1779	RB_ENTRY(pf_fragment) fr_entry;
1780	TAILQ_ENTRY(pf_fragment) frag_next;
1781	struct in_addr  fr_src;
1782	struct in_addr  fr_dst;
1783	u_int8_t        fr_p;           /* protocol of this fragment */
1784	u_int8_t        fr_flags;       /* status flags */
1785	u_int16_t       fr_id;          /* fragment id for reassemble */
1786	u_int16_t       fr_max;         /* fragment data max */
1787	u_int32_t       fr_timeout;
1788#define fr_queue        fr_u.fru_queue
1789#define fr_cache        fr_u.fru_cache
1790	union {
1791		LIST_HEAD(pf_fragq, pf_frent) fru_queue;        /* buffering */
1792		LIST_HEAD(pf_cacheq, pf_frcache) fru_cache;     /* non-buf */
1793	} fr_u;
1794};
1795#endif /* (__FreeBSD__) */
1796
1797#endif /* _KERNEL */
1798
1799extern struct pf_anchor_global  pf_anchors;
1800extern struct pf_anchor        pf_main_anchor;
1801#define pf_main_ruleset	pf_main_anchor.ruleset
1802
1803/* these ruleset functions can be linked into userland programs (pfctl) */
1804int			 pf_get_ruleset_number(u_int8_t);
1805void			 pf_init_ruleset(struct pf_ruleset *);
1806int			 pf_anchor_setup(struct pf_rule *,
1807			    const struct pf_ruleset *, const char *);
1808int			 pf_anchor_copyout(const struct pf_ruleset *,
1809			    const struct pf_rule *, struct pfioc_rule *);
1810void			 pf_anchor_remove(struct pf_rule *);
1811void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1812struct pf_anchor	*pf_find_anchor(const char *);
1813struct pf_ruleset	*pf_find_ruleset(const char *);
1814struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1815void			 pf_rs_initialize(void);
1816
1817#ifndef __FreeBSD__
1818/* ?!? */
1819#ifdef _KERNEL
1820int			 pf_anchor_copyout(const struct pf_ruleset *,
1821			    const struct pf_rule *, struct pfioc_rule *);
1822void			 pf_anchor_remove(struct pf_rule *);
1823
1824#endif /* _KERNEL */
1825#endif
1826
1827/* The fingerprint functions can be linked into userland programs (tcpdump) */
1828int	pf_osfp_add(struct pf_osfp_ioctl *);
1829#ifdef _KERNEL
1830struct pf_osfp_enlist *
1831	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1832	    const struct tcphdr *);
1833#endif /* _KERNEL */
1834struct pf_osfp_enlist *
1835	pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1836	    const struct tcphdr *);
1837void	pf_osfp_flush(void);
1838int	pf_osfp_get(struct pf_osfp_ioctl *);
1839#ifdef __FreeBSD__
1840int	pf_osfp_initialize(void);
1841void	pf_osfp_cleanup(void);
1842#else
1843void	pf_osfp_initialize(void);
1844#endif
1845int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1846struct pf_os_fingerprint *
1847	pf_osfp_validate(void);
1848
1849
1850#endif /* _NET_PFVAR_H_ */
1851