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/malloc.h>
42 #include <sys/refcount.h>
46 #include <net/radix.h>
47 #include <netinet/in.h>
49 #include <netpfil/pf/pf.h>
50 #include <netpfil/pf/pf_altq.h>
51 #include <netpfil/pf/pf_mtag.h>
60 } pfa; /* 128-bit address */
63 #define addr8 pfa.addr8
64 #define addr16 pfa.addr16
65 #define addr32 pfa.addr32
68 #define PFI_AFLAG_NETWORK 0x01
69 #define PFI_AFLAG_BROADCAST 0x02
70 #define PFI_AFLAG_PEER 0x04
71 #define PFI_AFLAG_MODEMASK 0x07
72 #define PFI_AFLAG_NOALIAS 0x08
80 char ifname[IFNAMSIZ];
81 char tblname[PF_TABLE_NAME_SIZE];
84 struct pfi_dynaddr *dyn;
85 struct pfr_ktable *tbl;
89 u_int8_t type; /* PF_ADDR_* */
90 u_int8_t iflags; /* PFI_AFLAG_* */
96 TAILQ_ENTRY(pfi_dynaddr) entry;
97 struct pf_addr pfid_addr4;
98 struct pf_addr pfid_mask4;
99 struct pf_addr pfid_addr6;
100 struct pf_addr pfid_mask6;
101 struct pfr_ktable *pfid_kt;
102 struct pfi_kif *pfid_kif;
103 int pfid_net; /* mask or 128 */
104 int pfid_acnt4; /* address count IPv4 */
105 int pfid_acnt6; /* address count IPv6 */
106 sa_family_t pfid_af; /* rule af */
107 u_int8_t pfid_iflags; /* PFI_AFLAG_* */
111 * Address manipulation macros
113 #define HTONL(x) (x) = htonl((__uint32_t)(x))
114 #define HTONS(x) (x) = htons((__uint16_t)(x))
115 #define NTOHL(x) (x) = ntohl((__uint32_t)(x))
116 #define NTOHS(x) (x) = ntohs((__uint16_t)(x))
120 #define PF_HASHROW_ASSERT(h) mtx_assert(&(h)->lock, MA_OWNED)
121 #define PF_HASHROW_LOCK(h) mtx_lock(&(h)->lock)
122 #define PF_HASHROW_UNLOCK(h) mtx_unlock(&(h)->lock)
124 #define PF_STATE_LOCK(s) \
126 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)]; \
127 PF_HASHROW_LOCK(_ih); \
130 #define PF_STATE_UNLOCK(s) \
132 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))]; \
133 PF_HASHROW_UNLOCK(_ih); \
137 #define PF_STATE_LOCK_ASSERT(s) \
139 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)]; \
140 PF_HASHROW_ASSERT(_ih); \
142 #else /* !INVARIANTS */
143 #define PF_STATE_LOCK_ASSERT(s) do {} while (0)
144 #endif /* INVARIANTS */
146 extern struct mtx pf_unlnkdrules_mtx;
147 #define PF_UNLNKDRULES_LOCK() mtx_lock(&pf_unlnkdrules_mtx)
148 #define PF_UNLNKDRULES_UNLOCK() mtx_unlock(&pf_unlnkdrules_mtx)
150 extern struct rwlock pf_rules_lock;
151 #define PF_RULES_RLOCK() rw_rlock(&pf_rules_lock)
152 #define PF_RULES_RUNLOCK() rw_runlock(&pf_rules_lock)
153 #define PF_RULES_WLOCK() rw_wlock(&pf_rules_lock)
154 #define PF_RULES_WUNLOCK() rw_wunlock(&pf_rules_lock)
155 #define PF_RULES_ASSERT() rw_assert(&pf_rules_lock, RA_LOCKED)
156 #define PF_RULES_RASSERT() rw_assert(&pf_rules_lock, RA_RLOCKED)
157 #define PF_RULES_WASSERT() rw_assert(&pf_rules_lock, RA_WLOCKED)
159 extern struct sx pf_end_lock;
162 #define PFLOG_MODVER 1
163 #define PFSYNC_MODVER 1
165 #define PFLOG_MINVER 1
166 #define PFLOG_PREFVER PFLOG_MODVER
167 #define PFLOG_MAXVER 1
168 #define PFSYNC_MINVER 1
169 #define PFSYNC_PREFVER PFSYNC_MODVER
170 #define PFSYNC_MAXVER 1
180 #define PF_INET6_ONLY
186 #define PF_INET_INET6
192 #define PF_INET_INET6
196 /* Both IPv4 and IPv6 */
199 #define PF_AEQ(a, b, c) \
200 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
201 (c == AF_INET6 && (a)->addr32[3] == (b)->addr32[3] && \
202 (a)->addr32[2] == (b)->addr32[2] && \
203 (a)->addr32[1] == (b)->addr32[1] && \
204 (a)->addr32[0] == (b)->addr32[0])) \
206 #define PF_ANEQ(a, b, c) \
207 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
208 (c == AF_INET6 && ((a)->addr32[0] != (b)->addr32[0] || \
209 (a)->addr32[1] != (b)->addr32[1] || \
210 (a)->addr32[2] != (b)->addr32[2] || \
211 (a)->addr32[3] != (b)->addr32[3]))) \
213 #define PF_AZERO(a, c) \
214 ((c == AF_INET && !(a)->addr32[0]) || \
215 (c == AF_INET6 && !(a)->addr32[0] && !(a)->addr32[1] && \
216 !(a)->addr32[2] && !(a)->addr32[3] )) \
218 #define PF_MATCHA(n, a, m, b, f) \
219 pf_match_addr(n, a, m, b, f)
221 #define PF_ACPY(a, b, f) \
224 #define PF_AINC(a, f) \
227 #define PF_POOLMASK(a, b, c, d, f) \
228 pf_poolmask(a, b, c, d, f)
236 #define PF_AEQ(a, b, c) \
237 ((a)->addr32[3] == (b)->addr32[3] && \
238 (a)->addr32[2] == (b)->addr32[2] && \
239 (a)->addr32[1] == (b)->addr32[1] && \
240 (a)->addr32[0] == (b)->addr32[0]) \
242 #define PF_ANEQ(a, b, c) \
243 ((a)->addr32[3] != (b)->addr32[3] || \
244 (a)->addr32[2] != (b)->addr32[2] || \
245 (a)->addr32[1] != (b)->addr32[1] || \
246 (a)->addr32[0] != (b)->addr32[0]) \
248 #define PF_AZERO(a, c) \
249 (!(a)->addr32[0] && \
254 #define PF_MATCHA(n, a, m, b, f) \
255 pf_match_addr(n, a, m, b, f)
257 #define PF_ACPY(a, b, f) \
260 #define PF_AINC(a, f) \
263 #define PF_POOLMASK(a, b, c, d, f) \
264 pf_poolmask(a, b, c, d, f)
271 #define PF_AEQ(a, b, c) \
272 ((a)->addr32[0] == (b)->addr32[0])
274 #define PF_ANEQ(a, b, c) \
275 ((a)->addr32[0] != (b)->addr32[0])
277 #define PF_AZERO(a, c) \
280 #define PF_MATCHA(n, a, m, b, f) \
281 pf_match_addr(n, a, m, b, f)
283 #define PF_ACPY(a, b, f) \
284 (a)->v4.s_addr = (b)->v4.s_addr
286 #define PF_AINC(a, f) \
288 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
291 #define PF_POOLMASK(a, b, c, d, f) \
293 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
294 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
297 #endif /* PF_INET_ONLY */
298 #endif /* PF_INET6_ONLY */
299 #endif /* PF_INET_INET6 */
302 * XXX callers not FIB-aware in our version of pf yet.
303 * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
305 #define PF_MISMATCHAW(aw, x, af, neg, ifp, rtid) \
307 (((aw)->type == PF_ADDR_NOROUTE && \
308 pf_routable((x), (af), NULL, (rtid))) || \
309 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL && \
310 pf_routable((x), (af), (ifp), (rtid))) || \
311 ((aw)->type == PF_ADDR_TABLE && \
312 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \
313 ((aw)->type == PF_ADDR_DYNIFTL && \
314 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \
315 ((aw)->type == PF_ADDR_RANGE && \
316 !pf_match_addr_range(&(aw)->v.a.addr, \
317 &(aw)->v.a.mask, (x), (af))) || \
318 ((aw)->type == PF_ADDR_ADDRMASK && \
319 !PF_AZERO(&(aw)->v.a.mask, (af)) && \
320 !PF_MATCHA(0, &(aw)->v.a.addr, \
321 &(aw)->v.a.mask, (x), (af))))) != \
336 struct pf_rule_addr {
337 struct pf_addr_wrap addr;
344 struct pf_addr_wrap addr;
345 TAILQ_ENTRY(pf_pooladdr) entries;
346 char ifname[IFNAMSIZ];
350 TAILQ_HEAD(pf_palist, pf_pooladdr);
352 struct pf_poolhashkey {
357 } pfk; /* 128-bit hash key */
358 #define key8 pfk.key8
359 #define key16 pfk.key16
360 #define key32 pfk.key32
364 struct pf_palist list;
365 struct pf_pooladdr *cur;
366 struct pf_poolhashkey key;
367 struct pf_addr counter;
369 u_int16_t proxy_port[2];
374 /* A packed Operating System description for fingerprinting */
375 typedef u_int32_t pf_osfp_t;
376 #define PF_OSFP_ANY ((pf_osfp_t)0)
377 #define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
378 #define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
380 struct pf_osfp_entry {
381 SLIST_ENTRY(pf_osfp_entry) fp_entry;
384 #define PF_OSFP_EXPANDED 0x001 /* expanded entry */
385 #define PF_OSFP_GENERIC 0x002 /* generic signature */
386 #define PF_OSFP_NODETAIL 0x004 /* no p0f details */
387 #define PF_OSFP_LEN 32
388 char fp_class_nm[PF_OSFP_LEN];
389 char fp_version_nm[PF_OSFP_LEN];
390 char fp_subtype_nm[PF_OSFP_LEN];
392 #define PF_OSFP_ENTRY_EQ(a, b) \
393 ((a)->fp_os == (b)->fp_os && \
394 memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
395 memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
396 memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
398 /* handle pf_osfp_t packing */
399 #define _FP_RESERVED_BIT 1 /* For the special negative #defines */
400 #define _FP_UNUSED_BITS 1
401 #define _FP_CLASS_BITS 10 /* OS Class (Windows, Linux) */
402 #define _FP_VERSION_BITS 10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
403 #define _FP_SUBTYPE_BITS 10 /* patch level (NT SP4, SP3, ECN patch) */
404 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
405 (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
406 ((1 << _FP_CLASS_BITS) - 1); \
407 (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
408 ((1 << _FP_VERSION_BITS) - 1);\
409 (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
411 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
412 (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
413 + _FP_SUBTYPE_BITS); \
414 (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
416 (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
419 /* the fingerprint of an OSes TCP SYN packet */
420 typedef u_int64_t pf_tcpopts_t;
421 struct pf_os_fingerprint {
422 SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
423 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
424 u_int16_t fp_wsize; /* TCP window size */
425 u_int16_t fp_psize; /* ip->ip_len */
426 u_int16_t fp_mss; /* TCP MSS */
428 #define PF_OSFP_WSIZE_MOD 0x0001 /* Window modulus */
429 #define PF_OSFP_WSIZE_DC 0x0002 /* Window don't care */
430 #define PF_OSFP_WSIZE_MSS 0x0004 /* Window multiple of MSS */
431 #define PF_OSFP_WSIZE_MTU 0x0008 /* Window multiple of MTU */
432 #define PF_OSFP_PSIZE_MOD 0x0010 /* packet size modulus */
433 #define PF_OSFP_PSIZE_DC 0x0020 /* packet size don't care */
434 #define PF_OSFP_WSCALE 0x0040 /* TCP window scaling */
435 #define PF_OSFP_WSCALE_MOD 0x0080 /* TCP window scale modulus */
436 #define PF_OSFP_WSCALE_DC 0x0100 /* TCP window scale dont-care */
437 #define PF_OSFP_MSS 0x0200 /* TCP MSS */
438 #define PF_OSFP_MSS_MOD 0x0400 /* TCP MSS modulus */
439 #define PF_OSFP_MSS_DC 0x0800 /* TCP MSS dont-care */
440 #define PF_OSFP_DF 0x1000 /* IPv4 don't fragment bit */
441 #define PF_OSFP_TS0 0x2000 /* Zero timestamp */
442 #define PF_OSFP_INET6 0x4000 /* IPv6 */
443 u_int8_t fp_optcnt; /* TCP option count */
444 u_int8_t fp_wscale; /* TCP window scaling */
445 u_int8_t fp_ttl; /* IPv4 TTL */
446 #define PF_OSFP_MAXTTL_OFFSET 40
447 /* TCP options packing */
448 #define PF_OSFP_TCPOPT_NOP 0x0 /* TCP NOP option */
449 #define PF_OSFP_TCPOPT_WSCALE 0x1 /* TCP window scaling option */
450 #define PF_OSFP_TCPOPT_MSS 0x2 /* TCP max segment size opt */
451 #define PF_OSFP_TCPOPT_SACK 0x3 /* TCP SACK OK option */
452 #define PF_OSFP_TCPOPT_TS 0x4 /* TCP timestamp option */
453 #define PF_OSFP_TCPOPT_BITS 3 /* bits used by each option */
454 #define PF_OSFP_MAX_OPTS \
455 (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
456 / PF_OSFP_TCPOPT_BITS
458 SLIST_ENTRY(pf_os_fingerprint) fp_next;
461 struct pf_osfp_ioctl {
462 struct pf_osfp_entry fp_os;
463 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
464 u_int16_t fp_wsize; /* TCP window size */
465 u_int16_t fp_psize; /* ip->ip_len */
466 u_int16_t fp_mss; /* TCP MSS */
468 u_int8_t fp_optcnt; /* TCP option count */
469 u_int8_t fp_wscale; /* TCP window scaling */
470 u_int8_t fp_ttl; /* IPv4 TTL */
472 int fp_getnum; /* DIOCOSFPGET number */
481 #define PF_ANCHOR_NAME_SIZE 64
484 struct pf_rule_addr src;
485 struct pf_rule_addr dst;
486 #define PF_SKIP_IFP 0
487 #define PF_SKIP_DIR 1
489 #define PF_SKIP_PROTO 3
490 #define PF_SKIP_SRC_ADDR 4
491 #define PF_SKIP_SRC_PORT 5
492 #define PF_SKIP_DST_ADDR 6
493 #define PF_SKIP_DST_PORT 7
494 #define PF_SKIP_COUNT 8
495 union pf_rule_ptr skip[PF_SKIP_COUNT];
496 #define PF_RULE_LABEL_SIZE 64
497 char label[PF_RULE_LABEL_SIZE];
498 char ifname[IFNAMSIZ];
499 char qname[PF_QNAME_SIZE];
500 char pqname[PF_QNAME_SIZE];
501 #define PF_TAG_NAME_SIZE 64
502 char tagname[PF_TAG_NAME_SIZE];
503 char match_tagname[PF_TAG_NAME_SIZE];
505 char overload_tblname[PF_TABLE_NAME_SIZE];
507 TAILQ_ENTRY(pf_rule) entries;
508 struct pf_pool rpool;
510 u_int64_t evaluations;
511 u_int64_t packets[2];
515 struct pf_anchor *anchor;
516 struct pfr_ktable *overload_tbl;
518 pf_osfp_t os_fingerprint;
521 u_int32_t timeout[PFTM_MAX];
522 u_int32_t max_states;
523 u_int32_t max_src_nodes;
524 u_int32_t max_src_states;
525 u_int32_t max_src_conn;
538 counter_u64_t states_cur;
539 counter_u64_t states_tot;
540 counter_u64_t src_nodes;
542 u_int16_t return_icmp;
543 u_int16_t return_icmp6;
547 u_int16_t scrub_flags;
549 struct pf_rule_uid uid;
550 struct pf_rule_gid gid;
559 u_int8_t match_tag_not;
562 #define PF_STATE_NORMAL 0x1
563 #define PF_STATE_MODULATE 0x2
564 #define PF_STATE_SYNPROXY 0x3
578 u_int8_t anchor_relative;
579 u_int8_t anchor_wildcard;
581 #define PF_FLUSH 0x01
582 #define PF_FLUSH_GLOBAL 0x02
584 #define PF_PRIO_ZERO 0xff /* match "prio 0" packets */
585 #define PF_PRIO_MAX 7
587 u_int8_t set_prio[2];
594 uint64_t u_states_cur;
595 uint64_t u_states_tot;
596 uint64_t u_src_nodes;
600 #define PFRULE_DROP 0x0000
601 #define PFRULE_RETURNRST 0x0001
602 #define PFRULE_FRAGMENT 0x0002
603 #define PFRULE_RETURNICMP 0x0004
604 #define PFRULE_RETURN 0x0008
605 #define PFRULE_NOSYNC 0x0010
606 #define PFRULE_SRCTRACK 0x0020 /* track source states */
607 #define PFRULE_RULESRCTRACK 0x0040 /* per rule */
608 #define PFRULE_REFS 0x0080 /* rule has references */
611 #define PFRULE_NODF 0x0100
612 #define PFRULE_RANDOMID 0x0800
613 #define PFRULE_REASSEMBLE_TCP 0x1000
614 #define PFRULE_SET_TOS 0x2000
616 /* rule flags again */
617 #define PFRULE_IFBOUND 0x00010000 /* if-bound */
618 #define PFRULE_STATESLOPPY 0x00020000 /* sloppy state tracking */
620 #define PFSTATE_HIWAT 10000 /* default state table size */
621 #define PFSTATE_ADAPT_START 6000 /* default adaptive timeout start */
622 #define PFSTATE_ADAPT_END 12000 /* default adaptive timeout end */
625 struct pf_threshold {
627 #define PF_THRESHOLD_MULT 1000
628 #define PF_THRESHOLD_MAX 0xffffffff / PF_THRESHOLD_MULT
635 LIST_ENTRY(pf_src_node) entry;
637 struct pf_addr raddr;
638 union pf_rule_ptr rule;
641 u_int64_t packets[2];
644 struct pf_threshold conn_rate;
651 #define PFSNODE_HIWAT 10000 /* default source node table size */
653 struct pf_state_scrub {
654 struct timeval pfss_last; /* time received last packet */
655 u_int32_t pfss_tsecr; /* last echoed timestamp */
656 u_int32_t pfss_tsval; /* largest timestamp */
657 u_int32_t pfss_tsval0; /* original timestamp */
658 u_int16_t pfss_flags;
659 #define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
660 #define PFSS_PAWS 0x0010 /* stricter PAWS checks */
661 #define PFSS_PAWS_IDLED 0x0020 /* was idle too long. no PAWS */
662 #define PFSS_DATA_TS 0x0040 /* timestamp on data packets */
663 #define PFSS_DATA_NOTS 0x0080 /* no timestamp on data packets */
664 u_int8_t pfss_ttl; /* stashed TTL */
666 u_int32_t pfss_ts_mod; /* timestamp modulation */
669 struct pf_state_host {
675 struct pf_state_peer {
676 struct pf_state_scrub *scrub; /* state is scrubbed */
677 u_int32_t seqlo; /* Max sequence number sent */
678 u_int32_t seqhi; /* Max the other end ACKd + win */
679 u_int32_t seqdiff; /* Sequence number modulator */
680 u_int16_t max_win; /* largest window (pre scaling) */
681 u_int16_t mss; /* Maximum segment size option */
682 u_int8_t state; /* active state level */
683 u_int8_t wscale; /* window scaling factor */
684 u_int8_t tcp_est; /* Did we reach TCPS_ESTABLISHED */
688 /* Keep synced with struct pf_state_key. */
689 struct pf_state_key_cmp {
690 struct pf_addr addr[2];
697 struct pf_state_key {
698 struct pf_addr addr[2];
704 LIST_ENTRY(pf_state_key) entry;
705 TAILQ_HEAD(, pf_state) states[2];
708 /* Keep synced with struct pf_state. */
709 struct pf_state_cmp {
723 TAILQ_ENTRY(pf_state) sync_list;
724 TAILQ_ENTRY(pf_state) key_list[2];
725 LIST_ENTRY(pf_state) entry;
726 struct pf_state_peer src;
727 struct pf_state_peer dst;
728 union pf_rule_ptr rule;
729 union pf_rule_ptr anchor;
730 union pf_rule_ptr nat_rule;
731 struct pf_addr rt_addr;
732 struct pf_state_key *key[2]; /* addresses stack and wire */
734 struct pfi_kif *rt_kif;
735 struct pf_src_node *src_node;
736 struct pf_src_node *nat_src_node;
737 u_int64_t packets[2];
741 u_int32_t pfsync_time;
744 u_int8_t state_flags;
745 #define PFSTATE_ALLOWOPTS 0x01
746 #define PFSTATE_SLOPPY 0x02
747 /* was PFSTATE_PFLOW 0x04 */
748 #define PFSTATE_NOSYNC 0x08
749 #define PFSTATE_ACK 0x10
750 #define PFSTATE_SETPRIO 0x0200
751 #define PFSTATE_SETMASK (PFSTATE_SETPRIO)
753 u_int8_t sync_state; /* PFSYNC_S_x */
756 u_int8_t sync_updates;
761 * Unified state structures for pulling states out of the kernel
762 * used by pfsync(4) and the pf(4) ioctl.
764 struct pfsync_state_scrub {
765 u_int16_t pfss_flags;
766 u_int8_t pfss_ttl; /* stashed TTL */
767 #define PFSYNC_SCRUB_FLAG_VALID 0x01
769 u_int32_t pfss_ts_mod; /* timestamp modulation */
772 struct pfsync_state_peer {
773 struct pfsync_state_scrub scrub; /* state is scrubbed */
774 u_int32_t seqlo; /* Max sequence number sent */
775 u_int32_t seqhi; /* Max the other end ACKd + win */
776 u_int32_t seqdiff; /* Sequence number modulator */
777 u_int16_t max_win; /* largest window (pre scaling) */
778 u_int16_t mss; /* Maximum segment size option */
779 u_int8_t state; /* active state level */
780 u_int8_t wscale; /* window scaling factor */
784 struct pfsync_state_key {
785 struct pf_addr addr[2];
789 struct pfsync_state {
791 char ifname[IFNAMSIZ];
792 struct pfsync_state_key key[2];
793 struct pfsync_state_peer src;
794 struct pfsync_state_peer dst;
795 struct pf_addr rt_addr;
801 u_int32_t packets[2][2];
802 u_int32_t bytes[2][2];
809 u_int8_t state_flags;
817 typedef int pfsync_state_import_t(struct pfsync_state *, u_int8_t);
818 typedef void pfsync_insert_state_t(struct pf_state *);
819 typedef void pfsync_update_state_t(struct pf_state *);
820 typedef void pfsync_delete_state_t(struct pf_state *);
821 typedef void pfsync_clear_states_t(u_int32_t, const char *);
822 typedef int pfsync_defer_t(struct pf_state *, struct mbuf *);
824 extern pfsync_state_import_t *pfsync_state_import_ptr;
825 extern pfsync_insert_state_t *pfsync_insert_state_ptr;
826 extern pfsync_update_state_t *pfsync_update_state_ptr;
827 extern pfsync_delete_state_t *pfsync_delete_state_ptr;
828 extern pfsync_clear_states_t *pfsync_clear_states_ptr;
829 extern pfsync_defer_t *pfsync_defer_ptr;
831 void pfsync_state_export(struct pfsync_state *,
837 typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
838 u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
839 struct pf_ruleset *, struct pf_pdesc *, int);
840 extern pflog_packet_t *pflog_packet_ptr;
844 #define PFSYNC_FLAG_SRCNODE 0x04
845 #define PFSYNC_FLAG_NATSRCNODE 0x08
847 /* for copies to/from network byte order */
848 /* ioctl interface also uses network byte order */
849 #define pf_state_peer_hton(s,d) do { \
850 (d)->seqlo = htonl((s)->seqlo); \
851 (d)->seqhi = htonl((s)->seqhi); \
852 (d)->seqdiff = htonl((s)->seqdiff); \
853 (d)->max_win = htons((s)->max_win); \
854 (d)->mss = htons((s)->mss); \
855 (d)->state = (s)->state; \
856 (d)->wscale = (s)->wscale; \
858 (d)->scrub.pfss_flags = \
859 htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP); \
860 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl; \
861 (d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
862 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID; \
866 #define pf_state_peer_ntoh(s,d) do { \
867 (d)->seqlo = ntohl((s)->seqlo); \
868 (d)->seqhi = ntohl((s)->seqhi); \
869 (d)->seqdiff = ntohl((s)->seqdiff); \
870 (d)->max_win = ntohs((s)->max_win); \
871 (d)->mss = ntohs((s)->mss); \
872 (d)->state = (s)->state; \
873 (d)->wscale = (s)->wscale; \
874 if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && \
875 (d)->scrub != NULL) { \
876 (d)->scrub->pfss_flags = \
877 ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP; \
878 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl; \
879 (d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
883 #define pf_state_counter_hton(s,d) do { \
884 d[0] = htonl((s>>32)&0xffffffff); \
885 d[1] = htonl(s&0xffffffff); \
888 #define pf_state_counter_from_pfsync(s) \
889 (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
891 #define pf_state_counter_ntoh(s,d) do { \
897 TAILQ_HEAD(pf_rulequeue, pf_rule);
903 struct pf_rulequeue queues[2];
905 struct pf_rulequeue *ptr;
906 struct pf_rule **ptr_array;
911 } rules[PF_RULESET_MAX];
912 struct pf_anchor *anchor;
918 RB_HEAD(pf_anchor_global, pf_anchor);
919 RB_HEAD(pf_anchor_node, pf_anchor);
921 RB_ENTRY(pf_anchor) entry_global;
922 RB_ENTRY(pf_anchor) entry_node;
923 struct pf_anchor *parent;
924 struct pf_anchor_node children;
925 char name[PF_ANCHOR_NAME_SIZE];
926 char path[MAXPATHLEN];
927 struct pf_ruleset ruleset;
928 int refcnt; /* anchor rules */
929 int match; /* XXX: used for pfctl black magic */
931 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
932 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
934 #define PF_RESERVED_ANCHOR "_pf"
936 #define PFR_TFLAG_PERSIST 0x00000001
937 #define PFR_TFLAG_CONST 0x00000002
938 #define PFR_TFLAG_ACTIVE 0x00000004
939 #define PFR_TFLAG_INACTIVE 0x00000008
940 #define PFR_TFLAG_REFERENCED 0x00000010
941 #define PFR_TFLAG_REFDANCHOR 0x00000020
942 #define PFR_TFLAG_COUNTERS 0x00000040
943 /* Adjust masks below when adding flags. */
944 #define PFR_TFLAG_USRMASK (PFR_TFLAG_PERSIST | \
947 #define PFR_TFLAG_SETMASK (PFR_TFLAG_ACTIVE | \
948 PFR_TFLAG_INACTIVE | \
949 PFR_TFLAG_REFERENCED | \
950 PFR_TFLAG_REFDANCHOR)
951 #define PFR_TFLAG_ALLMASK (PFR_TFLAG_PERSIST | \
954 PFR_TFLAG_INACTIVE | \
955 PFR_TFLAG_REFERENCED | \
956 PFR_TFLAG_REFDANCHOR | \
959 struct pf_anchor_stackframe;
962 char pfrt_anchor[MAXPATHLEN];
963 char pfrt_name[PF_TABLE_NAME_SIZE];
964 u_int32_t pfrt_flags;
968 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
969 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
970 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
974 struct in_addr _pfra_ip4addr;
975 struct in6_addr _pfra_ip6addr;
982 #define pfra_ip4addr pfra_u._pfra_ip4addr
983 #define pfra_ip6addr pfra_u._pfra_ip6addr
985 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
986 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
987 #define PFR_OP_XPASS PFR_OP_ADDR_MAX
990 struct pfr_addr pfras_a;
991 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
992 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
996 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
999 struct pfr_table pfrts_t;
1000 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1001 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1002 u_int64_t pfrts_match;
1003 u_int64_t pfrts_nomatch;
1006 int pfrts_refcnt[PFR_REFCNT_MAX];
1008 #define pfrts_name pfrts_t.pfrt_name
1009 #define pfrts_flags pfrts_t.pfrt_flags
1011 #ifndef _SOCKADDR_UNION_DEFINED
1012 #define _SOCKADDR_UNION_DEFINED
1013 union sockaddr_union {
1015 struct sockaddr_in sin;
1016 struct sockaddr_in6 sin6;
1018 #endif /* _SOCKADDR_UNION_DEFINED */
1020 struct pfr_kcounters {
1021 u_int64_t pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1022 u_int64_t pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1025 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1027 struct radix_node pfrke_node[2];
1028 union sockaddr_union pfrke_sa;
1029 SLIST_ENTRY(pfr_kentry) pfrke_workq;
1030 struct pfr_kcounters *pfrke_counters;
1035 u_int8_t pfrke_mark;
1038 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1039 RB_HEAD(pfr_ktablehead, pfr_ktable);
1041 struct pfr_tstats pfrkt_ts;
1042 RB_ENTRY(pfr_ktable) pfrkt_tree;
1043 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
1044 struct radix_node_head *pfrkt_ip4;
1045 struct radix_node_head *pfrkt_ip6;
1046 struct pfr_ktable *pfrkt_shadow;
1047 struct pfr_ktable *pfrkt_root;
1048 struct pf_ruleset *pfrkt_rs;
1052 #define pfrkt_t pfrkt_ts.pfrts_t
1053 #define pfrkt_name pfrkt_t.pfrt_name
1054 #define pfrkt_anchor pfrkt_t.pfrt_anchor
1055 #define pfrkt_ruleset pfrkt_t.pfrt_ruleset
1056 #define pfrkt_flags pfrkt_t.pfrt_flags
1057 #define pfrkt_cnt pfrkt_ts.pfrts_cnt
1058 #define pfrkt_refcnt pfrkt_ts.pfrts_refcnt
1059 #define pfrkt_packets pfrkt_ts.pfrts_packets
1060 #define pfrkt_bytes pfrkt_ts.pfrts_bytes
1061 #define pfrkt_match pfrkt_ts.pfrts_match
1062 #define pfrkt_nomatch pfrkt_ts.pfrts_nomatch
1063 #define pfrkt_tzero pfrkt_ts.pfrts_tzero
1065 /* keep synced with pfi_kif, used in RB_FIND */
1066 struct pfi_kif_cmp {
1067 char pfik_name[IFNAMSIZ];
1071 char pfik_name[IFNAMSIZ];
1073 RB_ENTRY(pfi_kif) _pfik_tree;
1074 LIST_ENTRY(pfi_kif) _pfik_list;
1076 #define pfik_tree _pfik_glue._pfik_tree
1077 #define pfik_list _pfik_glue._pfik_list
1078 u_int64_t pfik_packets[2][2][2];
1079 u_int64_t pfik_bytes[2][2][2];
1080 u_int32_t pfik_tzero;
1082 struct ifnet *pfik_ifp;
1083 struct ifg_group *pfik_group;
1084 u_int pfik_rulerefs;
1085 TAILQ_HEAD(, pfi_dynaddr) pfik_dynaddrs;
1088 #define PFI_IFLAG_REFS 0x0001 /* has state references */
1089 #define PFI_IFLAG_SKIP 0x0100 /* skip filtering on interface */
1097 u_int64_t tot_len; /* Make Mickey money */
1103 struct icmp6_hdr *icmp6;
1108 struct pf_rule *nat_rule; /* nat/rdr rule applied to packet */
1109 struct pf_addr *src; /* src address */
1110 struct pf_addr *dst; /* dst address */
1113 struct pf_mtag *pf_mtag;
1115 u_int32_t p_len; /* total length of payload */
1118 u_int16_t *proto_sum;
1119 u_int16_t flags; /* Let SCRUB trigger behavior in
1120 * state code. Easier than tags */
1121 #define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */
1122 #define PFDESC_IP_REAS 0x0002 /* IP frags would've been reassembled */
1126 u_int8_t dir; /* direction */
1127 u_int8_t sidx; /* key index for source */
1128 u_int8_t didx; /* key index for destination */
1131 /* flags for RDR options */
1132 #define PF_DPORT_RANGE 0x01 /* Dest port uses range */
1133 #define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
1135 /* UDP state enumeration */
1136 #define PFUDPS_NO_TRAFFIC 0
1137 #define PFUDPS_SINGLE 1
1138 #define PFUDPS_MULTIPLE 2
1140 #define PFUDPS_NSTATES 3 /* number of state levels */
1142 #define PFUDPS_NAMES { \
1149 /* Other protocol state enumeration */
1150 #define PFOTHERS_NO_TRAFFIC 0
1151 #define PFOTHERS_SINGLE 1
1152 #define PFOTHERS_MULTIPLE 2
1154 #define PFOTHERS_NSTATES 3 /* number of state levels */
1156 #define PFOTHERS_NAMES { \
1163 #define ACTION_SET(a, x) \
1169 #define REASON_SET(a, x) \
1173 if (x < PFRES_MAX) \
1174 counter_u64_add(V_pf_status.counters[x], 1); \
1178 counter_u64_t counters[PFRES_MAX]; /* reason for passing/dropping */
1179 counter_u64_t lcounters[LCNT_MAX]; /* limit counters */
1180 counter_u64_t fcounters[FCNT_MAX]; /* state operation counters */
1181 counter_u64_t scounters[SCNT_MAX]; /* src_node operation counters */
1188 char ifname[IFNAMSIZ];
1189 uint8_t pf_chksum[PF_MD5_DIGEST_LENGTH];
1194 struct in_addr ipv4;
1195 struct in6_addr ipv6;
1200 #define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */
1201 #define PFR_KENTRY_HIWAT 200000 /* Number of table entries */
1204 * ioctl parameter structures
1207 struct pfioc_pooladdr {
1215 char anchor[MAXPATHLEN];
1216 struct pf_pooladdr addr;
1222 u_int32_t pool_ticket;
1224 char anchor[MAXPATHLEN];
1225 char anchor_call[MAXPATHLEN];
1226 struct pf_rule rule;
1229 struct pfioc_natlook {
1230 struct pf_addr saddr;
1231 struct pf_addr daddr;
1232 struct pf_addr rsaddr;
1233 struct pf_addr rdaddr;
1243 struct pfioc_state {
1244 struct pfsync_state state;
1247 struct pfioc_src_node_kill {
1248 sa_family_t psnk_af;
1249 struct pf_rule_addr psnk_src;
1250 struct pf_rule_addr psnk_dst;
1254 struct pfioc_state_kill {
1255 struct pf_state_cmp psk_pfcmp;
1258 struct pf_rule_addr psk_src;
1259 struct pf_rule_addr psk_dst;
1260 char psk_ifname[IFNAMSIZ];
1261 char psk_label[PF_RULE_LABEL_SIZE];
1265 struct pfioc_states {
1269 struct pfsync_state *psu_states;
1271 #define ps_buf ps_u.psu_buf
1272 #define ps_states ps_u.psu_states
1275 struct pfioc_src_nodes {
1279 struct pf_src_node *psu_src_nodes;
1281 #define psn_buf psn_u.psu_buf
1282 #define psn_src_nodes psn_u.psu_src_nodes
1286 char ifname[IFNAMSIZ];
1294 struct pfioc_limit {
1303 struct pf_altq altq;
1306 struct pfioc_qstats {
1314 struct pfioc_ruleset {
1316 char path[MAXPATHLEN];
1317 char name[PF_ANCHOR_NAME_SIZE];
1320 #define PF_RULESET_ALTQ (PF_RULESET_MAX)
1321 #define PF_RULESET_TABLE (PF_RULESET_MAX+1)
1322 struct pfioc_trans {
1323 int size; /* number of elements */
1324 int esize; /* size of each element in bytes */
1325 struct pfioc_trans_e {
1327 char anchor[MAXPATHLEN];
1332 #define PFR_FLAG_ATOMIC 0x00000001 /* unused */
1333 #define PFR_FLAG_DUMMY 0x00000002
1334 #define PFR_FLAG_FEEDBACK 0x00000004
1335 #define PFR_FLAG_CLSTATS 0x00000008
1336 #define PFR_FLAG_ADDRSTOO 0x00000010
1337 #define PFR_FLAG_REPLACE 0x00000020
1338 #define PFR_FLAG_ALLRSETS 0x00000040
1339 #define PFR_FLAG_ALLMASK 0x0000007F
1341 #define PFR_FLAG_USERIOCTL 0x10000000
1344 struct pfioc_table {
1345 struct pfr_table pfrio_table;
1354 u_int32_t pfrio_ticket;
1356 #define pfrio_exists pfrio_nadd
1357 #define pfrio_nzero pfrio_nadd
1358 #define pfrio_nmatch pfrio_nadd
1359 #define pfrio_naddr pfrio_size2
1360 #define pfrio_setflag pfrio_size2
1361 #define pfrio_clrflag pfrio_nadd
1363 struct pfioc_iface {
1364 char pfiio_name[IFNAMSIZ];
1377 #define DIOCSTART _IO ('D', 1)
1378 #define DIOCSTOP _IO ('D', 2)
1379 #define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
1380 #define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
1381 #define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule)
1382 /* XXX cut 8 - 17 */
1383 #define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill)
1384 #define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
1385 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1386 #define DIOCGETSTATUS _IOWR('D', 21, struct pf_status)
1387 #define DIOCCLRSTATUS _IO ('D', 22)
1388 #define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
1389 #define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
1390 #define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
1391 #define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
1392 /* XXX cut 26 - 28 */
1393 #define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
1394 #define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
1395 #define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
1396 #define DIOCCLRRULECTRS _IO ('D', 38)
1397 #define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
1398 #define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
1399 #define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill)
1400 #define DIOCSTARTALTQ _IO ('D', 42)
1401 #define DIOCSTOPALTQ _IO ('D', 43)
1402 #define DIOCADDALTQ _IOWR('D', 45, struct pfioc_altq)
1403 #define DIOCGETALTQS _IOWR('D', 47, struct pfioc_altq)
1404 #define DIOCGETALTQ _IOWR('D', 48, struct pfioc_altq)
1405 #define DIOCCHANGEALTQ _IOWR('D', 49, struct pfioc_altq)
1406 #define DIOCGETQSTATS _IOWR('D', 50, struct pfioc_qstats)
1407 #define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr)
1408 #define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr)
1409 #define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr)
1410 #define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr)
1411 #define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr)
1412 /* XXX cut 55 - 57 */
1413 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1414 #define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
1415 #define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
1416 #define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
1417 #define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
1418 #define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
1419 #define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
1420 #define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
1421 #define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
1422 #define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
1423 #define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
1424 #define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
1425 #define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
1426 #define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
1427 #define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
1428 #define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
1429 #define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
1430 #define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
1431 #define DIOCOSFPFLUSH _IO('D', 78)
1432 #define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
1433 #define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
1434 #define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
1435 #define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
1436 #define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
1437 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1438 #define DIOCCLRSRCNODES _IO('D', 85)
1439 #define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
1440 #define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
1441 #define DIOCSETIFFLAG _IOWR('D', 89, struct pfioc_iface)
1442 #define DIOCCLRIFFLAG _IOWR('D', 90, struct pfioc_iface)
1443 #define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill)
1445 char ifname[IFNAMSIZ];
1448 #define DIOCGIFSPEED _IOWR('D', 92, struct pf_ifspeed)
1451 LIST_HEAD(pf_src_node_list, pf_src_node);
1453 struct pf_src_node_list nodes;
1458 LIST_HEAD(, pf_state_key) keys;
1463 LIST_HEAD(, pf_state) states;
1467 extern u_long pf_hashmask;
1468 extern u_long pf_srchashmask;
1469 #define PF_HASHSIZ (32768)
1470 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1471 VNET_DECLARE(struct pf_idhash *, pf_idhash);
1472 #define V_pf_keyhash VNET(pf_keyhash)
1473 #define V_pf_idhash VNET(pf_idhash)
1474 VNET_DECLARE(struct pf_srchash *, pf_srchash);
1475 #define V_pf_srchash VNET(pf_srchash)
1477 #define PF_IDHASH(s) (be64toh((s)->id) % (pf_hashmask + 1))
1479 VNET_DECLARE(void *, pf_swi_cookie);
1480 #define V_pf_swi_cookie VNET(pf_swi_cookie)
1482 VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1483 #define V_pf_stateid VNET(pf_stateid)
1485 TAILQ_HEAD(pf_altqqueue, pf_altq);
1486 VNET_DECLARE(struct pf_altqqueue, pf_altqs[2]);
1487 #define V_pf_altqs VNET(pf_altqs)
1488 VNET_DECLARE(struct pf_palist, pf_pabuf);
1489 #define V_pf_pabuf VNET(pf_pabuf)
1491 VNET_DECLARE(u_int32_t, ticket_altqs_active);
1492 #define V_ticket_altqs_active VNET(ticket_altqs_active)
1493 VNET_DECLARE(u_int32_t, ticket_altqs_inactive);
1494 #define V_ticket_altqs_inactive VNET(ticket_altqs_inactive)
1495 VNET_DECLARE(int, altqs_inactive_open);
1496 #define V_altqs_inactive_open VNET(altqs_inactive_open)
1497 VNET_DECLARE(u_int32_t, ticket_pabuf);
1498 #define V_ticket_pabuf VNET(ticket_pabuf)
1499 VNET_DECLARE(struct pf_altqqueue *, pf_altqs_active);
1500 #define V_pf_altqs_active VNET(pf_altqs_active)
1501 VNET_DECLARE(struct pf_altqqueue *, pf_altqs_inactive);
1502 #define V_pf_altqs_inactive VNET(pf_altqs_inactive)
1504 VNET_DECLARE(struct pf_rulequeue, pf_unlinked_rules);
1505 #define V_pf_unlinked_rules VNET(pf_unlinked_rules)
1507 void pf_initialize(void);
1508 void pf_mtag_initialize(void);
1509 void pf_mtag_cleanup(void);
1510 void pf_cleanup(void);
1512 struct pf_mtag *pf_get_mtag(struct mbuf *);
1514 extern void pf_calc_skip_steps(struct pf_rulequeue *);
1516 extern void pf_altq_ifnet_event(struct ifnet *, int);
1518 VNET_DECLARE(uma_zone_t, pf_state_z);
1519 #define V_pf_state_z VNET(pf_state_z)
1520 VNET_DECLARE(uma_zone_t, pf_state_key_z);
1521 #define V_pf_state_key_z VNET(pf_state_key_z)
1522 VNET_DECLARE(uma_zone_t, pf_state_scrub_z);
1523 #define V_pf_state_scrub_z VNET(pf_state_scrub_z)
1525 extern void pf_purge_thread(void *);
1526 extern void pf_unload_vnet_purge(void);
1527 extern void pf_intr(void *);
1528 extern void pf_purge_expired_src_nodes(void);
1530 extern int pf_unlink_state(struct pf_state *, u_int);
1531 #define PF_ENTER_LOCKED 0x00000001
1532 #define PF_RETURN_LOCKED 0x00000002
1533 extern int pf_state_insert(struct pfi_kif *,
1534 struct pf_state_key *,
1535 struct pf_state_key *,
1537 extern void pf_free_state(struct pf_state *);
1539 static __inline void
1540 pf_ref_state(struct pf_state *s)
1543 refcount_acquire(&s->refs);
1547 pf_release_state(struct pf_state *s)
1550 if (refcount_release(&s->refs)) {
1557 extern struct pf_state *pf_find_state_byid(uint64_t, uint32_t);
1558 extern struct pf_state *pf_find_state_all(struct pf_state_key_cmp *,
1560 extern struct pf_src_node *pf_find_src_node(struct pf_addr *,
1561 struct pf_rule *, sa_family_t, int);
1562 extern void pf_unlink_src_node(struct pf_src_node *);
1563 extern u_int pf_free_src_nodes(struct pf_src_node_list *);
1564 extern void pf_print_state(struct pf_state *);
1565 extern void pf_print_flags(u_int8_t);
1566 extern u_int16_t pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1568 extern u_int16_t pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1569 u_int16_t, u_int16_t, u_int8_t);
1571 VNET_DECLARE(struct ifnet *, sync_ifp);
1572 #define V_sync_ifp VNET(sync_ifp);
1573 VNET_DECLARE(struct pf_rule, pf_default_rule);
1574 #define V_pf_default_rule VNET(pf_default_rule)
1575 extern void pf_addrcpy(struct pf_addr *, struct pf_addr *,
1577 void pf_free_rule(struct pf_rule *);
1580 int pf_test(int, struct ifnet *, struct mbuf **, struct inpcb *);
1581 int pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1586 int pf_test6(int, struct ifnet *, struct mbuf **, struct inpcb *);
1587 int pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1589 void pf_poolmask(struct pf_addr *, struct pf_addr*,
1590 struct pf_addr *, struct pf_addr *, u_int8_t);
1591 void pf_addr_inc(struct pf_addr *, sa_family_t);
1592 int pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *);
1595 u_int32_t pf_new_isn(struct pf_state *);
1596 void *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1598 void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1599 void pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1601 void pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1602 void pf_send_deferred_syn(struct pf_state *);
1603 int pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1604 struct pf_addr *, sa_family_t);
1605 int pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1606 struct pf_addr *, sa_family_t);
1607 int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1609 void pf_normalize_init(void);
1610 void pf_normalize_cleanup(void);
1611 int pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1613 void pf_normalize_tcp_cleanup(struct pf_state *);
1614 int pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1615 struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1616 int pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1617 u_short *, struct tcphdr *, struct pf_state *,
1618 struct pf_state_peer *, struct pf_state_peer *, int *);
1620 pf_state_expires(const struct pf_state *);
1621 void pf_purge_expired_fragments(void);
1622 void pf_purge_fragments(uint32_t);
1623 int pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1625 int pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1626 struct pf_state_key *pf_alloc_state_key(int);
1627 void pfr_initialize(void);
1628 void pfr_cleanup(void);
1629 int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1630 void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1631 u_int64_t, int, int, int);
1632 int pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1633 void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1635 pfr_attach_table(struct pf_ruleset *, char *);
1636 void pfr_detach_table(struct pfr_ktable *);
1637 int pfr_clr_tables(struct pfr_table *, int *, int);
1638 int pfr_add_tables(struct pfr_table *, int, int *, int);
1639 int pfr_del_tables(struct pfr_table *, int, int *, int);
1640 int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1641 int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1642 int pfr_clr_tstats(struct pfr_table *, int, int *, int);
1643 int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1644 int pfr_clr_addrs(struct pfr_table *, int *, int);
1645 int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1646 int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1648 int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1650 int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1651 int *, int *, int *, int, u_int32_t);
1652 int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1653 int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1654 int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1656 int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1658 int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1659 int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1660 int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1661 int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1662 int *, u_int32_t, int);
1664 MALLOC_DECLARE(PFI_MTYPE);
1665 VNET_DECLARE(struct pfi_kif *, pfi_all);
1666 #define V_pfi_all VNET(pfi_all)
1668 void pfi_initialize(void);
1669 void pfi_initialize_vnet(void);
1670 void pfi_cleanup(void);
1671 void pfi_cleanup_vnet(void);
1672 void pfi_kif_ref(struct pfi_kif *);
1673 void pfi_kif_unref(struct pfi_kif *);
1674 struct pfi_kif *pfi_kif_find(const char *);
1675 struct pfi_kif *pfi_kif_attach(struct pfi_kif *, const char *);
1676 int pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1677 void pfi_kif_purge(void);
1678 int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1680 int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1681 void pfi_dynaddr_remove(struct pfi_dynaddr *);
1682 void pfi_dynaddr_copyout(struct pf_addr_wrap *);
1683 void pfi_update_status(const char *, struct pf_status *);
1684 void pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1685 int pfi_set_flags(const char *, int);
1686 int pfi_clear_flags(const char *, int);
1688 int pf_match_tag(struct mbuf *, struct pf_rule *, int *, int);
1689 int pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1690 int pf_addr_cmp(struct pf_addr *, struct pf_addr *,
1692 void pf_qid2qname(u_int32_t, char *);
1694 VNET_DECLARE(struct pf_kstatus, pf_status);
1695 #define V_pf_status VNET(pf_status)
1701 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1702 #define V_pf_limits VNET(pf_limits)
1704 #endif /* _KERNEL */
1707 VNET_DECLARE(struct pf_anchor_global, pf_anchors);
1708 #define V_pf_anchors VNET(pf_anchors)
1709 VNET_DECLARE(struct pf_anchor, pf_main_anchor);
1710 #define V_pf_main_anchor VNET(pf_main_anchor)
1711 #define pf_main_ruleset V_pf_main_anchor.ruleset
1714 /* these ruleset functions can be linked into userland programs (pfctl) */
1715 int pf_get_ruleset_number(u_int8_t);
1716 void pf_init_ruleset(struct pf_ruleset *);
1717 int pf_anchor_setup(struct pf_rule *,
1718 const struct pf_ruleset *, const char *);
1719 int pf_anchor_copyout(const struct pf_ruleset *,
1720 const struct pf_rule *, struct pfioc_rule *);
1721 void pf_anchor_remove(struct pf_rule *);
1722 void pf_remove_if_empty_ruleset(struct pf_ruleset *);
1723 struct pf_ruleset *pf_find_ruleset(const char *);
1724 struct pf_ruleset *pf_find_or_create_ruleset(const char *);
1725 void pf_rs_initialize(void);
1727 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1728 int pf_osfp_add(struct pf_osfp_ioctl *);
1730 struct pf_osfp_enlist *
1731 pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1732 const struct tcphdr *);
1733 #endif /* _KERNEL */
1734 void pf_osfp_flush(void);
1735 int pf_osfp_get(struct pf_osfp_ioctl *);
1736 int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1739 void pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1741 void pf_step_into_anchor(struct pf_anchor_stackframe *, int *,
1742 struct pf_ruleset **, int, struct pf_rule **,
1743 struct pf_rule **, int *);
1744 int pf_step_out_of_anchor(struct pf_anchor_stackframe *, int *,
1745 struct pf_ruleset **, int, struct pf_rule **,
1746 struct pf_rule **, int *);
1748 int pf_map_addr(u_int8_t, struct pf_rule *,
1749 struct pf_addr *, struct pf_addr *,
1750 struct pf_addr *, struct pf_src_node **);
1751 struct pf_rule *pf_get_translation(struct pf_pdesc *, struct mbuf *,
1752 int, int, struct pfi_kif *, struct pf_src_node **,
1753 struct pf_state_key **, struct pf_state_key **,
1754 struct pf_addr *, struct pf_addr *,
1755 uint16_t, uint16_t, struct pf_anchor_stackframe *);
1757 struct pf_state_key *pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1758 struct pf_addr *, u_int16_t, u_int16_t);
1759 struct pf_state_key *pf_state_key_clone(struct pf_state_key *);
1760 #endif /* _KERNEL */
1762 #endif /* _NET_PFVAR_H_ */