1 /* $OpenBSD: nd6.h,v 1.26 2008/06/11 06:30:36 mcbride 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/timeout.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 long ln_ntick; 56 struct timeout ln_timer_ch; 57 }; 58 59 #define ND6_LLINFO_PURGE -3 60 #define ND6_LLINFO_NOSTATE -2 61 /* 62 * We don't need the WAITDELETE state any more, but we keep the definition 63 * in a comment line instead of removing it. This is necessary to avoid 64 * unintentionally reusing the value for another purpose, which might 65 * affect backward compatibility with old applications. 66 * (20000711 jinmei@kame.net) 67 */ 68 /* #define ND6_LLINFO_WAITDELETE -1 */ 69 #define ND6_LLINFO_INCOMPLETE 0 70 #define ND6_LLINFO_REACHABLE 1 71 #define ND6_LLINFO_STALE 2 72 #define ND6_LLINFO_DELAY 3 73 #define ND6_LLINFO_PROBE 4 74 75 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 76 #define ND6_LLINFO_PERMANENT(n) ((n)->ln_expire == 0) 77 78 struct nd_ifinfo { 79 u_int32_t linkmtu; /* LinkMTU */ 80 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 81 u_int32_t basereachable; /* BaseReachableTime */ 82 u_int32_t reachable; /* Reachable Time */ 83 u_int32_t retrans; /* Retrans Timer */ 84 u_int32_t flags; /* Flags */ 85 int recalctm; /* BaseReacable re-calculation timer */ 86 u_int8_t chlim; /* CurHopLimit */ 87 u_int8_t initialized; /* Flag to see the entry is initialized */ 88 /* the following 3 members are for privacy extension for addrconf */ 89 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 90 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 91 u_int8_t randomid[8]; /* current random ID */ 92 }; 93 94 #define ND6_IFF_PERFORMNUD 0x1 95 #define ND6_IFF_ACCEPT_RTADV 0x2 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_defrouter { 130 struct sockaddr_in6 rtaddr; 131 u_char flags; 132 u_short rtlifetime; 133 u_long expire; 134 u_short if_index; 135 }; 136 137 #ifdef _KERNEL 138 struct in6_oprlist { 139 char ifname[IFNAMSIZ]; 140 struct { 141 struct in6_addr prefix; 142 struct prf_ra raflags; 143 u_char prefixlen; 144 u_char origin; 145 u_long vltime; 146 u_long pltime; 147 u_long expire; 148 u_short if_index; 149 u_short advrtrs; /* number of advertisement routers */ 150 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 151 } prefix[PRLSTSIZ]; 152 }; 153 #endif 154 155 struct in6_prlist { 156 char ifname[IFNAMSIZ]; 157 struct { 158 struct in6_addr prefix; 159 struct prf_ra raflags; 160 u_char prefixlen; 161 u_char origin; 162 u_int32_t vltime; 163 u_int32_t pltime; 164 time_t expire; 165 u_short if_index; 166 u_short advrtrs; /* number of advertisement routers */ 167 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 168 } prefix[PRLSTSIZ]; 169 }; 170 171 struct in6_prefix { 172 struct sockaddr_in6 prefix; 173 struct prf_ra raflags; 174 u_char prefixlen; 175 u_char origin; 176 u_int32_t vltime; 177 u_int32_t pltime; 178 time_t expire; 179 u_int32_t flags; 180 int refcnt; 181 u_short if_index; 182 u_short advrtrs; /* number of advertisement routers */ 183 /* struct sockaddr_in6 advrtr[] */ 184 }; 185 186 #ifdef _KERNEL 187 struct in6_ondireq { 188 char ifname[IFNAMSIZ]; 189 struct { 190 u_int32_t linkmtu; /* LinkMTU */ 191 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 192 u_int32_t basereachable; /* BaseReachableTime */ 193 u_int32_t reachable; /* Reachable Time */ 194 u_int32_t retrans; /* Retrans Timer */ 195 u_int32_t flags; /* Flags */ 196 int recalctm; /* BaseReacable re-calculation timer */ 197 u_int8_t chlim; /* CurHopLimit */ 198 u_int8_t receivedra; 199 } ndi; 200 }; 201 #endif 202 203 struct in6_ndireq { 204 char ifname[IFNAMSIZ]; 205 struct nd_ifinfo ndi; 206 }; 207 208 struct in6_ndifreq { 209 char ifname[IFNAMSIZ]; 210 u_long ifindex; 211 }; 212 213 /* Prefix status */ 214 #define NDPRF_ONLINK 0x1 215 #define NDPRF_DETACHED 0x2 216 #define NDPRF_HOME 0x4 217 218 /* protocol constants */ 219 #define MAX_RTR_SOLICITATION_DELAY 1 /*1sec*/ 220 #define RTR_SOLICITATION_INTERVAL 4 /*4sec*/ 221 #define MAX_RTR_SOLICITATIONS 3 222 223 #define ND6_INFINITE_LIFETIME 0xffffffff 224 225 #ifdef _KERNEL 226 /* node constants */ 227 #define MAX_REACHABLE_TIME 3600000 /* msec */ 228 #define REACHABLE_TIME 30000 /* msec */ 229 #define RETRANS_TIMER 1000 /* msec */ 230 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 231 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 232 #define ND_COMPUTE_RTIME(x) \ 233 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \ 234 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 235 236 TAILQ_HEAD(nd_drhead, nd_defrouter); 237 struct nd_defrouter { 238 TAILQ_ENTRY(nd_defrouter) dr_entry; 239 struct in6_addr rtaddr; 240 u_char flags; /* flags on RA message */ 241 u_short rtlifetime; 242 u_long expire; 243 struct ifnet *ifp; 244 int installed; /* is installed into kernel routing table */ 245 }; 246 247 struct nd_prefix { 248 struct ifnet *ndpr_ifp; 249 LIST_ENTRY(nd_prefix) ndpr_entry; 250 struct sockaddr_in6 ndpr_prefix; /* prefix */ 251 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 252 253 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 254 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 255 256 time_t ndpr_expire; /* expiration time of the prefix */ 257 time_t ndpr_preferred; /* preferred time of the prefix */ 258 time_t ndpr_lastupdate; /* reception time of last advertisement */ 259 260 struct prf_ra ndpr_flags; 261 u_int32_t ndpr_stateflags; /* actual state flags */ 262 /* list of routers that advertise the prefix: */ 263 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 264 u_char ndpr_plen; 265 int ndpr_refcnt; /* reference couter from addresses */ 266 }; 267 268 #define ndpr_next ndpr_entry.le_next 269 270 #define ndpr_raf ndpr_flags 271 #define ndpr_raf_onlink ndpr_flags.onlink 272 #define ndpr_raf_auto ndpr_flags.autonomous 273 #define ndpr_raf_router ndpr_flags.router 274 275 /* 276 * Message format for use in obtaining information about prefixes 277 * from inet6 sysctl function 278 */ 279 struct inet6_ndpr_msghdr { 280 u_short inpm_msglen; /* to skip over non-understood messages */ 281 u_char inpm_version; /* future binary compatibility */ 282 u_char inpm_type; /* message type */ 283 struct in6_addr inpm_prefix; 284 u_long prm_vltim; 285 u_long prm_pltime; 286 u_long prm_expire; 287 u_long prm_preferred; 288 struct in6_prflags prm_flags; 289 u_short prm_index; /* index for associated ifp */ 290 u_char prm_plen; /* length of prefix in bits */ 291 }; 292 293 #define prm_raf_onlink prm_flags.prf_ra.onlink 294 #define prm_raf_auto prm_flags.prf_ra.autonomous 295 296 #define prm_statef_onlink prm_flags.prf_state.onlink 297 298 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 299 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 300 301 struct nd_pfxrouter { 302 LIST_ENTRY(nd_pfxrouter) pfr_entry; 303 #define pfr_next pfr_entry.le_next 304 struct nd_defrouter *router; 305 }; 306 307 LIST_HEAD(nd_prhead, nd_prefix); 308 309 /* nd6.c */ 310 extern int nd6_prune; 311 extern int nd6_delay; 312 extern int nd6_umaxtries; 313 extern int nd6_mmaxtries; 314 extern int nd6_useloopback; 315 extern int nd6_maxnudhint; 316 extern int nd6_gctimer; 317 extern struct llinfo_nd6 llinfo_nd6; 318 extern struct nd_drhead nd_defrouter; 319 extern struct nd_prhead nd_prefix; 320 extern int nd6_debug; 321 322 #define nd6log(x) do { if (nd6_debug) log x; } while (0) 323 324 extern struct timeout nd6_timer_ch; 325 326 /* nd6_rtr.c */ 327 extern int nd6_defifindex; 328 329 union nd_opts { 330 struct nd_opt_hdr *nd_opt_array[9]; 331 struct { 332 struct nd_opt_hdr *zero; 333 struct nd_opt_hdr *src_lladdr; 334 struct nd_opt_hdr *tgt_lladdr; 335 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 336 struct nd_opt_rd_hdr *rh; 337 struct nd_opt_mtu *mtu; 338 struct nd_opt_hdr *search; /* multiple opts */ 339 struct nd_opt_hdr *last; /* multiple opts */ 340 int done; 341 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 342 } nd_opt_each; 343 }; 344 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 345 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 346 #define nd_opts_pi nd_opt_each.pi_beg 347 #define nd_opts_pi_end nd_opt_each.pi_end 348 #define nd_opts_rh nd_opt_each.rh 349 #define nd_opts_mtu nd_opt_each.mtu 350 #define nd_opts_search nd_opt_each.search 351 #define nd_opts_last nd_opt_each.last 352 #define nd_opts_done nd_opt_each.done 353 354 /* XXX: need nd6_var.h?? */ 355 /* nd6.c */ 356 void nd6_init(void); 357 struct nd_ifinfo *nd6_ifattach(struct ifnet *); 358 void nd6_ifdetach(struct nd_ifinfo *); 359 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *); 360 void nd6_option_init(void *, int, union nd_opts *); 361 struct nd_opt_hdr *nd6_option(union nd_opts *); 362 int nd6_options(union nd_opts *); 363 struct rtentry *nd6_lookup(struct in6_addr *, int, struct ifnet *); 364 void nd6_setmtu(struct ifnet *); 365 void nd6_llinfo_settimer(struct llinfo_nd6 *, long); 366 void nd6_timer(void *); 367 void nd6_purge(struct ifnet *); 368 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int); 369 int nd6_resolve(struct ifnet *, struct rtentry *, 370 struct mbuf *, struct sockaddr *, u_char *); 371 void nd6_rtrequest(int, struct rtentry *, struct rt_addrinfo *); 372 int nd6_ioctl(u_long, caddr_t, struct ifnet *); 373 struct rtentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 374 char *, int, int, int); 375 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *, 376 struct sockaddr_in6 *, struct rtentry *); 377 int nd6_storelladdr(struct ifnet *, struct rtentry *, struct mbuf *, 378 struct sockaddr *, u_char *); 379 int nd6_sysctl(int, void *, size_t *, void *, size_t); 380 int nd6_need_cache(struct ifnet *); 381 382 /* nd6_nbr.c */ 383 void nd6_na_input(struct mbuf *, int, int); 384 void nd6_na_output(struct ifnet *, struct in6_addr *, 385 struct in6_addr *, u_long, int, struct sockaddr *); 386 void nd6_ns_input(struct mbuf *, int, int); 387 void nd6_ns_output(struct ifnet *, struct in6_addr *, 388 struct in6_addr *, struct llinfo_nd6 *, int); 389 caddr_t nd6_ifptomac(struct ifnet *); 390 void nd6_dad_start(struct ifaddr *, int *); 391 void nd6_dad_stop(struct ifaddr *); 392 void nd6_dad_duplicated(struct ifaddr *); 393 394 /* nd6_rtr.c */ 395 void nd6_rs_input(struct mbuf *, int, int); 396 void nd6_ra_input(struct mbuf *, int, int); 397 void prelist_del(struct nd_prefix *); 398 void defrouter_addreq(struct nd_defrouter *); 399 void defrouter_reset(void); 400 void defrouter_select(void); 401 void defrtrlist_del(struct nd_defrouter *); 402 void prelist_remove(struct nd_prefix *); 403 int prelist_update(struct nd_prefix *, struct nd_defrouter *, struct mbuf *); 404 int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *, 405 struct nd_prefix **); 406 int nd6_prefix_onlink(struct nd_prefix *); 407 int nd6_prefix_offlink(struct nd_prefix *); 408 void pfxlist_onlink_check(void); 409 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *); 410 struct nd_prefix *nd6_prefix_lookup(struct nd_prefix *); 411 int in6_ifdel(struct ifnet *, struct in6_addr *); 412 int in6_init_prefix_ltimes(struct nd_prefix *ndpr); 413 void rt6_flush(struct in6_addr *, struct ifnet *); 414 int nd6_setdefaultiface(int); 415 416 #endif /* _KERNEL */ 417 418 #endif /* _NETINET6_ND6_H_ */ 419