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