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 32 #ifndef _NETINET_IN_VAR_H_ 33 #define _NETINET_IN_VAR_H_ 34 35 /* 36 * Argument structure for SIOCAIFADDR. 37 */ 38 struct in_aliasreq { 39 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 40 struct sockaddr_in ifra_addr; 41 struct sockaddr_in ifra_broadaddr; 42 #define ifra_dstaddr ifra_broadaddr 43 struct sockaddr_in ifra_mask; 44 int ifra_vhid; 45 }; 46 47 #ifdef _KERNEL 48 #include <sys/queue.h> 49 #include <sys/fnv_hash.h> 50 #include <sys/tree.h> 51 52 struct igmp_ifsoftc; 53 struct in_multi; 54 struct lltable; 55 SLIST_HEAD(in_multi_head, in_multi); 56 57 /* 58 * IPv4 per-interface state. 59 */ 60 struct in_ifinfo { 61 struct lltable *ii_llt; /* ARP state */ 62 struct igmp_ifsoftc *ii_igmp; /* IGMP state */ 63 struct in_multi *ii_allhosts; /* 224.0.0.1 membership */ 64 }; 65 66 /* 67 * Interface address, Internet version. One of these structures 68 * is allocated for each Internet address on an interface. 69 * The ifaddr structure contains the protocol-independent part 70 * of the structure and is assumed to be first. 71 */ 72 struct in_ifaddr { 73 struct ifaddr ia_ifa; /* protocol-independent info */ 74 #define ia_ifp ia_ifa.ifa_ifp 75 #define ia_flags ia_ifa.ifa_flags 76 /* ia_subnet{,mask} in host order */ 77 u_long ia_subnet; /* subnet address */ 78 u_long ia_subnetmask; /* mask of subnet */ 79 CK_LIST_ENTRY(in_ifaddr) ia_hash; /* hash of internet addresses */ 80 CK_STAILQ_ENTRY(in_ifaddr) ia_link; /* list of internet addresses */ 81 struct sockaddr_in ia_addr; /* reserve space for interface name */ 82 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ 83 #define ia_broadaddr ia_dstaddr 84 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ 85 struct callout ia_garp_timer; /* timer for retransmitting GARPs */ 86 int ia_garp_count; /* count of retransmitted GARPs */ 87 }; 88 89 /* 90 * Given a pointer to an in_ifaddr (ifaddr), 91 * return a pointer to the addr as a sockaddr_in. 92 */ 93 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) 94 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr)) 95 #define IA_MASKSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_sockmask)) 96 97 #define IN_LNAOF(in, ifa) \ 98 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask)) 99 100 #ifdef _KERNEL 101 #define IN_ARE_MASKED_ADDR_EQUAL(d, a, m) ( \ 102 ((((d).s_addr ^ (a).s_addr) & (m).s_addr)) == 0 ) 103 #endif 104 105 #define LLTABLE(ifp) ((struct in_ifinfo *)(ifp)->if_inet)->ii_llt 106 /* 107 * Hash table for IP addresses. 108 */ 109 CK_STAILQ_HEAD(in_ifaddrhead, in_ifaddr); 110 CK_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 /* 127 * Macro for finding the internet address structure (in_ifaddr) 128 * corresponding to one of our IP addresses (in_addr). 129 */ 130 #define INADDR_TO_IFADDR(addr, ia) \ 131 /* struct in_addr addr; */ \ 132 /* struct in_ifaddr *ia; */ \ 133 do { \ 134 NET_EPOCH_ASSERT(); \ 135 CK_LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \ 136 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \ 137 break; \ 138 } while (0) 139 140 /* 141 * Macro for finding the interface (ifnet structure) corresponding to one 142 * of our IP addresses. 143 */ 144 #define INADDR_TO_IFP(addr, ifp) \ 145 /* struct in_addr addr; */ \ 146 /* struct ifnet *ifp; */ \ 147 { \ 148 struct in_ifaddr *ia; \ 149 \ 150 INADDR_TO_IFADDR(addr, ia); \ 151 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \ 152 } 153 154 /* 155 * Macro for finding the internet address structure (in_ifaddr) corresponding 156 * to a given interface (ifnet structure). 157 */ 158 #define IFP_TO_IA(ifp, ia) \ 159 /* struct ifnet *ifp; */ \ 160 /* struct in_ifaddr *ia; */ \ 161 do { \ 162 NET_EPOCH_ASSERT(); \ 163 for ((ia) = CK_STAILQ_FIRST(&V_in_ifaddrhead); \ 164 (ia) != NULL && (ia)->ia_ifp != (ifp); \ 165 (ia) = CK_STAILQ_NEXT((ia), ia_link)) \ 166 continue; \ 167 } while (0) 168 169 /* 170 * Legacy IPv4 IGMP per-link structure. 171 */ 172 struct router_info { 173 struct ifnet *rti_ifp; 174 int rti_type; /* type of router which is querier on this interface */ 175 int rti_time; /* # of slow timeouts since last old query */ 176 SLIST_ENTRY(router_info) rti_list; 177 }; 178 179 /* 180 * IPv4 multicast IGMP-layer source entry. 181 */ 182 struct ip_msource { 183 RB_ENTRY(ip_msource) ims_link; /* RB tree links */ 184 in_addr_t ims_haddr; /* host byte order */ 185 struct ims_st { 186 uint16_t ex; /* # of exclusive members */ 187 uint16_t in; /* # of inclusive members */ 188 } ims_st[2]; /* state at t0, t1 */ 189 uint8_t ims_stp; /* pending query */ 190 }; 191 192 /* 193 * IPv4 multicast PCB-layer source entry. 194 */ 195 struct in_msource { 196 RB_ENTRY(ip_msource) ims_link; /* RB tree links */ 197 in_addr_t ims_haddr; /* host byte order */ 198 uint8_t imsl_st[2]; /* state before/at commit */ 199 }; 200 201 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */ 202 203 static __inline int 204 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b) 205 { 206 207 if (a->ims_haddr < b->ims_haddr) 208 return (-1); 209 if (a->ims_haddr == b->ims_haddr) 210 return (0); 211 return (1); 212 } 213 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp); 214 215 /* 216 * IPv4 multicast PCB-layer group filter descriptor. 217 */ 218 struct in_mfilter { 219 struct ip_msource_tree imf_sources; /* source list for (S,G) */ 220 u_long imf_nsrc; /* # of source entries */ 221 uint8_t imf_st[2]; /* state before/at commit */ 222 struct in_multi *imf_inm; /* associated multicast address */ 223 STAILQ_ENTRY(in_mfilter) imf_entry; /* list entry */ 224 }; 225 226 /* 227 * Helper types and functions for IPv4 multicast filters. 228 */ 229 STAILQ_HEAD(ip_mfilter_head, in_mfilter); 230 231 struct in_mfilter *ip_mfilter_alloc(int mflags, int st0, int st1); 232 void ip_mfilter_free(struct in_mfilter *); 233 234 static inline void 235 ip_mfilter_init(struct ip_mfilter_head *head) 236 { 237 238 STAILQ_INIT(head); 239 } 240 241 static inline struct in_mfilter * 242 ip_mfilter_first(const struct ip_mfilter_head *head) 243 { 244 245 return (STAILQ_FIRST(head)); 246 } 247 248 static inline void 249 ip_mfilter_insert(struct ip_mfilter_head *head, struct in_mfilter *imf) 250 { 251 252 STAILQ_INSERT_TAIL(head, imf, imf_entry); 253 } 254 255 static inline void 256 ip_mfilter_remove(struct ip_mfilter_head *head, struct in_mfilter *imf) 257 { 258 259 STAILQ_REMOVE(head, imf, in_mfilter, imf_entry); 260 } 261 262 #define IP_MFILTER_FOREACH(imf, head) \ 263 STAILQ_FOREACH(imf, head, imf_entry) 264 265 static inline size_t 266 ip_mfilter_count(struct ip_mfilter_head *head) 267 { 268 struct in_mfilter *imf; 269 size_t num = 0; 270 271 STAILQ_FOREACH(imf, head, imf_entry) 272 num++; 273 return (num); 274 } 275 276 /* 277 * IPv4 group descriptor. 278 * 279 * For every entry on an ifnet's if_multiaddrs list which represents 280 * an IP multicast group, there is one of these structures. 281 * 282 * If any source filters are present, then a node will exist in the RB-tree 283 * to permit fast lookup by source whenever an operation takes place. 284 * This permits pre-order traversal when we issue reports. 285 * Source filter trees are kept separately from the socket layer to 286 * greatly simplify locking. 287 * 288 * When IGMPv3 is active, inm_timer is the response to group query timer. 289 * The state-change timer inm_sctimer is separate; whenever state changes 290 * for the group the state change record is generated and transmitted, 291 * and kept if retransmissions are necessary. 292 * 293 * FUTURE: inm_link is now only used when groups are being purged 294 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but 295 * because it is at the very start of the struct, we can't do this 296 * w/o breaking the ABI for ifmcstat. 297 */ 298 struct in_multi { 299 LIST_ENTRY(in_multi) inm_link; /* to-be-released by in_ifdetach */ 300 struct in_addr inm_addr; /* IP multicast address, convenience */ 301 struct ifnet *inm_ifp; /* back pointer to ifnet */ 302 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */ 303 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */ 304 u_int inm_state; /* state of the membership */ 305 void *inm_rti; /* unused, legacy field */ 306 u_int inm_refcount; /* reference count */ 307 308 /* New fields for IGMPv3 follow. */ 309 struct igmp_ifsoftc *inm_igi; /* IGMP info */ 310 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */ 311 struct ip_msource_tree inm_srcs; /* tree of sources */ 312 u_long inm_nsrc; /* # of tree entries */ 313 314 struct mbufq inm_scq; /* queue of pending 315 * state-change packets */ 316 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */ 317 uint16_t inm_sctimer; /* state-change timer */ 318 uint16_t inm_scrv; /* state-change rexmit count */ 319 320 /* 321 * SSM state counters which track state at T0 (the time the last 322 * state-change report's RV timer went to zero) and T1 323 * (time of pending report, i.e. now). 324 * Used for computing IGMPv3 state-change reports. Several refcounts 325 * are maintained here to optimize for common use-cases. 326 */ 327 struct inm_st { 328 uint16_t iss_fmode; /* IGMP filter mode */ 329 uint16_t iss_asm; /* # of ASM listeners */ 330 uint16_t iss_ex; /* # of exclusive members */ 331 uint16_t iss_in; /* # of inclusive members */ 332 uint16_t iss_rec; /* # of recorded sources */ 333 } inm_st[2]; /* state at t0, t1 */ 334 }; 335 336 /* 337 * Helper function to derive the filter mode on a source entry 338 * from its internal counters. Predicates are: 339 * A source is only excluded if all listeners exclude it. 340 * A source is only included if no listeners exclude it, 341 * and at least one listener includes it. 342 * May be used by ifmcstat(8). 343 */ 344 static __inline uint8_t 345 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims, 346 uint8_t t) 347 { 348 349 t = !!t; 350 if (inm->inm_st[t].iss_ex > 0 && 351 inm->inm_st[t].iss_ex == ims->ims_st[t].ex) 352 return (MCAST_EXCLUDE); 353 else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0) 354 return (MCAST_INCLUDE); 355 return (MCAST_UNDEFINED); 356 } 357 358 #ifdef SYSCTL_DECL 359 SYSCTL_DECL(_net_inet); 360 SYSCTL_DECL(_net_inet_ip); 361 SYSCTL_DECL(_net_inet_raw); 362 #endif 363 364 /* 365 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes 366 * before link layer multicast locks in the lock order. In most cases, 367 * consumers of IN_*_MULTI() macros should acquire the locks before 368 * calling them; users of the in_{add,del}multi() functions should not. 369 */ 370 extern struct mtx in_multi_list_mtx; 371 extern struct sx in_multi_sx; 372 373 #define IN_MULTI_LIST_LOCK() mtx_lock(&in_multi_list_mtx) 374 #define IN_MULTI_LIST_UNLOCK() mtx_unlock(&in_multi_list_mtx) 375 #define IN_MULTI_LIST_LOCK_ASSERT() mtx_assert(&in_multi_list_mtx, MA_OWNED) 376 #define IN_MULTI_LIST_UNLOCK_ASSERT() mtx_assert(&in_multi_list_mtx, MA_NOTOWNED) 377 378 #define IN_MULTI_LOCK() sx_xlock(&in_multi_sx) 379 #define IN_MULTI_UNLOCK() sx_xunlock(&in_multi_sx) 380 #define IN_MULTI_LOCK_ASSERT() sx_assert(&in_multi_sx, SA_XLOCKED) 381 #define IN_MULTI_UNLOCK_ASSERT() sx_assert(&in_multi_sx, SA_XUNLOCKED) 382 383 void inm_disconnect(struct in_multi *inm); 384 385 /* 386 * Get the in_multi pointer from a ifmultiaddr. 387 * Returns NULL if ifmultiaddr is no longer valid. 388 */ 389 static __inline struct in_multi * 390 inm_ifmultiaddr_get_inm(struct ifmultiaddr *ifma) 391 { 392 393 NET_EPOCH_ASSERT(); 394 395 return ((ifma->ifma_addr->sa_family != AF_INET || 396 (ifma->ifma_flags & IFMA_F_ENQUEUED) == 0) ? NULL : 397 ifma->ifma_protospec); 398 } 399 400 /* Acquire an in_multi record. */ 401 static __inline void 402 inm_acquire_locked(struct in_multi *inm) 403 { 404 405 IN_MULTI_LIST_LOCK_ASSERT(); 406 ++inm->inm_refcount; 407 } 408 409 static __inline void 410 inm_acquire(struct in_multi *inm) 411 { 412 IN_MULTI_LIST_LOCK(); 413 inm_acquire_locked(inm); 414 IN_MULTI_LIST_UNLOCK(); 415 } 416 417 static __inline void 418 inm_rele_locked(struct in_multi_head *inmh, struct in_multi *inm) 419 { 420 MPASS(inm->inm_refcount > 0); 421 IN_MULTI_LIST_LOCK_ASSERT(); 422 423 if (--inm->inm_refcount == 0) { 424 MPASS(inmh != NULL); 425 inm_disconnect(inm); 426 inm->inm_ifma->ifma_protospec = NULL; 427 SLIST_INSERT_HEAD(inmh, inm, inm_nrele); 428 } 429 } 430 431 /* 432 * Return values for imo_multi_filter(). 433 */ 434 #define MCAST_PASS 0 /* Pass */ 435 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */ 436 #define MCAST_NOTSMEMBER 2 /* This host excluded source */ 437 #define MCAST_MUTED 3 /* [deprecated] */ 438 439 struct rib_head; 440 struct ip_moptions; 441 struct ucred; 442 443 struct in_multi *inm_lookup_locked(struct ifnet *, const struct in_addr); 444 struct in_multi *inm_lookup(struct ifnet *, const struct in_addr); 445 int imo_multi_filter(const struct ip_moptions *, const struct ifnet *, 446 const struct sockaddr *, const struct sockaddr *); 447 void inm_commit(struct in_multi *); 448 void inm_clear_recorded(struct in_multi *); 449 void inm_print(const struct in_multi *); 450 int inm_record_source(struct in_multi *inm, const in_addr_t); 451 void inm_release_deferred(struct in_multi *); 452 void inm_release_list_deferred(struct in_multi_head *); 453 void inm_release_wait(void *); 454 int in_joingroup(struct ifnet *, const struct in_addr *, 455 /*const*/ struct in_mfilter *, struct in_multi **); 456 int in_joingroup_locked(struct ifnet *, const struct in_addr *, 457 /*const*/ struct in_mfilter *, struct in_multi **); 458 int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *); 459 int in_leavegroup_locked(struct in_multi *, 460 /*const*/ struct in_mfilter *); 461 int in_mask2len(struct in_addr *); 462 int in_control(struct socket *, u_long, void *, struct ifnet *, 463 struct thread *); 464 int in_control_ioctl(u_long, void *, struct ifnet *, 465 struct ucred *); 466 int in_addprefix(struct in_ifaddr *); 467 int in_scrubprefix(struct in_ifaddr *, u_int); 468 void in_ifscrub_all(void); 469 void ip_input(struct mbuf *); 470 void ip_direct_input(struct mbuf *); 471 void in_ifadown(struct ifaddr *ifa, int); 472 struct mbuf *ip_tryforward(struct mbuf *); 473 struct rib_head *in_inithead(uint32_t fibnum); 474 void in_ifattach(void *, struct ifnet *); 475 476 #ifdef VIMAGE 477 void in_detachhead(struct rib_head *rh); 478 #endif 479 480 #endif /* _KERNEL */ 481 482 /* INET6 stuff */ 483 #include <netinet6/in6_var.h> 484 485 #endif /* _NETINET_IN_VAR_H_ */ 486