in_var.h revision 1.32 1 /* $NetBSD: in_var.h,v 1.32 1998/12/19 02:46:12 thorpej 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 };
104
105 struct in_aliasreq {
106 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
107 struct sockaddr_in ifra_addr;
108 struct sockaddr_in ifra_dstaddr;
109 #define ifra_broadaddr ifra_dstaddr
110 struct sockaddr_in ifra_mask;
111 };
112 /*
113 * Given a pointer to an in_ifaddr (ifaddr),
114 * return a pointer to the addr as a sockaddr_in.
115 */
116 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
117
118
119 #ifdef _KERNEL
120 #ifndef IN_IFADDR_HASH_SIZE
121 #define IN_IFADDR_HASH_SIZE 509 /* 61, 127, 251, 509, 1021, 2039 are good */
122 #endif
123
124 /*
125 * This is a bit unconventional, and wastes a little bit of space, but
126 * because we want a very even hash function we don't use & in_ifaddrhash
127 * here, but rather % the hash size, which should obviously be prime.
128 */
129
130 #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
131
132 u_long in_ifaddrhash; /* size of hash table - 1 */
133 int in_ifaddrentries; /* total number of addrs */
134 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); /* Type of the hash head */
135 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); /* Type of the list head */
136
137 extern struct in_ifaddrhashhead *in_ifaddrhashtbl; /* Hash table head */
138 extern struct in_ifaddrhead in_ifaddr; /* List head (in ip_input) */
139
140 extern struct ifqueue ipintrq; /* ip packet input queue */
141 void in_socktrim __P((struct sockaddr_in *));
142
143
144 /*
145 * Macro for finding whether an internet address (in_addr) belongs to one
146 * of our interfaces (in_ifaddr). NULL if the address isn't ours.
147 */
148 #define INADDR_TO_IA(addr, ia) \
149 /* struct in_addr addr; */ \
150 /* struct in_ifaddr *ia; */ \
151 { \
152 for (ia = IN_IFADDR_HASH((addr).s_addr).lh_first; \
153 ia != NULL && !in_hosteq(ia->ia_addr.sin_addr, (addr)); \
154 ia = ia->ia_hash.le_next) \
155 continue; \
156 }
157
158 /*
159 * Macro for finding the next in_ifaddr structure with the same internet
160 * address as ia. Call only with a valid ia pointer.
161 * Will set ia to NULL if none found.
162 */
163
164 #define NEXT_IA_WITH_SAME_ADDR(ia) \
165 /* struct in_ifaddr *ia; */ \
166 { \
167 struct in_addr addr; \
168 addr = ia->ia_addr.sin_addr; \
169 do { \
170 ia = ia->ia_hash.le_next; \
171 } while ((ia != NULL) && !in_hosteq(ia->ia_addr.sin_addr, addr)); \
172 }
173
174 /*
175 * Macro for finding the interface (ifnet structure) corresponding to one
176 * of our IP addresses.
177 */
178 #define INADDR_TO_IFP(addr, ifp) \
179 /* struct in_addr addr; */ \
180 /* struct ifnet *ifp; */ \
181 { \
182 register struct in_ifaddr *ia; \
183 \
184 INADDR_TO_IA(addr, ia); \
185 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
186 }
187
188 /*
189 * Macro for finding an internet address structure (in_ifaddr) corresponding
190 * to a given interface (ifnet structure).
191 */
192 #define IFP_TO_IA(ifp, ia) \
193 /* struct ifnet *ifp; */ \
194 /* struct in_ifaddr *ia; */ \
195 { \
196 register struct ifaddr *ifa; \
197 \
198 for (ifa = (ifp)->if_addrlist.tqh_first; \
199 ifa != NULL && ifa->ifa_addr->sa_family != AF_INET; \
200 ifa = ifa->ifa_list.tqe_next) \
201 continue; \
202 (ia) = ifatoia(ifa); \
203 }
204 #endif
205
206 /*
207 * Per-interface router version information.
208 */
209 struct router_info {
210 struct ifnet *rti_ifp;
211 int rti_type; /* type of router on this interface */
212 int rti_age; /* time since last v1 query */
213 struct router_info *rti_next;
214 };
215
216 /*
217 * Internet multicast address structure. There is one of these for each IP
218 * multicast group to which this host belongs on a given network interface.
219 * They are kept in a linked list, rooted in the interface's in_ifaddr
220 * structure.
221 */
222 struct in_multi {
223 struct in_addr inm_addr; /* IP multicast address */
224 struct ifnet *inm_ifp; /* back pointer to ifnet */
225 struct in_ifaddr *inm_ia; /* back pointer to in_ifaddr */
226 u_int inm_refcount; /* no. membership claims by sockets */
227 u_int inm_timer; /* IGMP membership report timer */
228 LIST_ENTRY(in_multi) inm_list; /* list of multicast addresses */
229 u_int inm_state; /* state of membership */
230 struct router_info *inm_rti; /* router version info */
231 };
232
233 #ifdef _KERNEL
234 /*
235 * Structure used by macros below to remember position when stepping through
236 * all of the in_multi records.
237 */
238 struct in_multistep {
239 struct in_ifaddr *i_ia;
240 struct in_multi *i_inm;
241 };
242
243 /*
244 * Macro for looking up the in_multi record for a given IP multicast address
245 * on a given interface. If no matching record is found, "inm" returns NULL.
246 */
247 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
248 /* struct in_addr addr; */ \
249 /* struct ifnet *ifp; */ \
250 /* struct in_multi *inm; */ \
251 { \
252 register struct in_ifaddr *ia; \
253 \
254 IFP_TO_IA((ifp), ia); /* multicast */ \
255 if (ia == NULL) \
256 (inm) = NULL; \
257 else \
258 for ((inm) = ia->ia_multiaddrs.lh_first; \
259 (inm) != NULL && !in_hosteq((inm)->inm_addr, (addr)); \
260 (inm) = inm->inm_list.le_next) \
261 continue; \
262 }
263
264 /*
265 * Macro to step through all of the in_multi records, one at a time.
266 * The current position is remembered in "step", which the caller must
267 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step"
268 * and get the first record. Both macros return a NULL "inm" when there
269 * are no remaining records.
270 */
271 #define IN_NEXT_MULTI(step, inm) \
272 /* struct in_multistep step; */ \
273 /* struct in_multi *inm; */ \
274 { \
275 if (((inm) = (step).i_inm) != NULL) \
276 (step).i_inm = (inm)->inm_list.le_next; \
277 else \
278 while ((step).i_ia != NULL) { \
279 (inm) = (step).i_ia->ia_multiaddrs.lh_first; \
280 (step).i_ia = (step).i_ia->ia_list.tqe_next; \
281 if ((inm) != NULL) { \
282 (step).i_inm = (inm)->inm_list.le_next; \
283 break; \
284 } \
285 } \
286 }
287
288 #define IN_FIRST_MULTI(step, inm) \
289 /* struct in_multistep step; */ \
290 /* struct in_multi *inm; */ \
291 { \
292 (step).i_ia = in_ifaddr.tqh_first; \
293 (step).i_inm = NULL; \
294 IN_NEXT_MULTI((step), (inm)); \
295 }
296
297 int in_ifinit __P((struct ifnet *,
298 struct in_ifaddr *, struct sockaddr_in *, int));
299 struct in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
300 void in_delmulti __P((struct in_multi *));
301 void in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
302 void in_setmaxmtu __P((void));
303 const char *in_fmtaddr __P((struct in_addr));
304 int in_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
305 struct proc *));
306 int ipflow_fastforward __P((struct mbuf *));
307 #endif
308
309 #endif /* _NETINET_IN_VAR_H_ */
310