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_
37 * Argument structure for SIOCAIFADDR.
40 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
41 struct sockaddr_in ifra_addr;
42 struct sockaddr_in ifra_broadaddr;
43 #define ifra_dstaddr ifra_broadaddr
44 struct sockaddr_in ifra_mask;
49 #include <sys/queue.h>
50 #include <sys/fnv_hash.h>
58 * IPv4 per-interface state.
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 */
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.
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 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */
80 TAILQ_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 */
88 * Given a pointer to an in_ifaddr (ifaddr),
89 * return a pointer to the addr as a sockaddr_in.
91 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
92 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
93 #define IA_MASKSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_sockmask))
95 #define IN_LNAOF(in, ifa) \
96 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
98 extern u_char inetctlerrmap[];
100 #define LLTABLE(ifp) \
101 ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt
103 * Hash table for IP addresses.
105 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);
106 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);
108 VNET_DECLARE(struct in_ifaddrhashhead *, in_ifaddrhashtbl);
109 VNET_DECLARE(struct in_ifaddrhead, in_ifaddrhead);
110 VNET_DECLARE(u_long, in_ifaddrhmask); /* mask for hash table */
112 #define V_in_ifaddrhashtbl VNET(in_ifaddrhashtbl)
113 #define V_in_ifaddrhead VNET(in_ifaddrhead)
114 #define V_in_ifaddrhmask VNET(in_ifaddrhmask)
116 #define INADDR_NHASH_LOG2 9
117 #define INADDR_NHASH (1 << INADDR_NHASH_LOG2)
118 #define INADDR_HASHVAL(x) fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
119 #define INADDR_HASH(x) \
120 (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask])
122 extern struct rmlock in_ifaddr_lock;
124 #define IN_IFADDR_LOCK_ASSERT() rm_assert(&in_ifaddr_lock, RA_LOCKED)
125 #define IN_IFADDR_RLOCK(t) rm_rlock(&in_ifaddr_lock, (t))
126 #define IN_IFADDR_RLOCK_ASSERT() rm_assert(&in_ifaddr_lock, RA_RLOCKED)
127 #define IN_IFADDR_RUNLOCK(t) rm_runlock(&in_ifaddr_lock, (t))
128 #define IN_IFADDR_WLOCK() rm_wlock(&in_ifaddr_lock)
129 #define IN_IFADDR_WLOCK_ASSERT() rm_assert(&in_ifaddr_lock, RA_WLOCKED)
130 #define IN_IFADDR_WUNLOCK() rm_wunlock(&in_ifaddr_lock)
133 * Macro for finding the internet address structure (in_ifaddr)
134 * corresponding to one of our IP addresses (in_addr).
136 #define INADDR_TO_IFADDR(addr, ia) \
137 /* struct in_addr addr; */ \
138 /* struct in_ifaddr *ia; */ \
141 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
142 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
147 * Macro for finding the interface (ifnet structure) corresponding to one
148 * of our IP addresses.
150 #define INADDR_TO_IFP(addr, ifp) \
151 /* struct in_addr addr; */ \
152 /* struct ifnet *ifp; */ \
154 struct in_ifaddr *ia; \
156 INADDR_TO_IFADDR(addr, ia); \
157 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
161 * Macro for finding the internet address structure (in_ifaddr) corresponding
162 * to a given interface (ifnet structure).
164 #define IFP_TO_IA(ifp, ia, t) \
165 /* struct ifnet *ifp; */ \
166 /* struct in_ifaddr *ia; */ \
167 /* struct rm_priotracker *t; */ \
169 IN_IFADDR_RLOCK((t)); \
170 for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \
171 (ia) != NULL && (ia)->ia_ifp != (ifp); \
172 (ia) = TAILQ_NEXT((ia), ia_link)) \
175 ifa_ref(&(ia)->ia_ifa); \
176 IN_IFADDR_RUNLOCK((t)); \
180 * Legacy IPv4 IGMP per-link structure.
183 struct ifnet *rti_ifp;
184 int rti_type; /* type of router which is querier on this interface */
185 int rti_time; /* # of slow timeouts since last old query */
186 SLIST_ENTRY(router_info) rti_list;
190 * IPv4 multicast IGMP-layer source entry.
193 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
194 in_addr_t ims_haddr; /* host byte order */
196 uint16_t ex; /* # of exclusive members */
197 uint16_t in; /* # of inclusive members */
198 } ims_st[2]; /* state at t0, t1 */
199 uint8_t ims_stp; /* pending query */
203 * IPv4 multicast PCB-layer source entry.
206 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
207 in_addr_t ims_haddr; /* host byte order */
208 uint8_t imsl_st[2]; /* state before/at commit */
211 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */
214 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b)
217 if (a->ims_haddr < b->ims_haddr)
219 if (a->ims_haddr == b->ims_haddr)
223 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);
226 * IPv4 multicast PCB-layer group filter descriptor.
229 struct ip_msource_tree imf_sources; /* source list for (S,G) */
230 u_long imf_nsrc; /* # of source entries */
231 uint8_t imf_st[2]; /* state before/at commit */
235 * IPv4 group descriptor.
237 * For every entry on an ifnet's if_multiaddrs list which represents
238 * an IP multicast group, there is one of these structures.
240 * If any source filters are present, then a node will exist in the RB-tree
241 * to permit fast lookup by source whenever an operation takes place.
242 * This permits pre-order traversal when we issue reports.
243 * Source filter trees are kept separately from the socket layer to
244 * greatly simplify locking.
246 * When IGMPv3 is active, inm_timer is the response to group query timer.
247 * The state-change timer inm_sctimer is separate; whenever state changes
248 * for the group the state change record is generated and transmitted,
249 * and kept if retransmissions are necessary.
251 * FUTURE: inm_link is now only used when groups are being purged
252 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
253 * because it is at the very start of the struct, we can't do this
254 * w/o breaking the ABI for ifmcstat.
257 LIST_ENTRY(in_multi) inm_link; /* to-be-released by in_ifdetach */
258 struct in_addr inm_addr; /* IP multicast address, convenience */
259 struct ifnet *inm_ifp; /* back pointer to ifnet */
260 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
261 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */
262 u_int inm_state; /* state of the membership */
263 void *inm_rti; /* unused, legacy field */
264 u_int inm_refcount; /* reference count */
266 /* New fields for IGMPv3 follow. */
267 struct igmp_ifsoftc *inm_igi; /* IGMP info */
268 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */
269 struct ip_msource_tree inm_srcs; /* tree of sources */
270 u_long inm_nsrc; /* # of tree entries */
272 struct mbufq inm_scq; /* queue of pending
273 * state-change packets */
274 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */
275 uint16_t inm_sctimer; /* state-change timer */
276 uint16_t inm_scrv; /* state-change rexmit count */
279 * SSM state counters which track state at T0 (the time the last
280 * state-change report's RV timer went to zero) and T1
281 * (time of pending report, i.e. now).
282 * Used for computing IGMPv3 state-change reports. Several refcounts
283 * are maintained here to optimize for common use-cases.
286 uint16_t iss_fmode; /* IGMP filter mode */
287 uint16_t iss_asm; /* # of ASM listeners */
288 uint16_t iss_ex; /* # of exclusive members */
289 uint16_t iss_in; /* # of inclusive members */
290 uint16_t iss_rec; /* # of recorded sources */
291 } inm_st[2]; /* state at t0, t1 */
295 * Helper function to derive the filter mode on a source entry
296 * from its internal counters. Predicates are:
297 * A source is only excluded if all listeners exclude it.
298 * A source is only included if no listeners exclude it,
299 * and at least one listener includes it.
300 * May be used by ifmcstat(8).
302 static __inline uint8_t
303 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims,
308 if (inm->inm_st[t].iss_ex > 0 &&
309 inm->inm_st[t].iss_ex == ims->ims_st[t].ex)
310 return (MCAST_EXCLUDE);
311 else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0)
312 return (MCAST_INCLUDE);
313 return (MCAST_UNDEFINED);
317 SYSCTL_DECL(_net_inet);
318 SYSCTL_DECL(_net_inet_ip);
319 SYSCTL_DECL(_net_inet_raw);
323 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes
324 * before link layer multicast locks in the lock order. In most cases,
325 * consumers of IN_*_MULTI() macros should acquire the locks before
326 * calling them; users of the in_{add,del}multi() functions should not.
328 extern struct mtx in_multi_mtx;
329 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx)
330 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx)
331 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED)
332 #define IN_MULTI_UNLOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_NOTOWNED)
334 /* Acquire an in_multi record. */
336 inm_acquire_locked(struct in_multi *inm)
339 IN_MULTI_LOCK_ASSERT();
344 * Return values for imo_multi_filter().
346 #define MCAST_PASS 0 /* Pass */
347 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */
348 #define MCAST_NOTSMEMBER 2 /* This host excluded source */
349 #define MCAST_MUTED 3 /* [deprecated] */
355 struct in_multi *inm_lookup_locked(struct ifnet *, const struct in_addr);
356 struct in_multi *inm_lookup(struct ifnet *, const struct in_addr);
357 int imo_multi_filter(const struct ip_moptions *, const struct ifnet *,
358 const struct sockaddr *, const struct sockaddr *);
359 void inm_commit(struct in_multi *);
360 void inm_clear_recorded(struct in_multi *);
361 void inm_print(const struct in_multi *);
362 int inm_record_source(struct in_multi *inm, const in_addr_t);
363 void inm_release(struct in_multi *);
364 void inm_release_locked(struct in_multi *);
366 in_addmulti(struct in_addr *, struct ifnet *);
367 void in_delmulti(struct in_multi *);
368 int in_joingroup(struct ifnet *, const struct in_addr *,
369 /*const*/ struct in_mfilter *, struct in_multi **);
370 int in_joingroup_locked(struct ifnet *, const struct in_addr *,
371 /*const*/ struct in_mfilter *, struct in_multi **);
372 int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *);
373 int in_leavegroup_locked(struct in_multi *,
374 /*const*/ struct in_mfilter *);
375 int in_control(struct socket *, u_long, caddr_t, struct ifnet *,
377 int in_addprefix(struct in_ifaddr *, int);
378 int in_scrubprefix(struct in_ifaddr *, u_int);
379 void ip_input(struct mbuf *);
380 void ip_direct_input(struct mbuf *);
381 void in_ifadown(struct ifaddr *ifa, int);
382 struct mbuf *ip_tryforward(struct mbuf *);
383 void *in_domifattach(struct ifnet *);
384 void in_domifdetach(struct ifnet *, void *);
388 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum);
389 void in_rtredirect(struct sockaddr *, struct sockaddr *,
390 struct sockaddr *, int, struct sockaddr *, u_int);
394 #include <netinet6/in6_var.h>
396 #endif /* _NETINET_IN_VAR_H_ */