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