FreeBSD/Linux Kernel Cross Reference
sys/netinet6/nd6.h
1 /*-
2 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the project nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $
30 * $FreeBSD: releng/10.4/sys/netinet6/nd6.h 303458 2016-07-28 20:08:01Z sbruno $
31 */
32
33 #ifndef _NETINET6_ND6_H_
34 #define _NETINET6_ND6_H_
35
36 /* see net/route.h, or net/if_inarp.h */
37 #ifndef RTF_ANNOUNCE
38 #define RTF_ANNOUNCE RTF_PROTO2
39 #endif
40
41 #include <sys/queue.h>
42 #include <sys/callout.h>
43
44 struct llentry;
45
46 #define ND6_LLINFO_NOSTATE -2
47 /*
48 * We don't need the WAITDELETE state any more, but we keep the definition
49 * in a comment line instead of removing it. This is necessary to avoid
50 * unintentionally reusing the value for another purpose, which might
51 * affect backward compatibility with old applications.
52 * (20000711 jinmei@kame.net)
53 */
54 /* #define ND6_LLINFO_WAITDELETE -1 */
55 #define ND6_LLINFO_INCOMPLETE 0
56 #define ND6_LLINFO_REACHABLE 1
57 #define ND6_LLINFO_STALE 2
58 #define ND6_LLINFO_DELAY 3
59 #define ND6_LLINFO_PROBE 4
60
61 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
62 #define ND6_LLINFO_PERMANENT(n) (((n)->la_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
63
64 struct nd_ifinfo {
65 u_int32_t linkmtu; /* LinkMTU */
66 u_int32_t maxmtu; /* Upper bound of LinkMTU */
67 u_int32_t basereachable; /* BaseReachableTime */
68 u_int32_t reachable; /* Reachable Time */
69 u_int32_t retrans; /* Retrans Timer */
70 u_int32_t flags; /* Flags */
71 int recalctm; /* BaseReacable re-calculation timer */
72 u_int8_t chlim; /* CurHopLimit */
73 u_int8_t initialized; /* Flag to see the entry is initialized */
74 /* the following 3 members are for privacy extension for addrconf */
75 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
76 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
77 u_int8_t randomid[8]; /* current random ID */
78 };
79
80 #define ND6_IFF_PERFORMNUD 0x1
81 #define ND6_IFF_ACCEPT_RTADV 0x2
82 #define ND6_IFF_PREFER_SOURCE 0x4 /* Not used in FreeBSD. */
83 #define ND6_IFF_IFDISABLED 0x8 /* IPv6 operation is disabled due to
84 * DAD failure. (XXX: not ND-specific)
85 */
86 #define ND6_IFF_DONT_SET_IFROUTE 0x10
87 #define ND6_IFF_AUTO_LINKLOCAL 0x20
88 #define ND6_IFF_NO_RADR 0x40
89 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */
90 #define ND6_IFF_NO_DAD 0x100
91
92 #define ND6_CREATE LLE_CREATE
93 #define ND6_EXCLUSIVE LLE_EXCLUSIVE
94
95 #ifdef _KERNEL
96 #define ND_IFINFO(ifp) \
97 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
98 #define IN6_LINKMTU(ifp) \
99 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
100 ? ND_IFINFO(ifp)->linkmtu \
101 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
102 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
103 #endif
104
105 struct in6_nbrinfo {
106 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
107 struct in6_addr addr; /* IPv6 address of the neighbor */
108 long asked; /* number of queries already sent for this addr */
109 int isrouter; /* if it acts as a router */
110 int state; /* reachability state */
111 int expire; /* lifetime for NDP state transition */
112 };
113
114 #define DRLSTSIZ 10
115 #define PRLSTSIZ 10
116 struct in6_drlist {
117 char ifname[IFNAMSIZ];
118 struct {
119 struct in6_addr rtaddr;
120 u_char flags;
121 u_short rtlifetime;
122 u_long expire;
123 u_short if_index;
124 } defrouter[DRLSTSIZ];
125 };
126
127 struct in6_defrouter {
128 struct sockaddr_in6 rtaddr;
129 u_char flags;
130 u_short rtlifetime;
131 u_long expire;
132 u_short if_index;
133 };
134
135 #ifdef _KERNEL
136 struct in6_oprlist {
137 char ifname[IFNAMSIZ];
138 struct {
139 struct in6_addr prefix;
140 struct prf_ra raflags;
141 u_char prefixlen;
142 u_char origin;
143 u_long vltime;
144 u_long pltime;
145 u_long expire;
146 u_short if_index;
147 u_short advrtrs; /* number of advertisement routers */
148 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
149 } prefix[PRLSTSIZ];
150 };
151 #endif
152
153 struct in6_prlist {
154 char ifname[IFNAMSIZ];
155 struct {
156 struct in6_addr prefix;
157 struct prf_ra raflags;
158 u_char prefixlen;
159 u_char origin;
160 u_int32_t vltime;
161 u_int32_t pltime;
162 time_t expire;
163 u_short if_index;
164 u_short advrtrs; /* number of advertisement routers */
165 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
166 } prefix[PRLSTSIZ];
167 };
168
169 struct in6_prefix {
170 struct sockaddr_in6 prefix;
171 struct prf_ra raflags;
172 u_char prefixlen;
173 u_char origin;
174 u_int32_t vltime;
175 u_int32_t pltime;
176 time_t expire;
177 u_int32_t flags;
178 int refcnt;
179 u_short if_index;
180 u_short advrtrs; /* number of advertisement routers */
181 /* struct sockaddr_in6 advrtr[] */
182 };
183
184 #ifdef _KERNEL
185 struct in6_ondireq {
186 char ifname[IFNAMSIZ];
187 struct {
188 u_int32_t linkmtu; /* LinkMTU */
189 u_int32_t maxmtu; /* Upper bound of LinkMTU */
190 u_int32_t basereachable; /* BaseReachableTime */
191 u_int32_t reachable; /* Reachable Time */
192 u_int32_t retrans; /* Retrans Timer */
193 u_int32_t flags; /* Flags */
194 int recalctm; /* BaseReacable re-calculation timer */
195 u_int8_t chlim; /* CurHopLimit */
196 u_int8_t receivedra;
197 } ndi;
198 };
199 #endif
200
201 struct in6_ndireq {
202 char ifname[IFNAMSIZ];
203 struct nd_ifinfo ndi;
204 };
205
206 struct in6_ndifreq {
207 char ifname[IFNAMSIZ];
208 u_long ifindex;
209 };
210
211 /* Prefix status */
212 #define NDPRF_ONLINK 0x1
213 #define NDPRF_DETACHED 0x2
214
215 /* protocol constants */
216 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
217 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
218 #define MAX_RTR_SOLICITATIONS 3
219
220 #define ND6_INFINITE_LIFETIME 0xffffffff
221
222 #ifdef _KERNEL
223 /* node constants */
224 #define MAX_REACHABLE_TIME 3600000 /* msec */
225 #define REACHABLE_TIME 30000 /* msec */
226 #define RETRANS_TIMER 1000 /* msec */
227 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
228 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
229 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
230 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
231 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
232 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
233 #define ND_COMPUTE_RTIME(x) \
234 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
235 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
236
237 TAILQ_HEAD(nd_drhead, nd_defrouter);
238 struct nd_defrouter {
239 TAILQ_ENTRY(nd_defrouter) dr_entry;
240 struct in6_addr rtaddr;
241 u_char raflags; /* flags on RA message */
242 u_short rtlifetime;
243 u_long expire;
244 struct ifnet *ifp;
245 int installed; /* is installed into kernel routing table */
246 u_int refcnt;
247 };
248
249 struct nd_prefixctl {
250 struct ifnet *ndpr_ifp;
251
252 /* prefix */
253 struct sockaddr_in6 ndpr_prefix;
254 u_char ndpr_plen;
255
256 u_int32_t ndpr_vltime; /* advertised valid lifetime */
257 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
258
259 struct prf_ra ndpr_flags;
260 };
261
262
263 struct nd_prefix {
264 struct ifnet *ndpr_ifp;
265 LIST_ENTRY(nd_prefix) ndpr_entry;
266 struct sockaddr_in6 ndpr_prefix; /* prefix */
267 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
268
269 u_int32_t ndpr_vltime; /* advertised valid lifetime */
270 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
271
272 time_t ndpr_expire; /* expiration time of the prefix */
273 time_t ndpr_preferred; /* preferred time of the prefix */
274 time_t ndpr_lastupdate; /* reception time of last advertisement */
275
276 struct prf_ra ndpr_flags;
277 u_int32_t ndpr_stateflags; /* actual state flags */
278 /* list of routers that advertise the prefix: */
279 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
280 u_char ndpr_plen;
281 int ndpr_refcnt; /* reference couter from addresses */
282 };
283
284 #define ndpr_raf ndpr_flags
285 #define ndpr_raf_onlink ndpr_flags.onlink
286 #define ndpr_raf_auto ndpr_flags.autonomous
287 #define ndpr_raf_router ndpr_flags.router
288
289 /*
290 * Message format for use in obtaining information about prefixes
291 * from inet6 sysctl function
292 */
293 struct inet6_ndpr_msghdr {
294 u_short inpm_msglen; /* to skip over non-understood messages */
295 u_char inpm_version; /* future binary compatibility */
296 u_char inpm_type; /* message type */
297 struct in6_addr inpm_prefix;
298 u_long prm_vltim;
299 u_long prm_pltime;
300 u_long prm_expire;
301 u_long prm_preferred;
302 struct in6_prflags prm_flags;
303 u_short prm_index; /* index for associated ifp */
304 u_char prm_plen; /* length of prefix in bits */
305 };
306
307 #define prm_raf_onlink prm_flags.prf_ra.onlink
308 #define prm_raf_auto prm_flags.prf_ra.autonomous
309
310 #define prm_statef_onlink prm_flags.prf_state.onlink
311
312 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
313 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
314
315 struct nd_pfxrouter {
316 LIST_ENTRY(nd_pfxrouter) pfr_entry;
317 struct nd_defrouter *router;
318 };
319
320 LIST_HEAD(nd_prhead, nd_prefix);
321
322 /* nd6.c */
323 VNET_DECLARE(int, nd6_prune);
324 VNET_DECLARE(int, nd6_delay);
325 VNET_DECLARE(int, nd6_umaxtries);
326 VNET_DECLARE(int, nd6_mmaxtries);
327 VNET_DECLARE(int, nd6_useloopback);
328 VNET_DECLARE(int, nd6_maxnudhint);
329 VNET_DECLARE(int, nd6_gctimer);
330 VNET_DECLARE(struct nd_drhead, nd_defrouter);
331 VNET_DECLARE(struct nd_prhead, nd_prefix);
332 VNET_DECLARE(int, nd6_debug);
333 VNET_DECLARE(int, nd6_onlink_ns_rfc4861);
334 #define V_nd6_prune VNET(nd6_prune)
335 #define V_nd6_delay VNET(nd6_delay)
336 #define V_nd6_umaxtries VNET(nd6_umaxtries)
337 #define V_nd6_mmaxtries VNET(nd6_mmaxtries)
338 #define V_nd6_useloopback VNET(nd6_useloopback)
339 #define V_nd6_maxnudhint VNET(nd6_maxnudhint)
340 #define V_nd6_gctimer VNET(nd6_gctimer)
341 #define V_nd_defrouter VNET(nd_defrouter)
342 #define V_nd_prefix VNET(nd_prefix)
343 #define V_nd6_debug VNET(nd6_debug)
344 #define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861)
345
346 /* Lock for the prefix and default router lists. */
347 VNET_DECLARE(struct rwlock, nd6_lock);
348 #define V_nd6_lock VNET(nd6_lock)
349
350 #define ND6_RLOCK() rw_rlock(&V_nd6_lock)
351 #define ND6_RUNLOCK() rw_runlock(&V_nd6_lock)
352 #define ND6_WLOCK() rw_wlock(&V_nd6_lock)
353 #define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock)
354 #define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED)
355 #define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED)
356 #define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED)
357 #define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED)
358
359 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
360
361 VNET_DECLARE(struct callout, nd6_timer_ch);
362 #define V_nd6_timer_ch VNET(nd6_timer_ch)
363
364 /* nd6_rtr.c */
365 VNET_DECLARE(int, nd6_defifindex);
366 VNET_DECLARE(int, ip6_desync_factor); /* seconds */
367 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
368 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
369 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
370 #define V_nd6_defifindex VNET(nd6_defifindex)
371 #define V_ip6_desync_factor VNET(ip6_desync_factor)
372 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
373 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
374 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
375
376 union nd_opts {
377 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
378 struct {
379 struct nd_opt_hdr *zero;
380 struct nd_opt_hdr *src_lladdr;
381 struct nd_opt_hdr *tgt_lladdr;
382 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
383 struct nd_opt_rd_hdr *rh;
384 struct nd_opt_mtu *mtu;
385 struct nd_opt_hdr *__res6;
386 struct nd_opt_hdr *__res7;
387 struct nd_opt_hdr *__res8;
388 struct nd_opt_hdr *__res9;
389 struct nd_opt_hdr *__res10;
390 struct nd_opt_hdr *__res11;
391 struct nd_opt_hdr *__res12;
392 struct nd_opt_hdr *__res13;
393 struct nd_opt_nonce *nonce;
394 struct nd_opt_hdr *__res15;
395 struct nd_opt_hdr *search; /* multiple opts */
396 struct nd_opt_hdr *last; /* multiple opts */
397 int done;
398 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
399 } nd_opt_each;
400 };
401 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
402 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
403 #define nd_opts_pi nd_opt_each.pi_beg
404 #define nd_opts_pi_end nd_opt_each.pi_end
405 #define nd_opts_rh nd_opt_each.rh
406 #define nd_opts_mtu nd_opt_each.mtu
407 #define nd_opts_nonce nd_opt_each.nonce
408 #define nd_opts_search nd_opt_each.search
409 #define nd_opts_last nd_opt_each.last
410 #define nd_opts_done nd_opt_each.done
411
412 /* XXX: need nd6_var.h?? */
413 /* nd6.c */
414 void nd6_init(void);
415 #ifdef VIMAGE
416 void nd6_destroy(void);
417 #endif
418 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
419 void nd6_ifdetach(struct nd_ifinfo *);
420 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *);
421 void nd6_option_init(void *, int, union nd_opts *);
422 struct nd_opt_hdr *nd6_option(union nd_opts *);
423 int nd6_options(union nd_opts *);
424 struct llentry *nd6_lookup(struct in6_addr *, int, struct ifnet *);
425 void nd6_setmtu(struct ifnet *);
426 void nd6_llinfo_settimer(struct llentry *, long);
427 void nd6_llinfo_settimer_locked(struct llentry *, long);
428 void nd6_timer(void *);
429 void nd6_purge(struct ifnet *);
430 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
431 int nd6_resolve(struct ifnet *, struct rtentry *, struct mbuf *,
432 struct sockaddr *, u_char *);
433 void nd6_rtrequest(int, struct rtentry *, struct rt_addrinfo *);
434 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
435 struct llentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
436 char *, int, int, int);
437 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
438 struct sockaddr_in6 *, struct rtentry *);
439 void nd6_grab_holdchain(struct llentry *, struct mbuf **,
440 struct sockaddr_in6 *);
441 int nd6_flush_holdchain(struct ifnet *, struct ifnet *, struct mbuf *,
442 struct sockaddr_in6 *);
443 int nd6_need_cache(struct ifnet *);
444 int nd6_storelladdr(struct ifnet *, struct mbuf *,
445 const struct sockaddr *, u_char *, struct llentry **);
446
447 /* nd6_nbr.c */
448 void nd6_na_input(struct mbuf *, int, int);
449 void nd6_na_output(struct ifnet *, const struct in6_addr *,
450 const struct in6_addr *, u_long, int, struct sockaddr *);
451 void nd6_ns_input(struct mbuf *, int, int);
452 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
453 const struct in6_addr *, struct llentry *, uint8_t *);
454 caddr_t nd6_ifptomac(struct ifnet *);
455 void nd6_dad_init(void);
456 void nd6_dad_start(struct ifaddr *, int);
457 void nd6_dad_stop(struct ifaddr *);
458
459 /* nd6_rtr.c */
460 void nd6_rs_input(struct mbuf *, int, int);
461 void nd6_ra_input(struct mbuf *, int, int);
462 void defrouter_reset(void);
463 void defrouter_select(void);
464 void defrouter_ref(struct nd_defrouter *);
465 void defrouter_rele(struct nd_defrouter *);
466 bool defrouter_remove(struct in6_addr *, struct ifnet *);
467 void defrouter_unlink(struct nd_defrouter *, struct nd_drhead *);
468 void defrouter_del(struct nd_defrouter *);
469 void prelist_remove(struct nd_prefix *);
470 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
471 struct nd_prefix **);
472 void pfxlist_onlink_check(void);
473 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
474 struct nd_defrouter *defrouter_lookup_locked(struct in6_addr *, struct ifnet *);
475 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
476 void rt6_flush(struct in6_addr *, struct ifnet *);
477 int nd6_setdefaultiface(int);
478 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
479
480 #endif /* _KERNEL */
481
482 #endif /* _NETINET6_ND6_H_ */
Cache object: 889e9fdd7c06f931353f5d493674081e
|