2 * Babeltrace trace converter - parameter parsing
4 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "CLI/CFG-CLI-ARGS"
31 #include "common/assert.h"
35 #include <babeltrace2/babeltrace.h>
36 #include "common/common.h"
38 #include <sys/types.h>
39 #include "argpar/argpar.h"
40 #include "babeltrace2-cfg.h"
41 #include "babeltrace2-cfg-cli-args.h"
42 #include "babeltrace2-cfg-cli-args-connect.h"
43 #include "param-parse/param-parse.h"
44 #include "babeltrace2-log-level.h"
45 #include "babeltrace2-plugins.h"
46 #include "babeltrace2-query.h"
47 #include "autodisc/autodisc.h"
48 #include "common/version.h"
50 #define BT_CLI_LOGE_APPEND_CAUSE_OOM() BT_CLI_LOGE_APPEND_CAUSE("Out of memory.")
53 * Returns the plugin name, component class name, component class type,
54 * and component name from a command-line --component option's argument.
55 * arg must have the following format:
57 * [NAME:]TYPE.PLUGIN.CLS
59 * where NAME is the optional component name, TYPE is either `source`,
60 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
61 * component class name.
63 * On success, both *plugin and *component are not NULL. *plugin
64 * and *comp_cls are owned by the caller. On success, *name can be NULL
65 * if no component class name was found, and *comp_cls_type is set.
68 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
69 char **comp_cls
, bt_component_class_type
*comp_cls_type
)
72 GString
*gs_name
= NULL
;
73 GString
*gs_comp_cls_type
= NULL
;
74 GString
*gs_plugin
= NULL
;
75 GString
*gs_comp_cls
= NULL
;
81 BT_ASSERT(comp_cls_type
);
83 if (!bt_common_string_is_printable(arg
)) {
84 BT_CLI_LOGE_APPEND_CAUSE("Argument contains a non-printable character.");
88 /* Parse the component name */
89 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
94 if (arg
[end_pos
] == ':') {
98 g_string_assign(gs_name
, "");
101 /* Parse the component class type */
102 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
103 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
104 BT_CLI_LOGE_APPEND_CAUSE("Missing component class type (`source`, `filter`, or `sink`).");
108 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
109 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
110 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
111 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
112 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
113 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
114 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
115 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
117 BT_CLI_LOGE_APPEND_CAUSE("Unknown component class type: `%s`.",
118 gs_comp_cls_type
->str
);
124 /* Parse the plugin name */
125 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
126 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
127 BT_CLI_LOGE_APPEND_CAUSE("Missing plugin or component class name.");
133 /* Parse the component class name */
134 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
135 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
136 BT_CLI_LOGE_APPEND_CAUSE("Missing component class name.");
140 if (at
[end_pos
] != '\0') {
141 /* Found a non-escaped `.` */
146 if (gs_name
->len
== 0) {
148 g_string_free(gs_name
, TRUE
);
150 *name
= g_string_free(gs_name
, FALSE
);
153 g_string_free(gs_name
, TRUE
);
156 *plugin
= g_string_free(gs_plugin
, FALSE
);
157 *comp_cls
= g_string_free(gs_comp_cls
, FALSE
);
173 g_string_free(gs_name
, TRUE
);
177 g_string_free(gs_plugin
, TRUE
);
181 g_string_free(gs_comp_cls
, TRUE
);
184 if (gs_comp_cls_type
) {
185 g_string_free(gs_comp_cls_type
, TRUE
);
192 void print_and_indent(const char *str
)
194 const char *ch
= &str
[0];
196 for (; *ch
!= '\0'; ch
++) {
210 * Prints the Babeltrace version.
213 void print_version(void)
215 bool has_extra_name
= strlen(BT_VERSION_EXTRA_NAME
) > 0;
216 bool has_extra_description
= strlen(BT_VERSION_EXTRA_DESCRIPTION
) > 0;
217 bool has_extra_patch_names
= strlen(BT_VERSION_EXTRA_PATCHES
) > 0;
218 bool has_extra
= has_extra_name
|| has_extra_description
||
219 has_extra_patch_names
;
221 printf("%sBabeltrace %s%s",
222 bt_common_color_bold(),
224 bt_common_color_reset());
226 if (strlen(BT_VERSION_NAME
) > 0) {
227 printf(" \"%s%s%s%s\"",
228 bt_common_color_fg_bright_blue(),
229 bt_common_color_bold(),
231 bt_common_color_reset());
234 if (strlen(BT_VERSION_GIT
) > 0) {
236 bt_common_color_fg_yellow(),
238 bt_common_color_reset());
243 if (strlen(BT_VERSION_DESCRIPTION
) > 0) {
244 unsigned int columns
;
247 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
248 /* Width not found: default to 80 */
252 descr
= bt_common_fold(BT_VERSION_DESCRIPTION
, columns
, 0);
254 printf("\n%s\n", descr
->str
);
255 g_string_free(descr
, TRUE
);
261 if (has_extra_name
) {
262 printf("%sExtra name%s: %s\n",
263 bt_common_color_fg_cyan(),
264 bt_common_color_reset(),
265 BT_VERSION_EXTRA_NAME
);
268 if (has_extra_description
) {
269 printf("%sExtra description%s:\n ",
270 bt_common_color_fg_cyan(),
271 bt_common_color_reset());
272 print_and_indent(BT_VERSION_EXTRA_DESCRIPTION
);
275 if (has_extra_patch_names
) {
276 printf("%sExtra patch names%s:\n ",
277 bt_common_color_fg_cyan(),
278 bt_common_color_reset());
279 print_and_indent(BT_VERSION_EXTRA_PATCHES
);
285 * Destroys a component configuration.
288 void bt_config_component_destroy(bt_object
*obj
)
290 struct bt_config_component
*bt_config_component
=
291 container_of(obj
, struct bt_config_component
, base
);
297 if (bt_config_component
->plugin_name
) {
298 g_string_free(bt_config_component
->plugin_name
, TRUE
);
301 if (bt_config_component
->comp_cls_name
) {
302 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
305 if (bt_config_component
->instance_name
) {
306 g_string_free(bt_config_component
->instance_name
, TRUE
);
309 BT_VALUE_PUT_REF_AND_RESET(bt_config_component
->params
);
310 g_free(bt_config_component
);
317 * Creates a component configuration using the given plugin name and
318 * component name. `plugin_name` and `comp_cls_name` are copied (belong
319 * to the return value).
321 * Return value is owned by the caller.
324 struct bt_config_component
*bt_config_component_create(
325 bt_component_class_type type
,
326 const char *plugin_name
, const char *comp_cls_name
,
329 struct bt_config_component
*cfg_component
= NULL
;
331 cfg_component
= g_new0(struct bt_config_component
, 1);
332 if (!cfg_component
) {
333 BT_CLI_LOGE_APPEND_CAUSE_OOM();
337 bt_object_init_shared(&cfg_component
->base
,
338 bt_config_component_destroy
);
339 cfg_component
->type
= type
;
340 cfg_component
->plugin_name
= g_string_new(plugin_name
);
341 if (!cfg_component
->plugin_name
) {
342 BT_CLI_LOGE_APPEND_CAUSE_OOM();
346 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
347 if (!cfg_component
->comp_cls_name
) {
348 BT_CLI_LOGE_APPEND_CAUSE_OOM();
352 cfg_component
->instance_name
= g_string_new(NULL
);
353 if (!cfg_component
->instance_name
) {
354 BT_CLI_LOGE_APPEND_CAUSE_OOM();
358 cfg_component
->log_level
= init_log_level
;
360 /* Start with empty parameters */
361 cfg_component
->params
= bt_value_map_create();
362 if (!cfg_component
->params
) {
363 BT_CLI_LOGE_APPEND_CAUSE_OOM();
370 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
373 return cfg_component
;
377 * Creates a component configuration from a command-line --component
381 struct bt_config_component
*bt_config_component_from_arg(const char *arg
,
384 struct bt_config_component
*cfg_comp
= NULL
;
386 char *plugin_name
= NULL
;
387 char *comp_cls_name
= NULL
;
388 bt_component_class_type type
;
390 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
391 if (!plugin_name
|| !comp_cls_name
) {
395 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
,
402 g_string_assign(cfg_comp
->instance_name
, name
);
408 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp
);
413 g_free(comp_cls_name
);
418 * Destroys a configuration.
421 void bt_config_destroy(bt_object
*obj
)
423 struct bt_config
*cfg
=
424 container_of(obj
, struct bt_config
, base
);
430 BT_VALUE_PUT_REF_AND_RESET(cfg
->plugin_paths
);
432 switch (cfg
->command
) {
433 case BT_CONFIG_COMMAND_RUN
:
434 if (cfg
->cmd_data
.run
.sources
) {
435 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
438 if (cfg
->cmd_data
.run
.filters
) {
439 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
442 if (cfg
->cmd_data
.run
.sinks
) {
443 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
446 if (cfg
->cmd_data
.run
.connections
) {
447 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
451 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
453 case BT_CONFIG_COMMAND_HELP
:
454 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.help
.cfg_component
);
456 case BT_CONFIG_COMMAND_QUERY
:
457 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.query
.cfg_component
);
459 if (cfg
->cmd_data
.query
.object
) {
460 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
463 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
464 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
465 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
468 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
472 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
473 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
475 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
478 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
493 void destroy_glist_of_gstring(GList
*list
)
501 for (at
= list
; at
; at
= g_list_next(at
)) {
502 g_string_free(at
->data
, TRUE
);
509 * Creates a simple lexical scanner for parsing comma-delimited names
512 * Return value is owned by the caller.
515 GScanner
*create_csv_identifiers_scanner(void)
518 GScannerConfig scanner_config
= {
519 .cset_skip_characters
= (gchar
*) " \t\n",
520 .cset_identifier_first
= (gchar
*) G_CSET_a_2_z G_CSET_A_2_Z
"_",
521 .cset_identifier_nth
= (gchar
*) G_CSET_a_2_z G_CSET_A_2_Z
":_-",
522 .case_sensitive
= TRUE
,
523 .cpair_comment_single
= NULL
,
524 .skip_comment_multi
= TRUE
,
525 .skip_comment_single
= TRUE
,
526 .scan_comment_multi
= FALSE
,
527 .scan_identifier
= TRUE
,
528 .scan_identifier_1char
= TRUE
,
529 .scan_identifier_NULL
= FALSE
,
530 .scan_symbols
= FALSE
,
531 .symbol_2_token
= FALSE
,
532 .scope_0_fallback
= FALSE
,
533 .scan_binary
= FALSE
,
537 .scan_hex_dollar
= FALSE
,
538 .numbers_2_int
= FALSE
,
539 .int_2_float
= FALSE
,
540 .store_int64
= FALSE
,
541 .scan_string_sq
= FALSE
,
542 .scan_string_dq
= FALSE
,
543 .identifier_2_string
= FALSE
,
544 .char_2_token
= TRUE
,
547 scanner
= g_scanner_new(&scanner_config
);
549 BT_CLI_LOGE_APPEND_CAUSE_OOM();
556 * Converts a comma-delimited list of known names (--names option) to
557 * an array value object containing those names as string value objects.
559 * Return value is owned by the caller.
562 bt_value
*names_from_arg(const char *arg
)
564 GScanner
*scanner
= NULL
;
565 bt_value
*names
= NULL
;
566 bool found_all
= false, found_none
= false, found_item
= false;
568 names
= bt_value_array_create();
570 BT_CLI_LOGE_APPEND_CAUSE_OOM();
574 scanner
= create_csv_identifiers_scanner();
579 g_scanner_input_text(scanner
, arg
, strlen(arg
));
582 GTokenType token_type
= g_scanner_get_next_token(scanner
);
584 switch (token_type
) {
585 case G_TOKEN_IDENTIFIER
:
587 const char *identifier
= scanner
->value
.v_identifier
;
589 if (strcmp(identifier
, "payload") == 0 ||
590 strcmp(identifier
, "args") == 0 ||
591 strcmp(identifier
, "arg") == 0) {
593 if (bt_value_array_append_string_element(names
,
597 } else if (strcmp(identifier
, "context") == 0 ||
598 strcmp(identifier
, "ctx") == 0) {
600 if (bt_value_array_append_string_element(names
,
604 } else if (strcmp(identifier
, "scope") == 0 ||
605 strcmp(identifier
, "header") == 0) {
607 if (bt_value_array_append_string_element(names
,
611 } else if (strcmp(identifier
, "all") == 0) {
613 if (bt_value_array_append_string_element(names
,
617 } else if (strcmp(identifier
, "none") == 0) {
619 if (bt_value_array_append_string_element(names
,
624 BT_CLI_LOGE_APPEND_CAUSE("Unknown name: `%s`.",
640 if (found_none
&& found_all
) {
641 BT_CLI_LOGE_APPEND_CAUSE("Only either `all` or `none` can be specified in the list given to the --names option, but not both.");
645 * Legacy behavior is to clear the defaults (show none) when at
646 * least one item is specified.
648 if (found_item
&& !found_none
&& !found_all
) {
649 if (bt_value_array_append_string_element(names
, "none")) {
654 g_scanner_destroy(scanner
);
659 BT_VALUE_PUT_REF_AND_RESET(names
);
661 g_scanner_destroy(scanner
);
667 * Converts a comma-delimited list of known fields (--fields option) to
668 * an array value object containing those fields as string
671 * Return value is owned by the caller.
674 bt_value
*fields_from_arg(const char *arg
)
676 GScanner
*scanner
= NULL
;
679 fields
= bt_value_array_create();
681 BT_CLI_LOGE_APPEND_CAUSE_OOM();
685 scanner
= create_csv_identifiers_scanner();
690 g_scanner_input_text(scanner
, arg
, strlen(arg
));
693 GTokenType token_type
= g_scanner_get_next_token(scanner
);
695 switch (token_type
) {
696 case G_TOKEN_IDENTIFIER
:
698 const char *identifier
= scanner
->value
.v_identifier
;
700 if (strcmp(identifier
, "trace") == 0 ||
701 strcmp(identifier
, "trace:hostname") == 0 ||
702 strcmp(identifier
, "trace:domain") == 0 ||
703 strcmp(identifier
, "trace:procname") == 0 ||
704 strcmp(identifier
, "trace:vpid") == 0 ||
705 strcmp(identifier
, "loglevel") == 0 ||
706 strcmp(identifier
, "emf") == 0 ||
707 strcmp(identifier
, "callsite") == 0 ||
708 strcmp(identifier
, "all") == 0) {
709 if (bt_value_array_append_string_element(fields
,
714 BT_CLI_LOGE_APPEND_CAUSE("Unknown field: `%s`.",
732 BT_VALUE_PUT_REF_AND_RESET(fields
);
736 g_scanner_destroy(scanner
);
742 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
744 BT_ASSERT(params_arg
);
748 if (params_arg
->len
!= 0) {
749 g_string_append_c(params_arg
, ',');
752 g_string_append(params_arg
, key
);
753 g_string_append_c(params_arg
, '=');
754 g_string_append(params_arg
, value
);
758 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
759 * where the names are in names_array.
762 int insert_flat_params_from_array(GString
*params_arg
,
763 const bt_value
*names_array
, const char *prefix
)
767 GString
*tmpstr
= NULL
, *default_value
= NULL
;
768 bool default_set
= false, non_default_set
= false;
771 * names_array may be NULL if no CLI options were specified to
772 * trigger its creation.
778 tmpstr
= g_string_new(NULL
);
780 BT_CLI_LOGE_APPEND_CAUSE_OOM();
785 default_value
= g_string_new(NULL
);
786 if (!default_value
) {
787 BT_CLI_LOGE_APPEND_CAUSE_OOM();
792 for (i
= 0; i
< bt_value_array_get_length(names_array
); i
++) {
793 const bt_value
*str_obj
=
794 bt_value_array_borrow_element_by_index_const(names_array
,
797 bool is_default
= false;
799 suffix
= bt_value_string_get(str_obj
);
801 g_string_assign(tmpstr
, prefix
);
802 g_string_append(tmpstr
, "-");
804 /* Special-case for "all" and "none". */
805 if (strcmp(suffix
, "all") == 0) {
807 g_string_assign(default_value
, "show");
808 } else if (strcmp(suffix
, "none") == 0) {
810 g_string_assign(default_value
, "hide");
814 g_string_append(tmpstr
, "default");
815 append_param_arg(params_arg
, tmpstr
->str
,
818 non_default_set
= true;
819 g_string_append(tmpstr
, suffix
);
820 append_param_arg(params_arg
, tmpstr
->str
, "yes");
824 /* Implicit field-default=hide if any non-default option is set. */
825 if (non_default_set
&& !default_set
) {
826 g_string_assign(tmpstr
, prefix
);
827 g_string_append(tmpstr
, "-default");
828 g_string_assign(default_value
, "hide");
829 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
834 g_string_free(default_value
, TRUE
);
838 g_string_free(tmpstr
, TRUE
);
851 OPT_CLOCK_FORCE_CORRELATE
,
862 OPT_DEBUG_INFO_FULL_PATH
,
863 OPT_DEBUG_INFO_TARGET_PREFIX
,
872 OPT_OMIT_HOME_PLUGIN_PATH
,
873 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
878 OPT_RESET_BASE_PARAMS
,
882 OPT_STREAM_INTERSECTION
,
888 enum bt_config_component_dest
{
889 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
890 BT_CONFIG_COMPONENT_DEST_SOURCE
,
891 BT_CONFIG_COMPONENT_DEST_FILTER
,
892 BT_CONFIG_COMPONENT_DEST_SINK
,
896 * Adds a configuration component to the appropriate configuration
897 * array depending on the destination.
900 void add_run_cfg_comp(struct bt_config
*cfg
,
901 struct bt_config_component
*cfg_comp
,
902 enum bt_config_component_dest dest
)
904 bt_object_get_ref(cfg_comp
);
907 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
908 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
910 case BT_CONFIG_COMPONENT_DEST_FILTER
:
911 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
913 case BT_CONFIG_COMPONENT_DEST_SINK
:
914 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
922 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
923 struct bt_config_component
*cfg_comp
,
924 enum bt_config_component_dest dest
,
925 bt_value
*instance_names
)
929 if (cfg_comp
->instance_name
->len
== 0) {
930 BT_CLI_LOGE_APPEND_CAUSE("Found an unnamed component.");
935 if (bt_value_map_has_entry(instance_names
,
936 cfg_comp
->instance_name
->str
)) {
937 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
938 cfg_comp
->instance_name
->str
);
943 if (bt_value_map_insert_entry(instance_names
,
944 cfg_comp
->instance_name
->str
, bt_value_null
)) {
945 BT_CLI_LOGE_APPEND_CAUSE_OOM();
950 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
957 int append_env_var_plugin_paths(bt_value
*plugin_paths
)
962 if (bt_common_is_setuid_setgid()) {
963 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
967 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
972 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
976 BT_CLI_LOGE_APPEND_CAUSE("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH.");
983 int append_home_and_system_plugin_paths(bt_value
*plugin_paths
,
984 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
988 if (!omit_home_plugin_path
) {
989 if (bt_common_is_setuid_setgid()) {
990 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
992 char *home_plugin_dir
= bt_common_get_home_plugin_path(
993 BT_LOG_OUTPUT_LEVEL
);
995 if (home_plugin_dir
) {
996 ret
= bt_config_append_plugin_paths(
997 plugin_paths
, home_plugin_dir
);
998 free(home_plugin_dir
);
1001 BT_CLI_LOGE_APPEND_CAUSE("Invalid home plugin path.");
1008 if (!omit_system_plugin_path
) {
1009 if (bt_config_append_plugin_paths(plugin_paths
,
1010 bt_common_get_system_plugin_path())) {
1011 BT_CLI_LOGE_APPEND_CAUSE("Invalid system plugin path.");
1017 BT_CLI_LOGE_APPEND_CAUSE("Cannot append home and system plugin paths.");
1022 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1023 const bt_value
*plugin_paths
, bool needs_plugins
)
1025 struct bt_config
*cfg
;
1028 cfg
= g_new0(struct bt_config
, 1);
1030 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1034 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1035 cfg
->command
= command
;
1036 cfg
->command_needs_plugins
= needs_plugins
;
1039 bt_value
*plugin_paths_copy
;
1041 (void) bt_value_copy(plugin_paths
,
1042 &plugin_paths_copy
);
1043 cfg
->plugin_paths
= plugin_paths_copy
;
1045 cfg
->plugin_paths
= bt_value_array_create();
1046 if (!cfg
->plugin_paths
) {
1047 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1055 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1062 struct bt_config
*bt_config_run_create(const bt_value
*plugin_paths
)
1064 struct bt_config
*cfg
;
1067 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1068 plugin_paths
, true);
1073 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1074 (GDestroyNotify
) bt_object_put_ref
);
1075 if (!cfg
->cmd_data
.run
.sources
) {
1076 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1080 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1081 (GDestroyNotify
) bt_object_put_ref
);
1082 if (!cfg
->cmd_data
.run
.filters
) {
1083 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1087 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1088 (GDestroyNotify
) bt_object_put_ref
);
1089 if (!cfg
->cmd_data
.run
.sinks
) {
1090 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1094 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1095 (GDestroyNotify
) bt_config_connection_destroy
);
1096 if (!cfg
->cmd_data
.run
.connections
) {
1097 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1104 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1111 struct bt_config
*bt_config_list_plugins_create(const bt_value
*plugin_paths
)
1113 return bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1114 plugin_paths
, true);
1118 struct bt_config
*bt_config_help_create(const bt_value
*plugin_paths
,
1119 int default_log_level
)
1121 struct bt_config
*cfg
;
1124 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1125 plugin_paths
, true);
1130 cfg
->cmd_data
.help
.cfg_component
=
1131 bt_config_component_create(-1, NULL
, NULL
, default_log_level
);
1132 if (!cfg
->cmd_data
.help
.cfg_component
) {
1139 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1146 struct bt_config
*bt_config_query_create(const bt_value
*plugin_paths
)
1148 struct bt_config
*cfg
;
1151 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1152 plugin_paths
, true);
1157 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1158 if (!cfg
->cmd_data
.query
.object
) {
1159 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1166 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1173 struct bt_config
*bt_config_print_ctf_metadata_create(
1174 const bt_value
*plugin_paths
)
1176 struct bt_config
*cfg
;
1179 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1180 plugin_paths
, true);
1185 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1186 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1187 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1191 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1192 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1193 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1200 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1207 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1208 const bt_value
*plugin_paths
)
1210 struct bt_config
*cfg
;
1213 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1214 plugin_paths
, true);
1219 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1220 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1221 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1225 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1227 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1228 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1235 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1242 int bt_config_append_plugin_paths_check_setuid_setgid(
1243 bt_value
*plugin_paths
, const char *arg
)
1247 if (bt_common_is_setuid_setgid()) {
1248 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1252 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1253 BT_CLI_LOGE_APPEND_CAUSE("Invalid --plugin-path option's argument:\n %s",
1264 * Prints the expected format for a --params option.
1267 void print_expected_params_format(FILE *fp
)
1269 fprintf(fp
, "Expected format of PARAMS\n");
1270 fprintf(fp
, "-------------------------\n");
1272 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1274 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1275 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1276 fprintf(fp
, "and VALUE can be one of:\n");
1278 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1279 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1280 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1281 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1282 fprintf(fp
, " (`0x` prefix) unsigned (with `+` prefix) or signed 64-bit integer.\n");
1283 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1284 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1285 fprintf(fp
, " the null and boolean value symbols above.\n");
1286 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1287 fprintf(fp
, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
1288 fprintf(fp
, " (as described by the current list) and a closing `]`.\n");
1289 fprintf(fp
, "* Map, formatted as an opening `{`, a comma-separated list of PARAM=VALUE\n");
1290 fprintf(fp
, " assignments and a closing `}`.\n");
1292 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1294 fprintf(fp
, "Example:\n");
1296 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1297 fprintf(fp
, " play=+23, observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1298 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\",\n");
1299 fprintf(fp
, " things=[1, \"2\", 3]\n");
1301 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1302 fprintf(fp
, "babeltrace2 from a shell.\n");
1306 bool help_option_is_specified(
1307 const struct argpar_parse_ret
*argpar_parse_ret
)
1310 bool specified
= false;
1312 for (i
= 0; i
< argpar_parse_ret
->items
->n_items
; i
++) {
1313 struct argpar_item
*argpar_item
=
1314 argpar_parse_ret
->items
->items
[i
];
1315 struct argpar_item_opt
*argpar_item_opt
;
1317 if (argpar_item
->type
!= ARGPAR_ITEM_TYPE_OPT
) {
1321 argpar_item_opt
= (struct argpar_item_opt
*) argpar_item
;
1322 if (argpar_item_opt
->descr
->id
== OPT_HELP
) {
1332 * Prints the help command usage.
1335 void print_help_usage(FILE *fp
)
1337 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1338 fprintf(fp
, " babeltrace2 [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1340 fprintf(fp
, "Options:\n");
1342 fprintf(fp
, " -h, --help Show this help and quit\n");
1344 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1346 fprintf(fp
, "Use `babeltrace2 list-plugins` to show the list of available plugins.\n");
1350 const struct argpar_opt_descr help_options
[] = {
1351 /* id, short_name, long_name, with_arg */
1352 { OPT_HELP
, 'h', "help", false },
1353 ARGPAR_OPT_DESCR_SENTINEL
1357 * Creates a Babeltrace config object from the arguments of a help
1360 * *retcode is set to the appropriate exit code to use.
1363 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
1364 int *retcode
, const bt_value
*plugin_paths
,
1365 int default_log_level
)
1367 struct bt_config
*cfg
= NULL
;
1368 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1369 struct argpar_parse_ret argpar_parse_ret
= { 0 };
1370 struct argpar_item_non_opt
*non_opt
;
1371 GString
*substring
= NULL
;
1375 cfg
= bt_config_help_create(plugin_paths
, default_log_level
);
1381 argpar_parse_ret
= argpar_parse(argc
, argv
, help_options
, true);
1382 if (argpar_parse_ret
.error
) {
1383 BT_CLI_LOGE_APPEND_CAUSE(
1384 "While parsing `help` command's command-line arguments: %s",
1385 argpar_parse_ret
.error
);
1389 if (help_option_is_specified(&argpar_parse_ret
)) {
1390 print_help_usage(stdout
);
1392 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1396 if (argpar_parse_ret
.items
->n_items
== 0) {
1397 BT_CLI_LOGE_APPEND_CAUSE(
1398 "Missing plugin name or component class descriptor.");
1400 } else if (argpar_parse_ret
.items
->n_items
> 1) {
1402 * At this point we know there are least two non-option
1403 * arguments because we don't reach here with `--help`,
1406 non_opt
= (struct argpar_item_non_opt
*) argpar_parse_ret
.items
->items
[1];
1407 BT_CLI_LOGE_APPEND_CAUSE(
1408 "Extraneous command-line argument specified to `help` command: `%s`.",
1413 non_opt
= (struct argpar_item_non_opt
*) argpar_parse_ret
.items
->items
[0];
1415 /* Look for unescaped dots in the argument. */
1416 substring
= bt_common_string_until(non_opt
->arg
, ".\\", ".", &end_pos
);
1418 BT_CLI_LOGE_APPEND_CAUSE("Could not consume argument: arg=%s",
1423 if (end_pos
== strlen(non_opt
->arg
)) {
1424 /* Didn't find an unescaped dot, treat it as a plugin name. */
1425 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1429 * Found an unescaped dot, treat it as a component class name.
1431 plugin_comp_cls_names(non_opt
->arg
, NULL
, &plugin_name
, &comp_cls_name
,
1432 &cfg
->cmd_data
.help
.cfg_component
->type
);
1433 if (!plugin_name
|| !comp_cls_name
) {
1434 BT_CLI_LOGE_APPEND_CAUSE(
1435 "Could not parse argument as a component class name: arg=%s",
1440 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1442 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1450 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1453 g_free(plugin_name
);
1454 g_free(comp_cls_name
);
1457 g_string_free(substring
, TRUE
);
1460 argpar_parse_ret_fini(&argpar_parse_ret
);
1466 * Prints the help command usage.
1469 void print_query_usage(FILE *fp
)
1471 fprintf(fp
, "Usage: babeltrace2 [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1473 fprintf(fp
, "Options:\n");
1475 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS (see the expected\n");
1476 fprintf(fp
, " format of PARAMS below)\n");
1477 fprintf(fp
, " -h, --help Show this help and quit\n");
1478 fprintf(fp
, "\n\n");
1479 print_expected_params_format(fp
);
1483 const struct argpar_opt_descr query_options
[] = {
1484 /* id, short_name, long_name, with_arg */
1485 { OPT_HELP
, 'h', "help", false },
1486 { OPT_PARAMS
, 'p', "params", true },
1487 ARGPAR_OPT_DESCR_SENTINEL
1491 * Creates a Babeltrace config object from the arguments of a query
1494 * *retcode is set to the appropriate exit code to use.
1497 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1498 int *retcode
, const bt_value
*plugin_paths
,
1499 int default_log_level
)
1502 struct bt_config
*cfg
= NULL
;
1503 const char *component_class_spec
= NULL
;
1504 const char *query_object
= NULL
;
1505 GString
*error_str
= NULL
;
1506 struct argpar_parse_ret argpar_parse_ret
= { 0 };
1508 bt_value
*params
= bt_value_map_create();
1510 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1515 cfg
= bt_config_query_create(plugin_paths
);
1520 error_str
= g_string_new(NULL
);
1522 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1527 argpar_parse_ret
= argpar_parse(argc
, argv
, query_options
, true);
1528 if (argpar_parse_ret
.error
) {
1529 BT_CLI_LOGE_APPEND_CAUSE(
1530 "While parsing `query` command's command-line arguments: %s",
1531 argpar_parse_ret
.error
);
1535 if (help_option_is_specified(&argpar_parse_ret
)) {
1536 print_query_usage(stdout
);
1538 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1542 for (i
= 0; i
< argpar_parse_ret
.items
->n_items
; i
++) {
1543 struct argpar_item
*argpar_item
=
1544 argpar_parse_ret
.items
->items
[i
];
1546 if (argpar_item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
1547 struct argpar_item_opt
*argpar_item_opt
=
1548 (struct argpar_item_opt
*) argpar_item
;
1549 const char *arg
= argpar_item_opt
->arg
;
1551 switch (argpar_item_opt
->descr
->id
) {
1554 bt_value
*parsed_params
= bt_param_parse(arg
, error_str
);
1555 bt_value_map_extend_status extend_status
;
1556 if (!parsed_params
) {
1557 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1562 extend_status
= bt_value_map_extend(params
, parsed_params
);
1563 BT_VALUE_PUT_REF_AND_RESET(parsed_params
);
1564 if (extend_status
) {
1565 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current parameters with --params option's argument:\n %s",
1572 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1573 argpar_item_opt
->descr
->id
);
1577 struct argpar_item_non_opt
*argpar_item_non_opt
1578 = (struct argpar_item_non_opt
*) argpar_item
;
1581 * We need exactly two non-option arguments
1582 * which are the mandatory component class
1583 * specification and query object.
1585 if (!component_class_spec
) {
1586 component_class_spec
= argpar_item_non_opt
->arg
;
1587 } else if (!query_object
) {
1588 query_object
= argpar_item_non_opt
->arg
;
1590 BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
1591 argpar_item_non_opt
->arg
);
1597 if (!component_class_spec
|| !query_object
) {
1598 print_query_usage(stdout
);
1600 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1604 cfg
->cmd_data
.query
.cfg_component
=
1605 bt_config_component_from_arg(component_class_spec
,
1607 if (!cfg
->cmd_data
.query
.cfg_component
) {
1608 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1609 component_class_spec
);
1614 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
1616 if (strlen(query_object
) == 0) {
1617 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1621 g_string_assign(cfg
->cmd_data
.query
.object
, query_object
);
1626 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1629 argpar_parse_ret_fini(&argpar_parse_ret
);
1632 g_string_free(error_str
, TRUE
);
1635 bt_value_put_ref(params
);
1640 * Prints the list-plugins command usage.
1643 void print_list_plugins_usage(FILE *fp
)
1645 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1647 fprintf(fp
, "Options:\n");
1649 fprintf(fp
, " -h, --help Show this help and quit\n");
1651 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1653 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1657 const struct argpar_opt_descr list_plugins_options
[] = {
1658 /* id, short_name, long_name, with_arg */
1659 { OPT_HELP
, 'h', "help", false },
1660 ARGPAR_OPT_DESCR_SENTINEL
1664 * Creates a Babeltrace config object from the arguments of a
1665 * list-plugins command.
1667 * *retcode is set to the appropriate exit code to use.
1670 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
1671 int *retcode
, const bt_value
*plugin_paths
)
1673 struct bt_config
*cfg
= NULL
;
1674 struct argpar_parse_ret argpar_parse_ret
= { 0 };
1677 cfg
= bt_config_list_plugins_create(plugin_paths
);
1683 argpar_parse_ret
= argpar_parse(argc
, argv
, list_plugins_options
, true);
1684 if (argpar_parse_ret
.error
) {
1685 BT_CLI_LOGE_APPEND_CAUSE(
1686 "While parsing `list-plugins` command's command-line arguments: %s",
1687 argpar_parse_ret
.error
);
1691 if (help_option_is_specified(&argpar_parse_ret
)) {
1692 print_list_plugins_usage(stdout
);
1694 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1698 if (argpar_parse_ret
.items
->n_items
> 0) {
1700 * At this point we know there's at least one non-option
1701 * argument because we don't reach here with `--help`,
1704 struct argpar_item_non_opt
*non_opt
=
1705 (struct argpar_item_non_opt
*) argpar_parse_ret
.items
->items
[0];
1707 BT_CLI_LOGE_APPEND_CAUSE(
1708 "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
1717 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1720 argpar_parse_ret_fini(&argpar_parse_ret
);
1726 * Prints the run command usage.
1729 void print_run_usage(FILE *fp
)
1731 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1733 fprintf(fp
, "Options:\n");
1735 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1736 fprintf(fp
, " for all the following components until\n");
1737 fprintf(fp
, " --reset-base-params is encountered\n");
1738 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1739 fprintf(fp
, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
1740 fprintf(fp
, " Instantiate the component class CLS of type\n");
1741 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1742 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1743 fprintf(fp
, " and name it NAME");
1744 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1745 fprintf(fp
, " expected format of CONNECTION below)\n");
1746 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1747 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
1748 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1749 fprintf(fp
, " current component (see the expected format\n");
1750 fprintf(fp
, " of PARAMS below)\n");
1751 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1752 fprintf(fp
, " empty map\n");
1753 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1754 fprintf(fp
, " the graph later, retry in DUR µs\n");
1755 fprintf(fp
, " (default: 100000)\n");
1756 fprintf(fp
, " -h, --help Show this help and quit\n");
1758 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1759 fprintf(fp
, "\n\n");
1760 fprintf(fp
, "Expected format of CONNECTION\n");
1761 fprintf(fp
, "-----------------------------\n");
1763 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1765 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1766 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1767 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
1768 fprintf(fp
, "component using the NAME prefix of the --component option.\n");
1770 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1771 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1772 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1774 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1775 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1776 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1777 fprintf(fp
, "DOWNSTREAM.\n");
1779 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1780 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1781 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1783 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1784 fprintf(fp
, "can connect a filter component to a sink component.\n");
1786 fprintf(fp
, "Examples:\n");
1788 fprintf(fp
, " my-src:my-sink\n");
1789 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1791 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1792 fprintf(fp
, "babeltrace2 from a shell.\n");
1793 fprintf(fp
, "\n\n");
1794 print_expected_params_format(fp
);
1798 * Creates a Babeltrace config object from the arguments of a run
1801 * *retcode is set to the appropriate exit code to use.
1804 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
1805 int *retcode
, const bt_value
*plugin_paths
,
1806 int default_log_level
)
1808 struct bt_config_component
*cur_cfg_comp
= NULL
;
1809 bt_value
*cur_base_params
= NULL
;
1811 struct bt_config
*cfg
= NULL
;
1812 bt_value
*instance_names
= NULL
;
1813 bt_value
*connection_args
= NULL
;
1814 char error_buf
[256] = { 0 };
1815 long retry_duration
= -1;
1816 bt_value_map_extend_status extend_status
;
1817 GString
*error_str
= NULL
;
1818 struct argpar_parse_ret argpar_parse_ret
= { 0 };
1821 static const struct argpar_opt_descr run_options
[] = {
1822 { OPT_BASE_PARAMS
, 'b', "base-params", true },
1823 { OPT_COMPONENT
, 'c', "component", true },
1824 { OPT_CONNECT
, 'x', "connect", true },
1825 { OPT_HELP
, 'h', "help", false },
1826 { OPT_LOG_LEVEL
, 'l', "log-level", true },
1827 { OPT_PARAMS
, 'p', "params", true },
1828 { OPT_RESET_BASE_PARAMS
, 'r', "reset-base-params", false },
1829 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
1830 ARGPAR_OPT_DESCR_SENTINEL
1835 error_str
= g_string_new(NULL
);
1837 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1842 print_run_usage(stdout
);
1847 cfg
= bt_config_run_create(plugin_paths
);
1852 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1853 cur_base_params
= bt_value_map_create();
1854 if (!cur_base_params
) {
1855 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1859 instance_names
= bt_value_map_create();
1860 if (!instance_names
) {
1861 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1865 connection_args
= bt_value_array_create();
1866 if (!connection_args
) {
1867 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1872 argpar_parse_ret
= argpar_parse(argc
, argv
, run_options
, true);
1873 if (argpar_parse_ret
.error
) {
1874 BT_CLI_LOGE_APPEND_CAUSE(
1875 "While parsing `run` command's command-line arguments: %s",
1876 argpar_parse_ret
.error
);
1880 if (help_option_is_specified(&argpar_parse_ret
)) {
1881 print_run_usage(stdout
);
1883 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1887 for (i
= 0; i
< argpar_parse_ret
.items
->n_items
; i
++) {
1888 struct argpar_item
*argpar_item
=
1889 argpar_parse_ret
.items
->items
[i
];
1890 struct argpar_item_opt
*argpar_item_opt
;
1893 /* This command does not accept non-option arguments.*/
1894 if (argpar_item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
) {
1895 struct argpar_item_non_opt
*argpar_nonopt_item
=
1896 (struct argpar_item_non_opt
*) argpar_item
;
1898 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
1899 argpar_nonopt_item
->arg
);
1903 argpar_item_opt
= (struct argpar_item_opt
*) argpar_item
;
1904 arg
= argpar_item_opt
->arg
;
1906 switch (argpar_item_opt
->descr
->id
) {
1909 enum bt_config_component_dest dest
;
1911 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
1912 cur_cfg_comp
= bt_config_component_from_arg(arg
,
1914 if (!cur_cfg_comp
) {
1915 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
1920 switch (cur_cfg_comp
->type
) {
1921 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1922 dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
1924 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1925 dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
1927 case BT_COMPONENT_CLASS_TYPE_SINK
:
1928 dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
1934 BT_ASSERT(cur_base_params
);
1935 bt_value_put_ref(cur_cfg_comp
->params
);
1936 if (bt_value_copy(cur_base_params
,
1937 &cur_cfg_comp
->params
) < 0) {
1938 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1942 ret
= add_run_cfg_comp_check_name(cfg
,
1955 if (!cur_cfg_comp
) {
1956 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
1961 params
= bt_param_parse(arg
, error_str
);
1963 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1968 extend_status
= bt_value_map_extend(cur_cfg_comp
->params
,
1970 BT_VALUE_PUT_REF_AND_RESET(params
);
1971 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
1972 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
1980 if (!cur_cfg_comp
) {
1981 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
1986 cur_cfg_comp
->log_level
=
1987 bt_log_get_level_from_string(arg
);
1988 if (cur_cfg_comp
->log_level
< 0) {
1989 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
1994 case OPT_BASE_PARAMS
:
1996 bt_value
*params
= bt_param_parse(arg
, error_str
);
1999 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
2004 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
2007 case OPT_RESET_BASE_PARAMS
:
2008 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2009 cur_base_params
= bt_value_map_create();
2010 if (!cur_base_params
) {
2011 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2016 if (bt_value_array_append_string_element(
2017 connection_args
, arg
)) {
2018 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2022 case OPT_RETRY_DURATION
: {
2024 size_t arg_len
= strlen(argpar_item_opt
->arg
);
2026 retry_duration
= g_ascii_strtoll(argpar_item_opt
->arg
, &end
, 10);
2028 if (arg_len
== 0 || end
!= (argpar_item_opt
->arg
+ arg_len
)) {
2029 BT_CLI_LOGE_APPEND_CAUSE(
2030 "Could not parse --retry-duration option's argument as an unsigned integer: `%s`",
2031 argpar_item_opt
->arg
);
2035 if (retry_duration
< 0) {
2036 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2041 cfg
->cmd_data
.run
.retry_duration_us
=
2042 (uint64_t) retry_duration
;
2046 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
2047 argpar_item_opt
->descr
->id
);
2052 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2054 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2055 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2059 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2060 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2064 ret
= bt_config_cli_args_create_connections(cfg
,
2068 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2076 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2080 g_string_free(error_str
, TRUE
);
2083 argpar_parse_ret_fini(&argpar_parse_ret
);
2084 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2085 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2086 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2087 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2092 struct bt_config
*bt_config_run_from_args_array(const bt_value
*run_args
,
2093 int *retcode
, const bt_value
*plugin_paths
,
2094 int default_log_level
)
2096 struct bt_config
*cfg
= NULL
;
2098 uint64_t i
, len
= bt_value_array_get_length(run_args
);
2100 BT_ASSERT(len
<= SIZE_MAX
);
2101 argv
= calloc((size_t) len
, sizeof(*argv
));
2103 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2107 for (i
= 0; i
< len
; i
++) {
2108 const bt_value
*arg_value
=
2109 bt_value_array_borrow_element_by_index_const(run_args
,
2113 arg
= bt_value_string_get(arg_value
);
2118 cfg
= bt_config_run_from_args((int) len
, argv
, retcode
,
2119 plugin_paths
, default_log_level
);
2127 * Prints the convert command usage.
2130 void print_convert_usage(FILE *fp
)
2132 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2134 fprintf(fp
, "Options:\n");
2136 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2137 fprintf(fp
, " Instantiate the component class CLS of type\n");
2138 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2139 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2140 fprintf(fp
, " conversion graph, and optionally name it\n");
2141 fprintf(fp
, " NAME\n");
2142 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2143 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
2144 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2145 fprintf(fp
, " current component (see the expected format\n");
2146 fprintf(fp
, " of PARAMS below)\n");
2147 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2148 fprintf(fp
, " the graph later, retry in DUR µs\n");
2149 fprintf(fp
, " (default: 100000)\n");
2150 fprintf(fp
, " dynamic plugins can be loaded\n");
2151 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2152 fprintf(fp
, " `run` command to the standard output,\n");
2153 fprintf(fp
, " formatted for a shell, and quit\n");
2154 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2155 fprintf(fp
, " `run` command to the standard output,\n");
2156 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2157 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2158 fprintf(fp
, " are active\n");
2159 fprintf(fp
, " -h, --help Show this help and quit\n");
2161 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2163 fprintf(fp
, " --clock-force-correlate Force the origin of all clocks\n");
2164 fprintf(fp
, " to the Unix epoch\n");
2165 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2166 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2168 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2170 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2171 fprintf(fp
, " --clock-date Print timestamp dates\n");
2172 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2173 fprintf(fp
, " time zone instead of the local time zone\n");
2174 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2175 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2176 fprintf(fp
, " --color=(never | auto | always)\n");
2177 fprintf(fp
, " Never, automatically, or always emit\n");
2178 fprintf(fp
, " console color codes\n");
2179 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2180 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2181 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2182 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2183 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2184 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2185 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2186 fprintf(fp
, " (or `ctx`)\n");
2187 fprintf(fp
, " --no-delta Do not print time delta between\n");
2188 fprintf(fp
, " consecutive events\n");
2189 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2190 fprintf(fp
, " the standard output\n");
2192 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2194 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2195 fprintf(fp
, " time range to BEGIN (see the format of\n");
2196 fprintf(fp
, " BEGIN below)\n");
2197 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2198 fprintf(fp
, " range to END (see the format of END below)\n");
2199 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2200 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2201 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2203 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2205 fprintf(fp
, " --debug-info Create an implicit\n");
2206 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2207 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2208 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2209 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2210 fprintf(fp
, " binary paths instead of just names\n");
2211 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2212 fprintf(fp
, " Use directory DIR as a prefix when\n");
2213 fprintf(fp
, " looking up executables during debug\n");
2214 fprintf(fp
, " info analysis\n");
2216 fprintf(fp
, "Legacy options that still work:\n");
2218 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2219 fprintf(fp
, " `ctf`:\n");
2220 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2221 fprintf(fp
, " component\n");
2222 fprintf(fp
, " `lttng-live`:\n");
2223 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2224 fprintf(fp
, " component\n");
2225 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2226 fprintf(fp
, " `text`:\n");
2227 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2228 fprintf(fp
, " component\n");
2229 fprintf(fp
, " `ctf`:\n");
2230 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2231 fprintf(fp
, " component\n");
2232 fprintf(fp
, " `dummy`:\n");
2233 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2234 fprintf(fp
, " component\n");
2235 fprintf(fp
, " `ctf-metadata`:\n");
2236 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2237 fprintf(fp
, " for metadata text and quit\n");
2239 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2240 fprintf(fp
, "\n\n");
2241 fprintf(fp
, "Format of BEGIN and END\n");
2242 fprintf(fp
, "-----------------------\n");
2244 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2245 fprintf(fp
, "\n\n");
2246 print_expected_params_format(fp
);
2250 const struct argpar_opt_descr convert_options
[] = {
2251 /* id, short_name, long_name, with_arg */
2252 { OPT_BEGIN
, 'b', "begin", true },
2253 { OPT_CLOCK_CYCLES
, '\0', "clock-cycles", false },
2254 { OPT_CLOCK_DATE
, '\0', "clock-date", false },
2255 { OPT_CLOCK_FORCE_CORRELATE
, '\0', "clock-force-correlate", false },
2256 { OPT_CLOCK_GMT
, '\0', "clock-gmt", false },
2257 { OPT_CLOCK_OFFSET
, '\0', "clock-offset", true },
2258 { OPT_CLOCK_OFFSET_NS
, '\0', "clock-offset-ns", true },
2259 { OPT_CLOCK_SECONDS
, '\0', "clock-seconds", false },
2260 { OPT_COLOR
, '\0', "color", true },
2261 { OPT_COMPONENT
, 'c', "component", true },
2262 { OPT_DEBUG
, 'd', "debug", false },
2263 { OPT_DEBUG_INFO_DIR
, '\0', "debug-info-dir", true },
2264 { OPT_DEBUG_INFO_FULL_PATH
, '\0', "debug-info-full-path", false },
2265 { OPT_DEBUG_INFO_TARGET_PREFIX
, '\0', "debug-info-target-prefix", true },
2266 { OPT_END
, 'e', "end", true },
2267 { OPT_FIELDS
, 'f', "fields", true },
2268 { OPT_HELP
, 'h', "help", false },
2269 { OPT_INPUT_FORMAT
, 'i', "input-format", true },
2270 { OPT_LOG_LEVEL
, 'l', "log-level", true },
2271 { OPT_NAMES
, 'n', "names", true },
2272 { OPT_DEBUG_INFO
, '\0', "debug-info", false },
2273 { OPT_NO_DELTA
, '\0', "no-delta", false },
2274 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
2275 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
2276 { OPT_OUTPUT
, 'w', "output", true },
2277 { OPT_OUTPUT_FORMAT
, 'o', "output-format", true },
2278 { OPT_PARAMS
, 'p', "params", true },
2279 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
2280 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
2281 { OPT_RUN_ARGS
, '\0', "run-args", false },
2282 { OPT_RUN_ARGS_0
, '\0', "run-args-0", false },
2283 { OPT_STREAM_INTERSECTION
, '\0', "stream-intersection", false },
2284 { OPT_TIMERANGE
, '\0', "timerange", true },
2285 { OPT_VERBOSE
, 'v', "verbose", false },
2286 ARGPAR_OPT_DESCR_SENTINEL
2290 GString
*get_component_auto_name(const char *prefix
,
2291 const bt_value
*existing_names
)
2294 GString
*auto_name
= g_string_new(NULL
);
2297 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2301 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2302 g_string_assign(auto_name
, prefix
);
2307 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2309 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2315 struct implicit_component_args
{
2318 /* The component class name (e.g. src.ctf.fs). */
2321 /* The component instance name. */
2324 GString
*params_arg
;
2325 bt_value
*extra_params
;
2329 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2330 const char *prefix
, bt_value
*existing_names
,
2331 GList
**comp_names
, bool append_to_comp_names
)
2334 GString
*name
= NULL
;
2336 if (!args
->exists
) {
2340 name
= get_component_auto_name(prefix
,
2348 g_string_assign(args
->name_arg
, name
->str
);
2350 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2352 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2357 if (append_to_comp_names
) {
2358 *comp_names
= g_list_append(*comp_names
, name
);
2364 g_string_free(name
, TRUE
);
2371 int append_run_args_for_implicit_component(
2372 struct implicit_component_args
*impl_args
,
2377 GString
*component_arg_for_run
= NULL
;
2379 if (!impl_args
->exists
) {
2383 component_arg_for_run
= g_string_new(NULL
);
2384 if (!component_arg_for_run
) {
2385 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2389 /* Build the full `name:type.plugin.cls`. */
2390 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, '\\'));
2391 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, ':'));
2392 g_string_printf(component_arg_for_run
, "%s:%s",
2393 impl_args
->name_arg
->str
, impl_args
->comp_arg
->str
);
2395 if (bt_value_array_append_string_element(run_args
, "--component")) {
2396 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2400 if (bt_value_array_append_string_element(run_args
,
2401 component_arg_for_run
->str
)) {
2402 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2406 if (impl_args
->params_arg
->len
> 0) {
2407 if (bt_value_array_append_string_element(run_args
, "--params")) {
2408 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2412 if (bt_value_array_append_string_element(run_args
,
2413 impl_args
->params_arg
->str
)) {
2414 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2419 for (i
= 0; i
< bt_value_array_get_length(impl_args
->extra_params
); i
++) {
2420 const bt_value
*elem
;
2423 elem
= bt_value_array_borrow_element_by_index(
2424 impl_args
->extra_params
, i
);
2426 BT_ASSERT(bt_value_is_string(elem
));
2427 arg
= bt_value_string_get(elem
);
2428 ret
= bt_value_array_append_string_element(run_args
, arg
);
2430 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2441 if (component_arg_for_run
) {
2442 g_string_free(component_arg_for_run
, TRUE
);
2448 /* Free the fields of a `struct implicit_component_args`. */
2451 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2455 if (args
->comp_arg
) {
2456 g_string_free(args
->comp_arg
, TRUE
);
2459 if (args
->name_arg
) {
2460 g_string_free(args
->name_arg
, TRUE
);
2463 if (args
->params_arg
) {
2464 g_string_free(args
->params_arg
, TRUE
);
2467 bt_value_put_ref(args
->extra_params
);
2470 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2473 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2475 finalize_implicit_component_args(args
);
2479 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2482 int init_implicit_component_args(struct implicit_component_args
*args
,
2483 const char *comp_arg
, bool exists
)
2487 args
->exists
= exists
;
2488 args
->comp_arg
= g_string_new(comp_arg
);
2489 args
->name_arg
= g_string_new(NULL
);
2490 args
->params_arg
= g_string_new(NULL
);
2491 args
->extra_params
= bt_value_array_create();
2493 if (!args
->comp_arg
|| !args
->name_arg
||
2494 !args
->params_arg
|| !args
->extra_params
) {
2496 finalize_implicit_component_args(args
);
2497 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2505 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2508 struct implicit_component_args
*create_implicit_component_args(
2509 const char *comp_arg
)
2511 struct implicit_component_args
*args
;
2514 args
= g_new(struct implicit_component_args
, 1);
2516 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2520 status
= init_implicit_component_args(args
, comp_arg
, true);
2531 void append_implicit_component_param(struct implicit_component_args
*args
,
2532 const char *key
, const char *value
)
2537 append_param_arg(args
->params_arg
, key
, value
);
2541 * Append the given parameter (`key=value`) to all component specifications
2542 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2543 * which match `comp_arg`.
2545 * Return the number of matching components.
2549 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2550 const char *comp_arg
, const char *key
, const char *value
)
2555 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2556 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2558 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2559 append_implicit_component_param(args
, key
, value
);
2567 /* Escape value to make it suitable to use as a string parameter value. */
2569 gchar
*escape_string_value(const char *value
)
2574 ret
= g_string_new(NULL
);
2576 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2585 g_string_append_c(ret
, '\\');
2589 g_string_append_c(ret
, *in
);
2595 return g_string_free(ret
, FALSE
);
2599 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2605 switch (bt_value_get_type(value
)) {
2606 case BT_VALUE_TYPE_STRING
:
2608 const char *str_value
= bt_value_string_get(value
);
2609 gchar
*escaped_str_value
;
2611 escaped_str_value
= escape_string_value(str_value
);
2612 if (!escaped_str_value
) {
2616 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2618 g_free(escaped_str_value
);
2621 case BT_VALUE_TYPE_ARRAY
: {
2622 g_string_append_c(buf
, '[');
2623 uint64_t sz
= bt_value_array_get_length(value
);
2624 for (uint64_t i
= 0; i
< sz
; i
++) {
2625 const bt_value
*item
;
2628 g_string_append(buf
, ", ");
2631 item
= bt_value_array_borrow_element_by_index_const(
2633 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2639 g_string_append_c(buf
, ']');
2653 * Convert `value` to its equivalent representation as a command line parameter
2658 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2661 gchar
*result
= NULL
;
2663 buf
= g_string_new(NULL
);
2665 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2669 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2673 result
= g_string_free(buf
, FALSE
);
2680 g_string_free(buf
, TRUE
);
2688 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2691 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2696 gchar
*str_value
= NULL
;
2697 GString
*parameter
= NULL
;
2699 if (bt_value_array_append_string_element(args
, "--params")) {
2700 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2705 str_value
= bt_value_to_cli_param_value(value
);
2711 parameter
= g_string_new(NULL
);
2713 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2718 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2720 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2721 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2728 g_string_free(parameter
, TRUE
);
2741 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2743 bt_value
*str_value
;
2746 str_value
= bt_value_string_create_init(value
);
2749 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2754 ret
= append_parameter_to_args(args
, key
, str_value
);
2757 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2762 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2763 const char *key
, const char *value
)
2765 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2769 * Escapes `.`, `:`, and `\` of `input` with `\`.
2772 GString
*escape_dot_colon(const char *input
)
2774 GString
*output
= g_string_new(NULL
);
2778 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2782 for (ch
= input
; *ch
!= '\0'; ch
++) {
2783 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
2784 g_string_append_c(output
, '\\');
2787 g_string_append_c(output
, *ch
);
2795 * Appends a --connect option to a list of arguments. `upstream_name`
2796 * and `downstream_name` are escaped with escape_dot_colon() in this
2800 int append_connect_arg(bt_value
*run_args
,
2801 const char *upstream_name
, const char *downstream_name
)
2804 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
2805 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
2806 GString
*arg
= g_string_new(NULL
);
2808 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
2809 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2814 ret
= bt_value_array_append_string_element(run_args
, "--connect");
2816 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2821 g_string_append(arg
, e_upstream_name
->str
);
2822 g_string_append_c(arg
, ':');
2823 g_string_append(arg
, e_downstream_name
->str
);
2824 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
2826 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2833 g_string_free(arg
, TRUE
);
2836 if (e_upstream_name
) {
2837 g_string_free(e_upstream_name
, TRUE
);
2840 if (e_downstream_name
) {
2841 g_string_free(e_downstream_name
, TRUE
);
2848 * Appends the run command's --connect options for the convert command.
2851 int convert_auto_connect(bt_value
*run_args
,
2852 GList
*source_names
, GList
*filter_names
,
2856 GList
*source_at
= source_names
;
2857 GList
*filter_at
= filter_names
;
2859 GList
*sink_at
= sink_names
;
2861 BT_ASSERT(source_names
);
2862 BT_ASSERT(filter_names
);
2863 BT_ASSERT(sink_names
);
2865 /* Connect all sources to the first filter */
2866 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
2867 GString
*source_name
= source_at
->data
;
2868 GString
*filter_name
= filter_at
->data
;
2870 ret
= append_connect_arg(run_args
, source_name
->str
,
2877 filter_prev
= filter_at
;
2878 filter_at
= g_list_next(filter_at
);
2880 /* Connect remaining filters */
2881 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
2882 GString
*filter_name
= filter_at
->data
;
2883 GString
*filter_prev_name
= filter_prev
->data
;
2885 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
2892 /* Connect last filter to all sinks */
2893 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
2894 GString
*filter_name
= filter_prev
->data
;
2895 GString
*sink_name
= sink_at
->data
;
2897 ret
= append_connect_arg(run_args
, filter_name
->str
,
2914 int split_timerange(const char *arg
, char **begin
, char **end
)
2917 const char *ch
= arg
;
2919 GString
*g_begin
= NULL
;
2920 GString
*g_end
= NULL
;
2928 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
2929 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
2935 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
2936 if (!g_end
|| g_end
->len
== 0) {
2942 *begin
= g_string_free(g_begin
, FALSE
);
2943 *end
= g_string_free(g_end
, FALSE
);
2953 g_string_free(g_begin
, TRUE
);
2957 g_string_free(g_end
, TRUE
);
2964 int g_list_prepend_gstring(GList
**list
, const char *string
)
2967 GString
*gs
= g_string_new(string
);
2972 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2976 *list
= g_list_prepend(*list
, gs
);
2983 * Create `struct implicit_component_args` structures for each of the
2984 * source components we identified. Add them to `component_args`.
2986 * `non_opts` is an array of the non-option arguments passed on the command
2989 * `non_opt_params` is an array where each element is an array of
2990 * strings containing all the arguments to `--params` that apply to the
2991 * non-option argument at the same index. For example, if, for a
2992 * non-option argument, the following `--params` options applied:
2994 * --params=a=2 --params=b=3,c=4
2996 * its entry in `non_opt_params` would contain
2998 * ["a=2", "b=3,c=4"]
3002 int create_implicit_component_args_from_auto_discovered_sources(
3003 const struct auto_source_discovery
*auto_disc
,
3004 const bt_value
*non_opts
,
3005 const bt_value
*non_opt_params
,
3006 const bt_value
*non_opt_loglevels
,
3007 GPtrArray
*component_args
)
3009 gchar
*cc_name
= NULL
;
3010 struct implicit_component_args
*comp
= NULL
;
3014 len
= auto_disc
->results
->len
;
3016 for (i
= 0; i
< len
; i
++) {
3017 struct auto_source_discovery_result
*res
=
3018 g_ptr_array_index(auto_disc
->results
, i
);
3019 uint64_t orig_indices_i
, orig_indices_count
;
3022 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3024 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3028 comp
= create_implicit_component_args(cc_name
);
3034 * Append parameters and log levels of all the
3035 * non-option arguments that contributed to this
3036 * component instance coming into existence.
3038 orig_indices_count
= bt_value_array_get_length(res
->original_input_indices
);
3039 for (orig_indices_i
= 0; orig_indices_i
< orig_indices_count
; orig_indices_i
++) {
3040 const bt_value
*orig_idx_value
=
3041 bt_value_array_borrow_element_by_index(
3042 res
->original_input_indices
, orig_indices_i
);
3043 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3044 const bt_value
*params_array
=
3045 bt_value_array_borrow_element_by_index_const(
3046 non_opt_params
, orig_idx
);
3047 uint64_t params_i
, params_count
;
3048 const bt_value
*loglevel_value
;
3050 params_count
= bt_value_array_get_length(params_array
);
3051 for (params_i
= 0; params_i
< params_count
; params_i
++) {
3052 const bt_value
*params_value
=
3053 bt_value_array_borrow_element_by_index_const(
3054 params_array
, params_i
);
3055 const char *params
= bt_value_string_get(params_value
);
3056 bt_value_array_append_element_status append_status
;
3058 append_status
= bt_value_array_append_string_element(
3059 comp
->extra_params
, "--params");
3060 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3061 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3065 append_status
= bt_value_array_append_string_element(
3066 comp
->extra_params
, params
);
3067 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3068 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3073 loglevel_value
= bt_value_array_borrow_element_by_index_const(
3074 non_opt_loglevels
, orig_idx
);
3075 if (bt_value_get_type(loglevel_value
) == BT_VALUE_TYPE_STRING
) {
3076 const char *loglevel
= bt_value_string_get(loglevel_value
);
3077 bt_value_array_append_element_status append_status
;
3079 append_status
= bt_value_array_append_string_element(
3080 comp
->extra_params
, "--log-level");
3081 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3082 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3086 append_status
= bt_value_array_append_string_element(
3087 comp
->extra_params
, loglevel
);
3088 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3089 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3096 * If single input and a src.ctf.fs component, provide the
3097 * relative path from the path passed on the command line to the
3100 if (bt_value_array_get_length(res
->inputs
) == 1 &&
3101 strcmp(res
->plugin_name
, "ctf") == 0 &&
3102 strcmp(res
->source_cc_name
, "fs") == 0) {
3103 const bt_value
*orig_idx_value
=
3104 bt_value_array_borrow_element_by_index(
3105 res
->original_input_indices
, 0);
3106 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3107 const bt_value
*non_opt_value
=
3108 bt_value_array_borrow_element_by_index_const(
3109 non_opts
, orig_idx
);
3110 const char *non_opt
= bt_value_string_get(non_opt_value
);
3111 const bt_value
*input_value
=
3112 bt_value_array_borrow_element_by_index_const(
3114 const char *input
= bt_value_string_get(input_value
);
3116 BT_ASSERT(orig_indices_count
== 1);
3117 BT_ASSERT(g_str_has_prefix(input
, non_opt
));
3119 input
+= strlen(non_opt
);
3121 while (G_IS_DIR_SEPARATOR(*input
)) {
3125 if (strlen(input
) > 0) {
3126 append_string_parameter_to_args(comp
->extra_params
,
3127 "trace-name", input
);
3131 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3136 g_ptr_array_add(component_args
, comp
);
3150 destroy_implicit_component_args(comp
);
3157 * As we iterate the arguments to the convert command, this tracks what is the
3158 * type of the current item, to which some contextual options (e.g. --params)
3161 enum convert_current_item_type
{
3162 /* There is no current item. */
3163 CONVERT_CURRENT_ITEM_TYPE_NONE
,
3165 /* Current item is a component. */
3166 CONVERT_CURRENT_ITEM_TYPE_COMPONENT
,
3168 /* Current item is a non-option argument. */
3169 CONVERT_CURRENT_ITEM_TYPE_NON_OPT
,
3173 * Creates a Babeltrace config object from the arguments of a convert
3176 * *retcode is set to the appropriate exit code to use.
3179 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3180 int *retcode
, const bt_value
*plugin_paths
,
3181 int *default_log_level
, const bt_interrupter
*interrupter
)
3183 enum convert_current_item_type current_item_type
=
3184 CONVERT_CURRENT_ITEM_TYPE_NONE
;
3186 struct bt_config
*cfg
= NULL
;
3187 bool got_input_format_opt
= false;
3188 bool got_output_format_opt
= false;
3189 bool trimmer_has_begin
= false;
3190 bool trimmer_has_end
= false;
3191 bool stream_intersection_mode
= false;
3192 bool print_run_args
= false;
3193 bool print_run_args_0
= false;
3194 bool print_ctf_metadata
= false;
3195 bt_value
*run_args
= NULL
;
3196 bt_value
*all_names
= NULL
;
3197 GList
*source_names
= NULL
;
3198 GList
*filter_names
= NULL
;
3199 GList
*sink_names
= NULL
;
3200 bt_value
*non_opts
= NULL
;
3201 bt_value
*non_opt_params
= NULL
;
3202 bt_value
*non_opt_loglevels
= NULL
;
3203 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3204 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3205 struct implicit_component_args implicit_dummy_args
= { 0 };
3206 struct implicit_component_args implicit_text_args
= { 0 };
3207 struct implicit_component_args implicit_debug_info_args
= { 0 };
3208 struct implicit_component_args implicit_muxer_args
= { 0 };
3209 struct implicit_component_args implicit_trimmer_args
= { 0 };
3210 char error_buf
[256] = { 0 };
3212 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3213 char *output
= NULL
;
3214 struct auto_source_discovery auto_disc
= { NULL
};
3215 GString
*auto_disc_comp_name
= NULL
;
3216 struct argpar_parse_ret argpar_parse_ret
= { 0 };
3217 GString
*name_gstr
= NULL
;
3218 GString
*component_arg_for_run
= NULL
;
3219 bt_value
*live_inputs_array_val
= NULL
;
3222 * Array of `struct implicit_component_args *` created for the sources
3223 * we have auto-discovered.
3225 GPtrArray
*discovered_source_args
= NULL
;
3228 * If set, restrict automatic source discovery to this component class
3231 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3232 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3234 bool ctf_fs_source_force_clock_class_unix_epoch_origin
= false;
3235 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3236 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3240 print_convert_usage(stdout
);
3245 if (init_implicit_component_args(&implicit_ctf_output_args
,
3246 "sink.ctf.fs", false)) {
3250 if (init_implicit_component_args(&implicit_lttng_live_args
,
3251 "source.ctf.lttng-live", false)) {
3255 if (init_implicit_component_args(&implicit_text_args
,
3256 "sink.text.pretty", false)) {
3260 if (init_implicit_component_args(&implicit_dummy_args
,
3261 "sink.utils.dummy", false)) {
3265 if (init_implicit_component_args(&implicit_debug_info_args
,
3266 "filter.lttng-utils.debug-info", false)) {
3270 if (init_implicit_component_args(&implicit_muxer_args
,
3271 "filter.utils.muxer", true)) {
3275 if (init_implicit_component_args(&implicit_trimmer_args
,
3276 "filter.utils.trimmer", false)) {
3280 all_names
= bt_value_map_create();
3282 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3286 run_args
= bt_value_array_create();
3288 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3292 component_arg_for_run
= g_string_new(NULL
);
3293 if (!component_arg_for_run
) {
3294 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3298 non_opts
= bt_value_array_create();
3300 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3304 non_opt_params
= bt_value_array_create();
3305 if (!non_opt_params
) {
3306 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3310 non_opt_loglevels
= bt_value_array_create();
3311 if (!non_opt_loglevels
) {
3312 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3316 if (auto_source_discovery_init(&auto_disc
) != 0) {
3320 discovered_source_args
=
3321 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3322 if (!discovered_source_args
) {
3323 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3327 auto_disc_comp_name
= g_string_new(NULL
);
3328 if (!auto_disc_comp_name
) {
3329 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3334 * First pass: collect all arguments which need to be passed
3335 * as is to the run command. This pass can also add --name
3336 * arguments if needed to automatically name unnamed component
3339 argpar_parse_ret
= argpar_parse(argc
, argv
, convert_options
, true);
3340 if (argpar_parse_ret
.error
) {
3341 BT_CLI_LOGE_APPEND_CAUSE(
3342 "While parsing `convert` command's command-line arguments: %s",
3343 argpar_parse_ret
.error
);
3347 if (help_option_is_specified(&argpar_parse_ret
)) {
3348 print_convert_usage(stdout
);
3350 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3354 for (i
= 0; i
< argpar_parse_ret
.items
->n_items
; i
++) {
3355 struct argpar_item
*argpar_item
=
3356 argpar_parse_ret
.items
->items
[i
];
3357 struct argpar_item_opt
*argpar_item_opt
;
3359 char *plugin_name
= NULL
;
3360 char *comp_cls_name
= NULL
;
3363 if (argpar_item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
3364 argpar_item_opt
= (struct argpar_item_opt
*) argpar_item
;
3365 arg
= argpar_item_opt
->arg
;
3367 switch (argpar_item_opt
->descr
->id
) {
3370 bt_component_class_type type
;
3372 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_COMPONENT
;
3374 /* Parse the argument */
3375 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3376 &comp_cls_name
, &type
);
3377 if (!plugin_name
|| !comp_cls_name
) {
3378 BT_CLI_LOGE_APPEND_CAUSE(
3379 "Invalid format for --component option's argument:\n %s",
3386 * Name was given by the user, verify it isn't
3389 if (bt_value_map_has_entry(all_names
, name
)) {
3390 BT_CLI_LOGE_APPEND_CAUSE(
3391 "Duplicate component instance name:\n %s",
3396 name_gstr
= g_string_new(name
);
3398 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3402 g_string_assign(component_arg_for_run
, arg
);
3404 /* Name not given by user, generate one. */
3405 name_gstr
= get_component_auto_name(arg
, all_names
);
3410 g_string_printf(component_arg_for_run
, "%s:%s",
3411 name_gstr
->str
, arg
);
3414 if (bt_value_array_append_string_element(run_args
,
3416 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3420 if (bt_value_array_append_string_element(run_args
,
3421 component_arg_for_run
->str
)) {
3422 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3427 * Remember this name globally, for the uniqueness of
3428 * all component names.
3430 if (bt_value_map_insert_entry(all_names
,
3431 name_gstr
->str
, bt_value_null
)) {
3432 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3437 * Remember this name specifically for the type of the
3438 * component. This is to create connection arguments.
3440 * The list takes ownership of `name_gstr`.
3443 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3444 source_names
= g_list_append(source_names
, name_gstr
);
3446 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3447 filter_names
= g_list_append(filter_names
, name_gstr
);
3449 case BT_COMPONENT_CLASS_TYPE_SINK
:
3450 sink_names
= g_list_append(sink_names
, name_gstr
);
3459 free(comp_cls_name
);
3462 comp_cls_name
= NULL
;
3466 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3468 * The current item is a component (--component option),
3469 * pass it directly to the run args.
3471 if (bt_value_array_append_string_element(run_args
,
3473 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3477 if (bt_value_array_append_string_element(run_args
, arg
)) {
3478 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3481 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3483 * The current item is a
3484 * non-option argument, record
3485 * it in `non_opt_params`.
3488 bt_value_array_append_element_status append_element_status
;
3489 uint64_t idx
= bt_value_array_get_length(non_opt_params
) - 1;
3491 array
= bt_value_array_borrow_element_by_index(non_opt_params
, idx
);
3493 append_element_status
= bt_value_array_append_string_element(array
, arg
);
3494 if (append_element_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3495 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3499 BT_CLI_LOGE_APPEND_CAUSE(
3500 "No current component (--component option) or non-option argument of which to set parameters:\n %s",
3506 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3507 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3508 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3512 if (bt_value_array_append_string_element(run_args
, arg
)) {
3513 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3516 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3517 uint64_t idx
= bt_value_array_get_length(non_opt_loglevels
) - 1;
3518 enum bt_value_array_set_element_by_index_status set_element_status
;
3519 bt_value
*log_level_str_value
;
3521 log_level_str_value
= bt_value_string_create_init(arg
);
3522 if (!log_level_str_value
) {
3523 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3527 set_element_status
=
3528 bt_value_array_set_element_by_index(non_opt_loglevels
,
3529 idx
, log_level_str_value
);
3530 bt_value_put_ref(log_level_str_value
);
3531 if (set_element_status
!= BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK
) {
3532 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3536 BT_CLI_LOGE_APPEND_CAUSE(
3537 "No current component (--component option) or non-option argument to assign a log level to:\n %s",
3543 case OPT_RETRY_DURATION
:
3544 if (bt_value_array_append_string_element(run_args
,
3545 "--retry-duration")) {
3546 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3550 if (bt_value_array_append_string_element(run_args
, arg
)) {
3551 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3556 case OPT_CLOCK_CYCLES
:
3557 case OPT_CLOCK_DATE
:
3558 case OPT_CLOCK_FORCE_CORRELATE
:
3560 case OPT_CLOCK_OFFSET
:
3561 case OPT_CLOCK_OFFSET_NS
:
3562 case OPT_CLOCK_SECONDS
:
3565 case OPT_DEBUG_INFO
:
3566 case OPT_DEBUG_INFO_DIR
:
3567 case OPT_DEBUG_INFO_FULL_PATH
:
3568 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3571 case OPT_INPUT_FORMAT
:
3574 case OPT_OUTPUT_FORMAT
:
3577 case OPT_RUN_ARGS_0
:
3578 case OPT_STREAM_INTERSECTION
:
3581 /* Ignore in this pass */
3584 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
3585 argpar_item_opt
->descr
->id
);
3588 } else if (argpar_item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
) {
3589 struct argpar_item_non_opt
*argpar_item_non_opt
;
3590 bt_value_array_append_element_status append_status
;
3592 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_NON_OPT
;
3594 argpar_item_non_opt
= (struct argpar_item_non_opt
*) argpar_item
;
3596 append_status
= bt_value_array_append_string_element(non_opts
,
3597 argpar_item_non_opt
->arg
);
3598 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3599 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3603 append_status
= bt_value_array_append_empty_array_element(
3604 non_opt_params
, NULL
);
3605 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3606 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3610 append_status
= bt_value_array_append_element(non_opt_loglevels
, bt_value_null
);
3611 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3612 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3621 * Second pass: transform the convert-specific options and
3622 * arguments into implicit component instances for the run
3625 for (i
= 0; i
< argpar_parse_ret
.items
->n_items
; i
++) {
3626 struct argpar_item
*argpar_item
=
3627 argpar_parse_ret
.items
->items
[i
];
3628 struct argpar_item_opt
*argpar_item_opt
;
3631 if (argpar_item
->type
!= ARGPAR_ITEM_TYPE_OPT
) {
3635 argpar_item_opt
= (struct argpar_item_opt
*) argpar_item
;
3636 arg
= argpar_item_opt
->arg
;
3638 switch (argpar_item_opt
->descr
->id
) {
3640 if (trimmer_has_begin
) {
3641 BT_CLI_LOGE_APPEND_CAUSE("At --begin option: --begin or --timerange option already specified\n %s\n",
3646 trimmer_has_begin
= true;
3647 ret
= append_implicit_component_extra_param(
3648 &implicit_trimmer_args
, "begin", arg
);
3649 implicit_trimmer_args
.exists
= true;
3655 if (trimmer_has_end
) {
3656 BT_CLI_LOGE_APPEND_CAUSE("At --end option: --end or --timerange option already specified\n %s\n",
3661 trimmer_has_end
= true;
3662 ret
= append_implicit_component_extra_param(
3663 &implicit_trimmer_args
, "end", arg
);
3664 implicit_trimmer_args
.exists
= true;
3674 if (trimmer_has_begin
|| trimmer_has_end
) {
3675 BT_CLI_LOGE_APPEND_CAUSE("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3680 ret
= split_timerange(arg
, &begin
, &end
);
3682 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3687 ret
= append_implicit_component_extra_param(
3688 &implicit_trimmer_args
, "begin", begin
);
3689 ret
|= append_implicit_component_extra_param(
3690 &implicit_trimmer_args
, "end", end
);
3691 implicit_trimmer_args
.exists
= true;
3699 case OPT_CLOCK_CYCLES
:
3700 append_implicit_component_param(
3701 &implicit_text_args
, "clock-cycles", "yes");
3702 implicit_text_args
.exists
= true;
3704 case OPT_CLOCK_DATE
:
3705 append_implicit_component_param(
3706 &implicit_text_args
, "clock-date", "yes");
3707 implicit_text_args
.exists
= true;
3709 case OPT_CLOCK_FORCE_CORRELATE
:
3710 ctf_fs_source_force_clock_class_unix_epoch_origin
= true;
3713 append_implicit_component_param(
3714 &implicit_text_args
, "clock-gmt", "yes");
3715 append_implicit_component_param(
3716 &implicit_trimmer_args
, "gmt", "yes");
3717 implicit_text_args
.exists
= true;
3719 case OPT_CLOCK_OFFSET
:
3720 if (ctf_fs_source_clock_class_offset_arg
) {
3721 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3725 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3726 if (!ctf_fs_source_clock_class_offset_arg
) {
3727 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3731 case OPT_CLOCK_OFFSET_NS
:
3732 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3733 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3737 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3738 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3739 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3743 case OPT_CLOCK_SECONDS
:
3744 append_implicit_component_param(
3745 &implicit_text_args
, "clock-seconds", "yes");
3746 implicit_text_args
.exists
= true;
3749 implicit_text_args
.exists
= true;
3750 ret
= append_implicit_component_extra_param(
3751 &implicit_text_args
, "color", arg
);
3756 case OPT_DEBUG_INFO
:
3757 implicit_debug_info_args
.exists
= true;
3759 case OPT_DEBUG_INFO_DIR
:
3760 implicit_debug_info_args
.exists
= true;
3761 ret
= append_implicit_component_extra_param(
3762 &implicit_debug_info_args
, "debug-info-dir", arg
);
3767 case OPT_DEBUG_INFO_FULL_PATH
:
3768 implicit_debug_info_args
.exists
= true;
3769 append_implicit_component_param(
3770 &implicit_debug_info_args
, "full-path", "yes");
3772 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3773 implicit_debug_info_args
.exists
= true;
3774 ret
= append_implicit_component_extra_param(
3775 &implicit_debug_info_args
,
3776 "target-prefix", arg
);
3783 bt_value
*fields
= fields_from_arg(arg
);
3789 implicit_text_args
.exists
= true;
3790 ret
= insert_flat_params_from_array(
3791 implicit_text_args
.params_arg
,
3793 bt_value_put_ref(fields
);
3801 bt_value
*names
= names_from_arg(arg
);
3807 implicit_text_args
.exists
= true;
3808 ret
= insert_flat_params_from_array(
3809 implicit_text_args
.params_arg
,
3811 bt_value_put_ref(names
);
3818 append_implicit_component_param(
3819 &implicit_text_args
, "no-delta", "yes");
3820 implicit_text_args
.exists
= true;
3822 case OPT_INPUT_FORMAT
:
3823 if (got_input_format_opt
) {
3824 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3828 got_input_format_opt
= true;
3830 if (strcmp(arg
, "ctf") == 0) {
3831 auto_source_discovery_restrict_plugin_name
= "ctf";
3832 auto_source_discovery_restrict_component_class_name
= "fs";
3833 } else if (strcmp(arg
, "lttng-live") == 0) {
3834 auto_source_discovery_restrict_plugin_name
= "ctf";
3835 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3836 implicit_lttng_live_args
.exists
= true;
3838 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
3843 case OPT_OUTPUT_FORMAT
:
3844 if (got_output_format_opt
) {
3845 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
3849 got_output_format_opt
= true;
3851 if (strcmp(arg
, "text") == 0) {
3852 implicit_text_args
.exists
= true;
3853 } else if (strcmp(arg
, "ctf") == 0) {
3854 implicit_ctf_output_args
.exists
= true;
3855 } else if (strcmp(arg
, "dummy") == 0) {
3856 implicit_dummy_args
.exists
= true;
3857 } else if (strcmp(arg
, "ctf-metadata") == 0) {
3858 print_ctf_metadata
= true;
3860 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
3867 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
3871 output
= strdup(arg
);
3873 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3878 if (print_run_args_0
) {
3879 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3883 print_run_args
= true;
3885 case OPT_RUN_ARGS_0
:
3886 if (print_run_args
) {
3887 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3891 print_run_args_0
= true;
3893 case OPT_STREAM_INTERSECTION
:
3895 * Applies to all traces implementing the
3896 * babeltrace.trace-infos query.
3898 stream_intersection_mode
= true;
3901 *default_log_level
=
3902 logging_level_min(*default_log_level
, BT_LOG_INFO
);
3905 *default_log_level
=
3906 logging_level_min(*default_log_level
, BT_LOG_TRACE
);
3913 set_auto_log_levels(default_log_level
);
3916 * Legacy behaviour: --verbose used to make the `text` output
3917 * format print more information. --verbose is now equivalent to
3918 * the INFO log level, which is why we compare to `BT_LOG_INFO`
3921 if (*default_log_level
== BT_LOG_INFO
) {
3922 append_implicit_component_param(&implicit_text_args
,
3926 /* Print CTF metadata or print LTTng live sessions */
3927 if (print_ctf_metadata
) {
3928 const bt_value
*bt_val_non_opt
;
3930 if (bt_value_array_is_empty(non_opts
)) {
3931 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
3935 if (bt_value_array_get_length(non_opts
) > 1) {
3936 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
3940 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
3945 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
3946 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
3947 bt_value_string_get(bt_val_non_opt
));
3951 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
3959 * If -o ctf was specified, make sure an output path (--output)
3960 * was also specified. --output does not imply -o ctf because
3961 * it's also used for the default, implicit -o text if -o ctf
3964 if (implicit_ctf_output_args
.exists
) {
3966 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
3971 * At this point we know that -o ctf AND --output were
3972 * specified. Make sure that no options were specified
3973 * which would imply -o text because --output would be
3974 * ambiguous in this case. For example, this is wrong:
3976 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
3978 * because --names=all implies -o text, and --output
3979 * could apply to both the sink.text.pretty and
3980 * sink.ctf.fs implicit components.
3982 if (implicit_text_args
.exists
) {
3983 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
3989 * If -o dummy and -o ctf were not specified, and if there are
3990 * no explicit sink components, then use an implicit
3991 * `sink.text.pretty` component.
3993 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
3995 implicit_text_args
.exists
= true;
3999 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4000 * `path` parameter if --output was specified.
4003 if (implicit_text_args
.exists
) {
4004 append_implicit_component_extra_param(&implicit_text_args
,
4006 } else if (implicit_ctf_output_args
.exists
) {
4007 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4012 /* Decide where the non-option argument(s) go */
4013 if (bt_value_array_get_length(non_opts
) > 0) {
4014 if (implicit_lttng_live_args
.exists
) {
4015 const bt_value
*bt_val_non_opt
;
4017 if (bt_value_array_get_length(non_opts
) > 1) {
4018 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
4022 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
4023 lttng_live_url_parts
=
4024 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt
),
4025 error_buf
, sizeof(error_buf
));
4026 if (!lttng_live_url_parts
.proto
) {
4027 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
4032 if (!lttng_live_url_parts
.session_name
) {
4033 /* Print LTTng live sessions */
4034 cfg
= bt_config_print_lttng_live_sessions_create(
4040 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4041 bt_value_string_get(bt_val_non_opt
));
4045 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4052 live_inputs_array_val
= bt_value_array_create();
4053 if (!live_inputs_array_val
) {
4054 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4058 if (bt_value_array_append_string_element(
4059 live_inputs_array_val
,
4060 bt_value_string_get(bt_val_non_opt
))) {
4061 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4065 ret
= append_parameter_to_args(
4066 implicit_lttng_live_args
.extra_params
,
4067 "inputs", live_inputs_array_val
);
4072 ret
= append_implicit_component_extra_param(
4073 &implicit_lttng_live_args
,
4074 "session-not-found-action", "end");
4080 size_t plugin_count
;
4081 const bt_plugin
**plugins
;
4082 const bt_plugin
*plugin
;
4084 status
= require_loaded_plugins(plugin_paths
);
4089 if (auto_source_discovery_restrict_plugin_name
) {
4091 plugin
= borrow_loaded_plugin_by_name(auto_source_discovery_restrict_plugin_name
);
4094 plugin_count
= get_loaded_plugins_count();
4095 plugins
= borrow_loaded_plugins();
4098 status
= auto_discover_source_components(non_opts
, plugins
, plugin_count
,
4099 auto_source_discovery_restrict_component_class_name
,
4100 *default_log_level
, &auto_disc
, interrupter
);
4103 if (status
== AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED
) {
4104 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
4105 "Babeltrace CLI", "Automatic source discovery interrupted by the user");
4110 status
= create_implicit_component_args_from_auto_discovered_sources(
4111 &auto_disc
, non_opts
, non_opt_params
, non_opt_loglevels
,
4112 discovered_source_args
);
4121 * If --clock-force-correlated was given, apply it to any src.ctf.fs
4124 if (ctf_fs_source_force_clock_class_unix_epoch_origin
) {
4127 n
= append_multiple_implicit_components_param(
4128 discovered_source_args
, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
4131 BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
4136 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4137 if (ctf_fs_source_clock_class_offset_arg
) {
4140 n
= append_multiple_implicit_components_param(
4141 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4142 ctf_fs_source_clock_class_offset_arg
);
4145 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4150 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4151 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4154 n
= append_multiple_implicit_components_param(
4155 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4156 ctf_fs_source_clock_class_offset_ns_arg
);
4159 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4165 * If the implicit `source.ctf.lttng-live` component exists,
4166 * make sure there's at least one non-option argument (which is
4169 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(non_opts
)) {
4170 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4171 implicit_lttng_live_args
.comp_arg
->str
);
4175 /* Assign names to implicit components */
4176 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4177 struct implicit_component_args
*args
;
4180 args
= discovered_source_args
->pdata
[i
];
4182 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4184 /* Give it a name like `auto-disc-src-ctf-fs`. */
4185 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4186 if (auto_disc_comp_name
->str
[j
] == '.') {
4187 auto_disc_comp_name
->str
[j
] = '-';
4191 ret
= assign_name_to_implicit_component(args
,
4192 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4198 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4199 "lttng-live", all_names
, &source_names
, true);
4204 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4205 "pretty", all_names
, &sink_names
, true);
4210 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4211 "sink-ctf-fs", all_names
, &sink_names
, true);
4216 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4217 "dummy", all_names
, &sink_names
, true);
4222 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4223 "muxer", all_names
, NULL
, false);
4228 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4229 "trimmer", all_names
, NULL
, false);
4234 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4235 "debug-info", all_names
, NULL
, false);
4240 /* Make sure there's at least one source and one sink */
4241 if (!source_names
) {
4242 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4247 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4251 /* Make sure there's a single sink component */
4252 if (g_list_length(sink_names
) != 1) {
4253 BT_CLI_LOGE_APPEND_CAUSE(
4254 "More than one sink component specified.");
4259 * Prepend the muxer, the trimmer, and the debug info to the
4260 * filter chain so that we have:
4262 * sources -> muxer -> [trimmer] -> [debug info] ->
4263 * [user filters] -> sinks
4265 if (implicit_debug_info_args
.exists
) {
4266 if (g_list_prepend_gstring(&filter_names
,
4267 implicit_debug_info_args
.name_arg
->str
)) {
4272 if (implicit_trimmer_args
.exists
) {
4273 if (g_list_prepend_gstring(&filter_names
,
4274 implicit_trimmer_args
.name_arg
->str
)) {
4279 if (g_list_prepend_gstring(&filter_names
,
4280 implicit_muxer_args
.name_arg
->str
)) {
4285 * Append the equivalent run arguments for the implicit
4288 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4289 struct implicit_component_args
*args
=
4290 discovered_source_args
->pdata
[i
];
4292 ret
= append_run_args_for_implicit_component(args
, run_args
);
4298 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4304 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4310 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4316 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4322 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4328 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4334 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4340 /* Auto-connect components */
4341 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4344 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4349 * We have all the run command arguments now. Depending on
4350 * --run-args, we pass this to the run command or print them
4353 if (print_run_args
|| print_run_args_0
) {
4354 uint64_t args_idx
, args_len
;
4355 if (stream_intersection_mode
) {
4356 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4360 args_len
= bt_value_array_get_length(run_args
);
4361 for (args_idx
= 0; args_idx
< args_len
; args_idx
++) {
4362 const bt_value
*arg_value
=
4363 bt_value_array_borrow_element_by_index(run_args
,
4366 GString
*quoted
= NULL
;
4367 const char *arg_to_print
;
4369 arg
= bt_value_string_get(arg_value
);
4371 if (print_run_args
) {
4372 quoted
= bt_common_shell_quote(arg
, true);
4377 arg_to_print
= quoted
->str
;
4382 printf("%s", arg_to_print
);
4385 g_string_free(quoted
, TRUE
);
4388 if (args_idx
< args_len
- 1) {
4389 if (print_run_args
) {
4398 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4402 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4403 plugin_paths
, *default_log_level
);
4408 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4413 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4416 argpar_parse_ret_fini(&argpar_parse_ret
);
4420 if (component_arg_for_run
) {
4421 g_string_free(component_arg_for_run
, TRUE
);
4425 g_string_free(name_gstr
, TRUE
);
4428 bt_value_put_ref(live_inputs_array_val
);
4429 bt_value_put_ref(run_args
);
4430 bt_value_put_ref(all_names
);
4431 destroy_glist_of_gstring(source_names
);
4432 destroy_glist_of_gstring(filter_names
);
4433 destroy_glist_of_gstring(sink_names
);
4434 bt_value_put_ref(non_opt_params
);
4435 bt_value_put_ref(non_opt_loglevels
);
4436 bt_value_put_ref(non_opts
);
4437 finalize_implicit_component_args(&implicit_ctf_output_args
);
4438 finalize_implicit_component_args(&implicit_lttng_live_args
);
4439 finalize_implicit_component_args(&implicit_dummy_args
);
4440 finalize_implicit_component_args(&implicit_text_args
);
4441 finalize_implicit_component_args(&implicit_debug_info_args
);
4442 finalize_implicit_component_args(&implicit_muxer_args
);
4443 finalize_implicit_component_args(&implicit_trimmer_args
);
4444 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4445 auto_source_discovery_fini(&auto_disc
);
4447 if (discovered_source_args
) {
4448 g_ptr_array_free(discovered_source_args
, TRUE
);
4451 g_free(ctf_fs_source_clock_class_offset_arg
);
4452 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4454 if (auto_disc_comp_name
) {
4455 g_string_free(auto_disc_comp_name
, TRUE
);
4462 * Prints the Babeltrace 2.x general usage.
4465 void print_gen_usage(FILE *fp
)
4467 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4469 fprintf(fp
, "General options:\n");
4471 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=T)\n");
4472 fprintf(fp
, " -h, --help Show this help and quit\n");
4473 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `T`, `D`,\n");
4474 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4475 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
4476 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
4477 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
4478 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
4479 fprintf(fp
, " dynamic plugins can be loaded\n");
4480 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4481 fprintf(fp
, " -V, --version Show version and quit\n");
4483 fprintf(fp
, "Available commands:\n");
4485 fprintf(fp
, " convert Convert and trim traces (default)\n");
4486 fprintf(fp
, " help Get help for a plugin or a component class\n");
4487 fprintf(fp
, " list-plugins List available plugins and their content\n");
4488 fprintf(fp
, " query Query objects from a component class\n");
4489 fprintf(fp
, " run Build a processing graph and run it\n");
4491 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4494 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4495 int *retcode
, bool omit_system_plugin_path
,
4496 bool omit_home_plugin_path
,
4497 const bt_value
*initial_plugin_paths
,
4498 const bt_interrupter
*interrupter
)
4500 struct bt_config
*config
= NULL
;
4503 const char **top_level_argv
;
4504 int command_argc
= -1;
4505 const char **command_argv
= NULL
;
4506 const char *command_name
= NULL
;
4507 int default_log_level
= -1;
4508 struct argpar_parse_ret argpar_parse_ret
= { 0 };
4509 bt_value
*plugin_paths
= NULL
;
4511 /* Top-level option descriptions. */
4512 static const struct argpar_opt_descr descrs
[] = {
4513 { OPT_DEBUG
, 'd', "debug", false },
4514 { OPT_HELP
, 'h', "help", false },
4515 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4516 { OPT_VERBOSE
, 'v', "verbose", false },
4517 { OPT_VERSION
, 'V', "version", false},
4518 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
4519 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
4520 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
4521 ARGPAR_OPT_DESCR_SENTINEL
4525 COMMAND_TYPE_NONE
= -1,
4526 COMMAND_TYPE_RUN
= 0,
4527 COMMAND_TYPE_CONVERT
,
4528 COMMAND_TYPE_LIST_PLUGINS
,
4531 } command_type
= COMMAND_TYPE_NONE
;
4535 if (!initial_plugin_paths
) {
4536 plugin_paths
= bt_value_array_create();
4537 if (!plugin_paths
) {
4541 bt_value_copy_status copy_status
= bt_value_copy(
4542 initial_plugin_paths
, &plugin_paths
);
4548 BT_ASSERT(plugin_paths
);
4551 * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
4552 * `--plugin-path` option's paths, so append it now before
4553 * parsing the general options.
4555 if (append_env_var_plugin_paths(plugin_paths
)) {
4562 print_gen_usage(stdout
);
4566 /* Skip first argument, the name of the program. */
4567 top_level_argc
= argc
- 1;
4568 top_level_argv
= argv
+ 1;
4569 argpar_parse_ret
= argpar_parse(top_level_argc
, top_level_argv
,
4572 if (argpar_parse_ret
.error
) {
4573 BT_CLI_LOGE_APPEND_CAUSE(
4574 "While parsing command-line arguments: %s",
4575 argpar_parse_ret
.error
);
4579 for (i
= 0; i
< argpar_parse_ret
.items
->n_items
; i
++) {
4580 struct argpar_item
*item
;
4582 item
= argpar_parse_ret
.items
->items
[i
];
4584 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
4585 struct argpar_item_opt
*item_opt
=
4586 (struct argpar_item_opt
*) item
;
4588 switch (item_opt
->descr
->id
) {
4591 logging_level_min(default_log_level
, BT_LOG_TRACE
);
4595 logging_level_min(default_log_level
, BT_LOG_INFO
);
4599 int level
= bt_log_get_level_from_string(item_opt
->arg
);
4602 BT_CLI_LOGE_APPEND_CAUSE(
4603 "Invalid argument for --log-level option:\n %s",
4609 logging_level_min(default_log_level
, level
);
4612 case OPT_PLUGIN_PATH
:
4613 if (bt_config_append_plugin_paths_check_setuid_setgid(
4614 plugin_paths
, item_opt
->arg
)) {
4618 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4619 omit_system_plugin_path
= true;
4621 case OPT_OMIT_HOME_PLUGIN_PATH
:
4622 omit_home_plugin_path
= true;
4628 print_gen_usage(stdout
);
4631 } else if (item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
) {
4632 struct argpar_item_non_opt
*item_non_opt
=
4633 (struct argpar_item_non_opt
*) item
;
4635 * First unknown argument: is it a known command
4639 top_level_argc
- item_non_opt
->orig_index
- 1;
4641 &top_level_argv
[item_non_opt
->orig_index
+ 1];
4643 if (strcmp(item_non_opt
->arg
, "convert") == 0) {
4644 command_type
= COMMAND_TYPE_CONVERT
;
4645 command_name
= "convert";
4646 } else if (strcmp(item_non_opt
->arg
, "list-plugins") == 0) {
4647 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4648 command_name
= "list-plugins";
4649 } else if (strcmp(item_non_opt
->arg
, "help") == 0) {
4650 command_type
= COMMAND_TYPE_HELP
;
4651 command_name
= "help";
4652 } else if (strcmp(item_non_opt
->arg
, "query") == 0) {
4653 command_type
= COMMAND_TYPE_QUERY
;
4654 command_name
= "query";
4655 } else if (strcmp(item_non_opt
->arg
, "run") == 0) {
4656 command_type
= COMMAND_TYPE_RUN
;
4657 command_name
= "run";
4660 * Non-option argument, but not a known
4661 * command name: assume the default
4662 * `convert` command.
4664 command_type
= COMMAND_TYPE_CONVERT
;
4665 command_name
= "convert";
4673 if (command_type
== COMMAND_TYPE_NONE
) {
4674 if (argpar_parse_ret
.ingested_orig_args
== top_level_argc
) {
4676 * We only got non-help, non-version general options
4677 * like --verbose and --debug, without any other
4678 * arguments, so we can't do anything useful: print the
4681 print_gen_usage(stdout
);
4686 * We stopped on an unknown option argument (and therefore
4687 * didn't see a command name). Assume `convert` command.
4689 command_type
= COMMAND_TYPE_CONVERT
;
4690 command_name
= "convert";
4692 top_level_argc
- argpar_parse_ret
.ingested_orig_args
;
4694 &top_level_argv
[argpar_parse_ret
.ingested_orig_args
];
4697 BT_ASSERT(command_argv
);
4698 BT_ASSERT(command_argc
>= 0);
4701 * For all commands other than `convert`, we now know the log level to
4702 * use, so we can apply it with `set_auto_log_levels`.
4704 * The convert command has `--debug` and `--verbose` arguments that are
4705 * equivalent to the top-level arguments of the same name. So after it
4706 * has parsed its arguments, `bt_config_convert_from_args` calls
4707 * `set_auto_log_levels` itself.
4709 if (command_type
!= COMMAND_TYPE_CONVERT
) {
4710 set_auto_log_levels(&default_log_level
);
4714 * At this point, `plugin_paths` contains the initial plugin
4715 * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
4716 * the paths from the `--plugin-path` option.
4718 * Now append the user and system plugin paths.
4720 if (append_home_and_system_plugin_paths(plugin_paths
,
4721 omit_system_plugin_path
, omit_home_plugin_path
)) {
4725 switch (command_type
) {
4726 case COMMAND_TYPE_RUN
:
4727 config
= bt_config_run_from_args(command_argc
, command_argv
,
4728 retcode
, plugin_paths
,
4731 case COMMAND_TYPE_CONVERT
:
4732 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4733 retcode
, plugin_paths
, &default_log_level
, interrupter
);
4735 case COMMAND_TYPE_LIST_PLUGINS
:
4736 config
= bt_config_list_plugins_from_args(command_argc
,
4737 command_argv
, retcode
, plugin_paths
);
4739 case COMMAND_TYPE_HELP
:
4740 config
= bt_config_help_from_args(command_argc
,
4741 command_argv
, retcode
, plugin_paths
,
4744 case COMMAND_TYPE_QUERY
:
4745 config
= bt_config_query_from_args(command_argc
,
4746 command_argv
, retcode
, plugin_paths
,
4754 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4755 config
->log_level
= default_log_level
;
4756 config
->command_name
= command_name
;
4765 argpar_parse_ret_fini(&argpar_parse_ret
);
4766 bt_value_put_ref(plugin_paths
);