1 /*- 2 * Copyright (c) 1985, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)in_var.h 8.2 (Berkeley) 1/9/95 30 * $FreeBSD$ 31 */ 32 33 #ifndef _NETINET_IN_VAR_H_ 34 #define _NETINET_IN_VAR_H_ 35 36 #include <sys/queue.h> 37 #include <sys/fnv_hash.h> 38 39 /* 40 * Interface address, Internet version. One of these structures 41 * is allocated for each Internet address on an interface. 42 * The ifaddr structure contains the protocol-independent part 43 * of the structure and is assumed to be first. 44 */ 45 struct in_ifaddr { 46 struct ifaddr ia_ifa; /* protocol-independent info */ 47 #define ia_ifp ia_ifa.ifa_ifp 48 #define ia_flags ia_ifa.ifa_flags 49 /* ia_{,sub}net{,mask} in host order */ 50 u_long ia_net; /* network number of interface */ 51 u_long ia_netmask; /* mask of net part */ 52 u_long ia_subnet; /* subnet number, including net */ 53 u_long ia_subnetmask; /* mask of subnet part */ 54 struct in_addr ia_netbroadcast; /* to recognize net broadcasts */ 55 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */ 56 TAILQ_ENTRY(in_ifaddr) ia_link; /* list of internet addresses */ 57 struct sockaddr_in ia_addr; /* reserve space for interface name */ 58 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ 59 #define ia_broadaddr ia_dstaddr 60 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ 61 }; 62 63 struct in_aliasreq { 64 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 65 struct sockaddr_in ifra_addr; 66 struct sockaddr_in ifra_broadaddr; 67 #define ifra_dstaddr ifra_broadaddr 68 struct sockaddr_in ifra_mask; 69 }; 70 /* 71 * Given a pointer to an in_ifaddr (ifaddr), 72 * return a pointer to the addr as a sockaddr_in. 73 */ 74 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) 75 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr)) 76 77 #define IN_LNAOF(in, ifa) \ 78 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask)) 79 80 81 #ifdef _KERNEL 82 extern u_char inetctlerrmap[]; 83 84 /* 85 * Hash table for IP addresses. 86 */ 87 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); 88 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); 89 #ifdef VIMAGE_GLOBALS 90 extern struct in_ifaddrhashhead *in_ifaddrhashtbl; 91 extern struct in_ifaddrhead in_ifaddrhead; 92 extern u_long in_ifaddrhmask; /* mask for hash table */ 93 #endif 94 95 #define INADDR_NHASH_LOG2 9 96 #define INADDR_NHASH (1 << INADDR_NHASH_LOG2) 97 #define INADDR_HASHVAL(x) fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT) 98 #define INADDR_HASH(x) \ 99 (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask]) 100 101 /* 102 * Macro for finding the internet address structure (in_ifaddr) 103 * corresponding to one of our IP addresses (in_addr). 104 */ 105 #define INADDR_TO_IFADDR(addr, ia) \ 106 /* struct in_addr addr; */ \ 107 /* struct in_ifaddr *ia; */ \ 108 do { \ 109 \ 110 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \ 111 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \ 112 break; \ 113 } while (0) 114 115 /* 116 * Macro for finding the interface (ifnet structure) corresponding to one 117 * of our IP addresses. 118 */ 119 #define INADDR_TO_IFP(addr, ifp) \ 120 /* struct in_addr addr; */ \ 121 /* struct ifnet *ifp; */ \ 122 { \ 123 struct in_ifaddr *ia; \ 124 \ 125 INADDR_TO_IFADDR(addr, ia); \ 126 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \ 127 } 128 129 /* 130 * Macro for finding the internet address structure (in_ifaddr) corresponding 131 * to a given interface (ifnet structure). 132 */ 133 #define IFP_TO_IA(ifp, ia) \ 134 /* struct ifnet *ifp; */ \ 135 /* struct in_ifaddr *ia; */ \ 136 { \ 137 for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \ 138 (ia) != NULL && (ia)->ia_ifp != (ifp); \ 139 (ia) = TAILQ_NEXT((ia), ia_link)) \ 140 continue; \ 141 } 142 #endif 143 144 /* 145 * IP datagram reassembly. 146 */ 147 #define IPREASS_NHASH_LOG2 6 148 #define IPREASS_NHASH (1 << IPREASS_NHASH_LOG2) 149 #define IPREASS_HMASK (IPREASS_NHASH - 1) 150 #define IPREASS_HASH(x,y) \ 151 (((((x) & 0xF) | ((((x) >> 8) & 0xF) << 4)) ^ (y)) & IPREASS_HMASK) 152 153 /* 154 * This information should be part of the ifnet structure but we don't wish 155 * to change that - as it might break a number of things 156 */ 157 158 struct router_info { 159 struct ifnet *rti_ifp; 160 int rti_type; /* type of router which is querier on this interface */ 161 int rti_time; /* # of slow timeouts since last old query */ 162 SLIST_ENTRY(router_info) rti_list; 163 #ifdef notyet 164 int rti_timev1; /* IGMPv1 querier present */ 165 int rti_timev2; /* IGMPv2 querier present */ 166 int rti_timer; /* report to general query */ 167 int rti_qrv; /* querier robustness */ 168 #endif 169 }; 170 171 /* 172 * Internet multicast address structure. There is one of these for each IP 173 * multicast group to which this host belongs on a given network interface. 174 * For every entry on the interface's if_multiaddrs list which represents 175 * an IP multicast group, there is one of these structures. They are also 176 * kept on a system-wide list to make it easier to keep our legacy IGMP code 177 * compatible with the rest of the world (see IN_FIRST_MULTI et al, below). 178 */ 179 struct in_multi { 180 LIST_ENTRY(in_multi) inm_link; /* queue macro glue */ 181 struct in_addr inm_addr; /* IP multicast address, convenience */ 182 struct ifnet *inm_ifp; /* back pointer to ifnet */ 183 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */ 184 u_int inm_timer; /* IGMP membership report timer */ 185 u_int inm_state; /* state of the membership */ 186 struct router_info *inm_rti; /* router info*/ 187 u_int inm_refcount; /* reference count */ 188 #ifdef notyet /* IGMPv3 source-specific multicast fields */ 189 TAILQ_HEAD(, in_msfentry) inm_msf; /* all active source filters */ 190 TAILQ_HEAD(, in_msfentry) inm_msf_record; /* recorded sources */ 191 TAILQ_HEAD(, in_msfentry) inm_msf_exclude; /* exclude sources */ 192 TAILQ_HEAD(, in_msfentry) inm_msf_include; /* include sources */ 193 /* XXX: should this lot go to the router_info structure? */ 194 /* XXX: can/should these be callouts? */ 195 /* IGMP protocol timers */ 196 int32_t inm_ti_curstate; /* current state timer */ 197 int32_t inm_ti_statechg; /* state change timer */ 198 /* IGMP report timers */ 199 uint16_t inm_rpt_statechg; /* state change report timer */ 200 uint16_t inm_rpt_toxx; /* fmode change report timer */ 201 /* IGMP protocol state */ 202 uint16_t inm_fmode; /* filter mode */ 203 uint32_t inm_recsrc_count; /* # of recorded sources */ 204 uint16_t inm_exclude_sock_count; /* # of exclude-mode sockets */ 205 uint16_t inm_gass_count; /* # of g-a-s queries */ 206 #endif 207 }; 208 209 #ifdef notyet 210 /* 211 * Internet multicast source filter list. This list is used to store 212 * IP multicast source addresses for each membership on an interface. 213 * TODO: Allocate these structures using UMA. 214 * TODO: Find an easier way of linking the struct into two lists at once. 215 */ 216 struct in_msfentry { 217 TAILQ_ENTRY(in_msfentry) isf_link; /* next filter in all-list */ 218 TAILQ_ENTRY(in_msfentry) isf_next; /* next filter in queue */ 219 struct in_addr isf_addr; /* the address of this source */ 220 uint16_t isf_refcount; /* reference count */ 221 uint16_t isf_reporttag; /* what to report to the IGMP router */ 222 uint16_t isf_rexmit; /* retransmission state/count */ 223 }; 224 #endif 225 226 #ifdef _KERNEL 227 228 #ifdef SYSCTL_DECL 229 SYSCTL_DECL(_net_inet); 230 SYSCTL_DECL(_net_inet_ip); 231 SYSCTL_DECL(_net_inet_raw); 232 #endif 233 234 LIST_HEAD(in_multihead, in_multi); 235 #ifdef VIMAGE_GLOBALS 236 extern struct in_multihead in_multihead; 237 #endif 238 239 /* 240 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes 241 * before link layer multicast locks in the lock order. In most cases, 242 * consumers of IN_*_MULTI() macros should acquire the locks before 243 * calling them; users of the in_{add,del}multi() functions should not. 244 */ 245 extern struct mtx in_multi_mtx; 246 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx) 247 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx) 248 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED) 249 250 /* 251 * Structure used by macros below to remember position when stepping through 252 * all of the in_multi records. 253 */ 254 struct in_multistep { 255 struct in_multi *i_inm; 256 }; 257 258 /* 259 * Macro for looking up the in_multi record for a given IP multicast address 260 * on a given interface. If no matching record is found, "inm" is set null. 261 */ 262 #define IN_LOOKUP_MULTI(addr, ifp, inm) \ 263 /* struct in_addr addr; */ \ 264 /* struct ifnet *ifp; */ \ 265 /* struct in_multi *inm; */ \ 266 do { \ 267 struct ifmultiaddr *ifma; \ 268 \ 269 IN_MULTI_LOCK_ASSERT(); \ 270 IF_ADDR_LOCK(ifp); \ 271 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \ 272 if (ifma->ifma_addr->sa_family == AF_INET \ 273 && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \ 274 (addr).s_addr) \ 275 break; \ 276 } \ 277 (inm) = ifma ? ifma->ifma_protospec : 0; \ 278 IF_ADDR_UNLOCK(ifp); \ 279 } while(0) 280 281 /* 282 * Macro to step through all of the in_multi records, one at a time. 283 * The current position is remembered in "step", which the caller must 284 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step" 285 * and get the first record. Both macros return a NULL "inm" when there 286 * are no remaining records. 287 */ 288 #define IN_NEXT_MULTI(step, inm) \ 289 /* struct in_multistep step; */ \ 290 /* struct in_multi *inm; */ \ 291 do { \ 292 IN_MULTI_LOCK_ASSERT(); \ 293 if (((inm) = (step).i_inm) != NULL) \ 294 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \ 295 } while(0) 296 297 #define IN_FIRST_MULTI(step, inm) \ 298 /* struct in_multistep step; */ \ 299 /* struct in_multi *inm; */ \ 300 do { \ 301 IN_MULTI_LOCK_ASSERT(); \ 302 (step).i_inm = LIST_FIRST(&V_in_multihead); \ 303 IN_NEXT_MULTI((step), (inm)); \ 304 } while(0) 305 306 struct rtentry; 307 struct route; 308 struct ip_moptions; 309 310 size_t imo_match_group(struct ip_moptions *, struct ifnet *, 311 struct sockaddr *); 312 struct in_msource *imo_match_source(struct ip_moptions *, size_t, 313 struct sockaddr *); 314 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *); 315 void in_delmulti(struct in_multi *); 316 void in_delmulti_locked(struct in_multi *); 317 int in_control(struct socket *, u_long, caddr_t, struct ifnet *, 318 struct thread *); 319 void in_rtqdrain(void); 320 void ip_input(struct mbuf *); 321 int in_ifadown(struct ifaddr *ifa, int); 322 void in_ifscrub(struct ifnet *, struct in_ifaddr *); 323 struct mbuf *ip_fastforward(struct mbuf *); 324 void *in_domifattach(struct ifnet *); 325 void in_domifdetach(struct ifnet *, void *); 326 327 328 /* XXX */ 329 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum); 330 void in_rtalloc(struct route *ro, u_int fibnum); 331 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int); 332 void in_rtredirect(struct sockaddr *, struct sockaddr *, 333 struct sockaddr *, int, struct sockaddr *, u_int); 334 int in_rtrequest(int, struct sockaddr *, 335 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int); 336 337 #if 0 338 int in_rt_getifa(struct rt_addrinfo *, u_int fibnum); 339 int in_rtioctl(u_long, caddr_t, u_int); 340 int in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int); 341 #endif 342 #endif /* _KERNEL */ 343 344 /* INET6 stuff */ 345 #include <netinet6/in6_var.h> 346 347 #endif /* _NETINET_IN_VAR_H_ */ 348