Home | History | Annotate | Line # | Download | only in netinet6
nd6.h revision 1.9
      1  1.9   itojun /*	$NetBSD: nd6.h,v 1.9 2000/02/26 08:39:20 itojun Exp $	*/
      2  1.9   itojun /*	$KAME: nd6.h,v 1.16 2000/02/24 16:34:51 itojun Exp $	*/
      3  1.3  thorpej 
      4  1.2   itojun /*
      5  1.2   itojun  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
      6  1.2   itojun  * All rights reserved.
      7  1.2   itojun  *
      8  1.2   itojun  * Redistribution and use in source and binary forms, with or without
      9  1.2   itojun  * modification, are permitted provided that the following conditions
     10  1.2   itojun  * are met:
     11  1.2   itojun  * 1. Redistributions of source code must retain the above copyright
     12  1.2   itojun  *    notice, this list of conditions and the following disclaimer.
     13  1.2   itojun  * 2. Redistributions in binary form must reproduce the above copyright
     14  1.2   itojun  *    notice, this list of conditions and the following disclaimer in the
     15  1.2   itojun  *    documentation and/or other materials provided with the distribution.
     16  1.2   itojun  * 3. Neither the name of the project nor the names of its contributors
     17  1.2   itojun  *    may be used to endorse or promote products derived from this software
     18  1.2   itojun  *    without specific prior written permission.
     19  1.2   itojun  *
     20  1.2   itojun  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
     21  1.2   itojun  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     22  1.2   itojun  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     23  1.2   itojun  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
     24  1.2   itojun  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     25  1.2   itojun  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     26  1.2   itojun  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     27  1.2   itojun  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     28  1.2   itojun  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     29  1.2   itojun  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     30  1.2   itojun  * SUCH DAMAGE.
     31  1.2   itojun  */
     32  1.2   itojun 
     33  1.2   itojun #ifndef _NETINET6_ND6_H_
     34  1.2   itojun #define _NETINET6_ND6_H_
     35  1.2   itojun 
     36  1.9   itojun /* see net/route.h, or net/if_inarp.h */
     37  1.9   itojun #ifndef RTF_ANNOUNCE
     38  1.9   itojun #define RTF_ANNOUNCE	RTF_PROTO2
     39  1.9   itojun #endif
     40  1.9   itojun 
     41  1.2   itojun #include <sys/queue.h>
     42  1.2   itojun 
     43  1.2   itojun struct	llinfo_nd6 {
     44  1.2   itojun 	struct	llinfo_nd6 *ln_next;
     45  1.2   itojun 	struct	llinfo_nd6 *ln_prev;
     46  1.2   itojun 	struct	rtentry *ln_rt;
     47  1.2   itojun 	struct	mbuf *ln_hold;	/* last packet until resolved/timeout */
     48  1.2   itojun 	long	ln_asked;	/* number of queries already sent for this addr */
     49  1.2   itojun 	u_long	ln_expire;	/* lifetime for NDP state transition */
     50  1.2   itojun 	short	ln_state;	/* reachability state */
     51  1.2   itojun 	short	ln_router;	/* 2^0: ND6 router bit */
     52  1.2   itojun };
     53  1.2   itojun 
     54  1.2   itojun #define ND6_LLINFO_NOSTATE	-2
     55  1.2   itojun #define ND6_LLINFO_WAITDELETE	-1
     56  1.2   itojun #define ND6_LLINFO_INCOMPLETE	0
     57  1.2   itojun #define ND6_LLINFO_REACHABLE	1
     58  1.2   itojun #define ND6_LLINFO_STALE	2
     59  1.2   itojun #define ND6_LLINFO_DELAY	3
     60  1.2   itojun #define ND6_LLINFO_PROBE	4
     61  1.2   itojun 
     62  1.6   itojun #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
     63  1.6   itojun 
     64  1.2   itojun struct nd_ifinfo {
     65  1.2   itojun 	u_int32_t linkmtu;		/* LinkMTU */
     66  1.2   itojun 	u_int32_t maxmtu;		/* Upper bound of LinkMTU */
     67  1.2   itojun 	u_int32_t basereachable;	/* BaseReachableTime */
     68  1.2   itojun 	u_int32_t reachable;		/* Reachable Time */
     69  1.2   itojun 	u_int32_t retrans;		/* Retrans Timer */
     70  1.6   itojun 	int recalctm;			/* BaseReacable re-calculation timer */
     71  1.2   itojun 	u_int8_t chlim;			/* CurHopLimit */
     72  1.2   itojun 	u_int8_t receivedra;
     73  1.2   itojun };
     74  1.2   itojun 
     75  1.2   itojun struct in6_nbrinfo {
     76  1.2   itojun 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
     77  1.2   itojun 	struct in6_addr addr;	/* IPv6 address of the neighbor */
     78  1.2   itojun 	long	asked;		/* number of queries already sent for this addr */
     79  1.2   itojun 	int	isrouter;	/* if it acts as a router */
     80  1.2   itojun 	int	state;		/* reachability state */
     81  1.2   itojun 	int	expire;		/* lifetime for NDP state transition */
     82  1.2   itojun };
     83  1.2   itojun 
     84  1.2   itojun #define DRLSTSIZ 10
     85  1.2   itojun #define PRLSTSIZ 10
     86  1.2   itojun struct	in6_drlist {
     87  1.2   itojun 	char ifname[IFNAMSIZ];
     88  1.2   itojun 	struct {
     89  1.2   itojun 		struct	in6_addr rtaddr;
     90  1.2   itojun 		u_char	flags;
     91  1.2   itojun 		u_short	rtlifetime;
     92  1.2   itojun 		u_long	expire;
     93  1.2   itojun 		u_short if_index;
     94  1.2   itojun 	} defrouter[DRLSTSIZ];
     95  1.2   itojun };
     96  1.2   itojun 
     97  1.2   itojun struct	in6_prlist {
     98  1.2   itojun 	char ifname[IFNAMSIZ];
     99  1.2   itojun 	struct {
    100  1.2   itojun 		struct	in6_addr prefix;
    101  1.2   itojun 		struct prf_ra raflags;
    102  1.2   itojun 		u_char	prefixlen;
    103  1.9   itojun 		u_char	origin;
    104  1.2   itojun 		u_long	vltime;
    105  1.2   itojun 		u_long	pltime;
    106  1.2   itojun 		u_long	expire;
    107  1.2   itojun 		u_short if_index;
    108  1.2   itojun 		u_short advrtrs; /* number of advertisement routers */
    109  1.2   itojun 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
    110  1.2   itojun 	} prefix[PRLSTSIZ];
    111  1.2   itojun };
    112  1.2   itojun 
    113  1.2   itojun struct	in6_ndireq {
    114  1.2   itojun 	char ifname[IFNAMSIZ];
    115  1.2   itojun 	struct nd_ifinfo ndi;
    116  1.2   itojun };
    117  1.2   itojun 
    118  1.6   itojun struct	in6_ndifreq {
    119  1.6   itojun 	char ifname[IFNAMSIZ];
    120  1.6   itojun 	u_long ifindex;
    121  1.6   itojun };
    122  1.6   itojun 
    123  1.6   itojun 
    124  1.2   itojun /* protocol constants */
    125  1.2   itojun #define MAX_RTR_SOLICITATION_DELAY	1	/*1sec*/
    126  1.2   itojun #define RTR_SOLICITATION_INTERVAL	4	/*4sec*/
    127  1.2   itojun #define MAX_RTR_SOLICITATIONS		3
    128  1.2   itojun 
    129  1.2   itojun #define ND6_INFINITE_LIFETIME		0xffffffff
    130  1.2   itojun 
    131  1.2   itojun #ifdef _KERNEL
    132  1.2   itojun /* node constants */
    133  1.2   itojun #define MAX_REACHABLE_TIME		3600000	/* msec */
    134  1.2   itojun #define REACHABLE_TIME			30000	/* msec */
    135  1.2   itojun #define RETRANS_TIMER			1000	/* msec */
    136  1.2   itojun #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
    137  1.2   itojun #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
    138  1.2   itojun #define ND_COMPUTE_RTIME(x) \
    139  1.2   itojun 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
    140  1.2   itojun 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
    141  1.2   itojun 
    142  1.6   itojun TAILQ_HEAD(nd_drhead, nd_defrouter);
    143  1.2   itojun struct	nd_defrouter {
    144  1.6   itojun 	TAILQ_ENTRY(nd_defrouter) dr_entry;
    145  1.2   itojun 	struct	in6_addr rtaddr;
    146  1.2   itojun 	u_char	flags;
    147  1.2   itojun 	u_short	rtlifetime;
    148  1.2   itojun 	u_long	expire;
    149  1.2   itojun 	struct  ifnet *ifp;
    150  1.2   itojun };
    151  1.2   itojun 
    152  1.2   itojun struct nd_prefix {
    153  1.6   itojun 	struct ifnet *ndpr_ifp;
    154  1.2   itojun 	LIST_ENTRY(nd_prefix) ndpr_entry;
    155  1.2   itojun 	struct sockaddr_in6 ndpr_prefix;	/* prefix */
    156  1.2   itojun 	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
    157  1.2   itojun 	struct in6_addr ndpr_addr; /* address that is derived from the prefix */
    158  1.2   itojun 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
    159  1.2   itojun 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
    160  1.2   itojun 	time_t ndpr_expire;	/* expiration time of the prefix */
    161  1.2   itojun 	time_t ndpr_preferred;	/* preferred time of the prefix */
    162  1.6   itojun 	struct prf_ra ndpr_flags;
    163  1.2   itojun 	/* list of routers that advertise the prefix: */
    164  1.2   itojun 	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
    165  1.6   itojun 	u_char	ndpr_plen;
    166  1.2   itojun 	struct	ndpr_stateflags {
    167  1.2   itojun 		/* if this prefix can be regarded as on-link */
    168  1.2   itojun 		u_char onlink : 1;
    169  1.2   itojun 	} ndpr_stateflags;
    170  1.2   itojun };
    171  1.2   itojun 
    172  1.2   itojun #define ndpr_next		ndpr_entry.le_next
    173  1.2   itojun 
    174  1.6   itojun #define ndpr_raf		ndpr_flags
    175  1.6   itojun #define ndpr_raf_onlink		ndpr_flags.onlink
    176  1.6   itojun #define ndpr_raf_auto		ndpr_flags.autonomous
    177  1.2   itojun 
    178  1.2   itojun #define ndpr_statef_onlink	ndpr_stateflags.onlink
    179  1.2   itojun #define ndpr_statef_addmark	ndpr_stateflags.addmark
    180  1.2   itojun 
    181  1.2   itojun /*
    182  1.2   itojun  * We keep expired prefix for certain amount of time, for validation purposes.
    183  1.2   itojun  * 1800s = MaxRtrAdvInterval
    184  1.2   itojun  */
    185  1.2   itojun #define NDPR_KEEP_EXPIRED	(1800 * 2)
    186  1.2   itojun 
    187  1.2   itojun /*
    188  1.2   itojun  * Message format for use in obtaining information about prefixes
    189  1.2   itojun  * from inet6 sysctl function
    190  1.2   itojun  */
    191  1.2   itojun struct inet6_ndpr_msghdr {
    192  1.2   itojun 	u_short	inpm_msglen;	/* to skip over non-understood messages */
    193  1.2   itojun 	u_char	inpm_version;	/* future binary compatability */
    194  1.2   itojun 	u_char	inpm_type;	/* message type */
    195  1.2   itojun 	struct in6_addr inpm_prefix;
    196  1.2   itojun 	u_long	prm_vltim;
    197  1.2   itojun 	u_long	prm_pltime;
    198  1.2   itojun 	u_long	prm_expire;
    199  1.2   itojun 	u_long	prm_preferred;
    200  1.2   itojun 	struct in6_prflags prm_flags;
    201  1.2   itojun 	u_short	prm_index;	/* index for associated ifp */
    202  1.2   itojun 	u_char	prm_plen;	/* length of prefix in bits */
    203  1.2   itojun };
    204  1.2   itojun 
    205  1.2   itojun #define prm_raf_onlink		prm_flags.prf_ra.onlink
    206  1.2   itojun #define prm_raf_auto		prm_flags.prf_ra.autonomous
    207  1.2   itojun 
    208  1.2   itojun #define prm_statef_onlink	prm_flags.prf_state.onlink
    209  1.2   itojun 
    210  1.2   itojun #define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
    211  1.2   itojun #define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd
    212  1.2   itojun 
    213  1.2   itojun #define ifpr2ndpr(ifpr)	((struct nd_prefix *)(ifpr))
    214  1.2   itojun #define ndpr2ifpr(ndpr)	((struct ifprefix *)(ndpr))
    215  1.2   itojun 
    216  1.2   itojun struct nd_pfxrouter {
    217  1.2   itojun 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
    218  1.2   itojun #define pfr_next pfr_entry.le_next
    219  1.2   itojun 	struct nd_defrouter *router;
    220  1.2   itojun };
    221  1.2   itojun 
    222  1.2   itojun LIST_HEAD(nd_prhead, nd_prefix);
    223  1.2   itojun 
    224  1.2   itojun /* nd6.c */
    225  1.2   itojun extern int nd6_prune;
    226  1.2   itojun extern int nd6_delay;
    227  1.2   itojun extern int nd6_umaxtries;
    228  1.2   itojun extern int nd6_mmaxtries;
    229  1.2   itojun extern int nd6_useloopback;
    230  1.2   itojun extern struct llinfo_nd6 llinfo_nd6;
    231  1.2   itojun extern struct nd_ifinfo *nd_ifinfo;
    232  1.2   itojun extern struct nd_drhead nd_defrouter;
    233  1.2   itojun extern struct nd_prhead nd_prefix;
    234  1.2   itojun 
    235  1.6   itojun /* nd6_rtr.c */
    236  1.6   itojun extern int nd6_defifindex;
    237  1.6   itojun 
    238  1.2   itojun union nd_opts {
    239  1.2   itojun 	struct nd_opt_hdr *nd_opt_array[9];
    240  1.2   itojun 	struct {
    241  1.2   itojun 		struct nd_opt_hdr *zero;
    242  1.2   itojun 		struct nd_opt_hdr *src_lladdr;
    243  1.2   itojun 		struct nd_opt_hdr *tgt_lladdr;
    244  1.2   itojun 		struct nd_opt_prefix_info *pi_beg;/* multiple opts, start */
    245  1.2   itojun 		struct nd_opt_rd_hdr *rh;
    246  1.2   itojun 		struct nd_opt_mtu *mtu;
    247  1.2   itojun 		struct nd_opt_hdr *search;	/* multiple opts */
    248  1.2   itojun 		struct nd_opt_hdr *last;	/* multiple opts */
    249  1.2   itojun 		int done;
    250  1.2   itojun 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
    251  1.2   itojun 	} nd_opt_each;
    252  1.2   itojun };
    253  1.2   itojun #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
    254  1.2   itojun #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
    255  1.2   itojun #define nd_opts_pi		nd_opt_each.pi_beg
    256  1.2   itojun #define nd_opts_pi_end		nd_opt_each.pi_end
    257  1.2   itojun #define nd_opts_rh		nd_opt_each.rh
    258  1.2   itojun #define nd_opts_mtu		nd_opt_each.mtu
    259  1.2   itojun #define nd_opts_search		nd_opt_each.search
    260  1.2   itojun #define nd_opts_last		nd_opt_each.last
    261  1.2   itojun #define nd_opts_done		nd_opt_each.done
    262  1.2   itojun 
    263  1.2   itojun /* XXX: need nd6_var.h?? */
    264  1.2   itojun /* nd6.c */
    265  1.2   itojun void nd6_init __P((void));
    266  1.2   itojun void nd6_ifattach __P((struct ifnet *));
    267  1.4   itojun int nd6_is_addr_neighbor __P((struct in6_addr *, struct ifnet *));
    268  1.2   itojun void nd6_option_init __P((void *, int, union nd_opts *));
    269  1.2   itojun struct nd_opt_hdr *nd6_option __P((union nd_opts *));
    270  1.2   itojun int nd6_options __P((union nd_opts *));
    271  1.2   itojun struct	rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
    272  1.2   itojun void nd6_setmtu __P((struct ifnet *));
    273  1.2   itojun void nd6_timer __P((void *));
    274  1.8   itojun void nd6_purge __P((struct ifnet *));
    275  1.2   itojun void nd6_free __P((struct rtentry *));
    276  1.2   itojun void nd6_nud_hint __P((struct rtentry *, struct in6_addr *));
    277  1.2   itojun int nd6_resolve __P((struct ifnet *, struct rtentry *,
    278  1.2   itojun 		     struct mbuf *, struct sockaddr *, u_char *));
    279  1.2   itojun void nd6_rtrequest __P((int, struct rtentry *, struct sockaddr *));
    280  1.2   itojun void nd6_p2p_rtrequest __P((int, struct rtentry *, struct sockaddr *));
    281  1.2   itojun int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
    282  1.2   itojun struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
    283  1.5   itojun 	char *, int, int, int));
    284  1.2   itojun /* for test */
    285  1.2   itojun int nd6_output __P((struct ifnet *, struct mbuf *, struct sockaddr_in6 *,
    286  1.2   itojun 		    struct rtentry *));
    287  1.2   itojun int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
    288  1.2   itojun 			 struct sockaddr *, u_char *));
    289  1.2   itojun 
    290  1.2   itojun /* nd6_nbr.c */
    291  1.2   itojun void nd6_na_input __P((struct mbuf *, int, int));
    292  1.2   itojun void nd6_na_output __P((struct ifnet *, struct in6_addr *,
    293  1.9   itojun  			struct in6_addr *, u_long, int, struct sockaddr *));
    294  1.2   itojun void nd6_ns_input __P((struct mbuf *, int, int));
    295  1.2   itojun void nd6_ns_output __P((struct ifnet *, struct in6_addr *,
    296  1.2   itojun 			struct in6_addr *, struct llinfo_nd6 *, int));
    297  1.2   itojun caddr_t nd6_ifptomac __P((struct ifnet *));
    298  1.2   itojun void nd6_dad_start __P((struct ifaddr *, int *));
    299  1.2   itojun void nd6_dad_duplicated __P((struct ifaddr *));
    300  1.2   itojun 
    301  1.2   itojun /* nd6_rtr.c */
    302  1.2   itojun void nd6_rs_input __P((struct mbuf *, int, int));
    303  1.2   itojun void nd6_ra_input __P((struct mbuf *, int, int));
    304  1.2   itojun void prelist_del __P((struct nd_prefix *));
    305  1.2   itojun void defrouter_addreq __P((struct nd_defrouter *));
    306  1.2   itojun void defrouter_delreq __P((struct nd_defrouter *, int));
    307  1.6   itojun void defrouter_select __P((void));
    308  1.2   itojun void defrtrlist_del __P((struct nd_defrouter *));
    309  1.2   itojun void prelist_remove __P((struct nd_prefix *));
    310  1.2   itojun int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
    311  1.2   itojun 	struct mbuf *));
    312  1.6   itojun void pfxlist_onlink_check __P((void));
    313  1.2   itojun struct nd_defrouter *defrouter_lookup __P((struct in6_addr *,
    314  1.2   itojun 					   struct ifnet *));
    315  1.2   itojun int in6_ifdel __P((struct ifnet *, struct in6_addr *));
    316  1.2   itojun int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr));
    317  1.2   itojun void rt6_flush __P((struct in6_addr *, struct ifnet *));
    318  1.6   itojun int nd6_setdefaultiface __P((int));
    319  1.2   itojun 
    320  1.2   itojun #endif /* _KERNEL */
    321  1.2   itojun 
    322  1.2   itojun #endif /* _NETINET6_ND6_H_ */
    323