2 /* $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ */
5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the project nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #ifndef _NETINET6_ND6_H_
34 #define _NETINET6_ND6_H_
36 /* see net/route.h, or net/if_inarp.h */
38 #define RTF_ANNOUNCE RTF_PROTO2
41 #include <sys/queue.h>
42 #include <sys/callout.h>
45 struct llinfo_nd6 *ln_next;
46 struct llinfo_nd6 *ln_prev;
47 struct rtentry *ln_rt;
48 struct mbuf *ln_hold; /* last packet until resolved/timeout */
49 long ln_asked; /* number of queries already sent for this addr */
50 u_long ln_expire; /* lifetime for NDP state transition */
51 short ln_state; /* reachability state */
52 short ln_router; /* 2^0: ND6 router bit */
53 int ln_byhint; /* # of times we made it reachable by UL hint */
56 #define ND6_LLINFO_NOSTATE -2
58 * We don't need the WAITDELETE state any more, but we keep the definition
59 * in a comment line instead of removing it. This is necessary to avoid
60 * unintentionally reusing the value for another purpose, which might
61 * affect backward compatibility with old applications.
62 * (20000711 jinmei@kame.net)
64 /* #define ND6_LLINFO_WAITDELETE -1 */
65 #define ND6_LLINFO_INCOMPLETE 0
66 #define ND6_LLINFO_REACHABLE 1
67 #define ND6_LLINFO_STALE 2
68 #define ND6_LLINFO_DELAY 3
69 #define ND6_LLINFO_PROBE 4
71 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
74 u_int32_t linkmtu; /* LinkMTU */
75 u_int32_t maxmtu; /* Upper bound of LinkMTU */
76 u_int32_t basereachable; /* BaseReachableTime */
77 u_int32_t reachable; /* Reachable Time */
78 u_int32_t retrans; /* Retrans Timer */
79 u_int32_t flags; /* Flags */
80 int recalctm; /* BaseReacable re-calculation timer */
81 u_int8_t chlim; /* CurHopLimit */
82 u_int8_t initialized; /* Flag to see the entry is initialized */
83 /* the following 3 members are for privacy extension for addrconf */
84 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
85 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
86 u_int8_t randomid[8]; /* current random ID */
89 #define ND6_IFF_PERFORMNUD 0x1
90 #define ND6_IFF_ACCEPT_RTADV 0x2
93 #define ND_IFINFO(ifp) \
94 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
95 #define IN6_LINKMTU(ifp) \
96 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
97 ? ND_IFINFO(ifp)->linkmtu \
98 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
99 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
103 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
104 struct in6_addr addr; /* IPv6 address of the neighbor */
105 long asked; /* number of queries already sent for this addr */
106 int isrouter; /* if it acts as a router */
107 int state; /* reachability state */
108 int expire; /* lifetime for NDP state transition */
114 char ifname[IFNAMSIZ];
116 struct in6_addr rtaddr;
121 } defrouter[DRLSTSIZ];
124 struct in6_defrouter {
125 struct sockaddr_in6 rtaddr;
134 char ifname[IFNAMSIZ];
136 struct in6_addr prefix;
137 struct prf_ra raflags;
144 u_short advrtrs; /* number of advertisement routers */
145 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
151 char ifname[IFNAMSIZ];
153 struct in6_addr prefix;
154 struct prf_ra raflags;
161 u_short advrtrs; /* number of advertisement routers */
162 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
167 struct sockaddr_in6 prefix;
168 struct prf_ra raflags;
177 u_short advrtrs; /* number of advertisement routers */
178 /* struct sockaddr_in6 advrtr[] */
183 char ifname[IFNAMSIZ];
185 u_int32_t linkmtu; /* LinkMTU */
186 u_int32_t maxmtu; /* Upper bound of LinkMTU */
187 u_int32_t basereachable; /* BaseReachableTime */
188 u_int32_t reachable; /* Reachable Time */
189 u_int32_t retrans; /* Retrans Timer */
190 u_int32_t flags; /* Flags */
191 int recalctm; /* BaseReacable re-calculation timer */
192 u_int8_t chlim; /* CurHopLimit */
199 char ifname[IFNAMSIZ];
200 struct nd_ifinfo ndi;
204 char ifname[IFNAMSIZ];
209 #define NDPRF_ONLINK 0x1
210 #define NDPRF_DETACHED 0x2
212 /* protocol constants */
213 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
214 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
215 #define MAX_RTR_SOLICITATIONS 3
217 #define ND6_INFINITE_LIFETIME 0xffffffff
221 #define MAX_REACHABLE_TIME 3600000 /* msec */
222 #define REACHABLE_TIME 30000 /* msec */
223 #define RETRANS_TIMER 1000 /* msec */
224 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
225 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
226 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
227 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
228 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
229 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
230 #define ND_COMPUTE_RTIME(x) \
231 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
232 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
234 TAILQ_HEAD(nd_drhead, nd_defrouter);
235 struct nd_defrouter {
236 TAILQ_ENTRY(nd_defrouter) dr_entry;
237 struct in6_addr rtaddr;
238 u_char flags; /* flags on RA message */
245 struct ifnet *ndpr_ifp;
246 LIST_ENTRY(nd_prefix) ndpr_entry;
247 struct sockaddr_in6 ndpr_prefix; /* prefix */
248 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
249 struct in6_addr ndpr_addr; /* address that is derived from the prefix */
250 u_int32_t ndpr_vltime; /* advertised valid lifetime */
251 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
252 time_t ndpr_expire; /* expiration time of the prefix */
253 time_t ndpr_preferred; /* preferred time of the prefix */
254 struct prf_ra ndpr_flags;
255 u_int32_t ndpr_stateflags; /* actual state flags */
256 /* list of routers that advertise the prefix: */
257 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
259 int ndpr_refcnt; /* reference couter from addresses */
262 #define ndpr_next ndpr_entry.le_next
264 #define ndpr_raf ndpr_flags
265 #define ndpr_raf_onlink ndpr_flags.onlink
266 #define ndpr_raf_auto ndpr_flags.autonomous
269 * We keep expired prefix for certain amount of time, for validation purposes.
270 * 1800s = MaxRtrAdvInterval
272 #define NDPR_KEEP_EXPIRED (1800 * 2)
275 * Message format for use in obtaining information about prefixes
276 * from inet6 sysctl function
278 struct inet6_ndpr_msghdr {
279 u_short inpm_msglen; /* to skip over non-understood messages */
280 u_char inpm_version; /* future binary compatibility */
281 u_char inpm_type; /* message type */
282 struct in6_addr inpm_prefix;
286 u_long prm_preferred;
287 struct in6_prflags prm_flags;
288 u_short prm_index; /* index for associated ifp */
289 u_char prm_plen; /* length of prefix in bits */
292 #define prm_raf_onlink prm_flags.prf_ra.onlink
293 #define prm_raf_auto prm_flags.prf_ra.autonomous
295 #define prm_statef_onlink prm_flags.prf_state.onlink
297 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
298 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
300 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
301 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
303 struct nd_pfxrouter {
304 LIST_ENTRY(nd_pfxrouter) pfr_entry;
305 #define pfr_next pfr_entry.le_next
306 struct nd_defrouter *router;
309 LIST_HEAD(nd_prhead, nd_prefix);
312 extern int nd6_prune;
313 extern int nd6_delay;
314 extern int nd6_umaxtries;
315 extern int nd6_mmaxtries;
316 extern int nd6_useloopback;
317 extern int nd6_maxnudhint;
318 extern int nd6_gctimer;
319 extern struct llinfo_nd6 llinfo_nd6;
320 extern struct nd_ifinfo *nd_ifinfo;
321 extern struct nd_drhead nd_defrouter;
322 extern struct nd_prhead nd_prefix;
323 extern int nd6_debug;
325 #define nd6log(x) do { if (nd6_debug) log x; } while (/*CONSTCOND*/ 0)
327 extern struct callout nd6_timer_ch;
330 extern int nd6_defifindex;
331 extern int ip6_desync_factor; /* seconds */
332 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
333 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
334 extern int ip6_temp_regen_advance; /* seconds */
337 struct nd_opt_hdr *nd_opt_array[8]; /* max = target address list */
339 struct nd_opt_hdr *zero;
340 struct nd_opt_hdr *src_lladdr;
341 struct nd_opt_hdr *tgt_lladdr;
342 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
343 struct nd_opt_rd_hdr *rh;
344 struct nd_opt_mtu *mtu;
345 struct nd_opt_hdr *search; /* multiple opts */
346 struct nd_opt_hdr *last; /* multiple opts */
348 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
351 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
352 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
353 #define nd_opts_pi nd_opt_each.pi_beg
354 #define nd_opts_pi_end nd_opt_each.pi_end
355 #define nd_opts_rh nd_opt_each.rh
356 #define nd_opts_mtu nd_opt_each.mtu
357 #define nd_opts_search nd_opt_each.search
358 #define nd_opts_last nd_opt_each.last
359 #define nd_opts_done nd_opt_each.done
361 /* XXX: need nd6_var.h?? */
363 void nd6_init __P((void));
364 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
365 void nd6_ifdetach __P((struct nd_ifinfo *));
366 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
367 void nd6_option_init __P((void *, int, union nd_opts *));
368 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
369 int nd6_options __P((union nd_opts *));
370 struct rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
371 void nd6_setmtu __P((struct ifnet *));
372 void nd6_timer __P((void *));
373 void nd6_purge __P((struct ifnet *));
374 struct llinfo_nd6 *nd6_free __P((struct rtentry *));
375 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
376 int nd6_resolve __P((struct ifnet *, struct rtentry *, struct mbuf *,
377 struct sockaddr *, u_char *));
378 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
379 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
380 struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
381 char *, int, int, int));
382 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
383 struct sockaddr_in6 *, struct rtentry *));
384 int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
385 struct sockaddr *, u_char *));
386 int nd6_need_cache __P((struct ifnet *));
389 void nd6_na_input __P((struct mbuf *, int, int));
390 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
391 const struct in6_addr *, u_long, int, struct sockaddr *));
392 void nd6_ns_input __P((struct mbuf *, int, int));
393 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
394 const struct in6_addr *, struct llinfo_nd6 *, int));
395 caddr_t nd6_ifptomac __P((struct ifnet *));
396 void nd6_dad_start __P((struct ifaddr *, int *));
397 void nd6_dad_stop __P((struct ifaddr *));
398 void nd6_dad_duplicated __P((struct ifaddr *));
401 void nd6_rs_input __P((struct mbuf *, int, int));
402 void nd6_ra_input __P((struct mbuf *, int, int));
403 void prelist_del __P((struct nd_prefix *));
404 void defrouter_addreq __P((struct nd_defrouter *));
405 void defrouter_delreq __P((struct nd_defrouter *, int));
406 void defrouter_select __P((void));
407 void defrtrlist_del __P((struct nd_defrouter *));
408 void prelist_remove __P((struct nd_prefix *));
409 int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
411 int nd6_prelist_add __P((struct nd_prefix *, struct nd_defrouter *,
412 struct nd_prefix **));
413 int nd6_prefix_onlink __P((struct nd_prefix *));
414 int nd6_prefix_offlink __P((struct nd_prefix *));
415 void pfxlist_onlink_check __P((void));
416 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *, struct ifnet *));
417 struct nd_prefix *nd6_prefix_lookup __P((struct nd_prefix *));
418 int in6_init_prefix_ltimes __P((struct nd_prefix *));
419 void rt6_flush __P((struct in6_addr *, struct ifnet *));
420 int nd6_setdefaultiface __P((int));
421 int in6_tmpifadd __P((const struct in6_ifaddr *, int));
425 #endif /* _NETINET6_ND6_H_ */