2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2001 Daniel Hartmeier
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
31 * $OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/counter.h>
41 #include <sys/cpuset.h>
42 #include <sys/epoch.h>
43 #include <sys/malloc.h>
45 #include <sys/refcount.h>
47 #include <sys/sysctl.h>
50 #include <sys/rmlock.h>
56 #include <net/ethernet.h>
57 #include <net/radix.h>
58 #include <netinet/in.h>
60 #include <netinet/ip.h>
61 #include <netinet/tcp.h>
62 #include <netinet/udp.h>
63 #include <netinet/ip_icmp.h>
64 #include <netinet/icmp6.h>
67 #include <netpfil/pf/pf.h>
68 #include <netpfil/pf/pf_altq.h>
69 #include <netpfil/pf/pf_mtag.h>
74 #define PF_WANT_32_TO_64_COUNTER
78 * A hybrid of 32-bit and 64-bit counters which can be used on platforms where
79 * counter(9) is very expensive.
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
85 #ifdef PF_WANT_32_TO_64_COUNTER
86 struct pf_counter_u64_pcpu {
91 struct pf_counter_u64 {
92 struct pf_counter_u64_pcpu *pfcu64_pcpu;
93 u_int64_t pfcu64_value;
98 pf_counter_u64_init(struct pf_counter_u64 *pfcu64, int flags)
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))
110 pf_counter_u64_deinit(struct pf_counter_u64 *pfcu64)
113 uma_zfree_pcpu(pcpu_zone_8, pfcu64->pfcu64_pcpu);
117 pf_counter_u64_critical_enter(void)
124 pf_counter_u64_critical_exit(void)
131 pf_counter_u64_add_protected(struct pf_counter_u64 *pfcu64, uint32_t n)
133 struct pf_counter_u64_pcpu *pcpu;
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);
143 pf_counter_u64_add(struct pf_counter_u64 *pfcu64, uint32_t n)
147 pf_counter_u64_add_protected(pfcu64, n);
151 static inline u_int64_t
152 pf_counter_u64_periodic(struct pf_counter_u64 *pfcu64)
154 struct pf_counter_u64_pcpu *pcpu;
159 MPASS(curthread->td_critnest > 0);
160 seqc_write_begin(&pfcu64->pfcu64_seqc);
161 sum = pfcu64->pfcu64_value;
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;
168 pfcu64->pfcu64_value = sum;
169 seqc_write_end(&pfcu64->pfcu64_seqc);
173 static inline u_int64_t
174 pf_counter_u64_fetch(const struct pf_counter_u64 *pfcu64)
176 struct pf_counter_u64_pcpu *pcpu;
182 seqc = seqc_read(&pfcu64->pfcu64_seqc);
185 pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
186 sum += (uint32_t)(atomic_load_int(&pcpu->current) -pcpu->snapshot);
188 sum += pfcu64->pfcu64_value;
189 if (seqc_consistent(&pfcu64->pfcu64_seqc, seqc))
196 pf_counter_u64_zero_protected(struct pf_counter_u64 *pfcu64)
198 struct pf_counter_u64_pcpu *pcpu;
201 MPASS(curthread->td_critnest > 0);
202 seqc_write_begin(&pfcu64->pfcu64_seqc);
204 pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
205 pcpu->snapshot = atomic_load_int(&pcpu->current);
207 pfcu64->pfcu64_value = 0;
208 seqc_write_end(&pfcu64->pfcu64_seqc);
212 pf_counter_u64_zero(struct pf_counter_u64 *pfcu64)
216 pf_counter_u64_zero_protected(pfcu64);
220 struct pf_counter_u64 {
221 counter_u64_t counter;
225 pf_counter_u64_init(struct pf_counter_u64 *pfcu64, int flags)
228 pfcu64->counter = counter_u64_alloc(flags);
229 if (__predict_false(pfcu64->counter == NULL))
235 pf_counter_u64_deinit(struct pf_counter_u64 *pfcu64)
238 counter_u64_free(pfcu64->counter);
242 pf_counter_u64_critical_enter(void)
248 pf_counter_u64_critical_exit(void)
254 pf_counter_u64_add_protected(struct pf_counter_u64 *pfcu64, uint32_t n)
257 counter_u64_add(pfcu64->counter, n);
261 pf_counter_u64_add(struct pf_counter_u64 *pfcu64, uint32_t n)
264 pf_counter_u64_add_protected(pfcu64, n);
267 static inline u_int64_t
268 pf_counter_u64_fetch(const struct pf_counter_u64 *pfcu64)
271 return (counter_u64_fetch(pfcu64->counter));
275 pf_counter_u64_zero_protected(struct pf_counter_u64 *pfcu64)
278 counter_u64_zero(pfcu64->counter);
282 pf_counter_u64_zero(struct pf_counter_u64 *pfcu64)
285 pf_counter_u64_zero_protected(pfcu64);
289 #define pf_get_timestamp(prule)({ \
294 __ts = *zpcpu_get_cpu(prule->timestamp, cpu); \
301 #define pf_update_timestamp(prule) \
304 *zpcpu_get((prule)->timestamp) = time_second; \
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");
311 SYSCTL_DECL(_net_pf);
312 MALLOC_DECLARE(M_PFHASH);
313 MALLOC_DECLARE(M_PF_RULE_ITEM);
315 SDT_PROVIDER_DECLARE(pf);
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_* */
333 * Address manipulation macros
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))
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)
347 #define PF_STATE_LOCK(s) \
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); \
354 #define PF_STATE_UNLOCK(s) \
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); \
362 #define PF_STATE_LOCK(s) mtx_lock(s->lock)
363 #define PF_STATE_UNLOCK(s) mtx_unlock(s->lock)
367 #define PF_STATE_LOCK_ASSERT(s) \
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); \
374 #else /* !INVARIANTS */
375 #define PF_STATE_LOCK_ASSERT(s) do {} while (0)
376 #endif /* INVARIANTS */
379 #define PF_SRC_NODE_LOCK(sn) \
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); \
387 #define PF_SRC_NODE_UNLOCK(sn) \
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); \
396 #define PF_SRC_NODE_LOCK(sn) mtx_lock((sn)->lock)
397 #define PF_SRC_NODE_UNLOCK(sn) mtx_unlock((sn)->lock)
401 #define PF_SRC_NODE_LOCK_ASSERT(sn) \
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); \
409 #else /* !INVARIANTS */
410 #define PF_SRC_NODE_LOCK_ASSERT(sn) do {} while (0)
411 #endif /* INVARIANTS */
413 extern struct mtx_padalign pf_unlnkdrules_mtx;
414 #define PF_UNLNKDRULES_LOCK() mtx_lock(&pf_unlnkdrules_mtx)
415 #define PF_UNLNKDRULES_UNLOCK() mtx_unlock(&pf_unlnkdrules_mtx)
416 #define PF_UNLNKDRULES_ASSERT() mtx_assert(&pf_unlnkdrules_mtx, MA_OWNED)
418 extern struct sx pf_config_lock;
419 #define PF_CONFIG_LOCK() sx_xlock(&pf_config_lock)
420 #define PF_CONFIG_UNLOCK() sx_xunlock(&pf_config_lock)
421 #define PF_CONFIG_ASSERT() sx_assert(&pf_config_lock, SA_XLOCKED)
423 VNET_DECLARE(struct rmlock, pf_rules_lock);
424 #define V_pf_rules_lock VNET(pf_rules_lock)
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)
436 extern struct mtx_padalign pf_table_stats_lock;
437 #define PF_TABLE_STATS_LOCK() mtx_lock(&pf_table_stats_lock)
438 #define PF_TABLE_STATS_UNLOCK() mtx_unlock(&pf_table_stats_lock)
439 #define PF_TABLE_STATS_OWNED() mtx_owned(&pf_table_stats_lock)
440 #define PF_TABLE_STATS_ASSERT() mtx_assert(&pf_table_stats_lock, MA_OWNED)
442 extern struct sx pf_end_lock;
445 #define PFLOG_MODVER 1
446 #define PFSYNC_MODVER 1
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
463 #define PF_INET6_ONLY
469 #define PF_INET_INET6
475 #define PF_INET_INET6
479 /* Both IPv4 and IPv6 */
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])) \
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]))) \
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] )) \
501 #define PF_MATCHA(n, a, m, b, f) \
502 pf_match_addr(n, a, m, b, f)
504 #define PF_ACPY(a, b, f) \
507 #define PF_AINC(a, f) \
510 #define PF_POOLMASK(a, b, c, d, f) \
511 pf_poolmask(a, b, c, d, f)
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]) \
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]) \
531 #define PF_AZERO(a, c) \
532 (!(a)->addr32[0] && \
537 #define PF_MATCHA(n, a, m, b, f) \
538 pf_match_addr(n, a, m, b, f)
540 #define PF_ACPY(a, b, f) \
543 #define PF_AINC(a, f) \
546 #define PF_POOLMASK(a, b, c, d, f) \
547 pf_poolmask(a, b, c, d, f)
554 #define PF_AEQ(a, b, c) \
555 ((a)->addr32[0] == (b)->addr32[0])
557 #define PF_ANEQ(a, b, c) \
558 ((a)->addr32[0] != (b)->addr32[0])
560 #define PF_AZERO(a, c) \
563 #define PF_MATCHA(n, a, m, b, f) \
564 pf_match_addr(n, a, m, b, f)
566 #define PF_ACPY(a, b, f) \
567 (a)->v4.s_addr = (b)->v4.s_addr
569 #define PF_AINC(a, f) \
571 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
574 #define PF_POOLMASK(a, b, c, d, f) \
576 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
577 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
580 #endif /* PF_INET_ONLY */
581 #endif /* PF_INET6_ONLY */
582 #endif /* PF_INET_INET6 */
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.
588 #define PF_MISMATCHAW(aw, x, af, neg, ifp, rtid) \
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))))) != \
608 #define PF_ALGNMNT(off) (((off) % 2) == 0)
612 struct pf_kpooladdr {
613 struct pf_addr_wrap addr;
614 TAILQ_ENTRY(pf_kpooladdr) entries;
615 char ifname[IFNAMSIZ];
616 struct pfi_kkif *kif;
619 TAILQ_HEAD(pf_kpalist, pf_kpooladdr);
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;
629 u_int16_t proxy_port[2];
633 struct pf_rule_actions {
642 uint16_t dnrpipe; /* Reverse direction pipe */
646 union pf_keth_rule_ptr {
647 struct pf_keth_rule *ptr;
651 struct pf_keth_rule_addr {
652 uint8_t addr[ETHER_ADDR_LEN];
653 uint8_t mask[ETHER_ADDR_LEN];
658 struct pf_keth_anchor;
660 TAILQ_HEAD(pf_keth_ruleq, pf_keth_rule);
662 struct pf_keth_ruleset {
663 struct pf_keth_ruleq rules[2];
664 struct pf_keth_rules {
665 struct pf_keth_ruleq *rules;
669 struct epoch_context epoch_ctx;
671 struct pf_keth_anchor *anchor;
674 RB_HEAD(pf_keth_anchor_global, pf_keth_anchor);
675 RB_HEAD(pf_keth_anchor_node, pf_keth_anchor);
676 struct pf_keth_anchor {
677 RB_ENTRY(pf_keth_anchor) entry_node;
678 RB_ENTRY(pf_keth_anchor) entry_global;
679 struct pf_keth_anchor *parent;
680 struct pf_keth_anchor_node children;
681 char name[PF_ANCHOR_NAME_SIZE];
682 char path[MAXPATHLEN];
683 struct pf_keth_ruleset ruleset;
684 int refcnt; /* anchor rules */
685 uint8_t anchor_relative;
686 uint8_t anchor_wildcard;
688 RB_PROTOTYPE(pf_keth_anchor_node, pf_keth_anchor, entry_node,
689 pf_keth_anchor_compare);
690 RB_PROTOTYPE(pf_keth_anchor_global, pf_keth_anchor, entry_global,
691 pf_keth_anchor_compare);
693 struct pf_keth_rule {
694 #define PFE_SKIP_IFP 0
695 #define PFE_SKIP_DIR 1
696 #define PFE_SKIP_PROTO 2
697 #define PFE_SKIP_SRC_ADDR 3
698 #define PFE_SKIP_DST_ADDR 4
699 #define PFE_SKIP_COUNT 5
700 union pf_keth_rule_ptr skip[PFE_SKIP_COUNT];
702 TAILQ_ENTRY(pf_keth_rule) entries;
704 struct pf_keth_anchor *anchor;
705 u_int8_t anchor_relative;
706 u_int8_t anchor_wildcard;
713 char ifname[IFNAMSIZ];
714 struct pfi_kkif *kif;
718 struct pf_keth_rule_addr src, dst;
719 struct pf_rule_addr ipsrc, ipdst;
720 char match_tagname[PF_TAG_NAME_SIZE];
726 counter_u64_t evaluations;
727 counter_u64_t packets[2];
728 counter_u64_t bytes[2];
732 char qname[PF_QNAME_SIZE];
734 char tagname[PF_TAG_NAME_SIZE];
736 char bridge_to_name[IFNAMSIZ];
737 struct pfi_kkif *bridge_to;
742 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
743 uint32_t ridentifier;
747 struct pf_krule *ptr;
751 RB_HEAD(pf_krule_global, pf_krule);
752 RB_PROTOTYPE(pf_krule_global, pf_krule, entry_global, pf_krule_compare);
755 struct pf_rule_addr src;
756 struct pf_rule_addr dst;
757 union pf_krule_ptr skip[PF_SKIP_COUNT];
758 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
759 uint32_t ridentifier;
760 char ifname[IFNAMSIZ];
761 char qname[PF_QNAME_SIZE];
762 char pqname[PF_QNAME_SIZE];
763 char tagname[PF_TAG_NAME_SIZE];
764 char match_tagname[PF_TAG_NAME_SIZE];
766 char overload_tblname[PF_TABLE_NAME_SIZE];
768 TAILQ_ENTRY(pf_krule) entries;
769 struct pf_kpool rpool;
771 struct pf_counter_u64 evaluations;
772 struct pf_counter_u64 packets[2];
773 struct pf_counter_u64 bytes[2];
776 struct pfi_kkif *kif;
777 struct pf_kanchor *anchor;
778 struct pfr_ktable *overload_tbl;
780 pf_osfp_t os_fingerprint;
783 u_int32_t timeout[PFTM_MAX];
784 u_int32_t max_states;
785 u_int32_t max_src_nodes;
786 u_int32_t max_src_states;
787 u_int32_t max_src_conn;
796 u_int32_t free_flags;
802 counter_u64_t states_cur;
803 counter_u64_t states_tot;
804 counter_u64_t src_nodes;
806 u_int16_t return_icmp;
807 u_int16_t return_icmp6;
811 u_int16_t scrub_flags;
813 struct pf_rule_uid uid;
814 struct pf_rule_gid gid;
824 u_int8_t match_tag_not;
840 u_int8_t anchor_relative;
841 u_int8_t anchor_wildcard;
845 u_int8_t set_prio[2];
851 u_int8_t md5sum[PF_MD5_DIGEST_LENGTH];
852 RB_ENTRY(pf_krule) entry_global;
854 #ifdef PF_WANT_32_TO_64_COUNTER
855 LIST_ENTRY(pf_krule) allrulelist;
860 struct pf_krule_item {
861 SLIST_ENTRY(pf_krule_item) entry;
865 SLIST_HEAD(pf_krule_slist, pf_krule_item);
867 struct pf_ksrc_node {
868 LIST_ENTRY(pf_ksrc_node) entry;
870 struct pf_addr raddr;
871 struct pf_krule_slist match_rules;
872 union pf_krule_ptr rule;
873 struct pfi_kkif *kif;
874 counter_u64_t bytes[2];
875 counter_u64_t packets[2];
878 struct pf_threshold conn_rate;
887 struct pf_state_scrub {
888 struct timeval pfss_last; /* time received last packet */
889 u_int32_t pfss_tsecr; /* last echoed timestamp */
890 u_int32_t pfss_tsval; /* largest timestamp */
891 u_int32_t pfss_tsval0; /* original timestamp */
892 u_int16_t pfss_flags;
893 #define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
894 #define PFSS_PAWS 0x0010 /* stricter PAWS checks */
895 #define PFSS_PAWS_IDLED 0x0020 /* was idle too long. no PAWS */
896 #define PFSS_DATA_TS 0x0040 /* timestamp on data packets */
897 #define PFSS_DATA_NOTS 0x0080 /* no timestamp on data packets */
898 u_int8_t pfss_ttl; /* stashed TTL */
900 u_int32_t pfss_ts_mod; /* timestamp modulation */
903 struct pf_state_host {
909 struct pf_state_peer {
910 struct pf_state_scrub *scrub; /* state is scrubbed */
911 u_int32_t seqlo; /* Max sequence number sent */
912 u_int32_t seqhi; /* Max the other end ACKd + win */
913 u_int32_t seqdiff; /* Sequence number modulator */
914 u_int16_t max_win; /* largest window (pre scaling) */
915 u_int16_t mss; /* Maximum segment size option */
916 u_int8_t state; /* active state level */
917 u_int8_t wscale; /* window scaling factor */
918 u_int8_t tcp_est; /* Did we reach TCPS_ESTABLISHED */
922 /* Keep synced with struct pf_state_key. */
923 struct pf_state_key_cmp {
924 struct pf_addr addr[2];
931 struct pf_state_key {
932 struct pf_addr addr[2];
938 LIST_ENTRY(pf_state_key) entry;
939 TAILQ_HEAD(, pf_kstate) states[2];
942 /* Keep synced with struct pf_kstate. */
943 struct pf_state_cmp {
950 struct pf_state_scrub_export {
952 uint8_t pfss_ttl; /* stashed TTL */
953 #define PF_SCRUB_FLAG_VALID 0x01
955 uint32_t pfss_ts_mod; /* timestamp modulation */
958 struct pf_state_key_export {
959 struct pf_addr addr[2];
963 struct pf_state_peer_export {
964 struct pf_state_scrub_export scrub; /* state is scrubbed */
965 uint32_t seqlo; /* Max sequence number sent */
966 uint32_t seqhi; /* Max the other end ACKd + win */
967 uint32_t seqdiff; /* Sequence number modulator */
968 uint16_t max_win; /* largest window (pre scaling) */
969 uint16_t mss; /* Maximum segment size option */
970 uint8_t state; /* active state level */
971 uint8_t wscale; /* window scaling factor */
974 _Static_assert(sizeof(struct pf_state_peer_export) == 32, "size incorrect");
976 struct pf_state_export {
978 #define PF_STATE_VERSION 20210706
980 char ifname[IFNAMSIZ];
981 char orig_ifname[IFNAMSIZ];
982 struct pf_state_key_export key[2];
983 struct pf_state_peer_export src;
984 struct pf_state_peer_export dst;
985 struct pf_addr rt_addr;
1000 uint8_t state_flags_compat;
1004 uint16_t state_flags;
1008 _Static_assert(sizeof(struct pf_state_export) == 384, "size incorrect");
1013 * Area shared with pf_state_cmp
1016 u_int32_t creatorid;
1023 u_int16_t state_flags;
1025 u_int8_t sync_state; /* PFSYNC_S_x */
1026 u_int8_t sync_updates; /* XXX */
1029 TAILQ_ENTRY(pf_kstate) sync_list;
1030 TAILQ_ENTRY(pf_kstate) key_list[2];
1031 LIST_ENTRY(pf_kstate) entry;
1032 struct pf_state_peer src;
1033 struct pf_state_peer dst;
1034 struct pf_krule_slist match_rules;
1035 union pf_krule_ptr rule;
1036 union pf_krule_ptr anchor;
1037 union pf_krule_ptr nat_rule;
1038 struct pf_addr rt_addr;
1039 struct pf_state_key *key[2]; /* addresses stack and wire */
1040 struct pfi_kkif *kif;
1041 struct pfi_kkif *orig_kif; /* The real kif, even if we're a floating state (i.e. if == V_pfi_all). */
1042 struct pfi_kkif *rt_kif;
1043 struct pf_ksrc_node *src_node;
1044 struct pf_ksrc_node *nat_src_node;
1045 u_int64_t packets[2];
1049 u_int32_t pfsync_time;
1063 * Size <= fits 12 objects per page on LP64. Try to not grow the struct beyond that.
1065 _Static_assert(sizeof(struct pf_kstate) <= 336, "pf_kstate size crosses 336 bytes");
1069 * Unified state structures for pulling states out of the kernel
1070 * used by pfsync(4) and the pf(4) ioctl.
1072 struct pfsync_state_scrub {
1073 u_int16_t pfss_flags;
1074 u_int8_t pfss_ttl; /* stashed TTL */
1075 #define PFSYNC_SCRUB_FLAG_VALID 0x01
1076 u_int8_t scrub_flag;
1077 u_int32_t pfss_ts_mod; /* timestamp modulation */
1080 struct pfsync_state_peer {
1081 struct pfsync_state_scrub scrub; /* state is scrubbed */
1082 u_int32_t seqlo; /* Max sequence number sent */
1083 u_int32_t seqhi; /* Max the other end ACKd + win */
1084 u_int32_t seqdiff; /* Sequence number modulator */
1085 u_int16_t max_win; /* largest window (pre scaling) */
1086 u_int16_t mss; /* Maximum segment size option */
1087 u_int8_t state; /* active state level */
1088 u_int8_t wscale; /* window scaling factor */
1092 struct pfsync_state_key {
1093 struct pf_addr addr[2];
1097 struct pfsync_state {
1099 char ifname[IFNAMSIZ];
1100 struct pfsync_state_key key[2];
1101 struct pfsync_state_peer src;
1102 struct pfsync_state_peer dst;
1103 struct pf_addr rt_addr;
1109 u_int32_t packets[2][2];
1110 u_int32_t bytes[2][2];
1111 u_int32_t creatorid;
1115 u_int16_t state_flags;
1117 u_int8_t state_flags_compat;
1119 u_int8_t sync_flags;
1125 typedef int pfsync_state_import_t(struct pfsync_state *, int);
1126 typedef void pfsync_insert_state_t(struct pf_kstate *);
1127 typedef void pfsync_update_state_t(struct pf_kstate *);
1128 typedef void pfsync_delete_state_t(struct pf_kstate *);
1129 typedef void pfsync_clear_states_t(u_int32_t, const char *);
1130 typedef int pfsync_defer_t(struct pf_kstate *, struct mbuf *);
1131 typedef void pfsync_detach_ifnet_t(struct ifnet *);
1133 VNET_DECLARE(pfsync_state_import_t *, pfsync_state_import_ptr);
1134 #define V_pfsync_state_import_ptr VNET(pfsync_state_import_ptr)
1135 VNET_DECLARE(pfsync_insert_state_t *, pfsync_insert_state_ptr);
1136 #define V_pfsync_insert_state_ptr VNET(pfsync_insert_state_ptr)
1137 VNET_DECLARE(pfsync_update_state_t *, pfsync_update_state_ptr);
1138 #define V_pfsync_update_state_ptr VNET(pfsync_update_state_ptr)
1139 VNET_DECLARE(pfsync_delete_state_t *, pfsync_delete_state_ptr);
1140 #define V_pfsync_delete_state_ptr VNET(pfsync_delete_state_ptr)
1141 VNET_DECLARE(pfsync_clear_states_t *, pfsync_clear_states_ptr);
1142 #define V_pfsync_clear_states_ptr VNET(pfsync_clear_states_ptr)
1143 VNET_DECLARE(pfsync_defer_t *, pfsync_defer_ptr);
1144 #define V_pfsync_defer_ptr VNET(pfsync_defer_ptr)
1145 extern pfsync_detach_ifnet_t *pfsync_detach_ifnet_ptr;
1147 void pfsync_state_export(struct pfsync_state *,
1148 struct pf_kstate *);
1149 void pf_state_export(struct pf_state_export *,
1150 struct pf_kstate *);
1155 typedef int pflog_packet_t(struct pfi_kkif *, struct mbuf *, sa_family_t,
1156 u_int8_t, u_int8_t, struct pf_krule *, struct pf_krule *,
1157 struct pf_kruleset *, struct pf_pdesc *, int);
1158 extern pflog_packet_t *pflog_packet_ptr;
1160 #endif /* _KERNEL */
1162 #define PFSYNC_FLAG_SRCNODE 0x04
1163 #define PFSYNC_FLAG_NATSRCNODE 0x08
1165 /* for copies to/from network byte order */
1166 /* ioctl interface also uses network byte order */
1167 #define pf_state_peer_hton(s,d) do { \
1168 (d)->seqlo = htonl((s)->seqlo); \
1169 (d)->seqhi = htonl((s)->seqhi); \
1170 (d)->seqdiff = htonl((s)->seqdiff); \
1171 (d)->max_win = htons((s)->max_win); \
1172 (d)->mss = htons((s)->mss); \
1173 (d)->state = (s)->state; \
1174 (d)->wscale = (s)->wscale; \
1176 (d)->scrub.pfss_flags = \
1177 htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP); \
1178 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl; \
1179 (d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
1180 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID; \
1184 #define pf_state_peer_ntoh(s,d) do { \
1185 (d)->seqlo = ntohl((s)->seqlo); \
1186 (d)->seqhi = ntohl((s)->seqhi); \
1187 (d)->seqdiff = ntohl((s)->seqdiff); \
1188 (d)->max_win = ntohs((s)->max_win); \
1189 (d)->mss = ntohs((s)->mss); \
1190 (d)->state = (s)->state; \
1191 (d)->wscale = (s)->wscale; \
1192 if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && \
1193 (d)->scrub != NULL) { \
1194 (d)->scrub->pfss_flags = \
1195 ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP; \
1196 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl; \
1197 (d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
1201 #define pf_state_counter_hton(s,d) do { \
1202 d[0] = htonl((s>>32)&0xffffffff); \
1203 d[1] = htonl(s&0xffffffff); \
1206 #define pf_state_counter_from_pfsync(s) \
1207 (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
1209 #define pf_state_counter_ntoh(s,d) do { \
1215 TAILQ_HEAD(pf_krulequeue, pf_krule);
1219 struct pf_kruleset {
1221 struct pf_krulequeue queues[2];
1223 struct pf_krulequeue *ptr;
1224 struct pf_krule **ptr_array;
1228 struct pf_krule_global *tree;
1230 } rules[PF_RULESET_MAX];
1231 struct pf_kanchor *anchor;
1237 RB_HEAD(pf_kanchor_global, pf_kanchor);
1238 RB_HEAD(pf_kanchor_node, pf_kanchor);
1240 RB_ENTRY(pf_kanchor) entry_global;
1241 RB_ENTRY(pf_kanchor) entry_node;
1242 struct pf_kanchor *parent;
1243 struct pf_kanchor_node children;
1244 char name[PF_ANCHOR_NAME_SIZE];
1245 char path[MAXPATHLEN];
1246 struct pf_kruleset ruleset;
1247 int refcnt; /* anchor rules */
1249 RB_PROTOTYPE(pf_kanchor_global, pf_kanchor, entry_global, pf_anchor_compare);
1250 RB_PROTOTYPE(pf_kanchor_node, pf_kanchor, entry_node, pf_kanchor_compare);
1252 #define PF_RESERVED_ANCHOR "_pf"
1254 #define PFR_TFLAG_PERSIST 0x00000001
1255 #define PFR_TFLAG_CONST 0x00000002
1256 #define PFR_TFLAG_ACTIVE 0x00000004
1257 #define PFR_TFLAG_INACTIVE 0x00000008
1258 #define PFR_TFLAG_REFERENCED 0x00000010
1259 #define PFR_TFLAG_REFDANCHOR 0x00000020
1260 #define PFR_TFLAG_COUNTERS 0x00000040
1261 /* Adjust masks below when adding flags. */
1262 #define PFR_TFLAG_USRMASK (PFR_TFLAG_PERSIST | \
1265 #define PFR_TFLAG_SETMASK (PFR_TFLAG_ACTIVE | \
1266 PFR_TFLAG_INACTIVE | \
1267 PFR_TFLAG_REFERENCED | \
1268 PFR_TFLAG_REFDANCHOR)
1269 #define PFR_TFLAG_ALLMASK (PFR_TFLAG_PERSIST | \
1271 PFR_TFLAG_ACTIVE | \
1272 PFR_TFLAG_INACTIVE | \
1273 PFR_TFLAG_REFERENCED | \
1274 PFR_TFLAG_REFDANCHOR | \
1277 struct pf_kanchor_stackframe;
1278 struct pf_keth_anchor_stackframe;
1281 char pfrt_anchor[MAXPATHLEN];
1282 char pfrt_name[PF_TABLE_NAME_SIZE];
1283 u_int32_t pfrt_flags;
1284 u_int8_t pfrt_fback;
1287 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1288 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1289 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1293 struct in_addr _pfra_ip4addr;
1294 struct in6_addr _pfra_ip6addr;
1299 u_int8_t pfra_fback;
1301 #define pfra_ip4addr pfra_u._pfra_ip4addr
1302 #define pfra_ip6addr pfra_u._pfra_ip6addr
1304 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1305 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1306 enum { PFR_TYPE_PACKETS, PFR_TYPE_BYTES, PFR_TYPE_MAX };
1307 #define PFR_NUM_COUNTERS (PFR_DIR_MAX * PFR_OP_ADDR_MAX * PFR_TYPE_MAX)
1308 #define PFR_OP_XPASS PFR_OP_ADDR_MAX
1311 struct pfr_addr pfras_a;
1312 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1313 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1317 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1320 struct pfr_table pfrts_t;
1321 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1322 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1323 u_int64_t pfrts_match;
1324 u_int64_t pfrts_nomatch;
1327 int pfrts_refcnt[PFR_REFCNT_MAX];
1332 struct pfr_kstate_counter {
1333 counter_u64_t pkc_pcpu;
1338 pfr_kstate_counter_init(struct pfr_kstate_counter *pfrc, int flags)
1342 pfrc->pkc_pcpu = counter_u64_alloc(flags);
1343 if (pfrc->pkc_pcpu == NULL)
1349 pfr_kstate_counter_deinit(struct pfr_kstate_counter *pfrc)
1352 counter_u64_free(pfrc->pkc_pcpu);
1355 static inline u_int64_t
1356 pfr_kstate_counter_fetch(struct pfr_kstate_counter *pfrc)
1360 c = counter_u64_fetch(pfrc->pkc_pcpu);
1361 c -= pfrc->pkc_zero;
1366 pfr_kstate_counter_zero(struct pfr_kstate_counter *pfrc)
1370 c = counter_u64_fetch(pfrc->pkc_pcpu);
1375 pfr_kstate_counter_add(struct pfr_kstate_counter *pfrc, int64_t n)
1378 counter_u64_add(pfrc->pkc_pcpu, n);
1381 struct pfr_ktstats {
1382 struct pfr_table pfrts_t;
1383 struct pfr_kstate_counter pfrkts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1384 struct pfr_kstate_counter pfrkts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1385 struct pfr_kstate_counter pfrkts_match;
1386 struct pfr_kstate_counter pfrkts_nomatch;
1389 int pfrkts_refcnt[PFR_REFCNT_MAX];
1392 #endif /* _KERNEL */
1394 #define pfrts_name pfrts_t.pfrt_name
1395 #define pfrts_flags pfrts_t.pfrt_flags
1397 #ifndef _SOCKADDR_UNION_DEFINED
1398 #define _SOCKADDR_UNION_DEFINED
1399 union sockaddr_union {
1401 struct sockaddr_in sin;
1402 struct sockaddr_in6 sin6;
1404 #endif /* _SOCKADDR_UNION_DEFINED */
1406 struct pfr_kcounters {
1407 counter_u64_t pfrkc_counters;
1410 #define pfr_kentry_counter(kc, dir, op, t) \
1411 ((kc)->pfrkc_counters + \
1412 (dir) * PFR_OP_ADDR_MAX * PFR_TYPE_MAX + (op) * PFR_TYPE_MAX + (t))
1415 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1417 struct radix_node pfrke_node[2];
1418 union sockaddr_union pfrke_sa;
1419 SLIST_ENTRY(pfr_kentry) pfrke_workq;
1420 struct pfr_kcounters pfrke_counters;
1424 u_int8_t pfrke_mark;
1427 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1428 RB_HEAD(pfr_ktablehead, pfr_ktable);
1430 struct pfr_ktstats pfrkt_kts;
1431 RB_ENTRY(pfr_ktable) pfrkt_tree;
1432 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
1433 struct radix_node_head *pfrkt_ip4;
1434 struct radix_node_head *pfrkt_ip6;
1435 struct pfr_ktable *pfrkt_shadow;
1436 struct pfr_ktable *pfrkt_root;
1437 struct pf_kruleset *pfrkt_rs;
1441 #define pfrkt_t pfrkt_kts.pfrts_t
1442 #define pfrkt_name pfrkt_t.pfrt_name
1443 #define pfrkt_anchor pfrkt_t.pfrt_anchor
1444 #define pfrkt_ruleset pfrkt_t.pfrt_ruleset
1445 #define pfrkt_flags pfrkt_t.pfrt_flags
1446 #define pfrkt_cnt pfrkt_kts.pfrkts_cnt
1447 #define pfrkt_refcnt pfrkt_kts.pfrkts_refcnt
1448 #define pfrkt_packets pfrkt_kts.pfrkts_packets
1449 #define pfrkt_bytes pfrkt_kts.pfrkts_bytes
1450 #define pfrkt_match pfrkt_kts.pfrkts_match
1451 #define pfrkt_nomatch pfrkt_kts.pfrkts_nomatch
1452 #define pfrkt_tzero pfrkt_kts.pfrkts_tzero
1457 char pfik_name[IFNAMSIZ];
1459 RB_ENTRY(pfi_kkif) _pfik_tree;
1460 LIST_ENTRY(pfi_kkif) _pfik_list;
1462 #define pfik_tree _pfik_glue._pfik_tree
1463 #define pfik_list _pfik_glue._pfik_list
1464 struct pf_counter_u64 pfik_packets[2][2][2];
1465 struct pf_counter_u64 pfik_bytes[2][2][2];
1466 u_int32_t pfik_tzero;
1468 struct ifnet *pfik_ifp;
1469 struct ifg_group *pfik_group;
1470 u_int pfik_rulerefs;
1471 TAILQ_HEAD(, pfi_dynaddr) pfik_dynaddrs;
1472 #ifdef PF_WANT_32_TO_64_COUNTER
1473 LIST_ENTRY(pfi_kkif) pfik_allkiflist;
1478 #define PFI_IFLAG_REFS 0x0001 /* has state references */
1479 #define PFI_IFLAG_SKIP 0x0100 /* skip filtering on interface */
1488 u_int64_t tot_len; /* Make Mickey money */
1494 struct icmp6_hdr icmp6;
1499 struct pf_krule *nat_rule; /* nat/rdr rule applied to packet */
1500 struct pf_addr *src; /* src address */
1501 struct pf_addr *dst; /* dst address */
1504 struct pf_mtag *pf_mtag;
1505 struct pf_rule_actions act;
1507 u_int32_t p_len; /* total length of payload */
1510 u_int16_t *proto_sum;
1511 u_int16_t flags; /* Let SCRUB trigger behavior in
1512 * state code. Easier than tags */
1513 #define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */
1514 #define PFDESC_IP_REAS 0x0002 /* IP frags would've been reassembled */
1518 u_int8_t dir; /* direction */
1519 u_int8_t sidx; /* key index for source */
1520 u_int8_t didx; /* key index for destination */
1524 /* flags for RDR options */
1525 #define PF_DPORT_RANGE 0x01 /* Dest port uses range */
1526 #define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
1528 /* UDP state enumeration */
1529 #define PFUDPS_NO_TRAFFIC 0
1530 #define PFUDPS_SINGLE 1
1531 #define PFUDPS_MULTIPLE 2
1533 #define PFUDPS_NSTATES 3 /* number of state levels */
1535 #define PFUDPS_NAMES { \
1542 /* Other protocol state enumeration */
1543 #define PFOTHERS_NO_TRAFFIC 0
1544 #define PFOTHERS_SINGLE 1
1545 #define PFOTHERS_MULTIPLE 2
1547 #define PFOTHERS_NSTATES 3 /* number of state levels */
1549 #define PFOTHERS_NAMES { \
1556 #define ACTION_SET(a, x) \
1562 #define REASON_SET(a, x) \
1566 if (x < PFRES_MAX) \
1567 counter_u64_add(V_pf_status.counters[x], 1); \
1570 enum pf_syncookies_mode {
1571 PF_SYNCOOKIES_NEVER = 0,
1572 PF_SYNCOOKIES_ALWAYS = 1,
1573 PF_SYNCOOKIES_ADAPTIVE = 2,
1574 PF_SYNCOOKIES_MODE_MAX = PF_SYNCOOKIES_ADAPTIVE
1577 #define PF_SYNCOOKIES_HIWATPCT 25
1578 #define PF_SYNCOOKIES_LOWATPCT (PF_SYNCOOKIES_HIWATPCT / 2)
1582 counter_u64_t counters[PFRES_MAX]; /* reason for passing/dropping */
1583 counter_u64_t lcounters[KLCNT_MAX]; /* limit counters */
1584 struct pf_counter_u64 fcounters[FCNT_MAX]; /* state operation counters */
1585 counter_u64_t scounters[SCNT_MAX]; /* src_node operation counters */
1592 char ifname[IFNAMSIZ];
1593 uint8_t pf_chksum[PF_MD5_DIGEST_LENGTH];
1595 enum pf_syncookies_mode syncookies_mode;
1596 bool syncookies_active;
1597 uint64_t syncookies_inflight[2];
1598 uint32_t states_halfopen;
1605 struct in_addr ipv4;
1606 struct in6_addr ipv6;
1611 #define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */
1612 #define PFR_KENTRY_HIWAT 200000 /* Number of table entries */
1615 * Limit the length of the fragment queue traversal. Remember
1616 * search entry points based on the fragment offset.
1618 #define PF_FRAG_ENTRY_POINTS 16
1621 * The number of entries in the fragment queue must be limited
1622 * to avoid DoS by linear searching. Instead of a global limit,
1623 * use a limit per entry point. For large packets these sum up.
1625 #define PF_FRAG_ENTRY_LIMIT 64
1628 * ioctl parameter structures
1631 struct pfioc_pooladdr {
1639 char anchor[MAXPATHLEN];
1640 struct pf_pooladdr addr;
1646 u_int32_t pool_ticket;
1648 char anchor[MAXPATHLEN];
1649 char anchor_call[MAXPATHLEN];
1650 struct pf_rule rule;
1653 struct pfioc_natlook {
1654 struct pf_addr saddr;
1655 struct pf_addr daddr;
1656 struct pf_addr rsaddr;
1657 struct pf_addr rdaddr;
1667 struct pfioc_state {
1668 struct pfsync_state state;
1671 struct pfioc_src_node_kill {
1672 sa_family_t psnk_af;
1673 struct pf_rule_addr psnk_src;
1674 struct pf_rule_addr psnk_dst;
1679 struct pf_kstate_kill {
1680 struct pf_state_cmp psk_pfcmp;
1683 struct pf_rule_addr psk_src;
1684 struct pf_rule_addr psk_dst;
1685 struct pf_rule_addr psk_rt_addr;
1686 char psk_ifname[IFNAMSIZ];
1687 char psk_label[PF_RULE_LABEL_SIZE];
1689 bool psk_kill_match;
1693 struct pfioc_state_kill {
1694 struct pf_state_cmp psk_pfcmp;
1697 struct pf_rule_addr psk_src;
1698 struct pf_rule_addr psk_dst;
1699 char psk_ifname[IFNAMSIZ];
1700 char psk_label[PF_RULE_LABEL_SIZE];
1704 struct pfioc_states {
1708 struct pfsync_state *psu_states;
1710 #define ps_buf ps_u.psu_buf
1711 #define ps_states ps_u.psu_states
1714 struct pfioc_states_v2 {
1716 uint64_t ps_req_version;
1719 struct pf_state_export *psu_states;
1721 #define ps_buf ps_u.psu_buf
1722 #define ps_states ps_u.psu_states
1725 struct pfioc_src_nodes {
1729 struct pf_src_node *psu_src_nodes;
1731 #define psn_buf psn_u.psu_buf
1732 #define psn_src_nodes psn_u.psu_src_nodes
1736 char ifname[IFNAMSIZ];
1744 struct pfioc_limit {
1749 struct pfioc_altq_v0 {
1753 struct pf_altq_v0 altq;
1756 struct pfioc_altq_v1 {
1761 * Placed here so code that only uses the above parameters can be
1762 * written entirely in terms of the v0 or v1 type.
1765 struct pf_altq_v1 altq;
1769 * Latest version of struct pfioc_altq_vX. This must move in lock-step with
1770 * the latest version of struct pf_altq_vX as it has that struct as a
1773 #define PFIOC_ALTQ_VERSION PF_ALTQ_VERSION
1775 struct pfioc_qstats_v0 {
1783 struct pfioc_qstats_v1 {
1790 * Placed here so code that only uses the above parameters can be
1791 * written entirely in terms of the v0 or v1 type.
1793 u_int32_t version; /* Requested version of stats struct */
1796 /* Latest version of struct pfioc_qstats_vX */
1797 #define PFIOC_QSTATS_VERSION 1
1799 struct pfioc_ruleset {
1801 char path[MAXPATHLEN];
1802 char name[PF_ANCHOR_NAME_SIZE];
1805 #define PF_RULESET_ALTQ (PF_RULESET_MAX)
1806 #define PF_RULESET_TABLE (PF_RULESET_MAX+1)
1807 #define PF_RULESET_ETH (PF_RULESET_MAX+2)
1808 struct pfioc_trans {
1809 int size; /* number of elements */
1810 int esize; /* size of each element in bytes */
1811 struct pfioc_trans_e {
1813 char anchor[MAXPATHLEN];
1818 #define PFR_FLAG_ATOMIC 0x00000001 /* unused */
1819 #define PFR_FLAG_DUMMY 0x00000002
1820 #define PFR_FLAG_FEEDBACK 0x00000004
1821 #define PFR_FLAG_CLSTATS 0x00000008
1822 #define PFR_FLAG_ADDRSTOO 0x00000010
1823 #define PFR_FLAG_REPLACE 0x00000020
1824 #define PFR_FLAG_ALLRSETS 0x00000040
1825 #define PFR_FLAG_ALLMASK 0x0000007F
1827 #define PFR_FLAG_USERIOCTL 0x10000000
1830 struct pfioc_table {
1831 struct pfr_table pfrio_table;
1840 u_int32_t pfrio_ticket;
1842 #define pfrio_exists pfrio_nadd
1843 #define pfrio_nzero pfrio_nadd
1844 #define pfrio_nmatch pfrio_nadd
1845 #define pfrio_naddr pfrio_size2
1846 #define pfrio_setflag pfrio_size2
1847 #define pfrio_clrflag pfrio_nadd
1849 struct pfioc_iface {
1850 char pfiio_name[IFNAMSIZ];
1862 #define DIOCSTART _IO ('D', 1)
1863 #define DIOCSTOP _IO ('D', 2)
1864 #define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
1865 #define DIOCADDRULENV _IOWR('D', 4, struct pfioc_nv)
1866 #define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
1867 #define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule)
1868 #define DIOCGETRULENV _IOWR('D', 7, struct pfioc_nv)
1869 /* XXX cut 8 - 17 */
1870 #define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill)
1871 #define DIOCCLRSTATESNV _IOWR('D', 18, struct pfioc_nv)
1872 #define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
1873 #define DIOCGETSTATENV _IOWR('D', 19, struct pfioc_nv)
1874 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1875 #define DIOCGETSTATUS _IOWR('D', 21, struct pf_status)
1876 #define DIOCGETSTATUSNV _IOWR('D', 21, struct pfioc_nv)
1877 #define DIOCCLRSTATUS _IO ('D', 22)
1878 #define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
1879 #define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
1880 #define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
1881 #define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
1882 /* XXX cut 26 - 28 */
1883 #define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
1884 #define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
1885 #define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
1886 #define DIOCCLRRULECTRS _IO ('D', 38)
1887 #define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
1888 #define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
1889 #define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill)
1890 #define DIOCKILLSTATESNV _IOWR('D', 41, struct pfioc_nv)
1891 #define DIOCSTARTALTQ _IO ('D', 42)
1892 #define DIOCSTOPALTQ _IO ('D', 43)
1893 #define DIOCADDALTQV0 _IOWR('D', 45, struct pfioc_altq_v0)
1894 #define DIOCADDALTQV1 _IOWR('D', 45, struct pfioc_altq_v1)
1895 #define DIOCGETALTQSV0 _IOWR('D', 47, struct pfioc_altq_v0)
1896 #define DIOCGETALTQSV1 _IOWR('D', 47, struct pfioc_altq_v1)
1897 #define DIOCGETALTQV0 _IOWR('D', 48, struct pfioc_altq_v0)
1898 #define DIOCGETALTQV1 _IOWR('D', 48, struct pfioc_altq_v1)
1899 #define DIOCCHANGEALTQV0 _IOWR('D', 49, struct pfioc_altq_v0)
1900 #define DIOCCHANGEALTQV1 _IOWR('D', 49, struct pfioc_altq_v1)
1901 #define DIOCGETQSTATSV0 _IOWR('D', 50, struct pfioc_qstats_v0)
1902 #define DIOCGETQSTATSV1 _IOWR('D', 50, struct pfioc_qstats_v1)
1903 #define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr)
1904 #define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr)
1905 #define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr)
1906 #define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr)
1907 #define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr)
1908 /* XXX cut 55 - 57 */
1909 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1910 #define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
1911 #define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
1912 #define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
1913 #define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
1914 #define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
1915 #define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
1916 #define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
1917 #define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
1918 #define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
1919 #define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
1920 #define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
1921 #define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
1922 #define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
1923 #define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
1924 #define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
1925 #define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
1926 #define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
1927 #define DIOCOSFPFLUSH _IO('D', 78)
1928 #define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
1929 #define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
1930 #define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
1931 #define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
1932 #define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
1933 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1934 #define DIOCCLRSRCNODES _IO('D', 85)
1935 #define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
1936 #define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
1937 #define DIOCSETIFFLAG _IOWR('D', 89, struct pfioc_iface)
1938 #define DIOCCLRIFFLAG _IOWR('D', 90, struct pfioc_iface)
1939 #define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill)
1940 #define DIOCGIFSPEEDV0 _IOWR('D', 92, struct pf_ifspeed_v0)
1941 #define DIOCGIFSPEEDV1 _IOWR('D', 92, struct pf_ifspeed_v1)
1942 #define DIOCGETSTATESV2 _IOWR('D', 93, struct pfioc_states_v2)
1943 #define DIOCGETSYNCOOKIES _IOWR('D', 94, struct pfioc_nv)
1944 #define DIOCSETSYNCOOKIES _IOWR('D', 95, struct pfioc_nv)
1945 #define DIOCKEEPCOUNTERS _IOWR('D', 96, struct pfioc_nv)
1946 #define DIOCKEEPCOUNTERS_FREEBSD13 _IOWR('D', 92, struct pfioc_nv)
1947 #define DIOCADDETHRULE _IOWR('D', 97, struct pfioc_nv)
1948 #define DIOCGETETHRULE _IOWR('D', 98, struct pfioc_nv)
1949 #define DIOCGETETHRULES _IOWR('D', 99, struct pfioc_nv)
1950 #define DIOCGETETHRULESETS _IOWR('D', 100, struct pfioc_nv)
1951 #define DIOCGETETHRULESET _IOWR('D', 101, struct pfioc_nv)
1952 #define DIOCSETREASS _IOWR('D', 102, u_int32_t)
1954 struct pf_ifspeed_v0 {
1955 char ifname[IFNAMSIZ];
1959 struct pf_ifspeed_v1 {
1960 char ifname[IFNAMSIZ];
1961 u_int32_t baudrate32;
1962 /* layout identical to struct pf_ifspeed_v0 up to this point */
1966 /* Latest version of struct pf_ifspeed_vX */
1967 #define PF_IFSPEED_VERSION 1
1970 * Compatibility and convenience macros
1973 #ifdef PFIOC_USE_LATEST
1975 * Maintaining in-tree consumers of the ioctl interface is easier when that
1976 * code can be written in terms old names that refer to the latest interface
1977 * version as that reduces the required changes in the consumers to those
1978 * that are functionally necessary to accommodate a new interface version.
1980 #define pfioc_altq __CONCAT(pfioc_altq_v, PFIOC_ALTQ_VERSION)
1981 #define pfioc_qstats __CONCAT(pfioc_qstats_v, PFIOC_QSTATS_VERSION)
1982 #define pf_ifspeed __CONCAT(pf_ifspeed_v, PF_IFSPEED_VERSION)
1984 #define DIOCADDALTQ __CONCAT(DIOCADDALTQV, PFIOC_ALTQ_VERSION)
1985 #define DIOCGETALTQS __CONCAT(DIOCGETALTQSV, PFIOC_ALTQ_VERSION)
1986 #define DIOCGETALTQ __CONCAT(DIOCGETALTQV, PFIOC_ALTQ_VERSION)
1987 #define DIOCCHANGEALTQ __CONCAT(DIOCCHANGEALTQV, PFIOC_ALTQ_VERSION)
1988 #define DIOCGETQSTATS __CONCAT(DIOCGETQSTATSV, PFIOC_QSTATS_VERSION)
1989 #define DIOCGIFSPEED __CONCAT(DIOCGIFSPEEDV, PF_IFSPEED_VERSION)
1992 * When building out-of-tree code that is written for the old interface,
1993 * such as may exist in ports for example, resolve the old struct tags and
1994 * ioctl command names to the v0 versions.
1996 #define pfioc_altq __CONCAT(pfioc_altq_v, 0)
1997 #define pfioc_qstats __CONCAT(pfioc_qstats_v, 0)
1998 #define pf_ifspeed __CONCAT(pf_ifspeed_v, 0)
2000 #define DIOCADDALTQ __CONCAT(DIOCADDALTQV, 0)
2001 #define DIOCGETALTQS __CONCAT(DIOCGETALTQSV, 0)
2002 #define DIOCGETALTQ __CONCAT(DIOCGETALTQV, 0)
2003 #define DIOCCHANGEALTQ __CONCAT(DIOCCHANGEALTQV, 0)
2004 #define DIOCGETQSTATS __CONCAT(DIOCGETQSTATSV, 0)
2005 #define DIOCGIFSPEED __CONCAT(DIOCGIFSPEEDV, 0)
2006 #endif /* PFIOC_USE_LATEST */
2007 #endif /* _KERNEL */
2010 LIST_HEAD(pf_ksrc_node_list, pf_ksrc_node);
2012 struct pf_ksrc_node_list nodes;
2017 LIST_HEAD(, pf_state_key) keys;
2022 LIST_HEAD(, pf_kstate) states;
2026 extern u_long pf_ioctl_maxcount;
2027 extern u_long pf_hashmask;
2028 extern u_long pf_srchashmask;
2029 #define PF_HASHSIZ (131072)
2030 #define PF_SRCHASHSIZ (PF_HASHSIZ/4)
2031 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
2032 VNET_DECLARE(struct pf_idhash *, pf_idhash);
2033 #define V_pf_keyhash VNET(pf_keyhash)
2034 #define V_pf_idhash VNET(pf_idhash)
2035 VNET_DECLARE(struct pf_srchash *, pf_srchash);
2036 #define V_pf_srchash VNET(pf_srchash)
2038 #define PF_IDHASH(s) (be64toh((s)->id) % (pf_hashmask + 1))
2040 VNET_DECLARE(void *, pf_swi_cookie);
2041 #define V_pf_swi_cookie VNET(pf_swi_cookie)
2042 VNET_DECLARE(struct intr_event *, pf_swi_ie);
2043 #define V_pf_swi_ie VNET(pf_swi_ie)
2045 VNET_DECLARE(struct unrhdr64, pf_stateid);
2046 #define V_pf_stateid VNET(pf_stateid)
2048 TAILQ_HEAD(pf_altqqueue, pf_altq);
2049 VNET_DECLARE(struct pf_altqqueue, pf_altqs[4]);
2050 #define V_pf_altqs VNET(pf_altqs)
2051 VNET_DECLARE(struct pf_kpalist, pf_pabuf);
2052 #define V_pf_pabuf VNET(pf_pabuf)
2054 VNET_DECLARE(u_int32_t, ticket_altqs_active);
2055 #define V_ticket_altqs_active VNET(ticket_altqs_active)
2056 VNET_DECLARE(u_int32_t, ticket_altqs_inactive);
2057 #define V_ticket_altqs_inactive VNET(ticket_altqs_inactive)
2058 VNET_DECLARE(int, altqs_inactive_open);
2059 #define V_altqs_inactive_open VNET(altqs_inactive_open)
2060 VNET_DECLARE(u_int32_t, ticket_pabuf);
2061 #define V_ticket_pabuf VNET(ticket_pabuf)
2062 VNET_DECLARE(struct pf_altqqueue *, pf_altqs_active);
2063 #define V_pf_altqs_active VNET(pf_altqs_active)
2064 VNET_DECLARE(struct pf_altqqueue *, pf_altq_ifs_active);
2065 #define V_pf_altq_ifs_active VNET(pf_altq_ifs_active)
2066 VNET_DECLARE(struct pf_altqqueue *, pf_altqs_inactive);
2067 #define V_pf_altqs_inactive VNET(pf_altqs_inactive)
2068 VNET_DECLARE(struct pf_altqqueue *, pf_altq_ifs_inactive);
2069 #define V_pf_altq_ifs_inactive VNET(pf_altq_ifs_inactive)
2071 VNET_DECLARE(struct pf_krulequeue, pf_unlinked_rules);
2072 #define V_pf_unlinked_rules VNET(pf_unlinked_rules)
2074 #ifdef PF_WANT_32_TO_64_COUNTER
2075 LIST_HEAD(allkiflist_head, pfi_kkif);
2076 VNET_DECLARE(struct allkiflist_head, pf_allkiflist);
2077 #define V_pf_allkiflist VNET(pf_allkiflist)
2078 VNET_DECLARE(size_t, pf_allkifcount);
2079 #define V_pf_allkifcount VNET(pf_allkifcount)
2080 VNET_DECLARE(struct pfi_kkif *, pf_kifmarker);
2081 #define V_pf_kifmarker VNET(pf_kifmarker)
2083 LIST_HEAD(allrulelist_head, pf_krule);
2084 VNET_DECLARE(struct allrulelist_head, pf_allrulelist);
2085 #define V_pf_allrulelist VNET(pf_allrulelist)
2086 VNET_DECLARE(size_t, pf_allrulecount);
2087 #define V_pf_allrulecount VNET(pf_allrulecount)
2088 VNET_DECLARE(struct pf_krule *, pf_rulemarker);
2089 #define V_pf_rulemarker VNET(pf_rulemarker)
2092 void pf_initialize(void);
2093 void pf_mtag_initialize(void);
2094 void pf_mtag_cleanup(void);
2095 void pf_cleanup(void);
2097 struct pf_mtag *pf_get_mtag(struct mbuf *);
2099 extern void pf_calc_skip_steps(struct pf_krulequeue *);
2101 extern void pf_altq_ifnet_event(struct ifnet *, int);
2103 VNET_DECLARE(uma_zone_t, pf_state_z);
2104 #define V_pf_state_z VNET(pf_state_z)
2105 VNET_DECLARE(uma_zone_t, pf_state_key_z);
2106 #define V_pf_state_key_z VNET(pf_state_key_z)
2107 VNET_DECLARE(uma_zone_t, pf_state_scrub_z);
2108 #define V_pf_state_scrub_z VNET(pf_state_scrub_z)
2110 extern void pf_purge_thread(void *);
2111 extern void pf_unload_vnet_purge(void);
2112 extern void pf_intr(void *);
2113 extern void pf_purge_expired_src_nodes(void);
2115 extern int pf_unlink_state(struct pf_kstate *);
2116 extern int pf_state_insert(struct pfi_kkif *,
2118 struct pf_state_key *,
2119 struct pf_state_key *,
2120 struct pf_kstate *);
2121 extern struct pf_kstate *pf_alloc_state(int);
2122 extern void pf_free_state(struct pf_kstate *);
2124 static __inline void
2125 pf_ref_state(struct pf_kstate *s)
2128 refcount_acquire(&s->refs);
2132 pf_release_state(struct pf_kstate *s)
2135 if (refcount_release(&s->refs)) {
2143 pf_release_staten(struct pf_kstate *s, u_int n)
2146 if (refcount_releasen(&s->refs, n)) {
2153 extern struct pf_kstate *pf_find_state_byid(uint64_t, uint32_t);
2154 extern struct pf_kstate *pf_find_state_all(struct pf_state_key_cmp *,
2156 extern bool pf_find_state_all_exists(struct pf_state_key_cmp *,
2158 extern struct pf_ksrc_node *pf_find_src_node(struct pf_addr *,
2159 struct pf_krule *, sa_family_t,
2160 struct pf_srchash **, bool);
2161 extern void pf_unlink_src_node(struct pf_ksrc_node *);
2162 extern u_int pf_free_src_nodes(struct pf_ksrc_node_list *);
2163 extern void pf_print_state(struct pf_kstate *);
2164 extern void pf_print_flags(u_int8_t);
2165 extern u_int16_t pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
2167 extern u_int16_t pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
2168 u_int16_t, u_int16_t, u_int8_t);
2170 VNET_DECLARE(struct ifnet *, sync_ifp);
2171 #define V_sync_ifp VNET(sync_ifp);
2172 VNET_DECLARE(struct pf_krule, pf_default_rule);
2173 #define V_pf_default_rule VNET(pf_default_rule)
2174 extern void pf_addrcpy(struct pf_addr *, struct pf_addr *,
2176 void pf_free_rule(struct pf_krule *);
2178 int pf_test_eth(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
2180 int pf_test(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
2181 int pf_normalize_ip(struct mbuf **, int, struct pfi_kkif *, u_short *,
2186 int pf_test6(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
2187 int pf_normalize_ip6(struct mbuf **, int, struct pfi_kkif *, u_short *,
2189 void pf_poolmask(struct pf_addr *, struct pf_addr*,
2190 struct pf_addr *, struct pf_addr *, u_int8_t);
2191 void pf_addr_inc(struct pf_addr *, sa_family_t);
2192 int pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *, bool);
2195 u_int32_t pf_new_isn(struct pf_kstate *);
2196 void *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
2198 void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
2199 void pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
2201 void pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
2202 void pf_patch_16_unaligned(struct mbuf *, u_int16_t *, void *, u_int16_t,
2204 void pf_patch_32_unaligned(struct mbuf *, u_int16_t *, void *, u_int32_t,
2206 void pf_send_deferred_syn(struct pf_kstate *);
2207 int pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
2208 struct pf_addr *, sa_family_t);
2209 int pf_match_addr_range(struct pf_addr *, struct pf_addr *,
2210 struct pf_addr *, sa_family_t);
2211 int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
2213 void pf_normalize_init(void);
2214 void pf_normalize_cleanup(void);
2215 int pf_normalize_tcp(int, struct pfi_kkif *, struct mbuf *, int, int, void *,
2217 void pf_normalize_tcp_cleanup(struct pf_kstate *);
2218 int pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
2219 struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
2220 int pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
2221 u_short *, struct tcphdr *, struct pf_kstate *,
2222 struct pf_state_peer *, struct pf_state_peer *, int *);
2224 pf_state_expires(const struct pf_kstate *);
2225 void pf_purge_expired_fragments(void);
2226 void pf_purge_fragments(uint32_t);
2227 int pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kkif *,
2229 int pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
2230 struct pf_state_key *pf_alloc_state_key(int);
2231 void pfr_initialize(void);
2232 void pfr_cleanup(void);
2233 int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
2234 void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
2235 u_int64_t, int, int, int);
2236 int pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
2237 void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
2239 pfr_attach_table(struct pf_kruleset *, char *);
2241 pfr_eth_attach_table(struct pf_keth_ruleset *, char *);
2242 void pfr_detach_table(struct pfr_ktable *);
2243 int pfr_clr_tables(struct pfr_table *, int *, int);
2244 int pfr_add_tables(struct pfr_table *, int, int *, int);
2245 int pfr_del_tables(struct pfr_table *, int, int *, int);
2246 int pfr_table_count(struct pfr_table *, int);
2247 int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
2248 int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
2249 int pfr_clr_tstats(struct pfr_table *, int, int *, int);
2250 int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
2251 int pfr_clr_addrs(struct pfr_table *, int *, int);
2252 int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
2253 int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2255 int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2257 int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2258 int *, int *, int *, int, u_int32_t);
2259 int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
2260 int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
2261 int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
2263 int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2265 int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
2266 int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
2267 int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
2268 int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
2269 int *, u_int32_t, int);
2271 MALLOC_DECLARE(PFI_MTYPE);
2272 VNET_DECLARE(struct pfi_kkif *, pfi_all);
2273 #define V_pfi_all VNET(pfi_all)
2275 void pfi_initialize(void);
2276 void pfi_initialize_vnet(void);
2277 void pfi_cleanup(void);
2278 void pfi_cleanup_vnet(void);
2279 void pfi_kkif_ref(struct pfi_kkif *);
2280 void pfi_kkif_unref(struct pfi_kkif *);
2281 struct pfi_kkif *pfi_kkif_find(const char *);
2282 struct pfi_kkif *pfi_kkif_attach(struct pfi_kkif *, const char *);
2283 int pfi_kkif_match(struct pfi_kkif *, struct pfi_kkif *);
2284 void pfi_kkif_purge(void);
2285 int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
2287 int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
2288 void pfi_dynaddr_remove(struct pfi_dynaddr *);
2289 void pfi_dynaddr_copyout(struct pf_addr_wrap *);
2290 void pfi_update_status(const char *, struct pf_status *);
2291 void pfi_get_ifaces(const char *, struct pfi_kif *, int *);
2292 int pfi_set_flags(const char *, int);
2293 int pfi_clear_flags(const char *, int);
2295 int pf_match_tag(struct mbuf *, struct pf_krule *, int *, int);
2296 int pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
2297 int pf_addr_cmp(struct pf_addr *, struct pf_addr *,
2300 u_int16_t pf_get_mss(struct mbuf *, int, u_int16_t, sa_family_t);
2301 u_int8_t pf_get_wscale(struct mbuf *, int, u_int16_t, sa_family_t);
2302 struct mbuf *pf_build_tcp(const struct pf_krule *, sa_family_t,
2303 const struct pf_addr *, const struct pf_addr *,
2304 u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2305 u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2307 void pf_send_tcp(const struct pf_krule *, sa_family_t,
2308 const struct pf_addr *, const struct pf_addr *,
2309 u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2310 u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2313 void pf_syncookies_init(void);
2314 void pf_syncookies_cleanup(void);
2315 int pf_get_syncookies(struct pfioc_nv *);
2316 int pf_set_syncookies(struct pfioc_nv *);
2317 int pf_synflood_check(struct pf_pdesc *);
2318 void pf_syncookie_send(struct mbuf *m, int off,
2320 bool pf_syncookie_check(struct pf_pdesc *);
2321 u_int8_t pf_syncookie_validate(struct pf_pdesc *);
2322 struct mbuf * pf_syncookie_recreate_syn(uint8_t, int,
2325 VNET_DECLARE(struct pf_kstatus, pf_status);
2326 #define V_pf_status VNET(pf_status)
2332 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
2333 #define V_pf_limits VNET(pf_limits)
2335 #endif /* _KERNEL */
2338 VNET_DECLARE(struct pf_kanchor_global, pf_anchors);
2339 #define V_pf_anchors VNET(pf_anchors)
2340 VNET_DECLARE(struct pf_kanchor, pf_main_anchor);
2341 #define V_pf_main_anchor VNET(pf_main_anchor)
2342 VNET_DECLARE(struct pf_keth_anchor_global, pf_keth_anchors);
2343 #define V_pf_keth_anchors VNET(pf_keth_anchors)
2344 #define pf_main_ruleset V_pf_main_anchor.ruleset
2346 VNET_DECLARE(struct pf_keth_anchor, pf_main_keth_anchor);
2347 #define V_pf_main_keth_anchor VNET(pf_main_keth_anchor)
2348 VNET_DECLARE(struct pf_keth_ruleset*, pf_keth);
2349 #define V_pf_keth VNET(pf_keth)
2351 void pf_init_kruleset(struct pf_kruleset *);
2352 void pf_init_keth(struct pf_keth_ruleset *);
2353 int pf_kanchor_setup(struct pf_krule *,
2354 const struct pf_kruleset *, const char *);
2355 int pf_kanchor_nvcopyout(const struct pf_kruleset *,
2356 const struct pf_krule *, nvlist_t *);
2357 int pf_kanchor_copyout(const struct pf_kruleset *,
2358 const struct pf_krule *, struct pfioc_rule *);
2359 void pf_kanchor_remove(struct pf_krule *);
2360 void pf_remove_if_empty_kruleset(struct pf_kruleset *);
2361 struct pf_kruleset *pf_find_kruleset(const char *);
2362 struct pf_kruleset *pf_find_or_create_kruleset(const char *);
2363 void pf_rs_initialize(void);
2366 struct pf_krule *pf_krule_alloc(void);
2368 void pf_remove_if_empty_keth_ruleset(
2369 struct pf_keth_ruleset *);
2370 struct pf_keth_ruleset *pf_find_keth_ruleset(const char *);
2371 struct pf_keth_anchor *pf_find_keth_anchor(const char *);
2372 int pf_keth_anchor_setup(struct pf_keth_rule *,
2373 const struct pf_keth_ruleset *, const char *);
2374 int pf_keth_anchor_nvcopyout(
2375 const struct pf_keth_ruleset *,
2376 const struct pf_keth_rule *, nvlist_t *);
2377 struct pf_keth_ruleset *pf_find_or_create_keth_ruleset(const char *);
2378 void pf_keth_anchor_remove(struct pf_keth_rule *);
2380 void pf_krule_free(struct pf_krule *);
2383 /* The fingerprint functions can be linked into userland programs (tcpdump) */
2384 int pf_osfp_add(struct pf_osfp_ioctl *);
2386 struct pf_osfp_enlist *
2387 pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
2388 const struct tcphdr *);
2389 #endif /* _KERNEL */
2390 void pf_osfp_flush(void);
2391 int pf_osfp_get(struct pf_osfp_ioctl *);
2392 int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
2395 void pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
2397 void pf_step_into_anchor(struct pf_kanchor_stackframe *, int *,
2398 struct pf_kruleset **, int, struct pf_krule **,
2399 struct pf_krule **, int *);
2400 int pf_step_out_of_anchor(struct pf_kanchor_stackframe *, int *,
2401 struct pf_kruleset **, int, struct pf_krule **,
2402 struct pf_krule **, int *);
2403 void pf_step_into_keth_anchor(struct pf_keth_anchor_stackframe *,
2404 int *, struct pf_keth_ruleset **,
2405 struct pf_keth_rule **, struct pf_keth_rule **,
2407 int pf_step_out_of_keth_anchor(struct pf_keth_anchor_stackframe *,
2408 int *, struct pf_keth_ruleset **,
2409 struct pf_keth_rule **, struct pf_keth_rule **,
2412 int pf_map_addr(u_int8_t, struct pf_krule *,
2413 struct pf_addr *, struct pf_addr *,
2414 struct pf_addr *, struct pf_ksrc_node **);
2415 struct pf_krule *pf_get_translation(struct pf_pdesc *, struct mbuf *,
2416 int, int, struct pfi_kkif *, struct pf_ksrc_node **,
2417 struct pf_state_key **, struct pf_state_key **,
2418 struct pf_addr *, struct pf_addr *,
2419 uint16_t, uint16_t, struct pf_kanchor_stackframe *);
2421 struct pf_state_key *pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
2422 struct pf_addr *, u_int16_t, u_int16_t);
2423 struct pf_state_key *pf_state_key_clone(struct pf_state_key *);
2425 int pf_normalize_mss(struct mbuf *m, int off,
2426 struct pf_pdesc *pd, u_int16_t maxmss);
2427 u_int16_t pf_rule_to_scrub_flags(u_int32_t);
2429 void pf_scrub_ip(struct mbuf **, uint32_t, uint8_t, uint8_t);
2432 void pf_scrub_ip6(struct mbuf **, uint32_t, uint8_t, uint8_t);
2435 struct pfi_kkif *pf_kkif_create(int);
2436 void pf_kkif_free(struct pfi_kkif *);
2437 void pf_kkif_zero(struct pfi_kkif *);
2438 #endif /* _KERNEL */
2440 #endif /* _NET_PFVAR_H_ */