xref: /freebsd/sys/netinet6/nd6.h (revision 31ec8b6407fdd5a87d70265762457c67ce618283)
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 
45 struct 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 
65 struct 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 	counter_u64_t dad_failures;	/* DAD failures when using RFC 7217 stable addresses */
80 };
81 
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)
87 				     */
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
93 #define ND6_IFF_STABLEADDR	0x800
94 #ifdef EXPERIMENTAL
95 /* XXX: not related to ND. */
96 #define	ND6_IFF_IPV6_ONLY	0x200 /* draft-ietf-6man-ipv6only-flag */
97 #define	ND6_IFF_IPV6_ONLY_MANUAL	0x400
98 #define	ND6_IFF_IPV6_ONLY_MASK	(ND6_IFF_IPV6_ONLY|ND6_IFF_IPV6_ONLY_MANUAL)
99 #endif
100 
101 #ifdef _KERNEL
102 #define ND_IFINFO(ifp) \
103 	(((struct in6_ifextra *)if_getafdata(ifp, AF_INET6))->nd_ifinfo)
104 #define IN6_LINKMTU(ifp) \
105 	((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
106 	    ? ND_IFINFO(ifp)->linkmtu \
107 	    : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
108 		? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
109 #endif
110 
111 struct in6_nbrinfo {
112 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
113 	struct in6_addr addr;	/* IPv6 address of the neighbor */
114 	long	asked;		/* number of queries already sent for this addr */
115 	int	isrouter;	/* if it acts as a router */
116 	int	state;		/* reachability state */
117 	int	expire;		/* lifetime for NDP state transition */
118 };
119 
120 /* Sysctls, shared with user space. */
121 struct	in6_defrouter {
122 	struct	sockaddr_in6 rtaddr;
123 	u_char	flags;
124 	u_short	rtlifetime;
125 	u_long	expire;
126 	u_short if_index;
127 };
128 
129 struct in6_prefix {
130 	struct	sockaddr_in6 prefix;
131 	struct prf_ra raflags;
132 	u_char	prefixlen;
133 	u_char	origin;
134 	u_int32_t vltime;
135 	u_int32_t pltime;
136 	time_t expire;
137 	u_int32_t flags;
138 	int refcnt;
139 	u_short if_index;
140 	u_short advrtrs; /* number of advertisement routers */
141 	/* struct sockaddr_in6 advrtr[] */
142 };
143 
144 #ifdef _KERNEL
145 struct	in6_ondireq {
146 	char ifname[IFNAMSIZ];
147 	struct {
148 		u_int32_t linkmtu;	/* LinkMTU */
149 		u_int32_t maxmtu;	/* Upper bound of LinkMTU */
150 		u_int32_t basereachable; /* BaseReachableTime */
151 		u_int32_t reachable;	/* Reachable Time */
152 		u_int32_t retrans;	/* Retrans Timer */
153 		u_int32_t flags;	/* Flags */
154 		int recalctm;		/* BaseReacable re-calculation timer */
155 		u_int8_t chlim;		/* CurHopLimit */
156 		u_int8_t receivedra;
157 	} ndi;
158 };
159 #endif
160 
161 struct	in6_ndireq {
162 	char ifname[IFNAMSIZ];
163 	struct nd_ifinfo ndi;
164 };
165 
166 struct	in6_ndifreq {
167 	char ifname[IFNAMSIZ];
168 	u_long ifindex;
169 };
170 
171 /* Prefix status */
172 #define NDPRF_ONLINK		0x1
173 #define NDPRF_DETACHED		0x2
174 
175 /* protocol constants */
176 #define MAX_RTR_SOLICITATION_DELAY	1	/* 1sec */
177 #define RTR_SOLICITATION_INTERVAL	4	/* 4sec */
178 #define MAX_RTR_SOLICITATIONS		3
179 
180 #define ND6_INFINITE_LIFETIME		0xffffffff
181 
182 #ifdef _KERNEL
183 /* node constants */
184 #define MAX_REACHABLE_TIME		3600000	/* msec */
185 #define REACHABLE_TIME			30000	/* msec */
186 #define RETRANS_TIMER			1000	/* msec */
187 #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
188 #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
189 #define DEF_TEMP_VALID_LIFETIME		172800	/* 2 days */
190 #define DEF_TEMP_PREFERRED_LIFETIME	86400	/* 1 day */
191 #define TEMPADDR_REGEN_ADVANCE		5	/* sec */
192 #define TEMP_MAX_DESYNC_FACTOR_BASE	300	/* 5 min */
193 #define ND_COMPUTE_RTIME(x) \
194 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
195 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
196 
197 struct nd_defrouter {
198 	TAILQ_ENTRY(nd_defrouter) dr_entry;
199 	struct in6_addr rtaddr;
200 	u_char	raflags;	/* flags on RA message */
201 	u_short	rtlifetime;
202 	u_long	expire;
203 	struct ifnet *ifp;
204 	int	installed;	/* is installed into kernel routing table */
205 	u_int	refcnt;
206 };
207 
208 struct nd_prefixctl {
209 	struct ifnet *ndpr_ifp;
210 
211 	/* prefix */
212 	struct sockaddr_in6 ndpr_prefix;
213 	u_char	ndpr_plen;
214 
215 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
216 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
217 
218 	struct prf_ra ndpr_flags;
219 };
220 
221 LIST_HEAD(nd_prhead, nd_prefix);
222 struct nd_prefix {
223 	struct ifnet *ndpr_ifp;
224 	LIST_ENTRY(nd_prefix) ndpr_entry;
225 	struct sockaddr_in6 ndpr_prefix;	/* prefix */
226 	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
227 
228 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
229 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
230 
231 	time_t ndpr_expire;	/* expiration time of the prefix */
232 	time_t ndpr_preferred;	/* preferred time of the prefix */
233 	time_t ndpr_lastupdate; /* reception time of last advertisement */
234 
235 	struct prf_ra ndpr_flags;
236 	u_int32_t ndpr_stateflags; /* actual state flags */
237 	/* list of routers that advertise the prefix: */
238 	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
239 	u_char	ndpr_plen;
240 	int	ndpr_addrcnt;	/* count of derived addresses */
241 	volatile u_int ndpr_refcnt;
242 };
243 
244 #define ndpr_raf		ndpr_flags
245 #define ndpr_raf_onlink		ndpr_flags.onlink
246 #define ndpr_raf_auto		ndpr_flags.autonomous
247 #define ndpr_raf_router		ndpr_flags.router
248 
249 struct nd_pfxrouter {
250 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
251 	struct nd_defrouter *router;
252 };
253 
254 #ifdef MALLOC_DECLARE
255 MALLOC_DECLARE(M_IP6NDP);
256 #endif
257 
258 /* nd6.c */
259 VNET_DECLARE(int, nd6_mmaxtries);
260 VNET_DECLARE(struct nd_prhead, nd_prefix);
261 VNET_DECLARE(int, nd6_debug);
262 #define	V_nd6_mmaxtries			VNET(nd6_mmaxtries)
263 #define	V_nd_prefix			VNET(nd_prefix)
264 #define	V_nd6_debug			VNET(nd6_debug)
265 
266 /* Lock for the prefix and default router lists. */
267 VNET_DECLARE(struct rwlock, nd6_lock);
268 VNET_DECLARE(uint64_t, nd6_list_genid);
269 #define	V_nd6_lock			VNET(nd6_lock)
270 #define	V_nd6_list_genid		VNET(nd6_list_genid)
271 
272 #define	ND6_RLOCK()			rw_rlock(&V_nd6_lock)
273 #define	ND6_RUNLOCK()			rw_runlock(&V_nd6_lock)
274 #define	ND6_WLOCK()			rw_wlock(&V_nd6_lock)
275 #define	ND6_WUNLOCK()			rw_wunlock(&V_nd6_lock)
276 #define	ND6_TRY_UPGRADE()		rw_try_upgrade(&V_nd6_lock)
277 #define	ND6_WLOCK_ASSERT()		rw_assert(&V_nd6_lock, RA_WLOCKED)
278 #define	ND6_RLOCK_ASSERT()		rw_assert(&V_nd6_lock, RA_RLOCKED)
279 #define	ND6_LOCK_ASSERT()		rw_assert(&V_nd6_lock, RA_LOCKED)
280 #define	ND6_UNLOCK_ASSERT()		rw_assert(&V_nd6_lock, RA_UNLOCKED)
281 
282 /* Mutex for prefix onlink/offlink transitions. */
283 VNET_DECLARE(struct mtx, nd6_onlink_mtx);
284 #define	V_nd6_onlink_mtx		VNET(nd6_onlink_mtx)
285 
286 #define	ND6_ONLINK_LOCK()		mtx_lock(&V_nd6_onlink_mtx)
287 #define	ND6_ONLINK_TRYLOCK()		mtx_trylock(&V_nd6_onlink_mtx)
288 #define	ND6_ONLINK_UNLOCK()		mtx_unlock(&V_nd6_onlink_mtx)
289 #define	ND6_ONLINK_LOCK_ASSERT()	mtx_assert(&V_nd6_onlink_mtx, MA_OWNED)
290 #define	ND6_ONLINK_UNLOCK_ASSERT()	mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED)
291 
292 #define nd6log(x)	do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
293 
294 /* nd6_rtr.c */
295 VNET_DECLARE(int, nd6_defifindex);
296 VNET_DECLARE(int, ip6_desync_factor);	/* seconds */
297 VNET_DECLARE(uint32_t, ip6_temp_max_desync_factor); /* seconds */
298 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
299 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
300 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
301 #define	V_nd6_defifindex		VNET(nd6_defifindex)
302 #define	V_ip6_desync_factor		VNET(ip6_desync_factor)
303 #define	V_ip6_temp_max_desync_factor	VNET(ip6_temp_max_desync_factor)
304 #define	V_ip6_temp_preferred_lifetime	VNET(ip6_temp_preferred_lifetime)
305 #define	V_ip6_temp_valid_lifetime	VNET(ip6_temp_valid_lifetime)
306 #define	V_ip6_temp_regen_advance	VNET(ip6_temp_regen_advance)
307 
308 union nd_opts {
309 	struct nd_opt_hdr *nd_opt_array[16];	/* max = ND_OPT_NONCE */
310 	struct {
311 		struct nd_opt_hdr *zero;
312 		struct nd_opt_hdr *src_lladdr;
313 		struct nd_opt_hdr *tgt_lladdr;
314 		struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
315 		struct nd_opt_rd_hdr *rh;
316 		struct nd_opt_mtu *mtu;
317 		struct nd_opt_hdr *__res6;
318 		struct nd_opt_hdr *__res7;
319 		struct nd_opt_hdr *__res8;
320 		struct nd_opt_hdr *__res9;
321 		struct nd_opt_hdr *__res10;
322 		struct nd_opt_hdr *__res11;
323 		struct nd_opt_hdr *__res12;
324 		struct nd_opt_hdr *__res13;
325 		struct nd_opt_nonce *nonce;
326 		struct nd_opt_hdr *__res15;
327 		struct nd_opt_hdr *search;	/* multiple opts */
328 		struct nd_opt_hdr *last;	/* multiple opts */
329 		int done;
330 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
331 	} nd_opt_each;
332 };
333 #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
334 #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
335 #define nd_opts_pi		nd_opt_each.pi_beg
336 #define nd_opts_pi_end		nd_opt_each.pi_end
337 #define nd_opts_rh		nd_opt_each.rh
338 #define nd_opts_mtu		nd_opt_each.mtu
339 #define nd_opts_nonce		nd_opt_each.nonce
340 #define nd_opts_search		nd_opt_each.search
341 #define nd_opts_last		nd_opt_each.last
342 #define nd_opts_done		nd_opt_each.done
343 
344 /* XXX: need nd6_var.h?? */
345 /* nd6.c */
346 void nd6_init(void);
347 #ifdef VIMAGE
348 void nd6_destroy(void);
349 #endif
350 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
351 void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *);
352 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
353 void nd6_option_init(void *, int, union nd_opts *);
354 struct nd_opt_hdr *nd6_option(union nd_opts *);
355 int nd6_options(union nd_opts *);
356 struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
357 void nd6_setmtu(struct ifnet *);
358 void nd6_llinfo_setstate(struct llentry *lle, int newstate);
359 void nd6_timer(void *);
360 void nd6_purge(struct ifnet *);
361 int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst,
362     char *desten, uint32_t *pflags);
363 int nd6_resolve(struct ifnet *, int, struct mbuf *,
364     const struct sockaddr *, u_char *, uint32_t *, struct llentry **);
365 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
366 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
367 	char *, int, int, int);
368 bool nd6_try_set_entry_addr(struct ifnet *ifp, struct llentry *lle, char *lladdr);
369 struct mbuf *nd6_grab_holdchain(struct llentry *);
370 int nd6_flush_holdchain(struct ifnet *, struct llentry *, struct mbuf *);
371 void nd6_flush_children_holdchain(struct ifnet *, struct llentry *);
372 int nd6_add_ifa_lle(struct in6_ifaddr *);
373 void nd6_rem_ifa_lle(struct in6_ifaddr *, int);
374 int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *,
375     struct sockaddr_in6 *, struct route *);
376 
377 struct rib_head;
378 struct rib_cmd_info;
379 void nd6_subscription_cb(struct rib_head *rnh, struct rib_cmd_info *rc,
380     void *arg);
381 
382 /* nd6_nbr.c */
383 void nd6_na_input(struct mbuf *, int, int);
384 void nd6_na_output(struct ifnet *, const struct in6_addr *,
385 	const struct in6_addr *, u_long, int, struct sockaddr *);
386 void nd6_ns_input(struct mbuf *, int, int);
387 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
388 	const struct in6_addr *, const struct in6_addr *, uint8_t *);
389 caddr_t nd6_ifptomac(struct ifnet *);
390 void nd6_dad_init(void);
391 void nd6_dad_start(struct ifaddr *, int);
392 void nd6_dad_stop(struct ifaddr *);
393 
394 /* nd6_rtr.c */
395 void nd6_rs_input(struct mbuf *, int, int);
396 void nd6_ra_input(struct mbuf *, int, int);
397 void nd6_ifnet_link_event(void *, struct ifnet *, int);
398 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *);
399 struct nd_defrouter *defrouter_lookup_locked(const struct in6_addr *,
400     struct ifnet *);
401 void defrouter_reset(void);
402 void defrouter_select_fib(int fibnum);
403 void defrouter_rele(struct nd_defrouter *);
404 bool defrouter_remove(struct in6_addr *, struct ifnet *);
405 bool nd6_defrouter_list_empty(void);
406 void nd6_defrouter_flush_all(void);
407 void nd6_defrouter_purge(struct ifnet *);
408 void nd6_defrouter_timer(void);
409 void nd6_defrouter_init(void);
410 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
411     struct nd_prefix **);
412 void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *);
413 void nd6_prefix_del(struct nd_prefix *);
414 void nd6_prefix_ref(struct nd_prefix *);
415 void nd6_prefix_rele(struct nd_prefix *);
416 int nd6_prefix_offlink(struct nd_prefix *);
417 void pfxlist_onlink_check(void);
418 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
419 void rt6_flush(struct in6_addr *, struct ifnet *);
420 int nd6_setdefaultiface(int);
421 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
422 
423 #endif /* _KERNEL */
424 
425 #endif /* _NETINET6_ND6_H_ */
426