xref: /freebsd/sys/net/pfvar.h (revision 796abca7e281f0d4b7f72f48da4f941e1c8b139c)
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  */
33 
34 #ifndef _NET_PFVAR_H_
35 #define _NET_PFVAR_H_
36 
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/counter.h>
40 #include <sys/cpuset.h>
41 #include <sys/epoch.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/smp.h>
48 #include <sys/lock.h>
49 #include <sys/rmlock.h>
50 #include <sys/tree.h>
51 #include <sys/seqc.h>
52 #include <vm/uma.h>
53 
54 #include <net/if.h>
55 #include <net/ethernet.h>
56 #include <net/radix.h>
57 #include <netinet/in.h>
58 #ifdef _KERNEL
59 #include <netinet/ip.h>
60 #include <netinet/tcp.h>
61 #include <netinet/udp.h>
62 #include <netinet/sctp.h>
63 #include <netinet/ip_icmp.h>
64 #include <netinet/icmp6.h>
65 #endif
66 
67 #include <netpfil/pf/pf.h>
68 #include <netpfil/pf/pf_altq.h>
69 #include <netpfil/pf/pf_mtag.h>
70 
71 #ifdef _KERNEL
72 
73 #define        PF_PFIL_NOREFRAGMENT    0x80000000
74 
75 #if defined(__arm__)
76 #define PF_WANT_32_TO_64_COUNTER
77 #endif
78 
79 /*
80  * A hybrid of 32-bit and 64-bit counters which can be used on platforms where
81  * counter(9) is very expensive.
82  *
83  * As 32-bit counters are expected to overflow, a periodic job sums them up to
84  * a saved 64-bit state. Fetching the value still walks all CPUs to get the most
85  * current snapshot.
86  */
87 #ifdef PF_WANT_32_TO_64_COUNTER
88 struct pf_counter_u64_pcpu {
89 	u_int32_t current;
90 	u_int32_t snapshot;
91 };
92 
93 struct pf_counter_u64 {
94 	struct pf_counter_u64_pcpu *pfcu64_pcpu;
95 	u_int64_t pfcu64_value;
96 	seqc_t	pfcu64_seqc;
97 };
98 
99 static inline int
100 pf_counter_u64_init(struct pf_counter_u64 *pfcu64, int flags)
101 {
102 
103 	pfcu64->pfcu64_value = 0;
104 	pfcu64->pfcu64_seqc = 0;
105 	pfcu64->pfcu64_pcpu = uma_zalloc_pcpu(pcpu_zone_8, flags | M_ZERO);
106 	if (__predict_false(pfcu64->pfcu64_pcpu == NULL))
107 		return (ENOMEM);
108 	return (0);
109 }
110 
111 static inline void
112 pf_counter_u64_deinit(struct pf_counter_u64 *pfcu64)
113 {
114 
115 	uma_zfree_pcpu(pcpu_zone_8, pfcu64->pfcu64_pcpu);
116 }
117 
118 static inline void
119 pf_counter_u64_critical_enter(void)
120 {
121 
122 	critical_enter();
123 }
124 
125 static inline void
126 pf_counter_u64_critical_exit(void)
127 {
128 
129 	critical_exit();
130 }
131 
132 static inline void
133 pf_counter_u64_rollup_protected(struct pf_counter_u64 *pfcu64, uint64_t n)
134 {
135 
136 	MPASS(curthread->td_critnest > 0);
137 	pfcu64->pfcu64_value += n;
138 }
139 
140 static inline void
141 pf_counter_u64_add_protected(struct pf_counter_u64 *pfcu64, uint32_t n)
142 {
143 	struct pf_counter_u64_pcpu *pcpu;
144 	u_int32_t val;
145 
146 	MPASS(curthread->td_critnest > 0);
147 	pcpu = zpcpu_get(pfcu64->pfcu64_pcpu);
148 	val = atomic_load_int(&pcpu->current);
149 	atomic_store_int(&pcpu->current, val + n);
150 }
151 
152 static inline void
153 pf_counter_u64_add(struct pf_counter_u64 *pfcu64, uint32_t n)
154 {
155 
156 	critical_enter();
157 	pf_counter_u64_add_protected(pfcu64, n);
158 	critical_exit();
159 }
160 
161 static inline u_int64_t
162 pf_counter_u64_periodic(struct pf_counter_u64 *pfcu64)
163 {
164 	struct pf_counter_u64_pcpu *pcpu;
165 	u_int64_t sum;
166 	u_int32_t val;
167 	int cpu;
168 
169 	MPASS(curthread->td_critnest > 0);
170 	seqc_write_begin(&pfcu64->pfcu64_seqc);
171 	sum = pfcu64->pfcu64_value;
172 	CPU_FOREACH(cpu) {
173 		pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
174 		val = atomic_load_int(&pcpu->current);
175 		sum += (uint32_t)(val - pcpu->snapshot);
176 		pcpu->snapshot = val;
177 	}
178 	pfcu64->pfcu64_value = sum;
179 	seqc_write_end(&pfcu64->pfcu64_seqc);
180 	return (sum);
181 }
182 
183 static inline u_int64_t
184 pf_counter_u64_fetch(const struct pf_counter_u64 *pfcu64)
185 {
186 	struct pf_counter_u64_pcpu *pcpu;
187 	u_int64_t sum;
188 	seqc_t seqc;
189 	int cpu;
190 
191 	for (;;) {
192 		seqc = seqc_read(&pfcu64->pfcu64_seqc);
193 		sum = 0;
194 		CPU_FOREACH(cpu) {
195 			pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
196 			sum += (uint32_t)(atomic_load_int(&pcpu->current) -pcpu->snapshot);
197 		}
198 		sum += pfcu64->pfcu64_value;
199 		if (seqc_consistent(&pfcu64->pfcu64_seqc, seqc))
200 			break;
201 	}
202 	return (sum);
203 }
204 
205 static inline void
206 pf_counter_u64_zero_protected(struct pf_counter_u64 *pfcu64)
207 {
208 	struct pf_counter_u64_pcpu *pcpu;
209 	int cpu;
210 
211 	MPASS(curthread->td_critnest > 0);
212 	seqc_write_begin(&pfcu64->pfcu64_seqc);
213 	CPU_FOREACH(cpu) {
214 		pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
215 		pcpu->snapshot = atomic_load_int(&pcpu->current);
216 	}
217 	pfcu64->pfcu64_value = 0;
218 	seqc_write_end(&pfcu64->pfcu64_seqc);
219 }
220 
221 static inline void
222 pf_counter_u64_zero(struct pf_counter_u64 *pfcu64)
223 {
224 
225 	critical_enter();
226 	pf_counter_u64_zero_protected(pfcu64);
227 	critical_exit();
228 }
229 #else
230 struct pf_counter_u64 {
231 	counter_u64_t counter;
232 };
233 
234 static inline int
235 pf_counter_u64_init(struct pf_counter_u64 *pfcu64, int flags)
236 {
237 
238 	pfcu64->counter = counter_u64_alloc(flags);
239 	if (__predict_false(pfcu64->counter == NULL))
240 		return (ENOMEM);
241 	return (0);
242 }
243 
244 static inline void
245 pf_counter_u64_deinit(struct pf_counter_u64 *pfcu64)
246 {
247 
248 	counter_u64_free(pfcu64->counter);
249 }
250 
251 static inline void
252 pf_counter_u64_critical_enter(void)
253 {
254 
255 }
256 
257 static inline void
258 pf_counter_u64_critical_exit(void)
259 {
260 
261 }
262 
263 static inline void
264 pf_counter_u64_rollup_protected(struct pf_counter_u64 *pfcu64, uint64_t n)
265 {
266 
267 	counter_u64_add(pfcu64->counter, n);
268 }
269 
270 static inline void
271 pf_counter_u64_add_protected(struct pf_counter_u64 *pfcu64, uint32_t n)
272 {
273 
274 	counter_u64_add(pfcu64->counter, n);
275 }
276 
277 static inline void
278 pf_counter_u64_add(struct pf_counter_u64 *pfcu64, uint32_t n)
279 {
280 
281 	pf_counter_u64_add_protected(pfcu64, n);
282 }
283 
284 static inline u_int64_t
285 pf_counter_u64_fetch(const struct pf_counter_u64 *pfcu64)
286 {
287 
288 	return (counter_u64_fetch(pfcu64->counter));
289 }
290 
291 static inline void
292 pf_counter_u64_zero_protected(struct pf_counter_u64 *pfcu64)
293 {
294 
295 	counter_u64_zero(pfcu64->counter);
296 }
297 
298 static inline void
299 pf_counter_u64_zero(struct pf_counter_u64 *pfcu64)
300 {
301 
302 	pf_counter_u64_zero_protected(pfcu64);
303 }
304 #endif
305 
306 #define pf_get_timestamp(prule)({					\
307 	uint32_t _ts = 0;						\
308 	uint32_t __ts;							\
309 	int cpu;							\
310 	CPU_FOREACH(cpu) {						\
311 		__ts = *zpcpu_get_cpu(prule->timestamp, cpu);		\
312 		if (__ts > _ts)						\
313 			_ts = __ts;					\
314 	}								\
315 	_ts;								\
316 })
317 
318 #define pf_update_timestamp(prule)					\
319 	do {								\
320 		critical_enter();					\
321 		*zpcpu_get((prule)->timestamp) = time_second;		\
322 		critical_exit();					\
323 	} while (0)
324 
325 #define pf_timestamp_pcpu_zone	(sizeof(time_t) == 4 ? pcpu_zone_4 : pcpu_zone_8)
326 _Static_assert(sizeof(time_t) == 4 || sizeof(time_t) == 8, "unexpected time_t size");
327 
328 SYSCTL_DECL(_net_pf);
329 MALLOC_DECLARE(M_PF);
330 MALLOC_DECLARE(M_PFHASH);
331 MALLOC_DECLARE(M_PF_RULE_ITEM);
332 
333 SDT_PROVIDER_DECLARE(pf);
334 SDT_PROBE_DECLARE(pf, , test, reason_set);
335 SDT_PROBE_DECLARE(pf, , log, log);
336 
337 #define DPFPRINTF(n, fmt, x...)				\
338 	do {						\
339 		SDT_PROBE2(pf, , log, log, (n), fmt);	\
340 		if (V_pf_status.debug >= (n))	 	\
341 			printf(fmt "\n", ##x); 		\
342 	} while (0)
343 
344 struct pfi_dynaddr {
345 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
346 	struct pf_addr			 pfid_addr4;
347 	struct pf_addr			 pfid_mask4;
348 	struct pf_addr			 pfid_addr6;
349 	struct pf_addr			 pfid_mask6;
350 	struct pfr_ktable		*pfid_kt;
351 	struct pfi_kkif			*pfid_kif;
352 	int				 pfid_net;	/* mask or 128 */
353 	int				 pfid_acnt4;	/* address count IPv4 */
354 	int				 pfid_acnt6;	/* address count IPv6 */
355 	sa_family_t			 pfid_af;	/* rule af */
356 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
357 };
358 
359 #define	PF_NAME		"pf"
360 
361 #define	PF_HASHROW_ASSERT(h)	mtx_assert(&(h)->lock, MA_OWNED)
362 #define	PF_HASHROW_LOCK(h)	mtx_lock(&(h)->lock)
363 #define	PF_HASHROW_UNLOCK(h)	mtx_unlock(&(h)->lock)
364 
365 #ifdef INVARIANTS
366 #define	PF_STATE_LOCK(s)						\
367 	do {								\
368 		struct pf_kstate *_s = (s);				\
369 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(_s)];	\
370 		MPASS(_s->lock == &_ih->lock);				\
371 		mtx_lock(_s->lock);					\
372 	} while (0)
373 #define	PF_STATE_UNLOCK(s)						\
374 	do {								\
375 		struct pf_kstate *_s = (s);				\
376 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(_s)];	\
377 		MPASS(_s->lock == &_ih->lock);				\
378 		mtx_unlock(_s->lock);					\
379 	} while (0)
380 #else
381 #define	PF_STATE_LOCK(s)	mtx_lock((s)->lock)
382 #define	PF_STATE_UNLOCK(s)	mtx_unlock((s)->lock)
383 #endif
384 
385 #ifdef INVARIANTS
386 #define	PF_STATE_LOCK_ASSERT(s)						\
387 	do {								\
388 		struct pf_kstate *_s = (s);				\
389 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(_s)];	\
390 		MPASS(_s->lock == &_ih->lock);				\
391 		PF_HASHROW_ASSERT(_ih);					\
392 	} while (0)
393 #else /* !INVARIANTS */
394 #define	PF_STATE_LOCK_ASSERT(s)		do {} while (0)
395 #endif /* INVARIANTS */
396 
397 #ifdef INVARIANTS
398 #define	PF_SRC_NODE_LOCK(sn)						\
399 	do {								\
400 		struct pf_ksrc_node *_sn = (sn);			\
401 		struct pf_srchash *_sh = &V_pf_srchash[			\
402 		    pf_hashsrc(&_sn->addr, _sn->af)];			\
403 		MPASS(_sn->lock == &_sh->lock);				\
404 		mtx_lock(_sn->lock);					\
405 	} while (0)
406 #define	PF_SRC_NODE_UNLOCK(sn)						\
407 	do {								\
408 		struct pf_ksrc_node *_sn = (sn);			\
409 		struct pf_srchash *_sh = &V_pf_srchash[			\
410 		    pf_hashsrc(&_sn->addr, _sn->af)];			\
411 		MPASS(_sn->lock == &_sh->lock);				\
412 		mtx_unlock(_sn->lock);					\
413 	} while (0)
414 #else
415 #define	PF_SRC_NODE_LOCK(sn)	mtx_lock((sn)->lock)
416 #define	PF_SRC_NODE_UNLOCK(sn)	mtx_unlock((sn)->lock)
417 #endif
418 
419 #ifdef INVARIANTS
420 #define	PF_SRC_NODE_LOCK_ASSERT(sn)					\
421 	do {								\
422 		struct pf_ksrc_node *_sn = (sn);			\
423 		struct pf_srchash *_sh = &V_pf_srchash[			\
424 		    pf_hashsrc(&_sn->addr, _sn->af)];			\
425 		MPASS(_sn->lock == &_sh->lock);				\
426 		PF_HASHROW_ASSERT(_sh);					\
427 	} while (0)
428 #else /* !INVARIANTS */
429 #define	PF_SRC_NODE_LOCK_ASSERT(sn)		do {} while (0)
430 #endif /* INVARIANTS */
431 
432 extern struct mtx_padalign pf_unlnkdrules_mtx;
433 #define	PF_UNLNKDRULES_LOCK()	mtx_lock(&pf_unlnkdrules_mtx)
434 #define	PF_UNLNKDRULES_UNLOCK()	mtx_unlock(&pf_unlnkdrules_mtx)
435 #define	PF_UNLNKDRULES_ASSERT()	mtx_assert(&pf_unlnkdrules_mtx, MA_OWNED)
436 
437 extern struct sx pf_config_lock;
438 #define	PF_CONFIG_LOCK()	sx_xlock(&pf_config_lock)
439 #define	PF_CONFIG_UNLOCK()	sx_xunlock(&pf_config_lock)
440 #define	PF_CONFIG_ASSERT()	sx_assert(&pf_config_lock, SA_XLOCKED)
441 
442 VNET_DECLARE(struct rmlock, pf_rules_lock);
443 #define	V_pf_rules_lock		VNET(pf_rules_lock)
444 
445 #define	PF_RULES_RLOCK_TRACKER	struct rm_priotracker _pf_rules_tracker
446 #define	PF_RULES_RLOCK()	rm_rlock(&V_pf_rules_lock, &_pf_rules_tracker)
447 #define	PF_RULES_RUNLOCK()	rm_runlock(&V_pf_rules_lock, &_pf_rules_tracker)
448 #define	PF_RULES_WLOCK()	rm_wlock(&V_pf_rules_lock)
449 #define	PF_RULES_WUNLOCK()	rm_wunlock(&V_pf_rules_lock)
450 #define	PF_RULES_WOWNED()	rm_wowned(&V_pf_rules_lock)
451 #define	PF_RULES_ASSERT()	rm_assert(&V_pf_rules_lock, RA_LOCKED)
452 #define	PF_RULES_RASSERT()	rm_assert(&V_pf_rules_lock, RA_RLOCKED)
453 #define	PF_RULES_WASSERT()	rm_assert(&V_pf_rules_lock, RA_WLOCKED)
454 
455 VNET_DECLARE(struct rmlock, pf_tags_lock);
456 #define	V_pf_tags_lock		VNET(pf_tags_lock)
457 
458 #define	PF_TAGS_RLOCK_TRACKER	struct rm_priotracker _pf_tags_tracker
459 #define	PF_TAGS_RLOCK()		rm_rlock(&V_pf_tags_lock, &_pf_tags_tracker)
460 #define	PF_TAGS_RUNLOCK()	rm_runlock(&V_pf_tags_lock, &_pf_tags_tracker)
461 #define	PF_TAGS_WLOCK()		rm_wlock(&V_pf_tags_lock)
462 #define	PF_TAGS_WUNLOCK()	rm_wunlock(&V_pf_tags_lock)
463 #define	PF_TAGS_WASSERT()	rm_assert(&V_pf_tags_lock, RA_WLOCKED)
464 
465 extern struct mtx_padalign pf_table_stats_lock;
466 #define	PF_TABLE_STATS_LOCK()	mtx_lock(&pf_table_stats_lock)
467 #define	PF_TABLE_STATS_UNLOCK()	mtx_unlock(&pf_table_stats_lock)
468 #define	PF_TABLE_STATS_OWNED()	mtx_owned(&pf_table_stats_lock)
469 #define	PF_TABLE_STATS_ASSERT()	mtx_assert(&pf_table_stats_lock, MA_OWNED)
470 
471 extern struct sx pf_end_lock;
472 
473 #define	PF_MODVER	1
474 #define	PFLOG_MODVER	1
475 #define	PFSYNC_MODVER	1
476 
477 #define	PFLOG_MINVER	1
478 #define	PFLOG_PREFVER	PFLOG_MODVER
479 #define	PFLOG_MAXVER	1
480 #define	PFSYNC_MINVER	1
481 #define	PFSYNC_PREFVER	PFSYNC_MODVER
482 #define	PFSYNC_MAXVER	1
483 
484 #ifdef INET
485 #ifndef INET6
486 #define	PF_INET_ONLY
487 #endif /* ! INET6 */
488 #endif /* INET */
489 
490 #ifdef INET6
491 #ifndef INET
492 #define	PF_INET6_ONLY
493 #endif /* ! INET */
494 #endif /* INET6 */
495 
496 #ifdef INET
497 #ifdef INET6
498 #define	PF_INET_INET6
499 #endif /* INET6 */
500 #endif /* INET */
501 
502 #else
503 
504 #define	PF_INET_INET6
505 
506 #endif /* _KERNEL */
507 
508 /* Both IPv4 and IPv6 */
509 #ifdef PF_INET_INET6
510 
511 #define PF_AEQ(a, b, c) \
512 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
513 	(c == AF_INET6 && (a)->addr32[3] == (b)->addr32[3] && \
514 	(a)->addr32[2] == (b)->addr32[2] && \
515 	(a)->addr32[1] == (b)->addr32[1] && \
516 	(a)->addr32[0] == (b)->addr32[0])) \
517 
518 #define PF_ANEQ(a, b, c) \
519 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
520 	(c == AF_INET6 && ((a)->addr32[0] != (b)->addr32[0] || \
521 	(a)->addr32[1] != (b)->addr32[1] || \
522 	(a)->addr32[2] != (b)->addr32[2] || \
523 	(a)->addr32[3] != (b)->addr32[3]))) \
524 
525 #define PF_AZERO(a, c) \
526 	((c == AF_INET && !(a)->addr32[0]) || \
527 	(c == AF_INET6 && !(a)->addr32[0] && !(a)->addr32[1] && \
528 	!(a)->addr32[2] && !(a)->addr32[3] )) \
529 
530 #else
531 
532 /* Just IPv6 */
533 
534 #ifdef PF_INET6_ONLY
535 
536 #define PF_AEQ(a, b, c) \
537 	((a)->addr32[3] == (b)->addr32[3] && \
538 	(a)->addr32[2] == (b)->addr32[2] && \
539 	(a)->addr32[1] == (b)->addr32[1] && \
540 	(a)->addr32[0] == (b)->addr32[0]) \
541 
542 #define PF_ANEQ(a, b, c) \
543 	((a)->addr32[3] != (b)->addr32[3] || \
544 	(a)->addr32[2] != (b)->addr32[2] || \
545 	(a)->addr32[1] != (b)->addr32[1] || \
546 	(a)->addr32[0] != (b)->addr32[0]) \
547 
548 #define PF_AZERO(a, c) \
549 	(!(a)->addr32[0] && \
550 	!(a)->addr32[1] && \
551 	!(a)->addr32[2] && \
552 	!(a)->addr32[3] ) \
553 
554 #else
555 
556 /* Just IPv4 */
557 #ifdef PF_INET_ONLY
558 
559 #define PF_AEQ(a, b, c) \
560 	((a)->addr32[0] == (b)->addr32[0])
561 
562 #define PF_ANEQ(a, b, c) \
563 	((a)->addr32[0] != (b)->addr32[0])
564 
565 #define PF_AZERO(a, c) \
566 	(!(a)->addr32[0])
567 
568 #endif /* PF_INET_ONLY */
569 #endif /* PF_INET6_ONLY */
570 #endif /* PF_INET_INET6 */
571 
572 #ifdef _KERNEL
573 
574 static inline __dead2 void
575 unhandled_af(int af)
576 {
577 	panic("unhandled af %d", af);
578 }
579 
580 static void inline
581 pf_addrcpy(struct pf_addr *dst, const struct pf_addr *src, sa_family_t af)
582 {
583 	switch (af) {
584 #ifdef INET
585 	case AF_INET:
586 		memcpy(&dst->v4, &src->v4, sizeof(dst->v4));
587 		break;
588 #endif /* INET */
589 #ifdef INET6
590 	case AF_INET6:
591 		memcpy(&dst->v6, &src->v6, sizeof(dst->v6));
592 		break;
593 #endif /* INET6 */
594 	default:
595 		unhandled_af(af);
596 	}
597 }
598 #endif
599 
600 /*
601  * XXX callers not FIB-aware in our version of pf yet.
602  * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
603  */
604 #define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
605 	(								\
606 		(((aw)->type == PF_ADDR_NOROUTE &&			\
607 		    pf_routable((x), (af), NULL, (rtid))) ||		\
608 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
609 		    pf_routable((x), (af), (ifp), (rtid))) ||		\
610 		((aw)->type == PF_ADDR_TABLE &&				\
611 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
612 		((aw)->type == PF_ADDR_DYNIFTL &&			\
613 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
614 		((aw)->type == PF_ADDR_RANGE &&				\
615 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
616 		    &(aw)->v.a.mask, (x), (af))) ||			\
617 		((aw)->type == PF_ADDR_ADDRMASK &&			\
618 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
619 		    !pf_match_addr(0, &(aw)->v.a.addr,			\
620 		    &(aw)->v.a.mask, (x), (af))))) !=			\
621 		(neg)							\
622 	)
623 
624 #define PF_ALGNMNT(off) (((off) % 2) == 0)
625 
626 /*
627  * At the moment there are no rules which have both NAT and RDR actions,
628  * apart from af-to rules, but those don't to source tracking for address
629  * translation. And the r->rdr pool is used for both NAT and RDR.
630  * So there is no PF_SN_RDR.
631  */
632 enum pf_sn_types { PF_SN_LIMIT, PF_SN_NAT, PF_SN_ROUTE, PF_SN_MAX };
633 typedef enum pf_sn_types pf_sn_types_t;
634 #define PF_SN_TYPE_NAMES { \
635 	"limit source-track", \
636 	"NAT/RDR sticky-address", \
637 	"route sticky-address", \
638 	NULL \
639 }
640 
641 #ifdef _KERNEL
642 
643 struct pf_kpooladdr {
644 	struct pf_addr_wrap		 addr;
645 	TAILQ_ENTRY(pf_kpooladdr)	 entries;
646 	char				 ifname[IFNAMSIZ];
647 	sa_family_t		 	 af;
648 	struct pfi_kkif			*kif;
649 };
650 
651 TAILQ_HEAD(pf_kpalist, pf_kpooladdr);
652 
653 struct pf_kpool {
654 	struct mtx		 mtx;
655 	struct pf_kpalist	 list;
656 	struct pf_kpooladdr	*cur;
657 	struct pf_poolhashkey	 key;
658 	struct pf_addr		 counter;
659 	struct pf_mape_portset	 mape;
660 	int			 tblidx;
661 	u_int16_t		 proxy_port[2];
662 	u_int8_t		 opts;
663 	sa_family_t		 ipv6_nexthop_af;
664 };
665 
666 struct pf_rule_actions {
667 	struct pf_addr	 rt_addr;
668 	struct pfi_kkif	*rt_kif;
669 	int32_t		 rtableid;
670 	uint32_t	 flags;
671 	uint16_t	 qid;
672 	uint16_t	 pqid;
673 	uint16_t	 max_mss;
674 	uint16_t	 dnpipe;
675 	uint16_t	 dnrpipe;	/* Reverse direction pipe */
676 	sa_family_t	 rt_af;
677 	uint8_t		 log;
678 	uint8_t		 set_tos;
679 	uint8_t		 min_ttl;
680 	uint8_t		 set_prio[2];
681 	uint8_t		 rt;
682 	uint8_t		 allow_opts;
683 	uint16_t	 max_pkt_size;
684 };
685 
686 union pf_keth_rule_ptr {
687 	struct pf_keth_rule	*ptr;
688 	uint32_t		nr;
689 };
690 
691 struct pf_keth_rule_addr {
692 	uint8_t	addr[ETHER_ADDR_LEN];
693 	uint8_t	mask[ETHER_ADDR_LEN];
694 	bool neg;
695 	uint8_t	isset;
696 };
697 
698 struct pf_keth_anchor;
699 
700 TAILQ_HEAD(pf_keth_ruleq, pf_keth_rule);
701 
702 struct pf_keth_ruleset {
703 	struct pf_keth_ruleq		 rules[2];
704 	struct pf_keth_rules {
705 		struct pf_keth_ruleq	*rules;
706 		int			 open;
707 		uint32_t		 ticket;
708 	} active, inactive;
709 	struct vnet		*vnet;
710 	struct pf_keth_anchor	*anchor;
711 };
712 
713 RB_HEAD(pf_keth_anchor_global, pf_keth_anchor);
714 RB_HEAD(pf_keth_anchor_node, pf_keth_anchor);
715 struct pf_keth_anchor {
716 	RB_ENTRY(pf_keth_anchor)	 entry_node;
717 	RB_ENTRY(pf_keth_anchor)	 entry_global;
718 	struct pf_keth_anchor		*parent;
719 	struct pf_keth_anchor_node	 children;
720 	char				 name[PF_ANCHOR_NAME_SIZE];
721 	char				 path[MAXPATHLEN];
722 	struct pf_keth_ruleset		 ruleset;
723 	int				 refcnt;	/* anchor rules */
724 	uint8_t				 anchor_relative;
725 	uint8_t				 anchor_wildcard;
726 };
727 RB_PROTOTYPE(pf_keth_anchor_node, pf_keth_anchor, entry_node,
728     pf_keth_anchor_compare);
729 RB_PROTOTYPE(pf_keth_anchor_global, pf_keth_anchor, entry_global,
730     pf_keth_anchor_compare);
731 
732 struct pf_keth_rule {
733 #define PFE_SKIP_IFP		0
734 #define PFE_SKIP_DIR		1
735 #define PFE_SKIP_PROTO		2
736 #define PFE_SKIP_SRC_ADDR	3
737 #define PFE_SKIP_DST_ADDR	4
738 #define PFE_SKIP_SRC_IP_ADDR	5
739 #define PFE_SKIP_DST_IP_ADDR	6
740 #define PFE_SKIP_COUNT		7
741 	union pf_keth_rule_ptr	 skip[PFE_SKIP_COUNT];
742 
743 	TAILQ_ENTRY(pf_keth_rule)	entries;
744 
745 	struct pf_keth_anchor	*anchor;
746 	u_int8_t		 anchor_relative;
747 	u_int8_t		 anchor_wildcard;
748 
749 	uint32_t		 nr;
750 
751 	bool			 quick;
752 
753 	/* Filter */
754 	char			 ifname[IFNAMSIZ];
755 	struct pfi_kkif		*kif;
756 	bool			 ifnot;
757 	uint8_t			 direction;
758 	uint16_t		 proto;
759 	struct pf_keth_rule_addr src, dst;
760 	struct pf_rule_addr	 ipsrc, ipdst;
761 	char			 match_tagname[PF_TAG_NAME_SIZE];
762 	uint16_t		 match_tag;
763 	bool			 match_tag_not;
764 
765 
766 	/* Stats */
767 	counter_u64_t		 evaluations;
768 	counter_u64_t		 packets[2];
769 	counter_u64_t		 bytes[2];
770 	time_t			*timestamp;
771 
772 	/* Action */
773 	char			 qname[PF_QNAME_SIZE];
774 	int			 qid;
775 	char			 tagname[PF_TAG_NAME_SIZE];
776 	uint16_t		 tag;
777 	char			 bridge_to_name[IFNAMSIZ];
778 	struct pfi_kkif		*bridge_to;
779 	uint8_t			 action;
780 	uint16_t		 dnpipe;
781 	uint32_t		 dnflags;
782 
783 	char			label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
784 	uint32_t		ridentifier;
785 };
786 
787 struct pf_kthreshold {
788 	uint32_t		 limit;
789 	uint32_t		 seconds;
790 	struct counter_rate	*cr;
791 };
792 
793 RB_HEAD(pf_krule_global, pf_krule);
794 RB_PROTOTYPE(pf_krule_global, pf_krule, entry_global, pf_krule_compare);
795 
796 struct pf_krule {
797 	struct pf_rule_addr	 src;
798 	struct pf_rule_addr	 dst;
799 	struct pf_krule		*skip[PF_SKIP_COUNT];
800 	char			 label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
801 	uint32_t		 ridentifier;
802 	char			 ifname[IFNAMSIZ];
803 	char			 rcv_ifname[IFNAMSIZ];
804 	char			 qname[PF_QNAME_SIZE];
805 	char			 pqname[PF_QNAME_SIZE];
806 	char			 tagname[PF_TAG_NAME_SIZE];
807 	char			 match_tagname[PF_TAG_NAME_SIZE];
808 
809 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
810 
811 	TAILQ_ENTRY(pf_krule)	 entries;
812 	struct pf_kpool		 nat;
813 	struct pf_kpool		 rdr;
814 	struct pf_kpool		 route;
815 	struct pf_kthreshold	 pktrate;
816 
817 	struct pf_counter_u64	 evaluations;
818 	struct pf_counter_u64	 packets[2];
819 	struct pf_counter_u64	 bytes[2];
820 	time_t			*timestamp;
821 
822 	struct pfi_kkif		*kif;
823 	struct pfi_kkif		*rcv_kif;
824 	struct pf_kanchor	*anchor;
825 	struct pfr_ktable	*overload_tbl;
826 
827 	pf_osfp_t		 os_fingerprint;
828 
829 	int32_t			 rtableid;
830 	u_int32_t		 timeout[PFTM_MAX];
831 	u_int32_t		 max_states;
832 	u_int32_t		 max_src_nodes;
833 	u_int32_t		 max_src_states;
834 	u_int32_t		 max_src_conn;
835 	struct {
836 		u_int32_t		limit;
837 		u_int32_t		seconds;
838 	}			 max_src_conn_rate;
839 	uint16_t		 max_pkt_size;
840 	u_int16_t		 qid;
841 	u_int16_t		 pqid;
842 	u_int16_t		 dnpipe;
843 	u_int16_t		 dnrpipe;
844 	u_int32_t		 free_flags;
845 	u_int32_t		 nr;
846 	u_int32_t		 prob;
847 	uid_t			 cuid;
848 	pid_t			 cpid;
849 
850 	counter_u64_t		 states_cur;
851 	counter_u64_t		 states_tot;
852 	counter_u64_t		 src_nodes[PF_SN_MAX];
853 
854 	u_int16_t		 return_icmp;
855 	u_int16_t		 return_icmp6;
856 	u_int16_t		 max_mss;
857 	u_int16_t		 tag;
858 	u_int16_t		 match_tag;
859 	u_int16_t		 scrub_flags;
860 
861 	struct pf_rule_uid	 uid;
862 	struct pf_rule_gid	 gid;
863 
864 	u_int32_t		 rule_flag;
865 	uint32_t		 rule_ref;
866 	u_int8_t		 action;
867 	u_int8_t		 direction;
868 	u_int8_t		 log;
869 	u_int8_t		 logif;
870 	u_int8_t		 quick;
871 	u_int8_t		 ifnot;
872 	u_int8_t		 match_tag_not;
873 	u_int8_t		 natpass;
874 
875 	u_int8_t		 keep_state;
876 	sa_family_t		 af;
877 	u_int8_t		 proto;
878 	uint16_t		 type;
879 	uint16_t		 code;
880 	u_int8_t		 flags;
881 	u_int8_t		 flagset;
882 	u_int8_t		 min_ttl;
883 	u_int8_t		 allow_opts;
884 	u_int8_t		 rt;
885 	u_int8_t		 return_ttl;
886 	u_int8_t		 tos;
887 	u_int8_t		 set_tos;
888 	u_int8_t		 anchor_relative;
889 	u_int8_t		 anchor_wildcard;
890 
891 	u_int8_t		 flush;
892 	u_int8_t		 prio;
893 	u_int8_t		 set_prio[2];
894 	sa_family_t		 naf;
895 	u_int8_t		 rcvifnot;
896 
897 	struct {
898 		struct pf_addr		addr;
899 		u_int16_t		port;
900 	}			divert;
901 	u_int8_t		 md5sum[PF_MD5_DIGEST_LENGTH];
902 	RB_ENTRY(pf_krule)	 entry_global;
903 
904 #ifdef PF_WANT_32_TO_64_COUNTER
905 	LIST_ENTRY(pf_krule)	 allrulelist;
906 	bool			 allrulelinked;
907 #endif
908 	time_t			 exptime;
909 };
910 
911 struct pf_krule_item {
912 	SLIST_ENTRY(pf_krule_item)	 entry;
913 	struct pf_krule			*r;
914 };
915 
916 SLIST_HEAD(pf_krule_slist, pf_krule_item);
917 
918 struct pf_ksrc_node {
919 	LIST_ENTRY(pf_ksrc_node) entry;
920 	struct pf_addr		 addr;
921 	struct pf_addr		 raddr;
922 	struct pf_krule_slist	 match_rules;
923 	struct pf_krule		*rule;
924 	struct pfi_kkif		*rkif;
925 	counter_u64_t		 bytes[2];
926 	counter_u64_t		 packets[2];
927 	u_int32_t		 states;
928 	u_int32_t		 conn;
929 	struct pf_kthreshold	 conn_rate;
930 	u_int32_t		 creation;
931 	u_int32_t		 expire;
932 	sa_family_t		 af;
933 	sa_family_t		 raf;
934 	u_int8_t		 ruletype;
935 	pf_sn_types_t		 type;
936 	struct mtx		*lock;
937 };
938 #endif
939 
940 struct pf_state_scrub {
941 	struct timeval	pfss_last;	/* time received last packet	*/
942 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
943 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
944 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
945 	u_int16_t	pfss_flags;
946 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
947 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
948 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
949 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
950 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
951 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
952 	u_int8_t	pad;
953 	union {
954 		u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
955 		u_int32_t	pfss_v_tag;	/* SCTP verification tag	*/
956 	};
957 };
958 
959 struct pf_state_host {
960 	struct pf_addr	addr;
961 	u_int16_t	port;
962 	u_int16_t	pad;
963 };
964 
965 struct pf_state_peer {
966 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
967 	u_int32_t	seqlo;		/* Max sequence number sent	*/
968 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
969 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
970 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
971 	u_int16_t	mss;		/* Maximum segment size option	*/
972 	u_int8_t	state;		/* active state level		*/
973 	u_int8_t	wscale;		/* window scaling factor	*/
974 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
975 	u_int8_t	pad[1];
976 };
977 
978 /* Keep synced with struct pf_udp_endpoint. */
979 struct pf_udp_endpoint_cmp {
980 	struct pf_addr	addr;
981 	uint16_t	port;
982 	sa_family_t	af;
983 	uint8_t		pad[1];
984 };
985 
986 struct pf_udp_endpoint {
987 	struct pf_addr	addr;
988 	uint16_t	port;
989 	sa_family_t	af;
990 	uint8_t		pad[1];
991 
992 	struct pf_udp_mapping *mapping;
993 	LIST_ENTRY(pf_udp_endpoint) entry;
994 };
995 
996 struct pf_udp_mapping {
997 	struct pf_udp_endpoint endpoints[2];
998 	u_int refs;
999 };
1000 
1001 /* Keep synced with struct pf_state_key. */
1002 struct pf_state_key_cmp {
1003 	struct pf_addr	 addr[2];
1004 	u_int16_t	 port[2];
1005 	sa_family_t	 af;
1006 	u_int8_t	 proto;
1007 	u_int8_t	 pad[2];
1008 };
1009 
1010 struct pf_state_key {
1011 	struct pf_addr	 addr[2];
1012 	u_int16_t	 port[2];
1013 	sa_family_t	 af;
1014 	u_int8_t	 proto;
1015 	u_int8_t	 pad[2];
1016 
1017 	LIST_ENTRY(pf_state_key) entry;
1018 	TAILQ_HEAD(, pf_kstate)	 states[2];
1019 };
1020 
1021 #define PF_REVERSED_KEY(state, family)					\
1022 	(((state)->key[PF_SK_WIRE]->af != (state)->key[PF_SK_STACK]->af) &&	\
1023 	    ((state)->key[PF_SK_WIRE]->af != (family)) &&			\
1024 	    ((state)->direction == PF_IN))
1025 
1026 /* Keep synced with struct pf_kstate. */
1027 struct pf_state_cmp {
1028 	u_int64_t		 id;
1029 	u_int32_t		 creatorid;
1030 	u_int8_t		 direction;
1031 	u_int8_t		 pad[3];
1032 };
1033 
1034 struct pf_state_scrub_export {
1035 	uint16_t	pfss_flags;
1036 	uint8_t		pfss_ttl;	/* stashed TTL		*/
1037 #define PF_SCRUB_FLAG_VALID		0x01
1038 	uint8_t		scrub_flag;
1039 	uint32_t	pfss_ts_mod;	/* timestamp modulation	*/
1040 } __packed;
1041 
1042 struct pf_state_key_export {
1043 	struct pf_addr	 addr[2];
1044 	uint16_t	 port[2];
1045 };
1046 
1047 struct pf_state_peer_export {
1048 	struct pf_state_scrub_export	scrub;	/* state is scrubbed	*/
1049 	uint32_t	seqlo;		/* Max sequence number sent	*/
1050 	uint32_t	seqhi;		/* Max the other end ACKd + win	*/
1051 	uint32_t	seqdiff;	/* Sequence number modulator	*/
1052 	uint16_t	max_win;	/* largest window (pre scaling)	*/
1053 	uint16_t	mss;		/* Maximum segment size option	*/
1054 	uint8_t		state;		/* active state level		*/
1055 	uint8_t		wscale;		/* window scaling factor	*/
1056 	uint8_t		dummy[6];
1057 } __packed;
1058 _Static_assert(sizeof(struct pf_state_peer_export) == 32, "size incorrect");
1059 
1060 struct pf_state_export {
1061 	uint64_t	 version;
1062 #define	PF_STATE_VERSION	20230404
1063 	uint64_t	 id;
1064 	char		 ifname[IFNAMSIZ];
1065 	char		 orig_ifname[IFNAMSIZ];
1066 	struct pf_state_key_export	 key[2];
1067 	struct pf_state_peer_export	 src;
1068 	struct pf_state_peer_export	 dst;
1069 	struct pf_addr	 rt_addr;
1070 	uint32_t	 rule;
1071 	uint32_t	 anchor;
1072 	uint32_t	 nat_rule;
1073 	uint32_t	 creation;
1074 	uint32_t	 expire;
1075 	uint32_t	 spare0;
1076 	uint64_t	 packets[2];
1077 	uint64_t	 bytes[2];
1078 	uint32_t	 creatorid;
1079 	uint32_t	 spare1;
1080 	sa_family_t	 af;
1081 	uint8_t		 proto;
1082 	uint8_t		 direction;
1083 	uint8_t		 log;
1084 	uint8_t		 state_flags_compat;
1085 	uint8_t		 timeout;
1086 	uint8_t		 sync_flags;
1087 	uint8_t		 updates;
1088 	uint16_t	 state_flags;
1089 	uint16_t	 qid;
1090 	uint16_t	 pqid;
1091 	uint16_t	 dnpipe;
1092 	uint16_t	 dnrpipe;
1093 	int32_t		 rtableid;
1094 	uint8_t		 min_ttl;
1095 	uint8_t		 set_tos;
1096 	uint16_t	 max_mss;
1097 	uint8_t		 set_prio[2];
1098 	uint8_t		 rt;
1099 	char		 rt_ifname[IFNAMSIZ];
1100 
1101 	uint8_t		 spare[72];
1102 };
1103 _Static_assert(sizeof(struct pf_state_export) == 384, "size incorrect");
1104 
1105 #ifdef _KERNEL
1106 struct pf_kstate {
1107 	/*
1108 	 * Area shared with pf_state_cmp
1109 	 */
1110 	u_int64_t		 id;
1111 	u_int32_t		 creatorid;
1112 	u_int8_t		 direction;
1113 	u_int8_t		 pad[3];
1114 	/*
1115 	 * end of the area
1116 	 */
1117 
1118 	u_int16_t		 state_flags;
1119 	u_int8_t		 timeout;
1120 	u_int8_t		 sync_state; /* PFSYNC_S_x */
1121 	u_int8_t		 sync_updates;
1122 	u_int			 refs;
1123 	struct mtx		*lock;
1124 	TAILQ_ENTRY(pf_kstate)	 sync_list;
1125 	TAILQ_ENTRY(pf_kstate)	 key_list[2];
1126 	LIST_ENTRY(pf_kstate)	 entry;
1127 	struct pf_state_peer	 src;
1128 	struct pf_state_peer	 dst;
1129 	struct pf_krule_slist	 match_rules;
1130 	struct pf_krule		*rule;
1131 	struct pf_krule		*anchor;
1132 	struct pf_krule		*nat_rule;
1133 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
1134 	struct pf_udp_mapping	*udp_mapping;
1135 	struct pfi_kkif		*kif;
1136 	struct pfi_kkif		*orig_kif;	/* The real kif, even if we're a floating state (i.e. if == V_pfi_all). */
1137 	struct pf_ksrc_node	*sns[PF_SN_MAX];/* source nodes */
1138 	u_int64_t		 packets[2];
1139 	u_int64_t		 bytes[2];
1140 	u_int64_t		 creation;
1141 	u_int64_t	 	 expire;
1142 	u_int32_t		 pfsync_time;
1143 	struct pf_rule_actions	 act;
1144 	u_int16_t		 tag;
1145 	u_int16_t		 if_index_in;
1146 	u_int16_t		 if_index_out;
1147 };
1148 
1149 /*
1150  * 6 cache lines per struct, 10 structs per page.
1151  * Try to not grow the struct beyond that.
1152  */
1153 _Static_assert(sizeof(struct pf_kstate) <= 384, "pf_kstate size crosses 384 bytes");
1154 
1155 enum pf_test_status {
1156 	PF_TEST_FAIL = -1,
1157 	PF_TEST_OK,
1158 	PF_TEST_QUICK
1159 };
1160 
1161 struct pf_test_ctx {
1162 	enum pf_test_status	 test_status;
1163 	struct pf_pdesc		*pd;
1164 	struct pf_rule_actions	 act;
1165 	uint8_t			 icmpcode;
1166 	uint8_t			 icmptype;
1167 	int			 icmp_dir;
1168 	int			 state_icmp;
1169 	int			 tag;
1170 	int			 rewrite;
1171 	u_short			 reason;
1172 	struct pf_src_node	*sns[PF_SN_MAX];
1173 	struct pf_krule		*nr;
1174 	struct pf_krule		*tr;
1175 	struct pf_krule		**rm;
1176 	struct pf_krule		*a;
1177 	struct pf_krule		**am;
1178 	struct pf_kruleset	**rsm;
1179 	struct pf_kruleset	*arsm;
1180 	struct pf_kruleset	*aruleset;
1181 	struct pf_state_key	*sk;
1182 	struct pf_state_key	*nk;
1183 	struct tcphdr		*th;
1184 	struct pf_udp_mapping	*udp_mapping;
1185 	struct pf_kpool		*nat_pool;
1186 	uint16_t		 virtual_type;
1187 	uint16_t		 virtual_id;
1188 	int			 depth;
1189 };
1190 
1191 #define	PF_ANCHOR_STACK_MAX	32
1192 #endif
1193 
1194 /*
1195  * Unified state structures for pulling states out of the kernel
1196  * used by pfsync(4) and the pf(4) ioctl.
1197  */
1198 struct pfsync_state_key {
1199 	struct pf_addr	 addr[2];
1200 	u_int16_t	 port[2];
1201 };
1202 
1203 struct pfsync_state_1301 {
1204 	u_int64_t	 id;
1205 	char		 ifname[IFNAMSIZ];
1206 	struct pfsync_state_key	key[2];
1207 	struct pf_state_peer_export src;
1208 	struct pf_state_peer_export dst;
1209 	struct pf_addr	 rt_addr;
1210 	u_int32_t	 rule;
1211 	u_int32_t	 anchor;
1212 	u_int32_t	 nat_rule;
1213 	u_int32_t	 creation;
1214 	u_int32_t	 expire;
1215 	u_int32_t	 packets[2][2];
1216 	u_int32_t	 bytes[2][2];
1217 	u_int32_t	 creatorid;
1218 	sa_family_t	 af;
1219 	u_int8_t	 proto;
1220 	u_int8_t	 direction;
1221 	u_int8_t	 __spare[2];
1222 	u_int8_t	 log;
1223 	u_int8_t	 state_flags;
1224 	u_int8_t	 timeout;
1225 	u_int8_t	 sync_flags;
1226 	u_int8_t	 updates;	/* unused */
1227 } __packed;
1228 
1229 struct pfsync_state_1400 {
1230 	/* The beginning of the struct is compatible with pfsync_state_1301 */
1231 	u_int64_t	 id;
1232 	char		 ifname[IFNAMSIZ];
1233 	struct pfsync_state_key	key[2];
1234 	struct pf_state_peer_export src;
1235 	struct pf_state_peer_export dst;
1236 	struct pf_addr	 rt_addr;
1237 	u_int32_t	 rule;
1238 	u_int32_t	 anchor;
1239 	u_int32_t	 nat_rule;
1240 	u_int32_t	 creation;
1241 	u_int32_t	 expire;
1242 	u_int32_t	 packets[2][2];
1243 	u_int32_t	 bytes[2][2];
1244 	u_int32_t	 creatorid;
1245 	sa_family_t	 af;
1246 	u_int8_t	 proto;
1247 	u_int8_t	 direction;
1248 	u_int16_t	 state_flags;
1249 	u_int8_t	 log;
1250 	u_int8_t	 __spare;
1251 	u_int8_t	 timeout;
1252 	u_int8_t	 sync_flags;
1253 	u_int8_t	 updates;	/* unused */
1254 	/* The rest is not */
1255 	u_int16_t	 qid;
1256 	u_int16_t	 pqid;
1257 	u_int16_t	 dnpipe;
1258 	u_int16_t	 dnrpipe;
1259 	int32_t		 rtableid;
1260 	u_int8_t	 min_ttl;
1261 	u_int8_t	 set_tos;
1262 	u_int16_t	 max_mss;
1263 	u_int8_t	 set_prio[2];
1264 	u_int8_t	 rt;
1265 	char		 rt_ifname[IFNAMSIZ];
1266 } __packed;
1267 
1268 struct pfsync_state_1500 {
1269 	/* The beginning of the struct is compatible with pfsync_state_1301 */
1270 	u_int64_t	 id;
1271 	char		 ifname[IFNAMSIZ];
1272 	struct pfsync_state_key	key[2];
1273 	struct pf_state_peer_export src;
1274 	struct pf_state_peer_export dst;
1275 	struct pf_addr	 rt_addr;
1276 	u_int32_t	 rule;
1277 	u_int32_t	 anchor;
1278 	u_int32_t	 nat_rule;
1279 	u_int32_t	 creation;
1280 	u_int32_t	 expire;
1281 	u_int32_t	 packets[2][2];
1282 	u_int32_t	 bytes[2][2];
1283 	u_int32_t	 creatorid;
1284 	/* The rest is not, use the opportunity to fix alignment */
1285 	char		 tagname[PF_TAG_NAME_SIZE];
1286 	char		 rt_ifname[IFNAMSIZ];
1287 	char		 orig_ifname[IFNAMSIZ];
1288 	int32_t		 rtableid;
1289 	u_int16_t	 state_flags;
1290 	u_int16_t	 qid;
1291 	u_int16_t	 pqid;
1292 	u_int16_t	 dnpipe;
1293 	u_int16_t	 dnrpipe;
1294 	u_int16_t	 max_mss;
1295 	sa_family_t	 wire_af;
1296 	sa_family_t	 stack_af;
1297 	sa_family_t	 rt_af;
1298 	u_int8_t	 wire_proto;
1299 	u_int8_t	 stack_proto;
1300 	u_int8_t	 log;
1301 	u_int8_t	 timeout;
1302 	u_int8_t	 direction;
1303 	u_int8_t	 rt;
1304 	u_int8_t	 min_ttl;
1305 	u_int8_t	 set_tos;
1306 	u_int8_t	 set_prio[2];
1307 	u_int8_t	 spare[3];	/* Improve struct alignment */
1308 } __packed;
1309 
1310 union pfsync_state_union {
1311 	struct pfsync_state_1301 pfs_1301;
1312 	struct pfsync_state_1400 pfs_1400;
1313 	struct pfsync_state_1500 pfs_1500;
1314 } __packed;
1315 
1316 #ifdef _KERNEL
1317 /* pfsync */
1318 typedef int		pfsync_state_import_t(union pfsync_state_union *, int, int);
1319 typedef	void		pfsync_insert_state_t(struct pf_kstate *);
1320 typedef	void		pfsync_update_state_t(struct pf_kstate *);
1321 typedef	void		pfsync_delete_state_t(struct pf_kstate *);
1322 typedef void		pfsync_clear_states_t(u_int32_t, const char *);
1323 typedef int		pfsync_defer_t(struct pf_kstate *, struct mbuf *);
1324 typedef void		pfsync_detach_ifnet_t(struct ifnet *);
1325 typedef void		pflow_export_state_t(const struct pf_kstate *);
1326 typedef bool		pf_addr_filter_func_t(const sa_family_t, const struct pf_addr *);
1327 
1328 VNET_DECLARE(pfsync_state_import_t *, pfsync_state_import_ptr);
1329 #define V_pfsync_state_import_ptr	VNET(pfsync_state_import_ptr)
1330 VNET_DECLARE(pfsync_insert_state_t *, pfsync_insert_state_ptr);
1331 #define V_pfsync_insert_state_ptr	VNET(pfsync_insert_state_ptr)
1332 VNET_DECLARE(pfsync_update_state_t *, pfsync_update_state_ptr);
1333 #define V_pfsync_update_state_ptr	VNET(pfsync_update_state_ptr)
1334 VNET_DECLARE(pfsync_delete_state_t *, pfsync_delete_state_ptr);
1335 #define V_pfsync_delete_state_ptr	VNET(pfsync_delete_state_ptr)
1336 VNET_DECLARE(pfsync_clear_states_t *, pfsync_clear_states_ptr);
1337 #define V_pfsync_clear_states_ptr	VNET(pfsync_clear_states_ptr)
1338 VNET_DECLARE(pfsync_defer_t *, pfsync_defer_ptr);
1339 #define V_pfsync_defer_ptr		VNET(pfsync_defer_ptr)
1340 VNET_DECLARE(pflow_export_state_t *,	pflow_export_state_ptr);
1341 #define V_pflow_export_state_ptr	VNET(pflow_export_state_ptr)
1342 extern pfsync_detach_ifnet_t	*pfsync_detach_ifnet_ptr;
1343 
1344 void			pfsync_state_export_1301(struct pfsync_state_1301 *,
1345 			    struct pf_kstate *);
1346 void			pfsync_state_export_1400(struct pfsync_state_1400 *,
1347 			    struct pf_kstate *);
1348 void			pfsync_state_export_1500(struct pfsync_state_1500 *,
1349 			    struct pf_kstate *);
1350 void			pf_state_export(struct pf_state_export *,
1351 			    struct pf_kstate *);
1352 
1353 /* pflog */
1354 struct pf_kruleset;
1355 struct pf_pdesc;
1356 typedef int pflog_packet_t(uint8_t, u_int8_t,
1357     struct pf_krule *, struct pf_krule *, struct pf_kruleset *,
1358     struct pf_pdesc *, int, struct pf_krule *);
1359 extern pflog_packet_t		*pflog_packet_ptr;
1360 
1361 #endif /* _KERNEL */
1362 
1363 #define	PFSYNC_FLAG_SRCNODE	0x04
1364 #define	PFSYNC_FLAG_NATSRCNODE	0x08
1365 
1366 /* for copies to/from network byte order */
1367 /* ioctl interface also uses network byte order */
1368 void	 pf_state_peer_hton(const struct pf_state_peer *,
1369 	    struct pf_state_peer_export *);
1370 void	 pf_state_peer_ntoh(const struct pf_state_peer_export *,
1371 	    struct pf_state_peer *);
1372 
1373 #define pf_state_counter_hton(s,d) do {				\
1374 	d[0] = htonl((s>>32)&0xffffffff);			\
1375 	d[1] = htonl(s&0xffffffff);				\
1376 } while (0)
1377 
1378 #define pf_state_counter_from_pfsync(s)				\
1379 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
1380 
1381 #define pf_state_counter_ntoh(s,d) do {				\
1382 	d = ntohl(s[0]);					\
1383 	d = d<<32;						\
1384 	d += ntohl(s[1]);					\
1385 } while (0)
1386 
1387 TAILQ_HEAD(pf_krulequeue, pf_krule);
1388 
1389 struct pf_kanchor;
1390 
1391 struct pf_kruleset {
1392 	struct {
1393 		struct pf_krulequeue	 queues[2];
1394 		struct {
1395 			struct pf_krulequeue	*ptr;
1396 			u_int32_t		 rcount;
1397 			u_int32_t		 ticket;
1398 			int			 open;
1399 			struct pf_krule_global 	 *tree;
1400 		}			 active, inactive;
1401 	}			 rules[PF_RULESET_MAX];
1402 	struct pf_kanchor	*anchor;
1403 	u_int32_t		 tticket;
1404 	int			 tables;
1405 	int			 topen;
1406 };
1407 
1408 RB_HEAD(pf_kanchor_global, pf_kanchor);
1409 RB_HEAD(pf_kanchor_node, pf_kanchor);
1410 struct pf_kanchor {
1411 	RB_ENTRY(pf_kanchor)	 entry_global;
1412 	RB_ENTRY(pf_kanchor)	 entry_node;
1413 	struct pf_kanchor	*parent;
1414 	struct pf_kanchor_node	 children;
1415 	char			 name[PF_ANCHOR_NAME_SIZE];
1416 	char			 path[MAXPATHLEN];
1417 	struct pf_kruleset	 ruleset;
1418 	int			 refcnt;	/* anchor rules */
1419 };
1420 RB_PROTOTYPE(pf_kanchor_global, pf_kanchor, entry_global, pf_anchor_compare);
1421 RB_PROTOTYPE(pf_kanchor_node, pf_kanchor, entry_node, pf_kanchor_compare);
1422 
1423 #define PF_RESERVED_ANCHOR	"_pf"
1424 
1425 #define PFR_TFLAG_PERSIST	0x00000001
1426 #define PFR_TFLAG_CONST		0x00000002
1427 #define PFR_TFLAG_ACTIVE	0x00000004
1428 #define PFR_TFLAG_INACTIVE	0x00000008
1429 #define PFR_TFLAG_REFERENCED	0x00000010
1430 #define PFR_TFLAG_REFDANCHOR	0x00000020
1431 #define PFR_TFLAG_COUNTERS	0x00000040
1432 /* Adjust masks below when adding flags. */
1433 #define PFR_TFLAG_USRMASK	(PFR_TFLAG_PERSIST	| \
1434 				 PFR_TFLAG_CONST	| \
1435 				 PFR_TFLAG_COUNTERS)
1436 #define PFR_TFLAG_SETMASK	(PFR_TFLAG_ACTIVE	| \
1437 				 PFR_TFLAG_INACTIVE	| \
1438 				 PFR_TFLAG_REFERENCED	| \
1439 				 PFR_TFLAG_REFDANCHOR)
1440 #define PFR_TFLAG_ALLMASK	(PFR_TFLAG_PERSIST	| \
1441 				 PFR_TFLAG_CONST	| \
1442 				 PFR_TFLAG_ACTIVE	| \
1443 				 PFR_TFLAG_INACTIVE	| \
1444 				 PFR_TFLAG_REFERENCED	| \
1445 				 PFR_TFLAG_REFDANCHOR	| \
1446 				 PFR_TFLAG_COUNTERS)
1447 
1448 struct pf_keth_anchor_stackframe;
1449 
1450 struct pfr_table {
1451 	char			 pfrt_anchor[MAXPATHLEN];
1452 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
1453 	u_int32_t		 pfrt_flags;
1454 	u_int8_t		 pfrt_fback;
1455 };
1456 
1457 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1458 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1459 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1460 
1461 struct pfr_addr {
1462 	union {
1463 		struct in_addr	 _pfra_ip4addr;
1464 		struct in6_addr	 _pfra_ip6addr;
1465 	}		 pfra_u;
1466 	u_int8_t	 pfra_af;
1467 	u_int8_t	 pfra_net;
1468 	u_int8_t	 pfra_not;
1469 	u_int8_t	 pfra_fback;
1470 };
1471 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
1472 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
1473 
1474 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1475 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1476 enum { PFR_TYPE_PACKETS, PFR_TYPE_BYTES, PFR_TYPE_MAX };
1477 #define	PFR_NUM_COUNTERS	(PFR_DIR_MAX * PFR_OP_ADDR_MAX * PFR_TYPE_MAX)
1478 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
1479 
1480 struct pfr_astats {
1481 	struct pfr_addr	 pfras_a;
1482 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1483 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1484 	time_t		 pfras_tzero;
1485 };
1486 
1487 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1488 
1489 struct pfr_tstats {
1490 	struct pfr_table pfrts_t;
1491 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1492 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1493 	u_int64_t	 pfrts_match;
1494 	u_int64_t	 pfrts_nomatch;
1495 	time_t		 pfrts_tzero;
1496 	int		 pfrts_cnt;
1497 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1498 };
1499 
1500 #ifdef _KERNEL
1501 
1502 struct pfr_kstate_counter {
1503 	counter_u64_t	pkc_pcpu;
1504 	u_int64_t	pkc_zero;
1505 };
1506 
1507 static inline int
1508 pfr_kstate_counter_init(struct pfr_kstate_counter *pfrc, int flags)
1509 {
1510 
1511 	pfrc->pkc_zero = 0;
1512 	pfrc->pkc_pcpu = counter_u64_alloc(flags);
1513 	if (pfrc->pkc_pcpu == NULL)
1514 		return (ENOMEM);
1515 	return (0);
1516 }
1517 
1518 static inline void
1519 pfr_kstate_counter_deinit(struct pfr_kstate_counter *pfrc)
1520 {
1521 
1522 	counter_u64_free(pfrc->pkc_pcpu);
1523 }
1524 
1525 static inline u_int64_t
1526 pfr_kstate_counter_fetch(struct pfr_kstate_counter *pfrc)
1527 {
1528 	u_int64_t c;
1529 
1530 	c = counter_u64_fetch(pfrc->pkc_pcpu);
1531 	c -= pfrc->pkc_zero;
1532 	return (c);
1533 }
1534 
1535 static inline void
1536 pfr_kstate_counter_zero(struct pfr_kstate_counter *pfrc)
1537 {
1538 	u_int64_t c;
1539 
1540 	c = counter_u64_fetch(pfrc->pkc_pcpu);
1541 	pfrc->pkc_zero = c;
1542 }
1543 
1544 static inline void
1545 pfr_kstate_counter_add(struct pfr_kstate_counter *pfrc, int64_t n)
1546 {
1547 
1548 	counter_u64_add(pfrc->pkc_pcpu, n);
1549 }
1550 
1551 struct pfr_ktstats {
1552 	struct pfr_table pfrts_t;
1553 	struct pfr_kstate_counter	 pfrkts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1554 	struct pfr_kstate_counter	 pfrkts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1555 	struct pfr_kstate_counter	 pfrkts_match;
1556 	struct pfr_kstate_counter	 pfrkts_nomatch;
1557 	time_t		 pfrkts_tzero;
1558 	int		 pfrkts_cnt;
1559 	int		 pfrkts_refcnt[PFR_REFCNT_MAX];
1560 };
1561 
1562 #endif /* _KERNEL */
1563 
1564 #define	pfrts_name	pfrts_t.pfrt_name
1565 #define pfrts_flags	pfrts_t.pfrt_flags
1566 
1567 #ifndef _SOCKADDR_UNION_DEFINED
1568 #define	_SOCKADDR_UNION_DEFINED
1569 union sockaddr_union {
1570 	struct sockaddr		sa;
1571 	struct sockaddr_in	sin;
1572 	struct sockaddr_in6	sin6;
1573 };
1574 #endif /* _SOCKADDR_UNION_DEFINED */
1575 
1576 struct pfr_kcounters {
1577 	counter_u64_t		 pfrkc_counters;
1578 	time_t			 pfrkc_tzero;
1579 };
1580 #define	pfr_kentry_counter(kc, dir, op, t)		\
1581 	((kc)->pfrkc_counters +				\
1582 	    (dir) * PFR_OP_ADDR_MAX * PFR_TYPE_MAX + (op) * PFR_TYPE_MAX + (t))
1583 
1584 #ifdef _KERNEL
1585 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1586 struct pfr_kentry {
1587 	struct radix_node	 pfrke_node[2];
1588 	union sockaddr_union	 pfrke_sa;
1589 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1590 	struct pfr_kcounters	 pfrke_counters;
1591 	u_int8_t		 pfrke_af;
1592 	u_int8_t		 pfrke_net;
1593 	u_int8_t		 pfrke_not;
1594 	u_int8_t		 pfrke_mark;
1595 };
1596 
1597 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1598 RB_HEAD(pfr_ktablehead, pfr_ktable);
1599 struct pfr_ktable {
1600 	struct pfr_ktstats	 pfrkt_kts;
1601 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1602 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1603 	struct radix_node_head	*pfrkt_ip4;
1604 	struct radix_node_head	*pfrkt_ip6;
1605 	struct pfr_ktable	*pfrkt_shadow;
1606 	struct pfr_ktable	*pfrkt_root;
1607 	struct pf_kruleset	*pfrkt_rs;
1608 	long			 pfrkt_larg;
1609 	int			 pfrkt_nflags;
1610 };
1611 #define pfrkt_t		pfrkt_kts.pfrts_t
1612 #define pfrkt_name	pfrkt_t.pfrt_name
1613 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
1614 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1615 #define pfrkt_flags	pfrkt_t.pfrt_flags
1616 #define pfrkt_cnt	pfrkt_kts.pfrkts_cnt
1617 #define pfrkt_refcnt	pfrkt_kts.pfrkts_refcnt
1618 #define pfrkt_packets	pfrkt_kts.pfrkts_packets
1619 #define pfrkt_bytes	pfrkt_kts.pfrkts_bytes
1620 #define pfrkt_match	pfrkt_kts.pfrkts_match
1621 #define pfrkt_nomatch	pfrkt_kts.pfrkts_nomatch
1622 #define pfrkt_tzero	pfrkt_kts.pfrkts_tzero
1623 #endif
1624 
1625 #ifdef _KERNEL
1626 struct pfi_kkif {
1627 	char				 pfik_name[IFNAMSIZ];
1628 	union {
1629 		RB_ENTRY(pfi_kkif)	 _pfik_tree;
1630 		LIST_ENTRY(pfi_kkif)	 _pfik_list;
1631 	} _pfik_glue;
1632 #define	pfik_tree	_pfik_glue._pfik_tree
1633 #define	pfik_list	_pfik_glue._pfik_list
1634 	struct pf_counter_u64		 pfik_packets[2][2][2];
1635 	struct pf_counter_u64		 pfik_bytes[2][2][2];
1636 	time_t				 pfik_tzero;
1637 	u_int				 pfik_flags;
1638 	struct ifnet			*pfik_ifp;
1639 	struct ifg_group		*pfik_group;
1640 	u_int				 pfik_rulerefs;
1641 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1642 #ifdef PF_WANT_32_TO_64_COUNTER
1643 	LIST_ENTRY(pfi_kkif)		 pfik_allkiflist;
1644 #endif
1645 };
1646 #endif
1647 
1648 #define	PFI_IFLAG_REFS		0x0001	/* has state references */
1649 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1650 #define	PFI_IFLAG_ANY 		0x0200	/* match any non-loopback interface */
1651 
1652 #ifdef _KERNEL
1653 struct pf_sctp_multihome_job;
1654 TAILQ_HEAD(pf_sctp_multihome_jobs, pf_sctp_multihome_job);
1655 
1656 struct pf_pdesc {
1657 	struct {
1658 		int	 done;
1659 		uid_t	 uid;
1660 		gid_t	 gid;
1661 	}		 lookup;
1662 	u_int64_t	 tot_len;	/* Make Mickey money */
1663 	union pf_headers {
1664 		struct tcphdr		tcp;
1665 		struct udphdr		udp;
1666 		struct sctphdr		sctp;
1667 		struct icmp		icmp;
1668 #ifdef INET6
1669 		struct icmp6_hdr	icmp6;
1670 #endif /* INET6 */
1671 		char any[0];
1672 	} hdr;
1673 
1674 	struct pf_addr	 nsaddr;	/* src address after NAT */
1675 	struct pf_addr	 ndaddr;	/* dst address after NAT */
1676 
1677 	struct pfi_kkif	*kif;		/* incomming interface */
1678 	struct mbuf	*m;
1679 
1680 	struct pf_addr	*src;		/* src address */
1681 	struct pf_addr	*dst;		/* dst address */
1682 	struct pf_addr	 osrc;
1683 	struct pf_addr	 odst;
1684 	u_int16_t	*pcksum;	/* proto cksum */
1685 	u_int16_t	*sport;
1686 	u_int16_t	*dport;
1687 	u_int16_t	 osport;
1688 	u_int16_t	 odport;
1689 	u_int16_t	 nsport;	/* src port after NAT */
1690 	u_int16_t	 ndport;	/* dst port after NAT */
1691 	struct pf_mtag	*pf_mtag;
1692 	struct pf_rule_actions	act;
1693 
1694 	u_int32_t	 off;		/* protocol header offset */
1695 	bool		 df;		/* IPv4 Don't fragment flag. */
1696 	u_int32_t	 hdrlen;	/* protocol header length */
1697 	u_int32_t	 p_len;		/* total length of protocol payload */
1698 	u_int32_t	 extoff;	/* extentsion header offset */
1699 	u_int32_t	 fragoff;	/* fragment header offset */
1700 	u_int32_t	 jumbolen;	/* length from v6 jumbo header */
1701 	u_int32_t	 badopts;	/* v4 options or v6 routing headers */
1702 #define	PF_OPT_OTHER		0x0001
1703 #define	PF_OPT_JUMBO		0x0002
1704 #define	PF_OPT_ROUTER_ALERT	0x0004
1705 
1706 	u_int16_t	*ip_sum;
1707 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1708 					 * state code. Easier than tags */
1709 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1710 	u_int16_t	 virtual_proto;
1711 #define PF_VPROTO_FRAGMENT	256
1712 	sa_family_t	 af;
1713 	sa_family_t	 naf;
1714 	u_int8_t	 proto;
1715 	u_int8_t	 tos;
1716 	u_int8_t	 ttl;
1717 	u_int8_t	 dir;		/* direction */
1718 	u_int8_t	 sidx;		/* key index for source */
1719 	u_int8_t	 didx;		/* key index for destination */
1720 #define PFDESC_SCTP_INIT	0x0001
1721 #define PFDESC_SCTP_INIT_ACK	0x0002
1722 #define PFDESC_SCTP_COOKIE	0x0004
1723 #define PFDESC_SCTP_COOKIE_ACK	0x0008
1724 #define PFDESC_SCTP_ABORT	0x0010
1725 #define PFDESC_SCTP_SHUTDOWN	0x0020
1726 #define PFDESC_SCTP_SHUTDOWN_COMPLETE	0x0040
1727 #define PFDESC_SCTP_DATA	0x0080
1728 #define PFDESC_SCTP_ASCONF	0x0100
1729 #define PFDESC_SCTP_HEARTBEAT	0x0200
1730 #define PFDESC_SCTP_HEARTBEAT_ACK	0x0400
1731 #define PFDESC_SCTP_OTHER	0x0800
1732 #define PFDESC_SCTP_ADD_IP	0x1000
1733 	u_int16_t	 sctp_flags;
1734 	u_int32_t	 sctp_initiate_tag;
1735 	u_int16_t	 sctp_dummy_sum;
1736 	struct pf_krule	*related_rule;
1737 
1738 	struct pf_sctp_multihome_jobs	sctp_multihome_jobs;
1739 };
1740 
1741 struct pf_sctp_multihome_job {
1742 	TAILQ_ENTRY(pf_sctp_multihome_job)	next;
1743 	struct pf_pdesc				 pd;
1744 	struct pf_addr				 src;
1745 	struct pf_addr				 dst;
1746 	int					 op;
1747 };
1748 
1749 #endif
1750 
1751 /* flags for RDR options */
1752 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1753 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1754 
1755 /* UDP state enumeration */
1756 #define PFUDPS_NO_TRAFFIC	0
1757 #define PFUDPS_SINGLE		1
1758 #define PFUDPS_MULTIPLE		2
1759 
1760 #define PFUDPS_NSTATES		3	/* number of state levels */
1761 
1762 #define PFUDPS_NAMES { \
1763 	"NO_TRAFFIC", \
1764 	"SINGLE", \
1765 	"MULTIPLE", \
1766 	NULL \
1767 }
1768 
1769 /* Other protocol state enumeration */
1770 #define PFOTHERS_NO_TRAFFIC	0
1771 #define PFOTHERS_SINGLE		1
1772 #define PFOTHERS_MULTIPLE	2
1773 
1774 #define PFOTHERS_NSTATES	3	/* number of state levels */
1775 
1776 #define PFOTHERS_NAMES { \
1777 	"NO_TRAFFIC", \
1778 	"SINGLE", \
1779 	"MULTIPLE", \
1780 	NULL \
1781 }
1782 
1783 #define ACTION_SET(a, x) \
1784 	do { \
1785 		if ((a) != NULL) \
1786 			*(a) = (x); \
1787 	} while (0)
1788 
1789 #define REASON_SET(a, x) \
1790 	do { \
1791 		SDT_PROBE2(pf, , test, reason_set, x, __LINE__); \
1792 		if ((a) != NULL) \
1793 			*(a) = (x); \
1794 		if (x < PFRES_MAX) \
1795 			counter_u64_add(V_pf_status.counters[x], 1); \
1796 	} while (0)
1797 
1798 enum pf_syncookies_mode {
1799 	PF_SYNCOOKIES_NEVER = 0,
1800 	PF_SYNCOOKIES_ALWAYS = 1,
1801 	PF_SYNCOOKIES_ADAPTIVE = 2,
1802 	PF_SYNCOOKIES_MODE_MAX = PF_SYNCOOKIES_ADAPTIVE
1803 };
1804 
1805 #define	PF_SYNCOOKIES_HIWATPCT	25
1806 #define	PF_SYNCOOKIES_LOWATPCT	(PF_SYNCOOKIES_HIWATPCT / 2)
1807 
1808 #ifdef _KERNEL
1809 struct pf_kstatus {
1810 	counter_u64_t	counters[PFRES_MAX]; /* reason for passing/dropping */
1811 	counter_u64_t	lcounters[KLCNT_MAX]; /* limit counters */
1812 	struct pf_counter_u64	fcounters[FCNT_MAX]; /* state operation counters */
1813 	counter_u64_t	scounters[SCNT_MAX]; /* src_node operation counters */
1814 	counter_u64_t	ncounters[NCNT_MAX];
1815 	uint32_t	states;
1816 	uint32_t	src_nodes;
1817 	uint32_t	running;
1818 	uint32_t	since;
1819 	uint32_t	debug;
1820 	uint32_t	hostid;
1821 	char		ifname[IFNAMSIZ];
1822 	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
1823 	bool		keep_counters;
1824 	enum pf_syncookies_mode	syncookies_mode;
1825 	bool		syncookies_active;
1826 	uint64_t	syncookies_inflight[2];
1827 	uint32_t	states_halfopen;
1828 	uint32_t	reass;
1829 };
1830 #endif
1831 
1832 struct pf_divert {
1833 	union {
1834 		struct in_addr	ipv4;
1835 		struct in6_addr	ipv6;
1836 	}		addr;
1837 	u_int16_t	port;
1838 };
1839 
1840 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1841 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1842 
1843 struct pf_fragment_tag {
1844 	uint16_t	ft_hdrlen;	/* header length of reassembled pkt */
1845 	uint16_t	ft_extoff;	/* last extension header offset or 0 */
1846 	uint16_t	ft_maxlen;	/* maximum fragment payload length */
1847 	uint32_t	ft_id;		/* fragment id */
1848 };
1849 
1850 /*
1851  * Limit the length of the fragment queue traversal.  Remember
1852  * search entry points based on the fragment offset.
1853  */
1854 #define PF_FRAG_ENTRY_POINTS		16
1855 
1856 /*
1857  * The number of entries in the fragment queue must be limited
1858  * to avoid DoS by linear searching.  Instead of a global limit,
1859  * use a limit per entry point.  For large packets these sum up.
1860  */
1861 #define PF_FRAG_ENTRY_LIMIT		64
1862 
1863 /*
1864  * ioctl parameter structures
1865  */
1866 
1867 struct pfioc_pooladdr {
1868 	u_int32_t		 action;
1869 	u_int32_t		 ticket;
1870 	u_int32_t		 nr;
1871 	u_int32_t		 r_num;
1872 	u_int8_t		 r_action;
1873 	u_int8_t		 r_last;
1874 	u_int8_t		 af;
1875 	char			 anchor[MAXPATHLEN];
1876 	struct pf_pooladdr	 addr;
1877 };
1878 
1879 struct pfioc_rule {
1880 	u_int32_t	 action;
1881 	u_int32_t	 ticket;
1882 	u_int32_t	 pool_ticket;
1883 	u_int32_t	 nr;
1884 	char		 anchor[MAXPATHLEN];
1885 	char		 anchor_call[MAXPATHLEN];
1886 	struct pf_rule	 rule;
1887 };
1888 
1889 struct pfioc_natlook {
1890 	struct pf_addr	 saddr;
1891 	struct pf_addr	 daddr;
1892 	struct pf_addr	 rsaddr;
1893 	struct pf_addr	 rdaddr;
1894 	u_int16_t	 sport;
1895 	u_int16_t	 dport;
1896 	u_int16_t	 rsport;
1897 	u_int16_t	 rdport;
1898 	sa_family_t	 af;
1899 	u_int8_t	 proto;
1900 	u_int8_t	 direction;
1901 };
1902 
1903 struct pfioc_state {
1904 	struct pfsync_state_1301	state;
1905 };
1906 
1907 struct pfioc_src_node_kill {
1908 	sa_family_t psnk_af;
1909 	struct pf_rule_addr psnk_src;
1910 	struct pf_rule_addr psnk_dst;
1911 	u_int		    psnk_killed;
1912 };
1913 
1914 #ifdef _KERNEL
1915 struct pf_kstate_kill {
1916 	struct pf_state_cmp	psk_pfcmp;
1917 	sa_family_t		psk_af;
1918 	int			psk_proto;
1919 	struct pf_rule_addr	psk_src;
1920 	struct pf_rule_addr	psk_dst;
1921 	struct pf_rule_addr	psk_rt_addr;
1922 	char			psk_ifname[IFNAMSIZ];
1923 	char			psk_label[PF_RULE_LABEL_SIZE];
1924 	u_int			psk_killed;
1925 	bool			psk_kill_match;
1926 	bool			psk_nat;
1927 };
1928 #endif
1929 
1930 struct pfioc_state_kill {
1931 	struct pf_state_cmp	psk_pfcmp;
1932 	sa_family_t		psk_af;
1933 	int			psk_proto;
1934 	struct pf_rule_addr	psk_src;
1935 	struct pf_rule_addr	psk_dst;
1936 	char			psk_ifname[IFNAMSIZ];
1937 	char			psk_label[PF_RULE_LABEL_SIZE];
1938 	u_int			psk_killed;
1939 };
1940 
1941 struct pfioc_states {
1942 	int	ps_len;
1943 	union {
1944 		void				*ps_buf;
1945 		struct pfsync_state_1301	*ps_states;
1946 	};
1947 };
1948 
1949 struct pfioc_states_v2 {
1950 	int		ps_len;
1951 	uint64_t	ps_req_version;
1952 	union {
1953 		void			*ps_buf;
1954 		struct pf_state_export	*ps_states;
1955 	};
1956 };
1957 
1958 struct pfioc_src_nodes {
1959 	int	psn_len;
1960 	union {
1961 		void		*psn_buf;
1962 		struct pf_src_node	*psn_src_nodes;
1963 	};
1964 };
1965 
1966 struct pfioc_if {
1967 	char		 ifname[IFNAMSIZ];
1968 };
1969 
1970 struct pfioc_tm {
1971 	int		 timeout;
1972 	int		 seconds;
1973 };
1974 
1975 struct pfioc_limit {
1976 	int		 index;
1977 	unsigned	 limit;
1978 };
1979 
1980 struct pfioc_altq_v0 {
1981 	u_int32_t	 action;
1982 	u_int32_t	 ticket;
1983 	u_int32_t	 nr;
1984 	struct pf_altq_v0 altq;
1985 };
1986 
1987 struct pfioc_altq_v1 {
1988 	u_int32_t	 action;
1989 	u_int32_t	 ticket;
1990 	u_int32_t	 nr;
1991 	/*
1992 	 * Placed here so code that only uses the above parameters can be
1993 	 * written entirely in terms of the v0 or v1 type.
1994 	 */
1995 	u_int32_t	 version;
1996 	struct pf_altq_v1 altq;
1997 };
1998 
1999 /*
2000  * Latest version of struct pfioc_altq_vX.  This must move in lock-step with
2001  * the latest version of struct pf_altq_vX as it has that struct as a
2002  * member.
2003  */
2004 #define PFIOC_ALTQ_VERSION	PF_ALTQ_VERSION
2005 
2006 struct pfioc_qstats_v0 {
2007 	u_int32_t	 ticket;
2008 	u_int32_t	 nr;
2009 	void		*buf;
2010 	int		 nbytes;
2011 	u_int8_t	 scheduler;
2012 };
2013 
2014 struct pfioc_qstats_v1 {
2015 	u_int32_t	 ticket;
2016 	u_int32_t	 nr;
2017 	void		*buf;
2018 	int		 nbytes;
2019 	u_int8_t	 scheduler;
2020 	/*
2021 	 * Placed here so code that only uses the above parameters can be
2022 	 * written entirely in terms of the v0 or v1 type.
2023 	 */
2024 	u_int32_t	 version;  /* Requested version of stats struct */
2025 };
2026 
2027 /* Latest version of struct pfioc_qstats_vX */
2028 #define PFIOC_QSTATS_VERSION	1
2029 
2030 struct pfioc_ruleset {
2031 	u_int32_t	 nr;
2032 	char		 path[MAXPATHLEN];
2033 	char		 name[PF_ANCHOR_NAME_SIZE];
2034 };
2035 
2036 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
2037 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
2038 #define PF_RULESET_ETH		(PF_RULESET_MAX+2)
2039 struct pfioc_trans {
2040 	int		 size;	/* number of elements */
2041 	int		 esize; /* size of each element in bytes */
2042 	struct pfioc_trans_e {
2043 		int		rs_num;
2044 		char		anchor[MAXPATHLEN];
2045 		u_int32_t	ticket;
2046 	}		*array;
2047 };
2048 
2049 #define PFR_FLAG_START		0x00000001
2050 #define PFR_FLAG_DUMMY		0x00000002
2051 #define PFR_FLAG_FEEDBACK	0x00000004
2052 #define PFR_FLAG_CLSTATS	0x00000008
2053 #define PFR_FLAG_ADDRSTOO	0x00000010
2054 #define PFR_FLAG_REPLACE	0x00000020
2055 #define PFR_FLAG_ALLRSETS	0x00000040
2056 #define PFR_FLAG_DONE		0x00000080
2057 #define PFR_FLAG_ALLMASK	0x000000FF
2058 #ifdef _KERNEL
2059 #define PFR_FLAG_USERIOCTL	0x10000000
2060 #endif
2061 
2062 struct pfioc_table {
2063 	struct pfr_table	 pfrio_table;
2064 	void			*pfrio_buffer;
2065 	int			 pfrio_esize;
2066 	int			 pfrio_size;
2067 	int			 pfrio_size2;
2068 	int			 pfrio_nadd;
2069 	int			 pfrio_ndel;
2070 	int			 pfrio_nchange;
2071 	int			 pfrio_flags;
2072 	u_int32_t		 pfrio_ticket;
2073 };
2074 #define	pfrio_exists	pfrio_nadd
2075 #define	pfrio_nzero	pfrio_nadd
2076 #define	pfrio_nmatch	pfrio_nadd
2077 #define pfrio_naddr	pfrio_size2
2078 #define pfrio_setflag	pfrio_size2
2079 #define pfrio_clrflag	pfrio_nadd
2080 
2081 struct pfioc_iface {
2082 	char	 pfiio_name[IFNAMSIZ];
2083 	void	*pfiio_buffer;
2084 	int	 pfiio_esize;
2085 	int	 pfiio_size;
2086 	int	 pfiio_nzero;
2087 	int	 pfiio_flags;
2088 };
2089 
2090 /*
2091  * ioctl operations
2092  */
2093 
2094 #define DIOCSTART	_IO  ('D',  1)
2095 #define DIOCSTOP	_IO  ('D',  2)
2096 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
2097 #define DIOCADDRULENV	_IOWR('D',  4, struct pfioc_nv)
2098 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
2099 #define DIOCGETRULENV	_IOWR('D',  7, struct pfioc_nv)
2100 #define DIOCCLRSTATESNV	_IOWR('D', 18, struct pfioc_nv)
2101 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
2102 #define DIOCGETSTATENV	_IOWR('D', 19, struct pfioc_nv)
2103 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
2104 #define DIOCGETSTATUSNV	_IOWR('D', 21, struct pfioc_nv)
2105 #define DIOCCLRSTATUS	_IO  ('D', 22)
2106 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
2107 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
2108 #ifdef COMPAT_FREEBSD14
2109 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
2110 #endif
2111 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
2112 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
2113 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
2114 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
2115 #define DIOCCLRRULECTRS	_IO  ('D', 38)
2116 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
2117 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
2118 #define DIOCKILLSTATESNV	_IOWR('D', 41, struct pfioc_nv)
2119 #define DIOCSTARTALTQ	_IO  ('D', 42)
2120 #define DIOCSTOPALTQ	_IO  ('D', 43)
2121 #define DIOCADDALTQV0	_IOWR('D', 45, struct pfioc_altq_v0)
2122 #define DIOCADDALTQV1	_IOWR('D', 45, struct pfioc_altq_v1)
2123 #define DIOCGETALTQSV0	_IOWR('D', 47, struct pfioc_altq_v0)
2124 #define DIOCGETALTQSV1	_IOWR('D', 47, struct pfioc_altq_v1)
2125 #define DIOCGETALTQV0	_IOWR('D', 48, struct pfioc_altq_v0)
2126 #define DIOCGETALTQV1	_IOWR('D', 48, struct pfioc_altq_v1)
2127 #define DIOCCHANGEALTQV0 _IOWR('D', 49, struct pfioc_altq_v0)
2128 #define DIOCCHANGEALTQV1 _IOWR('D', 49, struct pfioc_altq_v1)
2129 #define DIOCGETQSTATSV0	_IOWR('D', 50, struct pfioc_qstats_v0)
2130 #define DIOCGETQSTATSV1	_IOWR('D', 50, struct pfioc_qstats_v1)
2131 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
2132 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
2133 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
2134 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
2135 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
2136 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
2137 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
2138 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
2139 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
2140 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
2141 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
2142 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
2143 #define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
2144 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
2145 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
2146 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
2147 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
2148 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
2149 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
2150 #define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
2151 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
2152 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
2153 #define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
2154 #define	DIOCOSFPFLUSH	_IO('D', 78)
2155 #define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
2156 #define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
2157 #define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
2158 #define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
2159 #define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
2160 #define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
2161 #define	DIOCCLRSRCNODES	_IO('D', 85)
2162 #define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
2163 #define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
2164 #define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
2165 #define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
2166 #define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
2167 #define	DIOCGIFSPEEDV0	_IOWR('D', 92, struct pf_ifspeed_v0)
2168 #define	DIOCGIFSPEEDV1	_IOWR('D', 92, struct pf_ifspeed_v1)
2169 #ifdef COMPAT_FREEBSD14
2170 #define DIOCGETSTATESV2	_IOWR('D', 93, struct pfioc_states_v2)
2171 #endif
2172 #define	DIOCGETSYNCOOKIES	_IOWR('D', 94, struct pfioc_nv)
2173 #define	DIOCSETSYNCOOKIES	_IOWR('D', 95, struct pfioc_nv)
2174 #define	DIOCKEEPCOUNTERS	_IOWR('D', 96, struct pfioc_nv)
2175 #define	DIOCKEEPCOUNTERS_FREEBSD13	_IOWR('D', 92, struct pfioc_nv)
2176 #define	DIOCADDETHRULE		_IOWR('D', 97, struct pfioc_nv)
2177 #define	DIOCGETETHRULE		_IOWR('D', 98, struct pfioc_nv)
2178 #define	DIOCGETETHRULES		_IOWR('D', 99, struct pfioc_nv)
2179 #define	DIOCGETETHRULESETS	_IOWR('D', 100, struct pfioc_nv)
2180 #define	DIOCGETETHRULESET	_IOWR('D', 101, struct pfioc_nv)
2181 #define DIOCSETREASS		_IOWR('D', 102, u_int32_t)
2182 
2183 struct pf_ifspeed_v0 {
2184 	char			ifname[IFNAMSIZ];
2185 	u_int32_t		baudrate;
2186 };
2187 
2188 struct pf_ifspeed_v1 {
2189 	char			ifname[IFNAMSIZ];
2190 	u_int32_t		baudrate32;
2191 	/* layout identical to struct pf_ifspeed_v0 up to this point */
2192 	u_int64_t		baudrate;
2193 };
2194 
2195 /* Latest version of struct pf_ifspeed_vX */
2196 #define PF_IFSPEED_VERSION	1
2197 
2198 /*
2199  * Compatibility and convenience macros
2200  */
2201 #ifndef _KERNEL
2202 #ifdef PFIOC_USE_LATEST
2203 /*
2204  * Maintaining in-tree consumers of the ioctl interface is easier when that
2205  * code can be written in terms old names that refer to the latest interface
2206  * version as that reduces the required changes in the consumers to those
2207  * that are functionally necessary to accommodate a new interface version.
2208  */
2209 #define	pfioc_altq	__CONCAT(pfioc_altq_v, PFIOC_ALTQ_VERSION)
2210 #define	pfioc_qstats	__CONCAT(pfioc_qstats_v, PFIOC_QSTATS_VERSION)
2211 #define	pf_ifspeed	__CONCAT(pf_ifspeed_v, PF_IFSPEED_VERSION)
2212 
2213 #define	DIOCADDALTQ	__CONCAT(DIOCADDALTQV, PFIOC_ALTQ_VERSION)
2214 #define	DIOCGETALTQS	__CONCAT(DIOCGETALTQSV, PFIOC_ALTQ_VERSION)
2215 #define	DIOCGETALTQ	__CONCAT(DIOCGETALTQV, PFIOC_ALTQ_VERSION)
2216 #define	DIOCCHANGEALTQ	__CONCAT(DIOCCHANGEALTQV, PFIOC_ALTQ_VERSION)
2217 #define	DIOCGETQSTATS	__CONCAT(DIOCGETQSTATSV, PFIOC_QSTATS_VERSION)
2218 #define	DIOCGIFSPEED	__CONCAT(DIOCGIFSPEEDV, PF_IFSPEED_VERSION)
2219 #else
2220 /*
2221  * When building out-of-tree code that is written for the old interface,
2222  * such as may exist in ports for example, resolve the old struct tags and
2223  * ioctl command names to the v0 versions.
2224  */
2225 #define	pfioc_altq	__CONCAT(pfioc_altq_v, 0)
2226 #define	pfioc_qstats	__CONCAT(pfioc_qstats_v, 0)
2227 #define	pf_ifspeed	__CONCAT(pf_ifspeed_v, 0)
2228 
2229 #define	DIOCADDALTQ	__CONCAT(DIOCADDALTQV, 0)
2230 #define	DIOCGETALTQS	__CONCAT(DIOCGETALTQSV, 0)
2231 #define	DIOCGETALTQ	__CONCAT(DIOCGETALTQV, 0)
2232 #define	DIOCCHANGEALTQ	__CONCAT(DIOCCHANGEALTQV, 0)
2233 #define	DIOCGETQSTATS	__CONCAT(DIOCGETQSTATSV, 0)
2234 #define	DIOCGIFSPEED	__CONCAT(DIOCGIFSPEEDV, 0)
2235 #endif /* PFIOC_USE_LATEST */
2236 #endif /* _KERNEL */
2237 
2238 #ifdef _KERNEL
2239 LIST_HEAD(pf_ksrc_node_list, pf_ksrc_node);
2240 struct pf_srchash {
2241 	struct pf_ksrc_node_list		nodes;
2242 	struct mtx			lock;
2243 };
2244 
2245 struct pf_keyhash {
2246 	LIST_HEAD(, pf_state_key)	keys;
2247 	struct mtx			lock;
2248 };
2249 
2250 struct pf_idhash {
2251 	LIST_HEAD(, pf_kstate)		states;
2252 	struct mtx			lock;
2253 };
2254 
2255 struct pf_udpendpointhash {
2256 	LIST_HEAD(, pf_udp_endpoint)	endpoints;
2257 	/* refcont is synchronized on the source endpoint's row lock */
2258 	struct mtx			lock;
2259 };
2260 
2261 extern u_long		pf_ioctl_maxcount;
2262 VNET_DECLARE(u_long, pf_hashmask);
2263 #define V_pf_hashmask	VNET(pf_hashmask)
2264 VNET_DECLARE(u_long, pf_srchashmask);
2265 #define V_pf_srchashmask	VNET(pf_srchashmask)
2266 VNET_DECLARE(u_long, pf_udpendpointhashmask);
2267 #define V_pf_udpendpointhashmask	VNET(pf_udpendpointhashmask)
2268 #define	PF_HASHSIZ	(131072)
2269 #define	PF_SRCHASHSIZ	(PF_HASHSIZ/4)
2270 #define	PF_UDPENDHASHSIZ	(PF_HASHSIZ/4)
2271 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
2272 VNET_DECLARE(struct pf_idhash *, pf_idhash);
2273 VNET_DECLARE(struct pf_udpendpointhash *, pf_udpendpointhash);
2274 #define V_pf_keyhash	VNET(pf_keyhash)
2275 #define	V_pf_idhash	VNET(pf_idhash)
2276 #define	V_pf_udpendpointhash	VNET(pf_udpendpointhash)
2277 VNET_DECLARE(struct pf_srchash *, pf_srchash);
2278 #define	V_pf_srchash	VNET(pf_srchash)
2279 
2280 #define	PF_IDHASHID(id)	(be64toh(id) % (V_pf_hashmask + 1))
2281 #define	PF_IDHASH(s)	PF_IDHASHID((s)->id)
2282 
2283 VNET_DECLARE(void *, pf_swi_cookie);
2284 #define V_pf_swi_cookie	VNET(pf_swi_cookie)
2285 VNET_DECLARE(struct intr_event *, pf_swi_ie);
2286 #define	V_pf_swi_ie	VNET(pf_swi_ie)
2287 
2288 VNET_DECLARE(struct unrhdr64, pf_stateid);
2289 #define	V_pf_stateid	VNET(pf_stateid)
2290 
2291 TAILQ_HEAD(pf_altqqueue, pf_altq);
2292 VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[4]);
2293 #define	V_pf_altqs			 VNET(pf_altqs)
2294 VNET_DECLARE(struct pf_kpalist,		 pf_pabuf[3]);
2295 #define	V_pf_pabuf			 VNET(pf_pabuf)
2296 
2297 VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
2298 #define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
2299 VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
2300 #define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
2301 VNET_DECLARE(int,			 altqs_inactive_open);
2302 #define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
2303 VNET_DECLARE(u_int32_t,			 ticket_pabuf);
2304 #define	V_ticket_pabuf			 VNET(ticket_pabuf)
2305 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
2306 #define	V_pf_altqs_active		 VNET(pf_altqs_active)
2307 VNET_DECLARE(struct pf_altqqueue *,	 pf_altq_ifs_active);
2308 #define	V_pf_altq_ifs_active		 VNET(pf_altq_ifs_active)
2309 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
2310 #define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
2311 VNET_DECLARE(struct pf_altqqueue *,	 pf_altq_ifs_inactive);
2312 #define	V_pf_altq_ifs_inactive		 VNET(pf_altq_ifs_inactive)
2313 
2314 VNET_DECLARE(struct pf_krulequeue, pf_unlinked_rules);
2315 #define	V_pf_unlinked_rules	VNET(pf_unlinked_rules)
2316 
2317 #ifdef PF_WANT_32_TO_64_COUNTER
2318 LIST_HEAD(allkiflist_head, pfi_kkif);
2319 VNET_DECLARE(struct allkiflist_head, pf_allkiflist);
2320 #define V_pf_allkiflist     VNET(pf_allkiflist)
2321 VNET_DECLARE(size_t, pf_allkifcount);
2322 #define V_pf_allkifcount     VNET(pf_allkifcount)
2323 VNET_DECLARE(struct pfi_kkif *, pf_kifmarker);
2324 #define V_pf_kifmarker     VNET(pf_kifmarker)
2325 
2326 LIST_HEAD(allrulelist_head, pf_krule);
2327 VNET_DECLARE(struct allrulelist_head, pf_allrulelist);
2328 #define V_pf_allrulelist     VNET(pf_allrulelist)
2329 VNET_DECLARE(size_t, pf_allrulecount);
2330 #define V_pf_allrulecount     VNET(pf_allrulecount)
2331 VNET_DECLARE(struct pf_krule *, pf_rulemarker);
2332 #define V_pf_rulemarker     VNET(pf_rulemarker)
2333 #endif
2334 
2335 int				 pf_start(void);
2336 int				 pf_stop(void);
2337 void				 pf_initialize(void);
2338 void				 pf_mtag_initialize(void);
2339 void				 pf_mtag_cleanup(void);
2340 void				 pf_cleanup(void);
2341 
2342 struct pf_mtag			*pf_get_mtag(struct mbuf *);
2343 
2344 extern void			 pf_calc_skip_steps(struct pf_krulequeue *);
2345 #ifdef ALTQ
2346 extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
2347 #endif
2348 VNET_DECLARE(uma_zone_t,	 pf_state_z);
2349 #define	V_pf_state_z		 VNET(pf_state_z)
2350 VNET_DECLARE(uma_zone_t,	 pf_state_key_z);
2351 #define	V_pf_state_key_z	 VNET(pf_state_key_z)
2352 VNET_DECLARE(uma_zone_t,	 pf_udp_mapping_z);
2353 #define	V_pf_udp_mapping_z	 VNET(pf_udp_mapping_z)
2354 VNET_DECLARE(uma_zone_t,	 pf_state_scrub_z);
2355 #define	V_pf_state_scrub_z	 VNET(pf_state_scrub_z)
2356 VNET_DECLARE(uma_zone_t,	 pf_anchor_z);
2357 #define	V_pf_anchor_z		 VNET(pf_anchor_z)
2358 VNET_DECLARE(uma_zone_t,	 pf_eth_anchor_z);
2359 #define	V_pf_eth_anchor_z	 VNET(pf_eth_anchor_z)
2360 
2361 extern void			 pf_purge_thread(void *);
2362 extern void			 pf_unload_vnet_purge(void);
2363 extern void			 pf_intr(void *);
2364 extern void			 pf_purge_expired_src_nodes(void);
2365 
2366 extern int			 pf_remove_state(struct pf_kstate *);
2367 extern int			 pf_state_insert(struct pfi_kkif *,
2368 				    struct pfi_kkif *,
2369 				    struct pf_state_key *,
2370 				    struct pf_state_key *,
2371 				    struct pf_kstate *);
2372 extern struct pf_kstate		*pf_alloc_state(int);
2373 extern void			 pf_free_state(struct pf_kstate *);
2374 extern void			 pf_killstates(struct pf_kstate_kill *,
2375 				    unsigned int *);
2376 extern unsigned int		 pf_clear_states(const struct pf_kstate_kill *);
2377 
2378 static __inline void
2379 pf_ref_state(struct pf_kstate *s)
2380 {
2381 
2382 	refcount_acquire(&s->refs);
2383 }
2384 
2385 static __inline int
2386 pf_release_state(struct pf_kstate *s)
2387 {
2388 
2389 	if (refcount_release(&s->refs)) {
2390 		pf_free_state(s);
2391 		return (1);
2392 	} else
2393 		return (0);
2394 }
2395 
2396 static __inline int
2397 pf_release_staten(struct pf_kstate *s, u_int n)
2398 {
2399 
2400 	if (refcount_releasen(&s->refs, n)) {
2401 		pf_free_state(s);
2402 		return (1);
2403 	} else
2404 		return (0);
2405 }
2406 
2407 static __inline uint64_t
2408 pf_get_uptime(void)
2409 {
2410 	struct timeval t;
2411 	microuptime(&t);
2412 	return ((t.tv_sec * 1000) + (t.tv_usec / 1000));
2413 }
2414 
2415 static __inline uint64_t
2416 pf_get_time(void)
2417 {
2418 	struct timeval t;
2419 	microtime(&t);
2420 	return ((t.tv_sec * 1000) + (t.tv_usec / 1000));
2421 }
2422 
2423 extern struct pf_kstate		*pf_find_state_byid(uint64_t, uint32_t);
2424 extern struct pf_kstate		*pf_find_state_all(
2425 				    const struct pf_state_key_cmp *,
2426 				    u_int, int *);
2427 extern bool			pf_find_state_all_exists(
2428 				    const struct pf_state_key_cmp *,
2429 				    u_int);
2430 extern struct pf_udp_mapping	*pf_udp_mapping_find(struct pf_udp_endpoint_cmp
2431 				    *endpoint);
2432 extern struct pf_udp_mapping	*pf_udp_mapping_create(sa_family_t af,
2433 				    struct pf_addr *src_addr, uint16_t src_port,
2434 				    struct pf_addr *nat_addr, uint16_t nat_port);
2435 extern int			 pf_udp_mapping_insert(struct pf_udp_mapping
2436 				    *mapping);
2437 extern void			 pf_udp_mapping_release(struct pf_udp_mapping
2438 				    *mapping);
2439 uint32_t			 pf_hashsrc(struct pf_addr *, sa_family_t);
2440 extern bool			 pf_src_node_exists(struct pf_ksrc_node **,
2441 				    struct pf_srchash *);
2442 extern struct pf_ksrc_node	*pf_find_src_node(struct pf_addr *,
2443 				    struct pf_krule *, sa_family_t,
2444 				    struct pf_srchash **, pf_sn_types_t, bool);
2445 extern void			 pf_unlink_src_node(struct pf_ksrc_node *);
2446 extern u_int			 pf_free_src_nodes(struct pf_ksrc_node_list *);
2447 extern void			 pf_free_src_node(struct pf_ksrc_node *);
2448 extern void			 pf_print_state(struct pf_kstate *);
2449 extern void			 pf_print_flags(uint16_t);
2450 extern int			 pf_addr_wrap_neq(struct pf_addr_wrap *,
2451 				    struct pf_addr_wrap *);
2452 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
2453 				    u_int8_t);
2454 extern u_int16_t		 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
2455 				    u_int16_t, u_int16_t, u_int8_t);
2456 
2457 VNET_DECLARE(struct pf_krule,		 pf_default_rule);
2458 #define	V_pf_default_rule		  VNET(pf_default_rule)
2459 extern void			 pf_addrcpy(struct pf_addr *, const struct pf_addr *,
2460 				    sa_family_t);
2461 void				pf_free_rule(struct pf_krule *);
2462 
2463 int	pf_test_eth(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
2464 int	pf_scan_sctp(struct pf_pdesc *);
2465 #if defined(INET) || defined(INET6)
2466 int	pf_test(sa_family_t, int, int, struct ifnet *, struct mbuf **, struct inpcb *,
2467 	    struct pf_rule_actions *);
2468 #endif
2469 #ifdef INET
2470 int	pf_normalize_ip(u_short *, struct pf_pdesc *);
2471 #endif /* INET */
2472 
2473 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
2474 	    struct pf_addr *, struct pf_addr *, sa_family_t);
2475 void	pf_addr_inc(struct pf_addr *, sa_family_t);
2476 #ifdef INET6
2477 int	pf_normalize_ip6(int, u_short *, struct pf_pdesc *);
2478 int	pf_max_frag_size(struct mbuf *);
2479 int	pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *,
2480 	    struct ifnet *, bool);
2481 #endif /* INET6 */
2482 
2483 int	pf_multihome_scan_init(int, int, struct pf_pdesc *);
2484 int	pf_multihome_scan_asconf(int, int, struct pf_pdesc *);
2485 
2486 u_int32_t	pf_new_isn(struct pf_kstate *);
2487 void   *pf_pull_hdr(const struct mbuf *, int, void *, int, u_short *,
2488 	    sa_family_t);
2489 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
2490 void	pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
2491 	    u_int8_t);
2492 void	pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
2493 int	pf_patch_16(struct pf_pdesc *, void *, u_int16_t, bool);
2494 int	pf_patch_32(struct pf_pdesc *, void *, u_int32_t, bool);
2495 void	pf_send_deferred_syn(struct pf_kstate *);
2496 int	pf_match_addr(u_int8_t, const struct pf_addr *,
2497 	    const struct pf_addr *, const struct pf_addr *, sa_family_t);
2498 int	pf_match_addr_range(const struct pf_addr *, const struct pf_addr *,
2499 	    const struct pf_addr *, sa_family_t);
2500 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
2501 
2502 void	pf_normalize_init(void);
2503 void	pf_normalize_cleanup(void);
2504 uint64_t pf_normalize_get_frag_count(void);
2505 int	pf_normalize_tcp(struct pf_pdesc *);
2506 void	pf_normalize_tcp_cleanup(struct pf_kstate *);
2507 int	pf_normalize_tcp_init(struct pf_pdesc *,
2508 	    struct tcphdr *, struct pf_state_peer *);
2509 int	pf_normalize_tcp_stateful(struct pf_pdesc *,
2510 	    u_short *, struct tcphdr *, struct pf_kstate *,
2511 	    struct pf_state_peer *, struct pf_state_peer *, int *);
2512 int	pf_normalize_sctp_init(struct pf_pdesc *,
2513 	    struct pf_state_peer *, struct pf_state_peer *);
2514 int	pf_normalize_sctp(struct pf_pdesc *);
2515 u_int32_t
2516 	pf_state_expires(const struct pf_kstate *);
2517 void	pf_purge_expired_fragments(void);
2518 void	pf_purge_fragments(uint32_t);
2519 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kkif *,
2520 	    int);
2521 int	pf_socket_lookup(struct pf_pdesc *);
2522 struct pf_state_key *pf_alloc_state_key(int);
2523 int	pf_translate(struct pf_pdesc *, struct pf_addr *, u_int16_t,
2524 	    struct pf_addr *, u_int16_t, u_int16_t, int);
2525 bool	pf_init_threshold(struct pf_kthreshold *, uint32_t, uint32_t);
2526 uint16_t	pf_tagname2tag(const char *);
2527 #ifdef ALTQ
2528 uint16_t	pf_qname2qid(const char *, bool);
2529 #endif /* ALTQ */
2530 
2531 void	pfr_initialize(void);
2532 void	pfr_cleanup(void);
2533 struct pfr_kentry *
2534 	pfr_kentry_byaddr(struct pfr_ktable *, struct pf_addr *, sa_family_t,
2535 	    int);
2536 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
2537 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
2538 	    u_int64_t, int, int, int);
2539 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t,
2540 	    pf_addr_filter_func_t, bool);
2541 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
2542 struct pfr_ktable *
2543 	pfr_attach_table(struct pf_kruleset *, char *);
2544 struct pfr_ktable *
2545 	pfr_eth_attach_table(struct pf_keth_ruleset *, char *);
2546 void	pfr_detach_table(struct pfr_ktable *);
2547 int	pfr_clr_tables(struct pfr_table *, int *, int);
2548 int	pfr_add_tables(struct pfr_table *, int, int *, int);
2549 int	pfr_del_tables(struct pfr_table *, int, int *, int);
2550 int	pfr_table_count(struct pfr_table *, int);
2551 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
2552 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
2553 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
2554 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
2555 int	pfr_clr_addrs(struct pfr_table *, int *, int);
2556 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, time_t);
2557 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2558 	    int);
2559 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2560 	    int);
2561 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2562 	    int *, int *, int *, int, u_int32_t);
2563 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
2564 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
2565 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
2566 	    int);
2567 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2568 	    int);
2569 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
2570 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
2571 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
2572 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
2573 	    int *, u_int32_t, int);
2574 struct pfr_ktable
2575 	*pfr_ktable_select_active(struct pfr_ktable *);
2576 
2577 MALLOC_DECLARE(PFI_MTYPE);
2578 VNET_DECLARE(struct pfi_kkif *,		 pfi_all);
2579 #define	V_pfi_all	 		 VNET(pfi_all)
2580 
2581 void		 pfi_initialize(void);
2582 void		 pfi_initialize_vnet(void);
2583 void		 pfi_cleanup(void);
2584 void		 pfi_cleanup_vnet(void);
2585 void		 pfi_kkif_ref(struct pfi_kkif *);
2586 void		 pfi_kkif_unref(struct pfi_kkif *);
2587 struct pfi_kkif	*pfi_kkif_find(const char *);
2588 struct pfi_kkif	*pfi_kkif_attach(struct pfi_kkif *, const char *);
2589 int		 pfi_kkif_match(struct pfi_kkif *, struct pfi_kkif *);
2590 void		 pfi_kkif_purge(void);
2591 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
2592 		    sa_family_t);
2593 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
2594 void		 pfi_dynaddr_remove(struct pfi_dynaddr *);
2595 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
2596 void		 pfi_update_status(const char *, struct pf_status *);
2597 void		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
2598 int		 pfi_set_flags(const char *, int);
2599 int		 pfi_clear_flags(const char *, int);
2600 
2601 int		 pf_match_tag(struct mbuf *, struct pf_krule *, int *, int);
2602 int		 pf_tag_packet(struct pf_pdesc *, int);
2603 int		 pf_addr_cmp(struct pf_addr *, struct pf_addr *,
2604 		    sa_family_t);
2605 
2606 uint8_t*	 pf_find_tcpopt(u_int8_t *, u_int8_t *, size_t,
2607 		    u_int8_t, u_int8_t);
2608 u_int16_t	 pf_get_mss(struct pf_pdesc *);
2609 u_int8_t	 pf_get_wscale(struct pf_pdesc *);
2610 struct mbuf 	*pf_build_tcp(const struct pf_krule *, sa_family_t,
2611 		    const struct pf_addr *, const struct pf_addr *,
2612 		    u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2613 		    u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2614 		    u_int16_t, u_int16_t, u_int, int, u_short *);
2615 void		 pf_send_tcp(const struct pf_krule *, sa_family_t,
2616 			    const struct pf_addr *, const struct pf_addr *,
2617 			    u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2618 			    u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2619 			    u_int16_t, u_int16_t, int, u_short *);
2620 
2621 void			 pf_syncookies_init(void);
2622 void			 pf_syncookies_cleanup(void);
2623 int			 pf_get_syncookies(struct pfioc_nv *);
2624 int			 pf_set_syncookies(struct pfioc_nv *);
2625 int			 pf_synflood_check(struct pf_pdesc *);
2626 void			 pf_syncookie_send(struct pf_pdesc *, u_short *);
2627 bool			 pf_syncookie_check(struct pf_pdesc *);
2628 u_int8_t		 pf_syncookie_validate(struct pf_pdesc *);
2629 struct mbuf *		 pf_syncookie_recreate_syn(struct pf_pdesc *,
2630 			    u_short *);
2631 
2632 VNET_DECLARE(struct pf_kstatus, pf_status);
2633 #define	V_pf_status	VNET(pf_status)
2634 
2635 struct pf_limit {
2636 	uma_zone_t	zone;
2637 	u_int		limit;
2638 };
2639 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
2640 #define	V_pf_limits VNET(pf_limits)
2641 
2642 #endif /* _KERNEL */
2643 
2644 #ifdef _KERNEL
2645 struct pf_nl_pooladdr {
2646 	u_int32_t		 action;
2647 	u_int32_t		 ticket;
2648 	u_int32_t		 nr;
2649 	u_int32_t		 r_num;
2650 	u_int8_t		 r_action;
2651 	u_int8_t		 r_last;
2652 	u_int8_t		 af;
2653 	char			 anchor[MAXPATHLEN];
2654 	struct pf_pooladdr	 addr;
2655 	/* Above this is identical to pfioc_pooladdr */
2656 	int			 which;
2657 };
2658 
2659 VNET_DECLARE(struct pf_kanchor_global,		 pf_anchors);
2660 #define	V_pf_anchors				 VNET(pf_anchors)
2661 VNET_DECLARE(struct pf_kanchor,			 pf_main_anchor);
2662 #define	V_pf_main_anchor			 VNET(pf_main_anchor)
2663 VNET_DECLARE(struct pf_keth_anchor_global,	 pf_keth_anchors);
2664 #define	V_pf_keth_anchors			 VNET(pf_keth_anchors)
2665 #define pf_main_ruleset	V_pf_main_anchor.ruleset
2666 
2667 VNET_DECLARE(struct pf_keth_anchor,		 pf_main_keth_anchor);
2668 #define V_pf_main_keth_anchor			 VNET(pf_main_keth_anchor)
2669 VNET_DECLARE(struct pf_keth_ruleset*,		 pf_keth);
2670 #define	V_pf_keth				 VNET(pf_keth)
2671 
2672 void			 pf_init_kruleset(struct pf_kruleset *);
2673 void			 pf_init_keth(struct pf_keth_ruleset *);
2674 int			 pf_kanchor_setup(struct pf_krule *,
2675 			    const struct pf_kruleset *, const char *);
2676 int			 pf_kanchor_copyout(const struct pf_kruleset *,
2677 			    const struct pf_krule *, char *, size_t);
2678 int			 pf_kanchor_nvcopyout(const struct pf_kruleset *,
2679 			    const struct pf_krule *, nvlist_t *);
2680 void			 pf_remove_kanchor(struct pf_krule *);
2681 void			 pf_remove_if_empty_kruleset(struct pf_kruleset *);
2682 struct pf_kruleset	*pf_find_kruleset(const char *);
2683 struct pf_kruleset	*pf_get_leaf_kruleset(char *, char **);
2684 struct pf_kruleset	*pf_find_or_create_kruleset(const char *);
2685 void			 pf_rs_initialize(void);
2686 void			 pf_rule_tree_free(struct pf_krule_global *);
2687 
2688 
2689 struct pf_krule		*pf_krule_alloc(void);
2690 
2691 void			 pf_remove_if_empty_keth_ruleset(
2692 			    struct pf_keth_ruleset *);
2693 struct pf_keth_ruleset	*pf_find_keth_ruleset(const char *);
2694 struct pf_keth_anchor	*pf_find_keth_anchor(const char *);
2695 int			 pf_keth_anchor_setup(struct pf_keth_rule *,
2696 			    const struct pf_keth_ruleset *, const char *);
2697 int			 pf_keth_anchor_nvcopyout(
2698 			    const struct pf_keth_ruleset *,
2699 			    const struct pf_keth_rule *, nvlist_t *);
2700 struct pf_keth_ruleset	*pf_find_or_create_keth_ruleset(const char *);
2701 void			 pf_keth_anchor_remove(struct pf_keth_rule *);
2702 
2703 int			 pf_ioctl_getrules(struct pfioc_rule *);
2704 int			 pf_ioctl_addrule(struct pf_krule *, uint32_t,
2705 			    uint32_t, const char *, const char *, uid_t uid,
2706 			    pid_t);
2707 void			 pf_ioctl_clear_status(void);
2708 int			 pf_ioctl_get_timeout(int, int *);
2709 int			 pf_ioctl_set_timeout(int, int, int *);
2710 int			 pf_ioctl_get_limit(int, unsigned int *);
2711 int			 pf_ioctl_set_limit(int, unsigned int, unsigned int *);
2712 int			 pf_ioctl_begin_addrs(uint32_t *);
2713 int			 pf_ioctl_add_addr(struct pf_nl_pooladdr *);
2714 int			 pf_ioctl_get_addrs(struct pf_nl_pooladdr *);
2715 int			 pf_ioctl_get_addr(struct pf_nl_pooladdr *);
2716 int			 pf_ioctl_get_rulesets(struct pfioc_ruleset *);
2717 int			 pf_ioctl_get_ruleset(struct pfioc_ruleset *);
2718 int			 pf_ioctl_natlook(struct pfioc_natlook *);
2719 
2720 void			 pf_krule_free(struct pf_krule *);
2721 void			 pf_krule_clear_counters(struct pf_krule *);
2722 void			 pf_addr_copyout(struct pf_addr_wrap *);
2723 #endif
2724 
2725 /* The fingerprint functions can be linked into userland programs (tcpdump) */
2726 int	pf_osfp_add(struct pf_osfp_ioctl *);
2727 #ifdef _KERNEL
2728 struct pf_osfp_enlist *
2729 	pf_osfp_fingerprint(struct pf_pdesc *, const struct tcphdr *);
2730 #endif /* _KERNEL */
2731 void	pf_osfp_flush(void);
2732 int	pf_osfp_get(struct pf_osfp_ioctl *);
2733 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
2734 
2735 #ifdef _KERNEL
2736 void			 pf_print_host(struct pf_addr *, u_int16_t, sa_family_t);
2737 
2738 enum pf_test_status	 pf_step_into_anchor(struct pf_test_ctx *, struct pf_krule *,
2739 			    struct pf_krule_slist *match_rules);
2740 enum pf_test_status	 pf_match_rule(struct pf_test_ctx *, struct pf_kruleset *,
2741 			    struct pf_krule_slist *);
2742 void			 pf_step_into_keth_anchor(struct pf_keth_anchor_stackframe *,
2743 			    int *, struct pf_keth_ruleset **,
2744 			    struct pf_keth_rule **, struct pf_keth_rule **,
2745 			    int *);
2746 int			 pf_step_out_of_keth_anchor(struct pf_keth_anchor_stackframe *,
2747 			    int *, struct pf_keth_ruleset **,
2748 			    struct pf_keth_rule **, struct pf_keth_rule **,
2749 			    int *);
2750 
2751 u_short			 pf_map_addr(sa_family_t, struct pf_krule *,
2752 			    struct pf_addr *, struct pf_addr *,
2753 			    struct pfi_kkif **nkif, sa_family_t *,
2754 			    struct pf_addr *, struct pf_kpool *);
2755 u_short			 pf_map_addr_sn(u_int8_t, struct pf_krule *,
2756 			    struct pf_addr *, struct pf_addr *,
2757 			    sa_family_t *, struct pfi_kkif **,
2758 			    struct pf_addr *, struct pf_kpool *,
2759 			    pf_sn_types_t);
2760 int			 pf_get_transaddr_af(struct pf_krule *,
2761 			    struct pf_pdesc *);
2762 u_short			 pf_get_translation(struct pf_test_ctx *);
2763 u_short			 pf_get_transaddr(struct pf_test_ctx *,
2764 			    struct pf_krule *,
2765 			    u_int8_t, struct pf_kpool *);
2766 int			 pf_translate_compat(struct pf_test_ctx *);
2767 
2768 int			 pf_state_key_setup(struct pf_pdesc *,
2769 			    u_int16_t, u_int16_t,
2770 			    struct pf_state_key **sk, struct pf_state_key **nk);
2771 struct pf_state_key	*pf_state_key_clone(const struct pf_state_key *);
2772 void			 pf_rule_to_actions(struct pf_krule *,
2773 			    struct pf_rule_actions *);
2774 int			 pf_normalize_mss(struct pf_pdesc *pd);
2775 #if defined(INET) || defined(INET6)
2776 void	pf_scrub(struct pf_pdesc *);
2777 #endif
2778 
2779 struct pfi_kkif		*pf_kkif_create(int);
2780 void			 pf_kkif_free(struct pfi_kkif *);
2781 void			 pf_kkif_zero(struct pfi_kkif *);
2782 
2783 
2784 /* NAT64 functions. */
2785 int	  inet_nat64(int, const void *, void *, const void *, u_int8_t);
2786 int	  inet_nat64_inet(const void *, void *, const void *, u_int8_t);
2787 int	  inet_nat64_inet6(const void *, void *, const void *, u_int8_t);
2788 
2789 int	  inet_nat46(int, const void *, void *, const void *, u_int8_t);
2790 int	  inet_nat46_inet(const void *, void *, const void *, u_int8_t);
2791 int	  inet_nat46_inet6(const void *, void *, const void *, u_int8_t);
2792 
2793 #endif /* _KERNEL */
2794 
2795 #endif /* _NET_PFVAR_H_ */
2796