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