[babeltrace.git] / src / compat / socket.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2015-2017 Michael Jeanson <mjeanson@efficios.com>
 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#ifndef _BABELTRACE_COMPAT_SOCKET_H
#define _BABELTRACE_COMPAT_SOCKET_H

#include <stdbool.h>

#ifdef __MINGW32__

#include <winsock2.h>

#define BT_INVALID_SOCKET INVALID_SOCKET
#define BT_SOCKET_ERROR SOCKET_ERROR
#define BT_SOCKET SOCKET

static inline
int bt_socket_init(int log_level)
{
	WORD verreq;
	WSADATA wsa;
	int ret;

	/* Request winsock 2.2 support */
	verreq = MAKEWORD(2, 2);

	ret = WSAStartup(verreq, &wsa);
	if (ret != 0) {
#ifdef BT_LOG_WRITE_CUR_LVL
		BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
				"Winsock init failed with error: %d", ret);
#endif
		goto end;
	}

	if (LOBYTE(wsa.wVersion) != 2 || HIBYTE(wsa.wVersion) != 2) {
#ifdef BT_LOG_WRITE_CUR_LVL
		BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
				"Could not init winsock 2.2 support");
#endif
		WSACleanup();
		ret = -1;
	}

end:
	return ret;
}

static inline
int bt_socket_fini(void)
{
	return WSACleanup();
}

static inline
int bt_socket_send(int sockfd, const void *buf, size_t len, int flags)
{
	return send(sockfd, buf, len, flags);
}

static inline
int bt_socket_recv(int sockfd, void *buf, size_t len, int flags)
{
	return recv(sockfd, buf, len, flags);
}

static inline
int bt_socket_close(int fd)
{
	return closesocket(fd);
}

static inline
bool bt_socket_interrupted(void)
{
	/* There is no equivalent to EINTR in winsock 2.2 */
	return false;
}

static inline
const char *bt_socket_errormsg(void)
{
	const char *errstr;
	int error = WSAGetLastError();

	switch (error) {
	case WSAEINTR:
		errstr = "Call interrupted";
		break;
	case WSAEBADF:
		errstr = "Bad file";
		break;
	case WSAEACCES:
		errstr = "Bad access";
		break;
	case WSAEFAULT:
		errstr = "Bad argument";
		break;
	case WSAEINVAL:
		errstr = "Invalid arguments";
		break;
	case WSAEMFILE:
		errstr = "Out of file descriptors";
		break;
	case WSAEWOULDBLOCK:
		errstr = "Call would block";
		break;
	case WSAEINPROGRESS:
	case WSAEALREADY:
		errstr = "Blocking call in progress";
		break;
	case WSAENOTSOCK:
		errstr = "Descriptor is not a socket";
		break;
	case WSAEDESTADDRREQ:
		errstr = "Need destination address";
		break;
	case WSAEMSGSIZE:
		errstr = "Bad message size";
		break;
	case WSAEPROTOTYPE:
		errstr = "Bad protocol";
		break;
	case WSAENOPROTOOPT:
		errstr = "Protocol option is unsupported";
		break;
	case WSAEPROTONOSUPPORT:
		errstr = "Protocol is unsupported";
		break;
	case WSAESOCKTNOSUPPORT:
		errstr = "Socket is unsupported";
		break;
	case WSAEOPNOTSUPP:
		errstr = "Operation not supported";
		break;
	case WSAEAFNOSUPPORT:
		errstr = "Address family not supported";
		break;
	case WSAEPFNOSUPPORT:
		errstr = "Protocol family not supported";
		break;
	case WSAEADDRINUSE:
		errstr = "Address already in use";
		break;
	case WSAEADDRNOTAVAIL:
		errstr = "Address not available";
		break;
	case WSAENETDOWN:
		errstr = "Network down";
		break;
	case WSAENETUNREACH:
		errstr = "Network unreachable";
		break;
	case WSAENETRESET:
		errstr = "Network has been reset";
		break;
	case WSAECONNABORTED:
		errstr = "Connection was aborted";
		break;
	case WSAECONNRESET:
		errstr = "Connection was reset";
		break;
	case WSAENOBUFS:
		errstr = "No buffer space";
		break;
	case WSAEISCONN:
		errstr = "Socket is already connected";
		break;
	case WSAENOTCONN:
		errstr = "Socket is not connected";
		break;
	case WSAESHUTDOWN:
		errstr = "Socket has been shut down";
		break;
	case WSAETOOMANYREFS:
		errstr = "Too many references";
		break;
	case WSAETIMEDOUT:
		errstr = "Timed out";
		break;
	case WSAECONNREFUSED:
		errstr = "Connection refused";
		break;
	case WSAELOOP:
		errstr = "Loop??";
		break;
	case WSAENAMETOOLONG:
		errstr = "Name too long";
		break;
	case WSAEHOSTDOWN:
		errstr = "Host down";
		break;
	case WSAEHOSTUNREACH:
		errstr = "Host unreachable";
		break;
	case WSAENOTEMPTY:
		errstr = "Not empty";
		break;
	case WSAEPROCLIM:
		errstr = "Process limit reached";
		break;
	case WSAEUSERS:
		errstr = "Too many users";
		break;
	case WSAEDQUOT:
		errstr = "Bad quota";
		break;
	case WSAESTALE:
		errstr = "Something is stale";
		break;
	case WSAEREMOTE:
		errstr = "Remote error";
		break;
	case WSAEDISCON:
		errstr = "Disconnected";
		break;

	/* Extended Winsock errors */
	case WSASYSNOTREADY:
		errstr = "Winsock library is not ready";
		break;
	case WSANOTINITIALISED:
		errstr = "Winsock library not initialised";
		break;
	case WSAVERNOTSUPPORTED:
		errstr = "Winsock version not supported";
		break;

	/* getXbyY() errors (already handled in herrmsg):
	 * Authoritative Answer: Host not found */
	case WSAHOST_NOT_FOUND:
		errstr = "Host not found";
		break;

	/* Non-Authoritative: Host not found, or SERVERFAIL */
	case WSATRY_AGAIN:
		errstr = "Host not found, try again";
		break;

	/* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
	case WSANO_RECOVERY:
		errstr = "Unrecoverable error in call to nameserver";
		break;

	/* Valid name, no data record of requested type */
	case WSANO_DATA:
		errstr = "No data record of requested type";
		break;

	default:
		errstr = "Unknown error";
	}

	return errstr;
}

#else /* __MINGW32__ */

#include <errno.h>
#include <netdb.h>
#include <netinet/in.h>
#include <sys/socket.h>
#include <unistd.h>

#include <glib.h>

#define BT_INVALID_SOCKET -1
#define BT_SOCKET_ERROR -1
#define BT_SOCKET int

static inline
int bt_socket_init(int log_level)
{
	return 0;
}

static inline
int bt_socket_fini(void)
{
	return 0;
}

static inline
int bt_socket_send(int sockfd, const void *buf, size_t len, int flags)
{
	return send(sockfd, buf, len, flags);
}

static inline
int bt_socket_recv(int sockfd, void *buf, size_t len, int flags)
{
	return recv(sockfd, buf, len, flags);
}

static inline
int bt_socket_close(int fd)
{
	return close(fd);
}

static inline
bool bt_socket_interrupted(void)
{
	return (errno == EINTR);
}

static inline
const char *bt_socket_errormsg(void)
{
	return g_strerror(errno);
}
#endif


/*
 * This wrapper is used on platforms that have no way of ignoring SIGPIPE
 * during a send().
 */

#ifndef MSG_NOSIGNAL
# ifdef SO_NOSIGPIPE
#   define MSG_NOSIGNAL SO_NOSIGPIPE
# elif defined(__MINGW32__)
#   define MSG_NOSIGNAL 0
# endif
#endif

#if defined(MSG_NOSIGNAL)
static inline
ssize_t bt_socket_send_nosigpipe(int fd, const void *buffer, size_t size)
{
	return bt_socket_send(fd, buffer, size, MSG_NOSIGNAL);
}
#else

#include <signal.h>

static inline
ssize_t bt_socket_send_nosigpipe(int fd, const void *buffer, size_t size)
{
	ssize_t sent;
	int saved_err;
	sigset_t sigpipe_set, pending_set, old_set;
	int sigpipe_was_pending;

	/*
	 * Discard the SIGPIPE from send(), not disturbing any SIGPIPE
	 * that might be already pending. If a bogus SIGPIPE is sent to
	 * the entire process concurrently by a malicious user, it may
	 * be simply discarded.
	 */
	if (sigemptyset(&pending_set)) {
		return -1;
	}
	/*
	 * sigpending returns the mask of signals that are _both_
	 * blocked for the thread _and_ pending for either the thread or
	 * the entire process.
	 */
	if (sigpending(&pending_set)) {
		return -1;
	}
	sigpipe_was_pending = sigismember(&pending_set, SIGPIPE);
	/*
	 * If sigpipe was pending, it means it was already blocked, so
	 * no need to block it.
	 */
	if (!sigpipe_was_pending) {
		if (sigemptyset(&sigpipe_set)) {
			return -1;
		}
		if (sigaddset(&sigpipe_set, SIGPIPE)) {
			return -1;
		}
		if (pthread_sigmask(SIG_BLOCK, &sigpipe_set, &old_set)) {
			return -1;
		}
	}

	/* Send and save errno. */
	sent = bt_socket_send(fd, buffer, size, 0);
	saved_err = errno;

	if (sent == -1 && errno == EPIPE && !sigpipe_was_pending) {
		struct timespec timeout = { 0, 0 };
		int ret;

		do {
			ret = sigtimedwait(&sigpipe_set, NULL,
				&timeout);
		} while (ret == -1 && errno == EINTR);
	}
	if (!sigpipe_was_pending) {
		if (pthread_sigmask(SIG_SETMASK, &old_set, NULL)) {
			return -1;
		}
	}
	/* Restore send() errno */
	errno = saved_err;

	return sent;
}
#endif


#endif /* _BABELTRACE_COMPAT_SOCKET_H */
Commit	Line	Data
1cb3cdd7	1	/*
0235b0db	2	* SPDX-License-Identifier: MIT
1cb3cdd7	3	*
0235b0db MJ	4	* Copyright (C) 2015-2017 Michael Jeanson <mjeanson@efficios.com>
0235b0db MJ	5	* Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
1cb3cdd7 MJ	6	*/
1cb3cdd7 MJ	7
0235b0db MJ	8	#ifndef _BABELTRACE_COMPAT_SOCKET_H
	9	#define _BABELTRACE_COMPAT_SOCKET_H
	10
c4f23e30 FD	11	#include <stdbool.h>
c4f23e30 FD	12
1cb3cdd7 MJ	13	#ifdef __MINGW32__
	14
	15	#include <winsock2.h>
	16
	17	#define BT_INVALID_SOCKET INVALID_SOCKET
	18	#define BT_SOCKET_ERROR SOCKET_ERROR
	19	#define BT_SOCKET SOCKET
	20
	21	static inline
95c324a4	22	int bt_socket_init(int log_level)
1cb3cdd7 MJ	23	{
	24	WORD verreq;
	25	WSADATA wsa;
	26	int ret;
	27
	28	/* Request winsock 2.2 support */
	29	verreq = MAKEWORD(2, 2);
	30
	31	ret = WSAStartup(verreq, &wsa);
	32	if (ret != 0) {
95c324a4 JR	33	#ifdef BT_LOG_WRITE_CUR_LVL
	34	BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
	35	"Winsock init failed with error: %d", ret);
f571b963	36	#endif
1cb3cdd7 MJ	37	goto end;
	38	}
	39
	40	if (LOBYTE(wsa.wVersion) != 2 \|\| HIBYTE(wsa.wVersion) != 2) {
95c324a4 JR	41	#ifdef BT_LOG_WRITE_CUR_LVL
	42	BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
	43	"Could not init winsock 2.2 support");
f571b963	44	#endif
1cb3cdd7 MJ	45	WSACleanup();
	46	ret = -1;
	47	}
	48
	49	end:
	50	return ret;
	51	}
	52
	53	static inline
	54	int bt_socket_fini(void)
	55	{
	56	return WSACleanup();
	57	}
	58
	59	static inline
	60	int bt_socket_send(int sockfd, const void *buf, size_t len, int flags)
	61	{
	62	return send(sockfd, buf, len, flags);
	63	}
	64
	65	static inline
	66	int bt_socket_recv(int sockfd, void *buf, size_t len, int flags)
	67	{
	68	return recv(sockfd, buf, len, flags);
	69	}
	70
	71	static inline
	72	int bt_socket_close(int fd)
	73	{
	74	return closesocket(fd);
	75	}
	76
	77	static inline
	78	bool bt_socket_interrupted(void)
	79	{
	80	/* There is no equivalent to EINTR in winsock 2.2 */
	81	return false;
	82	}
	83
	84	static inline
	85	const char *bt_socket_errormsg(void)
	86	{
	87	const char *errstr;
	88	int error = WSAGetLastError();
	89
	90	switch (error) {
	91	case WSAEINTR:
	92	errstr = "Call interrupted";
	93	break;
	94	case WSAEBADF:
	95	errstr = "Bad file";
	96	break;
	97	case WSAEACCES:
	98	errstr = "Bad access";
	99	break;
	100	case WSAEFAULT:
	101	errstr = "Bad argument";
	102	break;
	103	case WSAEINVAL:
	104	errstr = "Invalid arguments";
	105	break;
	106	case WSAEMFILE:
	107	errstr = "Out of file descriptors";
	108	break;
109	case WSAEWOULDBLOCK:
110	errstr = "Call would block";
111	break;
112	case WSAEINPROGRESS:
113	case WSAEALREADY:
114	errstr = "Blocking call in progress";
115	break;
116	case WSAENOTSOCK:
117	errstr = "Descriptor is not a socket";
118	break;
119	case WSAEDESTADDRREQ:
120	errstr = "Need destination address";
121	break;
122	case WSAEMSGSIZE:
123	errstr = "Bad message size";
124	break;
125	case WSAEPROTOTYPE:
126	errstr = "Bad protocol";
127	break;
128	case WSAENOPROTOOPT:
129	errstr = "Protocol option is unsupported";
130	break;
131	case WSAEPROTONOSUPPORT:
132	errstr = "Protocol is unsupported";
133	break;
134	case WSAESOCKTNOSUPPORT:
135	errstr = "Socket is unsupported";
136	break;
137	case WSAEOPNOTSUPP:
138	errstr = "Operation not supported";
139	break;
140	case WSAEAFNOSUPPORT:
141	errstr = "Address family not supported";
142	break;
143	case WSAEPFNOSUPPORT:
144	errstr = "Protocol family not supported";
145	break;
146	case WSAEADDRINUSE:
147	errstr = "Address already in use";
148	break;
149	case WSAEADDRNOTAVAIL:
150	errstr = "Address not available";
151	break;
152	case WSAENETDOWN:
153	errstr = "Network down";
154	break;
155	case WSAENETUNREACH:
156	errstr = "Network unreachable";
157	break;
158	case WSAENETRESET:
159	errstr = "Network has been reset";
160	break;
161	case WSAECONNABORTED:
162	errstr = "Connection was aborted";
163	break;
164	case WSAECONNRESET:
165	errstr = "Connection was reset";
166	break;
167	case WSAENOBUFS:
168	errstr = "No buffer space";
169	break;
170	case WSAEISCONN:
171	errstr = "Socket is already connected";
172	break;
173	case WSAENOTCONN:
174	errstr = "Socket is not connected";
175	break;
176	case WSAESHUTDOWN:
177	errstr = "Socket has been shut down";
178	break;
179	case WSAETOOMANYREFS:
180	errstr = "Too many references";
181	break;
182	case WSAETIMEDOUT:
183	errstr = "Timed out";
184	break;
185	case WSAECONNREFUSED:
186	errstr = "Connection refused";
187	break;
188	case WSAELOOP:
189	errstr = "Loop??";
190	break;
191	case WSAENAMETOOLONG:
192	errstr = "Name too long";
193	break;
194	case WSAEHOSTDOWN:
195	errstr = "Host down";
196	break;
197	case WSAEHOSTUNREACH:
198	errstr = "Host unreachable";
199	break;
200	case WSAENOTEMPTY:
201	errstr = "Not empty";
202	break;
203	case WSAEPROCLIM:
204	errstr = "Process limit reached";
205	break;
206	case WSAEUSERS:
207	errstr = "Too many users";
208	break;
209	case WSAEDQUOT:
210	errstr = "Bad quota";
211	break;
212	case WSAESTALE:
213	errstr = "Something is stale";
214	break;
215	case WSAEREMOTE:
216	errstr = "Remote error";
217	break;
218	case WSAEDISCON:
219	errstr = "Disconnected";
220	break;
221
222	/* Extended Winsock errors */
223	case WSASYSNOTREADY:
224	errstr = "Winsock library is not ready";
225	break;
226	case WSANOTINITIALISED:
227	errstr = "Winsock library not initialised";
228	break;
229	case WSAVERNOTSUPPORTED:
230	errstr = "Winsock version not supported";
231	break;
232
233	/* getXbyY() errors (already handled in herrmsg):
234	* Authoritative Answer: Host not found */
235	case WSAHOST_NOT_FOUND:
236	errstr = "Host not found";
237	break;
238
239	/* Non-Authoritative: Host not found, or SERVERFAIL */
240	case WSATRY_AGAIN:
241	errstr = "Host not found, try again";
242	break;
243
244	/* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
245	case WSANO_RECOVERY:
246	errstr = "Unrecoverable error in call to nameserver";
247	break;
248
249	/* Valid name, no data record of requested type */
250	case WSANO_DATA:
251	errstr = "No data record of requested type";
252	break;
253
254	default:
255	errstr = "Unknown error";
256	}
257
258	return errstr;
259	}
260
261	#else /* __MINGW32__ */
262
c4f23e30	263	#include <errno.h>
1cb3cdd7	264	#include <netdb.h>
c4f23e30 FD	265	#include <netinet/in.h>
	266	#include <sys/socket.h>
	267	#include <unistd.h>
	268
	269	#include <glib.h>
1cb3cdd7 MJ	270
	271	#define BT_INVALID_SOCKET -1
	272	#define BT_SOCKET_ERROR -1
	273	#define BT_SOCKET int
	274
	275	static inline
95c324a4	276	int bt_socket_init(int log_level)
1cb3cdd7 MJ	277	{
	278	return 0;
	279	}
	280
	281	static inline
	282	int bt_socket_fini(void)
	283	{
	284	return 0;
	285	}
	286
	287	static inline
	288	int bt_socket_send(int sockfd, const void *buf, size_t len, int flags)
	289	{
	290	return send(sockfd, buf, len, flags);
	291	}
	292
	293	static inline
	294	int bt_socket_recv(int sockfd, void *buf, size_t len, int flags)
	295	{
	296	return recv(sockfd, buf, len, flags);
	297	}
	298
	299	static inline
	300	int bt_socket_close(int fd)
	301	{
	302	return close(fd);
	303	}
	304
	305	static inline
	306	bool bt_socket_interrupted(void)
	307	{
	308	return (errno == EINTR);
	309	}
	310
	311	static inline
	312	const char *bt_socket_errormsg(void)
	313	{
	314	return g_strerror(errno);
	315	}
	316	#endif
	317
	318
	319	/*
	320	* This wrapper is used on platforms that have no way of ignoring SIGPIPE
	321	* during a send().
	322	*/
	323
	324	#ifndef MSG_NOSIGNAL
	325	# ifdef SO_NOSIGPIPE
	326	# define MSG_NOSIGNAL SO_NOSIGPIPE
	327	# elif defined(__MINGW32__)
	328	# define MSG_NOSIGNAL 0
	329	# endif
	330	#endif
	331
	332	#if defined(MSG_NOSIGNAL)
	333	static inline
	334	ssize_t bt_socket_send_nosigpipe(int fd, const void *buffer, size_t size)
	335	{
	336	return bt_socket_send(fd, buffer, size, MSG_NOSIGNAL);
	337	}
	338	#else
	339
	340	#include <signal.h>
341
342	static inline
343	ssize_t bt_socket_send_nosigpipe(int fd, const void *buffer, size_t size)
344	{
345	ssize_t sent;
346	int saved_err;
347	sigset_t sigpipe_set, pending_set, old_set;
348	int sigpipe_was_pending;
349
350	/*
351	* Discard the SIGPIPE from send(), not disturbing any SIGPIPE
352	* that might be already pending. If a bogus SIGPIPE is sent to
353	* the entire process concurrently by a malicious user, it may
354	* be simply discarded.
355	*/
356	if (sigemptyset(&pending_set)) {
357	return -1;
358	}
359	/*
360	* sigpending returns the mask of signals that are _both_
361	* blocked for the thread _and_ pending for either the thread or
362	* the entire process.
363	*/
364	if (sigpending(&pending_set)) {
365	return -1;
366	}
367	sigpipe_was_pending = sigismember(&pending_set, SIGPIPE);
368	/*
369	* If sigpipe was pending, it means it was already blocked, so
370	* no need to block it.
371	*/
372	if (!sigpipe_was_pending) {
373	if (sigemptyset(&sigpipe_set)) {
374	return -1;
375	}
376	if (sigaddset(&sigpipe_set, SIGPIPE)) {
377	return -1;
378	}
379	if (pthread_sigmask(SIG_BLOCK, &sigpipe_set, &old_set)) {
380	return -1;
381	}
382	}
383
384	/* Send and save errno. */
385	sent = bt_socket_send(fd, buffer, size, 0);
386	saved_err = errno;
387
388	if (sent == -1 && errno == EPIPE && !sigpipe_was_pending) {
389	struct timespec timeout = { 0, 0 };
390	int ret;
391
392	do {
393	ret = sigtimedwait(&sigpipe_set, NULL,
394	&timeout);
395	} while (ret == -1 && errno == EINTR);
396	}
397	if (!sigpipe_was_pending) {
398	if (pthread_sigmask(SIG_SETMASK, &old_set, NULL)) {
399	return -1;
400	}
401	}
402	/* Restore send() errno */
403	errno = saved_err;
404
405	return sent;
406	}
407	#endif
408
409
410	#endif /* _BABELTRACE_COMPAT_SOCKET_H */