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 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
29 #include <babeltrace/babeltrace.h>
30 #include <babeltrace/format.h>
31 #include <babeltrace/context.h>
32 #include <babeltrace/context-internal.h>
33 #include <babeltrace/ctf/types.h>
34 #include <babeltrace/ctf/events.h>
35 /* TODO: fix object model for format-agnostic callbacks */
36 #include <babeltrace/ctf/events-internal.h>
37 #include <babeltrace/ctf/iterator.h>
38 #include <babeltrace/ctf-text/types.h>
39 #include <babeltrace/debug-info.h>
40
41 #include <babeltrace/iterator.h>
42 #include <popt.h>
43 #include <errno.h>
44 #include <stdlib.h>
45 #include <ctype.h>
46 #include <sys/stat.h>
47 #include <sys/types.h>
48 #include <fcntl.h>
49 #include <unistd.h>
50 #include <inttypes.h>
51 #include <ftw.h>
52 #include <string.h>
53
54 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
55
56 #define PARTIAL_ERROR_SLEEP 3 /* 3 seconds */
57
58 #define DEFAULT_FILE_ARRAY_SIZE 1
59
60 #define NET_URL_PREFIX "net://"
61 #define NET4_URL_PREFIX "net4://"
62 #define NET6_URL_PREFIX "net6://"
63
64 static char *opt_input_format, *opt_output_format;
65
66 /*
67 * We are not freeing opt_input_paths ipath elements when exiting from
68 * main() for backward compatibility with libpop 0.13, which does not
69 * allocate copies for arguments returned by poptGetArg(), and for
70 * general compatibility with the documented behavior. This is known to
71 * cause a small memory leak with libpop 0.16.
72 */
73 static GPtrArray *opt_input_paths;
74 static char *opt_output_path;
75 static int opt_stream_intersection;
76
77 static struct bt_format *fmt_read;
78
79 void bt_dummy_hook(void);
80 void bt_lttng_live_hook(void);
81 void bt_ctf_hook(void);
82 void bt_ctf_text_hook(void);
83 void bt_ctf_metadata_hook(void);
84
85 static
strlower(char * str)86 void strlower(char *str)
87 {
88 while (*str) {
89 *str = tolower((int) *str);
90 str++;
91 }
92 }
93
94 enum {
95 OPT_NONE = 0,
96 OPT_OUTPUT_PATH,
97 OPT_INPUT_FORMAT,
98 OPT_OUTPUT_FORMAT,
99 OPT_HELP,
100 OPT_LIST,
101 OPT_VERBOSE,
102 OPT_DEBUG,
103 OPT_NAMES,
104 OPT_FIELDS,
105 OPT_NO_DELTA,
106 OPT_CLOCK_OFFSET,
107 OPT_CLOCK_OFFSET_NS,
108 OPT_CLOCK_CYCLES,
109 OPT_CLOCK_SECONDS,
110 OPT_CLOCK_DATE,
111 OPT_CLOCK_GMT,
112 OPT_CLOCK_FORCE_CORRELATE,
113 OPT_STREAM_INTERSECTION,
114 OPT_DEBUG_INFO_DIR,
115 OPT_DEBUG_INFO_FULL_PATH,
116 OPT_DEBUG_INFO_TARGET_PREFIX,
117 };
118
119 /*
120 * We are _not_ using POPT_ARG_STRING ability to store directly into
121 * variables, because we want to cast the return to non-const, which is
122 * not possible without using poptGetOptArg explicitly. This helps us
123 * controlling memory allocation correctly without making assumptions
124 * about undocumented behaviors. poptGetOptArg is documented as
125 * requiring the returned const char * to be freed by the caller.
126 */
127 static struct poptOption long_options[] = {
128 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
129 { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT_PATH, NULL, NULL },
130 { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL },
131 { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL },
132 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
133 { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
134 { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
135 { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
136 { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
137 { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
138 { "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
139 { "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
140 { "clock-offset-ns", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL },
141 { "clock-cycles", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL },
142 { "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
143 { "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
144 { "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
145 { "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
146 { "stream-intersection", 0, POPT_ARG_NONE, NULL, OPT_STREAM_INTERSECTION, NULL, NULL },
147 #ifdef ENABLE_DEBUG_INFO
148 { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL },
149 { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL },
150 { "debug-info-target-prefix", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_TARGET_PREFIX, NULL, NULL },
151 #endif
152 { NULL, 0, 0, NULL, 0, NULL, NULL },
153 };
154
list_formats(FILE * fp)155 static void list_formats(FILE *fp)
156 {
157 fprintf(fp, "\n");
158 bt_fprintf_format_list(fp);
159 }
160
usage(FILE * fp)161 static void usage(FILE *fp)
162 {
163 fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
164 fprintf(fp, "usage : babeltrace [OPTIONS] FILE...\n");
165 fprintf(fp, "\n");
166 fprintf(fp, " FILE Input trace file(s) and/or directory(ies)\n");
167 fprintf(fp, " (space-separated)\n");
168 fprintf(fp, " -w, --output OUTPUT Output trace path (default: stdout)\n");
169 fprintf(fp, "\n");
170 fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
171 fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
172 fprintf(fp, "\n");
173 fprintf(fp, " -h, --help This help message\n");
174 fprintf(fp, " -l, --list List available formats\n");
175 fprintf(fp, " -v, --verbose Verbose mode\n");
176 fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n");
177 fprintf(fp, " -d, --debug Debug mode\n");
178 fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n");
179 fprintf(fp, " --no-delta Do not print time delta between consecutive events\n");
180 fprintf(fp, " -n, --names name1<,name2,...> Print field names:\n");
181 fprintf(fp, " (payload OR args OR arg)\n");
182 fprintf(fp, " none, all, scope, header, (context OR ctx)\n");
183 fprintf(fp, " (default: payload,context)\n");
184 fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n");
185 fprintf(fp, " all, trace, trace:hostname, trace:domain,\n");
186 fprintf(fp, " trace:procname, trace:vpid, loglevel, emf, callsite.\n");
187 fprintf(fp, " (default: trace:hostname,trace:procname,trace:vpid)\n");
188 fprintf(fp, " --clock-cycles Timestamp in cycles\n");
189 fprintf(fp, " --clock-offset seconds Clock offset in seconds\n");
190 fprintf(fp, " --clock-offset-ns ns Clock offset in nanoseconds\n");
191 fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n");
192 fprintf(fp, " (default is: [hh:mm:ss.ns])\n");
193 fprintf(fp, " --clock-date Print clock date\n");
194 fprintf(fp, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n");
195 fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n");
196 fprintf(fp, " across traces.\n");
197 fprintf(fp, " --stream-intersection Only print events when all streams are active.\n");
198 #ifdef ENABLE_DEBUG_INFO
199 fprintf(fp, " --debug-info-dir Directory in which to look for debugging information\n");
200 fprintf(fp, " files. (default: /usr/lib/debug/)\n");
201 fprintf(fp, " --debug-info-target-prefix Directory to use as a prefix for executable lookup\n");
202 fprintf(fp, " --debug-info-full-path Show full debug info source and binary paths (if available)\n");
203 #endif
204 list_formats(fp);
205 fprintf(fp, "\n");
206 }
207
get_names_args(poptContext * pc)208 static int get_names_args(poptContext *pc)
209 {
210 char *str, *strlist, *strctx;
211 int ret = 0;
212
213 opt_payload_field_names = 0;
214 opt_context_field_names = 0;
215 strlist = (char *) poptGetOptArg(*pc);
216 if (!strlist) {
217 return -EINVAL;
218 }
219 str = strtok_r(strlist, ",", &strctx);
220 do {
221 if (!strcmp(str, "all"))
222 opt_all_field_names = 1;
223 else if (!strcmp(str, "scope"))
224 opt_scope_field_names = 1;
225 else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
226 opt_context_field_names = 1;
227 else if (!strcmp(str, "header"))
228 opt_header_field_names = 1;
229 else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
230 opt_payload_field_names = 1;
231 else if (!strcmp(str, "none")) {
232 opt_all_field_names = 0;
233 opt_scope_field_names = 0;
234 opt_context_field_names = 0;
235 opt_header_field_names = 0;
236 opt_payload_field_names = 0;
237 } else {
238 fprintf(stderr, "[error] unknown field name type %s\n", str);
239 ret = -EINVAL;
240 goto end;
241 }
242 } while ((str = strtok_r(NULL, ",", &strctx)));
243 end:
244 free(strlist);
245 return ret;
246 }
247
get_fields_args(poptContext * pc)248 static int get_fields_args(poptContext *pc)
249 {
250 char *str, *strlist, *strctx;
251 int ret = 0;
252
253 strlist = (char *) poptGetOptArg(*pc);
254 if (!strlist) {
255 return -EINVAL;
256 }
257 str = strtok_r(strlist, ",", &strctx);
258 do {
259 opt_trace_default_fields = 0;
260 if (!strcmp(str, "all"))
261 opt_all_fields = 1;
262 else if (!strcmp(str, "trace"))
263 opt_trace_field = 1;
264 else if (!strcmp(str, "trace:hostname"))
265 opt_trace_hostname_field = 1;
266 else if (!strcmp(str, "trace:domain"))
267 opt_trace_domain_field = 1;
268 else if (!strcmp(str, "trace:procname"))
269 opt_trace_procname_field = 1;
270 else if (!strcmp(str, "trace:vpid"))
271 opt_trace_vpid_field = 1;
272 else if (!strcmp(str, "loglevel"))
273 opt_loglevel_field = 1;
274 else if (!strcmp(str, "emf"))
275 opt_emf_field = 1;
276 else if (!strcmp(str, "callsite"))
277 opt_callsite_field = 1;
278 else {
279 fprintf(stderr, "[error] unknown field type %s\n", str);
280 ret = -EINVAL;
281 goto end;
282 }
283 } while ((str = strtok_r(NULL, ",", &strctx)));
284 end:
285 free(strlist);
286 return ret;
287 }
288
289 /*
290 * Return 0 if caller should continue, < 0 if caller should return
291 * error, > 0 if caller should exit without reporting error.
292 */
parse_options(int argc,char ** argv)293 static int parse_options(int argc, char **argv)
294 {
295 poptContext pc;
296 int opt, ret = 0;
297 const char *ipath;
298
299 if (argc == 1) {
300 usage(stdout);
301 return 1; /* exit cleanly */
302 }
303
304 pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
305 poptReadDefaultConfig(pc, 0);
306
307 /* set default */
308 opt_context_field_names = 1;
309 opt_payload_field_names = 1;
310
311 while ((opt = poptGetNextOpt(pc)) != -1) {
312 switch (opt) {
313 case OPT_OUTPUT_PATH:
314 opt_output_path = (char *) poptGetOptArg(pc);
315 if (!opt_output_path) {
316 ret = -EINVAL;
317 goto end;
318 }
319 break;
320 case OPT_INPUT_FORMAT:
321 opt_input_format = (char *) poptGetOptArg(pc);
322 if (!opt_input_format) {
323 ret = -EINVAL;
324 goto end;
325 }
326 break;
327 case OPT_OUTPUT_FORMAT:
328 opt_output_format = (char *) poptGetOptArg(pc);
329 if (!opt_output_format) {
330 ret = -EINVAL;
331 goto end;
332 }
333 break;
334 case OPT_HELP:
335 usage(stdout);
336 ret = 1; /* exit cleanly */
337 goto end;
338 case OPT_LIST:
339 list_formats(stdout);
340 ret = 1;
341 goto end;
342 case OPT_VERBOSE:
343 babeltrace_verbose = 1;
344 break;
345 case OPT_NAMES:
346 if (get_names_args(&pc)) {
347 ret = -EINVAL;
348 goto end;
349 }
350 break;
351 case OPT_FIELDS:
352 if (get_fields_args(&pc)) {
353 ret = -EINVAL;
354 goto end;
355 }
356 break;
357 case OPT_DEBUG:
358 babeltrace_debug = 1;
359 break;
360 case OPT_NO_DELTA:
361 opt_delta_field = 0;
362 break;
363 case OPT_CLOCK_CYCLES:
364 opt_clock_cycles = 1;
365 break;
366 case OPT_CLOCK_OFFSET:
367 {
368 char *str;
369 char *endptr;
370
371 str = (char *) poptGetOptArg(pc);
372 if (!str) {
373 fprintf(stderr, "[error] Missing --clock-offset argument\n");
374 ret = -EINVAL;
375 goto end;
376 }
377 errno = 0;
378 opt_clock_offset = strtoull(str, &endptr, 0);
379 if (*endptr != '\0' || str == endptr || errno != 0) {
380 fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
381 ret = -EINVAL;
382 free(str);
383 goto end;
384 }
385 free(str);
386 break;
387 }
388 case OPT_CLOCK_SECONDS:
389 opt_clock_seconds = 1;
390 break;
391 case OPT_CLOCK_OFFSET_NS:
392 {
393 char *str;
394 char *endptr;
395
396 str = (char *) poptGetOptArg(pc);
397 if (!str) {
398 fprintf(stderr, "[error] Missing --clock-offset-ns argument\n");
399 ret = -EINVAL;
400 goto end;
401 }
402 errno = 0;
403 opt_clock_offset_ns = strtoull(str, &endptr, 0);
404 if (*endptr != '\0' || str == endptr || errno != 0) {
405 fprintf(stderr, "[error] Incorrect --clock-offset-ns argument: %s\n", str);
406 ret = -EINVAL;
407 free(str);
408 goto end;
409 }
410 free(str);
411 break;
412 }
413
414 case OPT_CLOCK_DATE:
415 opt_clock_date = 1;
416 break;
417 case OPT_CLOCK_GMT:
418 opt_clock_gmt = 1;
419 break;
420 case OPT_CLOCK_FORCE_CORRELATE:
421 opt_clock_force_correlate = 1;
422 break;
423 case OPT_STREAM_INTERSECTION:
424 opt_stream_intersection = 1;
425 break;
426 case OPT_DEBUG_INFO_DIR:
427 opt_debug_info_dir = (char *) poptGetOptArg(pc);
428 if (!opt_debug_info_dir) {
429 ret = -EINVAL;
430 goto end;
431 }
432 break;
433 case OPT_DEBUG_INFO_FULL_PATH:
434 opt_debug_info_full_path = 1;
435 break;
436 case OPT_DEBUG_INFO_TARGET_PREFIX:
437 opt_debug_info_target_prefix = (char *) poptGetOptArg(pc);
438 if (!opt_debug_info_target_prefix) {
439 ret = -EINVAL;
440 goto end;
441 }
442 break;
443 default:
444 ret = -EINVAL;
445 goto end;
446 }
447 }
448
449 do {
450 ipath = poptGetArg(pc);
451 if (ipath)
452 g_ptr_array_add(opt_input_paths, (gpointer) ipath);
453 } while (ipath);
454 if (opt_input_paths->len == 0) {
455 ret = -EINVAL;
456 goto end;
457 }
458
459 end:
460 if (pc) {
461 poptFreeContext(pc);
462 }
463 return ret;
464 }
465
466 static GPtrArray *traversed_paths = 0;
467
468 /*
469 * traverse_trace_dir() is the callback function for File Tree Walk (nftw).
470 * it receives the path of the current entry (file, dir, link..etc) with
471 * a flag to indicate the type of the entry.
472 * if the entry being visited is a directory and contains a metadata file,
473 * then add the path to a global list to be processed later in
474 * add_traces_recursive.
475 */
traverse_trace_dir(const char * fpath,const struct stat * sb,int tflag,struct FTW * ftwbuf)476 static int traverse_trace_dir(const char *fpath, const struct stat *sb,
477 int tflag, struct FTW *ftwbuf)
478 {
479 int dirfd, metafd;
480 int closeret;
481
482 if (tflag != FTW_D)
483 return 0;
484
485 dirfd = open(fpath, 0);
486 if (dirfd < 0) {
487 fprintf(stderr, "[error] [Context] Unable to open trace "
488 "directory file descriptor.\n");
489 return 0; /* partial error */
490 }
491 metafd = openat(dirfd, "metadata", O_RDONLY);
492 if (metafd < 0) {
493 closeret = close(dirfd);
494 if (closeret < 0) {
495 perror("close");
496 return -1;
497 }
498 /* No meta data, just return */
499 return 0;
500 } else {
501 int err_close = 0;
502
503 closeret = close(metafd);
504 if (closeret < 0) {
505 perror("close");
506 err_close = 1;
507 }
508 closeret = close(dirfd);
509 if (closeret < 0) {
510 perror("close");
511 err_close = 1;
512 }
513 if (err_close) {
514 return -1;
515 }
516
517 /* Add path to the global list */
518 if (traversed_paths == NULL) {
519 fprintf(stderr, "[error] [Context] Invalid open path array.\n");
520 return -1;
521 }
522 g_ptr_array_add(traversed_paths, g_string_new(fpath));
523 }
524
525 return 0;
526 }
527
528 /*
529 * bt_context_add_traces_recursive: Open a trace recursively
530 *
531 * Find each trace present in the subdirectory starting from the given
532 * path, and add them to the context. The packet_seek parameter can be
533 * NULL: this specify to use the default format packet_seek.
534 *
535 * Return: 0 on success, < 0 on failure, > 0 on partial failure.
536 * Unable to open toplevel: failure.
537 * Unable to open some subdirectory or file: warn and continue (partial
538 * failure);
539 */
bt_context_add_traces_recursive(struct bt_context * ctx,const char * path,const char * format_str,void (* packet_seek)(struct bt_stream_pos * pos,size_t offset,int whence))540 int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
541 const char *format_str,
542 void (*packet_seek)(struct bt_stream_pos *pos,
543 size_t offset, int whence))
544 {
545 int ret = 0, trace_ids = 0;
546
547 if ((strncmp(path, NET4_URL_PREFIX, sizeof(NET4_URL_PREFIX) - 1)) == 0 ||
548 (strncmp(path, NET6_URL_PREFIX, sizeof(NET6_URL_PREFIX) - 1)) == 0 ||
549 (strncmp(path, NET_URL_PREFIX, sizeof(NET_URL_PREFIX) - 1)) == 0) {
550 ret = bt_context_add_trace(ctx,
551 path, format_str, packet_seek, NULL, NULL);
552 if (ret < 0) {
553 fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" "
554 "for reading.\n", path);
555 }
556 return ret;
557 }
558 /* Should lock traversed_paths mutex here if used in multithread */
559
560 traversed_paths = g_ptr_array_new();
561 ret = nftw(path, traverse_trace_dir, 10, 0);
562
563 /* Process the array if ntfw did not return a fatal error */
564 if (ret >= 0) {
565 int i;
566
567 for (i = 0; i < traversed_paths->len; i++) {
568 GString *trace_path = g_ptr_array_index(traversed_paths,
569 i);
570 int trace_id = bt_context_add_trace(ctx,
571 trace_path->str,
572 format_str,
573 packet_seek,
574 NULL,
575 NULL);
576 if (trace_id < 0) {
577 fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" from %s "
578 "for reading.\n", trace_path->str, path);
579 /* Allow to skip erroneous traces. */
580 ret = 1; /* partial error */
581 } else {
582 trace_ids++;
583 }
584 g_string_free(trace_path, TRUE);
585 }
586 }
587
588 g_ptr_array_free(traversed_paths, TRUE);
589 traversed_paths = NULL;
590
591 /* Should unlock traversed paths mutex here if used in multithread */
592
593 /*
594 * Return an error if no trace can be opened.
595 */
596 if (trace_ids == 0) {
597 fprintf(stderr, "[error] Cannot open any trace for reading.\n\n");
598 ret = -ENOENT; /* failure */
599 }
600 return ret;
601 }
602
603 static
trace_pre_handler(struct bt_trace_descriptor * td_write,struct bt_context * ctx)604 int trace_pre_handler(struct bt_trace_descriptor *td_write,
605 struct bt_context *ctx)
606 {
607 struct ctf_text_stream_pos *sout;
608 struct trace_collection *tc;
609 int ret, i;
610
611 sout = container_of(td_write, struct ctf_text_stream_pos,
612 trace_descriptor);
613
614 if (!sout->parent.pre_trace_cb)
615 return 0;
616
617 tc = ctx->tc;
618 for (i = 0; i < tc->array->len; i++) {
619 struct bt_trace_descriptor *td =
620 g_ptr_array_index(tc->array, i);
621
622 ret = sout->parent.pre_trace_cb(&sout->parent, td);
623 if (ret) {
624 fprintf(stderr, "[error] Writing to trace pre handler failed.\n");
625 goto end;
626 }
627 }
628 ret = 0;
629 end:
630 return ret;
631 }
632
633 static
trace_post_handler(struct bt_trace_descriptor * td_write,struct bt_context * ctx)634 int trace_post_handler(struct bt_trace_descriptor *td_write,
635 struct bt_context *ctx)
636 {
637 struct ctf_text_stream_pos *sout;
638 struct trace_collection *tc;
639 int ret, i;
640
641 sout = container_of(td_write, struct ctf_text_stream_pos,
642 trace_descriptor);
643
644 if (!sout->parent.post_trace_cb)
645 return 0;
646
647 tc = ctx->tc;
648 for (i = 0; i < tc->array->len; i++) {
649 struct bt_trace_descriptor *td =
650 g_ptr_array_index(tc->array, i);
651
652 ret = sout->parent.post_trace_cb(&sout->parent, td);
653 if (ret) {
654 fprintf(stderr, "[error] Writing to trace post handler failed.\n");
655 goto end;
656 }
657 }
658 ret = 0;
659 end:
660 return ret;
661 }
662
663 static
convert_trace(struct bt_trace_descriptor * td_write,struct bt_context * ctx)664 int convert_trace(struct bt_trace_descriptor *td_write,
665 struct bt_context *ctx)
666 {
667 struct bt_ctf_iter *iter;
668 struct ctf_text_stream_pos *sout;
669 struct bt_iter_pos *begin_pos = NULL, *end_pos = NULL;
670 struct bt_ctf_event *ctf_event;
671 int ret;
672 int error_holder = 0;
673
674 sout = container_of(td_write, struct ctf_text_stream_pos,
675 trace_descriptor);
676
677 if (!sout->parent.event_cb) {
678 return 0;
679 }
680
681 if (opt_stream_intersection) {
682 iter = bt_ctf_iter_create_intersect(ctx, &begin_pos, &end_pos);
683 } else {
684 begin_pos = bt_iter_create_time_pos(NULL, 0);
685 begin_pos->type = BT_SEEK_BEGIN;
686 iter = bt_ctf_iter_create(ctx, begin_pos, NULL);
687 }
688 if (!iter) {
689 ret = -1;
690 goto error_iter;
691 }
692 while ((ctf_event = bt_ctf_iter_read_event(iter))) {
693 ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream);
694 if (ret) {
695 fprintf(stderr, "[error] Writing event failed.\n");
696 goto end;
697 }
698 ret = bt_iter_next(bt_ctf_get_iter(iter));
699 if (ret == -ERANGE) {
700 /*
701 * Remember that a range (truncated packet)
702 * error occurred and continue.
703 */
704 error_holder = 1;
705 continue;
706 } else if (ret < 0) {
707 goto end;
708 }
709 }
710 ret = error_holder;
711
712 end:
713 bt_ctf_iter_destroy(iter);
714 error_iter:
715 bt_iter_free_pos(begin_pos);
716 bt_iter_free_pos(end_pos);
717 return ret;
718 }
719
call_plugins_hooks(void)720 void call_plugins_hooks(void)
721 {
722 bt_dummy_hook();
723 bt_lttng_live_hook();
724 bt_ctf_hook();
725 bt_ctf_text_hook();
726 bt_ctf_metadata_hook();
727 }
728
main(int argc,char ** argv)729 int main(int argc, char **argv)
730 {
731 int ret, partial_error = 0, open_success = 0;
732 struct bt_format *fmt_write;
733 struct bt_trace_descriptor *td_write;
734 struct bt_context *ctx;
735 int i;
736
737 call_plugins_hooks();
738
739 opt_input_paths = g_ptr_array_new();
740
741 ret = parse_options(argc, argv);
742 if (ret < 0) {
743 fprintf(stderr, "Error parsing options.\n\n");
744 usage(stderr);
745 g_ptr_array_free(opt_input_paths, TRUE);
746 exit(EXIT_FAILURE);
747 } else if (ret > 0) {
748 g_ptr_array_free(opt_input_paths, TRUE);
749 exit(EXIT_SUCCESS);
750 }
751 printf_verbose("Verbose mode active.\n");
752 printf_debug("Debug mode active.\n");
753
754 if (opt_input_format)
755 strlower(opt_input_format);
756 if (opt_output_format)
757 strlower(opt_output_format);
758
759 printf_verbose("Converting from directory(ies):\n");
760 for (i = 0; i < opt_input_paths->len; i++) {
761 const char *ipath = g_ptr_array_index(opt_input_paths, i);
762 printf_verbose(" %s\n", ipath);
763 }
764 printf_verbose("Converting from format: %s\n",
765 opt_input_format ? : "ctf <default>");
766 printf_verbose("Converting to target: %s\n",
767 opt_output_path ? : "<stdout>");
768 printf_verbose("Converting to format: %s\n",
769 opt_output_format ? : "text <default>");
770
771 if (!opt_input_format) {
772 opt_input_format = strdup("ctf");
773 if (!opt_input_format) {
774 partial_error = 1;
775 goto end;
776 }
777 }
778 if (!opt_output_format) {
779 opt_output_format = strdup("text");
780 if (!opt_output_format) {
781 partial_error = 1;
782 goto end;
783 }
784 }
785 fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
786 if (!fmt_read) {
787 fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
788 opt_input_format);
789 partial_error = 1;
790 goto end;
791 }
792 fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
793 if (!fmt_write) {
794 fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
795 opt_output_format);
796 partial_error = 1;
797 goto end;
798 }
799
800 ctx = bt_context_create();
801 if (!ctx) {
802 goto error_td_read;
803 }
804
805 for (i = 0; i < opt_input_paths->len; i++) {
806 const char *ipath = g_ptr_array_index(opt_input_paths, i);
807 ret = bt_context_add_traces_recursive(ctx, ipath,
808 opt_input_format, NULL);
809 if (ret < 0) {
810 fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
811 ipath);
812 } else if (ret > 0) {
813 fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n",
814 ipath);
815 open_success = 1; /* some traces were OK */
816 partial_error = 1;
817 } else {
818 open_success = 1; /* all traces were OK */
819 }
820 }
821 if (!open_success) {
822 fprintf(stderr, "[error] none of the specified trace paths could be opened.\n\n");
823 goto error_td_read;
824 }
825
826 td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
827 if (!td_write) {
828 fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
829 opt_output_path ? : "<none>");
830 goto error_td_write;
831 }
832
833 /*
834 * Errors happened when opening traces, but we continue anyway.
835 * sleep to let user see the stderr output before stdout.
836 */
837 if (partial_error)
838 sleep(PARTIAL_ERROR_SLEEP);
839
840 ret = trace_pre_handler(td_write, ctx);
841 if (ret) {
842 fprintf(stderr, "Error in trace pre handle.\n\n");
843 goto error_copy_trace;
844 }
845
846 /* For now, we support only CTF iterators */
847 if (fmt_read->name == g_quark_from_static_string("ctf")) {
848 ret = convert_trace(td_write, ctx);
849 if (ret) {
850 fprintf(stderr, "Error printing trace.\n\n");
851 goto error_copy_trace;
852 }
853 }
854
855 ret = trace_post_handler(td_write, ctx);
856 if (ret) {
857 fprintf(stderr, "Error in trace post handle.\n\n");
858 goto error_copy_trace;
859 }
860
861 fmt_write->close_trace(td_write);
862
863 bt_context_put(ctx);
864 printf_verbose("finished converting. Output written to:\n%s\n",
865 opt_output_path ? : "<stdout>");
866 goto end;
867
868 /* Error handling */
869 error_copy_trace:
870 fmt_write->close_trace(td_write);
871 error_td_write:
872 bt_context_put(ctx);
873 error_td_read:
874 partial_error = 1;
875
876 /* teardown and exit */
877 end:
878 free(opt_input_format);
879 free(opt_output_format);
880 free(opt_output_path);
881 free(opt_debug_info_dir);
882 free(opt_debug_info_target_prefix);
883 g_ptr_array_free(opt_input_paths, TRUE);
884 if (partial_error)
885 exit(EXIT_FAILURE);
886 else
887 exit(EXIT_SUCCESS);
888 }
889