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"
38 #define DEFAULT_SOURCE_COMPONENT_NAME "ctf.fs"
41 * Error printf() macro which prepends "Error: " the first time it's
42 * called. This gives a nicer feel than having a bunch of error prefixes
43 * (since the following lines usually describe the error and possible
44 * solutions), or the error prefix just at the end.
46 #define printf_err(fmt, args...) \
48 if (is_first_error) { \
49 fprintf(stderr, "Error: "); \
50 is_first_error = false; \
52 fprintf(stderr, fmt, ##args); \
55 static bool is_first_error
= true;
57 /* INI-style parsing FSM states */
58 enum ini_parsing_fsm_state
{
59 /* Expect a map key (identifier) */
62 /* Expect an equal character ('=') */
68 /* Expect a negative number value */
69 INI_EXPECT_VALUE_NUMBER_NEG
,
71 /* Expect a comma character (',') */
75 /* INI-style parsing state variables */
76 struct ini_parsing_state
{
77 /* Lexical scanner (owned by this) */
80 /* Output map value object being filled (owned by this) */
81 struct bt_value
*params
;
83 /* Next expected FSM state */
84 enum ini_parsing_fsm_state expecting
;
86 /* Last decoded map key (owned by this) */
89 /* Complete INI-style string to parse (not owned by this) */
92 /* Error buffer (not owned by this) */
96 /* Offset option with "is set" boolean */
102 /* Legacy "ctf"/"lttng-live" format options */
103 struct ctf_legacy_opts
{
104 struct offset_opt offset_s
;
105 struct offset_opt offset_ns
;
106 bool stream_intersection
;
109 /* Legacy "text" format options */
110 struct text_legacy_opts
{
112 * output, dbg_info_dir, dbg_info_target_prefix, names,
113 * and fields are owned by this.
116 GString
*dbg_info_dir
;
117 GString
*dbg_info_target_prefix
;
118 struct bt_value
*names
;
119 struct bt_value
*fields
;
127 bool dbg_info_full_path
;
130 /* Legacy input format format */
131 enum legacy_input_format
{
132 LEGACY_INPUT_FORMAT_NONE
= 0,
133 LEGACY_INPUT_FORMAT_CTF
,
134 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
137 /* Legacy output format format */
138 enum legacy_output_format
{
139 LEGACY_OUTPUT_FORMAT_NONE
= 0,
140 LEGACY_OUTPUT_FORMAT_TEXT
,
141 LEGACY_OUTPUT_FORMAT_CTF_METADATA
,
142 LEGACY_OUTPUT_FORMAT_DUMMY
,
146 * Prints the "out of memory" error.
149 void print_err_oom(void)
151 printf_err("Out of memory\n");
155 * Prints duplicate legacy output format error.
158 void print_err_dup_legacy_output(void)
160 printf_err("More than one legacy output format specified\n");
164 * Prints duplicate legacy input format error.
167 void print_err_dup_legacy_input(void)
169 printf_err("More than one legacy input format specified\n");
173 * Checks if any of the "text" legacy options is set.
176 bool text_legacy_opts_is_any_set(struct text_legacy_opts
*opts
)
178 return (opts
->output
&& opts
->output
->len
> 0) ||
179 (opts
->dbg_info_dir
&& opts
->dbg_info_dir
->len
> 0) ||
180 (opts
->dbg_info_target_prefix
&&
181 opts
->dbg_info_target_prefix
->len
> 0) ||
182 bt_value_array_size(opts
->names
) > 0 ||
183 bt_value_array_size(opts
->fields
) > 0 ||
184 opts
->no_delta
|| opts
->clock_cycles
|| opts
->clock_seconds
||
185 opts
->clock_date
|| opts
->clock_gmt
||
186 opts
->dbg_info_full_path
;
190 * Checks if any of the "ctf" legacy options is set.
193 bool ctf_legacy_opts_is_any_set(struct ctf_legacy_opts
*opts
)
195 return opts
->offset_s
.is_set
|| opts
->offset_ns
.is_set
||
196 opts
->stream_intersection
;
200 * Appends an "expecting token" error to the INI-style parsing state's
204 void ini_append_error_expecting(struct ini_parsing_state
*state
,
205 GScanner
*scanner
, const char *expecting
)
210 g_string_append_printf(state
->ini_error
, "Expecting %s:\n", expecting
);
212 /* Only print error if there's one line */
213 if (strchr(state
->arg
, '\n') != NULL
|| strlen(state
->arg
) == 0) {
217 g_string_append_printf(state
->ini_error
, "\n %s\n", state
->arg
);
218 pos
= g_scanner_cur_position(scanner
) + 4;
220 if (!g_scanner_eof(scanner
)) {
224 for (i
= 0; i
< pos
; ++i
) {
225 g_string_append_printf(state
->ini_error
, " ");
228 g_string_append_printf(state
->ini_error
, "^\n\n");
232 int ini_handle_state(struct ini_parsing_state
*state
)
235 GTokenType token_type
;
236 struct bt_value
*value
= NULL
;
238 token_type
= g_scanner_get_next_token(state
->scanner
);
239 if (token_type
== G_TOKEN_EOF
) {
240 if (state
->expecting
!= INI_EXPECT_COMMA
) {
241 switch (state
->expecting
) {
242 case INI_EXPECT_EQUAL
:
243 ini_append_error_expecting(state
,
244 state
->scanner
, "'='");
246 case INI_EXPECT_VALUE
:
247 case INI_EXPECT_VALUE_NUMBER_NEG
:
248 ini_append_error_expecting(state
,
249 state
->scanner
, "value");
251 case INI_EXPECT_MAP_KEY
:
252 ini_append_error_expecting(state
,
253 state
->scanner
, "unquoted map key");
266 switch (state
->expecting
) {
267 case INI_EXPECT_MAP_KEY
:
268 if (token_type
!= G_TOKEN_IDENTIFIER
) {
269 ini_append_error_expecting(state
, state
->scanner
,
274 free(state
->last_map_key
);
275 state
->last_map_key
=
276 strdup(state
->scanner
->value
.v_identifier
);
277 if (!state
->last_map_key
) {
278 g_string_append(state
->ini_error
,
283 if (bt_value_map_has_key(state
->params
, state
->last_map_key
)) {
284 g_string_append_printf(state
->ini_error
,
285 "Duplicate parameter key: `%s`\n",
286 state
->last_map_key
);
290 state
->expecting
= INI_EXPECT_EQUAL
;
292 case INI_EXPECT_EQUAL
:
293 if (token_type
!= G_TOKEN_CHAR
) {
294 ini_append_error_expecting(state
,
295 state
->scanner
, "'='");
299 if (state
->scanner
->value
.v_char
!= '=') {
300 ini_append_error_expecting(state
,
301 state
->scanner
, "'='");
305 state
->expecting
= INI_EXPECT_VALUE
;
307 case INI_EXPECT_VALUE
:
309 switch (token_type
) {
311 if (state
->scanner
->value
.v_char
== '-') {
312 /* Negative number */
314 INI_EXPECT_VALUE_NUMBER_NEG
;
317 ini_append_error_expecting(state
,
318 state
->scanner
, "value");
324 /* Positive integer */
325 uint64_t int_val
= state
->scanner
->value
.v_int64
;
327 if (int_val
> (1ULL << 63) - 1) {
328 g_string_append_printf(state
->ini_error
,
329 "Integer value %" PRIu64
" is outside the range of a 64-bit signed integer\n",
334 value
= bt_value_integer_create_init(
339 /* Positive floating point number */
340 value
= bt_value_float_create_init(
341 state
->scanner
->value
.v_float
);
345 value
= bt_value_string_create_init(
346 state
->scanner
->value
.v_string
);
348 case G_TOKEN_IDENTIFIER
:
351 * Using symbols would be appropriate here,
352 * but said symbols are allowed as map key,
353 * so it's easier to consider everything an
356 * If one of the known symbols is not
357 * recognized here, then fall back to creating
360 const char *id
= state
->scanner
->value
.v_identifier
;
362 if (!strcmp(id
, "null") || !strcmp(id
, "NULL") ||
363 !strcmp(id
, "nul")) {
364 value
= bt_value_null
;
365 } else if (!strcmp(id
, "true") || !strcmp(id
, "TRUE") ||
366 !strcmp(id
, "yes") ||
367 !strcmp(id
, "YES")) {
368 value
= bt_value_bool_create_init(true);
369 } else if (!strcmp(id
, "false") ||
370 !strcmp(id
, "FALSE") ||
373 value
= bt_value_bool_create_init(false);
375 value
= bt_value_string_create_init(id
);
380 /* Unset value variable will trigger the error */
385 ini_append_error_expecting(state
,
386 state
->scanner
, "value");
390 state
->expecting
= INI_EXPECT_COMMA
;
393 case INI_EXPECT_VALUE_NUMBER_NEG
:
395 switch (token_type
) {
398 /* Negative integer */
399 uint64_t int_val
= state
->scanner
->value
.v_int64
;
401 if (int_val
> (1ULL << 63) - 1) {
402 g_string_append_printf(state
->ini_error
,
403 "Integer value -%" PRIu64
" is outside the range of a 64-bit signed integer\n",
408 value
= bt_value_integer_create_init(
409 -((int64_t) int_val
));
413 /* Negative floating point number */
414 value
= bt_value_float_create_init(
415 -state
->scanner
->value
.v_float
);
418 /* Unset value variable will trigger the error */
423 ini_append_error_expecting(state
,
424 state
->scanner
, "value");
428 state
->expecting
= INI_EXPECT_COMMA
;
431 case INI_EXPECT_COMMA
:
432 if (token_type
!= G_TOKEN_CHAR
) {
433 ini_append_error_expecting(state
,
434 state
->scanner
, "','");
438 if (state
->scanner
->value
.v_char
!= ',') {
439 ini_append_error_expecting(state
,
440 state
->scanner
, "','");
444 state
->expecting
= INI_EXPECT_MAP_KEY
;
456 if (bt_value_map_insert(state
->params
,
457 state
->last_map_key
, value
)) {
458 /* Only override return value on error */
469 * Converts an INI-style argument to an equivalent map value object.
471 * Return value is owned by the caller.
474 struct bt_value
*bt_value_from_ini(const char *arg
, GString
*ini_error
)
476 /* Lexical scanner configuration */
477 GScannerConfig scanner_config
= {
478 /* Skip whitespaces */
479 .cset_skip_characters
= " \t\n",
481 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
482 .cset_identifier_first
=
486 .cset_identifier_nth
=
491 /* "hello" and "Hello" two different keys */
492 .case_sensitive
= TRUE
,
495 .cpair_comment_single
= NULL
,
496 .skip_comment_multi
= TRUE
,
497 .skip_comment_single
= TRUE
,
498 .scan_comment_multi
= FALSE
,
501 * Do scan identifiers, including 1-char identifiers,
502 * but NULL is a normal identifier.
504 .scan_identifier
= TRUE
,
505 .scan_identifier_1char
= TRUE
,
506 .scan_identifier_NULL
= FALSE
,
509 * No specific symbols: null and boolean "symbols" are
510 * scanned as plain identifiers.
512 .scan_symbols
= FALSE
,
513 .symbol_2_token
= FALSE
,
514 .scope_0_fallback
= FALSE
,
517 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
518 * integers prefixed with "$".
524 .scan_hex_dollar
= FALSE
,
526 /* Convert scanned numbers to integer tokens */
527 .numbers_2_int
= TRUE
,
529 /* Support both integers and floating-point numbers */
530 .int_2_float
= FALSE
,
532 /* Scan integers as 64-bit signed integers */
535 /* Only scan double-quoted strings */
536 .scan_string_sq
= FALSE
,
537 .scan_string_dq
= TRUE
,
539 /* Do not converter identifiers to string tokens */
540 .identifier_2_string
= FALSE
,
542 /* Scan characters as G_TOKEN_CHAR token */
543 .char_2_token
= FALSE
,
545 struct ini_parsing_state state
= {
548 .expecting
= INI_EXPECT_MAP_KEY
,
550 .ini_error
= ini_error
,
553 state
.params
= bt_value_map_create();
558 state
.scanner
= g_scanner_new(&scanner_config
);
559 if (!state
.scanner
) {
563 /* Let the scan begin */
564 g_scanner_input_text(state
.scanner
, arg
, strlen(arg
));
567 int ret
= ini_handle_state(&state
);
572 } else if (ret
> 0) {
581 BT_PUT(state
.params
);
585 g_scanner_destroy(state
.scanner
);
588 free(state
.last_map_key
);
593 * Returns the parameters map value object from a command-line
594 * parameter option's argument.
596 * Return value is owned by the caller.
599 struct bt_value
*bt_value_from_arg(const char *arg
)
601 struct bt_value
*params
= NULL
;
602 GString
*ini_error
= NULL
;
604 ini_error
= g_string_new(NULL
);
610 /* Try INI-style parsing */
611 params
= bt_value_from_ini(arg
, ini_error
);
613 printf_err("%s", ini_error
->str
);
619 g_string_free(ini_error
, TRUE
);
625 * Returns the plugin and component names from a command-line
626 * source/sink option's argument. arg must have the following format:
630 * where PLUGIN is the plugin name, and COMPONENT is the component
633 * On success, both *plugin and *component are not NULL. *plugin
634 * and *component are owned by the caller.
637 void plugin_component_names_from_arg(const char *arg
, char **plugin
,
643 size_t component_len
;
645 /* Initialize both return values to NULL: not found */
649 dot
= strchr(arg
, '.');
655 end
= arg
+ strlen(arg
);
656 plugin_len
= dot
- arg
;
657 component_len
= end
- dot
- 1;
658 if (plugin_len
== 0 || component_len
== 0) {
662 *plugin
= g_malloc0(plugin_len
+ 1);
668 g_strlcpy(*plugin
, arg
, plugin_len
+ 1);
669 *component
= g_malloc0(component_len
+ 1);
675 g_strlcpy(*component
, dot
+ 1, component_len
+ 1);
682 * Prints the Babeltrace version.
685 void print_version(void)
687 puts("Babeltrace " VERSION
);
691 * Prints the legacy, Babeltrace 1.x command usage. Those options are
692 * still compatible in Babeltrace 2.x, but it is recommended to use
693 * the more generic plugin/component parameters instead of those
694 * hard-coded option names.
697 void print_legacy_usage(FILE *fp
)
699 fprintf(fp
, "Usage: babeltrace [OPTIONS] INPUT...\n");
701 fprintf(fp
, "The following options are compatible with the Babeltrace 1.x options:\n");
703 fprintf(fp
, " --help-legacy Show this help\n");
704 fprintf(fp
, " -V, --version Show version\n");
705 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently correlated\n");
706 fprintf(fp
, " across traces\n");
707 fprintf(fp
, " -d, --debug Enable debug mode\n");
708 fprintf(fp
, " -i, --input-format=FORMAT Input trace format (default: ctf)\n");
709 fprintf(fp
, " -l, --list List available formats\n");
710 fprintf(fp
, " -o, --output-format=FORMAT Output trace format (default: text)\n");
711 fprintf(fp
, " -v, --verbose Enable verbose output\n");
713 fprintf(fp
, " Available input formats: ctf, lttng-live, ctf-metadata\n");
714 fprintf(fp
, " Available output formats: text, dummy\n");
716 fprintf(fp
, "Input formats specific options:\n");
718 fprintf(fp
, " INPUT... Input trace file(s), directory(ies), or URLs\n");
719 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
720 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n");
721 fprintf(fp
, " --stream-intersection Only process events when all streams are active\n");
723 fprintf(fp
, "text output format specific options:\n");
725 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
726 fprintf(fp
, " --clock-date Print timestamp dates\n");
727 fprintf(fp
, " --clock-gmt Print and parse timestamps in GMT time zone\n");
728 fprintf(fp
, " (default: local time zone)\n");
729 fprintf(fp
, " --clock-seconds Print the timestamps as [SEC.NS]\n");
730 fprintf(fp
, " (default format: [HH:MM:SS.NS])\n");
731 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
732 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
733 fprintf(fp
, " --debug-info-full-path Show full debug info source and binary paths\n");
734 fprintf(fp
, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n");
735 fprintf(fp
, " up executables during debug info analysis\n");
736 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
737 fprintf(fp
, " -f, --fields=NAME[,NAME]... Print additional fields:\n");
738 fprintf(fp
, " all, trace, trace:hostname, trace:domain,\n");
739 fprintf(fp
, " trace:procname, trace:vpid, loglevel, emf\n");
740 fprintf(fp
, " (default: trace:hostname, trace:procname,\n");
741 fprintf(fp
, " trace:vpid)\n");
742 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names:\n");
743 fprintf(fp
, " payload (or arg or args)\n");
744 fprintf(fp
, " none, all, scope, header, context (or ctx)\n");
745 fprintf(fp
, " (default: payload, context)\n");
746 fprintf(fp
, " --no-delta Do not print time delta between consecutive\n");
747 fprintf(fp
, " events\n");
748 fprintf(fp
, " -w, --output=PATH Write output to PATH (default: standard output)\n");
752 * Prints the Babeltrace 2.x usage.
755 void print_usage(FILE *fp
)
757 fprintf(fp
, "Usage: babeltrace [OPTIONS]\n");
759 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
760 fprintf(fp
, " of the following source and sink component\n");
761 fprintf(fp
, " instances (see the exact format of PARAMS\n");
762 fprintf(fp
, " below)\n");
763 fprintf(fp
, " -d, --debug Enable debug mode\n");
764 fprintf(fp
, " -l, --list List available plugins and their components\n");
765 fprintf(fp
, " -P, --path=PATH Set the `path` parameter of the latest source\n");
766 fprintf(fp
, " or sink component to PATH\n");
767 fprintf(fp
, " -p, --params=PARAMS Set the parameters of the latest source or\n");
768 fprintf(fp
, " sink component instance (in command-line \n");
769 fprintf(fp
, " order) to PARAMS (see the exact format of\n");
770 fprintf(fp
, " PARAMS below)\n");
771 fprintf(fp
, " --plugin-path=PATH[:PATH]... Set paths from which dynamic plugins can be\n");
772 fprintf(fp
, " loaded to PATH\n");
773 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters of the\n");
774 fprintf(fp
, " following source and sink component\n");
775 fprintf(fp
, " instances to an empty map\n");
776 fprintf(fp
, " -o, --sink=PLUGIN.COMPCLS Instantiate a sink component from plugin\n");
777 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
778 fprintf(fp
, " repeated)\n");
779 fprintf(fp
, " -i, --source=PLUGIN.COMPCLS Instantiate a source component from plugin\n");
780 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
781 fprintf(fp
, " repeated)\n");
782 fprintf(fp
, " --begin Start time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
783 fprintf(fp
, " --end End time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
784 fprintf(fp
, " --timerange Time range: begin,end or [begin,end] (where [] are actual brackets)\n");
785 fprintf(fp
, " -h --help Show this help\n");
786 fprintf(fp
, " --help-legacy Show Babeltrace 1.x legacy options\n");
787 fprintf(fp
, " -v, --verbose Enable verbose output\n");
788 fprintf(fp
, " -V, --version Show version\n");
790 fprintf(fp
, "Format of PARAMS\n");
791 fprintf(fp
, "----------------\n");
793 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
795 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
796 fprintf(fp
, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
797 fprintf(fp
, "VALUE can be one of:\n");
799 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
800 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
801 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
802 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
803 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
804 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
805 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
806 fprintf(fp
, " the null and boolean value symbols above.\n");
807 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
809 fprintf(fp
, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
811 fprintf(fp
, "Example:\n");
813 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
814 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
815 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
817 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
818 fprintf(fp
, "from a shell.\n");
822 * Destroys a component configuration.
825 void bt_config_component_destroy(struct bt_object
*obj
)
827 struct bt_config_component
*bt_config_component
=
828 container_of(obj
, struct bt_config_component
, base
);
834 if (bt_config_component
->plugin_name
) {
835 g_string_free(bt_config_component
->plugin_name
, TRUE
);
838 if (bt_config_component
->component_name
) {
839 g_string_free(bt_config_component
->component_name
, TRUE
);
842 BT_PUT(bt_config_component
->params
);
843 g_free(bt_config_component
);
850 * Creates a component configuration using the given plugin name and
851 * component name. plugin_name and component_name are copied (belong to
854 * Return value is owned by the caller.
857 struct bt_config_component
*bt_config_component_create(const char *plugin_name
,
858 const char *component_name
)
860 struct bt_config_component
*cfg_component
= NULL
;
862 cfg_component
= g_new0(struct bt_config_component
, 1);
863 if (!cfg_component
) {
868 bt_object_init(cfg_component
, bt_config_component_destroy
);
869 cfg_component
->plugin_name
= g_string_new(plugin_name
);
870 if (!cfg_component
->plugin_name
) {
875 cfg_component
->component_name
= g_string_new(component_name
);
876 if (!cfg_component
->component_name
) {
881 /* Start with empty parameters */
882 cfg_component
->params
= bt_value_map_create();
883 if (!cfg_component
->params
) {
891 BT_PUT(cfg_component
);
894 return cfg_component
;
898 * Creates a component configuration from a command-line source/sink
902 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
904 struct bt_config_component
*bt_config_component
= NULL
;
906 char *component_name
;
908 plugin_component_names_from_arg(arg
, &plugin_name
, &component_name
);
909 if (!plugin_name
|| !component_name
) {
910 printf_err("Cannot get plugin or component class name\n");
914 bt_config_component
= bt_config_component_create(plugin_name
,
916 if (!bt_config_component
) {
923 BT_PUT(bt_config_component
);
927 g_free(component_name
);
928 return bt_config_component
;
932 * Destroys a configuration.
935 void bt_config_destroy(struct bt_object
*obj
)
937 struct bt_config
*bt_config
=
938 container_of(obj
, struct bt_config
, base
);
944 if (bt_config
->sources
) {
945 g_ptr_array_free(bt_config
->sources
, TRUE
);
948 if (bt_config
->sinks
) {
949 g_ptr_array_free(bt_config
->sinks
, TRUE
);
952 BT_PUT(bt_config
->plugin_paths
);
960 * Extracts the various paths from the string arg, delimited by ':',
961 * and converts them to an array value object.
963 * Returned array value object is empty if arg is empty.
965 * Return value is owned by the caller.
968 struct bt_value
*plugin_paths_from_arg(const char *arg
)
970 struct bt_value
*plugin_paths
;
971 const char *at
= arg
;
972 const char *end
= arg
+ strlen(arg
);
974 plugin_paths
= bt_value_array_create();
983 const char *next_colon
;
985 next_colon
= strchr(at
, ':');
986 if (next_colon
== at
) {
988 * Empty path: try next character (supported
989 * to conform to the typical parsing of $PATH).
993 } else if (!next_colon
) {
994 /* No more colon: use the remaining */
995 next_colon
= arg
+ strlen(arg
);
998 path
= g_string_new(NULL
);
1004 g_string_append_len(path
, at
, next_colon
- at
);
1005 at
= next_colon
+ 1;
1006 ret
= bt_value_array_append_string(plugin_paths
, path
->str
);
1007 g_string_free(path
, TRUE
);
1017 BT_PUT(plugin_paths
);
1020 return plugin_paths
;
1024 * Creates a simple lexical scanner for parsing comma-delimited names
1027 * Return value is owned by the caller.
1030 GScanner
*create_csv_identifiers_scanner(void)
1032 GScannerConfig scanner_config
= {
1033 .cset_skip_characters
= " \t\n",
1034 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
1035 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
1036 .case_sensitive
= TRUE
,
1037 .cpair_comment_single
= NULL
,
1038 .skip_comment_multi
= TRUE
,
1039 .skip_comment_single
= TRUE
,
1040 .scan_comment_multi
= FALSE
,
1041 .scan_identifier
= TRUE
,
1042 .scan_identifier_1char
= TRUE
,
1043 .scan_identifier_NULL
= FALSE
,
1044 .scan_symbols
= FALSE
,
1045 .symbol_2_token
= FALSE
,
1046 .scope_0_fallback
= FALSE
,
1047 .scan_binary
= FALSE
,
1048 .scan_octal
= FALSE
,
1049 .scan_float
= FALSE
,
1051 .scan_hex_dollar
= FALSE
,
1052 .numbers_2_int
= FALSE
,
1053 .int_2_float
= FALSE
,
1054 .store_int64
= FALSE
,
1055 .scan_string_sq
= FALSE
,
1056 .scan_string_dq
= FALSE
,
1057 .identifier_2_string
= FALSE
,
1058 .char_2_token
= TRUE
,
1061 return g_scanner_new(&scanner_config
);
1065 * Inserts a string (if exists and not empty) or null to a map value
1069 enum bt_value_status
map_insert_string_or_null(struct bt_value
*map
,
1070 const char *key
, GString
*string
)
1072 enum bt_value_status ret
;
1074 if (string
&& string
->len
> 0) {
1075 ret
= bt_value_map_insert_string(map
, key
, string
->str
);
1077 ret
= bt_value_map_insert(map
, key
, bt_value_null
);
1083 * Converts a comma-delimited list of known names (--names option) to
1084 * an array value object containing those names as string value objects.
1086 * Return value is owned by the caller.
1089 struct bt_value
*names_from_arg(const char *arg
)
1091 GScanner
*scanner
= NULL
;
1092 struct bt_value
*names
= NULL
;
1093 bool found_all
= false, found_none
= false, found_item
= false;
1095 names
= bt_value_array_create();
1101 scanner
= create_csv_identifiers_scanner();
1107 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1110 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1112 switch (token_type
) {
1113 case G_TOKEN_IDENTIFIER
:
1115 const char *identifier
= scanner
->value
.v_identifier
;
1117 if (!strcmp(identifier
, "payload") ||
1118 !strcmp(identifier
, "args") ||
1119 !strcmp(identifier
, "arg")) {
1121 if (bt_value_array_append_string(names
,
1125 } else if (!strcmp(identifier
, "context") ||
1126 !strcmp(identifier
, "ctx")) {
1128 if (bt_value_array_append_string(names
,
1132 } else if (!strcmp(identifier
, "scope") ||
1133 !strcmp(identifier
, "header")) {
1135 if (bt_value_array_append_string(names
,
1139 } else if (!strcmp(identifier
, "all")) {
1141 if (bt_value_array_append_string(names
,
1145 } else if (!strcmp(identifier
, "none")) {
1147 if (bt_value_array_append_string(names
,
1152 printf_err("Unknown field name: `%s`\n",
1168 if (found_none
&& found_all
) {
1169 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1173 * Legacy behavior is to clear the defaults (show none) when at
1174 * least one item is specified.
1176 if (found_item
&& !found_none
&& !found_all
) {
1177 if (bt_value_array_append_string(names
, "none")) {
1182 g_scanner_destroy(scanner
);
1189 g_scanner_destroy(scanner
);
1196 * Converts a comma-delimited list of known fields (--fields option) to
1197 * an array value object containing those fields as string
1200 * Return value is owned by the caller.
1203 struct bt_value
*fields_from_arg(const char *arg
)
1205 GScanner
*scanner
= NULL
;
1206 struct bt_value
*fields
;
1208 fields
= bt_value_array_create();
1214 scanner
= create_csv_identifiers_scanner();
1220 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1223 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1225 switch (token_type
) {
1226 case G_TOKEN_IDENTIFIER
:
1228 const char *identifier
= scanner
->value
.v_identifier
;
1230 if (!strcmp(identifier
, "trace") ||
1231 !strcmp(identifier
, "trace:hostname") ||
1232 !strcmp(identifier
, "trace:domain") ||
1233 !strcmp(identifier
, "trace:procname") ||
1234 !strcmp(identifier
, "trace:vpid") ||
1235 !strcmp(identifier
, "loglevel") ||
1236 !strcmp(identifier
, "emf") ||
1237 !strcmp(identifier
, "callsite") ||
1238 !strcmp(identifier
, "all")) {
1239 if (bt_value_array_append_string(fields
,
1244 printf_err("Unknown field name: `%s`\n",
1266 g_scanner_destroy(scanner
);
1272 * Inserts the equivalent "prefix-name" true boolean value objects into
1273 * map_obj where the names are in array_obj.
1276 int insert_flat_names_fields_from_array(struct bt_value
*map_obj
,
1277 struct bt_value
*array_obj
, const char *prefix
)
1281 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1284 * array_obj may be NULL if no CLI options were specified to
1285 * trigger its creation.
1291 tmpstr
= g_string_new(NULL
);
1298 default_value
= g_string_new(NULL
);
1299 if (!default_value
) {
1305 for (i
= 0; i
< bt_value_array_size(array_obj
); i
++) {
1306 struct bt_value
*str_obj
= bt_value_array_get(array_obj
, i
);
1308 bool is_default
= false;
1311 printf_err("Unexpected error\n");
1316 ret
= bt_value_string_get(str_obj
, &suffix
);
1319 printf_err("Unexpected error\n");
1323 g_string_assign(tmpstr
, prefix
);
1324 g_string_append(tmpstr
, "-");
1326 /* Special-case for "all" and "none". */
1327 if (!strcmp(suffix
, "all")) {
1329 g_string_assign(default_value
, "show");
1330 } else if (!strcmp(suffix
, "none")) {
1332 g_string_assign(default_value
, "hide");
1335 g_string_append(tmpstr
, "default");
1336 ret
= map_insert_string_or_null(map_obj
,
1344 g_string_append(tmpstr
, suffix
);
1345 ret
= bt_value_map_insert_bool(map_obj
, tmpstr
->str
,
1355 if (default_value
) {
1356 g_string_free(default_value
, TRUE
);
1359 g_string_free(tmpstr
, TRUE
);
1366 * Returns the parameters (map value object) corresponding to the
1367 * legacy text format options.
1369 * Return value is owned by the caller.
1372 struct bt_value
*params_from_text_legacy_opts(
1373 struct text_legacy_opts
*text_legacy_opts
)
1375 struct bt_value
*params
;
1377 params
= bt_value_map_create();
1383 if (map_insert_string_or_null(params
, "output-path",
1384 text_legacy_opts
->output
)) {
1389 if (map_insert_string_or_null(params
, "debug-info-dir",
1390 text_legacy_opts
->dbg_info_dir
)) {
1395 if (map_insert_string_or_null(params
, "debug-info-target-prefix",
1396 text_legacy_opts
->dbg_info_target_prefix
)) {
1401 if (bt_value_map_insert_bool(params
, "debug-info-full-path",
1402 text_legacy_opts
->dbg_info_full_path
)) {
1407 if (bt_value_map_insert_bool(params
, "no-delta",
1408 text_legacy_opts
->no_delta
)) {
1413 if (bt_value_map_insert_bool(params
, "clock-cycles",
1414 text_legacy_opts
->clock_cycles
)) {
1419 if (bt_value_map_insert_bool(params
, "clock-seconds",
1420 text_legacy_opts
->clock_seconds
)) {
1425 if (bt_value_map_insert_bool(params
, "clock-date",
1426 text_legacy_opts
->clock_date
)) {
1431 if (bt_value_map_insert_bool(params
, "clock-gmt",
1432 text_legacy_opts
->clock_gmt
)) {
1437 if (insert_flat_names_fields_from_array(params
,
1438 text_legacy_opts
->names
, "name")) {
1442 if (insert_flat_names_fields_from_array(params
,
1443 text_legacy_opts
->fields
, "field")) {
1457 int append_sinks_from_legacy_opts(GPtrArray
*sinks
,
1458 enum legacy_output_format legacy_output_format
,
1459 struct text_legacy_opts
*text_legacy_opts
)
1462 struct bt_value
*params
= NULL
;
1463 const char *plugin_name
;
1464 const char *component_name
;
1465 struct bt_config_component
*bt_config_component
= NULL
;
1467 switch (legacy_output_format
) {
1468 case LEGACY_OUTPUT_FORMAT_TEXT
:
1469 plugin_name
= "text";
1470 component_name
= "text";
1472 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1473 plugin_name
= "ctf";
1474 component_name
= "metadata-text";
1476 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1477 plugin_name
= "dummy";
1478 component_name
= "dummy";
1485 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
) {
1486 /* Legacy "text" output format has parameters */
1487 params
= params_from_text_legacy_opts(text_legacy_opts
);
1493 * Legacy "dummy" and "ctf-metadata" output formats do
1494 * not have parameters.
1496 params
= bt_value_map_create();
1503 /* Create a component configuration */
1504 bt_config_component
= bt_config_component_create(plugin_name
,
1506 if (!bt_config_component
) {
1510 BT_MOVE(bt_config_component
->params
, params
);
1512 /* Move created component configuration to the array */
1513 g_ptr_array_add(sinks
, bt_config_component
);
1527 * Returns the parameters (map value object) corresponding to the
1528 * given legacy CTF format options.
1530 * Return value is owned by the caller.
1533 struct bt_value
*params_from_ctf_legacy_opts(
1534 struct ctf_legacy_opts
*ctf_legacy_opts
)
1536 struct bt_value
*params
;
1538 params
= bt_value_map_create();
1544 if (bt_value_map_insert_integer(params
, "offset-s",
1545 ctf_legacy_opts
->offset_s
.value
)) {
1550 if (bt_value_map_insert_integer(params
, "offset-ns",
1551 ctf_legacy_opts
->offset_ns
.value
)) {
1556 if (bt_value_map_insert_bool(params
, "stream-intersection",
1557 ctf_legacy_opts
->stream_intersection
)) {
1572 int append_sources_from_legacy_opts(GPtrArray
*sources
,
1573 enum legacy_input_format legacy_input_format
,
1574 struct ctf_legacy_opts
*ctf_legacy_opts
,
1575 struct bt_value
*legacy_input_paths
)
1579 struct bt_value
*base_params
;
1580 struct bt_value
*params
= NULL
;
1581 struct bt_value
*input_path
= NULL
;
1582 struct bt_value
*input_path_copy
= NULL
;
1583 const char *input_key
;
1584 const char *component_name
;
1586 switch (legacy_input_format
) {
1587 case LEGACY_INPUT_FORMAT_CTF
:
1589 component_name
= "fs";
1591 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1593 component_name
= "lttng-live";
1600 base_params
= params_from_ctf_legacy_opts(ctf_legacy_opts
);
1605 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1606 struct bt_config_component
*bt_config_component
= NULL
;
1608 /* Copy base parameters as current parameters */
1609 params
= bt_value_copy(base_params
);
1614 /* Get current input path string value object */
1615 input_path
= bt_value_array_get(legacy_input_paths
, i
);
1620 /* Copy current input path value object */
1621 input_path_copy
= bt_value_copy(input_path
);
1622 if (!input_path_copy
) {
1626 /* Insert input path value object into current parameters */
1627 ret
= bt_value_map_insert(params
, input_key
, input_path_copy
);
1632 /* Create a component configuration */
1633 bt_config_component
= bt_config_component_create("ctf",
1635 if (!bt_config_component
) {
1639 BT_MOVE(bt_config_component
->params
, params
);
1641 /* Move created component configuration to the array */
1642 g_ptr_array_add(sources
, bt_config_component
);
1644 /* Put current stuff */
1646 BT_PUT(input_path_copy
);
1655 BT_PUT(base_params
);
1658 BT_PUT(input_path_copy
);
1663 * Escapes a string for the shell. The string is escaped knowing that
1664 * it's a parameter string value (double-quoted), and that it will be
1665 * entered between single quotes in the shell.
1667 * Return value is owned by the caller.
1670 char *str_shell_escape(const char *input
)
1673 const char *at
= input
;
1674 GString
*str
= g_string_new(NULL
);
1680 while (*at
!= '\0') {
1683 g_string_append(str
, "\\\\");
1686 g_string_append(str
, "\\\"");
1689 g_string_append(str
, "'\"'\"'");
1692 g_string_append(str
, "\\n");
1695 g_string_append(str
, "\\t");
1698 g_string_append_c(str
, *at
);
1708 g_string_free(str
, FALSE
);
1715 int append_prefixed_flag_params(GString
*str
, struct bt_value
*flags
,
1725 for (i
= 0; i
< bt_value_array_size(flags
); i
++) {
1726 struct bt_value
*value
= bt_value_array_get(flags
, i
);
1734 if (bt_value_string_get(value
, &flag
)) {
1740 g_string_append_printf(str
, ",%s-%s=true", prefix
, flag
);
1749 * Appends a boolean parameter string.
1752 void g_string_append_bool_param(GString
*str
, const char *name
, bool value
)
1754 g_string_append_printf(str
, ",%s=%s", name
, value
? "true" : "false");
1758 * Appends a path parameter string, or null if it's empty.
1761 int g_string_append_string_path_param(GString
*str
, const char *name
,
1766 if (path
->len
> 0) {
1767 char *escaped_path
= str_shell_escape(path
->str
);
1769 if (!escaped_path
) {
1774 g_string_append_printf(str
, "%s=\"%s\"", name
, escaped_path
);
1777 g_string_append_printf(str
, "%s=null", name
);
1790 * Prints the non-legacy sink options equivalent to the specified
1791 * legacy output format options.
1794 void print_output_legacy_to_sinks(
1795 enum legacy_output_format legacy_output_format
,
1796 struct text_legacy_opts
*text_legacy_opts
)
1798 const char *input_format
;
1799 GString
*str
= NULL
;
1801 str
= g_string_new(" ");
1807 switch (legacy_output_format
) {
1808 case LEGACY_OUTPUT_FORMAT_TEXT
:
1809 input_format
= "text";
1811 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1812 input_format
= "ctf-metadata";
1814 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1815 input_format
= "dummy";
1821 printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
1823 printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
1825 g_string_append(str
, "-o ");
1827 switch (legacy_output_format
) {
1828 case LEGACY_OUTPUT_FORMAT_TEXT
:
1829 g_string_append(str
, "text.text");
1831 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1832 g_string_append(str
, "ctf.metadata-text");
1834 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1835 g_string_append(str
, "dummy.dummy");
1841 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
&&
1842 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1845 g_string_append(str
, " -p '");
1847 if (g_string_append_string_path_param(str
, "output-path",
1848 text_legacy_opts
->output
)) {
1852 g_string_append(str
, ",");
1854 if (g_string_append_string_path_param(str
, "debug-info-dir",
1855 text_legacy_opts
->dbg_info_dir
)) {
1859 g_string_append(str
, ",");
1861 if (g_string_append_string_path_param(str
,
1862 "debug-info-target-prefix",
1863 text_legacy_opts
->dbg_info_target_prefix
)) {
1867 g_string_append_bool_param(str
, "no-delta",
1868 text_legacy_opts
->no_delta
);
1869 g_string_append_bool_param(str
, "clock-cycles",
1870 text_legacy_opts
->clock_cycles
);
1871 g_string_append_bool_param(str
, "clock-seconds",
1872 text_legacy_opts
->clock_seconds
);
1873 g_string_append_bool_param(str
, "clock-date",
1874 text_legacy_opts
->clock_date
);
1875 g_string_append_bool_param(str
, "clock-gmt",
1876 text_legacy_opts
->clock_gmt
);
1877 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->names
,
1883 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->fields
,
1889 /* Remove last comma and close single quote */
1890 g_string_append(str
, "'");
1893 printf_err("%s\n\n", str
->str
);
1897 g_string_free(str
, TRUE
);
1903 * Prints the non-legacy source options equivalent to the specified
1904 * legacy input format options.
1907 void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format
,
1908 struct bt_value
*legacy_input_paths
,
1909 struct ctf_legacy_opts
*ctf_legacy_opts
)
1911 const char *input_format
;
1912 GString
*str
= NULL
;
1915 str
= g_string_new(" ");
1921 switch (legacy_input_format
) {
1922 case LEGACY_INPUT_FORMAT_CTF
:
1923 input_format
= "ctf";
1925 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1926 input_format
= "lttng-live";
1932 printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
1934 printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
1937 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1938 struct bt_value
*input_value
=
1939 bt_value_array_get(legacy_input_paths
, i
);
1940 const char *input
= NULL
;
1941 char *escaped_input
;
1944 assert(input_value
);
1945 ret
= bt_value_string_get(input_value
, &input
);
1946 BT_PUT(input_value
);
1947 assert(!ret
&& input
);
1948 escaped_input
= str_shell_escape(input
);
1949 if (!escaped_input
) {
1954 g_string_append(str
, "-i ctf.");
1956 switch (legacy_input_format
) {
1957 case LEGACY_INPUT_FORMAT_CTF
:
1958 g_string_append(str
, "fs -p 'path=\"");
1960 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1961 g_string_append(str
, "lttng-live -p 'url=\"");
1967 g_string_append(str
, escaped_input
);
1968 g_string_append(str
, "\"");
1969 g_string_append_printf(str
, ",offset-s=%" PRId64
,
1970 ctf_legacy_opts
->offset_s
.value
);
1971 g_string_append_printf(str
, ",offset-ns=%" PRId64
,
1972 ctf_legacy_opts
->offset_ns
.value
);
1973 g_string_append_bool_param(str
, "stream-intersection",
1974 ctf_legacy_opts
->stream_intersection
);
1975 g_string_append(str
, "' ");
1976 g_free(escaped_input
);
1979 printf_err("%s\n\n", str
->str
);
1983 g_string_free(str
, TRUE
);
1989 * Validates a given configuration, with optional legacy input and
1990 * output formats options. Prints useful error messages if anything
1993 * Returns true when the configuration is valid.
1996 bool validate_cfg(struct bt_config
*cfg
,
1997 enum legacy_input_format
*legacy_input_format
,
1998 enum legacy_output_format
*legacy_output_format
,
1999 struct bt_value
*legacy_input_paths
,
2000 struct ctf_legacy_opts
*ctf_legacy_opts
,
2001 struct text_legacy_opts
*text_legacy_opts
)
2003 bool legacy_input
= false;
2004 bool legacy_output
= false;
2006 /* Determine if the input and output should be legacy-style */
2007 if (*legacy_input_format
!= LEGACY_INPUT_FORMAT_NONE
||
2008 cfg
->sources
->len
== 0 ||
2009 !bt_value_array_is_empty(legacy_input_paths
) ||
2010 ctf_legacy_opts_is_any_set(ctf_legacy_opts
)) {
2011 legacy_input
= true;
2014 if (*legacy_output_format
!= LEGACY_OUTPUT_FORMAT_NONE
||
2015 cfg
->sinks
->len
== 0 ||
2016 text_legacy_opts_is_any_set(text_legacy_opts
)) {
2017 legacy_output
= true;
2021 /* If no legacy input format was specified, default to CTF */
2022 if (*legacy_input_format
== LEGACY_INPUT_FORMAT_NONE
) {
2023 *legacy_input_format
= LEGACY_INPUT_FORMAT_CTF
;
2026 /* Make sure at least one input path exists */
2027 if (bt_value_array_is_empty(legacy_input_paths
)) {
2028 switch (*legacy_input_format
) {
2029 case LEGACY_INPUT_FORMAT_CTF
:
2030 printf_err("No input path specified for legacy `ctf` input format\n");
2032 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
2033 printf_err("No URL specified for legacy `lttng-live` input format\n");
2041 /* Make sure no non-legacy sources are specified */
2042 if (cfg
->sources
->len
!= 0) {
2043 print_input_legacy_to_sources(*legacy_input_format
,
2044 legacy_input_paths
, ctf_legacy_opts
);
2049 if (legacy_output
) {
2051 * If no legacy output format was specified, default to
2054 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_NONE
) {
2055 *legacy_output_format
= LEGACY_OUTPUT_FORMAT_TEXT
;
2059 * If any "text" option was specified, the output must be
2062 if (text_legacy_opts_is_any_set(text_legacy_opts
) &&
2063 *legacy_output_format
!=
2064 LEGACY_OUTPUT_FORMAT_TEXT
) {
2065 printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
2069 /* Make sure no non-legacy sinks are specified */
2070 if (cfg
->sinks
->len
!= 0) {
2071 print_output_legacy_to_sinks(*legacy_output_format
,
2078 * If the output is the legacy "ctf-metadata" format, then the
2079 * input should be the legacy "ctf" input format.
2081 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_CTF_METADATA
&&
2082 *legacy_input_format
!= LEGACY_INPUT_FORMAT_CTF
) {
2083 printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
2094 * Parses a 64-bit signed integer.
2096 * Returns a negative value if anything goes wrong.
2099 int parse_int64(const char *arg
, int64_t *val
)
2104 *val
= strtoll(arg
, &endptr
, 0);
2105 if (*endptr
!= '\0' || arg
== endptr
|| errno
!= 0) {
2119 OPT_CLOCK_FORCE_CORRELATE
,
2122 OPT_CLOCK_OFFSET_NS
,
2126 OPT_DEBUG_INFO_FULL_PATH
,
2127 OPT_DEBUG_INFO_TARGET_PREFIX
,
2141 OPT_RESET_BASE_PARAMS
,
2144 OPT_STREAM_INTERSECTION
,
2150 /* popt long option descriptions */
2151 static struct poptOption long_options
[] = {
2152 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2153 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
2154 { "begin", '\0', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2155 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2156 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2157 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2158 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2159 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2160 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2161 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2162 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2163 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2164 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2165 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2166 { "end", '\0', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2167 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2168 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2169 { "help-legacy", '\0', POPT_ARG_NONE
, NULL
, OPT_HELP_LEGACY
, NULL
, NULL
},
2170 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2171 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
2172 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2173 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2174 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_PATH
, NULL
, NULL
},
2175 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2176 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2177 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2178 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2179 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
2180 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2181 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2182 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2183 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2184 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2185 { "version", 'V', POPT_ARG_NONE
, NULL
, OPT_VERSION
, NULL
, NULL
},
2186 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2190 * Sets the value of a given legacy offset option and marks it as set.
2192 static void set_offset_value(struct offset_opt
*offset_opt
, int64_t value
)
2194 offset_opt
->value
= value
;
2195 offset_opt
->is_set
= true;
2198 enum bt_config_component_dest
{
2199 BT_CONFIG_COMPONENT_DEST_SOURCE
,
2200 BT_CONFIG_COMPONENT_DEST_SINK
,
2204 * Adds a configuration component to the appropriate configuration
2205 * array depending on the destination.
2207 static void add_cfg_comp(struct bt_config
*cfg
,
2208 struct bt_config_component
*cfg_comp
,
2209 enum bt_config_component_dest dest
)
2211 if (dest
== BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2212 g_ptr_array_add(cfg
->sources
, cfg_comp
);
2214 g_ptr_array_add(cfg
->sinks
, cfg_comp
);
2218 static int split_timerange(const char *arg
, const char **begin
, const char **end
)
2222 /* Try to match [begin,end] */
2223 c
= strchr(arg
, '[');
2237 /* Try to match begin,end */
2252 * Returns a Babeltrace configuration, out of command-line arguments,
2253 * containing everything that is needed to instanciate specific
2254 * components with given parameters.
2256 * *exit_code is set to the appropriate exit code to use as far as this
2259 * Return value is NULL on error, otherwise it's owned by the caller.
2261 struct bt_config
*bt_config_from_args(int argc
, const char *argv
[], int *exit_code
)
2263 struct bt_config
*cfg
= NULL
;
2264 poptContext pc
= NULL
;
2266 struct ctf_legacy_opts ctf_legacy_opts
;
2267 struct text_legacy_opts text_legacy_opts
;
2268 enum legacy_input_format legacy_input_format
= LEGACY_INPUT_FORMAT_NONE
;
2269 enum legacy_output_format legacy_output_format
=
2270 LEGACY_OUTPUT_FORMAT_NONE
;
2271 struct bt_value
*legacy_input_paths
= NULL
;
2272 struct bt_config_component
*implicit_source_comp
= NULL
;
2273 struct bt_config_component
*cur_cfg_comp
= NULL
;
2274 bool cur_is_implicit_source
= false;
2275 bool use_implicit_source
= false;
2276 enum bt_config_component_dest cur_cfg_comp_dest
=
2277 BT_CONFIG_COMPONENT_DEST_SOURCE
;
2278 struct bt_value
*cur_base_params
= NULL
;
2280 bool cur_cfg_comp_params_set
= false;
2282 memset(&ctf_legacy_opts
, 0, sizeof(ctf_legacy_opts
));
2283 memset(&text_legacy_opts
, 0, sizeof(text_legacy_opts
));
2287 print_usage(stdout
);
2291 text_legacy_opts
.output
= g_string_new(NULL
);
2292 if (!text_legacy_opts
.output
) {
2297 text_legacy_opts
.dbg_info_dir
= g_string_new(NULL
);
2298 if (!text_legacy_opts
.dbg_info_dir
) {
2303 text_legacy_opts
.dbg_info_target_prefix
= g_string_new(NULL
);
2304 if (!text_legacy_opts
.dbg_info_target_prefix
) {
2309 cur_base_params
= bt_value_map_create();
2310 if (!cur_base_params
) {
2316 cfg
= g_new0(struct bt_config
, 1);
2322 bt_object_init(cfg
, bt_config_destroy
);
2323 cfg
->sources
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2324 if (!cfg
->sources
) {
2329 cfg
->sinks
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2335 legacy_input_paths
= bt_value_array_create();
2336 if (!legacy_input_paths
) {
2341 /* Note: implicit source never gets positional base params. */
2342 implicit_source_comp
= bt_config_component_from_arg(DEFAULT_SOURCE_COMPONENT_NAME
);
2343 if (implicit_source_comp
) {
2344 cur_cfg_comp
= implicit_source_comp
;
2345 cur_is_implicit_source
= true;
2346 use_implicit_source
= true;
2348 printf_debug("Cannot find implicit source plugin \"%s\"",
2349 DEFAULT_SOURCE_COMPONENT_NAME
);
2353 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
2355 printf_err("Cannot get popt context\n");
2359 poptReadDefaultConfig(pc
, 0);
2361 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2362 arg
= poptGetOptArg(pc
);
2365 case OPT_PLUGIN_PATH
:
2366 if (cfg
->plugin_paths
) {
2367 printf_err("Duplicate --plugin-path option\n");
2371 cfg
->plugin_paths
= plugin_paths_from_arg(arg
);
2372 if (!cfg
->plugin_paths
) {
2373 printf_err("Invalid --plugin-path option's argument\n");
2377 case OPT_OUTPUT_PATH
:
2378 if (text_legacy_opts
.output
->len
> 0) {
2379 printf_err("Duplicate --output option\n");
2383 g_string_assign(text_legacy_opts
.output
, arg
);
2385 case OPT_DEBUG_INFO_DIR
:
2386 if (text_legacy_opts
.dbg_info_dir
->len
> 0) {
2387 printf_err("Duplicate --debug-info-dir option\n");
2391 g_string_assign(text_legacy_opts
.dbg_info_dir
, arg
);
2393 case OPT_DEBUG_INFO_TARGET_PREFIX
:
2394 if (text_legacy_opts
.dbg_info_target_prefix
->len
> 0) {
2395 printf_err("Duplicate --debug-info-target-prefix option\n");
2399 g_string_assign(text_legacy_opts
.dbg_info_target_prefix
, arg
);
2401 case OPT_INPUT_FORMAT
:
2404 if (opt
== OPT_INPUT_FORMAT
) {
2405 if (!strcmp(arg
, "ctf")) {
2406 /* Legacy CTF input format */
2407 if (legacy_input_format
) {
2408 print_err_dup_legacy_input();
2412 legacy_input_format
=
2413 LEGACY_INPUT_FORMAT_CTF
;
2415 } else if (!strcmp(arg
, "lttng-live")) {
2416 /* Legacy LTTng-live input format */
2417 if (legacy_input_format
) {
2418 print_err_dup_legacy_input();
2422 legacy_input_format
=
2423 LEGACY_INPUT_FORMAT_LTTNG_LIVE
;
2428 use_implicit_source
= false;
2430 /* Non-legacy: try to create a component config */
2431 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
2432 add_cfg_comp(cfg
, cur_cfg_comp
,
2436 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2437 if (!cur_cfg_comp
) {
2438 printf_err("Invalid format for --source option's argument:\n %s\n",
2442 cur_is_implicit_source
= false;
2444 assert(cur_base_params
);
2445 bt_put(cur_cfg_comp
->params
);
2446 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2447 if (!cur_cfg_comp
) {
2452 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2453 cur_cfg_comp_params_set
= false;
2456 case OPT_OUTPUT_FORMAT
:
2459 if (opt
== OPT_OUTPUT_FORMAT
) {
2460 if (!strcmp(arg
, "text")) {
2461 /* Legacy CTF-text output format */
2462 if (legacy_output_format
) {
2463 print_err_dup_legacy_output();
2467 legacy_output_format
=
2468 LEGACY_OUTPUT_FORMAT_TEXT
;
2470 } else if (!strcmp(arg
, "dummy")) {
2471 /* Legacy dummy output format */
2472 if (legacy_output_format
) {
2473 print_err_dup_legacy_output();
2477 legacy_output_format
=
2478 LEGACY_OUTPUT_FORMAT_DUMMY
;
2480 } else if (!strcmp(arg
, "ctf-metadata")) {
2481 /* Legacy CTF-metadata output format */
2482 if (legacy_output_format
) {
2483 print_err_dup_legacy_output();
2487 legacy_output_format
=
2488 LEGACY_OUTPUT_FORMAT_CTF_METADATA
;
2493 /* Non-legacy: try to create a component config */
2494 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
2495 add_cfg_comp(cfg
, cur_cfg_comp
,
2499 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2500 if (!cur_cfg_comp
) {
2501 printf_err("Invalid format for --sink option's argument:\n %s\n",
2505 cur_is_implicit_source
= false;
2507 assert(cur_base_params
);
2508 bt_put(cur_cfg_comp
->params
);
2509 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2510 if (!cur_cfg_comp
) {
2515 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2516 cur_cfg_comp_params_set
= false;
2521 struct bt_value
*params
;
2522 struct bt_value
*params_to_set
;
2524 if (!cur_cfg_comp
) {
2525 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2526 DEFAULT_SOURCE_COMPONENT_NAME
);
2530 if (cur_cfg_comp_params_set
) {
2531 printf_err("Duplicate --params option for the same current component\ninstance (class %s.%s)\n",
2532 cur_cfg_comp
->plugin_name
->str
,
2533 cur_cfg_comp
->component_name
->str
);
2537 params
= bt_value_from_arg(arg
);
2539 printf_err("Invalid format for --params option's argument:\n %s\n",
2544 params_to_set
= bt_value_map_extend(cur_base_params
,
2547 if (!params_to_set
) {
2548 printf_err("Cannot extend current base parameters with --params option's argument:\n %s\n",
2553 BT_MOVE(cur_cfg_comp
->params
, params_to_set
);
2554 cur_cfg_comp_params_set
= true;
2558 if (!cur_cfg_comp
) {
2559 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2560 DEFAULT_SOURCE_COMPONENT_NAME
);
2564 assert(cur_cfg_comp
->params
);
2566 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2572 case OPT_BASE_PARAMS
:
2574 struct bt_value
*params
= bt_value_from_arg(arg
);
2577 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2582 BT_MOVE(cur_base_params
, params
);
2585 case OPT_RESET_BASE_PARAMS
:
2586 BT_PUT(cur_base_params
);
2587 cur_base_params
= bt_value_map_create();
2588 if (!cur_base_params
) {
2594 if (text_legacy_opts
.names
) {
2595 printf_err("Duplicate --names option\n");
2599 text_legacy_opts
.names
= names_from_arg(arg
);
2600 if (!text_legacy_opts
.names
) {
2601 printf_err("Invalid --names option's argument\n");
2606 if (text_legacy_opts
.fields
) {
2607 printf_err("Duplicate --fields option\n");
2611 text_legacy_opts
.fields
= fields_from_arg(arg
);
2612 if (!text_legacy_opts
.fields
) {
2613 printf_err("Invalid --fields option's argument\n");
2618 text_legacy_opts
.no_delta
= true;
2620 case OPT_CLOCK_CYCLES
:
2621 text_legacy_opts
.clock_cycles
= true;
2623 case OPT_CLOCK_SECONDS
:
2624 text_legacy_opts
.clock_seconds
= true;
2626 case OPT_CLOCK_DATE
:
2627 text_legacy_opts
.clock_date
= true;
2630 text_legacy_opts
.clock_gmt
= true;
2632 case OPT_DEBUG_INFO_FULL_PATH
:
2633 text_legacy_opts
.dbg_info_full_path
= true;
2635 case OPT_CLOCK_OFFSET
:
2639 if (ctf_legacy_opts
.offset_s
.is_set
) {
2640 printf_err("Duplicate --clock-offset option\n");
2644 if (parse_int64(arg
, &val
)) {
2645 printf_err("Invalid --clock-offset option's argument\n");
2649 set_offset_value(&ctf_legacy_opts
.offset_s
, val
);
2652 case OPT_CLOCK_OFFSET_NS
:
2656 if (ctf_legacy_opts
.offset_ns
.is_set
) {
2657 printf_err("Duplicate --clock-offset-ns option\n");
2661 if (parse_int64(arg
, &val
)) {
2662 printf_err("Invalid --clock-offset-ns option's argument\n");
2666 set_offset_value(&ctf_legacy_opts
.offset_ns
, val
);
2669 case OPT_STREAM_INTERSECTION
:
2670 ctf_legacy_opts
.stream_intersection
= true;
2672 case OPT_CLOCK_FORCE_CORRELATE
:
2673 cfg
->force_correlate
= true;
2676 if (!cur_cfg_comp
) {
2677 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2678 DEFAULT_SOURCE_COMPONENT_NAME
);
2681 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2682 printf_err("--begin option must follow a --source option\n");
2685 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2692 if (!cur_cfg_comp
) {
2693 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2694 DEFAULT_SOURCE_COMPONENT_NAME
);
2697 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2698 printf_err("--end option must follow a --source option\n");
2701 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2709 const char *begin
, *end
;
2711 if (!cur_cfg_comp
) {
2712 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2713 DEFAULT_SOURCE_COMPONENT_NAME
);
2716 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2717 printf_err("--timerange option must follow a --source option\n");
2720 if (split_timerange(arg
, &begin
, &end
)) {
2721 printf_err("Invalid --timerange format, expecting: begin,end or [begin,end] (where [] are actual brackets)\n");
2724 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2729 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2738 print_usage(stdout
);
2740 case OPT_HELP_LEGACY
:
2742 print_legacy_usage(stdout
);
2749 cfg
->do_list
= true;
2752 cfg
->verbose
= true;
2758 printf_err("Unknown command-line option specified (option code %d)\n",
2767 /* Append current component configuration, if any */
2768 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
2769 add_cfg_comp(cfg
, cur_cfg_comp
, cur_cfg_comp_dest
);
2771 cur_cfg_comp
= NULL
;
2773 if (use_implicit_source
) {
2774 add_cfg_comp(cfg
, implicit_source_comp
,
2775 BT_CONFIG_COMPONENT_DEST_SOURCE
);
2776 implicit_source_comp
= NULL
;
2778 if (implicit_source_comp
2779 && !bt_value_map_is_empty(implicit_source_comp
->params
)) {
2780 printf_err("Arguments specified for implicit source, but an explicit source has been specified, overriding it\n");
2785 /* Check for option parsing error */
2787 printf_err("While parsing command-line options, at option %s: %s\n",
2788 poptBadOption(pc
, 0), poptStrerror(opt
));
2792 /* Consume leftover arguments as legacy input paths */
2794 const char *input_path
= poptGetArg(pc
);
2800 if (bt_value_array_append_string(legacy_input_paths
,
2807 /* Validate legacy/non-legacy options */
2808 if (!validate_cfg(cfg
, &legacy_input_format
, &legacy_output_format
,
2809 legacy_input_paths
, &ctf_legacy_opts
,
2810 &text_legacy_opts
)) {
2811 printf_err("Command-line options form an invalid configuration\n");
2816 * If there's a legacy input format, convert it to source
2817 * component configurations.
2819 if (legacy_input_format
) {
2820 if (append_sources_from_legacy_opts(cfg
->sources
,
2821 legacy_input_format
, &ctf_legacy_opts
,
2822 legacy_input_paths
)) {
2823 printf_err("Cannot convert legacy input format options to source component instance(s)\n");
2829 * If there's a legacy output format, convert it to sink
2830 * component configurations.
2832 if (legacy_output_format
) {
2833 if (append_sinks_from_legacy_opts(cfg
->sinks
,
2834 legacy_output_format
, &text_legacy_opts
)) {
2835 printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
2849 poptFreeContext(pc
);
2852 if (text_legacy_opts
.output
) {
2853 g_string_free(text_legacy_opts
.output
, TRUE
);
2856 if (text_legacy_opts
.dbg_info_dir
) {
2857 g_string_free(text_legacy_opts
.dbg_info_dir
, TRUE
);
2860 if (text_legacy_opts
.dbg_info_target_prefix
) {
2861 g_string_free(text_legacy_opts
.dbg_info_target_prefix
, TRUE
);
2865 BT_PUT(implicit_source_comp
);
2866 BT_PUT(cur_cfg_comp
);
2867 BT_PUT(cur_base_params
);
2868 BT_PUT(text_legacy_opts
.names
);
2869 BT_PUT(text_legacy_opts
.fields
);
2870 BT_PUT(legacy_input_paths
);