2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
30 #ifndef _IPFW2_PRIVATE_H
31 #define _IPFW2_PRIVATE_H
34 * Internal constants and data structures used by ipfw components
35 * and not meant to be exported outside the kernel.
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.
53 /* Return values from ipfw_chk() */
68 * Structure for collecting parameters to dummynet for ip6_output forwarding
71 struct ip6_pktopts *opt_or;
73 struct ip6_moptions *im6o_or;
74 struct ifnet *origifp_or;
76 struct sockaddr_in6 dst_or;
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.
87 #define IPFW_ARGS_ETHER 0x00010000 /* valid ethernet header */
88 #define IPFW_ARGS_NH4 0x00020000 /* IPv4 next hop in hopstore */
89 #define IPFW_ARGS_NH6 0x00040000 /* IPv6 next hop in hopstore */
90 #define IPFW_ARGS_NH4PTR 0x00080000 /* IPv4 next hop in next_hop */
91 #define IPFW_ARGS_NH6PTR 0x00100000 /* IPv6 next hop in next_hop6 */
92 #define IPFW_ARGS_REF 0x00200000 /* valid ipfw_rule_ref */
93 #define IPFW_ARGS_IN 0x00400000 /* called on input */
94 #define IPFW_ARGS_OUT 0x00800000 /* called on output */
95 #define IPFW_ARGS_IP4 0x01000000 /* belongs to v4 ISR */
96 #define IPFW_ARGS_IP6 0x02000000 /* belongs to v6 ISR */
97 #define IPFW_ARGS_DROP 0x04000000 /* drop it (dummynet) */
98 #define IPFW_ARGS_LENMASK 0x0000ffff /* length of data in *mem */
99 #define IPFW_ARGS_LENGTH(f) ((f) & IPFW_ARGS_LENMASK)
101 * On return, it points to the matching rule.
102 * On entry, rule.slot > 0 means the info is valid and
103 * contains the starting rule for an ipfw search.
104 * If chain_id == chain->id && slot >0 then jump to that slot.
105 * Otherwise, we locate the first rule >= rulenum:rule_id
107 struct ipfw_rule_ref rule; /* match/restart info */
109 struct ifnet *ifp; /* input/output interface */
113 * next_hop[6] pointers can be used to point to next hop
114 * stored in rule's opcode to avoid copying into hopstore.
115 * Also, it is expected that all 0x1-0x10 flags are mutually
118 struct sockaddr_in *next_hop;
119 struct sockaddr_in6 *next_hop6;
120 /* ipfw next hop storage */
121 struct sockaddr_in hopstore;
123 struct in6_addr sin6_addr;
124 uint32_t sin6_scope_id;
129 struct mbuf *m; /* the mbuf chain */
130 void *mem; /* or memory pointer */
132 struct ipfw_flow_id f_id; /* grabbed from IP header */
135 MALLOC_DECLARE(M_IPFW);
137 /* wrapper for freeing a packet, in case we need to do more work */
139 #if defined(__linux__) || defined(_WIN32)
140 #define FREE_PKT(m) netisr_dispatch(-1, m)
142 #define FREE_PKT(m) m_freem(m)
144 #endif /* !FREE_PKT */
147 * Function definitions.
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);
153 int ipfw_attach_hooks(void);
154 void ipfw_detach_hooks(void);
156 void ipfw_nat_destroy(void);
163 void ipfw_bpf_init(int);
164 void ipfw_bpf_uninit(int);
165 void ipfw_bpf_tap(u_char *, u_int);
166 void ipfw_bpf_mtap(struct mbuf *);
167 void ipfw_bpf_mtap2(void *, u_int, struct mbuf *);
168 void ipfw_log(struct ip_fw_chain *chain, struct ip_fw *f, u_int hlen,
169 struct ip_fw_args *args, u_short offset, uint32_t tablearg, struct ip *ip);
170 VNET_DECLARE(u_int64_t, norule_counter);
171 #define V_norule_counter VNET(norule_counter)
172 VNET_DECLARE(int, verbose_limit);
173 #define V_verbose_limit VNET(verbose_limit)
175 /* In ip_fw_dynamic.c */
178 enum { /* result for matching dynamic rules */
186 * Macro to determine that we need to do or redo dynamic state lookup.
187 * direction == MATCH_UNKNOWN means that this is first lookup, then we need
189 * Otherwise check the state name, if previous lookup was for "any" name,
190 * this means there is no state with specific name. Thus no need to do
191 * lookup. If previous name was not "any", redo lookup for specific name.
193 #define DYN_LOOKUP_NEEDED(p, cmd) \
194 ((p)->direction == MATCH_UNKNOWN || \
195 ((p)->kidx != 0 && (p)->kidx != (cmd)->arg1))
196 #define DYN_INFO_INIT(p) do { \
197 (p)->direction = MATCH_UNKNOWN; \
200 struct ipfw_dyn_info {
201 uint16_t direction; /* match direction */
202 uint16_t kidx; /* state name kidx */
203 uint32_t hashval; /* hash value */
204 uint32_t version; /* bucket version */
207 int ipfw_dyn_install_state(struct ip_fw_chain *chain, struct ip_fw *rule,
208 const ipfw_insn_limit *cmd, const struct ip_fw_args *args,
209 const void *ulp, int pktlen, struct ipfw_dyn_info *info,
211 struct ip_fw *ipfw_dyn_lookup_state(const struct ip_fw_args *args,
212 const void *ulp, int pktlen, const ipfw_insn *cmd,
213 struct ipfw_dyn_info *info);
215 int ipfw_is_dyn_rule(struct ip_fw *rule);
216 void ipfw_expire_dyn_states(struct ip_fw_chain *, ipfw_range_tlv *);
217 void ipfw_get_dynamic(struct ip_fw_chain *chain, char **bp, const char *ep);
218 int ipfw_dump_states(struct ip_fw_chain *chain, struct sockopt_data *sd);
220 void ipfw_dyn_init(struct ip_fw_chain *); /* per-vnet initialization */
221 void ipfw_dyn_uninit(int); /* per-vnet deinitialization */
222 int ipfw_dyn_len(void);
223 uint32_t ipfw_dyn_get_count(uint32_t *, int *);
224 void ipfw_dyn_reset_eaction(struct ip_fw_chain *ch, uint16_t eaction_id,
225 uint16_t default_id, uint16_t instance_id);
227 /* common variables */
228 VNET_DECLARE(int, fw_one_pass);
229 #define V_fw_one_pass VNET(fw_one_pass)
231 VNET_DECLARE(int, fw_verbose);
232 #define V_fw_verbose VNET(fw_verbose)
234 VNET_DECLARE(struct ip_fw_chain, layer3_chain);
235 #define V_layer3_chain VNET(layer3_chain)
237 VNET_DECLARE(int, ipfw_vnet_ready);
238 #define V_ipfw_vnet_ready VNET(ipfw_vnet_ready)
240 VNET_DECLARE(u_int32_t, set_disable);
241 #define V_set_disable VNET(set_disable)
243 VNET_DECLARE(int, autoinc_step);
244 #define V_autoinc_step VNET(autoinc_step)
246 VNET_DECLARE(unsigned int, fw_tables_max);
247 #define V_fw_tables_max VNET(fw_tables_max)
249 VNET_DECLARE(unsigned int, fw_tables_sets);
250 #define V_fw_tables_sets VNET(fw_tables_sets)
252 struct tables_config;
256 * Here we have the structure representing an ipfw rule.
258 * It starts with a general area
259 * followed by an array of one or more instructions, which the code
260 * accesses as an array of 32-bit values.
262 * Given a rule pointer r:
264 * r->cmd is the start of the first instruction.
265 * ACTION_PTR(r) is the start of the first action (things to do
266 * once a rule matched).
270 uint16_t act_ofs; /* offset of action in 32-bit units */
271 uint16_t cmd_len; /* # of 32-bit words in cmd */
272 uint16_t rulenum; /* rule number */
273 uint8_t set; /* rule set (0..31) */
274 uint8_t flags; /* currently unused */
275 counter_u64_t cntr; /* Pointer to rule counters */
276 uint32_t timestamp; /* tv_sec of last match */
277 uint32_t id; /* rule id */
278 uint32_t cached_id; /* used by jump_fast */
279 uint32_t cached_pos; /* used by jump_fast */
280 uint32_t refcnt; /* number of references */
282 struct ip_fw *next; /* linked list of deleted rules */
283 ipfw_insn cmd[1]; /* storage for commands */
286 #define IPFW_RULE_CNTR_SIZE (2 * sizeof(uint64_t))
291 struct ip_fw **map; /* array of rule ptrs to ease lookup */
292 uint32_t id; /* ruleset id */
293 int n_rules; /* number of static rules */
294 void *tablestate; /* runtime table info */
295 void *valuestate; /* runtime table value info */
296 int *idxmap; /* skipto array of rules */
297 void **srvstate; /* runtime service mappings */
298 #if defined( __linux__ ) || defined( _WIN32 )
303 int static_len; /* total len of static rules (v0) */
304 uint32_t gencnt; /* NAT generation count */
305 LIST_HEAD(nat_list, cfg_nat) nat; /* list of nat entries */
306 struct ip_fw *default_rule;
307 struct tables_config *tblcfg; /* tables module data */
308 void *ifcfg; /* interface module data */
309 int *idxmap_back; /* standby skipto array of rules */
310 struct namedobj_instance *srvmap; /* cfg name->number mappings */
311 #if defined( __linux__ ) || defined( _WIN32 )
314 struct rwlock uh_lock; /* lock for upper half */
318 /* 64-byte structure representing multi-field table value */
320 uint32_t tag; /* O_TAG/O_TAGGED */
321 uint32_t pipe; /* O_PIPE/O_QUEUE */
322 uint16_t divert; /* O_DIVERT/O_TEE */
323 uint16_t skipto; /* skipto, CALLRET */
324 uint32_t netgraph; /* O_NETGRAPH/O_NGTEE */
325 uint32_t fib; /* O_SETFIB */
326 uint32_t nat; /* O_NAT */
333 uint32_t limit; /* O_LIMIT */
334 uint32_t zoneid; /* scope zone id for nh6 */
335 uint64_t refcnt; /* Number of references */
338 struct named_object {
339 TAILQ_ENTRY(named_object) nn_next; /* namehash */
340 TAILQ_ENTRY(named_object) nv_next; /* valuehash */
341 char *name; /* object name */
342 uint16_t etlv; /* Export TLV id */
343 uint8_t subtype;/* object subtype within class */
344 uint8_t set; /* set object belongs to */
345 uint16_t kidx; /* object kernel index */
347 uint32_t ocnt; /* object counter for internal use */
348 uint32_t refcnt; /* number of references */
350 TAILQ_HEAD(namedobjects_head, named_object);
352 struct sockopt; /* used by tcp_var.h */
353 struct sockopt_data {
354 caddr_t kbuf; /* allocated buffer */
355 size_t ksize; /* given buffer size */
356 size_t koff; /* data already used */
357 size_t kavail; /* number of bytes available */
358 size_t ktotal; /* total bytes pushed */
359 struct sockopt *sopt; /* socket data */
360 caddr_t sopt_val; /* sopt user buffer */
361 size_t valsize; /* original data size */
366 typedef void (ipfw_ifc_cb)(struct ip_fw_chain *ch, void *cbdata,
370 struct named_object no;
376 TAILQ_HEAD(, ipfw_ifc) consumers;
380 TAILQ_ENTRY(ipfw_ifc) next;
381 struct ipfw_iface *iface;
386 /* Macro for working with various counters */
387 #define IPFW_INC_RULE_COUNTER(_cntr, _bytes) do { \
388 counter_u64_add((_cntr)->cntr, 1); \
389 counter_u64_add((_cntr)->cntr + 1, _bytes); \
390 if ((_cntr)->timestamp != time_uptime) \
391 (_cntr)->timestamp = time_uptime; \
394 #define IPFW_INC_DYN_COUNTER(_cntr, _bytes) do { \
396 (_cntr)->bcnt += _bytes; \
399 #define IPFW_ZERO_RULE_COUNTER(_cntr) do { \
400 counter_u64_zero((_cntr)->cntr); \
401 counter_u64_zero((_cntr)->cntr + 1); \
402 (_cntr)->timestamp = 0; \
405 #define IPFW_ZERO_DYN_COUNTER(_cntr) do { \
410 #define TARG_VAL(ch, k, f) ((struct table_value *)((ch)->valuestate))[k].f
411 #define IP_FW_ARG_TABLEARG(ch, a, f) \
412 (((a) == IP_FW_TARG) ? TARG_VAL(ch, tablearg, f) : (a))
414 * The lock is heavily used by ip_fw2.c (the main file) and ip_fw_nat.c
415 * so the variable and the macros must be here.
418 #if defined( __linux__ ) || defined( _WIN32 )
419 #define IPFW_LOCK_INIT(_chain) do { \
420 rw_init(&(_chain)->rwmtx, "IPFW static rules"); \
421 rw_init(&(_chain)->uh_lock, "IPFW UH lock"); \
424 #define IPFW_LOCK_DESTROY(_chain) do { \
425 rw_destroy(&(_chain)->rwmtx); \
426 rw_destroy(&(_chain)->uh_lock); \
429 #define IPFW_RLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_RLOCKED)
430 #define IPFW_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_WLOCKED)
432 #define IPFW_RLOCK_TRACKER
433 #define IPFW_RLOCK(p) rw_rlock(&(p)->rwmtx)
434 #define IPFW_RUNLOCK(p) rw_runlock(&(p)->rwmtx)
435 #define IPFW_WLOCK(p) rw_wlock(&(p)->rwmtx)
436 #define IPFW_WUNLOCK(p) rw_wunlock(&(p)->rwmtx)
437 #define IPFW_PF_RLOCK(p) IPFW_RLOCK(p)
438 #define IPFW_PF_RUNLOCK(p) IPFW_RUNLOCK(p)
440 #define IPFW_LOCK_INIT(_chain) do { \
441 rm_init_flags(&(_chain)->rwmtx, "IPFW static rules", RM_RECURSE); \
442 rw_init(&(_chain)->uh_lock, "IPFW UH lock"); \
445 #define IPFW_LOCK_DESTROY(_chain) do { \
446 rm_destroy(&(_chain)->rwmtx); \
447 rw_destroy(&(_chain)->uh_lock); \
450 #define IPFW_RLOCK_ASSERT(_chain) rm_assert(&(_chain)->rwmtx, RA_RLOCKED)
451 #define IPFW_WLOCK_ASSERT(_chain) rm_assert(&(_chain)->rwmtx, RA_WLOCKED)
453 #define IPFW_RLOCK_TRACKER struct rm_priotracker _tracker
454 #define IPFW_RLOCK(p) rm_rlock(&(p)->rwmtx, &_tracker)
455 #define IPFW_RUNLOCK(p) rm_runlock(&(p)->rwmtx, &_tracker)
456 #define IPFW_WLOCK(p) rm_wlock(&(p)->rwmtx)
457 #define IPFW_WUNLOCK(p) rm_wunlock(&(p)->rwmtx)
458 #define IPFW_PF_RLOCK(p) IPFW_RLOCK(p)
459 #define IPFW_PF_RUNLOCK(p) IPFW_RUNLOCK(p)
462 #define IPFW_UH_RLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_RLOCKED)
463 #define IPFW_UH_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_WLOCKED)
464 #define IPFW_UH_UNLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_UNLOCKED)
466 #define IPFW_UH_RLOCK(p) rw_rlock(&(p)->uh_lock)
467 #define IPFW_UH_RUNLOCK(p) rw_runlock(&(p)->uh_lock)
468 #define IPFW_UH_WLOCK(p) rw_wlock(&(p)->uh_lock)
469 #define IPFW_UH_WUNLOCK(p) rw_wunlock(&(p)->uh_lock)
472 uint16_t uidx; /* internal index supplied by userland */
473 uint16_t kidx; /* kernel object index */
474 uint16_t off; /* tlv offset from rule end in 4-byte words */
476 uint8_t type; /* object type within its category */
479 struct rule_check_info {
480 uint16_t flags; /* rule-specific check flags */
481 uint16_t object_opcodes; /* num of opcodes referencing objects */
482 uint16_t urule_numoff; /* offset of rulenum in bytes */
483 uint8_t version; /* rule version */
485 ipfw_obj_ctlv *ctlv; /* name TLV containter */
486 struct ip_fw *krule; /* resulting rule pointer */
487 caddr_t urule; /* original rule pointer */
488 struct obj_idx obuf[8]; /* table references storage */
491 /* Legacy interface support */
493 * FreeBSD 8 export rule format
496 struct ip_fw *x_next; /* linked list of rules */
497 struct ip_fw *next_rule; /* ptr to next [skipto] rule */
498 /* 'next_rule' is used to pass up 'set_disable' status */
500 uint16_t act_ofs; /* offset of action in 32-bit units */
501 uint16_t cmd_len; /* # of 32-bit words in cmd */
502 uint16_t rulenum; /* rule number */
503 uint8_t set; /* rule set (0..31) */
504 uint8_t _pad; /* padding */
505 uint32_t id; /* rule id */
507 /* These fields are present in all rules. */
508 uint64_t pcnt; /* Packet counter */
509 uint64_t bcnt; /* Byte counter */
510 uint32_t timestamp; /* tv_sec of last match */
512 ipfw_insn cmd[1]; /* storage for commands */
515 struct ip_fw_bcounter0 {
516 uint64_t pcnt; /* Packet counter */
517 uint64_t bcnt; /* Byte counter */
518 uint32_t timestamp; /* tv_sec of last match */
521 /* Kernel rule length */
523 * RULE _K_ SIZE _V_ ->
524 * get kernel size from userland rool version _V_.
525 * RULE _U_ SIZE _V_ ->
526 * get user size version _V_ from kernel rule
528 * get user size rule length
530 /* FreeBSD8 <> current kernel format */
531 #define RULEUSIZE0(r) (sizeof(struct ip_fw_rule0) + (r)->cmd_len * 4 - 4)
532 #define RULEKSIZE0(r) roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8)
533 /* FreeBSD11 <> current kernel format */
534 #define RULEUSIZE1(r) (roundup2(sizeof(struct ip_fw_rule) + \
535 (r)->cmd_len * 4 - 4, 8))
536 #define RULEKSIZE1(r) roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8)
539 * Tables/Objects index rewriting code
542 /* Default and maximum number of ipfw tables/objects. */
543 #define IPFW_TABLES_MAX 65536
544 #define IPFW_TABLES_DEFAULT 128
545 #define IPFW_OBJECTS_MAX 65536
546 #define IPFW_OBJECTS_DEFAULT 1024
548 #define CHAIN_TO_SRV(ch) ((ch)->srvmap)
549 #define SRV_OBJECT(ch, idx) ((ch)->srvstate[(idx)])
552 uint32_t set; /* table set */
553 uint16_t uidx; /* table index */
554 uint8_t type; /* table type */
557 int tlen; /* Total TLV size block */
558 void *tlvs; /* Pointer to first TLV */
562 * Classifier callback. Checks if @cmd opcode contains kernel object reference.
563 * If true, returns its index and type.
564 * Returns 0 if match is found, 1 overwise.
566 typedef int (ipfw_obj_rw_cl)(ipfw_insn *cmd, uint16_t *puidx, uint8_t *ptype);
568 * Updater callback. Sets kernel object reference index to @puidx
570 typedef void (ipfw_obj_rw_upd)(ipfw_insn *cmd, uint16_t puidx);
572 * Finder callback. Tries to find named object by name (specified via @ti).
573 * Stores found named object pointer in @pno.
574 * If object was not found, NULL is stored.
576 * Return 0 if input data was valid.
578 typedef int (ipfw_obj_fname_cb)(struct ip_fw_chain *ch,
579 struct tid_info *ti, struct named_object **pno);
581 * Another finder callback. Tries to findex named object by kernel index.
583 * Returns pointer to named object or NULL.
585 typedef struct named_object *(ipfw_obj_fidx_cb)(struct ip_fw_chain *ch,
588 * Object creator callback. Tries to create object specified by @ti.
589 * Stores newly-allocated object index in @pkidx.
591 * Returns 0 on success.
593 typedef int (ipfw_obj_create_cb)(struct ip_fw_chain *ch, struct tid_info *ti,
596 * Object destroy callback. Intended to free resources allocated by
597 * create_object callback.
599 typedef void (ipfw_obj_destroy_cb)(struct ip_fw_chain *ch,
600 struct named_object *no);
602 * Sets handler callback. Handles moving and swaping set of named object.
603 * SWAP_ALL moves all named objects from set `set' to `new_set' and vise versa;
604 * TEST_ALL checks that there aren't any named object with conflicting names;
605 * MOVE_ALL moves all named objects from set `set' to `new_set';
606 * COUNT_ONE used to count number of references used by object with kidx `set';
607 * TEST_ONE checks that named object with kidx `set' can be moved to `new_set`;
608 * MOVE_ONE moves named object with kidx `set' to set `new_set'.
611 SWAP_ALL = 0, TEST_ALL, MOVE_ALL, COUNT_ONE, TEST_ONE, MOVE_ONE
613 typedef int (ipfw_obj_sets_cb)(struct ip_fw_chain *ch,
614 uint16_t set, uint8_t new_set, enum ipfw_sets_cmd cmd);
616 struct opcode_obj_rewrite {
617 uint32_t opcode; /* Opcode to act upon */
618 uint32_t etlv; /* Relevant export TLV id */
619 ipfw_obj_rw_cl *classifier; /* Check if rewrite is needed */
620 ipfw_obj_rw_upd *update; /* update cmd with new value */
621 ipfw_obj_fname_cb *find_byname; /* Find named object by name */
622 ipfw_obj_fidx_cb *find_bykidx; /* Find named object by kidx */
623 ipfw_obj_create_cb *create_object; /* Create named object */
624 ipfw_obj_destroy_cb *destroy_object;/* Destroy named object */
625 ipfw_obj_sets_cb *manage_sets; /* Swap or move sets */
628 #define IPFW_ADD_OBJ_REWRITER(f, c) do { \
630 ipfw_add_obj_rewriter(c, \
631 sizeof(c) / sizeof(c[0])); \
633 #define IPFW_DEL_OBJ_REWRITER(l, c) do { \
635 ipfw_del_obj_rewriter(c, \
636 sizeof(c) / sizeof(c[0])); \
639 /* In ip_fw_iface.c */
640 int ipfw_iface_init(void);
641 void ipfw_iface_destroy(void);
642 void vnet_ipfw_iface_destroy(struct ip_fw_chain *ch);
643 int ipfw_iface_ref(struct ip_fw_chain *ch, char *name,
644 struct ipfw_ifc *ic);
645 void ipfw_iface_unref(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
646 void ipfw_iface_add_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
647 void ipfw_iface_del_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic);
649 /* In ip_fw_sockopt.c */
650 void ipfw_init_skipto_cache(struct ip_fw_chain *chain);
651 void ipfw_destroy_skipto_cache(struct ip_fw_chain *chain);
652 int ipfw_find_rule(struct ip_fw_chain *chain, uint32_t key, uint32_t id);
653 int ipfw_ctl3(struct sockopt *sopt);
654 int ipfw_add_protected_rule(struct ip_fw_chain *chain, struct ip_fw *rule,
656 void ipfw_reap_add(struct ip_fw_chain *chain, struct ip_fw **head,
658 void ipfw_reap_rules(struct ip_fw *head);
659 void ipfw_init_counters(void);
660 void ipfw_destroy_counters(void);
661 struct ip_fw *ipfw_alloc_rule(struct ip_fw_chain *chain, size_t rulesize);
662 void ipfw_free_rule(struct ip_fw *rule);
663 int ipfw_match_range(struct ip_fw *rule, ipfw_range_tlv *rt);
664 int ipfw_mark_object_kidx(uint32_t *bmask, uint16_t etlv, uint16_t kidx);
665 ipfw_insn *ipfw_get_action(struct ip_fw *);
667 typedef int (sopt_handler_f)(struct ip_fw_chain *ch,
668 ip_fw3_opheader *op3, struct sockopt_data *sd);
669 struct ipfw_sopt_handler {
673 sopt_handler_f *handler;
676 #define HDIR_SET 0x01 /* Handler is used to set some data */
677 #define HDIR_GET 0x02 /* Handler is used to retrieve data */
678 #define HDIR_BOTH HDIR_GET|HDIR_SET
680 void ipfw_init_sopt_handler(void);
681 void ipfw_destroy_sopt_handler(void);
682 void ipfw_add_sopt_handler(struct ipfw_sopt_handler *sh, size_t count);
683 int ipfw_del_sopt_handler(struct ipfw_sopt_handler *sh, size_t count);
684 caddr_t ipfw_get_sopt_space(struct sockopt_data *sd, size_t needed);
685 caddr_t ipfw_get_sopt_header(struct sockopt_data *sd, size_t needed);
686 #define IPFW_ADD_SOPT_HANDLER(f, c) do { \
688 ipfw_add_sopt_handler(c, \
689 sizeof(c) / sizeof(c[0])); \
691 #define IPFW_DEL_SOPT_HANDLER(l, c) do { \
693 ipfw_del_sopt_handler(c, \
694 sizeof(c) / sizeof(c[0])); \
697 struct namedobj_instance;
698 typedef int (objhash_cb_t)(struct namedobj_instance *ni, struct named_object *,
700 typedef uint32_t (objhash_hash_f)(struct namedobj_instance *ni, const void *key,
702 typedef int (objhash_cmp_f)(struct named_object *no, const void *key,
704 struct namedobj_instance *ipfw_objhash_create(uint32_t items);
705 void ipfw_objhash_destroy(struct namedobj_instance *);
706 void ipfw_objhash_bitmap_alloc(uint32_t items, void **idx, int *pblocks);
707 void ipfw_objhash_bitmap_merge(struct namedobj_instance *ni,
708 void **idx, int *blocks);
709 void ipfw_objhash_bitmap_swap(struct namedobj_instance *ni,
710 void **idx, int *blocks);
711 void ipfw_objhash_bitmap_free(void *idx, int blocks);
712 void ipfw_objhash_set_hashf(struct namedobj_instance *ni, objhash_hash_f *f);
713 struct named_object *ipfw_objhash_lookup_name(struct namedobj_instance *ni,
714 uint32_t set, char *name);
715 struct named_object *ipfw_objhash_lookup_name_type(struct namedobj_instance *ni,
716 uint32_t set, uint32_t type, const char *name);
717 struct named_object *ipfw_objhash_lookup_kidx(struct namedobj_instance *ni,
719 int ipfw_objhash_same_name(struct namedobj_instance *ni, struct named_object *a,
720 struct named_object *b);
721 void ipfw_objhash_add(struct namedobj_instance *ni, struct named_object *no);
722 void ipfw_objhash_del(struct namedobj_instance *ni, struct named_object *no);
723 uint32_t ipfw_objhash_count(struct namedobj_instance *ni);
724 uint32_t ipfw_objhash_count_type(struct namedobj_instance *ni, uint16_t type);
725 int ipfw_objhash_foreach(struct namedobj_instance *ni, objhash_cb_t *f,
727 int ipfw_objhash_foreach_type(struct namedobj_instance *ni, objhash_cb_t *f,
728 void *arg, uint16_t type);
729 int ipfw_objhash_free_idx(struct namedobj_instance *ni, uint16_t idx);
730 int ipfw_objhash_alloc_idx(void *n, uint16_t *pidx);
731 void ipfw_objhash_set_funcs(struct namedobj_instance *ni,
732 objhash_hash_f *hash_f, objhash_cmp_f *cmp_f);
733 int ipfw_objhash_find_type(struct namedobj_instance *ni, struct tid_info *ti,
734 uint32_t etlv, struct named_object **pno);
735 void ipfw_export_obj_ntlv(struct named_object *no, ipfw_obj_ntlv *ntlv);
736 ipfw_obj_ntlv *ipfw_find_name_tlv_type(void *tlvs, int len, uint16_t uidx,
738 void ipfw_init_obj_rewriter(void);
739 void ipfw_destroy_obj_rewriter(void);
740 void ipfw_add_obj_rewriter(struct opcode_obj_rewrite *rw, size_t count);
741 int ipfw_del_obj_rewriter(struct opcode_obj_rewrite *rw, size_t count);
743 int create_objects_compat(struct ip_fw_chain *ch, ipfw_insn *cmd,
744 struct obj_idx *oib, struct obj_idx *pidx, struct tid_info *ti);
745 void update_opcode_kidx(ipfw_insn *cmd, uint16_t idx);
746 int classify_opcode_kidx(ipfw_insn *cmd, uint16_t *puidx);
747 void ipfw_init_srv(struct ip_fw_chain *ch);
748 void ipfw_destroy_srv(struct ip_fw_chain *ch);
749 int ipfw_check_object_name_generic(const char *name);
750 int ipfw_obj_manage_sets(struct namedobj_instance *ni, uint16_t type,
751 uint16_t set, uint8_t new_set, enum ipfw_sets_cmd cmd);
753 /* In ip_fw_eaction.c */
754 typedef int (ipfw_eaction_t)(struct ip_fw_chain *ch, struct ip_fw_args *args,
755 ipfw_insn *cmd, int *done);
756 int ipfw_eaction_init(struct ip_fw_chain *ch, int first);
757 void ipfw_eaction_uninit(struct ip_fw_chain *ch, int last);
759 uint16_t ipfw_add_eaction(struct ip_fw_chain *ch, ipfw_eaction_t handler,
761 int ipfw_del_eaction(struct ip_fw_chain *ch, uint16_t eaction_id);
762 int ipfw_run_eaction(struct ip_fw_chain *ch, struct ip_fw_args *args,
763 ipfw_insn *cmd, int *done);
764 int ipfw_reset_eaction(struct ip_fw_chain *ch, struct ip_fw *rule,
765 uint16_t eaction_id, uint16_t default_id, uint16_t instance_id);
766 int ipfw_reset_eaction_instance(struct ip_fw_chain *ch, uint16_t eaction_id,
767 uint16_t instance_id);
769 /* In ip_fw_table.c */
772 typedef int (table_lookup_t)(struct table_info *ti, void *key, uint32_t keylen,
775 int ipfw_lookup_table(struct ip_fw_chain *ch, uint16_t tbl, uint16_t plen,
776 void *paddr, uint32_t *val);
777 struct named_object *ipfw_objhash_lookup_table_kidx(struct ip_fw_chain *ch,
779 int ipfw_ref_table(struct ip_fw_chain *ch, ipfw_obj_ntlv *ntlv, uint16_t *kidx);
780 void ipfw_unref_table(struct ip_fw_chain *ch, uint16_t kidx);
781 int ipfw_init_tables(struct ip_fw_chain *ch, int first);
782 int ipfw_resize_tables(struct ip_fw_chain *ch, unsigned int ntables);
783 int ipfw_switch_tables_namespace(struct ip_fw_chain *ch, unsigned int nsets);
784 void ipfw_destroy_tables(struct ip_fw_chain *ch, int last);
786 /* In ip_fw_nat.c -- XXX to be moved to ip_var.h */
788 extern struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int);
790 typedef int ipfw_nat_t(struct ip_fw_args *, struct cfg_nat *, struct mbuf *);
791 typedef int ipfw_nat_cfg_t(struct sockopt *);
793 VNET_DECLARE(int, ipfw_nat_ready);
794 #define V_ipfw_nat_ready VNET(ipfw_nat_ready)
795 #define IPFW_NAT_LOADED (V_ipfw_nat_ready)
797 extern ipfw_nat_t *ipfw_nat_ptr;
798 extern ipfw_nat_cfg_t *ipfw_nat_cfg_ptr;
799 extern ipfw_nat_cfg_t *ipfw_nat_del_ptr;
800 extern ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr;
801 extern ipfw_nat_cfg_t *ipfw_nat_get_log_ptr;
803 /* Helper functions for IP checksum adjustment */
804 static __inline uint16_t
805 cksum_add(uint16_t sum, uint16_t a)
810 return (res + (res < a));
813 static __inline uint16_t
814 cksum_adjust(uint16_t oldsum, uint16_t old, uint16_t new)
817 return (~cksum_add(cksum_add(~oldsum, ~old), new));
821 #endif /* _IPFW2_PRIVATE_H */