1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1985, 1986, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)in_var.h 8.2 (Berkeley) 1/9/95 32 * $FreeBSD$ 33 */ 34 35 #ifndef _NETINET_IN_VAR_H_ 36 #define _NETINET_IN_VAR_H_ 37 38 /* 39 * Argument structure for SIOCAIFADDR. 40 */ 41 struct in_aliasreq { 42 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 43 struct sockaddr_in ifra_addr; 44 struct sockaddr_in ifra_broadaddr; 45 #define ifra_dstaddr ifra_broadaddr 46 struct sockaddr_in ifra_mask; 47 int ifra_vhid; 48 }; 49 50 #ifdef _KERNEL 51 #include <sys/queue.h> 52 #include <sys/fnv_hash.h> 53 #include <sys/tree.h> 54 55 struct igmp_ifsoftc; 56 struct in_multi; 57 struct lltable; 58 59 /* 60 * IPv4 per-interface state. 61 */ 62 struct in_ifinfo { 63 struct lltable *ii_llt; /* ARP state */ 64 struct igmp_ifsoftc *ii_igmp; /* IGMP state */ 65 struct in_multi *ii_allhosts; /* 224.0.0.1 membership */ 66 }; 67 68 /* 69 * Interface address, Internet version. One of these structures 70 * is allocated for each Internet address on an interface. 71 * The ifaddr structure contains the protocol-independent part 72 * of the structure and is assumed to be first. 73 */ 74 struct in_ifaddr { 75 struct ifaddr ia_ifa; /* protocol-independent info */ 76 #define ia_ifp ia_ifa.ifa_ifp 77 #define ia_flags ia_ifa.ifa_flags 78 /* ia_subnet{,mask} in host order */ 79 u_long ia_subnet; /* subnet address */ 80 u_long ia_subnetmask; /* mask of subnet */ 81 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */ 82 TAILQ_ENTRY(in_ifaddr) ia_link; /* list of internet addresses */ 83 struct sockaddr_in ia_addr; /* reserve space for interface name */ 84 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ 85 #define ia_broadaddr ia_dstaddr 86 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ 87 struct callout ia_garp_timer; /* timer for retransmitting GARPs */ 88 int ia_garp_count; /* count of retransmitted GARPs */ 89 }; 90 91 /* 92 * Given a pointer to an in_ifaddr (ifaddr), 93 * return a pointer to the addr as a sockaddr_in. 94 */ 95 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) 96 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr)) 97 #define IA_MASKSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_sockmask)) 98 99 #define IN_LNAOF(in, ifa) \ 100 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask)) 101 102 extern u_char inetctlerrmap[]; 103 104 #define LLTABLE(ifp) \ 105 ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt 106 /* 107 * Hash table for IP addresses. 108 */ 109 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); 110 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); 111 112 VNET_DECLARE(struct in_ifaddrhashhead *, in_ifaddrhashtbl); 113 VNET_DECLARE(struct in_ifaddrhead, in_ifaddrhead); 114 VNET_DECLARE(u_long, in_ifaddrhmask); /* mask for hash table */ 115 116 #define V_in_ifaddrhashtbl VNET(in_ifaddrhashtbl) 117 #define V_in_ifaddrhead VNET(in_ifaddrhead) 118 #define V_in_ifaddrhmask VNET(in_ifaddrhmask) 119 120 #define INADDR_NHASH_LOG2 9 121 #define INADDR_NHASH (1 << INADDR_NHASH_LOG2) 122 #define INADDR_HASHVAL(x) fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT) 123 #define INADDR_HASH(x) \ 124 (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask]) 125 126 extern struct rmlock in_ifaddr_lock; 127 128 #define IN_IFADDR_LOCK_ASSERT() rm_assert(&in_ifaddr_lock, RA_LOCKED) 129 #define IN_IFADDR_RLOCK(t) rm_rlock(&in_ifaddr_lock, (t)) 130 #define IN_IFADDR_RLOCK_ASSERT() rm_assert(&in_ifaddr_lock, RA_RLOCKED) 131 #define IN_IFADDR_RUNLOCK(t) rm_runlock(&in_ifaddr_lock, (t)) 132 #define IN_IFADDR_WLOCK() rm_wlock(&in_ifaddr_lock) 133 #define IN_IFADDR_WLOCK_ASSERT() rm_assert(&in_ifaddr_lock, RA_WLOCKED) 134 #define IN_IFADDR_WUNLOCK() rm_wunlock(&in_ifaddr_lock) 135 136 /* 137 * Macro for finding the internet address structure (in_ifaddr) 138 * corresponding to one of our IP addresses (in_addr). 139 */ 140 #define INADDR_TO_IFADDR(addr, ia) \ 141 /* struct in_addr addr; */ \ 142 /* struct in_ifaddr *ia; */ \ 143 do { \ 144 \ 145 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \ 146 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \ 147 break; \ 148 } while (0) 149 150 /* 151 * Macro for finding the interface (ifnet structure) corresponding to one 152 * of our IP addresses. 153 */ 154 #define INADDR_TO_IFP(addr, ifp) \ 155 /* struct in_addr addr; */ \ 156 /* struct ifnet *ifp; */ \ 157 { \ 158 struct in_ifaddr *ia; \ 159 \ 160 INADDR_TO_IFADDR(addr, ia); \ 161 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \ 162 } 163 164 /* 165 * Macro for finding the internet address structure (in_ifaddr) corresponding 166 * to a given interface (ifnet structure). 167 */ 168 #define IFP_TO_IA(ifp, ia, t) \ 169 /* struct ifnet *ifp; */ \ 170 /* struct in_ifaddr *ia; */ \ 171 /* struct rm_priotracker *t; */ \ 172 do { \ 173 IN_IFADDR_RLOCK((t)); \ 174 for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \ 175 (ia) != NULL && (ia)->ia_ifp != (ifp); \ 176 (ia) = TAILQ_NEXT((ia), ia_link)) \ 177 continue; \ 178 if ((ia) != NULL) \ 179 ifa_ref(&(ia)->ia_ifa); \ 180 IN_IFADDR_RUNLOCK((t)); \ 181 } while (0) 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 * IPv4 multicast IGMP-layer source entry. 195 */ 196 struct ip_msource { 197 RB_ENTRY(ip_msource) ims_link; /* RB tree links */ 198 in_addr_t ims_haddr; /* host byte order */ 199 struct ims_st { 200 uint16_t ex; /* # of exclusive members */ 201 uint16_t in; /* # of inclusive members */ 202 } ims_st[2]; /* state at t0, t1 */ 203 uint8_t ims_stp; /* pending query */ 204 }; 205 206 /* 207 * IPv4 multicast PCB-layer source entry. 208 */ 209 struct in_msource { 210 RB_ENTRY(ip_msource) ims_link; /* RB tree links */ 211 in_addr_t ims_haddr; /* host byte order */ 212 uint8_t imsl_st[2]; /* state before/at commit */ 213 }; 214 215 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */ 216 217 static __inline int 218 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b) 219 { 220 221 if (a->ims_haddr < b->ims_haddr) 222 return (-1); 223 if (a->ims_haddr == b->ims_haddr) 224 return (0); 225 return (1); 226 } 227 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp); 228 229 /* 230 * IPv4 multicast PCB-layer group filter descriptor. 231 */ 232 struct in_mfilter { 233 struct ip_msource_tree imf_sources; /* source list for (S,G) */ 234 u_long imf_nsrc; /* # of source entries */ 235 uint8_t imf_st[2]; /* state before/at commit */ 236 }; 237 238 /* 239 * IPv4 group descriptor. 240 * 241 * For every entry on an ifnet's if_multiaddrs list which represents 242 * an IP multicast group, there is one of these structures. 243 * 244 * If any source filters are present, then a node will exist in the RB-tree 245 * to permit fast lookup by source whenever an operation takes place. 246 * This permits pre-order traversal when we issue reports. 247 * Source filter trees are kept separately from the socket layer to 248 * greatly simplify locking. 249 * 250 * When IGMPv3 is active, inm_timer is the response to group query timer. 251 * The state-change timer inm_sctimer is separate; whenever state changes 252 * for the group the state change record is generated and transmitted, 253 * and kept if retransmissions are necessary. 254 * 255 * FUTURE: inm_link is now only used when groups are being purged 256 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but 257 * because it is at the very start of the struct, we can't do this 258 * w/o breaking the ABI for ifmcstat. 259 */ 260 struct in_multi { 261 LIST_ENTRY(in_multi) inm_link; /* to-be-released by in_ifdetach */ 262 struct in_addr inm_addr; /* IP multicast address, convenience */ 263 struct ifnet *inm_ifp; /* back pointer to ifnet */ 264 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */ 265 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */ 266 u_int inm_state; /* state of the membership */ 267 void *inm_rti; /* unused, legacy field */ 268 u_int inm_refcount; /* reference count */ 269 270 /* New fields for IGMPv3 follow. */ 271 struct igmp_ifsoftc *inm_igi; /* IGMP info */ 272 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */ 273 struct ip_msource_tree inm_srcs; /* tree of sources */ 274 u_long inm_nsrc; /* # of tree entries */ 275 276 struct mbufq inm_scq; /* queue of pending 277 * state-change packets */ 278 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */ 279 uint16_t inm_sctimer; /* state-change timer */ 280 uint16_t inm_scrv; /* state-change rexmit count */ 281 282 /* 283 * SSM state counters which track state at T0 (the time the last 284 * state-change report's RV timer went to zero) and T1 285 * (time of pending report, i.e. now). 286 * Used for computing IGMPv3 state-change reports. Several refcounts 287 * are maintained here to optimize for common use-cases. 288 */ 289 struct inm_st { 290 uint16_t iss_fmode; /* IGMP filter mode */ 291 uint16_t iss_asm; /* # of ASM listeners */ 292 uint16_t iss_ex; /* # of exclusive members */ 293 uint16_t iss_in; /* # of inclusive members */ 294 uint16_t iss_rec; /* # of recorded sources */ 295 } inm_st[2]; /* state at t0, t1 */ 296 }; 297 298 /* 299 * Helper function to derive the filter mode on a source entry 300 * from its internal counters. Predicates are: 301 * A source is only excluded if all listeners exclude it. 302 * A source is only included if no listeners exclude it, 303 * and at least one listener includes it. 304 * May be used by ifmcstat(8). 305 */ 306 static __inline uint8_t 307 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims, 308 uint8_t t) 309 { 310 311 t = !!t; 312 if (inm->inm_st[t].iss_ex > 0 && 313 inm->inm_st[t].iss_ex == ims->ims_st[t].ex) 314 return (MCAST_EXCLUDE); 315 else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0) 316 return (MCAST_INCLUDE); 317 return (MCAST_UNDEFINED); 318 } 319 320 #ifdef SYSCTL_DECL 321 SYSCTL_DECL(_net_inet); 322 SYSCTL_DECL(_net_inet_ip); 323 SYSCTL_DECL(_net_inet_raw); 324 #endif 325 326 /* 327 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes 328 * before link layer multicast locks in the lock order. In most cases, 329 * consumers of IN_*_MULTI() macros should acquire the locks before 330 * calling them; users of the in_{add,del}multi() functions should not. 331 */ 332 extern struct mtx in_multi_mtx; 333 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx) 334 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx) 335 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED) 336 #define IN_MULTI_UNLOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_NOTOWNED) 337 338 /* Acquire an in_multi record. */ 339 static __inline void 340 inm_acquire_locked(struct in_multi *inm) 341 { 342 343 IN_MULTI_LOCK_ASSERT(); 344 ++inm->inm_refcount; 345 } 346 347 /* 348 * Return values for imo_multi_filter(). 349 */ 350 #define MCAST_PASS 0 /* Pass */ 351 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */ 352 #define MCAST_NOTSMEMBER 2 /* This host excluded source */ 353 #define MCAST_MUTED 3 /* [deprecated] */ 354 355 struct rtentry; 356 struct route; 357 struct ip_moptions; 358 359 struct in_multi *inm_lookup_locked(struct ifnet *, const struct in_addr); 360 struct in_multi *inm_lookup(struct ifnet *, const struct in_addr); 361 int imo_multi_filter(const struct ip_moptions *, const struct ifnet *, 362 const struct sockaddr *, const struct sockaddr *); 363 void inm_commit(struct in_multi *); 364 void inm_clear_recorded(struct in_multi *); 365 void inm_print(const struct in_multi *); 366 int inm_record_source(struct in_multi *inm, const in_addr_t); 367 void inm_release(struct in_multi *); 368 void inm_release_locked(struct in_multi *); 369 struct in_multi * 370 in_addmulti(struct in_addr *, struct ifnet *); 371 void in_delmulti(struct in_multi *); 372 int in_joingroup(struct ifnet *, const struct in_addr *, 373 /*const*/ struct in_mfilter *, struct in_multi **); 374 int in_joingroup_locked(struct ifnet *, const struct in_addr *, 375 /*const*/ struct in_mfilter *, struct in_multi **); 376 int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *); 377 int in_leavegroup_locked(struct in_multi *, 378 /*const*/ struct in_mfilter *); 379 int in_control(struct socket *, u_long, caddr_t, struct ifnet *, 380 struct thread *); 381 int in_addprefix(struct in_ifaddr *, int); 382 int in_scrubprefix(struct in_ifaddr *, u_int); 383 void in_ifscrub_all(void); 384 void ip_input(struct mbuf *); 385 void ip_direct_input(struct mbuf *); 386 void in_ifadown(struct ifaddr *ifa, int); 387 struct mbuf *ip_tryforward(struct mbuf *); 388 void *in_domifattach(struct ifnet *); 389 void in_domifdetach(struct ifnet *, void *); 390 391 392 /* XXX */ 393 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum); 394 void in_rtredirect(struct sockaddr *, struct sockaddr *, 395 struct sockaddr *, int, struct sockaddr *, u_int); 396 #endif /* _KERNEL */ 397 398 /* INET6 stuff */ 399 #include <netinet6/in6_var.h> 400 401 #endif /* _NETINET_IN_VAR_H_ */ 402