1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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.
18 *
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
29 * SUCH DAMAGE.
30 *
31 * $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $
32 */
33
34#ifndef _NETINET6_ND6_H_
35#define _NETINET6_ND6_H_
36
37/* see net/route.h, or net/if_inarp.h */
38#ifndef RTF_ANNOUNCE
39#define RTF_ANNOUNCE RTF_PROTO2
40#endif
41
42#include <sys/queue.h>
43#include <sys/callout.h>
44
45struct llentry;
46
47#define ND6_LLINFO_NOSTATE -2
48/*
49 * We don't need the WAITDELETE state any more, but we keep the definition
50 * in a comment line instead of removing it. This is necessary to avoid
51 * unintentionally reusing the value for another purpose, which might
52 * affect backward compatibility with old applications.
53 * (20000711 jinmei@kame.net)
54 */
55/* #define ND6_LLINFO_WAITDELETE -1 */
56#define ND6_LLINFO_INCOMPLETE 0
57#define ND6_LLINFO_REACHABLE 1
58#define ND6_LLINFO_STALE 2
59#define ND6_LLINFO_DELAY 3
60#define ND6_LLINFO_PROBE 4
61
62#define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
63#define ND6_LLINFO_PERMANENT(n) (((n)->la_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
64
65struct nd_ifinfo {
66 u_int32_t linkmtu; /* LinkMTU */
67 u_int32_t maxmtu; /* Upper bound of LinkMTU */
68 u_int32_t basereachable; /* BaseReachableTime */
69 u_int32_t reachable; /* Reachable Time */
70 u_int32_t retrans; /* Retrans Timer */
71 u_int32_t flags; /* Flags */
72 int recalctm; /* BaseReacable re-calculation timer */
73 u_int8_t chlim; /* CurHopLimit */
74 u_int8_t initialized; /* Flag to see the entry is initialized */
75 /* the following 3 members are for privacy extension for addrconf */
76 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
77 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
78 u_int8_t randomid[8]; /* current random ID */
79};
80
81#define ND6_IFF_PERFORMNUD 0x1
82#define ND6_IFF_ACCEPT_RTADV 0x2
83#define ND6_IFF_PREFER_SOURCE 0x4 /* Not used in FreeBSD. */
84#define ND6_IFF_IFDISABLED 0x8 /* IPv6 operation is disabled due to
85 * DAD failure. (XXX: not ND-specific)
86 */
87#define ND6_IFF_DONT_SET_IFROUTE 0x10
88#define ND6_IFF_AUTO_LINKLOCAL 0x20
89#define ND6_IFF_NO_RADR 0x40
90#define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */
91#define ND6_IFF_NO_DAD 0x100
92#ifdef EXPERIMENTAL
93/* XXX: not related to ND. */
94#define ND6_IFF_IPV6_ONLY 0x200 /* draft-ietf-6man-ipv6only-flag */
95#define ND6_IFF_IPV6_ONLY_MANUAL 0x400
96#define ND6_IFF_IPV6_ONLY_MASK (ND6_IFF_IPV6_ONLY|ND6_IFF_IPV6_ONLY_MANUAL)
97#endif
98
99#ifdef _KERNEL
100#define ND_IFINFO(ifp) \
101 (((struct in6_ifextra *)if_getafdata(ifp, AF_INET6))->nd_ifinfo)
102#define IN6_LINKMTU(ifp) \
103 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
104 ? ND_IFINFO(ifp)->linkmtu \
105 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
106 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
107#endif
108
109struct in6_nbrinfo {
110 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
111 struct in6_addr addr; /* IPv6 address of the neighbor */
112 long asked; /* number of queries already sent for this addr */
113 int isrouter; /* if it acts as a router */
114 int state; /* reachability state */
115 int expire; /* lifetime for NDP state transition */
116};
117
118/* Sysctls, shared with user space. */
119struct in6_defrouter {
120 struct sockaddr_in6 rtaddr;
121 u_char flags;
122 u_short rtlifetime;
123 u_long expire;
124 u_short if_index;
125};
126
127struct in6_prefix {
128 struct sockaddr_in6 prefix;
129 struct prf_ra raflags;
130 u_char prefixlen;
131 u_char origin;
132 u_int32_t vltime;
133 u_int32_t pltime;
134 time_t expire;
135 u_int32_t flags;
136 int refcnt;
137 u_short if_index;
138 u_short advrtrs; /* number of advertisement routers */
139 /* struct sockaddr_in6 advrtr[] */
140};
141
142#ifdef _KERNEL
143struct in6_ondireq {
144 char ifname[IFNAMSIZ];
145 struct {
146 u_int32_t linkmtu; /* LinkMTU */
147 u_int32_t maxmtu; /* Upper bound of LinkMTU */
148 u_int32_t basereachable; /* BaseReachableTime */
149 u_int32_t reachable; /* Reachable Time */
150 u_int32_t retrans; /* Retrans Timer */
151 u_int32_t flags; /* Flags */
152 int recalctm; /* BaseReacable re-calculation timer */
153 u_int8_t chlim; /* CurHopLimit */
154 u_int8_t receivedra;
155 } ndi;
156};
157#endif
158
159struct in6_ndireq {
160 char ifname[IFNAMSIZ];
161 struct nd_ifinfo ndi;
162};
163
164struct in6_ndifreq {
165 char ifname[IFNAMSIZ];
166 u_long ifindex;
167};
168
169/* Prefix status */
170#define NDPRF_ONLINK 0x1
171#define NDPRF_DETACHED 0x2
172
173/* protocol constants */
174#define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
175#define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
176#define MAX_RTR_SOLICITATIONS 3
177
178#define ND6_INFINITE_LIFETIME 0xffffffff
179
180#ifdef _KERNEL
181/* node constants */
182#define MAX_REACHABLE_TIME 3600000 /* msec */
183#define REACHABLE_TIME 30000 /* msec */
184#define RETRANS_TIMER 1000 /* msec */
185#define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
186#define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
187#define DEF_TEMP_VALID_LIFETIME 172800 /* 2 days */
188#define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
189#define TEMPADDR_REGEN_ADVANCE 5 /* sec */
190#define TEMP_MAX_DESYNC_FACTOR_BASE 300 /* 5 min */
191#define ND_COMPUTE_RTIME(x) \
192 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
193 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
194
195struct nd_defrouter {
196 TAILQ_ENTRY(nd_defrouter) dr_entry;
197 struct in6_addr rtaddr;
198 u_char raflags; /* flags on RA message */
199 u_short rtlifetime;
200 u_long expire;
201 struct ifnet *ifp;
202 int installed; /* is installed into kernel routing table */
203 u_int refcnt;
204};
205
206struct nd_prefixctl {
207 struct ifnet *ndpr_ifp;
208
209 /* prefix */
210 struct sockaddr_in6 ndpr_prefix;
211 u_char ndpr_plen;
212
213 u_int32_t ndpr_vltime; /* advertised valid lifetime */
214 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
215
216 struct prf_ra ndpr_flags;
217};
218
219LIST_HEAD(nd_prhead, nd_prefix);
220struct nd_prefix {
221 struct ifnet *ndpr_ifp;
222 LIST_ENTRY(nd_prefix) ndpr_entry;
223 struct sockaddr_in6 ndpr_prefix; /* prefix */
224 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
225
226 u_int32_t ndpr_vltime; /* advertised valid lifetime */
227 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
228
229 time_t ndpr_expire; /* expiration time of the prefix */
230 time_t ndpr_preferred; /* preferred time of the prefix */
231 time_t ndpr_lastupdate; /* reception time of last advertisement */
232
233 struct prf_ra ndpr_flags;
234 u_int32_t ndpr_stateflags; /* actual state flags */
235 /* list of routers that advertise the prefix: */
236 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
237 u_char ndpr_plen;
238 int ndpr_addrcnt; /* count of derived addresses */
239 volatile u_int ndpr_refcnt;
240};
241
242#define ndpr_raf ndpr_flags
243#define ndpr_raf_onlink ndpr_flags.onlink
244#define ndpr_raf_auto ndpr_flags.autonomous
245#define ndpr_raf_router ndpr_flags.router
246
247struct nd_pfxrouter {
248 LIST_ENTRY(nd_pfxrouter) pfr_entry;
249 struct nd_defrouter *router;
250};
251
252#ifdef MALLOC_DECLARE
253MALLOC_DECLARE(M_IP6NDP);
254#endif
255
256/* nd6.c */
257VNET_DECLARE(int, nd6_mmaxtries);
258VNET_DECLARE(struct nd_prhead, nd_prefix);
259VNET_DECLARE(int, nd6_debug);
260#define V_nd6_mmaxtries VNET(nd6_mmaxtries)
261#define V_nd_prefix VNET(nd_prefix)
262#define V_nd6_debug VNET(nd6_debug)
263
264/* Lock for the prefix and default router lists. */
265VNET_DECLARE(struct rwlock, nd6_lock);
266VNET_DECLARE(uint64_t, nd6_list_genid);
267#define V_nd6_lock VNET(nd6_lock)
268#define V_nd6_list_genid VNET(nd6_list_genid)
269
270#define ND6_RLOCK() rw_rlock(&V_nd6_lock)
271#define ND6_RUNLOCK() rw_runlock(&V_nd6_lock)
272#define ND6_WLOCK() rw_wlock(&V_nd6_lock)
273#define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock)
274#define ND6_TRY_UPGRADE() rw_try_upgrade(&V_nd6_lock)
275#define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED)
276#define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED)
277#define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED)
278#define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED)
279
280/* Mutex for prefix onlink/offlink transitions. */
281VNET_DECLARE(struct mtx, nd6_onlink_mtx);
282#define V_nd6_onlink_mtx VNET(nd6_onlink_mtx)
283
284#define ND6_ONLINK_LOCK() mtx_lock(&V_nd6_onlink_mtx)
285#define ND6_ONLINK_TRYLOCK() mtx_trylock(&V_nd6_onlink_mtx)
286#define ND6_ONLINK_UNLOCK() mtx_unlock(&V_nd6_onlink_mtx)
287#define ND6_ONLINK_LOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_OWNED)
288#define ND6_ONLINK_UNLOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED)
289
290#define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
291
292/* nd6_rtr.c */
293VNET_DECLARE(int, nd6_defifindex);
294VNET_DECLARE(int, ip6_desync_factor); /* seconds */
295VNET_DECLARE(uint32_t, ip6_temp_max_desync_factor); /* seconds */
296VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
297VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
298VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
299#define V_nd6_defifindex VNET(nd6_defifindex)
300#define V_ip6_desync_factor VNET(ip6_desync_factor)
301#define V_ip6_temp_max_desync_factor VNET(ip6_temp_max_desync_factor)
302#define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime)
303#define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime)
304#define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance)
305
306union nd_opts {
307 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
308 struct {
309 struct nd_opt_hdr *zero;
310 struct nd_opt_hdr *src_lladdr;
311 struct nd_opt_hdr *tgt_lladdr;
312 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
313 struct nd_opt_rd_hdr *rh;
314 struct nd_opt_mtu *mtu;
315 struct nd_opt_hdr *__res6;
316 struct nd_opt_hdr *__res7;
317 struct nd_opt_hdr *__res8;
318 struct nd_opt_hdr *__res9;
319 struct nd_opt_hdr *__res10;
320 struct nd_opt_hdr *__res11;
321 struct nd_opt_hdr *__res12;
322 struct nd_opt_hdr *__res13;
323 struct nd_opt_nonce *nonce;
324 struct nd_opt_hdr *__res15;
325 struct nd_opt_hdr *search; /* multiple opts */
326 struct nd_opt_hdr *last; /* multiple opts */
327 int done;
328 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
329 } nd_opt_each;
330};
331#define nd_opts_src_lladdr nd_opt_each.src_lladdr
332#define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
333#define nd_opts_pi nd_opt_each.pi_beg
334#define nd_opts_pi_end nd_opt_each.pi_end
335#define nd_opts_rh nd_opt_each.rh
336#define nd_opts_mtu nd_opt_each.mtu
337#define nd_opts_nonce nd_opt_each.nonce
338#define nd_opts_search nd_opt_each.search
339#define nd_opts_last nd_opt_each.last
340#define nd_opts_done nd_opt_each.done
341
342/* XXX: need nd6_var.h?? */
343/* nd6.c */
344void nd6_init(void);
345#ifdef VIMAGE
346void nd6_destroy(void);
347#endif
348struct nd_ifinfo *nd6_ifattach(struct ifnet *);
349void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *);
350int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
351void nd6_option_init(void *, int, union nd_opts *);
352struct nd_opt_hdr *nd6_option(union nd_opts *);
353int nd6_options(union nd_opts *);
354struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
355void nd6_setmtu(struct ifnet *);
356void nd6_llinfo_setstate(struct llentry *lle, int newstate);
357void nd6_timer(void *);
358void nd6_purge(struct ifnet *);
359int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst,
360 char *desten, uint32_t *pflags);
361int nd6_resolve(struct ifnet *, int, struct mbuf *,
362 const struct sockaddr *, u_char *, uint32_t *, struct llentry **);
363int nd6_ioctl(u_long, caddr_t, struct ifnet *);
364void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
365 char *, int, int, int);
366bool nd6_try_set_entry_addr(struct ifnet *ifp, struct llentry *lle, char *lladdr);
367struct mbuf *nd6_grab_holdchain(struct llentry *);
368int nd6_flush_holdchain(struct ifnet *, struct llentry *, struct mbuf *);
369void nd6_flush_children_holdchain(struct ifnet *, struct llentry *);
370int nd6_add_ifa_lle(struct in6_ifaddr *);
371void nd6_rem_ifa_lle(struct in6_ifaddr *, int);
372int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *,
373 struct sockaddr_in6 *, struct route *);
374
375struct rib_head;
376struct rib_cmd_info;
377void nd6_subscription_cb(struct rib_head *rnh, struct rib_cmd_info *rc,
378 void *arg);
379
380/* nd6_nbr.c */
381void nd6_na_input(struct mbuf *, int, int);
382void nd6_na_output(struct ifnet *, const struct in6_addr *,
383 const struct in6_addr *, u_long, int, struct sockaddr *);
384void nd6_ns_input(struct mbuf *, int, int);
385void nd6_ns_output(struct ifnet *, const struct in6_addr *,
386 const struct in6_addr *, const struct in6_addr *, uint8_t *);
387caddr_t nd6_ifptomac(struct ifnet *);
388void nd6_dad_init(void);
389void nd6_dad_start(struct ifaddr *, int);
390void nd6_dad_stop(struct ifaddr *);
391
392/* nd6_rtr.c */
393void nd6_rs_input(struct mbuf *, int, int);
394void nd6_ra_input(struct mbuf *, int, int);
395void nd6_ifnet_link_event(void *, struct ifnet *, int);
396struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *);
397struct nd_defrouter *defrouter_lookup_locked(const struct in6_addr *,
398 struct ifnet *);
399void defrouter_reset(void);
400void defrouter_select_fib(int fibnum);
401void defrouter_rele(struct nd_defrouter *);
402bool defrouter_remove(struct in6_addr *, struct ifnet *);
403bool nd6_defrouter_list_empty(void);
404void nd6_defrouter_flush_all(void);
405void nd6_defrouter_purge(struct ifnet *);
406void nd6_defrouter_timer(void);
407void nd6_defrouter_init(void);
408int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
409 struct nd_prefix **);
410void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *);
411void nd6_prefix_del(struct nd_prefix *);
412void nd6_prefix_ref(struct nd_prefix *);
413void nd6_prefix_rele(struct nd_prefix *);
414int nd6_prefix_offlink(struct nd_prefix *);
415void pfxlist_onlink_check(void);
416struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
417void rt6_flush(struct in6_addr *, struct ifnet *);
418int nd6_setdefaultiface(int);
419int in6_tmpifadd(const struct in6_ifaddr *, int, int);
420
421#endif /* _KERNEL */
422
423#endif /* _NETINET6_ND6_H_ */