nd6.h revision 121575
1/* $FreeBSD: head/sys/netinet6/nd6.h 121575 2003-10-26 15:06:06Z ume $ */ 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 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)) + (random() & \ 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 flags; /* flags on RA message */ 239 u_short rtlifetime; 240 u_long expire; 241 struct ifnet *ifp; 242}; 243 244struct nd_prefix { 245 struct ifnet *ndpr_ifp; 246 LIST_ENTRY(nd_prefix) ndpr_entry; 247 struct sockaddr_in6 ndpr_prefix; /* prefix */ 248 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 249 struct in6_addr ndpr_addr; /* address that is derived from the prefix */ 250 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 251 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 252 time_t ndpr_expire; /* expiration time of the prefix */ 253 time_t ndpr_preferred; /* preferred time of the prefix */ 254 struct prf_ra ndpr_flags; 255 u_int32_t ndpr_stateflags; /* actual state flags */ 256 /* list of routers that advertise the prefix: */ 257 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 258 u_char ndpr_plen; 259 int ndpr_refcnt; /* reference couter from addresses */ 260}; 261 262#define ndpr_next ndpr_entry.le_next 263 264#define ndpr_raf ndpr_flags 265#define ndpr_raf_onlink ndpr_flags.onlink 266#define ndpr_raf_auto ndpr_flags.autonomous 267 268/* 269 * We keep expired prefix for certain amount of time, for validation purposes. 270 * 1800s = MaxRtrAdvInterval 271 */ 272#define NDPR_KEEP_EXPIRED (1800 * 2) 273 274/* 275 * Message format for use in obtaining information about prefixes 276 * from inet6 sysctl function 277 */ 278struct inet6_ndpr_msghdr { 279 u_short inpm_msglen; /* to skip over non-understood messages */ 280 u_char inpm_version; /* future binary compatibility */ 281 u_char inpm_type; /* message type */ 282 struct in6_addr inpm_prefix; 283 u_long prm_vltim; 284 u_long prm_pltime; 285 u_long prm_expire; 286 u_long prm_preferred; 287 struct in6_prflags prm_flags; 288 u_short prm_index; /* index for associated ifp */ 289 u_char prm_plen; /* length of prefix in bits */ 290}; 291 292#define prm_raf_onlink prm_flags.prf_ra.onlink 293#define prm_raf_auto prm_flags.prf_ra.autonomous 294 295#define prm_statef_onlink prm_flags.prf_state.onlink 296 297#define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 298#define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 299 300#define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr)) 301#define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr)) 302 303struct nd_pfxrouter { 304 LIST_ENTRY(nd_pfxrouter) pfr_entry; 305#define pfr_next pfr_entry.le_next 306 struct nd_defrouter *router; 307}; 308 309LIST_HEAD(nd_prhead, nd_prefix); 310 311/* nd6.c */ 312extern int nd6_prune; 313extern int nd6_delay; 314extern int nd6_umaxtries; 315extern int nd6_mmaxtries; 316extern int nd6_useloopback; 317extern int nd6_maxnudhint; 318extern int nd6_gctimer; 319extern struct llinfo_nd6 llinfo_nd6; 320extern struct nd_ifinfo *nd_ifinfo; 321extern struct nd_drhead nd_defrouter; 322extern struct nd_prhead nd_prefix; 323extern int nd6_debug; 324 325#define nd6log(x) do { if (nd6_debug) log x; } while (/*CONSTCOND*/ 0) 326 327extern struct callout nd6_timer_ch; 328 329/* nd6_rtr.c */ 330extern int nd6_defifindex; 331extern int ip6_desync_factor; /* seconds */ 332extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */ 333extern u_int32_t ip6_temp_valid_lifetime; /* seconds */ 334extern int ip6_temp_regen_advance; /* seconds */ 335 336union nd_opts { 337 struct nd_opt_hdr *nd_opt_array[8]; /* max = target address list */ 338 struct { 339 struct nd_opt_hdr *zero; 340 struct nd_opt_hdr *src_lladdr; 341 struct nd_opt_hdr *tgt_lladdr; 342 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 343 struct nd_opt_rd_hdr *rh; 344 struct nd_opt_mtu *mtu; 345 struct nd_opt_hdr *search; /* multiple opts */ 346 struct nd_opt_hdr *last; /* multiple opts */ 347 int done; 348 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 349 } nd_opt_each; 350}; 351#define nd_opts_src_lladdr nd_opt_each.src_lladdr 352#define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 353#define nd_opts_pi nd_opt_each.pi_beg 354#define nd_opts_pi_end nd_opt_each.pi_end 355#define nd_opts_rh nd_opt_each.rh 356#define nd_opts_mtu nd_opt_each.mtu 357#define nd_opts_adv nd_opt_each.adv 358#define nd_opts_hai nd_opt_each.hai 359#define nd_opts_src_addrlist nd_opt_each.src_addrlist 360#define nd_opts_tgt_addrlist nd_opt_each.tgt_addrlist 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