xref: /dflybsd-src/sys/net/pf/pfvar.h (revision a9656fbcd49c376aba5e04370d8b0f1fa96e063c)
1 /*	$FreeBSD: src/sys/contrib/pf/net/pfvar.h,v 1.8 2004/08/12 13:59:44 mlaier Exp $	*/
2 /*	$OpenBSD: pfvar.h,v 1.187 2004/03/22 04:54:18 mcbride Exp $ */
3 /* add	$OpenBSD: pfvar.h,v 1.194 2004/05/11 07:34:11 dhartmei Exp $ */
4 /*	$DragonFly: src/sys/net/pf/pfvar.h,v 1.8 2008/04/11 18:21:48 dillon Exp $ */
5 /*	$OpenBSD: pfvar.h,v 1.244 2007/02/23 21:31:51 deraadt Exp $ */
6 
7 /*
8  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
9  *
10  * Copyright (c) 2001 Daniel Hartmeier
11  * All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  *    - Redistributions of source code must retain the above copyright
18  *      notice, this list of conditions and the following disclaimer.
19  *    - Redistributions in binary form must reproduce the above
20  *      copyright notice, this list of conditions and the following
21  *      disclaimer in the documentation and/or other materials provided
22  *      with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  *
37  */
38 
39 #ifndef _NET_PFVAR_H_
40 #define _NET_PFVAR_H_
41 
42 #include <sys/param.h>
43 #include <sys/types.h>
44 #include <sys/limits.h>
45 #include <sys/ioccom.h>
46 #include <sys/queue.h>
47 #include <sys/tree.h>
48 #include <sys/lock.h>
49 
50 #include <net/radix.h>
51 #include <net/if_clone.h>
52 #include <netinet/in.h>
53 #include <netinet/in_pcb.h>
54 
55 #ifdef _KERNEL
56 #include <vm/vm_zone.h>
57 #endif
58 
59 /*
60  * XXX
61  *  If we include <netipsec/keydb.h>, we need _KERNEL definition.
62  *  This makes pfctl compilation difficult.
63  */
64 union sockaddr_union {
65 	struct sockaddr		sa;
66 	struct sockaddr_in	sin;
67 	struct sockaddr_in6	sin6;
68 };
69 
70 #include <netinet/tcp_fsm.h>
71 
72 struct ip;
73 struct ip6_hdr;
74 
75 #define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
76 #define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
77 
78 
79 #define RTLABEL_LEN 32
80 #define	IFG_ALL		"all"		/* group contains all interfaces */
81 #define BPF_DIRECTION_OUT	(1<<1)
82 #define	PWAIT 0
83 #define RT_NUMFIBS 1
84 #define	ALTQ_IS_ENABLED(ifq)		((ifq)->altq_flags & ALTQF_ENABLED)
85 
86 
87 #define	PF_MD5_DIGEST_LENGTH	16
88 #ifdef MD5_DIGEST_LENGTH
89 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
90 #error
91 #endif
92 #endif
93 
94 enum	{ PF_INOUT, PF_IN, PF_OUT };
95 enum	{ PF_LAN_EXT, PF_EXT_GWY, PF_ID };
96 enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
97 	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
98 enum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
99 	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
100 enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
101 	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
102 enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
103 enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
104 	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
105 	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
106 enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
107 
108 /*
109  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
110  * PFTM_MAX, special cases afterwards. See pf_state_expires().
111  */
112 enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
113 	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
114 	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
115 	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
116 	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
117 	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
118 	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
119 	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
120 	  PFTM_UNTIL_PACKET };
121 
122 /* PFTM default values */
123 #define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
124 #define PFTM_TCP_OPENING_VAL		30	/* No response yet */
125 #define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
126 #define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
127 #define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
128 #define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
129 #define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
130 #define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
131 #define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
132 #define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
133 #define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
134 #define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
135 #define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
136 #define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
137 #define PFTM_FRAG_VAL			30	/* Fragment expire */
138 #define PFTM_INTERVAL_VAL		10	/* Expire interval */
139 #define PFTM_SRC_NODE_VAL		0	/* Source tracking */
140 #define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
141 
142 enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
143 enum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
144 	  PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
145 #define PF_POOL_IDMASK		0x0f
146 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
147 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
148 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
149 	  PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED };
150 #define PF_POOL_TYPEMASK	0x0f
151 #define PF_POOL_STICKYADDR	0x20
152 #define	PF_WSCALE_FLAG		0x80
153 #define	PF_WSCALE_MASK		0x0f
154 
155 #define	PF_LOG			0x01
156 #define	PF_LOG_ALL		0x02
157 #define	PF_LOG_SOCKET_LOOKUP	0x04
158 
159 struct pf_addr {
160 	union {
161 		struct in_addr		v4;
162 		struct in6_addr		v6;
163 		u_int8_t		addr8[16];
164 		u_int16_t		addr16[8];
165 		u_int32_t		addr32[4];
166 	} pfa;		    /* 128-bit address */
167 #define v4	pfa.v4
168 #define v6	pfa.v6
169 #define addr8	pfa.addr8
170 #define addr16	pfa.addr16
171 #define addr32	pfa.addr32
172 };
173 
174 #define	PF_TABLE_NAME_SIZE	 32
175 
176 #define PFI_AFLAG_NETWORK	0x01
177 #define PFI_AFLAG_BROADCAST	0x02
178 #define PFI_AFLAG_PEER		0x04
179 #define PFI_AFLAG_MODEMASK	0x07
180 #define PFI_AFLAG_NOALIAS	0x08
181 
182 struct pf_addr_wrap {
183 	union {
184 		struct {
185 			struct pf_addr		 addr;
186 			struct pf_addr		 mask;
187 		}			 a;
188 		char			 ifname[IFNAMSIZ];
189 		char			 tblname[PF_TABLE_NAME_SIZE];
190 		char			 rtlabelname[RTLABEL_LEN];
191 		u_int32_t		 rtlabel;
192 	}			 v;
193 	union {
194 		struct pfi_dynaddr	*dyn;
195 		struct pfr_ktable	*tbl;
196 		int			 dyncnt;
197 		int			 tblcnt;
198 	}			 p;
199 	u_int8_t		 type;		/* PF_ADDR_* */
200 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
201 };
202 
203 #ifdef _KERNEL
204 
205 struct pfi_dynaddr {
206 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
207 	struct pf_addr			 pfid_addr4;
208 	struct pf_addr			 pfid_mask4;
209 	struct pf_addr			 pfid_addr6;
210 	struct pf_addr			 pfid_mask6;
211 	struct pfr_ktable		*pfid_kt;
212 	struct pfi_kif			*pfid_kif;
213 	void				*pfid_hook_cookie;
214 	int				 pfid_net;	/* mask or 128 */
215 	int				 pfid_acnt4;	/* address count IPv4 */
216 	int				 pfid_acnt6;	/* address count IPv6 */
217 	sa_family_t			 pfid_af;	/* rule af */
218 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
219 };
220 
221 /*
222  * Address manipulation macros
223  */
224 
225 /* XXX correct values for zinit? */
226 #define	ZONE_CREATE(var, type, desc)					\
227 	var = zinit(desc, sizeof(type), 1, ZONE_DESTROYABLE, 1);	\
228 	if (var == NULL) break
229 #define	ZONE_DESTROY(a) zdestroy(a)
230 
231 #define	pool_get(p, f)	zalloc(*(p))
232 #define	pool_put(p, o)	zfree(*(p), (o))
233 
234 #define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
235 #define HTONS(x)	(x) = htons((__uint16_t)(x))
236 
237 #define	PF_NAME		"pf"
238 
239 #define	PF_MODVER	1
240 #define	PFLOG_MODVER	1
241 #define	PFSYNC_MODVER	1
242 
243 #define	PFLOG_MINVER	1
244 #define	PFLOG_PREFVER	PFLOG_MODVER
245 #define	PFLOG_MAXVER	1
246 #define	PFSYNC_MINVER	1
247 #define	PFSYNC_PREFVER	PFSYNC_MODVER
248 #define	PFSYNC_MAXVER	1
249 
250 /* prototyped for pf_subr.c */
251 struct hook_desc {
252 	TAILQ_ENTRY(hook_desc) hd_list;
253 	void	(*hd_fn)(void *);
254 	void	*hd_arg;
255 };
256 TAILQ_HEAD(hook_desc_head, hook_desc);
257 
258 void *hook_establish(struct hook_desc_head *, int, void (*)(void *), void *);
259 void hook_disestablish(struct hook_desc_head *, void *);
260 void dohooks(struct hook_desc_head *, int);
261 
262 #define	HOOK_REMOVE     0x01
263 #define	HOOK_FREE       0x02
264 
265 #ifdef INET
266 #ifndef INET6
267 #define PF_INET_ONLY
268 #endif /* ! INET6 */
269 #endif /* INET */
270 
271 #ifdef INET6
272 #ifndef INET
273 #define PF_INET6_ONLY
274 #endif /* ! INET */
275 #endif /* INET6 */
276 
277 #ifdef INET
278 #ifdef INET6
279 #define PF_INET_INET6
280 #endif /* INET6 */
281 #endif /* INET */
282 
283 #else
284 
285 #define PF_INET_INET6
286 
287 #endif /* _KERNEL */
288 
289 /* Both IPv4 and IPv6 */
290 #ifdef PF_INET_INET6
291 
292 #define PF_AEQ(a, b, c) \
293 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
294 	((a)->addr32[3] == (b)->addr32[3] && \
295 	(a)->addr32[2] == (b)->addr32[2] && \
296 	(a)->addr32[1] == (b)->addr32[1] && \
297 	(a)->addr32[0] == (b)->addr32[0])) \
298 
299 #define PF_ANEQ(a, b, c) \
300 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
301 	((a)->addr32[3] != (b)->addr32[3] || \
302 	(a)->addr32[2] != (b)->addr32[2] || \
303 	(a)->addr32[1] != (b)->addr32[1] || \
304 	(a)->addr32[0] != (b)->addr32[0])) \
305 
306 #define PF_AZERO(a, c) \
307 	((c == AF_INET && !(a)->addr32[0]) || \
308 	(!(a)->addr32[0] && !(a)->addr32[1] && \
309 	!(a)->addr32[2] && !(a)->addr32[3] )) \
310 
311 #define PF_MATCHA(n, a, m, b, f) \
312 	pf_match_addr(n, a, m, b, f)
313 
314 #define PF_ACPY(a, b, f) \
315 	pf_addrcpy(a, b, f)
316 
317 #define PF_AINC(a, f) \
318 	pf_addr_inc(a, f)
319 
320 #define PF_POOLMASK(a, b, c, d, f) \
321 	pf_poolmask(a, b, c, d, f)
322 
323 #else
324 
325 /* Just IPv6 */
326 
327 #ifdef PF_INET6_ONLY
328 
329 #define PF_AEQ(a, b, c) \
330 	((a)->addr32[3] == (b)->addr32[3] && \
331 	(a)->addr32[2] == (b)->addr32[2] && \
332 	(a)->addr32[1] == (b)->addr32[1] && \
333 	(a)->addr32[0] == (b)->addr32[0]) \
334 
335 #define PF_ANEQ(a, b, c) \
336 	((a)->addr32[3] != (b)->addr32[3] || \
337 	(a)->addr32[2] != (b)->addr32[2] || \
338 	(a)->addr32[1] != (b)->addr32[1] || \
339 	(a)->addr32[0] != (b)->addr32[0]) \
340 
341 #define PF_AZERO(a, c) \
342 	(!(a)->addr32[0] && \
343 	!(a)->addr32[1] && \
344 	!(a)->addr32[2] && \
345 	!(a)->addr32[3] ) \
346 
347 #define PF_MATCHA(n, a, m, b, f) \
348 	pf_match_addr(n, a, m, b, f)
349 
350 #define PF_ACPY(a, b, f) \
351 	pf_addrcpy(a, b, f)
352 
353 #define PF_AINC(a, f) \
354 	pf_addr_inc(a, f)
355 
356 #define PF_POOLMASK(a, b, c, d, f) \
357 	pf_poolmask(a, b, c, d, f)
358 
359 #else
360 
361 /* Just IPv4 */
362 #ifdef PF_INET_ONLY
363 
364 #define PF_AEQ(a, b, c) \
365 	((a)->addr32[0] == (b)->addr32[0])
366 
367 #define PF_ANEQ(a, b, c) \
368 	((a)->addr32[0] != (b)->addr32[0])
369 
370 #define PF_AZERO(a, c) \
371 	(!(a)->addr32[0])
372 
373 #define PF_MATCHA(n, a, m, b, f) \
374 	pf_match_addr(n, a, m, b, f)
375 
376 #define PF_ACPY(a, b, f) \
377 	(a)->v4.s_addr = (b)->v4.s_addr
378 
379 #define PF_AINC(a, f) \
380 	do { \
381 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
382 	} while (0)
383 
384 #define PF_POOLMASK(a, b, c, d, f) \
385 	do { \
386 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
387 		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
388 	} while (0)
389 
390 #endif /* PF_INET_ONLY */
391 #endif /* PF_INET6_ONLY */
392 #endif /* PF_INET_INET6 */
393 
394 #define	PF_MISMATCHAW(aw, x, af, neg, ifp)				\
395 	(								\
396 		(((aw)->type == PF_ADDR_NOROUTE &&			\
397 		    pf_routable((x), (af), NULL)) ||			\
398 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
399 		    pf_routable((x), (af), (ifp))) ||			\
400 		((aw)->type == PF_ADDR_RTLABEL &&			\
401 		    !pf_rtlabel_match((x), (af), (aw))) ||		\
402 		((aw)->type == PF_ADDR_TABLE &&				\
403 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
404 		((aw)->type == PF_ADDR_DYNIFTL &&			\
405 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) || 	\
406 		((aw)->type == PF_ADDR_ADDRMASK &&			\
407 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
408 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
409 		    &(aw)->v.a.mask, (x), (af))))) !=			\
410 		(neg)							\
411 	)
412 
413 
414 struct pf_rule_uid {
415 	uid_t		 uid[2];
416 	u_int8_t	 op;
417 };
418 
419 struct pf_rule_gid {
420 	uid_t		 gid[2];
421 	u_int8_t	 op;
422 };
423 
424 struct pf_rule_addr {
425 	struct pf_addr_wrap	 addr;
426 	u_int16_t		 port[2];
427 	u_int8_t		 neg;
428 	u_int8_t		 port_op;
429 };
430 
431 struct pf_pooladdr {
432 	struct pf_addr_wrap		 addr;
433 	TAILQ_ENTRY(pf_pooladdr)	 entries;
434 	char				 ifname[IFNAMSIZ];
435 	struct pfi_kif			*kif;
436 };
437 
438 TAILQ_HEAD(pf_palist, pf_pooladdr);
439 
440 struct pf_poolhashkey {
441 	union {
442 		u_int8_t		key8[16];
443 		u_int16_t		key16[8];
444 		u_int32_t		key32[4];
445 	} pfk;		    /* 128-bit hash key */
446 #define key8	pfk.key8
447 #define key16	pfk.key16
448 #define key32	pfk.key32
449 };
450 
451 struct pf_pool {
452 	struct pf_palist	 list;
453 	struct pf_pooladdr	*cur;
454 	struct pf_poolhashkey	 key;
455 	struct pf_addr		 counter;
456 	int			 tblidx;
457 	u_int16_t		 proxy_port[2];
458 	u_int8_t		 port_op;
459 	u_int8_t		 opts;
460 };
461 
462 
463 /* A packed Operating System description for fingerprinting */
464 typedef u_int32_t pf_osfp_t;
465 #define PF_OSFP_ANY	((pf_osfp_t)0)
466 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
467 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
468 
469 struct pf_osfp_entry {
470 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
471 	pf_osfp_t		fp_os;
472 	int			fp_enflags;
473 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
474 #define PF_OSFP_GENERIC		0x002		/* generic signature */
475 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
476 #define PF_OSFP_LEN	32
477 	char			fp_class_nm[PF_OSFP_LEN];
478 	char			fp_version_nm[PF_OSFP_LEN];
479 	char			fp_subtype_nm[PF_OSFP_LEN];
480 };
481 #define PF_OSFP_ENTRY_EQ(a, b) \
482     ((a)->fp_os == (b)->fp_os && \
483     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
484     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
485     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
486 
487 /* handle pf_osfp_t packing */
488 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
489 #define _FP_UNUSED_BITS		1
490 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
491 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
492 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
493 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
494 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
495 	    ((1 << _FP_CLASS_BITS) - 1); \
496 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
497 	    ((1 << _FP_VERSION_BITS) - 1);\
498 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
499 } while(0)
500 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
501 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
502 	    + _FP_SUBTYPE_BITS); \
503 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
504 	    _FP_SUBTYPE_BITS; \
505 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
506 } while(0)
507 
508 /* the fingerprint of an OSes TCP SYN packet */
509 typedef u_int64_t	pf_tcpopts_t;
510 struct pf_os_fingerprint {
511 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
512 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
513 	u_int16_t		fp_wsize;	/* TCP window size */
514 	u_int16_t		fp_psize;	/* ip->ip_len */
515 	u_int16_t		fp_mss;		/* TCP MSS */
516 	u_int16_t		fp_flags;
517 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
518 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
519 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
520 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
521 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
522 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
523 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
524 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
525 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
526 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
527 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
528 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
529 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
530 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
531 #define PF_OSFP_INET6		0x4000		/* IPv6 */
532 	u_int8_t		fp_optcnt;	/* TCP option count */
533 	u_int8_t		fp_wscale;	/* TCP window scaling */
534 	u_int8_t		fp_ttl;		/* IPv4 TTL */
535 #define PF_OSFP_MAXTTL_OFFSET	40
536 /* TCP options packing */
537 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
538 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
539 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
540 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
541 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
542 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
543 #define PF_OSFP_MAX_OPTS \
544     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
545     / PF_OSFP_TCPOPT_BITS
546 
547 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
548 };
549 
550 struct pf_osfp_ioctl {
551 	struct pf_osfp_entry	fp_os;
552 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
553 	u_int16_t		fp_wsize;	/* TCP window size */
554 	u_int16_t		fp_psize;	/* ip->ip_len */
555 	u_int16_t		fp_mss;		/* TCP MSS */
556 	u_int16_t		fp_flags;
557 	u_int8_t		fp_optcnt;	/* TCP option count */
558 	u_int8_t		fp_wscale;	/* TCP window scaling */
559 	u_int8_t		fp_ttl;		/* IPv4 TTL */
560 
561 	int			fp_getnum;	/* DIOCOSFPGET number */
562 };
563 
564 
565 union pf_rule_ptr {
566 	struct pf_rule		*ptr;
567 	u_int32_t		 nr;
568 };
569 
570 #define	PF_ANCHOR_NAME_SIZE	 64
571 
572 struct pf_rule {
573 	struct pf_rule_addr	 src;
574 	struct pf_rule_addr	 dst;
575 #define PF_SKIP_IFP		0
576 #define PF_SKIP_DIR		1
577 #define PF_SKIP_AF		2
578 #define PF_SKIP_PROTO		3
579 #define PF_SKIP_SRC_ADDR	4
580 #define PF_SKIP_SRC_PORT	5
581 #define PF_SKIP_DST_ADDR	6
582 #define PF_SKIP_DST_PORT	7
583 #define PF_SKIP_COUNT		8
584 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
585 #define PF_RULE_LABEL_SIZE	 64
586 	char			 label[PF_RULE_LABEL_SIZE];
587 #define PF_QNAME_SIZE		 64
588 	char			 ifname[IFNAMSIZ];
589 	char			 qname[PF_QNAME_SIZE];
590 	char			 pqname[PF_QNAME_SIZE];
591 #define	PF_TAG_NAME_SIZE	 64
592 	char			 tagname[PF_TAG_NAME_SIZE];
593 	char			 match_tagname[PF_TAG_NAME_SIZE];
594 
595 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
596 
597 	TAILQ_ENTRY(pf_rule)	 entries;
598 	struct pf_pool		 rpool;
599 
600 	u_int64_t		 evaluations;
601 	u_int64_t		 packets[2];
602 	u_int64_t		 bytes[2];
603 
604 	struct pfi_kif		*kif;
605 	struct pf_anchor	*anchor;
606 	struct pfr_ktable	*overload_tbl;
607 
608 	pf_osfp_t		 os_fingerprint;
609 
610 	int			 rtableid;
611 	u_int32_t		 timeout[PFTM_MAX];
612 	u_int32_t		 states;
613 	u_int32_t		 max_states;
614 	u_int32_t		 src_nodes;
615 	u_int32_t		 max_src_nodes;
616 	u_int32_t		 max_src_states;
617 	u_int32_t		 max_src_conn;
618 	struct {
619 		u_int32_t		limit;
620 		u_int32_t		seconds;
621 	}			 max_src_conn_rate;
622 	u_int32_t		 qid;
623 	u_int32_t		 pqid;
624 	u_int32_t		 rt_listid;
625 	u_int32_t		 nr;
626 	u_int32_t		 prob;
627 	uid_t			 cuid;
628 	pid_t			 cpid;
629 
630 	u_int16_t		 return_icmp;
631 	u_int16_t		 return_icmp6;
632 	u_int16_t		 max_mss;
633 	u_int16_t		 tag;
634 	u_int16_t		 match_tag;
635 
636 	struct pf_rule_uid	 uid;
637 	struct pf_rule_gid	 gid;
638 
639 	u_int32_t		 rule_flag;
640 	u_int8_t		 action;
641 	u_int8_t		 direction;
642 	u_int8_t		 log;
643 	u_int8_t		 logif;
644 	u_int8_t		 quick;
645 	u_int8_t		 ifnot;
646 	u_int8_t		 match_tag_not;
647 	u_int8_t		 natpass;
648 
649 #define PF_STATE_NORMAL		0x1
650 #define PF_STATE_MODULATE	0x2
651 #define PF_STATE_SYNPROXY	0x3
652 	u_int8_t		 keep_state;
653 	sa_family_t		 af;
654 	u_int8_t		 proto;
655 	u_int8_t		 type;
656 	u_int8_t		 code;
657 	u_int8_t		 flags;
658 	u_int8_t		 flagset;
659 	u_int8_t		 min_ttl;
660 	u_int8_t		 allow_opts;
661 	u_int8_t		 rt;
662 	u_int8_t		 return_ttl;
663 	u_int8_t		 tos;
664 	u_int8_t		 anchor_relative;
665 	u_int8_t		 anchor_wildcard;
666 
667 #define PF_FLUSH		0x01
668 #define PF_FLUSH_GLOBAL		0x02
669 	u_int8_t		 flush;
670 
671 #define PF_PICKUPS_UNSPECIFIED	0
672 #define PF_PICKUPS_DISABLED	1
673 #define PF_PICKUPS_HASHONLY	2
674 #define PF_PICKUPS_ENABLED	3
675 	u_int8_t		 pickup_mode;
676 	u_int8_t		 unused01;	/* available for use */
677 };
678 
679 /* rule flags */
680 #define	PFRULE_DROP		0x0000
681 #define	PFRULE_RETURNRST	0x0001
682 #define	PFRULE_FRAGMENT		0x0002
683 #define	PFRULE_RETURNICMP	0x0004
684 #define	PFRULE_RETURN		0x0008
685 #define	PFRULE_NOSYNC		0x0010
686 #define PFRULE_SRCTRACK		0x0020  /* track source states */
687 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
688 
689 /* scrub flags */
690 #define	PFRULE_NODF		0x0100
691 #define	PFRULE_FRAGCROP		0x0200	/* non-buffering frag cache */
692 #define	PFRULE_FRAGDROP		0x0400	/* drop funny fragments */
693 #define PFRULE_RANDOMID		0x0800
694 #define PFRULE_REASSEMBLE_TCP	0x1000
695 
696 /* rule flags again */
697 #define PFRULE_IFBOUND		0x00010000	/* if-bound */
698 
699 #define PFSTATE_HIWAT		10000	/* default state table size */
700 #define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
701 #define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
702 
703 
704 struct pf_threshold {
705 	u_int32_t	limit;
706 #define	PF_THRESHOLD_MULT	1000
707 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
708 	u_int32_t	seconds;
709 	u_int32_t	count;
710 	u_int32_t	last;
711 };
712 
713 struct pf_src_node {
714 	RB_ENTRY(pf_src_node) entry;
715 	struct pf_addr	 addr;
716 	struct pf_addr	 raddr;
717 	union pf_rule_ptr rule;
718 	struct pfi_kif	*kif;
719 	u_int64_t	 bytes[2];
720 	u_int64_t	 packets[2];
721 	u_int32_t	 states;
722 	u_int32_t	 conn;
723 	struct pf_threshold	conn_rate;
724 	u_int32_t	 creation;
725 	u_int32_t	 expire;
726 	sa_family_t	 af;
727 	u_int8_t	 ruletype;
728 };
729 
730 #define PFSNODE_HIWAT		10000	/* default source node table size */
731 
732 struct pf_state_scrub {
733 	struct timeval	pfss_last;	/* time received last packet	*/
734 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
735 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
736 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
737 	u_int16_t	pfss_flags;
738 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
739 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
740 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
741 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
742 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
743 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
744 	u_int8_t	pad;
745 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
746 };
747 
748 struct pf_state_host {
749 	struct pf_addr	addr;
750 	u_int16_t	port;
751 	u_int16_t	pad;
752 };
753 
754 struct pf_state_peer {
755 	u_int32_t	seqlo;		/* Max sequence number sent	*/
756 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
757 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
758 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
759 	u_int8_t	state;		/* active state level		*/
760 	u_int8_t	wscale;		/* window scaling factor	*/
761 	u_int16_t	mss;		/* Maximum segment size option	*/
762 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
763 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
764 	u_int8_t	pad[3];
765 };
766 
767 TAILQ_HEAD(pf_state_queue, pf_state);
768 
769 /* keep synced with struct pf_state, used in RB_FIND */
770 struct pf_state_cmp {
771 	u_int64_t	 id;
772 	u_int32_t	 creatorid;
773 	struct pf_state_host lan;
774 	struct pf_state_host gwy;
775 	struct pf_state_host ext;
776 	sa_family_t	 af;
777 	u_int8_t	 proto;
778 	u_int8_t	 direction;
779 	u_int8_t	 pad;
780 };
781 
782 struct pf_state {
783 	u_int64_t	 id;
784 	u_int32_t	 creatorid;
785 	struct pf_state_host lan;
786 	struct pf_state_host gwy;
787 	struct pf_state_host ext;
788 	sa_family_t	 af;
789 	u_int8_t	 proto;
790 	u_int8_t	 direction;
791 	u_int8_t	 pad;
792 	u_int8_t	 log;
793 	u_int8_t	 allow_opts;
794 	u_int8_t	 timeout;
795 	u_int8_t	 sync_flags;
796 	u_int8_t	 pickup_mode;
797 #define	PFSTATE_NOSYNC	 0x01
798 #define	PFSTATE_FROMSYNC 0x02
799 #define	PFSTATE_STALE	 0x04
800 #define PFSTATE_GOT_SYN1 0x04	/* got SYN in one direction */
801 #define PFSTATE_GOT_SYN2 0x08	/* got SYN in the other direction */
802 	union {
803 		struct {
804 			RB_ENTRY(pf_state)	 entry_lan_ext;
805 			RB_ENTRY(pf_state)	 entry_ext_gwy;
806 			RB_ENTRY(pf_state)	 entry_id;
807 			TAILQ_ENTRY(pf_state)	 entry_list;
808 			struct pfi_kif		*kif;
809 		} s;
810 		char	 ifname[IFNAMSIZ];
811 	} u;
812 	struct pf_state_peer src;
813 	struct pf_state_peer dst;
814 	union pf_rule_ptr rule;
815 	union pf_rule_ptr anchor;
816 	union pf_rule_ptr nat_rule;
817 	struct pf_addr	 rt_addr;
818 	struct pfi_kif	*rt_kif;
819 	struct pf_src_node	*src_node;
820 	struct pf_src_node	*nat_src_node;
821 	u_int64_t	 packets[2];
822 	u_int64_t	 bytes[2];
823 	u_int32_t	 hash;
824 	u_int32_t	 creation;
825 	u_int32_t	 expire;
826 	u_int32_t	 pfsync_time;
827 	u_int16_t	 tag;
828 };
829 
830 #define PFSTATE_GOT_SYN_MASK	(PFSTATE_GOT_SYN1|PFSTATE_GOT_SYN2)
831 
832 TAILQ_HEAD(pf_rulequeue, pf_rule);
833 
834 struct pf_anchor;
835 
836 struct pf_ruleset {
837 	struct {
838 		struct pf_rulequeue	 queues[2];
839 		struct {
840 			struct pf_rulequeue	*ptr;
841 			struct pf_rule		**ptr_array;
842 			u_int32_t		 rcount;
843 			u_int32_t		 ticket;
844 			int			 open;
845 		}			 active, inactive;
846 	}			 rules[PF_RULESET_MAX];
847 	struct pf_anchor	*anchor;
848 	u_int32_t		 tticket;
849 	int			 tables;
850 	int			 topen;
851 };
852 
853 RB_HEAD(pf_anchor_global, pf_anchor);
854 RB_HEAD(pf_anchor_node, pf_anchor);
855 struct pf_anchor {
856 	RB_ENTRY(pf_anchor)	 entry_global;
857 	RB_ENTRY(pf_anchor)	 entry_node;
858 	struct pf_anchor	*parent;
859 	struct pf_anchor_node	 children;
860 	char			 name[PF_ANCHOR_NAME_SIZE];
861 	char			 path[MAXPATHLEN];
862 	struct pf_ruleset	 ruleset;
863 	int			 refcnt;	/* anchor rules */
864 	int			 match;
865 };
866 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
867 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
868 
869 #define PF_RESERVED_ANCHOR	"_pf"
870 
871 #define PFR_TFLAG_PERSIST	0x00000001
872 #define PFR_TFLAG_CONST		0x00000002
873 #define PFR_TFLAG_ACTIVE	0x00000004
874 #define PFR_TFLAG_INACTIVE	0x00000008
875 #define PFR_TFLAG_REFERENCED	0x00000010
876 #define PFR_TFLAG_REFDANCHOR	0x00000020
877 #define PFR_TFLAG_USRMASK	0x00000003
878 #define PFR_TFLAG_SETMASK	0x0000003C
879 #define PFR_TFLAG_ALLMASK	0x0000003F
880 
881 struct pfr_table {
882 	char			 pfrt_anchor[MAXPATHLEN];
883 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
884 	u_int32_t		 pfrt_flags;
885 	u_int8_t		 pfrt_fback;
886 };
887 
888 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
889 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
890 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
891 
892 struct pfr_addr {
893 	union {
894 		struct in_addr	 _pfra_ip4addr;
895 		struct in6_addr	 _pfra_ip6addr;
896 	}		 pfra_u;
897 	u_int8_t	 pfra_af;
898 	u_int8_t	 pfra_net;
899 	u_int8_t	 pfra_not;
900 	u_int8_t	 pfra_fback;
901 };
902 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
903 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
904 
905 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
906 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
907 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
908 
909 struct pfr_astats {
910 	struct pfr_addr	 pfras_a;
911 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
912 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
913 	long		 pfras_tzero;
914 };
915 
916 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
917 
918 struct pfr_tstats {
919 	struct pfr_table pfrts_t;
920 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
921 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
922 	u_int64_t	 pfrts_match;
923 	u_int64_t	 pfrts_nomatch;
924 	long		 pfrts_tzero;
925 	int		 pfrts_cnt;
926 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
927 };
928 #define	pfrts_name	pfrts_t.pfrt_name
929 #define pfrts_flags	pfrts_t.pfrt_flags
930 
931 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
932 struct pfr_kentry {
933 	struct radix_node	 pfrke_node[2];
934 	union sockaddr_union	 pfrke_sa;
935 	u_int64_t		 pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
936 	u_int64_t		 pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
937 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
938 	long			 pfrke_tzero;
939 	u_int8_t		 pfrke_af;
940 	u_int8_t		 pfrke_net;
941 	u_int8_t		 pfrke_not;
942 	u_int8_t		 pfrke_mark;
943 	u_int8_t		 pfrke_intrpool;
944 };
945 
946 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
947 RB_HEAD(pfr_ktablehead, pfr_ktable);
948 struct pfr_ktable {
949 	struct pfr_tstats	 pfrkt_ts;
950 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
951 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
952 	struct radix_node_head	*pfrkt_ip4;
953 	struct radix_node_head	*pfrkt_ip6;
954 	struct pfr_ktable	*pfrkt_shadow;
955 	struct pfr_ktable	*pfrkt_root;
956 	struct pf_ruleset	*pfrkt_rs;
957 	long			 pfrkt_larg;
958 	int			 pfrkt_nflags;
959 };
960 #define pfrkt_t		pfrkt_ts.pfrts_t
961 #define pfrkt_name	pfrkt_t.pfrt_name
962 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
963 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
964 #define pfrkt_flags	pfrkt_t.pfrt_flags
965 #define pfrkt_cnt	pfrkt_ts.pfrts_cnt
966 #define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
967 #define pfrkt_packets	pfrkt_ts.pfrts_packets
968 #define pfrkt_bytes	pfrkt_ts.pfrts_bytes
969 #define pfrkt_match	pfrkt_ts.pfrts_match
970 #define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
971 #define pfrkt_tzero	pfrkt_ts.pfrts_tzero
972 
973 RB_HEAD(pf_state_tree_lan_ext, pf_state);
974 RB_PROTOTYPE(pf_state_tree_lan_ext, pf_state,
975     u.s.entry_lan_ext, pf_state_compare_lan_ext);
976 
977 RB_HEAD(pf_state_tree_ext_gwy, pf_state);
978 RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state,
979     u.s.entry_ext_gwy, pf_state_compare_ext_gwy);
980 
981 struct pfi_if {
982 	char				 pfif_name[IFNAMSIZ];
983 	u_int64_t			 pfif_packets[2][2][2];
984 	u_int64_t			 pfif_bytes[2][2][2];
985 	u_int64_t			 pfif_addcnt;
986 	u_int64_t			 pfif_delcnt;
987 	long				 pfif_tzero;
988 	int				 pfif_states;
989 	int				 pfif_rules;
990 	int				 pfif_flags;
991 };
992 
993 TAILQ_HEAD(pfi_grouphead, pfi_kif);
994 TAILQ_HEAD(pfi_statehead, pfi_kif);
995 RB_HEAD(pfi_ifhead, pfi_kif);
996 
997 /* keep synced with pfi_kif, used in RB_FIND */
998 struct pfi_kif_cmp {
999 	char				 pfik_ifname[IFNAMSIZ];
1000 };
1001 
1002 struct pfi_kif {
1003 	struct pfi_if			 pfik_if;
1004 	RB_ENTRY(pfi_kif)		 pfik_tree;
1005 	u_int64_t			 pfik_packets[2][2][2];
1006 	u_int64_t			 pfik_bytes[2][2][2];
1007 	u_int32_t			 pfik_tzero;
1008 	int				 pfik_flags;
1009 	struct pf_state_tree_lan_ext	 pfik_lan_ext;
1010 	struct pf_state_tree_ext_gwy	 pfik_ext_gwy;
1011 	struct pfi_grouphead		 pfik_grouphead;
1012 	TAILQ_ENTRY(pfi_kif)		 pfik_instances;
1013 	TAILQ_ENTRY(pfi_kif)		 pfik_w_states;
1014 	struct hook_desc_head		*pfik_ah_head;
1015 	void				*pfik_ah_cookie;
1016 	struct pfi_kif			*pfik_parent;
1017 	struct ifnet			*pfik_ifp;
1018 	struct ifg_group		*pfik_group;
1019 	int				 pfik_states;
1020 	int				 pfik_rules;
1021 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1022 };
1023 #define pfik_name	pfik_if.pfif_name
1024 #define pfik_packets	pfik_if.pfif_packets
1025 #define pfik_bytes	pfik_if.pfif_bytes
1026 #define pfik_tzero	pfik_if.pfif_tzero
1027 #define pfik_flags	pfik_if.pfif_flags
1028 #define pfik_addcnt	pfik_if.pfif_addcnt
1029 #define pfik_delcnt	pfik_if.pfif_delcnt
1030 #define pfik_states	pfik_if.pfif_states
1031 #define pfik_rules	pfik_if.pfif_rules
1032 
1033 enum pfi_kif_refs {
1034 	PFI_KIF_REF_NONE,
1035 	PFI_KIF_REF_STATE,
1036 	PFI_KIF_REF_RULE
1037 };
1038 
1039 #define PFI_IFLAG_GROUP		0x0001	/* group of interfaces */
1040 #define PFI_IFLAG_INSTANCE	0x0002	/* single instance */
1041 #define PFI_IFLAG_CLONABLE	0x0010	/* clonable group */
1042 #define PFI_IFLAG_DYNAMIC	0x0020	/* dynamic group */
1043 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1044 #define PFI_IFLAG_PLACEHOLDER	0x8000	/* placeholder group/interface */
1045 
1046 struct pf_pdesc {
1047 	struct {
1048 		int	 done;
1049 		uid_t	 uid;
1050 		gid_t	 gid;
1051 		pid_t	 pid;
1052 	}		 lookup;
1053 	u_int64_t	 tot_len;	/* Make Mickey money */
1054 	union {
1055 		struct tcphdr		*tcp;
1056 		struct udphdr		*udp;
1057 		struct icmp		*icmp;
1058 #ifdef INET6
1059 		struct icmp6_hdr	*icmp6;
1060 #endif /* INET6 */
1061 		void			*any;
1062 	} hdr;
1063 	struct pf_addr	 baddr;		/* address before translation */
1064 	struct pf_addr	 naddr;		/* address after translation */
1065 	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1066 	struct pf_addr	*src;
1067 	struct pf_addr	*dst;
1068 	struct ether_header
1069 			*eh;
1070 	struct pf_mtag	*pf_mtag;
1071 	u_int16_t	*ip_sum;
1072 	u_int32_t	 p_len;		/* total length of payload */
1073 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1074 					 * state code. Easier than tags */
1075 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1076 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1077 	sa_family_t	 af;
1078 	u_int8_t	 proto;
1079 	u_int8_t	 tos;
1080 };
1081 
1082 /* flags for RDR options */
1083 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1084 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1085 
1086 /* Reasons code for passing/dropping a packet */
1087 #define PFRES_MATCH	0		/* Explicit match of a rule */
1088 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1089 #define PFRES_FRAG	2		/* Dropping following fragment */
1090 #define PFRES_SHORT	3		/* Dropping short packet */
1091 #define PFRES_NORM	4		/* Dropping by normalizer */
1092 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1093 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1094 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1095 #define PFRES_IPOPTIONS 8		/* IP option */
1096 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1097 #define PFRES_BADSTATE	10		/* State mismatch */
1098 #define PFRES_STATEINS	11		/* State insertion failure */
1099 #define PFRES_MAXSTATES	12		/* State limit */
1100 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1101 #define PFRES_SYNPROXY	14		/* SYN proxy */
1102 #define PFRES_MAX	15		/* total+1 */
1103 
1104 #define PFRES_NAMES { \
1105 	"match", \
1106 	"bad-offset", \
1107 	"fragment", \
1108 	"short", \
1109 	"normalize", \
1110 	"memory", \
1111 	"bad-timestamp", \
1112 	"congestion", \
1113 	"ip-option", \
1114 	"proto-cksum", \
1115 	"state-mismatch", \
1116 	"state-insert", \
1117 	"state-limit", \
1118 	"src-limit", \
1119 	"synproxy", \
1120 	NULL \
1121 }
1122 
1123 /* Counters for other things we want to keep track of */
1124 #define LCNT_STATES		0	/* states */
1125 #define LCNT_SRCSTATES		1	/* max-src-states */
1126 #define LCNT_SRCNODES		2	/* max-src-nodes */
1127 #define LCNT_SRCCONN		3	/* max-src-conn */
1128 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1129 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1130 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1131 #define LCNT_MAX		7	/* total+1 */
1132 
1133 #define LCNT_NAMES { \
1134 	"max states per rule", \
1135 	"max-src-states", \
1136 	"max-src-nodes", \
1137 	"max-src-conn", \
1138 	"max-src-conn-rate", \
1139 	"overload table insertion", \
1140 	"overload flush states", \
1141 	NULL \
1142 }
1143 
1144 /* UDP state enumeration */
1145 #define PFUDPS_NO_TRAFFIC	0
1146 #define PFUDPS_SINGLE		1
1147 #define PFUDPS_MULTIPLE		2
1148 
1149 #define PFUDPS_NSTATES		3	/* number of state levels */
1150 
1151 #define PFUDPS_NAMES { \
1152 	"NO_TRAFFIC", \
1153 	"SINGLE", \
1154 	"MULTIPLE", \
1155 	NULL \
1156 }
1157 
1158 /* Other protocol state enumeration */
1159 #define PFOTHERS_NO_TRAFFIC	0
1160 #define PFOTHERS_SINGLE		1
1161 #define PFOTHERS_MULTIPLE	2
1162 
1163 #define PFOTHERS_NSTATES	3	/* number of state levels */
1164 
1165 #define PFOTHERS_NAMES { \
1166 	"NO_TRAFFIC", \
1167 	"SINGLE", \
1168 	"MULTIPLE", \
1169 	NULL \
1170 }
1171 
1172 #define FCNT_STATE_SEARCH	0
1173 #define FCNT_STATE_INSERT	1
1174 #define FCNT_STATE_REMOVALS	2
1175 #define FCNT_MAX		3
1176 
1177 #define SCNT_SRC_NODE_SEARCH	0
1178 #define SCNT_SRC_NODE_INSERT	1
1179 #define SCNT_SRC_NODE_REMOVALS	2
1180 #define SCNT_MAX		3
1181 
1182 #define ACTION_SET(a, x) \
1183 	do { \
1184 		if ((a) != NULL) \
1185 			*(a) = (x); \
1186 	} while (0)
1187 
1188 #define REASON_SET(a, x) \
1189 	do { \
1190 		if ((a) != NULL) \
1191 			*(a) = (x); \
1192 		if (x < PFRES_MAX) \
1193 			pf_status.counters[x]++; \
1194 	} while (0)
1195 
1196 struct pf_status {
1197 	u_int64_t	counters[PFRES_MAX];
1198 	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1199 	u_int64_t	fcounters[FCNT_MAX];
1200 	u_int64_t	scounters[SCNT_MAX];
1201 	u_int64_t	pcounters[2][2][3];
1202 	u_int64_t	bcounters[2][2];
1203 	u_int64_t	stateid;
1204 	u_int32_t	running;
1205 	u_int32_t	states;
1206 	u_int32_t	src_nodes;
1207 	u_int32_t	since;
1208 	u_int32_t	debug;
1209 	u_int32_t	hostid;
1210 	char		ifname[IFNAMSIZ];
1211 	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1212 };
1213 
1214 struct cbq_opts {
1215 	u_int		minburst;
1216 	u_int		maxburst;
1217 	u_int		pktsize;
1218 	u_int		maxpktsize;
1219 	u_int		ns_per_byte;
1220 	u_int		maxidle;
1221 	int		minidle;
1222 	u_int		offtime;
1223 	int		flags;
1224 };
1225 
1226 struct priq_opts {
1227 	int		flags;
1228 };
1229 
1230 struct hfsc_opts {
1231 	/* real-time service curve */
1232 	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
1233 	u_int		rtsc_d;		/* the x-projection of m1 in msec */
1234 	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
1235 	/* link-sharing service curve */
1236 	u_int		lssc_m1;
1237 	u_int		lssc_d;
1238 	u_int		lssc_m2;
1239 	/* upper-limit service curve */
1240 	u_int		ulsc_m1;
1241 	u_int		ulsc_d;
1242 	u_int		ulsc_m2;
1243 	int		flags;
1244 };
1245 
1246 /*
1247  * XXX this needs some work
1248  */
1249 struct fairq_opts {
1250 	u_int		nbuckets;	/* hash buckets */
1251 	u_int		hogs_m1;	/* hog detection bandwidth */
1252 	int		flags;
1253 
1254 	/* link-sharing service curve */
1255 	u_int		lssc_m1;
1256 	u_int		lssc_d;
1257 	u_int		lssc_m2;
1258 };
1259 
1260 struct pf_altq {
1261 	char			 ifname[IFNAMSIZ];
1262 
1263 	void			*altq_disc;	/* discipline-specific state */
1264 	TAILQ_ENTRY(pf_altq)	 entries;
1265 
1266 	/* scheduler spec */
1267 	u_int8_t		 scheduler;	/* scheduler type */
1268 	u_int16_t		 tbrsize;	/* tokenbucket regulator size */
1269 	u_int32_t		 ifbandwidth;	/* interface bandwidth */
1270 
1271 	/* queue spec */
1272 	char			 qname[PF_QNAME_SIZE];	/* queue name */
1273 	char			 parent[PF_QNAME_SIZE];	/* parent name */
1274 	u_int32_t		 parent_qid;	/* parent queue id */
1275 	u_int32_t		 bandwidth;	/* queue bandwidth */
1276 	u_int8_t		 priority;	/* priority */
1277 	u_int16_t		 qlimit;	/* queue size limit */
1278 	u_int16_t		 flags;		/* misc flags */
1279 	union {
1280 		struct cbq_opts		 cbq_opts;
1281 		struct priq_opts	 priq_opts;
1282 		struct hfsc_opts	 hfsc_opts;
1283 		struct fairq_opts	 fairq_opts;
1284 	} pq_u;
1285 
1286 	u_int32_t		 qid;		/* return value */
1287 };
1288 
1289 #define	PF_TAG_GENERATED		0x01
1290 #define	PF_TAG_FRAGCACHE		0x02
1291 #define	PF_TAG_TRANSLATE_LOCALHOST	0x04
1292 #define	PF_TAG_STATE_HASHED		0x08
1293 
1294 struct pf_mtag {
1295 	void		*hdr;		/* saved hdr pos in mbuf, for ECN */
1296 	u_int		 rtableid;	/* alternate routing table id */
1297 	u_int32_t	 qid;		/* queue id */
1298 	u_int16_t	 tag;		/* tag id */
1299 	u_int8_t	 flags;
1300 	u_int8_t	 routed;
1301 	sa_family_t	 af;		/* for ECN */
1302 	u_int32_t	 state_hash;	/* for fairq */
1303 };
1304 
1305 struct pf_tag {
1306 	u_int16_t	tag;		/* tag id */
1307 };
1308 
1309 struct pf_tagname {
1310 	TAILQ_ENTRY(pf_tagname)	entries;
1311 	char			name[PF_TAG_NAME_SIZE];
1312 	u_int16_t		tag;
1313 	int			ref;
1314 };
1315 
1316 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1317 #define PFFRAG_FRAG_HIWAT	1000	/* Number of fragmented packets */
1318 #define PFFRAG_FRCENT_HIWAT	50000	/* Number of fragment cache entries */
1319 #define PFFRAG_FRCACHE_HIWAT	10000	/* Number of fragment descriptors */
1320 
1321 #define PFR_KTABLE_HIWAT	1000	/* Number of tables */
1322 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1323 #define PFR_KENTRY_HIWAT_SMALL	100000	/* Number of table entries (tiny hosts) */
1324 
1325 /*
1326  * ioctl parameter structures
1327  */
1328 
1329 struct pfioc_pooladdr {
1330 	u_int32_t		 action;
1331 	u_int32_t		 ticket;
1332 	u_int32_t		 nr;
1333 	u_int32_t		 r_num;
1334 	u_int8_t		 r_action;
1335 	u_int8_t		 r_last;
1336 	u_int8_t		 af;
1337 	char			 anchor[MAXPATHLEN];
1338 	struct pf_pooladdr	 addr;
1339 };
1340 
1341 struct pfioc_rule {
1342 	u_int32_t	 action;
1343 	u_int32_t	 ticket;
1344 	u_int32_t	 pool_ticket;
1345 	u_int32_t	 nr;
1346 	char		 anchor[MAXPATHLEN];
1347 	char		 anchor_call[MAXPATHLEN];
1348 	struct pf_rule	 rule;
1349 };
1350 
1351 struct pfioc_natlook {
1352 	struct pf_addr	 saddr;
1353 	struct pf_addr	 daddr;
1354 	struct pf_addr	 rsaddr;
1355 	struct pf_addr	 rdaddr;
1356 	u_int16_t	 sport;
1357 	u_int16_t	 dport;
1358 	u_int16_t	 rsport;
1359 	u_int16_t	 rdport;
1360 	sa_family_t	 af;
1361 	u_int8_t	 proto;
1362 	u_int8_t	 direction;
1363 };
1364 
1365 struct pfioc_state {
1366 	u_int32_t	 nr;
1367 	struct pf_state	 state;
1368 };
1369 
1370 struct pfioc_src_node_kill {
1371 	/* XXX returns the number of src nodes killed in psnk_af */
1372 	sa_family_t psnk_af;
1373 	struct pf_rule_addr psnk_src;
1374 	struct pf_rule_addr psnk_dst;
1375 };
1376 
1377 struct pfioc_state_kill {
1378 	/* XXX returns the number of states killed in psk_af */
1379 	sa_family_t		psk_af;
1380 	int			psk_proto;
1381 	struct pf_rule_addr	psk_src;
1382 	struct pf_rule_addr	psk_dst;
1383 	char			psk_ifname[IFNAMSIZ];
1384 };
1385 
1386 struct pfioc_states {
1387 	int	ps_len;
1388 	union {
1389 		caddr_t		 psu_buf;
1390 		struct pf_state	*psu_states;
1391 	} ps_u;
1392 #define ps_buf		ps_u.psu_buf
1393 #define ps_states	ps_u.psu_states
1394 };
1395 
1396 struct pfioc_src_nodes {
1397 	int	psn_len;
1398 	union {
1399 		caddr_t		 psu_buf;
1400 		struct pf_src_node	*psu_src_nodes;
1401 	} psn_u;
1402 #define psn_buf		psn_u.psu_buf
1403 #define psn_src_nodes	psn_u.psu_src_nodes
1404 };
1405 
1406 struct pfioc_if {
1407 	char		 ifname[IFNAMSIZ];
1408 };
1409 
1410 struct pfioc_tm {
1411 	int		 timeout;
1412 	int		 seconds;
1413 };
1414 
1415 struct pfioc_limit {
1416 	int		 index;
1417 	unsigned	 limit;
1418 };
1419 
1420 struct pfioc_altq {
1421 	u_int32_t	 action;
1422 	u_int32_t	 ticket;
1423 	u_int32_t	 nr;
1424 	struct pf_altq	 altq;
1425 };
1426 
1427 struct pfioc_qstats {
1428 	u_int32_t	 ticket;
1429 	u_int32_t	 nr;
1430 	void		*buf;
1431 	int		 nbytes;
1432 	u_int8_t	 scheduler;
1433 };
1434 
1435 struct pfioc_anchor {
1436 	u_int32_t	 nr;
1437 	char		 name[PF_ANCHOR_NAME_SIZE];
1438 };
1439 
1440 struct pfioc_ruleset {
1441 	u_int32_t	 nr;
1442 	char		 path[MAXPATHLEN];
1443 	char		 name[PF_ANCHOR_NAME_SIZE];
1444 };
1445 
1446 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1447 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1448 struct pfioc_trans {
1449 	int		 size;	/* number of elements */
1450 	int		 esize; /* size of each element in bytes */
1451 	struct pfioc_trans_e {
1452 		int		rs_num;
1453 		char		anchor[MAXPATHLEN];
1454 		u_int32_t	ticket;
1455 	}		*array;
1456 };
1457 
1458 #define PFR_FLAG_ATOMIC		0x00000001
1459 #define PFR_FLAG_DUMMY		0x00000002
1460 #define PFR_FLAG_FEEDBACK	0x00000004
1461 #define PFR_FLAG_CLSTATS	0x00000008
1462 #define PFR_FLAG_ADDRSTOO	0x00000010
1463 #define PFR_FLAG_REPLACE	0x00000020
1464 #define PFR_FLAG_ALLRSETS	0x00000040
1465 #define PFR_FLAG_ALLMASK	0x0000007F
1466 #ifdef _KERNEL
1467 #define PFR_FLAG_USERIOCTL	0x10000000
1468 #endif
1469 
1470 struct pfioc_table {
1471 	struct pfr_table	 pfrio_table;
1472 	void			*pfrio_buffer;
1473 	int			 pfrio_esize;
1474 	int			 pfrio_size;
1475 	int			 pfrio_size2;
1476 	int			 pfrio_nadd;
1477 	int			 pfrio_ndel;
1478 	int			 pfrio_nchange;
1479 	int			 pfrio_flags;
1480 	u_int32_t		 pfrio_ticket;
1481 };
1482 #define	pfrio_exists	pfrio_nadd
1483 #define	pfrio_nzero	pfrio_nadd
1484 #define	pfrio_nmatch	pfrio_nadd
1485 #define pfrio_naddr	pfrio_size2
1486 #define pfrio_setflag	pfrio_size2
1487 #define pfrio_clrflag	pfrio_nadd
1488 
1489 struct pfioc_iface {
1490 	char	 pfiio_name[IFNAMSIZ];
1491 	void	*pfiio_buffer;
1492 	int	 pfiio_esize;
1493 	int	 pfiio_size;
1494 	int	 pfiio_nzero;
1495 	int	 pfiio_flags;
1496 };
1497 
1498 
1499 /*
1500  * ioctl operations
1501  */
1502 
1503 #define DIOCSTART	_IO  ('D',  1)
1504 #define DIOCSTOP	_IO  ('D',  2)
1505 #define DIOCBEGINRULES	_IOWR('D',  3, struct pfioc_rule)
1506 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1507 #define DIOCCOMMITRULES	_IOWR('D',  5, struct pfioc_rule)
1508 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1509 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1510 /* XXX cut 8 - 17 */
1511 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1512 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1513 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1514 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1515 #define DIOCCLRSTATUS	_IO  ('D', 22)
1516 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1517 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1518 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1519 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1520 /* XXX cut 26 - 28 */
1521 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1522 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1523 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1524 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1525 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1526 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1527 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1528 #define DIOCSTARTALTQ	_IO  ('D', 42)
1529 #define DIOCSTOPALTQ	_IO  ('D', 43)
1530 #define DIOCBEGINALTQS	_IOWR('D', 44, u_int32_t)
1531 #define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1532 #define DIOCCOMMITALTQS	_IOWR('D', 46, u_int32_t)
1533 #define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1534 #define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1535 #define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1536 #define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1537 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1538 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1539 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1540 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1541 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1542 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1543 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1544 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1545 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1546 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1547 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1548 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1549 #define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1550 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1551 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1552 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1553 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1554 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1555 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1556 #define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1557 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1558 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1559 #define DIOCRINABEGIN	_IOWR('D', 75, struct pfioc_table)
1560 #define DIOCRINACOMMIT	_IOWR('D', 76, struct pfioc_table)
1561 #define DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1562 #define DIOCOSFPFLUSH	_IO('D', 78)
1563 #define DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1564 #define DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1565 #define DIOCXBEGIN      _IOWR('D', 81, struct pfioc_trans)
1566 #define DIOCXCOMMIT     _IOWR('D', 82, struct pfioc_trans)
1567 #define DIOCXROLLBACK   _IOWR('D', 83, struct pfioc_trans)
1568 #define DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1569 #define DIOCCLRSRCNODES	_IO('D', 85)
1570 #define DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1571 #define DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1572 #define DIOCICLRISTATS  _IOWR('D', 88, struct pfioc_iface)
1573 #define DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1574 #define DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1575 #define DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1576 struct pf_ifspeed {
1577 	char			ifname[IFNAMSIZ];
1578 	u_int32_t		baudrate;
1579 };
1580 #define DIOCGIFSPEED	_IOWR('D', 89, struct pf_ifspeed)
1581 
1582 #ifdef _KERNEL
1583 RB_HEAD(pf_src_tree, pf_src_node);
1584 RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1585 extern struct pf_src_tree tree_src_tracking;
1586 
1587 RB_HEAD(pf_state_tree_id, pf_state);
1588 RB_PROTOTYPE(pf_state_tree_id, pf_state,
1589     entry_id, pf_state_compare_id);
1590 extern struct pf_state_tree_id tree_id;
1591 extern struct pf_state_queue state_list;
1592 
1593 TAILQ_HEAD(pf_poolqueue, pf_pool);
1594 extern struct pf_poolqueue		  pf_pools[2];
1595 TAILQ_HEAD(pf_altqqueue, pf_altq);
1596 extern struct pf_altqqueue		  pf_altqs[2];
1597 extern struct pf_palist			  pf_pabuf;
1598 
1599 extern u_int32_t		 ticket_altqs_active;
1600 extern u_int32_t		 ticket_altqs_inactive;
1601 extern int			 altqs_inactive_open;
1602 extern u_int32_t		 ticket_pabuf;
1603 extern struct pf_altqqueue	*pf_altqs_active;
1604 extern struct pf_altqqueue	*pf_altqs_inactive;
1605 extern struct pf_poolqueue	*pf_pools_active;
1606 extern struct pf_poolqueue	*pf_pools_inactive;
1607 extern int			 pf_tbladdr_setup(struct pf_ruleset *,
1608 				    struct pf_addr_wrap *);
1609 extern void			 pf_tbladdr_remove(struct pf_addr_wrap *);
1610 extern void			 pf_tbladdr_copyout(struct pf_addr_wrap *);
1611 extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1612 extern vm_zone_t		 pf_src_tree_pl, pf_rule_pl;
1613 extern vm_zone_t		 pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1614 extern vm_zone_t		 pfr_ktable_pl, pfr_kentry_pl;
1615 extern vm_zone_t		 pf_cache_pl, pf_cent_pl;
1616 extern vm_zone_t		 pf_state_scrub_pl;
1617 extern vm_zone_t		 pfi_addr_pl;
1618 extern void			 pf_purge_thread(void *);
1619 extern int			 pf_purge_expired_src_nodes(int);
1620 extern int			 pf_purge_expired_states(u_int32_t, int);
1621 extern void			 pf_unlink_state(struct pf_state *);
1622 extern void			 pf_free_state(struct pf_state *);
1623 extern int			 pf_insert_state(struct pfi_kif *,
1624 				    struct pf_state *);
1625 extern int			 pf_insert_src_node(struct pf_src_node **,
1626 				    struct pf_rule *, struct pf_addr *,
1627 				    sa_family_t);
1628 void				 pf_src_tree_remove_state(struct pf_state *);
1629 u_int32_t			 pf_state_hash(struct pf_state *s);
1630 extern struct pf_state		*pf_find_state_byid(struct pf_state_cmp *);
1631 extern struct pf_state		*pf_find_state_all(struct pf_state_cmp *key,
1632 				    u_int8_t tree, int *more);
1633 extern void			 pf_print_state(struct pf_state *);
1634 extern void			 pf_print_flags(u_int8_t);
1635 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1636 				    u_int8_t);
1637 
1638 extern struct ifnet		*sync_ifp;
1639 extern struct pf_rule		 pf_default_rule;
1640 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1641 				    u_int8_t);
1642 void				 pf_rm_rule(struct pf_rulequeue *,
1643 				    struct pf_rule *);
1644 
1645 #ifdef INET
1646 int	pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *, struct inpcb *);
1647 #endif /* INET */
1648 
1649 #ifdef INET6
1650 int	pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *, struct inpcb *);
1651 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1652 	    struct pf_addr *, struct pf_addr *, u_int8_t);
1653 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1654 #endif /* INET6 */
1655 
1656 u_int32_t	pf_new_isn(struct pf_state *); /* From FreeBSD */
1657 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1658 	    sa_family_t);
1659 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1660 int	pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1661 	    u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *,
1662 	    struct pf_pdesc *);
1663 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1664 	    struct pf_addr *, sa_family_t);
1665 int	pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1666 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1667 int	pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1668 int	pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1669 
1670 void	pf_normalize_init(void);
1671 int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1672 	    struct pf_pdesc *);
1673 int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1674 	    struct pf_pdesc *);
1675 int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1676 	    struct pf_pdesc *);
1677 void	pf_normalize_tcp_cleanup(struct pf_state *);
1678 int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1679 	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1680 int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1681 	    u_short *, struct tcphdr *, struct pf_state *,
1682 	    struct pf_state_peer *, struct pf_state_peer *, int *);
1683 u_int32_t
1684 	pf_state_expires(const struct pf_state *);
1685 void	pf_purge_expired_fragments(void);
1686 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *);
1687 int	pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *);
1688 int	pf_socket_lookup(int, struct pf_pdesc *, struct inpcb *);
1689 void	pfr_initialize(void);
1690 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1691 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1692 	    u_int64_t, int, int, int);
1693 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1694 	    struct pf_addr **, struct pf_addr **, sa_family_t);
1695 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1696 struct pfr_ktable *
1697 	pfr_attach_table(struct pf_ruleset *, char *);
1698 void	pfr_detach_table(struct pfr_ktable *);
1699 int	pfr_clr_tables(struct pfr_table *, int *, int);
1700 int	pfr_add_tables(struct pfr_table *, int, int *, int);
1701 int	pfr_del_tables(struct pfr_table *, int, int *, int);
1702 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1703 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1704 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1705 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1706 int	pfr_clr_addrs(struct pfr_table *, int *, int);
1707 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1708 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1709 	    int);
1710 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1711 	    int);
1712 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1713 	    int *, int *, int *, int, u_int32_t);
1714 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1715 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1716 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1717 	    int);
1718 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1719 	    int);
1720 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1721 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1722 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1723 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1724 	    int *, u_int32_t, int);
1725 
1726 extern struct pfi_statehead	 pfi_statehead;
1727 extern struct pfi_kif		*pfi_all;
1728 
1729 void		 pfi_initialize(void);
1730 struct pfi_kif	*pfi_kif_get(const char *);
1731 void		 pfi_cleanup(void);
1732 void		 pfi_attach_clone(struct if_clone *);
1733 void		 pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1734 void		 pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1735 int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1736 void		 pfi_attach_ifnet(struct ifnet *);
1737 void		 pfi_detach_ifnet(struct ifnet *);
1738 struct pfi_kif	*pfi_lookup_create(const char *);
1739 struct pfi_kif	*pfi_lookup_if(const char *);
1740 void		 pfi_attach_ifgroup(struct ifg_group *);
1741 void		 pfi_detach_ifgroup(struct ifg_group *);
1742 void		 pfi_group_change(const char *);
1743 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1744 		    sa_family_t);
1745 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1746 void		 pfi_dynaddr_remove(struct pf_addr_wrap *);
1747 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1748 void		 pfi_fill_oldstatus(struct pf_status *);
1749 int		 pfi_clr_istats(const char *);
1750 int		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1751 int		 pfi_set_flags(const char *, int);
1752 int		 pfi_clear_flags(const char *, int);
1753 
1754 u_int16_t	 pf_tagname2tag(char *);
1755 void		 pf_tag2tagname(u_int16_t, char *);
1756 void		 pf_tag_ref(u_int16_t);
1757 void		 pf_tag_unref(u_int16_t);
1758 int		 pf_tag_packet(struct mbuf *, struct pf_mtag *, int, int);
1759 u_int32_t	 pf_qname2qid(char *);
1760 void		 pf_qid2qname(u_int32_t, char *);
1761 void		 pf_qid_unref(u_int32_t);
1762 struct pf_mtag	*pf_find_mtag(struct mbuf *);
1763 struct pf_mtag	*pf_get_mtag(struct mbuf *);
1764 
1765 extern struct pf_status	pf_status;
1766 extern vm_zone_t	pf_frent_pl, pf_frag_pl;
1767 extern struct lock	pf_consistency_lock;
1768 
1769 struct pf_pool_limit {
1770 	void		*pp;
1771 	unsigned	 limit;
1772 };
1773 extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
1774 
1775 struct pf_frent {
1776 	LIST_ENTRY(pf_frent) fr_next;
1777 	struct ip *fr_ip;
1778 	struct mbuf *fr_m;
1779 };
1780 
1781 struct pf_frcache {
1782 	LIST_ENTRY(pf_frcache) fr_next;
1783 	uint16_t        fr_off;
1784 	uint16_t        fr_end;
1785 };
1786 
1787 struct pf_fragment {
1788 	RB_ENTRY(pf_fragment) fr_entry;
1789 	TAILQ_ENTRY(pf_fragment) frag_next;
1790 	struct in_addr  fr_src;
1791 	struct in_addr  fr_dst;
1792 	u_int8_t        fr_p;           /* protocol of this fragment */
1793 	u_int8_t        fr_flags;       /* status flags */
1794 	u_int16_t       fr_id;          /* fragment id for reassemble */
1795 	u_int16_t       fr_max;         /* fragment data max */
1796 	u_int32_t       fr_timeout;
1797 #define fr_queue        fr_u.fru_queue
1798 #define fr_cache        fr_u.fru_cache
1799 	union {
1800 		LIST_HEAD(pf_fragq, pf_frent) fru_queue;        /* buffering */
1801 		LIST_HEAD(pf_cacheq, pf_frcache) fru_cache;     /* non-buf */
1802 	} fr_u;
1803 };
1804 
1805 #endif /* _KERNEL */
1806 
1807 extern struct pf_anchor_global  pf_anchors;
1808 extern struct pf_anchor        pf_main_anchor;
1809 #define pf_main_ruleset	pf_main_anchor.ruleset
1810 
1811 /* these ruleset functions can be linked into userland programs (pfctl) */
1812 int			 pf_get_ruleset_number(u_int8_t);
1813 void			 pf_init_ruleset(struct pf_ruleset *);
1814 int			 pf_anchor_setup(struct pf_rule *,
1815 			    const struct pf_ruleset *, const char *);
1816 int			 pf_anchor_copyout(const struct pf_ruleset *,
1817 			    const struct pf_rule *, struct pfioc_rule *);
1818 void			 pf_anchor_remove(struct pf_rule *);
1819 void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1820 struct pf_anchor	*pf_find_anchor(const char *);
1821 struct pf_ruleset	*pf_find_ruleset(const char *);
1822 struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1823 void			 pf_rs_initialize(void);
1824 
1825 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1826 int	pf_osfp_add(struct pf_osfp_ioctl *);
1827 #ifdef _KERNEL
1828 struct pf_osfp_enlist *
1829 	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1830 	    const struct tcphdr *);
1831 #endif /* _KERNEL */
1832 struct pf_osfp_enlist *
1833 	pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1834 	    const struct tcphdr *);
1835 void	pf_osfp_flush(void);
1836 int	pf_osfp_get(struct pf_osfp_ioctl *);
1837 int	pf_osfp_initialize(void);
1838 void	pf_osfp_cleanup(void);
1839 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1840 struct pf_os_fingerprint *
1841 	pf_osfp_validate(void);
1842 
1843 
1844 #endif /* _NET_PFVAR_H_ */
1845