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