1 /*- 2 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the project nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ 30 * $FreeBSD$ 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 llentry; 45 46 #define ND6_LLINFO_NOSTATE -2 47 /* 48 * We don't need the WAITDELETE state any more, but we keep the definition 49 * in a comment line instead of removing it. This is necessary to avoid 50 * unintentionally reusing the value for another purpose, which might 51 * affect backward compatibility with old applications. 52 * (20000711 jinmei@kame.net) 53 */ 54 /* #define ND6_LLINFO_WAITDELETE -1 */ 55 #define ND6_LLINFO_INCOMPLETE 0 56 #define ND6_LLINFO_REACHABLE 1 57 #define ND6_LLINFO_STALE 2 58 #define ND6_LLINFO_DELAY 3 59 #define ND6_LLINFO_PROBE 4 60 61 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 62 #define ND6_LLINFO_PERMANENT(n) (((n)->la_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE)) 63 64 struct nd_ifinfo { 65 u_int32_t linkmtu; /* LinkMTU */ 66 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 67 u_int32_t basereachable; /* BaseReachableTime */ 68 u_int32_t reachable; /* Reachable Time */ 69 u_int32_t retrans; /* Retrans Timer */ 70 u_int32_t flags; /* Flags */ 71 int recalctm; /* BaseReacable re-calculation timer */ 72 u_int8_t chlim; /* CurHopLimit */ 73 u_int8_t initialized; /* Flag to see the entry is initialized */ 74 /* the following 3 members are for privacy extension for addrconf */ 75 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 76 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 77 u_int8_t randomid[8]; /* current random ID */ 78 }; 79 80 #define ND6_IFF_PERFORMNUD 0x1 81 #define ND6_IFF_ACCEPT_RTADV 0x2 82 #define ND6_IFF_PREFER_SOURCE 0x4 /* Not used in FreeBSD. */ 83 #define ND6_IFF_IFDISABLED 0x8 /* IPv6 operation is disabled due to 84 * DAD failure. (XXX: not ND-specific) 85 */ 86 #define ND6_IFF_DONT_SET_IFROUTE 0x10 87 #define ND6_IFF_AUTO_LINKLOCAL 0x20 88 #define ND6_IFF_NO_RADR 0x40 89 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */ 90 91 #define ND6_CREATE LLE_CREATE 92 #define ND6_EXCLUSIVE LLE_EXCLUSIVE 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 #ifdef _KERNEL 135 struct in6_oprlist { 136 char ifname[IFNAMSIZ]; 137 struct { 138 struct in6_addr prefix; 139 struct prf_ra raflags; 140 u_char prefixlen; 141 u_char origin; 142 u_long vltime; 143 u_long pltime; 144 u_long expire; 145 u_short if_index; 146 u_short advrtrs; /* number of advertisement routers */ 147 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 148 } prefix[PRLSTSIZ]; 149 }; 150 #endif 151 152 struct in6_prlist { 153 char ifname[IFNAMSIZ]; 154 struct { 155 struct in6_addr prefix; 156 struct prf_ra raflags; 157 u_char prefixlen; 158 u_char origin; 159 u_int32_t vltime; 160 u_int32_t pltime; 161 time_t expire; 162 u_short if_index; 163 u_short advrtrs; /* number of advertisement routers */ 164 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 165 } prefix[PRLSTSIZ]; 166 }; 167 168 struct in6_prefix { 169 struct sockaddr_in6 prefix; 170 struct prf_ra raflags; 171 u_char prefixlen; 172 u_char origin; 173 u_int32_t vltime; 174 u_int32_t pltime; 175 time_t expire; 176 u_int32_t flags; 177 int refcnt; 178 u_short if_index; 179 u_short advrtrs; /* number of advertisement routers */ 180 /* struct sockaddr_in6 advrtr[] */ 181 }; 182 183 #ifdef _KERNEL 184 struct in6_ondireq { 185 char ifname[IFNAMSIZ]; 186 struct { 187 u_int32_t linkmtu; /* LinkMTU */ 188 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 189 u_int32_t basereachable; /* BaseReachableTime */ 190 u_int32_t reachable; /* Reachable Time */ 191 u_int32_t retrans; /* Retrans Timer */ 192 u_int32_t flags; /* Flags */ 193 int recalctm; /* BaseReacable re-calculation timer */ 194 u_int8_t chlim; /* CurHopLimit */ 195 u_int8_t receivedra; 196 } ndi; 197 }; 198 #endif 199 200 struct in6_ndireq { 201 char ifname[IFNAMSIZ]; 202 struct nd_ifinfo ndi; 203 }; 204 205 struct in6_ndifreq { 206 char ifname[IFNAMSIZ]; 207 u_long ifindex; 208 }; 209 210 /* Prefix status */ 211 #define NDPRF_ONLINK 0x1 212 #define NDPRF_DETACHED 0x2 213 214 /* protocol constants */ 215 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 216 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 217 #define MAX_RTR_SOLICITATIONS 3 218 219 #define ND6_INFINITE_LIFETIME 0xffffffff 220 221 #ifdef _KERNEL 222 /* node constants */ 223 #define MAX_REACHABLE_TIME 3600000 /* msec */ 224 #define REACHABLE_TIME 30000 /* msec */ 225 #define RETRANS_TIMER 1000 /* msec */ 226 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 227 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 228 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */ 229 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 230 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 231 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */ 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_prefixctl { 248 struct ifnet *ndpr_ifp; 249 250 /* prefix */ 251 struct sockaddr_in6 ndpr_prefix; 252 u_char ndpr_plen; 253 254 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 255 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 256 257 struct prf_ra ndpr_flags; 258 }; 259 260 261 struct nd_prefix { 262 struct ifnet *ndpr_ifp; 263 LIST_ENTRY(nd_prefix) ndpr_entry; 264 struct sockaddr_in6 ndpr_prefix; /* prefix */ 265 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 266 267 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 268 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 269 270 time_t ndpr_expire; /* expiration time of the prefix */ 271 time_t ndpr_preferred; /* preferred time of the prefix */ 272 time_t ndpr_lastupdate; /* reception time of last advertisement */ 273 274 struct prf_ra ndpr_flags; 275 u_int32_t ndpr_stateflags; /* actual state flags */ 276 /* list of routers that advertise the prefix: */ 277 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 278 u_char ndpr_plen; 279 int ndpr_refcnt; /* reference couter from addresses */ 280 }; 281 282 #define ndpr_raf ndpr_flags 283 #define ndpr_raf_onlink ndpr_flags.onlink 284 #define ndpr_raf_auto ndpr_flags.autonomous 285 #define ndpr_raf_router ndpr_flags.router 286 287 /* 288 * Message format for use in obtaining information about prefixes 289 * from inet6 sysctl function 290 */ 291 struct inet6_ndpr_msghdr { 292 u_short inpm_msglen; /* to skip over non-understood messages */ 293 u_char inpm_version; /* future binary compatibility */ 294 u_char inpm_type; /* message type */ 295 struct in6_addr inpm_prefix; 296 u_long prm_vltim; 297 u_long prm_pltime; 298 u_long prm_expire; 299 u_long prm_preferred; 300 struct in6_prflags prm_flags; 301 u_short prm_index; /* index for associated ifp */ 302 u_char prm_plen; /* length of prefix in bits */ 303 }; 304 305 #define prm_raf_onlink prm_flags.prf_ra.onlink 306 #define prm_raf_auto prm_flags.prf_ra.autonomous 307 308 #define prm_statef_onlink prm_flags.prf_state.onlink 309 310 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 311 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 312 313 struct nd_pfxrouter { 314 LIST_ENTRY(nd_pfxrouter) pfr_entry; 315 struct nd_defrouter *router; 316 }; 317 318 LIST_HEAD(nd_prhead, nd_prefix); 319 320 /* nd6.c */ 321 VNET_DECLARE(int, nd6_prune); 322 VNET_DECLARE(int, nd6_delay); 323 VNET_DECLARE(int, nd6_umaxtries); 324 VNET_DECLARE(int, nd6_mmaxtries); 325 VNET_DECLARE(int, nd6_useloopback); 326 VNET_DECLARE(int, nd6_maxnudhint); 327 VNET_DECLARE(int, nd6_gctimer); 328 VNET_DECLARE(struct nd_drhead, nd_defrouter); 329 VNET_DECLARE(struct nd_prhead, nd_prefix); 330 VNET_DECLARE(int, nd6_debug); 331 VNET_DECLARE(int, nd6_onlink_ns_rfc4861); 332 #define V_nd6_prune VNET(nd6_prune) 333 #define V_nd6_delay VNET(nd6_delay) 334 #define V_nd6_umaxtries VNET(nd6_umaxtries) 335 #define V_nd6_mmaxtries VNET(nd6_mmaxtries) 336 #define V_nd6_useloopback VNET(nd6_useloopback) 337 #define V_nd6_maxnudhint VNET(nd6_maxnudhint) 338 #define V_nd6_gctimer VNET(nd6_gctimer) 339 #define V_nd_defrouter VNET(nd_defrouter) 340 #define V_nd_prefix VNET(nd_prefix) 341 #define V_nd6_debug VNET(nd6_debug) 342 #define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861) 343 344 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0) 345 346 VNET_DECLARE(struct callout, nd6_timer_ch); 347 #define V_nd6_timer_ch VNET(nd6_timer_ch) 348 349 /* nd6_rtr.c */ 350 VNET_DECLARE(int, nd6_defifindex); 351 VNET_DECLARE(int, ip6_desync_factor); /* seconds */ 352 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */ 353 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */ 354 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */ 355 #define V_nd6_defifindex VNET(nd6_defifindex) 356 #define V_ip6_desync_factor VNET(ip6_desync_factor) 357 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime) 358 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime) 359 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance) 360 361 union nd_opts { 362 struct nd_opt_hdr *nd_opt_array[8]; /* max = target address list */ 363 struct { 364 struct nd_opt_hdr *zero; 365 struct nd_opt_hdr *src_lladdr; 366 struct nd_opt_hdr *tgt_lladdr; 367 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 368 struct nd_opt_rd_hdr *rh; 369 struct nd_opt_mtu *mtu; 370 struct nd_opt_hdr *search; /* multiple opts */ 371 struct nd_opt_hdr *last; /* multiple opts */ 372 int done; 373 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 374 } nd_opt_each; 375 }; 376 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 377 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 378 #define nd_opts_pi nd_opt_each.pi_beg 379 #define nd_opts_pi_end nd_opt_each.pi_end 380 #define nd_opts_rh nd_opt_each.rh 381 #define nd_opts_mtu nd_opt_each.mtu 382 #define nd_opts_search nd_opt_each.search 383 #define nd_opts_last nd_opt_each.last 384 #define nd_opts_done nd_opt_each.done 385 386 /* XXX: need nd6_var.h?? */ 387 /* nd6.c */ 388 void nd6_init(void); 389 #ifdef VIMAGE 390 void nd6_destroy(void); 391 #endif 392 struct nd_ifinfo *nd6_ifattach(struct ifnet *); 393 void nd6_ifdetach(struct nd_ifinfo *); 394 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *); 395 void nd6_option_init(void *, int, union nd_opts *); 396 struct nd_opt_hdr *nd6_option(union nd_opts *); 397 int nd6_options(union nd_opts *); 398 struct llentry *nd6_lookup(struct in6_addr *, int, struct ifnet *); 399 void nd6_setmtu(struct ifnet *); 400 void nd6_llinfo_settimer(struct llentry *, long); 401 void nd6_llinfo_settimer_locked(struct llentry *, long); 402 void nd6_timer(void *); 403 void nd6_purge(struct ifnet *); 404 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int); 405 int nd6_resolve(struct ifnet *, struct rtentry *, struct mbuf *, 406 struct sockaddr *, u_char *); 407 int nd6_ioctl(u_long, caddr_t, struct ifnet *); 408 struct llentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 409 char *, int, int, int); 410 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *, 411 struct sockaddr_in6 *, struct rtentry *); 412 int nd6_output_lle(struct ifnet *, struct ifnet *, struct mbuf *, 413 struct sockaddr_in6 *, struct rtentry *, struct llentry *, 414 struct mbuf **); 415 int nd6_output_flush(struct ifnet *, struct ifnet *, struct mbuf *, 416 struct sockaddr_in6 *, struct route *); 417 int nd6_need_cache(struct ifnet *); 418 int nd6_add_ifa_lle(struct in6_ifaddr *); 419 void nd6_rem_ifa_lle(struct in6_ifaddr *); 420 int nd6_storelladdr(struct ifnet *, struct mbuf *, 421 const struct sockaddr *, u_char *, struct llentry **); 422 423 /* nd6_nbr.c */ 424 void nd6_na_input(struct mbuf *, int, int); 425 void nd6_na_output(struct ifnet *, const struct in6_addr *, 426 const struct in6_addr *, u_long, int, struct sockaddr *); 427 void nd6_ns_input(struct mbuf *, int, int); 428 void nd6_ns_output(struct ifnet *, const struct in6_addr *, 429 const struct in6_addr *, struct llentry *, int); 430 caddr_t nd6_ifptomac(struct ifnet *); 431 void nd6_dad_start(struct ifaddr *, int); 432 void nd6_dad_stop(struct ifaddr *); 433 void nd6_dad_duplicated(struct ifaddr *); 434 435 /* nd6_rtr.c */ 436 void nd6_rs_input(struct mbuf *, int, int); 437 void nd6_ra_input(struct mbuf *, int, int); 438 void prelist_del(struct nd_prefix *); 439 void defrouter_reset(void); 440 void defrouter_select(void); 441 void defrtrlist_del(struct nd_defrouter *); 442 void prelist_remove(struct nd_prefix *); 443 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *, 444 struct nd_prefix **); 445 void pfxlist_onlink_check(void); 446 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *); 447 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *); 448 void rt6_flush(struct in6_addr *, struct ifnet *); 449 int nd6_setdefaultiface(int); 450 int in6_tmpifadd(const struct in6_ifaddr *, int, int); 451 452 #endif /* _KERNEL */ 453 454 #endif /* _NETINET6_ND6_H_ */ 455