sys/net/pfvar.h

   1 /*
   2  * Copyright (c) 2001 Daniel Hartmeier
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  *    - Redistributions of source code must retain the above copyright
  10  *      notice, this list of conditions and the following disclaimer.
  11  *    - Redistributions in binary form must reproduce the above
  12  *      copyright notice, this list of conditions and the following
  13  *      disclaimer in the documentation and/or other materials provided
  14  *      with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  19  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  20  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  24  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27  * POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  *      $OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
  30  *      $FreeBSD$
  31  */
  32
  33 #ifndef _NET_PFVAR_H_
  34 #define _NET_PFVAR_H_
  35
  36 #include <sys/param.h>
  37 #include <sys/queue.h>
  38 #include <sys/refcount.h>
  39 #include <sys/tree.h>
  40
  41 #include <net/radix.h>
  42 #include <netinet/in.h>
  43
  44 #include <netpfil/pf/pf.h>
  45 #include <netpfil/pf/pf_altq.h>
  46 #include <netpfil/pf/pf_mtag.h>
  47
  48 struct pf_addr {
  49         union {
  50                 struct in_addr          v4;
  51                 struct in6_addr         v6;
  52                 u_int8_t                addr8[16];
  53                 u_int16_t               addr16[8];
  54                 u_int32_t               addr32[4];
  55         } pfa;              /* 128-bit address */
  56 #define v4      pfa.v4
  57 #define v6      pfa.v6
  58 #define addr8   pfa.addr8
  59 #define addr16  pfa.addr16
  60 #define addr32  pfa.addr32
  61 };
  62
  63 #define PFI_AFLAG_NETWORK       0x01
  64 #define PFI_AFLAG_BROADCAST     0x02
  65 #define PFI_AFLAG_PEER          0x04
  66 #define PFI_AFLAG_MODEMASK      0x07
  67 #define PFI_AFLAG_NOALIAS       0x08
  68
  69 struct pf_addr_wrap {
  70         union {
  71                 struct {
  72                         struct pf_addr           addr;
  73                         struct pf_addr           mask;
  74                 }                        a;
  75                 char                     ifname[IFNAMSIZ];
  76                 char                     tblname[PF_TABLE_NAME_SIZE];
  77         }                        v;
  78         union {
  79                 struct pfi_dynaddr      *dyn;
  80                 struct pfr_ktable       *tbl;
  81                 int                      dyncnt;
  82                 int                      tblcnt;
  83         }                        p;
  84         u_int8_t                 type;          /* PF_ADDR_* */
  85         u_int8_t                 iflags;        /* PFI_AFLAG_* */
  86 };
  87
  88 #ifdef _KERNEL
  89
  90 struct pfi_dynaddr {
  91         TAILQ_ENTRY(pfi_dynaddr)         entry;
  92         struct pf_addr                   pfid_addr4;
  93         struct pf_addr                   pfid_mask4;
  94         struct pf_addr                   pfid_addr6;
  95         struct pf_addr                   pfid_mask6;
  96         struct pfr_ktable               *pfid_kt;
  97         struct pfi_kif                  *pfid_kif;
  98         int                              pfid_net;      /* mask or 128 */
  99         int                              pfid_acnt4;    /* address count IPv4 */
 100         int                              pfid_acnt6;    /* address count IPv6 */
 101         sa_family_t                      pfid_af;       /* rule af */
 102         u_int8_t                         pfid_iflags;   /* PFI_AFLAG_* */
 103 };
 104
 105 /*
 106  * Address manipulation macros
 107  */
 108 #define HTONL(x)        (x) = htonl((__uint32_t)(x))
 109 #define HTONS(x)        (x) = htons((__uint16_t)(x))
 110 #define NTOHL(x)        (x) = ntohl((__uint32_t)(x))
 111 #define NTOHS(x)        (x) = ntohs((__uint16_t)(x))
 112
 113 #define PF_NAME         "pf"
 114
 115 #define PF_HASHROW_ASSERT(h)    mtx_assert(&(h)->lock, MA_OWNED)
 116 #define PF_HASHROW_LOCK(h)      mtx_lock(&(h)->lock)
 117 #define PF_HASHROW_UNLOCK(h)    mtx_unlock(&(h)->lock)
 118
 119 #define PF_STATE_LOCK(s)                                                \
 120         do {                                                            \
 121                 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];     \
 122                 PF_HASHROW_LOCK(_ih);                                   \
 123         } while (0)
 124
 125 #define PF_STATE_UNLOCK(s)                                              \
 126         do {                                                            \
 127                 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))];   \
 128                 PF_HASHROW_UNLOCK(_ih);                                 \
 129         } while (0)
 130
 131 #ifdef INVARIANTS
 132 #define PF_STATE_LOCK_ASSERT(s)                                         \
 133         do {                                                            \
 134                 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];     \
 135                 PF_HASHROW_ASSERT(_ih);                                 \
 136         } while (0)
 137 #else /* !INVARIANTS */
 138 #define PF_STATE_LOCK_ASSERT(s)         do {} while (0)
 139 #endif /* INVARIANTS */
 140
 141 extern struct mtx pf_unlnkdrules_mtx;
 142 #define PF_UNLNKDRULES_LOCK()   mtx_lock(&pf_unlnkdrules_mtx)
 143 #define PF_UNLNKDRULES_UNLOCK() mtx_unlock(&pf_unlnkdrules_mtx)
 144
 145 extern struct rwlock pf_rules_lock;
 146 #define PF_RULES_RLOCK()        rw_rlock(&pf_rules_lock)
 147 #define PF_RULES_RUNLOCK()      rw_runlock(&pf_rules_lock)
 148 #define PF_RULES_WLOCK()        rw_wlock(&pf_rules_lock)
 149 #define PF_RULES_WUNLOCK()      rw_wunlock(&pf_rules_lock)
 150 #define PF_RULES_ASSERT()       rw_assert(&pf_rules_lock, RA_LOCKED)
 151 #define PF_RULES_RASSERT()      rw_assert(&pf_rules_lock, RA_RLOCKED)
 152 #define PF_RULES_WASSERT()      rw_assert(&pf_rules_lock, RA_WLOCKED)
 153
 154 #define PF_MODVER       1
 155 #define PFLOG_MODVER    1
 156 #define PFSYNC_MODVER   1
 157
 158 #define PFLOG_MINVER    1
 159 #define PFLOG_PREFVER   PFLOG_MODVER
 160 #define PFLOG_MAXVER    1
 161 #define PFSYNC_MINVER   1
 162 #define PFSYNC_PREFVER  PFSYNC_MODVER
 163 #define PFSYNC_MAXVER   1
 164
 165 #ifdef INET
 166 #ifndef INET6
 167 #define PF_INET_ONLY
 168 #endif /* ! INET6 */
 169 #endif /* INET */
 170
 171 #ifdef INET6
 172 #ifndef INET
 173 #define PF_INET6_ONLY
 174 #endif /* ! INET */
 175 #endif /* INET6 */
 176
 177 #ifdef INET
 178 #ifdef INET6
 179 #define PF_INET_INET6
 180 #endif /* INET6 */
 181 #endif /* INET */
 182
 183 #else
 184
 185 #define PF_INET_INET6
 186
 187 #endif /* _KERNEL */
 188
 189 /* Both IPv4 and IPv6 */
 190 #ifdef PF_INET_INET6
 191
 192 #define PF_AEQ(a, b, c) \
 193         ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
 194         ((a)->addr32[3] == (b)->addr32[3] && \
 195         (a)->addr32[2] == (b)->addr32[2] && \
 196         (a)->addr32[1] == (b)->addr32[1] && \
 197         (a)->addr32[0] == (b)->addr32[0])) \
 198
 199 #define PF_ANEQ(a, b, c) \
 200         ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
 201         ((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])) \
 205
 206 #define PF_AZERO(a, c) \
 207         ((c == AF_INET && !(a)->addr32[0]) || \
 208         (!(a)->addr32[0] && !(a)->addr32[1] && \
 209         !(a)->addr32[2] && !(a)->addr32[3] )) \
 210
 211 #define PF_MATCHA(n, a, m, b, f) \
 212         pf_match_addr(n, a, m, b, f)
 213
 214 #define PF_ACPY(a, b, f) \
 215         pf_addrcpy(a, b, f)
 216
 217 #define PF_AINC(a, f) \
 218         pf_addr_inc(a, f)
 219
 220 #define PF_POOLMASK(a, b, c, d, f) \
 221         pf_poolmask(a, b, c, d, f)
 222
 223 #else
 224
 225 /* Just IPv6 */
 226
 227 #ifdef PF_INET6_ONLY
 228
 229 #define PF_AEQ(a, b, c) \
 230         ((a)->addr32[3] == (b)->addr32[3] && \
 231         (a)->addr32[2] == (b)->addr32[2] && \
 232         (a)->addr32[1] == (b)->addr32[1] && \
 233         (a)->addr32[0] == (b)->addr32[0]) \
 234
 235 #define PF_ANEQ(a, b, c) \
 236         ((a)->addr32[3] != (b)->addr32[3] || \
 237         (a)->addr32[2] != (b)->addr32[2] || \
 238         (a)->addr32[1] != (b)->addr32[1] || \
 239         (a)->addr32[0] != (b)->addr32[0]) \
 240
 241 #define PF_AZERO(a, c) \
 242         (!(a)->addr32[0] && \
 243         !(a)->addr32[1] && \
 244         !(a)->addr32[2] && \
 245         !(a)->addr32[3] ) \
 246
 247 #define PF_MATCHA(n, a, m, b, f) \
 248         pf_match_addr(n, a, m, b, f)
 249
 250 #define PF_ACPY(a, b, f) \
 251         pf_addrcpy(a, b, f)
 252
 253 #define PF_AINC(a, f) \
 254         pf_addr_inc(a, f)
 255
 256 #define PF_POOLMASK(a, b, c, d, f) \
 257         pf_poolmask(a, b, c, d, f)
 258
 259 #else
 260
 261 /* Just IPv4 */
 262 #ifdef PF_INET_ONLY
 263
 264 #define PF_AEQ(a, b, c) \
 265         ((a)->addr32[0] == (b)->addr32[0])
 266
 267 #define PF_ANEQ(a, b, c) \
 268         ((a)->addr32[0] != (b)->addr32[0])
 269
 270 #define PF_AZERO(a, c) \
 271         (!(a)->addr32[0])
 272
 273 #define PF_MATCHA(n, a, m, b, f) \
 274         pf_match_addr(n, a, m, b, f)
 275
 276 #define PF_ACPY(a, b, f) \
 277         (a)->v4.s_addr = (b)->v4.s_addr
 278
 279 #define PF_AINC(a, f) \
 280         do { \
 281                 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
 282         } while (0)
 283
 284 #define PF_POOLMASK(a, b, c, d, f) \
 285         do { \
 286                 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
 287                 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
 288         } while (0)
 289
 290 #endif /* PF_INET_ONLY */
 291 #endif /* PF_INET6_ONLY */
 292 #endif /* PF_INET_INET6 */
 293
 294 /*
 295  * XXX callers not FIB-aware in our version of pf yet.
 296  * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
 297  */
 298 #define PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)                        \
 299         (                                                               \
 300                 (((aw)->type == PF_ADDR_NOROUTE &&                      \
 301                     pf_routable((x), (af), NULL, (rtid))) ||            \
 302                 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&  \
 303                     pf_routable((x), (af), (ifp), (rtid))) ||           \
 304                 ((aw)->type == PF_ADDR_TABLE &&                         \
 305                     !pfr_match_addr((aw)->p.tbl, (x), (af))) ||         \
 306                 ((aw)->type == PF_ADDR_DYNIFTL &&                       \
 307                     !pfi_match_addr((aw)->p.dyn, (x), (af))) ||         \
 308                 ((aw)->type == PF_ADDR_RANGE &&                         \
 309                     !pf_match_addr_range(&(aw)->v.a.addr,               \
 310                     &(aw)->v.a.mask, (x), (af))) ||                     \
 311                 ((aw)->type == PF_ADDR_ADDRMASK &&                      \
 312                     !PF_AZERO(&(aw)->v.a.mask, (af)) &&                 \
 313                     !PF_MATCHA(0, &(aw)->v.a.addr,                      \
 314                     &(aw)->v.a.mask, (x), (af))))) !=                   \
 315                 (neg)                                                   \
 316         )
 317
 318
 319 struct pf_rule_uid {
 320         uid_t            uid[2];
 321         u_int8_t         op;
 322 };
 323
 324 struct pf_rule_gid {
 325         uid_t            gid[2];
 326         u_int8_t         op;
 327 };
 328
 329 struct pf_rule_addr {
 330         struct pf_addr_wrap      addr;
 331         u_int16_t                port[2];
 332         u_int8_t                 neg;
 333         u_int8_t                 port_op;
 334 };
 335
 336 struct pf_pooladdr {
 337         struct pf_addr_wrap              addr;
 338         TAILQ_ENTRY(pf_pooladdr)         entries;
 339         char                             ifname[IFNAMSIZ];
 340         struct pfi_kif                  *kif;
 341 };
 342
 343 TAILQ_HEAD(pf_palist, pf_pooladdr);
 344
 345 struct pf_poolhashkey {
 346         union {
 347                 u_int8_t                key8[16];
 348                 u_int16_t               key16[8];
 349                 u_int32_t               key32[4];
 350         } pfk;              /* 128-bit hash key */
 351 #define key8    pfk.key8
 352 #define key16   pfk.key16
 353 #define key32   pfk.key32
 354 };
 355
 356 struct pf_pool {
 357         struct pf_palist         list;
 358         struct pf_pooladdr      *cur;
 359         struct pf_poolhashkey    key;
 360         struct pf_addr           counter;
 361         int                      tblidx;
 362         u_int16_t                proxy_port[2];
 363         u_int8_t                 opts;
 364 };
 365
 366
 367 /* A packed Operating System description for fingerprinting */
 368 typedef u_int32_t pf_osfp_t;
 369 #define PF_OSFP_ANY     ((pf_osfp_t)0)
 370 #define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
 371 #define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
 372
 373 struct pf_osfp_entry {
 374         SLIST_ENTRY(pf_osfp_entry) fp_entry;
 375         pf_osfp_t               fp_os;
 376         int                     fp_enflags;
 377 #define PF_OSFP_EXPANDED        0x001           /* expanded entry */
 378 #define PF_OSFP_GENERIC         0x002           /* generic signature */
 379 #define PF_OSFP_NODETAIL        0x004           /* no p0f details */
 380 #define PF_OSFP_LEN     32
 381         char                    fp_class_nm[PF_OSFP_LEN];
 382         char                    fp_version_nm[PF_OSFP_LEN];
 383         char                    fp_subtype_nm[PF_OSFP_LEN];
 384 };
 385 #define PF_OSFP_ENTRY_EQ(a, b) \
 386     ((a)->fp_os == (b)->fp_os && \
 387     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
 388     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
 389     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
 390
 391 /* handle pf_osfp_t packing */
 392 #define _FP_RESERVED_BIT        1  /* For the special negative #defines */
 393 #define _FP_UNUSED_BITS         1
 394 #define _FP_CLASS_BITS          10 /* OS Class (Windows, Linux) */
 395 #define _FP_VERSION_BITS        10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
 396 #define _FP_SUBTYPE_BITS        10 /* patch level (NT SP4, SP3, ECN patch) */
 397 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
 398         (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
 399             ((1 << _FP_CLASS_BITS) - 1); \
 400         (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
 401             ((1 << _FP_VERSION_BITS) - 1);\
 402         (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
 403 } while(0)
 404 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
 405         (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
 406             + _FP_SUBTYPE_BITS); \
 407         (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
 408             _FP_SUBTYPE_BITS; \
 409         (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
 410 } while(0)
 411
 412 /* the fingerprint of an OSes TCP SYN packet */
 413 typedef u_int64_t       pf_tcpopts_t;
 414 struct pf_os_fingerprint {
 415         SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
 416         pf_tcpopts_t            fp_tcpopts;     /* packed TCP options */
 417         u_int16_t               fp_wsize;       /* TCP window size */
 418         u_int16_t               fp_psize;       /* ip->ip_len */
 419         u_int16_t               fp_mss;         /* TCP MSS */
 420         u_int16_t               fp_flags;
 421 #define PF_OSFP_WSIZE_MOD       0x0001          /* Window modulus */
 422 #define PF_OSFP_WSIZE_DC        0x0002          /* Window don't care */
 423 #define PF_OSFP_WSIZE_MSS       0x0004          /* Window multiple of MSS */
 424 #define PF_OSFP_WSIZE_MTU       0x0008          /* Window multiple of MTU */
 425 #define PF_OSFP_PSIZE_MOD       0x0010          /* packet size modulus */
 426 #define PF_OSFP_PSIZE_DC        0x0020          /* packet size don't care */
 427 #define PF_OSFP_WSCALE          0x0040          /* TCP window scaling */
 428 #define PF_OSFP_WSCALE_MOD      0x0080          /* TCP window scale modulus */
 429 #define PF_OSFP_WSCALE_DC       0x0100          /* TCP window scale dont-care */
 430 #define PF_OSFP_MSS             0x0200          /* TCP MSS */
 431 #define PF_OSFP_MSS_MOD         0x0400          /* TCP MSS modulus */
 432 #define PF_OSFP_MSS_DC          0x0800          /* TCP MSS dont-care */
 433 #define PF_OSFP_DF              0x1000          /* IPv4 don't fragment bit */
 434 #define PF_OSFP_TS0             0x2000          /* Zero timestamp */
 435 #define PF_OSFP_INET6           0x4000          /* IPv6 */
 436         u_int8_t                fp_optcnt;      /* TCP option count */
 437         u_int8_t                fp_wscale;      /* TCP window scaling */
 438         u_int8_t                fp_ttl;         /* IPv4 TTL */
 439 #define PF_OSFP_MAXTTL_OFFSET   40
 440 /* TCP options packing */
 441 #define PF_OSFP_TCPOPT_NOP      0x0             /* TCP NOP option */
 442 #define PF_OSFP_TCPOPT_WSCALE   0x1             /* TCP window scaling option */
 443 #define PF_OSFP_TCPOPT_MSS      0x2             /* TCP max segment size opt */
 444 #define PF_OSFP_TCPOPT_SACK     0x3             /* TCP SACK OK option */
 445 #define PF_OSFP_TCPOPT_TS       0x4             /* TCP timestamp option */
 446 #define PF_OSFP_TCPOPT_BITS     3               /* bits used by each option */
 447 #define PF_OSFP_MAX_OPTS \
 448     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
 449     / PF_OSFP_TCPOPT_BITS
 450
 451         SLIST_ENTRY(pf_os_fingerprint)  fp_next;
 452 };
 453
 454 struct pf_osfp_ioctl {
 455         struct pf_osfp_entry    fp_os;
 456         pf_tcpopts_t            fp_tcpopts;     /* packed TCP options */
 457         u_int16_t               fp_wsize;       /* TCP window size */
 458         u_int16_t               fp_psize;       /* ip->ip_len */
 459         u_int16_t               fp_mss;         /* TCP MSS */
 460         u_int16_t               fp_flags;
 461         u_int8_t                fp_optcnt;      /* TCP option count */
 462         u_int8_t                fp_wscale;      /* TCP window scaling */
 463         u_int8_t                fp_ttl;         /* IPv4 TTL */
 464
 465         int                     fp_getnum;      /* DIOCOSFPGET number */
 466 };
 467
 468
 469 union pf_rule_ptr {
 470         struct pf_rule          *ptr;
 471         u_int32_t                nr;
 472 };
 473
 474 #define PF_ANCHOR_NAME_SIZE      64
 475
 476 struct pf_rule {
 477         struct pf_rule_addr      src;
 478         struct pf_rule_addr      dst;
 479 #define PF_SKIP_IFP             0
 480 #define PF_SKIP_DIR             1
 481 #define PF_SKIP_AF              2
 482 #define PF_SKIP_PROTO           3
 483 #define PF_SKIP_SRC_ADDR        4
 484 #define PF_SKIP_SRC_PORT        5
 485 #define PF_SKIP_DST_ADDR        6
 486 #define PF_SKIP_DST_PORT        7
 487 #define PF_SKIP_COUNT           8
 488         union pf_rule_ptr        skip[PF_SKIP_COUNT];
 489 #define PF_RULE_LABEL_SIZE       64
 490         char                     label[PF_RULE_LABEL_SIZE];
 491         char                     ifname[IFNAMSIZ];
 492         char                     qname[PF_QNAME_SIZE];
 493         char                     pqname[PF_QNAME_SIZE];
 494 #define PF_TAG_NAME_SIZE         64
 495         char                     tagname[PF_TAG_NAME_SIZE];
 496         char                     match_tagname[PF_TAG_NAME_SIZE];
 497
 498         char                     overload_tblname[PF_TABLE_NAME_SIZE];
 499
 500         TAILQ_ENTRY(pf_rule)     entries;
 501         struct pf_pool           rpool;
 502
 503         u_int64_t                evaluations;
 504         u_int64_t                packets[2];
 505         u_int64_t                bytes[2];
 506
 507         struct pfi_kif          *kif;
 508         struct pf_anchor        *anchor;
 509         struct pfr_ktable       *overload_tbl;
 510
 511         pf_osfp_t                os_fingerprint;
 512
 513         int                      rtableid;
 514         u_int32_t                timeout[PFTM_MAX];
 515         u_int32_t                states_cur;
 516         u_int32_t                states_tot;
 517         u_int32_t                max_states;
 518         u_int32_t                src_nodes;
 519         u_int32_t                max_src_nodes;
 520         u_int32_t                max_src_states;
 521         u_int32_t                spare1;                        /* netgraph */
 522         u_int32_t                max_src_conn;
 523         struct {
 524                 u_int32_t               limit;
 525                 u_int32_t               seconds;
 526         }                        max_src_conn_rate;
 527         u_int32_t                qid;
 528         u_int32_t                pqid;
 529         u_int32_t                rt_listid;
 530         u_int32_t                nr;
 531         u_int32_t                prob;
 532         uid_t                    cuid;
 533         pid_t                    cpid;
 534
 535         u_int16_t                return_icmp;
 536         u_int16_t                return_icmp6;
 537         u_int16_t                max_mss;
 538         u_int16_t                tag;
 539         u_int16_t                match_tag;
 540         u_int16_t                spare2;                        /* netgraph */
 541
 542         struct pf_rule_uid       uid;
 543         struct pf_rule_gid       gid;
 544
 545         u_int32_t                rule_flag;
 546         u_int8_t                 action;
 547         u_int8_t                 direction;
 548         u_int8_t                 log;
 549         u_int8_t                 logif;
 550         u_int8_t                 quick;
 551         u_int8_t                 ifnot;
 552         u_int8_t                 match_tag_not;
 553         u_int8_t                 natpass;
 554
 555 #define PF_STATE_NORMAL         0x1
 556 #define PF_STATE_MODULATE       0x2
 557 #define PF_STATE_SYNPROXY       0x3
 558         u_int8_t                 keep_state;
 559         sa_family_t              af;
 560         u_int8_t                 proto;
 561         u_int8_t                 type;
 562         u_int8_t                 code;
 563         u_int8_t                 flags;
 564         u_int8_t                 flagset;
 565         u_int8_t                 min_ttl;
 566         u_int8_t                 allow_opts;
 567         u_int8_t                 rt;
 568         u_int8_t                 return_ttl;
 569         u_int8_t                 tos;
 570         u_int8_t                 set_tos;
 571         u_int8_t                 anchor_relative;
 572         u_int8_t                 anchor_wildcard;
 573
 574 #define PF_FLUSH                0x01
 575 #define PF_FLUSH_GLOBAL         0x02
 576         u_int8_t                 flush;
 577
 578         struct {
 579                 struct pf_addr          addr;
 580                 u_int16_t               port;
 581         }                       divert;
 582 };
 583
 584 /* rule flags */
 585 #define PFRULE_DROP             0x0000
 586 #define PFRULE_RETURNRST        0x0001
 587 #define PFRULE_FRAGMENT         0x0002
 588 #define PFRULE_RETURNICMP       0x0004
 589 #define PFRULE_RETURN           0x0008
 590 #define PFRULE_NOSYNC           0x0010
 591 #define PFRULE_SRCTRACK         0x0020  /* track source states */
 592 #define PFRULE_RULESRCTRACK     0x0040  /* per rule */
 593 #define PFRULE_REFS             0x0080  /* rule has references */
 594
 595 /* scrub flags */
 596 #define PFRULE_NODF             0x0100
 597 #define PFRULE_FRAGCROP         0x0200  /* non-buffering frag cache */
 598 #define PFRULE_FRAGDROP         0x0400  /* drop funny fragments */
 599 #define PFRULE_RANDOMID         0x0800
 600 #define PFRULE_REASSEMBLE_TCP   0x1000
 601 #define PFRULE_SET_TOS          0x2000
 602
 603 /* rule flags again */
 604 #define PFRULE_IFBOUND          0x00010000      /* if-bound */
 605 #define PFRULE_STATESLOPPY      0x00020000      /* sloppy state tracking */
 606
 607 #define PFSTATE_HIWAT           10000   /* default state table size */
 608 #define PFSTATE_ADAPT_START     6000    /* default adaptive timeout start */
 609 #define PFSTATE_ADAPT_END       12000   /* default adaptive timeout end */
 610
 611
 612 struct pf_threshold {
 613         u_int32_t       limit;
 614 #define PF_THRESHOLD_MULT       1000
 615 #define PF_THRESHOLD_MAX        0xffffffff / PF_THRESHOLD_MULT
 616         u_int32_t       seconds;
 617         u_int32_t       count;
 618         u_int32_t       last;
 619 };
 620
 621 struct pf_src_node {
 622         LIST_ENTRY(pf_src_node) entry;
 623         struct pf_addr   addr;
 624         struct pf_addr   raddr;
 625         union pf_rule_ptr rule;
 626         struct pfi_kif  *kif;
 627         u_int64_t        bytes[2];
 628         u_int64_t        packets[2];
 629         u_int32_t        states;
 630         u_int32_t        conn;
 631         struct pf_threshold     conn_rate;
 632         u_int32_t        creation;
 633         u_int32_t        expire;
 634         sa_family_t      af;
 635         u_int8_t         ruletype;
 636 };
 637
 638 #define PFSNODE_HIWAT           10000   /* default source node table size */
 639
 640 struct pf_state_scrub {
 641         struct timeval  pfss_last;      /* time received last packet    */
 642         u_int32_t       pfss_tsecr;     /* last echoed timestamp        */
 643         u_int32_t       pfss_tsval;     /* largest timestamp            */
 644         u_int32_t       pfss_tsval0;    /* original timestamp           */
 645         u_int16_t       pfss_flags;
 646 #define PFSS_TIMESTAMP  0x0001          /* modulate timestamp           */
 647 #define PFSS_PAWS       0x0010          /* stricter PAWS checks         */
 648 #define PFSS_PAWS_IDLED 0x0020          /* was idle too long.  no PAWS  */
 649 #define PFSS_DATA_TS    0x0040          /* timestamp on data packets    */
 650 #define PFSS_DATA_NOTS  0x0080          /* no timestamp on data packets */
 651         u_int8_t        pfss_ttl;       /* stashed TTL                  */
 652         u_int8_t        pad;
 653         u_int32_t       pfss_ts_mod;    /* timestamp modulation         */
 654 };
 655
 656 struct pf_state_host {
 657         struct pf_addr  addr;
 658         u_int16_t       port;
 659         u_int16_t       pad;
 660 };
 661
 662 struct pf_state_peer {
 663         struct pf_state_scrub   *scrub; /* state is scrubbed            */
 664         u_int32_t       seqlo;          /* Max sequence number sent     */
 665         u_int32_t       seqhi;          /* Max the other end ACKd + win */
 666         u_int32_t       seqdiff;        /* Sequence number modulator    */
 667         u_int16_t       max_win;        /* largest window (pre scaling) */
 668         u_int16_t       mss;            /* Maximum segment size option  */
 669         u_int8_t        state;          /* active state level           */
 670         u_int8_t        wscale;         /* window scaling factor        */
 671         u_int8_t        tcp_est;        /* Did we reach TCPS_ESTABLISHED */
 672         u_int8_t        pad[1];
 673 };
 674
 675 /* Keep synced with struct pf_state_key. */
 676 struct pf_state_key_cmp {
 677         struct pf_addr   addr[2];
 678         u_int16_t        port[2];
 679         sa_family_t      af;
 680         u_int8_t         proto;
 681         u_int8_t         pad[2];
 682 };
 683
 684 struct pf_state_key {
 685         struct pf_addr   addr[2];
 686         u_int16_t        port[2];
 687         sa_family_t      af;
 688         u_int8_t         proto;
 689         u_int8_t         pad[2];
 690
 691         LIST_ENTRY(pf_state_key) entry;
 692         TAILQ_HEAD(, pf_state)   states[2];
 693 };
 694
 695 /* Keep synced with struct pf_state. */
 696 struct pf_state_cmp {
 697         u_int64_t                id;
 698         u_int32_t                creatorid;
 699         u_int8_t                 direction;
 700         u_int8_t                 pad[3];
 701 };
 702
 703 struct pf_state {
 704         u_int64_t                id;
 705         u_int32_t                creatorid;
 706         u_int8_t                 direction;
 707         u_int8_t                 pad[3];
 708
 709         u_int                    refs;
 710         TAILQ_ENTRY(pf_state)    sync_list;
 711         TAILQ_ENTRY(pf_state)    key_list[2];
 712         LIST_ENTRY(pf_state)     entry;
 713         struct pf_state_peer     src;
 714         struct pf_state_peer     dst;
 715         union pf_rule_ptr        rule;
 716         union pf_rule_ptr        anchor;
 717         union pf_rule_ptr        nat_rule;
 718         struct pf_addr           rt_addr;
 719         struct pf_state_key     *key[2];        /* addresses stack and wire  */
 720         struct pfi_kif          *kif;
 721         struct pfi_kif          *rt_kif;
 722         struct pf_src_node      *src_node;
 723         struct pf_src_node      *nat_src_node;
 724         u_int64_t                packets[2];
 725         u_int64_t                bytes[2];
 726         u_int32_t                creation;
 727         u_int32_t                expire;
 728         u_int32_t                pfsync_time;
 729         u_int16_t                tag;
 730         u_int8_t                 log;
 731         u_int8_t                 state_flags;
 732 #define PFSTATE_ALLOWOPTS       0x01
 733 #define PFSTATE_SLOPPY          0x02
 734 /*  was PFSTATE_PFLOW           0x04 */
 735 #define PFSTATE_NOSYNC          0x08
 736 #define PFSTATE_ACK             0x10
 737         u_int8_t                 timeout;
 738         u_int8_t                 sync_state; /* PFSYNC_S_x */
 739
 740         /* XXX */
 741         u_int8_t                 sync_updates;
 742         u_int8_t                _tail[3];
 743 };
 744
 745 /*
 746  * Unified state structures for pulling states out of the kernel
 747  * used by pfsync(4) and the pf(4) ioctl.
 748  */
 749 struct pfsync_state_scrub {
 750         u_int16_t       pfss_flags;
 751         u_int8_t        pfss_ttl;       /* stashed TTL          */
 752 #define PFSYNC_SCRUB_FLAG_VALID         0x01
 753         u_int8_t        scrub_flag;
 754         u_int32_t       pfss_ts_mod;    /* timestamp modulation */
 755 } __packed;
 756
 757 struct pfsync_state_peer {
 758         struct pfsync_state_scrub scrub;        /* state is scrubbed    */
 759         u_int32_t       seqlo;          /* Max sequence number sent     */
 760         u_int32_t       seqhi;          /* Max the other end ACKd + win */
 761         u_int32_t       seqdiff;        /* Sequence number modulator    */
 762         u_int16_t       max_win;        /* largest window (pre scaling) */
 763         u_int16_t       mss;            /* Maximum segment size option  */
 764         u_int8_t        state;          /* active state level           */
 765         u_int8_t        wscale;         /* window scaling factor        */
 766         u_int8_t        pad[6];
 767 } __packed;
 768
 769 struct pfsync_state_key {
 770         struct pf_addr   addr[2];
 771         u_int16_t        port[2];
 772 };
 773
 774 struct pfsync_state {
 775         u_int64_t        id;
 776         char             ifname[IFNAMSIZ];
 777         struct pfsync_state_key key[2];
 778         struct pfsync_state_peer src;
 779         struct pfsync_state_peer dst;
 780         struct pf_addr   rt_addr;
 781         u_int32_t        rule;
 782         u_int32_t        anchor;
 783         u_int32_t        nat_rule;
 784         u_int32_t        creation;
 785         u_int32_t        expire;
 786         u_int32_t        packets[2][2];
 787         u_int32_t        bytes[2][2];
 788         u_int32_t        creatorid;
 789         sa_family_t      af;
 790         u_int8_t         proto;
 791         u_int8_t         direction;
 792         u_int8_t         __spare[2];
 793         u_int8_t         log;
 794         u_int8_t         state_flags;
 795         u_int8_t         timeout;
 796         u_int8_t         sync_flags;
 797         u_int8_t         updates;
 798 } __packed;
 799
 800 #ifdef _KERNEL
 801 /* pfsync */
 802 typedef int             pfsync_state_import_t(struct pfsync_state *, u_int8_t);
 803 typedef void            pfsync_insert_state_t(struct pf_state *);
 804 typedef void            pfsync_update_state_t(struct pf_state *);
 805 typedef void            pfsync_delete_state_t(struct pf_state *);
 806 typedef void            pfsync_clear_states_t(u_int32_t, const char *);
 807 typedef int             pfsync_defer_t(struct pf_state *, struct mbuf *);
 808
 809 extern pfsync_state_import_t    *pfsync_state_import_ptr;
 810 extern pfsync_insert_state_t    *pfsync_insert_state_ptr;
 811 extern pfsync_update_state_t    *pfsync_update_state_ptr;
 812 extern pfsync_delete_state_t    *pfsync_delete_state_ptr;
 813 extern pfsync_clear_states_t    *pfsync_clear_states_ptr;
 814 extern pfsync_defer_t           *pfsync_defer_ptr;
 815
 816 void                    pfsync_state_export(struct pfsync_state *,
 817                             struct pf_state *);
 818
 819 /* pflog */
 820 struct pf_ruleset;
 821 struct pf_pdesc;
 822 typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
 823     u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
 824     struct pf_ruleset *, struct pf_pdesc *, int);
 825 extern pflog_packet_t           *pflog_packet_ptr;
 826
 827 #define V_pf_end_threads        VNET(pf_end_threads)
 828 #endif /* _KERNEL */
 829
 830 #define PFSYNC_FLAG_SRCNODE     0x04
 831 #define PFSYNC_FLAG_NATSRCNODE  0x08
 832
 833 /* for copies to/from network byte order */
 834 /* ioctl interface also uses network byte order */
 835 #define pf_state_peer_hton(s,d) do {            \
 836         (d)->seqlo = htonl((s)->seqlo);         \
 837         (d)->seqhi = htonl((s)->seqhi);         \
 838         (d)->seqdiff = htonl((s)->seqdiff);     \
 839         (d)->max_win = htons((s)->max_win);     \
 840         (d)->mss = htons((s)->mss);             \
 841         (d)->state = (s)->state;                \
 842         (d)->wscale = (s)->wscale;              \
 843         if ((s)->scrub) {                                               \
 844                 (d)->scrub.pfss_flags =                                 \
 845                     htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);     \
 846                 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;             \
 847                 (d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
 848                 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;        \
 849         }                                                               \
 850 } while (0)
 851
 852 #define pf_state_peer_ntoh(s,d) do {            \
 853         (d)->seqlo = ntohl((s)->seqlo);         \
 854         (d)->seqhi = ntohl((s)->seqhi);         \
 855         (d)->seqdiff = ntohl((s)->seqdiff);     \
 856         (d)->max_win = ntohs((s)->max_win);     \
 857         (d)->mss = ntohs((s)->mss);             \
 858         (d)->state = (s)->state;                \
 859         (d)->wscale = (s)->wscale;              \
 860         if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID &&         \
 861             (d)->scrub != NULL) {                                       \
 862                 (d)->scrub->pfss_flags =                                \
 863                     ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;      \
 864                 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;             \
 865                 (d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
 866         }                                                               \
 867 } while (0)
 868
 869 #define pf_state_counter_hton(s,d) do {                         \
 870         d[0] = htonl((s>>32)&0xffffffff);                       \
 871         d[1] = htonl(s&0xffffffff);                             \
 872 } while (0)
 873
 874 #define pf_state_counter_from_pfsync(s)                         \
 875         (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
 876
 877 #define pf_state_counter_ntoh(s,d) do {                         \
 878         d = ntohl(s[0]);                                        \
 879         d = d<<32;                                              \
 880         d += ntohl(s[1]);                                       \
 881 } while (0)
 882
 883 TAILQ_HEAD(pf_rulequeue, pf_rule);
 884
 885 struct pf_anchor;
 886
 887 struct pf_ruleset {
 888         struct {
 889                 struct pf_rulequeue      queues[2];
 890                 struct {
 891                         struct pf_rulequeue     *ptr;
 892                         struct pf_rule          **ptr_array;
 893                         u_int32_t                rcount;
 894                         u_int32_t                ticket;
 895                         int                      open;
 896                 }                        active, inactive;
 897         }                        rules[PF_RULESET_MAX];
 898         struct pf_anchor        *anchor;
 899         u_int32_t                tticket;
 900         int                      tables;
 901         int                      topen;
 902 };
 903
 904 RB_HEAD(pf_anchor_global, pf_anchor);
 905 RB_HEAD(pf_anchor_node, pf_anchor);
 906 struct pf_anchor {
 907         RB_ENTRY(pf_anchor)      entry_global;
 908         RB_ENTRY(pf_anchor)      entry_node;
 909         struct pf_anchor        *parent;
 910         struct pf_anchor_node    children;
 911         char                     name[PF_ANCHOR_NAME_SIZE];
 912         char                     path[MAXPATHLEN];
 913         struct pf_ruleset        ruleset;
 914         int                      refcnt;        /* anchor rules */
 915         int                      match; /* XXX: used for pfctl black magic */
 916 };
 917 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
 918 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
 919
 920 #define PF_RESERVED_ANCHOR      "_pf"
 921
 922 #define PFR_TFLAG_PERSIST       0x00000001
 923 #define PFR_TFLAG_CONST         0x00000002
 924 #define PFR_TFLAG_ACTIVE        0x00000004
 925 #define PFR_TFLAG_INACTIVE      0x00000008
 926 #define PFR_TFLAG_REFERENCED    0x00000010
 927 #define PFR_TFLAG_REFDANCHOR    0x00000020
 928 #define PFR_TFLAG_COUNTERS      0x00000040
 929 /* Adjust masks below when adding flags. */
 930 #define PFR_TFLAG_USRMASK       (PFR_TFLAG_PERSIST      | \
 931                                  PFR_TFLAG_CONST        | \
 932                                  PFR_TFLAG_COUNTERS)
 933 #define PFR_TFLAG_SETMASK       (PFR_TFLAG_ACTIVE       | \
 934                                  PFR_TFLAG_INACTIVE     | \
 935                                  PFR_TFLAG_REFERENCED   | \
 936                                  PFR_TFLAG_REFDANCHOR)
 937 #define PFR_TFLAG_ALLMASK       (PFR_TFLAG_PERSIST      | \
 938                                  PFR_TFLAG_CONST        | \
 939                                  PFR_TFLAG_ACTIVE       | \
 940                                  PFR_TFLAG_INACTIVE     | \
 941                                  PFR_TFLAG_REFERENCED   | \
 942                                  PFR_TFLAG_REFDANCHOR   | \
 943                                  PFR_TFLAG_COUNTERS)
 944
 945 struct pf_anchor_stackframe;
 946
 947 struct pfr_table {
 948         char                     pfrt_anchor[MAXPATHLEN];
 949         char                     pfrt_name[PF_TABLE_NAME_SIZE];
 950         u_int32_t                pfrt_flags;
 951         u_int8_t                 pfrt_fback;
 952 };
 953
 954 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
 955         PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
 956         PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
 957
 958 struct pfr_addr {
 959         union {
 960                 struct in_addr   _pfra_ip4addr;
 961                 struct in6_addr  _pfra_ip6addr;
 962         }                pfra_u;
 963         u_int8_t         pfra_af;
 964         u_int8_t         pfra_net;
 965         u_int8_t         pfra_not;
 966         u_int8_t         pfra_fback;
 967 };
 968 #define pfra_ip4addr    pfra_u._pfra_ip4addr
 969 #define pfra_ip6addr    pfra_u._pfra_ip6addr
 970
 971 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
 972 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
 973 #define PFR_OP_XPASS    PFR_OP_ADDR_MAX
 974
 975 struct pfr_astats {
 976         struct pfr_addr  pfras_a;
 977         u_int64_t        pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
 978         u_int64_t        pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
 979         long             pfras_tzero;
 980 };
 981
 982 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
 983
 984 struct pfr_tstats {
 985         struct pfr_table pfrts_t;
 986         u_int64_t        pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
 987         u_int64_t        pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
 988         u_int64_t        pfrts_match;
 989         u_int64_t        pfrts_nomatch;
 990         long             pfrts_tzero;
 991         int              pfrts_cnt;
 992         int              pfrts_refcnt[PFR_REFCNT_MAX];
 993 };
 994 #define pfrts_name      pfrts_t.pfrt_name
 995 #define pfrts_flags     pfrts_t.pfrt_flags
 996
 997 #ifndef _SOCKADDR_UNION_DEFINED
 998 #define _SOCKADDR_UNION_DEFINED
 999 union sockaddr_union {
1000         struct sockaddr         sa;
1001         struct sockaddr_in      sin;
1002         struct sockaddr_in6     sin6;
1003 };
1004 #endif /* _SOCKADDR_UNION_DEFINED */
1005
1006 struct pfr_kcounters {
1007         u_int64_t                pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1008         u_int64_t                pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1009 };
1010
1011 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1012 struct pfr_kentry {
1013         struct radix_node        pfrke_node[2];
1014         union sockaddr_union     pfrke_sa;
1015         SLIST_ENTRY(pfr_kentry)  pfrke_workq;
1016         struct pfr_kcounters    *pfrke_counters;
1017         long                     pfrke_tzero;
1018         u_int8_t                 pfrke_af;
1019         u_int8_t                 pfrke_net;
1020         u_int8_t                 pfrke_not;
1021         u_int8_t                 pfrke_mark;
1022 };
1023
1024 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1025 RB_HEAD(pfr_ktablehead, pfr_ktable);
1026 struct pfr_ktable {
1027         struct pfr_tstats        pfrkt_ts;
1028         RB_ENTRY(pfr_ktable)     pfrkt_tree;
1029         SLIST_ENTRY(pfr_ktable)  pfrkt_workq;
1030         struct radix_node_head  *pfrkt_ip4;
1031         struct radix_node_head  *pfrkt_ip6;
1032         struct pfr_ktable       *pfrkt_shadow;
1033         struct pfr_ktable       *pfrkt_root;
1034         struct pf_ruleset       *pfrkt_rs;
1035         long                     pfrkt_larg;
1036         int                      pfrkt_nflags;
1037 };
1038 #define pfrkt_t         pfrkt_ts.pfrts_t
1039 #define pfrkt_name      pfrkt_t.pfrt_name
1040 #define pfrkt_anchor    pfrkt_t.pfrt_anchor
1041 #define pfrkt_ruleset   pfrkt_t.pfrt_ruleset
1042 #define pfrkt_flags     pfrkt_t.pfrt_flags
1043 #define pfrkt_cnt       pfrkt_ts.pfrts_cnt
1044 #define pfrkt_refcnt    pfrkt_ts.pfrts_refcnt
1045 #define pfrkt_packets   pfrkt_ts.pfrts_packets
1046 #define pfrkt_bytes     pfrkt_ts.pfrts_bytes
1047 #define pfrkt_match     pfrkt_ts.pfrts_match
1048 #define pfrkt_nomatch   pfrkt_ts.pfrts_nomatch
1049 #define pfrkt_tzero     pfrkt_ts.pfrts_tzero
1050
1051 /* keep synced with pfi_kif, used in RB_FIND */
1052 struct pfi_kif_cmp {
1053         char                             pfik_name[IFNAMSIZ];
1054 };
1055
1056 struct pfi_kif {
1057         char                             pfik_name[IFNAMSIZ];
1058         union {
1059                 RB_ENTRY(pfi_kif)        _pfik_tree;
1060                 LIST_ENTRY(pfi_kif)      _pfik_list;
1061         } _pfik_glue;
1062 #define pfik_tree       _pfik_glue._pfik_tree
1063 #define pfik_list       _pfik_glue._pfik_list
1064         u_int64_t                        pfik_packets[2][2][2];
1065         u_int64_t                        pfik_bytes[2][2][2];
1066         u_int32_t                        pfik_tzero;
1067         u_int                            pfik_flags;
1068         struct ifnet                    *pfik_ifp;
1069         struct ifg_group                *pfik_group;
1070         u_int                            pfik_rulerefs;
1071         TAILQ_HEAD(, pfi_dynaddr)        pfik_dynaddrs;
1072 };
1073
1074 #define PFI_IFLAG_REFS          0x0001  /* has state references */
1075 #define PFI_IFLAG_SKIP          0x0100  /* skip filtering on interface */
1076
1077 struct pf_pdesc {
1078         struct {
1079                 int      done;
1080                 uid_t    uid;
1081                 gid_t    gid;
1082         }                lookup;
1083         u_int64_t        tot_len;       /* Make Mickey money */
1084         union {
1085                 struct tcphdr           *tcp;
1086                 struct udphdr           *udp;
1087                 struct icmp             *icmp;
1088 #ifdef INET6
1089                 struct icmp6_hdr        *icmp6;
1090 #endif /* INET6 */
1091                 void                    *any;
1092         } hdr;
1093
1094         struct pf_rule  *nat_rule;      /* nat/rdr rule applied to packet */
1095         struct pf_addr  *src;           /* src address */
1096         struct pf_addr  *dst;           /* dst address */
1097         u_int16_t *sport;
1098         u_int16_t *dport;
1099         struct pf_mtag  *pf_mtag;
1100
1101         u_int32_t        p_len;         /* total length of payload */
1102
1103         u_int16_t       *ip_sum;
1104         u_int16_t       *proto_sum;
1105         u_int16_t        flags;         /* Let SCRUB trigger behavior in
1106                                          * state code. Easier than tags */
1107 #define PFDESC_TCP_NORM 0x0001          /* TCP shall be statefully scrubbed */
1108 #define PFDESC_IP_REAS  0x0002          /* IP frags would've been reassembled */
1109         sa_family_t      af;
1110         u_int8_t         proto;
1111         u_int8_t         tos;
1112         u_int8_t         dir;           /* direction */
1113         u_int8_t         sidx;          /* key index for source */
1114         u_int8_t         didx;          /* key index for destination */
1115 };
1116
1117 /* flags for RDR options */
1118 #define PF_DPORT_RANGE  0x01            /* Dest port uses range */
1119 #define PF_RPORT_RANGE  0x02            /* RDR'ed port uses range */
1120
1121 /* Counters for other things we want to keep track of */
1122 #define LCNT_STATES             0       /* states */
1123 #define LCNT_SRCSTATES          1       /* max-src-states */
1124 #define LCNT_SRCNODES           2       /* max-src-nodes */
1125 #define LCNT_SRCCONN            3       /* max-src-conn */
1126 #define LCNT_SRCCONNRATE        4       /* max-src-conn-rate */
1127 #define LCNT_OVERLOAD_TABLE     5       /* entry added to overload table */
1128 #define LCNT_OVERLOAD_FLUSH     6       /* state entries flushed */
1129 #define LCNT_MAX                7       /* total+1 */
1130
1131 #define LCNT_NAMES { \
1132         "max states per rule", \
1133         "max-src-states", \
1134         "max-src-nodes", \
1135         "max-src-conn", \
1136         "max-src-conn-rate", \
1137         "overload table insertion", \
1138         "overload flush states", \
1139         NULL \
1140 }
1141
1142 /* UDP state enumeration */
1143 #define PFUDPS_NO_TRAFFIC       0
1144 #define PFUDPS_SINGLE           1
1145 #define PFUDPS_MULTIPLE         2
1146
1147 #define PFUDPS_NSTATES          3       /* number of state levels */
1148
1149 #define PFUDPS_NAMES { \
1150         "NO_TRAFFIC", \
1151         "SINGLE", \
1152         "MULTIPLE", \
1153         NULL \
1154 }
1155
1156 /* Other protocol state enumeration */
1157 #define PFOTHERS_NO_TRAFFIC     0
1158 #define PFOTHERS_SINGLE         1
1159 #define PFOTHERS_MULTIPLE       2
1160
1161 #define PFOTHERS_NSTATES        3       /* number of state levels */
1162
1163 #define PFOTHERS_NAMES { \
1164         "NO_TRAFFIC", \
1165         "SINGLE", \
1166         "MULTIPLE", \
1167         NULL \
1168 }
1169
1170 #define FCNT_STATE_SEARCH       0
1171 #define FCNT_STATE_INSERT       1
1172 #define FCNT_STATE_REMOVALS     2
1173 #define FCNT_MAX                3
1174
1175 #define SCNT_SRC_NODE_SEARCH    0
1176 #define SCNT_SRC_NODE_INSERT    1
1177 #define SCNT_SRC_NODE_REMOVALS  2
1178 #define SCNT_MAX                3
1179
1180 #define ACTION_SET(a, x) \
1181         do { \
1182                 if ((a) != NULL) \
1183                         *(a) = (x); \
1184         } while (0)
1185
1186 #define REASON_SET(a, x) \
1187         do { \
1188                 if ((a) != NULL) \
1189                         *(a) = (x); \
1190                 if (x < PFRES_MAX) \
1191                         V_pf_status.counters[x]++; \
1192         } while (0)
1193
1194 struct pf_status {
1195         u_int64_t       counters[PFRES_MAX];
1196         u_int64_t       lcounters[LCNT_MAX];    /* limit counters */
1197         u_int64_t       fcounters[FCNT_MAX];
1198         u_int64_t       scounters[SCNT_MAX];
1199         u_int64_t       pcounters[2][2][3];
1200         u_int64_t       bcounters[2][2];
1201         u_int32_t       running;
1202         u_int32_t       states;
1203         u_int32_t       src_nodes;
1204         u_int32_t       since;
1205         u_int32_t       debug;
1206         u_int32_t       hostid;
1207         char            ifname[IFNAMSIZ];
1208         u_int8_t        pf_chksum[PF_MD5_DIGEST_LENGTH];
1209 };
1210
1211 struct pf_divert {
1212         union {
1213                 struct in_addr  ipv4;
1214                 struct in6_addr ipv6;
1215         }               addr;
1216         u_int16_t       port;
1217 };
1218
1219 #define PFFRAG_FRENT_HIWAT      5000    /* Number of fragment entries */
1220 #define PFR_KENTRY_HIWAT        200000  /* Number of table entries */
1221
1222 /*
1223  * ioctl parameter structures
1224  */
1225
1226 struct pfioc_pooladdr {
1227         u_int32_t                action;
1228         u_int32_t                ticket;
1229         u_int32_t                nr;
1230         u_int32_t                r_num;
1231         u_int8_t                 r_action;
1232         u_int8_t                 r_last;
1233         u_int8_t                 af;
1234         char                     anchor[MAXPATHLEN];
1235         struct pf_pooladdr       addr;
1236 };
1237
1238 struct pfioc_rule {
1239         u_int32_t        action;
1240         u_int32_t        ticket;
1241         u_int32_t        pool_ticket;
1242         u_int32_t        nr;
1243         char             anchor[MAXPATHLEN];
1244         char             anchor_call[MAXPATHLEN];
1245         struct pf_rule   rule;
1246 };
1247
1248 struct pfioc_natlook {
1249         struct pf_addr   saddr;
1250         struct pf_addr   daddr;
1251         struct pf_addr   rsaddr;
1252         struct pf_addr   rdaddr;
1253         u_int16_t        sport;
1254         u_int16_t        dport;
1255         u_int16_t        rsport;
1256         u_int16_t        rdport;
1257         sa_family_t      af;
1258         u_int8_t         proto;
1259         u_int8_t         direction;
1260 };
1261
1262 struct pfioc_state {
1263         struct pfsync_state     state;
1264 };
1265
1266 struct pfioc_src_node_kill {
1267         sa_family_t psnk_af;
1268         struct pf_rule_addr psnk_src;
1269         struct pf_rule_addr psnk_dst;
1270         u_int               psnk_killed;
1271 };
1272
1273 struct pfioc_state_kill {
1274         struct pf_state_cmp     psk_pfcmp;
1275         sa_family_t             psk_af;
1276         int                     psk_proto;
1277         struct pf_rule_addr     psk_src;
1278         struct pf_rule_addr     psk_dst;
1279         char                    psk_ifname[IFNAMSIZ];
1280         char                    psk_label[PF_RULE_LABEL_SIZE];
1281         u_int                   psk_killed;
1282 };
1283
1284 struct pfioc_states {
1285         int     ps_len;
1286         union {
1287                 caddr_t                  psu_buf;
1288                 struct pfsync_state     *psu_states;
1289         } ps_u;
1290 #define ps_buf          ps_u.psu_buf
1291 #define ps_states       ps_u.psu_states
1292 };
1293
1294 struct pfioc_src_nodes {
1295         int     psn_len;
1296         union {
1297                 caddr_t          psu_buf;
1298                 struct pf_src_node      *psu_src_nodes;
1299         } psn_u;
1300 #define psn_buf         psn_u.psu_buf
1301 #define psn_src_nodes   psn_u.psu_src_nodes
1302 };
1303
1304 struct pfioc_if {
1305         char             ifname[IFNAMSIZ];
1306 };
1307
1308 struct pfioc_tm {
1309         int              timeout;
1310         int              seconds;
1311 };
1312
1313 struct pfioc_limit {
1314         int              index;
1315         unsigned         limit;
1316 };
1317
1318 struct pfioc_altq {
1319         u_int32_t        action;
1320         u_int32_t        ticket;
1321         u_int32_t        nr;
1322         struct pf_altq   altq;
1323 };
1324
1325 struct pfioc_qstats {
1326         u_int32_t        ticket;
1327         u_int32_t        nr;
1328         void            *buf;
1329         int              nbytes;
1330         u_int8_t         scheduler;
1331 };
1332
1333 struct pfioc_ruleset {
1334         u_int32_t        nr;
1335         char             path[MAXPATHLEN];
1336         char             name[PF_ANCHOR_NAME_SIZE];
1337 };
1338
1339 #define PF_RULESET_ALTQ         (PF_RULESET_MAX)
1340 #define PF_RULESET_TABLE        (PF_RULESET_MAX+1)
1341 struct pfioc_trans {
1342         int              size;  /* number of elements */
1343         int              esize; /* size of each element in bytes */
1344         struct pfioc_trans_e {
1345                 int             rs_num;
1346                 char            anchor[MAXPATHLEN];
1347                 u_int32_t       ticket;
1348         }               *array;
1349 };
1350
1351 #define PFR_FLAG_ATOMIC         0x00000001      /* unused */
1352 #define PFR_FLAG_DUMMY          0x00000002
1353 #define PFR_FLAG_FEEDBACK       0x00000004
1354 #define PFR_FLAG_CLSTATS        0x00000008
1355 #define PFR_FLAG_ADDRSTOO       0x00000010
1356 #define PFR_FLAG_REPLACE        0x00000020
1357 #define PFR_FLAG_ALLRSETS       0x00000040
1358 #define PFR_FLAG_ALLMASK        0x0000007F
1359 #ifdef _KERNEL
1360 #define PFR_FLAG_USERIOCTL      0x10000000
1361 #endif
1362
1363 struct pfioc_table {
1364         struct pfr_table         pfrio_table;
1365         void                    *pfrio_buffer;
1366         int                      pfrio_esize;
1367         int                      pfrio_size;
1368         int                      pfrio_size2;
1369         int                      pfrio_nadd;
1370         int                      pfrio_ndel;
1371         int                      pfrio_nchange;
1372         int                      pfrio_flags;
1373         u_int32_t                pfrio_ticket;
1374 };
1375 #define pfrio_exists    pfrio_nadd
1376 #define pfrio_nzero     pfrio_nadd
1377 #define pfrio_nmatch    pfrio_nadd
1378 #define pfrio_naddr     pfrio_size2
1379 #define pfrio_setflag   pfrio_size2
1380 #define pfrio_clrflag   pfrio_nadd
1381
1382 struct pfioc_iface {
1383         char     pfiio_name[IFNAMSIZ];
1384         void    *pfiio_buffer;
1385         int      pfiio_esize;
1386         int      pfiio_size;
1387         int      pfiio_nzero;
1388         int      pfiio_flags;
1389 };
1390
1391
1392 /*
1393  * ioctl operations
1394  */
1395
1396 #define DIOCSTART       _IO  ('D',  1)
1397 #define DIOCSTOP        _IO  ('D',  2)
1398 #define DIOCADDRULE     _IOWR('D',  4, struct pfioc_rule)
1399 #define DIOCGETRULES    _IOWR('D',  6, struct pfioc_rule)
1400 #define DIOCGETRULE     _IOWR('D',  7, struct pfioc_rule)
1401 /* XXX cut 8 - 17 */
1402 #define DIOCCLRSTATES   _IOWR('D', 18, struct pfioc_state_kill)
1403 #define DIOCGETSTATE    _IOWR('D', 19, struct pfioc_state)
1404 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1405 #define DIOCGETSTATUS   _IOWR('D', 21, struct pf_status)
1406 #define DIOCCLRSTATUS   _IO  ('D', 22)
1407 #define DIOCNATLOOK     _IOWR('D', 23, struct pfioc_natlook)
1408 #define DIOCSETDEBUG    _IOWR('D', 24, u_int32_t)
1409 #define DIOCGETSTATES   _IOWR('D', 25, struct pfioc_states)
1410 #define DIOCCHANGERULE  _IOWR('D', 26, struct pfioc_rule)
1411 /* XXX cut 26 - 28 */
1412 #define DIOCSETTIMEOUT  _IOWR('D', 29, struct pfioc_tm)
1413 #define DIOCGETTIMEOUT  _IOWR('D', 30, struct pfioc_tm)
1414 #define DIOCADDSTATE    _IOWR('D', 37, struct pfioc_state)
1415 #define DIOCCLRRULECTRS _IO  ('D', 38)
1416 #define DIOCGETLIMIT    _IOWR('D', 39, struct pfioc_limit)
1417 #define DIOCSETLIMIT    _IOWR('D', 40, struct pfioc_limit)
1418 #define DIOCKILLSTATES  _IOWR('D', 41, struct pfioc_state_kill)
1419 #define DIOCSTARTALTQ   _IO  ('D', 42)
1420 #define DIOCSTOPALTQ    _IO  ('D', 43)
1421 #define DIOCADDALTQ     _IOWR('D', 45, struct pfioc_altq)
1422 #define DIOCGETALTQS    _IOWR('D', 47, struct pfioc_altq)
1423 #define DIOCGETALTQ     _IOWR('D', 48, struct pfioc_altq)
1424 #define DIOCCHANGEALTQ  _IOWR('D', 49, struct pfioc_altq)
1425 #define DIOCGETQSTATS   _IOWR('D', 50, struct pfioc_qstats)
1426 #define DIOCBEGINADDRS  _IOWR('D', 51, struct pfioc_pooladdr)
1427 #define DIOCADDADDR     _IOWR('D', 52, struct pfioc_pooladdr)
1428 #define DIOCGETADDRS    _IOWR('D', 53, struct pfioc_pooladdr)
1429 #define DIOCGETADDR     _IOWR('D', 54, struct pfioc_pooladdr)
1430 #define DIOCCHANGEADDR  _IOWR('D', 55, struct pfioc_pooladdr)
1431 /* XXX cut 55 - 57 */
1432 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1433 #define DIOCGETRULESET  _IOWR('D', 59, struct pfioc_ruleset)
1434 #define DIOCRCLRTABLES  _IOWR('D', 60, struct pfioc_table)
1435 #define DIOCRADDTABLES  _IOWR('D', 61, struct pfioc_table)
1436 #define DIOCRDELTABLES  _IOWR('D', 62, struct pfioc_table)
1437 #define DIOCRGETTABLES  _IOWR('D', 63, struct pfioc_table)
1438 #define DIOCRGETTSTATS  _IOWR('D', 64, struct pfioc_table)
1439 #define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1440 #define DIOCRCLRADDRS   _IOWR('D', 66, struct pfioc_table)
1441 #define DIOCRADDADDRS   _IOWR('D', 67, struct pfioc_table)
1442 #define DIOCRDELADDRS   _IOWR('D', 68, struct pfioc_table)
1443 #define DIOCRSETADDRS   _IOWR('D', 69, struct pfioc_table)
1444 #define DIOCRGETADDRS   _IOWR('D', 70, struct pfioc_table)
1445 #define DIOCRGETASTATS  _IOWR('D', 71, struct pfioc_table)
1446 #define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1447 #define DIOCRTSTADDRS   _IOWR('D', 73, struct pfioc_table)
1448 #define DIOCRSETTFLAGS  _IOWR('D', 74, struct pfioc_table)
1449 #define DIOCRINADEFINE  _IOWR('D', 77, struct pfioc_table)
1450 #define DIOCOSFPFLUSH   _IO('D', 78)
1451 #define DIOCOSFPADD     _IOWR('D', 79, struct pf_osfp_ioctl)
1452 #define DIOCOSFPGET     _IOWR('D', 80, struct pf_osfp_ioctl)
1453 #define DIOCXBEGIN      _IOWR('D', 81, struct pfioc_trans)
1454 #define DIOCXCOMMIT     _IOWR('D', 82, struct pfioc_trans)
1455 #define DIOCXROLLBACK   _IOWR('D', 83, struct pfioc_trans)
1456 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1457 #define DIOCCLRSRCNODES _IO('D', 85)
1458 #define DIOCSETHOSTID   _IOWR('D', 86, u_int32_t)
1459 #define DIOCIGETIFACES  _IOWR('D', 87, struct pfioc_iface)
1460 #define DIOCSETIFFLAG   _IOWR('D', 89, struct pfioc_iface)
1461 #define DIOCCLRIFFLAG   _IOWR('D', 90, struct pfioc_iface)
1462 #define DIOCKILLSRCNODES        _IOWR('D', 91, struct pfioc_src_node_kill)
1463 struct pf_ifspeed {
1464         char                    ifname[IFNAMSIZ];
1465         u_int32_t               baudrate;
1466 };
1467 #define DIOCGIFSPEED    _IOWR('D', 92, struct pf_ifspeed)
1468
1469 #ifdef _KERNEL
1470 LIST_HEAD(pf_src_node_list, pf_src_node);
1471 struct pf_srchash {
1472         struct pf_src_node_list         nodes;
1473         struct mtx                      lock;
1474 };
1475
1476 struct pf_keyhash {
1477         LIST_HEAD(, pf_state_key)       keys;
1478         struct mtx                      lock;
1479 };
1480
1481 struct pf_idhash {
1482         LIST_HEAD(, pf_state)           states;
1483         struct mtx                      lock;
1484 };
1485
1486 #define PF_HASHSIZ      (32768)
1487 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1488 VNET_DECLARE(struct pf_idhash *, pf_idhash);
1489 VNET_DECLARE(u_long, pf_hashmask);
1490 #define V_pf_keyhash    VNET(pf_keyhash)
1491 #define V_pf_idhash     VNET(pf_idhash)
1492 #define V_pf_hashmask   VNET(pf_hashmask)
1493 VNET_DECLARE(struct pf_srchash *, pf_srchash);
1494 VNET_DECLARE(u_long, pf_srchashmask);
1495 #define V_pf_srchash    VNET(pf_srchash)
1496 #define V_pf_srchashmask VNET(pf_srchashmask)
1497
1498 #define PF_IDHASH(s)    (be64toh((s)->id) % (V_pf_hashmask + 1))
1499
1500 VNET_DECLARE(void *, pf_swi_cookie);
1501 #define V_pf_swi_cookie VNET(pf_swi_cookie)
1502
1503 VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1504 #define V_pf_stateid    VNET(pf_stateid)
1505
1506 TAILQ_HEAD(pf_altqqueue, pf_altq);
1507 VNET_DECLARE(struct pf_altqqueue,        pf_altqs[2]);
1508 #define V_pf_altqs                       VNET(pf_altqs)
1509 VNET_DECLARE(struct pf_palist,           pf_pabuf);
1510 #define V_pf_pabuf                       VNET(pf_pabuf)
1511
1512 VNET_DECLARE(u_int32_t,                  ticket_altqs_active);
1513 #define V_ticket_altqs_active            VNET(ticket_altqs_active)
1514 VNET_DECLARE(u_int32_t,                  ticket_altqs_inactive);
1515 #define V_ticket_altqs_inactive          VNET(ticket_altqs_inactive)
1516 VNET_DECLARE(int,                        altqs_inactive_open);
1517 #define V_altqs_inactive_open            VNET(altqs_inactive_open)
1518 VNET_DECLARE(u_int32_t,                  ticket_pabuf);
1519 #define V_ticket_pabuf                   VNET(ticket_pabuf)
1520 VNET_DECLARE(struct pf_altqqueue *,      pf_altqs_active);
1521 #define V_pf_altqs_active                VNET(pf_altqs_active)
1522 VNET_DECLARE(struct pf_altqqueue *,      pf_altqs_inactive);
1523 #define V_pf_altqs_inactive              VNET(pf_altqs_inactive)
1524
1525 VNET_DECLARE(struct pf_rulequeue, pf_unlinked_rules);
1526 #define V_pf_unlinked_rules     VNET(pf_unlinked_rules)
1527
1528 void                             pf_initialize(void);
1529 void                             pf_cleanup(void);
1530
1531 struct pf_mtag                  *pf_get_mtag(struct mbuf *);
1532
1533 extern void                      pf_calc_skip_steps(struct pf_rulequeue *);
1534 #ifdef ALTQ
1535 extern  void                     pf_altq_ifnet_event(struct ifnet *, int);
1536 #endif
1537 VNET_DECLARE(uma_zone_t,         pf_state_z);
1538 #define V_pf_state_z             VNET(pf_state_z)
1539 VNET_DECLARE(uma_zone_t,         pf_state_key_z);
1540 #define V_pf_state_key_z         VNET(pf_state_key_z)
1541 VNET_DECLARE(uma_zone_t,         pf_state_scrub_z);
1542 #define V_pf_state_scrub_z       VNET(pf_state_scrub_z)
1543
1544 extern void                      pf_purge_thread(void *);
1545 extern void                      pf_intr(void *);
1546 extern void                      pf_purge_expired_src_nodes(void);
1547
1548 extern int                       pf_unlink_state(struct pf_state *, u_int);
1549 #define PF_ENTER_LOCKED         0x00000001
1550 #define PF_RETURN_LOCKED        0x00000002
1551 extern int                       pf_state_insert(struct pfi_kif *,
1552                                     struct pf_state_key *,
1553                                     struct pf_state_key *,
1554                                     struct pf_state *);
1555 extern void                      pf_free_state(struct pf_state *);
1556
1557 static __inline void
1558 pf_ref_state(struct pf_state *s)
1559 {
1560
1561         refcount_acquire(&s->refs);
1562 }
1563
1564 static __inline int
1565 pf_release_state(struct pf_state *s)
1566 {
1567
1568         if (refcount_release(&s->refs)) {
1569                 pf_free_state(s);
1570                 return (1);
1571         } else
1572                 return (0);
1573 }
1574
1575 extern struct pf_state          *pf_find_state_byid(uint64_t, uint32_t);
1576 extern struct pf_state          *pf_find_state_all(struct pf_state_key_cmp *,
1577                                     u_int, int *);
1578 extern struct pf_src_node       *pf_find_src_node(struct pf_addr *,
1579                                     struct pf_rule *, sa_family_t, int);
1580 extern void                      pf_unlink_src_node(struct pf_src_node *);
1581 extern void                      pf_unlink_src_node_locked(struct pf_src_node *);
1582 extern u_int                     pf_free_src_nodes(struct pf_src_node_list *);
1583 extern void                      pf_print_state(struct pf_state *);
1584 extern void                      pf_print_flags(u_int8_t);
1585 extern u_int16_t                 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1586                                     u_int8_t);
1587
1588 VNET_DECLARE(struct ifnet *,             sync_ifp);
1589 #define V_sync_ifp                       VNET(sync_ifp);
1590 VNET_DECLARE(struct pf_rule,             pf_default_rule);
1591 #define V_pf_default_rule                 VNET(pf_default_rule)
1592 extern void                      pf_addrcpy(struct pf_addr *, struct pf_addr *,
1593                                     u_int8_t);
1594 void                            pf_free_rule(struct pf_rule *);
1595
1596 #ifdef INET
1597 int     pf_test(int, struct ifnet *, struct mbuf **, struct inpcb *);
1598 #endif /* INET */
1599
1600 #ifdef INET6
1601 int     pf_test6(int, struct ifnet *, struct mbuf **, struct inpcb *);
1602 void    pf_poolmask(struct pf_addr *, struct pf_addr*,
1603             struct pf_addr *, struct pf_addr *, u_int8_t);
1604 void    pf_addr_inc(struct pf_addr *, sa_family_t);
1605 #endif /* INET6 */
1606
1607 u_int32_t       pf_new_isn(struct pf_state *);
1608 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1609             sa_family_t);
1610 void    pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1611 void    pf_send_deferred_syn(struct pf_state *);
1612 int     pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1613             struct pf_addr *, sa_family_t);
1614 int     pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1615             struct pf_addr *, sa_family_t);
1616 int     pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1617
1618 void    pf_normalize_init(void);
1619 void    pf_normalize_cleanup(void);
1620 int     pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1621             struct pf_pdesc *);
1622 int     pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1623             struct pf_pdesc *);
1624 int     pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1625             struct pf_pdesc *);
1626 void    pf_normalize_tcp_cleanup(struct pf_state *);
1627 int     pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1628             struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1629 int     pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1630             u_short *, struct tcphdr *, struct pf_state *,
1631             struct pf_state_peer *, struct pf_state_peer *, int *);
1632 u_int32_t
1633         pf_state_expires(const struct pf_state *);
1634 void    pf_purge_expired_fragments(void);
1635 int     pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1636             int);
1637 int     pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1638 struct pf_state_key *pf_alloc_state_key(int);
1639 void    pfr_initialize(void);
1640 void    pfr_cleanup(void);
1641 int     pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1642 void    pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1643             u_int64_t, int, int, int);
1644 int     pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1645 void    pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1646 struct pfr_ktable *
1647         pfr_attach_table(struct pf_ruleset *, char *);
1648 void    pfr_detach_table(struct pfr_ktable *);
1649 int     pfr_clr_tables(struct pfr_table *, int *, int);
1650 int     pfr_add_tables(struct pfr_table *, int, int *, int);
1651 int     pfr_del_tables(struct pfr_table *, int, int *, int);
1652 int     pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1653 int     pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1654 int     pfr_clr_tstats(struct pfr_table *, int, int *, int);
1655 int     pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1656 int     pfr_clr_addrs(struct pfr_table *, int *, int);
1657 int     pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1658 int     pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1659             int);
1660 int     pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1661             int);
1662 int     pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1663             int *, int *, int *, int, u_int32_t);
1664 int     pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1665 int     pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1666 int     pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1667             int);
1668 int     pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1669             int);
1670 int     pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1671 int     pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1672 int     pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1673 int     pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1674             int *, u_int32_t, int);
1675
1676 MALLOC_DECLARE(PFI_MTYPE);
1677 VNET_DECLARE(struct pfi_kif *,           pfi_all);
1678 #define V_pfi_all                        VNET(pfi_all)
1679
1680 void             pfi_initialize(void);
1681 void             pfi_cleanup(void);
1682 void             pfi_kif_ref(struct pfi_kif *);
1683 void             pfi_kif_unref(struct pfi_kif *);
1684 struct pfi_kif  *pfi_kif_find(const char *);
1685 struct pfi_kif  *pfi_kif_attach(struct pfi_kif *, const char *);
1686 int              pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1687 void             pfi_kif_purge(void);
1688 int              pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1689                     sa_family_t);
1690 int              pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1691 void             pfi_dynaddr_remove(struct pfi_dynaddr *);
1692 void             pfi_dynaddr_copyout(struct pf_addr_wrap *);
1693 void             pfi_update_status(const char *, struct pf_status *);
1694 void             pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1695 int              pfi_set_flags(const char *, int);
1696 int              pfi_clear_flags(const char *, int);
1697
1698 int              pf_match_tag(struct mbuf *, struct pf_rule *, int *, int);
1699 int              pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1700 void             pf_qid2qname(u_int32_t, char *);
1701
1702 VNET_DECLARE(struct pf_status,           pf_status);
1703 #define V_pf_status                      VNET(pf_status)
1704
1705 struct pf_limit {
1706         uma_zone_t      zone;
1707         u_int           limit;
1708 };
1709 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1710 #define V_pf_limits VNET(pf_limits)
1711
1712 #endif /* _KERNEL */
1713
1714 #ifdef _KERNEL
1715 VNET_DECLARE(struct pf_anchor_global,            pf_anchors);
1716 #define V_pf_anchors                             VNET(pf_anchors)
1717 VNET_DECLARE(struct pf_anchor,                   pf_main_anchor);
1718 #define V_pf_main_anchor                         VNET(pf_main_anchor)
1719 #define pf_main_ruleset V_pf_main_anchor.ruleset
1720 #endif
1721
1722 /* these ruleset functions can be linked into userland programs (pfctl) */
1723 int                      pf_get_ruleset_number(u_int8_t);
1724 void                     pf_init_ruleset(struct pf_ruleset *);
1725 int                      pf_anchor_setup(struct pf_rule *,
1726                             const struct pf_ruleset *, const char *);
1727 int                      pf_anchor_copyout(const struct pf_ruleset *,
1728                             const struct pf_rule *, struct pfioc_rule *);
1729 void                     pf_anchor_remove(struct pf_rule *);
1730 void                     pf_remove_if_empty_ruleset(struct pf_ruleset *);
1731 struct pf_ruleset       *pf_find_ruleset(const char *);
1732 struct pf_ruleset       *pf_find_or_create_ruleset(const char *);
1733 void                     pf_rs_initialize(void);
1734
1735 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1736 int     pf_osfp_add(struct pf_osfp_ioctl *);
1737 #ifdef _KERNEL
1738 struct pf_osfp_enlist *
1739         pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1740             const struct tcphdr *);
1741 #endif /* _KERNEL */
1742 void    pf_osfp_flush(void);
1743 int     pf_osfp_get(struct pf_osfp_ioctl *);
1744 int     pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1745
1746 #ifdef _KERNEL
1747 void                     pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1748
1749 void                     pf_step_into_anchor(struct pf_anchor_stackframe *, int *,
1750                             struct pf_ruleset **, int, struct pf_rule **,
1751                             struct pf_rule **, int *);
1752 int                      pf_step_out_of_anchor(struct pf_anchor_stackframe *, int *,
1753                             struct pf_ruleset **, int, struct pf_rule **,
1754                             struct pf_rule **, int *);
1755
1756 int                      pf_map_addr(u_int8_t, struct pf_rule *,
1757                             struct pf_addr *, struct pf_addr *,
1758                             struct pf_addr *, struct pf_src_node **);
1759 struct pf_rule          *pf_get_translation(struct pf_pdesc *, struct mbuf *,
1760                             int, int, struct pfi_kif *, struct pf_src_node **,
1761                             struct pf_state_key **, struct pf_state_key **,
1762                             struct pf_addr *, struct pf_addr *,
1763                             uint16_t, uint16_t, struct pf_anchor_stackframe *);
1764
1765 struct pf_state_key     *pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1766                             struct pf_addr *, u_int16_t, u_int16_t);
1767 struct pf_state_key     *pf_state_key_clone(struct pf_state_key *);
1768 #endif /* _KERNEL */
1769
1770 #endif /* _NET_PFVAR_H_ */