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