1 /* $NetBSD: in_var.h,v 1.53 2004/04/21 17:49:46 itojun Exp $ */ 2 3 /*- 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Public Access Networks Corporation ("Panix"). It was developed under 9 * contract to Panix by Eric Haszlakiewicz and Thor Lancelot Simon. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * Copyright (c) 1985, 1986, 1993 42 * The Regents of the University of California. All rights reserved. 43 * 44 * Redistribution and use in source and binary forms, with or without 45 * modification, are permitted provided that the following conditions 46 * are met: 47 * 1. Redistributions of source code must retain the above copyright 48 * notice, this list of conditions and the following disclaimer. 49 * 2. Redistributions in binary form must reproduce the above copyright 50 * notice, this list of conditions and the following disclaimer in the 51 * documentation and/or other materials provided with the distribution. 52 * 3. Neither the name of the University nor the names of its contributors 53 * may be used to endorse or promote products derived from this software 54 * without specific prior written permission. 55 * 56 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 57 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 58 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 59 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 60 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 61 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 62 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 63 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 64 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 65 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 66 * SUCH DAMAGE. 67 * 68 * @(#)in_var.h 8.2 (Berkeley) 1/9/95 69 */ 70 71 #ifndef _NETINET_IN_VAR_H_ 72 #define _NETINET_IN_VAR_H_ 73 74 #include <sys/queue.h> 75 76 /* 77 * Interface address, Internet version. One of these structures 78 * is allocated for each interface with an Internet address. 79 * The ifaddr structure contains the protocol-independent part 80 * of the structure and is assumed to be first. 81 */ 82 struct in_ifaddr { 83 struct ifaddr ia_ifa; /* protocol-independent info */ 84 #define ia_ifp ia_ifa.ifa_ifp 85 #define ia_flags ia_ifa.ifa_flags 86 /* ia_{,sub}net{,mask} in host order */ 87 u_int32_t ia_net; /* network number of interface */ 88 u_int32_t ia_netmask; /* mask of net part */ 89 u_int32_t ia_subnet; /* subnet number, including net */ 90 u_int32_t ia_subnetmask; /* mask of subnet part */ 91 struct in_addr ia_netbroadcast; /* to recognize net broadcasts */ 92 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */ 93 TAILQ_ENTRY(in_ifaddr) ia_list; /* list of internet addresses */ 94 struct sockaddr_in ia_addr; /* reserve space for interface name */ 95 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ 96 #define ia_broadaddr ia_dstaddr 97 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ 98 LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */ 99 struct in_multi *ia_allhosts; /* multicast address record for 100 the allhosts multicast group */ 101 }; 102 103 struct in_aliasreq { 104 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 105 struct sockaddr_in ifra_addr; 106 struct sockaddr_in ifra_dstaddr; 107 #define ifra_broadaddr ifra_dstaddr 108 struct sockaddr_in ifra_mask; 109 }; 110 /* 111 * Given a pointer to an in_ifaddr (ifaddr), 112 * return a pointer to the addr as a sockaddr_in. 113 */ 114 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) 115 116 117 #ifdef _KERNEL 118 #ifndef IN_IFADDR_HASH_SIZE 119 #define IN_IFADDR_HASH_SIZE 509 /* 61, 127, 251, 509, 1021, 2039 are good */ 120 #endif 121 #ifndef IN_MULTI_HASH_SIZE 122 #define IN_MULTI_HASH_SIZE 509 /* 61, 127, 251, 509, 1021, 2039 are good */ 123 #endif 124 125 /* 126 * This is a bit unconventional, and wastes a little bit of space, but 127 * because we want a very even hash function we don't use & in_ifaddrhash 128 * here, but rather % the hash size, which should obviously be prime. 129 */ 130 131 #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE] 132 #define IN_MULTI_HASH(x, ifp) \ 133 (in_multihashtbl[(u_long)((x) ^ (ifp->if_index)) % IN_MULTI_HASH_SIZE]) 134 135 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); /* Type of the hash head */ 136 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); /* Type of the list head */ 137 LIST_HEAD(in_multihashhead, in_multi); /* Type of the hash head */ 138 139 140 extern u_long in_ifaddrhash; /* size of hash table - 1 */ 141 extern int in_ifaddrentries; /* total number of addrs */ 142 extern struct in_ifaddrhashhead *in_ifaddrhashtbl; /* Hash table head */ 143 extern struct in_ifaddrhead in_ifaddrhead; /* List head (in ip_input) */ 144 145 extern u_long in_multihash; /* size of hash table - 1 */ 146 extern int in_multientries; /* total number of addrs */ 147 extern struct in_multihashhead *in_multihashtbl; /* Hash table head */ 148 149 extern struct ifqueue ipintrq; /* ip packet input queue */ 150 extern const int inetctlerrmap[]; 151 152 153 /* 154 * Macro for finding whether an internet address (in_addr) belongs to one 155 * of our interfaces (in_ifaddr). NULL if the address isn't ours. 156 */ 157 #define INADDR_TO_IA(addr, ia) \ 158 /* struct in_addr addr; */ \ 159 /* struct in_ifaddr *ia; */ \ 160 { \ 161 LIST_FOREACH(ia, &IN_IFADDR_HASH((addr).s_addr), ia_hash) { \ 162 if (in_hosteq(ia->ia_addr.sin_addr, (addr))) \ 163 break; \ 164 } \ 165 } 166 167 /* 168 * Macro for finding the next in_ifaddr structure with the same internet 169 * address as ia. Call only with a valid ia pointer. 170 * Will set ia to NULL if none found. 171 */ 172 173 #define NEXT_IA_WITH_SAME_ADDR(ia) \ 174 /* struct in_ifaddr *ia; */ \ 175 { \ 176 struct in_addr addr; \ 177 addr = ia->ia_addr.sin_addr; \ 178 do { \ 179 ia = LIST_NEXT(ia, ia_hash); \ 180 } while ((ia != NULL) && !in_hosteq(ia->ia_addr.sin_addr, addr)); \ 181 } 182 183 /* 184 * Macro for finding the interface (ifnet structure) corresponding to one 185 * of our IP addresses. 186 */ 187 #define INADDR_TO_IFP(addr, ifp) \ 188 /* struct in_addr addr; */ \ 189 /* struct ifnet *ifp; */ \ 190 { \ 191 struct in_ifaddr *ia; \ 192 \ 193 INADDR_TO_IA(addr, ia); \ 194 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \ 195 } 196 197 /* 198 * Macro for finding an internet address structure (in_ifaddr) corresponding 199 * to a given interface (ifnet structure). 200 */ 201 #define IFP_TO_IA(ifp, ia) \ 202 /* struct ifnet *ifp; */ \ 203 /* struct in_ifaddr *ia; */ \ 204 { \ 205 struct ifaddr *ifa; \ 206 \ 207 TAILQ_FOREACH(ifa, &(ifp)->if_addrlist, ifa_list) { \ 208 if (ifa->ifa_addr->sa_family == AF_INET) \ 209 break; \ 210 } \ 211 (ia) = ifatoia(ifa); \ 212 } 213 #endif 214 215 /* 216 * Per-interface router version information. 217 */ 218 struct router_info { 219 LIST_ENTRY(router_info) rti_link; 220 struct ifnet *rti_ifp; 221 int rti_type; /* type of router on this interface */ 222 int rti_age; /* time since last v1 query */ 223 }; 224 225 /* 226 * Internet multicast address structure. There is one of these for each IP 227 * multicast group to which this host belongs on a given network interface. 228 * They are kept in a linked list, rooted in the interface's in_ifaddr 229 * structure. 230 */ 231 struct in_multi { 232 LIST_ENTRY(in_multi) inm_list; /* list of multicast addresses */ 233 struct router_info *inm_rti; /* router version info */ 234 struct ifnet *inm_ifp; /* back pointer to ifnet */ 235 struct in_addr inm_addr; /* IP multicast address */ 236 u_int inm_refcount; /* no. membership claims by sockets */ 237 u_int inm_timer; /* IGMP membership report timer */ 238 u_int inm_state; /* state of membership */ 239 }; 240 241 #ifdef _KERNEL 242 /* 243 * Structure used by macros below to remember position when stepping through 244 * all of the in_multi records. 245 */ 246 struct in_multistep { 247 int i_n; 248 struct in_multi *i_inm; 249 }; 250 251 /* 252 * Macro for looking up the in_multi record for a given IP multicast address 253 * on a given interface. If no matching record is found, "inm" returns NULL. 254 */ 255 #define IN_LOOKUP_MULTI(addr, ifp, inm) \ 256 /* struct in_addr addr; */ \ 257 /* struct ifnet *ifp; */ \ 258 /* struct in_multi *inm; */ \ 259 { \ 260 LIST_FOREACH((inm), &IN_MULTI_HASH(((addr).s_addr), (ifp)), inm_list) {\ 261 if (in_hosteq((inm)->inm_addr, (addr)) && \ 262 (inm)->inm_ifp == (ifp)) \ 263 break; \ 264 } \ 265 } 266 267 /* 268 * Macro to step through all of the in_multi records, one at a time. 269 * The current position is remembered in "step", which the caller must 270 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step" 271 * and get the first record. Both macros return a NULL "inm" when there 272 * are no remaining records. 273 */ 274 #define IN_NEXT_MULTI(step, inm) \ 275 /* struct in_multistep step; */ \ 276 /* struct in_multi *inm; */ \ 277 { \ 278 while ((step).i_inm == NULL && (step).i_n < IN_MULTI_HASH_SIZE) \ 279 (step).i_inm = LIST_FIRST(&in_multihashtbl[++(step).i_n]); \ 280 if (((inm) = (step).i_inm) != NULL) \ 281 (step).i_inm = LIST_NEXT((inm), inm_list); \ 282 } 283 284 #define IN_FIRST_MULTI(step, inm) \ 285 /* struct in_multistep step; */ \ 286 /* struct in_multi *inm; */ \ 287 { \ 288 (step).i_n = 0; \ 289 (step).i_inm = LIST_FIRST(&in_multihashtbl[0]); \ 290 IN_NEXT_MULTI((step), (inm)); \ 291 } 292 293 struct ifaddr; 294 295 int in_ifinit(struct ifnet *, 296 struct in_ifaddr *, struct sockaddr_in *, int); 297 void in_savemkludge(struct in_ifaddr *); 298 void in_restoremkludge(struct in_ifaddr *, struct ifnet *); 299 void in_purgemkludge(struct ifnet *); 300 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *); 301 void in_delmulti(struct in_multi *); 302 void in_ifscrub(struct ifnet *, struct in_ifaddr *); 303 void in_setmaxmtu(void); 304 const char *in_fmtaddr(struct in_addr); 305 int in_control(struct socket *, u_long, caddr_t, struct ifnet *, 306 struct proc *); 307 void in_purgeaddr(struct ifaddr *, struct ifnet *); 308 void in_purgeif(struct ifnet *); 309 void ip_input(struct mbuf *); 310 int ipflow_fastforward(struct mbuf *); 311 312 #endif 313 314 /* INET6 stuff */ 315 #include <netinet6/in6_var.h> 316 317 #endif /* _NETINET_IN_VAR_H_ */ 318