1 | /* $NetBSD: in_var.h,v 1.89 2016/11/18 10:38:55 knakahara 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 | #define IN_IFF_TENTATIVE 0x01 /* tentative address */ |
70 | #define IN_IFF_DUPLICATED 0x02 /* DAD detected duplicate */ |
71 | #define IN_IFF_DETACHED 0x04 /* may be detached from the link */ |
72 | #define IN_IFF_TRYTENTATIVE 0x08 /* intent to try DAD */ |
73 | |
74 | #define IN_IFFBITS \ |
75 | "\020\1TENTATIVE\2DUPLICATED\3DETACHED\4TRYTENTATIVE" |
76 | |
77 | /* do not input/output */ |
78 | #define IN_IFF_NOTREADY \ |
79 | (IN_IFF_TRYTENTATIVE | IN_IFF_TENTATIVE | IN_IFF_DUPLICATED) |
80 | |
81 | /* |
82 | * Interface address, Internet version. One of these structures |
83 | * is allocated for each interface with an Internet address. |
84 | * The ifaddr structure contains the protocol-independent part |
85 | * of the structure and is assumed to be first. |
86 | */ |
87 | struct in_ifaddr { |
88 | struct ifaddr ia_ifa; /* protocol-independent info */ |
89 | #define ia_ifp ia_ifa.ifa_ifp |
90 | #define ia_flags ia_ifa.ifa_flags |
91 | /* ia_{,sub}net{,mask} in host order */ |
92 | u_int32_t ia_net; /* network number of interface */ |
93 | u_int32_t ia_netmask; /* mask of net part */ |
94 | u_int32_t ia_subnet; /* subnet number, including net */ |
95 | u_int32_t ia_subnetmask; /* mask of subnet part */ |
96 | struct in_addr ia_netbroadcast; /* to recognize net broadcasts */ |
97 | LIST_ENTRY(in_ifaddr) ia_hash; /* entry in bucket of inet addresses */ |
98 | TAILQ_ENTRY(in_ifaddr) ia_list; /* list of internet addresses */ |
99 | struct sockaddr_in ia_addr; /* reserve space for interface name */ |
100 | struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */ |
101 | #define ia_broadaddr ia_dstaddr |
102 | struct sockaddr_in ia_sockmask; /* reserve space for general netmask */ |
103 | LIST_HEAD(, in_multi) ia_multiaddrs; /* list of multicast addresses */ |
104 | struct in_multi *ia_allhosts; /* multicast address record for |
105 | the allhosts multicast group */ |
106 | uint16_t ia_idsalt; /* ip_id salt for this ia */ |
107 | int ia4_flags; /* address flags */ |
108 | void (*ia_dad_start) (struct ifaddr *); /* DAD start function */ |
109 | void (*ia_dad_stop) (struct ifaddr *); /* DAD stop function */ |
110 | time_t ia_dad_defended; /* last time of DAD defence */ |
111 | |
112 | #ifdef _KERNEL |
113 | struct pslist_entry ia_hash_pslist_entry; |
114 | struct pslist_entry ia_pslist_entry; |
115 | #endif |
116 | }; |
117 | |
118 | #ifdef _KERNEL |
119 | static inline void |
120 | ia4_acquire(struct in_ifaddr *ia, struct psref *psref) |
121 | { |
122 | |
123 | KASSERT(ia != NULL); |
124 | ifa_acquire(&ia->ia_ifa, psref); |
125 | } |
126 | |
127 | static inline void |
128 | ia4_release(struct in_ifaddr *ia, struct psref *psref) |
129 | { |
130 | |
131 | if (ia == NULL) |
132 | return; |
133 | ifa_release(&ia->ia_ifa, psref); |
134 | } |
135 | #endif |
136 | |
137 | struct in_aliasreq { |
138 | char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
139 | struct sockaddr_in ifra_addr; |
140 | struct sockaddr_in ifra_dstaddr; |
141 | #define ifra_broadaddr ifra_dstaddr |
142 | struct sockaddr_in ifra_mask; |
143 | }; |
144 | |
145 | /* |
146 | * Given a pointer to an in_ifaddr (ifaddr), |
147 | * return a pointer to the addr as a sockaddr_in. |
148 | */ |
149 | #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr)) |
150 | |
151 | #define iatoifa(ia) (struct ifaddr *)(ia) |
152 | |
153 | #ifdef _KERNEL |
154 | |
155 | /* Note: 61, 127, 251, 509, 1021, 2039 are good. */ |
156 | #ifndef IN_IFADDR_HASH_SIZE |
157 | #define IN_IFADDR_HASH_SIZE 509 |
158 | #endif |
159 | |
160 | /* |
161 | * This is a bit unconventional, and wastes a little bit of space, but |
162 | * because we want a very even hash function we don't use & in_ifaddrhash |
163 | * here, but rather % the hash size, which should obviously be prime. |
164 | */ |
165 | |
166 | #define IN_IFADDR_HASH(x) in_ifaddrhashtbl[(u_long)(x) % IN_IFADDR_HASH_SIZE] |
167 | |
168 | LIST_HEAD(in_ifaddrhashhead, in_ifaddr); /* Type of the hash head */ |
169 | TAILQ_HEAD(in_ifaddrhead, in_ifaddr); /* Type of the list head */ |
170 | |
171 | extern u_long in_ifaddrhash; /* size of hash table - 1 */ |
172 | extern struct in_ifaddrhashhead *in_ifaddrhashtbl; /* Hash table head */ |
173 | extern struct in_ifaddrhead in_ifaddrhead; /* List head (in ip_input) */ |
174 | |
175 | extern pserialize_t in_ifaddrhash_psz; |
176 | extern struct pslist_head *in_ifaddrhashtbl_pslist; |
177 | extern u_long in_ifaddrhash_pslist; |
178 | extern struct pslist_head in_ifaddrhead_pslist; |
179 | |
180 | #define IN_IFADDR_HASH_PSLIST(x) \ |
181 | in_ifaddrhashtbl_pslist[(u_long)(x) % IN_IFADDR_HASH_SIZE] |
182 | |
183 | #define IN_ADDRHASH_READER_FOREACH(__ia, __addr) \ |
184 | PSLIST_READER_FOREACH((__ia), &IN_IFADDR_HASH_PSLIST(__addr), \ |
185 | struct in_ifaddr, ia_hash_pslist_entry) |
186 | #define IN_ADDRHASH_WRITER_INSERT_HEAD(__ia) \ |
187 | PSLIST_WRITER_INSERT_HEAD( \ |
188 | &IN_IFADDR_HASH_PSLIST((__ia)->ia_addr.sin_addr.s_addr), \ |
189 | (__ia), ia_hash_pslist_entry) |
190 | #define IN_ADDRHASH_WRITER_REMOVE(__ia) \ |
191 | PSLIST_WRITER_REMOVE((__ia), ia_hash_pslist_entry) |
192 | #define IN_ADDRHASH_ENTRY_INIT(__ia) \ |
193 | PSLIST_ENTRY_INIT((__ia), ia_hash_pslist_entry); |
194 | #define IN_ADDRHASH_ENTRY_DESTROY(__ia) \ |
195 | PSLIST_ENTRY_DESTROY((__ia), ia_hash_pslist_entry); |
196 | #define IN_ADDRHASH_READER_NEXT(__ia) \ |
197 | PSLIST_READER_NEXT((__ia), struct in_ifaddr, ia_hash_pslist_entry) |
198 | |
199 | #define IN_ADDRLIST_ENTRY_INIT(__ia) \ |
200 | PSLIST_ENTRY_INIT((__ia), ia_pslist_entry) |
201 | #define IN_ADDRLIST_ENTRY_DESTROY(__ia) \ |
202 | PSLIST_ENTRY_DESTROY((__ia), ia_pslist_entry); |
203 | #define IN_ADDRLIST_READER_EMPTY() \ |
204 | (PSLIST_READER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ |
205 | ia_pslist_entry) == NULL) |
206 | #define IN_ADDRLIST_READER_FIRST() \ |
207 | PSLIST_READER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ |
208 | ia_pslist_entry) |
209 | #define IN_ADDRLIST_READER_NEXT(__ia) \ |
210 | PSLIST_READER_NEXT((__ia), struct in_ifaddr, ia_pslist_entry) |
211 | #define IN_ADDRLIST_READER_FOREACH(__ia) \ |
212 | PSLIST_READER_FOREACH((__ia), &in_ifaddrhead_pslist, \ |
213 | struct in_ifaddr, ia_pslist_entry) |
214 | #define IN_ADDRLIST_WRITER_INSERT_HEAD(__ia) \ |
215 | PSLIST_WRITER_INSERT_HEAD(&in_ifaddrhead_pslist, (__ia), \ |
216 | ia_pslist_entry) |
217 | #define IN_ADDRLIST_WRITER_REMOVE(__ia) \ |
218 | PSLIST_WRITER_REMOVE((__ia), ia_pslist_entry) |
219 | #define IN_ADDRLIST_WRITER_FOREACH(__ia) \ |
220 | PSLIST_WRITER_FOREACH((__ia), &in_ifaddrhead_pslist, \ |
221 | struct in_ifaddr, ia_pslist_entry) |
222 | #define IN_ADDRLIST_WRITER_FIRST() \ |
223 | PSLIST_WRITER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ |
224 | ia_pslist_entry) |
225 | #define IN_ADDRLIST_WRITER_NEXT(__ia) \ |
226 | PSLIST_WRITER_NEXT((__ia), struct in_ifaddr, ia_pslist_entry) |
227 | #define IN_ADDRLIST_WRITER_INSERT_AFTER(__ia, __new) \ |
228 | PSLIST_WRITER_INSERT_AFTER((__ia), (__new), ia_pslist_entry) |
229 | #define IN_ADDRLIST_WRITER_EMPTY() \ |
230 | (PSLIST_WRITER_FIRST(&in_ifaddrhead_pslist, struct in_ifaddr, \ |
231 | ia_pslist_entry) == NULL) |
232 | #define IN_ADDRLIST_WRITER_INSERT_TAIL(__new) \ |
233 | do { \ |
234 | if (IN_ADDRLIST_WRITER_EMPTY()) { \ |
235 | IN_ADDRLIST_WRITER_INSERT_HEAD((__new)); \ |
236 | } else { \ |
237 | struct in_ifaddr *__ia; \ |
238 | IN_ADDRLIST_WRITER_FOREACH(__ia) { \ |
239 | if (IN_ADDRLIST_WRITER_NEXT(__ia) == NULL) { \ |
240 | IN_ADDRLIST_WRITER_INSERT_AFTER(__ia,\ |
241 | (__new)); \ |
242 | break; \ |
243 | } \ |
244 | } \ |
245 | } \ |
246 | } while (0) |
247 | |
248 | extern const int inetctlerrmap[]; |
249 | |
250 | /* |
251 | * Find whether an internet address (in_addr) belongs to one |
252 | * of our interfaces (in_ifaddr). NULL if the address isn't ours. |
253 | */ |
254 | static inline struct in_ifaddr * |
255 | in_get_ia(struct in_addr addr) |
256 | { |
257 | struct in_ifaddr *ia; |
258 | |
259 | IN_ADDRHASH_READER_FOREACH(ia, addr.s_addr) { |
260 | if (in_hosteq(ia->ia_addr.sin_addr, addr)) |
261 | break; |
262 | } |
263 | |
264 | return ia; |
265 | } |
266 | |
267 | static inline struct in_ifaddr * |
268 | in_get_ia_psref(struct in_addr addr, struct psref *psref) |
269 | { |
270 | struct in_ifaddr *ia; |
271 | int s; |
272 | |
273 | s = pserialize_read_enter(); |
274 | ia = in_get_ia(addr); |
275 | if (ia != NULL) |
276 | ia4_acquire(ia, psref); |
277 | pserialize_read_exit(s); |
278 | |
279 | return ia; |
280 | } |
281 | |
282 | /* |
283 | * Find whether an internet address (in_addr) belongs to a specified |
284 | * interface. NULL if the address isn't ours. |
285 | */ |
286 | static inline struct in_ifaddr * |
287 | in_get_ia_on_iface(struct in_addr addr, struct ifnet *ifp) |
288 | { |
289 | struct in_ifaddr *ia; |
290 | |
291 | IN_ADDRHASH_READER_FOREACH(ia, addr.s_addr) { |
292 | if (in_hosteq(ia->ia_addr.sin_addr, addr) && |
293 | ia->ia_ifp == ifp) |
294 | break; |
295 | } |
296 | |
297 | return ia; |
298 | } |
299 | |
300 | static inline struct in_ifaddr * |
301 | in_get_ia_on_iface_psref(struct in_addr addr, struct ifnet *ifp, struct psref *psref) |
302 | { |
303 | struct in_ifaddr *ia; |
304 | int s; |
305 | |
306 | s = pserialize_read_enter(); |
307 | ia = in_get_ia_on_iface(addr, ifp); |
308 | if (ia != NULL) |
309 | ia4_acquire(ia, psref); |
310 | pserialize_read_exit(s); |
311 | |
312 | return ia; |
313 | } |
314 | |
315 | /* |
316 | * Find an internet address structure (in_ifaddr) corresponding |
317 | * to a given interface (ifnet structure). |
318 | */ |
319 | static inline struct in_ifaddr * |
320 | in_get_ia_from_ifp(struct ifnet *ifp) |
321 | { |
322 | struct ifaddr *ifa; |
323 | |
324 | IFADDR_READER_FOREACH(ifa, ifp) { |
325 | if (ifa->ifa_addr->sa_family == AF_INET) |
326 | break; |
327 | } |
328 | |
329 | return ifatoia(ifa); |
330 | } |
331 | |
332 | static inline struct in_ifaddr * |
333 | in_get_ia_from_ifp_psref(struct ifnet *ifp, struct psref *psref) |
334 | { |
335 | struct in_ifaddr *ia; |
336 | int s; |
337 | |
338 | s = pserialize_read_enter(); |
339 | ia = in_get_ia_from_ifp(ifp); |
340 | if (ia != NULL) |
341 | ia4_acquire(ia, psref); |
342 | pserialize_read_exit(s); |
343 | |
344 | return ia; |
345 | } |
346 | |
347 | #include <netinet/in_selsrc.h> |
348 | /* |
349 | * IPv4 per-interface state. |
350 | */ |
351 | struct in_ifinfo { |
352 | struct lltable *ii_llt; /* ARP state */ |
353 | struct in_ifsysctl *ii_selsrc; |
354 | }; |
355 | |
356 | #endif /* _KERNEL */ |
357 | |
358 | /* |
359 | * Internet multicast address structure. There is one of these for each IP |
360 | * multicast group to which this host belongs on a given network interface. |
361 | * They are kept in a linked list, rooted in the interface's in_ifaddr |
362 | * structure. |
363 | */ |
364 | struct router_info; |
365 | |
366 | struct in_multi { |
367 | LIST_ENTRY(in_multi) inm_list; /* list of multicast addresses */ |
368 | struct router_info *inm_rti; /* router version info */ |
369 | struct ifnet *inm_ifp; /* back pointer to ifnet */ |
370 | struct in_addr inm_addr; /* IP multicast address */ |
371 | u_int inm_refcount; /* no. membership claims by sockets */ |
372 | u_int inm_timer; /* IGMP membership report timer */ |
373 | u_int inm_state; /* state of membership */ |
374 | }; |
375 | |
376 | #ifdef _KERNEL |
377 | |
378 | #include <net/pktqueue.h> |
379 | |
380 | extern pktqueue_t *ip_pktq; |
381 | |
382 | extern int ip_dad_count; /* Duplicate Address Detection probes */ |
383 | #if defined(INET) && NARP > 0 |
384 | extern int arp_debug; |
385 | #define arplog(level, fmt, args...) \ |
386 | do { if (arp_debug) log(level, "%s: " fmt, __func__, ##args);} while (0) |
387 | #else |
388 | #define arplog(level, fmt, args...) |
389 | #endif |
390 | |
391 | /* |
392 | * Structure used by functions below to remember position when stepping |
393 | * through all of the in_multi records. |
394 | */ |
395 | struct in_multistep { |
396 | int i_n; |
397 | struct in_multi *i_inm; |
398 | }; |
399 | |
400 | bool in_multi_group(struct in_addr, struct ifnet *, int); |
401 | struct in_multi *in_first_multi(struct in_multistep *); |
402 | struct in_multi *in_next_multi(struct in_multistep *); |
403 | struct in_multi *in_lookup_multi(struct in_addr, struct ifnet *); |
404 | struct in_multi *in_addmulti(struct in_addr *, struct ifnet *); |
405 | void in_delmulti(struct in_multi *); |
406 | |
407 | void in_multi_lock(int); |
408 | void in_multi_unlock(void); |
409 | int in_multi_lock_held(void); |
410 | |
411 | struct ifaddr; |
412 | |
413 | int in_ifinit(struct ifnet *, struct in_ifaddr *, |
414 | const struct sockaddr_in *, const struct sockaddr_in *, int); |
415 | void in_savemkludge(struct in_ifaddr *); |
416 | void in_restoremkludge(struct in_ifaddr *, struct ifnet *); |
417 | void in_purgemkludge(struct ifnet *); |
418 | void in_setmaxmtu(void); |
419 | const char *in_fmtaddr(struct in_addr); |
420 | int in_control(struct socket *, u_long, void *, struct ifnet *); |
421 | void in_purgeaddr(struct ifaddr *); |
422 | void in_purgeif(struct ifnet *); |
423 | int ipflow_fastforward(struct mbuf *); |
424 | |
425 | struct ipid_state; |
426 | typedef struct ipid_state ipid_state_t; |
427 | |
428 | ipid_state_t * ip_id_init(void); |
429 | void ip_id_fini(ipid_state_t *); |
430 | uint16_t ip_randomid(ipid_state_t *, uint16_t); |
431 | |
432 | extern ipid_state_t * ip_ids; |
433 | extern uint16_t ip_id; |
434 | extern int ip_do_randomid; |
435 | |
436 | /* |
437 | * ip_newid_range: "allocate" num contiguous IP IDs. |
438 | * |
439 | * => Return the first ID. |
440 | */ |
441 | static __inline uint16_t |
442 | ip_newid_range(const struct in_ifaddr *ia, u_int num) |
443 | { |
444 | uint16_t id; |
445 | |
446 | if (ip_do_randomid) { |
447 | /* XXX ignore num */ |
448 | return ip_randomid(ip_ids, ia ? ia->ia_idsalt : 0); |
449 | } |
450 | |
451 | /* Never allow an IP ID of 0 (detect wrap). */ |
452 | if ((uint16_t)(ip_id + num) < ip_id) { |
453 | ip_id = 1; |
454 | } |
455 | id = htons(ip_id); |
456 | ip_id += num; |
457 | return id; |
458 | } |
459 | |
460 | static __inline uint16_t |
461 | ip_newid(const struct in_ifaddr *ia) |
462 | { |
463 | |
464 | return ip_newid_range(ia, 1); |
465 | } |
466 | |
467 | #ifdef SYSCTLFN_PROTO |
468 | int sysctl_inpcblist(SYSCTLFN_PROTO); |
469 | #endif |
470 | |
471 | #define LLTABLE(ifp) \ |
472 | ((struct in_ifinfo *)(ifp)->if_afdata[AF_INET])->ii_llt |
473 | |
474 | #endif /* !_KERNEL */ |
475 | |
476 | /* INET6 stuff */ |
477 | #include <netinet6/in6_var.h> |
478 | |
479 | #endif /* !_NETINET_IN_VAR_H_ */ |
480 | |