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