2 * Babeltrace trace converter - parameter parsing
4 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "CLI/CFG-CLI-ARGS"
31 #include "common/assert.h"
35 #include <babeltrace2/babeltrace.h>
36 #include "common/common.h"
38 #include <sys/types.h>
39 #include "argpar/argpar.h"
40 #include "babeltrace2-cfg.h"
41 #include "babeltrace2-cfg-cli-args.h"
42 #include "babeltrace2-cfg-cli-args-connect.h"
43 #include "param-parse/param-parse.h"
44 #include "babeltrace2-log-level.h"
45 #include "babeltrace2-plugins.h"
46 #include "babeltrace2-query.h"
47 #include "autodisc/autodisc.h"
48 #include "common/version.h"
50 /* Offset option with "is set" boolean */
56 /* Legacy "ctf"/"lttng-live" format options */
57 struct ctf_legacy_opts
{
58 struct offset_opt offset_s
;
59 struct offset_opt offset_ns
;
60 bool stream_intersection
;
63 /* Legacy "text" format options */
64 struct text_legacy_opts
{
66 * output, dbg_info_dir, dbg_info_target_prefix, names,
67 * and fields are owned by this.
70 GString
*dbg_info_dir
;
71 GString
*dbg_info_target_prefix
;
72 const bt_value
*names
;
73 const bt_value
*fields
;
81 bool dbg_info_full_path
;
85 /* Legacy input format format */
86 enum legacy_input_format
{
87 LEGACY_INPUT_FORMAT_NONE
= 0,
88 LEGACY_INPUT_FORMAT_CTF
,
89 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
92 /* Legacy output format format */
93 enum legacy_output_format
{
94 LEGACY_OUTPUT_FORMAT_NONE
= 0,
95 LEGACY_OUTPUT_FORMAT_TEXT
,
96 LEGACY_OUTPUT_FORMAT_DUMMY
,
99 #define BT_CLI_LOGE_APPEND_CAUSE_OOM() BT_CLI_LOGE_APPEND_CAUSE("Out of memory.")
102 * Returns the plugin name, component class name, component class type,
103 * and component name from a command-line --component option's argument.
104 * arg must have the following format:
106 * [NAME:]TYPE.PLUGIN.CLS
108 * where NAME is the optional component name, TYPE is either `source`,
109 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
110 * component class name.
112 * On success, both *plugin and *component are not NULL. *plugin
113 * and *comp_cls are owned by the caller. On success, *name can be NULL
114 * if no component class name was found, and *comp_cls_type is set.
117 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
118 char **comp_cls
, bt_component_class_type
*comp_cls_type
)
120 const char *at
= arg
;
121 GString
*gs_name
= NULL
;
122 GString
*gs_comp_cls_type
= NULL
;
123 GString
*gs_plugin
= NULL
;
124 GString
*gs_comp_cls
= NULL
;
130 BT_ASSERT(comp_cls_type
);
132 if (!bt_common_string_is_printable(arg
)) {
133 BT_CLI_LOGE_APPEND_CAUSE("Argument contains a non-printable character.");
137 /* Parse the component name */
138 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
143 if (arg
[end_pos
] == ':') {
147 g_string_assign(gs_name
, "");
150 /* Parse the component class type */
151 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
152 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
153 BT_CLI_LOGE_APPEND_CAUSE("Missing component class type (`source`, `filter`, or `sink`).");
157 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
158 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
159 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
160 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
161 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
162 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
163 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
164 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
166 BT_CLI_LOGE_APPEND_CAUSE("Unknown component class type: `%s`.",
167 gs_comp_cls_type
->str
);
173 /* Parse the plugin name */
174 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
175 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
176 BT_CLI_LOGE_APPEND_CAUSE("Missing plugin or component class name.");
182 /* Parse the component class name */
183 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
184 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
185 BT_CLI_LOGE_APPEND_CAUSE("Missing component class name.");
189 if (at
[end_pos
] != '\0') {
190 /* Found a non-escaped `.` */
195 if (gs_name
->len
== 0) {
197 g_string_free(gs_name
, TRUE
);
199 *name
= gs_name
->str
;
200 g_string_free(gs_name
, FALSE
);
203 g_string_free(gs_name
, TRUE
);
206 *plugin
= gs_plugin
->str
;
207 *comp_cls
= gs_comp_cls
->str
;
208 g_string_free(gs_plugin
, FALSE
);
209 g_string_free(gs_comp_cls
, FALSE
);
225 g_string_free(gs_name
, TRUE
);
229 g_string_free(gs_plugin
, TRUE
);
233 g_string_free(gs_comp_cls
, TRUE
);
236 if (gs_comp_cls_type
) {
237 g_string_free(gs_comp_cls_type
, TRUE
);
244 * Prints the Babeltrace version.
247 void print_version(void)
249 if (GIT_VERSION
[0] == '\0') {
250 puts("Babeltrace " VERSION
);
252 puts("Babeltrace " VERSION
" - " GIT_VERSION
);
257 * Destroys a component configuration.
260 void bt_config_component_destroy(bt_object
*obj
)
262 struct bt_config_component
*bt_config_component
=
263 container_of(obj
, struct bt_config_component
, base
);
269 if (bt_config_component
->plugin_name
) {
270 g_string_free(bt_config_component
->plugin_name
, TRUE
);
273 if (bt_config_component
->comp_cls_name
) {
274 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
277 if (bt_config_component
->instance_name
) {
278 g_string_free(bt_config_component
->instance_name
, TRUE
);
281 BT_VALUE_PUT_REF_AND_RESET(bt_config_component
->params
);
282 g_free(bt_config_component
);
289 * Creates a component configuration using the given plugin name and
290 * component name. `plugin_name` and `comp_cls_name` are copied (belong
291 * to the return value).
293 * Return value is owned by the caller.
296 struct bt_config_component
*bt_config_component_create(
297 bt_component_class_type type
,
298 const char *plugin_name
, const char *comp_cls_name
,
301 struct bt_config_component
*cfg_component
= NULL
;
303 cfg_component
= g_new0(struct bt_config_component
, 1);
304 if (!cfg_component
) {
305 BT_CLI_LOGE_APPEND_CAUSE_OOM();
309 bt_object_init_shared(&cfg_component
->base
,
310 bt_config_component_destroy
);
311 cfg_component
->type
= type
;
312 cfg_component
->plugin_name
= g_string_new(plugin_name
);
313 if (!cfg_component
->plugin_name
) {
314 BT_CLI_LOGE_APPEND_CAUSE_OOM();
318 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
319 if (!cfg_component
->comp_cls_name
) {
320 BT_CLI_LOGE_APPEND_CAUSE_OOM();
324 cfg_component
->instance_name
= g_string_new(NULL
);
325 if (!cfg_component
->instance_name
) {
326 BT_CLI_LOGE_APPEND_CAUSE_OOM();
330 cfg_component
->log_level
= init_log_level
;
332 /* Start with empty parameters */
333 cfg_component
->params
= bt_value_map_create();
334 if (!cfg_component
->params
) {
335 BT_CLI_LOGE_APPEND_CAUSE_OOM();
342 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
345 return cfg_component
;
349 * Creates a component configuration from a command-line --component
353 struct bt_config_component
*bt_config_component_from_arg(const char *arg
,
356 struct bt_config_component
*cfg_comp
= NULL
;
358 char *plugin_name
= NULL
;
359 char *comp_cls_name
= NULL
;
360 bt_component_class_type type
;
362 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
363 if (!plugin_name
|| !comp_cls_name
) {
367 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
,
374 g_string_assign(cfg_comp
->instance_name
, name
);
380 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp
);
385 g_free(comp_cls_name
);
390 * Destroys a configuration.
393 void bt_config_destroy(bt_object
*obj
)
395 struct bt_config
*cfg
=
396 container_of(obj
, struct bt_config
, base
);
402 BT_VALUE_PUT_REF_AND_RESET(cfg
->plugin_paths
);
404 switch (cfg
->command
) {
405 case BT_CONFIG_COMMAND_RUN
:
406 if (cfg
->cmd_data
.run
.sources
) {
407 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
410 if (cfg
->cmd_data
.run
.filters
) {
411 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
414 if (cfg
->cmd_data
.run
.sinks
) {
415 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
418 if (cfg
->cmd_data
.run
.connections
) {
419 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
423 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
425 case BT_CONFIG_COMMAND_HELP
:
426 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.help
.cfg_component
);
428 case BT_CONFIG_COMMAND_QUERY
:
429 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.query
.cfg_component
);
431 if (cfg
->cmd_data
.query
.object
) {
432 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
435 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
436 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
437 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
440 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
444 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
445 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
447 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
450 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
465 void destroy_glist_of_gstring(GList
*list
)
473 for (at
= list
; at
; at
= g_list_next(at
)) {
474 g_string_free(at
->data
, TRUE
);
481 * Creates a simple lexical scanner for parsing comma-delimited names
484 * Return value is owned by the caller.
487 GScanner
*create_csv_identifiers_scanner(void)
490 GScannerConfig scanner_config
= {
491 .cset_skip_characters
= " \t\n",
492 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
493 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
494 .case_sensitive
= TRUE
,
495 .cpair_comment_single
= NULL
,
496 .skip_comment_multi
= TRUE
,
497 .skip_comment_single
= TRUE
,
498 .scan_comment_multi
= FALSE
,
499 .scan_identifier
= TRUE
,
500 .scan_identifier_1char
= TRUE
,
501 .scan_identifier_NULL
= FALSE
,
502 .scan_symbols
= FALSE
,
503 .symbol_2_token
= FALSE
,
504 .scope_0_fallback
= FALSE
,
505 .scan_binary
= FALSE
,
509 .scan_hex_dollar
= FALSE
,
510 .numbers_2_int
= FALSE
,
511 .int_2_float
= FALSE
,
512 .store_int64
= FALSE
,
513 .scan_string_sq
= FALSE
,
514 .scan_string_dq
= FALSE
,
515 .identifier_2_string
= FALSE
,
516 .char_2_token
= TRUE
,
519 scanner
= g_scanner_new(&scanner_config
);
521 BT_CLI_LOGE_APPEND_CAUSE_OOM();
528 * Converts a comma-delimited list of known names (--names option) to
529 * an array value object containing those names as string value objects.
531 * Return value is owned by the caller.
534 bt_value
*names_from_arg(const char *arg
)
536 GScanner
*scanner
= NULL
;
537 bt_value
*names
= NULL
;
538 bool found_all
= false, found_none
= false, found_item
= false;
540 names
= bt_value_array_create();
542 BT_CLI_LOGE_APPEND_CAUSE_OOM();
546 scanner
= create_csv_identifiers_scanner();
551 g_scanner_input_text(scanner
, arg
, strlen(arg
));
554 GTokenType token_type
= g_scanner_get_next_token(scanner
);
556 switch (token_type
) {
557 case G_TOKEN_IDENTIFIER
:
559 const char *identifier
= scanner
->value
.v_identifier
;
561 if (strcmp(identifier
, "payload") == 0 ||
562 strcmp(identifier
, "args") == 0 ||
563 strcmp(identifier
, "arg") == 0) {
565 if (bt_value_array_append_string_element(names
,
569 } else if (strcmp(identifier
, "context") == 0 ||
570 strcmp(identifier
, "ctx") == 0) {
572 if (bt_value_array_append_string_element(names
,
576 } else if (strcmp(identifier
, "scope") == 0 ||
577 strcmp(identifier
, "header") == 0) {
579 if (bt_value_array_append_string_element(names
,
583 } else if (strcmp(identifier
, "all") == 0) {
585 if (bt_value_array_append_string_element(names
,
589 } else if (strcmp(identifier
, "none") == 0) {
591 if (bt_value_array_append_string_element(names
,
596 BT_CLI_LOGE_APPEND_CAUSE("Unknown name: `%s`.",
612 if (found_none
&& found_all
) {
613 BT_CLI_LOGE_APPEND_CAUSE("Only either `all` or `none` can be specified in the list given to the --names option, but not both.");
617 * Legacy behavior is to clear the defaults (show none) when at
618 * least one item is specified.
620 if (found_item
&& !found_none
&& !found_all
) {
621 if (bt_value_array_append_string_element(names
, "none")) {
626 g_scanner_destroy(scanner
);
631 BT_VALUE_PUT_REF_AND_RESET(names
);
633 g_scanner_destroy(scanner
);
639 * Converts a comma-delimited list of known fields (--fields option) to
640 * an array value object containing those fields as string
643 * Return value is owned by the caller.
646 bt_value
*fields_from_arg(const char *arg
)
648 GScanner
*scanner
= NULL
;
651 fields
= bt_value_array_create();
653 BT_CLI_LOGE_APPEND_CAUSE_OOM();
657 scanner
= create_csv_identifiers_scanner();
662 g_scanner_input_text(scanner
, arg
, strlen(arg
));
665 GTokenType token_type
= g_scanner_get_next_token(scanner
);
667 switch (token_type
) {
668 case G_TOKEN_IDENTIFIER
:
670 const char *identifier
= scanner
->value
.v_identifier
;
672 if (strcmp(identifier
, "trace") == 0 ||
673 strcmp(identifier
, "trace:hostname") == 0 ||
674 strcmp(identifier
, "trace:domain") == 0 ||
675 strcmp(identifier
, "trace:procname") == 0 ||
676 strcmp(identifier
, "trace:vpid") == 0 ||
677 strcmp(identifier
, "loglevel") == 0 ||
678 strcmp(identifier
, "emf") == 0 ||
679 strcmp(identifier
, "callsite") == 0 ||
680 strcmp(identifier
, "all") == 0) {
681 if (bt_value_array_append_string_element(fields
,
686 BT_CLI_LOGE_APPEND_CAUSE("Unknown field: `%s`.",
704 BT_VALUE_PUT_REF_AND_RESET(fields
);
708 g_scanner_destroy(scanner
);
714 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
716 BT_ASSERT(params_arg
);
720 if (params_arg
->len
!= 0) {
721 g_string_append_c(params_arg
, ',');
724 g_string_append(params_arg
, key
);
725 g_string_append_c(params_arg
, '=');
726 g_string_append(params_arg
, value
);
730 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
731 * where the names are in names_array.
734 int insert_flat_params_from_array(GString
*params_arg
,
735 const bt_value
*names_array
, const char *prefix
)
739 GString
*tmpstr
= NULL
, *default_value
= NULL
;
740 bool default_set
= false, non_default_set
= false;
743 * names_array may be NULL if no CLI options were specified to
744 * trigger its creation.
750 tmpstr
= g_string_new(NULL
);
752 BT_CLI_LOGE_APPEND_CAUSE_OOM();
757 default_value
= g_string_new(NULL
);
758 if (!default_value
) {
759 BT_CLI_LOGE_APPEND_CAUSE_OOM();
764 for (i
= 0; i
< bt_value_array_get_length(names_array
); i
++) {
765 const bt_value
*str_obj
=
766 bt_value_array_borrow_element_by_index_const(names_array
,
769 bool is_default
= false;
772 BT_CLI_LOGE_APPEND_CAUSE("Unexpected error.");
777 suffix
= bt_value_string_get(str_obj
);
779 g_string_assign(tmpstr
, prefix
);
780 g_string_append(tmpstr
, "-");
782 /* Special-case for "all" and "none". */
783 if (strcmp(suffix
, "all") == 0) {
785 g_string_assign(default_value
, "show");
786 } else if (strcmp(suffix
, "none") == 0) {
788 g_string_assign(default_value
, "hide");
792 g_string_append(tmpstr
, "default");
793 append_param_arg(params_arg
, tmpstr
->str
,
796 non_default_set
= true;
797 g_string_append(tmpstr
, suffix
);
798 append_param_arg(params_arg
, tmpstr
->str
, "yes");
802 /* Implicit field-default=hide if any non-default option is set. */
803 if (non_default_set
&& !default_set
) {
804 g_string_assign(tmpstr
, prefix
);
805 g_string_append(tmpstr
, "-default");
806 g_string_assign(default_value
, "hide");
807 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
812 g_string_free(default_value
, TRUE
);
816 g_string_free(tmpstr
, TRUE
);
829 OPT_CLOCK_FORCE_CORRELATE
,
840 OPT_DEBUG_INFO_FULL_PATH
,
841 OPT_DEBUG_INFO_TARGET_PREFIX
,
850 OPT_OMIT_HOME_PLUGIN_PATH
,
851 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
856 OPT_RESET_BASE_PARAMS
,
860 OPT_STREAM_INTERSECTION
,
866 enum bt_config_component_dest
{
867 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
868 BT_CONFIG_COMPONENT_DEST_SOURCE
,
869 BT_CONFIG_COMPONENT_DEST_FILTER
,
870 BT_CONFIG_COMPONENT_DEST_SINK
,
874 * Adds a configuration component to the appropriate configuration
875 * array depending on the destination.
878 void add_run_cfg_comp(struct bt_config
*cfg
,
879 struct bt_config_component
*cfg_comp
,
880 enum bt_config_component_dest dest
)
882 bt_object_get_ref(cfg_comp
);
885 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
886 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
888 case BT_CONFIG_COMPONENT_DEST_FILTER
:
889 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
891 case BT_CONFIG_COMPONENT_DEST_SINK
:
892 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
900 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
901 struct bt_config_component
*cfg_comp
,
902 enum bt_config_component_dest dest
,
903 bt_value
*instance_names
)
907 if (cfg_comp
->instance_name
->len
== 0) {
908 BT_CLI_LOGE_APPEND_CAUSE("Found an unnamed component.");
913 if (bt_value_map_has_entry(instance_names
,
914 cfg_comp
->instance_name
->str
)) {
915 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
916 cfg_comp
->instance_name
->str
);
921 if (bt_value_map_insert_entry(instance_names
,
922 cfg_comp
->instance_name
->str
, bt_value_null
)) {
923 BT_CLI_LOGE_APPEND_CAUSE_OOM();
928 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
935 int append_env_var_plugin_paths(bt_value
*plugin_paths
)
940 if (bt_common_is_setuid_setgid()) {
941 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
945 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
950 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
954 BT_CLI_LOGE_APPEND_CAUSE("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH.");
961 int append_home_and_system_plugin_paths(bt_value
*plugin_paths
,
962 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
966 if (!omit_home_plugin_path
) {
967 if (bt_common_is_setuid_setgid()) {
968 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
970 char *home_plugin_dir
= bt_common_get_home_plugin_path(
971 BT_LOG_OUTPUT_LEVEL
);
973 if (home_plugin_dir
) {
974 ret
= bt_config_append_plugin_paths(
975 plugin_paths
, home_plugin_dir
);
976 free(home_plugin_dir
);
979 BT_CLI_LOGE_APPEND_CAUSE("Invalid home plugin path.");
986 if (!omit_system_plugin_path
) {
987 if (bt_config_append_plugin_paths(plugin_paths
,
988 bt_common_get_system_plugin_path())) {
989 BT_CLI_LOGE_APPEND_CAUSE("Invalid system plugin path.");
995 BT_CLI_LOGE_APPEND_CAUSE("Cannot append home and system plugin paths.");
1000 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1001 const bt_value
*plugin_paths
, bool needs_plugins
)
1003 struct bt_config
*cfg
;
1006 cfg
= g_new0(struct bt_config
, 1);
1008 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1012 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1013 cfg
->command
= command
;
1014 cfg
->command_needs_plugins
= needs_plugins
;
1017 bt_value
*plugin_paths_copy
;
1019 (void) bt_value_copy(plugin_paths
,
1020 &plugin_paths_copy
);
1021 cfg
->plugin_paths
= plugin_paths_copy
;
1023 cfg
->plugin_paths
= bt_value_array_create();
1024 if (!cfg
->plugin_paths
) {
1025 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1033 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1040 struct bt_config
*bt_config_run_create(const bt_value
*plugin_paths
)
1042 struct bt_config
*cfg
;
1045 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1046 plugin_paths
, true);
1051 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1052 (GDestroyNotify
) bt_object_put_ref
);
1053 if (!cfg
->cmd_data
.run
.sources
) {
1054 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1058 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1059 (GDestroyNotify
) bt_object_put_ref
);
1060 if (!cfg
->cmd_data
.run
.filters
) {
1061 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1065 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1066 (GDestroyNotify
) bt_object_put_ref
);
1067 if (!cfg
->cmd_data
.run
.sinks
) {
1068 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1072 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1073 (GDestroyNotify
) bt_config_connection_destroy
);
1074 if (!cfg
->cmd_data
.run
.connections
) {
1075 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1082 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1089 struct bt_config
*bt_config_list_plugins_create(const bt_value
*plugin_paths
)
1091 return bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1092 plugin_paths
, true);
1096 struct bt_config
*bt_config_help_create(const bt_value
*plugin_paths
,
1097 int default_log_level
)
1099 struct bt_config
*cfg
;
1102 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1103 plugin_paths
, true);
1108 cfg
->cmd_data
.help
.cfg_component
=
1109 bt_config_component_create(-1, NULL
, NULL
, default_log_level
);
1110 if (!cfg
->cmd_data
.help
.cfg_component
) {
1117 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1124 struct bt_config
*bt_config_query_create(const bt_value
*plugin_paths
)
1126 struct bt_config
*cfg
;
1129 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1130 plugin_paths
, true);
1135 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1136 if (!cfg
->cmd_data
.query
.object
) {
1137 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1144 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1151 struct bt_config
*bt_config_print_ctf_metadata_create(
1152 const bt_value
*plugin_paths
)
1154 struct bt_config
*cfg
;
1157 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1158 plugin_paths
, true);
1163 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1164 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1165 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1169 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1170 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1171 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1178 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1185 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1186 const bt_value
*plugin_paths
)
1188 struct bt_config
*cfg
;
1191 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1192 plugin_paths
, true);
1197 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1198 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1199 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1203 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1205 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1206 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1213 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1220 int bt_config_append_plugin_paths_check_setuid_setgid(
1221 bt_value
*plugin_paths
, const char *arg
)
1225 if (bt_common_is_setuid_setgid()) {
1226 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1230 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1231 BT_CLI_LOGE_APPEND_CAUSE("Invalid --plugin-path option's argument:\n %s",
1242 * Prints the expected format for a --params option.
1245 void print_expected_params_format(FILE *fp
)
1247 fprintf(fp
, "Expected format of PARAMS\n");
1248 fprintf(fp
, "-------------------------\n");
1250 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1252 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1253 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1254 fprintf(fp
, "and VALUE can be one of:\n");
1256 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1257 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1258 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1259 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1260 fprintf(fp
, " (`0x` prefix) unsigned (with `+` prefix) or signed 64-bit integer.\n");
1261 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1262 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1263 fprintf(fp
, " the null and boolean value symbols above.\n");
1264 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1265 fprintf(fp
, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
1266 fprintf(fp
, " (as described by the current list) and a closing `]`.\n");
1267 fprintf(fp
, "* Map, formatted as an opening `{`, a comma-separated list of PARAM=VALUE\n");
1268 fprintf(fp
, " assignments and a closing `}`.\n");
1270 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1272 fprintf(fp
, "Example:\n");
1274 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1275 fprintf(fp
, " play=+23, observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1276 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\",\n");
1277 fprintf(fp
, " things=[1, \"2\", 3]\n");
1279 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1280 fprintf(fp
, "babeltrace2 from a shell.\n");
1284 bool help_option_is_specified(
1285 const struct bt_argpar_parse_ret
*argpar_parse_ret
)
1288 bool specified
= false;
1290 for (i
= 0; i
< argpar_parse_ret
->items
->len
; i
++) {
1291 struct bt_argpar_item
*argpar_item
=
1292 g_ptr_array_index(argpar_parse_ret
->items
, i
);
1293 struct bt_argpar_item_opt
*argpar_item_opt
;
1295 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
1299 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1300 if (argpar_item_opt
->descr
->id
== OPT_HELP
) {
1310 * Prints the help command usage.
1313 void print_help_usage(FILE *fp
)
1315 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1316 fprintf(fp
, " babeltrace2 [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1318 fprintf(fp
, "Options:\n");
1320 fprintf(fp
, " -h, --help Show this help and quit\n");
1322 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1324 fprintf(fp
, "Use `babeltrace2 list-plugins` to show the list of available plugins.\n");
1328 const struct bt_argpar_opt_descr help_options
[] = {
1329 /* id, short_name, long_name, with_arg */
1330 { OPT_HELP
, 'h', "help", false },
1331 BT_ARGPAR_OPT_DESCR_SENTINEL
1335 * Creates a Babeltrace config object from the arguments of a help
1338 * *retcode is set to the appropriate exit code to use.
1341 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
1342 int *retcode
, const bt_value
*plugin_paths
,
1343 int default_log_level
)
1345 struct bt_config
*cfg
= NULL
;
1346 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1347 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1348 struct bt_argpar_item_non_opt
*non_opt
;
1349 GString
*substring
= NULL
;
1353 cfg
= bt_config_help_create(plugin_paths
, default_log_level
);
1359 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, help_options
, true);
1360 if (argpar_parse_ret
.error
) {
1361 BT_CLI_LOGE_APPEND_CAUSE(
1362 "While parsing `help` command's command-line arguments: %s",
1363 argpar_parse_ret
.error
->str
);
1367 if (help_option_is_specified(&argpar_parse_ret
)) {
1368 print_help_usage(stdout
);
1370 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1374 if (argpar_parse_ret
.items
->len
== 0) {
1375 BT_CLI_LOGE_APPEND_CAUSE(
1376 "Missing plugin name or component class descriptor.");
1378 } else if (argpar_parse_ret
.items
->len
> 1) {
1380 * At this point we know there are least two non-option
1381 * arguments because we don't reach here with `--help`,
1384 non_opt
= argpar_parse_ret
.items
->pdata
[1];
1385 BT_CLI_LOGE_APPEND_CAUSE(
1386 "Extraneous command-line argument specified to `help` command: `%s`.",
1391 non_opt
= argpar_parse_ret
.items
->pdata
[0];
1393 /* Look for unescaped dots in the argument. */
1394 substring
= bt_common_string_until(non_opt
->arg
, ".\\", ".", &end_pos
);
1396 BT_CLI_LOGE_APPEND_CAUSE("Could not consume argument: arg=%s",
1401 if (end_pos
== strlen(non_opt
->arg
)) {
1402 /* Didn't find an unescaped dot, treat it as a plugin name. */
1403 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1407 * Found an unescaped dot, treat it as a component class name.
1409 plugin_comp_cls_names(non_opt
->arg
, NULL
, &plugin_name
, &comp_cls_name
,
1410 &cfg
->cmd_data
.help
.cfg_component
->type
);
1411 if (!plugin_name
|| !comp_cls_name
) {
1412 BT_CLI_LOGE_APPEND_CAUSE(
1413 "Could not parse argument as a component class name: arg=%s",
1418 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1420 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1428 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1431 g_free(plugin_name
);
1432 g_free(comp_cls_name
);
1435 g_string_free(substring
, TRUE
);
1438 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1444 * Prints the help command usage.
1447 void print_query_usage(FILE *fp
)
1449 fprintf(fp
, "Usage: babeltrace2 [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1451 fprintf(fp
, "Options:\n");
1453 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS (see the expected\n");
1454 fprintf(fp
, " format of PARAMS below)\n");
1455 fprintf(fp
, " -h, --help Show this help and quit\n");
1456 fprintf(fp
, "\n\n");
1457 print_expected_params_format(fp
);
1461 const struct bt_argpar_opt_descr query_options
[] = {
1462 /* id, short_name, long_name, with_arg */
1463 { OPT_HELP
, 'h', "help", false },
1464 { OPT_PARAMS
, 'p', "params", true },
1465 BT_ARGPAR_OPT_DESCR_SENTINEL
1469 * Creates a Babeltrace config object from the arguments of a query
1472 * *retcode is set to the appropriate exit code to use.
1475 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1476 int *retcode
, const bt_value
*plugin_paths
,
1477 int default_log_level
)
1480 struct bt_config
*cfg
= NULL
;
1481 const char *component_class_spec
= NULL
;
1482 const char *query_object
= NULL
;
1483 GString
*error_str
= NULL
;
1484 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1486 bt_value
*params
= bt_value_map_create();
1488 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1493 cfg
= bt_config_query_create(plugin_paths
);
1498 error_str
= g_string_new(NULL
);
1500 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1505 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, query_options
, true);
1506 if (argpar_parse_ret
.error
) {
1507 BT_CLI_LOGE_APPEND_CAUSE(
1508 "While parsing `query` command's command-line arguments: %s",
1509 argpar_parse_ret
.error
->str
);
1513 if (help_option_is_specified(&argpar_parse_ret
)) {
1514 print_query_usage(stdout
);
1516 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1520 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1521 struct bt_argpar_item
*argpar_item
=
1522 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1524 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
1525 struct bt_argpar_item_opt
*argpar_item_opt
=
1526 (struct bt_argpar_item_opt
*) argpar_item
;
1527 const char *arg
= argpar_item_opt
->arg
;
1529 switch (argpar_item_opt
->descr
->id
) {
1532 bt_value
*parsed_params
= bt_param_parse(arg
, error_str
);
1533 bt_value_map_extend_status extend_status
;
1534 if (!parsed_params
) {
1535 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1540 extend_status
= bt_value_map_extend(params
, parsed_params
);
1541 BT_VALUE_PUT_REF_AND_RESET(parsed_params
);
1542 if (extend_status
) {
1543 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current parameters with --params option's argument:\n %s",
1550 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1551 argpar_item_opt
->descr
->id
);
1555 struct bt_argpar_item_non_opt
*argpar_item_non_opt
1556 = (struct bt_argpar_item_non_opt
*) argpar_item
;
1559 * We need exactly two non-option arguments
1560 * which are the mandatory component class
1561 * specification and query object.
1563 if (!component_class_spec
) {
1564 component_class_spec
= argpar_item_non_opt
->arg
;
1565 } else if (!query_object
) {
1566 query_object
= argpar_item_non_opt
->arg
;
1568 BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
1569 argpar_item_non_opt
->arg
);
1575 if (!component_class_spec
|| !query_object
) {
1576 print_query_usage(stdout
);
1578 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1582 cfg
->cmd_data
.query
.cfg_component
=
1583 bt_config_component_from_arg(component_class_spec
,
1585 if (!cfg
->cmd_data
.query
.cfg_component
) {
1586 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1587 component_class_spec
);
1592 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
1594 if (strlen(query_object
) == 0) {
1595 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1599 g_string_assign(cfg
->cmd_data
.query
.object
, query_object
);
1604 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1607 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1610 g_string_free(error_str
, TRUE
);
1613 bt_value_put_ref(params
);
1618 * Prints the list-plugins command usage.
1621 void print_list_plugins_usage(FILE *fp
)
1623 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1625 fprintf(fp
, "Options:\n");
1627 fprintf(fp
, " -h, --help Show this help and quit\n");
1629 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1631 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1635 const struct bt_argpar_opt_descr list_plugins_options
[] = {
1636 /* id, short_name, long_name, with_arg */
1637 { OPT_HELP
, 'h', "help", false },
1638 BT_ARGPAR_OPT_DESCR_SENTINEL
1642 * Creates a Babeltrace config object from the arguments of a
1643 * list-plugins command.
1645 * *retcode is set to the appropriate exit code to use.
1648 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
1649 int *retcode
, const bt_value
*plugin_paths
)
1651 struct bt_config
*cfg
= NULL
;
1652 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1655 cfg
= bt_config_list_plugins_create(plugin_paths
);
1661 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, list_plugins_options
, true);
1662 if (argpar_parse_ret
.error
) {
1663 BT_CLI_LOGE_APPEND_CAUSE(
1664 "While parsing `list-plugins` command's command-line arguments: %s",
1665 argpar_parse_ret
.error
->str
);
1669 if (help_option_is_specified(&argpar_parse_ret
)) {
1670 print_list_plugins_usage(stdout
);
1672 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1676 if (argpar_parse_ret
.items
->len
> 0) {
1678 * At this point we know there's at least one non-option
1679 * argument because we don't reach here with `--help`,
1682 struct bt_argpar_item_non_opt
*non_opt
=
1683 argpar_parse_ret
.items
->pdata
[0];
1685 BT_CLI_LOGE_APPEND_CAUSE(
1686 "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
1695 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1698 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1704 * Prints the run command usage.
1707 void print_run_usage(FILE *fp
)
1709 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1711 fprintf(fp
, "Options:\n");
1713 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1714 fprintf(fp
, " for all the following components until\n");
1715 fprintf(fp
, " --reset-base-params is encountered\n");
1716 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1717 fprintf(fp
, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
1718 fprintf(fp
, " Instantiate the component class CLS of type\n");
1719 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1720 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1721 fprintf(fp
, " and name it NAME");
1722 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1723 fprintf(fp
, " expected format of CONNECTION below)\n");
1724 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1725 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
1726 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1727 fprintf(fp
, " current component (see the expected format\n");
1728 fprintf(fp
, " of PARAMS below)\n");
1729 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1730 fprintf(fp
, " empty map\n");
1731 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1732 fprintf(fp
, " the graph later, retry in DUR µs\n");
1733 fprintf(fp
, " (default: 100000)\n");
1734 fprintf(fp
, " -h, --help Show this help and quit\n");
1736 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1737 fprintf(fp
, "\n\n");
1738 fprintf(fp
, "Expected format of CONNECTION\n");
1739 fprintf(fp
, "-----------------------------\n");
1741 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1743 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1744 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1745 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
1746 fprintf(fp
, "component using the NAME prefix of the --component option.\n");
1748 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1749 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1750 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1752 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1753 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1754 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1755 fprintf(fp
, "DOWNSTREAM.\n");
1757 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1758 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1759 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1761 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1762 fprintf(fp
, "can connect a filter component to a sink component.\n");
1764 fprintf(fp
, "Examples:\n");
1766 fprintf(fp
, " my-src:my-sink\n");
1767 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1769 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1770 fprintf(fp
, "babeltrace2 from a shell.\n");
1771 fprintf(fp
, "\n\n");
1772 print_expected_params_format(fp
);
1776 * Creates a Babeltrace config object from the arguments of a run
1779 * *retcode is set to the appropriate exit code to use.
1782 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
1783 int *retcode
, const bt_value
*plugin_paths
,
1784 int default_log_level
)
1786 struct bt_config_component
*cur_cfg_comp
= NULL
;
1787 bt_value
*cur_base_params
= NULL
;
1789 struct bt_config
*cfg
= NULL
;
1790 bt_value
*instance_names
= NULL
;
1791 bt_value
*connection_args
= NULL
;
1792 char error_buf
[256] = { 0 };
1793 long retry_duration
= -1;
1794 bt_value_map_extend_status extend_status
;
1795 GString
*error_str
= NULL
;
1796 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1799 static const struct bt_argpar_opt_descr run_options
[] = {
1800 { OPT_BASE_PARAMS
, 'b', "base-params", true },
1801 { OPT_COMPONENT
, 'c', "component", true },
1802 { OPT_CONNECT
, 'x', "connect", true },
1803 { OPT_HELP
, 'h', "help", false },
1804 { OPT_LOG_LEVEL
, 'l', "log-level", true },
1805 { OPT_PARAMS
, 'p', "params", true },
1806 { OPT_RESET_BASE_PARAMS
, 'r', "reset-base-params", false },
1807 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
1808 BT_ARGPAR_OPT_DESCR_SENTINEL
1813 error_str
= g_string_new(NULL
);
1815 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1820 print_run_usage(stdout
);
1825 cfg
= bt_config_run_create(plugin_paths
);
1830 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1831 cur_base_params
= bt_value_map_create();
1832 if (!cur_base_params
) {
1833 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1837 instance_names
= bt_value_map_create();
1838 if (!instance_names
) {
1839 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1843 connection_args
= bt_value_array_create();
1844 if (!connection_args
) {
1845 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1850 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, run_options
, true);
1851 if (argpar_parse_ret
.error
) {
1852 BT_CLI_LOGE_APPEND_CAUSE(
1853 "While parsing `run` command's command-line arguments: %s",
1854 argpar_parse_ret
.error
->str
);
1858 if (help_option_is_specified(&argpar_parse_ret
)) {
1859 print_run_usage(stdout
);
1861 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1865 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1866 struct bt_argpar_item
*argpar_item
=
1867 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1868 struct bt_argpar_item_opt
*argpar_item_opt
;
1871 /* This command does not accept non-option arguments.*/
1872 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
1873 struct bt_argpar_item_non_opt
*argpar_nonopt_item
=
1874 (struct bt_argpar_item_non_opt
*) argpar_item
;
1876 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
1877 argpar_nonopt_item
->arg
);
1881 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1882 arg
= argpar_item_opt
->arg
;
1884 switch (argpar_item_opt
->descr
->id
) {
1887 enum bt_config_component_dest dest
;
1889 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
1890 cur_cfg_comp
= bt_config_component_from_arg(arg
,
1892 if (!cur_cfg_comp
) {
1893 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
1898 switch (cur_cfg_comp
->type
) {
1899 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1900 dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
1902 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1903 dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
1905 case BT_COMPONENT_CLASS_TYPE_SINK
:
1906 dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
1912 BT_ASSERT(cur_base_params
);
1913 bt_value_put_ref(cur_cfg_comp
->params
);
1914 if (bt_value_copy(cur_base_params
,
1915 &cur_cfg_comp
->params
) < 0) {
1916 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1920 ret
= add_run_cfg_comp_check_name(cfg
,
1933 if (!cur_cfg_comp
) {
1934 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
1939 params
= bt_param_parse(arg
, error_str
);
1941 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1946 extend_status
= bt_value_map_extend(cur_cfg_comp
->params
,
1948 BT_VALUE_PUT_REF_AND_RESET(params
);
1949 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
1950 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
1958 if (!cur_cfg_comp
) {
1959 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
1964 cur_cfg_comp
->log_level
=
1965 bt_log_get_level_from_string(arg
);
1966 if (cur_cfg_comp
->log_level
< 0) {
1967 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
1972 case OPT_BASE_PARAMS
:
1974 bt_value
*params
= bt_param_parse(arg
, error_str
);
1977 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
1982 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
1985 case OPT_RESET_BASE_PARAMS
:
1986 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
1987 cur_base_params
= bt_value_map_create();
1988 if (!cur_base_params
) {
1989 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1994 if (bt_value_array_append_string_element(
1995 connection_args
, arg
)) {
1996 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2000 case OPT_RETRY_DURATION
: {
2002 size_t arg_len
= strlen(argpar_item_opt
->arg
);
2004 retry_duration
= g_ascii_strtoll(argpar_item_opt
->arg
, &end
, 10);
2006 if (arg_len
== 0 || end
!= (argpar_item_opt
->arg
+ arg_len
)) {
2007 BT_CLI_LOGE_APPEND_CAUSE(
2008 "Could not parse --retry-duration option's argument as an unsigned integer: `%s`",
2009 argpar_item_opt
->arg
);
2013 if (retry_duration
< 0) {
2014 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2019 cfg
->cmd_data
.run
.retry_duration_us
=
2020 (uint64_t) retry_duration
;
2024 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
2025 argpar_item_opt
->descr
->id
);
2030 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2032 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2033 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2037 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2038 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2042 ret
= bt_config_cli_args_create_connections(cfg
,
2046 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2054 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2058 g_string_free(error_str
, TRUE
);
2061 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
2062 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2063 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2064 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2065 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2070 struct bt_config
*bt_config_run_from_args_array(const bt_value
*run_args
,
2071 int *retcode
, const bt_value
*plugin_paths
,
2072 int default_log_level
)
2074 struct bt_config
*cfg
= NULL
;
2077 const size_t argc
= bt_value_array_get_length(run_args
);
2079 argv
= calloc(argc
, sizeof(*argv
));
2081 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2085 len
= bt_value_array_get_length(run_args
);
2087 BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
2090 for (i
= 0; i
< len
; i
++) {
2091 const bt_value
*arg_value
=
2092 bt_value_array_borrow_element_by_index_const(run_args
,
2096 BT_ASSERT(arg_value
);
2097 arg
= bt_value_string_get(arg_value
);
2102 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2103 plugin_paths
, default_log_level
);
2111 * Prints the convert command usage.
2114 void print_convert_usage(FILE *fp
)
2116 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2118 fprintf(fp
, "Options:\n");
2120 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2121 fprintf(fp
, " Instantiate the component class CLS of type\n");
2122 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2123 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2124 fprintf(fp
, " conversion graph, and optionally name it\n");
2125 fprintf(fp
, " NAME\n");
2126 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2127 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
2128 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2129 fprintf(fp
, " current component (see the expected format\n");
2130 fprintf(fp
, " of PARAMS below)\n");
2131 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2132 fprintf(fp
, " the graph later, retry in DUR µs\n");
2133 fprintf(fp
, " (default: 100000)\n");
2134 fprintf(fp
, " dynamic plugins can be loaded\n");
2135 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2136 fprintf(fp
, " `run` command to the standard output,\n");
2137 fprintf(fp
, " formatted for a shell, and quit\n");
2138 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2139 fprintf(fp
, " `run` command to the standard output,\n");
2140 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2141 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2142 fprintf(fp
, " are active\n");
2143 fprintf(fp
, " -h, --help Show this help and quit\n");
2145 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2147 fprintf(fp
, " --clock-force-correlate Force the origin of all clocks\n");
2148 fprintf(fp
, " to the Unix epoch\n");
2149 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2150 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2152 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2154 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2155 fprintf(fp
, " --clock-date Print timestamp dates\n");
2156 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2157 fprintf(fp
, " time zone instead of the local time zone\n");
2158 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2159 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2160 fprintf(fp
, " --color=(never | auto | always)\n");
2161 fprintf(fp
, " Never, automatically, or always emit\n");
2162 fprintf(fp
, " console color codes\n");
2163 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2164 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2165 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2166 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2167 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2168 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2169 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2170 fprintf(fp
, " (or `ctx`)\n");
2171 fprintf(fp
, " --no-delta Do not print time delta between\n");
2172 fprintf(fp
, " consecutive events\n");
2173 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2174 fprintf(fp
, " the standard output\n");
2176 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2178 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2179 fprintf(fp
, " time range to BEGIN (see the format of\n");
2180 fprintf(fp
, " BEGIN below)\n");
2181 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2182 fprintf(fp
, " range to END (see the format of END below)\n");
2183 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2184 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2185 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2187 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2189 fprintf(fp
, " --debug-info Create an implicit\n");
2190 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2191 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2192 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2193 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2194 fprintf(fp
, " binary paths instead of just names\n");
2195 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2196 fprintf(fp
, " Use directory DIR as a prefix when\n");
2197 fprintf(fp
, " looking up executables during debug\n");
2198 fprintf(fp
, " info analysis\n");
2200 fprintf(fp
, "Legacy options that still work:\n");
2202 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2203 fprintf(fp
, " `ctf`:\n");
2204 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2205 fprintf(fp
, " component\n");
2206 fprintf(fp
, " `lttng-live`:\n");
2207 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2208 fprintf(fp
, " component\n");
2209 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2210 fprintf(fp
, " `text`:\n");
2211 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2212 fprintf(fp
, " component\n");
2213 fprintf(fp
, " `ctf`:\n");
2214 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2215 fprintf(fp
, " component\n");
2216 fprintf(fp
, " `dummy`:\n");
2217 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2218 fprintf(fp
, " component\n");
2219 fprintf(fp
, " `ctf-metadata`:\n");
2220 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2221 fprintf(fp
, " for metadata text and quit\n");
2223 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2224 fprintf(fp
, "\n\n");
2225 fprintf(fp
, "Format of BEGIN and END\n");
2226 fprintf(fp
, "-----------------------\n");
2228 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2229 fprintf(fp
, "\n\n");
2230 print_expected_params_format(fp
);
2234 const struct bt_argpar_opt_descr convert_options
[] = {
2235 /* id, short_name, long_name, with_arg */
2236 { OPT_BEGIN
, 'b', "begin", true },
2237 { OPT_CLOCK_CYCLES
, '\0', "clock-cycles", false },
2238 { OPT_CLOCK_DATE
, '\0', "clock-date", false },
2239 { OPT_CLOCK_FORCE_CORRELATE
, '\0', "clock-force-correlate", false },
2240 { OPT_CLOCK_GMT
, '\0', "clock-gmt", false },
2241 { OPT_CLOCK_OFFSET
, '\0', "clock-offset", true },
2242 { OPT_CLOCK_OFFSET_NS
, '\0', "clock-offset-ns", true },
2243 { OPT_CLOCK_SECONDS
, '\0', "clock-seconds", false },
2244 { OPT_COLOR
, '\0', "color", true },
2245 { OPT_COMPONENT
, 'c', "component", true },
2246 { OPT_DEBUG
, 'd', "debug", false },
2247 { OPT_DEBUG_INFO_DIR
, '\0', "debug-info-dir", true },
2248 { OPT_DEBUG_INFO_FULL_PATH
, '\0', "debug-info-full-path", false },
2249 { OPT_DEBUG_INFO_TARGET_PREFIX
, '\0', "debug-info-target-prefix", true },
2250 { OPT_END
, 'e', "end", true },
2251 { OPT_FIELDS
, 'f', "fields", true },
2252 { OPT_HELP
, 'h', "help", false },
2253 { OPT_INPUT_FORMAT
, 'i', "input-format", true },
2254 { OPT_LOG_LEVEL
, 'l', "log-level", true },
2255 { OPT_NAMES
, 'n', "names", true },
2256 { OPT_DEBUG_INFO
, '\0', "debug-info", false },
2257 { OPT_NO_DELTA
, '\0', "no-delta", false },
2258 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
2259 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
2260 { OPT_OUTPUT
, 'w', "output", true },
2261 { OPT_OUTPUT_FORMAT
, 'o', "output-format", true },
2262 { OPT_PARAMS
, 'p', "params", true },
2263 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
2264 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
2265 { OPT_RUN_ARGS
, '\0', "run-args", false },
2266 { OPT_RUN_ARGS_0
, '\0', "run-args-0", false },
2267 { OPT_STREAM_INTERSECTION
, '\0', "stream-intersection", false },
2268 { OPT_TIMERANGE
, '\0', "timerange", true },
2269 { OPT_VERBOSE
, 'v', "verbose", false },
2270 BT_ARGPAR_OPT_DESCR_SENTINEL
2274 GString
*get_component_auto_name(const char *prefix
,
2275 const bt_value
*existing_names
)
2278 GString
*auto_name
= g_string_new(NULL
);
2281 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2285 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2286 g_string_assign(auto_name
, prefix
);
2291 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2293 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2299 struct implicit_component_args
{
2302 /* The component class name (e.g. src.ctf.fs). */
2305 /* The component instance name. */
2308 GString
*params_arg
;
2309 bt_value
*extra_params
;
2313 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2314 const char *prefix
, bt_value
*existing_names
,
2315 GList
**comp_names
, bool append_to_comp_names
)
2318 GString
*name
= NULL
;
2320 if (!args
->exists
) {
2324 name
= get_component_auto_name(prefix
,
2332 g_string_assign(args
->name_arg
, name
->str
);
2334 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2336 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2341 if (append_to_comp_names
) {
2342 *comp_names
= g_list_append(*comp_names
, name
);
2348 g_string_free(name
, TRUE
);
2355 int append_run_args_for_implicit_component(
2356 struct implicit_component_args
*impl_args
,
2361 GString
*component_arg_for_run
= NULL
;
2363 if (!impl_args
->exists
) {
2367 component_arg_for_run
= g_string_new(NULL
);
2368 if (!component_arg_for_run
) {
2369 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2373 /* Build the full `name:type.plugin.cls`. */
2374 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, '\\'));
2375 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, ':'));
2376 g_string_printf(component_arg_for_run
, "%s:%s",
2377 impl_args
->name_arg
->str
, impl_args
->comp_arg
->str
);
2379 if (bt_value_array_append_string_element(run_args
, "--component")) {
2380 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2384 if (bt_value_array_append_string_element(run_args
,
2385 component_arg_for_run
->str
)) {
2386 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2390 if (impl_args
->params_arg
->len
> 0) {
2391 if (bt_value_array_append_string_element(run_args
, "--params")) {
2392 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2396 if (bt_value_array_append_string_element(run_args
,
2397 impl_args
->params_arg
->str
)) {
2398 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2403 for (i
= 0; i
< bt_value_array_get_length(impl_args
->extra_params
);
2405 const bt_value
*elem
;
2408 elem
= bt_value_array_borrow_element_by_index(impl_args
->extra_params
,
2414 BT_ASSERT(bt_value_is_string(elem
));
2415 arg
= bt_value_string_get(elem
);
2416 ret
= bt_value_array_append_string_element(run_args
, arg
);
2418 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2429 if (component_arg_for_run
) {
2430 g_string_free(component_arg_for_run
, TRUE
);
2436 /* Free the fields of a `struct implicit_component_args`. */
2439 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2443 if (args
->comp_arg
) {
2444 g_string_free(args
->comp_arg
, TRUE
);
2447 if (args
->name_arg
) {
2448 g_string_free(args
->name_arg
, TRUE
);
2451 if (args
->params_arg
) {
2452 g_string_free(args
->params_arg
, TRUE
);
2455 bt_value_put_ref(args
->extra_params
);
2458 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2461 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2463 finalize_implicit_component_args(args
);
2467 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2470 int init_implicit_component_args(struct implicit_component_args
*args
,
2471 const char *comp_arg
, bool exists
)
2475 args
->exists
= exists
;
2476 args
->comp_arg
= g_string_new(comp_arg
);
2477 args
->name_arg
= g_string_new(NULL
);
2478 args
->params_arg
= g_string_new(NULL
);
2479 args
->extra_params
= bt_value_array_create();
2481 if (!args
->comp_arg
|| !args
->name_arg
||
2482 !args
->params_arg
|| !args
->extra_params
) {
2484 finalize_implicit_component_args(args
);
2485 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2493 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2496 struct implicit_component_args
*create_implicit_component_args(
2497 const char *comp_arg
)
2499 struct implicit_component_args
*args
;
2502 args
= g_new(struct implicit_component_args
, 1);
2504 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2508 status
= init_implicit_component_args(args
, comp_arg
, true);
2519 void append_implicit_component_param(struct implicit_component_args
*args
,
2520 const char *key
, const char *value
)
2525 append_param_arg(args
->params_arg
, key
, value
);
2529 * Append the given parameter (`key=value`) to all component specifications
2530 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2531 * which match `comp_arg`.
2533 * Return the number of matching components.
2537 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2538 const char *comp_arg
, const char *key
, const char *value
)
2543 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2544 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2546 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2547 append_implicit_component_param(args
, key
, value
);
2555 /* Escape value to make it suitable to use as a string parameter value. */
2557 gchar
*escape_string_value(const char *value
)
2562 ret
= g_string_new(NULL
);
2564 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2573 g_string_append_c(ret
, '\\');
2577 g_string_append_c(ret
, *in
);
2583 return g_string_free(ret
, FALSE
);
2587 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2593 switch (bt_value_get_type(value
)) {
2594 case BT_VALUE_TYPE_STRING
:
2596 const char *str_value
= bt_value_string_get(value
);
2597 gchar
*escaped_str_value
;
2599 escaped_str_value
= escape_string_value(str_value
);
2600 if (!escaped_str_value
) {
2604 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2606 g_free(escaped_str_value
);
2609 case BT_VALUE_TYPE_ARRAY
: {
2610 g_string_append_c(buf
, '[');
2611 uint64_t sz
= bt_value_array_get_length(value
);
2612 for (uint64_t i
= 0; i
< sz
; i
++) {
2613 const bt_value
*item
;
2617 g_string_append(buf
, ", ");
2620 item
= bt_value_array_borrow_element_by_index_const(
2622 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2628 g_string_append_c(buf
, ']');
2642 * Convert `value` to its equivalent representation as a command line parameter
2647 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2650 gchar
*result
= NULL
;
2652 buf
= g_string_new(NULL
);
2654 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2658 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2662 result
= g_string_free(buf
, FALSE
);
2669 g_string_free(buf
, TRUE
);
2677 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2680 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2685 gchar
*str_value
= NULL
;
2686 GString
*parameter
= NULL
;
2688 if (bt_value_array_append_string_element(args
, "--params")) {
2689 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2694 str_value
= bt_value_to_cli_param_value(value
);
2700 parameter
= g_string_new(NULL
);
2702 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2707 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2709 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2710 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2717 g_string_free(parameter
, TRUE
);
2730 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2732 bt_value
*str_value
;
2735 str_value
= bt_value_string_create_init(value
);
2738 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2743 ret
= append_parameter_to_args(args
, key
, str_value
);
2746 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2751 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2752 const char *key
, const char *value
)
2754 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2758 * Escapes `.`, `:`, and `\` of `input` with `\`.
2761 GString
*escape_dot_colon(const char *input
)
2763 GString
*output
= g_string_new(NULL
);
2767 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2771 for (ch
= input
; *ch
!= '\0'; ch
++) {
2772 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
2773 g_string_append_c(output
, '\\');
2776 g_string_append_c(output
, *ch
);
2784 * Appends a --connect option to a list of arguments. `upstream_name`
2785 * and `downstream_name` are escaped with escape_dot_colon() in this
2789 int append_connect_arg(bt_value
*run_args
,
2790 const char *upstream_name
, const char *downstream_name
)
2793 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
2794 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
2795 GString
*arg
= g_string_new(NULL
);
2797 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
2798 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2803 ret
= bt_value_array_append_string_element(run_args
, "--connect");
2805 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2810 g_string_append(arg
, e_upstream_name
->str
);
2811 g_string_append_c(arg
, ':');
2812 g_string_append(arg
, e_downstream_name
->str
);
2813 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
2815 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2822 g_string_free(arg
, TRUE
);
2825 if (e_upstream_name
) {
2826 g_string_free(e_upstream_name
, TRUE
);
2829 if (e_downstream_name
) {
2830 g_string_free(e_downstream_name
, TRUE
);
2837 * Appends the run command's --connect options for the convert command.
2840 int convert_auto_connect(bt_value
*run_args
,
2841 GList
*source_names
, GList
*filter_names
,
2845 GList
*source_at
= source_names
;
2846 GList
*filter_at
= filter_names
;
2848 GList
*sink_at
= sink_names
;
2850 BT_ASSERT(source_names
);
2851 BT_ASSERT(filter_names
);
2852 BT_ASSERT(sink_names
);
2854 /* Connect all sources to the first filter */
2855 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
2856 GString
*source_name
= source_at
->data
;
2857 GString
*filter_name
= filter_at
->data
;
2859 ret
= append_connect_arg(run_args
, source_name
->str
,
2866 filter_prev
= filter_at
;
2867 filter_at
= g_list_next(filter_at
);
2869 /* Connect remaining filters */
2870 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
2871 GString
*filter_name
= filter_at
->data
;
2872 GString
*filter_prev_name
= filter_prev
->data
;
2874 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
2881 /* Connect last filter to all sinks */
2882 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
2883 GString
*filter_name
= filter_prev
->data
;
2884 GString
*sink_name
= sink_at
->data
;
2886 ret
= append_connect_arg(run_args
, filter_name
->str
,
2903 int split_timerange(const char *arg
, char **begin
, char **end
)
2906 const char *ch
= arg
;
2908 GString
*g_begin
= NULL
;
2909 GString
*g_end
= NULL
;
2917 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
2918 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
2924 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
2925 if (!g_end
|| g_end
->len
== 0) {
2931 *begin
= g_begin
->str
;
2933 g_string_free(g_begin
, FALSE
);
2934 g_string_free(g_end
, FALSE
);
2944 g_string_free(g_begin
, TRUE
);
2948 g_string_free(g_end
, TRUE
);
2955 int g_list_prepend_gstring(GList
**list
, const char *string
)
2958 GString
*gs
= g_string_new(string
);
2963 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2967 *list
= g_list_prepend(*list
, gs
);
2974 * Create `struct implicit_component_args` structures for each of the
2975 * source components we identified. Add them to `component_args`.
2977 * `non_opts` is an array of the non-option arguments passed on the command
2980 * `non_opt_params` is an array where each element is an array of
2981 * strings containing all the arguments to `--params` that apply to the
2982 * non-option argument at the same index. For example, if, for a
2983 * non-option argument, the following `--params` options applied:
2985 * --params=a=2 --params=b=3,c=4
2987 * its entry in `non_opt_params` would contain
2989 * ["a=2", "b=3,c=4"]
2993 int create_implicit_component_args_from_auto_discovered_sources(
2994 const struct auto_source_discovery
*auto_disc
,
2995 const bt_value
*non_opts
,
2996 const bt_value
*non_opt_params
,
2997 const bt_value
*non_opt_loglevels
,
2998 GPtrArray
*component_args
)
3000 gchar
*cc_name
= NULL
;
3001 struct implicit_component_args
*comp
= NULL
;
3005 len
= auto_disc
->results
->len
;
3007 for (i
= 0; i
< len
; i
++) {
3008 struct auto_source_discovery_result
*res
=
3009 g_ptr_array_index(auto_disc
->results
, i
);
3010 uint64_t orig_indices_i
, orig_indices_count
;
3013 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3015 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3019 comp
= create_implicit_component_args(cc_name
);
3025 * Append parameters and log levels of all the
3026 * non-option arguments that contributed to this
3027 * component instance coming into existence.
3029 orig_indices_count
= bt_value_array_get_length(res
->original_input_indices
);
3030 for (orig_indices_i
= 0; orig_indices_i
< orig_indices_count
; orig_indices_i
++) {
3031 const bt_value
*orig_idx_value
=
3032 bt_value_array_borrow_element_by_index(
3033 res
->original_input_indices
, orig_indices_i
);
3034 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3035 const bt_value
*params_array
=
3036 bt_value_array_borrow_element_by_index_const(
3037 non_opt_params
, orig_idx
);
3038 uint64_t params_i
, params_count
;
3039 const bt_value
*loglevel_value
;
3041 params_count
= bt_value_array_get_length(params_array
);
3042 for (params_i
= 0; params_i
< params_count
; params_i
++) {
3043 const bt_value
*params_value
=
3044 bt_value_array_borrow_element_by_index_const(
3045 params_array
, params_i
);
3046 const char *params
= bt_value_string_get(params_value
);
3047 bt_value_array_append_element_status append_status
;
3049 append_status
= bt_value_array_append_string_element(
3050 comp
->extra_params
, "--params");
3051 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3052 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3056 append_status
= bt_value_array_append_string_element(
3057 comp
->extra_params
, params
);
3058 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3059 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3064 loglevel_value
= bt_value_array_borrow_element_by_index_const(
3065 non_opt_loglevels
, orig_idx
);
3066 if (bt_value_get_type(loglevel_value
) == BT_VALUE_TYPE_STRING
) {
3067 const char *loglevel
= bt_value_string_get(loglevel_value
);
3068 bt_value_array_append_element_status append_status
;
3070 append_status
= bt_value_array_append_string_element(
3071 comp
->extra_params
, "--log-level");
3072 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3073 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3077 append_status
= bt_value_array_append_string_element(
3078 comp
->extra_params
, loglevel
);
3079 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3080 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3087 * If single input and a src.ctf.fs component, provide the
3088 * relative path from the path passed on the command line to the
3091 if (bt_value_array_get_length(res
->inputs
) == 1 &&
3092 strcmp(res
->plugin_name
, "ctf") == 0 &&
3093 strcmp(res
->source_cc_name
, "fs") == 0) {
3094 const bt_value
*orig_idx_value
=
3095 bt_value_array_borrow_element_by_index(
3096 res
->original_input_indices
, 0);
3097 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3098 const bt_value
*non_opt_value
=
3099 bt_value_array_borrow_element_by_index_const(
3100 non_opts
, orig_idx
);
3101 const char *non_opt
= bt_value_string_get(non_opt_value
);
3102 const bt_value
*input_value
=
3103 bt_value_array_borrow_element_by_index_const(
3105 const char *input
= bt_value_string_get(input_value
);
3107 BT_ASSERT(orig_indices_count
== 1);
3108 BT_ASSERT(g_str_has_prefix(input
, non_opt
));
3110 input
+= strlen(non_opt
);
3112 while (G_IS_DIR_SEPARATOR(*input
)) {
3116 if (strlen(input
) > 0) {
3117 append_string_parameter_to_args(comp
->extra_params
,
3118 "trace-name", input
);
3122 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3127 g_ptr_array_add(component_args
, comp
);
3141 destroy_implicit_component_args(comp
);
3148 * As we iterate the arguments to the convert command, this tracks what is the
3149 * type of the current item, to which some contextual options (e.g. --params)
3152 enum convert_current_item_type
{
3153 /* There is no current item. */
3154 CONVERT_CURRENT_ITEM_TYPE_NONE
,
3156 /* Current item is a component. */
3157 CONVERT_CURRENT_ITEM_TYPE_COMPONENT
,
3159 /* Current item is a non-option argument. */
3160 CONVERT_CURRENT_ITEM_TYPE_NON_OPT
,
3164 * Creates a Babeltrace config object from the arguments of a convert
3167 * *retcode is set to the appropriate exit code to use.
3170 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3171 int *retcode
, const bt_value
*plugin_paths
,
3172 int *default_log_level
, const bt_interrupter
*interrupter
)
3174 enum convert_current_item_type current_item_type
=
3175 CONVERT_CURRENT_ITEM_TYPE_NONE
;
3177 struct bt_config
*cfg
= NULL
;
3178 bool got_input_format_opt
= false;
3179 bool got_output_format_opt
= false;
3180 bool trimmer_has_begin
= false;
3181 bool trimmer_has_end
= false;
3182 bool stream_intersection_mode
= false;
3183 bool print_run_args
= false;
3184 bool print_run_args_0
= false;
3185 bool print_ctf_metadata
= false;
3186 bt_value
*run_args
= NULL
;
3187 bt_value
*all_names
= NULL
;
3188 GList
*source_names
= NULL
;
3189 GList
*filter_names
= NULL
;
3190 GList
*sink_names
= NULL
;
3191 bt_value
*non_opts
= NULL
;
3192 bt_value
*non_opt_params
= NULL
;
3193 bt_value
*non_opt_loglevels
= NULL
;
3194 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3195 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3196 struct implicit_component_args implicit_dummy_args
= { 0 };
3197 struct implicit_component_args implicit_text_args
= { 0 };
3198 struct implicit_component_args implicit_debug_info_args
= { 0 };
3199 struct implicit_component_args implicit_muxer_args
= { 0 };
3200 struct implicit_component_args implicit_trimmer_args
= { 0 };
3201 char error_buf
[256] = { 0 };
3203 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3204 char *output
= NULL
;
3205 struct auto_source_discovery auto_disc
= { NULL
};
3206 GString
*auto_disc_comp_name
= NULL
;
3207 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
3208 GString
*name_gstr
= NULL
;
3209 GString
*component_arg_for_run
= NULL
;
3210 bt_value
*live_inputs_array_val
= NULL
;
3213 * Array of `struct implicit_component_args *` created for the sources
3214 * we have auto-discovered.
3216 GPtrArray
*discovered_source_args
= NULL
;
3219 * If set, restrict automatic source discovery to this component class
3222 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3223 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3225 bool ctf_fs_source_force_clock_class_unix_epoch_origin
= false;
3226 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3227 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3231 print_convert_usage(stdout
);
3236 if (init_implicit_component_args(&implicit_ctf_output_args
,
3237 "sink.ctf.fs", false)) {
3241 if (init_implicit_component_args(&implicit_lttng_live_args
,
3242 "source.ctf.lttng-live", false)) {
3246 if (init_implicit_component_args(&implicit_text_args
,
3247 "sink.text.pretty", false)) {
3251 if (init_implicit_component_args(&implicit_dummy_args
,
3252 "sink.utils.dummy", false)) {
3256 if (init_implicit_component_args(&implicit_debug_info_args
,
3257 "filter.lttng-utils.debug-info", false)) {
3261 if (init_implicit_component_args(&implicit_muxer_args
,
3262 "filter.utils.muxer", true)) {
3266 if (init_implicit_component_args(&implicit_trimmer_args
,
3267 "filter.utils.trimmer", false)) {
3271 all_names
= bt_value_map_create();
3273 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3277 run_args
= bt_value_array_create();
3279 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3283 component_arg_for_run
= g_string_new(NULL
);
3284 if (!component_arg_for_run
) {
3285 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3289 non_opts
= bt_value_array_create();
3291 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3295 non_opt_params
= bt_value_array_create();
3296 if (!non_opt_params
) {
3297 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3301 non_opt_loglevels
= bt_value_array_create();
3302 if (!non_opt_loglevels
) {
3303 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3307 if (auto_source_discovery_init(&auto_disc
) != 0) {
3311 discovered_source_args
=
3312 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3313 if (!discovered_source_args
) {
3314 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3318 auto_disc_comp_name
= g_string_new(NULL
);
3319 if (!auto_disc_comp_name
) {
3320 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3325 * First pass: collect all arguments which need to be passed
3326 * as is to the run command. This pass can also add --name
3327 * arguments if needed to automatically name unnamed component
3330 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, convert_options
, true);
3331 if (argpar_parse_ret
.error
) {
3332 BT_CLI_LOGE_APPEND_CAUSE(
3333 "While parsing `convert` command's command-line arguments: %s",
3334 argpar_parse_ret
.error
->str
);
3338 if (help_option_is_specified(&argpar_parse_ret
)) {
3339 print_convert_usage(stdout
);
3341 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3345 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3346 struct bt_argpar_item
*argpar_item
=
3347 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3348 struct bt_argpar_item_opt
*argpar_item_opt
;
3350 char *plugin_name
= NULL
;
3351 char *comp_cls_name
= NULL
;
3354 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
3355 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3356 arg
= argpar_item_opt
->arg
;
3358 switch (argpar_item_opt
->descr
->id
) {
3361 bt_component_class_type type
;
3363 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_COMPONENT
;
3365 /* Parse the argument */
3366 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3367 &comp_cls_name
, &type
);
3368 if (!plugin_name
|| !comp_cls_name
) {
3369 BT_CLI_LOGE_APPEND_CAUSE(
3370 "Invalid format for --component option's argument:\n %s",
3377 * Name was given by the user, verify it isn't
3380 if (bt_value_map_has_entry(all_names
, name
)) {
3381 BT_CLI_LOGE_APPEND_CAUSE(
3382 "Duplicate component instance name:\n %s",
3387 name_gstr
= g_string_new(name
);
3389 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3393 g_string_assign(component_arg_for_run
, arg
);
3395 /* Name not given by user, generate one. */
3396 name_gstr
= get_component_auto_name(arg
, all_names
);
3401 g_string_printf(component_arg_for_run
, "%s:%s",
3402 name_gstr
->str
, arg
);
3405 if (bt_value_array_append_string_element(run_args
,
3407 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3411 if (bt_value_array_append_string_element(run_args
,
3412 component_arg_for_run
->str
)) {
3413 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3418 * Remember this name globally, for the uniqueness of
3419 * all component names.
3421 if (bt_value_map_insert_entry(all_names
,
3422 name_gstr
->str
, bt_value_null
)) {
3423 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3428 * Remember this name specifically for the type of the
3429 * component. This is to create connection arguments.
3431 * The list takes ownership of `name_gstr`.
3434 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3435 source_names
= g_list_append(source_names
, name_gstr
);
3437 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3438 filter_names
= g_list_append(filter_names
, name_gstr
);
3440 case BT_COMPONENT_CLASS_TYPE_SINK
:
3441 sink_names
= g_list_append(sink_names
, name_gstr
);
3450 free(comp_cls_name
);
3453 comp_cls_name
= NULL
;
3457 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3459 * The current item is a component (--component option),
3460 * pass it directly to the run args.
3462 if (bt_value_array_append_string_element(run_args
,
3464 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3468 if (bt_value_array_append_string_element(run_args
, arg
)) {
3469 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3472 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3474 * The current item is a
3475 * non-option argument, record
3476 * it in `non_opt_params`.
3479 bt_value_array_append_element_status append_element_status
;
3480 uint64_t idx
= bt_value_array_get_length(non_opt_params
) - 1;
3482 array
= bt_value_array_borrow_element_by_index(non_opt_params
, idx
);
3484 append_element_status
= bt_value_array_append_string_element(array
, arg
);
3485 if (append_element_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3486 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3490 BT_CLI_LOGE_APPEND_CAUSE(
3491 "No current component (--component option) or non-option argument of which to set parameters:\n %s",
3497 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3498 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3499 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3503 if (bt_value_array_append_string_element(run_args
, arg
)) {
3504 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3507 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3508 uint64_t idx
= bt_value_array_get_length(non_opt_loglevels
) - 1;
3509 bt_value
*log_level_str_value
;
3511 log_level_str_value
= bt_value_string_create_init(arg
);
3512 if (!log_level_str_value
) {
3513 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3517 if (bt_value_array_set_element_by_index(non_opt_loglevels
, idx
,
3518 log_level_str_value
)) {
3519 bt_value_put_ref(log_level_str_value
);
3520 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3524 BT_CLI_LOGE_APPEND_CAUSE(
3525 "No current component (--component option) or non-option argument to assign a log level to:\n %s",
3531 case OPT_RETRY_DURATION
:
3532 if (bt_value_array_append_string_element(run_args
,
3533 "--retry-duration")) {
3534 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3538 if (bt_value_array_append_string_element(run_args
, arg
)) {
3539 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3544 case OPT_CLOCK_CYCLES
:
3545 case OPT_CLOCK_DATE
:
3546 case OPT_CLOCK_FORCE_CORRELATE
:
3548 case OPT_CLOCK_OFFSET
:
3549 case OPT_CLOCK_OFFSET_NS
:
3550 case OPT_CLOCK_SECONDS
:
3553 case OPT_DEBUG_INFO
:
3554 case OPT_DEBUG_INFO_DIR
:
3555 case OPT_DEBUG_INFO_FULL_PATH
:
3556 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3559 case OPT_INPUT_FORMAT
:
3562 case OPT_OUTPUT_FORMAT
:
3565 case OPT_RUN_ARGS_0
:
3566 case OPT_STREAM_INTERSECTION
:
3569 /* Ignore in this pass */
3572 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
3573 argpar_item_opt
->descr
->id
);
3576 } else if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
3577 struct bt_argpar_item_non_opt
*argpar_item_non_opt
;
3578 bt_value_array_append_element_status append_status
;
3580 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_NON_OPT
;
3582 argpar_item_non_opt
= (struct bt_argpar_item_non_opt
*) argpar_item
;
3584 append_status
= bt_value_array_append_string_element(non_opts
,
3585 argpar_item_non_opt
->arg
);
3586 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3587 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3591 append_status
= bt_value_array_append_empty_array_element(
3592 non_opt_params
, NULL
);
3593 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3594 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3598 append_status
= bt_value_array_append_element(non_opt_loglevels
, bt_value_null
);
3599 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3600 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3609 * Second pass: transform the convert-specific options and
3610 * arguments into implicit component instances for the run
3613 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3614 struct bt_argpar_item
*argpar_item
=
3615 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3616 struct bt_argpar_item_opt
*argpar_item_opt
;
3619 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
3623 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3624 arg
= argpar_item_opt
->arg
;
3626 switch (argpar_item_opt
->descr
->id
) {
3628 if (trimmer_has_begin
) {
3629 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
3634 trimmer_has_begin
= true;
3635 ret
= append_implicit_component_extra_param(
3636 &implicit_trimmer_args
, "begin", arg
);
3637 implicit_trimmer_args
.exists
= true;
3643 if (trimmer_has_end
) {
3644 printf("At --end option: --end or --timerange option already specified\n %s\n",
3649 trimmer_has_end
= true;
3650 ret
= append_implicit_component_extra_param(
3651 &implicit_trimmer_args
, "end", arg
);
3652 implicit_trimmer_args
.exists
= true;
3662 if (trimmer_has_begin
|| trimmer_has_end
) {
3663 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3668 ret
= split_timerange(arg
, &begin
, &end
);
3670 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3675 ret
= append_implicit_component_extra_param(
3676 &implicit_trimmer_args
, "begin", begin
);
3677 ret
|= append_implicit_component_extra_param(
3678 &implicit_trimmer_args
, "end", end
);
3679 implicit_trimmer_args
.exists
= true;
3687 case OPT_CLOCK_CYCLES
:
3688 append_implicit_component_param(
3689 &implicit_text_args
, "clock-cycles", "yes");
3690 implicit_text_args
.exists
= true;
3692 case OPT_CLOCK_DATE
:
3693 append_implicit_component_param(
3694 &implicit_text_args
, "clock-date", "yes");
3695 implicit_text_args
.exists
= true;
3697 case OPT_CLOCK_FORCE_CORRELATE
:
3698 ctf_fs_source_force_clock_class_unix_epoch_origin
= true;
3701 append_implicit_component_param(
3702 &implicit_text_args
, "clock-gmt", "yes");
3703 append_implicit_component_param(
3704 &implicit_trimmer_args
, "gmt", "yes");
3705 implicit_text_args
.exists
= true;
3707 case OPT_CLOCK_OFFSET
:
3708 if (ctf_fs_source_clock_class_offset_arg
) {
3709 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3713 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3714 if (!ctf_fs_source_clock_class_offset_arg
) {
3715 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3719 case OPT_CLOCK_OFFSET_NS
:
3720 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3721 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3725 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3726 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3727 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3731 case OPT_CLOCK_SECONDS
:
3732 append_implicit_component_param(
3733 &implicit_text_args
, "clock-seconds", "yes");
3734 implicit_text_args
.exists
= true;
3737 implicit_text_args
.exists
= true;
3738 ret
= append_implicit_component_extra_param(
3739 &implicit_text_args
, "color", arg
);
3744 case OPT_DEBUG_INFO
:
3745 implicit_debug_info_args
.exists
= true;
3747 case OPT_DEBUG_INFO_DIR
:
3748 implicit_debug_info_args
.exists
= true;
3749 ret
= append_implicit_component_extra_param(
3750 &implicit_debug_info_args
, "debug-info-dir", arg
);
3755 case OPT_DEBUG_INFO_FULL_PATH
:
3756 implicit_debug_info_args
.exists
= true;
3757 append_implicit_component_param(
3758 &implicit_debug_info_args
, "full-path", "yes");
3760 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3761 implicit_debug_info_args
.exists
= true;
3762 ret
= append_implicit_component_extra_param(
3763 &implicit_debug_info_args
,
3764 "target-prefix", arg
);
3771 bt_value
*fields
= fields_from_arg(arg
);
3777 implicit_text_args
.exists
= true;
3778 ret
= insert_flat_params_from_array(
3779 implicit_text_args
.params_arg
,
3781 bt_value_put_ref(fields
);
3789 bt_value
*names
= names_from_arg(arg
);
3795 implicit_text_args
.exists
= true;
3796 ret
= insert_flat_params_from_array(
3797 implicit_text_args
.params_arg
,
3799 bt_value_put_ref(names
);
3806 append_implicit_component_param(
3807 &implicit_text_args
, "no-delta", "yes");
3808 implicit_text_args
.exists
= true;
3810 case OPT_INPUT_FORMAT
:
3811 if (got_input_format_opt
) {
3812 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3816 got_input_format_opt
= true;
3818 if (strcmp(arg
, "ctf") == 0) {
3819 auto_source_discovery_restrict_plugin_name
= "ctf";
3820 auto_source_discovery_restrict_component_class_name
= "fs";
3821 } else if (strcmp(arg
, "lttng-live") == 0) {
3822 auto_source_discovery_restrict_plugin_name
= "ctf";
3823 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3824 implicit_lttng_live_args
.exists
= true;
3826 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
3831 case OPT_OUTPUT_FORMAT
:
3832 if (got_output_format_opt
) {
3833 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
3837 got_output_format_opt
= true;
3839 if (strcmp(arg
, "text") == 0) {
3840 implicit_text_args
.exists
= true;
3841 } else if (strcmp(arg
, "ctf") == 0) {
3842 implicit_ctf_output_args
.exists
= true;
3843 } else if (strcmp(arg
, "dummy") == 0) {
3844 implicit_dummy_args
.exists
= true;
3845 } else if (strcmp(arg
, "ctf-metadata") == 0) {
3846 print_ctf_metadata
= true;
3848 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
3855 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
3859 output
= strdup(arg
);
3861 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3866 if (print_run_args_0
) {
3867 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3871 print_run_args
= true;
3873 case OPT_RUN_ARGS_0
:
3874 if (print_run_args
) {
3875 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3879 print_run_args_0
= true;
3881 case OPT_STREAM_INTERSECTION
:
3883 * Applies to all traces implementing the
3884 * babeltrace.trace-infos query.
3886 stream_intersection_mode
= true;
3889 *default_log_level
=
3890 logging_level_min(*default_log_level
, BT_LOG_INFO
);
3893 *default_log_level
=
3894 logging_level_min(*default_log_level
, BT_LOG_TRACE
);
3901 set_auto_log_levels(default_log_level
);
3904 * Legacy behaviour: --verbose used to make the `text` output
3905 * format print more information. --verbose is now equivalent to
3906 * the INFO log level, which is why we compare to `BT_LOG_INFO`
3909 if (*default_log_level
== BT_LOG_INFO
) {
3910 append_implicit_component_param(&implicit_text_args
,
3914 /* Print CTF metadata or print LTTng live sessions */
3915 if (print_ctf_metadata
) {
3916 const bt_value
*bt_val_non_opt
;
3918 if (bt_value_array_is_empty(non_opts
)) {
3919 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
3923 if (bt_value_array_get_length(non_opts
) > 1) {
3924 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
3928 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
3933 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
3934 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
3935 bt_value_string_get(bt_val_non_opt
));
3939 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
3947 * If -o ctf was specified, make sure an output path (--output)
3948 * was also specified. --output does not imply -o ctf because
3949 * it's also used for the default, implicit -o text if -o ctf
3952 if (implicit_ctf_output_args
.exists
) {
3954 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
3959 * At this point we know that -o ctf AND --output were
3960 * specified. Make sure that no options were specified
3961 * which would imply -o text because --output would be
3962 * ambiguous in this case. For example, this is wrong:
3964 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
3966 * because --names=all implies -o text, and --output
3967 * could apply to both the sink.text.pretty and
3968 * sink.ctf.fs implicit components.
3970 if (implicit_text_args
.exists
) {
3971 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
3977 * If -o dummy and -o ctf were not specified, and if there are
3978 * no explicit sink components, then use an implicit
3979 * `sink.text.pretty` component.
3981 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
3983 implicit_text_args
.exists
= true;
3987 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
3988 * `path` parameter if --output was specified.
3991 if (implicit_text_args
.exists
) {
3992 append_implicit_component_extra_param(&implicit_text_args
,
3994 } else if (implicit_ctf_output_args
.exists
) {
3995 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4000 /* Decide where the non-option argument(s) go */
4001 if (bt_value_array_get_length(non_opts
) > 0) {
4002 if (implicit_lttng_live_args
.exists
) {
4003 const bt_value
*bt_val_non_opt
;
4005 if (bt_value_array_get_length(non_opts
) > 1) {
4006 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
4010 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
4011 lttng_live_url_parts
=
4012 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt
),
4013 error_buf
, sizeof(error_buf
));
4014 if (!lttng_live_url_parts
.proto
) {
4015 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
4020 if (!lttng_live_url_parts
.session_name
) {
4021 /* Print LTTng live sessions */
4022 cfg
= bt_config_print_lttng_live_sessions_create(
4028 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4029 bt_value_string_get(bt_val_non_opt
));
4033 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4040 live_inputs_array_val
= bt_value_array_create();
4041 if (!live_inputs_array_val
) {
4042 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4046 if (bt_value_array_append_string_element(
4047 live_inputs_array_val
,
4048 bt_value_string_get(bt_val_non_opt
))) {
4049 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4053 ret
= append_parameter_to_args(
4054 implicit_lttng_live_args
.extra_params
,
4055 "inputs", live_inputs_array_val
);
4060 ret
= append_implicit_component_extra_param(
4061 &implicit_lttng_live_args
,
4062 "session-not-found-action", "end");
4068 size_t plugin_count
;
4069 const bt_plugin
**plugins
;
4070 const bt_plugin
*plugin
;
4072 status
= require_loaded_plugins(plugin_paths
);
4077 if (auto_source_discovery_restrict_plugin_name
) {
4079 plugin
= find_loaded_plugin(auto_source_discovery_restrict_plugin_name
);
4082 plugin_count
= get_loaded_plugins_count();
4083 plugins
= borrow_loaded_plugins();
4086 status
= auto_discover_source_components(non_opts
, plugins
, plugin_count
,
4087 auto_source_discovery_restrict_component_class_name
,
4088 *default_log_level
, &auto_disc
, interrupter
);
4091 if (status
== AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED
) {
4092 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
4093 "Babeltrace CLI", "Automatic source discovery interrupted by the user");
4098 status
= create_implicit_component_args_from_auto_discovered_sources(
4099 &auto_disc
, non_opts
, non_opt_params
, non_opt_loglevels
,
4100 discovered_source_args
);
4109 * If --clock-force-correlated was given, apply it to any src.ctf.fs
4112 if (ctf_fs_source_force_clock_class_unix_epoch_origin
) {
4115 n
= append_multiple_implicit_components_param(
4116 discovered_source_args
, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
4119 BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
4124 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4125 if (ctf_fs_source_clock_class_offset_arg
) {
4128 n
= append_multiple_implicit_components_param(
4129 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4130 ctf_fs_source_clock_class_offset_arg
);
4133 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4138 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4139 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4142 n
= append_multiple_implicit_components_param(
4143 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4144 ctf_fs_source_clock_class_offset_ns_arg
);
4147 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4153 * If the implicit `source.ctf.lttng-live` component exists,
4154 * make sure there's at least one non-option argument (which is
4157 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(non_opts
)) {
4158 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4159 implicit_lttng_live_args
.comp_arg
->str
);
4163 /* Assign names to implicit components */
4164 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4165 struct implicit_component_args
*args
;
4168 args
= discovered_source_args
->pdata
[i
];
4170 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4172 /* Give it a name like `auto-disc-src-ctf-fs`. */
4173 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4174 if (auto_disc_comp_name
->str
[j
] == '.') {
4175 auto_disc_comp_name
->str
[j
] = '-';
4179 ret
= assign_name_to_implicit_component(args
,
4180 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4186 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4187 "lttng-live", all_names
, &source_names
, true);
4192 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4193 "pretty", all_names
, &sink_names
, true);
4198 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4199 "sink-ctf-fs", all_names
, &sink_names
, true);
4204 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4205 "dummy", all_names
, &sink_names
, true);
4210 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4211 "muxer", all_names
, NULL
, false);
4216 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4217 "trimmer", all_names
, NULL
, false);
4222 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4223 "debug-info", all_names
, NULL
, false);
4228 /* Make sure there's at least one source and one sink */
4229 if (!source_names
) {
4230 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4235 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4239 /* Make sure there's a single sink component */
4240 if (g_list_length(sink_names
) != 1) {
4241 BT_CLI_LOGE_APPEND_CAUSE(
4242 "More than one sink component specified.");
4247 * Prepend the muxer, the trimmer, and the debug info to the
4248 * filter chain so that we have:
4250 * sources -> muxer -> [trimmer] -> [debug info] ->
4251 * [user filters] -> sinks
4253 if (implicit_debug_info_args
.exists
) {
4254 if (g_list_prepend_gstring(&filter_names
,
4255 implicit_debug_info_args
.name_arg
->str
)) {
4260 if (implicit_trimmer_args
.exists
) {
4261 if (g_list_prepend_gstring(&filter_names
,
4262 implicit_trimmer_args
.name_arg
->str
)) {
4267 if (g_list_prepend_gstring(&filter_names
,
4268 implicit_muxer_args
.name_arg
->str
)) {
4273 * Append the equivalent run arguments for the implicit
4276 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4277 struct implicit_component_args
*args
=
4278 discovered_source_args
->pdata
[i
];
4280 ret
= append_run_args_for_implicit_component(args
, run_args
);
4286 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4292 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4298 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4304 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4310 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4316 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4322 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4328 /* Auto-connect components */
4329 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4332 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4337 * We have all the run command arguments now. Depending on
4338 * --run-args, we pass this to the run command or print them
4341 if (print_run_args
|| print_run_args_0
) {
4342 if (stream_intersection_mode
) {
4343 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4347 for (i
= 0; i
< bt_value_array_get_length(run_args
); i
++) {
4348 const bt_value
*arg_value
=
4349 bt_value_array_borrow_element_by_index(run_args
,
4352 GString
*quoted
= NULL
;
4353 const char *arg_to_print
;
4355 BT_ASSERT(arg_value
);
4356 arg
= bt_value_string_get(arg_value
);
4358 if (print_run_args
) {
4359 quoted
= bt_common_shell_quote(arg
, true);
4364 arg_to_print
= quoted
->str
;
4369 printf("%s", arg_to_print
);
4372 g_string_free(quoted
, TRUE
);
4375 if (i
< bt_value_array_get_length(run_args
) - 1) {
4376 if (print_run_args
) {
4385 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4389 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4390 plugin_paths
, *default_log_level
);
4395 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4400 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4403 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4407 if (component_arg_for_run
) {
4408 g_string_free(component_arg_for_run
, TRUE
);
4412 g_string_free(name_gstr
, TRUE
);
4415 bt_value_put_ref(live_inputs_array_val
);
4416 bt_value_put_ref(run_args
);
4417 bt_value_put_ref(all_names
);
4418 destroy_glist_of_gstring(source_names
);
4419 destroy_glist_of_gstring(filter_names
);
4420 destroy_glist_of_gstring(sink_names
);
4421 bt_value_put_ref(non_opt_params
);
4422 bt_value_put_ref(non_opt_loglevels
);
4423 bt_value_put_ref(non_opts
);
4424 finalize_implicit_component_args(&implicit_ctf_output_args
);
4425 finalize_implicit_component_args(&implicit_lttng_live_args
);
4426 finalize_implicit_component_args(&implicit_dummy_args
);
4427 finalize_implicit_component_args(&implicit_text_args
);
4428 finalize_implicit_component_args(&implicit_debug_info_args
);
4429 finalize_implicit_component_args(&implicit_muxer_args
);
4430 finalize_implicit_component_args(&implicit_trimmer_args
);
4431 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4432 auto_source_discovery_fini(&auto_disc
);
4434 if (discovered_source_args
) {
4435 g_ptr_array_free(discovered_source_args
, TRUE
);
4438 g_free(ctf_fs_source_clock_class_offset_arg
);
4439 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4441 if (auto_disc_comp_name
) {
4442 g_string_free(auto_disc_comp_name
, TRUE
);
4449 * Prints the Babeltrace 2.x general usage.
4452 void print_gen_usage(FILE *fp
)
4454 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4456 fprintf(fp
, "General options:\n");
4458 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=T)\n");
4459 fprintf(fp
, " -h, --help Show this help and quit\n");
4460 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `T`, `D`,\n");
4461 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4462 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
4463 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
4464 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
4465 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
4466 fprintf(fp
, " dynamic plugins can be loaded\n");
4467 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4468 fprintf(fp
, " -V, --version Show version and quit\n");
4470 fprintf(fp
, "Available commands:\n");
4472 fprintf(fp
, " convert Convert and trim traces (default)\n");
4473 fprintf(fp
, " help Get help for a plugin or a component class\n");
4474 fprintf(fp
, " list-plugins List available plugins and their content\n");
4475 fprintf(fp
, " query Query objects from a component class\n");
4476 fprintf(fp
, " run Build a processing graph and run it\n");
4478 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4481 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4482 int *retcode
, bool omit_system_plugin_path
,
4483 bool omit_home_plugin_path
,
4484 const bt_value
*initial_plugin_paths
,
4485 const bt_interrupter
*interrupter
)
4487 struct bt_config
*config
= NULL
;
4490 const char **top_level_argv
;
4491 int command_argc
= -1;
4492 const char **command_argv
= NULL
;
4493 const char *command_name
= NULL
;
4494 int default_log_level
= -1;
4495 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
4496 bt_value
*plugin_paths
= NULL
;
4498 /* Top-level option descriptions. */
4499 static const struct bt_argpar_opt_descr descrs
[] = {
4500 { OPT_DEBUG
, 'd', "debug", false },
4501 { OPT_HELP
, 'h', "help", false },
4502 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4503 { OPT_VERBOSE
, 'v', "verbose", false },
4504 { OPT_VERSION
, 'V', "version", false},
4505 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
4506 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
4507 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
4508 BT_ARGPAR_OPT_DESCR_SENTINEL
4512 COMMAND_TYPE_NONE
= -1,
4513 COMMAND_TYPE_RUN
= 0,
4514 COMMAND_TYPE_CONVERT
,
4515 COMMAND_TYPE_LIST_PLUGINS
,
4518 } command_type
= COMMAND_TYPE_NONE
;
4522 if (!initial_plugin_paths
) {
4523 plugin_paths
= bt_value_array_create();
4524 if (!plugin_paths
) {
4528 bt_value_copy_status copy_status
= bt_value_copy(
4529 initial_plugin_paths
, &plugin_paths
);
4535 BT_ASSERT(plugin_paths
);
4538 * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
4539 * `--plugin-path` option's paths, so append it now before
4540 * parsing the general options.
4542 if (append_env_var_plugin_paths(plugin_paths
)) {
4549 print_gen_usage(stdout
);
4553 /* Skip first argument, the name of the program. */
4554 top_level_argc
= argc
- 1;
4555 top_level_argv
= argv
+ 1;
4556 argpar_parse_ret
= bt_argpar_parse(top_level_argc
, top_level_argv
,
4559 if (argpar_parse_ret
.error
) {
4560 BT_CLI_LOGE_APPEND_CAUSE(
4561 "While parsing command-line arguments: %s",
4562 argpar_parse_ret
.error
->str
);
4566 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
4567 struct bt_argpar_item
*item
;
4569 item
= g_ptr_array_index(argpar_parse_ret
.items
, i
);
4571 if (item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
4572 struct bt_argpar_item_opt
*item_opt
=
4573 (struct bt_argpar_item_opt
*) item
;
4575 switch (item_opt
->descr
->id
) {
4578 logging_level_min(default_log_level
, BT_LOG_TRACE
);
4582 logging_level_min(default_log_level
, BT_LOG_INFO
);
4586 int level
= bt_log_get_level_from_string(item_opt
->arg
);
4589 BT_CLI_LOGE_APPEND_CAUSE(
4590 "Invalid argument for --log-level option:\n %s",
4596 logging_level_min(default_log_level
, level
);
4599 case OPT_PLUGIN_PATH
:
4600 if (bt_config_append_plugin_paths_check_setuid_setgid(
4601 plugin_paths
, item_opt
->arg
)) {
4605 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4606 omit_system_plugin_path
= true;
4608 case OPT_OMIT_HOME_PLUGIN_PATH
:
4609 omit_home_plugin_path
= true;
4615 print_gen_usage(stdout
);
4618 } else if (item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
4619 struct bt_argpar_item_non_opt
*item_non_opt
=
4620 (struct bt_argpar_item_non_opt
*) item
;
4622 * First unknown argument: is it a known command
4626 top_level_argc
- item_non_opt
->orig_index
- 1;
4628 &top_level_argv
[item_non_opt
->orig_index
+ 1];
4630 if (strcmp(item_non_opt
->arg
, "convert") == 0) {
4631 command_type
= COMMAND_TYPE_CONVERT
;
4632 } else if (strcmp(item_non_opt
->arg
, "list-plugins") == 0) {
4633 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4634 } else if (strcmp(item_non_opt
->arg
, "help") == 0) {
4635 command_type
= COMMAND_TYPE_HELP
;
4636 } else if (strcmp(item_non_opt
->arg
, "query") == 0) {
4637 command_type
= COMMAND_TYPE_QUERY
;
4638 } else if (strcmp(item_non_opt
->arg
, "run") == 0) {
4639 command_type
= COMMAND_TYPE_RUN
;
4642 * Non-option argument, but not a known
4643 * command name: assume the default
4644 * `convert` command.
4646 command_type
= COMMAND_TYPE_CONVERT
;
4647 command_name
= "convert";
4655 if (command_type
== COMMAND_TYPE_NONE
) {
4656 if (argpar_parse_ret
.ingested_orig_args
== top_level_argc
) {
4658 * We only got non-help, non-version general options
4659 * like --verbose and --debug, without any other
4660 * arguments, so we can't do anything useful: print the
4663 print_gen_usage(stdout
);
4668 * We stopped on an unknown option argument (and therefore
4669 * didn't see a command name). Assume `convert` command.
4671 command_type
= COMMAND_TYPE_CONVERT
;
4672 command_name
= "convert";
4674 top_level_argc
- argpar_parse_ret
.ingested_orig_args
;
4676 &top_level_argv
[argpar_parse_ret
.ingested_orig_args
];
4679 BT_ASSERT(command_argv
);
4680 BT_ASSERT(command_argc
>= 0);
4683 * For all commands other than `convert`, we now know the log level to
4684 * use, so we can apply it with `set_auto_log_levels`.
4686 * The convert command has `--debug` and `--verbose` arguments that are
4687 * equivalent to the top-level arguments of the same name. So after it
4688 * has parsed its arguments, `bt_config_convert_from_args` calls
4689 * `set_auto_log_levels` itself.
4691 if (command_type
!= COMMAND_TYPE_CONVERT
) {
4692 set_auto_log_levels(&default_log_level
);
4696 * At this point, `plugin_paths` contains the initial plugin
4697 * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
4698 * the paths from the `--plugin-path` option.
4700 * Now append the user and system plugin paths.
4702 if (append_home_and_system_plugin_paths(plugin_paths
,
4703 omit_system_plugin_path
, omit_home_plugin_path
)) {
4707 switch (command_type
) {
4708 case COMMAND_TYPE_RUN
:
4709 config
= bt_config_run_from_args(command_argc
, command_argv
,
4710 retcode
, plugin_paths
,
4713 case COMMAND_TYPE_CONVERT
:
4714 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4715 retcode
, plugin_paths
, &default_log_level
, interrupter
);
4717 case COMMAND_TYPE_LIST_PLUGINS
:
4718 config
= bt_config_list_plugins_from_args(command_argc
,
4719 command_argv
, retcode
, plugin_paths
);
4721 case COMMAND_TYPE_HELP
:
4722 config
= bt_config_help_from_args(command_argc
,
4723 command_argv
, retcode
, plugin_paths
,
4726 case COMMAND_TYPE_QUERY
:
4727 config
= bt_config_query_from_args(command_argc
,
4728 command_argv
, retcode
, plugin_paths
,
4736 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4737 config
->log_level
= default_log_level
;
4738 config
->command_name
= command_name
;
4747 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4748 bt_value_put_ref(plugin_paths
);