API : iterator namespace cleanup
[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 _XOPEN_SOURCE 700
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-text/types.h>
28 #include <babeltrace/iterator.h>
29 #include <popt.h>
30 #include <errno.h>
31 #include <stdlib.h>
32 #include <ctype.h>
33 #include <sys/stat.h>
34 #include <sys/types.h>
35 #include <fcntl.h>
36 #include <ftw.h>
37 #include <dirent.h>
38 #include <unistd.h>
39 #include <inttypes.h>
40
41 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
42
43 #define DEFAULT_FILE_ARRAY_SIZE 1
44 static char *opt_input_format;
45 static char *opt_output_format;
46
47 static const char *opt_input_path;
48 static const char *opt_output_path;
49
50 static struct trace_collection trace_collection_read;
51 static struct format *fmt_read;
52
53 void strlower(char *str)
54 {
55 while (*str) {
56 *str = tolower(*str);
57 str++;
58 }
59 }
60
61 enum {
62 OPT_NONE = 0,
63 OPT_HELP,
64 OPT_LIST,
65 OPT_VERBOSE,
66 OPT_DEBUG,
67 OPT_NAMES,
68 OPT_FIELDS,
69 OPT_NO_DELTA,
70 OPT_CLOCK_OFFSET,
71 OPT_CLOCK_RAW,
72 OPT_CLOCK_SECONDS,
73 OPT_CLOCK_DATE,
74 OPT_CLOCK_GMT,
75 };
76
77 static struct poptOption long_options[] = {
78 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
79 { "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
80 { "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
81 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
82 { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
83 { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
84 { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
85 { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
86 { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
87 { "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
88 { "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
89 { "clock-raw", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_RAW, NULL, NULL },
90 { "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
91 { "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
92 { "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
93 { NULL, 0, 0, NULL, 0, NULL, NULL },
94 };
95
96 static void list_formats(FILE *fp)
97 {
98 fprintf(fp, "\n");
99 bt_fprintf_format_list(fp);
100 }
101
102 static void usage(FILE *fp)
103 {
104 fprintf(fp, "BabelTrace Trace Converter %s\n\n", VERSION);
105 fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
106 fprintf(fp, "\n");
107 fprintf(fp, " INPUT Input trace path\n");
108 fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
109 fprintf(fp, "\n");
110 fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
111 fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
112 fprintf(fp, "\n");
113 fprintf(fp, " -h, --help This help message\n");
114 fprintf(fp, " -l, --list List available formats\n");
115 fprintf(fp, " -v, --verbose Verbose mode\n");
116 fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n");
117 fprintf(fp, " -d, --debug Debug mode\n");
118 fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n");
119 fprintf(fp, " --no-delta Do not print time delta between consecutive events\n");
120 fprintf(fp, " -n, --names name1<,name2,...> Print field names:\n");
121 fprintf(fp, " (payload OR args OR arg)\n");
122 fprintf(fp, " all, scope, header, (context OR ctx)\n");
123 fprintf(fp, " (payload active by default)\n");
124 fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n");
125 fprintf(fp, " all, trace, trace:domain, trace:procname,\n");
126 fprintf(fp, " trace:vpid, loglevel.\n");
127 fprintf(fp, " --clock-raw Disregard internal clock offset (use raw value)\n");
128 fprintf(fp, " --clock-offset seconds Clock offset in seconds\n");
129 fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n");
130 fprintf(fp, " (default is: [hh:mm:ss.ns])\n");
131 fprintf(fp, " --clock-date Print clock date\n");
132 fprintf(fp, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n");
133 list_formats(fp);
134 fprintf(fp, "\n");
135 }
136
137 static int get_names_args(poptContext *pc)
138 {
139 char *str, *strlist, *strctx;
140
141 opt_payload_field_names = 0;
142 strlist = (char *) poptGetOptArg(*pc);
143 if (!strlist) {
144 return -EINVAL;
145 }
146 str = strtok_r(strlist, ",", &strctx);
147 do {
148 if (!strcmp(str, "all"))
149 opt_all_field_names = 1;
150 else if (!strcmp(str, "scope"))
151 opt_scope_field_names = 1;
152 else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
153 opt_context_field_names = 1;
154 else if (!strcmp(str, "header"))
155 opt_header_field_names = 1;
156 else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
157 opt_payload_field_names = 1;
158 else {
159 fprintf(stderr, "[error] unknown field name type %s\n", str);
160 return -EINVAL;
161 }
162 } while ((str = strtok_r(NULL, ",", &strctx)));
163 return 0;
164 }
165
166 static int get_fields_args(poptContext *pc)
167 {
168 char *str, *strlist, *strctx;
169
170 opt_payload_field_names = 0;
171 strlist = (char *) poptGetOptArg(*pc);
172 if (!strlist) {
173 return -EINVAL;
174 }
175 str = strtok_r(strlist, ",", &strctx);
176 do {
177 if (!strcmp(str, "all"))
178 opt_all_fields = 1;
179 else if (!strcmp(str, "trace"))
180 opt_trace_field = 1;
181 else if (!strcmp(str, "trace:domain"))
182 opt_trace_domain_field = 1;
183 else if (!strcmp(str, "trace:procname"))
184 opt_trace_procname_field = 1;
185 else if (!strcmp(str, "trace:vpid"))
186 opt_trace_vpid_field = 1;
187 else if (!strcmp(str, "loglevel"))
188 opt_loglevel_field = 1;
189 else {
190 fprintf(stderr, "[error] unknown field type %s\n", str);
191 return -EINVAL;
192 }
193 } while ((str = strtok_r(NULL, ",", &strctx)));
194 return 0;
195 }
196
197 /*
198 * Return 0 if caller should continue, < 0 if caller should return
199 * error, > 0 if caller should exit without reporting error.
200 */
201 static int parse_options(int argc, char **argv)
202 {
203 poptContext pc;
204 int opt, ret = 0;
205
206 if (argc == 1) {
207 usage(stdout);
208 return 1; /* exit cleanly */
209 }
210
211 pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
212 poptReadDefaultConfig(pc, 0);
213
214 /* set default */
215 opt_payload_field_names = 1;
216
217 while ((opt = poptGetNextOpt(pc)) != -1) {
218 switch (opt) {
219 case OPT_HELP:
220 usage(stdout);
221 ret = 1; /* exit cleanly */
222 goto end;
223 case OPT_LIST:
224 list_formats(stdout);
225 ret = 1;
226 goto end;
227 case OPT_VERBOSE:
228 babeltrace_verbose = 1;
229 break;
230 case OPT_NAMES:
231 if (get_names_args(&pc)) {
232 ret = -EINVAL;
233 goto end;
234 }
235 break;
236 case OPT_FIELDS:
237 if (get_fields_args(&pc)) {
238 ret = -EINVAL;
239 goto end;
240 }
241 break;
242 case OPT_DEBUG:
243 babeltrace_debug = 1;
244 break;
245 case OPT_NO_DELTA:
246 opt_delta_field = 0;
247 break;
248 case OPT_CLOCK_RAW:
249 opt_clock_raw = 1;
250 break;
251 case OPT_CLOCK_OFFSET:
252 {
253 char *str, *endptr;
254
255 str = poptGetOptArg(pc);
256 if (!str) {
257 fprintf(stderr, "[error] Missing --clock-offset argument\n");
258 ret = -EINVAL;
259 goto end;
260 }
261 errno = 0;
262 opt_clock_offset = strtoull(str, &endptr, 0);
263 if (*endptr != '\0' || str == endptr || errno != 0) {
264 fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
265 ret = -EINVAL;
266 goto end;
267 }
268 break;
269 }
270 case OPT_CLOCK_SECONDS:
271 opt_clock_seconds = 1;
272 break;
273 case OPT_CLOCK_DATE:
274 opt_clock_date = 1;
275 break;
276 case OPT_CLOCK_GMT:
277 opt_clock_gmt = 1;
278 break;
279
280 default:
281 ret = -EINVAL;
282 goto end;
283 }
284 }
285
286 opt_input_path = poptGetArg(pc);
287 if (!opt_input_path) {
288 ret = -EINVAL;
289 goto end;
290 }
291 opt_output_path = poptGetArg(pc);
292
293 end:
294 if (pc) {
295 poptFreeContext(pc);
296 }
297 return ret;
298 }
299
300 static void init_trace_collection(struct trace_collection *tc)
301 {
302 tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
303 tc->clocks = g_hash_table_new(g_direct_hash, g_direct_equal);
304 tc->single_clock_offset_avg = 0;
305 tc->offset_first = 0;
306 tc->delta_offset_first_sum = 0;
307 tc->offset_nr = 0;
308 }
309
310 /*
311 * finalize_trace_collection() closes the opened traces for read
312 * and free the memory allocated for trace collection
313 */
314 static void finalize_trace_collection(struct trace_collection *tc)
315 {
316 int i;
317
318 for (i = 0; i < tc->array->len; i++) {
319 struct trace_descriptor *temp =
320 g_ptr_array_index(tc->array, i);
321 fmt_read->close_trace(temp);
322 }
323 g_ptr_array_free(tc->array, TRUE);
324 g_hash_table_destroy(tc->clocks);
325 }
326
327 struct clock_match {
328 GHashTable *clocks;
329 struct ctf_clock *clock_match;
330 struct trace_collection *tc;
331 };
332
333 static void check_clock_match(gpointer key, gpointer value, gpointer user_data)
334 {
335 struct clock_match *match = user_data;
336 struct ctf_clock *clock_a = value, *clock_b;
337
338 if (clock_a->uuid != 0) {
339 /*
340 * Lookup the the trace clocks into the collection
341 * clocks.
342 */
343 clock_b = g_hash_table_lookup(match->clocks,
344 (gpointer) (unsigned long) clock_a->uuid);
345 if (clock_b) {
346 match->clock_match = clock_b;
347 return;
348 }
349 } else if (clock_a->absolute) {
350 /*
351 * Absolute time references, such as NTP, are looked up
352 * by clock name.
353 */
354 clock_b = g_hash_table_lookup(match->clocks,
355 (gpointer) (unsigned long) clock_a->name);
356 if (clock_b) {
357 match->clock_match = clock_b;
358 return;
359 }
360 }
361 }
362
363 static void clock_add(gpointer key, gpointer value, gpointer user_data)
364 {
365 struct clock_match *clock_match = user_data;
366 GHashTable *tc_clocks = clock_match->clocks;
367 struct ctf_clock *t_clock = value;
368 GQuark v;
369
370 if (t_clock->absolute)
371 v = t_clock->name;
372 else
373 v = t_clock->uuid;
374 if (v) {
375 struct ctf_clock *tc_clock;
376
377 tc_clock = g_hash_table_lookup(tc_clocks,
378 (gpointer) (unsigned long) v);
379 if (!tc_clock) {
380 /*
381 * For now, we only support CTF that has one
382 * single clock uuid or name (absolute ref).
383 */
384 if (g_hash_table_size(tc_clocks) > 0) {
385 fprintf(stderr, "[error] Only CTF traces with a single clock description are supported by this babeltrace version.\n");
386 }
387 if (!clock_match->tc->offset_nr) {
388 clock_match->tc->offset_first =
389 (t_clock->offset_s * 1000000000ULL) + t_clock->offset;
390 clock_match->tc->delta_offset_first_sum = 0;
391 clock_match->tc->offset_nr++;
392 clock_match->tc->single_clock_offset_avg =
393 clock_match->tc->offset_first;
394 }
395 g_hash_table_insert(tc_clocks,
396 (gpointer) (unsigned long) v,
397 value);
398 } else {
399 int64_t diff_ns;
400
401 /*
402 * Check that the offsets match. If not, warn
403 * the user that we do an arbitrary choice.
404 */
405 diff_ns = tc_clock->offset_s;
406 diff_ns -= t_clock->offset_s;
407 diff_ns *= 1000000000ULL;
408 diff_ns += tc_clock->offset;
409 diff_ns -= t_clock->offset;
410 printf_debug("Clock \"%s\" offset between traces has a delta of %" PRIu64 " ns.",
411 g_quark_to_string(tc_clock->name),
412 diff_ns < 0 ? -diff_ns : diff_ns);
413 if (diff_ns > 10000) {
414 fprintf(stderr, "[warning] Clock \"%s\" offset differs between traces (delta %" PRIu64 " ns). Using average.\n",
415 g_quark_to_string(tc_clock->name),
416 diff_ns < 0 ? -diff_ns : diff_ns);
417 }
418 /* Compute average */
419 clock_match->tc->delta_offset_first_sum +=
420 (t_clock->offset_s * 1000000000ULL) + t_clock->offset
421 - clock_match->tc->offset_first;
422 clock_match->tc->offset_nr++;
423 clock_match->tc->single_clock_offset_avg =
424 clock_match->tc->offset_first
425 + (clock_match->tc->delta_offset_first_sum / clock_match->tc->offset_nr);
426 }
427 }
428 }
429
430 /*
431 * Whenever we add a trace to the trace collection, check that we can
432 * correlate this trace with at least one other clock in the trace.
433 */
434 static int trace_collection_add(struct trace_collection *tc,
435 struct trace_descriptor *td)
436 {
437 struct ctf_trace *trace = container_of(td, struct ctf_trace, parent);
438
439 g_ptr_array_add(tc->array, td);
440 trace->collection = tc;
441
442 if (tc->array->len > 1) {
443 struct clock_match clock_match = {
444 .clocks = tc->clocks,
445 .clock_match = NULL,
446 .tc = NULL,
447 };
448
449 /*
450 * With two or more traces, we need correlation info
451 * avalable.
452 */
453 g_hash_table_foreach(trace->clocks,
454 check_clock_match,
455 &clock_match);
456 if (!clock_match.clock_match) {
457 fprintf(stderr, "[error] No clocks can be correlated and multiple traces are added to the collection.\n");
458 goto error;
459 }
460 }
461
462 {
463 struct clock_match clock_match = {
464 .clocks = tc->clocks,
465 .clock_match = NULL,
466 .tc = tc,
467 };
468
469 /*
470 * Add each clock from the trace clocks into the trace
471 * collection clocks.
472 */
473 g_hash_table_foreach(trace->clocks,
474 clock_add,
475 &clock_match);
476 }
477 return 0;
478 error:
479 return -EPERM;
480 }
481
482 int convert_trace(struct trace_descriptor *td_write,
483 struct bt_context *ctx)
484 {
485 struct bt_iter *iter;
486 struct ctf_stream *stream;
487 struct ctf_stream_event *event;
488 struct ctf_text_stream_pos *sout;
489 struct bt_iter_pos begin_pos;
490 int ret;
491
492 sout = container_of(td_write, struct ctf_text_stream_pos,
493 trace_descriptor);
494
495 begin_pos.type = BT_SEEK_BEGIN;
496 iter = bt_iter_create(ctx, &begin_pos, NULL);
497 if (!iter) {
498 ret = -1;
499 goto error_iter;
500 }
501 while (bt_iter_read_event(iter, &stream, &event) == 0) {
502 ret = sout->parent.event_cb(&sout->parent, stream);
503 if (ret) {
504 fprintf(stderr, "[error] Writing event failed.\n");
505 goto end;
506 }
507 ret = bt_iter_next(iter);
508 if (ret < 0)
509 goto end;
510 }
511 ret = 0;
512
513 end:
514 bt_iter_destroy(iter);
515 error_iter:
516 return ret;
517 }
518
519
520 /*
521 * traverse_dir() is the callback functiion for File Tree Walk (nftw).
522 * it receives the path of the current entry (file, dir, link..etc) with
523 * a flag to indicate the type of the entry.
524 * if the entry being visited is a directory and contains a metadata file,
525 * then open it for reading and save a trace_descriptor to that directory
526 * in the read trace collection.
527 */
528 static int traverse_dir(const char *fpath, const struct stat *sb,
529 int tflag, struct FTW *ftwbuf)
530 {
531 int dirfd;
532 int fd;
533 struct trace_descriptor *td_read;
534 int ret;
535
536 if (tflag != FTW_D)
537 return 0;
538 dirfd = open(fpath, 0);
539 if (dirfd < 0) {
540 fprintf(stderr, "[error] unable to open trace "
541 "directory file descriptor.\n");
542 return -1;
543 }
544 fd = openat(dirfd, "metadata", O_RDONLY);
545 if (fd < 0) {
546 close(dirfd);
547 } else {
548 close(fd);
549 close(dirfd);
550 td_read = fmt_read->open_trace(opt_input_path,
551 fpath, O_RDONLY, ctf_move_pos_slow,
552 NULL);
553 if (!td_read) {
554 fprintf(stderr, "Error opening trace \"%s\" "
555 "for reading.\n\n", fpath);
556 return -1; /* error */
557 }
558 ret = trace_collection_add(&trace_collection_read, td_read);
559 if (ret) {
560 return -1;
561 }
562 }
563 return 0; /* success */
564 }
565
566 int main(int argc, char **argv)
567 {
568 int ret;
569 struct format *fmt_write;
570 struct trace_descriptor *td_write;
571 struct bt_context *ctx;
572
573 ret = parse_options(argc, argv);
574 if (ret < 0) {
575 fprintf(stderr, "Error parsing options.\n\n");
576 usage(stderr);
577 exit(EXIT_FAILURE);
578 } else if (ret > 0) {
579 exit(EXIT_SUCCESS);
580 }
581 printf_verbose("Verbose mode active.\n");
582 printf_debug("Debug mode active.\n");
583
584 if (opt_input_format)
585 strlower(opt_input_format);
586 if (opt_output_format)
587 strlower(opt_output_format);
588
589 printf_verbose("Converting from directory: %s\n", opt_input_path);
590 printf_verbose("Converting from format: %s\n",
591 opt_input_format ? : "ctf <default>");
592 printf_verbose("Converting to directory: %s\n",
593 opt_output_path ? : "<stdout>");
594 printf_verbose("Converting to format: %s\n",
595 opt_output_format ? : "text <default>");
596
597 if (!opt_input_format)
598 opt_input_format = "ctf";
599 if (!opt_output_format)
600 opt_output_format = "text";
601 fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
602 if (!fmt_read) {
603 fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
604 opt_input_format);
605 exit(EXIT_FAILURE);
606 }
607 fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
608 if (!fmt_write) {
609 fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
610 opt_output_format);
611 exit(EXIT_FAILURE);
612 }
613
614 /*
615 * pass the input path to nftw() .
616 * specify traverse_dir() as the callback function.
617 * depth = 10 which is the max number of file descriptors
618 * that nftw() can open at a given time.
619 * flags = 0 check nftw documentation for more info .
620 */
621 init_trace_collection(&trace_collection_read);
622 ret = nftw(opt_input_path, traverse_dir, 10, 0);
623 if (ret != 0) {
624 fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
625 opt_input_path);
626 goto error_td_read;
627 }
628 if (trace_collection_read.array->len == 0) {
629 fprintf(stderr, "[warning] no metadata file was found."
630 " no output was generated\n");
631 return 0;
632 }
633 ctx = bt_context_create(&trace_collection_read);
634 if (!ctx) {
635 fprintf(stderr, "Error allocating a new context\n");
636 goto error_td_read;
637 }
638 td_write = fmt_write->open_trace(NULL, opt_output_path, O_RDWR, NULL, NULL);
639 if (!td_write) {
640 fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
641 opt_output_path ? : "<none>");
642 goto error_td_write;
643 }
644
645 ret = convert_trace(td_write, ctx);
646 if (ret) {
647 fprintf(stderr, "Error printing trace.\n\n");
648 goto error_copy_trace;
649 }
650
651 fmt_write->close_trace(td_write);
652 finalize_trace_collection(&trace_collection_read);
653 bt_context_destroy(ctx);
654 printf_verbose("finished converting. Output written to:\n%s\n",
655 opt_output_path ? : "<stdout>");
656 exit(EXIT_SUCCESS);
657
658 /* Error handling */
659 error_copy_trace:
660 fmt_write->close_trace(td_write);
661 error_td_write:
662 finalize_trace_collection(&trace_collection_read);
663 error_td_read:
664 exit(EXIT_FAILURE);
665 }
This page took 0.043098 seconds and 5 git commands to generate.