[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 "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"

#define METADATA_TEXT_SIG	"/* CTF 1.8"

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

BT_HIDDEN
bt_query_status metadata_info_query(
		bt_self_component_class_source *comp_class,
		const bt_value *params, bt_logging_level log_level,
		const bt_value **user_result)
{
	bt_query_status status = BT_QUERY_STATUS_OK;
	bt_value *result = NULL;
	const bt_value *path_value = NULL;
	char *metadata_text = NULL;
	FILE *metadata_fp = NULL;
	GString *g_metadata_text = NULL;
	int ret;
	int bo;
	const char *path;
	bool is_packetized;

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

	BT_ASSERT(params);

	if (!bt_value_is_map(params)) {
		BT_LOGE_STR("Query parameters is not a map value object.");
		status = BT_QUERY_STATUS_INVALID_PARAMS;
		goto error;
	}

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

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

	path = bt_value_string_get(path_value);

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

	is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp,
		&bo, log_level, NULL);

	if (is_packetized) {
		ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
			metadata_fp, &metadata_text, bo, NULL, NULL,
			log_level, NULL);
		if (ret) {
			BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
				path);
			goto error;
		}
	} else {
		long filesize;

		ret = fseek(metadata_fp, 0, SEEK_END);
		if (ret) {
			BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
				": path=\"%s\"", path);
			goto error;
		}
		filesize = ftell(metadata_fp);
		if (filesize < 0) {
			BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
				": path=\"%s\"", path);
			goto error;
		}
		rewind(metadata_fp);
		metadata_text = malloc(filesize + 1);
		if (!metadata_text) {
			BT_LOGE_STR("Cannot allocate buffer for metadata text.");
			goto error;
		}

		if (fread(metadata_text, filesize, 1, metadata_fp) != 1) {
			BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
				path);
			goto error;
		}

		metadata_text[filesize] = '\0';
	}

	g_metadata_text = g_string_new(NULL);
	if (!g_metadata_text) {
		goto error;
	}

	if (strncmp(metadata_text, METADATA_TEXT_SIG,
			sizeof(METADATA_TEXT_SIG) - 1) != 0) {
		g_string_assign(g_metadata_text, METADATA_TEXT_SIG);
		g_string_append(g_metadata_text, " */\n\n");
	}

	g_string_append(g_metadata_text, metadata_text);

	ret = bt_value_map_insert_string_entry(result, "text",
		g_metadata_text->str);
	if (ret) {
		BT_LOGE_STR("Cannot insert metadata text into query result.");
		goto error;
	}

	ret = bt_value_map_insert_bool_entry(result, "is-packetized",
		is_packetized);
	if (ret) {
		BT_LOGE_STR("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_QUERY_STATUS_ERROR;
	}

end:
	free(metadata_text);

	if (g_metadata_text) {
		g_string_free(g_metadata_text, TRUE);
	}

	if (metadata_fp) {
		fclose(metadata_fp);
	}

	*user_result = result;
	return status;
}

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

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

	range_map = bt_value_map_create();
	if (!range_map) {
		ret = -1;
		goto end;
	}

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

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

	status = bt_value_map_insert_entry(info, range_name,
		range_map);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

end:
	bt_value_put_ref(range_map);
	return ret;
}

static
int add_stream_ids(bt_value *info, struct ctf_fs_ds_file_group *ds_file_group)
{
	int ret = 0;
	bt_value_status status;

	if (ds_file_group->stream_id != UINT64_C(-1)) {
		status = bt_value_map_insert_unsigned_integer_entry(info, "id",
			ds_file_group->stream_id);
		if (status != BT_VALUE_STATUS_OK) {
			ret = -1;
			goto end;
		}
	}

	status = bt_value_map_insert_unsigned_integer_entry(info, "class-id",
		ds_file_group->sc->id);
	if (status != BT_VALUE_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;
	size_t file_idx;
	bt_value_status status;
	bt_value *file_paths;
	struct ctf_fs_ds_index_entry *first_ds_index_entry, *last_ds_index_entry;
	gchar *port_name = NULL;

	file_paths = bt_value_array_create();
	if (!file_paths) {
		ret = -1;
		goto end;
	}

	for (file_idx = 0; file_idx < group->ds_file_infos->len; file_idx++) {
		struct ctf_fs_ds_file_info *info =
			g_ptr_array_index(group->ds_file_infos,
				file_idx);

		status = bt_value_array_append_string_element(file_paths,
				info->path->str);
		if (status != BT_VALUE_STATUS_OK) {
			ret = -1;
			goto end;
		}
	}

	/*
	 * 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;
	}

	status = bt_value_map_insert_entry(group_info, "paths",
		file_paths);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

	ret = add_stream_ids(group_info, group);
	if (ret) {
		goto end;
	}

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

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

end:
	bt_value_put_ref(file_paths);
	return ret;
}

static
int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info)
{
	int ret = 0;
	size_t group_idx;
	bt_value_status status;
	bt_value *file_groups = NULL;
	struct range trace_range = {
		.begin_ns = INT64_MAX,
		.end_ns = 0,
		.set = false,
	};
	struct range trace_intersection = {
		.begin_ns = 0,
		.end_ns = INT64_MAX,
		.set = false,
	};

	BT_ASSERT(trace->ds_file_groups);
	/* Add trace range info only if it contains streams. */
	if (trace->ds_file_groups->len == 0) {
		ret = -1;
		goto end;
	}

	file_groups = bt_value_array_create();
	if (!file_groups) {
		goto end;
	}

	status = bt_value_map_insert_string_entry(trace_info, "name",
		trace->name->str);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}
	status = bt_value_map_insert_string_entry(trace_info, "path",
		trace->path->str);
	if (status != BT_VALUE_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);

		group_info = bt_value_map_create();
		if (!group_info) {
			ret = -1;
			goto end;
		}

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

		status = bt_value_array_append_element(file_groups, group_info);
		bt_value_put_ref(group_info);
		if (status != BT_VALUE_STATUS_OK) {
			goto end;
		}

		if (group_range.set) {
			trace_range.begin_ns = MIN(trace_range.begin_ns,
					group_range.begin_ns);
			trace_range.end_ns = MAX(trace_range.end_ns,
					group_range.end_ns);
			trace_range.set = true;

			trace_intersection.begin_ns = MAX(trace_intersection.begin_ns,
					group_range.begin_ns);
			trace_intersection.end_ns = MIN(trace_intersection.end_ns,
					group_range.end_ns);
			trace_intersection.set = true;
		}
	}

	ret = add_range(trace_info, &trace_range, "range-ns");
	if (ret) {
		goto end;
	}

	if (trace_intersection.begin_ns < trace_intersection.end_ns) {
		ret = add_range(trace_info, &trace_intersection,
				"intersection-range-ns");
		if (ret) {
			goto end;
		}
	}

	status = bt_value_map_insert_entry(trace_info, "streams",
		file_groups);
	BT_VALUE_PUT_REF_AND_RESET(file_groups);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

end:
	bt_value_put_ref(file_groups);
	return ret;
}

BT_HIDDEN
bt_query_status trace_info_query(
		bt_self_component_class_source *comp_class,
		const bt_value *params, bt_logging_level log_level,
		const bt_value **user_result)
{
	struct ctf_fs_component *ctf_fs = NULL;
	bt_query_status status = BT_QUERY_STATUS_OK;
	bt_value *result = NULL;
	const bt_value *paths_value = NULL;
	int ret = 0;
	guint i;

	BT_ASSERT(params);

	if (!bt_value_is_map(params)) {
		BT_LOGE("Query parameters is not a map value object.");
		status = BT_QUERY_STATUS_INVALID_PARAMS;
		goto error;
	}

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

	if (!read_src_fs_parameters(params, &paths_value, ctf_fs)) {
		status = BT_QUERY_STATUS_INVALID_PARAMS;
		goto error;
	}

	if (ctf_fs_component_create_ctf_fs_traces(NULL, ctf_fs, paths_value)) {
		goto error;
	}

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

	for (i = 0; i < ctf_fs->traces->len; i++) {
		struct ctf_fs_trace *trace;
		bt_value *trace_info;
		bt_value_status status;

		trace = g_ptr_array_index(ctf_fs->traces, i);
		BT_ASSERT(trace);

		trace_info = bt_value_map_create();
		if (!trace_info) {
			BT_LOGE("Failed to create trace info map.");
			goto error;
		}

		ret = populate_trace_info(trace, trace_info);
		if (ret) {
			bt_value_put_ref(trace_info);
			goto error;
		}

		status = bt_value_array_append_element(result, trace_info);
		bt_value_put_ref(trace_info);
		if (status != BT_VALUE_STATUS_OK) {
			goto error;
		}
	}

	goto end;

error:
	BT_VALUE_PUT_REF_AND_RESET(result);
	result = NULL;

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

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

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