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