/*
- * 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 "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-query.h"
#include "autodisc/autodisc.h"
#include "common/version.h"
-/* 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;
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);
g_ptr_array_add(cfg->cmd_data.run.sinks, cfg_comp);
break;
default:
- abort();
+ bt_common_abort();
}
}
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;
}
static
-const struct bt_argpar_opt_descr help_options[] = {
+const struct argpar_opt_descr help_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_HELP, 'h', "help", false },
- BT_ARGPAR_OPT_DESCR_SENTINEL
+ ARGPAR_OPT_DESCR_SENTINEL
};
/*
{
struct bt_config *cfg = NULL;
char *plugin_name = NULL, *comp_cls_name = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
- struct bt_argpar_item_non_opt *non_opt;
+ 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(plugin_paths, default_log_level);
}
/* Parse options */
- argpar_parse_ret = bt_argpar_parse(argc, argv, help_options, true);
+ 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->str);
+ argpar_parse_ret.error);
goto error;
}
goto end;
}
- if (argpar_parse_ret.items->len == 0) {
+ 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->len > 1) {
+ } 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 = argpar_parse_ret.items->pdata[1];
+ 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;
}
- non_opt = argpar_parse_ret.items->pdata[0];
- plugin_comp_cls_names(non_opt->arg, NULL, &plugin_name, &comp_cls_name,
- &cfg->cmd_data.help.cfg_component->type);
- if (plugin_name && comp_cls_name) {
- /* Component class help */
+ 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;
+ }
+
+ 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) {
+ BT_CLI_LOGE_APPEND_CAUSE(
+ "Could not parse argument as a component class name: arg=%s",
+ non_opt->arg);
+ 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);
- } else {
- /* Fall back to plugin help */
- g_string_assign(cfg->cmd_data.help.cfg_component->plugin_name,
- non_opt->arg);
}
goto end;
g_free(plugin_name);
g_free(comp_cls_name);
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ if (substring) {
+ g_string_free(substring, TRUE);
+ }
+
+ argpar_parse_ret_fini(&argpar_parse_ret);
return cfg;
}
}
static
-const struct bt_argpar_opt_descr query_options[] = {
+const struct argpar_opt_descr query_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_HELP, 'h', "help", false },
{ OPT_PARAMS, 'p', "params", true },
- BT_ARGPAR_OPT_DESCR_SENTINEL
+ ARGPAR_OPT_DESCR_SENTINEL
};
/*
struct bt_config *cfg = NULL;
const char *component_class_spec = NULL;
const char *query_object = NULL;
- bt_value *params;
GString *error_str = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ 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(plugin_paths);
}
/* Parse options */
- argpar_parse_ret = bt_argpar_parse(argc, argv, query_options, true);
+ 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->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);
+ for (i = 0; i < argpar_parse_ret.items->n_items; i++) {
+ struct argpar_item *argpar_item =
+ argpar_parse_ret.items->items[i];
- if (argpar_item->type == BT_ARGPAR_ITEM_TYPE_OPT) {
- struct bt_argpar_item_opt *argpar_item_opt =
- (struct bt_argpar_item_opt *) argpar_item;
+ 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 (argpar_item_opt->descr->id) {
case OPT_PARAMS:
{
- bt_value_put_ref(params);
- params = cli_value_from_arg(arg, error_str);
- if (!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;
}
default:
goto error;
}
} else {
- struct bt_argpar_item_non_opt *argpar_item_non_opt
- = (struct bt_argpar_item_non_opt *) argpar_item;
+ struct argpar_item_non_opt *argpar_item_non_opt
+ = (struct argpar_item_non_opt *) argpar_item;
/*
* We need exactly two non-option arguments
BT_OBJECT_PUT_REF_AND_RESET(cfg);
end:
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ argpar_parse_ret_fini(&argpar_parse_ret);
if (error_str) {
g_string_free(error_str, TRUE);
}
static
-const struct bt_argpar_opt_descr list_plugins_options[] = {
+const struct argpar_opt_descr list_plugins_options[] = {
/* id, short_name, long_name, with_arg */
{ OPT_HELP, 'h', "help", false },
- BT_ARGPAR_OPT_DESCR_SENTINEL
+ ARGPAR_OPT_DESCR_SENTINEL
};
/*
int *retcode, const bt_value *plugin_paths)
{
struct bt_config *cfg = NULL;
- struct bt_argpar_parse_ret argpar_parse_ret = { 0 };
+ struct argpar_parse_ret argpar_parse_ret = { 0 };
*retcode = 0;
cfg = bt_config_list_plugins_create(plugin_paths);
}
/* Parse options */
- argpar_parse_ret = bt_argpar_parse(argc, argv, list_plugins_options, true);
+ 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->str);
+ argpar_parse_ret.error);
goto error;
}
goto end;
}
- if (argpar_parse_ret.items->len > 0) {
+ 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 bt_argpar_item_non_opt *non_opt =
- argpar_parse_ret.items->pdata[0];
+ struct argpar_item_non_opt *non_opt =
+ (struct argpar_item_non_opt *) argpar_parse_ret.items->items[0];
BT_CLI_LOGE_APPEND_CAUSE(
"Extraneous command-line argument specified to `list-plugins` command: `%s`.",
BT_OBJECT_PUT_REF_AND_RESET(cfg);
end:
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ argpar_parse_ret_fini(&argpar_parse_ret);
return cfg;
}
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`, `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");
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_PARAMS, 'p', "params", 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;
}
/* 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 non-option arguments.*/
- if (argpar_item->type == BT_ARGPAR_ITEM_TYPE_NON_OPT) {
- struct bt_argpar_item_non_opt *argpar_nonopt_item =
- (struct bt_argpar_item_non_opt *) argpar_item;
+ 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) {
dest = BT_CONFIG_COMPONENT_DEST_SINK;
break;
default:
- abort();
+ bt_common_abort();
}
BT_ASSERT(cur_base_params);
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_LOG_LEVEL:
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",
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);
{
struct bt_config *cfg = NULL;
const char **argv;
- int64_t i, len;
- const size_t argc = bt_value_array_get_length(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_length(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,
+ cfg = bt_config_run_from_args((int) len, argv, retcode,
plugin_paths, default_log_level);
end:
fprintf(fp, " conversion graph, and optionally name it\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, " (`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, "\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_STREAM_INTERSECTION, '\0', "stream-intersection", false },
{ OPT_TIMERANGE, '\0', "timerange", 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) {
}
}
- for (i = 0; i < bt_value_array_get_length(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);
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;
* 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
static
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)
}
}
+ /*
+ * 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 error;
static
struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
int *retcode, const bt_value *plugin_paths,
- int *default_log_level)
+ int *default_log_level, const bt_interrupter *interrupter)
{
enum convert_current_item_type current_item_type =
CONVERT_CURRENT_ITEM_TYPE_NONE;
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;
*retcode = 0;
* arguments if needed to automatically name unnamed component
* 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) {
- argpar_item_opt = (struct bt_argpar_item_opt *) argpar_item;
+ if (argpar_item->type == ARGPAR_ITEM_TYPE_OPT) {
+ argpar_item_opt = (struct argpar_item_opt *) argpar_item;
arg = argpar_item_opt->arg;
switch (argpar_item_opt->descr->id) {
sink_names = g_list_append(sink_names, name_gstr);
break;
default:
- abort();
+ bt_common_abort();
}
name_gstr = NULL;
* 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;
array = bt_value_array_borrow_element_by_index(non_opt_params, idx);
- bt_value_array_append_string_element(array, arg);
+
+ 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",
}
} 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);
goto error;
}
- if (bt_value_array_set_element_by_index(non_opt_loglevels, idx,
- log_level_str_value)) {
- bt_value_put_ref(log_level_str_value);
+ 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;
}
argpar_item_opt->descr->id);
goto error;
}
- } else if (argpar_item->type == BT_ARGPAR_ITEM_TYPE_NON_OPT) {
- struct bt_argpar_item_non_opt *argpar_item_non_opt;
+ } 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;
current_item_type = CONVERT_CURRENT_ITEM_TYPE_NON_OPT;
- argpar_item_non_opt = (struct bt_argpar_item_non_opt *) argpar_item;
+ argpar_item_non_opt = (struct argpar_item_non_opt *) argpar_item;
append_status = bt_value_array_append_string_element(non_opts,
argpar_item_non_opt->arg);
goto error;
}
} else {
- abort();
+ bt_common_abort();
}
}
* 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;
goto end;
}
- ret = append_implicit_component_extra_param(
- &implicit_lttng_live_args, "url",
- bt_value_string_get(bt_val_non_opt));
+ 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;
}
if (auto_source_discovery_restrict_plugin_name) {
plugin_count = 1;
- plugin = find_loaded_plugin(auto_source_discovery_restrict_plugin_name);
+ plugin = borrow_loaded_plugin_by_name(auto_source_discovery_restrict_plugin_name);
plugins = &plugin;
} else {
plugin_count = get_loaded_plugins_count();
status = auto_discover_source_components(non_opts, plugins, plugin_count,
auto_source_discovery_restrict_component_class_name,
- *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;
}
status = create_implicit_component_args_from_auto_discovered_sources(
- &auto_disc, non_opt_params, non_opt_loglevels,
+ &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 --clock-offset was given, apply it to any src.ctf.fs component. */
if (ctf_fs_source_clock_class_offset_arg) {
int n;
* 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_length(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_length(run_args) - 1) {
+ if (args_idx < args_len - 1) {
if (print_run_args) {
putchar(' ');
} else {
BT_OBJECT_PUT_REF_AND_RESET(cfg);
end:
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ argpar_parse_ret_fini(&argpar_parse_ret);
free(output);
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);
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, " -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`, `V`, `D`,\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");
struct bt_config *bt_config_cli_args_create(int argc, const char *argv[],
int *retcode, bool omit_system_plugin_path,
bool omit_home_plugin_path,
- const bt_value *initial_plugin_paths)
+ 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_OMIT_HOME_PLUGIN_PATH, '\0', "omit-home-plugin-path", false },
{ OPT_OMIT_SYSTEM_PLUGIN_PATH, '\0', "omit-system-plugin-path", false },
{ OPT_PLUGIN_PATH, '\0', "plugin-path", true },
- BT_ARGPAR_OPT_DESCR_SENTINEL
+ ARGPAR_OPT_DESCR_SENTINEL
};
enum command_type {
/* 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:
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
break;
case COMMAND_TYPE_CONVERT:
config = bt_config_convert_from_args(command_argc, command_argv,
- retcode, 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,
default_log_level);
break;
default:
- abort();
+ bt_common_abort();
}
if (config) {
*retcode = 1;
end:
- bt_argpar_parse_ret_fini(&argpar_parse_ret);
+ argpar_parse_ret_fini(&argpar_parse_ret);
bt_value_put_ref(plugin_paths);
return config;
}