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