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
;
1484 GString
*error_str
= NULL
;
1485 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1487 params
= bt_value_null
;
1488 bt_value_get_ref(bt_value_null
);
1491 cfg
= bt_config_query_create(plugin_paths
);
1496 error_str
= g_string_new(NULL
);
1498 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1503 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, query_options
, true);
1504 if (argpar_parse_ret
.error
) {
1505 BT_CLI_LOGE_APPEND_CAUSE(
1506 "While parsing `query` command's command-line arguments: %s",
1507 argpar_parse_ret
.error
->str
);
1511 if (help_option_is_specified(&argpar_parse_ret
)) {
1512 print_query_usage(stdout
);
1514 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1518 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1519 struct bt_argpar_item
*argpar_item
=
1520 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1522 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
1523 struct bt_argpar_item_opt
*argpar_item_opt
=
1524 (struct bt_argpar_item_opt
*) argpar_item
;
1525 const char *arg
= argpar_item_opt
->arg
;
1527 switch (argpar_item_opt
->descr
->id
) {
1530 bt_value_put_ref(params
);
1531 params
= bt_param_parse(arg
, error_str
);
1533 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1540 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1541 argpar_item_opt
->descr
->id
);
1545 struct bt_argpar_item_non_opt
*argpar_item_non_opt
1546 = (struct bt_argpar_item_non_opt
*) argpar_item
;
1549 * We need exactly two non-option arguments
1550 * which are the mandatory component class
1551 * specification and query object.
1553 if (!component_class_spec
) {
1554 component_class_spec
= argpar_item_non_opt
->arg
;
1555 } else if (!query_object
) {
1556 query_object
= argpar_item_non_opt
->arg
;
1558 BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
1559 argpar_item_non_opt
->arg
);
1565 if (!component_class_spec
|| !query_object
) {
1566 print_query_usage(stdout
);
1568 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1572 cfg
->cmd_data
.query
.cfg_component
=
1573 bt_config_component_from_arg(component_class_spec
,
1575 if (!cfg
->cmd_data
.query
.cfg_component
) {
1576 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1577 component_class_spec
);
1582 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
1584 if (strlen(query_object
) == 0) {
1585 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1589 g_string_assign(cfg
->cmd_data
.query
.object
, query_object
);
1594 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1597 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1600 g_string_free(error_str
, TRUE
);
1603 bt_value_put_ref(params
);
1608 * Prints the list-plugins command usage.
1611 void print_list_plugins_usage(FILE *fp
)
1613 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1615 fprintf(fp
, "Options:\n");
1617 fprintf(fp
, " -h, --help Show this help and quit\n");
1619 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1621 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1625 const struct bt_argpar_opt_descr list_plugins_options
[] = {
1626 /* id, short_name, long_name, with_arg */
1627 { OPT_HELP
, 'h', "help", false },
1628 BT_ARGPAR_OPT_DESCR_SENTINEL
1632 * Creates a Babeltrace config object from the arguments of a
1633 * list-plugins command.
1635 * *retcode is set to the appropriate exit code to use.
1638 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
1639 int *retcode
, const bt_value
*plugin_paths
)
1641 struct bt_config
*cfg
= NULL
;
1642 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1645 cfg
= bt_config_list_plugins_create(plugin_paths
);
1651 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, list_plugins_options
, true);
1652 if (argpar_parse_ret
.error
) {
1653 BT_CLI_LOGE_APPEND_CAUSE(
1654 "While parsing `list-plugins` command's command-line arguments: %s",
1655 argpar_parse_ret
.error
->str
);
1659 if (help_option_is_specified(&argpar_parse_ret
)) {
1660 print_list_plugins_usage(stdout
);
1662 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1666 if (argpar_parse_ret
.items
->len
> 0) {
1668 * At this point we know there's at least one non-option
1669 * argument because we don't reach here with `--help`,
1672 struct bt_argpar_item_non_opt
*non_opt
=
1673 argpar_parse_ret
.items
->pdata
[0];
1675 BT_CLI_LOGE_APPEND_CAUSE(
1676 "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
1685 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1688 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1694 * Prints the run command usage.
1697 void print_run_usage(FILE *fp
)
1699 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1701 fprintf(fp
, "Options:\n");
1703 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1704 fprintf(fp
, " for all the following components until\n");
1705 fprintf(fp
, " --reset-base-params is encountered\n");
1706 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1707 fprintf(fp
, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
1708 fprintf(fp
, " Instantiate the component class CLS of type\n");
1709 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1710 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1711 fprintf(fp
, " and name it NAME");
1712 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1713 fprintf(fp
, " expected format of CONNECTION below)\n");
1714 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1715 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
1716 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1717 fprintf(fp
, " current component (see the expected format\n");
1718 fprintf(fp
, " of PARAMS below)\n");
1719 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1720 fprintf(fp
, " empty map\n");
1721 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1722 fprintf(fp
, " the graph later, retry in DUR µs\n");
1723 fprintf(fp
, " (default: 100000)\n");
1724 fprintf(fp
, " -h, --help Show this help and quit\n");
1726 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1727 fprintf(fp
, "\n\n");
1728 fprintf(fp
, "Expected format of CONNECTION\n");
1729 fprintf(fp
, "-----------------------------\n");
1731 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1733 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1734 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1735 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
1736 fprintf(fp
, "component using the NAME prefix of the --component option.\n");
1738 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1739 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1740 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1742 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1743 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1744 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1745 fprintf(fp
, "DOWNSTREAM.\n");
1747 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1748 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1749 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1751 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1752 fprintf(fp
, "can connect a filter component to a sink component.\n");
1754 fprintf(fp
, "Examples:\n");
1756 fprintf(fp
, " my-src:my-sink\n");
1757 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1759 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1760 fprintf(fp
, "babeltrace2 from a shell.\n");
1761 fprintf(fp
, "\n\n");
1762 print_expected_params_format(fp
);
1766 * Creates a Babeltrace config object from the arguments of a run
1769 * *retcode is set to the appropriate exit code to use.
1772 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
1773 int *retcode
, const bt_value
*plugin_paths
,
1774 int default_log_level
)
1776 struct bt_config_component
*cur_cfg_comp
= NULL
;
1777 bt_value
*cur_base_params
= NULL
;
1779 struct bt_config
*cfg
= NULL
;
1780 bt_value
*instance_names
= NULL
;
1781 bt_value
*connection_args
= NULL
;
1782 char error_buf
[256] = { 0 };
1783 long retry_duration
= -1;
1784 bt_value_map_extend_status extend_status
;
1785 GString
*error_str
= NULL
;
1786 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1789 static const struct bt_argpar_opt_descr run_options
[] = {
1790 { OPT_BASE_PARAMS
, 'b', "base-params", true },
1791 { OPT_COMPONENT
, 'c', "component", true },
1792 { OPT_CONNECT
, 'x', "connect", true },
1793 { OPT_HELP
, 'h', "help", false },
1794 { OPT_LOG_LEVEL
, 'l', "log-level", true },
1795 { OPT_PARAMS
, 'p', "params", true },
1796 { OPT_RESET_BASE_PARAMS
, 'r', "reset-base-params", false },
1797 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
1798 BT_ARGPAR_OPT_DESCR_SENTINEL
1803 error_str
= g_string_new(NULL
);
1805 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1810 print_run_usage(stdout
);
1815 cfg
= bt_config_run_create(plugin_paths
);
1820 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1821 cur_base_params
= bt_value_map_create();
1822 if (!cur_base_params
) {
1823 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1827 instance_names
= bt_value_map_create();
1828 if (!instance_names
) {
1829 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1833 connection_args
= bt_value_array_create();
1834 if (!connection_args
) {
1835 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1840 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, run_options
, true);
1841 if (argpar_parse_ret
.error
) {
1842 BT_CLI_LOGE_APPEND_CAUSE(
1843 "While parsing `run` command's command-line arguments: %s",
1844 argpar_parse_ret
.error
->str
);
1848 if (help_option_is_specified(&argpar_parse_ret
)) {
1849 print_run_usage(stdout
);
1851 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1855 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1856 struct bt_argpar_item
*argpar_item
=
1857 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1858 struct bt_argpar_item_opt
*argpar_item_opt
;
1861 /* This command does not accept non-option arguments.*/
1862 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
1863 struct bt_argpar_item_non_opt
*argpar_nonopt_item
=
1864 (struct bt_argpar_item_non_opt
*) argpar_item
;
1866 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
1867 argpar_nonopt_item
->arg
);
1871 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1872 arg
= argpar_item_opt
->arg
;
1874 switch (argpar_item_opt
->descr
->id
) {
1877 enum bt_config_component_dest dest
;
1879 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
1880 cur_cfg_comp
= bt_config_component_from_arg(arg
,
1882 if (!cur_cfg_comp
) {
1883 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
1888 switch (cur_cfg_comp
->type
) {
1889 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1890 dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
1892 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1893 dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
1895 case BT_COMPONENT_CLASS_TYPE_SINK
:
1896 dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
1902 BT_ASSERT(cur_base_params
);
1903 bt_value_put_ref(cur_cfg_comp
->params
);
1904 if (bt_value_copy(cur_base_params
,
1905 &cur_cfg_comp
->params
) < 0) {
1906 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1910 ret
= add_run_cfg_comp_check_name(cfg
,
1923 if (!cur_cfg_comp
) {
1924 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
1929 params
= bt_param_parse(arg
, error_str
);
1931 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1936 extend_status
= bt_value_map_extend(cur_cfg_comp
->params
,
1938 BT_VALUE_PUT_REF_AND_RESET(params
);
1939 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
1940 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
1948 if (!cur_cfg_comp
) {
1949 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
1954 cur_cfg_comp
->log_level
=
1955 bt_log_get_level_from_string(arg
);
1956 if (cur_cfg_comp
->log_level
< 0) {
1957 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
1962 case OPT_BASE_PARAMS
:
1964 bt_value
*params
= bt_param_parse(arg
, error_str
);
1967 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
1972 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
1975 case OPT_RESET_BASE_PARAMS
:
1976 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
1977 cur_base_params
= bt_value_map_create();
1978 if (!cur_base_params
) {
1979 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1984 if (bt_value_array_append_string_element(
1985 connection_args
, arg
)) {
1986 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1990 case OPT_RETRY_DURATION
: {
1992 size_t arg_len
= strlen(argpar_item_opt
->arg
);
1994 retry_duration
= g_ascii_strtoll(argpar_item_opt
->arg
, &end
, 10);
1996 if (arg_len
== 0 || end
!= (argpar_item_opt
->arg
+ arg_len
)) {
1997 BT_CLI_LOGE_APPEND_CAUSE(
1998 "Could not parse --retry-duration option's argument as an unsigned integer: `%s`",
1999 argpar_item_opt
->arg
);
2003 if (retry_duration
< 0) {
2004 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2009 cfg
->cmd_data
.run
.retry_duration_us
=
2010 (uint64_t) retry_duration
;
2014 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
2015 argpar_item_opt
->descr
->id
);
2020 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2022 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2023 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2027 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2028 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2032 ret
= bt_config_cli_args_create_connections(cfg
,
2036 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2044 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2048 g_string_free(error_str
, TRUE
);
2051 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
2052 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2053 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2054 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2055 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2060 struct bt_config
*bt_config_run_from_args_array(const bt_value
*run_args
,
2061 int *retcode
, const bt_value
*plugin_paths
,
2062 int default_log_level
)
2064 struct bt_config
*cfg
= NULL
;
2067 const size_t argc
= bt_value_array_get_length(run_args
);
2069 argv
= calloc(argc
, sizeof(*argv
));
2071 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2075 len
= bt_value_array_get_length(run_args
);
2077 BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
2080 for (i
= 0; i
< len
; i
++) {
2081 const bt_value
*arg_value
=
2082 bt_value_array_borrow_element_by_index_const(run_args
,
2086 BT_ASSERT(arg_value
);
2087 arg
= bt_value_string_get(arg_value
);
2092 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2093 plugin_paths
, default_log_level
);
2101 * Prints the convert command usage.
2104 void print_convert_usage(FILE *fp
)
2106 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2108 fprintf(fp
, "Options:\n");
2110 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2111 fprintf(fp
, " Instantiate the component class CLS of type\n");
2112 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2113 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2114 fprintf(fp
, " conversion graph, and optionally name it\n");
2115 fprintf(fp
, " NAME\n");
2116 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2117 fprintf(fp
, " (`N`, `T`, `D`, `I`, `W`, `E`, or `F`)\n");
2118 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2119 fprintf(fp
, " current component (see the expected format\n");
2120 fprintf(fp
, " of PARAMS below)\n");
2121 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2122 fprintf(fp
, " the graph later, retry in DUR µs\n");
2123 fprintf(fp
, " (default: 100000)\n");
2124 fprintf(fp
, " dynamic plugins can be loaded\n");
2125 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2126 fprintf(fp
, " `run` command to the standard output,\n");
2127 fprintf(fp
, " formatted for a shell, and quit\n");
2128 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2129 fprintf(fp
, " `run` command to the standard output,\n");
2130 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2131 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2132 fprintf(fp
, " are active\n");
2133 fprintf(fp
, " -h, --help Show this help and quit\n");
2135 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2137 fprintf(fp
, " --clock-force-correlate Force the origin of all clocks\n");
2138 fprintf(fp
, " to the Unix epoch\n");
2139 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2140 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2142 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2144 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2145 fprintf(fp
, " --clock-date Print timestamp dates\n");
2146 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2147 fprintf(fp
, " time zone instead of the local time zone\n");
2148 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2149 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2150 fprintf(fp
, " --color=(never | auto | always)\n");
2151 fprintf(fp
, " Never, automatically, or always emit\n");
2152 fprintf(fp
, " console color codes\n");
2153 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2154 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2155 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2156 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2157 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2158 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2159 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2160 fprintf(fp
, " (or `ctx`)\n");
2161 fprintf(fp
, " --no-delta Do not print time delta between\n");
2162 fprintf(fp
, " consecutive events\n");
2163 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2164 fprintf(fp
, " the standard output\n");
2166 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2168 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2169 fprintf(fp
, " time range to BEGIN (see the format of\n");
2170 fprintf(fp
, " BEGIN below)\n");
2171 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2172 fprintf(fp
, " range to END (see the format of END below)\n");
2173 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2174 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2175 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2177 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2179 fprintf(fp
, " --debug-info Create an implicit\n");
2180 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2181 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2182 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2183 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2184 fprintf(fp
, " binary paths instead of just names\n");
2185 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2186 fprintf(fp
, " Use directory DIR as a prefix when\n");
2187 fprintf(fp
, " looking up executables during debug\n");
2188 fprintf(fp
, " info analysis\n");
2190 fprintf(fp
, "Legacy options that still work:\n");
2192 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2193 fprintf(fp
, " `ctf`:\n");
2194 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2195 fprintf(fp
, " component\n");
2196 fprintf(fp
, " `lttng-live`:\n");
2197 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2198 fprintf(fp
, " component\n");
2199 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2200 fprintf(fp
, " `text`:\n");
2201 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2202 fprintf(fp
, " component\n");
2203 fprintf(fp
, " `ctf`:\n");
2204 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2205 fprintf(fp
, " component\n");
2206 fprintf(fp
, " `dummy`:\n");
2207 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2208 fprintf(fp
, " component\n");
2209 fprintf(fp
, " `ctf-metadata`:\n");
2210 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2211 fprintf(fp
, " for metadata text and quit\n");
2213 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2214 fprintf(fp
, "\n\n");
2215 fprintf(fp
, "Format of BEGIN and END\n");
2216 fprintf(fp
, "-----------------------\n");
2218 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2219 fprintf(fp
, "\n\n");
2220 print_expected_params_format(fp
);
2224 const struct bt_argpar_opt_descr convert_options
[] = {
2225 /* id, short_name, long_name, with_arg */
2226 { OPT_BEGIN
, 'b', "begin", true },
2227 { OPT_CLOCK_CYCLES
, '\0', "clock-cycles", false },
2228 { OPT_CLOCK_DATE
, '\0', "clock-date", false },
2229 { OPT_CLOCK_FORCE_CORRELATE
, '\0', "clock-force-correlate", false },
2230 { OPT_CLOCK_GMT
, '\0', "clock-gmt", false },
2231 { OPT_CLOCK_OFFSET
, '\0', "clock-offset", true },
2232 { OPT_CLOCK_OFFSET_NS
, '\0', "clock-offset-ns", true },
2233 { OPT_CLOCK_SECONDS
, '\0', "clock-seconds", false },
2234 { OPT_COLOR
, '\0', "color", true },
2235 { OPT_COMPONENT
, 'c', "component", true },
2236 { OPT_DEBUG
, 'd', "debug", false },
2237 { OPT_DEBUG_INFO_DIR
, '\0', "debug-info-dir", true },
2238 { OPT_DEBUG_INFO_FULL_PATH
, '\0', "debug-info-full-path", false },
2239 { OPT_DEBUG_INFO_TARGET_PREFIX
, '\0', "debug-info-target-prefix", true },
2240 { OPT_END
, 'e', "end", true },
2241 { OPT_FIELDS
, 'f', "fields", true },
2242 { OPT_HELP
, 'h', "help", false },
2243 { OPT_INPUT_FORMAT
, 'i', "input-format", true },
2244 { OPT_LOG_LEVEL
, 'l', "log-level", true },
2245 { OPT_NAMES
, 'n', "names", true },
2246 { OPT_DEBUG_INFO
, '\0', "debug-info", false },
2247 { OPT_NO_DELTA
, '\0', "no-delta", false },
2248 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
2249 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
2250 { OPT_OUTPUT
, 'w', "output", true },
2251 { OPT_OUTPUT_FORMAT
, 'o', "output-format", true },
2252 { OPT_PARAMS
, 'p', "params", true },
2253 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
2254 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
2255 { OPT_RUN_ARGS
, '\0', "run-args", false },
2256 { OPT_RUN_ARGS_0
, '\0', "run-args-0", false },
2257 { OPT_STREAM_INTERSECTION
, '\0', "stream-intersection", false },
2258 { OPT_TIMERANGE
, '\0', "timerange", true },
2259 { OPT_VERBOSE
, 'v', "verbose", false },
2260 BT_ARGPAR_OPT_DESCR_SENTINEL
2264 GString
*get_component_auto_name(const char *prefix
,
2265 const bt_value
*existing_names
)
2268 GString
*auto_name
= g_string_new(NULL
);
2271 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2275 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2276 g_string_assign(auto_name
, prefix
);
2281 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2283 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2289 struct implicit_component_args
{
2292 /* The component class name (e.g. src.ctf.fs). */
2295 /* The component instance name. */
2298 GString
*params_arg
;
2299 bt_value
*extra_params
;
2303 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2304 const char *prefix
, bt_value
*existing_names
,
2305 GList
**comp_names
, bool append_to_comp_names
)
2308 GString
*name
= NULL
;
2310 if (!args
->exists
) {
2314 name
= get_component_auto_name(prefix
,
2322 g_string_assign(args
->name_arg
, name
->str
);
2324 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2326 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2331 if (append_to_comp_names
) {
2332 *comp_names
= g_list_append(*comp_names
, name
);
2338 g_string_free(name
, TRUE
);
2345 int append_run_args_for_implicit_component(
2346 struct implicit_component_args
*impl_args
,
2351 GString
*component_arg_for_run
= NULL
;
2353 if (!impl_args
->exists
) {
2357 component_arg_for_run
= g_string_new(NULL
);
2358 if (!component_arg_for_run
) {
2359 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2363 /* Build the full `name:type.plugin.cls`. */
2364 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, '\\'));
2365 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, ':'));
2366 g_string_printf(component_arg_for_run
, "%s:%s",
2367 impl_args
->name_arg
->str
, impl_args
->comp_arg
->str
);
2369 if (bt_value_array_append_string_element(run_args
, "--component")) {
2370 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2374 if (bt_value_array_append_string_element(run_args
,
2375 component_arg_for_run
->str
)) {
2376 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2380 if (impl_args
->params_arg
->len
> 0) {
2381 if (bt_value_array_append_string_element(run_args
, "--params")) {
2382 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2386 if (bt_value_array_append_string_element(run_args
,
2387 impl_args
->params_arg
->str
)) {
2388 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2393 for (i
= 0; i
< bt_value_array_get_length(impl_args
->extra_params
);
2395 const bt_value
*elem
;
2398 elem
= bt_value_array_borrow_element_by_index(impl_args
->extra_params
,
2404 BT_ASSERT(bt_value_is_string(elem
));
2405 arg
= bt_value_string_get(elem
);
2406 ret
= bt_value_array_append_string_element(run_args
, arg
);
2408 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2419 if (component_arg_for_run
) {
2420 g_string_free(component_arg_for_run
, TRUE
);
2426 /* Free the fields of a `struct implicit_component_args`. */
2429 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2433 if (args
->comp_arg
) {
2434 g_string_free(args
->comp_arg
, TRUE
);
2437 if (args
->name_arg
) {
2438 g_string_free(args
->name_arg
, TRUE
);
2441 if (args
->params_arg
) {
2442 g_string_free(args
->params_arg
, TRUE
);
2445 bt_value_put_ref(args
->extra_params
);
2448 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2451 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2453 finalize_implicit_component_args(args
);
2457 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2460 int init_implicit_component_args(struct implicit_component_args
*args
,
2461 const char *comp_arg
, bool exists
)
2465 args
->exists
= exists
;
2466 args
->comp_arg
= g_string_new(comp_arg
);
2467 args
->name_arg
= g_string_new(NULL
);
2468 args
->params_arg
= g_string_new(NULL
);
2469 args
->extra_params
= bt_value_array_create();
2471 if (!args
->comp_arg
|| !args
->name_arg
||
2472 !args
->params_arg
|| !args
->extra_params
) {
2474 finalize_implicit_component_args(args
);
2475 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2483 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2486 struct implicit_component_args
*create_implicit_component_args(
2487 const char *comp_arg
)
2489 struct implicit_component_args
*args
;
2492 args
= g_new(struct implicit_component_args
, 1);
2494 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2498 status
= init_implicit_component_args(args
, comp_arg
, true);
2509 void append_implicit_component_param(struct implicit_component_args
*args
,
2510 const char *key
, const char *value
)
2515 append_param_arg(args
->params_arg
, key
, value
);
2519 * Append the given parameter (`key=value`) to all component specifications
2520 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2521 * which match `comp_arg`.
2523 * Return the number of matching components.
2527 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2528 const char *comp_arg
, const char *key
, const char *value
)
2533 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2534 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2536 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2537 append_implicit_component_param(args
, key
, value
);
2545 /* Escape value to make it suitable to use as a string parameter value. */
2547 gchar
*escape_string_value(const char *value
)
2552 ret
= g_string_new(NULL
);
2554 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2563 g_string_append_c(ret
, '\\');
2567 g_string_append_c(ret
, *in
);
2573 return g_string_free(ret
, FALSE
);
2577 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2583 switch (bt_value_get_type(value
)) {
2584 case BT_VALUE_TYPE_STRING
:
2586 const char *str_value
= bt_value_string_get(value
);
2587 gchar
*escaped_str_value
;
2589 escaped_str_value
= escape_string_value(str_value
);
2590 if (!escaped_str_value
) {
2594 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2596 g_free(escaped_str_value
);
2599 case BT_VALUE_TYPE_ARRAY
: {
2600 g_string_append_c(buf
, '[');
2601 uint64_t sz
= bt_value_array_get_length(value
);
2602 for (uint64_t i
= 0; i
< sz
; i
++) {
2603 const bt_value
*item
;
2607 g_string_append(buf
, ", ");
2610 item
= bt_value_array_borrow_element_by_index_const(
2612 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2618 g_string_append_c(buf
, ']');
2632 * Convert `value` to its equivalent representation as a command line parameter
2637 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2640 gchar
*result
= NULL
;
2642 buf
= g_string_new(NULL
);
2644 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2648 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2652 result
= g_string_free(buf
, FALSE
);
2659 g_string_free(buf
, TRUE
);
2667 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2670 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2675 gchar
*str_value
= NULL
;
2676 GString
*parameter
= NULL
;
2678 if (bt_value_array_append_string_element(args
, "--params")) {
2679 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2684 str_value
= bt_value_to_cli_param_value(value
);
2690 parameter
= g_string_new(NULL
);
2692 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2697 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2699 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2700 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2707 g_string_free(parameter
, TRUE
);
2720 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2722 bt_value
*str_value
;
2725 str_value
= bt_value_string_create_init(value
);
2728 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2733 ret
= append_parameter_to_args(args
, key
, str_value
);
2736 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2741 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2742 const char *key
, const char *value
)
2744 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2748 * Escapes `.`, `:`, and `\` of `input` with `\`.
2751 GString
*escape_dot_colon(const char *input
)
2753 GString
*output
= g_string_new(NULL
);
2757 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2761 for (ch
= input
; *ch
!= '\0'; ch
++) {
2762 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
2763 g_string_append_c(output
, '\\');
2766 g_string_append_c(output
, *ch
);
2774 * Appends a --connect option to a list of arguments. `upstream_name`
2775 * and `downstream_name` are escaped with escape_dot_colon() in this
2779 int append_connect_arg(bt_value
*run_args
,
2780 const char *upstream_name
, const char *downstream_name
)
2783 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
2784 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
2785 GString
*arg
= g_string_new(NULL
);
2787 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
2788 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2793 ret
= bt_value_array_append_string_element(run_args
, "--connect");
2795 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2800 g_string_append(arg
, e_upstream_name
->str
);
2801 g_string_append_c(arg
, ':');
2802 g_string_append(arg
, e_downstream_name
->str
);
2803 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
2805 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2812 g_string_free(arg
, TRUE
);
2815 if (e_upstream_name
) {
2816 g_string_free(e_upstream_name
, TRUE
);
2819 if (e_downstream_name
) {
2820 g_string_free(e_downstream_name
, TRUE
);
2827 * Appends the run command's --connect options for the convert command.
2830 int convert_auto_connect(bt_value
*run_args
,
2831 GList
*source_names
, GList
*filter_names
,
2835 GList
*source_at
= source_names
;
2836 GList
*filter_at
= filter_names
;
2838 GList
*sink_at
= sink_names
;
2840 BT_ASSERT(source_names
);
2841 BT_ASSERT(filter_names
);
2842 BT_ASSERT(sink_names
);
2844 /* Connect all sources to the first filter */
2845 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
2846 GString
*source_name
= source_at
->data
;
2847 GString
*filter_name
= filter_at
->data
;
2849 ret
= append_connect_arg(run_args
, source_name
->str
,
2856 filter_prev
= filter_at
;
2857 filter_at
= g_list_next(filter_at
);
2859 /* Connect remaining filters */
2860 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
2861 GString
*filter_name
= filter_at
->data
;
2862 GString
*filter_prev_name
= filter_prev
->data
;
2864 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
2871 /* Connect last filter to all sinks */
2872 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
2873 GString
*filter_name
= filter_prev
->data
;
2874 GString
*sink_name
= sink_at
->data
;
2876 ret
= append_connect_arg(run_args
, filter_name
->str
,
2893 int split_timerange(const char *arg
, char **begin
, char **end
)
2896 const char *ch
= arg
;
2898 GString
*g_begin
= NULL
;
2899 GString
*g_end
= NULL
;
2907 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
2908 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
2914 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
2915 if (!g_end
|| g_end
->len
== 0) {
2921 *begin
= g_begin
->str
;
2923 g_string_free(g_begin
, FALSE
);
2924 g_string_free(g_end
, FALSE
);
2934 g_string_free(g_begin
, TRUE
);
2938 g_string_free(g_end
, TRUE
);
2945 int g_list_prepend_gstring(GList
**list
, const char *string
)
2948 GString
*gs
= g_string_new(string
);
2953 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2957 *list
= g_list_prepend(*list
, gs
);
2964 * Create `struct implicit_component_args` structures for each of the
2965 * source components we identified. Add them to `component_args`.
2967 * `non_opts` is an array of the non-option arguments passed on the command
2970 * `non_opt_params` is an array where each element is an array of
2971 * strings containing all the arguments to `--params` that apply to the
2972 * non-option argument at the same index. For example, if, for a
2973 * non-option argument, the following `--params` options applied:
2975 * --params=a=2 --params=b=3,c=4
2977 * its entry in `non_opt_params` would contain
2979 * ["a=2", "b=3,c=4"]
2983 int create_implicit_component_args_from_auto_discovered_sources(
2984 const struct auto_source_discovery
*auto_disc
,
2985 const bt_value
*non_opts
,
2986 const bt_value
*non_opt_params
,
2987 const bt_value
*non_opt_loglevels
,
2988 GPtrArray
*component_args
)
2990 gchar
*cc_name
= NULL
;
2991 struct implicit_component_args
*comp
= NULL
;
2995 len
= auto_disc
->results
->len
;
2997 for (i
= 0; i
< len
; i
++) {
2998 struct auto_source_discovery_result
*res
=
2999 g_ptr_array_index(auto_disc
->results
, i
);
3000 uint64_t orig_indices_i
, orig_indices_count
;
3003 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3005 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3009 comp
= create_implicit_component_args(cc_name
);
3015 * Append parameters and log levels of all the
3016 * non-option arguments that contributed to this
3017 * component instance coming into existence.
3019 orig_indices_count
= bt_value_array_get_length(res
->original_input_indices
);
3020 for (orig_indices_i
= 0; orig_indices_i
< orig_indices_count
; orig_indices_i
++) {
3021 const bt_value
*orig_idx_value
=
3022 bt_value_array_borrow_element_by_index(
3023 res
->original_input_indices
, orig_indices_i
);
3024 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3025 const bt_value
*params_array
=
3026 bt_value_array_borrow_element_by_index_const(
3027 non_opt_params
, orig_idx
);
3028 uint64_t params_i
, params_count
;
3029 const bt_value
*loglevel_value
;
3031 params_count
= bt_value_array_get_length(params_array
);
3032 for (params_i
= 0; params_i
< params_count
; params_i
++) {
3033 const bt_value
*params_value
=
3034 bt_value_array_borrow_element_by_index_const(
3035 params_array
, params_i
);
3036 const char *params
= bt_value_string_get(params_value
);
3037 bt_value_array_append_element_status append_status
;
3039 append_status
= bt_value_array_append_string_element(
3040 comp
->extra_params
, "--params");
3041 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3042 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3046 append_status
= bt_value_array_append_string_element(
3047 comp
->extra_params
, params
);
3048 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3049 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3054 loglevel_value
= bt_value_array_borrow_element_by_index_const(
3055 non_opt_loglevels
, orig_idx
);
3056 if (bt_value_get_type(loglevel_value
) == BT_VALUE_TYPE_STRING
) {
3057 const char *loglevel
= bt_value_string_get(loglevel_value
);
3058 bt_value_array_append_element_status append_status
;
3060 append_status
= bt_value_array_append_string_element(
3061 comp
->extra_params
, "--log-level");
3062 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3063 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3067 append_status
= bt_value_array_append_string_element(
3068 comp
->extra_params
, loglevel
);
3069 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3070 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3077 * If single input and a src.ctf.fs component, provide the
3078 * relative path from the path passed on the command line to the
3081 if (bt_value_array_get_length(res
->inputs
) == 1 &&
3082 strcmp(res
->plugin_name
, "ctf") == 0 &&
3083 strcmp(res
->source_cc_name
, "fs") == 0) {
3084 const bt_value
*orig_idx_value
=
3085 bt_value_array_borrow_element_by_index(
3086 res
->original_input_indices
, 0);
3087 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3088 const bt_value
*non_opt_value
=
3089 bt_value_array_borrow_element_by_index_const(
3090 non_opts
, orig_idx
);
3091 const char *non_opt
= bt_value_string_get(non_opt_value
);
3092 const bt_value
*input_value
=
3093 bt_value_array_borrow_element_by_index_const(
3095 const char *input
= bt_value_string_get(input_value
);
3097 BT_ASSERT(orig_indices_count
== 1);
3098 BT_ASSERT(g_str_has_prefix(input
, non_opt
));
3100 input
+= strlen(non_opt
);
3102 while (G_IS_DIR_SEPARATOR(*input
)) {
3106 if (strlen(input
) > 0) {
3107 append_string_parameter_to_args(comp
->extra_params
,
3108 "trace-name", input
);
3112 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3117 g_ptr_array_add(component_args
, comp
);
3131 destroy_implicit_component_args(comp
);
3138 * As we iterate the arguments to the convert command, this tracks what is the
3139 * type of the current item, to which some contextual options (e.g. --params)
3142 enum convert_current_item_type
{
3143 /* There is no current item. */
3144 CONVERT_CURRENT_ITEM_TYPE_NONE
,
3146 /* Current item is a component. */
3147 CONVERT_CURRENT_ITEM_TYPE_COMPONENT
,
3149 /* Current item is a non-option argument. */
3150 CONVERT_CURRENT_ITEM_TYPE_NON_OPT
,
3154 * Creates a Babeltrace config object from the arguments of a convert
3157 * *retcode is set to the appropriate exit code to use.
3160 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3161 int *retcode
, const bt_value
*plugin_paths
,
3162 int *default_log_level
, const bt_interrupter
*interrupter
)
3164 enum convert_current_item_type current_item_type
=
3165 CONVERT_CURRENT_ITEM_TYPE_NONE
;
3167 struct bt_config
*cfg
= NULL
;
3168 bool got_input_format_opt
= false;
3169 bool got_output_format_opt
= false;
3170 bool trimmer_has_begin
= false;
3171 bool trimmer_has_end
= false;
3172 bool stream_intersection_mode
= false;
3173 bool print_run_args
= false;
3174 bool print_run_args_0
= false;
3175 bool print_ctf_metadata
= false;
3176 bt_value
*run_args
= NULL
;
3177 bt_value
*all_names
= NULL
;
3178 GList
*source_names
= NULL
;
3179 GList
*filter_names
= NULL
;
3180 GList
*sink_names
= NULL
;
3181 bt_value
*non_opts
= NULL
;
3182 bt_value
*non_opt_params
= NULL
;
3183 bt_value
*non_opt_loglevels
= NULL
;
3184 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3185 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3186 struct implicit_component_args implicit_dummy_args
= { 0 };
3187 struct implicit_component_args implicit_text_args
= { 0 };
3188 struct implicit_component_args implicit_debug_info_args
= { 0 };
3189 struct implicit_component_args implicit_muxer_args
= { 0 };
3190 struct implicit_component_args implicit_trimmer_args
= { 0 };
3191 char error_buf
[256] = { 0 };
3193 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3194 char *output
= NULL
;
3195 struct auto_source_discovery auto_disc
= { NULL
};
3196 GString
*auto_disc_comp_name
= NULL
;
3197 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
3198 GString
*name_gstr
= NULL
;
3199 GString
*component_arg_for_run
= NULL
;
3200 bt_value
*live_inputs_array_val
= NULL
;
3203 * Array of `struct implicit_component_args *` created for the sources
3204 * we have auto-discovered.
3206 GPtrArray
*discovered_source_args
= NULL
;
3209 * If set, restrict automatic source discovery to this component class
3212 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3213 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3215 bool ctf_fs_source_force_clock_class_unix_epoch_origin
= false;
3216 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3217 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3221 print_convert_usage(stdout
);
3226 if (init_implicit_component_args(&implicit_ctf_output_args
,
3227 "sink.ctf.fs", false)) {
3231 if (init_implicit_component_args(&implicit_lttng_live_args
,
3232 "source.ctf.lttng-live", false)) {
3236 if (init_implicit_component_args(&implicit_text_args
,
3237 "sink.text.pretty", false)) {
3241 if (init_implicit_component_args(&implicit_dummy_args
,
3242 "sink.utils.dummy", false)) {
3246 if (init_implicit_component_args(&implicit_debug_info_args
,
3247 "filter.lttng-utils.debug-info", false)) {
3251 if (init_implicit_component_args(&implicit_muxer_args
,
3252 "filter.utils.muxer", true)) {
3256 if (init_implicit_component_args(&implicit_trimmer_args
,
3257 "filter.utils.trimmer", false)) {
3261 all_names
= bt_value_map_create();
3263 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3267 run_args
= bt_value_array_create();
3269 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3273 component_arg_for_run
= g_string_new(NULL
);
3274 if (!component_arg_for_run
) {
3275 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3279 non_opts
= bt_value_array_create();
3281 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3285 non_opt_params
= bt_value_array_create();
3286 if (!non_opt_params
) {
3287 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3291 non_opt_loglevels
= bt_value_array_create();
3292 if (!non_opt_loglevels
) {
3293 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3297 if (auto_source_discovery_init(&auto_disc
) != 0) {
3301 discovered_source_args
=
3302 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3303 if (!discovered_source_args
) {
3304 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3308 auto_disc_comp_name
= g_string_new(NULL
);
3309 if (!auto_disc_comp_name
) {
3310 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3315 * First pass: collect all arguments which need to be passed
3316 * as is to the run command. This pass can also add --name
3317 * arguments if needed to automatically name unnamed component
3320 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, convert_options
, true);
3321 if (argpar_parse_ret
.error
) {
3322 BT_CLI_LOGE_APPEND_CAUSE(
3323 "While parsing `convert` command's command-line arguments: %s",
3324 argpar_parse_ret
.error
->str
);
3328 if (help_option_is_specified(&argpar_parse_ret
)) {
3329 print_convert_usage(stdout
);
3331 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3335 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3336 struct bt_argpar_item
*argpar_item
=
3337 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3338 struct bt_argpar_item_opt
*argpar_item_opt
;
3340 char *plugin_name
= NULL
;
3341 char *comp_cls_name
= NULL
;
3344 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
3345 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3346 arg
= argpar_item_opt
->arg
;
3348 switch (argpar_item_opt
->descr
->id
) {
3351 bt_component_class_type type
;
3353 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_COMPONENT
;
3355 /* Parse the argument */
3356 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3357 &comp_cls_name
, &type
);
3358 if (!plugin_name
|| !comp_cls_name
) {
3359 BT_CLI_LOGE_APPEND_CAUSE(
3360 "Invalid format for --component option's argument:\n %s",
3367 * Name was given by the user, verify it isn't
3370 if (bt_value_map_has_entry(all_names
, name
)) {
3371 BT_CLI_LOGE_APPEND_CAUSE(
3372 "Duplicate component instance name:\n %s",
3377 name_gstr
= g_string_new(name
);
3379 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3383 g_string_assign(component_arg_for_run
, arg
);
3385 /* Name not given by user, generate one. */
3386 name_gstr
= get_component_auto_name(arg
, all_names
);
3391 g_string_printf(component_arg_for_run
, "%s:%s",
3392 name_gstr
->str
, arg
);
3395 if (bt_value_array_append_string_element(run_args
,
3397 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3401 if (bt_value_array_append_string_element(run_args
,
3402 component_arg_for_run
->str
)) {
3403 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3408 * Remember this name globally, for the uniqueness of
3409 * all component names.
3411 if (bt_value_map_insert_entry(all_names
,
3412 name_gstr
->str
, bt_value_null
)) {
3413 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3418 * Remember this name specifically for the type of the
3419 * component. This is to create connection arguments.
3421 * The list takes ownership of `name_gstr`.
3424 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3425 source_names
= g_list_append(source_names
, name_gstr
);
3427 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3428 filter_names
= g_list_append(filter_names
, name_gstr
);
3430 case BT_COMPONENT_CLASS_TYPE_SINK
:
3431 sink_names
= g_list_append(sink_names
, name_gstr
);
3440 free(comp_cls_name
);
3443 comp_cls_name
= NULL
;
3447 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3449 * The current item is a component (--component option),
3450 * pass it directly to the run args.
3452 if (bt_value_array_append_string_element(run_args
,
3454 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3458 if (bt_value_array_append_string_element(run_args
, arg
)) {
3459 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3462 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3464 * The current item is a
3465 * non-option argument, record
3466 * it in `non_opt_params`.
3469 bt_value_array_append_element_status append_element_status
;
3470 uint64_t idx
= bt_value_array_get_length(non_opt_params
) - 1;
3472 array
= bt_value_array_borrow_element_by_index(non_opt_params
, idx
);
3474 append_element_status
= bt_value_array_append_string_element(array
, arg
);
3475 if (append_element_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3476 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3480 BT_CLI_LOGE_APPEND_CAUSE(
3481 "No current component (--component option) or non-option argument of which to set parameters:\n %s",
3487 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3488 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3489 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3493 if (bt_value_array_append_string_element(run_args
, arg
)) {
3494 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3497 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3498 uint64_t idx
= bt_value_array_get_length(non_opt_loglevels
) - 1;
3499 bt_value
*log_level_str_value
;
3501 log_level_str_value
= bt_value_string_create_init(arg
);
3502 if (!log_level_str_value
) {
3503 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3507 if (bt_value_array_set_element_by_index(non_opt_loglevels
, idx
,
3508 log_level_str_value
)) {
3509 bt_value_put_ref(log_level_str_value
);
3510 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3514 BT_CLI_LOGE_APPEND_CAUSE(
3515 "No current component (--component option) or non-option argument to assign a log level to:\n %s",
3521 case OPT_RETRY_DURATION
:
3522 if (bt_value_array_append_string_element(run_args
,
3523 "--retry-duration")) {
3524 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3528 if (bt_value_array_append_string_element(run_args
, arg
)) {
3529 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3534 case OPT_CLOCK_CYCLES
:
3535 case OPT_CLOCK_DATE
:
3536 case OPT_CLOCK_FORCE_CORRELATE
:
3538 case OPT_CLOCK_OFFSET
:
3539 case OPT_CLOCK_OFFSET_NS
:
3540 case OPT_CLOCK_SECONDS
:
3543 case OPT_DEBUG_INFO
:
3544 case OPT_DEBUG_INFO_DIR
:
3545 case OPT_DEBUG_INFO_FULL_PATH
:
3546 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3549 case OPT_INPUT_FORMAT
:
3552 case OPT_OUTPUT_FORMAT
:
3555 case OPT_RUN_ARGS_0
:
3556 case OPT_STREAM_INTERSECTION
:
3559 /* Ignore in this pass */
3562 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
3563 argpar_item_opt
->descr
->id
);
3566 } else if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
3567 struct bt_argpar_item_non_opt
*argpar_item_non_opt
;
3568 bt_value_array_append_element_status append_status
;
3570 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_NON_OPT
;
3572 argpar_item_non_opt
= (struct bt_argpar_item_non_opt
*) argpar_item
;
3574 append_status
= bt_value_array_append_string_element(non_opts
,
3575 argpar_item_non_opt
->arg
);
3576 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3577 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3581 append_status
= bt_value_array_append_empty_array_element(
3582 non_opt_params
, NULL
);
3583 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3584 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3588 append_status
= bt_value_array_append_element(non_opt_loglevels
, bt_value_null
);
3589 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3590 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3599 * Second pass: transform the convert-specific options and
3600 * arguments into implicit component instances for the run
3603 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3604 struct bt_argpar_item
*argpar_item
=
3605 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3606 struct bt_argpar_item_opt
*argpar_item_opt
;
3609 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
3613 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3614 arg
= argpar_item_opt
->arg
;
3616 switch (argpar_item_opt
->descr
->id
) {
3618 if (trimmer_has_begin
) {
3619 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
3624 trimmer_has_begin
= true;
3625 ret
= append_implicit_component_extra_param(
3626 &implicit_trimmer_args
, "begin", arg
);
3627 implicit_trimmer_args
.exists
= true;
3633 if (trimmer_has_end
) {
3634 printf("At --end option: --end or --timerange option already specified\n %s\n",
3639 trimmer_has_end
= true;
3640 ret
= append_implicit_component_extra_param(
3641 &implicit_trimmer_args
, "end", arg
);
3642 implicit_trimmer_args
.exists
= true;
3652 if (trimmer_has_begin
|| trimmer_has_end
) {
3653 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3658 ret
= split_timerange(arg
, &begin
, &end
);
3660 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3665 ret
= append_implicit_component_extra_param(
3666 &implicit_trimmer_args
, "begin", begin
);
3667 ret
|= append_implicit_component_extra_param(
3668 &implicit_trimmer_args
, "end", end
);
3669 implicit_trimmer_args
.exists
= true;
3677 case OPT_CLOCK_CYCLES
:
3678 append_implicit_component_param(
3679 &implicit_text_args
, "clock-cycles", "yes");
3680 implicit_text_args
.exists
= true;
3682 case OPT_CLOCK_DATE
:
3683 append_implicit_component_param(
3684 &implicit_text_args
, "clock-date", "yes");
3685 implicit_text_args
.exists
= true;
3687 case OPT_CLOCK_FORCE_CORRELATE
:
3688 ctf_fs_source_force_clock_class_unix_epoch_origin
= true;
3691 append_implicit_component_param(
3692 &implicit_text_args
, "clock-gmt", "yes");
3693 append_implicit_component_param(
3694 &implicit_trimmer_args
, "gmt", "yes");
3695 implicit_text_args
.exists
= true;
3697 case OPT_CLOCK_OFFSET
:
3698 if (ctf_fs_source_clock_class_offset_arg
) {
3699 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3703 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3704 if (!ctf_fs_source_clock_class_offset_arg
) {
3705 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3709 case OPT_CLOCK_OFFSET_NS
:
3710 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3711 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3715 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3716 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3717 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3721 case OPT_CLOCK_SECONDS
:
3722 append_implicit_component_param(
3723 &implicit_text_args
, "clock-seconds", "yes");
3724 implicit_text_args
.exists
= true;
3727 implicit_text_args
.exists
= true;
3728 ret
= append_implicit_component_extra_param(
3729 &implicit_text_args
, "color", arg
);
3734 case OPT_DEBUG_INFO
:
3735 implicit_debug_info_args
.exists
= true;
3737 case OPT_DEBUG_INFO_DIR
:
3738 implicit_debug_info_args
.exists
= true;
3739 ret
= append_implicit_component_extra_param(
3740 &implicit_debug_info_args
, "debug-info-dir", arg
);
3745 case OPT_DEBUG_INFO_FULL_PATH
:
3746 implicit_debug_info_args
.exists
= true;
3747 append_implicit_component_param(
3748 &implicit_debug_info_args
, "full-path", "yes");
3750 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3751 implicit_debug_info_args
.exists
= true;
3752 ret
= append_implicit_component_extra_param(
3753 &implicit_debug_info_args
,
3754 "target-prefix", arg
);
3761 bt_value
*fields
= fields_from_arg(arg
);
3767 implicit_text_args
.exists
= true;
3768 ret
= insert_flat_params_from_array(
3769 implicit_text_args
.params_arg
,
3771 bt_value_put_ref(fields
);
3779 bt_value
*names
= names_from_arg(arg
);
3785 implicit_text_args
.exists
= true;
3786 ret
= insert_flat_params_from_array(
3787 implicit_text_args
.params_arg
,
3789 bt_value_put_ref(names
);
3796 append_implicit_component_param(
3797 &implicit_text_args
, "no-delta", "yes");
3798 implicit_text_args
.exists
= true;
3800 case OPT_INPUT_FORMAT
:
3801 if (got_input_format_opt
) {
3802 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3806 got_input_format_opt
= true;
3808 if (strcmp(arg
, "ctf") == 0) {
3809 auto_source_discovery_restrict_plugin_name
= "ctf";
3810 auto_source_discovery_restrict_component_class_name
= "fs";
3811 } else if (strcmp(arg
, "lttng-live") == 0) {
3812 auto_source_discovery_restrict_plugin_name
= "ctf";
3813 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3814 implicit_lttng_live_args
.exists
= true;
3816 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
3821 case OPT_OUTPUT_FORMAT
:
3822 if (got_output_format_opt
) {
3823 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
3827 got_output_format_opt
= true;
3829 if (strcmp(arg
, "text") == 0) {
3830 implicit_text_args
.exists
= true;
3831 } else if (strcmp(arg
, "ctf") == 0) {
3832 implicit_ctf_output_args
.exists
= true;
3833 } else if (strcmp(arg
, "dummy") == 0) {
3834 implicit_dummy_args
.exists
= true;
3835 } else if (strcmp(arg
, "ctf-metadata") == 0) {
3836 print_ctf_metadata
= true;
3838 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
3845 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
3849 output
= strdup(arg
);
3851 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3856 if (print_run_args_0
) {
3857 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3861 print_run_args
= true;
3863 case OPT_RUN_ARGS_0
:
3864 if (print_run_args
) {
3865 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3869 print_run_args_0
= true;
3871 case OPT_STREAM_INTERSECTION
:
3873 * Applies to all traces implementing the
3874 * babeltrace.trace-infos query.
3876 stream_intersection_mode
= true;
3879 *default_log_level
=
3880 logging_level_min(*default_log_level
, BT_LOG_INFO
);
3883 *default_log_level
=
3884 logging_level_min(*default_log_level
, BT_LOG_TRACE
);
3891 set_auto_log_levels(default_log_level
);
3894 * Legacy behaviour: --verbose used to make the `text` output
3895 * format print more information. --verbose is now equivalent to
3896 * the INFO log level, which is why we compare to `BT_LOG_INFO`
3899 if (*default_log_level
== BT_LOG_INFO
) {
3900 append_implicit_component_param(&implicit_text_args
,
3904 /* Print CTF metadata or print LTTng live sessions */
3905 if (print_ctf_metadata
) {
3906 const bt_value
*bt_val_non_opt
;
3908 if (bt_value_array_is_empty(non_opts
)) {
3909 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
3913 if (bt_value_array_get_length(non_opts
) > 1) {
3914 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
3918 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
3923 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
3924 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
3925 bt_value_string_get(bt_val_non_opt
));
3929 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
3937 * If -o ctf was specified, make sure an output path (--output)
3938 * was also specified. --output does not imply -o ctf because
3939 * it's also used for the default, implicit -o text if -o ctf
3942 if (implicit_ctf_output_args
.exists
) {
3944 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
3949 * At this point we know that -o ctf AND --output were
3950 * specified. Make sure that no options were specified
3951 * which would imply -o text because --output would be
3952 * ambiguous in this case. For example, this is wrong:
3954 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
3956 * because --names=all implies -o text, and --output
3957 * could apply to both the sink.text.pretty and
3958 * sink.ctf.fs implicit components.
3960 if (implicit_text_args
.exists
) {
3961 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
3967 * If -o dummy and -o ctf were not specified, and if there are
3968 * no explicit sink components, then use an implicit
3969 * `sink.text.pretty` component.
3971 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
3973 implicit_text_args
.exists
= true;
3977 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
3978 * `path` parameter if --output was specified.
3981 if (implicit_text_args
.exists
) {
3982 append_implicit_component_extra_param(&implicit_text_args
,
3984 } else if (implicit_ctf_output_args
.exists
) {
3985 append_implicit_component_extra_param(&implicit_ctf_output_args
,
3990 /* Decide where the non-option argument(s) go */
3991 if (bt_value_array_get_length(non_opts
) > 0) {
3992 if (implicit_lttng_live_args
.exists
) {
3993 const bt_value
*bt_val_non_opt
;
3995 if (bt_value_array_get_length(non_opts
) > 1) {
3996 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
4000 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
4001 lttng_live_url_parts
=
4002 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt
),
4003 error_buf
, sizeof(error_buf
));
4004 if (!lttng_live_url_parts
.proto
) {
4005 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
4010 if (!lttng_live_url_parts
.session_name
) {
4011 /* Print LTTng live sessions */
4012 cfg
= bt_config_print_lttng_live_sessions_create(
4018 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4019 bt_value_string_get(bt_val_non_opt
));
4023 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4030 live_inputs_array_val
= bt_value_array_create();
4031 if (!live_inputs_array_val
) {
4032 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4036 if (bt_value_array_append_string_element(
4037 live_inputs_array_val
,
4038 bt_value_string_get(bt_val_non_opt
))) {
4039 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4043 ret
= append_parameter_to_args(
4044 implicit_lttng_live_args
.extra_params
,
4045 "inputs", live_inputs_array_val
);
4050 ret
= append_implicit_component_extra_param(
4051 &implicit_lttng_live_args
,
4052 "session-not-found-action", "end");
4058 size_t plugin_count
;
4059 const bt_plugin
**plugins
;
4060 const bt_plugin
*plugin
;
4062 status
= require_loaded_plugins(plugin_paths
);
4067 if (auto_source_discovery_restrict_plugin_name
) {
4069 plugin
= find_loaded_plugin(auto_source_discovery_restrict_plugin_name
);
4072 plugin_count
= get_loaded_plugins_count();
4073 plugins
= borrow_loaded_plugins();
4076 status
= auto_discover_source_components(non_opts
, plugins
, plugin_count
,
4077 auto_source_discovery_restrict_component_class_name
,
4078 *default_log_level
, &auto_disc
, interrupter
);
4081 if (status
== AUTO_SOURCE_DISCOVERY_STATUS_INTERRUPTED
) {
4082 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
4083 "Babeltrace CLI", "Automatic source discovery interrupted by the user");
4088 status
= create_implicit_component_args_from_auto_discovered_sources(
4089 &auto_disc
, non_opts
, non_opt_params
, non_opt_loglevels
,
4090 discovered_source_args
);
4099 * If --clock-force-correlated was given, apply it to any src.ctf.fs
4102 if (ctf_fs_source_force_clock_class_unix_epoch_origin
) {
4105 n
= append_multiple_implicit_components_param(
4106 discovered_source_args
, "source.ctf.fs", "force-clock-class-origin-unix-epoch",
4109 BT_CLI_LOGE_APPEND_CAUSE("--clock-force-correlate specified, but no source.ctf.fs component instantiated.");
4114 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4115 if (ctf_fs_source_clock_class_offset_arg
) {
4118 n
= append_multiple_implicit_components_param(
4119 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4120 ctf_fs_source_clock_class_offset_arg
);
4123 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4128 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4129 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4132 n
= append_multiple_implicit_components_param(
4133 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4134 ctf_fs_source_clock_class_offset_ns_arg
);
4137 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4143 * If the implicit `source.ctf.lttng-live` component exists,
4144 * make sure there's at least one non-option argument (which is
4147 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(non_opts
)) {
4148 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4149 implicit_lttng_live_args
.comp_arg
->str
);
4153 /* Assign names to implicit components */
4154 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4155 struct implicit_component_args
*args
;
4158 args
= discovered_source_args
->pdata
[i
];
4160 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4162 /* Give it a name like `auto-disc-src-ctf-fs`. */
4163 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4164 if (auto_disc_comp_name
->str
[j
] == '.') {
4165 auto_disc_comp_name
->str
[j
] = '-';
4169 ret
= assign_name_to_implicit_component(args
,
4170 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4176 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4177 "lttng-live", all_names
, &source_names
, true);
4182 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4183 "pretty", all_names
, &sink_names
, true);
4188 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4189 "sink-ctf-fs", all_names
, &sink_names
, true);
4194 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4195 "dummy", all_names
, &sink_names
, true);
4200 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4201 "muxer", all_names
, NULL
, false);
4206 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4207 "trimmer", all_names
, NULL
, false);
4212 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4213 "debug-info", all_names
, NULL
, false);
4218 /* Make sure there's at least one source and one sink */
4219 if (!source_names
) {
4220 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4225 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4229 /* Make sure there's a single sink component */
4230 if (g_list_length(sink_names
) != 1) {
4231 BT_CLI_LOGE_APPEND_CAUSE(
4232 "More than one sink component specified.");
4237 * Prepend the muxer, the trimmer, and the debug info to the
4238 * filter chain so that we have:
4240 * sources -> muxer -> [trimmer] -> [debug info] ->
4241 * [user filters] -> sinks
4243 if (implicit_debug_info_args
.exists
) {
4244 if (g_list_prepend_gstring(&filter_names
,
4245 implicit_debug_info_args
.name_arg
->str
)) {
4250 if (implicit_trimmer_args
.exists
) {
4251 if (g_list_prepend_gstring(&filter_names
,
4252 implicit_trimmer_args
.name_arg
->str
)) {
4257 if (g_list_prepend_gstring(&filter_names
,
4258 implicit_muxer_args
.name_arg
->str
)) {
4263 * Append the equivalent run arguments for the implicit
4266 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4267 struct implicit_component_args
*args
=
4268 discovered_source_args
->pdata
[i
];
4270 ret
= append_run_args_for_implicit_component(args
, run_args
);
4276 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4282 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4288 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4294 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4300 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4306 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4312 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4318 /* Auto-connect components */
4319 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4322 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4327 * We have all the run command arguments now. Depending on
4328 * --run-args, we pass this to the run command or print them
4331 if (print_run_args
|| print_run_args_0
) {
4332 if (stream_intersection_mode
) {
4333 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4337 for (i
= 0; i
< bt_value_array_get_length(run_args
); i
++) {
4338 const bt_value
*arg_value
=
4339 bt_value_array_borrow_element_by_index(run_args
,
4342 GString
*quoted
= NULL
;
4343 const char *arg_to_print
;
4345 BT_ASSERT(arg_value
);
4346 arg
= bt_value_string_get(arg_value
);
4348 if (print_run_args
) {
4349 quoted
= bt_common_shell_quote(arg
, true);
4354 arg_to_print
= quoted
->str
;
4359 printf("%s", arg_to_print
);
4362 g_string_free(quoted
, TRUE
);
4365 if (i
< bt_value_array_get_length(run_args
) - 1) {
4366 if (print_run_args
) {
4375 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4379 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4380 plugin_paths
, *default_log_level
);
4385 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4390 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4393 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4397 if (component_arg_for_run
) {
4398 g_string_free(component_arg_for_run
, TRUE
);
4402 g_string_free(name_gstr
, TRUE
);
4405 bt_value_put_ref(live_inputs_array_val
);
4406 bt_value_put_ref(run_args
);
4407 bt_value_put_ref(all_names
);
4408 destroy_glist_of_gstring(source_names
);
4409 destroy_glist_of_gstring(filter_names
);
4410 destroy_glist_of_gstring(sink_names
);
4411 bt_value_put_ref(non_opt_params
);
4412 bt_value_put_ref(non_opt_loglevels
);
4413 bt_value_put_ref(non_opts
);
4414 finalize_implicit_component_args(&implicit_ctf_output_args
);
4415 finalize_implicit_component_args(&implicit_lttng_live_args
);
4416 finalize_implicit_component_args(&implicit_dummy_args
);
4417 finalize_implicit_component_args(&implicit_text_args
);
4418 finalize_implicit_component_args(&implicit_debug_info_args
);
4419 finalize_implicit_component_args(&implicit_muxer_args
);
4420 finalize_implicit_component_args(&implicit_trimmer_args
);
4421 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4422 auto_source_discovery_fini(&auto_disc
);
4424 if (discovered_source_args
) {
4425 g_ptr_array_free(discovered_source_args
, TRUE
);
4428 g_free(ctf_fs_source_clock_class_offset_arg
);
4429 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4431 if (auto_disc_comp_name
) {
4432 g_string_free(auto_disc_comp_name
, TRUE
);
4439 * Prints the Babeltrace 2.x general usage.
4442 void print_gen_usage(FILE *fp
)
4444 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4446 fprintf(fp
, "General options:\n");
4448 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=T)\n");
4449 fprintf(fp
, " -h, --help Show this help and quit\n");
4450 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `T`, `D`,\n");
4451 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4452 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
4453 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
4454 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
4455 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
4456 fprintf(fp
, " dynamic plugins can be loaded\n");
4457 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4458 fprintf(fp
, " -V, --version Show version and quit\n");
4460 fprintf(fp
, "Available commands:\n");
4462 fprintf(fp
, " convert Convert and trim traces (default)\n");
4463 fprintf(fp
, " help Get help for a plugin or a component class\n");
4464 fprintf(fp
, " list-plugins List available plugins and their content\n");
4465 fprintf(fp
, " query Query objects from a component class\n");
4466 fprintf(fp
, " run Build a processing graph and run it\n");
4468 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4471 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4472 int *retcode
, bool omit_system_plugin_path
,
4473 bool omit_home_plugin_path
,
4474 const bt_value
*initial_plugin_paths
,
4475 const bt_interrupter
*interrupter
)
4477 struct bt_config
*config
= NULL
;
4480 const char **top_level_argv
;
4481 int command_argc
= -1;
4482 const char **command_argv
= NULL
;
4483 const char *command_name
= NULL
;
4484 int default_log_level
= -1;
4485 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
4486 bt_value
*plugin_paths
= NULL
;
4488 /* Top-level option descriptions. */
4489 static const struct bt_argpar_opt_descr descrs
[] = {
4490 { OPT_DEBUG
, 'd', "debug", false },
4491 { OPT_HELP
, 'h', "help", false },
4492 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4493 { OPT_VERBOSE
, 'v', "verbose", false },
4494 { OPT_VERSION
, 'V', "version", false},
4495 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
4496 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
4497 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
4498 BT_ARGPAR_OPT_DESCR_SENTINEL
4502 COMMAND_TYPE_NONE
= -1,
4503 COMMAND_TYPE_RUN
= 0,
4504 COMMAND_TYPE_CONVERT
,
4505 COMMAND_TYPE_LIST_PLUGINS
,
4508 } command_type
= COMMAND_TYPE_NONE
;
4512 if (!initial_plugin_paths
) {
4513 plugin_paths
= bt_value_array_create();
4514 if (!plugin_paths
) {
4518 bt_value_copy_status copy_status
= bt_value_copy(
4519 initial_plugin_paths
, &plugin_paths
);
4525 BT_ASSERT(plugin_paths
);
4528 * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
4529 * `--plugin-path` option's paths, so append it now before
4530 * parsing the general options.
4532 if (append_env_var_plugin_paths(plugin_paths
)) {
4539 print_gen_usage(stdout
);
4543 /* Skip first argument, the name of the program. */
4544 top_level_argc
= argc
- 1;
4545 top_level_argv
= argv
+ 1;
4546 argpar_parse_ret
= bt_argpar_parse(top_level_argc
, top_level_argv
,
4549 if (argpar_parse_ret
.error
) {
4550 BT_CLI_LOGE_APPEND_CAUSE(
4551 "While parsing command-line arguments: %s",
4552 argpar_parse_ret
.error
->str
);
4556 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
4557 struct bt_argpar_item
*item
;
4559 item
= g_ptr_array_index(argpar_parse_ret
.items
, i
);
4561 if (item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
4562 struct bt_argpar_item_opt
*item_opt
=
4563 (struct bt_argpar_item_opt
*) item
;
4565 switch (item_opt
->descr
->id
) {
4568 logging_level_min(default_log_level
, BT_LOG_TRACE
);
4572 logging_level_min(default_log_level
, BT_LOG_INFO
);
4576 int level
= bt_log_get_level_from_string(item_opt
->arg
);
4579 BT_CLI_LOGE_APPEND_CAUSE(
4580 "Invalid argument for --log-level option:\n %s",
4586 logging_level_min(default_log_level
, level
);
4589 case OPT_PLUGIN_PATH
:
4590 if (bt_config_append_plugin_paths_check_setuid_setgid(
4591 plugin_paths
, item_opt
->arg
)) {
4595 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4596 omit_system_plugin_path
= true;
4598 case OPT_OMIT_HOME_PLUGIN_PATH
:
4599 omit_home_plugin_path
= true;
4605 print_gen_usage(stdout
);
4608 } else if (item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
4609 struct bt_argpar_item_non_opt
*item_non_opt
=
4610 (struct bt_argpar_item_non_opt
*) item
;
4612 * First unknown argument: is it a known command
4616 top_level_argc
- item_non_opt
->orig_index
- 1;
4618 &top_level_argv
[item_non_opt
->orig_index
+ 1];
4620 if (strcmp(item_non_opt
->arg
, "convert") == 0) {
4621 command_type
= COMMAND_TYPE_CONVERT
;
4622 } else if (strcmp(item_non_opt
->arg
, "list-plugins") == 0) {
4623 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4624 } else if (strcmp(item_non_opt
->arg
, "help") == 0) {
4625 command_type
= COMMAND_TYPE_HELP
;
4626 } else if (strcmp(item_non_opt
->arg
, "query") == 0) {
4627 command_type
= COMMAND_TYPE_QUERY
;
4628 } else if (strcmp(item_non_opt
->arg
, "run") == 0) {
4629 command_type
= COMMAND_TYPE_RUN
;
4632 * Non-option argument, but not a known
4633 * command name: assume the default
4634 * `convert` command.
4636 command_type
= COMMAND_TYPE_CONVERT
;
4637 command_name
= "convert";
4645 if (command_type
== COMMAND_TYPE_NONE
) {
4646 if (argpar_parse_ret
.ingested_orig_args
== top_level_argc
) {
4648 * We only got non-help, non-version general options
4649 * like --verbose and --debug, without any other
4650 * arguments, so we can't do anything useful: print the
4653 print_gen_usage(stdout
);
4658 * We stopped on an unknown option argument (and therefore
4659 * didn't see a command name). Assume `convert` command.
4661 command_type
= COMMAND_TYPE_CONVERT
;
4662 command_name
= "convert";
4664 top_level_argc
- argpar_parse_ret
.ingested_orig_args
;
4666 &top_level_argv
[argpar_parse_ret
.ingested_orig_args
];
4669 BT_ASSERT(command_argv
);
4670 BT_ASSERT(command_argc
>= 0);
4673 * For all commands other than `convert`, we now know the log level to
4674 * use, so we can apply it with `set_auto_log_levels`.
4676 * The convert command has `--debug` and `--verbose` arguments that are
4677 * equivalent to the top-level arguments of the same name. So after it
4678 * has parsed its arguments, `bt_config_convert_from_args` calls
4679 * `set_auto_log_levels` itself.
4681 if (command_type
!= COMMAND_TYPE_CONVERT
) {
4682 set_auto_log_levels(&default_log_level
);
4686 * At this point, `plugin_paths` contains the initial plugin
4687 * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
4688 * the paths from the `--plugin-path` option.
4690 * Now append the user and system plugin paths.
4692 if (append_home_and_system_plugin_paths(plugin_paths
,
4693 omit_system_plugin_path
, omit_home_plugin_path
)) {
4697 switch (command_type
) {
4698 case COMMAND_TYPE_RUN
:
4699 config
= bt_config_run_from_args(command_argc
, command_argv
,
4700 retcode
, plugin_paths
,
4703 case COMMAND_TYPE_CONVERT
:
4704 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4705 retcode
, plugin_paths
, &default_log_level
, interrupter
);
4707 case COMMAND_TYPE_LIST_PLUGINS
:
4708 config
= bt_config_list_plugins_from_args(command_argc
,
4709 command_argv
, retcode
, plugin_paths
);
4711 case COMMAND_TYPE_HELP
:
4712 config
= bt_config_help_from_args(command_argc
,
4713 command_argv
, retcode
, plugin_paths
,
4716 case COMMAND_TYPE_QUERY
:
4717 config
= bt_config_query_from_args(command_argc
,
4718 command_argv
, retcode
, plugin_paths
,
4726 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4727 config
->log_level
= default_log_level
;
4728 config
->command_name
= command_name
;
4737 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4738 bt_value_put_ref(plugin_paths
);