inet6: Revoke nd6_ifinfo.receivedra
[dragonfly.git] / sys / netinet6 / nd6.h
CommitLineData
984263bc 1/* $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.5 2002/04/28 05:40:27 suz Exp $ */
cddfb7bb 2/* $DragonFly: src/sys/netinet6/nd6.h,v 1.8 2006/09/03 18:52:29 dillon Exp $ */
984263bc
MD
3/* $KAME: nd6.h,v 1.76 2001/12/18 02:10:31 itojun Exp $ */
4
5/*
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the project nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 */
33
34#ifndef _NETINET6_ND6_H_
35#define _NETINET6_ND6_H_
36
37/* see net/route.h, or net/if_inarp.h */
38#ifndef RTF_ANNOUNCE
39#define RTF_ANNOUNCE RTF_PROTO2
40#endif
41
1bd40720
MD
42#ifndef _SYS_TYPES_H_
43#include <sys/types.h>
44#endif
45#ifndef _SYS_QUEUE_H_
984263bc 46#include <sys/queue.h>
1bd40720
MD
47#endif
48#ifndef _SYS_CALLOUT_H_
984263bc 49#include <sys/callout.h>
1bd40720
MD
50#endif
51#ifndef _NET_IF_H_
52#include <net/if.h>
53#endif
54#ifndef _NETINET_IN_H_
55#include <netinet/in.h>
56#endif
57#ifndef _NETINET6_IN6_VAR_H_
58#include <netinet6/in6_var.h>
59#endif
f884afc5
MD
60#ifndef _SYS_MUTEX_H_
61#include <sys/mutex.h>
62#endif
984263bc
MD
63
64struct llinfo_nd6 {
65 struct llinfo_nd6 *ln_next;
66 struct llinfo_nd6 *ln_prev;
67 struct rtentry *ln_rt;
68 struct mbuf *ln_hold; /* last packet until resolved/timeout */
69 long ln_asked; /* number of queries already sent for this addr */
70 u_long ln_expire; /* lifetime for NDP state transition */
71 short ln_state; /* reachability state */
72 short ln_router; /* 2^0: ND6 router bit */
73 int ln_byhint; /* # of times we made it reachable by UL hint */
74};
75
76#define ND6_LLINFO_NOSTATE -2
77/*
78 * We don't need the WAITDELETE state any more, but we keep the definition
79 * in a comment line instead of removing it. This is necessary to avoid
80 * unintentionally reusing the value for another purpose, which might
81 * affect backward compatibility with old applications.
82 * (20000711 jinmei@kame.net)
83 */
84/* #define ND6_LLINFO_WAITDELETE -1 */
85#define ND6_LLINFO_INCOMPLETE 0
86#define ND6_LLINFO_REACHABLE 1
87#define ND6_LLINFO_STALE 2
88#define ND6_LLINFO_DELAY 3
89#define ND6_LLINFO_PROBE 4
90
91#define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
92
93struct nd_ifinfo {
94 u_int32_t linkmtu; /* LinkMTU */
95 u_int32_t maxmtu; /* Upper bound of LinkMTU */
96 u_int32_t basereachable; /* BaseReachableTime */
97 u_int32_t reachable; /* Reachable Time */
98 u_int32_t retrans; /* Retrans Timer */
99 u_int32_t flags; /* Flags */
100 int recalctm; /* BaseReacable re-calculation timer */
101 u_int8_t chlim; /* CurHopLimit */
2edc87ce 102 u_int8_t reserved; /* reserved 0 */
698ac46c 103 u_int8_t initialized; /* Flag to see the entry is initialized */
984263bc
MD
104 /* the following 3 members are for privacy extension for addrconf */
105 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
106 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
107 u_int8_t randomid[8]; /* current random ID */
108};
109
110#define ND6_IFF_PERFORMNUD 0x1
f5a8f472 111#define ND6_IFF_ACCEPT_RTADV 0x2
984263bc 112
698ac46c
HS
113#ifdef _KERNEL
114#define ND_IFINFO(ifp) \
115 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
116#define IN6_LINKMTU(ifp) \
117 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
118 ? ND_IFINFO(ifp)->linkmtu \
119 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
120 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
121#endif
122
984263bc
MD
123struct in6_nbrinfo {
124 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
125 struct in6_addr addr; /* IPv6 address of the neighbor */
126 long asked; /* number of queries already sent for this addr */
127 int isrouter; /* if it acts as a router */
128 int state; /* reachability state */
129 int expire; /* lifetime for NDP state transition */
130};
131
132#define DRLSTSIZ 10
133#define PRLSTSIZ 10
134struct in6_drlist {
135 char ifname[IFNAMSIZ];
136 struct {
137 struct in6_addr rtaddr;
138 u_char flags;
139 u_short rtlifetime;
140 u_long expire;
141 u_short if_index;
142 } defrouter[DRLSTSIZ];
143};
144
145struct in6_defrouter {
146 struct sockaddr_in6 rtaddr;
147 u_char flags;
148 u_short rtlifetime;
149 u_long expire;
150 u_short if_index;
151};
152
153struct in6_prlist {
154 char ifname[IFNAMSIZ];
155 struct {
156 struct in6_addr prefix;
157 struct prf_ra raflags;
158 u_char prefixlen;
159 u_char origin;
160 u_int32_t vltime;
161 u_int32_t pltime;
162 time_t expire;
163 u_short if_index;
164 u_short advrtrs; /* number of advertisement routers */
165 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
166 } prefix[PRLSTSIZ];
167};
168
169struct in6_prefix {
170 struct sockaddr_in6 prefix;
171 struct prf_ra raflags;
172 u_char prefixlen;
173 u_char origin;
174 u_long vltime;
175 u_long pltime;
176 u_long expire;
177 u_int32_t flags;
178 int refcnt;
179 u_short if_index;
180 u_short advrtrs; /* number of advertisement routers */
181 /* struct sockaddr_in6 advrtr[] */
182};
183
184#ifdef _KERNEL
185struct in6_ondireq {
186 char ifname[IFNAMSIZ];
187 struct {
188 u_int32_t linkmtu; /* LinkMTU */
189 u_int32_t maxmtu; /* Upper bound of LinkMTU */
190 u_int32_t basereachable; /* BaseReachableTime */
191 u_int32_t reachable; /* Reachable Time */
192 u_int32_t retrans; /* Retrans Timer */
193 u_int32_t flags; /* Flags */
194 int recalctm; /* BaseReacable re-calculation timer */
195 u_int8_t chlim; /* CurHopLimit */
196 u_int8_t receivedra;
197 } ndi;
198};
199#endif
200
201struct in6_ndireq {
202 char ifname[IFNAMSIZ];
203 struct nd_ifinfo ndi;
204};
205
206struct in6_ndifreq {
207 char ifname[IFNAMSIZ];
208 u_long ifindex;
209};
210
211/* Prefix status */
212#define NDPRF_ONLINK 0x1
213#define NDPRF_DETACHED 0x2
214
215/* protocol constants */
216#define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
217#define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
218#define MAX_RTR_SOLICITATIONS 3
219
220#define ND6_INFINITE_LIFETIME 0xffffffff
221
222#ifdef _KERNEL
223/* node constants */
224#define MAX_REACHABLE_TIME 3600000 /* msec */
225#define REACHABLE_TIME 30000 /* msec */
226#define RETRANS_TIMER 1000 /* msec */
227#define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
228#define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
229#define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
230#define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
231#define TEMPADDR_REGEN_ADVANCE 5 /* sec */
232#define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
233#define ND_COMPUTE_RTIME(x) \
cddfb7bb 234 (((MIN_RANDOM_FACTOR * (x >> 10)) + (krandom() & \
984263bc
MD
235 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
236
237TAILQ_HEAD(nd_drhead, nd_defrouter);
238struct nd_defrouter {
239 TAILQ_ENTRY(nd_defrouter) dr_entry;
240 struct in6_addr rtaddr;
241 u_char flags; /* flags on RA message */
242 u_short rtlifetime;
243 u_long expire;
244 u_long advint; /* Mobile IPv6 addition (milliseconds) */
245 u_long advint_expire; /* Mobile IPv6 addition */
246 int advints_lost; /* Mobile IPv6 addition */
247 struct ifnet *ifp;
248};
249
250struct nd_prefix {
251 struct ifnet *ndpr_ifp;
252 LIST_ENTRY(nd_prefix) ndpr_entry;
253 struct sockaddr_in6 ndpr_prefix; /* prefix */
254 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
255 struct in6_addr ndpr_addr; /* address that is derived from the prefix */
256 u_int32_t ndpr_vltime; /* advertised valid lifetime */
257 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
258 time_t ndpr_expire; /* expiration time of the prefix */
259 time_t ndpr_preferred; /* preferred time of the prefix */
260 struct prf_ra ndpr_flags;
261 u_int32_t ndpr_stateflags; /* actual state flags */
262 /* list of routers that advertise the prefix: */
263 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
264 u_char ndpr_plen;
265 int ndpr_refcnt; /* reference couter from addresses */
266};
267
268#define ndpr_next ndpr_entry.le_next
269
270#define ndpr_raf ndpr_flags
271#define ndpr_raf_onlink ndpr_flags.onlink
272#define ndpr_raf_auto ndpr_flags.autonomous
273
274/*
275 * We keep expired prefix for certain amount of time, for validation purposes.
276 * 1800s = MaxRtrAdvInterval
277 */
278#define NDPR_KEEP_EXPIRED (1800 * 2)
279
280/*
281 * Message format for use in obtaining information about prefixes
282 * from inet6 sysctl function
283 */
284struct inet6_ndpr_msghdr {
285 u_short inpm_msglen; /* to skip over non-understood messages */
9a7c6212 286 u_char inpm_version; /* future binary compatibility */
984263bc
MD
287 u_char inpm_type; /* message type */
288 struct in6_addr inpm_prefix;
289 u_long prm_vltim;
290 u_long prm_pltime;
291 u_long prm_expire;
292 u_long prm_preferred;
293 struct in6_prflags prm_flags;
294 u_short prm_index; /* index for associated ifp */
295 u_char prm_plen; /* length of prefix in bits */
296};
297
298#define prm_raf_onlink prm_flags.prf_ra.onlink
299#define prm_raf_auto prm_flags.prf_ra.autonomous
300
301#define prm_statef_onlink prm_flags.prf_state.onlink
302
303#define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
304#define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
305
306#define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
984263bc
MD
307
308struct nd_pfxrouter {
309 LIST_ENTRY(nd_pfxrouter) pfr_entry;
310#define pfr_next pfr_entry.le_next
311 struct nd_defrouter *router;
312};
313
314LIST_HEAD(nd_prhead, nd_prefix);
315
316/* nd6.c */
317extern int nd6_prune;
318extern int nd6_delay;
319extern int nd6_umaxtries;
320extern int nd6_mmaxtries;
321extern int nd6_useloopback;
322extern int nd6_maxnudhint;
323extern int nd6_gctimer;
324extern struct llinfo_nd6 llinfo_nd6;
325extern struct nd_ifinfo *nd_ifinfo;
326extern struct nd_drhead nd_defrouter;
327extern struct nd_prhead nd_prefix;
f884afc5 328extern struct mtx nd6_mtx;
984263bc 329extern int nd6_debug;
f5164be2 330extern int nd6_onlink_ns_rfc4861;
984263bc
MD
331
332#define nd6log(x) do { if (nd6_debug) log x; } while (0)
333
984263bc
MD
334/* nd6_rtr.c */
335extern int nd6_defifindex;
336extern int ip6_desync_factor; /* seconds */
337extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
338extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
339extern int ip6_temp_regen_advance; /* seconds */
340
341union nd_opts {
342 struct nd_opt_hdr *nd_opt_array[9]; /* max = home agent info */
343 struct {
344 struct nd_opt_hdr *zero;
345 struct nd_opt_hdr *src_lladdr;
346 struct nd_opt_hdr *tgt_lladdr;
347 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
348 struct nd_opt_rd_hdr *rh;
349 struct nd_opt_mtu *mtu;
350 struct nd_opt_hdr *six;
351 struct nd_opt_advint *adv;
352 struct nd_opt_hai *hai;
353 struct nd_opt_hdr *search; /* multiple opts */
354 struct nd_opt_hdr *last; /* multiple opts */
355 int done;
356 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
357 } nd_opt_each;
358};
359#define nd_opts_src_lladdr nd_opt_each.src_lladdr
360#define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
361#define nd_opts_pi nd_opt_each.pi_beg
362#define nd_opts_pi_end nd_opt_each.pi_end
363#define nd_opts_rh nd_opt_each.rh
364#define nd_opts_mtu nd_opt_each.mtu
365#define nd_opts_adv nd_opt_each.adv
366#define nd_opts_hai nd_opt_each.hai
367#define nd_opts_search nd_opt_each.search
368#define nd_opts_last nd_opt_each.last
369#define nd_opts_done nd_opt_each.done
370
371/* XXX: need nd6_var.h?? */
372/* nd6.c */
56d702cc 373void nd6_init (void);
9cb60aff 374void nd6_timer_init(void);
698ac46c
HS
375struct nd_ifinfo *nd6_ifattach (struct ifnet *);
376void nd6_ifdetach (struct nd_ifinfo *);
56d702cc
RG
377int nd6_is_addr_neighbor (struct sockaddr_in6 *, struct ifnet *);
378void nd6_option_init (void *, int, union nd_opts *);
379struct nd_opt_hdr *nd6_option (union nd_opts *);
380int nd6_options (union nd_opts *);
381struct rtentry *nd6_lookup (struct in6_addr *, int, struct ifnet *);
382void nd6_setmtu (struct ifnet *);
56d702cc
RG
383void nd6_purge (struct ifnet *);
384struct llinfo_nd6 *nd6_free (struct rtentry *);
385void nd6_nud_hint (struct rtentry *, struct in6_addr *, int);
e57e75d5
SZ
386int nd6_resolve(struct ifnet *, struct rtentry *,
387 struct mbuf *, struct sockaddr *, u_char *);
3ffea39d 388void nd6_rtrequest (int, struct rtentry *);
56d702cc
RG
389int nd6_ioctl (u_long, caddr_t, struct ifnet *);
390struct rtentry *nd6_cache_lladdr (struct ifnet *, struct in6_addr *,
391 char *, int, int, int);
e57e75d5
SZ
392int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
393 struct sockaddr_in6 *, struct rtentry *);
394int nd6_storelladdr(struct ifnet *, struct rtentry *, struct mbuf *,
395 struct sockaddr *, u_char *);
56d702cc 396int nd6_need_cache (struct ifnet *);
984263bc
MD
397
398/* nd6_nbr.c */
56d702cc
RG
399void nd6_na_input (struct mbuf *, int, int);
400void nd6_na_output (struct ifnet *, const struct in6_addr *,
401 const struct in6_addr *, u_long, int, struct sockaddr *);
402void nd6_ns_input (struct mbuf *, int, int);
403void nd6_ns_output (struct ifnet *, const struct in6_addr *,
404 const struct in6_addr *, struct llinfo_nd6 *, int);
405caddr_t nd6_ifptomac (struct ifnet *);
406void nd6_dad_start (struct ifaddr *, int *);
407void nd6_dad_stop (struct ifaddr *);
984263bc
MD
408
409/* nd6_rtr.c */
56d702cc
RG
410void nd6_rs_input (struct mbuf *, int, int);
411void nd6_ra_input (struct mbuf *, int, int);
412void prelist_del (struct nd_prefix *);
413void defrouter_addreq (struct nd_defrouter *);
414void defrouter_delreq (struct nd_defrouter *, int);
415void defrouter_select (void);
416void defrtrlist_del (struct nd_defrouter *);
417void prelist_remove (struct nd_prefix *);
e57e75d5
SZ
418int prelist_update(struct nd_prefix *, struct nd_defrouter *,
419 struct mbuf *);
420int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *,
421 struct nd_prefix **);
56d702cc
RG
422int nd6_prefix_onlink (struct nd_prefix *);
423int nd6_prefix_offlink (struct nd_prefix *);
424void pfxlist_onlink_check (void);
e57e75d5 425struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
56d702cc 426struct nd_prefix *nd6_prefix_lookup (struct nd_prefix *);
e57e75d5 427int in6_init_prefix_ltimes (struct nd_prefix *);
56d702cc
RG
428void rt6_flush (struct in6_addr *, struct ifnet *);
429int nd6_setdefaultiface (int);
430int in6_tmpifadd (const struct in6_ifaddr *, int);
984263bc
MD
431
432#endif /* _KERNEL */
433
434#endif /* _NETINET6_ND6_H_ */