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 "babeltrace2-cfg-cli-params-arg.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 /* INI-style parsing FSM states */
51 enum ini_parsing_fsm_state
{
52 /* Expect a map key (identifier) */
55 /* Expect an equal character ('=') */
61 /* Expect a comma character (',') */
65 /* INI-style parsing state variables */
66 struct ini_parsing_state
{
67 /* Lexical scanner (owned by this) */
70 /* Output map value object being filled (owned by this) */
73 /* Next expected FSM state */
74 enum ini_parsing_fsm_state expecting
;
76 /* Last decoded map key (owned by this) */
79 /* Complete INI-style string to parse (not owned by this) */
82 /* Error buffer (not owned by this) */
86 /* Offset option with "is set" boolean */
92 /* Legacy "ctf"/"lttng-live" format options */
93 struct ctf_legacy_opts
{
94 struct offset_opt offset_s
;
95 struct offset_opt offset_ns
;
96 bool stream_intersection
;
99 /* Legacy "text" format options */
100 struct text_legacy_opts
{
102 * output, dbg_info_dir, dbg_info_target_prefix, names,
103 * and fields are owned by this.
106 GString
*dbg_info_dir
;
107 GString
*dbg_info_target_prefix
;
108 const bt_value
*names
;
109 const bt_value
*fields
;
117 bool dbg_info_full_path
;
121 /* Legacy input format format */
122 enum legacy_input_format
{
123 LEGACY_INPUT_FORMAT_NONE
= 0,
124 LEGACY_INPUT_FORMAT_CTF
,
125 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
128 /* Legacy output format format */
129 enum legacy_output_format
{
130 LEGACY_OUTPUT_FORMAT_NONE
= 0,
131 LEGACY_OUTPUT_FORMAT_TEXT
,
132 LEGACY_OUTPUT_FORMAT_DUMMY
,
135 #define BT_CLI_LOGE_APPEND_CAUSE_OOM() BT_CLI_LOGE_APPEND_CAUSE("Out of memory.")
138 * Returns the plugin name, component class name, component class type,
139 * and component name from a command-line --component option's argument.
140 * arg must have the following format:
142 * [NAME:]TYPE.PLUGIN.CLS
144 * where NAME is the optional component name, TYPE is either `source`,
145 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
146 * component class name.
148 * On success, both *plugin and *component are not NULL. *plugin
149 * and *comp_cls are owned by the caller. On success, *name can be NULL
150 * if no component class name was found, and *comp_cls_type is set.
153 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
154 char **comp_cls
, bt_component_class_type
*comp_cls_type
)
156 const char *at
= arg
;
157 GString
*gs_name
= NULL
;
158 GString
*gs_comp_cls_type
= NULL
;
159 GString
*gs_plugin
= NULL
;
160 GString
*gs_comp_cls
= NULL
;
166 BT_ASSERT(comp_cls_type
);
168 if (!bt_common_string_is_printable(arg
)) {
169 BT_CLI_LOGE_APPEND_CAUSE("Argument contains a non-printable character.");
173 /* Parse the component name */
174 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
179 if (arg
[end_pos
] == ':') {
183 g_string_assign(gs_name
, "");
186 /* Parse the component class type */
187 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
188 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
189 BT_CLI_LOGE_APPEND_CAUSE("Missing component class type (`source`, `filter`, or `sink`).");
193 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
194 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
195 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
196 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
197 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
198 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
199 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
200 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
202 BT_CLI_LOGE_APPEND_CAUSE("Unknown component class type: `%s`.",
203 gs_comp_cls_type
->str
);
209 /* Parse the plugin name */
210 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
211 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
212 BT_CLI_LOGE_APPEND_CAUSE("Missing plugin or component class name.");
218 /* Parse the component class name */
219 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
220 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
221 BT_CLI_LOGE_APPEND_CAUSE("Missing component class name.");
225 if (at
[end_pos
] != '\0') {
226 /* Found a non-escaped `.` */
231 if (gs_name
->len
== 0) {
233 g_string_free(gs_name
, TRUE
);
235 *name
= gs_name
->str
;
236 g_string_free(gs_name
, FALSE
);
239 g_string_free(gs_name
, TRUE
);
242 *plugin
= gs_plugin
->str
;
243 *comp_cls
= gs_comp_cls
->str
;
244 g_string_free(gs_plugin
, FALSE
);
245 g_string_free(gs_comp_cls
, FALSE
);
261 g_string_free(gs_name
, TRUE
);
265 g_string_free(gs_plugin
, TRUE
);
269 g_string_free(gs_comp_cls
, TRUE
);
272 if (gs_comp_cls_type
) {
273 g_string_free(gs_comp_cls_type
, TRUE
);
280 * Prints the Babeltrace version.
283 void print_version(void)
285 if (GIT_VERSION
[0] == '\0') {
286 puts("Babeltrace " VERSION
);
288 puts("Babeltrace " VERSION
" - " GIT_VERSION
);
293 * Destroys a component configuration.
296 void bt_config_component_destroy(bt_object
*obj
)
298 struct bt_config_component
*bt_config_component
=
299 container_of(obj
, struct bt_config_component
, base
);
305 if (bt_config_component
->plugin_name
) {
306 g_string_free(bt_config_component
->plugin_name
, TRUE
);
309 if (bt_config_component
->comp_cls_name
) {
310 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
313 if (bt_config_component
->instance_name
) {
314 g_string_free(bt_config_component
->instance_name
, TRUE
);
317 BT_VALUE_PUT_REF_AND_RESET(bt_config_component
->params
);
318 g_free(bt_config_component
);
325 * Creates a component configuration using the given plugin name and
326 * component name. `plugin_name` and `comp_cls_name` are copied (belong
327 * to the return value).
329 * Return value is owned by the caller.
332 struct bt_config_component
*bt_config_component_create(
333 bt_component_class_type type
,
334 const char *plugin_name
, const char *comp_cls_name
,
337 struct bt_config_component
*cfg_component
= NULL
;
339 cfg_component
= g_new0(struct bt_config_component
, 1);
340 if (!cfg_component
) {
341 BT_CLI_LOGE_APPEND_CAUSE_OOM();
345 bt_object_init_shared(&cfg_component
->base
,
346 bt_config_component_destroy
);
347 cfg_component
->type
= type
;
348 cfg_component
->plugin_name
= g_string_new(plugin_name
);
349 if (!cfg_component
->plugin_name
) {
350 BT_CLI_LOGE_APPEND_CAUSE_OOM();
354 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
355 if (!cfg_component
->comp_cls_name
) {
356 BT_CLI_LOGE_APPEND_CAUSE_OOM();
360 cfg_component
->instance_name
= g_string_new(NULL
);
361 if (!cfg_component
->instance_name
) {
362 BT_CLI_LOGE_APPEND_CAUSE_OOM();
366 cfg_component
->log_level
= init_log_level
;
368 /* Start with empty parameters */
369 cfg_component
->params
= bt_value_map_create();
370 if (!cfg_component
->params
) {
371 BT_CLI_LOGE_APPEND_CAUSE_OOM();
378 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
381 return cfg_component
;
385 * Creates a component configuration from a command-line --component
389 struct bt_config_component
*bt_config_component_from_arg(const char *arg
,
392 struct bt_config_component
*cfg_comp
= NULL
;
394 char *plugin_name
= NULL
;
395 char *comp_cls_name
= NULL
;
396 bt_component_class_type type
;
398 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
399 if (!plugin_name
|| !comp_cls_name
) {
403 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
,
410 g_string_assign(cfg_comp
->instance_name
, name
);
416 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp
);
421 g_free(comp_cls_name
);
426 * Destroys a configuration.
429 void bt_config_destroy(bt_object
*obj
)
431 struct bt_config
*cfg
=
432 container_of(obj
, struct bt_config
, base
);
438 BT_VALUE_PUT_REF_AND_RESET(cfg
->plugin_paths
);
440 switch (cfg
->command
) {
441 case BT_CONFIG_COMMAND_RUN
:
442 if (cfg
->cmd_data
.run
.sources
) {
443 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
446 if (cfg
->cmd_data
.run
.filters
) {
447 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
450 if (cfg
->cmd_data
.run
.sinks
) {
451 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
454 if (cfg
->cmd_data
.run
.connections
) {
455 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
459 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
461 case BT_CONFIG_COMMAND_HELP
:
462 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.help
.cfg_component
);
464 case BT_CONFIG_COMMAND_QUERY
:
465 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.query
.cfg_component
);
467 if (cfg
->cmd_data
.query
.object
) {
468 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
471 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
472 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
473 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
476 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
480 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
481 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
483 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
486 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
501 void destroy_glist_of_gstring(GList
*list
)
509 for (at
= list
; at
; at
= g_list_next(at
)) {
510 g_string_free(at
->data
, TRUE
);
517 * Creates a simple lexical scanner for parsing comma-delimited names
520 * Return value is owned by the caller.
523 GScanner
*create_csv_identifiers_scanner(void)
526 GScannerConfig scanner_config
= {
527 .cset_skip_characters
= " \t\n",
528 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
529 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
530 .case_sensitive
= TRUE
,
531 .cpair_comment_single
= NULL
,
532 .skip_comment_multi
= TRUE
,
533 .skip_comment_single
= TRUE
,
534 .scan_comment_multi
= FALSE
,
535 .scan_identifier
= TRUE
,
536 .scan_identifier_1char
= TRUE
,
537 .scan_identifier_NULL
= FALSE
,
538 .scan_symbols
= FALSE
,
539 .symbol_2_token
= FALSE
,
540 .scope_0_fallback
= FALSE
,
541 .scan_binary
= FALSE
,
545 .scan_hex_dollar
= FALSE
,
546 .numbers_2_int
= FALSE
,
547 .int_2_float
= FALSE
,
548 .store_int64
= FALSE
,
549 .scan_string_sq
= FALSE
,
550 .scan_string_dq
= FALSE
,
551 .identifier_2_string
= FALSE
,
552 .char_2_token
= TRUE
,
555 scanner
= g_scanner_new(&scanner_config
);
557 BT_CLI_LOGE_APPEND_CAUSE_OOM();
564 * Converts a comma-delimited list of known names (--names option) to
565 * an array value object containing those names as string value objects.
567 * Return value is owned by the caller.
570 bt_value
*names_from_arg(const char *arg
)
572 GScanner
*scanner
= NULL
;
573 bt_value
*names
= NULL
;
574 bool found_all
= false, found_none
= false, found_item
= false;
576 names
= bt_value_array_create();
578 BT_CLI_LOGE_APPEND_CAUSE_OOM();
582 scanner
= create_csv_identifiers_scanner();
587 g_scanner_input_text(scanner
, arg
, strlen(arg
));
590 GTokenType token_type
= g_scanner_get_next_token(scanner
);
592 switch (token_type
) {
593 case G_TOKEN_IDENTIFIER
:
595 const char *identifier
= scanner
->value
.v_identifier
;
597 if (strcmp(identifier
, "payload") == 0 ||
598 strcmp(identifier
, "args") == 0 ||
599 strcmp(identifier
, "arg") == 0) {
601 if (bt_value_array_append_string_element(names
,
605 } else if (strcmp(identifier
, "context") == 0 ||
606 strcmp(identifier
, "ctx") == 0) {
608 if (bt_value_array_append_string_element(names
,
612 } else if (strcmp(identifier
, "scope") == 0 ||
613 strcmp(identifier
, "header") == 0) {
615 if (bt_value_array_append_string_element(names
,
619 } else if (strcmp(identifier
, "all") == 0) {
621 if (bt_value_array_append_string_element(names
,
625 } else if (strcmp(identifier
, "none") == 0) {
627 if (bt_value_array_append_string_element(names
,
632 BT_CLI_LOGE_APPEND_CAUSE("Unknown name: `%s`.",
648 if (found_none
&& found_all
) {
649 BT_CLI_LOGE_APPEND_CAUSE("Only either `all` or `none` can be specified in the list given to the --names option, but not both.");
653 * Legacy behavior is to clear the defaults (show none) when at
654 * least one item is specified.
656 if (found_item
&& !found_none
&& !found_all
) {
657 if (bt_value_array_append_string_element(names
, "none")) {
662 g_scanner_destroy(scanner
);
667 BT_VALUE_PUT_REF_AND_RESET(names
);
669 g_scanner_destroy(scanner
);
675 * Converts a comma-delimited list of known fields (--fields option) to
676 * an array value object containing those fields as string
679 * Return value is owned by the caller.
682 bt_value
*fields_from_arg(const char *arg
)
684 GScanner
*scanner
= NULL
;
687 fields
= bt_value_array_create();
689 BT_CLI_LOGE_APPEND_CAUSE_OOM();
693 scanner
= create_csv_identifiers_scanner();
698 g_scanner_input_text(scanner
, arg
, strlen(arg
));
701 GTokenType token_type
= g_scanner_get_next_token(scanner
);
703 switch (token_type
) {
704 case G_TOKEN_IDENTIFIER
:
706 const char *identifier
= scanner
->value
.v_identifier
;
708 if (strcmp(identifier
, "trace") == 0 ||
709 strcmp(identifier
, "trace:hostname") == 0 ||
710 strcmp(identifier
, "trace:domain") == 0 ||
711 strcmp(identifier
, "trace:procname") == 0 ||
712 strcmp(identifier
, "trace:vpid") == 0 ||
713 strcmp(identifier
, "loglevel") == 0 ||
714 strcmp(identifier
, "emf") == 0 ||
715 strcmp(identifier
, "callsite") == 0 ||
716 strcmp(identifier
, "all") == 0) {
717 if (bt_value_array_append_string_element(fields
,
722 BT_CLI_LOGE_APPEND_CAUSE("Unknown field: `%s`.",
740 BT_VALUE_PUT_REF_AND_RESET(fields
);
744 g_scanner_destroy(scanner
);
750 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
752 BT_ASSERT(params_arg
);
756 if (params_arg
->len
!= 0) {
757 g_string_append_c(params_arg
, ',');
760 g_string_append(params_arg
, key
);
761 g_string_append_c(params_arg
, '=');
762 g_string_append(params_arg
, value
);
766 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
767 * where the names are in names_array.
770 int insert_flat_params_from_array(GString
*params_arg
,
771 const bt_value
*names_array
, const char *prefix
)
775 GString
*tmpstr
= NULL
, *default_value
= NULL
;
776 bool default_set
= false, non_default_set
= false;
779 * names_array may be NULL if no CLI options were specified to
780 * trigger its creation.
786 tmpstr
= g_string_new(NULL
);
788 BT_CLI_LOGE_APPEND_CAUSE_OOM();
793 default_value
= g_string_new(NULL
);
794 if (!default_value
) {
795 BT_CLI_LOGE_APPEND_CAUSE_OOM();
800 for (i
= 0; i
< bt_value_array_get_length(names_array
); i
++) {
801 const bt_value
*str_obj
=
802 bt_value_array_borrow_element_by_index_const(names_array
,
805 bool is_default
= false;
808 BT_CLI_LOGE_APPEND_CAUSE("Unexpected error.");
813 suffix
= bt_value_string_get(str_obj
);
815 g_string_assign(tmpstr
, prefix
);
816 g_string_append(tmpstr
, "-");
818 /* Special-case for "all" and "none". */
819 if (strcmp(suffix
, "all") == 0) {
821 g_string_assign(default_value
, "show");
822 } else if (strcmp(suffix
, "none") == 0) {
824 g_string_assign(default_value
, "hide");
828 g_string_append(tmpstr
, "default");
829 append_param_arg(params_arg
, tmpstr
->str
,
832 non_default_set
= true;
833 g_string_append(tmpstr
, suffix
);
834 append_param_arg(params_arg
, tmpstr
->str
, "yes");
838 /* Implicit field-default=hide if any non-default option is set. */
839 if (non_default_set
&& !default_set
) {
840 g_string_assign(tmpstr
, prefix
);
841 g_string_append(tmpstr
, "-default");
842 g_string_assign(default_value
, "hide");
843 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
848 g_string_free(default_value
, TRUE
);
852 g_string_free(tmpstr
, TRUE
);
865 OPT_CLOCK_FORCE_CORRELATE
,
876 OPT_DEBUG_INFO_FULL_PATH
,
877 OPT_DEBUG_INFO_TARGET_PREFIX
,
886 OPT_OMIT_HOME_PLUGIN_PATH
,
887 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
892 OPT_RESET_BASE_PARAMS
,
896 OPT_STREAM_INTERSECTION
,
902 enum bt_config_component_dest
{
903 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
904 BT_CONFIG_COMPONENT_DEST_SOURCE
,
905 BT_CONFIG_COMPONENT_DEST_FILTER
,
906 BT_CONFIG_COMPONENT_DEST_SINK
,
910 * Adds a configuration component to the appropriate configuration
911 * array depending on the destination.
914 void add_run_cfg_comp(struct bt_config
*cfg
,
915 struct bt_config_component
*cfg_comp
,
916 enum bt_config_component_dest dest
)
918 bt_object_get_ref(cfg_comp
);
921 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
922 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
924 case BT_CONFIG_COMPONENT_DEST_FILTER
:
925 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
927 case BT_CONFIG_COMPONENT_DEST_SINK
:
928 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
936 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
937 struct bt_config_component
*cfg_comp
,
938 enum bt_config_component_dest dest
,
939 bt_value
*instance_names
)
943 if (cfg_comp
->instance_name
->len
== 0) {
944 BT_CLI_LOGE_APPEND_CAUSE("Found an unnamed component.");
949 if (bt_value_map_has_entry(instance_names
,
950 cfg_comp
->instance_name
->str
)) {
951 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
952 cfg_comp
->instance_name
->str
);
957 if (bt_value_map_insert_entry(instance_names
,
958 cfg_comp
->instance_name
->str
, bt_value_null
)) {
959 BT_CLI_LOGE_APPEND_CAUSE_OOM();
964 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
971 int append_env_var_plugin_paths(bt_value
*plugin_paths
)
976 if (bt_common_is_setuid_setgid()) {
977 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
981 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
986 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
990 BT_CLI_LOGE_APPEND_CAUSE("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH.");
997 int append_home_and_system_plugin_paths(bt_value
*plugin_paths
,
998 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
1002 if (!omit_home_plugin_path
) {
1003 if (bt_common_is_setuid_setgid()) {
1004 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1006 char *home_plugin_dir
= bt_common_get_home_plugin_path(
1007 BT_LOG_OUTPUT_LEVEL
);
1009 if (home_plugin_dir
) {
1010 ret
= bt_config_append_plugin_paths(
1011 plugin_paths
, home_plugin_dir
);
1012 free(home_plugin_dir
);
1015 BT_CLI_LOGE_APPEND_CAUSE("Invalid home plugin path.");
1022 if (!omit_system_plugin_path
) {
1023 if (bt_config_append_plugin_paths(plugin_paths
,
1024 bt_common_get_system_plugin_path())) {
1025 BT_CLI_LOGE_APPEND_CAUSE("Invalid system plugin path.");
1031 BT_CLI_LOGE_APPEND_CAUSE("Cannot append home and system plugin paths.");
1036 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1037 const bt_value
*plugin_paths
, bool needs_plugins
)
1039 struct bt_config
*cfg
;
1042 cfg
= g_new0(struct bt_config
, 1);
1044 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1048 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1049 cfg
->command
= command
;
1050 cfg
->command_needs_plugins
= needs_plugins
;
1053 bt_value
*plugin_paths_copy
;
1055 (void) bt_value_copy(plugin_paths
,
1056 &plugin_paths_copy
);
1057 cfg
->plugin_paths
= plugin_paths_copy
;
1059 cfg
->plugin_paths
= bt_value_array_create();
1060 if (!cfg
->plugin_paths
) {
1061 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1069 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1076 struct bt_config
*bt_config_run_create(const bt_value
*plugin_paths
)
1078 struct bt_config
*cfg
;
1081 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1082 plugin_paths
, true);
1087 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1088 (GDestroyNotify
) bt_object_put_ref
);
1089 if (!cfg
->cmd_data
.run
.sources
) {
1090 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1094 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1095 (GDestroyNotify
) bt_object_put_ref
);
1096 if (!cfg
->cmd_data
.run
.filters
) {
1097 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1101 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1102 (GDestroyNotify
) bt_object_put_ref
);
1103 if (!cfg
->cmd_data
.run
.sinks
) {
1104 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1108 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1109 (GDestroyNotify
) bt_config_connection_destroy
);
1110 if (!cfg
->cmd_data
.run
.connections
) {
1111 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1118 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1125 struct bt_config
*bt_config_list_plugins_create(const bt_value
*plugin_paths
)
1127 return bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1128 plugin_paths
, true);
1132 struct bt_config
*bt_config_help_create(const bt_value
*plugin_paths
,
1133 int default_log_level
)
1135 struct bt_config
*cfg
;
1138 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1139 plugin_paths
, true);
1144 cfg
->cmd_data
.help
.cfg_component
=
1145 bt_config_component_create(-1, NULL
, NULL
, default_log_level
);
1146 if (!cfg
->cmd_data
.help
.cfg_component
) {
1153 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1160 struct bt_config
*bt_config_query_create(const bt_value
*plugin_paths
)
1162 struct bt_config
*cfg
;
1165 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1166 plugin_paths
, true);
1171 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1172 if (!cfg
->cmd_data
.query
.object
) {
1173 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1180 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1187 struct bt_config
*bt_config_print_ctf_metadata_create(
1188 const bt_value
*plugin_paths
)
1190 struct bt_config
*cfg
;
1193 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1194 plugin_paths
, true);
1199 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1200 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1201 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1205 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1206 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1207 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1214 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1221 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1222 const bt_value
*plugin_paths
)
1224 struct bt_config
*cfg
;
1227 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1228 plugin_paths
, true);
1233 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1234 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1235 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1239 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1241 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1242 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1249 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1256 int bt_config_append_plugin_paths_check_setuid_setgid(
1257 bt_value
*plugin_paths
, const char *arg
)
1261 if (bt_common_is_setuid_setgid()) {
1262 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1266 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1267 BT_CLI_LOGE_APPEND_CAUSE("Invalid --plugin-path option's argument:\n %s",
1278 * Prints the expected format for a --params option.
1281 void print_expected_params_format(FILE *fp
)
1283 fprintf(fp
, "Expected format of PARAMS\n");
1284 fprintf(fp
, "-------------------------\n");
1286 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1288 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1289 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1290 fprintf(fp
, "and VALUE can be one of:\n");
1292 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1293 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1294 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1295 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1296 fprintf(fp
, " (`0x` prefix) unsigned (with `+` prefix) or signed 64-bit integer.\n");
1297 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1298 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1299 fprintf(fp
, " the null and boolean value symbols above.\n");
1300 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1301 fprintf(fp
, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
1302 fprintf(fp
, " (as described by the current list) and a closing `]`.\n");
1303 fprintf(fp
, "* Map, formatted as an opening `{`, a comma-separated list of PARAM=VALUE\n");
1304 fprintf(fp
, " assignments and a closing `}`.\n");
1306 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1308 fprintf(fp
, "Example:\n");
1310 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1311 fprintf(fp
, " play=+23, observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1312 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\",\n");
1313 fprintf(fp
, " things=[1, \"2\", 3]\n");
1315 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1316 fprintf(fp
, "babeltrace2 from a shell.\n");
1320 bool help_option_is_specified(
1321 const struct bt_argpar_parse_ret
*argpar_parse_ret
)
1324 bool specified
= false;
1326 for (i
= 0; i
< argpar_parse_ret
->items
->len
; i
++) {
1327 struct bt_argpar_item
*argpar_item
=
1328 g_ptr_array_index(argpar_parse_ret
->items
, i
);
1329 struct bt_argpar_item_opt
*argpar_item_opt
;
1331 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
1335 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1336 if (argpar_item_opt
->descr
->id
== OPT_HELP
) {
1346 * Prints the help command usage.
1349 void print_help_usage(FILE *fp
)
1351 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1352 fprintf(fp
, " babeltrace2 [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1354 fprintf(fp
, "Options:\n");
1356 fprintf(fp
, " -h, --help Show this help and quit\n");
1358 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1360 fprintf(fp
, "Use `babeltrace2 list-plugins` to show the list of available plugins.\n");
1364 const struct bt_argpar_opt_descr help_options
[] = {
1365 /* id, short_name, long_name, with_arg */
1366 { OPT_HELP
, 'h', "help", false },
1367 BT_ARGPAR_OPT_DESCR_SENTINEL
1371 * Creates a Babeltrace config object from the arguments of a help
1374 * *retcode is set to the appropriate exit code to use.
1377 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
1378 int *retcode
, const bt_value
*plugin_paths
,
1379 int default_log_level
)
1381 struct bt_config
*cfg
= NULL
;
1382 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1383 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1384 struct bt_argpar_item_non_opt
*non_opt
;
1385 GString
*substring
= NULL
;
1389 cfg
= bt_config_help_create(plugin_paths
, default_log_level
);
1395 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, help_options
, true);
1396 if (argpar_parse_ret
.error
) {
1397 BT_CLI_LOGE_APPEND_CAUSE(
1398 "While parsing `help` command's command-line arguments: %s",
1399 argpar_parse_ret
.error
->str
);
1403 if (help_option_is_specified(&argpar_parse_ret
)) {
1404 print_help_usage(stdout
);
1406 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1410 if (argpar_parse_ret
.items
->len
== 0) {
1411 BT_CLI_LOGE_APPEND_CAUSE(
1412 "Missing plugin name or component class descriptor.");
1414 } else if (argpar_parse_ret
.items
->len
> 1) {
1416 * At this point we know there are least two non-option
1417 * arguments because we don't reach here with `--help`,
1420 non_opt
= argpar_parse_ret
.items
->pdata
[1];
1421 BT_CLI_LOGE_APPEND_CAUSE(
1422 "Extraneous command-line argument specified to `help` command: `%s`.",
1427 non_opt
= argpar_parse_ret
.items
->pdata
[0];
1429 /* Look for unescaped dots in the argument. */
1430 substring
= bt_common_string_until(non_opt
->arg
, ".\\", ".", &end_pos
);
1432 BT_CLI_LOGE_APPEND_CAUSE("Could not consume argument: arg=%s",
1437 if (end_pos
== strlen(non_opt
->arg
)) {
1438 /* Didn't find an unescaped dot, treat it as a plugin name. */
1439 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1443 * Found an unescaped dot, treat it as a component class name.
1445 plugin_comp_cls_names(non_opt
->arg
, NULL
, &plugin_name
, &comp_cls_name
,
1446 &cfg
->cmd_data
.help
.cfg_component
->type
);
1447 if (!plugin_name
|| !comp_cls_name
) {
1448 BT_CLI_LOGE_APPEND_CAUSE(
1449 "Could not parse argument as a component class name: arg=%s",
1454 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1456 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1464 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1467 g_free(plugin_name
);
1468 g_free(comp_cls_name
);
1471 g_string_free(substring
, TRUE
);
1474 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1480 * Prints the help command usage.
1483 void print_query_usage(FILE *fp
)
1485 fprintf(fp
, "Usage: babeltrace2 [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1487 fprintf(fp
, "Options:\n");
1489 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS (see the expected\n");
1490 fprintf(fp
, " format of PARAMS below)\n");
1491 fprintf(fp
, " -h, --help Show this help and quit\n");
1492 fprintf(fp
, "\n\n");
1493 print_expected_params_format(fp
);
1497 const struct bt_argpar_opt_descr query_options
[] = {
1498 /* id, short_name, long_name, with_arg */
1499 { OPT_HELP
, 'h', "help", false },
1500 { OPT_PARAMS
, 'p', "params", true },
1501 BT_ARGPAR_OPT_DESCR_SENTINEL
1505 * Creates a Babeltrace config object from the arguments of a query
1508 * *retcode is set to the appropriate exit code to use.
1511 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1512 int *retcode
, const bt_value
*plugin_paths
,
1513 int default_log_level
)
1516 struct bt_config
*cfg
= NULL
;
1517 const char *component_class_spec
= NULL
;
1518 const char *query_object
= NULL
;
1520 GString
*error_str
= NULL
;
1521 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1523 params
= bt_value_null
;
1524 bt_value_get_ref(bt_value_null
);
1527 cfg
= bt_config_query_create(plugin_paths
);
1532 error_str
= g_string_new(NULL
);
1534 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1539 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, query_options
, true);
1540 if (argpar_parse_ret
.error
) {
1541 BT_CLI_LOGE_APPEND_CAUSE(
1542 "While parsing `query` command's command-line arguments: %s",
1543 argpar_parse_ret
.error
->str
);
1547 if (help_option_is_specified(&argpar_parse_ret
)) {
1548 print_query_usage(stdout
);
1550 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1554 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1555 struct bt_argpar_item
*argpar_item
=
1556 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1558 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
1559 struct bt_argpar_item_opt
*argpar_item_opt
=
1560 (struct bt_argpar_item_opt
*) argpar_item
;
1561 const char *arg
= argpar_item_opt
->arg
;
1563 switch (argpar_item_opt
->descr
->id
) {
1566 bt_value_put_ref(params
);
1567 params
= cli_value_from_arg(arg
, error_str
);
1569 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1576 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1577 argpar_item_opt
->descr
->id
);
1581 struct bt_argpar_item_non_opt
*argpar_item_non_opt
1582 = (struct bt_argpar_item_non_opt
*) argpar_item
;
1585 * We need exactly two non-option arguments
1586 * which are the mandatory component class
1587 * specification and query object.
1589 if (!component_class_spec
) {
1590 component_class_spec
= argpar_item_non_opt
->arg
;
1591 } else if (!query_object
) {
1592 query_object
= argpar_item_non_opt
->arg
;
1594 BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
1595 argpar_item_non_opt
->arg
);
1601 if (!component_class_spec
|| !query_object
) {
1602 print_query_usage(stdout
);
1604 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1608 cfg
->cmd_data
.query
.cfg_component
=
1609 bt_config_component_from_arg(component_class_spec
,
1611 if (!cfg
->cmd_data
.query
.cfg_component
) {
1612 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1613 component_class_spec
);
1618 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
1620 if (strlen(query_object
) == 0) {
1621 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1625 g_string_assign(cfg
->cmd_data
.query
.object
, query_object
);
1630 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1633 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1636 g_string_free(error_str
, TRUE
);
1639 bt_value_put_ref(params
);
1644 * Prints the list-plugins command usage.
1647 void print_list_plugins_usage(FILE *fp
)
1649 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1651 fprintf(fp
, "Options:\n");
1653 fprintf(fp
, " -h, --help Show this help and quit\n");
1655 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1657 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1661 const struct bt_argpar_opt_descr list_plugins_options
[] = {
1662 /* id, short_name, long_name, with_arg */
1663 { OPT_HELP
, 'h', "help", false },
1664 BT_ARGPAR_OPT_DESCR_SENTINEL
1668 * Creates a Babeltrace config object from the arguments of a
1669 * list-plugins command.
1671 * *retcode is set to the appropriate exit code to use.
1674 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
1675 int *retcode
, const bt_value
*plugin_paths
)
1677 struct bt_config
*cfg
= NULL
;
1678 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1681 cfg
= bt_config_list_plugins_create(plugin_paths
);
1687 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, list_plugins_options
, true);
1688 if (argpar_parse_ret
.error
) {
1689 BT_CLI_LOGE_APPEND_CAUSE(
1690 "While parsing `list-plugins` command's command-line arguments: %s",
1691 argpar_parse_ret
.error
->str
);
1695 if (help_option_is_specified(&argpar_parse_ret
)) {
1696 print_list_plugins_usage(stdout
);
1698 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1702 if (argpar_parse_ret
.items
->len
> 0) {
1704 * At this point we know there's at least one non-option
1705 * argument because we don't reach here with `--help`,
1708 struct bt_argpar_item_non_opt
*non_opt
=
1709 argpar_parse_ret
.items
->pdata
[0];
1711 BT_CLI_LOGE_APPEND_CAUSE(
1712 "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
1721 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1724 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1730 * Prints the run command usage.
1733 void print_run_usage(FILE *fp
)
1735 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1737 fprintf(fp
, "Options:\n");
1739 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1740 fprintf(fp
, " for all the following components until\n");
1741 fprintf(fp
, " --reset-base-params is encountered\n");
1742 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1743 fprintf(fp
, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
1744 fprintf(fp
, " Instantiate the component class CLS of type\n");
1745 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1746 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1747 fprintf(fp
, " and name it NAME");
1748 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1749 fprintf(fp
, " expected format of CONNECTION below)\n");
1750 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1751 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
1752 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1753 fprintf(fp
, " current component (see the expected format\n");
1754 fprintf(fp
, " of PARAMS below)\n");
1755 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1756 fprintf(fp
, " empty map\n");
1757 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1758 fprintf(fp
, " the graph later, retry in DUR µs\n");
1759 fprintf(fp
, " (default: 100000)\n");
1760 fprintf(fp
, " -h, --help Show this help and quit\n");
1762 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1763 fprintf(fp
, "\n\n");
1764 fprintf(fp
, "Expected format of CONNECTION\n");
1765 fprintf(fp
, "-----------------------------\n");
1767 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1769 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1770 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1771 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
1772 fprintf(fp
, "component using the NAME prefix of the --component option.\n");
1774 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1775 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1776 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1778 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1779 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1780 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1781 fprintf(fp
, "DOWNSTREAM.\n");
1783 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1784 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1785 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1787 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1788 fprintf(fp
, "can connect a filter component to a sink component.\n");
1790 fprintf(fp
, "Examples:\n");
1792 fprintf(fp
, " my-src:my-sink\n");
1793 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1795 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1796 fprintf(fp
, "babeltrace2 from a shell.\n");
1797 fprintf(fp
, "\n\n");
1798 print_expected_params_format(fp
);
1802 * Creates a Babeltrace config object from the arguments of a run
1805 * *retcode is set to the appropriate exit code to use.
1808 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
1809 int *retcode
, const bt_value
*plugin_paths
,
1810 int default_log_level
)
1812 struct bt_config_component
*cur_cfg_comp
= NULL
;
1813 bt_value
*cur_base_params
= NULL
;
1815 struct bt_config
*cfg
= NULL
;
1816 bt_value
*instance_names
= NULL
;
1817 bt_value
*connection_args
= NULL
;
1818 char error_buf
[256] = { 0 };
1819 long retry_duration
= -1;
1820 bt_value_map_extend_status extend_status
;
1821 GString
*error_str
= NULL
;
1822 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1825 static const struct bt_argpar_opt_descr run_options
[] = {
1826 { OPT_BASE_PARAMS
, 'b', "base-params", true },
1827 { OPT_COMPONENT
, 'c', "component", true },
1828 { OPT_CONNECT
, 'x', "connect", true },
1829 { OPT_HELP
, 'h', "help", false },
1830 { OPT_LOG_LEVEL
, 'l', "log-level", true },
1831 { OPT_PARAMS
, 'p', "params", true },
1832 { OPT_RESET_BASE_PARAMS
, 'r', "reset-base-params", false },
1833 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
1834 BT_ARGPAR_OPT_DESCR_SENTINEL
1839 error_str
= g_string_new(NULL
);
1841 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1846 print_run_usage(stdout
);
1851 cfg
= bt_config_run_create(plugin_paths
);
1856 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1857 cur_base_params
= bt_value_map_create();
1858 if (!cur_base_params
) {
1859 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1863 instance_names
= bt_value_map_create();
1864 if (!instance_names
) {
1865 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1869 connection_args
= bt_value_array_create();
1870 if (!connection_args
) {
1871 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1876 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, run_options
, true);
1877 if (argpar_parse_ret
.error
) {
1878 BT_CLI_LOGE_APPEND_CAUSE(
1879 "While parsing `run` command's command-line arguments: %s",
1880 argpar_parse_ret
.error
->str
);
1884 if (help_option_is_specified(&argpar_parse_ret
)) {
1885 print_run_usage(stdout
);
1887 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1891 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1892 struct bt_argpar_item
*argpar_item
=
1893 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1894 struct bt_argpar_item_opt
*argpar_item_opt
;
1897 /* This command does not accept non-option arguments.*/
1898 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
1899 struct bt_argpar_item_non_opt
*argpar_nonopt_item
=
1900 (struct bt_argpar_item_non_opt
*) argpar_item
;
1902 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
1903 argpar_nonopt_item
->arg
);
1907 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1908 arg
= argpar_item_opt
->arg
;
1910 switch (argpar_item_opt
->descr
->id
) {
1913 enum bt_config_component_dest dest
;
1915 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
1916 cur_cfg_comp
= bt_config_component_from_arg(arg
,
1918 if (!cur_cfg_comp
) {
1919 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
1924 switch (cur_cfg_comp
->type
) {
1925 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1926 dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
1928 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1929 dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
1931 case BT_COMPONENT_CLASS_TYPE_SINK
:
1932 dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
1938 BT_ASSERT(cur_base_params
);
1939 bt_value_put_ref(cur_cfg_comp
->params
);
1940 if (bt_value_copy(cur_base_params
,
1941 &cur_cfg_comp
->params
) < 0) {
1942 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1946 ret
= add_run_cfg_comp_check_name(cfg
,
1958 bt_value
*params_to_set
;
1960 if (!cur_cfg_comp
) {
1961 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
1966 params
= cli_value_from_arg(arg
, error_str
);
1968 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1973 extend_status
= bt_value_map_extend(
1974 cur_cfg_comp
->params
, params
, ¶ms_to_set
);
1975 BT_VALUE_PUT_REF_AND_RESET(params
);
1976 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
1977 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
1982 BT_OBJECT_MOVE_REF(cur_cfg_comp
->params
, params_to_set
);
1986 if (!cur_cfg_comp
) {
1987 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
1992 cur_cfg_comp
->log_level
=
1993 bt_log_get_level_from_string(arg
);
1994 if (cur_cfg_comp
->log_level
< 0) {
1995 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
2000 case OPT_BASE_PARAMS
:
2002 bt_value
*params
= cli_value_from_arg(arg
, error_str
);
2005 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
2010 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
2013 case OPT_RESET_BASE_PARAMS
:
2014 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2015 cur_base_params
= bt_value_map_create();
2016 if (!cur_base_params
) {
2017 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2022 if (bt_value_array_append_string_element(
2023 connection_args
, arg
)) {
2024 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2028 case OPT_RETRY_DURATION
: {
2030 size_t arg_len
= strlen(argpar_item_opt
->arg
);
2032 retry_duration
= g_ascii_strtoll(argpar_item_opt
->arg
, &end
, 10);
2034 if (arg_len
== 0 || end
!= (argpar_item_opt
->arg
+ arg_len
)) {
2035 BT_CLI_LOGE_APPEND_CAUSE(
2036 "Could not parse --retry-duration option's argument as an unsigned integer: `%s`",
2037 argpar_item_opt
->arg
);
2041 if (retry_duration
< 0) {
2042 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2047 cfg
->cmd_data
.run
.retry_duration_us
=
2048 (uint64_t) retry_duration
;
2052 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
2053 argpar_item_opt
->descr
->id
);
2058 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2060 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2061 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2065 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2066 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2070 ret
= bt_config_cli_args_create_connections(cfg
,
2074 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2082 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2086 g_string_free(error_str
, TRUE
);
2089 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
2090 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2091 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2092 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2093 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2098 struct bt_config
*bt_config_run_from_args_array(const bt_value
*run_args
,
2099 int *retcode
, const bt_value
*plugin_paths
,
2100 int default_log_level
)
2102 struct bt_config
*cfg
= NULL
;
2105 const size_t argc
= bt_value_array_get_length(run_args
);
2107 argv
= calloc(argc
, sizeof(*argv
));
2109 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2113 len
= bt_value_array_get_length(run_args
);
2115 BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
2118 for (i
= 0; i
< len
; i
++) {
2119 const bt_value
*arg_value
=
2120 bt_value_array_borrow_element_by_index_const(run_args
,
2124 BT_ASSERT(arg_value
);
2125 arg
= bt_value_string_get(arg_value
);
2130 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2131 plugin_paths
, default_log_level
);
2139 * Prints the convert command usage.
2142 void print_convert_usage(FILE *fp
)
2144 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2146 fprintf(fp
, "Options:\n");
2148 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2149 fprintf(fp
, " Instantiate the component class CLS of type\n");
2150 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2151 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2152 fprintf(fp
, " conversion graph, and optionally name it\n");
2153 fprintf(fp
, " NAME\n");
2154 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2155 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
2156 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2157 fprintf(fp
, " current component (see the expected format\n");
2158 fprintf(fp
, " of PARAMS below)\n");
2159 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2160 fprintf(fp
, " the graph later, retry in DUR µs\n");
2161 fprintf(fp
, " (default: 100000)\n");
2162 fprintf(fp
, " dynamic plugins can be loaded\n");
2163 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2164 fprintf(fp
, " `run` command to the standard output,\n");
2165 fprintf(fp
, " formatted for a shell, and quit\n");
2166 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2167 fprintf(fp
, " `run` command to the standard output,\n");
2168 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2169 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2170 fprintf(fp
, " are active\n");
2171 fprintf(fp
, " -h, --help Show this help and quit\n");
2173 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2175 fprintf(fp
, " --clock-force-correlate Force the origin of all clocks\n");
2176 fprintf(fp
, " to the Unix epoch\n");
2177 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2178 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2180 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2182 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2183 fprintf(fp
, " --clock-date Print timestamp dates\n");
2184 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2185 fprintf(fp
, " time zone instead of the local time zone\n");
2186 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2187 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2188 fprintf(fp
, " --color=(never | auto | always)\n");
2189 fprintf(fp
, " Never, automatically, or always emit\n");
2190 fprintf(fp
, " console color codes\n");
2191 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2192 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2193 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2194 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2195 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2196 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2197 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2198 fprintf(fp
, " (or `ctx`)\n");
2199 fprintf(fp
, " --no-delta Do not print time delta between\n");
2200 fprintf(fp
, " consecutive events\n");
2201 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2202 fprintf(fp
, " the standard output\n");
2204 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2206 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2207 fprintf(fp
, " time range to BEGIN (see the format of\n");
2208 fprintf(fp
, " BEGIN below)\n");
2209 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2210 fprintf(fp
, " range to END (see the format of END below)\n");
2211 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2212 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2213 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2215 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2217 fprintf(fp
, " --debug-info Create an implicit\n");
2218 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2219 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2220 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2221 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2222 fprintf(fp
, " binary paths instead of just names\n");
2223 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2224 fprintf(fp
, " Use directory DIR as a prefix when\n");
2225 fprintf(fp
, " looking up executables during debug\n");
2226 fprintf(fp
, " info analysis\n");
2228 fprintf(fp
, "Legacy options that still work:\n");
2230 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2231 fprintf(fp
, " `ctf`:\n");
2232 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2233 fprintf(fp
, " component\n");
2234 fprintf(fp
, " `lttng-live`:\n");
2235 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2236 fprintf(fp
, " component\n");
2237 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2238 fprintf(fp
, " `text`:\n");
2239 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2240 fprintf(fp
, " component\n");
2241 fprintf(fp
, " `ctf`:\n");
2242 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2243 fprintf(fp
, " component\n");
2244 fprintf(fp
, " `dummy`:\n");
2245 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2246 fprintf(fp
, " component\n");
2247 fprintf(fp
, " `ctf-metadata`:\n");
2248 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2249 fprintf(fp
, " for metadata text and quit\n");
2251 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2252 fprintf(fp
, "\n\n");
2253 fprintf(fp
, "Format of BEGIN and END\n");
2254 fprintf(fp
, "-----------------------\n");
2256 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2257 fprintf(fp
, "\n\n");
2258 print_expected_params_format(fp
);
2262 const struct bt_argpar_opt_descr convert_options
[] = {
2263 /* id, short_name, long_name, with_arg */
2264 { OPT_BEGIN
, 'b', "begin", true },
2265 { OPT_CLOCK_CYCLES
, '\0', "clock-cycles", false },
2266 { OPT_CLOCK_DATE
, '\0', "clock-date", false },
2267 { OPT_CLOCK_FORCE_CORRELATE
, '\0', "clock-force-correlate", false },
2268 { OPT_CLOCK_GMT
, '\0', "clock-gmt", false },
2269 { OPT_CLOCK_OFFSET
, '\0', "clock-offset", true },
2270 { OPT_CLOCK_OFFSET_NS
, '\0', "clock-offset-ns", true },
2271 { OPT_CLOCK_SECONDS
, '\0', "clock-seconds", false },
2272 { OPT_COLOR
, '\0', "color", true },
2273 { OPT_COMPONENT
, 'c', "component", true },
2274 { OPT_DEBUG
, 'd', "debug", false },
2275 { OPT_DEBUG_INFO_DIR
, '\0', "debug-info-dir", true },
2276 { OPT_DEBUG_INFO_FULL_PATH
, '\0', "debug-info-full-path", false },
2277 { OPT_DEBUG_INFO_TARGET_PREFIX
, '\0', "debug-info-target-prefix", true },
2278 { OPT_END
, 'e', "end", true },
2279 { OPT_FIELDS
, 'f', "fields", true },
2280 { OPT_HELP
, 'h', "help", false },
2281 { OPT_INPUT_FORMAT
, 'i', "input-format", true },
2282 { OPT_LOG_LEVEL
, 'l', "log-level", true },
2283 { OPT_NAMES
, 'n', "names", true },
2284 { OPT_DEBUG_INFO
, '\0', "debug-info", false },
2285 { OPT_NO_DELTA
, '\0', "no-delta", false },
2286 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
2287 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
2288 { OPT_OUTPUT
, 'w', "output", true },
2289 { OPT_OUTPUT_FORMAT
, 'o', "output-format", true },
2290 { OPT_PARAMS
, 'p', "params", true },
2291 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
2292 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
2293 { OPT_RUN_ARGS
, '\0', "run-args", false },
2294 { OPT_RUN_ARGS_0
, '\0', "run-args-0", false },
2295 { OPT_STREAM_INTERSECTION
, '\0', "stream-intersection", false },
2296 { OPT_TIMERANGE
, '\0', "timerange", true },
2297 { OPT_VERBOSE
, 'v', "verbose", false },
2298 BT_ARGPAR_OPT_DESCR_SENTINEL
2302 GString
*get_component_auto_name(const char *prefix
,
2303 const bt_value
*existing_names
)
2306 GString
*auto_name
= g_string_new(NULL
);
2309 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2313 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2314 g_string_assign(auto_name
, prefix
);
2319 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2321 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2327 struct implicit_component_args
{
2330 /* The component class name (e.g. src.ctf.fs). */
2333 /* The component instance name. */
2336 GString
*params_arg
;
2337 bt_value
*extra_params
;
2341 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2342 const char *prefix
, bt_value
*existing_names
,
2343 GList
**comp_names
, bool append_to_comp_names
)
2346 GString
*name
= NULL
;
2348 if (!args
->exists
) {
2352 name
= get_component_auto_name(prefix
,
2360 g_string_assign(args
->name_arg
, name
->str
);
2362 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2364 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2369 if (append_to_comp_names
) {
2370 *comp_names
= g_list_append(*comp_names
, name
);
2376 g_string_free(name
, TRUE
);
2383 int append_run_args_for_implicit_component(
2384 struct implicit_component_args
*impl_args
,
2389 GString
*component_arg_for_run
= NULL
;
2391 if (!impl_args
->exists
) {
2395 component_arg_for_run
= g_string_new(NULL
);
2396 if (!component_arg_for_run
) {
2397 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2401 /* Build the full `name:type.plugin.cls`. */
2402 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, '\\'));
2403 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, ':'));
2404 g_string_printf(component_arg_for_run
, "%s:%s",
2405 impl_args
->name_arg
->str
, impl_args
->comp_arg
->str
);
2407 if (bt_value_array_append_string_element(run_args
, "--component")) {
2408 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2412 if (bt_value_array_append_string_element(run_args
,
2413 component_arg_for_run
->str
)) {
2414 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2418 if (impl_args
->params_arg
->len
> 0) {
2419 if (bt_value_array_append_string_element(run_args
, "--params")) {
2420 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2424 if (bt_value_array_append_string_element(run_args
,
2425 impl_args
->params_arg
->str
)) {
2426 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2431 for (i
= 0; i
< bt_value_array_get_length(impl_args
->extra_params
);
2433 const bt_value
*elem
;
2436 elem
= bt_value_array_borrow_element_by_index(impl_args
->extra_params
,
2442 BT_ASSERT(bt_value_is_string(elem
));
2443 arg
= bt_value_string_get(elem
);
2444 ret
= bt_value_array_append_string_element(run_args
, arg
);
2446 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2457 if (component_arg_for_run
) {
2458 g_string_free(component_arg_for_run
, TRUE
);
2464 /* Free the fields of a `struct implicit_component_args`. */
2467 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2471 if (args
->comp_arg
) {
2472 g_string_free(args
->comp_arg
, TRUE
);
2475 if (args
->name_arg
) {
2476 g_string_free(args
->name_arg
, TRUE
);
2479 if (args
->params_arg
) {
2480 g_string_free(args
->params_arg
, TRUE
);
2483 bt_value_put_ref(args
->extra_params
);
2486 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2489 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2491 finalize_implicit_component_args(args
);
2495 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2498 int init_implicit_component_args(struct implicit_component_args
*args
,
2499 const char *comp_arg
, bool exists
)
2503 args
->exists
= exists
;
2504 args
->comp_arg
= g_string_new(comp_arg
);
2505 args
->name_arg
= g_string_new(NULL
);
2506 args
->params_arg
= g_string_new(NULL
);
2507 args
->extra_params
= bt_value_array_create();
2509 if (!args
->comp_arg
|| !args
->name_arg
||
2510 !args
->params_arg
|| !args
->extra_params
) {
2512 finalize_implicit_component_args(args
);
2513 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2521 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2524 struct implicit_component_args
*create_implicit_component_args(
2525 const char *comp_arg
)
2527 struct implicit_component_args
*args
;
2530 args
= g_new(struct implicit_component_args
, 1);
2532 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2536 status
= init_implicit_component_args(args
, comp_arg
, true);
2547 void append_implicit_component_param(struct implicit_component_args
*args
,
2548 const char *key
, const char *value
)
2553 append_param_arg(args
->params_arg
, key
, value
);
2557 * Append the given parameter (`key=value`) to all component specifications
2558 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2559 * which match `comp_arg`.
2561 * Return the number of matching components.
2565 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2566 const char *comp_arg
, const char *key
, const char *value
)
2571 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2572 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2574 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2575 append_implicit_component_param(args
, key
, value
);
2583 /* Escape value to make it suitable to use as a string parameter value. */
2585 gchar
*escape_string_value(const char *value
)
2590 ret
= g_string_new(NULL
);
2592 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2601 g_string_append_c(ret
, '\\');
2605 g_string_append_c(ret
, *in
);
2611 return g_string_free(ret
, FALSE
);
2615 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2621 switch (bt_value_get_type(value
)) {
2622 case BT_VALUE_TYPE_STRING
:
2624 const char *str_value
= bt_value_string_get(value
);
2625 gchar
*escaped_str_value
;
2627 escaped_str_value
= escape_string_value(str_value
);
2628 if (!escaped_str_value
) {
2632 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2634 g_free(escaped_str_value
);
2637 case BT_VALUE_TYPE_ARRAY
: {
2638 g_string_append_c(buf
, '[');
2639 uint64_t sz
= bt_value_array_get_length(value
);
2640 for (uint64_t i
= 0; i
< sz
; i
++) {
2641 const bt_value
*item
;
2645 g_string_append(buf
, ", ");
2648 item
= bt_value_array_borrow_element_by_index_const(
2650 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2656 g_string_append_c(buf
, ']');
2670 * Convert `value` to its equivalent representation as a command line parameter
2675 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2678 gchar
*result
= NULL
;
2680 buf
= g_string_new(NULL
);
2682 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2686 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2690 result
= g_string_free(buf
, FALSE
);
2697 g_string_free(buf
, TRUE
);
2705 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2708 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2713 gchar
*str_value
= NULL
;
2714 GString
*parameter
= NULL
;
2716 if (bt_value_array_append_string_element(args
, "--params")) {
2717 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2722 str_value
= bt_value_to_cli_param_value(value
);
2728 parameter
= g_string_new(NULL
);
2730 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2735 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2737 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2738 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2745 g_string_free(parameter
, TRUE
);
2758 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2760 bt_value
*str_value
;
2763 str_value
= bt_value_string_create_init(value
);
2766 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2771 ret
= append_parameter_to_args(args
, key
, str_value
);
2774 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2779 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2780 const char *key
, const char *value
)
2782 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2786 * Escapes `.`, `:`, and `\` of `input` with `\`.
2789 GString
*escape_dot_colon(const char *input
)
2791 GString
*output
= g_string_new(NULL
);
2795 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2799 for (ch
= input
; *ch
!= '\0'; ch
++) {
2800 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
2801 g_string_append_c(output
, '\\');
2804 g_string_append_c(output
, *ch
);
2812 * Appends a --connect option to a list of arguments. `upstream_name`
2813 * and `downstream_name` are escaped with escape_dot_colon() in this
2817 int append_connect_arg(bt_value
*run_args
,
2818 const char *upstream_name
, const char *downstream_name
)
2821 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
2822 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
2823 GString
*arg
= g_string_new(NULL
);
2825 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
2826 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2831 ret
= bt_value_array_append_string_element(run_args
, "--connect");
2833 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2838 g_string_append(arg
, e_upstream_name
->str
);
2839 g_string_append_c(arg
, ':');
2840 g_string_append(arg
, e_downstream_name
->str
);
2841 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
2843 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2850 g_string_free(arg
, TRUE
);
2853 if (e_upstream_name
) {
2854 g_string_free(e_upstream_name
, TRUE
);
2857 if (e_downstream_name
) {
2858 g_string_free(e_downstream_name
, TRUE
);
2865 * Appends the run command's --connect options for the convert command.
2868 int convert_auto_connect(bt_value
*run_args
,
2869 GList
*source_names
, GList
*filter_names
,
2873 GList
*source_at
= source_names
;
2874 GList
*filter_at
= filter_names
;
2876 GList
*sink_at
= sink_names
;
2878 BT_ASSERT(source_names
);
2879 BT_ASSERT(filter_names
);
2880 BT_ASSERT(sink_names
);
2882 /* Connect all sources to the first filter */
2883 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
2884 GString
*source_name
= source_at
->data
;
2885 GString
*filter_name
= filter_at
->data
;
2887 ret
= append_connect_arg(run_args
, source_name
->str
,
2894 filter_prev
= filter_at
;
2895 filter_at
= g_list_next(filter_at
);
2897 /* Connect remaining filters */
2898 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
2899 GString
*filter_name
= filter_at
->data
;
2900 GString
*filter_prev_name
= filter_prev
->data
;
2902 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
2909 /* Connect last filter to all sinks */
2910 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
2911 GString
*filter_name
= filter_prev
->data
;
2912 GString
*sink_name
= sink_at
->data
;
2914 ret
= append_connect_arg(run_args
, filter_name
->str
,
2931 int split_timerange(const char *arg
, char **begin
, char **end
)
2934 const char *ch
= arg
;
2936 GString
*g_begin
= NULL
;
2937 GString
*g_end
= NULL
;
2945 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
2946 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
2952 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
2953 if (!g_end
|| g_end
->len
== 0) {
2959 *begin
= g_begin
->str
;
2961 g_string_free(g_begin
, FALSE
);
2962 g_string_free(g_end
, FALSE
);
2972 g_string_free(g_begin
, TRUE
);
2976 g_string_free(g_end
, TRUE
);
2983 int g_list_prepend_gstring(GList
**list
, const char *string
)
2986 GString
*gs
= g_string_new(string
);
2991 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2995 *list
= g_list_prepend(*list
, gs
);
3002 * Create `struct implicit_component_args` structures for each of the
3003 * source components we identified. Add them to `component_args`.
3005 * `non_opts` is an array of the non-option arguments passed on the command
3008 * `non_opt_params` is an array where each element is an array of
3009 * strings containing all the arguments to `--params` that apply to the
3010 * non-option argument at the same index. For example, if, for a
3011 * non-option argument, the following `--params` options applied:
3013 * --params=a=2 --params=b=3,c=4
3015 * its entry in `non_opt_params` would contain
3017 * ["a=2", "b=3,c=4"]
3021 int create_implicit_component_args_from_auto_discovered_sources(
3022 const struct auto_source_discovery
*auto_disc
,
3023 const bt_value
*non_opts
,
3024 const bt_value
*non_opt_params
,
3025 const bt_value
*non_opt_loglevels
,
3026 GPtrArray
*component_args
)
3028 gchar
*cc_name
= NULL
;
3029 struct implicit_component_args
*comp
= NULL
;
3033 len
= auto_disc
->results
->len
;
3035 for (i
= 0; i
< len
; i
++) {
3036 struct auto_source_discovery_result
*res
=
3037 g_ptr_array_index(auto_disc
->results
, i
);
3038 uint64_t orig_indices_i
, orig_indices_count
;
3041 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3043 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3047 comp
= create_implicit_component_args(cc_name
);
3053 * Append parameters and log levels of all the
3054 * non-option arguments that contributed to this
3055 * component instance coming into existence.
3057 orig_indices_count
= bt_value_array_get_length(res
->original_input_indices
);
3058 for (orig_indices_i
= 0; orig_indices_i
< orig_indices_count
; orig_indices_i
++) {
3059 const bt_value
*orig_idx_value
=
3060 bt_value_array_borrow_element_by_index(
3061 res
->original_input_indices
, orig_indices_i
);
3062 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3063 const bt_value
*params_array
=
3064 bt_value_array_borrow_element_by_index_const(
3065 non_opt_params
, orig_idx
);
3066 uint64_t params_i
, params_count
;
3067 const bt_value
*loglevel_value
;
3069 params_count
= bt_value_array_get_length(params_array
);
3070 for (params_i
= 0; params_i
< params_count
; params_i
++) {
3071 const bt_value
*params_value
=
3072 bt_value_array_borrow_element_by_index_const(
3073 params_array
, params_i
);
3074 const char *params
= bt_value_string_get(params_value
);
3075 bt_value_array_append_element_status append_status
;
3077 append_status
= bt_value_array_append_string_element(
3078 comp
->extra_params
, "--params");
3079 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3080 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3084 append_status
= bt_value_array_append_string_element(
3085 comp
->extra_params
, params
);
3086 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3087 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3092 loglevel_value
= bt_value_array_borrow_element_by_index_const(
3093 non_opt_loglevels
, orig_idx
);
3094 if (bt_value_get_type(loglevel_value
) == BT_VALUE_TYPE_STRING
) {
3095 const char *loglevel
= bt_value_string_get(loglevel_value
);
3096 bt_value_array_append_element_status append_status
;
3098 append_status
= bt_value_array_append_string_element(
3099 comp
->extra_params
, "--log-level");
3100 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3101 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3105 append_status
= bt_value_array_append_string_element(
3106 comp
->extra_params
, loglevel
);
3107 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3108 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3115 * If single input and a src.ctf.fs component, provide the
3116 * relative path from the path passed on the command line to the
3119 if (bt_value_array_get_length(res
->inputs
) == 1 &&
3120 strcmp(res
->plugin_name
, "ctf") == 0 &&
3121 strcmp(res
->source_cc_name
, "fs") == 0) {
3122 const bt_value
*orig_idx_value
=
3123 bt_value_array_borrow_element_by_index(
3124 res
->original_input_indices
, 0);
3125 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3126 const bt_value
*non_opt_value
=
3127 bt_value_array_borrow_element_by_index_const(
3128 non_opts
, orig_idx
);
3129 const char *non_opt
= bt_value_string_get(non_opt_value
);
3130 const bt_value
*input_value
=
3131 bt_value_array_borrow_element_by_index_const(
3133 const char *input
= bt_value_string_get(input_value
);
3135 BT_ASSERT(orig_indices_count
== 1);
3136 BT_ASSERT(g_str_has_prefix(input
, non_opt
));
3138 input
+= strlen(non_opt
);
3140 while (G_IS_DIR_SEPARATOR(*input
)) {
3144 if (strlen(input
) > 0) {
3145 append_string_parameter_to_args(comp
->extra_params
,
3146 "trace-name", input
);
3150 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3155 g_ptr_array_add(component_args
, comp
);
3169 destroy_implicit_component_args(comp
);
3176 * As we iterate the arguments to the convert command, this tracks what is the
3177 * type of the current item, to which some contextual options (e.g. --params)
3180 enum convert_current_item_type
{
3181 /* There is no current item. */
3182 CONVERT_CURRENT_ITEM_TYPE_NONE
,
3184 /* Current item is a component. */
3185 CONVERT_CURRENT_ITEM_TYPE_COMPONENT
,
3187 /* Current item is a non-option argument. */
3188 CONVERT_CURRENT_ITEM_TYPE_NON_OPT
,
3192 * Creates a Babeltrace config object from the arguments of a convert
3195 * *retcode is set to the appropriate exit code to use.
3198 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3199 int *retcode
, const bt_value
*plugin_paths
,
3200 int *default_log_level
, const bt_interrupter
*interrupter
)
3202 enum convert_current_item_type current_item_type
=
3203 CONVERT_CURRENT_ITEM_TYPE_NONE
;
3205 struct bt_config
*cfg
= NULL
;
3206 bool got_input_format_opt
= false;
3207 bool got_output_format_opt
= false;
3208 bool trimmer_has_begin
= false;
3209 bool trimmer_has_end
= false;
3210 bool stream_intersection_mode
= false;
3211 bool print_run_args
= false;
3212 bool print_run_args_0
= false;
3213 bool print_ctf_metadata
= false;
3214 bt_value
*run_args
= NULL
;
3215 bt_value
*all_names
= NULL
;
3216 GList
*source_names
= NULL
;
3217 GList
*filter_names
= NULL
;
3218 GList
*sink_names
= NULL
;
3219 bt_value
*non_opts
= NULL
;
3220 bt_value
*non_opt_params
= NULL
;
3221 bt_value
*non_opt_loglevels
= NULL
;
3222 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3223 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3224 struct implicit_component_args implicit_dummy_args
= { 0 };
3225 struct implicit_component_args implicit_text_args
= { 0 };
3226 struct implicit_component_args implicit_debug_info_args
= { 0 };
3227 struct implicit_component_args implicit_muxer_args
= { 0 };
3228 struct implicit_component_args implicit_trimmer_args
= { 0 };
3229 char error_buf
[256] = { 0 };
3231 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3232 char *output
= NULL
;
3233 struct auto_source_discovery auto_disc
= { NULL
};
3234 GString
*auto_disc_comp_name
= NULL
;
3235 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
3236 GString
*name_gstr
= NULL
;
3237 GString
*component_arg_for_run
= NULL
;
3238 bt_value
*live_inputs_array_val
= NULL
;
3241 * Array of `struct implicit_component_args *` created for the sources
3242 * we have auto-discovered.
3244 GPtrArray
*discovered_source_args
= NULL
;
3247 * If set, restrict automatic source discovery to this component class
3250 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3251 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3253 bool ctf_fs_source_force_clock_class_unix_epoch_origin
= false;
3254 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3255 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3259 print_convert_usage(stdout
);
3264 if (init_implicit_component_args(&implicit_ctf_output_args
,
3265 "sink.ctf.fs", false)) {
3269 if (init_implicit_component_args(&implicit_lttng_live_args
,
3270 "source.ctf.lttng-live", false)) {
3274 if (init_implicit_component_args(&implicit_text_args
,
3275 "sink.text.pretty", false)) {
3279 if (init_implicit_component_args(&implicit_dummy_args
,
3280 "sink.utils.dummy", false)) {
3284 if (init_implicit_component_args(&implicit_debug_info_args
,
3285 "filter.lttng-utils.debug-info", false)) {
3289 if (init_implicit_component_args(&implicit_muxer_args
,
3290 "filter.utils.muxer", true)) {
3294 if (init_implicit_component_args(&implicit_trimmer_args
,
3295 "filter.utils.trimmer", false)) {
3299 all_names
= bt_value_map_create();
3301 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3305 run_args
= bt_value_array_create();
3307 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3311 component_arg_for_run
= g_string_new(NULL
);
3312 if (!component_arg_for_run
) {
3313 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3317 non_opts
= bt_value_array_create();
3319 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3323 non_opt_params
= bt_value_array_create();
3324 if (!non_opt_params
) {
3325 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3329 non_opt_loglevels
= bt_value_array_create();
3330 if (!non_opt_loglevels
) {
3331 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3335 if (auto_source_discovery_init(&auto_disc
) != 0) {
3339 discovered_source_args
=
3340 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3341 if (!discovered_source_args
) {
3342 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3346 auto_disc_comp_name
= g_string_new(NULL
);
3347 if (!auto_disc_comp_name
) {
3348 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3353 * First pass: collect all arguments which need to be passed
3354 * as is to the run command. This pass can also add --name
3355 * arguments if needed to automatically name unnamed component
3358 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, convert_options
, true);
3359 if (argpar_parse_ret
.error
) {
3360 BT_CLI_LOGE_APPEND_CAUSE(
3361 "While parsing `convert` command's command-line arguments: %s",
3362 argpar_parse_ret
.error
->str
);
3366 if (help_option_is_specified(&argpar_parse_ret
)) {
3367 print_convert_usage(stdout
);
3369 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3373 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3374 struct bt_argpar_item
*argpar_item
=
3375 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3376 struct bt_argpar_item_opt
*argpar_item_opt
;
3378 char *plugin_name
= NULL
;
3379 char *comp_cls_name
= NULL
;
3382 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
3383 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3384 arg
= argpar_item_opt
->arg
;
3386 switch (argpar_item_opt
->descr
->id
) {
3389 bt_component_class_type type
;
3391 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_COMPONENT
;
3393 /* Parse the argument */
3394 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3395 &comp_cls_name
, &type
);
3396 if (!plugin_name
|| !comp_cls_name
) {
3397 BT_CLI_LOGE_APPEND_CAUSE(
3398 "Invalid format for --component option's argument:\n %s",
3405 * Name was given by the user, verify it isn't
3408 if (bt_value_map_has_entry(all_names
, name
)) {
3409 BT_CLI_LOGE_APPEND_CAUSE(
3410 "Duplicate component instance name:\n %s",
3415 name_gstr
= g_string_new(name
);
3417 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3421 g_string_assign(component_arg_for_run
, arg
);
3423 /* Name not given by user, generate one. */
3424 name_gstr
= get_component_auto_name(arg
, all_names
);
3429 g_string_printf(component_arg_for_run
, "%s:%s",
3430 name_gstr
->str
, arg
);
3433 if (bt_value_array_append_string_element(run_args
,
3435 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3439 if (bt_value_array_append_string_element(run_args
,
3440 component_arg_for_run
->str
)) {
3441 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3446 * Remember this name globally, for the uniqueness of
3447 * all component names.
3449 if (bt_value_map_insert_entry(all_names
,
3450 name_gstr
->str
, bt_value_null
)) {
3451 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3456 * Remember this name specifically for the type of the
3457 * component. This is to create connection arguments.
3459 * The list takes ownership of `name_gstr`.
3462 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3463 source_names
= g_list_append(source_names
, name_gstr
);
3465 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3466 filter_names
= g_list_append(filter_names
, name_gstr
);
3468 case BT_COMPONENT_CLASS_TYPE_SINK
:
3469 sink_names
= g_list_append(sink_names
, name_gstr
);
3478 free(comp_cls_name
);
3481 comp_cls_name
= NULL
;
3485 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3487 * The current item is a component (--component option),
3488 * pass it directly to the run args.
3490 if (bt_value_array_append_string_element(run_args
,
3492 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3496 if (bt_value_array_append_string_element(run_args
, arg
)) {
3497 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3500 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3502 * The current item is a
3503 * non-option argument, record
3504 * it in `non_opt_params`.
3507 bt_value_array_append_element_status append_element_status
;
3508 uint64_t idx
= bt_value_array_get_length(non_opt_params
) - 1;
3510 array
= bt_value_array_borrow_element_by_index(non_opt_params
, idx
);
3512 append_element_status
= bt_value_array_append_string_element(array
, arg
);
3513 if (append_element_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3514 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3518 BT_CLI_LOGE_APPEND_CAUSE(
3519 "No current component (--component option) or non-option argument of which to set parameters:\n %s",
3525 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3526 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3527 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3531 if (bt_value_array_append_string_element(run_args
, arg
)) {
3532 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3535 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3536 uint64_t idx
= bt_value_array_get_length(non_opt_loglevels
) - 1;
3537 bt_value
*log_level_str_value
;
3539 log_level_str_value
= bt_value_string_create_init(arg
);
3540 if (!log_level_str_value
) {
3541 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3545 if (bt_value_array_set_element_by_index(non_opt_loglevels
, idx
,
3546 log_level_str_value
)) {
3547 bt_value_put_ref(log_level_str_value
);
3548 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3552 BT_CLI_LOGE_APPEND_CAUSE(
3553 "No current component (--component option) or non-option argument to assign a log level to:\n %s",
3559 case OPT_RETRY_DURATION
:
3560 if (bt_value_array_append_string_element(run_args
,
3561 "--retry-duration")) {
3562 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3566 if (bt_value_array_append_string_element(run_args
, arg
)) {
3567 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3572 case OPT_CLOCK_CYCLES
:
3573 case OPT_CLOCK_DATE
:
3574 case OPT_CLOCK_FORCE_CORRELATE
:
3576 case OPT_CLOCK_OFFSET
:
3577 case OPT_CLOCK_OFFSET_NS
:
3578 case OPT_CLOCK_SECONDS
:
3581 case OPT_DEBUG_INFO
:
3582 case OPT_DEBUG_INFO_DIR
:
3583 case OPT_DEBUG_INFO_FULL_PATH
:
3584 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3587 case OPT_INPUT_FORMAT
:
3590 case OPT_OUTPUT_FORMAT
:
3593 case OPT_RUN_ARGS_0
:
3594 case OPT_STREAM_INTERSECTION
:
3597 /* Ignore in this pass */
3600 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
3601 argpar_item_opt
->descr
->id
);
3604 } else if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
3605 struct bt_argpar_item_non_opt
*argpar_item_non_opt
;
3606 bt_value_array_append_element_status append_status
;
3608 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_NON_OPT
;
3610 argpar_item_non_opt
= (struct bt_argpar_item_non_opt
*) argpar_item
;
3612 append_status
= bt_value_array_append_string_element(non_opts
,
3613 argpar_item_non_opt
->arg
);
3614 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3615 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3619 append_status
= bt_value_array_append_empty_array_element(
3620 non_opt_params
, NULL
);
3621 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3622 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3626 append_status
= bt_value_array_append_element(non_opt_loglevels
, bt_value_null
);
3627 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3628 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3637 * Second pass: transform the convert-specific options and
3638 * arguments into implicit component instances for the run
3641 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3642 struct bt_argpar_item
*argpar_item
=
3643 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3644 struct bt_argpar_item_opt
*argpar_item_opt
;
3647 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
3651 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3652 arg
= argpar_item_opt
->arg
;
3654 switch (argpar_item_opt
->descr
->id
) {
3656 if (trimmer_has_begin
) {
3657 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
3662 trimmer_has_begin
= true;
3663 ret
= append_implicit_component_extra_param(
3664 &implicit_trimmer_args
, "begin", arg
);
3665 implicit_trimmer_args
.exists
= true;
3671 if (trimmer_has_end
) {
3672 printf("At --end option: --end or --timerange option already specified\n %s\n",
3677 trimmer_has_end
= true;
3678 ret
= append_implicit_component_extra_param(
3679 &implicit_trimmer_args
, "end", arg
);
3680 implicit_trimmer_args
.exists
= true;
3690 if (trimmer_has_begin
|| trimmer_has_end
) {
3691 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3696 ret
= split_timerange(arg
, &begin
, &end
);
3698 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3703 ret
= append_implicit_component_extra_param(
3704 &implicit_trimmer_args
, "begin", begin
);
3705 ret
|= append_implicit_component_extra_param(
3706 &implicit_trimmer_args
, "end", end
);
3707 implicit_trimmer_args
.exists
= true;
3715 case OPT_CLOCK_CYCLES
:
3716 append_implicit_component_param(
3717 &implicit_text_args
, "clock-cycles", "yes");
3718 implicit_text_args
.exists
= true;
3720 case OPT_CLOCK_DATE
:
3721 append_implicit_component_param(
3722 &implicit_text_args
, "clock-date", "yes");
3723 implicit_text_args
.exists
= true;
3725 case OPT_CLOCK_FORCE_CORRELATE
:
3726 ctf_fs_source_force_clock_class_unix_epoch_origin
= true;
3729 append_implicit_component_param(
3730 &implicit_text_args
, "clock-gmt", "yes");
3731 append_implicit_component_param(
3732 &implicit_trimmer_args
, "gmt", "yes");
3733 implicit_text_args
.exists
= true;
3735 case OPT_CLOCK_OFFSET
:
3736 if (ctf_fs_source_clock_class_offset_arg
) {
3737 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3741 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3742 if (!ctf_fs_source_clock_class_offset_arg
) {
3743 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3747 case OPT_CLOCK_OFFSET_NS
:
3748 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3749 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3753 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3754 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3755 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3759 case OPT_CLOCK_SECONDS
:
3760 append_implicit_component_param(
3761 &implicit_text_args
, "clock-seconds", "yes");
3762 implicit_text_args
.exists
= true;
3765 implicit_text_args
.exists
= true;
3766 ret
= append_implicit_component_extra_param(
3767 &implicit_text_args
, "color", arg
);
3772 case OPT_DEBUG_INFO
:
3773 implicit_debug_info_args
.exists
= true;
3775 case OPT_DEBUG_INFO_DIR
:
3776 implicit_debug_info_args
.exists
= true;
3777 ret
= append_implicit_component_extra_param(
3778 &implicit_debug_info_args
, "debug-info-dir", arg
);
3783 case OPT_DEBUG_INFO_FULL_PATH
:
3784 implicit_debug_info_args
.exists
= true;
3785 append_implicit_component_param(
3786 &implicit_debug_info_args
, "full-path", "yes");
3788 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3789 implicit_debug_info_args
.exists
= true;
3790 ret
= append_implicit_component_extra_param(
3791 &implicit_debug_info_args
,
3792 "target-prefix", arg
);
3799 bt_value
*fields
= fields_from_arg(arg
);
3805 implicit_text_args
.exists
= true;
3806 ret
= insert_flat_params_from_array(
3807 implicit_text_args
.params_arg
,
3809 bt_value_put_ref(fields
);
3817 bt_value
*names
= names_from_arg(arg
);
3823 implicit_text_args
.exists
= true;
3824 ret
= insert_flat_params_from_array(
3825 implicit_text_args
.params_arg
,
3827 bt_value_put_ref(names
);
3834 append_implicit_component_param(
3835 &implicit_text_args
, "no-delta", "yes");
3836 implicit_text_args
.exists
= true;
3838 case OPT_INPUT_FORMAT
:
3839 if (got_input_format_opt
) {
3840 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3844 got_input_format_opt
= true;
3846 if (strcmp(arg
, "ctf") == 0) {
3847 auto_source_discovery_restrict_plugin_name
= "ctf";
3848 auto_source_discovery_restrict_component_class_name
= "fs";
3849 } else if (strcmp(arg
, "lttng-live") == 0) {
3850 auto_source_discovery_restrict_plugin_name
= "ctf";
3851 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3852 implicit_lttng_live_args
.exists
= true;
3854 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
3859 case OPT_OUTPUT_FORMAT
:
3860 if (got_output_format_opt
) {
3861 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
3865 got_output_format_opt
= true;
3867 if (strcmp(arg
, "text") == 0) {
3868 implicit_text_args
.exists
= true;
3869 } else if (strcmp(arg
, "ctf") == 0) {
3870 implicit_ctf_output_args
.exists
= true;
3871 } else if (strcmp(arg
, "dummy") == 0) {
3872 implicit_dummy_args
.exists
= true;
3873 } else if (strcmp(arg
, "ctf-metadata") == 0) {
3874 print_ctf_metadata
= true;
3876 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
3883 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
3887 output
= strdup(arg
);
3889 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3894 if (print_run_args_0
) {
3895 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3899 print_run_args
= true;
3901 case OPT_RUN_ARGS_0
:
3902 if (print_run_args
) {
3903 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3907 print_run_args_0
= true;
3909 case OPT_STREAM_INTERSECTION
:
3911 * Applies to all traces implementing the
3912 * babeltrace.trace-infos query.
3914 stream_intersection_mode
= true;
3917 *default_log_level
=
3918 logging_level_min(*default_log_level
, BT_LOG_INFO
);
3921 *default_log_level
=
3922 logging_level_min(*default_log_level
, BT_LOG_TRACE
);
3929 set_auto_log_levels(default_log_level
);
3932 * Legacy behaviour: --verbose used to make the `text` output
3933 * format print more information. --verbose is now equivalent to
3934 * the INFO log level, which is why we compare to `BT_LOG_INFO`
3937 if (*default_log_level
== BT_LOG_INFO
) {
3938 append_implicit_component_param(&implicit_text_args
,
3942 /* Print CTF metadata or print LTTng live sessions */
3943 if (print_ctf_metadata
) {
3944 const bt_value
*bt_val_non_opt
;
3946 if (bt_value_array_is_empty(non_opts
)) {
3947 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
3951 if (bt_value_array_get_length(non_opts
) > 1) {
3952 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
3956 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
3961 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
3962 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
3963 bt_value_string_get(bt_val_non_opt
));
3967 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
3975 * If -o ctf was specified, make sure an output path (--output)
3976 * was also specified. --output does not imply -o ctf because
3977 * it's also used for the default, implicit -o text if -o ctf
3980 if (implicit_ctf_output_args
.exists
) {
3982 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
3987 * At this point we know that -o ctf AND --output were
3988 * specified. Make sure that no options were specified
3989 * which would imply -o text because --output would be
3990 * ambiguous in this case. For example, this is wrong:
3992 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
3994 * because --names=all implies -o text, and --output
3995 * could apply to both the sink.text.pretty and
3996 * sink.ctf.fs implicit components.
3998 if (implicit_text_args
.exists
) {
3999 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
4005 * If -o dummy and -o ctf were not specified, and if there are
4006 * no explicit sink components, then use an implicit
4007 * `sink.text.pretty` component.
4009 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
4011 implicit_text_args
.exists
= true;
4015 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4016 * `path` parameter if --output was specified.
4019 if (implicit_text_args
.exists
) {
4020 append_implicit_component_extra_param(&implicit_text_args
,
4022 } else if (implicit_ctf_output_args
.exists
) {
4023 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4028 /* Decide where the non-option argument(s) go */
4029 if (bt_value_array_get_length(non_opts
) > 0) {
4030 if (implicit_lttng_live_args
.exists
) {
4031 const bt_value
*bt_val_non_opt
;
4033 if (bt_value_array_get_length(non_opts
) > 1) {
4034 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
4038 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
4039 lttng_live_url_parts
=
4040 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt
),
4041 error_buf
, sizeof(error_buf
));
4042 if (!lttng_live_url_parts
.proto
) {
4043 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
4048 if (!lttng_live_url_parts
.session_name
) {
4049 /* Print LTTng live sessions */
4050 cfg
= bt_config_print_lttng_live_sessions_create(
4056 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4057 bt_value_string_get(bt_val_non_opt
));
4061 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4068 live_inputs_array_val
= bt_value_array_create();
4069 if (!live_inputs_array_val
) {
4070 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4074 if (bt_value_array_append_string_element(
4075 live_inputs_array_val
,
4076 bt_value_string_get(bt_val_non_opt
))) {
4077 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4081 ret
= append_parameter_to_args(
4082 implicit_lttng_live_args
.extra_params
,
4083 "inputs", live_inputs_array_val
);
4088 ret
= append_implicit_component_extra_param(
4089 &implicit_lttng_live_args
,
4090 "session-not-found-action", "end");
4096 size_t plugin_count
;
4097 const bt_plugin
**plugins
;
4098 const bt_plugin
*plugin
;
4100 status
= require_loaded_plugins(plugin_paths
);
4105 if (auto_source_discovery_restrict_plugin_name
) {
4107 plugin
= find_loaded_plugin(auto_source_discovery_restrict_plugin_name
);
4110 plugin_count
= get_loaded_plugins_count();
4111 plugins
= borrow_loaded_plugins();
4114 status
= auto_discover_source_components(non_opts
, plugins
, plugin_count
,
4115 auto_source_discovery_restrict_component_class_name
,
4116 *default_log_level
, &auto_disc
, interrupter
);
4119 if (status
== AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED
) {
4120 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
4121 "Babeltrace CLI", "Automatic source discovery interrupted by the user");
4126 status
= create_implicit_component_args_from_auto_discovered_sources(
4127 &auto_disc
, non_opts
, non_opt_params
, non_opt_loglevels
,
4128 discovered_source_args
);
4137 * If --clock-force-correlated was given, apply it to any src.ctf.fs
4140 if (ctf_fs_source_force_clock_class_unix_epoch_origin
) {
4143 n
= append_multiple_implicit_components_param(
4144 discovered_source_args
, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
4147 BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
4152 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4153 if (ctf_fs_source_clock_class_offset_arg
) {
4156 n
= append_multiple_implicit_components_param(
4157 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4158 ctf_fs_source_clock_class_offset_arg
);
4161 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4166 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4167 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4170 n
= append_multiple_implicit_components_param(
4171 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4172 ctf_fs_source_clock_class_offset_ns_arg
);
4175 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4181 * If the implicit `source.ctf.lttng-live` component exists,
4182 * make sure there's at least one non-option argument (which is
4185 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(non_opts
)) {
4186 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4187 implicit_lttng_live_args
.comp_arg
->str
);
4191 /* Assign names to implicit components */
4192 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4193 struct implicit_component_args
*args
;
4196 args
= discovered_source_args
->pdata
[i
];
4198 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4200 /* Give it a name like `auto-disc-src-ctf-fs`. */
4201 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4202 if (auto_disc_comp_name
->str
[j
] == '.') {
4203 auto_disc_comp_name
->str
[j
] = '-';
4207 ret
= assign_name_to_implicit_component(args
,
4208 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4214 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4215 "lttng-live", all_names
, &source_names
, true);
4220 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4221 "pretty", all_names
, &sink_names
, true);
4226 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4227 "sink-ctf-fs", all_names
, &sink_names
, true);
4232 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4233 "dummy", all_names
, &sink_names
, true);
4238 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4239 "muxer", all_names
, NULL
, false);
4244 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4245 "trimmer", all_names
, NULL
, false);
4250 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4251 "debug-info", all_names
, NULL
, false);
4256 /* Make sure there's at least one source and one sink */
4257 if (!source_names
) {
4258 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4263 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4267 /* Make sure there's a single sink component */
4268 if (g_list_length(sink_names
) != 1) {
4269 BT_CLI_LOGE_APPEND_CAUSE(
4270 "More than one sink component specified.");
4275 * Prepend the muxer, the trimmer, and the debug info to the
4276 * filter chain so that we have:
4278 * sources -> muxer -> [trimmer] -> [debug info] ->
4279 * [user filters] -> sinks
4281 if (implicit_debug_info_args
.exists
) {
4282 if (g_list_prepend_gstring(&filter_names
,
4283 implicit_debug_info_args
.name_arg
->str
)) {
4288 if (implicit_trimmer_args
.exists
) {
4289 if (g_list_prepend_gstring(&filter_names
,
4290 implicit_trimmer_args
.name_arg
->str
)) {
4295 if (g_list_prepend_gstring(&filter_names
,
4296 implicit_muxer_args
.name_arg
->str
)) {
4301 * Append the equivalent run arguments for the implicit
4304 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4305 struct implicit_component_args
*args
=
4306 discovered_source_args
->pdata
[i
];
4308 ret
= append_run_args_for_implicit_component(args
, run_args
);
4314 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4320 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4326 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4332 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4338 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4344 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4350 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4356 /* Auto-connect components */
4357 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4360 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4365 * We have all the run command arguments now. Depending on
4366 * --run-args, we pass this to the run command or print them
4369 if (print_run_args
|| print_run_args_0
) {
4370 if (stream_intersection_mode
) {
4371 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4375 for (i
= 0; i
< bt_value_array_get_length(run_args
); i
++) {
4376 const bt_value
*arg_value
=
4377 bt_value_array_borrow_element_by_index(run_args
,
4380 GString
*quoted
= NULL
;
4381 const char *arg_to_print
;
4383 BT_ASSERT(arg_value
);
4384 arg
= bt_value_string_get(arg_value
);
4386 if (print_run_args
) {
4387 quoted
= bt_common_shell_quote(arg
, true);
4392 arg_to_print
= quoted
->str
;
4397 printf("%s", arg_to_print
);
4400 g_string_free(quoted
, TRUE
);
4403 if (i
< bt_value_array_get_length(run_args
) - 1) {
4404 if (print_run_args
) {
4413 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4417 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4418 plugin_paths
, *default_log_level
);
4423 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4428 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4431 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4435 if (component_arg_for_run
) {
4436 g_string_free(component_arg_for_run
, TRUE
);
4440 g_string_free(name_gstr
, TRUE
);
4443 bt_value_put_ref(live_inputs_array_val
);
4444 bt_value_put_ref(run_args
);
4445 bt_value_put_ref(all_names
);
4446 destroy_glist_of_gstring(source_names
);
4447 destroy_glist_of_gstring(filter_names
);
4448 destroy_glist_of_gstring(sink_names
);
4449 bt_value_put_ref(non_opt_params
);
4450 bt_value_put_ref(non_opt_loglevels
);
4451 bt_value_put_ref(non_opts
);
4452 finalize_implicit_component_args(&implicit_ctf_output_args
);
4453 finalize_implicit_component_args(&implicit_lttng_live_args
);
4454 finalize_implicit_component_args(&implicit_dummy_args
);
4455 finalize_implicit_component_args(&implicit_text_args
);
4456 finalize_implicit_component_args(&implicit_debug_info_args
);
4457 finalize_implicit_component_args(&implicit_muxer_args
);
4458 finalize_implicit_component_args(&implicit_trimmer_args
);
4459 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4460 auto_source_discovery_fini(&auto_disc
);
4462 if (discovered_source_args
) {
4463 g_ptr_array_free(discovered_source_args
, TRUE
);
4466 g_free(ctf_fs_source_clock_class_offset_arg
);
4467 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4469 if (auto_disc_comp_name
) {
4470 g_string_free(auto_disc_comp_name
, TRUE
);
4477 * Prints the Babeltrace 2.x general usage.
4480 void print_gen_usage(FILE *fp
)
4482 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4484 fprintf(fp
, "General options:\n");
4486 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=T)\n");
4487 fprintf(fp
, " -h, --help Show this help and quit\n");
4488 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `T`, `D`,\n");
4489 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4490 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
4491 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
4492 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
4493 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
4494 fprintf(fp
, " dynamic plugins can be loaded\n");
4495 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4496 fprintf(fp
, " -V, --version Show version and quit\n");
4498 fprintf(fp
, "Available commands:\n");
4500 fprintf(fp
, " convert Convert and trim traces (default)\n");
4501 fprintf(fp
, " help Get help for a plugin or a component class\n");
4502 fprintf(fp
, " list-plugins List available plugins and their content\n");
4503 fprintf(fp
, " query Query objects from a component class\n");
4504 fprintf(fp
, " run Build a processing graph and run it\n");
4506 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4509 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4510 int *retcode
, bool omit_system_plugin_path
,
4511 bool omit_home_plugin_path
,
4512 const bt_value
*initial_plugin_paths
,
4513 const bt_interrupter
*interrupter
)
4515 struct bt_config
*config
= NULL
;
4518 const char **top_level_argv
;
4519 int command_argc
= -1;
4520 const char **command_argv
= NULL
;
4521 const char *command_name
= NULL
;
4522 int default_log_level
= -1;
4523 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
4524 bt_value
*plugin_paths
= NULL
;
4526 /* Top-level option descriptions. */
4527 static const struct bt_argpar_opt_descr descrs
[] = {
4528 { OPT_DEBUG
, 'd', "debug", false },
4529 { OPT_HELP
, 'h', "help", false },
4530 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4531 { OPT_VERBOSE
, 'v', "verbose", false },
4532 { OPT_VERSION
, 'V', "version", false},
4533 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
4534 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
4535 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
4536 BT_ARGPAR_OPT_DESCR_SENTINEL
4540 COMMAND_TYPE_NONE
= -1,
4541 COMMAND_TYPE_RUN
= 0,
4542 COMMAND_TYPE_CONVERT
,
4543 COMMAND_TYPE_LIST_PLUGINS
,
4546 } command_type
= COMMAND_TYPE_NONE
;
4550 if (!initial_plugin_paths
) {
4551 plugin_paths
= bt_value_array_create();
4552 if (!plugin_paths
) {
4556 bt_value_copy_status copy_status
= bt_value_copy(
4557 initial_plugin_paths
, &plugin_paths
);
4563 BT_ASSERT(plugin_paths
);
4566 * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
4567 * `--plugin-path` option's paths, so append it now before
4568 * parsing the general options.
4570 if (append_env_var_plugin_paths(plugin_paths
)) {
4577 print_gen_usage(stdout
);
4581 /* Skip first argument, the name of the program. */
4582 top_level_argc
= argc
- 1;
4583 top_level_argv
= argv
+ 1;
4584 argpar_parse_ret
= bt_argpar_parse(top_level_argc
, top_level_argv
,
4587 if (argpar_parse_ret
.error
) {
4588 BT_CLI_LOGE_APPEND_CAUSE(
4589 "While parsing command-line arguments: %s",
4590 argpar_parse_ret
.error
->str
);
4594 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
4595 struct bt_argpar_item
*item
;
4597 item
= g_ptr_array_index(argpar_parse_ret
.items
, i
);
4599 if (item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
4600 struct bt_argpar_item_opt
*item_opt
=
4601 (struct bt_argpar_item_opt
*) item
;
4603 switch (item_opt
->descr
->id
) {
4606 logging_level_min(default_log_level
, BT_LOG_TRACE
);
4610 logging_level_min(default_log_level
, BT_LOG_INFO
);
4614 int level
= bt_log_get_level_from_string(item_opt
->arg
);
4617 BT_CLI_LOGE_APPEND_CAUSE(
4618 "Invalid argument for --log-level option:\n %s",
4624 logging_level_min(default_log_level
, level
);
4627 case OPT_PLUGIN_PATH
:
4628 if (bt_config_append_plugin_paths_check_setuid_setgid(
4629 plugin_paths
, item_opt
->arg
)) {
4633 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4634 omit_system_plugin_path
= true;
4636 case OPT_OMIT_HOME_PLUGIN_PATH
:
4637 omit_home_plugin_path
= true;
4643 print_gen_usage(stdout
);
4646 } else if (item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
4647 struct bt_argpar_item_non_opt
*item_non_opt
=
4648 (struct bt_argpar_item_non_opt
*) item
;
4650 * First unknown argument: is it a known command
4654 top_level_argc
- item_non_opt
->orig_index
- 1;
4656 &top_level_argv
[item_non_opt
->orig_index
+ 1];
4658 if (strcmp(item_non_opt
->arg
, "convert") == 0) {
4659 command_type
= COMMAND_TYPE_CONVERT
;
4660 } else if (strcmp(item_non_opt
->arg
, "list-plugins") == 0) {
4661 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4662 } else if (strcmp(item_non_opt
->arg
, "help") == 0) {
4663 command_type
= COMMAND_TYPE_HELP
;
4664 } else if (strcmp(item_non_opt
->arg
, "query") == 0) {
4665 command_type
= COMMAND_TYPE_QUERY
;
4666 } else if (strcmp(item_non_opt
->arg
, "run") == 0) {
4667 command_type
= COMMAND_TYPE_RUN
;
4670 * Non-option argument, but not a known
4671 * command name: assume the default
4672 * `convert` command.
4674 command_type
= COMMAND_TYPE_CONVERT
;
4675 command_name
= "convert";
4683 if (command_type
== COMMAND_TYPE_NONE
) {
4684 if (argpar_parse_ret
.ingested_orig_args
== top_level_argc
) {
4686 * We only got non-help, non-version general options
4687 * like --verbose and --debug, without any other
4688 * arguments, so we can't do anything useful: print the
4691 print_gen_usage(stdout
);
4696 * We stopped on an unknown option argument (and therefore
4697 * didn't see a command name). Assume `convert` command.
4699 command_type
= COMMAND_TYPE_CONVERT
;
4700 command_name
= "convert";
4702 top_level_argc
- argpar_parse_ret
.ingested_orig_args
;
4704 &top_level_argv
[argpar_parse_ret
.ingested_orig_args
];
4707 BT_ASSERT(command_argv
);
4708 BT_ASSERT(command_argc
>= 0);
4711 * For all commands other than `convert`, we now know the log level to
4712 * use, so we can apply it with `set_auto_log_levels`.
4714 * The convert command has `--debug` and `--verbose` arguments that are
4715 * equivalent to the top-level arguments of the same name. So after it
4716 * has parsed its arguments, `bt_config_convert_from_args` calls
4717 * `set_auto_log_levels` itself.
4719 if (command_type
!= COMMAND_TYPE_CONVERT
) {
4720 set_auto_log_levels(&default_log_level
);
4724 * At this point, `plugin_paths` contains the initial plugin
4725 * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
4726 * the paths from the `--plugin-path` option.
4728 * Now append the user and system plugin paths.
4730 if (append_home_and_system_plugin_paths(plugin_paths
,
4731 omit_system_plugin_path
, omit_home_plugin_path
)) {
4735 switch (command_type
) {
4736 case COMMAND_TYPE_RUN
:
4737 config
= bt_config_run_from_args(command_argc
, command_argv
,
4738 retcode
, plugin_paths
,
4741 case COMMAND_TYPE_CONVERT
:
4742 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4743 retcode
, plugin_paths
, &default_log_level
, interrupter
);
4745 case COMMAND_TYPE_LIST_PLUGINS
:
4746 config
= bt_config_list_plugins_from_args(command_argc
,
4747 command_argv
, retcode
, plugin_paths
);
4749 case COMMAND_TYPE_HELP
:
4750 config
= bt_config_help_from_args(command_argc
,
4751 command_argv
, retcode
, plugin_paths
,
4754 case COMMAND_TYPE_QUERY
:
4755 config
= bt_config_query_from_args(command_argc
,
4756 command_argv
, retcode
, plugin_paths
,
4764 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4765 config
->log_level
= default_log_level
;
4766 config
->command_name
= command_name
;
4775 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4776 bt_value_put_ref(plugin_paths
);