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