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/counter.h>
  39 #include <sys/cpuset.h>
  40 #include <sys/malloc.h>
  41 #include <sys/refcount.h>
  42 #include <sys/lock.h>
  43 #include <sys/rmlock.h>
  44 #include <sys/tree.h>
  45 #include <vm/uma.h>
  46
  47 #include <net/radix.h>
  48 #include <netinet/in.h>
  49
  50 #include <netpfil/pf/pf.h>
  51 #include <netpfil/pf/pf_altq.h>
  52 #include <netpfil/pf/pf_mtag.h>
  53
  54 struct pf_addr {
  55         union {
  56                 struct in_addr          v4;
  57                 struct in6_addr         v6;
  58                 u_int8_t                addr8[16];
  59                 u_int16_t               addr16[8];
  60                 u_int32_t               addr32[4];
  61         } pfa;              /* 128-bit address */
  62 #define v4      pfa.v4
  63 #define v6      pfa.v6
  64 #define addr8   pfa.addr8
  65 #define addr16  pfa.addr16
  66 #define addr32  pfa.addr32
  67 };
  68
  69 #define PFI_AFLAG_NETWORK       0x01
  70 #define PFI_AFLAG_BROADCAST     0x02
  71 #define PFI_AFLAG_PEER          0x04
  72 #define PFI_AFLAG_MODEMASK      0x07
  73 #define PFI_AFLAG_NOALIAS       0x08
  74
  75 struct pf_addr_wrap {
  76         union {
  77                 struct {
  78                         struct pf_addr           addr;
  79                         struct pf_addr           mask;
  80                 }                        a;
  81                 char                     ifname[IFNAMSIZ];
  82                 char                     tblname[PF_TABLE_NAME_SIZE];
  83         }                        v;
  84         union {
  85                 struct pfi_dynaddr      *dyn;
  86                 struct pfr_ktable       *tbl;
  87                 int                      dyncnt;
  88                 int                      tblcnt;
  89         }                        p;
  90         u_int8_t                 type;          /* PF_ADDR_* */
  91         u_int8_t                 iflags;        /* PFI_AFLAG_* */
  92 };
  93
  94 #ifdef _KERNEL
  95
  96 struct pfi_dynaddr {
  97         TAILQ_ENTRY(pfi_dynaddr)         entry;
  98         struct pf_addr                   pfid_addr4;
  99         struct pf_addr                   pfid_mask4;
 100         struct pf_addr                   pfid_addr6;
 101         struct pf_addr                   pfid_mask6;
 102         struct pfr_ktable               *pfid_kt;
 103         struct pfi_kif                  *pfid_kif;
 104         int                              pfid_net;      /* mask or 128 */
 105         int                              pfid_acnt4;    /* address count IPv4 */
 106         int                              pfid_acnt6;    /* address count IPv6 */
 107         sa_family_t                      pfid_af;       /* rule af */
 108         u_int8_t                         pfid_iflags;   /* PFI_AFLAG_* */
 109 };
 110
 111 /*
 112  * Address manipulation macros
 113  */
 114 #define HTONL(x)        (x) = htonl((__uint32_t)(x))
 115 #define HTONS(x)        (x) = htons((__uint16_t)(x))
 116 #define NTOHL(x)        (x) = ntohl((__uint32_t)(x))
 117 #define NTOHS(x)        (x) = ntohs((__uint16_t)(x))
 118
 119 #define PF_NAME         "pf"
 120
 121 #define PF_HASHROW_ASSERT(h)    mtx_assert(&(h)->lock, MA_OWNED)
 122 #define PF_HASHROW_LOCK(h)      mtx_lock(&(h)->lock)
 123 #define PF_HASHROW_UNLOCK(h)    mtx_unlock(&(h)->lock)
 124
 125 #define PF_STATE_LOCK(s)                                                \
 126         do {                                                            \
 127                 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];     \
 128                 PF_HASHROW_LOCK(_ih);                                   \
 129         } while (0)
 130
 131 #define PF_STATE_UNLOCK(s)                                              \
 132         do {                                                            \
 133                 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))];   \
 134                 PF_HASHROW_UNLOCK(_ih);                                 \
 135         } while (0)
 136
 137 #ifdef INVARIANTS
 138 #define PF_STATE_LOCK_ASSERT(s)                                         \
 139         do {                                                            \
 140                 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];     \
 141                 PF_HASHROW_ASSERT(_ih);                                 \
 142         } while (0)
 143 #else /* !INVARIANTS */
 144 #define PF_STATE_LOCK_ASSERT(s)         do {} while (0)
 145 #endif /* INVARIANTS */
 146
 147 extern struct mtx pf_unlnkdrules_mtx;
 148 #define PF_UNLNKDRULES_LOCK()   mtx_lock(&pf_unlnkdrules_mtx)
 149 #define PF_UNLNKDRULES_UNLOCK() mtx_unlock(&pf_unlnkdrules_mtx)
 150
 151 extern struct rmlock pf_rules_lock;
 152 #define PF_RULES_RLOCK_TRACKER  struct rm_priotracker _pf_rules_tracker
 153 #define PF_RULES_RLOCK()        rm_rlock(&pf_rules_lock, &_pf_rules_tracker)
 154 #define PF_RULES_RUNLOCK()      rm_runlock(&pf_rules_lock, &_pf_rules_tracker)
 155 #define PF_RULES_WLOCK()        rm_wlock(&pf_rules_lock)
 156 #define PF_RULES_WUNLOCK()      rm_wunlock(&pf_rules_lock)
 157 #define PF_RULES_ASSERT()       rm_assert(&pf_rules_lock, RA_LOCKED)
 158 #define PF_RULES_RASSERT()      rm_assert(&pf_rules_lock, RA_RLOCKED)
 159 #define PF_RULES_WASSERT()      rm_assert(&pf_rules_lock, RA_WLOCKED)
 160
 161 #define PF_MODVER       1
 162 #define PFLOG_MODVER    1
 163 #define PFSYNC_MODVER   1
 164
 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
 171
 172 #ifdef INET
 173 #ifndef INET6
 174 #define PF_INET_ONLY
 175 #endif /* ! INET6 */
 176 #endif /* INET */
 177
 178 #ifdef INET6
 179 #ifndef INET
 180 #define PF_INET6_ONLY
 181 #endif /* ! INET */
 182 #endif /* INET6 */
 183
 184 #ifdef INET
 185 #ifdef INET6
 186 #define PF_INET_INET6
 187 #endif /* INET6 */
 188 #endif /* INET */
 189
 190 #else
 191
 192 #define PF_INET_INET6
 193
 194 #endif /* _KERNEL */
 195
 196 /* Both IPv4 and IPv6 */
 197 #ifdef PF_INET_INET6
 198
 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])) \
 205
 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]))) \
 212
 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] )) \
 217
 218 #define PF_MATCHA(n, a, m, b, f) \
 219         pf_match_addr(n, a, m, b, f)
 220
 221 #define PF_ACPY(a, b, f) \
 222         pf_addrcpy(a, b, f)
 223
 224 #define PF_AINC(a, f) \
 225         pf_addr_inc(a, f)
 226
 227 #define PF_POOLMASK(a, b, c, d, f) \
 228         pf_poolmask(a, b, c, d, f)
 229
 230 #else
 231
 232 /* Just IPv6 */
 233
 234 #ifdef PF_INET6_ONLY
 235
 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]) \
 241
 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]) \
 247
 248 #define PF_AZERO(a, c) \
 249         (!(a)->addr32[0] && \
 250         !(a)->addr32[1] && \
 251         !(a)->addr32[2] && \
 252         !(a)->addr32[3] ) \
 253
 254 #define PF_MATCHA(n, a, m, b, f) \
 255         pf_match_addr(n, a, m, b, f)
 256
 257 #define PF_ACPY(a, b, f) \
 258         pf_addrcpy(a, b, f)
 259
 260 #define PF_AINC(a, f) \
 261         pf_addr_inc(a, f)
 262
 263 #define PF_POOLMASK(a, b, c, d, f) \
 264         pf_poolmask(a, b, c, d, f)
 265
 266 #else
 267
 268 /* Just IPv4 */
 269 #ifdef PF_INET_ONLY
 270
 271 #define PF_AEQ(a, b, c) \
 272         ((a)->addr32[0] == (b)->addr32[0])
 273
 274 #define PF_ANEQ(a, b, c) \
 275         ((a)->addr32[0] != (b)->addr32[0])
 276
 277 #define PF_AZERO(a, c) \
 278         (!(a)->addr32[0])
 279
 280 #define PF_MATCHA(n, a, m, b, f) \
 281         pf_match_addr(n, a, m, b, f)
 282
 283 #define PF_ACPY(a, b, f) \
 284         (a)->v4.s_addr = (b)->v4.s_addr
 285
 286 #define PF_AINC(a, f) \
 287         do { \
 288                 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
 289         } while (0)
 290
 291 #define PF_POOLMASK(a, b, c, d, f) \
 292         do { \
 293                 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
 294                 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
 295         } while (0)
 296
 297 #endif /* PF_INET_ONLY */
 298 #endif /* PF_INET6_ONLY */
 299 #endif /* PF_INET_INET6 */
 300
 301 /*
 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.
 304  */
 305 #define PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)                        \
 306         (                                                               \
 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))))) !=                   \
 322                 (neg)                                                   \
 323         )
 324
 325
 326 struct pf_rule_uid {
 327         uid_t            uid[2];
 328         u_int8_t         op;
 329 };
 330
 331 struct pf_rule_gid {
 332         uid_t            gid[2];
 333         u_int8_t         op;
 334 };
 335
 336 struct pf_rule_addr {
 337         struct pf_addr_wrap      addr;
 338         u_int16_t                port[2];
 339         u_int8_t                 neg;
 340         u_int8_t                 port_op;
 341 };
 342
 343 struct pf_pooladdr {
 344         struct pf_addr_wrap              addr;
 345         TAILQ_ENTRY(pf_pooladdr)         entries;
 346         char                             ifname[IFNAMSIZ];
 347         struct pfi_kif                  *kif;
 348 };
 349
 350 TAILQ_HEAD(pf_palist, pf_pooladdr);
 351
 352 struct pf_poolhashkey {
 353         union {
 354                 u_int8_t                key8[16];
 355                 u_int16_t               key16[8];
 356                 u_int32_t               key32[4];
 357         } pfk;              /* 128-bit hash key */
 358 #define key8    pfk.key8
 359 #define key16   pfk.key16
 360 #define key32   pfk.key32
 361 };
 362
 363 struct pf_pool {
 364         struct pf_palist         list;
 365         struct pf_pooladdr      *cur;
 366         struct pf_poolhashkey    key;
 367         struct pf_addr           counter;
 368         int                      tblidx;
 369         u_int16_t                proxy_port[2];
 370         u_int8_t                 opts;
 371 };
 372
 373
 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)
 379
 380 struct pf_osfp_entry {
 381         SLIST_ENTRY(pf_osfp_entry) fp_entry;
 382         pf_osfp_t               fp_os;
 383         int                     fp_enflags;
 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];
 391 };
 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)
 397
 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); \
 410 } while(0)
 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)) << \
 415             _FP_SUBTYPE_BITS; \
 416         (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
 417 } while(0)
 418
 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 */
 427         u_int16_t               fp_flags;
 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
 457
 458         SLIST_ENTRY(pf_os_fingerprint)  fp_next;
 459 };
 460
 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 */
 467         u_int16_t               fp_flags;
 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 */
 471
 472         int                     fp_getnum;      /* DIOCOSFPGET number */
 473 };
 474
 475
 476 union pf_rule_ptr {
 477         struct pf_rule          *ptr;
 478         u_int32_t                nr;
 479 };
 480
 481 #define PF_ANCHOR_NAME_SIZE      64
 482
 483 struct pf_rule {
 484         struct pf_rule_addr      src;
 485         struct pf_rule_addr      dst;
 486 #define PF_SKIP_IFP             0
 487 #define PF_SKIP_DIR             1
 488 #define PF_SKIP_AF              2
 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];
 504
 505         char                     overload_tblname[PF_TABLE_NAME_SIZE];
 506
 507         TAILQ_ENTRY(pf_rule)     entries;
 508         struct pf_pool           rpool;
 509
 510         u_int64_t                evaluations;
 511         u_int64_t                packets[2];
 512         u_int64_t                bytes[2];
 513
 514         struct pfi_kif          *kif;
 515         struct pf_anchor        *anchor;
 516         struct pfr_ktable       *overload_tbl;
 517
 518         pf_osfp_t                os_fingerprint;
 519
 520         int                      rtableid;
 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;
 526         struct {
 527                 u_int32_t               limit;
 528                 u_int32_t               seconds;
 529         }                        max_src_conn_rate;
 530         u_int32_t                qid;
 531         u_int32_t                pqid;
 532         u_int32_t                rt_listid;
 533         u_int32_t                nr;
 534         u_int32_t                prob;
 535         uid_t                    cuid;
 536         pid_t                    cpid;
 537
 538         counter_u64_t            states_cur;
 539         counter_u64_t            states_tot;
 540         counter_u64_t            src_nodes;
 541
 542         u_int16_t                return_icmp;
 543         u_int16_t                return_icmp6;
 544         u_int16_t                max_mss;
 545         u_int16_t                tag;
 546         u_int16_t                match_tag;
 547         u_int16_t                scrub_flags;
 548
 549         struct pf_rule_uid       uid;
 550         struct pf_rule_gid       gid;
 551
 552         u_int32_t                rule_flag;
 553         u_int8_t                 action;
 554         u_int8_t                 direction;
 555         u_int8_t                 log;
 556         u_int8_t                 logif;
 557         u_int8_t                 quick;
 558         u_int8_t                 ifnot;
 559         u_int8_t                 match_tag_not;
 560         u_int8_t                 natpass;
 561
 562 #define PF_STATE_NORMAL         0x1
 563 #define PF_STATE_MODULATE       0x2
 564 #define PF_STATE_SYNPROXY       0x3
 565         u_int8_t                 keep_state;
 566         sa_family_t              af;
 567         u_int8_t                 proto;
 568         u_int8_t                 type;
 569         u_int8_t                 code;
 570         u_int8_t                 flags;
 571         u_int8_t                 flagset;
 572         u_int8_t                 min_ttl;
 573         u_int8_t                 allow_opts;
 574         u_int8_t                 rt;
 575         u_int8_t                 return_ttl;
 576         u_int8_t                 tos;
 577         u_int8_t                 set_tos;
 578         u_int8_t                 anchor_relative;
 579         u_int8_t                 anchor_wildcard;
 580
 581 #define PF_FLUSH                0x01
 582 #define PF_FLUSH_GLOBAL         0x02
 583         u_int8_t                 flush;
 584 #define PF_PRIO_ZERO            0xff            /* match "prio 0" packets */
 585 #define PF_PRIO_MAX             7
 586         u_int8_t                 prio;
 587         u_int8_t                 set_prio[2];
 588
 589         struct {
 590                 struct pf_addr          addr;
 591                 u_int16_t               port;
 592         }                       divert;
 593
 594         uint64_t                 u_states_cur;
 595         uint64_t                 u_states_tot;
 596         uint64_t                 u_src_nodes;
 597 };
 598
 599 /* rule flags */
 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 */
 609
 610 /* scrub flags */
 611 #define PFRULE_NODF             0x0100
 612 #define PFRULE_RANDOMID         0x0800
 613 #define PFRULE_REASSEMBLE_TCP   0x1000
 614 #define PFRULE_SET_TOS          0x2000
 615
 616 /* rule flags again */
 617 #define PFRULE_IFBOUND          0x00010000      /* if-bound */
 618 #define PFRULE_STATESLOPPY      0x00020000      /* sloppy state tracking */
 619
 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 */
 623
 624
 625 struct pf_threshold {
 626         u_int32_t       limit;
 627 #define PF_THRESHOLD_MULT       1000
 628 #define PF_THRESHOLD_MAX        0xffffffff / PF_THRESHOLD_MULT
 629         u_int32_t       seconds;
 630         u_int32_t       count;
 631         u_int32_t       last;
 632 };
 633
 634 struct pf_src_node {
 635         LIST_ENTRY(pf_src_node) entry;
 636         struct pf_addr   addr;
 637         struct pf_addr   raddr;
 638         union pf_rule_ptr rule;
 639         struct pfi_kif  *kif;
 640         u_int64_t        bytes[2];
 641         u_int64_t        packets[2];
 642         u_int32_t        states;
 643         u_int32_t        conn;
 644         struct pf_threshold     conn_rate;
 645         u_int32_t        creation;
 646         u_int32_t        expire;
 647         sa_family_t      af;
 648         u_int8_t         ruletype;
 649 };
 650
 651 #define PFSNODE_HIWAT           10000   /* default source node table size */
 652
 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                  */
 665         u_int8_t        pad;
 666         u_int32_t       pfss_ts_mod;    /* timestamp modulation         */
 667 };
 668
 669 struct pf_state_host {
 670         struct pf_addr  addr;
 671         u_int16_t       port;
 672         u_int16_t       pad;
 673 };
 674
 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 */
 685         u_int8_t        pad[1];
 686 };
 687
 688 /* Keep synced with struct pf_state_key. */
 689 struct pf_state_key_cmp {
 690         struct pf_addr   addr[2];
 691         u_int16_t        port[2];
 692         sa_family_t      af;
 693         u_int8_t         proto;
 694         u_int8_t         pad[2];
 695 };
 696
 697 struct pf_state_key {
 698         struct pf_addr   addr[2];
 699         u_int16_t        port[2];
 700         sa_family_t      af;
 701         u_int8_t         proto;
 702         u_int8_t         pad[2];
 703
 704         LIST_ENTRY(pf_state_key) entry;
 705         TAILQ_HEAD(, pf_state)   states[2];
 706 };
 707
 708 /* Keep synced with struct pf_state. */
 709 struct pf_state_cmp {
 710         u_int64_t                id;
 711         u_int32_t                creatorid;
 712         u_int8_t                 direction;
 713         u_int8_t                 pad[3];
 714 };
 715
 716 struct pf_state {
 717         u_int64_t                id;
 718         u_int32_t                creatorid;
 719         u_int8_t                 direction;
 720         u_int8_t                 pad[3];
 721
 722         u_int                    refs;
 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  */
 733         struct pfi_kif          *kif;
 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];
 738         u_int64_t                bytes[2];
 739         u_int32_t                creation;
 740         u_int32_t                expire;
 741         u_int32_t                pfsync_time;
 742         u_int16_t                tag;
 743         u_int8_t                 log;
 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)
 752         u_int8_t                 timeout;
 753         u_int8_t                 sync_state; /* PFSYNC_S_x */
 754
 755         /* XXX */
 756         u_int8_t                 sync_updates;
 757         u_int8_t                _tail[3];
 758 };
 759
 760 /*
 761  * Unified state structures for pulling states out of the kernel
 762  * used by pfsync(4) and the pf(4) ioctl.
 763  */
 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
 768         u_int8_t        scrub_flag;
 769         u_int32_t       pfss_ts_mod;    /* timestamp modulation */
 770 } __packed;
 771
 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        */
 781         u_int8_t        pad[6];
 782 } __packed;
 783
 784 struct pfsync_state_key {
 785         struct pf_addr   addr[2];
 786         u_int16_t        port[2];
 787 };
 788
 789 struct pfsync_state {
 790         u_int64_t        id;
 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;
 796         u_int32_t        rule;
 797         u_int32_t        anchor;
 798         u_int32_t        nat_rule;
 799         u_int32_t        creation;
 800         u_int32_t        expire;
 801         u_int32_t        packets[2][2];
 802         u_int32_t        bytes[2][2];
 803         u_int32_t        creatorid;
 804         sa_family_t      af;
 805         u_int8_t         proto;
 806         u_int8_t         direction;
 807         u_int8_t         __spare[2];
 808         u_int8_t         log;
 809         u_int8_t         state_flags;
 810         u_int8_t         timeout;
 811         u_int8_t         sync_flags;
 812         u_int8_t         updates;
 813 } __packed;
 814
 815 #ifdef _KERNEL
 816 /* pfsync */
 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 *);
 823 typedef void            pfsync_detach_ifnet_t(struct ifnet *);
 824
 825 VNET_DECLARE(pfsync_state_import_t *, pfsync_state_import_ptr);
 826 #define V_pfsync_state_import_ptr       VNET(pfsync_state_import_ptr)
 827 VNET_DECLARE(pfsync_insert_state_t *, pfsync_insert_state_ptr);
 828 #define V_pfsync_insert_state_ptr       VNET(pfsync_insert_state_ptr)
 829 VNET_DECLARE(pfsync_update_state_t *, pfsync_update_state_ptr);
 830 #define V_pfsync_update_state_ptr       VNET(pfsync_update_state_ptr)
 831 VNET_DECLARE(pfsync_delete_state_t *, pfsync_delete_state_ptr);
 832 #define V_pfsync_delete_state_ptr       VNET(pfsync_delete_state_ptr)
 833 VNET_DECLARE(pfsync_clear_states_t *, pfsync_clear_states_ptr);
 834 #define V_pfsync_clear_states_ptr       VNET(pfsync_clear_states_ptr)
 835 VNET_DECLARE(pfsync_defer_t *, pfsync_defer_ptr);
 836 #define V_pfsync_defer_ptr              VNET(pfsync_defer_ptr)
 837 extern pfsync_detach_ifnet_t    *pfsync_detach_ifnet_ptr;
 838
 839 void                    pfsync_state_export(struct pfsync_state *,
 840                             struct pf_state *);
 841
 842 /* pflog */
 843 struct pf_ruleset;
 844 struct pf_pdesc;
 845 typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
 846     u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
 847     struct pf_ruleset *, struct pf_pdesc *, int);
 848 extern pflog_packet_t           *pflog_packet_ptr;
 849
 850 #endif /* _KERNEL */
 851
 852 #define PFSYNC_FLAG_SRCNODE     0x04
 853 #define PFSYNC_FLAG_NATSRCNODE  0x08
 854
 855 /* for copies to/from network byte order */
 856 /* ioctl interface also uses network byte order */
 857 #define pf_state_peer_hton(s,d) do {            \
 858         (d)->seqlo = htonl((s)->seqlo);         \
 859         (d)->seqhi = htonl((s)->seqhi);         \
 860         (d)->seqdiff = htonl((s)->seqdiff);     \
 861         (d)->max_win = htons((s)->max_win);     \
 862         (d)->mss = htons((s)->mss);             \
 863         (d)->state = (s)->state;                \
 864         (d)->wscale = (s)->wscale;              \
 865         if ((s)->scrub) {                                               \
 866                 (d)->scrub.pfss_flags =                                 \
 867                     htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);     \
 868                 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;             \
 869                 (d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
 870                 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;        \
 871         }                                                               \
 872 } while (0)
 873
 874 #define pf_state_peer_ntoh(s,d) do {            \
 875         (d)->seqlo = ntohl((s)->seqlo);         \
 876         (d)->seqhi = ntohl((s)->seqhi);         \
 877         (d)->seqdiff = ntohl((s)->seqdiff);     \
 878         (d)->max_win = ntohs((s)->max_win);     \
 879         (d)->mss = ntohs((s)->mss);             \
 880         (d)->state = (s)->state;                \
 881         (d)->wscale = (s)->wscale;              \
 882         if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID &&         \
 883             (d)->scrub != NULL) {                                       \
 884                 (d)->scrub->pfss_flags =                                \
 885                     ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;      \
 886                 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;             \
 887                 (d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
 888         }                                                               \
 889 } while (0)
 890
 891 #define pf_state_counter_hton(s,d) do {                         \
 892         d[0] = htonl((s>>32)&0xffffffff);                       \
 893         d[1] = htonl(s&0xffffffff);                             \
 894 } while (0)
 895
 896 #define pf_state_counter_from_pfsync(s)                         \
 897         (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
 898
 899 #define pf_state_counter_ntoh(s,d) do {                         \
 900         d = ntohl(s[0]);                                        \
 901         d = d<<32;                                              \
 902         d += ntohl(s[1]);                                       \
 903 } while (0)
 904
 905 TAILQ_HEAD(pf_rulequeue, pf_rule);
 906
 907 struct pf_anchor;
 908
 909 struct pf_ruleset {
 910         struct {
 911                 struct pf_rulequeue      queues[2];
 912                 struct {
 913                         struct pf_rulequeue     *ptr;
 914                         struct pf_rule          **ptr_array;
 915                         u_int32_t                rcount;
 916                         u_int32_t                ticket;
 917                         int                      open;
 918                 }                        active, inactive;
 919         }                        rules[PF_RULESET_MAX];
 920         struct pf_anchor        *anchor;
 921         u_int32_t                tticket;
 922         int                      tables;
 923         int                      topen;
 924 };
 925
 926 RB_HEAD(pf_anchor_global, pf_anchor);
 927 RB_HEAD(pf_anchor_node, pf_anchor);
 928 struct pf_anchor {
 929         RB_ENTRY(pf_anchor)      entry_global;
 930         RB_ENTRY(pf_anchor)      entry_node;
 931         struct pf_anchor        *parent;
 932         struct pf_anchor_node    children;
 933         char                     name[PF_ANCHOR_NAME_SIZE];
 934         char                     path[MAXPATHLEN];
 935         struct pf_ruleset        ruleset;
 936         int                      refcnt;        /* anchor rules */
 937         int                      match; /* XXX: used for pfctl black magic */
 938 };
 939 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
 940 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
 941
 942 #define PF_RESERVED_ANCHOR      "_pf"
 943
 944 #define PFR_TFLAG_PERSIST       0x00000001
 945 #define PFR_TFLAG_CONST         0x00000002
 946 #define PFR_TFLAG_ACTIVE        0x00000004
 947 #define PFR_TFLAG_INACTIVE      0x00000008
 948 #define PFR_TFLAG_REFERENCED    0x00000010
 949 #define PFR_TFLAG_REFDANCHOR    0x00000020
 950 #define PFR_TFLAG_COUNTERS      0x00000040
 951 /* Adjust masks below when adding flags. */
 952 #define PFR_TFLAG_USRMASK       (PFR_TFLAG_PERSIST      | \
 953                                  PFR_TFLAG_CONST        | \
 954                                  PFR_TFLAG_COUNTERS)
 955 #define PFR_TFLAG_SETMASK       (PFR_TFLAG_ACTIVE       | \
 956                                  PFR_TFLAG_INACTIVE     | \
 957                                  PFR_TFLAG_REFERENCED   | \
 958                                  PFR_TFLAG_REFDANCHOR)
 959 #define PFR_TFLAG_ALLMASK       (PFR_TFLAG_PERSIST      | \
 960                                  PFR_TFLAG_CONST        | \
 961                                  PFR_TFLAG_ACTIVE       | \
 962                                  PFR_TFLAG_INACTIVE     | \
 963                                  PFR_TFLAG_REFERENCED   | \
 964                                  PFR_TFLAG_REFDANCHOR   | \
 965                                  PFR_TFLAG_COUNTERS)
 966
 967 struct pf_anchor_stackframe;
 968
 969 struct pfr_table {
 970         char                     pfrt_anchor[MAXPATHLEN];
 971         char                     pfrt_name[PF_TABLE_NAME_SIZE];
 972         u_int32_t                pfrt_flags;
 973         u_int8_t                 pfrt_fback;
 974 };
 975
 976 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
 977         PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
 978         PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
 979
 980 struct pfr_addr {
 981         union {
 982                 struct in_addr   _pfra_ip4addr;
 983                 struct in6_addr  _pfra_ip6addr;
 984         }                pfra_u;
 985         u_int8_t         pfra_af;
 986         u_int8_t         pfra_net;
 987         u_int8_t         pfra_not;
 988         u_int8_t         pfra_fback;
 989 };
 990 #define pfra_ip4addr    pfra_u._pfra_ip4addr
 991 #define pfra_ip6addr    pfra_u._pfra_ip6addr
 992
 993 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
 994 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
 995 #define PFR_OP_XPASS    PFR_OP_ADDR_MAX
 996
 997 struct pfr_astats {
 998         struct pfr_addr  pfras_a;
 999         u_int64_t        pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1000         u_int64_t        pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1001         long             pfras_tzero;
1002 };
1003
1004 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1005
1006 struct pfr_tstats {
1007         struct pfr_table pfrts_t;
1008         u_int64_t        pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1009         u_int64_t        pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1010         u_int64_t        pfrts_match;
1011         u_int64_t        pfrts_nomatch;
1012         long             pfrts_tzero;
1013         int              pfrts_cnt;
1014         int              pfrts_refcnt[PFR_REFCNT_MAX];
1015 };
1016
1017 struct pfr_ktstats {
1018         struct pfr_table pfrts_t;
1019         counter_u64_t    pfrkts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1020         counter_u64_t    pfrkts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1021         counter_u64_t    pfrkts_match;
1022         counter_u64_t    pfrkts_nomatch;
1023         long             pfrkts_tzero;
1024         int              pfrkts_cnt;
1025         int              pfrkts_refcnt[PFR_REFCNT_MAX];
1026 };
1027 #define pfrts_name      pfrts_t.pfrt_name
1028 #define pfrts_flags     pfrts_t.pfrt_flags
1029
1030 #ifndef _SOCKADDR_UNION_DEFINED
1031 #define _SOCKADDR_UNION_DEFINED
1032 union sockaddr_union {
1033         struct sockaddr         sa;
1034         struct sockaddr_in      sin;
1035         struct sockaddr_in6     sin6;
1036 };
1037 #endif /* _SOCKADDR_UNION_DEFINED */
1038
1039 struct pfr_kcounters {
1040         counter_u64_t            pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1041         counter_u64_t            pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1042         long                     pfrkc_tzero;
1043 };
1044
1045 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1046 struct pfr_kentry {
1047         struct radix_node        pfrke_node[2];
1048         union sockaddr_union     pfrke_sa;
1049         SLIST_ENTRY(pfr_kentry)  pfrke_workq;
1050         struct pfr_kcounters     pfrke_counters;
1051         u_int8_t                 pfrke_af;
1052         u_int8_t                 pfrke_net;
1053         u_int8_t                 pfrke_not;
1054         u_int8_t                 pfrke_mark;
1055 };
1056
1057 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1058 RB_HEAD(pfr_ktablehead, pfr_ktable);
1059 struct pfr_ktable {
1060         struct pfr_ktstats       pfrkt_kts;
1061         RB_ENTRY(pfr_ktable)     pfrkt_tree;
1062         SLIST_ENTRY(pfr_ktable)  pfrkt_workq;
1063         struct radix_node_head  *pfrkt_ip4;
1064         struct radix_node_head  *pfrkt_ip6;
1065         struct pfr_ktable       *pfrkt_shadow;
1066         struct pfr_ktable       *pfrkt_root;
1067         struct pf_ruleset       *pfrkt_rs;
1068         long                     pfrkt_larg;
1069         int                      pfrkt_nflags;
1070 };
1071 #define pfrkt_t         pfrkt_kts.pfrts_t
1072 #define pfrkt_name      pfrkt_t.pfrt_name
1073 #define pfrkt_anchor    pfrkt_t.pfrt_anchor
1074 #define pfrkt_ruleset   pfrkt_t.pfrt_ruleset
1075 #define pfrkt_flags     pfrkt_t.pfrt_flags
1076 #define pfrkt_cnt       pfrkt_kts.pfrkts_cnt
1077 #define pfrkt_refcnt    pfrkt_kts.pfrkts_refcnt
1078 #define pfrkt_packets   pfrkt_kts.pfrkts_packets
1079 #define pfrkt_bytes     pfrkt_kts.pfrkts_bytes
1080 #define pfrkt_match     pfrkt_kts.pfrkts_match
1081 #define pfrkt_nomatch   pfrkt_kts.pfrkts_nomatch
1082 #define pfrkt_tzero     pfrkt_kts.pfrkts_tzero
1083
1084 /* keep synced with pfi_kif, used in RB_FIND */
1085 struct pfi_kif_cmp {
1086         char                             pfik_name[IFNAMSIZ];
1087 };
1088
1089 struct pfi_kif {
1090         char                             pfik_name[IFNAMSIZ];
1091         union {
1092                 RB_ENTRY(pfi_kif)        _pfik_tree;
1093                 LIST_ENTRY(pfi_kif)      _pfik_list;
1094         } _pfik_glue;
1095 #define pfik_tree       _pfik_glue._pfik_tree
1096 #define pfik_list       _pfik_glue._pfik_list
1097         u_int64_t                        pfik_packets[2][2][2];
1098         u_int64_t                        pfik_bytes[2][2][2];
1099         u_int32_t                        pfik_tzero;
1100         u_int                            pfik_flags;
1101         struct ifnet                    *pfik_ifp;
1102         struct ifg_group                *pfik_group;
1103         u_int                            pfik_rulerefs;
1104         TAILQ_HEAD(, pfi_dynaddr)        pfik_dynaddrs;
1105 };
1106
1107 #define PFI_IFLAG_REFS          0x0001  /* has state references */
1108 #define PFI_IFLAG_SKIP          0x0100  /* skip filtering on interface */
1109
1110 struct pf_pdesc {
1111         struct {
1112                 int      done;
1113                 uid_t    uid;
1114                 gid_t    gid;
1115         }                lookup;
1116         u_int64_t        tot_len;       /* Make Mickey money */
1117         union {
1118                 struct tcphdr           *tcp;
1119                 struct udphdr           *udp;
1120                 struct icmp             *icmp;
1121 #ifdef INET6
1122                 struct icmp6_hdr        *icmp6;
1123 #endif /* INET6 */
1124                 void                    *any;
1125         } hdr;
1126
1127         struct pf_rule  *nat_rule;      /* nat/rdr rule applied to packet */
1128         struct pf_addr  *src;           /* src address */
1129         struct pf_addr  *dst;           /* dst address */
1130         u_int16_t *sport;
1131         u_int16_t *dport;
1132         struct pf_mtag  *pf_mtag;
1133
1134         u_int32_t        p_len;         /* total length of payload */
1135
1136         u_int16_t       *ip_sum;
1137         u_int16_t       *proto_sum;
1138         u_int16_t        flags;         /* Let SCRUB trigger behavior in
1139                                          * state code. Easier than tags */
1140 #define PFDESC_TCP_NORM 0x0001          /* TCP shall be statefully scrubbed */
1141 #define PFDESC_IP_REAS  0x0002          /* IP frags would've been reassembled */
1142         sa_family_t      af;
1143         u_int8_t         proto;
1144         u_int8_t         tos;
1145         u_int8_t         dir;           /* direction */
1146         u_int8_t         sidx;          /* key index for source */
1147         u_int8_t         didx;          /* key index for destination */
1148 };
1149
1150 /* flags for RDR options */
1151 #define PF_DPORT_RANGE  0x01            /* Dest port uses range */
1152 #define PF_RPORT_RANGE  0x02            /* RDR'ed port uses range */
1153
1154 /* UDP state enumeration */
1155 #define PFUDPS_NO_TRAFFIC       0
1156 #define PFUDPS_SINGLE           1
1157 #define PFUDPS_MULTIPLE         2
1158
1159 #define PFUDPS_NSTATES          3       /* number of state levels */
1160
1161 #define PFUDPS_NAMES { \
1162         "NO_TRAFFIC", \
1163         "SINGLE", \
1164         "MULTIPLE", \
1165         NULL \
1166 }
1167
1168 /* Other protocol state enumeration */
1169 #define PFOTHERS_NO_TRAFFIC     0
1170 #define PFOTHERS_SINGLE         1
1171 #define PFOTHERS_MULTIPLE       2
1172
1173 #define PFOTHERS_NSTATES        3       /* number of state levels */
1174
1175 #define PFOTHERS_NAMES { \
1176         "NO_TRAFFIC", \
1177         "SINGLE", \
1178         "MULTIPLE", \
1179         NULL \
1180 }
1181
1182 #define ACTION_SET(a, x) \
1183         do { \
1184                 if ((a) != NULL) \
1185                         *(a) = (x); \
1186         } while (0)
1187
1188 #define REASON_SET(a, x) \
1189         do { \
1190                 if ((a) != NULL) \
1191                         *(a) = (x); \
1192                 if (x < PFRES_MAX) \
1193                         counter_u64_add(V_pf_status.counters[x], 1); \
1194         } while (0)
1195
1196 struct pf_kstatus {
1197         counter_u64_t   counters[PFRES_MAX]; /* reason for passing/dropping */
1198         counter_u64_t   lcounters[LCNT_MAX]; /* limit counters */
1199         counter_u64_t   fcounters[FCNT_MAX]; /* state operation counters */
1200         counter_u64_t   scounters[SCNT_MAX]; /* src_node operation counters */
1201         uint32_t        states;
1202         uint32_t        src_nodes;
1203         uint32_t        running;
1204         uint32_t        since;
1205         uint32_t        debug;
1206         uint32_t        hostid;
1207         char            ifname[IFNAMSIZ];
1208         uint8_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 extern u_long           pf_hashmask;
1487 extern u_long           pf_srchashmask;
1488 #define PF_HASHSIZ      (32768)
1489 #define PF_SRCHASHSIZ   (PF_HASHSIZ/4)
1490 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1491 VNET_DECLARE(struct pf_idhash *, pf_idhash);
1492 #define V_pf_keyhash    VNET(pf_keyhash)
1493 #define V_pf_idhash     VNET(pf_idhash)
1494 VNET_DECLARE(struct pf_srchash *, pf_srchash);
1495 #define V_pf_srchash    VNET(pf_srchash)
1496
1497 #define PF_IDHASH(s)    (be64toh((s)->id) % (pf_hashmask + 1))
1498
1499 VNET_DECLARE(void *, pf_swi_cookie);
1500 #define V_pf_swi_cookie VNET(pf_swi_cookie)
1501
1502 VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1503 #define V_pf_stateid    VNET(pf_stateid)
1504
1505 TAILQ_HEAD(pf_altqqueue, pf_altq);
1506 VNET_DECLARE(struct pf_altqqueue,        pf_altqs[2]);
1507 #define V_pf_altqs                       VNET(pf_altqs)
1508 VNET_DECLARE(struct pf_palist,           pf_pabuf);
1509 #define V_pf_pabuf                       VNET(pf_pabuf)
1510
1511 VNET_DECLARE(u_int32_t,                  ticket_altqs_active);
1512 #define V_ticket_altqs_active            VNET(ticket_altqs_active)
1513 VNET_DECLARE(u_int32_t,                  ticket_altqs_inactive);
1514 #define V_ticket_altqs_inactive          VNET(ticket_altqs_inactive)
1515 VNET_DECLARE(int,                        altqs_inactive_open);
1516 #define V_altqs_inactive_open            VNET(altqs_inactive_open)
1517 VNET_DECLARE(u_int32_t,                  ticket_pabuf);
1518 #define V_ticket_pabuf                   VNET(ticket_pabuf)
1519 VNET_DECLARE(struct pf_altqqueue *,      pf_altqs_active);
1520 #define V_pf_altqs_active                VNET(pf_altqs_active)
1521 VNET_DECLARE(struct pf_altqqueue *,      pf_altqs_inactive);
1522 #define V_pf_altqs_inactive              VNET(pf_altqs_inactive)
1523
1524 VNET_DECLARE(struct pf_rulequeue, pf_unlinked_rules);
1525 #define V_pf_unlinked_rules     VNET(pf_unlinked_rules)
1526
1527 void                             pf_initialize(void);
1528 void                             pf_mtag_initialize(void);
1529 void                             pf_mtag_cleanup(void);
1530 void                             pf_cleanup(void);
1531
1532 struct pf_mtag                  *pf_get_mtag(struct mbuf *);
1533
1534 extern void                      pf_calc_skip_steps(struct pf_rulequeue *);
1535 #ifdef ALTQ
1536 extern  void                     pf_altq_ifnet_event(struct ifnet *, int);
1537 #endif
1538 VNET_DECLARE(uma_zone_t,         pf_state_z);
1539 #define V_pf_state_z             VNET(pf_state_z)
1540 VNET_DECLARE(uma_zone_t,         pf_state_key_z);
1541 #define V_pf_state_key_z         VNET(pf_state_key_z)
1542 VNET_DECLARE(uma_zone_t,         pf_state_scrub_z);
1543 #define V_pf_state_scrub_z       VNET(pf_state_scrub_z)
1544
1545 extern void                      pf_purge_thread(void *);
1546 extern void                      pf_unload_vnet_purge(void);
1547 extern void                      pf_intr(void *);
1548 extern void                      pf_purge_expired_src_nodes(void);
1549
1550 extern int                       pf_unlink_state(struct pf_state *, u_int);
1551 #define PF_ENTER_LOCKED         0x00000001
1552 #define PF_RETURN_LOCKED        0x00000002
1553 extern int                       pf_state_insert(struct pfi_kif *,
1554                                     struct pf_state_key *,
1555                                     struct pf_state_key *,
1556                                     struct pf_state *);
1557 extern void                      pf_free_state(struct pf_state *);
1558
1559 static __inline void
1560 pf_ref_state(struct pf_state *s)
1561 {
1562
1563         refcount_acquire(&s->refs);
1564 }
1565
1566 static __inline int
1567 pf_release_state(struct pf_state *s)
1568 {
1569
1570         if (refcount_release(&s->refs)) {
1571                 pf_free_state(s);
1572                 return (1);
1573         } else
1574                 return (0);
1575 }
1576
1577 extern struct pf_state          *pf_find_state_byid(uint64_t, uint32_t);
1578 extern struct pf_state          *pf_find_state_all(struct pf_state_key_cmp *,
1579                                     u_int, int *);
1580 extern struct pf_src_node       *pf_find_src_node(struct pf_addr *,
1581                                     struct pf_rule *, sa_family_t, int);
1582 extern void                      pf_unlink_src_node(struct pf_src_node *);
1583 extern u_int                     pf_free_src_nodes(struct pf_src_node_list *);
1584 extern void                      pf_print_state(struct pf_state *);
1585 extern void                      pf_print_flags(u_int8_t);
1586 extern u_int16_t                 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1587                                     u_int8_t);
1588 extern u_int16_t                 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1589                                     u_int16_t, u_int16_t, u_int8_t);
1590
1591 VNET_DECLARE(struct ifnet *,             sync_ifp);
1592 #define V_sync_ifp                       VNET(sync_ifp);
1593 VNET_DECLARE(struct pf_rule,             pf_default_rule);
1594 #define V_pf_default_rule                 VNET(pf_default_rule)
1595 extern void                      pf_addrcpy(struct pf_addr *, struct pf_addr *,
1596                                     u_int8_t);
1597 void                            pf_free_rule(struct pf_rule *);
1598
1599 #ifdef INET
1600 int     pf_test(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
1601 int     pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1602             struct pf_pdesc *);
1603 #endif /* INET */
1604
1605 #ifdef INET6
1606 int     pf_test6(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
1607 int     pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1608             struct pf_pdesc *);
1609 void    pf_poolmask(struct pf_addr *, struct pf_addr*,
1610             struct pf_addr *, struct pf_addr *, u_int8_t);
1611 void    pf_addr_inc(struct pf_addr *, sa_family_t);
1612 int     pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *);
1613 #endif /* INET6 */
1614
1615 u_int32_t       pf_new_isn(struct pf_state *);
1616 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1617             sa_family_t);
1618 void    pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1619 void    pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1620             u_int8_t);
1621 void    pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1622 void    pf_send_deferred_syn(struct pf_state *);
1623 int     pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1624             struct pf_addr *, sa_family_t);
1625 int     pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1626             struct pf_addr *, sa_family_t);
1627 int     pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1628
1629 void    pf_normalize_init(void);
1630 void    pf_normalize_cleanup(void);
1631 int     pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1632             struct pf_pdesc *);
1633 void    pf_normalize_tcp_cleanup(struct pf_state *);
1634 int     pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1635             struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1636 int     pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1637             u_short *, struct tcphdr *, struct pf_state *,
1638             struct pf_state_peer *, struct pf_state_peer *, int *);
1639 u_int32_t
1640         pf_state_expires(const struct pf_state *);
1641 void    pf_purge_expired_fragments(void);
1642 int     pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1643             int);
1644 int     pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1645 struct pf_state_key *pf_alloc_state_key(int);
1646 void    pfr_initialize(void);
1647 void    pfr_cleanup(void);
1648 int     pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1649 void    pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1650             u_int64_t, int, int, int);
1651 int     pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1652 void    pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1653 struct pfr_ktable *
1654         pfr_attach_table(struct pf_ruleset *, char *);
1655 void    pfr_detach_table(struct pfr_ktable *);
1656 int     pfr_clr_tables(struct pfr_table *, int *, int);
1657 int     pfr_add_tables(struct pfr_table *, int, int *, int);
1658 int     pfr_del_tables(struct pfr_table *, int, int *, int);
1659 int     pfr_table_count(struct pfr_table *, int);
1660 int     pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1661 int     pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1662 int     pfr_clr_tstats(struct pfr_table *, int, int *, int);
1663 int     pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1664 int     pfr_clr_addrs(struct pfr_table *, int *, int);
1665 int     pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1666 int     pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1667             int);
1668 int     pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1669             int);
1670 int     pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1671             int *, int *, int *, int, u_int32_t);
1672 int     pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1673 int     pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1674 int     pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1675             int);
1676 int     pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1677             int);
1678 int     pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1679 int     pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1680 int     pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1681 int     pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1682             int *, u_int32_t, int);
1683
1684 MALLOC_DECLARE(PFI_MTYPE);
1685 VNET_DECLARE(struct pfi_kif *,           pfi_all);
1686 #define V_pfi_all                        VNET(pfi_all)
1687
1688 void             pfi_initialize(void);
1689 void             pfi_initialize_vnet(void);
1690 void             pfi_cleanup(void);
1691 void             pfi_cleanup_vnet(void);
1692 void             pfi_kif_ref(struct pfi_kif *);
1693 void             pfi_kif_unref(struct pfi_kif *);
1694 struct pfi_kif  *pfi_kif_find(const char *);
1695 struct pfi_kif  *pfi_kif_attach(struct pfi_kif *, const char *);
1696 int              pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1697 void             pfi_kif_purge(void);
1698 int              pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1699                     sa_family_t);
1700 int              pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1701 void             pfi_dynaddr_remove(struct pfi_dynaddr *);
1702 void             pfi_dynaddr_copyout(struct pf_addr_wrap *);
1703 void             pfi_update_status(const char *, struct pf_status *);
1704 void             pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1705 int              pfi_set_flags(const char *, int);
1706 int              pfi_clear_flags(const char *, int);
1707
1708 int              pf_match_tag(struct mbuf *, struct pf_rule *, int *, int);
1709 int              pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1710 int              pf_addr_cmp(struct pf_addr *, struct pf_addr *,
1711                     sa_family_t);
1712 void             pf_qid2qname(u_int32_t, char *);
1713
1714 VNET_DECLARE(struct pf_kstatus, pf_status);
1715 #define V_pf_status     VNET(pf_status)
1716
1717 struct pf_limit {
1718         uma_zone_t      zone;
1719         u_int           limit;
1720 };
1721 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1722 #define V_pf_limits VNET(pf_limits)
1723
1724 #endif /* _KERNEL */
1725
1726 #ifdef _KERNEL
1727 VNET_DECLARE(struct pf_anchor_global,            pf_anchors);
1728 #define V_pf_anchors                             VNET(pf_anchors)
1729 VNET_DECLARE(struct pf_anchor,                   pf_main_anchor);
1730 #define V_pf_main_anchor                         VNET(pf_main_anchor)
1731 #define pf_main_ruleset V_pf_main_anchor.ruleset
1732 #endif
1733
1734 /* these ruleset functions can be linked into userland programs (pfctl) */
1735 int                      pf_get_ruleset_number(u_int8_t);
1736 void                     pf_init_ruleset(struct pf_ruleset *);
1737 int                      pf_anchor_setup(struct pf_rule *,
1738                             const struct pf_ruleset *, const char *);
1739 int                      pf_anchor_copyout(const struct pf_ruleset *,
1740                             const struct pf_rule *, struct pfioc_rule *);
1741 void                     pf_anchor_remove(struct pf_rule *);
1742 void                     pf_remove_if_empty_ruleset(struct pf_ruleset *);
1743 struct pf_ruleset       *pf_find_ruleset(const char *);
1744 struct pf_ruleset       *pf_find_or_create_ruleset(const char *);
1745 void                     pf_rs_initialize(void);
1746
1747 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1748 int     pf_osfp_add(struct pf_osfp_ioctl *);
1749 #ifdef _KERNEL
1750 struct pf_osfp_enlist *
1751         pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1752             const struct tcphdr *);
1753 #endif /* _KERNEL */
1754 void    pf_osfp_flush(void);
1755 int     pf_osfp_get(struct pf_osfp_ioctl *);
1756 int     pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1757
1758 #ifdef _KERNEL
1759 void                     pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1760
1761 void                     pf_step_into_anchor(struct pf_anchor_stackframe *, int *,
1762                             struct pf_ruleset **, int, struct pf_rule **,
1763                             struct pf_rule **, int *);
1764 int                      pf_step_out_of_anchor(struct pf_anchor_stackframe *, int *,
1765                             struct pf_ruleset **, int, struct pf_rule **,
1766                             struct pf_rule **, int *);
1767
1768 int                      pf_map_addr(u_int8_t, struct pf_rule *,
1769                             struct pf_addr *, struct pf_addr *,
1770                             struct pf_addr *, struct pf_src_node **);
1771 struct pf_rule          *pf_get_translation(struct pf_pdesc *, struct mbuf *,
1772                             int, int, struct pfi_kif *, struct pf_src_node **,
1773                             struct pf_state_key **, struct pf_state_key **,
1774                             struct pf_addr *, struct pf_addr *,
1775                             uint16_t, uint16_t, struct pf_anchor_stackframe *);
1776
1777 struct pf_state_key     *pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1778                             struct pf_addr *, u_int16_t, u_int16_t);
1779 struct pf_state_key     *pf_state_key_clone(struct pf_state_key *);
1780 #endif /* _KERNEL */
1781
1782 #endif /* _NET_PFVAR_H_ */