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
89 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */
90 #define ND6_IFF_NO_DAD 0x100
92 #define ND6_CREATE LLE_CREATE
93 #define ND6_EXCLUSIVE LLE_EXCLUSIVE
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))
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 */
117 char ifname[IFNAMSIZ];
119 struct in6_addr rtaddr;
124 } defrouter[DRLSTSIZ];
127 struct in6_defrouter {
128 struct sockaddr_in6 rtaddr;
137 char ifname[IFNAMSIZ];
139 struct in6_addr prefix;
140 struct prf_ra raflags;
147 u_short advrtrs; /* number of advertisement routers */
148 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
154 char ifname[IFNAMSIZ];
156 struct in6_addr prefix;
157 struct prf_ra raflags;
164 u_short advrtrs; /* number of advertisement routers */
165 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
170 struct sockaddr_in6 prefix;
171 struct prf_ra raflags;
180 u_short advrtrs; /* number of advertisement routers */
181 /* struct sockaddr_in6 advrtr[] */
186 char ifname[IFNAMSIZ];
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 */
202 char ifname[IFNAMSIZ];
203 struct nd_ifinfo ndi;
207 char ifname[IFNAMSIZ];
212 #define NDPRF_ONLINK 0x1
213 #define NDPRF_DETACHED 0x2
215 /* protocol constants */
216 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
217 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
218 #define MAX_RTR_SOLICITATIONS 3
220 #define ND6_INFINITE_LIFETIME 0xffffffff
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)
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 */
245 int installed; /* is installed into kernel routing table */
248 struct nd_prefixctl {
249 struct ifnet *ndpr_ifp;
252 struct sockaddr_in6 ndpr_prefix;
255 u_int32_t ndpr_vltime; /* advertised valid lifetime */
256 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
258 struct prf_ra ndpr_flags;
263 struct ifnet *ndpr_ifp;
264 LIST_ENTRY(nd_prefix) ndpr_entry;
265 struct sockaddr_in6 ndpr_prefix; /* prefix */
266 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
268 u_int32_t ndpr_vltime; /* advertised valid lifetime */
269 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
271 time_t ndpr_expire; /* expiration time of the prefix */
272 time_t ndpr_preferred; /* preferred time of the prefix */
273 time_t ndpr_lastupdate; /* reception time of last advertisement */
275 struct prf_ra ndpr_flags;
276 u_int32_t ndpr_stateflags; /* actual state flags */
277 /* list of routers that advertise the prefix: */
278 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
280 int ndpr_refcnt; /* reference couter from addresses */
283 #define ndpr_raf ndpr_flags
284 #define ndpr_raf_onlink ndpr_flags.onlink
285 #define ndpr_raf_auto ndpr_flags.autonomous
286 #define ndpr_raf_router ndpr_flags.router
289 * Message format for use in obtaining information about prefixes
290 * from inet6 sysctl function
292 struct inet6_ndpr_msghdr {
293 u_short inpm_msglen; /* to skip over non-understood messages */
294 u_char inpm_version; /* future binary compatibility */
295 u_char inpm_type; /* message type */
296 struct in6_addr inpm_prefix;
300 u_long prm_preferred;
301 struct in6_prflags prm_flags;
302 u_short prm_index; /* index for associated ifp */
303 u_char prm_plen; /* length of prefix in bits */
306 #define prm_raf_onlink prm_flags.prf_ra.onlink
307 #define prm_raf_auto prm_flags.prf_ra.autonomous
309 #define prm_statef_onlink prm_flags.prf_state.onlink
311 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
312 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
314 struct nd_pfxrouter {
315 LIST_ENTRY(nd_pfxrouter) pfr_entry;
316 struct nd_defrouter *router;
319 LIST_HEAD(nd_prhead, nd_prefix);
322 VNET_DECLARE(int, nd6_prune);
323 VNET_DECLARE(int, nd6_delay);
324 VNET_DECLARE(int, nd6_umaxtries);
325 VNET_DECLARE(int, nd6_mmaxtries);
326 VNET_DECLARE(int, nd6_useloopback);
327 VNET_DECLARE(int, nd6_maxnudhint);
328 VNET_DECLARE(int, nd6_gctimer);
329 VNET_DECLARE(struct nd_drhead, nd_defrouter);
330 VNET_DECLARE(struct nd_prhead, nd_prefix);
331 VNET_DECLARE(int, nd6_debug);
332 VNET_DECLARE(int, nd6_onlink_ns_rfc4861);
333 #define V_nd6_prune VNET(nd6_prune)
334 #define V_nd6_delay VNET(nd6_delay)
335 #define V_nd6_umaxtries VNET(nd6_umaxtries)
336 #define V_nd6_mmaxtries VNET(nd6_mmaxtries)
337 #define V_nd6_useloopback VNET(nd6_useloopback)
338 #define V_nd6_maxnudhint VNET(nd6_maxnudhint)
339 #define V_nd6_gctimer VNET(nd6_gctimer)
340 #define V_nd_defrouter VNET(nd_defrouter)
341 #define V_nd_prefix VNET(nd_prefix)
342 #define V_nd6_debug VNET(nd6_debug)
343 #define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861)
345 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
347 VNET_DECLARE(struct callout, nd6_timer_ch);
348 #define V_nd6_timer_ch VNET(nd6_timer_ch)
351 VNET_DECLARE(int, nd6_defifindex);
352 VNET_DECLARE(int, ip6_desync_factor); /* seconds */
353 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
354 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
355 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
356 #define V_nd6_defifindex VNET(nd6_defifindex)
357 #define V_ip6_desync_factor VNET(ip6_desync_factor)
358 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
359 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
360 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
363 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
365 struct nd_opt_hdr *zero;
366 struct nd_opt_hdr *src_lladdr;
367 struct nd_opt_hdr *tgt_lladdr;
368 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
369 struct nd_opt_rd_hdr *rh;
370 struct nd_opt_mtu *mtu;
371 struct nd_opt_hdr *__res6;
372 struct nd_opt_hdr *__res7;
373 struct nd_opt_hdr *__res8;
374 struct nd_opt_hdr *__res9;
375 struct nd_opt_hdr *__res10;
376 struct nd_opt_hdr *__res11;
377 struct nd_opt_hdr *__res12;
378 struct nd_opt_hdr *__res13;
379 struct nd_opt_nonce *nonce;
380 struct nd_opt_hdr *__res15;
381 struct nd_opt_hdr *search; /* multiple opts */
382 struct nd_opt_hdr *last; /* multiple opts */
384 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
387 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
388 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
389 #define nd_opts_pi nd_opt_each.pi_beg
390 #define nd_opts_pi_end nd_opt_each.pi_end
391 #define nd_opts_rh nd_opt_each.rh
392 #define nd_opts_mtu nd_opt_each.mtu
393 #define nd_opts_nonce nd_opt_each.nonce
394 #define nd_opts_search nd_opt_each.search
395 #define nd_opts_last nd_opt_each.last
396 #define nd_opts_done nd_opt_each.done
398 /* XXX: need nd6_var.h?? */
402 void nd6_destroy(void);
404 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
405 void nd6_ifdetach(struct nd_ifinfo *);
406 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *);
407 void nd6_option_init(void *, int, union nd_opts *);
408 struct nd_opt_hdr *nd6_option(union nd_opts *);
409 int nd6_options(union nd_opts *);
410 struct llentry *nd6_lookup(struct in6_addr *, int, struct ifnet *);
411 void nd6_setmtu(struct ifnet *);
412 void nd6_llinfo_settimer(struct llentry *, long);
413 void nd6_llinfo_settimer_locked(struct llentry *, long);
414 void nd6_timer(void *);
415 void nd6_purge(struct ifnet *);
416 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
417 int nd6_resolve(struct ifnet *, struct rtentry *, struct mbuf *,
418 struct sockaddr *, u_char *);
419 void nd6_rtrequest(int, struct rtentry *, struct rt_addrinfo *);
420 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
421 struct llentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
422 char *, int, int, int);
423 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
424 struct sockaddr_in6 *, struct rtentry *);
425 void nd6_grab_holdchain(struct llentry *, struct mbuf **,
426 struct sockaddr_in6 *);
427 int nd6_flush_holdchain(struct ifnet *, struct ifnet *, struct mbuf *,
428 struct sockaddr_in6 *);
429 int nd6_need_cache(struct ifnet *);
430 int nd6_storelladdr(struct ifnet *, struct mbuf *,
431 const struct sockaddr *, u_char *, struct llentry **);
434 void nd6_na_input(struct mbuf *, int, int);
435 void nd6_na_output(struct ifnet *, const struct in6_addr *,
436 const struct in6_addr *, u_long, int, struct sockaddr *);
437 void nd6_ns_input(struct mbuf *, int, int);
438 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
439 const struct in6_addr *, struct llentry *, uint8_t *);
440 caddr_t nd6_ifptomac(struct ifnet *);
441 void nd6_dad_init(void);
442 void nd6_dad_start(struct ifaddr *, int);
443 void nd6_dad_stop(struct ifaddr *);
446 void nd6_rs_input(struct mbuf *, int, int);
447 void nd6_ra_input(struct mbuf *, int, int);
448 void defrouter_reset(void);
449 void defrouter_select(void);
450 void defrtrlist_del(struct nd_defrouter *);
451 void prelist_remove(struct nd_prefix *);
452 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
453 struct nd_prefix **);
454 void pfxlist_onlink_check(void);
455 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
456 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
457 void rt6_flush(struct in6_addr *, struct ifnet *);
458 int nd6_setdefaultiface(int);
459 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
463 #endif /* _NETINET6_ND6_H_ */