src/bin/lttng-relayd/cmd-2-11.cpp

   1 /*
   2  * Copyright (C) 2018 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #define _LGPL_SOURCE
   9 #include <inttypes.h>
  10
  11 #include <common/common.h>
  12 #include <common/sessiond-comm/relayd.h>
  13
  14 #include <common/compat/endian.h>
  15 #include <common/compat/string.h>
  16 #include <lttng/constant.h>
  17
  18 #include "cmd-2-11.h"
  19 #include "utils.h"
  20
  21 int cmd_create_session_2_11(const struct lttng_buffer_view *payload,
  22                 char *session_name, char *hostname, char *base_path,
  23                 uint32_t *live_timer, bool *snapshot,
  24                 uint64_t *id_sessiond, lttng_uuid sessiond_uuid,
  25                 bool *has_current_chunk, uint64_t *current_chunk_id,
  26                 time_t *creation_time,
  27                 bool *session_name_contains_creation_time)
  28 {
  29         int ret;
  30         struct lttcomm_relayd_create_session_2_11 header;
  31         size_t header_len, received_names_size, offset;
  32         struct lttng_buffer_view session_name_view;
  33         struct lttng_buffer_view hostname_view;
  34         struct lttng_buffer_view base_path_view;
  35
  36         header_len = sizeof(header);
  37
  38         if (payload->size < header_len) {
  39                 ERR("Unexpected payload size in \"cmd_create_session_2_11\": expected >= %zu bytes, got %zu bytes",
  40                                 header_len, payload->size);
  41                 ret = -1;
  42                 goto error;
  43         }
  44         memcpy(&header, payload->data, header_len);
  45
  46         header.session_name_len = be32toh(header.session_name_len);
  47         header.hostname_len = be32toh(header.hostname_len);
  48         header.base_path_len = be32toh(header.base_path_len);
  49         header.live_timer = be32toh(header.live_timer);
  50         header.current_chunk_id.value = be64toh(header.current_chunk_id.value);
  51         header.current_chunk_id.is_set = !!header.current_chunk_id.is_set;
  52         header.creation_time = be64toh(header.creation_time);
  53
  54         lttng_uuid_copy(sessiond_uuid, header.sessiond_uuid);
  55
  56         received_names_size = header.session_name_len + header.hostname_len +
  57                                 header.base_path_len;
  58         if (payload->size < header_len + received_names_size) {
  59                 ERR("Unexpected payload size in \"cmd_create_session_2_11\": expected >= %zu bytes, got %zu bytes",
  60                                 header_len + received_names_size, payload->size);
  61                 ret = -1;
  62                 goto error;
  63         }
  64
  65         /* Validate length against defined constant. */
  66         if (header.session_name_len > LTTNG_NAME_MAX) {
  67                 ret = -ENAMETOOLONG;
  68                 ERR("Length of session name (%" PRIu32 " bytes) received in create_session command exceeds maximum length (%d bytes)", header.session_name_len, LTTNG_NAME_MAX);
  69                 goto error;
  70         } else if (header.session_name_len == 0) {
  71                 ret = -EINVAL;
  72                 ERR("Illegal session name length of 0 received");
  73                 goto error;
  74         }
  75         if (header.hostname_len > LTTNG_HOST_NAME_MAX) {
  76                 ret = -ENAMETOOLONG;
  77                 ERR("Length of hostname (%" PRIu32 " bytes) received in create_session command exceeds maximum length (%d bytes)", header.hostname_len, LTTNG_HOST_NAME_MAX);
  78                 goto error;
  79         }
  80         if (header.base_path_len > LTTNG_PATH_MAX) {
  81                 ret = -ENAMETOOLONG;
  82                 ERR("Length of base_path (%" PRIu32 " bytes) received in create_session command exceeds maximum length (%d bytes)", header.base_path_len, PATH_MAX);
  83                 goto error;
  84         }
  85
  86         offset = header_len;
  87         session_name_view = lttng_buffer_view_from_view(payload, offset,
  88                         header.session_name_len);
  89         if (!lttng_buffer_view_is_valid(&session_name_view)) {
  90                 ERR("Invalid payload in \"cmd_create_session_2_11\": buffer too short to contain session name");
  91                 ret = -1;
  92                 goto error;
  93         }
  94
  95         offset += header.session_name_len;
  96         hostname_view = lttng_buffer_view_from_view(payload,
  97                         offset, header.hostname_len);
  98         if (!lttng_buffer_view_is_valid(&hostname_view)) {
  99                 ERR("Invalid payload in \"cmd_create_session_2_11\": buffer too short to contain hostname");
 100                 ret = -1;
 101                 goto error;
 102         }
 103
 104         offset += header.hostname_len;
 105         base_path_view = lttng_buffer_view_from_view(payload,
 106                         offset, header.base_path_len);
 107         if (header.base_path_len > 0 && !lttng_buffer_view_is_valid(&base_path_view)) {
 108                 ERR("Invalid payload in \"cmd_create_session_2_11\": buffer too short to contain base path");
 109                 ret = -1;
 110                 goto error;
 111         }
 112
 113         /* Validate that names are NULL terminated. */
 114         if (session_name_view.data[session_name_view.size - 1] != '\0') {
 115                 ERR("cmd_create_session_2_11 session_name is invalid (not NULL terminated)");
 116                 ret = -1;
 117                 goto error;
 118         }
 119
 120         if (hostname_view.data[hostname_view.size - 1] != '\0') {
 121                 ERR("cmd_create_session_2_11 hostname is invalid (not NULL terminated)");
 122                 ret = -1;
 123                 goto error;
 124         }
 125
 126         if (base_path_view.size != 0 &&
 127                         base_path_view.data[base_path_view.size - 1] != '\0') {
 128                 ERR("cmd_create_session_2_11 base_path is invalid (not NULL terminated)");
 129                 ret = -1;
 130                 goto error;
 131         }
 132
 133         /*
 134          * Length and null-termination check are already performed.
 135          * LTTNG_NAME_MAX, LTTNG_HOST_NAME_MAX, and LTTNG_PATH_MAX max sizes are expected.
 136          */
 137         strcpy(session_name, session_name_view.data);
 138         strcpy(hostname, hostname_view.data);
 139         strcpy(base_path, base_path_view.size ? base_path_view.data : "");
 140
 141         *live_timer = header.live_timer;
 142         *snapshot = !!header.snapshot;
 143         *current_chunk_id = header.current_chunk_id.value;
 144         *has_current_chunk = header.current_chunk_id.is_set;
 145         *creation_time = (time_t) header.creation_time;
 146         *session_name_contains_creation_time =
 147                 header.session_name_contains_creation_time;
 148
 149         ret = 0;
 150
 151 error:
 152         return ret;
 153 }
 154
 155 /*
 156  * cmd_recv_stream_2_11 allocates path_name and channel_name.
 157  */
 158 int cmd_recv_stream_2_11(const struct lttng_buffer_view *payload,
 159                 char **ret_path_name, char **ret_channel_name,
 160                 uint64_t *tracefile_size, uint64_t *tracefile_count,
 161                 uint64_t *trace_archive_id)
 162 {
 163         int ret;
 164         struct lttcomm_relayd_add_stream_2_11 header;
 165         size_t header_len, received_names_size;
 166         struct lttng_buffer_view channel_name_view;
 167         struct lttng_buffer_view pathname_view;
 168         char *path_name = NULL;
 169         char *channel_name = NULL;
 170
 171         header_len = sizeof(header);
 172
 173         if (payload->size < header_len) {
 174                 ERR("Unexpected payload size in \"cmd_recv_stream_2_11\": expected >= %zu bytes, got %zu bytes",
 175                                 header_len, payload->size);
 176                 ret = -1;
 177                 goto error;
 178         }
 179         memcpy(&header, payload->data, header_len);
 180
 181         header.channel_name_len = be32toh(header.channel_name_len);
 182         header.pathname_len = be32toh(header.pathname_len);
 183         header.tracefile_size = be64toh(header.tracefile_size);
 184         header.tracefile_count = be64toh(header.tracefile_count);
 185         header.trace_chunk_id = be64toh(header.trace_chunk_id);
 186
 187         received_names_size = header.channel_name_len + header.pathname_len;
 188         if (payload->size < header_len + received_names_size) {
 189                 ERR("Unexpected payload size in \"cmd_recv_stream_2_11\": expected >= %zu bytes, got %zu bytes",
 190                                 header_len + received_names_size, payload->size);
 191                 ret = -1;
 192                 goto error;
 193         }
 194
 195         /* Validate length against defined constant. */
 196         if (header.channel_name_len > DEFAULT_STREAM_NAME_LEN) {
 197                 ret = -ENAMETOOLONG;
 198                 ERR("Channel name too long");
 199                 goto error;
 200         }
 201         if (header.pathname_len > LTTNG_NAME_MAX) {
 202                 ret = -ENAMETOOLONG;
 203                 ERR("Pathname too long");
 204                 goto error;
 205         }
 206
 207         /* Validate that names are (NULL terminated. */
 208         channel_name_view = lttng_buffer_view_from_view(payload, header_len,
 209                         header.channel_name_len);
 210         if (!lttng_buffer_view_is_valid(&channel_name_view)) {
 211                 ERR("Invalid payload received in \"cmd_recv_stream_2_11\": buffer too short for channel name");
 212                 ret = -1;
 213                 goto error;
 214         }
 215
 216         if (channel_name_view.data[channel_name_view.size - 1] != '\0') {
 217                 ERR("cmd_recv_stream_2_11 channel_name is invalid (not NULL terminated)");
 218                 ret = -1;
 219                 goto error;
 220         }
 221
 222         pathname_view = lttng_buffer_view_from_view(payload,
 223                         header_len + header.channel_name_len, header.pathname_len);
 224         if (!lttng_buffer_view_is_valid(&pathname_view)) {
 225                 ERR("Invalid payload received in \"cmd_recv_stream_2_11\": buffer too short for path name");
 226                 ret = -1;
 227                 goto error;
 228         }
 229
 230         if (pathname_view.data[pathname_view.size - 1] != '\0') {
 231                 ERR("cmd_recv_stream_2_11 patname is invalid (not NULL terminated)");
 232                 ret = -1;
 233                 goto error;
 234         }
 235
 236         channel_name = strdup(channel_name_view.data);
 237         if (!channel_name) {
 238                 ret = -errno;
 239                 PERROR("Channel name allocation");
 240                 goto error;
 241         }
 242
 243         path_name = strdup(pathname_view.data);
 244         if (!path_name) {
 245                 PERROR("Path name allocation");
 246                 ret = -ENOMEM;
 247                 goto error;
 248         }
 249
 250         *tracefile_size = header.tracefile_size;
 251         *tracefile_count = header.tracefile_count;
 252         *trace_archive_id = header.trace_chunk_id;
 253         *ret_path_name = path_name;
 254         *ret_channel_name = channel_name;
 255         /* Move ownership to caller */
 256         path_name = NULL;
 257         channel_name = NULL;
 258         ret = 0;
 259 error:
 260         free(channel_name);
 261         free(path_name);
 262         return ret;
 263 }