1/*
2 * Copyright (c) 2001 Daniel Hartmeier
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 *    - Redistributions of source code must retain the above copyright
10 *      notice, this list of conditions and the following disclaimer.
11 *    - Redistributions in binary form must reproduce the above
12 *      copyright notice, this list of conditions and the following
13 *      disclaimer in the documentation and/or other materials provided
14 *      with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
19 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
20 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
24 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 *
29 *	$OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
30 *	$FreeBSD: releng/11.0/sys/net/pfvar.h 302156 2016-06-23 21:34:38Z bz $
31 */
32
33#ifndef _NET_PFVAR_H_
34#define _NET_PFVAR_H_
35
36#include <sys/param.h>
37#include <sys/queue.h>
38#include <sys/counter.h>
39#include <sys/malloc.h>
40#include <sys/refcount.h>
41#include <sys/tree.h>
42#include <vm/uma.h>
43
44#include <net/radix.h>
45#include <netinet/in.h>
46
47#include <netpfil/pf/pf.h>
48#include <netpfil/pf/pf_altq.h>
49#include <netpfil/pf/pf_mtag.h>
50
51struct pf_addr {
52	union {
53		struct in_addr		v4;
54		struct in6_addr		v6;
55		u_int8_t		addr8[16];
56		u_int16_t		addr16[8];
57		u_int32_t		addr32[4];
58	} pfa;		    /* 128-bit address */
59#define v4	pfa.v4
60#define v6	pfa.v6
61#define addr8	pfa.addr8
62#define addr16	pfa.addr16
63#define addr32	pfa.addr32
64};
65
66#define PFI_AFLAG_NETWORK	0x01
67#define PFI_AFLAG_BROADCAST	0x02
68#define PFI_AFLAG_PEER		0x04
69#define PFI_AFLAG_MODEMASK	0x07
70#define PFI_AFLAG_NOALIAS	0x08
71
72struct pf_addr_wrap {
73	union {
74		struct {
75			struct pf_addr		 addr;
76			struct pf_addr		 mask;
77		}			 a;
78		char			 ifname[IFNAMSIZ];
79		char			 tblname[PF_TABLE_NAME_SIZE];
80	}			 v;
81	union {
82		struct pfi_dynaddr	*dyn;
83		struct pfr_ktable	*tbl;
84		int			 dyncnt;
85		int			 tblcnt;
86	}			 p;
87	u_int8_t		 type;		/* PF_ADDR_* */
88	u_int8_t		 iflags;	/* PFI_AFLAG_* */
89};
90
91#ifdef _KERNEL
92
93struct pfi_dynaddr {
94	TAILQ_ENTRY(pfi_dynaddr)	 entry;
95	struct pf_addr			 pfid_addr4;
96	struct pf_addr			 pfid_mask4;
97	struct pf_addr			 pfid_addr6;
98	struct pf_addr			 pfid_mask6;
99	struct pfr_ktable		*pfid_kt;
100	struct pfi_kif			*pfid_kif;
101	int				 pfid_net;	/* mask or 128 */
102	int				 pfid_acnt4;	/* address count IPv4 */
103	int				 pfid_acnt6;	/* address count IPv6 */
104	sa_family_t			 pfid_af;	/* rule af */
105	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
106};
107
108/*
109 * Address manipulation macros
110 */
111#define	HTONL(x)	(x) = htonl((__uint32_t)(x))
112#define	HTONS(x)	(x) = htons((__uint16_t)(x))
113#define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
114#define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
115
116#define	PF_NAME		"pf"
117
118#define	PF_HASHROW_ASSERT(h)	mtx_assert(&(h)->lock, MA_OWNED)
119#define	PF_HASHROW_LOCK(h)	mtx_lock(&(h)->lock)
120#define	PF_HASHROW_UNLOCK(h)	mtx_unlock(&(h)->lock)
121
122#define	PF_STATE_LOCK(s)						\
123	do {								\
124		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
125		PF_HASHROW_LOCK(_ih);					\
126	} while (0)
127
128#define	PF_STATE_UNLOCK(s)						\
129	do {								\
130		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))];	\
131		PF_HASHROW_UNLOCK(_ih);					\
132	} while (0)
133
134#ifdef INVARIANTS
135#define	PF_STATE_LOCK_ASSERT(s)						\
136	do {								\
137		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
138		PF_HASHROW_ASSERT(_ih);					\
139	} while (0)
140#else /* !INVARIANTS */
141#define	PF_STATE_LOCK_ASSERT(s)		do {} while (0)
142#endif /* INVARIANTS */
143
144extern struct mtx pf_unlnkdrules_mtx;
145#define	PF_UNLNKDRULES_LOCK()	mtx_lock(&pf_unlnkdrules_mtx)
146#define	PF_UNLNKDRULES_UNLOCK()	mtx_unlock(&pf_unlnkdrules_mtx)
147
148extern struct rwlock pf_rules_lock;
149#define	PF_RULES_RLOCK()	rw_rlock(&pf_rules_lock)
150#define	PF_RULES_RUNLOCK()	rw_runlock(&pf_rules_lock)
151#define	PF_RULES_WLOCK()	rw_wlock(&pf_rules_lock)
152#define	PF_RULES_WUNLOCK()	rw_wunlock(&pf_rules_lock)
153#define	PF_RULES_ASSERT()	rw_assert(&pf_rules_lock, RA_LOCKED)
154#define	PF_RULES_RASSERT()	rw_assert(&pf_rules_lock, RA_RLOCKED)
155#define	PF_RULES_WASSERT()	rw_assert(&pf_rules_lock, RA_WLOCKED)
156
157#define	PF_MODVER	1
158#define	PFLOG_MODVER	1
159#define	PFSYNC_MODVER	1
160
161#define	PFLOG_MINVER	1
162#define	PFLOG_PREFVER	PFLOG_MODVER
163#define	PFLOG_MAXVER	1
164#define	PFSYNC_MINVER	1
165#define	PFSYNC_PREFVER	PFSYNC_MODVER
166#define	PFSYNC_MAXVER	1
167
168#ifdef INET
169#ifndef INET6
170#define	PF_INET_ONLY
171#endif /* ! INET6 */
172#endif /* INET */
173
174#ifdef INET6
175#ifndef INET
176#define	PF_INET6_ONLY
177#endif /* ! INET */
178#endif /* INET6 */
179
180#ifdef INET
181#ifdef INET6
182#define	PF_INET_INET6
183#endif /* INET6 */
184#endif /* INET */
185
186#else
187
188#define	PF_INET_INET6
189
190#endif /* _KERNEL */
191
192/* Both IPv4 and IPv6 */
193#ifdef PF_INET_INET6
194
195#define PF_AEQ(a, b, c) \
196	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
197	(c == AF_INET6 && (a)->addr32[3] == (b)->addr32[3] && \
198	(a)->addr32[2] == (b)->addr32[2] && \
199	(a)->addr32[1] == (b)->addr32[1] && \
200	(a)->addr32[0] == (b)->addr32[0])) \
201
202#define PF_ANEQ(a, b, c) \
203	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
204	(c == AF_INET6 && ((a)->addr32[0] != (b)->addr32[0] || \
205	(a)->addr32[1] != (b)->addr32[1] || \
206	(a)->addr32[2] != (b)->addr32[2] || \
207	(a)->addr32[3] != (b)->addr32[3]))) \
208
209#define PF_AZERO(a, c) \
210	((c == AF_INET && !(a)->addr32[0]) || \
211	(c == AF_INET6 && !(a)->addr32[0] && !(a)->addr32[1] && \
212	!(a)->addr32[2] && !(a)->addr32[3] )) \
213
214#define PF_MATCHA(n, a, m, b, f) \
215	pf_match_addr(n, a, m, b, f)
216
217#define PF_ACPY(a, b, f) \
218	pf_addrcpy(a, b, f)
219
220#define PF_AINC(a, f) \
221	pf_addr_inc(a, f)
222
223#define PF_POOLMASK(a, b, c, d, f) \
224	pf_poolmask(a, b, c, d, f)
225
226#else
227
228/* Just IPv6 */
229
230#ifdef PF_INET6_ONLY
231
232#define PF_AEQ(a, b, c) \
233	((a)->addr32[3] == (b)->addr32[3] && \
234	(a)->addr32[2] == (b)->addr32[2] && \
235	(a)->addr32[1] == (b)->addr32[1] && \
236	(a)->addr32[0] == (b)->addr32[0]) \
237
238#define PF_ANEQ(a, b, c) \
239	((a)->addr32[3] != (b)->addr32[3] || \
240	(a)->addr32[2] != (b)->addr32[2] || \
241	(a)->addr32[1] != (b)->addr32[1] || \
242	(a)->addr32[0] != (b)->addr32[0]) \
243
244#define PF_AZERO(a, c) \
245	(!(a)->addr32[0] && \
246	!(a)->addr32[1] && \
247	!(a)->addr32[2] && \
248	!(a)->addr32[3] ) \
249
250#define PF_MATCHA(n, a, m, b, f) \
251	pf_match_addr(n, a, m, b, f)
252
253#define PF_ACPY(a, b, f) \
254	pf_addrcpy(a, b, f)
255
256#define PF_AINC(a, f) \
257	pf_addr_inc(a, f)
258
259#define PF_POOLMASK(a, b, c, d, f) \
260	pf_poolmask(a, b, c, d, f)
261
262#else
263
264/* Just IPv4 */
265#ifdef PF_INET_ONLY
266
267#define PF_AEQ(a, b, c) \
268	((a)->addr32[0] == (b)->addr32[0])
269
270#define PF_ANEQ(a, b, c) \
271	((a)->addr32[0] != (b)->addr32[0])
272
273#define PF_AZERO(a, c) \
274	(!(a)->addr32[0])
275
276#define PF_MATCHA(n, a, m, b, f) \
277	pf_match_addr(n, a, m, b, f)
278
279#define PF_ACPY(a, b, f) \
280	(a)->v4.s_addr = (b)->v4.s_addr
281
282#define PF_AINC(a, f) \
283	do { \
284		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
285	} while (0)
286
287#define PF_POOLMASK(a, b, c, d, f) \
288	do { \
289		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
290		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
291	} while (0)
292
293#endif /* PF_INET_ONLY */
294#endif /* PF_INET6_ONLY */
295#endif /* PF_INET_INET6 */
296
297/*
298 * XXX callers not FIB-aware in our version of pf yet.
299 * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
300 */
301#define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
302	(								\
303		(((aw)->type == PF_ADDR_NOROUTE &&			\
304		    pf_routable((x), (af), NULL, (rtid))) ||		\
305		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
306		    pf_routable((x), (af), (ifp), (rtid))) ||		\
307		((aw)->type == PF_ADDR_TABLE &&				\
308		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
309		((aw)->type == PF_ADDR_DYNIFTL &&			\
310		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
311		((aw)->type == PF_ADDR_RANGE &&				\
312		    !pf_match_addr_range(&(aw)->v.a.addr,		\
313		    &(aw)->v.a.mask, (x), (af))) ||			\
314		((aw)->type == PF_ADDR_ADDRMASK &&			\
315		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
316		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
317		    &(aw)->v.a.mask, (x), (af))))) !=			\
318		(neg)							\
319	)
320
321
322struct pf_rule_uid {
323	uid_t		 uid[2];
324	u_int8_t	 op;
325};
326
327struct pf_rule_gid {
328	uid_t		 gid[2];
329	u_int8_t	 op;
330};
331
332struct pf_rule_addr {
333	struct pf_addr_wrap	 addr;
334	u_int16_t		 port[2];
335	u_int8_t		 neg;
336	u_int8_t		 port_op;
337};
338
339struct pf_pooladdr {
340	struct pf_addr_wrap		 addr;
341	TAILQ_ENTRY(pf_pooladdr)	 entries;
342	char				 ifname[IFNAMSIZ];
343	struct pfi_kif			*kif;
344};
345
346TAILQ_HEAD(pf_palist, pf_pooladdr);
347
348struct pf_poolhashkey {
349	union {
350		u_int8_t		key8[16];
351		u_int16_t		key16[8];
352		u_int32_t		key32[4];
353	} pfk;		    /* 128-bit hash key */
354#define key8	pfk.key8
355#define key16	pfk.key16
356#define key32	pfk.key32
357};
358
359struct pf_pool {
360	struct pf_palist	 list;
361	struct pf_pooladdr	*cur;
362	struct pf_poolhashkey	 key;
363	struct pf_addr		 counter;
364	int			 tblidx;
365	u_int16_t		 proxy_port[2];
366	u_int8_t		 opts;
367};
368
369
370/* A packed Operating System description for fingerprinting */
371typedef u_int32_t pf_osfp_t;
372#define PF_OSFP_ANY	((pf_osfp_t)0)
373#define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
374#define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
375
376struct pf_osfp_entry {
377	SLIST_ENTRY(pf_osfp_entry) fp_entry;
378	pf_osfp_t		fp_os;
379	int			fp_enflags;
380#define PF_OSFP_EXPANDED	0x001		/* expanded entry */
381#define PF_OSFP_GENERIC		0x002		/* generic signature */
382#define PF_OSFP_NODETAIL	0x004		/* no p0f details */
383#define PF_OSFP_LEN	32
384	char			fp_class_nm[PF_OSFP_LEN];
385	char			fp_version_nm[PF_OSFP_LEN];
386	char			fp_subtype_nm[PF_OSFP_LEN];
387};
388#define PF_OSFP_ENTRY_EQ(a, b) \
389    ((a)->fp_os == (b)->fp_os && \
390    memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
391    memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
392    memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
393
394/* handle pf_osfp_t packing */
395#define _FP_RESERVED_BIT	1  /* For the special negative #defines */
396#define _FP_UNUSED_BITS		1
397#define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
398#define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
399#define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
400#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
401	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
402	    ((1 << _FP_CLASS_BITS) - 1); \
403	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
404	    ((1 << _FP_VERSION_BITS) - 1);\
405	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
406} while(0)
407#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
408	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
409	    + _FP_SUBTYPE_BITS); \
410	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
411	    _FP_SUBTYPE_BITS; \
412	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
413} while(0)
414
415/* the fingerprint of an OSes TCP SYN packet */
416typedef u_int64_t	pf_tcpopts_t;
417struct pf_os_fingerprint {
418	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
419	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
420	u_int16_t		fp_wsize;	/* TCP window size */
421	u_int16_t		fp_psize;	/* ip->ip_len */
422	u_int16_t		fp_mss;		/* TCP MSS */
423	u_int16_t		fp_flags;
424#define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
425#define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
426#define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
427#define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
428#define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
429#define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
430#define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
431#define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
432#define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
433#define PF_OSFP_MSS		0x0200		/* TCP MSS */
434#define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
435#define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
436#define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
437#define PF_OSFP_TS0		0x2000		/* Zero timestamp */
438#define PF_OSFP_INET6		0x4000		/* IPv6 */
439	u_int8_t		fp_optcnt;	/* TCP option count */
440	u_int8_t		fp_wscale;	/* TCP window scaling */
441	u_int8_t		fp_ttl;		/* IPv4 TTL */
442#define PF_OSFP_MAXTTL_OFFSET	40
443/* TCP options packing */
444#define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
445#define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
446#define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
447#define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
448#define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
449#define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
450#define PF_OSFP_MAX_OPTS \
451    (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
452    / PF_OSFP_TCPOPT_BITS
453
454	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
455};
456
457struct pf_osfp_ioctl {
458	struct pf_osfp_entry	fp_os;
459	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
460	u_int16_t		fp_wsize;	/* TCP window size */
461	u_int16_t		fp_psize;	/* ip->ip_len */
462	u_int16_t		fp_mss;		/* TCP MSS */
463	u_int16_t		fp_flags;
464	u_int8_t		fp_optcnt;	/* TCP option count */
465	u_int8_t		fp_wscale;	/* TCP window scaling */
466	u_int8_t		fp_ttl;		/* IPv4 TTL */
467
468	int			fp_getnum;	/* DIOCOSFPGET number */
469};
470
471
472union pf_rule_ptr {
473	struct pf_rule		*ptr;
474	u_int32_t		 nr;
475};
476
477#define	PF_ANCHOR_NAME_SIZE	 64
478
479struct pf_rule {
480	struct pf_rule_addr	 src;
481	struct pf_rule_addr	 dst;
482#define PF_SKIP_IFP		0
483#define PF_SKIP_DIR		1
484#define PF_SKIP_AF		2
485#define PF_SKIP_PROTO		3
486#define PF_SKIP_SRC_ADDR	4
487#define PF_SKIP_SRC_PORT	5
488#define PF_SKIP_DST_ADDR	6
489#define PF_SKIP_DST_PORT	7
490#define PF_SKIP_COUNT		8
491	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
492#define PF_RULE_LABEL_SIZE	 64
493	char			 label[PF_RULE_LABEL_SIZE];
494	char			 ifname[IFNAMSIZ];
495	char			 qname[PF_QNAME_SIZE];
496	char			 pqname[PF_QNAME_SIZE];
497#define	PF_TAG_NAME_SIZE	 64
498	char			 tagname[PF_TAG_NAME_SIZE];
499	char			 match_tagname[PF_TAG_NAME_SIZE];
500
501	char			 overload_tblname[PF_TABLE_NAME_SIZE];
502
503	TAILQ_ENTRY(pf_rule)	 entries;
504	struct pf_pool		 rpool;
505
506	u_int64_t		 evaluations;
507	u_int64_t		 packets[2];
508	u_int64_t		 bytes[2];
509
510	struct pfi_kif		*kif;
511	struct pf_anchor	*anchor;
512	struct pfr_ktable	*overload_tbl;
513
514	pf_osfp_t		 os_fingerprint;
515
516	int			 rtableid;
517	u_int32_t		 timeout[PFTM_MAX];
518	u_int32_t		 max_states;
519	u_int32_t		 max_src_nodes;
520	u_int32_t		 max_src_states;
521	u_int32_t		 max_src_conn;
522	struct {
523		u_int32_t		limit;
524		u_int32_t		seconds;
525	}			 max_src_conn_rate;
526	u_int32_t		 qid;
527	u_int32_t		 pqid;
528	u_int32_t		 rt_listid;
529	u_int32_t		 nr;
530	u_int32_t		 prob;
531	uid_t			 cuid;
532	pid_t			 cpid;
533
534	counter_u64_t		 states_cur;
535	counter_u64_t		 states_tot;
536	counter_u64_t		 src_nodes;
537
538	u_int16_t		 return_icmp;
539	u_int16_t		 return_icmp6;
540	u_int16_t		 max_mss;
541	u_int16_t		 tag;
542	u_int16_t		 match_tag;
543	u_int16_t		 scrub_flags;
544
545	struct pf_rule_uid	 uid;
546	struct pf_rule_gid	 gid;
547
548	u_int32_t		 rule_flag;
549	u_int8_t		 action;
550	u_int8_t		 direction;
551	u_int8_t		 log;
552	u_int8_t		 logif;
553	u_int8_t		 quick;
554	u_int8_t		 ifnot;
555	u_int8_t		 match_tag_not;
556	u_int8_t		 natpass;
557
558#define PF_STATE_NORMAL		0x1
559#define PF_STATE_MODULATE	0x2
560#define PF_STATE_SYNPROXY	0x3
561	u_int8_t		 keep_state;
562	sa_family_t		 af;
563	u_int8_t		 proto;
564	u_int8_t		 type;
565	u_int8_t		 code;
566	u_int8_t		 flags;
567	u_int8_t		 flagset;
568	u_int8_t		 min_ttl;
569	u_int8_t		 allow_opts;
570	u_int8_t		 rt;
571	u_int8_t		 return_ttl;
572	u_int8_t		 tos;
573	u_int8_t		 set_tos;
574	u_int8_t		 anchor_relative;
575	u_int8_t		 anchor_wildcard;
576
577#define PF_FLUSH		0x01
578#define PF_FLUSH_GLOBAL		0x02
579	u_int8_t		 flush;
580#define PF_PRIO_ZERO		0xff		/* match "prio 0" packets */
581#define PF_PRIO_MAX		7
582	u_int8_t		 prio;
583	u_int8_t		 set_prio[2];
584
585	struct {
586		struct pf_addr		addr;
587		u_int16_t		port;
588	}			divert;
589
590	uint64_t		 u_states_cur;
591	uint64_t		 u_states_tot;
592	uint64_t		 u_src_nodes;
593};
594
595/* rule flags */
596#define	PFRULE_DROP		0x0000
597#define	PFRULE_RETURNRST	0x0001
598#define	PFRULE_FRAGMENT		0x0002
599#define	PFRULE_RETURNICMP	0x0004
600#define	PFRULE_RETURN		0x0008
601#define	PFRULE_NOSYNC		0x0010
602#define PFRULE_SRCTRACK		0x0020  /* track source states */
603#define PFRULE_RULESRCTRACK	0x0040  /* per rule */
604#define	PFRULE_REFS		0x0080	/* rule has references */
605
606/* scrub flags */
607#define	PFRULE_NODF		0x0100
608#define PFRULE_RANDOMID		0x0800
609#define PFRULE_REASSEMBLE_TCP	0x1000
610#define PFRULE_SET_TOS		0x2000
611
612/* rule flags again */
613#define PFRULE_IFBOUND		0x00010000	/* if-bound */
614#define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
615
616#define PFSTATE_HIWAT		10000	/* default state table size */
617#define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
618#define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
619
620
621struct pf_threshold {
622	u_int32_t	limit;
623#define	PF_THRESHOLD_MULT	1000
624#define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
625	u_int32_t	seconds;
626	u_int32_t	count;
627	u_int32_t	last;
628};
629
630struct pf_src_node {
631	LIST_ENTRY(pf_src_node) entry;
632	struct pf_addr	 addr;
633	struct pf_addr	 raddr;
634	union pf_rule_ptr rule;
635	struct pfi_kif	*kif;
636	u_int64_t	 bytes[2];
637	u_int64_t	 packets[2];
638	u_int32_t	 states;
639	u_int32_t	 conn;
640	struct pf_threshold	conn_rate;
641	u_int32_t	 creation;
642	u_int32_t	 expire;
643	sa_family_t	 af;
644	u_int8_t	 ruletype;
645};
646
647#define PFSNODE_HIWAT		10000	/* default source node table size */
648
649struct pf_state_scrub {
650	struct timeval	pfss_last;	/* time received last packet	*/
651	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
652	u_int32_t	pfss_tsval;	/* largest timestamp		*/
653	u_int32_t	pfss_tsval0;	/* original timestamp		*/
654	u_int16_t	pfss_flags;
655#define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
656#define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
657#define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
658#define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
659#define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
660	u_int8_t	pfss_ttl;	/* stashed TTL			*/
661	u_int8_t	pad;
662	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
663};
664
665struct pf_state_host {
666	struct pf_addr	addr;
667	u_int16_t	port;
668	u_int16_t	pad;
669};
670
671struct pf_state_peer {
672	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
673	u_int32_t	seqlo;		/* Max sequence number sent	*/
674	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
675	u_int32_t	seqdiff;	/* Sequence number modulator	*/
676	u_int16_t	max_win;	/* largest window (pre scaling)	*/
677	u_int16_t	mss;		/* Maximum segment size option	*/
678	u_int8_t	state;		/* active state level		*/
679	u_int8_t	wscale;		/* window scaling factor	*/
680	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
681	u_int8_t	pad[1];
682};
683
684/* Keep synced with struct pf_state_key. */
685struct pf_state_key_cmp {
686	struct pf_addr	 addr[2];
687	u_int16_t	 port[2];
688	sa_family_t	 af;
689	u_int8_t	 proto;
690	u_int8_t	 pad[2];
691};
692
693struct pf_state_key {
694	struct pf_addr	 addr[2];
695	u_int16_t	 port[2];
696	sa_family_t	 af;
697	u_int8_t	 proto;
698	u_int8_t	 pad[2];
699
700	LIST_ENTRY(pf_state_key) entry;
701	TAILQ_HEAD(, pf_state)	 states[2];
702};
703
704/* Keep synced with struct pf_state. */
705struct pf_state_cmp {
706	u_int64_t		 id;
707	u_int32_t		 creatorid;
708	u_int8_t		 direction;
709	u_int8_t		 pad[3];
710};
711
712struct pf_state {
713	u_int64_t		 id;
714	u_int32_t		 creatorid;
715	u_int8_t		 direction;
716	u_int8_t		 pad[3];
717
718	u_int			 refs;
719	TAILQ_ENTRY(pf_state)	 sync_list;
720	TAILQ_ENTRY(pf_state)	 key_list[2];
721	LIST_ENTRY(pf_state)	 entry;
722	struct pf_state_peer	 src;
723	struct pf_state_peer	 dst;
724	union pf_rule_ptr	 rule;
725	union pf_rule_ptr	 anchor;
726	union pf_rule_ptr	 nat_rule;
727	struct pf_addr		 rt_addr;
728	struct pf_state_key	*key[2];	/* addresses stack and wire  */
729	struct pfi_kif		*kif;
730	struct pfi_kif		*rt_kif;
731	struct pf_src_node	*src_node;
732	struct pf_src_node	*nat_src_node;
733	u_int64_t		 packets[2];
734	u_int64_t		 bytes[2];
735	u_int32_t		 creation;
736	u_int32_t	 	 expire;
737	u_int32_t		 pfsync_time;
738	u_int16_t		 tag;
739	u_int8_t		 log;
740	u_int8_t		 state_flags;
741#define	PFSTATE_ALLOWOPTS	0x01
742#define	PFSTATE_SLOPPY		0x02
743/*  was	PFSTATE_PFLOW		0x04 */
744#define	PFSTATE_NOSYNC		0x08
745#define	PFSTATE_ACK		0x10
746#define	PFSTATE_SETPRIO		0x0200
747#define	PFSTATE_SETMASK   (PFSTATE_SETPRIO)
748	u_int8_t		 timeout;
749	u_int8_t		 sync_state; /* PFSYNC_S_x */
750
751	/* XXX */
752	u_int8_t		 sync_updates;
753	u_int8_t		_tail[3];
754};
755
756/*
757 * Unified state structures for pulling states out of the kernel
758 * used by pfsync(4) and the pf(4) ioctl.
759 */
760struct pfsync_state_scrub {
761	u_int16_t	pfss_flags;
762	u_int8_t	pfss_ttl;	/* stashed TTL		*/
763#define PFSYNC_SCRUB_FLAG_VALID		0x01
764	u_int8_t	scrub_flag;
765	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
766} __packed;
767
768struct pfsync_state_peer {
769	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
770	u_int32_t	seqlo;		/* Max sequence number sent	*/
771	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
772	u_int32_t	seqdiff;	/* Sequence number modulator	*/
773	u_int16_t	max_win;	/* largest window (pre scaling)	*/
774	u_int16_t	mss;		/* Maximum segment size option	*/
775	u_int8_t	state;		/* active state level		*/
776	u_int8_t	wscale;		/* window scaling factor	*/
777	u_int8_t	pad[6];
778} __packed;
779
780struct pfsync_state_key {
781	struct pf_addr	 addr[2];
782	u_int16_t	 port[2];
783};
784
785struct pfsync_state {
786	u_int64_t	 id;
787	char		 ifname[IFNAMSIZ];
788	struct pfsync_state_key	key[2];
789	struct pfsync_state_peer src;
790	struct pfsync_state_peer dst;
791	struct pf_addr	 rt_addr;
792	u_int32_t	 rule;
793	u_int32_t	 anchor;
794	u_int32_t	 nat_rule;
795	u_int32_t	 creation;
796	u_int32_t	 expire;
797	u_int32_t	 packets[2][2];
798	u_int32_t	 bytes[2][2];
799	u_int32_t	 creatorid;
800	sa_family_t	 af;
801	u_int8_t	 proto;
802	u_int8_t	 direction;
803	u_int8_t	 __spare[2];
804	u_int8_t	 log;
805	u_int8_t	 state_flags;
806	u_int8_t	 timeout;
807	u_int8_t	 sync_flags;
808	u_int8_t	 updates;
809} __packed;
810
811#ifdef _KERNEL
812/* pfsync */
813typedef int		pfsync_state_import_t(struct pfsync_state *, u_int8_t);
814typedef	void		pfsync_insert_state_t(struct pf_state *);
815typedef	void		pfsync_update_state_t(struct pf_state *);
816typedef	void		pfsync_delete_state_t(struct pf_state *);
817typedef void		pfsync_clear_states_t(u_int32_t, const char *);
818typedef int		pfsync_defer_t(struct pf_state *, struct mbuf *);
819
820extern pfsync_state_import_t	*pfsync_state_import_ptr;
821extern pfsync_insert_state_t	*pfsync_insert_state_ptr;
822extern pfsync_update_state_t	*pfsync_update_state_ptr;
823extern pfsync_delete_state_t	*pfsync_delete_state_ptr;
824extern pfsync_clear_states_t	*pfsync_clear_states_ptr;
825extern pfsync_defer_t		*pfsync_defer_ptr;
826
827void			pfsync_state_export(struct pfsync_state *,
828			    struct pf_state *);
829
830/* pflog */
831struct pf_ruleset;
832struct pf_pdesc;
833typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
834    u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
835    struct pf_ruleset *, struct pf_pdesc *, int);
836extern pflog_packet_t		*pflog_packet_ptr;
837
838#endif /* _KERNEL */
839
840#define	PFSYNC_FLAG_SRCNODE	0x04
841#define	PFSYNC_FLAG_NATSRCNODE	0x08
842
843/* for copies to/from network byte order */
844/* ioctl interface also uses network byte order */
845#define pf_state_peer_hton(s,d) do {		\
846	(d)->seqlo = htonl((s)->seqlo);		\
847	(d)->seqhi = htonl((s)->seqhi);		\
848	(d)->seqdiff = htonl((s)->seqdiff);	\
849	(d)->max_win = htons((s)->max_win);	\
850	(d)->mss = htons((s)->mss);		\
851	(d)->state = (s)->state;		\
852	(d)->wscale = (s)->wscale;		\
853	if ((s)->scrub) {						\
854		(d)->scrub.pfss_flags = 				\
855		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
856		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
857		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
858		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
859	}								\
860} while (0)
861
862#define pf_state_peer_ntoh(s,d) do {		\
863	(d)->seqlo = ntohl((s)->seqlo);		\
864	(d)->seqhi = ntohl((s)->seqhi);		\
865	(d)->seqdiff = ntohl((s)->seqdiff);	\
866	(d)->max_win = ntohs((s)->max_win);	\
867	(d)->mss = ntohs((s)->mss);		\
868	(d)->state = (s)->state;		\
869	(d)->wscale = (s)->wscale;		\
870	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
871	    (d)->scrub != NULL) {					\
872		(d)->scrub->pfss_flags =				\
873		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
874		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
875		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
876	}								\
877} while (0)
878
879#define pf_state_counter_hton(s,d) do {				\
880	d[0] = htonl((s>>32)&0xffffffff);			\
881	d[1] = htonl(s&0xffffffff);				\
882} while (0)
883
884#define pf_state_counter_from_pfsync(s)				\
885	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
886
887#define pf_state_counter_ntoh(s,d) do {				\
888	d = ntohl(s[0]);					\
889	d = d<<32;						\
890	d += ntohl(s[1]);					\
891} while (0)
892
893TAILQ_HEAD(pf_rulequeue, pf_rule);
894
895struct pf_anchor;
896
897struct pf_ruleset {
898	struct {
899		struct pf_rulequeue	 queues[2];
900		struct {
901			struct pf_rulequeue	*ptr;
902			struct pf_rule		**ptr_array;
903			u_int32_t		 rcount;
904			u_int32_t		 ticket;
905			int			 open;
906		}			 active, inactive;
907	}			 rules[PF_RULESET_MAX];
908	struct pf_anchor	*anchor;
909	u_int32_t		 tticket;
910	int			 tables;
911	int			 topen;
912};
913
914RB_HEAD(pf_anchor_global, pf_anchor);
915RB_HEAD(pf_anchor_node, pf_anchor);
916struct pf_anchor {
917	RB_ENTRY(pf_anchor)	 entry_global;
918	RB_ENTRY(pf_anchor)	 entry_node;
919	struct pf_anchor	*parent;
920	struct pf_anchor_node	 children;
921	char			 name[PF_ANCHOR_NAME_SIZE];
922	char			 path[MAXPATHLEN];
923	struct pf_ruleset	 ruleset;
924	int			 refcnt;	/* anchor rules */
925	int			 match;	/* XXX: used for pfctl black magic */
926};
927RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
928RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
929
930#define PF_RESERVED_ANCHOR	"_pf"
931
932#define PFR_TFLAG_PERSIST	0x00000001
933#define PFR_TFLAG_CONST		0x00000002
934#define PFR_TFLAG_ACTIVE	0x00000004
935#define PFR_TFLAG_INACTIVE	0x00000008
936#define PFR_TFLAG_REFERENCED	0x00000010
937#define PFR_TFLAG_REFDANCHOR	0x00000020
938#define PFR_TFLAG_COUNTERS	0x00000040
939/* Adjust masks below when adding flags. */
940#define PFR_TFLAG_USRMASK	(PFR_TFLAG_PERSIST	| \
941				 PFR_TFLAG_CONST	| \
942				 PFR_TFLAG_COUNTERS)
943#define PFR_TFLAG_SETMASK	(PFR_TFLAG_ACTIVE	| \
944				 PFR_TFLAG_INACTIVE	| \
945				 PFR_TFLAG_REFERENCED	| \
946				 PFR_TFLAG_REFDANCHOR)
947#define PFR_TFLAG_ALLMASK	(PFR_TFLAG_PERSIST	| \
948				 PFR_TFLAG_CONST	| \
949				 PFR_TFLAG_ACTIVE	| \
950				 PFR_TFLAG_INACTIVE	| \
951				 PFR_TFLAG_REFERENCED	| \
952				 PFR_TFLAG_REFDANCHOR	| \
953				 PFR_TFLAG_COUNTERS)
954
955struct pf_anchor_stackframe;
956
957struct pfr_table {
958	char			 pfrt_anchor[MAXPATHLEN];
959	char			 pfrt_name[PF_TABLE_NAME_SIZE];
960	u_int32_t		 pfrt_flags;
961	u_int8_t		 pfrt_fback;
962};
963
964enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
965	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
966	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
967
968struct pfr_addr {
969	union {
970		struct in_addr	 _pfra_ip4addr;
971		struct in6_addr	 _pfra_ip6addr;
972	}		 pfra_u;
973	u_int8_t	 pfra_af;
974	u_int8_t	 pfra_net;
975	u_int8_t	 pfra_not;
976	u_int8_t	 pfra_fback;
977};
978#define	pfra_ip4addr	pfra_u._pfra_ip4addr
979#define	pfra_ip6addr	pfra_u._pfra_ip6addr
980
981enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
982enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
983#define PFR_OP_XPASS	PFR_OP_ADDR_MAX
984
985struct pfr_astats {
986	struct pfr_addr	 pfras_a;
987	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
988	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
989	long		 pfras_tzero;
990};
991
992enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
993
994struct pfr_tstats {
995	struct pfr_table pfrts_t;
996	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
997	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
998	u_int64_t	 pfrts_match;
999	u_int64_t	 pfrts_nomatch;
1000	long		 pfrts_tzero;
1001	int		 pfrts_cnt;
1002	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1003};
1004#define	pfrts_name	pfrts_t.pfrt_name
1005#define pfrts_flags	pfrts_t.pfrt_flags
1006
1007#ifndef _SOCKADDR_UNION_DEFINED
1008#define	_SOCKADDR_UNION_DEFINED
1009union sockaddr_union {
1010	struct sockaddr		sa;
1011	struct sockaddr_in	sin;
1012	struct sockaddr_in6	sin6;
1013};
1014#endif /* _SOCKADDR_UNION_DEFINED */
1015
1016struct pfr_kcounters {
1017	u_int64_t		 pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1018	u_int64_t		 pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1019};
1020
1021SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1022struct pfr_kentry {
1023	struct radix_node	 pfrke_node[2];
1024	union sockaddr_union	 pfrke_sa;
1025	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1026	struct pfr_kcounters	*pfrke_counters;
1027	long			 pfrke_tzero;
1028	u_int8_t		 pfrke_af;
1029	u_int8_t		 pfrke_net;
1030	u_int8_t		 pfrke_not;
1031	u_int8_t		 pfrke_mark;
1032};
1033
1034SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1035RB_HEAD(pfr_ktablehead, pfr_ktable);
1036struct pfr_ktable {
1037	struct pfr_tstats	 pfrkt_ts;
1038	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1039	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1040	struct radix_node_head	*pfrkt_ip4;
1041	struct radix_node_head	*pfrkt_ip6;
1042	struct pfr_ktable	*pfrkt_shadow;
1043	struct pfr_ktable	*pfrkt_root;
1044	struct pf_ruleset	*pfrkt_rs;
1045	long			 pfrkt_larg;
1046	int			 pfrkt_nflags;
1047};
1048#define pfrkt_t		pfrkt_ts.pfrts_t
1049#define pfrkt_name	pfrkt_t.pfrt_name
1050#define pfrkt_anchor	pfrkt_t.pfrt_anchor
1051#define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1052#define pfrkt_flags	pfrkt_t.pfrt_flags
1053#define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1054#define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1055#define pfrkt_packets	pfrkt_ts.pfrts_packets
1056#define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1057#define pfrkt_match	pfrkt_ts.pfrts_match
1058#define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1059#define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1060
1061/* keep synced with pfi_kif, used in RB_FIND */
1062struct pfi_kif_cmp {
1063	char				 pfik_name[IFNAMSIZ];
1064};
1065
1066struct pfi_kif {
1067	char				 pfik_name[IFNAMSIZ];
1068	union {
1069		RB_ENTRY(pfi_kif)	 _pfik_tree;
1070		LIST_ENTRY(pfi_kif)	 _pfik_list;
1071	} _pfik_glue;
1072#define	pfik_tree	_pfik_glue._pfik_tree
1073#define	pfik_list	_pfik_glue._pfik_list
1074	u_int64_t			 pfik_packets[2][2][2];
1075	u_int64_t			 pfik_bytes[2][2][2];
1076	u_int32_t			 pfik_tzero;
1077	u_int				 pfik_flags;
1078	struct ifnet			*pfik_ifp;
1079	struct ifg_group		*pfik_group;
1080	u_int				 pfik_rulerefs;
1081	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1082};
1083
1084#define	PFI_IFLAG_REFS		0x0001	/* has state references */
1085#define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1086
1087struct pf_pdesc {
1088	struct {
1089		int	 done;
1090		uid_t	 uid;
1091		gid_t	 gid;
1092	}		 lookup;
1093	u_int64_t	 tot_len;	/* Make Mickey money */
1094	union {
1095		struct tcphdr		*tcp;
1096		struct udphdr		*udp;
1097		struct icmp		*icmp;
1098#ifdef INET6
1099		struct icmp6_hdr	*icmp6;
1100#endif /* INET6 */
1101		void			*any;
1102	} hdr;
1103
1104	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1105	struct pf_addr	*src;		/* src address */
1106	struct pf_addr	*dst;		/* dst address */
1107	u_int16_t *sport;
1108	u_int16_t *dport;
1109	struct pf_mtag	*pf_mtag;
1110
1111	u_int32_t	 p_len;		/* total length of payload */
1112
1113	u_int16_t	*ip_sum;
1114	u_int16_t	*proto_sum;
1115	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1116					 * state code. Easier than tags */
1117#define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1118#define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1119	sa_family_t	 af;
1120	u_int8_t	 proto;
1121	u_int8_t	 tos;
1122	u_int8_t	 dir;		/* direction */
1123	u_int8_t	 sidx;		/* key index for source */
1124	u_int8_t	 didx;		/* key index for destination */
1125};
1126
1127/* flags for RDR options */
1128#define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1129#define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1130
1131/* UDP state enumeration */
1132#define PFUDPS_NO_TRAFFIC	0
1133#define PFUDPS_SINGLE		1
1134#define PFUDPS_MULTIPLE		2
1135
1136#define PFUDPS_NSTATES		3	/* number of state levels */
1137
1138#define PFUDPS_NAMES { \
1139	"NO_TRAFFIC", \
1140	"SINGLE", \
1141	"MULTIPLE", \
1142	NULL \
1143}
1144
1145/* Other protocol state enumeration */
1146#define PFOTHERS_NO_TRAFFIC	0
1147#define PFOTHERS_SINGLE		1
1148#define PFOTHERS_MULTIPLE	2
1149
1150#define PFOTHERS_NSTATES	3	/* number of state levels */
1151
1152#define PFOTHERS_NAMES { \
1153	"NO_TRAFFIC", \
1154	"SINGLE", \
1155	"MULTIPLE", \
1156	NULL \
1157}
1158
1159#define ACTION_SET(a, x) \
1160	do { \
1161		if ((a) != NULL) \
1162			*(a) = (x); \
1163	} while (0)
1164
1165#define REASON_SET(a, x) \
1166	do { \
1167		if ((a) != NULL) \
1168			*(a) = (x); \
1169		if (x < PFRES_MAX) \
1170			counter_u64_add(V_pf_status.counters[x], 1); \
1171	} while (0)
1172
1173struct pf_kstatus {
1174	counter_u64_t	counters[PFRES_MAX]; /* reason for passing/dropping */
1175	counter_u64_t	lcounters[LCNT_MAX]; /* limit counters */
1176	counter_u64_t	fcounters[FCNT_MAX]; /* state operation counters */
1177	counter_u64_t	scounters[SCNT_MAX]; /* src_node operation counters */
1178	uint32_t	states;
1179	uint32_t	src_nodes;
1180	uint32_t	running;
1181	uint32_t	since;
1182	uint32_t	debug;
1183	uint32_t	hostid;
1184	char		ifname[IFNAMSIZ];
1185	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
1186};
1187
1188struct pf_divert {
1189	union {
1190		struct in_addr	ipv4;
1191		struct in6_addr	ipv6;
1192	}		addr;
1193	u_int16_t	port;
1194};
1195
1196#define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1197#define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1198
1199/*
1200 * ioctl parameter structures
1201 */
1202
1203struct pfioc_pooladdr {
1204	u_int32_t		 action;
1205	u_int32_t		 ticket;
1206	u_int32_t		 nr;
1207	u_int32_t		 r_num;
1208	u_int8_t		 r_action;
1209	u_int8_t		 r_last;
1210	u_int8_t		 af;
1211	char			 anchor[MAXPATHLEN];
1212	struct pf_pooladdr	 addr;
1213};
1214
1215struct pfioc_rule {
1216	u_int32_t	 action;
1217	u_int32_t	 ticket;
1218	u_int32_t	 pool_ticket;
1219	u_int32_t	 nr;
1220	char		 anchor[MAXPATHLEN];
1221	char		 anchor_call[MAXPATHLEN];
1222	struct pf_rule	 rule;
1223};
1224
1225struct pfioc_natlook {
1226	struct pf_addr	 saddr;
1227	struct pf_addr	 daddr;
1228	struct pf_addr	 rsaddr;
1229	struct pf_addr	 rdaddr;
1230	u_int16_t	 sport;
1231	u_int16_t	 dport;
1232	u_int16_t	 rsport;
1233	u_int16_t	 rdport;
1234	sa_family_t	 af;
1235	u_int8_t	 proto;
1236	u_int8_t	 direction;
1237};
1238
1239struct pfioc_state {
1240	struct pfsync_state	state;
1241};
1242
1243struct pfioc_src_node_kill {
1244	sa_family_t psnk_af;
1245	struct pf_rule_addr psnk_src;
1246	struct pf_rule_addr psnk_dst;
1247	u_int		    psnk_killed;
1248};
1249
1250struct pfioc_state_kill {
1251	struct pf_state_cmp	psk_pfcmp;
1252	sa_family_t		psk_af;
1253	int			psk_proto;
1254	struct pf_rule_addr	psk_src;
1255	struct pf_rule_addr	psk_dst;
1256	char			psk_ifname[IFNAMSIZ];
1257	char			psk_label[PF_RULE_LABEL_SIZE];
1258	u_int			psk_killed;
1259};
1260
1261struct pfioc_states {
1262	int	ps_len;
1263	union {
1264		caddr_t			 psu_buf;
1265		struct pfsync_state	*psu_states;
1266	} ps_u;
1267#define ps_buf		ps_u.psu_buf
1268#define ps_states	ps_u.psu_states
1269};
1270
1271struct pfioc_src_nodes {
1272	int	psn_len;
1273	union {
1274		caddr_t		 psu_buf;
1275		struct pf_src_node	*psu_src_nodes;
1276	} psn_u;
1277#define psn_buf		psn_u.psu_buf
1278#define psn_src_nodes	psn_u.psu_src_nodes
1279};
1280
1281struct pfioc_if {
1282	char		 ifname[IFNAMSIZ];
1283};
1284
1285struct pfioc_tm {
1286	int		 timeout;
1287	int		 seconds;
1288};
1289
1290struct pfioc_limit {
1291	int		 index;
1292	unsigned	 limit;
1293};
1294
1295struct pfioc_altq {
1296	u_int32_t	 action;
1297	u_int32_t	 ticket;
1298	u_int32_t	 nr;
1299	struct pf_altq	 altq;
1300};
1301
1302struct pfioc_qstats {
1303	u_int32_t	 ticket;
1304	u_int32_t	 nr;
1305	void		*buf;
1306	int		 nbytes;
1307	u_int8_t	 scheduler;
1308};
1309
1310struct pfioc_ruleset {
1311	u_int32_t	 nr;
1312	char		 path[MAXPATHLEN];
1313	char		 name[PF_ANCHOR_NAME_SIZE];
1314};
1315
1316#define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1317#define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1318struct pfioc_trans {
1319	int		 size;	/* number of elements */
1320	int		 esize; /* size of each element in bytes */
1321	struct pfioc_trans_e {
1322		int		rs_num;
1323		char		anchor[MAXPATHLEN];
1324		u_int32_t	ticket;
1325	}		*array;
1326};
1327
1328#define PFR_FLAG_ATOMIC		0x00000001	/* unused */
1329#define PFR_FLAG_DUMMY		0x00000002
1330#define PFR_FLAG_FEEDBACK	0x00000004
1331#define PFR_FLAG_CLSTATS	0x00000008
1332#define PFR_FLAG_ADDRSTOO	0x00000010
1333#define PFR_FLAG_REPLACE	0x00000020
1334#define PFR_FLAG_ALLRSETS	0x00000040
1335#define PFR_FLAG_ALLMASK	0x0000007F
1336#ifdef _KERNEL
1337#define PFR_FLAG_USERIOCTL	0x10000000
1338#endif
1339
1340struct pfioc_table {
1341	struct pfr_table	 pfrio_table;
1342	void			*pfrio_buffer;
1343	int			 pfrio_esize;
1344	int			 pfrio_size;
1345	int			 pfrio_size2;
1346	int			 pfrio_nadd;
1347	int			 pfrio_ndel;
1348	int			 pfrio_nchange;
1349	int			 pfrio_flags;
1350	u_int32_t		 pfrio_ticket;
1351};
1352#define	pfrio_exists	pfrio_nadd
1353#define	pfrio_nzero	pfrio_nadd
1354#define	pfrio_nmatch	pfrio_nadd
1355#define pfrio_naddr	pfrio_size2
1356#define pfrio_setflag	pfrio_size2
1357#define pfrio_clrflag	pfrio_nadd
1358
1359struct pfioc_iface {
1360	char	 pfiio_name[IFNAMSIZ];
1361	void	*pfiio_buffer;
1362	int	 pfiio_esize;
1363	int	 pfiio_size;
1364	int	 pfiio_nzero;
1365	int	 pfiio_flags;
1366};
1367
1368
1369/*
1370 * ioctl operations
1371 */
1372
1373#define DIOCSTART	_IO  ('D',  1)
1374#define DIOCSTOP	_IO  ('D',  2)
1375#define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1376#define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1377#define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1378/* XXX cut 8 - 17 */
1379#define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1380#define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1381#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1382#define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1383#define DIOCCLRSTATUS	_IO  ('D', 22)
1384#define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1385#define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1386#define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1387#define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1388/* XXX cut 26 - 28 */
1389#define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1390#define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1391#define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1392#define DIOCCLRRULECTRS	_IO  ('D', 38)
1393#define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1394#define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1395#define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1396#define DIOCSTARTALTQ	_IO  ('D', 42)
1397#define DIOCSTOPALTQ	_IO  ('D', 43)
1398#define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1399#define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1400#define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1401#define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1402#define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1403#define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1404#define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1405#define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1406#define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1407#define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1408/* XXX cut 55 - 57 */
1409#define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1410#define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1411#define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1412#define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1413#define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1414#define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1415#define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1416#define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
1417#define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1418#define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1419#define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1420#define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1421#define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1422#define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1423#define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
1424#define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1425#define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1426#define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1427#define	DIOCOSFPFLUSH	_IO('D', 78)
1428#define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1429#define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1430#define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
1431#define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
1432#define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
1433#define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1434#define	DIOCCLRSRCNODES	_IO('D', 85)
1435#define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1436#define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1437#define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1438#define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1439#define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1440struct pf_ifspeed {
1441	char			ifname[IFNAMSIZ];
1442	u_int32_t		baudrate;
1443};
1444#define	DIOCGIFSPEED	_IOWR('D', 92, struct pf_ifspeed)
1445
1446#ifdef _KERNEL
1447LIST_HEAD(pf_src_node_list, pf_src_node);
1448struct pf_srchash {
1449	struct pf_src_node_list		nodes;
1450	struct mtx			lock;
1451};
1452
1453struct pf_keyhash {
1454	LIST_HEAD(, pf_state_key)	keys;
1455	struct mtx			lock;
1456};
1457
1458struct pf_idhash {
1459	LIST_HEAD(, pf_state)		states;
1460	struct mtx			lock;
1461};
1462
1463extern u_long		pf_hashmask;
1464extern u_long		pf_srchashmask;
1465#define	PF_HASHSIZ	(32768)
1466VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1467VNET_DECLARE(struct pf_idhash *, pf_idhash);
1468#define V_pf_keyhash	VNET(pf_keyhash)
1469#define	V_pf_idhash	VNET(pf_idhash)
1470VNET_DECLARE(struct pf_srchash *, pf_srchash);
1471#define	V_pf_srchash	VNET(pf_srchash)
1472
1473#define PF_IDHASH(s)	(be64toh((s)->id) % (pf_hashmask + 1))
1474
1475VNET_DECLARE(void *, pf_swi_cookie);
1476#define V_pf_swi_cookie	VNET(pf_swi_cookie)
1477
1478VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1479#define	V_pf_stateid	VNET(pf_stateid)
1480
1481TAILQ_HEAD(pf_altqqueue, pf_altq);
1482VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[2]);
1483#define	V_pf_altqs			 VNET(pf_altqs)
1484VNET_DECLARE(struct pf_palist,		 pf_pabuf);
1485#define	V_pf_pabuf			 VNET(pf_pabuf)
1486
1487VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
1488#define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
1489VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
1490#define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
1491VNET_DECLARE(int,			 altqs_inactive_open);
1492#define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
1493VNET_DECLARE(u_int32_t,			 ticket_pabuf);
1494#define	V_ticket_pabuf			 VNET(ticket_pabuf)
1495VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
1496#define	V_pf_altqs_active		 VNET(pf_altqs_active)
1497VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
1498#define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
1499
1500VNET_DECLARE(struct pf_rulequeue, pf_unlinked_rules);
1501#define	V_pf_unlinked_rules	VNET(pf_unlinked_rules)
1502
1503void				 pf_initialize(void);
1504void				 pf_mtag_initialize(void);
1505void				 pf_mtag_cleanup(void);
1506void				 pf_cleanup(void);
1507
1508struct pf_mtag			*pf_get_mtag(struct mbuf *);
1509
1510extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1511#ifdef ALTQ
1512extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
1513#endif
1514VNET_DECLARE(uma_zone_t,	 pf_state_z);
1515#define	V_pf_state_z		 VNET(pf_state_z)
1516VNET_DECLARE(uma_zone_t,	 pf_state_key_z);
1517#define	V_pf_state_key_z	 VNET(pf_state_key_z)
1518VNET_DECLARE(uma_zone_t,	 pf_state_scrub_z);
1519#define	V_pf_state_scrub_z	 VNET(pf_state_scrub_z)
1520
1521extern void			 pf_purge_thread(void *);
1522extern void			 pf_unload_vnet_purge(void);
1523extern void			 pf_intr(void *);
1524extern void			 pf_purge_expired_src_nodes(void);
1525
1526extern int			 pf_unlink_state(struct pf_state *, u_int);
1527#define	PF_ENTER_LOCKED		0x00000001
1528#define	PF_RETURN_LOCKED	0x00000002
1529extern int			 pf_state_insert(struct pfi_kif *,
1530				    struct pf_state_key *,
1531				    struct pf_state_key *,
1532				    struct pf_state *);
1533extern void			 pf_free_state(struct pf_state *);
1534
1535static __inline void
1536pf_ref_state(struct pf_state *s)
1537{
1538
1539	refcount_acquire(&s->refs);
1540}
1541
1542static __inline int
1543pf_release_state(struct pf_state *s)
1544{
1545
1546	if (refcount_release(&s->refs)) {
1547		pf_free_state(s);
1548		return (1);
1549	} else
1550		return (0);
1551}
1552
1553extern struct pf_state		*pf_find_state_byid(uint64_t, uint32_t);
1554extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1555				    u_int, int *);
1556extern struct pf_src_node	*pf_find_src_node(struct pf_addr *,
1557				    struct pf_rule *, sa_family_t, int);
1558extern void			 pf_unlink_src_node(struct pf_src_node *);
1559extern u_int			 pf_free_src_nodes(struct pf_src_node_list *);
1560extern void			 pf_print_state(struct pf_state *);
1561extern void			 pf_print_flags(u_int8_t);
1562extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1563				    u_int8_t);
1564extern u_int16_t		 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1565				    u_int16_t, u_int16_t, u_int8_t);
1566
1567VNET_DECLARE(struct ifnet *,		 sync_ifp);
1568#define	V_sync_ifp		 	 VNET(sync_ifp);
1569VNET_DECLARE(struct pf_rule,		 pf_default_rule);
1570#define	V_pf_default_rule		  VNET(pf_default_rule)
1571extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1572				    u_int8_t);
1573void				pf_free_rule(struct pf_rule *);
1574
1575#ifdef INET
1576int	pf_test(int, struct ifnet *, struct mbuf **, struct inpcb *);
1577int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1578	    struct pf_pdesc *);
1579#endif /* INET */
1580
1581#ifdef INET6
1582int	pf_test6(int, struct ifnet *, struct mbuf **, struct inpcb *);
1583int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1584	    struct pf_pdesc *);
1585void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1586	    struct pf_addr *, struct pf_addr *, u_int8_t);
1587void	pf_addr_inc(struct pf_addr *, sa_family_t);
1588int	pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *);
1589#endif /* INET6 */
1590
1591u_int32_t	pf_new_isn(struct pf_state *);
1592void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1593	    sa_family_t);
1594void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1595void	pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1596	    u_int8_t);
1597void	pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1598void	pf_send_deferred_syn(struct pf_state *);
1599int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1600	    struct pf_addr *, sa_family_t);
1601int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1602	    struct pf_addr *, sa_family_t);
1603int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1604
1605void	pf_normalize_init(void);
1606void	pf_normalize_cleanup(void);
1607int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1608	    struct pf_pdesc *);
1609void	pf_normalize_tcp_cleanup(struct pf_state *);
1610int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1611	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1612int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1613	    u_short *, struct tcphdr *, struct pf_state *,
1614	    struct pf_state_peer *, struct pf_state_peer *, int *);
1615u_int32_t
1616	pf_state_expires(const struct pf_state *);
1617void	pf_purge_expired_fragments(void);
1618int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1619	    int);
1620int	pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1621struct pf_state_key *pf_alloc_state_key(int);
1622void	pfr_initialize(void);
1623void	pfr_cleanup(void);
1624int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1625void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1626	    u_int64_t, int, int, int);
1627int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1628void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1629struct pfr_ktable *
1630	pfr_attach_table(struct pf_ruleset *, char *);
1631void	pfr_detach_table(struct pfr_ktable *);
1632int	pfr_clr_tables(struct pfr_table *, int *, int);
1633int	pfr_add_tables(struct pfr_table *, int, int *, int);
1634int	pfr_del_tables(struct pfr_table *, int, int *, int);
1635int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1636int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1637int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1638int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1639int	pfr_clr_addrs(struct pfr_table *, int *, int);
1640int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1641int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1642	    int);
1643int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1644	    int);
1645int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1646	    int *, int *, int *, int, u_int32_t);
1647int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1648int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1649int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1650	    int);
1651int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1652	    int);
1653int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1654int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1655int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1656int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1657	    int *, u_int32_t, int);
1658
1659MALLOC_DECLARE(PFI_MTYPE);
1660VNET_DECLARE(struct pfi_kif *,		 pfi_all);
1661#define	V_pfi_all	 		 VNET(pfi_all)
1662
1663void		 pfi_initialize(void);
1664void		 pfi_initialize_vnet(void);
1665void		 pfi_cleanup(void);
1666void		 pfi_cleanup_vnet(void);
1667void		 pfi_kif_ref(struct pfi_kif *);
1668void		 pfi_kif_unref(struct pfi_kif *);
1669struct pfi_kif	*pfi_kif_find(const char *);
1670struct pfi_kif	*pfi_kif_attach(struct pfi_kif *, const char *);
1671int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1672void		 pfi_kif_purge(void);
1673int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1674		    sa_family_t);
1675int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1676void		 pfi_dynaddr_remove(struct pfi_dynaddr *);
1677void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1678void		 pfi_update_status(const char *, struct pf_status *);
1679void		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1680int		 pfi_set_flags(const char *, int);
1681int		 pfi_clear_flags(const char *, int);
1682
1683int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *, int);
1684int		 pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1685int		 pf_addr_cmp(struct pf_addr *, struct pf_addr *,
1686		    sa_family_t);
1687void		 pf_qid2qname(u_int32_t, char *);
1688
1689VNET_DECLARE(struct pf_kstatus, pf_status);
1690#define	V_pf_status	VNET(pf_status)
1691
1692struct pf_limit {
1693	uma_zone_t	zone;
1694	u_int		limit;
1695};
1696VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1697#define	V_pf_limits VNET(pf_limits)
1698
1699#endif /* _KERNEL */
1700
1701#ifdef _KERNEL
1702VNET_DECLARE(struct pf_anchor_global,		 pf_anchors);
1703#define	V_pf_anchors				 VNET(pf_anchors)
1704VNET_DECLARE(struct pf_anchor,			 pf_main_anchor);
1705#define	V_pf_main_anchor			 VNET(pf_main_anchor)
1706#define pf_main_ruleset	V_pf_main_anchor.ruleset
1707#endif
1708
1709/* these ruleset functions can be linked into userland programs (pfctl) */
1710int			 pf_get_ruleset_number(u_int8_t);
1711void			 pf_init_ruleset(struct pf_ruleset *);
1712int			 pf_anchor_setup(struct pf_rule *,
1713			    const struct pf_ruleset *, const char *);
1714int			 pf_anchor_copyout(const struct pf_ruleset *,
1715			    const struct pf_rule *, struct pfioc_rule *);
1716void			 pf_anchor_remove(struct pf_rule *);
1717void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1718struct pf_ruleset	*pf_find_ruleset(const char *);
1719struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1720void			 pf_rs_initialize(void);
1721
1722/* The fingerprint functions can be linked into userland programs (tcpdump) */
1723int	pf_osfp_add(struct pf_osfp_ioctl *);
1724#ifdef _KERNEL
1725struct pf_osfp_enlist *
1726	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1727	    const struct tcphdr *);
1728#endif /* _KERNEL */
1729void	pf_osfp_flush(void);
1730int	pf_osfp_get(struct pf_osfp_ioctl *);
1731int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1732
1733#ifdef _KERNEL
1734void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1735
1736void			 pf_step_into_anchor(struct pf_anchor_stackframe *, int *,
1737			    struct pf_ruleset **, int, struct pf_rule **,
1738			    struct pf_rule **, int *);
1739int			 pf_step_out_of_anchor(struct pf_anchor_stackframe *, int *,
1740			    struct pf_ruleset **, int, struct pf_rule **,
1741			    struct pf_rule **, int *);
1742
1743int			 pf_map_addr(u_int8_t, struct pf_rule *,
1744			    struct pf_addr *, struct pf_addr *,
1745			    struct pf_addr *, struct pf_src_node **);
1746struct pf_rule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
1747			    int, int, struct pfi_kif *, struct pf_src_node **,
1748			    struct pf_state_key **, struct pf_state_key **,
1749			    struct pf_addr *, struct pf_addr *,
1750			    uint16_t, uint16_t, struct pf_anchor_stackframe *);
1751
1752struct pf_state_key	*pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1753			    struct pf_addr *, u_int16_t, u_int16_t);
1754struct pf_state_key	*pf_state_key_clone(struct pf_state_key *);
1755#endif /* _KERNEL */
1756
1757#endif /* _NET_PFVAR_H_ */
1758