2 * Babeltrace trace converter - parameter parsing
4 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "CLI/CFG-CLI-ARGS"
31 #include "common/assert.h"
35 #include <babeltrace2/babeltrace.h>
36 #include "common/common.h"
38 #include <sys/types.h>
39 #include "argpar/argpar.h"
40 #include "babeltrace2-cfg.h"
41 #include "babeltrace2-cfg-cli-args.h"
42 #include "babeltrace2-cfg-cli-args-connect.h"
43 #include "babeltrace2-cfg-cli-params-arg.h"
44 #include "babeltrace2-plugins.h"
45 #include "babeltrace2-query.h"
46 #include "autodisc/autodisc.h"
47 #include "common/version.h"
49 static const int cli_default_log_level
= BT_LOG_WARNING
;
51 /* INI-style parsing FSM states */
52 enum ini_parsing_fsm_state
{
53 /* Expect a map key (identifier) */
56 /* Expect an equal character ('=') */
62 /* Expect a comma character (',') */
66 /* INI-style parsing state variables */
67 struct ini_parsing_state
{
68 /* Lexical scanner (owned by this) */
71 /* Output map value object being filled (owned by this) */
74 /* Next expected FSM state */
75 enum ini_parsing_fsm_state expecting
;
77 /* Last decoded map key (owned by this) */
80 /* Complete INI-style string to parse (not owned by this) */
83 /* Error buffer (not owned by this) */
87 /* Offset option with "is set" boolean */
93 /* Legacy "ctf"/"lttng-live" format options */
94 struct ctf_legacy_opts
{
95 struct offset_opt offset_s
;
96 struct offset_opt offset_ns
;
97 bool stream_intersection
;
100 /* Legacy "text" format options */
101 struct text_legacy_opts
{
103 * output, dbg_info_dir, dbg_info_target_prefix, names,
104 * and fields are owned by this.
107 GString
*dbg_info_dir
;
108 GString
*dbg_info_target_prefix
;
109 const bt_value
*names
;
110 const bt_value
*fields
;
118 bool dbg_info_full_path
;
122 /* Legacy input format format */
123 enum legacy_input_format
{
124 LEGACY_INPUT_FORMAT_NONE
= 0,
125 LEGACY_INPUT_FORMAT_CTF
,
126 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
129 /* Legacy output format format */
130 enum legacy_output_format
{
131 LEGACY_OUTPUT_FORMAT_NONE
= 0,
132 LEGACY_OUTPUT_FORMAT_TEXT
,
133 LEGACY_OUTPUT_FORMAT_DUMMY
,
136 #define BT_CLI_LOGE_APPEND_CAUSE_OOM() BT_CLI_LOGE_APPEND_CAUSE("Out of memory.")
139 * Returns the plugin name, component class name, component class type,
140 * and component name from a command-line --component option's argument.
141 * arg must have the following format:
143 * [NAME:]TYPE.PLUGIN.CLS
145 * where NAME is the optional component name, TYPE is either `source`,
146 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
147 * component class name.
149 * On success, both *plugin and *component are not NULL. *plugin
150 * and *comp_cls are owned by the caller. On success, *name can be NULL
151 * if no component class name was found, and *comp_cls_type is set.
154 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
155 char **comp_cls
, bt_component_class_type
*comp_cls_type
)
157 const char *at
= arg
;
158 GString
*gs_name
= NULL
;
159 GString
*gs_comp_cls_type
= NULL
;
160 GString
*gs_plugin
= NULL
;
161 GString
*gs_comp_cls
= NULL
;
167 BT_ASSERT(comp_cls_type
);
169 if (!bt_common_string_is_printable(arg
)) {
170 BT_CLI_LOGE_APPEND_CAUSE("Argument contains a non-printable character.");
174 /* Parse the component name */
175 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
180 if (arg
[end_pos
] == ':') {
184 g_string_assign(gs_name
, "");
187 /* Parse the component class type */
188 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
189 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
190 BT_CLI_LOGE_APPEND_CAUSE("Missing component class type (`source`, `filter`, or `sink`).");
194 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
195 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
196 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
197 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
198 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
199 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
200 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
201 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
203 BT_CLI_LOGE_APPEND_CAUSE("Unknown component class type: `%s`.",
204 gs_comp_cls_type
->str
);
210 /* Parse the plugin name */
211 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
212 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
213 BT_CLI_LOGE_APPEND_CAUSE("Missing plugin or component class name.");
219 /* Parse the component class name */
220 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
221 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
222 BT_CLI_LOGE_APPEND_CAUSE("Missing component class name.");
226 if (at
[end_pos
] != '\0') {
227 /* Found a non-escaped `.` */
232 if (gs_name
->len
== 0) {
234 g_string_free(gs_name
, TRUE
);
236 *name
= gs_name
->str
;
237 g_string_free(gs_name
, FALSE
);
240 g_string_free(gs_name
, TRUE
);
243 *plugin
= gs_plugin
->str
;
244 *comp_cls
= gs_comp_cls
->str
;
245 g_string_free(gs_plugin
, FALSE
);
246 g_string_free(gs_comp_cls
, FALSE
);
262 g_string_free(gs_name
, TRUE
);
266 g_string_free(gs_plugin
, TRUE
);
270 g_string_free(gs_comp_cls
, TRUE
);
273 if (gs_comp_cls_type
) {
274 g_string_free(gs_comp_cls_type
, TRUE
);
281 * Prints the Babeltrace version.
284 void print_version(void)
286 if (GIT_VERSION
[0] == '\0') {
287 puts("Babeltrace " VERSION
);
289 puts("Babeltrace " VERSION
" - " GIT_VERSION
);
294 * Destroys a component configuration.
297 void bt_config_component_destroy(bt_object
*obj
)
299 struct bt_config_component
*bt_config_component
=
300 container_of(obj
, struct bt_config_component
, base
);
306 if (bt_config_component
->plugin_name
) {
307 g_string_free(bt_config_component
->plugin_name
, TRUE
);
310 if (bt_config_component
->comp_cls_name
) {
311 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
314 if (bt_config_component
->instance_name
) {
315 g_string_free(bt_config_component
->instance_name
, TRUE
);
318 BT_VALUE_PUT_REF_AND_RESET(bt_config_component
->params
);
319 g_free(bt_config_component
);
326 * Creates a component configuration using the given plugin name and
327 * component name. `plugin_name` and `comp_cls_name` are copied (belong
328 * to the return value).
330 * Return value is owned by the caller.
333 struct bt_config_component
*bt_config_component_create(
334 bt_component_class_type type
,
335 const char *plugin_name
, const char *comp_cls_name
,
338 struct bt_config_component
*cfg_component
= NULL
;
340 cfg_component
= g_new0(struct bt_config_component
, 1);
341 if (!cfg_component
) {
342 BT_CLI_LOGE_APPEND_CAUSE_OOM();
346 bt_object_init_shared(&cfg_component
->base
,
347 bt_config_component_destroy
);
348 cfg_component
->type
= type
;
349 cfg_component
->plugin_name
= g_string_new(plugin_name
);
350 if (!cfg_component
->plugin_name
) {
351 BT_CLI_LOGE_APPEND_CAUSE_OOM();
355 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
356 if (!cfg_component
->comp_cls_name
) {
357 BT_CLI_LOGE_APPEND_CAUSE_OOM();
361 cfg_component
->instance_name
= g_string_new(NULL
);
362 if (!cfg_component
->instance_name
) {
363 BT_CLI_LOGE_APPEND_CAUSE_OOM();
367 cfg_component
->log_level
= init_log_level
;
369 /* Start with empty parameters */
370 cfg_component
->params
= bt_value_map_create();
371 if (!cfg_component
->params
) {
372 BT_CLI_LOGE_APPEND_CAUSE_OOM();
379 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
382 return cfg_component
;
386 * Creates a component configuration from a command-line --component
390 struct bt_config_component
*bt_config_component_from_arg(const char *arg
,
393 struct bt_config_component
*cfg_comp
= NULL
;
395 char *plugin_name
= NULL
;
396 char *comp_cls_name
= NULL
;
397 bt_component_class_type type
;
399 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
400 if (!plugin_name
|| !comp_cls_name
) {
404 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
,
411 g_string_assign(cfg_comp
->instance_name
, name
);
417 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp
);
422 g_free(comp_cls_name
);
427 * Destroys a configuration.
430 void bt_config_destroy(bt_object
*obj
)
432 struct bt_config
*cfg
=
433 container_of(obj
, struct bt_config
, base
);
439 BT_VALUE_PUT_REF_AND_RESET(cfg
->plugin_paths
);
441 switch (cfg
->command
) {
442 case BT_CONFIG_COMMAND_RUN
:
443 if (cfg
->cmd_data
.run
.sources
) {
444 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
447 if (cfg
->cmd_data
.run
.filters
) {
448 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
451 if (cfg
->cmd_data
.run
.sinks
) {
452 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
455 if (cfg
->cmd_data
.run
.connections
) {
456 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
460 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
462 case BT_CONFIG_COMMAND_HELP
:
463 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.help
.cfg_component
);
465 case BT_CONFIG_COMMAND_QUERY
:
466 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.query
.cfg_component
);
468 if (cfg
->cmd_data
.query
.object
) {
469 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
472 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
473 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
474 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
477 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
481 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
482 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
484 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
487 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
502 void destroy_glist_of_gstring(GList
*list
)
510 for (at
= list
; at
; at
= g_list_next(at
)) {
511 g_string_free(at
->data
, TRUE
);
518 * Creates a simple lexical scanner for parsing comma-delimited names
521 * Return value is owned by the caller.
524 GScanner
*create_csv_identifiers_scanner(void)
527 GScannerConfig scanner_config
= {
528 .cset_skip_characters
= " \t\n",
529 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
530 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
531 .case_sensitive
= TRUE
,
532 .cpair_comment_single
= NULL
,
533 .skip_comment_multi
= TRUE
,
534 .skip_comment_single
= TRUE
,
535 .scan_comment_multi
= FALSE
,
536 .scan_identifier
= TRUE
,
537 .scan_identifier_1char
= TRUE
,
538 .scan_identifier_NULL
= FALSE
,
539 .scan_symbols
= FALSE
,
540 .symbol_2_token
= FALSE
,
541 .scope_0_fallback
= FALSE
,
542 .scan_binary
= FALSE
,
546 .scan_hex_dollar
= FALSE
,
547 .numbers_2_int
= FALSE
,
548 .int_2_float
= FALSE
,
549 .store_int64
= FALSE
,
550 .scan_string_sq
= FALSE
,
551 .scan_string_dq
= FALSE
,
552 .identifier_2_string
= FALSE
,
553 .char_2_token
= TRUE
,
556 scanner
= g_scanner_new(&scanner_config
);
558 BT_CLI_LOGE_APPEND_CAUSE_OOM();
565 * Converts a comma-delimited list of known names (--names option) to
566 * an array value object containing those names as string value objects.
568 * Return value is owned by the caller.
571 bt_value
*names_from_arg(const char *arg
)
573 GScanner
*scanner
= NULL
;
574 bt_value
*names
= NULL
;
575 bool found_all
= false, found_none
= false, found_item
= false;
577 names
= bt_value_array_create();
579 BT_CLI_LOGE_APPEND_CAUSE_OOM();
583 scanner
= create_csv_identifiers_scanner();
588 g_scanner_input_text(scanner
, arg
, strlen(arg
));
591 GTokenType token_type
= g_scanner_get_next_token(scanner
);
593 switch (token_type
) {
594 case G_TOKEN_IDENTIFIER
:
596 const char *identifier
= scanner
->value
.v_identifier
;
598 if (strcmp(identifier
, "payload") == 0 ||
599 strcmp(identifier
, "args") == 0 ||
600 strcmp(identifier
, "arg") == 0) {
602 if (bt_value_array_append_string_element(names
,
606 } else if (strcmp(identifier
, "context") == 0 ||
607 strcmp(identifier
, "ctx") == 0) {
609 if (bt_value_array_append_string_element(names
,
613 } else if (strcmp(identifier
, "scope") == 0 ||
614 strcmp(identifier
, "header") == 0) {
616 if (bt_value_array_append_string_element(names
,
620 } else if (strcmp(identifier
, "all") == 0) {
622 if (bt_value_array_append_string_element(names
,
626 } else if (strcmp(identifier
, "none") == 0) {
628 if (bt_value_array_append_string_element(names
,
633 BT_CLI_LOGE_APPEND_CAUSE("Unknown name: `%s`.",
649 if (found_none
&& found_all
) {
650 BT_CLI_LOGE_APPEND_CAUSE("Only either `all` or `none` can be specified in the list given to the --names option, but not both.");
654 * Legacy behavior is to clear the defaults (show none) when at
655 * least one item is specified.
657 if (found_item
&& !found_none
&& !found_all
) {
658 if (bt_value_array_append_string_element(names
, "none")) {
663 g_scanner_destroy(scanner
);
668 BT_VALUE_PUT_REF_AND_RESET(names
);
670 g_scanner_destroy(scanner
);
676 * Converts a comma-delimited list of known fields (--fields option) to
677 * an array value object containing those fields as string
680 * Return value is owned by the caller.
683 bt_value
*fields_from_arg(const char *arg
)
685 GScanner
*scanner
= NULL
;
688 fields
= bt_value_array_create();
690 BT_CLI_LOGE_APPEND_CAUSE_OOM();
694 scanner
= create_csv_identifiers_scanner();
699 g_scanner_input_text(scanner
, arg
, strlen(arg
));
702 GTokenType token_type
= g_scanner_get_next_token(scanner
);
704 switch (token_type
) {
705 case G_TOKEN_IDENTIFIER
:
707 const char *identifier
= scanner
->value
.v_identifier
;
709 if (strcmp(identifier
, "trace") == 0 ||
710 strcmp(identifier
, "trace:hostname") == 0 ||
711 strcmp(identifier
, "trace:domain") == 0 ||
712 strcmp(identifier
, "trace:procname") == 0 ||
713 strcmp(identifier
, "trace:vpid") == 0 ||
714 strcmp(identifier
, "loglevel") == 0 ||
715 strcmp(identifier
, "emf") == 0 ||
716 strcmp(identifier
, "callsite") == 0 ||
717 strcmp(identifier
, "all") == 0) {
718 if (bt_value_array_append_string_element(fields
,
723 BT_CLI_LOGE_APPEND_CAUSE("Unknown field: `%s`.",
741 BT_VALUE_PUT_REF_AND_RESET(fields
);
745 g_scanner_destroy(scanner
);
751 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
753 BT_ASSERT(params_arg
);
757 if (params_arg
->len
!= 0) {
758 g_string_append_c(params_arg
, ',');
761 g_string_append(params_arg
, key
);
762 g_string_append_c(params_arg
, '=');
763 g_string_append(params_arg
, value
);
767 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
768 * where the names are in names_array.
771 int insert_flat_params_from_array(GString
*params_arg
,
772 const bt_value
*names_array
, const char *prefix
)
776 GString
*tmpstr
= NULL
, *default_value
= NULL
;
777 bool default_set
= false, non_default_set
= false;
780 * names_array may be NULL if no CLI options were specified to
781 * trigger its creation.
787 tmpstr
= g_string_new(NULL
);
789 BT_CLI_LOGE_APPEND_CAUSE_OOM();
794 default_value
= g_string_new(NULL
);
795 if (!default_value
) {
796 BT_CLI_LOGE_APPEND_CAUSE_OOM();
801 for (i
= 0; i
< bt_value_array_get_length(names_array
); i
++) {
802 const bt_value
*str_obj
=
803 bt_value_array_borrow_element_by_index_const(names_array
,
806 bool is_default
= false;
809 BT_CLI_LOGE_APPEND_CAUSE("Unexpected error.");
814 suffix
= bt_value_string_get(str_obj
);
816 g_string_assign(tmpstr
, prefix
);
817 g_string_append(tmpstr
, "-");
819 /* Special-case for "all" and "none". */
820 if (strcmp(suffix
, "all") == 0) {
822 g_string_assign(default_value
, "show");
823 } else if (strcmp(suffix
, "none") == 0) {
825 g_string_assign(default_value
, "hide");
829 g_string_append(tmpstr
, "default");
830 append_param_arg(params_arg
, tmpstr
->str
,
833 non_default_set
= true;
834 g_string_append(tmpstr
, suffix
);
835 append_param_arg(params_arg
, tmpstr
->str
, "yes");
839 /* Implicit field-default=hide if any non-default option is set. */
840 if (non_default_set
&& !default_set
) {
841 g_string_assign(tmpstr
, prefix
);
842 g_string_append(tmpstr
, "-default");
843 g_string_assign(default_value
, "hide");
844 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
849 g_string_free(default_value
, TRUE
);
853 g_string_free(tmpstr
, TRUE
);
866 OPT_CLOCK_FORCE_CORRELATE
,
877 OPT_DEBUG_INFO_FULL_PATH
,
878 OPT_DEBUG_INFO_TARGET_PREFIX
,
887 OPT_OMIT_HOME_PLUGIN_PATH
,
888 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
893 OPT_RESET_BASE_PARAMS
,
897 OPT_STREAM_INTERSECTION
,
903 enum bt_config_component_dest
{
904 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
905 BT_CONFIG_COMPONENT_DEST_SOURCE
,
906 BT_CONFIG_COMPONENT_DEST_FILTER
,
907 BT_CONFIG_COMPONENT_DEST_SINK
,
911 * Adds a configuration component to the appropriate configuration
912 * array depending on the destination.
915 void add_run_cfg_comp(struct bt_config
*cfg
,
916 struct bt_config_component
*cfg_comp
,
917 enum bt_config_component_dest dest
)
919 bt_object_get_ref(cfg_comp
);
922 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
923 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
925 case BT_CONFIG_COMPONENT_DEST_FILTER
:
926 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
928 case BT_CONFIG_COMPONENT_DEST_SINK
:
929 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
937 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
938 struct bt_config_component
*cfg_comp
,
939 enum bt_config_component_dest dest
,
940 bt_value
*instance_names
)
944 if (cfg_comp
->instance_name
->len
== 0) {
945 BT_CLI_LOGE_APPEND_CAUSE("Found an unnamed component.");
950 if (bt_value_map_has_entry(instance_names
,
951 cfg_comp
->instance_name
->str
)) {
952 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
953 cfg_comp
->instance_name
->str
);
958 if (bt_value_map_insert_entry(instance_names
,
959 cfg_comp
->instance_name
->str
, bt_value_null
)) {
960 BT_CLI_LOGE_APPEND_CAUSE_OOM();
965 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
972 int append_env_var_plugin_paths(bt_value
*plugin_paths
)
977 if (bt_common_is_setuid_setgid()) {
978 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
982 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
987 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
991 BT_CLI_LOGE_APPEND_CAUSE("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH.");
998 int append_home_and_system_plugin_paths(bt_value
*plugin_paths
,
999 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
1003 if (!omit_home_plugin_path
) {
1004 if (bt_common_is_setuid_setgid()) {
1005 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1007 char *home_plugin_dir
= bt_common_get_home_plugin_path(
1008 BT_LOG_OUTPUT_LEVEL
);
1010 if (home_plugin_dir
) {
1011 ret
= bt_config_append_plugin_paths(
1012 plugin_paths
, home_plugin_dir
);
1013 free(home_plugin_dir
);
1016 BT_CLI_LOGE_APPEND_CAUSE("Invalid home plugin path.");
1023 if (!omit_system_plugin_path
) {
1024 if (bt_config_append_plugin_paths(plugin_paths
,
1025 bt_common_get_system_plugin_path())) {
1026 BT_CLI_LOGE_APPEND_CAUSE("Invalid system plugin path.");
1032 BT_CLI_LOGE_APPEND_CAUSE("Cannot append home and system plugin paths.");
1037 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1038 const bt_value
*plugin_paths
, bool needs_plugins
)
1040 struct bt_config
*cfg
;
1043 cfg
= g_new0(struct bt_config
, 1);
1045 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1049 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1050 cfg
->command
= command
;
1051 cfg
->command_needs_plugins
= needs_plugins
;
1054 bt_value
*plugin_paths_copy
;
1056 (void) bt_value_copy(plugin_paths
,
1057 &plugin_paths_copy
);
1058 cfg
->plugin_paths
= plugin_paths_copy
;
1060 cfg
->plugin_paths
= bt_value_array_create();
1061 if (!cfg
->plugin_paths
) {
1062 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1070 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1077 struct bt_config
*bt_config_run_create(const bt_value
*plugin_paths
)
1079 struct bt_config
*cfg
;
1082 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1083 plugin_paths
, true);
1088 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1089 (GDestroyNotify
) bt_object_put_ref
);
1090 if (!cfg
->cmd_data
.run
.sources
) {
1091 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1095 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1096 (GDestroyNotify
) bt_object_put_ref
);
1097 if (!cfg
->cmd_data
.run
.filters
) {
1098 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1102 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1103 (GDestroyNotify
) bt_object_put_ref
);
1104 if (!cfg
->cmd_data
.run
.sinks
) {
1105 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1109 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1110 (GDestroyNotify
) bt_config_connection_destroy
);
1111 if (!cfg
->cmd_data
.run
.connections
) {
1112 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1119 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1126 struct bt_config
*bt_config_list_plugins_create(const bt_value
*plugin_paths
)
1128 return bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1129 plugin_paths
, true);
1133 struct bt_config
*bt_config_help_create(const bt_value
*plugin_paths
,
1134 int default_log_level
)
1136 struct bt_config
*cfg
;
1139 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1140 plugin_paths
, true);
1145 cfg
->cmd_data
.help
.cfg_component
=
1146 bt_config_component_create(-1, NULL
, NULL
, default_log_level
);
1147 if (!cfg
->cmd_data
.help
.cfg_component
) {
1154 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1161 struct bt_config
*bt_config_query_create(const bt_value
*plugin_paths
)
1163 struct bt_config
*cfg
;
1166 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1167 plugin_paths
, true);
1172 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1173 if (!cfg
->cmd_data
.query
.object
) {
1174 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1181 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1188 struct bt_config
*bt_config_print_ctf_metadata_create(
1189 const bt_value
*plugin_paths
)
1191 struct bt_config
*cfg
;
1194 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1195 plugin_paths
, true);
1200 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1201 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1202 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1206 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1207 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1208 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1215 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1222 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1223 const bt_value
*plugin_paths
)
1225 struct bt_config
*cfg
;
1228 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1229 plugin_paths
, true);
1234 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1235 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1236 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1240 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1242 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1243 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1250 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1257 int bt_config_append_plugin_paths_check_setuid_setgid(
1258 bt_value
*plugin_paths
, const char *arg
)
1262 if (bt_common_is_setuid_setgid()) {
1263 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1267 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1268 BT_CLI_LOGE_APPEND_CAUSE("Invalid --plugin-path option's argument:\n %s",
1279 * Prints the expected format for a --params option.
1282 void print_expected_params_format(FILE *fp
)
1284 fprintf(fp
, "Expected format of PARAMS\n");
1285 fprintf(fp
, "-------------------------\n");
1287 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1289 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1290 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1291 fprintf(fp
, "and VALUE can be one of:\n");
1293 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1294 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1295 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1296 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1297 fprintf(fp
, " (`0x` prefix) unsigned (with `+` prefix) or signed 64-bit integer.\n");
1298 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1299 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1300 fprintf(fp
, " the null and boolean value symbols above.\n");
1301 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1302 fprintf(fp
, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
1303 fprintf(fp
, " (as described by the current list) and a closing `]`.\n");
1305 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1307 fprintf(fp
, "Example:\n");
1309 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1310 fprintf(fp
, " play=+23, observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1311 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\",\n");
1312 fprintf(fp
, " things=[1, \"2\", 3]\n");
1314 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1315 fprintf(fp
, "babeltrace2 from a shell.\n");
1319 bool help_option_is_specified(
1320 const struct bt_argpar_parse_ret
*argpar_parse_ret
)
1323 bool specified
= false;
1325 for (i
= 0; i
< argpar_parse_ret
->items
->len
; i
++) {
1326 struct bt_argpar_item
*argpar_item
=
1327 g_ptr_array_index(argpar_parse_ret
->items
, i
);
1328 struct bt_argpar_item_opt
*argpar_item_opt
;
1330 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
1334 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1335 if (argpar_item_opt
->descr
->id
== OPT_HELP
) {
1345 * Prints the help command usage.
1348 void print_help_usage(FILE *fp
)
1350 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1351 fprintf(fp
, " babeltrace2 [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1353 fprintf(fp
, "Options:\n");
1355 fprintf(fp
, " -h, --help Show this help and quit\n");
1357 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1359 fprintf(fp
, "Use `babeltrace2 list-plugins` to show the list of available plugins.\n");
1363 const struct bt_argpar_opt_descr help_options
[] = {
1364 /* id, short_name, long_name, with_arg */
1365 { OPT_HELP
, 'h', "help", false },
1366 BT_ARGPAR_OPT_DESCR_SENTINEL
1370 * Creates a Babeltrace config object from the arguments of a help
1373 * *retcode is set to the appropriate exit code to use.
1376 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
1377 int *retcode
, const bt_value
*plugin_paths
,
1378 int default_log_level
)
1380 struct bt_config
*cfg
= NULL
;
1381 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1382 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1383 struct bt_argpar_item_non_opt
*non_opt
;
1386 cfg
= bt_config_help_create(plugin_paths
, default_log_level
);
1392 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, help_options
, true);
1393 if (argpar_parse_ret
.error
) {
1394 BT_CLI_LOGE_APPEND_CAUSE(
1395 "While parsing `help` command's command-line arguments: %s",
1396 argpar_parse_ret
.error
->str
);
1400 if (help_option_is_specified(&argpar_parse_ret
)) {
1401 print_help_usage(stdout
);
1403 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1407 if (argpar_parse_ret
.items
->len
== 0) {
1408 BT_CLI_LOGE_APPEND_CAUSE(
1409 "Missing plugin name or component class descriptor.");
1411 } else if (argpar_parse_ret
.items
->len
> 1) {
1413 * At this point we know there are least two non-option
1414 * arguments because we don't reach here with `--help`,
1417 non_opt
= argpar_parse_ret
.items
->pdata
[1];
1418 BT_CLI_LOGE_APPEND_CAUSE(
1419 "Extraneous command-line argument specified to `help` command: `%s`.",
1424 non_opt
= argpar_parse_ret
.items
->pdata
[0];
1425 plugin_comp_cls_names(non_opt
->arg
, NULL
, &plugin_name
, &comp_cls_name
,
1426 &cfg
->cmd_data
.help
.cfg_component
->type
);
1427 if (plugin_name
&& comp_cls_name
) {
1428 /* Component class help */
1429 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1431 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1434 /* Fall back to plugin help */
1435 g_string_assign(cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1443 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1446 g_free(plugin_name
);
1447 g_free(comp_cls_name
);
1449 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1455 * Prints the help command usage.
1458 void print_query_usage(FILE *fp
)
1460 fprintf(fp
, "Usage: babeltrace2 [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1462 fprintf(fp
, "Options:\n");
1464 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS (see the expected\n");
1465 fprintf(fp
, " format of PARAMS below)\n");
1466 fprintf(fp
, " -h, --help Show this help and quit\n");
1467 fprintf(fp
, "\n\n");
1468 print_expected_params_format(fp
);
1472 const struct bt_argpar_opt_descr query_options
[] = {
1473 /* id, short_name, long_name, with_arg */
1474 { OPT_HELP
, 'h', "help", false },
1475 { OPT_PARAMS
, 'p', "params", true },
1476 BT_ARGPAR_OPT_DESCR_SENTINEL
1480 * Creates a Babeltrace config object from the arguments of a query
1483 * *retcode is set to the appropriate exit code to use.
1486 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1487 int *retcode
, const bt_value
*plugin_paths
,
1488 int default_log_level
)
1491 struct bt_config
*cfg
= NULL
;
1492 const char *component_class_spec
= NULL
;
1493 const char *query_object
= NULL
;
1495 GString
*error_str
= NULL
;
1496 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1498 params
= bt_value_null
;
1499 bt_value_get_ref(bt_value_null
);
1502 cfg
= bt_config_query_create(plugin_paths
);
1507 error_str
= g_string_new(NULL
);
1509 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1514 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, query_options
, true);
1515 if (argpar_parse_ret
.error
) {
1516 BT_CLI_LOGE_APPEND_CAUSE(
1517 "While parsing `query` command's command-line arguments: %s",
1518 argpar_parse_ret
.error
->str
);
1522 if (help_option_is_specified(&argpar_parse_ret
)) {
1523 print_query_usage(stdout
);
1525 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1529 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1530 struct bt_argpar_item
*argpar_item
=
1531 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1533 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
1534 struct bt_argpar_item_opt
*argpar_item_opt
=
1535 (struct bt_argpar_item_opt
*) argpar_item
;
1536 const char *arg
= argpar_item_opt
->arg
;
1538 switch (argpar_item_opt
->descr
->id
) {
1541 bt_value_put_ref(params
);
1542 params
= cli_value_from_arg(arg
, error_str
);
1544 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1551 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1552 argpar_item_opt
->descr
->id
);
1556 struct bt_argpar_item_non_opt
*argpar_item_non_opt
1557 = (struct bt_argpar_item_non_opt
*) argpar_item
;
1560 * We need exactly two non-option arguments
1561 * which are the mandatory component class
1562 * specification and query object.
1564 if (!component_class_spec
) {
1565 component_class_spec
= argpar_item_non_opt
->arg
;
1566 } else if (!query_object
) {
1567 query_object
= argpar_item_non_opt
->arg
;
1569 BT_CLI_LOGE_APPEND_CAUSE("Extraneous command-line argument specified to `query` command: `%s`.",
1570 argpar_item_non_opt
->arg
);
1576 if (!component_class_spec
|| !query_object
) {
1577 print_query_usage(stdout
);
1579 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1583 cfg
->cmd_data
.query
.cfg_component
=
1584 bt_config_component_from_arg(component_class_spec
,
1586 if (!cfg
->cmd_data
.query
.cfg_component
) {
1587 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1588 component_class_spec
);
1593 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
1595 if (strlen(query_object
) == 0) {
1596 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1600 g_string_assign(cfg
->cmd_data
.query
.object
, query_object
);
1605 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1608 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1611 g_string_free(error_str
, TRUE
);
1614 bt_value_put_ref(params
);
1619 * Prints the list-plugins command usage.
1622 void print_list_plugins_usage(FILE *fp
)
1624 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1626 fprintf(fp
, "Options:\n");
1628 fprintf(fp
, " -h, --help Show this help and quit\n");
1630 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1632 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1636 const struct bt_argpar_opt_descr list_plugins_options
[] = {
1637 /* id, short_name, long_name, with_arg */
1638 { OPT_HELP
, 'h', "help", false },
1639 BT_ARGPAR_OPT_DESCR_SENTINEL
1643 * Creates a Babeltrace config object from the arguments of a
1644 * list-plugins command.
1646 * *retcode is set to the appropriate exit code to use.
1649 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
1650 int *retcode
, const bt_value
*plugin_paths
)
1652 struct bt_config
*cfg
= NULL
;
1653 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1656 cfg
= bt_config_list_plugins_create(plugin_paths
);
1662 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, list_plugins_options
, true);
1663 if (argpar_parse_ret
.error
) {
1664 BT_CLI_LOGE_APPEND_CAUSE(
1665 "While parsing `list-plugins` command's command-line arguments: %s",
1666 argpar_parse_ret
.error
->str
);
1670 if (help_option_is_specified(&argpar_parse_ret
)) {
1671 print_list_plugins_usage(stdout
);
1673 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1677 if (argpar_parse_ret
.items
->len
> 0) {
1679 * At this point we know there's at least one non-option
1680 * argument because we don't reach here with `--help`,
1683 struct bt_argpar_item_non_opt
*non_opt
=
1684 argpar_parse_ret
.items
->pdata
[0];
1686 BT_CLI_LOGE_APPEND_CAUSE(
1687 "Extraneous command-line argument specified to `list-plugins` command: `%s`.",
1696 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1699 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
1705 * Prints the run command usage.
1708 void print_run_usage(FILE *fp
)
1710 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1712 fprintf(fp
, "Options:\n");
1714 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1715 fprintf(fp
, " for all the following components until\n");
1716 fprintf(fp
, " --reset-base-params is encountered\n");
1717 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1718 fprintf(fp
, " -c, --component=NAME:TYPE.PLUGIN.CLS\n");
1719 fprintf(fp
, " Instantiate the component class CLS of type\n");
1720 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1721 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1722 fprintf(fp
, " and name it NAME");
1723 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1724 fprintf(fp
, " expected format of CONNECTION below)\n");
1725 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1726 fprintf(fp
, " (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
1727 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1728 fprintf(fp
, " current component (see the expected format\n");
1729 fprintf(fp
, " of PARAMS below)\n");
1730 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1731 fprintf(fp
, " empty map\n");
1732 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1733 fprintf(fp
, " the graph later, retry in DUR µs\n");
1734 fprintf(fp
, " (default: 100000)\n");
1735 fprintf(fp
, " -h, --help Show this help and quit\n");
1737 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1738 fprintf(fp
, "\n\n");
1739 fprintf(fp
, "Expected format of CONNECTION\n");
1740 fprintf(fp
, "-----------------------------\n");
1742 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1744 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1745 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1746 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You must set the name of the current\n");
1747 fprintf(fp
, "component using the NAME prefix of the --component option.\n");
1749 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1750 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1751 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1753 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1754 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1755 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1756 fprintf(fp
, "DOWNSTREAM.\n");
1758 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1759 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1760 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1762 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1763 fprintf(fp
, "can connect a filter component to a sink component.\n");
1765 fprintf(fp
, "Examples:\n");
1767 fprintf(fp
, " my-src:my-sink\n");
1768 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1770 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1771 fprintf(fp
, "babeltrace2 from a shell.\n");
1772 fprintf(fp
, "\n\n");
1773 print_expected_params_format(fp
);
1777 * Creates a Babeltrace config object from the arguments of a run
1780 * *retcode is set to the appropriate exit code to use.
1783 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
1784 int *retcode
, const bt_value
*plugin_paths
,
1785 int default_log_level
)
1787 struct bt_config_component
*cur_cfg_comp
= NULL
;
1788 bt_value
*cur_base_params
= NULL
;
1790 struct bt_config
*cfg
= NULL
;
1791 bt_value
*instance_names
= NULL
;
1792 bt_value
*connection_args
= NULL
;
1793 char error_buf
[256] = { 0 };
1794 long retry_duration
= -1;
1795 bt_value_map_extend_status extend_status
;
1796 GString
*error_str
= NULL
;
1797 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
1800 static const struct bt_argpar_opt_descr run_options
[] = {
1801 { OPT_BASE_PARAMS
, 'b', "base-params", true },
1802 { OPT_COMPONENT
, 'c', "component", true },
1803 { OPT_CONNECT
, 'x', "connect", true },
1804 { OPT_HELP
, 'h', "help", false },
1805 { OPT_LOG_LEVEL
, 'l', "log-level", true },
1806 { OPT_PARAMS
, 'p', "params", true },
1807 { OPT_RESET_BASE_PARAMS
, 'r', "reset-base-params", false },
1808 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
1809 BT_ARGPAR_OPT_DESCR_SENTINEL
1814 error_str
= g_string_new(NULL
);
1816 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1821 print_run_usage(stdout
);
1826 cfg
= bt_config_run_create(plugin_paths
);
1831 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1832 cur_base_params
= bt_value_map_create();
1833 if (!cur_base_params
) {
1834 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1838 instance_names
= bt_value_map_create();
1839 if (!instance_names
) {
1840 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1844 connection_args
= bt_value_array_create();
1845 if (!connection_args
) {
1846 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1851 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, run_options
, true);
1852 if (argpar_parse_ret
.error
) {
1853 BT_CLI_LOGE_APPEND_CAUSE(
1854 "While parsing `run` command's command-line arguments: %s",
1855 argpar_parse_ret
.error
->str
);
1859 if (help_option_is_specified(&argpar_parse_ret
)) {
1860 print_run_usage(stdout
);
1862 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1866 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
1867 struct bt_argpar_item
*argpar_item
=
1868 g_ptr_array_index(argpar_parse_ret
.items
, i
);
1869 struct bt_argpar_item_opt
*argpar_item_opt
;
1872 /* This command does not accept non-option arguments.*/
1873 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
1874 struct bt_argpar_item_non_opt
*argpar_nonopt_item
=
1875 (struct bt_argpar_item_non_opt
*) argpar_item
;
1877 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`",
1878 argpar_nonopt_item
->arg
);
1882 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
1883 arg
= argpar_item_opt
->arg
;
1885 switch (argpar_item_opt
->descr
->id
) {
1888 enum bt_config_component_dest dest
;
1890 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
1891 cur_cfg_comp
= bt_config_component_from_arg(arg
,
1893 if (!cur_cfg_comp
) {
1894 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
1899 switch (cur_cfg_comp
->type
) {
1900 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1901 dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
1903 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1904 dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
1906 case BT_COMPONENT_CLASS_TYPE_SINK
:
1907 dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
1913 BT_ASSERT(cur_base_params
);
1914 bt_value_put_ref(cur_cfg_comp
->params
);
1915 if (bt_value_copy(cur_base_params
,
1916 &cur_cfg_comp
->params
) < 0) {
1917 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1921 ret
= add_run_cfg_comp_check_name(cfg
,
1933 bt_value
*params_to_set
;
1935 if (!cur_cfg_comp
) {
1936 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
1941 params
= cli_value_from_arg(arg
, error_str
);
1943 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1948 extend_status
= bt_value_map_extend(
1949 cur_cfg_comp
->params
, params
, ¶ms_to_set
);
1950 BT_VALUE_PUT_REF_AND_RESET(params
);
1951 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
1952 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
1957 BT_OBJECT_MOVE_REF(cur_cfg_comp
->params
, params_to_set
);
1961 if (!cur_cfg_comp
) {
1962 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
1967 cur_cfg_comp
->log_level
=
1968 bt_log_get_level_from_string(arg
);
1969 if (cur_cfg_comp
->log_level
< 0) {
1970 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
1975 case OPT_BASE_PARAMS
:
1977 bt_value
*params
= cli_value_from_arg(arg
, error_str
);
1980 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
1985 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
1988 case OPT_RESET_BASE_PARAMS
:
1989 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
1990 cur_base_params
= bt_value_map_create();
1991 if (!cur_base_params
) {
1992 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1997 if (bt_value_array_append_string_element(
1998 connection_args
, arg
)) {
1999 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2003 case OPT_RETRY_DURATION
: {
2005 size_t arg_len
= strlen(argpar_item_opt
->arg
);
2007 retry_duration
= g_ascii_strtoll(argpar_item_opt
->arg
, &end
, 10);
2009 if (arg_len
== 0 || end
!= (argpar_item_opt
->arg
+ arg_len
)) {
2010 BT_CLI_LOGE_APPEND_CAUSE(
2011 "Could not parse --retry-duration option's argument as an unsigned integer: `%s`",
2012 argpar_item_opt
->arg
);
2016 if (retry_duration
< 0) {
2017 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2022 cfg
->cmd_data
.run
.retry_duration_us
=
2023 (uint64_t) retry_duration
;
2027 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
2028 argpar_item_opt
->descr
->id
);
2033 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2035 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2036 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2040 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2041 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2045 ret
= bt_config_cli_args_create_connections(cfg
,
2049 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2057 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2061 g_string_free(error_str
, TRUE
);
2064 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
2065 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2066 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2067 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2068 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2073 struct bt_config
*bt_config_run_from_args_array(const bt_value
*run_args
,
2074 int *retcode
, const bt_value
*plugin_paths
,
2075 int default_log_level
)
2077 struct bt_config
*cfg
= NULL
;
2080 const size_t argc
= bt_value_array_get_length(run_args
);
2082 argv
= calloc(argc
, sizeof(*argv
));
2084 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2088 len
= bt_value_array_get_length(run_args
);
2090 BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
2093 for (i
= 0; i
< len
; i
++) {
2094 const bt_value
*arg_value
=
2095 bt_value_array_borrow_element_by_index_const(run_args
,
2099 BT_ASSERT(arg_value
);
2100 arg
= bt_value_string_get(arg_value
);
2105 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2106 plugin_paths
, default_log_level
);
2114 * Prints the convert command usage.
2117 void print_convert_usage(FILE *fp
)
2119 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2121 fprintf(fp
, "Options:\n");
2123 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2124 fprintf(fp
, " Instantiate the component class CLS of type\n");
2125 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2126 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2127 fprintf(fp
, " conversion graph, and optionally name it\n");
2128 fprintf(fp
, " NAME\n");
2129 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2130 fprintf(fp
, " (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
2131 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2132 fprintf(fp
, " current component (see the expected format\n");
2133 fprintf(fp
, " of PARAMS below)\n");
2134 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2135 fprintf(fp
, " the graph later, retry in DUR µs\n");
2136 fprintf(fp
, " (default: 100000)\n");
2137 fprintf(fp
, " dynamic plugins can be loaded\n");
2138 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2139 fprintf(fp
, " `run` command to the standard output,\n");
2140 fprintf(fp
, " formatted for a shell, and quit\n");
2141 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2142 fprintf(fp
, " `run` command to the standard output,\n");
2143 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2144 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2145 fprintf(fp
, " are active\n");
2146 fprintf(fp
, " -h, --help Show this help and quit\n");
2148 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2150 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2151 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2153 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2155 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2156 fprintf(fp
, " --clock-date Print timestamp dates\n");
2157 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2158 fprintf(fp
, " time zone instead of the local time zone\n");
2159 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2160 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2161 fprintf(fp
, " --color=(never | auto | always)\n");
2162 fprintf(fp
, " Never, automatically, or always emit\n");
2163 fprintf(fp
, " console color codes\n");
2164 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2165 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2166 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2167 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2168 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2169 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2170 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2171 fprintf(fp
, " (or `ctx`)\n");
2172 fprintf(fp
, " --no-delta Do not print time delta between\n");
2173 fprintf(fp
, " consecutive events\n");
2174 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2175 fprintf(fp
, " the standard output\n");
2177 fprintf(fp
, "Implicit `filter.utils.muxer` component options:\n");
2179 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently\n");
2180 fprintf(fp
, " correlated across traces\n");
2182 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2184 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2185 fprintf(fp
, " time range to BEGIN (see the format of\n");
2186 fprintf(fp
, " BEGIN below)\n");
2187 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2188 fprintf(fp
, " range to END (see the format of END below)\n");
2189 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2190 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2191 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2193 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2195 fprintf(fp
, " --debug-info Create an implicit\n");
2196 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2197 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2198 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2199 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2200 fprintf(fp
, " binary paths instead of just names\n");
2201 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2202 fprintf(fp
, " Use directory DIR as a prefix when\n");
2203 fprintf(fp
, " looking up executables during debug\n");
2204 fprintf(fp
, " info analysis\n");
2206 fprintf(fp
, "Legacy options that still work:\n");
2208 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2209 fprintf(fp
, " `ctf`:\n");
2210 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2211 fprintf(fp
, " component\n");
2212 fprintf(fp
, " `lttng-live`:\n");
2213 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2214 fprintf(fp
, " component\n");
2215 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2216 fprintf(fp
, " `text`:\n");
2217 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2218 fprintf(fp
, " component\n");
2219 fprintf(fp
, " `ctf`:\n");
2220 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2221 fprintf(fp
, " component\n");
2222 fprintf(fp
, " `dummy`:\n");
2223 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2224 fprintf(fp
, " component\n");
2225 fprintf(fp
, " `ctf-metadata`:\n");
2226 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2227 fprintf(fp
, " for metadata text and quit\n");
2229 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2230 fprintf(fp
, "\n\n");
2231 fprintf(fp
, "Format of BEGIN and END\n");
2232 fprintf(fp
, "-----------------------\n");
2234 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2235 fprintf(fp
, "\n\n");
2236 print_expected_params_format(fp
);
2240 const struct bt_argpar_opt_descr convert_options
[] = {
2241 /* id, short_name, long_name, with_arg */
2242 { OPT_BEGIN
, 'b', "begin", true },
2243 { OPT_CLOCK_CYCLES
, '\0', "clock-cycles", false },
2244 { OPT_CLOCK_DATE
, '\0', "clock-date", false },
2245 { OPT_CLOCK_FORCE_CORRELATE
, '\0', "clock-force-correlate", false },
2246 { OPT_CLOCK_GMT
, '\0', "clock-gmt", false },
2247 { OPT_CLOCK_OFFSET
, '\0', "clock-offset", true },
2248 { OPT_CLOCK_OFFSET_NS
, '\0', "clock-offset-ns", true },
2249 { OPT_CLOCK_SECONDS
, '\0', "clock-seconds", false },
2250 { OPT_COLOR
, '\0', "color", true },
2251 { OPT_COMPONENT
, 'c', "component", true },
2252 { OPT_DEBUG
, 'd', "debug", false },
2253 { OPT_DEBUG_INFO_DIR
, '\0', "debug-info-dir", true },
2254 { OPT_DEBUG_INFO_FULL_PATH
, '\0', "debug-info-full-path", false },
2255 { OPT_DEBUG_INFO_TARGET_PREFIX
, '\0', "debug-info-target-prefix", true },
2256 { OPT_END
, 'e', "end", true },
2257 { OPT_FIELDS
, 'f', "fields", true },
2258 { OPT_HELP
, 'h', "help", false },
2259 { OPT_INPUT_FORMAT
, 'i', "input-format", true },
2260 { OPT_LOG_LEVEL
, 'l', "log-level", true },
2261 { OPT_NAMES
, 'n', "names", true },
2262 { OPT_DEBUG_INFO
, '\0', "debug-info", false },
2263 { OPT_NO_DELTA
, '\0', "no-delta", false },
2264 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
2265 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
2266 { OPT_OUTPUT
, 'w', "output", true },
2267 { OPT_OUTPUT_FORMAT
, 'o', "output-format", true },
2268 { OPT_PARAMS
, 'p', "params", true },
2269 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
2270 { OPT_RETRY_DURATION
, '\0', "retry-duration", true },
2271 { OPT_RUN_ARGS
, '\0', "run-args", false },
2272 { OPT_RUN_ARGS_0
, '\0', "run-args-0", false },
2273 { OPT_STREAM_INTERSECTION
, '\0', "stream-intersection", false },
2274 { OPT_TIMERANGE
, '\0', "timerange", true },
2275 { OPT_VERBOSE
, 'v', "verbose", false },
2276 BT_ARGPAR_OPT_DESCR_SENTINEL
2280 GString
*get_component_auto_name(const char *prefix
,
2281 const bt_value
*existing_names
)
2284 GString
*auto_name
= g_string_new(NULL
);
2287 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2291 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2292 g_string_assign(auto_name
, prefix
);
2297 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2299 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2305 struct implicit_component_args
{
2308 /* The component class name (e.g. src.ctf.fs). */
2311 /* The component instance name. */
2314 GString
*params_arg
;
2315 bt_value
*extra_params
;
2319 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2320 const char *prefix
, bt_value
*existing_names
,
2321 GList
**comp_names
, bool append_to_comp_names
)
2324 GString
*name
= NULL
;
2326 if (!args
->exists
) {
2330 name
= get_component_auto_name(prefix
,
2338 g_string_assign(args
->name_arg
, name
->str
);
2340 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2342 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2347 if (append_to_comp_names
) {
2348 *comp_names
= g_list_append(*comp_names
, name
);
2354 g_string_free(name
, TRUE
);
2361 int append_run_args_for_implicit_component(
2362 struct implicit_component_args
*impl_args
,
2367 GString
*component_arg_for_run
= NULL
;
2369 if (!impl_args
->exists
) {
2373 component_arg_for_run
= g_string_new(NULL
);
2374 if (!component_arg_for_run
) {
2375 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2379 /* Build the full `name:type.plugin.cls`. */
2380 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, '\\'));
2381 BT_ASSERT(!strchr(impl_args
->name_arg
->str
, ':'));
2382 g_string_printf(component_arg_for_run
, "%s:%s",
2383 impl_args
->name_arg
->str
, impl_args
->comp_arg
->str
);
2385 if (bt_value_array_append_string_element(run_args
, "--component")) {
2386 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2390 if (bt_value_array_append_string_element(run_args
,
2391 component_arg_for_run
->str
)) {
2392 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2396 if (impl_args
->params_arg
->len
> 0) {
2397 if (bt_value_array_append_string_element(run_args
, "--params")) {
2398 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2402 if (bt_value_array_append_string_element(run_args
,
2403 impl_args
->params_arg
->str
)) {
2404 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2409 for (i
= 0; i
< bt_value_array_get_length(impl_args
->extra_params
);
2411 const bt_value
*elem
;
2414 elem
= bt_value_array_borrow_element_by_index(impl_args
->extra_params
,
2420 BT_ASSERT(bt_value_is_string(elem
));
2421 arg
= bt_value_string_get(elem
);
2422 ret
= bt_value_array_append_string_element(run_args
, arg
);
2424 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2435 if (component_arg_for_run
) {
2436 g_string_free(component_arg_for_run
, TRUE
);
2442 /* Free the fields of a `struct implicit_component_args`. */
2445 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2449 if (args
->comp_arg
) {
2450 g_string_free(args
->comp_arg
, TRUE
);
2453 if (args
->name_arg
) {
2454 g_string_free(args
->name_arg
, TRUE
);
2457 if (args
->params_arg
) {
2458 g_string_free(args
->params_arg
, TRUE
);
2461 bt_value_put_ref(args
->extra_params
);
2464 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2467 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2469 finalize_implicit_component_args(args
);
2473 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2476 int init_implicit_component_args(struct implicit_component_args
*args
,
2477 const char *comp_arg
, bool exists
)
2481 args
->exists
= exists
;
2482 args
->comp_arg
= g_string_new(comp_arg
);
2483 args
->name_arg
= g_string_new(NULL
);
2484 args
->params_arg
= g_string_new(NULL
);
2485 args
->extra_params
= bt_value_array_create();
2487 if (!args
->comp_arg
|| !args
->name_arg
||
2488 !args
->params_arg
|| !args
->extra_params
) {
2490 finalize_implicit_component_args(args
);
2491 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2499 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2502 struct implicit_component_args
*create_implicit_component_args(
2503 const char *comp_arg
)
2505 struct implicit_component_args
*args
;
2508 args
= g_new(struct implicit_component_args
, 1);
2510 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2514 status
= init_implicit_component_args(args
, comp_arg
, true);
2525 void append_implicit_component_param(struct implicit_component_args
*args
,
2526 const char *key
, const char *value
)
2531 append_param_arg(args
->params_arg
, key
, value
);
2535 * Append the given parameter (`key=value`) to all component specifications
2536 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2537 * which match `comp_arg`.
2539 * Return the number of matching components.
2543 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2544 const char *comp_arg
, const char *key
, const char *value
)
2549 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2550 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2552 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2553 append_implicit_component_param(args
, key
, value
);
2561 /* Escape value to make it suitable to use as a string parameter value. */
2563 gchar
*escape_string_value(const char *value
)
2568 ret
= g_string_new(NULL
);
2570 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2579 g_string_append_c(ret
, '\\');
2583 g_string_append_c(ret
, *in
);
2589 return g_string_free(ret
, FALSE
);
2593 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2599 switch (bt_value_get_type(value
)) {
2600 case BT_VALUE_TYPE_STRING
:
2602 const char *str_value
= bt_value_string_get(value
);
2603 gchar
*escaped_str_value
;
2605 escaped_str_value
= escape_string_value(str_value
);
2606 if (!escaped_str_value
) {
2610 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2612 g_free(escaped_str_value
);
2615 case BT_VALUE_TYPE_ARRAY
: {
2616 g_string_append_c(buf
, '[');
2617 uint64_t sz
= bt_value_array_get_length(value
);
2618 for (uint64_t i
= 0; i
< sz
; i
++) {
2619 const bt_value
*item
;
2623 g_string_append(buf
, ", ");
2626 item
= bt_value_array_borrow_element_by_index_const(
2628 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2634 g_string_append_c(buf
, ']');
2648 * Convert `value` to its equivalent representation as a command line parameter
2653 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2656 gchar
*result
= NULL
;
2658 buf
= g_string_new(NULL
);
2660 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2664 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2668 result
= g_string_free(buf
, FALSE
);
2675 g_string_free(buf
, TRUE
);
2683 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2686 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2691 gchar
*str_value
= NULL
;
2692 GString
*parameter
= NULL
;
2694 if (bt_value_array_append_string_element(args
, "--params")) {
2695 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2700 str_value
= bt_value_to_cli_param_value(value
);
2706 parameter
= g_string_new(NULL
);
2708 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2713 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2715 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2716 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2723 g_string_free(parameter
, TRUE
);
2736 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2738 bt_value
*str_value
;
2741 str_value
= bt_value_string_create_init(value
);
2744 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2749 ret
= append_parameter_to_args(args
, key
, str_value
);
2752 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2757 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2758 const char *key
, const char *value
)
2760 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2764 * Escapes `.`, `:`, and `\` of `input` with `\`.
2767 GString
*escape_dot_colon(const char *input
)
2769 GString
*output
= g_string_new(NULL
);
2773 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2777 for (ch
= input
; *ch
!= '\0'; ch
++) {
2778 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
2779 g_string_append_c(output
, '\\');
2782 g_string_append_c(output
, *ch
);
2790 * Appends a --connect option to a list of arguments. `upstream_name`
2791 * and `downstream_name` are escaped with escape_dot_colon() in this
2795 int append_connect_arg(bt_value
*run_args
,
2796 const char *upstream_name
, const char *downstream_name
)
2799 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
2800 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
2801 GString
*arg
= g_string_new(NULL
);
2803 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
2804 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2809 ret
= bt_value_array_append_string_element(run_args
, "--connect");
2811 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2816 g_string_append(arg
, e_upstream_name
->str
);
2817 g_string_append_c(arg
, ':');
2818 g_string_append(arg
, e_downstream_name
->str
);
2819 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
2821 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2828 g_string_free(arg
, TRUE
);
2831 if (e_upstream_name
) {
2832 g_string_free(e_upstream_name
, TRUE
);
2835 if (e_downstream_name
) {
2836 g_string_free(e_downstream_name
, TRUE
);
2843 * Appends the run command's --connect options for the convert command.
2846 int convert_auto_connect(bt_value
*run_args
,
2847 GList
*source_names
, GList
*filter_names
,
2851 GList
*source_at
= source_names
;
2852 GList
*filter_at
= filter_names
;
2854 GList
*sink_at
= sink_names
;
2856 BT_ASSERT(source_names
);
2857 BT_ASSERT(filter_names
);
2858 BT_ASSERT(sink_names
);
2860 /* Connect all sources to the first filter */
2861 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
2862 GString
*source_name
= source_at
->data
;
2863 GString
*filter_name
= filter_at
->data
;
2865 ret
= append_connect_arg(run_args
, source_name
->str
,
2872 filter_prev
= filter_at
;
2873 filter_at
= g_list_next(filter_at
);
2875 /* Connect remaining filters */
2876 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
2877 GString
*filter_name
= filter_at
->data
;
2878 GString
*filter_prev_name
= filter_prev
->data
;
2880 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
2887 /* Connect last filter to all sinks */
2888 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
2889 GString
*filter_name
= filter_prev
->data
;
2890 GString
*sink_name
= sink_at
->data
;
2892 ret
= append_connect_arg(run_args
, filter_name
->str
,
2909 int split_timerange(const char *arg
, char **begin
, char **end
)
2912 const char *ch
= arg
;
2914 GString
*g_begin
= NULL
;
2915 GString
*g_end
= NULL
;
2923 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
2924 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
2930 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
2931 if (!g_end
|| g_end
->len
== 0) {
2937 *begin
= g_begin
->str
;
2939 g_string_free(g_begin
, FALSE
);
2940 g_string_free(g_end
, FALSE
);
2950 g_string_free(g_begin
, TRUE
);
2954 g_string_free(g_end
, TRUE
);
2961 int g_list_prepend_gstring(GList
**list
, const char *string
)
2964 GString
*gs
= g_string_new(string
);
2969 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2973 *list
= g_list_prepend(*list
, gs
);
2980 * Create `struct implicit_component_args` structures for each of the
2981 * source components we identified. Add them to `component_args`.
2983 * `non_opt_params` is an array where each element is an array of
2984 * strings containing all the arguments to `--params` that apply to the
2985 * non-option argument at the same index. For example, if, for a
2986 * non-option argument, the following `--params` options applied:
2988 * --params=a=2 --params=b=3,c=4
2990 * its entry in `non_opt_params` would contain
2992 * ["a=2", "b=3,c=4"]
2996 int create_implicit_component_args_from_auto_discovered_sources(
2997 const struct auto_source_discovery
*auto_disc
,
2998 const bt_value
*non_opt_params
,
2999 const bt_value
*non_opt_loglevels
,
3000 GPtrArray
*component_args
)
3002 gchar
*cc_name
= NULL
;
3003 struct implicit_component_args
*comp
= NULL
;
3007 len
= auto_disc
->results
->len
;
3009 for (i
= 0; i
< len
; i
++) {
3010 struct auto_source_discovery_result
*res
=
3011 g_ptr_array_index(auto_disc
->results
, i
);
3012 uint64_t orig_indices_i
, orig_indices_count
;
3015 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3017 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3021 comp
= create_implicit_component_args(cc_name
);
3027 * Append parameters and log levels of all the
3028 * non-option arguments that contributed to this
3029 * component instance coming into existence.
3031 orig_indices_count
= bt_value_array_get_length(res
->original_input_indices
);
3032 for (orig_indices_i
= 0; orig_indices_i
< orig_indices_count
; orig_indices_i
++) {
3033 const bt_value
*orig_idx_value
=
3034 bt_value_array_borrow_element_by_index(
3035 res
->original_input_indices
, orig_indices_i
);
3036 uint64_t orig_idx
= bt_value_integer_unsigned_get(orig_idx_value
);
3037 const bt_value
*params_array
=
3038 bt_value_array_borrow_element_by_index_const(
3039 non_opt_params
, orig_idx
);
3040 uint64_t params_i
, params_count
;
3041 const bt_value
*loglevel_value
;
3043 params_count
= bt_value_array_get_length(params_array
);
3044 for (params_i
= 0; params_i
< params_count
; params_i
++) {
3045 const bt_value
*params_value
=
3046 bt_value_array_borrow_element_by_index_const(
3047 params_array
, params_i
);
3048 const char *params
= bt_value_string_get(params_value
);
3049 bt_value_array_append_element_status append_status
;
3051 append_status
= bt_value_array_append_string_element(
3052 comp
->extra_params
, "--params");
3053 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3054 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3058 append_status
= bt_value_array_append_string_element(
3059 comp
->extra_params
, params
);
3060 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3061 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3066 loglevel_value
= bt_value_array_borrow_element_by_index_const(
3067 non_opt_loglevels
, orig_idx
);
3068 if (bt_value_get_type(loglevel_value
) == BT_VALUE_TYPE_STRING
) {
3069 const char *loglevel
= bt_value_string_get(loglevel_value
);
3070 bt_value_array_append_element_status append_status
;
3072 append_status
= bt_value_array_append_string_element(
3073 comp
->extra_params
, "--log-level");
3074 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3075 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3079 append_status
= bt_value_array_append_string_element(
3080 comp
->extra_params
, loglevel
);
3081 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3082 BT_CLI_LOGE_APPEND_CAUSE("Failed to append array element.");
3088 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3093 g_ptr_array_add(component_args
, comp
);
3107 destroy_implicit_component_args(comp
);
3114 * As we iterate the arguments to the convert command, this tracks what is the
3115 * type of the current item, to which some contextual options (e.g. --params)
3118 enum convert_current_item_type
{
3119 /* There is no current item. */
3120 CONVERT_CURRENT_ITEM_TYPE_NONE
,
3122 /* Current item is a component. */
3123 CONVERT_CURRENT_ITEM_TYPE_COMPONENT
,
3125 /* Current item is a non-option argument. */
3126 CONVERT_CURRENT_ITEM_TYPE_NON_OPT
,
3130 * Creates a Babeltrace config object from the arguments of a convert
3133 * *retcode is set to the appropriate exit code to use.
3136 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3137 int *retcode
, const bt_value
*plugin_paths
,
3138 int *default_log_level
)
3140 enum convert_current_item_type current_item_type
=
3141 CONVERT_CURRENT_ITEM_TYPE_NONE
;
3143 struct bt_config
*cfg
= NULL
;
3144 bool got_input_format_opt
= false;
3145 bool got_output_format_opt
= false;
3146 bool trimmer_has_begin
= false;
3147 bool trimmer_has_end
= false;
3148 bool stream_intersection_mode
= false;
3149 bool print_run_args
= false;
3150 bool print_run_args_0
= false;
3151 bool print_ctf_metadata
= false;
3152 bt_value
*run_args
= NULL
;
3153 bt_value
*all_names
= NULL
;
3154 GList
*source_names
= NULL
;
3155 GList
*filter_names
= NULL
;
3156 GList
*sink_names
= NULL
;
3157 bt_value
*non_opts
= NULL
;
3158 bt_value
*non_opt_params
= NULL
;
3159 bt_value
*non_opt_loglevels
= NULL
;
3160 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3161 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3162 struct implicit_component_args implicit_dummy_args
= { 0 };
3163 struct implicit_component_args implicit_text_args
= { 0 };
3164 struct implicit_component_args implicit_debug_info_args
= { 0 };
3165 struct implicit_component_args implicit_muxer_args
= { 0 };
3166 struct implicit_component_args implicit_trimmer_args
= { 0 };
3167 char error_buf
[256] = { 0 };
3169 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3170 char *output
= NULL
;
3171 struct auto_source_discovery auto_disc
= { NULL
};
3172 GString
*auto_disc_comp_name
= NULL
;
3173 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
3174 GString
*name_gstr
= NULL
;
3175 GString
*component_arg_for_run
= NULL
;
3178 * Array of `struct implicit_component_args *` created for the sources
3179 * we have auto-discovered.
3181 GPtrArray
*discovered_source_args
= NULL
;
3184 * If set, restrict automatic source discovery to this component class
3187 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3188 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3190 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3191 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3195 print_convert_usage(stdout
);
3200 if (init_implicit_component_args(&implicit_ctf_output_args
,
3201 "sink.ctf.fs", false)) {
3205 if (init_implicit_component_args(&implicit_lttng_live_args
,
3206 "source.ctf.lttng-live", false)) {
3210 if (init_implicit_component_args(&implicit_text_args
,
3211 "sink.text.pretty", false)) {
3215 if (init_implicit_component_args(&implicit_dummy_args
,
3216 "sink.utils.dummy", false)) {
3220 if (init_implicit_component_args(&implicit_debug_info_args
,
3221 "filter.lttng-utils.debug-info", false)) {
3225 if (init_implicit_component_args(&implicit_muxer_args
,
3226 "filter.utils.muxer", true)) {
3230 if (init_implicit_component_args(&implicit_trimmer_args
,
3231 "filter.utils.trimmer", false)) {
3235 all_names
= bt_value_map_create();
3237 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3241 run_args
= bt_value_array_create();
3243 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3247 component_arg_for_run
= g_string_new(NULL
);
3248 if (!component_arg_for_run
) {
3249 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3253 non_opts
= bt_value_array_create();
3255 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3259 non_opt_params
= bt_value_array_create();
3260 if (!non_opt_params
) {
3261 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3265 non_opt_loglevels
= bt_value_array_create();
3266 if (!non_opt_loglevels
) {
3267 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3271 if (auto_source_discovery_init(&auto_disc
) != 0) {
3275 discovered_source_args
=
3276 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3277 if (!discovered_source_args
) {
3278 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3282 auto_disc_comp_name
= g_string_new(NULL
);
3283 if (!auto_disc_comp_name
) {
3284 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3289 * First pass: collect all arguments which need to be passed
3290 * as is to the run command. This pass can also add --name
3291 * arguments if needed to automatically name unnamed component
3294 argpar_parse_ret
= bt_argpar_parse(argc
, argv
, convert_options
, true);
3295 if (argpar_parse_ret
.error
) {
3296 BT_CLI_LOGE_APPEND_CAUSE(
3297 "While parsing `convert` command's command-line arguments: %s",
3298 argpar_parse_ret
.error
->str
);
3302 if (help_option_is_specified(&argpar_parse_ret
)) {
3303 print_convert_usage(stdout
);
3305 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3309 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3310 struct bt_argpar_item
*argpar_item
=
3311 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3312 struct bt_argpar_item_opt
*argpar_item_opt
;
3314 char *plugin_name
= NULL
;
3315 char *comp_cls_name
= NULL
;
3318 if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
3319 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3320 arg
= argpar_item_opt
->arg
;
3322 switch (argpar_item_opt
->descr
->id
) {
3325 bt_component_class_type type
;
3327 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_COMPONENT
;
3329 /* Parse the argument */
3330 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3331 &comp_cls_name
, &type
);
3332 if (!plugin_name
|| !comp_cls_name
) {
3333 BT_CLI_LOGE_APPEND_CAUSE(
3334 "Invalid format for --component option's argument:\n %s",
3341 * Name was given by the user, verify it isn't
3344 if (bt_value_map_has_entry(all_names
, name
)) {
3345 BT_CLI_LOGE_APPEND_CAUSE(
3346 "Duplicate component instance name:\n %s",
3351 name_gstr
= g_string_new(name
);
3353 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3357 g_string_assign(component_arg_for_run
, arg
);
3359 /* Name not given by user, generate one. */
3360 name_gstr
= get_component_auto_name(arg
, all_names
);
3365 g_string_printf(component_arg_for_run
, "%s:%s",
3366 name_gstr
->str
, arg
);
3369 if (bt_value_array_append_string_element(run_args
,
3371 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3375 if (bt_value_array_append_string_element(run_args
,
3376 component_arg_for_run
->str
)) {
3377 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3382 * Remember this name globally, for the uniqueness of
3383 * all component names.
3385 if (bt_value_map_insert_entry(all_names
,
3386 name_gstr
->str
, bt_value_null
)) {
3387 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3392 * Remember this name specifically for the type of the
3393 * component. This is to create connection arguments.
3395 * The list takes ownership of `name_gstr`.
3398 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3399 source_names
= g_list_append(source_names
, name_gstr
);
3401 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3402 filter_names
= g_list_append(filter_names
, name_gstr
);
3404 case BT_COMPONENT_CLASS_TYPE_SINK
:
3405 sink_names
= g_list_append(sink_names
, name_gstr
);
3414 free(comp_cls_name
);
3417 comp_cls_name
= NULL
;
3421 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3423 * The current item is a component (--component option),
3424 * pass it directly to the run args.
3426 if (bt_value_array_append_string_element(run_args
,
3428 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3432 if (bt_value_array_append_string_element(run_args
, arg
)) {
3433 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3436 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3438 * The current item is a
3439 * non-option argument, record
3440 * it in `non_opt_params`.
3443 uint64_t idx
= bt_value_array_get_length(non_opt_params
) - 1;
3445 array
= bt_value_array_borrow_element_by_index(non_opt_params
, idx
);
3446 bt_value_array_append_string_element(array
, arg
);
3448 BT_CLI_LOGE_APPEND_CAUSE(
3449 "No current component (--component option) or non-option argument of which to set parameters:\n %s",
3455 if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_COMPONENT
) {
3456 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3457 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3461 if (bt_value_array_append_string_element(run_args
, arg
)) {
3462 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3465 } else if (current_item_type
== CONVERT_CURRENT_ITEM_TYPE_NON_OPT
) {
3466 uint64_t idx
= bt_value_array_get_length(non_opt_loglevels
) - 1;
3467 bt_value
*log_level_str_value
;
3469 log_level_str_value
= bt_value_string_create_init(arg
);
3470 if (!log_level_str_value
) {
3471 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3475 if (bt_value_array_set_element_by_index(non_opt_loglevels
, idx
,
3476 log_level_str_value
)) {
3477 bt_value_put_ref(log_level_str_value
);
3478 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3482 BT_CLI_LOGE_APPEND_CAUSE(
3483 "No current component (--component option) or non-option argument to assign a log level to:\n %s",
3489 case OPT_RETRY_DURATION
:
3490 if (bt_value_array_append_string_element(run_args
,
3491 "--retry-duration")) {
3492 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3496 if (bt_value_array_append_string_element(run_args
, arg
)) {
3497 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3502 case OPT_CLOCK_CYCLES
:
3503 case OPT_CLOCK_DATE
:
3504 case OPT_CLOCK_FORCE_CORRELATE
:
3506 case OPT_CLOCK_OFFSET
:
3507 case OPT_CLOCK_OFFSET_NS
:
3508 case OPT_CLOCK_SECONDS
:
3511 case OPT_DEBUG_INFO
:
3512 case OPT_DEBUG_INFO_DIR
:
3513 case OPT_DEBUG_INFO_FULL_PATH
:
3514 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3517 case OPT_INPUT_FORMAT
:
3520 case OPT_OUTPUT_FORMAT
:
3523 case OPT_RUN_ARGS_0
:
3524 case OPT_STREAM_INTERSECTION
:
3527 /* Ignore in this pass */
3530 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
3531 argpar_item_opt
->descr
->id
);
3534 } else if (argpar_item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
3535 struct bt_argpar_item_non_opt
*argpar_item_non_opt
;
3536 bt_value_array_append_element_status append_status
;
3538 current_item_type
= CONVERT_CURRENT_ITEM_TYPE_NON_OPT
;
3540 argpar_item_non_opt
= (struct bt_argpar_item_non_opt
*) argpar_item
;
3542 append_status
= bt_value_array_append_string_element(non_opts
,
3543 argpar_item_non_opt
->arg
);
3544 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3545 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3549 append_status
= bt_value_array_append_empty_array_element(
3550 non_opt_params
, NULL
);
3551 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3552 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3556 append_status
= bt_value_array_append_element(non_opt_loglevels
, bt_value_null
);
3557 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
3558 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3567 * Second pass: transform the convert-specific options and
3568 * arguments into implicit component instances for the run
3571 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
3572 struct bt_argpar_item
*argpar_item
=
3573 g_ptr_array_index(argpar_parse_ret
.items
, i
);
3574 struct bt_argpar_item_opt
*argpar_item_opt
;
3577 if (argpar_item
->type
!= BT_ARGPAR_ITEM_TYPE_OPT
) {
3581 argpar_item_opt
= (struct bt_argpar_item_opt
*) argpar_item
;
3582 arg
= argpar_item_opt
->arg
;
3584 switch (argpar_item_opt
->descr
->id
) {
3586 if (trimmer_has_begin
) {
3587 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
3592 trimmer_has_begin
= true;
3593 ret
= append_implicit_component_extra_param(
3594 &implicit_trimmer_args
, "begin", arg
);
3595 implicit_trimmer_args
.exists
= true;
3601 if (trimmer_has_end
) {
3602 printf("At --end option: --end or --timerange option already specified\n %s\n",
3607 trimmer_has_end
= true;
3608 ret
= append_implicit_component_extra_param(
3609 &implicit_trimmer_args
, "end", arg
);
3610 implicit_trimmer_args
.exists
= true;
3620 if (trimmer_has_begin
|| trimmer_has_end
) {
3621 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3626 ret
= split_timerange(arg
, &begin
, &end
);
3628 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3633 ret
= append_implicit_component_extra_param(
3634 &implicit_trimmer_args
, "begin", begin
);
3635 ret
|= append_implicit_component_extra_param(
3636 &implicit_trimmer_args
, "end", end
);
3637 implicit_trimmer_args
.exists
= true;
3645 case OPT_CLOCK_CYCLES
:
3646 append_implicit_component_param(
3647 &implicit_text_args
, "clock-cycles", "yes");
3648 implicit_text_args
.exists
= true;
3650 case OPT_CLOCK_DATE
:
3651 append_implicit_component_param(
3652 &implicit_text_args
, "clock-date", "yes");
3653 implicit_text_args
.exists
= true;
3655 case OPT_CLOCK_FORCE_CORRELATE
:
3656 append_implicit_component_param(
3657 &implicit_muxer_args
,
3658 "assume-absolute-clock-classes", "yes");
3661 append_implicit_component_param(
3662 &implicit_text_args
, "clock-gmt", "yes");
3663 append_implicit_component_param(
3664 &implicit_trimmer_args
, "gmt", "yes");
3665 implicit_text_args
.exists
= true;
3667 case OPT_CLOCK_OFFSET
:
3668 if (ctf_fs_source_clock_class_offset_arg
) {
3669 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3673 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3674 if (!ctf_fs_source_clock_class_offset_arg
) {
3675 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3679 case OPT_CLOCK_OFFSET_NS
:
3680 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3681 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3685 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3686 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3687 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3691 case OPT_CLOCK_SECONDS
:
3692 append_implicit_component_param(
3693 &implicit_text_args
, "clock-seconds", "yes");
3694 implicit_text_args
.exists
= true;
3697 implicit_text_args
.exists
= true;
3698 ret
= append_implicit_component_extra_param(
3699 &implicit_text_args
, "color", arg
);
3704 case OPT_DEBUG_INFO
:
3705 implicit_debug_info_args
.exists
= true;
3707 case OPT_DEBUG_INFO_DIR
:
3708 implicit_debug_info_args
.exists
= true;
3709 ret
= append_implicit_component_extra_param(
3710 &implicit_debug_info_args
, "debug-info-dir", arg
);
3715 case OPT_DEBUG_INFO_FULL_PATH
:
3716 implicit_debug_info_args
.exists
= true;
3717 append_implicit_component_param(
3718 &implicit_debug_info_args
, "full-path", "yes");
3720 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3721 implicit_debug_info_args
.exists
= true;
3722 ret
= append_implicit_component_extra_param(
3723 &implicit_debug_info_args
,
3724 "target-prefix", arg
);
3731 bt_value
*fields
= fields_from_arg(arg
);
3737 implicit_text_args
.exists
= true;
3738 ret
= insert_flat_params_from_array(
3739 implicit_text_args
.params_arg
,
3741 bt_value_put_ref(fields
);
3749 bt_value
*names
= names_from_arg(arg
);
3755 implicit_text_args
.exists
= true;
3756 ret
= insert_flat_params_from_array(
3757 implicit_text_args
.params_arg
,
3759 bt_value_put_ref(names
);
3766 append_implicit_component_param(
3767 &implicit_text_args
, "no-delta", "yes");
3768 implicit_text_args
.exists
= true;
3770 case OPT_INPUT_FORMAT
:
3771 if (got_input_format_opt
) {
3772 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3776 got_input_format_opt
= true;
3778 if (strcmp(arg
, "ctf") == 0) {
3779 auto_source_discovery_restrict_plugin_name
= "ctf";
3780 auto_source_discovery_restrict_component_class_name
= "fs";
3781 } else if (strcmp(arg
, "lttng-live") == 0) {
3782 auto_source_discovery_restrict_plugin_name
= "ctf";
3783 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3784 implicit_lttng_live_args
.exists
= true;
3786 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
3791 case OPT_OUTPUT_FORMAT
:
3792 if (got_output_format_opt
) {
3793 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
3797 got_output_format_opt
= true;
3799 if (strcmp(arg
, "text") == 0) {
3800 implicit_text_args
.exists
= true;
3801 } else if (strcmp(arg
, "ctf") == 0) {
3802 implicit_ctf_output_args
.exists
= true;
3803 } else if (strcmp(arg
, "dummy") == 0) {
3804 implicit_dummy_args
.exists
= true;
3805 } else if (strcmp(arg
, "ctf-metadata") == 0) {
3806 print_ctf_metadata
= true;
3808 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
3815 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
3819 output
= strdup(arg
);
3821 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3826 if (print_run_args_0
) {
3827 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3831 print_run_args
= true;
3833 case OPT_RUN_ARGS_0
:
3834 if (print_run_args
) {
3835 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
3839 print_run_args_0
= true;
3841 case OPT_STREAM_INTERSECTION
:
3843 * Applies to all traces implementing the
3844 * babeltrace.trace-info query.
3846 stream_intersection_mode
= true;
3849 if (*default_log_level
!= BT_LOG_TRACE
&&
3850 *default_log_level
!= BT_LOG_DEBUG
) {
3851 *default_log_level
= BT_LOG_INFO
;
3855 *default_log_level
= BT_LOG_TRACE
;
3863 * Legacy behaviour: --verbose used to make the `text` output
3864 * format print more information. --verbose is now equivalent to
3865 * the INFO log level, which is why we compare to `BT_LOG_INFO`
3868 if (*default_log_level
== BT_LOG_INFO
) {
3869 append_implicit_component_param(&implicit_text_args
,
3873 /* Print CTF metadata or print LTTng live sessions */
3874 if (print_ctf_metadata
) {
3875 const bt_value
*bt_val_non_opt
;
3877 if (bt_value_array_is_empty(non_opts
)) {
3878 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
3882 if (bt_value_array_get_length(non_opts
) > 1) {
3883 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
3887 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
3892 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
3893 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
3894 bt_value_string_get(bt_val_non_opt
));
3898 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
3906 * If -o ctf was specified, make sure an output path (--output)
3907 * was also specified. --output does not imply -o ctf because
3908 * it's also used for the default, implicit -o text if -o ctf
3911 if (implicit_ctf_output_args
.exists
) {
3913 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
3918 * At this point we know that -o ctf AND --output were
3919 * specified. Make sure that no options were specified
3920 * which would imply -o text because --output would be
3921 * ambiguous in this case. For example, this is wrong:
3923 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
3925 * because --names=all implies -o text, and --output
3926 * could apply to both the sink.text.pretty and
3927 * sink.ctf.fs implicit components.
3929 if (implicit_text_args
.exists
) {
3930 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
3936 * If -o dummy and -o ctf were not specified, and if there are
3937 * no explicit sink components, then use an implicit
3938 * `sink.text.pretty` component.
3940 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
3942 implicit_text_args
.exists
= true;
3946 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
3947 * `path` parameter if --output was specified.
3950 if (implicit_text_args
.exists
) {
3951 append_implicit_component_extra_param(&implicit_text_args
,
3953 } else if (implicit_ctf_output_args
.exists
) {
3954 append_implicit_component_extra_param(&implicit_ctf_output_args
,
3959 /* Decide where the non-option argument(s) go */
3960 if (bt_value_array_get_length(non_opts
) > 0) {
3961 if (implicit_lttng_live_args
.exists
) {
3962 const bt_value
*bt_val_non_opt
;
3964 if (bt_value_array_get_length(non_opts
) > 1) {
3965 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
3969 bt_val_non_opt
= bt_value_array_borrow_element_by_index_const(non_opts
, 0);
3970 lttng_live_url_parts
=
3971 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_non_opt
),
3972 error_buf
, sizeof(error_buf
));
3973 if (!lttng_live_url_parts
.proto
) {
3974 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
3979 if (!lttng_live_url_parts
.session_name
) {
3980 /* Print LTTng live sessions */
3981 cfg
= bt_config_print_lttng_live_sessions_create(
3987 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
3988 bt_value_string_get(bt_val_non_opt
));
3992 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
3999 ret
= append_implicit_component_extra_param(
4000 &implicit_lttng_live_args
, "url",
4001 bt_value_string_get(bt_val_non_opt
));
4006 ret
= append_implicit_component_extra_param(
4007 &implicit_lttng_live_args
,
4008 "session-not-found-action", "end");
4014 size_t plugin_count
;
4015 const bt_plugin
**plugins
;
4016 const bt_plugin
*plugin
;
4018 status
= require_loaded_plugins(plugin_paths
);
4023 if (auto_source_discovery_restrict_plugin_name
) {
4025 plugin
= find_loaded_plugin(auto_source_discovery_restrict_plugin_name
);
4028 plugin_count
= get_loaded_plugins_count();
4029 plugins
= borrow_loaded_plugins();
4032 status
= auto_discover_source_components(non_opts
, plugins
, plugin_count
,
4033 auto_source_discovery_restrict_component_class_name
,
4034 *default_log_level
>= 0 ? *default_log_level
: cli_default_log_level
,
4041 status
= create_implicit_component_args_from_auto_discovered_sources(
4042 &auto_disc
, non_opt_params
, non_opt_loglevels
,
4043 discovered_source_args
);
4050 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4051 if (ctf_fs_source_clock_class_offset_arg
) {
4054 n
= append_multiple_implicit_components_param(
4055 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4056 ctf_fs_source_clock_class_offset_arg
);
4059 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4064 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4065 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4068 n
= append_multiple_implicit_components_param(
4069 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4070 ctf_fs_source_clock_class_offset_ns_arg
);
4073 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4079 * If the implicit `source.ctf.lttng-live` component exists,
4080 * make sure there's at least one non-option argument (which is
4083 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(non_opts
)) {
4084 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4085 implicit_lttng_live_args
.comp_arg
->str
);
4089 /* Assign names to implicit components */
4090 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4091 struct implicit_component_args
*args
;
4094 args
= discovered_source_args
->pdata
[i
];
4096 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4098 /* Give it a name like `auto-disc-src-ctf-fs`. */
4099 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4100 if (auto_disc_comp_name
->str
[j
] == '.') {
4101 auto_disc_comp_name
->str
[j
] = '-';
4105 ret
= assign_name_to_implicit_component(args
,
4106 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4112 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4113 "lttng-live", all_names
, &source_names
, true);
4118 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4119 "pretty", all_names
, &sink_names
, true);
4124 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4125 "sink-ctf-fs", all_names
, &sink_names
, true);
4130 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4131 "dummy", all_names
, &sink_names
, true);
4136 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4137 "muxer", all_names
, NULL
, false);
4142 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4143 "trimmer", all_names
, NULL
, false);
4148 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4149 "debug-info", all_names
, NULL
, false);
4154 /* Make sure there's at least one source and one sink */
4155 if (!source_names
) {
4156 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4161 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4165 /* Make sure there's a single sink component */
4166 if (g_list_length(sink_names
) != 1) {
4167 BT_CLI_LOGE_APPEND_CAUSE(
4168 "More than one sink component specified.");
4173 * Prepend the muxer, the trimmer, and the debug info to the
4174 * filter chain so that we have:
4176 * sources -> muxer -> [trimmer] -> [debug info] ->
4177 * [user filters] -> sinks
4179 if (implicit_debug_info_args
.exists
) {
4180 if (g_list_prepend_gstring(&filter_names
,
4181 implicit_debug_info_args
.name_arg
->str
)) {
4186 if (implicit_trimmer_args
.exists
) {
4187 if (g_list_prepend_gstring(&filter_names
,
4188 implicit_trimmer_args
.name_arg
->str
)) {
4193 if (g_list_prepend_gstring(&filter_names
,
4194 implicit_muxer_args
.name_arg
->str
)) {
4199 * Append the equivalent run arguments for the implicit
4202 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4203 struct implicit_component_args
*args
=
4204 discovered_source_args
->pdata
[i
];
4206 ret
= append_run_args_for_implicit_component(args
, run_args
);
4212 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4218 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4224 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4230 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4236 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4242 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4248 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4254 /* Auto-connect components */
4255 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4258 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4263 * We have all the run command arguments now. Depending on
4264 * --run-args, we pass this to the run command or print them
4267 if (print_run_args
|| print_run_args_0
) {
4268 if (stream_intersection_mode
) {
4269 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4273 for (i
= 0; i
< bt_value_array_get_length(run_args
); i
++) {
4274 const bt_value
*arg_value
=
4275 bt_value_array_borrow_element_by_index(run_args
,
4278 GString
*quoted
= NULL
;
4279 const char *arg_to_print
;
4281 BT_ASSERT(arg_value
);
4282 arg
= bt_value_string_get(arg_value
);
4284 if (print_run_args
) {
4285 quoted
= bt_common_shell_quote(arg
, true);
4290 arg_to_print
= quoted
->str
;
4295 printf("%s", arg_to_print
);
4298 g_string_free(quoted
, TRUE
);
4301 if (i
< bt_value_array_get_length(run_args
) - 1) {
4302 if (print_run_args
) {
4311 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4316 * If the log level is still unset at this point, set it to
4317 * the program's default.
4319 if (*default_log_level
< 0) {
4320 *default_log_level
= cli_default_log_level
;
4323 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4324 plugin_paths
, *default_log_level
);
4329 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4334 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4338 * If the log level is still unset at this point, set it to
4339 * the program's default.
4341 if (*default_log_level
< 0) {
4342 *default_log_level
= cli_default_log_level
;
4345 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4349 if (component_arg_for_run
) {
4350 g_string_free(component_arg_for_run
, TRUE
);
4354 g_string_free(name_gstr
, TRUE
);
4357 bt_value_put_ref(run_args
);
4358 bt_value_put_ref(all_names
);
4359 destroy_glist_of_gstring(source_names
);
4360 destroy_glist_of_gstring(filter_names
);
4361 destroy_glist_of_gstring(sink_names
);
4362 bt_value_put_ref(non_opt_params
);
4363 bt_value_put_ref(non_opt_loglevels
);
4364 bt_value_put_ref(non_opts
);
4365 finalize_implicit_component_args(&implicit_ctf_output_args
);
4366 finalize_implicit_component_args(&implicit_lttng_live_args
);
4367 finalize_implicit_component_args(&implicit_dummy_args
);
4368 finalize_implicit_component_args(&implicit_text_args
);
4369 finalize_implicit_component_args(&implicit_debug_info_args
);
4370 finalize_implicit_component_args(&implicit_muxer_args
);
4371 finalize_implicit_component_args(&implicit_trimmer_args
);
4372 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4373 auto_source_discovery_fini(&auto_disc
);
4375 if (discovered_source_args
) {
4376 g_ptr_array_free(discovered_source_args
, TRUE
);
4379 g_free(ctf_fs_source_clock_class_offset_arg
);
4380 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4382 if (auto_disc_comp_name
) {
4383 g_string_free(auto_disc_comp_name
, TRUE
);
4390 * Prints the Babeltrace 2.x general usage.
4393 void print_gen_usage(FILE *fp
)
4395 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4397 fprintf(fp
, "General options:\n");
4399 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=V)\n");
4400 fprintf(fp
, " -h, --help Show this help and quit\n");
4401 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `V`, `D`,\n");
4402 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4403 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
4404 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
4405 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
4406 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
4407 fprintf(fp
, " dynamic plugins can be loaded\n");
4408 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4409 fprintf(fp
, " -V, --version Show version and quit\n");
4411 fprintf(fp
, "Available commands:\n");
4413 fprintf(fp
, " convert Convert and trim traces (default)\n");
4414 fprintf(fp
, " help Get help for a plugin or a component class\n");
4415 fprintf(fp
, " list-plugins List available plugins and their content\n");
4416 fprintf(fp
, " query Query objects from a component class\n");
4417 fprintf(fp
, " run Build a processing graph and run it\n");
4419 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4422 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4423 int *retcode
, bool omit_system_plugin_path
,
4424 bool omit_home_plugin_path
,
4425 const bt_value
*initial_plugin_paths
)
4427 struct bt_config
*config
= NULL
;
4430 const char **top_level_argv
;
4431 int command_argc
= -1;
4432 const char **command_argv
= NULL
;
4433 const char *command_name
= NULL
;
4434 int default_log_level
= -1;
4435 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
4436 bt_value
*plugin_paths
= NULL
;
4438 /* Top-level option descriptions. */
4439 static const struct bt_argpar_opt_descr descrs
[] = {
4440 { OPT_DEBUG
, 'd', "debug", false },
4441 { OPT_HELP
, 'h', "help", false },
4442 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4443 { OPT_VERBOSE
, 'v', "verbose", false },
4444 { OPT_VERSION
, 'V', "version", false},
4445 { OPT_OMIT_HOME_PLUGIN_PATH
, '\0', "omit-home-plugin-path", false },
4446 { OPT_OMIT_SYSTEM_PLUGIN_PATH
, '\0', "omit-system-plugin-path", false },
4447 { OPT_PLUGIN_PATH
, '\0', "plugin-path", true },
4448 BT_ARGPAR_OPT_DESCR_SENTINEL
4452 COMMAND_TYPE_NONE
= -1,
4453 COMMAND_TYPE_RUN
= 0,
4454 COMMAND_TYPE_CONVERT
,
4455 COMMAND_TYPE_LIST_PLUGINS
,
4458 } command_type
= COMMAND_TYPE_NONE
;
4462 if (!initial_plugin_paths
) {
4463 plugin_paths
= bt_value_array_create();
4464 if (!plugin_paths
) {
4468 bt_value_copy_status copy_status
= bt_value_copy(
4469 initial_plugin_paths
, &plugin_paths
);
4475 BT_ASSERT(plugin_paths
);
4478 * The `BABELTRACE_PLUGIN_PATH` paths take precedence over the
4479 * `--plugin-path` option's paths, so append it now before
4480 * parsing the general options.
4482 if (append_env_var_plugin_paths(plugin_paths
)) {
4489 print_gen_usage(stdout
);
4493 /* Skip first argument, the name of the program. */
4494 top_level_argc
= argc
- 1;
4495 top_level_argv
= argv
+ 1;
4496 argpar_parse_ret
= bt_argpar_parse(top_level_argc
, top_level_argv
,
4499 if (argpar_parse_ret
.error
) {
4500 BT_CLI_LOGE_APPEND_CAUSE(
4501 "While parsing command-line arguments: %s",
4502 argpar_parse_ret
.error
->str
);
4506 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
4507 struct bt_argpar_item
*item
;
4509 item
= g_ptr_array_index(argpar_parse_ret
.items
, i
);
4511 if (item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
4512 struct bt_argpar_item_opt
*item_opt
=
4513 (struct bt_argpar_item_opt
*) item
;
4515 switch (item_opt
->descr
->id
) {
4517 default_log_level
= BT_LOG_TRACE
;
4521 * Legacy: do not override a previous
4522 * --debug because --verbose and --debug
4523 * can be specified together (in this
4524 * case we want the lowest log level to
4527 default_log_level
= BT_LOG_INFO
;
4531 bt_log_get_level_from_string(item_opt
->arg
);
4532 if (default_log_level
< 0) {
4533 BT_CLI_LOGE_APPEND_CAUSE(
4534 "Invalid argument for --log-level option:\n %s",
4539 case OPT_PLUGIN_PATH
:
4540 if (bt_config_append_plugin_paths_check_setuid_setgid(
4541 plugin_paths
, item_opt
->arg
)) {
4545 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
4546 omit_system_plugin_path
= true;
4548 case OPT_OMIT_HOME_PLUGIN_PATH
:
4549 omit_home_plugin_path
= true;
4555 print_gen_usage(stdout
);
4558 } else if (item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
4559 struct bt_argpar_item_non_opt
*item_non_opt
=
4560 (struct bt_argpar_item_non_opt
*) item
;
4562 * First unknown argument: is it a known command
4566 top_level_argc
- item_non_opt
->orig_index
- 1;
4568 &top_level_argv
[item_non_opt
->orig_index
+ 1];
4570 if (strcmp(item_non_opt
->arg
, "convert") == 0) {
4571 command_type
= COMMAND_TYPE_CONVERT
;
4572 } else if (strcmp(item_non_opt
->arg
, "list-plugins") == 0) {
4573 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4574 } else if (strcmp(item_non_opt
->arg
, "help") == 0) {
4575 command_type
= COMMAND_TYPE_HELP
;
4576 } else if (strcmp(item_non_opt
->arg
, "query") == 0) {
4577 command_type
= COMMAND_TYPE_QUERY
;
4578 } else if (strcmp(item_non_opt
->arg
, "run") == 0) {
4579 command_type
= COMMAND_TYPE_RUN
;
4582 * Non-option argument, but not a known
4583 * command name: assume the default
4584 * `convert` command.
4586 command_type
= COMMAND_TYPE_CONVERT
;
4587 command_name
= "convert";
4595 if (command_type
== COMMAND_TYPE_NONE
) {
4596 if (argpar_parse_ret
.ingested_orig_args
== top_level_argc
) {
4598 * We only got non-help, non-version general options
4599 * like --verbose and --debug, without any other
4600 * arguments, so we can't do anything useful: print the
4603 print_gen_usage(stdout
);
4608 * We stopped on an unknown option argument (and therefore
4609 * didn't see a command name). Assume `convert` command.
4611 command_type
= COMMAND_TYPE_CONVERT
;
4612 command_name
= "convert";
4614 top_level_argc
- argpar_parse_ret
.ingested_orig_args
;
4616 &top_level_argv
[argpar_parse_ret
.ingested_orig_args
];
4619 BT_ASSERT(command_argv
);
4620 BT_ASSERT(command_argc
>= 0);
4623 * The convert command can set its own default log level for
4624 * backward compatibility reasons. It only does so if there's no
4625 * log level yet, so do not force one for this command.
4627 if (command_type
!= COMMAND_TYPE_CONVERT
&& default_log_level
< 0) {
4628 /* Default log level */
4629 default_log_level
= cli_default_log_level
;
4633 * At this point, `plugin_paths` contains the initial plugin
4634 * paths, the paths from the `BABELTRACE_PLUGIN_PATH` paths, and
4635 * the paths from the `--plugin-path` option.
4637 * Now append the user and system plugin paths.
4639 if (append_home_and_system_plugin_paths(plugin_paths
,
4640 omit_system_plugin_path
, omit_home_plugin_path
)) {
4644 switch (command_type
) {
4645 case COMMAND_TYPE_RUN
:
4646 config
= bt_config_run_from_args(command_argc
, command_argv
,
4647 retcode
, plugin_paths
,
4650 case COMMAND_TYPE_CONVERT
:
4651 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4652 retcode
, plugin_paths
, &default_log_level
);
4654 case COMMAND_TYPE_LIST_PLUGINS
:
4655 config
= bt_config_list_plugins_from_args(command_argc
,
4656 command_argv
, retcode
, plugin_paths
);
4658 case COMMAND_TYPE_HELP
:
4659 config
= bt_config_help_from_args(command_argc
,
4660 command_argv
, retcode
, plugin_paths
,
4663 case COMMAND_TYPE_QUERY
:
4664 config
= bt_config_query_from_args(command_argc
,
4665 command_argv
, retcode
, plugin_paths
,
4673 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4674 config
->log_level
= default_log_level
;
4675 config
->command_name
= command_name
;
4684 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4685 bt_value_put_ref(plugin_paths
);