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         /* Open for writing */
 155         fp = bt_open_memstream(&metadata_buf, &size);
 156         if (!fp) {
 157                 if (errno == EINTR &&
 158                                 lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
 159                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 160                 } else {
 161                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 162                                 "Metadata open_memstream", ".");
 163                         status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 164                 }
 165                 goto end;
 166         }
 167
 168         keep_receiving = true;
 169         /* Grab all available metadata. */
 170         while (keep_receiving) {
 171                 size_t reply_len = 0;
 172                 /*
 173                  * lttng_live_get_one_metadata_packet() asks the Relay Daemon
 174                  * for new metadata. If new metadata is received, the function
 175                  * writes it to the provided file handle and updates the
 176                  * reply_len output parameter. We call this function in loop
 177                  * until it returns _END meaning that no new metadata is
 178                  * available.
 179                  * We may receive a _CLOSED status if the metadata stream we
 180                  * are requesting is no longer available on the relay.
 181                  * If we receive an _ERROR status, it means there was a
 182                  * networking, allocating, or some other unrecoverable error.
 183                  */
 184                 metadata_status = lttng_live_get_one_metadata_packet(trace, fp,
 185                         &reply_len);
 186
 187                 switch (metadata_status) {
 188                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK:
 189                         len_read += reply_len;
 190                         break;
 191                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END:
 192                         keep_receiving = false;
 193                         break;
 194                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED:
 195                         keep_receiving = false;
 196                         break;
 197                 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR:
 198                         goto error;
 199                 default:
 200                         bt_common_abort();
 201                 }
 202         }
 203
 204         /*
 205          * A closed metadata stream means the trace is no longer active. Return
 206          * _END so that the caller can remove the trace from its list.
 207          */
 208         if (metadata_status == LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED) {
 209                 status = LTTNG_LIVE_ITERATOR_STATUS_END;
 210                 goto end;
 211         }
 212
 213         if (bt_close_memstream(&metadata_buf, &size, fp)) {
 214                 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 215                         "Metadata bt_close_memstream", ".");
 216         }
 217
 218         fp = NULL;
 219
 220         if (len_read == 0) {
 221                 if (!trace->trace) {
 222                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 223                         goto end;
 224                 }
 225                 trace->new_metadata_needed = false;
 226                 goto end;
 227         }
 228
 229         fp = bt_fmemopen(metadata_buf, len_read, "rb");
 230         if (!fp) {
 231                 if (errno == EINTR &&
 232                                 lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
 233                         status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 234                 } else {
 235                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 236                                 "Cannot memory-open metadata buffer", ".");
 237                         status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 238                 }
 239                 goto end;
 240         }
 241
 242         /*
 243          * The call to ctf_metadata_decoder_append_content() will append
 244          * new metadata to our current trace class.
 245          */
 246         decoder_status = ctf_metadata_decoder_append_content(
 247                 metadata->decoder, fp);
 248         switch (decoder_status) {
 249         case CTF_METADATA_DECODER_STATUS_OK:
 250                 if (!trace->trace_class) {
 251                         struct ctf_trace_class *tc =
 252                                 ctf_metadata_decoder_borrow_ctf_trace_class(
 253                                         metadata->decoder);
 254
 255                         trace->trace_class =
 256                                 ctf_metadata_decoder_get_ir_trace_class(
 257                                                 metadata->decoder);
 258                         trace->trace = bt_trace_create(trace->trace_class);
 259                         if (!trace->trace) {
 260                                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 261                                         "Failed to create bt_trace");
 262                                 goto error;
 263                         }
 264                         if (ctf_trace_class_configure_ir_trace(tc,
 265                                         trace->trace)) {
 266                                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 267                                         "Failed to configure ctf trace class");
 268                                 goto error;
 269                         }
 270                         if (!stream_classes_all_have_default_clock_class(
 271                                         trace->trace_class, log_level,
 272                                         self_comp)) {
 273                                 /* Error logged in function. */
 274                                 goto error;
 275                         }
 276                         trace->clock_class =
 277                                 borrow_any_clock_class(trace->trace_class);
 278                 }
 279                 trace->new_metadata_needed = false;
 280
 281                 break;
 282         case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
 283                 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
 284                 break;
 285         default:
 286                 goto error;
 287         }
 288
 289         goto end;
 290
 291 error:
 292         status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 293 end:
 294         if (fp) {
 295                 int closeret;
 296
 297                 closeret = fclose(fp);
 298                 if (closeret) {
 299                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 300                                 "Error on fclose", ".");
 301                 }
 302         }
 303         free(metadata_buf);
 304         return status;
 305 }
 306
 307 BT_HIDDEN
 308 int lttng_live_metadata_create_stream(struct lttng_live_session *session,
 309                 uint64_t ctf_trace_id, uint64_t stream_id,
 310                 const char *trace_name)
 311 {
 312         bt_self_component *self_comp = session->self_comp;
 313         bt_logging_level log_level = session->log_level;
 314         struct lttng_live_metadata *metadata = NULL;
 315         struct lttng_live_trace *trace;
 316         struct ctf_metadata_decoder_config cfg = {
 317                 .log_level = session->log_level,
 318                 .self_comp = session->self_comp,
 319                 .clock_class_offset_s = 0,
 320                 .clock_class_offset_ns = 0,
 321                 .create_trace_class = true,
 322         };
 323
 324         metadata = g_new0(struct lttng_live_metadata, 1);
 325         if (!metadata) {
 326                 return -1;
 327         }
 328         metadata->log_level = session->log_level;
 329         metadata->self_comp = session->self_comp;
 330         metadata->stream_id = stream_id;
 331
 332         metadata->decoder = ctf_metadata_decoder_create(&cfg);
 333         if (!metadata->decoder) {
 334                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 335                         "Failed to create CTF metadata decoder");
 336                 goto error;
 337         }
 338         trace = lttng_live_borrow_trace(session, ctf_trace_id);
 339         if (!trace) {
 340                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 341                         "Failed to borrow trace");
 342                 goto error;
 343         }
 344         metadata->trace = trace;
 345         trace->metadata = metadata;
 346         return 0;
 347
 348 error:
 349         ctf_metadata_decoder_destroy(metadata->decoder);
 350         g_free(metadata);
 351         return -1;
 352 }
 353
 354 BT_HIDDEN
 355 void lttng_live_metadata_fini(struct lttng_live_trace *trace)
 356 {
 357         struct lttng_live_metadata *metadata = trace->metadata;
 358
 359         if (!metadata) {
 360                 return;
 361         }
 362         ctf_metadata_decoder_destroy(metadata->decoder);
 363         trace->metadata = NULL;
 364         g_free(metadata);
 365 }