1 /* $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.5 2002/04/28 05:40:27 suz Exp $ */ 2 /* $DragonFly: src/sys/netinet6/nd6.h,v 1.6 2005/02/01 16:09:37 hrs Exp $ */ 3 /* $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ */ 4 5 /* 6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. Neither the name of the project nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34 #ifndef _NETINET6_ND6_H_ 35 #define _NETINET6_ND6_H_ 36 37 /* see net/route.h, or net/if_inarp.h */ 38 #ifndef RTF_ANNOUNCE 39 #define RTF_ANNOUNCE RTF_PROTO2 40 #endif 41 42 #include <sys/queue.h> 43 #include <sys/callout.h> 44 45 struct llinfo_nd6 { 46 struct llinfo_nd6 *ln_next; 47 struct llinfo_nd6 *ln_prev; 48 struct rtentry *ln_rt; 49 struct mbuf *ln_hold; /* last packet until resolved/timeout */ 50 long ln_asked; /* number of queries already sent for this addr */ 51 u_long ln_expire; /* lifetime for NDP state transition */ 52 short ln_state; /* reachability state */ 53 short ln_router; /* 2^0: ND6 router bit */ 54 int ln_byhint; /* # of times we made it reachable by UL hint */ 55 }; 56 57 #define ND6_LLINFO_NOSTATE -2 58 /* 59 * We don't need the WAITDELETE state any more, but we keep the definition 60 * in a comment line instead of removing it. This is necessary to avoid 61 * unintentionally reusing the value for another purpose, which might 62 * affect backward compatibility with old applications. 63 * (20000711 jinmei@kame.net) 64 */ 65 /* #define ND6_LLINFO_WAITDELETE -1 */ 66 #define ND6_LLINFO_INCOMPLETE 0 67 #define ND6_LLINFO_REACHABLE 1 68 #define ND6_LLINFO_STALE 2 69 #define ND6_LLINFO_DELAY 3 70 #define ND6_LLINFO_PROBE 4 71 72 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 73 74 struct nd_ifinfo { 75 u_int32_t linkmtu; /* LinkMTU */ 76 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 77 u_int32_t basereachable; /* BaseReachableTime */ 78 u_int32_t reachable; /* Reachable Time */ 79 u_int32_t retrans; /* Retrans Timer */ 80 u_int32_t flags; /* Flags */ 81 int recalctm; /* BaseReacable re-calculation timer */ 82 u_int8_t chlim; /* CurHopLimit */ 83 u_int8_t receivedra; 84 u_int8_t initialized; /* Flag to see the entry is initialized */ 85 /* the following 3 members are for privacy extension for addrconf */ 86 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 87 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 88 u_int8_t randomid[8]; /* current random ID */ 89 }; 90 91 #define ND6_IFF_PERFORMNUD 0x1 92 #define ND6_IFF_ACCEPT_RTADV 0x2 93 94 #ifdef _KERNEL 95 #define ND_IFINFO(ifp) \ 96 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo) 97 #define IN6_LINKMTU(ifp) \ 98 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \ 99 ? ND_IFINFO(ifp)->linkmtu \ 100 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \ 101 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu)) 102 #endif 103 104 struct in6_nbrinfo { 105 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 106 struct in6_addr addr; /* IPv6 address of the neighbor */ 107 long asked; /* number of queries already sent for this addr */ 108 int isrouter; /* if it acts as a router */ 109 int state; /* reachability state */ 110 int expire; /* lifetime for NDP state transition */ 111 }; 112 113 #define DRLSTSIZ 10 114 #define PRLSTSIZ 10 115 struct in6_drlist { 116 char ifname[IFNAMSIZ]; 117 struct { 118 struct in6_addr rtaddr; 119 u_char flags; 120 u_short rtlifetime; 121 u_long expire; 122 u_short if_index; 123 } defrouter[DRLSTSIZ]; 124 }; 125 126 struct in6_defrouter { 127 struct sockaddr_in6 rtaddr; 128 u_char flags; 129 u_short rtlifetime; 130 u_long expire; 131 u_short if_index; 132 }; 133 134 struct in6_prlist { 135 char ifname[IFNAMSIZ]; 136 struct { 137 struct in6_addr prefix; 138 struct prf_ra raflags; 139 u_char prefixlen; 140 u_char origin; 141 u_int32_t vltime; 142 u_int32_t pltime; 143 time_t expire; 144 u_short if_index; 145 u_short advrtrs; /* number of advertisement routers */ 146 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 147 } prefix[PRLSTSIZ]; 148 }; 149 150 struct in6_prefix { 151 struct sockaddr_in6 prefix; 152 struct prf_ra raflags; 153 u_char prefixlen; 154 u_char origin; 155 u_long vltime; 156 u_long pltime; 157 u_long expire; 158 u_int32_t flags; 159 int refcnt; 160 u_short if_index; 161 u_short advrtrs; /* number of advertisement routers */ 162 /* struct sockaddr_in6 advrtr[] */ 163 }; 164 165 #ifdef _KERNEL 166 struct in6_ondireq { 167 char ifname[IFNAMSIZ]; 168 struct { 169 u_int32_t linkmtu; /* LinkMTU */ 170 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 171 u_int32_t basereachable; /* BaseReachableTime */ 172 u_int32_t reachable; /* Reachable Time */ 173 u_int32_t retrans; /* Retrans Timer */ 174 u_int32_t flags; /* Flags */ 175 int recalctm; /* BaseReacable re-calculation timer */ 176 u_int8_t chlim; /* CurHopLimit */ 177 u_int8_t receivedra; 178 } ndi; 179 }; 180 #endif 181 182 struct in6_ndireq { 183 char ifname[IFNAMSIZ]; 184 struct nd_ifinfo ndi; 185 }; 186 187 struct in6_ndifreq { 188 char ifname[IFNAMSIZ]; 189 u_long ifindex; 190 }; 191 192 /* Prefix status */ 193 #define NDPRF_ONLINK 0x1 194 #define NDPRF_DETACHED 0x2 195 196 /* protocol constants */ 197 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 198 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 199 #define MAX_RTR_SOLICITATIONS 3 200 201 #define ND6_INFINITE_LIFETIME 0xffffffff 202 203 #ifdef _KERNEL 204 /* node constants */ 205 #define MAX_REACHABLE_TIME 3600000 /* msec */ 206 #define REACHABLE_TIME 30000 /* msec */ 207 #define RETRANS_TIMER 1000 /* msec */ 208 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 209 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 210 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */ 211 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 212 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 213 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */ 214 #define ND_COMPUTE_RTIME(x) \ 215 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \ 216 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 217 218 TAILQ_HEAD(nd_drhead, nd_defrouter); 219 struct nd_defrouter { 220 TAILQ_ENTRY(nd_defrouter) dr_entry; 221 struct in6_addr rtaddr; 222 u_char flags; /* flags on RA message */ 223 u_short rtlifetime; 224 u_long expire; 225 u_long advint; /* Mobile IPv6 addition (milliseconds) */ 226 u_long advint_expire; /* Mobile IPv6 addition */ 227 int advints_lost; /* Mobile IPv6 addition */ 228 struct ifnet *ifp; 229 }; 230 231 struct nd_prefix { 232 struct ifnet *ndpr_ifp; 233 LIST_ENTRY(nd_prefix) ndpr_entry; 234 struct sockaddr_in6 ndpr_prefix; /* prefix */ 235 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 236 struct in6_addr ndpr_addr; /* address that is derived from the prefix */ 237 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 238 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 239 time_t ndpr_expire; /* expiration time of the prefix */ 240 time_t ndpr_preferred; /* preferred time of the prefix */ 241 struct prf_ra ndpr_flags; 242 u_int32_t ndpr_stateflags; /* actual state flags */ 243 /* list of routers that advertise the prefix: */ 244 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 245 u_char ndpr_plen; 246 int ndpr_refcnt; /* reference couter from addresses */ 247 }; 248 249 #define ndpr_next ndpr_entry.le_next 250 251 #define ndpr_raf ndpr_flags 252 #define ndpr_raf_onlink ndpr_flags.onlink 253 #define ndpr_raf_auto ndpr_flags.autonomous 254 255 /* 256 * We keep expired prefix for certain amount of time, for validation purposes. 257 * 1800s = MaxRtrAdvInterval 258 */ 259 #define NDPR_KEEP_EXPIRED (1800 * 2) 260 261 /* 262 * Message format for use in obtaining information about prefixes 263 * from inet6 sysctl function 264 */ 265 struct inet6_ndpr_msghdr { 266 u_short inpm_msglen; /* to skip over non-understood messages */ 267 u_char inpm_version; /* future binary compatibility */ 268 u_char inpm_type; /* message type */ 269 struct in6_addr inpm_prefix; 270 u_long prm_vltim; 271 u_long prm_pltime; 272 u_long prm_expire; 273 u_long prm_preferred; 274 struct in6_prflags prm_flags; 275 u_short prm_index; /* index for associated ifp */ 276 u_char prm_plen; /* length of prefix in bits */ 277 }; 278 279 #define prm_raf_onlink prm_flags.prf_ra.onlink 280 #define prm_raf_auto prm_flags.prf_ra.autonomous 281 282 #define prm_statef_onlink prm_flags.prf_state.onlink 283 284 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 285 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 286 287 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr)) 288 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr)) 289 290 struct nd_pfxrouter { 291 LIST_ENTRY(nd_pfxrouter) pfr_entry; 292 #define pfr_next pfr_entry.le_next 293 struct nd_defrouter *router; 294 }; 295 296 LIST_HEAD(nd_prhead, nd_prefix); 297 298 /* nd6.c */ 299 extern int nd6_prune; 300 extern int nd6_delay; 301 extern int nd6_umaxtries; 302 extern int nd6_mmaxtries; 303 extern int nd6_useloopback; 304 extern int nd6_maxnudhint; 305 extern int nd6_gctimer; 306 extern struct llinfo_nd6 llinfo_nd6; 307 extern struct nd_ifinfo *nd_ifinfo; 308 extern struct nd_drhead nd_defrouter; 309 extern struct nd_prhead nd_prefix; 310 extern int nd6_debug; 311 312 #define nd6log(x) do { if (nd6_debug) log x; } while (0) 313 314 extern struct callout nd6_timer_ch; 315 316 /* nd6_rtr.c */ 317 extern int nd6_defifindex; 318 extern int ip6_desync_factor; /* seconds */ 319 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */ 320 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */ 321 extern int ip6_temp_regen_advance; /* seconds */ 322 323 union nd_opts { 324 struct nd_opt_hdr *nd_opt_array[9]; /* max = home agent info */ 325 struct { 326 struct nd_opt_hdr *zero; 327 struct nd_opt_hdr *src_lladdr; 328 struct nd_opt_hdr *tgt_lladdr; 329 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 330 struct nd_opt_rd_hdr *rh; 331 struct nd_opt_mtu *mtu; 332 struct nd_opt_hdr *six; 333 struct nd_opt_advint *adv; 334 struct nd_opt_hai *hai; 335 struct nd_opt_hdr *search; /* multiple opts */ 336 struct nd_opt_hdr *last; /* multiple opts */ 337 int done; 338 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 339 } nd_opt_each; 340 }; 341 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 342 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 343 #define nd_opts_pi nd_opt_each.pi_beg 344 #define nd_opts_pi_end nd_opt_each.pi_end 345 #define nd_opts_rh nd_opt_each.rh 346 #define nd_opts_mtu nd_opt_each.mtu 347 #define nd_opts_adv nd_opt_each.adv 348 #define nd_opts_hai nd_opt_each.hai 349 #define nd_opts_search nd_opt_each.search 350 #define nd_opts_last nd_opt_each.last 351 #define nd_opts_done nd_opt_each.done 352 353 /* XXX: need nd6_var.h?? */ 354 /* nd6.c */ 355 void nd6_init (void); 356 struct nd_ifinfo *nd6_ifattach (struct ifnet *); 357 void nd6_ifdetach (struct nd_ifinfo *); 358 int nd6_is_addr_neighbor (struct sockaddr_in6 *, struct ifnet *); 359 void nd6_option_init (void *, int, union nd_opts *); 360 struct nd_opt_hdr *nd6_option (union nd_opts *); 361 int nd6_options (union nd_opts *); 362 struct rtentry *nd6_lookup (struct in6_addr *, int, struct ifnet *); 363 void nd6_setmtu (struct ifnet *); 364 void nd6_timer (void *); 365 void nd6_purge (struct ifnet *); 366 struct llinfo_nd6 *nd6_free (struct rtentry *); 367 void nd6_nud_hint (struct rtentry *, struct in6_addr *, int); 368 int nd6_resolve (struct ifnet *, struct rtentry *, 369 struct mbuf *, struct sockaddr *, u_char *); 370 void nd6_rtrequest (int, struct rtentry *, struct rt_addrinfo *); 371 int nd6_ioctl (u_long, caddr_t, struct ifnet *); 372 struct rtentry *nd6_cache_lladdr (struct ifnet *, struct in6_addr *, 373 char *, int, int, int); 374 int nd6_output (struct ifnet *, struct ifnet *, struct mbuf *, 375 struct sockaddr_in6 *, struct rtentry *); 376 int nd6_storelladdr (struct ifnet *, struct rtentry *, struct mbuf *, 377 struct sockaddr *, u_char *); 378 int nd6_need_cache (struct ifnet *); 379 380 /* nd6_nbr.c */ 381 void nd6_na_input (struct mbuf *, int, int); 382 void nd6_na_output (struct ifnet *, const struct in6_addr *, 383 const struct in6_addr *, u_long, int, struct sockaddr *); 384 void nd6_ns_input (struct mbuf *, int, int); 385 void nd6_ns_output (struct ifnet *, const struct in6_addr *, 386 const struct in6_addr *, struct llinfo_nd6 *, int); 387 caddr_t nd6_ifptomac (struct ifnet *); 388 void nd6_dad_start (struct ifaddr *, int *); 389 void nd6_dad_stop (struct ifaddr *); 390 void nd6_dad_duplicated (struct ifaddr *); 391 392 /* nd6_rtr.c */ 393 void nd6_rs_input (struct mbuf *, int, int); 394 void nd6_ra_input (struct mbuf *, int, int); 395 void prelist_del (struct nd_prefix *); 396 void defrouter_addreq (struct nd_defrouter *); 397 void defrouter_delreq (struct nd_defrouter *, int); 398 void defrouter_select (void); 399 void defrtrlist_del (struct nd_defrouter *); 400 void prelist_remove (struct nd_prefix *); 401 int prelist_update (struct nd_prefix *, struct nd_defrouter *, 402 struct mbuf *); 403 int nd6_prelist_add (struct nd_prefix *, struct nd_defrouter *, 404 struct nd_prefix **); 405 int nd6_prefix_onlink (struct nd_prefix *); 406 int nd6_prefix_offlink (struct nd_prefix *); 407 void pfxlist_onlink_check (void); 408 struct nd_defrouter *defrouter_lookup (struct in6_addr *, 409 struct ifnet *); 410 struct nd_prefix *nd6_prefix_lookup (struct nd_prefix *); 411 int in6_init_prefix_ltimes (struct nd_prefix *ndpr); 412 void rt6_flush (struct in6_addr *, struct ifnet *); 413 int nd6_setdefaultiface (int); 414 int in6_tmpifadd (const struct in6_ifaddr *, int); 415 416 #endif /* _KERNEL */ 417 418 #endif /* _NETINET6_ND6_H_ */ 419