Home | History | Annotate | Line # | Download | only in netinet6
nd6.h revision 1.28
      1 /*	$NetBSD: nd6.h,v 1.28 2002/05/30 05:06:29 itojun Exp $	*/
      2 /*	$KAME: nd6.h,v 1.52 2001/02/19 04:40:37 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 
     56 #define ND6_LLINFO_NOSTATE	-2
     57 /*
     58  * We don't need the WAITDELETE state any more, but we keep the definition
     59  * in a comment line instead of removing it. This is necessary to avoid
     60  * unintentionally reusing the value for another purpose, which might
     61  * affect backward compatibility with old applications.
     62  * (20000711 jinmei (at) kame.net)
     63  */
     64 /* #define ND6_LLINFO_WAITDELETE	-1 */
     65 #define ND6_LLINFO_INCOMPLETE	0
     66 #define ND6_LLINFO_REACHABLE	1
     67 #define ND6_LLINFO_STALE	2
     68 #define ND6_LLINFO_DELAY	3
     69 #define ND6_LLINFO_PROBE	4
     70 
     71 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
     72 
     73 /*
     74  * Since the granularity of our retransmission timer is seconds, we should
     75  * ensure that a positive timer value will be mapped to at least one second.
     76  */
     77 #define ND6_RETRANS_SEC(r) (((r) + 999) / 1000)
     78 
     79 struct nd_ifinfo {
     80 	u_int32_t linkmtu;		/* LinkMTU */
     81 	u_int32_t maxmtu;		/* Upper bound of LinkMTU */
     82 	u_int32_t basereachable;	/* BaseReachableTime */
     83 	u_int32_t reachable;		/* Reachable Time */
     84 	u_int32_t retrans;		/* Retrans Timer */
     85 	u_int32_t flags;		/* Flags */
     86 	int recalctm;			/* BaseReacable re-calculation timer */
     87 	u_int8_t chlim;			/* CurHopLimit */
     88 	u_int8_t initialized; /* Flag to see the entry is initialized */
     89 	/* the following 3 members are for privacy extension for addrconf */
     90 	u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
     91 	u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
     92 	u_int8_t randomid[8];	/* current random ID */
     93 };
     94 
     95 #define ND6_IFF_PERFORMNUD	0x1
     96 
     97 #ifdef _KERNEL
     98 #define ND_IFINFO(ifp) \
     99 	(((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
    100 #define IN6_LINKMTU(ifp) \
    101 	((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
    102 		? ND_IFINFO(ifp)->linkmtu : (ifp)->if_mtu)
    103 #endif
    104 
    105 struct in6_nbrinfo {
    106 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
    107 	struct in6_addr addr;	/* IPv6 address of the neighbor */
    108 	long	asked;		/* number of queries already sent for this addr */
    109 	int	isrouter;	/* if it acts as a router */
    110 	int	state;		/* reachability state */
    111 	int	expire;		/* lifetime for NDP state transition */
    112 };
    113 
    114 #define DRLSTSIZ 10
    115 #define PRLSTSIZ 10
    116 struct	in6_drlist {
    117 	char ifname[IFNAMSIZ];
    118 	struct {
    119 		struct	in6_addr rtaddr;
    120 		u_char	flags;
    121 		u_short	rtlifetime;
    122 		u_long	expire;
    123 		u_short if_index;
    124 	} defrouter[DRLSTSIZ];
    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 #ifdef _KERNEL
    144 struct	in6_ondireq {
    145 	char ifname[IFNAMSIZ];
    146 	struct {
    147 		u_int32_t linkmtu;	/* LinkMTU */
    148 		u_int32_t maxmtu;	/* Upper bound of LinkMTU */
    149 		u_int32_t basereachable; /* BaseReachableTime */
    150 		u_int32_t reachable;	/* Reachable Time */
    151 		u_int32_t retrans;	/* Retrans Timer */
    152 		u_int32_t flags;	/* Flags */
    153 		int recalctm;		/* BaseReacable re-calculation timer */
    154 		u_int8_t chlim;		/* CurHopLimit */
    155 		u_int8_t receivedra;
    156 	} ndi;
    157 };
    158 #endif
    159 
    160 struct	in6_ndireq {
    161 	char ifname[IFNAMSIZ];
    162 	struct nd_ifinfo ndi;
    163 };
    164 
    165 struct	in6_ndifreq {
    166 	char ifname[IFNAMSIZ];
    167 	u_long ifindex;
    168 };
    169 
    170 
    171 /* protocol constants */
    172 #define MAX_RTR_SOLICITATION_DELAY	1	/* 1sec */
    173 #define RTR_SOLICITATION_INTERVAL	4	/* 4sec */
    174 #define MAX_RTR_SOLICITATIONS		3
    175 
    176 #define ND6_INFINITE_LIFETIME		0xffffffff
    177 
    178 #ifdef _KERNEL
    179 /* node constants */
    180 #define MAX_REACHABLE_TIME		3600000	/* msec */
    181 #define REACHABLE_TIME			30000	/* msec */
    182 #define RETRANS_TIMER			1000	/* msec */
    183 #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
    184 #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
    185 #define ND_COMPUTE_RTIME(x) \
    186 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (arc4random() & \
    187 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
    188 
    189 TAILQ_HEAD(nd_drhead, nd_defrouter);
    190 struct	nd_defrouter {
    191 	TAILQ_ENTRY(nd_defrouter) dr_entry;
    192 	struct	in6_addr rtaddr;
    193 	u_char	flags;
    194 	u_short	rtlifetime;
    195 	u_long	expire;
    196 	struct  ifnet *ifp;
    197 };
    198 
    199 struct nd_prefix {
    200 	struct ifnet *ndpr_ifp;
    201 	LIST_ENTRY(nd_prefix) ndpr_entry;
    202 	struct sockaddr_in6 ndpr_prefix;	/* prefix */
    203 	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
    204 	struct in6_addr ndpr_addr; /* address that is derived from the prefix */
    205 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
    206 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
    207 	time_t ndpr_expire;	/* expiration time of the prefix */
    208 	time_t ndpr_preferred;	/* preferred time of the prefix */
    209 	struct prf_ra ndpr_flags;
    210 	/* list of routers that advertise the prefix: */
    211 	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
    212 	u_char	ndpr_plen;
    213 	struct	ndpr_stateflags {
    214 		/* if this prefix can be regarded as on-link */
    215 		u_char onlink : 1;
    216 	} ndpr_stateflags;
    217 };
    218 
    219 #define ndpr_next		ndpr_entry.le_next
    220 
    221 #define ndpr_raf		ndpr_flags
    222 #define ndpr_raf_onlink		ndpr_flags.onlink
    223 #define ndpr_raf_auto		ndpr_flags.autonomous
    224 
    225 #define ndpr_statef_onlink	ndpr_stateflags.onlink
    226 #define ndpr_statef_addmark	ndpr_stateflags.addmark
    227 
    228 /*
    229  * We keep expired prefix for certain amount of time, for validation purposes.
    230  * 1800s = MaxRtrAdvInterval
    231  */
    232 #define NDPR_KEEP_EXPIRED	(1800 * 2)
    233 
    234 /*
    235  * Message format for use in obtaining information about prefixes
    236  * from inet6 sysctl function
    237  */
    238 struct inet6_ndpr_msghdr {
    239 	u_short	inpm_msglen;	/* to skip over non-understood messages */
    240 	u_char	inpm_version;	/* future binary compatibility */
    241 	u_char	inpm_type;	/* message type */
    242 	struct in6_addr inpm_prefix;
    243 	u_long	prm_vltim;
    244 	u_long	prm_pltime;
    245 	u_long	prm_expire;
    246 	u_long	prm_preferred;
    247 	struct in6_prflags prm_flags;
    248 	u_short	prm_index;	/* index for associated ifp */
    249 	u_char	prm_plen;	/* length of prefix in bits */
    250 };
    251 
    252 #define prm_raf_onlink		prm_flags.prf_ra.onlink
    253 #define prm_raf_auto		prm_flags.prf_ra.autonomous
    254 
    255 #define prm_statef_onlink	prm_flags.prf_state.onlink
    256 
    257 #define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
    258 #define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd
    259 
    260 #define ifpr2ndpr(ifpr)	((struct nd_prefix *)(ifpr))
    261 #define ndpr2ifpr(ndpr)	((struct ifprefix *)(ndpr))
    262 
    263 struct nd_pfxrouter {
    264 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
    265 #define pfr_next pfr_entry.le_next
    266 	struct nd_defrouter *router;
    267 };
    268 
    269 LIST_HEAD(nd_prhead, nd_prefix);
    270 
    271 /* nd6.c */
    272 extern int nd6_prune;
    273 extern int nd6_delay;
    274 extern int nd6_umaxtries;
    275 extern int nd6_mmaxtries;
    276 extern int nd6_useloopback;
    277 extern int nd6_maxnudhint;
    278 extern int nd6_gctimer;
    279 extern struct llinfo_nd6 llinfo_nd6;
    280 extern struct nd_drhead nd_defrouter;
    281 extern struct nd_prhead nd_prefix;
    282 extern int nd6_debug;
    283 
    284 #define nd6log(x)	do { if (nd6_debug) log x; } while (0)
    285 
    286 extern struct callout nd6_timer_ch;
    287 
    288 /* nd6_rtr.c */
    289 extern int nd6_defifindex;
    290 
    291 union nd_opts {
    292 	struct nd_opt_hdr *nd_opt_array[8];
    293 	struct {
    294 		struct nd_opt_hdr *zero;
    295 		struct nd_opt_hdr *src_lladdr;
    296 		struct nd_opt_hdr *tgt_lladdr;
    297 		struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
    298 		struct nd_opt_rd_hdr *rh;
    299 		struct nd_opt_mtu *mtu;
    300 		struct nd_opt_hdr *search;	/* multiple opts */
    301 		struct nd_opt_hdr *last;	/* multiple opts */
    302 		int done;
    303 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
    304 	} nd_opt_each;
    305 };
    306 #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
    307 #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
    308 #define nd_opts_pi		nd_opt_each.pi_beg
    309 #define nd_opts_pi_end		nd_opt_each.pi_end
    310 #define nd_opts_rh		nd_opt_each.rh
    311 #define nd_opts_mtu		nd_opt_each.mtu
    312 #define nd_opts_search		nd_opt_each.search
    313 #define nd_opts_last		nd_opt_each.last
    314 #define nd_opts_done		nd_opt_each.done
    315 
    316 /* XXX: need nd6_var.h?? */
    317 /* nd6.c */
    318 void nd6_init __P((void));
    319 struct nd_ifinfo *nd6_ifattach __P((struct ifnet *));
    320 void nd6_ifdetach __P((struct nd_ifinfo *));
    321 int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
    322 void nd6_option_init __P((void *, int, union nd_opts *));
    323 struct nd_opt_hdr *nd6_option __P((union nd_opts *));
    324 int nd6_options __P((union nd_opts *));
    325 struct	rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
    326 void nd6_setmtu __P((struct ifnet *));
    327 void nd6_timer __P((void *));
    328 void nd6_purge __P((struct ifnet *));
    329 void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
    330 int nd6_resolve __P((struct ifnet *, struct rtentry *,
    331 		     struct mbuf *, struct sockaddr *, u_char *));
    332 void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
    333 void nd6_p2p_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
    334 int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
    335 struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
    336 	char *, int, int, int));
    337 int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
    338 		    struct sockaddr_in6 *, struct rtentry *));
    339 int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
    340 			 struct sockaddr *, u_char *));
    341 int nd6_need_cache __P((struct ifnet *));
    342 
    343 /* nd6_nbr.c */
    344 void nd6_na_input __P((struct mbuf *, int, int));
    345 void nd6_na_output __P((struct ifnet *, const struct in6_addr *,
    346  			const struct in6_addr *, u_long, int, struct sockaddr *));
    347 void nd6_ns_input __P((struct mbuf *, int, int));
    348 void nd6_ns_output __P((struct ifnet *, const struct in6_addr *,
    349 			const struct in6_addr *, struct llinfo_nd6 *, int));
    350 caddr_t nd6_ifptomac __P((struct ifnet *));
    351 void nd6_dad_start __P((struct ifaddr *, int *));
    352 void nd6_dad_stop __P((struct ifaddr *));
    353 void nd6_dad_duplicated __P((struct ifaddr *));
    354 
    355 /* nd6_rtr.c */
    356 void nd6_rs_input __P((struct mbuf *, int, int));
    357 void nd6_ra_input __P((struct mbuf *, int, int));
    358 void prelist_del __P((struct nd_prefix *));
    359 void defrouter_addreq __P((struct nd_defrouter *));
    360 void defrouter_delreq __P((struct nd_defrouter *, int));
    361 void defrouter_select __P((void));
    362 void defrtrlist_del __P((struct nd_defrouter *));
    363 void prelist_remove __P((struct nd_prefix *));
    364 int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
    365 	struct mbuf *));
    366 void pfxlist_onlink_check __P((void));
    367 struct nd_defrouter *defrouter_lookup __P((struct in6_addr *,
    368 					   struct ifnet *));
    369 int in6_ifdel __P((struct ifnet *, struct in6_addr *));
    370 int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr));
    371 void rt6_flush __P((struct in6_addr *, struct ifnet *));
    372 int nd6_setdefaultiface __P((int));
    373 
    374 #endif /* _KERNEL */
    375 
    376 #endif /* _NETINET6_ND6_H_ */
    377