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.
73 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
77 if (code
< LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
|| code
> LTTCOMM_NR
) {
81 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(code
)];
85 * Create socket from an already allocated lttcomm socket structure and init
86 * sockaddr in the lttcomm sock.
88 int lttcomm_create_sock(struct lttcomm_sock
*sock
)
90 int ret
, _sock_type
, _sock_proto
, domain
;
94 domain
= sock
->sockaddr
.type
;
95 if (domain
!= LTTCOMM_INET
&& domain
!= LTTCOMM_INET6
) {
96 ERR("Create socket of unknown domain %d", domain
);
101 switch (sock
->proto
) {
102 case LTTCOMM_SOCK_UDP
:
103 _sock_type
= SOCK_DGRAM
;
104 _sock_proto
= IPPROTO_UDP
;
106 case LTTCOMM_SOCK_TCP
:
107 _sock_type
= SOCK_STREAM
;
108 _sock_proto
= IPPROTO_TCP
;
115 ret
= net_families
[domain
].create(sock
, _sock_type
, _sock_proto
);
125 * Return allocated lttcomm socket structure.
127 struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
)
129 struct lttcomm_sock
*sock
;
131 sock
= zmalloc(sizeof(struct lttcomm_sock
));
133 PERROR("zmalloc create sock");
145 * Return an allocated lttcomm socket structure and copy src content into
146 * the newly created socket.
148 * This is mostly useful when lttcomm_sock are passed between process where the
149 * fd and ops have to be changed within the correct address space.
151 struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
)
153 struct lttcomm_sock
*sock
;
158 sock
= lttcomm_alloc_sock(src
->proto
);
163 lttcomm_copy_sock(sock
, src
);
170 * Create and copy socket from an allocated lttcomm socket structure.
172 * This is mostly useful when lttcomm_sock are passed between process where the
173 * fd and ops have to be changed within the correct address space.
175 void lttcomm_copy_sock(struct lttcomm_sock
*dst
, struct lttcomm_sock
*src
)
181 dst
->proto
= src
->proto
;
184 /* Copy sockaddr information from original socket */
185 memcpy(&dst
->sockaddr
, &src
->sockaddr
, sizeof(dst
->sockaddr
));
189 * Init IPv4 sockaddr structure.
191 int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
192 const char *ip
, unsigned int port
)
196 LTTNG_ASSERT(sockaddr
);
198 LTTNG_ASSERT(port
> 0 && port
<= 65535);
200 memset(sockaddr
, 0, sizeof(struct lttcomm_sockaddr
));
202 sockaddr
->type
= LTTCOMM_INET
;
203 sockaddr
->addr
.sin
.sin_family
= AF_INET
;
204 sockaddr
->addr
.sin
.sin_port
= htons(port
);
205 ret
= inet_pton(sockaddr
->addr
.sin
.sin_family
, ip
,
206 &sockaddr
->addr
.sin
.sin_addr
);
209 ERR("%s with port %d: unrecognized IPv4 address", ip
, port
);
212 memset(sockaddr
->addr
.sin
.sin_zero
, 0, sizeof(sockaddr
->addr
.sin
.sin_zero
));
219 * Init IPv6 sockaddr structure.
221 int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
222 const char *ip
, unsigned int port
)
226 LTTNG_ASSERT(sockaddr
);
228 LTTNG_ASSERT(port
> 0 && port
<= 65535);
230 memset(sockaddr
, 0, sizeof(struct lttcomm_sockaddr
));
232 sockaddr
->type
= LTTCOMM_INET6
;
233 sockaddr
->addr
.sin6
.sin6_family
= AF_INET6
;
234 sockaddr
->addr
.sin6
.sin6_port
= htons(port
);
235 ret
= inet_pton(sockaddr
->addr
.sin6
.sin6_family
, ip
,
236 &sockaddr
->addr
.sin6
.sin6_addr
);
247 * Return allocated lttcomm socket structure from lttng URI.
249 struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
)
253 struct lttcomm_sock
*sock
= NULL
;
258 /* Check URI protocol */
259 if (uri
->proto
== LTTNG_TCP
) {
260 _sock_proto
= LTTCOMM_SOCK_TCP
;
262 ERR("Relayd invalid URI proto: %d", uri
->proto
);
266 sock
= lttcomm_alloc_sock(_sock_proto
);
271 /* Check destination type */
272 if (uri
->dtype
== LTTNG_DST_IPV4
) {
273 ret
= lttcomm_init_inet_sockaddr(&sock
->sockaddr
, uri
->dst
.ipv4
,
278 } else if (uri
->dtype
== LTTNG_DST_IPV6
) {
279 ret
= lttcomm_init_inet6_sockaddr(&sock
->sockaddr
, uri
->dst
.ipv6
,
285 /* Command URI is invalid */
286 ERR("Relayd invalid URI dst type: %d", uri
->dtype
);
293 lttcomm_destroy_sock(sock
);
299 * Destroy and free lttcomm socket.
301 void lttcomm_destroy_sock(struct lttcomm_sock
*sock
)
307 * Allocate and return a relayd socket object using a given URI to initialize
308 * it and the major/minor version of the supported protocol.
310 * On error, NULL is returned.
312 struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(struct lttng_uri
*uri
,
313 uint32_t major
, uint32_t minor
)
316 struct lttcomm_sock
*tmp_sock
= NULL
;
317 struct lttcomm_relayd_sock
*rsock
= NULL
;
321 rsock
= zmalloc(sizeof(*rsock
));
323 PERROR("zmalloc relayd sock");
327 /* Allocate socket object from URI */
328 tmp_sock
= lttcomm_alloc_sock_from_uri(uri
);
329 if (tmp_sock
== NULL
) {
334 * Create socket object which basically sets the ops according to the
337 lttcomm_copy_sock(&rsock
->sock
, tmp_sock
);
338 /* Temporary socket pointer not needed anymore. */
339 lttcomm_destroy_sock(tmp_sock
);
340 ret
= lttcomm_create_sock(&rsock
->sock
);
345 rsock
->major
= major
;
346 rsock
->minor
= minor
;
357 * Set socket receiving timeout.
359 int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
364 tv
.tv_sec
= msec
/ 1000;
365 tv
.tv_usec
= (msec
% 1000) * 1000;
367 ret
= setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
369 PERROR("setsockopt SO_RCVTIMEO");
376 * Set socket sending timeout.
378 int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
383 tv
.tv_sec
= msec
/ 1000;
384 tv
.tv_usec
= (msec
% 1000) * 1000;
386 ret
= setsockopt(sock
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
388 PERROR("setsockopt SO_SNDTIMEO");
394 int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
, uint16_t *port
)
398 LTTNG_ASSERT(sock
->sockaddr
.type
== LTTCOMM_INET
||
399 sock
->sockaddr
.type
== LTTCOMM_INET6
);
400 LTTNG_ASSERT(sock
->proto
== LTTCOMM_SOCK_TCP
||
401 sock
->proto
== LTTCOMM_SOCK_UDP
);
403 switch (sock
->sockaddr
.type
) {
405 *port
= ntohs(sock
->sockaddr
.addr
.sin
.sin_port
);
408 *port
= ntohs(sock
->sockaddr
.addr
.sin6
.sin6_port
);
417 int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
)
420 LTTNG_ASSERT(sock
->sockaddr
.type
== LTTCOMM_INET
||
421 sock
->sockaddr
.type
== LTTCOMM_INET6
);
422 LTTNG_ASSERT(sock
->proto
== LTTCOMM_SOCK_TCP
||
423 sock
->proto
== LTTCOMM_SOCK_UDP
);
425 switch (sock
->sockaddr
.type
) {
427 sock
->sockaddr
.addr
.sin
.sin_port
= htons(port
);
430 sock
->sockaddr
.addr
.sin6
.sin6_port
= htons(port
);
439 void lttcomm_init(void)
443 env
= getenv(NETWORK_TIMEOUT_ENV
);
448 timeout
= strtol(env
, NULL
, 0);
449 if (errno
!= 0 || timeout
< -1L) {
450 PERROR("Network timeout");
453 network_timeout
= timeout
;
459 unsigned long lttcomm_get_network_timeout(void)
461 return network_timeout
;