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 #include <sys/tree.h> 39 40 struct igmp_ifinfo; 41 struct in_multi; 42 struct lltable; 43 44 /* 45 * IPv4 per-interface state. 46 */ 47 struct in_ifinfo { 48 struct lltable *ii_llt; /* ARP state */ 49 struct igmp_ifinfo *ii_igmp; /* IGMP state */ 50 struct in_multi *ii_allhosts; /* 224.0.0.1 membership */ 51 }; 52 53 /* 54 * Interface address, Internet version. One of these structures 55 * is allocated for each Internet address on an interface. 56 * The ifaddr structure contains the protocol-independent part 57 * of the structure and is assumed to be first. 58 */ 59 struct in_ifaddr { 60 struct ifaddr ia_ifa; /* protocol-independent info */ 61 #define ia_ifp ia_ifa.ifa_ifp 62 #define ia_flags ia_ifa.ifa_flags 63 /* ia_subnet{,mask} in host order */ 64 u_long ia_subnet; /* subnet address */ 65 u_long ia_subnetmask; /* mask of subnet */ 66 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */ 67 TAILQ_ENTRY(in_ifaddr) ia_link; /* list of internet addresses */ 68 struct sockaddr_in ia_addr; /* reserve space for interface name */ 69 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ 70 #define ia_broadaddr ia_dstaddr 71 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ 72 }; 73 74 struct in_aliasreq { 75 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 76 struct sockaddr_in ifra_addr; 77 struct sockaddr_in ifra_broadaddr; 78 #define ifra_dstaddr ifra_broadaddr 79 struct sockaddr_in ifra_mask; 80 int ifra_vhid; 81 }; 82 /* 83 * Given a pointer to an in_ifaddr (ifaddr), 84 * return a pointer to the addr as a sockaddr_in. 85 */ 86 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) 87 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr)) 88 #define IA_MASKSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_sockmask)) 89 90 #define IN_LNAOF(in, ifa) \ 91 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask)) 92 93 94 #ifdef _KERNEL 95 extern u_char inetctlerrmap[]; 96 97 #define LLTABLE(ifp) \ 98 ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt 99 /* 100 * Hash table for IP addresses. 101 */ 102 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); 103 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); 104 105 VNET_DECLARE(struct in_ifaddrhashhead *, in_ifaddrhashtbl); 106 VNET_DECLARE(struct in_ifaddrhead, in_ifaddrhead); 107 VNET_DECLARE(u_long, in_ifaddrhmask); /* mask for hash table */ 108 109 #define V_in_ifaddrhashtbl VNET(in_ifaddrhashtbl) 110 #define V_in_ifaddrhead VNET(in_ifaddrhead) 111 #define V_in_ifaddrhmask VNET(in_ifaddrhmask) 112 113 #define INADDR_NHASH_LOG2 9 114 #define INADDR_NHASH (1 << INADDR_NHASH_LOG2) 115 #define INADDR_HASHVAL(x) fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT) 116 #define INADDR_HASH(x) \ 117 (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask]) 118 119 extern struct rwlock in_ifaddr_lock; 120 121 #define IN_IFADDR_LOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_LOCKED) 122 #define IN_IFADDR_RLOCK() rw_rlock(&in_ifaddr_lock) 123 #define IN_IFADDR_RLOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_RLOCKED) 124 #define IN_IFADDR_RUNLOCK() rw_runlock(&in_ifaddr_lock) 125 #define IN_IFADDR_WLOCK() rw_wlock(&in_ifaddr_lock) 126 #define IN_IFADDR_WLOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_WLOCKED) 127 #define IN_IFADDR_WUNLOCK() rw_wunlock(&in_ifaddr_lock) 128 129 /* 130 * Macro for finding the internet address structure (in_ifaddr) 131 * corresponding to one of our IP addresses (in_addr). 132 */ 133 #define INADDR_TO_IFADDR(addr, ia) \ 134 /* struct in_addr addr; */ \ 135 /* struct in_ifaddr *ia; */ \ 136 do { \ 137 \ 138 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \ 139 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \ 140 break; \ 141 } while (0) 142 143 /* 144 * Macro for finding the interface (ifnet structure) corresponding to one 145 * of our IP addresses. 146 */ 147 #define INADDR_TO_IFP(addr, ifp) \ 148 /* struct in_addr addr; */ \ 149 /* struct ifnet *ifp; */ \ 150 { \ 151 struct in_ifaddr *ia; \ 152 \ 153 INADDR_TO_IFADDR(addr, ia); \ 154 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \ 155 } 156 157 /* 158 * Macro for finding the internet address structure (in_ifaddr) corresponding 159 * to a given interface (ifnet structure). 160 */ 161 #define IFP_TO_IA(ifp, ia) \ 162 /* struct ifnet *ifp; */ \ 163 /* struct in_ifaddr *ia; */ \ 164 { \ 165 for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \ 166 (ia) != NULL && (ia)->ia_ifp != (ifp); \ 167 (ia) = TAILQ_NEXT((ia), ia_link)) \ 168 continue; \ 169 if ((ia) != NULL) \ 170 ifa_ref(&(ia)->ia_ifa); \ 171 } 172 #endif 173 174 /* 175 * IP datagram reassembly. 176 */ 177 #define IPREASS_NHASH_LOG2 6 178 #define IPREASS_NHASH (1 << IPREASS_NHASH_LOG2) 179 #define IPREASS_HMASK (IPREASS_NHASH - 1) 180 #define IPREASS_HASH(x,y) \ 181 (((((x) & 0xF) | ((((x) >> 8) & 0xF) << 4)) ^ (y)) & IPREASS_HMASK) 182 183 /* 184 * Legacy IPv4 IGMP per-link structure. 185 */ 186 struct router_info { 187 struct ifnet *rti_ifp; 188 int rti_type; /* type of router which is querier on this interface */ 189 int rti_time; /* # of slow timeouts since last old query */ 190 SLIST_ENTRY(router_info) rti_list; 191 }; 192 193 /* 194 * Per-interface IGMP router version information. 195 */ 196 struct igmp_ifinfo { 197 LIST_ENTRY(igmp_ifinfo) igi_link; 198 struct ifnet *igi_ifp; /* interface this instance belongs to */ 199 uint32_t igi_version; /* IGMPv3 Host Compatibility Mode */ 200 uint32_t igi_v1_timer; /* IGMPv1 Querier Present timer (s) */ 201 uint32_t igi_v2_timer; /* IGMPv2 Querier Present timer (s) */ 202 uint32_t igi_v3_timer; /* IGMPv3 General Query (interface) timer (s)*/ 203 uint32_t igi_flags; /* IGMP per-interface flags */ 204 uint32_t igi_rv; /* IGMPv3 Robustness Variable */ 205 uint32_t igi_qi; /* IGMPv3 Query Interval (s) */ 206 uint32_t igi_qri; /* IGMPv3 Query Response Interval (s) */ 207 uint32_t igi_uri; /* IGMPv3 Unsolicited Report Interval (s) */ 208 SLIST_HEAD(,in_multi) igi_relinmhead; /* released groups */ 209 struct ifqueue igi_gq; /* queue of general query responses */ 210 }; 211 212 #define IGIF_SILENT 0x00000001 /* Do not use IGMP on this ifp */ 213 #define IGIF_LOOPBACK 0x00000002 /* Send IGMP reports to loopback */ 214 215 /* 216 * IPv4 multicast IGMP-layer source entry. 217 */ 218 struct ip_msource { 219 RB_ENTRY(ip_msource) ims_link; /* RB tree links */ 220 in_addr_t ims_haddr; /* host byte order */ 221 struct ims_st { 222 uint16_t ex; /* # of exclusive members */ 223 uint16_t in; /* # of inclusive members */ 224 } ims_st[2]; /* state at t0, t1 */ 225 uint8_t ims_stp; /* pending query */ 226 }; 227 228 /* 229 * IPv4 multicast PCB-layer source entry. 230 */ 231 struct in_msource { 232 RB_ENTRY(ip_msource) ims_link; /* RB tree links */ 233 in_addr_t ims_haddr; /* host byte order */ 234 uint8_t imsl_st[2]; /* state before/at commit */ 235 }; 236 237 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */ 238 239 static __inline int 240 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b) 241 { 242 243 if (a->ims_haddr < b->ims_haddr) 244 return (-1); 245 if (a->ims_haddr == b->ims_haddr) 246 return (0); 247 return (1); 248 } 249 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp); 250 251 /* 252 * IPv4 multicast PCB-layer group filter descriptor. 253 */ 254 struct in_mfilter { 255 struct ip_msource_tree imf_sources; /* source list for (S,G) */ 256 u_long imf_nsrc; /* # of source entries */ 257 uint8_t imf_st[2]; /* state before/at commit */ 258 }; 259 260 /* 261 * IPv4 group descriptor. 262 * 263 * For every entry on an ifnet's if_multiaddrs list which represents 264 * an IP multicast group, there is one of these structures. 265 * 266 * If any source filters are present, then a node will exist in the RB-tree 267 * to permit fast lookup by source whenever an operation takes place. 268 * This permits pre-order traversal when we issue reports. 269 * Source filter trees are kept separately from the socket layer to 270 * greatly simplify locking. 271 * 272 * When IGMPv3 is active, inm_timer is the response to group query timer. 273 * The state-change timer inm_sctimer is separate; whenever state changes 274 * for the group the state change record is generated and transmitted, 275 * and kept if retransmissions are necessary. 276 * 277 * FUTURE: inm_link is now only used when groups are being purged 278 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but 279 * because it is at the very start of the struct, we can't do this 280 * w/o breaking the ABI for ifmcstat. 281 */ 282 struct in_multi { 283 LIST_ENTRY(in_multi) inm_link; /* to-be-released by in_ifdetach */ 284 struct in_addr inm_addr; /* IP multicast address, convenience */ 285 struct ifnet *inm_ifp; /* back pointer to ifnet */ 286 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */ 287 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */ 288 u_int inm_state; /* state of the membership */ 289 void *inm_rti; /* unused, legacy field */ 290 u_int inm_refcount; /* reference count */ 291 292 /* New fields for IGMPv3 follow. */ 293 struct igmp_ifinfo *inm_igi; /* IGMP info */ 294 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */ 295 struct ip_msource_tree inm_srcs; /* tree of sources */ 296 u_long inm_nsrc; /* # of tree entries */ 297 298 struct ifqueue inm_scq; /* queue of pending 299 * state-change packets */ 300 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */ 301 uint16_t inm_sctimer; /* state-change timer */ 302 uint16_t inm_scrv; /* state-change rexmit count */ 303 304 /* 305 * SSM state counters which track state at T0 (the time the last 306 * state-change report's RV timer went to zero) and T1 307 * (time of pending report, i.e. now). 308 * Used for computing IGMPv3 state-change reports. Several refcounts 309 * are maintained here to optimize for common use-cases. 310 */ 311 struct inm_st { 312 uint16_t iss_fmode; /* IGMP filter mode */ 313 uint16_t iss_asm; /* # of ASM listeners */ 314 uint16_t iss_ex; /* # of exclusive members */ 315 uint16_t iss_in; /* # of inclusive members */ 316 uint16_t iss_rec; /* # of recorded sources */ 317 } inm_st[2]; /* state at t0, t1 */ 318 }; 319 320 /* 321 * Helper function to derive the filter mode on a source entry 322 * from its internal counters. Predicates are: 323 * A source is only excluded if all listeners exclude it. 324 * A source is only included if no listeners exclude it, 325 * and at least one listener includes it. 326 * May be used by ifmcstat(8). 327 */ 328 static __inline uint8_t 329 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims, 330 uint8_t t) 331 { 332 333 t = !!t; 334 if (inm->inm_st[t].iss_ex > 0 && 335 inm->inm_st[t].iss_ex == ims->ims_st[t].ex) 336 return (MCAST_EXCLUDE); 337 else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0) 338 return (MCAST_INCLUDE); 339 return (MCAST_UNDEFINED); 340 } 341 342 #ifdef _KERNEL 343 344 #ifdef SYSCTL_DECL 345 SYSCTL_DECL(_net_inet); 346 SYSCTL_DECL(_net_inet_ip); 347 SYSCTL_DECL(_net_inet_raw); 348 #endif 349 350 /* 351 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes 352 * before link layer multicast locks in the lock order. In most cases, 353 * consumers of IN_*_MULTI() macros should acquire the locks before 354 * calling them; users of the in_{add,del}multi() functions should not. 355 */ 356 extern struct mtx in_multi_mtx; 357 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx) 358 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx) 359 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED) 360 #define IN_MULTI_UNLOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_NOTOWNED) 361 362 /* 363 * Function for looking up an in_multi record for an IPv4 multicast address 364 * on a given interface. ifp must be valid. If no record found, return NULL. 365 * The IN_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held. 366 */ 367 static __inline struct in_multi * 368 inm_lookup_locked(struct ifnet *ifp, const struct in_addr ina) 369 { 370 struct ifmultiaddr *ifma; 371 struct in_multi *inm; 372 373 IN_MULTI_LOCK_ASSERT(); 374 IF_ADDR_LOCK_ASSERT(ifp); 375 376 inm = NULL; 377 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { 378 if (ifma->ifma_addr->sa_family == AF_INET) { 379 inm = (struct in_multi *)ifma->ifma_protospec; 380 if (inm->inm_addr.s_addr == ina.s_addr) 381 break; 382 inm = NULL; 383 } 384 } 385 return (inm); 386 } 387 388 /* 389 * Wrapper for inm_lookup_locked(). 390 * The IF_ADDR_LOCK will be taken on ifp and released on return. 391 */ 392 static __inline struct in_multi * 393 inm_lookup(struct ifnet *ifp, const struct in_addr ina) 394 { 395 struct in_multi *inm; 396 397 IN_MULTI_LOCK_ASSERT(); 398 IF_ADDR_RLOCK(ifp); 399 inm = inm_lookup_locked(ifp, ina); 400 IF_ADDR_RUNLOCK(ifp); 401 402 return (inm); 403 } 404 405 /* Acquire an in_multi record. */ 406 static __inline void 407 inm_acquire_locked(struct in_multi *inm) 408 { 409 410 IN_MULTI_LOCK_ASSERT(); 411 ++inm->inm_refcount; 412 } 413 414 /* 415 * Return values for imo_multi_filter(). 416 */ 417 #define MCAST_PASS 0 /* Pass */ 418 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */ 419 #define MCAST_NOTSMEMBER 2 /* This host excluded source */ 420 #define MCAST_MUTED 3 /* [deprecated] */ 421 422 struct rtentry; 423 struct route; 424 struct ip_moptions; 425 426 int imo_multi_filter(const struct ip_moptions *, const struct ifnet *, 427 const struct sockaddr *, const struct sockaddr *); 428 void inm_commit(struct in_multi *); 429 void inm_clear_recorded(struct in_multi *); 430 void inm_print(const struct in_multi *); 431 int inm_record_source(struct in_multi *inm, const in_addr_t); 432 void inm_release(struct in_multi *); 433 void inm_release_locked(struct in_multi *); 434 struct in_multi * 435 in_addmulti(struct in_addr *, struct ifnet *); 436 void in_delmulti(struct in_multi *); 437 int in_joingroup(struct ifnet *, const struct in_addr *, 438 /*const*/ struct in_mfilter *, struct in_multi **); 439 int in_joingroup_locked(struct ifnet *, const struct in_addr *, 440 /*const*/ struct in_mfilter *, struct in_multi **); 441 int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *); 442 int in_leavegroup_locked(struct in_multi *, 443 /*const*/ struct in_mfilter *); 444 int in_control(struct socket *, u_long, caddr_t, struct ifnet *, 445 struct thread *); 446 void in_rtqdrain(void); 447 int in_addprefix(struct in_ifaddr *, int); 448 int in_scrubprefix(struct in_ifaddr *, u_int); 449 void ip_input(struct mbuf *); 450 int in_ifadown(struct ifaddr *ifa, int); 451 void in_ifscrub(struct ifnet *, struct in_ifaddr *, u_int); 452 struct mbuf *ip_fastforward(struct mbuf *); 453 void *in_domifattach(struct ifnet *); 454 void in_domifdetach(struct ifnet *, void *); 455 456 457 /* XXX */ 458 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum); 459 void in_rtalloc(struct route *ro, u_int fibnum); 460 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int); 461 void in_rtredirect(struct sockaddr *, struct sockaddr *, 462 struct sockaddr *, int, struct sockaddr *, u_int); 463 int in_rtrequest(int, struct sockaddr *, 464 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int); 465 466 #if 0 467 int in_rt_getifa(struct rt_addrinfo *, u_int fibnum); 468 int in_rtioctl(u_long, caddr_t, u_int); 469 int in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int); 470 #endif 471 #endif /* _KERNEL */ 472 473 /* INET6 stuff */ 474 #include <netinet6/in6_var.h> 475 476 #endif /* _NETINET_IN_VAR_H_ */ 477