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