[lttng-tools.git] / src / common / compat / socket.h

/*
 * Copyright (C) 2011 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _COMPAT_SOCKET_H
#define _COMPAT_SOCKET_H

#include <sys/socket.h>
#include <sys/un.h>

#include <common/macros.h>

#ifndef MSG_NOSIGNAL
# ifdef SO_NOSIGPIPE
#   define MSG_NOSIGNAL SO_NOSIGPIPE
# endif
#endif

#if defined(MSG_NOSIGNAL)
static inline
ssize_t lttng_recvmsg_nosigpipe(int sockfd, struct msghdr *msg)
{
	return recvmsg(sockfd, msg, MSG_NOSIGNAL);
}
#else

#include <signal.h>
#include <errno.h>

static inline
ssize_t lttng_recvmsg_nosigpipe(int sockfd, struct msghdr *msg)
{
	ssize_t received;
	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. */
	received = recvmsg(sockfd, msg, 0);
	saved_err = errno;

	if (received == -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 received;
}
#endif


#ifdef __linux__

#define LTTNG_SOCK_CREDS SCM_CREDENTIALS

typedef struct ucred lttng_sock_cred;

#define LTTNG_SOCK_SET_UID_CRED(c, u) LTTNG_REF(c)->uid = u
#define LTTNG_SOCK_SET_GID_CRED(c, g) LTTNG_REF(c)->gid = g
#define LTTNG_SOCK_SET_PID_CRED(c, p) LTTNG_REF(c)->pid = p

#define LTTNG_SOCK_GET_UID_CRED(c) LTTNG_REF(c)->uid
#define LTTNG_SOCK_GET_GID_CRED(c) LTTNG_REF(c)->gid
#define LTTNG_SOCK_GET_PID_CRED(c) LTTNG_REF(c)->pid

#elif (defined(__FreeBSD__) || defined(__CYGWIN__) || defined(__sun__) || defined(__APPLE__))

struct lttng_sock_cred {
	uid_t uid;
	gid_t gid;
};

typedef struct lttng_sock_cred lttng_sock_cred;

#define LTTNG_SOCK_SET_UID_CRED(c, u) LTTNG_REF(c)->uid = u
#define LTTNG_SOCK_SET_GID_CRED(c, g) LTTNG_REF(c)->gid = g
#define LTTNG_SOCK_SET_PID_CRED(c, p)

#define LTTNG_SOCK_GET_UID_CRED(c) LTTNG_REF(c)->uid
#define LTTNG_SOCK_GET_GID_CRED(c) LTTNG_REF(c)->gid
#define LTTNG_SOCK_GET_PID_CRED(c) -1

#else
#error "Please add support for your OS."
#endif /* __linux__ , __FreeBSD__ */


#ifdef __sun__

# ifndef CMSG_ALIGN
#  ifdef _CMSG_DATA_ALIGN
#   define CMSG_ALIGN(len) _CMSG_DATA_ALIGN(len)
#  else
    /* aligning to sizeof (long) is assumed to be portable (fd.o#40235) */
#   define CMSG_ALIGN(len) (((len) + sizeof (long) - 1) & ~(sizeof (long) - 1))
#  endif
#  ifndef CMSG_SPACE
#    define CMSG_SPACE(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + CMSG_ALIGN (len))
#  endif
#  ifndef CMSG_LEN
#    define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
#  endif
# endif


#include <ucred.h>

static inline
int getpeereid(int s, uid_t *euid, gid_t *gid)
{
	int ret = 0;
	ucred_t *ucred = NULL;

	ret = getpeerucred(s, &ucred);
	if (ret == -1) {
		goto end;
	}

	ret = ucred_geteuid(ucred);
	if (ret == -1) {
		goto free;
	}
	*euid = ret;

	ret = ucred_getrgid(ucred);
	if (ret == -1) {
		goto free;
	}
	*gid = ret;
	ret = 0;
free:
	ucred_free(ucred);
end:
	return ret;
}

#endif /* __sun__ */

#endif /* _COMPAT_SOCKET_H */
Commit	Line	Data
b17231c6	1	/*
ab5be9fa	2	* Copyright (C) 2011 David Goulet <dgoulet@efficios.com>
b17231c6	3	*
ab5be9fa	4	* SPDX-License-Identifier: GPL-2.0-only
b17231c6	5	*
b17231c6 DG	6	*/
	7
	8	#ifndef _COMPAT_SOCKET_H
	9	#define _COMPAT_SOCKET_H
	10
	11	#include <sys/socket.h>
	12	#include <sys/un.h>
	13
	14	#include <common/macros.h>
	15
fbb1fd3a MJ	16	#ifndef MSG_NOSIGNAL
	17	# ifdef SO_NOSIGPIPE
	18	# define MSG_NOSIGNAL SO_NOSIGPIPE
	19	# endif
	20	#endif
	21
	22	#if defined(MSG_NOSIGNAL)
	23	static inline
	24	ssize_t lttng_recvmsg_nosigpipe(int sockfd, struct msghdr *msg)
	25	{
	26	return recvmsg(sockfd, msg, MSG_NOSIGNAL);
	27	}
	28	#else
	29
	30	#include <signal.h>
	31	#include <errno.h>
	32
	33	static inline
	34	ssize_t lttng_recvmsg_nosigpipe(int sockfd, struct msghdr *msg)
	35	{
	36	ssize_t received;
	37	int saved_err;
	38	sigset_t sigpipe_set, pending_set, old_set;
	39	int sigpipe_was_pending;
	40
	41	/*
	42	* Discard the SIGPIPE from send(), not disturbing any SIGPIPE
	43	* that might be already pending. If a bogus SIGPIPE is sent to
	44	* the entire process concurrently by a malicious user, it may
	45	* be simply discarded.
	46	*/
	47	if (sigemptyset(&pending_set)) {
	48	return -1;
	49	}
	50	/*
	51	* sigpending returns the mask of signals that are _both_
	52	* blocked for the thread _and_ pending for either the thread or
	53	* the entire process.
	54	*/
	55	if (sigpending(&pending_set)) {
	56	return -1;
	57	}
	58	sigpipe_was_pending = sigismember(&pending_set, SIGPIPE);
	59	/*
	60	* If sigpipe was pending, it means it was already blocked, so
	61	* no need to block it.
	62	*/
	63	if (!sigpipe_was_pending) {
	64	if (sigemptyset(&sigpipe_set)) {
	65	return -1;
	66	}
	67	if (sigaddset(&sigpipe_set, SIGPIPE)) {
	68	return -1;
	69	}
	70	if (pthread_sigmask(SIG_BLOCK, &sigpipe_set, &old_set)) {
	71	return -1;
	72	}
	73	}
	74
	75	/* Send and save errno. */
	76	received = recvmsg(sockfd, msg, 0);
	77	saved_err = errno;
	78
	79	if (received == -1 && errno == EPIPE && !sigpipe_was_pending) {
80	struct timespec timeout = { 0, 0 };
81	int ret;
82
83	do {
84	ret = sigtimedwait(&sigpipe_set, NULL,
85	&timeout);
86	} while (ret == -1 && errno == EINTR);
87	}
88	if (!sigpipe_was_pending) {
89	if (pthread_sigmask(SIG_SETMASK, &old_set, NULL)) {
90	return -1;
91	}
92	}
93	/* Restore send() errno */
94	errno = saved_err;
95
96	return received;
97	}
98	#endif
99
100
b17231c6 DG	101	#ifdef __linux__
	102
	103	#define LTTNG_SOCK_CREDS SCM_CREDENTIALS
b17231c6 DG	104
	105	typedef struct ucred lttng_sock_cred;
	106
1268b9d6 DG	107	#define LTTNG_SOCK_SET_UID_CRED(c, u) LTTNG_REF(c)->uid = u
	108	#define LTTNG_SOCK_SET_GID_CRED(c, g) LTTNG_REF(c)->gid = g
	109	#define LTTNG_SOCK_SET_PID_CRED(c, p) LTTNG_REF(c)->pid = p
	110
	111	#define LTTNG_SOCK_GET_UID_CRED(c) LTTNG_REF(c)->uid
	112	#define LTTNG_SOCK_GET_GID_CRED(c) LTTNG_REF(c)->gid
	113	#define LTTNG_SOCK_GET_PID_CRED(c) LTTNG_REF(c)->pid
b17231c6	114
d05d6fe1	115	#elif (defined(__FreeBSD__) \|\| defined(__CYGWIN__) \|\| defined(__sun__) \|\| defined(__APPLE__))
b17231c6	116
d27c42b8 MD	117	struct lttng_sock_cred {
	118	uid_t uid;
	119	gid_t gid;
	120	};
b17231c6	121
d27c42b8	122	typedef struct lttng_sock_cred lttng_sock_cred;
b17231c6	123
de559cf1 MJ	124	#define LTTNG_SOCK_SET_UID_CRED(c, u) LTTNG_REF(c)->uid = u
	125	#define LTTNG_SOCK_SET_GID_CRED(c, g) LTTNG_REF(c)->gid = g
	126	#define LTTNG_SOCK_SET_PID_CRED(c, p)
	127
d27c42b8 MD	128	#define LTTNG_SOCK_GET_UID_CRED(c) LTTNG_REF(c)->uid
	129	#define LTTNG_SOCK_GET_GID_CRED(c) LTTNG_REF(c)->gid
	130	#define LTTNG_SOCK_GET_PID_CRED(c) -1
b17231c6 DG	131
b17231c6 DG	132	#else
7657ae75	133	#error "Please add support for your OS."
b17231c6 DG	134	#endif /* __linux__ , __FreeBSD__ */
b17231c6 DG	135
28105b32 MJ	136
	137	#ifdef __sun__
	138
	139	# ifndef CMSG_ALIGN
	140	# ifdef _CMSG_DATA_ALIGN
	141	# define CMSG_ALIGN(len) _CMSG_DATA_ALIGN(len)
	142	# else
	143	/* aligning to sizeof (long) is assumed to be portable (fd.o#40235) */
	144	# define CMSG_ALIGN(len) (((len) + sizeof (long) - 1) & ~(sizeof (long) - 1))
	145	# endif
	146	# ifndef CMSG_SPACE
	147	# define CMSG_SPACE(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + CMSG_ALIGN (len))
	148	# endif
	149	# ifndef CMSG_LEN
	150	# define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
	151	# endif
	152	# endif
	153
	154
	155	#include <ucred.h>
11a2fd46 MJ	156
	157	static inline
	158	int getpeereid(int s, uid_t euid, gid_t gid)
28105b32 MJ	159	{
	160	int ret = 0;
	161	ucred_t *ucred = NULL;
	162
	163	ret = getpeerucred(s, &ucred);
	164	if (ret == -1) {
	165	goto end;
	166	}
	167
	168	ret = ucred_geteuid(ucred);
	169	if (ret == -1) {
	170	goto free;
	171	}
	172	*euid = ret;
	173
	174	ret = ucred_getrgid(ucred);
	175	if (ret == -1) {
	176	goto free;
	177	}
	178	*gid = ret;
	179	ret = 0;
	180	free:
	181	ucred_free(ucred);
	182	end:
	183	return ret;
	184	}
	185
	186	#endif /* __sun__ */
	187
b17231c6	188	#endif /* _COMPAT_SOCKET_H */