2 * Copyright (c) 1985, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * @(#)in_var.h 8.2 (Berkeley) 1/9/95
33 #ifndef _NETINET_IN_VAR_H_
34 #define _NETINET_IN_VAR_H_
36 #include <sys/queue.h>
37 #include <sys/fnv_hash.h>
45 * IPv4 per-interface state.
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 */
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.
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 */
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;
83 * Given a pointer to an in_ifaddr (ifaddr),
84 * return a pointer to the addr as a sockaddr_in.
86 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
87 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
89 #define IN_LNAOF(in, ifa) \
90 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
94 extern u_char inetctlerrmap[];
96 #define LLTABLE(ifp) \
97 ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt
99 * Hash table for IP addresses.
101 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);
102 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);
104 VNET_DECLARE(struct in_ifaddrhashhead *, in_ifaddrhashtbl);
105 VNET_DECLARE(struct in_ifaddrhead, in_ifaddrhead);
106 VNET_DECLARE(u_long, in_ifaddrhmask); /* mask for hash table */
108 #define V_in_ifaddrhashtbl VNET(in_ifaddrhashtbl)
109 #define V_in_ifaddrhead VNET(in_ifaddrhead)
110 #define V_in_ifaddrhmask VNET(in_ifaddrhmask)
112 #define INADDR_NHASH_LOG2 9
113 #define INADDR_NHASH (1 << INADDR_NHASH_LOG2)
114 #define INADDR_HASHVAL(x) fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
115 #define INADDR_HASH(x) \
116 (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask])
118 extern struct rwlock in_ifaddr_lock;
120 #define IN_IFADDR_LOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_LOCKED)
121 #define IN_IFADDR_RLOCK() rw_rlock(&in_ifaddr_lock)
122 #define IN_IFADDR_RLOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_RLOCKED)
123 #define IN_IFADDR_RUNLOCK() rw_runlock(&in_ifaddr_lock)
124 #define IN_IFADDR_WLOCK() rw_wlock(&in_ifaddr_lock)
125 #define IN_IFADDR_WLOCK_ASSERT() rw_assert(&in_ifaddr_lock, RA_WLOCKED)
126 #define IN_IFADDR_WUNLOCK() rw_wunlock(&in_ifaddr_lock)
129 * Macro for finding the internet address structure (in_ifaddr)
130 * corresponding to one of our IP addresses (in_addr).
132 #define INADDR_TO_IFADDR(addr, ia) \
133 /* struct in_addr addr; */ \
134 /* struct in_ifaddr *ia; */ \
137 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
138 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
143 * Macro for finding the interface (ifnet structure) corresponding to one
144 * of our IP addresses.
146 #define INADDR_TO_IFP(addr, ifp) \
147 /* struct in_addr addr; */ \
148 /* struct ifnet *ifp; */ \
150 struct in_ifaddr *ia; \
152 INADDR_TO_IFADDR(addr, ia); \
153 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
157 * Macro for finding the internet address structure (in_ifaddr) corresponding
158 * to a given interface (ifnet structure).
160 #define IFP_TO_IA(ifp, ia) \
161 /* struct ifnet *ifp; */ \
162 /* struct in_ifaddr *ia; */ \
164 for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \
165 (ia) != NULL && (ia)->ia_ifp != (ifp); \
166 (ia) = TAILQ_NEXT((ia), ia_link)) \
169 ifa_ref(&(ia)->ia_ifa); \
174 * IP datagram reassembly.
176 #define IPREASS_NHASH_LOG2 6
177 #define IPREASS_NHASH (1 << IPREASS_NHASH_LOG2)
178 #define IPREASS_HMASK (IPREASS_NHASH - 1)
179 #define IPREASS_HASH(x,y) \
180 (((((x) & 0xF) | ((((x) >> 8) & 0xF) << 4)) ^ (y)) & IPREASS_HMASK)
183 * Legacy IPv4 IGMP per-link structure.
186 struct ifnet *rti_ifp;
187 int rti_type; /* type of router which is querier on this interface */
188 int rti_time; /* # of slow timeouts since last old query */
189 SLIST_ENTRY(router_info) rti_list;
193 * Per-interface IGMP router version information.
196 LIST_ENTRY(igmp_ifinfo) igi_link;
197 struct ifnet *igi_ifp; /* interface this instance belongs to */
198 uint32_t igi_version; /* IGMPv3 Host Compatibility Mode */
199 uint32_t igi_v1_timer; /* IGMPv1 Querier Present timer (s) */
200 uint32_t igi_v2_timer; /* IGMPv2 Querier Present timer (s) */
201 uint32_t igi_v3_timer; /* IGMPv3 General Query (interface) timer (s)*/
202 uint32_t igi_flags; /* IGMP per-interface flags */
203 uint32_t igi_rv; /* IGMPv3 Robustness Variable */
204 uint32_t igi_qi; /* IGMPv3 Query Interval (s) */
205 uint32_t igi_qri; /* IGMPv3 Query Response Interval (s) */
206 uint32_t igi_uri; /* IGMPv3 Unsolicited Report Interval (s) */
207 SLIST_HEAD(,in_multi) igi_relinmhead; /* released groups */
208 struct ifqueue igi_gq; /* queue of general query responses */
211 #define IGIF_SILENT 0x00000001 /* Do not use IGMP on this ifp */
212 #define IGIF_LOOPBACK 0x00000002 /* Send IGMP reports to loopback */
215 * IPv4 multicast IGMP-layer source entry.
218 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
219 in_addr_t ims_haddr; /* host byte order */
221 uint16_t ex; /* # of exclusive members */
222 uint16_t in; /* # of inclusive members */
223 } ims_st[2]; /* state at t0, t1 */
224 uint8_t ims_stp; /* pending query */
228 * IPv4 multicast PCB-layer source entry.
231 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
232 in_addr_t ims_haddr; /* host byte order */
233 uint8_t imsl_st[2]; /* state before/at commit */
236 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */
239 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b)
242 if (a->ims_haddr < b->ims_haddr)
244 if (a->ims_haddr == b->ims_haddr)
248 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);
251 * IPv4 multicast PCB-layer group filter descriptor.
254 struct ip_msource_tree imf_sources; /* source list for (S,G) */
255 u_long imf_nsrc; /* # of source entries */
256 uint8_t imf_st[2]; /* state before/at commit */
260 * IPv4 group descriptor.
262 * For every entry on an ifnet's if_multiaddrs list which represents
263 * an IP multicast group, there is one of these structures.
265 * If any source filters are present, then a node will exist in the RB-tree
266 * to permit fast lookup by source whenever an operation takes place.
267 * This permits pre-order traversal when we issue reports.
268 * Source filter trees are kept separately from the socket layer to
269 * greatly simplify locking.
271 * When IGMPv3 is active, inm_timer is the response to group query timer.
272 * The state-change timer inm_sctimer is separate; whenever state changes
273 * for the group the state change record is generated and transmitted,
274 * and kept if retransmissions are necessary.
276 * FUTURE: inm_link is now only used when groups are being purged
277 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
278 * because it is at the very start of the struct, we can't do this
279 * w/o breaking the ABI for ifmcstat.
282 LIST_ENTRY(in_multi) inm_link; /* to-be-released by in_ifdetach */
283 struct in_addr inm_addr; /* IP multicast address, convenience */
284 struct ifnet *inm_ifp; /* back pointer to ifnet */
285 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
286 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */
287 u_int inm_state; /* state of the membership */
288 void *inm_rti; /* unused, legacy field */
289 u_int inm_refcount; /* reference count */
291 /* New fields for IGMPv3 follow. */
292 struct igmp_ifinfo *inm_igi; /* IGMP info */
293 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */
294 struct ip_msource_tree inm_srcs; /* tree of sources */
295 u_long inm_nsrc; /* # of tree entries */
297 struct ifqueue inm_scq; /* queue of pending
298 * state-change packets */
299 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */
300 uint16_t inm_sctimer; /* state-change timer */
301 uint16_t inm_scrv; /* state-change rexmit count */
304 * SSM state counters which track state at T0 (the time the last
305 * state-change report's RV timer went to zero) and T1
306 * (time of pending report, i.e. now).
307 * Used for computing IGMPv3 state-change reports. Several refcounts
308 * are maintained here to optimize for common use-cases.
311 uint16_t iss_fmode; /* IGMP filter mode */
312 uint16_t iss_asm; /* # of ASM listeners */
313 uint16_t iss_ex; /* # of exclusive members */
314 uint16_t iss_in; /* # of inclusive members */
315 uint16_t iss_rec; /* # of recorded sources */
316 } inm_st[2]; /* state at t0, t1 */
320 * Helper function to derive the filter mode on a source entry
321 * from its internal counters. Predicates are:
322 * A source is only excluded if all listeners exclude it.
323 * A source is only included if no listeners exclude it,
324 * and at least one listener includes it.
325 * May be used by ifmcstat(8).
327 static __inline uint8_t
328 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims,
333 if (inm->inm_st[t].iss_ex > 0 &&
334 inm->inm_st[t].iss_ex == ims->ims_st[t].ex)
335 return (MCAST_EXCLUDE);
336 else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0)
337 return (MCAST_INCLUDE);
338 return (MCAST_UNDEFINED);
344 SYSCTL_DECL(_net_inet);
345 SYSCTL_DECL(_net_inet_ip);
346 SYSCTL_DECL(_net_inet_raw);
350 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes
351 * before link layer multicast locks in the lock order. In most cases,
352 * consumers of IN_*_MULTI() macros should acquire the locks before
353 * calling them; users of the in_{add,del}multi() functions should not.
355 extern struct mtx in_multi_mtx;
356 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx)
357 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx)
358 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED)
359 #define IN_MULTI_UNLOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_NOTOWNED)
362 * Function for looking up an in_multi record for an IPv4 multicast address
363 * on a given interface. ifp must be valid. If no record found, return NULL.
364 * The IN_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held.
366 static __inline struct in_multi *
367 inm_lookup_locked(struct ifnet *ifp, const struct in_addr ina)
369 struct ifmultiaddr *ifma;
370 struct in_multi *inm;
372 IN_MULTI_LOCK_ASSERT();
373 IF_ADDR_LOCK_ASSERT(ifp);
376 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) {
377 if (ifma->ifma_addr->sa_family == AF_INET) {
378 inm = (struct in_multi *)ifma->ifma_protospec;
379 if (inm->inm_addr.s_addr == ina.s_addr)
388 * Wrapper for inm_lookup_locked().
389 * The IF_ADDR_LOCK will be taken on ifp and released on return.
391 static __inline struct in_multi *
392 inm_lookup(struct ifnet *ifp, const struct in_addr ina)
394 struct in_multi *inm;
396 IN_MULTI_LOCK_ASSERT();
398 inm = inm_lookup_locked(ifp, ina);
404 /* Acquire an in_multi record. */
406 inm_acquire_locked(struct in_multi *inm)
409 IN_MULTI_LOCK_ASSERT();
414 * Return values for imo_multi_filter().
416 #define MCAST_PASS 0 /* Pass */
417 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */
418 #define MCAST_NOTSMEMBER 2 /* This host excluded source */
419 #define MCAST_MUTED 3 /* [deprecated] */
425 int imo_multi_filter(const struct ip_moptions *, const struct ifnet *,
426 const struct sockaddr *, const struct sockaddr *);
427 void inm_commit(struct in_multi *);
428 void inm_clear_recorded(struct in_multi *);
429 void inm_print(const struct in_multi *);
430 int inm_record_source(struct in_multi *inm, const in_addr_t);
431 void inm_release(struct in_multi *);
432 void inm_release_locked(struct in_multi *);
434 in_addmulti(struct in_addr *, struct ifnet *);
435 void in_delmulti(struct in_multi *);
436 int in_joingroup(struct ifnet *, const struct in_addr *,
437 /*const*/ struct in_mfilter *, struct in_multi **);
438 int in_joingroup_locked(struct ifnet *, const struct in_addr *,
439 /*const*/ struct in_mfilter *, struct in_multi **);
440 int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *);
441 int in_leavegroup_locked(struct in_multi *,
442 /*const*/ struct in_mfilter *);
443 int in_control(struct socket *, u_long, caddr_t, struct ifnet *,
445 void in_rtqdrain(void);
446 int in_addprefix(struct in_ifaddr *, int);
447 int in_scrubprefix(struct in_ifaddr *, u_int);
448 void ip_input(struct mbuf *);
449 int in_ifadown(struct ifaddr *ifa, int);
450 void in_ifscrub(struct ifnet *, struct in_ifaddr *, u_int);
451 struct mbuf *ip_fastforward(struct mbuf *);
452 void *in_domifattach(struct ifnet *);
453 void in_domifdetach(struct ifnet *, void *);
457 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum);
458 void in_rtalloc(struct route *ro, u_int fibnum);
459 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int);
460 void in_rtredirect(struct sockaddr *, struct sockaddr *,
461 struct sockaddr *, int, struct sockaddr *, u_int);
462 int in_rtrequest(int, struct sockaddr *,
463 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
466 int in_rt_getifa(struct rt_addrinfo *, u_int fibnum);
467 int in_rtioctl(u_long, caddr_t, u_int);
468 int in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int);
473 #include <netinet6/in6_var.h>
475 #endif /* _NETINET_IN_VAR_H_ */