#include "babeltrace2-cfg-cli-args-connect.h"
#include "babeltrace2-cfg-cli-params-arg.h"
#include "babeltrace2-plugins.h"
-#include "babeltrace2-cfg-src-auto-disc.h"
+#include "babeltrace2-query.h"
+#include "autodisc/autodisc.h"
#include "common/version.h"
static const int cli_default_log_level = BT_LOG_WARNING;
goto end;
}
- for (i = 0; i < bt_value_array_get_size(names_array); i++) {
+ for (i = 0; i < bt_value_array_get_length(names_array); i++) {
const bt_value *str_obj =
bt_value_array_borrow_element_by_index_const(names_array,
i);
return -1;
}
-static
-int append_home_and_system_plugin_paths_cfg(struct bt_config *cfg)
-{
- return append_home_and_system_plugin_paths(cfg->plugin_paths,
- cfg->omit_system_plugin_path, cfg->omit_home_plugin_path);
-}
-
static
struct bt_config *bt_config_base_create(enum bt_config_command command,
- const bt_value *initial_plugin_paths,
- bool needs_plugins)
+ const bt_value *plugin_paths, bool needs_plugins)
{
struct bt_config *cfg;
cfg->command = command;
cfg->command_needs_plugins = needs_plugins;
- if (initial_plugin_paths) {
- bt_value *initial_plugin_paths_copy;
+ if (plugin_paths) {
+ bt_value *plugin_paths_copy;
- (void) bt_value_copy(initial_plugin_paths,
- &initial_plugin_paths_copy);
- cfg->plugin_paths = initial_plugin_paths_copy;
+ (void) bt_value_copy(plugin_paths,
+ &plugin_paths_copy);
+ cfg->plugin_paths = plugin_paths_copy;
} else {
cfg->plugin_paths = bt_value_array_create();
if (!cfg->plugin_paths) {
}
static
-struct bt_config *bt_config_run_create(
- const bt_value *initial_plugin_paths)
+struct bt_config *bt_config_run_create(const bt_value *plugin_paths)
{
struct bt_config *cfg;
/* Create config */
cfg = bt_config_base_create(BT_CONFIG_COMMAND_RUN,
- initial_plugin_paths, true);
+ plugin_paths, true);
if (!cfg) {
goto error;
}
}
static
-struct bt_config *bt_config_list_plugins_create(
- const bt_value *initial_plugin_paths)
+struct bt_config *bt_config_list_plugins_create(const bt_value *plugin_paths)
{
- struct bt_config *cfg;
-
- /* Create config */
- cfg = bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS,
- initial_plugin_paths, true);
- if (!cfg) {
- goto error;
- }
-
- goto end;
-
-error:
- BT_OBJECT_PUT_REF_AND_RESET(cfg);
-
-end:
- return cfg;
+ return bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS,
+ plugin_paths, true);
}
static
-struct bt_config *bt_config_help_create(
- const bt_value *initial_plugin_paths,
+struct bt_config *bt_config_help_create(const bt_value *plugin_paths,
int default_log_level)
{
struct bt_config *cfg;
/* Create config */
cfg = bt_config_base_create(BT_CONFIG_COMMAND_HELP,
- initial_plugin_paths, true);
+ plugin_paths, true);
if (!cfg) {
goto error;
}
}
static
-struct bt_config *bt_config_query_create(
- const bt_value *initial_plugin_paths)
+struct bt_config *bt_config_query_create(const bt_value *plugin_paths)
{
struct bt_config *cfg;
/* Create config */
cfg = bt_config_base_create(BT_CONFIG_COMMAND_QUERY,
- initial_plugin_paths, true);
+ plugin_paths, true);
if (!cfg) {
goto error;
}
static
struct bt_config *bt_config_print_ctf_metadata_create(
- const bt_value *initial_plugin_paths)
+ const bt_value *plugin_paths)
{
struct bt_config *cfg;
/* Create config */
cfg = bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA,
- initial_plugin_paths, true);
+ plugin_paths, true);
if (!cfg) {
goto error;
}
static
struct bt_config *bt_config_print_lttng_live_sessions_create(
- const bt_value *initial_plugin_paths)
+ const bt_value *plugin_paths)
{
struct bt_config *cfg;
/* Create config */
cfg = bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS,
- initial_plugin_paths, true);
+ plugin_paths, true);
if (!cfg) {
goto error;
}
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/babeltrace2/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, " -h, --help Show this help and quit\n");
fprintf(fp, "\n");
fprintf(fp, "See `babeltrace2 --help` for the list of general options.\n");
fprintf(fp, "\n");
const struct bt_argpar_opt_descr help_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_HELP, 'h', "help", false },
- { OPT_OMIT_HOME_PLUGIN_PATH, '\0', "omit-home-plugin-path", false },
- { OPT_OMIT_SYSTEM_PLUGIN_PATH, '\0', "omit-system-plugin-path", false },
- { OPT_PLUGIN_PATH, '\0', "plugin-path", true },
BT_ARGPAR_OPT_DESCR_SENTINEL
};
*/
static
struct bt_config *bt_config_help_from_args(int argc, const char *argv[],
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
- const bt_value *initial_plugin_paths, int default_log_level)
+ int *retcode, const bt_value *plugin_paths,
+ int default_log_level)
{
- int ret, i;
struct bt_config *cfg = NULL;
- const char *leftover = NULL;
char *plugin_name = NULL, *comp_cls_name = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret;
+ struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ struct bt_argpar_item_non_opt *non_opt;
*retcode = 0;
- cfg = bt_config_help_create(initial_plugin_paths, default_log_level);
+ cfg = bt_config_help_create(plugin_paths, default_log_level);
if (!cfg) {
goto error;
}
- cfg->omit_system_plugin_path = force_omit_system_plugin_path;
- cfg->omit_home_plugin_path = force_omit_home_plugin_path;
- ret = append_env_var_plugin_paths(cfg->plugin_paths);
- if (ret) {
- goto error;
- }
-
/* Parse options */
argpar_parse_ret = bt_argpar_parse(argc, argv, help_options, true);
if (argpar_parse_ret.error) {
goto end;
}
- for (i = 0; i < argpar_parse_ret.items->len; i++) {
- struct bt_argpar_item *argpar_item =
- g_ptr_array_index(argpar_parse_ret.items, i);
-
- if (argpar_item->type == BT_ARGPAR_ITEM_TYPE_OPT) {
- struct bt_argpar_item_opt *argpar_item_opt;
- const char *arg;
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
- arg = argpar_item_opt->arg;
-
- switch (argpar_item_opt->descr->id) {
- case OPT_PLUGIN_PATH:
- if (bt_config_append_plugin_paths_check_setuid_setgid(
- cfg->plugin_paths, arg)) {
- goto error;
- }
- break;
- case OPT_OMIT_SYSTEM_PLUGIN_PATH:
- cfg->omit_system_plugin_path = true;
- break;
- case OPT_OMIT_HOME_PLUGIN_PATH:
- cfg->omit_home_plugin_path = true;
- break;
- default:
- BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
- argpar_item_opt->descr->id);
- goto error;
- }
- } else {
- struct bt_argpar_item_non_opt *argpar_item_non_opt
- = (struct bt_argpar_item_non_opt *) argpar_item;
-
- if (leftover) {
- BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `help` command: `%s`.",
- argpar_item_non_opt->arg);
- goto error;
- }
-
- leftover = argpar_item_non_opt->arg;
- }
+ if (argpar_parse_ret.items->len == 0) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Missing plugin name or component class descriptor.");
+ goto error;
+ } else if (argpar_parse_ret.items->len > 1) {
+ /*
+ * At this point we know there are least two non-option
+ * arguments because we don't reach here with `--help`,
+ * the only option.
+ */
+ non_opt = argpar_parse_ret.items->pdata[1];
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Extraneous command-line argument specified to `help` command: `%s`.",
+ non_opt->arg);
+ goto error;
}
- if (leftover) {
- plugin_comp_cls_names(leftover, NULL,
- &plugin_name, &comp_cls_name,
- &cfg->cmd_data.help.cfg_component->type);
- if (plugin_name && comp_cls_name) {
- /* Component class help */
- g_string_assign(
- cfg->cmd_data.help.cfg_component->plugin_name,
- plugin_name);
- g_string_assign(
- cfg->cmd_data.help.cfg_component->comp_cls_name,
- comp_cls_name);
- } else {
- /* Fall back to plugin help */
- g_string_assign(
- cfg->cmd_data.help.cfg_component->plugin_name,
- leftover);
- }
+ non_opt = argpar_parse_ret.items->pdata[0];
+ plugin_comp_cls_names(non_opt->arg, NULL, &plugin_name, &comp_cls_name,
+ &cfg->cmd_data.help.cfg_component->type);
+ if (plugin_name && comp_cls_name) {
+ /* Component class help */
+ g_string_assign(cfg->cmd_data.help.cfg_component->plugin_name,
+ plugin_name);
+ g_string_assign(cfg->cmd_data.help.cfg_component->comp_cls_name,
+ comp_cls_name);
} else {
- print_help_usage(stdout);
- *retcode = -1;
- BT_OBJECT_PUT_REF_AND_RESET(cfg);
- goto end;
- }
-
- if (append_home_and_system_plugin_paths_cfg(cfg)) {
- goto error;
+ /* Fall back to plugin help */
+ g_string_assign(cfg->cmd_data.help.cfg_component->plugin_name,
+ non_opt->arg);
}
goto end;
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/babeltrace2/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, " --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, " -p, --params=PARAMS Set the query parameters to PARAMS (see the expected\n");
+ fprintf(fp, " format of PARAMS below)\n");
+ fprintf(fp, " -h, --help Show this help and quit\n");
fprintf(fp, "\n\n");
print_expected_params_format(fp);
}
const struct bt_argpar_opt_descr query_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_HELP, 'h', "help", false },
- { OPT_OMIT_HOME_PLUGIN_PATH, '\0', "omit-home-plugin-path", false },
- { OPT_OMIT_SYSTEM_PLUGIN_PATH, '\0', "omit-system-plugin-path", false },
{ OPT_PARAMS, 'p', "params", true },
- { OPT_PLUGIN_PATH, '\0', "plugin-path", true },
BT_ARGPAR_OPT_DESCR_SENTINEL
};
*/
static
struct bt_config *bt_config_query_from_args(int argc, const char *argv[],
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
- const bt_value *initial_plugin_paths,
+ int *retcode, const bt_value *plugin_paths,
int default_log_level)
{
- int ret, i;
+ int i;
struct bt_config *cfg = NULL;
const char *component_class_spec = NULL;
const char *query_object = NULL;
bt_value *params;
GString *error_str = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret;
+ struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
params = bt_value_null;
bt_value_get_ref(bt_value_null);
*retcode = 0;
- cfg = bt_config_query_create(initial_plugin_paths);
+ cfg = bt_config_query_create(plugin_paths);
if (!cfg) {
goto error;
}
goto error;
}
- cfg->omit_system_plugin_path = force_omit_system_plugin_path;
- cfg->omit_home_plugin_path = force_omit_home_plugin_path;
- ret = append_env_var_plugin_paths(cfg->plugin_paths);
- if (ret) {
- goto error;
- }
-
/* Parse options */
argpar_parse_ret = bt_argpar_parse(argc, argv, query_options, true);
if (argpar_parse_ret.error) {
const char *arg = argpar_item_opt->arg;
switch (argpar_item_opt->descr->id) {
- case OPT_PLUGIN_PATH:
- if (bt_config_append_plugin_paths_check_setuid_setgid(
- cfg->plugin_paths, arg)) {
- goto error;
- }
- break;
- case OPT_OMIT_SYSTEM_PLUGIN_PATH:
- cfg->omit_system_plugin_path = true;
- break;
- case OPT_OMIT_HOME_PLUGIN_PATH:
- cfg->omit_home_plugin_path = true;
- break;
case OPT_PARAMS:
{
bt_value_put_ref(params);
= (struct bt_argpar_item_non_opt *) argpar_item;
/*
- * We need exactly two leftover arguments which are the
- * mandatory component class specification and query object.
+ * We need exactly two non-option arguments
+ * which are the mandatory component class
+ * specification and query object.
*/
if (!component_class_spec) {
component_class_spec = argpar_item_non_opt->arg;
}
g_string_assign(cfg->cmd_data.query.object, query_object);
-
- if (append_home_and_system_plugin_paths_cfg(cfg)) {
- goto error;
- }
-
goto end;
error:
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/babeltrace2/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 `babeltrace2 --help` for the list of general options.\n");
const struct bt_argpar_opt_descr list_plugins_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_HELP, 'h', "help", false },
- { OPT_OMIT_HOME_PLUGIN_PATH, '\0', "omit-home-plugin-path", false },
- { OPT_OMIT_SYSTEM_PLUGIN_PATH, '\0', "omit-system-plugin-path", false },
- { OPT_PLUGIN_PATH, '\0', "plugin-path", true },
BT_ARGPAR_OPT_DESCR_SENTINEL
};
*/
static
struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[],
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
- const bt_value *initial_plugin_paths)
+ int *retcode, const bt_value *plugin_paths)
{
- int ret, i;
struct bt_config *cfg = NULL;
struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
*retcode = 0;
- cfg = bt_config_list_plugins_create(initial_plugin_paths);
+ cfg = bt_config_list_plugins_create(plugin_paths);
if (!cfg) {
goto error;
}
- cfg->omit_system_plugin_path = force_omit_system_plugin_path;
- cfg->omit_home_plugin_path = force_omit_home_plugin_path;
- ret = append_env_var_plugin_paths(cfg->plugin_paths);
- if (ret) {
- goto error;
- }
-
/* Parse options */
argpar_parse_ret = bt_argpar_parse(argc, argv, list_plugins_options, true);
if (argpar_parse_ret.error) {
goto end;
}
- for (i = 0; i < argpar_parse_ret.items->len; i++) {
- struct bt_argpar_item *argpar_item =
- g_ptr_array_index(argpar_parse_ret.items, i);
- struct bt_argpar_item_opt *argpar_item_opt;
- const char *arg;
-
- if (argpar_item->type == BT_ARGPAR_ITEM_TYPE_NON_OPT) {
- struct bt_argpar_item_non_opt *argpar_item_non_opt
- = (struct bt_argpar_item_non_opt *) argpar_item;
-
- BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`.",
- argpar_item_non_opt->arg);
- goto error;
- }
-
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
- arg = argpar_item_opt->arg;
-
- switch (argpar_item_opt->descr->id) {
- case OPT_PLUGIN_PATH:
- if (bt_config_append_plugin_paths_check_setuid_setgid(
- cfg->plugin_paths, arg)) {
- goto error;
- }
- break;
- case OPT_OMIT_SYSTEM_PLUGIN_PATH:
- cfg->omit_system_plugin_path = true;
- break;
- case OPT_OMIT_HOME_PLUGIN_PATH:
- cfg->omit_home_plugin_path = true;
- break;
- default:
- BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
- argpar_item_opt->descr->id);
- goto error;
- }
- }
+ if (argpar_parse_ret.items->len > 0) {
+ /*
+ * At this point we know there's at least one non-option
+ * argument because we don't reach here with `--help`,
+ * the only option.
+ */
+ struct bt_argpar_item_non_opt *non_opt =
+ argpar_parse_ret.items->pdata[0];
- if (append_home_and_system_plugin_paths_cfg(cfg)) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
+ non_opt->arg);
goto error;
}
fprintf(fp, " expected format of CONNECTION below)\n");
fprintf(fp, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
fprintf(fp, " (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
- fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
- fprintf(fp, " (~/.local/lib/babeltrace2/plugins)\n");
- fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
fprintf(fp, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
fprintf(fp, " current component (see the expected format\n");
fprintf(fp, " of PARAMS below)\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, " -r, --reset-base-params Reset the current base parameters to an\n");
fprintf(fp, " empty map\n");
fprintf(fp, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
*/
static
struct bt_config *bt_config_run_from_args(int argc, const char *argv[],
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
- const bt_value *initial_plugin_paths, int default_log_level)
+ int *retcode, const bt_value *plugin_paths,
+ int default_log_level)
{
struct bt_config_component *cur_cfg_comp = NULL;
bt_value *cur_base_params = NULL;
{ OPT_CONNECT, 'x', "connect", true },
{ OPT_HELP, 'h', "help", false },
{ OPT_LOG_LEVEL, 'l', "log-level", true },
- { OPT_OMIT_HOME_PLUGIN_PATH, '\0', "omit-home-plugin-path", false },
- { OPT_OMIT_SYSTEM_PLUGIN_PATH, '\0', "omit-system-plugin-path", false },
{ OPT_PARAMS, 'p', "params", true },
- { OPT_PLUGIN_PATH, '\0', "plugin-path", true },
{ OPT_RESET_BASE_PARAMS, 'r', "reset-base-params", false },
{ OPT_RETRY_DURATION, '\0', "retry-duration", true },
BT_ARGPAR_OPT_DESCR_SENTINEL
goto end;
}
- cfg = bt_config_run_create(initial_plugin_paths);
+ cfg = bt_config_run_create(plugin_paths);
if (!cfg) {
goto error;
}
cfg->cmd_data.run.retry_duration_us = 100000;
- cfg->omit_system_plugin_path = force_omit_system_plugin_path;
- cfg->omit_home_plugin_path = force_omit_home_plugin_path;
cur_base_params = bt_value_map_create();
if (!cur_base_params) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- ret = append_env_var_plugin_paths(cfg->plugin_paths);
- if (ret) {
- goto error;
- }
-
/* Parse options */
argpar_parse_ret = bt_argpar_parse(argc, argv, run_options, true);
if (argpar_parse_ret.error) {
struct bt_argpar_item_opt *argpar_item_opt;
const char *arg;
- /* This command does not accept leftover arguments. */
+ /* This command does not accept non-option arguments.*/
if (argpar_item->type == BT_ARGPAR_ITEM_TYPE_NON_OPT) {
struct bt_argpar_item_non_opt *argpar_nonopt_item =
(struct bt_argpar_item_non_opt *) argpar_item;
arg = argpar_item_opt->arg;
switch (argpar_item_opt->descr->id) {
- case OPT_PLUGIN_PATH:
- if (bt_config_append_plugin_paths_check_setuid_setgid(
- cfg->plugin_paths, arg)) {
- goto error;
- }
- break;
- case OPT_OMIT_SYSTEM_PLUGIN_PATH:
- cfg->omit_system_plugin_path = true;
- break;
- case OPT_OMIT_HOME_PLUGIN_PATH:
- cfg->omit_home_plugin_path = true;
- break;
case OPT_COMPONENT:
{
enum bt_config_component_dest dest;
goto error;
}
- if (append_home_and_system_plugin_paths_cfg(cfg)) {
- goto error;
- }
-
ret = bt_config_cli_args_create_connections(cfg,
connection_args,
error_buf, 256);
static
struct bt_config *bt_config_run_from_args_array(const bt_value *run_args,
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
- const bt_value *initial_plugin_paths, int default_log_level)
+ int *retcode, const bt_value *plugin_paths,
+ int default_log_level)
{
struct bt_config *cfg = NULL;
const char **argv;
int64_t i, len;
- const size_t argc = bt_value_array_get_size(run_args);
+ const size_t argc = bt_value_array_get_length(run_args);
argv = calloc(argc, sizeof(*argv));
if (!argv) {
goto end;
}
- len = bt_value_array_get_size(run_args);
+ len = bt_value_array_get_length(run_args);
if (len < 0) {
BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
goto end;
}
cfg = bt_config_run_from_args(argc, argv, retcode,
- force_omit_system_plugin_path, force_omit_home_plugin_path,
- initial_plugin_paths, default_log_level);
+ plugin_paths, default_log_level);
end:
free(argv);
fprintf(fp, " NAME\n");
fprintf(fp, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
fprintf(fp, " (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
- fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
- fprintf(fp, " (~/.local/lib/babeltrace2/plugins)\n");
- fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
fprintf(fp, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
fprintf(fp, " current component (see the expected format\n");
fprintf(fp, " of PARAMS below)\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, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
fprintf(fp, " the graph later, retry in DUR µs\n");
fprintf(fp, " (default: 100000)\n");
}
}
- for (i = 0; i < bt_value_array_get_size(impl_args->extra_params);
+ for (i = 0; i < bt_value_array_get_length(impl_args->extra_params);
i++) {
const bt_value *elem;
const char *arg;
}
case BT_VALUE_TYPE_ARRAY: {
g_string_append_c(buf, '[');
- uint64_t sz = bt_value_array_get_size(value);
+ uint64_t sz = bt_value_array_get_length(value);
for (uint64_t i = 0; i < sz; i++) {
const bt_value *item;
int ret;
}
/*
- * Create `struct implicit_component_args` structures for each of the source
- * components we identified. Add them to `component_args`.
+ * Create `struct implicit_component_args` structures for each of the
+ * source components we identified. Add them to `component_args`.
*
- * `leftover_params` is an array where each element is an array of strings
- * containing all the arguments to `--params` that apply to the leftover at the
- * same index. For example, if, for a leftover, the following `--params`
- * options applied:
+ * `non_opt_params` is an array where each element is an array of
+ * strings containing all the arguments to `--params` that apply to the
+ * non-option argument at the same index. For example, if, for a
+ * non-option argument, the following `--params` options applied:
*
* --params=a=2 --params=b=3,c=4
*
- * its entry in `leftover_params` would contain
+ * its entry in `non_opt_params` would contain
*
* ["a=2", "b=3,c=4"]
*/
static
int create_implicit_component_args_from_auto_discovered_sources(
const struct auto_source_discovery *auto_disc,
- const bt_value *leftover_params,
- const bt_value *leftover_loglevels,
+ const bt_value *non_opt_params,
+ const bt_value *non_opt_loglevels,
GPtrArray *component_args)
{
gchar *cc_name = NULL;
}
/*
- * Append parameters and log levels of all the leftovers that
- * contributed to this component instance coming into existence.
+ * Append parameters and log levels of all the
+ * non-option arguments that contributed to this
+ * component instance coming into existence.
*/
- orig_indices_count = bt_value_array_get_size(res->original_input_indices);
+ orig_indices_count = bt_value_array_get_length(res->original_input_indices);
for (orig_indices_i = 0; orig_indices_i < orig_indices_count; orig_indices_i++) {
const bt_value *orig_idx_value =
bt_value_array_borrow_element_by_index(
uint64_t orig_idx = bt_value_integer_unsigned_get(orig_idx_value);
const bt_value *params_array =
bt_value_array_borrow_element_by_index_const(
- leftover_params, orig_idx);
+ non_opt_params, orig_idx);
uint64_t params_i, params_count;
const bt_value *loglevel_value;
- params_count = bt_value_array_get_size(params_array);
+ params_count = bt_value_array_get_length(params_array);
for (params_i = 0; params_i < params_count; params_i++) {
const bt_value *params_value =
bt_value_array_borrow_element_by_index_const(
}
loglevel_value = bt_value_array_borrow_element_by_index_const(
- leftover_loglevels, orig_idx);
+ non_opt_loglevels, orig_idx);
if (bt_value_get_type(loglevel_value) == BT_VALUE_TYPE_STRING) {
const char *loglevel = bt_value_string_get(loglevel_value);
bt_value_array_append_element_status append_status;
/* Current item is a component. */
CONVERT_CURRENT_ITEM_TYPE_COMPONENT,
- /* Current item is a leftover. */
- CONVERT_CURRENT_ITEM_TYPE_LEFTOVER,
+ /* Current item is a non-option argument. */
+ CONVERT_CURRENT_ITEM_TYPE_NON_OPT,
};
/*
*/
static
struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
- const bt_value *initial_plugin_paths, int *default_log_level)
+ int *retcode, const bt_value *plugin_paths,
+ int *default_log_level)
{
enum convert_current_item_type current_item_type =
CONVERT_CURRENT_ITEM_TYPE_NONE;
GList *source_names = NULL;
GList *filter_names = NULL;
GList *sink_names = NULL;
- bt_value *leftovers = NULL;
- bt_value *leftover_params = NULL;
- bt_value *leftover_loglevels = NULL;
+ bt_value *non_opts = NULL;
+ bt_value *non_opt_params = NULL;
+ bt_value *non_opt_loglevels = NULL;
struct implicit_component_args implicit_ctf_output_args = { 0 };
struct implicit_component_args implicit_lttng_live_args = { 0 };
struct implicit_component_args implicit_dummy_args = { 0 };
struct implicit_component_args implicit_debug_info_args = { 0 };
struct implicit_component_args implicit_muxer_args = { 0 };
struct implicit_component_args implicit_trimmer_args = { 0 };
- bt_value *plugin_paths;
char error_buf[256] = { 0 };
size_t i;
struct bt_common_lttng_live_url_parts lttng_live_url_parts = { 0 };
gchar *ctf_fs_source_clock_class_offset_arg = NULL;
gchar *ctf_fs_source_clock_class_offset_ns_arg = NULL;
-
- (void) bt_value_copy(initial_plugin_paths, &plugin_paths);
-
*retcode = 0;
if (argc < 1) {
goto error;
}
- ret = append_env_var_plugin_paths(plugin_paths);
- if (ret) {
- goto error;
- }
-
- leftovers = bt_value_array_create();
- if (!leftovers) {
+ non_opts = bt_value_array_create();
+ if (!non_opts) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- leftover_params = bt_value_array_create();
- if (!leftover_params) {
+ non_opt_params = bt_value_array_create();
+ if (!non_opt_params) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- leftover_loglevels = bt_value_array_create();
- if (!leftover_loglevels) {
+ non_opt_loglevels = bt_value_array_create();
+ if (!non_opt_loglevels) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
* as is to the run command. This pass can also add --name
* arguments if needed to automatically name unnamed component
* instances.
- *
- * Also it appends the plugin paths of --plugin-path to
- * `plugin_paths`.
*/
argpar_parse_ret = bt_argpar_parse(argc, argv, convert_options, true);
if (argpar_parse_ret.error) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- } else if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_LEFTOVER) {
- /* The current item is a leftover, record it in `leftover_params`. */
+ } else if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_NON_OPT) {
+ /*
+ * The current item is a
+ * non-option argument, record
+ * it in `non_opt_params`.
+ */
bt_value *array;
- uint64_t idx = bt_value_array_get_size(leftover_params) - 1;
+ uint64_t idx = bt_value_array_get_length(non_opt_params) - 1;
- array = bt_value_array_borrow_element_by_index(leftover_params, idx);
+ array = bt_value_array_borrow_element_by_index(non_opt_params, idx);
bt_value_array_append_string_element(array, arg);
} else {
BT_CLI_LOGE_APPEND_CAUSE(
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- } else if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_LEFTOVER) {
- uint64_t idx = bt_value_array_get_size(leftover_loglevels) - 1;
+ } else if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_NON_OPT) {
+ uint64_t idx = bt_value_array_get_length(non_opt_loglevels) - 1;
bt_value *log_level_str_value;
log_level_str_value = bt_value_string_create_init(arg);
goto error;
}
- if (bt_value_array_set_element_by_index(leftover_loglevels, idx,
+ if (bt_value_array_set_element_by_index(non_opt_loglevels, idx,
log_level_str_value)) {
bt_value_put_ref(log_level_str_value);
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- break;
- case OPT_OMIT_HOME_PLUGIN_PATH:
- force_omit_home_plugin_path = true;
-
- if (bt_value_array_append_string_element(run_args,
- "--omit-home-plugin-path")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
break;
case OPT_RETRY_DURATION:
if (bt_value_array_append_string_element(run_args,
goto error;
}
- if (bt_value_array_append_string_element(run_args, arg)) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
- break;
- case OPT_OMIT_SYSTEM_PLUGIN_PATH:
- force_omit_system_plugin_path = true;
-
- if (bt_value_array_append_string_element(run_args,
- "--omit-system-plugin-path")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
- break;
- case OPT_PLUGIN_PATH:
- if (bt_config_append_plugin_paths_check_setuid_setgid(
- plugin_paths, arg)) {
- goto error;
- }
-
- if (bt_value_array_append_string_element(run_args,
- "--plugin-path")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
-
if (bt_value_array_append_string_element(run_args, arg)) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
struct bt_argpar_item_non_opt *argpar_item_non_opt;
bt_value_array_append_element_status append_status;
- current_item_type = CONVERT_CURRENT_ITEM_TYPE_LEFTOVER;
+ current_item_type = CONVERT_CURRENT_ITEM_TYPE_NON_OPT;
argpar_item_non_opt = (struct bt_argpar_item_non_opt *) argpar_item;
- append_status = bt_value_array_append_string_element(leftovers,
+ append_status = bt_value_array_append_string_element(non_opts,
argpar_item_non_opt->arg);
if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- append_status = bt_value_array_append_empty_array_element(leftover_params);
+ append_status = bt_value_array_append_empty_array_element(
+ non_opt_params, NULL);
if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- append_status = bt_value_array_append_element(leftover_loglevels, bt_value_null);
+ append_status = bt_value_array_append_element(non_opt_loglevels, bt_value_null);
if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
"verbose", "yes");
}
- /*
- * Append home and system plugin paths now that we possibly got
- * --plugin-path.
- */
- if (append_home_and_system_plugin_paths(plugin_paths,
- force_omit_system_plugin_path,
- force_omit_home_plugin_path)) {
- goto error;
- }
-
/* Print CTF metadata or print LTTng live sessions */
if (print_ctf_metadata) {
- const bt_value *bt_val_leftover;
+ const bt_value *bt_val_non_opt;
- if (bt_value_array_is_empty(leftovers)) {
+ if (bt_value_array_is_empty(non_opts)) {
BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
goto error;
}
- if (bt_value_array_get_size(leftovers) > 1) {
+ if (bt_value_array_get_length(non_opts) > 1) {
BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
goto error;
}
goto error;
}
- bt_val_leftover = bt_value_array_borrow_element_by_index_const(leftovers, 0);
+ bt_val_non_opt = bt_value_array_borrow_element_by_index_const(non_opts, 0);
g_string_assign(cfg->cmd_data.print_ctf_metadata.path,
- bt_value_string_get(bt_val_leftover));
+ bt_value_string_get(bt_val_non_opt));
if (output) {
g_string_assign(
}
}
- /* Decide where the leftover argument(s) go */
- if (bt_value_array_get_size(leftovers) > 0) {
+ /* Decide where the non-option argument(s) go */
+ if (bt_value_array_get_length(non_opts) > 0) {
if (implicit_lttng_live_args.exists) {
- const bt_value *bt_val_leftover;
+ const bt_value *bt_val_non_opt;
- if (bt_value_array_get_size(leftovers) > 1) {
+ if (bt_value_array_get_length(non_opts) > 1) {
BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
goto error;
}
- bt_val_leftover = bt_value_array_borrow_element_by_index_const(leftovers, 0);
+ bt_val_non_opt = bt_value_array_borrow_element_by_index_const(non_opts, 0);
lttng_live_url_parts =
- bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_leftover),
+ bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt),
error_buf, sizeof(error_buf));
if (!lttng_live_url_parts.proto) {
BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
}
g_string_assign(cfg->cmd_data.print_lttng_live_sessions.url,
- bt_value_string_get(bt_val_leftover));
+ bt_value_string_get(bt_val_non_opt));
if (output) {
g_string_assign(
ret = append_implicit_component_extra_param(
&implicit_lttng_live_args, "url",
- bt_value_string_get(bt_val_leftover));
+ bt_value_string_get(bt_val_non_opt));
if (ret) {
goto error;
}
}
} else {
int status;
+ size_t plugin_count;
+ const bt_plugin **plugins;
+ const bt_plugin *plugin;
+
+ status = require_loaded_plugins(plugin_paths);
+ if (status != 0) {
+ goto error;
+ }
+
+ if (auto_source_discovery_restrict_plugin_name) {
+ plugin_count = 1;
+ plugin = find_loaded_plugin(auto_source_discovery_restrict_plugin_name);
+ plugins = &plugin;
+ } else {
+ plugin_count = get_loaded_plugins_count();
+ plugins = borrow_loaded_plugins();
+ }
- status = auto_discover_source_components(plugin_paths, leftovers,
- auto_source_discovery_restrict_plugin_name,
+ status = auto_discover_source_components(non_opts, plugins, plugin_count,
auto_source_discovery_restrict_component_class_name,
*default_log_level >= 0 ? *default_log_level : cli_default_log_level,
&auto_disc);
}
status = create_implicit_component_args_from_auto_discovered_sources(
- &auto_disc, leftover_params, leftover_loglevels,
+ &auto_disc, non_opt_params, non_opt_loglevels,
discovered_source_args);
if (status != 0) {
goto error;
}
/*
- * If the implicit `source.ctf.lttng-live` component exists, make sure
- * there's at least one leftover (which is the URL).
+ * If the implicit `source.ctf.lttng-live` component exists,
+ * make sure there's at least one non-option argument (which is
+ * the URL).
*/
- if (implicit_lttng_live_args.exists && bt_value_array_is_empty(leftovers)) {
+ if (implicit_lttng_live_args.exists && bt_value_array_is_empty(non_opts)) {
BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
implicit_lttng_live_args.comp_arg->str);
goto error;
goto error;
}
+ /* Make sure there's a single sink component */
+ if (g_list_length(sink_names) != 1) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "More than one sink component specified.");
+ goto error;
+ }
+
/*
* Prepend the muxer, the trimmer, and the debug info to the
* filter chain so that we have:
goto error;
}
- for (i = 0; i < bt_value_array_get_size(run_args); i++) {
+ for (i = 0; i < bt_value_array_get_length(run_args); i++) {
const bt_value *arg_value =
bt_value_array_borrow_element_by_index(run_args,
i);
g_string_free(quoted, TRUE);
}
- if (i < bt_value_array_get_size(run_args) - 1) {
+ if (i < bt_value_array_get_length(run_args) - 1) {
if (print_run_args) {
putchar(' ');
} else {
}
cfg = bt_config_run_from_args_array(run_args, retcode,
- force_omit_system_plugin_path,
- force_omit_home_plugin_path,
- initial_plugin_paths, *default_log_level);
+ plugin_paths, *default_log_level);
if (!cfg) {
goto error;
}
destroy_glist_of_gstring(source_names);
destroy_glist_of_gstring(filter_names);
destroy_glist_of_gstring(sink_names);
- bt_value_put_ref(leftovers);
+ bt_value_put_ref(non_opt_params);
+ bt_value_put_ref(non_opt_loglevels);
+ bt_value_put_ref(non_opts);
finalize_implicit_component_args(&implicit_ctf_output_args);
finalize_implicit_component_args(&implicit_lttng_live_args);
finalize_implicit_component_args(&implicit_dummy_args);
finalize_implicit_component_args(&implicit_debug_info_args);
finalize_implicit_component_args(&implicit_muxer_args);
finalize_implicit_component_args(&implicit_trimmer_args);
- bt_value_put_ref(plugin_paths);
bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts);
auto_source_discovery_fini(&auto_disc);
fprintf(fp, "\n");
fprintf(fp, "General options:\n");
fprintf(fp, "\n");
- fprintf(fp, " -d, --debug Enable debug mode (same as --log-level=V)\n");
- fprintf(fp, " -h, --help Show this help and quit\n");
- fprintf(fp, " -l, --log-level=LVL Set the default log level to LVL (`N`, `V`, `D`,\n");
- fprintf(fp, " `I`, `W` (default), `E`, or `F`)\n");
- fprintf(fp, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
- fprintf(fp, " -V, --version Show version and quit\n");
+ fprintf(fp, " -d, --debug Enable debug mode (same as --log-level=V)\n");
+ fprintf(fp, " -h, --help Show this help and quit\n");
+ fprintf(fp, " -l, --log-level=LVL Set the default log level to LVL (`N`, `V`, `D`,\n");
+ fprintf(fp, " `I`, `W` (default), `E`, or `F`)\n");
+ fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
+ fprintf(fp, " (~/.local/lib/babeltrace2/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, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
+ fprintf(fp, " -V, --version Show version and quit\n");
fprintf(fp, "\n");
fprintf(fp, "Available commands:\n");
fprintf(fp, "\n");
}
struct bt_config *bt_config_cli_args_create(int argc, const char *argv[],
- int *retcode, bool force_omit_system_plugin_path,
- bool force_omit_home_plugin_path,
+ int *retcode, bool omit_system_plugin_path,
+ bool omit_home_plugin_path,
const bt_value *initial_plugin_paths)
{
struct bt_config *config = NULL;
const char *command_name = NULL;
int default_log_level = -1;
struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ bt_value *plugin_paths = NULL;
/* Top-level option descriptions. */
static const struct bt_argpar_opt_descr descrs[] = {
{ OPT_LOG_LEVEL, 'l', "log-level", true },
{ OPT_VERBOSE, 'v', "verbose", false },
{ OPT_VERSION, 'V', "version", false},
+ { OPT_OMIT_HOME_PLUGIN_PATH, '\0', "omit-home-plugin-path", false },
+ { OPT_OMIT_SYSTEM_PLUGIN_PATH, '\0', "omit-system-plugin-path", false },
+ { OPT_PLUGIN_PATH, '\0', "plugin-path", true },
BT_ARGPAR_OPT_DESCR_SENTINEL
};
*retcode = -1;
if (!initial_plugin_paths) {
- initial_plugin_paths = bt_value_array_create();
- if (!initial_plugin_paths) {
- *retcode = 1;
- goto end;
+ plugin_paths = bt_value_array_create();
+ if (!plugin_paths) {
+ goto error;
}
} else {
- bt_value_get_ref(initial_plugin_paths);
+ bt_value_copy_status copy_status = bt_value_copy(
+ initial_plugin_paths, &plugin_paths);
+ if (copy_status) {
+ goto error;
+ }
+ }
+
+ BT_ASSERT(plugin_paths);
+
+ /*
+ * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
+ * `--plugin-path` option's paths, so append it now before
+ * parsing the general options.
+ */
+ if (append_env_var_plugin_paths(plugin_paths)) {
+ goto error;
}
if (argc <= 1) {
goto error;
}
break;
+ case OPT_PLUGIN_PATH:
+ if (bt_config_append_plugin_paths_check_setuid_setgid(
+ plugin_paths, item_opt->arg)) {
+ goto error;
+ }
+ break;
+ case OPT_OMIT_SYSTEM_PLUGIN_PATH:
+ omit_system_plugin_path = true;
+ break;
+ case OPT_OMIT_HOME_PLUGIN_PATH:
+ omit_home_plugin_path = true;
+ break;
case OPT_VERSION:
print_version();
goto end;
default_log_level = cli_default_log_level;
}
+ /*
+ * At this point, `plugin_paths` contains the initial plugin
+ * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
+ * the paths from the `--plugin-path` option.
+ *
+ * Now append the user and system plugin paths.
+ */
+ if (append_home_and_system_plugin_paths(plugin_paths,
+ omit_system_plugin_path, omit_home_plugin_path)) {
+ goto error;
+ }
+
switch (command_type) {
case COMMAND_TYPE_RUN:
config = bt_config_run_from_args(command_argc, command_argv,
- retcode, force_omit_system_plugin_path,
- force_omit_home_plugin_path, initial_plugin_paths,
+ retcode, plugin_paths,
default_log_level);
break;
case COMMAND_TYPE_CONVERT:
config = bt_config_convert_from_args(command_argc, command_argv,
- retcode, force_omit_system_plugin_path,
- force_omit_home_plugin_path,
- initial_plugin_paths, &default_log_level);
+ retcode, plugin_paths, &default_log_level);
break;
case COMMAND_TYPE_LIST_PLUGINS:
config = bt_config_list_plugins_from_args(command_argc,
- command_argv, retcode, force_omit_system_plugin_path,
- force_omit_home_plugin_path, initial_plugin_paths);
+ command_argv, retcode, plugin_paths);
break;
case COMMAND_TYPE_HELP:
config = bt_config_help_from_args(command_argc,
- command_argv, retcode, force_omit_system_plugin_path,
- force_omit_home_plugin_path, initial_plugin_paths,
+ command_argv, retcode, plugin_paths,
default_log_level);
break;
case COMMAND_TYPE_QUERY:
config = bt_config_query_from_args(command_argc,
- command_argv, retcode, force_omit_system_plugin_path,
- force_omit_home_plugin_path, initial_plugin_paths,
+ command_argv, retcode, plugin_paths,
default_log_level);
break;
default:
end:
bt_argpar_parse_ret_fini(&argpar_parse_ret);
- bt_value_put_ref(initial_plugin_paths);
+ bt_value_put_ref(plugin_paths);
return config;
}