sys/net/pfvar.h

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