xref: /dragonfly/contrib/dhcpcd/src/ipv6nd.h (revision 7d2302ac)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * dhcpcd - IPv6 ND handling
4  * Copyright (c) 2006-2019 Roy Marples <roy@marples.name>
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef IPV6ND_H
30 #define IPV6ND_H
31 
32 #ifdef INET6
33 
34 #include <time.h>
35 
36 #include "config.h"
37 #include "dhcpcd.h"
38 #include "ipv6.h"
39 
40 struct ra {
41 	TAILQ_ENTRY(ra) next;
42 	struct interface *iface;
43 	struct in6_addr from;
44 	char sfrom[INET6_ADDRSTRLEN];
45 	uint8_t *data;
46 	size_t data_len;
47 	struct timespec acquired;
48 	unsigned char flags;
49 	uint32_t lifetime;
50 	uint32_t reachable;
51 	uint32_t retrans;
52 	uint32_t mtu;
53 	struct ipv6_addrhead addrs;
54 	bool hasdns;
55 	bool expired;
56 	bool isreachable;
57 };
58 
59 TAILQ_HEAD(ra_head, ra);
60 
61 struct rs_state {
62 	struct nd_router_solicit *rs;
63 	size_t rslen;
64 	int rsprobes;
65 	uint32_t retrans;
66 #ifdef __sun
67 	int nd_fd;
68 #endif
69 };
70 
71 #define	RS_STATE(a) ((struct rs_state *)(ifp)->if_data[IF_DATA_IPV6ND])
72 #define	RS_CSTATE(a) ((const struct rs_state *)(ifp)->if_data[IF_DATA_IPV6ND])
73 #define	RS_STATE_RUNNING(a) (ipv6nd_hasra((a)) && ipv6nd_dadcompleted((a)))
74 
75 #ifndef MAX_RTR_SOLICITATION_DELAY
76 #define	MAX_RTR_SOLICITATION_DELAY	1	/* seconds */
77 #define	MAX_UNICAST_SOLICIT		3	/* 3 transmissions */
78 #define	RTR_SOLICITATION_INTERVAL	4	/* seconds */
79 #define	MAX_RTR_SOLICITATIONS		3	/* times */
80 #define	MAX_NEIGHBOR_ADVERTISEMENT	3	/* 3 transmissions */
81 #endif
82 
83 /* On carrier up, expire known routers after RTR_CARRIER_EXPIRE seconds. */
84 #define RTR_CARRIER_EXPIRE		\
85     (MAX_RTR_SOLICITATION_DELAY +	\
86     (MAX_RTR_SOLICITATIONS + 1) *	\
87     RTR_SOLICITATION_INTERVAL)
88 
89 #define	MAX_REACHABLE_TIME		3600000	/* milliseconds */
90 #define	REACHABLE_TIME			30000	/* milliseconds */
91 #define	RETRANS_TIMER			1000	/* milliseconds */
92 #define	DELAY_FIRST_PROBE_TIME		5	/* seconds */
93 
94 void ipv6nd_printoptions(const struct dhcpcd_ctx *,
95     const struct dhcp_opt *, size_t);
96 void ipv6nd_startrs(struct interface *);
97 ssize_t ipv6nd_env(FILE *, const struct interface *);
98 const struct ipv6_addr *ipv6nd_iffindaddr(const struct interface *ifp,
99     const struct in6_addr *addr, unsigned int flags);
100 struct ipv6_addr *ipv6nd_findaddr(struct dhcpcd_ctx *,
101     const struct in6_addr *, unsigned int);
102 ssize_t ipv6nd_free(struct interface *);
103 void ipv6nd_expirera(void *arg);
104 bool ipv6nd_hasralifetime(const struct interface *, bool);
105 #define	ipv6nd_hasra(i)		ipv6nd_hasralifetime((i), false)
106 bool ipv6nd_hasradhcp(const struct interface *);
107 void ipv6nd_handleifa(int, struct ipv6_addr *, pid_t);
108 int ipv6nd_dadcompleted(const struct interface *);
109 void ipv6nd_advertise(struct ipv6_addr *);
110 void ipv6nd_startexpire(struct interface *);
111 void ipv6nd_drop(struct interface *);
112 void ipv6nd_neighbour(struct dhcpcd_ctx *, struct in6_addr *, bool);
113 #endif /* INET6 */
114 
115 #endif /* IPV6ND_H */
116