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