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