X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=converter%2Fbabeltrace.c;h=fe7d39fa49b5b13d1fc7185c9f36e0a9c714ac8d;hp=539734eeaa55df4e3ba23019f8cbe5d9560fef51;hb=c462e188f3e7819c7bc74f671038cdbf36e8c3c0;hpb=20d24215ef299a387abac4850f82359de8a86f4d diff --git a/converter/babeltrace.c b/converter/babeltrace.c index 539734ee..fe7d39fa 100644 --- a/converter/babeltrace.c +++ b/converter/babeltrace.c @@ -16,6 +16,14 @@ * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. */ #define _GNU_SOURCE @@ -24,6 +32,10 @@ #include #include #include +#include +/* TODO: fix object model for format-agnostic callbacks */ +#include +#include #include #include #include @@ -35,29 +47,43 @@ #include #include #include -#include +#include +#include #include /* for clocks */ +#define PARTIAL_ERROR_SLEEP 3 /* 3 seconds */ + #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; +static char *opt_input_format, *opt_output_format; + +/* + * We are not freeing opt_input_paths ipath elements when exiting from + * main() for backward compatibility with libpop 0.13, which does not + * allocate copies for arguments returned by poptGetArg(), and for + * general compatibility with the documented behavior. This is known to + * cause a small memory leak with libpop 0.16. + */ +static GPtrArray *opt_input_paths; +static char *opt_output_path; static struct format *fmt_read; +static void strlower(char *str) { while (*str) { - *str = tolower(*str); + *str = tolower((int) *str); str++; } } enum { OPT_NONE = 0, + OPT_OUTPUT_PATH, + OPT_INPUT_FORMAT, + OPT_OUTPUT_FORMAT, OPT_HELP, OPT_LIST, OPT_VERBOSE, @@ -66,17 +92,26 @@ 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, }; +/* + * We are _not_ using POPT_ARG_STRING ability to store directly into + * variables, because we want to cast the return to non-const, which is + * not possible without using poptGetOptArg explicitly. This helps us + * controlling memory allocation correctly without making assumptions + * about undocumented behaviors. poptGetOptArg is documented as + * requiring the returned const char * to be freed by the caller. + */ 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 }, + { "output", 'w', POPT_ARG_STRING, NULL, OPT_NONE, NULL, NULL }, + { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL }, + { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, 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 }, @@ -85,7 +120,7 @@ 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 }, @@ -102,10 +137,11 @@ static void list_formats(FILE *fp) static void usage(FILE *fp) { fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION); - fprintf(fp, "usage : babeltrace [OPTIONS] INPUT \n"); + fprintf(fp, "usage : babeltrace [OPTIONS] FILE...\n"); fprintf(fp, "\n"); - fprintf(fp, " INPUT Input trace path\n"); - fprintf(fp, " OUTPUT Output trace path (default: stdout)\n"); + fprintf(fp, " FILE Input trace file(s) and/or directory(ies)\n"); + fprintf(fp, " (space-separated)\n"); + fprintf(fp, " -w, --output OUTPUT Output trace path (default: stdout)\n"); fprintf(fp, "\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"); @@ -119,12 +155,13 @@ 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, " all, trace, trace:hostname, trace:domain,\n"); + fprintf(fp, " trace:procname, trace:vpid, loglevel, emf, callsite.\n"); + fprintf(fp, " (default: trace:hostname,trace:procname,trace:vpid)\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"); @@ -139,8 +176,10 @@ static void usage(FILE *fp) static int get_names_args(poptContext *pc) { char *str, *strlist, *strctx; + int ret = 0; opt_payload_field_names = 0; + opt_context_field_names = 0; strlist = (char *) poptGetOptArg(*pc); if (!strlist) { return -EINVAL; @@ -157,17 +196,28 @@ 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; + free(strlist); + ret = -EINVAL; + goto end; } } while ((str = strtok_r(NULL, ",", &strctx))); - return 0; +end: + free(strlist); + return ret; } static int get_fields_args(poptContext *pc) { char *str, *strlist, *strctx; + int ret = 0; strlist = (char *) poptGetOptArg(*pc); if (!strlist) { @@ -175,10 +225,13 @@ static int get_fields_args(poptContext *pc) } str = strtok_r(strlist, ",", &strctx); do { + opt_trace_default_fields = 0; if (!strcmp(str, "all")) opt_all_fields = 1; else if (!strcmp(str, "trace")) opt_trace_field = 1; + else if (!strcmp(str, "trace:hostname")) + opt_trace_hostname_field = 1; else if (!strcmp(str, "trace:domain")) opt_trace_domain_field = 1; else if (!strcmp(str, "trace:procname")) @@ -187,12 +240,19 @@ static int get_fields_args(poptContext *pc) opt_trace_vpid_field = 1; else if (!strcmp(str, "loglevel")) opt_loglevel_field = 1; + else if (!strcmp(str, "emf")) + opt_emf_field = 1; + else if (!strcmp(str, "callsite")) + opt_callsite_field = 1; else { fprintf(stderr, "[error] unknown field type %s\n", str); - return -EINVAL; + ret = -EINVAL; + goto end; } } while ((str = strtok_r(NULL, ",", &strctx))); - return 0; +end: + free(strlist); + return ret; } /* @@ -203,6 +263,7 @@ static int parse_options(int argc, char **argv) { poptContext pc; int opt, ret = 0; + const char *ipath; if (argc == 1) { usage(stdout); @@ -213,10 +274,32 @@ 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) { switch (opt) { + case OPT_OUTPUT_PATH: + opt_output_path = (char *) poptGetOptArg(pc); + if (!opt_output_path) { + ret = -EINVAL; + goto end; + } + break; + case OPT_INPUT_FORMAT: + opt_input_format = (char *) poptGetOptArg(pc); + if (!opt_input_format) { + ret = -EINVAL; + goto end; + } + break; + case OPT_OUTPUT_FORMAT: + opt_output_format = (char *) poptGetOptArg(pc); + if (!opt_output_format) { + ret = -EINVAL; + goto end; + } + break; case OPT_HELP: usage(stdout); ret = 1; /* exit cleanly */ @@ -246,14 +329,15 @@ 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; + char *str; + char *endptr; - str = poptGetOptArg(pc); + str = (char *) poptGetOptArg(pc); if (!str) { fprintf(stderr, "[error] Missing --clock-offset argument\n"); ret = -EINVAL; @@ -264,8 +348,10 @@ static int parse_options(int argc, char **argv) if (*endptr != '\0' || str == endptr || errno != 0) { fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str); ret = -EINVAL; + free(str); goto end; } + free(str); break; } case OPT_CLOCK_SECONDS: @@ -287,12 +373,15 @@ static int parse_options(int argc, char **argv) } } - opt_input_path = poptGetArg(pc); - if (!opt_input_path) { + do { + ipath = poptGetArg(pc); + if (ipath) + g_ptr_array_add(opt_input_paths, (gpointer) ipath); + } while (ipath); + if (opt_input_paths->len == 0) { ret = -EINVAL; goto end; } - opt_output_path = poptGetArg(pc); end: if (pc) { @@ -301,148 +390,186 @@ end: return ret; } +static GPtrArray *traversed_paths = 0; + +/* + * 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 int traverse_trace_dir(const char *fpath, const struct stat *sb, + int tflag, struct FTW *ftwbuf) +{ + int dirfd, metafd; + int closeret; + + if (tflag != FTW_D) + return 0; + + 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; + } + /* 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 */ + } + + /* 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; +} /* * 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. + * 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, nonzero on failure. + * 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; + * Unable to open some subdirectory or file: warn and continue (partial + * failure); */ int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path, - const char *format_str) + const char *format_str, + void (*packet_seek)(struct stream_pos *pos, + size_t offset, int whence)) { - FTS *tree; - FTSENT *node; - GArray *trace_ids; - char lpath[PATH_MAX]; - char * const paths[2] = { lpath, NULL }; - int ret; - /* - * 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'; + GArray *trace_ids; + int ret = 0; - 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; - } + /* 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)); - while ((node = fts_read(tree))) { - int dirfd, metafd; - - 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 = dirfd; - goto error; - } - metafd = openat(dirfd, "metadata", O_RDONLY); - if (metafd < 0) { - ret = close(dirfd); - if (ret < 0) { - perror("close"); - goto error; - } - } else { - int trace_id; - - ret = close(metafd); - if (ret < 0) { - perror("close"); - goto error; - } - ret = close(dirfd); - if (ret < 0) { - perror("close"); - goto error; - } - - trace_id = bt_context_add_trace(ctx, - node->fts_accpath, format_str); + ret = nftw(path, traverse_trace_dir, 10, 0); + + /* Process the array if ntfw did not return a fatal error */ + if (ret >= 0) { + int i; + + 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, "[error] [Context] opening trace \"%s\" from %s " - "for reading.\n", node->fts_accpath, path); - ret = trace_id; - goto error; + 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_array_append_val(trace_ids, trace_id); + g_string_free(trace_path, TRUE); } } - g_array_free(trace_ids, TRUE); - return 0; + g_ptr_array_free(traversed_paths, TRUE); + traversed_paths = NULL; -error: + /* 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 */ + } + g_array_free(trace_ids, TRUE); return ret; } - - 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 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_iter_create(ctx, &begin_pos, NULL); + iter = bt_ctf_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); + 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 = bt_iter_next(iter); + ret = bt_iter_next(bt_ctf_get_iter(iter)); if (ret < 0) goto end; } ret = 0; end: - bt_iter_destroy(iter); + bt_ctf_iter_destroy(iter); error_iter: return ret; } int main(int argc, char **argv) { - int ret; + int ret, partial_error = 0, open_success = 0; struct format *fmt_write; struct trace_descriptor *td_write; struct bt_context *ctx; + int i; + + opt_input_paths = g_ptr_array_new(); ret = parse_options(argc, argv); if (ret < 0) { fprintf(stderr, "Error parsing options.\n\n"); usage(stderr); + g_ptr_array_free(opt_input_paths, TRUE); exit(EXIT_FAILURE); } else if (ret > 0) { + g_ptr_array_free(opt_input_paths, TRUE); exit(EXIT_SUCCESS); } printf_verbose("Verbose mode active.\n"); @@ -453,7 +580,11 @@ int main(int argc, char **argv) if (opt_output_format) strlower(opt_output_format); - printf_verbose("Converting from directory: %s\n", opt_input_path); + printf_verbose("Converting from directory(ies):\n"); + for (i = 0; i < opt_input_paths->len; i++) { + const char *ipath = g_ptr_array_index(opt_input_paths, i); + printf_verbose(" %s\n", ipath); + } printf_verbose("Converting from format: %s\n", opt_input_format ? : "ctf "); printf_verbose("Converting to directory: %s\n", @@ -461,30 +592,58 @@ 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; } ctx = bt_context_create(); + if (!ctx) { + goto error_td_read; + } - ret = bt_context_add_traces_recursive(ctx, opt_input_path, - opt_input_format); - if (ret) { - fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n", - opt_input_path); + for (i = 0; i < opt_input_paths->len; i++) { + const char *ipath = g_ptr_array_index(opt_input_paths, i); + ret = bt_context_add_traces_recursive(ctx, ipath, + opt_input_format, NULL); + if (ret < 0) { + fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n", + ipath); + } else if (ret > 0) { + fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n", + ipath); + open_success = 1; /* some traces were OK */ + partial_error = 1; + } else { + open_success = 1; /* all traces were OK */ + } + } + if (!open_success) { + fprintf(stderr, "[error] none of the specified trace paths could be opened.\n\n"); goto error_td_read; } @@ -495,6 +654,13 @@ int main(int argc, char **argv) goto error_td_write; } + /* + * Errors happened when opening traces, but we continue anyway. + * sleep to let user see the stderr output before stdout. + */ + if (partial_error) + sleep(PARTIAL_ERROR_SLEEP); + ret = convert_trace(td_write, ctx); if (ret) { fprintf(stderr, "Error printing trace.\n\n"); @@ -506,7 +672,7 @@ int main(int argc, char **argv) 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: @@ -514,5 +680,16 @@ error_copy_trace: error_td_write: 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); + free(opt_output_path); + g_ptr_array_free(opt_input_paths, TRUE); + if (partial_error) + exit(EXIT_FAILURE); + else + exit(EXIT_SUCCESS); }