ip_fw_private.h revision 218909
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: head/sys/netinet/ipfw/ip_fw_private.h 218909 2011-02-21 09:01:34Z brucec $ 26 */ 27 28#ifndef _IPFW2_PRIVATE_H 29#define _IPFW2_PRIVATE_H 30 31/* 32 * Internal constants and data structures used by ipfw components 33 * and not meant to be exported outside the kernel. 34 */ 35 36#ifdef _KERNEL 37 38/* 39 * For platforms that do not have SYSCTL support, we wrap the 40 * SYSCTL_* into a function (one per file) to collect the values 41 * into an array at module initialization. The wrapping macros, 42 * SYSBEGIN() and SYSEND, are empty in the default case. 43 */ 44#ifndef SYSBEGIN 45#define SYSBEGIN(x) 46#endif 47#ifndef SYSEND 48#define SYSEND 49#endif 50 51/* Return values from ipfw_chk() */ 52enum { 53 IP_FW_PASS = 0, 54 IP_FW_DENY, 55 IP_FW_DIVERT, 56 IP_FW_TEE, 57 IP_FW_DUMMYNET, 58 IP_FW_NETGRAPH, 59 IP_FW_NGTEE, 60 IP_FW_NAT, 61 IP_FW_REASS, 62}; 63 64/* 65 * Structure for collecting parameters to dummynet for ip6_output forwarding 66 */ 67struct _ip6dn_args { 68 struct ip6_pktopts *opt_or; 69 struct route_in6 ro_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 struct route_in6 ro_pmtu_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 */ 85struct 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 90 /* 91 * On return, it points to the matching rule. 92 * On entry, rule.slot > 0 means the info is valid and 93 * contains the starting rule for an ipfw search. 94 * If chain_id == chain->id && slot >0 then jump to that slot. 95 * Otherwise, we locate the first rule >= rulenum:rule_id 96 */ 97 struct ipfw_rule_ref rule; /* match/restart info */ 98 99 struct ether_header *eh; /* for bridged packets */ 100 101 struct ipfw_flow_id f_id; /* grabbed from IP header */ 102 //uint32_t cookie; /* a cookie depending on rule action */ 103 struct inpcb *inp; 104 105 struct _ip6dn_args dummypar; /* dummynet->ip6_output */ 106 struct sockaddr_in hopstore; /* store here if cannot use a pointer */ 107}; 108 109MALLOC_DECLARE(M_IPFW); 110 111/* 112 * Hooks sometime need to know the direction of the packet 113 * (divert, dummynet, netgraph, ...) 114 * We use a generic definition here, with bit0-1 indicating the 115 * direction, bit 2 indicating layer2 or 3, bit 3-4 indicating the 116 * specific protocol 117 * indicating the protocol (if necessary) 118 */ 119enum { 120 DIR_MASK = 0x3, 121 DIR_OUT = 0, 122 DIR_IN = 1, 123 DIR_FWD = 2, 124 DIR_DROP = 3, 125 PROTO_LAYER2 = 0x4, /* set for layer 2 */ 126 /* PROTO_DEFAULT = 0, */ 127 PROTO_IPV4 = 0x08, 128 PROTO_IPV6 = 0x10, 129 PROTO_IFB = 0x0c, /* layer2 + ifbridge */ 130 /* PROTO_OLDBDG = 0x14, unused, old bridge */ 131}; 132 133/* wrapper for freeing a packet, in case we need to do more work */ 134#ifndef FREE_PKT 135#if defined(__linux__) || defined(_WIN32) 136#define FREE_PKT(m) netisr_dispatch(-1, m) 137#else 138#define FREE_PKT(m) m_freem(m) 139#endif 140#endif /* !FREE_PKT */ 141 142/* 143 * Function definitions. 144 */ 145 146/* attach (arg = 1) or detach (arg = 0) hooks */ 147int ipfw_attach_hooks(int); 148#ifdef NOTYET 149void ipfw_nat_destroy(void); 150#endif 151 152/* In ip_fw_log.c */ 153struct ip; 154void ipfw_log_bpf(int); 155void ipfw_log(struct ip_fw *f, u_int hlen, struct ip_fw_args *args, 156 struct mbuf *m, struct ifnet *oif, u_short offset, uint32_t tablearg, 157 struct ip *ip); 158VNET_DECLARE(u_int64_t, norule_counter); 159#define V_norule_counter VNET(norule_counter) 160VNET_DECLARE(int, verbose_limit); 161#define V_verbose_limit VNET(verbose_limit) 162 163/* In ip_fw_dynamic.c */ 164 165enum { /* result for matching dynamic rules */ 166 MATCH_REVERSE = 0, 167 MATCH_FORWARD, 168 MATCH_NONE, 169 MATCH_UNKNOWN, 170}; 171 172/* 173 * The lock for dynamic rules is only used once outside the file, 174 * and only to release the result of lookup_dyn_rule(). 175 * Eventually we may implement it with a callback on the function. 176 */ 177void ipfw_dyn_unlock(void); 178 179struct tcphdr; 180struct mbuf *ipfw_send_pkt(struct mbuf *, struct ipfw_flow_id *, 181 u_int32_t, u_int32_t, int); 182int ipfw_install_state(struct ip_fw *rule, ipfw_insn_limit *cmd, 183 struct ip_fw_args *args, uint32_t tablearg); 184ipfw_dyn_rule *ipfw_lookup_dyn_rule(struct ipfw_flow_id *pkt, 185 int *match_direction, struct tcphdr *tcp); 186void ipfw_remove_dyn_children(struct ip_fw *rule); 187void ipfw_get_dynamic(char **bp, const char *ep); 188 189void ipfw_dyn_attach(void); /* uma_zcreate .... */ 190void ipfw_dyn_detach(void); /* uma_zdestroy ... */ 191void ipfw_dyn_init(void); /* per-vnet initialization */ 192void ipfw_dyn_uninit(int); /* per-vnet deinitialization */ 193int ipfw_dyn_len(void); 194 195/* common variables */ 196VNET_DECLARE(int, fw_one_pass); 197#define V_fw_one_pass VNET(fw_one_pass) 198 199VNET_DECLARE(int, fw_verbose); 200#define V_fw_verbose VNET(fw_verbose) 201 202VNET_DECLARE(struct ip_fw_chain, layer3_chain); 203#define V_layer3_chain VNET(layer3_chain) 204 205VNET_DECLARE(u_int32_t, set_disable); 206#define V_set_disable VNET(set_disable) 207 208VNET_DECLARE(int, autoinc_step); 209#define V_autoinc_step VNET(autoinc_step) 210 211struct ip_fw_chain { 212 struct ip_fw *rules; /* list of rules */ 213 struct ip_fw *reap; /* list of rules to reap */ 214 struct ip_fw *default_rule; 215 int n_rules; /* number of static rules */ 216 int static_len; /* total len of static rules */ 217 struct ip_fw **map; /* array of rule ptrs to ease lookup */ 218 LIST_HEAD(nat_list, cfg_nat) nat; /* list of nat entries */ 219 struct radix_node_head *tables[IPFW_TABLES_MAX]; 220#if defined( __linux__ ) || defined( _WIN32 ) 221 spinlock_t rwmtx; 222 spinlock_t uh_lock; 223#else 224 struct rwlock rwmtx; 225 struct rwlock uh_lock; /* lock for upper half */ 226#endif 227 uint32_t id; /* ruleset id */ 228}; 229 230struct sockopt; /* used by tcp_var.h */ 231 232/* 233 * The lock is heavily used by ip_fw2.c (the main file) and ip_fw_nat.c 234 * so the variable and the macros must be here. 235 */ 236 237#define IPFW_LOCK_INIT(_chain) do { \ 238 rw_init(&(_chain)->rwmtx, "IPFW static rules"); \ 239 rw_init(&(_chain)->uh_lock, "IPFW UH lock"); \ 240 } while (0) 241 242#define IPFW_LOCK_DESTROY(_chain) do { \ 243 rw_destroy(&(_chain)->rwmtx); \ 244 rw_destroy(&(_chain)->uh_lock); \ 245 } while (0) 246 247#define IPFW_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_WLOCKED) 248 249#define IPFW_RLOCK(p) rw_rlock(&(p)->rwmtx) 250#define IPFW_RUNLOCK(p) rw_runlock(&(p)->rwmtx) 251#define IPFW_WLOCK(p) rw_wlock(&(p)->rwmtx) 252#define IPFW_WUNLOCK(p) rw_wunlock(&(p)->rwmtx) 253 254#define IPFW_UH_RLOCK(p) rw_rlock(&(p)->uh_lock) 255#define IPFW_UH_RUNLOCK(p) rw_runlock(&(p)->uh_lock) 256#define IPFW_UH_WLOCK(p) rw_wlock(&(p)->uh_lock) 257#define IPFW_UH_WUNLOCK(p) rw_wunlock(&(p)->uh_lock) 258 259/* In ip_fw_sockopt.c */ 260int ipfw_find_rule(struct ip_fw_chain *chain, uint32_t key, uint32_t id); 261int ipfw_add_rule(struct ip_fw_chain *chain, struct ip_fw *input_rule); 262int ipfw_ctl(struct sockopt *sopt); 263int ipfw_chk(struct ip_fw_args *args); 264void ipfw_reap_rules(struct ip_fw *head); 265 266/* In ip_fw_pfil */ 267int ipfw_check_hook(void *arg, struct mbuf **m0, struct ifnet *ifp, int dir, 268 struct inpcb *inp); 269 270/* In ip_fw_table.c */ 271struct radix_node; 272int ipfw_lookup_table(struct ip_fw_chain *ch, uint16_t tbl, in_addr_t addr, 273 uint32_t *val); 274int ipfw_init_tables(struct ip_fw_chain *ch); 275void ipfw_destroy_tables(struct ip_fw_chain *ch); 276int ipfw_flush_table(struct ip_fw_chain *ch, uint16_t tbl); 277int ipfw_add_table_entry(struct ip_fw_chain *ch, uint16_t tbl, in_addr_t addr, 278 uint8_t mlen, uint32_t value); 279int ipfw_dump_table_entry(struct radix_node *rn, void *arg); 280int ipfw_del_table_entry(struct ip_fw_chain *ch, uint16_t tbl, in_addr_t addr, 281 uint8_t mlen); 282int ipfw_count_table(struct ip_fw_chain *ch, uint32_t tbl, uint32_t *cnt); 283int ipfw_dump_table(struct ip_fw_chain *ch, ipfw_table *tbl); 284 285/* In ip_fw_nat.c -- XXX to be moved to ip_var.h */ 286 287extern struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int); 288 289typedef int ipfw_nat_t(struct ip_fw_args *, struct cfg_nat *, struct mbuf *); 290typedef int ipfw_nat_cfg_t(struct sockopt *); 291 292extern ipfw_nat_t *ipfw_nat_ptr; 293#define IPFW_NAT_LOADED (ipfw_nat_ptr != NULL) 294 295extern ipfw_nat_cfg_t *ipfw_nat_cfg_ptr; 296extern ipfw_nat_cfg_t *ipfw_nat_del_ptr; 297extern ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr; 298extern ipfw_nat_cfg_t *ipfw_nat_get_log_ptr; 299 300#endif /* _KERNEL */ 301#endif /* _IPFW2_PRIVATE_H */ 302