[babeltrace.git] / src / plugins / ctf / fs-src / query.c

/*
 * query.c
 *
 * Babeltrace CTF file system Reader Component queries
 *
 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#define BT_LOG_OUTPUT_LEVEL log_level
#define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
#include "logging/log.h"

#include "query.h"
#include <stdbool.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "common/assert.h"
#include "metadata.h"
#include "../common/metadata/decoder.h"
#include "common/common.h"
#include "common/macros.h"
#include <babeltrace2/babeltrace.h>
#include "fs.h"
#include "logging/comp-logging.h"

#define METADATA_TEXT_SIG	"/* CTF 1.8"

struct range {
	int64_t begin_ns;
	int64_t end_ns;
	bool set;
};

BT_HIDDEN
bt_component_class_query_method_status metadata_info_query(
		bt_self_component_class_source *self_comp_class_src,
		const bt_value *params, bt_logging_level log_level,
		const bt_value **user_result)
{
	bt_component_class_query_method_status status =
		BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
	bt_self_component_class *self_comp_class =
		bt_self_component_class_source_as_self_component_class(self_comp_class_src);
	bt_value *result = NULL;
	const bt_value *path_value = NULL;
	FILE *metadata_fp = NULL;
	int ret;
	int bo;
	const char *path;
	bool is_packetized;
	struct ctf_metadata_decoder *decoder = NULL;
	struct ctf_metadata_decoder_config decoder_cfg = { 0 };
	enum ctf_metadata_decoder_status decoder_status;

	result = bt_value_map_create();
	if (!result) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
		goto error;
	}

	BT_ASSERT(params);

	if (!bt_value_is_map(params)) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Query parameters is not a map value object.");
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
		goto error;
	}

	path_value = bt_value_map_borrow_entry_value_const(params, "path");
	if (!path_value) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Mandatory `path` parameter missing");
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
		goto error;
	}

	if (!bt_value_is_string(path_value)) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"`path` parameter is required to be a string value");
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
		goto error;
	}

	path = bt_value_string_get(path_value);

	BT_ASSERT(path);
	metadata_fp = ctf_fs_metadata_open_file(path);
	if (!metadata_fp) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Cannot open trace metadata: path=\"%s\".", path);
		goto error;
	}

	ret = ctf_metadata_decoder_is_packetized(metadata_fp, &is_packetized,
		&bo, log_level, NULL);
	if (ret) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Cannot check whether or not the metadata stream is packetized: path=\"%s\".",
			path);
		goto error;
	}

	decoder_cfg.log_level = log_level;
	decoder_cfg.keep_plain_text = true;
	decoder = ctf_metadata_decoder_create(&decoder_cfg);
	if (!decoder) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Cannot create metadata decoder: path=\"%s\".", path);
		goto error;
	}

	rewind(metadata_fp);
	decoder_status = ctf_metadata_decoder_append_content(decoder,
		metadata_fp);
	if (decoder_status) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Cannot update metadata decoder's content: path=\"%s\".",
			path);
		goto error;
	}

	ret = bt_value_map_insert_string_entry(result, "text",
		ctf_metadata_decoder_get_text(decoder));
	if (ret) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Cannot insert metadata text into query result.");
		goto error;
	}

	ret = bt_value_map_insert_bool_entry(result, "is-packetized",
		is_packetized);
	if (ret) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Cannot insert \"is-packetized\" attribute into query result.");
		goto error;
	}

	goto end;

error:
	BT_VALUE_PUT_REF_AND_RESET(result);
	result = NULL;

	if (status >= 0) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
	}

end:
	ctf_metadata_decoder_destroy(decoder);

	if (metadata_fp) {
		ret = fclose(metadata_fp);
		if (ret) {
			BT_LOGE_ERRNO("Cannot close metatada file stream",
				": path=\"%s\"", path);
		}
	}

	*user_result = result;
	return status;
}

static
int add_range(bt_value *info, struct range *range,
		const char *range_name)
{
	int ret = 0;
	bt_value_map_insert_entry_status status;
	bt_value *range_map;

	if (!range->set) {
		/* Not an error. */
		goto end;
	}

	status = bt_value_map_insert_empty_map_entry(info, range_name,
		&range_map);
	if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
		ret = -1;
		goto end;
	}

	status = bt_value_map_insert_signed_integer_entry(range_map, "begin",
			range->begin_ns);
	if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
		ret = -1;
		goto end;
	}

	status = bt_value_map_insert_signed_integer_entry(range_map, "end",
			range->end_ns);
	if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
		ret = -1;
		goto end;
	}

end:
	return ret;
}

static
int populate_stream_info(struct ctf_fs_ds_file_group *group,
		bt_value *group_info, struct range *stream_range)
{
	int ret = 0;
	bt_value_map_insert_entry_status insert_status;
	struct ctf_fs_ds_index_entry *first_ds_index_entry, *last_ds_index_entry;
	gchar *port_name = NULL;

	/*
	 * Since each `struct ctf_fs_ds_file_group` has a sorted array of
	 * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
	 * the timestamp_begin of the first index entry and the timestamp_end
	 * of the last index entry.
	 */
	BT_ASSERT(group->index);
	BT_ASSERT(group->index->entries);
	BT_ASSERT(group->index->entries->len > 0);

	/* First entry. */
	first_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
		group->index->entries, 0);

	/* Last entry. */
	last_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
		group->index->entries, group->index->entries->len - 1);

	stream_range->begin_ns = first_ds_index_entry->timestamp_begin_ns;
	stream_range->end_ns = last_ds_index_entry->timestamp_end_ns;

	/*
	 * If any of the begin and end timestamps is not set it means that
	 * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
	 * in their packet context so we can't set the range.
	 */
	stream_range->set = stream_range->begin_ns != UINT64_C(-1) &&
		stream_range->end_ns != UINT64_C(-1);

	ret = add_range(group_info, stream_range, "range-ns");
	if (ret) {
		goto end;
	}

	port_name = ctf_fs_make_port_name(group);
	if (!port_name) {
		ret = -1;
		goto end;
	}

	insert_status = bt_value_map_insert_string_entry(group_info,
		"port-name", port_name);
	if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
		ret = -1;
		goto end;
	}

end:
	g_free(port_name);
	return ret;
}

static
int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info,
		bt_logging_level log_level,
		bt_self_component_class *self_comp_class)
{
	int ret = 0;
	size_t group_idx;
	bt_value_map_insert_entry_status insert_status;
	bt_value_array_append_element_status append_status;
	bt_value *file_groups = NULL;

	BT_ASSERT(trace->ds_file_groups);
	/* Add trace range info only if it contains streams. */
	if (trace->ds_file_groups->len == 0) {
		ret = -1;
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Trace has no streams: trace-path=%s", trace->path->str);
		goto end;
	}

	insert_status = bt_value_map_insert_empty_array_entry(trace_info,
		"stream-infos", &file_groups);
	if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
		ret = -1;
		goto end;
	}

	/* Find range of all stream groups, and of the trace. */
	for (group_idx = 0; group_idx < trace->ds_file_groups->len;
			group_idx++) {
		bt_value *group_info;
		struct range group_range = { .set = false };
		struct ctf_fs_ds_file_group *group = g_ptr_array_index(
				trace->ds_file_groups, group_idx);

		append_status = bt_value_array_append_empty_map_element(
			file_groups, &group_info);
		if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
			ret = -1;
			goto end;
		}

		ret = populate_stream_info(group, group_info, &group_range);
		if (ret) {
			goto end;
		}
	}

end:
	return ret;
}

BT_HIDDEN
bt_component_class_query_method_status trace_infos_query(
		bt_self_component_class_source *self_comp_class_src,
		const bt_value *params, bt_logging_level log_level,
		const bt_value **user_result)
{
	struct ctf_fs_component *ctf_fs = NULL;
	bt_component_class_query_method_status status =
		BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
	bt_self_component_class *self_comp_class =
		bt_self_component_class_source_as_self_component_class(
			self_comp_class_src);
	bt_value *result = NULL;
	const bt_value *inputs_value = NULL;
	const bt_value *trace_name_value;
	int ret = 0;
	bt_value *trace_info = NULL;
	bt_value_array_append_element_status append_status;

	BT_ASSERT(params);

	if (!bt_value_is_map(params)) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Query parameters is not a map value object.");
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
		goto error;
	}

	ctf_fs = ctf_fs_component_create(log_level, NULL);
	if (!ctf_fs) {
		goto error;
	}

	if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value,
			ctf_fs, NULL, self_comp_class)) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
		goto error;
	}

	if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value,
			trace_name_value, NULL, self_comp_class)) {
		goto error;
	}

	result = bt_value_array_create();
	if (!result) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
		goto error;
	}

	append_status = bt_value_array_append_empty_map_element(result,
		&trace_info);
	if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
		BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
			"Failed to create trace info map.");
		goto error;
	}

	ret = populate_trace_info(ctf_fs->trace, trace_info, log_level,
		self_comp_class);
	if (ret) {
		goto error;
	}

	goto end;

error:
	BT_VALUE_PUT_REF_AND_RESET(result);

	if (status >= 0) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
	}

end:
	if (ctf_fs) {
		ctf_fs_destroy(ctf_fs);
		ctf_fs = NULL;
	}

	*user_result = result;
	return status;
}

BT_HIDDEN
bt_component_class_query_method_status support_info_query(
		bt_self_component_class_source *comp_class,
		const bt_value *params, bt_logging_level log_level,
		const bt_value **user_result)
{
	const bt_value *input_type_value;
	const char *input_type;
	bt_component_class_query_method_status status;
	bt_value_map_insert_entry_status insert_entry_status;
	double weight = 0;
	gchar *metadata_path = NULL;
	bt_value *result = NULL;
	struct ctf_metadata_decoder *metadata_decoder = NULL;
	FILE *metadata_file = NULL;
	char uuid_str[BT_UUID_STR_LEN + 1];
	bool has_uuid = false;
	const bt_value *input_value;
	const char *input;

	input_type_value = bt_value_map_borrow_entry_value_const(params, "type");
	BT_ASSERT(input_type_value);
	BT_ASSERT(bt_value_get_type(input_type_value) == BT_VALUE_TYPE_STRING);
	input_type = bt_value_string_get(input_type_value);

	if (strcmp(input_type, "directory") != 0) {
		goto create_result;
	}

	input_value = bt_value_map_borrow_entry_value_const(params, "input");
	BT_ASSERT(input_value);
	BT_ASSERT(bt_value_get_type(input_value) == BT_VALUE_TYPE_STRING);
	input = bt_value_string_get(input_value);

	metadata_path = g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL);
	if (!metadata_path) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
		goto end;
	}

	metadata_file = g_fopen(metadata_path, "rb");
	if (metadata_file) {
		struct ctf_metadata_decoder_config metadata_decoder_config = { 0 };
		enum ctf_metadata_decoder_status decoder_status;
		bt_uuid_t uuid;

		metadata_decoder_config.log_level = log_level;

		metadata_decoder = ctf_metadata_decoder_create(
			&metadata_decoder_config);
		if (!metadata_decoder) {
			status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
			goto end;
		}

		decoder_status = ctf_metadata_decoder_append_content(
			metadata_decoder, metadata_file);
		if (decoder_status != CTF_METADATA_DECODER_STATUS_OK) {
			BT_LOGW("cannot append metadata content: metadata-decoder-status=%d",
				decoder_status);
			status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
			goto end;
		}

		/*
		 * We were able to parse the metadata file, so we are
		 * confident it's a CTF trace.
		 */
		weight = 0.75;

		/* If the trace has a UUID, return the stringified UUID as the group. */
		if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder, uuid) == 0) {
			bt_uuid_to_str(uuid, uuid_str);
			has_uuid = true;
		}
	}

create_result:
	result = bt_value_map_create();
	if (!result) {
		status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
		goto end;
	}

	insert_entry_status = bt_value_map_insert_real_entry(result, "weight", weight);
	if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
		status = (int) insert_entry_status;
		goto end;
	}

	/* We are not supposed to have weight == 0 and a UUID. */
	BT_ASSERT(weight > 0 || !has_uuid);

	if (weight > 0 && has_uuid) {
		insert_entry_status = bt_value_map_insert_string_entry(result, "group", uuid_str);
		if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
			status = (int) insert_entry_status;
			goto end;
		}
	}

	*user_result = result;
	result = NULL;
	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;

end:
	g_free(metadata_path);
	bt_value_put_ref(result);
	ctf_metadata_decoder_destroy(metadata_decoder);

	return status;
}
Commit	Line	Data
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"
04c0ba87 JG	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"
04c0ba87 JG	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"
04c0ba87 JG	48
97ade20b JG	49	struct range {
	50	int64_t begin_ns;
	51	int64_t end_ns;
	52	bool set;
	53	};
	54
04c0ba87	55	BT_HIDDEN
fb25b9e3	56	bt_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 =
fb25b9e3 PP	62	BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
5c3441d8 SM	63	bt_self_component_class *self_comp_class =
5c3441d8 SM	64	bt_self_component_class_source_as_self_component_class(self_comp_class_src);
8eee8ea2 PP	65	bt_value *result = NULL;
8eee8ea2 PP	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);
8b45963b PP	83
04c0ba87	84	if (!bt_value_is_map(params)) {
5c3441d8 SM	85	BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
5c3441d8 SM	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,
5c3441d8 SM	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,
5c3441d8 SM	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);
04c0ba87 JG	110	if (!metadata_fp) {
5c3441d8 SM	111	BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
5c3441d8 SM	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	}
04c0ba87 JG	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	}
04c0ba87 JG	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,
5c3441d8 SM	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);
04c0ba87 JG	154	if (ret) {
5c3441d8 SM	155	BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
5c3441d8 SM	156	"Cannot insert \"is-packetized\" attribute into query result.");
04c0ba87 JG	157	goto error;
	158	}
	159
	160	goto end;
	161
	162	error:
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
04c0ba87 JG	170	end:
526c3a49	171	ctf_metadata_decoder_destroy(decoder);
04c0ba87 JG	172
04c0ba87 JG	173	if (metadata_fp) {
a7d6bdfd FD	174	ret = fclose(metadata_fp);
	175	if (ret) {
	176	BT_LOGE_ERRNO("Cannot close metatada file stream",
	177	": path=\"%s\"", path);
	178	}
04c0ba87	179	}
1286dcbb	180
ce141536	181	*user_result = result;
834e9996	182	return status;
97ade20b	183	}
13160acc	184
97ade20b	185	static
8eee8ea2	186	int add_range(bt_value info, struct range range,
97ade20b JG	187	const char *range_name)
	188	{
	189	int ret = 0;
fb25b9e3	190	bt_value_map_insert_entry_status status;
de37c3a9	191	bt_value *range_map;
97ade20b JG	192
	193	if (!range->set) {
	194	/* Not an error. */
	195	goto end;
	196	}
	197
de37c3a9 SM	198	status = bt_value_map_insert_empty_map_entry(info, range_name,
	199	&range_map);
	200	if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
97ade20b JG	201	ret = -1;
	202	goto end;
	203	}
	204
68d9d039	205	status = bt_value_map_insert_signed_integer_entry(range_map, "begin",
97ade20b	206	range->begin_ns);
fb25b9e3	207	if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
97ade20b JG	208	ret = -1;
	209	goto end;
	210	}
	211
68d9d039	212	status = bt_value_map_insert_signed_integer_entry(range_map, "end",
97ade20b	213	range->end_ns);
fb25b9e3	214	if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
97ade20b JG	215	ret = -1;
	216	goto end;
	217	}
	218
97ade20b	219	end:
97ade20b JG	220	return ret;
	221	}
	222
97ade20b JG	223	static
97ade20b JG	224	int populate_stream_info(struct ctf_fs_ds_file_group *group,
8eee8ea2	225	bt_value group_info, struct range stream_range)
97ade20b JG	226	{
97ade20b JG	227	int ret = 0;
fb25b9e3	228	bt_value_map_insert_entry_status insert_status;
1924bed7	229	struct ctf_fs_ds_index_entry first_ds_index_entry, last_ds_index_entry;
ddf49b27	230	gchar *port_name = NULL;
97ade20b	231
1924bed7	232	/*
779f4a23 FD	233	* Since each `struct ctf_fs_ds_file_group` has a sorted array of
	234	* `struct ctf_fs_ds_index_entry`, we can compute the stream range from
	235	* the timestamp_begin of the first index entry and the timestamp_end
	236	* of the last index entry.
1924bed7	237	*/
779f4a23 FD	238	BT_ASSERT(group->index);
	239	BT_ASSERT(group->index->entries);
	240	BT_ASSERT(group->index->entries->len > 0);
1924bed7	241
779f4a23 FD	242	/* First entry. */
	243	first_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
	244	group->index->entries, 0);
1924bed7	245
779f4a23 FD	246	/* Last entry. */
	247	last_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
	248	group->index->entries, group->index->entries->len - 1);
1924bed7 FD	249
	250	stream_range->begin_ns = first_ds_index_entry->timestamp_begin_ns;
	251	stream_range->end_ns = last_ds_index_entry->timestamp_end_ns;
1924bed7	252
58117c6d FD	253	/*
	254	* If any of the begin and end timestamps is not set it means that
	255	* packets don't include `timestamp_begin` _and_ `timestamp_end` fields
	256	* in their packet context so we can't set the range.
	257	*/
	258	stream_range->set = stream_range->begin_ns != UINT64_C(-1) &&
	259	stream_range->end_ns != UINT64_C(-1);
	260
	261	ret = add_range(group_info, stream_range, "range-ns");
	262	if (ret) {
	263	goto end;
97ade20b JG	264	}
97ade20b JG	265
ddf49b27 SM	266	port_name = ctf_fs_make_port_name(group);
	267	if (!port_name) {
	268	ret = -1;
	269	goto end;
	270	}
	271
fb25b9e3 PP	272	insert_status = bt_value_map_insert_string_entry(group_info,
	273	"port-name", port_name);
	274	if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
ddf49b27 SM	275	ret = -1;
	276	goto end;
	277	}
	278
97ade20b	279	end:
be1b2e7e	280	g_free(port_name);
97ade20b JG	281	return ret;
	282	}
	283
	284	static
c855b1ea SM	285	int populate_trace_info(const struct ctf_fs_trace trace, bt_value trace_info,
	286	bt_logging_level log_level,
	287	bt_self_component_class *self_comp_class)
97ade20b JG	288	{
	289	int ret = 0;
	290	size_t group_idx;
fb25b9e3 PP	291	bt_value_map_insert_entry_status insert_status;
fb25b9e3 PP	292	bt_value_array_append_element_status append_status;
bf5b7748	293	bt_value *file_groups = NULL;
97ade20b	294
bf5b7748 SM	295	BT_ASSERT(trace->ds_file_groups);
	296	/* Add trace range info only if it contains streams. */
	297	if (trace->ds_file_groups->len == 0) {
	298	ret = -1;
c855b1ea SM	299	BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
c855b1ea SM	300	"Trace has no streams: trace-path=%s", trace->path->str);
bf5b7748 SM	301	goto end;
	302	}
	303
de37c3a9	304	insert_status = bt_value_map_insert_empty_array_entry(trace_info,
9db4399f	305	"stream-infos", &file_groups);
de37c3a9 SM	306	if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
de37c3a9 SM	307	ret = -1;
97ade20b JG	308	goto end;
	309	}
	310
97ade20b JG	311	/* Find range of all stream groups, and of the trace. */
	312	for (group_idx = 0; group_idx < trace->ds_file_groups->len;
	313	group_idx++) {
8eee8ea2	314	bt_value *group_info;
97ade20b JG	315	struct range group_range = { .set = false };
	316	struct ctf_fs_ds_file_group *group = g_ptr_array_index(
	317	trace->ds_file_groups, group_idx);
	318
de37c3a9 SM	319	append_status = bt_value_array_append_empty_map_element(
	320	file_groups, &group_info);
	321	if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
97ade20b JG	322	ret = -1;
	323	goto end;
	324	}
	325
	326	ret = populate_stream_info(group, group_info, &group_range);
	327	if (ret) {
ab19273b FD	328	goto end;
ab19273b FD	329	}
97ade20b JG	330	}
97ade20b JG	331
97ade20b	332	end:
97ade20b JG	333	return ret;
	334	}
	335
	336	BT_HIDDEN
9db4399f	337	bt_component_class_query_method_status trace_infos_query(
5c3441d8	338	bt_self_component_class_source *self_comp_class_src,
3d731ea9	339	const bt_value *params, bt_logging_level log_level,
8eee8ea2	340	const bt_value **user_result)
97ade20b	341	{
bf5b7748	342	struct ctf_fs_component *ctf_fs = NULL;
fb25b9e3 PP	343	bt_component_class_query_method_status status =
fb25b9e3 PP	344	BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
5c3441d8 SM	345	bt_self_component_class *self_comp_class =
	346	bt_self_component_class_source_as_self_component_class(
	347	self_comp_class_src);
8eee8ea2	348	bt_value *result = NULL;
a1040187	349	const bt_value *inputs_value = NULL;
c77d62f1	350	const bt_value *trace_name_value;
97ade20b	351	int ret = 0;
aab89afc SM	352	bt_value *trace_info = NULL;
aab89afc SM	353	bt_value_array_append_element_status append_status;
97ade20b	354
8b45963b PP	355	BT_ASSERT(params);
8b45963b PP	356
97ade20b	357	if (!bt_value_is_map(params)) {
5c3441d8 SM	358	BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
5c3441d8 SM	359	"Query parameters is not a map value object.");
574dea68	360	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
97ade20b JG	361	goto error;
	362	}
	363
f67894f9	364	ctf_fs = ctf_fs_component_create(log_level, NULL);
c80d4c65	365	if (!ctf_fs) {
97ade20b JG	366	goto error;
97ade20b JG	367	}
97ade20b	368
c77d62f1 SM	369	if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value,
c77d62f1 SM	370	ctf_fs, NULL, self_comp_class)) {
574dea68	371	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
97ade20b JG	372	goto error;
	373	}
	374
c77d62f1 SM	375	if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value,
c77d62f1 SM	376	trace_name_value, NULL, self_comp_class)) {
97ade20b JG	377	goto error;
	378	}
	379
ce141536	380	result = bt_value_array_create();
17582c6d	381	if (!result) {
fb25b9e3	382	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
97ade20b JG	383	goto error;
	384	}
	385
aab89afc SM	386	append_status = bt_value_array_append_empty_map_element(result,
	387	&trace_info);
	388	if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
	389	BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
	390	"Failed to create trace info map.");
	391	goto error;
	392	}
97ade20b	393
c855b1ea SM	394	ret = populate_trace_info(ctf_fs->trace, trace_info, log_level,
c855b1ea SM	395	self_comp_class);
aab89afc SM	396	if (ret) {
aab89afc SM	397	goto error;
97ade20b JG	398	}
	399
	400	goto end;
	401
	402	error:
8c6884d9	403	BT_VALUE_PUT_REF_AND_RESET(result);
1286dcbb	404
834e9996	405	if (status >= 0) {
fb25b9e3	406	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
1286dcbb PP	407	}
1286dcbb PP	408
97ade20b	409	end:
bf5b7748 SM	410	if (ctf_fs) {
	411	ctf_fs_destroy(ctf_fs);
	412	ctf_fs = NULL;
97ade20b	413	}
834e9996	414
ce141536	415	*user_result = result;
834e9996	416	return status;
04c0ba87	417	}
a1040187 SM	418
	419	BT_HIDDEN
	420	bt_component_class_query_method_status support_info_query(
	421	bt_self_component_class_source *comp_class,
	422	const bt_value *params, bt_logging_level log_level,
	423	const bt_value **user_result)
	424	{
	425	const bt_value *input_type_value;
	426	const char *input_type;
	427	bt_component_class_query_method_status status;
1d3426bc	428	bt_value_map_insert_entry_status insert_entry_status;
a1040187 SM	429	double weight = 0;
	430	gchar *metadata_path = NULL;
	431	bt_value *result = NULL;
1d3426bc SM	432	struct ctf_metadata_decoder *metadata_decoder = NULL;
	433	FILE *metadata_file = NULL;
	434	char uuid_str[BT_UUID_STR_LEN + 1];
	435	bool has_uuid = false;
	436	const bt_value *input_value;
	437	const char *input;
a1040187 SM	438
	439	input_type_value = bt_value_map_borrow_entry_value_const(params, "type");
	440	BT_ASSERT(input_type_value);
	441	BT_ASSERT(bt_value_get_type(input_type_value) == BT_VALUE_TYPE_STRING);
	442	input_type = bt_value_string_get(input_type_value);
	443
1d3426bc SM	444	if (strcmp(input_type, "directory") != 0) {
	445	goto create_result;
	446	}
	447
	448	input_value = bt_value_map_borrow_entry_value_const(params, "input");
	449	BT_ASSERT(input_value);
	450	BT_ASSERT(bt_value_get_type(input_value) == BT_VALUE_TYPE_STRING);
	451	input = bt_value_string_get(input_value);
	452
	453	metadata_path = g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL);
	454	if (!metadata_path) {
a1040187 SM	455	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
	456	goto end;
	457	}
	458
9aa69a72	459	metadata_file = g_fopen(metadata_path, "rb");
1d3426bc SM	460	if (metadata_file) {
	461	struct ctf_metadata_decoder_config metadata_decoder_config = { 0 };
	462	enum ctf_metadata_decoder_status decoder_status;
	463	bt_uuid_t uuid;
a1040187	464
1d3426bc	465	metadata_decoder_config.log_level = log_level;
a1040187	466
1d3426bc SM	467	metadata_decoder = ctf_metadata_decoder_create(
	468	&metadata_decoder_config);
	469	if (!metadata_decoder) {
	470	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
	471	goto end;
	472	}
	473
	474	decoder_status = ctf_metadata_decoder_append_content(
	475	metadata_decoder, metadata_file);
	476	if (decoder_status != CTF_METADATA_DECODER_STATUS_OK) {
	477	BT_LOGW("cannot append metadata content: metadata-decoder-status=%d",
	478	decoder_status);
	479	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
a1040187 SM	480	goto end;
	481	}
	482
	483	/*
1d3426bc SM	484	* We were able to parse the metadata file, so we are
1d3426bc SM	485	* confident it's a CTF trace.
a1040187	486	*/
1d3426bc SM	487	weight = 0.75;
	488
	489	/* If the trace has a UUID, return the stringified UUID as the group. */
	490	if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder, uuid) == 0) {
	491	bt_uuid_to_str(uuid, uuid_str);
	492	has_uuid = true;
a1040187 SM	493	}
	494	}
	495
1d3426bc SM	496	create_result:
	497	result = bt_value_map_create();
	498	if (!result) {
a1040187 SM	499	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
	500	goto end;
	501	}
	502
1d3426bc SM	503	insert_entry_status = bt_value_map_insert_real_entry(result, "weight", weight);
	504	if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
	505	status = (int) insert_entry_status;
a1040187 SM	506	goto end;
	507	}
	508
1d3426bc SM	509	/* We are not supposed to have weight == 0 and a UUID. */
	510	BT_ASSERT(weight > 0 \|\| !has_uuid);
	511
	512	if (weight > 0 && has_uuid) {
	513	insert_entry_status = bt_value_map_insert_string_entry(result, "group", uuid_str);
	514	if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
	515	status = (int) insert_entry_status;
	516	goto end;
	517	}
	518	}
	519
a1040187 SM	520	*user_result = result;
	521	result = NULL;
	522	status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
	523
	524	end:
	525	g_free(metadata_path);
	526	bt_value_put_ref(result);
1d3426bc	527	ctf_metadata_decoder_destroy(metadata_decoder);
a1040187 SM	528
	529	return status;
	530	}