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