[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.c

/*
 * Copyright (C) 2011 EfficiOS Inc.
 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#include <sys/socket.h>
#define _LGPL_SOURCE
#include <assert.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <inttypes.h>

#include <common/common.h>
#include <common/compat/errno.h>

#include "sessiond-comm.h"

/* For Unix socket */
#include <common/unix.h>
/* For Inet socket */
#include "inet.h"
/* For Inet6 socket */
#include "inet6.h"

#define NETWORK_TIMEOUT_ENV	"LTTNG_NETWORK_SOCKET_TIMEOUT"

static struct lttcomm_net_family net_families[] = {
	{ LTTCOMM_INET, lttcomm_create_inet_sock },
	{ LTTCOMM_INET6, lttcomm_create_inet6_sock },
};

/*
 * Human readable error message.
 */
static const char *lttcomm_readable_code[] = {
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_COMMAND_SOCK_READY) ] = "consumerd command socket ready",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SUCCESS_RECV_FD) ] = "consumerd success on receiving fds",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_RECV_FD) ] = "consumerd error on receiving fds",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_RECV_CMD) ] = "consumerd error on receiving command",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_ERROR) ] = "consumerd error in polling thread",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_NVAL) ] = "consumerd polling on closed fd",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_HUP) ] = "consumerd all fd hung up",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_EXIT_SUCCESS) ] = "consumerd exiting normally",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_EXIT_FAILURE) ] = "consumerd exiting on error",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_OUTFD_ERROR) ] = "consumerd error opening the tracefile",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_EBADF) ] = "consumerd splice EBADF",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_EINVAL) ] = "consumerd splice EINVAL",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_ENOMEM) ] = "consumerd splice ENOMEM",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_ESPIPE) ] = "consumerd splice ESPIPE",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ENOMEM) ] = "Consumer is out of memory",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_METADATA) ] = "Error with metadata",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_FATAL) ] = "Fatal error",
	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_RELAYD_FAIL) ] = "Error on remote relayd",

	/* Last element */
	[ LTTCOMM_ERR_INDEX(LTTCOMM_NR) ] = "Unknown error code"
};

static unsigned long network_timeout;

/*
 * Return ptr to string representing a human readable error code from the
 * lttcomm_return_code enum.
 *
 * These code MUST be negative in other to treat that as an error value.
 */
LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
{
	code = -code;

	if (code < LTTCOMM_CONSUMERD_COMMAND_SOCK_READY || code > LTTCOMM_NR) {
		code = LTTCOMM_NR;
	}

	return lttcomm_readable_code[LTTCOMM_ERR_INDEX(code)];
}

/*
 * Create socket from an already allocated lttcomm socket structure and init
 * sockaddr in the lttcomm sock.
 */
LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock *sock)
{
	int ret, _sock_type, _sock_proto, domain;

	assert(sock);

	domain = sock->sockaddr.type;
	if (domain != LTTCOMM_INET && domain != LTTCOMM_INET6) {
		ERR("Create socket of unknown domain %d", domain);
		ret = -1;
		goto error;
	}

	switch (sock->proto) {
	case LTTCOMM_SOCK_UDP:
		_sock_type = SOCK_DGRAM;
		_sock_proto = IPPROTO_UDP;
		break;
	case LTTCOMM_SOCK_TCP:
		_sock_type = SOCK_STREAM;
		_sock_proto = IPPROTO_TCP;
		break;
	default:
		ret = -1;
		goto error;
	}

	ret = net_families[domain].create(sock, _sock_type, _sock_proto);
	if (ret < 0) {
		goto error;
	}

error:
	return ret;
}

/*
 * Return allocated lttcomm socket structure.
 */
LTTNG_HIDDEN
struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto)
{
	struct lttcomm_sock *sock;

	sock = zmalloc(sizeof(struct lttcomm_sock));
	if (sock == NULL) {
		PERROR("zmalloc create sock");
		goto end;
	}

	sock->proto = proto;
	sock->fd = -1;

end:
	return sock;
}

/*
 * Return an allocated lttcomm socket structure and copy src content into
 * the newly created socket.
 *
 * This is mostly useful when lttcomm_sock are passed between process where the
 * fd and ops have to be changed within the correct address space.
 */
LTTNG_HIDDEN
struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src)
{
	struct lttcomm_sock *sock;

	/* Safety net */
	assert(src);

	sock = lttcomm_alloc_sock(src->proto);
	if (sock == NULL) {
		goto alloc_error;
	}

	lttcomm_copy_sock(sock, src);

alloc_error:
	return sock;
}

/*
 * Create and copy socket from an allocated lttcomm socket structure.
 *
 * This is mostly useful when lttcomm_sock are passed between process where the
 * fd and ops have to be changed within the correct address space.
 */
LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock *dst, struct lttcomm_sock *src)
{
	/* Safety net */
	assert(dst);
	assert(src);

	dst->proto = src->proto;
	dst->fd = src->fd;
	dst->ops = src->ops;
	/* Copy sockaddr information from original socket */
	memcpy(&dst->sockaddr, &src->sockaddr, sizeof(dst->sockaddr));
}

/*
 * Init IPv4 sockaddr structure.
 */
LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
		const char *ip, unsigned int port)
{
	int ret;

	assert(sockaddr);
	assert(ip);
	assert(port > 0 && port <= 65535);

	memset(sockaddr, 0, sizeof(struct lttcomm_sockaddr));

	sockaddr->type = LTTCOMM_INET;
	sockaddr->addr.sin.sin_family = AF_INET;
	sockaddr->addr.sin.sin_port = htons(port);
	ret = inet_pton(sockaddr->addr.sin.sin_family, ip,
			&sockaddr->addr.sin.sin_addr);
	if (ret < 1) {
		ret = -1;
		ERR("%s with port %d: unrecognized IPv4 address", ip, port);
		goto error;
	}
	memset(sockaddr->addr.sin.sin_zero, 0, sizeof(sockaddr->addr.sin.sin_zero));

error:
	return ret;
}

/*
 * Init IPv6 sockaddr structure.
 */
LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
		const char *ip, unsigned int port)
{
	int ret;

	assert(sockaddr);
	assert(ip);
	assert(port > 0 && port <= 65535);

	memset(sockaddr, 0, sizeof(struct lttcomm_sockaddr));

	sockaddr->type = LTTCOMM_INET6;
	sockaddr->addr.sin6.sin6_family = AF_INET6;
	sockaddr->addr.sin6.sin6_port = htons(port);
	ret = inet_pton(sockaddr->addr.sin6.sin6_family, ip,
			&sockaddr->addr.sin6.sin6_addr);
	if (ret < 1) {
		ret = -1;
		goto error;
	}

error:
	return ret;
}

/*
 * Return allocated lttcomm socket structure from lttng URI.
 */
LTTNG_HIDDEN
struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri)
{
	int ret;
	int _sock_proto;
	struct lttcomm_sock *sock = NULL;

	/* Safety net */
	assert(uri);

	/* Check URI protocol */
	if (uri->proto == LTTNG_TCP) {
		_sock_proto = LTTCOMM_SOCK_TCP;
	} else {
		ERR("Relayd invalid URI proto: %d", uri->proto);
		goto alloc_error;
	}

	sock = lttcomm_alloc_sock(_sock_proto);
	if (sock == NULL) {
		goto alloc_error;
	}

	/* Check destination type */
	if (uri->dtype == LTTNG_DST_IPV4) {
		ret = lttcomm_init_inet_sockaddr(&sock->sockaddr, uri->dst.ipv4,
				uri->port);
		if (ret < 0) {
			goto error;
		}
	} else if (uri->dtype == LTTNG_DST_IPV6) {
		ret = lttcomm_init_inet6_sockaddr(&sock->sockaddr, uri->dst.ipv6,
				uri->port);
		if (ret < 0) {
			goto error;
		}
	} else {
		/* Command URI is invalid */
		ERR("Relayd invalid URI dst type: %d", uri->dtype);
		goto error;
	}

	return sock;

error:
	lttcomm_destroy_sock(sock);
alloc_error:
	return NULL;
}

/*
 * Destroy and free lttcomm socket.
 */
LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock *sock)
{
	free(sock);
}

/*
 * Allocate and return a relayd socket object using a given URI to initialize
 * it and the major/minor version of the supported protocol.
 *
 * On error, NULL is returned.
 */
LTTNG_HIDDEN
struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(struct lttng_uri *uri,
		uint32_t major, uint32_t minor)
{
	int ret;
	struct lttcomm_sock *tmp_sock = NULL;
	struct lttcomm_relayd_sock *rsock = NULL;

	assert(uri);

	rsock = zmalloc(sizeof(*rsock));
	if (!rsock) {
		PERROR("zmalloc relayd sock");
		goto error;
	}

	/* Allocate socket object from URI */
	tmp_sock = lttcomm_alloc_sock_from_uri(uri);
	if (tmp_sock == NULL) {
		goto error_free;
	}

	/*
	 * Create socket object which basically sets the ops according to the
	 * socket protocol.
	 */
	lttcomm_copy_sock(&rsock->sock, tmp_sock);
	/* Temporary socket pointer not needed anymore. */
	lttcomm_destroy_sock(tmp_sock);
	ret = lttcomm_create_sock(&rsock->sock);
	if (ret < 0) {
		goto error_free;
	}

	rsock->major = major;
	rsock->minor = minor;

	return rsock;

error_free:
	free(rsock);
error:
	return NULL;
}

/*
 * Set socket receiving timeout.
 */
LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec)
{
	int ret;
	struct timeval tv;

	tv.tv_sec = msec / 1000;
	tv.tv_usec = (msec % 1000) * 1000;

	ret = setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
	if (ret < 0) {
		PERROR("setsockopt SO_RCVTIMEO");
	}

	return ret;
}

/*
 * Set socket sending timeout.
 */
LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec)
{
	int ret;
	struct timeval tv;

	tv.tv_sec = msec / 1000;
	tv.tv_usec = (msec % 1000) * 1000;

	ret = setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
	if (ret < 0) {
		PERROR("setsockopt SO_SNDTIMEO");
	}

	return ret;
}

LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock *sock, uint16_t *port)
{
	assert(sock);
	assert(port);
	assert(sock->sockaddr.type == LTTCOMM_INET ||
			sock->sockaddr.type == LTTCOMM_INET6);
	assert(sock->proto == LTTCOMM_SOCK_TCP ||
			sock->proto == LTTCOMM_SOCK_UDP);

	switch (sock->sockaddr.type) {
	case LTTCOMM_INET:
		*port = ntohs(sock->sockaddr.addr.sin.sin_port);
		break;
	case LTTCOMM_INET6:
		*port = ntohs(sock->sockaddr.addr.sin6.sin6_port);
		break;
	default:
		abort();
	}

	return 0;
}

LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port)
{
	assert(sock);
	assert(sock->sockaddr.type == LTTCOMM_INET ||
			sock->sockaddr.type == LTTCOMM_INET6);
	assert(sock->proto == LTTCOMM_SOCK_TCP ||
			sock->proto == LTTCOMM_SOCK_UDP);

	switch (sock->sockaddr.type) {
	case LTTCOMM_INET:
		sock->sockaddr.addr.sin.sin_port = htons(port);
		break;
	case LTTCOMM_INET6:
		sock->sockaddr.addr.sin6.sin6_port = htons(port);
		break;
	default:
		abort();
	}

	return 0;
}

LTTNG_HIDDEN
void lttcomm_init(void)
{
	const char *env;

	env = getenv(NETWORK_TIMEOUT_ENV);
	if (env) {
		long timeout;

		errno = 0;
		timeout = strtol(env, NULL, 0);
		if (errno != 0 || timeout < -1L) {
			PERROR("Network timeout");
		} else {
			if (timeout > 0) {
				network_timeout = timeout;
			}
		}
	}
}

LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void)
{
	return network_timeout;
}

/*
 * Only valid for an ipv4 and ipv6 bound socket that is already connected to its
 * peer.
 */
int lttcomm_populate_sock_from_open_socket(
		struct lttcomm_sock *sock,
		int fd,
		enum lttcomm_sock_proto protocol)
{
	int ret = 0;
	socklen_t storage_len;
	struct sockaddr_storage storage = { 0 };

	assert(sock);
	assert(fd >= 0);

	sock->proto = protocol;

	storage_len = sizeof(storage);
	ret = getpeername(fd, (struct sockaddr *) &storage,
			&storage_len);
	if (ret) {
		ERR("Failed to get peer info for socket %d (errno: %d)", fd,
				errno);
		ret = -1;
		goto end;
	}

	if (storage_len > sizeof(storage)) {
		ERR("Failed to get peer info for socket %d: storage size is too small", fd);
		ret = -1;
		goto end;
	}

	switch (storage.ss_family) {
	case AF_INET:
		sock->sockaddr.type = LTTCOMM_INET;
		memcpy(&sock->sockaddr.addr, &storage,
				sizeof(struct sockaddr_in));
		break;
	case AF_INET6:
		sock->sockaddr.type = LTTCOMM_INET6;
		memcpy(&sock->sockaddr.addr, &storage,
				sizeof(struct sockaddr_in6));
		break;
	default:
		abort();
		break;
	}

	/* Create a valid socket object with a temporary fd. */
	ret = lttcomm_create_sock(sock);
	if (ret < 0) {
		ERR("Failed to create temporary socket object");
		ret = -1;
		goto end;
	}

	/* Substitute the fd. */
	if (sock->ops->close(sock)) {
		ret = -1;
		goto end;
	}
	sock->fd = fd;

end:
	return ret;
}
Commit	Line	Data
826d496d	1	/*
90c106c6	2	* Copyright (C) 2011 EfficiOS Inc.
ab5be9fa MJ	3	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
	5	* SPDX-License-Identifier: GPL-2.0-only
fac6795d	6	*
fac6795d DG	7	*/
fac6795d DG	8
fe7bf564	9	#include <sys/socket.h>
6c1c0768	10	#define _LGPL_SOURCE
1e307fab	11	#include <assert.h>
fac6795d DG	12	#include <limits.h>
	13	#include <stdio.h>
	14	#include <stdlib.h>
	15	#include <string.h>
fac6795d DG	16	#include <sys/stat.h>
fac6795d DG	17	#include <sys/types.h>
fac6795d	18	#include <unistd.h>
2288467f	19	#include <inttypes.h>
fac6795d	20
90e535ef	21	#include <common/common.h>
edf4b93e	22	#include <common/compat/errno.h>
990570ed	23
10a8a223	24	#include "sessiond-comm.h"
fac6795d	25
6364a07a	26	/* For Unix socket */
2038dd6c	27	#include <common/unix.h>
6364a07a DG	28	/* For Inet socket */
	29	#include "inet.h"
	30	/* For Inet6 socket */
	31	#include "inet6.h"
	32
554831e7 MD	33	#define NETWORK_TIMEOUT_ENV "LTTNG_NETWORK_SOCKET_TIMEOUT"
554831e7 MD	34
32dd26fb	35	static struct lttcomm_net_family net_families[] = {
6364a07a DG	36	{ LTTCOMM_INET, lttcomm_create_inet_sock },
	37	{ LTTCOMM_INET6, lttcomm_create_inet6_sock },
	38	};
	39
fac6795d DG	40	/*
	41	* Human readable error message.
	42	*/
	43	static const char *lttcomm_readable_code[] = {
f73fabfd DG	44	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_COMMAND_SOCK_READY) ] = "consumerd command socket ready",
	45	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SUCCESS_RECV_FD) ] = "consumerd success on receiving fds",
	46	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_RECV_FD) ] = "consumerd error on receiving fds",
	47	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_RECV_CMD) ] = "consumerd error on receiving command",
	48	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_ERROR) ] = "consumerd error in polling thread",
	49	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_NVAL) ] = "consumerd polling on closed fd",
	50	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_HUP) ] = "consumerd all fd hung up",
	51	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_EXIT_SUCCESS) ] = "consumerd exiting normally",
	52	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_EXIT_FAILURE) ] = "consumerd exiting on error",
	53	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_OUTFD_ERROR) ] = "consumerd error opening the tracefile",
	54	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_EBADF) ] = "consumerd splice EBADF",
	55	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_EINVAL) ] = "consumerd splice EINVAL",
	56	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_ENOMEM) ] = "consumerd splice ENOMEM",
	57	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_ESPIPE) ] = "consumerd splice ESPIPE",
40727660 MD	58	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ENOMEM) ] = "Consumer is out of memory",
	59	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_METADATA) ] = "Error with metadata",
	60	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_FATAL) ] = "Fatal error",
618a6a28	61	[ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_RELAYD_FAIL) ] = "Error on remote relayd",
80e327fa	62
f73fabfd DG	63	/* Last element */
f73fabfd DG	64	[ LTTCOMM_ERR_INDEX(LTTCOMM_NR) ] = "Unknown error code"
fac6795d DG	65	};
fac6795d DG	66
554831e7 MD	67	static unsigned long network_timeout;
554831e7 MD	68
fac6795d	69	/*
917216f6 DG	70	* Return ptr to string representing a human readable error code from the
917216f6 DG	71	* lttcomm_return_code enum.
fac6795d	72	*
917216f6	73	* These code MUST be negative in other to treat that as an error value.
fac6795d	74	*/
90e535ef	75	LTTNG_HIDDEN
fac6795d DG	76	const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
fac6795d DG	77	{
f73fabfd	78	code = -code;
fac6795d	79
c617c0c6	80	if (code < LTTCOMM_CONSUMERD_COMMAND_SOCK_READY \|\| code > LTTCOMM_NR) {
f73fabfd	81	code = LTTCOMM_NR;
fac6795d DG	82	}
fac6795d DG	83
f73fabfd	84	return lttcomm_readable_code[LTTCOMM_ERR_INDEX(code)];
fac6795d	85	}
6364a07a DG	86
6364a07a DG	87	/*
de5e9086 DG	88	* Create socket from an already allocated lttcomm socket structure and init
de5e9086 DG	89	* sockaddr in the lttcomm sock.
6364a07a	90	*/
90e535ef	91	LTTNG_HIDDEN
de5e9086	92	int lttcomm_create_sock(struct lttcomm_sock *sock)
6364a07a	93	{
de5e9086	94	int ret, _sock_type, _sock_proto, domain;
6364a07a	95
de5e9086 DG	96	assert(sock);
	97
	98	domain = sock->sockaddr.type;
	99	if (domain != LTTCOMM_INET && domain != LTTCOMM_INET6) {
	100	ERR("Create socket of unknown domain %d", domain);
	101	ret = -1;
	102	goto error;
6364a07a DG	103	}
6364a07a DG	104
de5e9086 DG	105	switch (sock->proto) {
	106	case LTTCOMM_SOCK_UDP:
	107	_sock_type = SOCK_DGRAM;
	108	_sock_proto = IPPROTO_UDP;
	109	break;
	110	case LTTCOMM_SOCK_TCP:
	111	_sock_type = SOCK_STREAM;
	112	_sock_proto = IPPROTO_TCP;
	113	break;
	114	default:
	115	ret = -1;
	116	goto error;
	117	}
6364a07a	118
de5e9086 DG	119	ret = net_families[domain].create(sock, _sock_type, _sock_proto);
	120	if (ret < 0) {
	121	goto error;
	122	}
	123
	124	error:
	125	return ret;
6364a07a DG	126	}
	127
	128	/*
de5e9086	129	* Return allocated lttcomm socket structure.
6364a07a	130	*/
90e535ef	131	LTTNG_HIDDEN
de5e9086	132	struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto)
6364a07a	133	{
de5e9086	134	struct lttcomm_sock *sock;
6364a07a	135
de5e9086 DG	136	sock = zmalloc(sizeof(struct lttcomm_sock));
	137	if (sock == NULL) {
	138	PERROR("zmalloc create sock");
	139	goto end;
6364a07a DG	140	}
	141
	142	sock->proto = proto;
de5e9086	143	sock->fd = -1;
6364a07a	144
de5e9086 DG	145	end:
de5e9086 DG	146	return sock;
6364a07a DG	147	}
	148
	149	/*
de5e9086 DG	150	* Return an allocated lttcomm socket structure and copy src content into
	151	* the newly created socket.
	152	*
	153	* This is mostly useful when lttcomm_sock are passed between process where the
	154	* fd and ops have to be changed within the correct address space.
6364a07a	155	*/
90e535ef	156	LTTNG_HIDDEN
de5e9086	157	struct lttcomm_sock lttcomm_alloc_copy_sock(struct lttcomm_sock src)
6364a07a	158	{
6364a07a DG	159	struct lttcomm_sock *sock;
6364a07a DG	160
de5e9086 DG	161	/* Safety net */
	162	assert(src);
	163
	164	sock = lttcomm_alloc_sock(src->proto);
6364a07a DG	165	if (sock == NULL) {
	166	goto alloc_error;
	167	}
	168
de5e9086	169	lttcomm_copy_sock(sock, src);
6364a07a	170
de5e9086	171	alloc_error:
6364a07a	172	return sock;
de5e9086	173	}
6364a07a	174
de5e9086 DG	175	/*
	176	* Create and copy socket from an allocated lttcomm socket structure.
	177	*
	178	* This is mostly useful when lttcomm_sock are passed between process where the
	179	* fd and ops have to be changed within the correct address space.
	180	*/
90e535ef	181	LTTNG_HIDDEN
de5e9086 DG	182	void lttcomm_copy_sock(struct lttcomm_sock dst, struct lttcomm_sock src)
	183	{
	184	/* Safety net */
	185	assert(dst);
	186	assert(src);
	187
	188	dst->proto = src->proto;
	189	dst->fd = src->fd;
	190	dst->ops = src->ops;
	191	/* Copy sockaddr information from original socket */
	192	memcpy(&dst->sockaddr, &src->sockaddr, sizeof(dst->sockaddr));
6364a07a DG	193	}
	194
	195	/*
	196	* Init IPv4 sockaddr structure.
	197	*/
90e535ef	198	LTTNG_HIDDEN
6364a07a DG	199	int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
	200	const char *ip, unsigned int port)
	201	{
	202	int ret;
	203
	204	assert(sockaddr);
	205	assert(ip);
	206	assert(port > 0 && port <= 65535);
	207
	208	memset(sockaddr, 0, sizeof(struct lttcomm_sockaddr));
	209
	210	sockaddr->type = LTTCOMM_INET;
	211	sockaddr->addr.sin.sin_family = AF_INET;
	212	sockaddr->addr.sin.sin_port = htons(port);
	213	ret = inet_pton(sockaddr->addr.sin.sin_family, ip,
	214	&sockaddr->addr.sin.sin_addr);
	215	if (ret < 1) {
	216	ret = -1;
de5e9086	217	ERR("%s with port %d: unrecognized IPv4 address", ip, port);
6364a07a DG	218	goto error;
	219	}
	220	memset(sockaddr->addr.sin.sin_zero, 0, sizeof(sockaddr->addr.sin.sin_zero));
	221
	222	error:
	223	return ret;
	224	}
	225
	226	/*
	227	* Init IPv6 sockaddr structure.
	228	*/
90e535ef	229	LTTNG_HIDDEN
6364a07a DG	230	int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
	231	const char *ip, unsigned int port)
	232	{
	233	int ret;
	234
	235	assert(sockaddr);
	236	assert(ip);
	237	assert(port > 0 && port <= 65535);
	238
	239	memset(sockaddr, 0, sizeof(struct lttcomm_sockaddr));
	240
	241	sockaddr->type = LTTCOMM_INET6;
	242	sockaddr->addr.sin6.sin6_family = AF_INET6;
	243	sockaddr->addr.sin6.sin6_port = htons(port);
	244	ret = inet_pton(sockaddr->addr.sin6.sin6_family, ip,
	245	&sockaddr->addr.sin6.sin6_addr);
	246	if (ret < 1) {
	247	ret = -1;
	248	goto error;
	249	}
	250
	251	error:
	252	return ret;
	253	}
de5e9086 DG	254
	255	/*
	256	* Return allocated lttcomm socket structure from lttng URI.
	257	*/
90e535ef	258	LTTNG_HIDDEN
de5e9086 DG	259	struct lttcomm_sock lttcomm_alloc_sock_from_uri(struct lttng_uri uri)
	260	{
	261	int ret;
	262	int _sock_proto;
	263	struct lttcomm_sock *sock = NULL;
	264
	265	/* Safety net */
	266	assert(uri);
	267
	268	/* Check URI protocol */
	269	if (uri->proto == LTTNG_TCP) {
	270	_sock_proto = LTTCOMM_SOCK_TCP;
	271	} else {
	272	ERR("Relayd invalid URI proto: %d", uri->proto);
	273	goto alloc_error;
	274	}
	275
	276	sock = lttcomm_alloc_sock(_sock_proto);
	277	if (sock == NULL) {
	278	goto alloc_error;
	279	}
	280
	281	/* Check destination type */
	282	if (uri->dtype == LTTNG_DST_IPV4) {
	283	ret = lttcomm_init_inet_sockaddr(&sock->sockaddr, uri->dst.ipv4,
	284	uri->port);
	285	if (ret < 0) {
	286	goto error;
	287	}
	288	} else if (uri->dtype == LTTNG_DST_IPV6) {
	289	ret = lttcomm_init_inet6_sockaddr(&sock->sockaddr, uri->dst.ipv6,
	290	uri->port);
	291	if (ret < 0) {
	292	goto error;
	293	}
	294	} else {
	295	/* Command URI is invalid */
	296	ERR("Relayd invalid URI dst type: %d", uri->dtype);
	297	goto error;
	298	}
	299
	300	return sock;
	301
	302	error:
	303	lttcomm_destroy_sock(sock);
	304	alloc_error:
	305	return NULL;
	306	}
	307
	308	/*
	309	* Destroy and free lttcomm socket.
	310	*/
90e535ef	311	LTTNG_HIDDEN
de5e9086 DG	312	void lttcomm_destroy_sock(struct lttcomm_sock *sock)
de5e9086 DG	313	{
0e428499	314	free(sock);
de5e9086	315	}
6151a90f JD	316
	317	/*
	318	* Allocate and return a relayd socket object using a given URI to initialize
	319	* it and the major/minor version of the supported protocol.
	320	*
	321	* On error, NULL is returned.
	322	*/
bc182241	323	LTTNG_HIDDEN
6151a90f JD	324	struct lttcomm_relayd_sock lttcomm_alloc_relayd_sock(struct lttng_uri uri,
	325	uint32_t major, uint32_t minor)
	326	{
	327	int ret;
	328	struct lttcomm_sock *tmp_sock = NULL;
	329	struct lttcomm_relayd_sock *rsock = NULL;
	330
	331	assert(uri);
	332
	333	rsock = zmalloc(sizeof(*rsock));
	334	if (!rsock) {
	335	PERROR("zmalloc relayd sock");
	336	goto error;
	337	}
	338
	339	/* Allocate socket object from URI */
	340	tmp_sock = lttcomm_alloc_sock_from_uri(uri);
	341	if (tmp_sock == NULL) {
	342	goto error_free;
	343	}
	344
	345	/*
	346	* Create socket object which basically sets the ops according to the
	347	* socket protocol.
	348	*/
	349	lttcomm_copy_sock(&rsock->sock, tmp_sock);
	350	/* Temporary socket pointer not needed anymore. */
	351	lttcomm_destroy_sock(tmp_sock);
	352	ret = lttcomm_create_sock(&rsock->sock);
	353	if (ret < 0) {
	354	goto error_free;
	355	}
	356
	357	rsock->major = major;
	358	rsock->minor = minor;
	359
	360	return rsock;
	361
	362	error_free:
	363	free(rsock);
	364	error:
	365	return NULL;
	366	}
554831e7	367
783a3b9a MD	368	/*
	369	* Set socket receiving timeout.
	370	*/
	371	LTTNG_HIDDEN
	372	int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec)
	373	{
	374	int ret;
	375	struct timeval tv;
	376
	377	tv.tv_sec = msec / 1000;
	378	tv.tv_usec = (msec % 1000) * 1000;
	379
	380	ret = setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
	381	if (ret < 0) {
	382	PERROR("setsockopt SO_RCVTIMEO");
	383	}
	384
	385	return ret;
	386	}
	387
	388	/*
	389	* Set socket sending timeout.
	390	*/
	391	LTTNG_HIDDEN
	392	int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec)
	393	{
	394	int ret;
	395	struct timeval tv;
	396
	397	tv.tv_sec = msec / 1000;
	398	tv.tv_usec = (msec % 1000) * 1000;
	399
	400	ret = setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
	401	if (ret < 0) {
	402	PERROR("setsockopt SO_SNDTIMEO");
	403	}
	404
	405	return ret;
	406	}
	407
2288467f JG	408	LTTNG_HIDDEN
	409	int lttcomm_sock_get_port(const struct lttcomm_sock sock, uint16_t port)
	410	{
	411	assert(sock);
	412	assert(port);
	413	assert(sock->sockaddr.type == LTTCOMM_INET \|\|
	414	sock->sockaddr.type == LTTCOMM_INET6);
	415	assert(sock->proto == LTTCOMM_SOCK_TCP \|\|
	416	sock->proto == LTTCOMM_SOCK_UDP);
	417
	418	switch (sock->sockaddr.type) {
	419	case LTTCOMM_INET:
	420	*port = ntohs(sock->sockaddr.addr.sin.sin_port);
	421	break;
	422	case LTTCOMM_INET6:
	423	*port = ntohs(sock->sockaddr.addr.sin6.sin6_port);
	424	break;
	425	default:
	426	abort();
	427	}
	428
	429	return 0;
	430	}
	431
	432	LTTNG_HIDDEN
	433	int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port)
	434	{
	435	assert(sock);
	436	assert(sock->sockaddr.type == LTTCOMM_INET \|\|
	437	sock->sockaddr.type == LTTCOMM_INET6);
	438	assert(sock->proto == LTTCOMM_SOCK_TCP \|\|
	439	sock->proto == LTTCOMM_SOCK_UDP);
	440
	441	switch (sock->sockaddr.type) {
	442	case LTTCOMM_INET:
	443	sock->sockaddr.addr.sin.sin_port = htons(port);
	444	break;
	445	case LTTCOMM_INET6:
	446	sock->sockaddr.addr.sin6.sin6_port = htons(port);
	447	break;
	448	default:
	449	abort();
	450	}
	451
	452	return 0;
	453	}
	454
554831e7 MD	455	LTTNG_HIDDEN
	456	void lttcomm_init(void)
	457	{
	458	const char *env;
	459
	460	env = getenv(NETWORK_TIMEOUT_ENV);
	461	if (env) {
	462	long timeout;
	463
	464	errno = 0;
	465	timeout = strtol(env, NULL, 0);
	466	if (errno != 0 \|\| timeout < -1L) {
	467	PERROR("Network timeout");
	468	} else {
	469	if (timeout > 0) {
	470	network_timeout = timeout;
	471	}
	472	}
	473	}
	474	}
	475
	476	LTTNG_HIDDEN
	477	unsigned long lttcomm_get_network_timeout(void)
	478	{
	479	return network_timeout;
	480	}
fe7bf564 JR	481
	482	/*
	483	* Only valid for an ipv4 and ipv6 bound socket that is already connected to its
	484	* peer.
	485	*/
	486	int lttcomm_populate_sock_from_open_socket(
	487	struct lttcomm_sock *sock,
	488	int fd,
	489	enum lttcomm_sock_proto protocol)
	490	{
	491	int ret = 0;
	492	socklen_t storage_len;
	493	struct sockaddr_storage storage = { 0 };
	494
	495	assert(sock);
	496	assert(fd >= 0);
	497
	498	sock->proto = protocol;
	499
	500	storage_len = sizeof(storage);
	501	ret = getpeername(fd, (struct sockaddr *) &storage,
	502	&storage_len);
	503	if (ret) {
	504	ERR("Failed to get peer info for socket %d (errno: %d)", fd,
	505	errno);
	506	ret = -1;
	507	goto end;
	508	}
	509
	510	if (storage_len > sizeof(storage)) {
	511	ERR("Failed to get peer info for socket %d: storage size is too small", fd);
	512	ret = -1;
	513	goto end;
	514	}
	515
	516	switch (storage.ss_family) {
	517	case AF_INET:
	518	sock->sockaddr.type = LTTCOMM_INET;
	519	memcpy(&sock->sockaddr.addr, &storage,
	520	sizeof(struct sockaddr_in));
	521	break;
	522	case AF_INET6:
	523	sock->sockaddr.type = LTTCOMM_INET6;
	524	memcpy(&sock->sockaddr.addr, &storage,
	525	sizeof(struct sockaddr_in6));
	526	break;
	527	default:
	528	abort();
	529	break;
	530	}
	531
	532	/* Create a valid socket object with a temporary fd. */
	533	ret = lttcomm_create_sock(sock);
	534	if (ret < 0) {
	535	ERR("Failed to create temporary socket object");
	536	ret = -1;
	537	goto end;
	538	}
	539
	540	/* Substitute the fd. */
	541	if (sock->ops->close(sock)) {
	542	ret = -1;
	543	goto end;
	544	}
545	sock->fd = fd;
546
547	end:
548	return ret;
549	}