1 /* $NetBSD: nd6.h,v 1.72 2016/04/04 07:37:07 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 /* 42 * We don't need the WAITDELETE state any more, but we keep the definition 43 * in a comment line instead of removing it. This is necessary to avoid 44 * unintentionally reusing the value for another purpose, which might 45 * affect backward compatibility with old applications. 46 * (20000711 jinmei@kame.net) 47 */ 48 /* #define ND6_LLINFO_WAITDELETE -1 */ 49 #define ND6_LLINFO_INCOMPLETE 0 50 #define ND6_LLINFO_REACHABLE 1 51 #define ND6_LLINFO_STALE 2 52 #define ND6_LLINFO_DELAY 3 53 #define ND6_LLINFO_PROBE 4 54 55 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 56 #define ND6_LLINFO_PERMANENT(n) (((n)->ln_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE)) 57 58 struct nd_ifinfo { 59 u_int32_t linkmtu; /* LinkMTU */ 60 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 61 u_int32_t basereachable; /* BaseReachableTime */ 62 u_int32_t reachable; /* Reachable Time */ 63 u_int32_t retrans; /* Retrans Timer */ 64 u_int32_t flags; /* Flags */ 65 int recalctm; /* BaseReacable re-calculation timer */ 66 u_int8_t chlim; /* CurHopLimit */ 67 u_int8_t initialized; /* Flag to see the entry is initialized */ 68 /* the following 3 members are for privacy extension for addrconf */ 69 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 70 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 71 u_int8_t randomid[8]; /* current random ID */ 72 }; 73 74 #define ND6_IFF_PERFORMNUD 0x01 75 #define ND6_IFF_ACCEPT_RTADV 0x02 /* See "RTADV Key", below. */ 76 #define ND6_IFF_PREFER_SOURCE 0x04 /* XXX: not related to ND. */ 77 #define ND6_IFF_IFDISABLED 0x08 /* IPv6 operation is disabled due to 78 * DAD failure. (XXX: not ND-specific) 79 */ 80 #define ND6_IFF_OVERRIDE_RTADV 0x10 /* See "RTADV Key", below. */ 81 #define ND6_IFF_AUTO_LINKLOCAL 0x20 82 83 /* 84 * RTADV Key 85 * 86 * The flags ND6_IFF_ACCEPT_RTADV and ND6_IFF_OVERRIDE_RTADV form a 87 * tri-state variable. (There are actually four different states, but 88 * two of the states are functionally identical.) 89 * 90 * ND6_IFF_OVERRIDE_RTADV or 0: This interface does not accept 91 * Router Advertisements. 92 * 93 * ND6_IFF_OVERRIDE_RTADV| 94 * ND6_IFF_ACCEPT_RTADV: This interface accepts Router 95 * Advertisements regardless of the 96 * global setting, ip6_accept_rtadv. 97 * 98 * ND6_IFF_ACCEPT_RTADV: This interface follows the global setting, 99 * ip6_accept_rtadv. If ip6_accept_rtadv == 0, 100 * this interface does not accept Router 101 * Advertisements. If ip6_accept_rtadv != 0, 102 * this interface does accept them. 103 */ 104 105 #ifdef _KERNEL 106 #define ND_IFINFO(ifp) \ 107 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo) 108 #define IN6_LINKMTU(ifp) \ 109 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \ 110 ? ND_IFINFO(ifp)->linkmtu \ 111 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \ 112 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu)) 113 #endif 114 115 struct in6_nbrinfo { 116 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 117 struct in6_addr addr; /* IPv6 address of the neighbor */ 118 long asked; /* number of queries already sent for this addr */ 119 int isrouter; /* if it acts as a router */ 120 int state; /* reachability state */ 121 int expire; /* lifetime for NDP state transition */ 122 }; 123 124 #define DRLSTSIZ 10 125 #define PRLSTSIZ 10 126 struct in6_drlist { 127 char ifname[IFNAMSIZ]; 128 struct { 129 struct in6_addr rtaddr; 130 u_char flags; 131 u_short rtlifetime; 132 u_long expire; 133 u_short if_index; 134 } defrouter[DRLSTSIZ]; 135 }; 136 137 struct in6_defrouter { 138 struct sockaddr_in6 rtaddr; 139 u_char flags; 140 u_short rtlifetime; 141 u_long expire; 142 u_short if_index; 143 }; 144 145 #ifdef _KERNEL 146 struct in6_oprlist { 147 char ifname[IFNAMSIZ]; 148 struct { 149 struct in6_addr prefix; 150 struct prf_ra raflags; 151 u_char prefixlen; 152 u_char origin; 153 u_long vltime; 154 u_long pltime; 155 u_long expire; 156 u_short if_index; 157 u_short advrtrs; /* number of advertisement routers */ 158 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 159 } prefix[PRLSTSIZ]; 160 }; 161 #endif 162 163 struct in6_prlist { 164 char ifname[IFNAMSIZ]; 165 struct { 166 struct in6_addr prefix; 167 struct prf_ra raflags; 168 u_char prefixlen; 169 u_char origin; 170 u_int32_t vltime; 171 u_int32_t pltime; 172 time_t expire; 173 u_short if_index; 174 u_short advrtrs; /* number of advertisement routers */ 175 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 176 } prefix[PRLSTSIZ]; 177 }; 178 179 struct in6_prefix { 180 struct sockaddr_in6 prefix; 181 struct prf_ra raflags; 182 u_char prefixlen; 183 u_char origin; 184 u_int32_t vltime; 185 u_int32_t pltime; 186 time_t expire; 187 u_int32_t flags; 188 int refcnt; 189 u_short if_index; 190 u_short advrtrs; /* number of advertisement routers */ 191 /* struct sockaddr_in6 advrtr[] */ 192 }; 193 194 #ifdef _KERNEL 195 struct in6_ondireq { 196 char ifname[IFNAMSIZ]; 197 struct { 198 u_int32_t linkmtu; /* LinkMTU */ 199 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 200 u_int32_t basereachable; /* BaseReachableTime */ 201 u_int32_t reachable; /* Reachable Time */ 202 u_int32_t retrans; /* Retrans Timer */ 203 u_int32_t flags; /* Flags */ 204 int recalctm; /* BaseReacable re-calculation timer */ 205 u_int8_t chlim; /* CurHopLimit */ 206 u_int8_t receivedra; 207 } ndi; 208 }; 209 #endif 210 211 struct in6_ndireq { 212 char ifname[IFNAMSIZ]; 213 struct nd_ifinfo ndi; 214 }; 215 216 struct in6_ndifreq { 217 char ifname[IFNAMSIZ]; 218 u_long ifindex; 219 }; 220 221 /* Prefix status */ 222 #define NDPRF_ONLINK 0x1 223 #define NDPRF_DETACHED 0x2 224 #define NDPRF_HOME 0x4 225 226 /* protocol constants */ 227 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 228 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 229 #define MAX_RTR_SOLICITATIONS 3 230 231 #define ND6_INFINITE_LIFETIME ((u_int32_t)~0) 232 233 #ifdef _KERNEL 234 /* node constants */ 235 #define MAX_REACHABLE_TIME 3600000 /* msec */ 236 #define REACHABLE_TIME 30000 /* msec */ 237 #define RETRANS_TIMER 1000 /* msec */ 238 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 239 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 240 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */ 241 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 242 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 243 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */ 244 #define ND_COMPUTE_RTIME(x) \ 245 (((MIN_RANDOM_FACTOR * (x >> 10)) + (cprng_fast32() & \ 246 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 247 248 TAILQ_HEAD(nd_drhead, nd_defrouter); 249 struct nd_defrouter { 250 TAILQ_ENTRY(nd_defrouter) dr_entry; 251 struct in6_addr rtaddr; 252 u_char flags; /* flags on RA message */ 253 u_short rtlifetime; 254 u_long expire; 255 struct ifnet *ifp; 256 int installed; /* is installed into kernel routing table */ 257 }; 258 259 struct nd_prefixctl { 260 struct ifnet *ndprc_ifp; 261 262 /* prefix */ 263 struct sockaddr_in6 ndprc_prefix; 264 u_char ndprc_plen; 265 266 u_int32_t ndprc_vltime; /* advertised valid lifetime */ 267 u_int32_t ndprc_pltime; /* advertised preferred lifetime */ 268 269 struct prf_ra ndprc_flags; 270 }; 271 272 #define ndprc_raf ndprc_flags 273 #define ndprc_raf_onlink ndprc_flags.onlink 274 #define ndprc_raf_auto ndprc_flags.autonomous 275 #define ndprc_raf_router ndprc_flags.router 276 277 struct nd_prefix { 278 struct ifnet *ndpr_ifp; 279 LIST_ENTRY(nd_prefix) ndpr_entry; 280 struct sockaddr_in6 ndpr_prefix; /* prefix */ 281 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 282 283 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 284 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 285 286 time_t ndpr_expire; /* expiration time of the prefix */ 287 time_t ndpr_preferred; /* preferred time of the prefix */ 288 time_t ndpr_lastupdate; /* reception time of last advertisement */ 289 290 struct prf_ra ndpr_flags; 291 u_int32_t ndpr_stateflags; /* actual state flags */ 292 /* list of routers that advertise the prefix: */ 293 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 294 u_char ndpr_plen; 295 int ndpr_refcnt; /* reference couter from addresses */ 296 }; 297 298 #define ndpr_next ndpr_entry.le_next 299 300 #define ndpr_raf ndpr_flags 301 #define ndpr_raf_onlink ndpr_flags.onlink 302 #define ndpr_raf_auto ndpr_flags.autonomous 303 #define ndpr_raf_router ndpr_flags.router 304 305 /* 306 * Message format for use in obtaining information about prefixes 307 * from inet6 sysctl function 308 */ 309 struct inet6_ndpr_msghdr { 310 u_short inpm_msglen; /* to skip over non-understood messages */ 311 u_char inpm_version; /* future binary compatibility */ 312 u_char inpm_type; /* message type */ 313 struct in6_addr inpm_prefix; 314 u_long prm_vltim; 315 u_long prm_pltime; 316 u_long prm_expire; 317 u_long prm_preferred; 318 struct in6_prflags prm_flags; 319 u_short prm_index; /* index for associated ifp */ 320 u_char prm_plen; /* length of prefix in bits */ 321 }; 322 323 #define prm_raf_onlink prm_flags.prf_ra.onlink 324 #define prm_raf_auto prm_flags.prf_ra.autonomous 325 326 #define prm_statef_onlink prm_flags.prf_state.onlink 327 328 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 329 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 330 331 struct nd_pfxrouter { 332 LIST_ENTRY(nd_pfxrouter) pfr_entry; 333 struct nd_defrouter *router; 334 }; 335 336 LIST_HEAD(nd_prhead, nd_prefix); 337 338 #include <sys/mallocvar.h> 339 MALLOC_DECLARE(M_IP6NDP); 340 341 /* nd6.c */ 342 extern int nd6_prune; 343 extern int nd6_delay; 344 extern int nd6_umaxtries; 345 extern int nd6_mmaxtries; 346 extern int nd6_useloopback; 347 extern int nd6_maxnudhint; 348 extern int nd6_gctimer; 349 extern struct nd_drhead nd_defrouter; 350 extern struct nd_prhead nd_prefix; 351 extern int nd6_debug; 352 353 #define nd6log(level, fmt, args...) \ 354 do { if (nd6_debug) log(level, "%s: " fmt, __func__, ##args);} while (0) 355 356 /* nd6_rtr.c */ 357 extern int nd6_defifindex; 358 extern int ip6_desync_factor; /* seconds */ 359 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */ 360 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */ 361 extern int ip6_temp_regen_advance; /* seconds */ 362 extern int nd6_numroutes; 363 364 union nd_opts { 365 struct nd_opt_hdr *nd_opt_array[8]; 366 struct { 367 struct nd_opt_hdr *zero; 368 struct nd_opt_hdr *src_lladdr; 369 struct nd_opt_hdr *tgt_lladdr; 370 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 371 struct nd_opt_rd_hdr *rh; 372 struct nd_opt_mtu *mtu; 373 struct nd_opt_hdr *search; /* multiple opts */ 374 struct nd_opt_hdr *last; /* multiple opts */ 375 int done; 376 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 377 } nd_opt_each; 378 }; 379 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 380 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 381 #define nd_opts_pi nd_opt_each.pi_beg 382 #define nd_opts_pi_end nd_opt_each.pi_end 383 #define nd_opts_rh nd_opt_each.rh 384 #define nd_opts_mtu nd_opt_each.mtu 385 #define nd_opts_search nd_opt_each.search 386 #define nd_opts_last nd_opt_each.last 387 #define nd_opts_done nd_opt_each.done 388 389 #include <net/if_llatbl.h> 390 391 /* XXX: need nd6_var.h?? */ 392 /* nd6.c */ 393 void nd6_init(void); 394 struct nd_ifinfo *nd6_ifattach(struct ifnet *); 395 void nd6_ifdetach(struct ifnet *, struct in6_ifextra *); 396 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *); 397 void nd6_option_init(void *, int, union nd_opts *); 398 struct nd_opt_hdr *nd6_option(union nd_opts *); 399 int nd6_options(union nd_opts *); 400 struct llentry *nd6_lookup(const struct in6_addr *, const struct ifnet *, bool); 401 struct llentry *nd6_create(const struct in6_addr *, const struct ifnet *); 402 void nd6_setmtu(struct ifnet *); 403 void nd6_llinfo_settimer(struct llentry *, time_t); 404 void nd6_purge(struct ifnet *, struct in6_ifextra *); 405 void nd6_nud_hint(struct rtentry *); 406 int nd6_resolve(struct ifnet *, struct rtentry *, 407 struct mbuf *, struct sockaddr *, u_char *); 408 void nd6_rtrequest(int, struct rtentry *, const struct rt_addrinfo *); 409 int nd6_ioctl(u_long, void *, struct ifnet *); 410 void nd6_cache_lladdr(struct ifnet *, struct in6_addr *, 411 char *, int, int, int); 412 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *, 413 const struct sockaddr_in6 *, struct rtentry *); 414 int nd6_storelladdr(const struct ifnet *, const struct rtentry *, struct mbuf *, 415 const struct sockaddr *, uint8_t *, size_t); 416 int nd6_sysctl(int, void *, size_t *, void *, size_t); 417 int nd6_need_cache(struct ifnet *); 418 void nd6_llinfo_release_pkts(struct llentry *, struct ifnet *); 419 int nd6_add_ifa_lle(struct in6_ifaddr *); 420 void nd6_rem_ifa_lle(struct in6_ifaddr *); 421 422 /* nd6_nbr.c */ 423 void nd6_na_input(struct mbuf *, int, int); 424 void nd6_na_output(struct ifnet *, const struct in6_addr *, 425 const struct in6_addr *, u_long, int, const struct sockaddr *); 426 void nd6_ns_input(struct mbuf *, int, int); 427 void nd6_ns_output(struct ifnet *, const struct in6_addr *, 428 const struct in6_addr *, struct in6_addr *, int); 429 const void *nd6_ifptomac(const struct ifnet *); 430 void nd6_dad_start(struct ifaddr *, int); 431 void nd6_dad_stop(struct ifaddr *); 432 void nd6_dad_duplicated(struct ifaddr *); 433 434 /* nd6_rtr.c */ 435 void nd6_rs_input(struct mbuf *, int, int); 436 void nd6_ra_input(struct mbuf *, int, int); 437 void prelist_del(struct nd_prefix *); 438 void defrouter_addreq(struct nd_defrouter *); 439 void defrouter_reset(void); 440 void defrouter_select(void); 441 void defrtrlist_del(struct nd_defrouter *, struct in6_ifextra *); 442 void prelist_remove(struct nd_prefix *); 443 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *, 444 struct nd_prefix **); 445 int nd6_prefix_onlink(struct nd_prefix *); 446 int nd6_prefix_offlink(struct nd_prefix *); 447 void pfxlist_onlink_check(void); 448 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *); 449 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *); 450 int in6_ifdel(struct ifnet *, struct in6_addr *); 451 void rt6_flush(struct in6_addr *, struct ifnet *); 452 int nd6_setdefaultiface(int); 453 int in6_tmpifadd(const struct in6_ifaddr *, int, int); 454 bool nd6_accepts_rtadv(const struct nd_ifinfo *); 455 456 #endif /* _KERNEL */ 457 458 #endif /* !_NETINET6_ND6_H_ */ 459