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

   1 /*
   2  * query.c
   3  *
   4  * Babeltrace CTF file system Reader Component queries
   5  *
   6  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   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_LOG_OUTPUT_LEVEL log_level
  28 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
  29 #include "logging/log.h"
  30
  31 #include "query.h"
  32 #include <stdbool.h>
  33 #include <glib.h>
  34 #include <glib/gstdio.h>
  35 #include <fcntl.h>
  36 #include <sys/types.h>
  37 #include <sys/stat.h>
  38 #include "common/assert.h"
  39 #include "metadata.h"
  40 #include "../common/metadata/decoder.h"
  41 #include "common/common.h"
  42 #include "common/macros.h"
  43 #include <babeltrace2/babeltrace.h>
  44 #include "fs.h"
  45 #include "logging/comp-logging.h"
  46
  47 #define METADATA_TEXT_SIG       "/* CTF 1.8"
  48
  49 struct range {
  50         int64_t begin_ns;
  51         int64_t end_ns;
  52         bool set;
  53 };
  54
  55 BT_HIDDEN
  56 bt_component_class_query_method_status metadata_info_query(
  57                 bt_self_component_class_source *self_comp_class_src,
  58                 const bt_value *params, bt_logging_level log_level,
  59                 const bt_value **user_result)
  60 {
  61         bt_component_class_query_method_status status =
  62                 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
  63         bt_self_component_class *self_comp_class =
  64                 bt_self_component_class_source_as_self_component_class(self_comp_class_src);
  65         bt_value *result = NULL;
  66         const bt_value *path_value = NULL;
  67         FILE *metadata_fp = NULL;
  68         int ret;
  69         int bo;
  70         const char *path;
  71         bool is_packetized;
  72         struct ctf_metadata_decoder *decoder = NULL;
  73         struct ctf_metadata_decoder_config decoder_cfg = { 0 };
  74         enum ctf_metadata_decoder_status decoder_status;
  75
  76         result = bt_value_map_create();
  77         if (!result) {
  78                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
  79                 goto error;
  80         }
  81
  82         BT_ASSERT(params);
  83
  84         if (!bt_value_is_map(params)) {
  85                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
  86                         "Query parameters is not a map value object.");
  87                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
  88                 goto error;
  89         }
  90
  91         path_value = bt_value_map_borrow_entry_value_const(params, "path");
  92         if (!path_value) {
  93                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
  94                         "Mandatory `path` parameter missing");
  95                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
  96                 goto error;
  97         }
  98
  99         if (!bt_value_is_string(path_value)) {
 100                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 101                         "`path` parameter is required to be a string value");
 102                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 103                 goto error;
 104         }
 105
 106         path = bt_value_string_get(path_value);
 107
 108         BT_ASSERT(path);
 109         metadata_fp = ctf_fs_metadata_open_file(path);
 110         if (!metadata_fp) {
 111                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 112                         "Cannot open trace metadata: path=\"%s\".", path);
 113                 goto error;
 114         }
 115
 116         ret = ctf_metadata_decoder_is_packetized(metadata_fp, &is_packetized,
 117                 &bo, log_level, NULL);
 118         if (ret) {
 119                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 120                         "Cannot check whether or not the metadata stream is packetized: path=\"%s\".",
 121                         path);
 122                 goto error;
 123         }
 124
 125         decoder_cfg.log_level = log_level;
 126         decoder_cfg.keep_plain_text = true;
 127         decoder = ctf_metadata_decoder_create(&decoder_cfg);
 128         if (!decoder) {
 129                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 130                         "Cannot create metadata decoder: path=\"%s\".", path);
 131                 goto error;
 132         }
 133
 134         rewind(metadata_fp);
 135         decoder_status = ctf_metadata_decoder_append_content(decoder,
 136                 metadata_fp);
 137         if (decoder_status) {
 138                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 139                         "Cannot update metadata decoder's content: path=\"%s\".",
 140                         path);
 141                 goto error;
 142         }
 143
 144         ret = bt_value_map_insert_string_entry(result, "text",
 145                 ctf_metadata_decoder_get_text(decoder));
 146         if (ret) {
 147                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 148                         "Cannot insert metadata text into query result.");
 149                 goto error;
 150         }
 151
 152         ret = bt_value_map_insert_bool_entry(result, "is-packetized",
 153                 is_packetized);
 154         if (ret) {
 155                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 156                         "Cannot insert \"is-packetized\" attribute into query result.");
 157                 goto error;
 158         }
 159
 160         goto end;
 161
 162 error:
 163         BT_VALUE_PUT_REF_AND_RESET(result);
 164         result = NULL;
 165
 166         if (status >= 0) {
 167                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 168         }
 169
 170 end:
 171         ctf_metadata_decoder_destroy(decoder);
 172
 173         if (metadata_fp) {
 174                 ret = fclose(metadata_fp);
 175                 if (ret) {
 176                         BT_LOGE_ERRNO("Cannot close metatada file stream",
 177                                 ": path=\"%s\"", path);
 178                 }
 179         }
 180
 181         *user_result = result;
 182         return status;
 183 }
 184
 185 static
 186 int add_range(bt_value *info, struct range *range,
 187                 const char *range_name)
 188 {
 189         int ret = 0;
 190         bt_value_map_insert_entry_status status;
 191         bt_value *range_map;
 192
 193         if (!range->set) {
 194                 /* Not an error. */
 195                 goto end;
 196         }
 197
 198         status = bt_value_map_insert_empty_map_entry(info, range_name,
 199                 &range_map);
 200         if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 201                 ret = -1;
 202                 goto end;
 203         }
 204
 205         status = bt_value_map_insert_signed_integer_entry(range_map, "begin",
 206                         range->begin_ns);
 207         if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 208                 ret = -1;
 209                 goto end;
 210         }
 211
 212         status = bt_value_map_insert_signed_integer_entry(range_map, "end",
 213                         range->end_ns);
 214         if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 215                 ret = -1;
 216                 goto end;
 217         }
 218
 219 end:
 220         return ret;
 221 }
 222
 223 static
 224 int populate_stream_info(struct ctf_fs_ds_file_group *group,
 225                 bt_value *group_info, struct range *stream_range)
 226 {
 227         int ret = 0;
 228         bt_value_map_insert_entry_status insert_status;
 229         struct ctf_fs_ds_index_entry *first_ds_index_entry, *last_ds_index_entry;
 230         gchar *port_name = NULL;
 231
 232         /*
 233          * Since each `struct ctf_fs_ds_file_group` has a sorted array of
 234          * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
 235          * the timestamp_begin of the first index entry and the timestamp_end
 236          * of the last index entry.
 237          */
 238         BT_ASSERT(group->index);
 239         BT_ASSERT(group->index->entries);
 240         BT_ASSERT(group->index->entries->len > 0);
 241
 242         /* First entry. */
 243         first_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
 244                 group->index->entries, 0);
 245
 246         /* Last entry. */
 247         last_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
 248                 group->index->entries, group->index->entries->len - 1);
 249
 250         stream_range->begin_ns = first_ds_index_entry->timestamp_begin_ns;
 251         stream_range->end_ns = last_ds_index_entry->timestamp_end_ns;
 252
 253         /*
 254          * If any of the begin and end timestamps is not set it means that
 255          * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
 256          * in their packet context so we can't set the range.
 257          */
 258         stream_range->set = stream_range->begin_ns != UINT64_C(-1) &&
 259                 stream_range->end_ns != UINT64_C(-1);
 260
 261         ret = add_range(group_info, stream_range, "range-ns");
 262         if (ret) {
 263                 goto end;
 264         }
 265
 266         port_name = ctf_fs_make_port_name(group);
 267         if (!port_name) {
 268                 ret = -1;
 269                 goto end;
 270         }
 271
 272         insert_status = bt_value_map_insert_string_entry(group_info,
 273                 "port-name", port_name);
 274         if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 275                 ret = -1;
 276                 goto end;
 277         }
 278
 279 end:
 280         g_free(port_name);
 281         return ret;
 282 }
 283
 284 static
 285 int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info,
 286                 bt_logging_level log_level,
 287                 bt_self_component_class *self_comp_class)
 288 {
 289         int ret = 0;
 290         size_t group_idx;
 291         bt_value_map_insert_entry_status insert_status;
 292         bt_value_array_append_element_status append_status;
 293         bt_value *file_groups = NULL;
 294
 295         BT_ASSERT(trace->ds_file_groups);
 296         /* Add trace range info only if it contains streams. */
 297         if (trace->ds_file_groups->len == 0) {
 298                 ret = -1;
 299                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 300                         "Trace has no streams: trace-path=%s", trace->path->str);
 301                 goto end;
 302         }
 303
 304         insert_status = bt_value_map_insert_empty_array_entry(trace_info,
 305                 "stream-infos", &file_groups);
 306         if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 307                 ret = -1;
 308                 goto end;
 309         }
 310
 311         /* Find range of all stream groups, and of the trace. */
 312         for (group_idx = 0; group_idx < trace->ds_file_groups->len;
 313                         group_idx++) {
 314                 bt_value *group_info;
 315                 struct range group_range = { .set = false };
 316                 struct ctf_fs_ds_file_group *group = g_ptr_array_index(
 317                                 trace->ds_file_groups, group_idx);
 318
 319                 append_status = bt_value_array_append_empty_map_element(
 320                         file_groups, &group_info);
 321                 if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
 322                         ret = -1;
 323                         goto end;
 324                 }
 325
 326                 ret = populate_stream_info(group, group_info, &group_range);
 327                 if (ret) {
 328                         goto end;
 329                 }
 330         }
 331
 332 end:
 333         return ret;
 334 }
 335
 336 BT_HIDDEN
 337 bt_component_class_query_method_status trace_infos_query(
 338                 bt_self_component_class_source *self_comp_class_src,
 339                 const bt_value *params, bt_logging_level log_level,
 340                 const bt_value **user_result)
 341 {
 342         struct ctf_fs_component *ctf_fs = NULL;
 343         bt_component_class_query_method_status status =
 344                 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
 345         bt_self_component_class *self_comp_class =
 346                 bt_self_component_class_source_as_self_component_class(
 347                         self_comp_class_src);
 348         bt_value *result = NULL;
 349         const bt_value *inputs_value = NULL;
 350         const bt_value *trace_name_value;
 351         int ret = 0;
 352         bt_value *trace_info = NULL;
 353         bt_value_array_append_element_status append_status;
 354
 355         BT_ASSERT(params);
 356
 357         if (!bt_value_is_map(params)) {
 358                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 359                         "Query parameters is not a map value object.");
 360                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 361                 goto error;
 362         }
 363
 364         ctf_fs = ctf_fs_component_create(log_level, NULL);
 365         if (!ctf_fs) {
 366                 goto error;
 367         }
 368
 369         if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value,
 370                         ctf_fs, NULL, self_comp_class)) {
 371                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 372                 goto error;
 373         }
 374
 375         if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value,
 376                         trace_name_value, NULL, self_comp_class)) {
 377                 goto error;
 378         }
 379
 380         result = bt_value_array_create();
 381         if (!result) {
 382                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
 383                 goto error;
 384         }
 385
 386         append_status = bt_value_array_append_empty_map_element(result,
 387                 &trace_info);
 388         if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
 389                 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
 390                         "Failed to create trace info map.");
 391                 goto error;
 392         }
 393
 394         ret = populate_trace_info(ctf_fs->trace, trace_info, log_level,
 395                 self_comp_class);
 396         if (ret) {
 397                 goto error;
 398         }
 399
 400         goto end;
 401
 402 error:
 403         BT_VALUE_PUT_REF_AND_RESET(result);
 404
 405         if (status >= 0) {
 406                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 407         }
 408
 409 end:
 410         if (ctf_fs) {
 411                 ctf_fs_destroy(ctf_fs);
 412                 ctf_fs = NULL;
 413         }
 414
 415         *user_result = result;
 416         return status;
 417 }
 418
 419 BT_HIDDEN
 420 bt_component_class_query_method_status support_info_query(
 421                 bt_self_component_class_source *comp_class,
 422                 const bt_value *params, bt_logging_level log_level,
 423                 const bt_value **user_result)
 424 {
 425         const bt_value *input_type_value;
 426         const char *input_type;
 427         bt_component_class_query_method_status status;
 428         bt_value_map_insert_entry_status insert_entry_status;
 429         double weight = 0;
 430         gchar *metadata_path = NULL;
 431         bt_value *result = NULL;
 432         struct ctf_metadata_decoder *metadata_decoder = NULL;
 433         FILE *metadata_file = NULL;
 434         char uuid_str[BT_UUID_STR_LEN + 1];
 435         bool has_uuid = false;
 436         const bt_value *input_value;
 437         const char *input;
 438
 439         input_type_value = bt_value_map_borrow_entry_value_const(params, "type");
 440         BT_ASSERT(input_type_value);
 441         BT_ASSERT(bt_value_get_type(input_type_value) == BT_VALUE_TYPE_STRING);
 442         input_type = bt_value_string_get(input_type_value);
 443
 444         if (strcmp(input_type, "directory") != 0) {
 445                 goto create_result;
 446         }
 447
 448         input_value = bt_value_map_borrow_entry_value_const(params, "input");
 449         BT_ASSERT(input_value);
 450         BT_ASSERT(bt_value_get_type(input_value) == BT_VALUE_TYPE_STRING);
 451         input = bt_value_string_get(input_value);
 452
 453         metadata_path = g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL);
 454         if (!metadata_path) {
 455                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
 456                 goto end;
 457         }
 458
 459         metadata_file = g_fopen(metadata_path, "rb");
 460         if (metadata_file) {
 461                 struct ctf_metadata_decoder_config metadata_decoder_config = { 0 };
 462                 enum ctf_metadata_decoder_status decoder_status;
 463                 bt_uuid_t uuid;
 464
 465                 metadata_decoder_config.log_level = log_level;
 466
 467                 metadata_decoder = ctf_metadata_decoder_create(
 468                         &metadata_decoder_config);
 469                 if (!metadata_decoder) {
 470                         status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 471                         goto end;
 472                 }
 473
 474                 decoder_status = ctf_metadata_decoder_append_content(
 475                         metadata_decoder, metadata_file);
 476                 if (decoder_status != CTF_METADATA_DECODER_STATUS_OK) {
 477                         BT_LOGW("cannot append metadata content: metadata-decoder-status=%d",
 478                                 decoder_status);
 479                         status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
 480                         goto end;
 481                 }
 482
 483                 /*
 484                  * We were able to parse the metadata file, so we are
 485                  * confident it's a CTF trace.
 486                  */
 487                 weight = 0.75;
 488
 489                 /* If the trace has a UUID, return the stringified UUID as the group. */
 490                 if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder, uuid) == 0) {
 491                         bt_uuid_to_str(uuid, uuid_str);
 492                         has_uuid = true;
 493                 }
 494         }
 495
 496 create_result:
 497         result = bt_value_map_create();
 498         if (!result) {
 499                 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
 500                 goto end;
 501         }
 502
 503         insert_entry_status = bt_value_map_insert_real_entry(result, "weight", weight);
 504         if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 505                 status = (int) insert_entry_status;
 506                 goto end;
 507         }
 508
 509         /* We are not supposed to have weight == 0 and a UUID. */
 510         BT_ASSERT(weight > 0 || !has_uuid);
 511
 512         if (weight > 0 && has_uuid) {
 513                 insert_entry_status = bt_value_map_insert_string_entry(result, "group", uuid_str);
 514                 if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
 515                         status = (int) insert_entry_status;
 516                         goto end;
 517                 }
 518         }
 519
 520         *user_result = result;
 521         result = NULL;
 522         status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
 523
 524 end:
 525         g_free(metadata_path);
 526         bt_value_put_ref(result);
 527         ctf_metadata_decoder_destroy(metadata_decoder);
 528
 529         return status;
 530 }