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 * Legacy IPv4 IGMP per-link structure.
156 */
157 struct router_info {
158 struct ifnet *rti_ifp;
159 int rti_type; /* type of router which is querier on this interface */
160 int rti_time; /* # of slow timeouts since last old query */
161 SLIST_ENTRY(router_info) rti_list;
162 };
163
164 /*
165 * IPv4 multicast IGMP-layer source entry.
166 */
167 struct ip_msource {
168 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
169 in_addr_t ims_haddr; /* host byte order */
170 struct ims_st {
171 uint16_t ex; /* # of exclusive members */
172 uint16_t in; /* # of inclusive members */
173 } ims_st[2]; /* state at t0, t1 */
174 uint8_t ims_stp; /* pending query */
175 };
176
177 /*
178 * IPv4 multicast PCB-layer source entry.
179 */
180 struct in_msource {
181 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
182 in_addr_t ims_haddr; /* host byte order */
183 uint8_t imsl_st[2]; /* state before/at commit */
184 };
185
186 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */
187
188 static __inline int
ip_msource_cmp(const struct ip_msource * a,const struct ip_msource * b)189 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b)
190 {
191
192 if (a->ims_haddr < b->ims_haddr)
193 return (-1);
194 if (a->ims_haddr == b->ims_haddr)
195 return (0);
196 return (1);
197 }
198 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);
199
200 /*
201 * IPv4 multicast PCB-layer group filter descriptor.
202 */
203 struct in_mfilter {
204 struct ip_msource_tree imf_sources; /* source list for (S,G) */
205 u_long imf_nsrc; /* # of source entries */
206 uint8_t imf_st[2]; /* state before/at commit */
207 struct in_multi *imf_inm; /* associated multicast address */
208 STAILQ_ENTRY(in_mfilter) imf_entry; /* list entry */
209 };
210
211 /*
212 * Structure attached to inpcb.ip_moptions and passed to ip_output() when IP
213 * multicast options are in use.
214 * This structure is lazy-allocated.
215 */
216 struct ip_moptions {
217 struct ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
218 struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
219 u_long imo_multicast_vif; /* vif num outgoing multicasts */
220 u_char imo_multicast_ttl; /* TTL for outgoing multicasts */
221 u_char imo_multicast_loop; /* 1 => hear sends if a member */
222 STAILQ_HEAD(ip_mfilter_head, in_mfilter) imo_head;
223 };
224
225 struct in_mfilter *ip_mfilter_alloc(int mflags, int st0, int st1);
226 void ip_mfilter_free(struct in_mfilter *);
227
228 static inline void
ip_mfilter_init(struct ip_mfilter_head * head)229 ip_mfilter_init(struct ip_mfilter_head *head)
230 {
231
232 STAILQ_INIT(head);
233 }
234
235 static inline struct in_mfilter *
ip_mfilter_first(const struct ip_mfilter_head * head)236 ip_mfilter_first(const struct ip_mfilter_head *head)
237 {
238
239 return (STAILQ_FIRST(head));
240 }
241
242 static inline void
ip_mfilter_insert(struct ip_mfilter_head * head,struct in_mfilter * imf)243 ip_mfilter_insert(struct ip_mfilter_head *head, struct in_mfilter *imf)
244 {
245
246 STAILQ_INSERT_TAIL(head, imf, imf_entry);
247 }
248
249 static inline void
ip_mfilter_remove(struct ip_mfilter_head * head,struct in_mfilter * imf)250 ip_mfilter_remove(struct ip_mfilter_head *head, struct in_mfilter *imf)
251 {
252
253 STAILQ_REMOVE(head, imf, in_mfilter, imf_entry);
254 }
255
256 #define IP_MFILTER_FOREACH(imf, head) \
257 STAILQ_FOREACH(imf, head, imf_entry)
258
259 static inline size_t
ip_mfilter_count(struct ip_mfilter_head * head)260 ip_mfilter_count(struct ip_mfilter_head *head)
261 {
262 struct in_mfilter *imf;
263 size_t num = 0;
264
265 STAILQ_FOREACH(imf, head, imf_entry)
266 num++;
267 return (num);
268 }
269
270 /*
271 * IPv4 group descriptor.
272 *
273 * For every entry on an ifnet's if_multiaddrs list which represents
274 * an IP multicast group, there is one of these structures.
275 *
276 * If any source filters are present, then a node will exist in the RB-tree
277 * to permit fast lookup by source whenever an operation takes place.
278 * This permits pre-order traversal when we issue reports.
279 * Source filter trees are kept separately from the socket layer to
280 * greatly simplify locking.
281 *
282 * When IGMPv3 is active, inm_timer is the response to group query timer.
283 * The state-change timer inm_sctimer is separate; whenever state changes
284 * for the group the state change record is generated and transmitted,
285 * and kept if retransmissions are necessary.
286 *
287 * FUTURE: inm_link is now only used when groups are being purged
288 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY.
289 */
290 struct in_multi {
291 LIST_ENTRY(in_multi) inm_link; /* to-be-released by in_ifdetach */
292 struct in_addr inm_addr; /* IP multicast address, convenience */
293 struct ifnet *inm_ifp; /* back pointer to ifnet */
294 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
295 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */
296 u_int inm_state; /* state of the membership */
297 void *inm_rti; /* unused, legacy field */
298 u_int inm_refcount; /* reference count */
299
300 /* New fields for IGMPv3 follow. */
301 struct igmp_ifsoftc *inm_igi; /* IGMP info */
302 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */
303 struct ip_msource_tree inm_srcs; /* tree of sources */
304 u_long inm_nsrc; /* # of tree entries */
305
306 struct mbufq inm_scq; /* queue of pending
307 * state-change packets */
308 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */
309 uint16_t inm_sctimer; /* state-change timer */
310 uint16_t inm_scrv; /* state-change rexmit count */
311
312 /*
313 * SSM state counters which track state at T0 (the time the last
314 * state-change report's RV timer went to zero) and T1
315 * (time of pending report, i.e. now).
316 * Used for computing IGMPv3 state-change reports. Several refcounts
317 * are maintained here to optimize for common use-cases.
318 */
319 struct inm_st {
320 uint16_t iss_fmode; /* IGMP filter mode */
321 uint16_t iss_asm; /* # of ASM listeners */
322 uint16_t iss_ex; /* # of exclusive members */
323 uint16_t iss_in; /* # of inclusive members */
324 uint16_t iss_rec; /* # of recorded sources */
325 } inm_st[2]; /* state at t0, t1 */
326 };
327
328 /*
329 * Helper function to derive the filter mode on a source entry
330 * from its internal counters. Predicates are:
331 * A source is only excluded if all listeners exclude it.
332 * A source is only included if no listeners exclude it,
333 * and at least one listener includes it.
334 */
335 static __inline uint8_t
ims_get_mode(const struct in_multi * inm,const struct ip_msource * ims,uint8_t t)336 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims,
337 uint8_t t)
338 {
339
340 t = !!t;
341 if (inm->inm_st[t].iss_ex > 0 &&
342 inm->inm_st[t].iss_ex == ims->ims_st[t].ex)
343 return (MCAST_EXCLUDE);
344 else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0)
345 return (MCAST_INCLUDE);
346 return (MCAST_UNDEFINED);
347 }
348
349 #ifdef SYSCTL_DECL
350 SYSCTL_DECL(_net_inet);
351 SYSCTL_DECL(_net_inet_ip);
352 SYSCTL_DECL(_net_inet_raw);
353 #endif
354
355 /*
356 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes
357 * before link layer multicast locks in the lock order. In most cases,
358 * consumers of IN_*_MULTI() macros should acquire the locks before
359 * calling them; users of the in_{add,del}multi() functions should not.
360 */
361 extern struct mtx in_multi_list_mtx;
362 extern struct sx in_multi_sx;
363
364 #define IN_MULTI_LIST_LOCK() mtx_lock(&in_multi_list_mtx)
365 #define IN_MULTI_LIST_UNLOCK() mtx_unlock(&in_multi_list_mtx)
366 #define IN_MULTI_LIST_LOCK_ASSERT() mtx_assert(&in_multi_list_mtx, MA_OWNED)
367 #define IN_MULTI_LIST_UNLOCK_ASSERT() mtx_assert(&in_multi_list_mtx, MA_NOTOWNED)
368
369 #define IN_MULTI_LOCK() sx_xlock(&in_multi_sx)
370 #define IN_MULTI_UNLOCK() sx_xunlock(&in_multi_sx)
371 #define IN_MULTI_LOCK_ASSERT() sx_assert(&in_multi_sx, SA_XLOCKED)
372 #define IN_MULTI_UNLOCK_ASSERT() sx_assert(&in_multi_sx, SA_XUNLOCKED)
373
374 void inm_disconnect(struct in_multi *inm);
375
376 /*
377 * Get the in_multi pointer from a ifmultiaddr.
378 * Returns NULL if ifmultiaddr is no longer valid.
379 */
380 static __inline struct in_multi *
inm_ifmultiaddr_get_inm(struct ifmultiaddr * ifma)381 inm_ifmultiaddr_get_inm(struct ifmultiaddr *ifma)
382 {
383
384 NET_EPOCH_ASSERT();
385
386 return ((ifma->ifma_addr->sa_family != AF_INET ||
387 (ifma->ifma_flags & IFMA_F_ENQUEUED) == 0) ? NULL :
388 ifma->ifma_protospec);
389 }
390
391 /* Acquire an in_multi record. */
392 static __inline void
inm_acquire_locked(struct in_multi * inm)393 inm_acquire_locked(struct in_multi *inm)
394 {
395
396 IN_MULTI_LIST_LOCK_ASSERT();
397 ++inm->inm_refcount;
398 }
399
400 static __inline void
inm_acquire(struct in_multi * inm)401 inm_acquire(struct in_multi *inm)
402 {
403 IN_MULTI_LIST_LOCK();
404 inm_acquire_locked(inm);
405 IN_MULTI_LIST_UNLOCK();
406 }
407
408 static __inline void
inm_rele_locked(struct in_multi_head * inmh,struct in_multi * inm)409 inm_rele_locked(struct in_multi_head *inmh, struct in_multi *inm)
410 {
411 MPASS(inm->inm_refcount > 0);
412 IN_MULTI_LIST_LOCK_ASSERT();
413
414 if (--inm->inm_refcount == 0) {
415 MPASS(inmh != NULL);
416 inm_disconnect(inm);
417 inm->inm_ifma->ifma_protospec = NULL;
418 SLIST_INSERT_HEAD(inmh, inm, inm_nrele);
419 }
420 }
421
422 /*
423 * Return values for imo_multi_filter().
424 */
425 #define MCAST_PASS 0 /* Pass */
426 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */
427 #define MCAST_NOTSMEMBER 2 /* This host excluded source */
428 #define MCAST_MUTED 3 /* [deprecated] */
429
430 struct rib_head;
431 struct ucred;
432
433 struct in_multi *inm_lookup_locked(struct ifnet *, const struct in_addr);
434 struct in_multi *inm_lookup(struct ifnet *, const struct in_addr);
435 int imo_multi_filter(const struct ip_moptions *, const struct ifnet *,
436 const struct sockaddr *, const struct sockaddr *);
437 void inm_commit(struct in_multi *);
438 void inm_clear_recorded(struct in_multi *);
439 void inm_print(const struct in_multi *);
440 int inm_record_source(struct in_multi *inm, const in_addr_t);
441 void inm_release_deferred(struct in_multi *);
442 void inm_release_list_deferred(struct in_multi_head *);
443 void inm_release_wait(void *);
444 int in_joingroup(struct ifnet *, const struct in_addr *,
445 /*const*/ struct in_mfilter *, struct in_multi **);
446 int in_joingroup_locked(struct ifnet *, const struct in_addr *,
447 /*const*/ struct in_mfilter *, struct in_multi **);
448 int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *);
449 int in_leavegroup_locked(struct in_multi *,
450 /*const*/ struct in_mfilter *);
451 int in_mask2len(struct in_addr *);
452 int in_control(struct socket *, u_long, void *, struct ifnet *,
453 struct thread *);
454 int in_control_ioctl(u_long, void *, struct ifnet *,
455 struct ucred *);
456 int in_addprefix(struct in_ifaddr *);
457 int in_scrubprefix(struct in_ifaddr *, u_int);
458 void in_ifscrub_all(void);
459 void ip_input(struct mbuf *);
460 void ip_direct_input(struct mbuf *);
461 void in_ifadown(struct ifaddr *ifa, int);
462 struct mbuf *ip_tryforward(struct mbuf *);
463 struct rib_head *in_inithead(uint32_t fibnum);
464 void in_ifattach(void *, struct ifnet *);
465
466 #ifdef VIMAGE
467 void in_detachhead(struct rib_head *rh);
468 #endif
469
470 struct sockopt;
471
472 int inp_join_group(struct inpcb *, struct sockopt *);
473 int inp_leave_group(struct inpcb *, struct sockopt *);
474
475 #endif /* _KERNEL */
476
477 /* INET6 stuff */
478 #include <netinet6/in6_var.h>
479
480 #endif /* _NETINET_IN_VAR_H_ */
481