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