[babeltrace.git] / converter / babeltrace.c

/*
 * babeltrace.c
 *
 * Babeltrace Trace Converter
 *
 * 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.
 */

#define _GNU_SOURCE
#include <config.h>
#include <babeltrace/babeltrace.h>
#include <babeltrace/format.h>
#include <babeltrace/context.h>
#include <babeltrace/ctf/types.h>
#include <babeltrace/ctf/events.h>
/* TODO: fix object model for format-agnostic callbacks */
#include <babeltrace/ctf/events-internal.h>
#include <babeltrace/ctf/iterator.h>
#include <babeltrace/ctf-text/types.h>
#include <babeltrace/iterator.h>
#include <popt.h>
#include <errno.h>
#include <stdlib.h>
#include <ctype.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <fcntl.h>
#include <unistd.h>
#include <inttypes.h>
#include <fts.h>

#include <babeltrace/ctf-ir/metadata.h>	/* for clocks */

#define DEFAULT_FILE_ARRAY_SIZE	1
static char *opt_input_format;
static char *opt_output_format;

static const char *opt_input_path;
static const char *opt_output_path;

static struct format *fmt_read;

void strlower(char *str)
{
	while (*str) {
		*str = tolower(*str);
		str++;
	}
}

enum {
	OPT_NONE = 0,
	OPT_HELP,
	OPT_LIST,
	OPT_VERBOSE,
	OPT_DEBUG,
	OPT_NAMES,
	OPT_FIELDS,
	OPT_NO_DELTA,
	OPT_CLOCK_OFFSET,
	OPT_CLOCK_RAW,
	OPT_CLOCK_SECONDS,
	OPT_CLOCK_DATE,
	OPT_CLOCK_GMT,
	OPT_CLOCK_FORCE_CORRELATE,
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{ "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
	{ "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
	{ "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
	{ "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
	{ "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
	{ "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
	{ "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
	{ "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
	{ "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
	{ "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
	{ "clock-raw", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_RAW, NULL, NULL },
	{ "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
	{ "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
	{ "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
	{ "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
	{ NULL, 0, 0, NULL, 0, NULL, NULL },
};

static void list_formats(FILE *fp)
{
	fprintf(fp, "\n");
	bt_fprintf_format_list(fp);
}

static void usage(FILE *fp)
{
	fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
	fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
	fprintf(fp, "\n");
	fprintf(fp, "  INPUT                          Input trace path\n");
	fprintf(fp, "  OUTPUT                         Output trace path (default: stdout)\n");
	fprintf(fp, "\n");
	fprintf(fp, "  -i, --input-format FORMAT      Input trace format (default: ctf)\n");
	fprintf(fp, "  -o, --output-format FORMAT     Output trace format (default: text)\n");
	fprintf(fp, "\n");
	fprintf(fp, "  -h, --help                     This help message\n");
	fprintf(fp, "  -l, --list                     List available formats\n");
	fprintf(fp, "  -v, --verbose                  Verbose mode\n");
	fprintf(fp, "                                 (or set BABELTRACE_VERBOSE environment variable)\n");
	fprintf(fp, "  -d, --debug                    Debug mode\n");
	fprintf(fp, "                                 (or set BABELTRACE_DEBUG environment variable)\n");
	fprintf(fp, "      --no-delta                 Do not print time delta between consecutive events\n");
	fprintf(fp, "  -n, --names name1<,name2,...>  Print field names:\n");
	fprintf(fp, "                                     (payload OR args OR arg)\n");
	fprintf(fp, "                                     none, all, scope, header, (context OR ctx)\n");
	fprintf(fp, "                                        (default: payload,context)\n");
	fprintf(fp, "  -f, --fields name1<,name2,...> Print additional fields:\n");
	fprintf(fp, "                                     all, trace, trace:domain, trace:procname,\n");
	fprintf(fp, "                                     trace:vpid, loglevel.\n");
	fprintf(fp, "      --clock-raw                Disregard internal clock offset (use raw value)\n");
	fprintf(fp, "      --clock-offset seconds     Clock offset in seconds\n");
	fprintf(fp, "      --clock-seconds            Print the timestamps as [sec.ns]\n");
	fprintf(fp, "                                 (default is: [hh:mm:ss.ns])\n");
	fprintf(fp, "      --clock-date               Print clock date\n");
	fprintf(fp, "      --clock-gmt                Print clock in GMT time zone (default: local time zone)\n");
	fprintf(fp, "      --clock-force-correlate    Assume that clocks are inherently correlated\n");
	fprintf(fp, "                                 across traces.\n");
	list_formats(fp);
	fprintf(fp, "\n");
}

static int get_names_args(poptContext *pc)
{
	char *str, *strlist, *strctx;

	opt_payload_field_names = 0;
	opt_context_field_names = 0;
	strlist = (char *) poptGetOptArg(*pc);
	if (!strlist) {
		return -EINVAL;
	}
	str = strtok_r(strlist, ",", &strctx);
	do {
		if (!strcmp(str, "all"))
			opt_all_field_names = 1;
		else if (!strcmp(str, "scope"))
			opt_scope_field_names = 1;
		else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
			opt_context_field_names = 1;
		else if (!strcmp(str, "header"))
			opt_header_field_names = 1;
		else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
			opt_payload_field_names = 1;
		else if (!strcmp(str, "none")) {
			opt_all_field_names = 0;
			opt_scope_field_names = 0;
			opt_context_field_names = 0;
			opt_header_field_names = 0;
			opt_payload_field_names = 0;
		} else {
			fprintf(stderr, "[error] unknown field name type %s\n", str);
			return -EINVAL;
		}
	} while ((str = strtok_r(NULL, ",", &strctx)));
	return 0;
}

static int get_fields_args(poptContext *pc)
{
	char *str, *strlist, *strctx;

	strlist = (char *) poptGetOptArg(*pc);
	if (!strlist) {
		return -EINVAL;
	}
	str = strtok_r(strlist, ",", &strctx);
	do {
		if (!strcmp(str, "all"))
			opt_all_fields = 1;
		else if (!strcmp(str, "trace"))
			opt_trace_field = 1;
		else if (!strcmp(str, "trace:domain"))
			opt_trace_domain_field = 1;
		else if (!strcmp(str, "trace:procname"))
			opt_trace_procname_field = 1;
		else if (!strcmp(str, "trace:vpid"))
			opt_trace_vpid_field = 1;
		else if (!strcmp(str, "loglevel"))
			opt_loglevel_field = 1;
		else {
			fprintf(stderr, "[error] unknown field type %s\n", str);
			return -EINVAL;
		}
	} while ((str = strtok_r(NULL, ",", &strctx)));
	return 0;
}

/*
 * Return 0 if caller should continue, < 0 if caller should return
 * error, > 0 if caller should exit without reporting error.
 */
static int parse_options(int argc, char **argv)
{
	poptContext pc;
	int opt, ret = 0;

	if (argc == 1) {
		usage(stdout);
		return 1;	/* exit cleanly */
	}

	pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
	poptReadDefaultConfig(pc, 0);

	/* set default */
	opt_context_field_names = 1;
	opt_payload_field_names = 1;

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stdout);
			ret = 1;	/* exit cleanly */
			goto end;
		case OPT_LIST:
			list_formats(stdout);
			ret = 1;
			goto end;
		case OPT_VERBOSE:
			babeltrace_verbose = 1;
			break;
		case OPT_NAMES:
			if (get_names_args(&pc)) {
				ret = -EINVAL;
				goto end;
			}
			break;
		case OPT_FIELDS:
			if (get_fields_args(&pc)) {
				ret = -EINVAL;
				goto end;
			}
			break;
		case OPT_DEBUG:
			babeltrace_debug = 1;
			break;
		case OPT_NO_DELTA:
			opt_delta_field = 0;
			break;
		case OPT_CLOCK_RAW:
			opt_clock_raw = 1;
			break;
		case OPT_CLOCK_OFFSET:
		{
			char *str, *endptr;

			str = poptGetOptArg(pc);
			if (!str) {
				fprintf(stderr, "[error] Missing --clock-offset argument\n");
				ret = -EINVAL;
				goto end;
			}
			errno = 0;
			opt_clock_offset = strtoull(str, &endptr, 0);
			if (*endptr != '\0' || str == endptr || errno != 0) {
				fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
				ret = -EINVAL;
				goto end;
			}
			break;
		}
		case OPT_CLOCK_SECONDS:
			opt_clock_seconds = 1;
			break;
		case OPT_CLOCK_DATE:
			opt_clock_date = 1;
			break;
		case OPT_CLOCK_GMT:
			opt_clock_gmt = 1;
			break;
		case OPT_CLOCK_FORCE_CORRELATE:
			opt_clock_force_correlate = 1;
			break;

		default:
			ret = -EINVAL;
			goto end;
		}
	}

	opt_input_path = poptGetArg(pc);
	if (!opt_input_path) {
		ret = -EINVAL;
		goto end;
	}
	opt_output_path = poptGetArg(pc);

end:
	if (pc) {
		poptFreeContext(pc);
	}
	return ret;
}


/*
 * bt_context_add_traces_recursive: Open a trace recursively
 *
 * Find each trace present in the subdirectory starting from the given
 * path, and add them to the context. The packet_seek parameter can be
 * NULL: this specify to use the default format packet_seek.
 *
 * Return: 0 on success, nonzero on failure.
 * Unable to open toplevel: failure.
 * Unable to open some subdirectory or file: warn and continue;
 */
int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
		const char *format_str,
		void (*packet_seek)(struct stream_pos *pos,
			size_t offset, int whence))
{
	FTS *tree;
	FTSENT *node;
	GArray *trace_ids;
	char lpath[PATH_MAX];
	char * const paths[2] = { lpath, NULL };
	int ret = -1;

	/*
	 * Need to copy path, because fts_open can change it.
	 * It is the pointer array, not the strings, that are constant.
	 */
	strncpy(lpath, path, PATH_MAX);
	lpath[PATH_MAX - 1] = '\0';

	tree = fts_open(paths, FTS_NOCHDIR | FTS_LOGICAL, 0);
	if (tree == NULL) {
		fprintf(stderr, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
				path);
		return -EINVAL;
	}

	trace_ids = g_array_new(FALSE, TRUE, sizeof(int));

	while ((node = fts_read(tree))) {
		int dirfd, metafd;

		if (!(node->fts_info & FTS_D))
			continue;

		dirfd = open(node->fts_accpath, 0);
		if (dirfd < 0) {
			fprintf(stderr, "[error] [Context] Unable to open trace "
				"directory file descriptor.\n");
			ret = dirfd;
			goto error;
		}
		metafd = openat(dirfd, "metadata", O_RDONLY);
		if (metafd < 0) {
			ret = close(dirfd);
			if (ret < 0) {
				perror("close");
				goto error;
			}
		} else {
			int trace_id;

			ret = close(metafd);
			if (ret < 0) {
				perror("close");
				goto error;
			}
			ret = close(dirfd);
			if (ret < 0) {
				perror("close");
				goto error;
			}

			trace_id = bt_context_add_trace(ctx,
				node->fts_accpath, format_str,
				packet_seek, NULL, NULL);
			if (trace_id < 0) {
				fprintf(stderr, "[warning] [Context] opening trace \"%s\" from %s "
					"for reading.\n", node->fts_accpath, path);
				/* Allow to skip erroneous traces. */
				continue;
			}
			g_array_append_val(trace_ids, trace_id);
		}
	}

	g_array_free(trace_ids, TRUE);
	return ret;

error:
	return ret;
}


int convert_trace(struct trace_descriptor *td_write,
		  struct bt_context *ctx)
{
	struct bt_ctf_iter *iter;
	struct ctf_text_stream_pos *sout;
	struct bt_iter_pos begin_pos;
	struct bt_ctf_event *ctf_event;
	int ret;

	sout = container_of(td_write, struct ctf_text_stream_pos,
			trace_descriptor);

	begin_pos.type = BT_SEEK_BEGIN;
	iter = bt_ctf_iter_create(ctx, &begin_pos, NULL);
	if (!iter) {
		ret = -1;
		goto error_iter;
	}
	while ((ctf_event = bt_ctf_iter_read_event(iter))) {
		ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream);
		if (ret) {
			fprintf(stderr, "[error] Writing event failed.\n");
			goto end;
		}
		ret = bt_iter_next(bt_ctf_get_iter(iter));
		if (ret < 0)
			goto end;
	}
	ret = 0;

end:
	bt_ctf_iter_destroy(iter);
error_iter:
	return ret;
}

int main(int argc, char **argv)
{
	int ret;
	struct format *fmt_write;
	struct trace_descriptor *td_write;
	struct bt_context *ctx;

	ret = parse_options(argc, argv);
	if (ret < 0) {
		fprintf(stderr, "Error parsing options.\n\n");
		usage(stderr);
		exit(EXIT_FAILURE);
	} else if (ret > 0) {
		exit(EXIT_SUCCESS);
	}
	printf_verbose("Verbose mode active.\n");
	printf_debug("Debug mode active.\n");

	if (opt_input_format)
		strlower(opt_input_format);
	if (opt_output_format)
		strlower(opt_output_format);

	printf_verbose("Converting from directory: %s\n", opt_input_path);
	printf_verbose("Converting from format: %s\n",
		opt_input_format ? : "ctf <default>");
	printf_verbose("Converting to directory: %s\n",
		opt_output_path ? : "<stdout>");
	printf_verbose("Converting to format: %s\n",
		opt_output_format ? : "text <default>");

	if (!opt_input_format)
		opt_input_format = "ctf";
	if (!opt_output_format)
		opt_output_format = "text";
	fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
	if (!fmt_read) {
		fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
			opt_input_format);
		exit(EXIT_FAILURE);
	}
	fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
	if (!fmt_write) {
		fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
			opt_output_format);
		exit(EXIT_FAILURE);
	}

	ctx = bt_context_create();

	ret = bt_context_add_traces_recursive(ctx, opt_input_path,
			opt_input_format, NULL);
	if (ret) {
		fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
			opt_input_path);
		goto error_td_read;
	}

	td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
	if (!td_write) {
		fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
			opt_output_path ? : "<none>");
		goto error_td_write;
	}

	ret = convert_trace(td_write, ctx);
	if (ret) {
		fprintf(stderr, "Error printing trace.\n\n");
		goto error_copy_trace;
	}

	fmt_write->close_trace(td_write);

	bt_context_put(ctx);
	printf_verbose("finished converting. Output written to:\n%s\n",
			opt_output_path ? : "<stdout>");
	exit(EXIT_SUCCESS);

	/* Error handling */
error_copy_trace:
	fmt_write->close_trace(td_write);
error_td_write:
	bt_context_put(ctx);
error_td_read:
	exit(EXIT_FAILURE);
}
Commit	Line	Data
34ac0e6c MD	1	/*
	2	* babeltrace.c
	3	*
	4	* Babeltrace Trace Converter
	5	*
64fa3fec MD	6	* Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
	7	*
	8	* Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
34ac0e6c 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	*/
4c8bfb7e	20
20d24215	21	#define _GNU_SOURCE
00f7fbf0	22	#include <config.h>
95d36295	23	#include <babeltrace/babeltrace.h>
7fb21036	24	#include <babeltrace/format.h>
95d36295 JD	25	#include <babeltrace/context.h>
95d36295 JD	26	#include <babeltrace/ctf/types.h>
9843982d	27	#include <babeltrace/ctf/events.h>
04ae3991 MD	28	/* TODO: fix object model for format-agnostic callbacks */
04ae3991 MD	29	#include <babeltrace/ctf/events-internal.h>
9efd5d76	30	#include <babeltrace/ctf/iterator.h>
31bdef5c	31	#include <babeltrace/ctf-text/types.h>
6204d33c	32	#include <babeltrace/iterator.h>
34ac0e6c MD	33	#include <popt.h>
	34	#include <errno.h>
	35	#include <stdlib.h>
bbefb8dd MD	36	#include <ctype.h>
	37	#include <sys/stat.h>
	38	#include <sys/types.h>
	39	#include <fcntl.h>
afb48eae	40	#include <unistd.h>
70accc14	41	#include <inttypes.h>
20d24215	42	#include <fts.h>
4c8bfb7e	43
a44bc4c9 MD	44	#include <babeltrace/ctf-ir/metadata.h> /* for clocks */
a44bc4c9 MD	45
afb48eae	46	#define DEFAULT_FILE_ARRAY_SIZE 1
bbefb8dd MD	47	static char *opt_input_format;
bbefb8dd MD	48	static char *opt_output_format;
34ac0e6c MD	49
	50	static const char *opt_input_path;
	51	static const char *opt_output_path;
	52
afb48eae AA	53	static struct format *fmt_read;
afb48eae AA	54
bbefb8dd MD	55	void strlower(char *str)
	56	{
	57	while (*str) {
	58	str = tolower(str);
	59	str++;
	60	}
	61	}
	62
34ac0e6c MD	63	enum {
	64	OPT_NONE = 0,
	65	OPT_HELP,
7fb21036	66	OPT_LIST,
34ac0e6c MD	67	OPT_VERBOSE,
34ac0e6c MD	68	OPT_DEBUG,
d63ca2cd	69	OPT_NAMES,
359d7456	70	OPT_FIELDS,
8d8ed9af	71	OPT_NO_DELTA,
11ac6674 MD	72	OPT_CLOCK_OFFSET,
	73	OPT_CLOCK_RAW,
	74	OPT_CLOCK_SECONDS,
	75	OPT_CLOCK_DATE,
	76	OPT_CLOCK_GMT,
82ace6d6	77	OPT_CLOCK_FORCE_CORRELATE,
34ac0e6c MD	78	};
	79
	80	static struct poptOption long_options[] = {
	81	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	82	{ "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
	83	{ "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
	84	{ "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
7fb21036	85	{ "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
34ac0e6c MD	86	{ "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
34ac0e6c MD	87	{ "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
cba1661c	88	{ "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
359d7456	89	{ "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
8d8ed9af	90	{ "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
11ac6674 MD	91	{ "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
	92	{ "clock-raw", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_RAW, NULL, NULL },
	93	{ "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
	94	{ "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
	95	{ "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
82ace6d6	96	{ "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
34ac0e6c MD	97	{ NULL, 0, 0, NULL, 0, NULL, NULL },
	98	};
	99
7fb21036 MD	100	static void list_formats(FILE *fp)
	101	{
	102	fprintf(fp, "\n");
	103	bt_fprintf_format_list(fp);
	104	}
	105
34ac0e6c	106	static void usage(FILE *fp)
4c8bfb7e	107	{
4c15b06b	108	fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
4d5678b9	109	fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
34ac0e6c	110	fprintf(fp, "\n");
4d5678b9 MD	111	fprintf(fp, " INPUT Input trace path\n");
4d5678b9 MD	112	fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
34ac0e6c	113	fprintf(fp, "\n");
d2b8ea6b MD	114	fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
d2b8ea6b MD	115	fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
34ac0e6c	116	fprintf(fp, "\n");
4d5678b9 MD	117	fprintf(fp, " -h, --help This help message\n");
	118	fprintf(fp, " -l, --list List available formats\n");
	119	fprintf(fp, " -v, --verbose Verbose mode\n");
cba1661c	120	fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n");
4d5678b9	121	fprintf(fp, " -d, --debug Debug mode\n");
cba1661c	122	fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n");
8d8ed9af	123	fprintf(fp, " --no-delta Do not print time delta between consecutive events\n");
359d7456	124	fprintf(fp, " -n, --names name1<,name2,...> Print field names:\n");
82662ad4	125	fprintf(fp, " (payload OR args OR arg)\n");
12c9c3bc MD	126	fprintf(fp, " none, all, scope, header, (context OR ctx)\n");
12c9c3bc MD	127	fprintf(fp, " (default: payload,context)\n");
359d7456 MD	128	fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n");
	129	fprintf(fp, " all, trace, trace:domain, trace:procname,\n");
	130	fprintf(fp, " trace:vpid, loglevel.\n");
11ac6674 MD	131	fprintf(fp, " --clock-raw Disregard internal clock offset (use raw value)\n");
	132	fprintf(fp, " --clock-offset seconds Clock offset in seconds\n");
	133	fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n");
	134	fprintf(fp, " (default is: [hh:mm:ss.ns])\n");
	135	fprintf(fp, " --clock-date Print clock date\n");
	136	fprintf(fp, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n");
82ace6d6 MD	137	fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n");
82ace6d6 MD	138	fprintf(fp, " across traces.\n");
7fb21036	139	list_formats(fp);
34ac0e6c MD	140	fprintf(fp, "\n");
	141	}
	142
cba1661c MD	143	static int get_names_args(poptContext *pc)
	144	{
	145	char str, strlist, *strctx;
	146
	147	opt_payload_field_names = 0;
12c9c3bc	148	opt_context_field_names = 0;
cba1661c MD	149	strlist = (char ) poptGetOptArg(pc);
	150	if (!strlist) {
	151	return -EINVAL;
	152	}
	153	str = strtok_r(strlist, ",", &strctx);
	154	do {
	155	if (!strcmp(str, "all"))
	156	opt_all_field_names = 1;
	157	else if (!strcmp(str, "scope"))
	158	opt_scope_field_names = 1;
	159	else if (!strcmp(str, "context") \|\| !strcmp(str, "ctx"))
	160	opt_context_field_names = 1;
	161	else if (!strcmp(str, "header"))
	162	opt_header_field_names = 1;
	163	else if (!strcmp(str, "payload") \|\| !strcmp(str, "args") \|\| !strcmp(str, "arg"))
	164	opt_payload_field_names = 1;
12c9c3bc MD	165	else if (!strcmp(str, "none")) {
	166	opt_all_field_names = 0;
	167	opt_scope_field_names = 0;
	168	opt_context_field_names = 0;
	169	opt_header_field_names = 0;
	170	opt_payload_field_names = 0;
	171	} else {
359d7456 MD	172	fprintf(stderr, "[error] unknown field name type %s\n", str);
	173	return -EINVAL;
	174	}
	175	} while ((str = strtok_r(NULL, ",", &strctx)));
	176	return 0;
	177	}
	178
	179	static int get_fields_args(poptContext *pc)
	180	{
	181	char str, strlist, *strctx;
	182
359d7456 MD	183	strlist = (char ) poptGetOptArg(pc);
	184	if (!strlist) {
	185	return -EINVAL;
	186	}
	187	str = strtok_r(strlist, ",", &strctx);
	188	do {
	189	if (!strcmp(str, "all"))
	190	opt_all_fields = 1;
82662ad4	191	else if (!strcmp(str, "trace"))
359d7456	192	opt_trace_field = 1;
8c250d87	193	else if (!strcmp(str, "trace:domain"))
359d7456	194	opt_trace_domain_field = 1;
8c250d87	195	else if (!strcmp(str, "trace:procname"))
359d7456	196	opt_trace_procname_field = 1;
8c250d87	197	else if (!strcmp(str, "trace:vpid"))
359d7456	198	opt_trace_vpid_field = 1;
d86d62f8	199	else if (!strcmp(str, "loglevel"))
359d7456	200	opt_loglevel_field = 1;
cba1661c	201	else {
359d7456	202	fprintf(stderr, "[error] unknown field type %s\n", str);
cba1661c MD	203	return -EINVAL;
	204	}
	205	} while ((str = strtok_r(NULL, ",", &strctx)));
	206	return 0;
	207	}
	208
34ac0e6c MD	209	/*
	210	* Return 0 if caller should continue, < 0 if caller should return
	211	* error, > 0 if caller should exit without reporting error.
	212	*/
bbefb8dd	213	static int parse_options(int argc, char **argv)
34ac0e6c MD	214	{
	215	poptContext pc;
	216	int opt, ret = 0;
	217
0f980a35 MD	218	if (argc == 1) {
	219	usage(stdout);
	220	return 1; /* exit cleanly */
	221	}
	222
bbefb8dd	223	pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
34ac0e6c MD	224	poptReadDefaultConfig(pc, 0);
34ac0e6c MD	225
cba1661c	226	/* set default */
e505794f	227	opt_context_field_names = 1;
cba1661c MD	228	opt_payload_field_names = 1;
cba1661c MD	229
34ac0e6c MD	230	while ((opt = poptGetNextOpt(pc)) != -1) {
	231	switch (opt) {
	232	case OPT_HELP:
7fb21036	233	usage(stdout);
34ac0e6c MD	234	ret = 1; /* exit cleanly */
34ac0e6c MD	235	goto end;
7fb21036 MD	236	case OPT_LIST:
	237	list_formats(stdout);
	238	ret = 1;
	239	goto end;
34ac0e6c MD	240	case OPT_VERBOSE:
	241	babeltrace_verbose = 1;
	242	break;
cba1661c MD	243	case OPT_NAMES:
	244	if (get_names_args(&pc)) {
	245	ret = -EINVAL;
	246	goto end;
	247	}
	248	break;
359d7456 MD	249	case OPT_FIELDS:
	250	if (get_fields_args(&pc)) {
	251	ret = -EINVAL;
	252	goto end;
	253	}
	254	break;
34ac0e6c MD	255	case OPT_DEBUG:
	256	babeltrace_debug = 1;
	257	break;
8d8ed9af	258	case OPT_NO_DELTA:
359d7456	259	opt_delta_field = 0;
8d8ed9af	260	break;
11ac6674 MD	261	case OPT_CLOCK_RAW:
	262	opt_clock_raw = 1;
	263	break;
	264	case OPT_CLOCK_OFFSET:
	265	{
	266	char str, endptr;
	267
	268	str = poptGetOptArg(pc);
	269	if (!str) {
	270	fprintf(stderr, "[error] Missing --clock-offset argument\n");
	271	ret = -EINVAL;
	272	goto end;
	273	}
	274	errno = 0;
	275	opt_clock_offset = strtoull(str, &endptr, 0);
	276	if (*endptr != '\0' \|\| str == endptr \|\| errno != 0) {
	277	fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
	278	ret = -EINVAL;
	279	goto end;
	280	}
	281	break;
	282	}
	283	case OPT_CLOCK_SECONDS:
	284	opt_clock_seconds = 1;
	285	break;
	286	case OPT_CLOCK_DATE:
	287	opt_clock_date = 1;
	288	break;
	289	case OPT_CLOCK_GMT:
	290	opt_clock_gmt = 1;
	291	break;
82ace6d6 MD	292	case OPT_CLOCK_FORCE_CORRELATE:
	293	opt_clock_force_correlate = 1;
	294	break;
11ac6674	295
34ac0e6c MD	296	default:
	297	ret = -EINVAL;
	298	goto end;
	299	}
	300	}
	301
	302	opt_input_path = poptGetArg(pc);
	303	if (!opt_input_path) {
	304	ret = -EINVAL;
	305	goto end;
	306	}
	307	opt_output_path = poptGetArg(pc);
cba1661c	308
34ac0e6c MD	309	end:
	310	if (pc) {
	311	poptFreeContext(pc);
	312	}
	313	return ret;
	314	}
	315
afb48eae	316
20d24215 YB	317	/*
	318	* bt_context_add_traces_recursive: Open a trace recursively
	319	*
	320	* Find each trace present in the subdirectory starting from the given
613f532b MD	321	* path, and add them to the context. The packet_seek parameter can be
613f532b MD	322	* NULL: this specify to use the default format packet_seek.
20d24215 YB	323	*
	324	* Return: 0 on success, nonzero on failure.
	325	* Unable to open toplevel: failure.
	326	* Unable to open some subdirectory or file: warn and continue;
	327	*/
	328	int bt_context_add_traces_recursive(struct bt_context ctx, const char path,
613f532b MD	329	const char *format_str,
	330	void (packet_seek)(struct stream_pos pos,
	331	size_t offset, int whence))
20d24215 YB	332	{
	333	FTS *tree;
	334	FTSENT *node;
	335	GArray *trace_ids;
	336	char lpath[PATH_MAX];
	337	char * const paths[2] = { lpath, NULL };
ec4c2b5c	338	int ret = -1;
20d24215 YB	339
	340	/*
	341	* Need to copy path, because fts_open can change it.
	342	* It is the pointer array, not the strings, that are constant.
	343	*/
	344	strncpy(lpath, path, PATH_MAX);
	345	lpath[PATH_MAX - 1] = '\0';
	346
	347	tree = fts_open(paths, FTS_NOCHDIR \| FTS_LOGICAL, 0);
	348	if (tree == NULL) {
	349	fprintf(stderr, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
	350	path);
	351	return -EINVAL;
	352	}
	353
	354	trace_ids = g_array_new(FALSE, TRUE, sizeof(int));
	355
	356	while ((node = fts_read(tree))) {
	357	int dirfd, metafd;
	358
	359	if (!(node->fts_info & FTS_D))
	360	continue;
	361
	362	dirfd = open(node->fts_accpath, 0);
	363	if (dirfd < 0) {
	364	fprintf(stderr, "[error] [Context] Unable to open trace "
	365	"directory file descriptor.\n");
	366	ret = dirfd;
	367	goto error;
	368	}
	369	metafd = openat(dirfd, "metadata", O_RDONLY);
	370	if (metafd < 0) {
	371	ret = close(dirfd);
	372	if (ret < 0) {
	373	perror("close");
	374	goto error;
	375	}
	376	} else {
	377	int trace_id;
	378
	379	ret = close(metafd);
	380	if (ret < 0) {
	381	perror("close");
	382	goto error;
	383	}
	384	ret = close(dirfd);
	385	if (ret < 0) {
	386	perror("close");
	387	goto error;
	388	}
	389
	390	trace_id = bt_context_add_trace(ctx,
613f532b	391	node->fts_accpath, format_str,
0d4c669f	392	packet_seek, NULL, NULL);
20d24215	393	if (trace_id < 0) {
ca718275	394	fprintf(stderr, "[warning] [Context] opening trace \"%s\" from %s "
20d24215	395	"for reading.\n", node->fts_accpath, path);
ca718275 MD	396	/* Allow to skip erroneous traces. */
ca718275 MD	397	continue;
20d24215 YB	398	}
	399	g_array_append_val(trace_ids, trace_id);
	400	}
	401	}
	402
	403	g_array_free(trace_ids, TRUE);
ec4c2b5c	404	return ret;
20d24215 YB	405
	406	error:
	407	return ret;
	408	}
a44bc4c9	409
a44bc4c9	410
afb48eae	411
95d36295 JD	412	int convert_trace(struct trace_descriptor *td_write,
	413	struct bt_context *ctx)
	414	{
e4195791	415	struct bt_ctf_iter *iter;
95d36295	416	struct ctf_text_stream_pos *sout;
e8c92a62	417	struct bt_iter_pos begin_pos;
c50d2a7a	418	struct bt_ctf_event *ctf_event;
95d36295 JD	419	int ret;
	420
	421	sout = container_of(td_write, struct ctf_text_stream_pos,
	422	trace_descriptor);
	423
	424	begin_pos.type = BT_SEEK_BEGIN;
e4195791	425	iter = bt_ctf_iter_create(ctx, &begin_pos, NULL);
95d36295 JD	426	if (!iter) {
	427	ret = -1;
	428	goto error_iter;
	429	}
e4195791	430	while ((ctf_event = bt_ctf_iter_read_event(iter))) {
c50d2a7a	431	ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream);
95d36295	432	if (ret) {
3394d22e	433	fprintf(stderr, "[error] Writing event failed.\n");
95d36295 JD	434	goto end;
95d36295 JD	435	}
e4195791	436	ret = bt_iter_next(bt_ctf_get_iter(iter));
95d36295 JD	437	if (ret < 0)
	438	goto end;
	439	}
	440	ret = 0;
	441
	442	end:
e4195791	443	bt_ctf_iter_destroy(iter);
95d36295 JD	444	error_iter:
	445	return ret;
	446	}
	447
bbefb8dd	448	int main(int argc, char **argv)
34ac0e6c MD	449	{
34ac0e6c MD	450	int ret;
afb48eae AA	451	struct format *fmt_write;
afb48eae AA	452	struct trace_descriptor *td_write;
95d36295	453	struct bt_context *ctx;
34ac0e6c MD	454
	455	ret = parse_options(argc, argv);
	456	if (ret < 0) {
3394d22e MD	457	fprintf(stderr, "Error parsing options.\n\n");
3394d22e MD	458	usage(stderr);
34ac0e6c MD	459	exit(EXIT_FAILURE);
	460	} else if (ret > 0) {
	461	exit(EXIT_SUCCESS);
	462	}
	463	printf_verbose("Verbose mode active.\n");
	464	printf_debug("Debug mode active.\n");
	465
bbefb8dd MD	466	if (opt_input_format)
	467	strlower(opt_input_format);
	468	if (opt_output_format)
	469	strlower(opt_output_format);
	470
afb48eae	471	printf_verbose("Converting from directory: %s\n", opt_input_path);
34ac0e6c	472	printf_verbose("Converting from format: %s\n",
b61922b5	473	opt_input_format ? : "ctf <default>");
afb48eae	474	printf_verbose("Converting to directory: %s\n",
478b6389	475	opt_output_path ? : "<stdout>");
34ac0e6c	476	printf_verbose("Converting to format: %s\n",
b61922b5	477	opt_output_format ? : "text <default>");
bbefb8dd	478
b61922b5 MD	479	if (!opt_input_format)
	480	opt_input_format = "ctf";
	481	if (!opt_output_format)
	482	opt_output_format = "text";
bbefb8dd MD	483	fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
bbefb8dd MD	484	if (!fmt_read) {
3394d22e	485	fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
bbefb8dd MD	486	opt_input_format);
	487	exit(EXIT_FAILURE);
	488	}
bbefb8dd MD	489	fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
bbefb8dd MD	490	if (!fmt_write) {
3394d22e	491	fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
bbefb8dd MD	492	opt_output_format);
	493	exit(EXIT_FAILURE);
	494	}
	495
6cba487f MD	496	ctx = bt_context_create();
6cba487f MD	497
e669e45e	498	ret = bt_context_add_traces_recursive(ctx, opt_input_path,
613f532b	499	opt_input_format, NULL);
6cba487f	500	if (ret) {
3394d22e	501	fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
bbefb8dd MD	502	opt_input_path);
	503	goto error_td_read;
	504	}
6cba487f	505
5b80ddfb	506	td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
bbefb8dd	507	if (!td_write) {
3394d22e	508	fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
b61922b5	509	opt_output_path ? : "<none>");
bbefb8dd MD	510	goto error_td_write;
bbefb8dd MD	511	}
847bf71a	512
95d36295	513	ret = convert_trace(td_write, ctx);
46322b33	514	if (ret) {
3394d22e	515	fprintf(stderr, "Error printing trace.\n\n");
46322b33 MD	516	goto error_copy_trace;
46322b33 MD	517	}
847bf71a	518
bbefb8dd	519	fmt_write->close_trace(td_write);
6cba487f MD	520
6cba487f MD	521	bt_context_put(ctx);
afb48eae AA	522	printf_verbose("finished converting. Output written to:\n%s\n",
afb48eae AA	523	opt_output_path ? : "<stdout>");
bbefb8dd	524	exit(EXIT_SUCCESS);
34ac0e6c	525
bbefb8dd	526	/* Error handling */
46322b33	527	error_copy_trace:
bbefb8dd MD	528	fmt_write->close_trace(td_write);
bbefb8dd MD	529	error_td_write:
6cba487f	530	bt_context_put(ctx);
bbefb8dd MD	531	error_td_read:
bbefb8dd MD	532	exit(EXIT_FAILURE);
4c8bfb7e	533	}