xref: /freebsd/sys/netinet6/nd6.h (revision 8655c70597b0e0918c82114b1186df5669b83eb6)
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 
88 #define	ND6_CREATE		LLE_CREATE
89 #define	ND6_EXCLUSIVE		LLE_EXCLUSIVE
90 
91 #ifdef _KERNEL
92 #define ND_IFINFO(ifp) \
93 	(((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
94 #define IN6_LINKMTU(ifp) \
95 	((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
96 	    ? ND_IFINFO(ifp)->linkmtu \
97 	    : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
98 		? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
99 #endif
100 
101 struct in6_nbrinfo {
102 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
103 	struct in6_addr addr;	/* IPv6 address of the neighbor */
104 	long	asked;		/* number of queries already sent for this addr */
105 	int	isrouter;	/* if it acts as a router */
106 	int	state;		/* reachability state */
107 	int	expire;		/* lifetime for NDP state transition */
108 };
109 
110 #define DRLSTSIZ 10
111 #define PRLSTSIZ 10
112 struct	in6_drlist {
113 	char ifname[IFNAMSIZ];
114 	struct {
115 		struct	in6_addr rtaddr;
116 		u_char	flags;
117 		u_short	rtlifetime;
118 		u_long	expire;
119 		u_short if_index;
120 	} defrouter[DRLSTSIZ];
121 };
122 
123 struct	in6_defrouter {
124 	struct	sockaddr_in6 rtaddr;
125 	u_char	flags;
126 	u_short	rtlifetime;
127 	u_long	expire;
128 	u_short if_index;
129 };
130 
131 #ifdef _KERNEL
132 struct	in6_oprlist {
133 	char ifname[IFNAMSIZ];
134 	struct {
135 		struct	in6_addr prefix;
136 		struct prf_ra raflags;
137 		u_char	prefixlen;
138 		u_char	origin;
139 		u_long vltime;
140 		u_long pltime;
141 		u_long expire;
142 		u_short if_index;
143 		u_short advrtrs; /* number of advertisement routers */
144 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
145 	} prefix[PRLSTSIZ];
146 };
147 #endif
148 
149 struct	in6_prlist {
150 	char ifname[IFNAMSIZ];
151 	struct {
152 		struct	in6_addr prefix;
153 		struct prf_ra raflags;
154 		u_char	prefixlen;
155 		u_char	origin;
156 		u_int32_t vltime;
157 		u_int32_t pltime;
158 		time_t expire;
159 		u_short if_index;
160 		u_short advrtrs; /* number of advertisement routers */
161 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
162 	} prefix[PRLSTSIZ];
163 };
164 
165 struct in6_prefix {
166 	struct	sockaddr_in6 prefix;
167 	struct prf_ra raflags;
168 	u_char	prefixlen;
169 	u_char	origin;
170 	u_int32_t vltime;
171 	u_int32_t pltime;
172 	time_t expire;
173 	u_int32_t flags;
174 	int refcnt;
175 	u_short if_index;
176 	u_short advrtrs; /* number of advertisement routers */
177 	/* struct sockaddr_in6 advrtr[] */
178 };
179 
180 #ifdef _KERNEL
181 struct	in6_ondireq {
182 	char ifname[IFNAMSIZ];
183 	struct {
184 		u_int32_t linkmtu;	/* LinkMTU */
185 		u_int32_t maxmtu;	/* Upper bound of LinkMTU */
186 		u_int32_t basereachable; /* BaseReachableTime */
187 		u_int32_t reachable;	/* Reachable Time */
188 		u_int32_t retrans;	/* Retrans Timer */
189 		u_int32_t flags;	/* Flags */
190 		int recalctm;		/* BaseReacable re-calculation timer */
191 		u_int8_t chlim;		/* CurHopLimit */
192 		u_int8_t receivedra;
193 	} ndi;
194 };
195 #endif
196 
197 struct	in6_ndireq {
198 	char ifname[IFNAMSIZ];
199 	struct nd_ifinfo ndi;
200 };
201 
202 struct	in6_ndifreq {
203 	char ifname[IFNAMSIZ];
204 	u_long ifindex;
205 };
206 
207 /* Prefix status */
208 #define NDPRF_ONLINK		0x1
209 #define NDPRF_DETACHED		0x2
210 
211 /* protocol constants */
212 #define MAX_RTR_SOLICITATION_DELAY	1	/* 1sec */
213 #define RTR_SOLICITATION_INTERVAL	4	/* 4sec */
214 #define MAX_RTR_SOLICITATIONS		3
215 
216 #define ND6_INFINITE_LIFETIME		0xffffffff
217 
218 #ifdef _KERNEL
219 /* node constants */
220 #define MAX_REACHABLE_TIME		3600000	/* msec */
221 #define REACHABLE_TIME			30000	/* msec */
222 #define RETRANS_TIMER			1000	/* msec */
223 #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
224 #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
225 #define DEF_TEMP_VALID_LIFETIME		604800	/* 1 week */
226 #define DEF_TEMP_PREFERRED_LIFETIME	86400	/* 1 day */
227 #define TEMPADDR_REGEN_ADVANCE		5	/* sec */
228 #define MAX_TEMP_DESYNC_FACTOR		600	/* 10 min */
229 #define ND_COMPUTE_RTIME(x) \
230 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
231 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
232 
233 TAILQ_HEAD(nd_drhead, nd_defrouter);
234 struct	nd_defrouter {
235 	TAILQ_ENTRY(nd_defrouter) dr_entry;
236 	struct	in6_addr rtaddr;
237 	u_char	flags;		/* flags on RA message */
238 	u_short	rtlifetime;
239 	u_long	expire;
240 	struct  ifnet *ifp;
241 	int	installed;	/* is installed into kernel routing table */
242 };
243 
244 struct nd_prefixctl {
245 	struct ifnet *ndpr_ifp;
246 
247 	/* prefix */
248 	struct sockaddr_in6 ndpr_prefix;
249 	u_char	ndpr_plen;
250 
251 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
252 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
253 
254 	struct prf_ra ndpr_flags;
255 };
256 
257 
258 struct nd_prefix {
259 	struct ifnet *ndpr_ifp;
260 	LIST_ENTRY(nd_prefix) ndpr_entry;
261 	struct sockaddr_in6 ndpr_prefix;	/* prefix */
262 	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
263 
264 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
265 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
266 
267 	time_t ndpr_expire;	/* expiration time of the prefix */
268 	time_t ndpr_preferred;	/* preferred time of the prefix */
269 	time_t ndpr_lastupdate; /* reception time of last advertisement */
270 
271 	struct prf_ra ndpr_flags;
272 	u_int32_t ndpr_stateflags; /* actual state flags */
273 	/* list of routers that advertise the prefix: */
274 	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
275 	u_char	ndpr_plen;
276 	int	ndpr_refcnt;	/* reference couter from addresses */
277 };
278 
279 #define ndpr_next		ndpr_entry.le_next
280 
281 #define ndpr_raf		ndpr_flags
282 #define ndpr_raf_onlink		ndpr_flags.onlink
283 #define ndpr_raf_auto		ndpr_flags.autonomous
284 #define ndpr_raf_router		ndpr_flags.router
285 
286 /*
287  * Message format for use in obtaining information about prefixes
288  * from inet6 sysctl function
289  */
290 struct inet6_ndpr_msghdr {
291 	u_short	inpm_msglen;	/* to skip over non-understood messages */
292 	u_char	inpm_version;	/* future binary compatibility */
293 	u_char	inpm_type;	/* message type */
294 	struct in6_addr inpm_prefix;
295 	u_long	prm_vltim;
296 	u_long	prm_pltime;
297 	u_long	prm_expire;
298 	u_long	prm_preferred;
299 	struct in6_prflags prm_flags;
300 	u_short	prm_index;	/* index for associated ifp */
301 	u_char	prm_plen;	/* length of prefix in bits */
302 };
303 
304 #define prm_raf_onlink		prm_flags.prf_ra.onlink
305 #define prm_raf_auto		prm_flags.prf_ra.autonomous
306 
307 #define prm_statef_onlink	prm_flags.prf_state.onlink
308 
309 #define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
310 #define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd
311 
312 struct nd_pfxrouter {
313 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
314 #define pfr_next pfr_entry.le_next
315 	struct nd_defrouter *router;
316 };
317 
318 LIST_HEAD(nd_prhead, nd_prefix);
319 
320 /* nd6.c */
321 #ifdef VIMAGE_GLOBALS
322 extern int nd6_prune;
323 extern int nd6_delay;
324 extern int nd6_umaxtries;
325 extern int nd6_mmaxtries;
326 extern int nd6_useloopback;
327 extern int nd6_maxnudhint;
328 extern int nd6_gctimer;
329 extern struct nd_drhead nd_defrouter;
330 extern struct nd_prhead nd_prefix;
331 extern int nd6_debug;
332 extern int nd6_onlink_ns_rfc4861;
333 
334 extern struct callout nd6_timer_ch;
335 
336 /* nd6_rtr.c */
337 extern int nd6_defifindex;
338 extern int ip6_desync_factor;	/* seconds */
339 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
340 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
341 extern int ip6_temp_regen_advance; /* seconds */
342 #endif /* VIMAGE_GLOBALS */
343 
344 #define nd6log(x)	do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
345 
346 union nd_opts {
347 	struct nd_opt_hdr *nd_opt_array[8];	/* max = target address list */
348 	struct {
349 		struct nd_opt_hdr *zero;
350 		struct nd_opt_hdr *src_lladdr;
351 		struct nd_opt_hdr *tgt_lladdr;
352 		struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
353 		struct nd_opt_rd_hdr *rh;
354 		struct nd_opt_mtu *mtu;
355 		struct nd_opt_hdr *search;	/* multiple opts */
356 		struct nd_opt_hdr *last;	/* multiple opts */
357 		int done;
358 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
359 	} nd_opt_each;
360 };
361 #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
362 #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
363 #define nd_opts_pi		nd_opt_each.pi_beg
364 #define nd_opts_pi_end		nd_opt_each.pi_end
365 #define nd_opts_rh		nd_opt_each.rh
366 #define nd_opts_mtu		nd_opt_each.mtu
367 #define nd_opts_search		nd_opt_each.search
368 #define nd_opts_last		nd_opt_each.last
369 #define nd_opts_done		nd_opt_each.done
370 
371 /* XXX: need nd6_var.h?? */
372 /* nd6.c */
373 void nd6_init __P((void));
374 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
375 void nd6_ifdetach __P((struct nd_ifinfo *));
376 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
377 void nd6_option_init __P((void *, int, union nd_opts *));
378 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
379 int nd6_options __P((union nd_opts *));
380 struct	llentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
381 void nd6_setmtu __P((struct ifnet *));
382 void nd6_llinfo_settimer __P((struct llentry *, long));
383 void nd6_llinfo_settimer_locked __P((struct llentry *, long));
384 void nd6_timer __P((void *));
385 void nd6_purge __P((struct ifnet *));
386 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
387 int nd6_resolve __P((struct ifnet *, struct rtentry *, struct mbuf *,
388 	struct sockaddr *, u_char *));
389 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
390 struct llentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
391 	char *, int, int, int));
392 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
393 	struct sockaddr_in6 *, struct rtentry *));
394 int nd6_output_lle __P((struct ifnet *, struct ifnet *, struct mbuf *,
395 	struct sockaddr_in6 *, struct rtentry *, struct llentry *,
396 	struct mbuf **));
397 int nd6_output_flush __P((struct ifnet *, struct ifnet *, struct mbuf *,
398 	struct sockaddr_in6 *, struct rtentry *));
399 int nd6_need_cache __P((struct ifnet *));
400 int nd6_storelladdr __P((struct ifnet *, struct mbuf *,
401 	struct sockaddr *, u_char *, struct llentry **));
402 
403 /* nd6_nbr.c */
404 void nd6_na_input __P((struct mbuf *, int, int));
405 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
406 	const struct in6_addr *, u_long, int, struct sockaddr *));
407 void nd6_ns_input __P((struct mbuf *, int, int));
408 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
409 	const struct in6_addr *, struct llentry *, int));
410 caddr_t nd6_ifptomac __P((struct ifnet *));
411 void nd6_dad_start __P((struct ifaddr *, int));
412 void nd6_dad_stop __P((struct ifaddr *));
413 void nd6_dad_duplicated __P((struct ifaddr *));
414 
415 /* nd6_rtr.c */
416 void nd6_rs_input __P((struct mbuf *, int, int));
417 void nd6_ra_input __P((struct mbuf *, int, int));
418 void prelist_del __P((struct nd_prefix *));
419 void defrouter_addreq __P((struct nd_defrouter *));
420 void defrouter_reset __P((void));
421 void defrouter_select __P((void));
422 void defrtrlist_del __P((struct nd_defrouter *));
423 void prelist_remove __P((struct nd_prefix *));
424 int nd6_prelist_add __P((struct nd_prefixctl *, struct nd_defrouter *,
425 	struct nd_prefix **));
426 int nd6_prefix_onlink __P((struct nd_prefix *));
427 int nd6_prefix_offlink __P((struct nd_prefix *));
428 void pfxlist_onlink_check __P((void));
429 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *, struct ifnet *));
430 struct nd_prefix *nd6_prefix_lookup __P((struct nd_prefixctl *));
431 void rt6_flush __P((struct in6_addr *, struct ifnet *));
432 int nd6_setdefaultiface __P((int));
433 int in6_tmpifadd __P((const struct in6_ifaddr *, int, int));
434 
435 #endif /* _KERNEL */
436 
437 #endif /* _NETINET6_ND6_H_ */
438