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