1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/* $Id: socket.h 9562 2013-11-06 23:08:44Z iulius $
**
** Portability wrapper around <sys/socket.h> and friends.
**
** This header file is the equivalent of:
**
** #include <arpa/inet.h>
** #include <netinet/in.h>
** #include <netdb.h>
** #include <sys/socket.h>
**
** but also cleans up various messes, mostly related to IPv6 support. It
** ensures that inet_aton, inet_ntoa, and inet_ntop are available and
** properly prototyped.
*/
#ifndef PORTABLE_SOCKET_H
#define PORTABLE_SOCKET_H 1
#include "config.h"
#include <errno.h>
#include <sys/types.h>
/* BSDI needs <netinet/in.h> before <arpa/inet.h>. */
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <sys/socket.h>
/* Pick up definitions of getaddrinfo and getnameinfo if not otherwise
available. */
#include "portable/getaddrinfo.h"
#include "portable/getnameinfo.h"
BEGIN_DECLS
/* Provide prototypes for inet_aton and inet_ntoa if not prototyped in the
system header files since they're occasionally available without proper
prototypes. */
#if !HAVE_DECL_INET_ATON
extern int inet_aton(const char *, struct in_addr *);
#endif
#if !HAVE_DECL_INET_NTOA
extern const char * inet_ntoa(const struct in_addr);
#endif
#if !HAVE_INET_NTOP
extern const char * inet_ntop(int, const void *, char *, socklen_t);
#endif
/*
* Used for portability to Windows, which requires different functions be
* called to close sockets, send data to or read from sockets, and get socket
* errors than the regular functions and variables. Windows also uses SOCKET
* to store socket descriptors instead of an int.
*
* socket_init must be called before socket functions are used and
* socket_shutdown at the end of the program. socket_init may return failure,
* but this interface doesn't have a way to retrieve the exact error.
*
* socket_close, socket_read, and socket_write must be used instead of the
* standard functions. On Windows, closesocket must be called instead of
* close for sockets and recv and send must always be used instead of read and
* write.
*
* When reporting errors from socket functions, use socket_errno and
* socket_strerror instead of errno and strerror. When setting errno to
* something for socket errors (to preserve errors through close, for
* example), use socket_set_errno instead of just assigning to errno.
*
* Socket file descriptors must be passed and stored in variables of type
* socket_type rather than an int. Use INVALID_SOCKET for invalid socket file
* descriptors rather than -1, and compare to INVALID_SOCKET when testing
* whether operations succeed.
*/
#ifdef _WIN32
int socket_init(void);
# define socket_shutdown() WSACleanup()
# define socket_close(fd) closesocket(fd)
# define socket_read(fd, b, s) recv((fd), (b), (s), 0)
# define socket_write(fd, b, s) send((fd), (b), (s), 0)
# define socket_errno WSAGetLastError()
# define socket_set_errno(e) WSASetLastError(e)
const char *socket_strerror(int);
typedef SOCKET socket_type;
#else
# define socket_init() 1
# define socket_shutdown() /* empty */
# define socket_close(fd) close(fd)
# define socket_read(fd, b, s) read((fd), (b), (s))
# define socket_write(fd, b, s) write((fd), (b), (s))
# define socket_errno errno
# define socket_set_errno(e) errno = (e)
# define socket_strerror(e) strerror(e)
# define INVALID_SOCKET -1
typedef int socket_type;
#endif
/* Defined by RFC 3493, used to store a generic address. Note that this
doesn't do the alignment mangling that RFC 3493 does; it's not clear if
that should be added.... */
#if !HAVE_STRUCT_SOCKADDR_STORAGE
# if HAVE_STRUCT_SOCKADDR_SA_LEN
struct sockaddr_storage {
unsigned char ss_len;
unsigned char ss_family;
unsigned char __padding[128 - 2];
};
# else
struct sockaddr_storage {
unsigned short ss_family;
unsigned char __padding[128 - 2];
};
# endif
#endif
/* Use convenient, non-uglified names for the fields since we use them quite a
bit in code. */
#if HAVE_STRUCT_SOCKADDR_STORAGE && !HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY
# define ss_family __ss_family
# define ss_len __ss_len
#endif
/* Fix IN6_ARE_ADDR_EQUAL if required. */
#ifdef HAVE_BROKEN_IN6_ARE_ADDR_EQUAL
# undef IN6_ARE_ADDR_EQUAL
# define IN6_ARE_ADDR_EQUAL(a, b) \
(memcmp((a), (b), sizeof(struct in6_addr)) == 0)
#endif
/* Define an SA_LEN macro that gives us the length of a sockaddr. */
#if !HAVE_SA_LEN
# if HAVE_STRUCT_SOCKADDR_SA_LEN
# define SA_LEN(s) ((s)->sa_len)
# else
/* Hack courtesy of the USAGI project. */
# if HAVE_INET6
# define SA_LEN(s) \
((((const struct sockaddr *)(s))->sa_family == AF_INET6) \
? sizeof(struct sockaddr_in6) \
: ((((const struct sockaddr *)(s))->sa_family == AF_INET) \
? sizeof(struct sockaddr_in) \
: sizeof(struct sockaddr)))
# else
# define SA_LEN(s) \
((((const struct sockaddr *)(s))->sa_family == AF_INET) \
? sizeof(struct sockaddr_in) \
: sizeof(struct sockaddr))
# endif
# endif /* HAVE_SOCKADDR_LEN */
#endif /* !HAVE_SA_LEN_MACRO */
/* Make sure we have access to h_errno and hstrerror to print out name
resolution error messages. */
#if !HAVE_DECL_H_ERRNO
extern int h_errno;
#endif
#if !HAVE_HSTRERROR
extern const char *hstrerror(int);
#endif
/* The netdb constants, which aren't always defined (particularly if h_errno
isn't declared. We also make sure that a few of the less-used ones are
defined so that we can deal with them in case statements. */
#ifndef NETDB_SUCCESS
# define NETDB_SUCCESS 0
#endif
#ifndef HOST_NOT_FOUND
# define HOST_NOT_FOUND 1
# define TRY_AGAIN 2
# define NO_RECOVERY 3
# define NO_DATA 4
#endif
#ifndef NETDB_INTERNAL
# define NETDB_INTERNAL -1
#endif
/* AI_ADDRCONFIG results in an error from getaddrinfo on BSD/OS and
possibly other platforms. If configure determined it didn't work,
pretend it doesn't exist. */
#if !defined(HAVE_GETADDRINFO_ADDRCONFIG) && defined(AI_ADDRCONFIG)
# undef AI_ADDRCONFIG
#endif
/* POSIX requires AI_ADDRCONFIG and AI_NUMERICSERV, but some implementations
don't have them yet. It's only used in a bitwise OR of flags, so defining
them to 0 makes them harmlessly go away. */
#ifndef AI_ADDRCONFIG
# define AI_ADDRCONFIG 0
#endif
#ifndef AI_NUMERICSERV
# define AI_NUMERICSERV 0
#endif
/* Constants required by the IPv6 API. The buffer size required to hold any
nul-terminated text representation of the given address type. */
#ifndef INET_ADDRSTRLEN
# define INET_ADDRSTRLEN 16
#endif
#ifndef INET6_ADDRSTRLEN
# define INET6_ADDRSTRLEN 46
#endif
/* This is one of the defined error codes from inet_ntop, but it may not be
available on systems too old to have that function. */
#ifndef EAFNOSUPPORT
# define EAFNOSUPPORT EDOM
#endif
/* EAI_ADDRFAMILY was made obsolete by RFC 3493, but it may still be
* used by obsolete IPv6 stacks. */
#ifndef EAI_ADDRFAMILY
# define EAI_ADDRFAMILY EAI_FAMILY
#endif
END_DECLS
#endif /* PORTABLE_SOCKET_H */
|
