xref: /freebsd/sys/net/pfvar.h (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
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$
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 
51 struct 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 
72 struct 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 
93 struct 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 
144 extern 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 
148 extern 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 
322 struct pf_rule_uid {
323 	uid_t		 uid[2];
324 	u_int8_t	 op;
325 };
326 
327 struct pf_rule_gid {
328 	uid_t		 gid[2];
329 	u_int8_t	 op;
330 };
331 
332 struct 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 
339 struct 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 
346 TAILQ_HEAD(pf_palist, pf_pooladdr);
347 
348 struct 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 
359 struct 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 */
371 typedef 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 
376 struct 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 */
416 typedef u_int64_t	pf_tcpopts_t;
417 struct 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 
457 struct 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 
472 union pf_rule_ptr {
473 	struct pf_rule		*ptr;
474 	u_int32_t		 nr;
475 };
476 
477 #define	PF_ANCHOR_NAME_SIZE	 64
478 
479 struct 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		 spare2;			/* netgraph */
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 
581 	struct {
582 		struct pf_addr		addr;
583 		u_int16_t		port;
584 	}			divert;
585 
586 	uint64_t		 u_states_cur;
587 	uint64_t		 u_states_tot;
588 	uint64_t		 u_src_nodes;
589 };
590 
591 /* rule flags */
592 #define	PFRULE_DROP		0x0000
593 #define	PFRULE_RETURNRST	0x0001
594 #define	PFRULE_FRAGMENT		0x0002
595 #define	PFRULE_RETURNICMP	0x0004
596 #define	PFRULE_RETURN		0x0008
597 #define	PFRULE_NOSYNC		0x0010
598 #define PFRULE_SRCTRACK		0x0020  /* track source states */
599 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
600 #define	PFRULE_REFS		0x0080	/* rule has references */
601 
602 /* scrub flags */
603 #define	PFRULE_NODF		0x0100
604 #define PFRULE_RANDOMID		0x0800
605 #define PFRULE_REASSEMBLE_TCP	0x1000
606 #define PFRULE_SET_TOS		0x2000
607 
608 /* rule flags again */
609 #define PFRULE_IFBOUND		0x00010000	/* if-bound */
610 #define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
611 
612 #define PFSTATE_HIWAT		10000	/* default state table size */
613 #define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
614 #define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
615 
616 
617 struct pf_threshold {
618 	u_int32_t	limit;
619 #define	PF_THRESHOLD_MULT	1000
620 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
621 	u_int32_t	seconds;
622 	u_int32_t	count;
623 	u_int32_t	last;
624 };
625 
626 struct pf_src_node {
627 	LIST_ENTRY(pf_src_node) entry;
628 	struct pf_addr	 addr;
629 	struct pf_addr	 raddr;
630 	union pf_rule_ptr rule;
631 	struct pfi_kif	*kif;
632 	u_int64_t	 bytes[2];
633 	u_int64_t	 packets[2];
634 	u_int32_t	 states;
635 	u_int32_t	 conn;
636 	struct pf_threshold	conn_rate;
637 	u_int32_t	 creation;
638 	u_int32_t	 expire;
639 	sa_family_t	 af;
640 	u_int8_t	 ruletype;
641 };
642 
643 #define PFSNODE_HIWAT		10000	/* default source node table size */
644 
645 struct pf_state_scrub {
646 	struct timeval	pfss_last;	/* time received last packet	*/
647 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
648 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
649 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
650 	u_int16_t	pfss_flags;
651 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
652 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
653 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
654 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
655 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
656 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
657 	u_int8_t	pad;
658 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
659 };
660 
661 struct pf_state_host {
662 	struct pf_addr	addr;
663 	u_int16_t	port;
664 	u_int16_t	pad;
665 };
666 
667 struct pf_state_peer {
668 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
669 	u_int32_t	seqlo;		/* Max sequence number sent	*/
670 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
671 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
672 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
673 	u_int16_t	mss;		/* Maximum segment size option	*/
674 	u_int8_t	state;		/* active state level		*/
675 	u_int8_t	wscale;		/* window scaling factor	*/
676 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
677 	u_int8_t	pad[1];
678 };
679 
680 /* Keep synced with struct pf_state_key. */
681 struct pf_state_key_cmp {
682 	struct pf_addr	 addr[2];
683 	u_int16_t	 port[2];
684 	sa_family_t	 af;
685 	u_int8_t	 proto;
686 	u_int8_t	 pad[2];
687 };
688 
689 struct pf_state_key {
690 	struct pf_addr	 addr[2];
691 	u_int16_t	 port[2];
692 	sa_family_t	 af;
693 	u_int8_t	 proto;
694 	u_int8_t	 pad[2];
695 
696 	LIST_ENTRY(pf_state_key) entry;
697 	TAILQ_HEAD(, pf_state)	 states[2];
698 };
699 
700 /* Keep synced with struct pf_state. */
701 struct pf_state_cmp {
702 	u_int64_t		 id;
703 	u_int32_t		 creatorid;
704 	u_int8_t		 direction;
705 	u_int8_t		 pad[3];
706 };
707 
708 struct pf_state {
709 	u_int64_t		 id;
710 	u_int32_t		 creatorid;
711 	u_int8_t		 direction;
712 	u_int8_t		 pad[3];
713 
714 	u_int			 refs;
715 	TAILQ_ENTRY(pf_state)	 sync_list;
716 	TAILQ_ENTRY(pf_state)	 key_list[2];
717 	LIST_ENTRY(pf_state)	 entry;
718 	struct pf_state_peer	 src;
719 	struct pf_state_peer	 dst;
720 	union pf_rule_ptr	 rule;
721 	union pf_rule_ptr	 anchor;
722 	union pf_rule_ptr	 nat_rule;
723 	struct pf_addr		 rt_addr;
724 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
725 	struct pfi_kif		*kif;
726 	struct pfi_kif		*rt_kif;
727 	struct pf_src_node	*src_node;
728 	struct pf_src_node	*nat_src_node;
729 	u_int64_t		 packets[2];
730 	u_int64_t		 bytes[2];
731 	u_int32_t		 creation;
732 	u_int32_t	 	 expire;
733 	u_int32_t		 pfsync_time;
734 	u_int16_t		 tag;
735 	u_int8_t		 log;
736 	u_int8_t		 state_flags;
737 #define	PFSTATE_ALLOWOPTS	0x01
738 #define	PFSTATE_SLOPPY		0x02
739 /*  was	PFSTATE_PFLOW		0x04 */
740 #define	PFSTATE_NOSYNC		0x08
741 #define	PFSTATE_ACK		0x10
742 	u_int8_t		 timeout;
743 	u_int8_t		 sync_state; /* PFSYNC_S_x */
744 
745 	/* XXX */
746 	u_int8_t		 sync_updates;
747 	u_int8_t		_tail[3];
748 };
749 
750 /*
751  * Unified state structures for pulling states out of the kernel
752  * used by pfsync(4) and the pf(4) ioctl.
753  */
754 struct pfsync_state_scrub {
755 	u_int16_t	pfss_flags;
756 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
757 #define PFSYNC_SCRUB_FLAG_VALID		0x01
758 	u_int8_t	scrub_flag;
759 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
760 } __packed;
761 
762 struct pfsync_state_peer {
763 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
764 	u_int32_t	seqlo;		/* Max sequence number sent	*/
765 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
766 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
767 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
768 	u_int16_t	mss;		/* Maximum segment size option	*/
769 	u_int8_t	state;		/* active state level		*/
770 	u_int8_t	wscale;		/* window scaling factor	*/
771 	u_int8_t	pad[6];
772 } __packed;
773 
774 struct pfsync_state_key {
775 	struct pf_addr	 addr[2];
776 	u_int16_t	 port[2];
777 };
778 
779 struct pfsync_state {
780 	u_int64_t	 id;
781 	char		 ifname[IFNAMSIZ];
782 	struct pfsync_state_key	key[2];
783 	struct pfsync_state_peer src;
784 	struct pfsync_state_peer dst;
785 	struct pf_addr	 rt_addr;
786 	u_int32_t	 rule;
787 	u_int32_t	 anchor;
788 	u_int32_t	 nat_rule;
789 	u_int32_t	 creation;
790 	u_int32_t	 expire;
791 	u_int32_t	 packets[2][2];
792 	u_int32_t	 bytes[2][2];
793 	u_int32_t	 creatorid;
794 	sa_family_t	 af;
795 	u_int8_t	 proto;
796 	u_int8_t	 direction;
797 	u_int8_t	 __spare[2];
798 	u_int8_t	 log;
799 	u_int8_t	 state_flags;
800 	u_int8_t	 timeout;
801 	u_int8_t	 sync_flags;
802 	u_int8_t	 updates;
803 } __packed;
804 
805 #ifdef _KERNEL
806 /* pfsync */
807 typedef int		pfsync_state_import_t(struct pfsync_state *, u_int8_t);
808 typedef	void		pfsync_insert_state_t(struct pf_state *);
809 typedef	void		pfsync_update_state_t(struct pf_state *);
810 typedef	void		pfsync_delete_state_t(struct pf_state *);
811 typedef void		pfsync_clear_states_t(u_int32_t, const char *);
812 typedef int		pfsync_defer_t(struct pf_state *, struct mbuf *);
813 
814 extern pfsync_state_import_t	*pfsync_state_import_ptr;
815 extern pfsync_insert_state_t	*pfsync_insert_state_ptr;
816 extern pfsync_update_state_t	*pfsync_update_state_ptr;
817 extern pfsync_delete_state_t	*pfsync_delete_state_ptr;
818 extern pfsync_clear_states_t	*pfsync_clear_states_ptr;
819 extern pfsync_defer_t		*pfsync_defer_ptr;
820 
821 void			pfsync_state_export(struct pfsync_state *,
822 			    struct pf_state *);
823 
824 /* pflog */
825 struct pf_ruleset;
826 struct pf_pdesc;
827 typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
828     u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
829     struct pf_ruleset *, struct pf_pdesc *, int);
830 extern pflog_packet_t		*pflog_packet_ptr;
831 
832 #define	V_pf_end_threads	VNET(pf_end_threads)
833 #endif /* _KERNEL */
834 
835 #define	PFSYNC_FLAG_SRCNODE	0x04
836 #define	PFSYNC_FLAG_NATSRCNODE	0x08
837 
838 /* for copies to/from network byte order */
839 /* ioctl interface also uses network byte order */
840 #define pf_state_peer_hton(s,d) do {		\
841 	(d)->seqlo = htonl((s)->seqlo);		\
842 	(d)->seqhi = htonl((s)->seqhi);		\
843 	(d)->seqdiff = htonl((s)->seqdiff);	\
844 	(d)->max_win = htons((s)->max_win);	\
845 	(d)->mss = htons((s)->mss);		\
846 	(d)->state = (s)->state;		\
847 	(d)->wscale = (s)->wscale;		\
848 	if ((s)->scrub) {						\
849 		(d)->scrub.pfss_flags = 				\
850 		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
851 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
852 		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
853 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
854 	}								\
855 } while (0)
856 
857 #define pf_state_peer_ntoh(s,d) do {		\
858 	(d)->seqlo = ntohl((s)->seqlo);		\
859 	(d)->seqhi = ntohl((s)->seqhi);		\
860 	(d)->seqdiff = ntohl((s)->seqdiff);	\
861 	(d)->max_win = ntohs((s)->max_win);	\
862 	(d)->mss = ntohs((s)->mss);		\
863 	(d)->state = (s)->state;		\
864 	(d)->wscale = (s)->wscale;		\
865 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
866 	    (d)->scrub != NULL) {					\
867 		(d)->scrub->pfss_flags =				\
868 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
869 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
870 		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
871 	}								\
872 } while (0)
873 
874 #define pf_state_counter_hton(s,d) do {				\
875 	d[0] = htonl((s>>32)&0xffffffff);			\
876 	d[1] = htonl(s&0xffffffff);				\
877 } while (0)
878 
879 #define pf_state_counter_from_pfsync(s)				\
880 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
881 
882 #define pf_state_counter_ntoh(s,d) do {				\
883 	d = ntohl(s[0]);					\
884 	d = d<<32;						\
885 	d += ntohl(s[1]);					\
886 } while (0)
887 
888 TAILQ_HEAD(pf_rulequeue, pf_rule);
889 
890 struct pf_anchor;
891 
892 struct pf_ruleset {
893 	struct {
894 		struct pf_rulequeue	 queues[2];
895 		struct {
896 			struct pf_rulequeue	*ptr;
897 			struct pf_rule		**ptr_array;
898 			u_int32_t		 rcount;
899 			u_int32_t		 ticket;
900 			int			 open;
901 		}			 active, inactive;
902 	}			 rules[PF_RULESET_MAX];
903 	struct pf_anchor	*anchor;
904 	u_int32_t		 tticket;
905 	int			 tables;
906 	int			 topen;
907 };
908 
909 RB_HEAD(pf_anchor_global, pf_anchor);
910 RB_HEAD(pf_anchor_node, pf_anchor);
911 struct pf_anchor {
912 	RB_ENTRY(pf_anchor)	 entry_global;
913 	RB_ENTRY(pf_anchor)	 entry_node;
914 	struct pf_anchor	*parent;
915 	struct pf_anchor_node	 children;
916 	char			 name[PF_ANCHOR_NAME_SIZE];
917 	char			 path[MAXPATHLEN];
918 	struct pf_ruleset	 ruleset;
919 	int			 refcnt;	/* anchor rules */
920 	int			 match;	/* XXX: used for pfctl black magic */
921 };
922 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
923 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
924 
925 #define PF_RESERVED_ANCHOR	"_pf"
926 
927 #define PFR_TFLAG_PERSIST	0x00000001
928 #define PFR_TFLAG_CONST		0x00000002
929 #define PFR_TFLAG_ACTIVE	0x00000004
930 #define PFR_TFLAG_INACTIVE	0x00000008
931 #define PFR_TFLAG_REFERENCED	0x00000010
932 #define PFR_TFLAG_REFDANCHOR	0x00000020
933 #define PFR_TFLAG_COUNTERS	0x00000040
934 /* Adjust masks below when adding flags. */
935 #define PFR_TFLAG_USRMASK	(PFR_TFLAG_PERSIST	| \
936 				 PFR_TFLAG_CONST	| \
937 				 PFR_TFLAG_COUNTERS)
938 #define PFR_TFLAG_SETMASK	(PFR_TFLAG_ACTIVE	| \
939 				 PFR_TFLAG_INACTIVE	| \
940 				 PFR_TFLAG_REFERENCED	| \
941 				 PFR_TFLAG_REFDANCHOR)
942 #define PFR_TFLAG_ALLMASK	(PFR_TFLAG_PERSIST	| \
943 				 PFR_TFLAG_CONST	| \
944 				 PFR_TFLAG_ACTIVE	| \
945 				 PFR_TFLAG_INACTIVE	| \
946 				 PFR_TFLAG_REFERENCED	| \
947 				 PFR_TFLAG_REFDANCHOR	| \
948 				 PFR_TFLAG_COUNTERS)
949 
950 struct pf_anchor_stackframe;
951 
952 struct pfr_table {
953 	char			 pfrt_anchor[MAXPATHLEN];
954 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
955 	u_int32_t		 pfrt_flags;
956 	u_int8_t		 pfrt_fback;
957 };
958 
959 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
960 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
961 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
962 
963 struct pfr_addr {
964 	union {
965 		struct in_addr	 _pfra_ip4addr;
966 		struct in6_addr	 _pfra_ip6addr;
967 	}		 pfra_u;
968 	u_int8_t	 pfra_af;
969 	u_int8_t	 pfra_net;
970 	u_int8_t	 pfra_not;
971 	u_int8_t	 pfra_fback;
972 };
973 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
974 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
975 
976 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
977 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
978 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
979 
980 struct pfr_astats {
981 	struct pfr_addr	 pfras_a;
982 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
983 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
984 	long		 pfras_tzero;
985 };
986 
987 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
988 
989 struct pfr_tstats {
990 	struct pfr_table pfrts_t;
991 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
992 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
993 	u_int64_t	 pfrts_match;
994 	u_int64_t	 pfrts_nomatch;
995 	long		 pfrts_tzero;
996 	int		 pfrts_cnt;
997 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
998 };
999 #define	pfrts_name	pfrts_t.pfrt_name
1000 #define pfrts_flags	pfrts_t.pfrt_flags
1001 
1002 #ifndef _SOCKADDR_UNION_DEFINED
1003 #define	_SOCKADDR_UNION_DEFINED
1004 union sockaddr_union {
1005 	struct sockaddr		sa;
1006 	struct sockaddr_in	sin;
1007 	struct sockaddr_in6	sin6;
1008 };
1009 #endif /* _SOCKADDR_UNION_DEFINED */
1010 
1011 struct pfr_kcounters {
1012 	u_int64_t		 pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1013 	u_int64_t		 pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1014 };
1015 
1016 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1017 struct pfr_kentry {
1018 	struct radix_node	 pfrke_node[2];
1019 	union sockaddr_union	 pfrke_sa;
1020 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1021 	struct pfr_kcounters	*pfrke_counters;
1022 	long			 pfrke_tzero;
1023 	u_int8_t		 pfrke_af;
1024 	u_int8_t		 pfrke_net;
1025 	u_int8_t		 pfrke_not;
1026 	u_int8_t		 pfrke_mark;
1027 };
1028 
1029 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1030 RB_HEAD(pfr_ktablehead, pfr_ktable);
1031 struct pfr_ktable {
1032 	struct pfr_tstats	 pfrkt_ts;
1033 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1034 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1035 	struct radix_node_head	*pfrkt_ip4;
1036 	struct radix_node_head	*pfrkt_ip6;
1037 	struct pfr_ktable	*pfrkt_shadow;
1038 	struct pfr_ktable	*pfrkt_root;
1039 	struct pf_ruleset	*pfrkt_rs;
1040 	long			 pfrkt_larg;
1041 	int			 pfrkt_nflags;
1042 };
1043 #define pfrkt_t		pfrkt_ts.pfrts_t
1044 #define pfrkt_name	pfrkt_t.pfrt_name
1045 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
1046 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1047 #define pfrkt_flags	pfrkt_t.pfrt_flags
1048 #define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1049 #define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1050 #define pfrkt_packets	pfrkt_ts.pfrts_packets
1051 #define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1052 #define pfrkt_match	pfrkt_ts.pfrts_match
1053 #define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1054 #define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1055 
1056 /* keep synced with pfi_kif, used in RB_FIND */
1057 struct pfi_kif_cmp {
1058 	char				 pfik_name[IFNAMSIZ];
1059 };
1060 
1061 struct pfi_kif {
1062 	char				 pfik_name[IFNAMSIZ];
1063 	union {
1064 		RB_ENTRY(pfi_kif)	 _pfik_tree;
1065 		LIST_ENTRY(pfi_kif)	 _pfik_list;
1066 	} _pfik_glue;
1067 #define	pfik_tree	_pfik_glue._pfik_tree
1068 #define	pfik_list	_pfik_glue._pfik_list
1069 	u_int64_t			 pfik_packets[2][2][2];
1070 	u_int64_t			 pfik_bytes[2][2][2];
1071 	u_int32_t			 pfik_tzero;
1072 	u_int				 pfik_flags;
1073 	struct ifnet			*pfik_ifp;
1074 	struct ifg_group		*pfik_group;
1075 	u_int				 pfik_rulerefs;
1076 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1077 };
1078 
1079 #define	PFI_IFLAG_REFS		0x0001	/* has state references */
1080 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1081 
1082 struct pf_pdesc {
1083 	struct {
1084 		int	 done;
1085 		uid_t	 uid;
1086 		gid_t	 gid;
1087 	}		 lookup;
1088 	u_int64_t	 tot_len;	/* Make Mickey money */
1089 	union {
1090 		struct tcphdr		*tcp;
1091 		struct udphdr		*udp;
1092 		struct icmp		*icmp;
1093 #ifdef INET6
1094 		struct icmp6_hdr	*icmp6;
1095 #endif /* INET6 */
1096 		void			*any;
1097 	} hdr;
1098 
1099 	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1100 	struct pf_addr	*src;		/* src address */
1101 	struct pf_addr	*dst;		/* dst address */
1102 	u_int16_t *sport;
1103 	u_int16_t *dport;
1104 	struct pf_mtag	*pf_mtag;
1105 
1106 	u_int32_t	 p_len;		/* total length of payload */
1107 
1108 	u_int16_t	*ip_sum;
1109 	u_int16_t	*proto_sum;
1110 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1111 					 * state code. Easier than tags */
1112 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1113 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1114 	sa_family_t	 af;
1115 	u_int8_t	 proto;
1116 	u_int8_t	 tos;
1117 	u_int8_t	 dir;		/* direction */
1118 	u_int8_t	 sidx;		/* key index for source */
1119 	u_int8_t	 didx;		/* key index for destination */
1120 };
1121 
1122 /* flags for RDR options */
1123 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1124 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1125 
1126 /* UDP state enumeration */
1127 #define PFUDPS_NO_TRAFFIC	0
1128 #define PFUDPS_SINGLE		1
1129 #define PFUDPS_MULTIPLE		2
1130 
1131 #define PFUDPS_NSTATES		3	/* number of state levels */
1132 
1133 #define PFUDPS_NAMES { \
1134 	"NO_TRAFFIC", \
1135 	"SINGLE", \
1136 	"MULTIPLE", \
1137 	NULL \
1138 }
1139 
1140 /* Other protocol state enumeration */
1141 #define PFOTHERS_NO_TRAFFIC	0
1142 #define PFOTHERS_SINGLE		1
1143 #define PFOTHERS_MULTIPLE	2
1144 
1145 #define PFOTHERS_NSTATES	3	/* number of state levels */
1146 
1147 #define PFOTHERS_NAMES { \
1148 	"NO_TRAFFIC", \
1149 	"SINGLE", \
1150 	"MULTIPLE", \
1151 	NULL \
1152 }
1153 
1154 #define ACTION_SET(a, x) \
1155 	do { \
1156 		if ((a) != NULL) \
1157 			*(a) = (x); \
1158 	} while (0)
1159 
1160 #define REASON_SET(a, x) \
1161 	do { \
1162 		if ((a) != NULL) \
1163 			*(a) = (x); \
1164 		if (x < PFRES_MAX) \
1165 			counter_u64_add(V_pf_status.counters[x], 1); \
1166 	} while (0)
1167 
1168 struct pf_kstatus {
1169 	counter_u64_t	counters[PFRES_MAX]; /* reason for passing/dropping */
1170 	counter_u64_t	lcounters[LCNT_MAX]; /* limit counters */
1171 	counter_u64_t	fcounters[FCNT_MAX]; /* state operation counters */
1172 	counter_u64_t	scounters[SCNT_MAX]; /* src_node operation counters */
1173 	uint32_t	states;
1174 	uint32_t	src_nodes;
1175 	uint32_t	running;
1176 	uint32_t	since;
1177 	uint32_t	debug;
1178 	uint32_t	hostid;
1179 	char		ifname[IFNAMSIZ];
1180 	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
1181 };
1182 
1183 struct pf_divert {
1184 	union {
1185 		struct in_addr	ipv4;
1186 		struct in6_addr	ipv6;
1187 	}		addr;
1188 	u_int16_t	port;
1189 };
1190 
1191 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1192 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1193 
1194 /*
1195  * ioctl parameter structures
1196  */
1197 
1198 struct pfioc_pooladdr {
1199 	u_int32_t		 action;
1200 	u_int32_t		 ticket;
1201 	u_int32_t		 nr;
1202 	u_int32_t		 r_num;
1203 	u_int8_t		 r_action;
1204 	u_int8_t		 r_last;
1205 	u_int8_t		 af;
1206 	char			 anchor[MAXPATHLEN];
1207 	struct pf_pooladdr	 addr;
1208 };
1209 
1210 struct pfioc_rule {
1211 	u_int32_t	 action;
1212 	u_int32_t	 ticket;
1213 	u_int32_t	 pool_ticket;
1214 	u_int32_t	 nr;
1215 	char		 anchor[MAXPATHLEN];
1216 	char		 anchor_call[MAXPATHLEN];
1217 	struct pf_rule	 rule;
1218 };
1219 
1220 struct pfioc_natlook {
1221 	struct pf_addr	 saddr;
1222 	struct pf_addr	 daddr;
1223 	struct pf_addr	 rsaddr;
1224 	struct pf_addr	 rdaddr;
1225 	u_int16_t	 sport;
1226 	u_int16_t	 dport;
1227 	u_int16_t	 rsport;
1228 	u_int16_t	 rdport;
1229 	sa_family_t	 af;
1230 	u_int8_t	 proto;
1231 	u_int8_t	 direction;
1232 };
1233 
1234 struct pfioc_state {
1235 	struct pfsync_state	state;
1236 };
1237 
1238 struct pfioc_src_node_kill {
1239 	sa_family_t psnk_af;
1240 	struct pf_rule_addr psnk_src;
1241 	struct pf_rule_addr psnk_dst;
1242 	u_int		    psnk_killed;
1243 };
1244 
1245 struct pfioc_state_kill {
1246 	struct pf_state_cmp	psk_pfcmp;
1247 	sa_family_t		psk_af;
1248 	int			psk_proto;
1249 	struct pf_rule_addr	psk_src;
1250 	struct pf_rule_addr	psk_dst;
1251 	char			psk_ifname[IFNAMSIZ];
1252 	char			psk_label[PF_RULE_LABEL_SIZE];
1253 	u_int			psk_killed;
1254 };
1255 
1256 struct pfioc_states {
1257 	int	ps_len;
1258 	union {
1259 		caddr_t			 psu_buf;
1260 		struct pfsync_state	*psu_states;
1261 	} ps_u;
1262 #define ps_buf		ps_u.psu_buf
1263 #define ps_states	ps_u.psu_states
1264 };
1265 
1266 struct pfioc_src_nodes {
1267 	int	psn_len;
1268 	union {
1269 		caddr_t		 psu_buf;
1270 		struct pf_src_node	*psu_src_nodes;
1271 	} psn_u;
1272 #define psn_buf		psn_u.psu_buf
1273 #define psn_src_nodes	psn_u.psu_src_nodes
1274 };
1275 
1276 struct pfioc_if {
1277 	char		 ifname[IFNAMSIZ];
1278 };
1279 
1280 struct pfioc_tm {
1281 	int		 timeout;
1282 	int		 seconds;
1283 };
1284 
1285 struct pfioc_limit {
1286 	int		 index;
1287 	unsigned	 limit;
1288 };
1289 
1290 struct pfioc_altq {
1291 	u_int32_t	 action;
1292 	u_int32_t	 ticket;
1293 	u_int32_t	 nr;
1294 	struct pf_altq	 altq;
1295 };
1296 
1297 struct pfioc_qstats {
1298 	u_int32_t	 ticket;
1299 	u_int32_t	 nr;
1300 	void		*buf;
1301 	int		 nbytes;
1302 	u_int8_t	 scheduler;
1303 };
1304 
1305 struct pfioc_ruleset {
1306 	u_int32_t	 nr;
1307 	char		 path[MAXPATHLEN];
1308 	char		 name[PF_ANCHOR_NAME_SIZE];
1309 };
1310 
1311 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1312 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1313 struct pfioc_trans {
1314 	int		 size;	/* number of elements */
1315 	int		 esize; /* size of each element in bytes */
1316 	struct pfioc_trans_e {
1317 		int		rs_num;
1318 		char		anchor[MAXPATHLEN];
1319 		u_int32_t	ticket;
1320 	}		*array;
1321 };
1322 
1323 #define PFR_FLAG_ATOMIC		0x00000001	/* unused */
1324 #define PFR_FLAG_DUMMY		0x00000002
1325 #define PFR_FLAG_FEEDBACK	0x00000004
1326 #define PFR_FLAG_CLSTATS	0x00000008
1327 #define PFR_FLAG_ADDRSTOO	0x00000010
1328 #define PFR_FLAG_REPLACE	0x00000020
1329 #define PFR_FLAG_ALLRSETS	0x00000040
1330 #define PFR_FLAG_ALLMASK	0x0000007F
1331 #ifdef _KERNEL
1332 #define PFR_FLAG_USERIOCTL	0x10000000
1333 #endif
1334 
1335 struct pfioc_table {
1336 	struct pfr_table	 pfrio_table;
1337 	void			*pfrio_buffer;
1338 	int			 pfrio_esize;
1339 	int			 pfrio_size;
1340 	int			 pfrio_size2;
1341 	int			 pfrio_nadd;
1342 	int			 pfrio_ndel;
1343 	int			 pfrio_nchange;
1344 	int			 pfrio_flags;
1345 	u_int32_t		 pfrio_ticket;
1346 };
1347 #define	pfrio_exists	pfrio_nadd
1348 #define	pfrio_nzero	pfrio_nadd
1349 #define	pfrio_nmatch	pfrio_nadd
1350 #define pfrio_naddr	pfrio_size2
1351 #define pfrio_setflag	pfrio_size2
1352 #define pfrio_clrflag	pfrio_nadd
1353 
1354 struct pfioc_iface {
1355 	char	 pfiio_name[IFNAMSIZ];
1356 	void	*pfiio_buffer;
1357 	int	 pfiio_esize;
1358 	int	 pfiio_size;
1359 	int	 pfiio_nzero;
1360 	int	 pfiio_flags;
1361 };
1362 
1363 
1364 /*
1365  * ioctl operations
1366  */
1367 
1368 #define DIOCSTART	_IO  ('D',  1)
1369 #define DIOCSTOP	_IO  ('D',  2)
1370 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1371 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1372 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1373 /* XXX cut 8 - 17 */
1374 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1375 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1376 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1377 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1378 #define DIOCCLRSTATUS	_IO  ('D', 22)
1379 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1380 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1381 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1382 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1383 /* XXX cut 26 - 28 */
1384 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1385 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1386 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1387 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1388 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1389 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1390 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1391 #define DIOCSTARTALTQ	_IO  ('D', 42)
1392 #define DIOCSTOPALTQ	_IO  ('D', 43)
1393 #define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1394 #define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1395 #define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1396 #define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1397 #define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1398 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1399 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1400 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1401 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1402 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1403 /* XXX cut 55 - 57 */
1404 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1405 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1406 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1407 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1408 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1409 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1410 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1411 #define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
1412 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1413 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1414 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1415 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1416 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1417 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1418 #define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
1419 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1420 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1421 #define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1422 #define	DIOCOSFPFLUSH	_IO('D', 78)
1423 #define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1424 #define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1425 #define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
1426 #define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
1427 #define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
1428 #define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1429 #define	DIOCCLRSRCNODES	_IO('D', 85)
1430 #define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1431 #define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1432 #define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1433 #define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1434 #define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1435 struct pf_ifspeed {
1436 	char			ifname[IFNAMSIZ];
1437 	u_int32_t		baudrate;
1438 };
1439 #define	DIOCGIFSPEED	_IOWR('D', 92, struct pf_ifspeed)
1440 
1441 #ifdef _KERNEL
1442 LIST_HEAD(pf_src_node_list, pf_src_node);
1443 struct pf_srchash {
1444 	struct pf_src_node_list		nodes;
1445 	struct mtx			lock;
1446 };
1447 
1448 struct pf_keyhash {
1449 	LIST_HEAD(, pf_state_key)	keys;
1450 	struct mtx			lock;
1451 };
1452 
1453 struct pf_idhash {
1454 	LIST_HEAD(, pf_state)		states;
1455 	struct mtx			lock;
1456 };
1457 
1458 extern u_long		pf_hashmask;
1459 extern u_long		pf_srchashmask;
1460 #define	PF_HASHSIZ	(32768)
1461 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1462 VNET_DECLARE(struct pf_idhash *, pf_idhash);
1463 #define V_pf_keyhash	VNET(pf_keyhash)
1464 #define	V_pf_idhash	VNET(pf_idhash)
1465 VNET_DECLARE(struct pf_srchash *, pf_srchash);
1466 #define	V_pf_srchash	VNET(pf_srchash)
1467 
1468 #define PF_IDHASH(s)	(be64toh((s)->id) % (pf_hashmask + 1))
1469 
1470 VNET_DECLARE(void *, pf_swi_cookie);
1471 #define V_pf_swi_cookie	VNET(pf_swi_cookie)
1472 
1473 VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1474 #define	V_pf_stateid	VNET(pf_stateid)
1475 
1476 TAILQ_HEAD(pf_altqqueue, pf_altq);
1477 VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[2]);
1478 #define	V_pf_altqs			 VNET(pf_altqs)
1479 VNET_DECLARE(struct pf_palist,		 pf_pabuf);
1480 #define	V_pf_pabuf			 VNET(pf_pabuf)
1481 
1482 VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
1483 #define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
1484 VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
1485 #define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
1486 VNET_DECLARE(int,			 altqs_inactive_open);
1487 #define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
1488 VNET_DECLARE(u_int32_t,			 ticket_pabuf);
1489 #define	V_ticket_pabuf			 VNET(ticket_pabuf)
1490 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
1491 #define	V_pf_altqs_active		 VNET(pf_altqs_active)
1492 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
1493 #define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
1494 
1495 VNET_DECLARE(struct pf_rulequeue, pf_unlinked_rules);
1496 #define	V_pf_unlinked_rules	VNET(pf_unlinked_rules)
1497 
1498 void				 pf_initialize(void);
1499 void				 pf_mtag_initialize(void);
1500 void				 pf_mtag_cleanup(void);
1501 void				 pf_cleanup(void);
1502 
1503 struct pf_mtag			*pf_get_mtag(struct mbuf *);
1504 
1505 extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1506 #ifdef ALTQ
1507 extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
1508 #endif
1509 VNET_DECLARE(uma_zone_t,	 pf_state_z);
1510 #define	V_pf_state_z		 VNET(pf_state_z)
1511 VNET_DECLARE(uma_zone_t,	 pf_state_key_z);
1512 #define	V_pf_state_key_z	 VNET(pf_state_key_z)
1513 VNET_DECLARE(uma_zone_t,	 pf_state_scrub_z);
1514 #define	V_pf_state_scrub_z	 VNET(pf_state_scrub_z)
1515 
1516 extern void			 pf_purge_thread(void *);
1517 extern void			 pf_intr(void *);
1518 extern void			 pf_purge_expired_src_nodes(void);
1519 
1520 extern int			 pf_unlink_state(struct pf_state *, u_int);
1521 #define	PF_ENTER_LOCKED		0x00000001
1522 #define	PF_RETURN_LOCKED	0x00000002
1523 extern int			 pf_state_insert(struct pfi_kif *,
1524 				    struct pf_state_key *,
1525 				    struct pf_state_key *,
1526 				    struct pf_state *);
1527 extern void			 pf_free_state(struct pf_state *);
1528 
1529 static __inline void
1530 pf_ref_state(struct pf_state *s)
1531 {
1532 
1533 	refcount_acquire(&s->refs);
1534 }
1535 
1536 static __inline int
1537 pf_release_state(struct pf_state *s)
1538 {
1539 
1540 	if (refcount_release(&s->refs)) {
1541 		pf_free_state(s);
1542 		return (1);
1543 	} else
1544 		return (0);
1545 }
1546 
1547 extern struct pf_state		*pf_find_state_byid(uint64_t, uint32_t);
1548 extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1549 				    u_int, int *);
1550 extern struct pf_src_node	*pf_find_src_node(struct pf_addr *,
1551 				    struct pf_rule *, sa_family_t, int);
1552 extern void			 pf_unlink_src_node(struct pf_src_node *);
1553 extern u_int			 pf_free_src_nodes(struct pf_src_node_list *);
1554 extern void			 pf_print_state(struct pf_state *);
1555 extern void			 pf_print_flags(u_int8_t);
1556 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1557 				    u_int8_t);
1558 extern u_int16_t		 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1559 				    u_int16_t, u_int16_t, u_int8_t);
1560 
1561 VNET_DECLARE(struct ifnet *,		 sync_ifp);
1562 #define	V_sync_ifp		 	 VNET(sync_ifp);
1563 VNET_DECLARE(struct pf_rule,		 pf_default_rule);
1564 #define	V_pf_default_rule		  VNET(pf_default_rule)
1565 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1566 				    u_int8_t);
1567 void				pf_free_rule(struct pf_rule *);
1568 
1569 #ifdef INET
1570 int	pf_test(int, struct ifnet *, struct mbuf **, struct inpcb *);
1571 int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1572 	    struct pf_pdesc *);
1573 #endif /* INET */
1574 
1575 #ifdef INET6
1576 int	pf_test6(int, struct ifnet *, struct mbuf **, struct inpcb *);
1577 int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1578 	    struct pf_pdesc *);
1579 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1580 	    struct pf_addr *, struct pf_addr *, u_int8_t);
1581 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1582 int	pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *);
1583 #endif /* INET6 */
1584 
1585 u_int32_t	pf_new_isn(struct pf_state *);
1586 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1587 	    sa_family_t);
1588 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1589 void	pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1590 	    u_int8_t);
1591 void	pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1592 void	pf_send_deferred_syn(struct pf_state *);
1593 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1594 	    struct pf_addr *, sa_family_t);
1595 int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1596 	    struct pf_addr *, sa_family_t);
1597 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1598 
1599 void	pf_normalize_init(void);
1600 void	pf_normalize_cleanup(void);
1601 int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1602 	    struct pf_pdesc *);
1603 void	pf_normalize_tcp_cleanup(struct pf_state *);
1604 int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1605 	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1606 int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1607 	    u_short *, struct tcphdr *, struct pf_state *,
1608 	    struct pf_state_peer *, struct pf_state_peer *, int *);
1609 u_int32_t
1610 	pf_state_expires(const struct pf_state *);
1611 void	pf_purge_expired_fragments(void);
1612 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1613 	    int);
1614 int	pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1615 struct pf_state_key *pf_alloc_state_key(int);
1616 void	pfr_initialize(void);
1617 void	pfr_cleanup(void);
1618 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1619 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1620 	    u_int64_t, int, int, int);
1621 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1622 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1623 struct pfr_ktable *
1624 	pfr_attach_table(struct pf_ruleset *, char *);
1625 void	pfr_detach_table(struct pfr_ktable *);
1626 int	pfr_clr_tables(struct pfr_table *, int *, int);
1627 int	pfr_add_tables(struct pfr_table *, int, int *, int);
1628 int	pfr_del_tables(struct pfr_table *, int, int *, int);
1629 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1630 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1631 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1632 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1633 int	pfr_clr_addrs(struct pfr_table *, int *, int);
1634 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1635 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1636 	    int);
1637 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1638 	    int);
1639 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1640 	    int *, int *, int *, int, u_int32_t);
1641 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1642 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1643 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1644 	    int);
1645 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1646 	    int);
1647 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1648 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1649 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1650 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1651 	    int *, u_int32_t, int);
1652 
1653 MALLOC_DECLARE(PFI_MTYPE);
1654 VNET_DECLARE(struct pfi_kif *,		 pfi_all);
1655 #define	V_pfi_all	 		 VNET(pfi_all)
1656 
1657 void		 pfi_initialize(void);
1658 void		 pfi_cleanup(void);
1659 void		 pfi_kif_ref(struct pfi_kif *);
1660 void		 pfi_kif_unref(struct pfi_kif *);
1661 struct pfi_kif	*pfi_kif_find(const char *);
1662 struct pfi_kif	*pfi_kif_attach(struct pfi_kif *, const char *);
1663 int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1664 void		 pfi_kif_purge(void);
1665 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1666 		    sa_family_t);
1667 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1668 void		 pfi_dynaddr_remove(struct pfi_dynaddr *);
1669 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1670 void		 pfi_update_status(const char *, struct pf_status *);
1671 void		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1672 int		 pfi_set_flags(const char *, int);
1673 int		 pfi_clear_flags(const char *, int);
1674 
1675 int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *, int);
1676 int		 pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1677 int		 pf_addr_cmp(struct pf_addr *, struct pf_addr *,
1678 		    sa_family_t);
1679 void		 pf_qid2qname(u_int32_t, char *);
1680 
1681 VNET_DECLARE(struct pf_kstatus, pf_status);
1682 #define	V_pf_status	VNET(pf_status)
1683 
1684 struct pf_limit {
1685 	uma_zone_t	zone;
1686 	u_int		limit;
1687 };
1688 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1689 #define	V_pf_limits VNET(pf_limits)
1690 
1691 #endif /* _KERNEL */
1692 
1693 #ifdef _KERNEL
1694 VNET_DECLARE(struct pf_anchor_global,		 pf_anchors);
1695 #define	V_pf_anchors				 VNET(pf_anchors)
1696 VNET_DECLARE(struct pf_anchor,			 pf_main_anchor);
1697 #define	V_pf_main_anchor			 VNET(pf_main_anchor)
1698 #define pf_main_ruleset	V_pf_main_anchor.ruleset
1699 #endif
1700 
1701 /* these ruleset functions can be linked into userland programs (pfctl) */
1702 int			 pf_get_ruleset_number(u_int8_t);
1703 void			 pf_init_ruleset(struct pf_ruleset *);
1704 int			 pf_anchor_setup(struct pf_rule *,
1705 			    const struct pf_ruleset *, const char *);
1706 int			 pf_anchor_copyout(const struct pf_ruleset *,
1707 			    const struct pf_rule *, struct pfioc_rule *);
1708 void			 pf_anchor_remove(struct pf_rule *);
1709 void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1710 struct pf_ruleset	*pf_find_ruleset(const char *);
1711 struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1712 void			 pf_rs_initialize(void);
1713 
1714 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1715 int	pf_osfp_add(struct pf_osfp_ioctl *);
1716 #ifdef _KERNEL
1717 struct pf_osfp_enlist *
1718 	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1719 	    const struct tcphdr *);
1720 #endif /* _KERNEL */
1721 void	pf_osfp_flush(void);
1722 int	pf_osfp_get(struct pf_osfp_ioctl *);
1723 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1724 
1725 #ifdef _KERNEL
1726 void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1727 
1728 void			 pf_step_into_anchor(struct pf_anchor_stackframe *, int *,
1729 			    struct pf_ruleset **, int, struct pf_rule **,
1730 			    struct pf_rule **, int *);
1731 int			 pf_step_out_of_anchor(struct pf_anchor_stackframe *, int *,
1732 			    struct pf_ruleset **, int, struct pf_rule **,
1733 			    struct pf_rule **, int *);
1734 
1735 int			 pf_map_addr(u_int8_t, struct pf_rule *,
1736 			    struct pf_addr *, struct pf_addr *,
1737 			    struct pf_addr *, struct pf_src_node **);
1738 struct pf_rule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
1739 			    int, int, struct pfi_kif *, struct pf_src_node **,
1740 			    struct pf_state_key **, struct pf_state_key **,
1741 			    struct pf_addr *, struct pf_addr *,
1742 			    uint16_t, uint16_t, struct pf_anchor_stackframe *);
1743 
1744 struct pf_state_key	*pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1745 			    struct pf_addr *, u_int16_t, u_int16_t);
1746 struct pf_state_key	*pf_state_key_clone(struct pf_state_key *);
1747 #endif /* _KERNEL */
1748 
1749 #endif /* _NET_PFVAR_H_ */
1750