2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the project nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $
35 #ifndef _NETINET6_ND6_H_
36 #define _NETINET6_ND6_H_
38 /* see net/route.h, or net/if_inarp.h */
40 #define RTF_ANNOUNCE RTF_PROTO2
43 #include <sys/queue.h>
44 #include <sys/callout.h>
48 #define ND6_LLINFO_NOSTATE -2
50 * We don't need the WAITDELETE state any more, but we keep the definition
51 * in a comment line instead of removing it. This is necessary to avoid
52 * unintentionally reusing the value for another purpose, which might
53 * affect backward compatibility with old applications.
54 * (20000711 jinmei@kame.net)
56 /* #define ND6_LLINFO_WAITDELETE -1 */
57 #define ND6_LLINFO_INCOMPLETE 0
58 #define ND6_LLINFO_REACHABLE 1
59 #define ND6_LLINFO_STALE 2
60 #define ND6_LLINFO_DELAY 3
61 #define ND6_LLINFO_PROBE 4
63 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
64 #define ND6_LLINFO_PERMANENT(n) (((n)->la_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
67 u_int32_t linkmtu; /* LinkMTU */
68 u_int32_t maxmtu; /* Upper bound of LinkMTU */
69 u_int32_t basereachable; /* BaseReachableTime */
70 u_int32_t reachable; /* Reachable Time */
71 u_int32_t retrans; /* Retrans Timer */
72 u_int32_t flags; /* Flags */
73 int recalctm; /* BaseReacable re-calculation timer */
74 u_int8_t chlim; /* CurHopLimit */
75 u_int8_t initialized; /* Flag to see the entry is initialized */
76 /* the following 3 members are for privacy extension for addrconf */
77 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
78 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
79 u_int8_t randomid[8]; /* current random ID */
82 #define ND6_IFF_PERFORMNUD 0x1
83 #define ND6_IFF_ACCEPT_RTADV 0x2
84 #define ND6_IFF_PREFER_SOURCE 0x4 /* Not used in FreeBSD. */
85 #define ND6_IFF_IFDISABLED 0x8 /* IPv6 operation is disabled due to
86 * DAD failure. (XXX: not ND-specific)
88 #define ND6_IFF_DONT_SET_IFROUTE 0x10
89 #define ND6_IFF_AUTO_LINKLOCAL 0x20
90 #define ND6_IFF_NO_RADR 0x40
91 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */
92 #define ND6_IFF_NO_DAD 0x100
94 /* XXX: not related to ND. */
95 #define ND6_IFF_IPV6_ONLY 0x200 /* draft-ietf-6man-ipv6only-flag */
96 #define ND6_IFF_IPV6_ONLY_MANUAL 0x400
97 #define ND6_IFF_IPV6_ONLY_MASK (ND6_IFF_IPV6_ONLY|ND6_IFF_IPV6_ONLY_MANUAL)
101 #define ND_IFINFO(ifp) \
102 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
103 #define IN6_LINKMTU(ifp) \
104 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
105 ? ND_IFINFO(ifp)->linkmtu \
106 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
107 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
111 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
112 struct in6_addr addr; /* IPv6 address of the neighbor */
113 long asked; /* number of queries already sent for this addr */
114 int isrouter; /* if it acts as a router */
115 int state; /* reachability state */
116 int expire; /* lifetime for NDP state transition */
122 char ifname[IFNAMSIZ];
124 struct in6_addr rtaddr;
129 } defrouter[DRLSTSIZ];
132 struct in6_defrouter {
133 struct sockaddr_in6 rtaddr;
142 char ifname[IFNAMSIZ];
144 struct in6_addr prefix;
145 struct prf_ra raflags;
152 u_short advrtrs; /* number of advertisement routers */
153 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
159 char ifname[IFNAMSIZ];
161 struct in6_addr prefix;
162 struct prf_ra raflags;
169 u_short advrtrs; /* number of advertisement routers */
170 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
175 struct sockaddr_in6 prefix;
176 struct prf_ra raflags;
185 u_short advrtrs; /* number of advertisement routers */
186 /* struct sockaddr_in6 advrtr[] */
191 char ifname[IFNAMSIZ];
193 u_int32_t linkmtu; /* LinkMTU */
194 u_int32_t maxmtu; /* Upper bound of LinkMTU */
195 u_int32_t basereachable; /* BaseReachableTime */
196 u_int32_t reachable; /* Reachable Time */
197 u_int32_t retrans; /* Retrans Timer */
198 u_int32_t flags; /* Flags */
199 int recalctm; /* BaseReacable re-calculation timer */
200 u_int8_t chlim; /* CurHopLimit */
207 char ifname[IFNAMSIZ];
208 struct nd_ifinfo ndi;
212 char ifname[IFNAMSIZ];
217 #define NDPRF_ONLINK 0x1
218 #define NDPRF_DETACHED 0x2
220 /* protocol constants */
221 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
222 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
223 #define MAX_RTR_SOLICITATIONS 3
225 #define ND6_INFINITE_LIFETIME 0xffffffff
229 #define MAX_REACHABLE_TIME 3600000 /* msec */
230 #define REACHABLE_TIME 30000 /* msec */
231 #define RETRANS_TIMER 1000 /* msec */
232 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
233 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
234 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
235 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
236 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
237 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
238 #define ND_COMPUTE_RTIME(x) \
239 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
240 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
242 TAILQ_HEAD(nd_drhead, nd_defrouter);
243 struct nd_defrouter {
244 TAILQ_ENTRY(nd_defrouter) dr_entry;
245 struct in6_addr rtaddr;
246 u_char raflags; /* flags on RA message */
250 int installed; /* is installed into kernel routing table */
254 struct nd_prefixctl {
255 struct ifnet *ndpr_ifp;
258 struct sockaddr_in6 ndpr_prefix;
261 u_int32_t ndpr_vltime; /* advertised valid lifetime */
262 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
264 struct prf_ra ndpr_flags;
267 LIST_HEAD(nd_prhead, nd_prefix);
269 struct ifnet *ndpr_ifp;
270 LIST_ENTRY(nd_prefix) ndpr_entry;
271 struct sockaddr_in6 ndpr_prefix; /* prefix */
272 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
274 u_int32_t ndpr_vltime; /* advertised valid lifetime */
275 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
277 time_t ndpr_expire; /* expiration time of the prefix */
278 time_t ndpr_preferred; /* preferred time of the prefix */
279 time_t ndpr_lastupdate; /* reception time of last advertisement */
281 struct prf_ra ndpr_flags;
282 u_int32_t ndpr_stateflags; /* actual state flags */
283 /* list of routers that advertise the prefix: */
284 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
286 int ndpr_addrcnt; /* count of derived addresses */
287 volatile u_int ndpr_refcnt;
290 #define ndpr_raf ndpr_flags
291 #define ndpr_raf_onlink ndpr_flags.onlink
292 #define ndpr_raf_auto ndpr_flags.autonomous
293 #define ndpr_raf_router ndpr_flags.router
296 * Message format for use in obtaining information about prefixes
297 * from inet6 sysctl function
299 struct inet6_ndpr_msghdr {
300 u_short inpm_msglen; /* to skip over non-understood messages */
301 u_char inpm_version; /* future binary compatibility */
302 u_char inpm_type; /* message type */
303 struct in6_addr inpm_prefix;
307 u_long prm_preferred;
308 struct in6_prflags prm_flags;
309 u_short prm_index; /* index for associated ifp */
310 u_char prm_plen; /* length of prefix in bits */
313 #define prm_raf_onlink prm_flags.prf_ra.onlink
314 #define prm_raf_auto prm_flags.prf_ra.autonomous
316 #define prm_statef_onlink prm_flags.prf_state.onlink
318 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
319 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
321 struct nd_pfxrouter {
322 LIST_ENTRY(nd_pfxrouter) pfr_entry;
323 struct nd_defrouter *router;
326 #ifdef MALLOC_DECLARE
327 MALLOC_DECLARE(M_IP6NDP);
331 VNET_DECLARE(int, nd6_prune);
332 VNET_DECLARE(int, nd6_delay);
333 VNET_DECLARE(int, nd6_umaxtries);
334 VNET_DECLARE(int, nd6_mmaxtries);
335 VNET_DECLARE(int, nd6_useloopback);
336 VNET_DECLARE(int, nd6_maxnudhint);
337 VNET_DECLARE(int, nd6_gctimer);
338 VNET_DECLARE(struct nd_drhead, nd_defrouter);
339 VNET_DECLARE(struct nd_prhead, nd_prefix);
340 VNET_DECLARE(int, nd6_debug);
341 VNET_DECLARE(int, nd6_onlink_ns_rfc4861);
342 #define V_nd6_prune VNET(nd6_prune)
343 #define V_nd6_delay VNET(nd6_delay)
344 #define V_nd6_umaxtries VNET(nd6_umaxtries)
345 #define V_nd6_mmaxtries VNET(nd6_mmaxtries)
346 #define V_nd6_useloopback VNET(nd6_useloopback)
347 #define V_nd6_maxnudhint VNET(nd6_maxnudhint)
348 #define V_nd6_gctimer VNET(nd6_gctimer)
349 #define V_nd_defrouter VNET(nd_defrouter)
350 #define V_nd_prefix VNET(nd_prefix)
351 #define V_nd6_debug VNET(nd6_debug)
352 #define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861)
354 /* Lock for the prefix and default router lists. */
355 VNET_DECLARE(struct rwlock, nd6_lock);
356 VNET_DECLARE(uint64_t, nd6_list_genid);
357 #define V_nd6_lock VNET(nd6_lock)
358 #define V_nd6_list_genid VNET(nd6_list_genid)
360 #define ND6_RLOCK() rw_rlock(&V_nd6_lock)
361 #define ND6_RUNLOCK() rw_runlock(&V_nd6_lock)
362 #define ND6_WLOCK() rw_wlock(&V_nd6_lock)
363 #define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock)
364 #define ND6_TRY_UPGRADE() rw_try_upgrade(&V_nd6_lock)
365 #define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED)
366 #define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED)
367 #define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED)
368 #define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED)
370 /* Mutex for prefix onlink/offlink transitions. */
371 VNET_DECLARE(struct mtx, nd6_onlink_mtx);
372 #define V_nd6_onlink_mtx VNET(nd6_onlink_mtx)
374 #define ND6_ONLINK_LOCK() mtx_lock(&V_nd6_onlink_mtx)
375 #define ND6_ONLINK_TRYLOCK() mtx_trylock(&V_nd6_onlink_mtx)
376 #define ND6_ONLINK_UNLOCK() mtx_unlock(&V_nd6_onlink_mtx)
377 #define ND6_ONLINK_LOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_OWNED)
378 #define ND6_ONLINK_UNLOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED)
380 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
383 VNET_DECLARE(int, nd6_defifindex);
384 VNET_DECLARE(int, ip6_desync_factor); /* seconds */
385 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
386 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
387 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
388 #define V_nd6_defifindex VNET(nd6_defifindex)
389 #define V_ip6_desync_factor VNET(ip6_desync_factor)
390 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
391 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
392 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
395 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
397 struct nd_opt_hdr *zero;
398 struct nd_opt_hdr *src_lladdr;
399 struct nd_opt_hdr *tgt_lladdr;
400 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
401 struct nd_opt_rd_hdr *rh;
402 struct nd_opt_mtu *mtu;
403 struct nd_opt_hdr *__res6;
404 struct nd_opt_hdr *__res7;
405 struct nd_opt_hdr *__res8;
406 struct nd_opt_hdr *__res9;
407 struct nd_opt_hdr *__res10;
408 struct nd_opt_hdr *__res11;
409 struct nd_opt_hdr *__res12;
410 struct nd_opt_hdr *__res13;
411 struct nd_opt_nonce *nonce;
412 struct nd_opt_hdr *__res15;
413 struct nd_opt_hdr *search; /* multiple opts */
414 struct nd_opt_hdr *last; /* multiple opts */
416 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
419 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
420 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
421 #define nd_opts_pi nd_opt_each.pi_beg
422 #define nd_opts_pi_end nd_opt_each.pi_end
423 #define nd_opts_rh nd_opt_each.rh
424 #define nd_opts_mtu nd_opt_each.mtu
425 #define nd_opts_nonce nd_opt_each.nonce
426 #define nd_opts_search nd_opt_each.search
427 #define nd_opts_last nd_opt_each.last
428 #define nd_opts_done nd_opt_each.done
430 /* XXX: need nd6_var.h?? */
434 void nd6_destroy(void);
436 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
437 void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *);
438 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
439 void nd6_option_init(void *, int, union nd_opts *);
440 struct nd_opt_hdr *nd6_option(union nd_opts *);
441 int nd6_options(union nd_opts *);
442 struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
443 struct llentry *nd6_alloc(const struct in6_addr *, int, struct ifnet *);
444 void nd6_setmtu(struct ifnet *);
445 void nd6_llinfo_setstate(struct llentry *lle, int newstate);
446 void nd6_timer(void *);
447 void nd6_purge(struct ifnet *);
448 int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst,
449 char *desten, uint32_t *pflags);
450 int nd6_resolve(struct ifnet *, int, struct mbuf *,
451 const struct sockaddr *, u_char *, uint32_t *, struct llentry **);
452 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
453 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
454 char *, int, int, int);
455 void nd6_grab_holdchain(struct llentry *, struct mbuf **,
456 struct sockaddr_in6 *);
457 int nd6_flush_holdchain(struct ifnet *, struct mbuf *,
458 struct sockaddr_in6 *);
459 int nd6_add_ifa_lle(struct in6_ifaddr *);
460 void nd6_rem_ifa_lle(struct in6_ifaddr *, int);
461 int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *,
462 struct sockaddr_in6 *, struct route *);
465 void nd6_na_input(struct mbuf *, int, int);
466 void nd6_na_output(struct ifnet *, const struct in6_addr *,
467 const struct in6_addr *, u_long, int, struct sockaddr *);
468 void nd6_ns_input(struct mbuf *, int, int);
469 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
470 const struct in6_addr *, const struct in6_addr *, uint8_t *);
471 caddr_t nd6_ifptomac(struct ifnet *);
472 void nd6_dad_init(void);
473 void nd6_dad_start(struct ifaddr *, int);
474 void nd6_dad_stop(struct ifaddr *);
477 void nd6_rs_input(struct mbuf *, int, int);
478 void nd6_ra_input(struct mbuf *, int, int);
479 void nd6_ifnet_link_event(void *, struct ifnet *, int);
480 void defrouter_reset(void);
481 void defrouter_select_fib(int fibnum);
482 void defrouter_select(void);
483 void defrouter_ref(struct nd_defrouter *);
484 void defrouter_rele(struct nd_defrouter *);
485 bool defrouter_remove(struct in6_addr *, struct ifnet *);
486 void defrouter_unlink(struct nd_defrouter *, struct nd_drhead *);
487 void defrouter_del(struct nd_defrouter *);
488 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
489 struct nd_prefix **);
490 void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *);
491 void nd6_prefix_del(struct nd_prefix *);
492 void nd6_prefix_ref(struct nd_prefix *);
493 void nd6_prefix_rele(struct nd_prefix *);
494 int nd6_prefix_onlink(struct nd_prefix *);
495 int nd6_prefix_offlink(struct nd_prefix *);
496 void pfxlist_onlink_check(void);
497 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
498 struct nd_defrouter *defrouter_lookup_locked(struct in6_addr *, struct ifnet *);
499 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
500 void rt6_flush(struct in6_addr *, struct ifnet *);
501 int nd6_setdefaultiface(int);
502 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
506 #endif /* _NETINET6_ND6_H_ */