2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
9 #include <sys/socket.h>
17 #include <sys/types.h>
22 #include <common/common.h>
24 #include "sessiond-comm.h"
27 #include <common/unix.h>
30 /* For Inet6 socket */
33 #define NETWORK_TIMEOUT_ENV "LTTNG_NETWORK_SOCKET_TIMEOUT"
35 static struct lttcomm_net_family net_families
[] = {
36 { LTTCOMM_INET
, lttcomm_create_inet_sock
},
37 { LTTCOMM_INET6
, lttcomm_create_inet6_sock
},
41 * Human readable error message.
43 static const char *lttcomm_readable_code
[] = {
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",
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",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONSUMERD_RELAYD_FAIL
) ] = "Error on remote relayd",
64 [ LTTCOMM_ERR_INDEX(LTTCOMM_NR
) ] = "Unknown error code"
67 static unsigned long network_timeout
;
70 * Return ptr to string representing a human readable error code from the
71 * lttcomm_return_code enum.
73 * These code MUST be negative in other to treat that as an error value.
76 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
)
80 if (code
< LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
|| code
> LTTCOMM_NR
) {
84 return lttcomm_readable_code
[LTTCOMM_ERR_INDEX(code
)];
88 * Create socket from an already allocated lttcomm socket structure and init
89 * sockaddr in the lttcomm sock.
92 int lttcomm_create_sock(struct lttcomm_sock
*sock
)
94 int ret
, _sock_type
, _sock_proto
, domain
;
98 domain
= sock
->sockaddr
.type
;
99 if (domain
!= LTTCOMM_INET
&& domain
!= LTTCOMM_INET6
) {
100 ERR("Create socket of unknown domain %d", domain
);
105 switch (sock
->proto
) {
106 case LTTCOMM_SOCK_UDP
:
107 _sock_type
= SOCK_DGRAM
;
108 _sock_proto
= IPPROTO_UDP
;
110 case LTTCOMM_SOCK_TCP
:
111 _sock_type
= SOCK_STREAM
;
112 _sock_proto
= IPPROTO_TCP
;
119 ret
= net_families
[domain
].create(sock
, _sock_type
, _sock_proto
);
129 * Return allocated lttcomm socket structure.
132 struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
)
134 struct lttcomm_sock
*sock
;
136 sock
= zmalloc(sizeof(struct lttcomm_sock
));
138 PERROR("zmalloc create sock");
150 * Return an allocated lttcomm socket structure and copy src content into
151 * the newly created socket.
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.
157 struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
)
159 struct lttcomm_sock
*sock
;
164 sock
= lttcomm_alloc_sock(src
->proto
);
169 lttcomm_copy_sock(sock
, src
);
176 * Create and copy socket from an allocated lttcomm socket structure.
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.
182 void lttcomm_copy_sock(struct lttcomm_sock
*dst
, struct lttcomm_sock
*src
)
188 dst
->proto
= src
->proto
;
191 /* Copy sockaddr information from original socket */
192 memcpy(&dst
->sockaddr
, &src
->sockaddr
, sizeof(dst
->sockaddr
));
196 * Init IPv4 sockaddr structure.
199 int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
200 const char *ip
, unsigned int port
)
206 assert(port
> 0 && port
<= 65535);
208 memset(sockaddr
, 0, sizeof(struct lttcomm_sockaddr
));
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
);
217 ERR("%s with port %d: unrecognized IPv4 address", ip
, port
);
220 memset(sockaddr
->addr
.sin
.sin_zero
, 0, sizeof(sockaddr
->addr
.sin
.sin_zero
));
227 * Init IPv6 sockaddr structure.
230 int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
231 const char *ip
, unsigned int port
)
237 assert(port
> 0 && port
<= 65535);
239 memset(sockaddr
, 0, sizeof(struct lttcomm_sockaddr
));
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
);
256 * Return allocated lttcomm socket structure from lttng URI.
259 struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
)
263 struct lttcomm_sock
*sock
= NULL
;
268 /* Check URI protocol */
269 if (uri
->proto
== LTTNG_TCP
) {
270 _sock_proto
= LTTCOMM_SOCK_TCP
;
272 ERR("Relayd invalid URI proto: %d", uri
->proto
);
276 sock
= lttcomm_alloc_sock(_sock_proto
);
281 /* Check destination type */
282 if (uri
->dtype
== LTTNG_DST_IPV4
) {
283 ret
= lttcomm_init_inet_sockaddr(&sock
->sockaddr
, uri
->dst
.ipv4
,
288 } else if (uri
->dtype
== LTTNG_DST_IPV6
) {
289 ret
= lttcomm_init_inet6_sockaddr(&sock
->sockaddr
, uri
->dst
.ipv6
,
295 /* Command URI is invalid */
296 ERR("Relayd invalid URI dst type: %d", uri
->dtype
);
303 lttcomm_destroy_sock(sock
);
309 * Destroy and free lttcomm socket.
312 void lttcomm_destroy_sock(struct lttcomm_sock
*sock
)
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.
321 * On error, NULL is returned.
324 struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(struct lttng_uri
*uri
,
325 uint32_t major
, uint32_t minor
)
328 struct lttcomm_sock
*tmp_sock
= NULL
;
329 struct lttcomm_relayd_sock
*rsock
= NULL
;
333 rsock
= zmalloc(sizeof(*rsock
));
335 PERROR("zmalloc relayd sock");
339 /* Allocate socket object from URI */
340 tmp_sock
= lttcomm_alloc_sock_from_uri(uri
);
341 if (tmp_sock
== NULL
) {
346 * Create socket object which basically sets the ops according to the
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
);
357 rsock
->major
= major
;
358 rsock
->minor
= minor
;
369 * Set socket receiving timeout.
372 int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
377 tv
.tv_sec
= msec
/ 1000;
378 tv
.tv_usec
= (msec
% 1000) * 1000;
380 ret
= setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
382 PERROR("setsockopt SO_RCVTIMEO");
389 * Set socket sending timeout.
392 int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
397 tv
.tv_sec
= msec
/ 1000;
398 tv
.tv_usec
= (msec
% 1000) * 1000;
400 ret
= setsockopt(sock
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
402 PERROR("setsockopt SO_SNDTIMEO");
409 int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
, uint16_t *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
);
418 switch (sock
->sockaddr
.type
) {
420 *port
= ntohs(sock
->sockaddr
.addr
.sin
.sin_port
);
423 *port
= ntohs(sock
->sockaddr
.addr
.sin6
.sin6_port
);
433 int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
)
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
);
441 switch (sock
->sockaddr
.type
) {
443 sock
->sockaddr
.addr
.sin
.sin_port
= htons(port
);
446 sock
->sockaddr
.addr
.sin6
.sin6_port
= htons(port
);
456 void lttcomm_init(void)
460 env
= getenv(NETWORK_TIMEOUT_ENV
);
465 timeout
= strtol(env
, NULL
, 0);
466 if (errno
!= 0 || timeout
< -1L) {
467 PERROR("Network timeout");
470 network_timeout
= timeout
;
477 unsigned long lttcomm_get_network_timeout(void)
479 return network_timeout
;
483 * Only valid for an ipv4 and ipv6 bound socket that is already connected to its
486 LTTNG_HIDDEN
int lttcomm_populate_sock_from_open_socket(
487 struct lttcomm_sock
*sock
,
489 enum lttcomm_sock_proto protocol
)
492 socklen_t storage_len
;
493 struct sockaddr_storage storage
= { 0 };
498 sock
->proto
= protocol
;
500 storage_len
= sizeof(storage
);
501 ret
= getpeername(fd
, (struct sockaddr
*) &storage
,
504 ERR("Failed to get peer info for socket %d (errno: %d)", fd
,
510 if (storage_len
> sizeof(storage
)) {
511 ERR("Failed to get peer info for socket %d: storage size is too small", fd
);
516 switch (storage
.ss_family
) {
518 sock
->sockaddr
.type
= LTTCOMM_INET
;
519 memcpy(&sock
->sockaddr
.addr
, &storage
,
520 sizeof(struct sockaddr_in
));
523 sock
->sockaddr
.type
= LTTCOMM_INET6
;
524 memcpy(&sock
->sockaddr
.addr
, &storage
,
525 sizeof(struct sockaddr_in6
));
532 /* Create a valid socket object with a temporary fd. */
533 ret
= lttcomm_create_sock(sock
);
535 ERR("Failed to create temporary socket object");
540 /* Substitute the fd. */
541 if (sock
->ops
->close(sock
)) {