1 /* $NetBSD: nd6.h,v 1.88 2019/09/25 09:52:32 ozaki-r 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 #include <sys/queue.h> 37 #include <sys/callout.h> 38 39 #define ND6_LLINFO_PURGE -3 40 #define ND6_LLINFO_NOSTATE -2 41 #define ND6_LLINFO_WAITDELETE -1 42 #define ND6_LLINFO_INCOMPLETE 0 43 #define ND6_LLINFO_REACHABLE 1 44 #define ND6_LLINFO_STALE 2 45 #define ND6_LLINFO_DELAY 3 46 #define ND6_LLINFO_PROBE 4 47 48 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 49 #define ND6_LLINFO_PERMANENT(n) (((n)->ln_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE)) 50 51 struct nd_ifinfo { 52 u_int32_t linkmtu; /* LinkMTU */ 53 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 54 u_int32_t basereachable; /* BaseReachableTime */ 55 u_int32_t reachable; /* Reachable Time */ 56 u_int32_t retrans; /* Retrans Timer */ 57 u_int32_t flags; /* Flags */ 58 int recalctm; /* BaseReacable re-calculation timer */ 59 u_int8_t chlim; /* CurHopLimit */ 60 u_int8_t initialized; /* Flag to see the entry is initialized */ 61 /* the following 3 members are for privacy extension for addrconf */ 62 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 63 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 64 u_int8_t randomid[8]; /* current random ID */ 65 }; 66 67 #define ND6_IFF_PERFORMNUD 0x01 68 #define ND6_IFF_ACCEPT_RTADV 0x02 /* See "RTADV Key", below. */ 69 #define ND6_IFF_PREFER_SOURCE 0x04 /* XXX: not related to ND. */ 70 #define ND6_IFF_IFDISABLED 0x08 /* IPv6 operation is disabled due to 71 * DAD failure. (XXX: not ND-specific) 72 */ 73 #define ND6_IFF_OVERRIDE_RTADV 0x10 /* See "RTADV Key", below. */ 74 #define ND6_IFF_AUTO_LINKLOCAL 0x20 75 76 /* 77 * RTADV Key 78 * 79 * The flags ND6_IFF_ACCEPT_RTADV and ND6_IFF_OVERRIDE_RTADV form a 80 * tri-state variable. (There are actually four different states, but 81 * two of the states are functionally identical.) 82 * 83 * ND6_IFF_OVERRIDE_RTADV or 0: This interface does not accept 84 * Router Advertisements. 85 * 86 * ND6_IFF_OVERRIDE_RTADV| 87 * ND6_IFF_ACCEPT_RTADV: This interface accepts Router 88 * Advertisements regardless of the 89 * global setting, ip6_accept_rtadv. 90 * 91 * ND6_IFF_ACCEPT_RTADV: This interface follows the global setting, 92 * ip6_accept_rtadv. If ip6_accept_rtadv == 0, 93 * this interface does not accept Router 94 * Advertisements. If ip6_accept_rtadv != 0, 95 * this interface does accept them. 96 */ 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 ((u_int32_t)~0) 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 DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */ 234 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 235 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 236 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */ 237 #define ND_COMPUTE_RTIME(x) \ 238 (((MIN_RANDOM_FACTOR * (x >> 10)) + (cprng_fast32() & \ 239 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 240 241 TAILQ_HEAD(nd_drhead, nd_defrouter); 242 struct nd_defrouter { 243 TAILQ_ENTRY(nd_defrouter) dr_entry; 244 struct in6_addr rtaddr; 245 u_char flags; /* flags on RA message */ 246 u_short rtlifetime; 247 u_long expire; 248 struct ifnet *ifp; 249 int installed; /* is installed into kernel routing table */ 250 }; 251 252 #define ND_DEFROUTER_LIST_INIT() \ 253 TAILQ_INIT(&nd_defrouter) 254 #define ND_DEFROUTER_LIST_FOREACH(dr) \ 255 TAILQ_FOREACH((dr), &nd_defrouter, dr_entry) 256 #define ND_DEFROUTER_LIST_FOREACH_SAFE(dr, dr_next) \ 257 TAILQ_FOREACH_SAFE((dr), &nd_defrouter, dr_entry, (dr_next)) 258 #define ND_DEFROUTER_LIST_EMPTY() \ 259 TAILQ_EMPTY(&nd_defrouter) 260 #define ND_DEFROUTER_LIST_REMOVE(dr) \ 261 TAILQ_REMOVE(&nd_defrouter, (dr), dr_entry) 262 #define ND_DEFROUTER_LIST_INSERT_BEFORE(dr, dr_new) \ 263 TAILQ_INSERT_BEFORE((dr), (dr_new), dr_entry) 264 #define ND_DEFROUTER_LIST_INSERT_TAIL(dr) \ 265 TAILQ_INSERT_TAIL(&nd_defrouter, (dr), dr_entry) 266 #define ND_DEFROUTER_LIST_FIRST() \ 267 TAILQ_FIRST(&nd_defrouter) 268 #define ND_DEFROUTER_LIST_NEXT(dr) \ 269 TAILQ_NEXT((dr), dr_entry) 270 271 struct nd_prefixctl { 272 struct ifnet *ndprc_ifp; 273 274 /* prefix */ 275 struct sockaddr_in6 ndprc_prefix; 276 u_char ndprc_plen; 277 278 u_int32_t ndprc_vltime; /* advertised valid lifetime */ 279 u_int32_t ndprc_pltime; /* advertised preferred lifetime */ 280 281 struct prf_ra ndprc_flags; 282 }; 283 284 #define ndprc_raf ndprc_flags 285 #define ndprc_raf_onlink ndprc_flags.onlink 286 #define ndprc_raf_auto ndprc_flags.autonomous 287 #define ndprc_raf_router ndprc_flags.router 288 289 struct nd_prefix { 290 struct ifnet *ndpr_ifp; 291 LIST_ENTRY(nd_prefix) ndpr_entry; 292 struct sockaddr_in6 ndpr_prefix; /* prefix */ 293 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 294 295 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 296 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 297 298 time_t ndpr_expire; /* expiration time of the prefix */ 299 time_t ndpr_preferred; /* preferred time of the prefix */ 300 time_t ndpr_lastupdate; /* reception time of last advertisement */ 301 302 struct prf_ra ndpr_flags; 303 u_int32_t ndpr_stateflags; /* actual state flags */ 304 /* list of routers that advertise the prefix: */ 305 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 306 u_char ndpr_plen; 307 int ndpr_refcnt; /* reference couter from addresses */ 308 }; 309 310 #define ndpr_next ndpr_entry.le_next 311 312 #define ndpr_raf ndpr_flags 313 #define ndpr_raf_onlink ndpr_flags.onlink 314 #define ndpr_raf_auto ndpr_flags.autonomous 315 #define ndpr_raf_router ndpr_flags.router 316 317 #define ND_PREFIX_LIST_FOREACH(pr) \ 318 LIST_FOREACH((pr), &nd_prefix, ndpr_entry) 319 #define ND_PREFIX_LIST_FOREACH_SAFE(pr, pr_next) \ 320 LIST_FOREACH_SAFE((pr), &nd_prefix, ndpr_entry, (pr_next)) 321 #define ND_PREFIX_LIST_REMOVE(pr) \ 322 LIST_REMOVE((pr), ndpr_entry) 323 #define ND_PREFIX_LIST_INSERT_HEAD(pr) \ 324 LIST_INSERT_HEAD(&nd_prefix, (pr), ndpr_entry) 325 326 /* 327 * Message format for use in obtaining information about prefixes 328 * from inet6 sysctl function 329 */ 330 struct inet6_ndpr_msghdr { 331 u_short inpm_msglen; /* to skip over non-understood messages */ 332 u_char inpm_version; /* future binary compatibility */ 333 u_char inpm_type; /* message type */ 334 struct in6_addr inpm_prefix; 335 u_long prm_vltim; 336 u_long prm_pltime; 337 u_long prm_expire; 338 u_long prm_preferred; 339 struct in6_prflags prm_flags; 340 u_short prm_index; /* index for associated ifp */ 341 u_char prm_plen; /* length of prefix in bits */ 342 }; 343 344 #define prm_raf_onlink prm_flags.prf_ra.onlink 345 #define prm_raf_auto prm_flags.prf_ra.autonomous 346 347 #define prm_statef_onlink prm_flags.prf_state.onlink 348 349 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 350 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 351 352 struct nd_pfxrouter { 353 LIST_ENTRY(nd_pfxrouter) pfr_entry; 354 struct nd_defrouter *router; 355 }; 356 357 LIST_HEAD(nd_prhead, nd_prefix); 358 359 #include <sys/mallocvar.h> 360 MALLOC_DECLARE(M_IP6NDP); 361 362 /* nd6.c */ 363 extern int nd6_prune; 364 extern int nd6_delay; 365 extern int nd6_umaxtries; 366 extern int nd6_mmaxtries; 367 extern int nd6_useloopback; 368 extern int nd6_maxnudhint; 369 extern int nd6_gctimer; 370 extern struct nd_drhead nd_defrouter; 371 extern struct nd_prhead nd_prefix; 372 extern int nd6_debug; 373 374 #define nd6log(level, fmt, args...) \ 375 do { if (nd6_debug) log(level, "%s: " fmt, __func__, ##args);} while (0) 376 377 extern krwlock_t nd6_lock; 378 379 #define ND6_RLOCK() rw_enter(&nd6_lock, RW_READER) 380 #define ND6_WLOCK() rw_enter(&nd6_lock, RW_WRITER) 381 #define ND6_UNLOCK() rw_exit(&nd6_lock) 382 #define ND6_ASSERT_WLOCK() KASSERT(rw_write_held(&nd6_lock)) 383 #define ND6_ASSERT_LOCK() KASSERT(rw_lock_held(&nd6_lock)) 384 385 /* nd6_rtr.c */ 386 extern int ip6_desync_factor; /* seconds */ 387 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */ 388 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */ 389 extern int ip6_temp_regen_advance; /* seconds */ 390 extern int nd6_numroutes; 391 392 union nd_opts { 393 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */ 394 struct { 395 struct nd_opt_hdr *zero; 396 struct nd_opt_hdr *src_lladdr; 397 struct nd_opt_hdr *tgt_lladdr; 398 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 399 struct nd_opt_rd_hdr *rh; 400 struct nd_opt_mtu *mtu; 401 struct nd_opt_hdr *__res6; 402 struct nd_opt_hdr *__res7; 403 struct nd_opt_hdr *__res8; 404 struct nd_opt_hdr *__res9; 405 struct nd_opt_hdr *__res10; 406 struct nd_opt_hdr *__res11; 407 struct nd_opt_hdr *__res12; 408 struct nd_opt_hdr *__res13; 409 struct nd_opt_nonce *nonce; 410 struct nd_opt_hdr *__res15; 411 struct nd_opt_hdr *search; /* multiple opts */ 412 struct nd_opt_hdr *last; /* multiple opts */ 413 int done; 414 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 415 } nd_opt_each; 416 }; 417 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 418 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 419 #define nd_opts_pi nd_opt_each.pi_beg 420 #define nd_opts_pi_end nd_opt_each.pi_end 421 #define nd_opts_rh nd_opt_each.rh 422 #define nd_opts_mtu nd_opt_each.mtu 423 #define nd_opts_nonce nd_opt_each.nonce 424 #define nd_opts_search nd_opt_each.search 425 #define nd_opts_last nd_opt_each.last 426 #define nd_opts_done nd_opt_each.done 427 428 #include <net/if_llatbl.h> 429 430 /* XXX: need nd6_var.h?? */ 431 /* nd6.c */ 432 void nd6_init(void); 433 void nd6_nbr_init(void); 434 struct nd_ifinfo *nd6_ifattach(struct ifnet *); 435 void nd6_ifdetach(struct ifnet *, struct in6_ifextra *); 436 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *); 437 void nd6_option_init(void *, int, union nd_opts *); 438 int nd6_options(union nd_opts *); 439 struct llentry *nd6_lookup(const struct in6_addr *, const struct ifnet *, bool); 440 struct llentry *nd6_create(const struct in6_addr *, const struct ifnet *); 441 void nd6_setmtu(struct ifnet *); 442 void nd6_llinfo_settimer(struct llentry *, time_t); 443 void nd6_purge(struct ifnet *, struct in6_ifextra *); 444 void nd6_assert_purged(struct ifnet *); 445 void nd6_nud_hint(struct rtentry *); 446 int nd6_resolve(struct ifnet *, const struct rtentry *, struct mbuf *, 447 const struct sockaddr *, uint8_t *, size_t); 448 void nd6_rtrequest(int, struct rtentry *, const struct rt_addrinfo *); 449 int nd6_ioctl(u_long, void *, struct ifnet *); 450 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 451 char *, int, int, int); 452 int nd6_sysctl(int, void *, size_t *, void *, size_t); 453 int nd6_need_cache(struct ifnet *); 454 void nd6_llinfo_release_pkts(struct llentry *, struct ifnet *); 455 456 /* nd6_nbr.c */ 457 void nd6_na_input(struct mbuf *, int, int); 458 void nd6_na_output(struct ifnet *, const struct in6_addr *, 459 const struct in6_addr *, u_long, int, const struct sockaddr *); 460 void nd6_ns_input(struct mbuf *, int, int); 461 void nd6_ns_output(struct ifnet *, const struct in6_addr *, 462 const struct in6_addr *, struct in6_addr *, uint8_t *); 463 const void *nd6_ifptomac(const struct ifnet *); 464 void nd6_dad_start(struct ifaddr *, int); 465 void nd6_dad_stop(struct ifaddr *); 466 467 /* nd6_rtr.c */ 468 void nd6_rs_input(struct mbuf *, int, int); 469 void nd6_ra_input(struct mbuf *, int, int); 470 void nd6_defrouter_reset(void); 471 void nd6_defrouter_select(void); 472 void nd6_defrtrlist_del(struct nd_defrouter *, struct in6_ifextra *); 473 void nd6_prefix_unref(struct nd_prefix *); 474 void nd6_prelist_remove(struct nd_prefix *); 475 void nd6_invalidate_prefix(struct nd_prefix *); 476 void nd6_pfxlist_onlink_check(void); 477 struct nd_defrouter *nd6_defrouter_lookup(const struct in6_addr *, struct ifnet *); 478 void nd6_rt_flush(struct in6_addr *, struct ifnet *); 479 int in6_tmpifadd(const struct in6_ifaddr *, int, int); 480 bool nd6_accepts_rtadv(const struct nd_ifinfo *); 481 482 #endif /* _KERNEL */ 483 484 #endif /* !_NETINET6_ND6_H_ */ 485