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