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