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 */
119 /* Sysctls, shared with user space. */
120 struct in6_defrouter {
121 struct sockaddr_in6 rtaddr;
129 struct sockaddr_in6 prefix;
130 struct prf_ra raflags;
139 u_short advrtrs; /* number of advertisement routers */
140 /* struct sockaddr_in6 advrtr[] */
145 char ifname[IFNAMSIZ];
147 u_int32_t linkmtu; /* LinkMTU */
148 u_int32_t maxmtu; /* Upper bound of LinkMTU */
149 u_int32_t basereachable; /* BaseReachableTime */
150 u_int32_t reachable; /* Reachable Time */
151 u_int32_t retrans; /* Retrans Timer */
152 u_int32_t flags; /* Flags */
153 int recalctm; /* BaseReacable re-calculation timer */
154 u_int8_t chlim; /* CurHopLimit */
161 char ifname[IFNAMSIZ];
162 struct nd_ifinfo ndi;
166 char ifname[IFNAMSIZ];
171 #define NDPRF_ONLINK 0x1
172 #define NDPRF_DETACHED 0x2
174 /* protocol constants */
175 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
176 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
177 #define MAX_RTR_SOLICITATIONS 3
179 #define ND6_INFINITE_LIFETIME 0xffffffff
183 #define MAX_REACHABLE_TIME 3600000 /* msec */
184 #define REACHABLE_TIME 30000 /* msec */
185 #define RETRANS_TIMER 1000 /* msec */
186 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
187 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
188 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
189 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
190 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
191 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
192 #define ND_COMPUTE_RTIME(x) \
193 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
194 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
196 struct nd_defrouter {
197 TAILQ_ENTRY(nd_defrouter) dr_entry;
198 struct in6_addr rtaddr;
199 u_char raflags; /* flags on RA message */
203 int installed; /* is installed into kernel routing table */
207 struct nd_prefixctl {
208 struct ifnet *ndpr_ifp;
211 struct sockaddr_in6 ndpr_prefix;
214 u_int32_t ndpr_vltime; /* advertised valid lifetime */
215 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
217 struct prf_ra ndpr_flags;
220 LIST_HEAD(nd_prhead, nd_prefix);
222 struct ifnet *ndpr_ifp;
223 LIST_ENTRY(nd_prefix) ndpr_entry;
224 struct sockaddr_in6 ndpr_prefix; /* prefix */
225 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
227 u_int32_t ndpr_vltime; /* advertised valid lifetime */
228 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
230 time_t ndpr_expire; /* expiration time of the prefix */
231 time_t ndpr_preferred; /* preferred time of the prefix */
232 time_t ndpr_lastupdate; /* reception time of last advertisement */
234 struct prf_ra ndpr_flags;
235 u_int32_t ndpr_stateflags; /* actual state flags */
236 /* list of routers that advertise the prefix: */
237 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
239 int ndpr_addrcnt; /* count of derived addresses */
240 volatile u_int ndpr_refcnt;
243 #define ndpr_raf ndpr_flags
244 #define ndpr_raf_onlink ndpr_flags.onlink
245 #define ndpr_raf_auto ndpr_flags.autonomous
246 #define ndpr_raf_router ndpr_flags.router
248 struct nd_pfxrouter {
249 LIST_ENTRY(nd_pfxrouter) pfr_entry;
250 struct nd_defrouter *router;
253 #ifdef MALLOC_DECLARE
254 MALLOC_DECLARE(M_IP6NDP);
258 VNET_DECLARE(int, nd6_prune);
259 VNET_DECLARE(int, nd6_delay);
260 VNET_DECLARE(int, nd6_umaxtries);
261 VNET_DECLARE(int, nd6_mmaxtries);
262 VNET_DECLARE(int, nd6_useloopback);
263 VNET_DECLARE(int, nd6_maxnudhint);
264 VNET_DECLARE(int, nd6_gctimer);
265 VNET_DECLARE(struct nd_prhead, nd_prefix);
266 VNET_DECLARE(int, nd6_debug);
267 VNET_DECLARE(int, nd6_onlink_ns_rfc4861);
268 #define V_nd6_prune VNET(nd6_prune)
269 #define V_nd6_delay VNET(nd6_delay)
270 #define V_nd6_umaxtries VNET(nd6_umaxtries)
271 #define V_nd6_mmaxtries VNET(nd6_mmaxtries)
272 #define V_nd6_useloopback VNET(nd6_useloopback)
273 #define V_nd6_maxnudhint VNET(nd6_maxnudhint)
274 #define V_nd6_gctimer VNET(nd6_gctimer)
275 #define V_nd_prefix VNET(nd_prefix)
276 #define V_nd6_debug VNET(nd6_debug)
277 #define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861)
279 /* Lock for the prefix and default router lists. */
280 VNET_DECLARE(struct rwlock, nd6_lock);
281 VNET_DECLARE(uint64_t, nd6_list_genid);
282 #define V_nd6_lock VNET(nd6_lock)
283 #define V_nd6_list_genid VNET(nd6_list_genid)
285 #define ND6_RLOCK() rw_rlock(&V_nd6_lock)
286 #define ND6_RUNLOCK() rw_runlock(&V_nd6_lock)
287 #define ND6_WLOCK() rw_wlock(&V_nd6_lock)
288 #define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock)
289 #define ND6_TRY_UPGRADE() rw_try_upgrade(&V_nd6_lock)
290 #define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED)
291 #define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED)
292 #define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED)
293 #define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED)
295 /* Mutex for prefix onlink/offlink transitions. */
296 VNET_DECLARE(struct mtx, nd6_onlink_mtx);
297 #define V_nd6_onlink_mtx VNET(nd6_onlink_mtx)
299 #define ND6_ONLINK_LOCK() mtx_lock(&V_nd6_onlink_mtx)
300 #define ND6_ONLINK_TRYLOCK() mtx_trylock(&V_nd6_onlink_mtx)
301 #define ND6_ONLINK_UNLOCK() mtx_unlock(&V_nd6_onlink_mtx)
302 #define ND6_ONLINK_LOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_OWNED)
303 #define ND6_ONLINK_UNLOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED)
305 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
308 VNET_DECLARE(int, nd6_defifindex);
309 VNET_DECLARE(int, ip6_desync_factor); /* seconds */
310 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
311 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
312 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
313 #define V_nd6_defifindex VNET(nd6_defifindex)
314 #define V_ip6_desync_factor VNET(ip6_desync_factor)
315 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
316 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
317 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
320 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
322 struct nd_opt_hdr *zero;
323 struct nd_opt_hdr *src_lladdr;
324 struct nd_opt_hdr *tgt_lladdr;
325 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
326 struct nd_opt_rd_hdr *rh;
327 struct nd_opt_mtu *mtu;
328 struct nd_opt_hdr *__res6;
329 struct nd_opt_hdr *__res7;
330 struct nd_opt_hdr *__res8;
331 struct nd_opt_hdr *__res9;
332 struct nd_opt_hdr *__res10;
333 struct nd_opt_hdr *__res11;
334 struct nd_opt_hdr *__res12;
335 struct nd_opt_hdr *__res13;
336 struct nd_opt_nonce *nonce;
337 struct nd_opt_hdr *__res15;
338 struct nd_opt_hdr *search; /* multiple opts */
339 struct nd_opt_hdr *last; /* multiple opts */
341 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
344 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
345 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
346 #define nd_opts_pi nd_opt_each.pi_beg
347 #define nd_opts_pi_end nd_opt_each.pi_end
348 #define nd_opts_rh nd_opt_each.rh
349 #define nd_opts_mtu nd_opt_each.mtu
350 #define nd_opts_nonce nd_opt_each.nonce
351 #define nd_opts_search nd_opt_each.search
352 #define nd_opts_last nd_opt_each.last
353 #define nd_opts_done nd_opt_each.done
355 /* XXX: need nd6_var.h?? */
359 void nd6_destroy(void);
361 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
362 void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *);
363 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
364 void nd6_option_init(void *, int, union nd_opts *);
365 struct nd_opt_hdr *nd6_option(union nd_opts *);
366 int nd6_options(union nd_opts *);
367 struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
368 void nd6_setmtu(struct ifnet *);
369 void nd6_llinfo_setstate(struct llentry *lle, int newstate);
370 void nd6_timer(void *);
371 void nd6_purge(struct ifnet *);
372 int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst,
373 char *desten, uint32_t *pflags);
374 int nd6_resolve(struct ifnet *, int, struct mbuf *,
375 const struct sockaddr *, u_char *, uint32_t *, struct llentry **);
376 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
377 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
378 char *, int, int, int);
379 void nd6_grab_holdchain(struct llentry *, struct mbuf **,
380 struct sockaddr_in6 *);
381 int nd6_flush_holdchain(struct ifnet *, struct mbuf *,
382 struct sockaddr_in6 *);
383 int nd6_add_ifa_lle(struct in6_ifaddr *);
384 void nd6_rem_ifa_lle(struct in6_ifaddr *, int);
385 int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *,
386 struct sockaddr_in6 *, struct route *);
390 void nd6_subscription_cb(struct rib_head *rnh, struct rib_cmd_info *rc,
394 void nd6_na_input(struct mbuf *, int, int);
395 void nd6_na_output(struct ifnet *, const struct in6_addr *,
396 const struct in6_addr *, u_long, int, struct sockaddr *);
397 void nd6_ns_input(struct mbuf *, int, int);
398 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
399 const struct in6_addr *, const struct in6_addr *, uint8_t *);
400 caddr_t nd6_ifptomac(struct ifnet *);
401 void nd6_dad_init(void);
402 void nd6_dad_start(struct ifaddr *, int);
403 void nd6_dad_stop(struct ifaddr *);
406 void nd6_rs_input(struct mbuf *, int, int);
407 void nd6_ra_input(struct mbuf *, int, int);
408 void nd6_ifnet_link_event(void *, struct ifnet *, int);
409 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *);
410 struct nd_defrouter *defrouter_lookup_locked(const struct in6_addr *,
412 void defrouter_reset(void);
413 void defrouter_select_fib(int fibnum);
414 void defrouter_rele(struct nd_defrouter *);
415 bool defrouter_remove(struct in6_addr *, struct ifnet *);
416 bool nd6_defrouter_list_empty(void);
417 void nd6_defrouter_flush_all(void);
418 void nd6_defrouter_purge(struct ifnet *);
419 void nd6_defrouter_timer(void);
420 void nd6_defrouter_init(void);
421 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
422 struct nd_prefix **);
423 void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *);
424 void nd6_prefix_del(struct nd_prefix *);
425 void nd6_prefix_ref(struct nd_prefix *);
426 void nd6_prefix_rele(struct nd_prefix *);
427 int nd6_prefix_offlink(struct nd_prefix *);
428 void pfxlist_onlink_check(void);
429 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
430 void rt6_flush(struct in6_addr *, struct ifnet *);
431 int nd6_setdefaultiface(int);
432 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
436 #endif /* _NETINET6_ND6_H_ */