nd6.h revision 1.13 1 /* $NetBSD: nd6.h,v 1.13 2000/05/09 11:51:12 itojun Exp $ */
2 /* $KAME: nd6.h,v 1.20 2000/04/29 04:46:41 jinmei 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 };
54
55 #define ND6_LLINFO_NOSTATE -2
56 #define ND6_LLINFO_WAITDELETE -1
57 #define ND6_LLINFO_INCOMPLETE 0
58 #define ND6_LLINFO_REACHABLE 1
59 #define ND6_LLINFO_STALE 2
60 #define ND6_LLINFO_DELAY 3
61 #define ND6_LLINFO_PROBE 4
62
63 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
64
65 struct nd_ifinfo {
66 u_int32_t linkmtu; /* LinkMTU */
67 u_int32_t maxmtu; /* Upper bound of LinkMTU */
68 u_int32_t basereachable; /* BaseReachableTime */
69 u_int32_t reachable; /* Reachable Time */
70 u_int32_t retrans; /* Retrans Timer */
71 u_int32_t flags; /* Flags */
72 int recalctm; /* BaseReacable re-calculation timer */
73 u_int8_t chlim; /* CurHopLimit */
74 u_int8_t receivedra;
75 };
76
77 #define ND6_IFF_PERFORMNUD 0x1
78
79 struct in6_nbrinfo {
80 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
81 struct in6_addr addr; /* IPv6 address of the neighbor */
82 long asked; /* number of queries already sent for this addr */
83 int isrouter; /* if it acts as a router */
84 int state; /* reachability state */
85 int expire; /* lifetime for NDP state transition */
86 };
87
88 #define DRLSTSIZ 10
89 #define PRLSTSIZ 10
90 struct in6_drlist {
91 char ifname[IFNAMSIZ];
92 struct {
93 struct in6_addr rtaddr;
94 u_char flags;
95 u_short rtlifetime;
96 u_long expire;
97 u_short if_index;
98 } defrouter[DRLSTSIZ];
99 };
100
101 struct in6_prlist {
102 char ifname[IFNAMSIZ];
103 struct {
104 struct in6_addr prefix;
105 struct prf_ra raflags;
106 u_char prefixlen;
107 u_char origin;
108 u_long vltime;
109 u_long pltime;
110 u_long expire;
111 u_short if_index;
112 u_short advrtrs; /* number of advertisement routers */
113 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
114 } prefix[PRLSTSIZ];
115 };
116
117 struct in6_ndireq {
118 char ifname[IFNAMSIZ];
119 struct nd_ifinfo ndi;
120 };
121
122 struct in6_ndifreq {
123 char ifname[IFNAMSIZ];
124 u_long ifindex;
125 };
126
127
128 /* protocol constants */
129 #define MAX_RTR_SOLICITATION_DELAY 1 /*1sec*/
130 #define RTR_SOLICITATION_INTERVAL 4 /*4sec*/
131 #define MAX_RTR_SOLICITATIONS 3
132
133 #define ND6_INFINITE_LIFETIME 0xffffffff
134
135 #ifdef _KERNEL
136 /* node constants */
137 #define MAX_REACHABLE_TIME 3600000 /* msec */
138 #define REACHABLE_TIME 30000 /* msec */
139 #define RETRANS_TIMER 1000 /* msec */
140 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
141 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
142 #define ND_COMPUTE_RTIME(x) \
143 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
144 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
145
146 TAILQ_HEAD(nd_drhead, nd_defrouter);
147 struct nd_defrouter {
148 TAILQ_ENTRY(nd_defrouter) dr_entry;
149 struct in6_addr rtaddr;
150 u_char flags;
151 u_short rtlifetime;
152 u_long expire;
153 struct ifnet *ifp;
154 };
155
156 struct nd_prefix {
157 struct ifnet *ndpr_ifp;
158 LIST_ENTRY(nd_prefix) ndpr_entry;
159 struct sockaddr_in6 ndpr_prefix; /* prefix */
160 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
161 struct in6_addr ndpr_addr; /* address that is derived from the prefix */
162 u_int32_t ndpr_vltime; /* advertised valid lifetime */
163 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
164 time_t ndpr_expire; /* expiration time of the prefix */
165 time_t ndpr_preferred; /* preferred time of the prefix */
166 struct prf_ra ndpr_flags;
167 /* list of routers that advertise the prefix: */
168 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
169 u_char ndpr_plen;
170 struct ndpr_stateflags {
171 /* if this prefix can be regarded as on-link */
172 u_char onlink : 1;
173 } ndpr_stateflags;
174 };
175
176 #define ndpr_next ndpr_entry.le_next
177
178 #define ndpr_raf ndpr_flags
179 #define ndpr_raf_onlink ndpr_flags.onlink
180 #define ndpr_raf_auto ndpr_flags.autonomous
181
182 #define ndpr_statef_onlink ndpr_stateflags.onlink
183 #define ndpr_statef_addmark ndpr_stateflags.addmark
184
185 /*
186 * We keep expired prefix for certain amount of time, for validation purposes.
187 * 1800s = MaxRtrAdvInterval
188 */
189 #define NDPR_KEEP_EXPIRED (1800 * 2)
190
191 /*
192 * Message format for use in obtaining information about prefixes
193 * from inet6 sysctl function
194 */
195 struct inet6_ndpr_msghdr {
196 u_short inpm_msglen; /* to skip over non-understood messages */
197 u_char inpm_version; /* future binary compatability */
198 u_char inpm_type; /* message type */
199 struct in6_addr inpm_prefix;
200 u_long prm_vltim;
201 u_long prm_pltime;
202 u_long prm_expire;
203 u_long prm_preferred;
204 struct in6_prflags prm_flags;
205 u_short prm_index; /* index for associated ifp */
206 u_char prm_plen; /* length of prefix in bits */
207 };
208
209 #define prm_raf_onlink prm_flags.prf_ra.onlink
210 #define prm_raf_auto prm_flags.prf_ra.autonomous
211
212 #define prm_statef_onlink prm_flags.prf_state.onlink
213
214 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
215 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
216
217 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
218 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
219
220 struct nd_pfxrouter {
221 LIST_ENTRY(nd_pfxrouter) pfr_entry;
222 #define pfr_next pfr_entry.le_next
223 struct nd_defrouter *router;
224 };
225
226 LIST_HEAD(nd_prhead, nd_prefix);
227
228 /* nd6.c */
229 extern int nd6_prune;
230 extern int nd6_delay;
231 extern int nd6_umaxtries;
232 extern int nd6_mmaxtries;
233 extern int nd6_useloopback;
234 extern struct llinfo_nd6 llinfo_nd6;
235 extern struct nd_ifinfo *nd_ifinfo;
236 extern struct nd_drhead nd_defrouter;
237 extern struct nd_prhead nd_prefix;
238
239 extern struct callout nd6_timer_ch;
240
241 /* nd6_rtr.c */
242 extern int nd6_defifindex;
243
244 union nd_opts {
245 struct nd_opt_hdr *nd_opt_array[9];
246 struct {
247 struct nd_opt_hdr *zero;
248 struct nd_opt_hdr *src_lladdr;
249 struct nd_opt_hdr *tgt_lladdr;
250 struct nd_opt_prefix_info *pi_beg;/* multiple opts, start */
251 struct nd_opt_rd_hdr *rh;
252 struct nd_opt_mtu *mtu;
253 struct nd_opt_hdr *search; /* multiple opts */
254 struct nd_opt_hdr *last; /* multiple opts */
255 int done;
256 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
257 } nd_opt_each;
258 };
259 #define nd_opts_src_lladdr nd_opt_each.src_lladdr
260 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
261 #define nd_opts_pi nd_opt_each.pi_beg
262 #define nd_opts_pi_end nd_opt_each.pi_end
263 #define nd_opts_rh nd_opt_each.rh
264 #define nd_opts_mtu nd_opt_each.mtu
265 #define nd_opts_search nd_opt_each.search
266 #define nd_opts_last nd_opt_each.last
267 #define nd_opts_done nd_opt_each.done
268
269 /* XXX: need nd6_var.h?? */
270 /* nd6.c */
271 void nd6_init __P((void));
272 void nd6_ifattach __P((struct ifnet *));
273 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
274 void nd6_option_init __P((void *, int, union nd_opts *));
275 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
276 int nd6_options __P((union nd_opts *));
277 struct rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
278 void nd6_setmtu __P((struct ifnet *));
279 void nd6_timer __P((void *));
280 void nd6_purge __P((struct ifnet *));
281 void nd6_free __P((struct rtentry *));
282 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *));
283 int nd6_resolve __P((struct ifnet *, struct rtentry *,
284 struct mbuf *, struct sockaddr *, u_char *));
285 void nd6_rtrequest __P((int, struct rtentry *, struct sockaddr *));
286 void nd6_p2p_rtrequest __P((int, struct rtentry *, struct sockaddr *));
287 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
288 struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
289 char *, int, int, int));
290 /* for test */
291 int nd6_output __P((struct ifnet *, struct mbuf *, struct sockaddr_in6 *,
292 struct rtentry *));
293 int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
294 struct sockaddr *, u_char *));
295
296 /* nd6_nbr.c */
297 void nd6_na_input __P((struct mbuf *, int, int));
298 void nd6_na_output __P((struct ifnet *, struct in6_addr *,
299 struct in6_addr *, u_long, int, struct sockaddr *));
300 void nd6_ns_input __P((struct mbuf *, int, int));
301 void nd6_ns_output __P((struct ifnet *, struct in6_addr *,
302 struct in6_addr *, struct llinfo_nd6 *, int));
303 caddr_t nd6_ifptomac __P((struct ifnet *));
304 void nd6_dad_start __P((struct ifaddr *, int *));
305 void nd6_dad_duplicated __P((struct ifaddr *));
306
307 /* nd6_rtr.c */
308 void nd6_rs_input __P((struct mbuf *, int, int));
309 void nd6_ra_input __P((struct mbuf *, int, int));
310 void prelist_del __P((struct nd_prefix *));
311 void defrouter_addreq __P((struct nd_defrouter *));
312 void defrouter_delreq __P((struct nd_defrouter *, int));
313 void defrouter_select __P((void));
314 void defrtrlist_del __P((struct nd_defrouter *));
315 void prelist_remove __P((struct nd_prefix *));
316 int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
317 struct mbuf *));
318 void pfxlist_onlink_check __P((void));
319 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *,
320 struct ifnet *));
321 int in6_ifdel __P((struct ifnet *, struct in6_addr *));
322 int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr));
323 void rt6_flush __P((struct in6_addr *, struct ifnet *));
324 int nd6_setdefaultiface __P((int));
325
326 #endif /* _KERNEL */
327
328 #endif /* _NETINET6_ND6_H_ */
329