X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=converter%2Fbabeltrace-cfg.c;h=6e07a43749822a3d705360e6f3e5a3aceea5a5b8;hb=63ce0e1d658d528f48fd0f16d5a6748c1b369ef1;hp=e09973578555bcd4f45b14031cce4bd1abe7d794;hpb=2703153bb02ccf34e8aedbacde7ed258c73630b3;p=babeltrace.git diff --git a/converter/babeltrace-cfg.c b/converter/babeltrace-cfg.c index e0997357..6e07a437 100644 --- a/converter/babeltrace-cfg.c +++ b/converter/babeltrace-cfg.c @@ -37,6 +37,7 @@ #include #include #include "babeltrace-cfg.h" +#include "babeltrace-cfg-connect.h" #define DEFAULT_SOURCE_COMPONENT_NAME "ctf.fs" #define DEFAULT_SINK_COMPONENT_NAME "text.text" @@ -712,6 +713,10 @@ void bt_config_component_destroy(struct bt_object *obj) g_string_free(bt_config_component->component_name, TRUE); } + if (bt_config_component->instance_name) { + g_string_free(bt_config_component->instance_name, TRUE); + } + BT_PUT(bt_config_component->params); g_free(bt_config_component); @@ -727,8 +732,9 @@ end: * Return value is owned by the caller. */ static -struct bt_config_component *bt_config_component_create(const char *plugin_name, - const char *component_name) +struct bt_config_component *bt_config_component_create( + enum bt_component_class_type type, + const char *plugin_name, const char *component_name) { struct bt_config_component *cfg_component = NULL; @@ -739,6 +745,7 @@ struct bt_config_component *bt_config_component_create(const char *plugin_name, } bt_object_init(cfg_component, bt_config_component_destroy); + cfg_component->type = type; cfg_component->plugin_name = g_string_new(plugin_name); if (!cfg_component->plugin_name) { print_err_oom(); @@ -751,6 +758,12 @@ struct bt_config_component *bt_config_component_create(const char *plugin_name, goto error; } + cfg_component->instance_name = g_string_new(NULL); + if (!cfg_component->instance_name) { + print_err_oom(); + goto error; + } + /* Start with empty parameters */ cfg_component->params = bt_value_map_create(); if (!cfg_component->params) { @@ -771,8 +784,8 @@ end: * Creates a component configuration from a command-line source/sink * option's argument. */ -static -struct bt_config_component *bt_config_component_from_arg(const char *arg) +struct bt_config_component *bt_config_component_from_arg( + enum bt_component_class_type type, const char *arg) { struct bt_config_component *bt_config_component = NULL; char *plugin_name; @@ -784,7 +797,7 @@ struct bt_config_component *bt_config_component_from_arg(const char *arg) goto error; } - bt_config_component = bt_config_component_create(plugin_name, + bt_config_component = bt_config_component_create(type, plugin_name, component_name); if (!bt_config_component) { goto error; @@ -820,17 +833,36 @@ void bt_config_destroy(struct bt_object *obj) g_ptr_array_free(cfg->cmd_data.convert.sources, TRUE); } + if (cfg->cmd_data.convert.filters) { + g_ptr_array_free(cfg->cmd_data.convert.filters, TRUE); + } + if (cfg->cmd_data.convert.sinks) { g_ptr_array_free(cfg->cmd_data.convert.sinks, TRUE); } + if (cfg->cmd_data.convert.connections) { + g_ptr_array_free(cfg->cmd_data.convert.connections, + TRUE); + } + BT_PUT(cfg->cmd_data.convert.plugin_paths); break; - case BT_CONFIG_COMMAND_LIST_PLUGINS: BT_PUT(cfg->cmd_data.list_plugins.plugin_paths); break; + case BT_CONFIG_COMMAND_HELP: + BT_PUT(cfg->cmd_data.help.plugin_paths); + BT_PUT(cfg->cmd_data.help.cfg_component); + break; + case BT_CONFIG_COMMAND_QUERY_INFO: + BT_PUT(cfg->cmd_data.query_info.plugin_paths); + BT_PUT(cfg->cmd_data.query_info.cfg_component); + if (cfg->cmd_data.query_info.action) { + g_string_free(cfg->cmd_data.query_info.action, TRUE); + } + break; default: assert(false); } @@ -1334,7 +1366,7 @@ int append_sinks_from_legacy_opts(GPtrArray *sinks, component_name = "metadata-text"; break; case LEGACY_OUTPUT_FORMAT_DUMMY: - plugin_name = "dummy"; + plugin_name = "utils"; component_name = "dummy"; break; default: @@ -1361,8 +1393,8 @@ int append_sinks_from_legacy_opts(GPtrArray *sinks, } /* Create a component configuration */ - bt_config_component = bt_config_component_create(plugin_name, - component_name); + bt_config_component = bt_config_component_create( + BT_COMPONENT_CLASS_TYPE_SINK, plugin_name, component_name); if (!bt_config_component) { goto error; } @@ -1490,8 +1522,8 @@ int append_sources_from_legacy_opts(GPtrArray *sources, } /* Create a component configuration */ - bt_config_component = bt_config_component_create("ctf", - component_name); + bt_config_component = bt_config_component_create( + BT_COMPONENT_CLASS_TYPE_SOURCE, "ctf", component_name); if (!bt_config_component) { goto error; } @@ -1655,7 +1687,7 @@ void print_output_legacy_to_sinks( enum legacy_output_format legacy_output_format, struct text_legacy_opts *text_legacy_opts) { - const char *input_format; + const char *output_format; GString *str = NULL; str = g_string_new(" "); @@ -1666,22 +1698,22 @@ void print_output_legacy_to_sinks( switch (legacy_output_format) { case LEGACY_OUTPUT_FORMAT_TEXT: - input_format = "text"; + output_format = "text"; break; case LEGACY_OUTPUT_FORMAT_CTF_METADATA: - input_format = "ctf-metadata"; + output_format = "ctf-metadata"; break; case LEGACY_OUTPUT_FORMAT_DUMMY: - input_format = "dummy"; + output_format = "dummy"; break; default: assert(false); } printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n", - input_format); + output_format); printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n", - input_format); + output_format); g_string_append(str, "-o "); switch (legacy_output_format) { @@ -1692,7 +1724,7 @@ void print_output_legacy_to_sinks( g_string_append(str, "ctf.metadata-text"); break; case LEGACY_OUTPUT_FORMAT_DUMMY: - g_string_append(str, "dummy.dummy"); + g_string_append(str, "utils.dummy"); break; default: assert(false); @@ -1979,15 +2011,18 @@ enum { OPT_CLOCK_OFFSET, OPT_CLOCK_OFFSET_NS, OPT_CLOCK_SECONDS, + OPT_CONNECT, OPT_DEBUG, OPT_DEBUG_INFO_DIR, OPT_DEBUG_INFO_FULL_PATH, OPT_DEBUG_INFO_TARGET_PREFIX, OPT_END, OPT_FIELDS, + OPT_FILTER, OPT_HELP, OPT_INPUT_FORMAT, OPT_LIST, + OPT_NAME, OPT_NAMES, OPT_NO_DELTA, OPT_OMIT_HOME_PLUGIN_PATH, @@ -2191,6 +2226,13 @@ static struct bt_config *bt_config_convert_create( goto error; } + cfg->cmd_data.convert.filters = g_ptr_array_new_with_free_func( + (GDestroyNotify) bt_put); + if (!cfg->cmd_data.convert.filters) { + print_err_oom(); + goto error; + } + cfg->cmd_data.convert.sinks = g_ptr_array_new_with_free_func( (GDestroyNotify) bt_put); if (!cfg->cmd_data.convert.sinks) { @@ -2198,6 +2240,13 @@ static struct bt_config *bt_config_convert_create( goto error; } + cfg->cmd_data.convert.connections = g_ptr_array_new_with_free_func( + (GDestroyNotify) bt_config_connection_destroy); + if (!cfg->cmd_data.convert.connections) { + print_err_oom(); + goto error; + } + if (initial_plugin_paths) { cfg->cmd_data.convert.plugin_paths = bt_get(initial_plugin_paths); @@ -2251,42 +2300,174 @@ end: return cfg; } +static struct bt_config *bt_config_help_create( + struct bt_value *initial_plugin_paths) +{ + struct bt_config *cfg; + + /* Create config */ + cfg = bt_config_base_create(BT_CONFIG_COMMAND_HELP); + if (!cfg) { + print_err_oom(); + goto error; + } + + if (initial_plugin_paths) { + cfg->cmd_data.help.plugin_paths = + bt_get(initial_plugin_paths); + } else { + cfg->cmd_data.help.plugin_paths = + bt_value_array_create(); + if (!cfg->cmd_data.help.plugin_paths) { + print_err_oom(); + goto error; + } + } + + cfg->cmd_data.help.cfg_component = + bt_config_component_create(BT_COMPONENT_CLASS_TYPE_UNKNOWN, + NULL, NULL); + if (!cfg->cmd_data.help.cfg_component) { + print_err_oom(); + goto error; + } + + goto end; + +error: + BT_PUT(cfg); + +end: + return cfg; +} + +static struct bt_config *bt_config_query_info_create( + struct bt_value *initial_plugin_paths) +{ + struct bt_config *cfg; + + /* Create config */ + cfg = bt_config_base_create(BT_CONFIG_COMMAND_QUERY_INFO); + if (!cfg) { + print_err_oom(); + goto error; + } + + if (initial_plugin_paths) { + cfg->cmd_data.query_info.plugin_paths = + bt_get(initial_plugin_paths); + } else { + cfg->cmd_data.query_info.plugin_paths = + bt_value_array_create(); + if (!cfg->cmd_data.query_info.plugin_paths) { + print_err_oom(); + goto error; + } + } + + cfg->cmd_data.query_info.action = g_string_new(NULL); + if (!cfg->cmd_data.query_info.action) { + print_err_oom(); + goto error; + } + + goto end; + +error: + BT_PUT(cfg); + +end: + return cfg; +} + /* - * Prints the list-plugins command usage. + * Prints the expected format for a --params option. */ static -void print_list_plugins_usage(FILE *fp) +void print_expected_params_format(FILE *fp) { - fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] list-plugins [OPTIONS]\n"); + fprintf(fp, "Expected format of PARAMS\n"); + fprintf(fp, "-------------------------\n"); + fprintf(fp, "\n"); + fprintf(fp, " PARAM=VALUE[,PARAM=VALUE]...\n"); + fprintf(fp, "\n"); + fprintf(fp, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n"); + fprintf(fp, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n"); + fprintf(fp, "VALUE can be one of:\n"); + fprintf(fp, "\n"); + fprintf(fp, "* `null`, `nul`, `NULL`: null value (no backticks).\n"); + fprintf(fp, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n"); + fprintf(fp, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n"); + fprintf(fp, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n"); + fprintf(fp, " (`0x` prefix) signed 64-bit integer.\n"); + fprintf(fp, "* Double precision floating point number (scientific notation is accepted).\n"); + fprintf(fp, "* Unquoted string with no special characters, and not matching any of\n"); + fprintf(fp, " the null and boolean value symbols above.\n"); + fprintf(fp, "* Double-quoted string (accepts escape characters).\n"); + fprintf(fp, "\n"); + fprintf(fp, "Whitespaces are allowed around individual `=` and `,` tokens.\n"); + fprintf(fp, "\n"); + fprintf(fp, "Example:\n"); + fprintf(fp, "\n"); + fprintf(fp, " many=null, fresh=yes, condition=false, squirrel=-782329,\n"); + fprintf(fp, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n"); + fprintf(fp, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n"); + fprintf(fp, "\n"); + fprintf(fp, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n"); + fprintf(fp, "from a shell.\n"); +} + + +/* + * Prints the help command usage. + */ +static +void print_help_usage(FILE *fp) +{ + fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n"); + fprintf(fp, " babeltrace [GENERAL OPTIONS] help [OPTIONS] --source=PLUGIN.COMPCLS\n"); + fprintf(fp, " babeltrace [GENERAL OPTIONS] help [OPTIONS] --filter=PLUGIN.COMPCLS\n"); + fprintf(fp, " babeltrace [GENERAL OPTIONS] help [OPTIONS] --sink=PLUGIN.COMPCLS\n"); fprintf(fp, "\n"); fprintf(fp, "Options:\n"); fprintf(fp, "\n"); + fprintf(fp, " --filter=PLUGIN.COMPCLS Get help for the filter component class\n"); + fprintf(fp, " COMPCLS found in the plugin PLUGIN\n"); fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n"); fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n"); fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n"); fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n"); fprintf(fp, " dynamic plugins can be loaded\n"); + fprintf(fp, " --sink=PLUGIN.COMPCLS Get help for the sink component class\n"); + fprintf(fp, " COMPCLS found in the plugin PLUGIN\n"); + fprintf(fp, " --source=PLUGIN.COMPCLS Get help for the source component class\n"); + fprintf(fp, " COMPCLS found in the plugin PLUGIN\n"); fprintf(fp, " -h --help Show this help and quit\n"); fprintf(fp, "\n"); fprintf(fp, "See `babeltrace --help` for the list of general options.\n"); + fprintf(fp, "\n"); + fprintf(fp, "Use `babeltrace list-plugins` to show the list of available plugins.\n"); } -static struct poptOption list_plugins_long_options[] = { +static struct poptOption help_long_options[] = { /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ + { "filter", '\0', POPT_ARG_STRING, NULL, OPT_FILTER, NULL, NULL }, { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL }, { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL }, { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL }, + { "sink", '\0', POPT_ARG_STRING, NULL, OPT_SINK, NULL, NULL }, + { "source", '\0', POPT_ARG_STRING, NULL, OPT_SOURCE, NULL, NULL }, { NULL, 0, 0, NULL, 0, NULL, NULL }, }; /* - * Creates a Babeltrace config object from the arguments of a - * list-plugins command. + * Creates a Babeltrace config object from the arguments of a help + * command. * * *retcode is set to the appropriate exit code to use. */ -struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], +struct bt_config *bt_config_help_from_args(int argc, const char *argv[], int *retcode, bool omit_system_plugin_path, bool omit_home_plugin_path, struct bt_value *initial_plugin_paths) @@ -2297,18 +2478,19 @@ struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], int ret; struct bt_config *cfg = NULL; const char *leftover; + char *plugin_name = NULL, *component_name = NULL; + char *plugin_comp_cls_names = NULL; *retcode = 0; - cfg = bt_config_list_plugins_create(initial_plugin_paths); + cfg = bt_config_help_create(initial_plugin_paths); if (!cfg) { print_err_oom(); goto error; } - cfg->cmd_data.list_plugins.omit_system_plugin_path = omit_system_plugin_path; - cfg->cmd_data.list_plugins.omit_home_plugin_path = omit_home_plugin_path; - ret = append_env_var_plugin_paths( - cfg->cmd_data.list_plugins.plugin_paths); + cfg->cmd_data.help.omit_system_plugin_path = omit_system_plugin_path; + cfg->cmd_data.help.omit_home_plugin_path = omit_home_plugin_path; + ret = append_env_var_plugin_paths(cfg->cmd_data.help.plugin_paths); if (ret) { printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n"); goto error; @@ -2316,7 +2498,7 @@ struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], /* Parse options */ pc = poptGetContext(NULL, argc, (const char **) argv, - list_plugins_long_options, 0); + help_long_options, 0); if (!pc) { printf_err("Cannot get popt context\n"); goto error; @@ -2333,7 +2515,7 @@ struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n"); } else { if (bt_config_append_plugin_paths( - cfg->cmd_data.list_plugins.plugin_paths, + cfg->cmd_data.help.plugin_paths, arg)) { printf_err("Invalid --plugin-path option's argument:\n %s\n", arg); @@ -2342,13 +2524,45 @@ struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], } break; case OPT_OMIT_SYSTEM_PLUGIN_PATH: - cfg->cmd_data.list_plugins.omit_system_plugin_path = true; + cfg->cmd_data.help.omit_system_plugin_path = true; break; case OPT_OMIT_HOME_PLUGIN_PATH: - cfg->cmd_data.list_plugins.omit_home_plugin_path = true; + cfg->cmd_data.help.omit_home_plugin_path = true; + break; + case OPT_SOURCE: + case OPT_FILTER: + case OPT_SINK: + if (cfg->cmd_data.help.cfg_component->type != + BT_COMPONENT_CLASS_TYPE_UNKNOWN) { + printf_err("Cannot specify more than one plugin and component class:\n %s\n", + arg); + goto error; + } + + switch (opt) { + case OPT_SOURCE: + cfg->cmd_data.help.cfg_component->type = + BT_COMPONENT_CLASS_TYPE_SOURCE; + break; + case OPT_FILTER: + cfg->cmd_data.help.cfg_component->type = + BT_COMPONENT_CLASS_TYPE_FILTER; + break; + case OPT_SINK: + cfg->cmd_data.help.cfg_component->type = + BT_COMPONENT_CLASS_TYPE_SINK; + break; + default: + assert(false); + } + plugin_comp_cls_names = strdup(arg); + if (!plugin_comp_cls_names) { + print_err_oom(); + goto error; + } break; case OPT_HELP: - print_list_plugins_usage(stdout); + print_help_usage(stdout); *retcode = -1; BT_PUT(cfg); goto end; @@ -2371,14 +2585,42 @@ struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], leftover = poptGetArg(pc); if (leftover) { - printf_err("Invalid argument: %s\n", leftover); - goto error; + if (cfg->cmd_data.help.cfg_component->type != + BT_COMPONENT_CLASS_TYPE_UNKNOWN) { + printf_err("Cannot specify plugin name and --source/--filter/--sink component class:\n %s\n", + leftover); + goto error; + } + + g_string_assign(cfg->cmd_data.help.cfg_component->plugin_name, + leftover); + } else { + if (cfg->cmd_data.help.cfg_component->type == + BT_COMPONENT_CLASS_TYPE_UNKNOWN) { + print_help_usage(stdout); + *retcode = -1; + BT_PUT(cfg); + goto end; + } + + plugin_component_names_from_arg(plugin_comp_cls_names, + &plugin_name, &component_name); + if (plugin_name && component_name) { + g_string_assign(cfg->cmd_data.help.cfg_component->plugin_name, + plugin_name); + g_string_assign(cfg->cmd_data.help.cfg_component->component_name, + component_name); + } else { + printf_err("Invalid --source/--filter/--sink option's argument:\n %s\n", + plugin_comp_cls_names); + goto error; + } } if (append_home_and_system_plugin_paths( - cfg->cmd_data.list_plugins.plugin_paths, - cfg->cmd_data.list_plugins.omit_system_plugin_path, - cfg->cmd_data.list_plugins.omit_home_plugin_path)) { + cfg->cmd_data.help.plugin_paths, + cfg->cmd_data.help.omit_system_plugin_path, + cfg->cmd_data.help.omit_home_plugin_path)) { printf_err("Cannot append home and system plugin paths\n"); goto error; } @@ -2390,6 +2632,10 @@ error: BT_PUT(cfg); end: + free(plugin_comp_cls_names); + g_free(plugin_name); + g_free(component_name); + if (pc) { poptFreeContext(pc); } @@ -2398,88 +2644,481 @@ end: return cfg; } - -/* - * Prints the legacy, Babeltrace 1.x command usage. Those options are - * still compatible in Babeltrace 2.x, but it is recommended to use - * the more generic plugin/component parameters instead of those - * hard-coded option names. - */ -static -void print_legacy_usage(FILE *fp) -{ - fprintf(fp, "Usage: babeltrace [OPTIONS] INPUT...\n"); - fprintf(fp, "\n"); - fprintf(fp, "The following options are compatible with the Babeltrace 1.x options:\n"); - fprintf(fp, "\n"); - fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n"); - fprintf(fp, " across traces\n"); - fprintf(fp, " -d, --debug Enable debug mode\n"); - fprintf(fp, " -i, --input-format=FORMAT Input trace format (default: ctf)\n"); - fprintf(fp, " -l, --list List available formats\n"); - fprintf(fp, " -o, --output-format=FORMAT Output trace format (default: text)\n"); - fprintf(fp, " -v, --verbose Enable verbose output\n"); - fprintf(fp, " --help-legacy Show this help and quit\n"); - fprintf(fp, " -V, --version Show version and quit\n"); - fprintf(fp, "\n"); - fprintf(fp, " Available input formats: ctf, lttng-live, ctf-metadata\n"); - fprintf(fp, " Available output formats: text, dummy\n"); - fprintf(fp, "\n"); - fprintf(fp, "Input formats specific options:\n"); - fprintf(fp, "\n"); - fprintf(fp, " INPUT... Input trace file(s), directory(ies), or URLs\n"); - fprintf(fp, " --clock-offset=SEC Set clock offset to SEC seconds\n"); - fprintf(fp, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n"); - fprintf(fp, " --stream-intersection Only process events when all streams are active\n"); - fprintf(fp, "\n"); - fprintf(fp, "text output format specific options:\n"); - fprintf(fp, " \n"); - fprintf(fp, " --clock-cycles Print timestamps in clock cycles\n"); - fprintf(fp, " --clock-date Print timestamp dates\n"); - fprintf(fp, " --clock-gmt Print and parse timestamps in GMT time zone\n"); - fprintf(fp, " (default: local time zone)\n"); - fprintf(fp, " --clock-seconds Print the timestamps as [SEC.NS]\n"); - fprintf(fp, " (default format: [HH:MM:SS.NS])\n"); - fprintf(fp, " --debug-info-dir=DIR Search for debug info in directory DIR\n"); - fprintf(fp, " (default: `/usr/lib/debug`)\n"); - fprintf(fp, " --debug-info-full-path Show full debug info source and binary paths\n"); - fprintf(fp, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n"); - fprintf(fp, " up executables during debug info analysis\n"); - fprintf(fp, " (default: `/usr/lib/debug`)\n"); - fprintf(fp, " -f, --fields=NAME[,NAME]... Print additional fields:\n"); - fprintf(fp, " all, trace, trace:hostname, trace:domain,\n"); - fprintf(fp, " trace:procname, trace:vpid, loglevel, emf\n"); - fprintf(fp, " (default: trace:hostname, trace:procname,\n"); - fprintf(fp, " trace:vpid)\n"); - fprintf(fp, " -n, --names=NAME[,NAME]... Print field names:\n"); - fprintf(fp, " payload (or arg or args)\n"); - fprintf(fp, " none, all, scope, header, context (or ctx)\n"); - fprintf(fp, " (default: payload, context)\n"); - fprintf(fp, " --no-delta Do not print time delta between consecutive\n"); - fprintf(fp, " events\n"); - fprintf(fp, " -w, --output=PATH Write output to PATH (default: standard output)\n"); -} - /* - * Prints the convert command usage. + * Prints the help command usage. */ static -void print_convert_usage(FILE *fp) +void print_query_info_usage(FILE *fp) { - fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] convert [OPTIONS]\n"); + fprintf(fp, "Usage: babeltrace [GEN OPTS] query-info [OPTS] ACTION --source=PLUGIN.COMPCLS\n"); + fprintf(fp, " babeltrace [GEN OPTS] query-info [OPTS] ACTION --filter=PLUGIN.COMPCLS\n"); + fprintf(fp, " babeltrace [GEN OPTS] query-info [OPTS] ACTION --sink=PLUGIN.COMPCLS\n"); fprintf(fp, "\n"); fprintf(fp, "Options:\n"); fprintf(fp, "\n"); - fprintf(fp, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n"); - fprintf(fp, " for the following component instances\n"); + fprintf(fp, " --filter=PLUGIN.COMPCLS Query info from the filter component class\n"); + fprintf(fp, " COMPCLS found in the plugin PLUGIN\n"); + fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n"); + fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n"); + fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n"); + fprintf(fp, " -p, --params=PARAMS Set the query parameters to PARAMS\n"); fprintf(fp, " (see the expected format of PARAMS below)\n"); - fprintf(fp, " --begin=BEGIN Set the `begin` parameter of the latest\n"); + fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n"); + fprintf(fp, " dynamic plugins can be loaded\n"); + fprintf(fp, " --sink=PLUGIN.COMPCLS Query info from the sink component class\n"); + fprintf(fp, " COMPCLS found in the plugin PLUGIN\n"); + fprintf(fp, " --source=PLUGIN.COMPCLS Query info from the source component class\n"); + fprintf(fp, " COMPCLS found in the plugin PLUGIN\n"); + fprintf(fp, " -h --help Show this help and quit\n"); + fprintf(fp, "\n\n"); + print_expected_params_format(fp); +} + +static struct poptOption query_info_long_options[] = { + /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ + { "filter", '\0', POPT_ARG_STRING, NULL, OPT_FILTER, NULL, NULL }, + { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, + { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL }, + { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL }, + { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL }, + { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL }, + { "sink", '\0', POPT_ARG_STRING, NULL, OPT_SINK, NULL, NULL }, + { "source", '\0', POPT_ARG_STRING, NULL, OPT_SOURCE, NULL, NULL }, + { NULL, 0, 0, NULL, 0, NULL, NULL }, +}; + +/* + * Creates a Babeltrace config object from the arguments of a query-info + * command. + * + * *retcode is set to the appropriate exit code to use. + */ +struct bt_config *bt_config_query_info_from_args(int argc, const char *argv[], + int *retcode, bool omit_system_plugin_path, + bool omit_home_plugin_path, + struct bt_value *initial_plugin_paths) +{ + poptContext pc = NULL; + char *arg = NULL; + int opt; + int ret; + struct bt_config *cfg = NULL; + const char *leftover; + struct bt_value *params = bt_value_null; + + *retcode = 0; + cfg = bt_config_query_info_create(initial_plugin_paths); + if (!cfg) { + print_err_oom(); + goto error; + } + + cfg->cmd_data.query_info.omit_system_plugin_path = + omit_system_plugin_path; + cfg->cmd_data.query_info.omit_home_plugin_path = omit_home_plugin_path; + ret = append_env_var_plugin_paths(cfg->cmd_data.query_info.plugin_paths); + if (ret) { + printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n"); + goto error; + } + + /* Parse options */ + pc = poptGetContext(NULL, argc, (const char **) argv, + query_info_long_options, 0); + if (!pc) { + printf_err("Cannot get popt context\n"); + goto error; + } + + poptReadDefaultConfig(pc, 0); + + while ((opt = poptGetNextOpt(pc)) > 0) { + arg = poptGetOptArg(pc); + + switch (opt) { + case OPT_PLUGIN_PATH: + if (bt_common_is_setuid_setgid()) { + printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n"); + } else { + if (bt_config_append_plugin_paths( + cfg->cmd_data.query_info.plugin_paths, + arg)) { + printf_err("Invalid --plugin-path option's argument:\n %s\n", + arg); + goto error; + } + } + break; + case OPT_OMIT_SYSTEM_PLUGIN_PATH: + cfg->cmd_data.query_info.omit_system_plugin_path = true; + break; + case OPT_OMIT_HOME_PLUGIN_PATH: + cfg->cmd_data.query_info.omit_home_plugin_path = true; + break; + case OPT_SOURCE: + case OPT_FILTER: + case OPT_SINK: + { + enum bt_component_class_type type; + + if (cfg->cmd_data.query_info.cfg_component) { + printf_err("Cannot specify more than one plugin and component class:\n %s\n", + arg); + goto error; + } + + switch (opt) { + case OPT_SOURCE: + type = BT_COMPONENT_CLASS_TYPE_SOURCE; + break; + case OPT_FILTER: + type = BT_COMPONENT_CLASS_TYPE_FILTER; + break; + case OPT_SINK: + type = BT_COMPONENT_CLASS_TYPE_SINK; + break; + default: + assert(false); + } + + cfg->cmd_data.query_info.cfg_component = + bt_config_component_from_arg(type, arg); + if (!cfg->cmd_data.query_info.cfg_component) { + printf_err("Invalid format for --source/--filter/--sink option's argument:\n %s\n", + arg); + goto error; + } + + /* Default parameters: null */ + bt_put(cfg->cmd_data.query_info.cfg_component->params); + cfg->cmd_data.query_info.cfg_component->params = + bt_value_null; + break; + } + case OPT_PARAMS: + { + params = bt_value_from_arg(arg); + if (!params) { + printf_err("Invalid format for --params option's argument:\n %s\n", + arg); + goto error; + } + break; + } + case OPT_HELP: + print_query_info_usage(stdout); + *retcode = -1; + BT_PUT(cfg); + goto end; + default: + printf_err("Unknown command-line option specified (option code %d)\n", + opt); + goto error; + } + + free(arg); + arg = NULL; + } + + if (!cfg->cmd_data.query_info.cfg_component) { + printf_err("No target component class specified with --source/--filter/--sink option\n"); + goto error; + } + + assert(params); + BT_MOVE(cfg->cmd_data.query_info.cfg_component->params, params); + + /* Check for option parsing error */ + if (opt < -1) { + printf_err("While parsing command-line options, at option %s: %s\n", + poptBadOption(pc, 0), poptStrerror(opt)); + goto error; + } + + /* + * We need exactly one leftover argument which is the + * mandatory action. + */ + leftover = poptGetArg(pc); + if (leftover) { + if (strlen(leftover) == 0) { + printf_err("Invalid empty action\n"); + goto error; + } + + g_string_assign(cfg->cmd_data.query_info.action, leftover); + } else { + print_query_info_usage(stdout); + *retcode = -1; + BT_PUT(cfg); + goto end; + } + + leftover = poptGetArg(pc); + if (leftover) { + printf_err("Invalid argument: %s\n", leftover); + goto error; + } + + if (append_home_and_system_plugin_paths( + cfg->cmd_data.query_info.plugin_paths, + cfg->cmd_data.query_info.omit_system_plugin_path, + cfg->cmd_data.query_info.omit_home_plugin_path)) { + printf_err("Cannot append home and system plugin paths\n"); + goto error; + } + + goto end; + +error: + *retcode = 1; + BT_PUT(cfg); + +end: + if (pc) { + poptFreeContext(pc); + } + + BT_PUT(params); + free(arg); + return cfg; +} + +/* + * Prints the list-plugins command usage. + */ +static +void print_list_plugins_usage(FILE *fp) +{ + fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] list-plugins [OPTIONS]\n"); + fprintf(fp, "\n"); + fprintf(fp, "Options:\n"); + fprintf(fp, "\n"); + fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n"); + fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n"); + fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n"); + fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n"); + fprintf(fp, " dynamic plugins can be loaded\n"); + fprintf(fp, " -h --help Show this help and quit\n"); + fprintf(fp, "\n"); + fprintf(fp, "See `babeltrace --help` for the list of general options.\n"); + fprintf(fp, "\n"); + fprintf(fp, "Use `babeltrace help` to get help for a specific plugin or component class.\n"); +} + +static struct poptOption list_plugins_long_options[] = { + /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ + { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, + { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL }, + { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL }, + { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL }, + { NULL, 0, 0, NULL, 0, NULL, NULL }, +}; + +/* + * Creates a Babeltrace config object from the arguments of a + * list-plugins command. + * + * *retcode is set to the appropriate exit code to use. + */ +struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[], + int *retcode, bool omit_system_plugin_path, + bool omit_home_plugin_path, + struct bt_value *initial_plugin_paths) +{ + poptContext pc = NULL; + char *arg = NULL; + int opt; + int ret; + struct bt_config *cfg = NULL; + const char *leftover; + + *retcode = 0; + cfg = bt_config_list_plugins_create(initial_plugin_paths); + if (!cfg) { + print_err_oom(); + goto error; + } + + cfg->cmd_data.list_plugins.omit_system_plugin_path = omit_system_plugin_path; + cfg->cmd_data.list_plugins.omit_home_plugin_path = omit_home_plugin_path; + ret = append_env_var_plugin_paths( + cfg->cmd_data.list_plugins.plugin_paths); + if (ret) { + printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n"); + goto error; + } + + /* Parse options */ + pc = poptGetContext(NULL, argc, (const char **) argv, + list_plugins_long_options, 0); + if (!pc) { + printf_err("Cannot get popt context\n"); + goto error; + } + + poptReadDefaultConfig(pc, 0); + + while ((opt = poptGetNextOpt(pc)) > 0) { + arg = poptGetOptArg(pc); + + switch (opt) { + case OPT_PLUGIN_PATH: + if (bt_common_is_setuid_setgid()) { + printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n"); + } else { + if (bt_config_append_plugin_paths( + cfg->cmd_data.list_plugins.plugin_paths, + arg)) { + printf_err("Invalid --plugin-path option's argument:\n %s\n", + arg); + goto error; + } + } + break; + case OPT_OMIT_SYSTEM_PLUGIN_PATH: + cfg->cmd_data.list_plugins.omit_system_plugin_path = true; + break; + case OPT_OMIT_HOME_PLUGIN_PATH: + cfg->cmd_data.list_plugins.omit_home_plugin_path = true; + break; + case OPT_HELP: + print_list_plugins_usage(stdout); + *retcode = -1; + BT_PUT(cfg); + goto end; + default: + printf_err("Unknown command-line option specified (option code %d)\n", + opt); + goto error; + } + + free(arg); + arg = NULL; + } + + /* Check for option parsing error */ + if (opt < -1) { + printf_err("While parsing command-line options, at option %s: %s\n", + poptBadOption(pc, 0), poptStrerror(opt)); + goto error; + } + + leftover = poptGetArg(pc); + if (leftover) { + printf_err("Invalid argument: %s\n", leftover); + goto error; + } + + if (append_home_and_system_plugin_paths( + cfg->cmd_data.list_plugins.plugin_paths, + cfg->cmd_data.list_plugins.omit_system_plugin_path, + cfg->cmd_data.list_plugins.omit_home_plugin_path)) { + printf_err("Cannot append home and system plugin paths\n"); + goto error; + } + + goto end; + +error: + *retcode = 1; + BT_PUT(cfg); + +end: + if (pc) { + poptFreeContext(pc); + } + + free(arg); + return cfg; +} + +/* + * Prints the legacy, Babeltrace 1.x command usage. Those options are + * still compatible in Babeltrace 2.x, but it is recommended to use + * the more generic plugin/component parameters instead of those + * hard-coded option names. + */ +static +void print_legacy_usage(FILE *fp) +{ + fprintf(fp, "Usage: babeltrace [OPTIONS] INPUT...\n"); + fprintf(fp, "\n"); + fprintf(fp, "The following options are compatible with the Babeltrace 1.x options:\n"); + fprintf(fp, "\n"); + fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n"); + fprintf(fp, " across traces\n"); + fprintf(fp, " -d, --debug Enable debug mode\n"); + fprintf(fp, " -i, --input-format=FORMAT Input trace format (default: ctf)\n"); + fprintf(fp, " -l, --list List available formats\n"); + fprintf(fp, " -o, --output-format=FORMAT Output trace format (default: text)\n"); + fprintf(fp, " -v, --verbose Enable verbose output\n"); + fprintf(fp, " --help-legacy Show this help and quit\n"); + fprintf(fp, " -V, --version Show version and quit\n"); + fprintf(fp, "\n"); + fprintf(fp, " Available input formats: ctf, lttng-live, ctf-metadata\n"); + fprintf(fp, " Available output formats: text, dummy\n"); + fprintf(fp, "\n"); + fprintf(fp, "Input formats specific options:\n"); + fprintf(fp, "\n"); + fprintf(fp, " INPUT... Input trace file(s), directory(ies), or URLs\n"); + fprintf(fp, " --clock-offset=SEC Set clock offset to SEC seconds\n"); + fprintf(fp, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n"); + fprintf(fp, " --stream-intersection Only process events when all streams are active\n"); + fprintf(fp, "\n"); + fprintf(fp, "text output format specific options:\n"); + fprintf(fp, " \n"); + fprintf(fp, " --clock-cycles Print timestamps in clock cycles\n"); + fprintf(fp, " --clock-date Print timestamp dates\n"); + fprintf(fp, " --clock-gmt Print and parse timestamps in GMT time zone\n"); + fprintf(fp, " (default: local time zone)\n"); + fprintf(fp, " --clock-seconds Print the timestamps as [SEC.NS]\n"); + fprintf(fp, " (default format: [HH:MM:SS.NS])\n"); + fprintf(fp, " --debug-info-dir=DIR Search for debug info in directory DIR\n"); + fprintf(fp, " (default: `/usr/lib/debug`)\n"); + fprintf(fp, " --debug-info-full-path Show full debug info source and binary paths\n"); + fprintf(fp, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n"); + fprintf(fp, " up executables during debug info analysis\n"); + fprintf(fp, " (default: `/usr/lib/debug`)\n"); + fprintf(fp, " -f, --fields=NAME[,NAME]... Print additional fields:\n"); + fprintf(fp, " all, trace, trace:hostname, trace:domain,\n"); + fprintf(fp, " trace:procname, trace:vpid, loglevel, emf\n"); + fprintf(fp, " (default: trace:hostname, trace:procname,\n"); + fprintf(fp, " trace:vpid)\n"); + fprintf(fp, " -n, --names=NAME[,NAME]... Print field names:\n"); + fprintf(fp, " payload (or arg or args)\n"); + fprintf(fp, " none, all, scope, header, context (or ctx)\n"); + fprintf(fp, " (default: payload, context)\n"); + fprintf(fp, " --no-delta Do not print time delta between consecutive\n"); + fprintf(fp, " events\n"); + fprintf(fp, " -w, --output=PATH Write output to PATH (default: standard output)\n"); +} + +/* + * Prints the convert command usage. + */ +static +void print_convert_usage(FILE *fp) +{ + fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] convert [OPTIONS]\n"); + fprintf(fp, "\n"); + fprintf(fp, "Options:\n"); + fprintf(fp, "\n"); + fprintf(fp, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n"); + fprintf(fp, " for the following component instances\n"); + fprintf(fp, " (see the expected format of PARAMS below)\n"); + fprintf(fp, " --begin=BEGIN Set the `begin` parameter of the latest\n"); fprintf(fp, " source component instance to BEGIN\n"); fprintf(fp, " (see the suggested format of BEGIN below)\n"); + fprintf(fp, " -c, --connect=CONNECTION Connect two component instances (see the\n"); + fprintf(fp, " expected format of CONNECTION below)\n"); fprintf(fp, " -d, --debug Enable debug mode\n"); fprintf(fp, " --end=END Set the `end` parameter of the latest\n"); fprintf(fp, " source component instance to END\n"); fprintf(fp, " (see the suggested format of BEGIN below)\n"); + fprintf(fp, " --name=NAME Set the name of the latest component\n"); + fprintf(fp, " instance to NAME (must be unique amongst\n"); + fprintf(fp, " all the names of the component instances)\n"); fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n"); fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n"); fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n"); @@ -2512,35 +3151,27 @@ void print_convert_usage(FILE *fp) fprintf(fp, "\n"); fprintf(fp, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n"); fprintf(fp, "\n\n"); - fprintf(fp, "Expected format of PARAMS\n"); - fprintf(fp, "-------------------------\n"); + fprintf(fp, "Expected format of CONNECTION\n"); + fprintf(fp, "-----------------------------\n"); fprintf(fp, "\n"); - fprintf(fp, " PARAM=VALUE[,PARAM=VALUE]...\n"); + fprintf(fp, " SRC[.SRCPORT]:DST[.DSTPORT]\n"); fprintf(fp, "\n"); - fprintf(fp, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n"); - fprintf(fp, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n"); - fprintf(fp, "VALUE can be one of:\n"); + fprintf(fp, "SRC and DST are the names of the source and destination component\n"); + fprintf(fp, "instances to connect together. You can set the name of a component\n"); + fprintf(fp, "instance with the --name option.\n"); fprintf(fp, "\n"); - fprintf(fp, "* `null`, `nul`, `NULL`: null value (no backticks).\n"); - fprintf(fp, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n"); - fprintf(fp, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n"); - fprintf(fp, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n"); - fprintf(fp, " (`0x` prefix) signed 64-bit integer.\n"); - fprintf(fp, "* Double precision floating point number (scientific notation is accepted).\n"); - fprintf(fp, "* Unquoted string with no special characters, and not matching any of\n"); - fprintf(fp, " the null and boolean value symbols above.\n"); - fprintf(fp, "* Double-quoted string (accepts escape characters).\n"); + fprintf(fp, "SRCPORT and DSTPORT are the optional source and destination ports to use\n"); + fprintf(fp, "for the connection. When the port is not specified, the default port is\n"); + fprintf(fp, "used.\n"); fprintf(fp, "\n"); - fprintf(fp, "Whitespaces are allowed around individual `=` and `,` tokens.\n"); + fprintf(fp, "You can connect a source component to a filter or sink component. You\n"); + fprintf(fp, "can connect a filter component to a sink component.\n"); fprintf(fp, "\n"); fprintf(fp, "Example:\n"); fprintf(fp, "\n"); - fprintf(fp, " many=null, fresh=yes, condition=false, squirrel=-782329,\n"); - fprintf(fp, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n"); - fprintf(fp, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n"); - fprintf(fp, "\n"); - fprintf(fp, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n"); - fprintf(fp, "from a shell.\n"); + fprintf(fp, " my-filter.top10:json-out\n"); + fprintf(fp, "\n\n"); + print_expected_params_format(fp); } static struct poptOption convert_long_options[] = { @@ -2554,6 +3185,7 @@ static struct poptOption convert_long_options[] = { { "clock-offset", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL }, { "clock-offset-ns", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL }, { "clock-seconds", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL }, + { "connect", 'c', POPT_ARG_STRING, NULL, OPT_CONNECT, NULL, NULL }, { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL }, { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL }, { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL }, @@ -2562,6 +3194,7 @@ static struct poptOption convert_long_options[] = { { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL }, { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL }, + { "name", '\0', POPT_ARG_STRING, NULL, OPT_NAME, NULL, NULL }, { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL }, { "no-delta", '\0', POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL }, { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL }, @@ -2608,6 +3241,9 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], struct bt_value *cur_base_params = NULL; int opt, ret = 0; struct bt_config *cfg = NULL; + struct bt_value *instance_names = NULL; + struct bt_value *connection_args = NULL; + char error_buf[256] = { 0 }; *retcode = 0; memset(&ctf_legacy_opts, 0, sizeof(ctf_legacy_opts)); @@ -2657,6 +3293,18 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], goto error; } + instance_names = bt_value_map_create(); + if (!instance_names) { + print_err_oom(); + goto error; + } + + connection_args = bt_value_array_create(); + if (!connection_args) { + print_err_oom(); + goto error; + } + ret = append_env_var_plugin_paths(cfg->cmd_data.convert.plugin_paths); if (ret) { printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n"); @@ -2664,16 +3312,17 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], } /* Note: implicit source never gets positional base params. */ - implicit_source_comp = bt_config_component_from_arg(DEFAULT_SOURCE_COMPONENT_NAME); - if (implicit_source_comp) { - cur_cfg_comp = implicit_source_comp; - cur_is_implicit_source = true; - use_implicit_source = true; - } else { - printf_debug("Cannot find implicit source plugin `%s`", - DEFAULT_SOURCE_COMPONENT_NAME); + implicit_source_comp = bt_config_component_from_arg( + BT_COMPONENT_CLASS_TYPE_SOURCE, DEFAULT_SOURCE_COMPONENT_NAME); + if (!implicit_source_comp) { + print_err_oom(); + goto error; } + cur_cfg_comp = implicit_source_comp; + cur_is_implicit_source = true; + use_implicit_source = true; + /* Parse options */ pc = poptGetContext(NULL, argc, (const char **) argv, convert_long_options, 0); @@ -2766,7 +3415,8 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], cur_cfg_comp_dest); } - cur_cfg_comp = bt_config_component_from_arg(arg); + cur_cfg_comp = bt_config_component_from_arg( + BT_COMPONENT_CLASS_TYPE_SOURCE, arg); if (!cur_cfg_comp) { printf_err("Invalid format for --source option's argument:\n %s\n", arg); @@ -2828,7 +3478,8 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], cur_cfg_comp_dest); } - cur_cfg_comp = bt_config_component_from_arg(arg); + cur_cfg_comp = bt_config_component_from_arg( + BT_COMPONENT_CLASS_TYPE_SINK, arg); if (!cur_cfg_comp) { printf_err("Invalid format for --sink option's argument:\n %s\n", arg); @@ -2892,6 +3543,27 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], goto error; } break; + case OPT_NAME: + if (!cur_cfg_comp) { + printf_err("Cannot set the name of unavailable default source component `%s`:\n %s\n", + DEFAULT_SOURCE_COMPONENT_NAME, arg); + goto error; + } + + if (bt_value_map_has_key(instance_names, arg)) { + printf_err("Duplicate component instance name:\n %s\n", + arg); + goto error; + } + + g_string_assign(cur_cfg_comp->instance_name, arg); + + if (bt_value_map_insert(instance_names, + arg, bt_value_null)) { + print_err_oom(); + goto error; + } + break; case OPT_BASE_PARAMS: { struct bt_value *params = bt_value_from_arg(arg); @@ -3064,6 +3736,13 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], } break; } + case OPT_CONNECT: + if (bt_value_array_append_string(connection_args, + arg)) { + print_err_oom(); + goto error; + } + break; case OPT_HELP: print_convert_usage(stdout); *retcode = -1; @@ -3176,7 +3855,9 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], if (cfg->cmd_data.convert.sinks->len == 0) { /* Use implicit sink as default. */ - cur_cfg_comp = bt_config_component_from_arg(DEFAULT_SINK_COMPONENT_NAME); + cur_cfg_comp = bt_config_component_from_arg( + BT_COMPONENT_CLASS_TYPE_SINK, + DEFAULT_SINK_COMPONENT_NAME); if (!cur_cfg_comp) { printf_error("Cannot find implicit sink plugin `%s`\n", DEFAULT_SINK_COMPONENT_NAME); @@ -3186,6 +3867,13 @@ struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], cur_cfg_comp = NULL; } + ret = bt_config_create_connections(cfg, connection_args, + error_buf, 256); + if (ret) { + printf_err("Cannot creation connections:\n%s", error_buf); + goto error; + } + goto end; error: @@ -3216,6 +3904,8 @@ end: BT_PUT(text_legacy_opts.names); BT_PUT(text_legacy_opts.fields); BT_PUT(legacy_input_paths); + BT_PUT(instance_names); + BT_PUT(connection_args); return cfg; } @@ -3238,7 +3928,9 @@ void print_gen_usage(FILE *fp) fprintf(fp, "Available commands:\n"); fprintf(fp, "\n"); fprintf(fp, " convert Build a trace conversion graph and run it (default)\n"); + fprintf(fp, " help Get help for a plugin or a component class\n"); fprintf(fp, " list-plugins List available plugins and their content\n"); + fprintf(fp, " query-info Query information from a component class\n"); fprintf(fp, "\n"); fprintf(fp, "Use `babeltrace COMMAND --help` to show the help of COMMAND.\n"); } @@ -3285,20 +3977,20 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], print_legacy_usage(stdout); goto end; } else { + bool has_command = true; + /* * First unknown argument: is it a known command * name? */ if (strcmp(cur_arg, "convert") == 0) { command = BT_CONFIG_COMMAND_CONVERT; - command_argv = &argv[i]; - command_argc = argc - i; - command_name = cur_arg; } else if (strcmp(cur_arg, "list-plugins") == 0) { command = BT_CONFIG_COMMAND_LIST_PLUGINS; - command_argv = &argv[i]; - command_argc = argc - i; - command_name = cur_arg; + } else if (strcmp(cur_arg, "help") == 0) { + command = BT_CONFIG_COMMAND_HELP; + } else if (strcmp(cur_arg, "query-info") == 0) { + command = BT_CONFIG_COMMAND_QUERY_INFO; } else { /* * Unknown argument, but not a known @@ -3309,6 +4001,13 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], command = BT_CONFIG_COMMAND_CONVERT; command_argv = argv; command_argc = argc; + has_command = false; + } + + if (has_command) { + command_argv = &argv[i]; + command_argc = argc - i; + command_name = cur_arg; } break; } @@ -3339,6 +4038,16 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], command_argv, retcode, omit_system_plugin_path, omit_home_plugin_path, initial_plugin_paths); break; + case BT_CONFIG_COMMAND_HELP: + config = bt_config_help_from_args(command_argc, + command_argv, retcode, omit_system_plugin_path, + omit_home_plugin_path, initial_plugin_paths); + break; + case BT_CONFIG_COMMAND_QUERY_INFO: + config = bt_config_query_info_from_args(command_argc, + command_argv, retcode, omit_system_plugin_path, + omit_home_plugin_path, initial_plugin_paths); + break; default: assert(false); }