libc - Check for invalid context in setcontext() and swapcontext()
[dragonfly.git] / sys / netinet6 / nd6.h
1 /*      $FreeBSD: src/sys/netinet6/nd6.h,v 1.2.2.5 2002/04/28 05:40:27 suz Exp $        */
2 /*      $DragonFly: src/sys/netinet6/nd6.h,v 1.8 2006/09/03 18:52:29 dillon Exp $       */
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
42 #ifndef _SYS_TYPES_H_
43 #include <sys/types.h>
44 #endif
45 #ifndef _SYS_QUEUE_H_
46 #include <sys/queue.h>
47 #endif
48 #ifndef _SYS_CALLOUT_H_
49 #include <sys/callout.h>
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
60 #ifndef _SYS_MUTEX_H_
61 #include <sys/mutex.h>
62 #endif
63
64 struct  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 #define ND6_LLINFO_WAITDELETE   -1
78 #define ND6_LLINFO_INCOMPLETE   0
79 #define ND6_LLINFO_REACHABLE    1
80 #define ND6_LLINFO_STALE        2
81 #define ND6_LLINFO_DELAY        3
82 #define ND6_LLINFO_PROBE        4
83
84 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
85
86 struct nd_ifinfo {
87         u_int32_t linkmtu;              /* LinkMTU */
88         u_int32_t maxmtu;               /* Upper bound of LinkMTU */
89         u_int32_t basereachable;        /* BaseReachableTime */
90         u_int32_t reachable;            /* Reachable Time */
91         u_int32_t retrans;              /* Retrans Timer */
92         u_int32_t flags;                /* Flags */
93         int recalctm;                   /* BaseReacable re-calculation timer */
94         u_int8_t chlim;                 /* CurHopLimit */
95         u_int8_t reserved;              /* reserved 0 */
96         u_int8_t initialized;           /* Flag to see the entry is initialized */
97         /* the following 3 members are for privacy extension for addrconf */
98         u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
99         u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
100         u_int8_t randomid[8];   /* current random ID */
101 };
102
103 #define ND6_IFF_PERFORMNUD      0x1
104 #define ND6_IFF_ACCEPT_RTADV    0x2
105
106 #ifdef _KERNEL
107 #define ND_IFINFO(ifp) \
108         (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
109 #define IN6_LINKMTU(ifp) \
110         ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
111                 ? ND_IFINFO(ifp)->linkmtu \
112                 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
113                         ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
114 #endif
115
116 struct in6_nbrinfo {
117         char ifname[IFNAMSIZ];  /* if name, e.g. "en0" */
118         struct in6_addr addr;   /* IPv6 address of the neighbor */
119         long    asked;          /* number of queries already sent for this addr */
120         int     isrouter;       /* if it acts as a router */
121         int     state;          /* reachability state */
122         int     expire;         /* lifetime for NDP state transition */
123 };
124
125 #define DRLSTSIZ 10
126 #define PRLSTSIZ 10
127 struct  in6_drlist {
128         char ifname[IFNAMSIZ];
129         struct {
130                 struct  in6_addr rtaddr;
131                 u_char  flags;
132                 u_short rtlifetime;
133                 u_long  expire;
134                 u_short if_index;
135         } defrouter[DRLSTSIZ];
136 };
137
138 struct  in6_defrouter {
139         struct  sockaddr_in6 rtaddr;
140         u_char  flags;
141         u_short rtlifetime;
142         u_long  expire;
143         u_short if_index;
144 };
145
146 struct  in6_prlist {
147         char ifname[IFNAMSIZ];
148         struct {
149                 struct  in6_addr prefix;
150                 struct prf_ra raflags;
151                 u_char  prefixlen;
152                 u_char  origin;
153                 u_int32_t vltime;
154                 u_int32_t pltime;
155                 time_t expire;
156                 u_short if_index;
157                 u_short advrtrs; /* number of advertisement routers */
158                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
159         } prefix[PRLSTSIZ];
160 };
161
162 struct in6_prefix {
163         struct  sockaddr_in6 prefix;
164         struct prf_ra raflags;
165         u_char  prefixlen;
166         u_char  origin;
167         u_long  vltime;
168         u_long  pltime;
169         u_long  expire;
170         u_int32_t flags;
171         int refcnt;
172         u_short if_index;
173         u_short advrtrs; /* number of advertisement routers */
174         /* struct sockaddr_in6 advrtr[] */
175 };
176
177 #ifdef _KERNEL
178 struct  in6_ondireq {
179         char ifname[IFNAMSIZ];
180         struct {
181                 u_int32_t linkmtu;      /* LinkMTU */
182                 u_int32_t maxmtu;       /* Upper bound of LinkMTU */
183                 u_int32_t basereachable; /* BaseReachableTime */
184                 u_int32_t reachable;    /* Reachable Time */
185                 u_int32_t retrans;      /* Retrans Timer */
186                 u_int32_t flags;        /* Flags */
187                 int recalctm;           /* BaseReacable re-calculation timer */
188                 u_int8_t chlim;         /* CurHopLimit */
189                 u_int8_t receivedra;
190         } ndi;
191 };
192 #endif
193
194 struct  in6_ndireq {
195         char ifname[IFNAMSIZ];
196         struct nd_ifinfo ndi;
197 };
198
199 struct  in6_ndifreq {
200         char ifname[IFNAMSIZ];
201         u_long ifindex;
202 };
203
204 /* Prefix status */
205 #define NDPRF_ONLINK            0x1
206 #define NDPRF_DETACHED          0x2
207
208 /* protocol constants */
209 #define MAX_RTR_SOLICITATION_DELAY      1       /* 1sec */
210 #define RTR_SOLICITATION_INTERVAL       4       /* 4sec */
211 #define MAX_RTR_SOLICITATIONS           3
212
213 #define ND6_INFINITE_LIFETIME           0xffffffff
214
215 #ifdef _KERNEL
216 /* node constants */
217 #define MAX_REACHABLE_TIME              3600000 /* msec */
218 #define REACHABLE_TIME                  30000   /* msec */
219 #define RETRANS_TIMER                   1000    /* msec */
220 #define MIN_RANDOM_FACTOR               512     /* 1024 * 0.5 */
221 #define MAX_RANDOM_FACTOR               1536    /* 1024 * 1.5 */
222 #define DEF_TEMP_VALID_LIFETIME         604800  /* 1 week */
223 #define DEF_TEMP_PREFERRED_LIFETIME     86400   /* 1 day */
224 #define TEMPADDR_REGEN_ADVANCE          5       /* sec */
225 #define MAX_TEMP_DESYNC_FACTOR          600     /* 10 min */
226 #define ND_COMPUTE_RTIME(x) \
227                 (((MIN_RANDOM_FACTOR * (x >> 10)) + (krandom() & \
228                 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
229
230 TAILQ_HEAD(nd_drhead, nd_defrouter);
231 struct  nd_defrouter {
232         TAILQ_ENTRY(nd_defrouter) dr_entry;
233         struct  in6_addr rtaddr;
234         u_char  flags;          /* flags on RA message */
235         u_short rtlifetime;
236         u_long  expire;
237         u_long  advint;         /* Mobile IPv6 addition (milliseconds) */
238         u_long  advint_expire;  /* Mobile IPv6 addition */
239         int     advints_lost;   /* Mobile IPv6 addition */
240         struct  ifnet *ifp;
241 };
242
243 struct nd_prefix {
244         struct ifnet *ndpr_ifp;
245         LIST_ENTRY(nd_prefix) ndpr_entry;
246         struct sockaddr_in6 ndpr_prefix;        /* prefix */
247         struct in6_addr ndpr_mask; /* netmask derived from the prefix */
248         struct in6_addr ndpr_addr; /* address that is derived from the prefix */
249         u_int32_t ndpr_vltime;  /* advertised valid lifetime */
250         u_int32_t ndpr_pltime;  /* advertised preferred lifetime */
251         time_t ndpr_expire;     /* expiration time of the prefix */
252         time_t ndpr_preferred;  /* preferred time of the prefix */
253         struct prf_ra ndpr_flags;
254         u_int32_t ndpr_stateflags; /* actual state flags */
255         /* list of routers that advertise the prefix: */
256         LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
257         u_char  ndpr_plen;
258         int     ndpr_refcnt;    /* reference couter from addresses */
259 };
260
261 #define ndpr_next               ndpr_entry.le_next
262
263 #define ndpr_raf                ndpr_flags
264 #define ndpr_raf_onlink         ndpr_flags.onlink
265 #define ndpr_raf_auto           ndpr_flags.autonomous
266
267 /*
268  * We keep expired prefix for certain amount of time, for validation purposes.
269  * 1800s = MaxRtrAdvInterval
270  */
271 #define NDPR_KEEP_EXPIRED       (1800 * 2)
272
273 /*
274  * Message format for use in obtaining information about prefixes
275  * from inet6 sysctl function
276  */
277 struct inet6_ndpr_msghdr {
278         u_short inpm_msglen;    /* to skip over non-understood messages */
279         u_char  inpm_version;   /* future binary compatibility */
280         u_char  inpm_type;      /* message type */
281         struct in6_addr inpm_prefix;
282         u_long  prm_vltim;
283         u_long  prm_pltime;
284         u_long  prm_expire;
285         u_long  prm_preferred;
286         struct in6_prflags prm_flags;
287         u_short prm_index;      /* index for associated ifp */
288         u_char  prm_plen;       /* length of prefix in bits */
289 };
290
291 #define prm_raf_onlink          prm_flags.prf_ra.onlink
292 #define prm_raf_auto            prm_flags.prf_ra.autonomous
293
294 #define prm_statef_onlink       prm_flags.prf_state.onlink
295
296 #define prm_rrf_decrvalid       prm_flags.prf_rr.decrvalid
297 #define prm_rrf_decrprefd       prm_flags.prf_rr.decrprefd
298
299 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
300
301 struct nd_pfxrouter {
302         LIST_ENTRY(nd_pfxrouter) pfr_entry;
303 #define pfr_next pfr_entry.le_next
304         struct nd_defrouter *router;
305 };
306
307 LIST_HEAD(nd_prhead, nd_prefix);
308
309 /* nd6.c */
310 extern int nd6_prune;
311 extern int nd6_delay;
312 extern int nd6_umaxtries;
313 extern int nd6_mmaxtries;
314 extern int nd6_useloopback;
315 extern int nd6_maxnudhint;
316 extern int nd6_gctimer;
317 extern struct llinfo_nd6 llinfo_nd6;
318 extern struct nd_ifinfo *nd_ifinfo;
319 extern struct nd_drhead nd_defrouter;
320 extern struct nd_prhead nd_prefix;
321 extern struct mtx nd6_mtx;
322 extern int nd6_debug;
323 extern int nd6_onlink_ns_rfc4861;
324
325 #define nd6log(x)       do { if (nd6_debug) log x; } while (0)
326
327 /* nd6_rtr.c */
328 extern int nd6_defifindex;
329 extern int ip6_desync_factor;   /* seconds */
330 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
331 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
332 extern int ip6_temp_regen_advance; /* seconds */
333
334 union nd_opts {
335         struct nd_opt_hdr *nd_opt_array[9];     /* max = home agent info */
336         struct {
337                 struct nd_opt_hdr *zero;
338                 struct nd_opt_hdr *src_lladdr;
339                 struct nd_opt_hdr *tgt_lladdr;
340                 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
341                 struct nd_opt_rd_hdr *rh;
342                 struct nd_opt_mtu *mtu;
343                 struct nd_opt_hdr *six;
344                 struct nd_opt_advint *adv;
345                 struct nd_opt_hai *hai;
346                 struct nd_opt_hdr *search;      /* multiple opts */
347                 struct nd_opt_hdr *last;        /* multiple opts */
348                 int done;
349                 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
350         } nd_opt_each;
351 };
352 #define nd_opts_src_lladdr      nd_opt_each.src_lladdr
353 #define nd_opts_tgt_lladdr      nd_opt_each.tgt_lladdr
354 #define nd_opts_pi              nd_opt_each.pi_beg
355 #define nd_opts_pi_end          nd_opt_each.pi_end
356 #define nd_opts_rh              nd_opt_each.rh
357 #define nd_opts_mtu             nd_opt_each.mtu
358 #define nd_opts_adv             nd_opt_each.adv
359 #define nd_opts_hai             nd_opt_each.hai
360 #define nd_opts_search          nd_opt_each.search
361 #define nd_opts_last            nd_opt_each.last
362 #define nd_opts_done            nd_opt_each.done
363
364 /* XXX: need nd6_var.h?? */
365 /* nd6.c */
366 void nd6_init (void);
367 void nd6_timer_init(void);
368 struct nd_ifinfo *nd6_ifattach (struct ifnet *);
369 void nd6_ifdetach (struct nd_ifinfo *);
370 int nd6_is_addr_neighbor (struct sockaddr_in6 *, struct ifnet *);
371 void nd6_option_init (void *, int, union nd_opts *);
372 struct nd_opt_hdr *nd6_option (union nd_opts *);
373 int nd6_options (union nd_opts *);
374 struct  rtentry *nd6_lookup (struct in6_addr *, int, struct ifnet *);
375 void nd6_setmtu (struct ifnet *);
376 void nd6_purge (struct ifnet *);
377 struct llinfo_nd6 *nd6_free (struct rtentry *);
378 void nd6_nud_hint (struct rtentry *, struct in6_addr *, int);
379 int nd6_resolve(struct ifnet *, struct rtentry *,
380         struct mbuf *, struct sockaddr *, u_char *);
381 void nd6_rtrequest (int, struct rtentry *);
382 int nd6_ioctl (u_long, caddr_t, struct ifnet *);
383 struct rtentry *nd6_cache_lladdr (struct ifnet *, struct in6_addr *,
384         char *, int, int, int);
385 int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
386         struct sockaddr_in6 *, struct rtentry *);
387 int nd6_need_cache (struct ifnet *);
388
389 /* nd6_nbr.c */
390 void nd6_na_input (struct mbuf *, int, int);
391 void nd6_na_output (struct ifnet *, const struct in6_addr *,
392         const struct in6_addr *, u_long, int, struct sockaddr *);
393 void nd6_ns_input (struct mbuf *, int, int);
394 void nd6_ns_output (struct ifnet *, const struct in6_addr *,
395         const struct in6_addr *, struct llinfo_nd6 *, int);
396 caddr_t nd6_ifptomac (struct ifnet *);
397 void nd6_dad_start (struct ifaddr *, int *);
398 void nd6_dad_stop (struct ifaddr *);
399
400 /* nd6_rtr.c */
401 void nd6_rs_input (struct mbuf *, int, int);
402 void nd6_ra_input (struct mbuf *, int, int);
403 void prelist_del (struct nd_prefix *);
404 void defrouter_addreq (struct nd_defrouter *);
405 void defrouter_delreq (struct nd_defrouter *, int);
406 void defrouter_select (void);
407 void defrtrlist_del (struct nd_defrouter *);
408 void prelist_remove (struct nd_prefix *);
409 int prelist_update(struct nd_prefix *, struct nd_defrouter *,
410         struct mbuf *);
411 int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *,
412         struct nd_prefix **);
413 int nd6_prefix_onlink (struct nd_prefix *);
414 int nd6_prefix_offlink (struct nd_prefix *);
415 void pfxlist_onlink_check (void);
416 struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
417 struct nd_prefix *nd6_prefix_lookup (struct nd_prefix *);
418 int in6_init_prefix_ltimes (struct nd_prefix *);
419 void rt6_flush (struct in6_addr *, struct ifnet *);
420 int nd6_setdefaultiface (int);
421 int in6_tmpifadd (const struct in6_ifaddr *, int);
422
423 #endif /* _KERNEL */
424
425 #endif /* _NETINET6_ND6_H_ */