[apple/xnu.git] / bsd / netinet6 / nd6.h

/*	$FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.3 2001/08/13 01:10:49 simokawa Exp $	*/
/*	$KAME: nd6.h,v 1.55 2001/04/27 15:09:49 itojun Exp $	*/

/*
 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _NETINET6_ND6_H_
#define _NETINET6_ND6_H_
#include <sys/appleapiopts.h>

/* see net/route.h, or net/if_inarp.h */
#ifndef RTF_ANNOUNCE
#define RTF_ANNOUNCE	RTF_PROTO2
#endif

#include <sys/queue.h>

#ifdef KERNEL_PRIVATE
struct	llinfo_nd6 {
	struct	llinfo_nd6 *ln_next;
	struct	llinfo_nd6 *ln_prev;
	struct	rtentry *ln_rt;
	struct	mbuf *ln_hold;	/* last packet until resolved/timeout */
	long	ln_asked;	/* number of queries already sent for this addr */
	u_long	ln_expire;	/* lifetime for NDP state transition */
	short	ln_state;	/* reachability state */
	short	ln_router;	/* 2^0: ND6 router bit */
	int	ln_byhint;	/* # of times we made it reachable by UL hint */
};
#endif /* KERNEL_PRIVATE */

#define ND6_LLINFO_NOSTATE	-2
/*
 * We don't need the WAITDELETE state any more, but we keep the definition
 * in a comment line instead of removing it. This is necessary to avoid
 * unintentionally reusing the value for another purpose, which might
 * affect backward compatibility with old applications.
 * (20000711 jinmei@kame.net)
 */
/* #define ND6_LLINFO_WAITDELETE	-1 */
#define ND6_LLINFO_INCOMPLETE	0
#define ND6_LLINFO_REACHABLE	1
#define ND6_LLINFO_STALE	2
#define ND6_LLINFO_DELAY	3
#define ND6_LLINFO_PROBE	4

#define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)

struct nd_ifinfo {
	u_int32_t linkmtu;		/* LinkMTU */
	u_int32_t maxmtu;		/* Upper bound of LinkMTU */
	u_int32_t basereachable;	/* BaseReachableTime */
	u_int32_t reachable;		/* Reachable Time */
	u_int32_t retrans;		/* Retrans Timer */
	u_int32_t flags;		/* Flags */
	int recalctm;			/* BaseReacable re-calculation timer */
	u_int8_t chlim;			/* CurHopLimit */
	u_int8_t receivedra;
	/* the following 3 members are for privacy extension for addrconf */
	u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
	u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
	u_int8_t randomid[8];	/* current random ID */
};

#define ND6_IFF_PERFORMNUD	0x1

struct in6_nbrinfo {
	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
	struct in6_addr addr;	/* IPv6 address of the neighbor */
	long	asked;		/* number of queries already sent for this addr */
	int	isrouter;	/* if it acts as a router */
	int	state;		/* reachability state */
	int	expire;		/* lifetime for NDP state transition */
};

#define DRLSTSIZ 10
#define PRLSTSIZ 10
struct	in6_drlist {
	char ifname[IFNAMSIZ];
	struct {
		struct	in6_addr rtaddr;
		u_char	flags;
		u_short	rtlifetime;
		u_long	expire;
		u_short if_index;
	} defrouter[DRLSTSIZ];
};

struct	in6_defrouter {
	struct	sockaddr_in6 rtaddr;
	u_char	flags;
	u_short	rtlifetime;
	u_long	expire;
	u_short if_index;
};

struct	in6_prlist {
	char ifname[IFNAMSIZ];
	struct {
		struct	in6_addr prefix;
		struct prf_ra raflags;
		u_char	prefixlen;
		u_char	origin;
		u_long	vltime;
		u_long	pltime;
		u_long	expire;
		u_short if_index;
		u_short advrtrs; /* number of advertisement routers */
		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
	} prefix[PRLSTSIZ];
};

struct in6_prefix {
	struct	sockaddr_in6 prefix;
	struct prf_ra raflags;
	u_char	prefixlen;
	u_char	origin;
	u_long	vltime;
	u_long	pltime;
	u_long	expire;
	u_int32_t flags;
	int refcnt;
	u_short if_index;
	u_short advrtrs; /* number of advertisement routers */
	/* struct sockaddr_in6 advrtr[] */
};

struct	in6_ondireq {
	char ifname[IFNAMSIZ];
	struct {
		u_int32_t linkmtu;	/* LinkMTU */
		u_int32_t maxmtu;	/* Upper bound of LinkMTU */
		u_int32_t basereachable; /* BaseReachableTime */
		u_int32_t reachable;	/* Reachable Time */
		u_int32_t retrans;	/* Retrans Timer */
		u_int32_t flags;	/* Flags */
		int recalctm;		/* BaseReacable re-calculation timer */
		u_int8_t chlim;		/* CurHopLimit */
		u_int8_t receivedra;
	} ndi;
};

struct	in6_ndireq {
	char ifname[IFNAMSIZ];
	struct nd_ifinfo ndi;
};

struct	in6_ndifreq {
	char ifname[IFNAMSIZ];
	u_long ifindex;
};

/* Prefix status */
#define NDPRF_ONLINK		0x1
#define NDPRF_DETACHED		0x2

/* protocol constants */
#define MAX_RTR_SOLICITATION_DELAY	1	/*1sec*/
#define RTR_SOLICITATION_INTERVAL	4	/*4sec*/
#define MAX_RTR_SOLICITATIONS		3

#define ND6_INFINITE_LIFETIME		0xffffffff

#ifdef KERNEL_PRIVATE
#define ND_IFINFO(ifp) \
	(&nd_ifinfo[(ifp)->if_index])
/*
 * In a more readable form, we derive linkmtu based on:
 *
 * if (ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < ifp->if_mtu)
 *         linkmtu = ND_IFINFO(ifp)->linkmtu;
 * else if ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < ifp->if_mtu))
 *         linkmtu = ND_IFINFO(ifp)->maxmtu;
 * else
 *         linkmtu = ifp->if_mtu;
 */
#define IN6_LINKMTU(ifp)						      \
	((ND_IFINFO(ifp)->linkmtu &&					      \
	ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) ? ND_IFINFO(ifp)->linkmtu :  \
	((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) ? \
	ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))

/* node constants */
#define MAX_REACHABLE_TIME		3600000	/* msec */
#define REACHABLE_TIME			30000	/* msec */
#define RETRANS_TIMER			1000	/* msec */
#define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
#define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
#define DEF_TEMP_VALID_LIFETIME		604800	/* 1 week */
#define DEF_TEMP_PREFERRED_LIFETIME	86400	/* 1 day */
#define TEMPADDR_REGEN_ADVANCE		5	/* sec */
#define MAX_TEMP_DESYNC_FACTOR		600	/* 10 min */
#define ND_COMPUTE_RTIME(x) \
		(((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)

TAILQ_HEAD(nd_drhead, nd_defrouter);
struct	nd_defrouter {
	TAILQ_ENTRY(nd_defrouter) dr_entry;
	struct	in6_addr rtaddr;
	u_char	flags;		/* flags on RA message */
	u_short	rtlifetime;
	u_long	expire;
	u_long	advint;		/* Mobile IPv6 addition (milliseconds) */
	u_long	advint_expire;	/* Mobile IPv6 addition */
	int	advints_lost;	/* Mobile IPv6 addition */
	struct  ifnet *ifp;
};

struct nd_prefix {
	struct ifnet *ndpr_ifp;
	LIST_ENTRY(nd_prefix) ndpr_entry;
	struct sockaddr_in6 ndpr_prefix;	/* prefix */
	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
	struct in6_addr ndpr_addr; /* address that is derived from the prefix */
	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
	time_t ndpr_expire;	/* expiration time of the prefix */
	time_t ndpr_preferred;	/* preferred time of the prefix */
	struct prf_ra ndpr_flags;
	u_int32_t ndpr_stateflags; /* actual state flags */
	/* list of routers that advertise the prefix: */
	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
	u_char	ndpr_plen;
	int	ndpr_refcnt;	/* reference counter from addresses */
	int	ndpr_usecnt;	/* actual use count; prevents free */
};

#define ndpr_next		ndpr_entry.le_next

#define ndpr_raf		ndpr_flags
#define ndpr_raf_onlink		ndpr_flags.onlink
#define ndpr_raf_auto		ndpr_flags.autonomous

/*
 * We keep expired prefix for certain amount of time, for validation purposes.
 * 1800s = MaxRtrAdvInterval
 */
#define NDPR_KEEP_EXPIRED	(1800 * 2)

/*
 * Message format for use in obtaining information about prefixes
 * from inet6 sysctl function
 */
struct inet6_ndpr_msghdr {
	u_short	inpm_msglen;	/* to skip over non-understood messages */
	u_char	inpm_version;	/* future binary compatibility */
	u_char	inpm_type;	/* message type */
	struct in6_addr inpm_prefix;
	u_long	prm_vltim;
	u_long	prm_pltime;
	u_long	prm_expire;
	u_long	prm_preferred;
	struct in6_prflags prm_flags;
	u_short	prm_index;	/* index for associated ifp */
	u_char	prm_plen;	/* length of prefix in bits */
};

#define prm_raf_onlink		prm_flags.prf_ra.onlink
#define prm_raf_auto		prm_flags.prf_ra.autonomous

#define prm_statef_onlink	prm_flags.prf_state.onlink

#define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
#define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd

#define ifpr2ndpr(ifpr)	((struct nd_prefix *)(ifpr))
#define ndpr2ifpr(ndpr)	((struct ifprefix *)(ndpr))

struct nd_pfxrouter {
	LIST_ENTRY(nd_pfxrouter) pfr_entry;
#define pfr_next pfr_entry.le_next
	struct nd_defrouter *router;
};

LIST_HEAD(nd_prhead, nd_prefix);

/* nd6.c */
extern int nd6_prune;
extern int nd6_delay;
extern int nd6_umaxtries;
extern int nd6_mmaxtries;
extern int nd6_useloopback;
extern int nd6_maxnudhint;
extern int nd6_gctimer;
extern struct llinfo_nd6 llinfo_nd6;
extern struct nd_ifinfo *nd_ifinfo;
extern struct nd_drhead nd_defrouter;
extern struct nd_prhead nd_prefix;
extern int nd6_debug;

#define nd6log(x)	do { if (nd6_debug) log x; } while (0)

extern struct callout nd6_timer_ch;

/* nd6_rtr.c */
extern int nd6_defifindex;
extern int ip6_desync_factor;	/* seconds */
extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
extern int ip6_temp_regen_advance; /* seconds */

union nd_opts {
	struct nd_opt_hdr *nd_opt_array[9];	/*max = home agent info*/
	struct {
		struct nd_opt_hdr *zero;
		struct nd_opt_hdr *src_lladdr;
		struct nd_opt_hdr *tgt_lladdr;
		struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
		struct nd_opt_rd_hdr *rh;
		struct nd_opt_mtu *mtu;
		struct nd_opt_hdr *six;
		struct nd_opt_advint *adv;
		struct nd_opt_hai *hai;
		struct nd_opt_hdr *search;	/* multiple opts */
		struct nd_opt_hdr *last;	/* multiple opts */
		int done;
		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
	} nd_opt_each;
};
#define nd_opts_src_lladdr	nd_opt_each.src_lladdr
#define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
#define nd_opts_pi		nd_opt_each.pi_beg
#define nd_opts_pi_end		nd_opt_each.pi_end
#define nd_opts_rh		nd_opt_each.rh
#define nd_opts_mtu		nd_opt_each.mtu
#define nd_opts_adv		nd_opt_each.adv
#define nd_opts_hai		nd_opt_each.hai
#define nd_opts_search		nd_opt_each.search
#define nd_opts_last		nd_opt_each.last
#define nd_opts_done		nd_opt_each.done

/* XXX: need nd6_var.h?? */
/* nd6.c */
void nd6_init(void);
void nd6_ifattach(struct ifnet *);
int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *, int);
void nd6_option_init(void *, int, union nd_opts *);
struct nd_opt_hdr *nd6_option(union nd_opts *);
int nd6_options(union nd_opts *);
struct	rtentry *nd6_lookup(struct in6_addr *, int, struct ifnet *, int);
void nd6_setmtu(struct ifnet *);
void nd6_timer(void *);
void nd6_purge(struct ifnet *);
struct llinfo_nd6 *nd6_free(struct rtentry *);
void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
int nd6_resolve(struct ifnet *, struct rtentry *,
		     struct mbuf *, struct sockaddr *, u_char *);
void nd6_rtrequest(int, struct rtentry *, struct sockaddr *);
int nd6_ioctl(u_long, caddr_t, struct ifnet *);
struct rtentry *nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
	char *, int, int, int);
int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
		    struct sockaddr_in6 *, struct rtentry *, int);
int nd6_storelladdr(struct ifnet *, struct rtentry *, struct mbuf *,
			 struct sockaddr *, u_char *);
int nd6_need_cache(struct ifnet *);

/* nd6_nbr.c */
void nd6_na_input(struct mbuf *, int, int);
void nd6_na_output(struct ifnet *, const struct in6_addr *,
	const struct in6_addr *, u_long, int, struct sockaddr *);
void nd6_ns_input(struct mbuf *, int, int);
void nd6_ns_output(struct ifnet *, const struct in6_addr *,
	const struct in6_addr *, struct llinfo_nd6 *, int, int);
caddr_t nd6_ifptomac(struct ifnet *);
void nd6_dad_start(struct ifaddr *, int *);
void nd6_dad_stop(struct ifaddr *);
void nd6_dad_duplicated(struct ifaddr *);

/* nd6_rtr.c */
void nd6_rs_input(struct mbuf *, int, int);
void nd6_ra_input(struct mbuf *, int, int);
void prelist_del(struct nd_prefix *);
void defrouter_addreq(struct nd_defrouter *);
void defrouter_delreq(struct nd_defrouter *, int);
void defrouter_select(void);
void defrtrlist_del(struct nd_defrouter *, int);
void prelist_remove(struct nd_prefix *, int);
int prelist_update(struct nd_prefix *, struct nd_defrouter *,
			struct mbuf *);
int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *,
			 struct nd_prefix **);
int nd6_prefix_onlink(struct nd_prefix *, int, int);
int nd6_prefix_offlink(struct nd_prefix *);
void pfxlist_onlink_check(int);
struct nd_defrouter *defrouter_lookup(struct in6_addr *,
					   struct ifnet *);
struct nd_prefix *nd6_prefix_lookup(struct nd_prefix *);
int in6_init_prefix_ltimes(struct nd_prefix *ndpr);
void rt6_flush(struct in6_addr *, struct ifnet *);
int nd6_setdefaultiface(int);
int in6_tmpifadd(const struct in6_ifaddr *, int);
void ndpr_hold(struct nd_prefix *, boolean_t);
void ndpr_rele(struct nd_prefix *, boolean_t);
#endif /* KERNEL_PRIVATE */

#ifdef KERNEL

/*!
	@function nd6_lookup_ipv6
	@discussion This function will check the routing table for a cached
		neighbor discovery entry or trigger an neighbor discovery query
		to resolve the IPv6 address to a link-layer address.
		
		nd entries are stored in the routing table. This function will
		lookup the IPv6 destination in the routing table. If the
		destination requires forwarding to a gateway, the route of the
		gateway will be looked up. The route entry is inspected to
		determine if the link layer destination address is known. If
		unknown, neighbor discovery will be used to resolve the entry.
	@param interface The interface the packet is being sent on.
	@param ip6_dest The IPv6 destination of the packet.
	@param ll_dest On output, the link-layer destination.
	@param ll_dest_len The length of the buffer for ll_dest.
	@param hint Any routing hint passed down from the protocol.
	@param packet The packet being transmitted.
	@result May return an error such as EHOSTDOWN or ENETUNREACH. If
		this function returns EJUSTRETURN, the packet has been queued
		and will be sent when the address is resolved. If any other
		value is returned, the caller is responsible for disposing of
		the packet.
 */
errno_t nd6_lookup_ipv6(ifnet_t interface, const struct sockaddr_in6 *ip6_dest,
			struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
			mbuf_t packet);

#endif KERNEL
#endif /* _NETINET6_ND6_H_ */
Commit	Line	Data
9bccf70c A	1	/* $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.3 2001/08/13 01:10:49 simokawa Exp $ */
9bccf70c A	2	/* $KAME: nd6.h,v 1.55 2001/04/27 15:09:49 itojun Exp $ */
1c79356b A	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_
9bccf70c	35	#include <sys/appleapiopts.h>
1c79356b A	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
91447636	44	#ifdef KERNEL_PRIVATE
1c79356b A	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 */
9bccf70c	54	int ln_byhint; /* # of times we made it reachable by UL hint */
1c79356b	55	};
91447636	56	#endif /* KERNEL_PRIVATE */
1c79356b A	57
1c79356b A	58	#define ND6_LLINFO_NOSTATE -2
9bccf70c A	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 */
1c79356b A	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;
55e303ae	85	/* the following 3 members are for privacy extension for addrconf */
9bccf70c A	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 */
1c79356b A	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
9bccf70c A	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
1c79356b A	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
9bccf70c A	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
1c79356b A	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
9bccf70c A	179	/* Prefix status */
	180	#define NDPRF_ONLINK 0x1
	181	#define NDPRF_DETACHED 0x2
1c79356b A	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
91447636	190	#ifdef KERNEL_PRIVATE
2d21ac55 A	191	#define ND_IFINFO(ifp) \
	192	(&nd_ifinfo[(ifp)->if_index])
	193	/*
	194	* In a more readable form, we derive linkmtu based on:
	195	*
	196	* if (ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < ifp->if_mtu)
	197	* linkmtu = ND_IFINFO(ifp)->linkmtu;
	198	* else if ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < ifp->if_mtu))
	199	* linkmtu = ND_IFINFO(ifp)->maxmtu;
	200	* else
	201	* linkmtu = ifp->if_mtu;
	202	*/
	203	#define IN6_LINKMTU(ifp) \
	204	((ND_IFINFO(ifp)->linkmtu && \
	205	ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) ? ND_IFINFO(ifp)->linkmtu : \
	206	((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) ? \
	207	ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
	208
1c79356b A	209	/* node constants */
	210	#define MAX_REACHABLE_TIME 3600000 /* msec */
	211	#define REACHABLE_TIME 30000 /* msec */
	212	#define RETRANS_TIMER 1000 /* msec */
	213	#define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
	214	#define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
9bccf70c A	215	#define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
	216	#define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
	217	#define TEMPADDR_REGEN_ADVANCE 5 /* sec */
	218	#define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
1c79356b A	219	#define ND_COMPUTE_RTIME(x) \
	220	(((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
	221	((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
1c79356b A	222
	223	TAILQ_HEAD(nd_drhead, nd_defrouter);
	224	struct nd_defrouter {
	225	TAILQ_ENTRY(nd_defrouter) dr_entry;
	226	struct in6_addr rtaddr;
55e303ae	227	u_char flags; /* flags on RA message */
1c79356b A	228	u_short rtlifetime;
	229	u_long expire;
	230	u_long advint; /* Mobile IPv6 addition (milliseconds) */
	231	u_long advint_expire; /* Mobile IPv6 addition */
	232	int advints_lost; /* Mobile IPv6 addition */
	233	struct ifnet *ifp;
	234	};
	235
	236	struct nd_prefix {
	237	struct ifnet *ndpr_ifp;
	238	LIST_ENTRY(nd_prefix) ndpr_entry;
	239	struct sockaddr_in6 ndpr_prefix; /* prefix */
	240	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
	241	struct in6_addr ndpr_addr; /* address that is derived from the prefix */
	242	u_int32_t ndpr_vltime; /* advertised valid lifetime */
	243	u_int32_t ndpr_pltime; /* advertised preferred lifetime */
	244	time_t ndpr_expire; /* expiration time of the prefix */
	245	time_t ndpr_preferred; /* preferred time of the prefix */
	246	struct prf_ra ndpr_flags;
9bccf70c	247	u_int32_t ndpr_stateflags; /* actual state flags */
1c79356b A	248	/* list of routers that advertise the prefix: */
	249	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
	250	u_char ndpr_plen;
2d21ac55 A	251	int ndpr_refcnt; /* reference counter from addresses */
2d21ac55 A	252	int ndpr_usecnt; /* actual use count; prevents free */
1c79356b A	253	};
	254
	255	#define ndpr_next ndpr_entry.le_next
	256
	257	#define ndpr_raf ndpr_flags
	258	#define ndpr_raf_onlink ndpr_flags.onlink
	259	#define ndpr_raf_auto ndpr_flags.autonomous
	260
1c79356b A	261	/*
	262	* We keep expired prefix for certain amount of time, for validation purposes.
	263	* 1800s = MaxRtrAdvInterval
	264	*/
	265	#define NDPR_KEEP_EXPIRED (1800 * 2)
	266
	267	/*
	268	* Message format for use in obtaining information about prefixes
	269	* from inet6 sysctl function
	270	*/
	271	struct inet6_ndpr_msghdr {
	272	u_short inpm_msglen; /* to skip over non-understood messages */
55e303ae	273	u_char inpm_version; /* future binary compatibility */
1c79356b A	274	u_char inpm_type; /* message type */
	275	struct in6_addr inpm_prefix;
	276	u_long prm_vltim;
	277	u_long prm_pltime;
	278	u_long prm_expire;
	279	u_long prm_preferred;
	280	struct in6_prflags prm_flags;
	281	u_short prm_index; /* index for associated ifp */
	282	u_char prm_plen; /* length of prefix in bits */
	283	};
	284
	285	#define prm_raf_onlink prm_flags.prf_ra.onlink
	286	#define prm_raf_auto prm_flags.prf_ra.autonomous
	287
	288	#define prm_statef_onlink prm_flags.prf_state.onlink
	289
	290	#define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
	291	#define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
	292
	293	#define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
	294	#define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
	295
	296	struct nd_pfxrouter {
	297	LIST_ENTRY(nd_pfxrouter) pfr_entry;
	298	#define pfr_next pfr_entry.le_next
	299	struct nd_defrouter *router;
	300	};
	301
	302	LIST_HEAD(nd_prhead, nd_prefix);
	303
	304	/* nd6.c */
	305	extern int nd6_prune;
	306	extern int nd6_delay;
	307	extern int nd6_umaxtries;
	308	extern int nd6_mmaxtries;
	309	extern int nd6_useloopback;
9bccf70c A	310	extern int nd6_maxnudhint;
9bccf70c A	311	extern int nd6_gctimer;
1c79356b A	312	extern struct llinfo_nd6 llinfo_nd6;
	313	extern struct nd_ifinfo *nd_ifinfo;
	314	extern struct nd_drhead nd_defrouter;
	315	extern struct nd_prhead nd_prefix;
9bccf70c A	316	extern int nd6_debug;
	317
	318	#define nd6log(x) do { if (nd6_debug) log x; } while (0)
	319
	320	extern struct callout nd6_timer_ch;
1c79356b A	321
1c79356b A	322	/* nd6_rtr.c */
1c79356b	323	extern int nd6_defifindex;
9bccf70c A	324	extern int ip6_desync_factor; /* seconds */
	325	extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
	326	extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
	327	extern int ip6_temp_regen_advance; /* seconds */
1c79356b A	328
	329	union nd_opts {
	330	struct nd_opt_hdr nd_opt_array[9]; /max = home agent info*/
	331	struct {
	332	struct nd_opt_hdr *zero;
	333	struct nd_opt_hdr *src_lladdr;
	334	struct nd_opt_hdr *tgt_lladdr;
55e303ae	335	struct nd_opt_prefix_info pi_beg; / multiple opts, start */
1c79356b A	336	struct nd_opt_rd_hdr *rh;
	337	struct nd_opt_mtu *mtu;
	338	struct nd_opt_hdr *six;
	339	struct nd_opt_advint *adv;
	340	struct nd_opt_hai *hai;
	341	struct nd_opt_hdr search; / multiple opts */
	342	struct nd_opt_hdr last; / multiple opts */
	343	int done;
	344	struct nd_opt_prefix_info pi_end;/ multiple opts, end */
	345	} nd_opt_each;
	346	};
	347	#define nd_opts_src_lladdr nd_opt_each.src_lladdr
	348	#define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
	349	#define nd_opts_pi nd_opt_each.pi_beg
	350	#define nd_opts_pi_end nd_opt_each.pi_end
	351	#define nd_opts_rh nd_opt_each.rh
	352	#define nd_opts_mtu nd_opt_each.mtu
	353	#define nd_opts_adv nd_opt_each.adv
	354	#define nd_opts_hai nd_opt_each.hai
	355	#define nd_opts_search nd_opt_each.search
	356	#define nd_opts_last nd_opt_each.last
	357	#define nd_opts_done nd_opt_each.done
	358
	359	/* XXX: need nd6_var.h?? */
	360	/* nd6.c */
91447636 A	361	void nd6_init(void);
	362	void nd6_ifattach(struct ifnet *);
	363	int nd6_is_addr_neighbor(struct sockaddr_in6 , struct ifnet , int);
	364	void nd6_option_init(void , int, union nd_opts );
	365	struct nd_opt_hdr nd6_option(union nd_opts );
	366	int nd6_options(union nd_opts *);
	367	struct rtentry nd6_lookup(struct in6_addr , int, struct ifnet *, int);
	368	void nd6_setmtu(struct ifnet *);
	369	void nd6_timer(void *);
	370	void nd6_purge(struct ifnet *);
	371	struct llinfo_nd6 nd6_free(struct rtentry );
	372	void nd6_nud_hint(struct rtentry , struct in6_addr , int);
	373	int nd6_resolve(struct ifnet , struct rtentry ,
	374	struct mbuf , struct sockaddr , u_char *);
	375	void nd6_rtrequest(int, struct rtentry , struct sockaddr );
	376	int nd6_ioctl(u_long, caddr_t, struct ifnet *);
	377	struct rtentry nd6_cache_lladdr(struct ifnet , struct in6_addr *,
	378	char *, int, int, int);
	379	int nd6_output(struct ifnet , struct ifnet , struct mbuf *,
	380	struct sockaddr_in6 , struct rtentry , int);
	381	int nd6_storelladdr(struct ifnet , struct rtentry , struct mbuf *,
	382	struct sockaddr , u_char );
	383	int nd6_need_cache(struct ifnet *);
1c79356b A	384
1c79356b A	385	/* nd6_nbr.c */
91447636 A	386	void nd6_na_input(struct mbuf *, int, int);
	387	void nd6_na_output(struct ifnet , const struct in6_addr ,
	388	const struct in6_addr , u_long, int, struct sockaddr );
	389	void nd6_ns_input(struct mbuf *, int, int);
	390	void nd6_ns_output(struct ifnet , const struct in6_addr ,
	391	const struct in6_addr , struct llinfo_nd6 , int, int);
	392	caddr_t nd6_ifptomac(struct ifnet *);
	393	void nd6_dad_start(struct ifaddr , int );
	394	void nd6_dad_stop(struct ifaddr *);
	395	void nd6_dad_duplicated(struct ifaddr *);
1c79356b A	396
1c79356b A	397	/* nd6_rtr.c */
91447636 A	398	void nd6_rs_input(struct mbuf *, int, int);
	399	void nd6_ra_input(struct mbuf *, int, int);
	400	void prelist_del(struct nd_prefix *);
	401	void defrouter_addreq(struct nd_defrouter *);
	402	void defrouter_delreq(struct nd_defrouter *, int);
	403	void defrouter_select(void);
	404	void defrtrlist_del(struct nd_defrouter *, int);
	405	void prelist_remove(struct nd_prefix *, int);
	406	int prelist_update(struct nd_prefix , struct nd_defrouter ,
	407	struct mbuf *);
	408	int nd6_prelist_add(struct nd_prefix , struct nd_defrouter ,
	409	struct nd_prefix **);
	410	int nd6_prefix_onlink(struct nd_prefix *, int, int);
	411	int nd6_prefix_offlink(struct nd_prefix *);
	412	void pfxlist_onlink_check(int);
	413	struct nd_defrouter defrouter_lookup(struct in6_addr ,
	414	struct ifnet *);
	415	struct nd_prefix nd6_prefix_lookup(struct nd_prefix );
	416	int in6_init_prefix_ltimes(struct nd_prefix *ndpr);
	417	void rt6_flush(struct in6_addr , struct ifnet );
	418	int nd6_setdefaultiface(int);
	419	int in6_tmpifadd(const struct in6_ifaddr *, int);
2d21ac55 A	420	void ndpr_hold(struct nd_prefix *, boolean_t);
2d21ac55 A	421	void ndpr_rele(struct nd_prefix *, boolean_t);
91447636 A	422	#endif /* KERNEL_PRIVATE */
	423
	424	#ifdef KERNEL
	425
	426	/*!
	427	@function nd6_lookup_ipv6
	428	@discussion This function will check the routing table for a cached
	429	neighbor discovery entry or trigger an neighbor discovery query
	430	to resolve the IPv6 address to a link-layer address.
	431
	432	nd entries are stored in the routing table. This function will
	433	lookup the IPv6 destination in the routing table. If the
	434	destination requires forwarding to a gateway, the route of the
	435	gateway will be looked up. The route entry is inspected to
	436	determine if the link layer destination address is known. If
	437	unknown, neighbor discovery will be used to resolve the entry.
	438	@param interface The interface the packet is being sent on.
	439	@param ip6_dest The IPv6 destination of the packet.
	440	@param ll_dest On output, the link-layer destination.
	441	@param ll_dest_len The length of the buffer for ll_dest.
	442	@param hint Any routing hint passed down from the protocol.
	443	@param packet The packet being transmitted.
	444	@result May return an error such as EHOSTDOWN or ENETUNREACH. If
	445	this function returns EJUSTRETURN, the packet has been queued
	446	and will be sent when the address is resolved. If any other
	447	value is returned, the caller is responsible for disposing of
	448	the packet.
	449	*/
	450	errno_t nd6_lookup_ipv6(ifnet_t interface, const struct sockaddr_in6 *ip6_dest,
	451	struct sockaddr_dl *ll_dest, size_t ll_dest_len, route_t hint,
	452	mbuf_t packet);
1c79356b	453
91447636	454	#endif KERNEL
1c79356b	455	#endif /* _NETINET6_ND6_H_ */