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
32 #include <babeltrace/babeltrace.h>
33 #include <babeltrace/common-internal.h>
34 #include <babeltrace/values.h>
37 #include <sys/types.h>
39 #include "babeltrace-cfg.h"
41 #define DEFAULT_SOURCE_COMPONENT_NAME "ctf.fs"
42 #define DEFAULT_SINK_COMPONENT_NAME "text.text"
45 * Error printf() macro which prepends "Error: " the first time it's
46 * called. This gives a nicer feel than having a bunch of error prefixes
47 * (since the following lines usually describe the error and possible
48 * solutions), or the error prefix just at the end.
50 #define printf_err(fmt, args...) \
52 if (is_first_error) { \
53 fprintf(stderr, "Error: "); \
54 is_first_error = false; \
56 fprintf(stderr, fmt, ##args); \
59 static bool is_first_error
= true;
61 /* INI-style parsing FSM states */
62 enum ini_parsing_fsm_state
{
63 /* Expect a map key (identifier) */
66 /* Expect an equal character ('=') */
72 /* Expect a negative number value */
73 INI_EXPECT_VALUE_NUMBER_NEG
,
75 /* Expect a comma character (',') */
79 /* INI-style parsing state variables */
80 struct ini_parsing_state
{
81 /* Lexical scanner (owned by this) */
84 /* Output map value object being filled (owned by this) */
85 struct bt_value
*params
;
87 /* Next expected FSM state */
88 enum ini_parsing_fsm_state expecting
;
90 /* Last decoded map key (owned by this) */
93 /* Complete INI-style string to parse (not owned by this) */
96 /* Error buffer (not owned by this) */
100 /* Offset option with "is set" boolean */
106 /* Legacy "ctf"/"lttng-live" format options */
107 struct ctf_legacy_opts
{
108 struct offset_opt offset_s
;
109 struct offset_opt offset_ns
;
110 bool stream_intersection
;
113 /* Legacy "text" format options */
114 struct text_legacy_opts
{
116 * output, dbg_info_dir, dbg_info_target_prefix, names,
117 * and fields are owned by this.
120 GString
*dbg_info_dir
;
121 GString
*dbg_info_target_prefix
;
122 struct bt_value
*names
;
123 struct bt_value
*fields
;
131 bool dbg_info_full_path
;
134 /* Legacy input format format */
135 enum legacy_input_format
{
136 LEGACY_INPUT_FORMAT_NONE
= 0,
137 LEGACY_INPUT_FORMAT_CTF
,
138 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
141 /* Legacy output format format */
142 enum legacy_output_format
{
143 LEGACY_OUTPUT_FORMAT_NONE
= 0,
144 LEGACY_OUTPUT_FORMAT_TEXT
,
145 LEGACY_OUTPUT_FORMAT_CTF_METADATA
,
146 LEGACY_OUTPUT_FORMAT_DUMMY
,
150 * Prints the "out of memory" error.
153 void print_err_oom(void)
155 printf_err("Out of memory\n");
159 * Prints duplicate legacy output format error.
162 void print_err_dup_legacy_output(void)
164 printf_err("More than one legacy output format specified\n");
168 * Prints duplicate legacy input format error.
171 void print_err_dup_legacy_input(void)
173 printf_err("More than one legacy input format specified\n");
177 * Checks if any of the "text" legacy options is set.
180 bool text_legacy_opts_is_any_set(struct text_legacy_opts
*opts
)
182 return (opts
->output
&& opts
->output
->len
> 0) ||
183 (opts
->dbg_info_dir
&& opts
->dbg_info_dir
->len
> 0) ||
184 (opts
->dbg_info_target_prefix
&&
185 opts
->dbg_info_target_prefix
->len
> 0) ||
186 bt_value_array_size(opts
->names
) > 0 ||
187 bt_value_array_size(opts
->fields
) > 0 ||
188 opts
->no_delta
|| opts
->clock_cycles
|| opts
->clock_seconds
||
189 opts
->clock_date
|| opts
->clock_gmt
||
190 opts
->dbg_info_full_path
;
194 * Checks if any of the "ctf" legacy options is set.
197 bool ctf_legacy_opts_is_any_set(struct ctf_legacy_opts
*opts
)
199 return opts
->offset_s
.is_set
|| opts
->offset_ns
.is_set
||
200 opts
->stream_intersection
;
204 * Appends an "expecting token" error to the INI-style parsing state's
208 void ini_append_error_expecting(struct ini_parsing_state
*state
,
209 GScanner
*scanner
, const char *expecting
)
214 g_string_append_printf(state
->ini_error
, "Expecting %s:\n", expecting
);
216 /* Only print error if there's one line */
217 if (strchr(state
->arg
, '\n') != NULL
|| strlen(state
->arg
) == 0) {
221 g_string_append_printf(state
->ini_error
, "\n %s\n", state
->arg
);
222 pos
= g_scanner_cur_position(scanner
) + 4;
224 if (!g_scanner_eof(scanner
)) {
228 for (i
= 0; i
< pos
; ++i
) {
229 g_string_append_printf(state
->ini_error
, " ");
232 g_string_append_printf(state
->ini_error
, "^\n\n");
236 int ini_handle_state(struct ini_parsing_state
*state
)
239 GTokenType token_type
;
240 struct bt_value
*value
= NULL
;
242 token_type
= g_scanner_get_next_token(state
->scanner
);
243 if (token_type
== G_TOKEN_EOF
) {
244 if (state
->expecting
!= INI_EXPECT_COMMA
) {
245 switch (state
->expecting
) {
246 case INI_EXPECT_EQUAL
:
247 ini_append_error_expecting(state
,
248 state
->scanner
, "'='");
250 case INI_EXPECT_VALUE
:
251 case INI_EXPECT_VALUE_NUMBER_NEG
:
252 ini_append_error_expecting(state
,
253 state
->scanner
, "value");
255 case INI_EXPECT_MAP_KEY
:
256 ini_append_error_expecting(state
,
257 state
->scanner
, "unquoted map key");
270 switch (state
->expecting
) {
271 case INI_EXPECT_MAP_KEY
:
272 if (token_type
!= G_TOKEN_IDENTIFIER
) {
273 ini_append_error_expecting(state
, state
->scanner
,
278 free(state
->last_map_key
);
279 state
->last_map_key
=
280 strdup(state
->scanner
->value
.v_identifier
);
281 if (!state
->last_map_key
) {
282 g_string_append(state
->ini_error
,
287 if (bt_value_map_has_key(state
->params
, state
->last_map_key
)) {
288 g_string_append_printf(state
->ini_error
,
289 "Duplicate parameter key: `%s`\n",
290 state
->last_map_key
);
294 state
->expecting
= INI_EXPECT_EQUAL
;
296 case INI_EXPECT_EQUAL
:
297 if (token_type
!= G_TOKEN_CHAR
) {
298 ini_append_error_expecting(state
,
299 state
->scanner
, "'='");
303 if (state
->scanner
->value
.v_char
!= '=') {
304 ini_append_error_expecting(state
,
305 state
->scanner
, "'='");
309 state
->expecting
= INI_EXPECT_VALUE
;
311 case INI_EXPECT_VALUE
:
313 switch (token_type
) {
315 if (state
->scanner
->value
.v_char
== '-') {
316 /* Negative number */
318 INI_EXPECT_VALUE_NUMBER_NEG
;
321 ini_append_error_expecting(state
,
322 state
->scanner
, "value");
328 /* Positive integer */
329 uint64_t int_val
= state
->scanner
->value
.v_int64
;
331 if (int_val
> (1ULL << 63) - 1) {
332 g_string_append_printf(state
->ini_error
,
333 "Integer value %" PRIu64
" is outside the range of a 64-bit signed integer\n",
338 value
= bt_value_integer_create_init(
343 /* Positive floating point number */
344 value
= bt_value_float_create_init(
345 state
->scanner
->value
.v_float
);
349 value
= bt_value_string_create_init(
350 state
->scanner
->value
.v_string
);
352 case G_TOKEN_IDENTIFIER
:
355 * Using symbols would be appropriate here,
356 * but said symbols are allowed as map key,
357 * so it's easier to consider everything an
360 * If one of the known symbols is not
361 * recognized here, then fall back to creating
364 const char *id
= state
->scanner
->value
.v_identifier
;
366 if (!strcmp(id
, "null") || !strcmp(id
, "NULL") ||
367 !strcmp(id
, "nul")) {
368 value
= bt_value_null
;
369 } else if (!strcmp(id
, "true") || !strcmp(id
, "TRUE") ||
370 !strcmp(id
, "yes") ||
371 !strcmp(id
, "YES")) {
372 value
= bt_value_bool_create_init(true);
373 } else if (!strcmp(id
, "false") ||
374 !strcmp(id
, "FALSE") ||
377 value
= bt_value_bool_create_init(false);
379 value
= bt_value_string_create_init(id
);
384 /* Unset value variable will trigger the error */
389 ini_append_error_expecting(state
,
390 state
->scanner
, "value");
394 state
->expecting
= INI_EXPECT_COMMA
;
397 case INI_EXPECT_VALUE_NUMBER_NEG
:
399 switch (token_type
) {
402 /* Negative integer */
403 uint64_t int_val
= state
->scanner
->value
.v_int64
;
405 if (int_val
> (1ULL << 63) - 1) {
406 g_string_append_printf(state
->ini_error
,
407 "Integer value -%" PRIu64
" is outside the range of a 64-bit signed integer\n",
412 value
= bt_value_integer_create_init(
413 -((int64_t) int_val
));
417 /* Negative floating point number */
418 value
= bt_value_float_create_init(
419 -state
->scanner
->value
.v_float
);
422 /* Unset value variable will trigger the error */
427 ini_append_error_expecting(state
,
428 state
->scanner
, "value");
432 state
->expecting
= INI_EXPECT_COMMA
;
435 case INI_EXPECT_COMMA
:
436 if (token_type
!= G_TOKEN_CHAR
) {
437 ini_append_error_expecting(state
,
438 state
->scanner
, "','");
442 if (state
->scanner
->value
.v_char
!= ',') {
443 ini_append_error_expecting(state
,
444 state
->scanner
, "','");
448 state
->expecting
= INI_EXPECT_MAP_KEY
;
460 if (bt_value_map_insert(state
->params
,
461 state
->last_map_key
, value
)) {
462 /* Only override return value on error */
473 * Converts an INI-style argument to an equivalent map value object.
475 * Return value is owned by the caller.
478 struct bt_value
*bt_value_from_ini(const char *arg
, GString
*ini_error
)
480 /* Lexical scanner configuration */
481 GScannerConfig scanner_config
= {
482 /* Skip whitespaces */
483 .cset_skip_characters
= " \t\n",
485 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
486 .cset_identifier_first
=
490 .cset_identifier_nth
=
495 /* "hello" and "Hello" two different keys */
496 .case_sensitive
= TRUE
,
499 .cpair_comment_single
= NULL
,
500 .skip_comment_multi
= TRUE
,
501 .skip_comment_single
= TRUE
,
502 .scan_comment_multi
= FALSE
,
505 * Do scan identifiers, including 1-char identifiers,
506 * but NULL is a normal identifier.
508 .scan_identifier
= TRUE
,
509 .scan_identifier_1char
= TRUE
,
510 .scan_identifier_NULL
= FALSE
,
513 * No specific symbols: null and boolean "symbols" are
514 * scanned as plain identifiers.
516 .scan_symbols
= FALSE
,
517 .symbol_2_token
= FALSE
,
518 .scope_0_fallback
= FALSE
,
521 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
522 * integers prefixed with "$".
528 .scan_hex_dollar
= FALSE
,
530 /* Convert scanned numbers to integer tokens */
531 .numbers_2_int
= TRUE
,
533 /* Support both integers and floating-point numbers */
534 .int_2_float
= FALSE
,
536 /* Scan integers as 64-bit signed integers */
539 /* Only scan double-quoted strings */
540 .scan_string_sq
= FALSE
,
541 .scan_string_dq
= TRUE
,
543 /* Do not converter identifiers to string tokens */
544 .identifier_2_string
= FALSE
,
546 /* Scan characters as G_TOKEN_CHAR token */
547 .char_2_token
= FALSE
,
549 struct ini_parsing_state state
= {
552 .expecting
= INI_EXPECT_MAP_KEY
,
554 .ini_error
= ini_error
,
557 state
.params
= bt_value_map_create();
562 state
.scanner
= g_scanner_new(&scanner_config
);
563 if (!state
.scanner
) {
567 /* Let the scan begin */
568 g_scanner_input_text(state
.scanner
, arg
, strlen(arg
));
571 int ret
= ini_handle_state(&state
);
576 } else if (ret
> 0) {
585 BT_PUT(state
.params
);
589 g_scanner_destroy(state
.scanner
);
592 free(state
.last_map_key
);
597 * Returns the parameters map value object from a command-line
598 * parameter option's argument.
600 * Return value is owned by the caller.
603 struct bt_value
*bt_value_from_arg(const char *arg
)
605 struct bt_value
*params
= NULL
;
606 GString
*ini_error
= NULL
;
608 ini_error
= g_string_new(NULL
);
614 /* Try INI-style parsing */
615 params
= bt_value_from_ini(arg
, ini_error
);
617 printf_err("%s", ini_error
->str
);
623 g_string_free(ini_error
, TRUE
);
629 * Returns the plugin and component names from a command-line
630 * source/sink option's argument. arg must have the following format:
634 * where PLUGIN is the plugin name, and COMPONENT is the component
637 * On success, both *plugin and *component are not NULL. *plugin
638 * and *component are owned by the caller.
641 void plugin_component_names_from_arg(const char *arg
, char **plugin
,
647 size_t component_len
;
649 /* Initialize both return values to NULL: not found */
653 dot
= strchr(arg
, '.');
659 end
= arg
+ strlen(arg
);
660 plugin_len
= dot
- arg
;
661 component_len
= end
- dot
- 1;
662 if (plugin_len
== 0 || component_len
== 0) {
666 *plugin
= g_malloc0(plugin_len
+ 1);
672 g_strlcpy(*plugin
, arg
, plugin_len
+ 1);
673 *component
= g_malloc0(component_len
+ 1);
679 g_strlcpy(*component
, dot
+ 1, component_len
+ 1);
686 * Prints the Babeltrace version.
689 void print_version(void)
691 puts("Babeltrace " VERSION
);
695 * Destroys a component configuration.
698 void bt_config_component_destroy(struct bt_object
*obj
)
700 struct bt_config_component
*bt_config_component
=
701 container_of(obj
, struct bt_config_component
, base
);
707 if (bt_config_component
->plugin_name
) {
708 g_string_free(bt_config_component
->plugin_name
, TRUE
);
711 if (bt_config_component
->component_name
) {
712 g_string_free(bt_config_component
->component_name
, TRUE
);
715 if (bt_config_component
->instance_name
) {
716 g_string_free(bt_config_component
->instance_name
, TRUE
);
719 BT_PUT(bt_config_component
->params
);
720 g_free(bt_config_component
);
727 * Creates a component configuration using the given plugin name and
728 * component name. plugin_name and component_name are copied (belong to
731 * Return value is owned by the caller.
734 struct bt_config_component
*bt_config_component_create(const char *plugin_name
,
735 const char *component_name
)
737 struct bt_config_component
*cfg_component
= NULL
;
739 cfg_component
= g_new0(struct bt_config_component
, 1);
740 if (!cfg_component
) {
745 bt_object_init(cfg_component
, bt_config_component_destroy
);
746 cfg_component
->plugin_name
= g_string_new(plugin_name
);
747 if (!cfg_component
->plugin_name
) {
752 cfg_component
->component_name
= g_string_new(component_name
);
753 if (!cfg_component
->component_name
) {
758 cfg_component
->instance_name
= g_string_new(NULL
);
759 if (!cfg_component
->instance_name
) {
764 /* Start with empty parameters */
765 cfg_component
->params
= bt_value_map_create();
766 if (!cfg_component
->params
) {
774 BT_PUT(cfg_component
);
777 return cfg_component
;
781 * Creates a component configuration from a command-line source/sink
785 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
787 struct bt_config_component
*bt_config_component
= NULL
;
789 char *component_name
;
791 plugin_component_names_from_arg(arg
, &plugin_name
, &component_name
);
792 if (!plugin_name
|| !component_name
) {
793 printf_err("Cannot get plugin or component class name\n");
797 bt_config_component
= bt_config_component_create(plugin_name
,
799 if (!bt_config_component
) {
806 BT_PUT(bt_config_component
);
810 g_free(component_name
);
811 return bt_config_component
;
815 * Destroys a configuration.
818 void bt_config_destroy(struct bt_object
*obj
)
820 struct bt_config
*cfg
=
821 container_of(obj
, struct bt_config
, base
);
827 switch (cfg
->command
) {
828 case BT_CONFIG_COMMAND_CONVERT
:
829 if (cfg
->cmd_data
.convert
.sources
) {
830 g_ptr_array_free(cfg
->cmd_data
.convert
.sources
, TRUE
);
833 if (cfg
->cmd_data
.convert
.sinks
) {
834 g_ptr_array_free(cfg
->cmd_data
.convert
.sinks
, TRUE
);
837 BT_PUT(cfg
->cmd_data
.convert
.plugin_paths
);
839 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
840 BT_PUT(cfg
->cmd_data
.list_plugins
.plugin_paths
);
842 case BT_CONFIG_COMMAND_HELP
:
843 BT_PUT(cfg
->cmd_data
.help
.plugin_paths
);
845 if (cfg
->cmd_data
.help
.plugin_name
) {
846 g_string_free(cfg
->cmd_data
.help
.plugin_name
, TRUE
);
849 if (cfg
->cmd_data
.help
.component_name
) {
850 g_string_free(cfg
->cmd_data
.help
.component_name
, TRUE
);
863 static void destroy_gstring(void *data
)
865 g_string_free(data
, TRUE
);
869 * Extracts the various paths from the string arg, delimited by ':',
870 * and appends them to the array value object plugin_paths.
872 enum bt_value_status
bt_config_append_plugin_paths(
873 struct bt_value
*plugin_paths
, const char *arg
)
875 enum bt_value_status status
= BT_VALUE_STATUS_OK
;
876 GPtrArray
*dirs
= g_ptr_array_new_with_free_func(destroy_gstring
);
881 status
= BT_VALUE_STATUS_ERROR
;
885 ret
= bt_common_append_plugin_path_dirs(arg
, dirs
);
887 status
= BT_VALUE_STATUS_ERROR
;
891 for (i
= 0; i
< dirs
->len
; i
++) {
892 GString
*dir
= g_ptr_array_index(dirs
, i
);
894 bt_value_array_append_string(plugin_paths
, dir
->str
);
898 g_ptr_array_free(dirs
, TRUE
);
903 * Creates a simple lexical scanner for parsing comma-delimited names
906 * Return value is owned by the caller.
909 GScanner
*create_csv_identifiers_scanner(void)
911 GScannerConfig scanner_config
= {
912 .cset_skip_characters
= " \t\n",
913 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
914 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
915 .case_sensitive
= TRUE
,
916 .cpair_comment_single
= NULL
,
917 .skip_comment_multi
= TRUE
,
918 .skip_comment_single
= TRUE
,
919 .scan_comment_multi
= FALSE
,
920 .scan_identifier
= TRUE
,
921 .scan_identifier_1char
= TRUE
,
922 .scan_identifier_NULL
= FALSE
,
923 .scan_symbols
= FALSE
,
924 .symbol_2_token
= FALSE
,
925 .scope_0_fallback
= FALSE
,
926 .scan_binary
= FALSE
,
930 .scan_hex_dollar
= FALSE
,
931 .numbers_2_int
= FALSE
,
932 .int_2_float
= FALSE
,
933 .store_int64
= FALSE
,
934 .scan_string_sq
= FALSE
,
935 .scan_string_dq
= FALSE
,
936 .identifier_2_string
= FALSE
,
937 .char_2_token
= TRUE
,
940 return g_scanner_new(&scanner_config
);
944 * Inserts a string (if exists and not empty) or null to a map value
948 enum bt_value_status
map_insert_string_or_null(struct bt_value
*map
,
949 const char *key
, GString
*string
)
951 enum bt_value_status ret
;
953 if (string
&& string
->len
> 0) {
954 ret
= bt_value_map_insert_string(map
, key
, string
->str
);
956 ret
= bt_value_map_insert(map
, key
, bt_value_null
);
962 * Converts a comma-delimited list of known names (--names option) to
963 * an array value object containing those names as string value objects.
965 * Return value is owned by the caller.
968 struct bt_value
*names_from_arg(const char *arg
)
970 GScanner
*scanner
= NULL
;
971 struct bt_value
*names
= NULL
;
972 bool found_all
= false, found_none
= false, found_item
= false;
974 names
= bt_value_array_create();
980 scanner
= create_csv_identifiers_scanner();
986 g_scanner_input_text(scanner
, arg
, strlen(arg
));
989 GTokenType token_type
= g_scanner_get_next_token(scanner
);
991 switch (token_type
) {
992 case G_TOKEN_IDENTIFIER
:
994 const char *identifier
= scanner
->value
.v_identifier
;
996 if (!strcmp(identifier
, "payload") ||
997 !strcmp(identifier
, "args") ||
998 !strcmp(identifier
, "arg")) {
1000 if (bt_value_array_append_string(names
,
1004 } else if (!strcmp(identifier
, "context") ||
1005 !strcmp(identifier
, "ctx")) {
1007 if (bt_value_array_append_string(names
,
1011 } else if (!strcmp(identifier
, "scope") ||
1012 !strcmp(identifier
, "header")) {
1014 if (bt_value_array_append_string(names
,
1018 } else if (!strcmp(identifier
, "all")) {
1020 if (bt_value_array_append_string(names
,
1024 } else if (!strcmp(identifier
, "none")) {
1026 if (bt_value_array_append_string(names
,
1031 printf_err("Unknown field name: `%s`\n",
1047 if (found_none
&& found_all
) {
1048 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1052 * Legacy behavior is to clear the defaults (show none) when at
1053 * least one item is specified.
1055 if (found_item
&& !found_none
&& !found_all
) {
1056 if (bt_value_array_append_string(names
, "none")) {
1061 g_scanner_destroy(scanner
);
1068 g_scanner_destroy(scanner
);
1075 * Converts a comma-delimited list of known fields (--fields option) to
1076 * an array value object containing those fields as string
1079 * Return value is owned by the caller.
1082 struct bt_value
*fields_from_arg(const char *arg
)
1084 GScanner
*scanner
= NULL
;
1085 struct bt_value
*fields
;
1087 fields
= bt_value_array_create();
1093 scanner
= create_csv_identifiers_scanner();
1099 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1102 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1104 switch (token_type
) {
1105 case G_TOKEN_IDENTIFIER
:
1107 const char *identifier
= scanner
->value
.v_identifier
;
1109 if (!strcmp(identifier
, "trace") ||
1110 !strcmp(identifier
, "trace:hostname") ||
1111 !strcmp(identifier
, "trace:domain") ||
1112 !strcmp(identifier
, "trace:procname") ||
1113 !strcmp(identifier
, "trace:vpid") ||
1114 !strcmp(identifier
, "loglevel") ||
1115 !strcmp(identifier
, "emf") ||
1116 !strcmp(identifier
, "callsite") ||
1117 !strcmp(identifier
, "all")) {
1118 if (bt_value_array_append_string(fields
,
1123 printf_err("Unknown field name: `%s`\n",
1145 g_scanner_destroy(scanner
);
1151 * Inserts the equivalent "prefix-name" true boolean value objects into
1152 * map_obj where the names are in array_obj.
1155 int insert_flat_names_fields_from_array(struct bt_value
*map_obj
,
1156 struct bt_value
*array_obj
, const char *prefix
)
1160 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1163 * array_obj may be NULL if no CLI options were specified to
1164 * trigger its creation.
1170 tmpstr
= g_string_new(NULL
);
1177 default_value
= g_string_new(NULL
);
1178 if (!default_value
) {
1184 for (i
= 0; i
< bt_value_array_size(array_obj
); i
++) {
1185 struct bt_value
*str_obj
= bt_value_array_get(array_obj
, i
);
1187 bool is_default
= false;
1190 printf_err("Unexpected error\n");
1195 ret
= bt_value_string_get(str_obj
, &suffix
);
1198 printf_err("Unexpected error\n");
1202 g_string_assign(tmpstr
, prefix
);
1203 g_string_append(tmpstr
, "-");
1205 /* Special-case for "all" and "none". */
1206 if (!strcmp(suffix
, "all")) {
1208 g_string_assign(default_value
, "show");
1209 } else if (!strcmp(suffix
, "none")) {
1211 g_string_assign(default_value
, "hide");
1214 g_string_append(tmpstr
, "default");
1215 ret
= map_insert_string_or_null(map_obj
,
1223 g_string_append(tmpstr
, suffix
);
1224 ret
= bt_value_map_insert_bool(map_obj
, tmpstr
->str
,
1234 if (default_value
) {
1235 g_string_free(default_value
, TRUE
);
1238 g_string_free(tmpstr
, TRUE
);
1245 * Returns the parameters (map value object) corresponding to the
1246 * legacy text format options.
1248 * Return value is owned by the caller.
1251 struct bt_value
*params_from_text_legacy_opts(
1252 struct text_legacy_opts
*text_legacy_opts
)
1254 struct bt_value
*params
;
1256 params
= bt_value_map_create();
1262 if (map_insert_string_or_null(params
, "output-path",
1263 text_legacy_opts
->output
)) {
1268 if (map_insert_string_or_null(params
, "debug-info-dir",
1269 text_legacy_opts
->dbg_info_dir
)) {
1274 if (map_insert_string_or_null(params
, "debug-info-target-prefix",
1275 text_legacy_opts
->dbg_info_target_prefix
)) {
1280 if (bt_value_map_insert_bool(params
, "debug-info-full-path",
1281 text_legacy_opts
->dbg_info_full_path
)) {
1286 if (bt_value_map_insert_bool(params
, "no-delta",
1287 text_legacy_opts
->no_delta
)) {
1292 if (bt_value_map_insert_bool(params
, "clock-cycles",
1293 text_legacy_opts
->clock_cycles
)) {
1298 if (bt_value_map_insert_bool(params
, "clock-seconds",
1299 text_legacy_opts
->clock_seconds
)) {
1304 if (bt_value_map_insert_bool(params
, "clock-date",
1305 text_legacy_opts
->clock_date
)) {
1310 if (bt_value_map_insert_bool(params
, "clock-gmt",
1311 text_legacy_opts
->clock_gmt
)) {
1316 if (insert_flat_names_fields_from_array(params
,
1317 text_legacy_opts
->names
, "name")) {
1321 if (insert_flat_names_fields_from_array(params
,
1322 text_legacy_opts
->fields
, "field")) {
1336 int append_sinks_from_legacy_opts(GPtrArray
*sinks
,
1337 enum legacy_output_format legacy_output_format
,
1338 struct text_legacy_opts
*text_legacy_opts
)
1341 struct bt_value
*params
= NULL
;
1342 const char *plugin_name
;
1343 const char *component_name
;
1344 struct bt_config_component
*bt_config_component
= NULL
;
1346 switch (legacy_output_format
) {
1347 case LEGACY_OUTPUT_FORMAT_TEXT
:
1348 plugin_name
= "text";
1349 component_name
= "text";
1351 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1352 plugin_name
= "ctf";
1353 component_name
= "metadata-text";
1355 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1356 plugin_name
= "dummy";
1357 component_name
= "dummy";
1364 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
) {
1365 /* Legacy "text" output format has parameters */
1366 params
= params_from_text_legacy_opts(text_legacy_opts
);
1372 * Legacy "dummy" and "ctf-metadata" output formats do
1373 * not have parameters.
1375 params
= bt_value_map_create();
1382 /* Create a component configuration */
1383 bt_config_component
= bt_config_component_create(plugin_name
,
1385 if (!bt_config_component
) {
1389 BT_MOVE(bt_config_component
->params
, params
);
1391 /* Move created component configuration to the array */
1392 g_ptr_array_add(sinks
, bt_config_component
);
1406 * Returns the parameters (map value object) corresponding to the
1407 * given legacy CTF format options.
1409 * Return value is owned by the caller.
1412 struct bt_value
*params_from_ctf_legacy_opts(
1413 struct ctf_legacy_opts
*ctf_legacy_opts
)
1415 struct bt_value
*params
;
1417 params
= bt_value_map_create();
1423 if (bt_value_map_insert_integer(params
, "offset-s",
1424 ctf_legacy_opts
->offset_s
.value
)) {
1429 if (bt_value_map_insert_integer(params
, "offset-ns",
1430 ctf_legacy_opts
->offset_ns
.value
)) {
1435 if (bt_value_map_insert_bool(params
, "stream-intersection",
1436 ctf_legacy_opts
->stream_intersection
)) {
1451 int append_sources_from_legacy_opts(GPtrArray
*sources
,
1452 enum legacy_input_format legacy_input_format
,
1453 struct ctf_legacy_opts
*ctf_legacy_opts
,
1454 struct bt_value
*legacy_input_paths
)
1458 struct bt_value
*base_params
;
1459 struct bt_value
*params
= NULL
;
1460 struct bt_value
*input_path
= NULL
;
1461 struct bt_value
*input_path_copy
= NULL
;
1462 const char *input_key
;
1463 const char *component_name
;
1465 switch (legacy_input_format
) {
1466 case LEGACY_INPUT_FORMAT_CTF
:
1468 component_name
= "fs";
1470 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1472 component_name
= "lttng-live";
1479 base_params
= params_from_ctf_legacy_opts(ctf_legacy_opts
);
1484 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1485 struct bt_config_component
*bt_config_component
= NULL
;
1487 /* Copy base parameters as current parameters */
1488 params
= bt_value_copy(base_params
);
1493 /* Get current input path string value object */
1494 input_path
= bt_value_array_get(legacy_input_paths
, i
);
1499 /* Copy current input path value object */
1500 input_path_copy
= bt_value_copy(input_path
);
1501 if (!input_path_copy
) {
1505 /* Insert input path value object into current parameters */
1506 ret
= bt_value_map_insert(params
, input_key
, input_path_copy
);
1511 /* Create a component configuration */
1512 bt_config_component
= bt_config_component_create("ctf",
1514 if (!bt_config_component
) {
1518 BT_MOVE(bt_config_component
->params
, params
);
1520 /* Move created component configuration to the array */
1521 g_ptr_array_add(sources
, bt_config_component
);
1523 /* Put current stuff */
1525 BT_PUT(input_path_copy
);
1534 BT_PUT(base_params
);
1537 BT_PUT(input_path_copy
);
1542 * Escapes a string for the shell. The string is escaped knowing that
1543 * it's a parameter string value (double-quoted), and that it will be
1544 * entered between single quotes in the shell.
1546 * Return value is owned by the caller.
1549 char *str_shell_escape(const char *input
)
1552 const char *at
= input
;
1553 GString
*str
= g_string_new(NULL
);
1559 while (*at
!= '\0') {
1562 g_string_append(str
, "\\\\");
1565 g_string_append(str
, "\\\"");
1568 g_string_append(str
, "'\"'\"'");
1571 g_string_append(str
, "\\n");
1574 g_string_append(str
, "\\t");
1577 g_string_append_c(str
, *at
);
1587 g_string_free(str
, FALSE
);
1594 int append_prefixed_flag_params(GString
*str
, struct bt_value
*flags
,
1604 for (i
= 0; i
< bt_value_array_size(flags
); i
++) {
1605 struct bt_value
*value
= bt_value_array_get(flags
, i
);
1613 if (bt_value_string_get(value
, &flag
)) {
1619 g_string_append_printf(str
, ",%s-%s=true", prefix
, flag
);
1628 * Appends a boolean parameter string.
1631 void g_string_append_bool_param(GString
*str
, const char *name
, bool value
)
1633 g_string_append_printf(str
, ",%s=%s", name
, value
? "true" : "false");
1637 * Appends a path parameter string, or null if it's empty.
1640 int g_string_append_string_path_param(GString
*str
, const char *name
,
1645 if (path
->len
> 0) {
1646 char *escaped_path
= str_shell_escape(path
->str
);
1648 if (!escaped_path
) {
1653 g_string_append_printf(str
, "%s=\"%s\"", name
, escaped_path
);
1656 g_string_append_printf(str
, "%s=null", name
);
1669 * Prints the non-legacy sink options equivalent to the specified
1670 * legacy output format options.
1673 void print_output_legacy_to_sinks(
1674 enum legacy_output_format legacy_output_format
,
1675 struct text_legacy_opts
*text_legacy_opts
)
1677 const char *input_format
;
1678 GString
*str
= NULL
;
1680 str
= g_string_new(" ");
1686 switch (legacy_output_format
) {
1687 case LEGACY_OUTPUT_FORMAT_TEXT
:
1688 input_format
= "text";
1690 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1691 input_format
= "ctf-metadata";
1693 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1694 input_format
= "dummy";
1700 printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
1702 printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
1704 g_string_append(str
, "-o ");
1706 switch (legacy_output_format
) {
1707 case LEGACY_OUTPUT_FORMAT_TEXT
:
1708 g_string_append(str
, "text.text");
1710 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1711 g_string_append(str
, "ctf.metadata-text");
1713 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1714 g_string_append(str
, "dummy.dummy");
1720 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
&&
1721 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1724 g_string_append(str
, " -p '");
1726 if (g_string_append_string_path_param(str
, "output-path",
1727 text_legacy_opts
->output
)) {
1731 g_string_append(str
, ",");
1733 if (g_string_append_string_path_param(str
, "debug-info-dir",
1734 text_legacy_opts
->dbg_info_dir
)) {
1738 g_string_append(str
, ",");
1740 if (g_string_append_string_path_param(str
,
1741 "debug-info-target-prefix",
1742 text_legacy_opts
->dbg_info_target_prefix
)) {
1746 g_string_append_bool_param(str
, "no-delta",
1747 text_legacy_opts
->no_delta
);
1748 g_string_append_bool_param(str
, "clock-cycles",
1749 text_legacy_opts
->clock_cycles
);
1750 g_string_append_bool_param(str
, "clock-seconds",
1751 text_legacy_opts
->clock_seconds
);
1752 g_string_append_bool_param(str
, "clock-date",
1753 text_legacy_opts
->clock_date
);
1754 g_string_append_bool_param(str
, "clock-gmt",
1755 text_legacy_opts
->clock_gmt
);
1756 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->names
,
1762 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->fields
,
1768 /* Remove last comma and close single quote */
1769 g_string_append(str
, "'");
1772 printf_err("%s\n\n", str
->str
);
1776 g_string_free(str
, TRUE
);
1782 * Prints the non-legacy source options equivalent to the specified
1783 * legacy input format options.
1786 void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format
,
1787 struct bt_value
*legacy_input_paths
,
1788 struct ctf_legacy_opts
*ctf_legacy_opts
)
1790 const char *input_format
;
1791 GString
*str
= NULL
;
1794 str
= g_string_new(" ");
1800 switch (legacy_input_format
) {
1801 case LEGACY_INPUT_FORMAT_CTF
:
1802 input_format
= "ctf";
1804 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1805 input_format
= "lttng-live";
1811 printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
1813 printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
1816 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1817 struct bt_value
*input_value
=
1818 bt_value_array_get(legacy_input_paths
, i
);
1819 const char *input
= NULL
;
1820 char *escaped_input
;
1823 assert(input_value
);
1824 ret
= bt_value_string_get(input_value
, &input
);
1825 BT_PUT(input_value
);
1826 assert(!ret
&& input
);
1827 escaped_input
= str_shell_escape(input
);
1828 if (!escaped_input
) {
1833 g_string_append(str
, "-i ctf.");
1835 switch (legacy_input_format
) {
1836 case LEGACY_INPUT_FORMAT_CTF
:
1837 g_string_append(str
, "fs -p 'path=\"");
1839 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1840 g_string_append(str
, "lttng-live -p 'url=\"");
1846 g_string_append(str
, escaped_input
);
1847 g_string_append(str
, "\"");
1848 g_string_append_printf(str
, ",offset-s=%" PRId64
,
1849 ctf_legacy_opts
->offset_s
.value
);
1850 g_string_append_printf(str
, ",offset-ns=%" PRId64
,
1851 ctf_legacy_opts
->offset_ns
.value
);
1852 g_string_append_bool_param(str
, "stream-intersection",
1853 ctf_legacy_opts
->stream_intersection
);
1854 g_string_append(str
, "' ");
1855 g_free(escaped_input
);
1858 printf_err("%s\n\n", str
->str
);
1862 g_string_free(str
, TRUE
);
1868 * Validates a given configuration, with optional legacy input and
1869 * output formats options. Prints useful error messages if anything
1872 * Returns true when the configuration is valid.
1875 bool validate_cfg(struct bt_config
*cfg
,
1876 enum legacy_input_format
*legacy_input_format
,
1877 enum legacy_output_format
*legacy_output_format
,
1878 struct bt_value
*legacy_input_paths
,
1879 struct ctf_legacy_opts
*ctf_legacy_opts
,
1880 struct text_legacy_opts
*text_legacy_opts
)
1882 bool legacy_input
= false;
1883 bool legacy_output
= false;
1885 /* Determine if the input and output should be legacy-style */
1886 if (*legacy_input_format
!= LEGACY_INPUT_FORMAT_NONE
||
1887 !bt_value_array_is_empty(legacy_input_paths
) ||
1888 ctf_legacy_opts_is_any_set(ctf_legacy_opts
)) {
1889 legacy_input
= true;
1892 if (*legacy_output_format
!= LEGACY_OUTPUT_FORMAT_NONE
||
1893 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1894 legacy_output
= true;
1898 /* If no legacy input format was specified, default to CTF */
1899 if (*legacy_input_format
== LEGACY_INPUT_FORMAT_NONE
) {
1900 *legacy_input_format
= LEGACY_INPUT_FORMAT_CTF
;
1903 /* Make sure at least one input path exists */
1904 if (bt_value_array_is_empty(legacy_input_paths
)) {
1905 switch (*legacy_input_format
) {
1906 case LEGACY_INPUT_FORMAT_CTF
:
1907 printf_err("No input path specified for legacy `ctf` input format\n");
1909 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1910 printf_err("No URL specified for legacy `lttng-live` input format\n");
1918 /* Make sure no non-legacy sources are specified */
1919 if (cfg
->cmd_data
.convert
.sources
->len
!= 0) {
1920 print_input_legacy_to_sources(*legacy_input_format
,
1921 legacy_input_paths
, ctf_legacy_opts
);
1926 if (legacy_output
) {
1928 * If no legacy output format was specified, default to
1931 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_NONE
) {
1932 *legacy_output_format
= LEGACY_OUTPUT_FORMAT_TEXT
;
1936 * If any "text" option was specified, the output must be
1939 if (text_legacy_opts_is_any_set(text_legacy_opts
) &&
1940 *legacy_output_format
!=
1941 LEGACY_OUTPUT_FORMAT_TEXT
) {
1942 printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
1946 /* Make sure no non-legacy sinks are specified */
1947 if (cfg
->cmd_data
.convert
.sinks
->len
!= 0) {
1948 print_output_legacy_to_sinks(*legacy_output_format
,
1955 * If the output is the legacy "ctf-metadata" format, then the
1956 * input should be the legacy "ctf" input format.
1958 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_CTF_METADATA
&&
1959 *legacy_input_format
!= LEGACY_INPUT_FORMAT_CTF
) {
1960 printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
1971 * Parses a 64-bit signed integer.
1973 * Returns a negative value if anything goes wrong.
1976 int parse_int64(const char *arg
, int64_t *val
)
1981 *val
= strtoll(arg
, &endptr
, 0);
1982 if (*endptr
!= '\0' || arg
== endptr
|| errno
!= 0) {
1996 OPT_CLOCK_FORCE_CORRELATE
,
1999 OPT_CLOCK_OFFSET_NS
,
2003 OPT_DEBUG_INFO_FULL_PATH
,
2004 OPT_DEBUG_INFO_TARGET_PREFIX
,
2014 OPT_OMIT_HOME_PLUGIN_PATH
,
2015 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
2021 OPT_RESET_BASE_PARAMS
,
2024 OPT_STREAM_INTERSECTION
,
2030 * Sets the value of a given legacy offset option and marks it as set.
2032 static void set_offset_value(struct offset_opt
*offset_opt
, int64_t value
)
2034 offset_opt
->value
= value
;
2035 offset_opt
->is_set
= true;
2038 enum bt_config_component_dest
{
2039 BT_CONFIG_COMPONENT_DEST_SOURCE
,
2040 BT_CONFIG_COMPONENT_DEST_SINK
,
2044 * Adds a configuration component to the appropriate configuration
2045 * array depending on the destination.
2047 static void add_cfg_comp(struct bt_config
*cfg
,
2048 struct bt_config_component
*cfg_comp
,
2049 enum bt_config_component_dest dest
)
2051 if (dest
== BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2052 g_ptr_array_add(cfg
->cmd_data
.convert
.sources
, cfg_comp
);
2054 g_ptr_array_add(cfg
->cmd_data
.convert
.sinks
, cfg_comp
);
2058 static int split_timerange(const char *arg
, const char **begin
, const char **end
)
2062 /* Try to match [begin,end] */
2063 c
= strchr(arg
, '[');
2077 /* Try to match begin,end */
2091 static int append_env_var_plugin_paths(struct bt_value
*plugin_paths
)
2096 if (bt_common_is_setuid_setgid()) {
2097 printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
2101 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
2106 ret
= bt_config_append_plugin_paths(plugin_paths
, envvar
);
2112 static int append_home_and_system_plugin_paths(struct bt_value
*plugin_paths
,
2113 bool omit_system_plugin_path
, bool omit_home_plugin_path
)
2117 if (!omit_home_plugin_path
) {
2118 if (bt_common_is_setuid_setgid()) {
2119 printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
2121 char *home_plugin_dir
=
2122 bt_common_get_home_plugin_path();
2124 if (home_plugin_dir
) {
2125 ret
= bt_config_append_plugin_paths(
2128 free(home_plugin_dir
);
2131 printf_err("Invalid home plugin path\n");
2138 if (!omit_system_plugin_path
) {
2139 if (bt_config_append_plugin_paths(plugin_paths
,
2140 bt_common_get_system_plugin_path())) {
2141 printf_err("Invalid system plugin path\n");
2150 static int append_sources_from_implicit_params(GPtrArray
*sources
,
2151 struct bt_config_component
*implicit_source_comp
)
2154 size_t len
= sources
->len
;
2156 for (i
= 0; i
< len
; i
++) {
2157 struct bt_config_component
*comp
;
2158 struct bt_value
*params_to_set
;
2160 comp
= g_ptr_array_index(sources
, i
);
2161 params_to_set
= bt_value_map_extend(comp
->params
,
2162 implicit_source_comp
->params
);
2163 if (!params_to_set
) {
2164 printf_err("Cannot extend legacy component parameters with non-legacy parameters\n");
2167 BT_MOVE(comp
->params
, params_to_set
);
2174 static struct bt_config
*bt_config_base_create(enum bt_config_command command
)
2176 struct bt_config
*cfg
;
2179 cfg
= g_new0(struct bt_config
, 1);
2185 bt_object_init(cfg
, bt_config_destroy
);
2186 cfg
->command
= command
;
2196 static struct bt_config
*bt_config_convert_create(
2197 struct bt_value
*initial_plugin_paths
)
2199 struct bt_config
*cfg
;
2202 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_CONVERT
);
2208 cfg
->cmd_data
.convert
.sources
= g_ptr_array_new_with_free_func(
2209 (GDestroyNotify
) bt_put
);
2210 if (!cfg
->cmd_data
.convert
.sources
) {
2215 cfg
->cmd_data
.convert
.sinks
= g_ptr_array_new_with_free_func(
2216 (GDestroyNotify
) bt_put
);
2217 if (!cfg
->cmd_data
.convert
.sinks
) {
2222 if (initial_plugin_paths
) {
2223 cfg
->cmd_data
.convert
.plugin_paths
=
2224 bt_get(initial_plugin_paths
);
2226 cfg
->cmd_data
.convert
.plugin_paths
= bt_value_array_create();
2227 if (!cfg
->cmd_data
.convert
.plugin_paths
) {
2242 static struct bt_config
*bt_config_list_plugins_create(
2243 struct bt_value
*initial_plugin_paths
)
2245 struct bt_config
*cfg
;
2248 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS
);
2254 if (initial_plugin_paths
) {
2255 cfg
->cmd_data
.list_plugins
.plugin_paths
=
2256 bt_get(initial_plugin_paths
);
2258 cfg
->cmd_data
.list_plugins
.plugin_paths
=
2259 bt_value_array_create();
2260 if (!cfg
->cmd_data
.list_plugins
.plugin_paths
) {
2275 static struct bt_config
*bt_config_help_create(
2276 struct bt_value
*initial_plugin_paths
)
2278 struct bt_config
*cfg
;
2281 cfg
= bt_config_base_create(BT_CONFIG_COMMAND_HELP
);
2287 if (initial_plugin_paths
) {
2288 cfg
->cmd_data
.help
.plugin_paths
=
2289 bt_get(initial_plugin_paths
);
2291 cfg
->cmd_data
.help
.plugin_paths
=
2292 bt_value_array_create();
2293 if (!cfg
->cmd_data
.help
.plugin_paths
) {
2299 cfg
->cmd_data
.help
.plugin_name
= g_string_new(NULL
);
2300 if (!cfg
->cmd_data
.help
.plugin_name
) {
2305 cfg
->cmd_data
.help
.component_name
= g_string_new(NULL
);
2306 if (!cfg
->cmd_data
.help
.component_name
) {
2321 * Prints the help command usage.
2324 void print_help_usage(FILE *fp
)
2326 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
2327 fprintf(fp
, " babeltrace [GENERAL OPTIONS] help [OPTIONS] --source PLUGIN.COMPCLS\n");
2328 fprintf(fp
, " babeltrace [GENERAL OPTIONS] help [OPTIONS] --filter PLUGIN.COMPCLS\n");
2329 fprintf(fp
, " babeltrace [GENERAL OPTIONS] help [OPTIONS] --sink PLUGIN.COMPCLS\n");
2331 fprintf(fp
, "Options:\n");
2333 fprintf(fp
, " --filter=PLUGIN.COMPCLS Get help for the filter component class\n");
2334 fprintf(fp
, " COMPCLS found in the plugin PLUGIN\n");
2335 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2336 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2337 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2338 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2339 fprintf(fp
, " dynamic plugins can be loaded\n");
2340 fprintf(fp
, " --sink=PLUGIN.COMPCLS Get help for the sink component class\n");
2341 fprintf(fp
, " COMPCLS found in the plugin PLUGIN\n");
2342 fprintf(fp
, " --source=PLUGIN.COMPCLS Get help for the source component class\n");
2343 fprintf(fp
, " COMPCLS found in the plugin PLUGIN\n");
2344 fprintf(fp
, " -h --help Show this help and quit\n");
2346 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2348 fprintf(fp
, "Use `babeltrace list-plugins` to show the list of available plugins.\n");
2351 static struct poptOption help_long_options
[] = {
2352 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2353 { "filter", '\0', POPT_ARG_STRING
, NULL
, OPT_FILTER
, NULL
, NULL
},
2354 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2355 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2356 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2357 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2358 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2359 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2360 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2364 * Creates a Babeltrace config object from the arguments of a help
2367 * *retcode is set to the appropriate exit code to use.
2369 struct bt_config
*bt_config_help_from_args(int argc
, const char *argv
[],
2370 int *retcode
, bool omit_system_plugin_path
,
2371 bool omit_home_plugin_path
,
2372 struct bt_value
*initial_plugin_paths
)
2374 poptContext pc
= NULL
;
2378 struct bt_config
*cfg
= NULL
;
2379 const char *leftover
;
2380 char *plugin_name
= NULL
, *component_name
= NULL
;
2381 char *plugin_comp_cls_names
= NULL
;
2384 cfg
= bt_config_help_create(initial_plugin_paths
);
2390 cfg
->cmd_data
.help
.comp_cls_type
= BT_COMPONENT_CLASS_TYPE_UNKNOWN
;
2391 cfg
->cmd_data
.help
.omit_system_plugin_path
= omit_system_plugin_path
;
2392 cfg
->cmd_data
.help
.omit_home_plugin_path
= omit_home_plugin_path
;
2393 ret
= append_env_var_plugin_paths(cfg
->cmd_data
.help
.plugin_paths
);
2395 printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n");
2400 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2401 help_long_options
, 0);
2403 printf_err("Cannot get popt context\n");
2407 poptReadDefaultConfig(pc
, 0);
2409 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2410 arg
= poptGetOptArg(pc
);
2413 case OPT_PLUGIN_PATH
:
2414 if (bt_common_is_setuid_setgid()) {
2415 printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
2417 if (bt_config_append_plugin_paths(
2418 cfg
->cmd_data
.help
.plugin_paths
,
2420 printf_err("Invalid --plugin-path option's argument:\n %s\n",
2426 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2427 cfg
->cmd_data
.help
.omit_system_plugin_path
= true;
2429 case OPT_OMIT_HOME_PLUGIN_PATH
:
2430 cfg
->cmd_data
.help
.omit_home_plugin_path
= true;
2435 if (cfg
->cmd_data
.help
.comp_cls_type
!=
2436 BT_COMPONENT_CLASS_TYPE_UNKNOWN
) {
2437 printf_err("Cannot specify more than one plugin and component class:\n %s\n",
2444 cfg
->cmd_data
.help
.comp_cls_type
=
2445 BT_COMPONENT_CLASS_TYPE_SOURCE
;
2448 cfg
->cmd_data
.help
.comp_cls_type
=
2449 BT_COMPONENT_CLASS_TYPE_FILTER
;
2452 cfg
->cmd_data
.help
.comp_cls_type
=
2453 BT_COMPONENT_CLASS_TYPE_SINK
;
2458 plugin_comp_cls_names
= strdup(arg
);
2459 if (!plugin_comp_cls_names
) {
2465 print_help_usage(stdout
);
2470 printf_err("Unknown command-line option specified (option code %d)\n",
2479 /* Check for option parsing error */
2481 printf_err("While parsing command-line options, at option %s: %s\n",
2482 poptBadOption(pc
, 0), poptStrerror(opt
));
2486 leftover
= poptGetArg(pc
);
2488 if (cfg
->cmd_data
.help
.comp_cls_type
!=
2489 BT_COMPONENT_CLASS_TYPE_UNKNOWN
) {
2490 printf_err("Cannot specify plugin name and --source/--filter/--sink component class:\n %s\n",
2495 g_string_assign(cfg
->cmd_data
.help
.plugin_name
, leftover
);
2497 if (cfg
->cmd_data
.help
.comp_cls_type
==
2498 BT_COMPONENT_CLASS_TYPE_UNKNOWN
) {
2499 print_help_usage(stdout
);
2505 plugin_component_names_from_arg(plugin_comp_cls_names
,
2506 &plugin_name
, &component_name
);
2507 if (plugin_name
&& component_name
) {
2508 g_string_assign(cfg
->cmd_data
.help
.plugin_name
, plugin_name
);
2509 g_string_assign(cfg
->cmd_data
.help
.component_name
,
2512 printf_err("Invalid --source/--filter/--sink option's argument:\n %s\n",
2513 plugin_comp_cls_names
);
2518 if (append_home_and_system_plugin_paths(
2519 cfg
->cmd_data
.help
.plugin_paths
,
2520 cfg
->cmd_data
.help
.omit_system_plugin_path
,
2521 cfg
->cmd_data
.help
.omit_home_plugin_path
)) {
2522 printf_err("Cannot append home and system plugin paths\n");
2533 free(plugin_comp_cls_names
);
2534 g_free(plugin_name
);
2535 g_free(component_name
);
2538 poptFreeContext(pc
);
2546 * Prints the list-plugins command usage.
2549 void print_list_plugins_usage(FILE *fp
)
2551 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
2553 fprintf(fp
, "Options:\n");
2555 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2556 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2557 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2558 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2559 fprintf(fp
, " dynamic plugins can be loaded\n");
2560 fprintf(fp
, " -h --help Show this help and quit\n");
2562 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2564 fprintf(fp
, "Use `babeltrace help` to get help for a specific plugin or component class.\n");
2567 static struct poptOption list_plugins_long_options
[] = {
2568 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2569 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2570 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2571 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2572 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2573 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2577 * Creates a Babeltrace config object from the arguments of a
2578 * list-plugins command.
2580 * *retcode is set to the appropriate exit code to use.
2582 struct bt_config
*bt_config_list_plugins_from_args(int argc
, const char *argv
[],
2583 int *retcode
, bool omit_system_plugin_path
,
2584 bool omit_home_plugin_path
,
2585 struct bt_value
*initial_plugin_paths
)
2587 poptContext pc
= NULL
;
2591 struct bt_config
*cfg
= NULL
;
2592 const char *leftover
;
2595 cfg
= bt_config_list_plugins_create(initial_plugin_paths
);
2601 cfg
->cmd_data
.list_plugins
.omit_system_plugin_path
= omit_system_plugin_path
;
2602 cfg
->cmd_data
.list_plugins
.omit_home_plugin_path
= omit_home_plugin_path
;
2603 ret
= append_env_var_plugin_paths(
2604 cfg
->cmd_data
.list_plugins
.plugin_paths
);
2606 printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n");
2611 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2612 list_plugins_long_options
, 0);
2614 printf_err("Cannot get popt context\n");
2618 poptReadDefaultConfig(pc
, 0);
2620 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2621 arg
= poptGetOptArg(pc
);
2624 case OPT_PLUGIN_PATH
:
2625 if (bt_common_is_setuid_setgid()) {
2626 printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
2628 if (bt_config_append_plugin_paths(
2629 cfg
->cmd_data
.list_plugins
.plugin_paths
,
2631 printf_err("Invalid --plugin-path option's argument:\n %s\n",
2637 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2638 cfg
->cmd_data
.list_plugins
.omit_system_plugin_path
= true;
2640 case OPT_OMIT_HOME_PLUGIN_PATH
:
2641 cfg
->cmd_data
.list_plugins
.omit_home_plugin_path
= true;
2644 print_list_plugins_usage(stdout
);
2649 printf_err("Unknown command-line option specified (option code %d)\n",
2658 /* Check for option parsing error */
2660 printf_err("While parsing command-line options, at option %s: %s\n",
2661 poptBadOption(pc
, 0), poptStrerror(opt
));
2665 leftover
= poptGetArg(pc
);
2667 printf_err("Invalid argument: %s\n", leftover
);
2671 if (append_home_and_system_plugin_paths(
2672 cfg
->cmd_data
.list_plugins
.plugin_paths
,
2673 cfg
->cmd_data
.list_plugins
.omit_system_plugin_path
,
2674 cfg
->cmd_data
.list_plugins
.omit_home_plugin_path
)) {
2675 printf_err("Cannot append home and system plugin paths\n");
2687 poptFreeContext(pc
);
2695 * Prints the legacy, Babeltrace 1.x command usage. Those options are
2696 * still compatible in Babeltrace 2.x, but it is recommended to use
2697 * the more generic plugin/component parameters instead of those
2698 * hard-coded option names.
2701 void print_legacy_usage(FILE *fp
)
2703 fprintf(fp
, "Usage: babeltrace [OPTIONS] INPUT...\n");
2705 fprintf(fp
, "The following options are compatible with the Babeltrace 1.x options:\n");
2707 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently correlated\n");
2708 fprintf(fp
, " across traces\n");
2709 fprintf(fp
, " -d, --debug Enable debug mode\n");
2710 fprintf(fp
, " -i, --input-format=FORMAT Input trace format (default: ctf)\n");
2711 fprintf(fp
, " -l, --list List available formats\n");
2712 fprintf(fp
, " -o, --output-format=FORMAT Output trace format (default: text)\n");
2713 fprintf(fp
, " -v, --verbose Enable verbose output\n");
2714 fprintf(fp
, " --help-legacy Show this help and quit\n");
2715 fprintf(fp
, " -V, --version Show version and quit\n");
2717 fprintf(fp
, " Available input formats: ctf, lttng-live, ctf-metadata\n");
2718 fprintf(fp
, " Available output formats: text, dummy\n");
2720 fprintf(fp
, "Input formats specific options:\n");
2722 fprintf(fp
, " INPUT... Input trace file(s), directory(ies), or URLs\n");
2723 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2724 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n");
2725 fprintf(fp
, " --stream-intersection Only process events when all streams are active\n");
2727 fprintf(fp
, "text output format specific options:\n");
2729 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
2730 fprintf(fp
, " --clock-date Print timestamp dates\n");
2731 fprintf(fp
, " --clock-gmt Print and parse timestamps in GMT time zone\n");
2732 fprintf(fp
, " (default: local time zone)\n");
2733 fprintf(fp
, " --clock-seconds Print the timestamps as [SEC.NS]\n");
2734 fprintf(fp
, " (default format: [HH:MM:SS.NS])\n");
2735 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2736 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
2737 fprintf(fp
, " --debug-info-full-path Show full debug info source and binary paths\n");
2738 fprintf(fp
, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n");
2739 fprintf(fp
, " up executables during debug info analysis\n");
2740 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
2741 fprintf(fp
, " -f, --fields=NAME[,NAME]... Print additional fields:\n");
2742 fprintf(fp
, " all, trace, trace:hostname, trace:domain,\n");
2743 fprintf(fp
, " trace:procname, trace:vpid, loglevel, emf\n");
2744 fprintf(fp
, " (default: trace:hostname, trace:procname,\n");
2745 fprintf(fp
, " trace:vpid)\n");
2746 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names:\n");
2747 fprintf(fp
, " payload (or arg or args)\n");
2748 fprintf(fp
, " none, all, scope, header, context (or ctx)\n");
2749 fprintf(fp
, " (default: payload, context)\n");
2750 fprintf(fp
, " --no-delta Do not print time delta between consecutive\n");
2751 fprintf(fp
, " events\n");
2752 fprintf(fp
, " -w, --output=PATH Write output to PATH (default: standard output)\n");
2756 * Prints the convert command usage.
2759 void print_convert_usage(FILE *fp
)
2761 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] convert [OPTIONS]\n");
2763 fprintf(fp
, "Options:\n");
2765 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
2766 fprintf(fp
, " for the following component instances\n");
2767 fprintf(fp
, " (see the expected format of PARAMS below)\n");
2768 fprintf(fp
, " --begin=BEGIN Set the `begin` parameter of the latest\n");
2769 fprintf(fp
, " source component instance to BEGIN\n");
2770 fprintf(fp
, " (see the suggested format of BEGIN below)\n");
2771 fprintf(fp
, " -d, --debug Enable debug mode\n");
2772 fprintf(fp
, " --end=END Set the `end` parameter of the latest\n");
2773 fprintf(fp
, " source component instance to END\n");
2774 fprintf(fp
, " (see the suggested format of BEGIN below)\n");
2775 fprintf(fp
, " --name=NAME Set the name of the latest component\n");
2776 fprintf(fp
, " instance to NAME (must be unique amongst\n");
2777 fprintf(fp
, " all the names of the component instances)\n");
2778 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2779 fprintf(fp
, " (~/.local/lib/babeltrace/plugins)\n");
2780 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2781 fprintf(fp
, " -p, --params=PARAMS Set the parameters of the latest component\n");
2782 fprintf(fp
, " instance (in command-line order) to PARAMS\n");
2783 fprintf(fp
, " (see the expected format of PARAMS below)\n");
2784 fprintf(fp
, " -P, --path=PATH Set the `path` parameter of the latest\n");
2785 fprintf(fp
, " component instance to PATH\n");
2786 fprintf(fp
, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2787 fprintf(fp
, " dynamic plugins can be loaded\n");
2788 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters of the\n");
2789 fprintf(fp
, " following source and sink component\n");
2790 fprintf(fp
, " instances to an empty map\n");
2791 fprintf(fp
, " -o, --sink=PLUGIN.COMPCLS Instantiate a sink component from plugin\n");
2792 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
2793 fprintf(fp
, " repeated)\n");
2794 fprintf(fp
, " -i, --source=PLUGIN.COMPCLS Instantiate a source component from plugin\n");
2795 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
2796 fprintf(fp
, " repeated)\n");
2797 fprintf(fp
, " --timerange=TIMERANGE Set time range to TIMERANGE: BEGIN,END or\n");
2798 fprintf(fp
, " [BEGIN,END] (literally `[` and `]`)\n");
2799 fprintf(fp
, " (suggested format of BEGIN/END below)\n");
2800 fprintf(fp
, " -v, --verbose Enable verbose output\n");
2801 fprintf(fp
, " -h --help Show this help and quit\n");
2803 fprintf(fp
, "See `babeltrace --help` for the list of general options.\n");
2804 fprintf(fp
, "\n\n");
2805 fprintf(fp
, "Suggested format of BEGIN and END\n");
2806 fprintf(fp
, "---------------------------------\n");
2808 fprintf(fp
, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2809 fprintf(fp
, "\n\n");
2810 fprintf(fp
, "Expected format of PARAMS\n");
2811 fprintf(fp
, "-------------------------\n");
2813 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
2815 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
2816 fprintf(fp
, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
2817 fprintf(fp
, "VALUE can be one of:\n");
2819 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
2820 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
2821 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
2822 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
2823 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
2824 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
2825 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
2826 fprintf(fp
, " the null and boolean value symbols above.\n");
2827 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
2829 fprintf(fp
, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
2831 fprintf(fp
, "Example:\n");
2833 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
2834 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
2835 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
2837 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
2838 fprintf(fp
, "from a shell.\n");
2841 static struct poptOption convert_long_options
[] = {
2842 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2843 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
2844 { "begin", '\0', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2845 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2846 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2847 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2848 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2849 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2850 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2851 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2852 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2853 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2854 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2855 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2856 { "end", '\0', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2857 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2858 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2859 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2860 { "name", '\0', POPT_ARG_STRING
, NULL
, OPT_NAME
, NULL
, NULL
},
2861 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2862 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2863 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2864 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2865 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_PATH
, NULL
, NULL
},
2866 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2867 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2868 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2869 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2870 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
2871 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2872 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2873 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2874 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2875 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2876 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2880 * Creates a Babeltrace config object from the arguments of a convert
2883 * *retcode is set to the appropriate exit code to use.
2885 struct bt_config
*bt_config_convert_from_args(int argc
, const char *argv
[],
2886 int *retcode
, bool omit_system_plugin_path
,
2887 bool omit_home_plugin_path
,
2888 struct bt_value
*initial_plugin_paths
)
2890 poptContext pc
= NULL
;
2892 struct ctf_legacy_opts ctf_legacy_opts
;
2893 struct text_legacy_opts text_legacy_opts
;
2894 enum legacy_input_format legacy_input_format
= LEGACY_INPUT_FORMAT_NONE
;
2895 enum legacy_output_format legacy_output_format
=
2896 LEGACY_OUTPUT_FORMAT_NONE
;
2897 struct bt_value
*legacy_input_paths
= NULL
;
2898 struct bt_config_component
*implicit_source_comp
= NULL
;
2899 struct bt_config_component
*cur_cfg_comp
= NULL
;
2900 bool cur_is_implicit_source
= false;
2901 bool use_implicit_source
= false;
2902 enum bt_config_component_dest cur_cfg_comp_dest
=
2903 BT_CONFIG_COMPONENT_DEST_SOURCE
;
2904 struct bt_value
*cur_base_params
= NULL
;
2906 struct bt_config
*cfg
= NULL
;
2907 struct bt_value
*instance_names
= NULL
;
2910 memset(&ctf_legacy_opts
, 0, sizeof(ctf_legacy_opts
));
2911 memset(&text_legacy_opts
, 0, sizeof(text_legacy_opts
));
2914 print_convert_usage(stdout
);
2919 cfg
= bt_config_convert_create(initial_plugin_paths
);
2925 cfg
->cmd_data
.convert
.omit_system_plugin_path
= omit_system_plugin_path
;
2926 cfg
->cmd_data
.convert
.omit_home_plugin_path
= omit_home_plugin_path
;
2927 text_legacy_opts
.output
= g_string_new(NULL
);
2928 if (!text_legacy_opts
.output
) {
2933 text_legacy_opts
.dbg_info_dir
= g_string_new(NULL
);
2934 if (!text_legacy_opts
.dbg_info_dir
) {
2939 text_legacy_opts
.dbg_info_target_prefix
= g_string_new(NULL
);
2940 if (!text_legacy_opts
.dbg_info_target_prefix
) {
2945 cur_base_params
= bt_value_map_create();
2946 if (!cur_base_params
) {
2951 legacy_input_paths
= bt_value_array_create();
2952 if (!legacy_input_paths
) {
2957 instance_names
= bt_value_map_create();
2958 if (!instance_names
) {
2963 ret
= append_env_var_plugin_paths(cfg
->cmd_data
.convert
.plugin_paths
);
2965 printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n");
2969 /* Note: implicit source never gets positional base params. */
2970 implicit_source_comp
= bt_config_component_from_arg(DEFAULT_SOURCE_COMPONENT_NAME
);
2971 if (!implicit_source_comp
) {
2976 cur_cfg_comp
= implicit_source_comp
;
2977 cur_is_implicit_source
= true;
2978 use_implicit_source
= true;
2981 pc
= poptGetContext(NULL
, argc
, (const char **) argv
,
2982 convert_long_options
, 0);
2984 printf_err("Cannot get popt context\n");
2988 poptReadDefaultConfig(pc
, 0);
2990 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2991 arg
= poptGetOptArg(pc
);
2994 case OPT_PLUGIN_PATH
:
2995 if (bt_common_is_setuid_setgid()) {
2996 printf_debug("Skipping non-system plugin paths for setuid/setgid binary\n");
2998 if (bt_config_append_plugin_paths(
2999 cfg
->cmd_data
.convert
.plugin_paths
,
3001 printf_err("Invalid --plugin-path option's argument:\n %s\n",
3007 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
3008 cfg
->cmd_data
.convert
.omit_system_plugin_path
= true;
3010 case OPT_OMIT_HOME_PLUGIN_PATH
:
3011 cfg
->cmd_data
.convert
.omit_home_plugin_path
= true;
3013 case OPT_OUTPUT_PATH
:
3014 if (text_legacy_opts
.output
->len
> 0) {
3015 printf_err("Duplicate --output option\n");
3019 g_string_assign(text_legacy_opts
.output
, arg
);
3021 case OPT_DEBUG_INFO_DIR
:
3022 if (text_legacy_opts
.dbg_info_dir
->len
> 0) {
3023 printf_err("Duplicate --debug-info-dir option\n");
3027 g_string_assign(text_legacy_opts
.dbg_info_dir
, arg
);
3029 case OPT_DEBUG_INFO_TARGET_PREFIX
:
3030 if (text_legacy_opts
.dbg_info_target_prefix
->len
> 0) {
3031 printf_err("Duplicate --debug-info-target-prefix option\n");
3035 g_string_assign(text_legacy_opts
.dbg_info_target_prefix
, arg
);
3037 case OPT_INPUT_FORMAT
:
3040 if (opt
== OPT_INPUT_FORMAT
) {
3041 if (!strcmp(arg
, "ctf")) {
3042 /* Legacy CTF input format */
3043 if (legacy_input_format
) {
3044 print_err_dup_legacy_input();
3048 legacy_input_format
=
3049 LEGACY_INPUT_FORMAT_CTF
;
3051 } else if (!strcmp(arg
, "lttng-live")) {
3052 /* Legacy LTTng-live input format */
3053 if (legacy_input_format
) {
3054 print_err_dup_legacy_input();
3058 legacy_input_format
=
3059 LEGACY_INPUT_FORMAT_LTTNG_LIVE
;
3064 use_implicit_source
= false;
3066 /* Non-legacy: try to create a component config */
3067 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
3068 add_cfg_comp(cfg
, cur_cfg_comp
,
3072 cur_cfg_comp
= bt_config_component_from_arg(arg
);
3073 if (!cur_cfg_comp
) {
3074 printf_err("Invalid format for --source option's argument:\n %s\n",
3078 cur_is_implicit_source
= false;
3080 assert(cur_base_params
);
3081 bt_put(cur_cfg_comp
->params
);
3082 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
3083 if (!cur_cfg_comp
->params
) {
3088 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
3091 case OPT_OUTPUT_FORMAT
:
3094 if (opt
== OPT_OUTPUT_FORMAT
) {
3095 if (!strcmp(arg
, "text")) {
3096 /* Legacy CTF-text output format */
3097 if (legacy_output_format
) {
3098 print_err_dup_legacy_output();
3102 legacy_output_format
=
3103 LEGACY_OUTPUT_FORMAT_TEXT
;
3105 } else if (!strcmp(arg
, "dummy")) {
3106 /* Legacy dummy output format */
3107 if (legacy_output_format
) {
3108 print_err_dup_legacy_output();
3112 legacy_output_format
=
3113 LEGACY_OUTPUT_FORMAT_DUMMY
;
3115 } else if (!strcmp(arg
, "ctf-metadata")) {
3116 /* Legacy CTF-metadata output format */
3117 if (legacy_output_format
) {
3118 print_err_dup_legacy_output();
3122 legacy_output_format
=
3123 LEGACY_OUTPUT_FORMAT_CTF_METADATA
;
3128 /* Non-legacy: try to create a component config */
3129 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
3130 add_cfg_comp(cfg
, cur_cfg_comp
,
3134 cur_cfg_comp
= bt_config_component_from_arg(arg
);
3135 if (!cur_cfg_comp
) {
3136 printf_err("Invalid format for --sink option's argument:\n %s\n",
3140 cur_is_implicit_source
= false;
3142 assert(cur_base_params
);
3143 bt_put(cur_cfg_comp
->params
);
3144 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
3145 if (!cur_cfg_comp
->params
) {
3150 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
3155 struct bt_value
*params
;
3156 struct bt_value
*params_to_set
;
3158 if (!cur_cfg_comp
) {
3159 printf_err("Cannot add parameters to unavailable default source component `%s`:\n %s\n",
3160 DEFAULT_SOURCE_COMPONENT_NAME
, arg
);
3164 params
= bt_value_from_arg(arg
);
3166 printf_err("Invalid format for --params option's argument:\n %s\n",
3171 params_to_set
= bt_value_map_extend(cur_cfg_comp
->params
,
3174 if (!params_to_set
) {
3175 printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n",
3180 BT_MOVE(cur_cfg_comp
->params
, params_to_set
);
3184 if (!cur_cfg_comp
) {
3185 printf_err("Cannot add `path` parameter to unavailable default source component `%s`:\n %s\n",
3186 DEFAULT_SOURCE_COMPONENT_NAME
, arg
);
3190 assert(cur_cfg_comp
->params
);
3192 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
3199 if (!cur_cfg_comp
) {
3200 printf_err("Cannot set the name of unavailable default source component `%s`:\n %s\n",
3201 DEFAULT_SOURCE_COMPONENT_NAME
, arg
);
3205 if (bt_value_map_has_key(instance_names
, arg
)) {
3206 printf_err("Duplicate component instance name:\n %s\n",
3211 g_string_assign(cur_cfg_comp
->instance_name
, arg
);
3213 if (bt_value_map_insert(instance_names
,
3214 arg
, bt_value_null
)) {
3219 case OPT_BASE_PARAMS
:
3221 struct bt_value
*params
= bt_value_from_arg(arg
);
3224 printf_err("Invalid format for --base-params option's argument:\n %s\n",
3229 BT_MOVE(cur_base_params
, params
);
3232 case OPT_RESET_BASE_PARAMS
:
3233 BT_PUT(cur_base_params
);
3234 cur_base_params
= bt_value_map_create();
3235 if (!cur_base_params
) {
3241 if (text_legacy_opts
.names
) {
3242 printf_err("Duplicate --names option\n");
3246 text_legacy_opts
.names
= names_from_arg(arg
);
3247 if (!text_legacy_opts
.names
) {
3248 printf_err("Invalid --names option's argument:\n %s\n",
3254 if (text_legacy_opts
.fields
) {
3255 printf_err("Duplicate --fields option\n");
3259 text_legacy_opts
.fields
= fields_from_arg(arg
);
3260 if (!text_legacy_opts
.fields
) {
3261 printf_err("Invalid --fields option's argument:\n %s\n",
3267 text_legacy_opts
.no_delta
= true;
3269 case OPT_CLOCK_CYCLES
:
3270 text_legacy_opts
.clock_cycles
= true;
3272 case OPT_CLOCK_SECONDS
:
3273 text_legacy_opts
.clock_seconds
= true;
3275 case OPT_CLOCK_DATE
:
3276 text_legacy_opts
.clock_date
= true;
3279 text_legacy_opts
.clock_gmt
= true;
3281 case OPT_DEBUG_INFO_FULL_PATH
:
3282 text_legacy_opts
.dbg_info_full_path
= true;
3284 case OPT_CLOCK_OFFSET
:
3288 if (ctf_legacy_opts
.offset_s
.is_set
) {
3289 printf_err("Duplicate --clock-offset option\n");
3293 if (parse_int64(arg
, &val
)) {
3294 printf_err("Invalid --clock-offset option's argument:\n %s\n",
3299 set_offset_value(&ctf_legacy_opts
.offset_s
, val
);
3302 case OPT_CLOCK_OFFSET_NS
:
3306 if (ctf_legacy_opts
.offset_ns
.is_set
) {
3307 printf_err("Duplicate --clock-offset-ns option\n");
3311 if (parse_int64(arg
, &val
)) {
3312 printf_err("Invalid --clock-offset-ns option's argument:\n %s\n",
3317 set_offset_value(&ctf_legacy_opts
.offset_ns
, val
);
3320 case OPT_STREAM_INTERSECTION
:
3321 ctf_legacy_opts
.stream_intersection
= true;
3323 case OPT_CLOCK_FORCE_CORRELATE
:
3324 cfg
->cmd_data
.convert
.force_correlate
= true;
3327 if (!cur_cfg_comp
) {
3328 printf_err("Cannot add `begin` parameter to unavailable default source component `%s`:\n %s\n",
3329 DEFAULT_SOURCE_COMPONENT_NAME
, arg
);
3332 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
3333 printf_err("--begin option must follow a --source option:\n %s\n",
3337 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
3344 if (!cur_cfg_comp
) {
3345 printf_err("Cannot add `end` parameter to unavailable default source component `%s`:\n %s\n",
3346 DEFAULT_SOURCE_COMPONENT_NAME
, arg
);
3349 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
3350 printf_err("--end option must follow a --source option:\n %s\n",
3354 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
3362 const char *begin
, *end
;
3364 if (!cur_cfg_comp
) {
3365 printf_err("Cannot add `begin` and `end` parameters to unavailable default source component `%s`:\n %s\n",
3366 DEFAULT_SOURCE_COMPONENT_NAME
, arg
);
3369 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
3370 printf_err("--timerange option must follow a --source option:\n %s\n",
3374 if (split_timerange(arg
, &begin
, &end
)) {
3375 printf_err("Invalid --timerange format: expecting BEGIN,END or [BEGIN,END]:\n %s\n",
3379 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
3384 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
3392 print_convert_usage(stdout
);
3397 cfg
->verbose
= true;
3403 printf_err("Unknown command-line option specified (option code %d)\n",
3412 /* Check for option parsing error */
3414 printf_err("While parsing command-line options, at option %s: %s\n",
3415 poptBadOption(pc
, 0), poptStrerror(opt
));
3419 /* Consume leftover arguments as legacy input paths */
3421 const char *input_path
= poptGetArg(pc
);
3427 if (bt_value_array_append_string(legacy_input_paths
,
3434 if (append_home_and_system_plugin_paths(
3435 cfg
->cmd_data
.convert
.plugin_paths
,
3436 cfg
->cmd_data
.convert
.omit_system_plugin_path
,
3437 cfg
->cmd_data
.convert
.omit_home_plugin_path
)) {
3438 printf_err("Cannot append home and system plugin paths\n");
3442 /* Append current component configuration, if any */
3443 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
3444 add_cfg_comp(cfg
, cur_cfg_comp
, cur_cfg_comp_dest
);
3446 cur_cfg_comp
= NULL
;
3448 /* Validate legacy/non-legacy options */
3449 if (!validate_cfg(cfg
, &legacy_input_format
, &legacy_output_format
,
3450 legacy_input_paths
, &ctf_legacy_opts
,
3451 &text_legacy_opts
)) {
3452 printf_err("Command-line options form an invalid configuration\n");
3457 * If there's a legacy input format, convert it to source
3458 * component configurations.
3460 if (legacy_input_format
) {
3461 if (append_sources_from_legacy_opts(
3462 cfg
->cmd_data
.convert
.sources
,
3463 legacy_input_format
, &ctf_legacy_opts
,
3464 legacy_input_paths
)) {
3465 printf_err("Cannot convert legacy input format options to source component instance(s)\n");
3468 if (append_sources_from_implicit_params(
3469 cfg
->cmd_data
.convert
.sources
,
3470 implicit_source_comp
)) {
3471 printf_err("Cannot initialize legacy component parameters\n");
3474 use_implicit_source
= false;
3476 if (use_implicit_source
) {
3477 add_cfg_comp(cfg
, implicit_source_comp
,
3478 BT_CONFIG_COMPONENT_DEST_SOURCE
);
3479 implicit_source_comp
= NULL
;
3481 if (implicit_source_comp
3482 && !bt_value_map_is_empty(implicit_source_comp
->params
)) {
3483 printf_err("Arguments specified for implicit source, but an explicit source has been specified, overriding it\n");
3490 * If there's a legacy output format, convert it to sink
3491 * component configurations.
3493 if (legacy_output_format
) {
3494 if (append_sinks_from_legacy_opts(cfg
->cmd_data
.convert
.sinks
,
3495 legacy_output_format
, &text_legacy_opts
)) {
3496 printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
3501 if (cfg
->cmd_data
.convert
.sinks
->len
== 0) {
3502 /* Use implicit sink as default. */
3503 cur_cfg_comp
= bt_config_component_from_arg(DEFAULT_SINK_COMPONENT_NAME
);
3504 if (!cur_cfg_comp
) {
3505 printf_error("Cannot find implicit sink plugin `%s`\n",
3506 DEFAULT_SINK_COMPONENT_NAME
);
3508 add_cfg_comp(cfg
, cur_cfg_comp
,
3509 BT_CONFIG_COMPONENT_DEST_SINK
);
3510 cur_cfg_comp
= NULL
;
3521 poptFreeContext(pc
);
3524 if (text_legacy_opts
.output
) {
3525 g_string_free(text_legacy_opts
.output
, TRUE
);
3528 if (text_legacy_opts
.dbg_info_dir
) {
3529 g_string_free(text_legacy_opts
.dbg_info_dir
, TRUE
);
3532 if (text_legacy_opts
.dbg_info_target_prefix
) {
3533 g_string_free(text_legacy_opts
.dbg_info_target_prefix
, TRUE
);
3537 BT_PUT(implicit_source_comp
);
3538 BT_PUT(cur_cfg_comp
);
3539 BT_PUT(cur_base_params
);
3540 BT_PUT(text_legacy_opts
.names
);
3541 BT_PUT(text_legacy_opts
.fields
);
3542 BT_PUT(legacy_input_paths
);
3543 BT_PUT(instance_names
);
3548 * Prints the Babeltrace 2.x general usage.
3551 void print_gen_usage(FILE *fp
)
3553 fprintf(fp
, "Usage: babeltrace [GENERAL OPTIONS] [COMMAND] [COMMAND OPTIONS]\n");
3555 fprintf(fp
, "General options:\n");
3557 fprintf(fp
, " -d, --debug Enable debug mode\n");
3558 fprintf(fp
, " -h --help Show this help and quit\n");
3559 fprintf(fp
, " --help-legacy Show Babeltrace 1.x legacy help and quit\n");
3560 fprintf(fp
, " -v, --verbose Enable verbose output\n");
3561 fprintf(fp
, " -V, --version Show version and quit\n");
3563 fprintf(fp
, "Available commands:\n");
3565 fprintf(fp
, " convert Build a trace conversion graph and run it (default)\n");
3566 fprintf(fp
, " help Get help for a plugin or a component class\n");
3567 fprintf(fp
, " list-plugins List available plugins and their content\n");
3569 fprintf(fp
, "Use `babeltrace COMMAND --help` to show the help of COMMAND.\n");
3572 struct bt_config
*bt_config_from_args(int argc
, const char *argv
[],
3573 int *retcode
, bool omit_system_plugin_path
,
3574 bool omit_home_plugin_path
,
3575 struct bt_value
*initial_plugin_paths
)
3577 struct bt_config
*config
= NULL
;
3578 bool verbose
= false;
3581 enum bt_config_command command
= -1;
3582 const char **command_argv
= NULL
;
3583 int command_argc
= -1;
3584 const char *command_name
= NULL
;
3589 print_gen_usage(stdout
);
3593 for (i
= 1; i
< argc
; i
++) {
3594 const char *cur_arg
= argv
[i
];
3596 if (strcmp(cur_arg
, "-d") == 0 ||
3597 strcmp(cur_arg
, "--debug") == 0) {
3599 } else if (strcmp(cur_arg
, "-v") == 0 ||
3600 strcmp(cur_arg
, "--verbose") == 0) {
3602 } else if (strcmp(cur_arg
, "-V") == 0 ||
3603 strcmp(cur_arg
, "--version") == 0) {
3606 } else if (strcmp(cur_arg
, "-h") == 0 ||
3607 strcmp(cur_arg
, "--help") == 0) {
3608 print_gen_usage(stdout
);
3610 } else if (strcmp(cur_arg
, "--help-legacy") == 0) {
3611 print_legacy_usage(stdout
);
3614 bool has_command
= true;
3617 * First unknown argument: is it a known command
3620 if (strcmp(cur_arg
, "convert") == 0) {
3621 command
= BT_CONFIG_COMMAND_CONVERT
;
3622 } else if (strcmp(cur_arg
, "list-plugins") == 0) {
3623 command
= BT_CONFIG_COMMAND_LIST_PLUGINS
;
3624 } else if (strcmp(cur_arg
, "help") == 0) {
3625 command
= BT_CONFIG_COMMAND_HELP
;
3628 * Unknown argument, but not a known
3629 * command name: assume the whole
3630 * arguments are for the default convert
3633 command
= BT_CONFIG_COMMAND_CONVERT
;
3634 command_argv
= argv
;
3635 command_argc
= argc
;
3636 has_command
= false;
3640 command_argv
= &argv
[i
];
3641 command_argc
= argc
- i
;
3642 command_name
= cur_arg
;
3648 if ((int) command
< 0) {
3650 * We only got non-help, non-version general options
3651 * like --verbose and --debug, without any other
3652 * arguments, so we can't do anything useful: print the
3655 print_gen_usage(stdout
);
3659 assert(command_argv
);
3660 assert(command_argc
>= 0);
3663 case BT_CONFIG_COMMAND_CONVERT
:
3664 config
= bt_config_convert_from_args(command_argc
, command_argv
,
3665 retcode
, omit_system_plugin_path
,
3666 omit_home_plugin_path
, initial_plugin_paths
);
3668 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
3669 config
= bt_config_list_plugins_from_args(command_argc
,
3670 command_argv
, retcode
, omit_system_plugin_path
,
3671 omit_home_plugin_path
, initial_plugin_paths
);
3673 case BT_CONFIG_COMMAND_HELP
:
3674 config
= bt_config_help_from_args(command_argc
,
3675 command_argv
, retcode
, omit_system_plugin_path
,
3676 omit_home_plugin_path
, initial_plugin_paths
);
3684 config
->verbose
= true;
3688 config
->debug
= true;
3691 config
->command_name
= command_name
;