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