Rename: bt_put(), bt_get() -> bt_object_put_ref(), bt_object_get_ref()
[babeltrace.git] / plugins / ctf / fs-src / query.c
CommitLineData
04c0ba87
JG
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>
8b45963b 29#include <babeltrace/assert-internal.h>
04c0ba87
JG
30#include "metadata.h"
31#include "../common/metadata/decoder.h"
55314f2a 32#include <babeltrace/common-internal.h>
97ade20b 33#include <babeltrace/babeltrace-internal.h>
e0831b38 34#include <babeltrace/babeltrace.h>
97ade20b 35#include "fs.h"
55314f2a
JG
36
37#define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
38#include "logging.h"
04c0ba87
JG
39
40#define METADATA_TEXT_SIG "/* CTF 1.8"
41
97ade20b
JG
42struct range {
43 int64_t begin_ns;
44 int64_t end_ns;
45 bool set;
46};
47
04c0ba87 48BT_HIDDEN
fe7265b5 49struct bt_component_class_query_method_return metadata_info_query(
1286dcbb 50 struct bt_component_class *comp_class,
04c0ba87
JG
51 struct bt_value *params)
52{
fe7265b5 53 struct bt_component_class_query_method_return query_ret = {
1286dcbb
PP
54 .result = NULL,
55 .status = BT_QUERY_STATUS_OK,
56 };
57
04c0ba87
JG
58 struct bt_value *path_value = NULL;
59 char *metadata_text = NULL;
60 FILE *metadata_fp = NULL;
61 GString *g_metadata_text = NULL;
62 int ret;
63 int bo;
64 const char *path;
65 bool is_packetized;
66
1286dcbb
PP
67 query_ret.result = bt_value_map_create();
68 if (!query_ret.result) {
69 query_ret.status = BT_QUERY_STATUS_NOMEM;
04c0ba87
JG
70 goto error;
71 }
72
8b45963b
PP
73 BT_ASSERT(params);
74
04c0ba87 75 if (!bt_value_is_map(params)) {
682572a4 76 BT_LOGE_STR("Query parameters is not a map value object.");
1286dcbb 77 query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
04c0ba87
JG
78 goto error;
79 }
80
44514773 81 path_value = bt_value_map_borrow_entry_value(params, "path");
04c0ba87
JG
82 ret = bt_value_string_get(path_value, &path);
83 if (ret) {
682572a4 84 BT_LOGE_STR("Cannot get `path` string parameter.");
1286dcbb 85 query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
04c0ba87
JG
86 goto error;
87 }
88
8b45963b 89 BT_ASSERT(path);
04c0ba87
JG
90 metadata_fp = ctf_fs_metadata_open_file(path);
91 if (!metadata_fp) {
682572a4 92 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path);
04c0ba87
JG
93 goto error;
94 }
95
96 is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp,
97 &bo);
98
99 if (is_packetized) {
100 ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
101 metadata_fp, &metadata_text, bo);
102 if (ret) {
682572a4
JG
103 BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
104 path);
04c0ba87
JG
105 goto error;
106 }
107 } else {
108 long filesize;
109
faf8e665
MD
110 ret = fseek(metadata_fp, 0, SEEK_END);
111 if (ret) {
682572a4
JG
112 BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
113 ": path=\"%s\"", path);
faf8e665
MD
114 goto error;
115 }
04c0ba87 116 filesize = ftell(metadata_fp);
faf8e665 117 if (filesize < 0) {
682572a4
JG
118 BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
119 ": path=\"%s\"", path);
faf8e665
MD
120 goto error;
121 }
04c0ba87
JG
122 rewind(metadata_fp);
123 metadata_text = malloc(filesize + 1);
124 if (!metadata_text) {
682572a4 125 BT_LOGE_STR("Cannot allocate buffer for metadata text.");
04c0ba87
JG
126 goto error;
127 }
128
129 if (fread(metadata_text, filesize, 1, metadata_fp) != 1) {
682572a4
JG
130 BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
131 path);
04c0ba87
JG
132 goto error;
133 }
134
135 metadata_text[filesize] = '\0';
136 }
137
138 g_metadata_text = g_string_new(NULL);
139 if (!g_metadata_text) {
140 goto error;
141 }
142
143 if (strncmp(metadata_text, METADATA_TEXT_SIG,
144 sizeof(METADATA_TEXT_SIG) - 1) != 0) {
145 g_string_assign(g_metadata_text, METADATA_TEXT_SIG);
146 g_string_append(g_metadata_text, " */\n\n");
147 }
148
149 g_string_append(g_metadata_text, metadata_text);
150
44514773 151 ret = bt_value_map_insert_string_entry(query_ret.result, "text",
04c0ba87
JG
152 g_metadata_text->str);
153 if (ret) {
682572a4 154 BT_LOGE_STR("Cannot insert metadata text into query result.");
04c0ba87
JG
155 goto error;
156 }
157
44514773 158 ret = bt_value_map_insert_bool_entry(query_ret.result, "is-packetized",
04c0ba87
JG
159 is_packetized);
160 if (ret) {
682572a4 161 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
04c0ba87
JG
162 goto error;
163 }
164
165 goto end;
166
167error:
8138bfe1 168 BT_OBJECT_PUT_REF_AND_RESET(query_ret.result);
1286dcbb
PP
169
170 if (query_ret.status >= 0) {
171 query_ret.status = BT_QUERY_STATUS_ERROR;
172 }
04c0ba87
JG
173
174end:
04c0ba87
JG
175 free(metadata_text);
176
177 if (g_metadata_text) {
178 g_string_free(g_metadata_text, TRUE);
179 }
180
181 if (metadata_fp) {
182 fclose(metadata_fp);
183 }
1286dcbb
PP
184
185 return query_ret;
97ade20b 186}
13160acc 187
97ade20b
JG
188static
189int add_range(struct bt_value *info, struct range *range,
190 const char *range_name)
191{
192 int ret = 0;
193 enum bt_value_status status;
194 struct bt_value *range_map = NULL;
195
196 if (!range->set) {
197 /* Not an error. */
198 goto end;
199 }
200
201 range_map = bt_value_map_create();
202 if (!range_map) {
203 ret = -1;
204 goto end;
205 }
206
44514773 207 status = bt_value_map_insert_integer_entry(range_map, "begin",
97ade20b
JG
208 range->begin_ns);
209 if (status != BT_VALUE_STATUS_OK) {
210 ret = -1;
211 goto end;
212 }
213
44514773 214 status = bt_value_map_insert_integer_entry(range_map, "end",
97ade20b
JG
215 range->end_ns);
216 if (status != BT_VALUE_STATUS_OK) {
217 ret = -1;
218 goto end;
219 }
220
44514773 221 status = bt_value_map_insert_entry(info, range_name, range_map);
97ade20b
JG
222 if (status != BT_VALUE_STATUS_OK) {
223 ret = -1;
224 goto end;
225 }
226end:
8138bfe1 227 bt_object_put_ref(range_map);
97ade20b
JG
228 return ret;
229}
230
231static
839d52a5 232int add_stream_ids(struct bt_value *info, struct bt_stream *stream)
97ade20b
JG
233{
234 int ret = 0;
235 int64_t stream_class_id, stream_instance_id;
236 enum bt_value_status status;
839d52a5 237 struct bt_stream_class *stream_class = NULL;
97ade20b 238
839d52a5 239 stream_instance_id = bt_stream_get_id(stream);
97ade20b 240 if (stream_instance_id != -1) {
44514773 241 status = bt_value_map_insert_integer_entry(info, "id",
97ade20b
JG
242 stream_instance_id);
243 if (status != BT_VALUE_STATUS_OK) {
244 ret = -1;
245 goto end;
246 }
247 }
248
c43f6ee2 249 stream_class = bt_stream_borrow_class(stream);
97ade20b
JG
250 if (!stream_class) {
251 ret = -1;
252 goto end;
253 }
254
839d52a5 255 stream_class_id = bt_stream_class_get_id(stream_class);
97ade20b
JG
256 if (stream_class_id == -1) {
257 ret = -1;
258 goto end;
259 }
260
44514773 261 status = bt_value_map_insert_integer_entry(info, "class-id", stream_class_id);
97ade20b
JG
262 if (status != BT_VALUE_STATUS_OK) {
263 ret = -1;
264 goto end;
265 }
c43f6ee2 266
97ade20b 267end:
97ade20b
JG
268 return ret;
269}
270
271static
272int populate_stream_info(struct ctf_fs_ds_file_group *group,
273 struct bt_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_value *file_paths;
280
281 stream_range->begin_ns = INT64_MAX;
282 stream_range->end_ns = 0;
283
284 file_paths = bt_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
44514773 303 status = bt_value_array_append_string_element(file_paths,
97ade20b
JG
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
44514773 331 status = bt_value_map_insert_entry(group_info, "paths", file_paths);
97ade20b
JG
332 if (status != BT_VALUE_STATUS_OK) {
333 ret = -1;
334 goto end;
335 }
336
337 ret = add_stream_ids(group_info, group->stream);
338 if (ret) {
339 goto end;
340 }
341end:
8138bfe1 342 bt_object_put_ref(file_paths);
97ade20b
JG
343 return ret;
344}
345
346static
347int populate_trace_info(const char *trace_path, const char *trace_name,
348 struct bt_value *trace_info)
349{
350 int ret = 0;
351 size_t group_idx;
352 struct ctf_fs_trace *trace = NULL;
353 enum bt_value_status status;
354 struct bt_value *file_groups;
355 struct range trace_range = {
356 .begin_ns = INT64_MAX,
357 .end_ns = 0,
358 .set = false,
359 };
360 struct range trace_intersection = {
361 .begin_ns = 0,
362 .end_ns = INT64_MAX,
363 .set = false,
364 };
365
366 file_groups = bt_value_array_create();
367 if (!file_groups) {
368 goto end;
369 }
370
44514773 371 status = bt_value_map_insert_string_entry(trace_info, "name",
97ade20b
JG
372 trace_name);
373 if (status != BT_VALUE_STATUS_OK) {
374 ret = -1;
375 goto end;
376 }
44514773 377 status = bt_value_map_insert_string_entry(trace_info, "path",
97ade20b
JG
378 trace_path);
379 if (status != BT_VALUE_STATUS_OK) {
380 ret = -1;
381 goto end;
382 }
383
f7c3ac09 384 trace = ctf_fs_trace_create(trace_path, trace_name, NULL, NULL);
97ade20b
JG
385 if (!trace) {
386 BT_LOGE("Failed to create fs trace at \'%s\'", trace_path);
387 ret = -1;
388 goto end;
389 }
390
8b45963b 391 BT_ASSERT(trace->ds_file_groups);
97ade20b
JG
392 /* Add trace range info only if it contains streams. */
393 if (trace->ds_file_groups->len == 0) {
394 ret = -1;
395 goto end;
396 }
397
398 /* Find range of all stream groups, and of the trace. */
399 for (group_idx = 0; group_idx < trace->ds_file_groups->len;
400 group_idx++) {
401 struct bt_value *group_info;
402 struct range group_range = { .set = false };
403 struct ctf_fs_ds_file_group *group = g_ptr_array_index(
404 trace->ds_file_groups, group_idx);
405
406 group_info = bt_value_map_create();
407 if (!group_info) {
408 ret = -1;
409 goto end;
410 }
411
412 ret = populate_stream_info(group, group_info, &group_range);
413 if (ret) {
8138bfe1 414 bt_object_put_ref(group_info);
97ade20b
JG
415 goto end;
416 }
417
418 if (group_range.set) {
419 trace_range.begin_ns = min(trace_range.begin_ns,
420 group_range.begin_ns);
421 trace_range.end_ns = max(trace_range.end_ns,
422 group_range.end_ns);
423 trace_range.set = true;
424
425 trace_intersection.begin_ns = max(trace_intersection.begin_ns,
426 group_range.begin_ns);
427 trace_intersection.end_ns = min(trace_intersection.end_ns,
428 group_range.end_ns);
429 trace_intersection.set = true;
44514773 430 status = bt_value_array_append_element(file_groups, group_info);
8138bfe1 431 bt_object_put_ref(group_info);
97ade20b
JG
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 }
8ea849b8
PP
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 }
97ade20b
JG
449 }
450
44514773 451 status = bt_value_map_insert_entry(trace_info, "streams", file_groups);
8138bfe1 452 BT_OBJECT_PUT_REF_AND_RESET(file_groups);
97ade20b
JG
453 if (status != BT_VALUE_STATUS_OK) {
454 ret = -1;
455 goto end;
456 }
457
458end:
8138bfe1 459 bt_object_put_ref(file_groups);
97ade20b
JG
460 ctf_fs_trace_destroy(trace);
461 return ret;
462}
463
464BT_HIDDEN
fe7265b5 465struct bt_component_class_query_method_return trace_info_query(
1286dcbb 466 struct bt_component_class *comp_class,
97ade20b
JG
467 struct bt_value *params)
468{
fe7265b5 469 struct bt_component_class_query_method_return query_ret = {
1286dcbb
PP
470 .result = NULL,
471 .status = BT_QUERY_STATUS_OK,
472 };
473
97ade20b
JG
474 struct bt_value *path_value = NULL;
475 int ret = 0;
476 const char *path = NULL;
477 GList *trace_paths = NULL;
478 GList *trace_names = NULL;
479 GList *tp_node = NULL;
480 GList *tn_node = NULL;
481 GString *normalized_path = NULL;
482
8b45963b
PP
483 BT_ASSERT(params);
484
97ade20b
JG
485 if (!bt_value_is_map(params)) {
486 BT_LOGE("Query parameters is not a map value object.");
1286dcbb 487 query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
97ade20b
JG
488 goto error;
489 }
490
44514773 491 path_value = bt_value_map_borrow_entry_value(params, "path");
97ade20b
JG
492 ret = bt_value_string_get(path_value, &path);
493 if (ret) {
494 BT_LOGE("Cannot get `path` string parameter.");
1286dcbb 495 query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
97ade20b
JG
496 goto error;
497 }
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 }
8b45963b 504 BT_ASSERT(path);
97ade20b
JG
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
1286dcbb
PP
518 query_ret.result = bt_value_array_create();
519 if (!query_ret.result) {
520 query_ret.status = BT_QUERY_STATUS_NOMEM;
97ade20b
JG
521 goto error;
522 }
523
524 /* Iterates over both trace paths and names simultaneously. */
525 for (tp_node = trace_paths, tn_node = trace_names; tp_node;
526 tp_node = g_list_next(tp_node),
527 tn_node = g_list_next(tn_node)) {
528 GString *trace_path = tp_node->data;
529 GString *trace_name = tn_node->data;
530 enum bt_value_status status;
531 struct bt_value *trace_info;
532
533 trace_info = bt_value_map_create();
534 if (!trace_info) {
535 BT_LOGE("Failed to create trace info map.");
536 goto error;
537 }
538
539 ret = populate_trace_info(trace_path->str, trace_name->str,
540 trace_info);
541 if (ret) {
8138bfe1 542 bt_object_put_ref(trace_info);
97ade20b
JG
543 goto error;
544 }
545
44514773 546 status = bt_value_array_append_element(query_ret.result, trace_info);
8138bfe1 547 bt_object_put_ref(trace_info);
97ade20b
JG
548 if (status != BT_VALUE_STATUS_OK) {
549 goto error;
550 }
551 }
552
553 goto end;
554
555error:
8138bfe1 556 BT_OBJECT_PUT_REF_AND_RESET(query_ret.result);
1286dcbb
PP
557
558 if (query_ret.status >= 0) {
559 query_ret.status = BT_QUERY_STATUS_ERROR;
560 }
561
97ade20b
JG
562end:
563 if (normalized_path) {
564 g_string_free(normalized_path, TRUE);
565 }
566 if (trace_paths) {
567 for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) {
568 if (tp_node->data) {
569 g_string_free(tp_node->data, TRUE);
570 }
571 }
572 g_list_free(trace_paths);
573 }
574 if (trace_names) {
575 for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) {
576 if (tn_node->data) {
577 g_string_free(tn_node->data, TRUE);
578 }
579 }
580 g_list_free(trace_names);
581 }
582 /* "path" becomes invalid with the release of path_value. */
1286dcbb 583 return query_ret;
04c0ba87 584}
This page took 0.061067 seconds and 4 git commands to generate.