bsd/netinet6/nd6.h

   1 /*      $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.3 2001/08/13 01:10:49 simokawa Exp $   */
   2 /*      $KAME: nd6.h,v 1.55 2001/04/27 15:09:49 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 #include <sys/appleapiopts.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
  44 #ifdef KERNEL_PRIVATE
  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 #endif /* KERNEL_PRIVATE */
  57
  58 #define ND6_LLINFO_PURGE        -3
  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
  76 struct nd_ifinfo {
  77         u_int32_t linkmtu;              /* LinkMTU */
  78         u_int32_t maxmtu;               /* Upper bound of LinkMTU */
  79         u_int32_t basereachable;        /* BaseReachableTime */
  80         u_int32_t reachable;            /* Reachable Time */
  81         u_int32_t retrans;              /* Retrans Timer */
  82         u_int32_t flags;                /* Flags */
  83         int recalctm;                   /* BaseReacable re-calculation timer */
  84         u_int8_t chlim;                 /* CurHopLimit */
  85         u_int8_t receivedra;
  86         /* the following 3 members are for privacy extension for addrconf */
  87         u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
  88         u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
  89         u_int8_t randomid[8];   /* current random ID */
  90         /* keep track of routers and prefixes on this link */
  91         int32_t nprefixes;
  92         int32_t ndefrouters;
  93 };
  94
  95 #define ND6_IFF_PERFORMNUD      0x1
  96
  97 struct in6_nbrinfo {
  98         char ifname[IFNAMSIZ];  /* if name, e.g. "en0" */
  99         struct in6_addr addr;   /* IPv6 address of the neighbor */
 100         long    asked;          /* number of queries already sent for this addr */
 101         int     isrouter;       /* if it acts as a router */
 102         int     state;          /* reachability state */
 103         int     expire;         /* lifetime for NDP state transition */
 104 };
 105
 106 #define DRLSTSIZ 10
 107 #define PRLSTSIZ 10
 108 struct  in6_drlist {
 109         char ifname[IFNAMSIZ];
 110         struct {
 111                 struct  in6_addr rtaddr;
 112                 u_char  flags;
 113                 u_short rtlifetime;
 114                 u_long  expire;
 115                 u_short if_index;
 116         } defrouter[DRLSTSIZ];
 117 };
 118
 119 struct  in6_defrouter {
 120         struct  sockaddr_in6 rtaddr;
 121         u_char  flags;
 122         u_short rtlifetime;
 123         u_long  expire;
 124         u_short if_index;
 125 };
 126
 127 struct  in6_prlist {
 128         char ifname[IFNAMSIZ];
 129         struct {
 130                 struct  in6_addr prefix;
 131                 struct prf_ra raflags;
 132                 u_char  prefixlen;
 133                 u_char  origin;
 134                 u_long  vltime;
 135                 u_long  pltime;
 136                 u_long  expire;
 137                 u_short if_index;
 138                 u_short advrtrs; /* number of advertisement routers */
 139                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 140         } prefix[PRLSTSIZ];
 141 };
 142
 143 struct in6_prefix {
 144         struct  sockaddr_in6 prefix;
 145         struct prf_ra raflags;
 146         u_char  prefixlen;
 147         u_char  origin;
 148         u_long  vltime;
 149         u_long  pltime;
 150         u_long  expire;
 151         u_int32_t flags;
 152         int refcnt;
 153         u_short if_index;
 154         u_short advrtrs; /* number of advertisement routers */
 155         /* struct sockaddr_in6 advrtr[] */
 156 };
 157
 158 struct  in6_ondireq {
 159         char ifname[IFNAMSIZ];
 160         struct {
 161                 u_int32_t linkmtu;      /* LinkMTU */
 162                 u_int32_t maxmtu;       /* Upper bound of LinkMTU */
 163                 u_int32_t basereachable; /* BaseReachableTime */
 164                 u_int32_t reachable;    /* Reachable Time */
 165                 u_int32_t retrans;      /* Retrans Timer */
 166                 u_int32_t flags;        /* Flags */
 167                 int recalctm;           /* BaseReacable re-calculation timer */
 168                 u_int8_t chlim;         /* CurHopLimit */
 169                 u_int8_t receivedra;
 170         } ndi;
 171 };
 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_PRIVATE
 195 #define ND_IFINFO(ifp) \
 196         (&nd_ifinfo[(ifp)->if_index])
 197 /*
 198  * In a more readable form, we derive linkmtu based on:
 199  *
 200  * if (ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < ifp->if_mtu)
 201  *         linkmtu = ND_IFINFO(ifp)->linkmtu;
 202  * else if ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < ifp->if_mtu))
 203  *         linkmtu = ND_IFINFO(ifp)->maxmtu;
 204  * else
 205  *         linkmtu = ifp->if_mtu;
 206  */
 207 #define IN6_LINKMTU(ifp)                                                      \
 208         ((ND_IFINFO(ifp)->linkmtu &&                                          \
 209         ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) ? ND_IFINFO(ifp)->linkmtu :  \
 210         ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) ? \
 211         ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
 212
 213 /* node constants */
 214 #define MAX_REACHABLE_TIME              3600000 /* msec */
 215 #define REACHABLE_TIME                  30000   /* msec */
 216 #define RETRANS_TIMER                   1000    /* msec */
 217 #define MIN_RANDOM_FACTOR               512     /* 1024 * 0.5 */
 218 #define MAX_RANDOM_FACTOR               1536    /* 1024 * 1.5 */
 219 #define DEF_TEMP_VALID_LIFETIME         604800  /* 1 week */
 220 #define DEF_TEMP_PREFERRED_LIFETIME     86400   /* 1 day */
 221 #define TEMPADDR_REGEN_ADVANCE          5       /* sec */
 222 #define MAX_TEMP_DESYNC_FACTOR          600     /* 10 min */
 223 #define ND_COMPUTE_RTIME(x) \
 224                 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
 225                 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
 226
 227 TAILQ_HEAD(nd_drhead, nd_defrouter);
 228 struct  nd_defrouter {
 229         TAILQ_ENTRY(nd_defrouter) dr_entry;
 230         struct  in6_addr rtaddr;
 231         u_char  flags;          /* flags on RA message */
 232         u_short rtlifetime;
 233         u_long  expire;
 234         u_long  advint;         /* Mobile IPv6 addition (milliseconds) */
 235         u_long  advint_expire;  /* Mobile IPv6 addition */
 236         int     advints_lost;   /* Mobile IPv6 addition */
 237         struct  ifnet *ifp;
 238 };
 239
 240 struct nd_prefix {
 241         struct ifnet *ndpr_ifp;
 242         LIST_ENTRY(nd_prefix) ndpr_entry;
 243         struct sockaddr_in6 ndpr_prefix;        /* prefix */
 244         struct in6_addr ndpr_mask; /* netmask derived from the prefix */
 245         struct in6_addr ndpr_addr; /* address that is derived from the prefix */
 246         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
 247         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
 248         time_t ndpr_expire;     /* expiration time of the prefix */
 249         time_t ndpr_preferred;  /* preferred time of the prefix */
 250         struct prf_ra ndpr_flags;
 251         u_int32_t ndpr_stateflags; /* actual state flags */
 252         /* list of routers that advertise the prefix: */
 253         LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
 254         u_char  ndpr_plen;
 255         int     ndpr_refcnt;    /* reference counter from addresses */
 256         int     ndpr_usecnt;    /* actual use count; prevents free */
 257 };
 258
 259 #define ndpr_next               ndpr_entry.le_next
 260
 261 #define ndpr_raf                ndpr_flags
 262 #define ndpr_raf_onlink         ndpr_flags.onlink
 263 #define ndpr_raf_auto           ndpr_flags.autonomous
 264
 265 /*
 266  * We keep expired prefix for certain amount of time, for validation purposes.
 267  * 1800s = MaxRtrAdvInterval
 268  */
 269 #define NDPR_KEEP_EXPIRED       (1800 * 2)
 270
 271 /*
 272  * Message format for use in obtaining information about prefixes
 273  * from inet6 sysctl function
 274  */
 275 struct inet6_ndpr_msghdr {
 276         u_short inpm_msglen;    /* to skip over non-understood messages */
 277         u_char  inpm_version;   /* future binary compatibility */
 278         u_char  inpm_type;      /* message type */
 279         struct in6_addr inpm_prefix;
 280         u_long  prm_vltim;
 281         u_long  prm_pltime;
 282         u_long  prm_expire;
 283         u_long  prm_preferred;
 284         struct in6_prflags prm_flags;
 285         u_short prm_index;      /* index for associated ifp */
 286         u_char  prm_plen;       /* length of prefix in bits */
 287 };
 288
 289 #define prm_raf_onlink          prm_flags.prf_ra.onlink
 290 #define prm_raf_auto            prm_flags.prf_ra.autonomous
 291
 292 #define prm_statef_onlink       prm_flags.prf_state.onlink
 293
 294 #define prm_rrf_decrvalid       prm_flags.prf_rr.decrvalid
 295 #define prm_rrf_decrprefd       prm_flags.prf_rr.decrprefd
 296
 297 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
 298 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
 299
 300 struct nd_pfxrouter {
 301         LIST_ENTRY(nd_pfxrouter) pfr_entry;
 302 #define pfr_next pfr_entry.le_next
 303         struct nd_defrouter *router;
 304 };
 305
 306 LIST_HEAD(nd_prhead, nd_prefix);
 307
 308 /* nd6.c */
 309 extern int nd6_prune;
 310 extern int nd6_delay;
 311 extern int nd6_umaxtries;
 312 extern int nd6_mmaxtries;
 313 extern int nd6_useloopback;
 314 extern int nd6_maxnudhint;
 315 extern int nd6_gctimer;
 316 extern struct llinfo_nd6 llinfo_nd6;
 317 extern struct nd_ifinfo *nd_ifinfo;
 318 extern struct nd_drhead nd_defrouter;
 319 extern struct nd_prhead nd_prefix;
 320 extern int nd6_debug;
 321
 322 #define nd6log(x)       do { if (nd6_debug) log x; } while (0)
 323
 324 extern struct callout nd6_timer_ch;
 325
 326 /* nd6_rtr.c */
 327 extern int nd6_defifindex;
 328 extern int ip6_desync_factor;   /* seconds */
 329 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
 330 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
 331 extern int ip6_temp_regen_advance; /* seconds */
 332
 333 union nd_opts {
 334         struct nd_opt_hdr *nd_opt_array[9];     /*max = home agent info*/
 335         struct {
 336                 struct nd_opt_hdr *zero;
 337                 struct nd_opt_hdr *src_lladdr;
 338                 struct nd_opt_hdr *tgt_lladdr;
 339                 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
 340                 struct nd_opt_rd_hdr *rh;
 341                 struct nd_opt_mtu *mtu;
 342                 struct nd_opt_hdr *six;
 343                 struct nd_opt_advint *adv;
 344                 struct nd_opt_hai *hai;
 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_search          nd_opt_each.search
 360 #define nd_opts_last            nd_opt_each.last
 361 #define nd_opts_done            nd_opt_each.done
 362
 363 /* XXX: need nd6_var.h?? */
 364 /* nd6.c */
 365 void nd6_init(void);
 366 void nd6_ifattach(struct ifnet *);
 367 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *, int);
 368 void nd6_option_init(void *, int, union nd_opts *);
 369 struct nd_opt_hdr *nd6_option(union nd_opts *);
 370 int nd6_options(union nd_opts *);
 371 struct  rtentry *nd6_lookup(struct in6_addr *, int, struct ifnet *, int);
 372 void nd6_setmtu(struct ifnet *);
 373 void nd6_timer(void *);
 374 void nd6_purge(struct ifnet *);
 375 struct llinfo_nd6 *nd6_free(struct rtentry *);
 376 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
 377 int nd6_resolve(struct ifnet *, struct rtentry *,
 378                      struct mbuf *, struct sockaddr *, u_char *);
 379 void nd6_rtrequest(int, struct rtentry *, struct sockaddr *);
 380 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
 381 struct rtentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
 382         char *, int, int, int);
 383 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
 384                     struct sockaddr_in6 *, struct rtentry *, int);
 385 int nd6_storelladdr(struct ifnet *, struct rtentry *, struct mbuf *,
 386                          struct sockaddr *, u_char *);
 387 int nd6_need_cache(struct ifnet *);
 388
 389 /* nd6_nbr.c */
 390 void nd6_na_input(struct mbuf *, int, int);
 391 void nd6_na_output(struct ifnet *, const struct in6_addr *,
 392         const struct in6_addr *, u_long, int, struct sockaddr *);
 393 void nd6_ns_input(struct mbuf *, int, int);
 394 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
 395         const struct in6_addr *, struct llinfo_nd6 *, int, int);
 396 caddr_t nd6_ifptomac(struct ifnet *);
 397 void nd6_dad_start(struct ifaddr *, int *);
 398 void nd6_dad_stop(struct ifaddr *);
 399 void nd6_dad_duplicated(struct ifaddr *);
 400
 401 /* nd6_rtr.c */
 402 void nd6_rs_input(struct mbuf *, int, int);
 403 void nd6_ra_input(struct mbuf *, int, int);
 404 void prelist_del(struct nd_prefix *);
 405 void defrouter_addreq(struct nd_defrouter *);
 406 void defrouter_delreq(struct nd_defrouter *, int);
 407 void defrouter_select(void);
 408 void defrtrlist_del(struct nd_defrouter *, int);
 409 void prelist_remove(struct nd_prefix *, int);
 410 int prelist_update(struct nd_prefix *, struct nd_defrouter *,
 411                         struct mbuf *);
 412 int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *,
 413                          struct nd_prefix **);
 414 int nd6_prefix_onlink(struct nd_prefix *, int, int);
 415 int nd6_prefix_offlink(struct nd_prefix *);
 416 void pfxlist_onlink_check(int);
 417 struct nd_defrouter *defrouter_lookup(struct in6_addr *,
 418                                            struct ifnet *);
 419 struct nd_prefix *nd6_prefix_lookup(struct nd_prefix *);
 420 int in6_init_prefix_ltimes(struct nd_prefix *ndpr);
 421 void rt6_flush(struct in6_addr *, struct ifnet *);
 422 int nd6_setdefaultiface(int);
 423 int in6_tmpifadd(const struct in6_ifaddr *, int);
 424 void ndpr_hold(struct nd_prefix *, boolean_t);
 425 void ndpr_rele(struct nd_prefix *, boolean_t);
 426 #endif /* KERNEL_PRIVATE */
 427
 428 #ifdef KERNEL
 429
 430 /*!
 431         @function nd6_lookup_ipv6
 432         @discussion This function will check the routing table for a cached
 433                 neighbor discovery entry or trigger an neighbor discovery query
 434                 to resolve the IPv6 address to a link-layer address.
 435
 436                 nd entries are stored in the routing table. This function will
 437                 lookup the IPv6 destination in the routing table. If the
 438                 destination requires forwarding to a gateway, the route of the
 439                 gateway will be looked up. The route entry is inspected to
 440                 determine if the link layer destination address is known. If
 441                 unknown, neighbor discovery will be used to resolve the entry.
 442         @param interface The interface the packet is being sent on.
 443         @param ip6_dest The IPv6 destination of the packet.
 444         @param ll_dest On output, the link-layer destination.
 445         @param ll_dest_len The length of the buffer for ll_dest.
 446         @param hint Any routing hint passed down from the protocol.
 447         @param packet The packet being transmitted.
 448         @result May return an error such as EHOSTDOWN or ENETUNREACH. If
 449                 this function returns EJUSTRETURN, the packet has been queued
 450                 and will be sent when the address is resolved. If any other
 451                 value is returned, the caller is responsible for disposing of
 452                 the packet.
 453  */
 454 errno_t nd6_lookup_ipv6(ifnet_t interface, const struct sockaddr_in6 *ip6_dest,
 455                         struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
 456                         mbuf_t packet);
 457
 458 #endif KERNEL
 459 #endif /* _NETINET6_ND6_H_ */