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 #include "query.h"
  28 #include <stdbool.h>
  29 #include <babeltrace/assert-internal.h>
  30 #include "metadata.h"
  31 #include "../common/metadata/decoder.h"
  32 #include <babeltrace/common-internal.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <babeltrace/babeltrace.h>
  35 #include "fs.h"
  36
  37 #define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
  38 #include "logging.h"
  39
  40 #define METADATA_TEXT_SIG       "/* CTF 1.8"
  41
  42 struct range {
  43         int64_t begin_ns;
  44         int64_t end_ns;
  45         bool set;
  46 };
  47
  48 BT_HIDDEN
  49 struct bt_component_class_query_method_return metadata_info_query(
  50                 struct bt_component_class *comp_class,
  51                 struct bt_value *params)
  52 {
  53         struct bt_component_class_query_method_return query_ret = {
  54                 .result = NULL,
  55                 .status = BT_QUERY_STATUS_OK,
  56         };
  57
  58         struct bt_private_value *result = NULL;
  59         struct bt_value *path_value = NULL;
  60         char *metadata_text = NULL;
  61         FILE *metadata_fp = NULL;
  62         GString *g_metadata_text = NULL;
  63         int ret;
  64         int bo;
  65         const char *path;
  66         bool is_packetized;
  67
  68         result = bt_private_value_map_create();
  69         if (!result) {
  70                 query_ret.status = BT_QUERY_STATUS_NOMEM;
  71                 goto error;
  72         }
  73
  74         query_ret.result = bt_value_borrow_from_private(result);
  75         BT_ASSERT(params);
  76
  77         if (!bt_value_is_map(params)) {
  78                 BT_LOGE_STR("Query parameters is not a map value object.");
  79                 query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
  80                 goto error;
  81         }
  82
  83         path_value = bt_value_map_borrow_entry_value(params, "path");
  84         path = bt_value_string_get(path_value);
  85
  86         BT_ASSERT(path);
  87         metadata_fp = ctf_fs_metadata_open_file(path);
  88         if (!metadata_fp) {
  89                 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path);
  90                 goto error;
  91         }
  92
  93         is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp,
  94                 &bo);
  95
  96         if (is_packetized) {
  97                 ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
  98                         metadata_fp, &metadata_text, bo);
  99                 if (ret) {
 100                         BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
 101                                 path);
 102                         goto error;
 103                 }
 104         } else {
 105                 long filesize;
 106
 107                 ret = fseek(metadata_fp, 0, SEEK_END);
 108                 if (ret) {
 109                         BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
 110                                 ": path=\"%s\"", path);
 111                         goto error;
 112                 }
 113                 filesize = ftell(metadata_fp);
 114                 if (filesize < 0) {
 115                         BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
 116                                 ": path=\"%s\"", path);
 117                         goto error;
 118                 }
 119                 rewind(metadata_fp);
 120                 metadata_text = malloc(filesize + 1);
 121                 if (!metadata_text) {
 122                         BT_LOGE_STR("Cannot allocate buffer for metadata text.");
 123                         goto error;
 124                 }
 125
 126                 if (fread(metadata_text, filesize, 1, metadata_fp) != 1) {
 127                         BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
 128                                 path);
 129                         goto error;
 130                 }
 131
 132                 metadata_text[filesize] = '\0';
 133         }
 134
 135         g_metadata_text = g_string_new(NULL);
 136         if (!g_metadata_text) {
 137                 goto error;
 138         }
 139
 140         if (strncmp(metadata_text, METADATA_TEXT_SIG,
 141                         sizeof(METADATA_TEXT_SIG) - 1) != 0) {
 142                 g_string_assign(g_metadata_text, METADATA_TEXT_SIG);
 143                 g_string_append(g_metadata_text, " */\n\n");
 144         }
 145
 146         g_string_append(g_metadata_text, metadata_text);
 147
 148         ret = bt_private_value_map_insert_string_entry(result, "text",
 149                 g_metadata_text->str);
 150         if (ret) {
 151                 BT_LOGE_STR("Cannot insert metadata text into query result.");
 152                 goto error;
 153         }
 154
 155         ret = bt_private_value_map_insert_bool_entry(result, "is-packetized",
 156                 is_packetized);
 157         if (ret) {
 158                 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
 159                 goto error;
 160         }
 161
 162         goto end;
 163
 164 error:
 165         BT_OBJECT_PUT_REF_AND_RESET(result);
 166         query_ret.result = NULL;
 167
 168         if (query_ret.status >= 0) {
 169                 query_ret.status = BT_QUERY_STATUS_ERROR;
 170         }
 171
 172 end:
 173         free(metadata_text);
 174
 175         if (g_metadata_text) {
 176                 g_string_free(g_metadata_text, TRUE);
 177         }
 178
 179         if (metadata_fp) {
 180                 fclose(metadata_fp);
 181         }
 182
 183         return query_ret;
 184 }
 185
 186 static
 187 int add_range(struct bt_private_value *info, struct range *range,
 188                 const char *range_name)
 189 {
 190         int ret = 0;
 191         enum bt_value_status status;
 192         struct bt_private_value *range_map = NULL;
 193
 194         if (!range->set) {
 195                 /* Not an error. */
 196                 goto end;
 197         }
 198
 199         range_map = bt_private_value_map_create();
 200         if (!range_map) {
 201                 ret = -1;
 202                 goto end;
 203         }
 204
 205         status = bt_private_value_map_insert_integer_entry(range_map, "begin",
 206                         range->begin_ns);
 207         if (status != BT_VALUE_STATUS_OK) {
 208                 ret = -1;
 209                 goto end;
 210         }
 211
 212         status = bt_private_value_map_insert_integer_entry(range_map, "end",
 213                         range->end_ns);
 214         if (status != BT_VALUE_STATUS_OK) {
 215                 ret = -1;
 216                 goto end;
 217         }
 218
 219         status = bt_private_value_map_insert_entry(info, range_name,
 220                 bt_value_borrow_from_private(range_map));
 221         if (status != BT_VALUE_STATUS_OK) {
 222                 ret = -1;
 223                 goto end;
 224         }
 225
 226 end:
 227         bt_object_put_ref(range_map);
 228         return ret;
 229 }
 230
 231 static
 232 int add_stream_ids(struct bt_private_value *info, struct bt_stream *stream)
 233 {
 234         int ret = 0;
 235         int64_t stream_class_id, stream_instance_id;
 236         enum bt_value_status status;
 237         struct bt_stream_class *stream_class = NULL;
 238
 239         stream_instance_id = bt_stream_get_id(stream);
 240         if (stream_instance_id != -1) {
 241                 status = bt_private_value_map_insert_integer_entry(info, "id",
 242                                 stream_instance_id);
 243                 if (status != BT_VALUE_STATUS_OK) {
 244                         ret = -1;
 245                         goto end;
 246                 }
 247         }
 248
 249         stream_class = bt_stream_borrow_class(stream);
 250         if (!stream_class) {
 251                 ret = -1;
 252                 goto end;
 253         }
 254
 255         stream_class_id = bt_stream_class_get_id(stream_class);
 256         if (stream_class_id == -1) {
 257                 ret = -1;
 258                 goto end;
 259         }
 260
 261         status = bt_private_value_map_insert_integer_entry(info, "class-id", stream_class_id);
 262         if (status != BT_VALUE_STATUS_OK) {
 263                 ret = -1;
 264                 goto end;
 265         }
 266
 267 end:
 268         return ret;
 269 }
 270
 271 static
 272 int populate_stream_info(struct ctf_fs_ds_file_group *group,
 273                 struct bt_private_value *group_info,
 274                 struct range *stream_range)
 275 {
 276         int ret = 0;
 277         size_t file_idx;
 278         enum bt_value_status status;
 279         struct bt_private_value *file_paths;
 280
 281         stream_range->begin_ns = INT64_MAX;
 282         stream_range->end_ns = 0;
 283
 284         file_paths = bt_private_value_array_create();
 285         if (!file_paths) {
 286                 ret = -1;
 287                 goto end;
 288         }
 289
 290         for (file_idx = 0; file_idx < group->ds_file_infos->len; file_idx++) {
 291                 int64_t file_begin_epoch, file_end_epoch;
 292                 struct ctf_fs_ds_file_info *info =
 293                                 g_ptr_array_index(group->ds_file_infos,
 294                                         file_idx);
 295
 296                 if (!info->index || info->index->entries->len == 0) {
 297                         BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
 298                                 info->path->str);
 299                         ret = -1;
 300                         goto end;
 301                 }
 302
 303                 status = bt_private_value_array_append_string_element(file_paths,
 304                                 info->path->str);
 305                 if (status != BT_VALUE_STATUS_OK) {
 306                         ret = -1;
 307                         goto end;
 308                 }
 309
 310                 /*
 311                  * file range is from timestamp_begin of the first entry to the
 312                  * timestamp_end of the last entry.
 313                  */
 314                 file_begin_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries,
 315                                 struct ctf_fs_ds_index_entry, 0))->timestamp_begin_ns;
 316                 file_end_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries,
 317                                 struct ctf_fs_ds_index_entry, info->index->entries->len - 1))->timestamp_end_ns;
 318
 319                 stream_range->begin_ns = min(stream_range->begin_ns, file_begin_epoch);
 320                 stream_range->end_ns = max(stream_range->end_ns, file_end_epoch);
 321                 stream_range->set = true;
 322         }
 323
 324         if (stream_range->set) {
 325                 ret = add_range(group_info, stream_range, "range-ns");
 326                 if (ret) {
 327                         goto end;
 328                 }
 329         }
 330
 331         status = bt_private_value_map_insert_entry(group_info, "paths",
 332                 bt_value_borrow_from_private(file_paths));
 333         if (status != BT_VALUE_STATUS_OK) {
 334                 ret = -1;
 335                 goto end;
 336         }
 337
 338         ret = add_stream_ids(group_info, group->stream);
 339         if (ret) {
 340                 goto end;
 341         }
 342 end:
 343         bt_object_put_ref(file_paths);
 344         return ret;
 345 }
 346
 347 static
 348 int populate_trace_info(const char *trace_path, const char *trace_name,
 349                 struct bt_private_value *trace_info)
 350 {
 351         int ret = 0;
 352         size_t group_idx;
 353         struct ctf_fs_trace *trace = NULL;
 354         enum bt_value_status status;
 355         struct bt_private_value *file_groups;
 356         struct range trace_range = {
 357                 .begin_ns = INT64_MAX,
 358                 .end_ns = 0,
 359                 .set = false,
 360         };
 361         struct range trace_intersection = {
 362                 .begin_ns = 0,
 363                 .end_ns = INT64_MAX,
 364                 .set = false,
 365         };
 366
 367         file_groups = bt_private_value_array_create();
 368         if (!file_groups) {
 369                 goto end;
 370         }
 371
 372         status = bt_private_value_map_insert_string_entry(trace_info, "name",
 373                 trace_name);
 374         if (status != BT_VALUE_STATUS_OK) {
 375                 ret = -1;
 376                 goto end;
 377         }
 378         status = bt_private_value_map_insert_string_entry(trace_info, "path",
 379                         trace_path);
 380         if (status != BT_VALUE_STATUS_OK) {
 381                 ret = -1;
 382                 goto end;
 383         }
 384
 385         trace = ctf_fs_trace_create(trace_path, trace_name, NULL, NULL);
 386         if (!trace) {
 387                 BT_LOGE("Failed to create fs trace at \'%s\'", trace_path);
 388                 ret = -1;
 389                 goto end;
 390         }
 391
 392         BT_ASSERT(trace->ds_file_groups);
 393         /* Add trace range info only if it contains streams. */
 394         if (trace->ds_file_groups->len == 0) {
 395                 ret = -1;
 396                 goto end;
 397         }
 398
 399         /* Find range of all stream groups, and of the trace. */
 400         for (group_idx = 0; group_idx < trace->ds_file_groups->len;
 401                         group_idx++) {
 402                 struct bt_private_value *group_info;
 403                 struct range group_range = { .set = false };
 404                 struct ctf_fs_ds_file_group *group = g_ptr_array_index(
 405                                 trace->ds_file_groups, group_idx);
 406
 407                 group_info = bt_private_value_map_create();
 408                 if (!group_info) {
 409                         ret = -1;
 410                         goto end;
 411                 }
 412
 413                 ret = populate_stream_info(group, group_info, &group_range);
 414                 if (ret) {
 415                         bt_object_put_ref(group_info);
 416                         goto end;
 417                 }
 418
 419                 if (group_range.set) {
 420                         trace_range.begin_ns = min(trace_range.begin_ns,
 421                                         group_range.begin_ns);
 422                         trace_range.end_ns = max(trace_range.end_ns,
 423                                         group_range.end_ns);
 424                         trace_range.set = true;
 425
 426                         trace_intersection.begin_ns = max(trace_intersection.begin_ns,
 427                                         group_range.begin_ns);
 428                         trace_intersection.end_ns = min(trace_intersection.end_ns,
 429                                         group_range.end_ns);
 430                         trace_intersection.set = true;
 431                         status = bt_private_value_array_append_element(
 432                                 file_groups,
 433                                 bt_value_borrow_from_private(group_info));
 434                         bt_object_put_ref(group_info);
 435                         if (status != BT_VALUE_STATUS_OK) {
 436                                 goto end;
 437                         }
 438                 }
 439         }
 440
 441         ret = add_range(trace_info, &trace_range, "range-ns");
 442         if (ret) {
 443                 goto end;
 444         }
 445
 446         if (trace_intersection.begin_ns < trace_intersection.end_ns) {
 447                 ret = add_range(trace_info, &trace_intersection,
 448                                 "intersection-range-ns");
 449                 if (ret) {
 450                         goto end;
 451                 }
 452         }
 453
 454         status = bt_private_value_map_insert_entry(trace_info, "streams",
 455                 bt_value_borrow_from_private(file_groups));
 456         BT_OBJECT_PUT_REF_AND_RESET(file_groups);
 457         if (status != BT_VALUE_STATUS_OK) {
 458                 ret = -1;
 459                 goto end;
 460         }
 461
 462 end:
 463         bt_object_put_ref(file_groups);
 464         ctf_fs_trace_destroy(trace);
 465         return ret;
 466 }
 467
 468 BT_HIDDEN
 469 struct bt_component_class_query_method_return trace_info_query(
 470                 struct bt_component_class *comp_class,
 471                 struct bt_value *params)
 472 {
 473         struct bt_component_class_query_method_return query_ret = {
 474                 .result = NULL,
 475                 .status = BT_QUERY_STATUS_OK,
 476         };
 477
 478         struct bt_private_value *result = NULL;
 479         struct bt_value *path_value = NULL;
 480         int ret = 0;
 481         const char *path = NULL;
 482         GList *trace_paths = NULL;
 483         GList *trace_names = NULL;
 484         GList *tp_node = NULL;
 485         GList *tn_node = NULL;
 486         GString *normalized_path = NULL;
 487
 488         BT_ASSERT(params);
 489
 490         if (!bt_value_is_map(params)) {
 491                 BT_LOGE("Query parameters is not a map value object.");
 492                 query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
 493                 goto error;
 494         }
 495
 496         path_value = bt_value_map_borrow_entry_value(params, "path");
 497         path = bt_value_string_get(path_value);
 498
 499         normalized_path = bt_common_normalize_path(path, NULL);
 500         if (!normalized_path) {
 501                 BT_LOGE("Failed to normalize path: `%s`.", path);
 502                 goto error;
 503         }
 504         BT_ASSERT(path);
 505
 506         ret = ctf_fs_find_traces(&trace_paths, normalized_path->str);
 507         if (ret) {
 508                 goto error;
 509         }
 510
 511         trace_names = ctf_fs_create_trace_names(trace_paths,
 512                 normalized_path->str);
 513         if (!trace_names) {
 514                 BT_LOGE("Cannot create trace names from trace paths.");
 515                 goto error;
 516         }
 517
 518         result = bt_private_value_array_create();
 519         if (!result) {
 520                 query_ret.status = BT_QUERY_STATUS_NOMEM;
 521                 goto error;
 522         }
 523
 524         query_ret.result = bt_value_borrow_from_private(result);
 525
 526         /* Iterates over both trace paths and names simultaneously. */
 527         for (tp_node = trace_paths, tn_node = trace_names; tp_node;
 528                         tp_node = g_list_next(tp_node),
 529                         tn_node = g_list_next(tn_node)) {
 530                 GString *trace_path = tp_node->data;
 531                 GString *trace_name = tn_node->data;
 532                 enum bt_value_status status;
 533                 struct bt_private_value *trace_info;
 534
 535                 trace_info = bt_private_value_map_create();
 536                 if (!trace_info) {
 537                         BT_LOGE("Failed to create trace info map.");
 538                         goto error;
 539                 }
 540
 541                 ret = populate_trace_info(trace_path->str, trace_name->str,
 542                         trace_info);
 543                 if (ret) {
 544                         bt_object_put_ref(trace_info);
 545                         goto error;
 546                 }
 547
 548                 status = bt_private_value_array_append_element(result,
 549                         bt_value_borrow_from_private(trace_info));
 550                 bt_object_put_ref(trace_info);
 551                 if (status != BT_VALUE_STATUS_OK) {
 552                         goto error;
 553                 }
 554         }
 555
 556         goto end;
 557
 558 error:
 559         BT_OBJECT_PUT_REF_AND_RESET(result);
 560         query_ret.result = NULL;
 561
 562         if (query_ret.status >= 0) {
 563                 query_ret.status = BT_QUERY_STATUS_ERROR;
 564         }
 565
 566 end:
 567         if (normalized_path) {
 568                 g_string_free(normalized_path, TRUE);
 569         }
 570         if (trace_paths) {
 571                 for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) {
 572                         if (tp_node->data) {
 573                                 g_string_free(tp_node->data, TRUE);
 574                         }
 575                 }
 576                 g_list_free(trace_paths);
 577         }
 578         if (trace_names) {
 579                 for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) {
 580                         if (tn_node->data) {
 581                                 g_string_free(tn_node->data, TRUE);
 582                         }
 583                 }
 584                 g_list_free(trace_names);
 585         }
 586         /* "path" becomes invalid with the release of path_value. */
 587         return query_ret;
 588 }