xref: /openbsd-src/sys/net/pfvar.h (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1 /*	$OpenBSD: pfvar.h,v 1.401 2014/07/02 13:02:08 mikeb Exp $ */
2 
3 /*
4  * Copyright (c) 2001 Daniel Hartmeier
5  * Copyright (c) 2002 - 2013 Henning Brauer <henning@openbsd.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  *    - Redistributions of source code must retain the above copyright
13  *      notice, this list of conditions and the following disclaimer.
14  *    - Redistributions in binary form must reproduce the above
15  *      copyright notice, this list of conditions and the following
16  *      disclaimer in the documentation and/or other materials provided
17  *      with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 
34 #ifndef _NET_PFVAR_H_
35 #define _NET_PFVAR_H_
36 
37 #include <sys/param.h>
38 #include <sys/types.h>
39 #include <sys/queue.h>
40 #include <sys/tree.h>
41 #include <sys/rwlock.h>
42 
43 #include <net/radix.h>
44 #include <net/route.h>
45 #include <netinet/ip_ipsp.h>
46 #include <netinet/tcp_fsm.h>
47 
48 struct ip;
49 struct ip6_hdr;
50 
51 #define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
52 #define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
53 
54 #define	PF_MD5_DIGEST_LENGTH	16
55 #ifdef MD5_DIGEST_LENGTH
56 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
57 #error
58 #endif
59 #endif
60 
61 enum	{ PF_INOUT, PF_IN, PF_OUT, PF_FWD };
62 enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
63 	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, PF_DEFER,
64 	  PF_MATCH, PF_DIVERT, PF_RT, PF_AFRT };
65 enum	{ PF_TRANS_RULESET, PF_TRANS_ALTQ, PF_TRANS_TABLE };
66 enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
67 	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
68 enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
69 	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
70 	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
71 enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
72 enum	{ PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
73 
74 /*
75  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
76  * PFTM_MAX, special cases afterwards. See pf_state_expires().
77  */
78 enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
79 	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
80 	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
81 	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
82 	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
83 	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
84 	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
85 	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED };
86 
87 /* PFTM default values */
88 #define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
89 #define PFTM_TCP_OPENING_VAL		30	/* No response yet */
90 #define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
91 #define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
92 #define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
93 #define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
94 #define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
95 #define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
96 #define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
97 #define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
98 #define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
99 #define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
100 #define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
101 #define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
102 #define PFTM_FRAG_VAL			60	/* Fragment expire */
103 #define PFTM_INTERVAL_VAL		10	/* Expire interval */
104 #define PFTM_SRC_NODE_VAL		0	/* Source tracking */
105 #define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
106 
107 enum	{ PF_NOPFROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
108 enum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
109 	  PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
110 #define PF_POOL_IDMASK		0x0f
111 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
112 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN, PF_POOL_LEASTSTATES };
113 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
114 	  PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED,
115 	  PF_ADDR_RANGE, PF_ADDR_NONE };
116 #define PF_POOL_TYPEMASK	0x0f
117 #define PF_POOL_STICKYADDR	0x20
118 #define	PF_WSCALE_FLAG		0x80
119 #define	PF_WSCALE_MASK		0x0f
120 
121 #define	PF_LOG			0x01
122 #define	PF_LOG_ALL		0x02
123 #define	PF_LOG_SOCKET_LOOKUP	0x04
124 #define	PF_LOG_FORCE		0x08
125 #define	PF_LOG_MATCHES		0x10
126 
127 struct pf_addr {
128 	union {
129 		struct in_addr		v4;
130 		struct in6_addr		v6;
131 		u_int8_t		addr8[16];
132 		u_int16_t		addr16[8];
133 		u_int32_t		addr32[4];
134 	} pfa;		    /* 128-bit address */
135 #define v4	pfa.v4
136 #define v6	pfa.v6
137 #define addr8	pfa.addr8
138 #define addr16	pfa.addr16
139 #define addr32	pfa.addr32
140 };
141 
142 #define	PF_TABLE_NAME_SIZE	 32
143 
144 #define PFI_AFLAG_NETWORK	0x01
145 #define PFI_AFLAG_BROADCAST	0x02
146 #define PFI_AFLAG_PEER		0x04
147 #define PFI_AFLAG_MODEMASK	0x07
148 #define PFI_AFLAG_NOALIAS	0x08
149 
150 struct pf_addr_wrap {
151 	union {
152 		struct {
153 			struct pf_addr		 addr;
154 			struct pf_addr		 mask;
155 		}			 a;
156 		char			 ifname[IFNAMSIZ];
157 		char			 tblname[PF_TABLE_NAME_SIZE];
158 		char			 rtlabelname[RTLABEL_LEN];
159 		u_int32_t		 rtlabel;
160 	}			 v;
161 	union {
162 		struct pfi_dynaddr	*dyn;
163 		struct pfr_ktable	*tbl;
164 		int			 dyncnt;
165 		int			 tblcnt;
166 	}			 p;
167 	u_int8_t		 type;		/* PF_ADDR_* */
168 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
169 };
170 
171 #ifdef _KERNEL
172 
173 struct pfi_dynaddr {
174 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
175 	struct pf_addr			 pfid_addr4;
176 	struct pf_addr			 pfid_mask4;
177 	struct pf_addr			 pfid_addr6;
178 	struct pf_addr			 pfid_mask6;
179 	struct pfr_ktable		*pfid_kt;
180 	struct pfi_kif			*pfid_kif;
181 	void				*pfid_hook_cookie;
182 	int				 pfid_net;	/* mask or 128 */
183 	int				 pfid_acnt4;	/* address count IPv4 */
184 	int				 pfid_acnt6;	/* address count IPv6 */
185 	sa_family_t			 pfid_af;	/* rule af */
186 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
187 };
188 #endif /* _KERNEL */
189 
190 
191 /*
192  * Logging macros
193  */
194 
195 #ifndef PF_DEBUGNAME
196 #define PF_DEBUGNAME "pf: "
197 #endif
198 
199 #ifdef _KERNEL
200 #define	DPFPRINTF(n, format, x...)					\
201 	do {								\
202 		if (pf_status.debug >= (n)) {				\
203 			log(n, PF_DEBUGNAME);				\
204 			addlog(format, ##x);				\
205 			addlog("\n");					\
206 		}							\
207 	} while (0)
208 #else
209 #ifdef PFDEBUG
210 #define	DPFPRINTF(n, format, x...)					\
211 	do {								\
212 		fprintf(stderr, format, ##x);				\
213 		fprintf(stderr, "\n");					\
214 	} while (0)
215 #else
216 #define	DPFPRINTF(n, format, x...)	((void)0)
217 #endif /* PFDEBUG */
218 #endif /* _KERNEL */
219 
220 
221 /*
222  * Address manipulation macros
223  */
224 
225 #ifdef _KERNEL
226 #ifdef INET
227 #ifndef INET6
228 #define PF_INET_ONLY
229 #endif /* ! INET6 */
230 #endif /* INET */
231 
232 #ifdef INET6
233 #ifndef INET
234 #define PF_INET6_ONLY
235 #endif /* ! INET */
236 #endif /* INET6 */
237 
238 #ifdef INET
239 #ifdef INET6
240 #define PF_INET_INET6
241 #endif /* INET6 */
242 #endif /* INET */
243 
244 #else
245 
246 #define PF_INET_INET6
247 
248 #endif /* _KERNEL */
249 
250 /* Both IPv4 and IPv6 */
251 #ifdef PF_INET_INET6
252 
253 #define PF_AEQ(a, b, c) \
254 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
255 	(c == AF_INET6 && \
256 	(a)->addr32[3] == (b)->addr32[3] && \
257 	(a)->addr32[2] == (b)->addr32[2] && \
258 	(a)->addr32[1] == (b)->addr32[1] && \
259 	(a)->addr32[0] == (b)->addr32[0])) \
260 
261 #define PF_ANEQ(a, b, c) \
262 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
263 	(c == AF_INET6 && \
264 	((a)->addr32[3] != (b)->addr32[3] || \
265 	(a)->addr32[2] != (b)->addr32[2] || \
266 	(a)->addr32[1] != (b)->addr32[1] || \
267 	(a)->addr32[0] != (b)->addr32[0]))) \
268 
269 #define PF_AZERO(a, c) \
270 	((c == AF_INET && !(a)->addr32[0]) || \
271 	(c == AF_INET6 && \
272 	!(a)->addr32[0] && !(a)->addr32[1] && \
273 	!(a)->addr32[2] && !(a)->addr32[3] )) \
274 
275 #define PF_MATCHA(n, a, m, b, f) \
276 	pf_match_addr(n, a, m, b, f)
277 
278 #define PF_ACPY(a, b, f) \
279 	pf_addrcpy(a, b, f)
280 
281 #define PF_AINC(a, f) \
282 	pf_addr_inc(a, f)
283 
284 #define PF_POOLMASK(a, b, c, d, f) \
285 	pf_poolmask(a, b, c, d, f)
286 
287 #else
288 
289 /* Just IPv6 */
290 
291 #ifdef PF_INET6_ONLY
292 
293 #define PF_AEQ(a, b, c) \
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 	((a)->addr32[3] != (b)->addr32[3] || \
301 	(a)->addr32[2] != (b)->addr32[2] || \
302 	(a)->addr32[1] != (b)->addr32[1] || \
303 	(a)->addr32[0] != (b)->addr32[0]) \
304 
305 #define PF_AZERO(a, c) \
306 	(!(a)->addr32[0] && \
307 	!(a)->addr32[1] && \
308 	!(a)->addr32[2] && \
309 	!(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 IPv4 */
326 #ifdef PF_INET_ONLY
327 
328 #define PF_AEQ(a, b, c) \
329 	((a)->addr32[0] == (b)->addr32[0])
330 
331 #define PF_ANEQ(a, b, c) \
332 	((a)->addr32[0] != (b)->addr32[0])
333 
334 #define PF_AZERO(a, c) \
335 	(!(a)->addr32[0])
336 
337 #define PF_MATCHA(n, a, m, b, f) \
338 	pf_match_addr(n, a, m, b, f)
339 
340 #define PF_ACPY(a, b, f) \
341 	(a)->v4.s_addr = (b)->v4.s_addr
342 
343 #define PF_AINC(a, f) \
344 	do { \
345 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
346 	} while (0)
347 
348 #define PF_POOLMASK(a, b, c, d, f) \
349 	do { \
350 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
351 		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
352 	} while (0)
353 
354 #endif /* PF_INET_ONLY */
355 #endif /* PF_INET6_ONLY */
356 #endif /* PF_INET_INET6 */
357 
358 #define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
359 	(								\
360 		(((aw)->type == PF_ADDR_NOROUTE &&			\
361 		    pf_routable((x), (af), NULL, (rtid))) ||		\
362 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
363 		    pf_routable((x), (af), (ifp), (rtid))) ||		\
364 		((aw)->type == PF_ADDR_RTLABEL &&			\
365 		    !pf_rtlabel_match((x), (af), (aw), (rtid))) ||	\
366 		((aw)->type == PF_ADDR_TABLE &&				\
367 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
368 		((aw)->type == PF_ADDR_DYNIFTL &&			\
369 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
370 		((aw)->type == PF_ADDR_RANGE &&				\
371 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
372 		    &(aw)->v.a.mask, (x), (af))) ||			\
373 		((aw)->type == PF_ADDR_ADDRMASK &&			\
374 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
375 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
376 		    &(aw)->v.a.mask, (x), (af))))) !=			\
377 		(neg)							\
378 	)
379 
380 struct pf_rule_uid {
381 	uid_t		 uid[2];
382 	u_int8_t	 op;
383 };
384 
385 struct pf_rule_gid {
386 	uid_t		 gid[2];
387 	u_int8_t	 op;
388 };
389 
390 struct pf_rule_addr {
391 	struct pf_addr_wrap	 addr;
392 	u_int16_t		 port[2];
393 	u_int8_t		 neg;
394 	u_int8_t		 port_op;
395 	u_int16_t		 weight;
396 };
397 
398 struct pf_poolhashkey {
399 	union {
400 		u_int8_t		key8[16];
401 		u_int16_t		key16[8];
402 		u_int32_t		key32[4];
403 	} pfk;		    /* 128-bit hash key */
404 #define key8	pfk.key8
405 #define key16	pfk.key16
406 #define key32	pfk.key32
407 };
408 
409 struct pf_pool {
410 	struct pf_addr_wrap	 addr;
411 	struct pf_poolhashkey	 key;
412 	struct pf_addr		 counter;
413 	char			 ifname[IFNAMSIZ];
414 	struct pfi_kif		*kif;
415 	int			 tblidx;
416 	u_int64_t		 states;
417 	int			 curweight;
418 	u_int16_t		 weight;
419 	u_int16_t		 proxy_port[2];
420 	u_int8_t		 port_op;
421 	u_int8_t		 opts;
422 };
423 
424 /* A packed Operating System description for fingerprinting */
425 typedef u_int32_t pf_osfp_t;
426 #define PF_OSFP_ANY	((pf_osfp_t)0)
427 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
428 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
429 
430 struct pf_osfp_entry {
431 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
432 	pf_osfp_t		fp_os;
433 	int			fp_enflags;
434 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
435 #define PF_OSFP_GENERIC		0x002		/* generic signature */
436 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
437 #define PF_OSFP_LEN	32
438 	u_char			fp_class_nm[PF_OSFP_LEN];
439 	u_char			fp_version_nm[PF_OSFP_LEN];
440 	u_char			fp_subtype_nm[PF_OSFP_LEN];
441 };
442 #define PF_OSFP_ENTRY_EQ(a, b) \
443     ((a)->fp_os == (b)->fp_os && \
444     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
445     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
446     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
447 
448 /* handle pf_osfp_t packing */
449 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
450 #define _FP_UNUSED_BITS		1
451 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
452 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
453 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
454 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
455 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
456 	    ((1 << _FP_CLASS_BITS) - 1); \
457 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
458 	    ((1 << _FP_VERSION_BITS) - 1);\
459 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
460 } while(0)
461 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
462 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
463 	    + _FP_SUBTYPE_BITS); \
464 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
465 	    _FP_SUBTYPE_BITS; \
466 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
467 } while(0)
468 
469 /* the fingerprint of an OSes TCP SYN packet */
470 typedef u_int64_t	pf_tcpopts_t;
471 struct pf_os_fingerprint {
472 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
473 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
474 	u_int16_t		fp_wsize;	/* TCP window size */
475 	u_int16_t		fp_psize;	/* ip->ip_len */
476 	u_int16_t		fp_mss;		/* TCP MSS */
477 	u_int16_t		fp_flags;
478 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
479 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
480 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
481 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
482 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
483 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
484 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
485 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
486 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
487 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
488 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
489 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
490 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
491 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
492 #define PF_OSFP_INET6		0x4000		/* IPv6 */
493 	u_int8_t		fp_optcnt;	/* TCP option count */
494 	u_int8_t		fp_wscale;	/* TCP window scaling */
495 	u_int8_t		fp_ttl;		/* IPv4 TTL */
496 #define PF_OSFP_MAXTTL_OFFSET	40
497 /* TCP options packing */
498 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
499 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
500 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
501 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
502 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
503 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
504 #define PF_OSFP_MAX_OPTS \
505     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
506     / PF_OSFP_TCPOPT_BITS
507 
508 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
509 };
510 
511 struct pf_osfp_ioctl {
512 	struct pf_osfp_entry	fp_os;
513 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
514 	u_int16_t		fp_wsize;	/* TCP window size */
515 	u_int16_t		fp_psize;	/* ip->ip_len */
516 	u_int16_t		fp_mss;		/* TCP MSS */
517 	u_int16_t		fp_flags;
518 	u_int8_t		fp_optcnt;	/* TCP option count */
519 	u_int8_t		fp_wscale;	/* TCP window scaling */
520 	u_int8_t		fp_ttl;		/* IPv4 TTL */
521 
522 	int			fp_getnum;	/* DIOCOSFPGET number */
523 };
524 
525 struct pf_rule_actions {
526 	int		rtableid;
527 	u_int16_t	qid;
528 	u_int16_t	pqid;
529 	u_int16_t	max_mss;
530 	u_int16_t	flags;
531 	u_int8_t	log;
532 	u_int8_t	set_tos;
533 	u_int8_t	min_ttl;
534 	u_int8_t	set_prio[2];
535 	u_int8_t	pad[3];
536 };
537 
538 union pf_rule_ptr {
539 	struct pf_rule		*ptr;
540 	u_int32_t		 nr;
541 };
542 
543 #define	PF_ANCHOR_NAME_SIZE	 64
544 
545 struct pf_rule {
546 	struct pf_rule_addr	 src;
547 	struct pf_rule_addr	 dst;
548 #define PF_SKIP_IFP		0
549 #define PF_SKIP_DIR		1
550 #define PF_SKIP_RDOM		2
551 #define PF_SKIP_AF		3
552 #define PF_SKIP_PROTO		4
553 #define PF_SKIP_SRC_ADDR	5
554 #define PF_SKIP_DST_ADDR	6
555 #define PF_SKIP_SRC_PORT	7
556 #define PF_SKIP_DST_PORT	8
557 #define PF_SKIP_COUNT		9
558 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
559 #define PF_RULE_LABEL_SIZE	 64
560 	char			 label[PF_RULE_LABEL_SIZE];
561 #define PF_QNAME_SIZE		 64
562 	char			 ifname[IFNAMSIZ];
563 	char			 rcv_ifname[IFNAMSIZ];
564 	char			 qname[PF_QNAME_SIZE];
565 	char			 pqname[PF_QNAME_SIZE];
566 #define	PF_TAG_NAME_SIZE	 64
567 	char			 tagname[PF_TAG_NAME_SIZE];
568 	char			 match_tagname[PF_TAG_NAME_SIZE];
569 
570 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
571 
572 	TAILQ_ENTRY(pf_rule)	 entries;
573 	struct pf_pool		 nat;
574 	struct pf_pool		 rdr;
575 	struct pf_pool		 route;
576 
577 	u_int64_t		 evaluations;
578 	u_int64_t		 packets[2];
579 	u_int64_t		 bytes[2];
580 
581 	struct pfi_kif		*kif;
582 	struct pfi_kif		*rcv_kif;
583 	struct pf_anchor	*anchor;
584 	struct pfr_ktable	*overload_tbl;
585 
586 	pf_osfp_t		 os_fingerprint;
587 
588 	int			 rtableid;
589 	int			 onrdomain;
590 	u_int32_t		 timeout[PFTM_MAX];
591 	u_int32_t		 states_cur;
592 	u_int32_t		 states_tot;
593 	u_int32_t		 max_states;
594 	u_int32_t		 src_nodes;
595 	u_int32_t		 max_src_nodes;
596 	u_int32_t		 max_src_states;
597 	u_int32_t		 max_src_conn;
598 	struct {
599 		u_int32_t		limit;
600 		u_int32_t		seconds;
601 	}			 max_src_conn_rate;
602 	u_int32_t		 qid;
603 	u_int32_t		 pqid;
604 	u_int32_t		 rt_listid;
605 	u_int32_t		 nr;
606 	u_int32_t		 prob;
607 	uid_t			 cuid;
608 	pid_t			 cpid;
609 
610 	u_int16_t		 return_icmp;
611 	u_int16_t		 return_icmp6;
612 	u_int16_t		 max_mss;
613 	u_int16_t		 tag;
614 	u_int16_t		 match_tag;
615 	u_int16_t		 scrub_flags;
616 
617 	struct pf_rule_uid	 uid;
618 	struct pf_rule_gid	 gid;
619 
620 	u_int32_t		 rule_flag;
621 	u_int8_t		 action;
622 	u_int8_t		 direction;
623 	u_int8_t		 log;
624 	u_int8_t		 logif;
625 	u_int8_t		 quick;
626 	u_int8_t		 ifnot;
627 	u_int8_t		 match_tag_not;
628 
629 #define PF_STATE_NORMAL		0x1
630 #define PF_STATE_MODULATE	0x2
631 #define PF_STATE_SYNPROXY	0x3
632 	u_int8_t		 keep_state;
633 	sa_family_t		 af;
634 	u_int8_t		 proto;
635 	u_int8_t		 type;
636 	u_int8_t		 code;
637 	u_int8_t		 flags;
638 	u_int8_t		 flagset;
639 	u_int8_t		 min_ttl;
640 	u_int8_t		 allow_opts;
641 	u_int8_t		 rt;
642 	u_int8_t		 return_ttl;
643 	u_int8_t		 tos;
644 	u_int8_t		 set_tos;
645 	u_int8_t		 anchor_relative;
646 	u_int8_t		 anchor_wildcard;
647 
648 #define PF_FLUSH		0x01
649 #define PF_FLUSH_GLOBAL		0x02
650 	u_int8_t		 flush;
651 	u_int8_t		 set_prio[2];
652 	sa_family_t		 naf;
653 	u_int8_t		 rcvifnot;
654 	u_int8_t		 pad[3];
655 
656 	struct {
657 		struct pf_addr		addr;
658 		u_int16_t		port;
659 	}			divert, divert_packet;
660 };
661 
662 /* rule flags */
663 #define	PFRULE_DROP		0x0000
664 #define	PFRULE_RETURNRST	0x0001
665 #define	PFRULE_FRAGMENT		0x0002
666 #define	PFRULE_RETURNICMP	0x0004
667 #define	PFRULE_RETURN		0x0008
668 #define	PFRULE_NOSYNC		0x0010
669 #define PFRULE_SRCTRACK		0x0020  /* track source states */
670 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
671 
672 /* rule flags again */
673 #define PFRULE_IFBOUND		0x00010000	/* if-bound */
674 #define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
675 #define PFRULE_PFLOW		0x00040000
676 #define PFRULE_ONCE		0x00100000	/* one shot rule */
677 #define PFRULE_AFTO		0x00200000	/* af-to rule */
678 
679 #define PFSTATE_HIWAT		10000	/* default state table size */
680 #define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
681 #define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
682 
683 
684 struct pf_threshold {
685 	u_int32_t	limit;
686 #define	PF_THRESHOLD_MULT	1000
687 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
688 	u_int32_t	seconds;
689 	u_int32_t	count;
690 	u_int32_t	last;
691 };
692 
693 struct pf_rule_item {
694 	SLIST_ENTRY(pf_rule_item)	 entry;
695 	struct pf_rule			*r;
696 };
697 
698 SLIST_HEAD(pf_rule_slist, pf_rule_item);
699 
700 enum pf_sn_types { PF_SN_NONE, PF_SN_NAT, PF_SN_RDR, PF_SN_ROUTE, PF_SN_MAX };
701 
702 struct pf_src_node {
703 	RB_ENTRY(pf_src_node)	 entry;
704 	struct pf_addr		 addr;
705 	struct pf_addr		 raddr;
706 	union pf_rule_ptr	 rule;
707 	struct pfi_kif		*kif;
708 	u_int64_t		 bytes[2];
709 	u_int64_t		 packets[2];
710 	u_int32_t		 states;
711 	u_int32_t		 conn;
712 	struct pf_threshold	 conn_rate;
713 	int32_t			 creation;
714 	int32_t			 expire;
715 	sa_family_t		 af;
716 	sa_family_t		 naf;
717 	u_int8_t		 type;
718 };
719 
720 struct pf_sn_item {
721 	SLIST_ENTRY(pf_sn_item)	 next;
722 	struct pf_src_node	*sn;
723 };
724 
725 SLIST_HEAD(pf_sn_head, pf_sn_item);
726 
727 #define PFSNODE_HIWAT		10000	/* default source node table size */
728 
729 struct pf_state_scrub {
730 	struct timeval	pfss_last;	/* time received last packet	*/
731 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
732 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
733 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
734 	u_int16_t	pfss_flags;
735 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
736 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
737 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
738 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
739 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
740 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
741 	u_int8_t	pad;
742 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
743 };
744 
745 struct pf_state_host {
746 	struct pf_addr	addr;
747 	u_int16_t	port;
748 	u_int16_t	pad;
749 };
750 
751 struct pf_state_peer {
752 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
753 	u_int32_t	seqlo;		/* Max sequence number sent	*/
754 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
755 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
756 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
757 	u_int16_t	mss;		/* Maximum segment size option	*/
758 	u_int8_t	state;		/* active state level		*/
759 	u_int8_t	wscale;		/* window scaling factor	*/
760 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
761 	u_int8_t	pad[1];
762 };
763 
764 TAILQ_HEAD(pf_state_queue, pf_state);
765 
766 /* keep synced with struct pf_state_key, used in RB_FIND */
767 struct pf_state_key_cmp {
768 	struct pf_addr	 addr[2];
769 	u_int16_t	 port[2];
770 	u_int16_t	 rdomain;
771 	sa_family_t	 af;
772 	u_int8_t	 proto;
773 };
774 
775 struct pf_state_item {
776 	TAILQ_ENTRY(pf_state_item)	 entry;
777 	struct pf_state			*s;
778 };
779 
780 TAILQ_HEAD(pf_statelisthead, pf_state_item);
781 
782 struct pf_state_key {
783 	struct pf_addr	 addr[2];
784 	u_int16_t	 port[2];
785 	u_int16_t	 rdomain;
786 	sa_family_t	 af;
787 	u_int8_t	 proto;
788 
789 	RB_ENTRY(pf_state_key)	 entry;
790 	struct pf_statelisthead	 states;
791 	struct pf_state_key	*reverse;
792 	struct inpcb		*inp;
793 };
794 #define PF_REVERSED_KEY(key, family)				\
795 	((key[PF_SK_WIRE]->af != key[PF_SK_STACK]->af) &&	\
796 	 (key[PF_SK_WIRE]->af != (family)))
797 
798 /* keep synced with struct pf_state, used in RB_FIND */
799 struct pf_state_cmp {
800 	u_int64_t		 id;
801 	u_int32_t		 creatorid;
802 	u_int8_t		 direction;
803 	u_int8_t		 pad[3];
804 };
805 
806 struct pf_state {
807 	u_int64_t		 id;
808 	u_int32_t		 creatorid;
809 	u_int8_t		 direction;
810 	u_int8_t		 pad[3];
811 
812 	TAILQ_ENTRY(pf_state)	 sync_list;
813 	TAILQ_ENTRY(pf_state)	 entry_list;
814 	RB_ENTRY(pf_state)	 entry_id;
815 	struct pf_state_peer	 src;
816 	struct pf_state_peer	 dst;
817 	struct pf_rule_slist	 match_rules;
818 	union pf_rule_ptr	 rule;
819 	union pf_rule_ptr	 anchor;
820 	union pf_rule_ptr	 natrule;
821 	struct pf_addr		 rt_addr;
822 	struct pf_sn_head	 src_nodes;
823 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
824 	struct pfi_kif		*kif;
825 	struct pfi_kif		*rt_kif;
826 	u_int64_t		 packets[2];
827 	u_int64_t		 bytes[2];
828 	int32_t			 creation;
829 	int32_t			 expire;
830 	int32_t			 pfsync_time;
831 	u_int16_t		 qid;
832 	u_int16_t		 pqid;
833 	u_int16_t		 tag;
834 	u_int16_t		 state_flags;
835 #define	PFSTATE_ALLOWOPTS	0x0001
836 #define	PFSTATE_SLOPPY		0x0002
837 #define	PFSTATE_PFLOW		0x0004
838 #define	PFSTATE_NOSYNC		0x0008
839 #define	PFSTATE_ACK		0x0010
840 #define	PFSTATE_NODF		0x0020
841 #define	PFSTATE_SETTOS		0x0040
842 #define	PFSTATE_RANDOMID	0x0080
843 #define	PFSTATE_SCRUB_TCP	0x0100
844 #define	PFSTATE_SETPRIO		0x0200
845 #define	PFSTATE_SCRUBMASK (PFSTATE_NODF|PFSTATE_RANDOMID|PFSTATE_SCRUB_TCP)
846 #define	PFSTATE_SETMASK   (PFSTATE_SETTOS|PFSTATE_SETPRIO)
847 	u_int8_t		 log;
848 	u_int8_t		 timeout;
849 	u_int8_t		 sync_state; /* PFSYNC_S_x */
850 	u_int8_t		 sync_updates;
851 	int			 rtableid[2];	/* rtables stack and wire */
852 	u_int8_t		 min_ttl;
853 	u_int8_t		 set_tos;
854 	u_int8_t		 set_prio[2];
855 	u_int16_t		 max_mss;
856 	u_int16_t		 if_index_in;
857 	u_int16_t		 if_index_out;
858 	u_int8_t		 pad2[2];
859 };
860 
861 /*
862  * Unified state structures for pulling states out of the kernel
863  * used by pfsync(4) and the pf(4) ioctl.
864  */
865 struct pfsync_state_scrub {
866 	u_int16_t	pfss_flags;
867 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
868 #define PFSYNC_SCRUB_FLAG_VALID		0x01
869 	u_int8_t	scrub_flag;
870 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
871 } __packed;
872 
873 struct pfsync_state_peer {
874 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
875 	u_int32_t	seqlo;		/* Max sequence number sent	*/
876 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
877 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
878 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
879 	u_int16_t	mss;		/* Maximum segment size option	*/
880 	u_int8_t	state;		/* active state level		*/
881 	u_int8_t	wscale;		/* window scaling factor	*/
882 	u_int8_t	pad[6];
883 } __packed;
884 
885 struct pfsync_state_key {
886 	struct pf_addr	 addr[2];
887 	u_int16_t	 port[2];
888 	u_int16_t	 rdomain;
889 	sa_family_t	 af;
890 	u_int8_t	 pad;
891 };
892 
893 struct pfsync_state {
894 	u_int64_t	 id;
895 	char		 ifname[IFNAMSIZ];
896 	struct pfsync_state_key	key[2];
897 	struct pfsync_state_peer src;
898 	struct pfsync_state_peer dst;
899 	struct pf_addr	 rt_addr;
900 	u_int32_t	 rule;
901 	u_int32_t	 anchor;
902 	u_int32_t	 nat_rule;
903 	u_int32_t	 creation;
904 	u_int32_t	 expire;
905 	u_int32_t	 packets[2][2];
906 	u_int32_t	 bytes[2][2];
907 	u_int32_t	 creatorid;
908 	int32_t		 rtableid[2];
909 	u_int16_t	 max_mss;
910 	sa_family_t	 af;
911 	u_int8_t	 proto;
912 	u_int8_t	 direction;
913 	u_int8_t	 log;
914 	u_int8_t	 pad0;
915 	u_int8_t	 timeout;
916 	u_int8_t	 sync_flags;
917 	u_int8_t	 updates;
918 	u_int8_t	 min_ttl;
919 	u_int8_t	 set_tos;
920 	u_int16_t	 state_flags;
921 	u_int8_t	 pad[2];
922 } __packed;
923 
924 #define PFSYNC_FLAG_SRCNODE	0x04
925 #define PFSYNC_FLAG_NATSRCNODE	0x08
926 
927 /* for copies to/from network byte order */
928 /* ioctl interface also uses network byte order */
929 #define pf_state_peer_hton(s,d) do {		\
930 	(d)->seqlo = htonl((s)->seqlo);		\
931 	(d)->seqhi = htonl((s)->seqhi);		\
932 	(d)->seqdiff = htonl((s)->seqdiff);	\
933 	(d)->max_win = htons((s)->max_win);	\
934 	(d)->mss = htons((s)->mss);		\
935 	(d)->state = (s)->state;		\
936 	(d)->wscale = (s)->wscale;		\
937 	if ((s)->scrub) {						\
938 		(d)->scrub.pfss_flags =					\
939 		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
940 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
941 		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
942 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
943 	}								\
944 } while (0)
945 
946 #define pf_state_peer_ntoh(s,d) do {		\
947 	(d)->seqlo = ntohl((s)->seqlo);		\
948 	(d)->seqhi = ntohl((s)->seqhi);		\
949 	(d)->seqdiff = ntohl((s)->seqdiff);	\
950 	(d)->max_win = ntohs((s)->max_win);	\
951 	(d)->mss = ntohs((s)->mss);		\
952 	(d)->state = (s)->state;		\
953 	(d)->wscale = (s)->wscale;		\
954 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID &&		\
955 	    (d)->scrub != NULL) {					\
956 		(d)->scrub->pfss_flags =				\
957 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
958 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
959 		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
960 	}								\
961 } while (0)
962 
963 #define pf_state_counter_hton(s,d) do {				\
964 	d[0] = htonl((s>>32)&0xffffffff);			\
965 	d[1] = htonl(s&0xffffffff);				\
966 } while (0)
967 
968 #define pf_state_counter_from_pfsync(s)				\
969 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
970 
971 #define pf_state_counter_ntoh(s,d) do {				\
972 	d = ntohl(s[0]);					\
973 	d = d<<32;						\
974 	d += ntohl(s[1]);					\
975 } while (0)
976 
977 TAILQ_HEAD(pf_rulequeue, pf_rule);
978 
979 struct pf_anchor;
980 
981 struct pf_ruleset {
982 	struct {
983 		struct pf_rulequeue	 queues[2];
984 		struct {
985 			struct pf_rulequeue	*ptr;
986 			struct pf_rule		**ptr_array;
987 			u_int32_t		 rcount;
988 			u_int32_t		 ticket;
989 			int			 open;
990 		}			 active, inactive;
991 	}			 rules;
992 	struct pf_anchor	*anchor;
993 	u_int32_t		 tticket;
994 	int			 tables;
995 	int			 topen;
996 };
997 
998 RB_HEAD(pf_anchor_global, pf_anchor);
999 RB_HEAD(pf_anchor_node, pf_anchor);
1000 struct pf_anchor {
1001 	RB_ENTRY(pf_anchor)	 entry_global;
1002 	RB_ENTRY(pf_anchor)	 entry_node;
1003 	struct pf_anchor	*parent;
1004 	struct pf_anchor_node	 children;
1005 	char			 name[PF_ANCHOR_NAME_SIZE];
1006 	char			 path[MAXPATHLEN];
1007 	struct pf_ruleset	 ruleset;
1008 	int			 refcnt;	/* anchor rules */
1009 	int			 match;
1010 };
1011 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
1012 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
1013 
1014 #define PF_RESERVED_ANCHOR	"_pf"
1015 
1016 #define PFR_TFLAG_PERSIST	0x00000001
1017 #define PFR_TFLAG_CONST		0x00000002
1018 #define PFR_TFLAG_ACTIVE	0x00000004
1019 #define PFR_TFLAG_INACTIVE	0x00000008
1020 #define PFR_TFLAG_REFERENCED	0x00000010
1021 #define PFR_TFLAG_REFDANCHOR	0x00000020
1022 #define PFR_TFLAG_COUNTERS	0x00000040
1023 /* Adjust masks below when adding flags. */
1024 #define PFR_TFLAG_USRMASK	0x00000043
1025 #define PFR_TFLAG_SETMASK	0x0000003C
1026 #define PFR_TFLAG_ALLMASK	0x0000007F
1027 
1028 struct pfr_table {
1029 	char			 pfrt_anchor[MAXPATHLEN];
1030 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
1031 	u_int32_t		 pfrt_flags;
1032 	u_int8_t		 pfrt_fback;
1033 };
1034 
1035 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1036 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1037 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1038 
1039 struct pfr_addr {
1040 	union {
1041 		struct in_addr	 _pfra_ip4addr;
1042 		struct in6_addr	 _pfra_ip6addr;
1043 	}		 pfra_u;
1044 	char		 pfra_ifname[IFNAMSIZ];
1045 	u_int32_t	 pfra_states;
1046 	u_int16_t	 pfra_weight;
1047 	u_int8_t	 pfra_af;
1048 	u_int8_t	 pfra_net;
1049 	u_int8_t	 pfra_not;
1050 	u_int8_t	 pfra_fback;
1051 	u_int8_t	 pfra_type;
1052 	u_int8_t	 pad[7];
1053 };
1054 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
1055 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
1056 
1057 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1058 enum { PFR_OP_BLOCK, PFR_OP_MATCH, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1059 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
1060 
1061 struct pfr_astats {
1062 	struct pfr_addr	 pfras_a;
1063 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1064 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1065 	time_t		 pfras_tzero;
1066 };
1067 
1068 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1069 
1070 struct pfr_tstats {
1071 	struct pfr_table pfrts_t;
1072 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1073 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1074 	u_int64_t	 pfrts_match;
1075 	u_int64_t	 pfrts_nomatch;
1076 	time_t		 pfrts_tzero;
1077 	int		 pfrts_cnt;
1078 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1079 };
1080 #define	pfrts_name	pfrts_t.pfrt_name
1081 #define pfrts_flags	pfrts_t.pfrt_flags
1082 
1083 struct pfr_kcounters {
1084 	u_int64_t		 pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1085 	u_int64_t		 pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1086 	u_int64_t		 states;
1087 };
1088 
1089 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1090 struct _pfr_kentry {
1091 	struct radix_node	 _pfrke_node[2];
1092 	union sockaddr_union	 _pfrke_sa;
1093 	SLIST_ENTRY(pfr_kentry)	 _pfrke_workq;
1094 	struct pfr_kcounters	*_pfrke_counters;
1095 	time_t			 _pfrke_tzero;
1096 	u_int8_t		 _pfrke_af;
1097 	u_int8_t		 _pfrke_net;
1098 	u_int8_t		 _pfrke_flags;
1099 	u_int8_t		 _pfrke_type;
1100 };
1101 #define PFRKE_FLAG_NOT		0x01
1102 #define PFRKE_FLAG_MARK		0x02
1103 
1104 /* pfrke_type */
1105 enum { PFRKE_PLAIN, PFRKE_ROUTE, PFRKE_COST, PFRKE_MAX };
1106 
1107 struct pfr_kentry {
1108 	union {
1109 		struct _pfr_kentry	_ke;
1110 	} u;
1111 };
1112 #define pfrke_node	u._ke._pfrke_node
1113 #define pfrke_sa	u._ke._pfrke_sa
1114 #define pfrke_workq	u._ke._pfrke_workq
1115 #define pfrke_counters	u._ke._pfrke_counters
1116 #define pfrke_tzero	u._ke._pfrke_tzero
1117 #define pfrke_af	u._ke._pfrke_af
1118 #define pfrke_net	u._ke._pfrke_net
1119 #define pfrke_flags	u._ke._pfrke_flags
1120 #define pfrke_type	u._ke._pfrke_type
1121 
1122 struct pfr_kentry_route {
1123 	union {
1124 		struct _pfr_kentry	_ke;
1125 	} u;
1126 
1127 	struct pfi_kif		*kif;
1128 };
1129 
1130 struct pfr_kentry_cost {
1131 	union {
1132 		struct _pfr_kentry	_ke;
1133 	} u;
1134 
1135 	struct pfi_kif		*kif;
1136 	/* Above overlaps with pfr_kentry route */
1137 
1138 	u_int16_t		 weight;
1139 };
1140 
1141 struct pfr_kentry_all {
1142 	union {
1143 		struct _pfr_kentry		_ke;
1144 		struct pfr_kentry_route		kr;
1145 		struct pfr_kentry_cost		kc;
1146 	} u;
1147 };
1148 #define pfrke_rkif	u.kr.kif
1149 
1150 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1151 RB_HEAD(pfr_ktablehead, pfr_ktable);
1152 struct pfr_ktable {
1153 	struct pfr_tstats	 pfrkt_ts;
1154 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1155 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1156 	struct radix_node_head	*pfrkt_ip4;
1157 	struct radix_node_head	*pfrkt_ip6;
1158 	struct pfr_ktable	*pfrkt_shadow;
1159 	struct pfr_ktable	*pfrkt_root;
1160 	struct pf_ruleset	*pfrkt_rs;
1161 	long			 pfrkt_larg;
1162 	int			 pfrkt_nflags;
1163 	u_int64_t		 pfrkt_refcntcost;
1164 	u_int16_t		 pfrkt_gcdweight;
1165 	u_int16_t		 pfrkt_maxweight;
1166 };
1167 #define pfrkt_t		pfrkt_ts.pfrts_t
1168 #define pfrkt_name	pfrkt_t.pfrt_name
1169 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
1170 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1171 #define pfrkt_flags	pfrkt_t.pfrt_flags
1172 #define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1173 #define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1174 #define pfrkt_packets	pfrkt_ts.pfrts_packets
1175 #define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1176 #define pfrkt_match	pfrkt_ts.pfrts_match
1177 #define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1178 #define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1179 
1180 RB_HEAD(pf_state_tree, pf_state_key);
1181 RB_PROTOTYPE(pf_state_tree, pf_state_key, entry, pf_state_compare_key);
1182 
1183 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key);
1184 RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state_key,
1185     entry_ext_gwy, pf_state_compare_ext_gwy);
1186 
1187 RB_HEAD(pfi_ifhead, pfi_kif);
1188 
1189 /* state tables */
1190 extern struct pf_state_tree	 pf_statetbl;
1191 
1192 /* keep synced with pfi_kif, used in RB_FIND */
1193 struct pfi_kif_cmp {
1194 	char				 pfik_name[IFNAMSIZ];
1195 };
1196 
1197 struct ifnet;
1198 struct ifg_group;
1199 
1200 struct pfi_kif {
1201 	char				 pfik_name[IFNAMSIZ];
1202 	RB_ENTRY(pfi_kif)		 pfik_tree;
1203 	u_int64_t			 pfik_packets[2][2][2];
1204 	u_int64_t			 pfik_bytes[2][2][2];
1205 	time_t				 pfik_tzero;
1206 	int				 pfik_flags;
1207 	int				 pfik_flags_new;
1208 	void				*pfik_ah_cookie;
1209 	struct ifnet			*pfik_ifp;
1210 	struct ifg_group		*pfik_group;
1211 	int				 pfik_states;
1212 	int				 pfik_rules;
1213 	int				 pfik_routes;
1214 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1215 };
1216 
1217 enum pfi_kif_refs {
1218 	PFI_KIF_REF_NONE,
1219 	PFI_KIF_REF_STATE,
1220 	PFI_KIF_REF_RULE,
1221 	PFI_KIF_REF_ROUTE
1222 };
1223 
1224 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1225 #define PFI_IFLAG_ANY		0x0200	/* match any non-loopback interface */
1226 
1227 struct pf_pdesc {
1228 	struct {
1229 		int	 done;
1230 		uid_t	 uid;
1231 		gid_t	 gid;
1232 		pid_t	 pid;
1233 	}		 lookup;
1234 	u_int64_t	 tot_len;	/* Make Mickey money */
1235 	union {
1236 		struct tcphdr		*tcp;
1237 		struct udphdr		*udp;
1238 		struct icmp		*icmp;
1239 #ifdef INET6
1240 		struct icmp6_hdr	*icmp6;
1241 #endif /* INET6 */
1242 		void			*any;
1243 	} hdr;
1244 
1245 	struct pf_addr	 nsaddr;	/* src address after NAT */
1246 	struct pf_addr	 ndaddr;	/* dst address after NAT */
1247 
1248 	struct pfi_kif	*kif;		/* incoming interface */
1249 	struct mbuf	*m;		/* mbuf containing the packet */
1250 	struct ether_header
1251 			*eh;
1252 	struct pf_addr	*src;		/* src address */
1253 	struct pf_addr	*dst;		/* dst address */
1254 	u_int16_t	*pcksum;	/* proto cksum */
1255 	u_int16_t	*sport;
1256 	u_int16_t	*dport;
1257 	u_int16_t	 osport;
1258 	u_int16_t	 odport;
1259 	u_int16_t	 nsport;	/* src port after NAT */
1260 	u_int16_t	 ndport;	/* dst port after NAT */
1261 
1262 	u_int32_t	 off;		/* protocol header offset */
1263 	u_int32_t	 hdrlen;	/* protocol header length */
1264 	u_int32_t	 p_len;		/* length of protocol payload */
1265 	u_int32_t	 extoff;	/* extentsion header offset */
1266 	u_int32_t	 fragoff;	/* fragment header offset */
1267 	u_int32_t	 jumbolen;	/* length from v6 jumbo header */
1268 	u_int32_t	 badopts;	/* v4 options or v6 routing headers */
1269 
1270 	u_int16_t	 rdomain;	/* original routing domain */
1271 	u_int16_t	 virtual_proto;
1272 #define PF_VPROTO_FRAGMENT	256
1273 	sa_family_t	 af;
1274 	sa_family_t	 naf;
1275 	u_int8_t	 proto;
1276 	u_int8_t	 tos;
1277 	u_int8_t	 ttl;
1278 	u_int8_t	 dir;		/* direction */
1279 	u_int8_t	 sidx;		/* key index for source */
1280 	u_int8_t	 didx;		/* key index for destination */
1281 	u_int8_t	 destchg;	/* flag set when destination changed */
1282 	u_int8_t	 pflog;		/* flags for packet logging */
1283 	u_int8_t	 csum_status;	/* proto cksum ok/bad/unchecked */
1284 #define	PF_CSUM_UNKNOWN	0
1285 #define	PF_CSUM_BAD	1
1286 #define	PF_CSUM_OK	2
1287 };
1288 
1289 
1290 /* flags for RDR options */
1291 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1292 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1293 
1294 /* Reasons code for passing/dropping a packet */
1295 #define PFRES_MATCH	0		/* Explicit match of a rule */
1296 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1297 #define PFRES_FRAG	2		/* Dropping following fragment */
1298 #define PFRES_SHORT	3		/* Dropping short packet */
1299 #define PFRES_NORM	4		/* Dropping by normalizer */
1300 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1301 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1302 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1303 #define PFRES_IPOPTIONS 8		/* IP option */
1304 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1305 #define PFRES_BADSTATE	10		/* State mismatch */
1306 #define PFRES_STATEINS	11		/* State insertion failure */
1307 #define PFRES_MAXSTATES	12		/* State limit */
1308 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1309 #define PFRES_SYNPROXY	14		/* SYN proxy */
1310 #define PFRES_TRANSLATE	15		/* No translation address available */
1311 #define PFRES_MAX	16		/* total+1 */
1312 
1313 #define PFRES_NAMES { \
1314 	"match", \
1315 	"bad-offset", \
1316 	"fragment", \
1317 	"short", \
1318 	"normalize", \
1319 	"memory", \
1320 	"bad-timestamp", \
1321 	"congestion", \
1322 	"ip-option", \
1323 	"proto-cksum", \
1324 	"state-mismatch", \
1325 	"state-insert", \
1326 	"state-limit", \
1327 	"src-limit", \
1328 	"synproxy", \
1329 	"translate", \
1330 	NULL \
1331 }
1332 
1333 /* Counters for other things we want to keep track of */
1334 #define LCNT_STATES		0	/* states */
1335 #define LCNT_SRCSTATES		1	/* max-src-states */
1336 #define LCNT_SRCNODES		2	/* max-src-nodes */
1337 #define LCNT_SRCCONN		3	/* max-src-conn */
1338 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1339 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1340 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1341 #define LCNT_MAX		7	/* total+1 */
1342 
1343 #define LCNT_NAMES { \
1344 	"max states per rule", \
1345 	"max-src-states", \
1346 	"max-src-nodes", \
1347 	"max-src-conn", \
1348 	"max-src-conn-rate", \
1349 	"overload table insertion", \
1350 	"overload flush states", \
1351 	NULL \
1352 }
1353 
1354 /* UDP state enumeration */
1355 #define PFUDPS_NO_TRAFFIC	0
1356 #define PFUDPS_SINGLE		1
1357 #define PFUDPS_MULTIPLE		2
1358 
1359 #define PFUDPS_NSTATES		3	/* number of state levels */
1360 
1361 #define PFUDPS_NAMES { \
1362 	"NO_TRAFFIC", \
1363 	"SINGLE", \
1364 	"MULTIPLE", \
1365 	NULL \
1366 }
1367 
1368 /* Other protocol state enumeration */
1369 #define PFOTHERS_NO_TRAFFIC	0
1370 #define PFOTHERS_SINGLE		1
1371 #define PFOTHERS_MULTIPLE	2
1372 
1373 #define PFOTHERS_NSTATES	3	/* number of state levels */
1374 
1375 #define PFOTHERS_NAMES { \
1376 	"NO_TRAFFIC", \
1377 	"SINGLE", \
1378 	"MULTIPLE", \
1379 	NULL \
1380 }
1381 
1382 #define FCNT_STATE_SEARCH	0
1383 #define FCNT_STATE_INSERT	1
1384 #define FCNT_STATE_REMOVALS	2
1385 #define FCNT_MAX		3
1386 
1387 #define SCNT_SRC_NODE_SEARCH	0
1388 #define SCNT_SRC_NODE_INSERT	1
1389 #define SCNT_SRC_NODE_REMOVALS	2
1390 #define SCNT_MAX		3
1391 
1392 #define ACTION_SET(a, x) \
1393 	do { \
1394 		if ((a) != NULL) \
1395 			*(a) = (x); \
1396 	} while (0)
1397 
1398 #define REASON_SET(a, x) \
1399 	do { \
1400 		if ((void *)(a) != NULL) \
1401 			*(a) = (x); \
1402 		if (x < PFRES_MAX) \
1403 			pf_status.counters[x]++; \
1404 	} while (0)
1405 
1406 struct pf_status {
1407 	u_int64_t	counters[PFRES_MAX];
1408 	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1409 	u_int64_t	fcounters[FCNT_MAX];
1410 	u_int64_t	scounters[SCNT_MAX];
1411 	u_int64_t	pcounters[2][2][3];
1412 	u_int64_t	bcounters[2][2];
1413 	u_int64_t	stateid;
1414 	time_t		since;
1415 	u_int32_t	running;
1416 	u_int32_t	states;
1417 	u_int32_t	src_nodes;
1418 	u_int32_t	debug;
1419 	u_int32_t	hostid;
1420 	u_int32_t	reass;			/* reassembly */
1421 	char		ifname[IFNAMSIZ];
1422 	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1423 };
1424 
1425 #define PF_REASS_ENABLED	0x01
1426 #define PF_REASS_NODF		0x02
1427 
1428 struct pf_queue_bwspec {
1429 	u_int		absolute;
1430 	u_int		percent;
1431 };
1432 
1433 struct pf_queue_scspec {
1434 	struct pf_queue_bwspec	m1;
1435 	struct pf_queue_bwspec	m2;
1436 	u_int			d;
1437 };
1438 
1439 struct pf_queuespec {
1440 	TAILQ_ENTRY(pf_queuespec)	 entries;
1441 	char				 qname[PF_QNAME_SIZE];
1442 	char				 parent[PF_QNAME_SIZE];
1443 	char				 ifname[IFNAMSIZ];
1444 	struct pf_queue_scspec		 realtime;
1445 	struct pf_queue_scspec		 linkshare;
1446 	struct pf_queue_scspec		 upperlimit;
1447 	struct pfi_kif			*kif;
1448 	u_int				 flags;
1449 	u_int				 qlimit;
1450 	u_int32_t			 qid;
1451 	u_int32_t			 parent_qid;
1452 };
1453 
1454 struct cbq_opts {
1455 	u_int		minburst;
1456 	u_int		maxburst;
1457 	u_int		pktsize;
1458 	u_int		maxpktsize;
1459 	u_int		ns_per_byte;
1460 	u_int		maxidle;
1461 	int		minidle;
1462 	u_int		offtime;
1463 	int		flags;
1464 };
1465 
1466 struct priq_opts {
1467 	int		flags;
1468 };
1469 
1470 struct hfsc_opts {
1471 	/* real-time service curve */
1472 	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
1473 	u_int		rtsc_d;		/* the x-projection of m1 in msec */
1474 	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
1475 	/* link-sharing service curve */
1476 	u_int		lssc_m1;
1477 	u_int		lssc_d;
1478 	u_int		lssc_m2;
1479 	/* upper-limit service curve */
1480 	u_int		ulsc_m1;
1481 	u_int		ulsc_d;
1482 	u_int		ulsc_m2;
1483 	int		flags;
1484 };
1485 
1486 struct pf_tagname {
1487 	TAILQ_ENTRY(pf_tagname)	entries;
1488 	char			name[PF_TAG_NAME_SIZE];
1489 	u_int16_t		tag;
1490 	int			ref;
1491 };
1492 
1493 struct pf_divert {
1494 	struct pf_addr	addr;
1495 	u_int16_t	port;
1496 	u_int16_t	rdomain;
1497 };
1498 
1499 /* Fragment entries reference mbuf clusters, so base the default on that. */
1500 #define PFFRAG_FRENT_HIWAT	(NMBCLUSTERS / 4) /* Number of entries */
1501 #define PFFRAG_FRAG_HIWAT	(NMBCLUSTERS / 8) /* Number of packets */
1502 
1503 #define PFR_KTABLE_HIWAT	1000	/* Number of tables */
1504 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1505 #define PFR_KENTRY_HIWAT_SMALL	100000	/* Number of entries for tiny hosts */
1506 
1507 /*
1508  * ioctl parameter structures
1509  */
1510 
1511 struct pfioc_rule {
1512 	u_int32_t	 action;
1513 	u_int32_t	 ticket;
1514 	u_int32_t	 nr;
1515 	char		 anchor[MAXPATHLEN];
1516 	char		 anchor_call[MAXPATHLEN];
1517 	struct pf_rule	 rule;
1518 };
1519 
1520 struct pfioc_natlook {
1521 	struct pf_addr	 saddr;
1522 	struct pf_addr	 daddr;
1523 	struct pf_addr	 rsaddr;
1524 	struct pf_addr	 rdaddr;
1525 	u_int16_t	 rdomain;
1526 	u_int16_t	 rrdomain;
1527 	u_int16_t	 sport;
1528 	u_int16_t	 dport;
1529 	u_int16_t	 rsport;
1530 	u_int16_t	 rdport;
1531 	sa_family_t	 af;
1532 	u_int8_t	 proto;
1533 	u_int8_t	 direction;
1534 };
1535 
1536 struct pfioc_state {
1537 	struct pfsync_state	state;
1538 };
1539 
1540 struct pfioc_src_node_kill {
1541 	sa_family_t psnk_af;
1542 	struct pf_rule_addr psnk_src;
1543 	struct pf_rule_addr psnk_dst;
1544 	u_int		    psnk_killed;
1545 };
1546 
1547 struct pfioc_state_kill {
1548 	struct pf_state_cmp	psk_pfcmp;
1549 	sa_family_t		psk_af;
1550 	int			psk_proto;
1551 	struct pf_rule_addr	psk_src;
1552 	struct pf_rule_addr	psk_dst;
1553 	char			psk_ifname[IFNAMSIZ];
1554 	char			psk_label[PF_RULE_LABEL_SIZE];
1555 	u_int			psk_killed;
1556 	u_int16_t		psk_rdomain;
1557 };
1558 
1559 struct pfioc_states {
1560 	int	ps_len;
1561 	union {
1562 		caddr_t			 psu_buf;
1563 		struct pfsync_state	*psu_states;
1564 	} ps_u;
1565 #define ps_buf		ps_u.psu_buf
1566 #define ps_states	ps_u.psu_states
1567 };
1568 
1569 struct pfioc_src_nodes {
1570 	int	psn_len;
1571 	union {
1572 		caddr_t		 psu_buf;
1573 		struct pf_src_node	*psu_src_nodes;
1574 	} psn_u;
1575 #define psn_buf		psn_u.psu_buf
1576 #define psn_src_nodes	psn_u.psu_src_nodes
1577 };
1578 
1579 struct pfioc_tm {
1580 	int		 timeout;
1581 	int		 seconds;
1582 };
1583 
1584 struct pfioc_limit {
1585 	int		 index;
1586 	unsigned	 limit;
1587 };
1588 
1589 struct pfioc_ruleset {
1590 	u_int32_t	 nr;
1591 	char		 path[MAXPATHLEN];
1592 	char		 name[PF_ANCHOR_NAME_SIZE];
1593 };
1594 
1595 struct pfioc_trans {
1596 	int		 size;	/* number of elements */
1597 	int		 esize; /* size of each element in bytes */
1598 	struct pfioc_trans_e {
1599 		int		type;
1600 		char		anchor[MAXPATHLEN];
1601 		u_int32_t	ticket;
1602 	}		*array;
1603 };
1604 
1605 struct pfioc_queue {
1606 	u_int32_t		ticket;
1607 	u_int			nr;
1608 	struct pf_queuespec	queue;
1609 };
1610 
1611 struct pfioc_qstats {
1612 	u_int32_t		 ticket;
1613 	u_int32_t		 nr;
1614 	struct pf_queuespec	 queue;
1615 	void			*buf;
1616 	int			 nbytes;
1617 };
1618 
1619 #define PFR_FLAG_DUMMY		0x00000002
1620 #define PFR_FLAG_FEEDBACK	0x00000004
1621 #define PFR_FLAG_CLSTATS	0x00000008
1622 #define PFR_FLAG_ADDRSTOO	0x00000010
1623 #define PFR_FLAG_REPLACE	0x00000020
1624 #define PFR_FLAG_ALLRSETS	0x00000040
1625 #define PFR_FLAG_ALLMASK	0x0000007F
1626 #ifdef _KERNEL
1627 #define PFR_FLAG_USERIOCTL	0x10000000
1628 #endif
1629 
1630 struct pfioc_table {
1631 	struct pfr_table	 pfrio_table;
1632 	void			*pfrio_buffer;
1633 	int			 pfrio_esize;
1634 	int			 pfrio_size;
1635 	int			 pfrio_size2;
1636 	int			 pfrio_nadd;
1637 	int			 pfrio_ndel;
1638 	int			 pfrio_nchange;
1639 	int			 pfrio_flags;
1640 	u_int32_t		 pfrio_ticket;
1641 };
1642 #define	pfrio_exists	pfrio_nadd
1643 #define	pfrio_nzero	pfrio_nadd
1644 #define	pfrio_nmatch	pfrio_nadd
1645 #define pfrio_naddr	pfrio_size2
1646 #define pfrio_setflag	pfrio_size2
1647 #define pfrio_clrflag	pfrio_nadd
1648 
1649 struct pfioc_iface {
1650 	char	 pfiio_name[IFNAMSIZ];
1651 	void	*pfiio_buffer;
1652 	int	 pfiio_esize;
1653 	int	 pfiio_size;
1654 	int	 pfiio_nzero;
1655 	int	 pfiio_flags;
1656 };
1657 
1658 
1659 /*
1660  * ioctl operations
1661  */
1662 
1663 #define DIOCSTART	_IO  ('D',  1)
1664 #define DIOCSTOP	_IO  ('D',  2)
1665 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1666 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1667 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1668 /* XXX cut 8 - 17 */
1669 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1670 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1671 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_iface)
1672 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1673 #define DIOCCLRSTATUS	_IOWR('D', 22, struct pfioc_iface)
1674 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1675 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1676 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1677 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1678 /* XXX cut 27 - 28 */
1679 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1680 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1681 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1682 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1683 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1684 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1685 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1686 /* XXX cut 42 - 57 */
1687 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1688 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1689 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1690 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1691 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1692 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1693 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1694 #define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1695 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1696 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1697 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1698 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1699 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1700 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1701 #define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1702 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1703 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1704 #define DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1705 #define DIOCOSFPFLUSH	_IO('D', 78)
1706 #define DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1707 #define DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1708 #define DIOCXBEGIN      _IOWR('D', 81, struct pfioc_trans)
1709 #define DIOCXCOMMIT     _IOWR('D', 82, struct pfioc_trans)
1710 #define DIOCXROLLBACK   _IOWR('D', 83, struct pfioc_trans)
1711 #define DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1712 #define DIOCCLRSRCNODES	_IO('D', 85)
1713 #define DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1714 #define DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1715 #define DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1716 #define DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1717 #define DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1718 #define DIOCSETREASS	_IOWR('D', 92, u_int32_t)
1719 #define DIOCADDQUEUE	_IOWR('D', 93, struct pfioc_queue)
1720 #define DIOCGETQUEUES	_IOWR('D', 94, struct pfioc_queue)
1721 #define DIOCGETQUEUE	_IOWR('D', 95, struct pfioc_queue)
1722 #define DIOCGETQSTATS	_IOWR('D', 96, struct pfioc_qstats)
1723 
1724 #ifdef _KERNEL
1725 RB_HEAD(pf_src_tree, pf_src_node);
1726 RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1727 extern struct pf_src_tree tree_src_tracking;
1728 
1729 RB_HEAD(pf_state_tree_id, pf_state);
1730 RB_PROTOTYPE(pf_state_tree_id, pf_state,
1731     entry_id, pf_state_compare_id);
1732 extern struct pf_state_tree_id tree_id;
1733 extern struct pf_state_queue state_list;
1734 
1735 TAILQ_HEAD(pf_queuehead, pf_queuespec);
1736 extern struct pf_queuehead		  pf_queues[2];
1737 extern struct pf_queuehead		 *pf_queues_active, *pf_queues_inactive;
1738 
1739 extern u_int32_t		 ticket_pabuf;
1740 extern int			 pf_free_queues(struct pf_queuehead *,
1741 				    struct ifnet *);
1742 extern int			 pf_remove_queues(struct ifnet *);
1743 extern int			 pf_tbladdr_setup(struct pf_ruleset *,
1744 				    struct pf_addr_wrap *);
1745 extern void			 pf_tbladdr_remove(struct pf_addr_wrap *);
1746 extern void			 pf_tbladdr_copyout(struct pf_addr_wrap *);
1747 extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1748 extern struct pool		 pf_src_tree_pl, pf_sn_item_pl, pf_rule_pl;
1749 extern struct pool		 pf_state_pl, pf_state_key_pl, pf_state_item_pl,
1750 				    pf_rule_item_pl, pf_queue_pl;
1751 extern struct pool		 pf_state_scrub_pl;
1752 extern struct pool		 hfsc_class_pl, hfsc_classq_pl,
1753 				    hfsc_internal_sc_pl;
1754 extern void			 pf_purge_thread(void *);
1755 extern void			 pf_purge_expired_src_nodes(int);
1756 extern void			 pf_purge_expired_states(u_int32_t);
1757 extern void			 pf_unlink_state(struct pf_state *);
1758 extern void			 pf_free_state(struct pf_state *);
1759 extern int			 pf_state_insert(struct pfi_kif *,
1760 				    struct pf_state_key **,
1761 				    struct pf_state_key **,
1762 				    struct pf_state *);
1763 int				 pf_insert_src_node(struct pf_src_node **,
1764 				    struct pf_rule *, enum pf_sn_types,
1765 				    sa_family_t, struct pf_addr *,
1766 				    struct pf_addr *, int);
1767 void				 pf_remove_src_node(struct pf_src_node *);
1768 struct pf_src_node		*pf_get_src_node(struct pf_state *,
1769 				    enum pf_sn_types);
1770 void				 pf_src_tree_remove_state(struct pf_state *);
1771 void				 pf_state_rm_src_node(struct pf_state *,
1772 				    struct pf_src_node *);
1773 
1774 extern struct pf_state		*pf_find_state_byid(struct pf_state_cmp *);
1775 extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1776 				    u_int, int *);
1777 extern void			 pf_state_export(struct pfsync_state *,
1778 				    struct pf_state *);
1779 extern void			 pf_print_state(struct pf_state *);
1780 extern void			 pf_print_flags(u_int8_t);
1781 
1782 extern struct ifnet		*sync_ifp;
1783 extern struct pf_rule		 pf_default_rule;
1784 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1785 				    u_int8_t);
1786 void				 pf_rm_rule(struct pf_rulequeue *,
1787 				    struct pf_rule *);
1788 void				 pf_purge_rule(struct pf_ruleset *,
1789 				    struct pf_rule *);
1790 struct pf_divert		*pf_find_divert(struct mbuf *);
1791 int				 pf_setup_pdesc(struct pf_pdesc *, void *,
1792 				    sa_family_t, int, struct pfi_kif *,
1793 				    struct mbuf *, u_short *);
1794 
1795 int	pf_test(sa_family_t, int, struct ifnet *, struct mbuf **,
1796 	    struct ether_header *);
1797 
1798 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1799 	    struct pf_addr *, struct pf_addr *, sa_family_t);
1800 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1801 
1802 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1803 	    sa_family_t);
1804 void	pf_change_a(struct pf_pdesc *, void *, u_int32_t);
1805 int	pf_check_proto_cksum(struct pf_pdesc *, int, int, u_int8_t,
1806 	    sa_family_t);
1807 int	pflog_packet(struct pf_pdesc *, u_int8_t, struct pf_rule *,
1808 	    struct pf_rule *, struct pf_ruleset *);
1809 void	pf_send_deferred_syn(struct pf_state *);
1810 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1811 	    struct pf_addr *, sa_family_t);
1812 int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1813 	    struct pf_addr *, sa_family_t);
1814 int	pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1815 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1816 int	pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1817 int	pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1818 
1819 int	pf_refragment6(struct mbuf **, struct m_tag *mtag, int);
1820 void	pf_normalize_init(void);
1821 int	pf_normalize_ip(struct pf_pdesc *, u_short *);
1822 int	pf_normalize_ip6(struct pf_pdesc *, u_short *);
1823 int	pf_normalize_tcp(struct pf_pdesc *);
1824 void	pf_normalize_tcp_cleanup(struct pf_state *);
1825 int	pf_normalize_tcp_init(struct pf_pdesc *, struct pf_state_peer *,
1826 	    struct pf_state_peer *);
1827 int	pf_normalize_tcp_stateful(struct pf_pdesc *, u_short *,
1828 	    struct pf_state *, struct pf_state_peer *, struct pf_state_peer *,
1829 	    int *);
1830 int	pf_normalize_mss(struct pf_pdesc *, u_int16_t);
1831 void	pf_scrub(struct mbuf *, u_int16_t, sa_family_t, u_int8_t, u_int8_t);
1832 int32_t	pf_state_expires(const struct pf_state *);
1833 void	pf_purge_expired_fragments(void);
1834 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1835 	    int);
1836 int	pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *,
1837 	    int);
1838 int	pf_socket_lookup(struct pf_pdesc *);
1839 struct pf_state_key *pf_alloc_state_key(int);
1840 void	pf_pkt_addr_changed(struct mbuf *);
1841 int	pf_state_key_attach(struct pf_state_key *, struct pf_state *, int);
1842 int	pf_translate(struct pf_pdesc *, struct pf_addr *, u_int16_t,
1843 	    struct pf_addr *, u_int16_t, u_int16_t, int);
1844 int	pf_translate_af(struct pf_pdesc *);
1845 void	pf_route(struct mbuf **, struct pf_rule *, int,
1846 	    struct ifnet *, struct pf_state *);
1847 void	pf_route6(struct mbuf **, struct pf_rule *, int,
1848 	   struct ifnet *, struct pf_state *);
1849 
1850 void	pfr_initialize(void);
1851 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1852 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *,
1853 	    struct pf_pdesc *, int, int);
1854 int	pfr_pool_get(struct pf_pool *, struct pf_addr **,
1855 	    struct pf_addr **, sa_family_t);
1856 int	pfr_states_increase(struct pfr_ktable *, struct pf_addr *, int);
1857 int	pfr_states_decrease(struct pfr_ktable *, struct pf_addr *, int);
1858 struct pfr_kentry *
1859 	pfr_kentry_byaddr(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1860 	    int);
1861 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1862 struct pfr_ktable *
1863 	pfr_attach_table(struct pf_ruleset *, char *, int);
1864 void	pfr_detach_table(struct pfr_ktable *);
1865 int	pfr_clr_tables(struct pfr_table *, int *, int);
1866 int	pfr_add_tables(struct pfr_table *, int, int *, int);
1867 int	pfr_del_tables(struct pfr_table *, int, int *, int);
1868 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1869 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1870 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1871 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1872 int	pfr_clr_addrs(struct pfr_table *, int *, int);
1873 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, time_t);
1874 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1875 	    int);
1876 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1877 	    int);
1878 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1879 	    int *, int *, int *, int, u_int32_t);
1880 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1881 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1882 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1883 	    int);
1884 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1885 	    int);
1886 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1887 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1888 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1889 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1890 	    int *, u_int32_t, int);
1891 
1892 extern struct pfi_kif		*pfi_all;
1893 
1894 void		 pfi_initialize(void);
1895 struct pfi_kif	*pfi_kif_get(const char *);
1896 void		 pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1897 void		 pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1898 int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1899 void		 pfi_attach_ifnet(struct ifnet *);
1900 void		 pfi_detach_ifnet(struct ifnet *);
1901 void		 pfi_attach_ifgroup(struct ifg_group *);
1902 void		 pfi_detach_ifgroup(struct ifg_group *);
1903 void		 pfi_group_change(const char *);
1904 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1905 		    sa_family_t);
1906 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1907 void		 pfi_dynaddr_remove(struct pf_addr_wrap *);
1908 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1909 void		 pfi_update_status(const char *, struct pf_status *);
1910 int		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1911 int		 pfi_set_flags(const char *, int);
1912 int		 pfi_clear_flags(const char *, int);
1913 void		 pfi_xcommit(void);
1914 
1915 int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *);
1916 u_int16_t	 pf_tagname2tag(char *, int);
1917 void		 pf_tag2tagname(u_int16_t, char *);
1918 void		 pf_tag_ref(u_int16_t);
1919 void		 pf_tag_unref(u_int16_t);
1920 void		 pf_tag_packet(struct mbuf *, int, int);
1921 int		 pf_addr_compare(struct pf_addr *, struct pf_addr *,
1922 		    sa_family_t);
1923 
1924 extern struct pf_status	pf_status;
1925 extern struct pool	pf_frent_pl, pf_frag_pl;
1926 extern struct rwlock	pf_consistency_lock;
1927 
1928 struct pf_pool_limit {
1929 	void		*pp;
1930 	unsigned	 limit;
1931 	unsigned	 limit_new;
1932 };
1933 extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
1934 
1935 #endif /* _KERNEL */
1936 
1937 extern struct pf_anchor_global	pf_anchors;
1938 extern struct pf_anchor		pf_main_anchor;
1939 #define pf_main_ruleset		pf_main_anchor.ruleset
1940 
1941 /* these ruleset functions can be linked into userland programs (pfctl) */
1942 void			 pf_init_ruleset(struct pf_ruleset *);
1943 int			 pf_anchor_setup(struct pf_rule *,
1944 			    const struct pf_ruleset *, const char *);
1945 int			 pf_anchor_copyout(const struct pf_ruleset *,
1946 			    const struct pf_rule *, struct pfioc_rule *);
1947 void			 pf_anchor_remove(struct pf_rule *);
1948 void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1949 struct pf_anchor	*pf_find_anchor(const char *);
1950 struct pf_ruleset	*pf_find_ruleset(const char *);
1951 struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1952 void			 pf_rs_initialize(void);
1953 
1954 #ifdef _KERNEL
1955 int			 pf_anchor_copyout(const struct pf_ruleset *,
1956 			    const struct pf_rule *, struct pfioc_rule *);
1957 void			 pf_anchor_remove(struct pf_rule *);
1958 
1959 #endif /* _KERNEL */
1960 
1961 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1962 int	pf_osfp_add(struct pf_osfp_ioctl *);
1963 #ifdef _KERNEL
1964 struct pf_osfp_enlist *
1965 	pf_osfp_fingerprint(struct pf_pdesc *);
1966 #endif /* _KERNEL */
1967 struct pf_osfp_enlist *
1968 	pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1969 	    const struct tcphdr *);
1970 void	pf_osfp_flush(void);
1971 int	pf_osfp_get(struct pf_osfp_ioctl *);
1972 void	pf_osfp_initialize(void);
1973 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1974 struct pf_os_fingerprint *
1975 	pf_osfp_validate(void);
1976 
1977 #ifdef _KERNEL
1978 void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1979 
1980 int			 pf_get_transaddr(struct pf_rule *, struct pf_pdesc *,
1981 			    struct pf_src_node **, struct pf_rule **);
1982 
1983 int			 pf_map_addr(sa_family_t, struct pf_rule *,
1984 			    struct pf_addr *, struct pf_addr *,
1985 			    struct pf_addr *, struct pf_src_node **,
1986 			    struct pf_pool *, enum pf_sn_types);
1987 
1988 int			 pf_postprocess_addr(struct pf_state *);
1989 
1990 void			 pf_cksum(struct pf_pdesc *, struct mbuf *);
1991 
1992 #endif /* _KERNEL */
1993 
1994 
1995 #endif /* _NET_PFVAR_H_ */
1996