xref: /dragonfly/contrib/dhcpcd/src/ipv6nd.h (revision 54175cef)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * dhcpcd - IPv6 ND handling
4  * Copyright (c) 2006-2023 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 /* rfc4191 */
41 struct routeinfo {
42 	TAILQ_ENTRY(routeinfo) next;
43 	struct in6_addr prefix;
44 	uint8_t prefix_len;
45 	uint32_t lifetime;
46 	uint8_t flags;
47 	struct timespec acquired;
48 	char sprefix[INET6_ADDRSTRLEN];
49 };
50 
51 TAILQ_HEAD(routeinfohead, routeinfo);
52 
53 
54 struct ra {
55 	TAILQ_ENTRY(ra) next;
56 	struct interface *iface;
57 	struct in6_addr from;
58 	char sfrom[INET6_ADDRSTRLEN];
59 	uint8_t *data;
60 	size_t data_len;
61 	struct timespec acquired;
62 	uint8_t flags;
63 	uint32_t lifetime;
64 	uint32_t reachable;
65 	uint32_t retrans;
66 	uint32_t mtu;
67 	uint8_t hoplimit;
68 	struct ipv6_addrhead addrs;
69 	struct routeinfohead rinfos;
70 	bool hasdns;
71 	bool expired;
72 	bool willexpire;
73 	bool doexpire;
74 	bool isreachable;
75 };
76 
77 TAILQ_HEAD(ra_head, ra);
78 
79 struct rs_state {
80 	struct nd_router_solicit *rs;
81 	size_t rslen;
82 	int rsprobes;
83 	uint32_t retrans;
84 #ifdef __sun
85 	int nd_fd;
86 #endif
87 };
88 
89 #define	RS_STATE(a) ((struct rs_state *)(ifp)->if_data[IF_DATA_IPV6ND])
90 #define	RS_CSTATE(a) ((const struct rs_state *)(ifp)->if_data[IF_DATA_IPV6ND])
91 #define	RS_STATE_RUNNING(a) (ipv6nd_hasra((a)) && ipv6nd_dadcompleted((a)))
92 
93 #ifndef MAX_RTR_SOLICITATION_DELAY
94 #define	MAX_RTR_SOLICITATION_DELAY	1	/* seconds */
95 #define	MAX_UNICAST_SOLICIT		3	/* 3 transmissions */
96 #define	RTR_SOLICITATION_INTERVAL	4	/* seconds */
97 #define	MAX_RTR_SOLICITATIONS		3	/* times */
98 #define	MAX_NEIGHBOR_ADVERTISEMENT	3	/* 3 transmissions */
99 
100 #ifndef IPV6_DEFHLIM
101 #define	IPV6_DEFHLIM			64
102 #endif
103 #endif
104 
105 /* On carrier up, expire known routers after RTR_CARRIER_EXPIRE seconds. */
106 #define RTR_CARRIER_EXPIRE		\
107     (MAX_RTR_SOLICITATION_DELAY +	\
108     (MAX_RTR_SOLICITATIONS + 1) *	\
109     RTR_SOLICITATION_INTERVAL)
110 
111 #define	MAX_REACHABLE_TIME		3600000	/* milliseconds */
112 #define	REACHABLE_TIME			30000	/* milliseconds */
113 #define	RETRANS_TIMER			1000	/* milliseconds */
114 #define	DELAY_FIRST_PROBE_TIME		5	/* seconds */
115 
116 #define	MIN_EXTENDED_VLTIME		7200	/* seconds */
117 
118 int ipv6nd_open(bool);
119 #ifdef __sun
120 int ipv6nd_openif(struct interface *);
121 #endif
122 void ipv6nd_recvmsg(struct dhcpcd_ctx *, struct msghdr *);
123 int ipv6nd_rtpref(uint8_t);
124 void ipv6nd_printoptions(const struct dhcpcd_ctx *,
125     const struct dhcp_opt *, size_t);
126 void ipv6nd_startrs(struct interface *);
127 ssize_t ipv6nd_env(FILE *, const struct interface *);
128 const struct ipv6_addr *ipv6nd_iffindaddr(const struct interface *ifp,
129     const struct in6_addr *addr, unsigned int flags);
130 struct ipv6_addr *ipv6nd_findaddr(struct dhcpcd_ctx *,
131     const struct in6_addr *, unsigned int);
132 struct ipv6_addr *ipv6nd_iffindprefix(struct interface *,
133     const struct in6_addr *, uint8_t);
134 ssize_t ipv6nd_free(struct interface *);
135 void ipv6nd_expirera(void *arg);
136 bool ipv6nd_hasralifetime(const struct interface *, bool);
137 #define	ipv6nd_hasra(i)		ipv6nd_hasralifetime((i), false)
138 bool ipv6nd_hasradhcp(const struct interface *, bool);
139 void ipv6nd_handleifa(int, struct ipv6_addr *, pid_t);
140 int ipv6nd_dadcompleted(const struct interface *);
141 void ipv6nd_advertise(struct ipv6_addr *);
142 void ipv6nd_startexpire(struct interface *);
143 void ipv6nd_drop(struct interface *);
144 void ipv6nd_neighbour(struct dhcpcd_ctx *, struct in6_addr *, bool);
145 #endif /* INET6 */
146 
147 #endif /* IPV6ND_H */
148