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