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 <fts.h>
  43
  44 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
  45
  46 #define DEFAULT_FILE_ARRAY_SIZE 1
  47 static char *opt_input_format;
  48 static char *opt_output_format;
  49
  50 static const char *opt_input_path;
  51 static const char *opt_output_path;
  52
  53 static struct format *fmt_read;
  54
  55 void strlower(char *str)
  56 {
  57         while (*str) {
  58                 *str = tolower(*str);
  59                 str++;
  60         }
  61 }
  62
  63 enum {
  64         OPT_NONE = 0,
  65         OPT_HELP,
  66         OPT_LIST,
  67         OPT_VERBOSE,
  68         OPT_DEBUG,
  69         OPT_NAMES,
  70         OPT_FIELDS,
  71         OPT_NO_DELTA,
  72         OPT_CLOCK_OFFSET,
  73         OPT_CLOCK_RAW,
  74         OPT_CLOCK_SECONDS,
  75         OPT_CLOCK_DATE,
  76         OPT_CLOCK_GMT,
  77         OPT_CLOCK_FORCE_CORRELATE,
  78 };
  79
  80 static struct poptOption long_options[] = {
  81         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  82         { "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
  83         { "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
  84         { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
  85         { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
  86         { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
  87         { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
  88         { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
  89         { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
  90         { "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
  91         { "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
  92         { "clock-raw", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_RAW, NULL, NULL },
  93         { "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
  94         { "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
  95         { "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
  96         { "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
  97         { NULL, 0, 0, NULL, 0, NULL, NULL },
  98 };
  99
 100 static void list_formats(FILE *fp)
 101 {
 102         fprintf(fp, "\n");
 103         bt_fprintf_format_list(fp);
 104 }
 105
 106 static void usage(FILE *fp)
 107 {
 108         fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
 109         fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
 110         fprintf(fp, "\n");
 111         fprintf(fp, "  INPUT                          Input trace path\n");
 112         fprintf(fp, "  OUTPUT                         Output trace path (default: stdout)\n");
 113         fprintf(fp, "\n");
 114         fprintf(fp, "  -i, --input-format FORMAT      Input trace format (default: ctf)\n");
 115         fprintf(fp, "  -o, --output-format FORMAT     Output trace format (default: text)\n");
 116         fprintf(fp, "\n");
 117         fprintf(fp, "  -h, --help                     This help message\n");
 118         fprintf(fp, "  -l, --list                     List available formats\n");
 119         fprintf(fp, "  -v, --verbose                  Verbose mode\n");
 120         fprintf(fp, "                                 (or set BABELTRACE_VERBOSE environment variable)\n");
 121         fprintf(fp, "  -d, --debug                    Debug mode\n");
 122         fprintf(fp, "                                 (or set BABELTRACE_DEBUG environment variable)\n");
 123         fprintf(fp, "      --no-delta                 Do not print time delta between consecutive events\n");
 124         fprintf(fp, "  -n, --names name1<,name2,...>  Print field names:\n");
 125         fprintf(fp, "                                     (payload OR args OR arg)\n");
 126         fprintf(fp, "                                     none, all, scope, header, (context OR ctx)\n");
 127         fprintf(fp, "                                        (default: payload,context)\n");
 128         fprintf(fp, "  -f, --fields name1<,name2,...> Print additional fields:\n");
 129         fprintf(fp, "                                     all, trace, trace:domain, trace:procname,\n");
 130         fprintf(fp, "                                     trace:vpid, loglevel.\n");
 131         fprintf(fp, "      --clock-raw                Disregard internal clock offset (use raw value)\n");
 132         fprintf(fp, "      --clock-offset seconds     Clock offset in seconds\n");
 133         fprintf(fp, "      --clock-seconds            Print the timestamps as [sec.ns]\n");
 134         fprintf(fp, "                                 (default is: [hh:mm:ss.ns])\n");
 135         fprintf(fp, "      --clock-date               Print clock date\n");
 136         fprintf(fp, "      --clock-gmt                Print clock in GMT time zone (default: local time zone)\n");
 137         fprintf(fp, "      --clock-force-correlate    Assume that clocks are inherently correlated\n");
 138         fprintf(fp, "                                 across traces.\n");
 139         list_formats(fp);
 140         fprintf(fp, "\n");
 141 }
 142
 143 static int get_names_args(poptContext *pc)
 144 {
 145         char *str, *strlist, *strctx;
 146
 147         opt_payload_field_names = 0;
 148         opt_context_field_names = 0;
 149         strlist = (char *) poptGetOptArg(*pc);
 150         if (!strlist) {
 151                 return -EINVAL;
 152         }
 153         str = strtok_r(strlist, ",", &strctx);
 154         do {
 155                 if (!strcmp(str, "all"))
 156                         opt_all_field_names = 1;
 157                 else if (!strcmp(str, "scope"))
 158                         opt_scope_field_names = 1;
 159                 else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
 160                         opt_context_field_names = 1;
 161                 else if (!strcmp(str, "header"))
 162                         opt_header_field_names = 1;
 163                 else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
 164                         opt_payload_field_names = 1;
 165                 else if (!strcmp(str, "none")) {
 166                         opt_all_field_names = 0;
 167                         opt_scope_field_names = 0;
 168                         opt_context_field_names = 0;
 169                         opt_header_field_names = 0;
 170                         opt_payload_field_names = 0;
 171                 } else {
 172                         fprintf(stderr, "[error] unknown field name type %s\n", str);
 173                         return -EINVAL;
 174                 }
 175         } while ((str = strtok_r(NULL, ",", &strctx)));
 176         return 0;
 177 }
 178
 179 static int get_fields_args(poptContext *pc)
 180 {
 181         char *str, *strlist, *strctx;
 182
 183         strlist = (char *) poptGetOptArg(*pc);
 184         if (!strlist) {
 185                 return -EINVAL;
 186         }
 187         str = strtok_r(strlist, ",", &strctx);
 188         do {
 189                 if (!strcmp(str, "all"))
 190                         opt_all_fields = 1;
 191                 else if (!strcmp(str, "trace"))
 192                         opt_trace_field = 1;
 193                 else if (!strcmp(str, "trace:domain"))
 194                         opt_trace_domain_field = 1;
 195                 else if (!strcmp(str, "trace:procname"))
 196                         opt_trace_procname_field = 1;
 197                 else if (!strcmp(str, "trace:vpid"))
 198                         opt_trace_vpid_field = 1;
 199                 else if (!strcmp(str, "loglevel"))
 200                         opt_loglevel_field = 1;
 201                 else {
 202                         fprintf(stderr, "[error] unknown field type %s\n", str);
 203                         return -EINVAL;
 204                 }
 205         } while ((str = strtok_r(NULL, ",", &strctx)));
 206         return 0;
 207 }
 208
 209 /*
 210  * Return 0 if caller should continue, < 0 if caller should return
 211  * error, > 0 if caller should exit without reporting error.
 212  */
 213 static int parse_options(int argc, char **argv)
 214 {
 215         poptContext pc;
 216         int opt, ret = 0;
 217
 218         if (argc == 1) {
 219                 usage(stdout);
 220                 return 1;       /* exit cleanly */
 221         }
 222
 223         pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
 224         poptReadDefaultConfig(pc, 0);
 225
 226         /* set default */
 227         opt_context_field_names = 1;
 228         opt_payload_field_names = 1;
 229
 230         while ((opt = poptGetNextOpt(pc)) != -1) {
 231                 switch (opt) {
 232                 case OPT_HELP:
 233                         usage(stdout);
 234                         ret = 1;        /* exit cleanly */
 235                         goto end;
 236                 case OPT_LIST:
 237                         list_formats(stdout);
 238                         ret = 1;
 239                         goto end;
 240                 case OPT_VERBOSE:
 241                         babeltrace_verbose = 1;
 242                         break;
 243                 case OPT_NAMES:
 244                         if (get_names_args(&pc)) {
 245                                 ret = -EINVAL;
 246                                 goto end;
 247                         }
 248                         break;
 249                 case OPT_FIELDS:
 250                         if (get_fields_args(&pc)) {
 251                                 ret = -EINVAL;
 252                                 goto end;
 253                         }
 254                         break;
 255                 case OPT_DEBUG:
 256                         babeltrace_debug = 1;
 257                         break;
 258                 case OPT_NO_DELTA:
 259                         opt_delta_field = 0;
 260                         break;
 261                 case OPT_CLOCK_RAW:
 262                         opt_clock_raw = 1;
 263                         break;
 264                 case OPT_CLOCK_OFFSET:
 265                 {
 266                         char *str, *endptr;
 267
 268                         str = poptGetOptArg(pc);
 269                         if (!str) {
 270                                 fprintf(stderr, "[error] Missing --clock-offset argument\n");
 271                                 ret = -EINVAL;
 272                                 goto end;
 273                         }
 274                         errno = 0;
 275                         opt_clock_offset = strtoull(str, &endptr, 0);
 276                         if (*endptr != '\0' || str == endptr || errno != 0) {
 277                                 fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
 278                                 ret = -EINVAL;
 279                                 goto end;
 280                         }
 281                         break;
 282                 }
 283                 case OPT_CLOCK_SECONDS:
 284                         opt_clock_seconds = 1;
 285                         break;
 286                 case OPT_CLOCK_DATE:
 287                         opt_clock_date = 1;
 288                         break;
 289                 case OPT_CLOCK_GMT:
 290                         opt_clock_gmt = 1;
 291                         break;
 292                 case OPT_CLOCK_FORCE_CORRELATE:
 293                         opt_clock_force_correlate = 1;
 294                         break;
 295
 296                 default:
 297                         ret = -EINVAL;
 298                         goto end;
 299                 }
 300         }
 301
 302         opt_input_path = poptGetArg(pc);
 303         if (!opt_input_path) {
 304                 ret = -EINVAL;
 305                 goto end;
 306         }
 307         opt_output_path = poptGetArg(pc);
 308
 309 end:
 310         if (pc) {
 311                 poptFreeContext(pc);
 312         }
 313         return ret;
 314 }
 315
 316
 317 /*
 318  * bt_context_add_traces_recursive: Open a trace recursively
 319  *
 320  * Find each trace present in the subdirectory starting from the given
 321  * path, and add them to the context. The packet_seek parameter can be
 322  * NULL: this specify to use the default format packet_seek.
 323  *
 324  * Return: 0 on success, nonzero on failure.
 325  * Unable to open toplevel: failure.
 326  * Unable to open some subdirectory or file: warn and continue;
 327  */
 328 int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
 329                 const char *format_str,
 330                 void (*packet_seek)(struct stream_pos *pos,
 331                         size_t offset, int whence))
 332 {
 333         FTS *tree;
 334         FTSENT *node;
 335         GArray *trace_ids;
 336         char lpath[PATH_MAX];
 337         char * const paths[2] = { lpath, NULL };
 338         int ret = -1;
 339
 340         /*
 341          * Need to copy path, because fts_open can change it.
 342          * It is the pointer array, not the strings, that are constant.
 343          */
 344         strncpy(lpath, path, PATH_MAX);
 345         lpath[PATH_MAX - 1] = '\0';
 346
 347         tree = fts_open(paths, FTS_NOCHDIR | FTS_LOGICAL, 0);
 348         if (tree == NULL) {
 349                 fprintf(stderr, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
 350                                 path);
 351                 return -EINVAL;
 352         }
 353
 354         trace_ids = g_array_new(FALSE, TRUE, sizeof(int));
 355
 356         while ((node = fts_read(tree))) {
 357                 int dirfd, metafd;
 358                 int closeret;
 359
 360                 if (!(node->fts_info & FTS_D))
 361                         continue;
 362
 363                 dirfd = open(node->fts_accpath, 0);
 364                 if (dirfd < 0) {
 365                         fprintf(stderr, "[error] [Context] Unable to open trace "
 366                                 "directory file descriptor.\n");
 367                         ret = dirfd;
 368                         goto error;
 369                 }
 370                 metafd = openat(dirfd, "metadata", O_RDONLY);
 371                 if (metafd < 0) {
 372                         closeret = close(dirfd);
 373                         if (closeret < 0) {
 374                                 perror("close");
 375                                 goto error;
 376                         }
 377                         ret = -1;
 378                         continue;
 379                 } else {
 380                         int trace_id;
 381
 382                         ret = close(metafd);
 383                         if (ret < 0) {
 384                                 perror("close");
 385                                 goto error;
 386                         }
 387                         ret = close(dirfd);
 388                         if (ret < 0) {
 389                                 perror("close");
 390                                 goto error;
 391                         }
 392
 393                         trace_id = bt_context_add_trace(ctx,
 394                                 node->fts_accpath, format_str,
 395                                 packet_seek, NULL, NULL);
 396                         if (trace_id < 0) {
 397                                 fprintf(stderr, "[warning] [Context] opening trace \"%s\" from %s "
 398                                         "for reading.\n", node->fts_accpath, path);
 399                                 /* Allow to skip erroneous traces. */
 400                                 continue;
 401                         }
 402                         g_array_append_val(trace_ids, trace_id);
 403                 }
 404         }
 405
 406 error:
 407         /*
 408          * Return an error if no trace can be opened.
 409          */
 410         if (ret == 0 && trace_ids->len == 0) {
 411                 fprintf(stderr, "[error] Cannot open any trace for reading.\n\n");
 412                 ret = -ENOENT;
 413         }
 414         g_array_free(trace_ids, TRUE);
 415         return ret;
 416 }
 417
 418
 419
 420 int convert_trace(struct trace_descriptor *td_write,
 421                   struct bt_context *ctx)
 422 {
 423         struct bt_ctf_iter *iter;
 424         struct ctf_text_stream_pos *sout;
 425         struct bt_iter_pos begin_pos;
 426         struct bt_ctf_event *ctf_event;
 427         int ret;
 428
 429         sout = container_of(td_write, struct ctf_text_stream_pos,
 430                         trace_descriptor);
 431
 432         begin_pos.type = BT_SEEK_BEGIN;
 433         iter = bt_ctf_iter_create(ctx, &begin_pos, NULL);
 434         if (!iter) {
 435                 ret = -1;
 436                 goto error_iter;
 437         }
 438         while ((ctf_event = bt_ctf_iter_read_event(iter))) {
 439                 ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream);
 440                 if (ret) {
 441                         fprintf(stderr, "[error] Writing event failed.\n");
 442                         goto end;
 443                 }
 444                 ret = bt_iter_next(bt_ctf_get_iter(iter));
 445                 if (ret < 0)
 446                         goto end;
 447         }
 448         ret = 0;
 449
 450 end:
 451         bt_ctf_iter_destroy(iter);
 452 error_iter:
 453         return ret;
 454 }
 455
 456 int main(int argc, char **argv)
 457 {
 458         int ret;
 459         struct format *fmt_write;
 460         struct trace_descriptor *td_write;
 461         struct bt_context *ctx;
 462
 463         ret = parse_options(argc, argv);
 464         if (ret < 0) {
 465                 fprintf(stderr, "Error parsing options.\n\n");
 466                 usage(stderr);
 467                 exit(EXIT_FAILURE);
 468         } else if (ret > 0) {
 469                 exit(EXIT_SUCCESS);
 470         }
 471         printf_verbose("Verbose mode active.\n");
 472         printf_debug("Debug mode active.\n");
 473
 474         if (opt_input_format)
 475                 strlower(opt_input_format);
 476         if (opt_output_format)
 477                 strlower(opt_output_format);
 478
 479         printf_verbose("Converting from directory: %s\n", opt_input_path);
 480         printf_verbose("Converting from format: %s\n",
 481                 opt_input_format ? : "ctf <default>");
 482         printf_verbose("Converting to directory: %s\n",
 483                 opt_output_path ? : "<stdout>");
 484         printf_verbose("Converting to format: %s\n",
 485                 opt_output_format ? : "text <default>");
 486
 487         if (!opt_input_format)
 488                 opt_input_format = "ctf";
 489         if (!opt_output_format)
 490                 opt_output_format = "text";
 491         fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
 492         if (!fmt_read) {
 493                 fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
 494                         opt_input_format);
 495                 exit(EXIT_FAILURE);
 496         }
 497         fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
 498         if (!fmt_write) {
 499                 fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
 500                         opt_output_format);
 501                 exit(EXIT_FAILURE);
 502         }
 503
 504         ctx = bt_context_create();
 505
 506         ret = bt_context_add_traces_recursive(ctx, opt_input_path,
 507                         opt_input_format, NULL);
 508         if (ret) {
 509                 fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
 510                         opt_input_path);
 511                 goto error_td_read;
 512         }
 513
 514         td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
 515         if (!td_write) {
 516                 fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
 517                         opt_output_path ? : "<none>");
 518                 goto error_td_write;
 519         }
 520
 521         ret = convert_trace(td_write, ctx);
 522         if (ret) {
 523                 fprintf(stderr, "Error printing trace.\n\n");
 524                 goto error_copy_trace;
 525         }
 526
 527         fmt_write->close_trace(td_write);
 528
 529         bt_context_put(ctx);
 530         printf_verbose("finished converting. Output written to:\n%s\n",
 531                         opt_output_path ? : "<stdout>");
 532         exit(EXIT_SUCCESS);
 533
 534         /* Error handling */
 535 error_copy_trace:
 536         fmt_write->close_trace(td_write);
 537 error_td_write:
 538         bt_context_put(ctx);
 539 error_td_read:
 540         exit(EXIT_FAILURE);
 541 }