[babeltrace.git] / plugins / text / text.c

/*
 * text.c
 *
 * Babeltrace CTF Text Output Plugin
 *
 * 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/plugin/plugin-macros.h>
#include <babeltrace/plugin/component.h>
#include <babeltrace/plugin/sink.h>
#include <babeltrace/plugin/notification/notification.h>
#include <stdio.h>
#include <stdbool.h>
#include <glib.h>

enum loglevel {
        LOGLEVEL_EMERG                  = 0,
        LOGLEVEL_ALERT                  = 1,
        LOGLEVEL_CRIT                   = 2,
        LOGLEVEL_ERR                    = 3,
        LOGLEVEL_WARNING                = 4,
        LOGLEVEL_NOTICE                 = 5,
        LOGLEVEL_INFO                   = 6,
        LOGLEVEL_DEBUG_SYSTEM           = 7,
        LOGLEVEL_DEBUG_PROGRAM          = 8,
        LOGLEVEL_DEBUG_PROCESS          = 9,
        LOGLEVEL_DEBUG_MODULE           = 10,
        LOGLEVEL_DEBUG_UNIT             = 11,
        LOGLEVEL_DEBUG_FUNCTION         = 12,
        LOGLEVEL_DEBUG_LINE             = 13,
        LOGLEVEL_DEBUG                  = 14,
};

static
const char *loglevel_str [] = {
	[LOGLEVEL_EMERG] =		"TRACE_EMERG",
	[LOGLEVEL_ALERT] =		"TRACE_ALERT",
	[LOGLEVEL_CRIT] =		"TRACE_CRIT",
	[LOGLEVEL_ERR] =		"TRACE_ERR",
	[LOGLEVEL_WARNING] =		"TRACE_WARNING",
	[LOGLEVEL_NOTICE] =		"TRACE_NOTICE",
	[LOGLEVEL_INFO] =		"TRACE_INFO",
	[LOGLEVEL_DEBUG_SYSTEM] =	"TRACE_DEBUG_SYSTEM",
	[LOGLEVEL_DEBUG_PROGRAM] =	"TRACE_DEBUG_PROGRAM",
	[LOGLEVEL_DEBUG_PROCESS] =	"TRACE_DEBUG_PROCESS",
	[LOGLEVEL_DEBUG_MODULE] =	"TRACE_DEBUG_MODULE",
	[LOGLEVEL_DEBUG_UNIT] =		"TRACE_DEBUG_UNIT",
	[LOGLEVEL_DEBUG_FUNCTION] =	"TRACE_DEBUG_FUNCTION",
	[LOGLEVEL_DEBUG_LINE] =		"TRACE_DEBUG_LINE",
	[LOGLEVEL_DEBUG] =		"TRACE_DEBUG",
};

struct text_options {
	bool print_scope_field_names : 1;
	bool print_header_field_names : 1;
	bool print_context_field_names : 1;
	bool print_payload_field_names : 1;
	bool print_delta_field : 1;
	bool print_loglevel_field : 1;
	bool print_trace_field : 1;
	bool print_trace_domain_field : 1;
	bool print_trace_procname_field : 1;
	bool print_trace_vpid_field : 1;
	bool print_trace_hostname_field : 1;
	bool no_size_limit : 1;
};

struct text_component {
	struct text_options options;
	FILE *out, *err;
};

static
struct text_component *create_text(void)
{
	return g_new0(struct text_component, 1);
}

static
void destroy_text_data(struct text_component *data)
{
	g_free(data);
}

static void destroy_text(struct bt_component *component)
{
	void *data = bt_component_get_private_data(component);

	destroy_text_data(data);
}

static
enum bt_component_status handle_notification(struct bt_component *component,
	struct bt_notification *notification)
{
	switch (bt_notification_get_type(notification)) {
	case BT_NOTIFICATION_TYPE_PACKET_START:
		puts("<packet>");
		break;
	case BT_NOTIFICATION_TYPE_PACKET_END:
		puts("</packet>");
		break;
	case BT_NOTIFICATION_TYPE_EVENT:
		puts("\t<event>");
		break;
	case BT_NOTIFICATION_TYPE_STREAM_END:
		puts("</stream>");
		break;
	default:
		puts("Unhandled notification type");
	}
	return BT_COMPONENT_STATUS_OK;
}

static
enum bt_component_status text_component_init(
	struct bt_component *component, struct bt_value *params)
{
	enum bt_component_status ret;
	struct text_component *text = create_text();

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

	ret = bt_component_set_destroy_cb(component,
			destroy_text);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = bt_component_set_private_data(component, text);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	ret = bt_component_sink_set_handle_notification_cb(component,
			handle_notification);
	if (ret != BT_COMPONENT_STATUS_OK) {
		goto error;
	}

	text->out = stdout;
	text->err = stderr;
end:
	return ret;
error:
	destroy_text_data(text);
	return ret;
}

/* Initialize plug-in entry points. */
BT_PLUGIN_NAME("text");
BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
BT_PLUGIN_AUTHOR("Jérémie Galarneau");
BT_PLUGIN_LICENSE("MIT");

BT_PLUGIN_COMPONENT_CLASSES_BEGIN
BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text", "Formats CTF-IR to text. Formerly known as ctf-text.", text_component_init)
BT_PLUGIN_COMPONENT_CLASSES_END
Commit	Line	Data
7a278c8e	1	/*
5dac767a	2	* text.c
7a278c8e	3	*
5dac767a	4	* Babeltrace CTF Text Output Plugin
7a278c8e	5	*
2e339de1	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7a278c8e JG	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
38b48196	29	#include <babeltrace/plugin/plugin-macros.h>
480dc8ed	30	#include <babeltrace/plugin/component.h>
5dac767a	31	#include <babeltrace/plugin/sink.h>
480dc8ed	32	#include <babeltrace/plugin/notification/notification.h>
bfd20a42	33	#include <stdio.h>
39cfa40f	34	#include <stdbool.h>
bac67f0f	35	#include <glib.h>
480dc8ed	36
6405967d JG	37	enum loglevel {
	38	LOGLEVEL_EMERG = 0,
	39	LOGLEVEL_ALERT = 1,
	40	LOGLEVEL_CRIT = 2,
	41	LOGLEVEL_ERR = 3,
	42	LOGLEVEL_WARNING = 4,
	43	LOGLEVEL_NOTICE = 5,
	44	LOGLEVEL_INFO = 6,
	45	LOGLEVEL_DEBUG_SYSTEM = 7,
	46	LOGLEVEL_DEBUG_PROGRAM = 8,
	47	LOGLEVEL_DEBUG_PROCESS = 9,
	48	LOGLEVEL_DEBUG_MODULE = 10,
	49	LOGLEVEL_DEBUG_UNIT = 11,
	50	LOGLEVEL_DEBUG_FUNCTION = 12,
	51	LOGLEVEL_DEBUG_LINE = 13,
	52	LOGLEVEL_DEBUG = 14,
	53	};
	54
4647b93a	55	static
6405967d	56	const char *loglevel_str [] = {
480dc8ed JG	57	[LOGLEVEL_EMERG] = "TRACE_EMERG",
	58	[LOGLEVEL_ALERT] = "TRACE_ALERT",
	59	[LOGLEVEL_CRIT] = "TRACE_CRIT",
	60	[LOGLEVEL_ERR] = "TRACE_ERR",
	61	[LOGLEVEL_WARNING] = "TRACE_WARNING",
	62	[LOGLEVEL_NOTICE] = "TRACE_NOTICE",
	63	[LOGLEVEL_INFO] = "TRACE_INFO",
	64	[LOGLEVEL_DEBUG_SYSTEM] = "TRACE_DEBUG_SYSTEM",
	65	[LOGLEVEL_DEBUG_PROGRAM] = "TRACE_DEBUG_PROGRAM",
	66	[LOGLEVEL_DEBUG_PROCESS] = "TRACE_DEBUG_PROCESS",
	67	[LOGLEVEL_DEBUG_MODULE] = "TRACE_DEBUG_MODULE",
	68	[LOGLEVEL_DEBUG_UNIT] = "TRACE_DEBUG_UNIT",
	69	[LOGLEVEL_DEBUG_FUNCTION] = "TRACE_DEBUG_FUNCTION",
	70	[LOGLEVEL_DEBUG_LINE] = "TRACE_DEBUG_LINE",
	71	[LOGLEVEL_DEBUG] = "TRACE_DEBUG",
6405967d JG	72	};
6405967d JG	73
bac67f0f	74	struct text_options {
043e2020 JG	75	bool print_scope_field_names : 1;
	76	bool print_header_field_names : 1;
	77	bool print_context_field_names : 1;
	78	bool print_payload_field_names : 1;
	79	bool print_delta_field : 1;
	80	bool print_loglevel_field : 1;
	81	bool print_trace_field : 1;
	82	bool print_trace_domain_field : 1;
	83	bool print_trace_procname_field : 1;
	84	bool print_trace_vpid_field : 1;
	85	bool print_trace_hostname_field : 1;
	86	bool no_size_limit : 1;
bfd20a42 JG	87	};
bfd20a42 JG	88
bac67f0f JG	89	struct text_component {
bac67f0f JG	90	struct text_options options;
043e2020	91	FILE out, err;
bac67f0f JG	92	};
bac67f0f JG	93
bfd20a42	94	static
bac67f0f JG	95	struct text_component *create_text(void)
	96	{
	97	return g_new0(struct text_component, 1);
	98	}
	99
b25bd455 JG	100	static
b25bd455 JG	101	void destroy_text_data(struct text_component *data)
bac67f0f	102	{
e78cdc59	103	g_free(data);
bac67f0f JG	104	}
bac67f0f JG	105
b25bd455 JG	106	static void destroy_text(struct bt_component *component)
	107	{
	108	void *data = bt_component_get_private_data(component);
	109
	110	destroy_text_data(data);
	111	}
	112
bac67f0f JG	113	static
	114	enum bt_component_status handle_notification(struct bt_component *component,
	115	struct bt_notification *notification)
4c1456f0	116	{
78586d8a JG	117	switch (bt_notification_get_type(notification)) {
	118	case BT_NOTIFICATION_TYPE_PACKET_START:
	119	puts("<packet>");
	120	break;
	121	case BT_NOTIFICATION_TYPE_PACKET_END:
	122	puts("</packet>");
	123	break;
	124	case BT_NOTIFICATION_TYPE_EVENT:
043e2020 JG	125	puts("\t<event>");
	126	break;
	127	case BT_NOTIFICATION_TYPE_STREAM_END:
	128	puts("</stream>");
78586d8a JG	129	break;
	130	default:
	131	puts("Unhandled notification type");
	132	}
480dc8ed	133	return BT_COMPONENT_STATUS_OK;
4c1456f0	134	}
bac67f0f JG	135
	136	static
	137	enum bt_component_status text_component_init(
	138	struct bt_component component, struct bt_value params)
	139	{
	140	enum bt_component_status ret;
	141	struct text_component *text = create_text();
	142
	143	if (!text) {
	144	ret = BT_COMPONENT_STATUS_NOMEM;
	145	goto end;
	146	}
	147
a97c4b1a	148	ret = bt_component_set_destroy_cb(component,
e78cdc59	149	destroy_text);
bac67f0f JG	150	if (ret != BT_COMPONENT_STATUS_OK) {
	151	goto error;
	152	}
	153
	154	ret = bt_component_set_private_data(component, text);
	155	if (ret != BT_COMPONENT_STATUS_OK) {
	156	goto error;
	157	}
	158
	159	ret = bt_component_sink_set_handle_notification_cb(component,
b25bd455	160	handle_notification);
bac67f0f JG	161	if (ret != BT_COMPONENT_STATUS_OK) {
	162	goto error;
	163	}
043e2020 JG	164
	165	text->out = stdout;
	166	text->err = stderr;
bac67f0f JG	167	end:
	168	return ret;
	169	error:
b25bd455	170	destroy_text_data(text);
bac67f0f JG	171	return ret;
	172	}
	173
bac67f0f	174	/* Initialize plug-in entry points. */
56a1cced	175	BT_PLUGIN_NAME("text");
bac67f0f JG	176	BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
	177	BT_PLUGIN_AUTHOR("Jérémie Galarneau");
	178	BT_PLUGIN_LICENSE("MIT");
	179
	180	BT_PLUGIN_COMPONENT_CLASSES_BEGIN
	181	BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text", "Formats CTF-IR to text. Formerly known as ctf-text.", text_component_init)
	182	BT_PLUGIN_COMPONENT_CLASSES_END