xref: /freebsd/sys/netinet6/nd6.h (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
1 /*-
2  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
16  *
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
27  * SUCH DAMAGE.
28  *
29  *	$KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $
30  * $FreeBSD$
31  */
32 
33 #ifndef _NETINET6_ND6_H_
34 #define _NETINET6_ND6_H_
35 
36 /* see net/route.h, or net/if_inarp.h */
37 #ifndef RTF_ANNOUNCE
38 #define RTF_ANNOUNCE	RTF_PROTO2
39 #endif
40 
41 #include <sys/queue.h>
42 #include <sys/callout.h>
43 
44 struct llentry;
45 
46 #define ND6_LLINFO_NOSTATE	-2
47 /*
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)
53  */
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
60 
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))
63 
64 struct nd_ifinfo {
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 */
78 };
79 
80 #define ND6_IFF_PERFORMNUD	0x1
81 #define ND6_IFF_ACCEPT_RTADV	0x2
82 #define ND6_IFF_PREFER_SOURCE	0x4 /* XXX: not related to ND. */
83 #define ND6_IFF_IFDISABLED	0x8 /* IPv6 operation is disabled due to
84 				     * DAD failure.  (XXX: not ND-specific)
85 				     */
86 #define ND6_IFF_DONT_SET_IFROUTE	0x10
87 #define ND6_IFF_AUTO_LINKLOCAL	0x20
88 #define	ND6_IFF_NO_RADR		0x40
89 
90 #define	ND6_CREATE		LLE_CREATE
91 #define	ND6_EXCLUSIVE		LLE_EXCLUSIVE
92 
93 #ifdef _KERNEL
94 #define ND_IFINFO(ifp) \
95 	(((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
96 #define IN6_LINKMTU(ifp) \
97 	((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
98 	    ? ND_IFINFO(ifp)->linkmtu \
99 	    : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
100 		? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
101 #endif
102 
103 struct in6_nbrinfo {
104 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
105 	struct in6_addr addr;	/* IPv6 address of the neighbor */
106 	long	asked;		/* number of queries already sent for this addr */
107 	int	isrouter;	/* if it acts as a router */
108 	int	state;		/* reachability state */
109 	int	expire;		/* lifetime for NDP state transition */
110 };
111 
112 #define DRLSTSIZ 10
113 #define PRLSTSIZ 10
114 struct	in6_drlist {
115 	char ifname[IFNAMSIZ];
116 	struct {
117 		struct	in6_addr rtaddr;
118 		u_char	flags;
119 		u_short	rtlifetime;
120 		u_long	expire;
121 		u_short if_index;
122 	} defrouter[DRLSTSIZ];
123 };
124 
125 struct	in6_defrouter {
126 	struct	sockaddr_in6 rtaddr;
127 	u_char	flags;
128 	u_short	rtlifetime;
129 	u_long	expire;
130 	u_short if_index;
131 };
132 
133 #ifdef _KERNEL
134 struct	in6_oprlist {
135 	char ifname[IFNAMSIZ];
136 	struct {
137 		struct	in6_addr prefix;
138 		struct prf_ra raflags;
139 		u_char	prefixlen;
140 		u_char	origin;
141 		u_long vltime;
142 		u_long pltime;
143 		u_long expire;
144 		u_short if_index;
145 		u_short advrtrs; /* number of advertisement routers */
146 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
147 	} prefix[PRLSTSIZ];
148 };
149 #endif
150 
151 struct	in6_prlist {
152 	char ifname[IFNAMSIZ];
153 	struct {
154 		struct	in6_addr prefix;
155 		struct prf_ra raflags;
156 		u_char	prefixlen;
157 		u_char	origin;
158 		u_int32_t vltime;
159 		u_int32_t pltime;
160 		time_t expire;
161 		u_short if_index;
162 		u_short advrtrs; /* number of advertisement routers */
163 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
164 	} prefix[PRLSTSIZ];
165 };
166 
167 struct in6_prefix {
168 	struct	sockaddr_in6 prefix;
169 	struct prf_ra raflags;
170 	u_char	prefixlen;
171 	u_char	origin;
172 	u_int32_t vltime;
173 	u_int32_t pltime;
174 	time_t expire;
175 	u_int32_t flags;
176 	int refcnt;
177 	u_short if_index;
178 	u_short advrtrs; /* number of advertisement routers */
179 	/* struct sockaddr_in6 advrtr[] */
180 };
181 
182 #ifdef _KERNEL
183 struct	in6_ondireq {
184 	char ifname[IFNAMSIZ];
185 	struct {
186 		u_int32_t linkmtu;	/* LinkMTU */
187 		u_int32_t maxmtu;	/* Upper bound of LinkMTU */
188 		u_int32_t basereachable; /* BaseReachableTime */
189 		u_int32_t reachable;	/* Reachable Time */
190 		u_int32_t retrans;	/* Retrans Timer */
191 		u_int32_t flags;	/* Flags */
192 		int recalctm;		/* BaseReacable re-calculation timer */
193 		u_int8_t chlim;		/* CurHopLimit */
194 		u_int8_t receivedra;
195 	} ndi;
196 };
197 #endif
198 
199 struct	in6_ndireq {
200 	char ifname[IFNAMSIZ];
201 	struct nd_ifinfo ndi;
202 };
203 
204 struct	in6_ndifreq {
205 	char ifname[IFNAMSIZ];
206 	u_long ifindex;
207 };
208 
209 /* Prefix status */
210 #define NDPRF_ONLINK		0x1
211 #define NDPRF_DETACHED		0x2
212 
213 /* protocol constants */
214 #define MAX_RTR_SOLICITATION_DELAY	1	/* 1sec */
215 #define RTR_SOLICITATION_INTERVAL	4	/* 4sec */
216 #define MAX_RTR_SOLICITATIONS		3
217 
218 #define ND6_INFINITE_LIFETIME		0xffffffff
219 
220 #ifdef _KERNEL
221 /* node constants */
222 #define MAX_REACHABLE_TIME		3600000	/* msec */
223 #define REACHABLE_TIME			30000	/* msec */
224 #define RETRANS_TIMER			1000	/* msec */
225 #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
226 #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
227 #define DEF_TEMP_VALID_LIFETIME		604800	/* 1 week */
228 #define DEF_TEMP_PREFERRED_LIFETIME	86400	/* 1 day */
229 #define TEMPADDR_REGEN_ADVANCE		5	/* sec */
230 #define MAX_TEMP_DESYNC_FACTOR		600	/* 10 min */
231 #define ND_COMPUTE_RTIME(x) \
232 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
233 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
234 
235 TAILQ_HEAD(nd_drhead, nd_defrouter);
236 struct	nd_defrouter {
237 	TAILQ_ENTRY(nd_defrouter) dr_entry;
238 	struct	in6_addr rtaddr;
239 	u_char	flags;		/* flags on RA message */
240 	u_short	rtlifetime;
241 	u_long	expire;
242 	struct  ifnet *ifp;
243 	int	installed;	/* is installed into kernel routing table */
244 };
245 
246 struct nd_prefixctl {
247 	struct ifnet *ndpr_ifp;
248 
249 	/* prefix */
250 	struct sockaddr_in6 ndpr_prefix;
251 	u_char	ndpr_plen;
252 
253 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
254 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
255 
256 	struct prf_ra ndpr_flags;
257 };
258 
259 
260 struct 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 */
265 
266 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
267 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
268 
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 */
272 
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;
277 	u_char	ndpr_plen;
278 	int	ndpr_refcnt;	/* reference couter from addresses */
279 };
280 
281 #define ndpr_next		ndpr_entry.le_next
282 
283 #define ndpr_raf		ndpr_flags
284 #define ndpr_raf_onlink		ndpr_flags.onlink
285 #define ndpr_raf_auto		ndpr_flags.autonomous
286 #define ndpr_raf_router		ndpr_flags.router
287 
288 /*
289  * Message format for use in obtaining information about prefixes
290  * from inet6 sysctl function
291  */
292 struct inet6_ndpr_msghdr {
293 	u_short	inpm_msglen;	/* to skip over non-understood messages */
294 	u_char	inpm_version;	/* future binary compatibility */
295 	u_char	inpm_type;	/* message type */
296 	struct in6_addr inpm_prefix;
297 	u_long	prm_vltim;
298 	u_long	prm_pltime;
299 	u_long	prm_expire;
300 	u_long	prm_preferred;
301 	struct in6_prflags prm_flags;
302 	u_short	prm_index;	/* index for associated ifp */
303 	u_char	prm_plen;	/* length of prefix in bits */
304 };
305 
306 #define prm_raf_onlink		prm_flags.prf_ra.onlink
307 #define prm_raf_auto		prm_flags.prf_ra.autonomous
308 
309 #define prm_statef_onlink	prm_flags.prf_state.onlink
310 
311 #define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
312 #define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd
313 
314 struct nd_pfxrouter {
315 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
316 #define pfr_next pfr_entry.le_next
317 	struct nd_defrouter *router;
318 };
319 
320 LIST_HEAD(nd_prhead, nd_prefix);
321 
322 /* nd6.c */
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)
345 
346 #define nd6log(x)	do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
347 
348 VNET_DECLARE(struct callout, nd6_timer_ch);
349 #define	V_nd6_timer_ch			VNET(nd6_timer_ch)
350 
351 /* nd6_rtr.c */
352 VNET_DECLARE(int, nd6_defifindex);
353 VNET_DECLARE(int, ip6_desync_factor);	/* seconds */
354 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
355 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
356 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
357 #define	V_nd6_defifindex		VNET(nd6_defifindex)
358 #define	V_ip6_desync_factor		VNET(ip6_desync_factor)
359 #define	V_ip6_temp_preferred_lifetime	VNET(ip6_temp_preferred_lifetime)
360 #define	V_ip6_temp_valid_lifetime	VNET(ip6_temp_valid_lifetime)
361 #define	V_ip6_temp_regen_advance	VNET(ip6_temp_regen_advance)
362 
363 union nd_opts {
364 	struct nd_opt_hdr *nd_opt_array[8];	/* max = target address list */
365 	struct {
366 		struct nd_opt_hdr *zero;
367 		struct nd_opt_hdr *src_lladdr;
368 		struct nd_opt_hdr *tgt_lladdr;
369 		struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
370 		struct nd_opt_rd_hdr *rh;
371 		struct nd_opt_mtu *mtu;
372 		struct nd_opt_hdr *search;	/* multiple opts */
373 		struct nd_opt_hdr *last;	/* multiple opts */
374 		int done;
375 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
376 	} nd_opt_each;
377 };
378 #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
379 #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
380 #define nd_opts_pi		nd_opt_each.pi_beg
381 #define nd_opts_pi_end		nd_opt_each.pi_end
382 #define nd_opts_rh		nd_opt_each.rh
383 #define nd_opts_mtu		nd_opt_each.mtu
384 #define nd_opts_search		nd_opt_each.search
385 #define nd_opts_last		nd_opt_each.last
386 #define nd_opts_done		nd_opt_each.done
387 
388 /* XXX: need nd6_var.h?? */
389 /* nd6.c */
390 void nd6_init __P((void));
391 #ifdef VIMAGE
392 void nd6_destroy __P((void));
393 #endif
394 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
395 void nd6_ifdetach __P((struct nd_ifinfo *));
396 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
397 void nd6_option_init __P((void *, int, union nd_opts *));
398 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
399 int nd6_options __P((union nd_opts *));
400 struct	llentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
401 void nd6_setmtu __P((struct ifnet *));
402 void nd6_llinfo_settimer __P((struct llentry *, long));
403 void nd6_llinfo_settimer_locked __P((struct llentry *, long));
404 void nd6_timer __P((void *));
405 void nd6_purge __P((struct ifnet *));
406 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
407 int nd6_resolve __P((struct ifnet *, struct rtentry *, struct mbuf *,
408 	struct sockaddr *, u_char *));
409 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
410 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
411 struct llentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
412 	char *, int, int, int));
413 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
414 	struct sockaddr_in6 *, struct rtentry *));
415 int nd6_output_lle __P((struct ifnet *, struct ifnet *, struct mbuf *,
416 	struct sockaddr_in6 *, struct rtentry *, struct llentry *,
417 	struct mbuf **));
418 int nd6_output_flush __P((struct ifnet *, struct ifnet *, struct mbuf *,
419 	struct sockaddr_in6 *, struct route *));
420 int nd6_need_cache __P((struct ifnet *));
421 int nd6_storelladdr __P((struct ifnet *, struct mbuf *,
422 	struct sockaddr *, u_char *, struct llentry **));
423 
424 /* nd6_nbr.c */
425 void nd6_na_input __P((struct mbuf *, int, int));
426 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
427 	const struct in6_addr *, u_long, int, struct sockaddr *));
428 void nd6_ns_input __P((struct mbuf *, int, int));
429 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
430 	const struct in6_addr *, struct llentry *, int));
431 caddr_t nd6_ifptomac __P((struct ifnet *));
432 void nd6_dad_start __P((struct ifaddr *, int));
433 void nd6_dad_stop __P((struct ifaddr *));
434 void nd6_dad_duplicated __P((struct ifaddr *));
435 
436 /* nd6_rtr.c */
437 void nd6_rs_input __P((struct mbuf *, int, int));
438 void nd6_ra_input __P((struct mbuf *, int, int));
439 void prelist_del __P((struct nd_prefix *));
440 void defrouter_addreq __P((struct nd_defrouter *));
441 void defrouter_reset __P((void));
442 void defrouter_select __P((void));
443 void defrtrlist_del __P((struct nd_defrouter *));
444 void prelist_remove __P((struct nd_prefix *));
445 int nd6_prelist_add __P((struct nd_prefixctl *, struct nd_defrouter *,
446 	struct nd_prefix **));
447 int nd6_prefix_onlink __P((struct nd_prefix *));
448 int nd6_prefix_offlink __P((struct nd_prefix *));
449 void pfxlist_onlink_check __P((void));
450 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *, struct ifnet *));
451 struct nd_prefix *nd6_prefix_lookup __P((struct nd_prefixctl *));
452 void rt6_flush __P((struct in6_addr *, struct ifnet *));
453 int nd6_setdefaultiface __P((int));
454 int in6_tmpifadd __P((const struct in6_ifaddr *, int, int));
455 
456 #endif /* _KERNEL */
457 
458 #endif /* _NETINET6_ND6_H_ */
459