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