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