xref: /freebsd/sys/net/pfvar.h (revision 3a248c84419d4f7d6617d30744ab56d0b456fe03)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Daniel Hartmeier
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  *    - Redistributions of source code must retain the above copyright
12  *      notice, this list of conditions and the following disclaimer.
13  *    - Redistributions in binary form must reproduce the above
14  *      copyright notice, this list of conditions and the following
15  *      disclaimer in the documentation and/or other materials provided
16  *      with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  *	$OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
32  *	$FreeBSD$
33  */
34 
35 #ifndef _NET_PFVAR_H_
36 #define _NET_PFVAR_H_
37 
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/counter.h>
41 #include <sys/cpuset.h>
42 #include <sys/malloc.h>
43 #include <sys/nv.h>
44 #include <sys/refcount.h>
45 #include <sys/sysctl.h>
46 #include <sys/lock.h>
47 #include <sys/rmlock.h>
48 #include <sys/tree.h>
49 #include <vm/uma.h>
50 
51 #include <net/radix.h>
52 #include <netinet/in.h>
53 
54 #include <netpfil/pf/pf.h>
55 #include <netpfil/pf/pf_altq.h>
56 #include <netpfil/pf/pf_mtag.h>
57 
58 #ifdef _KERNEL
59 
60 SYSCTL_DECL(_net_pf);
61 MALLOC_DECLARE(M_PFHASH);
62 
63 struct pfi_dynaddr {
64 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
65 	struct pf_addr			 pfid_addr4;
66 	struct pf_addr			 pfid_mask4;
67 	struct pf_addr			 pfid_addr6;
68 	struct pf_addr			 pfid_mask6;
69 	struct pfr_ktable		*pfid_kt;
70 	struct pfi_kkif			*pfid_kif;
71 	int				 pfid_net;	/* mask or 128 */
72 	int				 pfid_acnt4;	/* address count IPv4 */
73 	int				 pfid_acnt6;	/* address count IPv6 */
74 	sa_family_t			 pfid_af;	/* rule af */
75 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
76 };
77 
78 /*
79  * Address manipulation macros
80  */
81 #define	HTONL(x)	(x) = htonl((__uint32_t)(x))
82 #define	HTONS(x)	(x) = htons((__uint16_t)(x))
83 #define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
84 #define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
85 
86 #define	PF_NAME		"pf"
87 
88 #define	PF_HASHROW_ASSERT(h)	mtx_assert(&(h)->lock, MA_OWNED)
89 #define	PF_HASHROW_LOCK(h)	mtx_lock(&(h)->lock)
90 #define	PF_HASHROW_UNLOCK(h)	mtx_unlock(&(h)->lock)
91 
92 #define	PF_STATE_LOCK(s)						\
93 	do {								\
94 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
95 		PF_HASHROW_LOCK(_ih);					\
96 	} while (0)
97 
98 #define	PF_STATE_UNLOCK(s)						\
99 	do {								\
100 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))];	\
101 		PF_HASHROW_UNLOCK(_ih);					\
102 	} while (0)
103 
104 #ifdef INVARIANTS
105 #define	PF_STATE_LOCK_ASSERT(s)						\
106 	do {								\
107 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
108 		PF_HASHROW_ASSERT(_ih);					\
109 	} while (0)
110 #else /* !INVARIANTS */
111 #define	PF_STATE_LOCK_ASSERT(s)		do {} while (0)
112 #endif /* INVARIANTS */
113 
114 extern struct mtx pf_unlnkdrules_mtx;
115 #define	PF_UNLNKDRULES_LOCK()	mtx_lock(&pf_unlnkdrules_mtx)
116 #define	PF_UNLNKDRULES_UNLOCK()	mtx_unlock(&pf_unlnkdrules_mtx)
117 
118 extern struct rmlock pf_rules_lock;
119 #define	PF_RULES_RLOCK_TRACKER	struct rm_priotracker _pf_rules_tracker
120 #define	PF_RULES_RLOCK()	rm_rlock(&pf_rules_lock, &_pf_rules_tracker)
121 #define	PF_RULES_RUNLOCK()	rm_runlock(&pf_rules_lock, &_pf_rules_tracker)
122 #define	PF_RULES_WLOCK()	rm_wlock(&pf_rules_lock)
123 #define	PF_RULES_WUNLOCK()	rm_wunlock(&pf_rules_lock)
124 #define	PF_RULES_ASSERT()	rm_assert(&pf_rules_lock, RA_LOCKED)
125 #define	PF_RULES_RASSERT()	rm_assert(&pf_rules_lock, RA_RLOCKED)
126 #define	PF_RULES_WASSERT()	rm_assert(&pf_rules_lock, RA_WLOCKED)
127 
128 extern struct sx pf_end_lock;
129 
130 #define	PF_MODVER	1
131 #define	PFLOG_MODVER	1
132 #define	PFSYNC_MODVER	1
133 
134 #define	PFLOG_MINVER	1
135 #define	PFLOG_PREFVER	PFLOG_MODVER
136 #define	PFLOG_MAXVER	1
137 #define	PFSYNC_MINVER	1
138 #define	PFSYNC_PREFVER	PFSYNC_MODVER
139 #define	PFSYNC_MAXVER	1
140 
141 #ifdef INET
142 #ifndef INET6
143 #define	PF_INET_ONLY
144 #endif /* ! INET6 */
145 #endif /* INET */
146 
147 #ifdef INET6
148 #ifndef INET
149 #define	PF_INET6_ONLY
150 #endif /* ! INET */
151 #endif /* INET6 */
152 
153 #ifdef INET
154 #ifdef INET6
155 #define	PF_INET_INET6
156 #endif /* INET6 */
157 #endif /* INET */
158 
159 #else
160 
161 #define	PF_INET_INET6
162 
163 #endif /* _KERNEL */
164 
165 /* Both IPv4 and IPv6 */
166 #ifdef PF_INET_INET6
167 
168 #define PF_AEQ(a, b, c) \
169 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
170 	(c == AF_INET6 && (a)->addr32[3] == (b)->addr32[3] && \
171 	(a)->addr32[2] == (b)->addr32[2] && \
172 	(a)->addr32[1] == (b)->addr32[1] && \
173 	(a)->addr32[0] == (b)->addr32[0])) \
174 
175 #define PF_ANEQ(a, b, c) \
176 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
177 	(c == AF_INET6 && ((a)->addr32[0] != (b)->addr32[0] || \
178 	(a)->addr32[1] != (b)->addr32[1] || \
179 	(a)->addr32[2] != (b)->addr32[2] || \
180 	(a)->addr32[3] != (b)->addr32[3]))) \
181 
182 #define PF_AZERO(a, c) \
183 	((c == AF_INET && !(a)->addr32[0]) || \
184 	(c == AF_INET6 && !(a)->addr32[0] && !(a)->addr32[1] && \
185 	!(a)->addr32[2] && !(a)->addr32[3] )) \
186 
187 #define PF_MATCHA(n, a, m, b, f) \
188 	pf_match_addr(n, a, m, b, f)
189 
190 #define PF_ACPY(a, b, f) \
191 	pf_addrcpy(a, b, f)
192 
193 #define PF_AINC(a, f) \
194 	pf_addr_inc(a, f)
195 
196 #define PF_POOLMASK(a, b, c, d, f) \
197 	pf_poolmask(a, b, c, d, f)
198 
199 #else
200 
201 /* Just IPv6 */
202 
203 #ifdef PF_INET6_ONLY
204 
205 #define PF_AEQ(a, b, c) \
206 	((a)->addr32[3] == (b)->addr32[3] && \
207 	(a)->addr32[2] == (b)->addr32[2] && \
208 	(a)->addr32[1] == (b)->addr32[1] && \
209 	(a)->addr32[0] == (b)->addr32[0]) \
210 
211 #define PF_ANEQ(a, b, c) \
212 	((a)->addr32[3] != (b)->addr32[3] || \
213 	(a)->addr32[2] != (b)->addr32[2] || \
214 	(a)->addr32[1] != (b)->addr32[1] || \
215 	(a)->addr32[0] != (b)->addr32[0]) \
216 
217 #define PF_AZERO(a, c) \
218 	(!(a)->addr32[0] && \
219 	!(a)->addr32[1] && \
220 	!(a)->addr32[2] && \
221 	!(a)->addr32[3] ) \
222 
223 #define PF_MATCHA(n, a, m, b, f) \
224 	pf_match_addr(n, a, m, b, f)
225 
226 #define PF_ACPY(a, b, f) \
227 	pf_addrcpy(a, b, f)
228 
229 #define PF_AINC(a, f) \
230 	pf_addr_inc(a, f)
231 
232 #define PF_POOLMASK(a, b, c, d, f) \
233 	pf_poolmask(a, b, c, d, f)
234 
235 #else
236 
237 /* Just IPv4 */
238 #ifdef PF_INET_ONLY
239 
240 #define PF_AEQ(a, b, c) \
241 	((a)->addr32[0] == (b)->addr32[0])
242 
243 #define PF_ANEQ(a, b, c) \
244 	((a)->addr32[0] != (b)->addr32[0])
245 
246 #define PF_AZERO(a, c) \
247 	(!(a)->addr32[0])
248 
249 #define PF_MATCHA(n, a, m, b, f) \
250 	pf_match_addr(n, a, m, b, f)
251 
252 #define PF_ACPY(a, b, f) \
253 	(a)->v4.s_addr = (b)->v4.s_addr
254 
255 #define PF_AINC(a, f) \
256 	do { \
257 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
258 	} while (0)
259 
260 #define PF_POOLMASK(a, b, c, d, f) \
261 	do { \
262 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
263 		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
264 	} while (0)
265 
266 #endif /* PF_INET_ONLY */
267 #endif /* PF_INET6_ONLY */
268 #endif /* PF_INET_INET6 */
269 
270 /*
271  * XXX callers not FIB-aware in our version of pf yet.
272  * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
273  */
274 #define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
275 	(								\
276 		(((aw)->type == PF_ADDR_NOROUTE &&			\
277 		    pf_routable((x), (af), NULL, (rtid))) ||		\
278 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
279 		    pf_routable((x), (af), (ifp), (rtid))) ||		\
280 		((aw)->type == PF_ADDR_TABLE &&				\
281 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
282 		((aw)->type == PF_ADDR_DYNIFTL &&			\
283 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
284 		((aw)->type == PF_ADDR_RANGE &&				\
285 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
286 		    &(aw)->v.a.mask, (x), (af))) ||			\
287 		((aw)->type == PF_ADDR_ADDRMASK &&			\
288 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
289 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
290 		    &(aw)->v.a.mask, (x), (af))))) !=			\
291 		(neg)							\
292 	)
293 
294 #define PF_ALGNMNT(off) (((off) % 2) == 0)
295 
296 #ifdef _KERNEL
297 
298 struct pf_kpooladdr {
299 	struct pf_addr_wrap		 addr;
300 	TAILQ_ENTRY(pf_kpooladdr)	 entries;
301 	char				 ifname[IFNAMSIZ];
302 	struct pfi_kkif			*kif;
303 };
304 
305 TAILQ_HEAD(pf_kpalist, pf_kpooladdr);
306 
307 struct pf_kpool {
308 	struct pf_kpalist	 list;
309 	struct pf_kpooladdr	*cur;
310 	struct pf_poolhashkey	 key;
311 	struct pf_addr		 counter;
312 	struct pf_mape_portset	 mape;
313 	int			 tblidx;
314 	u_int16_t		 proxy_port[2];
315 	u_int8_t		 opts;
316 };
317 
318 union pf_krule_ptr {
319 	struct pf_krule		*ptr;
320 	u_int32_t		 nr;
321 };
322 
323 struct pf_krule {
324 	struct pf_rule_addr	 src;
325 	struct pf_rule_addr	 dst;
326 	union pf_krule_ptr	 skip[PF_SKIP_COUNT];
327 	char			 label[PF_RULE_LABEL_SIZE];
328 	char			 ifname[IFNAMSIZ];
329 	char			 qname[PF_QNAME_SIZE];
330 	char			 pqname[PF_QNAME_SIZE];
331 	char			 tagname[PF_TAG_NAME_SIZE];
332 	char			 match_tagname[PF_TAG_NAME_SIZE];
333 
334 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
335 
336 	TAILQ_ENTRY(pf_krule)	 entries;
337 	struct pf_kpool		 rpool;
338 
339 	counter_u64_t		 evaluations;
340 	counter_u64_t		 packets[2];
341 	counter_u64_t		 bytes[2];
342 
343 	struct pfi_kkif		*kif;
344 	struct pf_kanchor	*anchor;
345 	struct pfr_ktable	*overload_tbl;
346 
347 	pf_osfp_t		 os_fingerprint;
348 
349 	int			 rtableid;
350 	u_int32_t		 timeout[PFTM_MAX];
351 	u_int32_t		 max_states;
352 	u_int32_t		 max_src_nodes;
353 	u_int32_t		 max_src_states;
354 	u_int32_t		 max_src_conn;
355 	struct {
356 		u_int32_t		limit;
357 		u_int32_t		seconds;
358 	}			 max_src_conn_rate;
359 	u_int32_t		 qid;
360 	u_int32_t		 pqid;
361 	u_int32_t		 nr;
362 	u_int32_t		 prob;
363 	uid_t			 cuid;
364 	pid_t			 cpid;
365 
366 	counter_u64_t		 states_cur;
367 	counter_u64_t		 states_tot;
368 	counter_u64_t		 src_nodes;
369 
370 	u_int16_t		 return_icmp;
371 	u_int16_t		 return_icmp6;
372 	u_int16_t		 max_mss;
373 	u_int16_t		 tag;
374 	u_int16_t		 match_tag;
375 	u_int16_t		 scrub_flags;
376 
377 	struct pf_rule_uid	 uid;
378 	struct pf_rule_gid	 gid;
379 
380 	u_int32_t		 rule_flag;
381 	u_int8_t		 action;
382 	u_int8_t		 direction;
383 	u_int8_t		 log;
384 	u_int8_t		 logif;
385 	u_int8_t		 quick;
386 	u_int8_t		 ifnot;
387 	u_int8_t		 match_tag_not;
388 	u_int8_t		 natpass;
389 
390 	u_int8_t		 keep_state;
391 	sa_family_t		 af;
392 	u_int8_t		 proto;
393 	u_int8_t		 type;
394 	u_int8_t		 code;
395 	u_int8_t		 flags;
396 	u_int8_t		 flagset;
397 	u_int8_t		 min_ttl;
398 	u_int8_t		 allow_opts;
399 	u_int8_t		 rt;
400 	u_int8_t		 return_ttl;
401 	u_int8_t		 tos;
402 	u_int8_t		 set_tos;
403 	u_int8_t		 anchor_relative;
404 	u_int8_t		 anchor_wildcard;
405 
406 	u_int8_t		 flush;
407 	u_int8_t		 prio;
408 	u_int8_t		 set_prio[2];
409 
410 	struct {
411 		struct pf_addr		addr;
412 		u_int16_t		port;
413 	}			divert;
414 };
415 
416 struct pf_ksrc_node {
417 	LIST_ENTRY(pf_ksrc_node) entry;
418 	struct pf_addr	 addr;
419 	struct pf_addr	 raddr;
420 	union pf_krule_ptr rule;
421 	struct pfi_kkif	*kif;
422 	counter_u64_t	 bytes[2];
423 	counter_u64_t	 packets[2];
424 	u_int32_t	 states;
425 	u_int32_t	 conn;
426 	struct pf_threshold	conn_rate;
427 	u_int32_t	 creation;
428 	u_int32_t	 expire;
429 	sa_family_t	 af;
430 	u_int8_t	 ruletype;
431 };
432 #endif
433 
434 struct pf_state_scrub {
435 	struct timeval	pfss_last;	/* time received last packet	*/
436 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
437 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
438 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
439 	u_int16_t	pfss_flags;
440 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
441 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
442 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
443 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
444 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
445 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
446 	u_int8_t	pad;
447 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
448 };
449 
450 struct pf_state_host {
451 	struct pf_addr	addr;
452 	u_int16_t	port;
453 	u_int16_t	pad;
454 };
455 
456 struct pf_state_peer {
457 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
458 	u_int32_t	seqlo;		/* Max sequence number sent	*/
459 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
460 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
461 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
462 	u_int16_t	mss;		/* Maximum segment size option	*/
463 	u_int8_t	state;		/* active state level		*/
464 	u_int8_t	wscale;		/* window scaling factor	*/
465 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
466 	u_int8_t	pad[1];
467 };
468 
469 /* Keep synced with struct pf_state_key. */
470 struct pf_state_key_cmp {
471 	struct pf_addr	 addr[2];
472 	u_int16_t	 port[2];
473 	sa_family_t	 af;
474 	u_int8_t	 proto;
475 	u_int8_t	 pad[2];
476 };
477 
478 struct pf_state_key {
479 	struct pf_addr	 addr[2];
480 	u_int16_t	 port[2];
481 	sa_family_t	 af;
482 	u_int8_t	 proto;
483 	u_int8_t	 pad[2];
484 
485 	LIST_ENTRY(pf_state_key) entry;
486 	TAILQ_HEAD(, pf_state)	 states[2];
487 };
488 
489 /* Keep synced with struct pf_state. */
490 struct pf_state_cmp {
491 	u_int64_t		 id;
492 	u_int32_t		 creatorid;
493 	u_int8_t		 direction;
494 	u_int8_t		 pad[3];
495 };
496 
497 #define	PFSTATE_ALLOWOPTS	0x01
498 #define	PFSTATE_SLOPPY		0x02
499 /*  was	PFSTATE_PFLOW		0x04 */
500 #define	PFSTATE_NOSYNC		0x08
501 #define	PFSTATE_ACK		0x10
502 #define	PFSTATE_SETPRIO		0x0200
503 #define	PFSTATE_SETMASK   (PFSTATE_SETPRIO)
504 
505 #ifdef _KERNEL
506 struct pf_state {
507 	u_int64_t		 id;
508 	u_int32_t		 creatorid;
509 	u_int8_t		 direction;
510 	u_int8_t		 pad[3];
511 
512 	u_int			 refs;
513 	TAILQ_ENTRY(pf_state)	 sync_list;
514 	TAILQ_ENTRY(pf_state)	 key_list[2];
515 	LIST_ENTRY(pf_state)	 entry;
516 	struct pf_state_peer	 src;
517 	struct pf_state_peer	 dst;
518 	union pf_krule_ptr	 rule;
519 	union pf_krule_ptr	 anchor;
520 	union pf_krule_ptr	 nat_rule;
521 	struct pf_addr		 rt_addr;
522 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
523 	struct pfi_kkif		*kif;
524 	struct pfi_kkif		*rt_kif;
525 	struct pf_ksrc_node	*src_node;
526 	struct pf_ksrc_node	*nat_src_node;
527 	counter_u64_t		 packets[2];
528 	counter_u64_t		 bytes[2];
529 	u_int32_t		 creation;
530 	u_int32_t	 	 expire;
531 	u_int32_t		 pfsync_time;
532 	u_int16_t		 tag;
533 	u_int8_t		 log;
534 	u_int8_t		 state_flags;
535 	u_int8_t		 timeout;
536 	u_int8_t		 sync_state; /* PFSYNC_S_x */
537 
538 	/* XXX */
539 	u_int8_t		 sync_updates;
540 	u_int8_t		_tail[3];
541 };
542 #endif
543 
544 /*
545  * Unified state structures for pulling states out of the kernel
546  * used by pfsync(4) and the pf(4) ioctl.
547  */
548 struct pfsync_state_scrub {
549 	u_int16_t	pfss_flags;
550 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
551 #define PFSYNC_SCRUB_FLAG_VALID		0x01
552 	u_int8_t	scrub_flag;
553 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
554 } __packed;
555 
556 struct pfsync_state_peer {
557 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
558 	u_int32_t	seqlo;		/* Max sequence number sent	*/
559 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
560 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
561 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
562 	u_int16_t	mss;		/* Maximum segment size option	*/
563 	u_int8_t	state;		/* active state level		*/
564 	u_int8_t	wscale;		/* window scaling factor	*/
565 	u_int8_t	pad[6];
566 } __packed;
567 
568 struct pfsync_state_key {
569 	struct pf_addr	 addr[2];
570 	u_int16_t	 port[2];
571 };
572 
573 struct pfsync_state {
574 	u_int64_t	 id;
575 	char		 ifname[IFNAMSIZ];
576 	struct pfsync_state_key	key[2];
577 	struct pfsync_state_peer src;
578 	struct pfsync_state_peer dst;
579 	struct pf_addr	 rt_addr;
580 	u_int32_t	 rule;
581 	u_int32_t	 anchor;
582 	u_int32_t	 nat_rule;
583 	u_int32_t	 creation;
584 	u_int32_t	 expire;
585 	u_int32_t	 packets[2][2];
586 	u_int32_t	 bytes[2][2];
587 	u_int32_t	 creatorid;
588 	sa_family_t	 af;
589 	u_int8_t	 proto;
590 	u_int8_t	 direction;
591 	u_int8_t	 __spare[2];
592 	u_int8_t	 log;
593 	u_int8_t	 state_flags;
594 	u_int8_t	 timeout;
595 	u_int8_t	 sync_flags;
596 	u_int8_t	 updates;
597 } __packed;
598 
599 #ifdef _KERNEL
600 /* pfsync */
601 typedef int		pfsync_state_import_t(struct pfsync_state *, u_int8_t);
602 typedef	void		pfsync_insert_state_t(struct pf_state *);
603 typedef	void		pfsync_update_state_t(struct pf_state *);
604 typedef	void		pfsync_delete_state_t(struct pf_state *);
605 typedef void		pfsync_clear_states_t(u_int32_t, const char *);
606 typedef int		pfsync_defer_t(struct pf_state *, struct mbuf *);
607 typedef void		pfsync_detach_ifnet_t(struct ifnet *);
608 
609 VNET_DECLARE(pfsync_state_import_t *, pfsync_state_import_ptr);
610 #define V_pfsync_state_import_ptr	VNET(pfsync_state_import_ptr)
611 VNET_DECLARE(pfsync_insert_state_t *, pfsync_insert_state_ptr);
612 #define V_pfsync_insert_state_ptr	VNET(pfsync_insert_state_ptr)
613 VNET_DECLARE(pfsync_update_state_t *, pfsync_update_state_ptr);
614 #define V_pfsync_update_state_ptr	VNET(pfsync_update_state_ptr)
615 VNET_DECLARE(pfsync_delete_state_t *, pfsync_delete_state_ptr);
616 #define V_pfsync_delete_state_ptr	VNET(pfsync_delete_state_ptr)
617 VNET_DECLARE(pfsync_clear_states_t *, pfsync_clear_states_ptr);
618 #define V_pfsync_clear_states_ptr	VNET(pfsync_clear_states_ptr)
619 VNET_DECLARE(pfsync_defer_t *, pfsync_defer_ptr);
620 #define V_pfsync_defer_ptr		VNET(pfsync_defer_ptr)
621 extern pfsync_detach_ifnet_t	*pfsync_detach_ifnet_ptr;
622 
623 void			pfsync_state_export(struct pfsync_state *,
624 			    struct pf_state *);
625 
626 /* pflog */
627 struct pf_kruleset;
628 struct pf_pdesc;
629 typedef int pflog_packet_t(struct pfi_kkif *, struct mbuf *, sa_family_t,
630     u_int8_t, u_int8_t, struct pf_krule *, struct pf_krule *,
631     struct pf_kruleset *, struct pf_pdesc *, int);
632 extern pflog_packet_t		*pflog_packet_ptr;
633 
634 #endif /* _KERNEL */
635 
636 #define	PFSYNC_FLAG_SRCNODE	0x04
637 #define	PFSYNC_FLAG_NATSRCNODE	0x08
638 
639 /* for copies to/from network byte order */
640 /* ioctl interface also uses network byte order */
641 #define pf_state_peer_hton(s,d) do {		\
642 	(d)->seqlo = htonl((s)->seqlo);		\
643 	(d)->seqhi = htonl((s)->seqhi);		\
644 	(d)->seqdiff = htonl((s)->seqdiff);	\
645 	(d)->max_win = htons((s)->max_win);	\
646 	(d)->mss = htons((s)->mss);		\
647 	(d)->state = (s)->state;		\
648 	(d)->wscale = (s)->wscale;		\
649 	if ((s)->scrub) {						\
650 		(d)->scrub.pfss_flags = 				\
651 		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
652 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
653 		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
654 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
655 	}								\
656 } while (0)
657 
658 #define pf_state_peer_ntoh(s,d) do {		\
659 	(d)->seqlo = ntohl((s)->seqlo);		\
660 	(d)->seqhi = ntohl((s)->seqhi);		\
661 	(d)->seqdiff = ntohl((s)->seqdiff);	\
662 	(d)->max_win = ntohs((s)->max_win);	\
663 	(d)->mss = ntohs((s)->mss);		\
664 	(d)->state = (s)->state;		\
665 	(d)->wscale = (s)->wscale;		\
666 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
667 	    (d)->scrub != NULL) {					\
668 		(d)->scrub->pfss_flags =				\
669 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
670 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
671 		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
672 	}								\
673 } while (0)
674 
675 #define pf_state_counter_hton(s,d) do {				\
676 	d[0] = htonl((s>>32)&0xffffffff);			\
677 	d[1] = htonl(s&0xffffffff);				\
678 } while (0)
679 
680 #define pf_state_counter_from_pfsync(s)				\
681 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
682 
683 #define pf_state_counter_ntoh(s,d) do {				\
684 	d = ntohl(s[0]);					\
685 	d = d<<32;						\
686 	d += ntohl(s[1]);					\
687 } while (0)
688 
689 TAILQ_HEAD(pf_krulequeue, pf_krule);
690 
691 struct pf_kanchor;
692 
693 struct pf_kruleset {
694 	struct {
695 		struct pf_krulequeue	 queues[2];
696 		struct {
697 			struct pf_krulequeue	*ptr;
698 			struct pf_krule		**ptr_array;
699 			u_int32_t		 rcount;
700 			u_int32_t		 ticket;
701 			int			 open;
702 		}			 active, inactive;
703 	}			 rules[PF_RULESET_MAX];
704 	struct pf_kanchor	*anchor;
705 	u_int32_t		 tticket;
706 	int			 tables;
707 	int			 topen;
708 };
709 
710 RB_HEAD(pf_kanchor_global, pf_kanchor);
711 RB_HEAD(pf_kanchor_node, pf_kanchor);
712 struct pf_kanchor {
713 	RB_ENTRY(pf_kanchor)	 entry_global;
714 	RB_ENTRY(pf_kanchor)	 entry_node;
715 	struct pf_kanchor	*parent;
716 	struct pf_kanchor_node	 children;
717 	char			 name[PF_ANCHOR_NAME_SIZE];
718 	char			 path[MAXPATHLEN];
719 	struct pf_kruleset	 ruleset;
720 	int			 refcnt;	/* anchor rules */
721 	int			 match;	/* XXX: used for pfctl black magic */
722 };
723 RB_PROTOTYPE(pf_kanchor_global, pf_kanchor, entry_global, pf_anchor_compare);
724 RB_PROTOTYPE(pf_kanchor_node, pf_kanchor, entry_node, pf_kanchor_compare);
725 
726 #define PF_RESERVED_ANCHOR	"_pf"
727 
728 #define PFR_TFLAG_PERSIST	0x00000001
729 #define PFR_TFLAG_CONST		0x00000002
730 #define PFR_TFLAG_ACTIVE	0x00000004
731 #define PFR_TFLAG_INACTIVE	0x00000008
732 #define PFR_TFLAG_REFERENCED	0x00000010
733 #define PFR_TFLAG_REFDANCHOR	0x00000020
734 #define PFR_TFLAG_COUNTERS	0x00000040
735 /* Adjust masks below when adding flags. */
736 #define PFR_TFLAG_USRMASK	(PFR_TFLAG_PERSIST	| \
737 				 PFR_TFLAG_CONST	| \
738 				 PFR_TFLAG_COUNTERS)
739 #define PFR_TFLAG_SETMASK	(PFR_TFLAG_ACTIVE	| \
740 				 PFR_TFLAG_INACTIVE	| \
741 				 PFR_TFLAG_REFERENCED	| \
742 				 PFR_TFLAG_REFDANCHOR)
743 #define PFR_TFLAG_ALLMASK	(PFR_TFLAG_PERSIST	| \
744 				 PFR_TFLAG_CONST	| \
745 				 PFR_TFLAG_ACTIVE	| \
746 				 PFR_TFLAG_INACTIVE	| \
747 				 PFR_TFLAG_REFERENCED	| \
748 				 PFR_TFLAG_REFDANCHOR	| \
749 				 PFR_TFLAG_COUNTERS)
750 
751 struct pf_kanchor_stackframe;
752 
753 struct pfr_table {
754 	char			 pfrt_anchor[MAXPATHLEN];
755 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
756 	u_int32_t		 pfrt_flags;
757 	u_int8_t		 pfrt_fback;
758 };
759 
760 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
761 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
762 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
763 
764 struct pfr_addr {
765 	union {
766 		struct in_addr	 _pfra_ip4addr;
767 		struct in6_addr	 _pfra_ip6addr;
768 	}		 pfra_u;
769 	u_int8_t	 pfra_af;
770 	u_int8_t	 pfra_net;
771 	u_int8_t	 pfra_not;
772 	u_int8_t	 pfra_fback;
773 };
774 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
775 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
776 
777 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
778 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
779 enum { PFR_TYPE_PACKETS, PFR_TYPE_BYTES, PFR_TYPE_MAX };
780 #define	PFR_NUM_COUNTERS	(PFR_DIR_MAX * PFR_OP_ADDR_MAX * PFR_TYPE_MAX)
781 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
782 
783 struct pfr_astats {
784 	struct pfr_addr	 pfras_a;
785 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
786 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
787 	long		 pfras_tzero;
788 };
789 
790 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
791 
792 struct pfr_tstats {
793 	struct pfr_table pfrts_t;
794 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
795 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
796 	u_int64_t	 pfrts_match;
797 	u_int64_t	 pfrts_nomatch;
798 	long		 pfrts_tzero;
799 	int		 pfrts_cnt;
800 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
801 };
802 
803 struct pfr_ktstats {
804 	struct pfr_table pfrts_t;
805 	counter_u64_t	 pfrkts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
806 	counter_u64_t	 pfrkts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
807 	counter_u64_t	 pfrkts_match;
808 	counter_u64_t	 pfrkts_nomatch;
809 	long		 pfrkts_tzero;
810 	int		 pfrkts_cnt;
811 	int		 pfrkts_refcnt[PFR_REFCNT_MAX];
812 };
813 #define	pfrts_name	pfrts_t.pfrt_name
814 #define pfrts_flags	pfrts_t.pfrt_flags
815 
816 #ifndef _SOCKADDR_UNION_DEFINED
817 #define	_SOCKADDR_UNION_DEFINED
818 union sockaddr_union {
819 	struct sockaddr		sa;
820 	struct sockaddr_in	sin;
821 	struct sockaddr_in6	sin6;
822 };
823 #endif /* _SOCKADDR_UNION_DEFINED */
824 
825 struct pfr_kcounters {
826 	counter_u64_t		 pfrkc_counters;
827 	long			 pfrkc_tzero;
828 };
829 #define	pfr_kentry_counter(kc, dir, op, t)		\
830 	((kc)->pfrkc_counters +				\
831 	    (dir) * PFR_OP_ADDR_MAX * PFR_TYPE_MAX + (op) * PFR_TYPE_MAX + (t))
832 
833 #ifdef _KERNEL
834 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
835 struct pfr_kentry {
836 	struct radix_node	 pfrke_node[2];
837 	union sockaddr_union	 pfrke_sa;
838 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
839 	struct pfr_kcounters	 pfrke_counters;
840 	u_int8_t		 pfrke_af;
841 	u_int8_t		 pfrke_net;
842 	u_int8_t		 pfrke_not;
843 	u_int8_t		 pfrke_mark;
844 };
845 
846 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
847 RB_HEAD(pfr_ktablehead, pfr_ktable);
848 struct pfr_ktable {
849 	struct pfr_ktstats	 pfrkt_kts;
850 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
851 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
852 	struct radix_node_head	*pfrkt_ip4;
853 	struct radix_node_head	*pfrkt_ip6;
854 	struct pfr_ktable	*pfrkt_shadow;
855 	struct pfr_ktable	*pfrkt_root;
856 	struct pf_kruleset	*pfrkt_rs;
857 	long			 pfrkt_larg;
858 	int			 pfrkt_nflags;
859 };
860 #define pfrkt_t		pfrkt_kts.pfrts_t
861 #define pfrkt_name	pfrkt_t.pfrt_name
862 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
863 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
864 #define pfrkt_flags	pfrkt_t.pfrt_flags
865 #define pfrkt_cnt	pfrkt_kts.pfrkts_cnt
866 #define pfrkt_refcnt	pfrkt_kts.pfrkts_refcnt
867 #define pfrkt_packets	pfrkt_kts.pfrkts_packets
868 #define pfrkt_bytes	pfrkt_kts.pfrkts_bytes
869 #define pfrkt_match	pfrkt_kts.pfrkts_match
870 #define pfrkt_nomatch	pfrkt_kts.pfrkts_nomatch
871 #define pfrkt_tzero	pfrkt_kts.pfrkts_tzero
872 #endif
873 
874 #ifdef _KERNEL
875 struct pfi_kkif {
876 	char				 pfik_name[IFNAMSIZ];
877 	union {
878 		RB_ENTRY(pfi_kkif)	 _pfik_tree;
879 		LIST_ENTRY(pfi_kkif)	 _pfik_list;
880 	} _pfik_glue;
881 #define	pfik_tree	_pfik_glue._pfik_tree
882 #define	pfik_list	_pfik_glue._pfik_list
883 	counter_u64_t			 pfik_packets[2][2][2];
884 	counter_u64_t			 pfik_bytes[2][2][2];
885 	u_int32_t			 pfik_tzero;
886 	u_int				 pfik_flags;
887 	struct ifnet			*pfik_ifp;
888 	struct ifg_group		*pfik_group;
889 	u_int				 pfik_rulerefs;
890 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
891 };
892 #endif
893 
894 #define	PFI_IFLAG_REFS		0x0001	/* has state references */
895 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
896 
897 #ifdef _KERNEL
898 struct pf_pdesc {
899 	struct {
900 		int	 done;
901 		uid_t	 uid;
902 		gid_t	 gid;
903 	}		 lookup;
904 	u_int64_t	 tot_len;	/* Make Mickey money */
905 	union {
906 		struct tcphdr		*tcp;
907 		struct udphdr		*udp;
908 		struct icmp		*icmp;
909 #ifdef INET6
910 		struct icmp6_hdr	*icmp6;
911 #endif /* INET6 */
912 		void			*any;
913 	} hdr;
914 
915 	struct pf_krule	*nat_rule;	/* nat/rdr rule applied to packet */
916 	struct pf_addr	*src;		/* src address */
917 	struct pf_addr	*dst;		/* dst address */
918 	u_int16_t *sport;
919 	u_int16_t *dport;
920 	struct pf_mtag	*pf_mtag;
921 
922 	u_int32_t	 p_len;		/* total length of payload */
923 
924 	u_int16_t	*ip_sum;
925 	u_int16_t	*proto_sum;
926 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
927 					 * state code. Easier than tags */
928 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
929 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
930 	sa_family_t	 af;
931 	u_int8_t	 proto;
932 	u_int8_t	 tos;
933 	u_int8_t	 dir;		/* direction */
934 	u_int8_t	 sidx;		/* key index for source */
935 	u_int8_t	 didx;		/* key index for destination */
936 };
937 #endif
938 
939 /* flags for RDR options */
940 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
941 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
942 
943 /* UDP state enumeration */
944 #define PFUDPS_NO_TRAFFIC	0
945 #define PFUDPS_SINGLE		1
946 #define PFUDPS_MULTIPLE		2
947 
948 #define PFUDPS_NSTATES		3	/* number of state levels */
949 
950 #define PFUDPS_NAMES { \
951 	"NO_TRAFFIC", \
952 	"SINGLE", \
953 	"MULTIPLE", \
954 	NULL \
955 }
956 
957 /* Other protocol state enumeration */
958 #define PFOTHERS_NO_TRAFFIC	0
959 #define PFOTHERS_SINGLE		1
960 #define PFOTHERS_MULTIPLE	2
961 
962 #define PFOTHERS_NSTATES	3	/* number of state levels */
963 
964 #define PFOTHERS_NAMES { \
965 	"NO_TRAFFIC", \
966 	"SINGLE", \
967 	"MULTIPLE", \
968 	NULL \
969 }
970 
971 #define ACTION_SET(a, x) \
972 	do { \
973 		if ((a) != NULL) \
974 			*(a) = (x); \
975 	} while (0)
976 
977 #define REASON_SET(a, x) \
978 	do { \
979 		if ((a) != NULL) \
980 			*(a) = (x); \
981 		if (x < PFRES_MAX) \
982 			counter_u64_add(V_pf_status.counters[x], 1); \
983 	} while (0)
984 
985 struct pf_kstatus {
986 	counter_u64_t	counters[PFRES_MAX]; /* reason for passing/dropping */
987 	counter_u64_t	lcounters[LCNT_MAX]; /* limit counters */
988 	counter_u64_t	fcounters[FCNT_MAX]; /* state operation counters */
989 	counter_u64_t	scounters[SCNT_MAX]; /* src_node operation counters */
990 	uint32_t	states;
991 	uint32_t	src_nodes;
992 	uint32_t	running;
993 	uint32_t	since;
994 	uint32_t	debug;
995 	uint32_t	hostid;
996 	char		ifname[IFNAMSIZ];
997 	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
998 };
999 
1000 struct pf_divert {
1001 	union {
1002 		struct in_addr	ipv4;
1003 		struct in6_addr	ipv6;
1004 	}		addr;
1005 	u_int16_t	port;
1006 };
1007 
1008 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1009 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1010 
1011 /*
1012  * Limit the length of the fragment queue traversal.  Remember
1013  * search entry points based on the fragment offset.
1014  */
1015 #define PF_FRAG_ENTRY_POINTS		16
1016 
1017 /*
1018  * The number of entries in the fragment queue must be limited
1019  * to avoid DoS by linear seaching.  Instead of a global limit,
1020  * use a limit per entry point.  For large packets these sum up.
1021  */
1022 #define PF_FRAG_ENTRY_LIMIT		64
1023 
1024 /*
1025  * ioctl parameter structures
1026  */
1027 
1028 struct pfioc_pooladdr {
1029 	u_int32_t		 action;
1030 	u_int32_t		 ticket;
1031 	u_int32_t		 nr;
1032 	u_int32_t		 r_num;
1033 	u_int8_t		 r_action;
1034 	u_int8_t		 r_last;
1035 	u_int8_t		 af;
1036 	char			 anchor[MAXPATHLEN];
1037 	struct pf_pooladdr	 addr;
1038 };
1039 
1040 struct pfioc_rule {
1041 	u_int32_t	 action;
1042 	u_int32_t	 ticket;
1043 	u_int32_t	 pool_ticket;
1044 	u_int32_t	 nr;
1045 	char		 anchor[MAXPATHLEN];
1046 	char		 anchor_call[MAXPATHLEN];
1047 	struct pf_rule	 rule;
1048 };
1049 
1050 struct pfioc_natlook {
1051 	struct pf_addr	 saddr;
1052 	struct pf_addr	 daddr;
1053 	struct pf_addr	 rsaddr;
1054 	struct pf_addr	 rdaddr;
1055 	u_int16_t	 sport;
1056 	u_int16_t	 dport;
1057 	u_int16_t	 rsport;
1058 	u_int16_t	 rdport;
1059 	sa_family_t	 af;
1060 	u_int8_t	 proto;
1061 	u_int8_t	 direction;
1062 };
1063 
1064 struct pfioc_state {
1065 	struct pfsync_state	state;
1066 };
1067 
1068 struct pfioc_src_node_kill {
1069 	sa_family_t psnk_af;
1070 	struct pf_rule_addr psnk_src;
1071 	struct pf_rule_addr psnk_dst;
1072 	u_int		    psnk_killed;
1073 };
1074 
1075 struct pfioc_state_kill {
1076 	struct pf_state_cmp	psk_pfcmp;
1077 	sa_family_t		psk_af;
1078 	int			psk_proto;
1079 	struct pf_rule_addr	psk_src;
1080 	struct pf_rule_addr	psk_dst;
1081 	char			psk_ifname[IFNAMSIZ];
1082 	char			psk_label[PF_RULE_LABEL_SIZE];
1083 	u_int			psk_killed;
1084 };
1085 
1086 struct pfioc_states {
1087 	int	ps_len;
1088 	union {
1089 		caddr_t			 psu_buf;
1090 		struct pfsync_state	*psu_states;
1091 	} ps_u;
1092 #define ps_buf		ps_u.psu_buf
1093 #define ps_states	ps_u.psu_states
1094 };
1095 
1096 struct pfioc_src_nodes {
1097 	int	psn_len;
1098 	union {
1099 		caddr_t		 psu_buf;
1100 		struct pf_src_node	*psu_src_nodes;
1101 	} psn_u;
1102 #define psn_buf		psn_u.psu_buf
1103 #define psn_src_nodes	psn_u.psu_src_nodes
1104 };
1105 
1106 struct pfioc_if {
1107 	char		 ifname[IFNAMSIZ];
1108 };
1109 
1110 struct pfioc_tm {
1111 	int		 timeout;
1112 	int		 seconds;
1113 };
1114 
1115 struct pfioc_limit {
1116 	int		 index;
1117 	unsigned	 limit;
1118 };
1119 
1120 struct pfioc_altq_v0 {
1121 	u_int32_t	 action;
1122 	u_int32_t	 ticket;
1123 	u_int32_t	 nr;
1124 	struct pf_altq_v0 altq;
1125 };
1126 
1127 struct pfioc_altq_v1 {
1128 	u_int32_t	 action;
1129 	u_int32_t	 ticket;
1130 	u_int32_t	 nr;
1131 	/*
1132 	 * Placed here so code that only uses the above parameters can be
1133 	 * written entirely in terms of the v0 or v1 type.
1134 	 */
1135 	u_int32_t	 version;
1136 	struct pf_altq_v1 altq;
1137 };
1138 
1139 /*
1140  * Latest version of struct pfioc_altq_vX.  This must move in lock-step with
1141  * the latest version of struct pf_altq_vX as it has that struct as a
1142  * member.
1143  */
1144 #define PFIOC_ALTQ_VERSION	PF_ALTQ_VERSION
1145 
1146 struct pfioc_qstats_v0 {
1147 	u_int32_t	 ticket;
1148 	u_int32_t	 nr;
1149 	void		*buf;
1150 	int		 nbytes;
1151 	u_int8_t	 scheduler;
1152 };
1153 
1154 struct pfioc_qstats_v1 {
1155 	u_int32_t	 ticket;
1156 	u_int32_t	 nr;
1157 	void		*buf;
1158 	int		 nbytes;
1159 	u_int8_t	 scheduler;
1160 	/*
1161 	 * Placed here so code that only uses the above parameters can be
1162 	 * written entirely in terms of the v0 or v1 type.
1163 	 */
1164 	u_int32_t	 version;  /* Requested version of stats struct */
1165 };
1166 
1167 /* Latest version of struct pfioc_qstats_vX */
1168 #define PFIOC_QSTATS_VERSION	1
1169 
1170 struct pfioc_ruleset {
1171 	u_int32_t	 nr;
1172 	char		 path[MAXPATHLEN];
1173 	char		 name[PF_ANCHOR_NAME_SIZE];
1174 };
1175 
1176 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1177 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1178 struct pfioc_trans {
1179 	int		 size;	/* number of elements */
1180 	int		 esize; /* size of each element in bytes */
1181 	struct pfioc_trans_e {
1182 		int		rs_num;
1183 		char		anchor[MAXPATHLEN];
1184 		u_int32_t	ticket;
1185 	}		*array;
1186 };
1187 
1188 #define PFR_FLAG_ATOMIC		0x00000001	/* unused */
1189 #define PFR_FLAG_DUMMY		0x00000002
1190 #define PFR_FLAG_FEEDBACK	0x00000004
1191 #define PFR_FLAG_CLSTATS	0x00000008
1192 #define PFR_FLAG_ADDRSTOO	0x00000010
1193 #define PFR_FLAG_REPLACE	0x00000020
1194 #define PFR_FLAG_ALLRSETS	0x00000040
1195 #define PFR_FLAG_ALLMASK	0x0000007F
1196 #ifdef _KERNEL
1197 #define PFR_FLAG_USERIOCTL	0x10000000
1198 #endif
1199 
1200 struct pfioc_table {
1201 	struct pfr_table	 pfrio_table;
1202 	void			*pfrio_buffer;
1203 	int			 pfrio_esize;
1204 	int			 pfrio_size;
1205 	int			 pfrio_size2;
1206 	int			 pfrio_nadd;
1207 	int			 pfrio_ndel;
1208 	int			 pfrio_nchange;
1209 	int			 pfrio_flags;
1210 	u_int32_t		 pfrio_ticket;
1211 };
1212 #define	pfrio_exists	pfrio_nadd
1213 #define	pfrio_nzero	pfrio_nadd
1214 #define	pfrio_nmatch	pfrio_nadd
1215 #define pfrio_naddr	pfrio_size2
1216 #define pfrio_setflag	pfrio_size2
1217 #define pfrio_clrflag	pfrio_nadd
1218 
1219 struct pfioc_iface {
1220 	char	 pfiio_name[IFNAMSIZ];
1221 	void	*pfiio_buffer;
1222 	int	 pfiio_esize;
1223 	int	 pfiio_size;
1224 	int	 pfiio_nzero;
1225 	int	 pfiio_flags;
1226 };
1227 
1228 /*
1229  * ioctl operations
1230  */
1231 
1232 #define DIOCSTART	_IO  ('D',  1)
1233 #define DIOCSTOP	_IO  ('D',  2)
1234 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1235 #define DIOCADDRULENV	_IOWR('D',  4, struct pfioc_nv)
1236 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1237 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1238 #define DIOCGETRULENV	_IOWR('D',  7, struct pfioc_nv)
1239 /* XXX cut 8 - 17 */
1240 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1241 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1242 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1243 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1244 #define DIOCCLRSTATUS	_IO  ('D', 22)
1245 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1246 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1247 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1248 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1249 /* XXX cut 26 - 28 */
1250 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1251 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1252 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1253 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1254 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1255 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1256 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1257 #define DIOCSTARTALTQ	_IO  ('D', 42)
1258 #define DIOCSTOPALTQ	_IO  ('D', 43)
1259 #define DIOCADDALTQV0	_IOWR('D', 45, struct pfioc_altq_v0)
1260 #define DIOCADDALTQV1	_IOWR('D', 45, struct pfioc_altq_v1)
1261 #define DIOCGETALTQSV0	_IOWR('D', 47, struct pfioc_altq_v0)
1262 #define DIOCGETALTQSV1	_IOWR('D', 47, struct pfioc_altq_v1)
1263 #define DIOCGETALTQV0	_IOWR('D', 48, struct pfioc_altq_v0)
1264 #define DIOCGETALTQV1	_IOWR('D', 48, struct pfioc_altq_v1)
1265 #define DIOCCHANGEALTQV0 _IOWR('D', 49, struct pfioc_altq_v0)
1266 #define DIOCCHANGEALTQV1 _IOWR('D', 49, struct pfioc_altq_v1)
1267 #define DIOCGETQSTATSV0	_IOWR('D', 50, struct pfioc_qstats_v0)
1268 #define DIOCGETQSTATSV1	_IOWR('D', 50, struct pfioc_qstats_v1)
1269 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1270 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1271 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1272 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1273 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1274 /* XXX cut 55 - 57 */
1275 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1276 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1277 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1278 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1279 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1280 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1281 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1282 #define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
1283 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1284 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1285 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1286 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1287 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1288 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1289 #define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
1290 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1291 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1292 #define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1293 #define	DIOCOSFPFLUSH	_IO('D', 78)
1294 #define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1295 #define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1296 #define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
1297 #define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
1298 #define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
1299 #define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1300 #define	DIOCCLRSRCNODES	_IO('D', 85)
1301 #define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1302 #define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1303 #define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1304 #define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1305 #define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1306 struct pf_ifspeed_v0 {
1307 	char			ifname[IFNAMSIZ];
1308 	u_int32_t		baudrate;
1309 };
1310 
1311 struct pf_ifspeed_v1 {
1312 	char			ifname[IFNAMSIZ];
1313 	u_int32_t		baudrate32;
1314 	/* layout identical to struct pf_ifspeed_v0 up to this point */
1315 	u_int64_t		baudrate;
1316 };
1317 
1318 /* Latest version of struct pf_ifspeed_vX */
1319 #define PF_IFSPEED_VERSION	1
1320 
1321 #define	DIOCGIFSPEEDV0	_IOWR('D', 92, struct pf_ifspeed_v0)
1322 #define	DIOCGIFSPEEDV1	_IOWR('D', 92, struct pf_ifspeed_v1)
1323 
1324 /*
1325  * Compatibility and convenience macros
1326  */
1327 #ifndef _KERNEL
1328 #ifdef PFIOC_USE_LATEST
1329 /*
1330  * Maintaining in-tree consumers of the ioctl interface is easier when that
1331  * code can be written in terms old names that refer to the latest interface
1332  * version as that reduces the required changes in the consumers to those
1333  * that are functionally necessary to accommodate a new interface version.
1334  */
1335 #define	pfioc_altq	__CONCAT(pfioc_altq_v, PFIOC_ALTQ_VERSION)
1336 #define	pfioc_qstats	__CONCAT(pfioc_qstats_v, PFIOC_QSTATS_VERSION)
1337 #define	pf_ifspeed	__CONCAT(pf_ifspeed_v, PF_IFSPEED_VERSION)
1338 
1339 #define	DIOCADDALTQ	__CONCAT(DIOCADDALTQV, PFIOC_ALTQ_VERSION)
1340 #define	DIOCGETALTQS	__CONCAT(DIOCGETALTQSV, PFIOC_ALTQ_VERSION)
1341 #define	DIOCGETALTQ	__CONCAT(DIOCGETALTQV, PFIOC_ALTQ_VERSION)
1342 #define	DIOCCHANGEALTQ	__CONCAT(DIOCCHANGEALTQV, PFIOC_ALTQ_VERSION)
1343 #define	DIOCGETQSTATS	__CONCAT(DIOCGETQSTATSV, PFIOC_QSTATS_VERSION)
1344 #define	DIOCGIFSPEED	__CONCAT(DIOCGIFSPEEDV, PF_IFSPEED_VERSION)
1345 #else
1346 /*
1347  * When building out-of-tree code that is written for the old interface,
1348  * such as may exist in ports for example, resolve the old struct tags and
1349  * ioctl command names to the v0 versions.
1350  */
1351 #define	pfioc_altq	__CONCAT(pfioc_altq_v, 0)
1352 #define	pfioc_qstats	__CONCAT(pfioc_qstats_v, 0)
1353 #define	pf_ifspeed	__CONCAT(pf_ifspeed_v, 0)
1354 
1355 #define	DIOCADDALTQ	__CONCAT(DIOCADDALTQV, 0)
1356 #define	DIOCGETALTQS	__CONCAT(DIOCGETALTQSV, 0)
1357 #define	DIOCGETALTQ	__CONCAT(DIOCGETALTQV, 0)
1358 #define	DIOCCHANGEALTQ	__CONCAT(DIOCCHANGEALTQV, 0)
1359 #define	DIOCGETQSTATS	__CONCAT(DIOCGETQSTATSV, 0)
1360 #define	DIOCGIFSPEED	__CONCAT(DIOCGIFSPEEDV, 0)
1361 #endif /* PFIOC_USE_LATEST */
1362 #endif /* _KERNEL */
1363 
1364 #ifdef _KERNEL
1365 LIST_HEAD(pf_ksrc_node_list, pf_ksrc_node);
1366 struct pf_srchash {
1367 	struct pf_ksrc_node_list		nodes;
1368 	struct mtx			lock;
1369 };
1370 
1371 struct pf_keyhash {
1372 	LIST_HEAD(, pf_state_key)	keys;
1373 	struct mtx			lock;
1374 };
1375 
1376 struct pf_idhash {
1377 	LIST_HEAD(, pf_state)		states;
1378 	struct mtx			lock;
1379 };
1380 
1381 extern u_long		pf_hashmask;
1382 extern u_long		pf_srchashmask;
1383 #define	PF_HASHSIZ	(131072)
1384 #define	PF_SRCHASHSIZ	(PF_HASHSIZ/4)
1385 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1386 VNET_DECLARE(struct pf_idhash *, pf_idhash);
1387 #define V_pf_keyhash	VNET(pf_keyhash)
1388 #define	V_pf_idhash	VNET(pf_idhash)
1389 VNET_DECLARE(struct pf_srchash *, pf_srchash);
1390 #define	V_pf_srchash	VNET(pf_srchash)
1391 
1392 #define PF_IDHASH(s)	(be64toh((s)->id) % (pf_hashmask + 1))
1393 
1394 VNET_DECLARE(void *, pf_swi_cookie);
1395 #define V_pf_swi_cookie	VNET(pf_swi_cookie)
1396 VNET_DECLARE(struct intr_event *, pf_swi_ie);
1397 #define	V_pf_swi_ie	VNET(pf_swi_ie)
1398 
1399 VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1400 #define	V_pf_stateid	VNET(pf_stateid)
1401 
1402 TAILQ_HEAD(pf_altqqueue, pf_altq);
1403 VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[4]);
1404 #define	V_pf_altqs			 VNET(pf_altqs)
1405 VNET_DECLARE(struct pf_kpalist,		 pf_pabuf);
1406 #define	V_pf_pabuf			 VNET(pf_pabuf)
1407 
1408 VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
1409 #define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
1410 VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
1411 #define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
1412 VNET_DECLARE(int,			 altqs_inactive_open);
1413 #define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
1414 VNET_DECLARE(u_int32_t,			 ticket_pabuf);
1415 #define	V_ticket_pabuf			 VNET(ticket_pabuf)
1416 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
1417 #define	V_pf_altqs_active		 VNET(pf_altqs_active)
1418 VNET_DECLARE(struct pf_altqqueue *,	 pf_altq_ifs_active);
1419 #define	V_pf_altq_ifs_active		 VNET(pf_altq_ifs_active)
1420 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
1421 #define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
1422 VNET_DECLARE(struct pf_altqqueue *,	 pf_altq_ifs_inactive);
1423 #define	V_pf_altq_ifs_inactive		 VNET(pf_altq_ifs_inactive)
1424 
1425 VNET_DECLARE(struct pf_krulequeue, pf_unlinked_rules);
1426 #define	V_pf_unlinked_rules	VNET(pf_unlinked_rules)
1427 
1428 void				 pf_initialize(void);
1429 void				 pf_mtag_initialize(void);
1430 void				 pf_mtag_cleanup(void);
1431 void				 pf_cleanup(void);
1432 
1433 struct pf_mtag			*pf_get_mtag(struct mbuf *);
1434 
1435 extern void			 pf_calc_skip_steps(struct pf_krulequeue *);
1436 #ifdef ALTQ
1437 extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
1438 #endif
1439 VNET_DECLARE(uma_zone_t,	 pf_state_z);
1440 #define	V_pf_state_z		 VNET(pf_state_z)
1441 VNET_DECLARE(uma_zone_t,	 pf_state_key_z);
1442 #define	V_pf_state_key_z	 VNET(pf_state_key_z)
1443 VNET_DECLARE(uma_zone_t,	 pf_state_scrub_z);
1444 #define	V_pf_state_scrub_z	 VNET(pf_state_scrub_z)
1445 
1446 extern void			 pf_purge_thread(void *);
1447 extern void			 pf_unload_vnet_purge(void);
1448 extern void			 pf_intr(void *);
1449 extern void			 pf_purge_expired_src_nodes(void);
1450 
1451 extern int			 pf_unlink_state(struct pf_state *, u_int);
1452 #define	PF_ENTER_LOCKED		0x00000001
1453 #define	PF_RETURN_LOCKED	0x00000002
1454 extern int			 pf_state_insert(struct pfi_kkif *,
1455 				    struct pf_state_key *,
1456 				    struct pf_state_key *,
1457 				    struct pf_state *);
1458 extern void			 pf_free_state(struct pf_state *);
1459 
1460 static __inline void
1461 pf_ref_state(struct pf_state *s)
1462 {
1463 
1464 	refcount_acquire(&s->refs);
1465 }
1466 
1467 static __inline int
1468 pf_release_state(struct pf_state *s)
1469 {
1470 
1471 	if (refcount_release(&s->refs)) {
1472 		pf_free_state(s);
1473 		return (1);
1474 	} else
1475 		return (0);
1476 }
1477 
1478 extern struct pf_state		*pf_find_state_byid(uint64_t, uint32_t);
1479 extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1480 				    u_int, int *);
1481 extern struct pf_ksrc_node	*pf_find_src_node(struct pf_addr *,
1482 				    struct pf_krule *, sa_family_t, int);
1483 extern void			 pf_unlink_src_node(struct pf_ksrc_node *);
1484 extern u_int			 pf_free_src_nodes(struct pf_ksrc_node_list *);
1485 extern void			 pf_print_state(struct pf_state *);
1486 extern void			 pf_print_flags(u_int8_t);
1487 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1488 				    u_int8_t);
1489 extern u_int16_t		 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1490 				    u_int16_t, u_int16_t, u_int8_t);
1491 
1492 VNET_DECLARE(struct ifnet *,		 sync_ifp);
1493 #define	V_sync_ifp		 	 VNET(sync_ifp);
1494 VNET_DECLARE(struct pf_krule,		 pf_default_rule);
1495 #define	V_pf_default_rule		  VNET(pf_default_rule)
1496 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1497 				    u_int8_t);
1498 void				pf_free_rule(struct pf_krule *);
1499 
1500 #ifdef INET
1501 int	pf_test(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
1502 int	pf_normalize_ip(struct mbuf **, int, struct pfi_kkif *, u_short *,
1503 	    struct pf_pdesc *);
1504 #endif /* INET */
1505 
1506 #ifdef INET6
1507 int	pf_test6(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
1508 int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kkif *, u_short *,
1509 	    struct pf_pdesc *);
1510 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1511 	    struct pf_addr *, struct pf_addr *, u_int8_t);
1512 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1513 int	pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *);
1514 #endif /* INET6 */
1515 
1516 u_int32_t	pf_new_isn(struct pf_state *);
1517 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1518 	    sa_family_t);
1519 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1520 void	pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1521 	    u_int8_t);
1522 void	pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1523 void	pf_patch_16_unaligned(struct mbuf *, u_int16_t *, void *, u_int16_t,
1524 	    bool, u_int8_t);
1525 void	pf_patch_32_unaligned(struct mbuf *, u_int16_t *, void *, u_int32_t,
1526     bool, u_int8_t);
1527 void	pf_send_deferred_syn(struct pf_state *);
1528 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1529 	    struct pf_addr *, sa_family_t);
1530 int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1531 	    struct pf_addr *, sa_family_t);
1532 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1533 
1534 void	pf_normalize_init(void);
1535 void	pf_normalize_cleanup(void);
1536 int	pf_normalize_tcp(int, struct pfi_kkif *, struct mbuf *, int, int, void *,
1537 	    struct pf_pdesc *);
1538 void	pf_normalize_tcp_cleanup(struct pf_state *);
1539 int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1540 	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1541 int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1542 	    u_short *, struct tcphdr *, struct pf_state *,
1543 	    struct pf_state_peer *, struct pf_state_peer *, int *);
1544 u_int32_t
1545 	pf_state_expires(const struct pf_state *);
1546 void	pf_purge_expired_fragments(void);
1547 void	pf_purge_fragments(uint32_t);
1548 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kkif *,
1549 	    int);
1550 int	pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1551 struct pf_state_key *pf_alloc_state_key(int);
1552 void	pfr_initialize(void);
1553 void	pfr_cleanup(void);
1554 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1555 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1556 	    u_int64_t, int, int, int);
1557 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1558 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1559 struct pfr_ktable *
1560 	pfr_attach_table(struct pf_kruleset *, char *);
1561 void	pfr_detach_table(struct pfr_ktable *);
1562 int	pfr_clr_tables(struct pfr_table *, int *, int);
1563 int	pfr_add_tables(struct pfr_table *, int, int *, int);
1564 int	pfr_del_tables(struct pfr_table *, int, int *, int);
1565 int	pfr_table_count(struct pfr_table *, int);
1566 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1567 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1568 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1569 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1570 int	pfr_clr_addrs(struct pfr_table *, int *, int);
1571 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1572 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1573 	    int);
1574 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1575 	    int);
1576 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1577 	    int *, int *, int *, int, u_int32_t);
1578 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1579 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1580 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1581 	    int);
1582 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1583 	    int);
1584 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1585 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1586 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1587 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1588 	    int *, u_int32_t, int);
1589 
1590 MALLOC_DECLARE(PFI_MTYPE);
1591 VNET_DECLARE(struct pfi_kkif *,		 pfi_all);
1592 #define	V_pfi_all	 		 VNET(pfi_all)
1593 
1594 void		 pfi_initialize(void);
1595 void		 pfi_initialize_vnet(void);
1596 void		 pfi_cleanup(void);
1597 void		 pfi_cleanup_vnet(void);
1598 void		 pfi_kkif_ref(struct pfi_kkif *);
1599 void		 pfi_kkif_unref(struct pfi_kkif *);
1600 struct pfi_kkif	*pfi_kkif_find(const char *);
1601 struct pfi_kkif	*pfi_kkif_attach(struct pfi_kkif *, const char *);
1602 int		 pfi_kkif_match(struct pfi_kkif *, struct pfi_kkif *);
1603 void		 pfi_kkif_purge(void);
1604 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1605 		    sa_family_t);
1606 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1607 void		 pfi_dynaddr_remove(struct pfi_dynaddr *);
1608 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1609 void		 pfi_update_status(const char *, struct pf_status *);
1610 void		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1611 int		 pfi_set_flags(const char *, int);
1612 int		 pfi_clear_flags(const char *, int);
1613 
1614 int		 pf_match_tag(struct mbuf *, struct pf_krule *, int *, int);
1615 int		 pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1616 int		 pf_addr_cmp(struct pf_addr *, struct pf_addr *,
1617 		    sa_family_t);
1618 void		 pf_qid2qname(u_int32_t, char *);
1619 
1620 VNET_DECLARE(struct pf_kstatus, pf_status);
1621 #define	V_pf_status	VNET(pf_status)
1622 
1623 struct pf_limit {
1624 	uma_zone_t	zone;
1625 	u_int		limit;
1626 };
1627 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1628 #define	V_pf_limits VNET(pf_limits)
1629 
1630 #endif /* _KERNEL */
1631 
1632 #ifdef _KERNEL
1633 VNET_DECLARE(struct pf_kanchor_global,		 pf_anchors);
1634 #define	V_pf_anchors				 VNET(pf_anchors)
1635 VNET_DECLARE(struct pf_kanchor,			 pf_main_anchor);
1636 #define	V_pf_main_anchor			 VNET(pf_main_anchor)
1637 #define pf_main_ruleset	V_pf_main_anchor.ruleset
1638 
1639 void			 pf_init_kruleset(struct pf_kruleset *);
1640 int			 pf_kanchor_setup(struct pf_krule *,
1641 			    const struct pf_kruleset *, const char *);
1642 int			 pf_kanchor_nvcopyout(const struct pf_kruleset *,
1643 			    const struct pf_krule *, nvlist_t *);
1644 int			 pf_kanchor_copyout(const struct pf_kruleset *,
1645 			    const struct pf_krule *, struct pfioc_rule *);
1646 void			 pf_kanchor_remove(struct pf_krule *);
1647 void			 pf_remove_if_empty_kruleset(struct pf_kruleset *);
1648 struct pf_kruleset	*pf_find_kruleset(const char *);
1649 struct pf_kruleset	*pf_find_or_create_kruleset(const char *);
1650 void			 pf_rs_initialize(void);
1651 
1652 void			 pf_krule_free(struct pf_krule *);
1653 #endif
1654 
1655 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1656 int	pf_osfp_add(struct pf_osfp_ioctl *);
1657 #ifdef _KERNEL
1658 struct pf_osfp_enlist *
1659 	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1660 	    const struct tcphdr *);
1661 #endif /* _KERNEL */
1662 void	pf_osfp_flush(void);
1663 int	pf_osfp_get(struct pf_osfp_ioctl *);
1664 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1665 
1666 #ifdef _KERNEL
1667 void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1668 
1669 void			 pf_step_into_anchor(struct pf_kanchor_stackframe *, int *,
1670 			    struct pf_kruleset **, int, struct pf_krule **,
1671 			    struct pf_krule **, int *);
1672 int			 pf_step_out_of_anchor(struct pf_kanchor_stackframe *, int *,
1673 			    struct pf_kruleset **, int, struct pf_krule **,
1674 			    struct pf_krule **, int *);
1675 
1676 int			 pf_map_addr(u_int8_t, struct pf_krule *,
1677 			    struct pf_addr *, struct pf_addr *,
1678 			    struct pf_addr *, struct pf_ksrc_node **);
1679 struct pf_krule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
1680 			    int, int, struct pfi_kkif *, struct pf_ksrc_node **,
1681 			    struct pf_state_key **, struct pf_state_key **,
1682 			    struct pf_addr *, struct pf_addr *,
1683 			    uint16_t, uint16_t, struct pf_kanchor_stackframe *);
1684 
1685 struct pf_state_key	*pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1686 			    struct pf_addr *, u_int16_t, u_int16_t);
1687 struct pf_state_key	*pf_state_key_clone(struct pf_state_key *);
1688 
1689 struct pfi_kkif		*pf_kkif_create(int);
1690 void			 pf_kkif_free(struct pfi_kkif *);
1691 void			 pf_kkif_zero(struct pfi_kkif *);
1692 #endif /* _KERNEL */
1693 
1694 #endif /* _NET_PFVAR_H_ */
1695