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