Home | History | Annotate | Line # | Download | only in netinet6
nd6.h revision 1.58
      1 /*	$NetBSD: nd6.h,v 1.58 2013/05/21 08:37:27 roy 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 #include <sys/queue.h>
     37 #include <sys/callout.h>
     38 
     39 struct	llinfo_nd6 {
     40 	struct	llinfo_nd6 *ln_next;
     41 	struct	llinfo_nd6 *ln_prev;
     42 	struct	rtentry *ln_rt;
     43 	struct	mbuf *ln_hold;	/* last packet until resolved/timeout */
     44 	long	ln_asked;	/* number of queries already sent for this addr */
     45 	u_long	ln_expire;	/* lifetime for NDP state transition */
     46 	short	ln_state;	/* reachability state */
     47 	short	ln_router;	/* 2^0: ND6 router bit */
     48 	int	ln_byhint;	/* # of times we made it reachable by UL hint */
     49 
     50 	long	ln_ntick;
     51 	struct callout ln_timer_ch;
     52 };
     53 
     54 #define ND6_LLINFO_PURGE	-3
     55 #define ND6_LLINFO_NOSTATE	-2
     56 /*
     57  * We don't need the WAITDELETE state any more, but we keep the definition
     58  * in a comment line instead of removing it. This is necessary to avoid
     59  * unintentionally reusing the value for another purpose, which might
     60  * affect backward compatibility with old applications.
     61  * (20000711 jinmei (at) kame.net)
     62  */
     63 /* #define ND6_LLINFO_WAITDELETE	-1 */
     64 #define ND6_LLINFO_INCOMPLETE	0
     65 #define ND6_LLINFO_REACHABLE	1
     66 #define ND6_LLINFO_STALE	2
     67 #define ND6_LLINFO_DELAY	3
     68 #define ND6_LLINFO_PROBE	4
     69 
     70 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
     71 #define ND6_LLINFO_PERMANENT(n)	(((n)->ln_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
     72 
     73 struct nd_ifinfo {
     74 	u_int32_t linkmtu;		/* LinkMTU */
     75 	u_int32_t maxmtu;		/* Upper bound of LinkMTU */
     76 	u_int32_t basereachable;	/* BaseReachableTime */
     77 	u_int32_t reachable;		/* Reachable Time */
     78 	u_int32_t retrans;		/* Retrans Timer */
     79 	u_int32_t flags;		/* Flags */
     80 	int recalctm;			/* BaseReacable re-calculation timer */
     81 	u_int8_t chlim;			/* CurHopLimit */
     82 	u_int8_t initialized; /* Flag to see the entry is initialized */
     83 	/* the following 3 members are for privacy extension for addrconf */
     84 	u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
     85 	u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
     86 	u_int8_t randomid[8];	/* current random ID */
     87 };
     88 
     89 #define ND6_IFF_PERFORMNUD	0x01
     90 #define ND6_IFF_ACCEPT_RTADV	0x02	/* See "RTADV Key", below. */
     91 #define ND6_IFF_PREFER_SOURCE	0x04	/* XXX: not related to ND. */
     92 #define ND6_IFF_IFDISABLED	0x08	/* IPv6 operation is disabled due to
     93 					 * DAD failure.  (XXX: not ND-specific)
     94 					 */
     95 #define	ND6_IFF_OVERRIDE_RTADV	0x10	/* See "RTADV Key", below. */
     96 
     97 /*
     98  * RTADV Key
     99  *
    100  * The flags ND6_IFF_ACCEPT_RTADV and ND6_IFF_OVERRIDE_RTADV form a
    101  * tri-state variable.  (There are actually four different states, but
    102  * two of the states are functionally identical.)
    103  *
    104  * ND6_IFF_OVERRIDE_RTADV or 0:	This interface does not accept
    105  *				Router Advertisements.
    106  *
    107  * ND6_IFF_OVERRIDE_RTADV|
    108  * ND6_IFF_ACCEPT_RTADV:	This interface accepts Router
    109  *				Advertisements regardless of the
    110  *				global setting, ip6_accept_rtadv.
    111  *
    112  * ND6_IFF_ACCEPT_RTADV:	This interface follows the global setting,
    113  *				ip6_accept_rtadv.  If ip6_accept_rtadv == 0,
    114  *				this interface does not accept Router
    115  *				Advertisements.  If ip6_accept_rtadv != 0,
    116  *				this interface does accept them.
    117  */
    118 
    119 #ifdef _KERNEL
    120 #define ND_IFINFO(ifp) \
    121 	(((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
    122 #define IN6_LINKMTU(ifp) \
    123 	((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
    124 	    ? ND_IFINFO(ifp)->linkmtu \
    125 	    : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
    126 		? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
    127 #endif
    128 
    129 struct in6_nbrinfo {
    130 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
    131 	struct in6_addr addr;	/* IPv6 address of the neighbor */
    132 	long	asked;		/* number of queries already sent for this addr */
    133 	int	isrouter;	/* if it acts as a router */
    134 	int	state;		/* reachability state */
    135 	int	expire;		/* lifetime for NDP state transition */
    136 };
    137 
    138 #define DRLSTSIZ 10
    139 #define PRLSTSIZ 10
    140 struct	in6_drlist {
    141 	char ifname[IFNAMSIZ];
    142 	struct {
    143 		struct	in6_addr rtaddr;
    144 		u_char	flags;
    145 		u_short	rtlifetime;
    146 		u_long	expire;
    147 		u_short if_index;
    148 	} defrouter[DRLSTSIZ];
    149 };
    150 
    151 struct	in6_defrouter {
    152 	struct	sockaddr_in6 rtaddr;
    153 	u_char	flags;
    154 	u_short	rtlifetime;
    155 	u_long	expire;
    156 	u_short if_index;
    157 };
    158 
    159 #ifdef _KERNEL
    160 struct	in6_oprlist {
    161 	char ifname[IFNAMSIZ];
    162 	struct {
    163 		struct	in6_addr prefix;
    164 		struct prf_ra raflags;
    165 		u_char	prefixlen;
    166 		u_char	origin;
    167 		u_long vltime;
    168 		u_long pltime;
    169 		u_long expire;
    170 		u_short if_index;
    171 		u_short advrtrs; /* number of advertisement routers */
    172 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
    173 	} prefix[PRLSTSIZ];
    174 };
    175 #endif
    176 
    177 struct	in6_prlist {
    178 	char ifname[IFNAMSIZ];
    179 	struct {
    180 		struct	in6_addr prefix;
    181 		struct prf_ra raflags;
    182 		u_char	prefixlen;
    183 		u_char	origin;
    184 		u_int32_t vltime;
    185 		u_int32_t pltime;
    186 		time_t expire;
    187 		u_short if_index;
    188 		u_short advrtrs; /* number of advertisement routers */
    189 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
    190 	} prefix[PRLSTSIZ];
    191 };
    192 
    193 struct in6_prefix {
    194 	struct	sockaddr_in6 prefix;
    195 	struct prf_ra raflags;
    196 	u_char	prefixlen;
    197 	u_char	origin;
    198 	u_int32_t vltime;
    199 	u_int32_t pltime;
    200 	time_t expire;
    201 	u_int32_t flags;
    202 	int refcnt;
    203 	u_short if_index;
    204 	u_short advrtrs; /* number of advertisement routers */
    205 	/* struct sockaddr_in6 advrtr[] */
    206 };
    207 
    208 #ifdef _KERNEL
    209 struct	in6_ondireq {
    210 	char ifname[IFNAMSIZ];
    211 	struct {
    212 		u_int32_t linkmtu;	/* LinkMTU */
    213 		u_int32_t maxmtu;	/* Upper bound of LinkMTU */
    214 		u_int32_t basereachable; /* BaseReachableTime */
    215 		u_int32_t reachable;	/* Reachable Time */
    216 		u_int32_t retrans;	/* Retrans Timer */
    217 		u_int32_t flags;	/* Flags */
    218 		int recalctm;		/* BaseReacable re-calculation timer */
    219 		u_int8_t chlim;		/* CurHopLimit */
    220 		u_int8_t receivedra;
    221 	} ndi;
    222 };
    223 #endif
    224 
    225 struct	in6_ndireq {
    226 	char ifname[IFNAMSIZ];
    227 	struct nd_ifinfo ndi;
    228 };
    229 
    230 struct	in6_ndifreq {
    231 	char ifname[IFNAMSIZ];
    232 	u_long ifindex;
    233 };
    234 
    235 /* Prefix status */
    236 #define NDPRF_ONLINK		0x1
    237 #define NDPRF_DETACHED		0x2
    238 #define NDPRF_HOME		0x4
    239 
    240 /* protocol constants */
    241 #define MAX_RTR_SOLICITATION_DELAY	1	/* 1sec */
    242 #define RTR_SOLICITATION_INTERVAL	4	/* 4sec */
    243 #define MAX_RTR_SOLICITATIONS		3
    244 
    245 #define ND6_INFINITE_LIFETIME		((u_int32_t)~0)
    246 
    247 #ifdef _KERNEL
    248 /* node constants */
    249 #define MAX_REACHABLE_TIME		3600000	/* msec */
    250 #define REACHABLE_TIME			30000	/* msec */
    251 #define RETRANS_TIMER			1000	/* msec */
    252 #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
    253 #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
    254 #define DEF_TEMP_VALID_LIFETIME		604800	/* 1 week */
    255 #define DEF_TEMP_PREFERRED_LIFETIME	86400	/* 1 day */
    256 #define TEMPADDR_REGEN_ADVANCE		5	/* sec */
    257 #define MAX_TEMP_DESYNC_FACTOR		600	/* 10 min */
    258 #define ND_COMPUTE_RTIME(x) \
    259 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (cprng_fast32() & \
    260 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
    261 
    262 TAILQ_HEAD(nd_drhead, nd_defrouter);
    263 struct	nd_defrouter {
    264 	TAILQ_ENTRY(nd_defrouter) dr_entry;
    265 	struct	in6_addr rtaddr;
    266 	u_char	flags;		/* flags on RA message */
    267 	u_short	rtlifetime;
    268 	u_long	expire;
    269 	struct  ifnet *ifp;
    270 	int	installed;	/* is installed into kernel routing table */
    271 };
    272 
    273 struct nd_prefixctl {
    274 	struct ifnet *ndpr_ifp;
    275 
    276 	/* prefix */
    277 	struct sockaddr_in6 ndpr_prefix;
    278 	u_char	ndpr_plen;
    279 
    280 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
    281 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
    282 
    283 	struct prf_ra ndpr_flags;
    284 };
    285 
    286 struct nd_prefix {
    287 	struct ifnet *ndpr_ifp;
    288 	LIST_ENTRY(nd_prefix) ndpr_entry;
    289 	struct sockaddr_in6 ndpr_prefix;	/* prefix */
    290 	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
    291 
    292 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
    293 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
    294 
    295 	time_t ndpr_expire;	/* expiration time of the prefix */
    296 	time_t ndpr_preferred;	/* preferred time of the prefix */
    297 	time_t ndpr_lastupdate; /* reception time of last advertisement */
    298 
    299 	struct prf_ra ndpr_flags;
    300 	u_int32_t ndpr_stateflags; /* actual state flags */
    301 	/* list of routers that advertise the prefix: */
    302 	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
    303 	u_char	ndpr_plen;
    304 	int	ndpr_refcnt;	/* reference couter from addresses */
    305 };
    306 
    307 #define ndpr_next		ndpr_entry.le_next
    308 
    309 #define ndpr_raf		ndpr_flags
    310 #define ndpr_raf_onlink		ndpr_flags.onlink
    311 #define ndpr_raf_auto		ndpr_flags.autonomous
    312 #define ndpr_raf_router		ndpr_flags.router
    313 
    314 /*
    315  * Message format for use in obtaining information about prefixes
    316  * from inet6 sysctl function
    317  */
    318 struct inet6_ndpr_msghdr {
    319 	u_short	inpm_msglen;	/* to skip over non-understood messages */
    320 	u_char	inpm_version;	/* future binary compatibility */
    321 	u_char	inpm_type;	/* message type */
    322 	struct in6_addr inpm_prefix;
    323 	u_long	prm_vltim;
    324 	u_long	prm_pltime;
    325 	u_long	prm_expire;
    326 	u_long	prm_preferred;
    327 	struct in6_prflags prm_flags;
    328 	u_short	prm_index;	/* index for associated ifp */
    329 	u_char	prm_plen;	/* length of prefix in bits */
    330 };
    331 
    332 #define prm_raf_onlink		prm_flags.prf_ra.onlink
    333 #define prm_raf_auto		prm_flags.prf_ra.autonomous
    334 
    335 #define prm_statef_onlink	prm_flags.prf_state.onlink
    336 
    337 #define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
    338 #define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd
    339 
    340 struct nd_pfxrouter {
    341 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
    342 	struct nd_defrouter *router;
    343 };
    344 
    345 LIST_HEAD(nd_prhead, nd_prefix);
    346 
    347 #include <sys/mallocvar.h>
    348 MALLOC_DECLARE(M_IP6NDP);
    349 
    350 /* nd6.c */
    351 extern int nd6_prune;
    352 extern int nd6_delay;
    353 extern int nd6_umaxtries;
    354 extern int nd6_mmaxtries;
    355 extern int nd6_useloopback;
    356 extern int nd6_maxnudhint;
    357 extern int nd6_gctimer;
    358 extern struct llinfo_nd6 llinfo_nd6;
    359 extern struct nd_drhead nd_defrouter;
    360 extern struct nd_prhead nd_prefix;
    361 extern int nd6_debug;
    362 
    363 #define nd6log(x)	do { if (nd6_debug) log x; } while (/*CONSTCOND*/ 0)
    364 
    365 extern struct callout nd6_timer_ch;
    366 
    367 /* nd6_rtr.c */
    368 extern int nd6_defifindex;
    369 extern int ip6_desync_factor;	/* seconds */
    370 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
    371 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
    372 extern int ip6_temp_regen_advance; /* seconds */
    373 extern int nd6_numroutes;
    374 
    375 union nd_opts {
    376 	struct nd_opt_hdr *nd_opt_array[8];
    377 	struct {
    378 		struct nd_opt_hdr *zero;
    379 		struct nd_opt_hdr *src_lladdr;
    380 		struct nd_opt_hdr *tgt_lladdr;
    381 		struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
    382 		struct nd_opt_rd_hdr *rh;
    383 		struct nd_opt_mtu *mtu;
    384 		struct nd_opt_hdr *search;	/* multiple opts */
    385 		struct nd_opt_hdr *last;	/* multiple opts */
    386 		int done;
    387 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
    388 	} nd_opt_each;
    389 };
    390 #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
    391 #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
    392 #define nd_opts_pi		nd_opt_each.pi_beg
    393 #define nd_opts_pi_end		nd_opt_each.pi_end
    394 #define nd_opts_rh		nd_opt_each.rh
    395 #define nd_opts_mtu		nd_opt_each.mtu
    396 #define nd_opts_search		nd_opt_each.search
    397 #define nd_opts_last		nd_opt_each.last
    398 #define nd_opts_done		nd_opt_each.done
    399 
    400 /* XXX: need nd6_var.h?? */
    401 /* nd6.c */
    402 void nd6_init(void);
    403 struct nd_ifinfo *nd6_ifattach(struct ifnet *);
    404 void nd6_ifdetach(struct nd_ifinfo *);
    405 int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
    406 void nd6_option_init(void *, int, union nd_opts *);
    407 struct nd_opt_hdr *nd6_option(union nd_opts *);
    408 int nd6_options(union nd_opts *);
    409 struct	rtentry *nd6_lookup(const struct in6_addr *, int, struct ifnet *);
    410 void nd6_setmtu(struct ifnet *);
    411 void nd6_llinfo_settimer(struct llinfo_nd6 *, long);
    412 void nd6_timer(void *);
    413 void nd6_purge(struct ifnet *);
    414 void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
    415 int nd6_resolve(struct ifnet *, struct rtentry *,
    416 	struct mbuf *, struct sockaddr *, u_char *);
    417 void nd6_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
    418 int nd6_ioctl(u_long, void *, struct ifnet *);
    419 struct rtentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
    420 	char *, int, int, int);
    421 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
    422 	const struct sockaddr_in6 *, struct rtentry *);
    423 int nd6_storelladdr(const struct ifnet *, const struct rtentry *, struct mbuf *,
    424 	const struct sockaddr *, uint8_t *, size_t);
    425 int nd6_sysctl(int, void *, size_t *, void *, size_t);
    426 int nd6_need_cache(struct ifnet *);
    427 void nd6_llinfo_release_pkts(struct llinfo_nd6 *, struct ifnet *,
    428     struct rtentry *);
    429 
    430 /* nd6_nbr.c */
    431 void nd6_na_input(struct mbuf *, int, int);
    432 void nd6_na_output(struct ifnet *, const struct in6_addr *,
    433 	const struct in6_addr *, u_long, int, const struct sockaddr *);
    434 void nd6_ns_input(struct mbuf *, int, int);
    435 void nd6_ns_output(struct ifnet *, const struct in6_addr *,
    436 	const struct in6_addr *, struct llinfo_nd6 *, int);
    437 const void *nd6_ifptomac(const struct ifnet *);
    438 void nd6_newaddrmsg(struct ifaddr *);
    439 void nd6_dad_start(struct ifaddr *, int);
    440 void nd6_dad_stop(struct ifaddr *);
    441 void nd6_dad_duplicated(struct ifaddr *);
    442 
    443 /* nd6_rtr.c */
    444 void nd6_rs_input(struct mbuf *, int, int);
    445 void nd6_ra_input(struct mbuf *, int, int);
    446 void prelist_del(struct nd_prefix *);
    447 void defrouter_addreq(struct nd_defrouter *);
    448 void defrouter_reset(void);
    449 void defrouter_select(void);
    450 void defrtrlist_del(struct nd_defrouter *);
    451 void prelist_remove(struct nd_prefix *);
    452 int nd6_prelist_add(struct nd_prefixctl *, struct nd_defrouter *,
    453 	struct nd_prefix **);
    454 int nd6_prefix_onlink(struct nd_prefix *);
    455 int nd6_prefix_offlink(struct nd_prefix *);
    456 void pfxlist_onlink_check(void);
    457 struct nd_defrouter *defrouter_lookup(const struct in6_addr *, struct ifnet *);
    458 struct nd_prefix *nd6_prefix_lookup(struct nd_prefixctl *);
    459 int in6_ifdel(struct ifnet *, struct in6_addr *);
    460 void rt6_flush(struct in6_addr *, struct ifnet *);
    461 int nd6_setdefaultiface(int);
    462 int in6_tmpifadd(const struct in6_ifaddr *, int, int);
    463 bool nd6_accepts_rtadv(const struct nd_ifinfo *);
    464 
    465 #endif /* _KERNEL */
    466 
    467 #endif /* !_NETINET6_ND6_H_ */
    468