nd6.h revision 306573
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: stable/11/sys/netinet6/nd6.h 306573 2016-10-02 01:16:02Z markj $ 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 44struct 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 64struct 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#define ND6_IFF_NO_DAD 0x100 91 92#ifdef _KERNEL 93#define ND_IFINFO(ifp) \ 94 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo) 95#define IN6_LINKMTU(ifp) \ 96 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \ 97 ? ND_IFINFO(ifp)->linkmtu \ 98 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \ 99 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu)) 100#endif 101 102struct in6_nbrinfo { 103 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 104 struct in6_addr addr; /* IPv6 address of the neighbor */ 105 long asked; /* number of queries already sent for this addr */ 106 int isrouter; /* if it acts as a router */ 107 int state; /* reachability state */ 108 int expire; /* lifetime for NDP state transition */ 109}; 110 111#define DRLSTSIZ 10 112#define PRLSTSIZ 10 113struct in6_drlist { 114 char ifname[IFNAMSIZ]; 115 struct { 116 struct in6_addr rtaddr; 117 u_char flags; 118 u_short rtlifetime; 119 u_long expire; 120 u_short if_index; 121 } defrouter[DRLSTSIZ]; 122}; 123 124struct in6_defrouter { 125 struct sockaddr_in6 rtaddr; 126 u_char flags; 127 u_short rtlifetime; 128 u_long expire; 129 u_short if_index; 130}; 131 132#ifdef _KERNEL 133struct in6_oprlist { 134 char ifname[IFNAMSIZ]; 135 struct { 136 struct in6_addr prefix; 137 struct prf_ra raflags; 138 u_char prefixlen; 139 u_char origin; 140 u_long vltime; 141 u_long pltime; 142 u_long expire; 143 u_short if_index; 144 u_short advrtrs; /* number of advertisement routers */ 145 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 146 } prefix[PRLSTSIZ]; 147}; 148#endif 149 150struct 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 166struct in6_prefix { 167 struct sockaddr_in6 prefix; 168 struct prf_ra raflags; 169 u_char prefixlen; 170 u_char origin; 171 u_int32_t vltime; 172 u_int32_t pltime; 173 time_t 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 182struct 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 198struct in6_ndireq { 199 char ifname[IFNAMSIZ]; 200 struct nd_ifinfo ndi; 201}; 202 203struct 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)) + (arc4random() & \ 232 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 233 234TAILQ_HEAD(nd_drhead, nd_defrouter); 235struct nd_defrouter { 236 TAILQ_ENTRY(nd_defrouter) dr_entry; 237 struct in6_addr rtaddr; 238 u_char raflags; /* flags on RA message */ 239 u_short rtlifetime; 240 u_long expire; 241 struct ifnet *ifp; 242 int installed; /* is installed into kernel routing table */ 243 u_int refcnt; 244}; 245 246struct nd_prefixctl { 247 struct ifnet *ndpr_ifp; 248 249 /* prefix */ 250 struct sockaddr_in6 ndpr_prefix; 251 u_char ndpr_plen; 252 253 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 254 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 255 256 struct prf_ra ndpr_flags; 257}; 258 259 260struct nd_prefix { 261 struct ifnet *ndpr_ifp; 262 LIST_ENTRY(nd_prefix) ndpr_entry; 263 struct sockaddr_in6 ndpr_prefix; /* prefix */ 264 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 265 266 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 267 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 268 269 time_t ndpr_expire; /* expiration time of the prefix */ 270 time_t ndpr_preferred; /* preferred time of the prefix */ 271 time_t ndpr_lastupdate; /* reception time of last advertisement */ 272 273 struct prf_ra ndpr_flags; 274 u_int32_t ndpr_stateflags; /* actual state flags */ 275 /* list of routers that advertise the prefix: */ 276 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 277 u_char ndpr_plen; 278 int ndpr_addrcnt; /* count of derived addresses */ 279}; 280 281#define ndpr_raf ndpr_flags 282#define ndpr_raf_onlink ndpr_flags.onlink 283#define ndpr_raf_auto ndpr_flags.autonomous 284#define ndpr_raf_router ndpr_flags.router 285 286/* 287 * Message format for use in obtaining information about prefixes 288 * from inet6 sysctl function 289 */ 290struct inet6_ndpr_msghdr { 291 u_short inpm_msglen; /* to skip over non-understood messages */ 292 u_char inpm_version; /* future binary compatibility */ 293 u_char inpm_type; /* message type */ 294 struct in6_addr inpm_prefix; 295 u_long prm_vltim; 296 u_long prm_pltime; 297 u_long prm_expire; 298 u_long prm_preferred; 299 struct in6_prflags prm_flags; 300 u_short prm_index; /* index for associated ifp */ 301 u_char prm_plen; /* length of prefix in bits */ 302}; 303 304#define prm_raf_onlink prm_flags.prf_ra.onlink 305#define prm_raf_auto prm_flags.prf_ra.autonomous 306 307#define prm_statef_onlink prm_flags.prf_state.onlink 308 309#define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 310#define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 311 312struct nd_pfxrouter { 313 LIST_ENTRY(nd_pfxrouter) pfr_entry; 314 struct nd_defrouter *router; 315}; 316 317LIST_HEAD(nd_prhead, nd_prefix); 318 319#ifdef MALLOC_DECLARE 320MALLOC_DECLARE(M_IP6NDP); 321#endif 322 323/* nd6.c */ 324VNET_DECLARE(int, nd6_prune); 325VNET_DECLARE(int, nd6_delay); 326VNET_DECLARE(int, nd6_umaxtries); 327VNET_DECLARE(int, nd6_mmaxtries); 328VNET_DECLARE(int, nd6_useloopback); 329VNET_DECLARE(int, nd6_maxnudhint); 330VNET_DECLARE(int, nd6_gctimer); 331VNET_DECLARE(struct nd_drhead, nd_defrouter); 332VNET_DECLARE(struct nd_prhead, nd_prefix); 333VNET_DECLARE(int, nd6_debug); 334VNET_DECLARE(int, nd6_onlink_ns_rfc4861); 335#define V_nd6_prune VNET(nd6_prune) 336#define V_nd6_delay VNET(nd6_delay) 337#define V_nd6_umaxtries VNET(nd6_umaxtries) 338#define V_nd6_mmaxtries VNET(nd6_mmaxtries) 339#define V_nd6_useloopback VNET(nd6_useloopback) 340#define V_nd6_maxnudhint VNET(nd6_maxnudhint) 341#define V_nd6_gctimer VNET(nd6_gctimer) 342#define V_nd_defrouter VNET(nd_defrouter) 343#define V_nd_prefix VNET(nd_prefix) 344#define V_nd6_debug VNET(nd6_debug) 345#define V_nd6_onlink_ns_rfc4861 VNET(nd6_onlink_ns_rfc4861) 346 347/* Lock for the prefix and default router lists. */ 348VNET_DECLARE(struct rwlock, nd6_lock); 349#define V_nd6_lock VNET(nd6_lock) 350 351#define ND6_RLOCK() rw_rlock(&V_nd6_lock) 352#define ND6_RUNLOCK() rw_runlock(&V_nd6_lock) 353#define ND6_WLOCK() rw_wlock(&V_nd6_lock) 354#define ND6_WUNLOCK() rw_wunlock(&V_nd6_lock) 355#define ND6_WLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_WLOCKED) 356#define ND6_RLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_RLOCKED) 357#define ND6_LOCK_ASSERT() rw_assert(&V_nd6_lock, RA_LOCKED) 358#define ND6_UNLOCK_ASSERT() rw_assert(&V_nd6_lock, RA_UNLOCKED) 359 360#define nd6log(x) do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0) 361 362/* nd6_rtr.c */ 363VNET_DECLARE(int, nd6_defifindex); 364VNET_DECLARE(int, ip6_desync_factor); /* seconds */ 365VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */ 366VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */ 367VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */ 368#define V_nd6_defifindex VNET(nd6_defifindex) 369#define V_ip6_desync_factor VNET(ip6_desync_factor) 370#define V_ip6_temp_preferred_lifetime VNET(ip6_temp_preferred_lifetime) 371#define V_ip6_temp_valid_lifetime VNET(ip6_temp_valid_lifetime) 372#define V_ip6_temp_regen_advance VNET(ip6_temp_regen_advance) 373 374union nd_opts { 375 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */ 376 struct { 377 struct nd_opt_hdr *zero; 378 struct nd_opt_hdr *src_lladdr; 379 struct nd_opt_hdr *tgt_lladdr; 380 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 381 struct nd_opt_rd_hdr *rh; 382 struct nd_opt_mtu *mtu; 383 struct nd_opt_hdr *__res6; 384 struct nd_opt_hdr *__res7; 385 struct nd_opt_hdr *__res8; 386 struct nd_opt_hdr *__res9; 387 struct nd_opt_hdr *__res10; 388 struct nd_opt_hdr *__res11; 389 struct nd_opt_hdr *__res12; 390 struct nd_opt_hdr *__res13; 391 struct nd_opt_nonce *nonce; 392 struct nd_opt_hdr *__res15; 393 struct nd_opt_hdr *search; /* multiple opts */ 394 struct nd_opt_hdr *last; /* multiple opts */ 395 int done; 396 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 397 } nd_opt_each; 398}; 399#define nd_opts_src_lladdr nd_opt_each.src_lladdr 400#define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 401#define nd_opts_pi nd_opt_each.pi_beg 402#define nd_opts_pi_end nd_opt_each.pi_end 403#define nd_opts_rh nd_opt_each.rh 404#define nd_opts_mtu nd_opt_each.mtu 405#define nd_opts_nonce nd_opt_each.nonce 406#define nd_opts_search nd_opt_each.search 407#define nd_opts_last nd_opt_each.last 408#define nd_opts_done nd_opt_each.done 409 410/* XXX: need nd6_var.h?? */ 411/* nd6.c */ 412void nd6_init(void); 413#ifdef VIMAGE 414void nd6_destroy(void); 415#endif 416struct nd_ifinfo *nd6_ifattach(struct ifnet *); 417void nd6_ifdetach(struct ifnet *, struct nd_ifinfo *); 418int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *); 419void nd6_option_init(void *, int, union nd_opts *); 420struct nd_opt_hdr *nd6_option(union nd_opts *); 421int nd6_options(union nd_opts *); 422struct llentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *); 423struct llentry *nd6_alloc(const struct in6_addr *, int, struct ifnet *); 424void nd6_setmtu(struct ifnet *); 425void nd6_llinfo_setstate(struct llentry *lle, int newstate); 426void nd6_timer(void *); 427void nd6_purge(struct ifnet *); 428int nd6_resolve_addr(struct ifnet *ifp, int flags, const struct sockaddr *dst, 429 char *desten, uint32_t *pflags); 430int nd6_resolve(struct ifnet *, int, struct mbuf *, 431 const struct sockaddr *, u_char *, uint32_t *, struct llentry **); 432int nd6_ioctl(u_long, caddr_t, struct ifnet *); 433void nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 434 char *, int, int, int); 435void nd6_grab_holdchain(struct llentry *, struct mbuf **, 436 struct sockaddr_in6 *); 437int nd6_flush_holdchain(struct ifnet *, struct ifnet *, struct mbuf *, 438 struct sockaddr_in6 *); 439int nd6_add_ifa_lle(struct in6_ifaddr *); 440void nd6_rem_ifa_lle(struct in6_ifaddr *, int); 441int nd6_output_ifp(struct ifnet *, struct ifnet *, struct mbuf *, 442 struct sockaddr_in6 *, struct route *); 443 444/* nd6_nbr.c */ 445void nd6_na_input(struct mbuf *, int, int); 446void nd6_na_output(struct ifnet *, const struct in6_addr *, 447 const struct in6_addr *, u_long, int, struct sockaddr *); 448void nd6_ns_input(struct mbuf *, int, int); 449void nd6_ns_output(struct ifnet *, const struct in6_addr *, 450 const struct in6_addr *, const struct in6_addr *, uint8_t *); 451caddr_t nd6_ifptomac(struct ifnet *); 452void nd6_dad_init(void); 453void nd6_dad_start(struct ifaddr *, int); 454void nd6_dad_stop(struct ifaddr *); 455 456/* nd6_rtr.c */ 457void nd6_rs_input(struct mbuf *, int, int); 458void nd6_ra_input(struct mbuf *, int, int); 459void defrouter_reset(void); 460void defrouter_select(void); 461void defrouter_ref(struct nd_defrouter *); 462void defrouter_rele(struct nd_defrouter *); 463bool defrouter_remove(struct in6_addr *, struct ifnet *); 464void defrouter_unlink(struct nd_defrouter *, struct nd_drhead *); 465void defrouter_del(struct nd_defrouter *); 466void prelist_remove(struct nd_prefix *); 467int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *, 468 struct nd_prefix **); 469void pfxlist_onlink_check(void); 470struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *); 471struct nd_defrouter *defrouter_lookup_locked(struct in6_addr *, struct ifnet *); 472struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *); 473void rt6_flush(struct in6_addr *, struct ifnet *); 474int nd6_setdefaultiface(int); 475int in6_tmpifadd(const struct in6_ifaddr *, int, int); 476 477#endif /* _KERNEL */ 478 479#endif /* _NETINET6_ND6_H_ */ 480