sys/netinet6/nd6.h

   1 /*-
   2  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the project nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $
  30  * $FreeBSD$
  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 llentry;
  45
  46 #define ND6_LLINFO_NOSTATE      -2
  47 /*
  48  * We don't need the WAITDELETE state any more, but we keep the definition
  49  * in a comment line instead of removing it. This is necessary to avoid
  50  * unintentionally reusing the value for another purpose, which might
  51  * affect backward compatibility with old applications.
  52  * (20000711 jinmei@kame.net)
  53  */
  54 /* #define ND6_LLINFO_WAITDELETE        -1 */
  55 #define ND6_LLINFO_INCOMPLETE   0
  56 #define ND6_LLINFO_REACHABLE    1
  57 #define ND6_LLINFO_STALE        2
  58 #define ND6_LLINFO_DELAY        3
  59 #define ND6_LLINFO_PROBE        4
  60
  61 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
  62 #define ND6_LLINFO_PERMANENT(n) (((n)->la_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
  63
  64 struct nd_ifinfo {
  65         u_int32_t linkmtu;              /* LinkMTU */
  66         u_int32_t maxmtu;               /* Upper bound of LinkMTU */
  67         u_int32_t basereachable;        /* BaseReachableTime */
  68         u_int32_t reachable;            /* Reachable Time */
  69         u_int32_t retrans;              /* Retrans Timer */
  70         u_int32_t flags;                /* Flags */
  71         int recalctm;                   /* BaseReacable re-calculation timer */
  72         u_int8_t chlim;                 /* CurHopLimit */
  73         u_int8_t initialized; /* Flag to see the entry is initialized */
  74         /* the following 3 members are for privacy extension for addrconf */
  75         u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
  76         u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
  77         u_int8_t randomid[8];   /* current random ID */
  78 };
  79
  80 #define ND6_IFF_PERFORMNUD      0x1
  81 #define ND6_IFF_ACCEPT_RTADV    0x2
  82 #define ND6_IFF_PREFER_SOURCE   0x4 /* Not used in FreeBSD. */
  83 #define ND6_IFF_IFDISABLED      0x8 /* IPv6 operation is disabled due to
  84                                      * DAD failure.  (XXX: not ND-specific)
  85                                      */
  86 #define ND6_IFF_DONT_SET_IFROUTE        0x10
  87 #define ND6_IFF_AUTO_LINKLOCAL  0x20
  88 #define ND6_IFF_NO_RADR         0x40
  89 #define ND6_IFF_NO_PREFER_IFACE 0x80 /* XXX: not related to ND. */
  90 #define ND6_IFF_IGNORELOOP      0x100
  91 #define ND6_IFF_NO_DAD          0x200
  92
  93 #define ND6_CREATE              LLE_CREATE
  94 #define ND6_EXCLUSIVE           LLE_EXCLUSIVE
  95
  96 #ifdef _KERNEL
  97 #define ND_IFINFO(ifp) \
  98         (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
  99 #define IN6_LINKMTU(ifp) \
 100         ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
 101             ? ND_IFINFO(ifp)->linkmtu \
 102             : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
 103                 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
 104 #endif
 105
 106 struct in6_nbrinfo {
 107         char ifname[IFNAMSIZ];  /* if name, e.g. "en0" */
 108         struct in6_addr addr;   /* IPv6 address of the neighbor */
 109         long    asked;          /* number of queries already sent for this addr */
 110         int     isrouter;       /* if it acts as a router */
 111         int     state;          /* reachability state */
 112         int     expire;         /* lifetime for NDP state transition */
 113 };
 114
 115 #define DRLSTSIZ 10
 116 #define PRLSTSIZ 10
 117 struct  in6_drlist {
 118         char ifname[IFNAMSIZ];
 119         struct {
 120                 struct  in6_addr rtaddr;
 121                 u_char  flags;
 122                 u_short rtlifetime;
 123                 u_long  expire;
 124                 u_short if_index;
 125         } defrouter[DRLSTSIZ];
 126 };
 127
 128 struct  in6_defrouter {
 129         struct  sockaddr_in6 rtaddr;
 130         u_char  flags;
 131         u_short rtlifetime;
 132         u_long  expire;
 133         u_short if_index;
 134 };
 135
 136 #ifdef _KERNEL
 137 struct  in6_oprlist {
 138         char ifname[IFNAMSIZ];
 139         struct {
 140                 struct  in6_addr 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_short if_index;
 148                 u_short advrtrs; /* number of advertisement routers */
 149                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 150         } prefix[PRLSTSIZ];
 151 };
 152 #endif
 153
 154 struct  in6_prlist {
 155         char ifname[IFNAMSIZ];
 156         struct {
 157                 struct  in6_addr prefix;
 158                 struct prf_ra raflags;
 159                 u_char  prefixlen;
 160                 u_char  origin;
 161                 u_int32_t vltime;
 162                 u_int32_t pltime;
 163                 time_t expire;
 164                 u_short if_index;
 165                 u_short advrtrs; /* number of advertisement routers */
 166                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 167         } prefix[PRLSTSIZ];
 168 };
 169
 170 struct in6_prefix {
 171         struct  sockaddr_in6 prefix;
 172         struct prf_ra raflags;
 173         u_char  prefixlen;
 174         u_char  origin;
 175         u_int32_t vltime;
 176         u_int32_t pltime;
 177         time_t expire;
 178         u_int32_t flags;
 179         int refcnt;
 180         u_short if_index;
 181         u_short advrtrs; /* number of advertisement routers */
 182         /* struct sockaddr_in6 advrtr[] */
 183 };
 184
 185 #ifdef _KERNEL
 186 struct  in6_ondireq {
 187         char ifname[IFNAMSIZ];
 188         struct {
 189                 u_int32_t linkmtu;      /* LinkMTU */
 190                 u_int32_t maxmtu;       /* Upper bound of LinkMTU */
 191                 u_int32_t basereachable; /* BaseReachableTime */
 192                 u_int32_t reachable;    /* Reachable Time */
 193                 u_int32_t retrans;      /* Retrans Timer */
 194                 u_int32_t flags;        /* Flags */
 195                 int recalctm;           /* BaseReacable re-calculation timer */
 196                 u_int8_t chlim;         /* CurHopLimit */
 197                 u_int8_t receivedra;
 198         } ndi;
 199 };
 200 #endif
 201
 202 struct  in6_ndireq {
 203         char ifname[IFNAMSIZ];
 204         struct nd_ifinfo ndi;
 205 };
 206
 207 struct  in6_ndifreq {
 208         char ifname[IFNAMSIZ];
 209         u_long ifindex;
 210 };
 211
 212 /* Prefix status */
 213 #define NDPRF_ONLINK            0x1
 214 #define NDPRF_DETACHED          0x2
 215
 216 /* protocol constants */
 217 #define MAX_RTR_SOLICITATION_DELAY      1       /* 1sec */
 218 #define RTR_SOLICITATION_INTERVAL       4       /* 4sec */
 219 #define MAX_RTR_SOLICITATIONS           3
 220
 221 #define ND6_INFINITE_LIFETIME           0xffffffff
 222
 223 #ifdef _KERNEL
 224 /* node constants */
 225 #define MAX_REACHABLE_TIME              3600000 /* msec */
 226 #define REACHABLE_TIME                  30000   /* msec */
 227 #define RETRANS_TIMER                   1000    /* msec */
 228 #define MIN_RANDOM_FACTOR               512     /* 1024 * 0.5 */
 229 #define MAX_RANDOM_FACTOR               1536    /* 1024 * 1.5 */
 230 #define DEF_TEMP_VALID_LIFETIME         604800  /* 1 week */
 231 #define DEF_TEMP_PREFERRED_LIFETIME     86400   /* 1 day */
 232 #define TEMPADDR_REGEN_ADVANCE          5       /* sec */
 233 #define MAX_TEMP_DESYNC_FACTOR          600     /* 10 min */
 234 #define ND_COMPUTE_RTIME(x) \
 235                 (((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
 236                 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
 237
 238 TAILQ_HEAD(nd_drhead, nd_defrouter);
 239 struct  nd_defrouter {
 240         TAILQ_ENTRY(nd_defrouter) dr_entry;
 241         struct  in6_addr rtaddr;
 242         u_char  flags;          /* flags on RA message */
 243         u_short rtlifetime;
 244         u_long  expire;
 245         struct  ifnet *ifp;
 246         int     installed;      /* is installed into kernel routing table */
 247 };
 248
 249 struct nd_prefixctl {
 250         struct ifnet *ndpr_ifp;
 251
 252         /* prefix */
 253         struct sockaddr_in6 ndpr_prefix;
 254         u_char  ndpr_plen;
 255
 256         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
 257         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
 258
 259         struct prf_ra ndpr_flags;
 260 };
 261
 262
 263 struct nd_prefix {
 264         struct ifnet *ndpr_ifp;
 265         LIST_ENTRY(nd_prefix) ndpr_entry;
 266         struct sockaddr_in6 ndpr_prefix;        /* prefix */
 267         struct in6_addr ndpr_mask; /* netmask derived from the prefix */
 268
 269         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
 270         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
 271
 272         time_t ndpr_expire;     /* expiration time of the prefix */
 273         time_t ndpr_preferred;  /* preferred time of the prefix */
 274         time_t ndpr_lastupdate; /* reception time of last advertisement */
 275
 276         struct prf_ra ndpr_flags;
 277         u_int32_t ndpr_stateflags; /* actual state flags */
 278         /* list of routers that advertise the prefix: */
 279         LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
 280         u_char  ndpr_plen;
 281         int     ndpr_refcnt;    /* reference couter from addresses */
 282 };
 283
 284 #define ndpr_raf                ndpr_flags
 285 #define ndpr_raf_onlink         ndpr_flags.onlink
 286 #define ndpr_raf_auto           ndpr_flags.autonomous
 287 #define ndpr_raf_router         ndpr_flags.router
 288
 289 /*
 290  * Message format for use in obtaining information about prefixes
 291  * from inet6 sysctl function
 292  */
 293 struct inet6_ndpr_msghdr {
 294         u_short inpm_msglen;    /* to skip over non-understood messages */
 295         u_char  inpm_version;   /* future binary compatibility */
 296         u_char  inpm_type;      /* message type */
 297         struct in6_addr inpm_prefix;
 298         u_long  prm_vltim;
 299         u_long  prm_pltime;
 300         u_long  prm_expire;
 301         u_long  prm_preferred;
 302         struct in6_prflags prm_flags;
 303         u_short prm_index;      /* index for associated ifp */
 304         u_char  prm_plen;       /* length of prefix in bits */
 305 };
 306
 307 #define prm_raf_onlink          prm_flags.prf_ra.onlink
 308 #define prm_raf_auto            prm_flags.prf_ra.autonomous
 309
 310 #define prm_statef_onlink       prm_flags.prf_state.onlink
 311
 312 #define prm_rrf_decrvalid       prm_flags.prf_rr.decrvalid
 313 #define prm_rrf_decrprefd       prm_flags.prf_rr.decrprefd
 314
 315 struct nd_pfxrouter {
 316         LIST_ENTRY(nd_pfxrouter) pfr_entry;
 317         struct nd_defrouter *router;
 318 };
 319
 320 LIST_HEAD(nd_prhead, nd_prefix);
 321
 322 /* nd6.c */
 323 VNET_DECLARE(int, nd6_prune);
 324 VNET_DECLARE(int, nd6_delay);
 325 VNET_DECLARE(int, nd6_umaxtries);
 326 VNET_DECLARE(int, nd6_mmaxtries);
 327 VNET_DECLARE(int, nd6_useloopback);
 328 VNET_DECLARE(int, nd6_maxnudhint);
 329 VNET_DECLARE(int, nd6_gctimer);
 330 VNET_DECLARE(struct nd_drhead, nd_defrouter);
 331 VNET_DECLARE(struct nd_prhead, nd_prefix);
 332 VNET_DECLARE(int, nd6_debug);
 333 VNET_DECLARE(int, nd6_onlink_ns_rfc4861);
 334 #define V_nd6_prune                     VNET(nd6_prune)
 335 #define V_nd6_delay                     VNET(nd6_delay)
 336 #define V_nd6_umaxtries                 VNET(nd6_umaxtries)
 337 #define V_nd6_mmaxtries                 VNET(nd6_mmaxtries)
 338 #define V_nd6_useloopback               VNET(nd6_useloopback)
 339 #define V_nd6_maxnudhint                VNET(nd6_maxnudhint)
 340 #define V_nd6_gctimer                   VNET(nd6_gctimer)
 341 #define V_nd_defrouter                  VNET(nd_defrouter)
 342 #define V_nd_prefix                     VNET(nd_prefix)
 343 #define V_nd6_debug                     VNET(nd6_debug)
 344 #define V_nd6_onlink_ns_rfc4861         VNET(nd6_onlink_ns_rfc4861)
 345
 346 #define nd6log(x)       do { if (V_nd6_debug) log x; } while (/*CONSTCOND*/ 0)
 347
 348 VNET_DECLARE(struct callout, nd6_timer_ch);
 349 #define V_nd6_timer_ch                  VNET(nd6_timer_ch)
 350
 351 /* nd6_rtr.c */
 352 VNET_DECLARE(int, nd6_defifindex);
 353 VNET_DECLARE(int, ip6_desync_factor);   /* seconds */
 354 VNET_DECLARE(u_int32_t, ip6_temp_preferred_lifetime); /* seconds */
 355 VNET_DECLARE(u_int32_t, ip6_temp_valid_lifetime); /* seconds */
 356 VNET_DECLARE(int, ip6_temp_regen_advance); /* seconds */
 357 #define V_nd6_defifindex                VNET(nd6_defifindex)
 358 #define V_ip6_desync_factor             VNET(ip6_desync_factor)
 359 #define V_ip6_temp_preferred_lifetime   VNET(ip6_temp_preferred_lifetime)
 360 #define V_ip6_temp_valid_lifetime       VNET(ip6_temp_valid_lifetime)
 361 #define V_ip6_temp_regen_advance        VNET(ip6_temp_regen_advance)
 362
 363 union nd_opts {
 364         struct nd_opt_hdr *nd_opt_array[16];    /* max = ND_OPT_NONCE */
 365         struct {
 366                 struct nd_opt_hdr *zero;
 367                 struct nd_opt_hdr *src_lladdr;
 368                 struct nd_opt_hdr *tgt_lladdr;
 369                 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
 370                 struct nd_opt_rd_hdr *rh;
 371                 struct nd_opt_mtu *mtu;
 372                 struct nd_opt_hdr *__res6;
 373                 struct nd_opt_hdr *__res7;
 374                 struct nd_opt_hdr *__res8;
 375                 struct nd_opt_hdr *__res9;
 376                 struct nd_opt_hdr *__res10;
 377                 struct nd_opt_hdr *__res11;
 378                 struct nd_opt_hdr *__res12;
 379                 struct nd_opt_hdr *__res13;
 380                 struct nd_opt_nonce *nonce;
 381                 struct nd_opt_hdr *__res15;
 382                 struct nd_opt_hdr *search;      /* multiple opts */
 383                 struct nd_opt_hdr *last;        /* multiple opts */
 384                 int done;
 385                 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
 386         } nd_opt_each;
 387 };
 388 #define nd_opts_src_lladdr      nd_opt_each.src_lladdr
 389 #define nd_opts_tgt_lladdr      nd_opt_each.tgt_lladdr
 390 #define nd_opts_pi              nd_opt_each.pi_beg
 391 #define nd_opts_pi_end          nd_opt_each.pi_end
 392 #define nd_opts_rh              nd_opt_each.rh
 393 #define nd_opts_mtu             nd_opt_each.mtu
 394 #define nd_opts_nonce           nd_opt_each.nonce
 395 #define nd_opts_search          nd_opt_each.search
 396 #define nd_opts_last            nd_opt_each.last
 397 #define nd_opts_done            nd_opt_each.done
 398
 399 /* XXX: need nd6_var.h?? */
 400 /* nd6.c */
 401 void nd6_init(void);
 402 #ifdef VIMAGE
 403 void nd6_destroy(void);
 404 #endif
 405 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
 406 void nd6_ifdetach(struct nd_ifinfo *);
 407 int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *);
 408 void nd6_option_init(void *, int, union nd_opts *);
 409 struct nd_opt_hdr *nd6_option(union nd_opts *);
 410 int nd6_options(union nd_opts *);
 411 struct  llentry *nd6_lookup(struct in6_addr *, int, struct ifnet *);
 412 void nd6_setmtu(struct ifnet *);
 413 void nd6_llinfo_settimer(struct llentry *, long);
 414 void nd6_llinfo_settimer_locked(struct llentry *, long);
 415 void nd6_timer(void *);
 416 void nd6_purge(struct ifnet *);
 417 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
 418 int nd6_resolve(struct ifnet *, struct rtentry *, struct mbuf *,
 419         struct sockaddr *, u_char *);
 420 void nd6_rtrequest(int, struct rtentry *, struct rt_addrinfo *);
 421 int nd6_ioctl(u_long, caddr_t, struct ifnet *);
 422 struct llentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
 423         char *, int, int, int);
 424 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
 425         struct sockaddr_in6 *, struct rtentry *);
 426 void nd6_grab_holdchain(struct llentry *, struct mbuf **,
 427     struct sockaddr_in6 *);
 428 int nd6_flush_holdchain(struct ifnet *, struct ifnet *, struct mbuf *,
 429     struct sockaddr_in6 *);
 430 int nd6_need_cache(struct ifnet *);
 431 int nd6_storelladdr(struct ifnet *, struct mbuf *,
 432         const struct sockaddr *, u_char *, struct llentry **);
 433
 434 /* nd6_nbr.c */
 435 void nd6_na_input(struct mbuf *, int, int);
 436 void nd6_na_output(struct ifnet *, const struct in6_addr *,
 437         const struct in6_addr *, u_long, int, struct sockaddr *);
 438 void nd6_ns_input(struct mbuf *, int, int);
 439 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
 440         const struct in6_addr *, struct llentry *, uint8_t *);
 441 caddr_t nd6_ifptomac(struct ifnet *);
 442 void nd6_dad_init(void);
 443 void nd6_dad_start(struct ifaddr *, int);
 444 void nd6_dad_stop(struct ifaddr *);
 445
 446 /* nd6_rtr.c */
 447 void nd6_rs_input(struct mbuf *, int, int);
 448 void nd6_ra_input(struct mbuf *, int, int);
 449 void prelist_del(struct nd_prefix *);
 450 void defrouter_reset(void);
 451 void defrouter_select(void);
 452 void defrtrlist_del(struct nd_defrouter *);
 453 void prelist_remove(struct nd_prefix *);
 454 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
 455         struct nd_prefix **);
 456 void pfxlist_onlink_check(void);
 457 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
 458 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
 459 void rt6_flush(struct in6_addr *, struct ifnet *);
 460 int nd6_setdefaultiface(int);
 461 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
 462
 463 #endif /* _KERNEL */
 464
 465 #endif /* _NETINET6_ND6_H_ */