Move opt_field_names/babeltrace_verbose/babeltrace_debug into lib
[babeltrace.git] / converter / babeltrace.c
CommitLineData
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
37static char *opt_input_format;
38static char *opt_output_format;
34ac0e6c
MD
39
40static const char *opt_input_path;
41static const char *opt_output_path;
42
afb48eae
AA
43static struct trace_collection trace_collection_read;
44static struct format *fmt_read;
45
bbefb8dd
MD
46void strlower(char *str)
47{
48 while (*str) {
49 *str = tolower(*str);
50 str++;
51 }
52}
53
34ac0e6c
MD
54enum {
55 OPT_NONE = 0,
56 OPT_HELP,
7fb21036 57 OPT_LIST,
34ac0e6c
MD
58 OPT_VERBOSE,
59 OPT_DEBUG,
d63ca2cd 60 OPT_NAMES,
34ac0e6c
MD
61};
62
63static struct poptOption long_options[] = {
64 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
65 { "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
66 { "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
67 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
7fb21036 68 { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
34ac0e6c
MD
69 { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
70 { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
d63ca2cd 71 { "names", 'n', POPT_ARG_NONE, NULL, OPT_NAMES, NULL, NULL },
34ac0e6c
MD
72 { NULL, 0, 0, NULL, 0, NULL, NULL },
73};
74
7fb21036
MD
75static void list_formats(FILE *fp)
76{
77 fprintf(fp, "\n");
78 bt_fprintf_format_list(fp);
79}
80
34ac0e6c 81static void usage(FILE *fp)
4c8bfb7e 82{
00f7fbf0 83 fprintf(fp, "BabelTrace Trace Converter %s\n\n", VERSION);
4d5678b9 84 fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
34ac0e6c 85 fprintf(fp, "\n");
4d5678b9
MD
86 fprintf(fp, " INPUT Input trace path\n");
87 fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
34ac0e6c 88 fprintf(fp, "\n");
d2b8ea6b
MD
89 fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
90 fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
34ac0e6c 91 fprintf(fp, "\n");
4d5678b9
MD
92 fprintf(fp, " -h, --help This help message\n");
93 fprintf(fp, " -l, --list List available formats\n");
94 fprintf(fp, " -v, --verbose Verbose mode\n");
b88d6e85 95 fprintf(fp, " (or set BABELTRACE_VERBOSE env. var.)\n");
4d5678b9 96 fprintf(fp, " -d, --debug Debug mode\n");
b88d6e85 97 fprintf(fp, " (or set BABELTRACE_DEBUG env. var.)\n");
d63ca2cd 98 fprintf(fp, " -n, --names Print field names\n");
7fb21036 99 list_formats(fp);
34ac0e6c
MD
100 fprintf(fp, "\n");
101}
102
103/*
104 * Return 0 if caller should continue, < 0 if caller should return
105 * error, > 0 if caller should exit without reporting error.
106 */
bbefb8dd 107static int parse_options(int argc, char **argv)
34ac0e6c
MD
108{
109 poptContext pc;
110 int opt, ret = 0;
111
0f980a35
MD
112 if (argc == 1) {
113 usage(stdout);
114 return 1; /* exit cleanly */
115 }
116
bbefb8dd 117 pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
34ac0e6c
MD
118 poptReadDefaultConfig(pc, 0);
119
120 while ((opt = poptGetNextOpt(pc)) != -1) {
121 switch (opt) {
122 case OPT_HELP:
7fb21036 123 usage(stdout);
34ac0e6c
MD
124 ret = 1; /* exit cleanly */
125 goto end;
7fb21036
MD
126 case OPT_LIST:
127 list_formats(stdout);
128 ret = 1;
129 goto end;
34ac0e6c
MD
130 case OPT_VERBOSE:
131 babeltrace_verbose = 1;
132 break;
133 case OPT_DEBUG:
134 babeltrace_debug = 1;
135 break;
d63ca2cd
MD
136 case OPT_NAMES:
137 opt_field_names = 1;
138 break;
34ac0e6c
MD
139 default:
140 ret = -EINVAL;
141 goto end;
142 }
143 }
144
145 opt_input_path = poptGetArg(pc);
146 if (!opt_input_path) {
147 ret = -EINVAL;
148 goto end;
149 }
150 opt_output_path = poptGetArg(pc);
34ac0e6c
MD
151end:
152 if (pc) {
153 poptFreeContext(pc);
154 }
155 return ret;
156}
157
afb48eae
AA
158static void init_trace_collection(struct trace_collection *tc)
159{
160 tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
161}
162
163/*
164 * finalize_trace_collection() closes the opened traces for read
165 * and free the memory allocated for trace collection
166 */
167static void finalize_trace_collection(struct trace_collection *tc)
168{
169 int i;
170
171 for (i = 0; i < tc->array->len; i++) {
172 struct trace_descriptor *temp =
173 g_ptr_array_index(tc->array, i);
174 fmt_read->close_trace(temp);
175 }
176 g_ptr_array_free(tc->array, TRUE);
177}
178
179static void trace_collection_add(struct trace_collection *tc,
180 struct trace_descriptor *td)
181{
182 g_ptr_array_add(tc->array, td);
183}
184
185/*
186 * traverse_dir() is the callback functiion for File Tree Walk (nftw).
187 * it receives the path of the current entry (file, dir, link..etc) with
188 * a flag to indicate the type of the entry.
189 * if the entry being visited is a directory and contains a metadata file,
190 * then open it for reading and save a trace_descriptor to that directory
191 * in the read trace collection.
192 */
193static int traverse_dir(const char *fpath, const struct stat *sb,
194 int tflag, struct FTW *ftwbuf)
195{
196 int dirfd;
197 int fd;
198 struct trace_descriptor *td_read;
199
200 if (tflag != FTW_D)
201 return 0;
202 dirfd = open(fpath, 0);
203 if (dirfd < 0) {
204 fprintf(stdout, "[error] unable to open trace "
205 "directory file descriptor.\n");
206 return -1;
207 }
208 fd = openat(dirfd, "metadata", O_RDONLY);
209 if (fd < 0) {
210 close(dirfd);
211 } else {
212 close(fd);
213 close(dirfd);
ae23d232
JD
214 td_read = fmt_read->open_trace(fpath, O_RDONLY, ctf_move_pos_slow,
215 NULL);
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 226int main(int argc, char **argv)
34ac0e6c
MD
227{
228 int ret;
afb48eae
AA
229 struct format *fmt_write;
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));
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));
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
ae23d232 293 td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
bbefb8dd
MD
294 if (!td_write) {
295 fprintf(stdout, "Error opening trace \"%s\" for writing.\n\n",
b61922b5 296 opt_output_path ? : "<none>");
bbefb8dd
MD
297 goto error_td_write;
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 313error_copy_trace:
bbefb8dd
MD
314 fmt_write->close_trace(td_write);
315error_td_write:
afb48eae 316 finalize_trace_collection(&trace_collection_read);
bbefb8dd
MD
317error_td_read:
318 exit(EXIT_FAILURE);
4c8bfb7e 319}
This page took 0.058545 seconds and 4 git commands to generate.