1 /*	$OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $ */
2 
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  */
32 
33 #ifndef _NET_PFVAR_H_
34 #define _NET_PFVAR_H_
35 
36 #include <sys/param.h>
37 #include <sys/types.h>
38 #include <sys/queue.h>
39 #include <sys/tree.h>
40 #ifdef __FreeBSD__
41 #include <sys/lock.h>
42 #include <sys/sx.h>
43 #else
44 #include <sys/rwlock.h>
45 #endif
46 
47 #include <net/radix.h>
48 #include <net/route.h>
49 #ifdef __FreeBSD__
50 #include <net/if_clone.h>
51 #include <net/pf_mtag.h>
52 #include <vm/uma.h>
53 #else
54 #include <netinet/ip_ipsp.h>
55 #endif
56 
57 #ifdef __FreeBSD__
58 #include <netinet/in.h>
59 #endif
60 
61 #include <netinet/tcp_fsm.h>
62 
63 struct ip;
64 struct ip6_hdr;
65 #ifdef __FreeBSD__
66 struct inpcb;
67 #endif
68 
69 #define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
70 #define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
71 
72 #define	PF_MD5_DIGEST_LENGTH	16
73 #ifdef MD5_DIGEST_LENGTH
74 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
75 #error
76 #endif
77 #endif
78 
79 enum	{ PF_INOUT, PF_IN, PF_OUT };
80 enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
81 	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, PF_DEFER };
82 enum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
83 	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
84 enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
85 	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
86 enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
87 enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
88 	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
89 	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
90 enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
91 enum	{ PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
92 
93 /*
94  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
95  * PFTM_MAX, special cases afterwards. See pf_state_expires().
96  */
97 enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
98 	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
99 	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
100 	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
101 	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
102 	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
103 	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
104 	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
105 	  PFTM_UNTIL_PACKET };
106 
107 /* PFTM default values */
108 #define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
109 #define PFTM_TCP_OPENING_VAL		30	/* No response yet */
110 #define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
111 #define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
112 #define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
113 #define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
114 #define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
115 #define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
116 #define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
117 #define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
118 #define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
119 #define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
120 #define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
121 #define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
122 #define PFTM_FRAG_VAL			30	/* Fragment expire */
123 #define PFTM_INTERVAL_VAL		10	/* Expire interval */
124 #define PFTM_SRC_NODE_VAL		0	/* Source tracking */
125 #define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
126 
127 enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
128 enum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
129 	  PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
130 #define PF_POOL_IDMASK		0x0f
131 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
132 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
133 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
134 	  PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED,
135 	  PF_ADDR_RANGE };
136 #define PF_POOL_TYPEMASK	0x0f
137 #define PF_POOL_STICKYADDR	0x20
138 #define	PF_WSCALE_FLAG		0x80
139 #define	PF_WSCALE_MASK		0x0f
140 
141 #define	PF_LOG			0x01
142 #define	PF_LOG_ALL		0x02
143 #define	PF_LOG_SOCKET_LOOKUP	0x04
144 
145 struct pf_addr {
146 	union {
147 		struct in_addr		v4;
148 		struct in6_addr		v6;
149 		u_int8_t		addr8[16];
150 		u_int16_t		addr16[8];
151 		u_int32_t		addr32[4];
152 	} pfa;		    /* 128-bit address */
153 #define v4	pfa.v4
154 #define v6	pfa.v6
155 #define addr8	pfa.addr8
156 #define addr16	pfa.addr16
157 #define addr32	pfa.addr32
158 };
159 
160 #define	PF_TABLE_NAME_SIZE	 32
161 
162 #define PFI_AFLAG_NETWORK	0x01
163 #define PFI_AFLAG_BROADCAST	0x02
164 #define PFI_AFLAG_PEER		0x04
165 #define PFI_AFLAG_MODEMASK	0x07
166 #define PFI_AFLAG_NOALIAS	0x08
167 
168 struct pf_addr_wrap {
169 	union {
170 		struct {
171 			struct pf_addr		 addr;
172 			struct pf_addr		 mask;
173 		}			 a;
174 		char			 ifname[IFNAMSIZ];
175 		char			 tblname[PF_TABLE_NAME_SIZE];
176 #ifdef __FreeBSD__
177 #define	RTLABEL_LEN	32
178 #endif
179 		char			 rtlabelname[RTLABEL_LEN];
180 		u_int32_t		 rtlabel;
181 	}			 v;
182 	union {
183 		struct pfi_dynaddr	*dyn;
184 		struct pfr_ktable	*tbl;
185 		int			 dyncnt;
186 		int			 tblcnt;
187 	}			 p;
188 	u_int8_t		 type;		/* PF_ADDR_* */
189 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
190 };
191 
192 #ifdef _KERNEL
193 
194 struct pfi_dynaddr {
195 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
196 	struct pf_addr			 pfid_addr4;
197 	struct pf_addr			 pfid_mask4;
198 	struct pf_addr			 pfid_addr6;
199 	struct pf_addr			 pfid_mask6;
200 	struct pfr_ktable		*pfid_kt;
201 	struct pfi_kif			*pfid_kif;
202 	void				*pfid_hook_cookie;
203 	int				 pfid_net;	/* mask or 128 */
204 	int				 pfid_acnt4;	/* address count IPv4 */
205 	int				 pfid_acnt6;	/* address count IPv6 */
206 	sa_family_t			 pfid_af;	/* rule af */
207 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
208 };
209 
210 /*
211  * Address manipulation macros
212  */
213 
214 #ifdef __FreeBSD__
215 #define	splsoftnet()	splnet()
216 
217 #define	HTONL(x)	(x) = htonl((__uint32_t)(x))
218 #define	HTONS(x)	(x) = htons((__uint16_t)(x))
219 #define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
220 #define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
221 
222 #define	PF_NAME		"pf"
223 
224 #define	PR_NOWAIT	M_NOWAIT
225 #define	PR_WAITOK	M_WAITOK
226 #define	PR_ZERO		M_ZERO
227 #define	pool_get(p, f)	uma_zalloc(*(p), (f))
228 #define	pool_put(p, o)	uma_zfree(*(p), (o))
229 
230 #define	UMA_CREATE(var, type, desc)			\
231 	var = uma_zcreate(desc, sizeof(type),		\
232 	NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);	\
233 	if (var == NULL)				\
234 		break
235 #define	UMA_DESTROY(var)				\
236 	if (var)					\
237 		uma_zdestroy(var)
238 
239 #ifdef __FreeBSD__
240 extern struct mtx pf_task_mtx;
241 
242 #define	PF_LOCK_ASSERT()	mtx_assert(&pf_task_mtx, MA_OWNED)
243 #define	PF_UNLOCK_ASSERT()	mtx_assert(&pf_task_mtx, MA_NOTOWNED)
244 #define	PF_LOCK()		mtx_lock(&pf_task_mtx)
245 #define	PF_UNLOCK()		mtx_unlock(&pf_task_mtx)
246 #else
247 #define	PF_LOCK_ASSERT()
248 #define	PF_UNLOCK_ASSERT()
249 #define	PF_LOCK()
250 #define	PF_UNLOCK()
251 #endif /* __FreeBSD__ */
252 
253 #define	PF_COPYIN(uaddr, kaddr, len, r)		do {	\
254 	PF_UNLOCK();					\
255 	r = copyin((uaddr), (kaddr), (len));		\
256 	PF_LOCK();					\
257 } while(0)
258 
259 #define	PF_COPYOUT(kaddr, uaddr, len, r)	do {	\
260 	PF_UNLOCK();					\
261 	r = copyout((kaddr), (uaddr), (len));		\
262 	PF_LOCK();					\
263 } while(0)
264 
265 #define	PF_MODVER	1
266 #define	PFLOG_MODVER	1
267 #define	PFSYNC_MODVER	1
268 
269 #define	PFLOG_MINVER	1
270 #define	PFLOG_PREFVER	PFLOG_MODVER
271 #define	PFLOG_MAXVER	1
272 #define	PFSYNC_MINVER	1
273 #define	PFSYNC_PREFVER	PFSYNC_MODVER
274 #define	PFSYNC_MAXVER	1
275 #endif /* __FreeBSD__ */
276 #ifdef INET
277 #ifndef INET6
278 #define	PF_INET_ONLY
279 #endif /* ! INET6 */
280 #endif /* INET */
281 
282 #ifdef INET6
283 #ifndef INET
284 #define	PF_INET6_ONLY
285 #endif /* ! INET */
286 #endif /* INET6 */
287 
288 #ifdef INET
289 #ifdef INET6
290 #define	PF_INET_INET6
291 #endif /* INET6 */
292 #endif /* INET */
293 
294 #else
295 
296 #define	PF_INET_INET6
297 
298 #endif /* _KERNEL */
299 
300 /* Both IPv4 and IPv6 */
301 #ifdef PF_INET_INET6
302 
303 #define PF_AEQ(a, b, c) \
304 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
305 	((a)->addr32[3] == (b)->addr32[3] && \
306 	(a)->addr32[2] == (b)->addr32[2] && \
307 	(a)->addr32[1] == (b)->addr32[1] && \
308 	(a)->addr32[0] == (b)->addr32[0])) \
309 
310 #define PF_ANEQ(a, b, c) \
311 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
312 	((a)->addr32[3] != (b)->addr32[3] || \
313 	(a)->addr32[2] != (b)->addr32[2] || \
314 	(a)->addr32[1] != (b)->addr32[1] || \
315 	(a)->addr32[0] != (b)->addr32[0])) \
316 
317 #define PF_AZERO(a, c) \
318 	((c == AF_INET && !(a)->addr32[0]) || \
319 	(!(a)->addr32[0] && !(a)->addr32[1] && \
320 	!(a)->addr32[2] && !(a)->addr32[3] )) \
321 
322 #define PF_MATCHA(n, a, m, b, f) \
323 	pf_match_addr(n, a, m, b, f)
324 
325 #define PF_ACPY(a, b, f) \
326 	pf_addrcpy(a, b, f)
327 
328 #define PF_AINC(a, f) \
329 	pf_addr_inc(a, f)
330 
331 #define PF_POOLMASK(a, b, c, d, f) \
332 	pf_poolmask(a, b, c, d, f)
333 
334 #else
335 
336 /* Just IPv6 */
337 
338 #ifdef PF_INET6_ONLY
339 
340 #define PF_AEQ(a, b, c) \
341 	((a)->addr32[3] == (b)->addr32[3] && \
342 	(a)->addr32[2] == (b)->addr32[2] && \
343 	(a)->addr32[1] == (b)->addr32[1] && \
344 	(a)->addr32[0] == (b)->addr32[0]) \
345 
346 #define PF_ANEQ(a, b, c) \
347 	((a)->addr32[3] != (b)->addr32[3] || \
348 	(a)->addr32[2] != (b)->addr32[2] || \
349 	(a)->addr32[1] != (b)->addr32[1] || \
350 	(a)->addr32[0] != (b)->addr32[0]) \
351 
352 #define PF_AZERO(a, c) \
353 	(!(a)->addr32[0] && \
354 	!(a)->addr32[1] && \
355 	!(a)->addr32[2] && \
356 	!(a)->addr32[3] ) \
357 
358 #define PF_MATCHA(n, a, m, b, f) \
359 	pf_match_addr(n, a, m, b, f)
360 
361 #define PF_ACPY(a, b, f) \
362 	pf_addrcpy(a, b, f)
363 
364 #define PF_AINC(a, f) \
365 	pf_addr_inc(a, f)
366 
367 #define PF_POOLMASK(a, b, c, d, f) \
368 	pf_poolmask(a, b, c, d, f)
369 
370 #else
371 
372 /* Just IPv4 */
373 #ifdef PF_INET_ONLY
374 
375 #define PF_AEQ(a, b, c) \
376 	((a)->addr32[0] == (b)->addr32[0])
377 
378 #define PF_ANEQ(a, b, c) \
379 	((a)->addr32[0] != (b)->addr32[0])
380 
381 #define PF_AZERO(a, c) \
382 	(!(a)->addr32[0])
383 
384 #define PF_MATCHA(n, a, m, b, f) \
385 	pf_match_addr(n, a, m, b, f)
386 
387 #define PF_ACPY(a, b, f) \
388 	(a)->v4.s_addr = (b)->v4.s_addr
389 
390 #define PF_AINC(a, f) \
391 	do { \
392 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
393 	} while (0)
394 
395 #define PF_POOLMASK(a, b, c, d, f) \
396 	do { \
397 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
398 		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
399 	} while (0)
400 
401 #endif /* PF_INET_ONLY */
402 #endif /* PF_INET6_ONLY */
403 #endif /* PF_INET_INET6 */
404 
405 /*
406  * XXX callers not FIB-aware in our version of pf yet.
407  * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
408  */
409 #define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
410 	(								\
411 		(((aw)->type == PF_ADDR_NOROUTE &&			\
412 		    pf_routable((x), (af), NULL, (rtid))) ||		\
413 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
414 		    pf_routable((x), (af), (ifp), (rtid))) ||		\
415 		((aw)->type == PF_ADDR_RTLABEL &&			\
416 		    !pf_rtlabel_match((x), (af), (aw), (rtid))) ||	\
417 		((aw)->type == PF_ADDR_TABLE &&				\
418 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
419 		((aw)->type == PF_ADDR_DYNIFTL &&			\
420 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
421 		((aw)->type == PF_ADDR_RANGE &&				\
422 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
423 		    &(aw)->v.a.mask, (x), (af))) ||			\
424 		((aw)->type == PF_ADDR_ADDRMASK &&			\
425 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
426 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
427 		    &(aw)->v.a.mask, (x), (af))))) !=			\
428 		(neg)							\
429 	)
430 
431 
432 struct pf_rule_uid {
433 	uid_t		 uid[2];
434 	u_int8_t	 op;
435 };
436 
437 struct pf_rule_gid {
438 	uid_t		 gid[2];
439 	u_int8_t	 op;
440 };
441 
442 struct pf_rule_addr {
443 	struct pf_addr_wrap	 addr;
444 	u_int16_t		 port[2];
445 	u_int8_t		 neg;
446 	u_int8_t		 port_op;
447 };
448 
449 struct pf_pooladdr {
450 	struct pf_addr_wrap		 addr;
451 	TAILQ_ENTRY(pf_pooladdr)	 entries;
452 	char				 ifname[IFNAMSIZ];
453 	struct pfi_kif			*kif;
454 };
455 
456 TAILQ_HEAD(pf_palist, pf_pooladdr);
457 
458 struct pf_poolhashkey {
459 	union {
460 		u_int8_t		key8[16];
461 		u_int16_t		key16[8];
462 		u_int32_t		key32[4];
463 	} pfk;		    /* 128-bit hash key */
464 #define key8	pfk.key8
465 #define key16	pfk.key16
466 #define key32	pfk.key32
467 };
468 
469 struct pf_pool {
470 	struct pf_palist	 list;
471 	struct pf_pooladdr	*cur;
472 	struct pf_poolhashkey	 key;
473 	struct pf_addr		 counter;
474 	int			 tblidx;
475 	u_int16_t		 proxy_port[2];
476 	u_int8_t		 port_op;
477 	u_int8_t		 opts;
478 };
479 
480 
481 /* A packed Operating System description for fingerprinting */
482 typedef u_int32_t pf_osfp_t;
483 #define PF_OSFP_ANY	((pf_osfp_t)0)
484 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
485 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
486 
487 struct pf_osfp_entry {
488 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
489 	pf_osfp_t		fp_os;
490 	int			fp_enflags;
491 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
492 #define PF_OSFP_GENERIC		0x002		/* generic signature */
493 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
494 #define PF_OSFP_LEN	32
495 	char			fp_class_nm[PF_OSFP_LEN];
496 	char			fp_version_nm[PF_OSFP_LEN];
497 	char			fp_subtype_nm[PF_OSFP_LEN];
498 };
499 #define PF_OSFP_ENTRY_EQ(a, b) \
500     ((a)->fp_os == (b)->fp_os && \
501     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
502     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
503     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
504 
505 /* handle pf_osfp_t packing */
506 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
507 #define _FP_UNUSED_BITS		1
508 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
509 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
510 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
511 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
512 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
513 	    ((1 << _FP_CLASS_BITS) - 1); \
514 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
515 	    ((1 << _FP_VERSION_BITS) - 1);\
516 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
517 } while(0)
518 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
519 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
520 	    + _FP_SUBTYPE_BITS); \
521 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
522 	    _FP_SUBTYPE_BITS; \
523 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
524 } while(0)
525 
526 /* the fingerprint of an OSes TCP SYN packet */
527 typedef u_int64_t	pf_tcpopts_t;
528 struct pf_os_fingerprint {
529 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
530 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
531 	u_int16_t		fp_wsize;	/* TCP window size */
532 	u_int16_t		fp_psize;	/* ip->ip_len */
533 	u_int16_t		fp_mss;		/* TCP MSS */
534 	u_int16_t		fp_flags;
535 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
536 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
537 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
538 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
539 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
540 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
541 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
542 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
543 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
544 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
545 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
546 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
547 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
548 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
549 #define PF_OSFP_INET6		0x4000		/* IPv6 */
550 	u_int8_t		fp_optcnt;	/* TCP option count */
551 	u_int8_t		fp_wscale;	/* TCP window scaling */
552 	u_int8_t		fp_ttl;		/* IPv4 TTL */
553 #define PF_OSFP_MAXTTL_OFFSET	40
554 /* TCP options packing */
555 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
556 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
557 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
558 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
559 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
560 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
561 #define PF_OSFP_MAX_OPTS \
562     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
563     / PF_OSFP_TCPOPT_BITS
564 
565 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
566 };
567 
568 struct pf_osfp_ioctl {
569 	struct pf_osfp_entry	fp_os;
570 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
571 	u_int16_t		fp_wsize;	/* TCP window size */
572 	u_int16_t		fp_psize;	/* ip->ip_len */
573 	u_int16_t		fp_mss;		/* TCP MSS */
574 	u_int16_t		fp_flags;
575 	u_int8_t		fp_optcnt;	/* TCP option count */
576 	u_int8_t		fp_wscale;	/* TCP window scaling */
577 	u_int8_t		fp_ttl;		/* IPv4 TTL */
578 
579 	int			fp_getnum;	/* DIOCOSFPGET number */
580 };
581 
582 
583 union pf_rule_ptr {
584 	struct pf_rule		*ptr;
585 	u_int32_t		 nr;
586 };
587 
588 #define	PF_ANCHOR_NAME_SIZE	 64
589 
590 struct pf_rule {
591 	struct pf_rule_addr	 src;
592 	struct pf_rule_addr	 dst;
593 #define PF_SKIP_IFP		0
594 #define PF_SKIP_DIR		1
595 #define PF_SKIP_AF		2
596 #define PF_SKIP_PROTO		3
597 #define PF_SKIP_SRC_ADDR	4
598 #define PF_SKIP_SRC_PORT	5
599 #define PF_SKIP_DST_ADDR	6
600 #define PF_SKIP_DST_PORT	7
601 #define PF_SKIP_COUNT		8
602 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
603 #define PF_RULE_LABEL_SIZE	 64
604 	char			 label[PF_RULE_LABEL_SIZE];
605 #define PF_QNAME_SIZE		 64
606 	char			 ifname[IFNAMSIZ];
607 	char			 qname[PF_QNAME_SIZE];
608 	char			 pqname[PF_QNAME_SIZE];
609 #define	PF_TAG_NAME_SIZE	 64
610 	char			 tagname[PF_TAG_NAME_SIZE];
611 	char			 match_tagname[PF_TAG_NAME_SIZE];
612 
613 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
614 
615 	TAILQ_ENTRY(pf_rule)	 entries;
616 	struct pf_pool		 rpool;
617 
618 	u_int64_t		 evaluations;
619 	u_int64_t		 packets[2];
620 	u_int64_t		 bytes[2];
621 
622 	struct pfi_kif		*kif;
623 	struct pf_anchor	*anchor;
624 	struct pfr_ktable	*overload_tbl;
625 
626 	pf_osfp_t		 os_fingerprint;
627 
628 	int			 rtableid;
629 	u_int32_t		 timeout[PFTM_MAX];
630 	u_int32_t		 states_cur;
631 	u_int32_t		 states_tot;
632 	u_int32_t		 max_states;
633 	u_int32_t		 src_nodes;
634 	u_int32_t		 max_src_nodes;
635 	u_int32_t		 max_src_states;
636 	u_int32_t		 spare1;			/* netgraph */
637 	u_int32_t		 max_src_conn;
638 	struct {
639 		u_int32_t		limit;
640 		u_int32_t		seconds;
641 	}			 max_src_conn_rate;
642 	u_int32_t		 qid;
643 	u_int32_t		 pqid;
644 	u_int32_t		 rt_listid;
645 	u_int32_t		 nr;
646 	u_int32_t		 prob;
647 	uid_t			 cuid;
648 	pid_t			 cpid;
649 
650 	u_int16_t		 return_icmp;
651 	u_int16_t		 return_icmp6;
652 	u_int16_t		 max_mss;
653 	u_int16_t		 tag;
654 	u_int16_t		 match_tag;
655 	u_int16_t		 spare2;			/* netgraph */
656 
657 	struct pf_rule_uid	 uid;
658 	struct pf_rule_gid	 gid;
659 
660 	u_int32_t		 rule_flag;
661 	u_int8_t		 action;
662 	u_int8_t		 direction;
663 	u_int8_t		 log;
664 	u_int8_t		 logif;
665 	u_int8_t		 quick;
666 	u_int8_t		 ifnot;
667 	u_int8_t		 match_tag_not;
668 	u_int8_t		 natpass;
669 
670 #define PF_STATE_NORMAL		0x1
671 #define PF_STATE_MODULATE	0x2
672 #define PF_STATE_SYNPROXY	0x3
673 	u_int8_t		 keep_state;
674 	sa_family_t		 af;
675 	u_int8_t		 proto;
676 	u_int8_t		 type;
677 	u_int8_t		 code;
678 	u_int8_t		 flags;
679 	u_int8_t		 flagset;
680 	u_int8_t		 min_ttl;
681 	u_int8_t		 allow_opts;
682 	u_int8_t		 rt;
683 	u_int8_t		 return_ttl;
684 	u_int8_t		 tos;
685 	u_int8_t		 set_tos;
686 	u_int8_t		 anchor_relative;
687 	u_int8_t		 anchor_wildcard;
688 
689 #define PF_FLUSH		0x01
690 #define PF_FLUSH_GLOBAL		0x02
691 	u_int8_t		 flush;
692 
693 	struct {
694 		struct pf_addr		addr;
695 		u_int16_t		port;
696 	}			divert;
697 };
698 
699 /* rule flags */
700 #define	PFRULE_DROP		0x0000
701 #define	PFRULE_RETURNRST	0x0001
702 #define	PFRULE_FRAGMENT		0x0002
703 #define	PFRULE_RETURNICMP	0x0004
704 #define	PFRULE_RETURN		0x0008
705 #define	PFRULE_NOSYNC		0x0010
706 #define PFRULE_SRCTRACK		0x0020  /* track source states */
707 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
708 
709 /* scrub flags */
710 #define	PFRULE_NODF		0x0100
711 #define	PFRULE_FRAGCROP		0x0200	/* non-buffering frag cache */
712 #define	PFRULE_FRAGDROP		0x0400	/* drop funny fragments */
713 #define PFRULE_RANDOMID		0x0800
714 #define PFRULE_REASSEMBLE_TCP	0x1000
715 #define PFRULE_SET_TOS		0x2000
716 
717 /* rule flags again */
718 #define PFRULE_IFBOUND		0x00010000	/* if-bound */
719 #define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
720 #define PFRULE_PFLOW		0x00040000
721 
722 #define PFSTATE_HIWAT		10000	/* default state table size */
723 #define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
724 #define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
725 
726 
727 struct pf_threshold {
728 	u_int32_t	limit;
729 #define	PF_THRESHOLD_MULT	1000
730 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
731 	u_int32_t	seconds;
732 	u_int32_t	count;
733 	u_int32_t	last;
734 };
735 
736 struct pf_src_node {
737 	RB_ENTRY(pf_src_node) entry;
738 	struct pf_addr	 addr;
739 	struct pf_addr	 raddr;
740 	union pf_rule_ptr rule;
741 	struct pfi_kif	*kif;
742 	u_int64_t	 bytes[2];
743 	u_int64_t	 packets[2];
744 	u_int32_t	 states;
745 	u_int32_t	 conn;
746 	struct pf_threshold	conn_rate;
747 	u_int32_t	 creation;
748 	u_int32_t	 expire;
749 	sa_family_t	 af;
750 	u_int8_t	 ruletype;
751 };
752 
753 #define PFSNODE_HIWAT		10000	/* default source node table size */
754 
755 struct pf_state_scrub {
756 	struct timeval	pfss_last;	/* time received last packet	*/
757 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
758 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
759 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
760 	u_int16_t	pfss_flags;
761 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
762 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
763 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
764 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
765 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
766 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
767 	u_int8_t	pad;
768 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
769 };
770 
771 struct pf_state_host {
772 	struct pf_addr	addr;
773 	u_int16_t	port;
774 	u_int16_t	pad;
775 };
776 
777 struct pf_state_peer {
778 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
779 	u_int32_t	seqlo;		/* Max sequence number sent	*/
780 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
781 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
782 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
783 	u_int16_t	mss;		/* Maximum segment size option	*/
784 	u_int8_t	state;		/* active state level		*/
785 	u_int8_t	wscale;		/* window scaling factor	*/
786 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
787 	u_int8_t	pad[1];
788 };
789 
790 TAILQ_HEAD(pf_state_queue, pf_state);
791 
792 /* keep synced with struct pf_state_key, used in RB_FIND */
793 struct pf_state_key_cmp {
794 	struct pf_addr	 addr[2];
795 	u_int16_t	 port[2];
796 	sa_family_t	 af;
797 	u_int8_t	 proto;
798 	u_int8_t	 pad[2];
799 };
800 
801 struct pf_state_item {
802 	TAILQ_ENTRY(pf_state_item)	 entry;
803 	struct pf_state			*s;
804 };
805 
806 TAILQ_HEAD(pf_statelisthead, pf_state_item);
807 
808 struct pf_state_key {
809 	struct pf_addr	 addr[2];
810 	u_int16_t	 port[2];
811 	sa_family_t	 af;
812 	u_int8_t	 proto;
813 	u_int8_t	 pad[2];
814 
815 	RB_ENTRY(pf_state_key)	 entry;
816 	struct pf_statelisthead	 states;
817 	struct pf_state_key	*reverse;
818 	struct inpcb		*inp;
819 };
820 
821 /* keep synced with struct pf_state, used in RB_FIND */
822 struct pf_state_cmp {
823 	u_int64_t		 id;
824 	u_int32_t		 creatorid;
825 	u_int8_t		 direction;
826 	u_int8_t		 pad[3];
827 };
828 
829 struct pf_state {
830 	u_int64_t		 id;
831 	u_int32_t		 creatorid;
832 	u_int8_t		 direction;
833 #ifdef __FreeBSD__
834 	u_int8_t		 pad[2];
835 	u_int8_t		 local_flags;
836 #define	PFSTATE_EXPIRING 0x01
837 #else
838 	u_int8_t		 pad[3];
839 #endif
840 
841 	TAILQ_ENTRY(pf_state)	 sync_list;
842 	TAILQ_ENTRY(pf_state)	 entry_list;
843 	RB_ENTRY(pf_state)	 entry_id;
844 	struct pf_state_peer	 src;
845 	struct pf_state_peer	 dst;
846 	union pf_rule_ptr	 rule;
847 	union pf_rule_ptr	 anchor;
848 	union pf_rule_ptr	 nat_rule;
849 	struct pf_addr		 rt_addr;
850 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
851 	struct pfi_kif		*kif;
852 	struct pfi_kif		*rt_kif;
853 	struct pf_src_node	*src_node;
854 	struct pf_src_node	*nat_src_node;
855 	u_int64_t		 packets[2];
856 	u_int64_t		 bytes[2];
857 	u_int32_t		 creation;
858 	u_int32_t	 	 expire;
859 	u_int32_t		 pfsync_time;
860 	u_int16_t		 tag;
861 	u_int8_t		 log;
862 	u_int8_t		 state_flags;
863 #define	PFSTATE_ALLOWOPTS	0x01
864 #define	PFSTATE_SLOPPY		0x02
865 #define	PFSTATE_PFLOW		0x04
866 #define	PFSTATE_NOSYNC		0x08
867 #define	PFSTATE_ACK		0x10
868 	u_int8_t		 timeout;
869 	u_int8_t		 sync_state; /* PFSYNC_S_x */
870 
871 	/* XXX */
872 	u_int8_t		 sync_updates;
873 	u_int8_t		_tail[3];
874 };
875 
876 /*
877  * Unified state structures for pulling states out of the kernel
878  * used by pfsync(4) and the pf(4) ioctl.
879  */
880 struct pfsync_state_scrub {
881 	u_int16_t	pfss_flags;
882 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
883 #define PFSYNC_SCRUB_FLAG_VALID		0x01
884 	u_int8_t	scrub_flag;
885 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
886 } __packed;
887 
888 struct pfsync_state_peer {
889 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
890 	u_int32_t	seqlo;		/* Max sequence number sent	*/
891 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
892 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
893 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
894 	u_int16_t	mss;		/* Maximum segment size option	*/
895 	u_int8_t	state;		/* active state level		*/
896 	u_int8_t	wscale;		/* window scaling factor	*/
897 	u_int8_t	pad[6];
898 } __packed;
899 
900 struct pfsync_state_key {
901 	struct pf_addr	 addr[2];
902 	u_int16_t	 port[2];
903 };
904 
905 struct pfsync_state {
906 	u_int32_t	 id[2];
907 	char		 ifname[IFNAMSIZ];
908 	struct pfsync_state_key	key[2];
909 	struct pfsync_state_peer src;
910 	struct pfsync_state_peer dst;
911 	struct pf_addr	 rt_addr;
912 	u_int32_t	 rule;
913 	u_int32_t	 anchor;
914 	u_int32_t	 nat_rule;
915 	u_int32_t	 creation;
916 	u_int32_t	 expire;
917 	u_int32_t	 packets[2][2];
918 	u_int32_t	 bytes[2][2];
919 	u_int32_t	 creatorid;
920 	sa_family_t	 af;
921 	u_int8_t	 proto;
922 	u_int8_t	 direction;
923 #ifdef __FreeBSD__
924 	u_int8_t	 local_flags;
925 #define	PFSTATE_EXPIRING		0x01
926 	u_int8_t	 pad;
927 #endif
928 	u_int8_t	 log;
929 	u_int8_t	 state_flags;
930 	u_int8_t	 timeout;
931 	u_int8_t	 sync_flags;
932 	u_int8_t	 updates;
933 } __packed;
934 
935 #ifdef __FreeBSD__
936 #ifdef _KERNEL
937 /* pfsync */
938 typedef int		pfsync_state_import_t(struct pfsync_state *, u_int8_t);
939 typedef	void		pfsync_insert_state_t(struct pf_state *);
940 typedef	void		pfsync_update_state_t(struct pf_state *);
941 typedef	void		pfsync_delete_state_t(struct pf_state *);
942 typedef void		pfsync_clear_states_t(u_int32_t, const char *);
943 typedef int		pfsync_state_in_use_t(struct pf_state *);
944 typedef int		pfsync_defer_t(struct pf_state *, struct mbuf *);
945 typedef	int		pfsync_up_t(void);
946 
947 extern pfsync_state_import_t	*pfsync_state_import_ptr;
948 extern pfsync_insert_state_t	*pfsync_insert_state_ptr;
949 extern pfsync_update_state_t	*pfsync_update_state_ptr;
950 extern pfsync_delete_state_t	*pfsync_delete_state_ptr;
951 extern pfsync_clear_states_t	*pfsync_clear_states_ptr;
952 extern pfsync_state_in_use_t	*pfsync_state_in_use_ptr;
953 extern pfsync_defer_t		*pfsync_defer_ptr;
954 extern pfsync_up_t		*pfsync_up_ptr;
955 
956 void			pfsync_state_export(struct pfsync_state *,
957 			    struct pf_state *);
958 
959 /* pflow */
960 typedef int		export_pflow_t(struct pf_state *);
961 
962 extern export_pflow_t		*export_pflow_ptr;
963 
964 /* pflog */
965 struct pf_ruleset;
966 struct pf_pdesc;
967 typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
968     u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
969     struct pf_ruleset *, struct pf_pdesc *);
970 
971 extern pflog_packet_t		*pflog_packet_ptr;
972 
973 /* pf uid hack */
974 VNET_DECLARE(int, debug_pfugidhack);
975 #define	V_debug_pfugidhack	VNET(debug_pfugidhack)
976 
977 #define	V_pf_end_threads	VNET(pf_end_threads)
978 #endif
979 
980 /* Macros to set/clear/test flags. */
981 #ifdef _KERNEL
982 #define	SET(t, f)	((t) |= (f))
983 #define	CLR(t, f)	((t) &= ~(f))
984 #define	ISSET(t, f)	((t) & (f))
985 #endif
986 #endif
987 
988 #define	PFSYNC_FLAG_SRCNODE	0x04
989 #define	PFSYNC_FLAG_NATSRCNODE	0x08
990 
991 /* for copies to/from network byte order */
992 /* ioctl interface also uses network byte order */
993 #define pf_state_peer_hton(s,d) do {		\
994 	(d)->seqlo = htonl((s)->seqlo);		\
995 	(d)->seqhi = htonl((s)->seqhi);		\
996 	(d)->seqdiff = htonl((s)->seqdiff);	\
997 	(d)->max_win = htons((s)->max_win);	\
998 	(d)->mss = htons((s)->mss);		\
999 	(d)->state = (s)->state;		\
1000 	(d)->wscale = (s)->wscale;		\
1001 	if ((s)->scrub) {						\
1002 		(d)->scrub.pfss_flags = 				\
1003 		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
1004 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
1005 		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
1006 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
1007 	}								\
1008 } while (0)
1009 
1010 #define pf_state_peer_ntoh(s,d) do {		\
1011 	(d)->seqlo = ntohl((s)->seqlo);		\
1012 	(d)->seqhi = ntohl((s)->seqhi);		\
1013 	(d)->seqdiff = ntohl((s)->seqdiff);	\
1014 	(d)->max_win = ntohs((s)->max_win);	\
1015 	(d)->mss = ntohs((s)->mss);		\
1016 	(d)->state = (s)->state;		\
1017 	(d)->wscale = (s)->wscale;		\
1018 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
1019 	    (d)->scrub != NULL) {					\
1020 		(d)->scrub->pfss_flags =				\
1021 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
1022 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
1023 		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
1024 	}								\
1025 } while (0)
1026 
1027 #define pf_state_counter_hton(s,d) do {				\
1028 	d[0] = htonl((s>>32)&0xffffffff);			\
1029 	d[1] = htonl(s&0xffffffff);				\
1030 } while (0)
1031 
1032 #define pf_state_counter_from_pfsync(s)				\
1033 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
1034 
1035 #define pf_state_counter_ntoh(s,d) do {				\
1036 	d = ntohl(s[0]);					\
1037 	d = d<<32;						\
1038 	d += ntohl(s[1]);					\
1039 } while (0)
1040 
1041 TAILQ_HEAD(pf_rulequeue, pf_rule);
1042 
1043 struct pf_anchor;
1044 
1045 struct pf_ruleset {
1046 	struct {
1047 		struct pf_rulequeue	 queues[2];
1048 		struct {
1049 			struct pf_rulequeue	*ptr;
1050 			struct pf_rule		**ptr_array;
1051 			u_int32_t		 rcount;
1052 			u_int32_t		 ticket;
1053 			int			 open;
1054 		}			 active, inactive;
1055 	}			 rules[PF_RULESET_MAX];
1056 	struct pf_anchor	*anchor;
1057 	u_int32_t		 tticket;
1058 	int			 tables;
1059 	int			 topen;
1060 };
1061 
1062 RB_HEAD(pf_anchor_global, pf_anchor);
1063 RB_HEAD(pf_anchor_node, pf_anchor);
1064 struct pf_anchor {
1065 	RB_ENTRY(pf_anchor)	 entry_global;
1066 	RB_ENTRY(pf_anchor)	 entry_node;
1067 	struct pf_anchor	*parent;
1068 	struct pf_anchor_node	 children;
1069 	char			 name[PF_ANCHOR_NAME_SIZE];
1070 	char			 path[MAXPATHLEN];
1071 	struct pf_ruleset	 ruleset;
1072 	int			 refcnt;	/* anchor rules */
1073 	int			 match;
1074 };
1075 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
1076 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
1077 
1078 #define PF_RESERVED_ANCHOR	"_pf"
1079 
1080 #define PFR_TFLAG_PERSIST	0x00000001
1081 #define PFR_TFLAG_CONST		0x00000002
1082 #define PFR_TFLAG_ACTIVE	0x00000004
1083 #define PFR_TFLAG_INACTIVE	0x00000008
1084 #define PFR_TFLAG_REFERENCED	0x00000010
1085 #define PFR_TFLAG_REFDANCHOR	0x00000020
1086 #define PFR_TFLAG_COUNTERS	0x00000040
1087 /* Adjust masks below when adding flags. */
1088 #define PFR_TFLAG_USRMASK	0x00000043
1089 #define PFR_TFLAG_SETMASK	0x0000003C
1090 #define PFR_TFLAG_ALLMASK	0x0000007F
1091 
1092 struct pfr_table {
1093 	char			 pfrt_anchor[MAXPATHLEN];
1094 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
1095 	u_int32_t		 pfrt_flags;
1096 	u_int8_t		 pfrt_fback;
1097 };
1098 
1099 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1100 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1101 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1102 
1103 struct pfr_addr {
1104 	union {
1105 		struct in_addr	 _pfra_ip4addr;
1106 		struct in6_addr	 _pfra_ip6addr;
1107 	}		 pfra_u;
1108 	u_int8_t	 pfra_af;
1109 	u_int8_t	 pfra_net;
1110 	u_int8_t	 pfra_not;
1111 	u_int8_t	 pfra_fback;
1112 };
1113 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
1114 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
1115 
1116 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1117 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1118 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
1119 
1120 struct pfr_astats {
1121 	struct pfr_addr	 pfras_a;
1122 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1123 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1124 	long		 pfras_tzero;
1125 };
1126 
1127 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1128 
1129 struct pfr_tstats {
1130 	struct pfr_table pfrts_t;
1131 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1132 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1133 	u_int64_t	 pfrts_match;
1134 	u_int64_t	 pfrts_nomatch;
1135 	long		 pfrts_tzero;
1136 	int		 pfrts_cnt;
1137 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1138 };
1139 #define	pfrts_name	pfrts_t.pfrt_name
1140 #define pfrts_flags	pfrts_t.pfrt_flags
1141 
1142 #ifndef _SOCKADDR_UNION_DEFINED
1143 #define	_SOCKADDR_UNION_DEFINED
1144 union sockaddr_union {
1145 	struct sockaddr		sa;
1146 	struct sockaddr_in	sin;
1147 	struct sockaddr_in6	sin6;
1148 };
1149 #endif /* _SOCKADDR_UNION_DEFINED */
1150 
1151 struct pfr_kcounters {
1152 	u_int64_t		 pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1153 	u_int64_t		 pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1154 };
1155 
1156 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1157 struct pfr_kentry {
1158 	struct radix_node	 pfrke_node[2];
1159 	union sockaddr_union	 pfrke_sa;
1160 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1161 	union {
1162 
1163 		struct pfr_kcounters		*pfrke_counters;
1164 #if 0
1165 		struct pfr_kroute		*pfrke_route;
1166 #endif
1167 	} u;
1168 	long			 pfrke_tzero;
1169 	u_int8_t		 pfrke_af;
1170 	u_int8_t		 pfrke_net;
1171 	u_int8_t		 pfrke_not;
1172 	u_int8_t		 pfrke_mark;
1173 };
1174 #define pfrke_counters	u.pfrke_counters
1175 #define pfrke_route	u.pfrke_route
1176 
1177 
1178 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1179 RB_HEAD(pfr_ktablehead, pfr_ktable);
1180 struct pfr_ktable {
1181 	struct pfr_tstats	 pfrkt_ts;
1182 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1183 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1184 	struct radix_node_head	*pfrkt_ip4;
1185 	struct radix_node_head	*pfrkt_ip6;
1186 	struct pfr_ktable	*pfrkt_shadow;
1187 	struct pfr_ktable	*pfrkt_root;
1188 	struct pf_ruleset	*pfrkt_rs;
1189 	long			 pfrkt_larg;
1190 	int			 pfrkt_nflags;
1191 };
1192 #define pfrkt_t		pfrkt_ts.pfrts_t
1193 #define pfrkt_name	pfrkt_t.pfrt_name
1194 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
1195 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1196 #define pfrkt_flags	pfrkt_t.pfrt_flags
1197 #define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1198 #define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1199 #define pfrkt_packets	pfrkt_ts.pfrts_packets
1200 #define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1201 #define pfrkt_match	pfrkt_ts.pfrts_match
1202 #define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1203 #define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1204 
1205 RB_HEAD(pf_state_tree, pf_state_key);
1206 RB_PROTOTYPE(pf_state_tree, pf_state_key, entry, pf_state_compare_key);
1207 
1208 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key);
1209 RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state_key,
1210     entry_ext_gwy, pf_state_compare_ext_gwy);
1211 
1212 RB_HEAD(pfi_ifhead, pfi_kif);
1213 
1214 /* state tables */
1215 #ifdef __FreeBSD__
1216 #ifdef _KERNEL
1217 VNET_DECLARE(struct pf_state_tree,	 pf_statetbl);
1218 #define	V_pf_statetbl			 VNET(pf_statetbl)
1219 #endif
1220 #else
1221 extern struct pf_state_tree	 pf_statetbl;
1222 #endif
1223 
1224 /* keep synced with pfi_kif, used in RB_FIND */
1225 struct pfi_kif_cmp {
1226 	char				 pfik_name[IFNAMSIZ];
1227 };
1228 
1229 struct pfi_kif {
1230 	char				 pfik_name[IFNAMSIZ];
1231 	RB_ENTRY(pfi_kif)		 pfik_tree;
1232 	u_int64_t			 pfik_packets[2][2][2];
1233 	u_int64_t			 pfik_bytes[2][2][2];
1234 	u_int32_t			 pfik_tzero;
1235 	int				 pfik_flags;
1236 	void				*pfik_ah_cookie;
1237 	struct ifnet			*pfik_ifp;
1238 	struct ifg_group		*pfik_group;
1239 	int				 pfik_states;
1240 	int				 pfik_rules;
1241 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1242 };
1243 
1244 enum pfi_kif_refs {
1245 	PFI_KIF_REF_NONE,
1246 	PFI_KIF_REF_STATE,
1247 	PFI_KIF_REF_RULE
1248 };
1249 
1250 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1251 
1252 struct pf_pdesc {
1253 	struct {
1254 		int	 done;
1255 		uid_t	 uid;
1256 		gid_t	 gid;
1257 		pid_t	 pid;
1258 	}		 lookup;
1259 	u_int64_t	 tot_len;	/* Make Mickey money */
1260 	union {
1261 		struct tcphdr		*tcp;
1262 		struct udphdr		*udp;
1263 		struct icmp		*icmp;
1264 #ifdef INET6
1265 		struct icmp6_hdr	*icmp6;
1266 #endif /* INET6 */
1267 		void			*any;
1268 	} hdr;
1269 
1270 	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1271 	struct ether_header
1272 			*eh;
1273 	struct pf_addr	*src;		/* src address */
1274 	struct pf_addr	*dst;		/* dst address */
1275 	u_int16_t *sport;
1276 	u_int16_t *dport;
1277 #ifdef __FreeBSD__
1278 	struct pf_mtag	*pf_mtag;
1279 #endif
1280 
1281 	u_int32_t	 p_len;		/* total length of payload */
1282 
1283 	u_int16_t	*ip_sum;
1284 	u_int16_t	*proto_sum;
1285 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1286 					 * state code. Easier than tags */
1287 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1288 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1289 	sa_family_t	 af;
1290 	u_int8_t	 proto;
1291 	u_int8_t	 tos;
1292 	u_int8_t	 dir;		/* direction */
1293 	u_int8_t	 sidx;		/* key index for source */
1294 	u_int8_t	 didx;		/* key index for destination */
1295 };
1296 
1297 /* flags for RDR options */
1298 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1299 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1300 
1301 /* Reasons code for passing/dropping a packet */
1302 #define PFRES_MATCH	0		/* Explicit match of a rule */
1303 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1304 #define PFRES_FRAG	2		/* Dropping following fragment */
1305 #define PFRES_SHORT	3		/* Dropping short packet */
1306 #define PFRES_NORM	4		/* Dropping by normalizer */
1307 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1308 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1309 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1310 #define PFRES_IPOPTIONS 8		/* IP option */
1311 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1312 #define PFRES_BADSTATE	10		/* State mismatch */
1313 #define PFRES_STATEINS	11		/* State insertion failure */
1314 #define PFRES_MAXSTATES	12		/* State limit */
1315 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1316 #define PFRES_SYNPROXY	14		/* SYN proxy */
1317 #define PFRES_MAX	15		/* total+1 */
1318 
1319 #define PFRES_NAMES { \
1320 	"match", \
1321 	"bad-offset", \
1322 	"fragment", \
1323 	"short", \
1324 	"normalize", \
1325 	"memory", \
1326 	"bad-timestamp", \
1327 	"congestion", \
1328 	"ip-option", \
1329 	"proto-cksum", \
1330 	"state-mismatch", \
1331 	"state-insert", \
1332 	"state-limit", \
1333 	"src-limit", \
1334 	"synproxy", \
1335 	NULL \
1336 }
1337 
1338 /* Counters for other things we want to keep track of */
1339 #define LCNT_STATES		0	/* states */
1340 #define LCNT_SRCSTATES		1	/* max-src-states */
1341 #define LCNT_SRCNODES		2	/* max-src-nodes */
1342 #define LCNT_SRCCONN		3	/* max-src-conn */
1343 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1344 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1345 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1346 #define LCNT_MAX		7	/* total+1 */
1347 
1348 #define LCNT_NAMES { \
1349 	"max states per rule", \
1350 	"max-src-states", \
1351 	"max-src-nodes", \
1352 	"max-src-conn", \
1353 	"max-src-conn-rate", \
1354 	"overload table insertion", \
1355 	"overload flush states", \
1356 	NULL \
1357 }
1358 
1359 /* UDP state enumeration */
1360 #define PFUDPS_NO_TRAFFIC	0
1361 #define PFUDPS_SINGLE		1
1362 #define PFUDPS_MULTIPLE		2
1363 
1364 #define PFUDPS_NSTATES		3	/* number of state levels */
1365 
1366 #define PFUDPS_NAMES { \
1367 	"NO_TRAFFIC", \
1368 	"SINGLE", \
1369 	"MULTIPLE", \
1370 	NULL \
1371 }
1372 
1373 /* Other protocol state enumeration */
1374 #define PFOTHERS_NO_TRAFFIC	0
1375 #define PFOTHERS_SINGLE		1
1376 #define PFOTHERS_MULTIPLE	2
1377 
1378 #define PFOTHERS_NSTATES	3	/* number of state levels */
1379 
1380 #define PFOTHERS_NAMES { \
1381 	"NO_TRAFFIC", \
1382 	"SINGLE", \
1383 	"MULTIPLE", \
1384 	NULL \
1385 }
1386 
1387 #define FCNT_STATE_SEARCH	0
1388 #define FCNT_STATE_INSERT	1
1389 #define FCNT_STATE_REMOVALS	2
1390 #define FCNT_MAX		3
1391 
1392 #define SCNT_SRC_NODE_SEARCH	0
1393 #define SCNT_SRC_NODE_INSERT	1
1394 #define SCNT_SRC_NODE_REMOVALS	2
1395 #define SCNT_MAX		3
1396 
1397 #define ACTION_SET(a, x) \
1398 	do { \
1399 		if ((a) != NULL) \
1400 			*(a) = (x); \
1401 	} while (0)
1402 
1403 #ifdef __FreeBSD__
1404 #define REASON_SET(a, x) \
1405 	do { \
1406 		if ((a) != NULL) \
1407 			*(a) = (x); \
1408 		if (x < PFRES_MAX) \
1409 			V_pf_status.counters[x]++; \
1410 	} while (0)
1411 #else
1412 #define REASON_SET(a, x) \
1413 	do { \
1414 		if ((a) != NULL) \
1415 			*(a) = (x); \
1416 		if (x < PFRES_MAX) \
1417 			pf_status.counters[x]++; \
1418 	} while (0)
1419 #endif
1420 
1421 struct pf_status {
1422 	u_int64_t	counters[PFRES_MAX];
1423 	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1424 	u_int64_t	fcounters[FCNT_MAX];
1425 	u_int64_t	scounters[SCNT_MAX];
1426 	u_int64_t	pcounters[2][2][3];
1427 	u_int64_t	bcounters[2][2];
1428 	u_int64_t	stateid;
1429 	u_int32_t	running;
1430 	u_int32_t	states;
1431 	u_int32_t	src_nodes;
1432 	u_int32_t	since;
1433 	u_int32_t	debug;
1434 	u_int32_t	hostid;
1435 	char		ifname[IFNAMSIZ];
1436 	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1437 };
1438 
1439 struct cbq_opts {
1440 	u_int		minburst;
1441 	u_int		maxburst;
1442 	u_int		pktsize;
1443 	u_int		maxpktsize;
1444 	u_int		ns_per_byte;
1445 	u_int		maxidle;
1446 	int		minidle;
1447 	u_int		offtime;
1448 	int		flags;
1449 };
1450 
1451 struct priq_opts {
1452 	int		flags;
1453 };
1454 
1455 struct hfsc_opts {
1456 	/* real-time service curve */
1457 	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
1458 	u_int		rtsc_d;		/* the x-projection of m1 in msec */
1459 	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
1460 	/* link-sharing service curve */
1461 	u_int		lssc_m1;
1462 	u_int		lssc_d;
1463 	u_int		lssc_m2;
1464 	/* upper-limit service curve */
1465 	u_int		ulsc_m1;
1466 	u_int		ulsc_d;
1467 	u_int		ulsc_m2;
1468 	int		flags;
1469 };
1470 
1471 struct pf_altq {
1472 	char			 ifname[IFNAMSIZ];
1473 
1474 	void			*altq_disc;	/* discipline-specific state */
1475 	TAILQ_ENTRY(pf_altq)	 entries;
1476 
1477 	/* scheduler spec */
1478 	u_int8_t		 scheduler;	/* scheduler type */
1479 	u_int16_t		 tbrsize;	/* tokenbucket regulator size */
1480 	u_int32_t		 ifbandwidth;	/* interface bandwidth */
1481 
1482 	/* queue spec */
1483 	char			 qname[PF_QNAME_SIZE];	/* queue name */
1484 	char			 parent[PF_QNAME_SIZE];	/* parent name */
1485 	u_int32_t		 parent_qid;	/* parent queue id */
1486 	u_int32_t		 bandwidth;	/* queue bandwidth */
1487 	u_int8_t		 priority;	/* priority */
1488 #ifdef __FreeBSD__
1489 	u_int8_t		 local_flags;	/* dynamic interface */
1490 #define	PFALTQ_FLAG_IF_REMOVED		0x01
1491 #endif
1492 	u_int16_t		 qlimit;	/* queue size limit */
1493 	u_int16_t		 flags;		/* misc flags */
1494 	union {
1495 		struct cbq_opts		 cbq_opts;
1496 		struct priq_opts	 priq_opts;
1497 		struct hfsc_opts	 hfsc_opts;
1498 	} pq_u;
1499 
1500 	u_int32_t		 qid;		/* return value */
1501 };
1502 
1503 struct pf_tagname {
1504 	TAILQ_ENTRY(pf_tagname)	entries;
1505 	char			name[PF_TAG_NAME_SIZE];
1506 	u_int16_t		tag;
1507 	int			ref;
1508 };
1509 
1510 struct pf_divert {
1511 	union {
1512 		struct in_addr	ipv4;
1513 		struct in6_addr	ipv6;
1514 	}		addr;
1515 	u_int16_t	port;
1516 };
1517 
1518 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1519 #define PFFRAG_FRAG_HIWAT	1000	/* Number of fragmented packets */
1520 #define PFFRAG_FRCENT_HIWAT	50000	/* Number of fragment cache entries */
1521 #define PFFRAG_FRCACHE_HIWAT	10000	/* Number of fragment descriptors */
1522 
1523 #define PFR_KTABLE_HIWAT	1000	/* Number of tables */
1524 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1525 #define PFR_KENTRY_HIWAT_SMALL	100000	/* Number of table entries (tiny hosts) */
1526 
1527 /*
1528  * ioctl parameter structures
1529  */
1530 
1531 struct pfioc_pooladdr {
1532 	u_int32_t		 action;
1533 	u_int32_t		 ticket;
1534 	u_int32_t		 nr;
1535 	u_int32_t		 r_num;
1536 	u_int8_t		 r_action;
1537 	u_int8_t		 r_last;
1538 	u_int8_t		 af;
1539 	char			 anchor[MAXPATHLEN];
1540 	struct pf_pooladdr	 addr;
1541 };
1542 
1543 struct pfioc_rule {
1544 	u_int32_t	 action;
1545 	u_int32_t	 ticket;
1546 	u_int32_t	 pool_ticket;
1547 	u_int32_t	 nr;
1548 	char		 anchor[MAXPATHLEN];
1549 	char		 anchor_call[MAXPATHLEN];
1550 	struct pf_rule	 rule;
1551 };
1552 
1553 struct pfioc_natlook {
1554 	struct pf_addr	 saddr;
1555 	struct pf_addr	 daddr;
1556 	struct pf_addr	 rsaddr;
1557 	struct pf_addr	 rdaddr;
1558 	u_int16_t	 sport;
1559 	u_int16_t	 dport;
1560 	u_int16_t	 rsport;
1561 	u_int16_t	 rdport;
1562 	sa_family_t	 af;
1563 	u_int8_t	 proto;
1564 	u_int8_t	 direction;
1565 };
1566 
1567 struct pfioc_state {
1568 	struct pfsync_state	state;
1569 };
1570 
1571 struct pfioc_src_node_kill {
1572 	sa_family_t psnk_af;
1573 	struct pf_rule_addr psnk_src;
1574 	struct pf_rule_addr psnk_dst;
1575 	u_int		    psnk_killed;
1576 };
1577 
1578 struct pfioc_state_kill {
1579 	struct pf_state_cmp	psk_pfcmp;
1580 	sa_family_t		psk_af;
1581 	int			psk_proto;
1582 	struct pf_rule_addr	psk_src;
1583 	struct pf_rule_addr	psk_dst;
1584 	char			psk_ifname[IFNAMSIZ];
1585 	char			psk_label[PF_RULE_LABEL_SIZE];
1586 	u_int			psk_killed;
1587 };
1588 
1589 struct pfioc_states {
1590 	int	ps_len;
1591 	union {
1592 		caddr_t			 psu_buf;
1593 		struct pfsync_state	*psu_states;
1594 	} ps_u;
1595 #define ps_buf		ps_u.psu_buf
1596 #define ps_states	ps_u.psu_states
1597 };
1598 
1599 struct pfioc_src_nodes {
1600 	int	psn_len;
1601 	union {
1602 		caddr_t		 psu_buf;
1603 		struct pf_src_node	*psu_src_nodes;
1604 	} psn_u;
1605 #define psn_buf		psn_u.psu_buf
1606 #define psn_src_nodes	psn_u.psu_src_nodes
1607 };
1608 
1609 struct pfioc_if {
1610 	char		 ifname[IFNAMSIZ];
1611 };
1612 
1613 struct pfioc_tm {
1614 	int		 timeout;
1615 	int		 seconds;
1616 };
1617 
1618 struct pfioc_limit {
1619 	int		 index;
1620 	unsigned	 limit;
1621 };
1622 
1623 struct pfioc_altq {
1624 	u_int32_t	 action;
1625 	u_int32_t	 ticket;
1626 	u_int32_t	 nr;
1627 	struct pf_altq	 altq;
1628 };
1629 
1630 struct pfioc_qstats {
1631 	u_int32_t	 ticket;
1632 	u_int32_t	 nr;
1633 	void		*buf;
1634 	int		 nbytes;
1635 	u_int8_t	 scheduler;
1636 };
1637 
1638 struct pfioc_ruleset {
1639 	u_int32_t	 nr;
1640 	char		 path[MAXPATHLEN];
1641 	char		 name[PF_ANCHOR_NAME_SIZE];
1642 };
1643 
1644 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1645 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1646 struct pfioc_trans {
1647 	int		 size;	/* number of elements */
1648 	int		 esize; /* size of each element in bytes */
1649 	struct pfioc_trans_e {
1650 		int		rs_num;
1651 		char		anchor[MAXPATHLEN];
1652 		u_int32_t	ticket;
1653 	}		*array;
1654 };
1655 
1656 #define PFR_FLAG_ATOMIC		0x00000001
1657 #define PFR_FLAG_DUMMY		0x00000002
1658 #define PFR_FLAG_FEEDBACK	0x00000004
1659 #define PFR_FLAG_CLSTATS	0x00000008
1660 #define PFR_FLAG_ADDRSTOO	0x00000010
1661 #define PFR_FLAG_REPLACE	0x00000020
1662 #define PFR_FLAG_ALLRSETS	0x00000040
1663 #define PFR_FLAG_ALLMASK	0x0000007F
1664 #ifdef _KERNEL
1665 #define PFR_FLAG_USERIOCTL	0x10000000
1666 #endif
1667 
1668 struct pfioc_table {
1669 	struct pfr_table	 pfrio_table;
1670 	void			*pfrio_buffer;
1671 	int			 pfrio_esize;
1672 	int			 pfrio_size;
1673 	int			 pfrio_size2;
1674 	int			 pfrio_nadd;
1675 	int			 pfrio_ndel;
1676 	int			 pfrio_nchange;
1677 	int			 pfrio_flags;
1678 	u_int32_t		 pfrio_ticket;
1679 };
1680 #define	pfrio_exists	pfrio_nadd
1681 #define	pfrio_nzero	pfrio_nadd
1682 #define	pfrio_nmatch	pfrio_nadd
1683 #define pfrio_naddr	pfrio_size2
1684 #define pfrio_setflag	pfrio_size2
1685 #define pfrio_clrflag	pfrio_nadd
1686 
1687 struct pfioc_iface {
1688 	char	 pfiio_name[IFNAMSIZ];
1689 	void	*pfiio_buffer;
1690 	int	 pfiio_esize;
1691 	int	 pfiio_size;
1692 	int	 pfiio_nzero;
1693 	int	 pfiio_flags;
1694 };
1695 
1696 
1697 /*
1698  * ioctl operations
1699  */
1700 
1701 #define DIOCSTART	_IO  ('D',  1)
1702 #define DIOCSTOP	_IO  ('D',  2)
1703 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1704 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1705 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1706 /* XXX cut 8 - 17 */
1707 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1708 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1709 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1710 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1711 #define DIOCCLRSTATUS	_IO  ('D', 22)
1712 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1713 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1714 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1715 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1716 /* XXX cut 26 - 28 */
1717 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1718 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1719 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1720 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1721 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1722 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1723 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1724 #define DIOCSTARTALTQ	_IO  ('D', 42)
1725 #define DIOCSTOPALTQ	_IO  ('D', 43)
1726 #define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1727 #define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1728 #define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1729 #define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1730 #define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1731 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1732 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1733 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1734 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1735 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1736 /* XXX cut 55 - 57 */
1737 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1738 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1739 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1740 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1741 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1742 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1743 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1744 #define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
1745 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1746 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1747 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1748 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1749 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1750 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1751 #define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
1752 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1753 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1754 #define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1755 #define	DIOCOSFPFLUSH	_IO('D', 78)
1756 #define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1757 #define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1758 #define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
1759 #define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
1760 #define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
1761 #define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1762 #define	DIOCCLRSRCNODES	_IO('D', 85)
1763 #define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1764 #define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1765 #define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1766 #define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1767 #define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1768 #ifdef __FreeBSD__
1769 struct pf_ifspeed {
1770 	char			ifname[IFNAMSIZ];
1771 	u_int32_t		baudrate;
1772 };
1773 #define	DIOCGIFSPEED	_IOWR('D', 92, struct pf_ifspeed)
1774 #endif
1775 
1776 #ifdef _KERNEL
1777 RB_HEAD(pf_src_tree, pf_src_node);
1778 RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1779 #ifdef __FreeBSD__
1780 VNET_DECLARE(struct pf_src_tree,	 tree_src_tracking);
1781 #define	V_tree_src_tracking		 VNET(tree_src_tracking)
1782 #else
1783 extern struct pf_src_tree tree_src_tracking;
1784 #endif
1785 
1786 RB_HEAD(pf_state_tree_id, pf_state);
1787 RB_PROTOTYPE(pf_state_tree_id, pf_state,
1788     entry_id, pf_state_compare_id);
1789 #ifdef __FreeBSD__
1790 VNET_DECLARE(struct pf_state_tree_id,	 tree_id);
1791 #define	V_tree_id			 VNET(tree_id)
1792 VNET_DECLARE(struct pf_state_queue,	 state_list);
1793 #define	V_state_list			 VNET(state_list)
1794 #else
1795 extern struct pf_state_tree_id tree_id;
1796 extern struct pf_state_queue state_list;
1797 #endif
1798 
1799 TAILQ_HEAD(pf_poolqueue, pf_pool);
1800 #ifdef __FreeBSD__
1801 VNET_DECLARE(struct pf_poolqueue,	 pf_pools[2]);
1802 #define	V_pf_pools			 VNET(pf_pools)
1803 #else
1804 extern struct pf_poolqueue		  pf_pools[2];
1805 #endif
1806 TAILQ_HEAD(pf_altqqueue, pf_altq);
1807 #ifdef __FreeBSD__
1808 VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[2]);
1809 #define	V_pf_altqs			 VNET(pf_altqs)
1810 VNET_DECLARE(struct pf_palist,		 pf_pabuf);
1811 #define	V_pf_pabuf			 VNET(pf_pabuf)
1812 #else
1813 extern struct pf_altqqueue		  pf_altqs[2];
1814 extern struct pf_palist			  pf_pabuf;
1815 #endif
1816 
1817 #ifdef __FreeBSD__
1818 VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
1819 #define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
1820 VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
1821 #define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
1822 VNET_DECLARE(int,			 altqs_inactive_open);
1823 #define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
1824 VNET_DECLARE(u_int32_t,			 ticket_pabuf);
1825 #define	V_ticket_pabuf			 VNET(ticket_pabuf)
1826 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
1827 #define	V_pf_altqs_active		 VNET(pf_altqs_active)
1828 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
1829 #define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
1830 VNET_DECLARE(struct pf_poolqueue *,	 pf_pools_active);
1831 #define	V_pf_pools_active		 VNET(pf_pools_active)
1832 VNET_DECLARE(struct pf_poolqueue *,	 pf_pools_inactive);
1833 #define	V_pf_pools_inactive		 VNET(pf_pools_inactive)
1834 #else
1835 extern u_int32_t		 ticket_altqs_active;
1836 extern u_int32_t		 ticket_altqs_inactive;
1837 extern int			 altqs_inactive_open;
1838 extern u_int32_t		 ticket_pabuf;
1839 extern struct pf_altqqueue	*pf_altqs_active;
1840 extern struct pf_altqqueue	*pf_altqs_inactive;
1841 extern struct pf_poolqueue	*pf_pools_active;
1842 extern struct pf_poolqueue	*pf_pools_inactive;
1843 #endif
1844 extern int			 pf_tbladdr_setup(struct pf_ruleset *,
1845 				    struct pf_addr_wrap *);
1846 extern void			 pf_tbladdr_remove(struct pf_addr_wrap *);
1847 extern void			 pf_tbladdr_copyout(struct pf_addr_wrap *);
1848 extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1849 #ifdef __FreeBSD__
1850 #ifdef ALTQ
1851 extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
1852 #endif
1853 VNET_DECLARE(uma_zone_t,		 pf_src_tree_pl);
1854 #define	V_pf_src_tree_pl		 VNET(pf_src_tree_pl)
1855 VNET_DECLARE(uma_zone_t,		 pf_rule_pl);
1856 #define	V_pf_rule_pl			 VNET(pf_rule_pl)
1857 VNET_DECLARE(uma_zone_t,		 pf_state_pl);
1858 #define	V_pf_state_pl			 VNET(pf_state_pl)
1859 VNET_DECLARE(uma_zone_t,		 pf_state_key_pl);
1860 #define	V_pf_state_key_pl		 VNET(pf_state_key_pl)
1861 VNET_DECLARE(uma_zone_t,		 pf_state_item_pl);
1862 #define	V_pf_state_item_pl		 VNET(pf_state_item_pl)
1863 VNET_DECLARE(uma_zone_t,		 pf_altq_pl);
1864 #define	V_pf_altq_pl			 VNET(pf_altq_pl)
1865 VNET_DECLARE(uma_zone_t,		 pf_pooladdr_pl);
1866 #define	V_pf_pooladdr_pl		 VNET(pf_pooladdr_pl)
1867 VNET_DECLARE(uma_zone_t,		 pfr_ktable_pl);
1868 #define	V_pfr_ktable_pl			 VNET(pfr_ktable_pl)
1869 VNET_DECLARE(uma_zone_t,		 pfr_kentry_pl);
1870 #define	V_pfr_kentry_pl			 VNET(pfr_kentry_pl)
1871 VNET_DECLARE(uma_zone_t,		 pfr_kcounters_pl);
1872 #define	V_pfr_kcounters_pl		 VNET(pfr_kcounters_pl)
1873 VNET_DECLARE(uma_zone_t,		 pf_cache_pl);
1874 #define	V_pf_cache_pl			 VNET(pf_cache_pl)
1875 VNET_DECLARE(uma_zone_t,		 pf_cent_pl);
1876 #define	V_pf_cent_pl			 VNET(pf_cent_pl)
1877 VNET_DECLARE(uma_zone_t,		 pf_state_scrub_pl);
1878 #define	V_pf_state_scrub_pl		 VNET(pf_state_scrub_pl)
1879 VNET_DECLARE(uma_zone_t,		 pfi_addr_pl);
1880 #define	V_pfi_addr_pl			 VNET(pfi_addr_pl)
1881 #else
1882 extern struct pool		 pf_src_tree_pl, pf_rule_pl;
1883 extern struct pool		 pf_state_pl, pf_state_key_pl, pf_state_item_pl,
1884 				    pf_altq_pl, pf_pooladdr_pl;
1885 extern struct pool		 pf_state_scrub_pl;
1886 #endif
1887 extern void			 pf_purge_thread(void *);
1888 #ifdef __FreeBSD__
1889 extern int			 pf_purge_expired_src_nodes(int);
1890 extern int			 pf_purge_expired_states(u_int32_t , int);
1891 #else
1892 extern void			 pf_purge_expired_src_nodes(int);
1893 extern void			 pf_purge_expired_states(u_int32_t);
1894 #endif
1895 extern void			 pf_unlink_state(struct pf_state *);
1896 extern void			 pf_free_state(struct pf_state *);
1897 extern int			 pf_state_insert(struct pfi_kif *,
1898 				    struct pf_state_key *,
1899 				    struct pf_state_key *,
1900 				    struct pf_state *);
1901 extern int			 pf_insert_src_node(struct pf_src_node **,
1902 				    struct pf_rule *, struct pf_addr *,
1903 				    sa_family_t);
1904 void				 pf_src_tree_remove_state(struct pf_state *);
1905 extern struct pf_state		*pf_find_state_byid(struct pf_state_cmp *);
1906 extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1907 				    u_int, int *);
1908 extern void			 pf_print_state(struct pf_state *);
1909 extern void			 pf_print_flags(u_int8_t);
1910 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1911 				    u_int8_t);
1912 extern u_int16_t		 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1913 				    u_int16_t, u_int16_t, u_int8_t);
1914 
1915 #ifdef __FreeBSD__
1916 VNET_DECLARE(struct ifnet *,		 sync_ifp);
1917 #define	V_sync_ifp		 	 VNET(sync_ifp);
1918 VNET_DECLARE(struct pf_rule,		 pf_default_rule);
1919 #define	V_pf_default_rule		  VNET(pf_default_rule)
1920 #else
1921 extern struct ifnet		*sync_ifp;
1922 extern struct pf_rule		 pf_default_rule;
1923 #endif
1924 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1925 				    u_int8_t);
1926 void				 pf_rm_rule(struct pf_rulequeue *,
1927 				    struct pf_rule *);
1928 #ifndef __FreeBSD__
1929 struct pf_divert		*pf_find_divert(struct mbuf *);
1930 #endif
1931 
1932 #ifdef INET
1933 #ifdef __FreeBSD__
1934 int	pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *,
1935     struct inpcb *);
1936 #else
1937 int	pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *);
1938 #endif
1939 #endif /* INET */
1940 
1941 #ifdef INET6
1942 #ifdef __FreeBSD__
1943 int	pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *,
1944     struct inpcb *);
1945 #else
1946 int	pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *);
1947 #endif
1948 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1949 	    struct pf_addr *, struct pf_addr *, u_int8_t);
1950 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1951 #endif /* INET6 */
1952 
1953 #ifdef __FreeBSD__
1954 u_int32_t	pf_new_isn(struct pf_state *);
1955 #endif
1956 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1957 	    sa_family_t);
1958 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1959 void	pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1960 	    u_int8_t);
1961 void	pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1962 int	pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1963 	    u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *,
1964 	    struct pf_pdesc *);
1965 void	pf_send_deferred_syn(struct pf_state *);
1966 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1967 	    struct pf_addr *, sa_family_t);
1968 int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1969 	    struct pf_addr *, sa_family_t);
1970 int	pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1971 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1972 int	pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1973 int	pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1974 
1975 void	pf_normalize_init(void);
1976 int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1977 	    struct pf_pdesc *);
1978 int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1979 	    struct pf_pdesc *);
1980 int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1981 	    struct pf_pdesc *);
1982 void	pf_normalize_tcp_cleanup(struct pf_state *);
1983 int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1984 	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1985 int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1986 	    u_short *, struct tcphdr *, struct pf_state *,
1987 	    struct pf_state_peer *, struct pf_state_peer *, int *);
1988 u_int32_t
1989 	pf_state_expires(const struct pf_state *);
1990 void	pf_purge_expired_fragments(void);
1991 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1992 	    int);
1993 int	pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *,
1994 	    int);
1995 #ifdef __FreeBSD__
1996 int	pf_socket_lookup(int, struct pf_pdesc *,  struct inpcb *);
1997 #else
1998 int	pf_socket_lookup(int, struct pf_pdesc *);
1999 #endif
2000 struct pf_state_key *pf_alloc_state_key(int);
2001 void	pf_pkt_addr_changed(struct mbuf *);
2002 int	pf_state_key_attach(struct pf_state_key *, struct pf_state *, int);
2003 void	pfr_initialize(void);
2004 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
2005 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
2006 	    u_int64_t, int, int, int);
2007 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
2008 	    struct pf_addr **, struct pf_addr **, sa_family_t);
2009 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
2010 struct pfr_ktable *
2011 	pfr_attach_table(struct pf_ruleset *, char *, int);
2012 void	pfr_detach_table(struct pfr_ktable *);
2013 int	pfr_clr_tables(struct pfr_table *, int *, int);
2014 int	pfr_add_tables(struct pfr_table *, int, int *, int);
2015 int	pfr_del_tables(struct pfr_table *, int, int *, int);
2016 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
2017 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
2018 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
2019 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
2020 int	pfr_clr_addrs(struct pfr_table *, int *, int);
2021 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
2022 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2023 	    int);
2024 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2025 	    int);
2026 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2027 	    int *, int *, int *, int, u_int32_t);
2028 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
2029 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
2030 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
2031 	    int);
2032 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2033 	    int);
2034 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
2035 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
2036 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
2037 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
2038 	    int *, u_int32_t, int);
2039 
2040 #ifdef __FreeBSD__
2041 VNET_DECLARE(struct pfi_kif *,		 pfi_all);
2042 #define	V_pfi_all	 		 VNET(pfi_all)
2043 #else
2044 extern struct pfi_kif		*pfi_all;
2045 #endif
2046 
2047 void		 pfi_initialize(void);
2048 #ifdef __FreeBSD__
2049 void		 pfi_cleanup(void);
2050 #endif
2051 struct pfi_kif	*pfi_kif_get(const char *);
2052 void		 pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
2053 void		 pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
2054 int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
2055 void		 pfi_attach_ifnet(struct ifnet *);
2056 void		 pfi_detach_ifnet(struct ifnet *);
2057 void		 pfi_attach_ifgroup(struct ifg_group *);
2058 void		 pfi_detach_ifgroup(struct ifg_group *);
2059 void		 pfi_group_change(const char *);
2060 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
2061 		    sa_family_t);
2062 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
2063 void		 pfi_dynaddr_remove(struct pf_addr_wrap *);
2064 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
2065 void		 pfi_update_status(const char *, struct pf_status *);
2066 int		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
2067 int		 pfi_set_flags(const char *, int);
2068 int		 pfi_clear_flags(const char *, int);
2069 
2070 #ifdef __FreeBSD__
2071 int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *,
2072 		    struct pf_mtag *);
2073 #else
2074 int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *);
2075 #endif
2076 u_int16_t	 pf_tagname2tag(char *);
2077 void		 pf_tag2tagname(u_int16_t, char *);
2078 void		 pf_tag_ref(u_int16_t);
2079 void		 pf_tag_unref(u_int16_t);
2080 #ifdef __FreeBSD__
2081 int		 pf_tag_packet(struct mbuf *, int, int, struct pf_mtag *);
2082 #else
2083 int		 pf_tag_packet(struct mbuf *, int, int);
2084 #endif
2085 u_int32_t	 pf_qname2qid(char *);
2086 void		 pf_qid2qname(u_int32_t, char *);
2087 void		 pf_qid_unref(u_int32_t);
2088 
2089 #ifdef __FreeBSD__
2090 VNET_DECLARE(struct pf_status,		 pf_status);
2091 #define	V_pf_status			 VNET(pf_status)
2092 #else
2093 extern struct pf_status	pf_status;
2094 #endif
2095 
2096 #ifdef __FreeBSD__
2097 VNET_DECLARE(uma_zone_t,		 pf_frent_pl);
2098 #define	V_pf_frent_pl			 VNET(pf_frent_pl)
2099 VNET_DECLARE(uma_zone_t,		 pf_frag_pl);
2100 #define	V_pf_frag_pl			 VNET(pf_frag_pl)
2101 VNET_DECLARE(struct sx,			 pf_consistency_lock);
2102 #define	V_pf_consistency_lock		 VNET(pf_consistency_lock)
2103 #else
2104 extern struct pool	pf_frent_pl, pf_frag_pl;
2105 extern struct rwlock	pf_consistency_lock;
2106 #endif
2107 
2108 struct pf_pool_limit {
2109 	void		*pp;
2110 	unsigned	 limit;
2111 };
2112 #ifdef __FreeBSD__
2113 VNET_DECLARE(struct pf_pool_limit,		 pf_pool_limits[PF_LIMIT_MAX]);
2114 #define	V_pf_pool_limits			 VNET(pf_pool_limits)
2115 #else
2116 extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
2117 #endif
2118 
2119 #ifdef __FreeBSD__
2120 struct pf_frent {
2121 	LIST_ENTRY(pf_frent) fr_next;
2122 	struct ip *fr_ip;
2123 	struct mbuf *fr_m;
2124 };
2125 
2126 struct pf_frcache {
2127 	LIST_ENTRY(pf_frcache) fr_next;
2128 	uint16_t		fr_off;
2129 	uint16_t		fr_end;
2130 };
2131 
2132 struct pf_fragment {
2133 	RB_ENTRY(pf_fragment) fr_entry;
2134 	TAILQ_ENTRY(pf_fragment) frag_next;
2135 	struct in_addr	fr_src;
2136 	struct in_addr	fr_dst;
2137 	u_int8_t	fr_p;		/* protocol of this fragment */
2138 	u_int8_t	fr_flags;	/* status flags */
2139 	u_int16_t	fr_id;		/* fragment id for reassemble */
2140 	u_int16_t	fr_max;		/* fragment data max */
2141 	u_int32_t	fr_timeout;
2142 #define	fr_queue	fr_u.fru_queue
2143 #define	fr_cache	fr_u.fru_cache
2144 	union {
2145 		LIST_HEAD(pf_fragq, pf_frent) fru_queue;	/* buffering */
2146 		LIST_HEAD(pf_cacheq, pf_frcache) fru_cache;	/* non-buf */
2147 	} fr_u;
2148 };
2149 #endif /* (__FreeBSD__) */
2150 
2151 #endif /* _KERNEL */
2152 
2153 #ifdef __FreeBSD__
2154 #ifdef _KERNEL
2155 VNET_DECLARE(struct pf_anchor_global,		 pf_anchors);
2156 #define	V_pf_anchors				 VNET(pf_anchors)
2157 VNET_DECLARE(struct pf_anchor,			 pf_main_anchor);
2158 #define	V_pf_main_anchor			 VNET(pf_main_anchor)
2159 #define pf_main_ruleset	V_pf_main_anchor.ruleset
2160 #endif
2161 #else
2162 extern struct pf_anchor_global	pf_anchors;
2163 extern struct pf_anchor		pf_main_anchor;
2164 #define pf_main_ruleset	pf_main_anchor.ruleset
2165 #endif
2166 
2167 /* these ruleset functions can be linked into userland programs (pfctl) */
2168 int			 pf_get_ruleset_number(u_int8_t);
2169 void			 pf_init_ruleset(struct pf_ruleset *);
2170 int			 pf_anchor_setup(struct pf_rule *,
2171 			    const struct pf_ruleset *, const char *);
2172 int			 pf_anchor_copyout(const struct pf_ruleset *,
2173 			    const struct pf_rule *, struct pfioc_rule *);
2174 void			 pf_anchor_remove(struct pf_rule *);
2175 void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
2176 struct pf_anchor	*pf_find_anchor(const char *);
2177 struct pf_ruleset	*pf_find_ruleset(const char *);
2178 struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
2179 void			 pf_rs_initialize(void);
2180 
2181 #ifndef __FreeBSD__
2182 #ifdef _KERNEL
2183 int			 pf_anchor_copyout(const struct pf_ruleset *,
2184 			    const struct pf_rule *, struct pfioc_rule *);
2185 void			 pf_anchor_remove(struct pf_rule *);
2186 
2187 #endif /* _KERNEL */
2188 #endif
2189 
2190 /* The fingerprint functions can be linked into userland programs (tcpdump) */
2191 int	pf_osfp_add(struct pf_osfp_ioctl *);
2192 #ifdef _KERNEL
2193 struct pf_osfp_enlist *
2194 	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
2195 	    const struct tcphdr *);
2196 #endif /* _KERNEL */
2197 struct pf_osfp_enlist *
2198 	pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
2199 	    const struct tcphdr *);
2200 void	pf_osfp_flush(void);
2201 int	pf_osfp_get(struct pf_osfp_ioctl *);
2202 #ifdef __FreeBSD__
2203 int	pf_osfp_initialize(void);
2204 void	pf_osfp_cleanup(void);
2205 #else
2206 void	pf_osfp_initialize(void);
2207 #endif
2208 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
2209 struct pf_os_fingerprint *
2210 	pf_osfp_validate(void);
2211 
2212 #ifdef _KERNEL
2213 void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
2214 
2215 void			 pf_step_into_anchor(int *, struct pf_ruleset **, int,
2216 			    struct pf_rule **, struct pf_rule **, int *);
2217 int			 pf_step_out_of_anchor(int *, struct pf_ruleset **,
2218 			    int, struct pf_rule **, struct pf_rule **,
2219 			    int *);
2220 
2221 int			 pf_map_addr(u_int8_t, struct pf_rule *,
2222 			    struct pf_addr *, struct pf_addr *,
2223 			    struct pf_addr *, struct pf_src_node **);
2224 struct pf_rule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
2225 			    int, int, struct pfi_kif *, struct pf_src_node **,
2226 			    struct pf_state_key **, struct pf_state_key **,
2227 			    struct pf_state_key **, struct pf_state_key **,
2228 			    struct pf_addr *, struct pf_addr *,
2229 			    u_int16_t, u_int16_t);
2230 
2231 int			 pf_state_key_setup(struct pf_pdesc *, struct pf_rule *,
2232 			    struct pf_state_key **, struct pf_state_key **,
2233 			    struct pf_state_key **, struct pf_state_key **,
2234 			    struct pf_addr *, struct pf_addr *,
2235 			    u_int16_t, u_int16_t);
2236 #endif /* _KERNEL */
2237 
2238 
2239 #endif /* _NET_PFVAR_H_ */
2240