sys/net/pfvar.h

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