in_var.h revision 1.69 1 /* $NetBSD: in_var.h,v 1.69 2014/06/05 23:48:16 rmind 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 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /*
34 * Copyright (c) 1985, 1986, 1993
35 * The Regents of the University of California. All rights reserved.
36 *
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
39 * are met:
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
45 * 3. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 * @(#)in_var.h 8.2 (Berkeley) 1/9/95
62 */
63
64 #ifndef _NETINET_IN_VAR_H_
65 #define _NETINET_IN_VAR_H_
66
67 #include <sys/queue.h>
68
69 /*
70 * Interface address, Internet version. One of these structures
71 * is allocated for each interface with an Internet address.
72 * The ifaddr structure contains the protocol-independent part
73 * of the structure and is assumed to be first.
74 */
75 struct in_ifaddr {
76 struct ifaddr ia_ifa; /* protocol-independent info */
77 #define ia_ifp ia_ifa.ifa_ifp
78 #define ia_flags ia_ifa.ifa_flags
79 /* ia_{,sub}net{,mask} in host order */
80 u_int32_t ia_net; /* network number of interface */
81 u_int32_t ia_netmask; /* mask of net part */
82 u_int32_t ia_subnet; /* subnet number, including net */
83 u_int32_t ia_subnetmask; /* mask of subnet part */
84 struct in_addr ia_netbroadcast; /* to recognize net broadcasts */
85 LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */
86 TAILQ_ENTRY(in_ifaddr) ia_list; /* list of internet addresses */
87 struct sockaddr_in ia_addr; /* reserve space for interface name */
88 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
89 #define ia_broadaddr ia_dstaddr
90 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */
91 LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */
92 struct in_multi *ia_allhosts; /* multicast address record for
93 the allhosts multicast group */
94 uint16_t ia_idsalt; /* ip_id salt for this ia */
95 };
96
97 struct in_aliasreq {
98 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
99 struct sockaddr_in ifra_addr;
100 struct sockaddr_in ifra_dstaddr;
101 #define ifra_broadaddr ifra_dstaddr
102 struct sockaddr_in ifra_mask;
103 };
104 /*
105 * Given a pointer to an in_ifaddr (ifaddr),
106 * return a pointer to the addr as a sockaddr_in.
107 */
108 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
109
110 #ifdef _KERNEL
111
112 /* Note: 61, 127, 251, 509, 1021, 2039 are good. */
113 #ifndef IN_IFADDR_HASH_SIZE
114 #define IN_IFADDR_HASH_SIZE 509
115 #endif
116
117 /*
118 * This is a bit unconventional, and wastes a little bit of space, but
119 * because we want a very even hash function we don't use & in_ifaddrhash
120 * here, but rather % the hash size, which should obviously be prime.
121 */
122
123 #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE]
124
125 LIST_HEAD(in_ifaddrhashhead, in_ifaddr); /* Type of the hash head */
126 TAILQ_HEAD(in_ifaddrhead, in_ifaddr); /* Type of the list head */
127
128 extern u_long in_ifaddrhash; /* size of hash table - 1 */
129 extern struct in_ifaddrhashhead *in_ifaddrhashtbl; /* Hash table head */
130 extern struct in_ifaddrhead in_ifaddrhead; /* List head (in ip_input) */
131
132 extern const int inetctlerrmap[];
133
134 /*
135 * Macro for finding whether an internet address (in_addr) belongs to one
136 * of our interfaces (in_ifaddr). NULL if the address isn't ours.
137 */
138 #define INADDR_TO_IA(addr, ia) \
139 /* struct in_addr addr; */ \
140 /* struct in_ifaddr *ia; */ \
141 { \
142 LIST_FOREACH(ia, &IN_IFADDR_HASH((addr).s_addr), ia_hash) { \
143 if (in_hosteq(ia->ia_addr.sin_addr, (addr))) \
144 break; \
145 } \
146 }
147
148 /*
149 * Macro for finding the next in_ifaddr structure with the same internet
150 * address as ia. Call only with a valid ia pointer.
151 * Will set ia to NULL if none found.
152 */
153
154 #define NEXT_IA_WITH_SAME_ADDR(ia) \
155 /* struct in_ifaddr *ia; */ \
156 { \
157 struct in_addr addr; \
158 addr = ia->ia_addr.sin_addr; \
159 do { \
160 ia = LIST_NEXT(ia, ia_hash); \
161 } while ((ia != NULL) && !in_hosteq(ia->ia_addr.sin_addr, addr)); \
162 }
163
164 /*
165 * Macro for finding the interface (ifnet structure) corresponding to one
166 * of our IP addresses.
167 */
168 #define INADDR_TO_IFP(addr, ifp) \
169 /* struct in_addr addr; */ \
170 /* struct ifnet *ifp; */ \
171 { \
172 struct in_ifaddr *ia; \
173 \
174 INADDR_TO_IA(addr, ia); \
175 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
176 }
177
178 /*
179 * Macro for finding an internet address structure (in_ifaddr) corresponding
180 * to a given interface (ifnet structure).
181 */
182 #define IFP_TO_IA(ifp, ia) \
183 /* struct ifnet *ifp; */ \
184 /* struct in_ifaddr *ia; */ \
185 { \
186 struct ifaddr *ifa; \
187 \
188 IFADDR_FOREACH(ifa, ifp) { \
189 if (ifa->ifa_addr->sa_family == AF_INET) \
190 break; \
191 } \
192 (ia) = ifatoia(ifa); \
193 }
194 #endif
195
196 /*
197 * Internet multicast address structure. There is one of these for each IP
198 * multicast group to which this host belongs on a given network interface.
199 * They are kept in a linked list, rooted in the interface's in_ifaddr
200 * structure.
201 */
202 struct router_info;
203
204 struct in_multi {
205 LIST_ENTRY(in_multi) inm_list; /* list of multicast addresses */
206 struct router_info *inm_rti; /* router version info */
207 struct ifnet *inm_ifp; /* back pointer to ifnet */
208 struct in_addr inm_addr; /* IP multicast address */
209 u_int inm_refcount; /* no. membership claims by sockets */
210 u_int inm_timer; /* IGMP membership report timer */
211 u_int inm_state; /* state of membership */
212 };
213
214 #ifdef _KERNEL
215
216 #include <net/pktqueue.h>
217
218 extern pktqueue_t *ip_pktq;
219
220 /*
221 * Structure used by functions below to remember position when stepping
222 * through all of the in_multi records.
223 */
224 struct in_multistep {
225 int i_n;
226 struct in_multi *i_inm;
227 };
228
229 bool in_multi_group(struct in_addr, struct ifnet *, int);
230 struct in_multi *in_first_multi(struct in_multistep *);
231 struct in_multi *in_next_multi(struct in_multistep *);
232 struct in_multi *in_lookup_multi(struct in_addr, struct ifnet *);
233 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
234 void in_delmulti(struct in_multi *);
235
236 void in_multi_lock(int);
237 void in_multi_unlock(void);
238 int in_multi_lock_held(void);
239
240 struct ifaddr;
241
242 int in_ifinit(struct ifnet *,
243 struct in_ifaddr *, const struct sockaddr_in *, int);
244 void in_savemkludge(struct in_ifaddr *);
245 void in_restoremkludge(struct in_ifaddr *, struct ifnet *);
246 void in_purgemkludge(struct ifnet *);
247 void in_ifscrub(struct ifnet *, struct in_ifaddr *);
248 void in_setmaxmtu(void);
249 const char *in_fmtaddr(struct in_addr);
250 int in_control(struct socket *, u_long, void *, struct ifnet *,
251 struct lwp *);
252 void in_purgeaddr(struct ifaddr *);
253 void in_purgeif(struct ifnet *);
254 int ipflow_fastforward(struct mbuf *);
255
256 struct ipid_state;
257 typedef struct ipid_state ipid_state_t;
258
259 ipid_state_t * ip_id_init(void);
260 void ip_id_fini(ipid_state_t *);
261 uint16_t ip_randomid(ipid_state_t *, uint16_t);
262
263 extern ipid_state_t * ip_ids;
264 extern uint16_t ip_id;
265 extern int ip_do_randomid;
266
267 /*
268 * ip_newid_range: "allocate" num contiguous IP IDs.
269 *
270 * => Return the first ID.
271 */
272 static __inline uint16_t
273 ip_newid_range(const struct in_ifaddr *ia, u_int num)
274 {
275 uint16_t id;
276
277 if (ip_do_randomid) {
278 /* XXX ignore num */
279 return ip_randomid(ip_ids, ia ? ia->ia_idsalt : 0);
280 }
281
282 /* Never allow an IP ID of 0 (detect wrap). */
283 if ((uint16_t)(ip_id + num) < ip_id) {
284 ip_id = 1;
285 }
286 id = htons(ip_id);
287 ip_id += num;
288 return id;
289 }
290
291 static __inline uint16_t
292 ip_newid(const struct in_ifaddr *ia)
293 {
294
295 return ip_newid_range(ia, 1);
296 }
297
298 #ifdef SYSCTLFN_PROTO
299 int sysctl_inpcblist(SYSCTLFN_PROTO);
300 #endif
301
302 #endif /* !_KERNEL */
303
304 /* INET6 stuff */
305 #include <netinet6/in6_var.h>
306
307 #endif /* !_NETINET_IN_VAR_H_ */
308