xref: /freebsd/contrib/ntp/include/ntp_rfc2553.h (revision 74bf4e164ba5851606a27d4feff27717452583e5)
1 /*
2  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the project nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 /*
31  * Copyright (c) 1982, 1986, 1990, 1993
32  *	The Regents of the University of California.  All rights reserved.
33  *
34  * Redistribution and use in source and binary forms, with or without
35  * modification, are permitted provided that the following conditions
36  * are met:
37  * 1. Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in the
41  *    documentation and/or other materials provided with the distribution.
42  * 3. All advertising materials mentioning features or use of this software
43  *    must display the following acknowledgement:
44  *	This product includes software developed by the University of
45  *	California, Berkeley and its contributors.
46  * 4. Neither the name of the University nor the names of its contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60  * SUCH DAMAGE.
61  *
62  *	@(#)in.h	8.3 (Berkeley) 1/3/94
63  */
64 
65 /*
66  * Compatability shims with the rfc2553 API to simplify ntp.
67  */
68 #ifndef _NTP_RFC2553_H_
69 #define _NTP_RFC2553_H_
70 
71 #if defined(_SS_MAXSIZE) || defined(_SS_SIZE)
72 #define HAVE_IPV6
73 #else
74 
75 #include <sys/types.h>
76 #include "ntp_types.h"
77 
78 #ifndef AF_INET6
79 #define AF_INET6	AF_MAX
80 #define PF_INET6	AF_INET6
81 #endif
82 
83 #ifndef HAVE_TYPE_U_INT8_T
84 typedef u_char		u_int8_t;
85 typedef u_short		u_int16_t;
86 typedef u_int32		u_int32_t;
87 #endif /* HAVE_TYPE_U_INT8_T */
88 
89 #ifndef HAVE_TYPE_U_INT64_T
90 typedef struct u_int64_t { u_int32 val[2]; } u_int64_t;
91 #endif /* HAVE_TYPE_U_INT64_T */
92 
93 /*
94  * IPv6 address
95  */
96 #ifdef SYS_WINNT
97 #define in6_addr in_addr6
98 #else
99 /*
100  * Don't include any additional IPv6 definitions
101  * We are defining our own here.
102  */
103 #define ISC_IPV6_H 1
104 
105 struct in6_addr {
106 	union {
107 		u_int8_t   __u6_addr8[16];
108 		u_int16_t  __u6_addr16[8];
109 		u_int32_t  __u6_addr32[4];
110 	} __u6_addr;			/* 128-bit IP6 address */
111 };
112 
113 #define s6_addr   __u6_addr.__u6_addr8
114 #endif
115 
116 /*
117  * Definition of some useful macros to handle IP6 addresses
118  */
119 #ifdef SYS_WINNT
120 #define IN6ADDR_ANY_INIT 	{{ 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 }}
121 #else
122 #define IN6ADDR_ANY_INIT \
123 	{{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
124 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
125 #endif
126 
127 extern const struct in6_addr in6addr_any;
128 
129 #define SIN6_LEN
130 #ifndef HAVE_SOCKADDR_IN6
131 struct sockaddr_in6 {
132 #ifdef HAVE_SA_LEN_IN_STRUCT_SOCKADDR
133 	u_int8_t	sin6_len;	/* length of this struct(sa_family_t)*/
134 	u_int8_t	sin6_family;	/* AF_INET6 (sa_family_t) */
135 #else
136 	short		sin6_family;	/* AF_INET6 (sa_family_t) */
137 #endif
138 	u_int16_t	sin6_port;	/* Transport layer port # (in_port_t)*/
139 	u_int32_t	sin6_flowinfo;	/* IP6 flow information */
140 	struct in6_addr	sin6_addr;	/* IP6 address */
141 	u_int32_t	sin6_scope_id;	/* scope zone index */
142 };
143 #endif
144 
145 /*
146  * Unspecified
147  */
148 #ifndef IN6_IS_ADDR_UNSPECIFIED
149 #define IN6_IS_ADDR_UNSPECIFIED(a)	\
150 	((*(const u_int32_t *)(const void *)(&(a)->s6_addr[0]) == 0) &&	\
151 	 (*(const u_int32_t *)(const void *)(&(a)->s6_addr[4]) == 0) &&	\
152 	 (*(const u_int32_t *)(const void *)(&(a)->s6_addr[8]) == 0) &&	\
153 	 (*(const u_int32_t *)(const void *)(&(a)->s6_addr[12]) == 0))
154 #endif
155 /*
156  * Multicast
157  */
158 #ifndef IN6_IS_ADDR_MULTICAST
159 #define IN6_IS_ADDR_MULTICAST(a)	((a)->s6_addr[0] == 0xff)
160 #endif
161 
162 /*
163  * RFC 2553: protocol-independent placeholder for socket addresses
164  */
165 #define	_SS_MAXSIZE	128
166 #define	_SS_ALIGNSIZE	(sizeof(u_int64_t))
167 #ifdef HAVE_SA_LEN_IN_STRUCT_SOCKADDR
168 #define	_SS_PAD1SIZE	(_SS_ALIGNSIZE - sizeof(u_char) - sizeof(u_int8_t))
169 #define	_SS_PAD2SIZE	(_SS_MAXSIZE - sizeof(u_char) - sizeof(u_int8_t) - \
170 				_SS_PAD1SIZE - _SS_ALIGNSIZE)
171 #else
172 #define	_SS_PAD1SIZE	(_SS_ALIGNSIZE - sizeof(short))
173 #define	_SS_PAD2SIZE	(_SS_MAXSIZE - sizeof(short) - \
174 				_SS_PAD1SIZE - _SS_ALIGNSIZE)
175 #endif /* HAVE_SA_LEN_IN_STRUCT_SOCKADDR */
176 
177 struct sockaddr_storage {
178 #ifdef HAVE_SA_LEN_IN_STRUCT_SOCKADDR
179 	u_int8_t	ss_len;		/* address length */
180 	u_int8_t	ss_family;	/* address family */
181 #else
182 	short		ss_family;	/* address family */
183 #endif
184 	char		__ss_pad1[_SS_PAD1SIZE];
185 	u_int64_t	__ss_align;	/* force desired structure storage alignment */
186 	char		__ss_pad2[_SS_PAD2SIZE];
187 };
188 
189 struct addrinfo {
190 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
191 	int	ai_family;	/* PF_xxx */
192 	int	ai_socktype;	/* SOCK_xxx */
193 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
194 	size_t	ai_addrlen;	/* length of ai_addr */
195 	char	*ai_canonname;	/* canonical name for hostname */
196 	struct	sockaddr *ai_addr;	/* binary address */
197 	struct	addrinfo *ai_next;	/* next structure in linked list */
198 };
199 
200 /*
201  * Error return codes from getaddrinfo()
202  */
203 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
204 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
205 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
206 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
207 #define	EAI_FAMILY	 5	/* ai_family not supported */
208 #define	EAI_MEMORY	 6	/* memory allocation failure */
209 #define	EAI_NODATA	 7	/* no address associated with hostname */
210 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
211 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
212 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
213 #define	EAI_SYSTEM	11	/* system error returned in errno */
214 #define	EAI_BADHINTS	12
215 #define	EAI_PROTOCOL	13
216 #define	EAI_MAX		14
217 
218 /*
219  * Flag values for getaddrinfo()
220  */
221 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
222 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
223 #define	AI_NUMERICHOST	0x00000004 /* prevent name resolution */
224 /* valid flags for addrinfo */
225 #define AI_MASK \
226     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_ADDRCONFIG)
227 
228 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
229 
230 /*
231  * Constants for getnameinfo()
232  */
233 #define	NI_MAXHOST	1025
234 #define	NI_MAXSERV	32
235 
236 /*
237  * Flag values for getnameinfo()
238  */
239 #define	NI_NOFQDN	0x00000001
240 #define	NI_NUMERICHOST	0x00000002
241 #define	NI_NAMEREQD	0x00000004
242 #define	NI_NUMERICSERV	0x00000008
243 #define	NI_DGRAM	0x00000010
244 #define NI_WITHSCOPEID	0x00000020
245 
246 int	getaddrinfo P((const char *, const char *,
247 			 const struct addrinfo *, struct addrinfo **));
248 int	getnameinfo P((const struct sockaddr *, u_int, char *,
249 			 size_t, char *, size_t, int));
250 void	freeaddrinfo P((struct addrinfo *));
251 char	*gai_strerror P((int));
252 
253 #endif /* _SS_MAXSIZE */
254 #endif /* !_NTP_RFC2553_H_ */
255