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 <babeltrace/assert-internal.h>
35 #include <babeltrace/babeltrace.h>
36 #include <babeltrace/common-internal.h>
39 #include <sys/types.h>
40 #include "babeltrace-cfg.h"
41 #include "babeltrace-cfg-cli-args.h"
42 #include "babeltrace-cfg-cli-args-connect.h"
46 * Error printf() macro which prepends "Error: " the first time it's
47 * called. This gives a nicer feel than having a bunch of error prefixes
48 * (since the following lines usually describe the error and possible
49 * solutions), or the error prefix just at the end.
51 #define printf_err(fmt, args...) \
53 if (is_first_error) { \
54 fprintf(stderr, "Command line error: "); \
55 is_first_error = false; \
57 fprintf(stderr, fmt, ##args); \
60 static bool is_first_error
= true;
62 /* INI-style parsing FSM states */
63 enum ini_parsing_fsm_state
{
64 /* Expect a map key (identifier) */
67 /* Expect an equal character ('=') */
73 /* Expect a negative number value */
74 INI_EXPECT_VALUE_NUMBER_NEG
,
76 /* Expect a comma character (',') */
80 /* INI-style parsing state variables */
81 struct ini_parsing_state
{
82 /* Lexical scanner (owned by this) */
85 /* Output map value object being filled (owned by this) */
86 struct bt_value
*params
;
88 /* Next expected FSM state */
89 enum ini_parsing_fsm_state expecting
;
91 /* Last decoded map key (owned by this) */
94 /* Complete INI-style string to parse (not owned by this) */
97 /* Error buffer (not owned by this) */
101 /* Offset option with "is set" boolean */
107 /* Legacy "ctf"/"lttng-live" format options */
108 struct ctf_legacy_opts
{
109 struct offset_opt offset_s
;
110 struct offset_opt offset_ns
;
111 bool stream_intersection
;
114 /* Legacy "text" format options */
115 struct text_legacy_opts
{
117 * output, dbg_info_dir, dbg_info_target_prefix, names,
118 * and fields are owned by this.
121 GString
*dbg_info_dir
;
122 GString
*dbg_info_target_prefix
;
123 const struct bt_value
*names
;
124 const struct bt_value
*fields
;
132 bool dbg_info_full_path
;
136 /* Legacy input format format */
137 enum legacy_input_format
{
138 LEGACY_INPUT_FORMAT_NONE
= 0,
139 LEGACY_INPUT_FORMAT_CTF
,
140 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
143 /* Legacy output format format */
144 enum legacy_output_format
{
145 LEGACY_OUTPUT_FORMAT_NONE
= 0,
146 LEGACY_OUTPUT_FORMAT_TEXT
,
147 LEGACY_OUTPUT_FORMAT_DUMMY
,
151 * Prints the "out of memory" error.
154 void print_err_oom(void)
156 printf_err("Out of memory\n");
160 * Appends an "expecting token" error to the INI-style parsing state's
164 void ini_append_error_expecting(struct ini_parsing_state
*state
,
165 GScanner
*scanner
, const char *expecting
)
170 g_string_append_printf(state
->ini_error
, "Expecting %s:\n", expecting
);
172 /* Only print error if there's one line */
173 if (strchr(state
->arg
, '\n') != NULL
|| strlen(state
->arg
) == 0) {
177 g_string_append_printf(state
->ini_error
, "\n %s\n", state
->arg
);
178 pos
= g_scanner_cur_position(scanner
) + 4;
180 if (!g_scanner_eof(scanner
)) {
184 for (i
= 0; i
< pos
; ++i
) {
185 g_string_append_printf(state
->ini_error
, " ");
188 g_string_append_printf(state
->ini_error
, "^\n\n");
192 int ini_handle_state(struct ini_parsing_state
*state
)
195 GTokenType token_type
;
196 struct bt_value
*value
= NULL
;
198 token_type
= g_scanner_get_next_token(state
->scanner
);
199 if (token_type
== G_TOKEN_EOF
) {
200 if (state
->expecting
!= INI_EXPECT_COMMA
) {
201 switch (state
->expecting
) {
202 case INI_EXPECT_EQUAL
:
203 ini_append_error_expecting(state
,
204 state
->scanner
, "'='");
206 case INI_EXPECT_VALUE
:
207 case INI_EXPECT_VALUE_NUMBER_NEG
:
208 ini_append_error_expecting(state
,
209 state
->scanner
, "value");
211 case INI_EXPECT_MAP_KEY
:
212 ini_append_error_expecting(state
,
213 state
->scanner
, "unquoted map key");
226 switch (state
->expecting
) {
227 case INI_EXPECT_MAP_KEY
:
228 if (token_type
!= G_TOKEN_IDENTIFIER
) {
229 ini_append_error_expecting(state
, state
->scanner
,
234 free(state
->last_map_key
);
235 state
->last_map_key
=
236 strdup(state
->scanner
->value
.v_identifier
);
237 if (!state
->last_map_key
) {
238 g_string_append(state
->ini_error
,
243 if (bt_value_map_has_entry(state
->params
,
244 state
->last_map_key
)) {
245 g_string_append_printf(state
->ini_error
,
246 "Duplicate parameter key: `%s`\n",
247 state
->last_map_key
);
251 state
->expecting
= INI_EXPECT_EQUAL
;
253 case INI_EXPECT_EQUAL
:
254 if (token_type
!= G_TOKEN_CHAR
) {
255 ini_append_error_expecting(state
,
256 state
->scanner
, "'='");
260 if (state
->scanner
->value
.v_char
!= '=') {
261 ini_append_error_expecting(state
,
262 state
->scanner
, "'='");
266 state
->expecting
= INI_EXPECT_VALUE
;
268 case INI_EXPECT_VALUE
:
270 switch (token_type
) {
272 if (state
->scanner
->value
.v_char
== '-') {
273 /* Negative number */
275 INI_EXPECT_VALUE_NUMBER_NEG
;
278 ini_append_error_expecting(state
,
279 state
->scanner
, "value");
285 /* Positive integer */
286 uint64_t int_val
= state
->scanner
->value
.v_int64
;
288 if (int_val
> (1ULL << 63) - 1) {
289 g_string_append_printf(state
->ini_error
,
290 "Integer value %" PRIu64
" is outside the range of a 64-bit signed integer\n",
295 value
= bt_value_integer_create_init((int64_t)int_val
);
299 /* Positive floating point number */
300 value
= bt_value_real_create_init(state
->scanner
->value
.v_float
);
304 value
= bt_value_string_create_init(state
->scanner
->value
.v_string
);
306 case G_TOKEN_IDENTIFIER
:
309 * Using symbols would be appropriate here,
310 * but said symbols are allowed as map key,
311 * so it's easier to consider everything an
314 * If one of the known symbols is not
315 * recognized here, then fall back to creating
318 const char *id
= state
->scanner
->value
.v_identifier
;
320 if (!strcmp(id
, "null") || !strcmp(id
, "NULL") ||
321 !strcmp(id
, "nul")) {
322 value
= bt_value_null
;
323 } else if (!strcmp(id
, "true") || !strcmp(id
, "TRUE") ||
324 !strcmp(id
, "yes") ||
325 !strcmp(id
, "YES")) {
326 value
= bt_value_bool_create_init(true);
327 } else if (!strcmp(id
, "false") ||
328 !strcmp(id
, "FALSE") ||
331 value
= bt_value_bool_create_init(false);
333 value
= bt_value_string_create_init(id
);
338 /* Unset value variable will trigger the error */
343 ini_append_error_expecting(state
,
344 state
->scanner
, "value");
348 state
->expecting
= INI_EXPECT_COMMA
;
351 case INI_EXPECT_VALUE_NUMBER_NEG
:
353 switch (token_type
) {
356 /* Negative integer */
357 uint64_t int_val
= state
->scanner
->value
.v_int64
;
359 if (int_val
> (1ULL << 63) - 1) {
360 g_string_append_printf(state
->ini_error
,
361 "Integer value -%" PRIu64
" is outside the range of a 64-bit signed integer\n",
366 value
= bt_value_integer_create_init(-((int64_t)int_val
));
370 /* Negative floating point number */
371 value
= bt_value_real_create_init(-state
->scanner
->value
.v_float
);
374 /* Unset value variable will trigger the error */
379 ini_append_error_expecting(state
,
380 state
->scanner
, "value");
384 state
->expecting
= INI_EXPECT_COMMA
;
387 case INI_EXPECT_COMMA
:
388 if (token_type
!= G_TOKEN_CHAR
) {
389 ini_append_error_expecting(state
,
390 state
->scanner
, "','");
394 if (state
->scanner
->value
.v_char
!= ',') {
395 ini_append_error_expecting(state
,
396 state
->scanner
, "','");
400 state
->expecting
= INI_EXPECT_MAP_KEY
;
412 if (bt_value_map_insert_entry(state
->params
,
413 state
->last_map_key
, value
)) {
414 /* Only override return value on error */
420 BT_OBJECT_PUT_REF_AND_RESET(value
);
425 * Converts an INI-style argument to an equivalent map value object.
427 * Return value is owned by the caller.
430 struct bt_value
*bt_value_from_ini(const char *arg
,
433 /* Lexical scanner configuration */
434 GScannerConfig scanner_config
= {
435 /* Skip whitespaces */
436 .cset_skip_characters
= " \t\n",
438 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
439 .cset_identifier_first
=
443 .cset_identifier_nth
=
448 /* "hello" and "Hello" two different keys */
449 .case_sensitive
= TRUE
,
452 .cpair_comment_single
= NULL
,
453 .skip_comment_multi
= TRUE
,
454 .skip_comment_single
= TRUE
,
455 .scan_comment_multi
= FALSE
,
458 * Do scan identifiers, including 1-char identifiers,
459 * but NULL is a normal identifier.
461 .scan_identifier
= TRUE
,
462 .scan_identifier_1char
= TRUE
,
463 .scan_identifier_NULL
= FALSE
,
466 * No specific symbols: null and boolean "symbols" are
467 * scanned as plain identifiers.
469 .scan_symbols
= FALSE
,
470 .symbol_2_token
= FALSE
,
471 .scope_0_fallback
= FALSE
,
474 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
475 * integers prefixed with "$".
481 .scan_hex_dollar
= FALSE
,
483 /* Convert scanned numbers to integer tokens */
484 .numbers_2_int
= TRUE
,
486 /* Support both integers and floating-point numbers */
487 .int_2_float
= FALSE
,
489 /* Scan integers as 64-bit signed integers */
492 /* Only scan double-quoted strings */
493 .scan_string_sq
= FALSE
,
494 .scan_string_dq
= TRUE
,
496 /* Do not converter identifiers to string tokens */
497 .identifier_2_string
= FALSE
,
499 /* Scan characters as G_TOKEN_CHAR token */
500 .char_2_token
= FALSE
,
502 struct ini_parsing_state state
= {
505 .expecting
= INI_EXPECT_MAP_KEY
,
507 .ini_error
= ini_error
,
510 state
.params
= bt_value_map_create();
515 state
.scanner
= g_scanner_new(&scanner_config
);
516 if (!state
.scanner
) {
520 /* Let the scan begin */
521 g_scanner_input_text(state
.scanner
, arg
, strlen(arg
));
524 int ret
= ini_handle_state(&state
);
529 } else if (ret
> 0) {
538 BT_OBJECT_PUT_REF_AND_RESET(state
.params
);
542 g_scanner_destroy(state
.scanner
);
545 free(state
.last_map_key
);
550 * Returns the parameters map value object from a command-line
551 * parameter option's argument.
553 * Return value is owned by the caller.
556 struct bt_value
*bt_value_from_arg(const char *arg
)
558 struct bt_value
*params
= NULL
;
559 GString
*ini_error
= NULL
;
561 ini_error
= g_string_new(NULL
);
567 /* Try INI-style parsing */
568 params
= bt_value_from_ini(arg
, ini_error
);
570 printf_err("%s", ini_error
->str
);
576 g_string_free(ini_error
, TRUE
);
583 * Returns the plugin name, component class name, component class type,
584 * and component name from a command-line --component option's argument.
585 * arg must have the following format:
587 * [NAME:]TYPE.PLUGIN.CLS
589 * where NAME is the optional component name, TYPE is either `source`,
590 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
591 * component class name.
593 * On success, both *plugin and *component are not NULL. *plugin
594 * and *comp_cls are owned by the caller. On success, *name can be NULL
595 * if no component class name was found, and *comp_cls_type is set.
598 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
599 char **comp_cls
, enum bt_component_class_type
*comp_cls_type
)
601 const char *at
= arg
;
602 GString
*gs_name
= NULL
;
603 GString
*gs_comp_cls_type
= NULL
;
604 GString
*gs_plugin
= NULL
;
605 GString
*gs_comp_cls
= NULL
;
611 BT_ASSERT(comp_cls_type
);
613 if (!bt_common_string_is_printable(arg
)) {
614 printf_err("Argument contains a non-printable character\n");
618 /* Parse the component name */
619 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
624 if (arg
[end_pos
] == ':') {
628 g_string_assign(gs_name
, "");
631 /* Parse the component class type */
632 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
633 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
634 printf_err("Missing component class type (`source`, `filter`, or `sink`)\n");
638 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
639 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
640 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
641 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
642 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
643 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
644 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
645 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
647 printf_err("Unknown component class type: `%s`\n",
648 gs_comp_cls_type
->str
);
654 /* Parse the plugin name */
655 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
656 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
657 printf_err("Missing plugin or component class name\n");
663 /* Parse the component class name */
664 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
665 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
666 printf_err("Missing component class name\n");
670 if (at
[end_pos
] != '\0') {
671 /* Found a non-escaped `.` */
676 if (gs_name
->len
== 0) {
678 g_string_free(gs_name
, TRUE
);
680 *name
= gs_name
->str
;
681 g_string_free(gs_name
, FALSE
);
684 g_string_free(gs_name
, TRUE
);
687 *plugin
= gs_plugin
->str
;
688 *comp_cls
= gs_comp_cls
->str
;
689 g_string_free(gs_plugin
, FALSE
);
690 g_string_free(gs_comp_cls
, FALSE
);
706 g_string_free(gs_name
, TRUE
);
710 g_string_free(gs_plugin
, TRUE
);
714 g_string_free(gs_comp_cls
, TRUE
);
717 if (gs_comp_cls_type
) {
718 g_string_free(gs_comp_cls_type
, TRUE
);
725 * Prints the Babeltrace version.
728 void print_version(void)
730 if (GIT_VERSION
[0] == '\0') {
731 puts("Babeltrace " VERSION
);
733 puts("Babeltrace " VERSION
" - " GIT_VERSION
);
738 * Destroys a component configuration.
741 void bt_config_component_destroy(struct bt_object
*obj
)
743 struct bt_config_component
*bt_config_component
=
744 container_of(obj
, struct bt_config_component
, base
);
750 if (bt_config_component
->plugin_name
) {
751 g_string_free(bt_config_component
->plugin_name
, TRUE
);
754 if (bt_config_component
->comp_cls_name
) {
755 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
758 if (bt_config_component
->instance_name
) {
759 g_string_free(bt_config_component
->instance_name
, TRUE
);
762 BT_OBJECT_PUT_REF_AND_RESET(bt_config_component
->params
);
763 g_free(bt_config_component
);
770 * Creates a component configuration using the given plugin name and
771 * component name. `plugin_name` and `comp_cls_name` are copied (belong
772 * to the return value).
774 * Return value is owned by the caller.
777 struct bt_config_component
*bt_config_component_create(
778 enum bt_component_class_type type
,
779 const char *plugin_name
, const char *comp_cls_name
)
781 struct bt_config_component
*cfg_component
= NULL
;
783 cfg_component
= g_new0(struct bt_config_component
, 1);
784 if (!cfg_component
) {
789 bt_object_init_shared(&cfg_component
->base
,
790 bt_config_component_destroy
);
791 cfg_component
->type
= type
;
792 cfg_component
->plugin_name
= g_string_new(plugin_name
);
793 if (!cfg_component
->plugin_name
) {
798 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
799 if (!cfg_component
->comp_cls_name
) {
804 cfg_component
->instance_name
= g_string_new(NULL
);
805 if (!cfg_component
->instance_name
) {
810 /* Start with empty parameters */
811 cfg_component
->params
= bt_value_map_create();
812 if (!cfg_component
->params
) {
820 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
823 return cfg_component
;
827 * Creates a component configuration from a command-line --component
831 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
833 struct bt_config_component
*cfg_comp
= NULL
;
835 char *plugin_name
= NULL
;
836 char *comp_cls_name
= NULL
;
837 enum bt_component_class_type type
;
839 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
840 if (!plugin_name
|| !comp_cls_name
) {
844 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
);
850 g_string_assign(cfg_comp
->instance_name
, name
);
856 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp
);
861 g_free(comp_cls_name
);
866 * Destroys a configuration.
869 void bt_config_destroy(struct bt_object
*obj
)
871 struct bt_config
*cfg
=
872 container_of(obj
, struct bt_config
, base
);
878 BT_OBJECT_PUT_REF_AND_RESET(cfg
->plugin_paths
);
880 switch (cfg
->command
) {
881 case BT_CONFIG_COMMAND_RUN
:
882 if (cfg
->cmd_data
.run
.sources
) {
883 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
886 if (cfg
->cmd_data
.run
.filters
) {
887 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
890 if (cfg
->cmd_data
.run
.sinks
) {
891 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
894 if (cfg
->cmd_data
.run
.connections
) {
895 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
899 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
901 case BT_CONFIG_COMMAND_HELP
:
902 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.help
.cfg_component
);
904 case BT_CONFIG_COMMAND_QUERY
:
905 BT_OBJECT_PUT_REF_AND_RESET(cfg
->cmd_data
.query
.cfg_component
);
907 if (cfg
->cmd_data
.query
.object
) {
908 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
911 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
912 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
913 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
916 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
920 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
921 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
923 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
926 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
941 void destroy_glist_of_gstring(GList
*list
)
949 for (at
= list
; at
!= NULL
; at
= g_list_next(at
)) {
950 g_string_free(at
->data
, TRUE
);
957 * Creates a simple lexical scanner for parsing comma-delimited names
960 * Return value is owned by the caller.
963 GScanner
*create_csv_identifiers_scanner(void)
966 GScannerConfig scanner_config
= {
967 .cset_skip_characters
= " \t\n",
968 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
969 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
970 .case_sensitive
= TRUE
,
971 .cpair_comment_single
= NULL
,
972 .skip_comment_multi
= TRUE
,
973 .skip_comment_single
= TRUE
,
974 .scan_comment_multi
= FALSE
,
975 .scan_identifier
= TRUE
,
976 .scan_identifier_1char
= TRUE
,
977 .scan_identifier_NULL
= FALSE
,
978 .scan_symbols
= FALSE
,
979 .symbol_2_token
= FALSE
,
980 .scope_0_fallback
= FALSE
,
981 .scan_binary
= FALSE
,
985 .scan_hex_dollar
= FALSE
,
986 .numbers_2_int
= FALSE
,
987 .int_2_float
= FALSE
,
988 .store_int64
= FALSE
,
989 .scan_string_sq
= FALSE
,
990 .scan_string_dq
= FALSE
,
991 .identifier_2_string
= FALSE
,
992 .char_2_token
= TRUE
,
995 scanner
= g_scanner_new(&scanner_config
);
1004 * Converts a comma-delimited list of known names (--names option) to
1005 * an array value object containing those names as string value objects.
1007 * Return value is owned by the caller.
1010 struct bt_value
*names_from_arg(const char *arg
)
1012 GScanner
*scanner
= NULL
;
1013 struct bt_value
*names
= NULL
;
1014 bool found_all
= false, found_none
= false, found_item
= false;
1016 names
= bt_value_array_create();
1022 scanner
= create_csv_identifiers_scanner();
1027 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1030 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1032 switch (token_type
) {
1033 case G_TOKEN_IDENTIFIER
:
1035 const char *identifier
= scanner
->value
.v_identifier
;
1037 if (!strcmp(identifier
, "payload") ||
1038 !strcmp(identifier
, "args") ||
1039 !strcmp(identifier
, "arg")) {
1041 if (bt_value_array_append_string_element(names
,
1045 } else if (!strcmp(identifier
, "context") ||
1046 !strcmp(identifier
, "ctx")) {
1048 if (bt_value_array_append_string_element(names
,
1052 } else if (!strcmp(identifier
, "scope") ||
1053 !strcmp(identifier
, "header")) {
1055 if (bt_value_array_append_string_element(names
,
1059 } else if (!strcmp(identifier
, "all")) {
1061 if (bt_value_array_append_string_element(names
,
1065 } else if (!strcmp(identifier
, "none")) {
1067 if (bt_value_array_append_string_element(names
,
1072 printf_err("Unknown name: `%s`\n",
1088 if (found_none
&& found_all
) {
1089 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1093 * Legacy behavior is to clear the defaults (show none) when at
1094 * least one item is specified.
1096 if (found_item
&& !found_none
&& !found_all
) {
1097 if (bt_value_array_append_string_element(names
, "none")) {
1102 g_scanner_destroy(scanner
);
1107 BT_OBJECT_PUT_REF_AND_RESET(names
);
1109 g_scanner_destroy(scanner
);
1115 * Converts a comma-delimited list of known fields (--fields option) to
1116 * an array value object containing those fields as string
1119 * Return value is owned by the caller.
1122 struct bt_value
*fields_from_arg(const char *arg
)
1124 GScanner
*scanner
= NULL
;
1125 struct bt_value
*fields
;
1127 fields
= bt_value_array_create();
1133 scanner
= create_csv_identifiers_scanner();
1138 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1141 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1143 switch (token_type
) {
1144 case G_TOKEN_IDENTIFIER
:
1146 const char *identifier
= scanner
->value
.v_identifier
;
1148 if (!strcmp(identifier
, "trace") ||
1149 !strcmp(identifier
, "trace:hostname") ||
1150 !strcmp(identifier
, "trace:domain") ||
1151 !strcmp(identifier
, "trace:procname") ||
1152 !strcmp(identifier
, "trace:vpid") ||
1153 !strcmp(identifier
, "loglevel") ||
1154 !strcmp(identifier
, "emf") ||
1155 !strcmp(identifier
, "callsite") ||
1156 !strcmp(identifier
, "all")) {
1157 if (bt_value_array_append_string_element(fields
,
1162 printf_err("Unknown field: `%s`\n",
1180 BT_OBJECT_PUT_REF_AND_RESET(fields
);
1184 g_scanner_destroy(scanner
);
1190 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
1192 BT_ASSERT(params_arg
);
1196 if (params_arg
->len
!= 0) {
1197 g_string_append_c(params_arg
, ',');
1200 g_string_append(params_arg
, key
);
1201 g_string_append_c(params_arg
, '=');
1202 g_string_append(params_arg
, value
);
1206 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
1207 * where the names are in names_array.
1210 int insert_flat_params_from_array(GString
*params_arg
,
1211 const struct bt_value
*names_array
, const char *prefix
)
1215 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1216 bool default_set
= false, non_default_set
= false;
1219 * names_array may be NULL if no CLI options were specified to
1220 * trigger its creation.
1226 tmpstr
= g_string_new(NULL
);
1233 default_value
= g_string_new(NULL
);
1234 if (!default_value
) {
1240 for (i
= 0; i
< bt_value_array_get_size(names_array
); i
++) {
1241 const struct bt_value
*str_obj
=
1242 bt_value_array_borrow_element_by_index_const(names_array
,
1245 bool is_default
= false;
1248 printf_err("Unexpected error\n");
1253 suffix
= bt_value_string_get(str_obj
);
1255 g_string_assign(tmpstr
, prefix
);
1256 g_string_append(tmpstr
, "-");
1258 /* Special-case for "all" and "none". */
1259 if (!strcmp(suffix
, "all")) {
1261 g_string_assign(default_value
, "show");
1262 } else if (!strcmp(suffix
, "none")) {
1264 g_string_assign(default_value
, "hide");
1268 g_string_append(tmpstr
, "default");
1269 append_param_arg(params_arg
, tmpstr
->str
,
1270 default_value
->str
);
1272 non_default_set
= true;
1273 g_string_append(tmpstr
, suffix
);
1274 append_param_arg(params_arg
, tmpstr
->str
, "yes");
1278 /* Implicit field-default=hide if any non-default option is set. */
1279 if (non_default_set
&& !default_set
) {
1280 g_string_assign(tmpstr
, prefix
);
1281 g_string_append(tmpstr
, "-default");
1282 g_string_assign(default_value
, "hide");
1283 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
1287 if (default_value
) {
1288 g_string_free(default_value
, TRUE
);
1292 g_string_free(tmpstr
, TRUE
);
1305 OPT_CLOCK_FORCE_CORRELATE
,
1308 OPT_CLOCK_OFFSET_NS
,
1316 OPT_DEBUG_INFO_FULL_PATH
,
1317 OPT_DEBUG_INFO_TARGET_PREFIX
,
1327 OPT_OMIT_HOME_PLUGIN_PATH
,
1328 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
1334 OPT_RESET_BASE_PARAMS
,
1338 OPT_STREAM_INTERSECTION
,
1345 enum bt_config_component_dest
{
1346 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
1347 BT_CONFIG_COMPONENT_DEST_SOURCE
,
1348 BT_CONFIG_COMPONENT_DEST_FILTER
,
1349 BT_CONFIG_COMPONENT_DEST_SINK
,
1353 * Adds a configuration component to the appropriate configuration
1354 * array depending on the destination.
1357 void add_run_cfg_comp(struct bt_config
*cfg
,
1358 struct bt_config_component
*cfg_comp
,
1359 enum bt_config_component_dest dest
)
1361 bt_object_get_ref(cfg_comp
);
1364 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
1365 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
1367 case BT_CONFIG_COMPONENT_DEST_FILTER
:
1368 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
1370 case BT_CONFIG_COMPONENT_DEST_SINK
:
1371 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
1379 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
1380 struct bt_config_component
*cfg_comp
,
1381 enum bt_config_component_dest dest
,
1382 struct bt_value
*instance_names
)
1386 if (cfg_comp
->instance_name
->len
== 0) {
1387 printf_err("Found an unnamed component\n");
1392 if (bt_value_map_has_entry(instance_names
,
1393 cfg_comp
->instance_name
->str
)) {
1394 printf_err("Duplicate component instance name:\n %s\n",
1395 cfg_comp
->instance_name
->str
);
1400 if (bt_value_map_insert_entry(instance_names
,
1401 cfg_comp
->instance_name
->str
, bt_value_null
)) {
1407 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
1414 int append_env_var_plugin_paths(struct bt_value
*plugin_paths
)
1419 if (bt_common_is_setuid_setgid()) {
1420 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1424 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
1429 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
1433 printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n");
1440 int append_home_and_system_plugin_paths(struct bt_value
*plugin_paths
,
1441 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
1445 if (!omit_home_plugin_path
) {
1446 if (bt_common_is_setuid_setgid()) {
1447 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1449 char *home_plugin_dir
=
1450 bt_common_get_home_plugin_path();
1452 if (home_plugin_dir
) {
1453 ret
= bt_config_append_plugin_paths(
1454 plugin_paths
, home_plugin_dir
);
1455 free(home_plugin_dir
);
1458 printf_err("Invalid home plugin path\n");
1465 if (!omit_system_plugin_path
) {
1466 if (bt_config_append_plugin_paths(plugin_paths
,
1467 bt_common_get_system_plugin_path())) {
1468 printf_err("Invalid system plugin path\n");
1474 printf_err("Cannot append home and system plugin paths\n");
1479 int append_home_and_system_plugin_paths_cfg(struct bt_config
*cfg
)
1481 return append_home_and_system_plugin_paths(cfg
->plugin_paths
,
1482 cfg
->omit_system_plugin_path
, cfg
->omit_home_plugin_path
);
1486 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1487 const struct bt_value
*initial_plugin_paths
,
1490 struct bt_config
*cfg
;
1493 cfg
= g_new0(struct bt_config
, 1);
1499 bt_object_init_shared(&cfg
->base
, bt_config_destroy
);
1500 cfg
->command
= command
;
1501 cfg
->command_needs_plugins
= needs_plugins
;
1503 if (initial_plugin_paths
) {
1504 struct bt_value
*initial_plugin_paths_copy
;
1506 (void) bt_value_copy(&initial_plugin_paths_copy
,
1507 initial_plugin_paths
);
1508 cfg
->plugin_paths
= initial_plugin_paths_copy
;
1510 cfg
->plugin_paths
= bt_value_array_create();
1511 if (!cfg
->plugin_paths
) {
1520 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1527 struct bt_config
*bt_config_run_create(
1528 const struct bt_value
*initial_plugin_paths
)
1530 struct bt_config
*cfg
;
1533 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1534 initial_plugin_paths
, true);
1539 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1540 (GDestroyNotify
) bt_object_put_ref
);
1541 if (!cfg
->cmd_data
.run
.sources
) {
1546 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1547 (GDestroyNotify
) bt_object_put_ref
);
1548 if (!cfg
->cmd_data
.run
.filters
) {
1553 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1554 (GDestroyNotify
) bt_object_put_ref
);
1555 if (!cfg
->cmd_data
.run
.sinks
) {
1560 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1561 (GDestroyNotify
) bt_config_connection_destroy
);
1562 if (!cfg
->cmd_data
.run
.connections
) {
1570 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1577 struct bt_config
*bt_config_list_plugins_create(
1578 const struct bt_value
*initial_plugin_paths
)
1580 struct bt_config
*cfg
;
1583 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1584 initial_plugin_paths
, true);
1592 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1599 struct bt_config
*bt_config_help_create(
1600 const struct bt_value
*initial_plugin_paths
)
1602 struct bt_config
*cfg
;
1605 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1606 initial_plugin_paths
, true);
1611 cfg
->cmd_data
.help
.cfg_component
=
1612 bt_config_component_create(-1, NULL
, NULL
);
1613 if (!cfg
->cmd_data
.help
.cfg_component
) {
1620 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1627 struct bt_config
*bt_config_query_create(
1628 const struct bt_value
*initial_plugin_paths
)
1630 struct bt_config
*cfg
;
1633 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_QUERY
,
1634 initial_plugin_paths
, true);
1639 cfg
->cmd_data
.query
.object
= g_string_new(NULL
);
1640 if (!cfg
->cmd_data
.query
.object
) {
1648 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1655 struct bt_config
*bt_config_print_ctf_metadata_create(
1656 const struct bt_value
*initial_plugin_paths
)
1658 struct bt_config
*cfg
;
1661 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA
,
1662 initial_plugin_paths
, true);
1667 cfg
->cmd_data
.print_ctf_metadata
.path
= g_string_new(NULL
);
1668 if (!cfg
->cmd_data
.print_ctf_metadata
.path
) {
1673 cfg
->cmd_data
.print_ctf_metadata
.output_path
= g_string_new(NULL
);
1674 if (!cfg
->cmd_data
.print_ctf_metadata
.output_path
) {
1682 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1689 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1690 const struct bt_value
*initial_plugin_paths
)
1692 struct bt_config
*cfg
;
1695 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
,
1696 initial_plugin_paths
, true);
1701 cfg
->cmd_data
.print_lttng_live_sessions
.url
= g_string_new(NULL
);
1702 if (!cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
1707 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
=
1709 if (!cfg
->cmd_data
.print_lttng_live_sessions
.output_path
) {
1717 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1724 int bt_config_append_plugin_paths_check_setuid_setgid(
1725 struct bt_value
*plugin_paths
, const char *arg
)
1729 if (bt_common_is_setuid_setgid()) {
1730 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1734 if (bt_config_append_plugin_paths(plugin_paths
, arg
)) {
1735 printf_err("Invalid --plugin-path option's argument:\n %s\n",
1746 * Prints the expected format for a --params option.
1749 void print_expected_params_format(FILE *fp
)
1751 fprintf(fp
, "Expected format of PARAMS\n");
1752 fprintf(fp
, "-------------------------\n");
1754 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
1756 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1757 fprintf(fp
, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1758 fprintf(fp
, "and VALUE can be one of:\n");
1760 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1761 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1762 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1763 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1764 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
1765 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
1766 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
1767 fprintf(fp
, " the null and boolean value symbols above.\n");
1768 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
1770 fprintf(fp
, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1772 fprintf(fp
, "Example:\n");
1774 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1775 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1776 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
1778 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1779 fprintf(fp
, "babeltrace from a shell.\n");
1784 * Prints the help command usage.
1787 void print_help_usage(FILE *fp
)
1789 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
1790 fprintf(fp
, " babeltrace [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
1792 fprintf(fp
, "Options:\n");
1794 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1795 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
1796 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1797 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1798 fprintf(fp
, " dynamic plugins can be loaded\n");
1799 fprintf(fp
, " -h, --help Show this help and quit\n");
1801 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
1803 fprintf(fp
, "Use `babeltrace list-plugins` to show the list of available plugins.\n");
1807 struct poptOption help_long_options
[] = {
1808 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1809 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1810 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1811 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1812 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1813 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1817 * Creates a Babeltrace config object from the arguments of a help
1820 * *retcode is set to the appropriate exit code to use.
1823 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
1824 int *retcode
, bool force_omit_system_plugin_path
,
1825 bool force_omit_home_plugin_path
,
1826 const struct bt_value
*initial_plugin_paths
)
1828 poptContext pc
= NULL
;
1832 struct bt_config
*cfg
= NULL
;
1833 const char *leftover
;
1834 char *plugin_name
= NULL
, *comp_cls_name
= NULL
;
1837 cfg
= bt_config_help_create(initial_plugin_paths
);
1842 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
1843 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
1844 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
1850 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
1851 help_long_options
, 0);
1853 printf_err("Cannot get popt context\n");
1857 poptReadDefaultConfig(pc
, 0);
1859 while ((opt
= poptGetNextOpt(pc
)) > 0) {
1860 arg
= poptGetOptArg(pc
);
1863 case OPT_PLUGIN_PATH
:
1864 if (bt_config_append_plugin_paths_check_setuid_setgid(
1865 cfg
->plugin_paths
, arg
)) {
1869 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
1870 cfg
->omit_system_plugin_path
= true;
1872 case OPT_OMIT_HOME_PLUGIN_PATH
:
1873 cfg
->omit_home_plugin_path
= true;
1876 print_help_usage(stdout
);
1878 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1881 printf_err("Unknown command-line option specified (option code %d)\n",
1890 /* Check for option parsing error */
1892 printf_err("While parsing command-line options, at option %s: %s\n",
1893 poptBadOption(pc
, 0), poptStrerror(opt
));
1897 leftover
= poptGetArg(pc
);
1899 plugin_comp_cls_names(leftover
, NULL
,
1900 &plugin_name
, &comp_cls_name
,
1901 &cfg
->cmd_data
.help
.cfg_component
->type
);
1902 if (plugin_name
&& comp_cls_name
) {
1903 /* Component class help */
1905 cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1908 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
,
1911 /* Fall back to plugin help */
1913 cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1917 print_help_usage(stdout
);
1919 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1923 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
1931 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
1934 g_free(plugin_name
);
1935 g_free(comp_cls_name
);
1938 poptFreeContext(pc
);
1946 * Prints the help command usage.
1949 void print_query_usage(FILE *fp
)
1951 fprintf(fp
, "Usage: babeltrace [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1953 fprintf(fp
, "Options:\n");
1955 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1956 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
1957 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1958 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS\n");
1959 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1960 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1961 fprintf(fp
, " dynamic plugins can be loaded\n");
1962 fprintf(fp
, " -h, --help Show this help and quit\n");
1963 fprintf(fp
, "\n\n");
1964 print_expected_params_format(fp
);
1968 struct poptOption query_long_options
[] = {
1969 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1970 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1971 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1972 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1973 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
1974 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1975 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1979 * Creates a Babeltrace config object from the arguments of a query
1982 * *retcode is set to the appropriate exit code to use.
1985 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1986 int *retcode
, bool force_omit_system_plugin_path
,
1987 bool force_omit_home_plugin_path
,
1988 const struct bt_value
*initial_plugin_paths
)
1990 poptContext pc
= NULL
;
1994 struct bt_config
*cfg
= NULL
;
1995 const char *leftover
;
1996 struct bt_value
*params
= bt_value_null
;
1999 cfg
= bt_config_query_create(initial_plugin_paths
);
2004 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
2005 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
2006 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
2012 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2013 query_long_options
, 0);
2015 printf_err("Cannot get popt context\n");
2019 poptReadDefaultConfig(pc
, 0);
2021 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2022 arg
= poptGetOptArg(pc
);
2025 case OPT_PLUGIN_PATH
:
2026 if (bt_config_append_plugin_paths_check_setuid_setgid(
2027 cfg
->plugin_paths
, arg
)) {
2031 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2032 cfg
->omit_system_plugin_path
= true;
2034 case OPT_OMIT_HOME_PLUGIN_PATH
:
2035 cfg
->omit_home_plugin_path
= true;
2039 bt_object_put_ref(params
);
2040 params
= bt_value_from_arg(arg
);
2042 printf_err("Invalid format for --params option's argument:\n %s\n",
2049 print_query_usage(stdout
);
2051 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2054 printf_err("Unknown command-line option specified (option code %d)\n",
2063 /* Check for option parsing error */
2065 printf_err("While parsing command-line options, at option %s: %s\n",
2066 poptBadOption(pc
, 0), poptStrerror(opt
));
2071 * We need exactly two leftover arguments which are the
2072 * mandatory component class specification and query object.
2074 leftover
= poptGetArg(pc
);
2076 cfg
->cmd_data
.query
.cfg_component
=
2077 bt_config_component_from_arg(leftover
);
2078 if (!cfg
->cmd_data
.query
.cfg_component
) {
2079 printf_err("Invalid format for component class specification:\n %s\n",
2085 BT_OBJECT_MOVE_REF(cfg
->cmd_data
.query
.cfg_component
->params
,
2088 print_query_usage(stdout
);
2090 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2094 leftover
= poptGetArg(pc
);
2096 if (strlen(leftover
) == 0) {
2097 printf_err("Invalid empty object\n");
2101 g_string_assign(cfg
->cmd_data
.query
.object
, leftover
);
2103 print_query_usage(stdout
);
2105 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2109 leftover
= poptGetArg(pc
);
2111 printf_err("Unexpected argument: %s\n", leftover
);
2115 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2123 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2127 poptFreeContext(pc
);
2130 bt_object_put_ref(params
);
2136 * Prints the list-plugins command usage.
2139 void print_list_plugins_usage(FILE *fp
)
2141 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
2143 fprintf(fp
, "Options:\n");
2145 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2146 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2147 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2148 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2149 fprintf(fp
, " dynamic plugins can be loaded\n");
2150 fprintf(fp
, " -h, --help Show this help and quit\n");
2152 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2154 fprintf(fp
, "Use `babeltrace help` to get help for a specific plugin or component class.\n");
2158 struct poptOption list_plugins_long_options
[] = {
2159 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2160 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2161 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2162 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2163 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2164 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
2168 * Creates a Babeltrace config object from the arguments of a
2169 * list-plugins command.
2171 * *retcode is set to the appropriate exit code to use.
2174 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
2175 int *retcode
, bool force_omit_system_plugin_path
,
2176 bool force_omit_home_plugin_path
,
2177 const struct bt_value
*initial_plugin_paths
)
2179 poptContext pc
= NULL
;
2183 struct bt_config
*cfg
= NULL
;
2184 const char *leftover
;
2187 cfg
= bt_config_list_plugins_create(initial_plugin_paths
);
2192 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
2193 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
2194 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
2200 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2201 list_plugins_long_options
, 0);
2203 printf_err("Cannot get popt context\n");
2207 poptReadDefaultConfig(pc
, 0);
2209 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2210 arg
= poptGetOptArg(pc
);
2213 case OPT_PLUGIN_PATH
:
2214 if (bt_config_append_plugin_paths_check_setuid_setgid(
2215 cfg
->plugin_paths
, arg
)) {
2219 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2220 cfg
->omit_system_plugin_path
= true;
2222 case OPT_OMIT_HOME_PLUGIN_PATH
:
2223 cfg
->omit_home_plugin_path
= true;
2226 print_list_plugins_usage(stdout
);
2228 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2231 printf_err("Unknown command-line option specified (option code %d)\n",
2240 /* Check for option parsing error */
2242 printf_err("While parsing command-line options, at option %s: %s\n",
2243 poptBadOption(pc
, 0), poptStrerror(opt
));
2247 leftover
= poptGetArg(pc
);
2249 printf_err("Unexpected argument: %s\n", leftover
);
2253 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2261 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2265 poptFreeContext(pc
);
2273 * Prints the run command usage.
2276 void print_run_usage(FILE *fp
)
2278 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] run [OPTIONS]\n");
2280 fprintf(fp
, "Options:\n");
2282 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
2283 fprintf(fp
, " for all the following components until\n");
2284 fprintf(fp
, " --reset-base-params is encountered\n");
2285 fprintf(fp
, " (see the expected format of PARAMS below)\n");
2286 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2287 fprintf(fp
, " Instantiate the component class CLS of type\n");
2288 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2289 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
2290 fprintf(fp
, " and optionally name it NAME (you can also\n");
2291 fprintf(fp
, " specify the name with --name)\n");
2292 fprintf(fp
, " -C, --connect=CONNECTION Connect two created components (see the\n");
2293 fprintf(fp
, " expected format of CONNECTION below)\n");
2294 fprintf(fp
, " --key=KEY Set the current initialization string\n");
2295 fprintf(fp
, " parameter key to KEY (see --value)\n");
2296 fprintf(fp
, " -n, --name=NAME Set the name of the current component\n");
2297 fprintf(fp
, " to NAME (must be unique amongst all the\n");
2298 fprintf(fp
, " names of the created components)\n");
2299 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2300 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2301 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2302 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2303 fprintf(fp
, " current component (see the expected format\n");
2304 fprintf(fp
, " of PARAMS below)\n");
2305 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2306 fprintf(fp
, " dynamic plugins can be loaded\n");
2307 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
2308 fprintf(fp
, " empty map\n");
2309 fprintf(fp
, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n");
2310 fprintf(fp
, " the graph later, retry in DUR µs\n");
2311 fprintf(fp
, " (default: 100000)\n");
2312 fprintf(fp
, " --value=VAL Add a string initialization parameter to\n");
2313 fprintf(fp
, " the current component with a name given by\n");
2314 fprintf(fp
, " the last argument of the --key option and a\n");
2315 fprintf(fp
, " value set to VAL\n");
2316 fprintf(fp
, " -h, --help Show this help and quit\n");
2318 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2319 fprintf(fp
, "\n\n");
2320 fprintf(fp
, "Expected format of CONNECTION\n");
2321 fprintf(fp
, "-----------------------------\n");
2323 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
2325 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
2326 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
2327 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You can set the name of the current\n");
2328 fprintf(fp
, "component with the --name option.\n");
2330 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
2331 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
2332 fprintf(fp
, "When the port is not specified, `*` is used.\n");
2334 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
2335 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
2336 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
2337 fprintf(fp
, "DOWNSTREAM.\n");
2339 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
2340 fprintf(fp
, "which matches anything. You must escape the following characters\n");
2341 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
2343 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
2344 fprintf(fp
, "can connect a filter component to a sink component.\n");
2346 fprintf(fp
, "Examples:\n");
2348 fprintf(fp
, " my-src:my-sink\n");
2349 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
2351 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
2352 fprintf(fp
, "babeltrace from a shell.\n");
2353 fprintf(fp
, "\n\n");
2354 print_expected_params_format(fp
);
2358 * Creates a Babeltrace config object from the arguments of a run
2361 * *retcode is set to the appropriate exit code to use.
2364 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
2365 int *retcode
, bool force_omit_system_plugin_path
,
2366 bool force_omit_home_plugin_path
,
2367 const struct bt_value
*initial_plugin_paths
)
2369 poptContext pc
= NULL
;
2371 struct bt_config_component
*cur_cfg_comp
= NULL
;
2372 enum bt_config_component_dest cur_cfg_comp_dest
=
2373 BT_CONFIG_COMPONENT_DEST_UNKNOWN
;
2374 struct bt_value
*cur_base_params
= NULL
;
2376 struct bt_config
*cfg
= NULL
;
2377 struct bt_value
*instance_names
= NULL
;
2378 struct bt_value
*connection_args
= NULL
;
2379 GString
*cur_param_key
= NULL
;
2380 char error_buf
[256] = { 0 };
2381 long retry_duration
= -1;
2382 enum bt_value_status status
;
2383 struct poptOption run_long_options
[] = {
2384 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
2385 { "component", 'c', POPT_ARG_STRING
, NULL
, OPT_COMPONENT
, NULL
, NULL
},
2386 { "connect", 'C', POPT_ARG_STRING
, NULL
, OPT_CONNECT
, NULL
, NULL
},
2387 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2388 { "key", '\0', POPT_ARG_STRING
, NULL
, OPT_KEY
, NULL
, NULL
},
2389 { "name", 'n', POPT_ARG_STRING
, NULL
, OPT_NAME
, NULL
, NULL
},
2390 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2391 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2392 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2393 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2394 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
2395 { "retry-duration", '\0', POPT_ARG_LONG
, &retry_duration
, OPT_RETRY_DURATION
, NULL
, NULL
},
2396 { "value", '\0', POPT_ARG_STRING
, NULL
, OPT_VALUE
, NULL
, NULL
},
2397 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
2401 cur_param_key
= g_string_new(NULL
);
2402 if (!cur_param_key
) {
2408 print_run_usage(stdout
);
2413 cfg
= bt_config_run_create(initial_plugin_paths
);
2418 cfg
->cmd_data
.run
.retry_duration_us
= 100000;
2419 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
2420 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
2421 cur_base_params
= bt_value_map_create();
2422 if (!cur_base_params
) {
2427 instance_names
= bt_value_map_create();
2428 if (!instance_names
) {
2433 connection_args
= bt_value_array_create();
2434 if (!connection_args
) {
2439 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
2445 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2446 run_long_options
, 0);
2448 printf_err("Cannot get popt context\n");
2452 poptReadDefaultConfig(pc
, 0);
2454 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2455 arg
= poptGetOptArg(pc
);
2458 case OPT_PLUGIN_PATH
:
2459 if (bt_config_append_plugin_paths_check_setuid_setgid(
2460 cfg
->plugin_paths
, arg
)) {
2464 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2465 cfg
->omit_system_plugin_path
= true;
2467 case OPT_OMIT_HOME_PLUGIN_PATH
:
2468 cfg
->omit_home_plugin_path
= true;
2472 enum bt_config_component_dest new_dest
;
2475 ret
= add_run_cfg_comp_check_name(cfg
,
2476 cur_cfg_comp
, cur_cfg_comp_dest
,
2478 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2484 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2485 if (!cur_cfg_comp
) {
2486 printf_err("Invalid format for --component option's argument:\n %s\n",
2491 switch (cur_cfg_comp
->type
) {
2492 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2493 new_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2495 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2496 new_dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
2498 case BT_COMPONENT_CLASS_TYPE_SINK
:
2499 new_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2505 BT_ASSERT(cur_base_params
);
2506 bt_object_put_ref(cur_cfg_comp
->params
);
2507 status
= bt_value_copy(
2508 &cur_cfg_comp
->params
,
2510 if (status
!= BT_VALUE_STATUS_OK
) {
2515 cur_cfg_comp_dest
= new_dest
;
2520 struct bt_value
*params
;
2521 struct bt_value
*params_to_set
;
2523 if (!cur_cfg_comp
) {
2524 printf_err("Cannot add parameters to unavailable component:\n %s\n",
2529 params
= bt_value_from_arg(arg
);
2531 printf_err("Invalid format for --params option's argument:\n %s\n",
2536 status
= bt_value_map_extend(¶ms_to_set
,
2537 cur_cfg_comp
->params
,
2539 BT_OBJECT_PUT_REF_AND_RESET(params
);
2540 if (status
!= BT_VALUE_STATUS_OK
) {
2541 printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n",
2546 BT_OBJECT_MOVE_REF(cur_cfg_comp
->params
, params_to_set
);
2550 if (strlen(arg
) == 0) {
2551 printf_err("Cannot set an empty string as the current parameter key\n");
2555 g_string_assign(cur_param_key
, arg
);
2558 if (!cur_cfg_comp
) {
2559 printf_err("Cannot set a parameter's value of unavailable component:\n %s\n",
2564 if (cur_param_key
->len
== 0) {
2565 printf_err("--value option specified without preceding --key option:\n %s\n",
2570 if (bt_value_map_insert_string_entry(cur_cfg_comp
->params
,
2571 cur_param_key
->str
, arg
)) {
2577 if (!cur_cfg_comp
) {
2578 printf_err("Cannot set the name of unavailable component:\n %s\n",
2583 g_string_assign(cur_cfg_comp
->instance_name
, arg
);
2585 case OPT_BASE_PARAMS
:
2587 struct bt_value
*params
=
2588 bt_value_from_arg(arg
);
2591 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2596 BT_OBJECT_MOVE_REF(cur_base_params
, params
);
2599 case OPT_RESET_BASE_PARAMS
:
2600 BT_OBJECT_PUT_REF_AND_RESET(cur_base_params
);
2601 cur_base_params
= bt_value_map_create();
2602 if (!cur_base_params
) {
2608 if (bt_value_array_append_string_element(
2609 connection_args
, arg
)) {
2614 case OPT_RETRY_DURATION
:
2615 if (retry_duration
< 0) {
2616 printf_err("--retry-duration option's argument must be positive or 0: %ld\n",
2621 cfg
->cmd_data
.run
.retry_duration_us
=
2622 (uint64_t) retry_duration
;
2625 print_run_usage(stdout
);
2627 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2630 printf_err("Unknown command-line option specified (option code %d)\n",
2639 /* Check for option parsing error */
2641 printf_err("While parsing command-line options, at option %s: %s\n",
2642 poptBadOption(pc
, 0), poptStrerror(opt
));
2646 /* This command does not accept leftover arguments */
2647 if (poptPeekArg(pc
)) {
2648 printf_err("Unexpected argument: %s\n", poptPeekArg(pc
));
2652 /* Add current component */
2654 ret
= add_run_cfg_comp_check_name(cfg
, cur_cfg_comp
,
2655 cur_cfg_comp_dest
, instance_names
);
2656 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2662 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2663 printf_err("Incomplete graph: no source component\n");
2667 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2668 printf_err("Incomplete graph: no sink component\n");
2672 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2676 ret
= bt_config_cli_args_create_connections(cfg
,
2680 printf_err("Cannot creation connections:\n%s", error_buf
);
2688 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2692 poptFreeContext(pc
);
2695 if (cur_param_key
) {
2696 g_string_free(cur_param_key
, TRUE
);
2700 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp
);
2701 BT_OBJECT_PUT_REF_AND_RESET(cur_base_params
);
2702 BT_OBJECT_PUT_REF_AND_RESET(instance_names
);
2703 BT_OBJECT_PUT_REF_AND_RESET(connection_args
);
2708 struct bt_config
*bt_config_run_from_args_array(const struct bt_value
*run_args
,
2709 int *retcode
, bool force_omit_system_plugin_path
,
2710 bool force_omit_home_plugin_path
,
2711 const struct bt_value
*initial_plugin_paths
)
2713 struct bt_config
*cfg
= NULL
;
2716 const size_t argc
= bt_value_array_get_size(run_args
) + 1;
2718 argv
= calloc(argc
, sizeof(*argv
));
2726 len
= bt_value_array_get_size(run_args
);
2728 printf_err("Invalid executable arguments\n");
2731 for (i
= 0; i
< len
; i
++) {
2732 const struct bt_value
*arg_value
=
2733 bt_value_array_borrow_element_by_index_const(run_args
,
2737 BT_ASSERT(arg_value
);
2738 arg
= bt_value_string_get(arg_value
);
2743 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2744 force_omit_system_plugin_path
, force_omit_home_plugin_path
,
2745 initial_plugin_paths
);
2753 * Prints the convert command usage.
2756 void print_convert_usage(FILE *fp
)
2758 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2760 fprintf(fp
, "Options:\n");
2762 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2763 fprintf(fp
, " Instantiate the component class CLS of type\n");
2764 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2765 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2766 fprintf(fp
, " conversion graph, and optionally name it\n");
2767 fprintf(fp
, " NAME (you can also specify the name with\n");
2768 fprintf(fp
, " --name)\n");
2769 fprintf(fp
, " --name=NAME Set the name of the current component\n");
2770 fprintf(fp
, " to NAME (must be unique amongst all the\n");
2771 fprintf(fp
, " names of the created components)\n");
2772 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2773 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2774 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2775 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2776 fprintf(fp
, " current component (see the expected format\n");
2777 fprintf(fp
, " of PARAMS below)\n");
2778 fprintf(fp
, " -P, --path=PATH Set the `path` string parameter of the\n");
2779 fprintf(fp
, " current component to PATH\n");
2780 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2781 fprintf(fp
, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n");
2782 fprintf(fp
, " the graph later, retry in DUR µs\n");
2783 fprintf(fp
, " (default: 100000)\n");
2784 fprintf(fp
, " dynamic plugins can be loaded\n");
2785 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2786 fprintf(fp
, " `run` command to the standard output,\n");
2787 fprintf(fp
, " formatted for a shell, and quit\n");
2788 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2789 fprintf(fp
, " `run` command to the standard output,\n");
2790 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2791 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2792 fprintf(fp
, " are active\n");
2793 fprintf(fp
, " -u, --url=URL Set the `url` string parameter of the\n");
2794 fprintf(fp
, " current component to URL\n");
2795 fprintf(fp
, " -h, --help Show this help and quit\n");
2797 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2799 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2800 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2802 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2804 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2805 fprintf(fp
, " --clock-date Print timestamp dates\n");
2806 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2807 fprintf(fp
, " time zone instead of the local time zone\n");
2808 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2809 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2810 fprintf(fp
, " --color=(never | auto | always)\n");
2811 fprintf(fp
, " Never, automatically, or always emit\n");
2812 fprintf(fp
, " console color codes\n");
2813 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2814 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2815 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2816 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2817 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2818 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2819 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2820 fprintf(fp
, " (or `ctx`)\n");
2821 fprintf(fp
, " --no-delta Do not print time delta between\n");
2822 fprintf(fp
, " consecutive events\n");
2823 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2824 fprintf(fp
, " the standard output\n");
2826 fprintf(fp
, "Implicit `filter.utils.muxer` component options:\n");
2828 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently\n");
2829 fprintf(fp
, " correlated across traces\n");
2831 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2833 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2834 fprintf(fp
, " time range to BEGIN (see the format of\n");
2835 fprintf(fp
, " BEGIN below)\n");
2836 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2837 fprintf(fp
, " range to END (see the format of END below)\n");
2838 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2839 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2840 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2842 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2844 fprintf(fp
, " --debug-info Create an implicit\n");
2845 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2846 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2847 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2848 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2849 fprintf(fp
, " binary paths instead of just names\n");
2850 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2851 fprintf(fp
, " Use directory DIR as a prefix when\n");
2852 fprintf(fp
, " looking up executables during debug\n");
2853 fprintf(fp
, " info analysis\n");
2855 fprintf(fp
, "Legacy options that still work:\n");
2857 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2858 fprintf(fp
, " `ctf`:\n");
2859 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2860 fprintf(fp
, " component\n");
2861 fprintf(fp
, " `lttng-live`:\n");
2862 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2863 fprintf(fp
, " component\n");
2864 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2865 fprintf(fp
, " `text`:\n");
2866 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2867 fprintf(fp
, " component\n");
2868 fprintf(fp
, " `ctf`:\n");
2869 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2870 fprintf(fp
, " component\n");
2871 fprintf(fp
, " `dummy`:\n");
2872 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2873 fprintf(fp
, " component\n");
2874 fprintf(fp
, " `ctf-metadata`:\n");
2875 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2876 fprintf(fp
, " for metadata text and quit\n");
2878 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2879 fprintf(fp
, "\n\n");
2880 fprintf(fp
, "Format of BEGIN and END\n");
2881 fprintf(fp
, "-----------------------\n");
2883 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2884 fprintf(fp
, "\n\n");
2885 print_expected_params_format(fp
);
2889 struct poptOption convert_long_options
[] = {
2890 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2891 { "begin", 'b', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2892 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2893 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2894 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2895 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2896 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2897 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2898 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2899 { "color", '\0', POPT_ARG_STRING
, NULL
, OPT_COLOR
, NULL
, NULL
},
2900 { "component", 'c', POPT_ARG_STRING
, NULL
, OPT_COMPONENT
, NULL
, NULL
},
2901 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2902 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2903 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2904 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2905 { "end", 'e', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2906 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2907 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2908 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2909 { "name", '\0', POPT_ARG_STRING
, NULL
, OPT_NAME
, NULL
, NULL
},
2910 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2911 { "debug-info", '\0', POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO
, NULL
, NULL
},
2912 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2913 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2914 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2915 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT
, NULL
, NULL
},
2916 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2917 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2918 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2919 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2920 { "retry-duration", '\0', POPT_ARG_STRING
, NULL
, OPT_RETRY_DURATION
, NULL
, NULL
},
2921 { "run-args", '\0', POPT_ARG_NONE
, NULL
, OPT_RUN_ARGS
, NULL
, NULL
},
2922 { "run-args-0", '\0', POPT_ARG_NONE
, NULL
, OPT_RUN_ARGS_0
, NULL
, NULL
},
2923 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2924 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2925 { "url", 'u', POPT_ARG_STRING
, NULL
, OPT_URL
, NULL
, NULL
},
2926 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2927 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
2931 GString
*get_component_auto_name(const char *prefix
,
2932 const struct bt_value
*existing_names
)
2935 GString
*auto_name
= g_string_new(NULL
);
2942 if (!bt_value_map_has_entry(existing_names
, prefix
)) {
2943 g_string_assign(auto_name
, prefix
);
2948 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2950 } while (bt_value_map_has_entry(existing_names
, auto_name
->str
));
2956 struct implicit_component_args
{
2960 GString
*params_arg
;
2961 struct bt_value
*extra_params
;
2965 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2966 const char *prefix
, struct bt_value
*existing_names
,
2967 GList
**comp_names
, bool append_to_comp_names
)
2970 GString
*name
= NULL
;
2972 if (!args
->exists
) {
2976 name
= get_component_auto_name(prefix
,
2984 g_string_assign(args
->name_arg
, name
->str
);
2986 if (bt_value_map_insert_entry(existing_names
, name
->str
,
2993 if (append_to_comp_names
) {
2994 *comp_names
= g_list_append(*comp_names
, name
);
3000 g_string_free(name
, TRUE
);
3007 int append_run_args_for_implicit_component(
3008 struct implicit_component_args
*impl_args
,
3009 struct bt_value
*run_args
)
3014 if (!impl_args
->exists
) {
3018 if (bt_value_array_append_string_element(run_args
, "--component")) {
3023 if (bt_value_array_append_string_element(run_args
, impl_args
->comp_arg
->str
)) {
3028 if (bt_value_array_append_string_element(run_args
, "--name")) {
3033 if (bt_value_array_append_string_element(run_args
, impl_args
->name_arg
->str
)) {
3038 if (impl_args
->params_arg
->len
> 0) {
3039 if (bt_value_array_append_string_element(run_args
, "--params")) {
3044 if (bt_value_array_append_string_element(run_args
,
3045 impl_args
->params_arg
->str
)) {
3051 for (i
= 0; i
< bt_value_array_get_size(impl_args
->extra_params
);
3053 const struct bt_value
*elem
;
3056 elem
= bt_value_array_borrow_element_by_index(impl_args
->extra_params
,
3062 BT_ASSERT(bt_value_is_string(elem
));
3063 arg
= bt_value_string_get(elem
);
3064 ret
= bt_value_array_append_string_element(run_args
, arg
);
3081 void finalize_implicit_component_args(struct implicit_component_args
*args
)
3085 if (args
->comp_arg
) {
3086 g_string_free(args
->comp_arg
, TRUE
);
3089 if (args
->name_arg
) {
3090 g_string_free(args
->name_arg
, TRUE
);
3093 if (args
->params_arg
) {
3094 g_string_free(args
->params_arg
, TRUE
);
3097 bt_object_put_ref(args
->extra_params
);
3101 void destroy_implicit_component_args(void *args
)
3107 finalize_implicit_component_args(args
);
3112 int init_implicit_component_args(struct implicit_component_args
*args
,
3113 const char *comp_arg
, bool exists
)
3117 args
->exists
= exists
;
3118 args
->comp_arg
= g_string_new(comp_arg
);
3119 args
->name_arg
= g_string_new(NULL
);
3120 args
->params_arg
= g_string_new(NULL
);
3121 args
->extra_params
= bt_value_array_create();
3123 if (!args
->comp_arg
|| !args
->name_arg
||
3124 !args
->params_arg
|| !args
->extra_params
) {
3126 finalize_implicit_component_args(args
);
3136 void append_implicit_component_param(struct implicit_component_args
*args
,
3137 const char *key
, const char *value
)
3142 append_param_arg(args
->params_arg
, key
, value
);
3146 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
3147 const char *key
, const char *value
)
3155 if (bt_value_array_append_string_element(args
->extra_params
, "--key")) {
3161 if (bt_value_array_append_string_element(args
->extra_params
, key
)) {
3167 if (bt_value_array_append_string_element(args
->extra_params
, "--value")) {
3173 if (bt_value_array_append_string_element(args
->extra_params
, value
)) {
3184 int convert_append_name_param(enum bt_config_component_dest dest
,
3185 GString
*cur_name
, GString
*cur_name_prefix
,
3186 struct bt_value
*run_args
,
3187 struct bt_value
*all_names
,
3188 GList
**source_names
, GList
**filter_names
,
3193 if (cur_name_prefix
->len
> 0) {
3194 /* We're after a --component option */
3195 GString
*name
= NULL
;
3196 bool append_name_opt
= false;
3198 if (cur_name
->len
== 0) {
3200 * No explicit name was provided for the user
3203 name
= get_component_auto_name(cur_name_prefix
->str
,
3205 append_name_opt
= true;
3208 * An explicit name was provided for the user
3211 if (bt_value_map_has_entry(all_names
,
3213 printf_err("Duplicate component instance name:\n %s\n",
3218 name
= g_string_new(cur_name
->str
);
3227 * Remember this name globally, for the uniqueness of
3228 * all component names.
3230 if (bt_value_map_insert_entry(all_names
, name
->str
, bt_value_null
)) {
3236 * Append the --name option if necessary.
3238 if (append_name_opt
) {
3239 if (bt_value_array_append_string_element(run_args
, "--name")) {
3244 if (bt_value_array_append_string_element(run_args
, name
->str
)) {
3251 * Remember this name specifically for the type of the
3252 * component. This is to create connection arguments.
3255 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
3256 *source_names
= g_list_append(*source_names
, name
);
3258 case BT_CONFIG_COMPONENT_DEST_FILTER
:
3259 *filter_names
= g_list_append(*filter_names
, name
);
3261 case BT_CONFIG_COMPONENT_DEST_SINK
:
3262 *sink_names
= g_list_append(*sink_names
, name
);
3268 g_string_assign(cur_name_prefix
, "");
3281 * Escapes `.`, `:`, and `\` of `input` with `\`.
3284 GString
*escape_dot_colon(const char *input
)
3286 GString
*output
= g_string_new(NULL
);
3294 for (ch
= input
; *ch
!= '\0'; ch
++) {
3295 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
3296 g_string_append_c(output
, '\\');
3299 g_string_append_c(output
, *ch
);
3307 * Appends a --connect option to a list of arguments. `upstream_name`
3308 * and `downstream_name` are escaped with escape_dot_colon() in this
3312 int append_connect_arg(struct bt_value
*run_args
,
3313 const char *upstream_name
, const char *downstream_name
)
3316 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
3317 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
3318 GString
*arg
= g_string_new(NULL
);
3320 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
3326 ret
= bt_value_array_append_string_element(run_args
, "--connect");
3333 g_string_append(arg
, e_upstream_name
->str
);
3334 g_string_append_c(arg
, ':');
3335 g_string_append(arg
, e_downstream_name
->str
);
3336 ret
= bt_value_array_append_string_element(run_args
, arg
->str
);
3345 g_string_free(arg
, TRUE
);
3348 if (e_upstream_name
) {
3349 g_string_free(e_upstream_name
, TRUE
);
3352 if (e_downstream_name
) {
3353 g_string_free(e_downstream_name
, TRUE
);
3360 * Appends the run command's --connect options for the convert command.
3363 int convert_auto_connect(struct bt_value
*run_args
,
3364 GList
*source_names
, GList
*filter_names
,
3368 GList
*source_at
= source_names
;
3369 GList
*filter_at
= filter_names
;
3371 GList
*sink_at
= sink_names
;
3373 BT_ASSERT(source_names
);
3374 BT_ASSERT(filter_names
);
3375 BT_ASSERT(sink_names
);
3377 /* Connect all sources to the first filter */
3378 for (source_at
= source_names
; source_at
!= NULL
; source_at
= g_list_next(source_at
)) {
3379 GString
*source_name
= source_at
->data
;
3380 GString
*filter_name
= filter_at
->data
;
3382 ret
= append_connect_arg(run_args
, source_name
->str
,
3389 filter_prev
= filter_at
;
3390 filter_at
= g_list_next(filter_at
);
3392 /* Connect remaining filters */
3393 for (; filter_at
!= NULL
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
3394 GString
*filter_name
= filter_at
->data
;
3395 GString
*filter_prev_name
= filter_prev
->data
;
3397 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
3404 /* Connect last filter to all sinks */
3405 for (sink_at
= sink_names
; sink_at
!= NULL
; sink_at
= g_list_next(sink_at
)) {
3406 GString
*filter_name
= filter_prev
->data
;
3407 GString
*sink_name
= sink_at
->data
;
3409 ret
= append_connect_arg(run_args
, filter_name
->str
,
3426 int split_timerange(const char *arg
, char **begin
, char **end
)
3429 const char *ch
= arg
;
3431 GString
*g_begin
= NULL
;
3432 GString
*g_end
= NULL
;
3440 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
3441 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
3447 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
3448 if (!g_end
|| g_end
->len
== 0) {
3454 *begin
= g_begin
->str
;
3456 g_string_free(g_begin
, FALSE
);
3457 g_string_free(g_end
, FALSE
);
3467 g_string_free(g_begin
, TRUE
);
3471 g_string_free(g_end
, TRUE
);
3478 int g_list_prepend_gstring(GList
**list
, const char *string
)
3481 GString
*gs
= g_string_new(string
);
3490 *list
= g_list_prepend(*list
, gs
);
3497 struct implicit_component_args
*create_implicit_component_args(void)
3499 struct implicit_component_args
*impl_args
=
3500 g_new0(struct implicit_component_args
, 1);
3506 if (init_implicit_component_args(impl_args
, NULL
, true)) {
3507 destroy_implicit_component_args(impl_args
);
3517 int fill_implicit_ctf_inputs_args(GPtrArray
*implicit_ctf_inputs_args
,
3518 struct implicit_component_args
*base_implicit_ctf_input_args
,
3523 enum bt_value_status status
;
3525 for (leftover
= leftovers
; leftover
!= NULL
;
3526 leftover
= g_list_next(leftover
)) {
3527 GString
*gs_leftover
= leftover
->data
;
3528 struct implicit_component_args
*impl_args
=
3529 create_implicit_component_args();
3536 impl_args
->exists
= true;
3537 g_string_assign(impl_args
->comp_arg
,
3538 base_implicit_ctf_input_args
->comp_arg
->str
);
3539 g_string_assign(impl_args
->params_arg
,
3540 base_implicit_ctf_input_args
->params_arg
->str
);
3543 * We need our own copy of the extra parameters because
3544 * this is where the unique path goes.
3546 BT_OBJECT_PUT_REF_AND_RESET(impl_args
->extra_params
);
3547 status
= bt_value_copy(&impl_args
->extra_params
,
3548 base_implicit_ctf_input_args
->extra_params
);
3549 if (status
!= BT_VALUE_STATUS_OK
) {
3551 destroy_implicit_component_args(impl_args
);
3555 /* Append unique path parameter */
3556 ret
= append_implicit_component_extra_param(impl_args
,
3557 "path", gs_leftover
->str
);
3559 destroy_implicit_component_args(impl_args
);
3563 g_ptr_array_add(implicit_ctf_inputs_args
, impl_args
);
3576 * Creates a Babeltrace config object from the arguments of a convert
3579 * *retcode is set to the appropriate exit code to use.
3582 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3583 int *retcode
, bool force_omit_system_plugin_path
,
3584 bool force_omit_home_plugin_path
,
3585 const struct bt_value
*initial_plugin_paths
, char *log_level
)
3587 poptContext pc
= NULL
;
3589 enum bt_config_component_dest cur_comp_dest
=
3590 BT_CONFIG_COMPONENT_DEST_UNKNOWN
;
3592 struct bt_config
*cfg
= NULL
;
3593 bool got_input_format_opt
= false;
3594 bool got_output_format_opt
= false;
3595 bool trimmer_has_begin
= false;
3596 bool trimmer_has_end
= false;
3597 bool stream_intersection_mode
= false;
3598 GString
*cur_name
= NULL
;
3599 GString
*cur_name_prefix
= NULL
;
3600 const char *leftover
= NULL
;
3601 bool print_run_args
= false;
3602 bool print_run_args_0
= false;
3603 bool print_ctf_metadata
= false;
3604 struct bt_value
*run_args
= NULL
;
3605 struct bt_value
*all_names
= NULL
;
3606 GList
*source_names
= NULL
;
3607 GList
*filter_names
= NULL
;
3608 GList
*sink_names
= NULL
;
3609 GList
*leftovers
= NULL
;
3610 GPtrArray
*implicit_ctf_inputs_args
= NULL
;
3611 struct implicit_component_args base_implicit_ctf_input_args
= { 0 };
3612 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3613 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3614 struct implicit_component_args implicit_dummy_args
= { 0 };
3615 struct implicit_component_args implicit_text_args
= { 0 };
3616 struct implicit_component_args implicit_debug_info_args
= { 0 };
3617 struct implicit_component_args implicit_muxer_args
= { 0 };
3618 struct implicit_component_args implicit_trimmer_args
= { 0 };
3619 struct bt_value
*plugin_paths
;
3620 char error_buf
[256] = { 0 };
3622 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3623 char *output
= NULL
;
3625 (void) bt_value_copy(&plugin_paths
, initial_plugin_paths
);
3630 print_convert_usage(stdout
);
3635 if (init_implicit_component_args(&base_implicit_ctf_input_args
,
3636 "source.ctf.fs", false)) {
3640 if (init_implicit_component_args(&implicit_ctf_output_args
,
3641 "sink.ctf.fs", false)) {
3645 if (init_implicit_component_args(&implicit_lttng_live_args
,
3646 "source.ctf.lttng-live", false)) {
3650 if (init_implicit_component_args(&implicit_text_args
,
3651 "sink.text.pretty", false)) {
3655 if (init_implicit_component_args(&implicit_dummy_args
,
3656 "sink.utils.dummy", false)) {
3660 if (init_implicit_component_args(&implicit_debug_info_args
,
3661 "filter.lttng-utils.debug-info", false)) {
3665 if (init_implicit_component_args(&implicit_muxer_args
,
3666 "filter.utils.muxer", true)) {
3670 if (init_implicit_component_args(&implicit_trimmer_args
,
3671 "filter.utils.trimmer", false)) {
3675 implicit_ctf_inputs_args
= g_ptr_array_new_with_free_func(
3676 (GDestroyNotify
) destroy_implicit_component_args
);
3677 if (!implicit_ctf_inputs_args
) {
3682 all_names
= bt_value_map_create();
3688 run_args
= bt_value_array_create();
3694 cur_name
= g_string_new(NULL
);
3700 cur_name_prefix
= g_string_new(NULL
);
3701 if (!cur_name_prefix
) {
3706 ret
= append_env_var_plugin_paths(plugin_paths
);
3712 * First pass: collect all arguments which need to be passed
3713 * as is to the run command. This pass can also add --name
3714 * arguments if needed to automatically name unnamed component
3715 * instances. Also it does the following transformations:
3717 * --path=PATH -> --key path --value PATH
3718 * --url=URL -> --key url --value URL
3720 * Also it appends the plugin paths of --plugin-path to
3723 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
3724 convert_long_options
, 0);
3726 printf_err("Cannot get popt context\n");
3730 poptReadDefaultConfig(pc
, 0);
3732 while ((opt
= poptGetNextOpt(pc
)) > 0) {
3734 char *plugin_name
= NULL
;
3735 char *comp_cls_name
= NULL
;
3737 arg
= poptGetOptArg(pc
);
3742 enum bt_component_class_type type
;
3743 const char *type_prefix
;
3745 /* Append current component's name if needed */
3746 ret
= convert_append_name_param(cur_comp_dest
, cur_name
,
3747 cur_name_prefix
, run_args
, all_names
,
3748 &source_names
, &filter_names
, &sink_names
);
3753 /* Parse the argument */
3754 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3755 &comp_cls_name
, &type
);
3756 if (!plugin_name
|| !comp_cls_name
) {
3757 printf_err("Invalid format for --component option's argument:\n %s\n",
3763 g_string_assign(cur_name
, name
);
3765 g_string_assign(cur_name
, "");
3769 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3770 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
3771 type_prefix
= "source";
3773 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3774 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
3775 type_prefix
= "filter";
3777 case BT_COMPONENT_CLASS_TYPE_SINK
:
3778 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
3779 type_prefix
= "sink";
3785 if (bt_value_array_append_string_element(run_args
,
3791 if (bt_value_array_append_string_element(run_args
, arg
)) {
3796 g_string_assign(cur_name_prefix
, "");
3797 g_string_append_printf(cur_name_prefix
, "%s.%s.%s",
3798 type_prefix
, plugin_name
, comp_cls_name
);
3801 free(comp_cls_name
);
3804 comp_cls_name
= NULL
;
3808 if (cur_name_prefix
->len
== 0) {
3809 printf_err("No current component of which to set parameters:\n %s\n",
3814 if (bt_value_array_append_string_element(run_args
,
3820 if (bt_value_array_append_string_element(run_args
, arg
)) {
3826 if (cur_name_prefix
->len
== 0) {
3827 printf_err("No current component of which to set `path` parameter:\n %s\n",
3832 if (bt_value_array_append_string_element(run_args
, "--key")) {
3837 if (bt_value_array_append_string_element(run_args
, "path")) {
3842 if (bt_value_array_append_string_element(run_args
, "--value")) {
3847 if (bt_value_array_append_string_element(run_args
, arg
)) {
3853 if (cur_name_prefix
->len
== 0) {
3854 printf_err("No current component of which to set `url` parameter:\n %s\n",
3859 if (bt_value_array_append_string_element(run_args
, "--key")) {
3864 if (bt_value_array_append_string_element(run_args
, "url")) {
3869 if (bt_value_array_append_string_element(run_args
, "--value")) {
3874 if (bt_value_array_append_string_element(run_args
, arg
)) {
3880 if (cur_name_prefix
->len
== 0) {
3881 printf_err("No current component to name:\n %s\n",
3886 if (bt_value_array_append_string_element(run_args
, "--name")) {
3891 if (bt_value_array_append_string_element(run_args
, arg
)) {
3896 g_string_assign(cur_name
, arg
);
3898 case OPT_OMIT_HOME_PLUGIN_PATH
:
3899 force_omit_home_plugin_path
= true;
3901 if (bt_value_array_append_string_element(run_args
,
3902 "--omit-home-plugin-path")) {
3907 case OPT_RETRY_DURATION
:
3908 if (bt_value_array_append_string_element(run_args
,
3909 "--retry-duration")) {
3914 if (bt_value_array_append_string_element(run_args
, arg
)) {
3919 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
3920 force_omit_system_plugin_path
= true;
3922 if (bt_value_array_append_string_element(run_args
,
3923 "--omit-system-plugin-path")) {
3928 case OPT_PLUGIN_PATH
:
3929 if (bt_config_append_plugin_paths_check_setuid_setgid(
3930 plugin_paths
, arg
)) {
3934 if (bt_value_array_append_string_element(run_args
,
3940 if (bt_value_array_append_string_element(run_args
, arg
)) {
3946 print_convert_usage(stdout
);
3948 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
3951 case OPT_CLOCK_CYCLES
:
3952 case OPT_CLOCK_DATE
:
3953 case OPT_CLOCK_FORCE_CORRELATE
:
3955 case OPT_CLOCK_OFFSET
:
3956 case OPT_CLOCK_OFFSET_NS
:
3957 case OPT_CLOCK_SECONDS
:
3960 case OPT_DEBUG_INFO
:
3961 case OPT_DEBUG_INFO_DIR
:
3962 case OPT_DEBUG_INFO_FULL_PATH
:
3963 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3966 case OPT_INPUT_FORMAT
:
3969 case OPT_OUTPUT_FORMAT
:
3972 case OPT_RUN_ARGS_0
:
3973 case OPT_STREAM_INTERSECTION
:
3976 /* Ignore in this pass */
3979 printf_err("Unknown command-line option specified (option code %d)\n",
3988 /* Append current component's name if needed */
3989 ret
= convert_append_name_param(cur_comp_dest
, cur_name
,
3990 cur_name_prefix
, run_args
, all_names
, &source_names
,
3991 &filter_names
, &sink_names
);
3996 /* Check for option parsing error */
3998 printf_err("While parsing command-line options, at option %s: %s\n",
3999 poptBadOption(pc
, 0), poptStrerror(opt
));
4003 poptFreeContext(pc
);
4008 * Second pass: transform the convert-specific options and
4009 * arguments into implicit component instances for the run
4012 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
4013 convert_long_options
, 0);
4015 printf_err("Cannot get popt context\n");
4019 poptReadDefaultConfig(pc
, 0);
4021 while ((opt
= poptGetNextOpt(pc
)) > 0) {
4022 arg
= poptGetOptArg(pc
);
4026 if (trimmer_has_begin
) {
4027 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
4032 trimmer_has_begin
= true;
4033 ret
= append_implicit_component_extra_param(
4034 &implicit_trimmer_args
, "begin", arg
);
4035 implicit_trimmer_args
.exists
= true;
4041 if (trimmer_has_end
) {
4042 printf("At --end option: --end or --timerange option already specified\n %s\n",
4047 trimmer_has_end
= true;
4048 ret
= append_implicit_component_extra_param(
4049 &implicit_trimmer_args
, "end", arg
);
4050 implicit_trimmer_args
.exists
= true;
4060 if (trimmer_has_begin
|| trimmer_has_end
) {
4061 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
4066 ret
= split_timerange(arg
, &begin
, &end
);
4068 printf_err("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s\n",
4073 ret
= append_implicit_component_extra_param(
4074 &implicit_trimmer_args
, "begin", begin
);
4075 ret
|= append_implicit_component_extra_param(
4076 &implicit_trimmer_args
, "end", end
);
4077 implicit_trimmer_args
.exists
= true;
4085 case OPT_CLOCK_CYCLES
:
4086 append_implicit_component_param(
4087 &implicit_text_args
, "clock-cycles", "yes");
4088 implicit_text_args
.exists
= true;
4090 case OPT_CLOCK_DATE
:
4091 append_implicit_component_param(
4092 &implicit_text_args
, "clock-date", "yes");
4093 implicit_text_args
.exists
= true;
4095 case OPT_CLOCK_FORCE_CORRELATE
:
4096 append_implicit_component_param(
4097 &implicit_muxer_args
,
4098 "assume-absolute-clock-classes", "yes");
4101 append_implicit_component_param(
4102 &implicit_text_args
, "clock-gmt", "yes");
4103 append_implicit_component_param(
4104 &implicit_trimmer_args
, "clock-gmt", "yes");
4105 implicit_text_args
.exists
= true;
4107 case OPT_CLOCK_OFFSET
:
4108 base_implicit_ctf_input_args
.exists
= true;
4109 append_implicit_component_param(
4110 &base_implicit_ctf_input_args
,
4111 "clock-class-offset-s", arg
);
4113 case OPT_CLOCK_OFFSET_NS
:
4114 base_implicit_ctf_input_args
.exists
= true;
4115 append_implicit_component_param(
4116 &base_implicit_ctf_input_args
,
4117 "clock-class-offset-ns", arg
);
4119 case OPT_CLOCK_SECONDS
:
4120 append_implicit_component_param(
4121 &implicit_text_args
, "clock-seconds", "yes");
4122 implicit_text_args
.exists
= true;
4125 implicit_text_args
.exists
= true;
4126 ret
= append_implicit_component_extra_param(
4127 &implicit_text_args
, "color", arg
);
4132 case OPT_DEBUG_INFO
:
4133 implicit_debug_info_args
.exists
= true;
4135 case OPT_DEBUG_INFO_DIR
:
4136 implicit_debug_info_args
.exists
= true;
4137 ret
= append_implicit_component_extra_param(
4138 &implicit_debug_info_args
, "debug-info-dir", arg
);
4143 case OPT_DEBUG_INFO_FULL_PATH
:
4144 implicit_debug_info_args
.exists
= true;
4145 append_implicit_component_param(
4146 &implicit_debug_info_args
, "full-path", "yes");
4148 case OPT_DEBUG_INFO_TARGET_PREFIX
:
4149 implicit_debug_info_args
.exists
= true;
4150 ret
= append_implicit_component_extra_param(
4151 &implicit_debug_info_args
,
4152 "target-prefix", arg
);
4159 struct bt_value
*fields
= fields_from_arg(arg
);
4165 implicit_text_args
.exists
= true;
4166 ret
= insert_flat_params_from_array(
4167 implicit_text_args
.params_arg
,
4169 bt_object_put_ref(fields
);
4177 struct bt_value
*names
= names_from_arg(arg
);
4183 implicit_text_args
.exists
= true;
4184 ret
= insert_flat_params_from_array(
4185 implicit_text_args
.params_arg
,
4187 bt_object_put_ref(names
);
4194 append_implicit_component_param(
4195 &implicit_text_args
, "no-delta", "yes");
4196 implicit_text_args
.exists
= true;
4198 case OPT_INPUT_FORMAT
:
4199 if (got_input_format_opt
) {
4200 printf_err("Duplicate --input-format option\n");
4204 got_input_format_opt
= true;
4206 if (strcmp(arg
, "ctf") == 0) {
4207 base_implicit_ctf_input_args
.exists
= true;
4208 } else if (strcmp(arg
, "lttng-live") == 0) {
4209 implicit_lttng_live_args
.exists
= true;
4211 printf_err("Unknown legacy input format:\n %s\n",
4216 case OPT_OUTPUT_FORMAT
:
4217 if (got_output_format_opt
) {
4218 printf_err("Duplicate --output-format option\n");
4222 got_output_format_opt
= true;
4224 if (strcmp(arg
, "text") == 0) {
4225 implicit_text_args
.exists
= true;
4226 } else if (strcmp(arg
, "ctf") == 0) {
4227 implicit_ctf_output_args
.exists
= true;
4228 } else if (strcmp(arg
, "dummy") == 0) {
4229 implicit_dummy_args
.exists
= true;
4230 } else if (strcmp(arg
, "ctf-metadata") == 0) {
4231 print_ctf_metadata
= true;
4233 printf_err("Unknown legacy output format:\n %s\n",
4240 printf_err("Duplicate --output option\n");
4244 output
= strdup(arg
);
4251 if (print_run_args_0
) {
4252 printf_err("Cannot specify --run-args and --run-args-0\n");
4256 print_run_args
= true;
4258 case OPT_RUN_ARGS_0
:
4259 if (print_run_args
) {
4260 printf_err("Cannot specify --run-args and --run-args-0\n");
4264 print_run_args_0
= true;
4266 case OPT_STREAM_INTERSECTION
:
4268 * Applies to all traces implementing the trace-info
4271 stream_intersection_mode
= true;
4274 if (*log_level
!= 'V' && *log_level
!= 'D') {
4287 /* Check for option parsing error */
4289 printf_err("While parsing command-line options, at option %s: %s\n",
4290 poptBadOption(pc
, 0), poptStrerror(opt
));
4295 * Legacy behaviour: --verbose used to make the `text` output
4296 * format print more information. --verbose is now equivalent to
4297 * the INFO log level, which is why we compare to 'I' here.
4299 if (*log_level
== 'I') {
4300 append_implicit_component_param(&implicit_text_args
,
4305 * Append home and system plugin paths now that we possibly got
4308 if (append_home_and_system_plugin_paths(plugin_paths
,
4309 force_omit_system_plugin_path
,
4310 force_omit_home_plugin_path
)) {
4314 /* Consume and keep leftover arguments */
4315 while ((leftover
= poptGetArg(pc
))) {
4316 GString
*gs_leftover
= g_string_new(leftover
);
4323 leftovers
= g_list_append(leftovers
, gs_leftover
);
4325 g_string_free(gs_leftover
, TRUE
);
4331 /* Print CTF metadata or print LTTng live sessions */
4332 if (print_ctf_metadata
) {
4333 GString
*gs_leftover
;
4335 if (g_list_length(leftovers
) == 0) {
4336 printf_err("--output-format=ctf-metadata specified without a path\n");
4340 if (g_list_length(leftovers
) > 1) {
4341 printf_err("Too many paths specified for --output-format=ctf-metadata\n");
4345 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
4350 gs_leftover
= leftovers
->data
;
4351 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
4356 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
4364 * If -o ctf was specified, make sure an output path (--output)
4365 * was also specified. --output does not imply -o ctf because
4366 * it's also used for the default, implicit -o text if -o ctf
4369 if (implicit_ctf_output_args
.exists
) {
4371 printf_err("--output-format=ctf specified without --output (trace output path)\n");
4376 * At this point we know that -o ctf AND --output were
4377 * specified. Make sure that no options were specified
4378 * which would imply -o text because --output would be
4379 * ambiguous in this case. For example, this is wrong:
4381 * babeltrace --names=all -o ctf --output=/tmp/path my-trace
4383 * because --names=all implies -o text, and --output
4384 * could apply to both the sink.text.pretty and
4385 * sink.ctf.fs implicit components.
4387 if (implicit_text_args
.exists
) {
4388 printf_err("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text\n");
4394 * If -o dummy and -o ctf were not specified, and if there are
4395 * no explicit sink components, then use an implicit
4396 * `sink.text.pretty` component.
4398 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
4400 implicit_text_args
.exists
= true;
4404 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4405 * `path` parameter if --output was specified.
4408 if (implicit_text_args
.exists
) {
4409 append_implicit_component_extra_param(&implicit_text_args
,
4411 } else if (implicit_ctf_output_args
.exists
) {
4412 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4417 /* Decide where the leftover argument(s) go */
4418 if (g_list_length(leftovers
) > 0) {
4419 if (implicit_lttng_live_args
.exists
) {
4420 GString
*gs_leftover
;
4422 if (g_list_length(leftovers
) > 1) {
4423 printf_err("Too many URLs specified for --output-format=lttng-live\n");
4427 gs_leftover
= leftovers
->data
;
4428 lttng_live_url_parts
=
4429 bt_common_parse_lttng_live_url(gs_leftover
->str
,
4430 error_buf
, sizeof(error_buf
));
4431 if (!lttng_live_url_parts
.proto
) {
4432 printf_err("Invalid LTTng live URL format: %s\n",
4437 if (!lttng_live_url_parts
.session_name
) {
4438 /* Print LTTng live sessions */
4439 cfg
= bt_config_print_lttng_live_sessions_create(
4445 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4450 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4457 ret
= append_implicit_component_extra_param(
4458 &implicit_lttng_live_args
, "url",
4465 * Append one implicit component argument set
4466 * for each leftover (souce.ctf.fs paths). Copy
4467 * the base implicit component arguments.
4468 * Note that they still have to be named later.
4470 ret
= fill_implicit_ctf_inputs_args(
4471 implicit_ctf_inputs_args
,
4472 &base_implicit_ctf_input_args
, leftovers
);
4480 * Ensure mutual exclusion between implicit `source.ctf.fs` and
4481 * `source.ctf.lttng-live` components.
4483 if (base_implicit_ctf_input_args
.exists
&&
4484 implicit_lttng_live_args
.exists
) {
4485 printf_err("Cannot create both implicit `%s` and `%s` components\n",
4486 base_implicit_ctf_input_args
.comp_arg
->str
,
4487 implicit_lttng_live_args
.comp_arg
->str
);
4492 * If the implicit `source.ctf.fs` or `source.ctf.lttng-live`
4493 * components exists, make sure there's at least one leftover
4494 * (which is the path or URL).
4496 if (base_implicit_ctf_input_args
.exists
&&
4497 g_list_length(leftovers
) == 0) {
4498 printf_err("Missing path for implicit `%s` component\n",
4499 base_implicit_ctf_input_args
.comp_arg
->str
);
4503 if (implicit_lttng_live_args
.exists
&& g_list_length(leftovers
) == 0) {
4504 printf_err("Missing URL for implicit `%s` component\n",
4505 implicit_lttng_live_args
.comp_arg
->str
);
4509 /* Assign names to implicit components */
4510 for (i
= 0; i
< implicit_ctf_inputs_args
->len
; i
++) {
4511 struct implicit_component_args
*impl_args
=
4512 g_ptr_array_index(implicit_ctf_inputs_args
, i
);
4514 ret
= assign_name_to_implicit_component(impl_args
,
4515 "source-ctf-fs", all_names
, &source_names
, true);
4521 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4522 "lttng-live", all_names
, &source_names
, true);
4527 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4528 "pretty", all_names
, &sink_names
, true);
4533 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4534 "sink-ctf-fs", all_names
, &sink_names
, true);
4539 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4540 "dummy", all_names
, &sink_names
, true);
4545 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4546 "muxer", all_names
, NULL
, false);
4551 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4552 "trimmer", all_names
, NULL
, false);
4557 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4558 "debug-info", all_names
, NULL
, false);
4563 /* Make sure there's at least one source and one sink */
4564 if (!source_names
) {
4565 printf_err("No source component\n");
4570 printf_err("No sink component\n");
4575 * Prepend the muxer, the trimmer, and the debug info to the
4576 * filter chain so that we have:
4578 * sources -> muxer -> [trimmer] -> [debug info] ->
4579 * [user filters] -> sinks
4581 if (implicit_debug_info_args
.exists
) {
4582 if (g_list_prepend_gstring(&filter_names
,
4583 implicit_debug_info_args
.name_arg
->str
)) {
4588 if (implicit_trimmer_args
.exists
) {
4589 if (g_list_prepend_gstring(&filter_names
,
4590 implicit_trimmer_args
.name_arg
->str
)) {
4595 if (g_list_prepend_gstring(&filter_names
,
4596 implicit_muxer_args
.name_arg
->str
)) {
4601 * Append the equivalent run arguments for the implicit
4604 for (i
= 0; i
< implicit_ctf_inputs_args
->len
; i
++) {
4605 struct implicit_component_args
*impl_args
=
4606 g_ptr_array_index(implicit_ctf_inputs_args
, i
);
4608 ret
= append_run_args_for_implicit_component(impl_args
,
4615 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4621 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4627 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4633 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4639 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4645 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4651 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4657 /* Auto-connect components */
4658 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4661 printf_err("Cannot auto-connect components\n");
4666 * We have all the run command arguments now. Depending on
4667 * --run-args, we pass this to the run command or print them
4670 if (print_run_args
|| print_run_args_0
) {
4671 if (stream_intersection_mode
) {
4672 printf_err("Cannot specify --stream-intersection with --run-args or --run-args-0\n");
4676 for (i
= 0; i
< bt_value_array_get_size(run_args
); i
++) {
4677 const struct bt_value
*arg_value
=
4678 bt_value_array_borrow_element_by_index(run_args
,
4681 GString
*quoted
= NULL
;
4682 const char *arg_to_print
;
4684 BT_ASSERT(arg_value
);
4685 arg
= bt_value_string_get(arg_value
);
4687 if (print_run_args
) {
4688 quoted
= bt_common_shell_quote(arg
, true);
4693 arg_to_print
= quoted
->str
;
4698 printf("%s", arg_to_print
);
4701 g_string_free(quoted
, TRUE
);
4704 if (i
< bt_value_array_get_size(run_args
) - 1) {
4705 if (print_run_args
) {
4714 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4718 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4719 force_omit_system_plugin_path
,
4720 force_omit_home_plugin_path
,
4721 initial_plugin_paths
);
4726 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4731 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
4735 poptFreeContext(pc
);
4742 g_string_free(cur_name
, TRUE
);
4745 if (cur_name_prefix
) {
4746 g_string_free(cur_name_prefix
, TRUE
);
4749 if (implicit_ctf_inputs_args
) {
4750 g_ptr_array_free(implicit_ctf_inputs_args
, TRUE
);
4753 bt_object_put_ref(run_args
);
4754 bt_object_put_ref(all_names
);
4755 destroy_glist_of_gstring(source_names
);
4756 destroy_glist_of_gstring(filter_names
);
4757 destroy_glist_of_gstring(sink_names
);
4758 destroy_glist_of_gstring(leftovers
);
4759 finalize_implicit_component_args(&base_implicit_ctf_input_args
);
4760 finalize_implicit_component_args(&implicit_ctf_output_args
);
4761 finalize_implicit_component_args(&implicit_lttng_live_args
);
4762 finalize_implicit_component_args(&implicit_dummy_args
);
4763 finalize_implicit_component_args(&implicit_text_args
);
4764 finalize_implicit_component_args(&implicit_debug_info_args
);
4765 finalize_implicit_component_args(&implicit_muxer_args
);
4766 finalize_implicit_component_args(&implicit_trimmer_args
);
4767 bt_object_put_ref(plugin_paths
);
4768 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4773 * Prints the Babeltrace 2.x general usage.
4776 void print_gen_usage(FILE *fp
)
4778 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4780 fprintf(fp
, "General options:\n");
4782 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=V)\n");
4783 fprintf(fp
, " -h, --help Show this help and quit\n");
4784 fprintf(fp
, " -l, --log-level=LVL Set all log levels to LVL (`N`, `V`, `D`,\n");
4785 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4786 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4787 fprintf(fp
, " -V, --version Show version and quit\n");
4789 fprintf(fp
, "Available commands:\n");
4791 fprintf(fp
, " convert Convert and trim traces (default)\n");
4792 fprintf(fp
, " help Get help for a plugin or a component class\n");
4793 fprintf(fp
, " list-plugins List available plugins and their content\n");
4794 fprintf(fp
, " query Query objects from a component class\n");
4795 fprintf(fp
, " run Build a processing graph and run it\n");
4797 fprintf(fp
, "Use `babeltrace COMMAND --help` to show the help of COMMAND.\n");
4801 char log_level_from_arg(const char *arg
)
4805 if (strcmp(arg
, "VERBOSE") == 0 ||
4806 strcmp(arg
, "V") == 0) {
4808 } else if (strcmp(arg
, "DEBUG") == 0 ||
4809 strcmp(arg
, "D") == 0) {
4811 } else if (strcmp(arg
, "INFO") == 0 ||
4812 strcmp(arg
, "I") == 0) {
4814 } else if (strcmp(arg
, "WARN") == 0 ||
4815 strcmp(arg
, "WARNING") == 0 ||
4816 strcmp(arg
, "W") == 0) {
4818 } else if (strcmp(arg
, "ERROR") == 0 ||
4819 strcmp(arg
, "E") == 0) {
4821 } else if (strcmp(arg
, "FATAL") == 0 ||
4822 strcmp(arg
, "F") == 0) {
4824 } else if (strcmp(arg
, "NONE") == 0 ||
4825 strcmp(arg
, "N") == 0) {
4832 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4833 int *retcode
, bool force_omit_system_plugin_path
,
4834 bool force_omit_home_plugin_path
,
4835 const struct bt_value
*initial_plugin_paths
)
4837 struct bt_config
*config
= NULL
;
4839 const char **command_argv
= NULL
;
4840 int command_argc
= -1;
4841 const char *command_name
= NULL
;
4842 char log_level
= 'U';
4845 COMMAND_TYPE_NONE
= -1,
4846 COMMAND_TYPE_RUN
= 0,
4847 COMMAND_TYPE_CONVERT
,
4848 COMMAND_TYPE_LIST_PLUGINS
,
4851 } command_type
= COMMAND_TYPE_NONE
;
4855 if (!initial_plugin_paths
) {
4856 initial_plugin_paths
= bt_value_array_create();
4857 if (!initial_plugin_paths
) {
4862 bt_object_get_ref(initial_plugin_paths
);
4868 print_gen_usage(stdout
);
4872 for (i
= 1; i
< argc
; i
++) {
4873 const char *cur_arg
= argv
[i
];
4874 const char *next_arg
= i
== (argc
- 1) ? NULL
: argv
[i
+ 1];
4876 if (strcmp(cur_arg
, "-d") == 0 ||
4877 strcmp(cur_arg
, "--debug") == 0) {
4879 } else if (strcmp(cur_arg
, "-v") == 0 ||
4880 strcmp(cur_arg
, "--verbose") == 0) {
4881 if (log_level
!= 'V' && log_level
!= 'D') {
4883 * Legacy: do not override a previous
4884 * --debug because --verbose and --debug
4885 * can be specified together (in this
4886 * case we want the lowest log level to
4891 } else if (strcmp(cur_arg
, "--log-level") == 0 ||
4892 strcmp(cur_arg
, "-l") == 0) {
4894 printf_err("Missing log level value for --log-level option\n");
4899 log_level
= log_level_from_arg(next_arg
);
4900 if (log_level
== 'U') {
4901 printf_err("Invalid argument for --log-level option:\n %s\n",
4908 } else if (strncmp(cur_arg
, "--log-level=", 12) == 0) {
4909 const char *arg
= &cur_arg
[12];
4911 log_level
= log_level_from_arg(arg
);
4912 if (log_level
== 'U') {
4913 printf_err("Invalid argument for --log-level option:\n %s\n",
4918 } else if (strncmp(cur_arg
, "-l", 2) == 0) {
4919 const char *arg
= &cur_arg
[2];
4921 log_level
= log_level_from_arg(arg
);
4922 if (log_level
== 'U') {
4923 printf_err("Invalid argument for --log-level option:\n %s\n",
4928 } else if (strcmp(cur_arg
, "-V") == 0 ||
4929 strcmp(cur_arg
, "--version") == 0) {
4932 } else if (strcmp(cur_arg
, "-h") == 0 ||
4933 strcmp(cur_arg
, "--help") == 0) {
4934 print_gen_usage(stdout
);
4938 * First unknown argument: is it a known command
4941 command_argv
= &argv
[i
];
4942 command_argc
= argc
- i
;
4944 if (strcmp(cur_arg
, "convert") == 0) {
4945 command_type
= COMMAND_TYPE_CONVERT
;
4946 } else if (strcmp(cur_arg
, "list-plugins") == 0) {
4947 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4948 } else if (strcmp(cur_arg
, "help") == 0) {
4949 command_type
= COMMAND_TYPE_HELP
;
4950 } else if (strcmp(cur_arg
, "query") == 0) {
4951 command_type
= COMMAND_TYPE_QUERY
;
4952 } else if (strcmp(cur_arg
, "run") == 0) {
4953 command_type
= COMMAND_TYPE_RUN
;
4956 * Unknown argument, but not a known
4957 * command name: assume the default
4958 * `convert` command.
4960 command_type
= COMMAND_TYPE_CONVERT
;
4961 command_name
= "convert";
4962 command_argv
= &argv
[i
- 1];
4963 command_argc
= argc
- i
+ 1;
4969 if (command_type
== COMMAND_TYPE_NONE
) {
4971 * We only got non-help, non-version general options
4972 * like --verbose and --debug, without any other
4973 * arguments, so we can't do anything useful: print the
4976 print_gen_usage(stdout
);
4980 BT_ASSERT(command_argv
);
4981 BT_ASSERT(command_argc
>= 0);
4983 switch (command_type
) {
4984 case COMMAND_TYPE_RUN
:
4985 config
= bt_config_run_from_args(command_argc
, command_argv
,
4986 retcode
, force_omit_system_plugin_path
,
4987 force_omit_home_plugin_path
, initial_plugin_paths
);
4989 case COMMAND_TYPE_CONVERT
:
4990 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4991 retcode
, force_omit_system_plugin_path
,
4992 force_omit_home_plugin_path
,
4993 initial_plugin_paths
, &log_level
);
4995 case COMMAND_TYPE_LIST_PLUGINS
:
4996 config
= bt_config_list_plugins_from_args(command_argc
,
4997 command_argv
, retcode
, force_omit_system_plugin_path
,
4998 force_omit_home_plugin_path
, initial_plugin_paths
);
5000 case COMMAND_TYPE_HELP
:
5001 config
= bt_config_help_from_args(command_argc
,
5002 command_argv
, retcode
, force_omit_system_plugin_path
,
5003 force_omit_home_plugin_path
, initial_plugin_paths
);
5005 case COMMAND_TYPE_QUERY
:
5006 config
= bt_config_query_from_args(command_argc
,
5007 command_argv
, retcode
, force_omit_system_plugin_path
,
5008 force_omit_home_plugin_path
, initial_plugin_paths
);
5015 if (log_level
== 'U') {
5019 config
->log_level
= log_level
;
5020 config
->command_name
= command_name
;
5024 bt_object_put_ref(initial_plugin_paths
);