[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 _XOPEN_SOURCE 700
#include <config.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/format.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 <ftw.h>
#include <dirent.h>
#include <unistd.h>

#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;

int babeltrace_verbose, babeltrace_debug;
int opt_field_names;

static struct trace_collection trace_collection_read;
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,
};

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_NONE, NULL, OPT_NAMES, 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 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, "  -d, --debug                    Debug mode\n");
	fprintf(fp, "  -n, --names                    Print field names\n");
	list_formats(fp);
	fprintf(fp, "\n");
}

/*
 * 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);

	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_DEBUG:
			babeltrace_debug = 1;
			break;
		case OPT_NAMES:
			opt_field_names = 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;
}

static void init_trace_collection(struct trace_collection *tc)
{
	tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
}

/*
 * finalize_trace_collection() closes the opened traces for read
 * and free the memory allocated for trace collection
 */
static void finalize_trace_collection(struct trace_collection *tc)
{
	int i;

	for (i = 0; i < tc->array->len; i++) {
		struct trace_descriptor *temp =
			g_ptr_array_index(tc->array, i);
		fmt_read->close_trace(temp);
	}
	g_ptr_array_free(tc->array, TRUE);
}

static void trace_collection_add(struct trace_collection *tc,
				 struct trace_descriptor *td)
{
	g_ptr_array_add(tc->array, td);
}

/*
 * traverse_dir() is the callback functiion for File Tree Walk (nftw).
 * it receives the path of the current entry (file, dir, link..etc) with
 * a flag to indicate the type of the entry.
 * if the entry being visited is a directory and contains a metadata file,
 * then open it for reading and save a trace_descriptor to that directory
 * in the read trace collection.
 */
static int traverse_dir(const char *fpath, const struct stat *sb,
			int tflag, struct FTW *ftwbuf)
{
	int dirfd;
	int fd;
	struct trace_descriptor *td_read;

	if (tflag != FTW_D)
		return 0;
	dirfd = open(fpath, 0);
	if (dirfd < 0) {
		fprintf(stdout, "[error] unable to open trace "
			"directory file descriptor.\n");
		return -1;
	}
	fd = openat(dirfd, "metadata", O_RDONLY);
	if (fd < 0) {
		close(dirfd);
	} else {
		close(fd);
		close(dirfd);
		td_read = fmt_read->open_trace(fpath, O_RDONLY, ctf_move_pos_slow);
		if (!td_read) {
			fprintf(stdout, "Error opening trace \"%s\" "
					"for reading.\n\n", fpath);
			return -1;	/* error */
		}
		trace_collection_add(&trace_collection_read, td_read);
	}
	return 0;	/* success */
}

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

	ret = parse_options(argc, argv);
	if (ret < 0) {
		fprintf(stdout, "Error parsing options.\n\n");
		usage(stdout);
		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(stdout, "[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(stdout, "[error] format \"%s\" is not supported.\n\n",
			opt_output_format);
		exit(EXIT_FAILURE);
	}

	/*
	 * pass the input path to nftw() .
	 * specify traverse_dir() as the callback function.
	 * depth = 10 which is the max number of file descriptors
	 * that nftw() can open at a given time.
	 * flags = 0  check nftw documentation for more info .
	 */
	init_trace_collection(&trace_collection_read);
	ret = nftw(opt_input_path, traverse_dir, 10, 0);
	if (ret != 0) {
		fprintf(stdout, "[error] opening trace \"%s\" for reading.\n\n",
			opt_input_path);
		goto error_td_read;
	}
	if (trace_collection_read.array->len == 0) {
		fprintf(stdout, "[warning] no metadata file was found."
						" no output was generated\n");
		return 0;
	}

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

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

	fmt_write->close_trace(td_write);
	finalize_trace_collection(&trace_collection_read);
	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:
	finalize_trace_collection(&trace_collection_read);
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
afb48eae	21	#define _XOPEN_SOURCE 700
00f7fbf0	22	#include <config.h>
70bd0a12	23	#include <babeltrace/babeltrace-internal.h>
7fb21036	24	#include <babeltrace/format.h>
34ac0e6c MD	25	#include <popt.h>
	26	#include <errno.h>
	27	#include <stdlib.h>
bbefb8dd MD	28	#include <ctype.h>
	29	#include <sys/stat.h>
	30	#include <sys/types.h>
	31	#include <fcntl.h>
afb48eae AA	32	#include <ftw.h>
	33	#include <dirent.h>
	34	#include <unistd.h>
4c8bfb7e	35
afb48eae	36	#define DEFAULT_FILE_ARRAY_SIZE 1
bbefb8dd MD	37	static char *opt_input_format;
bbefb8dd MD	38	static char *opt_output_format;
34ac0e6c MD	39
	40	static const char *opt_input_path;
	41	static const char *opt_output_path;
	42
	43	int babeltrace_verbose, babeltrace_debug;
d63ca2cd	44	int opt_field_names;
34ac0e6c	45
afb48eae AA	46	static struct trace_collection trace_collection_read;
	47	static struct format *fmt_read;
	48
bbefb8dd MD	49	void strlower(char *str)
	50	{
	51	while (*str) {
	52	str = tolower(str);
	53	str++;
	54	}
	55	}
	56
34ac0e6c MD	57	enum {
	58	OPT_NONE = 0,
	59	OPT_HELP,
7fb21036	60	OPT_LIST,
34ac0e6c MD	61	OPT_VERBOSE,
34ac0e6c MD	62	OPT_DEBUG,
d63ca2cd	63	OPT_NAMES,
34ac0e6c MD	64	};
	65
	66	static struct poptOption long_options[] = {
	67	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	68	{ "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
	69	{ "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
	70	{ "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
7fb21036	71	{ "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
34ac0e6c MD	72	{ "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
34ac0e6c MD	73	{ "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
d63ca2cd	74	{ "names", 'n', POPT_ARG_NONE, NULL, OPT_NAMES, NULL, NULL },
34ac0e6c MD	75	{ NULL, 0, 0, NULL, 0, NULL, NULL },
	76	};
	77
7fb21036 MD	78	static void list_formats(FILE *fp)
	79	{
	80	fprintf(fp, "\n");
	81	bt_fprintf_format_list(fp);
	82	}
	83
34ac0e6c	84	static void usage(FILE *fp)
4c8bfb7e	85	{
00f7fbf0	86	fprintf(fp, "BabelTrace Trace Converter %s\n\n", VERSION);
4d5678b9	87	fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
34ac0e6c	88	fprintf(fp, "\n");
4d5678b9 MD	89	fprintf(fp, " INPUT Input trace path\n");
4d5678b9 MD	90	fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
34ac0e6c	91	fprintf(fp, "\n");
d2b8ea6b MD	92	fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
d2b8ea6b MD	93	fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
34ac0e6c	94	fprintf(fp, "\n");
4d5678b9 MD	95	fprintf(fp, " -h, --help This help message\n");
	96	fprintf(fp, " -l, --list List available formats\n");
	97	fprintf(fp, " -v, --verbose Verbose mode\n");
	98	fprintf(fp, " -d, --debug Debug mode\n");
d63ca2cd	99	fprintf(fp, " -n, --names Print field names\n");
7fb21036	100	list_formats(fp);
34ac0e6c MD	101	fprintf(fp, "\n");
	102	}
	103
	104	/*
	105	* Return 0 if caller should continue, < 0 if caller should return
	106	* error, > 0 if caller should exit without reporting error.
	107	*/
bbefb8dd	108	static int parse_options(int argc, char **argv)
34ac0e6c MD	109	{
	110	poptContext pc;
	111	int opt, ret = 0;
	112
0f980a35 MD	113	if (argc == 1) {
	114	usage(stdout);
	115	return 1; /* exit cleanly */
	116	}
	117
bbefb8dd	118	pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
34ac0e6c MD	119	poptReadDefaultConfig(pc, 0);
	120
	121	while ((opt = poptGetNextOpt(pc)) != -1) {
	122	switch (opt) {
	123	case OPT_HELP:
7fb21036	124	usage(stdout);
34ac0e6c MD	125	ret = 1; /* exit cleanly */
34ac0e6c MD	126	goto end;
7fb21036 MD	127	case OPT_LIST:
	128	list_formats(stdout);
	129	ret = 1;
	130	goto end;
34ac0e6c MD	131	case OPT_VERBOSE:
	132	babeltrace_verbose = 1;
	133	break;
	134	case OPT_DEBUG:
	135	babeltrace_debug = 1;
	136	break;
d63ca2cd MD	137	case OPT_NAMES:
	138	opt_field_names = 1;
	139	break;
34ac0e6c MD	140	default:
	141	ret = -EINVAL;
	142	goto end;
	143	}
	144	}
	145
	146	opt_input_path = poptGetArg(pc);
	147	if (!opt_input_path) {
	148	ret = -EINVAL;
	149	goto end;
	150	}
	151	opt_output_path = poptGetArg(pc);
34ac0e6c MD	152	end:
	153	if (pc) {
	154	poptFreeContext(pc);
	155	}
	156	return ret;
	157	}
	158
afb48eae AA	159	static void init_trace_collection(struct trace_collection *tc)
	160	{
	161	tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
	162	}
	163
	164	/*
	165	* finalize_trace_collection() closes the opened traces for read
	166	* and free the memory allocated for trace collection
	167	*/
	168	static void finalize_trace_collection(struct trace_collection *tc)
	169	{
	170	int i;
	171
	172	for (i = 0; i < tc->array->len; i++) {
	173	struct trace_descriptor *temp =
	174	g_ptr_array_index(tc->array, i);
	175	fmt_read->close_trace(temp);
	176	}
	177	g_ptr_array_free(tc->array, TRUE);
	178	}
	179
	180	static void trace_collection_add(struct trace_collection *tc,
	181	struct trace_descriptor *td)
	182	{
	183	g_ptr_array_add(tc->array, td);
	184	}
	185
	186	/*
	187	* traverse_dir() is the callback functiion for File Tree Walk (nftw).
	188	* it receives the path of the current entry (file, dir, link..etc) with
	189	* a flag to indicate the type of the entry.
	190	* if the entry being visited is a directory and contains a metadata file,
	191	* then open it for reading and save a trace_descriptor to that directory
	192	* in the read trace collection.
	193	*/
	194	static int traverse_dir(const char fpath, const struct stat sb,
	195	int tflag, struct FTW *ftwbuf)
	196	{
	197	int dirfd;
	198	int fd;
	199	struct trace_descriptor *td_read;
	200
	201	if (tflag != FTW_D)
	202	return 0;
	203	dirfd = open(fpath, 0);
	204	if (dirfd < 0) {
	205	fprintf(stdout, "[error] unable to open trace "
	206	"directory file descriptor.\n");
	207	return -1;
	208	}
	209	fd = openat(dirfd, "metadata", O_RDONLY);
	210	if (fd < 0) {
	211	close(dirfd);
	212	} else {
	213	close(fd);
	214	close(dirfd);
b086c01a	215	td_read = fmt_read->open_trace(fpath, O_RDONLY, ctf_move_pos_slow);
afb48eae AA	216	if (!td_read) {
	217	fprintf(stdout, "Error opening trace \"%s\" "
	218	"for reading.\n\n", fpath);
	219	return -1; /* error */
	220	}
	221	trace_collection_add(&trace_collection_read, td_read);
	222	}
	223	return 0; /* success */
	224	}
	225
bbefb8dd	226	int main(int argc, char **argv)
34ac0e6c MD	227	{
34ac0e6c MD	228	int ret;
afb48eae AA	229	struct format *fmt_write;
afb48eae AA	230	struct trace_descriptor *td_write;
34ac0e6c MD	231
	232	ret = parse_options(argc, argv);
	233	if (ret < 0) {
bbefb8dd	234	fprintf(stdout, "Error parsing options.\n\n");
34ac0e6c MD	235	usage(stdout);
	236	exit(EXIT_FAILURE);
	237	} else if (ret > 0) {
	238	exit(EXIT_SUCCESS);
	239	}
	240	printf_verbose("Verbose mode active.\n");
	241	printf_debug("Debug mode active.\n");
	242
bbefb8dd MD	243	if (opt_input_format)
	244	strlower(opt_input_format);
	245	if (opt_output_format)
	246	strlower(opt_output_format);
	247
afb48eae	248	printf_verbose("Converting from directory: %s\n", opt_input_path);
34ac0e6c	249	printf_verbose("Converting from format: %s\n",
b61922b5	250	opt_input_format ? : "ctf <default>");
afb48eae	251	printf_verbose("Converting to directory: %s\n",
478b6389	252	opt_output_path ? : "<stdout>");
34ac0e6c	253	printf_verbose("Converting to format: %s\n",
b61922b5	254	opt_output_format ? : "text <default>");
bbefb8dd	255
b61922b5 MD	256	if (!opt_input_format)
	257	opt_input_format = "ctf";
	258	if (!opt_output_format)
	259	opt_output_format = "text";
bbefb8dd MD	260	fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
bbefb8dd MD	261	if (!fmt_read) {
c8b219a3	262	fprintf(stdout, "[error] Format \"%s\" is not supported.\n\n",
bbefb8dd MD	263	opt_input_format);
	264	exit(EXIT_FAILURE);
	265	}
bbefb8dd MD	266	fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
bbefb8dd MD	267	if (!fmt_write) {
c8b219a3	268	fprintf(stdout, "[error] format \"%s\" is not supported.\n\n",
bbefb8dd MD	269	opt_output_format);
	270	exit(EXIT_FAILURE);
	271	}
	272
afb48eae AA	273	/*
	274	* pass the input path to nftw() .
	275	* specify traverse_dir() as the callback function.
	276	* depth = 10 which is the max number of file descriptors
	277	* that nftw() can open at a given time.
	278	* flags = 0 check nftw documentation for more info .
	279	*/
	280	init_trace_collection(&trace_collection_read);
	281	ret = nftw(opt_input_path, traverse_dir, 10, 0);
	282	if (ret != 0) {
c8b219a3	283	fprintf(stdout, "[error] opening trace \"%s\" for reading.\n\n",
bbefb8dd MD	284	opt_input_path);
	285	goto error_td_read;
	286	}
afb48eae AA	287	if (trace_collection_read.array->len == 0) {
	288	fprintf(stdout, "[warning] no metadata file was found."
	289	" no output was generated\n");
	290	return 0;
	291	}
bbefb8dd	292
b086c01a	293	td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL);
bbefb8dd MD	294	if (!td_write) {
bbefb8dd MD	295	fprintf(stdout, "Error opening trace \"%s\" for writing.\n\n",
b61922b5	296	opt_output_path ? : "<none>");
bbefb8dd MD	297	goto error_td_write;
bbefb8dd MD	298	}
847bf71a	299
afb48eae	300	ret = convert_trace(td_write, &trace_collection_read);
46322b33 MD	301	if (ret) {
	302	fprintf(stdout, "Error printing trace.\n\n");
	303	goto error_copy_trace;
	304	}
847bf71a	305
bbefb8dd	306	fmt_write->close_trace(td_write);
afb48eae AA	307	finalize_trace_collection(&trace_collection_read);
	308	printf_verbose("finished converting. Output written to:\n%s\n",
	309	opt_output_path ? : "<stdout>");
bbefb8dd	310	exit(EXIT_SUCCESS);
34ac0e6c	311
bbefb8dd	312	/* Error handling */
46322b33	313	error_copy_trace:
bbefb8dd MD	314	fmt_write->close_trace(td_write);
bbefb8dd MD	315	error_td_write:
afb48eae	316	finalize_trace_collection(&trace_collection_read);
bbefb8dd MD	317	error_td_read:
bbefb8dd MD	318	exit(EXIT_FAILURE);
4c8bfb7e	319	}