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