sys/net/pfvar.h

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