nd6.h revision 1.30 1 /* $NetBSD: nd6.h,v 1.30 2002/06/07 02:31:04 itojun Exp $ */
2 /* $KAME: nd6.h,v 1.93 2002/06/05 00:56:22 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 /* the following 3 members are for privacy extension for addrconf */
90 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
91 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
92 u_int8_t randomid[8]; /* current random ID */
93 };
94
95 #define ND6_IFF_PERFORMNUD 0x1
96
97 #ifdef _KERNEL
98 #define ND_IFINFO(ifp) \
99 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
100 #define IN6_LINKMTU(ifp) \
101 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
102 ? ND_IFINFO(ifp)->linkmtu \
103 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
104 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
105 #endif
106
107 struct in6_nbrinfo {
108 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
109 struct in6_addr addr; /* IPv6 address of the neighbor */
110 long asked; /* number of queries already sent for this addr */
111 int isrouter; /* if it acts as a router */
112 int state; /* reachability state */
113 int expire; /* lifetime for NDP state transition */
114 };
115
116 #define DRLSTSIZ 10
117 #define PRLSTSIZ 10
118 struct in6_drlist {
119 char ifname[IFNAMSIZ];
120 struct {
121 struct in6_addr rtaddr;
122 u_char flags;
123 u_short rtlifetime;
124 u_long expire;
125 u_short if_index;
126 } defrouter[DRLSTSIZ];
127 };
128
129 struct in6_prlist {
130 char ifname[IFNAMSIZ];
131 struct {
132 struct in6_addr prefix;
133 struct prf_ra raflags;
134 u_char prefixlen;
135 u_char origin;
136 u_long vltime;
137 u_long pltime;
138 u_long expire;
139 u_short if_index;
140 u_short advrtrs; /* number of advertisement routers */
141 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
142 } prefix[PRLSTSIZ];
143 };
144
145 #ifdef _KERNEL
146 struct in6_ondireq {
147 char ifname[IFNAMSIZ];
148 struct {
149 u_int32_t linkmtu; /* LinkMTU */
150 u_int32_t maxmtu; /* Upper bound of LinkMTU */
151 u_int32_t basereachable; /* BaseReachableTime */
152 u_int32_t reachable; /* Reachable Time */
153 u_int32_t retrans; /* Retrans Timer */
154 u_int32_t flags; /* Flags */
155 int recalctm; /* BaseReacable re-calculation timer */
156 u_int8_t chlim; /* CurHopLimit */
157 u_int8_t receivedra;
158 } ndi;
159 };
160 #endif
161
162 struct in6_ndireq {
163 char ifname[IFNAMSIZ];
164 struct nd_ifinfo ndi;
165 };
166
167 struct in6_ndifreq {
168 char ifname[IFNAMSIZ];
169 u_long ifindex;
170 };
171
172
173 /* protocol constants */
174 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
175 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
176 #define MAX_RTR_SOLICITATIONS 3
177
178 #define ND6_INFINITE_LIFETIME 0xffffffff
179
180 #ifdef _KERNEL
181 /* node constants */
182 #define MAX_REACHABLE_TIME 3600000 /* msec */
183 #define REACHABLE_TIME 30000 /* msec */
184 #define RETRANS_TIMER 1000 /* msec */
185 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
186 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
187 #define ND_COMPUTE_RTIME(x) \
188 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
189 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
190
191 TAILQ_HEAD(nd_drhead, nd_defrouter);
192 struct nd_defrouter {
193 TAILQ_ENTRY(nd_defrouter) dr_entry;
194 struct in6_addr rtaddr;
195 u_char flags;
196 u_short rtlifetime;
197 u_long expire;
198 struct ifnet *ifp;
199 };
200
201 struct nd_prefix {
202 struct ifnet *ndpr_ifp;
203 LIST_ENTRY(nd_prefix) ndpr_entry;
204 struct sockaddr_in6 ndpr_prefix; /* prefix */
205 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
206 struct in6_addr ndpr_addr; /* address that is derived from the prefix */
207 u_int32_t ndpr_vltime; /* advertised valid lifetime */
208 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
209 time_t ndpr_expire; /* expiration time of the prefix */
210 time_t ndpr_preferred; /* preferred time of the prefix */
211 struct prf_ra ndpr_flags;
212 /* list of routers that advertise the prefix: */
213 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
214 u_char ndpr_plen;
215 struct ndpr_stateflags {
216 /* if this prefix can be regarded as on-link */
217 u_char onlink : 1;
218 } ndpr_stateflags;
219 };
220
221 #define ndpr_next ndpr_entry.le_next
222
223 #define ndpr_raf ndpr_flags
224 #define ndpr_raf_onlink ndpr_flags.onlink
225 #define ndpr_raf_auto ndpr_flags.autonomous
226
227 #define ndpr_statef_onlink ndpr_stateflags.onlink
228 #define ndpr_statef_addmark ndpr_stateflags.addmark
229
230 /*
231 * We keep expired prefix for certain amount of time, for validation purposes.
232 * 1800s = MaxRtrAdvInterval
233 */
234 #define NDPR_KEEP_EXPIRED (1800 * 2)
235
236 /*
237 * Message format for use in obtaining information about prefixes
238 * from inet6 sysctl function
239 */
240 struct inet6_ndpr_msghdr {
241 u_short inpm_msglen; /* to skip over non-understood messages */
242 u_char inpm_version; /* future binary compatibility */
243 u_char inpm_type; /* message type */
244 struct in6_addr inpm_prefix;
245 u_long prm_vltim;
246 u_long prm_pltime;
247 u_long prm_expire;
248 u_long prm_preferred;
249 struct in6_prflags prm_flags;
250 u_short prm_index; /* index for associated ifp */
251 u_char prm_plen; /* length of prefix in bits */
252 };
253
254 #define prm_raf_onlink prm_flags.prf_ra.onlink
255 #define prm_raf_auto prm_flags.prf_ra.autonomous
256
257 #define prm_statef_onlink prm_flags.prf_state.onlink
258
259 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
260 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
261
262 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
263 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
264
265 struct nd_pfxrouter {
266 LIST_ENTRY(nd_pfxrouter) pfr_entry;
267 #define pfr_next pfr_entry.le_next
268 struct nd_defrouter *router;
269 };
270
271 LIST_HEAD(nd_prhead, nd_prefix);
272
273 /* nd6.c */
274 extern int nd6_prune;
275 extern int nd6_delay;
276 extern int nd6_umaxtries;
277 extern int nd6_mmaxtries;
278 extern int nd6_useloopback;
279 extern int nd6_maxnudhint;
280 extern int nd6_gctimer;
281 extern struct llinfo_nd6 llinfo_nd6;
282 extern struct nd_drhead nd_defrouter;
283 extern struct nd_prhead nd_prefix;
284 extern int nd6_debug;
285
286 #define nd6log(x) do { if (nd6_debug) log x; } while (0)
287
288 extern struct callout nd6_timer_ch;
289
290 /* nd6_rtr.c */
291 extern int nd6_defifindex;
292
293 union nd_opts {
294 struct nd_opt_hdr *nd_opt_array[8];
295 struct {
296 struct nd_opt_hdr *zero;
297 struct nd_opt_hdr *src_lladdr;
298 struct nd_opt_hdr *tgt_lladdr;
299 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
300 struct nd_opt_rd_hdr *rh;
301 struct nd_opt_mtu *mtu;
302 struct nd_opt_hdr *search; /* multiple opts */
303 struct nd_opt_hdr *last; /* multiple opts */
304 int done;
305 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
306 } nd_opt_each;
307 };
308 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
309 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
310 #define nd_opts_pi nd_opt_each.pi_beg
311 #define nd_opts_pi_end nd_opt_each.pi_end
312 #define nd_opts_rh nd_opt_each.rh
313 #define nd_opts_mtu nd_opt_each.mtu
314 #define nd_opts_search nd_opt_each.search
315 #define nd_opts_last nd_opt_each.last
316 #define nd_opts_done nd_opt_each.done
317
318 /* XXX: need nd6_var.h?? */
319 /* nd6.c */
320 void nd6_init __P((void));
321 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
322 void nd6_ifdetach __P((struct nd_ifinfo *));
323 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
324 void nd6_option_init __P((void *, int, union nd_opts *));
325 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
326 int nd6_options __P((union nd_opts *));
327 struct rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
328 void nd6_setmtu __P((struct ifnet *));
329 void nd6_timer __P((void *));
330 void nd6_purge __P((struct ifnet *));
331 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
332 int nd6_resolve __P((struct ifnet *, struct rtentry *,
333 struct mbuf *, struct sockaddr *, u_char *));
334 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
335 void nd6_p2p_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
336 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
337 struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
338 char *, int, int, int));
339 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
340 struct sockaddr_in6 *, struct rtentry *));
341 int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
342 struct sockaddr *, u_char *));
343 int nd6_need_cache __P((struct ifnet *));
344
345 /* nd6_nbr.c */
346 void nd6_na_input __P((struct mbuf *, int, int));
347 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
348 const struct in6_addr *, u_long, int, struct sockaddr *));
349 void nd6_ns_input __P((struct mbuf *, int, int));
350 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
351 const struct in6_addr *, struct llinfo_nd6 *, int));
352 caddr_t nd6_ifptomac __P((struct ifnet *));
353 void nd6_dad_start __P((struct ifaddr *, int *));
354 void nd6_dad_stop __P((struct ifaddr *));
355 void nd6_dad_duplicated __P((struct ifaddr *));
356
357 /* nd6_rtr.c */
358 void nd6_rs_input __P((struct mbuf *, int, int));
359 void nd6_ra_input __P((struct mbuf *, int, int));
360 void prelist_del __P((struct nd_prefix *));
361 void defrouter_addreq __P((struct nd_defrouter *));
362 void defrouter_delreq __P((struct nd_defrouter *, int));
363 void defrouter_select __P((void));
364 void defrtrlist_del __P((struct nd_defrouter *));
365 void prelist_remove __P((struct nd_prefix *));
366 int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
367 struct mbuf *));
368 void pfxlist_onlink_check __P((void));
369 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *,
370 struct ifnet *));
371 int in6_ifdel __P((struct ifnet *, struct in6_addr *));
372 int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr));
373 void rt6_flush __P((struct in6_addr *, struct ifnet *));
374 int nd6_setdefaultiface __P((int));
375
376 #endif /* _KERNEL */
377
378 #endif /* _NETINET6_ND6_H_ */
379