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 _XOPEN_SOURCE 700
  22 #include <config.h>
  23 #include <babeltrace/babeltrace-internal.h>
  24 #include <babeltrace/format.h>
  25 #include <popt.h>
  26 #include <errno.h>
  27 #include <stdlib.h>
  28 #include <ctype.h>
  29 #include <sys/stat.h>
  30 #include <sys/types.h>
  31 #include <fcntl.h>
  32 #include <ftw.h>
  33 #include <dirent.h>
  34 #include <unistd.h>
  35
  36 #define DEFAULT_FILE_ARRAY_SIZE 1
  37 static char *opt_input_format;
  38 static char *opt_output_format;
  39
  40 static const char *opt_input_path;
  41 static const char *opt_output_path;
  42
  43 static struct trace_collection trace_collection_read;
  44 static struct format *fmt_read;
  45
  46 void strlower(char *str)
  47 {
  48         while (*str) {
  49                 *str = tolower(*str);
  50                 str++;
  51         }
  52 }
  53
  54 enum {
  55         OPT_NONE = 0,
  56         OPT_HELP,
  57         OPT_LIST,
  58         OPT_VERBOSE,
  59         OPT_DEBUG,
  60         OPT_NAMES,
  61 };
  62
  63 static struct poptOption long_options[] = {
  64         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  65         { "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
  66         { "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
  67         { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
  68         { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
  69         { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
  70         { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
  71         { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
  72         { NULL, 0, 0, NULL, 0, NULL, NULL },
  73 };
  74
  75 static void list_formats(FILE *fp)
  76 {
  77         fprintf(fp, "\n");
  78         bt_fprintf_format_list(fp);
  79 }
  80
  81 static void usage(FILE *fp)
  82 {
  83         fprintf(fp, "BabelTrace Trace Converter %s\n\n", VERSION);
  84         fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
  85         fprintf(fp, "\n");
  86         fprintf(fp, "  INPUT                          Input trace path\n");
  87         fprintf(fp, "  OUTPUT                         Output trace path (default: stdout)\n");
  88         fprintf(fp, "\n");
  89         fprintf(fp, "  -i, --input-format FORMAT      Input trace format (default: ctf)\n");
  90         fprintf(fp, "  -o, --output-format FORMAT     Output trace format (default: text)\n");
  91         fprintf(fp, "\n");
  92         fprintf(fp, "  -h, --help                     This help message\n");
  93         fprintf(fp, "  -l, --list                     List available formats\n");
  94         fprintf(fp, "  -v, --verbose                  Verbose mode\n");
  95         fprintf(fp, "                                 (or set BABELTRACE_VERBOSE environment variable)\n");
  96         fprintf(fp, "  -d, --debug                    Debug mode\n");
  97         fprintf(fp, "                                 (or set BABELTRACE_DEBUG environment variable)\n");
  98         fprintf(fp, "  -n, --names name1<,name2,...>  Print field names.\n");
  99         fprintf(fp, "                                 Available field names:\n");
 100         fprintf(fp, "                                     (payload OR args OR arg)\n");
 101         fprintf(fp, "                                     all, scope, header, (context OR ctx)\n");
 102         fprintf(fp, "                                     trace, trace:domain, trace:procname, trace:vpid\n");
 103         fprintf(fp, "                                        (payload active by default)\n");
 104         list_formats(fp);
 105         fprintf(fp, "\n");
 106 }
 107
 108 static int get_names_args(poptContext *pc)
 109 {
 110         char *str, *strlist, *strctx;
 111
 112         opt_payload_field_names = 0;
 113         strlist = (char *) poptGetOptArg(*pc);
 114         if (!strlist) {
 115                 return -EINVAL;
 116         }
 117         str = strtok_r(strlist, ",", &strctx);
 118         do {
 119                 if (!strcmp(str, "all"))
 120                         opt_all_field_names = 1;
 121                 else if (!strcmp(str, "scope"))
 122                         opt_scope_field_names = 1;
 123                 else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
 124                         opt_context_field_names = 1;
 125                 else if (!strcmp(str, "header"))
 126                         opt_header_field_names = 1;
 127                 else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
 128                         opt_payload_field_names = 1;
 129                 else if (!strcmp(str, "trace"))
 130                         opt_trace_name = 1;
 131                 else if (!strcmp(str, "trace:domain"))
 132                         opt_trace_domain = 1;
 133                 else if (!strcmp(str, "trace:procname"))
 134                         opt_trace_procname = 1;
 135                 else if (!strcmp(str, "trace:vpid"))
 136                         opt_trace_vpid = 1;
 137                 else {
 138                         fprintf(stdout, "[error] unknown field name type %s\n", str);
 139                         return -EINVAL;
 140                 }
 141         } while ((str = strtok_r(NULL, ",", &strctx)));
 142         return 0;
 143 }
 144
 145 /*
 146  * Return 0 if caller should continue, < 0 if caller should return
 147  * error, > 0 if caller should exit without reporting error.
 148  */
 149 static int parse_options(int argc, char **argv)
 150 {
 151         poptContext pc;
 152         int opt, ret = 0;
 153
 154         if (argc == 1) {
 155                 usage(stdout);
 156                 return 1;       /* exit cleanly */
 157         }
 158
 159         pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
 160         poptReadDefaultConfig(pc, 0);
 161
 162         /* set default */
 163         opt_payload_field_names = 1;
 164
 165         while ((opt = poptGetNextOpt(pc)) != -1) {
 166                 switch (opt) {
 167                 case OPT_HELP:
 168                         usage(stdout);
 169                         ret = 1;        /* exit cleanly */
 170                         goto end;
 171                 case OPT_LIST:
 172                         list_formats(stdout);
 173                         ret = 1;
 174                         goto end;
 175                 case OPT_VERBOSE:
 176                         babeltrace_verbose = 1;
 177                         break;
 178                 case OPT_NAMES:
 179                         if (get_names_args(&pc)) {
 180                                 ret = -EINVAL;
 181                                 goto end;
 182                         }
 183                         break;
 184                 case OPT_DEBUG:
 185                         babeltrace_debug = 1;
 186                         break;
 187                 default:
 188                         ret = -EINVAL;
 189                         goto end;
 190                 }
 191         }
 192
 193         opt_input_path = poptGetArg(pc);
 194         if (!opt_input_path) {
 195                 ret = -EINVAL;
 196                 goto end;
 197         }
 198         opt_output_path = poptGetArg(pc);
 199
 200 end:
 201         if (pc) {
 202                 poptFreeContext(pc);
 203         }
 204         return ret;
 205 }
 206
 207 static void init_trace_collection(struct trace_collection *tc)
 208 {
 209         tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
 210 }
 211
 212 /*
 213  * finalize_trace_collection() closes the opened traces for read
 214  * and free the memory allocated for trace collection
 215  */
 216 static void finalize_trace_collection(struct trace_collection *tc)
 217 {
 218         int i;
 219
 220         for (i = 0; i < tc->array->len; i++) {
 221                 struct trace_descriptor *temp =
 222                         g_ptr_array_index(tc->array, i);
 223                 fmt_read->close_trace(temp);
 224         }
 225         g_ptr_array_free(tc->array, TRUE);
 226 }
 227
 228 static void trace_collection_add(struct trace_collection *tc,
 229                                  struct trace_descriptor *td)
 230 {
 231         g_ptr_array_add(tc->array, td);
 232 }
 233
 234 /*
 235  * traverse_dir() is the callback functiion for File Tree Walk (nftw).
 236  * it receives the path of the current entry (file, dir, link..etc) with
 237  * a flag to indicate the type of the entry.
 238  * if the entry being visited is a directory and contains a metadata file,
 239  * then open it for reading and save a trace_descriptor to that directory
 240  * in the read trace collection.
 241  */
 242 static int traverse_dir(const char *fpath, const struct stat *sb,
 243                         int tflag, struct FTW *ftwbuf)
 244 {
 245         int dirfd;
 246         int fd;
 247         struct trace_descriptor *td_read;
 248
 249         if (tflag != FTW_D)
 250                 return 0;
 251         dirfd = open(fpath, 0);
 252         if (dirfd < 0) {
 253                 fprintf(stdout, "[error] unable to open trace "
 254                         "directory file descriptor.\n");
 255                 return -1;
 256         }
 257         fd = openat(dirfd, "metadata", O_RDONLY);
 258         if (fd < 0) {
 259                 close(dirfd);
 260         } else {
 261                 close(fd);
 262                 close(dirfd);
 263                 td_read = fmt_read->open_trace(opt_input_path,
 264                                 fpath, O_RDONLY, ctf_move_pos_slow,
 265                                 NULL);
 266                 if (!td_read) {
 267                         fprintf(stdout, "Error opening trace \"%s\" "
 268                                         "for reading.\n\n", fpath);
 269                         return -1;      /* error */
 270                 }
 271                 trace_collection_add(&trace_collection_read, td_read);
 272         }
 273         return 0;       /* success */
 274 }
 275
 276 int main(int argc, char **argv)
 277 {
 278         int ret;
 279         struct format *fmt_write;
 280         struct trace_descriptor *td_write;
 281
 282         ret = parse_options(argc, argv);
 283         if (ret < 0) {
 284                 fprintf(stdout, "Error parsing options.\n\n");
 285                 usage(stdout);
 286                 exit(EXIT_FAILURE);
 287         } else if (ret > 0) {
 288                 exit(EXIT_SUCCESS);
 289         }
 290         printf_verbose("Verbose mode active.\n");
 291         printf_debug("Debug mode active.\n");
 292
 293         if (opt_input_format)
 294                 strlower(opt_input_format);
 295         if (opt_output_format)
 296                 strlower(opt_output_format);
 297
 298         printf_verbose("Converting from directory: %s\n", opt_input_path);
 299         printf_verbose("Converting from format: %s\n",
 300                 opt_input_format ? : "ctf <default>");
 301         printf_verbose("Converting to directory: %s\n",
 302                 opt_output_path ? : "<stdout>");
 303         printf_verbose("Converting to format: %s\n",
 304                 opt_output_format ? : "text <default>");
 305
 306         if (!opt_input_format)
 307                 opt_input_format = "ctf";
 308         if (!opt_output_format)
 309                 opt_output_format = "text";
 310         fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
 311         if (!fmt_read) {
 312                 fprintf(stdout, "[error] Format \"%s\" is not supported.\n\n",
 313                         opt_input_format);
 314                 exit(EXIT_FAILURE);
 315         }
 316         fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
 317         if (!fmt_write) {
 318                 fprintf(stdout, "[error] format \"%s\" is not supported.\n\n",
 319                         opt_output_format);
 320                 exit(EXIT_FAILURE);
 321         }
 322
 323         /*
 324          * pass the input path to nftw() .
 325          * specify traverse_dir() as the callback function.
 326          * depth = 10 which is the max number of file descriptors
 327          * that nftw() can open at a given time.
 328          * flags = 0  check nftw documentation for more info .
 329          */
 330         init_trace_collection(&trace_collection_read);
 331         ret = nftw(opt_input_path, traverse_dir, 10, 0);
 332         if (ret != 0) {
 333                 fprintf(stdout, "[error] opening trace \"%s\" for reading.\n\n",
 334                         opt_input_path);
 335                 goto error_td_read;
 336         }
 337         if (trace_collection_read.array->len == 0) {
 338                 fprintf(stdout, "[warning] no metadata file was found."
 339                                                 " no output was generated\n");
 340                 return 0;
 341         }
 342
 343         td_write = fmt_write->open_trace(NULL, opt_output_path, O_RDWR, NULL, NULL);
 344         if (!td_write) {
 345                 fprintf(stdout, "Error opening trace \"%s\" for writing.\n\n",
 346                         opt_output_path ? : "<none>");
 347                 goto error_td_write;
 348         }
 349
 350         ret = convert_trace(td_write, &trace_collection_read);
 351         if (ret) {
 352                 fprintf(stdout, "Error printing trace.\n\n");
 353                 goto error_copy_trace;
 354         }
 355
 356         fmt_write->close_trace(td_write);
 357         finalize_trace_collection(&trace_collection_read);
 358         printf_verbose("finished converting. Output written to:\n%s\n",
 359                         opt_output_path ? : "<stdout>");
 360         exit(EXIT_SUCCESS);
 361
 362         /* Error handling */
 363 error_copy_trace:
 364         fmt_write->close_trace(td_write);
 365 error_td_write:
 366         finalize_trace_collection(&trace_collection_read);
 367 error_td_read:
 368         exit(EXIT_FAILURE);
 369 }