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"
39 #include <sys/types.h>
40 #include "argpar/argpar.h"
41 #include "babeltrace2-cfg.h"
42 #include "babeltrace2-cfg-cli-args.h"
43 #include "babeltrace2-cfg-cli-args-connect.h"
44 #include "babeltrace2-cfg-cli-params-arg.h"
45 #include "babeltrace2-plugins.h"
46 #include "babeltrace2-cfg-src-auto-disc.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_size(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
,
888 OPT_OMIT_HOME_PLUGIN_PATH
,
889 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
895 OPT_RESET_BASE_PARAMS
,
899 OPT_STREAM_INTERSECTION
,
906 enum bt_config_component_dest
{
907 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
908 BT_CONFIG_COMPONENT_DEST_SOURCE
,
909 BT_CONFIG_COMPONENT_DEST_FILTER
,
910 BT_CONFIG_COMPONENT_DEST_SINK
,
914 * Adds a configuration component to the appropriate configuration
915 * array depending on the destination.
918 void add_run_cfg_comp(struct bt_config
*cfg
,
919 struct bt_config_component
*cfg_comp
,
920 enum bt_config_component_dest dest
)
922 bt_object_get_ref(cfg_comp
);
925 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
926 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
928 case BT_CONFIG_COMPONENT_DEST_FILTER
:
929 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
931 case BT_CONFIG_COMPONENT_DEST_SINK
:
932 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
940 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
941 struct bt_config_component
*cfg_comp
,
942 enum bt_config_component_dest dest
,
943 bt_value
*instance_names
)
947 if (cfg_comp
->instance_name
->len
== 0) {
948 BT_CLI_LOGE_APPEND_CAUSE("Found an unnamed component.");
953 if (bt_value_map_has_entry(instance_names
,
954 cfg_comp
->instance_name
->str
)) {
955 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
956 cfg_comp
->instance_name
->str
);
961 if (bt_value_map_insert_entry(instance_names
,
962 cfg_comp
->instance_name
->str
, bt_value_null
)) {
963 BT_CLI_LOGE_APPEND_CAUSE_OOM();
968 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
975 int append_env_var_plugin_paths(bt_value
*plugin_paths
)
980 if (bt_common_is_setuid_setgid()) {
981 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
985 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
990 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
994 BT_CLI_LOGE_APPEND_CAUSE("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH.");
1001 int append_home_and_system_plugin_paths(bt_value
*plugin_paths
,
1002 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
1006 if (!omit_home_plugin_path
) {
1007 if (bt_common_is_setuid_setgid()) {
1008 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1010 char *home_plugin_dir
= bt_common_get_home_plugin_path(
1011 BT_LOG_OUTPUT_LEVEL
);
1013 if (home_plugin_dir
) {
1014 ret
= bt_config_append_plugin_paths(
1015 plugin_paths
, home_plugin_dir
);
1016 free(home_plugin_dir
);
1019 BT_CLI_LOGE_APPEND_CAUSE("Invalid home plugin path.");
1026 if (!omit_system_plugin_path
) {
1027 if (bt_config_append_plugin_paths(plugin_paths
,
1028 bt_common_get_system_plugin_path())) {
1029 BT_CLI_LOGE_APPEND_CAUSE("Invalid system plugin path.");
1035 BT_CLI_LOGE_APPEND_CAUSE("Cannot append home and system plugin paths.");
1040 int append_home_and_system_plugin_paths_cfg(struct bt_config
*cfg
)
1042 return append_home_and_system_plugin_paths(cfg
->plugin_paths
,
1043 cfg
->omit_system_plugin_path
, cfg
->omit_home_plugin_path
);
1047 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1048 const bt_value
*initial_plugin_paths
,
1051 struct bt_config
*cfg
;
1054 cfg
= g_new0(struct bt_config
, 1);
1056 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1060 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1061 cfg
->command
= command
;
1062 cfg
->command_needs_plugins
= needs_plugins
;
1064 if (initial_plugin_paths
) {
1065 bt_value
*initial_plugin_paths_copy
;
1067 (void) bt_value_copy(initial_plugin_paths
,
1068 &initial_plugin_paths_copy
);
1069 cfg
->plugin_paths
= initial_plugin_paths_copy
;
1071 cfg
->plugin_paths
= bt_value_array_create();
1072 if (!cfg
->plugin_paths
) {
1073 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1081 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1088 struct bt_config
*bt_config_run_create(
1089 const bt_value
*initial_plugin_paths
)
1091 struct bt_config
*cfg
;
1094 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1095 initial_plugin_paths
, true);
1100 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1101 (GDestroyNotify
) bt_object_put_ref
);
1102 if (!cfg
->cmd_data
.run
.sources
) {
1103 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1107 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1108 (GDestroyNotify
) bt_object_put_ref
);
1109 if (!cfg
->cmd_data
.run
.filters
) {
1110 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1114 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1115 (GDestroyNotify
) bt_object_put_ref
);
1116 if (!cfg
->cmd_data
.run
.sinks
) {
1117 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1121 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1122 (GDestroyNotify
) bt_config_connection_destroy
);
1123 if (!cfg
->cmd_data
.run
.connections
) {
1124 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1131 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1138 struct bt_config
*bt_config_list_plugins_create(
1139 const bt_value
*initial_plugin_paths
)
1141 struct bt_config
*cfg
;
1144 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1145 initial_plugin_paths
, true);
1153 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1160 struct bt_config
*bt_config_help_create(
1161 const bt_value
*initial_plugin_paths
,
1162 int default_log_level
)
1164 struct bt_config
*cfg
;
1167 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1168 initial_plugin_paths
, true);
1173 cfg
->cmd_data
.help
.cfg_component
=
1174 bt_config_component_create(-1, NULL
, NULL
, default_log_level
);
1175 if (!cfg
->cmd_data
.help
.cfg_component
) {
1182 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1189 struct bt_config
*bt_config_query_create(
1190 const bt_value
*initial_plugin_paths
)
1192 struct bt_config
*cfg
;
1195 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1196 initial_plugin_paths
, true);
1201 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1202 if (!cfg
->cmd_data
.query
.object
) {
1203 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1210 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1217 struct bt_config
*bt_config_print_ctf_metadata_create(
1218 const bt_value
*initial_plugin_paths
)
1220 struct bt_config
*cfg
;
1223 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1224 initial_plugin_paths
, true);
1229 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1230 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1231 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1235 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1236 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1237 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1244 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1251 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1252 const bt_value
*initial_plugin_paths
)
1254 struct bt_config
*cfg
;
1257 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1258 initial_plugin_paths
, true);
1263 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1264 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1265 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1269 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1271 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1272 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1279 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1286 int bt_config_append_plugin_paths_check_setuid_setgid(
1287 bt_value
*plugin_paths
, const char *arg
)
1291 if (bt_common_is_setuid_setgid()) {
1292 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1296 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1297 BT_CLI_LOGE_APPEND_CAUSE("Invalid --plugin-path option's argument:\n %s",
1308 * Prints the expected format for a --params option.
1311 void print_expected_params_format(FILE *fp
)
1313 fprintf(fp
, "Expected format of PARAMS\n");
1314 fprintf(fp
, "-------------------------\n");
1316 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1318 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1319 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1320 fprintf(fp
, "and VALUE can be one of:\n");
1322 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1323 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1324 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1325 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1326 fprintf(fp
, " (`0x` prefix) unsigned (with `+` prefix) or signed 64-bit integer.\n");
1327 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1328 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1329 fprintf(fp
, " the null and boolean value symbols above.\n");
1330 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1331 fprintf(fp
, "* Array, formatted as an opening `[`, a list of comma-separated values\n");
1332 fprintf(fp
, " (as described by the current list) and a closing `]`.\n");
1334 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1336 fprintf(fp
, "Example:\n");
1338 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1339 fprintf(fp
, " play=+23, observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1340 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\",\n");
1341 fprintf(fp
, " things=[1, \"2\", 3]\n");
1343 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1344 fprintf(fp
, "babeltrace2 from a shell.\n");
1349 * Prints the help command usage.
1352 void print_help_usage(FILE *fp
)
1354 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1355 fprintf(fp
, " babeltrace2 [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1357 fprintf(fp
, "Options:\n");
1359 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1360 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
1361 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1362 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1363 fprintf(fp
, " dynamic plugins can be loaded\n");
1364 fprintf(fp
, " -h, --help Show this help and quit\n");
1366 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1368 fprintf(fp
, "Use `babeltrace2 list-plugins` to show the list of available plugins.\n");
1372 struct poptOption help_long_options
[] = {
1373 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1374 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1375 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1376 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1377 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1378 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1382 * Creates a Babeltrace config object from the arguments of a help
1385 * *retcode is set to the appropriate exit code to use.
1388 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
1389 int *retcode
, bool force_omit_system_plugin_path
,
1390 bool force_omit_home_plugin_path
,
1391 const bt_value
*initial_plugin_paths
, int default_log_level
)
1393 poptContext pc
= NULL
;
1397 struct bt_config
*cfg
= NULL
;
1398 const char *leftover
;
1399 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1402 cfg
= bt_config_help_create(initial_plugin_paths
, default_log_level
);
1407 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
1408 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
1409 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
1415 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
1416 help_long_options
, POPT_CONTEXT_KEEP_FIRST
);
1418 BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
1422 poptReadDefaultConfig(pc
, 0);
1424 while ((opt
= poptGetNextOpt(pc
)) > 0) {
1425 arg
= poptGetOptArg(pc
);
1428 case OPT_PLUGIN_PATH
:
1429 if (bt_config_append_plugin_paths_check_setuid_setgid(
1430 cfg
->plugin_paths
, arg
)) {
1434 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
1435 cfg
->omit_system_plugin_path
= true;
1437 case OPT_OMIT_HOME_PLUGIN_PATH
:
1438 cfg
->omit_home_plugin_path
= true;
1441 print_help_usage(stdout
);
1443 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1446 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1455 /* Check for option parsing error */
1457 BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: `%s`.",
1458 poptBadOption(pc
, 0), poptStrerror(opt
));
1462 leftover
= poptGetArg(pc
);
1464 plugin_comp_cls_names(leftover
, NULL
,
1465 &plugin_name
, &comp_cls_name
,
1466 &cfg
->cmd_data
.help
.cfg_component
->type
);
1467 if (plugin_name
&& comp_cls_name
) {
1468 /* Component class help */
1470 cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1473 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1476 /* Fall back to plugin help */
1478 cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1482 print_help_usage(stdout
);
1484 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1488 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
1496 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1499 g_free(plugin_name
);
1500 g_free(comp_cls_name
);
1503 poptFreeContext(pc
);
1511 * Prints the help command usage.
1514 void print_query_usage(FILE *fp
)
1516 fprintf(fp
, "Usage: babeltrace2 [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1518 fprintf(fp
, "Options:\n");
1520 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1521 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
1522 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1523 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS\n");
1524 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1525 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1526 fprintf(fp
, " dynamic plugins can be loaded\n");
1527 fprintf(fp
, " -h, --help Show this help and quit\n");
1528 fprintf(fp
, "\n\n");
1529 print_expected_params_format(fp
);
1533 struct poptOption query_long_options
[] = {
1534 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1535 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1536 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1537 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1538 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
1539 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1540 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1544 * Creates a Babeltrace config object from the arguments of a query
1547 * *retcode is set to the appropriate exit code to use.
1550 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1551 int *retcode
, bool force_omit_system_plugin_path
,
1552 bool force_omit_home_plugin_path
,
1553 const bt_value
*initial_plugin_paths
,
1554 int default_log_level
)
1556 poptContext pc
= NULL
;
1560 struct bt_config
*cfg
= NULL
;
1561 const char *leftover
;
1563 GString
*error_str
= NULL
;
1565 params
= bt_value_null
;
1566 bt_value_get_ref(bt_value_null
);
1569 cfg
= bt_config_query_create(initial_plugin_paths
);
1574 error_str
= g_string_new(NULL
);
1576 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1580 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
1581 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
1582 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
1588 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
1589 query_long_options
, POPT_CONTEXT_KEEP_FIRST
);
1591 BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
1595 poptReadDefaultConfig(pc
, 0);
1597 while ((opt
= poptGetNextOpt(pc
)) > 0) {
1598 arg
= poptGetOptArg(pc
);
1601 case OPT_PLUGIN_PATH
:
1602 if (bt_config_append_plugin_paths_check_setuid_setgid(
1603 cfg
->plugin_paths
, arg
)) {
1607 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
1608 cfg
->omit_system_plugin_path
= true;
1610 case OPT_OMIT_HOME_PLUGIN_PATH
:
1611 cfg
->omit_home_plugin_path
= true;
1615 bt_value_put_ref(params
);
1616 params
= cli_value_from_arg(arg
, error_str
);
1618 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
1625 print_query_usage(stdout
);
1627 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1630 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1639 /* Check for option parsing error */
1641 BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: `%s`.",
1642 poptBadOption(pc
, 0), poptStrerror(opt
));
1647 * We need exactly two leftover arguments which are the
1648 * mandatory component class specification and query object.
1650 leftover
= poptGetArg(pc
);
1652 cfg
->cmd_data
.query
.cfg_component
=
1653 bt_config_component_from_arg(leftover
,
1655 if (!cfg
->cmd_data
.query
.cfg_component
) {
1656 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for component class specification:\n %s",
1662 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
,
1665 print_query_usage(stdout
);
1667 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1671 leftover
= poptGetArg(pc
);
1673 if (strlen(leftover
) == 0) {
1674 BT_CLI_LOGE_APPEND_CAUSE("Invalid empty object.");
1678 g_string_assign(cfg
->cmd_data
.query
.object
, leftover
);
1680 print_query_usage(stdout
);
1682 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1686 leftover
= poptGetArg(pc
);
1688 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`.", leftover
);
1692 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
1700 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1704 poptFreeContext(pc
);
1708 g_string_free(error_str
, TRUE
);
1711 bt_value_put_ref(params
);
1717 * Prints the list-plugins command usage.
1720 void print_list_plugins_usage(FILE *fp
)
1722 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
1724 fprintf(fp
, "Options:\n");
1726 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1727 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
1728 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1729 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1730 fprintf(fp
, " dynamic plugins can be loaded\n");
1731 fprintf(fp
, " -h, --help Show this help and quit\n");
1733 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1735 fprintf(fp
, "Use `babeltrace2 help` to get help for a specific plugin or component class.\n");
1739 struct poptOption list_plugins_long_options
[] = {
1740 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1741 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1742 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1743 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1744 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1745 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1749 * Creates a Babeltrace config object from the arguments of a
1750 * list-plugins command.
1752 * *retcode is set to the appropriate exit code to use.
1755 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
1756 int *retcode
, bool force_omit_system_plugin_path
,
1757 bool force_omit_home_plugin_path
,
1758 const bt_value
*initial_plugin_paths
)
1760 poptContext pc
= NULL
;
1764 struct bt_config
*cfg
= NULL
;
1765 const char *leftover
;
1768 cfg
= bt_config_list_plugins_create(initial_plugin_paths
);
1773 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
1774 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
1775 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
1781 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
1782 list_plugins_long_options
, POPT_CONTEXT_KEEP_FIRST
);
1784 BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
1788 poptReadDefaultConfig(pc
, 0);
1790 while ((opt
= poptGetNextOpt(pc
)) > 0) {
1791 arg
= poptGetOptArg(pc
);
1794 case OPT_PLUGIN_PATH
:
1795 if (bt_config_append_plugin_paths_check_setuid_setgid(
1796 cfg
->plugin_paths
, arg
)) {
1800 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
1801 cfg
->omit_system_plugin_path
= true;
1803 case OPT_OMIT_HOME_PLUGIN_PATH
:
1804 cfg
->omit_home_plugin_path
= true;
1807 print_list_plugins_usage(stdout
);
1809 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1812 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
1821 /* Check for option parsing error */
1823 BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: %s",
1824 poptBadOption(pc
, 0), poptStrerror(opt
));
1828 leftover
= poptGetArg(pc
);
1830 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: `%s`.", leftover
);
1834 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
1842 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1846 poptFreeContext(pc
);
1854 * Prints the run command usage.
1857 void print_run_usage(FILE *fp
)
1859 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] run [OPTIONS]\n");
1861 fprintf(fp
, "Options:\n");
1863 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
1864 fprintf(fp
, " for all the following components until\n");
1865 fprintf(fp
, " --reset-base-params is encountered\n");
1866 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1867 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
1868 fprintf(fp
, " Instantiate the component class CLS of type\n");
1869 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
1870 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
1871 fprintf(fp
, " and optionally name it NAME (you can also\n");
1872 fprintf(fp
, " specify the name with --name)\n");
1873 fprintf(fp
, " -x, --connect=CONNECTION Connect two created components (see the\n");
1874 fprintf(fp
, " expected format of CONNECTION below)\n");
1875 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
1876 fprintf(fp
, " (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
1877 fprintf(fp
, " -n, --name=NAME Set the name of the current component\n");
1878 fprintf(fp
, " to NAME (must be unique amongst all the\n");
1879 fprintf(fp
, " names of the created components)\n");
1880 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1881 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
1882 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1883 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
1884 fprintf(fp
, " current component (see the expected format\n");
1885 fprintf(fp
, " of PARAMS below)\n");
1886 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1887 fprintf(fp
, " dynamic plugins can be loaded\n");
1888 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
1889 fprintf(fp
, " empty map\n");
1890 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
1891 fprintf(fp
, " the graph later, retry in DUR µs\n");
1892 fprintf(fp
, " (default: 100000)\n");
1893 fprintf(fp
, " -h, --help Show this help and quit\n");
1895 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
1896 fprintf(fp
, "\n\n");
1897 fprintf(fp
, "Expected format of CONNECTION\n");
1898 fprintf(fp
, "-----------------------------\n");
1900 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
1902 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
1903 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
1904 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You can set the name of the current\n");
1905 fprintf(fp
, "component with the --name option.\n");
1907 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
1908 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
1909 fprintf(fp
, "When the port is not specified, `*` is used.\n");
1911 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
1912 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
1913 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
1914 fprintf(fp
, "DOWNSTREAM.\n");
1916 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
1917 fprintf(fp
, "which matches anything. You must escape the following characters\n");
1918 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
1920 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
1921 fprintf(fp
, "can connect a filter component to a sink component.\n");
1923 fprintf(fp
, "Examples:\n");
1925 fprintf(fp
, " my-src:my-sink\n");
1926 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
1928 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1929 fprintf(fp
, "babeltrace2 from a shell.\n");
1930 fprintf(fp
, "\n\n");
1931 print_expected_params_format(fp
);
1935 * Creates a Babeltrace config object from the arguments of a run
1938 * *retcode is set to the appropriate exit code to use.
1941 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
1942 int *retcode
, bool force_omit_system_plugin_path
,
1943 bool force_omit_home_plugin_path
,
1944 const bt_value
*initial_plugin_paths
, int default_log_level
)
1946 poptContext pc
= NULL
;
1948 struct bt_config_component
*cur_cfg_comp
= NULL
;
1949 enum bt_config_component_dest cur_cfg_comp_dest
=
1950 BT_CONFIG_COMPONENT_DEST_UNKNOWN
;
1951 bt_value
*cur_base_params
= NULL
;
1953 struct bt_config
*cfg
= NULL
;
1954 bt_value
*instance_names
= NULL
;
1955 bt_value
*connection_args
= NULL
;
1956 char error_buf
[256] = { 0 };
1957 long retry_duration
= -1;
1958 bt_value_map_extend_status extend_status
;
1959 GString
*error_str
= NULL
;
1960 struct poptOption run_long_options
[] = {
1961 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
1962 { "component", 'c', POPT_ARG_STRING
, NULL
, OPT_COMPONENT
, NULL
, NULL
},
1963 { "connect", 'x', POPT_ARG_STRING
, NULL
, OPT_CONNECT
, NULL
, NULL
},
1964 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1965 { "log-level", 'l', POPT_ARG_STRING
, NULL
, OPT_LOG_LEVEL
, NULL
, NULL
},
1966 { "name", 'n', POPT_ARG_STRING
, NULL
, OPT_NAME
, NULL
, NULL
},
1967 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1968 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1969 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
1970 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1971 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
1972 { "retry-duration", '\0', POPT_ARG_LONG
, &retry_duration
, OPT_RETRY_DURATION
, NULL
, NULL
},
1973 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1978 error_str
= g_string_new(NULL
);
1980 BT_CLI_LOGE_APPEND_CAUSE_OOM();
1985 print_run_usage(stdout
);
1990 cfg
= bt_config_run_create(initial_plugin_paths
);
1995 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
1996 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
1997 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
1998 cur_base_params
= bt_value_map_create();
1999 if (!cur_base_params
) {
2000 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2004 instance_names
= bt_value_map_create();
2005 if (!instance_names
) {
2006 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2010 connection_args
= bt_value_array_create();
2011 if (!connection_args
) {
2012 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2016 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
2022 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2023 run_long_options
, POPT_CONTEXT_KEEP_FIRST
);
2025 BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
2029 poptReadDefaultConfig(pc
, 0);
2031 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2032 arg
= poptGetOptArg(pc
);
2035 case OPT_PLUGIN_PATH
:
2036 if (bt_config_append_plugin_paths_check_setuid_setgid(
2037 cfg
->plugin_paths
, arg
)) {
2041 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2042 cfg
->omit_system_plugin_path
= true;
2044 case OPT_OMIT_HOME_PLUGIN_PATH
:
2045 cfg
->omit_home_plugin_path
= true;
2049 enum bt_config_component_dest new_dest
;
2052 ret
= add_run_cfg_comp_check_name(cfg
,
2053 cur_cfg_comp
, cur_cfg_comp_dest
,
2055 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2061 cur_cfg_comp
= bt_config_component_from_arg(arg
,
2063 if (!cur_cfg_comp
) {
2064 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --component option's argument:\n %s",
2069 switch (cur_cfg_comp
->type
) {
2070 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2071 new_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2073 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2074 new_dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
2076 case BT_COMPONENT_CLASS_TYPE_SINK
:
2077 new_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2083 BT_ASSERT(cur_base_params
);
2084 bt_value_put_ref(cur_cfg_comp
->params
);
2085 if (bt_value_copy(cur_base_params
,
2086 &cur_cfg_comp
->params
) < 0) {
2087 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2091 cur_cfg_comp_dest
= new_dest
;
2097 bt_value
*params_to_set
;
2099 if (!cur_cfg_comp
) {
2100 BT_CLI_LOGE_APPEND_CAUSE("Cannot add parameters to unavailable component:\n %s",
2105 params
= cli_value_from_arg(arg
, error_str
);
2107 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --params option's argument:\n %s",
2112 extend_status
= bt_value_map_extend(
2113 cur_cfg_comp
->params
, params
, ¶ms_to_set
);
2114 BT_VALUE_PUT_REF_AND_RESET(params
);
2115 if (extend_status
!= BT_VALUE_MAP_EXTEND_STATUS_OK
) {
2116 BT_CLI_LOGE_APPEND_CAUSE("Cannot extend current component parameters with --params option's argument:\n %s",
2121 BT_OBJECT_MOVE_REF(cur_cfg_comp
->params
, params_to_set
);
2125 if (!cur_cfg_comp
) {
2126 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the name of unavailable component:\n %s",
2131 g_string_assign(cur_cfg_comp
->instance_name
, arg
);
2134 if (!cur_cfg_comp
) {
2135 BT_CLI_LOGE_APPEND_CAUSE("Cannot set the log level of unavailable component:\n %s",
2140 cur_cfg_comp
->log_level
=
2141 bt_log_get_level_from_string(arg
);
2142 if (cur_cfg_comp
->log_level
< 0) {
2143 BT_CLI_LOGE_APPEND_CAUSE("Invalid argument for --log-level option:\n %s",
2148 case OPT_BASE_PARAMS
:
2150 bt_value
*params
= cli_value_from_arg(arg
, error_str
);
2153 BT_CLI_LOGE_APPEND_CAUSE("Invalid format for --base-params option's argument:\n %s",
2158 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
2161 case OPT_RESET_BASE_PARAMS
:
2162 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2163 cur_base_params
= bt_value_map_create();
2164 if (!cur_base_params
) {
2165 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2170 if (bt_value_array_append_string_element(
2171 connection_args
, arg
)) {
2172 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2176 case OPT_RETRY_DURATION
:
2177 if (retry_duration
< 0) {
2178 BT_CLI_LOGE_APPEND_CAUSE("--retry-duration option's argument must be positive or 0: %ld",
2183 cfg
->cmd_data
.run
.retry_duration_us
=
2184 (uint64_t) retry_duration
;
2187 print_run_usage(stdout
);
2189 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2192 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
2201 /* Check for option parsing error */
2203 BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: %s",
2204 poptBadOption(pc
, 0), poptStrerror(opt
));
2208 /* This command does not accept leftover arguments */
2209 if (poptPeekArg(pc
)) {
2210 BT_CLI_LOGE_APPEND_CAUSE("Unexpected argument: %s", poptPeekArg(pc
));
2214 /* Add current component */
2216 ret
= add_run_cfg_comp_check_name(cfg
, cur_cfg_comp
,
2217 cur_cfg_comp_dest
, instance_names
);
2218 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2224 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2225 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no source component.");
2229 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2230 BT_CLI_LOGE_APPEND_CAUSE("Incomplete graph: no sink component.");
2234 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2238 ret
= bt_config_cli_args_create_connections(cfg
,
2242 BT_CLI_LOGE_APPEND_CAUSE("Cannot creation connections:\n%s", error_buf
);
2250 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2254 poptFreeContext(pc
);
2258 g_string_free(error_str
, TRUE
);
2262 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2263 BT_VALUE_PUT_REF_AND_RESET(cur_base_params
);
2264 BT_VALUE_PUT_REF_AND_RESET(instance_names
);
2265 BT_VALUE_PUT_REF_AND_RESET(connection_args
);
2270 struct bt_config
*bt_config_run_from_args_array(const bt_value
*run_args
,
2271 int *retcode
, bool force_omit_system_plugin_path
,
2272 bool force_omit_home_plugin_path
,
2273 const bt_value
*initial_plugin_paths
, int default_log_level
)
2275 struct bt_config
*cfg
= NULL
;
2278 const size_t argc
= bt_value_array_get_size(run_args
);
2280 argv
= calloc(argc
, sizeof(*argv
));
2282 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2286 len
= bt_value_array_get_size(run_args
);
2288 BT_CLI_LOGE_APPEND_CAUSE("Invalid executable arguments.");
2291 for (i
= 0; i
< len
; i
++) {
2292 const bt_value
*arg_value
=
2293 bt_value_array_borrow_element_by_index_const(run_args
,
2297 BT_ASSERT(arg_value
);
2298 arg
= bt_value_string_get(arg_value
);
2303 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2304 force_omit_system_plugin_path
, force_omit_home_plugin_path
,
2305 initial_plugin_paths
, default_log_level
);
2313 * Prints the convert command usage.
2316 void print_convert_usage(FILE *fp
)
2318 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2320 fprintf(fp
, "Options:\n");
2322 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2323 fprintf(fp
, " Instantiate the component class CLS of type\n");
2324 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2325 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2326 fprintf(fp
, " conversion graph, and optionally name it\n");
2327 fprintf(fp
, " NAME (you can also specify the name with\n");
2328 fprintf(fp
, " --name)\n");
2329 fprintf(fp
, " -l, --log-level=LVL Set the log level of the current component to LVL\n");
2330 fprintf(fp
, " (`N`, `V`, `D`, `I`, `W`, `E`, or `F`)\n");
2331 fprintf(fp
, " --name=NAME Set the name of the current component\n");
2332 fprintf(fp
, " to NAME (must be unique amongst all the\n");
2333 fprintf(fp
, " names of the created components)\n");
2334 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2335 fprintf(fp
, " (~/.local/lib/babeltrace2/plugins)\n");
2336 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2337 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2338 fprintf(fp
, " current component (see the expected format\n");
2339 fprintf(fp
, " of PARAMS below)\n");
2340 fprintf(fp
, " -P, --path=PATH Set the `path` string parameter of the\n");
2341 fprintf(fp
, " current component to PATH\n");
2342 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2343 fprintf(fp
, " dynamic plugins can be loaded\n");
2344 fprintf(fp
, " --retry-duration=DUR When babeltrace2(1) needs to retry to run\n");
2345 fprintf(fp
, " the graph later, retry in DUR µs\n");
2346 fprintf(fp
, " (default: 100000)\n");
2347 fprintf(fp
, " dynamic plugins can be loaded\n");
2348 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2349 fprintf(fp
, " `run` command to the standard output,\n");
2350 fprintf(fp
, " formatted for a shell, and quit\n");
2351 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2352 fprintf(fp
, " `run` command to the standard output,\n");
2353 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2354 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2355 fprintf(fp
, " are active\n");
2356 fprintf(fp
, " -u, --url=URL Set the `url` string parameter of the\n");
2357 fprintf(fp
, " current component to URL\n");
2358 fprintf(fp
, " -h, --help Show this help and quit\n");
2360 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2362 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2363 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2365 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2367 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2368 fprintf(fp
, " --clock-date Print timestamp dates\n");
2369 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2370 fprintf(fp
, " time zone instead of the local time zone\n");
2371 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2372 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2373 fprintf(fp
, " --color=(never | auto | always)\n");
2374 fprintf(fp
, " Never, automatically, or always emit\n");
2375 fprintf(fp
, " console color codes\n");
2376 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2377 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2378 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2379 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2380 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2381 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2382 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2383 fprintf(fp
, " (or `ctx`)\n");
2384 fprintf(fp
, " --no-delta Do not print time delta between\n");
2385 fprintf(fp
, " consecutive events\n");
2386 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2387 fprintf(fp
, " the standard output\n");
2389 fprintf(fp
, "Implicit `filter.utils.muxer` component options:\n");
2391 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently\n");
2392 fprintf(fp
, " correlated across traces\n");
2394 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2396 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2397 fprintf(fp
, " time range to BEGIN (see the format of\n");
2398 fprintf(fp
, " BEGIN below)\n");
2399 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2400 fprintf(fp
, " range to END (see the format of END below)\n");
2401 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2402 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2403 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2405 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2407 fprintf(fp
, " --debug-info Create an implicit\n");
2408 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2409 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2410 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2411 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2412 fprintf(fp
, " binary paths instead of just names\n");
2413 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2414 fprintf(fp
, " Use directory DIR as a prefix when\n");
2415 fprintf(fp
, " looking up executables during debug\n");
2416 fprintf(fp
, " info analysis\n");
2418 fprintf(fp
, "Legacy options that still work:\n");
2420 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2421 fprintf(fp
, " `ctf`:\n");
2422 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2423 fprintf(fp
, " component\n");
2424 fprintf(fp
, " `lttng-live`:\n");
2425 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2426 fprintf(fp
, " component\n");
2427 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2428 fprintf(fp
, " `text`:\n");
2429 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2430 fprintf(fp
, " component\n");
2431 fprintf(fp
, " `ctf`:\n");
2432 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2433 fprintf(fp
, " component\n");
2434 fprintf(fp
, " `dummy`:\n");
2435 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2436 fprintf(fp
, " component\n");
2437 fprintf(fp
, " `ctf-metadata`:\n");
2438 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2439 fprintf(fp
, " for metadata text and quit\n");
2441 fprintf(fp
, "See `babeltrace2 --help` for the list of general options.\n");
2442 fprintf(fp
, "\n\n");
2443 fprintf(fp
, "Format of BEGIN and END\n");
2444 fprintf(fp
, "-----------------------\n");
2446 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2447 fprintf(fp
, "\n\n");
2448 print_expected_params_format(fp
);
2452 struct poptOption convert_long_options
[] = {
2453 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2454 { "begin", 'b', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2455 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2456 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2457 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2458 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2459 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2460 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2461 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2462 { "color", '\0', POPT_ARG_STRING
, NULL
, OPT_COLOR
, NULL
, NULL
},
2463 { "component", 'c', POPT_ARG_STRING
, NULL
, OPT_COMPONENT
, NULL
, NULL
},
2464 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2465 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2466 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2467 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2468 { "end", 'e', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2469 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2470 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2471 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2472 { "log-level", 'l', POPT_ARG_STRING
, NULL
, OPT_LOG_LEVEL
, NULL
, NULL
},
2473 { "name", '\0', POPT_ARG_STRING
, NULL
, OPT_NAME
, NULL
, NULL
},
2474 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2475 { "debug-info", '\0', POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO
, NULL
, NULL
},
2476 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2477 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2478 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2479 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT
, NULL
, NULL
},
2480 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2481 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2482 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2483 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2484 { "retry-duration", '\0', POPT_ARG_STRING
, NULL
, OPT_RETRY_DURATION
, NULL
, NULL
},
2485 { "run-args", '\0', POPT_ARG_NONE
, NULL
, OPT_RUN_ARGS
, NULL
, NULL
},
2486 { "run-args-0", '\0', POPT_ARG_NONE
, NULL
, OPT_RUN_ARGS_0
, NULL
, NULL
},
2487 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2488 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2489 { "url", 'u', POPT_ARG_STRING
, NULL
, OPT_URL
, NULL
, NULL
},
2490 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2491 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
2495 GString
*get_component_auto_name(const char *prefix
,
2496 const bt_value
*existing_names
)
2499 GString
*auto_name
= g_string_new(NULL
);
2502 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2506 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2507 g_string_assign(auto_name
, prefix
);
2512 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2514 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2520 struct implicit_component_args
{
2523 /* The component class name (e.g. src.ctf.fs). */
2526 /* The component instance name. */
2529 GString
*params_arg
;
2530 bt_value
*extra_params
;
2534 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2535 const char *prefix
, bt_value
*existing_names
,
2536 GList
**comp_names
, bool append_to_comp_names
)
2539 GString
*name
= NULL
;
2541 if (!args
->exists
) {
2545 name
= get_component_auto_name(prefix
,
2553 g_string_assign(args
->name_arg
, name
->str
);
2555 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2557 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2562 if (append_to_comp_names
) {
2563 *comp_names
= g_list_append(*comp_names
, name
);
2569 g_string_free(name
, TRUE
);
2576 int append_run_args_for_implicit_component(
2577 struct implicit_component_args
*impl_args
,
2583 if (!impl_args
->exists
) {
2587 if (bt_value_array_append_string_element(run_args
, "--component")) {
2588 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2592 if (bt_value_array_append_string_element(run_args
, impl_args
->comp_arg
->str
)) {
2593 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2597 if (bt_value_array_append_string_element(run_args
, "--name")) {
2598 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2602 if (bt_value_array_append_string_element(run_args
, impl_args
->name_arg
->str
)) {
2603 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2607 if (impl_args
->params_arg
->len
> 0) {
2608 if (bt_value_array_append_string_element(run_args
, "--params")) {
2609 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2613 if (bt_value_array_append_string_element(run_args
,
2614 impl_args
->params_arg
->str
)) {
2615 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2620 for (i
= 0; i
< bt_value_array_get_size(impl_args
->extra_params
);
2622 const bt_value
*elem
;
2625 elem
= bt_value_array_borrow_element_by_index(impl_args
->extra_params
,
2631 BT_ASSERT(bt_value_is_string(elem
));
2632 arg
= bt_value_string_get(elem
);
2633 ret
= bt_value_array_append_string_element(run_args
, arg
);
2635 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2649 /* Free the fields of a `struct implicit_component_args`. */
2652 void finalize_implicit_component_args(struct implicit_component_args
*args
)
2656 if (args
->comp_arg
) {
2657 g_string_free(args
->comp_arg
, TRUE
);
2660 if (args
->name_arg
) {
2661 g_string_free(args
->name_arg
, TRUE
);
2664 if (args
->params_arg
) {
2665 g_string_free(args
->params_arg
, TRUE
);
2668 bt_value_put_ref(args
->extra_params
);
2671 /* Destroy a dynamically-allocated `struct implicit_component_args`. */
2674 void destroy_implicit_component_args(struct implicit_component_args
*args
)
2676 finalize_implicit_component_args(args
);
2680 /* Initialize the fields of an already allocated `struct implicit_component_args`. */
2683 int init_implicit_component_args(struct implicit_component_args
*args
,
2684 const char *comp_arg
, bool exists
)
2688 args
->exists
= exists
;
2689 args
->comp_arg
= g_string_new(comp_arg
);
2690 args
->name_arg
= g_string_new(NULL
);
2691 args
->params_arg
= g_string_new(NULL
);
2692 args
->extra_params
= bt_value_array_create();
2694 if (!args
->comp_arg
|| !args
->name_arg
||
2695 !args
->params_arg
|| !args
->extra_params
) {
2697 finalize_implicit_component_args(args
);
2698 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2706 /* Dynamically allocate and initialize a `struct implicit_component_args`. */
2709 struct implicit_component_args
*create_implicit_component_args(
2710 const char *comp_arg
)
2712 struct implicit_component_args
*args
;
2715 args
= g_new(struct implicit_component_args
, 1);
2717 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2721 status
= init_implicit_component_args(args
, comp_arg
, true);
2732 void append_implicit_component_param(struct implicit_component_args
*args
,
2733 const char *key
, const char *value
)
2738 append_param_arg(args
->params_arg
, key
, value
);
2742 * Append the given parameter (`key=value`) to all component specifications
2743 * in `implicit_comp_args` (an array of `struct implicit_component_args *`)
2744 * which match `comp_arg`.
2746 * Return the number of matching components.
2750 int append_multiple_implicit_components_param(GPtrArray
*implicit_comp_args
,
2751 const char *comp_arg
, const char *key
, const char *value
)
2756 for (i
= 0; i
< implicit_comp_args
->len
; i
++) {
2757 struct implicit_component_args
*args
= implicit_comp_args
->pdata
[i
];
2759 if (strcmp(args
->comp_arg
->str
, comp_arg
) == 0) {
2760 append_implicit_component_param(args
, key
, value
);
2768 /* Escape value to make it suitable to use as a string parameter value. */
2770 gchar
*escape_string_value(const char *value
)
2775 ret
= g_string_new(NULL
);
2777 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2786 g_string_append_c(ret
, '\\');
2790 g_string_append_c(ret
, *in
);
2796 return g_string_free(ret
, FALSE
);
2800 int bt_value_to_cli_param_value_append(const bt_value
*value
, GString
*buf
)
2806 switch (bt_value_get_type(value
)) {
2807 case BT_VALUE_TYPE_STRING
:
2809 const char *str_value
= bt_value_string_get(value
);
2810 gchar
*escaped_str_value
;
2812 escaped_str_value
= escape_string_value(str_value
);
2813 if (!escaped_str_value
) {
2817 g_string_append_printf(buf
, "\"%s\"", escaped_str_value
);
2819 g_free(escaped_str_value
);
2822 case BT_VALUE_TYPE_ARRAY
: {
2823 g_string_append_c(buf
, '[');
2824 uint64_t sz
= bt_value_array_get_size(value
);
2825 for (uint64_t i
= 0; i
< sz
; i
++) {
2826 const bt_value
*item
;
2830 g_string_append(buf
, ", ");
2833 item
= bt_value_array_borrow_element_by_index_const(
2835 ret
= bt_value_to_cli_param_value_append(item
, buf
);
2841 g_string_append_c(buf
, ']');
2855 * Convert `value` to its equivalent representation as a command line parameter
2860 gchar
*bt_value_to_cli_param_value(bt_value
*value
)
2863 gchar
*result
= NULL
;
2865 buf
= g_string_new(NULL
);
2867 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2871 if (bt_value_to_cli_param_value_append(value
, buf
)) {
2875 result
= g_string_free(buf
, FALSE
);
2882 g_string_free(buf
, TRUE
);
2890 int append_parameter_to_args(bt_value
*args
, const char *key
, bt_value
*value
)
2893 BT_ASSERT(bt_value_get_type(args
) == BT_VALUE_TYPE_ARRAY
);
2898 gchar
*str_value
= NULL
;
2899 GString
*parameter
= NULL
;
2901 if (bt_value_array_append_string_element(args
, "--params")) {
2902 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2907 str_value
= bt_value_to_cli_param_value(value
);
2913 parameter
= g_string_new(NULL
);
2915 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2920 g_string_printf(parameter
, "%s=%s", key
, str_value
);
2922 if (bt_value_array_append_string_element(args
, parameter
->str
)) {
2923 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2930 g_string_free(parameter
, TRUE
);
2943 int append_string_parameter_to_args(bt_value
*args
, const char *key
, const char *value
)
2945 bt_value
*str_value
;
2948 str_value
= bt_value_string_create_init(value
);
2951 BT_CLI_LOGE_APPEND_CAUSE_OOM();
2956 ret
= append_parameter_to_args(args
, key
, str_value
);
2959 BT_VALUE_PUT_REF_AND_RESET(str_value
);
2964 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
2965 const char *key
, const char *value
)
2967 return append_string_parameter_to_args(args
->extra_params
, key
, value
);
2971 int convert_append_name_param(enum bt_config_component_dest dest
,
2972 GString
*cur_name
, GString
*cur_name_prefix
,
2974 bt_value
*all_names
,
2975 GList
**source_names
, GList
**filter_names
,
2980 if (cur_name_prefix
->len
> 0) {
2981 /* We're after a --component option */
2982 GString
*name
= NULL
;
2983 bool append_name_opt
= false;
2985 if (cur_name
->len
== 0) {
2987 * No explicit name was provided for the user
2990 name
= get_component_auto_name(cur_name_prefix
->str
,
2992 append_name_opt
= true;
2995 * An explicit name was provided for the user
2998 if (bt_value_map_has_entry(all_names
,
3000 BT_CLI_LOGE_APPEND_CAUSE("Duplicate component instance name:\n %s",
3005 name
= g_string_new(cur_name
->str
);
3009 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3014 * Remember this name globally, for the uniqueness of
3015 * all component names.
3017 if (bt_value_map_insert_entry(all_names
, name
->str
, bt_value_null
)) {
3018 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3023 * Append the --name option if necessary.
3025 if (append_name_opt
) {
3026 if (bt_value_array_append_string_element(run_args
, "--name")) {
3027 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3031 if (bt_value_array_append_string_element(run_args
, name
->str
)) {
3032 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3038 * Remember this name specifically for the type of the
3039 * component. This is to create connection arguments.
3042 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
3043 *source_names
= g_list_append(*source_names
, name
);
3045 case BT_CONFIG_COMPONENT_DEST_FILTER
:
3046 *filter_names
= g_list_append(*filter_names
, name
);
3048 case BT_CONFIG_COMPONENT_DEST_SINK
:
3049 *sink_names
= g_list_append(*sink_names
, name
);
3055 g_string_assign(cur_name_prefix
, "");
3068 * Escapes `.`, `:`, and `\` of `input` with `\`.
3071 GString
*escape_dot_colon(const char *input
)
3073 GString
*output
= g_string_new(NULL
);
3077 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3081 for (ch
= input
; *ch
!= '\0'; ch
++) {
3082 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
3083 g_string_append_c(output
, '\\');
3086 g_string_append_c(output
, *ch
);
3094 * Appends a --connect option to a list of arguments. `upstream_name`
3095 * and `downstream_name` are escaped with escape_dot_colon() in this
3099 int append_connect_arg(bt_value
*run_args
,
3100 const char *upstream_name
, const char *downstream_name
)
3103 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
3104 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
3105 GString
*arg
= g_string_new(NULL
);
3107 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
3108 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3113 ret
= bt_value_array_append_string_element(run_args
, "--connect");
3115 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3120 g_string_append(arg
, e_upstream_name
->str
);
3121 g_string_append_c(arg
, ':');
3122 g_string_append(arg
, e_downstream_name
->str
);
3123 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
3125 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3132 g_string_free(arg
, TRUE
);
3135 if (e_upstream_name
) {
3136 g_string_free(e_upstream_name
, TRUE
);
3139 if (e_downstream_name
) {
3140 g_string_free(e_downstream_name
, TRUE
);
3147 * Appends the run command's --connect options for the convert command.
3150 int convert_auto_connect(bt_value
*run_args
,
3151 GList
*source_names
, GList
*filter_names
,
3155 GList
*source_at
= source_names
;
3156 GList
*filter_at
= filter_names
;
3158 GList
*sink_at
= sink_names
;
3160 BT_ASSERT(source_names
);
3161 BT_ASSERT(filter_names
);
3162 BT_ASSERT(sink_names
);
3164 /* Connect all sources to the first filter */
3165 for (source_at
= source_names
; source_at
; source_at
= g_list_next(source_at
)) {
3166 GString
*source_name
= source_at
->data
;
3167 GString
*filter_name
= filter_at
->data
;
3169 ret
= append_connect_arg(run_args
, source_name
->str
,
3176 filter_prev
= filter_at
;
3177 filter_at
= g_list_next(filter_at
);
3179 /* Connect remaining filters */
3180 for (; filter_at
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
3181 GString
*filter_name
= filter_at
->data
;
3182 GString
*filter_prev_name
= filter_prev
->data
;
3184 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
3191 /* Connect last filter to all sinks */
3192 for (sink_at
= sink_names
; sink_at
; sink_at
= g_list_next(sink_at
)) {
3193 GString
*filter_name
= filter_prev
->data
;
3194 GString
*sink_name
= sink_at
->data
;
3196 ret
= append_connect_arg(run_args
, filter_name
->str
,
3213 int split_timerange(const char *arg
, char **begin
, char **end
)
3216 const char *ch
= arg
;
3218 GString
*g_begin
= NULL
;
3219 GString
*g_end
= NULL
;
3227 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
3228 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
3234 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
3235 if (!g_end
|| g_end
->len
== 0) {
3241 *begin
= g_begin
->str
;
3243 g_string_free(g_begin
, FALSE
);
3244 g_string_free(g_end
, FALSE
);
3254 g_string_free(g_begin
, TRUE
);
3258 g_string_free(g_end
, TRUE
);
3265 int g_list_prepend_gstring(GList
**list
, const char *string
)
3268 GString
*gs
= g_string_new(string
);
3273 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3277 *list
= g_list_prepend(*list
, gs
);
3284 * Create `struct implicit_component_args` structures for each of the source
3285 * components we identified. Add them to `component_args`.
3289 void create_implicit_component_args_from_auto_discovered_sources(
3290 const struct auto_source_discovery
*auto_disc
, GPtrArray
*component_args
)
3292 gchar
*cc_name
= NULL
;
3293 struct implicit_component_args
*comp
= NULL
;
3297 len
= auto_disc
->results
->len
;
3299 for (i
= 0; i
< len
; i
++) {
3300 struct auto_source_discovery_result
*res
=
3301 g_ptr_array_index(auto_disc
->results
, i
);
3304 cc_name
= g_strdup_printf("source.%s.%s", res
->plugin_name
, res
->source_cc_name
);
3306 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3310 comp
= create_implicit_component_args(cc_name
);
3315 status
= append_parameter_to_args(comp
->extra_params
, "inputs", res
->inputs
);
3320 g_ptr_array_add(component_args
, comp
);
3328 destroy_implicit_component_args(comp
);
3333 * Creates a Babeltrace config object from the arguments of a convert
3336 * *retcode is set to the appropriate exit code to use.
3339 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3340 int *retcode
, bool force_omit_system_plugin_path
,
3341 bool force_omit_home_plugin_path
,
3342 const bt_value
*initial_plugin_paths
, int *default_log_level
)
3344 poptContext pc
= NULL
;
3346 enum bt_config_component_dest cur_comp_dest
=
3347 BT_CONFIG_COMPONENT_DEST_UNKNOWN
;
3349 struct bt_config
*cfg
= NULL
;
3350 bool got_input_format_opt
= false;
3351 bool got_output_format_opt
= false;
3352 bool trimmer_has_begin
= false;
3353 bool trimmer_has_end
= false;
3354 bool stream_intersection_mode
= false;
3355 GString
*cur_name
= NULL
;
3356 GString
*cur_name_prefix
= NULL
;
3357 const char *leftover
= NULL
;
3358 bool print_run_args
= false;
3359 bool print_run_args_0
= false;
3360 bool print_ctf_metadata
= false;
3361 bt_value
*run_args
= NULL
;
3362 bt_value
*all_names
= NULL
;
3363 GList
*source_names
= NULL
;
3364 GList
*filter_names
= NULL
;
3365 GList
*sink_names
= NULL
;
3366 bt_value
*leftovers
= NULL
;
3367 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3368 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3369 struct implicit_component_args implicit_dummy_args
= { 0 };
3370 struct implicit_component_args implicit_text_args
= { 0 };
3371 struct implicit_component_args implicit_debug_info_args
= { 0 };
3372 struct implicit_component_args implicit_muxer_args
= { 0 };
3373 struct implicit_component_args implicit_trimmer_args
= { 0 };
3374 bt_value
*plugin_paths
;
3375 char error_buf
[256] = { 0 };
3377 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3378 char *output
= NULL
;
3379 struct auto_source_discovery auto_disc
= { NULL
};
3380 GString
*auto_disc_comp_name
= NULL
;
3383 * Array of `struct implicit_component_args *` created for the sources
3384 * we have auto-discovered.
3386 GPtrArray
*discovered_source_args
= NULL
;
3389 * If set, restrict automatic source discovery to this component class
3392 const char *auto_source_discovery_restrict_plugin_name
= NULL
;
3393 const char *auto_source_discovery_restrict_component_class_name
= NULL
;
3395 gchar
*ctf_fs_source_clock_class_offset_arg
= NULL
;
3396 gchar
*ctf_fs_source_clock_class_offset_ns_arg
= NULL
;
3398 (void) bt_value_copy(initial_plugin_paths
, &plugin_paths
);
3403 print_convert_usage(stdout
);
3408 if (init_implicit_component_args(&implicit_ctf_output_args
,
3409 "sink.ctf.fs", false)) {
3413 if (init_implicit_component_args(&implicit_lttng_live_args
,
3414 "source.ctf.lttng-live", false)) {
3418 if (init_implicit_component_args(&implicit_text_args
,
3419 "sink.text.pretty", false)) {
3423 if (init_implicit_component_args(&implicit_dummy_args
,
3424 "sink.utils.dummy", false)) {
3428 if (init_implicit_component_args(&implicit_debug_info_args
,
3429 "filter.lttng-utils.debug-info", false)) {
3433 if (init_implicit_component_args(&implicit_muxer_args
,
3434 "filter.utils.muxer", true)) {
3438 if (init_implicit_component_args(&implicit_trimmer_args
,
3439 "filter.utils.trimmer", false)) {
3443 all_names
= bt_value_map_create();
3445 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3449 run_args
= bt_value_array_create();
3451 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3455 cur_name
= g_string_new(NULL
);
3457 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3461 cur_name_prefix
= g_string_new(NULL
);
3462 if (!cur_name_prefix
) {
3463 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3467 ret
= append_env_var_plugin_paths(plugin_paths
);
3472 leftovers
= bt_value_array_create();
3474 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3478 if (auto_source_discovery_init(&auto_disc
) != 0) {
3482 discovered_source_args
=
3483 g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_implicit_component_args
);
3484 if (!discovered_source_args
) {
3485 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3489 auto_disc_comp_name
= g_string_new(NULL
);
3490 if (!auto_disc_comp_name
) {
3491 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3496 * First pass: collect all arguments which need to be passed
3497 * as is to the run command. This pass can also add --name
3498 * arguments if needed to automatically name unnamed component
3499 * instances. Also it does the following transformations:
3501 * --path=PATH -> --params=path="PATH"
3502 * --url=URL -> --params=url="URL"
3504 * Also it appends the plugin paths of --plugin-path to
3507 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
3508 convert_long_options
, POPT_CONTEXT_KEEP_FIRST
);
3510 BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
3514 poptReadDefaultConfig(pc
, 0);
3516 while ((opt
= poptGetNextOpt(pc
)) > 0) {
3518 char *plugin_name
= NULL
;
3519 char *comp_cls_name
= NULL
;
3521 arg
= poptGetOptArg(pc
);
3526 bt_component_class_type type
;
3527 const char *type_prefix
;
3529 /* Append current component's name if needed */
3530 ret
= convert_append_name_param(cur_comp_dest
, cur_name
,
3531 cur_name_prefix
, run_args
, all_names
,
3532 &source_names
, &filter_names
, &sink_names
);
3537 /* Parse the argument */
3538 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3539 &comp_cls_name
, &type
);
3540 if (!plugin_name
|| !comp_cls_name
) {
3541 BT_CLI_LOGE_APPEND_CAUSE(
3542 "Invalid format for --component option's argument:\n %s",
3548 g_string_assign(cur_name
, name
);
3550 g_string_assign(cur_name
, "");
3554 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3555 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
3556 type_prefix
= "source";
3558 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3559 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
3560 type_prefix
= "filter";
3562 case BT_COMPONENT_CLASS_TYPE_SINK
:
3563 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
3564 type_prefix
= "sink";
3570 if (bt_value_array_append_string_element(run_args
,
3572 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3576 if (bt_value_array_append_string_element(run_args
, arg
)) {
3577 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3581 g_string_assign(cur_name_prefix
, "");
3582 g_string_append_printf(cur_name_prefix
, "%s.%s.%s",
3583 type_prefix
, plugin_name
, comp_cls_name
);
3586 free(comp_cls_name
);
3589 comp_cls_name
= NULL
;
3593 if (cur_name_prefix
->len
== 0) {
3594 BT_CLI_LOGE_APPEND_CAUSE("No current component of which to set parameters:\n %s",
3599 if (bt_value_array_append_string_element(run_args
,
3601 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3605 if (bt_value_array_append_string_element(run_args
, arg
)) {
3606 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3611 if (cur_name_prefix
->len
== 0) {
3612 BT_CLI_LOGE_APPEND_CAUSE("No current component of which to set `path` parameter:\n %s",
3617 if (append_string_parameter_to_args(run_args
, "path", arg
)) {
3622 if (cur_name_prefix
->len
== 0) {
3623 BT_CLI_LOGE_APPEND_CAUSE("No current component of which to set `url` parameter:\n %s",
3629 if (append_string_parameter_to_args(run_args
, "url", arg
)) {
3634 if (cur_name_prefix
->len
== 0) {
3635 BT_CLI_LOGE_APPEND_CAUSE("No current component to name:\n %s",
3640 if (bt_value_array_append_string_element(run_args
, "--name")) {
3641 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3645 if (bt_value_array_append_string_element(run_args
, arg
)) {
3646 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3650 g_string_assign(cur_name
, arg
);
3653 if (cur_name_prefix
->len
== 0) {
3654 BT_CLI_LOGE_APPEND_CAUSE("No current component to assign a log level to:\n %s",
3659 if (bt_value_array_append_string_element(run_args
, "--log-level")) {
3660 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3664 if (bt_value_array_append_string_element(run_args
, arg
)) {
3665 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3670 case OPT_OMIT_HOME_PLUGIN_PATH
:
3671 force_omit_home_plugin_path
= true;
3673 if (bt_value_array_append_string_element(run_args
,
3674 "--omit-home-plugin-path")) {
3675 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3679 case OPT_RETRY_DURATION
:
3680 if (bt_value_array_append_string_element(run_args
,
3681 "--retry-duration")) {
3682 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3686 if (bt_value_array_append_string_element(run_args
, arg
)) {
3687 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3691 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
3692 force_omit_system_plugin_path
= true;
3694 if (bt_value_array_append_string_element(run_args
,
3695 "--omit-system-plugin-path")) {
3696 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3700 case OPT_PLUGIN_PATH
:
3701 if (bt_config_append_plugin_paths_check_setuid_setgid(
3702 plugin_paths
, arg
)) {
3706 if (bt_value_array_append_string_element(run_args
,
3708 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3712 if (bt_value_array_append_string_element(run_args
, arg
)) {
3713 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3718 print_convert_usage(stdout
);
3720 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3723 case OPT_CLOCK_CYCLES
:
3724 case OPT_CLOCK_DATE
:
3725 case OPT_CLOCK_FORCE_CORRELATE
:
3727 case OPT_CLOCK_OFFSET
:
3728 case OPT_CLOCK_OFFSET_NS
:
3729 case OPT_CLOCK_SECONDS
:
3732 case OPT_DEBUG_INFO
:
3733 case OPT_DEBUG_INFO_DIR
:
3734 case OPT_DEBUG_INFO_FULL_PATH
:
3735 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3738 case OPT_INPUT_FORMAT
:
3741 case OPT_OUTPUT_FORMAT
:
3744 case OPT_RUN_ARGS_0
:
3745 case OPT_STREAM_INTERSECTION
:
3748 /* Ignore in this pass */
3751 BT_CLI_LOGE_APPEND_CAUSE("Unknown command-line option specified (option code %d).",
3760 /* Append current component's name if needed */
3761 ret
= convert_append_name_param(cur_comp_dest
, cur_name
,
3762 cur_name_prefix
, run_args
, all_names
, &source_names
,
3763 &filter_names
, &sink_names
);
3768 /* Check for option parsing error */
3770 BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option `%s`: %s.",
3771 poptBadOption(pc
, 0), poptStrerror(opt
));
3775 poptFreeContext(pc
);
3780 * Second pass: transform the convert-specific options and
3781 * arguments into implicit component instances for the run
3784 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
3785 convert_long_options
, POPT_CONTEXT_KEEP_FIRST
);
3787 BT_CLI_LOGE_APPEND_CAUSE("Cannot get popt context.");
3791 poptReadDefaultConfig(pc
, 0);
3793 while ((opt
= poptGetNextOpt(pc
)) > 0) {
3794 arg
= poptGetOptArg(pc
);
3798 if (trimmer_has_begin
) {
3799 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
3804 trimmer_has_begin
= true;
3805 ret
= append_implicit_component_extra_param(
3806 &implicit_trimmer_args
, "begin", arg
);
3807 implicit_trimmer_args
.exists
= true;
3813 if (trimmer_has_end
) {
3814 printf("At --end option: --end or --timerange option already specified\n %s\n",
3819 trimmer_has_end
= true;
3820 ret
= append_implicit_component_extra_param(
3821 &implicit_trimmer_args
, "end", arg
);
3822 implicit_trimmer_args
.exists
= true;
3832 if (trimmer_has_begin
|| trimmer_has_end
) {
3833 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
3838 ret
= split_timerange(arg
, &begin
, &end
);
3840 BT_CLI_LOGE_APPEND_CAUSE("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s",
3845 ret
= append_implicit_component_extra_param(
3846 &implicit_trimmer_args
, "begin", begin
);
3847 ret
|= append_implicit_component_extra_param(
3848 &implicit_trimmer_args
, "end", end
);
3849 implicit_trimmer_args
.exists
= true;
3857 case OPT_CLOCK_CYCLES
:
3858 append_implicit_component_param(
3859 &implicit_text_args
, "clock-cycles", "yes");
3860 implicit_text_args
.exists
= true;
3862 case OPT_CLOCK_DATE
:
3863 append_implicit_component_param(
3864 &implicit_text_args
, "clock-date", "yes");
3865 implicit_text_args
.exists
= true;
3867 case OPT_CLOCK_FORCE_CORRELATE
:
3868 append_implicit_component_param(
3869 &implicit_muxer_args
,
3870 "assume-absolute-clock-classes", "yes");
3873 append_implicit_component_param(
3874 &implicit_text_args
, "clock-gmt", "yes");
3875 append_implicit_component_param(
3876 &implicit_trimmer_args
, "gmt", "yes");
3877 implicit_text_args
.exists
= true;
3879 case OPT_CLOCK_OFFSET
:
3880 if (ctf_fs_source_clock_class_offset_arg
) {
3881 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset option\n");
3885 ctf_fs_source_clock_class_offset_arg
= g_strdup(arg
);
3886 if (!ctf_fs_source_clock_class_offset_arg
) {
3887 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3891 case OPT_CLOCK_OFFSET_NS
:
3892 if (ctf_fs_source_clock_class_offset_ns_arg
) {
3893 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --clock-offset-ns option\n");
3897 ctf_fs_source_clock_class_offset_ns_arg
= g_strdup(arg
);
3898 if (!ctf_fs_source_clock_class_offset_ns_arg
) {
3899 BT_CLI_LOGE_APPEND_CAUSE_OOM();
3903 case OPT_CLOCK_SECONDS
:
3904 append_implicit_component_param(
3905 &implicit_text_args
, "clock-seconds", "yes");
3906 implicit_text_args
.exists
= true;
3909 implicit_text_args
.exists
= true;
3910 ret
= append_implicit_component_extra_param(
3911 &implicit_text_args
, "color", arg
);
3916 case OPT_DEBUG_INFO
:
3917 implicit_debug_info_args
.exists
= true;
3919 case OPT_DEBUG_INFO_DIR
:
3920 implicit_debug_info_args
.exists
= true;
3921 ret
= append_implicit_component_extra_param(
3922 &implicit_debug_info_args
, "debug-info-dir", arg
);
3927 case OPT_DEBUG_INFO_FULL_PATH
:
3928 implicit_debug_info_args
.exists
= true;
3929 append_implicit_component_param(
3930 &implicit_debug_info_args
, "full-path", "yes");
3932 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3933 implicit_debug_info_args
.exists
= true;
3934 ret
= append_implicit_component_extra_param(
3935 &implicit_debug_info_args
,
3936 "target-prefix", arg
);
3943 bt_value
*fields
= fields_from_arg(arg
);
3949 implicit_text_args
.exists
= true;
3950 ret
= insert_flat_params_from_array(
3951 implicit_text_args
.params_arg
,
3953 bt_value_put_ref(fields
);
3961 bt_value
*names
= names_from_arg(arg
);
3967 implicit_text_args
.exists
= true;
3968 ret
= insert_flat_params_from_array(
3969 implicit_text_args
.params_arg
,
3971 bt_value_put_ref(names
);
3978 append_implicit_component_param(
3979 &implicit_text_args
, "no-delta", "yes");
3980 implicit_text_args
.exists
= true;
3982 case OPT_INPUT_FORMAT
:
3983 if (got_input_format_opt
) {
3984 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --input-format option.");
3988 got_input_format_opt
= true;
3990 if (strcmp(arg
, "ctf") == 0) {
3991 auto_source_discovery_restrict_plugin_name
= "ctf";
3992 auto_source_discovery_restrict_component_class_name
= "fs";
3993 } else if (strcmp(arg
, "lttng-live") == 0) {
3994 auto_source_discovery_restrict_plugin_name
= "ctf";
3995 auto_source_discovery_restrict_component_class_name
= "lttng-live";
3996 implicit_lttng_live_args
.exists
= true;
3998 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy input format:\n %s",
4003 case OPT_OUTPUT_FORMAT
:
4004 if (got_output_format_opt
) {
4005 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output-format option.");
4009 got_output_format_opt
= true;
4011 if (strcmp(arg
, "text") == 0) {
4012 implicit_text_args
.exists
= true;
4013 } else if (strcmp(arg
, "ctf") == 0) {
4014 implicit_ctf_output_args
.exists
= true;
4015 } else if (strcmp(arg
, "dummy") == 0) {
4016 implicit_dummy_args
.exists
= true;
4017 } else if (strcmp(arg
, "ctf-metadata") == 0) {
4018 print_ctf_metadata
= true;
4020 BT_CLI_LOGE_APPEND_CAUSE("Unknown legacy output format:\n %s",
4027 BT_CLI_LOGE_APPEND_CAUSE("Duplicate --output option");
4031 output
= strdup(arg
);
4033 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4038 if (print_run_args_0
) {
4039 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
4043 print_run_args
= true;
4045 case OPT_RUN_ARGS_0
:
4046 if (print_run_args
) {
4047 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --run-args and --run-args-0.");
4051 print_run_args_0
= true;
4053 case OPT_STREAM_INTERSECTION
:
4055 * Applies to all traces implementing the
4056 * babeltrace.trace-info query.
4058 stream_intersection_mode
= true;
4061 if (*default_log_level
!= BT_LOG_TRACE
&&
4062 *default_log_level
!= BT_LOG_DEBUG
) {
4063 *default_log_level
= BT_LOG_INFO
;
4067 *default_log_level
= BT_LOG_TRACE
;
4077 /* Check for option parsing error */
4079 BT_CLI_LOGE_APPEND_CAUSE("While parsing command-line options, at option %s: %s",
4080 poptBadOption(pc
, 0), poptStrerror(opt
));
4085 * Legacy behaviour: --verbose used to make the `text` output
4086 * format print more information. --verbose is now equivalent to
4087 * the INFO log level, which is why we compare to `BT_LOG_INFO`
4090 if (*default_log_level
== BT_LOG_INFO
) {
4091 append_implicit_component_param(&implicit_text_args
,
4096 * Append home and system plugin paths now that we possibly got
4099 if (append_home_and_system_plugin_paths(plugin_paths
,
4100 force_omit_system_plugin_path
,
4101 force_omit_home_plugin_path
)) {
4105 /* Consume and keep leftover arguments */
4106 while ((leftover
= poptGetArg(pc
))) {
4107 if (bt_value_array_append_string_element(leftovers
, leftover
) !=
4108 BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
4109 BT_CLI_LOGE_APPEND_CAUSE_OOM();
4114 /* Print CTF metadata or print LTTng live sessions */
4115 if (print_ctf_metadata
) {
4116 const bt_value
*bt_val_leftover
;
4118 if (bt_value_array_is_empty(leftovers
)) {
4119 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf-metadata specified without a path.");
4123 if (bt_value_array_get_size(leftovers
) > 1) {
4124 BT_CLI_LOGE_APPEND_CAUSE("Too many paths specified for --output-format=ctf-metadata.");
4128 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
4133 bt_val_leftover
= bt_value_array_borrow_element_by_index_const(leftovers
, 0);
4134 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
4135 bt_value_string_get(bt_val_leftover
));
4139 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
4147 * If -o ctf was specified, make sure an output path (--output)
4148 * was also specified. --output does not imply -o ctf because
4149 * it's also used for the default, implicit -o text if -o ctf
4152 if (implicit_ctf_output_args
.exists
) {
4154 BT_CLI_LOGE_APPEND_CAUSE("--output-format=ctf specified without --output (trace output path).");
4159 * At this point we know that -o ctf AND --output were
4160 * specified. Make sure that no options were specified
4161 * which would imply -o text because --output would be
4162 * ambiguous in this case. For example, this is wrong:
4164 * babeltrace2 --names=all -o ctf --output=/tmp/path my-trace
4166 * because --names=all implies -o text, and --output
4167 * could apply to both the sink.text.pretty and
4168 * sink.ctf.fs implicit components.
4170 if (implicit_text_args
.exists
) {
4171 BT_CLI_LOGE_APPEND_CAUSE("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text.");
4177 * If -o dummy and -o ctf were not specified, and if there are
4178 * no explicit sink components, then use an implicit
4179 * `sink.text.pretty` component.
4181 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
4183 implicit_text_args
.exists
= true;
4187 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4188 * `path` parameter if --output was specified.
4191 if (implicit_text_args
.exists
) {
4192 append_implicit_component_extra_param(&implicit_text_args
,
4194 } else if (implicit_ctf_output_args
.exists
) {
4195 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4200 /* Decide where the leftover argument(s) go */
4201 if (bt_value_array_get_size(leftovers
) > 0) {
4202 if (implicit_lttng_live_args
.exists
) {
4203 const bt_value
*bt_val_leftover
;
4205 if (bt_value_array_get_size(leftovers
) > 1) {
4206 BT_CLI_LOGE_APPEND_CAUSE("Too many URLs specified for --input-format=lttng-live.");
4210 bt_val_leftover
= bt_value_array_borrow_element_by_index_const(leftovers
, 0);
4211 lttng_live_url_parts
=
4212 bt_common_parse_lttng_live_url(bt_value_string_get(bt_val_leftover
),
4213 error_buf
, sizeof(error_buf
));
4214 if (!lttng_live_url_parts
.proto
) {
4215 BT_CLI_LOGE_APPEND_CAUSE("Invalid LTTng live URL format: %s.",
4220 if (!lttng_live_url_parts
.session_name
) {
4221 /* Print LTTng live sessions */
4222 cfg
= bt_config_print_lttng_live_sessions_create(
4228 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4229 bt_value_string_get(bt_val_leftover
));
4233 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4240 ret
= append_implicit_component_extra_param(
4241 &implicit_lttng_live_args
, "url",
4242 bt_value_string_get(bt_val_leftover
));
4247 ret
= append_implicit_component_extra_param(
4248 &implicit_lttng_live_args
,
4249 "session-not-found-action", "end");
4256 status
= auto_discover_source_components(plugin_paths
, leftovers
,
4257 auto_source_discovery_restrict_plugin_name
,
4258 auto_source_discovery_restrict_component_class_name
,
4259 *default_log_level
>= 0 ? *default_log_level
: cli_default_log_level
,
4266 create_implicit_component_args_from_auto_discovered_sources(
4267 &auto_disc
, discovered_source_args
);
4271 /* If --clock-offset was given, apply it to any src.ctf.fs component. */
4272 if (ctf_fs_source_clock_class_offset_arg
) {
4275 n
= append_multiple_implicit_components_param(
4276 discovered_source_args
, "source.ctf.fs", "clock-class-offset-s",
4277 ctf_fs_source_clock_class_offset_arg
);
4280 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset specified, but no source.ctf.fs component instantiated.");
4285 /* If --clock-offset-ns was given, apply it to any src.ctf.fs component. */
4286 if (ctf_fs_source_clock_class_offset_ns_arg
) {
4289 n
= append_multiple_implicit_components_param(
4290 discovered_source_args
, "source.ctf.fs", "clock-class-offset-ns",
4291 ctf_fs_source_clock_class_offset_ns_arg
);
4294 BT_CLI_LOGE_APPEND_CAUSE("--clock-offset-ns specified, but no source.ctf.fs component instantiated.");
4300 * If the implicit `source.ctf.lttng-live` component exists, make sure
4301 * there's at least one leftover (which is the URL).
4303 if (implicit_lttng_live_args
.exists
&& bt_value_array_is_empty(leftovers
)) {
4304 BT_CLI_LOGE_APPEND_CAUSE("Missing URL for implicit `%s` component.",
4305 implicit_lttng_live_args
.comp_arg
->str
);
4309 /* Assign names to implicit components */
4310 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4311 struct implicit_component_args
*args
;
4314 args
= discovered_source_args
->pdata
[i
];
4316 g_string_printf(auto_disc_comp_name
, "auto-disc-%s", args
->comp_arg
->str
);
4318 /* Give it a name like `auto-disc-src-ctf-fs`. */
4319 for (j
= 0; j
< auto_disc_comp_name
->len
; j
++) {
4320 if (auto_disc_comp_name
->str
[j
] == '.') {
4321 auto_disc_comp_name
->str
[j
] = '-';
4325 ret
= assign_name_to_implicit_component(args
,
4326 auto_disc_comp_name
->str
, all_names
, &source_names
, true);
4332 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4333 "lttng-live", all_names
, &source_names
, true);
4338 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4339 "pretty", all_names
, &sink_names
, true);
4344 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4345 "sink-ctf-fs", all_names
, &sink_names
, true);
4350 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4351 "dummy", all_names
, &sink_names
, true);
4356 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4357 "muxer", all_names
, NULL
, false);
4362 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4363 "trimmer", all_names
, NULL
, false);
4368 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4369 "debug-info", all_names
, NULL
, false);
4374 /* Make sure there's at least one source and one sink */
4375 if (!source_names
) {
4376 BT_CLI_LOGE_APPEND_CAUSE("No source component.");
4381 BT_CLI_LOGE_APPEND_CAUSE("No sink component.");
4386 * Prepend the muxer, the trimmer, and the debug info to the
4387 * filter chain so that we have:
4389 * sources -> muxer -> [trimmer] -> [debug info] ->
4390 * [user filters] -> sinks
4392 if (implicit_debug_info_args
.exists
) {
4393 if (g_list_prepend_gstring(&filter_names
,
4394 implicit_debug_info_args
.name_arg
->str
)) {
4399 if (implicit_trimmer_args
.exists
) {
4400 if (g_list_prepend_gstring(&filter_names
,
4401 implicit_trimmer_args
.name_arg
->str
)) {
4406 if (g_list_prepend_gstring(&filter_names
,
4407 implicit_muxer_args
.name_arg
->str
)) {
4412 * Append the equivalent run arguments for the implicit
4415 for (i
= 0; i
< discovered_source_args
->len
; i
++) {
4416 struct implicit_component_args
*args
=
4417 discovered_source_args
->pdata
[i
];
4419 ret
= append_run_args_for_implicit_component(args
, run_args
);
4425 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4431 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4437 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4443 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4449 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4455 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4461 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4467 /* Auto-connect components */
4468 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4471 BT_CLI_LOGE_APPEND_CAUSE("Cannot auto-connect components.");
4476 * We have all the run command arguments now. Depending on
4477 * --run-args, we pass this to the run command or print them
4480 if (print_run_args
|| print_run_args_0
) {
4481 if (stream_intersection_mode
) {
4482 BT_CLI_LOGE_APPEND_CAUSE("Cannot specify --stream-intersection with --run-args or --run-args-0.");
4486 for (i
= 0; i
< bt_value_array_get_size(run_args
); i
++) {
4487 const bt_value
*arg_value
=
4488 bt_value_array_borrow_element_by_index(run_args
,
4491 GString
*quoted
= NULL
;
4492 const char *arg_to_print
;
4494 BT_ASSERT(arg_value
);
4495 arg
= bt_value_string_get(arg_value
);
4497 if (print_run_args
) {
4498 quoted
= bt_common_shell_quote(arg
, true);
4503 arg_to_print
= quoted
->str
;
4508 printf("%s", arg_to_print
);
4511 g_string_free(quoted
, TRUE
);
4514 if (i
< bt_value_array_get_size(run_args
) - 1) {
4515 if (print_run_args
) {
4524 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4529 * If the log level is still unset at this point, set it to
4530 * the program's default.
4532 if (*default_log_level
< 0) {
4533 *default_log_level
= cli_default_log_level
;
4536 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4537 force_omit_system_plugin_path
,
4538 force_omit_home_plugin_path
,
4539 initial_plugin_paths
, *default_log_level
);
4544 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4549 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4553 * If the log level is still unset at this point, set it to
4554 * the program's default.
4556 if (*default_log_level
< 0) {
4557 *default_log_level
= cli_default_log_level
;
4561 poptFreeContext(pc
);
4568 g_string_free(cur_name
, TRUE
);
4571 if (cur_name_prefix
) {
4572 g_string_free(cur_name_prefix
, TRUE
);
4575 bt_value_put_ref(run_args
);
4576 bt_value_put_ref(all_names
);
4577 destroy_glist_of_gstring(source_names
);
4578 destroy_glist_of_gstring(filter_names
);
4579 destroy_glist_of_gstring(sink_names
);
4580 bt_value_put_ref(leftovers
);
4581 finalize_implicit_component_args(&implicit_ctf_output_args
);
4582 finalize_implicit_component_args(&implicit_lttng_live_args
);
4583 finalize_implicit_component_args(&implicit_dummy_args
);
4584 finalize_implicit_component_args(&implicit_text_args
);
4585 finalize_implicit_component_args(&implicit_debug_info_args
);
4586 finalize_implicit_component_args(&implicit_muxer_args
);
4587 finalize_implicit_component_args(&implicit_trimmer_args
);
4588 bt_value_put_ref(plugin_paths
);
4589 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4590 auto_source_discovery_fini(&auto_disc
);
4592 if (discovered_source_args
) {
4593 g_ptr_array_free(discovered_source_args
, TRUE
);
4596 g_free(ctf_fs_source_clock_class_offset_arg
);
4597 g_free(ctf_fs_source_clock_class_offset_ns_arg
);
4599 if (auto_disc_comp_name
) {
4600 g_string_free(auto_disc_comp_name
, TRUE
);
4607 * Prints the Babeltrace 2.x general usage.
4610 void print_gen_usage(FILE *fp
)
4612 fprintf(fp
, "Usage: babeltrace2 [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4614 fprintf(fp
, "General options:\n");
4616 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=V)\n");
4617 fprintf(fp
, " -h, --help Show this help and quit\n");
4618 fprintf(fp
, " -l, --log-level=LVL Set the default log level to LVL (`N`, `V`, `D`,\n");
4619 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4620 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4621 fprintf(fp
, " -V, --version Show version and quit\n");
4623 fprintf(fp
, "Available commands:\n");
4625 fprintf(fp
, " convert Convert and trim traces (default)\n");
4626 fprintf(fp
, " help Get help for a plugin or a component class\n");
4627 fprintf(fp
, " list-plugins List available plugins and their content\n");
4628 fprintf(fp
, " query Query objects from a component class\n");
4629 fprintf(fp
, " run Build a processing graph and run it\n");
4631 fprintf(fp
, "Use `babeltrace2 COMMAND --help` to show the help of COMMAND.\n");
4634 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4635 int *retcode
, bool force_omit_system_plugin_path
,
4636 bool force_omit_home_plugin_path
,
4637 const bt_value
*initial_plugin_paths
)
4639 struct bt_config
*config
= NULL
;
4642 const char **top_level_argv
;
4643 int command_argc
= -1;
4644 const char **command_argv
= NULL
;
4645 const char *command_name
= NULL
;
4646 int default_log_level
= -1;
4647 struct bt_argpar_parse_ret argpar_parse_ret
= { 0 };
4649 /* Top-level option descriptions. */
4650 static const struct bt_argpar_opt_descr descrs
[] = {
4651 { OPT_DEBUG
, 'd', "debug", false },
4652 { OPT_HELP
, 'h', "help", false },
4653 { OPT_LOG_LEVEL
, 'l', "log-level", true },
4654 { OPT_VERBOSE
, 'v', "verbose", false },
4655 { OPT_VERSION
, 'V', "version", false},
4656 BT_ARGPAR_OPT_DESCR_SENTINEL
4660 COMMAND_TYPE_NONE
= -1,
4661 COMMAND_TYPE_RUN
= 0,
4662 COMMAND_TYPE_CONVERT
,
4663 COMMAND_TYPE_LIST_PLUGINS
,
4666 } command_type
= COMMAND_TYPE_NONE
;
4670 if (!initial_plugin_paths
) {
4671 initial_plugin_paths
= bt_value_array_create();
4672 if (!initial_plugin_paths
) {
4677 bt_value_get_ref(initial_plugin_paths
);
4683 print_gen_usage(stdout
);
4687 /* Skip first argument, the name of the program. */
4688 top_level_argc
= argc
- 1;
4689 top_level_argv
= argv
+ 1;
4690 argpar_parse_ret
= bt_argpar_parse(top_level_argc
, top_level_argv
,
4693 if (argpar_parse_ret
.error
) {
4694 BT_CLI_LOGE_APPEND_CAUSE(
4695 "While parsing command-line arguments: %s",
4696 argpar_parse_ret
.error
->str
);
4700 for (i
= 0; i
< argpar_parse_ret
.items
->len
; i
++) {
4701 struct bt_argpar_item
*item
;
4703 item
= g_ptr_array_index(argpar_parse_ret
.items
, i
);
4705 if (item
->type
== BT_ARGPAR_ITEM_TYPE_OPT
) {
4706 struct bt_argpar_item_opt
*item_opt
=
4707 (struct bt_argpar_item_opt
*) item
;
4709 switch (item_opt
->descr
->id
) {
4711 default_log_level
= BT_LOG_TRACE
;
4715 * Legacy: do not override a previous
4716 * --debug because --verbose and --debug
4717 * can be specified together (in this
4718 * case we want the lowest log level to
4721 default_log_level
= BT_LOG_INFO
;
4725 bt_log_get_level_from_string(item_opt
->arg
);
4726 if (default_log_level
< 0) {
4727 BT_CLI_LOGE_APPEND_CAUSE(
4728 "Invalid argument for --log-level option:\n %s",
4737 print_gen_usage(stdout
);
4740 } else if (item
->type
== BT_ARGPAR_ITEM_TYPE_NON_OPT
) {
4741 struct bt_argpar_item_non_opt
*item_non_opt
=
4742 (struct bt_argpar_item_non_opt
*) item
;
4744 * First unknown argument: is it a known command
4748 top_level_argc
- item_non_opt
->orig_index
- 1;
4750 &top_level_argv
[item_non_opt
->orig_index
+ 1];
4752 if (strcmp(item_non_opt
->arg
, "convert") == 0) {
4753 command_type
= COMMAND_TYPE_CONVERT
;
4754 } else if (strcmp(item_non_opt
->arg
, "list-plugins") == 0) {
4755 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4756 } else if (strcmp(item_non_opt
->arg
, "help") == 0) {
4757 command_type
= COMMAND_TYPE_HELP
;
4758 } else if (strcmp(item_non_opt
->arg
, "query") == 0) {
4759 command_type
= COMMAND_TYPE_QUERY
;
4760 } else if (strcmp(item_non_opt
->arg
, "run") == 0) {
4761 command_type
= COMMAND_TYPE_RUN
;
4764 * Non-option argument, but not a known
4765 * command name: assume the default
4766 * `convert` command.
4768 command_type
= COMMAND_TYPE_CONVERT
;
4769 command_name
= "convert";
4777 if (command_type
== COMMAND_TYPE_NONE
) {
4778 if (argpar_parse_ret
.ingested_orig_args
== top_level_argc
) {
4780 * We only got non-help, non-version general options
4781 * like --verbose and --debug, without any other
4782 * arguments, so we can't do anything useful: print the
4785 print_gen_usage(stdout
);
4790 * We stopped on an unknown option argument (and therefore
4791 * didn't see a command name). Assume `convert` command.
4793 command_type
= COMMAND_TYPE_CONVERT
;
4794 command_name
= "convert";
4796 top_level_argc
- argpar_parse_ret
.ingested_orig_args
;
4798 &top_level_argv
[argpar_parse_ret
.ingested_orig_args
];
4801 BT_ASSERT(command_argv
);
4802 BT_ASSERT(command_argc
>= 0);
4805 * The convert command can set its own default log level for
4806 * backward compatibility reasons. It only does so if there's no
4807 * log level yet, so do not force one for this command.
4809 if (command_type
!= COMMAND_TYPE_CONVERT
&& default_log_level
< 0) {
4810 /* Default log level */
4811 default_log_level
= cli_default_log_level
;
4814 switch (command_type
) {
4815 case COMMAND_TYPE_RUN
:
4816 config
= bt_config_run_from_args(command_argc
, command_argv
,
4817 retcode
, force_omit_system_plugin_path
,
4818 force_omit_home_plugin_path
, initial_plugin_paths
,
4821 case COMMAND_TYPE_CONVERT
:
4822 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4823 retcode
, force_omit_system_plugin_path
,
4824 force_omit_home_plugin_path
,
4825 initial_plugin_paths
, &default_log_level
);
4827 case COMMAND_TYPE_LIST_PLUGINS
:
4828 config
= bt_config_list_plugins_from_args(command_argc
,
4829 command_argv
, retcode
, force_omit_system_plugin_path
,
4830 force_omit_home_plugin_path
, initial_plugin_paths
);
4832 case COMMAND_TYPE_HELP
:
4833 config
= bt_config_help_from_args(command_argc
,
4834 command_argv
, retcode
, force_omit_system_plugin_path
,
4835 force_omit_home_plugin_path
, initial_plugin_paths
,
4838 case COMMAND_TYPE_QUERY
:
4839 config
= bt_config_query_from_args(command_argc
,
4840 command_argv
, retcode
, force_omit_system_plugin_path
,
4841 force_omit_home_plugin_path
, initial_plugin_paths
,
4849 BT_ASSERT(default_log_level
>= BT_LOG_TRACE
);
4850 config
->log_level
= default_log_level
;
4851 config
->command_name
= command_name
;
4860 bt_argpar_parse_ret_fini(&argpar_parse_ret
);
4861 bt_value_put_ref(initial_plugin_paths
);