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