[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 <assert.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
struct bt_component_class_query_method_return metadata_info_query(
		struct bt_component_class *comp_class,
		struct bt_value *params)
{
	struct bt_component_class_query_method_return query_ret = {
		.result = NULL,
		.status = BT_QUERY_STATUS_OK,
	};

	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;

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

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

	path_value = bt_value_map_get(params, "path");
	ret = bt_value_string_get(path_value, &path);
	if (ret) {
		BT_LOGE_STR("Cannot get `path` string parameter.");
		query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
		goto error;
	}

	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(query_ret.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(query_ret.result, "is-packetized",
		is_packetized);
	if (ret) {
		BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
		goto error;
	}

	goto end;

error:
	BT_PUT(query_ret.result);

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

end:
	bt_put(path_value);
	free(metadata_text);

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

	if (metadata_fp) {
		fclose(metadata_fp);
	}

	return query_ret;
}

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(range_map, "begin",
			range->begin_ns);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

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

	status = bt_value_map_insert(info, range_name, range_map);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}
end:
	bt_put(range_map);
	return ret;
}

static
int add_stream_ids(struct bt_value *info, struct bt_stream *stream)
{
	int ret = 0;
	int64_t stream_class_id, stream_instance_id;
	enum bt_value_status status;
	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(info, "id",
				stream_instance_id);
		if (status != BT_VALUE_STATUS_OK) {
			ret = -1;
			goto end;
		}
	}

	stream_class = bt_stream_get_class(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(info, "class-id", stream_class_id);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}
end:
	bt_put(stream_class);
	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(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(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_put(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(trace_info, "name",
			trace_name);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}
	status = bt_value_map_insert_string(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;
	}

	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_put(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(file_groups, group_info);
			bt_put(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(trace_info, "streams", file_groups);
	BT_PUT(file_groups);
	if (status != BT_VALUE_STATUS_OK) {
		ret = -1;
		goto end;
	}

end:
	bt_put(file_groups);
	ctf_fs_trace_destroy(trace);
	return ret;
}

BT_HIDDEN
struct bt_component_class_query_method_return trace_info_query(
		struct bt_component_class *comp_class,
		struct bt_value *params)
{
	struct bt_component_class_query_method_return query_ret = {
		.result = NULL,
		.status = BT_QUERY_STATUS_OK,
	};

	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;

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

	path_value = bt_value_map_get(params, "path");
	ret = bt_value_string_get(path_value, &path);
	if (ret) {
		BT_LOGE("Cannot get `path` string parameter.");
		query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
		goto error;
	}

	normalized_path = bt_common_normalize_path(path, NULL);
	if (!normalized_path) {
		BT_LOGE("Failed to normalize path: `%s`.", path);
		goto error;
	}
	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;
	}

	query_ret.result = bt_value_array_create();
	if (!query_ret.result) {
		query_ret.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_put(trace_info);
			goto error;
		}

		status = bt_value_array_append(query_ret.result, trace_info);
		bt_put(trace_info);
		if (status != BT_VALUE_STATUS_OK) {
			goto error;
		}
	}

	goto end;

error:
	BT_PUT(query_ret.result);

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