[babeltrace.git] / formats / ctf-text / ctf-text.c

/*
 * BabelTrace - Common Trace Format (CTF)
 *
 * CTF Text Format registration.
 *
 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
 *
 * Author: Mathieu Desnoyers <mathieu.desnoyers@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.
 */

#include <babeltrace/format.h>
#include <babeltrace/ctf-text/types.h>
#include <babeltrace/ctf/metadata.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/ctf/events-internal.h>
#include <inttypes.h>
#include <uuid/uuid.h>
#include <sys/mman.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <dirent.h>
#include <glib.h>
#include <unistd.h>
#include <stdlib.h>

#define NSEC_PER_SEC 1000000000ULL

int opt_all_field_names,
	opt_scope_field_names,
	opt_header_field_names,
	opt_context_field_names,
	opt_payload_field_names,
	opt_all_fields,
	opt_trace_field,
	opt_trace_domain_field,
	opt_trace_procname_field,
	opt_trace_vpid_field,
	opt_loglevel_field,
	opt_delta_field = 1;

enum field_item {
	ITEM_SCOPE,
	ITEM_HEADER,
	ITEM_CONTEXT,
	ITEM_PAYLOAD,
};

enum bt_loglevel {
        BT_LOGLEVEL_EMERG                  = 0,
        BT_LOGLEVEL_ALERT                  = 1,
        BT_LOGLEVEL_CRIT                   = 2,
        BT_LOGLEVEL_ERR                    = 3,
        BT_LOGLEVEL_WARNING                = 4,
        BT_LOGLEVEL_NOTICE                 = 5,
        BT_LOGLEVEL_INFO                   = 6,
        BT_LOGLEVEL_DEBUG_SYSTEM           = 7,
        BT_LOGLEVEL_DEBUG_PROGRAM          = 8,
        BT_LOGLEVEL_DEBUG_PROCESS          = 9,
        BT_LOGLEVEL_DEBUG_MODULE           = 10,
        BT_LOGLEVEL_DEBUG_UNIT             = 11,
        BT_LOGLEVEL_DEBUG_FUNCTION         = 12,
        BT_LOGLEVEL_DEBUG_LINE             = 13,
        BT_LOGLEVEL_DEBUG                  = 14,
};


struct trace_descriptor *ctf_text_open_trace(const char *path, int flags,
		void (*packet_seek)(struct stream_pos *pos, size_t index,
			int whence), FILE *metadata_fp);
void ctf_text_close_trace(struct trace_descriptor *descriptor);

static
rw_dispatch write_dispatch_table[] = {
	[ CTF_TYPE_INTEGER ] = ctf_text_integer_write,
	[ CTF_TYPE_FLOAT ] = ctf_text_float_write,
	[ CTF_TYPE_ENUM ] = ctf_text_enum_write,
	[ CTF_TYPE_STRING ] = ctf_text_string_write,
	[ CTF_TYPE_STRUCT ] = ctf_text_struct_write,
	[ CTF_TYPE_VARIANT ] = ctf_text_variant_write,
	[ CTF_TYPE_ARRAY ] = ctf_text_array_write,
	[ CTF_TYPE_SEQUENCE ] = ctf_text_sequence_write,
};

static
struct format ctf_text_format = {
	.open_trace = ctf_text_open_trace,
	.close_trace = ctf_text_close_trace,
};

static GQuark Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN,
	Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END,
	Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED,
	Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE,
	Q_STREAM_PACKET_CONTEXT_PACKET_SIZE;

static
void __attribute__((constructor)) init_quarks(void)
{
	Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN = g_quark_from_static_string("stream.packet.context.timestamp_begin");
	Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END = g_quark_from_static_string("stream.packet.context.timestamp_end");
	Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED = g_quark_from_static_string("stream.packet.context.events_discarded");
	Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE = g_quark_from_static_string("stream.packet.context.content_size");
	Q_STREAM_PACKET_CONTEXT_PACKET_SIZE = g_quark_from_static_string("stream.packet.context.packet_size");
}

int print_field(struct definition *definition)
{
	/* Print all fields in verbose mode */
	if (babeltrace_verbose)
		return 1;

	/* Filter out part of the packet context */
	if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN)
		return 0;
	if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END)
		return 0;
	if (definition->path == Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED)
		return 0;
	if (definition->path == Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE)
		return 0;
	if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SIZE)
		return 0;

	return 1;
}

static
void set_field_names_print(struct ctf_text_stream_pos *pos, enum field_item item)
{
	switch (item) {
	case ITEM_SCOPE:
		if (opt_all_field_names || opt_scope_field_names)
			pos->print_names = 1;
		else
			pos->print_names = 0;
		break;
	case ITEM_HEADER:
		if (opt_all_field_names || opt_header_field_names)
			pos->print_names = 1;
		else
			pos->print_names = 0;
		break;
	case ITEM_CONTEXT:
		if (opt_all_field_names || opt_context_field_names)
			pos->print_names = 1;
		else
			pos->print_names = 0;
		break;
	case ITEM_PAYLOAD:
		if (opt_all_field_names || opt_payload_field_names)
			pos->print_names = 1;
		else
			pos->print_names = 0;

		break;
	default:
		assert(0);
	}
}

static
const char *print_loglevel(int value)
{
	switch (value) {
	case -1:
		return "";
	case BT_LOGLEVEL_EMERG:
		return "TRACE_EMERG";
	case BT_LOGLEVEL_ALERT:
		return "TRACE_ALERT";
	case BT_LOGLEVEL_CRIT:
		return "TRACE_CRIT";
	case BT_LOGLEVEL_ERR:
		return "TRACE_ERR";
	case BT_LOGLEVEL_WARNING:
		return "TRACE_WARNING";
	case BT_LOGLEVEL_NOTICE:
		return "TRACE_NOTICE";
	case BT_LOGLEVEL_INFO:
		return "TRACE_INFO";
	case BT_LOGLEVEL_DEBUG_SYSTEM:
		return "TRACE_DEBUG_SYSTEM";
	case BT_LOGLEVEL_DEBUG_PROGRAM:
		return "TRACE_DEBUG_PROGRAM";
	case BT_LOGLEVEL_DEBUG_PROCESS:
		return "TRACE_DEBUG_PROCESS";
	case BT_LOGLEVEL_DEBUG_MODULE:
		return "TRACE_DEBUG_MODULE";
	case BT_LOGLEVEL_DEBUG_UNIT:
		return "TRACE_DEBUG_UNIT";
	case BT_LOGLEVEL_DEBUG_FUNCTION:
		return "TRACE_DEBUG_FUNCTION";
	case BT_LOGLEVEL_DEBUG_LINE:
		return "TRACE_DEBUG_LINE";
	case BT_LOGLEVEL_DEBUG:
		return "TRACE_DEBUG";
	default:
		return "<<UNKNOWN>>";
	}
}

static
int ctf_text_write_event(struct stream_pos *ppos, struct ctf_stream *stream)
			 
{
	struct ctf_text_stream_pos *pos =
		container_of(ppos, struct ctf_text_stream_pos, parent);
	struct ctf_stream_class *stream_class = stream->stream_class;
	int field_nr_saved;
	struct ctf_event *event_class;
	struct ctf_stream_event *event;
	uint64_t id;
	int ret;
	int dom_print = 0;

	id = stream->event_id;

	if (id >= stream_class->events_by_id->len) {
		fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
		return -EINVAL;
	}
	event = g_ptr_array_index(stream->events_by_id, id);
	if (!event) {
		fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
		return -EINVAL;
	}
	event_class = g_ptr_array_index(stream_class->events_by_id, id);
	if (!event) {
		fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
		return -EINVAL;
	}

	/* Print events discarded */
	if (stream->events_discarded) {
		fflush(pos->fp);
		fprintf(stderr, "[warning] Tracer discarded %d events between [",
			stream->events_discarded);
		ctf_print_timestamp(stderr, stream, stream->prev_timestamp);
		fprintf(stderr, "] and [");
		ctf_print_timestamp(stderr, stream, stream->prev_timestamp_end);
		fprintf(stderr, "]. You should consider increasing the buffer size.\n");
		fflush(stderr);
		stream->events_discarded = 0;
	}

	if (stream->has_timestamp) {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names)
			fprintf(pos->fp, "timestamp = ");
		else
			fprintf(pos->fp, "[");
		ctf_print_timestamp(pos->fp, stream, stream->timestamp);
		if (!pos->print_names)
			fprintf(pos->fp, "]");

		if (pos->print_names)
			fprintf(pos->fp, ", ");
		else
			fprintf(pos->fp, " ");
	}
	if ((opt_delta_field || opt_all_fields) && stream->has_timestamp) {
		uint64_t delta, delta_sec, delta_nsec;

		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names)
			fprintf(pos->fp, "delta = ");
		else
			fprintf(pos->fp, "(");
		if (pos->last_timestamp != -1ULL) {
			delta = stream->timestamp - pos->last_timestamp;
			delta_sec = delta / NSEC_PER_SEC;
			delta_nsec = delta % NSEC_PER_SEC;
			fprintf(pos->fp, "+%" PRIu64 ".%09" PRIu64,
				delta_sec, delta_nsec);
		} else {
			fprintf(pos->fp, "+?.?????????");
		}
		if (!pos->print_names)
			fprintf(pos->fp, ")");

		if (pos->print_names)
			fprintf(pos->fp, ", ");
		else
			fprintf(pos->fp, " ");
		pos->last_timestamp = stream->timestamp;
	}

	if ((opt_trace_field || opt_all_fields) && stream_class->trace->path[0] != '\0') {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "trace = ");
		}
		fprintf(pos->fp, "%s", stream_class->trace->path);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		else
			fprintf(pos->fp, " ");
	}
	if ((opt_trace_domain_field && !opt_all_fields) && stream_class->trace->env.domain[0] != '\0') {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "trace:domain = ");
		}
		fprintf(pos->fp, "%s", stream_class->trace->env.domain);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		dom_print = 1;
	}
	if ((opt_trace_procname_field && !opt_all_fields) && stream_class->trace->env.procname[0] != '\0') {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "trace:procname = ");
		} else if (dom_print) {
			fprintf(pos->fp, ":");
		}
		fprintf(pos->fp, "%s", stream_class->trace->env.procname);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		dom_print = 1;
	}
	if ((opt_trace_vpid_field && !opt_all_fields) && stream_class->trace->env.vpid != -1) {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "trace:vpid = ");
		} else if (dom_print) {
			fprintf(pos->fp, ":");
		}
		fprintf(pos->fp, "%d", stream_class->trace->env.vpid);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		dom_print = 1;
	}
	if ((opt_loglevel_field || opt_all_fields) && event_class->loglevel != -1) {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "loglevel = ");
		} else if (dom_print) {
			fprintf(pos->fp, ":");
		}
		fprintf(pos->fp, "%s (%d)",
			print_loglevel(event_class->loglevel),
			event_class->loglevel);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		dom_print = 1;
	}
	if (dom_print && !pos->print_names)
		fprintf(pos->fp, " ");
	set_field_names_print(pos, ITEM_HEADER);
	if (pos->print_names)
		fprintf(pos->fp, "name = ");
	fprintf(pos->fp, "%s", g_quark_to_string(event_class->name));
	if (pos->print_names)
		pos->field_nr++;
	else
		fprintf(pos->fp, ":");

	/* print cpuid field from packet context */
	if (stream->stream_packet_context) {
		if (pos->field_nr++ != 0)
			fprintf(pos->fp, ",");
		set_field_names_print(pos, ITEM_SCOPE);
		if (pos->print_names)
			fprintf(pos->fp, " stream.packet.context =");
		field_nr_saved = pos->field_nr;
		pos->field_nr = 0;
		set_field_names_print(pos, ITEM_CONTEXT);
		ret = generic_rw(ppos, &stream->stream_packet_context->p);
		if (ret)
			goto error;
		pos->field_nr = field_nr_saved;
	}

	/* Only show the event header in verbose mode */
	if (babeltrace_verbose && stream->stream_event_header) {
		if (pos->field_nr++ != 0)
			fprintf(pos->fp, ",");
		set_field_names_print(pos, ITEM_SCOPE);
		if (pos->print_names)
			fprintf(pos->fp, " stream.event.header =");
		field_nr_saved = pos->field_nr;
		pos->field_nr = 0;
		set_field_names_print(pos, ITEM_CONTEXT);
		ret = generic_rw(ppos, &stream->stream_event_header->p);
		if (ret)
			goto error;
		pos->field_nr = field_nr_saved;
	}

	/* print stream-declared event context */
	if (stream->stream_event_context) {
		if (pos->field_nr++ != 0)
			fprintf(pos->fp, ",");
		set_field_names_print(pos, ITEM_SCOPE);
		if (pos->print_names)
			fprintf(pos->fp, " stream.event.context =");
		field_nr_saved = pos->field_nr;
		pos->field_nr = 0;
		set_field_names_print(pos, ITEM_CONTEXT);
		ret = generic_rw(ppos, &stream->stream_event_context->p);
		if (ret)
			goto error;
		pos->field_nr = field_nr_saved;
	}

	/* print event-declared event context */
	if (event->event_context) {
		if (pos->field_nr++ != 0)
			fprintf(pos->fp, ",");
		set_field_names_print(pos, ITEM_SCOPE);
		if (pos->print_names)
			fprintf(pos->fp, " event.context =");
		field_nr_saved = pos->field_nr;
		pos->field_nr = 0;
		set_field_names_print(pos, ITEM_CONTEXT);
		ret = generic_rw(ppos, &event->event_context->p);
		if (ret)
			goto error;
		pos->field_nr = field_nr_saved;
	}

	/* Read and print event payload */
	if (event->event_fields) {
		if (pos->field_nr++ != 0)
			fprintf(pos->fp, ",");
		set_field_names_print(pos, ITEM_SCOPE);
		if (pos->print_names)
			fprintf(pos->fp, " event.fields =");
		field_nr_saved = pos->field_nr;
		pos->field_nr = 0;
		set_field_names_print(pos, ITEM_PAYLOAD);
		ret = generic_rw(ppos, &event->event_fields->p);
		if (ret)
			goto error;
		pos->field_nr = field_nr_saved;
	}
	/* newline */
	fprintf(pos->fp, "\n");
	pos->field_nr = 0;
	stream->consumed = 1;

	return 0;

error:
	fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
	return ret;
}


struct trace_descriptor *ctf_text_open_trace(const char *path, int flags,
		void (*packet_seek)(struct stream_pos *pos, size_t index,
			int whence), FILE *metadata_fp)
{
	struct ctf_text_stream_pos *pos;
	FILE *fp;

	pos = g_new0(struct ctf_text_stream_pos, 1);

	pos->last_timestamp = -1ULL;
	switch (flags & O_ACCMODE) {
	case O_RDWR:
		if (!path)
			fp = stdout;
		else
			fp = fopen(path, "w");
		if (!fp)
			goto error;
		pos->fp = fp;
		pos->parent.rw_table = write_dispatch_table;
		pos->parent.event_cb = ctf_text_write_event;
		pos->print_names = 0;
		break;
	case O_RDONLY:
	default:
		fprintf(stderr, "[error] Incorrect open flags.\n");
		goto error;
	}

	return &pos->trace_descriptor;
error:
	g_free(pos);
	return NULL;
}

void ctf_text_close_trace(struct trace_descriptor *td)
{
	struct ctf_text_stream_pos *pos =
		container_of(td, struct ctf_text_stream_pos, trace_descriptor);
	fclose(pos->fp);
	g_free(pos);
}

void __attribute__((constructor)) ctf_text_init(void)
{
	int ret;

	ctf_text_format.name = g_quark_from_static_string("text");
	ret = bt_register_format(&ctf_text_format);
	assert(!ret);
}

/* TODO: finalize */
Commit	Line	Data
642ec66d MD	1	/*
	2	* BabelTrace - Common Trace Format (CTF)
	3	*
	4	* CTF Text Format registration.
	5	*
64fa3fec MD	6	* Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
	7	*
	8	* Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
642ec66d MD	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
	21	#include <babeltrace/format.h>
	22	#include <babeltrace/ctf-text/types.h>
31262354	23	#include <babeltrace/ctf/metadata.h>
70bd0a12	24	#include <babeltrace/babeltrace-internal.h>
e4195791	25	#include <babeltrace/ctf/events-internal.h>
642ec66d MD	26	#include <inttypes.h>
	27	#include <uuid/uuid.h>
	28	#include <sys/mman.h>
	29	#include <errno.h>
	30	#include <sys/types.h>
	31	#include <sys/stat.h>
	32	#include <fcntl.h>
	33	#include <dirent.h>
	34	#include <glib.h>
	35	#include <unistd.h>
	36	#include <stdlib.h>
	37
bfe74b8c MD	38	#define NSEC_PER_SEC 1000000000ULL
bfe74b8c MD	39
cba1661c MD	40	int opt_all_field_names,
	41	opt_scope_field_names,
	42	opt_header_field_names,
	43	opt_context_field_names,
82662ad4	44	opt_payload_field_names,
359d7456 MD	45	opt_all_fields,
	46	opt_trace_field,
	47	opt_trace_domain_field,
	48	opt_trace_procname_field,
	49	opt_trace_vpid_field,
	50	opt_loglevel_field,
7d97fad9	51	opt_delta_field = 1;
cba1661c MD	52
	53	enum field_item {
	54	ITEM_SCOPE,
	55	ITEM_HEADER,
	56	ITEM_CONTEXT,
	57	ITEM_PAYLOAD,
	58	};
b88d6e85	59
39535929 MD	60	enum bt_loglevel {
	61	BT_LOGLEVEL_EMERG = 0,
	62	BT_LOGLEVEL_ALERT = 1,
	63	BT_LOGLEVEL_CRIT = 2,
	64	BT_LOGLEVEL_ERR = 3,
	65	BT_LOGLEVEL_WARNING = 4,
	66	BT_LOGLEVEL_NOTICE = 5,
	67	BT_LOGLEVEL_INFO = 6,
	68	BT_LOGLEVEL_DEBUG_SYSTEM = 7,
	69	BT_LOGLEVEL_DEBUG_PROGRAM = 8,
	70	BT_LOGLEVEL_DEBUG_PROCESS = 9,
	71	BT_LOGLEVEL_DEBUG_MODULE = 10,
	72	BT_LOGLEVEL_DEBUG_UNIT = 11,
	73	BT_LOGLEVEL_DEBUG_FUNCTION = 12,
	74	BT_LOGLEVEL_DEBUG_LINE = 13,
	75	BT_LOGLEVEL_DEBUG = 14,
	76	};
	77
	78
5b80ddfb	79	struct trace_descriptor ctf_text_open_trace(const char path, int flags,
20d0dcf9	80	void (packet_seek)(struct stream_pos pos, size_t index,
ae23d232	81	int whence), FILE *metadata_fp);
642ec66d MD	82	void ctf_text_close_trace(struct trace_descriptor *descriptor);
642ec66d MD	83
642ec66d MD	84	static
	85	rw_dispatch write_dispatch_table[] = {
	86	[ CTF_TYPE_INTEGER ] = ctf_text_integer_write,
	87	[ CTF_TYPE_FLOAT ] = ctf_text_float_write,
	88	[ CTF_TYPE_ENUM ] = ctf_text_enum_write,
	89	[ CTF_TYPE_STRING ] = ctf_text_string_write,
	90	[ CTF_TYPE_STRUCT ] = ctf_text_struct_write,
	91	[ CTF_TYPE_VARIANT ] = ctf_text_variant_write,
	92	[ CTF_TYPE_ARRAY ] = ctf_text_array_write,
	93	[ CTF_TYPE_SEQUENCE ] = ctf_text_sequence_write,
	94	};
	95
	96	static
	97	struct format ctf_text_format = {
	98	.open_trace = ctf_text_open_trace,
	99	.close_trace = ctf_text_close_trace,
	100	};
	101
d335f0f7 MD	102	static GQuark Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN,
	103	Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END,
	104	Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED,
	105	Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE,
	106	Q_STREAM_PACKET_CONTEXT_PACKET_SIZE;
	107
	108	static
	109	void __attribute__((constructor)) init_quarks(void)
	110	{
	111	Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN = g_quark_from_static_string("stream.packet.context.timestamp_begin");
	112	Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END = g_quark_from_static_string("stream.packet.context.timestamp_end");
	113	Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED = g_quark_from_static_string("stream.packet.context.events_discarded");
	114	Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE = g_quark_from_static_string("stream.packet.context.content_size");
	115	Q_STREAM_PACKET_CONTEXT_PACKET_SIZE = g_quark_from_static_string("stream.packet.context.packet_size");
	116	}
	117
	118	int print_field(struct definition *definition)
	119	{
	120	/* Print all fields in verbose mode */
	121	if (babeltrace_verbose)
	122	return 1;
	123
	124	/* Filter out part of the packet context */
	125	if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN)
	126	return 0;
	127	if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END)
	128	return 0;
	129	if (definition->path == Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED)
	130	return 0;
	131	if (definition->path == Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE)
	132	return 0;
	133	if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SIZE)
	134	return 0;
	135
	136	return 1;
	137	}
	138
cba1661c MD	139	static
	140	void set_field_names_print(struct ctf_text_stream_pos *pos, enum field_item item)
	141	{
	142	switch (item) {
	143	case ITEM_SCOPE:
	144	if (opt_all_field_names \|\| opt_scope_field_names)
	145	pos->print_names = 1;
	146	else
	147	pos->print_names = 0;
	148	break;
	149	case ITEM_HEADER:
	150	if (opt_all_field_names \|\| opt_header_field_names)
	151	pos->print_names = 1;
	152	else
	153	pos->print_names = 0;
	154	break;
	155	case ITEM_CONTEXT:
	156	if (opt_all_field_names \|\| opt_context_field_names)
	157	pos->print_names = 1;
	158	else
	159	pos->print_names = 0;
	160	break;
	161	case ITEM_PAYLOAD:
	162	if (opt_all_field_names \|\| opt_payload_field_names)
	163	pos->print_names = 1;
	164	else
	165	pos->print_names = 0;
	166
	167	break;
	168	default:
	169	assert(0);
	170	}
	171	}
	172
39535929 MD	173	static
	174	const char *print_loglevel(int value)
	175	{
	176	switch (value) {
	177	case -1:
	178	return "";
	179	case BT_LOGLEVEL_EMERG:
	180	return "TRACE_EMERG";
	181	case BT_LOGLEVEL_ALERT:
	182	return "TRACE_ALERT";
	183	case BT_LOGLEVEL_CRIT:
	184	return "TRACE_CRIT";
	185	case BT_LOGLEVEL_ERR:
	186	return "TRACE_ERR";
	187	case BT_LOGLEVEL_WARNING:
	188	return "TRACE_WARNING";
	189	case BT_LOGLEVEL_NOTICE:
	190	return "TRACE_NOTICE";
	191	case BT_LOGLEVEL_INFO:
	192	return "TRACE_INFO";
	193	case BT_LOGLEVEL_DEBUG_SYSTEM:
	194	return "TRACE_DEBUG_SYSTEM";
	195	case BT_LOGLEVEL_DEBUG_PROGRAM:
	196	return "TRACE_DEBUG_PROGRAM";
	197	case BT_LOGLEVEL_DEBUG_PROCESS:
	198	return "TRACE_DEBUG_PROCESS";
	199	case BT_LOGLEVEL_DEBUG_MODULE:
	200	return "TRACE_DEBUG_MODULE";
	201	case BT_LOGLEVEL_DEBUG_UNIT:
	202	return "TRACE_DEBUG_UNIT";
	203	case BT_LOGLEVEL_DEBUG_FUNCTION:
	204	return "TRACE_DEBUG_FUNCTION";
	205	case BT_LOGLEVEL_DEBUG_LINE:
	206	return "TRACE_DEBUG_LINE";
	207	case BT_LOGLEVEL_DEBUG:
	208	return "TRACE_DEBUG";
	209	default:
	210	return "<<UNKNOWN>>";
	211	}
	212	}
	213
31262354	214	static
e4195791 MD	215	int ctf_text_write_event(struct stream_pos ppos, struct ctf_stream stream)
e4195791 MD	216
31262354 MD	217	{
	218	struct ctf_text_stream_pos *pos =
	219	container_of(ppos, struct ctf_text_stream_pos, parent);
764af3f4	220	struct ctf_stream_class *stream_class = stream->stream_class;
fd3382e8	221	int field_nr_saved;
31262354	222	struct ctf_event *event_class;
42dc00b7	223	struct ctf_stream_event *event;
c87a8eb2	224	uint64_t id;
31262354	225	int ret;
8c250d87	226	int dom_print = 0;
31262354	227
c87a8eb2	228	id = stream->event_id;
31262354 MD	229
31262354 MD	230	if (id >= stream_class->events_by_id->len) {
3394d22e	231	fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
31262354 MD	232	return -EINVAL;
31262354 MD	233	}
e28d4618 MD	234	event = g_ptr_array_index(stream->events_by_id, id);
e28d4618 MD	235	if (!event) {
3394d22e	236	fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
e28d4618 MD	237	return -EINVAL;
e28d4618 MD	238	}
31262354	239	event_class = g_ptr_array_index(stream_class->events_by_id, id);
e28d4618	240	if (!event) {
3394d22e	241	fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
31262354 MD	242	return -EINVAL;
	243	}
	244
fca04958 MD	245	/* Print events discarded */
fca04958 MD	246	if (stream->events_discarded) {
7d97fad9	247	fflush(pos->fp);
fca04958 MD	248	fprintf(stderr, "[warning] Tracer discarded %d events between [",
fca04958 MD	249	stream->events_discarded);
7d97fad9	250	ctf_print_timestamp(stderr, stream, stream->prev_timestamp);
fca04958	251	fprintf(stderr, "] and [");
7d97fad9	252	ctf_print_timestamp(stderr, stream, stream->prev_timestamp_end);
fca04958 MD	253	fprintf(stderr, "]. You should consider increasing the buffer size.\n");
	254	fflush(stderr);
	255	stream->events_discarded = 0;
	256	}
	257
5e2eb0ae	258	if (stream->has_timestamp) {
cba1661c	259	set_field_names_print(pos, ITEM_HEADER);
be60c7fb MD	260	if (pos->print_names)
	261	fprintf(pos->fp, "timestamp = ");
	262	else
	263	fprintf(pos->fp, "[");
7d97fad9	264	ctf_print_timestamp(pos->fp, stream, stream->timestamp);
be60c7fb MD	265	if (!pos->print_names)
be60c7fb MD	266	fprintf(pos->fp, "]");
aa6bffae	267
be60c7fb MD	268	if (pos->print_names)
	269	fprintf(pos->fp, ", ");
	270	else
	271	fprintf(pos->fp, " ");
	272	}
359d7456	273	if ((opt_delta_field \|\| opt_all_fields) && stream->has_timestamp) {
8d8ed9af MD	274	uint64_t delta, delta_sec, delta_nsec;
	275
	276	set_field_names_print(pos, ITEM_HEADER);
	277	if (pos->print_names)
	278	fprintf(pos->fp, "delta = ");
	279	else
	280	fprintf(pos->fp, "(");
	281	if (pos->last_timestamp != -1ULL) {
	282	delta = stream->timestamp - pos->last_timestamp;
	283	delta_sec = delta / NSEC_PER_SEC;
	284	delta_nsec = delta % NSEC_PER_SEC;
	285	fprintf(pos->fp, "+%" PRIu64 ".%09" PRIu64,
	286	delta_sec, delta_nsec);
	287	} else {
	288	fprintf(pos->fp, "+?.?????????");
	289	}
	290	if (!pos->print_names)
	291	fprintf(pos->fp, ")");
	292
	293	if (pos->print_names)
	294	fprintf(pos->fp, ", ");
	295	else
	296	fprintf(pos->fp, " ");
	297	pos->last_timestamp = stream->timestamp;
	298	}
	299
359d7456	300	if ((opt_trace_field \|\| opt_all_fields) && stream_class->trace->path[0] != '\0') {
82662ad4	301	set_field_names_print(pos, ITEM_HEADER);
8c250d87	302	if (pos->print_names) {
359d7456	303	fprintf(pos->fp, "trace = ");
8c250d87	304	}
82662ad4	305	fprintf(pos->fp, "%s", stream_class->trace->path);
82662ad4 MD	306	if (pos->print_names)
	307	fprintf(pos->fp, ", ");
	308	else
	309	fprintf(pos->fp, " ");
	310	}
1842a4c8	311	if ((opt_trace_domain_field && !opt_all_fields) && stream_class->trace->env.domain[0] != '\0') {
8c250d87 MD	312	set_field_names_print(pos, ITEM_HEADER);
	313	if (pos->print_names) {
	314	fprintf(pos->fp, "trace:domain = ");
	315	}
1842a4c8	316	fprintf(pos->fp, "%s", stream_class->trace->env.domain);
8c250d87 MD	317	if (pos->print_names)
	318	fprintf(pos->fp, ", ");
	319	dom_print = 1;
	320	}
1842a4c8	321	if ((opt_trace_procname_field && !opt_all_fields) && stream_class->trace->env.procname[0] != '\0') {
8c250d87 MD	322	set_field_names_print(pos, ITEM_HEADER);
	323	if (pos->print_names) {
	324	fprintf(pos->fp, "trace:procname = ");
	325	} else if (dom_print) {
	326	fprintf(pos->fp, ":");
	327	}
1842a4c8	328	fprintf(pos->fp, "%s", stream_class->trace->env.procname);
8c250d87 MD	329	if (pos->print_names)
	330	fprintf(pos->fp, ", ");
	331	dom_print = 1;
	332	}
1842a4c8	333	if ((opt_trace_vpid_field && !opt_all_fields) && stream_class->trace->env.vpid != -1) {
8c250d87 MD	334	set_field_names_print(pos, ITEM_HEADER);
	335	if (pos->print_names) {
	336	fprintf(pos->fp, "trace:vpid = ");
	337	} else if (dom_print) {
	338	fprintf(pos->fp, ":");
	339	}
1842a4c8	340	fprintf(pos->fp, "%d", stream_class->trace->env.vpid);
8c250d87 MD	341	if (pos->print_names)
	342	fprintf(pos->fp, ", ");
	343	dom_print = 1;
	344	}
306eeaa6	345	if ((opt_loglevel_field \|\| opt_all_fields) && event_class->loglevel != -1) {
d86d62f8 MD	346	set_field_names_print(pos, ITEM_HEADER);
	347	if (pos->print_names) {
	348	fprintf(pos->fp, "loglevel = ");
	349	} else if (dom_print) {
	350	fprintf(pos->fp, ":");
	351	}
39535929 MD	352	fprintf(pos->fp, "%s (%d)",
39535929 MD	353	print_loglevel(event_class->loglevel),
306eeaa6	354	event_class->loglevel);
d86d62f8 MD	355	if (pos->print_names)
	356	fprintf(pos->fp, ", ");
	357	dom_print = 1;
	358	}
8c250d87 MD	359	if (dom_print && !pos->print_names)
8c250d87 MD	360	fprintf(pos->fp, " ");
cba1661c	361	set_field_names_print(pos, ITEM_HEADER);
31262354 MD	362	if (pos->print_names)
31262354 MD	363	fprintf(pos->fp, "name = ");
8178fe48 MD	364	fprintf(pos->fp, "%s", g_quark_to_string(event_class->name));
8178fe48 MD	365	if (pos->print_names)
fd3382e8	366	pos->field_nr++;
8178fe48	367	else
fd3382e8	368	fprintf(pos->fp, ":");
31262354	369
e28d4618 MD	370	/* print cpuid field from packet context */
	371	if (stream->stream_packet_context) {
	372	if (pos->field_nr++ != 0)
	373	fprintf(pos->fp, ",");
cba1661c	374	set_field_names_print(pos, ITEM_SCOPE);
e28d4618 MD	375	if (pos->print_names)
	376	fprintf(pos->fp, " stream.packet.context =");
	377	field_nr_saved = pos->field_nr;
	378	pos->field_nr = 0;
cba1661c	379	set_field_names_print(pos, ITEM_CONTEXT);
e28d4618 MD	380	ret = generic_rw(ppos, &stream->stream_packet_context->p);
	381	if (ret)
	382	goto error;
	383	pos->field_nr = field_nr_saved;
	384	}
	385
764af3f4	386	/* Only show the event header in verbose mode */
e28d4618	387	if (babeltrace_verbose && stream->stream_event_header) {
fd3382e8 MD	388	if (pos->field_nr++ != 0)
fd3382e8 MD	389	fprintf(pos->fp, ",");
cba1661c	390	set_field_names_print(pos, ITEM_SCOPE);
31262354	391	if (pos->print_names)
fd3382e8 MD	392	fprintf(pos->fp, " stream.event.header =");
	393	field_nr_saved = pos->field_nr;
	394	pos->field_nr = 0;
cba1661c	395	set_field_names_print(pos, ITEM_CONTEXT);
e28d4618	396	ret = generic_rw(ppos, &stream->stream_event_header->p);
31262354 MD	397	if (ret)
31262354 MD	398	goto error;
fd3382e8	399	pos->field_nr = field_nr_saved;
31262354 MD	400	}
	401
	402	/* print stream-declared event context */
e28d4618	403	if (stream->stream_event_context) {
fd3382e8 MD	404	if (pos->field_nr++ != 0)
fd3382e8 MD	405	fprintf(pos->fp, ",");
cba1661c	406	set_field_names_print(pos, ITEM_SCOPE);
31262354	407	if (pos->print_names)
fd3382e8 MD	408	fprintf(pos->fp, " stream.event.context =");
	409	field_nr_saved = pos->field_nr;
	410	pos->field_nr = 0;
cba1661c	411	set_field_names_print(pos, ITEM_CONTEXT);
e28d4618	412	ret = generic_rw(ppos, &stream->stream_event_context->p);
31262354 MD	413	if (ret)
31262354 MD	414	goto error;
fd3382e8	415	pos->field_nr = field_nr_saved;
31262354 MD	416	}
	417
	418	/* print event-declared event context */
e28d4618	419	if (event->event_context) {
fd3382e8 MD	420	if (pos->field_nr++ != 0)
fd3382e8 MD	421	fprintf(pos->fp, ",");
cba1661c	422	set_field_names_print(pos, ITEM_SCOPE);
31262354	423	if (pos->print_names)
fd3382e8 MD	424	fprintf(pos->fp, " event.context =");
	425	field_nr_saved = pos->field_nr;
	426	pos->field_nr = 0;
cba1661c	427	set_field_names_print(pos, ITEM_CONTEXT);
e28d4618	428	ret = generic_rw(ppos, &event->event_context->p);
31262354 MD	429	if (ret)
31262354 MD	430	goto error;
fd3382e8	431	pos->field_nr = field_nr_saved;
31262354 MD	432	}
	433
	434	/* Read and print event payload */
e28d4618	435	if (event->event_fields) {
fd3382e8 MD	436	if (pos->field_nr++ != 0)
fd3382e8 MD	437	fprintf(pos->fp, ",");
cba1661c	438	set_field_names_print(pos, ITEM_SCOPE);
31262354	439	if (pos->print_names)
fd3382e8 MD	440	fprintf(pos->fp, " event.fields =");
	441	field_nr_saved = pos->field_nr;
	442	pos->field_nr = 0;
cba1661c	443	set_field_names_print(pos, ITEM_PAYLOAD);
e28d4618	444	ret = generic_rw(ppos, &event->event_fields->p);
31262354 MD	445	if (ret)
31262354 MD	446	goto error;
fd3382e8	447	pos->field_nr = field_nr_saved;
31262354	448	}
fd3382e8	449	/* newline */
31262354	450	fprintf(pos->fp, "\n");
fd3382e8	451	pos->field_nr = 0;
90fcbacc	452	stream->consumed = 1;
31262354 MD	453
	454	return 0;
	455
	456	error:
3394d22e	457	fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
31262354 MD	458	return ret;
	459	}
	460
	461
5b80ddfb	462	struct trace_descriptor ctf_text_open_trace(const char path, int flags,
20d0dcf9	463	void (packet_seek)(struct stream_pos pos, size_t index,
ae23d232	464	int whence), FILE *metadata_fp)
642ec66d MD	465	{
	466	struct ctf_text_stream_pos *pos;
	467	FILE *fp;
	468
	469	pos = g_new0(struct ctf_text_stream_pos, 1);
	470
8d8ed9af	471	pos->last_timestamp = -1ULL;
642ec66d	472	switch (flags & O_ACCMODE) {
989c73bc	473	case O_RDWR:
b61922b5	474	if (!path)
6cf7957b MD	475	fp = stdout;
	476	else
	477	fp = fopen(path, "w");
642ec66d MD	478	if (!fp)
	479	goto error;
	480	pos->fp = fp;
	481	pos->parent.rw_table = write_dispatch_table;
31262354	482	pos->parent.event_cb = ctf_text_write_event;
cba1661c	483	pos->print_names = 0;
642ec66d MD	484	break;
	485	case O_RDONLY:
	486	default:
3394d22e	487	fprintf(stderr, "[error] Incorrect open flags.\n");
642ec66d MD	488	goto error;
	489	}
	490
	491	return &pos->trace_descriptor;
	492	error:
	493	g_free(pos);
	494	return NULL;
	495	}
	496
	497	void ctf_text_close_trace(struct trace_descriptor *td)
	498	{
	499	struct ctf_text_stream_pos *pos =
	500	container_of(td, struct ctf_text_stream_pos, trace_descriptor);
	501	fclose(pos->fp);
	502	g_free(pos);
	503	}
	504
	505	void __attribute__((constructor)) ctf_text_init(void)
	506	{
	507	int ret;
	508
	509	ctf_text_format.name = g_quark_from_static_string("text");
	510	ret = bt_register_format(&ctf_text_format);
	511	assert(!ret);
	512	}
	513
	514	/* TODO: finalize */