xref: /freebsd/sys/netinet/in_var.h (revision 195ebc7e9e4b129de810833791a19dfb4349d6a9)
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 #include <sys/queue.h>
37 #include <sys/fnv_hash.h>
38 #include <sys/tree.h>
39 
40 struct igmp_ifinfo;
41 struct in_multi;
42 struct lltable;
43 
44 /*
45  * IPv4 per-interface state.
46  */
47 struct in_ifinfo {
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 */
51 };
52 
53 /*
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.
58  */
59 struct in_ifaddr {
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_{,sub}net{,mask} in host order */
64 	u_long	ia_net;			/* network number of interface */
65 	u_long	ia_netmask;		/* mask of net part */
66 	u_long	ia_subnet;		/* subnet number, including net */
67 	u_long	ia_subnetmask;		/* mask of subnet part */
68 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
69 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
70 	TAILQ_ENTRY(in_ifaddr) ia_link;	/* list of internet addresses */
71 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
72 	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
73 #define	ia_broadaddr	ia_dstaddr
74 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
75 };
76 
77 struct	in_aliasreq {
78 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
79 	struct	sockaddr_in ifra_addr;
80 	struct	sockaddr_in ifra_broadaddr;
81 #define ifra_dstaddr ifra_broadaddr
82 	struct	sockaddr_in ifra_mask;
83 };
84 /*
85  * Given a pointer to an in_ifaddr (ifaddr),
86  * return a pointer to the addr as a sockaddr_in.
87  */
88 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
89 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
90 
91 #define IN_LNAOF(in, ifa) \
92 	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
93 
94 
95 #ifdef	_KERNEL
96 extern	u_char	inetctlerrmap[];
97 
98 #define LLTABLE(ifp)	\
99 	((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt
100 /*
101  * Hash table for IP addresses.
102  */
103 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);
104 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);
105 #ifdef VIMAGE_GLOBALS
106 extern	struct in_ifaddrhashhead *in_ifaddrhashtbl;
107 extern	struct in_ifaddrhead in_ifaddrhead;
108 extern	u_long in_ifaddrhmask;			/* mask for hash table */
109 #endif
110 
111 #define INADDR_NHASH_LOG2       9
112 #define INADDR_NHASH		(1 << INADDR_NHASH_LOG2)
113 #define INADDR_HASHVAL(x)	fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
114 #define INADDR_HASH(x) \
115 	(&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask])
116 
117 /*
118  * Macro for finding the internet address structure (in_ifaddr)
119  * corresponding to one of our IP addresses (in_addr).
120  */
121 #define INADDR_TO_IFADDR(addr, ia) \
122 	/* struct in_addr addr; */ \
123 	/* struct in_ifaddr *ia; */ \
124 do { \
125 \
126 	LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
127 		if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
128 			break; \
129 } while (0)
130 
131 /*
132  * Macro for finding the interface (ifnet structure) corresponding to one
133  * of our IP addresses.
134  */
135 #define INADDR_TO_IFP(addr, ifp) \
136 	/* struct in_addr addr; */ \
137 	/* struct ifnet *ifp; */ \
138 { \
139 	struct in_ifaddr *ia; \
140 \
141 	INADDR_TO_IFADDR(addr, ia); \
142 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
143 }
144 
145 /*
146  * Macro for finding the internet address structure (in_ifaddr) corresponding
147  * to a given interface (ifnet structure).
148  */
149 #define IFP_TO_IA(ifp, ia) \
150 	/* struct ifnet *ifp; */ \
151 	/* struct in_ifaddr *ia; */ \
152 { \
153 	for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \
154 	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
155 	    (ia) = TAILQ_NEXT((ia), ia_link)) \
156 		continue; \
157 }
158 #endif
159 
160 /*
161  * IP datagram reassembly.
162  */
163 #define	IPREASS_NHASH_LOG2	6
164 #define	IPREASS_NHASH		(1 << IPREASS_NHASH_LOG2)
165 #define	IPREASS_HMASK		(IPREASS_NHASH - 1)
166 #define	IPREASS_HASH(x,y) \
167 	(((((x) & 0xF) | ((((x) >> 8) & 0xF) << 4)) ^ (y)) & IPREASS_HMASK)
168 
169 /*
170  * Legacy IPv4 IGMP per-link structure.
171  */
172 struct router_info {
173 	struct ifnet *rti_ifp;
174 	int    rti_type; /* type of router which is querier on this interface */
175 	int    rti_time; /* # of slow timeouts since last old query */
176 	SLIST_ENTRY(router_info) rti_list;
177 };
178 
179 /*
180  * Per-interface IGMP router version information.
181  */
182 struct igmp_ifinfo {
183 	LIST_ENTRY(igmp_ifinfo) igi_link;
184 	struct ifnet *igi_ifp;	/* interface this instance belongs to */
185 	uint32_t igi_version;	/* IGMPv3 Host Compatibility Mode */
186 	uint32_t igi_v1_timer;	/* IGMPv1 Querier Present timer (s) */
187 	uint32_t igi_v2_timer;	/* IGMPv2 Querier Present timer (s) */
188 	uint32_t igi_v3_timer;	/* IGMPv3 General Query (interface) timer (s)*/
189 	uint32_t igi_flags;	/* IGMP per-interface flags */
190 	uint32_t igi_rv;	/* IGMPv3 Robustness Variable */
191 	uint32_t igi_qi;	/* IGMPv3 Query Interval (s) */
192 	uint32_t igi_qri;	/* IGMPv3 Query Response Interval (s) */
193 	uint32_t igi_uri;	/* IGMPv3 Unsolicited Report Interval (s) */
194 	SLIST_HEAD(,in_multi)	igi_relinmhead; /* released groups */
195 	struct ifqueue	 igi_gq;	/* queue of general query responses */
196 };
197 
198 #define IGIF_SILENT	0x00000001	/* Do not use IGMP on this ifp */
199 #define IGIF_LOOPBACK	0x00000002	/* Send IGMP reports to loopback */
200 
201 /*
202  * IPv4 multicast IGMP-layer source entry.
203  */
204 struct ip_msource {
205 	RB_ENTRY(ip_msource)	ims_link;	/* RB tree links */
206 	in_addr_t		ims_haddr;	/* host byte order */
207 	struct ims_st {
208 		uint16_t	ex;		/* # of exclusive members */
209 		uint16_t	in;		/* # of inclusive members */
210 	}			ims_st[2];	/* state at t0, t1 */
211 	uint8_t			ims_stp;	/* pending query */
212 };
213 
214 /*
215  * IPv4 multicast PCB-layer source entry.
216  */
217 struct in_msource {
218 	RB_ENTRY(ip_msource)	ims_link;	/* RB tree links */
219 	in_addr_t		ims_haddr;	/* host byte order */
220 	uint8_t			imsl_st[2];	/* state before/at commit */
221 };
222 
223 RB_HEAD(ip_msource_tree, ip_msource);	/* define struct ip_msource_tree */
224 
225 static __inline int
226 ip_msource_cmp(const struct ip_msource *a, const struct ip_msource *b)
227 {
228 
229 	if (a->ims_haddr < b->ims_haddr)
230 		return (-1);
231 	if (a->ims_haddr == b->ims_haddr)
232 		return (0);
233 	return (1);
234 }
235 RB_PROTOTYPE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);
236 
237 /*
238  * IPv4 multicast PCB-layer group filter descriptor.
239  */
240 struct in_mfilter {
241 	struct ip_msource_tree	imf_sources; /* source list for (S,G) */
242 	u_long			imf_nsrc;    /* # of source entries */
243 	uint8_t			imf_st[2];   /* state before/at commit */
244 };
245 
246 /*
247  * IPv4 group descriptor.
248  *
249  * For every entry on an ifnet's if_multiaddrs list which represents
250  * an IP multicast group, there is one of these structures.
251  *
252  * If any source filters are present, then a node will exist in the RB-tree
253  * to permit fast lookup by source whenever an operation takes place.
254  * This permits pre-order traversal when we issue reports.
255  * Source filter trees are kept separately from the socket layer to
256  * greatly simplify locking.
257  *
258  * When IGMPv3 is active, inm_timer is the response to group query timer.
259  * The state-change timer inm_sctimer is separate; whenever state changes
260  * for the group the state change record is generated and transmitted,
261  * and kept if retransmissions are necessary.
262  *
263  * FUTURE: inm_link is now only used when groups are being purged
264  * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
265  * because it is at the very start of the struct, we can't do this
266  * w/o breaking the ABI for ifmcstat.
267  */
268 struct in_multi {
269 	LIST_ENTRY(in_multi) inm_link;	/* to-be-released by in_ifdetach */
270 	struct	in_addr inm_addr;	/* IP multicast address, convenience */
271 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
272 	struct	ifmultiaddr *inm_ifma;	/* back pointer to ifmultiaddr */
273 	u_int	inm_timer;		/* IGMPv1/v2 group / v3 query timer */
274 	u_int	inm_state;		/* state of the membership */
275 	void	*inm_rti;		/* unused, legacy field */
276 	u_int	inm_refcount;		/* reference count */
277 
278 	/* New fields for IGMPv3 follow. */
279 	struct igmp_ifinfo	*inm_igi;	/* IGMP info */
280 	SLIST_ENTRY(in_multi)	 inm_nrele;	/* to-be-released by IGMP */
281 	struct ip_msource_tree	 inm_srcs;	/* tree of sources */
282 	u_long			 inm_nsrc;	/* # of tree entries */
283 
284 	struct ifqueue		 inm_scq;	/* queue of pending
285 						 * state-change packets */
286 	struct timeval		 inm_lastgsrtv;	/* Time of last G-S-R query */
287 	uint16_t		 inm_sctimer;	/* state-change timer */
288 	uint16_t		 inm_scrv;	/* state-change rexmit count */
289 
290 	/*
291 	 * SSM state counters which track state at T0 (the time the last
292 	 * state-change report's RV timer went to zero) and T1
293 	 * (time of pending report, i.e. now).
294 	 * Used for computing IGMPv3 state-change reports. Several refcounts
295 	 * are maintained here to optimize for common use-cases.
296 	 */
297 	struct inm_st {
298 		uint16_t	iss_fmode;	/* IGMP filter mode */
299 		uint16_t	iss_asm;	/* # of ASM listeners */
300 		uint16_t	iss_ex;		/* # of exclusive members */
301 		uint16_t	iss_in;		/* # of inclusive members */
302 		uint16_t	iss_rec;	/* # of recorded sources */
303 	}			inm_st[2];	/* state at t0, t1 */
304 };
305 
306 /*
307  * Helper function to derive the filter mode on a source entry
308  * from its internal counters. Predicates are:
309  *  A source is only excluded if all listeners exclude it.
310  *  A source is only included if no listeners exclude it,
311  *  and at least one listener includes it.
312  * May be used by ifmcstat(8).
313  */
314 static __inline uint8_t
315 ims_get_mode(const struct in_multi *inm, const struct ip_msource *ims,
316     uint8_t t)
317 {
318 
319 	t = !!t;
320 	if (inm->inm_st[t].iss_ex > 0 &&
321 	    inm->inm_st[t].iss_ex == ims->ims_st[t].ex)
322 		return (MCAST_EXCLUDE);
323 	else if (ims->ims_st[t].in > 0 && ims->ims_st[t].ex == 0)
324 		return (MCAST_INCLUDE);
325 	return (MCAST_UNDEFINED);
326 }
327 
328 #ifdef _KERNEL
329 
330 #ifdef SYSCTL_DECL
331 SYSCTL_DECL(_net_inet);
332 SYSCTL_DECL(_net_inet_ip);
333 SYSCTL_DECL(_net_inet_raw);
334 #endif
335 
336 LIST_HEAD(in_multihead, in_multi);	/* XXX unused */
337 #ifdef VIMAGE_GLOBALS
338 extern struct in_multihead in_multihead;
339 #endif
340 
341 /*
342  * Lock macros for IPv4 layer multicast address lists.  IPv4 lock goes
343  * before link layer multicast locks in the lock order.  In most cases,
344  * consumers of IN_*_MULTI() macros should acquire the locks before
345  * calling them; users of the in_{add,del}multi() functions should not.
346  */
347 extern struct mtx in_multi_mtx;
348 #define	IN_MULTI_LOCK()		mtx_lock(&in_multi_mtx)
349 #define	IN_MULTI_UNLOCK()	mtx_unlock(&in_multi_mtx)
350 #define	IN_MULTI_LOCK_ASSERT()	mtx_assert(&in_multi_mtx, MA_OWNED)
351 #define	IN_MULTI_UNLOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_NOTOWNED)
352 
353 /*
354  * Function for looking up an in_multi record for an IPv4 multicast address
355  * on a given interface. ifp must be valid. If no record found, return NULL.
356  * The IN_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held.
357  */
358 static __inline struct in_multi *
359 inm_lookup_locked(struct ifnet *ifp, const struct in_addr ina)
360 {
361 	struct ifmultiaddr *ifma;
362 	struct in_multi *inm;
363 
364 	IN_MULTI_LOCK_ASSERT();
365 	IF_ADDR_LOCK_ASSERT(ifp);
366 
367 	inm = NULL;
368 	TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) {
369 		if (ifma->ifma_addr->sa_family == AF_INET) {
370 			inm = (struct in_multi *)ifma->ifma_protospec;
371 			if (inm->inm_addr.s_addr == ina.s_addr)
372 				break;
373 			inm = NULL;
374 		}
375 	}
376 	return (inm);
377 }
378 
379 /*
380  * Wrapper for inm_lookup_locked().
381  * The IF_ADDR_LOCK will be taken on ifp and released on return.
382  */
383 static __inline struct in_multi *
384 inm_lookup(struct ifnet *ifp, const struct in_addr ina)
385 {
386 	struct in_multi *inm;
387 
388 	IN_MULTI_LOCK_ASSERT();
389 	IF_ADDR_LOCK(ifp);
390 	inm = inm_lookup_locked(ifp, ina);
391 	IF_ADDR_UNLOCK(ifp);
392 
393 	return (inm);
394 }
395 
396 /* Acquire an in_multi record. */
397 static __inline void
398 inm_acquire_locked(struct in_multi *inm)
399 {
400 
401 	IN_MULTI_LOCK_ASSERT();
402 	++inm->inm_refcount;
403 }
404 
405 /*
406  * Return values for imo_multi_filter().
407  */
408 #define MCAST_PASS		0	/* Pass */
409 #define MCAST_NOTGMEMBER	1	/* This host not a member of group */
410 #define MCAST_NOTSMEMBER	2	/* This host excluded source */
411 #define MCAST_MUTED		3	/* [deprecated] */
412 
413 struct	rtentry;
414 struct	route;
415 struct	ip_moptions;
416 
417 int	imo_multi_filter(const struct ip_moptions *, const struct ifnet *,
418 	    const struct sockaddr *, const struct sockaddr *);
419 void	inm_commit(struct in_multi *);
420 void	inm_clear_recorded(struct in_multi *);
421 void	inm_print(const struct in_multi *);
422 int	inm_record_source(struct in_multi *inm, const in_addr_t);
423 void	inm_release(struct in_multi *);
424 void	inm_release_locked(struct in_multi *);
425 struct	in_multi *
426 	in_addmulti(struct in_addr *, struct ifnet *);
427 void	in_delmulti(struct in_multi *);
428 int	in_joingroup(struct ifnet *, const struct in_addr *,
429 	    /*const*/ struct in_mfilter *, struct in_multi **);
430 int	in_joingroup_locked(struct ifnet *, const struct in_addr *,
431 	    /*const*/ struct in_mfilter *, struct in_multi **);
432 int	in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *);
433 int	in_leavegroup_locked(struct in_multi *,
434 	    /*const*/ struct in_mfilter *);
435 int	in_control(struct socket *, u_long, caddr_t, struct ifnet *,
436 	    struct thread *);
437 void	in_rtqdrain(void);
438 void	ip_input(struct mbuf *);
439 int	in_ifadown(struct ifaddr *ifa, int);
440 void	in_ifscrub(struct ifnet *, struct in_ifaddr *);
441 struct	mbuf	*ip_fastforward(struct mbuf *);
442 void	*in_domifattach(struct ifnet *);
443 void	in_domifdetach(struct ifnet *, void *);
444 
445 
446 /* XXX */
447 void	 in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum);
448 void	 in_rtalloc(struct route *ro, u_int fibnum);
449 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int);
450 void	 in_rtredirect(struct sockaddr *, struct sockaddr *,
451 	    struct sockaddr *, int, struct sockaddr *, u_int);
452 int	 in_rtrequest(int, struct sockaddr *,
453 	    struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
454 
455 #if 0
456 int	 in_rt_getifa(struct rt_addrinfo *, u_int fibnum);
457 int	 in_rtioctl(u_long, caddr_t, u_int);
458 int	 in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int);
459 #endif
460 #endif /* _KERNEL */
461 
462 /* INET6 stuff */
463 #include <netinet6/in6_var.h>
464 
465 #endif /* _NETINET_IN_VAR_H_ */
466