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.8 2006/09/03 18:52:29 dillon 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 #ifndef _SYS_TYPES_H_ 43 #include <sys/types.h> 44 #endif 45 #ifndef _SYS_QUEUE_H_ 46 #include <sys/queue.h> 47 #endif 48 #ifndef _SYS_CALLOUT_H_ 49 #include <sys/callout.h> 50 #endif 51 #ifndef _NET_IF_H_ 52 #include <net/if.h> 53 #endif 54 #ifndef _NETINET_IN_H_ 55 #include <netinet/in.h> 56 #endif 57 #ifndef _NETINET6_IN6_VAR_H_ 58 #include <netinet6/in6_var.h> 59 #endif 60 61 struct llinfo_nd6 { 62 struct llinfo_nd6 *ln_next; 63 struct llinfo_nd6 *ln_prev; 64 struct rtentry *ln_rt; 65 struct mbuf *ln_hold; /* last packet until resolved/timeout */ 66 long ln_asked; /* number of queries already sent for this addr */ 67 u_long ln_expire; /* lifetime for NDP state transition */ 68 short ln_state; /* reachability state */ 69 short ln_router; /* 2^0: ND6 router bit */ 70 int ln_byhint; /* # of times we made it reachable by UL hint */ 71 }; 72 73 #define ND6_LLINFO_NOSTATE -2 74 /* 75 * We don't need the WAITDELETE state any more, but we keep the definition 76 * in a comment line instead of removing it. This is necessary to avoid 77 * unintentionally reusing the value for another purpose, which might 78 * affect backward compatibility with old applications. 79 * (20000711 jinmei@kame.net) 80 */ 81 /* #define ND6_LLINFO_WAITDELETE -1 */ 82 #define ND6_LLINFO_INCOMPLETE 0 83 #define ND6_LLINFO_REACHABLE 1 84 #define ND6_LLINFO_STALE 2 85 #define ND6_LLINFO_DELAY 3 86 #define ND6_LLINFO_PROBE 4 87 88 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 89 90 struct nd_ifinfo { 91 u_int32_t linkmtu; /* LinkMTU */ 92 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 93 u_int32_t basereachable; /* BaseReachableTime */ 94 u_int32_t reachable; /* Reachable Time */ 95 u_int32_t retrans; /* Retrans Timer */ 96 u_int32_t flags; /* Flags */ 97 int recalctm; /* BaseReacable re-calculation timer */ 98 u_int8_t chlim; /* CurHopLimit */ 99 u_int8_t receivedra; 100 u_int8_t initialized; /* Flag to see the entry is initialized */ 101 /* the following 3 members are for privacy extension for addrconf */ 102 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 103 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 104 u_int8_t randomid[8]; /* current random ID */ 105 }; 106 107 #define ND6_IFF_PERFORMNUD 0x1 108 #define ND6_IFF_ACCEPT_RTADV 0x2 109 110 #ifdef _KERNEL 111 #define ND_IFINFO(ifp) \ 112 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo) 113 #define IN6_LINKMTU(ifp) \ 114 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \ 115 ? ND_IFINFO(ifp)->linkmtu \ 116 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \ 117 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu)) 118 #endif 119 120 struct in6_nbrinfo { 121 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 122 struct in6_addr addr; /* IPv6 address of the neighbor */ 123 long asked; /* number of queries already sent for this addr */ 124 int isrouter; /* if it acts as a router */ 125 int state; /* reachability state */ 126 int expire; /* lifetime for NDP state transition */ 127 }; 128 129 #define DRLSTSIZ 10 130 #define PRLSTSIZ 10 131 struct in6_drlist { 132 char ifname[IFNAMSIZ]; 133 struct { 134 struct in6_addr rtaddr; 135 u_char flags; 136 u_short rtlifetime; 137 u_long expire; 138 u_short if_index; 139 } defrouter[DRLSTSIZ]; 140 }; 141 142 struct in6_defrouter { 143 struct sockaddr_in6 rtaddr; 144 u_char flags; 145 u_short rtlifetime; 146 u_long expire; 147 u_short if_index; 148 }; 149 150 struct in6_prlist { 151 char ifname[IFNAMSIZ]; 152 struct { 153 struct in6_addr prefix; 154 struct prf_ra raflags; 155 u_char prefixlen; 156 u_char origin; 157 u_int32_t vltime; 158 u_int32_t pltime; 159 time_t expire; 160 u_short if_index; 161 u_short advrtrs; /* number of advertisement routers */ 162 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 163 } prefix[PRLSTSIZ]; 164 }; 165 166 struct in6_prefix { 167 struct sockaddr_in6 prefix; 168 struct prf_ra raflags; 169 u_char prefixlen; 170 u_char origin; 171 u_long vltime; 172 u_long pltime; 173 u_long expire; 174 u_int32_t flags; 175 int refcnt; 176 u_short if_index; 177 u_short advrtrs; /* number of advertisement routers */ 178 /* struct sockaddr_in6 advrtr[] */ 179 }; 180 181 #ifdef _KERNEL 182 struct in6_ondireq { 183 char ifname[IFNAMSIZ]; 184 struct { 185 u_int32_t linkmtu; /* LinkMTU */ 186 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 187 u_int32_t basereachable; /* BaseReachableTime */ 188 u_int32_t reachable; /* Reachable Time */ 189 u_int32_t retrans; /* Retrans Timer */ 190 u_int32_t flags; /* Flags */ 191 int recalctm; /* BaseReacable re-calculation timer */ 192 u_int8_t chlim; /* CurHopLimit */ 193 u_int8_t receivedra; 194 } ndi; 195 }; 196 #endif 197 198 struct in6_ndireq { 199 char ifname[IFNAMSIZ]; 200 struct nd_ifinfo ndi; 201 }; 202 203 struct in6_ndifreq { 204 char ifname[IFNAMSIZ]; 205 u_long ifindex; 206 }; 207 208 /* Prefix status */ 209 #define NDPRF_ONLINK 0x1 210 #define NDPRF_DETACHED 0x2 211 212 /* protocol constants */ 213 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 214 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 215 #define MAX_RTR_SOLICITATIONS 3 216 217 #define ND6_INFINITE_LIFETIME 0xffffffff 218 219 #ifdef _KERNEL 220 /* node constants */ 221 #define MAX_REACHABLE_TIME 3600000 /* msec */ 222 #define REACHABLE_TIME 30000 /* msec */ 223 #define RETRANS_TIMER 1000 /* msec */ 224 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 225 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 226 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */ 227 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 228 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 229 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */ 230 #define ND_COMPUTE_RTIME(x) \ 231 (((MIN_RANDOM_FACTOR * (x >> 10)) + (krandom() & \ 232 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 233 234 TAILQ_HEAD(nd_drhead, nd_defrouter); 235 struct nd_defrouter { 236 TAILQ_ENTRY(nd_defrouter) dr_entry; 237 struct in6_addr rtaddr; 238 u_char flags; /* flags on RA message */ 239 u_short rtlifetime; 240 u_long expire; 241 u_long advint; /* Mobile IPv6 addition (milliseconds) */ 242 u_long advint_expire; /* Mobile IPv6 addition */ 243 int advints_lost; /* Mobile IPv6 addition */ 244 struct ifnet *ifp; 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 struct in6_addr ndpr_addr; /* address that is derived from the prefix */ 253 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 254 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 255 time_t ndpr_expire; /* expiration time of the prefix */ 256 time_t ndpr_preferred; /* preferred time of the prefix */ 257 struct prf_ra ndpr_flags; 258 u_int32_t ndpr_stateflags; /* actual state flags */ 259 /* list of routers that advertise the prefix: */ 260 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 261 u_char ndpr_plen; 262 int ndpr_refcnt; /* reference couter from addresses */ 263 }; 264 265 #define ndpr_next ndpr_entry.le_next 266 267 #define ndpr_raf ndpr_flags 268 #define ndpr_raf_onlink ndpr_flags.onlink 269 #define ndpr_raf_auto ndpr_flags.autonomous 270 271 /* 272 * We keep expired prefix for certain amount of time, for validation purposes. 273 * 1800s = MaxRtrAdvInterval 274 */ 275 #define NDPR_KEEP_EXPIRED (1800 * 2) 276 277 /* 278 * Message format for use in obtaining information about prefixes 279 * from inet6 sysctl function 280 */ 281 struct inet6_ndpr_msghdr { 282 u_short inpm_msglen; /* to skip over non-understood messages */ 283 u_char inpm_version; /* future binary compatibility */ 284 u_char inpm_type; /* message type */ 285 struct in6_addr inpm_prefix; 286 u_long prm_vltim; 287 u_long prm_pltime; 288 u_long prm_expire; 289 u_long prm_preferred; 290 struct in6_prflags prm_flags; 291 u_short prm_index; /* index for associated ifp */ 292 u_char prm_plen; /* length of prefix in bits */ 293 }; 294 295 #define prm_raf_onlink prm_flags.prf_ra.onlink 296 #define prm_raf_auto prm_flags.prf_ra.autonomous 297 298 #define prm_statef_onlink prm_flags.prf_state.onlink 299 300 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 301 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 302 303 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr)) 304 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr)) 305 306 struct nd_pfxrouter { 307 LIST_ENTRY(nd_pfxrouter) pfr_entry; 308 #define pfr_next pfr_entry.le_next 309 struct nd_defrouter *router; 310 }; 311 312 LIST_HEAD(nd_prhead, nd_prefix); 313 314 /* nd6.c */ 315 extern int nd6_prune; 316 extern int nd6_delay; 317 extern int nd6_umaxtries; 318 extern int nd6_mmaxtries; 319 extern int nd6_useloopback; 320 extern int nd6_maxnudhint; 321 extern int nd6_gctimer; 322 extern struct llinfo_nd6 llinfo_nd6; 323 extern struct nd_ifinfo *nd_ifinfo; 324 extern struct nd_drhead nd_defrouter; 325 extern struct nd_prhead nd_prefix; 326 extern int nd6_debug; 327 328 #define nd6log(x) do { if (nd6_debug) log x; } while (0) 329 330 extern struct callout nd6_timer_ch; 331 332 /* nd6_rtr.c */ 333 extern int nd6_defifindex; 334 extern int ip6_desync_factor; /* seconds */ 335 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */ 336 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */ 337 extern int ip6_temp_regen_advance; /* seconds */ 338 339 union nd_opts { 340 struct nd_opt_hdr *nd_opt_array[9]; /* max = home agent info */ 341 struct { 342 struct nd_opt_hdr *zero; 343 struct nd_opt_hdr *src_lladdr; 344 struct nd_opt_hdr *tgt_lladdr; 345 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 346 struct nd_opt_rd_hdr *rh; 347 struct nd_opt_mtu *mtu; 348 struct nd_opt_hdr *six; 349 struct nd_opt_advint *adv; 350 struct nd_opt_hai *hai; 351 struct nd_opt_hdr *search; /* multiple opts */ 352 struct nd_opt_hdr *last; /* multiple opts */ 353 int done; 354 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 355 } nd_opt_each; 356 }; 357 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 358 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 359 #define nd_opts_pi nd_opt_each.pi_beg 360 #define nd_opts_pi_end nd_opt_each.pi_end 361 #define nd_opts_rh nd_opt_each.rh 362 #define nd_opts_mtu nd_opt_each.mtu 363 #define nd_opts_adv nd_opt_each.adv 364 #define nd_opts_hai nd_opt_each.hai 365 #define nd_opts_search nd_opt_each.search 366 #define nd_opts_last nd_opt_each.last 367 #define nd_opts_done nd_opt_each.done 368 369 /* XXX: need nd6_var.h?? */ 370 /* nd6.c */ 371 void nd6_init (void); 372 struct nd_ifinfo *nd6_ifattach (struct ifnet *); 373 void nd6_ifdetach (struct nd_ifinfo *); 374 int nd6_is_addr_neighbor (struct sockaddr_in6 *, struct ifnet *); 375 void nd6_option_init (void *, int, union nd_opts *); 376 struct nd_opt_hdr *nd6_option (union nd_opts *); 377 int nd6_options (union nd_opts *); 378 struct rtentry *nd6_lookup (struct in6_addr *, int, struct ifnet *); 379 void nd6_setmtu (struct ifnet *); 380 void nd6_timer (void *); 381 void nd6_purge (struct ifnet *); 382 struct llinfo_nd6 *nd6_free (struct rtentry *); 383 void nd6_nud_hint (struct rtentry *, struct in6_addr *, int); 384 int nd6_resolve (struct ifnet *, struct rtentry *, 385 struct mbuf *, struct sockaddr *, u_char *); 386 void nd6_rtrequest (int, struct rtentry *, struct rt_addrinfo *); 387 int nd6_ioctl (u_long, caddr_t, struct ifnet *); 388 struct rtentry *nd6_cache_lladdr (struct ifnet *, struct in6_addr *, 389 char *, int, int, int); 390 int nd6_output (struct ifnet *, struct ifnet *, struct mbuf *, 391 struct sockaddr_in6 *, struct rtentry *); 392 int nd6_storelladdr (struct ifnet *, struct rtentry *, struct mbuf *, 393 struct sockaddr *, u_char *); 394 int nd6_need_cache (struct ifnet *); 395 396 /* nd6_nbr.c */ 397 void nd6_na_input (struct mbuf *, int, int); 398 void nd6_na_output (struct ifnet *, const struct in6_addr *, 399 const struct in6_addr *, u_long, int, struct sockaddr *); 400 void nd6_ns_input (struct mbuf *, int, int); 401 void nd6_ns_output (struct ifnet *, const struct in6_addr *, 402 const struct in6_addr *, struct llinfo_nd6 *, int); 403 caddr_t nd6_ifptomac (struct ifnet *); 404 void nd6_dad_start (struct ifaddr *, int *); 405 void nd6_dad_stop (struct ifaddr *); 406 void nd6_dad_duplicated (struct ifaddr *); 407 408 /* nd6_rtr.c */ 409 void nd6_rs_input (struct mbuf *, int, int); 410 void nd6_ra_input (struct mbuf *, int, int); 411 void prelist_del (struct nd_prefix *); 412 void defrouter_addreq (struct nd_defrouter *); 413 void defrouter_delreq (struct nd_defrouter *, int); 414 void defrouter_select (void); 415 void defrtrlist_del (struct nd_defrouter *); 416 void prelist_remove (struct nd_prefix *); 417 int prelist_update (struct nd_prefix *, struct nd_defrouter *, 418 struct mbuf *); 419 int nd6_prelist_add (struct nd_prefix *, struct nd_defrouter *, 420 struct nd_prefix **); 421 int nd6_prefix_onlink (struct nd_prefix *); 422 int nd6_prefix_offlink (struct nd_prefix *); 423 void pfxlist_onlink_check (void); 424 struct nd_defrouter *defrouter_lookup (struct in6_addr *, 425 struct ifnet *); 426 struct nd_prefix *nd6_prefix_lookup (struct nd_prefix *); 427 int in6_init_prefix_ltimes (struct nd_prefix *ndpr); 428 void rt6_flush (struct in6_addr *, struct ifnet *); 429 int nd6_setdefaultiface (int); 430 int in6_tmpifadd (const struct in6_ifaddr *, int); 431 432 #endif /* _KERNEL */ 433 434 #endif /* _NETINET6_ND6_H_ */ 435