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

/*
 * BabelTrace - Common Trace Format (CTF)
 *
 * CTF Text Format registration.
 *
 * Copyright 2010, 2011 - 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.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>

struct trace_descriptor *ctf_text_open_trace(const char *path, int flags);
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
int ctf_text_write_event(struct stream_pos *ppos,
			 struct ctf_stream *stream_class)
{
	struct ctf_text_stream_pos *pos =
		container_of(ppos, struct ctf_text_stream_pos, parent);
	struct ctf_event *event_class;
	uint64_t id = 0;
	int len_index;
	int ret;

	/* print event header */
	if (stream_class->event_header) {
		/* lookup event id */
		len_index = struct_declaration_lookup_field_index(stream_class->event_header_decl,
				g_quark_from_static_string("id"));
		if (len_index >= 0) {
			struct definition_integer *defint;
			struct definition *field;

			field = struct_definition_get_field_from_index(stream_class->event_header, len_index);
			assert(field->declaration->id == CTF_TYPE_INTEGER);
			defint = container_of(field, struct definition_integer, p);
			assert(defint->declaration->signedness == FALSE);
			id = defint->value._unsigned;	/* set id */
		}
	}

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

	if (pos->print_names)
		fprintf(pos->fp, "name = ");
	fprintf(pos->fp, "%s", g_quark_to_string(event_class->name));

	if (stream_class->event_header) {
		if (pos->print_names)
			fprintf(pos->fp, ", stream.event.header =");
		fprintf(pos->fp, " ");
		ret = generic_rw(ppos, &stream_class->event_header->p);
		if (ret)
			goto error;
	}

	/* print stream-declared event context */
	if (stream_class->event_context) {
		if (pos->print_names)
			fprintf(pos->fp, ", stream.event.context =");
		fprintf(pos->fp, " ");
		ret = generic_rw(ppos, &stream_class->event_context->p);
		if (ret)
			goto error;
	}

	/* print event-declared event context */
	if (event_class->context) {
		if (pos->print_names)
			fprintf(pos->fp, ", event.context =");
		fprintf(pos->fp, " ");
		ret = generic_rw(ppos, &event_class->context->p);
		if (ret)
			goto error;
	}

	/* Read and print event payload */
	if (event_class->fields) {
		if (pos->print_names)
			fprintf(pos->fp, ", event.fields =");
		fprintf(pos->fp, " ");
		ret = generic_rw(ppos, &event_class->fields->p);
		if (ret)
			goto error;
	}
	fprintf(pos->fp, "\n");

	return 0;

error:
	fprintf(stdout, "[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)
{
	struct ctf_text_stream_pos *pos;
	FILE *fp;

	pos = g_new0(struct ctf_text_stream_pos, 1);

	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 = 1;
		break;
	case O_RDONLY:
	default:
		fprintf(stdout, "[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	*
	6	* Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*/
	18
	19	#include <babeltrace/format.h>
	20	#include <babeltrace/ctf-text/types.h>
31262354	21	#include <babeltrace/ctf/metadata.h>
642ec66d MD	22	#include <babeltrace/babeltrace.h>
	23	#include <inttypes.h>
	24	#include <uuid/uuid.h>
	25	#include <sys/mman.h>
	26	#include <errno.h>
	27	#include <sys/types.h>
	28	#include <sys/stat.h>
	29	#include <fcntl.h>
	30	#include <dirent.h>
	31	#include <glib.h>
	32	#include <unistd.h>
	33	#include <stdlib.h>
	34
	35	struct trace_descriptor ctf_text_open_trace(const char path, int flags);
	36	void ctf_text_close_trace(struct trace_descriptor *descriptor);
	37
642ec66d MD	38	static
	39	rw_dispatch write_dispatch_table[] = {
	40	[ CTF_TYPE_INTEGER ] = ctf_text_integer_write,
	41	[ CTF_TYPE_FLOAT ] = ctf_text_float_write,
	42	[ CTF_TYPE_ENUM ] = ctf_text_enum_write,
	43	[ CTF_TYPE_STRING ] = ctf_text_string_write,
	44	[ CTF_TYPE_STRUCT ] = ctf_text_struct_write,
	45	[ CTF_TYPE_VARIANT ] = ctf_text_variant_write,
	46	[ CTF_TYPE_ARRAY ] = ctf_text_array_write,
	47	[ CTF_TYPE_SEQUENCE ] = ctf_text_sequence_write,
	48	};
	49
	50	static
	51	struct format ctf_text_format = {
	52	.open_trace = ctf_text_open_trace,
	53	.close_trace = ctf_text_close_trace,
	54	};
	55
31262354 MD	56	static
	57	int ctf_text_write_event(struct stream_pos *ppos,
	58	struct ctf_stream *stream_class)
	59	{
	60	struct ctf_text_stream_pos *pos =
	61	container_of(ppos, struct ctf_text_stream_pos, parent);
	62	struct ctf_event *event_class;
	63	uint64_t id = 0;
	64	int len_index;
	65	int ret;
	66
	67	/* print event header */
	68	if (stream_class->event_header) {
	69	/* lookup event id */
	70	len_index = struct_declaration_lookup_field_index(stream_class->event_header_decl,
	71	g_quark_from_static_string("id"));
	72	if (len_index >= 0) {
	73	struct definition_integer *defint;
	74	struct definition *field;
	75
	76	field = struct_definition_get_field_from_index(stream_class->event_header, len_index);
	77	assert(field->declaration->id == CTF_TYPE_INTEGER);
	78	defint = container_of(field, struct definition_integer, p);
	79	assert(defint->declaration->signedness == FALSE);
	80	id = defint->value._unsigned; /* set id */
	81	}
	82	}
	83
	84	if (id >= stream_class->events_by_id->len) {
	85	fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
	86	return -EINVAL;
	87	}
	88	event_class = g_ptr_array_index(stream_class->events_by_id, id);
	89	if (!event_class) {
	90	fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
	91	return -EINVAL;
	92	}
	93
	94	if (pos->print_names)
	95	fprintf(pos->fp, "name = ");
	96	fprintf(pos->fp, "%s", g_quark_to_string(event_class->name));
	97
	98	if (stream_class->event_header) {
	99	if (pos->print_names)
	100	fprintf(pos->fp, ", stream.event.header =");
	101	fprintf(pos->fp, " ");
	102	ret = generic_rw(ppos, &stream_class->event_header->p);
	103	if (ret)
	104	goto error;
	105	}
	106
	107	/* print stream-declared event context */
	108	if (stream_class->event_context) {
	109	if (pos->print_names)
	110	fprintf(pos->fp, ", stream.event.context =");
	111	fprintf(pos->fp, " ");
	112	ret = generic_rw(ppos, &stream_class->event_context->p);
	113	if (ret)
	114	goto error;
	115	}
	116
	117	/* print event-declared event context */
	118	if (event_class->context) {
	119	if (pos->print_names)
120	fprintf(pos->fp, ", event.context =");
121	fprintf(pos->fp, " ");
122	ret = generic_rw(ppos, &event_class->context->p);
123	if (ret)
124	goto error;
125	}
126
127	/* Read and print event payload */
128	if (event_class->fields) {
129	if (pos->print_names)
130	fprintf(pos->fp, ", event.fields =");
131	fprintf(pos->fp, " ");
132	ret = generic_rw(ppos, &event_class->fields->p);
133	if (ret)
134	goto error;
135	}
136	fprintf(pos->fp, "\n");
137
138	return 0;
139
140	error:
141	fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
142	return ret;
143	}
144
145
642ec66d MD	146	struct trace_descriptor ctf_text_open_trace(const char path, int flags)
	147	{
	148	struct ctf_text_stream_pos *pos;
	149	FILE *fp;
	150
	151	pos = g_new0(struct ctf_text_stream_pos, 1);
	152
	153	switch (flags & O_ACCMODE) {
989c73bc	154	case O_RDWR:
b61922b5	155	if (!path)
6cf7957b MD	156	fp = stdout;
	157	else
	158	fp = fopen(path, "w");
642ec66d MD	159	if (!fp)
	160	goto error;
	161	pos->fp = fp;
	162	pos->parent.rw_table = write_dispatch_table;
31262354 MD	163	pos->parent.event_cb = ctf_text_write_event;
31262354 MD	164	pos->print_names = 1;
642ec66d MD	165	break;
	166	case O_RDONLY:
	167	default:
	168	fprintf(stdout, "[error] Incorrect open flags.\n");
	169	goto error;
	170	}
	171
	172	return &pos->trace_descriptor;
	173	error:
	174	g_free(pos);
	175	return NULL;
	176	}
	177
	178	void ctf_text_close_trace(struct trace_descriptor *td)
	179	{
	180	struct ctf_text_stream_pos *pos =
	181	container_of(td, struct ctf_text_stream_pos, trace_descriptor);
	182	fclose(pos->fp);
	183	g_free(pos);
	184	}
	185
	186	void __attribute__((constructor)) ctf_text_init(void)
	187	{
	188	int ret;
	189
	190	ctf_text_format.name = g_quark_from_static_string("text");
	191	ret = bt_register_format(&ctf_text_format);
	192	assert(!ret);
	193	}
	194
	195	/* TODO: finalize */