Home | History | Annotate | Line # | Download | only in netinet6
nd6.h revision 1.5.2.4
      1  1.5.2.4   bouyer /*	$NetBSD: nd6.h,v 1.5.2.4 2001/03/12 13:31:56 bouyer Exp $	*/
      2  1.5.2.4   bouyer /*	$KAME: nd6.h,v 1.52 2001/02/19 04:40:37 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.5.2.1   bouyer  *
      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.5.2.1   bouyer  *
     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.5.2.1   bouyer /* see net/route.h, or net/if_inarp.h */
     37  1.5.2.1   bouyer #ifndef RTF_ANNOUNCE
     38  1.5.2.1   bouyer #define RTF_ANNOUNCE	RTF_PROTO2
     39  1.5.2.1   bouyer #endif
     40  1.5.2.1   bouyer 
     41      1.2   itojun #include <sys/queue.h>
     42  1.5.2.1   bouyer #include <sys/callout.h>
     43      1.2   itojun 
     44      1.2   itojun struct	llinfo_nd6 {
     45      1.2   itojun 	struct	llinfo_nd6 *ln_next;
     46      1.2   itojun 	struct	llinfo_nd6 *ln_prev;
     47      1.2   itojun 	struct	rtentry *ln_rt;
     48      1.2   itojun 	struct	mbuf *ln_hold;	/* last packet until resolved/timeout */
     49      1.2   itojun 	long	ln_asked;	/* number of queries already sent for this addr */
     50      1.2   itojun 	u_long	ln_expire;	/* lifetime for NDP state transition */
     51      1.2   itojun 	short	ln_state;	/* reachability state */
     52      1.2   itojun 	short	ln_router;	/* 2^0: ND6 router bit */
     53  1.5.2.1   bouyer 	int	ln_byhint;	/* # of times we made it reachable by UL hint */
     54      1.2   itojun };
     55      1.2   itojun 
     56      1.2   itojun #define ND6_LLINFO_NOSTATE	-2
     57  1.5.2.4   bouyer /*
     58  1.5.2.4   bouyer  * We don't need the WAITDELETE state any more, but we keep the definition
     59  1.5.2.4   bouyer  * in a comment line instead of removing it. This is necessary to avoid
     60  1.5.2.4   bouyer  * unintentionally reusing the value for another purpose, which might
     61  1.5.2.4   bouyer  * affect backward compatibility with old applications.
     62  1.5.2.4   bouyer  * (20000711 jinmei (at) kame.net)
     63  1.5.2.4   bouyer  */
     64  1.5.2.4   bouyer /* #define ND6_LLINFO_WAITDELETE	-1 */
     65      1.2   itojun #define ND6_LLINFO_INCOMPLETE	0
     66      1.2   itojun #define ND6_LLINFO_REACHABLE	1
     67      1.2   itojun #define ND6_LLINFO_STALE	2
     68      1.2   itojun #define ND6_LLINFO_DELAY	3
     69      1.2   itojun #define ND6_LLINFO_PROBE	4
     70      1.2   itojun 
     71  1.5.2.1   bouyer #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
     72  1.5.2.1   bouyer 
     73      1.2   itojun struct nd_ifinfo {
     74      1.2   itojun 	u_int32_t linkmtu;		/* LinkMTU */
     75      1.2   itojun 	u_int32_t maxmtu;		/* Upper bound of LinkMTU */
     76      1.2   itojun 	u_int32_t basereachable;	/* BaseReachableTime */
     77      1.2   itojun 	u_int32_t reachable;		/* Reachable Time */
     78      1.2   itojun 	u_int32_t retrans;		/* Retrans Timer */
     79  1.5.2.1   bouyer 	u_int32_t flags;		/* Flags */
     80  1.5.2.1   bouyer 	int recalctm;			/* BaseReacable re-calculation timer */
     81      1.2   itojun 	u_int8_t chlim;			/* CurHopLimit */
     82      1.2   itojun 	u_int8_t receivedra;
     83      1.2   itojun };
     84      1.2   itojun 
     85  1.5.2.1   bouyer #define ND6_IFF_PERFORMNUD	0x1
     86  1.5.2.1   bouyer 
     87      1.2   itojun struct in6_nbrinfo {
     88      1.2   itojun 	char ifname[IFNAMSIZ];	/* if name, e.g. "en0" */
     89      1.2   itojun 	struct in6_addr addr;	/* IPv6 address of the neighbor */
     90      1.2   itojun 	long	asked;		/* number of queries already sent for this addr */
     91      1.2   itojun 	int	isrouter;	/* if it acts as a router */
     92      1.2   itojun 	int	state;		/* reachability state */
     93      1.2   itojun 	int	expire;		/* lifetime for NDP state transition */
     94      1.2   itojun };
     95      1.2   itojun 
     96      1.2   itojun #define DRLSTSIZ 10
     97      1.2   itojun #define PRLSTSIZ 10
     98      1.2   itojun struct	in6_drlist {
     99      1.2   itojun 	char ifname[IFNAMSIZ];
    100      1.2   itojun 	struct {
    101      1.2   itojun 		struct	in6_addr rtaddr;
    102      1.2   itojun 		u_char	flags;
    103      1.2   itojun 		u_short	rtlifetime;
    104      1.2   itojun 		u_long	expire;
    105      1.2   itojun 		u_short if_index;
    106      1.2   itojun 	} defrouter[DRLSTSIZ];
    107      1.2   itojun };
    108      1.2   itojun 
    109      1.2   itojun struct	in6_prlist {
    110      1.2   itojun 	char ifname[IFNAMSIZ];
    111      1.2   itojun 	struct {
    112      1.2   itojun 		struct	in6_addr prefix;
    113      1.2   itojun 		struct prf_ra raflags;
    114      1.2   itojun 		u_char	prefixlen;
    115  1.5.2.1   bouyer 		u_char	origin;
    116      1.2   itojun 		u_long	vltime;
    117      1.2   itojun 		u_long	pltime;
    118      1.2   itojun 		u_long	expire;
    119      1.2   itojun 		u_short if_index;
    120      1.2   itojun 		u_short advrtrs; /* number of advertisement routers */
    121      1.2   itojun 		struct	in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
    122      1.2   itojun 	} prefix[PRLSTSIZ];
    123      1.2   itojun };
    124      1.2   itojun 
    125      1.2   itojun struct	in6_ndireq {
    126      1.2   itojun 	char ifname[IFNAMSIZ];
    127      1.2   itojun 	struct nd_ifinfo ndi;
    128      1.2   itojun };
    129      1.2   itojun 
    130  1.5.2.1   bouyer struct	in6_ndifreq {
    131  1.5.2.1   bouyer 	char ifname[IFNAMSIZ];
    132  1.5.2.1   bouyer 	u_long ifindex;
    133  1.5.2.1   bouyer };
    134  1.5.2.1   bouyer 
    135  1.5.2.1   bouyer 
    136      1.2   itojun /* protocol constants */
    137      1.2   itojun #define MAX_RTR_SOLICITATION_DELAY	1	/*1sec*/
    138      1.2   itojun #define RTR_SOLICITATION_INTERVAL	4	/*4sec*/
    139      1.2   itojun #define MAX_RTR_SOLICITATIONS		3
    140      1.2   itojun 
    141      1.2   itojun #define ND6_INFINITE_LIFETIME		0xffffffff
    142      1.2   itojun 
    143      1.2   itojun #ifdef _KERNEL
    144      1.2   itojun /* node constants */
    145      1.2   itojun #define MAX_REACHABLE_TIME		3600000	/* msec */
    146      1.2   itojun #define REACHABLE_TIME			30000	/* msec */
    147      1.2   itojun #define RETRANS_TIMER			1000	/* msec */
    148      1.2   itojun #define MIN_RANDOM_FACTOR		512	/* 1024 * 0.5 */
    149      1.2   itojun #define MAX_RANDOM_FACTOR		1536	/* 1024 * 1.5 */
    150      1.2   itojun #define ND_COMPUTE_RTIME(x) \
    151      1.2   itojun 		(((MIN_RANDOM_FACTOR * (x >> 10)) + (random() & \
    152      1.2   itojun 		((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
    153      1.2   itojun 
    154  1.5.2.1   bouyer TAILQ_HEAD(nd_drhead, nd_defrouter);
    155      1.2   itojun struct	nd_defrouter {
    156  1.5.2.1   bouyer 	TAILQ_ENTRY(nd_defrouter) dr_entry;
    157      1.2   itojun 	struct	in6_addr rtaddr;
    158      1.2   itojun 	u_char	flags;
    159      1.2   itojun 	u_short	rtlifetime;
    160      1.2   itojun 	u_long	expire;
    161      1.2   itojun 	struct  ifnet *ifp;
    162      1.2   itojun };
    163      1.2   itojun 
    164      1.2   itojun struct nd_prefix {
    165  1.5.2.1   bouyer 	struct ifnet *ndpr_ifp;
    166      1.2   itojun 	LIST_ENTRY(nd_prefix) ndpr_entry;
    167      1.2   itojun 	struct sockaddr_in6 ndpr_prefix;	/* prefix */
    168      1.2   itojun 	struct in6_addr ndpr_mask; /* netmask derived from the prefix */
    169      1.2   itojun 	struct in6_addr ndpr_addr; /* address that is derived from the prefix */
    170      1.2   itojun 	u_int32_t ndpr_vltime;	/* advertised valid lifetime */
    171      1.2   itojun 	u_int32_t ndpr_pltime;	/* advertised preferred lifetime */
    172      1.2   itojun 	time_t ndpr_expire;	/* expiration time of the prefix */
    173      1.2   itojun 	time_t ndpr_preferred;	/* preferred time of the prefix */
    174  1.5.2.1   bouyer 	struct prf_ra ndpr_flags;
    175      1.2   itojun 	/* list of routers that advertise the prefix: */
    176      1.2   itojun 	LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
    177  1.5.2.1   bouyer 	u_char	ndpr_plen;
    178      1.2   itojun 	struct	ndpr_stateflags {
    179      1.2   itojun 		/* if this prefix can be regarded as on-link */
    180      1.2   itojun 		u_char onlink : 1;
    181      1.2   itojun 	} ndpr_stateflags;
    182      1.2   itojun };
    183      1.2   itojun 
    184      1.2   itojun #define ndpr_next		ndpr_entry.le_next
    185      1.2   itojun 
    186  1.5.2.1   bouyer #define ndpr_raf		ndpr_flags
    187  1.5.2.1   bouyer #define ndpr_raf_onlink		ndpr_flags.onlink
    188  1.5.2.1   bouyer #define ndpr_raf_auto		ndpr_flags.autonomous
    189      1.2   itojun 
    190      1.2   itojun #define ndpr_statef_onlink	ndpr_stateflags.onlink
    191      1.2   itojun #define ndpr_statef_addmark	ndpr_stateflags.addmark
    192      1.2   itojun 
    193      1.2   itojun /*
    194      1.2   itojun  * We keep expired prefix for certain amount of time, for validation purposes.
    195      1.2   itojun  * 1800s = MaxRtrAdvInterval
    196      1.2   itojun  */
    197      1.2   itojun #define NDPR_KEEP_EXPIRED	(1800 * 2)
    198      1.2   itojun 
    199      1.2   itojun /*
    200      1.2   itojun  * Message format for use in obtaining information about prefixes
    201      1.2   itojun  * from inet6 sysctl function
    202      1.2   itojun  */
    203      1.2   itojun struct inet6_ndpr_msghdr {
    204      1.2   itojun 	u_short	inpm_msglen;	/* to skip over non-understood messages */
    205      1.2   itojun 	u_char	inpm_version;	/* future binary compatability */
    206      1.2   itojun 	u_char	inpm_type;	/* message type */
    207      1.2   itojun 	struct in6_addr inpm_prefix;
    208      1.2   itojun 	u_long	prm_vltim;
    209      1.2   itojun 	u_long	prm_pltime;
    210      1.2   itojun 	u_long	prm_expire;
    211      1.2   itojun 	u_long	prm_preferred;
    212      1.2   itojun 	struct in6_prflags prm_flags;
    213      1.2   itojun 	u_short	prm_index;	/* index for associated ifp */
    214      1.2   itojun 	u_char	prm_plen;	/* length of prefix in bits */
    215      1.2   itojun };
    216      1.2   itojun 
    217      1.2   itojun #define prm_raf_onlink		prm_flags.prf_ra.onlink
    218      1.2   itojun #define prm_raf_auto		prm_flags.prf_ra.autonomous
    219      1.2   itojun 
    220      1.2   itojun #define prm_statef_onlink	prm_flags.prf_state.onlink
    221      1.2   itojun 
    222      1.2   itojun #define prm_rrf_decrvalid	prm_flags.prf_rr.decrvalid
    223      1.2   itojun #define prm_rrf_decrprefd	prm_flags.prf_rr.decrprefd
    224      1.2   itojun 
    225      1.2   itojun #define ifpr2ndpr(ifpr)	((struct nd_prefix *)(ifpr))
    226      1.2   itojun #define ndpr2ifpr(ndpr)	((struct ifprefix *)(ndpr))
    227      1.2   itojun 
    228      1.2   itojun struct nd_pfxrouter {
    229      1.2   itojun 	LIST_ENTRY(nd_pfxrouter) pfr_entry;
    230      1.2   itojun #define pfr_next pfr_entry.le_next
    231      1.2   itojun 	struct nd_defrouter *router;
    232      1.2   itojun };
    233      1.2   itojun 
    234      1.2   itojun LIST_HEAD(nd_prhead, nd_prefix);
    235      1.2   itojun 
    236      1.2   itojun /* nd6.c */
    237      1.2   itojun extern int nd6_prune;
    238      1.2   itojun extern int nd6_delay;
    239      1.2   itojun extern int nd6_umaxtries;
    240      1.2   itojun extern int nd6_mmaxtries;
    241      1.2   itojun extern int nd6_useloopback;
    242  1.5.2.1   bouyer extern int nd6_maxnudhint;
    243  1.5.2.4   bouyer extern int nd6_gctimer;
    244      1.2   itojun extern struct llinfo_nd6 llinfo_nd6;
    245      1.2   itojun extern struct nd_ifinfo *nd_ifinfo;
    246      1.2   itojun extern struct nd_drhead nd_defrouter;
    247      1.2   itojun extern struct nd_prhead nd_prefix;
    248  1.5.2.3   bouyer extern int nd6_debug;
    249  1.5.2.3   bouyer 
    250  1.5.2.3   bouyer #define nd6log(x)	do { if (nd6_debug) log x; } while (0)
    251      1.2   itojun 
    252  1.5.2.1   bouyer extern struct callout nd6_timer_ch;
    253  1.5.2.1   bouyer 
    254  1.5.2.1   bouyer /* nd6_rtr.c */
    255  1.5.2.1   bouyer extern int nd6_defifindex;
    256  1.5.2.1   bouyer 
    257      1.2   itojun union nd_opts {
    258      1.2   itojun 	struct nd_opt_hdr *nd_opt_array[9];
    259      1.2   itojun 	struct {
    260      1.2   itojun 		struct nd_opt_hdr *zero;
    261      1.2   itojun 		struct nd_opt_hdr *src_lladdr;
    262      1.2   itojun 		struct nd_opt_hdr *tgt_lladdr;
    263      1.2   itojun 		struct nd_opt_prefix_info *pi_beg;/* multiple opts, start */
    264      1.2   itojun 		struct nd_opt_rd_hdr *rh;
    265      1.2   itojun 		struct nd_opt_mtu *mtu;
    266      1.2   itojun 		struct nd_opt_hdr *search;	/* multiple opts */
    267      1.2   itojun 		struct nd_opt_hdr *last;	/* multiple opts */
    268      1.2   itojun 		int done;
    269      1.2   itojun 		struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
    270      1.2   itojun 	} nd_opt_each;
    271      1.2   itojun };
    272      1.2   itojun #define nd_opts_src_lladdr	nd_opt_each.src_lladdr
    273      1.2   itojun #define nd_opts_tgt_lladdr	nd_opt_each.tgt_lladdr
    274      1.2   itojun #define nd_opts_pi		nd_opt_each.pi_beg
    275      1.2   itojun #define nd_opts_pi_end		nd_opt_each.pi_end
    276      1.2   itojun #define nd_opts_rh		nd_opt_each.rh
    277      1.2   itojun #define nd_opts_mtu		nd_opt_each.mtu
    278      1.2   itojun #define nd_opts_search		nd_opt_each.search
    279      1.2   itojun #define nd_opts_last		nd_opt_each.last
    280      1.2   itojun #define nd_opts_done		nd_opt_each.done
    281      1.2   itojun 
    282      1.2   itojun /* XXX: need nd6_var.h?? */
    283      1.2   itojun /* nd6.c */
    284      1.2   itojun void nd6_init __P((void));
    285      1.2   itojun void nd6_ifattach __P((struct ifnet *));
    286  1.5.2.1   bouyer int nd6_is_addr_neighbor __P((struct sockaddr_in6 *, struct ifnet *));
    287      1.2   itojun void nd6_option_init __P((void *, int, union nd_opts *));
    288      1.2   itojun struct nd_opt_hdr *nd6_option __P((union nd_opts *));
    289      1.2   itojun int nd6_options __P((union nd_opts *));
    290      1.2   itojun struct	rtentry *nd6_lookup __P((struct in6_addr *, int, struct ifnet *));
    291      1.2   itojun void nd6_setmtu __P((struct ifnet *));
    292      1.2   itojun void nd6_timer __P((void *));
    293  1.5.2.1   bouyer void nd6_purge __P((struct ifnet *));
    294  1.5.2.3   bouyer struct llinfo_nd6 *nd6_free __P((struct rtentry *));
    295  1.5.2.1   bouyer void nd6_nud_hint __P((struct rtentry *, struct in6_addr *, int));
    296      1.2   itojun int nd6_resolve __P((struct ifnet *, struct rtentry *,
    297      1.2   itojun 		     struct mbuf *, struct sockaddr *, u_char *));
    298  1.5.2.2   bouyer void nd6_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
    299  1.5.2.2   bouyer void nd6_p2p_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
    300      1.2   itojun int nd6_ioctl __P((u_long, caddr_t, struct ifnet *));
    301      1.2   itojun struct rtentry *nd6_cache_lladdr __P((struct ifnet *, struct in6_addr *,
    302      1.5   itojun 	char *, int, int, int));
    303      1.2   itojun /* for test */
    304  1.5.2.1   bouyer int nd6_output __P((struct ifnet *, struct ifnet *, struct mbuf *,
    305  1.5.2.1   bouyer 		    struct sockaddr_in6 *, struct rtentry *));
    306      1.2   itojun int nd6_storelladdr __P((struct ifnet *, struct rtentry *, struct mbuf *,
    307      1.2   itojun 			 struct sockaddr *, u_char *));
    308      1.2   itojun 
    309      1.2   itojun /* nd6_nbr.c */
    310      1.2   itojun void nd6_na_input __P((struct mbuf *, int, int));
    311      1.2   itojun void nd6_na_output __P((struct ifnet *, struct in6_addr *,
    312  1.5.2.1   bouyer  			struct in6_addr *, u_long, int, struct sockaddr *));
    313      1.2   itojun void nd6_ns_input __P((struct mbuf *, int, int));
    314      1.2   itojun void nd6_ns_output __P((struct ifnet *, struct in6_addr *,
    315      1.2   itojun 			struct in6_addr *, struct llinfo_nd6 *, int));
    316      1.2   itojun caddr_t nd6_ifptomac __P((struct ifnet *));
    317      1.2   itojun void nd6_dad_start __P((struct ifaddr *, int *));
    318  1.5.2.3   bouyer void nd6_dad_stop __P((struct ifaddr *));
    319      1.2   itojun void nd6_dad_duplicated __P((struct ifaddr *));
    320      1.2   itojun 
    321      1.2   itojun /* nd6_rtr.c */
    322      1.2   itojun void nd6_rs_input __P((struct mbuf *, int, int));
    323      1.2   itojun void nd6_ra_input __P((struct mbuf *, int, int));
    324      1.2   itojun void prelist_del __P((struct nd_prefix *));
    325      1.2   itojun void defrouter_addreq __P((struct nd_defrouter *));
    326      1.2   itojun void defrouter_delreq __P((struct nd_defrouter *, int));
    327  1.5.2.1   bouyer void defrouter_select __P((void));
    328      1.2   itojun void defrtrlist_del __P((struct nd_defrouter *));
    329      1.2   itojun void prelist_remove __P((struct nd_prefix *));
    330      1.2   itojun int prelist_update __P((struct nd_prefix *, struct nd_defrouter *,
    331      1.2   itojun 	struct mbuf *));
    332  1.5.2.1   bouyer void pfxlist_onlink_check __P((void));
    333      1.2   itojun struct nd_defrouter *defrouter_lookup __P((struct in6_addr *,
    334      1.2   itojun 					   struct ifnet *));
    335      1.2   itojun int in6_ifdel __P((struct ifnet *, struct in6_addr *));
    336      1.2   itojun int in6_init_prefix_ltimes __P((struct nd_prefix *ndpr));
    337      1.2   itojun void rt6_flush __P((struct in6_addr *, struct ifnet *));
    338  1.5.2.1   bouyer int nd6_setdefaultiface __P((int));
    339      1.2   itojun 
    340      1.2   itojun #endif /* _KERNEL */
    341      1.2   itojun 
    342      1.2   itojun #endif /* _NETINET6_ND6_H_ */
    343