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