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.5 2004/12/30 02:26:12 hsu 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
42 #include <sys/queue.h>
43 #include <sys/callout.h>
46 struct llinfo_nd6 *ln_next;
47 struct llinfo_nd6 *ln_prev;
48 struct rtentry *ln_rt;
49 struct mbuf *ln_hold; /* last packet until resolved/timeout */
50 long ln_asked; /* number of queries already sent for this addr */
51 u_long ln_expire; /* lifetime for NDP state transition */
52 short ln_state; /* reachability state */
53 short ln_router; /* 2^0: ND6 router bit */
54 int ln_byhint; /* # of times we made it reachable by UL hint */
57 #define ND6_LLINFO_NOSTATE -2
59 * We don't need the WAITDELETE state any more, but we keep the definition
60 * in a comment line instead of removing it. This is necessary to avoid
61 * unintentionally reusing the value for another purpose, which might
62 * affect backward compatibility with old applications.
63 * (20000711 jinmei@kame.net)
65 /* #define ND6_LLINFO_WAITDELETE -1 */
66 #define ND6_LLINFO_INCOMPLETE 0
67 #define ND6_LLINFO_REACHABLE 1
68 #define ND6_LLINFO_STALE 2
69 #define ND6_LLINFO_DELAY 3
70 #define ND6_LLINFO_PROBE 4
72 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
75 u_int32_t linkmtu; /* LinkMTU */
76 u_int32_t maxmtu; /* Upper bound of LinkMTU */
77 u_int32_t basereachable; /* BaseReachableTime */
78 u_int32_t reachable; /* Reachable Time */
79 u_int32_t retrans; /* Retrans Timer */
80 u_int32_t flags; /* Flags */
81 int recalctm; /* BaseReacable re-calculation timer */
82 u_int8_t chlim; /* CurHopLimit */
84 /* the following 3 members are for privacy extension for addrconf */
85 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
86 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
87 u_int8_t randomid[8]; /* current random ID */
90 #define ND6_IFF_PERFORMNUD 0x1
91 #define ND6_IFF_ACCEPT_RTADV 0x2
94 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
95 struct in6_addr addr; /* IPv6 address of the neighbor */
96 long asked; /* number of queries already sent for this addr */
97 int isrouter; /* if it acts as a router */
98 int state; /* reachability state */
99 int expire; /* lifetime for NDP state transition */
105 char ifname[IFNAMSIZ];
107 struct in6_addr rtaddr;
112 } defrouter[DRLSTSIZ];
115 struct in6_defrouter {
116 struct sockaddr_in6 rtaddr;
124 char ifname[IFNAMSIZ];
126 struct in6_addr prefix;
127 struct prf_ra raflags;
134 u_short advrtrs; /* number of advertisement routers */
135 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
140 struct sockaddr_in6 prefix;
141 struct prf_ra raflags;
150 u_short advrtrs; /* number of advertisement routers */
151 /* struct sockaddr_in6 advrtr[] */
156 char ifname[IFNAMSIZ];
158 u_int32_t linkmtu; /* LinkMTU */
159 u_int32_t maxmtu; /* Upper bound of LinkMTU */
160 u_int32_t basereachable; /* BaseReachableTime */
161 u_int32_t reachable; /* Reachable Time */
162 u_int32_t retrans; /* Retrans Timer */
163 u_int32_t flags; /* Flags */
164 int recalctm; /* BaseReacable re-calculation timer */
165 u_int8_t chlim; /* CurHopLimit */
172 char ifname[IFNAMSIZ];
173 struct nd_ifinfo ndi;
177 char ifname[IFNAMSIZ];
182 #define NDPRF_ONLINK 0x1
183 #define NDPRF_DETACHED 0x2
185 /* protocol constants */
186 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
187 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
188 #define MAX_RTR_SOLICITATIONS 3
190 #define ND6_INFINITE_LIFETIME 0xffffffff
194 #define MAX_REACHABLE_TIME 3600000 /* msec */
195 #define REACHABLE_TIME 30000 /* msec */
196 #define RETRANS_TIMER 1000 /* msec */
197 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
198 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
199 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
200 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
201 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */
202 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
203 #define ND_COMPUTE_RTIME(x) \
204 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
205 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
207 TAILQ_HEAD(nd_drhead, nd_defrouter);
208 struct nd_defrouter {
209 TAILQ_ENTRY(nd_defrouter) dr_entry;
210 struct in6_addr rtaddr;
211 u_char flags; /* flags on RA message */
214 u_long advint; /* Mobile IPv6 addition (milliseconds) */
215 u_long advint_expire; /* Mobile IPv6 addition */
216 int advints_lost; /* Mobile IPv6 addition */
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 struct in6_addr ndpr_addr; /* address that is derived from the prefix */
226 u_int32_t ndpr_vltime; /* advertised valid lifetime */
227 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
228 time_t ndpr_expire; /* expiration time of the prefix */
229 time_t ndpr_preferred; /* preferred time of the prefix */
230 struct prf_ra ndpr_flags;
231 u_int32_t ndpr_stateflags; /* actual state flags */
232 /* list of routers that advertise the prefix: */
233 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
235 int ndpr_refcnt; /* reference couter from addresses */
238 #define ndpr_next ndpr_entry.le_next
240 #define ndpr_raf ndpr_flags
241 #define ndpr_raf_onlink ndpr_flags.onlink
242 #define ndpr_raf_auto ndpr_flags.autonomous
245 * We keep expired prefix for certain amount of time, for validation purposes.
246 * 1800s = MaxRtrAdvInterval
248 #define NDPR_KEEP_EXPIRED (1800 * 2)
251 * Message format for use in obtaining information about prefixes
252 * from inet6 sysctl function
254 struct inet6_ndpr_msghdr {
255 u_short inpm_msglen; /* to skip over non-understood messages */
256 u_char inpm_version; /* future binary compatibility */
257 u_char inpm_type; /* message type */
258 struct in6_addr inpm_prefix;
262 u_long prm_preferred;
263 struct in6_prflags prm_flags;
264 u_short prm_index; /* index for associated ifp */
265 u_char prm_plen; /* length of prefix in bits */
268 #define prm_raf_onlink prm_flags.prf_ra.onlink
269 #define prm_raf_auto prm_flags.prf_ra.autonomous
271 #define prm_statef_onlink prm_flags.prf_state.onlink
273 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
274 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
276 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
277 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
279 struct nd_pfxrouter {
280 LIST_ENTRY(nd_pfxrouter) pfr_entry;
281 #define pfr_next pfr_entry.le_next
282 struct nd_defrouter *router;
285 LIST_HEAD(nd_prhead, nd_prefix);
288 extern int nd6_prune;
289 extern int nd6_delay;
290 extern int nd6_umaxtries;
291 extern int nd6_mmaxtries;
292 extern int nd6_useloopback;
293 extern int nd6_maxnudhint;
294 extern int nd6_gctimer;
295 extern struct llinfo_nd6 llinfo_nd6;
296 extern struct nd_ifinfo *nd_ifinfo;
297 extern struct nd_drhead nd_defrouter;
298 extern struct nd_prhead nd_prefix;
299 extern int nd6_debug;
301 #define nd6log(x) do { if (nd6_debug) log x; } while (0)
303 extern struct callout nd6_timer_ch;
306 extern int nd6_defifindex;
307 extern int ip6_desync_factor; /* seconds */
308 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
309 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
310 extern int ip6_temp_regen_advance; /* seconds */
313 struct nd_opt_hdr *nd_opt_array[9]; /* max = home agent info */
315 struct nd_opt_hdr *zero;
316 struct nd_opt_hdr *src_lladdr;
317 struct nd_opt_hdr *tgt_lladdr;
318 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
319 struct nd_opt_rd_hdr *rh;
320 struct nd_opt_mtu *mtu;
321 struct nd_opt_hdr *six;
322 struct nd_opt_advint *adv;
323 struct nd_opt_hai *hai;
324 struct nd_opt_hdr *search; /* multiple opts */
325 struct nd_opt_hdr *last; /* multiple opts */
327 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
330 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
331 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
332 #define nd_opts_pi nd_opt_each.pi_beg
333 #define nd_opts_pi_end nd_opt_each.pi_end
334 #define nd_opts_rh nd_opt_each.rh
335 #define nd_opts_mtu nd_opt_each.mtu
336 #define nd_opts_adv nd_opt_each.adv
337 #define nd_opts_hai nd_opt_each.hai
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
342 /* XXX: need nd6_var.h?? */
344 void nd6_init (void);
345 void nd6_ifattach (struct ifnet *);
346 int nd6_is_addr_neighbor (struct sockaddr_in6 *, struct ifnet *);
347 void nd6_option_init (void *, int, union nd_opts *);
348 struct nd_opt_hdr *nd6_option (union nd_opts *);
349 int nd6_options (union nd_opts *);
350 struct rtentry *nd6_lookup (struct in6_addr *, int, struct ifnet *);
351 void nd6_setmtu (struct ifnet *);
352 void nd6_timer (void *);
353 void nd6_purge (struct ifnet *);
354 struct llinfo_nd6 *nd6_free (struct rtentry *);
355 void nd6_nud_hint (struct rtentry *, struct in6_addr *, int);
356 int nd6_resolve (struct ifnet *, struct rtentry *,
357 struct mbuf *, struct sockaddr *, u_char *);
358 void nd6_rtrequest (int, struct rtentry *, struct rt_addrinfo *);
359 int nd6_ioctl (u_long, caddr_t, struct ifnet *);
360 struct rtentry *nd6_cache_lladdr (struct ifnet *, struct in6_addr *,
361 char *, int, int, int);
362 int nd6_output (struct ifnet *, struct ifnet *, struct mbuf *,
363 struct sockaddr_in6 *, struct rtentry *);
364 int nd6_storelladdr (struct ifnet *, struct rtentry *, struct mbuf *,
365 struct sockaddr *, u_char *);
366 int nd6_need_cache (struct ifnet *);
369 void nd6_na_input (struct mbuf *, int, int);
370 void nd6_na_output (struct ifnet *, const struct in6_addr *,
371 const struct in6_addr *, u_long, int, struct sockaddr *);
372 void nd6_ns_input (struct mbuf *, int, int);
373 void nd6_ns_output (struct ifnet *, const struct in6_addr *,
374 const struct in6_addr *, struct llinfo_nd6 *, int);
375 caddr_t nd6_ifptomac (struct ifnet *);
376 void nd6_dad_start (struct ifaddr *, int *);
377 void nd6_dad_stop (struct ifaddr *);
378 void nd6_dad_duplicated (struct ifaddr *);
381 void nd6_rs_input (struct mbuf *, int, int);
382 void nd6_ra_input (struct mbuf *, int, int);
383 void prelist_del (struct nd_prefix *);
384 void defrouter_addreq (struct nd_defrouter *);
385 void defrouter_delreq (struct nd_defrouter *, int);
386 void defrouter_select (void);
387 void defrtrlist_del (struct nd_defrouter *);
388 void prelist_remove (struct nd_prefix *);
389 int prelist_update (struct nd_prefix *, struct nd_defrouter *,
391 int nd6_prelist_add (struct nd_prefix *, struct nd_defrouter *,
392 struct nd_prefix **);
393 int nd6_prefix_onlink (struct nd_prefix *);
394 int nd6_prefix_offlink (struct nd_prefix *);
395 void pfxlist_onlink_check (void);
396 struct nd_defrouter *defrouter_lookup (struct in6_addr *,
398 struct nd_prefix *nd6_prefix_lookup (struct nd_prefix *);
399 int in6_init_prefix_ltimes (struct nd_prefix *ndpr);
400 void rt6_flush (struct in6_addr *, struct ifnet *);
401 int nd6_setdefaultiface (int);
402 int in6_tmpifadd (const struct in6_ifaddr *, int);
406 #endif /* _NETINET6_ND6_H_ */