[babeltrace.git] / 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.
 */

#include "query.h"
#include <stdbool.h>
#include <babeltrace/assert-internal.h>
#include "metadata.h"
#include "../common/metadata/decoder.h"
#include <babeltrace/common-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/babeltrace.h>
#include "fs.h"

#define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
#include "logging.h"

#define METADATA_TEXT_SIG	"/* CTF 1.8"

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

BT_HIDDEN
enum bt_query_status metadata_info_query(
		struct bt_self_component_class_source *comp_class,
		const struct bt_value *params,
		const struct bt_value **user_result)
{
	enum bt_query_status status = BT_QUERY_STATUS_OK;
	struct bt_value *result = NULL;
	const struct 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");
	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);

	if (is_packetized) {
		ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
			metadata_fp, &metadata_text, bo);
		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(struct bt_value *info, struct range *range,
		const char *range_name)
{
	int ret = 0;
	enum bt_value_status status;
	struct 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_integer_entry(range_map, "begin",
			range->begin_ns);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

	status = bt_value_map_insert_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(struct bt_value *info, const struct bt_stream *stream)
{
	int ret = 0;
	int64_t stream_class_id, stream_instance_id;
	enum bt_value_status status;
	const struct bt_stream_class *stream_class = NULL;

	stream_instance_id = bt_stream_get_id(stream);
	if (stream_instance_id != -1) {
		status = bt_value_map_insert_integer_entry(info, "id",
				stream_instance_id);
		if (status != BT_VALUE_STATUS_OK) {
			ret = -1;
			goto end;
		}
	}

	stream_class = bt_stream_borrow_class_const(stream);
	if (!stream_class) {
		ret = -1;
		goto end;
	}

	stream_class_id = bt_stream_class_get_id(stream_class);
	if (stream_class_id == -1) {
		ret = -1;
		goto end;
	}

	status = bt_value_map_insert_integer_entry(info, "class-id", stream_class_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,
		struct bt_value *group_info, struct range *stream_range)
{
	int ret = 0;
	size_t file_idx;
	enum bt_value_status status;
	struct bt_value *file_paths;

	stream_range->begin_ns = INT64_MAX;
	stream_range->end_ns = 0;

	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++) {
		int64_t file_begin_epoch, file_end_epoch;
		struct ctf_fs_ds_file_info *info =
				g_ptr_array_index(group->ds_file_infos,
					file_idx);

		if (!info->index || info->index->entries->len == 0) {
			BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
				info->path->str);
			ret = -1;
			goto end;
		}

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

		/*
		 * file range is from timestamp_begin of the first entry to the
		 * timestamp_end of the last entry.
		 */
		file_begin_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries,
				struct ctf_fs_ds_index_entry, 0))->timestamp_begin_ns;
		file_end_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries,
				struct ctf_fs_ds_index_entry, info->index->entries->len - 1))->timestamp_end_ns;

		stream_range->begin_ns = min(stream_range->begin_ns, file_begin_epoch);
		stream_range->end_ns = max(stream_range->end_ns, file_end_epoch);
		stream_range->set = true;
	}

	if (stream_range->set) {
		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->stream);
	if (ret) {
		goto end;
	}
end:
	bt_value_put_ref(file_paths);
	return ret;
}

static
int populate_trace_info(const char *trace_path, const char *trace_name,
		struct bt_value *trace_info)
{
	int ret = 0;
	size_t group_idx;
	struct ctf_fs_trace *trace = NULL;
	enum bt_value_status status;
	struct bt_value *file_groups;
	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,
	};

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

	status = bt_value_map_insert_string_entry(trace_info, "name",
		trace_name);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}
	status = bt_value_map_insert_string_entry(trace_info, "path",
			trace_path);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

	trace = ctf_fs_trace_create(trace_path, trace_name, NULL);
	if (!trace) {
		BT_LOGE("Failed to create fs trace at \'%s\'", trace_path);
		ret = -1;
		goto end;
	}

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

	/* Find range of all stream groups, and of the trace. */
	for (group_idx = 0; group_idx < trace->ds_file_groups->len;
			group_idx++) {
		struct 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;
		}

		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;
			status = bt_value_array_append_element(
				file_groups,
				group_info);
			bt_value_put_ref(group_info);
			if (status != BT_VALUE_STATUS_OK) {
				goto end;
			}
		}
	}

	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);
	ctf_fs_trace_destroy(trace);
	return ret;
}

BT_HIDDEN
enum bt_query_status trace_info_query(
		struct bt_self_component_class_source *comp_class,
		const struct bt_value *params,
		const struct bt_value **user_result)
{
	enum bt_query_status status = BT_QUERY_STATUS_OK;
	struct bt_value *result = NULL;
	const struct bt_value *path_value = NULL;
	int ret = 0;
	const char *path = NULL;
	GList *trace_paths = NULL;
	GList *trace_names = NULL;
	GList *tp_node = NULL;
	GList *tn_node = NULL;
	GString *normalized_path = NULL;

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

	path_value = bt_value_map_borrow_entry_value_const(params, "path");
	path = bt_value_string_get(path_value);

	normalized_path = bt_common_normalize_path(path, NULL);
	if (!normalized_path) {
		BT_LOGE("Failed to normalize path: `%s`.", path);
		goto error;
	}
	BT_ASSERT(path);

	ret = ctf_fs_find_traces(&trace_paths, normalized_path->str);
	if (ret) {
		goto error;
	}

	trace_names = ctf_fs_create_trace_names(trace_paths,
		normalized_path->str);
	if (!trace_names) {
		BT_LOGE("Cannot create trace names from trace paths.");
		goto error;
	}

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

	/* Iterates over both trace paths and names simultaneously. */
	for (tp_node = trace_paths, tn_node = trace_names; tp_node;
			tp_node = g_list_next(tp_node),
			tn_node = g_list_next(tn_node)) {
		GString *trace_path = tp_node->data;
		GString *trace_name = tn_node->data;
		enum bt_value_status status;
		struct bt_value *trace_info;

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

		ret = populate_trace_info(trace_path->str, trace_name->str,
			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 (normalized_path) {
		g_string_free(normalized_path, TRUE);
	}
	if (trace_paths) {
		for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) {
			if (tp_node->data) {
				g_string_free(tp_node->data, TRUE);
			}
		}
		g_list_free(trace_paths);
	}
	if (trace_names) {
		for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) {
			if (tn_node->data) {
				g_string_free(tn_node->data, TRUE);
			}
		}
		g_list_free(trace_names);
	}

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