xref: /netbsd-src/sys/netinet/in_var.h (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: in_var.h,v 1.41 2000/10/08 09:15:28 enami Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Public Access Networks Corporation ("Panix").  It was developed under
9  * contract to Panix by Eric Haszlakiewicz and Thor Lancelot Simon.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 /*
41  * Copyright (c) 1985, 1986, 1993
42  *	The Regents of the University of California.  All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *	This product includes software developed by the University of
55  *	California, Berkeley and its contributors.
56  * 4. Neither the name of the University nor the names of its contributors
57  *    may be used to endorse or promote products derived from this software
58  *    without specific prior written permission.
59  *
60  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
70  * SUCH DAMAGE.
71  *
72  *	@(#)in_var.h	8.2 (Berkeley) 1/9/95
73  */
74 
75 #ifndef _NETINET_IN_VAR_H_
76 #define _NETINET_IN_VAR_H_
77 
78 #include <sys/queue.h>
79 
80 /*
81  * Interface address, Internet version.  One of these structures
82  * is allocated for each interface with an Internet address.
83  * The ifaddr structure contains the protocol-independent part
84  * of the structure and is assumed to be first.
85  */
86 struct in_ifaddr {
87 	struct	ifaddr ia_ifa;		/* protocol-independent info */
88 #define	ia_ifp		ia_ifa.ifa_ifp
89 #define ia_flags	ia_ifa.ifa_flags
90 					/* ia_{,sub}net{,mask} in host order */
91 	u_int32_t ia_net;		/* network number of interface */
92 	u_int32_t ia_netmask;		/* mask of net part */
93 	u_int32_t ia_subnet;		/* subnet number, including net */
94 	u_int32_t ia_subnetmask;	/* mask of subnet part */
95 	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
96 	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
97 	TAILQ_ENTRY(in_ifaddr) ia_list;	/* list of internet addresses */
98 	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
99 	struct	sockaddr_in ia_dstaddr;	/* reserve space for broadcast addr */
100 #define	ia_broadaddr	ia_dstaddr
101 	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
102 	LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
103 	struct	in_multi *ia_allhosts;	/* multicast address record for
104 					   the allhosts multicast group */
105 };
106 
107 struct	in_aliasreq {
108 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
109 	struct	sockaddr_in ifra_addr;
110 	struct	sockaddr_in ifra_dstaddr;
111 #define	ifra_broadaddr	ifra_dstaddr
112 	struct	sockaddr_in ifra_mask;
113 };
114 /*
115  * Given a pointer to an in_ifaddr (ifaddr),
116  * return a pointer to the addr as a sockaddr_in.
117  */
118 #define	IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
119 
120 
121 #ifdef	_KERNEL
122 #ifndef IN_IFADDR_HASH_SIZE
123 #define IN_IFADDR_HASH_SIZE 509	/* 61, 127, 251, 509, 1021, 2039 are good */
124 #endif
125 
126 /*
127  * This is a bit unconventional, and wastes a little bit of space, but
128  * because we want a very even hash function we don't use & in_ifaddrhash
129  * here, but rather % the hash size, which should obviously be prime.
130  */
131 
132 #define	IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
133 
134 u_long in_ifaddrhash;				/* size of hash table - 1 */
135 int	in_ifaddrentries;			/* total number of addrs */
136 LIST_HEAD(in_ifaddrhashhead, in_ifaddr);	/* Type of the hash head */
137 TAILQ_HEAD(in_ifaddrhead, in_ifaddr);		/* Type of the list head */
138 
139 extern  struct in_ifaddrhashhead *in_ifaddrhashtbl;	/* Hash table head */
140 extern  struct in_ifaddrhead in_ifaddr;		/* List head (in ip_input) */
141 
142 extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
143 extern	int	inetctlerrmap[];
144 
145 
146 /*
147  * Macro for finding whether an internet address (in_addr) belongs to one
148  * of our interfaces (in_ifaddr).  NULL if the address isn't ours.
149  *
150  * Note that even if we find an interface with the address we're looking
151  * for, we should skip that interface if it is not up.
152  */
153 #define INADDR_TO_IA(addr, ia) \
154 	/* struct in_addr addr; */ \
155 	/* struct in_ifaddr *ia; */ \
156 { \
157 	for (ia = IN_IFADDR_HASH((addr).s_addr).lh_first; \
158 	     ia != NULL; \
159 	     ia = ia->ia_hash.le_next) { \
160 		if (in_hosteq(ia->ia_addr.sin_addr, (addr)) && \
161 		    (ia->ia_ifp->if_flags & IFF_UP) != 0) \
162 			break; \
163 	} \
164 }
165 
166 /*
167  * Macro for finding the next in_ifaddr structure with the same internet
168  * address as ia. Call only with a valid ia pointer.
169  * Will set ia to NULL if none found.
170  */
171 
172 #define NEXT_IA_WITH_SAME_ADDR(ia) \
173 	/* struct in_ifaddr *ia; */ \
174 { \
175 	struct in_addr addr; \
176 	addr = ia->ia_addr.sin_addr; \
177 	do { \
178 		ia = ia->ia_hash.le_next; \
179 	} while ((ia != NULL) && !in_hosteq(ia->ia_addr.sin_addr, addr)); \
180 }
181 
182 /*
183  * Macro for finding the interface (ifnet structure) corresponding to one
184  * of our IP addresses.
185  */
186 #define INADDR_TO_IFP(addr, ifp) \
187 	/* struct in_addr addr; */ \
188 	/* struct ifnet *ifp; */ \
189 { \
190 	struct in_ifaddr *ia; \
191 \
192 	INADDR_TO_IA(addr, ia); \
193 	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
194 }
195 
196 /*
197  * Macro for finding an internet address structure (in_ifaddr) corresponding
198  * to a given interface (ifnet structure).
199  */
200 #define IFP_TO_IA(ifp, ia) \
201 	/* struct ifnet *ifp; */ \
202 	/* struct in_ifaddr *ia; */ \
203 { \
204 	struct ifaddr *ifa; \
205 \
206 	for (ifa = (ifp)->if_addrlist.tqh_first; \
207 	    ifa != NULL && ifa->ifa_addr->sa_family != AF_INET; \
208 	    ifa = ifa->ifa_list.tqe_next) \
209 		continue; \
210 	(ia) = ifatoia(ifa); \
211 }
212 #endif
213 
214 /*
215  * Per-interface router version information.
216  */
217 struct router_info {
218 	struct	ifnet *rti_ifp;
219 	int	rti_type;	/* type of router on this interface */
220 	int	rti_age;	/* time since last v1 query */
221 	struct	router_info *rti_next;
222 };
223 
224 /*
225  * Internet multicast address structure.  There is one of these for each IP
226  * multicast group to which this host belongs on a given network interface.
227  * They are kept in a linked list, rooted in the interface's in_ifaddr
228  * structure.
229  */
230 struct in_multi {
231 	struct	in_addr inm_addr;	/* IP multicast address */
232 	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
233 	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
234 	u_int	inm_refcount;		/* no. membership claims by sockets */
235 	u_int	inm_timer;		/* IGMP membership report timer */
236 	LIST_ENTRY(in_multi) inm_list;	/* list of multicast addresses */
237 	u_int	inm_state;		/* state of membership */
238 	struct	router_info *inm_rti;	/* router version info */
239 };
240 
241 #ifdef _KERNEL
242 /*
243  * Structure used by macros below to remember position when stepping through
244  * all of the in_multi records.
245  */
246 struct in_multistep {
247 	struct in_ifaddr *i_ia;
248 	struct in_multi *i_inm;
249 };
250 
251 /*
252  * Macro for looking up the in_multi record for a given IP multicast address
253  * on a given interface.  If no matching record is found, "inm" returns NULL.
254  */
255 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
256 	/* struct in_addr addr; */ \
257 	/* struct ifnet *ifp; */ \
258 	/* struct in_multi *inm; */ \
259 { \
260 	struct in_ifaddr *ia; \
261 \
262 	IFP_TO_IA((ifp), ia); 			/* multicast */ \
263 	if (ia == NULL) \
264 		(inm) = NULL; \
265 	else \
266 		for ((inm) = ia->ia_multiaddrs.lh_first; \
267 		    (inm) != NULL && !in_hosteq((inm)->inm_addr, (addr)); \
268 		     (inm) = inm->inm_list.le_next) \
269 			 continue; \
270 }
271 
272 /*
273  * Macro to step through all of the in_multi records, one at a time.
274  * The current position is remembered in "step", which the caller must
275  * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
276  * and get the first record.  Both macros return a NULL "inm" when there
277  * are no remaining records.
278  */
279 #define IN_NEXT_MULTI(step, inm) \
280 	/* struct in_multistep  step; */ \
281 	/* struct in_multi *inm; */ \
282 { \
283 	if (((inm) = (step).i_inm) != NULL) \
284 		(step).i_inm = (inm)->inm_list.le_next; \
285 	else \
286 		while ((step).i_ia != NULL) { \
287 			(inm) = (step).i_ia->ia_multiaddrs.lh_first; \
288 			(step).i_ia = (step).i_ia->ia_list.tqe_next; \
289 			if ((inm) != NULL) { \
290 				(step).i_inm = (inm)->inm_list.le_next; \
291 				break; \
292 			} \
293 		} \
294 }
295 
296 #define IN_FIRST_MULTI(step, inm) \
297 	/* struct in_multistep step; */ \
298 	/* struct in_multi *inm; */ \
299 { \
300 	(step).i_ia = in_ifaddr.tqh_first; \
301 	(step).i_inm = NULL; \
302 	IN_NEXT_MULTI((step), (inm)); \
303 }
304 
305 struct ifaddr;
306 
307 int	in_ifinit __P((struct ifnet *,
308 	    struct in_ifaddr *, struct sockaddr_in *, int));
309 void	in_savemkludge __P((struct in_ifaddr *));
310 void	in_restoremkludge __P((struct in_ifaddr *, struct ifnet *));
311 void	in_purgemkludge __P((struct ifnet *));
312 struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
313 void	in_delmulti __P((struct in_multi *));
314 void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
315 void	in_setmaxmtu __P((void));
316 const char *in_fmtaddr __P((struct in_addr));
317 int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
318 	    struct proc *));
319 void	in_purgeaddr __P((struct ifaddr *, struct ifnet *));
320 void	in_purgeif __P((struct ifnet *));
321 void	ip_input __P((struct mbuf *));
322 int	ipflow_fastforward __P((struct mbuf *));
323 
324 #endif
325 
326 /* INET6 stuff */
327 #include <netinet6/in6_var.h>
328 
329 #endif /* _NETINET_IN_VAR_H_ */
330