src/common/sessiond-comm/sessiond-comm.cpp

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