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 #define ND6_IFF_PERFORMNUD 0x1 66 #define ND6_IFF_ACCEPT_RTADV 0x2 67 #define ND6_IFF_PREFER_SOURCE 0x4 /* Not used in FreeBSD. */ 68 #define ND6_IFF_IFDISABLED 0x8 /* IPv6 operation is disabled due to 69 * DAD failure. (XXX: not ND-specific) 70 */ 71 #define ND6_IFF_DONT_SET_IFROUTE 0x10 72 #define ND6_IFF_AUTO_LINKLOCAL 0x20 73 #define ND6_IFF_NO_RADR 0x40 74 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */ 75 #define ND6_IFF_NO_DAD 0x100 76 #define ND6_IFF_STABLEADDR 0x800 77 78 struct in6_nbrinfo { 79 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 80 struct in6_addr addr; /* IPv6 address of the neighbor */ 81 long asked; /* number of queries already sent for this addr */ 82 int isrouter; /* if it acts as a router */ 83 int state; /* reachability state */ 84 int expire; /* lifetime for NDP state transition */ 85 }; 86 87 /* Sysctls, shared with user space. */ 88 struct in6_defrouter { 89 struct sockaddr_in6 rtaddr; 90 u_char flags; 91 u_short rtlifetime; 92 u_long expire; 93 u_short if_index; 94 }; 95 96 struct in6_prefix { 97 struct sockaddr_in6 prefix; 98 struct prf_ra raflags; 99 u_char prefixlen; 100 u_char origin; 101 u_int32_t vltime; 102 u_int32_t pltime; 103 time_t expire; 104 u_int32_t flags; 105 int refcnt; 106 u_short if_index; 107 u_short advrtrs; /* number of advertisement routers */ 108 /* struct sockaddr_in6 advrtr[] */ 109 }; 110 111 struct in6_ndireq { 112 char ifname[IFNAMSIZ]; 113 struct nd_ifinfo { 114 uint32_t linkmtu; /* LinkMTU */ 115 uint32_t maxmtu; /* Upper bound of LinkMTU */ 116 uint32_t basereachable; /* BaseReachableTime */ 117 uint32_t reachable; /* Reachable Time */ 118 uint32_t retrans; /* Retrans Timer */ 119 uint32_t flags; /* Flags */ 120 int recalctm; /* BaseReacable re-calculation timer */ 121 uint8_t chlim; /* CurHopLimit */ 122 /* 123 * The below members are not used. They came from KAME and 124 * are hanging around to preserve ABI compatibility of the 125 * SIOCGIFINFO_IN6 ioctl. 126 * The original comment documented the random* members as a 127 * privacy extension for addrconf. 128 */ 129 uint8_t initialized; /* compat: always 1 */ 130 uint8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 131 uint8_t randomseed1[8]; /* lower 64 bits (the EUI64 IFID?) */ 132 uint8_t randomid[8]; /* current random ID */ 133 } ndi; 134 }; 135 136 struct in6_ndifreq { 137 char ifname[IFNAMSIZ]; 138 u_long ifindex; 139 }; 140 141 /* Prefix status */ 142 #define NDPRF_ONLINK 0x1 143 #define NDPRF_DETACHED 0x2 144 145 /* ND6 NA output flags */ 146 #define ND6_NA_OPT_LLA 0x01 147 #define ND6_NA_CARP_MASTER 0x02 148 149 /* ND6 queue flags */ 150 #define ND6_QUEUE_FLAG_NEWGUA 0x01 /* new global unicast address event */ 151 #define ND6_QUEUE_FLAG_LLADDR 0x02 /* link-layer address change event */ 152 #define ND6_QUEUE_FLAG_ANYCAST 0x04 /* delay NA for anycast address */ 153 #define ND6_QUEUE_FLAG_PROXY 0x08 /* delay NA for proxy address */ 154 155 /* GRAND specific flags */ 156 #define ND6_QUEUE_GRAND_MASK (ND6_QUEUE_FLAG_NEWGUA|ND6_QUEUE_FLAG_LLADDR) 157 158 /* protocol constants */ 159 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 160 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 161 #define MAX_RTR_SOLICITATIONS 3 162 #define MAX_ANYCAST_DELAY_TIME 1 /* 1sec */ 163 164 #define ND6_INFINITE_LIFETIME 0xffffffff 165 166 #ifdef _KERNEL 167 /* node constants */ 168 #define MAX_REACHABLE_TIME 3600000 /* msec */ 169 #define REACHABLE_TIME 30000 /* msec */ 170 #define RETRANS_TIMER 1000 /* msec */ 171 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 172 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 173 #define DEF_TEMP_VALID_LIFETIME 172800 /* 2 days */ 174 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 175 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 176 #define TEMP_MAX_DESYNC_FACTOR_BASE 300 /* 5 min */ 177 #define ND_COMPUTE_RTIME(x) \ 178 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \ 179 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 180 #define MAX_NEIGHBOR_ADVERTISEMENT 3 /* RFC4891 Section 10 */ 181 182 struct nd_defrouter { 183 TAILQ_ENTRY(nd_defrouter) dr_entry; 184 struct in6_addr rtaddr; 185 u_char raflags; /* flags on RA message */ 186 u_short rtlifetime; 187 u_long expire; 188 struct ifnet *ifp; 189 int installed; /* is installed into kernel routing table */ 190 u_int refcnt; 191 }; 192 193 struct nd_prefixctl { 194 struct ifnet *ndpr_ifp; 195 196 /* prefix */ 197 struct sockaddr_in6 ndpr_prefix; 198 u_char ndpr_plen; 199 200 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 201 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 202 203 struct prf_ra ndpr_flags; 204 }; 205 206 LIST_HEAD(nd_prhead, nd_prefix); 207 struct nd_prefix { 208 struct ifnet *ndpr_ifp; 209 LIST_ENTRY(nd_prefix) ndpr_entry; 210 struct sockaddr_in6 ndpr_prefix; /* prefix */ 211 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 212 213 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 214 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 215 216 time_t ndpr_expire; /* expiration time of the prefix */ 217 time_t ndpr_preferred; /* preferred time of the prefix */ 218 time_t ndpr_lastupdate; /* reception time of last advertisement */ 219 220 struct prf_ra ndpr_flags; 221 u_int32_t ndpr_stateflags; /* actual state flags */ 222 /* list of routers that advertise the prefix: */ 223 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 224 u_char ndpr_plen; 225 int ndpr_addrcnt; /* count of derived addresses */ 226 volatile u_int ndpr_refcnt; 227 }; 228 229 #define ndpr_raf ndpr_flags 230 #define ndpr_raf_onlink ndpr_flags.onlink 231 #define ndpr_raf_auto ndpr_flags.autonomous 232 #define ndpr_raf_router ndpr_flags.router 233 234 struct nd_pfxrouter { 235 LIST_ENTRY(nd_pfxrouter) pfr_entry; 236 struct nd_defrouter *router; 237 }; 238 239 /* nd6.c */ 240 VNET_DECLARE(int, nd6_mmaxtries); 241 VNET_DECLARE(struct nd_prhead, nd_prefix); 242 VNET_DECLARE(int, nd6_debug); 243 #define V_nd6_mmaxtries VNET(nd6_mmaxtries) 244 #define V_nd_prefix VNET(nd_prefix) 245 #define V_nd6_debug VNET(nd6_debug) 246 247 /* Lock for the prefix and default router lists. */ 248 VNET_DECLARE(struct rwlock, nd6_lock); 249 VNET_DECLARE(uint64_t, nd6_list_genid); 250 #define V_nd6_lock VNET(nd6_lock) 251 #define V_nd6_list_genid VNET(nd6_list_genid) 252 253 #define ND6_RLOCK() rw_rlock(&V_nd6_lock) 254 #define ND6_RUNLOCK() rw_runlock(&V_nd6_lock) 255 #define ND6_WLOCK() rw_wlock(&V_nd6_lock) 256 #define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock) 257 #define ND6_TRY_UPGRADE() rw_try_upgrade(&V_nd6_lock) 258 #define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED) 259 #define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED) 260 #define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED) 261 #define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED) 262 263 /* Mutex for prefix onlink/offlink transitions. */ 264 VNET_DECLARE(struct mtx, nd6_onlink_mtx); 265 #define V_nd6_onlink_mtx VNET(nd6_onlink_mtx) 266 267 #define ND6_ONLINK_LOCK() mtx_lock(&V_nd6_onlink_mtx) 268 #define ND6_ONLINK_TRYLOCK() mtx_trylock(&V_nd6_onlink_mtx) 269 #define ND6_ONLINK_UNLOCK() mtx_unlock(&V_nd6_onlink_mtx) 270 #define ND6_ONLINK_LOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_OWNED) 271 #define ND6_ONLINK_UNLOCK_ASSERT() mtx_assert(&V_nd6_onlink_mtx, MA_NOTOWNED) 272 273 #define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0) 274 275 /* nd6_rtr.c */ 276 VNET_DECLARE(int, nd6_defifindex); 277 VNET_DECLARE(int, ip6_desync_factor); /* seconds */ 278 VNET_DECLARE(uint32_t, ip6_temp_max_desync_factor); /* seconds */ 279 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */ 280 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */ 281 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */ 282 #define V_nd6_defifindex VNET(nd6_defifindex) 283 #define V_ip6_desync_factor VNET(ip6_desync_factor) 284 #define V_ip6_temp_max_desync_factor VNET(ip6_temp_max_desync_factor) 285 #define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime) 286 #define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime) 287 #define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance) 288 289 union nd_opts { 290 struct nd_opt_hdr *nd_opt_array[24]; /* max = ND_OPT_ROUTE_INFO */ 291 struct { 292 struct nd_opt_hdr *zero; 293 struct nd_opt_hdr *src_lladdr; 294 struct nd_opt_hdr *tgt_lladdr; 295 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 296 struct nd_opt_rd_hdr *rh; 297 struct nd_opt_mtu *mtu; 298 struct nd_opt_hdr *__res6; 299 struct nd_opt_hdr *__res7; 300 struct nd_opt_hdr *__res8; 301 struct nd_opt_hdr *__res9; 302 struct nd_opt_hdr *__res10; 303 struct nd_opt_hdr *__res11; 304 struct nd_opt_hdr *__res12; 305 struct nd_opt_hdr *__res13; 306 struct nd_opt_nonce *nonce; 307 struct nd_opt_hdr *__res15; 308 struct nd_opt_hdr *__res16; 309 struct nd_opt_hdr *__res17; 310 struct nd_opt_hdr *__res18; 311 struct nd_opt_hdr *__res19; 312 struct nd_opt_hdr *__res20; 313 struct nd_opt_hdr *__res21; 314 struct nd_opt_hdr *__res22; 315 struct nd_opt_hdr *__res23; 316 struct nd_opt_route_info *rti_beg; 317 struct nd_opt_hdr *search; /* multiple opts */ 318 struct nd_opt_hdr *last; /* multiple opts */ 319 int done; 320 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 321 struct nd_opt_route_info *rti_end;/* multiple opts, end */ 322 } nd_opt_each; 323 }; 324 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 325 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 326 #define nd_opts_pi nd_opt_each.pi_beg 327 #define nd_opts_pi_end nd_opt_each.pi_end 328 #define nd_opts_rh nd_opt_each.rh 329 #define nd_opts_mtu nd_opt_each.mtu 330 #define nd_opts_nonce nd_opt_each.nonce 331 #define nd_opts_rti nd_opt_each.rti_beg 332 #define nd_opts_rti_end nd_opt_each.rti_end 333 #define nd_opts_search nd_opt_each.search 334 #define nd_opts_last nd_opt_each.last 335 #define nd_opts_done nd_opt_each.done 336 337 /* XXX: need nd6_var.h?? */ 338 /* nd6.c */ 339 void nd6_init(void); 340 #ifdef VIMAGE 341 void nd6_destroy(void); 342 #endif 343 void nd6_ifattach(struct ifnet *); 344 void nd6_ifdetach(struct ifnet *); 345 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *); 346 void nd6_option_init(void *, int, union nd_opts *); 347 struct nd_opt_hdr *nd6_option(union nd_opts *); 348 int nd6_options(union nd_opts *); 349 struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *); 350 void nd6_setmtu(struct ifnet *); 351 void nd6_llinfo_setstate(struct llentry *lle, int newstate); 352 void nd6_timer(void *); 353 void nd6_purge(struct ifnet *); 354 int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst, 355 char *desten, uint32_t *pflags); 356 int nd6_resolve(struct ifnet *, int, struct mbuf *, 357 const struct sockaddr *, u_char *, uint32_t *, struct llentry **); 358 int nd6_ioctl(u_long, caddr_t, struct ifnet *); 359 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 360 char *, int, int, int); 361 bool nd6_try_set_entry_addr(struct ifnet *ifp, struct llentry *lle, char *lladdr); 362 struct mbuf *nd6_grab_holdchain(struct llentry *); 363 int nd6_flush_holdchain(struct ifnet *, struct llentry *, struct mbuf *); 364 void nd6_flush_children_holdchain(struct ifnet *, struct llentry *); 365 int nd6_add_ifa_lle(struct in6_ifaddr *); 366 void nd6_rem_ifa_lle(struct in6_ifaddr *, int); 367 int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *, 368 struct sockaddr_in6 *, struct route *); 369 370 struct rib_head; 371 struct rib_cmd_info; 372 void nd6_subscription_cb(struct rib_head *rnh, struct rib_cmd_info *rc, 373 void *arg); 374 375 /* nd6_nbr.c */ 376 void nd6_na_input(struct mbuf *, int, int); 377 void nd6_na_output(struct ifnet *, const struct in6_addr *, 378 const struct in6_addr *, u_long, int, struct sockaddr *); 379 void nd6_ns_input(struct mbuf *, int, int); 380 void nd6_ns_output(struct ifnet *, const struct in6_addr *, 381 const struct in6_addr *, const struct in6_addr *, uint8_t *); 382 caddr_t nd6_ifptomac(struct ifnet *); 383 void nd6_dad_init(void); 384 void nd6_dad_start(struct ifaddr *, int); 385 void nd6_dad_stop(struct ifaddr *); 386 void nd6_grand_start(struct ifaddr *, uint32_t); 387 void nd6_queue_stop(struct ifaddr *); 388 389 /* nd6_rtr.c */ 390 void nd6_rs_input(struct mbuf *, int, int); 391 void nd6_ra_input(struct mbuf *, int, int); 392 void nd6_ifnet_link_event(void *, struct ifnet *, int); 393 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *); 394 struct nd_defrouter *defrouter_lookup_locked(const struct in6_addr *, 395 struct ifnet *); 396 void defrouter_reset(void); 397 void defrouter_select_fib(int fibnum); 398 void defrouter_rele(struct nd_defrouter *); 399 bool defrouter_remove(struct in6_addr *, struct ifnet *); 400 bool nd6_defrouter_list_empty(void); 401 void nd6_defrouter_flush_all(void); 402 void nd6_defrouter_purge(struct ifnet *); 403 void nd6_defrouter_timer(void); 404 void nd6_defrouter_init(void); 405 int nd6_prelist_add(struct nd_prefixctl *, struct nd_prefix **); 406 void nd6_prefix_unlink(struct nd_prefix *, struct nd_prhead *); 407 void nd6_prefix_del(struct nd_prefix *); 408 void nd6_prefix_ref(struct nd_prefix *); 409 void nd6_prefix_rele(struct nd_prefix *); 410 int nd6_prefix_offlink(struct nd_prefix *); 411 void pfxlist_onlink_check(void); 412 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *); 413 void rt6_flush(struct in6_addr *, struct ifnet *); 414 int nd6_setdefaultiface(int); 415 int in6_tmpifadd(const struct in6_ifaddr *, int, int); 416 417 #endif /* _KERNEL */ 418 419 #endif /* _NETINET6_ND6_H_ */ 420