2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
15 #include <sys/types.h>
19 #include <common/common.h>
20 #include <common/compat/errno.h>
22 #include "sessiond-comm.h"
25 #include <common/unix.h>
28 /* For Inet6 socket */
31 #define NETWORK_TIMEOUT_ENV "LTTNG_NETWORK_SOCKET_TIMEOUT"
33 static struct lttcomm_net_family net_families
[] = {
34 { LTTCOMM_INET
, lttcomm_create_inet_sock
},
35 { LTTCOMM_INET6
, lttcomm_create_inet6_sock
},
39 * Human readable error message.
41 static const char *lttcomm_readable_code
[] = {
42 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) ] = "consumerd command socket ready",
43 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
) ] = "consumerd success on receiving fds",
44 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_RECV_FD
) ] = "consumerd error on receiving fds",
45 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_RECV_CMD
) ] = "consumerd error on receiving command",
46 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_ERROR
) ] = "consumerd error in polling thread",
47 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_NVAL
) ] = "consumerd polling on closed fd",
48 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_POLL_HUP
) ] = "consumerd all fd hung up",
49 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_EXIT_SUCCESS
) ] = "consumerd exiting normally",
50 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_EXIT_FAILURE
) ] = "consumerd exiting on error",
51 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_OUTFD_ERROR
) ] = "consumerd error opening the tracefile",
52 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_EBADF
) ] = "consumerd splice EBADF",
53 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_EINVAL
) ] = "consumerd splice EINVAL",
54 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_ENOMEM
) ] = "consumerd splice ENOMEM",
55 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_SPLICE_ESPIPE
) ] = "consumerd splice ESPIPE",
56 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ENOMEM
) ] = "Consumer is out of memory",
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_ERROR_METADATA
) ] = "Error with metadata",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_FATAL
) ] = "Fatal error",
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_RELAYD_FAIL
) ] = "Error on remote relayd",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_NR
) ] = "Unknown error code"
65 static unsigned long network_timeout
;
68 * Return ptr to string representing a human readable error code from the
69 * lttcomm_return_code enum.
71 * These code MUST be negative in other to treat that as an error value.
74 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
78 if (code
< LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
|| code
> LTTCOMM_NR
) {
82 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(code
)];
86 * Create socket from an already allocated lttcomm socket structure and init
87 * sockaddr in the lttcomm sock.
90 int lttcomm_create_sock(struct lttcomm_sock
*sock
)
92 int ret
, _sock_type
, _sock_proto
, domain
;
96 domain
= sock
->sockaddr
.type
;
97 if (domain
!= LTTCOMM_INET
&& domain
!= LTTCOMM_INET6
) {
98 ERR("Create socket of unknown domain %d", domain
);
103 switch (sock
->proto
) {
104 case LTTCOMM_SOCK_UDP
:
105 _sock_type
= SOCK_DGRAM
;
106 _sock_proto
= IPPROTO_UDP
;
108 case LTTCOMM_SOCK_TCP
:
109 _sock_type
= SOCK_STREAM
;
110 _sock_proto
= IPPROTO_TCP
;
117 ret
= net_families
[domain
].create(sock
, _sock_type
, _sock_proto
);
127 * Return allocated lttcomm socket structure.
130 struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
)
132 struct lttcomm_sock
*sock
;
134 sock
= zmalloc(sizeof(struct lttcomm_sock
));
136 PERROR("zmalloc create sock");
148 * Return an allocated lttcomm socket structure and copy src content into
149 * the newly created socket.
151 * This is mostly useful when lttcomm_sock are passed between process where the
152 * fd and ops have to be changed within the correct address space.
155 struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
)
157 struct lttcomm_sock
*sock
;
162 sock
= lttcomm_alloc_sock(src
->proto
);
167 lttcomm_copy_sock(sock
, src
);
174 * Create and copy socket from an allocated lttcomm socket structure.
176 * This is mostly useful when lttcomm_sock are passed between process where the
177 * fd and ops have to be changed within the correct address space.
180 void lttcomm_copy_sock(struct lttcomm_sock
*dst
, struct lttcomm_sock
*src
)
186 dst
->proto
= src
->proto
;
189 /* Copy sockaddr information from original socket */
190 memcpy(&dst
->sockaddr
, &src
->sockaddr
, sizeof(dst
->sockaddr
));
194 * Init IPv4 sockaddr structure.
197 int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
198 const char *ip
, unsigned int port
)
202 LTTNG_ASSERT(sockaddr
);
204 LTTNG_ASSERT(port
> 0 && port
<= 65535);
206 memset(sockaddr
, 0, sizeof(struct lttcomm_sockaddr
));
208 sockaddr
->type
= LTTCOMM_INET
;
209 sockaddr
->addr
.sin
.sin_family
= AF_INET
;
210 sockaddr
->addr
.sin
.sin_port
= htons(port
);
211 ret
= inet_pton(sockaddr
->addr
.sin
.sin_family
, ip
,
212 &sockaddr
->addr
.sin
.sin_addr
);
215 ERR("%s with port %d: unrecognized IPv4 address", ip
, port
);
218 memset(sockaddr
->addr
.sin
.sin_zero
, 0, sizeof(sockaddr
->addr
.sin
.sin_zero
));
225 * Init IPv6 sockaddr structure.
228 int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
229 const char *ip
, unsigned int port
)
233 LTTNG_ASSERT(sockaddr
);
235 LTTNG_ASSERT(port
> 0 && port
<= 65535);
237 memset(sockaddr
, 0, sizeof(struct lttcomm_sockaddr
));
239 sockaddr
->type
= LTTCOMM_INET6
;
240 sockaddr
->addr
.sin6
.sin6_family
= AF_INET6
;
241 sockaddr
->addr
.sin6
.sin6_port
= htons(port
);
242 ret
= inet_pton(sockaddr
->addr
.sin6
.sin6_family
, ip
,
243 &sockaddr
->addr
.sin6
.sin6_addr
);
254 * Return allocated lttcomm socket structure from lttng URI.
257 struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
)
261 struct lttcomm_sock
*sock
= NULL
;
266 /* Check URI protocol */
267 if (uri
->proto
== LTTNG_TCP
) {
268 _sock_proto
= LTTCOMM_SOCK_TCP
;
270 ERR("Relayd invalid URI proto: %d", uri
->proto
);
274 sock
= lttcomm_alloc_sock(_sock_proto
);
279 /* Check destination type */
280 if (uri
->dtype
== LTTNG_DST_IPV4
) {
281 ret
= lttcomm_init_inet_sockaddr(&sock
->sockaddr
, uri
->dst
.ipv4
,
286 } else if (uri
->dtype
== LTTNG_DST_IPV6
) {
287 ret
= lttcomm_init_inet6_sockaddr(&sock
->sockaddr
, uri
->dst
.ipv6
,
293 /* Command URI is invalid */
294 ERR("Relayd invalid URI dst type: %d", uri
->dtype
);
301 lttcomm_destroy_sock(sock
);
307 * Destroy and free lttcomm socket.
310 void lttcomm_destroy_sock(struct lttcomm_sock
*sock
)
316 * Allocate and return a relayd socket object using a given URI to initialize
317 * it and the major/minor version of the supported protocol.
319 * On error, NULL is returned.
322 struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(struct lttng_uri
*uri
,
323 uint32_t major
, uint32_t minor
)
326 struct lttcomm_sock
*tmp_sock
= NULL
;
327 struct lttcomm_relayd_sock
*rsock
= NULL
;
331 rsock
= zmalloc(sizeof(*rsock
));
333 PERROR("zmalloc relayd sock");
337 /* Allocate socket object from URI */
338 tmp_sock
= lttcomm_alloc_sock_from_uri(uri
);
339 if (tmp_sock
== NULL
) {
344 * Create socket object which basically sets the ops according to the
347 lttcomm_copy_sock(&rsock
->sock
, tmp_sock
);
348 /* Temporary socket pointer not needed anymore. */
349 lttcomm_destroy_sock(tmp_sock
);
350 ret
= lttcomm_create_sock(&rsock
->sock
);
355 rsock
->major
= major
;
356 rsock
->minor
= minor
;
367 * Set socket receiving timeout.
370 int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
375 tv
.tv_sec
= msec
/ 1000;
376 tv
.tv_usec
= (msec
% 1000) * 1000;
378 ret
= setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
380 PERROR("setsockopt SO_RCVTIMEO");
387 * Set socket sending timeout.
390 int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
395 tv
.tv_sec
= msec
/ 1000;
396 tv
.tv_usec
= (msec
% 1000) * 1000;
398 ret
= setsockopt(sock
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
400 PERROR("setsockopt SO_SNDTIMEO");
407 int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
, uint16_t *port
)
411 LTTNG_ASSERT(sock
->sockaddr
.type
== LTTCOMM_INET
||
412 sock
->sockaddr
.type
== LTTCOMM_INET6
);
413 LTTNG_ASSERT(sock
->proto
== LTTCOMM_SOCK_TCP
||
414 sock
->proto
== LTTCOMM_SOCK_UDP
);
416 switch (sock
->sockaddr
.type
) {
418 *port
= ntohs(sock
->sockaddr
.addr
.sin
.sin_port
);
421 *port
= ntohs(sock
->sockaddr
.addr
.sin6
.sin6_port
);
431 int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
)
434 LTTNG_ASSERT(sock
->sockaddr
.type
== LTTCOMM_INET
||
435 sock
->sockaddr
.type
== LTTCOMM_INET6
);
436 LTTNG_ASSERT(sock
->proto
== LTTCOMM_SOCK_TCP
||
437 sock
->proto
== LTTCOMM_SOCK_UDP
);
439 switch (sock
->sockaddr
.type
) {
441 sock
->sockaddr
.addr
.sin
.sin_port
= htons(port
);
444 sock
->sockaddr
.addr
.sin6
.sin6_port
= htons(port
);
454 void lttcomm_init(void)
458 env
= getenv(NETWORK_TIMEOUT_ENV
);
463 timeout
= strtol(env
, NULL
, 0);
464 if (errno
!= 0 || timeout
< -1L) {
465 PERROR("Network timeout");
468 network_timeout
= timeout
;
475 unsigned long lttcomm_get_network_timeout(void)
477 return network_timeout
;