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