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