Update help
[babeltrace.git] / converter / babeltrace.c
index a30e330f2766c31ea78f30b4afb29bb53785ce0c..2701a0cd2517661122fec747e6038c3748b87f95 100644 (file)
@@ -24,7 +24,7 @@
 #include <babeltrace/format.h>
 #include <babeltrace/context.h>
 #include <babeltrace/ctf/types.h>
-#include <babeltrace/ctf-text/types.h>
+#include <abeltrace/ctf-text/types.h>
 #include <babeltrace/iterator.h>
 #include <popt.h>
 #include <errno.h>
@@ -36,6 +36,9 @@
 #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;
@@ -62,7 +65,13 @@ enum {
        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[] = {
@@ -74,7 +83,13 @@ static struct poptOption long_options[] = {
        { "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 },
 };
 
@@ -86,7 +101,7 @@ static void list_formats(FILE *fp)
 
 static void usage(FILE *fp)
 {
-       fprintf(fp, "BabelTrace Trace Converter %s\n\n", VERSION);
+       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");
@@ -102,13 +117,19 @@ static void usage(FILE *fp)
        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, "                                 Available field names:\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, "                                     trace, trace:domain, trace:procname, trace:vpid,\n");
-       fprintf(fp, "                                     loglevel.\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");
 }
@@ -134,18 +155,38 @@ static int get_names_args(poptContext *pc)
                        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_name = 1;
+                       opt_trace_field = 1;
                else if (!strcmp(str, "trace:domain"))
-                       opt_trace_domain = 1;
+                       opt_trace_domain_field = 1;
                else if (!strcmp(str, "trace:procname"))
-                       opt_trace_procname = 1;
+                       opt_trace_procname_field = 1;
                else if (!strcmp(str, "trace:vpid"))
-                       opt_trace_vpid = 1;
+                       opt_trace_vpid_field = 1;
                else if (!strcmp(str, "loglevel"))
-                       opt_loglevel = 1;
+                       opt_loglevel_field = 1;
                else {
-                       fprintf(stderr, "[error] unknown field name type %s\n", str);
+                       fprintf(stderr, "[error] unknown field type %s\n", str);
                        return -EINVAL;
                }
        } while ((str = strtok_r(NULL, ",", &strctx)));
@@ -191,12 +232,50 @@ static int parse_options(int argc, char **argv)
                                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 = 0;
+                       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;
@@ -220,6 +299,11 @@ end:
 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;
 }
 
 /*
@@ -236,47 +320,197 @@ static void finalize_trace_collection(struct trace_collection *tc)
                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);
+               }
+       }
 }
 
-static void trace_collection_add(struct trace_collection *tc,
-                                struct trace_descriptor *td)
+/*
+ * 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 babeltrace_iter *iter;
+       struct bt_iter *iter;
        struct ctf_stream *stream;
        struct ctf_stream_event *event;
        struct ctf_text_stream_pos *sout;
-       struct trace_collection_pos begin_pos;
+       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 = babeltrace_iter_create(ctx, &begin_pos, NULL);
+       iter = bt_iter_create(ctx, &begin_pos, NULL);
        if (!iter) {
                ret = -1;
                goto error_iter;
        }
-       while (babeltrace_iter_read_event(iter, &stream, &event) == 0) {
+       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 = babeltrace_iter_next(iter);
+               ret = bt_iter_next(iter);
                if (ret < 0)
                        goto end;
        }
        ret = 0;
 
 end:
-       babeltrace_iter_destroy(iter);
+       bt_iter_destroy(iter);
 error_iter:
        return ret;
 }
@@ -296,6 +530,7 @@ static int traverse_dir(const char *fpath, const struct stat *sb,
        int dirfd;
        int fd;
        struct trace_descriptor *td_read;
+       int ret;
 
        if (tflag != FTW_D)
                return 0;
@@ -319,7 +554,10 @@ static int traverse_dir(const char *fpath, const struct stat *sb,
                                        "for reading.\n\n", fpath);
                        return -1;      /* error */
                }
-               trace_collection_add(&trace_collection_read, td_read);
+               ret = trace_collection_add(&trace_collection_read, td_read);
+               if (ret) {
+                       return -1;
+               }
        }
        return 0;       /* success */
 }
This page took 0.027295 seconds and 4 git commands to generate.