git.mutantstargoat.com Git - oftp/blob - libs/watt32/netinet6/nd6.h

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