1/* $NetBSD: nd6.h,v 1.86 2018/03/06 10:57:00 roy Exp $ */
2/* $KAME: nd6.h,v 1.95 2002/06/08 11:31:06 itojun Exp $ */
3
4/*
5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the project nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 */
32
33#ifndef _NETINET6_ND6_H_
34#define _NETINET6_ND6_H_
35
36#include <sys/queue.h>
37#include <sys/callout.h>
38
39#define ND6_LLINFO_PURGE -3
40#define ND6_LLINFO_NOSTATE -2
41/*
42 * We don't need the WAITDELETE state any more, but we keep the definition
43 * in a comment line instead of removing it. This is necessary to avoid
44 * unintentionally reusing the value for another purpose, which might
45 * affect backward compatibility with old applications.
46 * (20000711 jinmei@kame.net)
47 */
48/* #define ND6_LLINFO_WAITDELETE -1 */
49#define ND6_LLINFO_INCOMPLETE 0
50#define ND6_LLINFO_REACHABLE 1
51#define ND6_LLINFO_STALE 2
52#define ND6_LLINFO_DELAY 3
53#define ND6_LLINFO_PROBE 4
54
55#define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
56#define ND6_LLINFO_PERMANENT(n) (((n)->ln_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
57
58struct nd_ifinfo {
59 u_int32_t linkmtu; /* LinkMTU */
60 u_int32_t maxmtu; /* Upper bound of LinkMTU */
61 u_int32_t basereachable; /* BaseReachableTime */
62 u_int32_t reachable; /* Reachable Time */
63 u_int32_t retrans; /* Retrans Timer */
64 u_int32_t flags; /* Flags */
65 int recalctm; /* BaseReacable re-calculation timer */
66 u_int8_t chlim; /* CurHopLimit */
67 u_int8_t initialized; /* Flag to see the entry is initialized */
68 /* the following 3 members are for privacy extension for addrconf */
69 u_int8_t randomseed0[8]; /* upper 64 bits of MD5 digest */
70 u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
71 u_int8_t randomid[8]; /* current random ID */
72};
73
74#define ND6_IFF_PERFORMNUD 0x01
75#define ND6_IFF_ACCEPT_RTADV 0x02 /* See "RTADV Key", below. */
76#define ND6_IFF_PREFER_SOURCE 0x04 /* XXX: not related to ND. */
77#define ND6_IFF_IFDISABLED 0x08 /* IPv6 operation is disabled due to
78 * DAD failure. (XXX: not ND-specific)
79 */
80#define ND6_IFF_OVERRIDE_RTADV 0x10 /* See "RTADV Key", below. */
81#define ND6_IFF_AUTO_LINKLOCAL 0x20
82
83/*
84 * RTADV Key
85 *
86 * The flags ND6_IFF_ACCEPT_RTADV and ND6_IFF_OVERRIDE_RTADV form a
87 * tri-state variable. (There are actually four different states, but
88 * two of the states are functionally identical.)
89 *
90 * ND6_IFF_OVERRIDE_RTADV or 0: This interface does not accept
91 * Router Advertisements.
92 *
93 * ND6_IFF_OVERRIDE_RTADV|
94 * ND6_IFF_ACCEPT_RTADV: This interface accepts Router
95 * Advertisements regardless of the
96 * global setting, ip6_accept_rtadv.
97 *
98 * ND6_IFF_ACCEPT_RTADV: This interface follows the global setting,
99 * ip6_accept_rtadv. If ip6_accept_rtadv == 0,
100 * this interface does not accept Router
101 * Advertisements. If ip6_accept_rtadv != 0,
102 * this interface does accept them.
103 */
104
105#ifdef _KERNEL
106#define ND_IFINFO(ifp) \
107 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->nd_ifinfo)
108#define IN6_LINKMTU(ifp) \
109 ((ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) \
110 ? ND_IFINFO(ifp)->linkmtu \
111 : ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) \
112 ? ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu))
113#endif
114
115struct in6_nbrinfo {
116 char ifname[IFNAMSIZ]; /* if name, e.g. "en0" */
117 struct in6_addr addr; /* IPv6 address of the neighbor */
118 long asked; /* number of queries already sent for this addr */
119 int isrouter; /* if it acts as a router */
120 int state; /* reachability state */
121 int expire; /* lifetime for NDP state transition */
122};
123
124#define DRLSTSIZ 10
125#define PRLSTSIZ 10
126struct in6_drlist {
127 char ifname[IFNAMSIZ];
128 struct {
129 struct in6_addr rtaddr;
130 u_char flags;
131 u_short rtlifetime;
132 u_long expire;
133 u_short if_index;
134 } defrouter[DRLSTSIZ];
135};
136
137struct in6_defrouter {
138 struct sockaddr_in6 rtaddr;
139 u_char flags;
140 u_short rtlifetime;
141 u_long expire;
142 u_short if_index;
143};
144
145#ifdef _KERNEL
146struct in6_oprlist {
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_long vltime;
154 u_long pltime;
155 u_long 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#endif
162
163struct in6_prlist {
164 char ifname[IFNAMSIZ];
165 struct {
166 struct in6_addr prefix;
167 struct prf_ra raflags;
168 u_char prefixlen;
169 u_char origin;
170 u_int32_t vltime;
171 u_int32_t pltime;
172 time_t expire;
173 u_short if_index;
174 u_short advrtrs; /* number of advertisement routers */
175 struct in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
176 } prefix[PRLSTSIZ];
177};
178
179struct in6_prefix {
180 struct sockaddr_in6 prefix;
181 struct prf_ra raflags;
182 u_char prefixlen;
183 u_char origin;
184 u_int32_t vltime;
185 u_int32_t pltime;
186 time_t expire;
187 u_int32_t flags;
188 int refcnt;
189 u_short if_index;
190 u_short advrtrs; /* number of advertisement routers */
191 /* struct sockaddr_in6 advrtr[] */
192};
193
194#ifdef _KERNEL
195struct in6_ondireq {
196 char ifname[IFNAMSIZ];
197 struct {
198 u_int32_t linkmtu; /* LinkMTU */
199 u_int32_t maxmtu; /* Upper bound of LinkMTU */
200 u_int32_t basereachable; /* BaseReachableTime */
201 u_int32_t reachable; /* Reachable Time */
202 u_int32_t retrans; /* Retrans Timer */
203 u_int32_t flags; /* Flags */
204 int recalctm; /* BaseReacable re-calculation timer */
205 u_int8_t chlim; /* CurHopLimit */
206 u_int8_t receivedra;
207 } ndi;
208};
209#endif
210
211struct in6_ndireq {
212 char ifname[IFNAMSIZ];
213 struct nd_ifinfo ndi;
214};
215
216struct in6_ndifreq {
217 char ifname[IFNAMSIZ];
218 u_long ifindex;
219};
220
221/* Prefix status */
222#define NDPRF_ONLINK 0x1
223#define NDPRF_DETACHED 0x2
224#define NDPRF_HOME 0x4
225
226/* protocol constants */
227#define MAX_RTR_SOLICITATION_DELAY 1 /* 1sec */
228#define RTR_SOLICITATION_INTERVAL 4 /* 4sec */
229#define MAX_RTR_SOLICITATIONS 3
230
231#define ND6_INFINITE_LIFETIME ((u_int32_t)~0)
232
233#ifdef _KERNEL
234/* node constants */
235#define MAX_REACHABLE_TIME 3600000 /* msec */
236#define REACHABLE_TIME 30000 /* msec */
237#define RETRANS_TIMER 1000 /* msec */
238#define MIN_RANDOM_FACTOR 512 /* 1024 * 0.5 */
239#define MAX_RANDOM_FACTOR 1536 /* 1024 * 1.5 */
240#define DEF_TEMP_VALID_LIFETIME 604800 /* 1 week */
241#define DEF_TEMP_PREFERRED_LIFETIME 86400 /* 1 day */
242#define TEMPADDR_REGEN_ADVANCE 5 /* sec */
243#define MAX_TEMP_DESYNC_FACTOR 600 /* 10 min */
244#define ND_COMPUTE_RTIME(x) \
245 (((MIN_RANDOM_FACTOR * (x >> 10)) + (cprng_fast32() & \
246 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
247
248TAILQ_HEAD(nd_drhead, nd_defrouter);
249struct nd_defrouter {
250 TAILQ_ENTRY(nd_defrouter) dr_entry;
251 struct in6_addr rtaddr;
252 u_char flags; /* flags on RA message */
253 u_short rtlifetime;
254 u_long expire;
255 struct ifnet *ifp;
256 int installed; /* is installed into kernel routing table */
257};
258
259#define ND_DEFROUTER_LIST_INIT() \
260 TAILQ_INIT(&nd_defrouter)
261#define ND_DEFROUTER_LIST_FOREACH(dr) \
262 TAILQ_FOREACH((dr), &nd_defrouter, dr_entry)
263#define ND_DEFROUTER_LIST_FOREACH_SAFE(dr, dr_next) \
264 TAILQ_FOREACH_SAFE((dr), &nd_defrouter, dr_entry, (dr_next))
265#define ND_DEFROUTER_LIST_EMPTY() \
266 TAILQ_EMPTY(&nd_defrouter)
267#define ND_DEFROUTER_LIST_REMOVE(dr) \
268 TAILQ_REMOVE(&nd_defrouter, (dr), dr_entry)
269#define ND_DEFROUTER_LIST_INSERT_BEFORE(dr, dr_new) \
270 TAILQ_INSERT_BEFORE((dr), (dr_new), dr_entry)
271#define ND_DEFROUTER_LIST_INSERT_TAIL(dr) \
272 TAILQ_INSERT_TAIL(&nd_defrouter, (dr), dr_entry)
273#define ND_DEFROUTER_LIST_FIRST() \
274 TAILQ_FIRST(&nd_defrouter)
275#define ND_DEFROUTER_LIST_NEXT(dr) \
276 TAILQ_NEXT((dr), dr_entry)
277
278struct nd_prefixctl {
279 struct ifnet *ndprc_ifp;
280
281 /* prefix */
282 struct sockaddr_in6 ndprc_prefix;
283 u_char ndprc_plen;
284
285 u_int32_t ndprc_vltime; /* advertised valid lifetime */
286 u_int32_t ndprc_pltime; /* advertised preferred lifetime */
287
288 struct prf_ra ndprc_flags;
289};
290
291#define ndprc_raf ndprc_flags
292#define ndprc_raf_onlink ndprc_flags.onlink
293#define ndprc_raf_auto ndprc_flags.autonomous
294#define ndprc_raf_router ndprc_flags.router
295
296struct nd_prefix {
297 struct ifnet *ndpr_ifp;
298 LIST_ENTRY(nd_prefix) ndpr_entry;
299 struct sockaddr_in6 ndpr_prefix; /* prefix */
300 struct in6_addr ndpr_mask; /* netmask derived from the prefix */
301
302 u_int32_t ndpr_vltime; /* advertised valid lifetime */
303 u_int32_t ndpr_pltime; /* advertised preferred lifetime */
304
305 time_t ndpr_expire; /* expiration time of the prefix */
306 time_t ndpr_preferred; /* preferred time of the prefix */
307 time_t ndpr_lastupdate; /* reception time of last advertisement */
308
309 struct prf_ra ndpr_flags;
310 u_int32_t ndpr_stateflags; /* actual state flags */
311 /* list of routers that advertise the prefix: */
312 LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
313 u_char ndpr_plen;
314 int ndpr_refcnt; /* reference couter from addresses */
315};
316
317#define ndpr_next ndpr_entry.le_next
318
319#define ndpr_raf ndpr_flags
320#define ndpr_raf_onlink ndpr_flags.onlink
321#define ndpr_raf_auto ndpr_flags.autonomous
322#define ndpr_raf_router ndpr_flags.router
323
324#define ND_PREFIX_LIST_FOREACH(pr) \
325 LIST_FOREACH((pr), &nd_prefix, ndpr_entry)
326#define ND_PREFIX_LIST_FOREACH_SAFE(pr, pr_next) \
327 LIST_FOREACH_SAFE((pr), &nd_prefix, ndpr_entry, (pr_next))
328#define ND_PREFIX_LIST_REMOVE(pr) \
329 LIST_REMOVE((pr), ndpr_entry)
330#define ND_PREFIX_LIST_INSERT_HEAD(pr) \
331 LIST_INSERT_HEAD(&nd_prefix, (pr), ndpr_entry)
332
333/*
334 * Message format for use in obtaining information about prefixes
335 * from inet6 sysctl function
336 */
337struct inet6_ndpr_msghdr {
338 u_short inpm_msglen; /* to skip over non-understood messages */
339 u_char inpm_version; /* future binary compatibility */
340 u_char inpm_type; /* message type */
341 struct in6_addr inpm_prefix;
342 u_long prm_vltim;
343 u_long prm_pltime;
344 u_long prm_expire;
345 u_long prm_preferred;
346 struct in6_prflags prm_flags;
347 u_short prm_index; /* index for associated ifp */
348 u_char prm_plen; /* length of prefix in bits */
349};
350
351#define prm_raf_onlink prm_flags.prf_ra.onlink
352#define prm_raf_auto prm_flags.prf_ra.autonomous
353
354#define prm_statef_onlink prm_flags.prf_state.onlink
355
356#define prm_rrf_decrvalid prm_flags.prf_rr.decrvalid
357#define prm_rrf_decrprefd prm_flags.prf_rr.decrprefd
358
359struct nd_pfxrouter {
360 LIST_ENTRY(nd_pfxrouter) pfr_entry;
361 struct nd_defrouter *router;
362};
363
364LIST_HEAD(nd_prhead, nd_prefix);
365
366#include <sys/mallocvar.h>
367MALLOC_DECLARE(M_IP6NDP);
368
369/* nd6.c */
370extern int nd6_prune;
371extern int nd6_delay;
372extern int nd6_umaxtries;
373extern int nd6_mmaxtries;
374extern int nd6_useloopback;
375extern int nd6_maxnudhint;
376extern int nd6_gctimer;
377extern struct nd_drhead nd_defrouter;
378extern struct nd_prhead nd_prefix;
379extern int nd6_debug;
380
381#define nd6log(level, fmt, args...) \
382 do { if (nd6_debug) log(level, "%s: " fmt, __func__, ##args);} while (0)
383
384extern krwlock_t nd6_lock;
385
386#define ND6_RLOCK() rw_enter(&nd6_lock, RW_READER)
387#define ND6_WLOCK() rw_enter(&nd6_lock, RW_WRITER)
388#define ND6_UNLOCK() rw_exit(&nd6_lock)
389#define ND6_ASSERT_WLOCK() KASSERT(rw_write_held(&nd6_lock))
390#define ND6_ASSERT_LOCK() KASSERT(rw_lock_held(&nd6_lock))
391
392/* nd6_rtr.c */
393extern int ip6_desync_factor; /* seconds */
394extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
395extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
396extern int ip6_temp_regen_advance; /* seconds */
397extern int nd6_numroutes;
398
399union nd_opts {
400 struct nd_opt_hdr *nd_opt_array[16]; /* max = ND_OPT_NONCE */
401 struct {
402 struct nd_opt_hdr *zero;
403 struct nd_opt_hdr *src_lladdr;
404 struct nd_opt_hdr *tgt_lladdr;
405 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
406 struct nd_opt_rd_hdr *rh;
407 struct nd_opt_mtu *mtu;
408 struct nd_opt_hdr *__res6;
409 struct nd_opt_hdr *__res7;
410 struct nd_opt_hdr *__res8;
411 struct nd_opt_hdr *__res9;
412 struct nd_opt_hdr *__res10;
413 struct nd_opt_hdr *__res11;
414 struct nd_opt_hdr *__res12;
415 struct nd_opt_hdr *__res13;
416 struct nd_opt_nonce *nonce;
417 struct nd_opt_hdr *__res15;
418 struct nd_opt_hdr *search; /* multiple opts */
419 struct nd_opt_hdr *last; /* multiple opts */
420 int done;
421 struct nd_opt_prefix_info *pi_end;/* multiple opts, end */
422 } nd_opt_each;
423};
424#define nd_opts_src_lladdr nd_opt_each.src_lladdr
425#define nd_opts_tgt_lladdr nd_opt_each.tgt_lladdr
426#define nd_opts_pi nd_opt_each.pi_beg
427#define nd_opts_pi_end nd_opt_each.pi_end
428#define nd_opts_rh nd_opt_each.rh
429#define nd_opts_mtu nd_opt_each.mtu
430#define nd_opts_nonce nd_opt_each.nonce
431#define nd_opts_search nd_opt_each.search
432#define nd_opts_last nd_opt_each.last
433#define nd_opts_done nd_opt_each.done
434
435#include <net/if_llatbl.h>
436
437/* XXX: need nd6_var.h?? */
438/* nd6.c */
439void nd6_init(void);
440struct nd_ifinfo *nd6_ifattach(struct ifnet *);
441void nd6_ifdetach(struct ifnet *, struct in6_ifextra *);
442int nd6_is_addr_neighbor(const struct sockaddr_in6 *, struct ifnet *);
443void nd6_option_init(void *, int, union nd_opts *);
444int nd6_options(union nd_opts *);
445struct llentry *nd6_lookup(const struct in6_addr *, const struct ifnet *, bool);
446struct llentry *nd6_create(const struct in6_addr *, const struct ifnet *);
447void nd6_setmtu(struct ifnet *);
448void nd6_llinfo_settimer(struct llentry *, time_t);
449void nd6_purge(struct ifnet *, struct in6_ifextra *);
450void nd6_assert_purged(struct ifnet *);
451void nd6_nud_hint(struct rtentry *);
452int nd6_resolve(struct ifnet *, const struct rtentry *, struct mbuf *,
453 const struct sockaddr *, uint8_t *, size_t);
454void nd6_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
455int nd6_ioctl(u_long, void *, struct ifnet *);
456void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
457 char *, int, int, int);
458int nd6_sysctl(int, void *, size_t *, void *, size_t);
459int nd6_need_cache(struct ifnet *);
460void nd6_llinfo_release_pkts(struct llentry *, struct ifnet *);
461
462/* nd6_nbr.c */
463void nd6_na_input(struct mbuf *, int, int);
464void nd6_na_output(struct ifnet *, const struct in6_addr *,
465 const struct in6_addr *, u_long, int, const struct sockaddr *);
466void nd6_ns_input(struct mbuf *, int, int);
467void nd6_ns_output(struct ifnet *, const struct in6_addr *,
468 const struct in6_addr *, struct in6_addr *, uint8_t *);
469const void *nd6_ifptomac(const struct ifnet *);
470void nd6_dad_start(struct ifaddr *, int);
471void nd6_dad_stop(struct ifaddr *);
472
473/* nd6_rtr.c */
474void nd6_rs_input(struct mbuf *, int, int);
475void nd6_ra_input(struct mbuf *, int, int);
476void nd6_defrouter_reset(void);
477void nd6_defrouter_select(void);
478void nd6_defrtrlist_del(struct nd_defrouter *, struct in6_ifextra *);
479void nd6_prefix_unref(struct nd_prefix *);
480void nd6_prelist_remove(struct nd_prefix *);
481void nd6_invalidate_prefix(struct nd_prefix *);
482void nd6_pfxlist_onlink_check(void);
483struct nd_defrouter *nd6_defrouter_lookup(const struct in6_addr *, struct ifnet *);
484void nd6_rt_flush(struct in6_addr *, struct ifnet *);
485int in6_tmpifadd(const struct in6_ifaddr *, int, int);
486bool nd6_accepts_rtadv(const struct nd_ifinfo *);
487
488#endif /* _KERNEL */
489
490#endif /* !_NETINET6_ND6_H_ */
491