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