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