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