2 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $
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>
46 #define ND6_LLINFO_NOSTATE -2
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)
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
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))
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 */
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)
86 #define ND6_IFF_DONT_SET_IFROUTE 0x10
87 #define ND6_IFF_AUTO_LINKLOCAL 0x20
88 #define ND6_IFF_NO_RADR 0x40
90 #define ND6_CREATE LLE_CREATE
91 #define ND6_EXCLUSIVE LLE_EXCLUSIVE
94 #define ND_IFINFO(ifp) \
95 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
96 #define IN6_LINKMTU(ifp) \
97 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
98 ? ND_IFINFO(ifp)->linkmtu \
99 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
100 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
104 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
105 struct in6_addr addr; /* IPv6 address of the neighbor */
106 long asked; /* number of queries already sent for this addr */
107 int isrouter; /* if it acts as a router */
108 int state; /* reachability state */
109 int expire; /* lifetime for NDP state transition */
115 char ifname[IFNAMSIZ];
117 struct in6_addr rtaddr;
122 } defrouter[DRLSTSIZ];
125 struct in6_defrouter {
126 struct sockaddr_in6 rtaddr;
135 char ifname[IFNAMSIZ];
137 struct in6_addr prefix;
138 struct prf_ra raflags;
145 u_short advrtrs; /* number of advertisement routers */
146 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
152 char ifname[IFNAMSIZ];
154 struct in6_addr prefix;
155 struct prf_ra raflags;
162 u_short advrtrs; /* number of advertisement routers */
163 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
168 struct sockaddr_in6 prefix;
169 struct prf_ra raflags;
178 u_short advrtrs; /* number of advertisement routers */
179 /* struct sockaddr_in6 advrtr[] */
184 char ifname[IFNAMSIZ];
186 u_int32_t linkmtu; /* LinkMTU */
187 u_int32_t maxmtu; /* Upper bound of LinkMTU */
188 u_int32_t basereachable; /* BaseReachableTime */
189 u_int32_t reachable; /* Reachable Time */
190 u_int32_t retrans; /* Retrans Timer */
191 u_int32_t flags; /* Flags */
192 int recalctm; /* BaseReacable re-calculation timer */
193 u_int8_t chlim; /* CurHopLimit */
200 char ifname[IFNAMSIZ];
201 struct nd_ifinfo ndi;
205 char ifname[IFNAMSIZ];
210 #define NDPRF_ONLINK 0x1
211 #define NDPRF_DETACHED 0x2
213 /* protocol constants */
214 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
215 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
216 #define MAX_RTR_SOLICITATIONS 3
218 #define ND6_INFINITE_LIFETIME 0xffffffff
222 #define MAX_REACHABLE_TIME 3600000 /* msec */
223 #define REACHABLE_TIME 30000 /* msec */
224 #define RETRANS_TIMER 1000 /* msec */
225 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
226 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
227 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
228 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
229 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
230 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
231 #define ND_COMPUTE_RTIME(x) \
232 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
233 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
235 TAILQ_HEAD(nd_drhead, nd_defrouter);
236 struct nd_defrouter {
237 TAILQ_ENTRY(nd_defrouter) dr_entry;
238 struct in6_addr rtaddr;
239 u_char flags; /* flags on RA message */
243 int installed; /* is installed into kernel routing table */
246 struct nd_prefixctl {
247 struct ifnet *ndpr_ifp;
250 struct sockaddr_in6 ndpr_prefix;
253 u_int32_t ndpr_vltime; /* advertised valid lifetime */
254 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
256 struct prf_ra ndpr_flags;
261 struct ifnet *ndpr_ifp;
262 LIST_ENTRY(nd_prefix) ndpr_entry;
263 struct sockaddr_in6 ndpr_prefix; /* prefix */
264 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
266 u_int32_t ndpr_vltime; /* advertised valid lifetime */
267 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
269 time_t ndpr_expire; /* expiration time of the prefix */
270 time_t ndpr_preferred; /* preferred time of the prefix */
271 time_t ndpr_lastupdate; /* reception time of last advertisement */
273 struct prf_ra ndpr_flags;
274 u_int32_t ndpr_stateflags; /* actual state flags */
275 /* list of routers that advertise the prefix: */
276 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
278 int ndpr_refcnt; /* reference couter from addresses */
281 #define ndpr_raf ndpr_flags
282 #define ndpr_raf_onlink ndpr_flags.onlink
283 #define ndpr_raf_auto ndpr_flags.autonomous
284 #define ndpr_raf_router ndpr_flags.router
287 * Message format for use in obtaining information about prefixes
288 * from inet6 sysctl function
290 struct inet6_ndpr_msghdr {
291 u_short inpm_msglen; /* to skip over non-understood messages */
292 u_char inpm_version; /* future binary compatibility */
293 u_char inpm_type; /* message type */
294 struct in6_addr inpm_prefix;
298 u_long prm_preferred;
299 struct in6_prflags prm_flags;
300 u_short prm_index; /* index for associated ifp */
301 u_char prm_plen; /* length of prefix in bits */
304 #define prm_raf_onlink prm_flags.prf_ra.onlink
305 #define prm_raf_auto prm_flags.prf_ra.autonomous
307 #define prm_statef_onlink prm_flags.prf_state.onlink
309 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
310 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
312 struct nd_pfxrouter {
313 LIST_ENTRY(nd_pfxrouter) pfr_entry;
314 struct nd_defrouter *router;
317 LIST_HEAD(nd_prhead, nd_prefix);
320 VNET_DECLARE(int, nd6_prune);
321 VNET_DECLARE(int, nd6_delay);
322 VNET_DECLARE(int, nd6_umaxtries);
323 VNET_DECLARE(int, nd6_mmaxtries);
324 VNET_DECLARE(int, nd6_useloopback);
325 VNET_DECLARE(int, nd6_maxnudhint);
326 VNET_DECLARE(int, nd6_gctimer);
327 VNET_DECLARE(struct nd_drhead, nd_defrouter);
328 VNET_DECLARE(struct nd_prhead, nd_prefix);
329 VNET_DECLARE(int, nd6_debug);
330 VNET_DECLARE(int, nd6_onlink_ns_rfc4861);
331 #define V_nd6_prune VNET(nd6_prune)
332 #define V_nd6_delay VNET(nd6_delay)
333 #define V_nd6_umaxtries VNET(nd6_umaxtries)
334 #define V_nd6_mmaxtries VNET(nd6_mmaxtries)
335 #define V_nd6_useloopback VNET(nd6_useloopback)
336 #define V_nd6_maxnudhint VNET(nd6_maxnudhint)
337 #define V_nd6_gctimer VNET(nd6_gctimer)
338 #define V_nd_defrouter VNET(nd_defrouter)
339 #define V_nd_prefix VNET(nd_prefix)
340 #define V_nd6_debug VNET(nd6_debug)
341 #define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861)
343 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
345 VNET_DECLARE(struct callout, nd6_timer_ch);
346 #define V_nd6_timer_ch VNET(nd6_timer_ch)
349 VNET_DECLARE(int, nd6_defifindex);
350 VNET_DECLARE(int, ip6_desync_factor); /* seconds */
351 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
352 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
353 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
354 #define V_nd6_defifindex VNET(nd6_defifindex)
355 #define V_ip6_desync_factor VNET(ip6_desync_factor)
356 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
357 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
358 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
361 struct nd_opt_hdr *nd_opt_array[8]; /* max = target address list */
363 struct nd_opt_hdr *zero;
364 struct nd_opt_hdr *src_lladdr;
365 struct nd_opt_hdr *tgt_lladdr;
366 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
367 struct nd_opt_rd_hdr *rh;
368 struct nd_opt_mtu *mtu;
369 struct nd_opt_hdr *search; /* multiple opts */
370 struct nd_opt_hdr *last; /* multiple opts */
372 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
375 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
376 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
377 #define nd_opts_pi nd_opt_each.pi_beg
378 #define nd_opts_pi_end nd_opt_each.pi_end
379 #define nd_opts_rh nd_opt_each.rh
380 #define nd_opts_mtu nd_opt_each.mtu
381 #define nd_opts_search nd_opt_each.search
382 #define nd_opts_last nd_opt_each.last
383 #define nd_opts_done nd_opt_each.done
385 /* XXX: need nd6_var.h?? */
387 void nd6_init __P((void));
389 void nd6_destroy __P((void));
391 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
392 void nd6_ifdetach __P((struct nd_ifinfo *));
393 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
394 void nd6_option_init __P((void *, int, union nd_opts *));
395 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
396 int nd6_options __P((union nd_opts *));
397 struct llentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
398 void nd6_setmtu __P((struct ifnet *));
399 void nd6_llinfo_settimer __P((struct llentry *, long));
400 void nd6_llinfo_settimer_locked __P((struct llentry *, long));
401 void nd6_timer __P((void *));
402 void nd6_purge __P((struct ifnet *));
403 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
404 int nd6_resolve __P((struct ifnet *, struct rtentry *, struct mbuf *,
405 struct sockaddr *, u_char *));
406 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
407 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
408 struct llentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
409 char *, int, int, int));
410 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
411 struct sockaddr_in6 *, struct rtentry *));
412 int nd6_output_lle __P((struct ifnet *, struct ifnet *, struct mbuf *,
413 struct sockaddr_in6 *, struct rtentry *, struct llentry *,
415 int nd6_output_flush __P((struct ifnet *, struct ifnet *, struct mbuf *,
416 struct sockaddr_in6 *, struct route *));
417 int nd6_need_cache __P((struct ifnet *));
418 int nd6_storelladdr __P((struct ifnet *, struct mbuf *,
419 struct sockaddr *, u_char *, struct llentry **));
422 void nd6_na_input __P((struct mbuf *, int, int));
423 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
424 const struct in6_addr *, u_long, int, struct sockaddr *));
425 void nd6_ns_input __P((struct mbuf *, int, int));
426 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
427 const struct in6_addr *, struct llentry *, int));
428 caddr_t nd6_ifptomac __P((struct ifnet *));
429 void nd6_dad_start __P((struct ifaddr *, int));
430 void nd6_dad_stop __P((struct ifaddr *));
431 void nd6_dad_duplicated __P((struct ifaddr *));
434 void nd6_rs_input __P((struct mbuf *, int, int));
435 void nd6_ra_input __P((struct mbuf *, int, int));
436 void prelist_del __P((struct nd_prefix *));
437 void defrouter_reset __P((void));
438 void defrouter_select __P((void));
439 void defrtrlist_del __P((struct nd_defrouter *));
440 void prelist_remove __P((struct nd_prefix *));
441 int nd6_prelist_add __P((struct nd_prefixctl *, struct nd_defrouter *,
442 struct nd_prefix **));
443 void pfxlist_onlink_check __P((void));
444 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *, struct ifnet *));
445 struct nd_prefix *nd6_prefix_lookup __P((struct nd_prefixctl *));
446 void rt6_flush __P((struct in6_addr *, struct ifnet *));
447 int nd6_setdefaultiface __P((int));
448 int in6_tmpifadd __P((const struct in6_ifaddr *, int, int));
452 #endif /* _NETINET6_ND6_H_ */