1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the project nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ 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 llentry; 46 47 #define ND6_LLINFO_NOSTATE -2 48 /* 49 * We don't need the WAITDELETE state any more, but we keep the definition 50 * in a comment line instead of removing it. This is necessary to avoid 51 * unintentionally reusing the value for another purpose, which might 52 * affect backward compatibility with old applications. 53 * (20000711 jinmei@kame.net) 54 */ 55 /* #define ND6_LLINFO_WAITDELETE -1 */ 56 #define ND6_LLINFO_INCOMPLETE 0 57 #define ND6_LLINFO_REACHABLE 1 58 #define ND6_LLINFO_STALE 2 59 #define ND6_LLINFO_DELAY 3 60 #define ND6_LLINFO_PROBE 4 61 62 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 63 #define ND6_LLINFO_PERMANENT(n) (((n)->la_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE)) 64 65 struct nd_ifinfo { 66 u_int32_t linkmtu; /* LinkMTU */ 67 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 68 u_int32_t basereachable; /* BaseReachableTime */ 69 u_int32_t reachable; /* Reachable Time */ 70 u_int32_t retrans; /* Retrans Timer */ 71 u_int32_t flags; /* Flags */ 72 int recalctm; /* BaseReacable re-calculation timer */ 73 u_int8_t chlim; /* CurHopLimit */ 74 u_int8_t initialized; /* Flag to see the entry is initialized */ 75 /* the following 3 members are for privacy extension for addrconf */ 76 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 77 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 78 u_int8_t randomid[8]; /* current random ID */ 79 }; 80 81 #define ND6_IFF_PERFORMNUD 0x1 82 #define ND6_IFF_ACCEPT_RTADV 0x2 83 #define ND6_IFF_PREFER_SOURCE 0x4 /* Not used in FreeBSD. */ 84 #define ND6_IFF_IFDISABLED 0x8 /* IPv6 operation is disabled due to 85 * DAD failure. (XXX: not ND-specific) 86 */ 87 #define ND6_IFF_DONT_SET_IFROUTE 0x10 88 #define ND6_IFF_AUTO_LINKLOCAL 0x20 89 #define ND6_IFF_NO_RADR 0x40 90 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */ 91 #define ND6_IFF_NO_DAD 0x100 92 #define ND6_IFF_STABLEADDR 0x800 93 #ifdef EXPERIMENTAL 94 /* XXX: not related to ND. */ 95 #define ND6_IFF_IPV6_ONLY 0x200 /* draft-ietf-6man-ipv6only-flag */ 96 #define ND6_IFF_IPV6_ONLY_MANUAL 0x400 97 #define ND6_IFF_IPV6_ONLY_MASK (ND6_IFF_IPV6_ONLY|ND6_IFF_IPV6_ONLY_MANUAL) 98 #endif 99 100 #ifdef _KERNEL 101 #define ND_IFINFO(ifp) \ 102 (((struct in6_ifextra *)if_getafdata(ifp, AF_INET6))->nd_ifinfo) 103 #define IN6_LINKMTU(ifp) \ 104 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \ 105 ? ND_IFINFO(ifp)->linkmtu \ 106 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \ 107 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu)) 108 #endif 109 110 struct in6_nbrinfo { 111 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 112 struct in6_addr addr; /* IPv6 address of the neighbor */ 113 long asked; /* number of queries already sent for this addr */ 114 int isrouter; /* if it acts as a router */ 115 int state; /* reachability state */ 116 int expire; /* lifetime for NDP state transition */ 117 }; 118 119 /* Sysctls, shared with user space. */ 120 struct in6_defrouter { 121 struct sockaddr_in6 rtaddr; 122 u_char flags; 123 u_short rtlifetime; 124 u_long expire; 125 u_short if_index; 126 }; 127 128 struct in6_prefix { 129 struct sockaddr_in6 prefix; 130 struct prf_ra raflags; 131 u_char prefixlen; 132 u_char origin; 133 u_int32_t vltime; 134 u_int32_t pltime; 135 time_t expire; 136 u_int32_t flags; 137 int refcnt; 138 u_short if_index; 139 u_short advrtrs; /* number of advertisement routers */ 140 /* struct sockaddr_in6 advrtr[] */ 141 }; 142 143 #ifdef _KERNEL 144 struct in6_ondireq { 145 char ifname[IFNAMSIZ]; 146 struct { 147 u_int32_t linkmtu; /* LinkMTU */ 148 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 149 u_int32_t basereachable; /* BaseReachableTime */ 150 u_int32_t reachable; /* Reachable Time */ 151 u_int32_t retrans; /* Retrans Timer */ 152 u_int32_t flags; /* Flags */ 153 int recalctm; /* BaseReacable re-calculation timer */ 154 u_int8_t chlim; /* CurHopLimit */ 155 u_int8_t receivedra; 156 } ndi; 157 }; 158 #endif 159 160 struct in6_ndireq { 161 char ifname[IFNAMSIZ]; 162 struct nd_ifinfo ndi; 163 }; 164 165 struct in6_ndifreq { 166 char ifname[IFNAMSIZ]; 167 u_long ifindex; 168 }; 169 170 /* Prefix status */ 171 #define NDPRF_ONLINK 0x1 172 #define NDPRF_DETACHED 0x2 173 174 /* ND6 NA output flags */ 175 #define ND6_NA_OPT_LLA 0x01 176 #define ND6_NA_CARP_MASTER 0x02 177 178 /* protocol constants */ 179 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 180 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 181 #define MAX_RTR_SOLICITATIONS 3 182 183 #define ND6_INFINITE_LIFETIME 0xffffffff 184 185 #ifdef _KERNEL 186 /* node constants */ 187 #define MAX_REACHABLE_TIME 3600000 /* msec */ 188 #define REACHABLE_TIME 30000 /* msec */ 189 #define RETRANS_TIMER 1000 /* msec */ 190 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 191 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 192 #define DEF_TEMP_VALID_LIFETIME 172800 /* 2 days */ 193 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 194 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 195 #define TEMP_MAX_DESYNC_FACTOR_BASE 300 /* 5 min */ 196 #define ND_COMPUTE_RTIME(x) \ 197 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \ 198 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 199 200 struct nd_defrouter { 201 TAILQ_ENTRY(nd_defrouter) dr_entry; 202 struct in6_addr rtaddr; 203 u_char raflags; /* flags on RA message */ 204 u_short rtlifetime; 205 u_long expire; 206 struct ifnet *ifp; 207 int installed; /* is installed into kernel routing table */ 208 u_int refcnt; 209 }; 210 211 struct nd_prefixctl { 212 struct ifnet *ndpr_ifp; 213 214 /* prefix */ 215 struct sockaddr_in6 ndpr_prefix; 216 u_char ndpr_plen; 217 218 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 219 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 220 221 struct prf_ra ndpr_flags; 222 }; 223 224 LIST_HEAD(nd_prhead, nd_prefix); 225 struct nd_prefix { 226 struct ifnet *ndpr_ifp; 227 LIST_ENTRY(nd_prefix) ndpr_entry; 228 struct sockaddr_in6 ndpr_prefix; /* prefix */ 229 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 230 231 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 232 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 233 234 time_t ndpr_expire; /* expiration time of the prefix */ 235 time_t ndpr_preferred; /* preferred time of the prefix */ 236 time_t ndpr_lastupdate; /* reception time of last advertisement */ 237 238 struct prf_ra ndpr_flags; 239 u_int32_t ndpr_stateflags; /* actual state flags */ 240 /* list of routers that advertise the prefix: */ 241 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 242 u_char ndpr_plen; 243 int ndpr_addrcnt; /* count of derived addresses */ 244 volatile u_int ndpr_refcnt; 245 }; 246 247 #define ndpr_raf ndpr_flags 248 #define ndpr_raf_onlink ndpr_flags.onlink 249 #define ndpr_raf_auto ndpr_flags.autonomous 250 #define ndpr_raf_router ndpr_flags.router 251 252 struct nd_pfxrouter { 253 LIST_ENTRY(nd_pfxrouter) pfr_entry; 254 struct nd_defrouter *router; 255 }; 256 257 #ifdef MALLOC_DECLARE 258 MALLOC_DECLARE(M_IP6NDP); 259 #endif 260 261 /* nd6.c */ 262 VNET_DECLARE(int, nd6_mmaxtries); 263 VNET_DECLARE(struct nd_prhead, nd_prefix); 264 VNET_DECLARE(int, nd6_debug); 265 #define V_nd6_mmaxtries VNET(nd6_mmaxtries) 266 #define V_nd_prefix VNET(nd_prefix) 267 #define V_nd6_debug VNET(nd6_debug) 268 269 /* Lock for the prefix and default router lists. */ 270 VNET_DECLARE(struct rwlock, nd6_lock); 271 VNET_DECLARE(uint64_t, nd6_list_genid); 272 #define V_nd6_lock VNET(nd6_lock) 273 #define V_nd6_list_genid VNET(nd6_list_genid) 274 275 #define ND6_RLOCK() rw_rlock(&V_nd6_lock) 276 #define ND6_RUNLOCK() rw_runlock(&V_nd6_lock) 277 #define ND6_WLOCK() rw_wlock(&V_nd6_lock) 278 #define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock) 279 #define ND6_TRY_UPGRADE() rw_try_upgrade(&V_nd6_lock) 280 #define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED) 281 #define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED) 282 #define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED) 283 #define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED) 284 285 /* Mutex for prefix onlink/offlink transitions. */ 286 VNET_DECLARE(struct mtx, nd6_onlink_mtx); 287 #define V_nd6_onlink_mtx VNET(nd6_onlink_mtx) 288 289 #define ND6_ONLINK_LOCK() mtx_lock(&V_nd6_onlink_mtx) 290 #define ND6_ONLINK_TRYLOCK() mtx_trylock(&V_nd6_onlink_mtx) 291 #define ND6_ONLINK_UNLOCK() mtx_unlock(&V_nd6_onlink_mtx) 292 #define ND6_ONLINK_LOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_OWNED) 293 #define ND6_ONLINK_UNLOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED) 294 295 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0) 296 297 /* nd6_rtr.c */ 298 VNET_DECLARE(int, nd6_defifindex); 299 VNET_DECLARE(int, ip6_desync_factor); /* seconds */ 300 VNET_DECLARE(uint32_t, ip6_temp_max_desync_factor); /* seconds */ 301 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */ 302 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */ 303 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */ 304 #define V_nd6_defifindex VNET(nd6_defifindex) 305 #define V_ip6_desync_factor VNET(ip6_desync_factor) 306 #define V_ip6_temp_max_desync_factor VNET(ip6_temp_max_desync_factor) 307 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime) 308 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime) 309 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance) 310 311 union nd_opts { 312 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */ 313 struct { 314 struct nd_opt_hdr *zero; 315 struct nd_opt_hdr *src_lladdr; 316 struct nd_opt_hdr *tgt_lladdr; 317 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 318 struct nd_opt_rd_hdr *rh; 319 struct nd_opt_mtu *mtu; 320 struct nd_opt_hdr *__res6; 321 struct nd_opt_hdr *__res7; 322 struct nd_opt_hdr *__res8; 323 struct nd_opt_hdr *__res9; 324 struct nd_opt_hdr *__res10; 325 struct nd_opt_hdr *__res11; 326 struct nd_opt_hdr *__res12; 327 struct nd_opt_hdr *__res13; 328 struct nd_opt_nonce *nonce; 329 struct nd_opt_hdr *__res15; 330 struct nd_opt_hdr *search; /* multiple opts */ 331 struct nd_opt_hdr *last; /* multiple opts */ 332 int done; 333 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 334 } nd_opt_each; 335 }; 336 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 337 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 338 #define nd_opts_pi nd_opt_each.pi_beg 339 #define nd_opts_pi_end nd_opt_each.pi_end 340 #define nd_opts_rh nd_opt_each.rh 341 #define nd_opts_mtu nd_opt_each.mtu 342 #define nd_opts_nonce nd_opt_each.nonce 343 #define nd_opts_search nd_opt_each.search 344 #define nd_opts_last nd_opt_each.last 345 #define nd_opts_done nd_opt_each.done 346 347 /* XXX: need nd6_var.h?? */ 348 /* nd6.c */ 349 void nd6_init(void); 350 #ifdef VIMAGE 351 void nd6_destroy(void); 352 #endif 353 struct nd_ifinfo *nd6_ifattach(struct ifnet *); 354 void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *); 355 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *); 356 void nd6_option_init(void *, int, union nd_opts *); 357 struct nd_opt_hdr *nd6_option(union nd_opts *); 358 int nd6_options(union nd_opts *); 359 struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *); 360 void nd6_setmtu(struct ifnet *); 361 void nd6_llinfo_setstate(struct llentry *lle, int newstate); 362 void nd6_timer(void *); 363 void nd6_purge(struct ifnet *); 364 int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst, 365 char *desten, uint32_t *pflags); 366 int nd6_resolve(struct ifnet *, int, struct mbuf *, 367 const struct sockaddr *, u_char *, uint32_t *, struct llentry **); 368 int nd6_ioctl(u_long, caddr_t, struct ifnet *); 369 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 370 char *, int, int, int); 371 bool nd6_try_set_entry_addr(struct ifnet *ifp, struct llentry *lle, char *lladdr); 372 struct mbuf *nd6_grab_holdchain(struct llentry *); 373 int nd6_flush_holdchain(struct ifnet *, struct llentry *, struct mbuf *); 374 void nd6_flush_children_holdchain(struct ifnet *, struct llentry *); 375 int nd6_add_ifa_lle(struct in6_ifaddr *); 376 void nd6_rem_ifa_lle(struct in6_ifaddr *, int); 377 int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *, 378 struct sockaddr_in6 *, struct route *); 379 380 struct rib_head; 381 struct rib_cmd_info; 382 void nd6_subscription_cb(struct rib_head *rnh, struct rib_cmd_info *rc, 383 void *arg); 384 385 /* nd6_nbr.c */ 386 void nd6_na_input(struct mbuf *, int, int); 387 void nd6_na_output(struct ifnet *, const struct in6_addr *, 388 const struct in6_addr *, u_long, int, struct sockaddr *); 389 void nd6_ns_input(struct mbuf *, int, int); 390 void nd6_ns_output(struct ifnet *, const struct in6_addr *, 391 const struct in6_addr *, const struct in6_addr *, uint8_t *); 392 caddr_t nd6_ifptomac(struct ifnet *); 393 void nd6_dad_init(void); 394 void nd6_dad_start(struct ifaddr *, int); 395 void nd6_dad_stop(struct ifaddr *); 396 397 /* nd6_rtr.c */ 398 void nd6_rs_input(struct mbuf *, int, int); 399 void nd6_ra_input(struct mbuf *, int, int); 400 void nd6_ifnet_link_event(void *, struct ifnet *, int); 401 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *); 402 struct nd_defrouter *defrouter_lookup_locked(const struct in6_addr *, 403 struct ifnet *); 404 void defrouter_reset(void); 405 void defrouter_select_fib(int fibnum); 406 void defrouter_rele(struct nd_defrouter *); 407 bool defrouter_remove(struct in6_addr *, struct ifnet *); 408 bool nd6_defrouter_list_empty(void); 409 void nd6_defrouter_flush_all(void); 410 void nd6_defrouter_purge(struct ifnet *); 411 void nd6_defrouter_timer(void); 412 void nd6_defrouter_init(void); 413 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *, 414 struct nd_prefix **); 415 void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *); 416 void nd6_prefix_del(struct nd_prefix *); 417 void nd6_prefix_ref(struct nd_prefix *); 418 void nd6_prefix_rele(struct nd_prefix *); 419 int nd6_prefix_offlink(struct nd_prefix *); 420 void pfxlist_onlink_check(void); 421 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *); 422 void rt6_flush(struct in6_addr *, struct ifnet *); 423 int nd6_setdefaultiface(int); 424 int in6_tmpifadd(const struct in6_ifaddr *, int, int); 425 426 #endif /* _KERNEL */ 427 428 #endif /* _NETINET6_ND6_H_ */ 429