1 /* $NetBSD: nd6.h,v 1.21 2001/06/11 01:50:57 wiz Exp $ */ 2 /* $KAME: nd6.h,v 1.52 2001/02/19 04:40:37 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 44 struct 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 73 struct 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 receivedra; 83 }; 84 85 #define ND6_IFF_PERFORMNUD 0x1 86 87 struct in6_nbrinfo { 88 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 89 struct in6_addr addr; /* IPv6 address of the neighbor */ 90 long asked; /* number of queries already sent for this addr */ 91 int isrouter; /* if it acts as a router */ 92 int state; /* reachability state */ 93 int expire; /* lifetime for NDP state transition */ 94 }; 95 96 #define DRLSTSIZ 10 97 #define PRLSTSIZ 10 98 struct in6_drlist { 99 char ifname[IFNAMSIZ]; 100 struct { 101 struct in6_addr rtaddr; 102 u_char flags; 103 u_short rtlifetime; 104 u_long expire; 105 u_short if_index; 106 } defrouter[DRLSTSIZ]; 107 }; 108 109 struct in6_prlist { 110 char ifname[IFNAMSIZ]; 111 struct { 112 struct in6_addr prefix; 113 struct prf_ra raflags; 114 u_char prefixlen; 115 u_char origin; 116 u_long vltime; 117 u_long pltime; 118 u_long expire; 119 u_short if_index; 120 u_short advrtrs; /* number of advertisement routers */ 121 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 122 } prefix[PRLSTSIZ]; 123 }; 124 125 struct in6_ndireq { 126 char ifname[IFNAMSIZ]; 127 struct nd_ifinfo ndi; 128 }; 129 130 struct in6_ndifreq { 131 char ifname[IFNAMSIZ]; 132 u_long ifindex; 133 }; 134 135 136 /* protocol constants */ 137 #define MAX_RTR_SOLICITATION_DELAY 1 /*1sec*/ 138 #define RTR_SOLICITATION_INTERVAL 4 /*4sec*/ 139 #define MAX_RTR_SOLICITATIONS 3 140 141 #define ND6_INFINITE_LIFETIME 0xffffffff 142 143 #ifdef _KERNEL 144 /* node constants */ 145 #define MAX_REACHABLE_TIME 3600000 /* msec */ 146 #define REACHABLE_TIME 30000 /* msec */ 147 #define RETRANS_TIMER 1000 /* msec */ 148 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 149 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 150 #define ND_COMPUTE_RTIME(x) \ 151 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \ 152 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 153 154 TAILQ_HEAD(nd_drhead, nd_defrouter); 155 struct nd_defrouter { 156 TAILQ_ENTRY(nd_defrouter) dr_entry; 157 struct in6_addr rtaddr; 158 u_char flags; 159 u_short rtlifetime; 160 u_long expire; 161 struct ifnet *ifp; 162 }; 163 164 struct nd_prefix { 165 struct ifnet *ndpr_ifp; 166 LIST_ENTRY(nd_prefix) ndpr_entry; 167 struct sockaddr_in6 ndpr_prefix; /* prefix */ 168 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 169 struct in6_addr ndpr_addr; /* address that is derived from the prefix */ 170 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 171 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 172 time_t ndpr_expire; /* expiration time of the prefix */ 173 time_t ndpr_preferred; /* preferred time of the prefix */ 174 struct prf_ra ndpr_flags; 175 /* list of routers that advertise the prefix: */ 176 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 177 u_char ndpr_plen; 178 struct ndpr_stateflags { 179 /* if this prefix can be regarded as on-link */ 180 u_char onlink : 1; 181 } ndpr_stateflags; 182 }; 183 184 #define ndpr_next ndpr_entry.le_next 185 186 #define ndpr_raf ndpr_flags 187 #define ndpr_raf_onlink ndpr_flags.onlink 188 #define ndpr_raf_auto ndpr_flags.autonomous 189 190 #define ndpr_statef_onlink ndpr_stateflags.onlink 191 #define ndpr_statef_addmark ndpr_stateflags.addmark 192 193 /* 194 * We keep expired prefix for certain amount of time, for validation purposes. 195 * 1800s = MaxRtrAdvInterval 196 */ 197 #define NDPR_KEEP_EXPIRED (1800 * 2) 198 199 /* 200 * Message format for use in obtaining information about prefixes 201 * from inet6 sysctl function 202 */ 203 struct inet6_ndpr_msghdr { 204 u_short inpm_msglen; /* to skip over non-understood messages */ 205 u_char inpm_version; /* future binary compatibility */ 206 u_char inpm_type; /* message type */ 207 struct in6_addr inpm_prefix; 208 u_long prm_vltim; 209 u_long prm_pltime; 210 u_long prm_expire; 211 u_long prm_preferred; 212 struct in6_prflags prm_flags; 213 u_short prm_index; /* index for associated ifp */ 214 u_char prm_plen; /* length of prefix in bits */ 215 }; 216 217 #define prm_raf_onlink prm_flags.prf_ra.onlink 218 #define prm_raf_auto prm_flags.prf_ra.autonomous 219 220 #define prm_statef_onlink prm_flags.prf_state.onlink 221 222 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 223 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 224 225 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr)) 226 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr)) 227 228 struct nd_pfxrouter { 229 LIST_ENTRY(nd_pfxrouter) pfr_entry; 230 #define pfr_next pfr_entry.le_next 231 struct nd_defrouter *router; 232 }; 233 234 LIST_HEAD(nd_prhead, nd_prefix); 235 236 /* nd6.c */ 237 extern int nd6_prune; 238 extern int nd6_delay; 239 extern int nd6_umaxtries; 240 extern int nd6_mmaxtries; 241 extern int nd6_useloopback; 242 extern int nd6_maxnudhint; 243 extern int nd6_gctimer; 244 extern struct llinfo_nd6 llinfo_nd6; 245 extern struct nd_ifinfo *nd_ifinfo; 246 extern struct nd_drhead nd_defrouter; 247 extern struct nd_prhead nd_prefix; 248 extern int nd6_debug; 249 250 #define nd6log(x) do { if (nd6_debug) log x; } while (0) 251 252 extern struct callout nd6_timer_ch; 253 254 /* nd6_rtr.c */ 255 extern int nd6_defifindex; 256 257 union nd_opts { 258 struct nd_opt_hdr *nd_opt_array[9]; 259 struct { 260 struct nd_opt_hdr *zero; 261 struct nd_opt_hdr *src_lladdr; 262 struct nd_opt_hdr *tgt_lladdr; 263 struct nd_opt_prefix_info *pi_beg;/* multiple opts, start */ 264 struct nd_opt_rd_hdr *rh; 265 struct nd_opt_mtu *mtu; 266 struct nd_opt_hdr *search; /* multiple opts */ 267 struct nd_opt_hdr *last; /* multiple opts */ 268 int done; 269 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 270 } nd_opt_each; 271 }; 272 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 273 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 274 #define nd_opts_pi nd_opt_each.pi_beg 275 #define nd_opts_pi_end nd_opt_each.pi_end 276 #define nd_opts_rh nd_opt_each.rh 277 #define nd_opts_mtu nd_opt_each.mtu 278 #define nd_opts_search nd_opt_each.search 279 #define nd_opts_last nd_opt_each.last 280 #define nd_opts_done nd_opt_each.done 281 282 /* XXX: need nd6_var.h?? */ 283 /* nd6.c */ 284 void nd6_init __P((void)); 285 void nd6_ifattach __P((struct ifnet *)); 286 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *)); 287 void nd6_option_init __P((void *, int, union nd_opts *)); 288 struct nd_opt_hdr *nd6_option __P((union nd_opts *)); 289 int nd6_options __P((union nd_opts *)); 290 struct rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *)); 291 void nd6_setmtu __P((struct ifnet *)); 292 void nd6_timer __P((void *)); 293 void nd6_purge __P((struct ifnet *)); 294 struct llinfo_nd6 *nd6_free __P((struct rtentry *)); 295 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int)); 296 int nd6_resolve __P((struct ifnet *, struct rtentry *, 297 struct mbuf *, struct sockaddr *, u_char *)); 298 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *)); 299 void nd6_p2p_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *)); 300 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *)); 301 struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *, 302 char *, int, int, int)); 303 /* for test */ 304 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *, 305 struct sockaddr_in6 *, struct rtentry *)); 306 int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *, 307 struct sockaddr *, u_char *)); 308 309 /* nd6_nbr.c */ 310 void nd6_na_input __P((struct mbuf *, int, int)); 311 void nd6_na_output __P((struct ifnet *, struct in6_addr *, 312 struct in6_addr *, u_long, int, struct sockaddr *)); 313 void nd6_ns_input __P((struct mbuf *, int, int)); 314 void nd6_ns_output __P((struct ifnet *, struct in6_addr *, 315 struct in6_addr *, struct llinfo_nd6 *, int)); 316 caddr_t nd6_ifptomac __P((struct ifnet *)); 317 void nd6_dad_start __P((struct ifaddr *, int *)); 318 void nd6_dad_stop __P((struct ifaddr *)); 319 void nd6_dad_duplicated __P((struct ifaddr *)); 320 321 /* nd6_rtr.c */ 322 void nd6_rs_input __P((struct mbuf *, int, int)); 323 void nd6_ra_input __P((struct mbuf *, int, int)); 324 void prelist_del __P((struct nd_prefix *)); 325 void defrouter_addreq __P((struct nd_defrouter *)); 326 void defrouter_delreq __P((struct nd_defrouter *, int)); 327 void defrouter_select __P((void)); 328 void defrtrlist_del __P((struct nd_defrouter *)); 329 void prelist_remove __P((struct nd_prefix *)); 330 int prelist_update __P((struct nd_prefix *, struct nd_defrouter *, 331 struct mbuf *)); 332 void pfxlist_onlink_check __P((void)); 333 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *, 334 struct ifnet *)); 335 int in6_ifdel __P((struct ifnet *, struct in6_addr *)); 336 int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr)); 337 void rt6_flush __P((struct in6_addr *, struct ifnet *)); 338 int nd6_setdefaultiface __P((int)); 339 340 #endif /* _KERNEL */ 341 342 #endif /* _NETINET6_ND6_H_ */ 343