[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.
 *
 * 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/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 <babeltrace/trace-debuginfo.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_trace_hostname_field,
	opt_trace_default_fields = 1,
	opt_loglevel_field,
	opt_emf_field,
	opt_callsite_field,
	opt_delta_field = 1,
	opt_debug_info_full_path;

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,
};

static
struct bt_trace_descriptor *ctf_text_open_trace(const char *path, int flags,
		void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
			int whence), FILE *metadata_fp);
static
int ctf_text_close_trace(struct bt_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 bt_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,
	Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM;

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");
	Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM = g_quark_from_static_string("stream.packet.context.packet_seq_num");
}

static
struct ctf_callsite_dups *ctf_trace_callsite_lookup(struct ctf_trace *trace,
			GQuark callsite_name)
{
	return g_hash_table_lookup(trace->callsites,
			(gpointer) (unsigned long) callsite_name);
}

int print_field(struct bt_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;
	if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM)
		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 bt_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;
	}

	handle_debug_info_event(stream_class, event);

	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 && 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->parent.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->parent.path);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		else
			fprintf(pos->fp, " ");
	}
	if ((opt_trace_hostname_field || opt_all_fields || opt_trace_default_fields)
			&& stream_class->trace->env.hostname[0] != '\0') {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "trace:hostname = ");
		}
		fprintf(pos->fp, "%s", stream_class->trace->env.hostname);
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		dom_print = 1;
	}
	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 || opt_trace_default_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 || opt_trace_default_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 ((opt_emf_field || opt_all_fields) && event_class->model_emf_uri) {
		set_field_names_print(pos, ITEM_HEADER);
		if (pos->print_names) {
			fprintf(pos->fp, "model.emf.uri = ");
		} else if (dom_print) {
			fprintf(pos->fp, ":");
		}
		fprintf(pos->fp, "\"%s\"",
			g_quark_to_string(event_class->model_emf_uri));
		if (pos->print_names)
			fprintf(pos->fp, ", ");
		dom_print = 1;
	}
	if ((opt_callsite_field || opt_all_fields)) {
		struct ctf_callsite_dups *cs_dups;
		struct ctf_callsite *callsite;

		cs_dups = ctf_trace_callsite_lookup(stream_class->trace,
				event_class->name);
		if (cs_dups) {
			int i = 0;

			set_field_names_print(pos, ITEM_HEADER);
			if (pos->print_names) {
				fprintf(pos->fp, "callsite = ");
			} else if (dom_print) {
				fprintf(pos->fp, ":");
			}
			fprintf(pos->fp, "[");
			bt_list_for_each_entry(callsite, &cs_dups->head, node) {
				if (i != 0)
					fprintf(pos->fp, ",");
				if (CTF_CALLSITE_FIELD_IS_SET(callsite, ip)) {
					fprintf(pos->fp, "%s@0x%" PRIx64 ":%s:%" PRIu64 "",
						callsite->func, callsite->ip, callsite->file,
						callsite->line);
				} else {
					fprintf(pos->fp, "%s:%s:%" PRIu64 "",
						callsite->func, callsite->file,
						callsite->line);
				}
				i++;
			}
			fprintf(pos->fp, "]");
			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;
}

static
struct bt_trace_descriptor *ctf_text_open_trace(const char *path, int flags,
		void (*packet_seek)(struct bt_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);
	if (!pos) {
		goto error;
	}
	init_trace_descriptor(&pos->trace_descriptor);

	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->parent.trace = &pos->trace_descriptor;
		pos->print_names = 0;
		babeltrace_ctf_console_output++;
		break;
	case O_RDONLY:
	default:
		fprintf(stderr, "[error] Incorrect open flags.\n");
		goto error;
	}

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

static
int ctf_text_close_trace(struct bt_trace_descriptor *td)
{
	int ret;
	struct ctf_text_stream_pos *pos =
		container_of(td, struct ctf_text_stream_pos, trace_descriptor);

	babeltrace_ctf_console_output--;
	if (pos->fp != stdout) {
		ret = fclose(pos->fp);
		if (ret) {
			perror("Error on fclose");
			return -1;
		}
	}
	g_free(pos);
	return 0;
}

static
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);
}

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