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>
37 #include <babeltrace/values.h>
40 #include <sys/types.h>
41 #include "babeltrace-cfg.h"
42 #include "babeltrace-cfg-cli-args.h"
43 #include "babeltrace-cfg-cli-args-connect.h"
47 * Error printf() macro which prepends "Error: " the first time it's
48 * called. This gives a nicer feel than having a bunch of error prefixes
49 * (since the following lines usually describe the error and possible
50 * solutions), or the error prefix just at the end.
52 #define printf_err(fmt, args...) \
54 if (is_first_error) { \
55 fprintf(stderr, "Command line error: "); \
56 is_first_error = false; \
58 fprintf(stderr, fmt, ##args); \
61 static bool is_first_error
= true;
63 /* INI-style parsing FSM states */
64 enum ini_parsing_fsm_state
{
65 /* Expect a map key (identifier) */
68 /* Expect an equal character ('=') */
74 /* Expect a negative number value */
75 INI_EXPECT_VALUE_NUMBER_NEG
,
77 /* Expect a comma character (',') */
81 /* INI-style parsing state variables */
82 struct ini_parsing_state
{
83 /* Lexical scanner (owned by this) */
86 /* Output map value object being filled (owned by this) */
87 struct bt_value
*params
;
89 /* Next expected FSM state */
90 enum ini_parsing_fsm_state expecting
;
92 /* Last decoded map key (owned by this) */
95 /* Complete INI-style string to parse (not owned by this) */
98 /* Error buffer (not owned by this) */
102 /* Offset option with "is set" boolean */
108 /* Legacy "ctf"/"lttng-live" format options */
109 struct ctf_legacy_opts
{
110 struct offset_opt offset_s
;
111 struct offset_opt offset_ns
;
112 bool stream_intersection
;
115 /* Legacy "text" format options */
116 struct text_legacy_opts
{
118 * output, dbg_info_dir, dbg_info_target_prefix, names,
119 * and fields are owned by this.
122 GString
*dbg_info_dir
;
123 GString
*dbg_info_target_prefix
;
124 struct bt_value
*names
;
125 struct bt_value
*fields
;
133 bool dbg_info_full_path
;
137 /* Legacy input format format */
138 enum legacy_input_format
{
139 LEGACY_INPUT_FORMAT_NONE
= 0,
140 LEGACY_INPUT_FORMAT_CTF
,
141 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
144 /* Legacy output format format */
145 enum legacy_output_format
{
146 LEGACY_OUTPUT_FORMAT_NONE
= 0,
147 LEGACY_OUTPUT_FORMAT_TEXT
,
148 LEGACY_OUTPUT_FORMAT_DUMMY
,
152 * Prints the "out of memory" error.
155 void print_err_oom(void)
157 printf_err("Out of memory\n");
161 * Appends an "expecting token" error to the INI-style parsing state's
165 void ini_append_error_expecting(struct ini_parsing_state
*state
,
166 GScanner
*scanner
, const char *expecting
)
171 g_string_append_printf(state
->ini_error
, "Expecting %s:\n", expecting
);
173 /* Only print error if there's one line */
174 if (strchr(state
->arg
, '\n') != NULL
|| strlen(state
->arg
) == 0) {
178 g_string_append_printf(state
->ini_error
, "\n %s\n", state
->arg
);
179 pos
= g_scanner_cur_position(scanner
) + 4;
181 if (!g_scanner_eof(scanner
)) {
185 for (i
= 0; i
< pos
; ++i
) {
186 g_string_append_printf(state
->ini_error
, " ");
189 g_string_append_printf(state
->ini_error
, "^\n\n");
193 int ini_handle_state(struct ini_parsing_state
*state
)
196 GTokenType token_type
;
197 struct bt_value
*value
= NULL
;
199 token_type
= g_scanner_get_next_token(state
->scanner
);
200 if (token_type
== G_TOKEN_EOF
) {
201 if (state
->expecting
!= INI_EXPECT_COMMA
) {
202 switch (state
->expecting
) {
203 case INI_EXPECT_EQUAL
:
204 ini_append_error_expecting(state
,
205 state
->scanner
, "'='");
207 case INI_EXPECT_VALUE
:
208 case INI_EXPECT_VALUE_NUMBER_NEG
:
209 ini_append_error_expecting(state
,
210 state
->scanner
, "value");
212 case INI_EXPECT_MAP_KEY
:
213 ini_append_error_expecting(state
,
214 state
->scanner
, "unquoted map key");
227 switch (state
->expecting
) {
228 case INI_EXPECT_MAP_KEY
:
229 if (token_type
!= G_TOKEN_IDENTIFIER
) {
230 ini_append_error_expecting(state
, state
->scanner
,
235 free(state
->last_map_key
);
236 state
->last_map_key
=
237 strdup(state
->scanner
->value
.v_identifier
);
238 if (!state
->last_map_key
) {
239 g_string_append(state
->ini_error
,
244 if (bt_value_map_has_key(state
->params
, 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(
300 /* Positive floating point number */
301 value
= bt_value_float_create_init(
302 state
->scanner
->value
.v_float
);
306 value
= bt_value_string_create_init(
307 state
->scanner
->value
.v_string
);
309 case G_TOKEN_IDENTIFIER
:
312 * Using symbols would be appropriate here,
313 * but said symbols are allowed as map key,
314 * so it's easier to consider everything an
317 * If one of the known symbols is not
318 * recognized here, then fall back to creating
321 const char *id
= state
->scanner
->value
.v_identifier
;
323 if (!strcmp(id
, "null") || !strcmp(id
, "NULL") ||
324 !strcmp(id
, "nul")) {
325 value
= bt_value_null
;
326 } else if (!strcmp(id
, "true") || !strcmp(id
, "TRUE") ||
327 !strcmp(id
, "yes") ||
328 !strcmp(id
, "YES")) {
329 value
= bt_value_bool_create_init(true);
330 } else if (!strcmp(id
, "false") ||
331 !strcmp(id
, "FALSE") ||
334 value
= bt_value_bool_create_init(false);
336 value
= bt_value_string_create_init(id
);
341 /* Unset value variable will trigger the error */
346 ini_append_error_expecting(state
,
347 state
->scanner
, "value");
351 state
->expecting
= INI_EXPECT_COMMA
;
354 case INI_EXPECT_VALUE_NUMBER_NEG
:
356 switch (token_type
) {
359 /* Negative integer */
360 uint64_t int_val
= state
->scanner
->value
.v_int64
;
362 if (int_val
> (1ULL << 63) - 1) {
363 g_string_append_printf(state
->ini_error
,
364 "Integer value -%" PRIu64
" is outside the range of a 64-bit signed integer\n",
369 value
= bt_value_integer_create_init(
370 -((int64_t) int_val
));
374 /* Negative floating point number */
375 value
= bt_value_float_create_init(
376 -state
->scanner
->value
.v_float
);
379 /* Unset value variable will trigger the error */
384 ini_append_error_expecting(state
,
385 state
->scanner
, "value");
389 state
->expecting
= INI_EXPECT_COMMA
;
392 case INI_EXPECT_COMMA
:
393 if (token_type
!= G_TOKEN_CHAR
) {
394 ini_append_error_expecting(state
,
395 state
->scanner
, "','");
399 if (state
->scanner
->value
.v_char
!= ',') {
400 ini_append_error_expecting(state
,
401 state
->scanner
, "','");
405 state
->expecting
= INI_EXPECT_MAP_KEY
;
417 if (bt_value_map_insert(state
->params
,
418 state
->last_map_key
, value
)) {
419 /* Only override return value on error */
430 * Converts an INI-style argument to an equivalent map value object.
432 * Return value is owned by the caller.
435 struct bt_value
*bt_value_from_ini(const char *arg
, GString
*ini_error
)
437 /* Lexical scanner configuration */
438 GScannerConfig scanner_config
= {
439 /* Skip whitespaces */
440 .cset_skip_characters
= " \t\n",
442 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
443 .cset_identifier_first
=
447 .cset_identifier_nth
=
452 /* "hello" and "Hello" two different keys */
453 .case_sensitive
= TRUE
,
456 .cpair_comment_single
= NULL
,
457 .skip_comment_multi
= TRUE
,
458 .skip_comment_single
= TRUE
,
459 .scan_comment_multi
= FALSE
,
462 * Do scan identifiers, including 1-char identifiers,
463 * but NULL is a normal identifier.
465 .scan_identifier
= TRUE
,
466 .scan_identifier_1char
= TRUE
,
467 .scan_identifier_NULL
= FALSE
,
470 * No specific symbols: null and boolean "symbols" are
471 * scanned as plain identifiers.
473 .scan_symbols
= FALSE
,
474 .symbol_2_token
= FALSE
,
475 .scope_0_fallback
= FALSE
,
478 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
479 * integers prefixed with "$".
485 .scan_hex_dollar
= FALSE
,
487 /* Convert scanned numbers to integer tokens */
488 .numbers_2_int
= TRUE
,
490 /* Support both integers and floating-point numbers */
491 .int_2_float
= FALSE
,
493 /* Scan integers as 64-bit signed integers */
496 /* Only scan double-quoted strings */
497 .scan_string_sq
= FALSE
,
498 .scan_string_dq
= TRUE
,
500 /* Do not converter identifiers to string tokens */
501 .identifier_2_string
= FALSE
,
503 /* Scan characters as G_TOKEN_CHAR token */
504 .char_2_token
= FALSE
,
506 struct ini_parsing_state state
= {
509 .expecting
= INI_EXPECT_MAP_KEY
,
511 .ini_error
= ini_error
,
514 state
.params
= bt_value_map_create();
519 state
.scanner
= g_scanner_new(&scanner_config
);
520 if (!state
.scanner
) {
524 /* Let the scan begin */
525 g_scanner_input_text(state
.scanner
, arg
, strlen(arg
));
528 int ret
= ini_handle_state(&state
);
533 } else if (ret
> 0) {
542 BT_PUT(state
.params
);
546 g_scanner_destroy(state
.scanner
);
549 free(state
.last_map_key
);
554 * Returns the parameters map value object from a command-line
555 * parameter option's argument.
557 * Return value is owned by the caller.
560 struct bt_value
*bt_value_from_arg(const char *arg
)
562 struct bt_value
*params
= NULL
;
563 GString
*ini_error
= NULL
;
565 ini_error
= g_string_new(NULL
);
571 /* Try INI-style parsing */
572 params
= bt_value_from_ini(arg
, ini_error
);
574 printf_err("%s", ini_error
->str
);
580 g_string_free(ini_error
, TRUE
);
586 * Returns the plugin name, component class name, component class type,
587 * and component name from a command-line --component option's argument.
588 * arg must have the following format:
590 * [NAME:]TYPE.PLUGIN.CLS
592 * where NAME is the optional component name, TYPE is either `source`,
593 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
594 * component class name.
596 * On success, both *plugin and *component are not NULL. *plugin
597 * and *comp_cls are owned by the caller. On success, *name can be NULL
598 * if no component class name was found, and *comp_cls_type is set.
601 void plugin_comp_cls_names(const char *arg
, char **name
, char **plugin
,
602 char **comp_cls
, enum bt_component_class_type
*comp_cls_type
)
604 const char *at
= arg
;
605 GString
*gs_name
= NULL
;
606 GString
*gs_comp_cls_type
= NULL
;
607 GString
*gs_plugin
= NULL
;
608 GString
*gs_comp_cls
= NULL
;
614 BT_ASSERT(comp_cls_type
);
616 if (!bt_common_string_is_printable(arg
)) {
617 printf_err("Argument contains a non-printable character\n");
621 /* Parse the component name */
622 gs_name
= bt_common_string_until(at
, ".:\\", ":", &end_pos
);
627 if (arg
[end_pos
] == ':') {
631 g_string_assign(gs_name
, "");
634 /* Parse the component class type */
635 gs_comp_cls_type
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
636 if (!gs_comp_cls_type
|| at
[end_pos
] == '\0') {
637 printf_err("Missing component class type (`source`, `filter`, or `sink`)\n");
641 if (strcmp(gs_comp_cls_type
->str
, "source") == 0 ||
642 strcmp(gs_comp_cls_type
->str
, "src") == 0) {
643 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SOURCE
;
644 } else if (strcmp(gs_comp_cls_type
->str
, "filter") == 0 ||
645 strcmp(gs_comp_cls_type
->str
, "flt") == 0) {
646 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_FILTER
;
647 } else if (strcmp(gs_comp_cls_type
->str
, "sink") == 0) {
648 *comp_cls_type
= BT_COMPONENT_CLASS_TYPE_SINK
;
650 printf_err("Unknown component class type: `%s`\n",
651 gs_comp_cls_type
->str
);
657 /* Parse the plugin name */
658 gs_plugin
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
659 if (!gs_plugin
|| gs_plugin
->len
== 0 || at
[end_pos
] == '\0') {
660 printf_err("Missing plugin or component class name\n");
666 /* Parse the component class name */
667 gs_comp_cls
= bt_common_string_until(at
, ".:\\", ".", &end_pos
);
668 if (!gs_comp_cls
|| gs_comp_cls
->len
== 0) {
669 printf_err("Missing component class name\n");
673 if (at
[end_pos
] != '\0') {
674 /* Found a non-escaped `.` */
679 if (gs_name
->len
== 0) {
681 g_string_free(gs_name
, TRUE
);
683 *name
= gs_name
->str
;
684 g_string_free(gs_name
, FALSE
);
687 g_string_free(gs_name
, TRUE
);
690 *plugin
= gs_plugin
->str
;
691 *comp_cls
= gs_comp_cls
->str
;
692 g_string_free(gs_plugin
, FALSE
);
693 g_string_free(gs_comp_cls
, FALSE
);
709 g_string_free(gs_name
, TRUE
);
713 g_string_free(gs_plugin
, TRUE
);
717 g_string_free(gs_comp_cls
, TRUE
);
720 if (gs_comp_cls_type
) {
721 g_string_free(gs_comp_cls_type
, TRUE
);
728 * Prints the Babeltrace version.
731 void print_version(void)
733 if (GIT_VERSION
[0] == '\0') {
734 puts("Babeltrace " VERSION
);
736 puts("Babeltrace " VERSION
" - " GIT_VERSION
);
741 * Destroys a component configuration.
744 void bt_config_component_destroy(struct bt_object
*obj
)
746 struct bt_config_component
*bt_config_component
=
747 container_of(obj
, struct bt_config_component
, base
);
753 if (bt_config_component
->plugin_name
) {
754 g_string_free(bt_config_component
->plugin_name
, TRUE
);
757 if (bt_config_component
->comp_cls_name
) {
758 g_string_free(bt_config_component
->comp_cls_name
, TRUE
);
761 if (bt_config_component
->instance_name
) {
762 g_string_free(bt_config_component
->instance_name
, TRUE
);
765 BT_PUT(bt_config_component
->params
);
766 g_free(bt_config_component
);
773 * Creates a component configuration using the given plugin name and
774 * component name. `plugin_name` and `comp_cls_name` are copied (belong
775 * to the return value).
777 * Return value is owned by the caller.
780 struct bt_config_component
*bt_config_component_create(
781 enum bt_component_class_type type
,
782 const char *plugin_name
, const char *comp_cls_name
)
784 struct bt_config_component
*cfg_component
= NULL
;
786 cfg_component
= g_new0(struct bt_config_component
, 1);
787 if (!cfg_component
) {
792 bt_object_init(cfg_component
, bt_config_component_destroy
);
793 cfg_component
->type
= type
;
794 cfg_component
->plugin_name
= g_string_new(plugin_name
);
795 if (!cfg_component
->plugin_name
) {
800 cfg_component
->comp_cls_name
= g_string_new(comp_cls_name
);
801 if (!cfg_component
->comp_cls_name
) {
806 cfg_component
->instance_name
= g_string_new(NULL
);
807 if (!cfg_component
->instance_name
) {
812 /* Start with empty parameters */
813 cfg_component
->params
= bt_value_map_create();
814 if (!cfg_component
->params
) {
822 BT_PUT(cfg_component
);
825 return cfg_component
;
829 * Creates a component configuration from a command-line --component
833 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
835 struct bt_config_component
*cfg_comp
= NULL
;
837 char *plugin_name
= NULL
;
838 char *comp_cls_name
= NULL
;
839 enum bt_component_class_type type
;
841 plugin_comp_cls_names(arg
, &name
, &plugin_name
, &comp_cls_name
, &type
);
842 if (!plugin_name
|| !comp_cls_name
) {
846 cfg_comp
= bt_config_component_create(type
, plugin_name
, comp_cls_name
);
852 g_string_assign(cfg_comp
->instance_name
, name
);
863 g_free(comp_cls_name
);
868 * Destroys a configuration.
871 void bt_config_destroy(struct bt_object
*obj
)
873 struct bt_config
*cfg
=
874 container_of(obj
, struct bt_config
, base
);
880 BT_PUT(cfg
->plugin_paths
);
882 switch (cfg
->command
) {
883 case BT_CONFIG_COMMAND_RUN
:
884 if (cfg
->cmd_data
.run
.sources
) {
885 g_ptr_array_free(cfg
->cmd_data
.run
.sources
, TRUE
);
888 if (cfg
->cmd_data
.run
.filters
) {
889 g_ptr_array_free(cfg
->cmd_data
.run
.filters
, TRUE
);
892 if (cfg
->cmd_data
.run
.sinks
) {
893 g_ptr_array_free(cfg
->cmd_data
.run
.sinks
, TRUE
);
896 if (cfg
->cmd_data
.run
.connections
) {
897 g_ptr_array_free(cfg
->cmd_data
.run
.connections
,
901 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
903 case BT_CONFIG_COMMAND_HELP
:
904 BT_PUT(cfg
->cmd_data
.help
.cfg_component
);
906 case BT_CONFIG_COMMAND_QUERY
:
907 BT_PUT(cfg
->cmd_data
.query
.cfg_component
);
909 if (cfg
->cmd_data
.query
.object
) {
910 g_string_free(cfg
->cmd_data
.query
.object
, TRUE
);
913 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
914 if (cfg
->cmd_data
.print_ctf_metadata
.path
) {
915 g_string_free(cfg
->cmd_data
.print_ctf_metadata
.path
,
918 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
922 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
923 if (cfg
->cmd_data
.print_lttng_live_sessions
.url
) {
925 cfg
->cmd_data
.print_lttng_live_sessions
.url
,
928 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
943 void destroy_glist_of_gstring(GList
*list
)
951 for (at
= list
; at
!= NULL
; at
= g_list_next(at
)) {
952 g_string_free(at
->data
, TRUE
);
959 * Creates a simple lexical scanner for parsing comma-delimited names
962 * Return value is owned by the caller.
965 GScanner
*create_csv_identifiers_scanner(void)
968 GScannerConfig scanner_config
= {
969 .cset_skip_characters
= " \t\n",
970 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
971 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
972 .case_sensitive
= TRUE
,
973 .cpair_comment_single
= NULL
,
974 .skip_comment_multi
= TRUE
,
975 .skip_comment_single
= TRUE
,
976 .scan_comment_multi
= FALSE
,
977 .scan_identifier
= TRUE
,
978 .scan_identifier_1char
= TRUE
,
979 .scan_identifier_NULL
= FALSE
,
980 .scan_symbols
= FALSE
,
981 .symbol_2_token
= FALSE
,
982 .scope_0_fallback
= FALSE
,
983 .scan_binary
= FALSE
,
987 .scan_hex_dollar
= FALSE
,
988 .numbers_2_int
= FALSE
,
989 .int_2_float
= FALSE
,
990 .store_int64
= FALSE
,
991 .scan_string_sq
= FALSE
,
992 .scan_string_dq
= FALSE
,
993 .identifier_2_string
= FALSE
,
994 .char_2_token
= TRUE
,
997 scanner
= g_scanner_new(&scanner_config
);
1006 * Converts a comma-delimited list of known names (--names option) to
1007 * an array value object containing those names as string value objects.
1009 * Return value is owned by the caller.
1012 struct bt_value
*names_from_arg(const char *arg
)
1014 GScanner
*scanner
= NULL
;
1015 struct bt_value
*names
= NULL
;
1016 bool found_all
= false, found_none
= false, found_item
= false;
1018 names
= bt_value_array_create();
1024 scanner
= create_csv_identifiers_scanner();
1029 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1032 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1034 switch (token_type
) {
1035 case G_TOKEN_IDENTIFIER
:
1037 const char *identifier
= scanner
->value
.v_identifier
;
1039 if (!strcmp(identifier
, "payload") ||
1040 !strcmp(identifier
, "args") ||
1041 !strcmp(identifier
, "arg")) {
1043 if (bt_value_array_append_string(names
,
1047 } else if (!strcmp(identifier
, "context") ||
1048 !strcmp(identifier
, "ctx")) {
1050 if (bt_value_array_append_string(names
,
1054 } else if (!strcmp(identifier
, "scope") ||
1055 !strcmp(identifier
, "header")) {
1057 if (bt_value_array_append_string(names
,
1061 } else if (!strcmp(identifier
, "all")) {
1063 if (bt_value_array_append_string(names
,
1067 } else if (!strcmp(identifier
, "none")) {
1069 if (bt_value_array_append_string(names
,
1074 printf_err("Unknown name: `%s`\n",
1090 if (found_none
&& found_all
) {
1091 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1095 * Legacy behavior is to clear the defaults (show none) when at
1096 * least one item is specified.
1098 if (found_item
&& !found_none
&& !found_all
) {
1099 if (bt_value_array_append_string(names
, "none")) {
1104 g_scanner_destroy(scanner
);
1111 g_scanner_destroy(scanner
);
1117 * Converts a comma-delimited list of known fields (--fields option) to
1118 * an array value object containing those fields as string
1121 * Return value is owned by the caller.
1124 struct bt_value
*fields_from_arg(const char *arg
)
1126 GScanner
*scanner
= NULL
;
1127 struct bt_value
*fields
;
1129 fields
= bt_value_array_create();
1135 scanner
= create_csv_identifiers_scanner();
1140 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1143 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1145 switch (token_type
) {
1146 case G_TOKEN_IDENTIFIER
:
1148 const char *identifier
= scanner
->value
.v_identifier
;
1150 if (!strcmp(identifier
, "trace") ||
1151 !strcmp(identifier
, "trace:hostname") ||
1152 !strcmp(identifier
, "trace:domain") ||
1153 !strcmp(identifier
, "trace:procname") ||
1154 !strcmp(identifier
, "trace:vpid") ||
1155 !strcmp(identifier
, "loglevel") ||
1156 !strcmp(identifier
, "emf") ||
1157 !strcmp(identifier
, "callsite") ||
1158 !strcmp(identifier
, "all")) {
1159 if (bt_value_array_append_string(fields
,
1164 printf_err("Unknown field: `%s`\n",
1186 g_scanner_destroy(scanner
);
1192 void append_param_arg(GString
*params_arg
, const char *key
, const char *value
)
1194 BT_ASSERT(params_arg
);
1198 if (params_arg
->len
!= 0) {
1199 g_string_append_c(params_arg
, ',');
1202 g_string_append(params_arg
, key
);
1203 g_string_append_c(params_arg
, '=');
1204 g_string_append(params_arg
, value
);
1208 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
1209 * where the names are in names_array.
1212 int insert_flat_params_from_array(GString
*params_arg
,
1213 struct bt_value
*names_array
, const char *prefix
)
1217 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1218 bool default_set
= false, non_default_set
= false;
1221 * names_array may be NULL if no CLI options were specified to
1222 * trigger its creation.
1228 tmpstr
= g_string_new(NULL
);
1235 default_value
= g_string_new(NULL
);
1236 if (!default_value
) {
1242 for (i
= 0; i
< bt_value_array_size(names_array
); i
++) {
1243 struct bt_value
*str_obj
= bt_value_array_get(names_array
, i
);
1245 bool is_default
= false;
1248 printf_err("Unexpected error\n");
1253 ret
= bt_value_string_get(str_obj
, &suffix
);
1256 printf_err("Unexpected error\n");
1260 g_string_assign(tmpstr
, prefix
);
1261 g_string_append(tmpstr
, "-");
1263 /* Special-case for "all" and "none". */
1264 if (!strcmp(suffix
, "all")) {
1266 g_string_assign(default_value
, "show");
1267 } else if (!strcmp(suffix
, "none")) {
1269 g_string_assign(default_value
, "hide");
1273 g_string_append(tmpstr
, "default");
1274 append_param_arg(params_arg
, tmpstr
->str
,
1275 default_value
->str
);
1277 non_default_set
= true;
1278 g_string_append(tmpstr
, suffix
);
1279 append_param_arg(params_arg
, tmpstr
->str
, "yes");
1283 /* Implicit field-default=hide if any non-default option is set. */
1284 if (non_default_set
&& !default_set
) {
1285 g_string_assign(tmpstr
, prefix
);
1286 g_string_append(tmpstr
, "-default");
1287 g_string_assign(default_value
, "hide");
1288 append_param_arg(params_arg
, tmpstr
->str
, default_value
->str
);
1292 if (default_value
) {
1293 g_string_free(default_value
, TRUE
);
1297 g_string_free(tmpstr
, TRUE
);
1310 OPT_CLOCK_FORCE_CORRELATE
,
1313 OPT_CLOCK_OFFSET_NS
,
1321 OPT_DEBUG_INFO_FULL_PATH
,
1322 OPT_DEBUG_INFO_TARGET_PREFIX
,
1332 OPT_OMIT_HOME_PLUGIN_PATH
,
1333 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
1339 OPT_RESET_BASE_PARAMS
,
1343 OPT_STREAM_INTERSECTION
,
1350 enum bt_config_component_dest
{
1351 BT_CONFIG_COMPONENT_DEST_UNKNOWN
= -1,
1352 BT_CONFIG_COMPONENT_DEST_SOURCE
,
1353 BT_CONFIG_COMPONENT_DEST_FILTER
,
1354 BT_CONFIG_COMPONENT_DEST_SINK
,
1358 * Adds a configuration component to the appropriate configuration
1359 * array depending on the destination.
1362 void add_run_cfg_comp(struct bt_config
*cfg
,
1363 struct bt_config_component
*cfg_comp
,
1364 enum bt_config_component_dest dest
)
1369 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
1370 g_ptr_array_add(cfg
->cmd_data
.run
.sources
, cfg_comp
);
1372 case BT_CONFIG_COMPONENT_DEST_FILTER
:
1373 g_ptr_array_add(cfg
->cmd_data
.run
.filters
, cfg_comp
);
1375 case BT_CONFIG_COMPONENT_DEST_SINK
:
1376 g_ptr_array_add(cfg
->cmd_data
.run
.sinks
, cfg_comp
);
1384 int add_run_cfg_comp_check_name(struct bt_config
*cfg
,
1385 struct bt_config_component
*cfg_comp
,
1386 enum bt_config_component_dest dest
,
1387 struct bt_value
*instance_names
)
1391 if (cfg_comp
->instance_name
->len
== 0) {
1392 printf_err("Found an unnamed component\n");
1397 if (bt_value_map_has_key(instance_names
, cfg_comp
->instance_name
->str
)) {
1398 printf_err("Duplicate component instance name:\n %s\n",
1399 cfg_comp
->instance_name
->str
);
1404 if (bt_value_map_insert(instance_names
,
1405 cfg_comp
->instance_name
->str
, bt_value_null
)) {
1411 add_run_cfg_comp(cfg
, cfg_comp
, dest
);
1418 int append_env_var_plugin_paths(struct bt_value
*plugin_paths
)
1423 if (bt_common_is_setuid_setgid()) {
1424 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1428 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
1433 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
1437 printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n");
1444 int append_home_and_system_plugin_paths(struct bt_value
*plugin_paths
,
1445 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
1449 if (!omit_home_plugin_path
) {
1450 if (bt_common_is_setuid_setgid()) {
1451 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
1453 char *home_plugin_dir
=
1454 bt_common_get_home_plugin_path();
1456 if (home_plugin_dir
) {
1457 ret
= bt_config_append_plugin_paths(
1458 plugin_paths
, home_plugin_dir
);
1459 free(home_plugin_dir
);
1462 printf_err("Invalid home plugin path\n");
1469 if (!omit_system_plugin_path
) {
1470 if (bt_config_append_plugin_paths(plugin_paths
,
1471 bt_common_get_system_plugin_path())) {
1472 printf_err("Invalid system plugin path\n");
1478 printf_err("Cannot append home and system plugin paths\n");
1483 int append_home_and_system_plugin_paths_cfg(struct bt_config
*cfg
)
1485 return append_home_and_system_plugin_paths(cfg
->plugin_paths
,
1486 cfg
->omit_system_plugin_path
, cfg
->omit_home_plugin_path
);
1490 struct bt_config
*bt_config_base_create(enum bt_config_command command
,
1491 struct bt_value
*initial_plugin_paths
, bool needs_plugins
)
1493 struct bt_config
*cfg
;
1496 cfg
= g_new0(struct bt_config
, 1);
1502 bt_object_init(cfg
, bt_config_destroy
);
1503 cfg
->command
= command
;
1504 cfg
->command_needs_plugins
= needs_plugins
;
1506 if (initial_plugin_paths
) {
1507 cfg
->plugin_paths
= bt_get(initial_plugin_paths
);
1509 cfg
->plugin_paths
= bt_value_array_create();
1510 if (!cfg
->plugin_paths
) {
1526 struct bt_config
*bt_config_run_create(
1527 struct bt_value
*initial_plugin_paths
)
1529 struct bt_config
*cfg
;
1532 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_RUN
,
1533 initial_plugin_paths
, true);
1538 cfg
->cmd_data
.run
.sources
= g_ptr_array_new_with_free_func(
1539 (GDestroyNotify
) bt_put
);
1540 if (!cfg
->cmd_data
.run
.sources
) {
1545 cfg
->cmd_data
.run
.filters
= g_ptr_array_new_with_free_func(
1546 (GDestroyNotify
) bt_put
);
1547 if (!cfg
->cmd_data
.run
.filters
) {
1552 cfg
->cmd_data
.run
.sinks
= g_ptr_array_new_with_free_func(
1553 (GDestroyNotify
) bt_put
);
1554 if (!cfg
->cmd_data
.run
.sinks
) {
1559 cfg
->cmd_data
.run
.connections
= g_ptr_array_new_with_free_func(
1560 (GDestroyNotify
) bt_config_connection_destroy
);
1561 if (!cfg
->cmd_data
.run
.connections
) {
1576 struct bt_config
*bt_config_list_plugins_create(
1577 struct bt_value
*initial_plugin_paths
)
1579 struct bt_config
*cfg
;
1582 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
,
1583 initial_plugin_paths
, true);
1598 struct bt_config
*bt_config_help_create(
1599 struct bt_value
*initial_plugin_paths
)
1601 struct bt_config
*cfg
;
1604 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
,
1605 initial_plugin_paths
, true);
1610 cfg
->cmd_data
.help
.cfg_component
=
1611 bt_config_component_create(BT_COMPONENT_CLASS_TYPE_UNKNOWN
,
1613 if (!cfg
->cmd_data
.help
.cfg_component
) {
1627 struct bt_config
*bt_config_query_create(
1628 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
) {
1655 struct bt_config
*bt_config_print_ctf_metadata_create(
1656 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
) {
1689 struct bt_config
*bt_config_print_lttng_live_sessions_create(
1690 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
) {
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 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
);
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 */
1912 cfg
->cmd_data
.help
.cfg_component
->type
=
1913 BT_COMPONENT_CLASS_TYPE_UNKNOWN
;
1915 cfg
->cmd_data
.help
.cfg_component
->plugin_name
,
1919 print_help_usage(stdout
);
1925 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
1936 g_free(plugin_name
);
1937 g_free(comp_cls_name
);
1940 poptFreeContext(pc
);
1948 * Prints the help command usage.
1951 void print_query_usage(FILE *fp
)
1953 fprintf(fp
, "Usage: babeltrace [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
1955 fprintf(fp
, "Options:\n");
1957 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1958 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
1959 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1960 fprintf(fp
, " -p, --params=PARAMS Set the query parameters to PARAMS\n");
1961 fprintf(fp
, " (see the expected format of PARAMS below)\n");
1962 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1963 fprintf(fp
, " dynamic plugins can be loaded\n");
1964 fprintf(fp
, " -h, --help Show this help and quit\n");
1965 fprintf(fp
, "\n\n");
1966 print_expected_params_format(fp
);
1970 struct poptOption query_long_options
[] = {
1971 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1972 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
1973 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
1974 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
1975 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
1976 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
1977 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
1981 * Creates a Babeltrace config object from the arguments of a query
1984 * *retcode is set to the appropriate exit code to use.
1987 struct bt_config
*bt_config_query_from_args(int argc
, const char *argv
[],
1988 int *retcode
, bool force_omit_system_plugin_path
,
1989 bool force_omit_home_plugin_path
,
1990 struct bt_value
*initial_plugin_paths
)
1992 poptContext pc
= NULL
;
1996 struct bt_config
*cfg
= NULL
;
1997 const char *leftover
;
1998 struct bt_value
*params
= bt_value_null
;
2001 cfg
= bt_config_query_create(initial_plugin_paths
);
2006 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
2007 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
2008 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
2014 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2015 query_long_options
, 0);
2017 printf_err("Cannot get popt context\n");
2021 poptReadDefaultConfig(pc
, 0);
2023 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2024 arg
= poptGetOptArg(pc
);
2027 case OPT_PLUGIN_PATH
:
2028 if (bt_config_append_plugin_paths_check_setuid_setgid(
2029 cfg
->plugin_paths
, arg
)) {
2033 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2034 cfg
->omit_system_plugin_path
= true;
2036 case OPT_OMIT_HOME_PLUGIN_PATH
:
2037 cfg
->omit_home_plugin_path
= true;
2042 params
= bt_value_from_arg(arg
);
2044 printf_err("Invalid format for --params option's argument:\n %s\n",
2051 print_query_usage(stdout
);
2056 printf_err("Unknown command-line option specified (option code %d)\n",
2065 /* Check for option parsing error */
2067 printf_err("While parsing command-line options, at option %s: %s\n",
2068 poptBadOption(pc
, 0), poptStrerror(opt
));
2073 * We need exactly two leftover arguments which are the
2074 * mandatory component class specification and query object.
2076 leftover
= poptGetArg(pc
);
2078 cfg
->cmd_data
.query
.cfg_component
=
2079 bt_config_component_from_arg(leftover
);
2080 if (!cfg
->cmd_data
.query
.cfg_component
) {
2081 printf_err("Invalid format for component class specification:\n %s\n",
2087 BT_MOVE(cfg
->cmd_data
.query
.cfg_component
->params
, params
);
2089 print_query_usage(stdout
);
2095 leftover
= poptGetArg(pc
);
2097 if (strlen(leftover
) == 0) {
2098 printf_err("Invalid empty object\n");
2102 g_string_assign(cfg
->cmd_data
.query
.object
, leftover
);
2104 print_query_usage(stdout
);
2110 leftover
= poptGetArg(pc
);
2112 printf_err("Unexpected argument: %s\n", leftover
);
2116 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2128 poptFreeContext(pc
);
2137 * Prints the list-plugins command usage.
2140 void print_list_plugins_usage(FILE *fp
)
2142 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
2144 fprintf(fp
, "Options:\n");
2146 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2147 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2148 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2149 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2150 fprintf(fp
, " dynamic plugins can be loaded\n");
2151 fprintf(fp
, " -h, --help Show this help and quit\n");
2153 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2155 fprintf(fp
, "Use `babeltrace help` to get help for a specific plugin or component class.\n");
2159 struct poptOption list_plugins_long_options
[] = {
2160 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2161 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2162 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2163 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2164 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2165 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
2169 * Creates a Babeltrace config object from the arguments of a
2170 * list-plugins command.
2172 * *retcode is set to the appropriate exit code to use.
2175 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
2176 int *retcode
, bool force_omit_system_plugin_path
,
2177 bool force_omit_home_plugin_path
,
2178 struct bt_value
*initial_plugin_paths
)
2180 poptContext pc
= NULL
;
2184 struct bt_config
*cfg
= NULL
;
2185 const char *leftover
;
2188 cfg
= bt_config_list_plugins_create(initial_plugin_paths
);
2193 cfg
->omit_system_plugin_path
= force_omit_system_plugin_path
;
2194 cfg
->omit_home_plugin_path
= force_omit_home_plugin_path
;
2195 ret
= append_env_var_plugin_paths(cfg
->plugin_paths
);
2201 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2202 list_plugins_long_options
, 0);
2204 printf_err("Cannot get popt context\n");
2208 poptReadDefaultConfig(pc
, 0);
2210 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2211 arg
= poptGetOptArg(pc
);
2214 case OPT_PLUGIN_PATH
:
2215 if (bt_config_append_plugin_paths_check_setuid_setgid(
2216 cfg
->plugin_paths
, arg
)) {
2220 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2221 cfg
->omit_system_plugin_path
= true;
2223 case OPT_OMIT_HOME_PLUGIN_PATH
:
2224 cfg
->omit_home_plugin_path
= true;
2227 print_list_plugins_usage(stdout
);
2232 printf_err("Unknown command-line option specified (option code %d)\n",
2241 /* Check for option parsing error */
2243 printf_err("While parsing command-line options, at option %s: %s\n",
2244 poptBadOption(pc
, 0), poptStrerror(opt
));
2248 leftover
= poptGetArg(pc
);
2250 printf_err("Unexpected argument: %s\n", leftover
);
2254 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2266 poptFreeContext(pc
);
2274 * Prints the run command usage.
2277 void print_run_usage(FILE *fp
)
2279 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] run [OPTIONS]\n");
2281 fprintf(fp
, "Options:\n");
2283 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
2284 fprintf(fp
, " for all the following components until\n");
2285 fprintf(fp
, " --reset-base-params is encountered\n");
2286 fprintf(fp
, " (see the expected format of PARAMS below)\n");
2287 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2288 fprintf(fp
, " Instantiate the component class CLS of type\n");
2289 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2290 fprintf(fp
, " in the plugin PLUGIN, add it to the graph,\n");
2291 fprintf(fp
, " and optionally name it NAME (you can also\n");
2292 fprintf(fp
, " specify the name with --name)\n");
2293 fprintf(fp
, " -C, --connect=CONNECTION Connect two created components (see the\n");
2294 fprintf(fp
, " expected format of CONNECTION below)\n");
2295 fprintf(fp
, " --key=KEY Set the current initialization string\n");
2296 fprintf(fp
, " parameter key to KEY (see --value)\n");
2297 fprintf(fp
, " -n, --name=NAME Set the name of the current component\n");
2298 fprintf(fp
, " to NAME (must be unique amongst all the\n");
2299 fprintf(fp
, " names of the created components)\n");
2300 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2301 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2302 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2303 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2304 fprintf(fp
, " current component (see the expected format\n");
2305 fprintf(fp
, " of PARAMS below)\n");
2306 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2307 fprintf(fp
, " dynamic plugins can be loaded\n");
2308 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters to an\n");
2309 fprintf(fp
, " empty map\n");
2310 fprintf(fp
, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n");
2311 fprintf(fp
, " the graph later, retry in DUR µs\n");
2312 fprintf(fp
, " (default: 100000)\n");
2313 fprintf(fp
, " --value=VAL Add a string initialization parameter to\n");
2314 fprintf(fp
, " the current component with a name given by\n");
2315 fprintf(fp
, " the last argument of the --key option and a\n");
2316 fprintf(fp
, " value set to VAL\n");
2317 fprintf(fp
, " -h, --help Show this help and quit\n");
2319 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2320 fprintf(fp
, "\n\n");
2321 fprintf(fp
, "Expected format of CONNECTION\n");
2322 fprintf(fp
, "-----------------------------\n");
2324 fprintf(fp
, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
2326 fprintf(fp
, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
2327 fprintf(fp
, "components to connect together. You must escape the following characters\n\n");
2328 fprintf(fp
, "with `\\`: `\\`, `.`, and `:`. You can set the name of the current\n");
2329 fprintf(fp
, "component with the --name option.\n");
2331 fprintf(fp
, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
2332 fprintf(fp
, "identify the upstream and downstream ports to use for the connection.\n");
2333 fprintf(fp
, "When the port is not specified, `*` is used.\n");
2335 fprintf(fp
, "When a component named UPSTREAM has an available port which matches the\n");
2336 fprintf(fp
, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
2337 fprintf(fp
, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
2338 fprintf(fp
, "DOWNSTREAM.\n");
2340 fprintf(fp
, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
2341 fprintf(fp
, "which matches anything. You must escape the following characters\n");
2342 fprintf(fp
, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
2344 fprintf(fp
, "You can connect a source component to a filter or sink component. You\n");
2345 fprintf(fp
, "can connect a filter component to a sink component.\n");
2347 fprintf(fp
, "Examples:\n");
2349 fprintf(fp
, " my-src:my-sink\n");
2350 fprintf(fp
, " ctf-fs.*stream*:utils-muxer:*\n");
2352 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
2353 fprintf(fp
, "babeltrace from a shell.\n");
2354 fprintf(fp
, "\n\n");
2355 print_expected_params_format(fp
);
2359 * Creates a Babeltrace config object from the arguments of a run
2362 * *retcode is set to the appropriate exit code to use.
2365 struct bt_config
*bt_config_run_from_args(int argc
, const char *argv
[],
2366 int *retcode
, bool force_omit_system_plugin_path
,
2367 bool force_omit_home_plugin_path
,
2368 struct bt_value
*initial_plugin_paths
)
2370 poptContext pc
= NULL
;
2372 struct bt_config_component
*cur_cfg_comp
= NULL
;
2373 enum bt_config_component_dest cur_cfg_comp_dest
=
2374 BT_CONFIG_COMPONENT_DEST_UNKNOWN
;
2375 struct bt_value
*cur_base_params
= NULL
;
2377 struct bt_config
*cfg
= NULL
;
2378 struct bt_value
*instance_names
= NULL
;
2379 struct bt_value
*connection_args
= NULL
;
2380 GString
*cur_param_key
= NULL
;
2381 char error_buf
[256] = { 0 };
2382 long retry_duration
= -1;
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_PUT(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_put(cur_cfg_comp
->params
);
2507 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2508 if (!cur_cfg_comp
->params
) {
2513 cur_cfg_comp_dest
= new_dest
;
2518 struct bt_value
*params
;
2519 struct bt_value
*params_to_set
;
2521 if (!cur_cfg_comp
) {
2522 printf_err("Cannot add parameters to unavailable component:\n %s\n",
2527 params
= bt_value_from_arg(arg
);
2529 printf_err("Invalid format for --params option's argument:\n %s\n",
2534 params_to_set
= bt_value_map_extend(cur_cfg_comp
->params
,
2537 if (!params_to_set
) {
2538 printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n",
2543 BT_MOVE(cur_cfg_comp
->params
, params_to_set
);
2547 if (strlen(arg
) == 0) {
2548 printf_err("Cannot set an empty string as the current parameter key\n");
2552 g_string_assign(cur_param_key
, arg
);
2555 if (!cur_cfg_comp
) {
2556 printf_err("Cannot set a parameter's value of unavailable component:\n %s\n",
2561 if (cur_param_key
->len
== 0) {
2562 printf_err("--value option specified without preceding --key option:\n %s\n",
2567 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2568 cur_param_key
->str
, arg
)) {
2574 if (!cur_cfg_comp
) {
2575 printf_err("Cannot set the name of unavailable component:\n %s\n",
2580 g_string_assign(cur_cfg_comp
->instance_name
, arg
);
2582 case OPT_BASE_PARAMS
:
2584 struct bt_value
*params
= bt_value_from_arg(arg
);
2587 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2592 BT_MOVE(cur_base_params
, params
);
2595 case OPT_RESET_BASE_PARAMS
:
2596 BT_PUT(cur_base_params
);
2597 cur_base_params
= bt_value_map_create();
2598 if (!cur_base_params
) {
2604 if (bt_value_array_append_string(connection_args
,
2610 case OPT_RETRY_DURATION
:
2611 if (retry_duration
< 0) {
2612 printf_err("--retry-duration option's argument must be positive or 0: %ld\n",
2617 cfg
->cmd_data
.run
.retry_duration_us
=
2618 (uint64_t) retry_duration
;
2621 print_run_usage(stdout
);
2626 printf_err("Unknown command-line option specified (option code %d)\n",
2635 /* Check for option parsing error */
2637 printf_err("While parsing command-line options, at option %s: %s\n",
2638 poptBadOption(pc
, 0), poptStrerror(opt
));
2642 /* This command does not accept leftover arguments */
2643 if (poptPeekArg(pc
)) {
2644 printf_err("Unexpected argument: %s\n", poptPeekArg(pc
));
2648 /* Add current component */
2650 ret
= add_run_cfg_comp_check_name(cfg
, cur_cfg_comp
,
2651 cur_cfg_comp_dest
, instance_names
);
2652 BT_PUT(cur_cfg_comp
);
2658 if (cfg
->cmd_data
.run
.sources
->len
== 0) {
2659 printf_err("Incomplete graph: no source component\n");
2663 if (cfg
->cmd_data
.run
.sinks
->len
== 0) {
2664 printf_err("Incomplete graph: no sink component\n");
2668 if (append_home_and_system_plugin_paths_cfg(cfg
)) {
2672 ret
= bt_config_cli_args_create_connections(cfg
, connection_args
,
2675 printf_err("Cannot creation connections:\n%s", error_buf
);
2687 poptFreeContext(pc
);
2690 if (cur_param_key
) {
2691 g_string_free(cur_param_key
, TRUE
);
2695 BT_PUT(cur_cfg_comp
);
2696 BT_PUT(cur_base_params
);
2697 BT_PUT(instance_names
);
2698 BT_PUT(connection_args
);
2703 struct bt_config
*bt_config_run_from_args_array(struct bt_value
*run_args
,
2704 int *retcode
, bool force_omit_system_plugin_path
,
2705 bool force_omit_home_plugin_path
,
2706 struct bt_value
*initial_plugin_paths
)
2708 struct bt_config
*cfg
= NULL
;
2711 const size_t argc
= bt_value_array_size(run_args
) + 1;
2713 argv
= calloc(argc
, sizeof(*argv
));
2721 len
= bt_value_array_size(run_args
);
2723 printf_err("Invalid executable arguments\n");
2726 for (i
= 0; i
< len
; i
++) {
2728 struct bt_value
*arg_value
= bt_value_array_get(run_args
, i
);
2731 BT_ASSERT(arg_value
);
2732 ret
= bt_value_string_get(arg_value
, &arg
);
2733 BT_ASSERT(ret
== 0);
2739 cfg
= bt_config_run_from_args(argc
, argv
, retcode
,
2740 force_omit_system_plugin_path
, force_omit_home_plugin_path
,
2741 initial_plugin_paths
);
2749 * Prints the convert command usage.
2752 void print_convert_usage(FILE *fp
)
2754 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2756 fprintf(fp
, "Options:\n");
2758 fprintf(fp
, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2759 fprintf(fp
, " Instantiate the component class CLS of type\n");
2760 fprintf(fp
, " TYPE (`source`, `filter`, or `sink`) found\n");
2761 fprintf(fp
, " in the plugin PLUGIN, add it to the\n");
2762 fprintf(fp
, " conversion graph, and optionally name it\n");
2763 fprintf(fp
, " NAME (you can also specify the name with\n");
2764 fprintf(fp
, " --name)\n");
2765 fprintf(fp
, " --name=NAME Set the name of the current component\n");
2766 fprintf(fp
, " to NAME (must be unique amongst all the\n");
2767 fprintf(fp
, " names of the created components)\n");
2768 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2769 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2770 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2771 fprintf(fp
, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2772 fprintf(fp
, " current component (see the expected format\n");
2773 fprintf(fp
, " of PARAMS below)\n");
2774 fprintf(fp
, " -P, --path=PATH Set the `path` string parameter of the\n");
2775 fprintf(fp
, " current component to PATH\n");
2776 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2777 fprintf(fp
, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n");
2778 fprintf(fp
, " the graph later, retry in DUR µs\n");
2779 fprintf(fp
, " (default: 100000)\n");
2780 fprintf(fp
, " dynamic plugins can be loaded\n");
2781 fprintf(fp
, " --run-args Print the equivalent arguments for the\n");
2782 fprintf(fp
, " `run` command to the standard output,\n");
2783 fprintf(fp
, " formatted for a shell, and quit\n");
2784 fprintf(fp
, " --run-args-0 Print the equivalent arguments for the\n");
2785 fprintf(fp
, " `run` command to the standard output,\n");
2786 fprintf(fp
, " formatted for `xargs -0`, and quit\n");
2787 fprintf(fp
, " --stream-intersection Only process events when all streams\n");
2788 fprintf(fp
, " are active\n");
2789 fprintf(fp
, " -u, --url=URL Set the `url` string parameter of the\n");
2790 fprintf(fp
, " current component to URL\n");
2791 fprintf(fp
, " -h, --help Show this help and quit\n");
2793 fprintf(fp
, "Implicit `source.ctf.fs` component options:\n");
2795 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2796 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS ns\n");
2798 fprintf(fp
, "Implicit `sink.text.pretty` component options:\n");
2800 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2801 fprintf(fp
, " --clock-date Print timestamp dates\n");
2802 fprintf(fp
, " --clock-gmt Print and parse timestamps in the GMT\n");
2803 fprintf(fp
, " time zone instead of the local time zone\n");
2804 fprintf(fp
, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2805 fprintf(fp
, " of `hh:mm:ss.nnnnnnnnn`\n");
2806 fprintf(fp
, " --color=(never | auto | always)\n");
2807 fprintf(fp
, " Never, automatically, or always emit\n");
2808 fprintf(fp
, " console color codes\n");
2809 fprintf(fp
, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2810 fprintf(fp
, " `all`, `trace`, `trace:hostname`,\n");
2811 fprintf(fp
, " `trace:domain`, `trace:procname`,\n");
2812 fprintf(fp
, " `trace:vpid`, `loglevel`, `emf`\n");
2813 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2814 fprintf(fp
, " `payload` (or `arg` or `args`), `none`,\n");
2815 fprintf(fp
, " `all`, `scope`, `header`, `context`\n");
2816 fprintf(fp
, " (or `ctx`)\n");
2817 fprintf(fp
, " --no-delta Do not print time delta between\n");
2818 fprintf(fp
, " consecutive events\n");
2819 fprintf(fp
, " -w, --output=PATH Write output text to PATH instead of\n");
2820 fprintf(fp
, " the standard output\n");
2822 fprintf(fp
, "Implicit `filter.utils.muxer` component options:\n");
2824 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently\n");
2825 fprintf(fp
, " correlated across traces\n");
2827 fprintf(fp
, "Implicit `filter.utils.trimmer` component options:\n");
2829 fprintf(fp
, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2830 fprintf(fp
, " time range to BEGIN (see the format of\n");
2831 fprintf(fp
, " BEGIN below)\n");
2832 fprintf(fp
, " -e, --end=END Set the end time of the conversion time\n");
2833 fprintf(fp
, " range to END (see the format of END below)\n");
2834 fprintf(fp
, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2835 fprintf(fp
, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2836 fprintf(fp
, " `]`) (see the format of BEGIN/END below)\n");
2838 fprintf(fp
, "Implicit `filter.lttng-utils.debug-info` component options:\n");
2840 fprintf(fp
, " --debug-info Create an implicit\n");
2841 fprintf(fp
, " `filter.lttng-utils.debug-info` component\n");
2842 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2843 fprintf(fp
, " instead of `/usr/lib/debug`\n");
2844 fprintf(fp
, " --debug-info-full-path Show full debug info source and\n");
2845 fprintf(fp
, " binary paths instead of just names\n");
2846 fprintf(fp
, " --debug-info-target-prefix=DIR\n");
2847 fprintf(fp
, " Use directory DIR as a prefix when\n");
2848 fprintf(fp
, " looking up executables during debug\n");
2849 fprintf(fp
, " info analysis\n");
2851 fprintf(fp
, "Legacy options that still work:\n");
2853 fprintf(fp
, " -i, --input-format=(ctf | lttng-live)\n");
2854 fprintf(fp
, " `ctf`:\n");
2855 fprintf(fp
, " Create an implicit `source.ctf.fs`\n");
2856 fprintf(fp
, " component\n");
2857 fprintf(fp
, " `lttng-live`:\n");
2858 fprintf(fp
, " Create an implicit `source.ctf.lttng-live`\n");
2859 fprintf(fp
, " component\n");
2860 fprintf(fp
, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
2861 fprintf(fp
, " `text`:\n");
2862 fprintf(fp
, " Create an implicit `sink.text.pretty`\n");
2863 fprintf(fp
, " component\n");
2864 fprintf(fp
, " `ctf`:\n");
2865 fprintf(fp
, " Create an implicit `sink.ctf.fs`\n");
2866 fprintf(fp
, " component\n");
2867 fprintf(fp
, " `dummy`:\n");
2868 fprintf(fp
, " Create an implicit `sink.utils.dummy`\n");
2869 fprintf(fp
, " component\n");
2870 fprintf(fp
, " `ctf-metadata`:\n");
2871 fprintf(fp
, " Query the `source.ctf.fs` component class\n");
2872 fprintf(fp
, " for metadata text and quit\n");
2874 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2875 fprintf(fp
, "\n\n");
2876 fprintf(fp
, "Format of BEGIN and END\n");
2877 fprintf(fp
, "-----------------------\n");
2879 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2880 fprintf(fp
, "\n\n");
2881 print_expected_params_format(fp
);
2885 struct poptOption convert_long_options
[] = {
2886 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2887 { "begin", 'b', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2888 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2889 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2890 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2891 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2892 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2893 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2894 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2895 { "color", '\0', POPT_ARG_STRING
, NULL
, OPT_COLOR
, NULL
, NULL
},
2896 { "component", 'c', POPT_ARG_STRING
, NULL
, OPT_COMPONENT
, NULL
, NULL
},
2897 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2898 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2899 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2900 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2901 { "end", 'e', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2902 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2903 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2904 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2905 { "name", '\0', POPT_ARG_STRING
, NULL
, OPT_NAME
, NULL
, NULL
},
2906 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2907 { "debug-info", '\0', POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO
, NULL
, NULL
},
2908 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2909 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2910 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2911 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT
, NULL
, NULL
},
2912 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2913 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2914 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2915 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2916 { "retry-duration", '\0', POPT_ARG_STRING
, NULL
, OPT_RETRY_DURATION
, NULL
, NULL
},
2917 { "run-args", '\0', POPT_ARG_NONE
, NULL
, OPT_RUN_ARGS
, NULL
, NULL
},
2918 { "run-args-0", '\0', POPT_ARG_NONE
, NULL
, OPT_RUN_ARGS_0
, NULL
, NULL
},
2919 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2920 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2921 { "url", 'u', POPT_ARG_STRING
, NULL
, OPT_URL
, NULL
, NULL
},
2922 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2923 { NULL
, 0, '\0', NULL
, 0, NULL
, NULL
},
2927 GString
*get_component_auto_name(const char *prefix
,
2928 struct bt_value
*existing_names
)
2931 GString
*auto_name
= g_string_new(NULL
);
2938 if (!bt_value_map_has_key(existing_names
, prefix
)) {
2939 g_string_assign(auto_name
, prefix
);
2944 g_string_printf(auto_name
, "%s-%d", prefix
, i
);
2946 } while (bt_value_map_has_key(existing_names
, auto_name
->str
));
2952 struct implicit_component_args
{
2956 GString
*params_arg
;
2957 struct bt_value
*extra_params
;
2961 int assign_name_to_implicit_component(struct implicit_component_args
*args
,
2962 const char *prefix
, struct bt_value
*existing_names
,
2963 GList
**comp_names
, bool append_to_comp_names
)
2966 GString
*name
= NULL
;
2968 if (!args
->exists
) {
2972 name
= get_component_auto_name(prefix
, existing_names
);
2979 g_string_assign(args
->name_arg
, name
->str
);
2981 if (bt_value_map_insert(existing_names
, name
->str
,
2988 if (append_to_comp_names
) {
2989 *comp_names
= g_list_append(*comp_names
, name
);
2995 g_string_free(name
, TRUE
);
3002 int append_run_args_for_implicit_component(
3003 struct implicit_component_args
*impl_args
,
3004 struct bt_value
*run_args
)
3009 if (!impl_args
->exists
) {
3013 if (bt_value_array_append_string(run_args
, "--component")) {
3018 if (bt_value_array_append_string(run_args
, impl_args
->comp_arg
->str
)) {
3023 if (bt_value_array_append_string(run_args
, "--name")) {
3028 if (bt_value_array_append_string(run_args
, impl_args
->name_arg
->str
)) {
3033 if (impl_args
->params_arg
->len
> 0) {
3034 if (bt_value_array_append_string(run_args
, "--params")) {
3039 if (bt_value_array_append_string(run_args
,
3040 impl_args
->params_arg
->str
)) {
3046 for (i
= 0; i
< bt_value_array_size(impl_args
->extra_params
); i
++) {
3047 struct bt_value
*elem
;
3050 elem
= bt_value_array_get(impl_args
->extra_params
, i
);
3055 BT_ASSERT(bt_value_is_string(elem
));
3056 if (bt_value_string_get(elem
, &arg
)) {
3060 ret
= bt_value_array_append_string(run_args
, arg
);
3078 void finalize_implicit_component_args(struct implicit_component_args
*args
)
3082 if (args
->comp_arg
) {
3083 g_string_free(args
->comp_arg
, TRUE
);
3086 if (args
->name_arg
) {
3087 g_string_free(args
->name_arg
, TRUE
);
3090 if (args
->params_arg
) {
3091 g_string_free(args
->params_arg
, TRUE
);
3094 bt_put(args
->extra_params
);
3098 void destroy_implicit_component_args(void *args
)
3104 finalize_implicit_component_args(args
);
3109 int init_implicit_component_args(struct implicit_component_args
*args
,
3110 const char *comp_arg
, bool exists
)
3114 args
->exists
= exists
;
3115 args
->comp_arg
= g_string_new(comp_arg
);
3116 args
->name_arg
= g_string_new(NULL
);
3117 args
->params_arg
= g_string_new(NULL
);
3118 args
->extra_params
= bt_value_array_create();
3120 if (!args
->comp_arg
|| !args
->name_arg
||
3121 !args
->params_arg
|| !args
->extra_params
) {
3123 finalize_implicit_component_args(args
);
3133 void append_implicit_component_param(struct implicit_component_args
*args
,
3134 const char *key
, const char *value
)
3139 append_param_arg(args
->params_arg
, key
, value
);
3143 int append_implicit_component_extra_param(struct implicit_component_args
*args
,
3144 const char *key
, const char *value
)
3152 if (bt_value_array_append_string(args
->extra_params
, "--key")) {
3158 if (bt_value_array_append_string(args
->extra_params
, key
)) {
3164 if (bt_value_array_append_string(args
->extra_params
, "--value")) {
3170 if (bt_value_array_append_string(args
->extra_params
, value
)) {
3181 int convert_append_name_param(enum bt_config_component_dest dest
,
3182 GString
*cur_name
, GString
*cur_name_prefix
,
3183 struct bt_value
*run_args
, struct bt_value
*all_names
,
3184 GList
**source_names
, GList
**filter_names
,
3189 if (cur_name_prefix
->len
> 0) {
3190 /* We're after a --component option */
3191 GString
*name
= NULL
;
3192 bool append_name_opt
= false;
3194 if (cur_name
->len
== 0) {
3196 * No explicit name was provided for the user
3199 name
= get_component_auto_name(cur_name_prefix
->str
,
3201 append_name_opt
= true;
3204 * An explicit name was provided for the user
3207 if (bt_value_map_has_key(all_names
,
3209 printf_err("Duplicate component instance name:\n %s\n",
3214 name
= g_string_new(cur_name
->str
);
3223 * Remember this name globally, for the uniqueness of
3224 * all component names.
3226 if (bt_value_map_insert(all_names
, name
->str
, bt_value_null
)) {
3232 * Append the --name option if necessary.
3234 if (append_name_opt
) {
3235 if (bt_value_array_append_string(run_args
, "--name")) {
3240 if (bt_value_array_append_string(run_args
, name
->str
)) {
3247 * Remember this name specifically for the type of the
3248 * component. This is to create connection arguments.
3251 case BT_CONFIG_COMPONENT_DEST_SOURCE
:
3252 *source_names
= g_list_append(*source_names
, name
);
3254 case BT_CONFIG_COMPONENT_DEST_FILTER
:
3255 *filter_names
= g_list_append(*filter_names
, name
);
3257 case BT_CONFIG_COMPONENT_DEST_SINK
:
3258 *sink_names
= g_list_append(*sink_names
, name
);
3264 g_string_assign(cur_name_prefix
, "");
3277 * Escapes `.`, `:`, and `\` of `input` with `\`.
3280 GString
*escape_dot_colon(const char *input
)
3282 GString
*output
= g_string_new(NULL
);
3290 for (ch
= input
; *ch
!= '\0'; ch
++) {
3291 if (*ch
== '\\' || *ch
== '.' || *ch
== ':') {
3292 g_string_append_c(output
, '\\');
3295 g_string_append_c(output
, *ch
);
3303 * Appends a --connect option to a list of arguments. `upstream_name`
3304 * and `downstream_name` are escaped with escape_dot_colon() in this
3308 int append_connect_arg(struct bt_value
*run_args
,
3309 const char *upstream_name
, const char *downstream_name
)
3312 GString
*e_upstream_name
= escape_dot_colon(upstream_name
);
3313 GString
*e_downstream_name
= escape_dot_colon(downstream_name
);
3314 GString
*arg
= g_string_new(NULL
);
3316 if (!e_upstream_name
|| !e_downstream_name
|| !arg
) {
3322 ret
= bt_value_array_append_string(run_args
, "--connect");
3329 g_string_append(arg
, e_upstream_name
->str
);
3330 g_string_append_c(arg
, ':');
3331 g_string_append(arg
, e_downstream_name
->str
);
3332 ret
= bt_value_array_append_string(run_args
, arg
->str
);
3341 g_string_free(arg
, TRUE
);
3344 if (e_upstream_name
) {
3345 g_string_free(e_upstream_name
, TRUE
);
3348 if (e_downstream_name
) {
3349 g_string_free(e_downstream_name
, TRUE
);
3356 * Appends the run command's --connect options for the convert command.
3359 int convert_auto_connect(struct bt_value
*run_args
,
3360 GList
*source_names
, GList
*filter_names
,
3364 GList
*source_at
= source_names
;
3365 GList
*filter_at
= filter_names
;
3367 GList
*sink_at
= sink_names
;
3369 BT_ASSERT(source_names
);
3370 BT_ASSERT(filter_names
);
3371 BT_ASSERT(sink_names
);
3373 /* Connect all sources to the first filter */
3374 for (source_at
= source_names
; source_at
!= NULL
; source_at
= g_list_next(source_at
)) {
3375 GString
*source_name
= source_at
->data
;
3376 GString
*filter_name
= filter_at
->data
;
3378 ret
= append_connect_arg(run_args
, source_name
->str
,
3385 filter_prev
= filter_at
;
3386 filter_at
= g_list_next(filter_at
);
3388 /* Connect remaining filters */
3389 for (; filter_at
!= NULL
; filter_prev
= filter_at
, filter_at
= g_list_next(filter_at
)) {
3390 GString
*filter_name
= filter_at
->data
;
3391 GString
*filter_prev_name
= filter_prev
->data
;
3393 ret
= append_connect_arg(run_args
, filter_prev_name
->str
,
3400 /* Connect last filter to all sinks */
3401 for (sink_at
= sink_names
; sink_at
!= NULL
; sink_at
= g_list_next(sink_at
)) {
3402 GString
*filter_name
= filter_prev
->data
;
3403 GString
*sink_name
= sink_at
->data
;
3405 ret
= append_connect_arg(run_args
, filter_name
->str
,
3422 int split_timerange(const char *arg
, char **begin
, char **end
)
3425 const char *ch
= arg
;
3427 GString
*g_begin
= NULL
;
3428 GString
*g_end
= NULL
;
3436 g_begin
= bt_common_string_until(ch
, "", ",", &end_pos
);
3437 if (!g_begin
|| ch
[end_pos
] != ',' || g_begin
->len
== 0) {
3443 g_end
= bt_common_string_until(ch
, "", "]", &end_pos
);
3444 if (!g_end
|| g_end
->len
== 0) {
3450 *begin
= g_begin
->str
;
3452 g_string_free(g_begin
, FALSE
);
3453 g_string_free(g_end
, FALSE
);
3463 g_string_free(g_begin
, TRUE
);
3467 g_string_free(g_end
, TRUE
);
3474 int g_list_prepend_gstring(GList
**list
, const char *string
)
3477 GString
*gs
= g_string_new(string
);
3486 *list
= g_list_prepend(*list
, gs
);
3493 struct implicit_component_args
*create_implicit_component_args(void)
3495 struct implicit_component_args
*impl_args
=
3496 g_new0(struct implicit_component_args
, 1);
3502 if (init_implicit_component_args(impl_args
, NULL
, true)) {
3503 destroy_implicit_component_args(impl_args
);
3513 int fill_implicit_ctf_inputs_args(GPtrArray
*implicit_ctf_inputs_args
,
3514 struct implicit_component_args
*base_implicit_ctf_input_args
,
3520 for (leftover
= leftovers
; leftover
!= NULL
;
3521 leftover
= g_list_next(leftover
)) {
3522 GString
*gs_leftover
= leftover
->data
;
3523 struct implicit_component_args
*impl_args
=
3524 create_implicit_component_args();
3531 impl_args
->exists
= true;
3532 g_string_assign(impl_args
->comp_arg
,
3533 base_implicit_ctf_input_args
->comp_arg
->str
);
3534 g_string_assign(impl_args
->params_arg
,
3535 base_implicit_ctf_input_args
->params_arg
->str
);
3538 * We need our own copy of the extra parameters because
3539 * this is where the unique path goes.
3541 BT_PUT(impl_args
->extra_params
);
3542 impl_args
->extra_params
=
3543 bt_value_copy(base_implicit_ctf_input_args
->extra_params
);
3544 if (!impl_args
->extra_params
) {
3546 destroy_implicit_component_args(impl_args
);
3550 /* Append unique path parameter */
3551 ret
= append_implicit_component_extra_param(impl_args
,
3552 "path", gs_leftover
->str
);
3554 destroy_implicit_component_args(impl_args
);
3558 g_ptr_array_add(implicit_ctf_inputs_args
, impl_args
);
3571 * Creates a Babeltrace config object from the arguments of a convert
3574 * *retcode is set to the appropriate exit code to use.
3577 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
3578 int *retcode
, bool force_omit_system_plugin_path
,
3579 bool force_omit_home_plugin_path
,
3580 struct bt_value
*initial_plugin_paths
, char *log_level
)
3582 poptContext pc
= NULL
;
3584 enum bt_config_component_dest cur_comp_dest
=
3585 BT_CONFIG_COMPONENT_DEST_UNKNOWN
;
3587 struct bt_config
*cfg
= NULL
;
3588 bool got_input_format_opt
= false;
3589 bool got_output_format_opt
= false;
3590 bool trimmer_has_begin
= false;
3591 bool trimmer_has_end
= false;
3592 bool stream_intersection_mode
= false;
3593 GString
*cur_name
= NULL
;
3594 GString
*cur_name_prefix
= NULL
;
3595 const char *leftover
= NULL
;
3596 bool print_run_args
= false;
3597 bool print_run_args_0
= false;
3598 bool print_ctf_metadata
= false;
3599 struct bt_value
*run_args
= NULL
;
3600 struct bt_value
*all_names
= NULL
;
3601 GList
*source_names
= NULL
;
3602 GList
*filter_names
= NULL
;
3603 GList
*sink_names
= NULL
;
3604 GList
*leftovers
= NULL
;
3605 GPtrArray
*implicit_ctf_inputs_args
= NULL
;
3606 struct implicit_component_args base_implicit_ctf_input_args
= { 0 };
3607 struct implicit_component_args implicit_ctf_output_args
= { 0 };
3608 struct implicit_component_args implicit_lttng_live_args
= { 0 };
3609 struct implicit_component_args implicit_dummy_args
= { 0 };
3610 struct implicit_component_args implicit_text_args
= { 0 };
3611 struct implicit_component_args implicit_debug_info_args
= { 0 };
3612 struct implicit_component_args implicit_muxer_args
= { 0 };
3613 struct implicit_component_args implicit_trimmer_args
= { 0 };
3614 struct bt_value
*plugin_paths
= bt_get(initial_plugin_paths
);
3615 char error_buf
[256] = { 0 };
3617 struct bt_common_lttng_live_url_parts lttng_live_url_parts
= { 0 };
3618 char *output
= NULL
;
3623 print_convert_usage(stdout
);
3628 if (init_implicit_component_args(&base_implicit_ctf_input_args
,
3629 "source.ctf.fs", false)) {
3633 if (init_implicit_component_args(&implicit_ctf_output_args
,
3634 "sink.ctf.fs", false)) {
3638 if (init_implicit_component_args(&implicit_lttng_live_args
,
3639 "source.ctf.lttng-live", false)) {
3643 if (init_implicit_component_args(&implicit_text_args
,
3644 "sink.text.pretty", false)) {
3648 if (init_implicit_component_args(&implicit_dummy_args
,
3649 "sink.utils.dummy", false)) {
3653 if (init_implicit_component_args(&implicit_debug_info_args
,
3654 "filter.lttng-utils.debug-info", false)) {
3658 if (init_implicit_component_args(&implicit_muxer_args
,
3659 "filter.utils.muxer", true)) {
3663 if (init_implicit_component_args(&implicit_trimmer_args
,
3664 "filter.utils.trimmer", false)) {
3668 implicit_ctf_inputs_args
= g_ptr_array_new_with_free_func(
3669 (GDestroyNotify
) destroy_implicit_component_args
);
3670 if (!implicit_ctf_inputs_args
) {
3675 all_names
= bt_value_map_create();
3681 run_args
= bt_value_array_create();
3687 cur_name
= g_string_new(NULL
);
3693 cur_name_prefix
= g_string_new(NULL
);
3694 if (!cur_name_prefix
) {
3699 ret
= append_env_var_plugin_paths(plugin_paths
);
3705 * First pass: collect all arguments which need to be passed
3706 * as is to the run command. This pass can also add --name
3707 * arguments if needed to automatically name unnamed component
3708 * instances. Also it does the following transformations:
3710 * --path=PATH -> --key path --value PATH
3711 * --url=URL -> --key url --value URL
3713 * Also it appends the plugin paths of --plugin-path to
3716 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
3717 convert_long_options
, 0);
3719 printf_err("Cannot get popt context\n");
3723 poptReadDefaultConfig(pc
, 0);
3725 while ((opt
= poptGetNextOpt(pc
)) > 0) {
3727 char *plugin_name
= NULL
;
3728 char *comp_cls_name
= NULL
;
3730 arg
= poptGetOptArg(pc
);
3735 enum bt_component_class_type type
;
3736 const char *type_prefix
;
3738 /* Append current component's name if needed */
3739 ret
= convert_append_name_param(cur_comp_dest
, cur_name
,
3740 cur_name_prefix
, run_args
, all_names
,
3741 &source_names
, &filter_names
, &sink_names
);
3746 /* Parse the argument */
3747 plugin_comp_cls_names(arg
, &name
, &plugin_name
,
3748 &comp_cls_name
, &type
);
3749 if (!plugin_name
|| !comp_cls_name
) {
3750 printf_err("Invalid format for --component option's argument:\n %s\n",
3756 g_string_assign(cur_name
, name
);
3758 g_string_assign(cur_name
, "");
3762 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
3763 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
3764 type_prefix
= "source";
3766 case BT_COMPONENT_CLASS_TYPE_FILTER
:
3767 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_FILTER
;
3768 type_prefix
= "filter";
3770 case BT_COMPONENT_CLASS_TYPE_SINK
:
3771 cur_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
3772 type_prefix
= "sink";
3778 if (bt_value_array_append_string(run_args
,
3784 if (bt_value_array_append_string(run_args
, arg
)) {
3789 g_string_assign(cur_name_prefix
, "");
3790 g_string_append_printf(cur_name_prefix
, "%s.%s.%s",
3791 type_prefix
, plugin_name
, comp_cls_name
);
3794 free(comp_cls_name
);
3797 comp_cls_name
= NULL
;
3801 if (cur_name_prefix
->len
== 0) {
3802 printf_err("No current component of which to set parameters:\n %s\n",
3807 if (bt_value_array_append_string(run_args
,
3813 if (bt_value_array_append_string(run_args
, arg
)) {
3819 if (cur_name_prefix
->len
== 0) {
3820 printf_err("No current component of which to set `path` parameter:\n %s\n",
3825 if (bt_value_array_append_string(run_args
, "--key")) {
3830 if (bt_value_array_append_string(run_args
, "path")) {
3835 if (bt_value_array_append_string(run_args
, "--value")) {
3840 if (bt_value_array_append_string(run_args
, arg
)) {
3846 if (cur_name_prefix
->len
== 0) {
3847 printf_err("No current component of which to set `url` parameter:\n %s\n",
3852 if (bt_value_array_append_string(run_args
, "--key")) {
3857 if (bt_value_array_append_string(run_args
, "url")) {
3862 if (bt_value_array_append_string(run_args
, "--value")) {
3867 if (bt_value_array_append_string(run_args
, arg
)) {
3873 if (cur_name_prefix
->len
== 0) {
3874 printf_err("No current component to name:\n %s\n",
3879 if (bt_value_array_append_string(run_args
, "--name")) {
3884 if (bt_value_array_append_string(run_args
, arg
)) {
3889 g_string_assign(cur_name
, arg
);
3891 case OPT_OMIT_HOME_PLUGIN_PATH
:
3892 force_omit_home_plugin_path
= true;
3894 if (bt_value_array_append_string(run_args
,
3895 "--omit-home-plugin-path")) {
3900 case OPT_RETRY_DURATION
:
3901 if (bt_value_array_append_string(run_args
,
3902 "--retry-duration")) {
3907 if (bt_value_array_append_string(run_args
, arg
)) {
3912 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
3913 force_omit_system_plugin_path
= true;
3915 if (bt_value_array_append_string(run_args
,
3916 "--omit-system-plugin-path")) {
3921 case OPT_PLUGIN_PATH
:
3922 if (bt_config_append_plugin_paths_check_setuid_setgid(
3923 plugin_paths
, arg
)) {
3927 if (bt_value_array_append_string(run_args
,
3933 if (bt_value_array_append_string(run_args
, arg
)) {
3939 print_convert_usage(stdout
);
3944 case OPT_CLOCK_CYCLES
:
3945 case OPT_CLOCK_DATE
:
3946 case OPT_CLOCK_FORCE_CORRELATE
:
3948 case OPT_CLOCK_OFFSET
:
3949 case OPT_CLOCK_OFFSET_NS
:
3950 case OPT_CLOCK_SECONDS
:
3953 case OPT_DEBUG_INFO
:
3954 case OPT_DEBUG_INFO_DIR
:
3955 case OPT_DEBUG_INFO_FULL_PATH
:
3956 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3959 case OPT_INPUT_FORMAT
:
3962 case OPT_OUTPUT_FORMAT
:
3965 case OPT_RUN_ARGS_0
:
3966 case OPT_STREAM_INTERSECTION
:
3969 /* Ignore in this pass */
3972 printf_err("Unknown command-line option specified (option code %d)\n",
3981 /* Append current component's name if needed */
3982 ret
= convert_append_name_param(cur_comp_dest
, cur_name
,
3983 cur_name_prefix
, run_args
, all_names
, &source_names
,
3984 &filter_names
, &sink_names
);
3989 /* Check for option parsing error */
3991 printf_err("While parsing command-line options, at option %s: %s\n",
3992 poptBadOption(pc
, 0), poptStrerror(opt
));
3996 poptFreeContext(pc
);
4001 * Second pass: transform the convert-specific options and
4002 * arguments into implicit component instances for the run
4005 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
4006 convert_long_options
, 0);
4008 printf_err("Cannot get popt context\n");
4012 poptReadDefaultConfig(pc
, 0);
4014 while ((opt
= poptGetNextOpt(pc
)) > 0) {
4015 arg
= poptGetOptArg(pc
);
4019 if (trimmer_has_begin
) {
4020 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
4025 trimmer_has_begin
= true;
4026 ret
= append_implicit_component_extra_param(
4027 &implicit_trimmer_args
, "begin", arg
);
4028 implicit_trimmer_args
.exists
= true;
4034 if (trimmer_has_end
) {
4035 printf("At --end option: --end or --timerange option already specified\n %s\n",
4040 trimmer_has_end
= true;
4041 ret
= append_implicit_component_extra_param(
4042 &implicit_trimmer_args
, "end", arg
);
4043 implicit_trimmer_args
.exists
= true;
4053 if (trimmer_has_begin
|| trimmer_has_end
) {
4054 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
4059 ret
= split_timerange(arg
, &begin
, &end
);
4061 printf_err("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s\n",
4066 ret
= append_implicit_component_extra_param(
4067 &implicit_trimmer_args
, "begin", begin
);
4068 ret
|= append_implicit_component_extra_param(
4069 &implicit_trimmer_args
, "end", end
);
4070 implicit_trimmer_args
.exists
= true;
4078 case OPT_CLOCK_CYCLES
:
4079 append_implicit_component_param(
4080 &implicit_text_args
, "clock-cycles", "yes");
4081 implicit_text_args
.exists
= true;
4083 case OPT_CLOCK_DATE
:
4084 append_implicit_component_param(
4085 &implicit_text_args
, "clock-date", "yes");
4086 implicit_text_args
.exists
= true;
4088 case OPT_CLOCK_FORCE_CORRELATE
:
4089 append_implicit_component_param(
4090 &implicit_muxer_args
,
4091 "assume-absolute-clock-classes", "yes");
4094 append_implicit_component_param(
4095 &implicit_text_args
, "clock-gmt", "yes");
4096 append_implicit_component_param(
4097 &implicit_trimmer_args
, "clock-gmt", "yes");
4098 implicit_text_args
.exists
= true;
4100 case OPT_CLOCK_OFFSET
:
4101 base_implicit_ctf_input_args
.exists
= true;
4102 append_implicit_component_param(
4103 &base_implicit_ctf_input_args
,
4104 "clock-class-offset-s", arg
);
4106 case OPT_CLOCK_OFFSET_NS
:
4107 base_implicit_ctf_input_args
.exists
= true;
4108 append_implicit_component_param(
4109 &base_implicit_ctf_input_args
,
4110 "clock-class-offset-ns", arg
);
4112 case OPT_CLOCK_SECONDS
:
4113 append_implicit_component_param(
4114 &implicit_text_args
, "clock-seconds", "yes");
4115 implicit_text_args
.exists
= true;
4118 implicit_text_args
.exists
= true;
4119 ret
= append_implicit_component_extra_param(
4120 &implicit_text_args
, "color", arg
);
4125 case OPT_DEBUG_INFO
:
4126 implicit_debug_info_args
.exists
= true;
4128 case OPT_DEBUG_INFO_DIR
:
4129 implicit_debug_info_args
.exists
= true;
4130 ret
= append_implicit_component_extra_param(
4131 &implicit_debug_info_args
, "debug-info-dir", arg
);
4136 case OPT_DEBUG_INFO_FULL_PATH
:
4137 implicit_debug_info_args
.exists
= true;
4138 append_implicit_component_param(
4139 &implicit_debug_info_args
, "full-path", "yes");
4141 case OPT_DEBUG_INFO_TARGET_PREFIX
:
4142 implicit_debug_info_args
.exists
= true;
4143 ret
= append_implicit_component_extra_param(
4144 &implicit_debug_info_args
,
4145 "target-prefix", arg
);
4152 struct bt_value
*fields
= fields_from_arg(arg
);
4158 implicit_text_args
.exists
= true;
4159 ret
= insert_flat_params_from_array(
4160 implicit_text_args
.params_arg
,
4170 struct bt_value
*names
= names_from_arg(arg
);
4176 implicit_text_args
.exists
= true;
4177 ret
= insert_flat_params_from_array(
4178 implicit_text_args
.params_arg
,
4187 append_implicit_component_param(
4188 &implicit_text_args
, "no-delta", "yes");
4189 implicit_text_args
.exists
= true;
4191 case OPT_INPUT_FORMAT
:
4192 if (got_input_format_opt
) {
4193 printf_err("Duplicate --input-format option\n");
4197 got_input_format_opt
= true;
4199 if (strcmp(arg
, "ctf") == 0) {
4200 base_implicit_ctf_input_args
.exists
= true;
4201 } else if (strcmp(arg
, "lttng-live") == 0) {
4202 implicit_lttng_live_args
.exists
= true;
4204 printf_err("Unknown legacy input format:\n %s\n",
4209 case OPT_OUTPUT_FORMAT
:
4210 if (got_output_format_opt
) {
4211 printf_err("Duplicate --output-format option\n");
4215 got_output_format_opt
= true;
4217 if (strcmp(arg
, "text") == 0) {
4218 implicit_text_args
.exists
= true;
4219 } else if (strcmp(arg
, "ctf") == 0) {
4220 implicit_ctf_output_args
.exists
= true;
4221 } else if (strcmp(arg
, "dummy") == 0) {
4222 implicit_dummy_args
.exists
= true;
4223 } else if (strcmp(arg
, "ctf-metadata") == 0) {
4224 print_ctf_metadata
= true;
4226 printf_err("Unknown legacy output format:\n %s\n",
4233 printf_err("Duplicate --output option\n");
4237 output
= strdup(arg
);
4244 if (print_run_args_0
) {
4245 printf_err("Cannot specify --run-args and --run-args-0\n");
4249 print_run_args
= true;
4251 case OPT_RUN_ARGS_0
:
4252 if (print_run_args
) {
4253 printf_err("Cannot specify --run-args and --run-args-0\n");
4257 print_run_args_0
= true;
4259 case OPT_STREAM_INTERSECTION
:
4261 * Applies to all traces implementing the trace-info
4264 stream_intersection_mode
= true;
4267 if (*log_level
!= 'V' && *log_level
!= 'D') {
4280 /* Check for option parsing error */
4282 printf_err("While parsing command-line options, at option %s: %s\n",
4283 poptBadOption(pc
, 0), poptStrerror(opt
));
4288 * Legacy behaviour: --verbose used to make the `text` output
4289 * format print more information. --verbose is now equivalent to
4290 * the INFO log level, which is why we compare to 'I' here.
4292 if (*log_level
== 'I') {
4293 append_implicit_component_param(&implicit_text_args
,
4298 * Append home and system plugin paths now that we possibly got
4301 if (append_home_and_system_plugin_paths(plugin_paths
,
4302 force_omit_system_plugin_path
,
4303 force_omit_home_plugin_path
)) {
4307 /* Consume and keep leftover arguments */
4308 while ((leftover
= poptGetArg(pc
))) {
4309 GString
*gs_leftover
= g_string_new(leftover
);
4316 leftovers
= g_list_append(leftovers
, gs_leftover
);
4318 g_string_free(gs_leftover
, TRUE
);
4324 /* Print CTF metadata or print LTTng live sessions */
4325 if (print_ctf_metadata
) {
4326 GString
*gs_leftover
;
4328 if (g_list_length(leftovers
) == 0) {
4329 printf_err("--output-format=ctf-metadata specified without a path\n");
4333 if (g_list_length(leftovers
) > 1) {
4334 printf_err("Too many paths specified for --output-format=ctf-metadata\n");
4338 cfg
= bt_config_print_ctf_metadata_create(plugin_paths
);
4343 gs_leftover
= leftovers
->data
;
4344 g_string_assign(cfg
->cmd_data
.print_ctf_metadata
.path
,
4349 cfg
->cmd_data
.print_ctf_metadata
.output_path
,
4357 * If -o ctf was specified, make sure an output path (--output)
4358 * was also specified. --output does not imply -o ctf because
4359 * it's also used for the default, implicit -o text if -o ctf
4362 if (implicit_ctf_output_args
.exists
) {
4364 printf_err("--output-format=ctf specified without --output (trace output path)\n");
4369 * At this point we know that -o ctf AND --output were
4370 * specified. Make sure that no options were specified
4371 * which would imply -o text because --output would be
4372 * ambiguous in this case. For example, this is wrong:
4374 * babeltrace --names=all -o ctf --output=/tmp/path my-trace
4376 * because --names=all implies -o text, and --output
4377 * could apply to both the sink.text.pretty and
4378 * sink.ctf.fs implicit components.
4380 if (implicit_text_args
.exists
) {
4381 printf_err("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text\n");
4387 * If -o dummy and -o ctf were not specified, and if there are
4388 * no explicit sink components, then use an implicit
4389 * `sink.text.pretty` component.
4391 if (!implicit_dummy_args
.exists
&& !implicit_ctf_output_args
.exists
&&
4393 implicit_text_args
.exists
= true;
4397 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4398 * `path` parameter if --output was specified.
4401 if (implicit_text_args
.exists
) {
4402 append_implicit_component_extra_param(&implicit_text_args
,
4404 } else if (implicit_ctf_output_args
.exists
) {
4405 append_implicit_component_extra_param(&implicit_ctf_output_args
,
4410 /* Decide where the leftover argument(s) go */
4411 if (g_list_length(leftovers
) > 0) {
4412 if (implicit_lttng_live_args
.exists
) {
4413 GString
*gs_leftover
;
4415 if (g_list_length(leftovers
) > 1) {
4416 printf_err("Too many URLs specified for --output-format=lttng-live\n");
4420 gs_leftover
= leftovers
->data
;
4421 lttng_live_url_parts
=
4422 bt_common_parse_lttng_live_url(gs_leftover
->str
,
4423 error_buf
, sizeof(error_buf
));
4424 if (!lttng_live_url_parts
.proto
) {
4425 printf_err("Invalid LTTng live URL format: %s\n",
4430 if (!lttng_live_url_parts
.session_name
) {
4431 /* Print LTTng live sessions */
4432 cfg
= bt_config_print_lttng_live_sessions_create(
4438 g_string_assign(cfg
->cmd_data
.print_lttng_live_sessions
.url
,
4443 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
,
4450 ret
= append_implicit_component_extra_param(
4451 &implicit_lttng_live_args
, "url",
4458 * Append one implicit component argument set
4459 * for each leftover (souce.ctf.fs paths). Copy
4460 * the base implicit component arguments.
4461 * Note that they still have to be named later.
4463 ret
= fill_implicit_ctf_inputs_args(
4464 implicit_ctf_inputs_args
,
4465 &base_implicit_ctf_input_args
, leftovers
);
4473 * Ensure mutual exclusion between implicit `source.ctf.fs` and
4474 * `source.ctf.lttng-live` components.
4476 if (base_implicit_ctf_input_args
.exists
&&
4477 implicit_lttng_live_args
.exists
) {
4478 printf_err("Cannot create both implicit `%s` and `%s` components\n",
4479 base_implicit_ctf_input_args
.comp_arg
->str
,
4480 implicit_lttng_live_args
.comp_arg
->str
);
4485 * If the implicit `source.ctf.fs` or `source.ctf.lttng-live`
4486 * components exists, make sure there's at least one leftover
4487 * (which is the path or URL).
4489 if (base_implicit_ctf_input_args
.exists
&&
4490 g_list_length(leftovers
) == 0) {
4491 printf_err("Missing path for implicit `%s` component\n",
4492 base_implicit_ctf_input_args
.comp_arg
->str
);
4496 if (implicit_lttng_live_args
.exists
&& g_list_length(leftovers
) == 0) {
4497 printf_err("Missing URL for implicit `%s` component\n",
4498 implicit_lttng_live_args
.comp_arg
->str
);
4502 /* Assign names to implicit components */
4503 for (i
= 0; i
< implicit_ctf_inputs_args
->len
; i
++) {
4504 struct implicit_component_args
*impl_args
=
4505 g_ptr_array_index(implicit_ctf_inputs_args
, i
);
4507 ret
= assign_name_to_implicit_component(impl_args
,
4508 "source-ctf-fs", all_names
, &source_names
, true);
4514 ret
= assign_name_to_implicit_component(&implicit_lttng_live_args
,
4515 "lttng-live", all_names
, &source_names
, true);
4520 ret
= assign_name_to_implicit_component(&implicit_text_args
,
4521 "pretty", all_names
, &sink_names
, true);
4526 ret
= assign_name_to_implicit_component(&implicit_ctf_output_args
,
4527 "sink-ctf-fs", all_names
, &sink_names
, true);
4532 ret
= assign_name_to_implicit_component(&implicit_dummy_args
,
4533 "dummy", all_names
, &sink_names
, true);
4538 ret
= assign_name_to_implicit_component(&implicit_muxer_args
,
4539 "muxer", all_names
, NULL
, false);
4544 ret
= assign_name_to_implicit_component(&implicit_trimmer_args
,
4545 "trimmer", all_names
, NULL
, false);
4550 ret
= assign_name_to_implicit_component(&implicit_debug_info_args
,
4551 "debug-info", all_names
, NULL
, false);
4556 /* Make sure there's at least one source and one sink */
4557 if (!source_names
) {
4558 printf_err("No source component\n");
4563 printf_err("No sink component\n");
4568 * Prepend the muxer, the trimmer, and the debug info to the
4569 * filter chain so that we have:
4571 * sources -> muxer -> [trimmer] -> [debug info] ->
4572 * [user filters] -> sinks
4574 if (implicit_debug_info_args
.exists
) {
4575 if (g_list_prepend_gstring(&filter_names
,
4576 implicit_debug_info_args
.name_arg
->str
)) {
4581 if (implicit_trimmer_args
.exists
) {
4582 if (g_list_prepend_gstring(&filter_names
,
4583 implicit_trimmer_args
.name_arg
->str
)) {
4588 if (g_list_prepend_gstring(&filter_names
,
4589 implicit_muxer_args
.name_arg
->str
)) {
4594 * Append the equivalent run arguments for the implicit
4597 for (i
= 0; i
< implicit_ctf_inputs_args
->len
; i
++) {
4598 struct implicit_component_args
*impl_args
=
4599 g_ptr_array_index(implicit_ctf_inputs_args
, i
);
4601 ret
= append_run_args_for_implicit_component(impl_args
,
4608 ret
= append_run_args_for_implicit_component(&implicit_lttng_live_args
,
4614 ret
= append_run_args_for_implicit_component(&implicit_text_args
,
4620 ret
= append_run_args_for_implicit_component(&implicit_ctf_output_args
,
4626 ret
= append_run_args_for_implicit_component(&implicit_dummy_args
,
4632 ret
= append_run_args_for_implicit_component(&implicit_muxer_args
,
4638 ret
= append_run_args_for_implicit_component(&implicit_trimmer_args
,
4644 ret
= append_run_args_for_implicit_component(&implicit_debug_info_args
,
4650 /* Auto-connect components */
4651 ret
= convert_auto_connect(run_args
, source_names
, filter_names
,
4654 printf_err("Cannot auto-connect components\n");
4659 * We have all the run command arguments now. Depending on
4660 * --run-args, we pass this to the run command or print them
4663 if (print_run_args
|| print_run_args_0
) {
4664 if (stream_intersection_mode
) {
4665 printf_err("Cannot specify --stream-intersection with --run-args or --run-args-0\n");
4669 for (i
= 0; i
< bt_value_array_size(run_args
); i
++) {
4670 struct bt_value
*arg_value
=
4671 bt_value_array_get(run_args
, i
);
4673 GString
*quoted
= NULL
;
4674 const char *arg_to_print
;
4676 BT_ASSERT(arg_value
);
4677 ret
= bt_value_string_get(arg_value
, &arg
);
4678 BT_ASSERT(ret
== 0);
4681 if (print_run_args
) {
4682 quoted
= bt_common_shell_quote(arg
, true);
4687 arg_to_print
= quoted
->str
;
4692 printf("%s", arg_to_print
);
4695 g_string_free(quoted
, TRUE
);
4698 if (i
< bt_value_array_size(run_args
) - 1) {
4699 if (print_run_args
) {
4712 cfg
= bt_config_run_from_args_array(run_args
, retcode
,
4713 force_omit_system_plugin_path
, force_omit_home_plugin_path
,
4714 initial_plugin_paths
);
4719 cfg
->cmd_data
.run
.stream_intersection_mode
= stream_intersection_mode
;
4728 poptFreeContext(pc
);
4735 g_string_free(cur_name
, TRUE
);
4738 if (cur_name_prefix
) {
4739 g_string_free(cur_name_prefix
, TRUE
);
4742 if (implicit_ctf_inputs_args
) {
4743 g_ptr_array_free(implicit_ctf_inputs_args
, TRUE
);
4748 destroy_glist_of_gstring(source_names
);
4749 destroy_glist_of_gstring(filter_names
);
4750 destroy_glist_of_gstring(sink_names
);
4751 destroy_glist_of_gstring(leftovers
);
4752 finalize_implicit_component_args(&base_implicit_ctf_input_args
);
4753 finalize_implicit_component_args(&implicit_ctf_output_args
);
4754 finalize_implicit_component_args(&implicit_lttng_live_args
);
4755 finalize_implicit_component_args(&implicit_dummy_args
);
4756 finalize_implicit_component_args(&implicit_text_args
);
4757 finalize_implicit_component_args(&implicit_debug_info_args
);
4758 finalize_implicit_component_args(&implicit_muxer_args
);
4759 finalize_implicit_component_args(&implicit_trimmer_args
);
4760 bt_put(plugin_paths
);
4761 bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts
);
4766 * Prints the Babeltrace 2.x general usage.
4769 void print_gen_usage(FILE *fp
)
4771 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4773 fprintf(fp
, "General options:\n");
4775 fprintf(fp
, " -d, --debug Enable debug mode (same as --log-level=V)\n");
4776 fprintf(fp
, " -h, --help Show this help and quit\n");
4777 fprintf(fp
, " --log-level=LVL Set all log levels to LVL (`N`, `V`, `D`,\n");
4778 fprintf(fp
, " `I`, `W` (default), `E`, or `F`)\n");
4779 fprintf(fp
, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4780 fprintf(fp
, " -V, --version Show version and quit\n");
4782 fprintf(fp
, "Available commands:\n");
4784 fprintf(fp
, " convert Convert and trim traces (default)\n");
4785 fprintf(fp
, " help Get help for a plugin or a component class\n");
4786 fprintf(fp
, " list-plugins List available plugins and their content\n");
4787 fprintf(fp
, " query Query objects from a component class\n");
4788 fprintf(fp
, " run Build a processing graph and run it\n");
4790 fprintf(fp
, "Use `babeltrace COMMAND --help` to show the help of COMMAND.\n");
4794 char log_level_from_arg(const char *arg
)
4798 if (strcmp(arg
, "VERBOSE") == 0 ||
4799 strcmp(arg
, "V") == 0) {
4801 } else if (strcmp(arg
, "DEBUG") == 0 ||
4802 strcmp(arg
, "D") == 0) {
4804 } else if (strcmp(arg
, "INFO") == 0 ||
4805 strcmp(arg
, "I") == 0) {
4807 } else if (strcmp(arg
, "WARN") == 0 ||
4808 strcmp(arg
, "WARNING") == 0 ||
4809 strcmp(arg
, "W") == 0) {
4811 } else if (strcmp(arg
, "ERROR") == 0 ||
4812 strcmp(arg
, "E") == 0) {
4814 } else if (strcmp(arg
, "FATAL") == 0 ||
4815 strcmp(arg
, "F") == 0) {
4817 } else if (strcmp(arg
, "NONE") == 0 ||
4818 strcmp(arg
, "N") == 0) {
4825 struct bt_config
*bt_config_cli_args_create(int argc
, const char *argv
[],
4826 int *retcode
, bool force_omit_system_plugin_path
,
4827 bool force_omit_home_plugin_path
,
4828 struct bt_value
*initial_plugin_paths
)
4830 struct bt_config
*config
= NULL
;
4832 const char **command_argv
= NULL
;
4833 int command_argc
= -1;
4834 const char *command_name
= NULL
;
4835 char log_level
= 'U';
4838 COMMAND_TYPE_NONE
= -1,
4839 COMMAND_TYPE_RUN
= 0,
4840 COMMAND_TYPE_CONVERT
,
4841 COMMAND_TYPE_LIST_PLUGINS
,
4844 } command_type
= COMMAND_TYPE_NONE
;
4848 if (!initial_plugin_paths
) {
4849 initial_plugin_paths
= bt_value_array_create();
4850 if (!initial_plugin_paths
) {
4855 bt_get(initial_plugin_paths
);
4861 print_gen_usage(stdout
);
4865 for (i
= 1; i
< argc
; i
++) {
4866 const char *cur_arg
= argv
[i
];
4867 const char *next_arg
= i
== (argc
- 1) ? NULL
: argv
[i
+ 1];
4869 if (strcmp(cur_arg
, "-d") == 0 ||
4870 strcmp(cur_arg
, "--debug") == 0) {
4872 } else if (strcmp(cur_arg
, "-v") == 0 ||
4873 strcmp(cur_arg
, "--verbose") == 0) {
4874 if (log_level
!= 'V' && log_level
!= 'D') {
4876 * Legacy: do not override a previous
4877 * --debug because --verbose and --debug
4878 * can be specified together (in this
4879 * case we want the lowest log level to
4884 } else if (strcmp(cur_arg
, "--log-level") == 0) {
4886 printf_err("Missing log level value for --log-level option\n");
4891 log_level
= log_level_from_arg(next_arg
);
4892 if (log_level
== 'U') {
4893 printf_err("Invalid argument for --log-level option:\n %s\n",
4900 } else if (strncmp(cur_arg
, "--log-level=", 12) == 0) {
4901 const char *arg
= &cur_arg
[12];
4903 log_level
= log_level_from_arg(arg
);
4904 if (log_level
== 'U') {
4905 printf_err("Invalid argument for --log-level option:\n %s\n",
4910 } else if (strcmp(cur_arg
, "-V") == 0 ||
4911 strcmp(cur_arg
, "--version") == 0) {
4914 } else if (strcmp(cur_arg
, "-h") == 0 ||
4915 strcmp(cur_arg
, "--help") == 0) {
4916 print_gen_usage(stdout
);
4920 * First unknown argument: is it a known command
4923 command_argv
= &argv
[i
];
4924 command_argc
= argc
- i
;
4926 if (strcmp(cur_arg
, "convert") == 0) {
4927 command_type
= COMMAND_TYPE_CONVERT
;
4928 } else if (strcmp(cur_arg
, "list-plugins") == 0) {
4929 command_type
= COMMAND_TYPE_LIST_PLUGINS
;
4930 } else if (strcmp(cur_arg
, "help") == 0) {
4931 command_type
= COMMAND_TYPE_HELP
;
4932 } else if (strcmp(cur_arg
, "query") == 0) {
4933 command_type
= COMMAND_TYPE_QUERY
;
4934 } else if (strcmp(cur_arg
, "run") == 0) {
4935 command_type
= COMMAND_TYPE_RUN
;
4938 * Unknown argument, but not a known
4939 * command name: assume the default
4940 * `convert` command.
4942 command_type
= COMMAND_TYPE_CONVERT
;
4943 command_name
= "convert";
4944 command_argv
= &argv
[i
- 1];
4945 command_argc
= argc
- i
+ 1;
4951 if (command_type
== COMMAND_TYPE_NONE
) {
4953 * We only got non-help, non-version general options
4954 * like --verbose and --debug, without any other
4955 * arguments, so we can't do anything useful: print the
4958 print_gen_usage(stdout
);
4962 BT_ASSERT(command_argv
);
4963 BT_ASSERT(command_argc
>= 0);
4965 switch (command_type
) {
4966 case COMMAND_TYPE_RUN
:
4967 config
= bt_config_run_from_args(command_argc
, command_argv
,
4968 retcode
, force_omit_system_plugin_path
,
4969 force_omit_home_plugin_path
, initial_plugin_paths
);
4971 case COMMAND_TYPE_CONVERT
:
4972 config
= bt_config_convert_from_args(command_argc
, command_argv
,
4973 retcode
, force_omit_system_plugin_path
,
4974 force_omit_home_plugin_path
,
4975 initial_plugin_paths
, &log_level
);
4977 case COMMAND_TYPE_LIST_PLUGINS
:
4978 config
= bt_config_list_plugins_from_args(command_argc
,
4979 command_argv
, retcode
, force_omit_system_plugin_path
,
4980 force_omit_home_plugin_path
, initial_plugin_paths
);
4982 case COMMAND_TYPE_HELP
:
4983 config
= bt_config_help_from_args(command_argc
,
4984 command_argv
, retcode
, force_omit_system_plugin_path
,
4985 force_omit_home_plugin_path
, initial_plugin_paths
);
4987 case COMMAND_TYPE_QUERY
:
4988 config
= bt_config_query_from_args(command_argc
,
4989 command_argv
, retcode
, force_omit_system_plugin_path
,
4990 force_omit_home_plugin_path
, initial_plugin_paths
);
4997 if (log_level
== 'U') {
5001 config
->log_level
= log_level
;
5002 config
->command_name
= command_name
;
5006 bt_put(initial_plugin_paths
);