pfvar.h revision 127145
1/*	$FreeBSD: head/sys/contrib/pf/net/pfvar.h 127145 2004-03-17 21:11:02Z mlaier $	*/
2/*	$OpenBSD: pfvar.h,v 1.170 2003/08/22 21:50:34 david 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/types.h>
38#include <sys/queue.h>
39#include <sys/tree.h>
40
41#include <net/radix.h>
42#ifdef __FreeBSD__
43#include <vm/uma.h>
44#else
45#include <netinet/ip_ipsp.h>
46#endif
47
48#ifdef __FreeBSD__
49#include <netinet/in.h>
50/*
51 * XXX
52 *  If we include <netipsec/keydb.h>, we need _KERNEL definition.
53 *  This makes pfctl compilation difficult.
54 */
55union sockaddr_union {
56	struct sockaddr		sa;
57	struct sockaddr_in	sin;
58	struct sockaddr_in6	sin6;
59};
60#endif
61
62#include <netinet/tcp_fsm.h>
63
64struct ip;
65
66#define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
67#define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
68
69enum	{ PF_INOUT, PF_IN, PF_OUT };
70enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NAT, PF_NONAT,
71	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
72enum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
73	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
74enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
75	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
76enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
77enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
78	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
79	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
80/*
81 * Note about PFTM_*: real indices into pf_rule.timeout[] come before
82 * PFTM_MAX, special cases afterwards. See pf_state_expires().
83 */
84enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
85	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
86	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
87	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
88	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
89	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
90	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_MAX,
91	  PFTM_PURGE, PFTM_UNTIL_PACKET };
92enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
93enum	{ PF_LIMIT_STATES, PF_LIMIT_FRAGS, PF_LIMIT_MAX };
94#define PF_POOL_IDMASK		0x0f
95enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
96	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
97enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
98	  PF_ADDR_TABLE };
99#define PF_POOL_TYPEMASK	0x0f
100#define	PF_WSCALE_FLAG		0x80
101#define	PF_WSCALE_MASK		0x0f
102
103struct pf_addr {
104	union {
105		struct in_addr		v4;
106		struct in6_addr		v6;
107		u_int8_t		addr8[16];
108		u_int16_t		addr16[8];
109		u_int32_t		addr32[4];
110	} pfa;		    /* 128-bit address */
111#define v4	pfa.v4
112#define v6	pfa.v6
113#define addr8	pfa.addr8
114#define addr16	pfa.addr16
115#define addr32	pfa.addr32
116};
117
118#define	PF_TABLE_NAME_SIZE	 32
119
120struct pf_addr_wrap {
121	union {
122		struct {
123			struct pf_addr		 addr;
124			struct pf_addr		 mask;
125		}			 a;
126		char			 ifname[IFNAMSIZ];
127		char			 tblname[PF_TABLE_NAME_SIZE];
128	}			 v;
129	union {
130		struct pf_addr_dyn	*dyn;
131		struct pfr_ktable	*tbl;
132		int			 tblcnt;
133	}			 p;
134	u_int8_t		 type;		/* PF_ADDR_* */
135};
136
137#ifdef _KERNEL
138
139struct pf_addr_dyn {
140	char			 ifname[IFNAMSIZ];
141	struct ifnet		*ifp;
142	struct pf_addr		*addr;
143	sa_family_t		 af;
144#ifdef __FreeBSD__
145	eventhandler_tag	 hook_cookie;
146#else
147	void			*hook_cookie;
148#endif
149	u_int8_t		 undefined;
150};
151
152/*
153 * Address manipulation macros
154 */
155
156#ifdef __FreeBSD__
157#define splsoftnet()	splnet()
158
159#define	HTONL(x)	(x) = htonl((__uint32_t)(x))
160#define	HTONS(x)	(x) = htons((__uint16_t)(x))
161#define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
162#define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
163
164#define PF_NAME		"pf"
165
166#define PR_NOWAIT	M_NOWAIT
167#define pool_get(p, f)	uma_zalloc(*(p), (f))
168#define pool_put(p, o)	uma_zfree(*(p), (o))
169
170#define UMA_CREATE(var, type, desc) \
171		var = uma_zcreate(desc, sizeof(type),	\
172			NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0); \
173		if (var == NULL) break
174#define UMA_DESTROY(var) \
175		if(var) uma_zdestroy(var)
176
177extern struct mtx pf_task_mtx;
178#ifdef ALTQ
179extern struct mtx pf_altq_mtx;
180extern int pfaltq_ref;
181#endif
182
183#define	PF_ASSERT(h) mtx_assert(&pf_task_mtx, (h))
184
185#define PF_LOCK()	do {			\
186	PF_ASSERT(MA_NOTOWNED);			\
187	mtx_lock(&pf_task_mtx);			\
188} while(0)
189#define PF_UNLOCK()	do {			\
190	PF_ASSERT(MA_OWNED);			\
191	mtx_unlock(&pf_task_mtx);		\
192} while(0)
193
194#define PF_COPYIN(uaddr, kaddr, len, r) do {	\
195	PF_UNLOCK();				\
196	r = copyin((uaddr), (kaddr), (len));	\
197	PF_LOCK();				\
198} while(0)
199
200#define PF_COPYOUT(kaddr, uaddr, len, r) do {	\
201	PF_UNLOCK();				\
202	r = copyout((kaddr), (uaddr), (len));	\
203	PF_LOCK();				\
204} while(0)
205
206extern void init_pf_mutex(void);
207extern void destroy_pf_mutex(void);
208
209#define PF_MODVER	1
210#define PFLOG_MODVER	1
211#define PFSYNC_MODVER	1
212
213#define PFLOG_MINVER	1
214#define PFLOG_PREFVER	PFLOG_MODVER
215#define PFLOG_MAXVER	1
216#define PFSYNC_MINVER	1
217#define PFSYNC_PREFVER	PFSYNC_MODVER
218#define PFSYNC_MAXVER	1
219#endif
220
221#ifdef INET
222#ifndef INET6
223#define PF_INET_ONLY
224#endif /* ! INET6 */
225#endif /* INET */
226
227#ifdef INET6
228#ifndef INET
229#define PF_INET6_ONLY
230#endif /* ! INET */
231#endif /* INET6 */
232
233#ifdef INET
234#ifdef INET6
235#define PF_INET_INET6
236#endif /* INET6 */
237#endif /* INET */
238
239#else
240
241#define PF_INET_INET6
242
243#endif /* _KERNEL */
244
245/* Both IPv4 and IPv6 */
246#ifdef PF_INET_INET6
247
248#define PF_AEQ(a, b, c) \
249	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
250	((a)->addr32[3] == (b)->addr32[3] && \
251	(a)->addr32[2] == (b)->addr32[2] && \
252	(a)->addr32[1] == (b)->addr32[1] && \
253	(a)->addr32[0] == (b)->addr32[0])) \
254
255#define PF_ANEQ(a, b, c) \
256	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
257	((a)->addr32[3] != (b)->addr32[3] || \
258	(a)->addr32[2] != (b)->addr32[2] || \
259	(a)->addr32[1] != (b)->addr32[1] || \
260	(a)->addr32[0] != (b)->addr32[0])) \
261
262#define PF_AZERO(a, c) \
263	((c == AF_INET && !(a)->addr32[0]) || \
264	(!(a)->addr32[0] && !(a)->addr32[1] && \
265	!(a)->addr32[2] && !(a)->addr32[3] )) \
266
267#define PF_MATCHA(n, a, m, b, f) \
268	pf_match_addr(n, a, m, b, f)
269
270#define PF_ACPY(a, b, f) \
271	pf_addrcpy(a, b, f)
272
273#define PF_AINC(a, f) \
274	pf_addr_inc(a, f)
275
276#define PF_POOLMASK(a, b, c, d, f) \
277	pf_poolmask(a, b, c, d, f)
278
279#else
280
281/* Just IPv6 */
282
283#ifdef PF_INET6_ONLY
284
285#define PF_AEQ(a, b, c) \
286	((a)->addr32[3] == (b)->addr32[3] && \
287	(a)->addr32[2] == (b)->addr32[2] && \
288	(a)->addr32[1] == (b)->addr32[1] && \
289	(a)->addr32[0] == (b)->addr32[0]) \
290
291#define PF_ANEQ(a, b, c) \
292	((a)->addr32[3] != (b)->addr32[3] || \
293	(a)->addr32[2] != (b)->addr32[2] || \
294	(a)->addr32[1] != (b)->addr32[1] || \
295	(a)->addr32[0] != (b)->addr32[0]) \
296
297#define PF_AZERO(a, c) \
298	(!(a)->addr32[0] && \
299	!(a)->addr32[1] && \
300	!(a)->addr32[2] && \
301	!(a)->addr32[3] ) \
302
303#define PF_MATCHA(n, a, m, b, f) \
304	pf_match_addr(n, a, m, b, f)
305
306#define PF_ACPY(a, b, f) \
307	pf_addrcpy(a, b, f)
308
309#define PF_AINC(a, f) \
310	pf_addr_inc(a, f)
311
312#define PF_POOLMASK(a, b, c, d, f) \
313	pf_poolmask(a, b, c, d, f)
314
315#else
316
317/* Just IPv4 */
318#ifdef PF_INET_ONLY
319
320#define PF_AEQ(a, b, c) \
321	((a)->addr32[0] == (b)->addr32[0])
322
323#define PF_ANEQ(a, b, c) \
324	((a)->addr32[0] != (b)->addr32[0])
325
326#define PF_AZERO(a, c) \
327	(!(a)->addr32[0])
328
329#define PF_MATCHA(n, a, m, b, f) \
330	pf_match_addr(n, a, m, b, f)
331
332#define PF_ACPY(a, b, f) \
333	(a)->v4.s_addr = (b)->v4.s_addr
334
335#define PF_AINC(a, f) \
336	do { \
337		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
338	} while (0)
339
340#define PF_POOLMASK(a, b, c, d, f) \
341	do { \
342		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
343		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
344	} while (0)
345
346#endif /* PF_INET_ONLY */
347#endif /* PF_INET6_ONLY */
348#endif /* PF_INET_INET6 */
349
350#define	PF_MISMATCHAW(aw, x, af, not)				\
351	(							\
352		(((aw)->type == PF_ADDR_NOROUTE &&		\
353		    pf_routable((x), (af))) ||			\
354		((aw)->type == PF_ADDR_TABLE &&			\
355		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||	\
356		((aw)->type == PF_ADDR_DYNIFTL &&		\
357		    ((aw)->p.dyn->undefined ||			\
358		    (!PF_AZERO(&(aw)->v.a.mask, (af)) &&	\
359		    !PF_MATCHA(0, &(aw)->v.a.addr,		\
360		    &(aw)->v.a.mask, (x), (af))))) ||		\
361		((aw)->type == PF_ADDR_ADDRMASK &&		\
362		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&		\
363		    !PF_MATCHA(0, &(aw)->v.a.addr,		\
364		    &(aw)->v.a.mask, (x), (af)))) !=		\
365		(not)						\
366	)
367
368struct pf_rule_uid {
369	uid_t		 uid[2];
370	u_int8_t	 op;
371};
372
373struct pf_rule_gid {
374	uid_t		 gid[2];
375	u_int8_t	 op;
376};
377
378struct pf_rule_addr {
379	struct pf_addr_wrap	 addr;
380	u_int16_t		 port[2];
381	u_int8_t		 not;
382	u_int8_t		 port_op;
383};
384
385struct pf_pooladdr {
386	struct pf_addr_wrap		 addr;
387	TAILQ_ENTRY(pf_pooladdr)	 entries;
388	char				 ifname[IFNAMSIZ];
389	struct ifnet			*ifp;
390};
391
392TAILQ_HEAD(pf_palist, pf_pooladdr);
393
394struct pf_poolhashkey {
395	union {
396		u_int8_t		key8[16];
397		u_int16_t		key16[8];
398		u_int32_t		key32[4];
399	} pfk;		    /* 128-bit hash key */
400#define key8	pfk.key8
401#define key16	pfk.key16
402#define key32	pfk.key32
403};
404
405struct pf_pool {
406	struct pf_palist	 list;
407	struct pf_pooladdr	*cur;
408	struct pf_poolhashkey	 key;
409	struct pf_addr		 counter;
410	int			 tblidx;
411	u_int16_t		 proxy_port[2];
412	u_int8_t		 port_op;
413	u_int8_t		 opts;
414};
415
416
417/* A packed Operating System description for fingerprinting */
418typedef u_int32_t pf_osfp_t;
419#define PF_OSFP_ANY	((pf_osfp_t)0)
420#define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
421#define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
422
423struct pf_osfp_entry {
424	SLIST_ENTRY(pf_osfp_entry) fp_entry;
425	pf_osfp_t		fp_os;
426	int			fp_enflags;
427#define PF_OSFP_EXPANDED	0x001		/* expanded entry */
428#define PF_OSFP_GENERIC		0x002		/* generic signature */
429#define PF_OSFP_NODETAIL	0x004		/* no p0f details */
430#define PF_OSFP_LEN	32
431	char			fp_class_nm[PF_OSFP_LEN];
432	char			fp_version_nm[PF_OSFP_LEN];
433	char			fp_subtype_nm[PF_OSFP_LEN];
434};
435#define PF_OSFP_ENTRY_EQ(a, b) \
436    ((a)->fp_os == (b)->fp_os && \
437    memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
438    memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
439    memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
440
441/* handle pf_osfp_t packing */
442#define _FP_RESERVED_BIT	1  /* For the special negative #defines */
443#define _FP_UNUSED_BITS		1
444#define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
445#define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
446#define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
447#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
448	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
449	    ((1 << _FP_CLASS_BITS) - 1); \
450	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
451	    ((1 << _FP_VERSION_BITS) - 1);\
452	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
453} while(0)
454#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
455	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
456	    + _FP_SUBTYPE_BITS); \
457	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
458	    _FP_SUBTYPE_BITS; \
459	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
460} while(0)
461
462/* the fingerprint of an OSes TCP SYN packet */
463typedef u_int64_t	pf_tcpopts_t;
464struct pf_os_fingerprint {
465	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
466	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
467	u_int16_t		fp_wsize;	/* TCP window size */
468	u_int16_t		fp_psize;	/* ip->ip_len */
469	u_int16_t		fp_mss;		/* TCP MSS */
470	u_int16_t		fp_flags;
471#define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
472#define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
473#define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
474#define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
475#define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
476#define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
477#define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
478#define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
479#define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
480#define PF_OSFP_MSS		0x0200		/* TCP MSS */
481#define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
482#define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
483#define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
484#define PF_OSFP_TS0		0x2000		/* Zero timestamp */
485	u_int8_t		fp_optcnt;	/* TCP option count */
486	u_int8_t		fp_wscale;	/* TCP window scaling */
487	u_int8_t		fp_ttl;		/* IPv4 TTL */
488#define PF_OSFP_MAXTTL_OFFSET	40
489/* TCP options packing */
490#define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
491#define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
492#define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
493#define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
494#define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
495#define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
496#define PF_OSFP_MAX_OPTS \
497    (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
498    / PF_OSFP_TCPOPT_BITS
499
500	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
501};
502
503struct pf_osfp_ioctl {
504	struct pf_osfp_entry	fp_os;
505	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
506	u_int16_t		fp_wsize;	/* TCP window size */
507	u_int16_t		fp_psize;	/* ip->ip_len */
508	u_int16_t		fp_mss;		/* TCP MSS */
509	u_int16_t		fp_flags;
510	u_int8_t		fp_optcnt;	/* TCP option count */
511	u_int8_t		fp_wscale;	/* TCP window scaling */
512	u_int8_t		fp_ttl;		/* IPv4 TTL */
513
514	int			fp_getnum;	/* DIOCOSFPGET number */
515};
516
517
518union pf_rule_ptr {
519	struct pf_rule		*ptr;
520	u_int32_t		 nr;
521};
522
523struct pf_rule {
524	struct pf_rule_addr	 src;
525	struct pf_rule_addr	 dst;
526#define PF_SKIP_IFP		0
527#define PF_SKIP_DIR		1
528#define PF_SKIP_AF		2
529#define PF_SKIP_PROTO		3
530#define PF_SKIP_SRC_ADDR	4
531#define PF_SKIP_SRC_PORT	5
532#define PF_SKIP_DST_ADDR	6
533#define PF_SKIP_DST_PORT	7
534#define PF_SKIP_COUNT		8
535	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
536#define PF_RULE_LABEL_SIZE	 64
537	char			 label[PF_RULE_LABEL_SIZE];
538	u_int32_t		 timeout[PFTM_MAX];
539#define PF_QNAME_SIZE		 16
540	char			 ifname[IFNAMSIZ];
541	char			 qname[PF_QNAME_SIZE];
542	char			 pqname[PF_QNAME_SIZE];
543#define	PF_ANCHOR_NAME_SIZE	 16
544	char			 anchorname[PF_ANCHOR_NAME_SIZE];
545#define	PF_TAG_NAME_SIZE	 16
546	char			 tagname[PF_TAG_NAME_SIZE];
547	char			 match_tagname[PF_TAG_NAME_SIZE];
548
549	TAILQ_ENTRY(pf_rule)	 entries;
550	struct pf_pool		 rpool;
551
552	u_int64_t		 evaluations;
553	u_int64_t		 packets;
554	u_int64_t		 bytes;
555
556	struct ifnet		*ifp;
557	struct pf_anchor	*anchor;
558
559	pf_osfp_t		 os_fingerprint;
560	u_int32_t		 states;
561	u_int32_t		 max_states;
562	u_int32_t		 qid;
563	u_int32_t		 pqid;
564	u_int32_t		 rt_listid;
565	u_int32_t		 nr;
566
567	u_int16_t		 return_icmp;
568	u_int16_t		 return_icmp6;
569	u_int16_t		 max_mss;
570	u_int16_t		 tag;
571	u_int16_t		 match_tag;
572
573	struct pf_rule_uid	 uid;
574	struct pf_rule_gid	 gid;
575
576	u_int32_t		 rule_flag;
577	u_int8_t		 action;
578	u_int8_t		 direction;
579	u_int8_t		 log;
580	u_int8_t		 quick;
581	u_int8_t		 ifnot;
582	u_int8_t		 match_tag_not;
583	u_int8_t		 natpass;
584
585#define PF_STATE_NORMAL		0x1
586#define PF_STATE_MODULATE	0x2
587#define PF_STATE_SYNPROXY	0x3
588	u_int8_t		 keep_state;
589	sa_family_t		 af;
590	u_int8_t		 proto;
591	u_int8_t		 type;
592	u_int8_t		 code;
593	u_int8_t		 flags;
594	u_int8_t		 flagset;
595	u_int8_t		 min_ttl;
596	u_int8_t		 allow_opts;
597	u_int8_t		 rt;
598	u_int8_t		 return_ttl;
599	u_int8_t		 tos;
600};
601
602/* rule flags */
603#define	PFRULE_DROP		0x0000
604#define	PFRULE_RETURNRST	0x0001
605#define	PFRULE_FRAGMENT		0x0002
606#define	PFRULE_RETURNICMP	0x0004
607#define	PFRULE_RETURN		0x0008
608
609/* scrub flags */
610#define	PFRULE_NODF		0x0100
611#define	PFRULE_FRAGCROP		0x0200	/* non-buffering frag cache */
612#define	PFRULE_FRAGDROP		0x0400	/* drop funny fragments */
613#define PFRULE_RANDOMID		0x0800
614#define PFRULE_REASSEMBLE_TCP	0x1000
615
616#define PFSTATE_HIWAT		10000	/* default state table size */
617
618
619struct pf_state_scrub {
620	u_int16_t	pfss_flags;
621#define PFSS_TIMESTAMP	0x0001		/* modulate timestamp	*/
622	u_int8_t	pfss_ttl;	/* stashed TTL		*/
623	u_int8_t	pad;
624	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
625};
626
627struct pf_state_host {
628	struct pf_addr	addr;
629	u_int16_t	port;
630	u_int16_t	pad;
631};
632
633struct pf_state_peer {
634	u_int32_t	seqlo;		/* Max sequence number sent	*/
635	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
636	u_int32_t	seqdiff;	/* Sequence number modulator	*/
637	u_int16_t	max_win;	/* largest window (pre scaling)	*/
638	u_int8_t	state;		/* active state level		*/
639	u_int8_t	wscale;		/* window scaling factor	*/
640	u_int16_t	mss;		/* Maximum segment size option	*/
641	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
642};
643
644struct pf_state {
645	struct pf_state_host lan;
646	struct pf_state_host gwy;
647	struct pf_state_host ext;
648	struct pf_state_peer src;
649	struct pf_state_peer dst;
650	union pf_rule_ptr rule;
651	union pf_rule_ptr anchor;
652	union pf_rule_ptr nat_rule;
653	struct pf_addr	 rt_addr;
654	struct ifnet	*rt_ifp;
655	u_int32_t	 creation;
656	u_int32_t	 expire;
657	u_int32_t	 packets[2];
658	u_int32_t	 bytes[2];
659	sa_family_t	 af;
660	u_int8_t	 proto;
661	u_int8_t	 direction;
662	u_int8_t	 log;
663	u_int8_t	 allow_opts;
664	u_int8_t	 timeout;
665	u_int8_t	 pad[2];
666};
667
668struct pf_tree_node {
669	RB_ENTRY(pf_tree_node) entry;
670	struct pf_state	*state;
671	struct pf_addr	 addr[2];
672	u_int16_t	 port[2];
673	sa_family_t	 af;
674	u_int8_t	 proto;
675};
676
677TAILQ_HEAD(pf_rulequeue, pf_rule);
678
679struct pf_anchor;
680
681struct pf_ruleset {
682	TAILQ_ENTRY(pf_ruleset)	 entries;
683#define PF_RULESET_NAME_SIZE	 16
684	char			 name[PF_RULESET_NAME_SIZE];
685	struct {
686		struct pf_rulequeue	 queues[2];
687		struct {
688			struct pf_rulequeue	*ptr;
689			u_int32_t		 ticket;
690		}			 active, inactive;
691	}			 rules[PF_RULESET_MAX];
692	struct pf_anchor	*anchor;
693	u_int32_t		 tticket;
694	int			 tables;
695	int			 topen;
696};
697
698TAILQ_HEAD(pf_rulesetqueue, pf_ruleset);
699
700struct pf_anchor {
701	TAILQ_ENTRY(pf_anchor)	 entries;
702	char			 name[PF_ANCHOR_NAME_SIZE];
703	struct pf_rulesetqueue	 rulesets;
704	int			 tables;
705};
706
707TAILQ_HEAD(pf_anchorqueue, pf_anchor);
708
709#define PFR_TFLAG_PERSIST	0x00000001
710#define PFR_TFLAG_CONST		0x00000002
711#define PFR_TFLAG_ACTIVE	0x00000004
712#define PFR_TFLAG_INACTIVE	0x00000008
713#define PFR_TFLAG_REFERENCED	0x00000010
714#define PFR_TFLAG_REFDANCHOR	0x00000020
715#define PFR_TFLAG_USRMASK	0x00000003
716#define PFR_TFLAG_SETMASK	0x0000003C
717#define PFR_TFLAG_ALLMASK	0x0000003F
718
719struct pfr_table {
720	char			 pfrt_anchor[PF_ANCHOR_NAME_SIZE];
721	char			 pfrt_ruleset[PF_RULESET_NAME_SIZE];
722	char			 pfrt_name[PF_TABLE_NAME_SIZE];
723	u_int32_t		 pfrt_flags;
724	u_int8_t		 pfrt_fback;
725};
726
727enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
728	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
729	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
730
731struct pfr_addr {
732	union {
733		struct in_addr	 _pfra_ip4addr;
734		struct in6_addr	 _pfra_ip6addr;
735	}		 pfra_u;
736	u_int8_t	 pfra_af;
737	u_int8_t	 pfra_net;
738	u_int8_t	 pfra_not;
739	u_int8_t	 pfra_fback;
740};
741#define	pfra_ip4addr	pfra_u._pfra_ip4addr
742#define	pfra_ip6addr	pfra_u._pfra_ip6addr
743
744enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
745enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
746#define PFR_OP_XPASS	PFR_OP_ADDR_MAX
747
748struct pfr_astats {
749	struct pfr_addr	 pfras_a;
750	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
751	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
752	long		 pfras_tzero;
753};
754
755enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
756
757struct pfr_tstats {
758	struct pfr_table pfrts_t;
759	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
760	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
761	u_int64_t	 pfrts_match;
762	u_int64_t	 pfrts_nomatch;
763	long		 pfrts_tzero;
764	int		 pfrts_cnt;
765	int		 pfrts_refcnt[PFR_REFCNT_MAX];
766};
767#define	pfrts_name	pfrts_t.pfrt_name
768#define pfrts_flags	pfrts_t.pfrt_flags
769
770SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
771struct pfr_kentry {
772	struct radix_node	 pfrke_node[2];
773	union sockaddr_union	 pfrke_sa;
774	u_int64_t		 pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
775	u_int64_t		 pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
776	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
777	long			 pfrke_tzero;
778	u_int8_t		 pfrke_af;
779	u_int8_t		 pfrke_net;
780	u_int8_t		 pfrke_not;
781	u_int8_t		 pfrke_mark;
782};
783
784SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
785RB_HEAD(pfr_ktablehead, pfr_ktable);
786struct pfr_ktable {
787	struct pfr_tstats	 pfrkt_ts;
788	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
789	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
790	struct radix_node_head	*pfrkt_ip4;
791	struct radix_node_head	*pfrkt_ip6;
792	struct pfr_ktable	*pfrkt_shadow;
793	struct pfr_ktable	*pfrkt_root;
794	struct pf_ruleset	*pfrkt_rs;
795	int			 pfrkt_nflags;
796};
797#define pfrkt_t		pfrkt_ts.pfrts_t
798#define pfrkt_name	pfrkt_t.pfrt_name
799#define pfrkt_anchor    pfrkt_t.pfrt_anchor
800#define pfrkt_ruleset   pfrkt_t.pfrt_ruleset
801#define pfrkt_flags	pfrkt_t.pfrt_flags
802#define pfrkt_cnt	pfrkt_ts.pfrts_cnt
803#define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
804#define pfrkt_packets	pfrkt_ts.pfrts_packets
805#define pfrkt_bytes	pfrkt_ts.pfrts_bytes
806#define pfrkt_match	pfrkt_ts.pfrts_match
807#define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
808#define pfrkt_tzero	pfrkt_ts.pfrts_tzero
809
810struct pf_pdesc {
811	u_int64_t	 tot_len;	/* Make Mickey money */
812	union {
813		struct tcphdr		*tcp;
814		struct udphdr		*udp;
815		struct icmp		*icmp;
816#ifdef INET6
817		struct icmp6_hdr	*icmp6;
818#endif /* INET6 */
819		void			*any;
820	} hdr;
821	struct pf_addr	*src;
822	struct pf_addr	*dst;
823	u_int16_t	*ip_sum;
824	u_int32_t	 p_len;		/* total length of payload */
825	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
826					 * state code. Easier than tags */
827#define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
828	sa_family_t	 af;
829	u_int8_t	 proto;
830	u_int8_t	 tos;
831};
832
833/* flags for RDR options */
834#define PF_DPORT_RANGE	0x01		/* Dest port uses range */
835#define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
836
837/* Reasons code for passing/dropping a packet */
838#define PFRES_MATCH	0		/* Explicit match of a rule */
839#define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
840#define PFRES_FRAG	2		/* Dropping following fragment */
841#define PFRES_SHORT	3		/* Dropping short packet */
842#define PFRES_NORM	4		/* Dropping by normalizer */
843#define PFRES_MEMORY	5		/* Dropped due to lacking mem */
844#define PFRES_MAX	6		/* total+1 */
845
846#define PFRES_NAMES { \
847	"match", \
848	"bad-offset", \
849	"fragment", \
850	"short", \
851	"normalize", \
852	"memory", \
853	NULL \
854}
855
856/* UDP state enumeration */
857#define PFUDPS_NO_TRAFFIC	0
858#define PFUDPS_SINGLE		1
859#define PFUDPS_MULTIPLE		2
860
861#define PFUDPS_NSTATES		3	/* number of state levels */
862
863#define PFUDPS_NAMES { \
864	"NO_TRAFFIC", \
865	"SINGLE", \
866	"MULTIPLE", \
867	NULL \
868}
869
870/* Other protocol state enumeration */
871#define PFOTHERS_NO_TRAFFIC	0
872#define PFOTHERS_SINGLE		1
873#define PFOTHERS_MULTIPLE	2
874
875#define PFOTHERS_NSTATES	3	/* number of state levels */
876
877#define PFOTHERS_NAMES { \
878	"NO_TRAFFIC", \
879	"SINGLE", \
880	"MULTIPLE", \
881	NULL \
882}
883
884#define FCNT_STATE_SEARCH	0
885#define FCNT_STATE_INSERT	1
886#define FCNT_STATE_REMOVALS	2
887#define FCNT_MAX		3
888
889
890#define ACTION_SET(a, x) \
891	do { \
892		if ((a) != NULL) \
893			*(a) = (x); \
894	} while (0)
895
896#define REASON_SET(a, x) \
897	do { \
898		if ((a) != NULL) \
899			*(a) = (x); \
900		if (x < PFRES_MAX) \
901			pf_status.counters[x]++; \
902	} while (0)
903
904struct pf_status {
905	u_int64_t	counters[PFRES_MAX];
906	u_int64_t	fcounters[FCNT_MAX];
907	u_int64_t	pcounters[2][2][3];
908	u_int64_t	bcounters[2][2];
909	u_int32_t	running;
910	u_int32_t	states;
911	u_int32_t	since;
912	u_int32_t	debug;
913	char		ifname[IFNAMSIZ];
914};
915
916struct cbq_opts {
917	u_int		minburst;
918	u_int		maxburst;
919	u_int		pktsize;
920	u_int		maxpktsize;
921	u_int		ns_per_byte;
922	u_int		maxidle;
923	int		minidle;
924	u_int		offtime;
925	int		flags;
926};
927
928struct priq_opts {
929	int		flags;
930};
931
932struct hfsc_opts {
933	/* real-time service curve */
934	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
935	u_int		rtsc_d;		/* the x-projection of m1 in msec */
936	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
937	/* link-sharing service curve */
938	u_int		lssc_m1;
939	u_int		lssc_d;
940	u_int		lssc_m2;
941	/* upper-limit service curve */
942	u_int		ulsc_m1;
943	u_int		ulsc_d;
944	u_int		ulsc_m2;
945	int		flags;
946};
947
948struct pf_altq {
949	char			 ifname[IFNAMSIZ];
950
951	void			*altq_disc;	/* discipline-specific state */
952	TAILQ_ENTRY(pf_altq)	 entries;
953
954	/* scheduler spec */
955	u_int8_t		 scheduler;	/* scheduler type */
956	u_int16_t		 tbrsize;	/* tokenbucket regulator size */
957	u_int32_t		 ifbandwidth;	/* interface bandwidth */
958
959	/* queue spec */
960	char			 qname[PF_QNAME_SIZE];	/* queue name */
961	char			 parent[PF_QNAME_SIZE];	/* parent name */
962	u_int32_t		 parent_qid;	/* parent queue id */
963	u_int32_t		 bandwidth;	/* queue bandwidth */
964	u_int8_t		 priority;	/* priority */
965	u_int16_t		 qlimit;	/* queue size limit */
966	u_int16_t		 flags;		/* misc flags */
967	union {
968		struct cbq_opts		 cbq_opts;
969		struct priq_opts	 priq_opts;
970		struct hfsc_opts	 hfsc_opts;
971	} pq_u;
972
973	u_int32_t		 qid;		/* return value */
974};
975
976struct pf_tag {
977	u_int16_t	tag;		/* tag id */
978};
979
980struct pf_tagname {
981	TAILQ_ENTRY(pf_tagname)	entries;
982	char			name[PF_TAG_NAME_SIZE];
983	u_int16_t		tag;
984	int			ref;
985};
986
987#define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
988#define PFFRAG_FRAG_HIWAT	1000	/* Number of fragmented packets */
989#define PFFRAG_FRCENT_HIWAT	50000	/* Number of fragment cache entries */
990#define PFFRAG_FRCACHE_HIWAT	10000	/* Number of fragment descriptors */
991
992/*
993 * ioctl parameter structures
994 */
995
996struct pfioc_pooladdr {
997	u_int32_t		 action;
998	u_int32_t		 ticket;
999	u_int32_t		 nr;
1000	u_int32_t		 r_num;
1001	u_int8_t		 r_action;
1002	u_int8_t		 r_last;
1003	u_int8_t		 af;
1004	char			 anchor[PF_ANCHOR_NAME_SIZE];
1005	char			 ruleset[PF_RULESET_NAME_SIZE];
1006	struct pf_pooladdr	 addr;
1007};
1008
1009struct pfioc_rule {
1010	u_int32_t	 action;
1011	u_int32_t	 ticket;
1012	u_int32_t	 pool_ticket;
1013	u_int32_t	 nr;
1014	char		 anchor[PF_ANCHOR_NAME_SIZE];
1015	char		 ruleset[PF_RULESET_NAME_SIZE];
1016	struct pf_rule	 rule;
1017};
1018
1019struct pfioc_natlook {
1020	struct pf_addr	 saddr;
1021	struct pf_addr	 daddr;
1022	struct pf_addr	 rsaddr;
1023	struct pf_addr	 rdaddr;
1024	u_int16_t	 sport;
1025	u_int16_t	 dport;
1026	u_int16_t	 rsport;
1027	u_int16_t	 rdport;
1028	sa_family_t	 af;
1029	u_int8_t	 proto;
1030	u_int8_t	 direction;
1031};
1032
1033struct pfioc_state {
1034	u_int32_t	 nr;
1035	struct pf_state	 state;
1036};
1037
1038struct pfioc_state_kill {
1039	/* XXX returns the number of states killed in psk_af */
1040	sa_family_t		psk_af;
1041	int			psk_proto;
1042	struct pf_rule_addr	psk_src;
1043	struct pf_rule_addr	psk_dst;
1044};
1045
1046struct pfioc_states {
1047	int	ps_len;
1048	union {
1049		caddr_t		 psu_buf;
1050		struct pf_state	*psu_states;
1051	} ps_u;
1052#define ps_buf		ps_u.psu_buf
1053#define ps_states	ps_u.psu_states
1054};
1055
1056struct pfioc_if {
1057	char		 ifname[IFNAMSIZ];
1058};
1059
1060struct pfioc_tm {
1061	int		 timeout;
1062	int		 seconds;
1063};
1064
1065struct pfioc_limit {
1066	int		 index;
1067	unsigned	 limit;
1068};
1069
1070struct pfioc_altq {
1071	u_int32_t	 action;
1072	u_int32_t	 ticket;
1073	u_int32_t	 nr;
1074	struct pf_altq	 altq;
1075};
1076
1077struct pfioc_qstats {
1078	u_int32_t	 ticket;
1079	u_int32_t	 nr;
1080	void		*buf;
1081	int		 nbytes;
1082	u_int8_t	 scheduler;
1083};
1084
1085struct pfioc_anchor {
1086	u_int32_t	 nr;
1087	char		 name[PF_ANCHOR_NAME_SIZE];
1088};
1089
1090struct pfioc_ruleset {
1091	u_int32_t	 nr;
1092	char		 anchor[PF_ANCHOR_NAME_SIZE];
1093	char		 name[PF_RULESET_NAME_SIZE];
1094};
1095
1096#define PFR_FLAG_ATOMIC		0x00000001
1097#define PFR_FLAG_DUMMY		0x00000002
1098#define PFR_FLAG_FEEDBACK	0x00000004
1099#define PFR_FLAG_CLSTATS	0x00000008
1100#define PFR_FLAG_ADDRSTOO	0x00000010
1101#define PFR_FLAG_REPLACE	0x00000020
1102#define PFR_FLAG_ALLRSETS	0x00000040
1103#define PFR_FLAG_ALLMASK	0x0000007F
1104
1105struct pfioc_table {
1106	struct pfr_table	 pfrio_table;
1107	void			*pfrio_buffer;
1108	int			 pfrio_esize;
1109	int			 pfrio_size;
1110	int			 pfrio_size2;
1111	int			 pfrio_nadd;
1112	int			 pfrio_ndel;
1113	int			 pfrio_nchange;
1114	int			 pfrio_flags;
1115	u_int32_t		 pfrio_ticket;
1116};
1117#define	pfrio_exists	pfrio_nadd
1118#define	pfrio_nzero	pfrio_nadd
1119#define	pfrio_nmatch	pfrio_nadd
1120#define pfrio_naddr	pfrio_size2
1121#define pfrio_setflag	pfrio_size2
1122#define pfrio_clrflag	pfrio_nadd
1123
1124
1125/*
1126 * ioctl operations
1127 */
1128
1129#define DIOCSTART	_IO  ('D',  1)
1130#define DIOCSTOP	_IO  ('D',  2)
1131#define DIOCBEGINRULES	_IOWR('D',  3, struct pfioc_rule)
1132#define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1133#define DIOCCOMMITRULES	_IOWR('D',  5, struct pfioc_rule)
1134#define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1135#define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1136/* XXX cut 8 - 17 */
1137#define DIOCCLRSTATES	_IO  ('D', 18)
1138#define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1139#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1140#define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1141#define DIOCCLRSTATUS	_IO  ('D', 22)
1142#define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1143#define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1144#define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1145#define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1146/* XXX cut 26 - 28 */
1147#define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1148#define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1149#define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1150#define DIOCCLRRULECTRS	_IO  ('D', 38)
1151#define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1152#define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1153#define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1154#define DIOCSTARTALTQ	_IO  ('D', 42)
1155#define DIOCSTOPALTQ	_IO  ('D', 43)
1156#define DIOCBEGINALTQS	_IOWR('D', 44, u_int32_t)
1157#define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1158#define DIOCCOMMITALTQS	_IOWR('D', 46, u_int32_t)
1159#define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1160#define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1161#define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1162#define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1163#define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1164#define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1165#define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1166#define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1167#define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1168#define	DIOCGETANCHORS	_IOWR('D', 56, struct pfioc_anchor)
1169#define	DIOCGETANCHOR	_IOWR('D', 57, struct pfioc_anchor)
1170#define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1171#define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1172#define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1173#define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1174#define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1175#define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1176#define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1177#define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1178#define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1179#define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1180#define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1181#define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1182#define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1183#define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1184#define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1185#define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1186#define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1187#define DIOCRINABEGIN	_IOWR('D', 75, struct pfioc_table)
1188#define DIOCRINACOMMIT	_IOWR('D', 76, struct pfioc_table)
1189#define DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1190#define DIOCOSFPFLUSH	_IO('D', 78)
1191#define DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1192#define DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1193#ifdef __FreeBSD__
1194struct pf_ifspeed {
1195	char			ifname[IFNAMSIZ];
1196	u_int32_t		baudrate;
1197};
1198#define DIOCGIFSPEED	_IOWR('D', 81, struct pf_ifspeed)
1199#endif
1200
1201#ifdef _KERNEL
1202RB_HEAD(pf_state_tree, pf_tree_node);
1203RB_PROTOTYPE(pf_state_tree, pf_tree_node, entry, pf_state_compare);
1204extern struct pf_state_tree tree_lan_ext, tree_ext_gwy;
1205
1206extern struct pf_anchorqueue		 pf_anchors;
1207extern struct pf_ruleset		 pf_main_ruleset;
1208TAILQ_HEAD(pf_poolqueue, pf_pool);
1209extern struct pf_poolqueue		 pf_pools[2];
1210TAILQ_HEAD(pf_altqqueue, pf_altq);
1211extern struct pf_altqqueue		 pf_altqs[2];
1212extern struct pf_palist			 pf_pabuf;
1213
1214
1215extern u_int32_t		 ticket_altqs_active;
1216extern u_int32_t		 ticket_altqs_inactive;
1217extern u_int32_t		 ticket_pabuf;
1218extern struct pf_altqqueue	*pf_altqs_active;
1219extern struct pf_altqqueue	*pf_altqs_inactive;
1220extern struct pf_poolqueue	*pf_pools_active;
1221extern struct pf_poolqueue	*pf_pools_inactive;
1222extern int			 pf_tbladdr_setup(struct pf_ruleset *,
1223				    struct pf_addr_wrap *);
1224extern void			 pf_tbladdr_remove(struct pf_addr_wrap *);
1225extern void			 pf_tbladdr_copyout(struct pf_addr_wrap *);
1226extern int			 pf_dynaddr_setup(struct pf_addr_wrap *,
1227				    sa_family_t);
1228extern void			 pf_dynaddr_copyout(struct pf_addr_wrap *);
1229extern void			 pf_dynaddr_remove(struct pf_addr_wrap *);
1230extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1231extern void			 pf_rule_set_qid(struct pf_rulequeue *);
1232extern u_int32_t		 pf_qname_to_qid(char *);
1233extern void			 pf_update_anchor_rules(void);
1234#ifdef __FreeBSD__
1235extern uma_zone_t		 pf_tree_pl, pf_rule_pl, pf_addr_pl;
1236extern uma_zone_t		 pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1237extern uma_zone_t		 pfr_ktable_pl, pfr_kentry_pl;
1238extern uma_zone_t		 pf_cache_pl, pf_cent_pl;
1239extern uma_zone_t		 pf_state_scrub_pl;
1240#else
1241extern struct pool		 pf_tree_pl, pf_rule_pl, pf_addr_pl;
1242extern struct pool		 pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1243extern struct pool		 pf_state_scrub_pl;
1244#endif
1245extern void			 pf_purge_timeout(void *);
1246extern void			 pf_purge_expired_states(void);
1247extern int			 pf_insert_state(struct pf_state *);
1248extern struct pf_state		*pf_find_state(struct pf_state_tree *,
1249				    struct pf_tree_node *);
1250extern struct pf_anchor		*pf_find_anchor(const char *);
1251extern struct pf_ruleset	*pf_find_ruleset(char *, char *);
1252extern struct pf_ruleset	*pf_find_or_create_ruleset(char *, char *);
1253extern void			 pf_remove_if_empty_ruleset(
1254				    struct pf_ruleset *);
1255
1256extern struct ifnet		*status_ifp;
1257extern struct pf_rule		 pf_default_rule;
1258extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1259				    u_int8_t);
1260void				 pf_rm_rule(struct pf_rulequeue *,
1261				    struct pf_rule *);
1262
1263#ifdef INET
1264int	pf_test(int, struct ifnet *, struct mbuf **);
1265#endif /* INET */
1266
1267#ifdef INET6
1268int	pf_test6(int, struct ifnet *, struct mbuf **);
1269void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1270	    struct pf_addr *, struct pf_addr *, u_int8_t);
1271void	pf_addr_inc(struct pf_addr *, sa_family_t);
1272#endif /* INET6 */
1273
1274void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1275	    sa_family_t);
1276void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1277int	pflog_packet(struct ifnet *, struct mbuf *, sa_family_t, u_int8_t,
1278	    u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *);
1279int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1280	    struct pf_addr *, sa_family_t);
1281int	pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1282int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1283int	pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1284int	pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1285
1286void	pf_normalize_init(void);
1287int	pf_normalize_ip(struct mbuf **, int, struct ifnet *, u_short *);
1288int	pf_normalize_ip6(struct mbuf **, int, struct ifnet *, u_short *);
1289int	pf_normalize_tcp(int, struct ifnet *, struct mbuf *, int, int, void *,
1290	    struct pf_pdesc *);
1291void	pf_normalize_tcp_cleanup(struct pf_state *);
1292int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1293	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1294int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1295	    u_short *, struct tcphdr *, struct pf_state_peer *,
1296	    struct pf_state_peer *, int *);
1297u_int32_t
1298	pf_state_expires(const struct pf_state *);
1299void	pf_purge_expired_fragments(void);
1300int	pf_routable(struct pf_addr *addr, sa_family_t af);
1301void	pfr_initialize(void);
1302int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1303void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1304	    u_int64_t, int, int, int);
1305int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1306	    struct pf_addr **, struct pf_addr **, sa_family_t);
1307struct pfr_ktable *
1308	pfr_attach_table(struct pf_ruleset *, char *);
1309void	pfr_detach_table(struct pfr_ktable *);
1310int	pfr_clr_tables(struct pfr_table *, int *, int);
1311int	pfr_add_tables(struct pfr_table *, int, int *, int);
1312int	pfr_del_tables(struct pfr_table *, int, int *, int);
1313int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1314int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1315int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1316int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1317int	pfr_clr_addrs(struct pfr_table *, int *, int);
1318int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1319	    int);
1320int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1321	    int);
1322int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1323	    int *, int *, int *, int);
1324int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1325int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1326int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1327	    int);
1328int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1329	    int);
1330int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1331int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1332int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1333	    int *, u_int32_t, int);
1334
1335u_int16_t	pf_tagname2tag(char *);
1336void		pf_tag2tagname(u_int16_t, char *);
1337void		pf_tag_unref(u_int16_t);
1338int		pf_tag_packet(struct mbuf *, struct pf_tag *, int);
1339
1340extern struct pf_status	pf_status;
1341
1342#ifdef __FreeBSD__
1343extern uma_zone_t	pf_frent_pl, pf_frag_pl;
1344#else
1345extern struct pool	pf_frent_pl, pf_frag_pl;
1346#endif
1347
1348struct pf_pool_limit {
1349	void		*pp;
1350	unsigned	 limit;
1351};
1352extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
1353
1354#ifdef __FreeBSD__
1355struct pf_frent {
1356	LIST_ENTRY(pf_frent) fr_next;
1357	struct ip *fr_ip;
1358	struct mbuf *fr_m;
1359};
1360
1361struct pf_frcache {
1362	LIST_ENTRY(pf_frcache) fr_next;
1363	uint16_t        fr_off;
1364	uint16_t        fr_end;
1365};
1366
1367struct pf_fragment {
1368	RB_ENTRY(pf_fragment) fr_entry;
1369	TAILQ_ENTRY(pf_fragment) frag_next;
1370	struct in_addr  fr_src;
1371	struct in_addr  fr_dst;
1372	u_int8_t        fr_p;           /* protocol of this fragment */
1373	u_int8_t        fr_flags;       /* status flags */
1374	u_int16_t       fr_id;          /* fragment id for reassemble */
1375	u_int16_t       fr_max;         /* fragment data max */
1376	u_int32_t       fr_timeout;
1377#define fr_queue        fr_u.fru_queue
1378#define fr_cache        fr_u.fru_cache
1379	union {
1380		LIST_HEAD(pf_fragq, pf_frent) fru_queue;        /* buffering */
1381		LIST_HEAD(pf_cacheq, pf_frcache) fru_cache;     /* non-buf */
1382	} fr_u;
1383};
1384#endif /* (__FreeBSD__) */
1385
1386#endif /* _KERNEL */
1387
1388/* The fingerprint functions can be linked into userland programs (tcpdump) */
1389int	pf_osfp_add(struct pf_osfp_ioctl *);
1390#ifdef _KERNEL
1391struct pf_osfp_enlist *
1392	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1393	    const struct tcphdr *);
1394#endif /* _KERNEL */
1395struct pf_osfp_enlist *
1396	pf_osfp_fingerprint_hdr(const struct ip *, const struct tcphdr *);
1397void	pf_osfp_flush(void);
1398int	pf_osfp_get(struct pf_osfp_ioctl *);
1399#ifdef __FreeBSD__
1400int	pf_osfp_initialize(void);
1401void	pf_osfp_cleanup(void);
1402#else
1403void	pf_osfp_initialize(void);
1404#endif
1405int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1406struct pf_os_fingerprint *
1407	pf_osfp_validate(void);
1408
1409
1410#endif /* _NET_PFVAR_H_ */
1411