[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 <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_definition *stream)
			 
{
	struct ctf_text_stream_pos *pos =
		container_of(ppos, struct ctf_text_stream_pos, parent);
	struct ctf_stream_declaration *stream_class = stream->stream_class;
	int field_nr_saved;
	struct ctf_event_declaration *event_class;
	struct ctf_event_definition *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_class) {
		fprintf(stderr, "[error] Event class id %" PRIu64 " is unknown.\n", id);
		return -EINVAL;
	}

	/* Print events discarded */
	if (stream->events_discarded) {
		fflush(pos->fp);
		fprintf(stderr, "[warning] Tracer discarded %" PRIu64 " events between [",
			stream->events_discarded);
		if (opt_clock_cycles) {
			ctf_print_timestamp(stderr, stream,
					stream->prev_cycles_timestamp);
			fprintf(stderr, "] and [");
			ctf_print_timestamp(stderr, stream,
					stream->prev_cycles_timestamp_end);
		} else {
			ctf_print_timestamp(stderr, stream,
					stream->prev_real_timestamp);
			fprintf(stderr, "] and [");
			ctf_print_timestamp(stderr, stream,
					stream->prev_real_timestamp_end);
		}
		fprintf(stderr, "]. You should consider recording a new trace with larger buffers or with fewer events enabled.\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, "[");
		if (opt_clock_cycles) {
			ctf_print_timestamp(pos->fp, stream, stream->cycles_timestamp);
		} else {
			ctf_print_timestamp(pos->fp, stream, stream->real_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_real_timestamp != -1ULL) {
			delta = stream->real_timestamp - pos->last_real_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_real_timestamp = stream->real_timestamp;
		pos->last_cycles_timestamp = stream->cycles_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;

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