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