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