X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=converter%2Fbabeltrace.c;h=384b02f9f228fd98634f3a60b927b91612cc40cc;hb=685ee0054ac30d3682a6b8b09fa2995bf35a9fe3;hp=fd6586a5a1e020eb80d168ef19b689f9db987dcd;hpb=03798a93f959f6c694fe98f5647481947607c604;p=babeltrace.git diff --git a/converter/babeltrace.c b/converter/babeltrace.c index fd6586a5..384b02f9 100644 --- a/converter/babeltrace.c +++ b/converter/babeltrace.c @@ -16,199 +16,55 @@ * * 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 -#include #include -#include -#include -#include -#include -/* TODO: fix object model for format-agnostic callbacks */ -#include -#include -#include -#include -#include -#include +#include +#include +#include +#include +#include #include -#include -#include -#include -#include -#include -#include -#include -#include - #include /* for clocks */ +#include +#include +#include -#define DEFAULT_FILE_ARRAY_SIZE 1 -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 format *fmt_read; -static -void strlower(char *str) -{ - while (*str) { - *str = tolower((int) *str); - str++; - } -} +static char *opt_plugin_path; enum { OPT_NONE = 0, - OPT_HELP, - OPT_LIST, + OPT_PLUGIN_PATH, 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, + OPT_HELP, }; +/* + * We are _not_ using POPT_ARG_STRING's 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_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 }, + { "plugin-path", 0, POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, 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 }, }; -static void list_formats(FILE *fp) -{ - fprintf(fp, "\n"); - bt_fprintf_format_list(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, "\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 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, " (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, " 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"); -} - -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; - } - 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 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_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. @@ -219,7 +75,6 @@ static int parse_options(int argc, char **argv) int opt, ret = 0; if (argc == 1) { - usage(stdout); return 1; /* exit cleanly */ } @@ -233,83 +88,27 @@ static int parse_options(int argc, char **argv) while ((opt = poptGetNextOpt(pc)) != -1) { switch (opt) { case OPT_HELP: - usage(stdout); ret = 1; /* exit cleanly */ goto end; - case OPT_LIST: - list_formats(stdout); - ret = 1; - goto end; - case OPT_VERBOSE: - babeltrace_verbose = 1; - break; - case OPT_NAMES: - if (get_names_args(&pc)) { + case OPT_PLUGIN_PATH: + opt_plugin_path = (char *) poptGetOptArg(pc); + if (!opt_plugin_path) { ret = -EINVAL; goto end; - } + } ; break; - case OPT_FIELDS: - if (get_fields_args(&pc)) { - ret = -EINVAL; - goto end; - } + case OPT_VERBOSE: + babeltrace_verbose = 1; 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; } } - opt_input_path = poptGetArg(pc); - if (!opt_input_path) { - ret = -EINVAL; - goto end; - } - opt_output_path = poptGetArg(pc); - end: if (pc) { poptFreeContext(pc); @@ -317,270 +116,146 @@ end: return ret; } - -/* - * 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); - */ -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)) +static +const char *component_type_str(enum bt_component_type type) { - 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'; - - 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; + switch (type) { + case BT_COMPONENT_TYPE_SOURCE: + return "source"; + case BT_COMPONENT_TYPE_SINK: + return "sink"; + case BT_COMPONENT_TYPE_FILTER: + return "filter"; + case BT_COMPONENT_TYPE_UNKNOWN: + default: + return "unknown"; } +} - 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; +static +void print_detected_component_classes(struct bt_component_factory *factory) +{ + int count, i; - 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; - } + if (!babeltrace_verbose) { + return; + } - 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); - } + count = bt_component_factory_get_component_class_count(factory); + if (count <= 0) { + fprintf(stderr, "No component classes found. Please make sure your plug-in search path is set correctly."); + return; } -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 */ + printf_verbose("Found %d component classes.\n", count); + for (i = 0; i < count; i++) { + struct bt_component_class *component_class = + bt_component_factory_get_component_class_index( + factory, i); + struct bt_plugin *plugin = bt_component_class_get_plugin( + component_class); + const char *plugin_name = bt_plugin_get_name(plugin); + const char *component_name = bt_component_class_get_name( + component_class); + const char *path = bt_plugin_get_path(plugin); + const char *author = bt_plugin_get_author(plugin); + const char *license = bt_plugin_get_license(plugin); + const char *plugin_description = bt_plugin_get_description( + plugin); + const char *component_description = + bt_component_class_get_description( + component_class); + enum bt_component_type type = bt_component_class_get_type( + component_class); + + printf_verbose("[%s - %s (%s)]\n", plugin_name, component_name, + component_type_str(type)); + printf_verbose("\tpath: %s\n", path); + printf_verbose("\tauthor: %s\n", author); + printf_verbose("\tlicense: %s\n", license); + printf_verbose("\tplugin description: %s\n", + plugin_description ? plugin_description : "None"); + printf_verbose("\tcomponent description: %s\n", + component_description ? component_description : "None"); + + bt_put(plugin); + bt_put(component_class); } - g_array_free(trace_ids, TRUE); - return ret; } - - -int convert_trace(struct trace_descriptor *td_write, - struct bt_context *ctx) +static +void test_sink_notifications(struct bt_component *sink) { - 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; - } - 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(bt_ctf_get_iter(iter)); - if (ret < 0) - goto end; - } - ret = 0; - -end: - bt_ctf_iter_destroy(iter); -error_iter: - return ret; + return; } int main(int argc, char **argv) { - int ret, partial_error = 0; - struct format *fmt_write; - struct trace_descriptor *td_write; - struct bt_context *ctx; + int ret; + struct bt_component_factory *component_factory = NULL; + struct bt_component_class *source_class = NULL; + struct bt_component_class *sink_class = NULL; + struct bt_component *source = NULL, *sink = NULL; + struct bt_value *source_params = NULL, *sink_params = NULL; ret = parse_options(argc, argv); if (ret < 0) { fprintf(stderr, "Error parsing options.\n\n"); - usage(stderr); exit(EXIT_FAILURE); } else if (ret > 0) { exit(EXIT_SUCCESS); } + printf_verbose("Verbose mode active.\n"); printf_debug("Debug mode active.\n"); - 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_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", - opt_input_format ? : "ctf "); - printf_verbose("Converting to directory: %s\n", - opt_output_path ? : ""); - printf_verbose("Converting to format: %s\n", - 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); - partial_error = 1; + if (!opt_plugin_path) { + fprintf(stderr, "No plugin path specified, aborting...\n"); + ret = -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); - partial_error = 1; + printf_verbose("Looking-up plugins at %s\n", + opt_plugin_path ? opt_plugin_path : "Invalid"); + component_factory = bt_component_factory_create(); + if (!component_factory) { + fprintf(stderr, "Failed to create component factory.\n"); + ret = -1; goto end; } - 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; - } 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; + ret = bt_component_factory_load(component_factory, opt_plugin_path); + if (ret) { + fprintf(stderr, "Failed to load plugins.\n"); + goto end; } - 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 ? : ""); - goto error_td_write; - } + print_detected_component_classes(component_factory); - ret = convert_trace(td_write, ctx); - if (ret) { - fprintf(stderr, "Error printing trace.\n\n"); - goto error_copy_trace; + sink_class = bt_component_factory_get_component_class(component_factory, + NULL, BT_COMPONENT_TYPE_SINK, "text"); + if (!sink_class) { + fprintf(stderr, "Could not find text output component class. Aborting...\n"); + ret = -1; + goto end; } - fmt_write->close_trace(td_write); - - bt_context_put(ctx); - printf_verbose("finished converting. Output written to:\n%s\n", - opt_output_path ? : ""); - goto end; + sink = bt_component_create(sink_class, "bt_text_output", sink_params); + if (!sink) { + fprintf(stderr, "Failed to instanciate text output. Aborting...\n"); + ret = -1; + goto end; + } - /* Error handling */ -error_copy_trace: - fmt_write->close_trace(td_write); -error_td_write: - bt_context_put(ctx); -error_td_read: - partial_error = 1; + test_sink_notifications(sink); /* teardown and exit */ end: - free(opt_input_format); - free(opt_output_format); - if (partial_error) - exit(EXIT_FAILURE); - else - exit(EXIT_SUCCESS); + BT_PUT(component_factory); + BT_PUT(sink_class); + BT_PUT(source_class); + BT_PUT(source); + BT_PUT(sink); + BT_PUT(source_params); + BT_PUT(sink_params); + return ret ? 1 : 0; }