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 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
, " callsite\n");
739 fprintf(fp
, " (default: trace:hostname, trace:procname,\n");
740 fprintf(fp
, " trace:vpid)\n");
741 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names:\n");
742 fprintf(fp
, " payload (or arg or args)\n");
743 fprintf(fp
, " none, all, scope, header, context (or ctx)\n");
744 fprintf(fp
, " (default: payload, context)\n");
745 fprintf(fp
, " --no-delta Do not print time delta between consecutive\n");
746 fprintf(fp
, " events\n");
747 fprintf(fp
, " -w, --output=PATH Write output to PATH (default: standard output)\n");
751 * Prints the Babeltrace 2.x usage.
754 void print_usage(FILE *fp
)
756 fprintf(fp
, "Usage: babeltrace [OPTIONS]\n");
758 fprintf(fp
, " -d, --debug Enable debug mode\n");
759 fprintf(fp
, " -i, --source=PLUGIN.COMPCLS Instantiate a source component from plugin\n");
760 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
761 fprintf(fp
, " repeated)\n");
762 fprintf(fp
, " -l, --list List available plugins and their components\n");
763 fprintf(fp
, " -o, --sink=PLUGIN.COMPCLS Instantiate a sink component from plugin\n");
764 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
765 fprintf(fp
, " repeated)\n");
766 fprintf(fp
, " -P, --plugin-path=PATH[:PATH]... Set paths from which dynamic plugins can be\n");
767 fprintf(fp
, " loaded to PATH\n");
768 fprintf(fp
, " -p, --params=PARAMS Set the parameters of the latest source or\n");
769 fprintf(fp
, " sink instance (in command-line order) to\n");
770 fprintf(fp
, " PARAMS (see the exact format below)\n");
771 fprintf(fp
, " -h --help Show this help\n");
772 fprintf(fp
, " --help-legacy Show Babeltrace 1.x legacy options\n");
773 fprintf(fp
, " -v, --verbose Enable verbose output\n");
774 fprintf(fp
, " -V, --version Show version\n");
776 fprintf(fp
, "Format of the --params option's argument\n");
777 fprintf(fp
, "----------------------------------------\n");
779 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
781 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
782 fprintf(fp
, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
783 fprintf(fp
, "VALUE can be one of:\n");
785 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
786 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
787 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
788 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
789 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
790 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
791 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
792 fprintf(fp
, " the null and boolean value symbols above.\n");
793 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
795 fprintf(fp
, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
797 fprintf(fp
, "Example:\n");
799 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
800 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
801 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
803 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
804 fprintf(fp
, "from a shell.\n");
808 * Destroys a component configuration.
811 void bt_config_component_destroy(struct bt_object
*obj
)
813 struct bt_config_component
*bt_config_component
=
814 container_of(obj
, struct bt_config_component
, base
);
820 if (bt_config_component
->plugin_name
) {
821 g_string_free(bt_config_component
->plugin_name
, TRUE
);
824 if (bt_config_component
->component_name
) {
825 g_string_free(bt_config_component
->component_name
, TRUE
);
828 BT_PUT(bt_config_component
->params
);
829 g_free(bt_config_component
);
836 * Creates a component configuration using the given plugin name and
837 * component name. plugin_name and component_name are copied (belong to
840 * Return value is owned by the caller.
843 struct bt_config_component
*bt_config_component_create(const char *plugin_name
,
844 const char *component_name
)
846 struct bt_config_component
*cfg_component
= NULL
;
848 cfg_component
= g_new0(struct bt_config_component
, 1);
849 if (!cfg_component
) {
854 bt_object_init(cfg_component
, bt_config_component_destroy
);
855 cfg_component
->plugin_name
= g_string_new(plugin_name
);
856 if (!cfg_component
->plugin_name
) {
861 cfg_component
->component_name
= g_string_new(component_name
);
862 if (!cfg_component
->component_name
) {
867 /* Start with empty parameters */
868 cfg_component
->params
= bt_value_map_create();
869 if (!cfg_component
->params
) {
877 BT_PUT(cfg_component
);
880 return cfg_component
;
884 * Creates a component configuration from a command-line source/sink
888 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
890 struct bt_config_component
*bt_config_component
= NULL
;
892 char *component_name
;
894 plugin_component_names_from_arg(arg
, &plugin_name
, &component_name
);
895 if (!plugin_name
|| !component_name
) {
896 printf_err("Cannot get plugin or component name\n");
900 bt_config_component
= bt_config_component_create(plugin_name
,
902 if (!bt_config_component
) {
909 BT_PUT(bt_config_component
);
913 g_free(component_name
);
914 return bt_config_component
;
918 * Destroys a configuration.
921 void bt_config_destroy(struct bt_object
*obj
)
923 struct bt_config
*bt_config
=
924 container_of(obj
, struct bt_config
, base
);
930 if (bt_config
->sources
) {
931 g_ptr_array_free(bt_config
->sources
, TRUE
);
934 if (bt_config
->sinks
) {
935 g_ptr_array_free(bt_config
->sinks
, TRUE
);
938 BT_PUT(bt_config
->plugin_paths
);
946 * Extracts the various paths from the string arg, delimited by ':',
947 * and converts them to an array value object.
949 * Returned array value object is empty if arg is empty.
951 * Return value is owned by the caller.
954 struct bt_value
*plugin_paths_from_arg(const char *arg
)
956 struct bt_value
*plugin_paths
;
957 const char *at
= arg
;
958 const char *end
= arg
+ strlen(arg
);
960 plugin_paths
= bt_value_array_create();
969 const char *next_colon
;
971 next_colon
= strchr(at
, ':');
972 if (next_colon
== at
) {
974 * Empty path: try next character (supported
975 * to conform to the typical parsing of $PATH).
979 } else if (!next_colon
) {
980 /* No more colon: use the remaining */
981 next_colon
= arg
+ strlen(arg
);
984 path
= g_string_new(NULL
);
990 g_string_append_len(path
, at
, next_colon
- at
);
992 ret
= bt_value_array_append_string(plugin_paths
, path
->str
);
993 g_string_free(path
, TRUE
);
1003 BT_PUT(plugin_paths
);
1006 return plugin_paths
;
1010 * Creates a simple lexical scanner for parsing comma-delimited names
1013 * Return value is owned by the caller.
1016 GScanner
*create_csv_identifiers_scanner(void)
1018 GScannerConfig scanner_config
= {
1019 .cset_skip_characters
= " \t\n",
1020 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
1021 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
1022 .case_sensitive
= TRUE
,
1023 .cpair_comment_single
= NULL
,
1024 .skip_comment_multi
= TRUE
,
1025 .skip_comment_single
= TRUE
,
1026 .scan_comment_multi
= FALSE
,
1027 .scan_identifier
= TRUE
,
1028 .scan_identifier_1char
= TRUE
,
1029 .scan_identifier_NULL
= FALSE
,
1030 .scan_symbols
= FALSE
,
1031 .symbol_2_token
= FALSE
,
1032 .scope_0_fallback
= FALSE
,
1033 .scan_binary
= FALSE
,
1034 .scan_octal
= FALSE
,
1035 .scan_float
= FALSE
,
1037 .scan_hex_dollar
= FALSE
,
1038 .numbers_2_int
= FALSE
,
1039 .int_2_float
= FALSE
,
1040 .store_int64
= FALSE
,
1041 .scan_string_sq
= FALSE
,
1042 .scan_string_dq
= FALSE
,
1043 .identifier_2_string
= FALSE
,
1044 .char_2_token
= TRUE
,
1047 return g_scanner_new(&scanner_config
);
1051 * Inserts a string (if exists and not empty) or null to a map value
1055 enum bt_value_status
map_insert_string_or_null(struct bt_value
*map
,
1056 const char *key
, GString
*string
)
1058 enum bt_value_status ret
;
1060 if (string
&& string
->len
> 0) {
1061 ret
= bt_value_map_insert_string(map
, key
, string
->str
);
1063 ret
= bt_value_map_insert(map
, key
, bt_value_null
);
1069 * Converts a comma-delimited list of known names (--names option) to
1070 * an array value object containing those names as string value objects.
1072 * Return value is owned by the caller.
1075 struct bt_value
*names_from_arg(const char *arg
)
1077 GScanner
*scanner
= NULL
;
1078 struct bt_value
*names
= NULL
;
1079 bool found_all
= false, found_none
= false, found_item
= false;
1081 names
= bt_value_array_create();
1087 scanner
= create_csv_identifiers_scanner();
1093 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1096 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1098 switch (token_type
) {
1099 case G_TOKEN_IDENTIFIER
:
1101 const char *identifier
= scanner
->value
.v_identifier
;
1103 if (!strcmp(identifier
, "payload") ||
1104 !strcmp(identifier
, "args") ||
1105 !strcmp(identifier
, "arg")) {
1107 if (bt_value_array_append_string(names
,
1111 } else if (!strcmp(identifier
, "context") ||
1112 !strcmp(identifier
, "ctx")) {
1114 if (bt_value_array_append_string(names
,
1118 } else if (!strcmp(identifier
, "scope") ||
1119 !strcmp(identifier
, "header")) {
1121 if (bt_value_array_append_string(names
,
1125 } else if (!strcmp(identifier
, "all")) {
1127 if (bt_value_array_append_string(names
,
1131 } else if (!strcmp(identifier
, "none")) {
1133 if (bt_value_array_append_string(names
,
1138 printf_err("Unknown field name: \"%s\"\n",
1154 if (found_none
&& found_all
) {
1155 printf_err("Only either \"all\" or \"none\" can be specified in the list given to the \"--names\" option, but not both.\n");
1159 * Legacy behavior is to clear the defaults (show none) when at
1160 * least one item is specified.
1162 if (found_item
&& !found_none
&& !found_all
) {
1163 if (bt_value_array_append_string(names
, "none")) {
1168 g_scanner_destroy(scanner
);
1175 g_scanner_destroy(scanner
);
1182 * Converts a comma-delimited list of known fields (--fields option) to
1183 * an array value object containing those fields as string
1186 * Return value is owned by the caller.
1189 struct bt_value
*fields_from_arg(const char *arg
)
1191 GScanner
*scanner
= NULL
;
1192 struct bt_value
*fields
;
1194 fields
= bt_value_array_create();
1200 scanner
= create_csv_identifiers_scanner();
1206 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1209 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1211 switch (token_type
) {
1212 case G_TOKEN_IDENTIFIER
:
1214 const char *identifier
= scanner
->value
.v_identifier
;
1216 if (!strcmp(identifier
, "trace") ||
1217 !strcmp(identifier
, "trace:hostname") ||
1218 !strcmp(identifier
, "trace:domain") ||
1219 !strcmp(identifier
, "trace:procname") ||
1220 !strcmp(identifier
, "trace:vpid") ||
1221 !strcmp(identifier
, "loglevel") ||
1222 !strcmp(identifier
, "emf") ||
1223 !strcmp(identifier
, "callsite") ||
1224 !strcmp(identifier
, "all")) {
1225 if (bt_value_array_append_string(fields
,
1230 printf_err("Unknown field name: \"%s\"\n",
1252 g_scanner_destroy(scanner
);
1258 * Inserts the equivalent "prefix-name" true boolean value objects into
1259 * map_obj where the names are in array_obj.
1262 int insert_flat_names_fields_from_array(struct bt_value
*map_obj
,
1263 struct bt_value
*array_obj
, const char *prefix
)
1267 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1270 * array_obj may be NULL if no CLI options were specified to
1271 * trigger its creation.
1277 tmpstr
= g_string_new(NULL
);
1284 default_value
= g_string_new(NULL
);
1285 if (!default_value
) {
1291 for (i
= 0; i
< bt_value_array_size(array_obj
); i
++) {
1292 struct bt_value
*str_obj
= bt_value_array_get(array_obj
, i
);
1294 bool is_default
= false;
1297 printf_err("Unexpected error\n");
1302 ret
= bt_value_string_get(str_obj
, &suffix
);
1305 printf_err("Unexpected error\n");
1309 g_string_assign(tmpstr
, prefix
);
1310 g_string_append(tmpstr
, "-");
1312 /* Special-case for "all" and "none". */
1313 if (!strcmp(suffix
, "all")) {
1315 g_string_assign(default_value
, "show");
1316 } else if (!strcmp(suffix
, "none")) {
1318 g_string_assign(default_value
, "hide");
1321 g_string_append(tmpstr
, "default");
1322 ret
= map_insert_string_or_null(map_obj
,
1330 g_string_append(tmpstr
, suffix
);
1331 ret
= bt_value_map_insert_bool(map_obj
, tmpstr
->str
,
1341 if (default_value
) {
1342 g_string_free(default_value
, TRUE
);
1345 g_string_free(tmpstr
, TRUE
);
1352 * Returns the parameters (map value object) corresponding to the
1353 * legacy text format options.
1355 * Return value is owned by the caller.
1358 struct bt_value
*params_from_text_legacy_opts(
1359 struct text_legacy_opts
*text_legacy_opts
)
1361 struct bt_value
*params
;
1363 params
= bt_value_map_create();
1369 if (map_insert_string_or_null(params
, "output-path",
1370 text_legacy_opts
->output
)) {
1375 if (map_insert_string_or_null(params
, "debug-info-dir",
1376 text_legacy_opts
->dbg_info_dir
)) {
1381 if (map_insert_string_or_null(params
, "debug-info-target-prefix",
1382 text_legacy_opts
->dbg_info_target_prefix
)) {
1387 if (bt_value_map_insert_bool(params
, "debug-info-full-path",
1388 text_legacy_opts
->dbg_info_full_path
)) {
1393 if (bt_value_map_insert_bool(params
, "no-delta",
1394 text_legacy_opts
->no_delta
)) {
1399 if (bt_value_map_insert_bool(params
, "clock-cycles",
1400 text_legacy_opts
->clock_cycles
)) {
1405 if (bt_value_map_insert_bool(params
, "clock-seconds",
1406 text_legacy_opts
->clock_seconds
)) {
1411 if (bt_value_map_insert_bool(params
, "clock-date",
1412 text_legacy_opts
->clock_date
)) {
1417 if (bt_value_map_insert_bool(params
, "clock-gmt",
1418 text_legacy_opts
->clock_gmt
)) {
1423 if (insert_flat_names_fields_from_array(params
,
1424 text_legacy_opts
->names
, "name")) {
1428 if (insert_flat_names_fields_from_array(params
,
1429 text_legacy_opts
->fields
, "field")) {
1443 int append_sinks_from_legacy_opts(GPtrArray
*sinks
,
1444 enum legacy_output_format legacy_output_format
,
1445 struct text_legacy_opts
*text_legacy_opts
)
1448 struct bt_value
*params
= NULL
;
1449 const char *plugin_name
;
1450 const char *component_name
;
1451 struct bt_config_component
*bt_config_component
= NULL
;
1453 switch (legacy_output_format
) {
1454 case LEGACY_OUTPUT_FORMAT_TEXT
:
1455 plugin_name
= "text";
1456 component_name
= "text";
1458 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1459 plugin_name
= "ctf";
1460 component_name
= "metadata-text";
1462 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1463 plugin_name
= "dummy";
1464 component_name
= "dummy";
1471 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
) {
1472 /* Legacy "text" output format has parameters */
1473 params
= params_from_text_legacy_opts(text_legacy_opts
);
1479 * Legacy "dummy" and "ctf-metadata" output formats do
1480 * not have parameters.
1482 params
= bt_value_map_create();
1489 /* Create a component configuration */
1490 bt_config_component
= bt_config_component_create(plugin_name
,
1492 if (!bt_config_component
) {
1496 BT_MOVE(bt_config_component
->params
, params
);
1498 /* Move created component configuration to the array */
1499 g_ptr_array_add(sinks
, bt_config_component
);
1513 * Returns the parameters (map value object) corresponding to the
1514 * given legacy CTF format options.
1516 * Return value is owned by the caller.
1519 struct bt_value
*params_from_ctf_legacy_opts(
1520 struct ctf_legacy_opts
*ctf_legacy_opts
)
1522 struct bt_value
*params
;
1524 params
= bt_value_map_create();
1530 if (bt_value_map_insert_integer(params
, "offset-s",
1531 ctf_legacy_opts
->offset_s
.value
)) {
1536 if (bt_value_map_insert_integer(params
, "offset-ns",
1537 ctf_legacy_opts
->offset_ns
.value
)) {
1542 if (bt_value_map_insert_bool(params
, "stream-intersection",
1543 ctf_legacy_opts
->stream_intersection
)) {
1558 int append_sources_from_legacy_opts(GPtrArray
*sources
,
1559 enum legacy_input_format legacy_input_format
,
1560 struct ctf_legacy_opts
*ctf_legacy_opts
,
1561 struct bt_value
*legacy_input_paths
)
1565 struct bt_value
*base_params
;
1566 struct bt_value
*params
= NULL
;
1567 struct bt_value
*input_path
= NULL
;
1568 struct bt_value
*input_path_copy
= NULL
;
1569 const char *input_key
;
1570 const char *component_name
;
1572 switch (legacy_input_format
) {
1573 case LEGACY_INPUT_FORMAT_CTF
:
1575 component_name
= "fs";
1577 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1579 component_name
= "lttng-live";
1586 base_params
= params_from_ctf_legacy_opts(ctf_legacy_opts
);
1591 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1592 struct bt_config_component
*bt_config_component
= NULL
;
1594 /* Copy base parameters as current parameters */
1595 params
= bt_value_copy(base_params
);
1600 /* Get current input path string value object */
1601 input_path
= bt_value_array_get(legacy_input_paths
, i
);
1606 /* Copy current input path value object */
1607 input_path_copy
= bt_value_copy(input_path
);
1608 if (!input_path_copy
) {
1612 /* Insert input path value object into current parameters */
1613 ret
= bt_value_map_insert(params
, input_key
, input_path_copy
);
1618 /* Create a component configuration */
1619 bt_config_component
= bt_config_component_create("ctf",
1621 if (!bt_config_component
) {
1625 BT_MOVE(bt_config_component
->params
, params
);
1627 /* Move created component configuration to the array */
1628 g_ptr_array_add(sources
, bt_config_component
);
1630 /* Put current stuff */
1632 BT_PUT(input_path_copy
);
1641 BT_PUT(base_params
);
1644 BT_PUT(input_path_copy
);
1649 * Escapes a string for the shell. The string is escaped knowing that
1650 * it's a parameter string value (double-quoted), and that it will be
1651 * entered between single quotes in the shell.
1653 * Return value is owned by the caller.
1656 char *str_shell_escape(const char *input
)
1659 const char *at
= input
;
1660 GString
*str
= g_string_new(NULL
);
1666 while (*at
!= '\0') {
1669 g_string_append(str
, "\\\\");
1672 g_string_append(str
, "\\\"");
1675 g_string_append(str
, "'\"'\"'");
1678 g_string_append(str
, "\\n");
1681 g_string_append(str
, "\\t");
1684 g_string_append_c(str
, *at
);
1694 g_string_free(str
, FALSE
);
1701 int append_prefixed_flag_params(GString
*str
, struct bt_value
*flags
,
1711 for (i
= 0; i
< bt_value_array_size(flags
); i
++) {
1712 struct bt_value
*value
= bt_value_array_get(flags
, i
);
1720 if (bt_value_string_get(value
, &flag
)) {
1726 g_string_append_printf(str
, ",%s-%s=true", prefix
, flag
);
1735 * Appends a boolean parameter string.
1738 void g_string_append_bool_param(GString
*str
, const char *name
, bool value
)
1740 g_string_append_printf(str
, ",%s=%s", name
, value
? "true" : "false");
1744 * Appends a path parameter string, or null if it's empty.
1747 int g_string_append_string_path_param(GString
*str
, const char *name
,
1752 if (path
->len
> 0) {
1753 char *escaped_path
= str_shell_escape(path
->str
);
1755 if (!escaped_path
) {
1760 g_string_append_printf(str
, "%s=\"%s\"", name
, escaped_path
);
1763 g_string_append_printf(str
, "%s=null", name
);
1776 * Prints the non-legacy sink options equivalent to the specified
1777 * legacy output format options.
1780 void print_output_legacy_to_sinks(
1781 enum legacy_output_format legacy_output_format
,
1782 struct text_legacy_opts
*text_legacy_opts
)
1784 const char *input_format
;
1785 GString
*str
= NULL
;
1787 str
= g_string_new(" ");
1793 switch (legacy_output_format
) {
1794 case LEGACY_OUTPUT_FORMAT_TEXT
:
1795 input_format
= "text";
1797 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1798 input_format
= "ctf-metadata";
1800 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1801 input_format
= "dummy";
1807 printf_err("Both \"%s\" legacy output format and non-legacy sink(s) specified.\n\n",
1809 printf_err("Specify the following non-legacy sink instead of the legacy \"%s\"\noutput format options:\n\n",
1811 g_string_append(str
, "-o ");
1813 switch (legacy_output_format
) {
1814 case LEGACY_OUTPUT_FORMAT_TEXT
:
1815 g_string_append(str
, "text.text");
1817 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1818 g_string_append(str
, "ctf.metadata-text");
1820 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1821 g_string_append(str
, "dummy.dummy");
1827 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
&&
1828 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1831 g_string_append(str
, " -p '");
1833 if (g_string_append_string_path_param(str
, "output-path",
1834 text_legacy_opts
->output
)) {
1838 g_string_append(str
, ",");
1840 if (g_string_append_string_path_param(str
, "debug-info-dir",
1841 text_legacy_opts
->dbg_info_dir
)) {
1845 g_string_append(str
, ",");
1847 if (g_string_append_string_path_param(str
,
1848 "debug-info-target-prefix",
1849 text_legacy_opts
->dbg_info_target_prefix
)) {
1853 g_string_append_bool_param(str
, "no-delta",
1854 text_legacy_opts
->no_delta
);
1855 g_string_append_bool_param(str
, "clock-cycles",
1856 text_legacy_opts
->clock_cycles
);
1857 g_string_append_bool_param(str
, "clock-seconds",
1858 text_legacy_opts
->clock_seconds
);
1859 g_string_append_bool_param(str
, "clock-date",
1860 text_legacy_opts
->clock_date
);
1861 g_string_append_bool_param(str
, "clock-gmt",
1862 text_legacy_opts
->clock_gmt
);
1863 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->names
,
1869 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->fields
,
1875 /* Remove last comma and close single quote */
1876 g_string_append(str
, "'");
1879 printf_err("%s\n\n", str
->str
);
1883 g_string_free(str
, TRUE
);
1889 * Prints the non-legacy source options equivalent to the specified
1890 * legacy input format options.
1893 void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format
,
1894 struct bt_value
*legacy_input_paths
,
1895 struct ctf_legacy_opts
*ctf_legacy_opts
)
1897 const char *input_format
;
1898 GString
*str
= NULL
;
1901 str
= g_string_new(" ");
1907 switch (legacy_input_format
) {
1908 case LEGACY_INPUT_FORMAT_CTF
:
1909 input_format
= "ctf";
1911 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1912 input_format
= "lttng-live";
1918 printf_err("Both \"%s\" legacy input format and non-legacy source(s) specified.\n\n",
1920 printf_err("Specify the following non-legacy source(s) instead of the legacy \"%s\"\ninput format options and positional arguments:\n\n",
1923 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1924 struct bt_value
*input_value
=
1925 bt_value_array_get(legacy_input_paths
, i
);
1926 const char *input
= NULL
;
1927 char *escaped_input
;
1930 assert(input_value
);
1931 ret
= bt_value_string_get(input_value
, &input
);
1932 BT_PUT(input_value
);
1933 assert(!ret
&& input
);
1934 escaped_input
= str_shell_escape(input
);
1935 if (!escaped_input
) {
1940 g_string_append(str
, "-i ctf.");
1942 switch (legacy_input_format
) {
1943 case LEGACY_INPUT_FORMAT_CTF
:
1944 g_string_append(str
, "fs -p 'path=\"");
1946 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1947 g_string_append(str
, "lttng-live -p 'url=\"");
1953 g_string_append(str
, escaped_input
);
1954 g_string_append(str
, "\"");
1955 g_string_append_printf(str
, ",offset-s=%" PRId64
,
1956 ctf_legacy_opts
->offset_s
.value
);
1957 g_string_append_printf(str
, ",offset-ns=%" PRId64
,
1958 ctf_legacy_opts
->offset_ns
.value
);
1959 g_string_append_bool_param(str
, "stream-intersection",
1960 ctf_legacy_opts
->stream_intersection
);
1961 g_string_append(str
, "' ");
1962 g_free(escaped_input
);
1965 printf_err("%s\n\n", str
->str
);
1969 g_string_free(str
, TRUE
);
1975 * Validates a given configuration, with optional legacy input and
1976 * output formats options. Prints useful error messages if anything
1979 * Returns true when the configuration is valid.
1982 bool validate_cfg(struct bt_config
*cfg
,
1983 enum legacy_input_format
*legacy_input_format
,
1984 enum legacy_output_format
*legacy_output_format
,
1985 struct bt_value
*legacy_input_paths
,
1986 struct ctf_legacy_opts
*ctf_legacy_opts
,
1987 struct text_legacy_opts
*text_legacy_opts
)
1989 bool legacy_input
= false;
1990 bool legacy_output
= false;
1992 /* Determine if the input and output should be legacy-style */
1993 if (*legacy_input_format
!= LEGACY_INPUT_FORMAT_NONE
||
1994 cfg
->sources
->len
== 0 ||
1995 !bt_value_array_is_empty(legacy_input_paths
) ||
1996 ctf_legacy_opts_is_any_set(ctf_legacy_opts
)) {
1997 legacy_input
= true;
2000 if (*legacy_output_format
!= LEGACY_OUTPUT_FORMAT_NONE
||
2001 cfg
->sinks
->len
== 0 ||
2002 text_legacy_opts_is_any_set(text_legacy_opts
)) {
2003 legacy_output
= true;
2007 /* If no legacy input format was specified, default to CTF */
2008 if (*legacy_input_format
== LEGACY_INPUT_FORMAT_NONE
) {
2009 *legacy_input_format
= LEGACY_INPUT_FORMAT_CTF
;
2012 /* Make sure at least one input path exists */
2013 if (bt_value_array_is_empty(legacy_input_paths
)) {
2014 switch (*legacy_input_format
) {
2015 case LEGACY_INPUT_FORMAT_CTF
:
2016 printf_err("No input path specified for legacy \"ctf\" input format\n");
2018 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
2019 printf_err("No URL specified for legacy \"lttng-live\" input format\n");
2027 /* Make sure no non-legacy sources are specified */
2028 if (cfg
->sources
->len
!= 0) {
2029 print_input_legacy_to_sources(*legacy_input_format
,
2030 legacy_input_paths
, ctf_legacy_opts
);
2035 if (legacy_output
) {
2037 * If no legacy output format was specified, default to
2040 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_NONE
) {
2041 *legacy_output_format
= LEGACY_OUTPUT_FORMAT_TEXT
;
2045 * If any "text" option was specified, the output must be
2048 if (text_legacy_opts_is_any_set(text_legacy_opts
) &&
2049 *legacy_output_format
!=
2050 LEGACY_OUTPUT_FORMAT_TEXT
) {
2051 printf_err("Options for legacy \"text\" output format specified with a different legacy output format\n");
2055 /* Make sure no non-legacy sinks are specified */
2056 if (cfg
->sinks
->len
!= 0) {
2057 print_output_legacy_to_sinks(*legacy_output_format
,
2064 * If the output is the legacy "ctf-metadata" format, then the
2065 * input should be the legacy "ctf" input format.
2067 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_CTF_METADATA
&&
2068 *legacy_input_format
!= LEGACY_INPUT_FORMAT_CTF
) {
2069 printf_err("Legacy \"ctf-metadata\" output format requires using legacy \"ctf\" input format\n");
2080 * Parses a 64-bit signed integer.
2082 * Returns a negative value if anything goes wrong.
2085 int parse_int64(const char *arg
, int64_t *val
)
2090 *val
= strtoll(arg
, &endptr
, 0);
2091 if (*endptr
!= '\0' || arg
== endptr
|| errno
!= 0) {
2103 OPT_CLOCK_FORCE_CORRELATE
,
2106 OPT_CLOCK_OFFSET_NS
,
2110 OPT_DEBUG_INFO_FULL_PATH
,
2111 OPT_DEBUG_INFO_TARGET_PREFIX
,
2125 OPT_STREAM_INTERSECTION
,
2130 /* popt long option descriptions */
2131 static struct poptOption long_options
[] = {
2132 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2133 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2134 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2135 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2136 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2137 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2138 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2139 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2140 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2141 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2142 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2143 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2144 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2145 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2146 { "help-legacy", '\0', POPT_ARG_NONE
, NULL
, OPT_HELP_LEGACY
, NULL
, NULL
},
2147 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2148 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
2149 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2150 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2151 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_PATH
, NULL
, NULL
},
2152 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2153 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2154 { "plugin-path", 'P', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2155 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2156 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2157 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2158 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2159 { "version", 'V', POPT_ARG_NONE
, NULL
, OPT_VERSION
, NULL
, NULL
},
2160 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2164 * Sets the value of a given legacy offset option and marks it as set.
2166 static void set_offset_value(struct offset_opt
*offset_opt
, int64_t value
)
2168 offset_opt
->value
= value
;
2169 offset_opt
->is_set
= true;
2172 enum bt_config_component_dest
{
2173 BT_CONFIG_COMPONENT_DEST_SOURCE
,
2174 BT_CONFIG_COMPONENT_DEST_SINK
,
2178 * Adds a configuration component to the appropriate configuration
2179 * array depending on the destination.
2181 static void add_cfg_comp(struct bt_config
*cfg
,
2182 struct bt_config_component
*cfg_comp
,
2183 enum bt_config_component_dest dest
)
2185 if (dest
== BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2186 g_ptr_array_add(cfg
->sources
, cfg_comp
);
2188 g_ptr_array_add(cfg
->sinks
, cfg_comp
);
2193 * Returns a Babeltrace configuration, out of command-line arguments,
2194 * containing everything that is needed to instanciate specific
2195 * components with given parameters.
2197 * *exit_code is set to the appropriate exit code to use as far as this
2200 * Return value is NULL on error, otherwise it's owned by the caller.
2202 struct bt_config
*bt_config_from_args(int argc
, char *argv
[], int *exit_code
)
2204 struct bt_config
*cfg
= NULL
;
2205 poptContext pc
= NULL
;
2207 struct ctf_legacy_opts ctf_legacy_opts
= { 0 };
2208 struct text_legacy_opts text_legacy_opts
= { 0 };
2209 enum legacy_input_format legacy_input_format
= LEGACY_INPUT_FORMAT_NONE
;
2210 enum legacy_output_format legacy_output_format
=
2211 LEGACY_OUTPUT_FORMAT_NONE
;
2212 struct bt_value
*legacy_input_paths
= NULL
;
2213 struct bt_config_component
*cur_cfg_comp
= NULL
;
2214 enum bt_config_component_dest cur_cfg_comp_dest
=
2215 BT_CONFIG_COMPONENT_DEST_SOURCE
;
2217 bool cur_cfg_comp_params_set
= false;
2222 print_usage(stdout
);
2226 text_legacy_opts
.output
= g_string_new(NULL
);
2227 if (!text_legacy_opts
.output
) {
2232 text_legacy_opts
.dbg_info_dir
= g_string_new(NULL
);
2233 if (!text_legacy_opts
.dbg_info_dir
) {
2238 text_legacy_opts
.dbg_info_target_prefix
= g_string_new(NULL
);
2239 if (!text_legacy_opts
.dbg_info_target_prefix
) {
2245 cfg
= g_new0(struct bt_config
, 1);
2251 bt_object_init(cfg
, bt_config_destroy
);
2252 cfg
->sources
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2253 if (!cfg
->sources
) {
2258 cfg
->sinks
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2264 legacy_input_paths
= bt_value_array_create();
2265 if (!legacy_input_paths
) {
2271 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
2273 printf_err("Cannot get popt context\n");
2277 poptReadDefaultConfig(pc
, 0);
2279 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2280 arg
= poptGetOptArg(pc
);
2283 case OPT_PLUGIN_PATH
:
2284 if (cfg
->plugin_paths
) {
2285 printf_err("Duplicate --plugin-path option\n");
2289 cfg
->plugin_paths
= plugin_paths_from_arg(arg
);
2290 if (!cfg
->plugin_paths
) {
2291 printf_err("Invalid --plugin-path option's argument\n");
2295 case OPT_OUTPUT_PATH
:
2296 if (text_legacy_opts
.output
->len
> 0) {
2297 printf_err("Duplicate --output option\n");
2301 g_string_assign(text_legacy_opts
.output
, arg
);
2303 case OPT_DEBUG_INFO_DIR
:
2304 if (text_legacy_opts
.dbg_info_dir
->len
> 0) {
2305 printf_err("Duplicate --debug-info-dir option\n");
2309 g_string_assign(text_legacy_opts
.dbg_info_dir
, arg
);
2311 case OPT_DEBUG_INFO_TARGET_PREFIX
:
2312 if (text_legacy_opts
.dbg_info_target_prefix
->len
> 0) {
2313 printf_err("Duplicate --debug-info-target-prefix option\n");
2317 g_string_assign(text_legacy_opts
.dbg_info_target_prefix
, arg
);
2319 case OPT_INPUT_FORMAT
:
2322 if (opt
== OPT_INPUT_FORMAT
) {
2323 if (!strcmp(arg
, "ctf")) {
2324 /* Legacy CTF input format */
2325 if (legacy_input_format
) {
2326 print_err_dup_legacy_input();
2330 legacy_input_format
=
2331 LEGACY_INPUT_FORMAT_CTF
;
2333 } else if (!strcmp(arg
, "lttng-live")) {
2334 /* Legacy LTTng-live input format */
2335 if (legacy_input_format
) {
2336 print_err_dup_legacy_input();
2340 legacy_input_format
=
2341 LEGACY_INPUT_FORMAT_LTTNG_LIVE
;
2346 /* Non-legacy: try to create a component config */
2348 add_cfg_comp(cfg
, cur_cfg_comp
,
2352 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2353 if (!cur_cfg_comp
) {
2354 printf_err("Invalid source component format:\n %s\n",
2359 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2360 cur_cfg_comp_params_set
= false;
2363 case OPT_OUTPUT_FORMAT
:
2366 if (opt
== OPT_OUTPUT_FORMAT
) {
2367 if (!strcmp(arg
, "text")) {
2368 /* Legacy CTF-text output format */
2369 if (legacy_output_format
) {
2370 print_err_dup_legacy_output();
2374 legacy_output_format
=
2375 LEGACY_OUTPUT_FORMAT_TEXT
;
2377 } else if (!strcmp(arg
, "dummy")) {
2378 /* Legacy dummy output format */
2379 if (legacy_output_format
) {
2380 print_err_dup_legacy_output();
2384 legacy_output_format
=
2385 LEGACY_OUTPUT_FORMAT_DUMMY
;
2387 } else if (!strcmp(arg
, "ctf-metadata")) {
2388 /* Legacy CTF-metadata output format */
2389 if (legacy_output_format
) {
2390 print_err_dup_legacy_output();
2394 legacy_output_format
=
2395 LEGACY_OUTPUT_FORMAT_CTF_METADATA
;
2400 /* Non-legacy: try to create a component config */
2402 add_cfg_comp(cfg
, cur_cfg_comp
,
2406 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2407 if (!cur_cfg_comp
) {
2408 printf_err("Invalid sink component format:\n %s\n",
2413 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2414 cur_cfg_comp_params_set
= false;
2419 struct bt_value
*params
;
2421 if (!cur_cfg_comp
) {
2422 printf_err("--params option must follow a --source or --sink option\n");
2426 if (cur_cfg_comp_params_set
) {
2427 printf_err("Duplicate --params option for the same current component (%s.%s)\n",
2428 cur_cfg_comp
->plugin_name
->str
,
2429 cur_cfg_comp
->component_name
->str
);
2433 params
= bt_value_from_arg(arg
);
2435 printf_err("Invalid format for --params option's argument:\n %s\n",
2440 BT_MOVE(cur_cfg_comp
->params
, params
);
2441 cur_cfg_comp_params_set
= true;
2445 if (text_legacy_opts
.names
) {
2446 printf_err("Duplicate --names option\n");
2450 text_legacy_opts
.names
= names_from_arg(arg
);
2451 if (!text_legacy_opts
.names
) {
2452 printf_err("Invalid --names option's argument\n");
2457 if (text_legacy_opts
.fields
) {
2458 printf_err("Duplicate --fields option\n");
2462 text_legacy_opts
.fields
= fields_from_arg(arg
);
2463 if (!text_legacy_opts
.fields
) {
2464 printf_err("Invalid --fields option's argument\n");
2469 text_legacy_opts
.no_delta
= true;
2471 case OPT_CLOCK_CYCLES
:
2472 text_legacy_opts
.clock_cycles
= true;
2474 case OPT_CLOCK_SECONDS
:
2475 text_legacy_opts
.clock_seconds
= true;
2477 case OPT_CLOCK_DATE
:
2478 text_legacy_opts
.clock_date
= true;
2481 text_legacy_opts
.clock_gmt
= true;
2483 case OPT_DEBUG_INFO_FULL_PATH
:
2484 text_legacy_opts
.dbg_info_full_path
= true;
2486 case OPT_CLOCK_OFFSET
:
2490 if (ctf_legacy_opts
.offset_s
.is_set
) {
2491 printf_err("Duplicate --clock-offset option\n");
2495 if (parse_int64(arg
, &val
)) {
2496 printf_err("Invalid --clock-offset option's argument\n");
2500 set_offset_value(&ctf_legacy_opts
.offset_s
, val
);
2503 case OPT_CLOCK_OFFSET_NS
:
2507 if (ctf_legacy_opts
.offset_ns
.is_set
) {
2508 printf_err("Duplicate --clock-offset-ns option\n");
2512 if (parse_int64(arg
, &val
)) {
2513 printf_err("Invalid --clock-offset-ns option's argument\n");
2517 set_offset_value(&ctf_legacy_opts
.offset_ns
, val
);
2520 case OPT_STREAM_INTERSECTION
:
2521 ctf_legacy_opts
.stream_intersection
= true;
2523 case OPT_CLOCK_FORCE_CORRELATE
:
2524 cfg
->force_correlate
= true;
2528 print_usage(stdout
);
2530 case OPT_HELP_LEGACY
:
2532 print_legacy_usage(stdout
);
2539 cfg
->do_list
= true;
2542 cfg
->verbose
= true;
2548 printf_err("Unknown command-line option specified (option code %d)\n",
2557 /* Append current component configuration, if any */
2559 add_cfg_comp(cfg
, cur_cfg_comp
, cur_cfg_comp_dest
);
2560 cur_cfg_comp
= NULL
;
2563 /* Check for option parsing error */
2565 printf_err("While parsing command-line options, at option %s: %s\n",
2566 poptBadOption(pc
, 0), poptStrerror(opt
));
2570 /* Consume leftover arguments as legacy input paths */
2572 const char *input_path
= poptGetArg(pc
);
2578 if (bt_value_array_append_string(legacy_input_paths
,
2585 /* Validate legacy/non-legacy options */
2586 if (!validate_cfg(cfg
, &legacy_input_format
, &legacy_output_format
,
2587 legacy_input_paths
, &ctf_legacy_opts
,
2588 &text_legacy_opts
)) {
2589 printf_err("Command-line options form an invalid configuration\n");
2594 * If there's a legacy input format, convert it to source
2595 * component configurations.
2597 if (legacy_input_format
) {
2598 if (append_sources_from_legacy_opts(cfg
->sources
,
2599 legacy_input_format
, &ctf_legacy_opts
,
2600 legacy_input_paths
)) {
2601 printf_err("Cannot convert legacy input format options to source(s)\n");
2607 * If there's a legacy output format, convert it to sink
2608 * component configurations.
2610 if (legacy_output_format
) {
2611 if (append_sinks_from_legacy_opts(cfg
->sinks
,
2612 legacy_output_format
, &text_legacy_opts
)) {
2613 printf_err("Cannot convert legacy output format options to sink(s)\n");
2627 poptFreeContext(pc
);
2630 if (text_legacy_opts
.output
) {
2631 g_string_free(text_legacy_opts
.output
, TRUE
);
2634 if (text_legacy_opts
.dbg_info_dir
) {
2635 g_string_free(text_legacy_opts
.dbg_info_dir
, TRUE
);
2638 if (text_legacy_opts
.dbg_info_target_prefix
) {
2639 g_string_free(text_legacy_opts
.dbg_info_target_prefix
, TRUE
);
2643 BT_PUT(cur_cfg_comp
);
2644 BT_PUT(text_legacy_opts
.names
);
2645 BT_PUT(text_legacy_opts
.fields
);
2646 BT_PUT(legacy_input_paths
);