X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=converter%2Fbabeltrace.c;h=fd6586a5a1e020eb80d168ef19b689f9db987dcd;hp=bac8a85f700a2f7b14dc5fbe4265d24e47aeadca;hb=09349576c27925daab50630bff7d219eebc8df98;hpb=82662ad4362f791f9cd7026652f60708923554f4 diff --git a/converter/babeltrace.c b/converter/babeltrace.c index bac8a85f..fd6586a5 100644 --- a/converter/babeltrace.c +++ b/converter/babeltrace.c @@ -18,10 +18,18 @@ * all copies or substantial portions of the Software. */ -#define _XOPEN_SOURCE 700 +#define _GNU_SOURCE #include -#include +#include #include +#include +#include +#include +/* TODO: fix object model for format-agnostic callbacks */ +#include +#include +#include +#include #include #include #include @@ -29,24 +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++; } } @@ -58,17 +70,33 @@ enum { OPT_VERBOSE, OPT_DEBUG, OPT_NAMES, + OPT_FIELDS, + OPT_NO_DELTA, + OPT_CLOCK_OFFSET, + 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 }, { "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-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 }, }; @@ -80,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"); @@ -95,12 +123,22 @@ static void usage(FILE *fp) 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, " -n, --names name1<,name2,...> Print field names.\n"); - fprintf(fp, " Available field names:\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, " trace\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-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"); } @@ -110,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; @@ -126,10 +165,44 @@ 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 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; + } + } 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_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(stdout, "[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))); @@ -154,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) { @@ -175,9 +249,54 @@ 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_field = 0; + break; + case OPT_CLOCK_CYCLES: + opt_clock_cycles = 1; + break; + case OPT_CLOCK_OFFSET: + { + const char *str; + char *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; + case OPT_CLOCK_FORCE_CORRELATE: + opt_clock_force_correlate = 1; + break; + default: ret = -EINVAL; goto end; @@ -198,84 +317,161 @@ end: return ret; } -static void init_trace_collection(struct trace_collection *tc) -{ - tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE); -} /* - * finalize_trace_collection() closes the opened traces for read - * and free the memory allocated for trace collection + * 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 void finalize_trace_collection(struct trace_collection *tc) +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)) { - int i; + FTS *tree; + FTSENT *node; + GArray *trace_ids; + char lpath[PATH_MAX]; + char * const paths[2] = { lpath, NULL }; + int ret = 0; + + /* + * Need to copy path, because fts_open can change it. + * It is the pointer array, not the strings, that are constant. + */ + strncpy(lpath, path, PATH_MAX); + lpath[PATH_MAX - 1] = '\0'; - for (i = 0; i < tc->array->len; i++) { - struct trace_descriptor *temp = - g_ptr_array_index(tc->array, i); - fmt_read->close_trace(temp); + tree = fts_open(paths, FTS_NOCHDIR | FTS_LOGICAL, 0); + if (tree == NULL) { + fprintf(stderr, "[error] [Context] Cannot traverse \"%s\" for reading.\n", + path); + return -EINVAL; } - g_ptr_array_free(tc->array, TRUE); -} -static void trace_collection_add(struct trace_collection *tc, - struct trace_descriptor *td) -{ - g_ptr_array_add(tc->array, td); + trace_ids = g_array_new(FALSE, TRUE, sizeof(int)); + + while ((node = fts_read(tree))) { + int dirfd, metafd; + int closeret; + + if (!(node->fts_info & FTS_D)) + continue; + + dirfd = open(node->fts_accpath, 0); + if (dirfd < 0) { + fprintf(stderr, "[error] [Context] Unable to open trace " + "directory file descriptor.\n"); + ret = 1; /* partial error */ + goto error; + } + metafd = openat(dirfd, "metadata", O_RDONLY); + if (metafd < 0) { + closeret = close(dirfd); + if (closeret < 0) { + perror("close"); + ret = -1; /* failure */ + goto error; + } + continue; + } else { + int trace_id; + + closeret = close(metafd); + if (closeret < 0) { + perror("close"); + ret = -1; /* failure */ + goto error; + } + closeret = close(dirfd); + if (closeret < 0) { + perror("close"); + ret = -1; /* failure */ + goto error; + } + + trace_id = bt_context_add_trace(ctx, + node->fts_accpath, format_str, + packet_seek, NULL, NULL); + if (trace_id < 0) { + fprintf(stderr, "[warning] [Context] opening trace \"%s\" from %s " + "for reading.\n", node->fts_accpath, path); + /* Allow to skip erroneous traces. */ + ret = 1; /* partial error */ + continue; + } + g_array_append_val(trace_ids, trace_id); + } + } + +error: + /* + * 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 */ + } + g_array_free(trace_ids, TRUE); + 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 convert_trace(struct trace_descriptor *td_write, + struct bt_context *ctx) { - int dirfd; - int fd; - struct trace_descriptor *td_read; - - if (tflag != FTW_D) - return 0; - dirfd = open(fpath, 0); - if (dirfd < 0) { - fprintf(stdout, "[error] unable to open trace " - "directory file descriptor.\n"); - return -1; + struct bt_ctf_iter *iter; + struct ctf_text_stream_pos *sout; + 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 = bt_ctf_iter_create(ctx, &begin_pos, NULL); + if (!iter) { + ret = -1; + goto error_iter; } - fd = openat(dirfd, "metadata", O_RDONLY); - if (fd < 0) { - close(dirfd); - } else { - close(fd); - close(dirfd); - td_read = fmt_read->open_trace(fpath, O_RDONLY, ctf_move_pos_slow, - NULL); - if (!td_read) { - fprintf(stdout, "Error opening trace \"%s\" " - "for reading.\n\n", fpath); - return -1; /* error */ + 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; } - trace_collection_add(&trace_collection_read, td_read); + ret = bt_iter_next(bt_ctf_get_iter(iter)); + if (ret < 0) + goto end; } - return 0; /* success */ + ret = 0; + +end: + bt_ctf_iter_destroy(iter); +error_iter: + return ret; } 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; 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); @@ -283,10 +479,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", @@ -296,67 +504,83 @@ 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(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); + partial_error = 1; + goto end; } 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); + 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(stdout, "[error] opening trace \"%s\" for reading.\n\n", + ctx = bt_context_create(); + + 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; - } - if (trace_collection_read.array->len == 0) { - fprintf(stdout, "[warning] no metadata file was found." - " no output was generated\n"); - return 0; + } 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(opt_output_path, O_RDWR, NULL, NULL); if (!td_write) { - fprintf(stdout, "Error opening trace \"%s\" for writing.\n\n", + fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n", opt_output_path ? : ""); goto error_td_write; } - ret = convert_trace(td_write, &trace_collection_read); + ret = convert_trace(td_write, ctx); if (ret) { - fprintf(stdout, "Error printing trace.\n\n"); + fprintf(stderr, "Error printing trace.\n\n"); goto error_copy_trace; } fmt_write->close_trace(td_write); - finalize_trace_collection(&trace_collection_read); + + 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); }