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
, " --begin Start time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
781 fprintf(fp
, " --end End time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
782 fprintf(fp
, " --timerange Time range: begin,end or [begin,end] (where [] are actual brackets)\n");
783 fprintf(fp
, " -h --help Show this help\n");
784 fprintf(fp
, " --help-legacy Show Babeltrace 1.x legacy options\n");
785 fprintf(fp
, " -v, --verbose Enable verbose output\n");
786 fprintf(fp
, " -V, --version Show version\n");
788 fprintf(fp
, "Format of PARAMS\n");
789 fprintf(fp
, "----------------\n");
791 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
793 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
794 fprintf(fp
, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
795 fprintf(fp
, "VALUE can be one of:\n");
797 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
798 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
799 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
800 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
801 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
802 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
803 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
804 fprintf(fp
, " the null and boolean value symbols above.\n");
805 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
807 fprintf(fp
, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
809 fprintf(fp
, "Example:\n");
811 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
812 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
813 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
815 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
816 fprintf(fp
, "from a shell.\n");
820 * Destroys a component configuration.
823 void bt_config_component_destroy(struct bt_object
*obj
)
825 struct bt_config_component
*bt_config_component
=
826 container_of(obj
, struct bt_config_component
, base
);
832 if (bt_config_component
->plugin_name
) {
833 g_string_free(bt_config_component
->plugin_name
, TRUE
);
836 if (bt_config_component
->component_name
) {
837 g_string_free(bt_config_component
->component_name
, TRUE
);
840 BT_PUT(bt_config_component
->params
);
841 g_free(bt_config_component
);
848 * Creates a component configuration using the given plugin name and
849 * component name. plugin_name and component_name are copied (belong to
852 * Return value is owned by the caller.
855 struct bt_config_component
*bt_config_component_create(const char *plugin_name
,
856 const char *component_name
)
858 struct bt_config_component
*cfg_component
= NULL
;
860 cfg_component
= g_new0(struct bt_config_component
, 1);
861 if (!cfg_component
) {
866 bt_object_init(cfg_component
, bt_config_component_destroy
);
867 cfg_component
->plugin_name
= g_string_new(plugin_name
);
868 if (!cfg_component
->plugin_name
) {
873 cfg_component
->component_name
= g_string_new(component_name
);
874 if (!cfg_component
->component_name
) {
879 /* Start with empty parameters */
880 cfg_component
->params
= bt_value_map_create();
881 if (!cfg_component
->params
) {
889 BT_PUT(cfg_component
);
892 return cfg_component
;
896 * Creates a component configuration from a command-line source/sink
900 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
902 struct bt_config_component
*bt_config_component
= NULL
;
904 char *component_name
;
906 plugin_component_names_from_arg(arg
, &plugin_name
, &component_name
);
907 if (!plugin_name
|| !component_name
) {
908 printf_err("Cannot get plugin or component class name\n");
912 bt_config_component
= bt_config_component_create(plugin_name
,
914 if (!bt_config_component
) {
921 BT_PUT(bt_config_component
);
925 g_free(component_name
);
926 return bt_config_component
;
930 * Destroys a configuration.
933 void bt_config_destroy(struct bt_object
*obj
)
935 struct bt_config
*bt_config
=
936 container_of(obj
, struct bt_config
, base
);
942 if (bt_config
->sources
) {
943 g_ptr_array_free(bt_config
->sources
, TRUE
);
946 if (bt_config
->sinks
) {
947 g_ptr_array_free(bt_config
->sinks
, TRUE
);
950 BT_PUT(bt_config
->plugin_paths
);
958 * Extracts the various paths from the string arg, delimited by ':',
959 * and converts them to an array value object.
961 * Returned array value object is empty if arg is empty.
963 * Return value is owned by the caller.
966 struct bt_value
*plugin_paths_from_arg(const char *arg
)
968 struct bt_value
*plugin_paths
;
969 const char *at
= arg
;
970 const char *end
= arg
+ strlen(arg
);
972 plugin_paths
= bt_value_array_create();
981 const char *next_colon
;
983 next_colon
= strchr(at
, ':');
984 if (next_colon
== at
) {
986 * Empty path: try next character (supported
987 * to conform to the typical parsing of $PATH).
991 } else if (!next_colon
) {
992 /* No more colon: use the remaining */
993 next_colon
= arg
+ strlen(arg
);
996 path
= g_string_new(NULL
);
1002 g_string_append_len(path
, at
, next_colon
- at
);
1003 at
= next_colon
+ 1;
1004 ret
= bt_value_array_append_string(plugin_paths
, path
->str
);
1005 g_string_free(path
, TRUE
);
1015 BT_PUT(plugin_paths
);
1018 return plugin_paths
;
1022 * Creates a simple lexical scanner for parsing comma-delimited names
1025 * Return value is owned by the caller.
1028 GScanner
*create_csv_identifiers_scanner(void)
1030 GScannerConfig scanner_config
= {
1031 .cset_skip_characters
= " \t\n",
1032 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
1033 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
1034 .case_sensitive
= TRUE
,
1035 .cpair_comment_single
= NULL
,
1036 .skip_comment_multi
= TRUE
,
1037 .skip_comment_single
= TRUE
,
1038 .scan_comment_multi
= FALSE
,
1039 .scan_identifier
= TRUE
,
1040 .scan_identifier_1char
= TRUE
,
1041 .scan_identifier_NULL
= FALSE
,
1042 .scan_symbols
= FALSE
,
1043 .symbol_2_token
= FALSE
,
1044 .scope_0_fallback
= FALSE
,
1045 .scan_binary
= FALSE
,
1046 .scan_octal
= FALSE
,
1047 .scan_float
= FALSE
,
1049 .scan_hex_dollar
= FALSE
,
1050 .numbers_2_int
= FALSE
,
1051 .int_2_float
= FALSE
,
1052 .store_int64
= FALSE
,
1053 .scan_string_sq
= FALSE
,
1054 .scan_string_dq
= FALSE
,
1055 .identifier_2_string
= FALSE
,
1056 .char_2_token
= TRUE
,
1059 return g_scanner_new(&scanner_config
);
1063 * Inserts a string (if exists and not empty) or null to a map value
1067 enum bt_value_status
map_insert_string_or_null(struct bt_value
*map
,
1068 const char *key
, GString
*string
)
1070 enum bt_value_status ret
;
1072 if (string
&& string
->len
> 0) {
1073 ret
= bt_value_map_insert_string(map
, key
, string
->str
);
1075 ret
= bt_value_map_insert(map
, key
, bt_value_null
);
1081 * Converts a comma-delimited list of known names (--names option) to
1082 * an array value object containing those names as string value objects.
1084 * Return value is owned by the caller.
1087 struct bt_value
*names_from_arg(const char *arg
)
1089 GScanner
*scanner
= NULL
;
1090 struct bt_value
*names
= NULL
;
1091 bool found_all
= false, found_none
= false, found_item
= false;
1093 names
= bt_value_array_create();
1099 scanner
= create_csv_identifiers_scanner();
1105 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1108 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1110 switch (token_type
) {
1111 case G_TOKEN_IDENTIFIER
:
1113 const char *identifier
= scanner
->value
.v_identifier
;
1115 if (!strcmp(identifier
, "payload") ||
1116 !strcmp(identifier
, "args") ||
1117 !strcmp(identifier
, "arg")) {
1119 if (bt_value_array_append_string(names
,
1123 } else if (!strcmp(identifier
, "context") ||
1124 !strcmp(identifier
, "ctx")) {
1126 if (bt_value_array_append_string(names
,
1130 } else if (!strcmp(identifier
, "scope") ||
1131 !strcmp(identifier
, "header")) {
1133 if (bt_value_array_append_string(names
,
1137 } else if (!strcmp(identifier
, "all")) {
1139 if (bt_value_array_append_string(names
,
1143 } else if (!strcmp(identifier
, "none")) {
1145 if (bt_value_array_append_string(names
,
1150 printf_err("Unknown field name: `%s`\n",
1166 if (found_none
&& found_all
) {
1167 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1171 * Legacy behavior is to clear the defaults (show none) when at
1172 * least one item is specified.
1174 if (found_item
&& !found_none
&& !found_all
) {
1175 if (bt_value_array_append_string(names
, "none")) {
1180 g_scanner_destroy(scanner
);
1187 g_scanner_destroy(scanner
);
1194 * Converts a comma-delimited list of known fields (--fields option) to
1195 * an array value object containing those fields as string
1198 * Return value is owned by the caller.
1201 struct bt_value
*fields_from_arg(const char *arg
)
1203 GScanner
*scanner
= NULL
;
1204 struct bt_value
*fields
;
1206 fields
= bt_value_array_create();
1212 scanner
= create_csv_identifiers_scanner();
1218 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1221 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1223 switch (token_type
) {
1224 case G_TOKEN_IDENTIFIER
:
1226 const char *identifier
= scanner
->value
.v_identifier
;
1228 if (!strcmp(identifier
, "trace") ||
1229 !strcmp(identifier
, "trace:hostname") ||
1230 !strcmp(identifier
, "trace:domain") ||
1231 !strcmp(identifier
, "trace:procname") ||
1232 !strcmp(identifier
, "trace:vpid") ||
1233 !strcmp(identifier
, "loglevel") ||
1234 !strcmp(identifier
, "emf") ||
1235 !strcmp(identifier
, "callsite") ||
1236 !strcmp(identifier
, "all")) {
1237 if (bt_value_array_append_string(fields
,
1242 printf_err("Unknown field name: `%s`\n",
1264 g_scanner_destroy(scanner
);
1270 * Inserts the equivalent "prefix-name" true boolean value objects into
1271 * map_obj where the names are in array_obj.
1274 int insert_flat_names_fields_from_array(struct bt_value
*map_obj
,
1275 struct bt_value
*array_obj
, const char *prefix
)
1279 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1282 * array_obj may be NULL if no CLI options were specified to
1283 * trigger its creation.
1289 tmpstr
= g_string_new(NULL
);
1296 default_value
= g_string_new(NULL
);
1297 if (!default_value
) {
1303 for (i
= 0; i
< bt_value_array_size(array_obj
); i
++) {
1304 struct bt_value
*str_obj
= bt_value_array_get(array_obj
, i
);
1306 bool is_default
= false;
1309 printf_err("Unexpected error\n");
1314 ret
= bt_value_string_get(str_obj
, &suffix
);
1317 printf_err("Unexpected error\n");
1321 g_string_assign(tmpstr
, prefix
);
1322 g_string_append(tmpstr
, "-");
1324 /* Special-case for "all" and "none". */
1325 if (!strcmp(suffix
, "all")) {
1327 g_string_assign(default_value
, "show");
1328 } else if (!strcmp(suffix
, "none")) {
1330 g_string_assign(default_value
, "hide");
1333 g_string_append(tmpstr
, "default");
1334 ret
= map_insert_string_or_null(map_obj
,
1342 g_string_append(tmpstr
, suffix
);
1343 ret
= bt_value_map_insert_bool(map_obj
, tmpstr
->str
,
1353 if (default_value
) {
1354 g_string_free(default_value
, TRUE
);
1357 g_string_free(tmpstr
, TRUE
);
1364 * Returns the parameters (map value object) corresponding to the
1365 * legacy text format options.
1367 * Return value is owned by the caller.
1370 struct bt_value
*params_from_text_legacy_opts(
1371 struct text_legacy_opts
*text_legacy_opts
)
1373 struct bt_value
*params
;
1375 params
= bt_value_map_create();
1381 if (map_insert_string_or_null(params
, "output-path",
1382 text_legacy_opts
->output
)) {
1387 if (map_insert_string_or_null(params
, "debug-info-dir",
1388 text_legacy_opts
->dbg_info_dir
)) {
1393 if (map_insert_string_or_null(params
, "debug-info-target-prefix",
1394 text_legacy_opts
->dbg_info_target_prefix
)) {
1399 if (bt_value_map_insert_bool(params
, "debug-info-full-path",
1400 text_legacy_opts
->dbg_info_full_path
)) {
1405 if (bt_value_map_insert_bool(params
, "no-delta",
1406 text_legacy_opts
->no_delta
)) {
1411 if (bt_value_map_insert_bool(params
, "clock-cycles",
1412 text_legacy_opts
->clock_cycles
)) {
1417 if (bt_value_map_insert_bool(params
, "clock-seconds",
1418 text_legacy_opts
->clock_seconds
)) {
1423 if (bt_value_map_insert_bool(params
, "clock-date",
1424 text_legacy_opts
->clock_date
)) {
1429 if (bt_value_map_insert_bool(params
, "clock-gmt",
1430 text_legacy_opts
->clock_gmt
)) {
1435 if (insert_flat_names_fields_from_array(params
,
1436 text_legacy_opts
->names
, "name")) {
1440 if (insert_flat_names_fields_from_array(params
,
1441 text_legacy_opts
->fields
, "field")) {
1455 int append_sinks_from_legacy_opts(GPtrArray
*sinks
,
1456 enum legacy_output_format legacy_output_format
,
1457 struct text_legacy_opts
*text_legacy_opts
)
1460 struct bt_value
*params
= NULL
;
1461 const char *plugin_name
;
1462 const char *component_name
;
1463 struct bt_config_component
*bt_config_component
= NULL
;
1465 switch (legacy_output_format
) {
1466 case LEGACY_OUTPUT_FORMAT_TEXT
:
1467 plugin_name
= "text";
1468 component_name
= "text";
1470 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1471 plugin_name
= "ctf";
1472 component_name
= "metadata-text";
1474 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1475 plugin_name
= "dummy";
1476 component_name
= "dummy";
1483 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
) {
1484 /* Legacy "text" output format has parameters */
1485 params
= params_from_text_legacy_opts(text_legacy_opts
);
1491 * Legacy "dummy" and "ctf-metadata" output formats do
1492 * not have parameters.
1494 params
= bt_value_map_create();
1501 /* Create a component configuration */
1502 bt_config_component
= bt_config_component_create(plugin_name
,
1504 if (!bt_config_component
) {
1508 BT_MOVE(bt_config_component
->params
, params
);
1510 /* Move created component configuration to the array */
1511 g_ptr_array_add(sinks
, bt_config_component
);
1525 * Returns the parameters (map value object) corresponding to the
1526 * given legacy CTF format options.
1528 * Return value is owned by the caller.
1531 struct bt_value
*params_from_ctf_legacy_opts(
1532 struct ctf_legacy_opts
*ctf_legacy_opts
)
1534 struct bt_value
*params
;
1536 params
= bt_value_map_create();
1542 if (bt_value_map_insert_integer(params
, "offset-s",
1543 ctf_legacy_opts
->offset_s
.value
)) {
1548 if (bt_value_map_insert_integer(params
, "offset-ns",
1549 ctf_legacy_opts
->offset_ns
.value
)) {
1554 if (bt_value_map_insert_bool(params
, "stream-intersection",
1555 ctf_legacy_opts
->stream_intersection
)) {
1570 int append_sources_from_legacy_opts(GPtrArray
*sources
,
1571 enum legacy_input_format legacy_input_format
,
1572 struct ctf_legacy_opts
*ctf_legacy_opts
,
1573 struct bt_value
*legacy_input_paths
)
1577 struct bt_value
*base_params
;
1578 struct bt_value
*params
= NULL
;
1579 struct bt_value
*input_path
= NULL
;
1580 struct bt_value
*input_path_copy
= NULL
;
1581 const char *input_key
;
1582 const char *component_name
;
1584 switch (legacy_input_format
) {
1585 case LEGACY_INPUT_FORMAT_CTF
:
1587 component_name
= "fs";
1589 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1591 component_name
= "lttng-live";
1598 base_params
= params_from_ctf_legacy_opts(ctf_legacy_opts
);
1603 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1604 struct bt_config_component
*bt_config_component
= NULL
;
1606 /* Copy base parameters as current parameters */
1607 params
= bt_value_copy(base_params
);
1612 /* Get current input path string value object */
1613 input_path
= bt_value_array_get(legacy_input_paths
, i
);
1618 /* Copy current input path value object */
1619 input_path_copy
= bt_value_copy(input_path
);
1620 if (!input_path_copy
) {
1624 /* Insert input path value object into current parameters */
1625 ret
= bt_value_map_insert(params
, input_key
, input_path_copy
);
1630 /* Create a component configuration */
1631 bt_config_component
= bt_config_component_create("ctf",
1633 if (!bt_config_component
) {
1637 BT_MOVE(bt_config_component
->params
, params
);
1639 /* Move created component configuration to the array */
1640 g_ptr_array_add(sources
, bt_config_component
);
1642 /* Put current stuff */
1644 BT_PUT(input_path_copy
);
1653 BT_PUT(base_params
);
1656 BT_PUT(input_path_copy
);
1661 * Escapes a string for the shell. The string is escaped knowing that
1662 * it's a parameter string value (double-quoted), and that it will be
1663 * entered between single quotes in the shell.
1665 * Return value is owned by the caller.
1668 char *str_shell_escape(const char *input
)
1671 const char *at
= input
;
1672 GString
*str
= g_string_new(NULL
);
1678 while (*at
!= '\0') {
1681 g_string_append(str
, "\\\\");
1684 g_string_append(str
, "\\\"");
1687 g_string_append(str
, "'\"'\"'");
1690 g_string_append(str
, "\\n");
1693 g_string_append(str
, "\\t");
1696 g_string_append_c(str
, *at
);
1706 g_string_free(str
, FALSE
);
1713 int append_prefixed_flag_params(GString
*str
, struct bt_value
*flags
,
1723 for (i
= 0; i
< bt_value_array_size(flags
); i
++) {
1724 struct bt_value
*value
= bt_value_array_get(flags
, i
);
1732 if (bt_value_string_get(value
, &flag
)) {
1738 g_string_append_printf(str
, ",%s-%s=true", prefix
, flag
);
1747 * Appends a boolean parameter string.
1750 void g_string_append_bool_param(GString
*str
, const char *name
, bool value
)
1752 g_string_append_printf(str
, ",%s=%s", name
, value
? "true" : "false");
1756 * Appends a path parameter string, or null if it's empty.
1759 int g_string_append_string_path_param(GString
*str
, const char *name
,
1764 if (path
->len
> 0) {
1765 char *escaped_path
= str_shell_escape(path
->str
);
1767 if (!escaped_path
) {
1772 g_string_append_printf(str
, "%s=\"%s\"", name
, escaped_path
);
1775 g_string_append_printf(str
, "%s=null", name
);
1788 * Prints the non-legacy sink options equivalent to the specified
1789 * legacy output format options.
1792 void print_output_legacy_to_sinks(
1793 enum legacy_output_format legacy_output_format
,
1794 struct text_legacy_opts
*text_legacy_opts
)
1796 const char *input_format
;
1797 GString
*str
= NULL
;
1799 str
= g_string_new(" ");
1805 switch (legacy_output_format
) {
1806 case LEGACY_OUTPUT_FORMAT_TEXT
:
1807 input_format
= "text";
1809 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1810 input_format
= "ctf-metadata";
1812 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1813 input_format
= "dummy";
1819 printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
1821 printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
1823 g_string_append(str
, "-o ");
1825 switch (legacy_output_format
) {
1826 case LEGACY_OUTPUT_FORMAT_TEXT
:
1827 g_string_append(str
, "text.text");
1829 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1830 g_string_append(str
, "ctf.metadata-text");
1832 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1833 g_string_append(str
, "dummy.dummy");
1839 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
&&
1840 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1843 g_string_append(str
, " -p '");
1845 if (g_string_append_string_path_param(str
, "output-path",
1846 text_legacy_opts
->output
)) {
1850 g_string_append(str
, ",");
1852 if (g_string_append_string_path_param(str
, "debug-info-dir",
1853 text_legacy_opts
->dbg_info_dir
)) {
1857 g_string_append(str
, ",");
1859 if (g_string_append_string_path_param(str
,
1860 "debug-info-target-prefix",
1861 text_legacy_opts
->dbg_info_target_prefix
)) {
1865 g_string_append_bool_param(str
, "no-delta",
1866 text_legacy_opts
->no_delta
);
1867 g_string_append_bool_param(str
, "clock-cycles",
1868 text_legacy_opts
->clock_cycles
);
1869 g_string_append_bool_param(str
, "clock-seconds",
1870 text_legacy_opts
->clock_seconds
);
1871 g_string_append_bool_param(str
, "clock-date",
1872 text_legacy_opts
->clock_date
);
1873 g_string_append_bool_param(str
, "clock-gmt",
1874 text_legacy_opts
->clock_gmt
);
1875 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->names
,
1881 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->fields
,
1887 /* Remove last comma and close single quote */
1888 g_string_append(str
, "'");
1891 printf_err("%s\n\n", str
->str
);
1895 g_string_free(str
, TRUE
);
1901 * Prints the non-legacy source options equivalent to the specified
1902 * legacy input format options.
1905 void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format
,
1906 struct bt_value
*legacy_input_paths
,
1907 struct ctf_legacy_opts
*ctf_legacy_opts
)
1909 const char *input_format
;
1910 GString
*str
= NULL
;
1913 str
= g_string_new(" ");
1919 switch (legacy_input_format
) {
1920 case LEGACY_INPUT_FORMAT_CTF
:
1921 input_format
= "ctf";
1923 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1924 input_format
= "lttng-live";
1930 printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
1932 printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
1935 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1936 struct bt_value
*input_value
=
1937 bt_value_array_get(legacy_input_paths
, i
);
1938 const char *input
= NULL
;
1939 char *escaped_input
;
1942 assert(input_value
);
1943 ret
= bt_value_string_get(input_value
, &input
);
1944 BT_PUT(input_value
);
1945 assert(!ret
&& input
);
1946 escaped_input
= str_shell_escape(input
);
1947 if (!escaped_input
) {
1952 g_string_append(str
, "-i ctf.");
1954 switch (legacy_input_format
) {
1955 case LEGACY_INPUT_FORMAT_CTF
:
1956 g_string_append(str
, "fs -p 'path=\"");
1958 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1959 g_string_append(str
, "lttng-live -p 'url=\"");
1965 g_string_append(str
, escaped_input
);
1966 g_string_append(str
, "\"");
1967 g_string_append_printf(str
, ",offset-s=%" PRId64
,
1968 ctf_legacy_opts
->offset_s
.value
);
1969 g_string_append_printf(str
, ",offset-ns=%" PRId64
,
1970 ctf_legacy_opts
->offset_ns
.value
);
1971 g_string_append_bool_param(str
, "stream-intersection",
1972 ctf_legacy_opts
->stream_intersection
);
1973 g_string_append(str
, "' ");
1974 g_free(escaped_input
);
1977 printf_err("%s\n\n", str
->str
);
1981 g_string_free(str
, TRUE
);
1987 * Validates a given configuration, with optional legacy input and
1988 * output formats options. Prints useful error messages if anything
1991 * Returns true when the configuration is valid.
1994 bool validate_cfg(struct bt_config
*cfg
,
1995 enum legacy_input_format
*legacy_input_format
,
1996 enum legacy_output_format
*legacy_output_format
,
1997 struct bt_value
*legacy_input_paths
,
1998 struct ctf_legacy_opts
*ctf_legacy_opts
,
1999 struct text_legacy_opts
*text_legacy_opts
)
2001 bool legacy_input
= false;
2002 bool legacy_output
= false;
2004 /* Determine if the input and output should be legacy-style */
2005 if (*legacy_input_format
!= LEGACY_INPUT_FORMAT_NONE
||
2006 cfg
->sources
->len
== 0 ||
2007 !bt_value_array_is_empty(legacy_input_paths
) ||
2008 ctf_legacy_opts_is_any_set(ctf_legacy_opts
)) {
2009 legacy_input
= true;
2012 if (*legacy_output_format
!= LEGACY_OUTPUT_FORMAT_NONE
||
2013 cfg
->sinks
->len
== 0 ||
2014 text_legacy_opts_is_any_set(text_legacy_opts
)) {
2015 legacy_output
= true;
2019 /* If no legacy input format was specified, default to CTF */
2020 if (*legacy_input_format
== LEGACY_INPUT_FORMAT_NONE
) {
2021 *legacy_input_format
= LEGACY_INPUT_FORMAT_CTF
;
2024 /* Make sure at least one input path exists */
2025 if (bt_value_array_is_empty(legacy_input_paths
)) {
2026 switch (*legacy_input_format
) {
2027 case LEGACY_INPUT_FORMAT_CTF
:
2028 printf_err("No input path specified for legacy `ctf` input format\n");
2030 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
2031 printf_err("No URL specified for legacy `lttng-live` input format\n");
2039 /* Make sure no non-legacy sources are specified */
2040 if (cfg
->sources
->len
!= 0) {
2041 print_input_legacy_to_sources(*legacy_input_format
,
2042 legacy_input_paths
, ctf_legacy_opts
);
2047 if (legacy_output
) {
2049 * If no legacy output format was specified, default to
2052 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_NONE
) {
2053 *legacy_output_format
= LEGACY_OUTPUT_FORMAT_TEXT
;
2057 * If any "text" option was specified, the output must be
2060 if (text_legacy_opts_is_any_set(text_legacy_opts
) &&
2061 *legacy_output_format
!=
2062 LEGACY_OUTPUT_FORMAT_TEXT
) {
2063 printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
2067 /* Make sure no non-legacy sinks are specified */
2068 if (cfg
->sinks
->len
!= 0) {
2069 print_output_legacy_to_sinks(*legacy_output_format
,
2076 * If the output is the legacy "ctf-metadata" format, then the
2077 * input should be the legacy "ctf" input format.
2079 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_CTF_METADATA
&&
2080 *legacy_input_format
!= LEGACY_INPUT_FORMAT_CTF
) {
2081 printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
2092 * Parses a 64-bit signed integer.
2094 * Returns a negative value if anything goes wrong.
2097 int parse_int64(const char *arg
, int64_t *val
)
2102 *val
= strtoll(arg
, &endptr
, 0);
2103 if (*endptr
!= '\0' || arg
== endptr
|| errno
!= 0) {
2117 OPT_CLOCK_FORCE_CORRELATE
,
2120 OPT_CLOCK_OFFSET_NS
,
2124 OPT_DEBUG_INFO_FULL_PATH
,
2125 OPT_DEBUG_INFO_TARGET_PREFIX
,
2139 OPT_RESET_BASE_PARAMS
,
2142 OPT_STREAM_INTERSECTION
,
2148 /* popt long option descriptions */
2149 static struct poptOption long_options
[] = {
2150 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2151 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
2152 { "begin", '\0', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2153 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2154 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2155 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2156 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2157 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2158 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2159 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2160 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2161 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2162 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2163 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2164 { "end", '\0', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2165 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2166 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2167 { "help-legacy", '\0', POPT_ARG_NONE
, NULL
, OPT_HELP_LEGACY
, NULL
, NULL
},
2168 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2169 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
2170 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2171 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2172 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_PATH
, NULL
, NULL
},
2173 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2174 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2175 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2176 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2177 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
2178 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2179 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2180 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2181 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2182 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2183 { "version", 'V', POPT_ARG_NONE
, NULL
, OPT_VERSION
, NULL
, NULL
},
2184 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2188 * Sets the value of a given legacy offset option and marks it as set.
2190 static void set_offset_value(struct offset_opt
*offset_opt
, int64_t value
)
2192 offset_opt
->value
= value
;
2193 offset_opt
->is_set
= true;
2196 enum bt_config_component_dest
{
2197 BT_CONFIG_COMPONENT_DEST_SOURCE
,
2198 BT_CONFIG_COMPONENT_DEST_SINK
,
2202 * Adds a configuration component to the appropriate configuration
2203 * array depending on the destination.
2205 static void add_cfg_comp(struct bt_config
*cfg
,
2206 struct bt_config_component
*cfg_comp
,
2207 enum bt_config_component_dest dest
)
2209 if (dest
== BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2210 g_ptr_array_add(cfg
->sources
, cfg_comp
);
2212 g_ptr_array_add(cfg
->sinks
, cfg_comp
);
2216 static int split_timerange(const char *arg
, const char **begin
, const char **end
)
2220 /* Try to match [begin,end] */
2221 c
= strchr(arg
, '[');
2235 /* Try to match begin,end */
2250 * Returns a Babeltrace configuration, out of command-line arguments,
2251 * containing everything that is needed to instanciate specific
2252 * components with given parameters.
2254 * *exit_code is set to the appropriate exit code to use as far as this
2257 * Return value is NULL on error, otherwise it's owned by the caller.
2259 struct bt_config
*bt_config_from_args(int argc
, const char *argv
[], int *exit_code
)
2261 struct bt_config
*cfg
= NULL
;
2262 poptContext pc
= NULL
;
2264 struct ctf_legacy_opts ctf_legacy_opts
;
2265 struct text_legacy_opts text_legacy_opts
;
2266 enum legacy_input_format legacy_input_format
= LEGACY_INPUT_FORMAT_NONE
;
2267 enum legacy_output_format legacy_output_format
=
2268 LEGACY_OUTPUT_FORMAT_NONE
;
2269 struct bt_value
*legacy_input_paths
= NULL
;
2270 struct bt_config_component
*cur_cfg_comp
= NULL
;
2271 enum bt_config_component_dest cur_cfg_comp_dest
=
2272 BT_CONFIG_COMPONENT_DEST_SOURCE
;
2273 struct bt_value
*cur_base_params
= NULL
;
2275 bool cur_cfg_comp_params_set
= false;
2277 memset(&ctf_legacy_opts
, 0, sizeof(ctf_legacy_opts
));
2278 memset(&text_legacy_opts
, 0, sizeof(text_legacy_opts
));
2282 print_usage(stdout
);
2286 text_legacy_opts
.output
= g_string_new(NULL
);
2287 if (!text_legacy_opts
.output
) {
2292 text_legacy_opts
.dbg_info_dir
= g_string_new(NULL
);
2293 if (!text_legacy_opts
.dbg_info_dir
) {
2298 text_legacy_opts
.dbg_info_target_prefix
= g_string_new(NULL
);
2299 if (!text_legacy_opts
.dbg_info_target_prefix
) {
2304 cur_base_params
= bt_value_map_create();
2305 if (!cur_base_params
) {
2311 cfg
= g_new0(struct bt_config
, 1);
2317 bt_object_init(cfg
, bt_config_destroy
);
2318 cfg
->sources
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2319 if (!cfg
->sources
) {
2324 cfg
->sinks
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2330 legacy_input_paths
= bt_value_array_create();
2331 if (!legacy_input_paths
) {
2337 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
2339 printf_err("Cannot get popt context\n");
2343 poptReadDefaultConfig(pc
, 0);
2345 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2346 arg
= poptGetOptArg(pc
);
2349 case OPT_PLUGIN_PATH
:
2350 if (cfg
->plugin_paths
) {
2351 printf_err("Duplicate --plugin-path option\n");
2355 cfg
->plugin_paths
= plugin_paths_from_arg(arg
);
2356 if (!cfg
->plugin_paths
) {
2357 printf_err("Invalid --plugin-path option's argument\n");
2361 case OPT_OUTPUT_PATH
:
2362 if (text_legacy_opts
.output
->len
> 0) {
2363 printf_err("Duplicate --output option\n");
2367 g_string_assign(text_legacy_opts
.output
, arg
);
2369 case OPT_DEBUG_INFO_DIR
:
2370 if (text_legacy_opts
.dbg_info_dir
->len
> 0) {
2371 printf_err("Duplicate --debug-info-dir option\n");
2375 g_string_assign(text_legacy_opts
.dbg_info_dir
, arg
);
2377 case OPT_DEBUG_INFO_TARGET_PREFIX
:
2378 if (text_legacy_opts
.dbg_info_target_prefix
->len
> 0) {
2379 printf_err("Duplicate --debug-info-target-prefix option\n");
2383 g_string_assign(text_legacy_opts
.dbg_info_target_prefix
, arg
);
2385 case OPT_INPUT_FORMAT
:
2388 if (opt
== OPT_INPUT_FORMAT
) {
2389 if (!strcmp(arg
, "ctf")) {
2390 /* Legacy CTF input format */
2391 if (legacy_input_format
) {
2392 print_err_dup_legacy_input();
2396 legacy_input_format
=
2397 LEGACY_INPUT_FORMAT_CTF
;
2399 } else if (!strcmp(arg
, "lttng-live")) {
2400 /* Legacy LTTng-live input format */
2401 if (legacy_input_format
) {
2402 print_err_dup_legacy_input();
2406 legacy_input_format
=
2407 LEGACY_INPUT_FORMAT_LTTNG_LIVE
;
2412 /* Non-legacy: try to create a component config */
2414 add_cfg_comp(cfg
, cur_cfg_comp
,
2418 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2419 if (!cur_cfg_comp
) {
2420 printf_err("Invalid format for --source option's argument:\n %s\n",
2425 assert(cur_base_params
);
2426 bt_put(cur_cfg_comp
->params
);
2427 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2428 if (!cur_cfg_comp
) {
2433 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2434 cur_cfg_comp_params_set
= false;
2437 case OPT_OUTPUT_FORMAT
:
2440 if (opt
== OPT_OUTPUT_FORMAT
) {
2441 if (!strcmp(arg
, "text")) {
2442 /* Legacy CTF-text output format */
2443 if (legacy_output_format
) {
2444 print_err_dup_legacy_output();
2448 legacy_output_format
=
2449 LEGACY_OUTPUT_FORMAT_TEXT
;
2451 } else if (!strcmp(arg
, "dummy")) {
2452 /* Legacy dummy output format */
2453 if (legacy_output_format
) {
2454 print_err_dup_legacy_output();
2458 legacy_output_format
=
2459 LEGACY_OUTPUT_FORMAT_DUMMY
;
2461 } else if (!strcmp(arg
, "ctf-metadata")) {
2462 /* Legacy CTF-metadata output format */
2463 if (legacy_output_format
) {
2464 print_err_dup_legacy_output();
2468 legacy_output_format
=
2469 LEGACY_OUTPUT_FORMAT_CTF_METADATA
;
2474 /* Non-legacy: try to create a component config */
2476 add_cfg_comp(cfg
, cur_cfg_comp
,
2480 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2481 if (!cur_cfg_comp
) {
2482 printf_err("Invalid format for --sink option's argument:\n %s\n",
2487 assert(cur_base_params
);
2488 bt_put(cur_cfg_comp
->params
);
2489 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2490 if (!cur_cfg_comp
) {
2495 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2496 cur_cfg_comp_params_set
= false;
2501 struct bt_value
*params
;
2502 struct bt_value
*params_to_set
;
2504 if (!cur_cfg_comp
) {
2505 printf_err("--params option must follow a --source or --sink option\n");
2509 if (cur_cfg_comp_params_set
) {
2510 printf_err("Duplicate --params option for the same current component\ninstance (class %s.%s)\n",
2511 cur_cfg_comp
->plugin_name
->str
,
2512 cur_cfg_comp
->component_name
->str
);
2516 params
= bt_value_from_arg(arg
);
2518 printf_err("Invalid format for --params option's argument:\n %s\n",
2523 params_to_set
= bt_value_map_extend(cur_base_params
,
2526 if (!params_to_set
) {
2527 printf_err("Cannot extend current base parameters with --params option's argument:\n %s\n",
2532 BT_MOVE(cur_cfg_comp
->params
, params_to_set
);
2533 cur_cfg_comp_params_set
= true;
2537 if (!cur_cfg_comp
) {
2538 printf_err("--path option must follow a --source or --sink option\n");
2542 assert(cur_cfg_comp
->params
);
2544 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2550 case OPT_BASE_PARAMS
:
2552 struct bt_value
*params
= bt_value_from_arg(arg
);
2555 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2560 BT_MOVE(cur_base_params
, params
);
2563 case OPT_RESET_BASE_PARAMS
:
2564 BT_PUT(cur_base_params
);
2565 cur_base_params
= bt_value_map_create();
2566 if (!cur_base_params
) {
2572 if (text_legacy_opts
.names
) {
2573 printf_err("Duplicate --names option\n");
2577 text_legacy_opts
.names
= names_from_arg(arg
);
2578 if (!text_legacy_opts
.names
) {
2579 printf_err("Invalid --names option's argument\n");
2584 if (text_legacy_opts
.fields
) {
2585 printf_err("Duplicate --fields option\n");
2589 text_legacy_opts
.fields
= fields_from_arg(arg
);
2590 if (!text_legacy_opts
.fields
) {
2591 printf_err("Invalid --fields option's argument\n");
2596 text_legacy_opts
.no_delta
= true;
2598 case OPT_CLOCK_CYCLES
:
2599 text_legacy_opts
.clock_cycles
= true;
2601 case OPT_CLOCK_SECONDS
:
2602 text_legacy_opts
.clock_seconds
= true;
2604 case OPT_CLOCK_DATE
:
2605 text_legacy_opts
.clock_date
= true;
2608 text_legacy_opts
.clock_gmt
= true;
2610 case OPT_DEBUG_INFO_FULL_PATH
:
2611 text_legacy_opts
.dbg_info_full_path
= true;
2613 case OPT_CLOCK_OFFSET
:
2617 if (ctf_legacy_opts
.offset_s
.is_set
) {
2618 printf_err("Duplicate --clock-offset option\n");
2622 if (parse_int64(arg
, &val
)) {
2623 printf_err("Invalid --clock-offset option's argument\n");
2627 set_offset_value(&ctf_legacy_opts
.offset_s
, val
);
2630 case OPT_CLOCK_OFFSET_NS
:
2634 if (ctf_legacy_opts
.offset_ns
.is_set
) {
2635 printf_err("Duplicate --clock-offset-ns option\n");
2639 if (parse_int64(arg
, &val
)) {
2640 printf_err("Invalid --clock-offset-ns option's argument\n");
2644 set_offset_value(&ctf_legacy_opts
.offset_ns
, val
);
2647 case OPT_STREAM_INTERSECTION
:
2648 ctf_legacy_opts
.stream_intersection
= true;
2650 case OPT_CLOCK_FORCE_CORRELATE
:
2651 cfg
->force_correlate
= true;
2654 if (!cur_cfg_comp
) {
2656 printf_err("Unimplemented: apply to default source\n");
2659 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2660 printf_err("--begin option must follow a --source option\n");
2663 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2670 if (!cur_cfg_comp
) {
2672 printf_err("Unimplemented: apply to default source\n");
2675 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2676 printf_err("--end option must follow a --source option\n");
2679 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2687 const char *begin
, *end
;
2689 if (!cur_cfg_comp
) {
2691 printf_err("Unimplemented: apply to default source\n");
2694 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2695 printf_err("--timerange option must follow a --source option\n");
2698 if (split_timerange(arg
, &begin
, &end
)) {
2699 printf_err("Invalid --timerange format, expecting: begin,end or [begin,end] (where [] are actual brackets)\n");
2702 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2707 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2716 print_usage(stdout
);
2718 case OPT_HELP_LEGACY
:
2720 print_legacy_usage(stdout
);
2727 cfg
->do_list
= true;
2730 cfg
->verbose
= true;
2736 printf_err("Unknown command-line option specified (option code %d)\n",
2745 /* Append current component configuration, if any */
2747 add_cfg_comp(cfg
, cur_cfg_comp
, cur_cfg_comp_dest
);
2748 cur_cfg_comp
= NULL
;
2751 /* Check for option parsing error */
2753 printf_err("While parsing command-line options, at option %s: %s\n",
2754 poptBadOption(pc
, 0), poptStrerror(opt
));
2758 /* Consume leftover arguments as legacy input paths */
2760 const char *input_path
= poptGetArg(pc
);
2766 if (bt_value_array_append_string(legacy_input_paths
,
2773 /* Validate legacy/non-legacy options */
2774 if (!validate_cfg(cfg
, &legacy_input_format
, &legacy_output_format
,
2775 legacy_input_paths
, &ctf_legacy_opts
,
2776 &text_legacy_opts
)) {
2777 printf_err("Command-line options form an invalid configuration\n");
2782 * If there's a legacy input format, convert it to source
2783 * component configurations.
2785 if (legacy_input_format
) {
2786 if (append_sources_from_legacy_opts(cfg
->sources
,
2787 legacy_input_format
, &ctf_legacy_opts
,
2788 legacy_input_paths
)) {
2789 printf_err("Cannot convert legacy input format options to source component instance(s)\n");
2795 * If there's a legacy output format, convert it to sink
2796 * component configurations.
2798 if (legacy_output_format
) {
2799 if (append_sinks_from_legacy_opts(cfg
->sinks
,
2800 legacy_output_format
, &text_legacy_opts
)) {
2801 printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
2815 poptFreeContext(pc
);
2818 if (text_legacy_opts
.output
) {
2819 g_string_free(text_legacy_opts
.output
, TRUE
);
2822 if (text_legacy_opts
.dbg_info_dir
) {
2823 g_string_free(text_legacy_opts
.dbg_info_dir
, TRUE
);
2826 if (text_legacy_opts
.dbg_info_target_prefix
) {
2827 g_string_free(text_legacy_opts
.dbg_info_target_prefix
, TRUE
);
2831 BT_PUT(cur_cfg_comp
);
2832 BT_PUT(cur_base_params
);
2833 BT_PUT(text_legacy_opts
.names
);
2834 BT_PUT(text_legacy_opts
.fields
);
2835 BT_PUT(legacy_input_paths
);