2 * SPDX-License-Identifier: MIT
4 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
6 * Babeltrace trace converter - parameter parsing
9 #define BT_LOG_TAG "CLI/CFG-CLI-ARGS"
15 #include "common/assert.h"
19 #include <babeltrace2/babeltrace.h>
20 #include "common/common.h"
22 #include <sys/types.h>
23 #include "argpar/argpar.h"
24 #include "babeltrace2-cfg.h"
25 #include "babeltrace2-cfg-cli-args.h"
26 #include "babeltrace2-cfg-cli-args-connect.h"
27 #include "param-parse/param-parse.h"
28 #include "babeltrace2-log-level.h"
29 #include "babeltrace2-plugins.h"
30 #include "babeltrace2-query.h"
31 #include "autodisc/autodisc.h"
32 #include "common/version.h"
34 #define BT_CLI_LOGE_APPEND_CAUSE_OOM() BT_CLI_LOGE_APPEND_CAUSE("Out of memory.")
35 #define WHILE_PARSING_ARG_N_FMT "While parsing argument #%d (`%s`): "
38 * Returns the plugin name, component class name, component class type,
39 * and component name from a command-line --component option's argument.
40 * arg must have the following format:
42 * [NAME:]TYPE.PLUGIN.CLS
44 * where NAME is the optional component name, TYPE is either `source`,
45 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
46 * component class name.
48 * On success, both *plugin and *component are not NULL. *plugin
49 * and *comp_cls are owned by the caller. On success, *name can be NULL
50 * if no component class name was found, and *comp_cls_type is set.
53 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
54 char **comp_cls
, bt_component_class_type
*comp_cls_type
)
57 GString
*gs_name
= NULL
;
58 GString
*gs_comp_cls_type
= NULL
;
59 GString
*gs_plugin
= NULL
;
60 GString
*gs_comp_cls
= NULL
;
66 BT_ASSERT(comp_cls_type
);
68 if (!bt_common_string_is_printable(arg
)) {
69 BT_CLI_LOGE_APPEND_CAUSE("Argument contains a non-printable character.");
73 /* Parse the component name */
74 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
79 if (arg
[end_pos
] == ':') {
83 g_string_assign(gs_name
, "");
86 /* Parse the component class type */
87 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
88 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
89 BT_CLI_LOGE_APPEND_CAUSE("Missing component class type (`source`, `filter`, or `sink`).");
93 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
94 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
95 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
96 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
97 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
98 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
99 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
100 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
102 BT_CLI_LOGE_APPEND_CAUSE("Unknown component class type: `%s`.",
103 gs_comp_cls_type
->str
);
109 /* Parse the plugin name */
110 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
111 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
112 BT_CLI_LOGE_APPEND_CAUSE("Missing plugin or component class name.");
118 /* Parse the component class name */
119 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
120 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
121 BT_CLI_LOGE_APPEND_CAUSE("Missing component class name.");
125 if (at
[end_pos
] != '\0') {
126 /* Found a non-escaped `.` */
131 if (gs_name
->len
== 0) {
133 g_string_free(gs_name
, TRUE
);
135 *name
= g_string_free(gs_name
, FALSE
);
138 g_string_free(gs_name
, TRUE
);
141 *plugin
= g_string_free(gs_plugin
, FALSE
);
142 *comp_cls
= g_string_free(gs_comp_cls
, FALSE
);
158 g_string_free(gs_name
, TRUE
);
162 g_string_free(gs_plugin
, TRUE
);
166 g_string_free(gs_comp_cls
, TRUE
);
169 if (gs_comp_cls_type
) {
170 g_string_free(gs_comp_cls_type
, TRUE
);
177 void print_and_indent(const char *str
)
179 const char *ch
= &str
[0];
181 for (; *ch
!= '\0'; ch
++) {
195 * Prints the Babeltrace version.
198 void print_version(void)
200 bool has_extra_name
= strlen(BT_VERSION_EXTRA_NAME
) > 0;
201 bool has_extra_description
= strlen(BT_VERSION_EXTRA_DESCRIPTION
) > 0;
202 bool has_extra_patch_names
= strlen(BT_VERSION_EXTRA_PATCHES
) > 0;
203 bool has_extra
= has_extra_name
|| has_extra_description
||
204 has_extra_patch_names
;
206 printf("%sBabeltrace %s%s",
207 bt_common_color_bold(),
209 bt_common_color_reset());
211 if (strlen(BT_VERSION_NAME
) > 0) {
212 printf(" \"%s%s%s%s\"",
213 bt_common_color_fg_bright_blue(),
214 bt_common_color_bold(),
216 bt_common_color_reset());
219 if (strlen(BT_VERSION_GIT
) > 0) {
221 bt_common_color_fg_yellow(),
223 bt_common_color_reset());
228 if (strlen(BT_VERSION_DESCRIPTION
) > 0) {
229 unsigned int columns
;
232 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
233 /* Width not found: default to 80 */
237 descr
= bt_common_fold(BT_VERSION_DESCRIPTION
, columns
, 0);
239 printf("\n%s\n", descr
->str
);
240 g_string_free(descr
, TRUE
);
246 if (has_extra_name
) {
247 printf("%sExtra name%s: %s\n",
248 bt_common_color_fg_cyan(),
249 bt_common_color_reset(),
250 BT_VERSION_EXTRA_NAME
);
253 if (has_extra_description
) {
254 printf("%sExtra description%s:\n ",
255 bt_common_color_fg_cyan(),
256 bt_common_color_reset());
257 print_and_indent(BT_VERSION_EXTRA_DESCRIPTION
);
260 if (has_extra_patch_names
) {
261 printf("%sExtra patch names%s:\n ",
262 bt_common_color_fg_cyan(),
263 bt_common_color_reset());
264 print_and_indent(BT_VERSION_EXTRA_PATCHES
);
270 * Destroys a component configuration.
273 void bt_config_component_destroy(bt_object
*obj
)
275 struct bt_config_component
*bt_config_component
=
276 container_of(obj
, struct bt_config_component
, base
);
282 if (bt_config_component
->plugin_name
) {
283 g_string_free(bt_config_component
->plugin_name
, TRUE
);
286 if (bt_config_component
->comp_cls_name
) {
287 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
290 if (bt_config_component
->instance_name
) {
291 g_string_free(bt_config_component
->instance_name
, TRUE
);
294 BT_VALUE_PUT_REF_AND_RESET(bt_config_component
->params
);
295 g_free(bt_config_component
);
302 * Creates a component configuration using the given plugin name and
303 * component name. `plugin_name` and `comp_cls_name` are copied (belong
304 * to the return value).
306 * Return value is owned by the caller.
309 struct bt_config_component
*bt_config_component_create(
310 bt_component_class_type type
,
311 const char *plugin_name
, const char *comp_cls_name
,
314 struct bt_config_component
*cfg_component
= NULL
;
316 cfg_component
= g_new0(struct bt_config_component
, 1);
317 if (!cfg_component
) {
318 BT_CLI_LOGE_APPEND_CAUSE_OOM();
322 bt_object_init_shared(&cfg_component
->base
,
323 bt_config_component_destroy
);
324 cfg_component
->type
= type
;
325 cfg_component
->plugin_name
= g_string_new(plugin_name
);
326 if (!cfg_component
->plugin_name
) {
327 BT_CLI_LOGE_APPEND_CAUSE_OOM();
331 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
332 if (!cfg_component
->comp_cls_name
) {
333 BT_CLI_LOGE_APPEND_CAUSE_OOM();
337 cfg_component
->instance_name
= g_string_new(NULL
);
338 if (!cfg_component
->instance_name
) {
339 BT_CLI_LOGE_APPEND_CAUSE_OOM();
343 cfg_component
->log_level
= init_log_level
;
345 /* Start with empty parameters */
346 cfg_component
->params
= bt_value_map_create();
347 if (!cfg_component
->params
) {
348 BT_CLI_LOGE_APPEND_CAUSE_OOM();
355 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
358 return cfg_component
;
362 * Creates a component configuration from a command-line --component
366 struct bt_config_component
*bt_config_component_from_arg(const char *arg
,
369 struct bt_config_component
*cfg_comp
= NULL
;
371 char *plugin_name
= NULL
;
372 char *comp_cls_name
= NULL
;
373 bt_component_class_type type
;
375 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
376 if (!plugin_name
|| !comp_cls_name
) {
380 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
,
387 g_string_assign(cfg_comp
->instance_name
, name
);
393 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp
);
398 g_free(comp_cls_name
);
403 * Destroys a configuration.
406 void bt_config_destroy(bt_object
*obj
)
408 struct bt_config
*cfg
=
409 container_of(obj
, struct bt_config
, base
);
415 BT_VALUE_PUT_REF_AND_RESET(cfg
->plugin_paths
);
417 switch (cfg
->command
) {
418 case BT_CONFIG_COMMAND_RUN
:
419 if (cfg
->cmd_data
.run
.sources
) {
420 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
423 if (cfg
->cmd_data
.run
.filters
) {
424 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
427 if (cfg
->cmd_data
.run
.sinks
) {
428 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
431 if (cfg
->cmd_data
.run
.connections
) {
432 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
436 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
438 case BT_CONFIG_COMMAND_HELP
:
439 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.help
.cfg_component
);
441 case BT_CONFIG_COMMAND_QUERY
:
442 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.query
.cfg_component
);
444 if (cfg
->cmd_data
.query
.object
) {
445 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
448 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
449 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
450 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
453 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
457 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
458 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
460 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
463 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
478 void destroy_glist_of_gstring(GList
*list
)
486 for (at
= list
; at
; at
= g_list_next(at
)) {
487 g_string_free(at
->data
, TRUE
);
494 * Creates a simple lexical scanner for parsing comma-delimited names
497 * Return value is owned by the caller.
500 GScanner
*create_csv_identifiers_scanner(void)
503 GScannerConfig scanner_config
= {
504 .cset_skip_characters
= (gchar
*) " \t\n",
505 .cset_identifier_first
= (gchar
*) G_CSET_a_2_z G_CSET_A_2_Z
"_",
506 .cset_identifier_nth
= (gchar
*) G_CSET_a_2_z G_CSET_A_2_Z
":_-",
507 .case_sensitive
= TRUE
,
508 .cpair_comment_single
= NULL
,
509 .skip_comment_multi
= TRUE
,
510 .skip_comment_single
= TRUE
,
511 .scan_comment_multi
= FALSE
,
512 .scan_identifier
= TRUE
,
513 .scan_identifier_1char
= TRUE
,
514 .scan_identifier_NULL
= FALSE
,
515 .scan_symbols
= FALSE
,
516 .symbol_2_token
= FALSE
,
517 .scope_0_fallback
= FALSE
,
518 .scan_binary
= FALSE
,
522 .scan_hex_dollar
= FALSE
,
523 .numbers_2_int
= FALSE
,
524 .int_2_float
= FALSE
,
525 .store_int64
= FALSE
,
526 .scan_string_sq
= FALSE
,
527 .scan_string_dq
= FALSE
,
528 .identifier_2_string
= FALSE
,
529 .char_2_token
= TRUE
,
532 scanner
= g_scanner_new(&scanner_config
);
534 BT_CLI_LOGE_APPEND_CAUSE_OOM();
541 * Converts a comma-delimited list of known names (--names option) to
542 * an array value object containing those names as string value objects.
544 * Return value is owned by the caller.
547 bt_value
*names_from_arg(const char *arg
)
549 GScanner
*scanner
= NULL
;
550 bt_value
*names
= NULL
;
551 bool found_all
= false, found_none
= false, found_item
= false;
553 names
= bt_value_array_create();
555 BT_CLI_LOGE_APPEND_CAUSE_OOM();
559 scanner
= create_csv_identifiers_scanner();
564 g_scanner_input_text(scanner
, arg
, strlen(arg
));
567 GTokenType token_type
= g_scanner_get_next_token(scanner
);
569 switch (token_type
) {
570 case G_TOKEN_IDENTIFIER
:
572 const char *identifier
= scanner
->value
.v_identifier
;
574 if (strcmp(identifier
, "payload") == 0 ||
575 strcmp(identifier
, "args") == 0 ||
576 strcmp(identifier
, "arg") == 0) {
578 if (bt_value_array_append_string_element(names
,
582 } else if (strcmp(identifier
, "context") == 0 ||
583 strcmp(identifier
, "ctx") == 0) {
585 if (bt_value_array_append_string_element(names
,
589 } else if (strcmp(identifier
, "scope") == 0 ||
590 strcmp(identifier
, "header") == 0) {
592 if (bt_value_array_append_string_element(names
,
596 } else if (strcmp(identifier
, "all") == 0) {
598 if (bt_value_array_append_string_element(names
,
602 } else if (strcmp(identifier
, "none") == 0) {
604 if (bt_value_array_append_string_element(names
,
609 BT_CLI_LOGE_APPEND_CAUSE("Unknown name: `%s`.",
625 if (found_none
&& found_all
) {
626 BT_CLI_LOGE_APPEND_CAUSE("Only either `all` or `none` can be specified in the list given to the --names option, but not both.");
630 * Legacy behavior is to clear the defaults (show none) when at
631 * least one item is specified.
633 if (found_item
&& !found_none
&& !found_all
) {
634 if (bt_value_array_append_string_element(names
, "none")) {
639 g_scanner_destroy(scanner
);
644 BT_VALUE_PUT_REF_AND_RESET(names
);
646 g_scanner_destroy(scanner
);
652 * Converts a comma-delimited list of known fields (--fields option) to
653 * an array value object containing those fields as string
656 * Return value is owned by the caller.
659 bt_value
*fields_from_arg(const char *arg
)
661 GScanner
*scanner
= NULL
;
664 fields
= bt_value_array_create();
666 BT_CLI_LOGE_APPEND_CAUSE_OOM();
670 scanner
= create_csv_identifiers_scanner();
675 g_scanner_input_text(scanner
, arg
, strlen(arg
));
678 GTokenType token_type
= g_scanner_get_next_token(scanner
);
680 switch (token_type
) {
681 case G_TOKEN_IDENTIFIER
:
683 const char *identifier
= scanner
->value
.v_identifier
;
685 if (strcmp(identifier
, "trace") == 0 ||
686 strcmp(identifier
, "trace:hostname") == 0 ||
687 strcmp(identifier
, "trace:domain") == 0 ||
688 strcmp(identifier
, "trace:procname") == 0 ||
689 strcmp(identifier
, "trace:vpid") == 0 ||
690 strcmp(identifier
, "loglevel") == 0 ||
691 strcmp(identifier
, "emf") == 0 ||
692 strcmp(identifier
, "callsite") == 0 ||
693 strcmp(identifier
, "all") == 0) {
694 if (bt_value_array_append_string_element(fields
,
699 BT_CLI_LOGE_APPEND_CAUSE("Unknown field: `%s`.",
717 BT_VALUE_PUT_REF_AND_RESET(fields
);
721 g_scanner_destroy(scanner
);
727 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
729 BT_ASSERT(params_arg
);
733 if (params_arg
->len
!= 0) {
734 g_string_append_c(params_arg
, ',');
737 g_string_append(params_arg
, key
);
738 g_string_append_c(params_arg
, '=');
739 g_string_append(params_arg
, value
);
743 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
744 * where the names are in names_array.
747 int insert_flat_params_from_array(GString
*params_arg
,
748 const bt_value
*names_array
, const char *prefix
)
752 GString
*tmpstr
= NULL
, *default_value
= NULL
;
753 bool default_set
= false, non_default_set
= false;
756 * names_array may be NULL if no CLI options were specified to
757 * trigger its creation.
763 tmpstr
= g_string_new(NULL
);
765 BT_CLI_LOGE_APPEND_CAUSE_OOM();
770 default_value
= g_string_new(NULL
);
771 if (!default_value
) {
772 BT_CLI_LOGE_APPEND_CAUSE_OOM();
777 for (i
= 0; i
< bt_value_array_get_length(names_array
); i
++) {
778 const bt_value
*str_obj
=
779 bt_value_array_borrow_element_by_index_const(names_array
,
782 bool is_default
= false;
784 suffix
= bt_value_string_get(str_obj
);
786 g_string_assign(tmpstr
, prefix
);
787 g_string_append(tmpstr
, "-");
789 /* Special-case for "all" and "none". */
790 if (strcmp(suffix
, "all") == 0) {
792 g_string_assign(default_value
, "show");
793 } else if (strcmp(suffix
, "none") == 0) {
795 g_string_assign(default_value
, "hide");
799 g_string_append(tmpstr
, "default");
800 append_param_arg(params_arg
, tmpstr
->str
,
803 non_default_set
= true;
804 g_string_append(tmpstr
, suffix
);
805 append_param_arg(params_arg
, tmpstr
->str
, "yes");
809 /* Implicit field-default=hide if any non-default option is set. */
810 if (non_default_set
&& !default_set
) {
811 g_string_assign(tmpstr
, prefix
);
812 g_string_append(tmpstr
, "-default");
813 g_string_assign(default_value
, "hide");
814 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
819 g_string_free(default_value
, TRUE
);
823 g_string_free(tmpstr
, TRUE
);
836 OPT_CLOCK_FORCE_CORRELATE
,
847 OPT_DEBUG_INFO_FULL_PATH
,
848 OPT_DEBUG_INFO_TARGET_PREFIX
,
857 OPT_OMIT_HOME_PLUGIN_PATH
,
858 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
863 OPT_RESET_BASE_PARAMS
,
867 OPT_STREAM_INTERSECTION
,
873 enum bt_config_component_dest
{
874 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
875 BT_CONFIG_COMPONENT_DEST_SOURCE
,
876 BT_CONFIG_COMPONENT_DEST_FILTER
,
877 BT_CONFIG_COMPONENT_DEST_SINK
,
881 * Adds a configuration component to the appropriate configuration
882 * array depending on the destination.
885 void add_run_cfg_comp(struct bt_config
*cfg
,
886 struct bt_config_component
*cfg_comp
,
887 enum bt_config_component_dest dest
)
889 bt_object_get_ref(cfg_comp
);
892 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
893 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
895 case BT_CONFIG_COMPONENT_DEST_FILTER
:
896 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
898 case BT_CONFIG_COMPONENT_DEST_SINK
:
899 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
907 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
908 struct bt_config_component
*cfg_comp
,
909 enum bt_config_component_dest dest
,
910 bt_value
*instance_names
)
914 if (cfg_comp
->instance_name
->len
== 0) {
915 BT_CLI_LOGE_APPEND_CAUSE("Found an unnamed component.");
920 if (bt_value_map_has_entry(instance_names
,
921 cfg_comp
->instance_name
->str
)) {
922 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
923 cfg_comp
->instance_name
->str
);
928 if (bt_value_map_insert_entry(instance_names
,
929 cfg_comp
->instance_name
->str
, bt_value_null
)) {
930 BT_CLI_LOGE_APPEND_CAUSE_OOM();
935 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
942 int append_env_var_plugin_paths(bt_value
*plugin_paths
)
947 if (bt_common_is_setuid_setgid()) {
948 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
952 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
957 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
961 BT_CLI_LOGE_APPEND_CAUSE("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH.");
968 int append_home_and_system_plugin_paths(bt_value
*plugin_paths
,
969 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
973 if (!omit_home_plugin_path
) {
974 if (bt_common_is_setuid_setgid()) {
975 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
977 char *home_plugin_dir
= bt_common_get_home_plugin_path(
978 BT_LOG_OUTPUT_LEVEL
);
980 if (home_plugin_dir
) {
981 ret
= bt_config_append_plugin_paths(
982 plugin_paths
, home_plugin_dir
);
983 free(home_plugin_dir
);
986 BT_CLI_LOGE_APPEND_CAUSE("Invalid home plugin path.");
993 if (!omit_system_plugin_path
) {
994 if (bt_config_append_plugin_paths(plugin_paths
,
995 bt_common_get_system_plugin_path())) {
996 BT_CLI_LOGE_APPEND_CAUSE("Invalid system plugin path.");
1002 BT_CLI_LOGE_APPEND_CAUSE("Cannot append home and system plugin paths.");
1007 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1008 const bt_value
*plugin_paths
, bool needs_plugins
)
1010 struct bt_config
*cfg
;
1013 cfg
= g_new0(struct bt_config
, 1);
1015 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1019 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1020 cfg
->command
= command
;
1021 cfg
->command_needs_plugins
= needs_plugins
;
1024 bt_value
*plugin_paths_copy
;
1026 (void) bt_value_copy(plugin_paths
,
1027 &plugin_paths_copy
);
1028 cfg
->plugin_paths
= plugin_paths_copy
;
1030 cfg
->plugin_paths
= bt_value_array_create();
1031 if (!cfg
->plugin_paths
) {
1032 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1040 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1047 struct bt_config
*bt_config_run_create(const bt_value
*plugin_paths
)
1049 struct bt_config
*cfg
;
1052 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1053 plugin_paths
, true);
1058 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1059 (GDestroyNotify
) bt_object_put_ref
);
1060 if (!cfg
->cmd_data
.run
.sources
) {
1061 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1065 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1066 (GDestroyNotify
) bt_object_put_ref
);
1067 if (!cfg
->cmd_data
.run
.filters
) {
1068 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1072 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1073 (GDestroyNotify
) bt_object_put_ref
);
1074 if (!cfg
->cmd_data
.run
.sinks
) {
1075 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1079 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1080 (GDestroyNotify
) bt_config_connection_destroy
);
1081 if (!cfg
->cmd_data
.run
.connections
) {
1082 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1089 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1096 struct bt_config
*bt_config_list_plugins_create(const bt_value
*plugin_paths
)
1098 return bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1099 plugin_paths
, true);
1103 struct bt_config
*bt_config_help_create(const bt_value
*plugin_paths
,
1104 int default_log_level
)
1106 struct bt_config
*cfg
;
1109 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1110 plugin_paths
, true);
1115 cfg
->cmd_data
.help
.cfg_component
=
1116 bt_config_component_create(-1, NULL
, NULL
, default_log_level
);
1117 if (!cfg
->cmd_data
.help
.cfg_component
) {
1124 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1131 struct bt_config
*bt_config_query_create(const bt_value
*plugin_paths
)
1133 struct bt_config
*cfg
;
1136 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1137 plugin_paths
, true);
1142 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1143 if (!cfg
->cmd_data
.query
.object
) {
1144 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1151 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1158 enum bt_config_cli_args_status
bt_config_print_ctf_metadata_create(
1159 const bt_value
*plugin_paths
, struct bt_config
**cfg_out
)
1161 struct bt_config
*cfg
;
1162 enum bt_config_cli_args_status status
;
1165 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1166 plugin_paths
, true);
1171 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1172 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1173 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1177 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1178 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1179 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1183 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
1184 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
1188 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
1191 bt_object_put_ref(cfg
);
1196 enum bt_config_cli_args_status
bt_config_print_lttng_live_sessions_create(
1197 const bt_value
*plugin_paths
, struct bt_config
**cfg_out
)
1199 struct bt_config
*cfg
;
1200 enum bt_config_cli_args_status status
;
1203 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1204 plugin_paths
, true);
1209 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1210 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1211 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1215 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1217 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1218 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1222 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
1223 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
1227 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
1230 bt_object_put_ref(cfg
);
1235 int bt_config_append_plugin_paths_check_setuid_setgid(
1236 bt_value
*plugin_paths
, const char *arg
)
1240 if (bt_common_is_setuid_setgid()) {
1241 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1245 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1246 BT_CLI_LOGE_APPEND_CAUSE("Invalid --plugin-path option's argument:\n %s",
1257 * Prints the expected format for a --params option.
1260 void print_expected_params_format(FILE *fp
)
1262 fprintf(fp
, "Expected format of PARAMS\n");
1263 fprintf(fp
, "-------------------------\n");
1265 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1267 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1268 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1269 fprintf(fp
, "and VALUE can be one of:\n");
1271 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1272 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1273 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1274 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1275 fprintf(fp
, " (`0x` prefix) unsigned (with `+` prefix) or signed 64-bit integer.\n");
1276 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1277 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1278 fprintf(fp
, " the null and boolean value symbols above.\n");
1279 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1280 fprintf(fp
, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
1281 fprintf(fp
, " (as described by the current list) and a closing `]`.\n");
1282 fprintf(fp
, "* Map, formatted as an opening `{`, a comma-separated list of PARAM=VALUE\n");
1283 fprintf(fp
, " assignments and a closing `}`.\n");
1285 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1287 fprintf(fp
, "Example:\n");
1289 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1290 fprintf(fp
, " play=+23, observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1291 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\",\n");
1292 fprintf(fp
, " things=[1, \"2\", 3]\n");
1294 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1295 fprintf(fp
, "babeltrace2 from a shell.\n");
1299 * Given argpar error status `status` and error `error`, return a formatted
1300 * error message describing the error.
1302 * `argv` is the argument vector that was being parsed.
1304 * `prefix_fmt` (formatted using the following arguments) is prepended to
1305 * the error message.
1307 * The returned string must be freed by the caller.
1310 GString
*__BT_ATTR_FORMAT_PRINTF(4, 5) format_arg_error(
1311 const struct argpar_error
*error
,
1312 const char **argv
, unsigned int arg_index_offset
,
1313 const char *prefix_fmt
, ...)
1315 GString
*str
= g_string_new(NULL
);
1318 va_start(args
, prefix_fmt
);
1319 g_string_append_vprintf(str
, prefix_fmt
, args
);
1322 g_string_append(str
, ": ");
1324 switch (argpar_error_type(error
))
1326 case ARGPAR_ERROR_TYPE_MISSING_OPT_ARG
:
1329 const struct argpar_opt_descr
*descr
=
1330 argpar_error_opt_descr(error
, &is_short
);
1331 int orig_index
= argpar_error_orig_index(error
);
1332 const char *arg
= argv
[orig_index
];
1335 g_string_append_printf(
1337 WHILE_PARSING_ARG_N_FMT
"Missing required argument for option `-%c`",
1338 arg_index_offset
+ orig_index
+ 1, arg
, descr
->short_name
);
1340 g_string_append_printf(
1342 WHILE_PARSING_ARG_N_FMT
"Missing required argument for option `--%s`",
1343 arg_index_offset
+ orig_index
+ 1, arg
, descr
->long_name
);
1348 case ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG
:
1351 const struct argpar_opt_descr
*descr
=
1352 argpar_error_opt_descr(error
, &is_short
);
1353 int orig_index
= argpar_error_orig_index(error
);
1354 const char *arg
= argv
[orig_index
];
1357 g_string_append_printf(
1359 WHILE_PARSING_ARG_N_FMT
"Unexpected argument for option `-%c`",
1360 arg_index_offset
+ orig_index
+ 1, arg
, descr
->short_name
);
1362 g_string_append_printf(
1364 WHILE_PARSING_ARG_N_FMT
"Unexpected argument for option `--%s`",
1365 arg_index_offset
+ orig_index
+ 1, arg
, descr
->long_name
);
1370 case ARGPAR_ERROR_TYPE_UNKNOWN_OPT
:
1372 int orig_index
= argpar_error_orig_index(error
);
1373 const char *unknown_opt
= argpar_error_unknown_opt_name(error
);
1374 const char *arg
= argv
[orig_index
];
1376 g_string_append_printf(
1378 WHILE_PARSING_ARG_N_FMT
"Unknown option `%s`",
1379 arg_index_offset
+ orig_index
+ 1, arg
, unknown_opt
);
1391 enum parse_next_item_status
1393 PARSE_NEXT_ITEM_STATUS_OK
= 0,
1394 PARSE_NEXT_ITEM_STATUS_END
= 1,
1395 PARSE_NEXT_ITEM_STATUS_ERROR
= -1,
1399 * Parse the next item using `iter`. Log and append an error if necessary.
1401 * The item in `*item` on entry is freed, and the new item is also
1402 * returned in `*item`.
1405 enum parse_next_item_status
parse_next_item(struct argpar_iter
*iter
,
1406 const struct argpar_item
**item
, const char **argv
,
1407 const char *command
, unsigned int consumed_args
)
1409 enum argpar_iter_next_status status
;
1410 const struct argpar_error
*error
= NULL
;
1411 enum parse_next_item_status ret
;
1413 ARGPAR_ITEM_DESTROY_AND_RESET(*item
);
1414 status
= argpar_iter_next(iter
, item
, &error
);
1417 case ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY
:
1418 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1419 ret
= PARSE_NEXT_ITEM_STATUS_ERROR
;
1421 case ARGPAR_ITER_NEXT_STATUS_ERROR
:
1423 GString
*err_str
= format_arg_error(error
, argv
,
1425 "While parsing `%s` command's command-line arguments",
1427 BT_CLI_LOGE_APPEND_CAUSE("%s", err_str
->str
);
1428 g_string_free(err_str
, TRUE
);
1429 ret
= PARSE_NEXT_ITEM_STATUS_ERROR
;
1432 case ARGPAR_ITER_NEXT_STATUS_END
:
1433 ret
= PARSE_NEXT_ITEM_STATUS_END
;
1435 case ARGPAR_ITER_NEXT_STATUS_OK
:
1436 ret
= PARSE_NEXT_ITEM_STATUS_OK
;
1442 argpar_error_destroy(error
);
1448 * Prints the help command usage.
1451 void print_help_usage(FILE *fp
)
1453 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1454 fprintf(fp
, " babeltrace2 [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1456 fprintf(fp
, "Options:\n");
1458 fprintf(fp
, " -h, --help Show this help and quit\n");
1460 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1462 fprintf(fp
, "Use `babeltrace2 list-plugins` to show the list of available plugins.\n");
1466 const struct argpar_opt_descr help_options
[] = {
1467 /* id, short_name, long_name, with_arg */
1468 { OPT_HELP
, 'h', "help", false },
1469 ARGPAR_OPT_DESCR_SENTINEL
1473 * Creates a Babeltrace config object from the arguments of a help
1477 enum bt_config_cli_args_status
bt_config_help_from_args(int argc
,
1478 const char *argv
[], struct bt_config
**cfg_out
,
1479 const bt_value
*plugin_paths
, int default_log_level
,
1480 unsigned int consumed_args
)
1482 enum bt_config_cli_args_status status
;
1483 struct bt_config
*cfg
;
1484 const char *plugin_comp_cls_arg
= NULL
;
1485 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1486 GString
*substring
= NULL
;
1488 struct argpar_iter
*argpar_iter
= NULL
;
1489 const struct argpar_item
*argpar_item
= NULL
;
1491 cfg
= bt_config_help_create(plugin_paths
, default_log_level
);
1496 argpar_iter
= argpar_iter_create(argc
, argv
, help_options
);
1498 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1503 enum parse_next_item_status parse_status
=
1504 parse_next_item(argpar_iter
, &argpar_item
, argv
, "help",
1507 if (parse_status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
1509 } else if (parse_status
== PARSE_NEXT_ITEM_STATUS_END
) {
1513 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1514 const struct argpar_opt_descr
*opt_descr
=
1515 argpar_item_opt_descr(argpar_item
);
1517 switch (opt_descr
->id
) {
1519 print_help_usage(stdout
);
1520 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
1526 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1528 if (plugin_comp_cls_arg
) {
1529 BT_CLI_LOGE_APPEND_CAUSE(
1530 "Extraneous command-line argument specified to `help` command: `%s`.",
1535 plugin_comp_cls_arg
= arg
;
1539 if (!plugin_comp_cls_arg
) {
1540 BT_CLI_LOGE_APPEND_CAUSE(
1541 "Missing plugin name or component class descriptor.");
1545 /* Look for unescaped dots in the argument. */
1546 substring
= bt_common_string_until(plugin_comp_cls_arg
, ".\\", ".", &end_pos
);
1548 BT_CLI_LOGE_APPEND_CAUSE("Could not consume argument: arg=%s",
1549 plugin_comp_cls_arg
);
1553 if (end_pos
== strlen(plugin_comp_cls_arg
)) {
1554 /* Didn't find an unescaped dot, treat it as a plugin name. */
1555 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1556 plugin_comp_cls_arg
);
1559 * Found an unescaped dot, treat it as a component class name.
1561 plugin_comp_cls_names(plugin_comp_cls_arg
, NULL
, &plugin_name
, &comp_cls_name
,
1562 &cfg
->cmd_data
.help
.cfg_component
->type
);
1563 if (!plugin_name
|| !comp_cls_name
) {
1564 BT_CLI_LOGE_APPEND_CAUSE(
1565 "Could not parse argument as a component class name: arg=%s",
1566 plugin_comp_cls_arg
);
1570 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1572 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1576 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
1577 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
1581 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
1584 g_free(plugin_name
);
1585 g_free(comp_cls_name
);
1588 g_string_free(substring
, TRUE
);
1591 argpar_iter_destroy(argpar_iter
);
1592 argpar_item_destroy(argpar_item
);
1593 bt_object_put_ref(cfg
);
1599 * Prints the help command usage.
1602 void print_query_usage(FILE *fp
)
1604 fprintf(fp
, "Usage: babeltrace2 [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1606 fprintf(fp
, "Options:\n");
1608 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS (see the expected\n");
1609 fprintf(fp
, " format of PARAMS below)\n");
1610 fprintf(fp
, " -h, --help Show this help and quit\n");
1611 fprintf(fp
, "\n\n");
1612 print_expected_params_format(fp
);
1616 const struct argpar_opt_descr query_options
[] = {
1617 /* id, short_name, long_name, with_arg */
1618 { OPT_HELP
, 'h', "help", false },
1619 { OPT_PARAMS
, 'p', "params", true },
1620 ARGPAR_OPT_DESCR_SENTINEL
1624 * Creates a Babeltrace config object from the arguments of a query
1628 enum bt_config_cli_args_status
bt_config_query_from_args(int argc
,
1629 const char *argv
[], struct bt_config
**cfg_out
,
1630 const bt_value
*plugin_paths
, int default_log_level
,
1631 unsigned int consumed_args
)
1633 enum bt_config_cli_args_status status
;
1634 struct bt_config
*cfg
= NULL
;
1635 const char *component_class_spec
= NULL
;
1636 const char *query_object
= NULL
;
1637 GString
*error_str
= NULL
;
1638 struct argpar_iter
*argpar_iter
= NULL
;
1639 const struct argpar_item
*argpar_item
= NULL
;
1641 bt_value
*params
= bt_value_map_create();
1643 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1647 cfg
= bt_config_query_create(plugin_paths
);
1652 error_str
= g_string_new(NULL
);
1654 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1658 argpar_iter
= argpar_iter_create(argc
, argv
, query_options
);
1660 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1665 enum parse_next_item_status parse_status
=
1666 parse_next_item(argpar_iter
, &argpar_item
, argv
, "query",
1669 if (parse_status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
1671 } else if (parse_status
== PARSE_NEXT_ITEM_STATUS_END
) {
1675 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1676 const struct argpar_opt_descr
*opt_descr
=
1677 argpar_item_opt_descr(argpar_item
);
1678 const char *arg
= argpar_item_opt_arg(argpar_item
);
1680 switch (opt_descr
->id
) {
1682 print_query_usage(stdout
);
1683 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
1687 bt_value
*parsed_params
= bt_param_parse(arg
, error_str
);
1688 bt_value_map_extend_status extend_status
;
1689 if (!parsed_params
) {
1690 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1695 extend_status
= bt_value_map_extend(params
, parsed_params
);
1696 BT_VALUE_PUT_REF_AND_RESET(parsed_params
);
1697 if (extend_status
) {
1698 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current parameters with --params option's argument:\n %s",
1708 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1711 * We need exactly two non-option arguments
1712 * which are the mandatory component class
1713 * specification and query object.
1715 if (!component_class_spec
) {
1716 component_class_spec
= arg
;
1717 } else if (!query_object
) {
1720 BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
1727 if (!component_class_spec
|| !query_object
) {
1728 print_query_usage(stdout
);
1729 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
1733 cfg
->cmd_data
.query
.cfg_component
=
1734 bt_config_component_from_arg(component_class_spec
,
1736 if (!cfg
->cmd_data
.query
.cfg_component
) {
1737 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1738 component_class_spec
);
1743 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
1745 if (strlen(query_object
) == 0) {
1746 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1750 g_string_assign(cfg
->cmd_data
.query
.object
, query_object
);
1751 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
1752 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
1756 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
1759 argpar_iter_destroy(argpar_iter
);
1760 argpar_item_destroy(argpar_item
);
1763 g_string_free(error_str
, TRUE
);
1766 bt_value_put_ref(params
);
1767 bt_object_put_ref(cfg
);
1773 * Prints the list-plugins command usage.
1776 void print_list_plugins_usage(FILE *fp
)
1778 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1780 fprintf(fp
, "Options:\n");
1782 fprintf(fp
, " -h, --help Show this help and quit\n");
1784 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1786 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1790 const struct argpar_opt_descr list_plugins_options
[] = {
1791 /* id, short_name, long_name, with_arg */
1792 { OPT_HELP
, 'h', "help", false },
1793 ARGPAR_OPT_DESCR_SENTINEL
1797 * Creates a Babeltrace config object from the arguments of a
1798 * list-plugins command.
1801 enum bt_config_cli_args_status
bt_config_list_plugins_from_args(int argc
,
1802 const char *argv
[], struct bt_config
**cfg_out
,
1803 const bt_value
*plugin_paths
, unsigned int consumed_args
)
1805 enum bt_config_cli_args_status status
;
1806 struct bt_config
*cfg
= NULL
;
1807 struct argpar_iter
*argpar_iter
= NULL
;
1808 const struct argpar_item
*argpar_item
= NULL
;
1810 cfg
= bt_config_list_plugins_create(plugin_paths
);
1815 argpar_iter
= argpar_iter_create(argc
, argv
, list_plugins_options
);
1817 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1822 enum parse_next_item_status parse_status
=
1823 parse_next_item(argpar_iter
, &argpar_item
, argv
, "list-plugins",
1826 if (parse_status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
1828 } else if (parse_status
== PARSE_NEXT_ITEM_STATUS_END
) {
1832 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1833 const struct argpar_opt_descr
*opt_descr
=
1834 argpar_item_opt_descr(argpar_item
);
1836 switch (opt_descr
->id
) {
1838 print_list_plugins_usage(stdout
);
1839 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
1845 BT_CLI_LOGE_APPEND_CAUSE(
1846 "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
1847 argpar_item_non_opt_arg(argpar_item
));
1852 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
1853 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
1857 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
1860 argpar_iter_destroy(argpar_iter
);
1861 argpar_item_destroy(argpar_item
);
1862 bt_object_put_ref(cfg
);
1868 * Prints the run command usage.
1871 void print_run_usage(FILE *fp
)
1873 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1875 fprintf(fp
, "Options:\n");
1877 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1878 fprintf(fp
, " for all the following components until\n");
1879 fprintf(fp
, " --reset-base-params is encountered\n");
1880 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1881 fprintf(fp
, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
1882 fprintf(fp
, " Instantiate the component class CLS of type\n");
1883 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1884 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1885 fprintf(fp
, " and name it NAME");
1886 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1887 fprintf(fp
, " expected format of CONNECTION below)\n");
1888 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1889 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
1890 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1891 fprintf(fp
, " current component (see the expected format\n");
1892 fprintf(fp
, " of PARAMS below)\n");
1893 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1894 fprintf(fp
, " empty map\n");
1895 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1896 fprintf(fp
, " the graph later, retry in DUR µs\n");
1897 fprintf(fp
, " (default: 100000)\n");
1898 fprintf(fp
, " -h, --help Show this help and quit\n");
1900 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1901 fprintf(fp
, "\n\n");
1902 fprintf(fp
, "Expected format of CONNECTION\n");
1903 fprintf(fp
, "-----------------------------\n");
1905 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1907 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1908 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1909 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
1910 fprintf(fp
, "component using the NAME prefix of the --component option.\n");
1912 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1913 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1914 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1916 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1917 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1918 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1919 fprintf(fp
, "DOWNSTREAM.\n");
1921 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1922 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1923 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1925 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1926 fprintf(fp
, "can connect a filter component to a sink component.\n");
1928 fprintf(fp
, "Examples:\n");
1930 fprintf(fp
, " my-src:my-sink\n");
1931 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1933 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1934 fprintf(fp
, "babeltrace2 from a shell.\n");
1935 fprintf(fp
, "\n\n");
1936 print_expected_params_format(fp
);
1940 * Creates a Babeltrace config object from the arguments of a run
1944 enum bt_config_cli_args_status
bt_config_run_from_args(int argc
, const char *argv
[],
1945 struct bt_config
**cfg_out
, const bt_value
*plugin_paths
,
1946 int default_log_level
, unsigned int consumed_args
)
1948 enum bt_config_cli_args_status status
;
1949 struct bt_config_component
*cur_cfg_comp
= NULL
;
1950 bt_value
*cur_base_params
= NULL
;
1952 struct bt_config
*cfg
= NULL
;
1953 bt_value
*instance_names
= NULL
;
1954 bt_value
*connection_args
= NULL
;
1955 char error_buf
[256] = { 0 };
1956 long retry_duration
= -1;
1957 bt_value_map_extend_status extend_status
;
1958 GString
*error_str
= NULL
;
1959 struct argpar_iter
*argpar_iter
= NULL
;
1960 const struct argpar_item
*argpar_item
= NULL
;
1962 static const struct argpar_opt_descr run_options
[] = {
1963 { OPT_BASE_PARAMS
, 'b', "base-params", true },
1964 { OPT_COMPONENT
, 'c', "component", true },
1965 { OPT_CONNECT
, 'x', "connect", true },
1966 { OPT_HELP
, 'h', "help", false },
1967 { OPT_LOG_LEVEL
, 'l', "log-level", true },
1968 { OPT_PARAMS
, 'p', "params", true },
1969 { OPT_RESET_BASE_PARAMS
, 'r', "reset-base-params", false },
1970 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
1971 ARGPAR_OPT_DESCR_SENTINEL
1974 error_str
= g_string_new(NULL
);
1976 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1981 print_run_usage(stdout
);
1982 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
1986 cfg
= bt_config_run_create(plugin_paths
);
1991 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1992 cur_base_params
= bt_value_map_create();
1993 if (!cur_base_params
) {
1994 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1998 instance_names
= bt_value_map_create();
1999 if (!instance_names
) {
2000 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2004 connection_args
= bt_value_array_create();
2005 if (!connection_args
) {
2006 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2010 argpar_iter
= argpar_iter_create(argc
, argv
, run_options
);
2012 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2017 enum parse_next_item_status parse_status
;
2018 const struct argpar_opt_descr
*opt_descr
;
2021 parse_status
= parse_next_item(argpar_iter
, &argpar_item
, argv
, "run",
2023 if (parse_status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
2025 } else if (parse_status
== PARSE_NEXT_ITEM_STATUS_END
) {
2029 /* This command does not accept non-option arguments.*/
2030 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_NON_OPT
) {
2031 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
2032 argpar_item_non_opt_arg(argpar_item
));
2036 opt_descr
= argpar_item_opt_descr(argpar_item
);
2037 arg
= argpar_item_opt_arg(argpar_item
);
2039 switch (opt_descr
->id
) {
2041 print_run_usage(stdout
);
2042 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
2046 enum bt_config_component_dest dest
;
2048 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2049 cur_cfg_comp
= bt_config_component_from_arg(arg
,
2051 if (!cur_cfg_comp
) {
2052 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
2057 switch (cur_cfg_comp
->type
) {
2058 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2059 dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2061 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2062 dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
2064 case BT_COMPONENT_CLASS_TYPE_SINK
:
2065 dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2071 BT_ASSERT(cur_base_params
);
2072 bt_value_put_ref(cur_cfg_comp
->params
);
2073 if (bt_value_copy(cur_base_params
,
2074 &cur_cfg_comp
->params
) < 0) {
2075 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2079 ret
= add_run_cfg_comp_check_name(cfg
,
2092 if (!cur_cfg_comp
) {
2093 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
2098 params
= bt_param_parse(arg
, error_str
);
2100 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
2105 extend_status
= bt_value_map_extend(cur_cfg_comp
->params
,
2107 BT_VALUE_PUT_REF_AND_RESET(params
);
2108 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
2109 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
2117 if (!cur_cfg_comp
) {
2118 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
2123 cur_cfg_comp
->log_level
=
2124 bt_log_get_level_from_string(arg
);
2125 if (cur_cfg_comp
->log_level
< 0) {
2126 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
2131 case OPT_BASE_PARAMS
:
2133 bt_value
*params
= bt_param_parse(arg
, error_str
);
2136 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
2141 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
2144 case OPT_RESET_BASE_PARAMS
:
2145 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2146 cur_base_params
= bt_value_map_create();
2147 if (!cur_base_params
) {
2148 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2153 if (bt_value_array_append_string_element(
2154 connection_args
, arg
)) {
2155 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2159 case OPT_RETRY_DURATION
: {
2161 size_t arg_len
= strlen(arg
);
2163 retry_duration
= g_ascii_strtoll(arg
, &end
, 10);
2165 if (arg_len
== 0 || end
!= (arg
+ arg_len
)) {
2166 BT_CLI_LOGE_APPEND_CAUSE(
2167 "Could not parse --retry-duration option's argument as an unsigned integer: `%s`",
2172 if (retry_duration
< 0) {
2173 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2178 cfg
->cmd_data
.run
.retry_duration_us
=
2179 (uint64_t) retry_duration
;
2187 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2189 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2190 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2194 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2195 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2199 ret
= bt_config_cli_args_create_connections(cfg
,
2203 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2207 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
2208 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
2212 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
2216 g_string_free(error_str
, TRUE
);
2219 argpar_iter_destroy(argpar_iter
);
2220 argpar_item_destroy(argpar_item
);
2222 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2223 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2224 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2225 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2226 bt_object_put_ref(cfg
);
2232 enum bt_config_cli_args_status
bt_config_run_from_args_array(
2233 const bt_value
*run_args
, struct bt_config
**cfg
,
2234 const bt_value
*plugin_paths
,
2235 int default_log_level
)
2237 enum bt_config_cli_args_status status
;
2239 uint64_t i
, len
= bt_value_array_get_length(run_args
);
2241 BT_ASSERT(len
<= SIZE_MAX
);
2242 argv
= calloc((size_t) len
, sizeof(*argv
));
2244 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2248 for (i
= 0; i
< len
; i
++) {
2249 const bt_value
*arg_value
=
2250 bt_value_array_borrow_element_by_index_const(run_args
,
2254 arg
= bt_value_string_get(arg_value
);
2259 status
= bt_config_run_from_args((int) len
, argv
, cfg
,
2260 plugin_paths
, default_log_level
, 0);
2265 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
2273 * Prints the convert command usage.
2276 void print_convert_usage(FILE *fp
)
2278 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2280 fprintf(fp
, "Options:\n");
2282 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2283 fprintf(fp
, " Instantiate the component class CLS of type\n");
2284 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2285 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2286 fprintf(fp
, " conversion graph, and optionally name it\n");
2287 fprintf(fp
, " NAME\n");
2288 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2289 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
2290 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2291 fprintf(fp
, " current component (see the expected format\n");
2292 fprintf(fp
, " of PARAMS below)\n");
2293 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2294 fprintf(fp
, " the graph later, retry in DUR µs\n");
2295 fprintf(fp
, " (default: 100000)\n");
2296 fprintf(fp
, " dynamic plugins can be loaded\n");
2297 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2298 fprintf(fp
, " `run` command to the standard output,\n");
2299 fprintf(fp
, " formatted for a shell, and quit\n");
2300 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2301 fprintf(fp
, " `run` command to the standard output,\n");
2302 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2303 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2304 fprintf(fp
, " are active\n");
2305 fprintf(fp
, " -h, --help Show this help and quit\n");
2307 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2309 fprintf(fp
, " --clock-force-correlate Force the origin of all clocks\n");
2310 fprintf(fp
, " to the Unix epoch\n");
2311 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2312 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2314 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2316 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2317 fprintf(fp
, " --clock-date Print timestamp dates\n");
2318 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2319 fprintf(fp
, " time zone instead of the local time zone\n");
2320 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2321 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2322 fprintf(fp
, " --color=(never | auto | always)\n");
2323 fprintf(fp
, " Never, automatically, or always emit\n");
2324 fprintf(fp
, " console color codes\n");
2325 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2326 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2327 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2328 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2329 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2330 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2331 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2332 fprintf(fp
, " (or `ctx`)\n");
2333 fprintf(fp
, " --no-delta Do not print time delta between\n");
2334 fprintf(fp
, " consecutive events\n");
2335 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2336 fprintf(fp
, " the standard output\n");
2338 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2340 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2341 fprintf(fp
, " time range to BEGIN (see the format of\n");
2342 fprintf(fp
, " BEGIN below)\n");
2343 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2344 fprintf(fp
, " range to END (see the format of END below)\n");
2345 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2346 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2347 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2349 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2351 fprintf(fp
, " --debug-info Create an implicit\n");
2352 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2353 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2354 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2355 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2356 fprintf(fp
, " binary paths instead of just names\n");
2357 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2358 fprintf(fp
, " Use directory DIR as a prefix when\n");
2359 fprintf(fp
, " looking up executables during debug\n");
2360 fprintf(fp
, " info analysis\n");
2362 fprintf(fp
, "Legacy options that still work:\n");
2364 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2365 fprintf(fp
, " `ctf`:\n");
2366 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2367 fprintf(fp
, " component\n");
2368 fprintf(fp
, " `lttng-live`:\n");
2369 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2370 fprintf(fp
, " component\n");
2371 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2372 fprintf(fp
, " `text`:\n");
2373 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2374 fprintf(fp
, " component\n");
2375 fprintf(fp
, " `ctf`:\n");
2376 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2377 fprintf(fp
, " component\n");
2378 fprintf(fp
, " `dummy`:\n");
2379 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2380 fprintf(fp
, " component\n");
2381 fprintf(fp
, " `ctf-metadata`:\n");
2382 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2383 fprintf(fp
, " for metadata text and quit\n");
2385 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2386 fprintf(fp
, "\n\n");
2387 fprintf(fp
, "Format of BEGIN and END\n");
2388 fprintf(fp
, "-----------------------\n");
2390 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2391 fprintf(fp
, "\n\n");
2392 print_expected_params_format(fp
);
2396 const struct argpar_opt_descr convert_options
[] = {
2397 /* id, short_name, long_name, with_arg */
2398 { OPT_BEGIN
, 'b', "begin", true },
2399 { OPT_CLOCK_CYCLES
, '\0', "clock-cycles", false },
2400 { OPT_CLOCK_DATE
, '\0', "clock-date", false },
2401 { OPT_CLOCK_FORCE_CORRELATE
, '\0', "clock-force-correlate", false },
2402 { OPT_CLOCK_GMT
, '\0', "clock-gmt", false },
2403 { OPT_CLOCK_OFFSET
, '\0', "clock-offset", true },
2404 { OPT_CLOCK_OFFSET_NS
, '\0', "clock-offset-ns", true },
2405 { OPT_CLOCK_SECONDS
, '\0', "clock-seconds", false },
2406 { OPT_COLOR
, '\0', "color", true },
2407 { OPT_COMPONENT
, 'c', "component", true },
2408 { OPT_DEBUG
, 'd', "debug", false },
2409 { OPT_DEBUG_INFO_DIR
, '\0', "debug-info-dir", true },
2410 { OPT_DEBUG_INFO_FULL_PATH
, '\0', "debug-info-full-path", false },
2411 { OPT_DEBUG_INFO_TARGET_PREFIX
, '\0', "debug-info-target-prefix", true },
2412 { OPT_END
, 'e', "end", true },
2413 { OPT_FIELDS
, 'f', "fields", true },
2414 { OPT_HELP
, 'h', "help", false },
2415 { OPT_INPUT_FORMAT
, 'i', "input-format", true },
2416 { OPT_LOG_LEVEL
, 'l', "log-level", true },
2417 { OPT_NAMES
, 'n', "names", true },
2418 { OPT_DEBUG_INFO
, '\0', "debug-info", false },
2419 { OPT_NO_DELTA
, '\0', "no-delta", false },
2420 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
2421 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
2422 { OPT_OUTPUT
, 'w', "output", true },
2423 { OPT_OUTPUT_FORMAT
, 'o', "output-format", true },
2424 { OPT_PARAMS
, 'p', "params", true },
2425 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
2426 { OPT_RUN_ARGS
, '\0', "run-args", false },
2427 { OPT_RUN_ARGS_0
, '\0', "run-args-0", false },
2428 { OPT_STREAM_INTERSECTION
, '\0', "stream-intersection", false },
2429 { OPT_TIMERANGE
, '\0', "timerange", true },
2430 { OPT_VERBOSE
, 'v', "verbose", false },
2431 ARGPAR_OPT_DESCR_SENTINEL
2435 GString
*get_component_auto_name(const char *prefix
,
2436 const bt_value
*existing_names
)
2439 GString
*auto_name
= g_string_new(NULL
);
2442 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2446 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2447 g_string_assign(auto_name
, prefix
);
2452 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2454 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2460 struct implicit_component_args
{
2463 /* The component class name (e.g. src.ctf.fs). */
2466 /* The component instance name. */
2469 GString
*params_arg
;
2470 bt_value
*extra_params
;
2474 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2475 const char *prefix
, bt_value
*existing_names
,
2476 GList
**comp_names
, bool append_to_comp_names
)
2479 GString
*name
= NULL
;
2481 if (!args
->exists
) {
2485 name
= get_component_auto_name(prefix
,
2493 g_string_assign(args
->name_arg
, name
->str
);
2495 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2497 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2502 if (append_to_comp_names
) {
2503 *comp_names
= g_list_append(*comp_names
, name
);
2509 g_string_free(name
, TRUE
);
2516 int append_run_args_for_implicit_component(
2517 struct implicit_component_args
*impl_args
,
2522 GString
*component_arg_for_run
= NULL
;
2524 if (!impl_args
->exists
) {
2528 component_arg_for_run
= g_string_new(NULL
);
2529 if (!component_arg_for_run
) {
2530 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2534 /* Build the full `name:type.plugin.cls`. */
2535 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, '\\'));
2536 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, ':'));
2537 g_string_printf(component_arg_for_run
, "%s:%s",
2538 impl_args
->name_arg
->str
, impl_args
->comp_arg
->str
);
2540 if (bt_value_array_append_string_element(run_args
, "--component")) {
2541 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2545 if (bt_value_array_append_string_element(run_args
,
2546 component_arg_for_run
->str
)) {
2547 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2551 if (impl_args
->params_arg
->len
> 0) {
2552 if (bt_value_array_append_string_element(run_args
, "--params")) {
2553 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2557 if (bt_value_array_append_string_element(run_args
,
2558 impl_args
->params_arg
->str
)) {
2559 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2564 for (i
= 0; i
< bt_value_array_get_length(impl_args
->extra_params
); i
++) {
2565 const bt_value
*elem
;
2568 elem
= bt_value_array_borrow_element_by_index(
2569 impl_args
->extra_params
, i
);
2571 BT_ASSERT(bt_value_is_string(elem
));
2572 arg
= bt_value_string_get(elem
);
2573 ret
= bt_value_array_append_string_element(run_args
, arg
);
2575 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2586 if (component_arg_for_run
) {
2587 g_string_free(component_arg_for_run
, TRUE
);
2593 /* Free the fields of a `struct implicit_component_args`. */
2596 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2600 if (args
->comp_arg
) {
2601 g_string_free(args
->comp_arg
, TRUE
);
2604 if (args
->name_arg
) {
2605 g_string_free(args
->name_arg
, TRUE
);
2608 if (args
->params_arg
) {
2609 g_string_free(args
->params_arg
, TRUE
);
2612 bt_value_put_ref(args
->extra_params
);
2615 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2618 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2620 finalize_implicit_component_args(args
);
2624 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2627 int init_implicit_component_args(struct implicit_component_args
*args
,
2628 const char *comp_arg
, bool exists
)
2632 args
->exists
= exists
;
2633 args
->comp_arg
= g_string_new(comp_arg
);
2634 args
->name_arg
= g_string_new(NULL
);
2635 args
->params_arg
= g_string_new(NULL
);
2636 args
->extra_params
= bt_value_array_create();
2638 if (!args
->comp_arg
|| !args
->name_arg
||
2639 !args
->params_arg
|| !args
->extra_params
) {
2641 finalize_implicit_component_args(args
);
2642 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2650 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2653 struct implicit_component_args
*create_implicit_component_args(
2654 const char *comp_arg
)
2656 struct implicit_component_args
*args
;
2659 args
= g_new(struct implicit_component_args
, 1);
2661 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2665 status
= init_implicit_component_args(args
, comp_arg
, true);
2676 void append_implicit_component_param(struct implicit_component_args
*args
,
2677 const char *key
, const char *value
)
2682 append_param_arg(args
->params_arg
, key
, value
);
2686 * Append the given parameter (`key=value`) to all component specifications
2687 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2688 * which match `comp_arg`.
2690 * Return the number of matching components.
2694 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2695 const char *comp_arg
, const char *key
, const char *value
)
2700 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2701 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2703 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2704 append_implicit_component_param(args
, key
, value
);
2712 /* Escape value to make it suitable to use as a string parameter value. */
2714 gchar
*escape_string_value(const char *value
)
2719 ret
= g_string_new(NULL
);
2721 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2730 g_string_append_c(ret
, '\\');
2734 g_string_append_c(ret
, *in
);
2740 return g_string_free(ret
, FALSE
);
2744 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2750 switch (bt_value_get_type(value
)) {
2751 case BT_VALUE_TYPE_STRING
:
2753 const char *str_value
= bt_value_string_get(value
);
2754 gchar
*escaped_str_value
;
2756 escaped_str_value
= escape_string_value(str_value
);
2757 if (!escaped_str_value
) {
2761 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2763 g_free(escaped_str_value
);
2766 case BT_VALUE_TYPE_ARRAY
: {
2767 g_string_append_c(buf
, '[');
2768 uint64_t sz
= bt_value_array_get_length(value
);
2769 for (uint64_t i
= 0; i
< sz
; i
++) {
2770 const bt_value
*item
;
2773 g_string_append(buf
, ", ");
2776 item
= bt_value_array_borrow_element_by_index_const(
2778 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2784 g_string_append_c(buf
, ']');
2798 * Convert `value` to its equivalent representation as a command line parameter
2803 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2806 gchar
*result
= NULL
;
2808 buf
= g_string_new(NULL
);
2810 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2814 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2818 result
= g_string_free(buf
, FALSE
);
2825 g_string_free(buf
, TRUE
);
2833 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2836 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2841 gchar
*str_value
= NULL
;
2842 GString
*parameter
= NULL
;
2844 if (bt_value_array_append_string_element(args
, "--params")) {
2845 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2850 str_value
= bt_value_to_cli_param_value(value
);
2856 parameter
= g_string_new(NULL
);
2858 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2863 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2865 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2866 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2873 g_string_free(parameter
, TRUE
);
2886 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2888 bt_value
*str_value
;
2891 str_value
= bt_value_string_create_init(value
);
2894 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2899 ret
= append_parameter_to_args(args
, key
, str_value
);
2902 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2907 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2908 const char *key
, const char *value
)
2910 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2914 * Escapes `.`, `:`, and `\` of `input` with `\`.
2917 GString
*escape_dot_colon(const char *input
)
2919 GString
*output
= g_string_new(NULL
);
2923 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2927 for (ch
= input
; *ch
!= '\0'; ch
++) {
2928 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
2929 g_string_append_c(output
, '\\');
2932 g_string_append_c(output
, *ch
);
2940 * Appends a --connect option to a list of arguments. `upstream_name`
2941 * and `downstream_name` are escaped with escape_dot_colon() in this
2945 int append_connect_arg(bt_value
*run_args
,
2946 const char *upstream_name
, const char *downstream_name
)
2949 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
2950 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
2951 GString
*arg
= g_string_new(NULL
);
2953 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
2954 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2959 ret
= bt_value_array_append_string_element(run_args
, "--connect");
2961 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2966 g_string_append(arg
, e_upstream_name
->str
);
2967 g_string_append_c(arg
, ':');
2968 g_string_append(arg
, e_downstream_name
->str
);
2969 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
2971 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2978 g_string_free(arg
, TRUE
);
2981 if (e_upstream_name
) {
2982 g_string_free(e_upstream_name
, TRUE
);
2985 if (e_downstream_name
) {
2986 g_string_free(e_downstream_name
, TRUE
);
2993 * Appends the run command's --connect options for the convert command.
2996 int convert_auto_connect(bt_value
*run_args
,
2997 GList
*source_names
, GList
*filter_names
,
3001 GList
*source_at
= source_names
;
3002 GList
*filter_at
= filter_names
;
3004 GList
*sink_at
= sink_names
;
3006 BT_ASSERT(source_names
);
3007 BT_ASSERT(filter_names
);
3008 BT_ASSERT(sink_names
);
3010 /* Connect all sources to the first filter */
3011 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
3012 GString
*source_name
= source_at
->data
;
3013 GString
*filter_name
= filter_at
->data
;
3015 ret
= append_connect_arg(run_args
, source_name
->str
,
3022 filter_prev
= filter_at
;
3023 filter_at
= g_list_next(filter_at
);
3025 /* Connect remaining filters */
3026 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
3027 GString
*filter_name
= filter_at
->data
;
3028 GString
*filter_prev_name
= filter_prev
->data
;
3030 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
3037 /* Connect last filter to all sinks */
3038 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
3039 GString
*filter_name
= filter_prev
->data
;
3040 GString
*sink_name
= sink_at
->data
;
3042 ret
= append_connect_arg(run_args
, filter_name
->str
,
3059 int split_timerange(const char *arg
, char **begin
, char **end
)
3062 const char *ch
= arg
;
3064 GString
*g_begin
= NULL
;
3065 GString
*g_end
= NULL
;
3073 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
3074 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
3080 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
3081 if (!g_end
|| g_end
->len
== 0) {
3087 *begin
= g_string_free(g_begin
, FALSE
);
3088 *end
= g_string_free(g_end
, FALSE
);
3098 g_string_free(g_begin
, TRUE
);
3102 g_string_free(g_end
, TRUE
);
3109 int g_list_prepend_gstring(GList
**list
, const char *string
)
3112 GString
*gs
= g_string_new(string
);
3117 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3121 *list
= g_list_prepend(*list
, gs
);
3128 * Create `struct implicit_component_args` structures for each of the
3129 * source components we identified. Add them to `component_args`.
3131 * `non_opts` is an array of the non-option arguments passed on the command
3134 * `non_opt_params` is an array where each element is an array of
3135 * strings containing all the arguments to `--params` that apply to the
3136 * non-option argument at the same index. For example, if, for a
3137 * non-option argument, the following `--params` options applied:
3139 * --params=a=2 --params=b=3,c=4
3141 * its entry in `non_opt_params` would contain
3143 * ["a=2", "b=3,c=4"]
3147 int create_implicit_component_args_from_auto_discovered_sources(
3148 const struct auto_source_discovery
*auto_disc
,
3149 const bt_value
*non_opts
,
3150 const bt_value
*non_opt_params
,
3151 const bt_value
*non_opt_loglevels
,
3152 GPtrArray
*component_args
)
3154 gchar
*cc_name
= NULL
;
3155 struct implicit_component_args
*comp
= NULL
;
3159 len
= auto_disc
->results
->len
;
3161 for (i
= 0; i
< len
; i
++) {
3162 struct auto_source_discovery_result
*res
=
3163 g_ptr_array_index(auto_disc
->results
, i
);
3164 uint64_t orig_indices_i
, orig_indices_count
;
3167 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3169 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3173 comp
= create_implicit_component_args(cc_name
);
3179 * Append parameters and log levels of all the
3180 * non-option arguments that contributed to this
3181 * component instance coming into existence.
3183 orig_indices_count
= bt_value_array_get_length(res
->original_input_indices
);
3184 for (orig_indices_i
= 0; orig_indices_i
< orig_indices_count
; orig_indices_i
++) {
3185 const bt_value
*orig_idx_value
=
3186 bt_value_array_borrow_element_by_index(
3187 res
->original_input_indices
, orig_indices_i
);
3188 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3189 const bt_value
*params_array
=
3190 bt_value_array_borrow_element_by_index_const(
3191 non_opt_params
, orig_idx
);
3192 uint64_t params_i
, params_count
;
3193 const bt_value
*loglevel_value
;
3195 params_count
= bt_value_array_get_length(params_array
);
3196 for (params_i
= 0; params_i
< params_count
; params_i
++) {
3197 const bt_value
*params_value
=
3198 bt_value_array_borrow_element_by_index_const(
3199 params_array
, params_i
);
3200 const char *params
= bt_value_string_get(params_value
);
3201 bt_value_array_append_element_status append_status
;
3203 append_status
= bt_value_array_append_string_element(
3204 comp
->extra_params
, "--params");
3205 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3206 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3210 append_status
= bt_value_array_append_string_element(
3211 comp
->extra_params
, params
);
3212 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3213 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3218 loglevel_value
= bt_value_array_borrow_element_by_index_const(
3219 non_opt_loglevels
, orig_idx
);
3220 if (bt_value_get_type(loglevel_value
) == BT_VALUE_TYPE_STRING
) {
3221 const char *loglevel
= bt_value_string_get(loglevel_value
);
3222 bt_value_array_append_element_status append_status
;
3224 append_status
= bt_value_array_append_string_element(
3225 comp
->extra_params
, "--log-level");
3226 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3227 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3231 append_status
= bt_value_array_append_string_element(
3232 comp
->extra_params
, loglevel
);
3233 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3234 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3241 * If single input and a src.ctf.fs component, provide the
3242 * relative path from the path passed on the command line to the
3245 if (bt_value_array_get_length(res
->inputs
) == 1 &&
3246 strcmp(res
->plugin_name
, "ctf") == 0 &&
3247 strcmp(res
->source_cc_name
, "fs") == 0) {
3248 const bt_value
*orig_idx_value
=
3249 bt_value_array_borrow_element_by_index(
3250 res
->original_input_indices
, 0);
3251 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3252 const bt_value
*non_opt_value
=
3253 bt_value_array_borrow_element_by_index_const(
3254 non_opts
, orig_idx
);
3255 const char *non_opt
= bt_value_string_get(non_opt_value
);
3256 const bt_value
*input_value
=
3257 bt_value_array_borrow_element_by_index_const(
3259 const char *input
= bt_value_string_get(input_value
);
3261 BT_ASSERT(orig_indices_count
== 1);
3262 BT_ASSERT(g_str_has_prefix(input
, non_opt
));
3264 input
+= strlen(non_opt
);
3266 while (G_IS_DIR_SEPARATOR(*input
)) {
3270 if (strlen(input
) > 0) {
3271 append_string_parameter_to_args(comp
->extra_params
,
3272 "trace-name", input
);
3276 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3281 g_ptr_array_add(component_args
, comp
);
3295 destroy_implicit_component_args(comp
);
3302 * As we iterate the arguments to the convert command, this tracks what is the
3303 * type of the current item, to which some contextual options (e.g. --params)
3306 enum convert_current_item_type
{
3307 /* There is no current item. */
3308 CONVERT_CURRENT_ITEM_TYPE_NONE
,
3310 /* Current item is a component. */
3311 CONVERT_CURRENT_ITEM_TYPE_COMPONENT
,
3313 /* Current item is a non-option argument. */
3314 CONVERT_CURRENT_ITEM_TYPE_NON_OPT
,
3318 * Creates a Babeltrace config object from the arguments of a convert
3322 enum bt_config_cli_args_status
bt_config_convert_from_args(int argc
,
3323 const char *argv
[], struct bt_config
**cfg_out
,
3324 const bt_value
*plugin_paths
,
3325 int *default_log_level
, const bt_interrupter
*interrupter
,
3326 unsigned int consumed_args
)
3328 enum bt_config_cli_args_status status
;
3329 enum convert_current_item_type current_item_type
=
3330 CONVERT_CURRENT_ITEM_TYPE_NONE
;
3332 struct bt_config
*cfg
= NULL
;
3333 bool got_input_format_opt
= false;
3334 bool got_output_format_opt
= false;
3335 bool trimmer_has_begin
= false;
3336 bool trimmer_has_end
= false;
3337 bool stream_intersection_mode
= false;
3338 bool print_run_args
= false;
3339 bool print_run_args_0
= false;
3340 bool print_ctf_metadata
= false;
3341 bt_value
*run_args
= NULL
;
3342 bt_value
*all_names
= NULL
;
3343 GList
*source_names
= NULL
;
3344 GList
*filter_names
= NULL
;
3345 GList
*sink_names
= NULL
;
3346 bt_value
*non_opts
= NULL
;
3347 bt_value
*non_opt_params
= NULL
;
3348 bt_value
*non_opt_loglevels
= NULL
;
3349 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3350 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3351 struct implicit_component_args implicit_dummy_args
= { 0 };
3352 struct implicit_component_args implicit_text_args
= { 0 };
3353 struct implicit_component_args implicit_debug_info_args
= { 0 };
3354 struct implicit_component_args implicit_muxer_args
= { 0 };
3355 struct implicit_component_args implicit_trimmer_args
= { 0 };
3356 char error_buf
[256] = { 0 };
3358 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3359 char *output
= NULL
;
3360 struct auto_source_discovery auto_disc
= { NULL
};
3361 GString
*auto_disc_comp_name
= NULL
;
3362 struct argpar_iter
*argpar_iter
= NULL
;
3363 const struct argpar_item
*argpar_item
= NULL
;
3364 GString
*name_gstr
= NULL
;
3365 GString
*component_arg_for_run
= NULL
;
3366 bt_value
*live_inputs_array_val
= NULL
;
3369 * Array of `struct implicit_component_args *` created for the sources
3370 * we have auto-discovered.
3372 GPtrArray
*discovered_source_args
= NULL
;
3375 * If set, restrict automatic source discovery to this component class
3378 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3379 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3381 bool ctf_fs_source_force_clock_class_unix_epoch_origin
= false;
3382 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3383 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3386 print_convert_usage(stdout
);
3387 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
3391 if (init_implicit_component_args(&implicit_ctf_output_args
,
3392 "sink.ctf.fs", false)) {
3396 if (init_implicit_component_args(&implicit_lttng_live_args
,
3397 "source.ctf.lttng-live", false)) {
3401 if (init_implicit_component_args(&implicit_text_args
,
3402 "sink.text.pretty", false)) {
3406 if (init_implicit_component_args(&implicit_dummy_args
,
3407 "sink.utils.dummy", false)) {
3411 if (init_implicit_component_args(&implicit_debug_info_args
,
3412 "filter.lttng-utils.debug-info", false)) {
3416 if (init_implicit_component_args(&implicit_muxer_args
,
3417 "filter.utils.muxer", true)) {
3421 if (init_implicit_component_args(&implicit_trimmer_args
,
3422 "filter.utils.trimmer", false)) {
3426 all_names
= bt_value_map_create();
3428 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3432 run_args
= bt_value_array_create();
3434 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3438 component_arg_for_run
= g_string_new(NULL
);
3439 if (!component_arg_for_run
) {
3440 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3444 non_opts
= bt_value_array_create();
3446 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3450 non_opt_params
= bt_value_array_create();
3451 if (!non_opt_params
) {
3452 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3456 non_opt_loglevels
= bt_value_array_create();
3457 if (!non_opt_loglevels
) {
3458 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3462 if (auto_source_discovery_init(&auto_disc
) != 0) {
3466 discovered_source_args
=
3467 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3468 if (!discovered_source_args
) {
3469 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3473 auto_disc_comp_name
= g_string_new(NULL
);
3474 if (!auto_disc_comp_name
) {
3475 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3480 * First pass: collect all arguments which need to be passed
3481 * as is to the run command. This pass can also add --name
3482 * arguments if needed to automatically name unnamed component
3485 argpar_iter
= argpar_iter_create(argc
, argv
, convert_options
);
3487 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3492 enum parse_next_item_status parse_status
;
3494 char *plugin_name
= NULL
;
3495 char *comp_cls_name
= NULL
;
3497 parse_status
= parse_next_item(argpar_iter
, &argpar_item
, argv
, "convert",
3499 if (parse_status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
3501 } else if (parse_status
== PARSE_NEXT_ITEM_STATUS_END
) {
3505 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
3506 const struct argpar_opt_descr
*opt_descr
=
3507 argpar_item_opt_descr(argpar_item
);
3508 const char *arg
= argpar_item_opt_arg(argpar_item
);
3510 switch (opt_descr
->id
) {
3512 print_convert_usage(stdout
);
3513 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
3517 bt_component_class_type type
;
3519 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_COMPONENT
;
3521 /* Parse the argument */
3522 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3523 &comp_cls_name
, &type
);
3524 if (!plugin_name
|| !comp_cls_name
) {
3525 BT_CLI_LOGE_APPEND_CAUSE(
3526 "Invalid format for --component option's argument:\n %s",
3533 * Name was given by the user, verify it isn't
3536 if (bt_value_map_has_entry(all_names
, name
)) {
3537 BT_CLI_LOGE_APPEND_CAUSE(
3538 "Duplicate component instance name:\n %s",
3543 name_gstr
= g_string_new(name
);
3545 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3549 g_string_assign(component_arg_for_run
, arg
);
3551 /* Name not given by user, generate one. */
3552 name_gstr
= get_component_auto_name(arg
, all_names
);
3557 g_string_printf(component_arg_for_run
, "%s:%s",
3558 name_gstr
->str
, arg
);
3561 if (bt_value_array_append_string_element(run_args
,
3563 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3567 if (bt_value_array_append_string_element(run_args
,
3568 component_arg_for_run
->str
)) {
3569 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3574 * Remember this name globally, for the uniqueness of
3575 * all component names.
3577 if (bt_value_map_insert_entry(all_names
,
3578 name_gstr
->str
, bt_value_null
)) {
3579 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3584 * Remember this name specifically for the type of the
3585 * component. This is to create connection arguments.
3587 * The list takes ownership of `name_gstr`.
3590 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3591 source_names
= g_list_append(source_names
, name_gstr
);
3593 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3594 filter_names
= g_list_append(filter_names
, name_gstr
);
3596 case BT_COMPONENT_CLASS_TYPE_SINK
:
3597 sink_names
= g_list_append(sink_names
, name_gstr
);
3606 free(comp_cls_name
);
3609 comp_cls_name
= NULL
;
3613 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3615 * The current item is a component (--component option),
3616 * pass it directly to the run args.
3618 if (bt_value_array_append_string_element(run_args
,
3620 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3624 if (bt_value_array_append_string_element(run_args
, arg
)) {
3625 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3628 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3630 * The current item is a
3631 * non-option argument, record
3632 * it in `non_opt_params`.
3635 bt_value_array_append_element_status append_element_status
;
3636 uint64_t idx
= bt_value_array_get_length(non_opt_params
) - 1;
3638 array
= bt_value_array_borrow_element_by_index(non_opt_params
, idx
);
3640 append_element_status
= bt_value_array_append_string_element(array
, arg
);
3641 if (append_element_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3642 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3646 BT_CLI_LOGE_APPEND_CAUSE(
3647 "No current component (--component option) or non-option argument of which to set parameters:\n %s",
3653 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3654 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3655 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3659 if (bt_value_array_append_string_element(run_args
, arg
)) {
3660 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3663 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3664 uint64_t idx
= bt_value_array_get_length(non_opt_loglevels
) - 1;
3665 enum bt_value_array_set_element_by_index_status set_element_status
;
3666 bt_value
*log_level_str_value
;
3668 log_level_str_value
= bt_value_string_create_init(arg
);
3669 if (!log_level_str_value
) {
3670 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3674 set_element_status
=
3675 bt_value_array_set_element_by_index(non_opt_loglevels
,
3676 idx
, log_level_str_value
);
3677 bt_value_put_ref(log_level_str_value
);
3678 if (set_element_status
!= BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK
) {
3679 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3683 BT_CLI_LOGE_APPEND_CAUSE(
3684 "No current component (--component option) or non-option argument to assign a log level to:\n %s",
3690 case OPT_RETRY_DURATION
:
3691 if (bt_value_array_append_string_element(run_args
,
3692 "--retry-duration")) {
3693 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3697 if (bt_value_array_append_string_element(run_args
, arg
)) {
3698 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3703 case OPT_CLOCK_CYCLES
:
3704 case OPT_CLOCK_DATE
:
3705 case OPT_CLOCK_FORCE_CORRELATE
:
3707 case OPT_CLOCK_OFFSET
:
3708 case OPT_CLOCK_OFFSET_NS
:
3709 case OPT_CLOCK_SECONDS
:
3712 case OPT_DEBUG_INFO
:
3713 case OPT_DEBUG_INFO_DIR
:
3714 case OPT_DEBUG_INFO_FULL_PATH
:
3715 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3718 case OPT_INPUT_FORMAT
:
3721 case OPT_OUTPUT_FORMAT
:
3724 case OPT_RUN_ARGS_0
:
3725 case OPT_STREAM_INTERSECTION
:
3728 /* Ignore in this pass */
3734 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
3735 bt_value_array_append_element_status append_status
;
3737 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_NON_OPT
;
3739 append_status
= bt_value_array_append_string_element(non_opts
, arg
);
3740 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3741 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3745 append_status
= bt_value_array_append_empty_array_element(
3746 non_opt_params
, NULL
);
3747 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3748 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3752 append_status
= bt_value_array_append_element(non_opt_loglevels
, bt_value_null
);
3753 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3754 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3761 * Second pass: transform the convert-specific options and
3762 * arguments into implicit component instances for the run
3765 argpar_iter_destroy(argpar_iter
);
3766 argpar_iter
= argpar_iter_create(argc
, argv
, convert_options
);
3768 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3773 enum parse_next_item_status parse_status
;
3774 const struct argpar_opt_descr
*opt_descr
;
3777 parse_status
= parse_next_item(argpar_iter
, &argpar_item
, argv
, "convert",
3779 if (parse_status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
3781 } else if (parse_status
== PARSE_NEXT_ITEM_STATUS_END
) {
3785 if (argpar_item_type(argpar_item
) != ARGPAR_ITEM_TYPE_OPT
) {
3789 opt_descr
= argpar_item_opt_descr(argpar_item
);
3790 arg
= argpar_item_opt_arg(argpar_item
);
3792 switch (opt_descr
->id
) {
3794 if (trimmer_has_begin
) {
3795 BT_CLI_LOGE_APPEND_CAUSE("At --begin option: --begin or --timerange option already specified\n %s\n",
3800 trimmer_has_begin
= true;
3801 ret
= append_implicit_component_extra_param(
3802 &implicit_trimmer_args
, "begin", arg
);
3803 implicit_trimmer_args
.exists
= true;
3809 if (trimmer_has_end
) {
3810 BT_CLI_LOGE_APPEND_CAUSE("At --end option: --end or --timerange option already specified\n %s\n",
3815 trimmer_has_end
= true;
3816 ret
= append_implicit_component_extra_param(
3817 &implicit_trimmer_args
, "end", arg
);
3818 implicit_trimmer_args
.exists
= true;
3828 if (trimmer_has_begin
|| trimmer_has_end
) {
3829 BT_CLI_LOGE_APPEND_CAUSE("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3834 ret
= split_timerange(arg
, &begin
, &end
);
3836 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3841 ret
= append_implicit_component_extra_param(
3842 &implicit_trimmer_args
, "begin", begin
);
3843 ret
|= append_implicit_component_extra_param(
3844 &implicit_trimmer_args
, "end", end
);
3845 implicit_trimmer_args
.exists
= true;
3853 case OPT_CLOCK_CYCLES
:
3854 append_implicit_component_param(
3855 &implicit_text_args
, "clock-cycles", "yes");
3856 implicit_text_args
.exists
= true;
3858 case OPT_CLOCK_DATE
:
3859 append_implicit_component_param(
3860 &implicit_text_args
, "clock-date", "yes");
3861 implicit_text_args
.exists
= true;
3863 case OPT_CLOCK_FORCE_CORRELATE
:
3864 ctf_fs_source_force_clock_class_unix_epoch_origin
= true;
3867 append_implicit_component_param(
3868 &implicit_text_args
, "clock-gmt", "yes");
3869 append_implicit_component_param(
3870 &implicit_trimmer_args
, "gmt", "yes");
3871 implicit_text_args
.exists
= true;
3873 case OPT_CLOCK_OFFSET
:
3874 if (ctf_fs_source_clock_class_offset_arg
) {
3875 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3879 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3880 if (!ctf_fs_source_clock_class_offset_arg
) {
3881 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3885 case OPT_CLOCK_OFFSET_NS
:
3886 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3887 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3891 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3892 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3893 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3897 case OPT_CLOCK_SECONDS
:
3898 append_implicit_component_param(
3899 &implicit_text_args
, "clock-seconds", "yes");
3900 implicit_text_args
.exists
= true;
3903 implicit_text_args
.exists
= true;
3904 ret
= append_implicit_component_extra_param(
3905 &implicit_text_args
, "color", arg
);
3910 case OPT_DEBUG_INFO
:
3911 implicit_debug_info_args
.exists
= true;
3913 case OPT_DEBUG_INFO_DIR
:
3914 implicit_debug_info_args
.exists
= true;
3915 ret
= append_implicit_component_extra_param(
3916 &implicit_debug_info_args
, "debug-info-dir", arg
);
3921 case OPT_DEBUG_INFO_FULL_PATH
:
3922 implicit_debug_info_args
.exists
= true;
3923 append_implicit_component_param(
3924 &implicit_debug_info_args
, "full-path", "yes");
3926 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3927 implicit_debug_info_args
.exists
= true;
3928 ret
= append_implicit_component_extra_param(
3929 &implicit_debug_info_args
,
3930 "target-prefix", arg
);
3937 bt_value
*fields
= fields_from_arg(arg
);
3943 implicit_text_args
.exists
= true;
3944 ret
= insert_flat_params_from_array(
3945 implicit_text_args
.params_arg
,
3947 bt_value_put_ref(fields
);
3955 bt_value
*names
= names_from_arg(arg
);
3961 implicit_text_args
.exists
= true;
3962 ret
= insert_flat_params_from_array(
3963 implicit_text_args
.params_arg
,
3965 bt_value_put_ref(names
);
3972 append_implicit_component_param(
3973 &implicit_text_args
, "no-delta", "yes");
3974 implicit_text_args
.exists
= true;
3976 case OPT_INPUT_FORMAT
:
3977 if (got_input_format_opt
) {
3978 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3982 got_input_format_opt
= true;
3984 if (strcmp(arg
, "ctf") == 0) {
3985 auto_source_discovery_restrict_plugin_name
= "ctf";
3986 auto_source_discovery_restrict_component_class_name
= "fs";
3987 } else if (strcmp(arg
, "lttng-live") == 0) {
3988 auto_source_discovery_restrict_plugin_name
= "ctf";
3989 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3990 implicit_lttng_live_args
.exists
= true;
3992 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
3997 case OPT_OUTPUT_FORMAT
:
3998 if (got_output_format_opt
) {
3999 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
4003 got_output_format_opt
= true;
4005 if (strcmp(arg
, "text") == 0) {
4006 implicit_text_args
.exists
= true;
4007 } else if (strcmp(arg
, "ctf") == 0) {
4008 implicit_ctf_output_args
.exists
= true;
4009 } else if (strcmp(arg
, "dummy") == 0) {
4010 implicit_dummy_args
.exists
= true;
4011 } else if (strcmp(arg
, "ctf-metadata") == 0) {
4012 print_ctf_metadata
= true;
4014 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
4021 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
4025 output
= strdup(arg
);
4027 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4032 if (print_run_args_0
) {
4033 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
4037 print_run_args
= true;
4039 case OPT_RUN_ARGS_0
:
4040 if (print_run_args
) {
4041 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
4045 print_run_args_0
= true;
4047 case OPT_STREAM_INTERSECTION
:
4049 * Applies to all traces implementing the
4050 * babeltrace.trace-infos query.
4052 stream_intersection_mode
= true;
4055 *default_log_level
=
4056 logging_level_min(*default_log_level
, BT_LOG_INFO
);
4059 *default_log_level
=
4060 logging_level_min(*default_log_level
, BT_LOG_TRACE
);
4065 case OPT_OMIT_HOME_PLUGIN_PATH
:
4066 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4068 case OPT_PLUGIN_PATH
:
4069 case OPT_RETRY_DURATION
:
4070 /* Ignore in this pass */
4077 set_auto_log_levels(default_log_level
);
4080 * Legacy behaviour: --verbose used to make the `text` output
4081 * format print more information. --verbose is now equivalent to
4082 * the INFO log level, which is why we compare to `BT_LOG_INFO`
4085 if (*default_log_level
== BT_LOG_INFO
) {
4086 append_implicit_component_param(&implicit_text_args
,
4090 /* Print CTF metadata or print LTTng live sessions */
4091 if (print_ctf_metadata
) {
4092 const bt_value
*bt_val_non_opt
;
4094 if (bt_value_array_is_empty(non_opts
)) {
4095 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
4099 if (bt_value_array_get_length(non_opts
) > 1) {
4100 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
4104 status
= bt_config_print_ctf_metadata_create(plugin_paths
, &cfg
);
4105 if (status
!= BT_CONFIG_CLI_ARGS_STATUS_OK
) {
4109 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
4110 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
4111 bt_value_string_get(bt_val_non_opt
));
4115 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
4119 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
4124 * If -o ctf was specified, make sure an output path (--output)
4125 * was also specified. --output does not imply -o ctf because
4126 * it's also used for the default, implicit -o text if -o ctf
4129 if (implicit_ctf_output_args
.exists
) {
4131 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
4136 * At this point we know that -o ctf AND --output were
4137 * specified. Make sure that no options were specified
4138 * which would imply -o text because --output would be
4139 * ambiguous in this case. For example, this is wrong:
4141 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
4143 * because --names=all implies -o text, and --output
4144 * could apply to both the sink.text.pretty and
4145 * sink.ctf.fs implicit components.
4147 if (implicit_text_args
.exists
) {
4148 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
4154 * If -o dummy and -o ctf were not specified, and if there are
4155 * no explicit sink components, then use an implicit
4156 * `sink.text.pretty` component.
4158 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
4160 implicit_text_args
.exists
= true;
4164 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4165 * `path` parameter if --output was specified.
4168 if (implicit_text_args
.exists
) {
4169 append_implicit_component_extra_param(&implicit_text_args
,
4171 } else if (implicit_ctf_output_args
.exists
) {
4172 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4177 /* Decide where the non-option argument(s) go */
4178 if (bt_value_array_get_length(non_opts
) > 0) {
4179 if (implicit_lttng_live_args
.exists
) {
4180 const bt_value
*bt_val_non_opt
;
4182 if (bt_value_array_get_length(non_opts
) > 1) {
4183 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
4187 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
4188 lttng_live_url_parts
=
4189 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt
),
4190 error_buf
, sizeof(error_buf
));
4191 if (!lttng_live_url_parts
.proto
) {
4192 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
4197 if (!lttng_live_url_parts
.session_name
) {
4198 /* Print LTTng live sessions */
4199 status
= bt_config_print_lttng_live_sessions_create(
4200 plugin_paths
, &cfg
);
4201 if (status
!= BT_CONFIG_CLI_ARGS_STATUS_OK
) {
4205 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4206 bt_value_string_get(bt_val_non_opt
));
4210 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4214 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
4218 live_inputs_array_val
= bt_value_array_create();
4219 if (!live_inputs_array_val
) {
4220 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4224 if (bt_value_array_append_string_element(
4225 live_inputs_array_val
,
4226 bt_value_string_get(bt_val_non_opt
))) {
4227 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4231 ret
= append_parameter_to_args(
4232 implicit_lttng_live_args
.extra_params
,
4233 "inputs", live_inputs_array_val
);
4238 ret
= append_implicit_component_extra_param(
4239 &implicit_lttng_live_args
,
4240 "session-not-found-action", "end");
4245 size_t plugin_count
;
4246 const bt_plugin
**plugins
;
4247 const bt_plugin
*plugin
;
4248 auto_source_discovery_status auto_disc_status
;
4250 ret
= require_loaded_plugins(plugin_paths
);
4255 if (auto_source_discovery_restrict_plugin_name
) {
4257 plugin
= borrow_loaded_plugin_by_name(auto_source_discovery_restrict_plugin_name
);
4260 plugin_count
= get_loaded_plugins_count();
4261 plugins
= borrow_loaded_plugins();
4264 auto_disc_status
= auto_discover_source_components(
4265 non_opts
, plugins
, plugin_count
,
4266 auto_source_discovery_restrict_component_class_name
,
4267 *default_log_level
, &auto_disc
, interrupter
);
4269 if (auto_disc_status
!= AUTO_SOURCE_DISCOVERY_STATUS_OK
) {
4270 if (auto_disc_status
== AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED
) {
4271 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
4272 "Babeltrace CLI", "Automatic source discovery interrupted by the user");
4277 ret
= create_implicit_component_args_from_auto_discovered_sources(
4278 &auto_disc
, non_opts
, non_opt_params
, non_opt_loglevels
,
4279 discovered_source_args
);
4288 * If --clock-force-correlated was given, apply it to any src.ctf.fs
4291 if (ctf_fs_source_force_clock_class_unix_epoch_origin
) {
4294 n
= append_multiple_implicit_components_param(
4295 discovered_source_args
, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
4298 BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
4303 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4304 if (ctf_fs_source_clock_class_offset_arg
) {
4307 n
= append_multiple_implicit_components_param(
4308 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4309 ctf_fs_source_clock_class_offset_arg
);
4312 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4317 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4318 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4321 n
= append_multiple_implicit_components_param(
4322 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4323 ctf_fs_source_clock_class_offset_ns_arg
);
4326 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4332 * If the implicit `source.ctf.lttng-live` component exists,
4333 * make sure there's at least one non-option argument (which is
4336 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(non_opts
)) {
4337 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4338 implicit_lttng_live_args
.comp_arg
->str
);
4342 /* Assign names to implicit components */
4343 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4344 struct implicit_component_args
*args
;
4347 args
= discovered_source_args
->pdata
[i
];
4349 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4351 /* Give it a name like `auto-disc-src-ctf-fs`. */
4352 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4353 if (auto_disc_comp_name
->str
[j
] == '.') {
4354 auto_disc_comp_name
->str
[j
] = '-';
4358 ret
= assign_name_to_implicit_component(args
,
4359 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4365 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4366 "lttng-live", all_names
, &source_names
, true);
4371 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4372 "pretty", all_names
, &sink_names
, true);
4377 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4378 "sink-ctf-fs", all_names
, &sink_names
, true);
4383 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4384 "dummy", all_names
, &sink_names
, true);
4389 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4390 "muxer", all_names
, NULL
, false);
4395 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4396 "trimmer", all_names
, NULL
, false);
4401 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4402 "debug-info", all_names
, NULL
, false);
4407 /* Make sure there's at least one source and one sink */
4408 if (!source_names
) {
4409 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4414 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4418 /* Make sure there's a single sink component */
4419 if (g_list_length(sink_names
) != 1) {
4420 BT_CLI_LOGE_APPEND_CAUSE(
4421 "More than one sink component specified.");
4426 * Prepend the muxer, the trimmer, and the debug info to the
4427 * filter chain so that we have:
4429 * sources -> muxer -> [trimmer] -> [debug info] ->
4430 * [user filters] -> sinks
4432 if (implicit_debug_info_args
.exists
) {
4433 if (g_list_prepend_gstring(&filter_names
,
4434 implicit_debug_info_args
.name_arg
->str
)) {
4439 if (implicit_trimmer_args
.exists
) {
4440 if (g_list_prepend_gstring(&filter_names
,
4441 implicit_trimmer_args
.name_arg
->str
)) {
4446 if (g_list_prepend_gstring(&filter_names
,
4447 implicit_muxer_args
.name_arg
->str
)) {
4452 * Append the equivalent run arguments for the implicit
4455 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4456 struct implicit_component_args
*args
=
4457 discovered_source_args
->pdata
[i
];
4459 ret
= append_run_args_for_implicit_component(args
, run_args
);
4465 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4471 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4477 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4483 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4489 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4495 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4501 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4507 /* Auto-connect components */
4508 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4511 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4516 * We have all the run command arguments now. Depending on
4517 * --run-args, we pass this to the run command or print them
4520 if (print_run_args
|| print_run_args_0
) {
4521 uint64_t args_idx
, args_len
;
4522 if (stream_intersection_mode
) {
4523 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4527 args_len
= bt_value_array_get_length(run_args
);
4528 for (args_idx
= 0; args_idx
< args_len
; args_idx
++) {
4529 const bt_value
*arg_value
=
4530 bt_value_array_borrow_element_by_index(run_args
,
4533 GString
*quoted
= NULL
;
4534 const char *arg_to_print
;
4536 arg
= bt_value_string_get(arg_value
);
4538 if (print_run_args
) {
4539 quoted
= bt_common_shell_quote(arg
, true);
4544 arg_to_print
= quoted
->str
;
4549 printf("%s", arg_to_print
);
4552 g_string_free(quoted
, TRUE
);
4555 if (args_idx
< args_len
- 1) {
4556 if (print_run_args
) {
4564 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
4568 status
= bt_config_run_from_args_array(run_args
, &cfg
,
4569 plugin_paths
, *default_log_level
);
4570 if (status
!= BT_CONFIG_CLI_ARGS_STATUS_OK
) {
4574 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4575 BT_OBJECT_MOVE_REF(*cfg_out
, cfg
);
4579 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
4582 argpar_iter_destroy(argpar_iter
);
4583 argpar_item_destroy(argpar_item
);
4587 if (component_arg_for_run
) {
4588 g_string_free(component_arg_for_run
, TRUE
);
4592 g_string_free(name_gstr
, TRUE
);
4595 bt_value_put_ref(live_inputs_array_val
);
4596 bt_value_put_ref(run_args
);
4597 bt_value_put_ref(all_names
);
4598 destroy_glist_of_gstring(source_names
);
4599 destroy_glist_of_gstring(filter_names
);
4600 destroy_glist_of_gstring(sink_names
);
4601 bt_value_put_ref(non_opt_params
);
4602 bt_value_put_ref(non_opt_loglevels
);
4603 bt_value_put_ref(non_opts
);
4604 finalize_implicit_component_args(&implicit_ctf_output_args
);
4605 finalize_implicit_component_args(&implicit_lttng_live_args
);
4606 finalize_implicit_component_args(&implicit_dummy_args
);
4607 finalize_implicit_component_args(&implicit_text_args
);
4608 finalize_implicit_component_args(&implicit_debug_info_args
);
4609 finalize_implicit_component_args(&implicit_muxer_args
);
4610 finalize_implicit_component_args(&implicit_trimmer_args
);
4611 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4612 auto_source_discovery_fini(&auto_disc
);
4614 if (discovered_source_args
) {
4615 g_ptr_array_free(discovered_source_args
, TRUE
);
4618 g_free(ctf_fs_source_clock_class_offset_arg
);
4619 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4621 if (auto_disc_comp_name
) {
4622 g_string_free(auto_disc_comp_name
, TRUE
);
4625 bt_object_put_ref(cfg
);
4631 * Prints the Babeltrace 2.x general usage.
4634 void print_gen_usage(FILE *fp
)
4636 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4638 fprintf(fp
, "General options:\n");
4640 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=T)\n");
4641 fprintf(fp
, " -h, --help Show this help and quit\n");
4642 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `T`, `D`,\n");
4643 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4644 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
4645 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
4646 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
4647 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
4648 fprintf(fp
, " dynamic plugins can be loaded\n");
4649 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4650 fprintf(fp
, " -V, --version Show version and quit\n");
4652 fprintf(fp
, "Available commands:\n");
4654 fprintf(fp
, " convert Convert and trim traces (default)\n");
4655 fprintf(fp
, " help Get help for a plugin or a component class\n");
4656 fprintf(fp
, " list-plugins List available plugins and their content\n");
4657 fprintf(fp
, " query Query objects from a component class\n");
4658 fprintf(fp
, " run Build a processing graph and run it\n");
4660 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4663 enum bt_config_cli_args_status
bt_config_cli_args_create(int argc
,
4664 const char *argv
[], struct bt_config
**cfg
,
4665 bool omit_system_plugin_path
,
4666 bool omit_home_plugin_path
,
4667 const bt_value
*initial_plugin_paths
,
4668 const bt_interrupter
*interrupter
)
4670 enum bt_config_cli_args_status status
;
4672 const char **top_level_argv
;
4673 int command_argc
= -1;
4674 const char **command_argv
= NULL
;
4675 const char *command_name
= NULL
;
4676 int default_log_level
= -1;
4677 struct argpar_iter
*argpar_iter
= NULL
;
4678 const struct argpar_item
*argpar_item
= NULL
;
4679 const struct argpar_error
*argpar_error
= NULL
;
4680 bt_value
*plugin_paths
= NULL
;
4681 unsigned int consumed_args
;
4683 /* Top-level option descriptions. */
4684 static const struct argpar_opt_descr descrs
[] = {
4685 { OPT_DEBUG
, 'd', "debug", false },
4686 { OPT_HELP
, 'h', "help", false },
4687 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4688 { OPT_VERBOSE
, 'v', "verbose", false },
4689 { OPT_VERSION
, 'V', "version", false},
4690 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
4691 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
4692 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
4693 ARGPAR_OPT_DESCR_SENTINEL
4697 COMMAND_TYPE_NONE
= -1,
4698 COMMAND_TYPE_RUN
= 0,
4699 COMMAND_TYPE_CONVERT
,
4700 COMMAND_TYPE_LIST_PLUGINS
,
4703 } command_type
= COMMAND_TYPE_NONE
;
4705 if (!initial_plugin_paths
) {
4706 plugin_paths
= bt_value_array_create();
4707 if (!plugin_paths
) {
4711 bt_value_copy_status copy_status
= bt_value_copy(
4712 initial_plugin_paths
, &plugin_paths
);
4718 BT_ASSERT(plugin_paths
);
4721 * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
4722 * `--plugin-path` option's paths, so append it now before
4723 * parsing the general options.
4725 if (append_env_var_plugin_paths(plugin_paths
)) {
4732 print_gen_usage(stdout
);
4733 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
4737 /* Skip first argument, the name of the program. */
4738 top_level_argc
= argc
- 1;
4739 top_level_argv
= argv
+ 1;
4741 argpar_iter
= argpar_iter_create(top_level_argc
, top_level_argv
, descrs
);
4743 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4748 enum argpar_iter_next_status argpar_status
;
4750 ARGPAR_ITEM_DESTROY_AND_RESET(argpar_item
);
4751 argpar_status
= argpar_iter_next(argpar_iter
, &argpar_item
, &argpar_error
);
4753 switch (argpar_status
) {
4754 case ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY
:
4755 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4757 case ARGPAR_ITER_NEXT_STATUS_ERROR
:
4759 if (argpar_error_type(argpar_error
)
4760 != ARGPAR_ERROR_TYPE_UNKNOWN_OPT
) {
4761 GString
*err_str
= format_arg_error(argpar_error
, top_level_argv
,
4762 0, "While parsing command-line arguments");
4763 BT_CLI_LOGE_APPEND_CAUSE("%s", err_str
->str
);
4764 g_string_free(err_str
, TRUE
);
4774 if (argpar_status
== ARGPAR_ITER_NEXT_STATUS_END
) {
4778 if (argpar_status
== ARGPAR_ITER_NEXT_STATUS_ERROR
) {
4779 BT_ASSERT(argpar_error_type(argpar_error
) ==
4780 ARGPAR_ERROR_TYPE_UNKNOWN_OPT
);
4782 * Unknown option, assume this is implicitly the
4783 * convert command, stop processing arguments.
4788 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
4789 const struct argpar_opt_descr
*opt_descr
=
4790 argpar_item_opt_descr(argpar_item
);
4791 const char *arg
= argpar_item_opt_arg(argpar_item
);
4793 switch (opt_descr
->id
) {
4796 logging_level_min(default_log_level
, BT_LOG_TRACE
);
4800 logging_level_min(default_log_level
, BT_LOG_INFO
);
4804 int level
= bt_log_get_level_from_string(arg
);
4807 BT_CLI_LOGE_APPEND_CAUSE(
4808 "Invalid argument for --log-level option:\n %s",
4814 logging_level_min(default_log_level
, level
);
4817 case OPT_PLUGIN_PATH
:
4818 if (bt_config_append_plugin_paths_check_setuid_setgid(
4819 plugin_paths
, arg
)) {
4823 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4824 omit_system_plugin_path
= true;
4826 case OPT_OMIT_HOME_PLUGIN_PATH
:
4827 omit_home_plugin_path
= true;
4831 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
4834 print_gen_usage(stdout
);
4835 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
4841 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
4842 unsigned int orig_index
= argpar_item_non_opt_orig_index(argpar_item
);
4845 * First unknown argument: is it a known command
4848 command_argc
= top_level_argc
- orig_index
- 1;
4849 command_argv
= &top_level_argv
[orig_index
+ 1];
4851 if (strcmp(arg
, "convert") == 0) {
4852 command_type
= COMMAND_TYPE_CONVERT
;
4853 command_name
= "convert";
4854 } else if (strcmp(arg
, "list-plugins") == 0) {
4855 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4856 command_name
= "list-plugins";
4857 } else if (strcmp(arg
, "help") == 0) {
4858 command_type
= COMMAND_TYPE_HELP
;
4859 command_name
= "help";
4860 } else if (strcmp(arg
, "query") == 0) {
4861 command_type
= COMMAND_TYPE_QUERY
;
4862 command_name
= "query";
4863 } else if (strcmp(arg
, "run") == 0) {
4864 command_type
= COMMAND_TYPE_RUN
;
4865 command_name
= "run";
4868 * Non-option argument, but not a known
4869 * command name: assume the default
4870 * `convert` command.
4872 command_type
= COMMAND_TYPE_CONVERT
;
4873 command_name
= "convert";
4878 /* Stop processing arguments. */
4883 if (command_type
== COMMAND_TYPE_NONE
) {
4884 unsigned int ingested_orig_args
= argpar_iter_ingested_orig_args(argpar_iter
);
4886 if (ingested_orig_args
== top_level_argc
) {
4888 * We only got non-help, non-version general options
4889 * like --verbose and --debug, without any other
4890 * arguments, so we can't do anything useful: print the
4893 print_gen_usage(stdout
);
4894 status
= BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
;
4899 * We stopped on an unknown option argument (and therefore
4900 * didn't see a command name). Assume `convert` command.
4902 command_type
= COMMAND_TYPE_CONVERT
;
4903 command_name
= "convert";
4904 command_argc
= top_level_argc
- ingested_orig_args
;
4905 command_argv
= &top_level_argv
[ingested_orig_args
];
4908 BT_ASSERT(command_argv
);
4909 BT_ASSERT(command_argc
>= 0);
4912 * For all commands other than `convert`, we now know the log level to
4913 * use, so we can apply it with `set_auto_log_levels`.
4915 * The convert command has `--debug` and `--verbose` arguments that are
4916 * equivalent to the top-level arguments of the same name. So after it
4917 * has parsed its arguments, `bt_config_convert_from_args` calls
4918 * `set_auto_log_levels` itself.
4920 if (command_type
!= COMMAND_TYPE_CONVERT
) {
4921 set_auto_log_levels(&default_log_level
);
4925 * At this point, `plugin_paths` contains the initial plugin
4926 * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
4927 * the paths from the `--plugin-path` option.
4929 * Now append the user and system plugin paths.
4931 if (append_home_and_system_plugin_paths(plugin_paths
,
4932 omit_system_plugin_path
, omit_home_plugin_path
)) {
4936 consumed_args
= argpar_iter_ingested_orig_args(argpar_iter
);
4938 switch (command_type
) {
4939 case COMMAND_TYPE_RUN
:
4940 status
= bt_config_run_from_args(command_argc
, command_argv
,
4942 default_log_level
, consumed_args
);
4944 case COMMAND_TYPE_CONVERT
:
4945 status
= bt_config_convert_from_args(command_argc
, command_argv
,
4946 cfg
, plugin_paths
, &default_log_level
, interrupter
,
4949 case COMMAND_TYPE_LIST_PLUGINS
:
4950 status
= bt_config_list_plugins_from_args(command_argc
,
4951 command_argv
, cfg
, plugin_paths
, consumed_args
);
4953 case COMMAND_TYPE_HELP
:
4954 status
= bt_config_help_from_args(command_argc
,
4955 command_argv
, cfg
, plugin_paths
,
4956 default_log_level
, consumed_args
);
4958 case COMMAND_TYPE_QUERY
:
4959 status
= bt_config_query_from_args(command_argc
,
4960 command_argv
, cfg
, plugin_paths
,
4961 default_log_level
, consumed_args
);
4967 if (status
== BT_CONFIG_CLI_ARGS_STATUS_ERROR
) {
4969 } else if (status
== BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
) {
4973 BT_ASSERT(status
== BT_CONFIG_CLI_ARGS_STATUS_OK
);
4975 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4976 (*cfg
)->log_level
= default_log_level
;
4977 (*cfg
)->command_name
= command_name
;
4979 status
= BT_CONFIG_CLI_ARGS_STATUS_OK
;
4983 status
= BT_CONFIG_CLI_ARGS_STATUS_ERROR
;
4986 argpar_error_destroy(argpar_error
);
4987 argpar_item_destroy(argpar_item
);
4988 argpar_iter_destroy(argpar_iter
);
4989 bt_value_put_ref(plugin_paths
);