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