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