*
* Babeltrace Trace Converter
*
- * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
+ *
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* all copies or substantial portions of the Software.
*/
+#define _XOPEN_SOURCE 700
+#include <config.h>
#include <babeltrace/babeltrace.h>
#include <babeltrace/format.h>
+#include <babeltrace/context.h>
+#include <babeltrace/ctf/types.h>
+#include <abeltrace/ctf-text/types.h>
+#include <babeltrace/iterator.h>
#include <popt.h>
#include <errno.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <fcntl.h>
+#include <ftw.h>
+#include <dirent.h>
+#include <unistd.h>
+#include <inttypes.h>
+
+#include <babeltrace/ctf-ir/metadata.h> /* for clocks */
+#define DEFAULT_FILE_ARRAY_SIZE 1
static char *opt_input_format;
static char *opt_output_format;
static const char *opt_input_path;
static const char *opt_output_path;
-int babeltrace_verbose, babeltrace_debug;
+static struct trace_collection trace_collection_read;
+static struct format *fmt_read;
void strlower(char *str)
{
OPT_LIST,
OPT_VERBOSE,
OPT_DEBUG,
+ OPT_NAMES,
+ OPT_FIELDS,
+ OPT_NO_DELTA,
+ OPT_CLOCK_OFFSET,
+ OPT_CLOCK_RAW,
+ OPT_CLOCK_SECONDS,
+ OPT_CLOCK_DATE,
+ OPT_CLOCK_GMT,
};
static struct poptOption long_options[] = {
{ "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
{ "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
{ "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
+ { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
+ { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
+ { "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
+ { "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
+ { "clock-raw", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_RAW, NULL, NULL },
+ { "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
+ { "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
+ { "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
{ NULL, 0, 0, NULL, 0, NULL, NULL },
};
static void usage(FILE *fp)
{
- fprintf(fp, "Babeltrace %u.%u\n\n", BABELTRACE_VERSION_MAJOR,
- BABELTRACE_VERSION_MINOR);
- fprintf(fp, "usage : babeltrace [OPTIONS] INPUT OUTPUT\n");
+ fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
+ fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
fprintf(fp, "\n");
- fprintf(fp, " INPUT Input trace path\n");
- fprintf(fp, " OUTPUT Output trace path\n");
+ fprintf(fp, " INPUT Input trace path\n");
+ fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
fprintf(fp, "\n");
- fprintf(fp, " -i, --input-format Input trace path\n");
- fprintf(fp, " -o, --output-format Input trace path\n");
+ fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
+ fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
fprintf(fp, "\n");
- fprintf(fp, " -h, --help This help message\n");
- fprintf(fp, " -l, --list List available formats\n");
- fprintf(fp, " -v, --verbose Verbose mode\n");
- fprintf(fp, " -d, --debug Debug mode\n");
+ fprintf(fp, " -h, --help This help message\n");
+ fprintf(fp, " -l, --list List available formats\n");
+ fprintf(fp, " -v, --verbose Verbose mode\n");
+ fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n");
+ fprintf(fp, " -d, --debug Debug mode\n");
+ fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n");
+ fprintf(fp, " --no-delta Do not print time delta between consecutive events\n");
+ fprintf(fp, " -n, --names name1<,name2,...> Print field names:\n");
+ fprintf(fp, " (payload OR args OR arg)\n");
+ fprintf(fp, " all, scope, header, (context OR ctx)\n");
+ fprintf(fp, " (payload active by default)\n");
+ fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n");
+ fprintf(fp, " all, trace, trace:domain, trace:procname,\n");
+ fprintf(fp, " trace:vpid, loglevel.\n");
+ fprintf(fp, " --clock-raw Disregard internal clock offset (use raw value)\n");
+ fprintf(fp, " --clock-offset seconds Clock offset in seconds\n");
+ fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n");
+ fprintf(fp, " (default is: [hh:mm:ss.ns])\n");
+ fprintf(fp, " --clock-date Print clock date\n");
+ fprintf(fp, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n");
list_formats(fp);
fprintf(fp, "\n");
}
+static int get_names_args(poptContext *pc)
+{
+ char *str, *strlist, *strctx;
+
+ opt_payload_field_names = 0;
+ strlist = (char *) poptGetOptArg(*pc);
+ if (!strlist) {
+ return -EINVAL;
+ }
+ str = strtok_r(strlist, ",", &strctx);
+ do {
+ if (!strcmp(str, "all"))
+ opt_all_field_names = 1;
+ else if (!strcmp(str, "scope"))
+ opt_scope_field_names = 1;
+ else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
+ opt_context_field_names = 1;
+ else if (!strcmp(str, "header"))
+ opt_header_field_names = 1;
+ else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
+ opt_payload_field_names = 1;
+ else {
+ fprintf(stderr, "[error] unknown field name type %s\n", str);
+ return -EINVAL;
+ }
+ } while ((str = strtok_r(NULL, ",", &strctx)));
+ return 0;
+}
+
+static int get_fields_args(poptContext *pc)
+{
+ char *str, *strlist, *strctx;
+
+ strlist = (char *) poptGetOptArg(*pc);
+ if (!strlist) {
+ return -EINVAL;
+ }
+ str = strtok_r(strlist, ",", &strctx);
+ do {
+ if (!strcmp(str, "all"))
+ opt_all_fields = 1;
+ else if (!strcmp(str, "trace"))
+ opt_trace_field = 1;
+ else if (!strcmp(str, "trace:domain"))
+ opt_trace_domain_field = 1;
+ else if (!strcmp(str, "trace:procname"))
+ opt_trace_procname_field = 1;
+ else if (!strcmp(str, "trace:vpid"))
+ opt_trace_vpid_field = 1;
+ else if (!strcmp(str, "loglevel"))
+ opt_loglevel_field = 1;
+ else {
+ fprintf(stderr, "[error] unknown field type %s\n", str);
+ return -EINVAL;
+ }
+ } while ((str = strtok_r(NULL, ",", &strctx)));
+ return 0;
+}
+
/*
* Return 0 if caller should continue, < 0 if caller should return
* error, > 0 if caller should exit without reporting error.
poptContext pc;
int opt, ret = 0;
+ if (argc == 1) {
+ usage(stdout);
+ return 1; /* exit cleanly */
+ }
+
pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
poptReadDefaultConfig(pc, 0);
+ /* set default */
+ opt_payload_field_names = 1;
+
while ((opt = poptGetNextOpt(pc)) != -1) {
switch (opt) {
case OPT_HELP:
case OPT_VERBOSE:
babeltrace_verbose = 1;
break;
+ case OPT_NAMES:
+ if (get_names_args(&pc)) {
+ ret = -EINVAL;
+ goto end;
+ }
+ break;
+ case OPT_FIELDS:
+ if (get_fields_args(&pc)) {
+ ret = -EINVAL;
+ goto end;
+ }
+ break;
case OPT_DEBUG:
babeltrace_debug = 1;
break;
+ case OPT_NO_DELTA:
+ opt_delta_field = 0;
+ break;
+ case OPT_CLOCK_RAW:
+ opt_clock_raw = 1;
+ break;
+ case OPT_CLOCK_OFFSET:
+ {
+ char *str, *endptr;
+
+ str = poptGetOptArg(pc);
+ if (!str) {
+ fprintf(stderr, "[error] Missing --clock-offset argument\n");
+ ret = -EINVAL;
+ goto end;
+ }
+ errno = 0;
+ opt_clock_offset = strtoull(str, &endptr, 0);
+ if (*endptr != '\0' || str == endptr || errno != 0) {
+ fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
+ ret = -EINVAL;
+ goto end;
+ }
+ break;
+ }
+ case OPT_CLOCK_SECONDS:
+ opt_clock_seconds = 1;
+ break;
+ case OPT_CLOCK_DATE:
+ opt_clock_date = 1;
+ break;
+ case OPT_CLOCK_GMT:
+ opt_clock_gmt = 1;
+ break;
+
default:
ret = -EINVAL;
goto end;
goto end;
}
opt_output_path = poptGetArg(pc);
- if (!opt_output_path) {
- ret = -EINVAL;
- goto end;
- }
+
end:
if (pc) {
poptFreeContext(pc);
return ret;
}
+static void init_trace_collection(struct trace_collection *tc)
+{
+ tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
+ tc->clocks = g_hash_table_new(g_direct_hash, g_direct_equal);
+ tc->single_clock_offset_avg = 0;
+ tc->offset_first = 0;
+ tc->delta_offset_first_sum = 0;
+ tc->offset_nr = 0;
+}
+
+/*
+ * finalize_trace_collection() closes the opened traces for read
+ * and free the memory allocated for trace collection
+ */
+static void finalize_trace_collection(struct trace_collection *tc)
+{
+ int i;
+
+ for (i = 0; i < tc->array->len; i++) {
+ struct trace_descriptor *temp =
+ g_ptr_array_index(tc->array, i);
+ fmt_read->close_trace(temp);
+ }
+ g_ptr_array_free(tc->array, TRUE);
+ g_hash_table_destroy(tc->clocks);
+}
+
+struct clock_match {
+ GHashTable *clocks;
+ struct ctf_clock *clock_match;
+ struct trace_collection *tc;
+};
+
+static void check_clock_match(gpointer key, gpointer value, gpointer user_data)
+{
+ struct clock_match *match = user_data;
+ struct ctf_clock *clock_a = value, *clock_b;
+
+ if (clock_a->uuid != 0) {
+ /*
+ * Lookup the the trace clocks into the collection
+ * clocks.
+ */
+ clock_b = g_hash_table_lookup(match->clocks,
+ (gpointer) (unsigned long) clock_a->uuid);
+ if (clock_b) {
+ match->clock_match = clock_b;
+ return;
+ }
+ } else if (clock_a->absolute) {
+ /*
+ * Absolute time references, such as NTP, are looked up
+ * by clock name.
+ */
+ clock_b = g_hash_table_lookup(match->clocks,
+ (gpointer) (unsigned long) clock_a->name);
+ if (clock_b) {
+ match->clock_match = clock_b;
+ return;
+ }
+ }
+}
+
+static void clock_add(gpointer key, gpointer value, gpointer user_data)
+{
+ struct clock_match *clock_match = user_data;
+ GHashTable *tc_clocks = clock_match->clocks;
+ struct ctf_clock *t_clock = value;
+ GQuark v;
+
+ if (t_clock->absolute)
+ v = t_clock->name;
+ else
+ v = t_clock->uuid;
+ if (v) {
+ struct ctf_clock *tc_clock;
+
+ tc_clock = g_hash_table_lookup(tc_clocks,
+ (gpointer) (unsigned long) v);
+ if (!tc_clock) {
+ /*
+ * For now, we only support CTF that has one
+ * single clock uuid or name (absolute ref).
+ */
+ if (g_hash_table_size(tc_clocks) > 0) {
+ fprintf(stderr, "[error] Only CTF traces with a single clock description are supported by this babeltrace version.\n");
+ }
+ if (!clock_match->tc->offset_nr) {
+ clock_match->tc->offset_first =
+ (t_clock->offset_s * 1000000000ULL) + t_clock->offset;
+ clock_match->tc->delta_offset_first_sum = 0;
+ clock_match->tc->offset_nr++;
+ clock_match->tc->single_clock_offset_avg =
+ clock_match->tc->offset_first;
+ }
+ g_hash_table_insert(tc_clocks,
+ (gpointer) (unsigned long) v,
+ value);
+ } else {
+ int64_t diff_ns;
+
+ /*
+ * Check that the offsets match. If not, warn
+ * the user that we do an arbitrary choice.
+ */
+ diff_ns = tc_clock->offset_s;
+ diff_ns -= t_clock->offset_s;
+ diff_ns *= 1000000000ULL;
+ diff_ns += tc_clock->offset;
+ diff_ns -= t_clock->offset;
+ printf_debug("Clock \"%s\" offset between traces has a delta of %" PRIu64 " ns.",
+ g_quark_to_string(tc_clock->name),
+ diff_ns < 0 ? -diff_ns : diff_ns);
+ if (diff_ns > 10000) {
+ fprintf(stderr, "[warning] Clock \"%s\" offset differs between traces (delta %" PRIu64 " ns). Using average.\n",
+ g_quark_to_string(tc_clock->name),
+ diff_ns < 0 ? -diff_ns : diff_ns);
+ }
+ /* Compute average */
+ clock_match->tc->delta_offset_first_sum +=
+ (t_clock->offset_s * 1000000000ULL) + t_clock->offset
+ - clock_match->tc->offset_first;
+ clock_match->tc->offset_nr++;
+ clock_match->tc->single_clock_offset_avg =
+ clock_match->tc->offset_first
+ + (clock_match->tc->delta_offset_first_sum / clock_match->tc->offset_nr);
+ }
+ }
+}
+
+/*
+ * Whenever we add a trace to the trace collection, check that we can
+ * correlate this trace with at least one other clock in the trace.
+ */
+static int trace_collection_add(struct trace_collection *tc,
+ struct trace_descriptor *td)
+{
+ struct ctf_trace *trace = container_of(td, struct ctf_trace, parent);
+
+ g_ptr_array_add(tc->array, td);
+ trace->collection = tc;
+
+ if (tc->array->len > 1) {
+ struct clock_match clock_match = {
+ .clocks = tc->clocks,
+ .clock_match = NULL,
+ .tc = NULL,
+ };
+
+ /*
+ * With two or more traces, we need correlation info
+ * avalable.
+ */
+ g_hash_table_foreach(trace->clocks,
+ check_clock_match,
+ &clock_match);
+ if (!clock_match.clock_match) {
+ fprintf(stderr, "[error] No clocks can be correlated and multiple traces are added to the collection.\n");
+ goto error;
+ }
+ }
+
+ {
+ struct clock_match clock_match = {
+ .clocks = tc->clocks,
+ .clock_match = NULL,
+ .tc = tc,
+ };
+
+ /*
+ * Add each clock from the trace clocks into the trace
+ * collection clocks.
+ */
+ g_hash_table_foreach(trace->clocks,
+ clock_add,
+ &clock_match);
+ }
+ return 0;
+error:
+ return -EPERM;
+}
+
+int convert_trace(struct trace_descriptor *td_write,
+ struct bt_context *ctx)
+{
+ struct bt_iter *iter;
+ struct ctf_stream *stream;
+ struct ctf_stream_event *event;
+ struct ctf_text_stream_pos *sout;
+ struct bt_iter_pos begin_pos;
+ int ret;
+
+ sout = container_of(td_write, struct ctf_text_stream_pos,
+ trace_descriptor);
+
+ begin_pos.type = BT_SEEK_BEGIN;
+ iter = bt_iter_create(ctx, &begin_pos, NULL);
+ if (!iter) {
+ ret = -1;
+ goto error_iter;
+ }
+ while (bt_iter_read_event(iter, &stream, &event) == 0) {
+ ret = sout->parent.event_cb(&sout->parent, stream);
+ if (ret) {
+ fprintf(stderr, "[error] Writing event failed.\n");
+ goto end;
+ }
+ ret = bt_iter_next(iter);
+ if (ret < 0)
+ goto end;
+ }
+ ret = 0;
+
+end:
+ bt_iter_destroy(iter);
+error_iter:
+ return ret;
+}
+
+
+/*
+ * traverse_dir() is the callback functiion for File Tree Walk (nftw).
+ * it receives the path of the current entry (file, dir, link..etc) with
+ * a flag to indicate the type of the entry.
+ * if the entry being visited is a directory and contains a metadata file,
+ * then open it for reading and save a trace_descriptor to that directory
+ * in the read trace collection.
+ */
+static int traverse_dir(const char *fpath, const struct stat *sb,
+ int tflag, struct FTW *ftwbuf)
+{
+ int dirfd;
+ int fd;
+ struct trace_descriptor *td_read;
+ int ret;
+
+ if (tflag != FTW_D)
+ return 0;
+ dirfd = open(fpath, 0);
+ if (dirfd < 0) {
+ fprintf(stderr, "[error] unable to open trace "
+ "directory file descriptor.\n");
+ return -1;
+ }
+ fd = openat(dirfd, "metadata", O_RDONLY);
+ if (fd < 0) {
+ close(dirfd);
+ } else {
+ close(fd);
+ close(dirfd);
+ td_read = fmt_read->open_trace(opt_input_path,
+ fpath, O_RDONLY, ctf_move_pos_slow,
+ NULL);
+ if (!td_read) {
+ fprintf(stderr, "Error opening trace \"%s\" "
+ "for reading.\n\n", fpath);
+ return -1; /* error */
+ }
+ ret = trace_collection_add(&trace_collection_read, td_read);
+ if (ret) {
+ return -1;
+ }
+ }
+ return 0; /* success */
+}
+
int main(int argc, char **argv)
{
int ret;
- struct format *fmt_read, *fmt_write;
- struct trace_descriptor *td_read, *td_write;
+ struct format *fmt_write;
+ struct trace_descriptor *td_write;
+ struct bt_context *ctx;
ret = parse_options(argc, argv);
if (ret < 0) {
- fprintf(stdout, "Error parsing options.\n\n");
- usage(stdout);
+ fprintf(stderr, "Error parsing options.\n\n");
+ usage(stderr);
exit(EXIT_FAILURE);
} else if (ret > 0) {
exit(EXIT_SUCCESS);
if (opt_output_format)
strlower(opt_output_format);
- printf_verbose("Converting from file: %s\n", opt_input_path);
+ printf_verbose("Converting from directory: %s\n", opt_input_path);
printf_verbose("Converting from format: %s\n",
- opt_input_format ? : "<autodetect>");
- printf_verbose("Converting to file: %s\n", opt_output_path);
+ opt_input_format ? : "ctf <default>");
+ printf_verbose("Converting to directory: %s\n",
+ opt_output_path ? : "<stdout>");
printf_verbose("Converting to format: %s\n",
- opt_output_format ? : "ctf");
+ opt_output_format ? : "text <default>");
- if (!opt_input_format) {
- fprintf(stdout, "Error: input format autodetection not implemented yet.\n\n");
- usage(stdout);
- exit(EXIT_FAILURE);
- }
+ if (!opt_input_format)
+ opt_input_format = "ctf";
+ if (!opt_output_format)
+ opt_output_format = "text";
fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
if (!fmt_read) {
- fprintf(stdout, "Error: format \"%s\" is not supported.\n\n",
+ fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n",
opt_input_format);
exit(EXIT_FAILURE);
}
- if (!opt_output_format)
- opt_output_format = "ctf";
fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
if (!fmt_write) {
- fprintf(stdout, "Error: format \"%s\" is not supported.\n\n",
+ fprintf(stderr, "[error] format \"%s\" is not supported.\n\n",
opt_output_format);
exit(EXIT_FAILURE);
}
- td_read = fmt_read->open_trace(opt_input_path, O_RDONLY);
- if (!td_read) {
- fprintf(stdout, "Error opening trace \"%s\" for reading.\n\n",
+ /*
+ * pass the input path to nftw() .
+ * specify traverse_dir() as the callback function.
+ * depth = 10 which is the max number of file descriptors
+ * that nftw() can open at a given time.
+ * flags = 0 check nftw documentation for more info .
+ */
+ init_trace_collection(&trace_collection_read);
+ ret = nftw(opt_input_path, traverse_dir, 10, 0);
+ if (ret != 0) {
+ fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
opt_input_path);
goto error_td_read;
}
-
- td_write = fmt_write->open_trace(opt_output_path, O_WRONLY);
+ if (trace_collection_read.array->len == 0) {
+ fprintf(stderr, "[warning] no metadata file was found."
+ " no output was generated\n");
+ return 0;
+ }
+ ctx = bt_context_create(&trace_collection_read);
+ if (!ctx) {
+ fprintf(stderr, "Error allocating a new context\n");
+ goto error_td_read;
+ }
+ td_write = fmt_write->open_trace(NULL, opt_output_path, O_RDWR, NULL, NULL);
if (!td_write) {
- fprintf(stdout, "Error opening trace \"%s\" for writing.\n\n",
- opt_output_path);
+ fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n",
+ opt_output_path ? : "<none>");
goto error_td_write;
}
+ ret = convert_trace(td_write, ctx);
+ if (ret) {
+ fprintf(stderr, "Error printing trace.\n\n");
+ goto error_copy_trace;
+ }
+
fmt_write->close_trace(td_write);
- fmt_read->close_trace(td_read);
+ finalize_trace_collection(&trace_collection_read);
+ bt_context_destroy(ctx);
+ printf_verbose("finished converting. Output written to:\n%s\n",
+ opt_output_path ? : "<stdout>");
exit(EXIT_SUCCESS);
/* Error handling */
+error_copy_trace:
fmt_write->close_trace(td_write);
error_td_write:
- fmt_read->close_trace(td_read);
+ finalize_trace_collection(&trace_collection_read);
error_td_read:
exit(EXIT_FAILURE);
}
projects / babeltrace.git / blobdiff