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
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 raflags; /* flags on RA message */
242 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;
259 LIST_HEAD(nd_prhead, nd_prefix);
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_addrcnt; /* count of derived addresses */
279 volatile u_int ndpr_refcnt;
282 #define ndpr_raf ndpr_flags
283 #define ndpr_raf_onlink ndpr_flags.onlink
284 #define ndpr_raf_auto ndpr_flags.autonomous
285 #define ndpr_raf_router ndpr_flags.router
288 * Message format for use in obtaining information about prefixes
289 * from inet6 sysctl function
291 struct inet6_ndpr_msghdr {
292 u_short inpm_msglen; /* to skip over non-understood messages */
293 u_char inpm_version; /* future binary compatibility */
294 u_char inpm_type; /* message type */
295 struct in6_addr inpm_prefix;
299 u_long prm_preferred;
300 struct in6_prflags prm_flags;
301 u_short prm_index; /* index for associated ifp */
302 u_char prm_plen; /* length of prefix in bits */
305 #define prm_raf_onlink prm_flags.prf_ra.onlink
306 #define prm_raf_auto prm_flags.prf_ra.autonomous
308 #define prm_statef_onlink prm_flags.prf_state.onlink
310 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
311 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
313 struct nd_pfxrouter {
314 LIST_ENTRY(nd_pfxrouter) pfr_entry;
315 struct nd_defrouter *router;
318 #ifdef MALLOC_DECLARE
319 MALLOC_DECLARE(M_IP6NDP);
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)
346 /* Lock for the prefix and default router lists. */
347 VNET_DECLARE(struct rwlock, nd6_lock);
348 VNET_DECLARE(uint64_t, nd6_list_genid);
349 #define V_nd6_lock VNET(nd6_lock)
350 #define V_nd6_list_genid VNET(nd6_list_genid)
352 #define ND6_RLOCK() rw_rlock(&V_nd6_lock)
353 #define ND6_RUNLOCK() rw_runlock(&V_nd6_lock)
354 #define ND6_WLOCK() rw_wlock(&V_nd6_lock)
355 #define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock)
356 #define ND6_TRY_UPGRADE() rw_try_upgrade(&V_nd6_lock)
357 #define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED)
358 #define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED)
359 #define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED)
360 #define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED)
362 /* Mutex for prefix onlink/offlink transitions. */
363 VNET_DECLARE(struct mtx, nd6_onlink_mtx);
364 #define V_nd6_onlink_mtx VNET(nd6_onlink_mtx)
366 #define ND6_ONLINK_LOCK() mtx_lock(&V_nd6_onlink_mtx)
367 #define ND6_ONLINK_TRYLOCK() mtx_trylock(&V_nd6_onlink_mtx)
368 #define ND6_ONLINK_UNLOCK() mtx_unlock(&V_nd6_onlink_mtx)
369 #define ND6_ONLINK_LOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_OWNED)
370 #define ND6_ONLINK_UNLOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED)
372 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
375 VNET_DECLARE(int, nd6_defifindex);
376 VNET_DECLARE(int, ip6_desync_factor); /* seconds */
377 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
378 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
379 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
380 #define V_nd6_defifindex VNET(nd6_defifindex)
381 #define V_ip6_desync_factor VNET(ip6_desync_factor)
382 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
383 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
384 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
387 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
389 struct nd_opt_hdr *zero;
390 struct nd_opt_hdr *src_lladdr;
391 struct nd_opt_hdr *tgt_lladdr;
392 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
393 struct nd_opt_rd_hdr *rh;
394 struct nd_opt_mtu *mtu;
395 struct nd_opt_hdr *__res6;
396 struct nd_opt_hdr *__res7;
397 struct nd_opt_hdr *__res8;
398 struct nd_opt_hdr *__res9;
399 struct nd_opt_hdr *__res10;
400 struct nd_opt_hdr *__res11;
401 struct nd_opt_hdr *__res12;
402 struct nd_opt_hdr *__res13;
403 struct nd_opt_nonce *nonce;
404 struct nd_opt_hdr *__res15;
405 struct nd_opt_hdr *search; /* multiple opts */
406 struct nd_opt_hdr *last; /* multiple opts */
408 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
411 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
412 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
413 #define nd_opts_pi nd_opt_each.pi_beg
414 #define nd_opts_pi_end nd_opt_each.pi_end
415 #define nd_opts_rh nd_opt_each.rh
416 #define nd_opts_mtu nd_opt_each.mtu
417 #define nd_opts_nonce nd_opt_each.nonce
418 #define nd_opts_search nd_opt_each.search
419 #define nd_opts_last nd_opt_each.last
420 #define nd_opts_done nd_opt_each.done
422 /* XXX: need nd6_var.h?? */
426 void nd6_destroy(void);
428 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
429 void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *);
430 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
431 void nd6_option_init(void *, int, union nd_opts *);
432 struct nd_opt_hdr *nd6_option(union nd_opts *);
433 int nd6_options(union nd_opts *);
434 struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
435 struct llentry *nd6_alloc(const struct in6_addr *, int, struct ifnet *);
436 void nd6_setmtu(struct ifnet *);
437 void nd6_llinfo_setstate(struct llentry *lle, int newstate);
438 void nd6_timer(void *);
439 void nd6_purge(struct ifnet *);
440 int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst,
441 char *desten, uint32_t *pflags);
442 int nd6_resolve(struct ifnet *, int, struct mbuf *,
443 const struct sockaddr *, u_char *, uint32_t *, struct llentry **);
444 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
445 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
446 char *, int, int, int);
447 void nd6_grab_holdchain(struct llentry *, struct mbuf **,
448 struct sockaddr_in6 *);
449 int nd6_flush_holdchain(struct ifnet *, struct ifnet *, struct mbuf *,
450 struct sockaddr_in6 *);
451 int nd6_add_ifa_lle(struct in6_ifaddr *);
452 void nd6_rem_ifa_lle(struct in6_ifaddr *, int);
453 int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *,
454 struct sockaddr_in6 *, struct route *);
457 void nd6_na_input(struct mbuf *, int, int);
458 void nd6_na_output(struct ifnet *, const struct in6_addr *,
459 const struct in6_addr *, u_long, int, struct sockaddr *);
460 void nd6_ns_input(struct mbuf *, int, int);
461 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
462 const struct in6_addr *, const struct in6_addr *, uint8_t *);
463 caddr_t nd6_ifptomac(struct ifnet *);
464 void nd6_dad_init(void);
465 void nd6_dad_start(struct ifaddr *, int);
466 void nd6_dad_stop(struct ifaddr *);
469 void nd6_rs_input(struct mbuf *, int, int);
470 void nd6_ra_input(struct mbuf *, int, int);
471 void defrouter_reset(void);
472 void defrouter_select_fib(int fibnum);
473 void defrouter_select(void);
474 void defrouter_ref(struct nd_defrouter *);
475 void defrouter_rele(struct nd_defrouter *);
476 bool defrouter_remove(struct in6_addr *, struct ifnet *);
477 void defrouter_unlink(struct nd_defrouter *, struct nd_drhead *);
478 void defrouter_del(struct nd_defrouter *);
479 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
480 struct nd_prefix **);
481 void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *);
482 void nd6_prefix_del(struct nd_prefix *);
483 void nd6_prefix_ref(struct nd_prefix *);
484 void nd6_prefix_rele(struct nd_prefix *);
485 int nd6_prefix_onlink(struct nd_prefix *);
486 int nd6_prefix_offlink(struct nd_prefix *);
487 void pfxlist_onlink_check(void);
488 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
489 struct nd_defrouter *defrouter_lookup_locked(struct in6_addr *, struct ifnet *);
490 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
491 void rt6_flush(struct in6_addr *, struct ifnet *);
492 int nd6_setdefaultiface(int);
493 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
497 #endif /* _NETINET6_ND6_H_ */