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