sys/netinet6/nd6.h

   1 /*      $NetBSD: nd6.h,v 1.52 2009/01/15 18:20:48 christos Exp $        */
   2 /*      $KAME: nd6.h,v 1.95 2002/06/08 11:31:06 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         long    ln_ntick;
  56         struct callout ln_timer_ch;
  57 };
  58
  59 #define ND6_LLINFO_NOSTATE      -2
  60 /*
  61  * We don't need the WAITDELETE state any more, but we keep the definition
  62  * in a comment line instead of removing it. This is necessary to avoid
  63  * unintentionally reusing the value for another purpose, which might
  64  * affect backward compatibility with old applications.
  65  * (20000711 jinmei@kame.net)
  66  */
  67 /* #define ND6_LLINFO_WAITDELETE        -1 */
  68 #define ND6_LLINFO_INCOMPLETE   0
  69 #define ND6_LLINFO_REACHABLE    1
  70 #define ND6_LLINFO_STALE        2
  71 #define ND6_LLINFO_DELAY        3
  72 #define ND6_LLINFO_PROBE        4
  73
  74 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
  75 #define ND6_LLINFO_PERMANENT(n) (((n)->ln_expire == 0) && ((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 initialized; /* Flag to see the entry is initialized */
  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      0x01
  94 #define ND6_IFF_ACCEPT_RTADV    0x02    /* See "RTADV Key", below. */
  95 #define ND6_IFF_PREFER_SOURCE   0x04    /* XXX: not related to ND. */
  96 #define ND6_IFF_IFDISABLED      0x08    /* IPv6 operation is disabled due to
  97                                          * DAD failure.  (XXX: not ND-specific)
  98                                          */
  99 #define ND6_IFF_OVERRIDE_RTADV  0x10    /* See "RTADV Key", below. */
 100
 101 /*
 102  * RTADV Key
 103  *
 104  * The flags ND6_IFF_ACCEPT_RTADV and ND6_IFF_OVERRIDE_RTADV form a
 105  * tri-state variable.  (There are actually four different states, but
 106  * two of the states are functionally identical.)
 107  *
 108  * ND6_IFF_OVERRIDE_RTADV or 0: This interface does not accept
 109  *                              Router Advertisements.
 110  *
 111  * ND6_IFF_OVERRIDE_RTADV|
 112  * ND6_IFF_ACCEPT_RTADV:        This interface accepts Router
 113  *                              Advertisements regardless of the
 114  *                              global setting, ip6_accept_rtadv.
 115  *
 116  * ND6_IFF_ACCEPT_RTADV:        This interface follows the global setting,
 117  *                              ip6_accept_rtadv.  If ip6_accept_rtadv == 0,
 118  *                              this interface does not accept Router
 119  *                              Advertisements.  If ip6_accept_rtadv != 0,
 120  *                              this interface does accept them.
 121  */
 122
 123 #ifdef _KERNEL
 124 #define ND_IFINFO(ifp) \
 125         (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
 126 #define IN6_LINKMTU(ifp) \
 127         ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
 128             ? ND_IFINFO(ifp)->linkmtu \
 129             : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
 130                 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
 131 #endif
 132
 133 struct in6_nbrinfo {
 134         char ifname[IFNAMSIZ];  /* if name, e.g. "en0" */
 135         struct in6_addr addr;   /* IPv6 address of the neighbor */
 136         long    asked;          /* number of queries already sent for this addr */
 137         int     isrouter;       /* if it acts as a router */
 138         int     state;          /* reachability state */
 139         int     expire;         /* lifetime for NDP state transition */
 140 };
 141
 142 #define DRLSTSIZ 10
 143 #define PRLSTSIZ 10
 144 struct  in6_drlist {
 145         char ifname[IFNAMSIZ];
 146         struct {
 147                 struct  in6_addr rtaddr;
 148                 u_char  flags;
 149                 u_short rtlifetime;
 150                 u_long  expire;
 151                 u_short if_index;
 152         } defrouter[DRLSTSIZ];
 153 };
 154
 155 struct  in6_defrouter {
 156         struct  sockaddr_in6 rtaddr;
 157         u_char  flags;
 158         u_short rtlifetime;
 159         u_long  expire;
 160         u_short if_index;
 161 };
 162
 163 #ifdef _KERNEL
 164 struct  in6_oprlist {
 165         char ifname[IFNAMSIZ];
 166         struct {
 167                 struct  in6_addr prefix;
 168                 struct prf_ra raflags;
 169                 u_char  prefixlen;
 170                 u_char  origin;
 171                 u_long vltime;
 172                 u_long pltime;
 173                 u_long expire;
 174                 u_short if_index;
 175                 u_short advrtrs; /* number of advertisement routers */
 176                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 177         } prefix[PRLSTSIZ];
 178 };
 179 #endif
 180
 181 struct  in6_prlist {
 182         char ifname[IFNAMSIZ];
 183         struct {
 184                 struct  in6_addr prefix;
 185                 struct prf_ra raflags;
 186                 u_char  prefixlen;
 187                 u_char  origin;
 188                 u_int32_t vltime;
 189                 u_int32_t pltime;
 190                 time_t expire;
 191                 u_short if_index;
 192                 u_short advrtrs; /* number of advertisement routers */
 193                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 194         } prefix[PRLSTSIZ];
 195 };
 196
 197 struct in6_prefix {
 198         struct  sockaddr_in6 prefix;
 199         struct prf_ra raflags;
 200         u_char  prefixlen;
 201         u_char  origin;
 202         u_int32_t vltime;
 203         u_int32_t pltime;
 204         time_t expire;
 205         u_int32_t flags;
 206         int refcnt;
 207         u_short if_index;
 208         u_short advrtrs; /* number of advertisement routers */
 209         /* struct sockaddr_in6 advrtr[] */
 210 };
 211
 212 #ifdef _KERNEL
 213 struct  in6_ondireq {
 214         char ifname[IFNAMSIZ];
 215         struct {
 216                 u_int32_t linkmtu;      /* LinkMTU */
 217                 u_int32_t maxmtu;       /* Upper bound of LinkMTU */
 218                 u_int32_t basereachable; /* BaseReachableTime */
 219                 u_int32_t reachable;    /* Reachable Time */
 220                 u_int32_t retrans;      /* Retrans Timer */
 221                 u_int32_t flags;        /* Flags */
 222                 int recalctm;           /* BaseReacable re-calculation timer */
 223                 u_int8_t chlim;         /* CurHopLimit */
 224                 u_int8_t receivedra;
 225         } ndi;
 226 };
 227 #endif
 228
 229 struct  in6_ndireq {
 230         char ifname[IFNAMSIZ];
 231         struct nd_ifinfo ndi;
 232 };
 233
 234 struct  in6_ndifreq {
 235         char ifname[IFNAMSIZ];
 236         u_long ifindex;
 237 };
 238
 239 /* Prefix status */
 240 #define NDPRF_ONLINK            0x1
 241 #define NDPRF_DETACHED          0x2
 242 #define NDPRF_HOME              0x4
 243
 244 /* protocol constants */
 245 #define MAX_RTR_SOLICITATION_DELAY      1       /* 1sec */
 246 #define RTR_SOLICITATION_INTERVAL       4       /* 4sec */
 247 #define MAX_RTR_SOLICITATIONS           3
 248
 249 #define ND6_INFINITE_LIFETIME           ((u_int32_t)~0)
 250
 251 #ifdef _KERNEL
 252 /* node constants */
 253 #define MAX_REACHABLE_TIME              3600000 /* msec */
 254 #define REACHABLE_TIME                  30000   /* msec */
 255 #define RETRANS_TIMER                   1000    /* msec */
 256 #define MIN_RANDOM_FACTOR               512     /* 1024 * 0.5 */
 257 #define MAX_RANDOM_FACTOR               1536    /* 1024 * 1.5 */
 258 #define DEF_TEMP_VALID_LIFETIME         604800  /* 1 week */
 259 #define DEF_TEMP_PREFERRED_LIFETIME     86400   /* 1 day */
 260 #define TEMPADDR_REGEN_ADVANCE          5       /* sec */
 261 #define MAX_TEMP_DESYNC_FACTOR          600     /* 10 min */
 262 #define ND_COMPUTE_RTIME(x) \
 263                 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
 264                 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
 265
 266 TAILQ_HEAD(nd_drhead, nd_defrouter);
 267 struct  nd_defrouter {
 268         TAILQ_ENTRY(nd_defrouter) dr_entry;
 269         struct  in6_addr rtaddr;
 270         u_char  flags;          /* flags on RA message */
 271         u_short rtlifetime;
 272         u_long  expire;
 273         struct  ifnet *ifp;
 274         int     installed;      /* is installed into kernel routing table */
 275 };
 276
 277 struct nd_prefixctl {
 278         struct ifnet *ndpr_ifp;
 279
 280         /* prefix */
 281         struct sockaddr_in6 ndpr_prefix;
 282         u_char  ndpr_plen;
 283
 284         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
 285         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
 286
 287         struct prf_ra ndpr_flags;
 288 };
 289
 290 struct nd_prefix {
 291         struct ifnet *ndpr_ifp;
 292         LIST_ENTRY(nd_prefix) ndpr_entry;
 293         struct sockaddr_in6 ndpr_prefix;        /* prefix */
 294         struct in6_addr ndpr_mask; /* netmask derived from the prefix */
 295
 296         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
 297         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
 298
 299         time_t ndpr_expire;     /* expiration time of the prefix */
 300         time_t ndpr_preferred;  /* preferred time of the prefix */
 301         time_t ndpr_lastupdate; /* reception time of last advertisement */
 302
 303         struct prf_ra ndpr_flags;
 304         u_int32_t ndpr_stateflags; /* actual state flags */
 305         /* list of routers that advertise the prefix: */
 306         LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
 307         u_char  ndpr_plen;
 308         int     ndpr_refcnt;    /* reference couter from addresses */
 309 };
 310
 311 #define ndpr_raf                ndpr_flags
 312 #define ndpr_raf_onlink         ndpr_flags.onlink
 313 #define ndpr_raf_auto           ndpr_flags.autonomous
 314 #define ndpr_raf_router         ndpr_flags.router
 315
 316 /*
 317  * Message format for use in obtaining information about prefixes
 318  * from inet6 sysctl function
 319  */
 320 struct inet6_ndpr_msghdr {
 321         u_short inpm_msglen;    /* to skip over non-understood messages */
 322         u_char  inpm_version;   /* future binary compatibility */
 323         u_char  inpm_type;      /* message type */
 324         struct in6_addr inpm_prefix;
 325         u_long  prm_vltim;
 326         u_long  prm_pltime;
 327         u_long  prm_expire;
 328         u_long  prm_preferred;
 329         struct in6_prflags prm_flags;
 330         u_short prm_index;      /* index for associated ifp */
 331         u_char  prm_plen;       /* length of prefix in bits */
 332 };
 333
 334 #define prm_raf_onlink          prm_flags.prf_ra.onlink
 335 #define prm_raf_auto            prm_flags.prf_ra.autonomous
 336
 337 #define prm_statef_onlink       prm_flags.prf_state.onlink
 338
 339 #define prm_rrf_decrvalid       prm_flags.prf_rr.decrvalid
 340 #define prm_rrf_decrprefd       prm_flags.prf_rr.decrprefd
 341
 342 struct nd_pfxrouter {
 343         LIST_ENTRY(nd_pfxrouter) pfr_entry;
 344         struct nd_defrouter *router;
 345 };
 346
 347 LIST_HEAD(nd_prhead, nd_prefix);
 348
 349 #include <sys/mallocvar.h>
 350 MALLOC_DECLARE(M_IP6NDP);
 351
 352 /* nd6.c */
 353 extern int nd6_prune;
 354 extern int nd6_delay;
 355 extern int nd6_umaxtries;
 356 extern int nd6_mmaxtries;
 357 extern int nd6_useloopback;
 358 extern int nd6_maxnudhint;
 359 extern int nd6_gctimer;
 360 extern struct llinfo_nd6 llinfo_nd6;
 361 extern struct nd_drhead nd_defrouter;
 362 extern struct nd_prhead nd_prefix;
 363 extern int nd6_debug;
 364
 365 #define nd6log(x)       do { if (nd6_debug) log x; } while (/*CONSTCOND*/ 0)
 366
 367 extern struct callout nd6_timer_ch;
 368
 369 /* nd6_rtr.c */
 370 extern int nd6_defifindex;
 371 extern int ip6_desync_factor;   /* seconds */
 372 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
 373 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
 374 extern int ip6_temp_regen_advance; /* seconds */
 375
 376 union nd_opts {
 377         struct nd_opt_hdr *nd_opt_array[8];
 378         struct {
 379                 struct nd_opt_hdr *zero;
 380                 struct nd_opt_hdr *src_lladdr;
 381                 struct nd_opt_hdr *tgt_lladdr;
 382                 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
 383                 struct nd_opt_rd_hdr *rh;
 384                 struct nd_opt_mtu *mtu;
 385                 struct nd_opt_hdr *search;      /* multiple opts */
 386                 struct nd_opt_hdr *last;        /* multiple opts */
 387                 int done;
 388                 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
 389         } nd_opt_each;
 390 };
 391 #define nd_opts_src_lladdr      nd_opt_each.src_lladdr
 392 #define nd_opts_tgt_lladdr      nd_opt_each.tgt_lladdr
 393 #define nd_opts_pi              nd_opt_each.pi_beg
 394 #define nd_opts_pi_end          nd_opt_each.pi_end
 395 #define nd_opts_rh              nd_opt_each.rh
 396 #define nd_opts_mtu             nd_opt_each.mtu
 397 #define nd_opts_search          nd_opt_each.search
 398 #define nd_opts_last            nd_opt_each.last
 399 #define nd_opts_done            nd_opt_each.done
 400
 401 /* XXX: need nd6_var.h?? */
 402 /* nd6.c */
 403 void nd6_init(void);
 404 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
 405 void nd6_ifdetach(struct nd_ifinfo *);
 406 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
 407 void nd6_option_init(void *, int, union nd_opts *);
 408 struct nd_opt_hdr *nd6_option(union nd_opts *);
 409 int nd6_options(union nd_opts *);
 410 struct  rtentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
 411 void nd6_setmtu(struct ifnet *);
 412 void nd6_llinfo_settimer(struct llinfo_nd6 *, long);
 413 void nd6_timer(void *);
 414 void nd6_purge(struct ifnet *);
 415 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
 416 int nd6_resolve(struct ifnet *, struct rtentry *,
 417         struct mbuf *, struct sockaddr *, u_char *);
 418 void nd6_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
 419 int nd6_ioctl(u_long, void *, struct ifnet *);
 420 struct rtentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
 421         char *, int, int, int);
 422 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
 423         const struct sockaddr_in6 *, struct rtentry *);
 424 int nd6_storelladdr(const struct ifnet *, const struct rtentry *, struct mbuf *,
 425         const struct sockaddr *, uint8_t *, size_t);
 426 int nd6_sysctl(int, void *, size_t *, void *, size_t);
 427 int nd6_need_cache(struct ifnet *);
 428 void nd6_llinfo_release_pkts(struct llinfo_nd6 *, struct ifnet *,
 429     struct rtentry *);
 430
 431 /* nd6_nbr.c */
 432 void nd6_na_input(struct mbuf *, int, int);
 433 void nd6_na_output(struct ifnet *, const struct in6_addr *,
 434         const struct in6_addr *, u_long, int, const struct sockaddr *);
 435 void nd6_ns_input(struct mbuf *, int, int);
 436 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
 437         const struct in6_addr *, struct llinfo_nd6 *, int);
 438 const void *nd6_ifptomac(const struct ifnet *);
 439 void nd6_dad_start(struct ifaddr *, int);
 440 void nd6_dad_stop(struct ifaddr *);
 441 void nd6_dad_duplicated(struct ifaddr *);
 442
 443 /* nd6_rtr.c */
 444 void nd6_rs_input(struct mbuf *, int, int);
 445 void nd6_ra_input(struct mbuf *, int, int);
 446 void prelist_del(struct nd_prefix *);
 447 void defrouter_addreq(struct nd_defrouter *);
 448 void defrouter_reset(void);
 449 void defrouter_select(void);
 450 void defrtrlist_del(struct nd_defrouter *);
 451 void prelist_remove(struct nd_prefix *);
 452 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
 453         struct nd_prefix **);
 454 int nd6_prefix_onlink(struct nd_prefix *);
 455 int nd6_prefix_offlink(struct nd_prefix *);
 456 void pfxlist_onlink_check(void);
 457 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *);
 458 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
 459 int in6_ifdel(struct ifnet *, struct in6_addr *);
 460 void rt6_flush(struct in6_addr *, struct ifnet *);
 461 int nd6_setdefaultiface(int);
 462 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
 463 bool nd6_accepts_rtadv(const struct nd_ifinfo *);
 464
 465 #endif /* _KERNEL */
 466
 467 #endif /* !_NETINET6_ND6_H_ */