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