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