1 /* $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.5 2002/04/28 05:40:27 suz Exp $ */
2 /* $DragonFly: src/sys/netinet6/nd6.h,v 1.8 2006/09/03 18:52:29 dillon Exp $ */
3 /* $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ */
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the project nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #ifndef _NETINET6_ND6_H_
35 #define _NETINET6_ND6_H_
37 /* see net/route.h, or net/if_inarp.h */
39 #define RTF_ANNOUNCE RTF_PROTO2
43 #include <sys/types.h>
46 #include <sys/queue.h>
48 #ifndef _SYS_CALLOUT_H_
49 #include <sys/callout.h>
54 #ifndef _NETINET_IN_H_
55 #include <netinet/in.h>
57 #ifndef _NETINET6_IN6_VAR_H_
58 #include <netinet6/in6_var.h>
61 #include <sys/mutex.h>
65 struct llinfo_nd6
*ln_next
;
66 struct llinfo_nd6
*ln_prev
;
67 struct rtentry
*ln_rt
;
68 struct mbuf
*ln_hold
; /* last packet until resolved/timeout */
69 long ln_asked
; /* number of queries already sent for this addr */
70 u_long ln_expire
; /* lifetime for NDP state transition */
71 short ln_state
; /* reachability state */
72 short ln_router
; /* 2^0: ND6 router bit */
73 int ln_byhint
; /* # of times we made it reachable by UL hint */
76 #define ND6_LLINFO_NOSTATE -2
77 #define ND6_LLINFO_WAITDELETE -1
78 #define ND6_LLINFO_INCOMPLETE 0
79 #define ND6_LLINFO_REACHABLE 1
80 #define ND6_LLINFO_STALE 2
81 #define ND6_LLINFO_DELAY 3
82 #define ND6_LLINFO_PROBE 4
84 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
87 u_int32_t linkmtu
; /* LinkMTU */
88 u_int32_t maxmtu
; /* Upper bound of LinkMTU */
89 u_int32_t basereachable
; /* BaseReachableTime */
90 u_int32_t reachable
; /* Reachable Time */
91 u_int32_t retrans
; /* Retrans Timer */
92 u_int32_t flags
; /* Flags (ND6_IFF_*) */
93 int recalctm
; /* BaseReacable re-calculation timer */
94 u_int8_t chlim
; /* CurHopLimit */
95 u_int8_t reserved
; /* reserved 0 */
96 u_int8_t initialized
; /* Flag to see the entry is initialized */
97 /* the following 3 members are for privacy extension for addrconf */
98 u_int8_t randomseed0
[8]; /* upper 64 bits of MD5 digest */
99 u_int8_t randomseed1
[8]; /* lower 64 bits (usually the EUI64 IFID) */
100 u_int8_t randomid
[8]; /* current random ID */
103 #define ND6_IFF_PERFORMNUD 0x1
104 #define ND6_IFF_ACCEPT_RTADV 0x2
105 #define ND6_IFF_AUTO_LINKLOCAL 0x4
106 #define ND6_IFF_NO_DAD 0x8
109 #define ND_IFINFO(ifp) \
110 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
111 #define IN6_LINKMTU(ifp) \
112 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
113 ? ND_IFINFO(ifp)->linkmtu \
114 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
115 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
119 char ifname
[IFNAMSIZ
]; /* if name, e.g. "en0" */
120 struct in6_addr addr
; /* IPv6 address of the neighbor */
121 long asked
; /* number of queries already sent for this addr */
122 int isrouter
; /* if it acts as a router */
123 int state
; /* reachability state */
124 int expire
; /* lifetime for NDP state transition */
130 char ifname
[IFNAMSIZ
];
132 struct in6_addr rtaddr
;
137 } defrouter
[DRLSTSIZ
];
140 struct in6_defrouter
{
141 struct sockaddr_in6 rtaddr
;
149 char ifname
[IFNAMSIZ
];
151 struct in6_addr prefix
;
152 struct prf_ra raflags
;
159 u_short advrtrs
; /* number of advertisement routers */
160 struct in6_addr advrtr
[DRLSTSIZ
]; /* XXX: explicit limit */
165 struct sockaddr_in6 prefix
;
166 struct prf_ra raflags
;
175 u_short advrtrs
; /* number of advertisement routers */
176 /* struct sockaddr_in6 advrtr[] */
181 char ifname
[IFNAMSIZ
];
183 u_int32_t linkmtu
; /* LinkMTU */
184 u_int32_t maxmtu
; /* Upper bound of LinkMTU */
185 u_int32_t basereachable
; /* BaseReachableTime */
186 u_int32_t reachable
; /* Reachable Time */
187 u_int32_t retrans
; /* Retrans Timer */
188 u_int32_t flags
; /* Flags */
189 int recalctm
; /* BaseReacable re-calculation timer */
190 u_int8_t chlim
; /* CurHopLimit */
197 char ifname
[IFNAMSIZ
];
198 struct nd_ifinfo ndi
;
202 char ifname
[IFNAMSIZ
];
207 #define NDPRF_ONLINK 0x1
208 #define NDPRF_DETACHED 0x2
210 /* protocol constants */
211 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
212 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
213 #define MAX_RTR_SOLICITATIONS 3
215 #define ND6_INFINITE_LIFETIME 0xffffffff
219 #define MAX_REACHABLE_TIME 3600000 /* msec */
220 #define REACHABLE_TIME 30000 /* msec */
221 #define RETRANS_TIMER 1000 /* msec */
222 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
223 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
224 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
225 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
226 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
227 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
228 #define ND_COMPUTE_RTIME(x) \
229 (((MIN_RANDOM_FACTOR * (x >> 10)) + (krandom() & \
230 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
232 TAILQ_HEAD(nd_drhead
, nd_defrouter
);
233 struct nd_defrouter
{
234 TAILQ_ENTRY(nd_defrouter
) dr_entry
;
235 struct in6_addr rtaddr
;
236 u_char flags
; /* flags on RA message */
239 u_long advint
; /* Mobile IPv6 addition (milliseconds) */
240 u_long advint_expire
; /* Mobile IPv6 addition */
241 int advints_lost
; /* Mobile IPv6 addition */
246 struct ifnet
*ndpr_ifp
;
247 LIST_ENTRY(nd_prefix
) ndpr_entry
;
248 struct sockaddr_in6 ndpr_prefix
; /* prefix */
249 struct in6_addr ndpr_mask
; /* netmask derived from the prefix */
250 struct in6_addr ndpr_addr
; /* address that is derived from the prefix */
251 u_int32_t ndpr_vltime
; /* advertised valid lifetime */
252 u_int32_t ndpr_pltime
; /* advertised preferred lifetime */
253 time_t ndpr_expire
; /* expiration time of the prefix */
254 time_t ndpr_preferred
; /* preferred time of the prefix */
255 struct prf_ra ndpr_flags
;
256 u_int32_t ndpr_stateflags
; /* actual state flags */
257 /* list of routers that advertise the prefix: */
258 LIST_HEAD(pr_rtrhead
, nd_pfxrouter
) ndpr_advrtrs
;
260 int ndpr_refcnt
; /* reference couter from addresses */
263 #define ndpr_next ndpr_entry.le_next
265 #define ndpr_raf ndpr_flags
266 #define ndpr_raf_onlink ndpr_flags.onlink
267 #define ndpr_raf_auto ndpr_flags.autonomous
270 * We keep expired prefix for certain amount of time, for validation purposes.
271 * 1800s = MaxRtrAdvInterval
273 #define NDPR_KEEP_EXPIRED (1800 * 2)
276 * Message format for use in obtaining information about prefixes
277 * from inet6 sysctl function
279 struct inet6_ndpr_msghdr
{
280 u_short inpm_msglen
; /* to skip over non-understood messages */
281 u_char inpm_version
; /* future binary compatibility */
282 u_char inpm_type
; /* message type */
283 struct in6_addr inpm_prefix
;
287 u_long prm_preferred
;
288 struct in6_prflags prm_flags
;
289 u_short prm_index
; /* index for associated ifp */
290 u_char prm_plen
; /* length of prefix in bits */
293 #define prm_raf_onlink prm_flags.prf_ra.onlink
294 #define prm_raf_auto prm_flags.prf_ra.autonomous
296 #define prm_statef_onlink prm_flags.prf_state.onlink
298 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
299 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
301 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
303 struct nd_pfxrouter
{
304 LIST_ENTRY(nd_pfxrouter
) pfr_entry
;
305 #define pfr_next pfr_entry.le_next
306 struct nd_defrouter
*router
;
309 LIST_HEAD(nd_prhead
, nd_prefix
);
312 extern int nd6_prune
;
313 extern int nd6_delay
;
314 extern int nd6_umaxtries
;
315 extern int nd6_mmaxtries
;
316 extern int nd6_useloopback
;
317 extern int nd6_maxnudhint
;
318 extern int nd6_gctimer
;
319 extern struct llinfo_nd6 llinfo_nd6
;
320 extern struct nd_ifinfo
*nd_ifinfo
;
321 extern struct nd_drhead nd_defrouter
;
322 extern struct nd_prhead nd_prefix
;
323 extern struct mtx nd6_mtx
;
324 extern int nd6_debug
;
325 extern int nd6_onlink_ns_rfc4861
;
327 #define nd6log(x) do { if (nd6_debug) log x; } while (0)
330 extern int nd6_defifindex
;
331 extern int ip6_desync_factor
; /* seconds */
332 extern u_int32_t ip6_temp_preferred_lifetime
; /* seconds */
333 extern u_int32_t ip6_temp_valid_lifetime
; /* seconds */
334 extern int ip6_temp_regen_advance
; /* seconds */
337 struct nd_opt_hdr
*nd_opt_array
[9]; /* max = home agent info */
339 struct nd_opt_hdr
*zero
;
340 struct nd_opt_hdr
*src_lladdr
;
341 struct nd_opt_hdr
*tgt_lladdr
;
342 struct nd_opt_prefix_info
*pi_beg
; /* multiple opts, start */
343 struct nd_opt_rd_hdr
*rh
;
344 struct nd_opt_mtu
*mtu
;
345 struct nd_opt_hdr
*six
;
346 struct nd_opt_advint
*adv
;
347 struct nd_opt_hai
*hai
;
348 struct nd_opt_hdr
*search
; /* multiple opts */
349 struct nd_opt_hdr
*last
; /* multiple opts */
351 struct nd_opt_prefix_info
*pi_end
;/* multiple opts, end */
354 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
355 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
356 #define nd_opts_pi nd_opt_each.pi_beg
357 #define nd_opts_pi_end nd_opt_each.pi_end
358 #define nd_opts_rh nd_opt_each.rh
359 #define nd_opts_mtu nd_opt_each.mtu
360 #define nd_opts_adv nd_opt_each.adv
361 #define nd_opts_hai nd_opt_each.hai
362 #define nd_opts_search nd_opt_each.search
363 #define nd_opts_last nd_opt_each.last
364 #define nd_opts_done nd_opt_each.done
366 /* XXX: need nd6_var.h?? */
368 void nd6_init (void);
369 void nd6_timer_init(void);
370 struct nd_ifinfo
*nd6_ifattach (struct ifnet
*);
371 void nd6_ifdetach (struct nd_ifinfo
*);
372 int nd6_is_addr_neighbor (struct sockaddr_in6
*, struct ifnet
*);
373 void nd6_option_init (void *, int, union nd_opts
*);
374 struct nd_opt_hdr
*nd6_option (union nd_opts
*);
375 int nd6_options (union nd_opts
*);
376 struct rtentry
*nd6_lookup (struct in6_addr
*, int, struct ifnet
*);
377 void nd6_setmtu (struct ifnet
*);
378 void nd6_purge (struct ifnet
*);
379 struct llinfo_nd6
*nd6_free (struct rtentry
*);
380 void nd6_nud_hint (struct rtentry
*, struct in6_addr
*, int);
381 int nd6_resolve(struct ifnet
*, struct rtentry
*,
382 struct mbuf
*, struct sockaddr
*, u_char
*);
383 void nd6_rtrequest (int, struct rtentry
*);
384 int nd6_ioctl (u_long
, caddr_t
, struct ifnet
*);
385 struct rtentry
*nd6_cache_lladdr (struct ifnet
*, struct in6_addr
*,
386 char *, int, int, int);
387 int nd6_output(struct ifnet
*, struct ifnet
*, struct mbuf
*,
388 struct sockaddr_in6
*, struct rtentry
*);
389 int nd6_need_cache (struct ifnet
*);
392 void nd6_na_input (struct mbuf
*, int, int);
393 void nd6_na_output (struct ifnet
*, const struct in6_addr
*,
394 const struct in6_addr
*, u_long
, int, struct sockaddr
*);
395 void nd6_ns_input (struct mbuf
*, int, int);
396 void nd6_ns_output (struct ifnet
*, const struct in6_addr
*,
397 const struct in6_addr
*, struct llinfo_nd6
*, int);
398 caddr_t
nd6_ifptomac (struct ifnet
*);
399 void nd6_dad_start (struct ifaddr
*, int *);
400 void nd6_dad_stop (struct ifaddr
*);
403 void nd6_rs_input (struct mbuf
*, int, int);
404 void nd6_ra_input (struct mbuf
*, int, int);
405 void prelist_del (struct nd_prefix
*);
406 void defrouter_addreq (struct nd_defrouter
*);
407 void defrouter_delreq (struct nd_defrouter
*, int);
408 void defrouter_select (void);
409 void defrtrlist_del (struct nd_defrouter
*);
410 void prelist_remove (struct nd_prefix
*);
411 int prelist_update(struct nd_prefix
*, struct nd_defrouter
*,
413 int nd6_prelist_add(struct nd_prefix
*, struct nd_defrouter
*,
414 struct nd_prefix
**);
415 int nd6_prefix_onlink (struct nd_prefix
*);
416 int nd6_prefix_offlink (struct nd_prefix
*);
417 void pfxlist_onlink_check (void);
418 struct nd_defrouter
*defrouter_lookup(struct in6_addr
*, struct ifnet
*);
419 struct nd_prefix
*nd6_prefix_lookup (struct nd_prefix
*);
420 int in6_init_prefix_ltimes (struct nd_prefix
*);
421 void rt6_flush (struct in6_addr
*, struct ifnet
*);
422 int nd6_setdefaultiface (int);
423 int in6_tmpifadd (const struct in6_ifaddr
*, int);
427 #endif /* _NETINET6_ND6_H_ */