xref: /netbsd-src/external/bsd/ntp/dist/include/ntp_net.h (revision b757af438b42b93f8c6571f026d8b8ef3eaf5fc9)
1 /*	$NetBSD: ntp_net.h,v 1.1.1.2 2012/01/31 21:23:17 kardel Exp $	*/
2 
3 /*
4  * ntp_net.h - definitions for NTP network stuff
5  */
6 
7 #ifndef NTP_NET_H
8 #define NTP_NET_H
9 
10 #include <sys/types.h>
11 #ifdef HAVE_SYS_SOCKET_H
12 #include <sys/socket.h>
13 #endif
14 #ifdef HAVE_NET_IF_H
15 #include <net/if.h>
16 #endif
17 #ifdef HAVE_NETINET_IN_H
18 #include <netinet/in.h>
19 #endif
20 #ifdef HAVE_NET_IF_VAR_H
21 #include <net/if_var.h>
22 #endif
23 #ifdef HAVE_NETINET_IN_VAR_H
24 #include <netinet/in_var.h>
25 #endif
26 
27 #include "ntp_rfc2553.h"
28 
29 typedef union {
30 	struct sockaddr		sa;
31 	struct sockaddr_in	sa4;
32 	struct sockaddr_in6	sa6;
33 } sockaddr_u;
34 
35 /*
36  * Utilities for manipulating sockaddr_u v4/v6 unions
37  */
38 #define SOCK_ADDR4(psau)	((psau)->sa4.sin_addr)
39 #define SOCK_ADDR6(psau)	((psau)->sa6.sin6_addr)
40 
41 #define PSOCK_ADDR4(psau)	(&SOCK_ADDR4(psau))
42 #define PSOCK_ADDR6(psau)	(&SOCK_ADDR6(psau))
43 
44 #define AF(psau)		((psau)->sa.sa_family)
45 
46 #define IS_IPV4(psau)		(AF_INET == AF(psau))
47 #define IS_IPV6(psau)		(AF_INET6 == AF(psau))
48 
49 /* sockaddr_u v4 address in network byte order */
50 #define	NSRCADR(psau)		(SOCK_ADDR4(psau).s_addr)
51 
52 /* sockaddr_u v4 address in host byte order */
53 #define	SRCADR(psau)		(ntohl(NSRCADR(psau)))
54 
55 /* sockaddr_u v6 address in network byte order */
56 #define NSRCADR6(psau)		(SOCK_ADDR6(psau).s6_addr)
57 
58 /* assign sockaddr_u v4 address from host byte order */
59 #define	SET_ADDR4(psau, addr4)	(NSRCADR(psau) = htonl(addr4))
60 
61 /* assign sockaddr_u v4 address from network byte order */
62 #define SET_ADDR4N(psau, addr4n) (NSRCADR(psau) = (addr4n));
63 
64 /* assign sockaddr_u v6 address from network byte order */
65 #define SET_ADDR6N(psau, s6_addr)				\
66 	(SOCK_ADDR6(psau) = (s6_addr))
67 
68 /* sockaddr_u v4/v6 port in network byte order */
69 #define	NSRCPORT(psau)		((psau)->sa4.sin_port)
70 
71 /* sockaddr_u v4/v6 port in host byte order */
72 #define	SRCPORT(psau)		(ntohs(NSRCPORT(psau)))
73 
74 /* assign sockaddr_u v4/v6 port from host byte order */
75 #define SET_PORT(psau, port)	(NSRCPORT(psau) = htons(port))
76 
77 /* sockaddr_u v6 scope */
78 #define SCOPE_VAR(psau)		((psau)->sa6.sin6_scope_id)
79 
80 #ifdef ISC_PLATFORM_HAVESCOPEID
81 /* v4/v6 scope (always zero for v4) */
82 # define SCOPE(psau)		(IS_IPV4(psau)			\
83 				    ? 0				\
84 				    : SCOPE_VAR(psau))
85 
86 /* are two v6 sockaddr_u scopes equal? */
87 # define SCOPE_EQ(psau1, psau2)					\
88 	(SCOPE_VAR(psau1) == SCOPE_VAR(psau2))
89 
90 /* assign scope if supported */
91 # define SET_SCOPE(psau, s)					\
92 	do							\
93 		if (IS_IPV6(psau))				\
94 			SCOPE_VAR(psau) = (s);			\
95 	while (0)
96 #else	/* ISC_PLATFORM_HAVESCOPEID not defined */
97 # define SCOPE(psau)		(0)
98 # define SCOPE_EQ(psau1, psau2)	(1)
99 # define SET_SCOPE(psau, s)	do { } while (0)
100 #endif	/* ISC_PLATFORM_HAVESCOPEID */
101 
102 /* v4/v6 is multicast address */
103 #define IS_MCAST(psau)						\
104 	(IS_IPV4(psau)						\
105 	    ? IN_CLASSD(SRCADR(psau))				\
106 	    : IN6_IS_ADDR_MULTICAST(PSOCK_ADDR6(psau)))
107 
108 /* v6 is interface ID scope universal, as with MAC-derived addresses */
109 #define IS_IID_UNIV(psau)					\
110 	(!!(0x02 & NSRCADR6(psau)[8]))
111 
112 #define SIZEOF_INADDR(fam)					\
113 	((AF_INET == (fam))					\
114 	    ? sizeof(struct in_addr)				\
115 	    : sizeof(struct in6_addr))
116 
117 #define SIZEOF_SOCKADDR(fam)					\
118 	((AF_INET == (fam))					\
119 	    ? sizeof(struct sockaddr_in)			\
120 	    : sizeof(struct sockaddr_in6))
121 
122 #define SOCKLEN(psau)						\
123 	(IS_IPV4(psau)						\
124 	    ? sizeof((psau)->sa4)				\
125 	    : sizeof((psau)->sa6))
126 
127 #define ZERO_SOCK(psau)						\
128 	memset((psau), 0, sizeof(*(psau)))
129 
130 /* blast a byte value across sockaddr_u v6 address */
131 #define	MEMSET_ADDR6(psau, v)					\
132 	memset((psau)->sa6.sin6_addr.s6_addr, (v),		\
133 		sizeof((psau)->sa6.sin6_addr.s6_addr))
134 
135 #define SET_ONESMASK(psau)					\
136 	do {							\
137 		if (IS_IPV6(psau))				\
138 			MEMSET_ADDR6((psau), 0xff);		\
139 		else						\
140 			NSRCADR(psau) = 0xffffffff;		\
141 	} while(0)
142 
143 /* zero sockaddr_u, fill in family and all-ones (host) mask */
144 #define SET_HOSTMASK(psau, family)				\
145 	do {							\
146 		ZERO_SOCK(psau);				\
147 		AF(psau) = (family);				\
148 		SET_ONESMASK(psau);				\
149 	} while (0)
150 
151 /*
152  * compare two in6_addr returning negative, 0, or positive.
153  * ADDR6_CMP is negative if *pin6A is lower than *pin6B, zero if they
154  * are equal, positive if *pin6A is higher than *pin6B.  IN6ADDR_ANY
155  * is the lowest address (128 zero bits).
156  */
157 #define	ADDR6_CMP(pin6A, pin6B)					\
158 	memcmp((pin6A)->s6_addr, (pin6B)->s6_addr,		\
159 	       sizeof(pin6A)->s6_addr)
160 
161 /* compare two in6_addr for equality only */
162 #if !defined(SYS_WINNT) || !defined(in_addr6)
163 #define ADDR6_EQ(pin6A, pin6B)					\
164 	(!ADDR6_CMP(pin6A, pin6B))
165 #else
166 #define ADDR6_EQ(pin6A, pin6B)					\
167 	IN6_ADDR_EQUAL(pin6A, pin6B)
168 #endif
169 
170 /* compare a in6_addr with socket address */
171 #define	S_ADDR6_EQ(psau, pin6)					\
172 	ADDR6_EQ(&(psau)->sa6.sin6_addr, pin6)
173 
174 /* are two sockaddr_u's addresses equal? (port excluded) */
175 #define SOCK_EQ(psau1, psau2)					\
176 	((AF(psau1) != AF(psau2))				\
177 	     ? 0						\
178 	     : IS_IPV4(psau1)					\
179 		   ? (NSRCADR(psau1) == NSRCADR(psau2))		\
180 		   : (S_ADDR6_EQ((psau1), PSOCK_ADDR6(psau2))	\
181 		      && SCOPE_EQ((psau1), (psau2))))
182 
183 /* are two sockaddr_u's addresses and ports equal? */
184 #define ADDR_PORT_EQ(psau1, psau2)				\
185 	((NSRCPORT(psau1) != NSRCPORT(psau2)			\
186 	     ? 0						\
187 	     : SOCK_EQ((psau1), (psau2))))
188 
189 /* is sockaddr_u address unspecified? */
190 #define SOCK_UNSPEC(psau)					\
191 	(IS_IPV4(psau)						\
192 	    ? !NSRCADR(psau)					\
193 	    : IN6_IS_ADDR_UNSPECIFIED(PSOCK_ADDR6(psau)))
194 
195 /* just how unspecified do you mean? (scope 0/unspec too) */
196 #define SOCK_UNSPEC_S(psau)					\
197 	(SOCK_UNSPEC(psau) && !SCOPE(psau))
198 
199 /* choose a default net interface (struct interface) for v4 or v6 */
200 #define ANY_INTERFACE_BYFAM(family)				\
201 	((AF_INET == family)					\
202 	     ? any_interface					\
203 	     : any6_interface)
204 
205 /* choose a default interface for addresses' protocol (addr family) */
206 #define ANY_INTERFACE_CHOOSE(psau)				\
207 	ANY_INTERFACE_BYFAM(AF(psau))
208 
209 
210 /*
211  * We tell reference clocks from real peers by giving the reference
212  * clocks an address of the form 127.127.t.u, where t is the type and
213  * u is the unit number.  We define some of this here since we will need
214  * some sanity checks to make sure this address isn't interpretted as
215  * that of a normal peer.
216  */
217 #define	REFCLOCK_ADDR	0x7f7f0000	/* 127.127.0.0 */
218 #define	REFCLOCK_MASK	0xffff0000	/* 255.255.0.0 */
219 
220 #ifdef REFCLOCK
221 #define	ISREFCLOCKADR(srcadr)					\
222 	(IS_IPV4(srcadr) &&					\
223 	 (SRCADR(srcadr) & REFCLOCK_MASK) == REFCLOCK_ADDR)
224 #else
225 #define ISREFCLOCKADR(srcadr)		(0)
226 #endif
227 
228 /*
229  * Macro for checking for invalid addresses.  This is really, really
230  * gross, but is needed so no one configures a host on net 127 now that
231  * we're encouraging it the the configuration file.
232  */
233 #define	LOOPBACKADR	0x7f000001
234 #define	LOOPNETMASK	0xff000000
235 
236 #define	ISBADADR(srcadr)					\
237 	(IS_IPV4(srcadr)					\
238 	 && ((SRCADR(srcadr) & LOOPNETMASK)			\
239 	     == (LOOPBACKADR & LOOPNETMASK))			\
240 	 && SRCADR(srcadr) != LOOPBACKADR)
241 
242 
243 #endif /* NTP_NET_H */
244