src/plugins/ctf/fs-src/query.cpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  *
   6  * Babeltrace CTF file system Reader Component queries
   7  */
   8
   9 #include <glib.h>
  10 #include <glib/gstdio.h>
  11 #include <sys/types.h>
  12
  13 #include <babeltrace2/babeltrace.h>
  14
  15 #include "cpp-common/bt2/exc.hpp"
  16 #include "cpp-common/bt2c/glib-up.hpp"
  17 #include "cpp-common/bt2c/libc-up.hpp"
  18
  19 #include "plugins/common/param-validation/param-validation.h"
  20
  21 #include "../common/src/metadata/tsdl/decoder.hpp"
  22 #include "data-stream-file.hpp"
  23 #include "fs.hpp"
  24 #include "metadata.hpp"
  25 #include "query.hpp"
  26
  27 #define METADATA_TEXT_SIG "/* CTF 1.8"
  28
  29 struct range
  30 {
  31     int64_t begin_ns = 0;
  32     int64_t end_ns = 0;
  33     bool set = false;
  34 };
  35
  36 static bt_param_validation_map_value_entry_descr metadataInfoQueryParamsDesc[] = {
  37     {"path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY,
  38      bt_param_validation_value_descr::makeString()},
  39     BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END};
  40
  41 bt2::Value::Shared metadata_info_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
  42 {
  43     gchar *validateError = nullptr;
  44     const auto validationStatus = bt_param_validation_validate(
  45         params.libObjPtr(), metadataInfoQueryParamsDesc, &validateError);
  46
  47     if (validationStatus == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
  48         throw bt2::MemoryError {};
  49     } else if (validationStatus == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
  50         const bt2c::GCharUP deleter {validateError};
  51
  52         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "{}", validateError);
  53     }
  54
  55     const auto path = params["path"]->asString().value();
  56     bt2c::FileUP metadataFp {ctf_fs_metadata_open_file(path, logger)};
  57     if (!metadataFp) {
  58         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
  59                                                "Cannot open trace metadata: path=\"{}\".", path);
  60     }
  61
  62     bool is_packetized;
  63     int bo;
  64     int ret = ctf_metadata_decoder_is_packetized(metadataFp.get(), &is_packetized, &bo, logger);
  65
  66     if (ret) {
  67         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
  68             logger, bt2::Error,
  69             "Cannot check whether or not the metadata stream is packetized: path=\"{}\".", path);
  70     }
  71
  72     ctf_metadata_decoder_config decoder_cfg {logger};
  73     decoder_cfg.keep_plain_text = true;
  74     ctf_metadata_decoder_up decoder = ctf_metadata_decoder_create(&decoder_cfg);
  75     if (!decoder) {
  76         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
  77             logger, bt2::Error, "Cannot create metadata decoder: path=\"{}}\".", path);
  78     }
  79
  80     rewind(metadataFp.get());
  81     ctf_metadata_decoder_status decoder_status =
  82         ctf_metadata_decoder_append_content(decoder.get(), metadataFp.get());
  83     if (decoder_status) {
  84         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
  85             logger, bt2::Error, "Cannot update metadata decoder's content: path=\"{}\".", path);
  86     }
  87
  88     const char *plain_text = ctf_metadata_decoder_get_text(decoder.get());
  89     std::string metadata_text;
  90
  91     if (strncmp(plain_text, METADATA_TEXT_SIG, sizeof(METADATA_TEXT_SIG) - 1) != 0) {
  92         metadata_text = METADATA_TEXT_SIG;
  93         metadata_text += " */\n\n";
  94     }
  95
  96     metadata_text += plain_text;
  97
  98     const auto result = bt2::MapValue::create();
  99     result->insert("text", metadata_text);
 100     result->insert("is-packetized", is_packetized);
 101
 102     return result;
 103 }
 104
 105 static void add_range(const bt2::MapValue info, struct range *range, const char *range_name)
 106 {
 107     if (!range->set) {
 108         /* Not an error. */
 109         return;
 110     }
 111
 112     const auto rangeMap = info.insertEmptyMap(range_name);
 113     rangeMap.insert("begin", range->begin_ns);
 114     rangeMap.insert("end", range->end_ns);
 115 }
 116
 117 static void populate_stream_info(struct ctf_fs_ds_file_group *group, const bt2::MapValue groupInfo,
 118                                  struct range *stream_range)
 119 {
 120     /*
 121      * Since each `struct ctf_fs_ds_file_group` has a sorted array of
 122      * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
 123      * the timestamp_begin of the first index entry and the timestamp_end
 124      * of the last index entry.
 125      */
 126     BT_ASSERT(!group->index.entries.empty());
 127
 128     /* First entry. */
 129     const auto& first_ds_index_entry = group->index.entries.front();
 130
 131     /* Last entry. */
 132     const auto& last_ds_index_entry = group->index.entries.back();
 133
 134     stream_range->begin_ns = first_ds_index_entry.timestamp_begin_ns;
 135     stream_range->end_ns = last_ds_index_entry.timestamp_end_ns;
 136
 137     /*
 138      * If any of the begin and end timestamps is not set it means that
 139      * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
 140      * in their packet context so we can't set the range.
 141      */
 142     stream_range->set =
 143         stream_range->begin_ns != UINT64_C(-1) && stream_range->end_ns != UINT64_C(-1);
 144
 145     add_range(groupInfo, stream_range, "range-ns");
 146     groupInfo.insert("port-name", ctf_fs_make_port_name(group));
 147 }
 148
 149 static void populate_trace_info(const struct ctf_fs_trace *trace, const bt2::MapValue traceInfo,
 150                                 const bt2c::Logger& logger)
 151 {
 152     /* Add trace range info only if it contains streams. */
 153     if (trace->ds_file_groups.empty()) {
 154         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
 155                                                "Trace has no streams: trace-path={}", trace->path);
 156     }
 157
 158     const auto fileGroups = traceInfo.insertEmptyArray("stream-infos");
 159
 160     /* Find range of all stream groups, and of the trace. */
 161     for (const auto& group : trace->ds_file_groups) {
 162         range group_range;
 163         const auto groupInfo = fileGroups.appendEmptyMap();
 164         populate_stream_info(group.get(), groupInfo, &group_range);
 165     }
 166 }
 167
 168 bt2::Value::Shared trace_infos_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
 169 {
 170     const auto parameters = read_src_fs_parameters(params, logger);
 171     ctf_fs_component ctf_fs {parameters.clkClsCfg, logger};
 172
 173     if (ctf_fs_component_create_ctf_fs_trace(
 174             &ctf_fs, parameters.inputs,
 175             parameters.traceName ? parameters.traceName->c_str() : nullptr, nullptr)) {
 176         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "Failed to create trace");
 177     }
 178
 179     const auto result = bt2::ArrayValue::create();
 180     const auto traceInfo = result->appendEmptyMap();
 181     populate_trace_info(ctf_fs.trace.get(), traceInfo, logger);
 182
 183     return result;
 184 }
 185
 186 static bt_param_validation_map_value_entry_descr supportInfoQueryParamsDesc[] = {
 187     {"type", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY,
 188      bt_param_validation_value_descr::makeString()},
 189     {"input", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY,
 190      bt_param_validation_value_descr::makeString()},
 191     BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END};
 192
 193 bt2::Value::Shared support_info_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
 194 {
 195     gchar *validateError = NULL;
 196     const auto validationStatus = bt_param_validation_validate(
 197         params.libObjPtr(), supportInfoQueryParamsDesc, &validateError);
 198
 199     if (validationStatus == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
 200         throw bt2::MemoryError {};
 201     } else if (validationStatus == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
 202         const bt2c::GCharUP deleter {validateError};
 203
 204         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "{}", validateError);
 205     }
 206
 207     const auto type = params["type"]->asString().value();
 208
 209     if (strcmp(type, "directory") != 0) {
 210         /*
 211          * The input type is not a directory so we are 100% sure it's not a CTF
 212          * 1.8 trace as it would need a directory with at least 1 metadata file
 213          * and 1 data stream file.
 214          */
 215         const auto result = bt2::MapValue::create();
 216         result->insert("weight", 0.0f);
 217         return result;
 218     }
 219
 220     const auto input = params["input"]->asString().value();
 221
 222     bt2c::GCharUP metadataPath {g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL)};
 223     if (!metadataPath) {
 224         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "Failed to read parameters");
 225     }
 226
 227     double weight = 0;
 228     char uuid_str[BT_UUID_STR_LEN + 1];
 229     bool has_uuid = false;
 230     bt2c::FileUP metadataFile {g_fopen(metadataPath.get(), "rb")};
 231     if (metadataFile) {
 232         enum ctf_metadata_decoder_status decoder_status;
 233         bt_uuid_t uuid;
 234
 235         ctf_metadata_decoder_config metadata_decoder_config {logger};
 236
 237         ctf_metadata_decoder_up metadata_decoder =
 238             ctf_metadata_decoder_create(&metadata_decoder_config);
 239         if (!metadata_decoder) {
 240             BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
 241                                                    "Failed to create metadata decoder");
 242         }
 243
 244         decoder_status =
 245             ctf_metadata_decoder_append_content(metadata_decoder.get(), metadataFile.get());
 246         if (decoder_status != CTF_METADATA_DECODER_STATUS_OK) {
 247             BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
 248                 logger, bt2::Error, "Failed to append metadata content: metadata-decoder-status={}",
 249                 decoder_status);
 250         }
 251
 252         /*
 253          * We were able to parse the metadata file, so we are
 254          * confident it's a CTF trace.
 255          */
 256         weight = 0.75;
 257
 258         /* If the trace has a UUID, return the stringified UUID as the group. */
 259         if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder.get(), uuid) == 0) {
 260             bt_uuid_to_str(uuid, uuid_str);
 261             has_uuid = true;
 262         }
 263     }
 264
 265     const auto result = bt2::MapValue::create();
 266     result->insert("weight", weight);
 267
 268     /* We are not supposed to have weight == 0 and a UUID. */
 269     BT_ASSERT(weight > 0 || !has_uuid);
 270
 271     if (weight > 0 && has_uuid) {
 272         result->insert("group", uuid_str);
 273     }
 274
 275     return result;
 276 }