sys/contrib/pf/net/pfvar.h

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