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