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