X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=converter%2Fbabeltrace.c;h=c9007c3d9c9f2f5c467c4e9435d4055dd474a06c;hp=f872e6dc30ccea4ca06b9f84cae475f4e0a2bb5b;hb=b4b292cc76e04e9efda111e492251d8e7aefe451;hpb=0716bb06f1a2995aedf7df46b0ed00a126fc8f29 diff --git a/converter/babeltrace.c b/converter/babeltrace.c index f872e6dc..c9007c3d 100644 --- a/converter/babeltrace.c +++ b/converter/babeltrace.c @@ -18,12 +18,16 @@ * all copies or substantial portions of the Software. */ -#define _XOPEN_SOURCE 700 +#define _GNU_SOURCE #include #include #include #include #include +#include +/* TODO: fix object model for format-agnostic callbacks */ +#include +#include #include #include #include @@ -33,27 +37,28 @@ #include #include #include -#include -#include #include #include +#include +#include #include /* for clocks */ #define DEFAULT_FILE_ARRAY_SIZE 1 -static char *opt_input_format; -static char *opt_output_format; +static char *opt_input_format, *opt_output_format; +/* Pointer into const argv */ +static const char *opt_input_format_arg, *opt_output_format_arg; static const char *opt_input_path; static const char *opt_output_path; -static struct trace_collection trace_collection_read; static struct format *fmt_read; +static void strlower(char *str) { while (*str) { - *str = tolower(*str); + *str = tolower((int) *str); str++; } } @@ -68,16 +73,17 @@ enum { OPT_FIELDS, OPT_NO_DELTA, OPT_CLOCK_OFFSET, - OPT_CLOCK_RAW, + OPT_CLOCK_CYCLES, OPT_CLOCK_SECONDS, OPT_CLOCK_DATE, OPT_CLOCK_GMT, + OPT_CLOCK_FORCE_CORRELATE, }; static struct poptOption long_options[] = { /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ - { "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL }, - { "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL }, + { "input-format", 'i', POPT_ARG_STRING, &opt_input_format_arg, OPT_NONE, NULL, NULL }, + { "output-format", 'o', POPT_ARG_STRING, &opt_output_format_arg, OPT_NONE, NULL, NULL }, { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL }, { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL }, @@ -86,10 +92,11 @@ static struct poptOption long_options[] = { { "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-cycles", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, 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 }, + { "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL }, { NULL, 0, 0, NULL, 0, NULL, NULL }, }; @@ -101,7 +108,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 \n"); fprintf(fp, "\n"); fprintf(fp, " INPUT Input trace path\n"); @@ -119,17 +126,19 @@ static void usage(FILE *fp) 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, " none, all, scope, header, (context OR ctx)\n"); + fprintf(fp, " (default: payload,context)\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-cycles Timestamp in cycles\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"); + fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n"); + fprintf(fp, " across traces.\n"); list_formats(fp); fprintf(fp, "\n"); } @@ -139,6 +148,7 @@ static int get_names_args(poptContext *pc) char *str, *strlist, *strctx; opt_payload_field_names = 0; + opt_context_field_names = 0; strlist = (char *) poptGetOptArg(*pc); if (!strlist) { return -EINVAL; @@ -155,7 +165,13 @@ 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 { + else if (!strcmp(str, "none")) { + opt_all_field_names = 0; + opt_scope_field_names = 0; + opt_context_field_names = 0; + opt_header_field_names = 0; + opt_payload_field_names = 0; + } else { fprintf(stderr, "[error] unknown field name type %s\n", str); return -EINVAL; } @@ -167,7 +183,6 @@ static int get_fields_args(poptContext *pc) { char *str, *strlist, *strctx; - opt_payload_field_names = 0; strlist = (char *) poptGetOptArg(*pc); if (!strlist) { return -EINVAL; @@ -212,6 +227,7 @@ static int parse_options(int argc, char **argv) poptReadDefaultConfig(pc, 0); /* set default */ + opt_context_field_names = 1; opt_payload_field_names = 1; while ((opt = poptGetNextOpt(pc)) != -1) { @@ -245,12 +261,13 @@ static int parse_options(int argc, char **argv) case OPT_NO_DELTA: opt_delta_field = 0; break; - case OPT_CLOCK_RAW: - opt_clock_raw = 1; + case OPT_CLOCK_CYCLES: + opt_clock_cycles = 1; break; case OPT_CLOCK_OFFSET: { - char *str, *endptr; + const char *str; + char *endptr; str = poptGetOptArg(pc); if (!str) { @@ -276,6 +293,9 @@ static int parse_options(int argc, char **argv) case OPT_CLOCK_GMT: opt_clock_gmt = 1; break; + case OPT_CLOCK_FORCE_CORRELATE: + opt_clock_force_correlate = 1; + break; default: ret = -EINVAL; @@ -297,275 +317,168 @@ end: 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; -} +static GPtrArray *traversed_paths = 0; /* - * finalize_trace_collection() closes the opened traces for read - * and free the memory allocated for trace collection + * traverse_trace_dir() is the callback function 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 add the path to a global list to be processed later in + * add_traces_recursive. */ -static void finalize_trace_collection(struct trace_collection *tc) +static int traverse_trace_dir(const char *fpath, const struct stat *sb, + int tflag, struct FTW *ftwbuf) { - int i; + int dirfd, metafd; + int closeret; - 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; -}; + if (tflag != FTW_D) + return 0; -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; + dirfd = open(fpath, 0); + if (dirfd < 0) { + fprintf(stderr, "[error] [Context] Unable to open trace " + "directory file descriptor.\n"); + return 0; /* partial error */ + } + metafd = openat(dirfd, "metadata", O_RDONLY); + if (metafd < 0) { + closeret = close(dirfd); + if (closeret < 0) { + perror("close"); + return -1; } - } 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; + /* No meta data, just return */ + return 0; + } else { + closeret = close(metafd); + if (closeret < 0) { + perror("close"); + return -1; /* failure */ + } + closeret = close(dirfd); + if (closeret < 0) { + perror("close"); + return -1; /* failure */ } - } -} - -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); + /* Add path to the global list */ + if (traversed_paths == NULL) { + fprintf(stderr, "[error] [Context] Invalid open path array.\n"); + return -1; } + g_ptr_array_add(traversed_paths, g_string_new(fpath)); } -} + return 0; +} /* - * 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. + * bt_context_add_traces_recursive: Open a trace recursively + * + * Find each trace present in the subdirectory starting from the given + * path, and add them to the context. The packet_seek parameter can be + * NULL: this specify to use the default format packet_seek. + * + * Return: 0 on success, < 0 on failure, > 0 on partial failure. + * Unable to open toplevel: failure. + * Unable to open some subdirectory or file: warn and continue (partial + * failure); */ -static int trace_collection_add(struct trace_collection *tc, - struct trace_descriptor *td) +int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path, + const char *format_str, + void (*packet_seek)(struct stream_pos *pos, + size_t offset, int whence)) { - 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; + + GArray *trace_ids; + int ret = 0; + int i; + + /* Should lock traversed_paths mutex here if used in multithread */ + + traversed_paths = g_ptr_array_new(); + trace_ids = g_array_new(FALSE, TRUE, sizeof(int)); + + ret = nftw(path, traverse_trace_dir, 10, 0); + + /* Process the array if ntfw did not return a fatal error */ + if (ret >= 0) { + for (i = 0; i < traversed_paths->len; i++) { + GString *trace_path = g_ptr_array_index(traversed_paths, + i); + int trace_id = bt_context_add_trace(ctx, + trace_path->str, + format_str, + packet_seek, + NULL, + NULL); + if (trace_id < 0) { + fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" from %s " + "for reading.\n", trace_path->str, path); + /* Allow to skip erroneous traces. */ + ret = 1; /* partial error */ + } else { + g_array_append_val(trace_ids, trace_id); + } + g_string_free(trace_path, TRUE); } } + g_ptr_array_free(traversed_paths, TRUE); + traversed_paths = NULL; - { - 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); + /* Should unlock traversed paths mutex here if used in multithread */ + + /* + * Return an error if no trace can be opened. + */ + if (trace_ids->len == 0) { + fprintf(stderr, "[error] Cannot open any trace for reading.\n\n"); + ret = -ENOENT; /* failure */ } - return 0; -error: - return -EPERM; + g_array_free(trace_ids, TRUE); + return ret; } int convert_trace(struct trace_descriptor *td_write, struct bt_context *ctx) { - struct babeltrace_iter *iter; - struct ctf_stream *stream; - struct ctf_stream_event *event; + struct bt_ctf_iter *iter; struct ctf_text_stream_pos *sout; - struct trace_collection_pos begin_pos; + struct bt_iter_pos begin_pos; + struct bt_ctf_event *ctf_event; 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_ctf_iter_create(ctx, &begin_pos, NULL); if (!iter) { ret = -1; goto error_iter; } - while (babeltrace_iter_read_event(iter, &stream, &event) == 0) { - ret = sout->parent.event_cb(&sout->parent, stream); + while ((ctf_event = bt_ctf_iter_read_event(iter))) { + ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream); if (ret) { fprintf(stderr, "[error] Writing event failed.\n"); goto end; } - ret = babeltrace_iter_next(iter); + ret = bt_iter_next(bt_ctf_get_iter(iter)); if (ret < 0) goto end; } ret = 0; end: - babeltrace_iter_destroy(iter); + bt_ctf_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; + int ret, partial_error = 0; struct format *fmt_write; struct trace_descriptor *td_write; struct bt_context *ctx; @@ -581,10 +494,22 @@ int main(int argc, char **argv) printf_verbose("Verbose mode active.\n"); printf_debug("Debug mode active.\n"); - if (opt_input_format) + if (opt_input_format_arg) { + opt_input_format = strdup(opt_input_format_arg); + if (!opt_input_format) { + partial_error = 1; + goto end; + } strlower(opt_input_format); - if (opt_output_format) + } + if (opt_output_format_arg) { + opt_output_format = strdup(opt_output_format_arg); + if (!opt_output_format) { + partial_error = 1; + goto end; + } strlower(opt_output_format); + } printf_verbose("Converting from directory: %s\n", opt_input_path); printf_verbose("Converting from format: %s\n", @@ -594,48 +519,53 @@ int main(int argc, char **argv) printf_verbose("Converting to format: %s\n", opt_output_format ? : "text "); - if (!opt_input_format) - opt_input_format = "ctf"; - if (!opt_output_format) - opt_output_format = "text"; + if (!opt_input_format) { + opt_input_format = strdup("ctf"); + if (!opt_input_format) { + partial_error = 1; + goto end; + } + } + if (!opt_output_format) { + opt_output_format = strdup("text"); + if (!opt_output_format) { + partial_error = 1; + goto end; + } + } fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format)); if (!fmt_read) { fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n", opt_input_format); - exit(EXIT_FAILURE); + partial_error = 1; + goto end; } fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format)); if (!fmt_write) { fprintf(stderr, "[error] format \"%s\" is not supported.\n\n", opt_output_format); - exit(EXIT_FAILURE); + partial_error = 1; + goto end; } - /* - * 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); + ctx = bt_context_create(); + if (!ctx) { goto error_td_read; } - 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"); + + ret = bt_context_add_traces_recursive(ctx, opt_input_path, + opt_input_format, NULL); + if (ret < 0) { + fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n", + opt_input_path); goto error_td_read; + } else if (ret > 0) { + fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n", + opt_input_path); + partial_error = 1; } - td_write = fmt_write->open_trace(NULL, opt_output_path, O_RDWR, NULL, NULL); + + td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL); if (!td_write) { fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n", opt_output_path ? : ""); @@ -649,17 +579,26 @@ int main(int argc, char **argv) } fmt_write->close_trace(td_write); - finalize_trace_collection(&trace_collection_read); - bt_context_destroy(ctx); + + bt_context_put(ctx); printf_verbose("finished converting. Output written to:\n%s\n", opt_output_path ? : ""); - exit(EXIT_SUCCESS); + goto end; /* Error handling */ error_copy_trace: fmt_write->close_trace(td_write); error_td_write: - finalize_trace_collection(&trace_collection_read); + bt_context_put(ctx); error_td_read: - exit(EXIT_FAILURE); + partial_error = 1; + + /* teardown and exit */ +end: + free(opt_input_format); + free(opt_output_format); + if (partial_error) + exit(EXIT_FAILURE); + else + exit(EXIT_SUCCESS); }