src/plugins/ctf/lttng-live/metadata.c

   1 /*
   2  * Copyright 2019 - Francis Deslauriers <francis.deslauriers@efficios.com>
   3  * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
   4  * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
   5  *
   6  * Some functions are based on older functions written by Mathieu Desnoyers.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #define BT_COMP_LOG_SELF_COMP self_comp
  28 #define BT_LOG_OUTPUT_LEVEL log_level
  29 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META"
  30 #include "logging/comp-logging.h"
  31
  32 #include <stdio.h>
  33 #include <stdint.h>
  34 #include <stdlib.h>
  35 #include <stdbool.h>
  36 #include <glib.h>
  37 #include "compat/memstream.h"
  38 #include <babeltrace2/babeltrace.h>
  39
  40 #include "metadata.h"
  41 #include "../common/metadata/decoder.h"
  42 #include "../common/metadata/ctf-meta-configure-ir-trace.h"
  43
  44 #define TSDL_MAGIC      0x75d11d57
  45
  46 struct packet_header {
  47         uint32_t magic;
  48         uint8_t  uuid[16];
  49         uint32_t checksum;
  50         uint32_t content_size;
  51         uint32_t packet_size;
  52         uint8_t  compression_scheme;
  53         uint8_t  encryption_scheme;
  54         uint8_t  checksum_scheme;
  55         uint8_t  major;
  56         uint8_t  minor;
  57 } __attribute__((__packed__));
  58
  59
  60 static
  61 bool stream_classes_all_have_default_clock_class(bt_trace_class *tc,
  62                 bt_logging_level log_level,
  63                 bt_self_component *self_comp)
  64 {
  65         uint64_t i, sc_count;
  66         const bt_clock_class *cc = NULL;
  67         const bt_stream_class *sc;
  68         bool ret = true;
  69
  70         sc_count = bt_trace_class_get_stream_class_count(tc);
  71         for (i = 0; i < sc_count; i++) {
  72                 sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
  73
  74                 BT_ASSERT(sc);
  75
  76                 cc = bt_stream_class_borrow_default_clock_class_const(sc);
  77                 if (!cc) {
  78                         ret = false;
  79                         BT_COMP_LOGE_APPEND_CAUSE(self_comp,
  80                                 "Stream class doesn't have a default clock class: "
  81                                 "sc-id=%" PRIu64 ", sc-name=\"%s\"",
  82                                 bt_stream_class_get_id(sc),
  83                                 bt_stream_class_get_name(sc));
  84                         goto end;
  85                 }
  86         }
  87
  88 end:
  89         return ret;
  90 }
  91 /*
  92  * Iterate over the stream classes and returns the first clock class
  93  * encountered. This is useful to create message iterator inactivity message as
  94  * we don't need a particular clock class.
  95  */
  96 static
  97 const bt_clock_class *borrow_any_clock_class(bt_trace_class *tc)
  98 {
  99         uint64_t i, sc_count;
 100         const bt_clock_class *cc = NULL;
 101         const bt_stream_class *sc;
 102
 103         sc_count = bt_trace_class_get_stream_class_count(tc);
 104         for (i = 0; i < sc_count; i++) {
 105                 sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
 106                 BT_ASSERT_DBG(sc);
 107
 108                 cc = bt_stream_class_borrow_default_clock_class_const(sc);
 109                 if (cc) {
 110                         goto end;
 111                 }
 112         }
 113 end:
 114         BT_ASSERT_DBG(cc);
 115         return cc;
 116 }
 117
 118 BT_HIDDEN
 119 enum lttng_live_iterator_status lttng_live_metadata_update(
 120                 struct lttng_live_trace *trace)
 121 {
 122         struct lttng_live_session *session = trace->session;
 123         struct lttng_live_metadata *metadata = trace->metadata;
 124         size_t size, len_read = 0;
 125         char *metadata_buf = NULL;
 126         bool keep_receiving;
 127         FILE *fp = NULL;
 128         enum ctf_metadata_decoder_status decoder_status;
 129         enum lttng_live_iterator_status status =
 130                 LTTNG_LIVE_ITERATOR_STATUS_OK;
 131         bt_logging_level log_level = trace->log_level;
 132         bt_self_component *self_comp = trace->self_comp;
 133         enum lttng_live_get_one_metadata_status metadata_status;
 134
 135         /* No metadata stream yet. */
 136         if (!metadata) {
 137                 if (session->new_streams_needed) {
 138                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 139                 } else {
 140                         session->new_streams_needed = true;
 141                         status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
 142                 }
 143                 goto end;
 144         }
 145
 146         if (!metadata->trace) {
 147                 trace->new_metadata_needed = false;
 148         }
 149
 150         if (!trace->new_metadata_needed) {
 151                 goto end;
 152         }
 153
 154         /*
 155          * Open a new write only file handle to populate the `metadata_buf`
 156          * memory buffer so we can write in loop in it easily.
 157          */
 158         fp = bt_open_memstream(&metadata_buf, &size);
 159         if (!fp) {
 160                 if (errno == EINTR &&
 161                                 lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
 162                         session->lttng_live_msg_iter->was_interrupted = true;
 163                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 164                 } else {
 165                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 166                                 "Metadata open_memstream", ".");
 167                         status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 168                 }
 169                 goto end;
 170         }
 171
 172         keep_receiving = true;
 173         /* Grab all available metadata. */
 174         while (keep_receiving) {
 175                 size_t reply_len = 0;
 176                 /*
 177                  * lttng_live_get_one_metadata_packet() asks the Relay Daemon
 178                  * for new metadata. If new metadata is received, the function
 179                  * writes it to the provided file handle and updates the
 180                  * reply_len output parameter. We call this function in loop
 181                  * until it returns _END meaning that no new metadata is
 182                  * available.
 183                  * We may receive a _CLOSED status if the metadata stream we
 184                  * are requesting is no longer available on the relay.
 185                  * If we receive an _ERROR status, it means there was a
 186                  * networking, allocating, or some other unrecoverable error.
 187                  */
 188                 metadata_status = lttng_live_get_one_metadata_packet(trace, fp,
 189                         &reply_len);
 190
 191                 switch (metadata_status) {
 192                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK:
 193                         len_read += reply_len;
 194                         break;
 195                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END:
 196                         keep_receiving = false;
 197                         break;
 198                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED:
 199                         keep_receiving = false;
 200                         break;
 201                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR:
 202                         goto error;
 203                 default:
 204                         bt_common_abort();
 205                 }
 206         }
 207
 208         /*
 209          * A closed metadata stream means the trace is no longer active. Return
 210          * _END so that the caller can remove the trace from its list.
 211          */
 212         if (metadata_status == LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED) {
 213                 status = LTTNG_LIVE_ITERATOR_STATUS_END;
 214                 goto end;
 215         }
 216
 217         /* The memory buffer `metadata_buf` contains all the metadata. */
 218         if (bt_close_memstream(&metadata_buf, &size, fp)) {
 219                 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 220                         "Metadata bt_close_memstream", ".");
 221         }
 222
 223         fp = NULL;
 224
 225         if (len_read == 0) {
 226                 if (!trace->trace) {
 227                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 228                         goto end;
 229                 }
 230                 trace->new_metadata_needed = false;
 231                 goto end;
 232         }
 233
 234         /*
 235          * Open a new reading file handle on the `metadata_buf` and pass it to
 236          * the metadata decoder.
 237          */
 238         fp = bt_fmemopen(metadata_buf, len_read, "rb");
 239         if (!fp) {
 240                 if (errno == EINTR &&
 241                                 lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
 242                         session->lttng_live_msg_iter->was_interrupted = true;
 243                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 244                 } else {
 245                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 246                                 "Cannot memory-open metadata buffer", ".");
 247                         status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 248                 }
 249                 goto end;
 250         }
 251
 252         /*
 253          * The call to ctf_metadata_decoder_append_content() will append
 254          * new metadata to our current trace class.
 255          */
 256         decoder_status = ctf_metadata_decoder_append_content(
 257                 metadata->decoder, fp);
 258         switch (decoder_status) {
 259         case CTF_METADATA_DECODER_STATUS_OK:
 260                 if (!trace->trace_class) {
 261                         struct ctf_trace_class *tc =
 262                                 ctf_metadata_decoder_borrow_ctf_trace_class(
 263                                         metadata->decoder);
 264
 265                         trace->trace_class =
 266                                 ctf_metadata_decoder_get_ir_trace_class(
 267                                                 metadata->decoder);
 268                         trace->trace = bt_trace_create(trace->trace_class);
 269                         if (!trace->trace) {
 270                                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 271                                         "Failed to create bt_trace");
 272                                 goto error;
 273                         }
 274                         if (ctf_trace_class_configure_ir_trace(tc,
 275                                         trace->trace)) {
 276                                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 277                                         "Failed to configure ctf trace class");
 278                                 goto error;
 279                         }
 280                         if (!stream_classes_all_have_default_clock_class(
 281                                         trace->trace_class, log_level,
 282                                         self_comp)) {
 283                                 /* Error logged in function. */
 284                                 goto error;
 285                         }
 286                         trace->clock_class =
 287                                 borrow_any_clock_class(trace->trace_class);
 288                 }
 289                 trace->new_metadata_needed = false;
 290
 291                 break;
 292         case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
 293                 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 294                 break;
 295         default:
 296                 goto error;
 297         }
 298
 299         goto end;
 300
 301 error:
 302         status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 303 end:
 304         if (fp) {
 305                 int closeret;
 306
 307                 closeret = fclose(fp);
 308                 if (closeret) {
 309                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 310                                 "Error on fclose", ".");
 311                 }
 312         }
 313         free(metadata_buf);
 314         return status;
 315 }
 316
 317 BT_HIDDEN
 318 int lttng_live_metadata_create_stream(struct lttng_live_session *session,
 319                 uint64_t ctf_trace_id, uint64_t stream_id,
 320                 const char *trace_name)
 321 {
 322         bt_self_component *self_comp = session->self_comp;
 323         bt_logging_level log_level = session->log_level;
 324         struct lttng_live_metadata *metadata = NULL;
 325         struct lttng_live_trace *trace;
 326         struct ctf_metadata_decoder_config cfg = {
 327                 .log_level = session->log_level,
 328                 .self_comp = session->self_comp,
 329                 .clock_class_offset_s = 0,
 330                 .clock_class_offset_ns = 0,
 331                 .create_trace_class = true,
 332         };
 333
 334         metadata = g_new0(struct lttng_live_metadata, 1);
 335         if (!metadata) {
 336                 return -1;
 337         }
 338         metadata->log_level = session->log_level;
 339         metadata->self_comp = session->self_comp;
 340         metadata->stream_id = stream_id;
 341
 342         metadata->decoder = ctf_metadata_decoder_create(&cfg);
 343         if (!metadata->decoder) {
 344                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 345                         "Failed to create CTF metadata decoder");
 346                 goto error;
 347         }
 348         trace = lttng_live_borrow_trace(session, ctf_trace_id);
 349         if (!trace) {
 350                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 351                         "Failed to borrow trace");
 352                 goto error;
 353         }
 354         metadata->trace = trace;
 355         trace->metadata = metadata;
 356         return 0;
 357
 358 error:
 359         ctf_metadata_decoder_destroy(metadata->decoder);
 360         g_free(metadata);
 361         return -1;
 362 }
 363
 364 BT_HIDDEN
 365 void lttng_live_metadata_fini(struct lttng_live_trace *trace)
 366 {
 367         struct lttng_live_metadata *metadata = trace->metadata;
 368
 369         if (!metadata) {
 370                 return;
 371         }
 372         ctf_metadata_decoder_destroy(metadata->decoder);
 373         trace->metadata = NULL;
 374         g_free(metadata);
 375 }