4 * Babeltrace Trace Converter
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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>
38 #include <sys/types.h>
45 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
47 #define DEFAULT_FILE_ARRAY_SIZE 1
48 static char *opt_input_format
, *opt_output_format
;
49 /* Pointer into const argv */
50 static const char *opt_input_format_arg
, *opt_output_format_arg
;
52 static const char *opt_input_path
;
53 static const char *opt_output_path
;
55 static struct format
*fmt_read
;
58 void strlower(char *str
)
61 *str
= tolower((int) *str
);
80 OPT_CLOCK_FORCE_CORRELATE
,
83 static struct poptOption long_options
[] = {
84 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
85 { "input-format", 'i', POPT_ARG_STRING
, &opt_input_format_arg
, OPT_NONE
, NULL
, NULL
},
86 { "output-format", 'o', POPT_ARG_STRING
, &opt_output_format_arg
, OPT_NONE
, NULL
, NULL
},
87 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
88 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
89 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
90 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
91 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
92 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
93 { "no-delta", 0, POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
94 { "clock-offset", 0, POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
95 { "clock-cycles", 0, POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
96 { "clock-seconds", 0, POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
97 { "clock-date", 0, POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
98 { "clock-gmt", 0, POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
99 { "clock-force-correlate", 0, POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
100 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
103 static void list_formats(FILE *fp
)
106 bt_fprintf_format_list(fp
);
109 static void usage(FILE *fp
)
111 fprintf(fp
, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION
);
112 fprintf(fp
, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
114 fprintf(fp
, " INPUT Input trace path\n");
115 fprintf(fp
, " OUTPUT Output trace path (default: stdout)\n");
117 fprintf(fp
, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
118 fprintf(fp
, " -o, --output-format FORMAT Output trace format (default: text)\n");
120 fprintf(fp
, " -h, --help This help message\n");
121 fprintf(fp
, " -l, --list List available formats\n");
122 fprintf(fp
, " -v, --verbose Verbose mode\n");
123 fprintf(fp
, " (or set BABELTRACE_VERBOSE environment variable)\n");
124 fprintf(fp
, " -d, --debug Debug mode\n");
125 fprintf(fp
, " (or set BABELTRACE_DEBUG environment variable)\n");
126 fprintf(fp
, " --no-delta Do not print time delta between consecutive events\n");
127 fprintf(fp
, " -n, --names name1<,name2,...> Print field names:\n");
128 fprintf(fp
, " (payload OR args OR arg)\n");
129 fprintf(fp
, " none, all, scope, header, (context OR ctx)\n");
130 fprintf(fp
, " (default: payload,context)\n");
131 fprintf(fp
, " -f, --fields name1<,name2,...> Print additional fields:\n");
132 fprintf(fp
, " all, trace, trace:domain, trace:procname,\n");
133 fprintf(fp
, " trace:vpid, loglevel.\n");
134 fprintf(fp
, " --clock-cycles Timestamp in cycles\n");
135 fprintf(fp
, " --clock-offset seconds Clock offset in seconds\n");
136 fprintf(fp
, " --clock-seconds Print the timestamps as [sec.ns]\n");
137 fprintf(fp
, " (default is: [hh:mm:ss.ns])\n");
138 fprintf(fp
, " --clock-date Print clock date\n");
139 fprintf(fp
, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n");
140 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently correlated\n");
141 fprintf(fp
, " across traces.\n");
146 static int get_names_args(poptContext
*pc
)
148 char *str
, *strlist
, *strctx
;
150 opt_payload_field_names
= 0;
151 opt_context_field_names
= 0;
152 strlist
= (char *) poptGetOptArg(*pc
);
156 str
= strtok_r(strlist
, ",", &strctx
);
158 if (!strcmp(str
, "all"))
159 opt_all_field_names
= 1;
160 else if (!strcmp(str
, "scope"))
161 opt_scope_field_names
= 1;
162 else if (!strcmp(str
, "context") || !strcmp(str
, "ctx"))
163 opt_context_field_names
= 1;
164 else if (!strcmp(str
, "header"))
165 opt_header_field_names
= 1;
166 else if (!strcmp(str
, "payload") || !strcmp(str
, "args") || !strcmp(str
, "arg"))
167 opt_payload_field_names
= 1;
168 else if (!strcmp(str
, "none")) {
169 opt_all_field_names
= 0;
170 opt_scope_field_names
= 0;
171 opt_context_field_names
= 0;
172 opt_header_field_names
= 0;
173 opt_payload_field_names
= 0;
175 fprintf(stderr
, "[error] unknown field name type %s\n", str
);
178 } while ((str
= strtok_r(NULL
, ",", &strctx
)));
182 static int get_fields_args(poptContext
*pc
)
184 char *str
, *strlist
, *strctx
;
186 strlist
= (char *) poptGetOptArg(*pc
);
190 str
= strtok_r(strlist
, ",", &strctx
);
192 if (!strcmp(str
, "all"))
194 else if (!strcmp(str
, "trace"))
196 else if (!strcmp(str
, "trace:domain"))
197 opt_trace_domain_field
= 1;
198 else if (!strcmp(str
, "trace:procname"))
199 opt_trace_procname_field
= 1;
200 else if (!strcmp(str
, "trace:vpid"))
201 opt_trace_vpid_field
= 1;
202 else if (!strcmp(str
, "loglevel"))
203 opt_loglevel_field
= 1;
205 fprintf(stderr
, "[error] unknown field type %s\n", str
);
208 } while ((str
= strtok_r(NULL
, ",", &strctx
)));
213 * Return 0 if caller should continue, < 0 if caller should return
214 * error, > 0 if caller should exit without reporting error.
216 static int parse_options(int argc
, char **argv
)
223 return 1; /* exit cleanly */
226 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
227 poptReadDefaultConfig(pc
, 0);
230 opt_context_field_names
= 1;
231 opt_payload_field_names
= 1;
233 while ((opt
= poptGetNextOpt(pc
)) != -1) {
237 ret
= 1; /* exit cleanly */
240 list_formats(stdout
);
244 babeltrace_verbose
= 1;
247 if (get_names_args(&pc
)) {
253 if (get_fields_args(&pc
)) {
259 babeltrace_debug
= 1;
264 case OPT_CLOCK_CYCLES
:
265 opt_clock_cycles
= 1;
267 case OPT_CLOCK_OFFSET
:
272 str
= poptGetOptArg(pc
);
274 fprintf(stderr
, "[error] Missing --clock-offset argument\n");
279 opt_clock_offset
= strtoull(str
, &endptr
, 0);
280 if (*endptr
!= '\0' || str
== endptr
|| errno
!= 0) {
281 fprintf(stderr
, "[error] Incorrect --clock-offset argument: %s\n", str
);
287 case OPT_CLOCK_SECONDS
:
288 opt_clock_seconds
= 1;
296 case OPT_CLOCK_FORCE_CORRELATE
:
297 opt_clock_force_correlate
= 1;
306 opt_input_path
= poptGetArg(pc
);
307 if (!opt_input_path
) {
311 opt_output_path
= poptGetArg(pc
);
322 * bt_context_add_traces_recursive: Open a trace recursively
324 * Find each trace present in the subdirectory starting from the given
325 * path, and add them to the context. The packet_seek parameter can be
326 * NULL: this specify to use the default format packet_seek.
328 * Return: 0 on success, < 0 on failure, > 0 on partial failure.
329 * Unable to open toplevel: failure.
330 * Unable to open some subdirectory or file: warn and continue (partial
333 int bt_context_add_traces_recursive(struct bt_context
*ctx
, const char *path
,
334 const char *format_str
,
335 void (*packet_seek
)(struct stream_pos
*pos
,
336 size_t offset
, int whence
))
341 char lpath
[PATH_MAX
];
342 char * const paths
[2] = { lpath
, NULL
};
346 * Need to copy path, because fts_open can change it.
347 * It is the pointer array, not the strings, that are constant.
349 strncpy(lpath
, path
, PATH_MAX
);
350 lpath
[PATH_MAX
- 1] = '\0';
352 tree
= fts_open(paths
, FTS_NOCHDIR
| FTS_LOGICAL
, 0);
354 fprintf(stderr
, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
359 trace_ids
= g_array_new(FALSE
, TRUE
, sizeof(int));
361 while ((node
= fts_read(tree
))) {
365 if (!(node
->fts_info
& FTS_D
))
368 dirfd
= open(node
->fts_accpath
, 0);
370 fprintf(stderr
, "[error] [Context] Unable to open trace "
371 "directory file descriptor.\n");
372 ret
= 1; /* partial error */
375 metafd
= openat(dirfd
, "metadata", O_RDONLY
);
377 closeret
= close(dirfd
);
380 ret
= -1; /* failure */
387 closeret
= close(metafd
);
390 ret
= -1; /* failure */
393 closeret
= close(dirfd
);
396 ret
= -1; /* failure */
400 trace_id
= bt_context_add_trace(ctx
,
401 node
->fts_accpath
, format_str
,
402 packet_seek
, NULL
, NULL
);
404 fprintf(stderr
, "[warning] [Context] opening trace \"%s\" from %s "
405 "for reading.\n", node
->fts_accpath
, path
);
406 /* Allow to skip erroneous traces. */
407 ret
= 1; /* partial error */
410 g_array_append_val(trace_ids
, trace_id
);
416 * Return an error if no trace can be opened.
418 if (trace_ids
->len
== 0) {
419 fprintf(stderr
, "[error] Cannot open any trace for reading.\n\n");
420 ret
= -ENOENT
; /* failure */
422 g_array_free(trace_ids
, TRUE
);
428 int convert_trace(struct trace_descriptor
*td_write
,
429 struct bt_context
*ctx
)
431 struct bt_ctf_iter
*iter
;
432 struct ctf_text_stream_pos
*sout
;
433 struct bt_iter_pos begin_pos
;
434 struct bt_ctf_event
*ctf_event
;
437 sout
= container_of(td_write
, struct ctf_text_stream_pos
,
440 begin_pos
.type
= BT_SEEK_BEGIN
;
441 iter
= bt_ctf_iter_create(ctx
, &begin_pos
, NULL
);
446 while ((ctf_event
= bt_ctf_iter_read_event(iter
))) {
447 ret
= sout
->parent
.event_cb(&sout
->parent
, ctf_event
->parent
->stream
);
449 fprintf(stderr
, "[error] Writing event failed.\n");
452 ret
= bt_iter_next(bt_ctf_get_iter(iter
));
459 bt_ctf_iter_destroy(iter
);
464 int main(int argc
, char **argv
)
466 int ret
, partial_error
= 0;
467 struct format
*fmt_write
;
468 struct trace_descriptor
*td_write
;
469 struct bt_context
*ctx
;
471 ret
= parse_options(argc
, argv
);
473 fprintf(stderr
, "Error parsing options.\n\n");
476 } else if (ret
> 0) {
479 printf_verbose("Verbose mode active.\n");
480 printf_debug("Debug mode active.\n");
482 if (opt_input_format_arg
) {
483 opt_input_format
= strdup(opt_input_format_arg
);
484 if (!opt_input_format
) {
488 strlower(opt_input_format
);
490 if (opt_output_format_arg
) {
491 opt_output_format
= strdup(opt_output_format_arg
);
492 if (!opt_output_format
) {
496 strlower(opt_output_format
);
499 printf_verbose("Converting from directory: %s\n", opt_input_path
);
500 printf_verbose("Converting from format: %s\n",
501 opt_input_format
? : "ctf <default>");
502 printf_verbose("Converting to directory: %s\n",
503 opt_output_path
? : "<stdout>");
504 printf_verbose("Converting to format: %s\n",
505 opt_output_format
? : "text <default>");
507 if (!opt_input_format
) {
508 opt_input_format
= strdup("ctf");
509 if (!opt_input_format
) {
514 if (!opt_output_format
) {
515 opt_output_format
= strdup("text");
516 if (!opt_output_format
) {
521 fmt_read
= bt_lookup_format(g_quark_from_static_string(opt_input_format
));
523 fprintf(stderr
, "[error] Format \"%s\" is not supported.\n\n",
528 fmt_write
= bt_lookup_format(g_quark_from_static_string(opt_output_format
));
530 fprintf(stderr
, "[error] format \"%s\" is not supported.\n\n",
536 ctx
= bt_context_create();
538 ret
= bt_context_add_traces_recursive(ctx
, opt_input_path
,
539 opt_input_format
, NULL
);
541 fprintf(stderr
, "[error] opening trace \"%s\" for reading.\n\n",
544 } else if (ret
> 0) {
545 fprintf(stderr
, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n",
550 td_write
= fmt_write
->open_trace(opt_output_path
, O_RDWR
, NULL
, NULL
);
552 fprintf(stderr
, "Error opening trace \"%s\" for writing.\n\n",
553 opt_output_path
? : "<none>");
557 ret
= convert_trace(td_write
, ctx
);
559 fprintf(stderr
, "Error printing trace.\n\n");
560 goto error_copy_trace
;
563 fmt_write
->close_trace(td_write
);
566 printf_verbose("finished converting. Output written to:\n%s\n",
567 opt_output_path
? : "<stdout>");
572 fmt_write
->close_trace(td_write
);
578 /* teardown and exit */
580 free(opt_input_format
);
581 free(opt_output_format
);