xref: /freebsd/sys/netinet/in_var.h (revision f0a75d274af375d15b97b830966b99a02b7db911)
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 
39 /*
40  * Interface address, Internet version.  One of these structures
41  * is allocated for each Internet address on an interface.
42  * The ifaddr structure contains the protocol-independent part
43  * of the structure and is assumed to be first.
44  */
45 struct in_ifaddr {
46 	struct	ifaddr ia_ifa;		/* protocol-independent info */
47 #define	ia_ifp		ia_ifa.ifa_ifp
48 #define ia_flags	ia_ifa.ifa_flags
49 					/* ia_{,sub}net{,mask} in host order */
50 	u_long	ia_net;			/* network number of interface */
51 	u_long	ia_netmask;		/* mask of net part */
52 	u_long	ia_subnet;		/* subnet number, including net */
53 	u_long	ia_subnetmask;		/* mask of subnet part */
54 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
55 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
56 	TAILQ_ENTRY(in_ifaddr) ia_link;	/* list of internet addresses */
57 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
58 	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
59 #define	ia_broadaddr	ia_dstaddr
60 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
61 };
62 
63 struct	in_aliasreq {
64 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
65 	struct	sockaddr_in ifra_addr;
66 	struct	sockaddr_in ifra_broadaddr;
67 #define ifra_dstaddr ifra_broadaddr
68 	struct	sockaddr_in ifra_mask;
69 };
70 /*
71  * Given a pointer to an in_ifaddr (ifaddr),
72  * return a pointer to the addr as a sockaddr_in.
73  */
74 #define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
75 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
76 
77 #define IN_LNAOF(in, ifa) \
78 	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
79 
80 
81 #ifdef	_KERNEL
82 extern	u_char	inetctlerrmap[];
83 
84 /*
85  * Hash table for IP addresses.
86  */
87 extern	LIST_HEAD(in_ifaddrhashhead, in_ifaddr) *in_ifaddrhashtbl;
88 extern	TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
89 extern	u_long in_ifaddrhmask;			/* mask for hash table */
90 
91 #define INADDR_NHASH_LOG2       9
92 #define INADDR_NHASH		(1 << INADDR_NHASH_LOG2)
93 #define INADDR_HASHVAL(x)	fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
94 #define INADDR_HASH(x) \
95 	(&in_ifaddrhashtbl[INADDR_HASHVAL(x) & in_ifaddrhmask])
96 
97 /*
98  * Macro for finding the internet address structure (in_ifaddr)
99  * corresponding to one of our IP addresses (in_addr).
100  */
101 #define INADDR_TO_IFADDR(addr, ia) \
102 	/* struct in_addr addr; */ \
103 	/* struct in_ifaddr *ia; */ \
104 do { \
105 \
106 	LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
107 		if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
108 			break; \
109 } while (0)
110 
111 /*
112  * Macro for finding the interface (ifnet structure) corresponding to one
113  * of our IP addresses.
114  */
115 #define INADDR_TO_IFP(addr, ifp) \
116 	/* struct in_addr addr; */ \
117 	/* struct ifnet *ifp; */ \
118 { \
119 	struct in_ifaddr *ia; \
120 \
121 	INADDR_TO_IFADDR(addr, ia); \
122 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
123 }
124 
125 /*
126  * Macro for finding the internet address structure (in_ifaddr) corresponding
127  * to a given interface (ifnet structure).
128  */
129 #define IFP_TO_IA(ifp, ia) \
130 	/* struct ifnet *ifp; */ \
131 	/* struct in_ifaddr *ia; */ \
132 { \
133 	for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
134 	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
135 	    (ia) = TAILQ_NEXT((ia), ia_link)) \
136 		continue; \
137 }
138 #endif
139 
140 /*
141  * This information should be part of the ifnet structure but we don't wish
142  * to change that - as it might break a number of things
143  */
144 
145 struct router_info {
146 	struct ifnet *rti_ifp;
147 	int    rti_type; /* type of router which is querier on this interface */
148 	int    rti_time; /* # of slow timeouts since last old query */
149 	SLIST_ENTRY(router_info) rti_list;
150 };
151 
152 /*
153  * Internet multicast address structure.  There is one of these for each IP
154  * multicast group to which this host belongs on a given network interface.
155  * For every entry on the interface's if_multiaddrs list which represents
156  * an IP multicast group, there is one of these structures.  They are also
157  * kept on a system-wide list to make it easier to keep our legacy IGMP code
158  * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
159  */
160 struct in_multi {
161 	LIST_ENTRY(in_multi) inm_link;	/* queue macro glue */
162 	struct	in_addr inm_addr;	/* IP multicast address, convenience */
163 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
164 	struct	ifmultiaddr *inm_ifma;	/* back pointer to ifmultiaddr */
165 	u_int	inm_timer;		/* IGMP membership report timer */
166 	u_int	inm_state;		/*  state of the membership */
167 	struct	router_info *inm_rti;	/* router info*/
168 	u_int	inm_refcount;		/* reference count */
169 };
170 
171 #ifdef _KERNEL
172 
173 #ifdef SYSCTL_DECL
174 SYSCTL_DECL(_net_inet);
175 SYSCTL_DECL(_net_inet_ip);
176 SYSCTL_DECL(_net_inet_raw);
177 #endif
178 
179 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
180 
181 /*
182  * Lock macros for IPv4 layer multicast address lists.  IPv4 lock goes
183  * before link layer multicast locks in the lock order.  In most cases,
184  * consumers of IN_*_MULTI() macros should acquire the locks before
185  * calling them; users of the in_{add,del}multi() functions should not.
186  */
187 extern struct mtx in_multi_mtx;
188 #define	IN_MULTI_LOCK()		mtx_lock(&in_multi_mtx)
189 #define	IN_MULTI_UNLOCK()	mtx_unlock(&in_multi_mtx)
190 #define	IN_MULTI_LOCK_ASSERT()	mtx_assert(&in_multi_mtx, MA_OWNED)
191 
192 /*
193  * Structure used by macros below to remember position when stepping through
194  * all of the in_multi records.
195  */
196 struct in_multistep {
197 	struct in_multi *i_inm;
198 };
199 
200 /*
201  * Macro for looking up the in_multi record for a given IP multicast address
202  * on a given interface.  If no matching record is found, "inm" is set null.
203  */
204 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
205 	/* struct in_addr addr; */ \
206 	/* struct ifnet *ifp; */ \
207 	/* struct in_multi *inm; */ \
208 do { \
209 	struct ifmultiaddr *ifma; \
210 \
211 	IN_MULTI_LOCK_ASSERT(); \
212 	IF_ADDR_LOCK(ifp); \
213 	TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
214 		if (ifma->ifma_addr->sa_family == AF_INET \
215 		    && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
216 		    (addr).s_addr) \
217 			break; \
218 	} \
219 	(inm) = ifma ? ifma->ifma_protospec : 0; \
220 	IF_ADDR_UNLOCK(ifp); \
221 } while(0)
222 
223 /*
224  * Macro to step through all of the in_multi records, one at a time.
225  * The current position is remembered in "step", which the caller must
226  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
227  * and get the first record.  Both macros return a NULL "inm" when there
228  * are no remaining records.
229  */
230 #define IN_NEXT_MULTI(step, inm) \
231 	/* struct in_multistep  step; */ \
232 	/* struct in_multi *inm; */ \
233 do { \
234 	IN_MULTI_LOCK_ASSERT(); \
235 	if (((inm) = (step).i_inm) != NULL) \
236 		(step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
237 } while(0)
238 
239 #define IN_FIRST_MULTI(step, inm) \
240 	/* struct in_multistep step; */ \
241 	/* struct in_multi *inm; */ \
242 do { \
243 	IN_MULTI_LOCK_ASSERT(); \
244 	(step).i_inm = LIST_FIRST(&in_multihead); \
245 	IN_NEXT_MULTI((step), (inm)); \
246 } while(0)
247 
248 struct	route;
249 struct	in_multi *in_addmulti(struct in_addr *, struct ifnet *);
250 void	in_delmulti(struct in_multi *);
251 void	in_delmulti_locked(struct in_multi *);
252 int	in_control(struct socket *, u_long, caddr_t, struct ifnet *,
253 	    struct thread *);
254 void	in_rtqdrain(void);
255 void	ip_input(struct mbuf *);
256 int	in_ifadown(struct ifaddr *ifa, int);
257 void	in_ifscrub(struct ifnet *, struct in_ifaddr *);
258 struct	mbuf	*ip_fastforward(struct mbuf *);
259 
260 #endif /* _KERNEL */
261 
262 /* INET6 stuff */
263 #include <netinet6/in6_var.h>
264 
265 #endif /* _NETINET_IN_VAR_H_ */
266