/*
- * Babeltrace trace converter - parameter parsing
+ * SPDX-License-Identifier: MIT
*
* Copyright 2016 Philippe Proulx <pproulx@efficios.com>
*
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * 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.
+ * Babeltrace trace converter - parameter parsing
*/
#define BT_LOG_TAG "CLI/CFG-CLI-ARGS"
#include <inttypes.h>
#include <babeltrace2/babeltrace.h>
#include "common/common.h"
-#include <popt.h>
#include <glib.h>
#include <sys/types.h>
#include "argpar/argpar.h"
#include "babeltrace2-cfg.h"
#include "babeltrace2-cfg-cli-args.h"
#include "babeltrace2-cfg-cli-args-connect.h"
-#include "babeltrace2-cfg-cli-params-arg.h"
+#include "param-parse/param-parse.h"
+#include "babeltrace2-log-level.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;
-
-/* INI-style parsing FSM states */
-enum ini_parsing_fsm_state {
- /* Expect a map key (identifier) */
- INI_EXPECT_MAP_KEY,
-
- /* Expect an equal character ('=') */
- INI_EXPECT_EQUAL,
-
- /* Expect a value */
- INI_EXPECT_VALUE,
-
- /* Expect a comma character (',') */
- INI_EXPECT_COMMA,
-};
-
-/* INI-style parsing state variables */
-struct ini_parsing_state {
- /* Lexical scanner (owned by this) */
- GScanner *scanner;
-
- /* Output map value object being filled (owned by this) */
- bt_value *params;
-
- /* Next expected FSM state */
- enum ini_parsing_fsm_state expecting;
-
- /* Last decoded map key (owned by this) */
- char *last_map_key;
-
- /* Complete INI-style string to parse (not owned by this) */
- const char *arg;
-
- /* Error buffer (not owned by this) */
- GString *ini_error;
-};
-
-/* Offset option with "is set" boolean */
-struct offset_opt {
- int64_t value;
- bool is_set;
-};
-
-/* Legacy "ctf"/"lttng-live" format options */
-struct ctf_legacy_opts {
- struct offset_opt offset_s;
- struct offset_opt offset_ns;
- bool stream_intersection;
-};
-
-/* Legacy "text" format options */
-struct text_legacy_opts {
- /*
- * output, dbg_info_dir, dbg_info_target_prefix, names,
- * and fields are owned by this.
- */
- GString *output;
- GString *dbg_info_dir;
- GString *dbg_info_target_prefix;
- const bt_value *names;
- const bt_value *fields;
-
- /* Flags */
- bool no_delta;
- bool clock_cycles;
- bool clock_seconds;
- bool clock_date;
- bool clock_gmt;
- bool dbg_info_full_path;
- bool verbose;
-};
-
-/* Legacy input format format */
-enum legacy_input_format {
- LEGACY_INPUT_FORMAT_NONE = 0,
- LEGACY_INPUT_FORMAT_CTF,
- LEGACY_INPUT_FORMAT_LTTNG_LIVE,
-};
-
-/* Legacy output format format */
-enum legacy_output_format {
- LEGACY_OUTPUT_FORMAT_NONE = 0,
- LEGACY_OUTPUT_FORMAT_TEXT,
- LEGACY_OUTPUT_FORMAT_DUMMY,
-};
-
#define BT_CLI_LOGE_APPEND_CAUSE_OOM() BT_CLI_LOGE_APPEND_CAUSE("Out of memory.")
/*
return;
}
+static
+void print_and_indent(const char *str)
+{
+ const char *ch = &str[0];
+
+ for (; *ch != '\0'; ch++) {
+ if (*ch == '\n') {
+ if (ch[1] != '\0') {
+ printf("\n ");
+ }
+ } else {
+ printf("%c", *ch);
+ }
+ }
+
+ printf("\n");
+}
+
/*
* Prints the Babeltrace version.
*/
static
void print_version(void)
{
- if (GIT_VERSION[0] == '\0') {
- puts("Babeltrace " VERSION);
- } else {
- puts("Babeltrace " VERSION " - " GIT_VERSION);
+ bool has_extra_name = strlen(BT_VERSION_EXTRA_NAME) > 0;
+ bool has_extra_description = strlen(BT_VERSION_EXTRA_DESCRIPTION) > 0;
+ bool has_extra_patch_names = strlen(BT_VERSION_EXTRA_PATCHES) > 0;
+ bool has_extra = has_extra_name || has_extra_description ||
+ has_extra_patch_names;
+
+ printf("%sBabeltrace %s%s",
+ bt_common_color_bold(),
+ VERSION,
+ bt_common_color_reset());
+
+ if (strlen(BT_VERSION_NAME) > 0) {
+ printf(" \"%s%s%s%s\"",
+ bt_common_color_fg_bright_blue(),
+ bt_common_color_bold(),
+ BT_VERSION_NAME,
+ bt_common_color_reset());
+ }
+
+ if (strlen(BT_VERSION_GIT) > 0) {
+ printf(" [%s%s%s]",
+ bt_common_color_fg_yellow(),
+ BT_VERSION_GIT,
+ bt_common_color_reset());
+ }
+
+ printf("\n");
+
+ if (strlen(BT_VERSION_DESCRIPTION) > 0) {
+ unsigned int columns;
+ GString *descr;
+
+ if (bt_common_get_term_size(&columns, NULL) < 0) {
+ /* Width not found: default to 80 */
+ columns = 80;
+ }
+
+ descr = bt_common_fold(BT_VERSION_DESCRIPTION, columns, 0);
+ BT_ASSERT(descr);
+ printf("\n%s\n", descr->str);
+ g_string_free(descr, TRUE);
+ }
+
+ if (has_extra) {
+ printf("\n");
+
+ if (has_extra_name) {
+ printf("%sExtra name%s: %s\n",
+ bt_common_color_fg_cyan(),
+ bt_common_color_reset(),
+ BT_VERSION_EXTRA_NAME);
+ }
+
+ if (has_extra_description) {
+ printf("%sExtra description%s:\n ",
+ bt_common_color_fg_cyan(),
+ bt_common_color_reset());
+ print_and_indent(BT_VERSION_EXTRA_DESCRIPTION);
+ }
+
+ if (has_extra_patch_names) {
+ printf("%sExtra patch names%s:\n ",
+ bt_common_color_fg_cyan(),
+ bt_common_color_reset());
+ print_and_indent(BT_VERSION_EXTRA_PATCHES);
+ }
}
}
}
break;
default:
- abort();
+ bt_common_abort();
}
g_free(cfg);
{
GScanner *scanner;
GScannerConfig scanner_config = {
- .cset_skip_characters = " \t\n",
- .cset_identifier_first = G_CSET_a_2_z G_CSET_A_2_Z "_",
- .cset_identifier_nth = G_CSET_a_2_z G_CSET_A_2_Z ":_-",
+ .cset_skip_characters = (gchar *) " \t\n",
+ .cset_identifier_first = (gchar *) G_CSET_a_2_z G_CSET_A_2_Z "_",
+ .cset_identifier_nth = (gchar *) G_CSET_a_2_z G_CSET_A_2_Z ":_-",
.case_sensitive = TRUE,
.cpair_comment_single = NULL,
.skip_comment_multi = TRUE,
const bt_value *names_array, const char *prefix)
{
int ret = 0;
- int i;
+ uint64_t i;
GString *tmpstr = NULL, *default_value = NULL;
bool default_set = false, non_default_set = false;
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);
+ i);
const char *suffix;
bool is_default = false;
- if (!str_obj) {
- BT_CLI_LOGE_APPEND_CAUSE("Unexpected error.");
- ret = -1;
- goto end;
- }
-
suffix = bt_value_string_get(str_obj);
g_string_assign(tmpstr, prefix);
return ret;
}
-/* popt options */
+/* argpar options */
enum {
OPT_NONE = 0,
OPT_BASE_PARAMS,
OPT_INPUT_FORMAT,
OPT_LIST,
OPT_LOG_LEVEL,
- OPT_NAME,
OPT_NAMES,
OPT_NO_DELTA,
OPT_OMIT_HOME_PLUGIN_PATH,
OPT_OUTPUT,
OPT_OUTPUT_FORMAT,
OPT_PARAMS,
- OPT_PATH,
OPT_PLUGIN_PATH,
OPT_RESET_BASE_PARAMS,
OPT_RETRY_DURATION,
OPT_RUN_ARGS_0,
OPT_STREAM_INTERSECTION,
OPT_TIMERANGE,
- OPT_URL,
OPT_VERBOSE,
OPT_VERSION,
};
g_ptr_array_add(cfg->cmd_data.run.sinks, cfg_comp);
break;
default:
- abort();
+ bt_common_abort();
}
}
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, "* Double-quoted string (accepts escape characters).\n");
fprintf(fp, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
fprintf(fp, " (as described by the current list) and a closing `]`.\n");
+ fprintf(fp, "* Map, formatted as an opening `{`, a comma-separated list of PARAM=VALUE\n");
+ fprintf(fp, " assignments and a closing `}`.\n");
fprintf(fp, "\n");
fprintf(fp, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
fprintf(fp, "\n");
static
bool help_option_is_specified(
- const struct bt_argpar_parse_ret *argpar_parse_ret)
+ const struct argpar_parse_ret *argpar_parse_ret)
{
int i;
bool specified = false;
- 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;
+ for (i = 0; i < argpar_parse_ret->items->n_items; i++) {
+ struct argpar_item *argpar_item =
+ argpar_parse_ret->items->items[i];
+ struct argpar_item_opt *argpar_item_opt;
- if (argpar_item->type != BT_ARGPAR_ITEM_TYPE_OPT) {
+ if (argpar_item->type != ARGPAR_ITEM_TYPE_OPT) {
continue;
}
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
+ argpar_item_opt = (struct argpar_item_opt *) argpar_item;
if (argpar_item_opt->descr->id == OPT_HELP) {
specified = true;
break;
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");
}
static
-struct poptOption help_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 },
+const struct argpar_opt_descr help_options[] = {
+ /* id, short_name, long_name, with_arg */
+ { OPT_HELP, 'h', "help", false },
+ 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)
{
- poptContext pc = NULL;
- char *arg = NULL;
- int opt;
- int ret;
struct bt_config *cfg = NULL;
- const char *leftover;
char *plugin_name = NULL, *comp_cls_name = NULL;
+ struct argpar_parse_ret argpar_parse_ret = { 0 };
+ struct argpar_item_non_opt *non_opt;
+ GString *substring = NULL;
+ size_t end_pos;
*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 */
- pc = poptGetContext(NULL, argc, (const char **) argv,
- help_long_options, POPT_CONTEXT_KEEP_FIRST);
- if (!pc) {
- BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
+ argpar_parse_ret = argpar_parse(argc, argv, help_options, true);
+ if (argpar_parse_ret.error) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "While parsing `help` command's command-line arguments: %s",
+ argpar_parse_ret.error);
goto error;
}
- poptReadDefaultConfig(pc, 0);
-
- while ((opt = poptGetNextOpt(pc)) > 0) {
- arg = poptGetOptArg(pc);
-
- switch (opt) {
- 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_HELP:
- print_help_usage(stdout);
- *retcode = -1;
- BT_OBJECT_PUT_REF_AND_RESET(cfg);
- goto end;
- default:
- BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
- opt);
- goto error;
- }
+ if (help_option_is_specified(&argpar_parse_ret)) {
+ print_help_usage(stdout);
+ *retcode = -1;
+ BT_OBJECT_PUT_REF_AND_RESET(cfg);
+ goto end;
+ }
- free(arg);
- arg = NULL;
+ if (argpar_parse_ret.items->n_items == 0) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Missing plugin name or component class descriptor.");
+ goto error;
+ } else if (argpar_parse_ret.items->n_items > 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 = (struct argpar_item_non_opt *) argpar_parse_ret.items->items[1];
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Extraneous command-line argument specified to `help` command: `%s`.",
+ non_opt->arg);
+ goto error;
}
- /* Check for option parsing error */
- if (opt < -1) {
- BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: `%s`.",
- poptBadOption(pc, 0), poptStrerror(opt));
+ non_opt = (struct argpar_item_non_opt *) argpar_parse_ret.items->items[0];
+
+ /* Look for unescaped dots in the argument. */
+ substring = bt_common_string_until(non_opt->arg, ".\\", ".", &end_pos);
+ if (!substring) {
+ BT_CLI_LOGE_APPEND_CAUSE("Could not consume argument: arg=%s",
+ non_opt->arg);
goto error;
}
- leftover = poptGetArg(pc);
- if (leftover) {
- plugin_comp_cls_names(leftover, NULL,
- &plugin_name, &comp_cls_name,
+ if (end_pos == strlen(non_opt->arg)) {
+ /* Didn't find an unescaped dot, treat it as a plugin name. */
+ g_string_assign(cfg->cmd_data.help.cfg_component->plugin_name,
+ non_opt->arg);
+ } else {
+ /*
+ * Found an unescaped dot, treat it as a component class name.
+ */
+ 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 {
- /* Fall back to plugin help */
- g_string_assign(
- cfg->cmd_data.help.cfg_component->plugin_name,
- leftover);
+ if (!plugin_name || !comp_cls_name) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Could not parse argument as a component class name: arg=%s",
+ non_opt->arg);
+ goto error;
}
- } 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;
+ 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);
}
goto end;
g_free(plugin_name);
g_free(comp_cls_name);
- if (pc) {
- poptFreeContext(pc);
+ if (substring) {
+ g_string_free(substring, TRUE);
}
- free(arg);
+ argpar_parse_ret_fini(&argpar_parse_ret);
+
return cfg;
}
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);
}
static
-struct poptOption query_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 },
- { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL },
- { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
- { NULL, 0, '\0', NULL, 0, NULL, NULL },
+const struct argpar_opt_descr query_options[] = {
+ /* id, short_name, long_name, with_arg */
+ { OPT_HELP, 'h', "help", false },
+ { OPT_PARAMS, 'p', "params", true },
+ 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)
{
- poptContext pc = NULL;
- char *arg = NULL;
- int opt;
- int ret;
+ int i;
struct bt_config *cfg = NULL;
- const char *leftover;
- bt_value *params;
+ const char *component_class_spec = NULL;
+ const char *query_object = NULL;
GString *error_str = NULL;
+ struct argpar_parse_ret argpar_parse_ret = { 0 };
- params = bt_value_null;
- bt_value_get_ref(bt_value_null);
+ bt_value *params = bt_value_map_create();
+ if (!params) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
*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) {
+ /* Parse options */
+ argpar_parse_ret = argpar_parse(argc, argv, query_options, true);
+ if (argpar_parse_ret.error) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "While parsing `query` command's command-line arguments: %s",
+ argpar_parse_ret.error);
goto error;
}
- /* Parse options */
- pc = poptGetContext(NULL, argc, (const char **) argv,
- query_long_options, POPT_CONTEXT_KEEP_FIRST);
- if (!pc) {
- BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
- goto error;
+ if (help_option_is_specified(&argpar_parse_ret)) {
+ print_query_usage(stdout);
+ *retcode = -1;
+ BT_OBJECT_PUT_REF_AND_RESET(cfg);
+ goto end;
}
- poptReadDefaultConfig(pc, 0);
+ for (i = 0; i < argpar_parse_ret.items->n_items; i++) {
+ struct argpar_item *argpar_item =
+ argpar_parse_ret.items->items[i];
- while ((opt = poptGetNextOpt(pc)) > 0) {
- arg = poptGetOptArg(pc);
+ if (argpar_item->type == ARGPAR_ITEM_TYPE_OPT) {
+ struct argpar_item_opt *argpar_item_opt =
+ (struct argpar_item_opt *) argpar_item;
+ const char *arg = argpar_item_opt->arg;
- switch (opt) {
- case OPT_PLUGIN_PATH:
- if (bt_config_append_plugin_paths_check_setuid_setgid(
- cfg->plugin_paths, arg)) {
- goto error;
+ switch (argpar_item_opt->descr->id) {
+ case OPT_PARAMS:
+ {
+ bt_value *parsed_params = bt_param_parse(arg, error_str);
+ bt_value_map_extend_status extend_status;
+ if (!parsed_params) {
+ BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
+ error_str->str);
+ goto error;
+ }
+
+ extend_status = bt_value_map_extend(params, parsed_params);
+ BT_VALUE_PUT_REF_AND_RESET(parsed_params);
+ if (extend_status) {
+ BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current parameters with --params option's argument:\n %s",
+ arg);
+ goto error;
+ }
+ break;
}
- 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);
- params = cli_value_from_arg(arg, error_str);
- if (!params) {
- BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
- error_str->str);
+ default:
+ BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
+ argpar_item_opt->descr->id);
goto error;
}
- break;
- }
- case OPT_HELP:
- print_query_usage(stdout);
- *retcode = -1;
- BT_OBJECT_PUT_REF_AND_RESET(cfg);
- goto end;
- default:
- BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
- opt);
- goto error;
- }
-
- free(arg);
- arg = NULL;
- }
-
- /* Check for option parsing error */
- if (opt < -1) {
- BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: `%s`.",
- poptBadOption(pc, 0), poptStrerror(opt));
- goto error;
- }
+ } else {
+ struct argpar_item_non_opt *argpar_item_non_opt
+ = (struct argpar_item_non_opt *) argpar_item;
- /*
- * We need exactly two leftover arguments which are the
- * mandatory component class specification and query object.
- */
- leftover = poptGetArg(pc);
- if (leftover) {
- cfg->cmd_data.query.cfg_component =
- bt_config_component_from_arg(leftover,
- default_log_level);
- if (!cfg->cmd_data.query.cfg_component) {
- BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
- leftover);
- goto error;
+ /*
+ * 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;
+ } else if (!query_object) {
+ query_object = argpar_item_non_opt->arg;
+ } else {
+ BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
+ argpar_item_non_opt->arg);
+ goto error;
+ }
}
-
- BT_ASSERT(params);
- BT_OBJECT_MOVE_REF(cfg->cmd_data.query.cfg_component->params,
- params);
- } else {
- print_query_usage(stdout);
- *retcode = -1;
- BT_OBJECT_PUT_REF_AND_RESET(cfg);
- goto end;
}
- leftover = poptGetArg(pc);
- if (leftover) {
- if (strlen(leftover) == 0) {
- BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
- goto error;
- }
-
- g_string_assign(cfg->cmd_data.query.object, leftover);
- } else {
+ if (!component_class_spec || !query_object) {
print_query_usage(stdout);
*retcode = -1;
BT_OBJECT_PUT_REF_AND_RESET(cfg);
goto end;
}
- leftover = poptGetArg(pc);
- if (leftover) {
- BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`.", leftover);
+ cfg->cmd_data.query.cfg_component =
+ bt_config_component_from_arg(component_class_spec,
+ default_log_level);
+ if (!cfg->cmd_data.query.cfg_component) {
+ BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
+ component_class_spec);
goto error;
}
- if (append_home_and_system_plugin_paths_cfg(cfg)) {
+ BT_ASSERT(params);
+ BT_OBJECT_MOVE_REF(cfg->cmd_data.query.cfg_component->params, params);
+
+ if (strlen(query_object) == 0) {
+ BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
goto error;
}
+ g_string_assign(cfg->cmd_data.query.object, query_object);
goto end;
error:
BT_OBJECT_PUT_REF_AND_RESET(cfg);
end:
- if (pc) {
- poptFreeContext(pc);
- }
+ argpar_parse_ret_fini(&argpar_parse_ret);
if (error_str) {
g_string_free(error_str, TRUE);
}
bt_value_put_ref(params);
- free(arg);
return cfg;
}
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");
}
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 },
+const struct argpar_opt_descr list_plugins_options[] = {
+ /* id, short_name, long_name, with_arg */
+ { OPT_HELP, 'h', "help", false },
+ 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)
{
- poptContext pc = NULL;
- char *arg = NULL;
- int opt;
- int ret;
struct bt_config *cfg = NULL;
- const char *leftover;
+ struct 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 */
- pc = poptGetContext(NULL, argc, (const char **) argv,
- list_plugins_long_options, POPT_CONTEXT_KEEP_FIRST);
- if (!pc) {
- BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
+ argpar_parse_ret = argpar_parse(argc, argv, list_plugins_options, true);
+ if (argpar_parse_ret.error) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "While parsing `list-plugins` command's command-line arguments: %s",
+ argpar_parse_ret.error);
goto error;
}
- poptReadDefaultConfig(pc, 0);
-
- while ((opt = poptGetNextOpt(pc)) > 0) {
- arg = poptGetOptArg(pc);
-
- switch (opt) {
- 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_HELP:
- print_list_plugins_usage(stdout);
- *retcode = -1;
- BT_OBJECT_PUT_REF_AND_RESET(cfg);
- goto end;
- default:
- BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
- opt);
- goto error;
- }
-
- free(arg);
- arg = NULL;
+ if (help_option_is_specified(&argpar_parse_ret)) {
+ print_list_plugins_usage(stdout);
+ *retcode = -1;
+ BT_OBJECT_PUT_REF_AND_RESET(cfg);
+ goto end;
}
- /* Check for option parsing error */
- if (opt < -1) {
- BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: %s",
- poptBadOption(pc, 0), poptStrerror(opt));
- goto error;
- }
+ if (argpar_parse_ret.items->n_items > 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 argpar_item_non_opt *non_opt =
+ (struct argpar_item_non_opt *) argpar_parse_ret.items->items[0];
- leftover = poptGetArg(pc);
- if (leftover) {
- BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`.", leftover);
- goto error;
- }
-
- 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;
}
BT_OBJECT_PUT_REF_AND_RESET(cfg);
end:
- if (pc) {
- poptFreeContext(pc);
- }
+ argpar_parse_ret_fini(&argpar_parse_ret);
- free(arg);
return cfg;
}
fprintf(fp, " for all the following components until\n");
fprintf(fp, " --reset-base-params is encountered\n");
fprintf(fp, " (see the expected format of PARAMS below)\n");
- fprintf(fp, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
+ fprintf(fp, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
fprintf(fp, " Instantiate the component class CLS of type\n");
fprintf(fp, " TYPE (`source`, `filter`, or `sink`) found\n");
fprintf(fp, " in the plugin PLUGIN, add it to the graph,\n");
- fprintf(fp, " and optionally name it NAME (you can also\n");
- fprintf(fp, " specify the name with --name)\n");
+ fprintf(fp, " and name it NAME");
fprintf(fp, " -x, --connect=CONNECTION Connect two created components (see the\n");
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, " -n, --name=NAME Set the name of the current component\n");
- fprintf(fp, " to NAME (must be unique amongst all the\n");
- fprintf(fp, " names of the created components)\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, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\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");
fprintf(fp, "\n");
fprintf(fp, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
fprintf(fp, "components to connect together. You must escape the following characters\n\n");
- fprintf(fp, "with `\\`: `\\`, `.`, and `:`. You can set the name of the current\n");
- fprintf(fp, "component with the --name option.\n");
+ fprintf(fp, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
+ fprintf(fp, "component using the NAME prefix of the --component option.\n");
fprintf(fp, "\n");
fprintf(fp, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
fprintf(fp, "identify the upstream and downstream ports to use for the connection.\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;
- enum bt_config_component_dest cur_cfg_comp_dest =
- BT_CONFIG_COMPONENT_DEST_UNKNOWN;
bt_value *cur_base_params = NULL;
int ret = 0;
struct bt_config *cfg = NULL;
long retry_duration = -1;
bt_value_map_extend_status extend_status;
GString *error_str = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ struct argpar_parse_ret argpar_parse_ret = { 0 };
int i;
- static const struct bt_argpar_opt_descr run_options[] = {
+ static const struct argpar_opt_descr run_options[] = {
{ OPT_BASE_PARAMS, 'b', "base-params", true },
{ OPT_COMPONENT, 'c', "component", true },
{ OPT_CONNECT, 'x', "connect", true },
{ OPT_HELP, 'h', "help", false },
{ OPT_LOG_LEVEL, 'l', "log-level", true },
- { OPT_NAME, 'n', "name", 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
+ ARGPAR_OPT_DESCR_SENTINEL
};
*retcode = 0;
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);
+ argpar_parse_ret = argpar_parse(argc, argv, run_options, true);
if (argpar_parse_ret.error) {
BT_CLI_LOGE_APPEND_CAUSE(
"While parsing `run` command's command-line arguments: %s",
- argpar_parse_ret.error->str);
+ argpar_parse_ret.error);
goto 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;
+ for (i = 0; i < argpar_parse_ret.items->n_items; i++) {
+ struct argpar_item *argpar_item =
+ argpar_parse_ret.items->items[i];
+ struct argpar_item_opt *argpar_item_opt;
const char *arg;
- /* This command does not accept leftover 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;
+ /* This command does not accept non-option arguments.*/
+ if (argpar_item->type == ARGPAR_ITEM_TYPE_NON_OPT) {
+ struct argpar_item_non_opt *argpar_nonopt_item =
+ (struct argpar_item_non_opt *) argpar_item;
BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
argpar_nonopt_item->arg);
goto error;
}
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
+ argpar_item_opt = (struct 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;
case OPT_COMPONENT:
{
- enum bt_config_component_dest new_dest;
-
- if (cur_cfg_comp) {
- ret = add_run_cfg_comp_check_name(cfg,
- cur_cfg_comp, cur_cfg_comp_dest,
- instance_names);
- BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
- if (ret) {
- goto error;
- }
- }
+ enum bt_config_component_dest dest;
+ BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
cur_cfg_comp = bt_config_component_from_arg(arg,
default_log_level);
if (!cur_cfg_comp) {
switch (cur_cfg_comp->type) {
case BT_COMPONENT_CLASS_TYPE_SOURCE:
- new_dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
+ dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
break;
case BT_COMPONENT_CLASS_TYPE_FILTER:
- new_dest = BT_CONFIG_COMPONENT_DEST_FILTER;
+ dest = BT_CONFIG_COMPONENT_DEST_FILTER;
break;
case BT_COMPONENT_CLASS_TYPE_SINK:
- new_dest = BT_CONFIG_COMPONENT_DEST_SINK;
+ dest = BT_CONFIG_COMPONENT_DEST_SINK;
break;
default:
- abort();
+ bt_common_abort();
}
BT_ASSERT(cur_base_params);
goto error;
}
- cur_cfg_comp_dest = new_dest;
+ ret = add_run_cfg_comp_check_name(cfg,
+ cur_cfg_comp, dest,
+ instance_names);
+ if (ret) {
+ goto error;
+ }
+
break;
}
case OPT_PARAMS:
{
bt_value *params;
- bt_value *params_to_set;
if (!cur_cfg_comp) {
BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
goto error;
}
- params = cli_value_from_arg(arg, error_str);
+ params = bt_param_parse(arg, error_str);
if (!params) {
BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
error_str->str);
goto error;
}
- extend_status = bt_value_map_extend(
- cur_cfg_comp->params, params, ¶ms_to_set);
+ extend_status = bt_value_map_extend(cur_cfg_comp->params,
+ params);
BT_VALUE_PUT_REF_AND_RESET(params);
if (extend_status != BT_VALUE_MAP_EXTEND_STATUS_OK) {
BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
goto error;
}
- BT_OBJECT_MOVE_REF(cur_cfg_comp->params, params_to_set);
break;
}
- case OPT_NAME:
- if (!cur_cfg_comp) {
- BT_CLI_LOGE_APPEND_CAUSE("Cannot set the name of unavailable component:\n %s",
- arg);
- goto error;
- }
-
- g_string_assign(cur_cfg_comp->instance_name, arg);
- break;
case OPT_LOG_LEVEL:
if (!cur_cfg_comp) {
BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
break;
case OPT_BASE_PARAMS:
{
- bt_value *params = cli_value_from_arg(arg, error_str);
+ bt_value *params = bt_param_parse(arg, error_str);
if (!params) {
BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
}
}
- /* Add current component */
- if (cur_cfg_comp) {
- ret = add_run_cfg_comp_check_name(cfg, cur_cfg_comp,
- cur_cfg_comp_dest, instance_names);
- BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
- if (ret) {
- goto error;
- }
- }
+ BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
if (cfg->cmd_data.run.sources->len == 0) {
BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
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);
g_string_free(error_str, TRUE);
}
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ argpar_parse_ret_fini(&argpar_parse_ret);
BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
BT_VALUE_PUT_REF_AND_RESET(cur_base_params);
BT_VALUE_PUT_REF_AND_RESET(instance_names);
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);
+ uint64_t i, len = bt_value_array_get_length(run_args);
- argv = calloc(argc, sizeof(*argv));
+ BT_ASSERT(len <= SIZE_MAX);
+ argv = calloc((size_t) len, sizeof(*argv));
if (!argv) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto end;
}
- len = bt_value_array_get_size(run_args);
- if (len < 0) {
- BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
- goto end;
- }
for (i = 0; i < len; i++) {
const bt_value *arg_value =
bt_value_array_borrow_element_by_index_const(run_args,
- i);
+ i);
const char *arg;
- BT_ASSERT(arg_value);
arg = bt_value_string_get(arg_value);
BT_ASSERT(arg);
argv[i] = arg;
}
- 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);
+ cfg = bt_config_run_from_args((int) len, argv, retcode,
+ plugin_paths, default_log_level);
end:
free(argv);
fprintf(fp, " TYPE (`source`, `filter`, or `sink`) found\n");
fprintf(fp, " in the plugin PLUGIN, add it to the\n");
fprintf(fp, " conversion graph, and optionally name it\n");
- fprintf(fp, " NAME (you can also specify the name with\n");
- fprintf(fp, " --name)\n");
+ 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, " --name=NAME Set the name of the current component\n");
- fprintf(fp, " to NAME (must be unique amongst all the\n");
- fprintf(fp, " names of the created components)\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, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\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, " -P, --path=PATH Set the `path` string parameter of the\n");
- fprintf(fp, " current component to 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, " --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");
fprintf(fp, " formatted for `xargs -0`, and quit\n");
fprintf(fp, " --stream-intersection Only process events when all streams\n");
fprintf(fp, " are active\n");
- fprintf(fp, " -u, --url=URL Set the `url` string parameter of the\n");
- fprintf(fp, " current component to URL\n");
fprintf(fp, " -h, --help Show this help and quit\n");
fprintf(fp, "\n");
fprintf(fp, "Implicit `source.ctf.fs` component options:\n");
fprintf(fp, "\n");
+ fprintf(fp, " --clock-force-correlate Force the origin of all clocks\n");
+ fprintf(fp, " to the Unix epoch\n");
fprintf(fp, " --clock-offset=SEC Set clock offset to SEC seconds\n");
fprintf(fp, " --clock-offset-ns=NS Set clock offset to NS ns\n");
fprintf(fp, "\n");
fprintf(fp, " -w, --output=PATH Write output text to PATH instead of\n");
fprintf(fp, " the standard output\n");
fprintf(fp, "\n");
- fprintf(fp, "Implicit `filter.utils.muxer` component options:\n");
- fprintf(fp, "\n");
- fprintf(fp, " --clock-force-correlate Assume that clocks are inherently\n");
- fprintf(fp, " correlated across traces\n");
- fprintf(fp, "\n");
fprintf(fp, "Implicit `filter.utils.trimmer` component options:\n");
fprintf(fp, "\n");
fprintf(fp, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
}
static
-const struct bt_argpar_opt_descr convert_options[] = {
+const struct argpar_opt_descr convert_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_BEGIN, 'b', "begin", true },
{ OPT_CLOCK_CYCLES, '\0', "clock-cycles", false },
{ OPT_HELP, 'h', "help", false },
{ OPT_INPUT_FORMAT, 'i', "input-format", true },
{ OPT_LOG_LEVEL, 'l', "log-level", true },
- { OPT_NAME, '\0', "name", true },
{ OPT_NAMES, 'n', "names", true },
{ OPT_DEBUG_INFO, '\0', "debug-info", false },
{ OPT_NO_DELTA, '\0', "no-delta", false },
{ OPT_OUTPUT, 'w', "output", true },
{ OPT_OUTPUT_FORMAT, 'o', "output-format", true },
{ OPT_PARAMS, 'p', "params", true },
- { OPT_PATH, 'P', "path", true },
{ OPT_PLUGIN_PATH, '\0', "plugin-path", true },
{ OPT_RETRY_DURATION, '\0', "retry-duration", true },
{ OPT_RUN_ARGS, '\0', "run-args", false },
{ OPT_RUN_ARGS_0, '\0', "run-args-0", false },
{ OPT_STREAM_INTERSECTION, '\0', "stream-intersection", false },
{ OPT_TIMERANGE, '\0', "timerange", true },
- { OPT_URL, 'u', "url", true },
{ OPT_VERBOSE, 'v', "verbose", false },
- BT_ARGPAR_OPT_DESCR_SENTINEL
+ ARGPAR_OPT_DESCR_SENTINEL
};
static
bt_value *run_args)
{
int ret = 0;
- size_t i;
+ uint64_t i;
+ GString *component_arg_for_run = NULL;
if (!impl_args->exists) {
goto end;
}
- if (bt_value_array_append_string_element(run_args, "--component")) {
+ component_arg_for_run = g_string_new(NULL);
+ if (!component_arg_for_run) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- if (bt_value_array_append_string_element(run_args, impl_args->comp_arg->str)) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ /* Build the full `name:type.plugin.cls`. */
+ BT_ASSERT(!strchr(impl_args->name_arg->str, '\\'));
+ BT_ASSERT(!strchr(impl_args->name_arg->str, ':'));
+ g_string_printf(component_arg_for_run, "%s:%s",
+ impl_args->name_arg->str, impl_args->comp_arg->str);
- if (bt_value_array_append_string_element(run_args, "--name")) {
+ if (bt_value_array_append_string_element(run_args, "--component")) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- if (bt_value_array_append_string_element(run_args, impl_args->name_arg->str)) {
+ if (bt_value_array_append_string_element(run_args,
+ component_arg_for_run->str)) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
}
}
- for (i = 0; i < bt_value_array_get_size(impl_args->extra_params);
- i++) {
+ for (i = 0; i < bt_value_array_get_length(impl_args->extra_params); i++) {
const bt_value *elem;
const char *arg;
- elem = bt_value_array_borrow_element_by_index(impl_args->extra_params,
- i);
- if (!elem) {
- goto error;
- }
+ elem = bt_value_array_borrow_element_by_index(
+ impl_args->extra_params, i);
BT_ASSERT(bt_value_is_string(elem));
arg = bt_value_string_get(elem);
ret = -1;
end:
+ if (component_arg_for_run) {
+ g_string_free(component_arg_for_run, TRUE);
+ }
+
return ret;
}
}
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;
if (i > 0) {
g_string_append(buf, ", ");
break;
}
default:
- abort();
+ bt_common_abort();
}
ret = 0;
return append_string_parameter_to_args(args->extra_params, key, value);
}
-static
-int convert_append_name_param(enum bt_config_component_dest dest,
- GString *cur_name, GString *cur_name_prefix,
- bt_value *run_args,
- bt_value *all_names,
- GList **source_names, GList **filter_names,
- GList **sink_names)
-{
- int ret = 0;
-
- if (cur_name_prefix->len > 0) {
- /* We're after a --component option */
- GString *name = NULL;
- bool append_name_opt = false;
-
- if (cur_name->len == 0) {
- /*
- * No explicit name was provided for the user
- * component.
- */
- name = get_component_auto_name(cur_name_prefix->str,
- all_names);
- append_name_opt = true;
- } else {
- /*
- * An explicit name was provided for the user
- * component.
- */
- if (bt_value_map_has_entry(all_names,
- cur_name->str)) {
- BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
- cur_name->str);
- goto error;
- }
-
- name = g_string_new(cur_name->str);
- }
-
- if (!name) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
-
- /*
- * Remember this name globally, for the uniqueness of
- * all component names.
- */
- if (bt_value_map_insert_entry(all_names, name->str, bt_value_null)) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
-
- /*
- * Append the --name option if necessary.
- */
- if (append_name_opt) {
- if (bt_value_array_append_string_element(run_args, "--name")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
-
- if (bt_value_array_append_string_element(run_args, name->str)) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
- }
-
- /*
- * Remember this name specifically for the type of the
- * component. This is to create connection arguments.
- */
- switch (dest) {
- case BT_CONFIG_COMPONENT_DEST_SOURCE:
- *source_names = g_list_append(*source_names, name);
- break;
- case BT_CONFIG_COMPONENT_DEST_FILTER:
- *filter_names = g_list_append(*filter_names, name);
- break;
- case BT_CONFIG_COMPONENT_DEST_SINK:
- *sink_names = g_list_append(*sink_names, name);
- break;
- default:
- abort();
- }
-
- g_string_assign(cur_name_prefix, "");
- }
-
- goto end;
-
-error:
- ret = -1;
-
-end:
- return ret;
-}
-
/*
* Escapes `.`, `:`, and `\` of `input` with `\`.
*/
}
/*
- * 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`.
+ *
+ * `non_opts` is an array of the non-option arguments passed on the command
+ * line.
+ *
+ * `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 `non_opt_params` would contain
+ *
+ * ["a=2", "b=3,c=4"]
*/
static
-void create_implicit_component_args_from_auto_discovered_sources(
- const struct auto_source_discovery *auto_disc, GPtrArray *component_args)
+int create_implicit_component_args_from_auto_discovered_sources(
+ const struct auto_source_discovery *auto_disc,
+ const bt_value *non_opts,
+ const bt_value *non_opt_params,
+ const bt_value *non_opt_loglevels,
+ GPtrArray *component_args)
{
gchar *cc_name = NULL;
struct implicit_component_args *comp = NULL;
for (i = 0; i < len; i++) {
struct auto_source_discovery_result *res =
g_ptr_array_index(auto_disc->results, i);
+ uint64_t orig_indices_i, orig_indices_count;
g_free(cc_name);
cc_name = g_strdup_printf("source.%s.%s", res->plugin_name, res->source_cc_name);
if (!cc_name) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto end;
+ goto error;
}
comp = create_implicit_component_args(cc_name);
if (!comp) {
- goto end;
+ goto error;
+ }
+
+ /*
+ * 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_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(
+ res->original_input_indices, orig_indices_i);
+ 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(
+ non_opt_params, orig_idx);
+ uint64_t params_i, params_count;
+ const bt_value *loglevel_value;
+
+ 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(
+ params_array, params_i);
+ const char *params = bt_value_string_get(params_value);
+ bt_value_array_append_element_status append_status;
+
+ append_status = bt_value_array_append_string_element(
+ comp->extra_params, "--params");
+ if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
+ BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
+ goto error;
+ }
+
+ append_status = bt_value_array_append_string_element(
+ comp->extra_params, params);
+ if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
+ BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
+ goto error;
+ }
+ }
+
+ loglevel_value = bt_value_array_borrow_element_by_index_const(
+ 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;
+
+ append_status = bt_value_array_append_string_element(
+ comp->extra_params, "--log-level");
+ if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
+ BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
+ goto error;
+ }
+
+ append_status = bt_value_array_append_string_element(
+ comp->extra_params, loglevel);
+ if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
+ BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
+ goto error;
+ }
+ }
+ }
+
+ /*
+ * If single input and a src.ctf.fs component, provide the
+ * relative path from the path passed on the command line to the
+ * found trace.
+ */
+ if (bt_value_array_get_length(res->inputs) == 1 &&
+ strcmp(res->plugin_name, "ctf") == 0 &&
+ strcmp(res->source_cc_name, "fs") == 0) {
+ const bt_value *orig_idx_value =
+ bt_value_array_borrow_element_by_index(
+ res->original_input_indices, 0);
+ uint64_t orig_idx = bt_value_integer_unsigned_get(orig_idx_value);
+ const bt_value *non_opt_value =
+ bt_value_array_borrow_element_by_index_const(
+ non_opts, orig_idx);
+ const char *non_opt = bt_value_string_get(non_opt_value);
+ const bt_value *input_value =
+ bt_value_array_borrow_element_by_index_const(
+ res->inputs, 0);
+ const char *input = bt_value_string_get(input_value);
+
+ BT_ASSERT(orig_indices_count == 1);
+ BT_ASSERT(g_str_has_prefix(input, non_opt));
+
+ input += strlen(non_opt);
+
+ while (G_IS_DIR_SEPARATOR(*input)) {
+ input++;
+ }
+
+ if (strlen(input) > 0) {
+ append_string_parameter_to_args(comp->extra_params,
+ "trace-name", input);
+ }
}
status = append_parameter_to_args(comp->extra_params, "inputs", res->inputs);
if (status != 0) {
- goto end;
+ goto error;
}
g_ptr_array_add(component_args, comp);
comp = NULL;
}
+ status = 0;
+ goto end;
+
+error:
+ status = -1;
+
end:
g_free(cc_name);
if (comp) {
destroy_implicit_component_args(comp);
}
+
+ return status;
}
+/*
+ * As we iterate the arguments to the convert command, this tracks what is the
+ * type of the current item, to which some contextual options (e.g. --params)
+ * apply to.
+ */
+enum convert_current_item_type {
+ /* There is no current item. */
+ CONVERT_CURRENT_ITEM_TYPE_NONE,
+
+ /* Current item is a component. */
+ CONVERT_CURRENT_ITEM_TYPE_COMPONENT,
+
+ /* Current item is a non-option argument. */
+ CONVERT_CURRENT_ITEM_TYPE_NON_OPT,
+};
+
/*
* Creates a Babeltrace config object from the arguments of a convert
* command.
*/
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, const bt_interrupter *interrupter)
{
- enum bt_config_component_dest cur_comp_dest =
- BT_CONFIG_COMPONENT_DEST_UNKNOWN;
+ enum convert_current_item_type current_item_type =
+ CONVERT_CURRENT_ITEM_TYPE_NONE;
int ret = 0;
struct bt_config *cfg = NULL;
bool got_input_format_opt = false;
bool trimmer_has_begin = false;
bool trimmer_has_end = false;
bool stream_intersection_mode = false;
- GString *cur_name = NULL;
- GString *cur_name_prefix = NULL;
bool print_run_args = false;
bool print_run_args_0 = false;
bool print_ctf_metadata = false;
GList *source_names = NULL;
GList *filter_names = NULL;
GList *sink_names = NULL;
- bt_value *leftovers = 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 };
char *output = NULL;
struct auto_source_discovery auto_disc = { NULL };
GString *auto_disc_comp_name = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ struct argpar_parse_ret argpar_parse_ret = { 0 };
+ GString *name_gstr = NULL;
+ GString *component_arg_for_run = NULL;
+ bt_value *live_inputs_array_val = NULL;
/*
* Array of `struct implicit_component_args *` created for the sources
const char *auto_source_discovery_restrict_plugin_name = NULL;
const char *auto_source_discovery_restrict_component_class_name = NULL;
+ bool ctf_fs_source_force_clock_class_unix_epoch_origin = false;
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;
}
- cur_name = g_string_new(NULL);
- if (!cur_name) {
+ component_arg_for_run = g_string_new(NULL);
+ if (!component_arg_for_run) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- cur_name_prefix = g_string_new(NULL);
- if (!cur_name_prefix) {
+ non_opts = bt_value_array_create();
+ if (!non_opts) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- ret = append_env_var_plugin_paths(plugin_paths);
- if (ret) {
+ non_opt_params = bt_value_array_create();
+ if (!non_opt_params) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
- leftovers = bt_value_array_create();
- if (!leftovers) {
+ non_opt_loglevels = bt_value_array_create();
+ if (!non_opt_loglevels) {
BT_CLI_LOGE_APPEND_CAUSE_OOM();
goto error;
}
* First pass: collect all arguments which need to be passed
* as is to the run command. This pass can also add --name
* arguments if needed to automatically name unnamed component
- * instances. Also it does the following transformations:
- *
- * --path=PATH -> --params=path="PATH"
- * --url=URL -> --params=url="URL"
- *
- * Also it appends the plugin paths of --plugin-path to
- * `plugin_paths`.
+ * instances.
*/
- argpar_parse_ret = bt_argpar_parse(argc, argv, convert_options, true);
+ argpar_parse_ret = argpar_parse(argc, argv, convert_options, true);
if (argpar_parse_ret.error) {
BT_CLI_LOGE_APPEND_CAUSE(
"While parsing `convert` command's command-line arguments: %s",
- argpar_parse_ret.error->str);
+ argpar_parse_ret.error);
goto 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;
+ for (i = 0; i < argpar_parse_ret.items->n_items; i++) {
+ struct argpar_item *argpar_item =
+ argpar_parse_ret.items->items[i];
+ struct argpar_item_opt *argpar_item_opt;
char *name = NULL;
char *plugin_name = NULL;
char *comp_cls_name = NULL;
const char *arg;
- if (argpar_item->type != BT_ARGPAR_ITEM_TYPE_OPT) {
- continue;
- }
+ if (argpar_item->type == ARGPAR_ITEM_TYPE_OPT) {
+ argpar_item_opt = (struct argpar_item_opt *) argpar_item;
+ arg = argpar_item_opt->arg;
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
- arg = argpar_item_opt->arg;
-
- switch (argpar_item_opt->descr->id) {
- case OPT_COMPONENT:
- {
- bt_component_class_type type;
- const char *type_prefix;
+ switch (argpar_item_opt->descr->id) {
+ case OPT_COMPONENT:
+ {
+ bt_component_class_type type;
- /* Append current component's name if needed */
- ret = convert_append_name_param(cur_comp_dest, cur_name,
- cur_name_prefix, run_args, all_names,
- &source_names, &filter_names, &sink_names);
- if (ret) {
- goto error;
- }
+ current_item_type = CONVERT_CURRENT_ITEM_TYPE_COMPONENT;
- /* Parse the argument */
- plugin_comp_cls_names(arg, &name, &plugin_name,
- &comp_cls_name, &type);
- if (!plugin_name || !comp_cls_name) {
- BT_CLI_LOGE_APPEND_CAUSE(
- "Invalid format for --component option's argument:\n %s",
- arg);
- goto error;
- }
+ /* Parse the argument */
+ plugin_comp_cls_names(arg, &name, &plugin_name,
+ &comp_cls_name, &type);
+ if (!plugin_name || !comp_cls_name) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Invalid format for --component option's argument:\n %s",
+ arg);
+ goto error;
+ }
- if (name) {
- g_string_assign(cur_name, name);
- } else {
- g_string_assign(cur_name, "");
- }
+ if (name) {
+ /*
+ * Name was given by the user, verify it isn't
+ * taken.
+ */
+ if (bt_value_map_has_entry(all_names, name)) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Duplicate component instance name:\n %s",
+ name);
+ goto error;
+ }
- switch (type) {
- case BT_COMPONENT_CLASS_TYPE_SOURCE:
- cur_comp_dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
- type_prefix = "source";
- break;
- case BT_COMPONENT_CLASS_TYPE_FILTER:
- cur_comp_dest = BT_CONFIG_COMPONENT_DEST_FILTER;
- type_prefix = "filter";
- break;
- case BT_COMPONENT_CLASS_TYPE_SINK:
- cur_comp_dest = BT_CONFIG_COMPONENT_DEST_SINK;
- type_prefix = "sink";
- break;
- default:
- abort();
- }
+ name_gstr = g_string_new(name);
+ if (!name_gstr) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
- if (bt_value_array_append_string_element(run_args,
- "--component")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ g_string_assign(component_arg_for_run, arg);
+ } else {
+ /* Name not given by user, generate one. */
+ name_gstr = get_component_auto_name(arg, all_names);
+ if (!name_gstr) {
+ goto error;
+ }
- if (bt_value_array_append_string_element(run_args, arg)) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ g_string_printf(component_arg_for_run, "%s:%s",
+ name_gstr->str, arg);
+ }
- g_string_assign(cur_name_prefix, "");
- g_string_append_printf(cur_name_prefix, "%s.%s.%s",
- type_prefix, plugin_name, comp_cls_name);
- free(name);
- free(plugin_name);
- free(comp_cls_name);
- name = NULL;
- plugin_name = NULL;
- comp_cls_name = NULL;
- break;
- }
- case OPT_PARAMS:
- if (cur_name_prefix->len == 0) {
- BT_CLI_LOGE_APPEND_CAUSE("No current component of which to set parameters:\n %s",
- arg);
- goto error;
- }
+ if (bt_value_array_append_string_element(run_args,
+ "--component")) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
- if (bt_value_array_append_string_element(run_args,
- "--params")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ if (bt_value_array_append_string_element(run_args,
+ component_arg_for_run->str)) {
+ 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;
- }
- break;
- case OPT_PATH:
- if (cur_name_prefix->len == 0) {
- BT_CLI_LOGE_APPEND_CAUSE("No current component of which to set `path` parameter:\n %s",
- arg);
- goto error;
- }
+ /*
+ * Remember this name globally, for the uniqueness of
+ * all component names.
+ */
+ if (bt_value_map_insert_entry(all_names,
+ name_gstr->str, bt_value_null)) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
- if (append_string_parameter_to_args(run_args, "path", arg)) {
- goto error;
- }
- break;
- case OPT_URL:
- if (cur_name_prefix->len == 0) {
- BT_CLI_LOGE_APPEND_CAUSE("No current component of which to set `url` parameter:\n %s",
- arg);
- goto error;
+ /*
+ * Remember this name specifically for the type of the
+ * component. This is to create connection arguments.
+ *
+ * The list takes ownership of `name_gstr`.
+ */
+ switch (type) {
+ case BT_COMPONENT_CLASS_TYPE_SOURCE:
+ source_names = g_list_append(source_names, name_gstr);
+ break;
+ case BT_COMPONENT_CLASS_TYPE_FILTER:
+ filter_names = g_list_append(filter_names, name_gstr);
+ break;
+ case BT_COMPONENT_CLASS_TYPE_SINK:
+ sink_names = g_list_append(sink_names, name_gstr);
+ break;
+ default:
+ bt_common_abort();
+ }
+ name_gstr = NULL;
+
+ free(name);
+ free(plugin_name);
+ free(comp_cls_name);
+ name = NULL;
+ plugin_name = NULL;
+ comp_cls_name = NULL;
+ break;
}
+ case OPT_PARAMS:
+ if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_COMPONENT) {
+ /*
+ * The current item is a component (--component option),
+ * pass it directly to the run args.
+ */
+ if (bt_value_array_append_string_element(run_args,
+ "--params")) {
+ 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;
+ }
+ } 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;
+ bt_value_array_append_element_status append_element_status;
+ uint64_t idx = bt_value_array_get_length(non_opt_params) - 1;
- if (append_string_parameter_to_args(run_args, "url", arg)) {
- goto error;
- }
- break;
- case OPT_NAME:
- if (cur_name_prefix->len == 0) {
- BT_CLI_LOGE_APPEND_CAUSE("No current component to name:\n %s",
- arg);
- goto error;
- }
+ array = bt_value_array_borrow_element_by_index(non_opt_params, idx);
- if (bt_value_array_append_string_element(run_args, "--name")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ append_element_status = bt_value_array_append_string_element(array, arg);
+ if (append_element_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
+ } else {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "No current component (--component option) or non-option argument of which to set parameters:\n %s",
+ arg);
+ goto error;
+ }
+ break;
+ case OPT_LOG_LEVEL:
+ if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_COMPONENT) {
+ if (bt_value_array_append_string_element(run_args, "--log-level")) {
+ 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;
- }
+ if (bt_value_array_append_string_element(run_args, arg)) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
+ } else if (current_item_type == CONVERT_CURRENT_ITEM_TYPE_NON_OPT) {
+ uint64_t idx = bt_value_array_get_length(non_opt_loglevels) - 1;
+ enum bt_value_array_set_element_by_index_status set_element_status;
+ bt_value *log_level_str_value;
+
+ log_level_str_value = bt_value_string_create_init(arg);
+ if (!log_level_str_value) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
- g_string_assign(cur_name, arg);
- break;
- case OPT_LOG_LEVEL:
- if (cur_name_prefix->len == 0) {
- BT_CLI_LOGE_APPEND_CAUSE("No current component to assign a log level to:\n %s",
- arg);
- goto error;
- }
+ set_element_status =
+ bt_value_array_set_element_by_index(non_opt_loglevels,
+ idx, log_level_str_value);
+ bt_value_put_ref(log_level_str_value);
+ if (set_element_status != BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
+ } else {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "No current component (--component option) or non-option argument to assign a log level to:\n %s",
+ arg);
+ goto error;
+ }
- if (bt_value_array_append_string_element(run_args, "--log-level")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ break;
+ case OPT_RETRY_DURATION:
+ if (bt_value_array_append_string_element(run_args,
+ "--retry-duration")) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
- if (bt_value_array_append_string_element(run_args, arg)) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ if (bt_value_array_append_string_element(run_args, arg)) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
+ break;
+ case OPT_BEGIN:
+ case OPT_CLOCK_CYCLES:
+ case OPT_CLOCK_DATE:
+ case OPT_CLOCK_FORCE_CORRELATE:
+ case OPT_CLOCK_GMT:
+ case OPT_CLOCK_OFFSET:
+ case OPT_CLOCK_OFFSET_NS:
+ case OPT_CLOCK_SECONDS:
+ case OPT_COLOR:
+ case OPT_DEBUG:
+ case OPT_DEBUG_INFO:
+ case OPT_DEBUG_INFO_DIR:
+ case OPT_DEBUG_INFO_FULL_PATH:
+ case OPT_DEBUG_INFO_TARGET_PREFIX:
+ case OPT_END:
+ case OPT_FIELDS:
+ case OPT_INPUT_FORMAT:
+ case OPT_NAMES:
+ case OPT_NO_DELTA:
+ case OPT_OUTPUT_FORMAT:
+ case OPT_OUTPUT:
+ case OPT_RUN_ARGS:
+ case OPT_RUN_ARGS_0:
+ case OPT_STREAM_INTERSECTION:
+ case OPT_TIMERANGE:
+ case OPT_VERBOSE:
+ /* Ignore in this pass */
+ break;
+ default:
+ BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
+ argpar_item_opt->descr->id);
goto error;
}
+ } else if (argpar_item->type == ARGPAR_ITEM_TYPE_NON_OPT) {
+ struct argpar_item_non_opt *argpar_item_non_opt;
+ bt_value_array_append_element_status append_status;
- break;
- case OPT_OMIT_HOME_PLUGIN_PATH:
- force_omit_home_plugin_path = true;
+ current_item_type = CONVERT_CURRENT_ITEM_TYPE_NON_OPT;
- 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,
- "--retry-duration")) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- goto error;
- }
+ argpar_item_non_opt = (struct argpar_item_non_opt *) argpar_item;
- if (bt_value_array_append_string_element(run_args, arg)) {
+ 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;
}
- 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")) {
+ 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;
}
- if (bt_value_array_append_string_element(run_args, arg)) {
+ 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;
}
- break;
- case OPT_BEGIN:
- case OPT_CLOCK_CYCLES:
- case OPT_CLOCK_DATE:
- case OPT_CLOCK_FORCE_CORRELATE:
- case OPT_CLOCK_GMT:
- case OPT_CLOCK_OFFSET:
- case OPT_CLOCK_OFFSET_NS:
- case OPT_CLOCK_SECONDS:
- case OPT_COLOR:
- case OPT_DEBUG:
- case OPT_DEBUG_INFO:
- case OPT_DEBUG_INFO_DIR:
- case OPT_DEBUG_INFO_FULL_PATH:
- case OPT_DEBUG_INFO_TARGET_PREFIX:
- case OPT_END:
- case OPT_FIELDS:
- case OPT_INPUT_FORMAT:
- case OPT_NAMES:
- case OPT_NO_DELTA:
- case OPT_OUTPUT_FORMAT:
- case OPT_OUTPUT:
- case OPT_RUN_ARGS:
- case OPT_RUN_ARGS_0:
- case OPT_STREAM_INTERSECTION:
- case OPT_TIMERANGE:
- case OPT_VERBOSE:
- /* Ignore in this pass */
- break;
- default:
- BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
- argpar_item_opt->descr->id);
- goto error;
+ } else {
+ bt_common_abort();
}
}
- /* Append current component's name if needed */
- ret = convert_append_name_param(cur_comp_dest, cur_name,
- cur_name_prefix, run_args, all_names, &source_names,
- &filter_names, &sink_names);
- if (ret) {
- goto error;
- }
-
/*
* Second pass: transform the convert-specific options and
* arguments into implicit component instances for the run
* command.
*/
- 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;
+ for (i = 0; i < argpar_parse_ret.items->n_items; i++) {
+ struct argpar_item *argpar_item =
+ argpar_parse_ret.items->items[i];
+ struct argpar_item_opt *argpar_item_opt;
const char *arg;
- if (argpar_item->type != BT_ARGPAR_ITEM_TYPE_OPT) {
+ if (argpar_item->type != ARGPAR_ITEM_TYPE_OPT) {
continue;
}
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
+ argpar_item_opt = (struct argpar_item_opt *) argpar_item;
arg = argpar_item_opt->arg;
switch (argpar_item_opt->descr->id) {
case OPT_BEGIN:
if (trimmer_has_begin) {
- printf("At --begin option: --begin or --timerange option already specified\n %s\n",
+ BT_CLI_LOGE_APPEND_CAUSE("At --begin option: --begin or --timerange option already specified\n %s\n",
arg);
goto error;
}
break;
case OPT_END:
if (trimmer_has_end) {
- printf("At --end option: --end or --timerange option already specified\n %s\n",
+ BT_CLI_LOGE_APPEND_CAUSE("At --end option: --end or --timerange option already specified\n %s\n",
arg);
goto error;
}
char *end;
if (trimmer_has_begin || trimmer_has_end) {
- printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
+ BT_CLI_LOGE_APPEND_CAUSE("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
arg);
goto error;
}
implicit_text_args.exists = true;
break;
case OPT_CLOCK_FORCE_CORRELATE:
- append_implicit_component_param(
- &implicit_muxer_args,
- "assume-absolute-clock-classes", "yes");
+ ctf_fs_source_force_clock_class_unix_epoch_origin = true;
break;
case OPT_CLOCK_GMT:
append_implicit_component_param(
case OPT_STREAM_INTERSECTION:
/*
* Applies to all traces implementing the
- * babeltrace.trace-info query.
+ * babeltrace.trace-infos query.
*/
stream_intersection_mode = true;
break;
case OPT_VERBOSE:
- if (*default_log_level != BT_LOG_TRACE &&
- *default_log_level != BT_LOG_DEBUG) {
- *default_log_level = BT_LOG_INFO;
- }
+ *default_log_level =
+ logging_level_min(*default_log_level, BT_LOG_INFO);
break;
case OPT_DEBUG:
- *default_log_level = BT_LOG_TRACE;
+ *default_log_level =
+ logging_level_min(*default_log_level, BT_LOG_TRACE);
break;
default:
break;
}
}
+ set_auto_log_levels(default_log_level);
+
/*
* Legacy behaviour: --verbose used to make the `text` output
* format print more information. --verbose is now equivalent to
"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;
- }
-
- /* Consume and keep leftover arguments */
- 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_non_opt *argpar_item_non_opt;
-
- if (argpar_item->type != BT_ARGPAR_ITEM_TYPE_NON_OPT) {
- continue;
- }
-
- argpar_item_non_opt = (struct bt_argpar_item_non_opt *) argpar_item;
-
- if (bt_value_array_append_string_element(leftovers, argpar_item_non_opt->arg) !=
- BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
- BT_CLI_LOGE_APPEND_CAUSE_OOM();
- 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(
goto end;
}
- ret = append_implicit_component_extra_param(
- &implicit_lttng_live_args, "url",
- bt_value_string_get(bt_val_leftover));
+ live_inputs_array_val = bt_value_array_create();
+ if (!live_inputs_array_val) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
+
+ if (bt_value_array_append_string_element(
+ live_inputs_array_val,
+ bt_value_string_get(bt_val_non_opt))) {
+ BT_CLI_LOGE_APPEND_CAUSE_OOM();
+ goto error;
+ }
+
+ ret = append_parameter_to_args(
+ implicit_lttng_live_args.extra_params,
+ "inputs", live_inputs_array_val);
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 = borrow_loaded_plugin_by_name(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);
+ *default_log_level, &auto_disc, interrupter);
if (status != 0) {
+ if (status == AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED) {
+ BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
+ "Babeltrace CLI", "Automatic source discovery interrupted by the user");
+ }
goto error;
}
- create_implicit_component_args_from_auto_discovered_sources(
- &auto_disc, discovered_source_args);
+ status = create_implicit_component_args_from_auto_discovered_sources(
+ &auto_disc, non_opts, non_opt_params, non_opt_loglevels,
+ discovered_source_args);
+ if (status != 0) {
+ goto error;
+ }
+ }
+ }
+
+
+ /*
+ * If --clock-force-correlated was given, apply it to any src.ctf.fs
+ * component.
+ */
+ if (ctf_fs_source_force_clock_class_unix_epoch_origin) {
+ int n;
+
+ n = append_multiple_implicit_components_param(
+ discovered_source_args, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
+ "yes");
+ if (n == 0) {
+ BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
+ 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:
* here.
*/
if (print_run_args || print_run_args_0) {
+ uint64_t args_idx, args_len;
if (stream_intersection_mode) {
BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
goto error;
}
- for (i = 0; i < bt_value_array_get_size(run_args); i++) {
+ args_len = bt_value_array_get_length(run_args);
+ for (args_idx = 0; args_idx < args_len; args_idx++) {
const bt_value *arg_value =
bt_value_array_borrow_element_by_index(run_args,
- i);
+ args_idx);
const char *arg;
GString *quoted = NULL;
const char *arg_to_print;
- BT_ASSERT(arg_value);
arg = bt_value_string_get(arg_value);
if (print_run_args) {
g_string_free(quoted, TRUE);
}
- if (i < bt_value_array_get_size(run_args) - 1) {
+ if (args_idx < args_len - 1) {
if (print_run_args) {
putchar(' ');
} else {
goto end;
}
- /*
- * If the log level is still unset at this point, set it to
- * the program's default.
- */
- if (*default_log_level < 0) {
- *default_log_level = cli_default_log_level;
- }
-
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;
}
BT_OBJECT_PUT_REF_AND_RESET(cfg);
end:
- /*
- * If the log level is still unset at this point, set it to
- * the program's default.
- */
- if (*default_log_level < 0) {
- *default_log_level = cli_default_log_level;
- }
-
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ argpar_parse_ret_fini(&argpar_parse_ret);
free(output);
- if (cur_name) {
- g_string_free(cur_name, TRUE);
+ if (component_arg_for_run) {
+ g_string_free(component_arg_for_run, TRUE);
}
- if (cur_name_prefix) {
- g_string_free(cur_name_prefix, TRUE);
+ if (name_gstr) {
+ g_string_free(name_gstr, TRUE);
}
+ bt_value_put_ref(live_inputs_array_val);
bt_value_put_ref(run_args);
bt_value_put_ref(all_names);
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=T)\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`, `T`, `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,
- const bt_value *initial_plugin_paths)
+ int *retcode, bool omit_system_plugin_path,
+ bool omit_home_plugin_path,
+ const bt_value *initial_plugin_paths,
+ const bt_interrupter *interrupter)
{
struct bt_config *config = NULL;
int i;
const char **command_argv = NULL;
const char *command_name = NULL;
int default_log_level = -1;
- struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ struct argpar_parse_ret argpar_parse_ret = { 0 };
+ bt_value *plugin_paths = NULL;
/* Top-level option descriptions. */
- static const struct bt_argpar_opt_descr descrs[] = {
+ static const struct argpar_opt_descr descrs[] = {
{ OPT_DEBUG, 'd', "debug", false },
{ OPT_HELP, 'h', "help", false },
{ OPT_LOG_LEVEL, 'l', "log-level", true },
{ OPT_VERBOSE, 'v', "verbose", false },
{ OPT_VERSION, 'V', "version", false},
- BT_ARGPAR_OPT_DESCR_SENTINEL
+ { 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 },
+ ARGPAR_OPT_DESCR_SENTINEL
};
enum command_type {
*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) {
/* Skip first argument, the name of the program. */
top_level_argc = argc - 1;
top_level_argv = argv + 1;
- argpar_parse_ret = bt_argpar_parse(top_level_argc, top_level_argv,
+ argpar_parse_ret = argpar_parse(top_level_argc, top_level_argv,
descrs, false);
if (argpar_parse_ret.error) {
BT_CLI_LOGE_APPEND_CAUSE(
"While parsing command-line arguments: %s",
- argpar_parse_ret.error->str);
+ argpar_parse_ret.error);
goto error;
}
- for (i = 0; i < argpar_parse_ret.items->len; i++) {
- struct bt_argpar_item *item;
+ for (i = 0; i < argpar_parse_ret.items->n_items; i++) {
+ struct argpar_item *item;
- item = g_ptr_array_index(argpar_parse_ret.items, i);
+ item = argpar_parse_ret.items->items[i];
- if (item->type == BT_ARGPAR_ITEM_TYPE_OPT) {
- struct bt_argpar_item_opt *item_opt =
- (struct bt_argpar_item_opt *) item;
+ if (item->type == ARGPAR_ITEM_TYPE_OPT) {
+ struct argpar_item_opt *item_opt =
+ (struct argpar_item_opt *) item;
switch (item_opt->descr->id) {
case OPT_DEBUG:
- default_log_level = BT_LOG_TRACE;
+ default_log_level =
+ logging_level_min(default_log_level, BT_LOG_TRACE);
break;
case OPT_VERBOSE:
- /*
- * Legacy: do not override a previous
- * --debug because --verbose and --debug
- * can be specified together (in this
- * case we want the lowest log level to
- * apply, TRACE).
- */
- default_log_level = BT_LOG_INFO;
+ default_log_level =
+ logging_level_min(default_log_level, BT_LOG_INFO);
break;
case OPT_LOG_LEVEL:
- default_log_level =
- bt_log_get_level_from_string(item_opt->arg);
- if (default_log_level < 0) {
+ {
+ int level = bt_log_get_level_from_string(item_opt->arg);
+
+ if (level < 0) {
BT_CLI_LOGE_APPEND_CAUSE(
"Invalid argument for --log-level option:\n %s",
item_opt->arg);
goto error;
}
+
+ default_log_level =
+ logging_level_min(default_log_level, level);
+ 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();
print_gen_usage(stdout);
goto end;
}
- } else if (item->type == BT_ARGPAR_ITEM_TYPE_NON_OPT) {
- struct bt_argpar_item_non_opt *item_non_opt =
- (struct bt_argpar_item_non_opt *) item;
+ } else if (item->type == ARGPAR_ITEM_TYPE_NON_OPT) {
+ struct argpar_item_non_opt *item_non_opt =
+ (struct argpar_item_non_opt *) item;
/*
* First unknown argument: is it a known command
* name?
if (strcmp(item_non_opt->arg, "convert") == 0) {
command_type = COMMAND_TYPE_CONVERT;
+ command_name = "convert";
} else if (strcmp(item_non_opt->arg, "list-plugins") == 0) {
command_type = COMMAND_TYPE_LIST_PLUGINS;
+ command_name = "list-plugins";
} else if (strcmp(item_non_opt->arg, "help") == 0) {
command_type = COMMAND_TYPE_HELP;
+ command_name = "help";
} else if (strcmp(item_non_opt->arg, "query") == 0) {
command_type = COMMAND_TYPE_QUERY;
+ command_name = "query";
} else if (strcmp(item_non_opt->arg, "run") == 0) {
command_type = COMMAND_TYPE_RUN;
+ command_name = "run";
} else {
/*
* Non-option argument, but not a known
BT_ASSERT(command_argc >= 0);
/*
- * The convert command can set its own default log level for
- * backward compatibility reasons. It only does so if there's no
- * log level yet, so do not force one for this command.
+ * For all commands other than `convert`, we now know the log level to
+ * use, so we can apply it with `set_auto_log_levels`.
+ *
+ * The convert command has `--debug` and `--verbose` arguments that are
+ * equivalent to the top-level arguments of the same name. So after it
+ * has parsed its arguments, `bt_config_convert_from_args` calls
+ * `set_auto_log_levels` itself.
+ */
+ if (command_type != COMMAND_TYPE_CONVERT) {
+ set_auto_log_levels(&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 (command_type != COMMAND_TYPE_CONVERT && default_log_level < 0) {
- /* Default log level */
- default_log_level = cli_default_log_level;
+ 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, interrupter);
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:
- abort();
+ bt_common_abort();
}
if (config) {
*retcode = 1;
end:
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
- bt_value_put_ref(initial_plugin_paths);
+ argpar_parse_ret_fini(&argpar_parse_ret);
+ bt_value_put_ref(plugin_paths);
return config;
}
projects / babeltrace.git / blobdiff