[babeltrace.git] / plugins / debug-info / plugin.c

/*
 * plugin.c
 *
 * Babeltrace Debug Info Plug-in
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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 <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/private-notification-iterator.h>
#include <babeltrace/graph/notification.h>
#include <babeltrace/graph/notification-event.h>
#include <babeltrace/graph/notification-stream.h>
#include <babeltrace/graph/notification-packet.h>
#include <babeltrace/graph/component-filter.h>
#include <babeltrace/graph/private-component-filter.h>
#include <babeltrace/graph/private-port.h>
#include <babeltrace/graph/private-connection.h>
#include <babeltrace/graph/private-component.h>
#include <babeltrace/plugin/plugin-dev.h>
#include <plugins-common.h>
#include <assert.h>
#include "debug-info.h"
#include "copy.h"

static
void destroy_debug_info_data(struct debug_info_component *debug_info)
{
	free(debug_info->arg_debug_info_field_name);
	g_free(debug_info);
}

static
void destroy_debug_info_component(struct bt_private_component *component)
{
	void *data = bt_private_component_get_user_data(component);
	destroy_debug_info_data(data);
}

static
struct debug_info_component *create_debug_info_component_data(void)
{
	struct debug_info_component *debug_info;

	debug_info = g_new0(struct debug_info_component, 1);
	if (!debug_info) {
		goto end;
	}
	debug_info->err = stderr;

end:
	return debug_info;
}

static
void unref_debug_info(struct debug_info *debug_info)
{
	debug_info_destroy(debug_info);
}

static
void unref_trace(struct bt_ctf_trace *trace)
{
	bt_put(trace);
}

static
void unref_stream(struct bt_ctf_stream *stream)
{
	bt_put(stream);
}

static
void unref_packet(struct bt_ctf_packet *packet)
{
	bt_put(packet);
}

static
void unref_stream_class(struct bt_ctf_stream_class *stream_class)
{
	bt_put(stream_class);
}

static
void debug_info_iterator_destroy(struct bt_private_notification_iterator *it)
{
	struct debug_info_iterator *it_data;

	it_data = bt_private_notification_iterator_get_user_data(it);
	assert(it_data);

	if (it_data->input_iterator_group) {
		g_ptr_array_free(it_data->input_iterator_group, TRUE);
	}
	bt_put(it_data->current_notification);
	bt_put(it_data->input_iterator);
	g_hash_table_destroy(it_data->trace_map);
	g_hash_table_destroy(it_data->stream_map);
	g_hash_table_destroy(it_data->stream_class_map);
	g_hash_table_destroy(it_data->packet_map);
	g_hash_table_destroy(it_data->trace_debug_map);
	g_free(it_data);
}

static
struct bt_notification *handle_notification(FILE *err,
		struct debug_info_iterator *debug_it,
		struct bt_notification *notification)
{
	struct bt_notification *new_notification = NULL;

	switch (bt_notification_get_type(notification)) {
	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	{
		struct bt_ctf_packet *packet =
			bt_notification_packet_begin_get_packet(notification);
		struct bt_ctf_packet *writer_packet;

		if (!packet) {
			goto end;
		}

		writer_packet = debug_info_new_packet(debug_it, packet);
		assert(writer_packet);
		new_notification = bt_notification_packet_begin_create(
				writer_packet);
		assert(new_notification);
		bt_put(packet);
		break;
	}
	case BT_NOTIFICATION_TYPE_PACKET_END:
	{
		struct bt_ctf_packet *packet =
			bt_notification_packet_end_get_packet(notification);
		struct bt_ctf_packet *writer_packet;

		if (!packet) {
			goto end;
		}

		writer_packet = debug_info_close_packet(debug_it, packet);
		assert(writer_packet);
		new_notification = bt_notification_packet_end_create(
				writer_packet);
		assert(new_notification);
		bt_put(packet);
		bt_put(writer_packet);
		break;
	}
	case BT_NOTIFICATION_TYPE_EVENT:
	{
		struct bt_ctf_event *event = bt_notification_event_get_event(
				notification);
		struct bt_ctf_event *writer_event;
		struct bt_clock_class_priority_map *cc_prio_map =
			bt_notification_event_get_clock_class_priority_map(
					notification);

		if (!event) {
			goto end;
		}
		writer_event = debug_info_output_event(debug_it, event);
		assert(writer_event);
		new_notification = bt_notification_event_create(writer_event,
				cc_prio_map);
		bt_put(cc_prio_map);
		assert(new_notification);
		bt_put(event);
		bt_put(writer_event);
		break;
	}
	case BT_NOTIFICATION_TYPE_STREAM_END:
	{
		struct bt_ctf_stream *stream =
			bt_notification_stream_end_get_stream(notification);
		struct bt_ctf_stream *writer_stream;

		if (!stream) {
			goto end;
		}

		writer_stream = debug_info_stream_end(debug_it, stream);
		assert(writer_stream);
		new_notification = bt_notification_stream_end_create(
				writer_stream);
		assert(new_notification);
		bt_put(stream);
		bt_put(writer_stream);
		break;
	}
	default:
		puts("Unhandled notification type");
	}

end:
	return new_notification;
}

static
struct bt_notification_iterator_next_return debug_info_iterator_next(
		struct bt_private_notification_iterator *iterator)
{
	struct debug_info_iterator *debug_it = NULL;
	struct bt_private_component *component = NULL;
	struct debug_info_component *debug_info = NULL;
	struct bt_notification_iterator *source_it = NULL;
	struct bt_notification *notification;
	struct bt_notification_iterator_next_return ret = {
		.status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
		.notification = NULL,
	};

	debug_it = bt_private_notification_iterator_get_user_data(iterator);
	assert(debug_it);

	component = bt_private_notification_iterator_get_private_component(iterator);
	assert(component);
	debug_info = bt_private_component_get_user_data(component);
	assert(debug_info);

	source_it = debug_it->input_iterator;

	ret.status = bt_notification_iterator_next(source_it);
	if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
		goto end;
	}

	notification = bt_notification_iterator_get_notification(
			source_it);
	if (!notification) {
		ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
		goto end;
	}

	ret.notification = handle_notification(debug_info->err, debug_it,
			notification);
	assert(ret.notification);
	bt_put(notification);

end:
	bt_put(component);
	return ret;
}

/*
static
struct bt_notification *debug_info_iterator_get(
		struct bt_private_notification_iterator *iterator)
{
	struct debug_info_iterator *debug_it;

	debug_it = bt_private_notification_iterator_get_user_data(iterator);
	assert(debug_it);

	if (!debug_it->current_notification) {
		enum bt_notification_iterator_status it_ret;

		it_ret = debug_info_iterator_next(iterator);
		if (it_ret) {
			goto end;
		}
	}

end:
	return bt_get(debug_it->current_notification);
}
*/

static
enum bt_notification_iterator_status debug_info_iterator_seek_time(
		struct bt_private_notification_iterator *iterator, int64_t time)
{
	enum bt_notification_iterator_status ret;

	ret = BT_NOTIFICATION_ITERATOR_STATUS_OK;

	return ret;
}

static
enum bt_notification_iterator_status debug_info_iterator_init(
		struct bt_private_notification_iterator *iterator,
		struct bt_private_port *port)
{
	enum bt_notification_iterator_status ret =
		BT_NOTIFICATION_ITERATOR_STATUS_OK;
	enum bt_notification_iterator_status it_ret;
	struct bt_private_port *input_port = NULL;
	struct bt_private_connection *connection = NULL;
	struct bt_private_component *component =
		bt_private_notification_iterator_get_private_component(iterator);
	struct debug_info_iterator *it_data = g_new0(struct debug_info_iterator, 1);

	if (!it_data) {
		ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
		goto end;
	}

	/* Create a new iterator on the upstream component. */
	input_port = bt_private_component_filter_get_default_input_private_port(component);
	assert(input_port);
	connection = bt_private_port_get_private_connection(input_port);
	assert(connection);

	it_data->input_iterator = bt_private_connection_create_notification_iterator(
			connection);
	if (!it_data->input_iterator) {
		ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
		goto end;
	}
	it_data->debug_info_component = (struct debug_info_component *)
		bt_private_component_get_user_data(component);

	it_data->err = it_data->debug_info_component->err;
	it_data->trace_map = g_hash_table_new_full(g_direct_hash,
			g_direct_equal, NULL, (GDestroyNotify) unref_trace);
	it_data->stream_map = g_hash_table_new_full(g_direct_hash,
			g_direct_equal, NULL, (GDestroyNotify) unref_stream);
	it_data->stream_class_map = g_hash_table_new_full(g_direct_hash,
			g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
	it_data->packet_map = g_hash_table_new_full(g_direct_hash,
			g_direct_equal, NULL, (GDestroyNotify) unref_packet);
	it_data->trace_debug_map = g_hash_table_new_full(g_direct_hash,
			g_direct_equal, NULL, (GDestroyNotify) unref_debug_info);

	it_ret = bt_private_notification_iterator_set_user_data(iterator, it_data);
	if (it_ret) {
		goto end;
	}

end:
	bt_put(connection);
	bt_put(input_port);
	return ret;
}

static
enum bt_component_status init_from_params(
		struct debug_info_component *debug_info_component,
		struct bt_value *params)
{
	struct bt_value *value = NULL;
	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;

	assert(params);

        value = bt_value_map_get(params, "debug-info-field-name");
	if (value) {
		enum bt_value_status value_ret;
		const char *tmp;

		value_ret = bt_value_string_get(value, &tmp);
		if (value_ret) {
			ret = BT_COMPONENT_STATUS_INVALID;
			printf_error("Failed to retrieve debug-info-field-name value. "
					"Expecting a string");
		}
		strcpy(debug_info_component->arg_debug_info_field_name, tmp);
		bt_put(value);
	} else {
		debug_info_component->arg_debug_info_field_name =
			malloc(strlen("debug_info") + 1);
		if (!debug_info_component->arg_debug_info_field_name) {
			ret = BT_COMPONENT_STATUS_NOMEM;
			printf_error();
		}
		sprintf(debug_info_component->arg_debug_info_field_name,
				"debug_info");
	}
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto end;
	}

        value = bt_value_map_get(params, "debug-dir");
	if (value) {
		enum bt_value_status value_ret;

		value_ret = bt_value_string_get(value,
				&debug_info_component->arg_debug_dir);
		if (value_ret) {
			ret = BT_COMPONENT_STATUS_INVALID;
			printf_error("Failed to retrieve debug-dir value. "
					"Expecting a string");
		}
	}
	bt_put(value);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto end;
	}

        value = bt_value_map_get(params, "target-prefix");
	if (value) {
		enum bt_value_status value_ret;

		value_ret = bt_value_string_get(value,
				&debug_info_component->arg_target_prefix);
		if (value_ret) {
			ret = BT_COMPONENT_STATUS_INVALID;
			printf_error("Failed to retrieve target-prefix value. "
					"Expecting a string");
		}
	}
	bt_put(value);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto end;
	}

        value = bt_value_map_get(params, "full-path");
	if (value) {
		enum bt_value_status value_ret;

		value_ret = bt_value_bool_get(value,
				&debug_info_component->arg_full_path);
		if (value_ret) {
			ret = BT_COMPONENT_STATUS_INVALID;
			printf_error("Failed to retrieve full-path value. "
					"Expecting a boolean");
		}
	}
	bt_put(value);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto end;
	}

end:
	return ret;
}

enum bt_component_status debug_info_component_init(
	struct bt_private_component *component, struct bt_value *params,
	UNUSED_VAR void *init_method_data)
{
	enum bt_component_status ret;
	struct debug_info_component *debug_info = create_debug_info_component_data();

	if (!debug_info) {
		ret = BT_COMPONENT_STATUS_NOMEM;
		goto end;
	}

	ret = bt_private_component_set_user_data(component, debug_info);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = init_from_params(debug_info, params);
end:
	return ret;
error:
	destroy_debug_info_data(debug_info);
	return ret;
}

/* Initialize plug-in entry points. */
BT_PLUGIN(debug_info);
BT_PLUGIN_DESCRIPTION("Babeltrace Debug Informations Plug-In.");
BT_PLUGIN_AUTHOR("Jérémie Galarneau");
BT_PLUGIN_LICENSE("MIT");

BT_PLUGIN_FILTER_COMPONENT_CLASS(debug_info, debug_info_iterator_next);
BT_PLUGIN_FILTER_COMPONENT_CLASS_DESCRIPTION(debug_info,
	"Add the debug information to events if possible.");
BT_PLUGIN_FILTER_COMPONENT_CLASS_INIT_METHOD(debug_info, debug_info_component_init);
BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD(debug_info, destroy_debug_info_component);
BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_INIT_METHOD(debug_info,
	debug_info_iterator_init);
BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_FINALIZE_METHOD(debug_info,
	debug_info_iterator_destroy);
BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_SEEK_TIME_METHOD(debug_info,
	debug_info_iterator_seek_time);
Commit	Line	Data
4f45f9bb JD	1	/*
	2	* plugin.c
	3	*
	4	* Babeltrace Debug Info Plug-in
	5	*
	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
	27	*/
	28
7b077a9d JD	29	#include <babeltrace/graph/notification-iterator.h>
	30	#include <babeltrace/graph/private-notification-iterator.h>
	31	#include <babeltrace/graph/notification.h>
	32	#include <babeltrace/graph/notification-event.h>
	33	#include <babeltrace/graph/notification-stream.h>
	34	#include <babeltrace/graph/notification-packet.h>
	35	#include <babeltrace/graph/component-filter.h>
	36	#include <babeltrace/graph/private-component-filter.h>
	37	#include <babeltrace/graph/private-port.h>
	38	#include <babeltrace/graph/private-connection.h>
	39	#include <babeltrace/graph/private-component.h>
4f45f9bb	40	#include <babeltrace/plugin/plugin-dev.h>
4f45f9bb JD	41	#include <plugins-common.h>
	42	#include <assert.h>
	43	#include "debug-info.h"
	44	#include "copy.h"
	45
	46	static
	47	void destroy_debug_info_data(struct debug_info_component *debug_info)
	48	{
	49	free(debug_info->arg_debug_info_field_name);
	50	g_free(debug_info);
	51	}
	52
	53	static
7b077a9d	54	void destroy_debug_info_component(struct bt_private_component *component)
4f45f9bb	55	{
7b077a9d	56	void *data = bt_private_component_get_user_data(component);
4f45f9bb JD	57	destroy_debug_info_data(data);
	58	}
	59
	60	static
	61	struct debug_info_component *create_debug_info_component_data(void)
	62	{
	63	struct debug_info_component *debug_info;
	64
	65	debug_info = g_new0(struct debug_info_component, 1);
	66	if (!debug_info) {
	67	goto end;
	68	}
	69	debug_info->err = stderr;
	70
	71	end:
	72	return debug_info;
	73	}
	74
	75	static
	76	void unref_debug_info(struct debug_info *debug_info)
	77	{
	78	debug_info_destroy(debug_info);
	79	}
	80
	81	static
	82	void unref_trace(struct bt_ctf_trace *trace)
	83	{
	84	bt_put(trace);
	85	}
	86
	87	static
	88	void unref_stream(struct bt_ctf_stream *stream)
	89	{
	90	bt_put(stream);
	91	}
	92
	93	static
	94	void unref_packet(struct bt_ctf_packet *packet)
	95	{
	96	bt_put(packet);
	97	}
	98
	99	static
	100	void unref_stream_class(struct bt_ctf_stream_class *stream_class)
	101	{
	102	bt_put(stream_class);
	103	}
	104
	105	static
7b077a9d	106	void debug_info_iterator_destroy(struct bt_private_notification_iterator *it)
4f45f9bb JD	107	{
	108	struct debug_info_iterator *it_data;
	109
7b077a9d	110	it_data = bt_private_notification_iterator_get_user_data(it);
4f45f9bb JD	111	assert(it_data);
	112
	113	if (it_data->input_iterator_group) {
	114	g_ptr_array_free(it_data->input_iterator_group, TRUE);
	115	}
	116	bt_put(it_data->current_notification);
	117	bt_put(it_data->input_iterator);
	118	g_hash_table_destroy(it_data->trace_map);
	119	g_hash_table_destroy(it_data->stream_map);
	120	g_hash_table_destroy(it_data->stream_class_map);
	121	g_hash_table_destroy(it_data->packet_map);
	122	g_hash_table_destroy(it_data->trace_debug_map);
	123	g_free(it_data);
	124	}
	125
	126	static
	127	struct bt_notification handle_notification(FILE err,
	128	struct debug_info_iterator *debug_it,
	129	struct bt_notification *notification)
	130	{
	131	struct bt_notification *new_notification = NULL;
	132
	133	switch (bt_notification_get_type(notification)) {
	134	case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
	135	{
	136	struct bt_ctf_packet *packet =
	137	bt_notification_packet_begin_get_packet(notification);
	138	struct bt_ctf_packet *writer_packet;
	139
	140	if (!packet) {
	141	goto end;
	142	}
	143
	144	writer_packet = debug_info_new_packet(debug_it, packet);
	145	assert(writer_packet);
	146	new_notification = bt_notification_packet_begin_create(
	147	writer_packet);
	148	assert(new_notification);
	149	bt_put(packet);
	150	break;
	151	}
	152	case BT_NOTIFICATION_TYPE_PACKET_END:
	153	{
	154	struct bt_ctf_packet *packet =
	155	bt_notification_packet_end_get_packet(notification);
	156	struct bt_ctf_packet *writer_packet;
	157
	158	if (!packet) {
	159	goto end;
	160	}
	161
	162	writer_packet = debug_info_close_packet(debug_it, packet);
	163	assert(writer_packet);
	164	new_notification = bt_notification_packet_end_create(
	165	writer_packet);
	166	assert(new_notification);
	167	bt_put(packet);
	168	bt_put(writer_packet);
	169	break;
	170	}
	171	case BT_NOTIFICATION_TYPE_EVENT:
	172	{
	173	struct bt_ctf_event *event = bt_notification_event_get_event(
	174	notification);
175	struct bt_ctf_event *writer_event;
176	struct bt_clock_class_priority_map *cc_prio_map =
177	bt_notification_event_get_clock_class_priority_map(
178	notification);
179
180	if (!event) {
181	goto end;
182	}
183	writer_event = debug_info_output_event(debug_it, event);
184	assert(writer_event);
185	new_notification = bt_notification_event_create(writer_event,
186	cc_prio_map);
187	bt_put(cc_prio_map);
188	assert(new_notification);
189	bt_put(event);
190	bt_put(writer_event);
191	break;
192	}
193	case BT_NOTIFICATION_TYPE_STREAM_END:
194	{
195	struct bt_ctf_stream *stream =
196	bt_notification_stream_end_get_stream(notification);
197	struct bt_ctf_stream *writer_stream;
198
199	if (!stream) {
200	goto end;
201	}
202
203	writer_stream = debug_info_stream_end(debug_it, stream);
204	assert(writer_stream);
205	new_notification = bt_notification_stream_end_create(
206	writer_stream);
207	assert(new_notification);
208	bt_put(stream);
209	bt_put(writer_stream);
210	break;
211	}
212	default:
213	puts("Unhandled notification type");
214	}
215
216	end:
217	return new_notification;
218	}
219
220	static
7b077a9d JD	221	struct bt_notification_iterator_next_return debug_info_iterator_next(
7b077a9d JD	222	struct bt_private_notification_iterator *iterator)
4f45f9bb JD	223	{
4f45f9bb JD	224	struct debug_info_iterator *debug_it = NULL;
7b077a9d	225	struct bt_private_component *component = NULL;
4f45f9bb JD	226	struct debug_info_component *debug_info = NULL;
4f45f9bb JD	227	struct bt_notification_iterator *source_it = NULL;
7b077a9d JD	228	struct bt_notification *notification;
	229	struct bt_notification_iterator_next_return ret = {
	230	.status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
	231	.notification = NULL,
	232	};
4f45f9bb	233
7b077a9d	234	debug_it = bt_private_notification_iterator_get_user_data(iterator);
4f45f9bb JD	235	assert(debug_it);
4f45f9bb JD	236
7b077a9d	237	component = bt_private_notification_iterator_get_private_component(iterator);
4f45f9bb	238	assert(component);
7b077a9d	239	debug_info = bt_private_component_get_user_data(component);
4f45f9bb JD	240	assert(debug_info);
	241
	242	source_it = debug_it->input_iterator;
	243
7b077a9d JD	244	ret.status = bt_notification_iterator_next(source_it);
7b077a9d JD	245	if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
4f45f9bb JD	246	goto end;
	247	}
	248
	249	notification = bt_notification_iterator_get_notification(
	250	source_it);
	251	if (!notification) {
7b077a9d	252	ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
4f45f9bb JD	253	goto end;
	254	}
	255
7b077a9d	256	ret.notification = handle_notification(debug_info->err, debug_it,
4f45f9bb	257	notification);
7b077a9d	258	assert(ret.notification);
4f45f9bb JD	259	bt_put(notification);
4f45f9bb JD	260
4f45f9bb JD	261	end:
	262	bt_put(component);
	263	return ret;
	264	}
	265
7b077a9d	266	/*
4f45f9bb JD	267	static
4f45f9bb JD	268	struct bt_notification *debug_info_iterator_get(
7b077a9d	269	struct bt_private_notification_iterator *iterator)
4f45f9bb JD	270	{
	271	struct debug_info_iterator *debug_it;
	272
7b077a9d	273	debug_it = bt_private_notification_iterator_get_user_data(iterator);
4f45f9bb JD	274	assert(debug_it);
	275
	276	if (!debug_it->current_notification) {
	277	enum bt_notification_iterator_status it_ret;
	278
	279	it_ret = debug_info_iterator_next(iterator);
	280	if (it_ret) {
	281	goto end;
	282	}
	283	}
	284
	285	end:
	286	return bt_get(debug_it->current_notification);
	287	}
7b077a9d	288	*/
4f45f9bb JD	289
	290	static
	291	enum bt_notification_iterator_status debug_info_iterator_seek_time(
7b077a9d	292	struct bt_private_notification_iterator *iterator, int64_t time)
4f45f9bb JD	293	{
	294	enum bt_notification_iterator_status ret;
	295
	296	ret = BT_NOTIFICATION_ITERATOR_STATUS_OK;
	297
	298	return ret;
	299	}
	300
	301	static
7b077a9d JD	302	enum bt_notification_iterator_status debug_info_iterator_init(
	303	struct bt_private_notification_iterator *iterator,
	304	struct bt_private_port *port)
4f45f9bb JD	305	{
	306	enum bt_notification_iterator_status ret =
	307	BT_NOTIFICATION_ITERATOR_STATUS_OK;
	308	enum bt_notification_iterator_status it_ret;
7b077a9d JD	309	struct bt_private_port *input_port = NULL;
	310	struct bt_private_connection *connection = NULL;
	311	struct bt_private_component *component =
	312	bt_private_notification_iterator_get_private_component(iterator);
4f45f9bb JD	313	struct debug_info_iterator *it_data = g_new0(struct debug_info_iterator, 1);
	314
	315	if (!it_data) {
	316	ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
	317	goto end;
	318	}
	319
	320	/* Create a new iterator on the upstream component. */
7b077a9d	321	input_port = bt_private_component_filter_get_default_input_private_port(component);
4f45f9bb	322	assert(input_port);
7b077a9d	323	connection = bt_private_port_get_private_connection(input_port);
4f45f9bb JD	324	assert(connection);
4f45f9bb JD	325
7b077a9d	326	it_data->input_iterator = bt_private_connection_create_notification_iterator(
4f45f9bb JD	327	connection);
	328	if (!it_data->input_iterator) {
	329	ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
	330	goto end;
	331	}
	332	it_data->debug_info_component = (struct debug_info_component *)
7b077a9d	333	bt_private_component_get_user_data(component);
4f45f9bb JD	334
	335	it_data->err = it_data->debug_info_component->err;
	336	it_data->trace_map = g_hash_table_new_full(g_direct_hash,
	337	g_direct_equal, NULL, (GDestroyNotify) unref_trace);
	338	it_data->stream_map = g_hash_table_new_full(g_direct_hash,
	339	g_direct_equal, NULL, (GDestroyNotify) unref_stream);
	340	it_data->stream_class_map = g_hash_table_new_full(g_direct_hash,
	341	g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
	342	it_data->packet_map = g_hash_table_new_full(g_direct_hash,
	343	g_direct_equal, NULL, (GDestroyNotify) unref_packet);
	344	it_data->trace_debug_map = g_hash_table_new_full(g_direct_hash,
	345	g_direct_equal, NULL, (GDestroyNotify) unref_debug_info);
	346
7b077a9d	347	it_ret = bt_private_notification_iterator_set_user_data(iterator, it_data);
4f45f9bb JD	348	if (it_ret) {
	349	goto end;
	350	}
	351
	352	end:
	353	bt_put(connection);
	354	bt_put(input_port);
	355	return ret;
	356	}
	357
	358	static
	359	enum bt_component_status init_from_params(
	360	struct debug_info_component *debug_info_component,
	361	struct bt_value *params)
	362	{
	363	struct bt_value *value = NULL;
	364	enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
	365
	366	assert(params);
	367
	368	value = bt_value_map_get(params, "debug-info-field-name");
	369	if (value) {
	370	enum bt_value_status value_ret;
	371	const char *tmp;
	372
	373	value_ret = bt_value_string_get(value, &tmp);
	374	if (value_ret) {
	375	ret = BT_COMPONENT_STATUS_INVALID;
	376	printf_error("Failed to retrieve debug-info-field-name value. "
	377	"Expecting a string");
	378	}
	379	strcpy(debug_info_component->arg_debug_info_field_name, tmp);
	380	bt_put(value);
	381	} else {
	382	debug_info_component->arg_debug_info_field_name =
	383	malloc(strlen("debug_info") + 1);
	384	if (!debug_info_component->arg_debug_info_field_name) {
	385	ret = BT_COMPONENT_STATUS_NOMEM;
	386	printf_error();
	387	}
	388	sprintf(debug_info_component->arg_debug_info_field_name,
	389	"debug_info");
	390	}
	391	if (ret != BT_COMPONENT_STATUS_OK) {
	392	goto end;
	393	}
	394
	395	value = bt_value_map_get(params, "debug-dir");
	396	if (value) {
	397	enum bt_value_status value_ret;
	398
	399	value_ret = bt_value_string_get(value,
	400	&debug_info_component->arg_debug_dir);
	401	if (value_ret) {
	402	ret = BT_COMPONENT_STATUS_INVALID;
	403	printf_error("Failed to retrieve debug-dir value. "
	404	"Expecting a string");
	405	}
	406	}
	407	bt_put(value);
	408	if (ret != BT_COMPONENT_STATUS_OK) {
	409	goto end;
	410	}
	411
412	value = bt_value_map_get(params, "target-prefix");
413	if (value) {
414	enum bt_value_status value_ret;
415
416	value_ret = bt_value_string_get(value,
417	&debug_info_component->arg_target_prefix);
418	if (value_ret) {
419	ret = BT_COMPONENT_STATUS_INVALID;
420	printf_error("Failed to retrieve target-prefix value. "
421	"Expecting a string");
422	}
423	}
424	bt_put(value);
425	if (ret != BT_COMPONENT_STATUS_OK) {
426	goto end;
427	}
428
429	value = bt_value_map_get(params, "full-path");
430	if (value) {
431	enum bt_value_status value_ret;
432
433	value_ret = bt_value_bool_get(value,
434	&debug_info_component->arg_full_path);
435	if (value_ret) {
436	ret = BT_COMPONENT_STATUS_INVALID;
437	printf_error("Failed to retrieve full-path value. "
438	"Expecting a boolean");
439	}
440	}
441	bt_put(value);
442	if (ret != BT_COMPONENT_STATUS_OK) {
443	goto end;
444	}
445
446	end:
447	return ret;
448	}
449
450	enum bt_component_status debug_info_component_init(
7b077a9d	451	struct bt_private_component component, struct bt_value params,
4f45f9bb JD	452	UNUSED_VAR void *init_method_data)
	453	{
	454	enum bt_component_status ret;
	455	struct debug_info_component *debug_info = create_debug_info_component_data();
	456
	457	if (!debug_info) {
	458	ret = BT_COMPONENT_STATUS_NOMEM;
	459	goto end;
	460	}
	461
7b077a9d	462	ret = bt_private_component_set_user_data(component, debug_info);
4f45f9bb JD	463	if (ret != BT_COMPONENT_STATUS_OK) {
	464	goto error;
	465	}
	466
	467	ret = init_from_params(debug_info, params);
	468	end:
	469	return ret;
	470	error:
	471	destroy_debug_info_data(debug_info);
	472	return ret;
	473	}
	474
	475	/* Initialize plug-in entry points. */
	476	BT_PLUGIN(debug_info);
	477	BT_PLUGIN_DESCRIPTION("Babeltrace Debug Informations Plug-In.");
	478	BT_PLUGIN_AUTHOR("Jérémie Galarneau");
	479	BT_PLUGIN_LICENSE("MIT");
	480
7b077a9d	481	BT_PLUGIN_FILTER_COMPONENT_CLASS(debug_info, debug_info_iterator_next);
4f45f9bb JD	482	BT_PLUGIN_FILTER_COMPONENT_CLASS_DESCRIPTION(debug_info,
	483	"Add the debug information to events if possible.");
	484	BT_PLUGIN_FILTER_COMPONENT_CLASS_INIT_METHOD(debug_info, debug_info_component_init);
7b077a9d	485	BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD(debug_info, destroy_debug_info_component);
4f45f9bb JD	486	BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_INIT_METHOD(debug_info,
4f45f9bb JD	487	debug_info_iterator_init);
7b077a9d	488	BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_FINALIZE_METHOD(debug_info,
4f45f9bb JD	489	debug_info_iterator_destroy);
	490	BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_SEEK_TIME_METHOD(debug_info,
	491	debug_info_iterator_seek_time);