in_var.h revision 1.79
1 /* $NetBSD: in_var.h,v 1.79 2016/08/01 03:15:30 ozaki-r 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 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Copyright (c) 1985, 1986, 1993 35 * The Regents of the University of California. All rights reserved. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 1. Redistributions of source code must retain the above copyright 41 * notice, this list of conditions and the following disclaimer. 42 * 2. Redistributions in binary form must reproduce the above copyright 43 * notice, this list of conditions and the following disclaimer in the 44 * documentation and/or other materials provided with the distribution. 45 * 3. Neither the name of the University nor the names of its contributors 46 * may be used to endorse or promote products derived from this software 47 * without specific prior written permission. 48 * 49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 59 * SUCH DAMAGE. 60 * 61 * @(#)in_var.h 8.2 (Berkeley) 1/9/95 62 */ 63 64 #ifndef _NETINET_IN_VAR_H_ 65 #define _NETINET_IN_VAR_H_ 66 67 #include <sys/queue.h> 68 69 #define IN_IFF_TENTATIVE 0x01 /* tentative address */ 70 #define IN_IFF_DUPLICATED 0x02 /* DAD detected duplicate */ 71 #define IN_IFF_DETACHED 0x04 /* may be detached from the link */ 72 #define IN_IFF_TRYTENTATIVE 0x08 /* intent to try DAD */ 73 74 /* do not input/output */ 75 #define IN_IFF_NOTREADY \ 76 (IN_IFF_TRYTENTATIVE | IN_IFF_TENTATIVE | IN_IFF_DUPLICATED) 77 78 /* 79 * Interface address, Internet version. One of these structures 80 * is allocated for each interface with an Internet address. 81 * The ifaddr structure contains the protocol-independent part 82 * of the structure and is assumed to be first. 83 */ 84 struct in_ifaddr { 85 struct ifaddr ia_ifa; /* protocol-independent info */ 86 #define ia_ifp ia_ifa.ifa_ifp 87 #define ia_flags ia_ifa.ifa_flags 88 /* ia_{,sub}net{,mask} in host order */ 89 u_int32_t ia_net; /* network number of interface */ 90 u_int32_t ia_netmask; /* mask of net part */ 91 u_int32_t ia_subnet; /* subnet number, including net */ 92 u_int32_t ia_subnetmask; /* mask of subnet part */ 93 struct in_addr ia_netbroadcast; /* to recognize net broadcasts */ 94 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */ 95 TAILQ_ENTRY(in_ifaddr) ia_list; /* list of internet addresses */ 96 struct sockaddr_in ia_addr; /* reserve space for interface name */ 97 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ 98 #define ia_broadaddr ia_dstaddr 99 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ 100 LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */ 101 struct in_multi *ia_allhosts; /* multicast address record for 102 the allhosts multicast group */ 103 uint16_t ia_idsalt; /* ip_id salt for this ia */ 104 int ia4_flags; /* address flags */ 105 void (*ia_dad_start) (struct ifaddr *); /* DAD start function */ 106 void (*ia_dad_stop) (struct ifaddr *); /* DAD stop function */ 107 108 #ifdef _KERNEL 109 struct pslist_entry ia_hash_pslist_entry; 110 struct pslist_entry ia_pslist_entry; 111 #endif 112 }; 113 114 #ifdef _KERNEL 115 static inline void 116 ia4_acquire(struct in_ifaddr *ia, struct psref *psref) 117 { 118 119 KASSERT(ia != NULL); 120 ifa_acquire(&ia->ia_ifa, psref); 121 } 122 123 static inline void 124 ia4_release(struct in_ifaddr *ia, struct psref *psref) 125 { 126 127 if (ia == NULL) 128 return; 129 ifa_release(&ia->ia_ifa, psref); 130 } 131 #endif 132 133 struct in_aliasreq { 134 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 135 struct sockaddr_in ifra_addr; 136 struct sockaddr_in ifra_dstaddr; 137 #define ifra_broadaddr ifra_dstaddr 138 struct sockaddr_in ifra_mask; 139 }; 140 141 /* 142 * Given a pointer to an in_ifaddr (ifaddr), 143 * return a pointer to the addr as a sockaddr_in. 144 */ 145 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) 146 147 #define iatoifa(ia) (struct ifaddr *)(ia) 148 149 #ifdef _KERNEL 150 151 /* Note: 61, 127, 251, 509, 1021, 2039 are good. */ 152 #ifndef IN_IFADDR_HASH_SIZE 153 #define IN_IFADDR_HASH_SIZE 509 154 #endif 155 156 /* 157 * This is a bit unconventional, and wastes a little bit of space, but 158 * because we want a very even hash function we don't use & in_ifaddrhash 159 * here, but rather % the hash size, which should obviously be prime. 160 */ 161 162 #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE] 163 164 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); /* Type of the hash head */ 165 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); /* Type of the list head */ 166 167 extern u_long in_ifaddrhash; /* size of hash table - 1 */ 168 extern struct in_ifaddrhashhead *in_ifaddrhashtbl; /* Hash table head */ 169 extern struct in_ifaddrhead in_ifaddrhead; /* List head (in ip_input) */ 170 171 extern struct pslist_head *in_ifaddrhashtbl_pslist; 172 extern u_long in_ifaddrhash_pslist; 173 extern struct pslist_head in_ifaddrhead_pslist; 174 175 #define IN_IFADDR_HASH_PSLIST(x) \ 176 in_ifaddrhashtbl_pslist[(u_long)(x) % IN_IFADDR_HASH_SIZE] 177 178 #define IN_ADDRHASH_READER_FOREACH(__ia, __addr) \ 179 PSLIST_READER_FOREACH((__ia), &IN_IFADDR_HASH_PSLIST(__addr), \ 180 struct in_ifaddr, ia_hash_pslist_entry) 181 #define IN_ADDRHASH_WRITER_INSERT_HEAD(__ia) \ 182 PSLIST_WRITER_INSERT_HEAD( \ 183 &IN_IFADDR_HASH_PSLIST((__ia)->ia_addr.sin_addr.s_addr), \ 184 (__ia), ia_hash_pslist_entry) 185 #define IN_ADDRHASH_WRITER_REMOVE(__ia) \ 186 PSLIST_WRITER_REMOVE((__ia), ia_hash_pslist_entry) 187 #define IN_ADDRHASH_ENTRY_INIT(__ia) \ 188 PSLIST_ENTRY_INIT((__ia), ia_hash_pslist_entry); 189 #define IN_ADDRHASH_ENTRY_DESTROY(__ia) \ 190 PSLIST_ENTRY_DESTROY((__ia), ia_hash_pslist_entry); 191 #define IN_ADDRHASH_READER_NEXT(__ia) \ 192 PSLIST_READER_NEXT((__ia), struct in_ifaddr, ia_hash_pslist_entry) 193 194 #define IN_ADDRLIST_ENTRY_INIT(__ia) \ 195 PSLIST_ENTRY_INIT((__ia), ia_pslist_entry) 196 #define IN_ADDRLIST_ENTRY_DESTROY(__ia) \ 197 PSLIST_ENTRY_DESTROY((__ia), ia_pslist_entry); 198 #define IN_ADDRLIST_READER_EMPTY() \ 199 (PSLIST_READER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ 200 ia_pslist_entry) == NULL) 201 #define IN_ADDRLIST_READER_FIRST() \ 202 PSLIST_READER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ 203 ia_pslist_entry) 204 #define IN_ADDRLIST_READER_NEXT(__ia) \ 205 PSLIST_READER_NEXT((__ia), struct in_ifaddr, ia_pslist_entry) 206 #define IN_ADDRLIST_READER_FOREACH(__ia) \ 207 PSLIST_READER_FOREACH((__ia), &in_ifaddrhead_pslist, \ 208 struct in_ifaddr, ia_pslist_entry) 209 #define IN_ADDRLIST_WRITER_INSERT_HEAD(__ia) \ 210 PSLIST_WRITER_INSERT_HEAD(&in_ifaddrhead_pslist, (__ia), \ 211 ia_pslist_entry) 212 #define IN_ADDRLIST_WRITER_REMOVE(__ia) \ 213 PSLIST_WRITER_REMOVE((__ia), ia_pslist_entry) 214 #define IN_ADDRLIST_WRITER_FOREACH(__ia) \ 215 PSLIST_WRITER_FOREACH((__ia), &in_ifaddrhead_pslist, \ 216 struct in_ifaddr, ia_pslist_entry) 217 #define IN_ADDRLIST_WRITER_FIRST() \ 218 PSLIST_WRITER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ 219 ia_pslist_entry) 220 #define IN_ADDRLIST_WRITER_NEXT(__ia) \ 221 PSLIST_WRITER_NEXT((__ia), struct in_ifaddr, ia_pslist_entry) 222 #define IN_ADDRLIST_WRITER_INSERT_AFTER(__ia, __new) \ 223 PSLIST_WRITER_INSERT_AFTER((__ia), (__new), ia_pslist_entry) 224 #define IN_ADDRLIST_WRITER_EMPTY() \ 225 (PSLIST_WRITER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ 226 ia_pslist_entry) == NULL) 227 #define IN_ADDRLIST_WRITER_INSERT_TAIL(__new) \ 228 do { \ 229 if (IN_ADDRLIST_WRITER_EMPTY()) { \ 230 IN_ADDRLIST_WRITER_INSERT_HEAD((__new)); \ 231 } else { \ 232 struct in_ifaddr *__ia; \ 233 IN_ADDRLIST_WRITER_FOREACH(__ia) { \ 234 if (IN_ADDRLIST_WRITER_NEXT(__ia) == NULL) { \ 235 IN_ADDRLIST_WRITER_INSERT_AFTER(__ia,\ 236 (__new)); \ 237 break; \ 238 } \ 239 } \ 240 } \ 241 } while (0) 242 243 extern const int inetctlerrmap[]; 244 245 /* 246 * Find whether an internet address (in_addr) belongs to one 247 * of our interfaces (in_ifaddr). NULL if the address isn't ours. 248 */ 249 static inline struct in_ifaddr * 250 in_get_ia(struct in_addr addr) 251 { 252 struct in_ifaddr *ia; 253 254 IN_ADDRHASH_READER_FOREACH(ia, addr.s_addr) { 255 if (in_hosteq(ia->ia_addr.sin_addr, addr)) 256 break; 257 } 258 259 return ia; 260 } 261 262 static inline struct in_ifaddr * 263 in_get_ia_psref(struct in_addr addr, struct psref *psref) 264 { 265 struct in_ifaddr *ia; 266 int s; 267 268 s = pserialize_read_enter(); 269 ia = in_get_ia(addr); 270 if (ia != NULL) 271 ia4_acquire(ia, psref); 272 pserialize_read_exit(s); 273 274 return ia; 275 } 276 277 /* 278 * Find whether an internet address (in_addr) belongs to a specified 279 * interface. NULL if the address isn't ours. 280 */ 281 static inline struct in_ifaddr * 282 in_get_ia_on_iface(struct in_addr addr, struct ifnet *ifp) 283 { 284 struct in_ifaddr *ia; 285 286 IN_ADDRHASH_READER_FOREACH(ia, addr.s_addr) { 287 if (in_hosteq(ia->ia_addr.sin_addr, addr) && 288 ia->ia_ifp == ifp) 289 break; 290 } 291 292 return ia; 293 } 294 295 static inline struct in_ifaddr * 296 in_get_ia_on_iface_psref(struct in_addr addr, struct ifnet *ifp, struct psref *psref) 297 { 298 struct in_ifaddr *ia; 299 int s; 300 301 s = pserialize_read_enter(); 302 ia = in_get_ia_on_iface(addr, ifp); 303 if (ia != NULL) 304 ia4_acquire(ia, psref); 305 pserialize_read_exit(s); 306 307 return ia; 308 } 309 310 /* 311 * Find an internet address structure (in_ifaddr) corresponding 312 * to a given interface (ifnet structure). 313 */ 314 static inline struct in_ifaddr * 315 in_get_ia_from_ifp(struct ifnet *ifp) 316 { 317 struct ifaddr *ifa; 318 319 IFADDR_READER_FOREACH(ifa, ifp) { 320 if (ifa->ifa_addr->sa_family == AF_INET) 321 break; 322 } 323 324 return ifatoia(ifa); 325 } 326 327 static inline struct in_ifaddr * 328 in_get_ia_from_ifp_psref(struct ifnet *ifp, struct psref *psref) 329 { 330 struct in_ifaddr *ia; 331 int s; 332 333 s = pserialize_read_enter(); 334 ia = in_get_ia_from_ifp(ifp); 335 if (ia != NULL) 336 ia4_acquire(ia, psref); 337 pserialize_read_exit(s); 338 339 return ia; 340 } 341 342 #include <netinet/in_selsrc.h> 343 /* 344 * IPv4 per-interface state. 345 */ 346 struct in_ifinfo { 347 struct lltable *ii_llt; /* ARP state */ 348 struct in_ifsysctl *ii_selsrc; 349 }; 350 351 #endif /* _KERNEL */ 352 353 /* 354 * Internet multicast address structure. There is one of these for each IP 355 * multicast group to which this host belongs on a given network interface. 356 * They are kept in a linked list, rooted in the interface's in_ifaddr 357 * structure. 358 */ 359 struct router_info; 360 361 struct in_multi { 362 LIST_ENTRY(in_multi) inm_list; /* list of multicast addresses */ 363 struct router_info *inm_rti; /* router version info */ 364 struct ifnet *inm_ifp; /* back pointer to ifnet */ 365 struct in_addr inm_addr; /* IP multicast address */ 366 u_int inm_refcount; /* no. membership claims by sockets */ 367 u_int inm_timer; /* IGMP membership report timer */ 368 u_int inm_state; /* state of membership */ 369 }; 370 371 #ifdef _KERNEL 372 373 #include <net/pktqueue.h> 374 375 extern pktqueue_t *ip_pktq; 376 377 extern int ip_dad_count; /* Duplicate Address Detection probes */ 378 379 /* 380 * Structure used by functions below to remember position when stepping 381 * through all of the in_multi records. 382 */ 383 struct in_multistep { 384 int i_n; 385 struct in_multi *i_inm; 386 }; 387 388 bool in_multi_group(struct in_addr, struct ifnet *, int); 389 struct in_multi *in_first_multi(struct in_multistep *); 390 struct in_multi *in_next_multi(struct in_multistep *); 391 struct in_multi *in_lookup_multi(struct in_addr, struct ifnet *); 392 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *); 393 void in_delmulti(struct in_multi *); 394 395 void in_multi_lock(int); 396 void in_multi_unlock(void); 397 int in_multi_lock_held(void); 398 399 struct ifaddr; 400 401 int in_ifinit(struct ifnet *, 402 struct in_ifaddr *, const struct sockaddr_in *, int, int); 403 void in_savemkludge(struct in_ifaddr *); 404 void in_restoremkludge(struct in_ifaddr *, struct ifnet *); 405 void in_purgemkludge(struct ifnet *); 406 void in_ifscrub(struct ifnet *, struct in_ifaddr *); 407 void in_setmaxmtu(void); 408 const char *in_fmtaddr(struct in_addr); 409 int in_control(struct socket *, u_long, void *, struct ifnet *); 410 void in_purgeaddr(struct ifaddr *); 411 void in_purgeif(struct ifnet *); 412 int ipflow_fastforward(struct mbuf *); 413 414 struct ipid_state; 415 typedef struct ipid_state ipid_state_t; 416 417 ipid_state_t * ip_id_init(void); 418 void ip_id_fini(ipid_state_t *); 419 uint16_t ip_randomid(ipid_state_t *, uint16_t); 420 421 extern ipid_state_t * ip_ids; 422 extern uint16_t ip_id; 423 extern int ip_do_randomid; 424 425 /* 426 * ip_newid_range: "allocate" num contiguous IP IDs. 427 * 428 * => Return the first ID. 429 */ 430 static __inline uint16_t 431 ip_newid_range(const struct in_ifaddr *ia, u_int num) 432 { 433 uint16_t id; 434 435 if (ip_do_randomid) { 436 /* XXX ignore num */ 437 return ip_randomid(ip_ids, ia ? ia->ia_idsalt : 0); 438 } 439 440 /* Never allow an IP ID of 0 (detect wrap). */ 441 if ((uint16_t)(ip_id + num) < ip_id) { 442 ip_id = 1; 443 } 444 id = htons(ip_id); 445 ip_id += num; 446 return id; 447 } 448 449 static __inline uint16_t 450 ip_newid(const struct in_ifaddr *ia) 451 { 452 453 return ip_newid_range(ia, 1); 454 } 455 456 #ifdef SYSCTLFN_PROTO 457 int sysctl_inpcblist(SYSCTLFN_PROTO); 458 #endif 459 460 #define LLTABLE(ifp) \ 461 ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt 462 463 #endif /* !_KERNEL */ 464 465 /* INET6 stuff */ 466 #include <netinet6/in6_var.h> 467 468 #endif /* !_NETINET_IN_VAR_H_ */ 469
Indexes created Thu Sep 25 16:09:42 GMT 2025