1 /* $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.5 2002/04/28 05:40:27 suz Exp $ */ 2 /* $DragonFly: src/sys/netinet6/nd6.h,v 1.4 2003/11/22 19:30:56 asmodai Exp $ */ 3 /* $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ */ 4 5 /* 6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. Neither the name of the project nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34 #ifndef _NETINET6_ND6_H_ 35 #define _NETINET6_ND6_H_ 36 37 /* see net/route.h, or net/if_inarp.h */ 38 #ifndef RTF_ANNOUNCE 39 #define RTF_ANNOUNCE RTF_PROTO2 40 #endif 41 42 #include <sys/queue.h> 43 #include <sys/callout.h> 44 45 struct llinfo_nd6 { 46 struct llinfo_nd6 *ln_next; 47 struct llinfo_nd6 *ln_prev; 48 struct rtentry *ln_rt; 49 struct mbuf *ln_hold; /* last packet until resolved/timeout */ 50 long ln_asked; /* number of queries already sent for this addr */ 51 u_long ln_expire; /* lifetime for NDP state transition */ 52 short ln_state; /* reachability state */ 53 short ln_router; /* 2^0: ND6 router bit */ 54 int ln_byhint; /* # of times we made it reachable by UL hint */ 55 }; 56 57 #define ND6_LLINFO_NOSTATE -2 58 /* 59 * We don't need the WAITDELETE state any more, but we keep the definition 60 * in a comment line instead of removing it. This is necessary to avoid 61 * unintentionally reusing the value for another purpose, which might 62 * affect backward compatibility with old applications. 63 * (20000711 jinmei@kame.net) 64 */ 65 /* #define ND6_LLINFO_WAITDELETE -1 */ 66 #define ND6_LLINFO_INCOMPLETE 0 67 #define ND6_LLINFO_REACHABLE 1 68 #define ND6_LLINFO_STALE 2 69 #define ND6_LLINFO_DELAY 3 70 #define ND6_LLINFO_PROBE 4 71 72 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE) 73 74 struct nd_ifinfo { 75 u_int32_t linkmtu; /* LinkMTU */ 76 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 77 u_int32_t basereachable; /* BaseReachableTime */ 78 u_int32_t reachable; /* Reachable Time */ 79 u_int32_t retrans; /* Retrans Timer */ 80 u_int32_t flags; /* Flags */ 81 int recalctm; /* BaseReacable re-calculation timer */ 82 u_int8_t chlim; /* CurHopLimit */ 83 u_int8_t receivedra; 84 /* the following 3 members are for privacy extension for addrconf */ 85 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */ 86 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */ 87 u_int8_t randomid[8]; /* current random ID */ 88 }; 89 90 #define ND6_IFF_PERFORMNUD 0x1 91 92 struct in6_nbrinfo { 93 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */ 94 struct in6_addr addr; /* IPv6 address of the neighbor */ 95 long asked; /* number of queries already sent for this addr */ 96 int isrouter; /* if it acts as a router */ 97 int state; /* reachability state */ 98 int expire; /* lifetime for NDP state transition */ 99 }; 100 101 #define DRLSTSIZ 10 102 #define PRLSTSIZ 10 103 struct in6_drlist { 104 char ifname[IFNAMSIZ]; 105 struct { 106 struct in6_addr rtaddr; 107 u_char flags; 108 u_short rtlifetime; 109 u_long expire; 110 u_short if_index; 111 } defrouter[DRLSTSIZ]; 112 }; 113 114 struct in6_defrouter { 115 struct sockaddr_in6 rtaddr; 116 u_char flags; 117 u_short rtlifetime; 118 u_long expire; 119 u_short if_index; 120 }; 121 122 struct in6_prlist { 123 char ifname[IFNAMSIZ]; 124 struct { 125 struct in6_addr prefix; 126 struct prf_ra raflags; 127 u_char prefixlen; 128 u_char origin; 129 u_int32_t vltime; 130 u_int32_t pltime; 131 time_t expire; 132 u_short if_index; 133 u_short advrtrs; /* number of advertisement routers */ 134 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */ 135 } prefix[PRLSTSIZ]; 136 }; 137 138 struct in6_prefix { 139 struct sockaddr_in6 prefix; 140 struct prf_ra raflags; 141 u_char prefixlen; 142 u_char origin; 143 u_long vltime; 144 u_long pltime; 145 u_long expire; 146 u_int32_t flags; 147 int refcnt; 148 u_short if_index; 149 u_short advrtrs; /* number of advertisement routers */ 150 /* struct sockaddr_in6 advrtr[] */ 151 }; 152 153 #ifdef _KERNEL 154 struct in6_ondireq { 155 char ifname[IFNAMSIZ]; 156 struct { 157 u_int32_t linkmtu; /* LinkMTU */ 158 u_int32_t maxmtu; /* Upper bound of LinkMTU */ 159 u_int32_t basereachable; /* BaseReachableTime */ 160 u_int32_t reachable; /* Reachable Time */ 161 u_int32_t retrans; /* Retrans Timer */ 162 u_int32_t flags; /* Flags */ 163 int recalctm; /* BaseReacable re-calculation timer */ 164 u_int8_t chlim; /* CurHopLimit */ 165 u_int8_t receivedra; 166 } ndi; 167 }; 168 #endif 169 170 struct in6_ndireq { 171 char ifname[IFNAMSIZ]; 172 struct nd_ifinfo ndi; 173 }; 174 175 struct in6_ndifreq { 176 char ifname[IFNAMSIZ]; 177 u_long ifindex; 178 }; 179 180 /* Prefix status */ 181 #define NDPRF_ONLINK 0x1 182 #define NDPRF_DETACHED 0x2 183 184 /* protocol constants */ 185 #define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */ 186 #define RTR_SOLICITATION_INTERVAL 4 /* 4sec */ 187 #define MAX_RTR_SOLICITATIONS 3 188 189 #define ND6_INFINITE_LIFETIME 0xffffffff 190 191 #ifdef _KERNEL 192 /* node constants */ 193 #define MAX_REACHABLE_TIME 3600000 /* msec */ 194 #define REACHABLE_TIME 30000 /* msec */ 195 #define RETRANS_TIMER 1000 /* msec */ 196 #define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */ 197 #define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */ 198 #define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */ 199 #define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */ 200 #define TEMPADDR_REGEN_ADVANCE 5 /* sec */ 201 #define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */ 202 #define ND_COMPUTE_RTIME(x) \ 203 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \ 204 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000) 205 206 TAILQ_HEAD(nd_drhead, nd_defrouter); 207 struct nd_defrouter { 208 TAILQ_ENTRY(nd_defrouter) dr_entry; 209 struct in6_addr rtaddr; 210 u_char flags; /* flags on RA message */ 211 u_short rtlifetime; 212 u_long expire; 213 u_long advint; /* Mobile IPv6 addition (milliseconds) */ 214 u_long advint_expire; /* Mobile IPv6 addition */ 215 int advints_lost; /* Mobile IPv6 addition */ 216 struct ifnet *ifp; 217 }; 218 219 struct nd_prefix { 220 struct ifnet *ndpr_ifp; 221 LIST_ENTRY(nd_prefix) ndpr_entry; 222 struct sockaddr_in6 ndpr_prefix; /* prefix */ 223 struct in6_addr ndpr_mask; /* netmask derived from the prefix */ 224 struct in6_addr ndpr_addr; /* address that is derived from the prefix */ 225 u_int32_t ndpr_vltime; /* advertised valid lifetime */ 226 u_int32_t ndpr_pltime; /* advertised preferred lifetime */ 227 time_t ndpr_expire; /* expiration time of the prefix */ 228 time_t ndpr_preferred; /* preferred time of the prefix */ 229 struct prf_ra ndpr_flags; 230 u_int32_t ndpr_stateflags; /* actual state flags */ 231 /* list of routers that advertise the prefix: */ 232 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs; 233 u_char ndpr_plen; 234 int ndpr_refcnt; /* reference couter from addresses */ 235 }; 236 237 #define ndpr_next ndpr_entry.le_next 238 239 #define ndpr_raf ndpr_flags 240 #define ndpr_raf_onlink ndpr_flags.onlink 241 #define ndpr_raf_auto ndpr_flags.autonomous 242 243 /* 244 * We keep expired prefix for certain amount of time, for validation purposes. 245 * 1800s = MaxRtrAdvInterval 246 */ 247 #define NDPR_KEEP_EXPIRED (1800 * 2) 248 249 /* 250 * Message format for use in obtaining information about prefixes 251 * from inet6 sysctl function 252 */ 253 struct inet6_ndpr_msghdr { 254 u_short inpm_msglen; /* to skip over non-understood messages */ 255 u_char inpm_version; /* future binary compatibility */ 256 u_char inpm_type; /* message type */ 257 struct in6_addr inpm_prefix; 258 u_long prm_vltim; 259 u_long prm_pltime; 260 u_long prm_expire; 261 u_long prm_preferred; 262 struct in6_prflags prm_flags; 263 u_short prm_index; /* index for associated ifp */ 264 u_char prm_plen; /* length of prefix in bits */ 265 }; 266 267 #define prm_raf_onlink prm_flags.prf_ra.onlink 268 #define prm_raf_auto prm_flags.prf_ra.autonomous 269 270 #define prm_statef_onlink prm_flags.prf_state.onlink 271 272 #define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid 273 #define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd 274 275 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr)) 276 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr)) 277 278 struct nd_pfxrouter { 279 LIST_ENTRY(nd_pfxrouter) pfr_entry; 280 #define pfr_next pfr_entry.le_next 281 struct nd_defrouter *router; 282 }; 283 284 LIST_HEAD(nd_prhead, nd_prefix); 285 286 /* nd6.c */ 287 extern int nd6_prune; 288 extern int nd6_delay; 289 extern int nd6_umaxtries; 290 extern int nd6_mmaxtries; 291 extern int nd6_useloopback; 292 extern int nd6_maxnudhint; 293 extern int nd6_gctimer; 294 extern struct llinfo_nd6 llinfo_nd6; 295 extern struct nd_ifinfo *nd_ifinfo; 296 extern struct nd_drhead nd_defrouter; 297 extern struct nd_prhead nd_prefix; 298 extern int nd6_debug; 299 300 #define nd6log(x) do { if (nd6_debug) log x; } while (0) 301 302 extern struct callout nd6_timer_ch; 303 304 /* nd6_rtr.c */ 305 extern int nd6_defifindex; 306 extern int ip6_desync_factor; /* seconds */ 307 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */ 308 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */ 309 extern int ip6_temp_regen_advance; /* seconds */ 310 311 union nd_opts { 312 struct nd_opt_hdr *nd_opt_array[9]; /* max = home agent info */ 313 struct { 314 struct nd_opt_hdr *zero; 315 struct nd_opt_hdr *src_lladdr; 316 struct nd_opt_hdr *tgt_lladdr; 317 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */ 318 struct nd_opt_rd_hdr *rh; 319 struct nd_opt_mtu *mtu; 320 struct nd_opt_hdr *six; 321 struct nd_opt_advint *adv; 322 struct nd_opt_hai *hai; 323 struct nd_opt_hdr *search; /* multiple opts */ 324 struct nd_opt_hdr *last; /* multiple opts */ 325 int done; 326 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */ 327 } nd_opt_each; 328 }; 329 #define nd_opts_src_lladdr nd_opt_each.src_lladdr 330 #define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr 331 #define nd_opts_pi nd_opt_each.pi_beg 332 #define nd_opts_pi_end nd_opt_each.pi_end 333 #define nd_opts_rh nd_opt_each.rh 334 #define nd_opts_mtu nd_opt_each.mtu 335 #define nd_opts_adv nd_opt_each.adv 336 #define nd_opts_hai nd_opt_each.hai 337 #define nd_opts_search nd_opt_each.search 338 #define nd_opts_last nd_opt_each.last 339 #define nd_opts_done nd_opt_each.done 340 341 /* XXX: need nd6_var.h?? */ 342 /* nd6.c */ 343 void nd6_init (void); 344 void nd6_ifattach (struct ifnet *); 345 int nd6_is_addr_neighbor (struct sockaddr_in6 *, struct ifnet *); 346 void nd6_option_init (void *, int, union nd_opts *); 347 struct nd_opt_hdr *nd6_option (union nd_opts *); 348 int nd6_options (union nd_opts *); 349 struct rtentry *nd6_lookup (struct in6_addr *, int, struct ifnet *); 350 void nd6_setmtu (struct ifnet *); 351 void nd6_timer (void *); 352 void nd6_purge (struct ifnet *); 353 struct llinfo_nd6 *nd6_free (struct rtentry *); 354 void nd6_nud_hint (struct rtentry *, struct in6_addr *, int); 355 int nd6_resolve (struct ifnet *, struct rtentry *, 356 struct mbuf *, struct sockaddr *, u_char *); 357 void nd6_rtrequest (int, struct rtentry *, struct rt_addrinfo *); 358 int nd6_ioctl (u_long, caddr_t, struct ifnet *); 359 struct rtentry *nd6_cache_lladdr (struct ifnet *, struct in6_addr *, 360 char *, int, int, int); 361 int nd6_output (struct ifnet *, struct ifnet *, struct mbuf *, 362 struct sockaddr_in6 *, struct rtentry *); 363 int nd6_storelladdr (struct ifnet *, struct rtentry *, struct mbuf *, 364 struct sockaddr *, u_char *); 365 int nd6_need_cache (struct ifnet *); 366 367 /* nd6_nbr.c */ 368 void nd6_na_input (struct mbuf *, int, int); 369 void nd6_na_output (struct ifnet *, const struct in6_addr *, 370 const struct in6_addr *, u_long, int, struct sockaddr *); 371 void nd6_ns_input (struct mbuf *, int, int); 372 void nd6_ns_output (struct ifnet *, const struct in6_addr *, 373 const struct in6_addr *, struct llinfo_nd6 *, int); 374 caddr_t nd6_ifptomac (struct ifnet *); 375 void nd6_dad_start (struct ifaddr *, int *); 376 void nd6_dad_stop (struct ifaddr *); 377 void nd6_dad_duplicated (struct ifaddr *); 378 379 /* nd6_rtr.c */ 380 void nd6_rs_input (struct mbuf *, int, int); 381 void nd6_ra_input (struct mbuf *, int, int); 382 void prelist_del (struct nd_prefix *); 383 void defrouter_addreq (struct nd_defrouter *); 384 void defrouter_delreq (struct nd_defrouter *, int); 385 void defrouter_select (void); 386 void defrtrlist_del (struct nd_defrouter *); 387 void prelist_remove (struct nd_prefix *); 388 int prelist_update (struct nd_prefix *, struct nd_defrouter *, 389 struct mbuf *); 390 int nd6_prelist_add (struct nd_prefix *, struct nd_defrouter *, 391 struct nd_prefix **); 392 int nd6_prefix_onlink (struct nd_prefix *); 393 int nd6_prefix_offlink (struct nd_prefix *); 394 void pfxlist_onlink_check (void); 395 struct nd_defrouter *defrouter_lookup (struct in6_addr *, 396 struct ifnet *); 397 struct nd_prefix *nd6_prefix_lookup (struct nd_prefix *); 398 int in6_init_prefix_ltimes (struct nd_prefix *ndpr); 399 void rt6_flush (struct in6_addr *, struct ifnet *); 400 int nd6_setdefaultiface (int); 401 int in6_tmpifadd (const struct in6_ifaddr *, int); 402 403 #endif /* _KERNEL */ 404 405 #endif /* _NETINET6_ND6_H_ */ 406