sys/netpfil/ipfw/ip_fw_private.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _IPFW2_PRIVATE_H
  31 #define _IPFW2_PRIVATE_H
  32
  33 /*
  34  * Internal constants and data structures used by ipfw components
  35  * and not meant to be exported outside the kernel.
  36  */
  37
  38 #ifdef _KERNEL
  39
  40 /*
  41  * For platforms that do not have SYSCTL support, we wrap the
  42  * SYSCTL_* into a function (one per file) to collect the values
  43  * into an array at module initialization. The wrapping macros,
  44  * SYSBEGIN() and SYSEND, are empty in the default case.
  45  */
  46 #ifndef SYSBEGIN
  47 #define SYSBEGIN(x)
  48 #endif
  49 #ifndef SYSEND
  50 #define SYSEND
  51 #endif
  52
  53 /* Return values from ipfw_chk() */
  54 enum {
  55         IP_FW_PASS = 0,
  56         IP_FW_DENY,
  57         IP_FW_DIVERT,
  58         IP_FW_TEE,
  59         IP_FW_DUMMYNET,
  60         IP_FW_NETGRAPH,
  61         IP_FW_NGTEE,
  62         IP_FW_NAT,
  63         IP_FW_REASS,
  64         IP_FW_NAT64,
  65 };
  66
  67 /*
  68  * Structure for collecting parameters to dummynet for ip6_output forwarding
  69  */
  70 struct _ip6dn_args {
  71        struct ip6_pktopts *opt_or;
  72        int flags_or;
  73        struct ip6_moptions *im6o_or;
  74        struct ifnet *origifp_or;
  75        struct ifnet *ifp_or;
  76        struct sockaddr_in6 dst_or;
  77        u_long mtu_or;
  78 };
  79
  80
  81 /*
  82  * Arguments for calling ipfw_chk() and dummynet_io(). We put them
  83  * all into a structure because this way it is easier and more
  84  * efficient to pass variables around and extend the interface.
  85  */
  86 struct ip_fw_args {
  87         uint32_t                flags;
  88 #define IPFW_ARGS_ETHER         0x0001  /* has valid ethernet header    */
  89 #define IPFW_ARGS_NH4           0x0002  /* has IPv4 next hop in hopstore */
  90 #define IPFW_ARGS_NH6           0x0004  /* has IPv6 next hop in hopstore */
  91 #define IPFW_ARGS_NH4PTR        0x0008  /* has IPv4 next hop in next_hop */
  92 #define IPFW_ARGS_NH6PTR        0x0010  /* has IPv6 next hop in next_hop6 */
  93 #define IPFW_ARGS_REF           0x0020  /* has valid ipfw_rule_ref      */
  94         /*
  95          * On return, it points to the matching rule.
  96          * On entry, rule.slot > 0 means the info is valid and
  97          * contains the starting rule for an ipfw search.
  98          * If chain_id == chain->id && slot >0 then jump to that slot.
  99          * Otherwise, we locate the first rule >= rulenum:rule_id
 100          */
 101         struct ipfw_rule_ref    rule;   /* match/restart info           */
 102
 103         struct ifnet            *oif;   /* output interface             */
 104         struct inpcb            *inp;
 105         union {
 106                 /*
 107                  * We don't support forwarding on layer2, thus we can
 108                  * keep eh pointer in this union.
 109                  * next_hop[6] pointers can be used to point to next hop
 110                  * stored in rule's opcode to avoid copying into hopstore.
 111                  * Also, it is expected that all 0x1-0x10 flags are mutually
 112                  * exclusive.
 113                  */
 114                 struct ether_header     *eh;    /* for bridged packets  */
 115                 struct sockaddr_in      *next_hop;
 116                 struct sockaddr_in6     *next_hop6;
 117                 /* ipfw next hop storage */
 118                 struct sockaddr_in      hopstore;
 119                 struct ip_fw_nh6 {
 120                         struct in6_addr sin6_addr;
 121                         uint32_t        sin6_scope_id;
 122                         uint16_t        sin6_port;
 123                 } hopstore6;
 124         };
 125
 126         struct mbuf             *m;     /* the mbuf chain               */
 127         struct ipfw_flow_id     f_id;   /* grabbed from IP header       */
 128 };
 129
 130 MALLOC_DECLARE(M_IPFW);
 131
 132 /*
 133  * Hooks sometime need to know the direction of the packet
 134  * (divert, dummynet, netgraph, ...)
 135  * We use a generic definition here, with bit0-1 indicating the
 136  * direction, bit 2 indicating layer2 or 3, bit 3-4 indicating the
 137  * specific protocol
 138  * indicating the protocol (if necessary)
 139  */
 140 enum {
 141         DIR_MASK =      0x3,
 142         DIR_OUT =       0,
 143         DIR_IN =        1,
 144         DIR_FWD =       2,
 145         DIR_DROP =      3,
 146         PROTO_LAYER2 =  0x4, /* set for layer 2 */
 147         /* PROTO_DEFAULT = 0, */
 148         PROTO_IPV4 =    0x08,
 149         PROTO_IPV6 =    0x10,
 150         PROTO_IFB =     0x0c, /* layer2 + ifbridge */
 151    /*   PROTO_OLDBDG =  0x14, unused, old bridge */
 152 };
 153
 154 /* wrapper for freeing a packet, in case we need to do more work */
 155 #ifndef FREE_PKT
 156 #if defined(__linux__) || defined(_WIN32)
 157 #define FREE_PKT(m)     netisr_dispatch(-1, m)
 158 #else
 159 #define FREE_PKT(m)     m_freem(m)
 160 #endif
 161 #endif /* !FREE_PKT */
 162
 163 /*
 164  * Function definitions.
 165  */
 166 int ipfw_chk(struct ip_fw_args *args);
 167 struct mbuf *ipfw_send_pkt(struct mbuf *, struct ipfw_flow_id *,
 168     u_int32_t, u_int32_t, int);
 169
 170 /* attach (arg = 1) or detach (arg = 0) hooks */
 171 int ipfw_attach_hooks(int);
 172 #ifdef NOTYET
 173 void ipfw_nat_destroy(void);
 174 #endif
 175
 176 /* In ip_fw_log.c */
 177 struct ip;
 178 struct ip_fw_chain;
 179
 180 void ipfw_bpf_init(int);
 181 void ipfw_bpf_uninit(int);
 182 void ipfw_bpf_mtap2(void *, u_int, struct mbuf *);
 183 void ipfw_log(struct ip_fw_chain *chain, struct ip_fw *f, u_int hlen,
 184     struct ip_fw_args *args, struct mbuf *m, struct ifnet *oif,
 185     u_short offset, uint32_t tablearg, struct ip *ip);
 186 VNET_DECLARE(u_int64_t, norule_counter);
 187 #define V_norule_counter        VNET(norule_counter)
 188 VNET_DECLARE(int, verbose_limit);
 189 #define V_verbose_limit         VNET(verbose_limit)
 190
 191 /* In ip_fw_dynamic.c */
 192 struct sockopt_data;
 193
 194 enum { /* result for matching dynamic rules */
 195         MATCH_REVERSE = 0,
 196         MATCH_FORWARD,
 197         MATCH_NONE,
 198         MATCH_UNKNOWN,
 199 };
 200
 201 /*
 202  * Macro to determine that we need to do or redo dynamic state lookup.
 203  * direction == MATCH_UNKNOWN means that this is first lookup, then we need
 204  * to do lookup.
 205  * Otherwise check the state name, if previous lookup was for "any" name,
 206  * this means there is no state with specific name. Thus no need to do
 207  * lookup. If previous name was not "any", redo lookup for specific name.
 208  */
 209 #define DYN_LOOKUP_NEEDED(p, cmd)       \
 210     ((p)->direction == MATCH_UNKNOWN || \
 211         ((p)->kidx != 0 && (p)->kidx != (cmd)->arg1))
 212 #define DYN_INFO_INIT(p)        do {    \
 213         (p)->direction = MATCH_UNKNOWN; \
 214         (p)->kidx = 0;                  \
 215 } while (0)
 216 struct ipfw_dyn_info {
 217         uint16_t        direction;      /* match direction */
 218         uint16_t        kidx;           /* state name kidx */
 219         uint32_t        hashval;        /* hash value */
 220         uint32_t        version;        /* bucket version */
 221         uint32_t        f_pos;
 222 };
 223 int ipfw_dyn_install_state(struct ip_fw_chain *chain, struct ip_fw *rule,
 224     const ipfw_insn_limit *cmd, const struct ip_fw_args *args,
 225     const void *ulp, int pktlen, struct ipfw_dyn_info *info,
 226     uint32_t tablearg);
 227 struct ip_fw *ipfw_dyn_lookup_state(const struct ip_fw_args *args,
 228     const void *ulp, int pktlen, const ipfw_insn *cmd,
 229     struct ipfw_dyn_info *info);
 230
 231 int ipfw_is_dyn_rule(struct ip_fw *rule);
 232 void ipfw_expire_dyn_states(struct ip_fw_chain *, ipfw_range_tlv *);
 233 void ipfw_get_dynamic(struct ip_fw_chain *chain, char **bp, const char *ep);
 234 int ipfw_dump_states(struct ip_fw_chain *chain, struct sockopt_data *sd);
 235
 236 void ipfw_dyn_init(struct ip_fw_chain *);       /* per-vnet initialization */
 237 void ipfw_dyn_uninit(int);      /* per-vnet deinitialization */
 238 int ipfw_dyn_len(void);
 239 uint32_t ipfw_dyn_get_count(uint32_t *, int *);
 240 void ipfw_dyn_reset_eaction(struct ip_fw_chain *ch, uint16_t eaction_id,
 241     uint16_t default_id, uint16_t instance_id);
 242
 243 /* common variables */
 244 VNET_DECLARE(int, fw_one_pass);
 245 #define V_fw_one_pass           VNET(fw_one_pass)
 246
 247 VNET_DECLARE(int, fw_verbose);
 248 #define V_fw_verbose            VNET(fw_verbose)
 249
 250 VNET_DECLARE(struct ip_fw_chain, layer3_chain);
 251 #define V_layer3_chain          VNET(layer3_chain)
 252
 253 VNET_DECLARE(int, ipfw_vnet_ready);
 254 #define V_ipfw_vnet_ready       VNET(ipfw_vnet_ready)
 255
 256 VNET_DECLARE(u_int32_t, set_disable);
 257 #define V_set_disable           VNET(set_disable)
 258
 259 VNET_DECLARE(int, autoinc_step);
 260 #define V_autoinc_step          VNET(autoinc_step)
 261
 262 VNET_DECLARE(unsigned int, fw_tables_max);
 263 #define V_fw_tables_max         VNET(fw_tables_max)
 264
 265 VNET_DECLARE(unsigned int, fw_tables_sets);
 266 #define V_fw_tables_sets        VNET(fw_tables_sets)
 267
 268 struct tables_config;
 269
 270 #ifdef _KERNEL
 271 /*
 272  * Here we have the structure representing an ipfw rule.
 273  *
 274  * It starts with a general area
 275  * followed by an array of one or more instructions, which the code
 276  * accesses as an array of 32-bit values.
 277  *
 278  * Given a rule pointer  r:
 279  *
 280  *  r->cmd              is the start of the first instruction.
 281  *  ACTION_PTR(r)       is the start of the first action (things to do
 282  *                      once a rule matched).
 283  */
 284
 285 struct ip_fw {
 286         uint16_t        act_ofs;        /* offset of action in 32-bit units */
 287         uint16_t        cmd_len;        /* # of 32-bit words in cmd     */
 288         uint16_t        rulenum;        /* rule number                  */
 289         uint8_t         set;            /* rule set (0..31)             */
 290         uint8_t         flags;          /* currently unused             */
 291         counter_u64_t   cntr;           /* Pointer to rule counters     */
 292         uint32_t        timestamp;      /* tv_sec of last match         */
 293         uint32_t        id;             /* rule id                      */
 294         uint32_t        cached_id;      /* used by jump_fast            */
 295         uint32_t        cached_pos;     /* used by jump_fast            */
 296         uint32_t        refcnt;         /* number of references         */
 297
 298         struct ip_fw    *next;          /* linked list of deleted rules */
 299         ipfw_insn       cmd[1];         /* storage for commands         */
 300 };
 301
 302 #define IPFW_RULE_CNTR_SIZE     (2 * sizeof(uint64_t))
 303
 304 #endif
 305
 306 struct ip_fw_chain {
 307         struct ip_fw    **map;          /* array of rule ptrs to ease lookup */
 308         uint32_t        id;             /* ruleset id */
 309         int             n_rules;        /* number of static rules */
 310         void            *tablestate;    /* runtime table info */
 311         void            *valuestate;    /* runtime table value info */
 312         int             *idxmap;        /* skipto array of rules */
 313         void            **srvstate;     /* runtime service mappings */
 314 #if defined( __linux__ ) || defined( _WIN32 )
 315         spinlock_t rwmtx;
 316 #else
 317         struct rmlock   rwmtx;
 318 #endif
 319         int             static_len;     /* total len of static rules (v0) */
 320         uint32_t        gencnt;         /* NAT generation count */
 321         LIST_HEAD(nat_list, cfg_nat) nat;       /* list of nat entries */
 322         struct ip_fw    *default_rule;
 323         struct tables_config *tblcfg;   /* tables module data */
 324         void            *ifcfg;         /* interface module data */
 325         int             *idxmap_back;   /* standby skipto array of rules */
 326         struct namedobj_instance        *srvmap; /* cfg name->number mappings */
 327 #if defined( __linux__ ) || defined( _WIN32 )
 328         spinlock_t uh_lock;
 329 #else
 330         struct rwlock   uh_lock;        /* lock for upper half */
 331 #endif
 332 };
 333
 334 /* 64-byte structure representing multi-field table value */
 335 struct table_value {
 336         uint32_t        tag;            /* O_TAG/O_TAGGED */
 337         uint32_t        pipe;           /* O_PIPE/O_QUEUE */
 338         uint16_t        divert;         /* O_DIVERT/O_TEE */
 339         uint16_t        skipto;         /* skipto, CALLRET */
 340         uint32_t        netgraph;       /* O_NETGRAPH/O_NGTEE */
 341         uint32_t        fib;            /* O_SETFIB */
 342         uint32_t        nat;            /* O_NAT */
 343         uint32_t        nh4;
 344         uint8_t         dscp;
 345         uint8_t         spare0;
 346         uint16_t        spare1;
 347         /* -- 32 bytes -- */
 348         struct in6_addr nh6;
 349         uint32_t        limit;          /* O_LIMIT */
 350         uint32_t        zoneid;         /* scope zone id for nh6 */
 351         uint64_t        refcnt;         /* Number of references */
 352 };
 353
 354
 355 struct named_object {
 356         TAILQ_ENTRY(named_object)       nn_next;        /* namehash */
 357         TAILQ_ENTRY(named_object)       nv_next;        /* valuehash */
 358         char                    *name;  /* object name */
 359         uint16_t                etlv;   /* Export TLV id */
 360         uint8_t                 subtype;/* object subtype within class */
 361         uint8_t                 set;    /* set object belongs to */
 362         uint16_t                kidx;   /* object kernel index */
 363         uint16_t                spare;
 364         uint32_t                ocnt;   /* object counter for internal use */
 365         uint32_t                refcnt; /* number of references */
 366 };
 367 TAILQ_HEAD(namedobjects_head, named_object);
 368
 369 struct sockopt; /* used by tcp_var.h */
 370 struct sockopt_data {
 371         caddr_t         kbuf;           /* allocated buffer */
 372         size_t          ksize;          /* given buffer size */
 373         size_t          koff;           /* data already used */
 374         size_t          kavail;         /* number of bytes available */
 375         size_t          ktotal;         /* total bytes pushed */
 376         struct sockopt  *sopt;          /* socket data */
 377         caddr_t         sopt_val;       /* sopt user buffer */
 378         size_t          valsize;        /* original data size */
 379 };
 380
 381 struct ipfw_ifc;
 382
 383 typedef void (ipfw_ifc_cb)(struct ip_fw_chain *ch, void *cbdata,
 384     uint16_t ifindex);
 385
 386 struct ipfw_iface {
 387         struct named_object     no;
 388         char ifname[64];
 389         int resolved;
 390         uint16_t ifindex;
 391         uint16_t spare;
 392         uint64_t gencnt;
 393         TAILQ_HEAD(, ipfw_ifc)  consumers;
 394 };
 395
 396 struct ipfw_ifc {
 397         TAILQ_ENTRY(ipfw_ifc)   next;
 398         struct ipfw_iface       *iface;
 399         ipfw_ifc_cb             *cb;
 400         void                    *cbdata;
 401 };
 402
 403 /* Macro for working with various counters */
 404 #define IPFW_INC_RULE_COUNTER(_cntr, _bytes)    do {    \
 405         counter_u64_add((_cntr)->cntr, 1);              \
 406         counter_u64_add((_cntr)->cntr + 1, _bytes);     \
 407         if ((_cntr)->timestamp != time_uptime)          \
 408                 (_cntr)->timestamp = time_uptime;       \
 409         } while (0)
 410
 411 #define IPFW_INC_DYN_COUNTER(_cntr, _bytes)     do {            \
 412         (_cntr)->pcnt++;                                \
 413         (_cntr)->bcnt += _bytes;                        \
 414         } while (0)
 415
 416 #define IPFW_ZERO_RULE_COUNTER(_cntr) do {              \
 417         counter_u64_zero((_cntr)->cntr);                \
 418         counter_u64_zero((_cntr)->cntr + 1);            \
 419         (_cntr)->timestamp = 0;                         \
 420         } while (0)
 421
 422 #define IPFW_ZERO_DYN_COUNTER(_cntr) do {               \
 423         (_cntr)->pcnt = 0;                              \
 424         (_cntr)->bcnt = 0;                              \
 425         } while (0)
 426
 427 #define TARG_VAL(ch, k, f)      ((struct table_value *)((ch)->valuestate))[k].f
 428 #define IP_FW_ARG_TABLEARG(ch, a, f)    \
 429         (((a) == IP_FW_TARG) ? TARG_VAL(ch, tablearg, f) : (a))
 430 /*
 431  * The lock is heavily used by ip_fw2.c (the main file) and ip_fw_nat.c
 432  * so the variable and the macros must be here.
 433  */
 434
 435 #if defined( __linux__ ) || defined( _WIN32 )
 436 #define IPFW_LOCK_INIT(_chain) do {                     \
 437         rw_init(&(_chain)->rwmtx, "IPFW static rules"); \
 438         rw_init(&(_chain)->uh_lock, "IPFW UH lock");    \
 439         } while (0)
 440
 441 #define IPFW_LOCK_DESTROY(_chain) do {                  \
 442         rw_destroy(&(_chain)->rwmtx);                   \
 443         rw_destroy(&(_chain)->uh_lock);                 \
 444         } while (0)
 445
 446 #define IPFW_RLOCK_ASSERT(_chain)       rw_assert(&(_chain)->rwmtx, RA_RLOCKED)
 447 #define IPFW_WLOCK_ASSERT(_chain)       rw_assert(&(_chain)->rwmtx, RA_WLOCKED)
 448
 449 #define IPFW_RLOCK_TRACKER
 450 #define IPFW_RLOCK(p)                   rw_rlock(&(p)->rwmtx)
 451 #define IPFW_RUNLOCK(p)                 rw_runlock(&(p)->rwmtx)
 452 #define IPFW_WLOCK(p)                   rw_wlock(&(p)->rwmtx)
 453 #define IPFW_WUNLOCK(p)                 rw_wunlock(&(p)->rwmtx)
 454 #define IPFW_PF_RLOCK(p)                IPFW_RLOCK(p)
 455 #define IPFW_PF_RUNLOCK(p)              IPFW_RUNLOCK(p)
 456 #else /* FreeBSD */
 457 #define IPFW_LOCK_INIT(_chain) do {                     \
 458         rm_init_flags(&(_chain)->rwmtx, "IPFW static rules", RM_RECURSE); \
 459         rw_init(&(_chain)->uh_lock, "IPFW UH lock");    \
 460         } while (0)
 461
 462 #define IPFW_LOCK_DESTROY(_chain) do {                  \
 463         rm_destroy(&(_chain)->rwmtx);                   \
 464         rw_destroy(&(_chain)->uh_lock);                 \
 465         } while (0)
 466
 467 #define IPFW_RLOCK_ASSERT(_chain)       rm_assert(&(_chain)->rwmtx, RA_RLOCKED)
 468 #define IPFW_WLOCK_ASSERT(_chain)       rm_assert(&(_chain)->rwmtx, RA_WLOCKED)
 469
 470 #define IPFW_RLOCK_TRACKER              struct rm_priotracker _tracker
 471 #define IPFW_RLOCK(p)                   rm_rlock(&(p)->rwmtx, &_tracker)
 472 #define IPFW_RUNLOCK(p)                 rm_runlock(&(p)->rwmtx, &_tracker)
 473 #define IPFW_WLOCK(p)                   rm_wlock(&(p)->rwmtx)
 474 #define IPFW_WUNLOCK(p)                 rm_wunlock(&(p)->rwmtx)
 475 #define IPFW_PF_RLOCK(p)                IPFW_RLOCK(p)
 476 #define IPFW_PF_RUNLOCK(p)              IPFW_RUNLOCK(p)
 477 #endif
 478
 479 #define IPFW_UH_RLOCK_ASSERT(_chain)    rw_assert(&(_chain)->uh_lock, RA_RLOCKED)
 480 #define IPFW_UH_WLOCK_ASSERT(_chain)    rw_assert(&(_chain)->uh_lock, RA_WLOCKED)
 481 #define IPFW_UH_UNLOCK_ASSERT(_chain)   rw_assert(&(_chain)->uh_lock, RA_UNLOCKED)
 482
 483 #define IPFW_UH_RLOCK(p) rw_rlock(&(p)->uh_lock)
 484 #define IPFW_UH_RUNLOCK(p) rw_runlock(&(p)->uh_lock)
 485 #define IPFW_UH_WLOCK(p) rw_wlock(&(p)->uh_lock)
 486 #define IPFW_UH_WUNLOCK(p) rw_wunlock(&(p)->uh_lock)
 487
 488 struct obj_idx {
 489         uint16_t        uidx;   /* internal index supplied by userland */
 490         uint16_t        kidx;   /* kernel object index */
 491         uint16_t        off;    /* tlv offset from rule end in 4-byte words */
 492         uint8_t         spare;
 493         uint8_t         type;   /* object type within its category */
 494 };
 495
 496 struct rule_check_info {
 497         uint16_t        flags;          /* rule-specific check flags */
 498         uint16_t        object_opcodes; /* num of opcodes referencing objects */
 499         uint16_t        urule_numoff;   /* offset of rulenum in bytes */
 500         uint8_t         version;        /* rule version */
 501         uint8_t         spare;
 502         ipfw_obj_ctlv   *ctlv;          /* name TLV containter */
 503         struct ip_fw    *krule;         /* resulting rule pointer */
 504         caddr_t         urule;          /* original rule pointer */
 505         struct obj_idx  obuf[8];        /* table references storage */
 506 };
 507
 508 /* Legacy interface support */
 509 /*
 510  * FreeBSD 8 export rule format
 511  */
 512 struct ip_fw_rule0 {
 513         struct ip_fw    *x_next;        /* linked list of rules         */
 514         struct ip_fw    *next_rule;     /* ptr to next [skipto] rule    */
 515         /* 'next_rule' is used to pass up 'set_disable' status          */
 516
 517         uint16_t        act_ofs;        /* offset of action in 32-bit units */
 518         uint16_t        cmd_len;        /* # of 32-bit words in cmd     */
 519         uint16_t        rulenum;        /* rule number                  */
 520         uint8_t         set;            /* rule set (0..31)             */
 521         uint8_t         _pad;           /* padding                      */
 522         uint32_t        id;             /* rule id */
 523
 524         /* These fields are present in all rules.                       */
 525         uint64_t        pcnt;           /* Packet counter               */
 526         uint64_t        bcnt;           /* Byte counter                 */
 527         uint32_t        timestamp;      /* tv_sec of last match         */
 528
 529         ipfw_insn       cmd[1];         /* storage for commands         */
 530 };
 531
 532 struct ip_fw_bcounter0 {
 533         uint64_t        pcnt;           /* Packet counter               */
 534         uint64_t        bcnt;           /* Byte counter                 */
 535         uint32_t        timestamp;      /* tv_sec of last match         */
 536 };
 537
 538 /* Kernel rule length */
 539 /*
 540  * RULE _K_ SIZE _V_ ->
 541  * get kernel size from userland rool version _V_.
 542  * RULE _U_ SIZE _V_ ->
 543  * get user size version _V_ from kernel rule
 544  * RULESIZE _V_ ->
 545  * get user size rule length
 546  */
 547 /* FreeBSD8 <> current kernel format */
 548 #define RULEUSIZE0(r)   (sizeof(struct ip_fw_rule0) + (r)->cmd_len * 4 - 4)
 549 #define RULEKSIZE0(r)   roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8)
 550 /* FreeBSD11 <> current kernel format */
 551 #define RULEUSIZE1(r)   (roundup2(sizeof(struct ip_fw_rule) + \
 552     (r)->cmd_len * 4 - 4, 8))
 553 #define RULEKSIZE1(r)   roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8)
 554
 555 /*
 556  * Tables/Objects index rewriting code
 557  */
 558
 559 /* Default and maximum number of ipfw tables/objects. */
 560 #define IPFW_TABLES_MAX         65536
 561 #define IPFW_TABLES_DEFAULT     128
 562 #define IPFW_OBJECTS_MAX        65536
 563 #define IPFW_OBJECTS_DEFAULT    1024
 564
 565 #define CHAIN_TO_SRV(ch)        ((ch)->srvmap)
 566 #define SRV_OBJECT(ch, idx)     ((ch)->srvstate[(idx)])
 567
 568 struct tid_info {
 569         uint32_t        set;    /* table set */
 570         uint16_t        uidx;   /* table index */
 571         uint8_t         type;   /* table type */
 572         uint8_t         atype;
 573         uint8_t         spare;
 574         int             tlen;   /* Total TLV size block */
 575         void            *tlvs;  /* Pointer to first TLV */
 576 };
 577
 578 /*
 579  * Classifier callback. Checks if @cmd opcode contains kernel object reference.
 580  * If true, returns its index and type.
 581  * Returns 0 if match is found, 1 overwise.
 582  */
 583 typedef int (ipfw_obj_rw_cl)(ipfw_insn *cmd, uint16_t *puidx, uint8_t *ptype);
 584 /*
 585  * Updater callback. Sets kernel object reference index to @puidx
 586  */
 587 typedef void (ipfw_obj_rw_upd)(ipfw_insn *cmd, uint16_t puidx);
 588 /*
 589  * Finder callback. Tries to find named object by name (specified via @ti).
 590  * Stores found named object pointer in @pno.
 591  * If object was not found, NULL is stored.
 592  *
 593  * Return 0 if input data was valid.
 594  */
 595 typedef int (ipfw_obj_fname_cb)(struct ip_fw_chain *ch,
 596     struct tid_info *ti, struct named_object **pno);
 597 /*
 598  * Another finder callback. Tries to findex named object by kernel index.
 599  *
 600  * Returns pointer to named object or NULL.
 601  */
 602 typedef struct named_object *(ipfw_obj_fidx_cb)(struct ip_fw_chain *ch,
 603     uint16_t kidx);
 604 /*
 605  * Object creator callback. Tries to create object specified by @ti.
 606  * Stores newly-allocated object index in @pkidx.
 607  *
 608  * Returns 0 on success.
 609  */
 610 typedef int (ipfw_obj_create_cb)(struct ip_fw_chain *ch, struct tid_info *ti,
 611     uint16_t *pkidx);
 612 /*
 613  * Object destroy callback. Intended to free resources allocated by
 614  * create_object callback.
 615  */
 616 typedef void (ipfw_obj_destroy_cb)(struct ip_fw_chain *ch,
 617     struct named_object *no);
 618 /*
 619  * Sets handler callback. Handles moving and swaping set of named object.
 620  *  SWAP_ALL moves all named objects from set `set' to `new_set' and vise versa;
 621  *  TEST_ALL checks that there aren't any named object with conflicting names;
 622  *  MOVE_ALL moves all named objects from set `set' to `new_set';
 623  *  COUNT_ONE used to count number of references used by object with kidx `set';
 624  *  TEST_ONE checks that named object with kidx `set' can be moved to `new_set`;
 625  *  MOVE_ONE moves named object with kidx `set' to set `new_set'.
 626  */
 627 enum ipfw_sets_cmd {
 628         SWAP_ALL = 0, TEST_ALL, MOVE_ALL, COUNT_ONE, TEST_ONE, MOVE_ONE
 629 };
 630 typedef int (ipfw_obj_sets_cb)(struct ip_fw_chain *ch,
 631     uint16_t set, uint8_t new_set, enum ipfw_sets_cmd cmd);
 632
 633
 634 struct opcode_obj_rewrite {
 635         uint32_t                opcode;         /* Opcode to act upon */
 636         uint32_t                etlv;           /* Relevant export TLV id  */
 637         ipfw_obj_rw_cl          *classifier;    /* Check if rewrite is needed */
 638         ipfw_obj_rw_upd         *update;        /* update cmd with new value */
 639         ipfw_obj_fname_cb       *find_byname;   /* Find named object by name */
 640         ipfw_obj_fidx_cb        *find_bykidx;   /* Find named object by kidx */
 641         ipfw_obj_create_cb      *create_object; /* Create named object */
 642         ipfw_obj_destroy_cb     *destroy_object;/* Destroy named object */
 643         ipfw_obj_sets_cb        *manage_sets;   /* Swap or move sets */
 644 };
 645
 646 #define IPFW_ADD_OBJ_REWRITER(f, c)     do {    \
 647         if ((f) != 0)                           \
 648                 ipfw_add_obj_rewriter(c,        \
 649                     sizeof(c) / sizeof(c[0]));  \
 650         } while(0)
 651 #define IPFW_DEL_OBJ_REWRITER(l, c)     do {    \
 652         if ((l) != 0)                           \
 653                 ipfw_del_obj_rewriter(c,        \
 654                     sizeof(c) / sizeof(c[0]));  \
 655         } while(0)
 656
 657 /* In ip_fw_iface.c */
 658 int ipfw_iface_init(void);
 659 void ipfw_iface_destroy(void);
 660 void vnet_ipfw_iface_destroy(struct ip_fw_chain *ch);
 661 int ipfw_iface_ref(struct ip_fw_chain *ch, char *name,
 662     struct ipfw_ifc *ic);
 663 void ipfw_iface_unref(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
 664 void ipfw_iface_add_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
 665 void ipfw_iface_del_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
 666
 667 /* In ip_fw_sockopt.c */
 668 void ipfw_init_skipto_cache(struct ip_fw_chain *chain);
 669 void ipfw_destroy_skipto_cache(struct ip_fw_chain *chain);
 670 int ipfw_find_rule(struct ip_fw_chain *chain, uint32_t key, uint32_t id);
 671 int ipfw_ctl3(struct sockopt *sopt);
 672 int ipfw_add_protected_rule(struct ip_fw_chain *chain, struct ip_fw *rule,
 673     int locked);
 674 void ipfw_reap_add(struct ip_fw_chain *chain, struct ip_fw **head,
 675     struct ip_fw *rule);
 676 void ipfw_reap_rules(struct ip_fw *head);
 677 void ipfw_init_counters(void);
 678 void ipfw_destroy_counters(void);
 679 struct ip_fw *ipfw_alloc_rule(struct ip_fw_chain *chain, size_t rulesize);
 680 void ipfw_free_rule(struct ip_fw *rule);
 681 int ipfw_match_range(struct ip_fw *rule, ipfw_range_tlv *rt);
 682 int ipfw_mark_object_kidx(uint32_t *bmask, uint16_t etlv, uint16_t kidx);
 683
 684 typedef int (sopt_handler_f)(struct ip_fw_chain *ch,
 685     ip_fw3_opheader *op3, struct sockopt_data *sd);
 686 struct ipfw_sopt_handler {
 687         uint16_t        opcode;
 688         uint8_t         version;
 689         uint8_t         dir;
 690         sopt_handler_f  *handler;
 691         uint64_t        refcnt;
 692 };
 693 #define HDIR_SET        0x01    /* Handler is used to set some data */
 694 #define HDIR_GET        0x02    /* Handler is used to retrieve data */
 695 #define HDIR_BOTH       HDIR_GET|HDIR_SET
 696
 697 void ipfw_init_sopt_handler(void);
 698 void ipfw_destroy_sopt_handler(void);
 699 void ipfw_add_sopt_handler(struct ipfw_sopt_handler *sh, size_t count);
 700 int ipfw_del_sopt_handler(struct ipfw_sopt_handler *sh, size_t count);
 701 caddr_t ipfw_get_sopt_space(struct sockopt_data *sd, size_t needed);
 702 caddr_t ipfw_get_sopt_header(struct sockopt_data *sd, size_t needed);
 703 #define IPFW_ADD_SOPT_HANDLER(f, c)     do {    \
 704         if ((f) != 0)                           \
 705                 ipfw_add_sopt_handler(c,        \
 706                     sizeof(c) / sizeof(c[0]));  \
 707         } while(0)
 708 #define IPFW_DEL_SOPT_HANDLER(l, c)     do {    \
 709         if ((l) != 0)                           \
 710                 ipfw_del_sopt_handler(c,        \
 711                     sizeof(c) / sizeof(c[0]));  \
 712         } while(0)
 713
 714 struct namedobj_instance;
 715 typedef int (objhash_cb_t)(struct namedobj_instance *ni, struct named_object *,
 716     void *arg);
 717 typedef uint32_t (objhash_hash_f)(struct namedobj_instance *ni, const void *key,
 718     uint32_t kopt);
 719 typedef int (objhash_cmp_f)(struct named_object *no, const void *key,
 720     uint32_t kopt);
 721 struct namedobj_instance *ipfw_objhash_create(uint32_t items);
 722 void ipfw_objhash_destroy(struct namedobj_instance *);
 723 void ipfw_objhash_bitmap_alloc(uint32_t items, void **idx, int *pblocks);
 724 void ipfw_objhash_bitmap_merge(struct namedobj_instance *ni,
 725     void **idx, int *blocks);
 726 void ipfw_objhash_bitmap_swap(struct namedobj_instance *ni,
 727     void **idx, int *blocks);
 728 void ipfw_objhash_bitmap_free(void *idx, int blocks);
 729 void ipfw_objhash_set_hashf(struct namedobj_instance *ni, objhash_hash_f *f);
 730 struct named_object *ipfw_objhash_lookup_name(struct namedobj_instance *ni,
 731     uint32_t set, char *name);
 732 struct named_object *ipfw_objhash_lookup_name_type(struct namedobj_instance *ni,
 733     uint32_t set, uint32_t type, const char *name);
 734 struct named_object *ipfw_objhash_lookup_kidx(struct namedobj_instance *ni,
 735     uint16_t idx);
 736 int ipfw_objhash_same_name(struct namedobj_instance *ni, struct named_object *a,
 737     struct named_object *b);
 738 void ipfw_objhash_add(struct namedobj_instance *ni, struct named_object *no);
 739 void ipfw_objhash_del(struct namedobj_instance *ni, struct named_object *no);
 740 uint32_t ipfw_objhash_count(struct namedobj_instance *ni);
 741 uint32_t ipfw_objhash_count_type(struct namedobj_instance *ni, uint16_t type);
 742 int ipfw_objhash_foreach(struct namedobj_instance *ni, objhash_cb_t *f,
 743     void *arg);
 744 int ipfw_objhash_foreach_type(struct namedobj_instance *ni, objhash_cb_t *f,
 745     void *arg, uint16_t type);
 746 int ipfw_objhash_free_idx(struct namedobj_instance *ni, uint16_t idx);
 747 int ipfw_objhash_alloc_idx(void *n, uint16_t *pidx);
 748 void ipfw_objhash_set_funcs(struct namedobj_instance *ni,
 749     objhash_hash_f *hash_f, objhash_cmp_f *cmp_f);
 750 int ipfw_objhash_find_type(struct namedobj_instance *ni, struct tid_info *ti,
 751     uint32_t etlv, struct named_object **pno);
 752 void ipfw_export_obj_ntlv(struct named_object *no, ipfw_obj_ntlv *ntlv);
 753 ipfw_obj_ntlv *ipfw_find_name_tlv_type(void *tlvs, int len, uint16_t uidx,
 754     uint32_t etlv);
 755 void ipfw_init_obj_rewriter(void);
 756 void ipfw_destroy_obj_rewriter(void);
 757 void ipfw_add_obj_rewriter(struct opcode_obj_rewrite *rw, size_t count);
 758 int ipfw_del_obj_rewriter(struct opcode_obj_rewrite *rw, size_t count);
 759
 760 int create_objects_compat(struct ip_fw_chain *ch, ipfw_insn *cmd,
 761     struct obj_idx *oib, struct obj_idx *pidx, struct tid_info *ti);
 762 void update_opcode_kidx(ipfw_insn *cmd, uint16_t idx);
 763 int classify_opcode_kidx(ipfw_insn *cmd, uint16_t *puidx);
 764 void ipfw_init_srv(struct ip_fw_chain *ch);
 765 void ipfw_destroy_srv(struct ip_fw_chain *ch);
 766 int ipfw_check_object_name_generic(const char *name);
 767 int ipfw_obj_manage_sets(struct namedobj_instance *ni, uint16_t type,
 768     uint16_t set, uint8_t new_set, enum ipfw_sets_cmd cmd);
 769
 770 /* In ip_fw_eaction.c */
 771 typedef int (ipfw_eaction_t)(struct ip_fw_chain *ch, struct ip_fw_args *args,
 772     ipfw_insn *cmd, int *done);
 773 int ipfw_eaction_init(struct ip_fw_chain *ch, int first);
 774 void ipfw_eaction_uninit(struct ip_fw_chain *ch, int last);
 775
 776 uint16_t ipfw_add_eaction(struct ip_fw_chain *ch, ipfw_eaction_t handler,
 777     const char *name);
 778 int ipfw_del_eaction(struct ip_fw_chain *ch, uint16_t eaction_id);
 779 int ipfw_run_eaction(struct ip_fw_chain *ch, struct ip_fw_args *args,
 780     ipfw_insn *cmd, int *done);
 781 int ipfw_reset_eaction(struct ip_fw_chain *ch, struct ip_fw *rule,
 782     uint16_t eaction_id, uint16_t default_id, uint16_t instance_id);
 783 int ipfw_reset_eaction_instance(struct ip_fw_chain *ch, uint16_t eaction_id,
 784     uint16_t instance_id);
 785
 786 /* In ip_fw_table.c */
 787 struct table_info;
 788
 789 typedef int (table_lookup_t)(struct table_info *ti, void *key, uint32_t keylen,
 790     uint32_t *val);
 791
 792 int ipfw_lookup_table(struct ip_fw_chain *ch, uint16_t tbl, uint16_t plen,
 793     void *paddr, uint32_t *val);
 794 struct named_object *ipfw_objhash_lookup_table_kidx(struct ip_fw_chain *ch,
 795     uint16_t kidx);
 796 int ipfw_ref_table(struct ip_fw_chain *ch, ipfw_obj_ntlv *ntlv, uint16_t *kidx);
 797 void ipfw_unref_table(struct ip_fw_chain *ch, uint16_t kidx);
 798 int ipfw_init_tables(struct ip_fw_chain *ch, int first);
 799 int ipfw_resize_tables(struct ip_fw_chain *ch, unsigned int ntables);
 800 int ipfw_switch_tables_namespace(struct ip_fw_chain *ch, unsigned int nsets);
 801 void ipfw_destroy_tables(struct ip_fw_chain *ch, int last);
 802
 803 /* In ip_fw_nat.c -- XXX to be moved to ip_var.h */
 804
 805 extern struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int);
 806
 807 typedef int ipfw_nat_t(struct ip_fw_args *, struct cfg_nat *, struct mbuf *);
 808 typedef int ipfw_nat_cfg_t(struct sockopt *);
 809
 810 VNET_DECLARE(int, ipfw_nat_ready);
 811 #define V_ipfw_nat_ready        VNET(ipfw_nat_ready)
 812 #define IPFW_NAT_LOADED (V_ipfw_nat_ready)
 813
 814 extern ipfw_nat_t *ipfw_nat_ptr;
 815 extern ipfw_nat_cfg_t *ipfw_nat_cfg_ptr;
 816 extern ipfw_nat_cfg_t *ipfw_nat_del_ptr;
 817 extern ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr;
 818 extern ipfw_nat_cfg_t *ipfw_nat_get_log_ptr;
 819
 820 /* Helper functions for IP checksum adjustment */
 821 static __inline uint16_t
 822 cksum_add(uint16_t sum, uint16_t a)
 823 {
 824         uint16_t res;
 825
 826         res = sum + a;
 827         return (res + (res < a));
 828 }
 829
 830 static __inline uint16_t
 831 cksum_adjust(uint16_t oldsum, uint16_t old, uint16_t new)
 832 {
 833
 834         return (~cksum_add(cksum_add(~oldsum, ~old), new));
 835 }
 836
 837 #endif /* _KERNEL */
 838 #endif /* _IPFW2_PRIVATE_H */