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