babeltrace: fix poptGetOptArg memleak
[babeltrace.git] / converter / babeltrace.c
1 /*
2 * babeltrace.c
3 *
4 * Babeltrace Trace Converter
5 *
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 *
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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 */
20
21 #define _GNU_SOURCE
22 #include <config.h>
23 #include <babeltrace/babeltrace.h>
24 #include <babeltrace/format.h>
25 #include <babeltrace/context.h>
26 #include <babeltrace/ctf/types.h>
27 #include <babeltrace/ctf/events.h>
28 /* TODO: fix object model for format-agnostic callbacks */
29 #include <babeltrace/ctf/events-internal.h>
30 #include <babeltrace/ctf/iterator.h>
31 #include <babeltrace/ctf-text/types.h>
32 #include <babeltrace/iterator.h>
33 #include <popt.h>
34 #include <errno.h>
35 #include <stdlib.h>
36 #include <ctype.h>
37 #include <sys/stat.h>
38 #include <sys/types.h>
39 #include <fcntl.h>
40 #include <unistd.h>
41 #include <inttypes.h>
42 #include <ftw.h>
43 #include <string.h>
44
45 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
46
47 #define PARTIAL_ERROR_SLEEP 3 /* 3 seconds */
48
49 #define DEFAULT_FILE_ARRAY_SIZE 1
50 static char *opt_input_format, *opt_output_format;
51 /* Pointer into const argv */
52 static const char *opt_input_format_arg, *opt_output_format_arg;
53
54 static GPtrArray *opt_input_paths;
55 static const char *opt_output_path;
56
57 static struct format *fmt_read;
58
59 static
60 void strlower(char *str)
61 {
62 while (*str) {
63 *str = tolower((int) *str);
64 str++;
65 }
66 }
67
68 enum {
69 OPT_NONE = 0,
70 OPT_HELP,
71 OPT_LIST,
72 OPT_VERBOSE,
73 OPT_DEBUG,
74 OPT_NAMES,
75 OPT_FIELDS,
76 OPT_NO_DELTA,
77 OPT_CLOCK_OFFSET,
78 OPT_CLOCK_CYCLES,
79 OPT_CLOCK_SECONDS,
80 OPT_CLOCK_DATE,
81 OPT_CLOCK_GMT,
82 OPT_CLOCK_FORCE_CORRELATE,
83 };
84
85 static struct poptOption long_options[] = {
86 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
87 { "output", 'w', POPT_ARG_STRING, &opt_output_path, OPT_NONE, NULL, NULL },
88 { "input-format", 'i', POPT_ARG_STRING, &opt_input_format_arg, OPT_NONE, NULL, NULL },
89 { "output-format", 'o', POPT_ARG_STRING, &opt_output_format_arg, OPT_NONE, NULL, NULL },
90 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
91 { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
92 { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
93 { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
94 { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
95 { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
96 { "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
97 { "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
98 { "clock-cycles", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL },
99 { "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
100 { "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
101 { "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
102 { "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
103 { NULL, 0, 0, NULL, 0, NULL, NULL },
104 };
105
106 static void list_formats(FILE *fp)
107 {
108 fprintf(fp, "\n");
109 bt_fprintf_format_list(fp);
110 }
111
112 static void usage(FILE *fp)
113 {
114 fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
115 fprintf(fp, "usage : babeltrace [OPTIONS] FILE...\n");
116 fprintf(fp, "\n");
117 fprintf(fp, " FILE Input trace file(s) and/or directory(ies)\n");
118 fprintf(fp, " (space-separated)\n");
119 fprintf(fp, " -w, --output OUTPUT Output trace path (default: stdout)\n");
120 fprintf(fp, "\n");
121 fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
122 fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
123 fprintf(fp, "\n");
124 fprintf(fp, " -h, --help This help message\n");
125 fprintf(fp, " -l, --list List available formats\n");
126 fprintf(fp, " -v, --verbose Verbose mode\n");
127 fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n");
128 fprintf(fp, " -d, --debug Debug mode\n");
129 fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n");
130 fprintf(fp, " --no-delta Do not print time delta between consecutive events\n");
131 fprintf(fp, " -n, --names name1<,name2,...> Print field names:\n");
132 fprintf(fp, " (payload OR args OR arg)\n");
133 fprintf(fp, " none, all, scope, header, (context OR ctx)\n");
134 fprintf(fp, " (default: payload,context)\n");
135 fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n");
136 fprintf(fp, " all, trace, trace:hostname, trace:domain,\n");
137 fprintf(fp, " trace:procname, trace:vpid, loglevel, emf, callsite.\n");
138 fprintf(fp, " (default: trace:hostname,trace:procname,trace:vpid)\n");
139 fprintf(fp, " --clock-cycles Timestamp in cycles\n");
140 fprintf(fp, " --clock-offset seconds Clock offset in seconds\n");
141 fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n");
142 fprintf(fp, " (default is: [hh:mm:ss.ns])\n");
143 fprintf(fp, " --clock-date Print clock date\n");
144 fprintf(fp, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n");
145 fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n");
146 fprintf(fp, " across traces.\n");
147 list_formats(fp);
148 fprintf(fp, "\n");
149 }
150
151 static int get_names_args(poptContext *pc)
152 {
153 char *str, *strlist, *strctx;
154 int ret = 0;
155
156 opt_payload_field_names = 0;
157 opt_context_field_names = 0;
158 strlist = (char *) poptGetOptArg(*pc);
159 if (!strlist) {
160 return -EINVAL;
161 }
162 str = strtok_r(strlist, ",", &strctx);
163 do {
164 if (!strcmp(str, "all"))
165 opt_all_field_names = 1;
166 else if (!strcmp(str, "scope"))
167 opt_scope_field_names = 1;
168 else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
169 opt_context_field_names = 1;
170 else if (!strcmp(str, "header"))
171 opt_header_field_names = 1;
172 else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
173 opt_payload_field_names = 1;
174 else if (!strcmp(str, "none")) {
175 opt_all_field_names = 0;
176 opt_scope_field_names = 0;
177 opt_context_field_names = 0;
178 opt_header_field_names = 0;
179 opt_payload_field_names = 0;
180 } else {
181 fprintf(stderr, "[error] unknown field name type %s\n", str);
182 free(strlist);
183 ret = -EINVAL;
184 goto end;
185 }
186 } while ((str = strtok_r(NULL, ",", &strctx)));
187 end:
188 free(strlist);
189 return ret;
190 }
191
192 static int get_fields_args(poptContext *pc)
193 {
194 char *str, *strlist, *strctx;
195 int ret = 0;
196
197 strlist = (char *) poptGetOptArg(*pc);
198 if (!strlist) {
199 return -EINVAL;
200 }
201 str = strtok_r(strlist, ",", &strctx);
202 do {
203 opt_trace_default_fields = 0;
204 if (!strcmp(str, "all"))
205 opt_all_fields = 1;
206 else if (!strcmp(str, "trace"))
207 opt_trace_field = 1;
208 else if (!strcmp(str, "trace:hostname"))
209 opt_trace_hostname_field = 1;
210 else if (!strcmp(str, "trace:domain"))
211 opt_trace_domain_field = 1;
212 else if (!strcmp(str, "trace:procname"))
213 opt_trace_procname_field = 1;
214 else if (!strcmp(str, "trace:vpid"))
215 opt_trace_vpid_field = 1;
216 else if (!strcmp(str, "loglevel"))
217 opt_loglevel_field = 1;
218 else if (!strcmp(str, "emf"))
219 opt_emf_field = 1;
220 else if (!strcmp(str, "callsite"))
221 opt_callsite_field = 1;
222 else {
223 fprintf(stderr, "[error] unknown field type %s\n", str);
224 ret = -EINVAL;
225 goto end;
226 }
227 } while ((str = strtok_r(NULL, ",", &strctx)));
228 end:
229 free(strlist);
230 return ret;
231 }
232
233 /*
234 * Return 0 if caller should continue, < 0 if caller should return
235 * error, > 0 if caller should exit without reporting error.
236 */
237 static int parse_options(int argc, char **argv)
238 {
239 poptContext pc;
240 int opt, ret = 0;
241 const char *ipath;
242
243 if (argc == 1) {
244 usage(stdout);
245 return 1; /* exit cleanly */
246 }
247
248 pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
249 poptReadDefaultConfig(pc, 0);
250
251 /* set default */
252 opt_context_field_names = 1;
253 opt_payload_field_names = 1;
254
255 while ((opt = poptGetNextOpt(pc)) != -1) {
256 switch (opt) {
257 case OPT_HELP:
258 usage(stdout);
259 ret = 1; /* exit cleanly */
260 goto end;
261 case OPT_LIST:
262 list_formats(stdout);
263 ret = 1;
264 goto end;
265 case OPT_VERBOSE:
266 babeltrace_verbose = 1;
267 break;
268 case OPT_NAMES:
269 if (get_names_args(&pc)) {
270 ret = -EINVAL;
271 goto end;
272 }
273 break;
274 case OPT_FIELDS:
275 if (get_fields_args(&pc)) {
276 ret = -EINVAL;
277 goto end;
278 }
279 break;
280 case OPT_DEBUG:
281 babeltrace_debug = 1;
282 break;
283 case OPT_NO_DELTA:
284 opt_delta_field = 0;
285 break;
286 case OPT_CLOCK_CYCLES:
287 opt_clock_cycles = 1;
288 break;
289 case OPT_CLOCK_OFFSET:
290 {
291 char *str;
292 char *endptr;
293
294 str = (char *) poptGetOptArg(pc);
295 if (!str) {
296 fprintf(stderr, "[error] Missing --clock-offset argument\n");
297 ret = -EINVAL;
298 goto end;
299 }
300 errno = 0;
301 opt_clock_offset = strtoull(str, &endptr, 0);
302 if (*endptr != '\0' || str == endptr || errno != 0) {
303 fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
304 ret = -EINVAL;
305 free(str);
306 goto end;
307 }
308 free(str);
309 break;
310 }
311 case OPT_CLOCK_SECONDS:
312 opt_clock_seconds = 1;
313 break;
314 case OPT_CLOCK_DATE:
315 opt_clock_date = 1;
316 break;
317 case OPT_CLOCK_GMT:
318 opt_clock_gmt = 1;
319 break;
320 case OPT_CLOCK_FORCE_CORRELATE:
321 opt_clock_force_correlate = 1;
322 break;
323
324 default:
325 ret = -EINVAL;
326 goto end;
327 }
328 }
329
330 do {
331 ipath = poptGetArg(pc);
332 if (ipath)
333 g_ptr_array_add(opt_input_paths, (gpointer) ipath);
334 } while (ipath);
335 if (opt_input_paths->len == 0) {
336 ret = -EINVAL;
337 goto end;
338 }
339
340 end:
341 if (pc) {
342 poptFreeContext(pc);
343 }
344 return ret;
345 }
346
347 static GPtrArray *traversed_paths = 0;
348
349 /*
350 * traverse_trace_dir() is the callback function for File Tree Walk (nftw).
351 * it receives the path of the current entry (file, dir, link..etc) with
352 * a flag to indicate the type of the entry.
353 * if the entry being visited is a directory and contains a metadata file,
354 * then add the path to a global list to be processed later in
355 * add_traces_recursive.
356 */
357 static int traverse_trace_dir(const char *fpath, const struct stat *sb,
358 int tflag, struct FTW *ftwbuf)
359 {
360 int dirfd, metafd;
361 int closeret;
362
363 if (tflag != FTW_D)
364 return 0;
365
366 dirfd = open(fpath, 0);
367 if (dirfd < 0) {
368 fprintf(stderr, "[error] [Context] Unable to open trace "
369 "directory file descriptor.\n");
370 return 0; /* partial error */
371 }
372 metafd = openat(dirfd, "metadata", O_RDONLY);
373 if (metafd < 0) {
374 closeret = close(dirfd);
375 if (closeret < 0) {
376 perror("close");
377 return -1;
378 }
379 /* No meta data, just return */
380 return 0;
381 } else {
382 closeret = close(metafd);
383 if (closeret < 0) {
384 perror("close");
385 return -1; /* failure */
386 }
387 closeret = close(dirfd);
388 if (closeret < 0) {
389 perror("close");
390 return -1; /* failure */
391 }
392
393 /* Add path to the global list */
394 if (traversed_paths == NULL) {
395 fprintf(stderr, "[error] [Context] Invalid open path array.\n");
396 return -1;
397 }
398 g_ptr_array_add(traversed_paths, g_string_new(fpath));
399 }
400
401 return 0;
402 }
403 /*
404 * bt_context_add_traces_recursive: Open a trace recursively
405 *
406 * Find each trace present in the subdirectory starting from the given
407 * path, and add them to the context. The packet_seek parameter can be
408 * NULL: this specify to use the default format packet_seek.
409 *
410 * Return: 0 on success, < 0 on failure, > 0 on partial failure.
411 * Unable to open toplevel: failure.
412 * Unable to open some subdirectory or file: warn and continue (partial
413 * failure);
414 */
415 int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
416 const char *format_str,
417 void (*packet_seek)(struct stream_pos *pos,
418 size_t offset, int whence))
419 {
420
421 GArray *trace_ids;
422 int ret = 0;
423 int i;
424
425 /* Should lock traversed_paths mutex here if used in multithread */
426
427 traversed_paths = g_ptr_array_new();
428 trace_ids = g_array_new(FALSE, TRUE, sizeof(int));
429
430 ret = nftw(path, traverse_trace_dir, 10, 0);
431
432 /* Process the array if ntfw did not return a fatal error */
433 if (ret >= 0) {
434 for (i = 0; i < traversed_paths->len; i++) {
435 GString *trace_path = g_ptr_array_index(traversed_paths,
436 i);
437 int trace_id = bt_context_add_trace(ctx,
438 trace_path->str,
439 format_str,
440 packet_seek,
441 NULL,
442 NULL);
443 if (trace_id < 0) {
444 fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" from %s "
445 "for reading.\n", trace_path->str, path);
446 /* Allow to skip erroneous traces. */
447 ret = 1; /* partial error */
448 } else {
449 g_array_append_val(trace_ids, trace_id);
450 }
451 g_string_free(trace_path, TRUE);
452 }
453 }
454 g_ptr_array_free(traversed_paths, TRUE);
455 traversed_paths = NULL;
456
457 /* Should unlock traversed paths mutex here if used in multithread */
458
459 /*
460 * Return an error if no trace can be opened.
461 */
462 if (trace_ids->len == 0) {
463 fprintf(stderr, "[error] Cannot open any trace for reading.\n\n");
464 ret = -ENOENT; /* failure */
465 }
466 g_array_free(trace_ids, TRUE);
467 return ret;
468 }
469
470 int convert_trace(struct trace_descriptor *td_write,
471 struct bt_context *ctx)
472 {
473 struct bt_ctf_iter *iter;
474 struct ctf_text_stream_pos *sout;
475 struct bt_iter_pos begin_pos;
476 struct bt_ctf_event *ctf_event;
477 int ret;
478
479 sout = container_of(td_write, struct ctf_text_stream_pos,
480 trace_descriptor);
481
482 begin_pos.type = BT_SEEK_BEGIN;
483 iter = bt_ctf_iter_create(ctx, &begin_pos, NULL);
484 if (!iter) {
485 ret = -1;
486 goto error_iter;
487 }
488 while ((ctf_event = bt_ctf_iter_read_event(iter))) {
489 ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream);
490 if (ret) {
491 fprintf(stderr, "[error] Writing event failed.\n");
492 goto end;
493 }
494 ret = bt_iter_next(bt_ctf_get_iter(iter));
495 if (ret < 0)
496 goto end;
497 }
498 ret = 0;
499
500 end:
501 bt_ctf_iter_destroy(iter);
502 error_iter:
503 return ret;
504 }
505
506 int main(int argc, char **argv)
507 {
508 int ret, partial_error = 0, open_success = 0;
509 struct format *fmt_write;
510 struct trace_descriptor *td_write;
511 struct bt_context *ctx;
512 int i;
513
514 opt_input_paths = g_ptr_array_new();
515
516 ret = parse_options(argc, argv);
517 if (ret < 0) {
518 fprintf(stderr, "Error parsing options.\n\n");
519 usage(stderr);
520 g_ptr_array_free(opt_input_paths, TRUE);
521 exit(EXIT_FAILURE);
522 } else if (ret > 0) {
523 g_ptr_array_free(opt_input_paths, TRUE);
524 exit(EXIT_SUCCESS);
525 }
526 printf_verbose("Verbose mode active.\n");
527 printf_debug("Debug mode active.\n");
528
529 if (opt_input_format_arg) {
530 opt_input_format = strdup(opt_input_format_arg);
531 if (!opt_input_format) {
532 partial_error = 1;
533 goto end;
534 }
535 strlower(opt_input_format);
536 }
537 if (opt_output_format_arg) {
538 opt_output_format = strdup(opt_output_format_arg);
539 if (!opt_output_format) {
540 partial_error = 1;
541 goto end;
542 }
543 strlower(opt_output_format);
544 }
545
546 printf_verbose("Converting from directory(ies):\n");
547 for (i = 0; i < opt_input_paths->len; i++) {
548 const char *ipath = g_ptr_array_index(opt_input_paths, i);
549 printf_verbose(" %s\n", ipath);
550 }
551 printf_verbose("Converting from format: %s\n",
552 opt_input_format ? : "ctf <default>");
553 printf_verbose("Converting to directory: %s\n",
554 opt_output_path ? : "<stdout>");
555 printf_verbose("Converting to format: %s\n",
556 opt_output_format ? : "text <default>");
557
558 if (!opt_input_format) {
559 opt_input_format = strdup("ctf");
560 if (!opt_input_format) {
561 partial_error = 1;
562 goto end;
563 }
564 }
565 if (!opt_output_format) {
566 opt_output_format = strdup("text");
567 if (!opt_output_format) {
568 partial_error = 1;
569 goto end;
570 }
571 }
572 fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
573 if (!fmt_read) {
574 fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
575 opt_input_format);
576 partial_error = 1;
577 goto end;
578 }
579 fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
580 if (!fmt_write) {
581 fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
582 opt_output_format);
583 partial_error = 1;
584 goto end;
585 }
586
587 ctx = bt_context_create();
588 if (!ctx) {
589 goto error_td_read;
590 }
591
592 for (i = 0; i < opt_input_paths->len; i++) {
593 const char *ipath = g_ptr_array_index(opt_input_paths, i);
594 ret = bt_context_add_traces_recursive(ctx, ipath,
595 opt_input_format, NULL);
596 if (ret < 0) {
597 fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
598 ipath);
599 } else if (ret > 0) {
600 fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n",
601 ipath);
602 open_success = 1; /* some traces were OK */
603 partial_error = 1;
604 } else {
605 open_success = 1; /* all traces were OK */
606 }
607 }
608 if (!open_success) {
609 fprintf(stderr, "[error] none of the specified trace paths could be opened.\n\n");
610 goto error_td_read;
611 }
612
613 td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
614 if (!td_write) {
615 fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
616 opt_output_path ? : "<none>");
617 goto error_td_write;
618 }
619
620 /*
621 * Errors happened when opening traces, but we continue anyway.
622 * sleep to let user see the stderr output before stdout.
623 */
624 if (partial_error)
625 sleep(PARTIAL_ERROR_SLEEP);
626
627 ret = convert_trace(td_write, ctx);
628 if (ret) {
629 fprintf(stderr, "Error printing trace.\n\n");
630 goto error_copy_trace;
631 }
632
633 fmt_write->close_trace(td_write);
634
635 bt_context_put(ctx);
636 printf_verbose("finished converting. Output written to:\n%s\n",
637 opt_output_path ? : "<stdout>");
638 goto end;
639
640 /* Error handling */
641 error_copy_trace:
642 fmt_write->close_trace(td_write);
643 error_td_write:
644 bt_context_put(ctx);
645 error_td_read:
646 partial_error = 1;
647
648 /* teardown and exit */
649 end:
650 free(opt_input_format);
651 free(opt_output_format);
652 g_ptr_array_free(opt_input_paths, TRUE);
653 if (partial_error)
654 exit(EXIT_FAILURE);
655 else
656 exit(EXIT_SUCCESS);
657 }
This page took 0.042905 seconds and 5 git commands to generate.