nd6.h revision 1.26 1 /* $NetBSD: nd6.h,v 1.26 2002/05/29 07:53:42 itojun Exp $ */
2 /* $KAME: nd6.h,v 1.52 2001/02/19 04:40:37 itojun Exp $ */
3
4 /*
5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the project nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
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 llinfo_nd6 {
45 struct llinfo_nd6 *ln_next;
46 struct llinfo_nd6 *ln_prev;
47 struct rtentry *ln_rt;
48 struct mbuf *ln_hold; /* last packet until resolved/timeout */
49 long ln_asked; /* number of queries already sent for this addr */
50 u_long ln_expire; /* lifetime for NDP state transition */
51 short ln_state; /* reachability state */
52 short ln_router; /* 2^0: ND6 router bit */
53 int ln_byhint; /* # of times we made it reachable by UL hint */
54 };
55
56 #define ND6_LLINFO_NOSTATE -2
57 /*
58 * We don't need the WAITDELETE state any more, but we keep the definition
59 * in a comment line instead of removing it. This is necessary to avoid
60 * unintentionally reusing the value for another purpose, which might
61 * affect backward compatibility with old applications.
62 * (20000711 jinmei (at) kame.net)
63 */
64 /* #define ND6_LLINFO_WAITDELETE -1 */
65 #define ND6_LLINFO_INCOMPLETE 0
66 #define ND6_LLINFO_REACHABLE 1
67 #define ND6_LLINFO_STALE 2
68 #define ND6_LLINFO_DELAY 3
69 #define ND6_LLINFO_PROBE 4
70
71 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
72
73 /*
74 * Since the granularity of our retransmission timer is seconds, we should
75 * ensure that a positive timer value will be mapped to at least one second.
76 */
77 #define ND6_RETRANS_SEC(r) (((r) + 999) / 1000)
78
79 struct nd_ifinfo {
80 u_int32_t linkmtu; /* LinkMTU */
81 u_int32_t maxmtu; /* Upper bound of LinkMTU */
82 u_int32_t basereachable; /* BaseReachableTime */
83 u_int32_t reachable; /* Reachable Time */
84 u_int32_t retrans; /* Retrans Timer */
85 u_int32_t flags; /* Flags */
86 int recalctm; /* BaseReacable re-calculation timer */
87 u_int8_t chlim; /* CurHopLimit */
88 u_int8_t initialized; /* Flag to see the entry is initialized */
89 #define receivedra initialized /* obsoleted */
90 /* the following 3 members are for privacy extension for addrconf */
91 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
92 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
93 u_int8_t randomid[8]; /* current random ID */
94 };
95
96 #define ND6_IFF_PERFORMNUD 0x1
97
98 #ifdef _KERNEL
99 #define ND_IFINFO(ifp) \
100 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
101 #define IN6_LINKMTU(ifp) \
102 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
103 ? ND_IFINFO(ifp)->linkmtu : (ifp)->if_mtu)
104 #endif
105
106 struct in6_nbrinfo {
107 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
108 struct in6_addr addr; /* IPv6 address of the neighbor */
109 long asked; /* number of queries already sent for this addr */
110 int isrouter; /* if it acts as a router */
111 int state; /* reachability state */
112 int expire; /* lifetime for NDP state transition */
113 };
114
115 #define DRLSTSIZ 10
116 #define PRLSTSIZ 10
117 struct in6_drlist {
118 char ifname[IFNAMSIZ];
119 struct {
120 struct in6_addr rtaddr;
121 u_char flags;
122 u_short rtlifetime;
123 u_long expire;
124 u_short if_index;
125 } defrouter[DRLSTSIZ];
126 };
127
128 struct in6_prlist {
129 char ifname[IFNAMSIZ];
130 struct {
131 struct in6_addr prefix;
132 struct prf_ra raflags;
133 u_char prefixlen;
134 u_char origin;
135 u_long vltime;
136 u_long pltime;
137 u_long expire;
138 u_short if_index;
139 u_short advrtrs; /* number of advertisement routers */
140 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
141 } prefix[PRLSTSIZ];
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
172 /* protocol constants */
173 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
174 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
175 #define MAX_RTR_SOLICITATIONS 3
176
177 #define ND6_INFINITE_LIFETIME 0xffffffff
178
179 #ifdef _KERNEL
180 /* node constants */
181 #define MAX_REACHABLE_TIME 3600000 /* msec */
182 #define REACHABLE_TIME 30000 /* msec */
183 #define RETRANS_TIMER 1000 /* msec */
184 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
185 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
186 #define ND_COMPUTE_RTIME(x) \
187 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
188 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
189
190 TAILQ_HEAD(nd_drhead, nd_defrouter);
191 struct nd_defrouter {
192 TAILQ_ENTRY(nd_defrouter) dr_entry;
193 struct in6_addr rtaddr;
194 u_char flags;
195 u_short rtlifetime;
196 u_long expire;
197 struct ifnet *ifp;
198 };
199
200 struct nd_prefix {
201 struct ifnet *ndpr_ifp;
202 LIST_ENTRY(nd_prefix) ndpr_entry;
203 struct sockaddr_in6 ndpr_prefix; /* prefix */
204 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
205 struct in6_addr ndpr_addr; /* address that is derived from the prefix */
206 u_int32_t ndpr_vltime; /* advertised valid lifetime */
207 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
208 time_t ndpr_expire; /* expiration time of the prefix */
209 time_t ndpr_preferred; /* preferred time of the prefix */
210 struct prf_ra ndpr_flags;
211 /* list of routers that advertise the prefix: */
212 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
213 u_char ndpr_plen;
214 struct ndpr_stateflags {
215 /* if this prefix can be regarded as on-link */
216 u_char onlink : 1;
217 } ndpr_stateflags;
218 };
219
220 #define ndpr_next ndpr_entry.le_next
221
222 #define ndpr_raf ndpr_flags
223 #define ndpr_raf_onlink ndpr_flags.onlink
224 #define ndpr_raf_auto ndpr_flags.autonomous
225
226 #define ndpr_statef_onlink ndpr_stateflags.onlink
227 #define ndpr_statef_addmark ndpr_stateflags.addmark
228
229 /*
230 * We keep expired prefix for certain amount of time, for validation purposes.
231 * 1800s = MaxRtrAdvInterval
232 */
233 #define NDPR_KEEP_EXPIRED (1800 * 2)
234
235 /*
236 * Message format for use in obtaining information about prefixes
237 * from inet6 sysctl function
238 */
239 struct inet6_ndpr_msghdr {
240 u_short inpm_msglen; /* to skip over non-understood messages */
241 u_char inpm_version; /* future binary compatibility */
242 u_char inpm_type; /* message type */
243 struct in6_addr inpm_prefix;
244 u_long prm_vltim;
245 u_long prm_pltime;
246 u_long prm_expire;
247 u_long prm_preferred;
248 struct in6_prflags prm_flags;
249 u_short prm_index; /* index for associated ifp */
250 u_char prm_plen; /* length of prefix in bits */
251 };
252
253 #define prm_raf_onlink prm_flags.prf_ra.onlink
254 #define prm_raf_auto prm_flags.prf_ra.autonomous
255
256 #define prm_statef_onlink prm_flags.prf_state.onlink
257
258 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
259 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
260
261 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
262 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
263
264 struct nd_pfxrouter {
265 LIST_ENTRY(nd_pfxrouter) pfr_entry;
266 #define pfr_next pfr_entry.le_next
267 struct nd_defrouter *router;
268 };
269
270 LIST_HEAD(nd_prhead, nd_prefix);
271
272 /* nd6.c */
273 extern int nd6_prune;
274 extern int nd6_delay;
275 extern int nd6_umaxtries;
276 extern int nd6_mmaxtries;
277 extern int nd6_useloopback;
278 extern int nd6_maxnudhint;
279 extern int nd6_gctimer;
280 extern struct llinfo_nd6 llinfo_nd6;
281 extern struct nd_drhead nd_defrouter;
282 extern struct nd_prhead nd_prefix;
283 extern int nd6_debug;
284
285 #define nd6log(x) do { if (nd6_debug) log x; } while (0)
286
287 extern struct callout nd6_timer_ch;
288
289 /* nd6_rtr.c */
290 extern int nd6_defifindex;
291
292 union nd_opts {
293 struct nd_opt_hdr *nd_opt_array[8];
294 struct {
295 struct nd_opt_hdr *zero;
296 struct nd_opt_hdr *src_lladdr;
297 struct nd_opt_hdr *tgt_lladdr;
298 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
299 struct nd_opt_rd_hdr *rh;
300 struct nd_opt_mtu *mtu;
301 struct nd_opt_hdr *search; /* multiple opts */
302 struct nd_opt_hdr *last; /* multiple opts */
303 int done;
304 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
305 } nd_opt_each;
306 };
307 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
308 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
309 #define nd_opts_pi nd_opt_each.pi_beg
310 #define nd_opts_pi_end nd_opt_each.pi_end
311 #define nd_opts_rh nd_opt_each.rh
312 #define nd_opts_mtu nd_opt_each.mtu
313 #define nd_opts_search nd_opt_each.search
314 #define nd_opts_last nd_opt_each.last
315 #define nd_opts_done nd_opt_each.done
316
317 /* XXX: need nd6_var.h?? */
318 /* nd6.c */
319 void nd6_init __P((void));
320 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
321 void nd6_ifdetach __P((struct nd_ifinfo *));
322 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
323 void nd6_option_init __P((void *, int, union nd_opts *));
324 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
325 int nd6_options __P((union nd_opts *));
326 struct rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
327 void nd6_setmtu __P((struct ifnet *, struct nd_ifinfo *));
328 void nd6_timer __P((void *));
329 void nd6_purge __P((struct ifnet *));
330 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
331 int nd6_resolve __P((struct ifnet *, struct rtentry *,
332 struct mbuf *, struct sockaddr *, u_char *));
333 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
334 void nd6_p2p_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
335 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
336 struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
337 char *, int, int, int));
338 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
339 struct sockaddr_in6 *, struct rtentry *));
340 int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
341 struct sockaddr *, u_char *));
342 int nd6_need_cache __P((struct ifnet *));
343
344 /* nd6_nbr.c */
345 void nd6_na_input __P((struct mbuf *, int, int));
346 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
347 const struct in6_addr *, u_long, int, struct sockaddr *));
348 void nd6_ns_input __P((struct mbuf *, int, int));
349 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
350 const struct in6_addr *, struct llinfo_nd6 *, int));
351 caddr_t nd6_ifptomac __P((struct ifnet *));
352 void nd6_dad_start __P((struct ifaddr *, int *));
353 void nd6_dad_stop __P((struct ifaddr *));
354 void nd6_dad_duplicated __P((struct ifaddr *));
355
356 /* nd6_rtr.c */
357 void nd6_rs_input __P((struct mbuf *, int, int));
358 void nd6_ra_input __P((struct mbuf *, int, int));
359 void prelist_del __P((struct nd_prefix *));
360 void defrouter_addreq __P((struct nd_defrouter *));
361 void defrouter_delreq __P((struct nd_defrouter *, int));
362 void defrouter_select __P((void));
363 void defrtrlist_del __P((struct nd_defrouter *));
364 void prelist_remove __P((struct nd_prefix *));
365 int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
366 struct mbuf *));
367 void pfxlist_onlink_check __P((void));
368 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *,
369 struct ifnet *));
370 int in6_ifdel __P((struct ifnet *, struct in6_addr *));
371 int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr));
372 void rt6_flush __P((struct in6_addr *, struct ifnet *));
373 int nd6_setdefaultiface __P((int));
374
375 #endif /* _KERNEL */
376
377 #endif /* _NETINET6_ND6_H_ */
378