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