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