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