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_NOSTATE      -2
  59 /*
  60  * We don't need the WAITDELETE state any more, but we keep the definition
  61  * in a comment line instead of removing it. This is necessary to avoid
  62  * unintentionally reusing the value for another purpose, which might
  63  * affect backward compatibility with old applications.
  64  * (20000711 jinmei@kame.net)
  65  */
  66 /* #define ND6_LLINFO_WAITDELETE        -1 */
  67 #define ND6_LLINFO_INCOMPLETE   0
  68 #define ND6_LLINFO_REACHABLE    1
  69 #define ND6_LLINFO_STALE        2
  70 #define ND6_LLINFO_DELAY        3
  71 #define ND6_LLINFO_PROBE        4
  72
  73 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
  74
  75 struct nd_ifinfo {
  76         u_int32_t linkmtu;              /* LinkMTU */
  77         u_int32_t maxmtu;               /* Upper bound of LinkMTU */
  78         u_int32_t basereachable;        /* BaseReachableTime */
  79         u_int32_t reachable;            /* Reachable Time */
  80         u_int32_t retrans;              /* Retrans Timer */
  81         u_int32_t flags;                /* Flags */
  82         int recalctm;                   /* BaseReacable re-calculation timer */
  83         u_int8_t chlim;                 /* CurHopLimit */
  84         u_int8_t receivedra;
  85         /* the following 3 members are for privacy extension for addrconf */
  86         u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
  87         u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
  88         u_int8_t randomid[8];   /* current random ID */
  89 };
  90
  91 #define ND6_IFF_PERFORMNUD      0x1
  92
  93 struct in6_nbrinfo {
  94         char ifname[IFNAMSIZ];  /* if name, e.g. "en0" */
  95         struct in6_addr addr;   /* IPv6 address of the neighbor */
  96         long    asked;          /* number of queries already sent for this addr */
  97         int     isrouter;       /* if it acts as a router */
  98         int     state;          /* reachability state */
  99         int     expire;         /* lifetime for NDP state transition */
 100 };
 101
 102 #define DRLSTSIZ 10
 103 #define PRLSTSIZ 10
 104 struct  in6_drlist {
 105         char ifname[IFNAMSIZ];
 106         struct {
 107                 struct  in6_addr rtaddr;
 108                 u_char  flags;
 109                 u_short rtlifetime;
 110                 u_long  expire;
 111                 u_short if_index;
 112         } defrouter[DRLSTSIZ];
 113 };
 114
 115 struct  in6_defrouter {
 116         struct  sockaddr_in6 rtaddr;
 117         u_char  flags;
 118         u_short rtlifetime;
 119         u_long  expire;
 120         u_short if_index;
 121 };
 122
 123 struct  in6_prlist {
 124         char ifname[IFNAMSIZ];
 125         struct {
 126                 struct  in6_addr prefix;
 127                 struct prf_ra raflags;
 128                 u_char  prefixlen;
 129                 u_char  origin;
 130                 u_long  vltime;
 131                 u_long  pltime;
 132                 u_long  expire;
 133                 u_short if_index;
 134                 u_short advrtrs; /* number of advertisement routers */
 135                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 136         } prefix[PRLSTSIZ];
 137 };
 138
 139 struct in6_prefix {
 140         struct  sockaddr_in6 prefix;
 141         struct prf_ra raflags;
 142         u_char  prefixlen;
 143         u_char  origin;
 144         u_long  vltime;
 145         u_long  pltime;
 146         u_long  expire;
 147         u_int32_t flags;
 148         int refcnt;
 149         u_short if_index;
 150         u_short advrtrs; /* number of advertisement routers */
 151         /* struct sockaddr_in6 advrtr[] */
 152 };
 153
 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
 169 struct  in6_ndireq {
 170         char ifname[IFNAMSIZ];
 171         struct nd_ifinfo ndi;
 172 };
 173
 174 struct  in6_ndifreq {
 175         char ifname[IFNAMSIZ];
 176         u_long ifindex;
 177 };
 178
 179 /* Prefix status */
 180 #define NDPRF_ONLINK            0x1
 181 #define NDPRF_DETACHED          0x2
 182
 183 /* protocol constants */
 184 #define MAX_RTR_SOLICITATION_DELAY      1       /*1sec*/
 185 #define RTR_SOLICITATION_INTERVAL       4       /*4sec*/
 186 #define MAX_RTR_SOLICITATIONS           3
 187
 188 #define ND6_INFINITE_LIFETIME           0xffffffff
 189
 190 #ifdef KERNEL_PRIVATE
 191 /* node constants */
 192 #define MAX_REACHABLE_TIME              3600000 /* msec */
 193 #define REACHABLE_TIME                  30000   /* msec */
 194 #define RETRANS_TIMER                   1000    /* msec */
 195 #define MIN_RANDOM_FACTOR               512     /* 1024 * 0.5 */
 196 #define MAX_RANDOM_FACTOR               1536    /* 1024 * 1.5 */
 197 #define DEF_TEMP_VALID_LIFETIME         604800  /* 1 week */
 198 #define DEF_TEMP_PREFERRED_LIFETIME     86400   /* 1 day */
 199 #define TEMPADDR_REGEN_ADVANCE          5       /* sec */
 200 #define MAX_TEMP_DESYNC_FACTOR          600     /* 10 min */
 201 #define ND_COMPUTE_RTIME(x) \
 202                 (((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
 203                 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
 204
 205 TAILQ_HEAD(nd_drhead, nd_defrouter);
 206 struct  nd_defrouter {
 207         TAILQ_ENTRY(nd_defrouter) dr_entry;
 208         struct  in6_addr rtaddr;
 209         u_char  flags;          /* flags on RA message */
 210         u_short rtlifetime;
 211         u_long  expire;
 212         u_long  advint;         /* Mobile IPv6 addition (milliseconds) */
 213         u_long  advint_expire;  /* Mobile IPv6 addition */
 214         int     advints_lost;   /* Mobile IPv6 addition */
 215         struct  ifnet *ifp;
 216 };
 217
 218 struct nd_prefix {
 219         struct ifnet *ndpr_ifp;
 220         LIST_ENTRY(nd_prefix) ndpr_entry;
 221         struct sockaddr_in6 ndpr_prefix;        /* prefix */
 222         struct in6_addr ndpr_mask; /* netmask derived from the prefix */
 223         struct in6_addr ndpr_addr; /* address that is derived from the prefix */
 224         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
 225         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
 226         time_t ndpr_expire;     /* expiration time of the prefix */
 227         time_t ndpr_preferred;  /* preferred time of the prefix */
 228         struct prf_ra ndpr_flags;
 229         u_int32_t ndpr_stateflags; /* actual state flags */
 230         /* list of routers that advertise the prefix: */
 231         LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
 232         u_char  ndpr_plen;
 233         int     ndpr_refcnt;    /* reference couter from addresses */
 234 };
 235
 236 #define ndpr_next               ndpr_entry.le_next
 237
 238 #define ndpr_raf                ndpr_flags
 239 #define ndpr_raf_onlink         ndpr_flags.onlink
 240 #define ndpr_raf_auto           ndpr_flags.autonomous
 241
 242 /*
 243  * We keep expired prefix for certain amount of time, for validation purposes.
 244  * 1800s = MaxRtrAdvInterval
 245  */
 246 #define NDPR_KEEP_EXPIRED       (1800 * 2)
 247
 248 /*
 249  * Message format for use in obtaining information about prefixes
 250  * from inet6 sysctl function
 251  */
 252 struct inet6_ndpr_msghdr {
 253         u_short inpm_msglen;    /* to skip over non-understood messages */
 254         u_char  inpm_version;   /* future binary compatibility */
 255         u_char  inpm_type;      /* message type */
 256         struct in6_addr inpm_prefix;
 257         u_long  prm_vltim;
 258         u_long  prm_pltime;
 259         u_long  prm_expire;
 260         u_long  prm_preferred;
 261         struct in6_prflags prm_flags;
 262         u_short prm_index;      /* index for associated ifp */
 263         u_char  prm_plen;       /* length of prefix in bits */
 264 };
 265
 266 #define prm_raf_onlink          prm_flags.prf_ra.onlink
 267 #define prm_raf_auto            prm_flags.prf_ra.autonomous
 268
 269 #define prm_statef_onlink       prm_flags.prf_state.onlink
 270
 271 #define prm_rrf_decrvalid       prm_flags.prf_rr.decrvalid
 272 #define prm_rrf_decrprefd       prm_flags.prf_rr.decrprefd
 273
 274 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
 275 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
 276
 277 struct nd_pfxrouter {
 278         LIST_ENTRY(nd_pfxrouter) pfr_entry;
 279 #define pfr_next pfr_entry.le_next
 280         struct nd_defrouter *router;
 281 };
 282
 283 LIST_HEAD(nd_prhead, nd_prefix);
 284
 285 /* nd6.c */
 286 extern int nd6_prune;
 287 extern int nd6_delay;
 288 extern int nd6_umaxtries;
 289 extern int nd6_mmaxtries;
 290 extern int nd6_useloopback;
 291 extern int nd6_maxnudhint;
 292 extern int nd6_gctimer;
 293 extern struct llinfo_nd6 llinfo_nd6;
 294 extern struct nd_ifinfo *nd_ifinfo;
 295 extern struct nd_drhead nd_defrouter;
 296 extern struct nd_prhead nd_prefix;
 297 extern int nd6_debug;
 298
 299 #define nd6log(x)       do { if (nd6_debug) log x; } while (0)
 300
 301 extern struct callout nd6_timer_ch;
 302
 303 /* nd6_rtr.c */
 304 extern int nd6_defifindex;
 305 extern int ip6_desync_factor;   /* seconds */
 306 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
 307 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
 308 extern int ip6_temp_regen_advance; /* seconds */
 309
 310 union nd_opts {
 311         struct nd_opt_hdr *nd_opt_array[9];     /*max = home agent info*/
 312         struct {
 313                 struct nd_opt_hdr *zero;
 314                 struct nd_opt_hdr *src_lladdr;
 315                 struct nd_opt_hdr *tgt_lladdr;
 316                 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
 317                 struct nd_opt_rd_hdr *rh;
 318                 struct nd_opt_mtu *mtu;
 319                 struct nd_opt_hdr *six;
 320                 struct nd_opt_advint *adv;
 321                 struct nd_opt_hai *hai;
 322                 struct nd_opt_hdr *search;      /* multiple opts */
 323                 struct nd_opt_hdr *last;        /* multiple opts */
 324                 int done;
 325                 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
 326         } nd_opt_each;
 327 };
 328 #define nd_opts_src_lladdr      nd_opt_each.src_lladdr
 329 #define nd_opts_tgt_lladdr      nd_opt_each.tgt_lladdr
 330 #define nd_opts_pi              nd_opt_each.pi_beg
 331 #define nd_opts_pi_end          nd_opt_each.pi_end
 332 #define nd_opts_rh              nd_opt_each.rh
 333 #define nd_opts_mtu             nd_opt_each.mtu
 334 #define nd_opts_adv             nd_opt_each.adv
 335 #define nd_opts_hai             nd_opt_each.hai
 336 #define nd_opts_search          nd_opt_each.search
 337 #define nd_opts_last            nd_opt_each.last
 338 #define nd_opts_done            nd_opt_each.done
 339
 340 /* XXX: need nd6_var.h?? */
 341 /* nd6.c */
 342 void nd6_init(void);
 343 void nd6_ifattach(struct ifnet *);
 344 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *, int);
 345 void nd6_option_init(void *, int, union nd_opts *);
 346 struct nd_opt_hdr *nd6_option(union nd_opts *);
 347 int nd6_options(union nd_opts *);
 348 struct  rtentry *nd6_lookup(struct in6_addr *, int, struct ifnet *, int);
 349 void nd6_setmtu(struct ifnet *);
 350 void nd6_timer(void *);
 351 void nd6_purge(struct ifnet *);
 352 struct llinfo_nd6 *nd6_free(struct rtentry *);
 353 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
 354 int nd6_resolve(struct ifnet *, struct rtentry *,
 355                      struct mbuf *, struct sockaddr *, u_char *);
 356 void nd6_rtrequest(int, struct rtentry *, struct sockaddr *);
 357 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
 358 struct rtentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
 359         char *, int, int, int);
 360 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
 361                     struct sockaddr_in6 *, struct rtentry *, int);
 362 int nd6_storelladdr(struct ifnet *, struct rtentry *, struct mbuf *,
 363                          struct sockaddr *, u_char *);
 364 int nd6_need_cache(struct ifnet *);
 365
 366 /* nd6_nbr.c */
 367 void nd6_na_input(struct mbuf *, int, int);
 368 void nd6_na_output(struct ifnet *, const struct in6_addr *,
 369         const struct in6_addr *, u_long, int, struct sockaddr *);
 370 void nd6_ns_input(struct mbuf *, int, int);
 371 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
 372         const struct in6_addr *, struct llinfo_nd6 *, int, int);
 373 caddr_t nd6_ifptomac(struct ifnet *);
 374 void nd6_dad_start(struct ifaddr *, int *);
 375 void nd6_dad_stop(struct ifaddr *);
 376 void nd6_dad_duplicated(struct ifaddr *);
 377
 378 /* nd6_rtr.c */
 379 void nd6_rs_input(struct mbuf *, int, int);
 380 void nd6_ra_input(struct mbuf *, int, int);
 381 void prelist_del(struct nd_prefix *);
 382 void defrouter_addreq(struct nd_defrouter *);
 383 void defrouter_delreq(struct nd_defrouter *, int);
 384 void defrouter_select(void);
 385 void defrtrlist_del(struct nd_defrouter *, int);
 386 void prelist_remove(struct nd_prefix *, int);
 387 int prelist_update(struct nd_prefix *, struct nd_defrouter *,
 388                         struct mbuf *);
 389 int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *,
 390                          struct nd_prefix **);
 391 int nd6_prefix_onlink(struct nd_prefix *, int, int);
 392 int nd6_prefix_offlink(struct nd_prefix *);
 393 void pfxlist_onlink_check(int);
 394 struct nd_defrouter *defrouter_lookup(struct in6_addr *,
 395                                            struct ifnet *);
 396 struct nd_prefix *nd6_prefix_lookup(struct nd_prefix *);
 397 int in6_init_prefix_ltimes(struct nd_prefix *ndpr);
 398 void rt6_flush(struct in6_addr *, struct ifnet *);
 399 int nd6_setdefaultiface(int);
 400 int in6_tmpifadd(const struct in6_ifaddr *, int);
 401 #endif /* KERNEL_PRIVATE */
 402
 403 #ifdef KERNEL
 404
 405 /*!
 406         @function nd6_lookup_ipv6
 407         @discussion This function will check the routing table for a cached
 408                 neighbor discovery entry or trigger an neighbor discovery query
 409                 to resolve the IPv6 address to a link-layer address.
 410
 411                 nd entries are stored in the routing table. This function will
 412                 lookup the IPv6 destination in the routing table. If the
 413                 destination requires forwarding to a gateway, the route of the
 414                 gateway will be looked up. The route entry is inspected to
 415                 determine if the link layer destination address is known. If
 416                 unknown, neighbor discovery will be used to resolve the entry.
 417         @param interface The interface the packet is being sent on.
 418         @param ip6_dest The IPv6 destination of the packet.
 419         @param ll_dest On output, the link-layer destination.
 420         @param ll_dest_len The length of the buffer for ll_dest.
 421         @param hint Any routing hint passed down from the protocol.
 422         @param packet The packet being transmitted.
 423         @result May return an error such as EHOSTDOWN or ENETUNREACH. If
 424                 this function returns EJUSTRETURN, the packet has been queued
 425                 and will be sent when the address is resolved. If any other
 426                 value is returned, the caller is responsible for disposing of
 427                 the packet.
 428  */
 429 errno_t nd6_lookup_ipv6(ifnet_t interface, const struct sockaddr_in6 *ip6_dest,
 430                         struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
 431                         mbuf_t packet);
 432
 433 #endif KERNEL
 434 #endif /* _NETINET6_ND6_H_ */