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