1 /*
2  * Copyright (c) 2007-2014 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 /*	$apfw: git commit b6bf13f8321283cd7ee82b1795e86506084b1b95 $ */
30 /*	$OpenBSD: pfvar.h,v 1.259 2007/12/02 12:08:04 pascoe Exp $ */
31 
32 /*
33  * Copyright (c) 2001 Daniel Hartmeier
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  *
40  *    - Redistributions of source code must retain the above copyright
41  *      notice, this list of conditions and the following disclaimer.
42  *    - Redistributions in binary form must reproduce the above
43  *      copyright notice, this list of conditions and the following
44  *      disclaimer in the documentation and/or other materials provided
45  *      with the distribution.
46  *
47  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
48  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
49  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
50  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
51  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
52  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
53  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
54  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
55  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
57  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
58  * POSSIBILITY OF SUCH DAMAGE.
59  *
60  */
61 
62 #ifndef _NET_PFVAR_H_
63 #define _NET_PFVAR_H_
64 
65 #ifdef PRIVATE
66 /*
67  * XXX
68  * XXX Private interfaces.  Do not include this file; use pfctl(8) instead.
69  * XXX
70  */
71 #if PF || !defined(KERNEL)
72 
73 #ifdef  __cplusplus
74 extern "C" {
75 #endif
76 
77 #include <stdbool.h>
78 #include <sys/param.h>
79 #include <sys/types.h>
80 #include <sys/queue.h>
81 #include <libkern/tree.h>
82 
83 #include <net/radix.h>
84 #include <netinet/in.h>
85 
86 #ifdef KERNEL
87 #include <kern/kern_types.h>
88 #include <kern/zalloc.h>
89 #include <kern/locks.h>
90 
91 #include <machine/endian.h>
92 #include <sys/systm.h>
93 
94 #if BYTE_ORDER == BIG_ENDIAN
95 #define	htobe64(x)	(x)
96 #else /* LITTLE ENDIAN */
97 #define	htobe64(x)	__DARWIN_OSSwapInt64(x)
98 #endif /* LITTLE_ENDIAN */
99 
100 #define	be64toh(x)	htobe64(x)
101 
102 extern lck_rw_t *pf_perim_lock;
103 extern lck_mtx_t *pf_lock;
104 
105 struct pool {
106 	struct zone	*pool_zone;	/* pointer to backend zone */
107 	const char	*pool_name;	/* name of pool */
108 	unsigned int	pool_count;	/* # of outstanding elements */
109 	unsigned int	pool_hiwat;	/* high watermark */
110 	unsigned int	pool_limit;	/* hard limit */
111 	unsigned int	pool_fails;	/* # of failed allocs due to limit */
112 };
113 
114 #define	PR_NOWAIT	FALSE
115 #define	PR_WAITOK	TRUE
116 
117 __private_extern__ void pool_init(struct pool *, size_t, unsigned int,
118     unsigned int, int, const char *, void *);
119 __private_extern__ void pool_destroy(struct pool *);
120 __private_extern__ void pool_sethiwat(struct pool *, int);
121 __private_extern__ void pool_sethardlimit(struct pool *, int,
122     const char *, int);
123 __private_extern__ void *pool_get(struct pool *, int);
124 __private_extern__ void pool_put(struct pool *, void *);
125 __private_extern__ u_int64_t pf_time_second(void);
126 __private_extern__ u_int64_t pf_calendar_time_second(void);
127 #endif /* KERNEL */
128 
129 union sockaddr_union {
130 	struct sockaddr		sa;
131 	struct sockaddr_in	sin;
132 	struct sockaddr_in6	sin6;
133 };
134 
135 #define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
136 #define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
137 
138 #define	PF_MD5_DIGEST_LENGTH	16
139 #ifdef MD5_DIGEST_LENGTH
140 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
141 #error
142 #endif /* PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH */
143 #endif /* MD5_DIGEST_LENGTH */
144 
145 #ifdef KERNEL
146 struct ip;
147 struct ip6_hdr;
148 struct tcphdr;
149 struct pf_grev1_hdr;
150 struct pf_esp_hdr;
151 #endif /* KERNEL */
152 
153 #define PF_GRE_PPTP_VARIANT	0x01
154 
155 enum	{ PF_INOUT, PF_IN, PF_OUT };
156 enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
157 	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP,
158 	  PF_DUMMYNET, PF_NODUMMYNET };
159 enum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
160 	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_DUMMYNET,
161 	  PF_RULESET_MAX };
162 enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
163 	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
164 enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
165 enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
166 	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
167 	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
168 enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
169 
170 /*
171  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
172  * PFTM_MAX, special cases afterwards. See pf_state_expires().
173  */
174 enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
175 	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
176 	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
177 	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
178 	  PFTM_GREv1_FIRST_PACKET, PFTM_GREv1_INITIATING,
179 	  PFTM_GREv1_ESTABLISHED, PFTM_ESP_FIRST_PACKET, PFTM_ESP_INITIATING,
180 	  PFTM_ESP_ESTABLISHED, PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
181 	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
182 	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
183 	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED };
184 
185 /* PFTM default values */
186 #define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
187 #define PFTM_TCP_OPENING_VAL		30	/* No response yet */
188 #define PFTM_TCP_ESTABLISHED_VAL	(24 * 60 * 60)	/* Established */
189 #define PFTM_TCP_CLOSING_VAL		(15 * 60)	/* Half closed */
190 #define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
191 #define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
192 #define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
193 #define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
194 #define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
195 #define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
196 #define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
197 #define PFTM_GREv1_FIRST_PACKET_VAL	120
198 #define PFTM_GREv1_INITIATING_VAL	30
199 #define PFTM_GREv1_ESTABLISHED_VAL	1800
200 #define PFTM_ESP_FIRST_PACKET_VAL	120
201 #define PFTM_ESP_INITIATING_VAL		30
202 #define PFTM_ESP_ESTABLISHED_VAL	900
203 #define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
204 #define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
205 #define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
206 #define PFTM_FRAG_VAL			30	/* Fragment expire */
207 #define PFTM_INTERVAL_VAL		10	/* Expire interval */
208 #define PFTM_SRC_NODE_VAL		0	/* Source tracking */
209 #define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
210 
211 enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
212 enum	{ PF_LIMIT_STATES,
213 	  PF_LIMIT_APP_STATES,
214 	  PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
215 	  PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
216 #define PF_POOL_IDMASK		0x0f
217 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
218 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
219 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
220 	  PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED,
221 	  PF_ADDR_RANGE };
222 #define PF_POOL_TYPEMASK	0x0f
223 #define PF_POOL_STICKYADDR	0x20
224 #define	PF_WSCALE_FLAG		0x80
225 #define	PF_WSCALE_MASK		0x0f
226 
227 #define	PF_LOG			0x01
228 #define	PF_LOG_ALL		0x02
229 #define	PF_LOG_SOCKET_LOOKUP	0x04
230 
231 struct pf_addr {
232 	union {
233 		struct in_addr		v4;
234 		struct in6_addr		v6;
235 		u_int8_t		addr8[16];
236 		u_int16_t		addr16[8];
237 		u_int32_t		addr32[4];
238 	} pfa;		    /* 128-bit address */
239 #define v4	pfa.v4
240 #define v6	pfa.v6
241 #define addr8	pfa.addr8
242 #define addr16	pfa.addr16
243 #define addr32	pfa.addr32
244 };
245 
246 #define	PF_TABLE_NAME_SIZE	 32
247 
248 #define PFI_AFLAG_NETWORK	0x01
249 #define PFI_AFLAG_BROADCAST	0x02
250 #define PFI_AFLAG_PEER		0x04
251 #define PFI_AFLAG_MODEMASK	0x07
252 #define PFI_AFLAG_NOALIAS	0x08
253 
254 #ifndef RTLABEL_LEN
255 #define RTLABEL_LEN 32
256 #endif
257 
258 struct pf_addr_wrap {
259 	union {
260 		struct {
261 			struct pf_addr		 addr;
262 			struct pf_addr		 mask;
263 		}			 a;
264 		char			 ifname[IFNAMSIZ];
265 		char			 tblname[PF_TABLE_NAME_SIZE];
266 		char			 rtlabelname[RTLABEL_LEN];
267 		u_int32_t		 rtlabel;
268 	}			 v;
269 	union {
270 #ifdef KERNEL
271 		struct pfi_dynaddr	*dyn	__attribute__((aligned(8)));
272 		struct pfr_ktable	*tbl	__attribute__((aligned(8)));
273 #else /* !KERNEL */
274 		void			*dyn	__attribute__((aligned(8)));
275 		void			*tbl	__attribute__((aligned(8)));
276 #endif /* !KERNEL */
277 		int			 dyncnt __attribute__((aligned(8)));
278 		int			 tblcnt __attribute__((aligned(8)));
279 	}			 p __attribute__((aligned(8)));
280 	u_int8_t		 type;		/* PF_ADDR_* */
281 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
282 };
283 
284 struct pf_port_range {
285 	u_int16_t			port[2];
286 	u_int8_t			op;
287 };
288 
289 union pf_rule_xport {
290 	struct pf_port_range	range;
291 	u_int16_t		call_id;
292 	u_int32_t		spi;
293 };
294 
295 #ifdef KERNEL
296 struct pfi_dynaddr {
297 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
298 	struct pf_addr			 pfid_addr4;
299 	struct pf_addr			 pfid_mask4;
300 	struct pf_addr			 pfid_addr6;
301 	struct pf_addr			 pfid_mask6;
302 	struct pfr_ktable		*pfid_kt;
303 	struct pfi_kif			*pfid_kif;
304 	void				*pfid_hook_cookie;
305 	int				 pfid_net;	/* mask or 128 */
306 	int				 pfid_acnt4;	/* address count IPv4 */
307 	int				 pfid_acnt6;	/* address count IPv6 */
308 	sa_family_t			 pfid_af;	/* rule af */
309 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
310 };
311 
312 /*
313  * Address manipulation macros
314  */
315 
316 #if INET
317 #if !INET6
318 #define PF_INET_ONLY
319 #endif /* ! INET6 */
320 #endif /* INET */
321 
322 #if INET6
323 #if !INET
324 #define PF_INET6_ONLY
325 #endif /* ! INET */
326 #endif /* INET6 */
327 
328 #if INET
329 #if INET6
330 #define PF_INET_INET6
331 #endif /* INET6 */
332 #endif /* INET */
333 
334 #else /* !KERNEL */
335 
336 #define PF_INET_INET6
337 
338 #endif /* !KERNEL */
339 
340 /* Both IPv4 and IPv6 */
341 #ifdef PF_INET_INET6
342 
343 #define PF_AEQ(a, b, c) \
344 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
345 	((a)->addr32[3] == (b)->addr32[3] && \
346 	(a)->addr32[2] == (b)->addr32[2] && \
347 	(a)->addr32[1] == (b)->addr32[1] && \
348 	(a)->addr32[0] == (b)->addr32[0])) \
349 
350 #define PF_ANEQ(a, b, c) \
351 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
352 	((a)->addr32[3] != (b)->addr32[3] || \
353 	(a)->addr32[2] != (b)->addr32[2] || \
354 	(a)->addr32[1] != (b)->addr32[1] || \
355 	(a)->addr32[0] != (b)->addr32[0])) \
356 
357 #define PF_ALEQ(a, b, c) \
358 	((c == AF_INET && (a)->addr32[0] <= (b)->addr32[0]) || \
359 	((a)->addr32[3] <= (b)->addr32[3] && \
360 	(a)->addr32[2] <= (b)->addr32[2] && \
361 	(a)->addr32[1] <= (b)->addr32[1] && \
362 	(a)->addr32[0] <= (b)->addr32[0])) \
363 
364 #define PF_AZERO(a, c) \
365 	((c == AF_INET && !(a)->addr32[0]) || \
366 	(!(a)->addr32[0] && !(a)->addr32[1] && \
367 	!(a)->addr32[2] && !(a)->addr32[3])) \
368 
369 #define PF_MATCHA(n, a, m, b, f) \
370 	pf_match_addr(n, a, m, b, f)
371 
372 #define PF_ACPY(a, b, f) \
373 	pf_addrcpy(a, b, f)
374 
375 #define PF_AINC(a, f) \
376 	pf_addr_inc(a, f)
377 
378 #define PF_POOLMASK(a, b, c, d, f) \
379 	pf_poolmask(a, b, c, d, f)
380 
381 #else
382 
383 /* Just IPv6 */
384 
385 #ifdef PF_INET6_ONLY
386 
387 #define PF_AEQ(a, b, c) \
388 	((a)->addr32[3] == (b)->addr32[3] && \
389 	(a)->addr32[2] == (b)->addr32[2] && \
390 	(a)->addr32[1] == (b)->addr32[1] && \
391 	(a)->addr32[0] == (b)->addr32[0]) \
392 
393 #define PF_ANEQ(a, b, c) \
394 	((a)->addr32[3] != (b)->addr32[3] || \
395 	(a)->addr32[2] != (b)->addr32[2] || \
396 	(a)->addr32[1] != (b)->addr32[1] || \
397 	(a)->addr32[0] != (b)->addr32[0]) \
398 
399 #define PF_ALEQ(a, b, c) \
400 	((a)->addr32[3] <= (b)->addr32[3] && \
401 	(a)->addr32[2] <= (b)->addr32[2] && \
402 	(a)->addr32[1] <= (b)->addr32[1] && \
403 	(a)->addr32[0] <= (b)->addr32[0]) \
404 
405 #define PF_AZERO(a, c) \
406 	(!(a)->addr32[0] && \
407 	!(a)->addr32[1] && \
408 	!(a)->addr32[2] && \
409 	!(a)->addr32[3]) \
410 
411 #define PF_MATCHA(n, a, m, b, f) \
412 	pf_match_addr(n, a, m, b, f)
413 
414 #define PF_ACPY(a, b, f) \
415 	pf_addrcpy(a, b, f)
416 
417 #define PF_AINC(a, f) \
418 	pf_addr_inc(a, f)
419 
420 #define PF_POOLMASK(a, b, c, d, f) \
421 	pf_poolmask(a, b, c, d, f)
422 
423 #else
424 
425 /* Just IPv4 */
426 #ifdef PF_INET_ONLY
427 
428 #define PF_AEQ(a, b, c) \
429 	((a)->addr32[0] == (b)->addr32[0])
430 
431 #define PF_ANEQ(a, b, c) \
432 	((a)->addr32[0] != (b)->addr32[0])
433 
434 #define PF_ALEQ(a, b, c) \
435 	((a)->addr32[0] <= (b)->addr32[0])
436 
437 #define PF_AZERO(a, c) \
438 	(!(a)->addr32[0])
439 
440 #define PF_MATCHA(n, a, m, b, f) \
441 	pf_match_addr(n, a, m, b, f)
442 
443 #define PF_ACPY(a, b, f) \
444 	(a)->v4.s_addr = (b)->v4.s_addr
445 
446 #define PF_AINC(a, f) \
447 	do { \
448 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
449 	} while (0)
450 
451 #define PF_POOLMASK(a, b, c, d, f) \
452 	do { \
453 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
454 		(((c)->addr32[0] ^ 0xffffffff) & (d)->addr32[0]); \
455 	} while (0)
456 
457 #endif /* PF_INET_ONLY */
458 #endif /* PF_INET6_ONLY */
459 #endif /* PF_INET_INET6 */
460 
461 #ifdef KERNEL
462 #define	PF_MISMATCHAW(aw, x, af, neg, ifp)				\
463 	(								\
464 		(((aw)->type == PF_ADDR_NOROUTE &&			\
465 		    pf_routable((x), (af), NULL)) ||			\
466 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
467 		    pf_routable((x), (af), (ifp))) ||			\
468 		((aw)->type == PF_ADDR_RTLABEL &&			\
469 		    !pf_rtlabel_match((x), (af), (aw))) ||		\
470 		((aw)->type == PF_ADDR_TABLE &&				\
471 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
472 		((aw)->type == PF_ADDR_DYNIFTL &&			\
473 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) || 	\
474 		((aw)->type == PF_ADDR_RANGE &&				\
475 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
476 		    &(aw)->v.a.mask, (x), (af))) || 			\
477 		((aw)->type == PF_ADDR_ADDRMASK &&			\
478 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
479 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
480 		    &(aw)->v.a.mask, (x), (af))))) !=			\
481 		(neg)							\
482 	)
483 #endif /* KERNEL */
484 
485 struct pf_rule_uid {
486 	uid_t		 uid[2];
487 	u_int8_t	 op;
488 	u_int8_t	 _pad[3];
489 };
490 
491 struct pf_rule_gid {
492 	uid_t		 gid[2];
493 	u_int8_t	 op;
494 	u_int8_t	 _pad[3];
495 };
496 
497 struct pf_rule_addr {
498 	struct pf_addr_wrap	 addr;
499 	union pf_rule_xport	 xport;
500 	u_int8_t		 neg;
501 };
502 
503 struct pf_pooladdr {
504 	struct pf_addr_wrap		 addr;
505 	TAILQ_ENTRY(pf_pooladdr)	 entries;
506 #if !defined(__LP64__)
507 	u_int32_t			 _pad[2];
508 #endif /* !__LP64__ */
509 	char				 ifname[IFNAMSIZ];
510 #ifdef KERNEL
511 	struct pfi_kif			*kif	__attribute__((aligned(8)));
512 #else /* !KERNEL */
513 	void				*kif	__attribute__((aligned(8)));
514 #endif /* !KERNEL */
515 };
516 
517 TAILQ_HEAD(pf_palist, pf_pooladdr);
518 
519 struct pf_poolhashkey {
520 	union {
521 		u_int8_t		key8[16];
522 		u_int16_t		key16[8];
523 		u_int32_t		key32[4];
524 	} pfk;		    /* 128-bit hash key */
525 #define key8	pfk.key8
526 #define key16	pfk.key16
527 #define key32	pfk.key32
528 };
529 
530 struct pf_pool {
531 	struct pf_palist	 list;
532 #if !defined(__LP64__)
533 	u_int32_t		 _pad[2];
534 #endif /* !__LP64__ */
535 #ifdef KERNEL
536 	struct pf_pooladdr	*cur		__attribute__((aligned(8)));
537 #else /* !KERNEL */
538 	void			*cur		__attribute__((aligned(8)));
539 #endif /* !KERNEL */
540 	struct pf_poolhashkey	 key		__attribute__((aligned(8)));
541 	struct pf_addr		 counter;
542 	int			 tblidx;
543 	u_int16_t		 proxy_port[2];
544 	u_int8_t		 port_op;
545 	u_int8_t		 opts;
546 };
547 
548 
549 /* A packed Operating System description for fingerprinting */
550 typedef u_int32_t pf_osfp_t;
551 #define PF_OSFP_ANY	((pf_osfp_t)0)
552 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
553 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
554 
555 struct pf_osfp_entry {
556 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
557 #if !defined(__LP64__)
558 	u_int32_t		_pad;
559 #endif /* !__LP64__ */
560 	pf_osfp_t		fp_os;
561 	int			fp_enflags;
562 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
563 #define PF_OSFP_GENERIC		0x002		/* generic signature */
564 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
565 #define PF_OSFP_LEN	32
566 	char			fp_class_nm[PF_OSFP_LEN];
567 	char			fp_version_nm[PF_OSFP_LEN];
568 	char			fp_subtype_nm[PF_OSFP_LEN];
569 };
570 #define PF_OSFP_ENTRY_EQ(a, b) \
571     ((a)->fp_os == (b)->fp_os && \
572     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
573     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
574     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
575 
576 /* handle pf_osfp_t packing */
577 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
578 #define _FP_UNUSED_BITS		1
579 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
580 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
581 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
582 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
583 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
584 	    ((1 << _FP_CLASS_BITS) - 1); \
585 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
586 	    ((1 << _FP_VERSION_BITS) - 1);\
587 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
588 } while (0)
589 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
590 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
591 	    + _FP_SUBTYPE_BITS); \
592 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
593 	    _FP_SUBTYPE_BITS; \
594 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
595 } while (0)
596 
597 /* the fingerprint of an OSes TCP SYN packet */
598 typedef u_int64_t	pf_tcpopts_t;
599 struct pf_os_fingerprint {
600 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
601 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
602 	u_int16_t		fp_wsize;	/* TCP window size */
603 	u_int16_t		fp_psize;	/* ip->ip_len */
604 	u_int16_t		fp_mss;		/* TCP MSS */
605 	u_int16_t		fp_flags;
606 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
607 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
608 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
609 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
610 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
611 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
612 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
613 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
614 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
615 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
616 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
617 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
618 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
619 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
620 #define PF_OSFP_INET6		0x4000		/* IPv6 */
621 	u_int8_t		fp_optcnt;	/* TCP option count */
622 	u_int8_t		fp_wscale;	/* TCP window scaling */
623 	u_int8_t		fp_ttl;		/* IPv4 TTL */
624 #define PF_OSFP_MAXTTL_OFFSET	40
625 /* TCP options packing */
626 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
627 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
628 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
629 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
630 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
631 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
632 #define PF_OSFP_MAX_OPTS \
633     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
634     / PF_OSFP_TCPOPT_BITS
635 
636 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
637 };
638 
639 struct pf_osfp_ioctl {
640 	struct pf_osfp_entry	fp_os;
641 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
642 	u_int16_t		fp_wsize;	/* TCP window size */
643 	u_int16_t		fp_psize;	/* ip->ip_len */
644 	u_int16_t		fp_mss;		/* TCP MSS */
645 	u_int16_t		fp_flags;
646 	u_int8_t		fp_optcnt;	/* TCP option count */
647 	u_int8_t		fp_wscale;	/* TCP window scaling */
648 	u_int8_t		fp_ttl;		/* IPv4 TTL */
649 
650 	int			fp_getnum;	/* DIOCOSFPGET number */
651 };
652 
653 
654 union pf_rule_ptr {
655 	struct pf_rule		*ptr		__attribute__((aligned(8)));
656 	u_int32_t		 nr		__attribute__((aligned(8)));
657 } __attribute__((aligned(8)));
658 
659 #define	PF_ANCHOR_NAME_SIZE	 64
660 
661 struct pf_rule {
662 	struct pf_rule_addr	 src;
663 	struct pf_rule_addr	 dst;
664 #define PF_SKIP_IFP		0
665 #define PF_SKIP_DIR		1
666 #define PF_SKIP_AF		2
667 #define PF_SKIP_PROTO		3
668 #define PF_SKIP_SRC_ADDR	4
669 #define PF_SKIP_SRC_PORT	5
670 #define PF_SKIP_DST_ADDR	6
671 #define PF_SKIP_DST_PORT	7
672 #define PF_SKIP_COUNT		8
673 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
674 #define PF_RULE_LABEL_SIZE	 64
675 	char			 label[PF_RULE_LABEL_SIZE];
676 #define PF_QNAME_SIZE		 64
677 	char			 ifname[IFNAMSIZ];
678 	char			 qname[PF_QNAME_SIZE];
679 	char			 pqname[PF_QNAME_SIZE];
680 #define	PF_TAG_NAME_SIZE	 64
681 	char			 tagname[PF_TAG_NAME_SIZE];
682 	char			 match_tagname[PF_TAG_NAME_SIZE];
683 
684 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
685 
686 	TAILQ_ENTRY(pf_rule)	 entries;
687 #if !defined(__LP64__)
688 	u_int32_t		 _pad[2];
689 #endif /* !__LP64__ */
690 	struct pf_pool		 rpool;
691 
692 	u_int64_t		 evaluations;
693 	u_int64_t		 packets[2];
694 	u_int64_t		 bytes[2];
695 
696 	u_int64_t		 ticket;
697 #define PF_OWNER_NAME_SIZE	 64
698 	char			 owner[PF_OWNER_NAME_SIZE];
699 	u_int32_t		 priority;
700 
701 #ifdef KERNEL
702 	struct pfi_kif		*kif		__attribute__((aligned(8)));
703 #else /* !KERNEL */
704 	void			*kif		__attribute__((aligned(8)));
705 #endif /* !KERNEL */
706 	struct pf_anchor	*anchor		__attribute__((aligned(8)));
707 #ifdef KERNEL
708 	struct pfr_ktable	*overload_tbl	__attribute__((aligned(8)));
709 #else /* !KERNEL */
710 	void			*overload_tbl	__attribute__((aligned(8)));
711 #endif /* !KERNEL */
712 
713 	pf_osfp_t		 os_fingerprint	__attribute__((aligned(8)));
714 
715 	unsigned int		 rtableid;
716 	u_int32_t		 timeout[PFTM_MAX];
717 	u_int32_t		 states;
718 	u_int32_t		 max_states;
719 	u_int32_t		 src_nodes;
720 	u_int32_t		 max_src_nodes;
721 	u_int32_t		 max_src_states;
722 	u_int32_t		 max_src_conn;
723 	struct {
724 		u_int32_t		limit;
725 		u_int32_t		seconds;
726 	}			 max_src_conn_rate;
727 	u_int32_t		 qid;
728 	u_int32_t		 pqid;
729 	u_int32_t		 rt_listid;
730 	u_int32_t		 nr;
731 	u_int32_t		 prob;
732 	uid_t			 cuid;
733 	pid_t			 cpid;
734 
735 	u_int16_t		 return_icmp;
736 	u_int16_t		 return_icmp6;
737 	u_int16_t		 max_mss;
738 	u_int16_t		 tag;
739 	u_int16_t		 match_tag;
740 
741 	struct pf_rule_uid	 uid;
742 	struct pf_rule_gid	 gid;
743 
744 	u_int32_t		 rule_flag;
745 	u_int8_t		 action;
746 	u_int8_t		 direction;
747 	u_int8_t		 log;
748 	u_int8_t		 logif;
749 	u_int8_t		 quick;
750 	u_int8_t		 ifnot;
751 	u_int8_t		 match_tag_not;
752 	u_int8_t		 natpass;
753 
754 #define PF_STATE_NORMAL		0x1
755 #define PF_STATE_MODULATE	0x2
756 #define PF_STATE_SYNPROXY	0x3
757 	u_int8_t		 keep_state;
758 	sa_family_t		 af;
759 	u_int8_t		 proto;
760 	u_int8_t		 type;
761 	u_int8_t		 code;
762 	u_int8_t		 flags;
763 	u_int8_t		 flagset;
764 	u_int8_t		 min_ttl;
765 	u_int8_t		 allow_opts;
766 	u_int8_t		 rt;
767 	u_int8_t		 return_ttl;
768 
769 /* service class categories */
770 #define	SCIDX_MASK		0x0f
771 #define	SC_BE			0x10
772 #define	SC_BK_SYS		0x11
773 #define	SC_BK			0x12
774 #define	SC_RD			0x13
775 #define	SC_OAM			0x14
776 #define	SC_AV			0x15
777 #define	SC_RV			0x16
778 #define	SC_VI			0x17
779 #define	SC_VO			0x18
780 #define	SC_CTL			0x19
781 
782 /* diffserve code points */
783 #define	DSCP_MASK		0xfc
784 #define	DSCP_CUMASK		0x03
785 #define	DSCP_EF			0xb8
786 #define	DSCP_AF11		0x28
787 #define	DSCP_AF12		0x30
788 #define	DSCP_AF13		0x38
789 #define	DSCP_AF21		0x48
790 #define	DSCP_AF22		0x50
791 #define	DSCP_AF23		0x58
792 #define	DSCP_AF31		0x68
793 #define	DSCP_AF32		0x70
794 #define	DSCP_AF33		0x78
795 #define	DSCP_AF41		0x88
796 #define	DSCP_AF42		0x90
797 #define	DSCP_AF43		0x98
798 #define	AF_CLASSMASK		0xe0
799 #define	AF_DROPPRECMASK		0x18
800 	u_int8_t		 tos;
801 	u_int8_t		 anchor_relative;
802 	u_int8_t		 anchor_wildcard;
803 
804 #define PF_FLUSH		0x01
805 #define PF_FLUSH_GLOBAL		0x02
806 	u_int8_t		 flush;
807 
808 	u_int8_t		proto_variant;
809 	u_int8_t		extfilter; /* Filter mode [PF_EXTFILTER_xxx] */
810 	u_int8_t		extmap;    /* Mapping mode [PF_EXTMAP_xxx] */
811 	u_int32_t               dnpipe;
812 	u_int32_t               dntype;
813 };
814 
815 /* pf device identifiers */
816 #define PFDEV_PF		0
817 #define PFDEV_PFM		1
818 #define PFDEV_MAX		2
819 
820 /* rule flags */
821 #define	PFRULE_DROP		0x0000
822 #define	PFRULE_RETURNRST	0x0001
823 #define	PFRULE_FRAGMENT		0x0002
824 #define	PFRULE_RETURNICMP	0x0004
825 #define	PFRULE_RETURN		0x0008
826 #define	PFRULE_NOSYNC		0x0010
827 #define PFRULE_SRCTRACK		0x0020  /* track source states */
828 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
829 
830 /* scrub flags */
831 #define	PFRULE_NODF		0x0100
832 #define	PFRULE_FRAGCROP		0x0200	/* non-buffering frag cache */
833 #define	PFRULE_FRAGDROP		0x0400	/* drop funny fragments */
834 #define PFRULE_RANDOMID		0x0800
835 #define PFRULE_REASSEMBLE_TCP	0x1000
836 
837 /* rule flags for TOS/DSCP/service class differentiation */
838 #define	PFRULE_TOS		0x2000
839 #define	PFRULE_DSCP		0x4000
840 #define	PFRULE_SC		0x8000
841 
842 /* rule flags again */
843 #define	PFRULE_IFBOUND		0x00010000	/* if-bound */
844 #define	PFRULE_PFM		0x00020000	/* created by pfm device */
845 
846 #define	PFSTATE_HIWAT		10000	/* default state table size */
847 #define	PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
848 #define	PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
849 
850 #define	PFAPPSTATE_HIWAT	10000	/* default same as state table */
851 
852 enum pf_extmap {
853 	PF_EXTMAP_APD	= 1,	/* Address-port-dependent mapping */
854 	PF_EXTMAP_AD,		/* Address-dependent mapping */
855 	PF_EXTMAP_EI		/* Endpoint-independent mapping */
856 };
857 
858 enum pf_extfilter {
859 	PF_EXTFILTER_APD = 1,	/* Address-port-dependent filtering */
860 	PF_EXTFILTER_AD,	/* Address-dependent filtering */
861 	PF_EXTFILTER_EI		/* Endpoint-independent filtering */
862 };
863 
864 struct pf_threshold {
865 	u_int32_t	limit;
866 #define	PF_THRESHOLD_MULT	1000
867 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
868 	u_int32_t	seconds;
869 	u_int32_t	count;
870 	u_int32_t	last;
871 };
872 
873 struct pf_src_node {
874 	RB_ENTRY(pf_src_node) entry;
875 	struct pf_addr	 addr;
876 	struct pf_addr	 raddr;
877 	union pf_rule_ptr rule;
878 #ifdef KERNEL
879 	struct pfi_kif	*kif;
880 #else /* !KERNEL */
881 	void		*kif;
882 #endif /* !KERNEL */
883 	u_int64_t	 bytes[2];
884 	u_int64_t	 packets[2];
885 	u_int32_t	 states;
886 	u_int32_t	 conn;
887 	struct pf_threshold	conn_rate;
888 	u_int64_t	 creation;
889 	u_int64_t	 expire;
890 	sa_family_t	 af;
891 	u_int8_t	 ruletype;
892 };
893 
894 #define PFSNODE_HIWAT		10000	/* default source node table size */
895 
896 #ifdef KERNEL
897 struct pf_state_scrub {
898 	struct timeval	pfss_last;	/* time received last packet	*/
899 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
900 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
901 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
902 	u_int16_t	pfss_flags;
903 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
904 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
905 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
906 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
907 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
908 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
909 	u_int8_t	pad;
910 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
911 };
912 #endif /* KERNEL */
913 
914 union pf_state_xport {
915 	u_int16_t	port;
916 	u_int16_t	call_id;
917 	u_int32_t	spi;
918 };
919 
920 struct pf_state_host {
921 	struct pf_addr		addr;
922 	union pf_state_xport	xport;
923 };
924 
925 #ifdef KERNEL
926 struct pf_state_peer {
927 	u_int32_t	seqlo;		/* Max sequence number sent	*/
928 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
929 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
930 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
931 	u_int8_t	state;		/* active state level		*/
932 	u_int8_t	wscale;		/* window scaling factor	*/
933 	u_int16_t	mss;		/* Maximum segment size option	*/
934 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
935 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
936 	u_int8_t	pad[3];
937 };
938 
939 TAILQ_HEAD(pf_state_queue, pf_state);
940 
941 struct pf_state;
942 struct pf_pdesc;
943 struct pf_app_state;
944 
945 typedef void (*pf_app_handler)(struct pf_state *, int, int, struct pf_pdesc *,
946 	struct pfi_kif *);
947 
948 typedef int (*pf_app_compare)(struct pf_app_state *, struct pf_app_state *);
949 
950 struct pf_pptp_state {
951 	struct pf_state *grev1_state;
952 };
953 
954 struct pf_grev1_state {
955 	struct pf_state *pptp_state;
956 };
957 
958 struct pf_ike_state {
959 	u_int64_t cookie;
960 };
961 
962 struct pf_app_state {
963 	pf_app_handler	handler;
964 	pf_app_compare	compare_lan_ext;
965 	pf_app_compare	compare_ext_gwy;
966 	union {
967 		struct pf_pptp_state pptp;
968 		struct pf_grev1_state grev1;
969 		struct pf_ike_state ike;
970 	} u;
971 };
972 
973 /* keep synced with struct pf_state, used in RB_FIND */
974 struct pf_state_key_cmp {
975 	struct pf_state_host lan;
976 	struct pf_state_host gwy;
977 	struct pf_state_host ext;
978 	sa_family_t	 af;
979 	u_int8_t	 proto;
980 	u_int8_t	 direction;
981 	u_int8_t	 proto_variant;
982 	struct pf_app_state	*app_state;
983 };
984 
985 TAILQ_HEAD(pf_statelist, pf_state);
986 
987 struct pf_state_key {
988 	struct pf_state_host lan;
989 	struct pf_state_host gwy;
990 	struct pf_state_host ext;
991 	sa_family_t	 af;
992 	u_int8_t	 proto;
993 	u_int8_t	 direction;
994 	u_int8_t	 proto_variant;
995 	struct pf_app_state	*app_state;
996 	u_int32_t	 flowsrc;
997 	u_int32_t	 flowhash;
998 
999 	RB_ENTRY(pf_state_key)	 entry_lan_ext;
1000 	RB_ENTRY(pf_state_key)	 entry_ext_gwy;
1001 	struct pf_statelist	 states;
1002 	u_int32_t	 refcnt;
1003 };
1004 
1005 
1006 /* keep synced with struct pf_state, used in RB_FIND */
1007 struct pf_state_cmp {
1008 	u_int64_t	 id;
1009 	u_int32_t	 creatorid;
1010 	u_int32_t	 pad;
1011 };
1012 
1013 /* flowhash key (12-bytes multiple for performance) */
1014 struct pf_flowhash_key {
1015 	struct pf_state_host	ap1;	/* address+port blob 1 */
1016 	struct pf_state_host	ap2;	/* address+port blob 2 */
1017 	u_int32_t		af;
1018 	u_int32_t		proto;
1019 };
1020 #endif /* KERNEL */
1021 
1022 struct hook_desc;
1023 TAILQ_HEAD(hook_desc_head, hook_desc);
1024 
1025 #ifdef KERNEL
1026 struct pf_state {
1027 	u_int64_t		 id;
1028 	u_int32_t		 creatorid;
1029 	u_int32_t		 pad;
1030 
1031 	TAILQ_ENTRY(pf_state)	 entry_list;
1032 	TAILQ_ENTRY(pf_state)	 next;
1033 	RB_ENTRY(pf_state)	 entry_id;
1034 	struct pf_state_peer	 src;
1035 	struct pf_state_peer	 dst;
1036 	union pf_rule_ptr	 rule;
1037 	union pf_rule_ptr	 anchor;
1038 	union pf_rule_ptr	 nat_rule;
1039 	struct pf_addr		 rt_addr;
1040 	struct hook_desc_head	 unlink_hooks;
1041 	struct pf_state_key	*state_key;
1042 	struct pfi_kif		*kif;
1043 	struct pfi_kif		*rt_kif;
1044 	struct pf_src_node	*src_node;
1045 	struct pf_src_node	*nat_src_node;
1046 	u_int64_t		 packets[2];
1047 	u_int64_t		 bytes[2];
1048 	u_int64_t		 creation;
1049 	u_int64_t		 expire;
1050 	u_int64_t		 pfsync_time;
1051 	u_int16_t		 tag;
1052 	u_int8_t		 log;
1053 	u_int8_t		 allow_opts;
1054 	u_int8_t		 timeout;
1055 	u_int8_t		 sync_flags;
1056 };
1057 #endif /* KERNEL */
1058 
1059 #define	PFSTATE_NOSYNC	 0x01
1060 #define	PFSTATE_FROMSYNC 0x02
1061 #define	PFSTATE_STALE	 0x04
1062 
1063 #define	__packed	__attribute__((__packed__))
1064 
1065 /*
1066  * Unified state structures for pulling states out of the kernel
1067  * used by pfsync(4) and the pf(4) ioctl.
1068  */
1069 struct pfsync_state_scrub {
1070 	u_int16_t	pfss_flags;
1071 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
1072 #define PFSYNC_SCRUB_FLAG_VALID 	0x01
1073 	u_int8_t	scrub_flag;
1074 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
1075 } __packed;
1076 
1077 struct pfsync_state_host {
1078 	struct pf_addr		addr;
1079 	union pf_state_xport	xport;
1080 	u_int16_t		pad[2];
1081 } __packed;
1082 
1083 struct pfsync_state_peer {
1084 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
1085 	u_int32_t	seqlo;		/* Max sequence number sent	*/
1086 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
1087 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
1088 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
1089 	u_int16_t	mss;		/* Maximum segment size option	*/
1090 	u_int8_t	state;		/* active state level		*/
1091 	u_int8_t	wscale;		/* window scaling factor	*/
1092 	u_int8_t	pad[6];
1093 } __packed;
1094 
1095 struct pfsync_state {
1096 	u_int32_t	 id[2];
1097 	char		 ifname[IFNAMSIZ];
1098 	struct pfsync_state_host lan;
1099 	struct pfsync_state_host gwy;
1100 	struct pfsync_state_host ext;
1101 	struct pfsync_state_peer src;
1102 	struct pfsync_state_peer dst;
1103 	struct pf_addr	 rt_addr;
1104 	struct hook_desc_head unlink_hooks;
1105 #if !defined(__LP64__)
1106 	u_int32_t	_pad[2];
1107 #endif /* !__LP64__ */
1108 	u_int32_t	 rule;
1109 	u_int32_t	 anchor;
1110 	u_int32_t	 nat_rule;
1111 	u_int64_t	 creation;
1112 	u_int64_t	 expire;
1113 	u_int32_t	 packets[2][2];
1114 	u_int32_t	 bytes[2][2];
1115 	u_int32_t	 creatorid;
1116 	u_int16_t	 tag;
1117 	sa_family_t	 af;
1118 	u_int8_t	 proto;
1119 	u_int8_t	 direction;
1120 	u_int8_t	 log;
1121 	u_int8_t	 allow_opts;
1122 	u_int8_t	 timeout;
1123 	u_int8_t	 sync_flags;
1124 	u_int8_t	 updates;
1125 	u_int8_t	 proto_variant;
1126 	u_int8_t	 __pad;
1127 	u_int32_t	 flowhash;
1128 } __packed;
1129 
1130 #define PFSYNC_FLAG_COMPRESS	0x01
1131 #define PFSYNC_FLAG_STALE	0x02
1132 #define PFSYNC_FLAG_SRCNODE	0x04
1133 #define PFSYNC_FLAG_NATSRCNODE	0x08
1134 
1135 #ifdef KERNEL
1136 /* for copies to/from userland via pf_ioctl() */
1137 #define pf_state_peer_to_pfsync(s, d) do {	\
1138 	(d)->seqlo = (s)->seqlo;		\
1139 	(d)->seqhi = (s)->seqhi;		\
1140 	(d)->seqdiff = (s)->seqdiff;		\
1141 	(d)->max_win = (s)->max_win;		\
1142 	(d)->mss = (s)->mss;			\
1143 	(d)->state = (s)->state;		\
1144 	(d)->wscale = (s)->wscale;		\
1145 	if ((s)->scrub) {						\
1146 		(d)->scrub.pfss_flags =					\
1147 		    (s)->scrub->pfss_flags & PFSS_TIMESTAMP;		\
1148 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
1149 		(d)->scrub.pfss_ts_mod = (s)->scrub->pfss_ts_mod;	\
1150 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
1151 	}								\
1152 } while (0)
1153 
1154 #define pf_state_peer_from_pfsync(s, d) do {	\
1155 	(d)->seqlo = (s)->seqlo;		\
1156 	(d)->seqhi = (s)->seqhi;		\
1157 	(d)->seqdiff = (s)->seqdiff;		\
1158 	(d)->max_win = (s)->max_win;		\
1159 	(d)->mss = ntohs((s)->mss);		\
1160 	(d)->state = (s)->state;		\
1161 	(d)->wscale = (s)->wscale;		\
1162 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID &&		\
1163 	    (d)->scrub != NULL) {					\
1164 		(d)->scrub->pfss_flags =				\
1165 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
1166 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
1167 		(d)->scrub->pfss_ts_mod = (s)->scrub.pfss_ts_mod;	\
1168 	}								\
1169 } while (0)
1170 #endif /* KERNEL */
1171 
1172 #define pf_state_counter_to_pfsync(s, d) do {			\
1173 	d[0] = (s>>32)&0xffffffff;				\
1174 	d[1] = s&0xffffffff;					\
1175 } while (0)
1176 
1177 #define pf_state_counter_from_pfsync(s)		\
1178 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
1179 
1180 
1181 
1182 TAILQ_HEAD(pf_rulequeue, pf_rule);
1183 
1184 struct pf_anchor;
1185 
1186 struct pf_ruleset {
1187 	struct {
1188 		struct pf_rulequeue	 queues[2];
1189 		struct {
1190 			struct pf_rulequeue	*ptr;
1191 			struct pf_rule		**ptr_array;
1192 			u_int32_t		 rcount;
1193 			u_int32_t		 ticket;
1194 			int			 open;
1195 		}			 active, inactive;
1196 	}			 rules[PF_RULESET_MAX];
1197 	struct pf_anchor	*anchor;
1198 	u_int32_t		 tticket;
1199 	int			 tables;
1200 	int			 topen;
1201 };
1202 
1203 RB_HEAD(pf_anchor_global, pf_anchor);
1204 RB_HEAD(pf_anchor_node, pf_anchor);
1205 struct pf_anchor {
1206 	RB_ENTRY(pf_anchor)	 entry_global;
1207 	RB_ENTRY(pf_anchor)	 entry_node;
1208 	struct pf_anchor	*parent;
1209 	struct pf_anchor_node	 children;
1210 	char			 name[PF_ANCHOR_NAME_SIZE];
1211 	char			 path[MAXPATHLEN];
1212 	struct pf_ruleset	 ruleset;
1213 	int			 refcnt;	/* anchor rules */
1214 	int			 match;
1215 	char			 owner[PF_OWNER_NAME_SIZE];
1216 };
1217 #ifdef KERNEL
1218 RB_PROTOTYPE_SC(__private_extern__, pf_anchor_global, pf_anchor, entry_global,
1219     pf_anchor_compare);
1220 RB_PROTOTYPE_SC(__private_extern__, pf_anchor_node, pf_anchor, entry_node,
1221     pf_anchor_compare);
1222 #else /* !KERNEL */
1223 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
1224 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
1225 #endif /* !KERNEL */
1226 
1227 #define PF_RESERVED_ANCHOR	"_pf"
1228 
1229 #define PFR_TFLAG_PERSIST	0x00000001
1230 #define PFR_TFLAG_CONST		0x00000002
1231 #define PFR_TFLAG_ACTIVE	0x00000004
1232 #define PFR_TFLAG_INACTIVE	0x00000008
1233 #define PFR_TFLAG_REFERENCED	0x00000010
1234 #define PFR_TFLAG_REFDANCHOR	0x00000020
1235 #define PFR_TFLAG_USRMASK	0x00000003
1236 #define PFR_TFLAG_SETMASK	0x0000003C
1237 #define PFR_TFLAG_ALLMASK	0x0000003F
1238 
1239 struct pfr_table {
1240 	char			 pfrt_anchor[MAXPATHLEN];
1241 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
1242 	u_int32_t		 pfrt_flags;
1243 	u_int8_t		 pfrt_fback;
1244 };
1245 
1246 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1247 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1248 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
1249 
1250 struct pfr_addr {
1251 	union {
1252 		struct in_addr	 _pfra_ip4addr;
1253 		struct in6_addr	 _pfra_ip6addr;
1254 	}		 pfra_u;
1255 	u_int8_t	 pfra_af;
1256 	u_int8_t	 pfra_net;
1257 	u_int8_t	 pfra_not;
1258 	u_int8_t	 pfra_fback;
1259 };
1260 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
1261 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
1262 
1263 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1264 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1265 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
1266 
1267 struct pfr_astats {
1268 	struct pfr_addr	 pfras_a;
1269 #if !defined(__LP64__)
1270 	u_int32_t	 _pad;
1271 #endif /* !__LP64__ */
1272 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1273 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1274 	u_int64_t	 pfras_tzero;
1275 };
1276 
1277 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1278 
1279 struct pfr_tstats {
1280 	struct pfr_table pfrts_t;
1281 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1282 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1283 	u_int64_t	 pfrts_match;
1284 	u_int64_t	 pfrts_nomatch;
1285 	u_int64_t	 pfrts_tzero;
1286 	int		 pfrts_cnt;
1287 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1288 #if !defined(__LP64__)
1289 	u_int32_t	 _pad;
1290 #endif /* !__LP64__ */
1291 };
1292 #define	pfrts_name	pfrts_t.pfrt_name
1293 #define pfrts_flags	pfrts_t.pfrt_flags
1294 
1295 #ifdef KERNEL
1296 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1297 struct pfr_kentry {
1298 	struct radix_node	 pfrke_node[2];
1299 	union sockaddr_union	 pfrke_sa;
1300 	u_int64_t		 pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1301 	u_int64_t		 pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1302 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1303 	u_int64_t		 pfrke_tzero;
1304 	u_int8_t		 pfrke_af;
1305 	u_int8_t		 pfrke_net;
1306 	u_int8_t		 pfrke_not;
1307 	u_int8_t		 pfrke_mark;
1308 	u_int8_t		 pfrke_intrpool;
1309 };
1310 
1311 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1312 RB_HEAD(pfr_ktablehead, pfr_ktable);
1313 struct pfr_ktable {
1314 	struct pfr_tstats	 pfrkt_ts;
1315 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1316 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1317 	struct radix_node_head	*pfrkt_ip4;
1318 	struct radix_node_head	*pfrkt_ip6;
1319 	struct pfr_ktable	*pfrkt_shadow;
1320 	struct pfr_ktable	*pfrkt_root;
1321 	struct pf_ruleset	*pfrkt_rs;
1322 	u_int64_t		 pfrkt_larg;
1323 	u_int32_t		 pfrkt_nflags;
1324 };
1325 #define pfrkt_t		pfrkt_ts.pfrts_t
1326 #define pfrkt_name	pfrkt_t.pfrt_name
1327 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
1328 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1329 #define pfrkt_flags	pfrkt_t.pfrt_flags
1330 #define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1331 #define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1332 #define pfrkt_packets	pfrkt_ts.pfrts_packets
1333 #define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1334 #define pfrkt_match	pfrkt_ts.pfrts_match
1335 #define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1336 #define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1337 
1338 RB_HEAD(pf_state_tree_lan_ext, pf_state_key);
1339 RB_PROTOTYPE_SC(__private_extern__, pf_state_tree_lan_ext, pf_state_key,
1340     entry_lan_ext, pf_state_compare_lan_ext);
1341 
1342 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key);
1343 RB_PROTOTYPE_SC(__private_extern__, pf_state_tree_ext_gwy, pf_state_key,
1344     entry_ext_gwy, pf_state_compare_ext_gwy);
1345 
1346 RB_HEAD(pfi_ifhead, pfi_kif);
1347 
1348 /* state tables */
1349 extern struct pf_state_tree_lan_ext	 pf_statetbl_lan_ext;
1350 extern struct pf_state_tree_ext_gwy	 pf_statetbl_ext_gwy;
1351 
1352 /* keep synced with pfi_kif, used in RB_FIND */
1353 struct pfi_kif_cmp {
1354 	char				 pfik_name[IFNAMSIZ];
1355 };
1356 
1357 struct pfi_kif {
1358 	char				 pfik_name[IFNAMSIZ];
1359 	RB_ENTRY(pfi_kif)		 pfik_tree;
1360 	u_int64_t			 pfik_packets[2][2][2];
1361 	u_int64_t			 pfik_bytes[2][2][2];
1362 	u_int64_t			 pfik_tzero;
1363 	int				 pfik_flags;
1364 	void				*pfik_ah_cookie;
1365 	struct ifnet			*pfik_ifp;
1366 	int				 pfik_states;
1367 	int				 pfik_rules;
1368 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1369 };
1370 
1371 enum pfi_kif_refs {
1372 	PFI_KIF_REF_NONE,
1373 	PFI_KIF_REF_STATE,
1374 	PFI_KIF_REF_RULE
1375 };
1376 
1377 struct pfi_uif {
1378 #else /* !KERNEL */
1379 struct pfi_kif {
1380 #endif /* !KERNEL */
1381 	char				 pfik_name[IFNAMSIZ];
1382 	u_int64_t			 pfik_packets[2][2][2];
1383 	u_int64_t			 pfik_bytes[2][2][2];
1384 	u_int64_t			 pfik_tzero;
1385 	int				 pfik_flags;
1386 	int				 pfik_states;
1387 	int				 pfik_rules;
1388 #if !defined(__LP64__)
1389 	u_int32_t			 _pad;
1390 #endif /* !__LP64__ */
1391 };
1392 
1393 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1394 
1395 #ifdef KERNEL
1396 struct pf_pdesc {
1397 	struct {
1398 		int	 done;
1399 		uid_t	 uid;
1400 		gid_t	 gid;
1401 		pid_t	 pid;
1402 	}		 lookup;
1403 	u_int64_t	 tot_len;	/* Make Mickey money */
1404 	union {
1405 		struct tcphdr		*tcp;
1406 		struct udphdr		*udp;
1407 		struct icmp		*icmp;
1408 #if INET6
1409 		struct icmp6_hdr	*icmp6;
1410 #endif /* INET6 */
1411 		struct pf_grev1_hdr	*grev1;
1412 		struct pf_esp_hdr	*esp;
1413 		void			*any;
1414 	} hdr;
1415 	struct pf_addr	 baddr;		/* address before translation */
1416 	struct pf_addr	 naddr;		/* address after translation */
1417 	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1418 	struct pf_addr	*src;
1419 	struct pf_addr	*dst;
1420 	struct ether_header
1421 			*eh;
1422 	struct mbuf	*mp;
1423 	int		lmw;		/* lazy writable offset */
1424 	struct pf_mtag	*pf_mtag;
1425 	u_int16_t	*ip_sum;
1426 	u_int32_t	 p_len;		/* total length of payload */
1427 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in */
1428 					/* state code. Easier than tags */
1429 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1430 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1431 #define PFDESC_IP_FRAG	0x0004		/* This is a fragment */
1432 	sa_family_t	 af;
1433 	u_int8_t	 proto;
1434 	u_int8_t	 tos;
1435 	u_int8_t	 proto_variant;
1436 	mbuf_svc_class_t sc;		/* mbuf service class (MBUF_SVC) */
1437 	u_int32_t	 pktflags;	/* mbuf packet flags (PKTF) */
1438 	u_int32_t	 flowsrc;	/* flow source (FLOWSRC) */
1439 	u_int32_t	 flowhash;	/* flow hash to identify the sender */
1440 };
1441 #endif /* KERNEL */
1442 
1443 /* flags for RDR options */
1444 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1445 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1446 
1447 /* Reasons code for passing/dropping a packet */
1448 #define PFRES_MATCH	0		/* Explicit match of a rule */
1449 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1450 #define PFRES_FRAG	2		/* Dropping following fragment */
1451 #define PFRES_SHORT	3		/* Dropping short packet */
1452 #define PFRES_NORM	4		/* Dropping by normalizer */
1453 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1454 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1455 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1456 #define PFRES_IPOPTIONS 8		/* IP option */
1457 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1458 #define PFRES_BADSTATE	10		/* State mismatch */
1459 #define PFRES_STATEINS	11		/* State insertion failure */
1460 #define PFRES_MAXSTATES	12		/* State limit */
1461 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1462 #define PFRES_SYNPROXY	14		/* SYN proxy */
1463 #define PFRES_DUMMYNET	15		/* Dummynet */
1464 #define PFRES_MAX	16		/* total+1 */
1465 
1466 #define PFRES_NAMES { \
1467 	"match", \
1468 	"bad-offset", \
1469 	"fragment", \
1470 	"short", \
1471 	"normalize", \
1472 	"memory", \
1473 	"bad-timestamp", \
1474 	"congestion", \
1475 	"ip-option", \
1476 	"proto-cksum", \
1477 	"state-mismatch", \
1478 	"state-insert", \
1479 	"state-limit", \
1480 	"src-limit", \
1481 	"synproxy", \
1482 	"dummynet", \
1483 	NULL \
1484 }
1485 
1486 /* Counters for other things we want to keep track of */
1487 #define LCNT_STATES		0	/* states */
1488 #define LCNT_SRCSTATES		1	/* max-src-states */
1489 #define LCNT_SRCNODES		2	/* max-src-nodes */
1490 #define LCNT_SRCCONN		3	/* max-src-conn */
1491 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1492 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1493 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1494 #define LCNT_MAX		7	/* total+1 */
1495 
1496 #define LCNT_NAMES { \
1497 	"max states per rule", \
1498 	"max-src-states", \
1499 	"max-src-nodes", \
1500 	"max-src-conn", \
1501 	"max-src-conn-rate", \
1502 	"overload table insertion", \
1503 	"overload flush states", \
1504 	NULL \
1505 }
1506 
1507 /* UDP state enumeration */
1508 #define PFUDPS_NO_TRAFFIC	0
1509 #define PFUDPS_SINGLE		1
1510 #define PFUDPS_MULTIPLE		2
1511 
1512 #define PFUDPS_NSTATES		3	/* number of state levels */
1513 
1514 #define PFUDPS_NAMES { \
1515 	"NO_TRAFFIC", \
1516 	"SINGLE", \
1517 	"MULTIPLE", \
1518 	NULL \
1519 }
1520 
1521 /* GREv1 protocol state enumeration */
1522 #define PFGRE1S_NO_TRAFFIC		0
1523 #define PFGRE1S_INITIATING		1
1524 #define PFGRE1S_ESTABLISHED		2
1525 
1526 #define PFGRE1S_NSTATES			3	/* number of state levels */
1527 
1528 #define PFGRE1S_NAMES { \
1529 	"NO_TRAFFIC", \
1530 	"INITIATING", \
1531 	"ESTABLISHED", \
1532 	NULL \
1533 }
1534 
1535 #define PFESPS_NO_TRAFFIC	0
1536 #define PFESPS_INITIATING	1
1537 #define PFESPS_ESTABLISHED	2
1538 
1539 #define PFESPS_NSTATES		3	/* number of state levels */
1540 
1541 #define PFESPS_NAMES { "NO_TRAFFIC", "INITIATING", "ESTABLISHED", NULL }
1542 
1543 /* Other protocol state enumeration */
1544 #define PFOTHERS_NO_TRAFFIC	0
1545 #define PFOTHERS_SINGLE		1
1546 #define PFOTHERS_MULTIPLE	2
1547 
1548 #define PFOTHERS_NSTATES	3	/* number of state levels */
1549 
1550 #define PFOTHERS_NAMES { \
1551 	"NO_TRAFFIC", \
1552 	"SINGLE", \
1553 	"MULTIPLE", \
1554 	NULL \
1555 }
1556 
1557 #define FCNT_STATE_SEARCH	0
1558 #define FCNT_STATE_INSERT	1
1559 #define FCNT_STATE_REMOVALS	2
1560 #define FCNT_MAX		3
1561 
1562 #define SCNT_SRC_NODE_SEARCH	0
1563 #define SCNT_SRC_NODE_INSERT	1
1564 #define SCNT_SRC_NODE_REMOVALS	2
1565 #define SCNT_MAX		3
1566 
1567 #ifdef KERNEL
1568 #define ACTION_SET(a, x) \
1569 	do { \
1570 		if ((a) != NULL) \
1571 			*(a) = (x); \
1572 	} while (0)
1573 
1574 #define REASON_SET(a, x) \
1575 	do { \
1576 		if ((a) != NULL) \
1577 			*(a) = (x); \
1578 		if (x < PFRES_MAX) \
1579 			pf_status.counters[x]++; \
1580 	} while (0)
1581 #endif /* KERNEL */
1582 
1583 struct pf_status {
1584 	u_int64_t	counters[PFRES_MAX];
1585 	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1586 	u_int64_t	fcounters[FCNT_MAX];
1587 	u_int64_t	scounters[SCNT_MAX];
1588 	u_int64_t	pcounters[2][2][3];
1589 	u_int64_t	bcounters[2][2];
1590 	u_int64_t	stateid;
1591 	u_int32_t	running;
1592 	u_int32_t	states;
1593 	u_int32_t	src_nodes;
1594 	u_int64_t	since			__attribute__((aligned(8)));
1595 	u_int32_t	debug;
1596 	u_int32_t	hostid;
1597 	char		ifname[IFNAMSIZ];
1598 	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1599 };
1600 
1601 struct cbq_opts {
1602 	u_int32_t	minburst;
1603 	u_int32_t	maxburst;
1604 	u_int32_t	pktsize;
1605 	u_int32_t	maxpktsize;
1606 	u_int32_t	ns_per_byte;
1607 	u_int32_t	maxidle;
1608 	int32_t		minidle;
1609 	u_int32_t	offtime;
1610 	u_int32_t	flags;
1611 };
1612 
1613 struct priq_opts {
1614 	u_int32_t	flags;
1615 };
1616 
1617 struct qfq_opts {
1618 	u_int32_t	flags;
1619 	u_int32_t	lmax;
1620 };
1621 
1622 struct hfsc_opts {
1623 	/* real-time service curve */
1624 	u_int64_t	rtsc_m1;	/* slope of the 1st segment in bps */
1625 	u_int64_t	rtsc_d;		/* the x-projection of m1 in msec */
1626 	u_int64_t	rtsc_m2;	/* slope of the 2nd segment in bps */
1627 	u_int32_t	rtsc_fl;	/* service curve flags */
1628 #if !defined(__LP64__)
1629 	u_int32_t	_pad;
1630 #endif /* !__LP64__ */
1631 	/* link-sharing service curve */
1632 	u_int64_t	lssc_m1;
1633 	u_int64_t	lssc_d;
1634 	u_int64_t	lssc_m2;
1635 	u_int32_t	lssc_fl;
1636 #if !defined(__LP64__)
1637 	u_int32_t	__pad;
1638 #endif /* !__LP64__ */
1639 	/* upper-limit service curve */
1640 	u_int64_t	ulsc_m1;
1641 	u_int64_t	ulsc_d;
1642 	u_int64_t	ulsc_m2;
1643 	u_int32_t	ulsc_fl;
1644 	u_int32_t	flags;		/* scheduler flags */
1645 };
1646 
1647 struct fairq_opts {
1648 	u_int32_t	nbuckets;	/* hash buckets */
1649 	u_int32_t	flags;
1650 	u_int64_t	hogs_m1;	/* hog detection bandwidth */
1651 
1652 	/* link-sharing service curve */
1653 	u_int64_t	lssc_m1;
1654 	u_int64_t	lssc_d;
1655 	u_int64_t	lssc_m2;
1656 };
1657 
1658 /* bandwidth types */
1659 #define PF_ALTQ_BW_ABSOLUTE	1	/* bw in absolute value (bps) */
1660 #define PF_ALTQ_BW_PERCENT	2	/* bandwidth in percentage */
1661 
1662 /* ALTQ rule flags */
1663 #define	PF_ALTQF_TBR		0x1	/* enable Token Bucket Regulator */
1664 
1665 /* queue rule flags */
1666 #define	PF_ALTQ_QRF_WEIGHT	0x1	/* weight instead of priority */
1667 
1668 struct pf_altq {
1669 	char			 ifname[IFNAMSIZ];
1670 
1671 	/* discipline-specific state */
1672 	void			*altq_disc __attribute__((aligned(8)));
1673 	TAILQ_ENTRY(pf_altq)	 entries __attribute__((aligned(8)));
1674 #if !defined(__LP64__)
1675 	u_int32_t		_pad[2];
1676 #endif /* !__LP64__ */
1677 
1678 	u_int32_t		 aflags;	/* ALTQ rule flags */
1679 	u_int32_t		 bwtype;	/* bandwidth type */
1680 
1681 	/* scheduler spec */
1682 	u_int32_t		 scheduler;	/* scheduler type */
1683 	u_int32_t		 tbrsize;	/* tokenbucket regulator size */
1684 	u_int64_t		 ifbandwidth;	/* interface bandwidth */
1685 
1686 	/* queue spec */
1687 	char			 qname[PF_QNAME_SIZE];	/* queue name */
1688 	char			 parent[PF_QNAME_SIZE];	/* parent name */
1689 	u_int32_t		 parent_qid;	/* parent queue id */
1690 	u_int32_t		 qrflags;	/* queue rule flags */
1691 	union {
1692 		u_int32_t	 priority;	/* priority */
1693 		u_int32_t	 weight;	/* weight */
1694 	};
1695 	u_int32_t		 qlimit;	/* queue size limit */
1696 	u_int32_t		 flags;		/* misc flags */
1697 #if !defined(__LP64__)
1698 	u_int32_t		__pad;
1699 #endif /* !__LP64__ */
1700 	u_int64_t		 bandwidth;	/* queue bandwidth */
1701 	union {
1702 		struct cbq_opts		 cbq_opts;
1703 		struct priq_opts	 priq_opts;
1704 		struct hfsc_opts	 hfsc_opts;
1705 		struct fairq_opts	 fairq_opts;
1706 		struct qfq_opts		 qfq_opts;
1707 	} pq_u;
1708 
1709 	u_int32_t		 qid;		/* return value */
1710 };
1711 
1712 struct pf_tagname {
1713 	TAILQ_ENTRY(pf_tagname)	entries;
1714 	char			name[PF_TAG_NAME_SIZE];
1715 	u_int16_t		tag;
1716 	int			ref;
1717 };
1718 
1719 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1720 #define PFFRAG_FRAG_HIWAT	1000	/* Number of fragmented packets */
1721 #define PFFRAG_FRCENT_HIWAT	50000	/* Number of fragment cache entries */
1722 #define PFFRAG_FRCACHE_HIWAT	10000	/* Number of fragment descriptors */
1723 
1724 #define PFR_KTABLE_HIWAT	1000	/* Number of tables */
1725 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1726 #define PFR_KENTRY_HIWAT_SMALL	100000	/* Number of table entries (tiny hosts) */
1727 
1728 /*
1729  * ioctl parameter structures
1730  */
1731 
1732 struct pfioc_pooladdr {
1733 	u_int32_t		 action;
1734 	u_int32_t		 ticket;
1735 	u_int32_t		 nr;
1736 	u_int32_t		 r_num;
1737 	u_int8_t		 r_action;
1738 	u_int8_t		 r_last;
1739 	u_int8_t		 af;
1740 	char			 anchor[MAXPATHLEN];
1741 	struct pf_pooladdr	 addr;
1742 };
1743 
1744 struct pfioc_rule {
1745 	u_int32_t	 action;
1746 	u_int32_t	 ticket;
1747 	u_int32_t	 pool_ticket;
1748 	u_int32_t	 nr;
1749 	char		 anchor[MAXPATHLEN];
1750 	char		 anchor_call[MAXPATHLEN];
1751 	struct pf_rule	 rule;
1752 };
1753 
1754 struct pfioc_natlook {
1755 	struct pf_addr	 saddr;
1756 	struct pf_addr	 daddr;
1757 	struct pf_addr	 rsaddr;
1758 	struct pf_addr	 rdaddr;
1759 	union pf_state_xport	sxport;
1760 	union pf_state_xport	dxport;
1761 	union pf_state_xport	rsxport;
1762 	union pf_state_xport	rdxport;
1763 	sa_family_t	 af;
1764 	u_int8_t	 proto;
1765 	u_int8_t	 proto_variant;
1766 	u_int8_t	 direction;
1767 };
1768 
1769 struct pfioc_state {
1770 	struct pfsync_state	state;
1771 };
1772 
1773 struct pfioc_src_node_kill {
1774 	/* XXX returns the number of src nodes killed in psnk_af */
1775 	sa_family_t psnk_af;
1776 	struct pf_rule_addr psnk_src;
1777 	struct pf_rule_addr psnk_dst;
1778 };
1779 
1780 struct pfioc_state_addr_kill {
1781 	struct pf_addr_wrap		addr;
1782 	u_int8_t			reserved_[3];
1783 	u_int8_t			neg;
1784 	union pf_rule_xport		xport;
1785 };
1786 
1787 struct pfioc_state_kill {
1788 	/* XXX returns the number of states killed in psk_af */
1789 	sa_family_t		psk_af;
1790 	u_int8_t		psk_proto;
1791 	u_int8_t		psk_proto_variant;
1792 	u_int8_t		_pad;
1793 	struct pfioc_state_addr_kill	psk_src;
1794 	struct pfioc_state_addr_kill	psk_dst;
1795 	char			psk_ifname[IFNAMSIZ];
1796 	char			psk_ownername[PF_OWNER_NAME_SIZE];
1797 };
1798 
1799 struct pfioc_states {
1800 	int	ps_len;
1801 	union {
1802 		caddr_t			 psu_buf;
1803 		struct pfsync_state	*psu_states;
1804 	} ps_u __attribute__((aligned(8)));
1805 #define ps_buf		ps_u.psu_buf
1806 #define ps_states	ps_u.psu_states
1807 };
1808 
1809 #ifdef KERNEL
1810 struct pfioc_states_32 {
1811 	int	ps_len;
1812 	union {
1813 		user32_addr_t		psu_buf;
1814 		user32_addr_t		psu_states;
1815 	} ps_u __attribute__((aligned(8)));
1816 };
1817 
1818 struct pfioc_states_64 {
1819 	int	ps_len;
1820 	union {
1821 		user64_addr_t		psu_buf;
1822 		user64_addr_t		psu_states;
1823 	} ps_u __attribute__((aligned(8)));
1824 };
1825 #endif /* KERNEL */
1826 
1827 #define PFTOK_PROCNAME_LEN    64
1828 #pragma pack(1)
1829 struct pfioc_token {
1830 	u_int64_t			token_value;
1831 	u_int64_t			timestamp;
1832 	pid_t				pid;
1833 	char				proc_name[PFTOK_PROCNAME_LEN];
1834 };
1835 #pragma pack()
1836 
1837 struct pfioc_kernel_token {
1838 	SLIST_ENTRY(pfioc_kernel_token)	next;
1839 	struct pfioc_token		token;
1840 };
1841 
1842 struct pfioc_remove_token {
1843 	u_int64_t                token_value;
1844 	u_int64_t                refcount;
1845 };
1846 
1847 struct pfioc_tokens {
1848 	int	size;
1849 	union {
1850 		caddr_t				pgtu_buf;
1851 		struct pfioc_token		*pgtu_tokens;
1852 	} pgt_u __attribute__((aligned(8)));
1853 #define pgt_buf		pgt_u.pgtu_buf
1854 #define pgt_tokens	pgt_u.pgtu_tokens
1855 };
1856 
1857 #ifdef KERNEL
1858 struct pfioc_tokens_32 {
1859 	int	size;
1860 	union {
1861 		user32_addr_t		pgtu_buf;
1862 		user32_addr_t		pgtu_tokens;
1863 	} pgt_u __attribute__((aligned(8)));
1864 };
1865 
1866 struct pfioc_tokens_64 {
1867 	int	size;
1868 	union {
1869 		user64_addr_t		pgtu_buf;
1870 		user64_addr_t		pgtu_tokens;
1871 	} pgt_u __attribute__((aligned(8)));
1872 };
1873 #endif /* KERNEL */
1874 
1875 
1876 struct pfioc_src_nodes {
1877 	int	psn_len;
1878 	union {
1879 		caddr_t			psu_buf;
1880 		struct pf_src_node	*psu_src_nodes;
1881 	} psn_u __attribute__((aligned(8)));
1882 #define psn_buf		psn_u.psu_buf
1883 #define psn_src_nodes	psn_u.psu_src_nodes
1884 };
1885 
1886 #ifdef KERNEL
1887 struct pfioc_src_nodes_32 {
1888 	int	psn_len;
1889 	union {
1890 		user32_addr_t		psu_buf;
1891 		user32_addr_t		psu_src_nodes;
1892 	} psn_u __attribute__((aligned(8)));
1893 };
1894 
1895 struct pfioc_src_nodes_64 {
1896 	int	psn_len;
1897 	union {
1898 		user64_addr_t		psu_buf;
1899 		user64_addr_t		psu_src_nodes;
1900 	} psn_u __attribute__((aligned(8)));
1901 };
1902 #endif /* KERNEL */
1903 
1904 struct pfioc_if {
1905 	char		 ifname[IFNAMSIZ];
1906 };
1907 
1908 struct pfioc_tm {
1909 	int		 timeout;
1910 	int		 seconds;
1911 };
1912 
1913 struct pfioc_limit {
1914 	int		 index;
1915 	unsigned	 limit;
1916 };
1917 
1918 struct pfioc_altq {
1919 	u_int32_t	 action;
1920 	u_int32_t	 ticket;
1921 	u_int32_t	 nr;
1922 	struct pf_altq	 altq			__attribute__((aligned(8)));
1923 };
1924 
1925 struct pfioc_qstats {
1926 	u_int32_t	 ticket;
1927 	u_int32_t	 nr;
1928 	void		*buf			__attribute__((aligned(8)));
1929 	int		 nbytes			__attribute__((aligned(8)));
1930 	u_int8_t	 scheduler;
1931 };
1932 
1933 struct pfioc_ruleset {
1934 	u_int32_t	 nr;
1935 	char		 path[MAXPATHLEN];
1936 	char		 name[PF_ANCHOR_NAME_SIZE];
1937 };
1938 
1939 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1940 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1941 struct pfioc_trans {
1942 	int		 size;	/* number of elements */
1943 	int		 esize; /* size of each element in bytes */
1944 	struct pfioc_trans_e {
1945 		int		rs_num;
1946 		char		anchor[MAXPATHLEN];
1947 		u_int32_t	ticket;
1948 	} *array __attribute__((aligned(8)));
1949 };
1950 
1951 #ifdef KERNEL
1952 struct pfioc_trans_32 {
1953 	int		 size;	/* number of elements */
1954 	int		 esize; /* size of each element in bytes */
1955 	user32_addr_t	 array __attribute__((aligned(8)));
1956 };
1957 
1958 struct pfioc_trans_64 {
1959 	int		 size;	/* number of elements */
1960 	int		 esize; /* size of each element in bytes */
1961 	user64_addr_t	 array __attribute__((aligned(8)));
1962 };
1963 #endif /* KERNEL */
1964 
1965 
1966 #define PFR_FLAG_ATOMIC		0x00000001
1967 #define PFR_FLAG_DUMMY		0x00000002
1968 #define PFR_FLAG_FEEDBACK	0x00000004
1969 #define PFR_FLAG_CLSTATS	0x00000008
1970 #define PFR_FLAG_ADDRSTOO	0x00000010
1971 #define PFR_FLAG_REPLACE	0x00000020
1972 #define PFR_FLAG_ALLRSETS	0x00000040
1973 #define PFR_FLAG_ALLMASK	0x0000007F
1974 #ifdef KERNEL
1975 #define PFR_FLAG_USERIOCTL	0x10000000
1976 #endif /* KERNEL */
1977 
1978 struct pfioc_table {
1979 	struct pfr_table	 pfrio_table;
1980 	void			*pfrio_buffer	__attribute__((aligned(8)));
1981 	int			 pfrio_esize	__attribute__((aligned(8)));
1982 	int			 pfrio_size;
1983 	int			 pfrio_size2;
1984 	int			 pfrio_nadd;
1985 	int			 pfrio_ndel;
1986 	int			 pfrio_nchange;
1987 	int			 pfrio_flags;
1988 	u_int32_t		 pfrio_ticket;
1989 };
1990 #define	pfrio_exists	pfrio_nadd
1991 #define	pfrio_nzero	pfrio_nadd
1992 #define	pfrio_nmatch	pfrio_nadd
1993 #define pfrio_naddr	pfrio_size2
1994 #define pfrio_setflag	pfrio_size2
1995 #define pfrio_clrflag	pfrio_nadd
1996 
1997 #ifdef KERNEL
1998 struct pfioc_table_32 {
1999 	struct pfr_table	 pfrio_table;
2000 	user32_addr_t		 pfrio_buffer	__attribute__((aligned(8)));
2001 	int			 pfrio_esize	__attribute__((aligned(8)));
2002 	int			 pfrio_size;
2003 	int			 pfrio_size2;
2004 	int			 pfrio_nadd;
2005 	int			 pfrio_ndel;
2006 	int			 pfrio_nchange;
2007 	int			 pfrio_flags;
2008 	u_int32_t		 pfrio_ticket;
2009 };
2010 
2011 struct pfioc_table_64 {
2012 	struct pfr_table	 pfrio_table;
2013 	user64_addr_t		 pfrio_buffer	__attribute__((aligned(8)));
2014 	int			 pfrio_esize	__attribute__((aligned(8)));
2015 	int			 pfrio_size;
2016 	int			 pfrio_size2;
2017 	int			 pfrio_nadd;
2018 	int			 pfrio_ndel;
2019 	int			 pfrio_nchange;
2020 	int			 pfrio_flags;
2021 	u_int32_t		 pfrio_ticket;
2022 };
2023 #endif /* KERNEL */
2024 
2025 struct pfioc_iface {
2026 	char	 pfiio_name[IFNAMSIZ];
2027 	void	*pfiio_buffer			__attribute__((aligned(8)));
2028 	int	 pfiio_esize			__attribute__((aligned(8)));
2029 	int	 pfiio_size;
2030 	int	 pfiio_nzero;
2031 	int	 pfiio_flags;
2032 };
2033 
2034 #ifdef KERNEL
2035 struct pfioc_iface_32 {
2036 	char	 pfiio_name[IFNAMSIZ];
2037 	user32_addr_t pfiio_buffer		__attribute__((aligned(8)));
2038 	int	 pfiio_esize			__attribute__((aligned(8)));
2039 	int	 pfiio_size;
2040 	int	 pfiio_nzero;
2041 	int	 pfiio_flags;
2042 };
2043 
2044 struct pfioc_iface_64 {
2045 	char	 pfiio_name[IFNAMSIZ];
2046 	user64_addr_t pfiio_buffer		__attribute__((aligned(8)));
2047 	int	 pfiio_esize			__attribute__((aligned(8)));
2048 	int	 pfiio_size;
2049 	int	 pfiio_nzero;
2050 	int	 pfiio_flags;
2051 };
2052 #endif /* KERNEL */
2053 
2054 struct pf_ifspeed {
2055 	char			ifname[IFNAMSIZ];
2056 	u_int64_t		baudrate;
2057 };
2058 
2059 /*
2060  * ioctl operations
2061  */
2062 
2063 #define DIOCSTART	_IO  ('D',  1)
2064 #define DIOCSTOP	_IO  ('D',  2)
2065 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
2066 #define DIOCGETSTARTERS	_IOWR('D',  5, struct pfioc_tokens)
2067 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
2068 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
2069 #define DIOCSTARTREF	_IOR ('D',  8, u_int64_t)
2070 #define DIOCSTOPREF	_IOWR('D',  9, struct pfioc_remove_token)
2071 /* XXX cut 10 - 17 */
2072 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
2073 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
2074 #define DIOCSETSTATUSIF	_IOWR('D', 20, struct pfioc_if)
2075 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
2076 #define DIOCCLRSTATUS	_IO  ('D', 22)
2077 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
2078 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
2079 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
2080 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
2081 #define DIOCINSERTRULE	_IOWR('D',  27, struct pfioc_rule)
2082 #define DIOCDELETERULE	_IOWR('D',  28, struct pfioc_rule)
2083 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
2084 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
2085 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
2086 #define DIOCCLRRULECTRS	_IO  ('D', 38)
2087 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
2088 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
2089 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
2090 #define DIOCSTARTALTQ	_IO  ('D', 42)
2091 #define DIOCSTOPALTQ	_IO  ('D', 43)
2092 #define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
2093 #define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
2094 #define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
2095 #define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
2096 #define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
2097 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
2098 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
2099 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
2100 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
2101 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
2102 /* XXX cut 55 - 57 */
2103 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
2104 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
2105 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
2106 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
2107 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
2108 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
2109 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
2110 #define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
2111 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
2112 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
2113 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
2114 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
2115 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
2116 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
2117 #define DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
2118 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
2119 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
2120 #define DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
2121 #define DIOCOSFPFLUSH	_IO('D', 78)
2122 #define DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
2123 #define DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
2124 #define DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
2125 #define DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
2126 #define DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
2127 #define DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
2128 #define DIOCCLRSRCNODES	_IO('D', 85)
2129 #define DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
2130 #define DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
2131 #define DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
2132 #define DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
2133 #define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill)
2134 #define	DIOCGIFSPEED	_IOWR('D', 92, struct pf_ifspeed)
2135 
2136 #ifdef KERNEL
2137 RB_HEAD(pf_src_tree, pf_src_node);
2138 RB_PROTOTYPE_SC(__private_extern__, pf_src_tree, pf_src_node, entry,
2139     pf_src_compare);
2140 extern struct pf_src_tree tree_src_tracking;
2141 
2142 RB_HEAD(pf_state_tree_id, pf_state);
2143 RB_PROTOTYPE_SC(__private_extern__, pf_state_tree_id, pf_state,
2144     entry_id, pf_state_compare_id);
2145 extern struct pf_state_tree_id tree_id;
2146 extern struct pf_state_queue state_list;
2147 
2148 TAILQ_HEAD(pf_poolqueue, pf_pool);
2149 extern struct pf_poolqueue	pf_pools[2];
2150 extern struct pf_palist	pf_pabuf;
2151 extern u_int32_t		ticket_pabuf;
2152 #if PF_ALTQ
2153 TAILQ_HEAD(pf_altqqueue, pf_altq);
2154 extern struct pf_altqqueue	pf_altqs[2];
2155 extern u_int32_t		ticket_altqs_active;
2156 extern u_int32_t		ticket_altqs_inactive;
2157 extern int			altqs_inactive_open;
2158 extern struct pf_altqqueue	*pf_altqs_active;
2159 extern struct pf_altqqueue	*pf_altqs_inactive;
2160 #endif /* PF_ALTQ */
2161 extern struct pf_poolqueue	*pf_pools_active;
2162 extern struct pf_poolqueue	*pf_pools_inactive;
2163 
2164 __private_extern__ int pf_tbladdr_setup(struct pf_ruleset *,
2165     struct pf_addr_wrap *);
2166 __private_extern__ void pf_tbladdr_remove(struct pf_addr_wrap *);
2167 __private_extern__ void pf_tbladdr_copyout(struct pf_addr_wrap *);
2168 __private_extern__ void pf_calc_skip_steps(struct pf_rulequeue *);
2169 __private_extern__ u_int32_t pf_calc_state_key_flowhash(struct pf_state_key *);
2170 
2171 extern struct pool pf_src_tree_pl, pf_rule_pl;
2172 extern struct pool pf_state_pl, pf_state_key_pl, pf_pooladdr_pl;
2173 extern struct pool pf_state_scrub_pl;
2174 #if PF_ALTQ
2175 extern struct pool pf_altq_pl;
2176 #endif /* PF_ALTQ */
2177 extern struct pool pf_app_state_pl;
2178 
2179 extern struct thread *pf_purge_thread;
2180 
2181 __private_extern__ void pfinit(void);
2182 __private_extern__ void pf_purge_thread_fn(void *, wait_result_t);
2183 __private_extern__ void pf_purge_expired_src_nodes(void);
2184 __private_extern__ void pf_purge_expired_states(u_int32_t);
2185 __private_extern__ void pf_unlink_state(struct pf_state *);
2186 __private_extern__ void pf_free_state(struct pf_state *);
2187 __private_extern__ int pf_insert_state(struct pfi_kif *, struct pf_state *);
2188 __private_extern__ int pf_insert_src_node(struct pf_src_node **,
2189     struct pf_rule *, struct pf_addr *, sa_family_t);
2190 __private_extern__ void pf_src_tree_remove_state(struct pf_state *);
2191 __private_extern__ struct pf_state *pf_find_state_byid(struct pf_state_cmp *);
2192 __private_extern__ struct pf_state *pf_find_state_all(struct pf_state_key_cmp *,
2193     u_int, int *);
2194 __private_extern__ void pf_print_state(struct pf_state *);
2195 __private_extern__ void pf_print_flags(u_int8_t);
2196 __private_extern__ u_int16_t pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
2197     u_int8_t);
2198 
2199 extern struct ifnet *sync_ifp;
2200 extern struct pf_rule pf_default_rule;
2201 __private_extern__ void pf_addrcpy(struct pf_addr *, struct pf_addr *,
2202     u_int8_t);
2203 __private_extern__ void pf_rm_rule(struct pf_rulequeue *, struct pf_rule *);
2204 
2205 struct ip_fw_args;
2206 #if INET
2207 __private_extern__ int pf_test(int, struct ifnet *, struct mbuf **,
2208     struct ether_header *, struct ip_fw_args *);
2209 #endif /* INET */
2210 
2211 #if INET6
2212 __private_extern__ int pf_test6(int, struct ifnet *, struct mbuf **,
2213     struct ether_header *, struct ip_fw_args *);
2214 __private_extern__ void pf_poolmask(struct pf_addr *, struct pf_addr *,
2215     struct pf_addr *, struct pf_addr *, u_int8_t);
2216 __private_extern__ void pf_addr_inc(struct pf_addr *, sa_family_t);
2217 #endif /* INET6 */
2218 
2219 __private_extern__ struct mbuf *pf_lazy_makewritable(struct pf_pdesc *,
2220     struct mbuf *, int);
2221 __private_extern__ void *pf_pull_hdr(struct mbuf *, int, void *, int,
2222     u_short *, u_short *, sa_family_t);
2223 __private_extern__ void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
2224 __private_extern__ int pflog_packet(struct pfi_kif *, struct mbuf *,
2225     sa_family_t, u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
2226     struct pf_ruleset *, struct pf_pdesc *);
2227 __private_extern__ int pf_match_addr(u_int8_t, struct pf_addr *,
2228     struct pf_addr *, struct pf_addr *, sa_family_t);
2229 __private_extern__ int pf_match_addr_range(struct pf_addr *, struct pf_addr *,
2230     struct pf_addr *, sa_family_t);
2231 __private_extern__ int pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
2232 __private_extern__ int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
2233 __private_extern__ int pf_match_xport(u_int8_t, u_int8_t, union pf_rule_xport *,
2234     union pf_state_xport *);
2235 __private_extern__ int pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
2236 __private_extern__ int pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
2237 
2238 __private_extern__ void pf_normalize_init(void);
2239 __private_extern__ int pf_normalize_isempty(void);
2240 __private_extern__ int pf_normalize_ip(struct mbuf **, int, struct pfi_kif *,
2241     u_short *, struct pf_pdesc *);
2242 __private_extern__ int pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *,
2243     u_short *, struct pf_pdesc *);
2244 __private_extern__ int pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *,
2245     int, int, void *, struct pf_pdesc *);
2246 __private_extern__ void pf_normalize_tcp_cleanup(struct pf_state *);
2247 __private_extern__ int pf_normalize_tcp_init(struct mbuf *, int,
2248     struct pf_pdesc *, struct tcphdr *, struct pf_state_peer *,
2249     struct pf_state_peer *);
2250 __private_extern__ int pf_normalize_tcp_stateful(struct mbuf *, int,
2251     struct pf_pdesc *, u_short *, struct tcphdr *, struct pf_state *,
2252     struct pf_state_peer *, struct pf_state_peer *, int *);
2253 __private_extern__ u_int64_t pf_state_expires(const struct pf_state *);
2254 __private_extern__ void pf_purge_expired_fragments(void);
2255 __private_extern__ int pf_routable(struct pf_addr *addr, sa_family_t af,
2256     struct pfi_kif *);
2257 __private_extern__ int pf_rtlabel_match(struct pf_addr *, sa_family_t,
2258     struct pf_addr_wrap *);
2259 __private_extern__ int pf_socket_lookup(int, struct pf_pdesc *);
2260 __private_extern__ struct pf_state_key *pf_alloc_state_key(struct pf_state *,
2261     struct pf_state_key *);
2262 __private_extern__ void pfr_initialize(void);
2263 __private_extern__ int pfr_match_addr(struct pfr_ktable *, struct pf_addr *,
2264     sa_family_t);
2265 __private_extern__ void pfr_update_stats(struct pfr_ktable *, struct pf_addr *,
2266     sa_family_t, u_int64_t, int, int, int);
2267 __private_extern__ int pfr_pool_get(struct pfr_ktable *, int *,
2268     struct pf_addr *, struct pf_addr **, struct pf_addr **, sa_family_t);
2269 __private_extern__ void pfr_dynaddr_update(struct pfr_ktable *,
2270     struct pfi_dynaddr *);
2271 __private_extern__ void pfr_table_copyin_cleanup(struct pfr_table *);
2272 __private_extern__ struct pfr_ktable *pfr_attach_table(struct pf_ruleset *,
2273     char *);
2274 __private_extern__ void pfr_detach_table(struct pfr_ktable *);
2275 __private_extern__ int pfr_clr_tables(struct pfr_table *, int *, int);
2276 __private_extern__ int pfr_add_tables(user_addr_t, int, int *, int);
2277 __private_extern__ int pfr_del_tables(user_addr_t, int, int *, int);
2278 __private_extern__ int pfr_get_tables(struct pfr_table *, user_addr_t,
2279     int *, int);
2280 __private_extern__ int pfr_get_tstats(struct pfr_table *, user_addr_t,
2281     int *, int);
2282 __private_extern__ int pfr_clr_tstats(user_addr_t, int, int *, int);
2283 __private_extern__ int pfr_set_tflags(user_addr_t, int, int, int, int *,
2284     int *, int);
2285 __private_extern__ int pfr_clr_addrs(struct pfr_table *, int *, int);
2286 __private_extern__ int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *,
2287     u_int64_t);
2288 __private_extern__ int pfr_add_addrs(struct pfr_table *, user_addr_t,
2289     int, int *, int);
2290 __private_extern__ int pfr_del_addrs(struct pfr_table *, user_addr_t,
2291     int, int *, int);
2292 __private_extern__ int pfr_set_addrs(struct pfr_table *, user_addr_t,
2293     int, int *, int *, int *, int *, int, u_int32_t);
2294 __private_extern__ int pfr_get_addrs(struct pfr_table *, user_addr_t,
2295     int *, int);
2296 __private_extern__ int pfr_get_astats(struct pfr_table *, user_addr_t,
2297     int *, int);
2298 __private_extern__ int pfr_clr_astats(struct pfr_table *, user_addr_t,
2299     int, int *, int);
2300 __private_extern__ int pfr_tst_addrs(struct pfr_table *, user_addr_t,
2301     int, int *, int);
2302 __private_extern__ int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *,
2303     int);
2304 __private_extern__ int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *,
2305     int);
2306 __private_extern__ int pfr_ina_commit(struct pfr_table *, u_int32_t, int *,
2307     int *, int);
2308 __private_extern__ int pfr_ina_define(struct pfr_table *, user_addr_t,
2309     int, int *, int *, u_int32_t, int);
2310 
2311 extern struct pfi_kif *pfi_all;
2312 
2313 __private_extern__ void pfi_initialize(void);
2314 __private_extern__ struct pfi_kif *pfi_kif_get(const char *);
2315 __private_extern__ void pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
2316 __private_extern__ void pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
2317 __private_extern__ int pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
2318 __private_extern__ void pfi_attach_ifnet(struct ifnet *);
2319 __private_extern__ void pfi_detach_ifnet(struct ifnet *);
2320 __private_extern__ int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
2321     sa_family_t);
2322 __private_extern__ int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
2323 __private_extern__ void pfi_dynaddr_remove(struct pf_addr_wrap *);
2324 __private_extern__ void pfi_dynaddr_copyout(struct pf_addr_wrap *);
2325 __private_extern__ void pfi_update_status(const char *, struct pf_status *);
2326 __private_extern__ int pfi_get_ifaces(const char *, user_addr_t, int *);
2327 __private_extern__ int pfi_set_flags(const char *, int);
2328 __private_extern__ int pfi_clear_flags(const char *, int);
2329 
2330 __private_extern__ u_int16_t pf_tagname2tag(char *);
2331 __private_extern__ void pf_tag2tagname(u_int16_t, char *);
2332 __private_extern__ void pf_tag_ref(u_int16_t);
2333 __private_extern__ void pf_tag_unref(u_int16_t);
2334 __private_extern__ int pf_tag_packet(struct mbuf *, struct pf_mtag *,
2335     int, unsigned int, struct pf_pdesc *);
2336 __private_extern__ void pf_step_into_anchor(int *, struct pf_ruleset **, int,
2337     struct pf_rule **, struct pf_rule **,  int *);
2338 __private_extern__ int pf_step_out_of_anchor(int *, struct pf_ruleset **, int,
2339     struct pf_rule **, struct pf_rule **, int *);
2340 __private_extern__ u_int32_t pf_qname2qid(char *);
2341 __private_extern__ void pf_qid2qname(u_int32_t, char *);
2342 __private_extern__ void pf_qid_unref(u_int32_t);
2343 
2344 extern struct pf_status pf_status;
2345 extern struct pool pf_frent_pl, pf_frag_pl;
2346 
2347 struct pf_pool_limit {
2348 	void		*pp;
2349 	unsigned	 limit;
2350 };
2351 extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
2352 
2353 __private_extern__ int pf_af_hook(struct ifnet *, struct mbuf **,
2354     struct mbuf **, unsigned int, int, struct ip_fw_args *);
2355 __private_extern__ int pf_ifaddr_hook(struct ifnet *);
2356 __private_extern__ void pf_ifnet_hook(struct ifnet *, int);
2357 
2358 /*
2359  * The following are defined with "private extern" storage class for
2360  * kernel, and "extern" for user-space.
2361  */
2362 extern struct pf_anchor_global pf_anchors;
2363 extern struct pf_anchor pf_main_anchor;
2364 #define pf_main_ruleset	pf_main_anchor.ruleset
2365 
2366 extern int pf_is_enabled;
2367 #define PF_IS_ENABLED (pf_is_enabled != 0)
2368 extern u_int32_t pf_hash_seed;
2369 
2370 #if PF_ALTQ
2371 extern u_int32_t altq_allowed;
2372 #endif /* PF_ALTQ */
2373 
2374 /* these ruleset functions can be linked into userland programs (pfctl) */
2375 __private_extern__ int pf_get_ruleset_number(u_int8_t);
2376 __private_extern__ void pf_init_ruleset(struct pf_ruleset *);
2377 __private_extern__ int pf_anchor_setup(struct pf_rule *,
2378     const struct pf_ruleset *, const char *);
2379 __private_extern__ int pf_anchor_copyout(const struct pf_ruleset *,
2380     const struct pf_rule *, struct pfioc_rule *);
2381 __private_extern__ void pf_anchor_remove(struct pf_rule *);
2382 __private_extern__ void pf_remove_if_empty_ruleset(struct pf_ruleset *);
2383 __private_extern__ struct pf_anchor *pf_find_anchor(const char *);
2384 __private_extern__ struct pf_ruleset *pf_find_ruleset(const char *);
2385 __private_extern__ struct pf_ruleset *pf_find_ruleset_with_owner(const char *,
2386     const char *, int, int *);
2387 __private_extern__ struct pf_ruleset *pf_find_or_create_ruleset(const char *);
2388 __private_extern__ void pf_rs_initialize(void);
2389 
2390 __private_extern__ int pf_osfp_add(struct pf_osfp_ioctl *);
2391 __private_extern__ struct pf_osfp_enlist *pf_osfp_fingerprint(struct pf_pdesc *,
2392     struct mbuf *, int, const struct tcphdr *);
2393 __private_extern__ struct pf_osfp_enlist *pf_osfp_fingerprint_hdr(
2394     const struct ip *, const struct ip6_hdr *, const struct tcphdr *);
2395 __private_extern__ void pf_osfp_flush(void);
2396 __private_extern__ int pf_osfp_get(struct pf_osfp_ioctl *);
2397 __private_extern__ void pf_osfp_initialize(void);
2398 __private_extern__ int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
2399 __private_extern__ struct pf_os_fingerprint *pf_osfp_validate(void);
2400 __private_extern__ struct pf_mtag *pf_find_mtag(struct mbuf *);
2401 __private_extern__ struct pf_mtag *pf_get_mtag(struct mbuf *);
2402 #else /* !KERNEL */
2403 extern struct pf_anchor_global pf_anchors;
2404 extern struct pf_anchor pf_main_anchor;
2405 #define pf_main_ruleset	pf_main_anchor.ruleset
2406 
2407 /* these ruleset functions can be linked into userland programs (pfctl) */
2408 extern int pf_get_ruleset_number(u_int8_t);
2409 extern void pf_init_ruleset(struct pf_ruleset *);
2410 extern int pf_anchor_setup(struct pf_rule *, const struct pf_ruleset *,
2411     const char *);
2412 extern int pf_anchor_copyout(const struct pf_ruleset *, const struct pf_rule *,
2413     struct pfioc_rule *);
2414 extern void pf_anchor_remove(struct pf_rule *);
2415 extern void pf_remove_if_empty_ruleset(struct pf_ruleset *);
2416 extern struct pf_anchor *pf_find_anchor(const char *);
2417 extern struct pf_ruleset *pf_find_ruleset(const char *);
2418 extern struct pf_ruleset *pf_find_ruleset_with_owner(const char *,
2419     const char *, int, int *);
2420 extern struct pf_ruleset *pf_find_or_create_ruleset(const char *);
2421 extern void pf_rs_initialize(void);
2422 #endif /* !KERNEL */
2423 
2424 #ifdef  __cplusplus
2425 }
2426 #endif
2427 #endif /* PF || !KERNEL */
2428 #endif /* PRIVATE */
2429 #endif /* _NET_PFVAR_H_ */
2430