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/values.h>
36 #include "babeltrace-cfg.h"
39 * Error printf() macro which prepends "Error: " the first time it's
40 * called. This gives a nicer feel than having a bunch of error prefixes
41 * (since the following lines usually describe the error and possible
42 * solutions), or the error prefix just at the end.
44 #define printf_err(fmt, args...) \
46 if (is_first_error) { \
47 fprintf(stderr, "Error: "); \
48 is_first_error = false; \
50 fprintf(stderr, fmt, ##args); \
53 static bool is_first_error
= true;
55 /* INI-style parsing FSM states */
56 enum ini_parsing_fsm_state
{
57 /* Expect a map key (identifier) */
60 /* Expect an equal character ('=') */
66 /* Expect a negative number value */
67 INI_EXPECT_VALUE_NUMBER_NEG
,
69 /* Expect a comma character (',') */
73 /* INI-style parsing state variables */
74 struct ini_parsing_state
{
75 /* Lexical scanner (owned by this) */
78 /* Output map value object being filled (owned by this) */
79 struct bt_value
*params
;
81 /* Next expected FSM state */
82 enum ini_parsing_fsm_state expecting
;
84 /* Last decoded map key (owned by this) */
87 /* Complete INI-style string to parse (not owned by this) */
90 /* Error buffer (not owned by this) */
94 /* Offset option with "is set" boolean */
100 /* Legacy "ctf"/"lttng-live" format options */
101 struct ctf_legacy_opts
{
102 struct offset_opt offset_s
;
103 struct offset_opt offset_ns
;
104 bool stream_intersection
;
107 /* Legacy "text" format options */
108 struct text_legacy_opts
{
110 * output, dbg_info_dir, dbg_info_target_prefix, names,
111 * and fields are owned by this.
114 GString
*dbg_info_dir
;
115 GString
*dbg_info_target_prefix
;
116 struct bt_value
*names
;
117 struct bt_value
*fields
;
125 bool dbg_info_full_path
;
128 /* Legacy input format format */
129 enum legacy_input_format
{
130 LEGACY_INPUT_FORMAT_NONE
= 0,
131 LEGACY_INPUT_FORMAT_CTF
,
132 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
135 /* Legacy output format format */
136 enum legacy_output_format
{
137 LEGACY_OUTPUT_FORMAT_NONE
= 0,
138 LEGACY_OUTPUT_FORMAT_TEXT
,
139 LEGACY_OUTPUT_FORMAT_CTF_METADATA
,
140 LEGACY_OUTPUT_FORMAT_DUMMY
,
144 * Prints the "out of memory" error.
147 void print_err_oom(void)
149 printf_err("Out of memory\n");
153 * Prints duplicate legacy output format error.
156 void print_err_dup_legacy_output(void)
158 printf_err("More than one legacy output format specified\n");
162 * Prints duplicate legacy input format error.
165 void print_err_dup_legacy_input(void)
167 printf_err("More than one legacy input format specified\n");
171 * Checks if any of the "text" legacy options is set.
174 bool text_legacy_opts_is_any_set(struct text_legacy_opts
*opts
)
176 return (opts
->output
&& opts
->output
->len
> 0) ||
177 (opts
->dbg_info_dir
&& opts
->dbg_info_dir
->len
> 0) ||
178 (opts
->dbg_info_target_prefix
&&
179 opts
->dbg_info_target_prefix
->len
> 0) ||
180 bt_value_array_size(opts
->names
) > 0 ||
181 bt_value_array_size(opts
->fields
) > 0 ||
182 opts
->no_delta
|| opts
->clock_cycles
|| opts
->clock_seconds
||
183 opts
->clock_date
|| opts
->clock_gmt
||
184 opts
->dbg_info_full_path
;
188 * Checks if any of the "ctf" legacy options is set.
191 bool ctf_legacy_opts_is_any_set(struct ctf_legacy_opts
*opts
)
193 return opts
->offset_s
.is_set
|| opts
->offset_ns
.is_set
||
194 opts
->stream_intersection
;
198 * Appends an "expecting token" error to the INI-style parsing state's
202 void ini_append_error_expecting(struct ini_parsing_state
*state
,
203 GScanner
*scanner
, const char *expecting
)
208 g_string_append_printf(state
->ini_error
, "Expecting %s:\n", expecting
);
210 /* Only print error if there's one line */
211 if (strchr(state
->arg
, '\n') != NULL
|| strlen(state
->arg
) == 0) {
215 g_string_append_printf(state
->ini_error
, "\n %s\n", state
->arg
);
216 pos
= g_scanner_cur_position(scanner
) + 4;
218 if (!g_scanner_eof(scanner
)) {
222 for (i
= 0; i
< pos
; ++i
) {
223 g_string_append_printf(state
->ini_error
, " ");
226 g_string_append_printf(state
->ini_error
, "^\n\n");
230 int ini_handle_state(struct ini_parsing_state
*state
)
233 GTokenType token_type
;
234 struct bt_value
*value
= NULL
;
236 token_type
= g_scanner_get_next_token(state
->scanner
);
237 if (token_type
== G_TOKEN_EOF
) {
238 if (state
->expecting
!= INI_EXPECT_COMMA
) {
239 switch (state
->expecting
) {
240 case INI_EXPECT_EQUAL
:
241 ini_append_error_expecting(state
,
242 state
->scanner
, "'='");
244 case INI_EXPECT_VALUE
:
245 case INI_EXPECT_VALUE_NUMBER_NEG
:
246 ini_append_error_expecting(state
,
247 state
->scanner
, "value");
249 case INI_EXPECT_MAP_KEY
:
250 ini_append_error_expecting(state
,
251 state
->scanner
, "unquoted map key");
264 switch (state
->expecting
) {
265 case INI_EXPECT_MAP_KEY
:
266 if (token_type
!= G_TOKEN_IDENTIFIER
) {
267 ini_append_error_expecting(state
, state
->scanner
,
272 free(state
->last_map_key
);
273 state
->last_map_key
=
274 strdup(state
->scanner
->value
.v_identifier
);
275 if (!state
->last_map_key
) {
276 g_string_append(state
->ini_error
,
281 if (bt_value_map_has_key(state
->params
, state
->last_map_key
)) {
282 g_string_append_printf(state
->ini_error
,
283 "Duplicate parameter key: `%s`\n",
284 state
->last_map_key
);
288 state
->expecting
= INI_EXPECT_EQUAL
;
290 case INI_EXPECT_EQUAL
:
291 if (token_type
!= G_TOKEN_CHAR
) {
292 ini_append_error_expecting(state
,
293 state
->scanner
, "'='");
297 if (state
->scanner
->value
.v_char
!= '=') {
298 ini_append_error_expecting(state
,
299 state
->scanner
, "'='");
303 state
->expecting
= INI_EXPECT_VALUE
;
305 case INI_EXPECT_VALUE
:
307 switch (token_type
) {
309 if (state
->scanner
->value
.v_char
== '-') {
310 /* Negative number */
312 INI_EXPECT_VALUE_NUMBER_NEG
;
315 ini_append_error_expecting(state
,
316 state
->scanner
, "value");
322 /* Positive integer */
323 uint64_t int_val
= state
->scanner
->value
.v_int64
;
325 if (int_val
> (1ULL << 63) - 1) {
326 g_string_append_printf(state
->ini_error
,
327 "Integer value %" PRIu64
" is outside the range of a 64-bit signed integer\n",
332 value
= bt_value_integer_create_init(
337 /* Positive floating point number */
338 value
= bt_value_float_create_init(
339 state
->scanner
->value
.v_float
);
343 value
= bt_value_string_create_init(
344 state
->scanner
->value
.v_string
);
346 case G_TOKEN_IDENTIFIER
:
349 * Using symbols would be appropriate here,
350 * but said symbols are allowed as map key,
351 * so it's easier to consider everything an
354 * If one of the known symbols is not
355 * recognized here, then fall back to creating
358 const char *id
= state
->scanner
->value
.v_identifier
;
360 if (!strcmp(id
, "null") || !strcmp(id
, "NULL") ||
361 !strcmp(id
, "nul")) {
362 value
= bt_value_null
;
363 } else if (!strcmp(id
, "true") || !strcmp(id
, "TRUE") ||
364 !strcmp(id
, "yes") ||
365 !strcmp(id
, "YES")) {
366 value
= bt_value_bool_create_init(true);
367 } else if (!strcmp(id
, "false") ||
368 !strcmp(id
, "FALSE") ||
371 value
= bt_value_bool_create_init(false);
373 value
= bt_value_string_create_init(id
);
378 /* Unset value variable will trigger the error */
383 ini_append_error_expecting(state
,
384 state
->scanner
, "value");
388 state
->expecting
= INI_EXPECT_COMMA
;
391 case INI_EXPECT_VALUE_NUMBER_NEG
:
393 switch (token_type
) {
396 /* Negative integer */
397 uint64_t int_val
= state
->scanner
->value
.v_int64
;
399 if (int_val
> (1ULL << 63) - 1) {
400 g_string_append_printf(state
->ini_error
,
401 "Integer value -%" PRIu64
" is outside the range of a 64-bit signed integer\n",
406 value
= bt_value_integer_create_init(
407 -((int64_t) int_val
));
411 /* Negative floating point number */
412 value
= bt_value_float_create_init(
413 -state
->scanner
->value
.v_float
);
416 /* Unset value variable will trigger the error */
421 ini_append_error_expecting(state
,
422 state
->scanner
, "value");
426 state
->expecting
= INI_EXPECT_COMMA
;
429 case INI_EXPECT_COMMA
:
430 if (token_type
!= G_TOKEN_CHAR
) {
431 ini_append_error_expecting(state
,
432 state
->scanner
, "','");
436 if (state
->scanner
->value
.v_char
!= ',') {
437 ini_append_error_expecting(state
,
438 state
->scanner
, "','");
442 state
->expecting
= INI_EXPECT_MAP_KEY
;
454 if (bt_value_map_insert(state
->params
,
455 state
->last_map_key
, value
)) {
456 /* Only override return value on error */
467 * Converts an INI-style argument to an equivalent map value object.
469 * Return value is owned by the caller.
472 struct bt_value
*bt_value_from_ini(const char *arg
, GString
*ini_error
)
474 /* Lexical scanner configuration */
475 GScannerConfig scanner_config
= {
476 /* Skip whitespaces */
477 .cset_skip_characters
= " \t\n",
479 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
480 .cset_identifier_first
=
484 .cset_identifier_nth
=
489 /* "hello" and "Hello" two different keys */
490 .case_sensitive
= TRUE
,
493 .cpair_comment_single
= NULL
,
494 .skip_comment_multi
= TRUE
,
495 .skip_comment_single
= TRUE
,
496 .scan_comment_multi
= FALSE
,
499 * Do scan identifiers, including 1-char identifiers,
500 * but NULL is a normal identifier.
502 .scan_identifier
= TRUE
,
503 .scan_identifier_1char
= TRUE
,
504 .scan_identifier_NULL
= FALSE
,
507 * No specific symbols: null and boolean "symbols" are
508 * scanned as plain identifiers.
510 .scan_symbols
= FALSE
,
511 .symbol_2_token
= FALSE
,
512 .scope_0_fallback
= FALSE
,
515 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
516 * integers prefixed with "$".
522 .scan_hex_dollar
= FALSE
,
524 /* Convert scanned numbers to integer tokens */
525 .numbers_2_int
= TRUE
,
527 /* Support both integers and floating-point numbers */
528 .int_2_float
= FALSE
,
530 /* Scan integers as 64-bit signed integers */
533 /* Only scan double-quoted strings */
534 .scan_string_sq
= FALSE
,
535 .scan_string_dq
= TRUE
,
537 /* Do not converter identifiers to string tokens */
538 .identifier_2_string
= FALSE
,
540 /* Scan characters as G_TOKEN_CHAR token */
541 .char_2_token
= FALSE
,
543 struct ini_parsing_state state
= {
546 .expecting
= INI_EXPECT_MAP_KEY
,
548 .ini_error
= ini_error
,
551 state
.params
= bt_value_map_create();
556 state
.scanner
= g_scanner_new(&scanner_config
);
557 if (!state
.scanner
) {
561 /* Let the scan begin */
562 g_scanner_input_text(state
.scanner
, arg
, strlen(arg
));
565 int ret
= ini_handle_state(&state
);
570 } else if (ret
> 0) {
579 BT_PUT(state
.params
);
583 g_scanner_destroy(state
.scanner
);
586 free(state
.last_map_key
);
591 * Returns the parameters map value object from a command-line
592 * parameter option's argument.
594 * Return value is owned by the caller.
597 struct bt_value
*bt_value_from_arg(const char *arg
)
599 struct bt_value
*params
= NULL
;
600 GString
*ini_error
= NULL
;
602 ini_error
= g_string_new(NULL
);
608 /* Try INI-style parsing */
609 params
= bt_value_from_ini(arg
, ini_error
);
611 printf_err("%s", ini_error
->str
);
617 g_string_free(ini_error
, TRUE
);
623 * Returns the plugin and component names from a command-line
624 * source/sink option's argument. arg must have the following format:
628 * where PLUGIN is the plugin name, and COMPONENT is the component
631 * On success, both *plugin and *component are not NULL. *plugin
632 * and *component are owned by the caller.
635 void plugin_component_names_from_arg(const char *arg
, char **plugin
,
641 size_t component_len
;
643 /* Initialize both return values to NULL: not found */
647 dot
= strchr(arg
, '.');
653 end
= arg
+ strlen(arg
);
654 plugin_len
= dot
- arg
;
655 component_len
= end
- dot
- 1;
656 if (plugin_len
== 0 || component_len
== 0) {
660 *plugin
= g_malloc0(plugin_len
+ 1);
666 g_strlcpy(*plugin
, arg
, plugin_len
+ 1);
667 *component
= g_malloc0(component_len
+ 1);
673 g_strlcpy(*component
, dot
+ 1, component_len
+ 1);
680 * Prints the Babeltrace version.
683 void print_version(void)
685 puts("Babeltrace " VERSION
);
689 * Prints the legacy, Babeltrace 1.x command usage. Those options are
690 * still compatible in Babeltrace 2.x, but it is recommended to use
691 * the more generic plugin/component parameters instead of those
692 * hard-coded option names.
695 void print_legacy_usage(FILE *fp
)
697 fprintf(fp
, "Usage: babeltrace [OPTIONS] INPUT...\n");
699 fprintf(fp
, "The following options are compatible with the Babeltrace 1.x options:\n");
701 fprintf(fp
, " --help-legacy Show this help\n");
702 fprintf(fp
, " -V, --version Show version\n");
703 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently correlated\n");
704 fprintf(fp
, " across traces\n");
705 fprintf(fp
, " -d, --debug Enable debug mode\n");
706 fprintf(fp
, " -i, --input-format=FORMAT Input trace format (default: ctf)\n");
707 fprintf(fp
, " -l, --list List available formats\n");
708 fprintf(fp
, " -o, --output-format=FORMAT Output trace format (default: text)\n");
709 fprintf(fp
, " -v, --verbose Enable verbose output\n");
711 fprintf(fp
, " Available input formats: ctf, lttng-live, ctf-metadata\n");
712 fprintf(fp
, " Available output formats: text, dummy\n");
714 fprintf(fp
, "Input formats specific options:\n");
716 fprintf(fp
, " INPUT... Input trace file(s), directory(ies), or URLs\n");
717 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
718 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n");
719 fprintf(fp
, " --stream-intersection Only process events when all streams are active\n");
721 fprintf(fp
, "text output format specific options:\n");
723 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
724 fprintf(fp
, " --clock-date Print timestamp dates\n");
725 fprintf(fp
, " --clock-gmt Print and parse timestamps in GMT time zone\n");
726 fprintf(fp
, " (default: local time zone)\n");
727 fprintf(fp
, " --clock-seconds Print the timestamps as [SEC.NS]\n");
728 fprintf(fp
, " (default format: [HH:MM:SS.NS])\n");
729 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
730 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
731 fprintf(fp
, " --debug-info-full-path Show full debug info source and binary paths\n");
732 fprintf(fp
, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n");
733 fprintf(fp
, " up executables during debug info analysis\n");
734 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
735 fprintf(fp
, " -f, --fields=NAME[,NAME]... Print additional fields:\n");
736 fprintf(fp
, " all, trace, trace:hostname, trace:domain,\n");
737 fprintf(fp
, " trace:procname, trace:vpid, loglevel, emf\n");
738 fprintf(fp
, " (default: trace:hostname, trace:procname,\n");
739 fprintf(fp
, " trace:vpid)\n");
740 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names:\n");
741 fprintf(fp
, " payload (or arg or args)\n");
742 fprintf(fp
, " none, all, scope, header, context (or ctx)\n");
743 fprintf(fp
, " (default: payload, context)\n");
744 fprintf(fp
, " --no-delta Do not print time delta between consecutive\n");
745 fprintf(fp
, " events\n");
746 fprintf(fp
, " -w, --output=PATH Write output to PATH (default: standard output)\n");
750 * Prints the Babeltrace 2.x usage.
753 void print_usage(FILE *fp
)
755 fprintf(fp
, "Usage: babeltrace [OPTIONS]\n");
757 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
758 fprintf(fp
, " of the following source and sink component\n");
759 fprintf(fp
, " instances (see the exact format of PARAMS\n");
760 fprintf(fp
, " below)\n");
761 fprintf(fp
, " -d, --debug Enable debug mode\n");
762 fprintf(fp
, " -l, --list List available plugins and their components\n");
763 fprintf(fp
, " -P, --path=PATH Set the `path` parameter of the latest source\n");
764 fprintf(fp
, " or sink component to PATH\n");
765 fprintf(fp
, " -p, --params=PARAMS Set the parameters of the latest source or\n");
766 fprintf(fp
, " sink component instance (in command-line \n");
767 fprintf(fp
, " order) to PARAMS (see the exact format of\n");
768 fprintf(fp
, " PARAMS below)\n");
769 fprintf(fp
, " --plugin-path=PATH[:PATH]... Set paths from which dynamic plugins can be\n");
770 fprintf(fp
, " loaded to PATH\n");
771 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters of the\n");
772 fprintf(fp
, " following source and sink component\n");
773 fprintf(fp
, " instances to an empty map\n");
774 fprintf(fp
, " -o, --sink=PLUGIN.COMPCLS Instantiate a sink component from plugin\n");
775 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
776 fprintf(fp
, " repeated)\n");
777 fprintf(fp
, " -i, --source=PLUGIN.COMPCLS Instantiate a source component from plugin\n");
778 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
779 fprintf(fp
, " repeated)\n");
780 fprintf(fp
, " -h --help Show this help\n");
781 fprintf(fp
, " --help-legacy Show Babeltrace 1.x legacy options\n");
782 fprintf(fp
, " -v, --verbose Enable verbose output\n");
783 fprintf(fp
, " -V, --version Show version\n");
785 fprintf(fp
, "Format of PARAMS\n");
786 fprintf(fp
, "----------------\n");
788 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
790 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
791 fprintf(fp
, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
792 fprintf(fp
, "VALUE can be one of:\n");
794 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
795 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
796 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
797 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
798 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
799 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
800 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
801 fprintf(fp
, " the null and boolean value symbols above.\n");
802 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
804 fprintf(fp
, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
806 fprintf(fp
, "Example:\n");
808 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
809 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
810 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
812 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
813 fprintf(fp
, "from a shell.\n");
817 * Destroys a component configuration.
820 void bt_config_component_destroy(struct bt_object
*obj
)
822 struct bt_config_component
*bt_config_component
=
823 container_of(obj
, struct bt_config_component
, base
);
829 if (bt_config_component
->plugin_name
) {
830 g_string_free(bt_config_component
->plugin_name
, TRUE
);
833 if (bt_config_component
->component_name
) {
834 g_string_free(bt_config_component
->component_name
, TRUE
);
837 BT_PUT(bt_config_component
->params
);
838 g_free(bt_config_component
);
845 * Creates a component configuration using the given plugin name and
846 * component name. plugin_name and component_name are copied (belong to
849 * Return value is owned by the caller.
852 struct bt_config_component
*bt_config_component_create(const char *plugin_name
,
853 const char *component_name
)
855 struct bt_config_component
*cfg_component
= NULL
;
857 cfg_component
= g_new0(struct bt_config_component
, 1);
858 if (!cfg_component
) {
863 bt_object_init(cfg_component
, bt_config_component_destroy
);
864 cfg_component
->plugin_name
= g_string_new(plugin_name
);
865 if (!cfg_component
->plugin_name
) {
870 cfg_component
->component_name
= g_string_new(component_name
);
871 if (!cfg_component
->component_name
) {
876 /* Start with empty parameters */
877 cfg_component
->params
= bt_value_map_create();
878 if (!cfg_component
->params
) {
886 BT_PUT(cfg_component
);
889 return cfg_component
;
893 * Creates a component configuration from a command-line source/sink
897 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
899 struct bt_config_component
*bt_config_component
= NULL
;
901 char *component_name
;
903 plugin_component_names_from_arg(arg
, &plugin_name
, &component_name
);
904 if (!plugin_name
|| !component_name
) {
905 printf_err("Cannot get plugin or component class name\n");
909 bt_config_component
= bt_config_component_create(plugin_name
,
911 if (!bt_config_component
) {
918 BT_PUT(bt_config_component
);
922 g_free(component_name
);
923 return bt_config_component
;
927 * Destroys a configuration.
930 void bt_config_destroy(struct bt_object
*obj
)
932 struct bt_config
*bt_config
=
933 container_of(obj
, struct bt_config
, base
);
939 if (bt_config
->sources
) {
940 g_ptr_array_free(bt_config
->sources
, TRUE
);
943 if (bt_config
->sinks
) {
944 g_ptr_array_free(bt_config
->sinks
, TRUE
);
947 BT_PUT(bt_config
->plugin_paths
);
955 * Extracts the various paths from the string arg, delimited by ':',
956 * and converts them to an array value object.
958 * Returned array value object is empty if arg is empty.
960 * Return value is owned by the caller.
963 struct bt_value
*plugin_paths_from_arg(const char *arg
)
965 struct bt_value
*plugin_paths
;
966 const char *at
= arg
;
967 const char *end
= arg
+ strlen(arg
);
969 plugin_paths
= bt_value_array_create();
978 const char *next_colon
;
980 next_colon
= strchr(at
, ':');
981 if (next_colon
== at
) {
983 * Empty path: try next character (supported
984 * to conform to the typical parsing of $PATH).
988 } else if (!next_colon
) {
989 /* No more colon: use the remaining */
990 next_colon
= arg
+ strlen(arg
);
993 path
= g_string_new(NULL
);
999 g_string_append_len(path
, at
, next_colon
- at
);
1000 at
= next_colon
+ 1;
1001 ret
= bt_value_array_append_string(plugin_paths
, path
->str
);
1002 g_string_free(path
, TRUE
);
1012 BT_PUT(plugin_paths
);
1015 return plugin_paths
;
1019 * Creates a simple lexical scanner for parsing comma-delimited names
1022 * Return value is owned by the caller.
1025 GScanner
*create_csv_identifiers_scanner(void)
1027 GScannerConfig scanner_config
= {
1028 .cset_skip_characters
= " \t\n",
1029 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
1030 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
1031 .case_sensitive
= TRUE
,
1032 .cpair_comment_single
= NULL
,
1033 .skip_comment_multi
= TRUE
,
1034 .skip_comment_single
= TRUE
,
1035 .scan_comment_multi
= FALSE
,
1036 .scan_identifier
= TRUE
,
1037 .scan_identifier_1char
= TRUE
,
1038 .scan_identifier_NULL
= FALSE
,
1039 .scan_symbols
= FALSE
,
1040 .symbol_2_token
= FALSE
,
1041 .scope_0_fallback
= FALSE
,
1042 .scan_binary
= FALSE
,
1043 .scan_octal
= FALSE
,
1044 .scan_float
= FALSE
,
1046 .scan_hex_dollar
= FALSE
,
1047 .numbers_2_int
= FALSE
,
1048 .int_2_float
= FALSE
,
1049 .store_int64
= FALSE
,
1050 .scan_string_sq
= FALSE
,
1051 .scan_string_dq
= FALSE
,
1052 .identifier_2_string
= FALSE
,
1053 .char_2_token
= TRUE
,
1056 return g_scanner_new(&scanner_config
);
1060 * Inserts a string (if exists and not empty) or null to a map value
1064 enum bt_value_status
map_insert_string_or_null(struct bt_value
*map
,
1065 const char *key
, GString
*string
)
1067 enum bt_value_status ret
;
1069 if (string
&& string
->len
> 0) {
1070 ret
= bt_value_map_insert_string(map
, key
, string
->str
);
1072 ret
= bt_value_map_insert(map
, key
, bt_value_null
);
1078 * Converts a comma-delimited list of known names (--names option) to
1079 * an array value object containing those names as string value objects.
1081 * Return value is owned by the caller.
1084 struct bt_value
*names_from_arg(const char *arg
)
1086 GScanner
*scanner
= NULL
;
1087 struct bt_value
*names
= NULL
;
1088 bool found_all
= false, found_none
= false, found_item
= false;
1090 names
= bt_value_array_create();
1096 scanner
= create_csv_identifiers_scanner();
1102 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1105 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1107 switch (token_type
) {
1108 case G_TOKEN_IDENTIFIER
:
1110 const char *identifier
= scanner
->value
.v_identifier
;
1112 if (!strcmp(identifier
, "payload") ||
1113 !strcmp(identifier
, "args") ||
1114 !strcmp(identifier
, "arg")) {
1116 if (bt_value_array_append_string(names
,
1120 } else if (!strcmp(identifier
, "context") ||
1121 !strcmp(identifier
, "ctx")) {
1123 if (bt_value_array_append_string(names
,
1127 } else if (!strcmp(identifier
, "scope") ||
1128 !strcmp(identifier
, "header")) {
1130 if (bt_value_array_append_string(names
,
1134 } else if (!strcmp(identifier
, "all")) {
1136 if (bt_value_array_append_string(names
,
1140 } else if (!strcmp(identifier
, "none")) {
1142 if (bt_value_array_append_string(names
,
1147 printf_err("Unknown field name: `%s`\n",
1163 if (found_none
&& found_all
) {
1164 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1168 * Legacy behavior is to clear the defaults (show none) when at
1169 * least one item is specified.
1171 if (found_item
&& !found_none
&& !found_all
) {
1172 if (bt_value_array_append_string(names
, "none")) {
1177 g_scanner_destroy(scanner
);
1184 g_scanner_destroy(scanner
);
1191 * Converts a comma-delimited list of known fields (--fields option) to
1192 * an array value object containing those fields as string
1195 * Return value is owned by the caller.
1198 struct bt_value
*fields_from_arg(const char *arg
)
1200 GScanner
*scanner
= NULL
;
1201 struct bt_value
*fields
;
1203 fields
= bt_value_array_create();
1209 scanner
= create_csv_identifiers_scanner();
1215 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1218 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1220 switch (token_type
) {
1221 case G_TOKEN_IDENTIFIER
:
1223 const char *identifier
= scanner
->value
.v_identifier
;
1225 if (!strcmp(identifier
, "trace") ||
1226 !strcmp(identifier
, "trace:hostname") ||
1227 !strcmp(identifier
, "trace:domain") ||
1228 !strcmp(identifier
, "trace:procname") ||
1229 !strcmp(identifier
, "trace:vpid") ||
1230 !strcmp(identifier
, "loglevel") ||
1231 !strcmp(identifier
, "emf") ||
1232 !strcmp(identifier
, "callsite") ||
1233 !strcmp(identifier
, "all")) {
1234 if (bt_value_array_append_string(fields
,
1239 printf_err("Unknown field name: `%s`\n",
1261 g_scanner_destroy(scanner
);
1267 * Inserts the equivalent "prefix-name" true boolean value objects into
1268 * map_obj where the names are in array_obj.
1271 int insert_flat_names_fields_from_array(struct bt_value
*map_obj
,
1272 struct bt_value
*array_obj
, const char *prefix
)
1276 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1279 * array_obj may be NULL if no CLI options were specified to
1280 * trigger its creation.
1286 tmpstr
= g_string_new(NULL
);
1293 default_value
= g_string_new(NULL
);
1294 if (!default_value
) {
1300 for (i
= 0; i
< bt_value_array_size(array_obj
); i
++) {
1301 struct bt_value
*str_obj
= bt_value_array_get(array_obj
, i
);
1303 bool is_default
= false;
1306 printf_err("Unexpected error\n");
1311 ret
= bt_value_string_get(str_obj
, &suffix
);
1314 printf_err("Unexpected error\n");
1318 g_string_assign(tmpstr
, prefix
);
1319 g_string_append(tmpstr
, "-");
1321 /* Special-case for "all" and "none". */
1322 if (!strcmp(suffix
, "all")) {
1324 g_string_assign(default_value
, "show");
1325 } else if (!strcmp(suffix
, "none")) {
1327 g_string_assign(default_value
, "hide");
1330 g_string_append(tmpstr
, "default");
1331 ret
= map_insert_string_or_null(map_obj
,
1339 g_string_append(tmpstr
, suffix
);
1340 ret
= bt_value_map_insert_bool(map_obj
, tmpstr
->str
,
1350 if (default_value
) {
1351 g_string_free(default_value
, TRUE
);
1354 g_string_free(tmpstr
, TRUE
);
1361 * Returns the parameters (map value object) corresponding to the
1362 * legacy text format options.
1364 * Return value is owned by the caller.
1367 struct bt_value
*params_from_text_legacy_opts(
1368 struct text_legacy_opts
*text_legacy_opts
)
1370 struct bt_value
*params
;
1372 params
= bt_value_map_create();
1378 if (map_insert_string_or_null(params
, "output-path",
1379 text_legacy_opts
->output
)) {
1384 if (map_insert_string_or_null(params
, "debug-info-dir",
1385 text_legacy_opts
->dbg_info_dir
)) {
1390 if (map_insert_string_or_null(params
, "debug-info-target-prefix",
1391 text_legacy_opts
->dbg_info_target_prefix
)) {
1396 if (bt_value_map_insert_bool(params
, "debug-info-full-path",
1397 text_legacy_opts
->dbg_info_full_path
)) {
1402 if (bt_value_map_insert_bool(params
, "no-delta",
1403 text_legacy_opts
->no_delta
)) {
1408 if (bt_value_map_insert_bool(params
, "clock-cycles",
1409 text_legacy_opts
->clock_cycles
)) {
1414 if (bt_value_map_insert_bool(params
, "clock-seconds",
1415 text_legacy_opts
->clock_seconds
)) {
1420 if (bt_value_map_insert_bool(params
, "clock-date",
1421 text_legacy_opts
->clock_date
)) {
1426 if (bt_value_map_insert_bool(params
, "clock-gmt",
1427 text_legacy_opts
->clock_gmt
)) {
1432 if (insert_flat_names_fields_from_array(params
,
1433 text_legacy_opts
->names
, "name")) {
1437 if (insert_flat_names_fields_from_array(params
,
1438 text_legacy_opts
->fields
, "field")) {
1452 int append_sinks_from_legacy_opts(GPtrArray
*sinks
,
1453 enum legacy_output_format legacy_output_format
,
1454 struct text_legacy_opts
*text_legacy_opts
)
1457 struct bt_value
*params
= NULL
;
1458 const char *plugin_name
;
1459 const char *component_name
;
1460 struct bt_config_component
*bt_config_component
= NULL
;
1462 switch (legacy_output_format
) {
1463 case LEGACY_OUTPUT_FORMAT_TEXT
:
1464 plugin_name
= "text";
1465 component_name
= "text";
1467 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1468 plugin_name
= "ctf";
1469 component_name
= "metadata-text";
1471 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1472 plugin_name
= "dummy";
1473 component_name
= "dummy";
1480 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
) {
1481 /* Legacy "text" output format has parameters */
1482 params
= params_from_text_legacy_opts(text_legacy_opts
);
1488 * Legacy "dummy" and "ctf-metadata" output formats do
1489 * not have parameters.
1491 params
= bt_value_map_create();
1498 /* Create a component configuration */
1499 bt_config_component
= bt_config_component_create(plugin_name
,
1501 if (!bt_config_component
) {
1505 BT_MOVE(bt_config_component
->params
, params
);
1507 /* Move created component configuration to the array */
1508 g_ptr_array_add(sinks
, bt_config_component
);
1522 * Returns the parameters (map value object) corresponding to the
1523 * given legacy CTF format options.
1525 * Return value is owned by the caller.
1528 struct bt_value
*params_from_ctf_legacy_opts(
1529 struct ctf_legacy_opts
*ctf_legacy_opts
)
1531 struct bt_value
*params
;
1533 params
= bt_value_map_create();
1539 if (bt_value_map_insert_integer(params
, "offset-s",
1540 ctf_legacy_opts
->offset_s
.value
)) {
1545 if (bt_value_map_insert_integer(params
, "offset-ns",
1546 ctf_legacy_opts
->offset_ns
.value
)) {
1551 if (bt_value_map_insert_bool(params
, "stream-intersection",
1552 ctf_legacy_opts
->stream_intersection
)) {
1567 int append_sources_from_legacy_opts(GPtrArray
*sources
,
1568 enum legacy_input_format legacy_input_format
,
1569 struct ctf_legacy_opts
*ctf_legacy_opts
,
1570 struct bt_value
*legacy_input_paths
)
1574 struct bt_value
*base_params
;
1575 struct bt_value
*params
= NULL
;
1576 struct bt_value
*input_path
= NULL
;
1577 struct bt_value
*input_path_copy
= NULL
;
1578 const char *input_key
;
1579 const char *component_name
;
1581 switch (legacy_input_format
) {
1582 case LEGACY_INPUT_FORMAT_CTF
:
1584 component_name
= "fs";
1586 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1588 component_name
= "lttng-live";
1595 base_params
= params_from_ctf_legacy_opts(ctf_legacy_opts
);
1600 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1601 struct bt_config_component
*bt_config_component
= NULL
;
1603 /* Copy base parameters as current parameters */
1604 params
= bt_value_copy(base_params
);
1609 /* Get current input path string value object */
1610 input_path
= bt_value_array_get(legacy_input_paths
, i
);
1615 /* Copy current input path value object */
1616 input_path_copy
= bt_value_copy(input_path
);
1617 if (!input_path_copy
) {
1621 /* Insert input path value object into current parameters */
1622 ret
= bt_value_map_insert(params
, input_key
, input_path_copy
);
1627 /* Create a component configuration */
1628 bt_config_component
= bt_config_component_create("ctf",
1630 if (!bt_config_component
) {
1634 BT_MOVE(bt_config_component
->params
, params
);
1636 /* Move created component configuration to the array */
1637 g_ptr_array_add(sources
, bt_config_component
);
1639 /* Put current stuff */
1641 BT_PUT(input_path_copy
);
1650 BT_PUT(base_params
);
1653 BT_PUT(input_path_copy
);
1658 * Escapes a string for the shell. The string is escaped knowing that
1659 * it's a parameter string value (double-quoted), and that it will be
1660 * entered between single quotes in the shell.
1662 * Return value is owned by the caller.
1665 char *str_shell_escape(const char *input
)
1668 const char *at
= input
;
1669 GString
*str
= g_string_new(NULL
);
1675 while (*at
!= '\0') {
1678 g_string_append(str
, "\\\\");
1681 g_string_append(str
, "\\\"");
1684 g_string_append(str
, "'\"'\"'");
1687 g_string_append(str
, "\\n");
1690 g_string_append(str
, "\\t");
1693 g_string_append_c(str
, *at
);
1703 g_string_free(str
, FALSE
);
1710 int append_prefixed_flag_params(GString
*str
, struct bt_value
*flags
,
1720 for (i
= 0; i
< bt_value_array_size(flags
); i
++) {
1721 struct bt_value
*value
= bt_value_array_get(flags
, i
);
1729 if (bt_value_string_get(value
, &flag
)) {
1735 g_string_append_printf(str
, ",%s-%s=true", prefix
, flag
);
1744 * Appends a boolean parameter string.
1747 void g_string_append_bool_param(GString
*str
, const char *name
, bool value
)
1749 g_string_append_printf(str
, ",%s=%s", name
, value
? "true" : "false");
1753 * Appends a path parameter string, or null if it's empty.
1756 int g_string_append_string_path_param(GString
*str
, const char *name
,
1761 if (path
->len
> 0) {
1762 char *escaped_path
= str_shell_escape(path
->str
);
1764 if (!escaped_path
) {
1769 g_string_append_printf(str
, "%s=\"%s\"", name
, escaped_path
);
1772 g_string_append_printf(str
, "%s=null", name
);
1785 * Prints the non-legacy sink options equivalent to the specified
1786 * legacy output format options.
1789 void print_output_legacy_to_sinks(
1790 enum legacy_output_format legacy_output_format
,
1791 struct text_legacy_opts
*text_legacy_opts
)
1793 const char *input_format
;
1794 GString
*str
= NULL
;
1796 str
= g_string_new(" ");
1802 switch (legacy_output_format
) {
1803 case LEGACY_OUTPUT_FORMAT_TEXT
:
1804 input_format
= "text";
1806 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1807 input_format
= "ctf-metadata";
1809 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1810 input_format
= "dummy";
1816 printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
1818 printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
1820 g_string_append(str
, "-o ");
1822 switch (legacy_output_format
) {
1823 case LEGACY_OUTPUT_FORMAT_TEXT
:
1824 g_string_append(str
, "text.text");
1826 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1827 g_string_append(str
, "ctf.metadata-text");
1829 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1830 g_string_append(str
, "dummy.dummy");
1836 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
&&
1837 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1840 g_string_append(str
, " -p '");
1842 if (g_string_append_string_path_param(str
, "output-path",
1843 text_legacy_opts
->output
)) {
1847 g_string_append(str
, ",");
1849 if (g_string_append_string_path_param(str
, "debug-info-dir",
1850 text_legacy_opts
->dbg_info_dir
)) {
1854 g_string_append(str
, ",");
1856 if (g_string_append_string_path_param(str
,
1857 "debug-info-target-prefix",
1858 text_legacy_opts
->dbg_info_target_prefix
)) {
1862 g_string_append_bool_param(str
, "no-delta",
1863 text_legacy_opts
->no_delta
);
1864 g_string_append_bool_param(str
, "clock-cycles",
1865 text_legacy_opts
->clock_cycles
);
1866 g_string_append_bool_param(str
, "clock-seconds",
1867 text_legacy_opts
->clock_seconds
);
1868 g_string_append_bool_param(str
, "clock-date",
1869 text_legacy_opts
->clock_date
);
1870 g_string_append_bool_param(str
, "clock-gmt",
1871 text_legacy_opts
->clock_gmt
);
1872 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->names
,
1878 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->fields
,
1884 /* Remove last comma and close single quote */
1885 g_string_append(str
, "'");
1888 printf_err("%s\n\n", str
->str
);
1892 g_string_free(str
, TRUE
);
1898 * Prints the non-legacy source options equivalent to the specified
1899 * legacy input format options.
1902 void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format
,
1903 struct bt_value
*legacy_input_paths
,
1904 struct ctf_legacy_opts
*ctf_legacy_opts
)
1906 const char *input_format
;
1907 GString
*str
= NULL
;
1910 str
= g_string_new(" ");
1916 switch (legacy_input_format
) {
1917 case LEGACY_INPUT_FORMAT_CTF
:
1918 input_format
= "ctf";
1920 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1921 input_format
= "lttng-live";
1927 printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
1929 printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
1932 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1933 struct bt_value
*input_value
=
1934 bt_value_array_get(legacy_input_paths
, i
);
1935 const char *input
= NULL
;
1936 char *escaped_input
;
1939 assert(input_value
);
1940 ret
= bt_value_string_get(input_value
, &input
);
1941 BT_PUT(input_value
);
1942 assert(!ret
&& input
);
1943 escaped_input
= str_shell_escape(input
);
1944 if (!escaped_input
) {
1949 g_string_append(str
, "-i ctf.");
1951 switch (legacy_input_format
) {
1952 case LEGACY_INPUT_FORMAT_CTF
:
1953 g_string_append(str
, "fs -p 'path=\"");
1955 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1956 g_string_append(str
, "lttng-live -p 'url=\"");
1962 g_string_append(str
, escaped_input
);
1963 g_string_append(str
, "\"");
1964 g_string_append_printf(str
, ",offset-s=%" PRId64
,
1965 ctf_legacy_opts
->offset_s
.value
);
1966 g_string_append_printf(str
, ",offset-ns=%" PRId64
,
1967 ctf_legacy_opts
->offset_ns
.value
);
1968 g_string_append_bool_param(str
, "stream-intersection",
1969 ctf_legacy_opts
->stream_intersection
);
1970 g_string_append(str
, "' ");
1971 g_free(escaped_input
);
1974 printf_err("%s\n\n", str
->str
);
1978 g_string_free(str
, TRUE
);
1984 * Validates a given configuration, with optional legacy input and
1985 * output formats options. Prints useful error messages if anything
1988 * Returns true when the configuration is valid.
1991 bool validate_cfg(struct bt_config
*cfg
,
1992 enum legacy_input_format
*legacy_input_format
,
1993 enum legacy_output_format
*legacy_output_format
,
1994 struct bt_value
*legacy_input_paths
,
1995 struct ctf_legacy_opts
*ctf_legacy_opts
,
1996 struct text_legacy_opts
*text_legacy_opts
)
1998 bool legacy_input
= false;
1999 bool legacy_output
= false;
2001 /* Determine if the input and output should be legacy-style */
2002 if (*legacy_input_format
!= LEGACY_INPUT_FORMAT_NONE
||
2003 cfg
->sources
->len
== 0 ||
2004 !bt_value_array_is_empty(legacy_input_paths
) ||
2005 ctf_legacy_opts_is_any_set(ctf_legacy_opts
)) {
2006 legacy_input
= true;
2009 if (*legacy_output_format
!= LEGACY_OUTPUT_FORMAT_NONE
||
2010 cfg
->sinks
->len
== 0 ||
2011 text_legacy_opts_is_any_set(text_legacy_opts
)) {
2012 legacy_output
= true;
2016 /* If no legacy input format was specified, default to CTF */
2017 if (*legacy_input_format
== LEGACY_INPUT_FORMAT_NONE
) {
2018 *legacy_input_format
= LEGACY_INPUT_FORMAT_CTF
;
2021 /* Make sure at least one input path exists */
2022 if (bt_value_array_is_empty(legacy_input_paths
)) {
2023 switch (*legacy_input_format
) {
2024 case LEGACY_INPUT_FORMAT_CTF
:
2025 printf_err("No input path specified for legacy `ctf` input format\n");
2027 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
2028 printf_err("No URL specified for legacy `lttng-live` input format\n");
2036 /* Make sure no non-legacy sources are specified */
2037 if (cfg
->sources
->len
!= 0) {
2038 print_input_legacy_to_sources(*legacy_input_format
,
2039 legacy_input_paths
, ctf_legacy_opts
);
2044 if (legacy_output
) {
2046 * If no legacy output format was specified, default to
2049 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_NONE
) {
2050 *legacy_output_format
= LEGACY_OUTPUT_FORMAT_TEXT
;
2054 * If any "text" option was specified, the output must be
2057 if (text_legacy_opts_is_any_set(text_legacy_opts
) &&
2058 *legacy_output_format
!=
2059 LEGACY_OUTPUT_FORMAT_TEXT
) {
2060 printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
2064 /* Make sure no non-legacy sinks are specified */
2065 if (cfg
->sinks
->len
!= 0) {
2066 print_output_legacy_to_sinks(*legacy_output_format
,
2073 * If the output is the legacy "ctf-metadata" format, then the
2074 * input should be the legacy "ctf" input format.
2076 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_CTF_METADATA
&&
2077 *legacy_input_format
!= LEGACY_INPUT_FORMAT_CTF
) {
2078 printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
2089 * Parses a 64-bit signed integer.
2091 * Returns a negative value if anything goes wrong.
2094 int parse_int64(const char *arg
, int64_t *val
)
2099 *val
= strtoll(arg
, &endptr
, 0);
2100 if (*endptr
!= '\0' || arg
== endptr
|| errno
!= 0) {
2113 OPT_CLOCK_FORCE_CORRELATE
,
2116 OPT_CLOCK_OFFSET_NS
,
2120 OPT_DEBUG_INFO_FULL_PATH
,
2121 OPT_DEBUG_INFO_TARGET_PREFIX
,
2134 OPT_RESET_BASE_PARAMS
,
2137 OPT_STREAM_INTERSECTION
,
2142 /* popt long option descriptions */
2143 static struct poptOption long_options
[] = {
2144 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2145 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
2146 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2147 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2148 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2149 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2150 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2151 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2152 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2153 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2154 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2155 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2156 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2157 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2158 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2159 { "help-legacy", '\0', POPT_ARG_NONE
, NULL
, OPT_HELP_LEGACY
, NULL
, NULL
},
2160 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2161 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
2162 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2163 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2164 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_PATH
, NULL
, NULL
},
2165 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2166 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2167 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2168 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2169 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
2170 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2171 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2172 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2173 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2174 { "version", 'V', POPT_ARG_NONE
, NULL
, OPT_VERSION
, NULL
, NULL
},
2175 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2179 * Sets the value of a given legacy offset option and marks it as set.
2181 static void set_offset_value(struct offset_opt
*offset_opt
, int64_t value
)
2183 offset_opt
->value
= value
;
2184 offset_opt
->is_set
= true;
2187 enum bt_config_component_dest
{
2188 BT_CONFIG_COMPONENT_DEST_SOURCE
,
2189 BT_CONFIG_COMPONENT_DEST_SINK
,
2193 * Adds a configuration component to the appropriate configuration
2194 * array depending on the destination.
2196 static void add_cfg_comp(struct bt_config
*cfg
,
2197 struct bt_config_component
*cfg_comp
,
2198 enum bt_config_component_dest dest
)
2200 if (dest
== BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2201 g_ptr_array_add(cfg
->sources
, cfg_comp
);
2203 g_ptr_array_add(cfg
->sinks
, cfg_comp
);
2208 * Returns a Babeltrace configuration, out of command-line arguments,
2209 * containing everything that is needed to instanciate specific
2210 * components with given parameters.
2212 * *exit_code is set to the appropriate exit code to use as far as this
2215 * Return value is NULL on error, otherwise it's owned by the caller.
2217 struct bt_config
*bt_config_from_args(int argc
, const char *argv
[], int *exit_code
)
2219 struct bt_config
*cfg
= NULL
;
2220 poptContext pc
= NULL
;
2222 struct ctf_legacy_opts ctf_legacy_opts
;
2223 struct text_legacy_opts text_legacy_opts
;
2224 enum legacy_input_format legacy_input_format
= LEGACY_INPUT_FORMAT_NONE
;
2225 enum legacy_output_format legacy_output_format
=
2226 LEGACY_OUTPUT_FORMAT_NONE
;
2227 struct bt_value
*legacy_input_paths
= NULL
;
2228 struct bt_config_component
*cur_cfg_comp
= NULL
;
2229 enum bt_config_component_dest cur_cfg_comp_dest
=
2230 BT_CONFIG_COMPONENT_DEST_SOURCE
;
2231 struct bt_value
*cur_base_params
= NULL
;
2233 bool cur_cfg_comp_params_set
= false;
2235 memset(&ctf_legacy_opts
, 0, sizeof(ctf_legacy_opts
));
2236 memset(&text_legacy_opts
, 0, sizeof(text_legacy_opts
));
2240 print_usage(stdout
);
2244 text_legacy_opts
.output
= g_string_new(NULL
);
2245 if (!text_legacy_opts
.output
) {
2250 text_legacy_opts
.dbg_info_dir
= g_string_new(NULL
);
2251 if (!text_legacy_opts
.dbg_info_dir
) {
2256 text_legacy_opts
.dbg_info_target_prefix
= g_string_new(NULL
);
2257 if (!text_legacy_opts
.dbg_info_target_prefix
) {
2262 cur_base_params
= bt_value_map_create();
2263 if (!cur_base_params
) {
2269 cfg
= g_new0(struct bt_config
, 1);
2275 bt_object_init(cfg
, bt_config_destroy
);
2276 cfg
->sources
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2277 if (!cfg
->sources
) {
2282 cfg
->sinks
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2288 legacy_input_paths
= bt_value_array_create();
2289 if (!legacy_input_paths
) {
2295 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
2297 printf_err("Cannot get popt context\n");
2301 poptReadDefaultConfig(pc
, 0);
2303 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2304 arg
= poptGetOptArg(pc
);
2307 case OPT_PLUGIN_PATH
:
2308 if (cfg
->plugin_paths
) {
2309 printf_err("Duplicate --plugin-path option\n");
2313 cfg
->plugin_paths
= plugin_paths_from_arg(arg
);
2314 if (!cfg
->plugin_paths
) {
2315 printf_err("Invalid --plugin-path option's argument\n");
2319 case OPT_OUTPUT_PATH
:
2320 if (text_legacy_opts
.output
->len
> 0) {
2321 printf_err("Duplicate --output option\n");
2325 g_string_assign(text_legacy_opts
.output
, arg
);
2327 case OPT_DEBUG_INFO_DIR
:
2328 if (text_legacy_opts
.dbg_info_dir
->len
> 0) {
2329 printf_err("Duplicate --debug-info-dir option\n");
2333 g_string_assign(text_legacy_opts
.dbg_info_dir
, arg
);
2335 case OPT_DEBUG_INFO_TARGET_PREFIX
:
2336 if (text_legacy_opts
.dbg_info_target_prefix
->len
> 0) {
2337 printf_err("Duplicate --debug-info-target-prefix option\n");
2341 g_string_assign(text_legacy_opts
.dbg_info_target_prefix
, arg
);
2343 case OPT_INPUT_FORMAT
:
2346 if (opt
== OPT_INPUT_FORMAT
) {
2347 if (!strcmp(arg
, "ctf")) {
2348 /* Legacy CTF input format */
2349 if (legacy_input_format
) {
2350 print_err_dup_legacy_input();
2354 legacy_input_format
=
2355 LEGACY_INPUT_FORMAT_CTF
;
2357 } else if (!strcmp(arg
, "lttng-live")) {
2358 /* Legacy LTTng-live input format */
2359 if (legacy_input_format
) {
2360 print_err_dup_legacy_input();
2364 legacy_input_format
=
2365 LEGACY_INPUT_FORMAT_LTTNG_LIVE
;
2370 /* Non-legacy: try to create a component config */
2372 add_cfg_comp(cfg
, cur_cfg_comp
,
2376 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2377 if (!cur_cfg_comp
) {
2378 printf_err("Invalid format for --source option's argument:\n %s\n",
2383 assert(cur_base_params
);
2384 bt_put(cur_cfg_comp
->params
);
2385 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2386 if (!cur_cfg_comp
) {
2391 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2392 cur_cfg_comp_params_set
= false;
2395 case OPT_OUTPUT_FORMAT
:
2398 if (opt
== OPT_OUTPUT_FORMAT
) {
2399 if (!strcmp(arg
, "text")) {
2400 /* Legacy CTF-text output format */
2401 if (legacy_output_format
) {
2402 print_err_dup_legacy_output();
2406 legacy_output_format
=
2407 LEGACY_OUTPUT_FORMAT_TEXT
;
2409 } else if (!strcmp(arg
, "dummy")) {
2410 /* Legacy dummy output format */
2411 if (legacy_output_format
) {
2412 print_err_dup_legacy_output();
2416 legacy_output_format
=
2417 LEGACY_OUTPUT_FORMAT_DUMMY
;
2419 } else if (!strcmp(arg
, "ctf-metadata")) {
2420 /* Legacy CTF-metadata output format */
2421 if (legacy_output_format
) {
2422 print_err_dup_legacy_output();
2426 legacy_output_format
=
2427 LEGACY_OUTPUT_FORMAT_CTF_METADATA
;
2432 /* Non-legacy: try to create a component config */
2434 add_cfg_comp(cfg
, cur_cfg_comp
,
2438 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2439 if (!cur_cfg_comp
) {
2440 printf_err("Invalid format for --sink option's argument:\n %s\n",
2445 assert(cur_base_params
);
2446 bt_put(cur_cfg_comp
->params
);
2447 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2448 if (!cur_cfg_comp
) {
2453 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2454 cur_cfg_comp_params_set
= false;
2459 struct bt_value
*params
;
2460 struct bt_value
*params_to_set
;
2462 if (!cur_cfg_comp
) {
2463 printf_err("--params option must follow a --source or --sink option\n");
2467 if (cur_cfg_comp_params_set
) {
2468 printf_err("Duplicate --params option for the same current component\ninstance (class %s.%s)\n",
2469 cur_cfg_comp
->plugin_name
->str
,
2470 cur_cfg_comp
->component_name
->str
);
2474 params
= bt_value_from_arg(arg
);
2476 printf_err("Invalid format for --params option's argument:\n %s\n",
2481 params_to_set
= bt_value_map_extend(cur_base_params
,
2484 if (!params_to_set
) {
2485 printf_err("Cannot extend current base parameters with --params option's argument:\n %s\n",
2490 BT_MOVE(cur_cfg_comp
->params
, params_to_set
);
2491 cur_cfg_comp_params_set
= true;
2495 if (!cur_cfg_comp
) {
2496 printf_err("--path option must follow a --source or --sink option\n");
2500 assert(cur_cfg_comp
->params
);
2502 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2508 case OPT_BASE_PARAMS
:
2510 struct bt_value
*params
= bt_value_from_arg(arg
);
2513 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2518 BT_MOVE(cur_base_params
, params
);
2521 case OPT_RESET_BASE_PARAMS
:
2522 BT_PUT(cur_base_params
);
2523 cur_base_params
= bt_value_map_create();
2524 if (!cur_base_params
) {
2530 if (text_legacy_opts
.names
) {
2531 printf_err("Duplicate --names option\n");
2535 text_legacy_opts
.names
= names_from_arg(arg
);
2536 if (!text_legacy_opts
.names
) {
2537 printf_err("Invalid --names option's argument\n");
2542 if (text_legacy_opts
.fields
) {
2543 printf_err("Duplicate --fields option\n");
2547 text_legacy_opts
.fields
= fields_from_arg(arg
);
2548 if (!text_legacy_opts
.fields
) {
2549 printf_err("Invalid --fields option's argument\n");
2554 text_legacy_opts
.no_delta
= true;
2556 case OPT_CLOCK_CYCLES
:
2557 text_legacy_opts
.clock_cycles
= true;
2559 case OPT_CLOCK_SECONDS
:
2560 text_legacy_opts
.clock_seconds
= true;
2562 case OPT_CLOCK_DATE
:
2563 text_legacy_opts
.clock_date
= true;
2566 text_legacy_opts
.clock_gmt
= true;
2568 case OPT_DEBUG_INFO_FULL_PATH
:
2569 text_legacy_opts
.dbg_info_full_path
= true;
2571 case OPT_CLOCK_OFFSET
:
2575 if (ctf_legacy_opts
.offset_s
.is_set
) {
2576 printf_err("Duplicate --clock-offset option\n");
2580 if (parse_int64(arg
, &val
)) {
2581 printf_err("Invalid --clock-offset option's argument\n");
2585 set_offset_value(&ctf_legacy_opts
.offset_s
, val
);
2588 case OPT_CLOCK_OFFSET_NS
:
2592 if (ctf_legacy_opts
.offset_ns
.is_set
) {
2593 printf_err("Duplicate --clock-offset-ns option\n");
2597 if (parse_int64(arg
, &val
)) {
2598 printf_err("Invalid --clock-offset-ns option's argument\n");
2602 set_offset_value(&ctf_legacy_opts
.offset_ns
, val
);
2605 case OPT_STREAM_INTERSECTION
:
2606 ctf_legacy_opts
.stream_intersection
= true;
2608 case OPT_CLOCK_FORCE_CORRELATE
:
2609 cfg
->force_correlate
= true;
2613 print_usage(stdout
);
2615 case OPT_HELP_LEGACY
:
2617 print_legacy_usage(stdout
);
2624 cfg
->do_list
= true;
2627 cfg
->verbose
= true;
2633 printf_err("Unknown command-line option specified (option code %d)\n",
2642 /* Append current component configuration, if any */
2644 add_cfg_comp(cfg
, cur_cfg_comp
, cur_cfg_comp_dest
);
2645 cur_cfg_comp
= NULL
;
2648 /* Check for option parsing error */
2650 printf_err("While parsing command-line options, at option %s: %s\n",
2651 poptBadOption(pc
, 0), poptStrerror(opt
));
2655 /* Consume leftover arguments as legacy input paths */
2657 const char *input_path
= poptGetArg(pc
);
2663 if (bt_value_array_append_string(legacy_input_paths
,
2670 /* Validate legacy/non-legacy options */
2671 if (!validate_cfg(cfg
, &legacy_input_format
, &legacy_output_format
,
2672 legacy_input_paths
, &ctf_legacy_opts
,
2673 &text_legacy_opts
)) {
2674 printf_err("Command-line options form an invalid configuration\n");
2679 * If there's a legacy input format, convert it to source
2680 * component configurations.
2682 if (legacy_input_format
) {
2683 if (append_sources_from_legacy_opts(cfg
->sources
,
2684 legacy_input_format
, &ctf_legacy_opts
,
2685 legacy_input_paths
)) {
2686 printf_err("Cannot convert legacy input format options to source component instance(s)\n");
2692 * If there's a legacy output format, convert it to sink
2693 * component configurations.
2695 if (legacy_output_format
) {
2696 if (append_sinks_from_legacy_opts(cfg
->sinks
,
2697 legacy_output_format
, &text_legacy_opts
)) {
2698 printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
2712 poptFreeContext(pc
);
2715 if (text_legacy_opts
.output
) {
2716 g_string_free(text_legacy_opts
.output
, TRUE
);
2719 if (text_legacy_opts
.dbg_info_dir
) {
2720 g_string_free(text_legacy_opts
.dbg_info_dir
, TRUE
);
2723 if (text_legacy_opts
.dbg_info_target_prefix
) {
2724 g_string_free(text_legacy_opts
.dbg_info_target_prefix
, TRUE
);
2728 BT_PUT(cur_cfg_comp
);
2729 BT_PUT(cur_base_params
);
2730 BT_PUT(text_legacy_opts
.names
);
2731 BT_PUT(text_legacy_opts
.fields
);
2732 BT_PUT(legacy_input_paths
);