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 <sys/types.h>
38 #include "babeltrace-cfg.h"
40 #define SYSTEM_PLUGIN_PATH INSTALL_LIBDIR "/babeltrace/plugins"
41 #define DEFAULT_SOURCE_COMPONENT_NAME "ctf.fs"
42 #define DEFAULT_SINK_COMPONENT_NAME "text.text"
43 #define HOME_ENV_VAR "HOME"
44 #define HOME_SUBPATH "/.babeltrace/plugins"
47 * Error printf() macro which prepends "Error: " the first time it's
48 * called. This gives a nicer feel than having a bunch of error prefixes
49 * (since the following lines usually describe the error and possible
50 * solutions), or the error prefix just at the end.
52 #define printf_err(fmt, args...) \
54 if (is_first_error) { \
55 fprintf(stderr, "Error: "); \
56 is_first_error = false; \
58 fprintf(stderr, fmt, ##args); \
61 static bool is_first_error
= true;
63 /* INI-style parsing FSM states */
64 enum ini_parsing_fsm_state
{
65 /* Expect a map key (identifier) */
68 /* Expect an equal character ('=') */
74 /* Expect a negative number value */
75 INI_EXPECT_VALUE_NUMBER_NEG
,
77 /* Expect a comma character (',') */
81 /* INI-style parsing state variables */
82 struct ini_parsing_state
{
83 /* Lexical scanner (owned by this) */
86 /* Output map value object being filled (owned by this) */
87 struct bt_value
*params
;
89 /* Next expected FSM state */
90 enum ini_parsing_fsm_state expecting
;
92 /* Last decoded map key (owned by this) */
95 /* Complete INI-style string to parse (not owned by this) */
98 /* Error buffer (not owned by this) */
102 /* Offset option with "is set" boolean */
108 /* Legacy "ctf"/"lttng-live" format options */
109 struct ctf_legacy_opts
{
110 struct offset_opt offset_s
;
111 struct offset_opt offset_ns
;
112 bool stream_intersection
;
115 /* Legacy "text" format options */
116 struct text_legacy_opts
{
118 * output, dbg_info_dir, dbg_info_target_prefix, names,
119 * and fields are owned by this.
122 GString
*dbg_info_dir
;
123 GString
*dbg_info_target_prefix
;
124 struct bt_value
*names
;
125 struct bt_value
*fields
;
133 bool dbg_info_full_path
;
136 /* Legacy input format format */
137 enum legacy_input_format
{
138 LEGACY_INPUT_FORMAT_NONE
= 0,
139 LEGACY_INPUT_FORMAT_CTF
,
140 LEGACY_INPUT_FORMAT_LTTNG_LIVE
,
143 /* Legacy output format format */
144 enum legacy_output_format
{
145 LEGACY_OUTPUT_FORMAT_NONE
= 0,
146 LEGACY_OUTPUT_FORMAT_TEXT
,
147 LEGACY_OUTPUT_FORMAT_CTF_METADATA
,
148 LEGACY_OUTPUT_FORMAT_DUMMY
,
152 * Prints the "out of memory" error.
155 void print_err_oom(void)
157 printf_err("Out of memory\n");
161 * Prints duplicate legacy output format error.
164 void print_err_dup_legacy_output(void)
166 printf_err("More than one legacy output format specified\n");
170 * Prints duplicate legacy input format error.
173 void print_err_dup_legacy_input(void)
175 printf_err("More than one legacy input format specified\n");
179 * Checks if any of the "text" legacy options is set.
182 bool text_legacy_opts_is_any_set(struct text_legacy_opts
*opts
)
184 return (opts
->output
&& opts
->output
->len
> 0) ||
185 (opts
->dbg_info_dir
&& opts
->dbg_info_dir
->len
> 0) ||
186 (opts
->dbg_info_target_prefix
&&
187 opts
->dbg_info_target_prefix
->len
> 0) ||
188 bt_value_array_size(opts
->names
) > 0 ||
189 bt_value_array_size(opts
->fields
) > 0 ||
190 opts
->no_delta
|| opts
->clock_cycles
|| opts
->clock_seconds
||
191 opts
->clock_date
|| opts
->clock_gmt
||
192 opts
->dbg_info_full_path
;
196 * Checks if any of the "ctf" legacy options is set.
199 bool ctf_legacy_opts_is_any_set(struct ctf_legacy_opts
*opts
)
201 return opts
->offset_s
.is_set
|| opts
->offset_ns
.is_set
||
202 opts
->stream_intersection
;
206 * Appends an "expecting token" error to the INI-style parsing state's
210 void ini_append_error_expecting(struct ini_parsing_state
*state
,
211 GScanner
*scanner
, const char *expecting
)
216 g_string_append_printf(state
->ini_error
, "Expecting %s:\n", expecting
);
218 /* Only print error if there's one line */
219 if (strchr(state
->arg
, '\n') != NULL
|| strlen(state
->arg
) == 0) {
223 g_string_append_printf(state
->ini_error
, "\n %s\n", state
->arg
);
224 pos
= g_scanner_cur_position(scanner
) + 4;
226 if (!g_scanner_eof(scanner
)) {
230 for (i
= 0; i
< pos
; ++i
) {
231 g_string_append_printf(state
->ini_error
, " ");
234 g_string_append_printf(state
->ini_error
, "^\n\n");
238 int ini_handle_state(struct ini_parsing_state
*state
)
241 GTokenType token_type
;
242 struct bt_value
*value
= NULL
;
244 token_type
= g_scanner_get_next_token(state
->scanner
);
245 if (token_type
== G_TOKEN_EOF
) {
246 if (state
->expecting
!= INI_EXPECT_COMMA
) {
247 switch (state
->expecting
) {
248 case INI_EXPECT_EQUAL
:
249 ini_append_error_expecting(state
,
250 state
->scanner
, "'='");
252 case INI_EXPECT_VALUE
:
253 case INI_EXPECT_VALUE_NUMBER_NEG
:
254 ini_append_error_expecting(state
,
255 state
->scanner
, "value");
257 case INI_EXPECT_MAP_KEY
:
258 ini_append_error_expecting(state
,
259 state
->scanner
, "unquoted map key");
272 switch (state
->expecting
) {
273 case INI_EXPECT_MAP_KEY
:
274 if (token_type
!= G_TOKEN_IDENTIFIER
) {
275 ini_append_error_expecting(state
, state
->scanner
,
280 free(state
->last_map_key
);
281 state
->last_map_key
=
282 strdup(state
->scanner
->value
.v_identifier
);
283 if (!state
->last_map_key
) {
284 g_string_append(state
->ini_error
,
289 if (bt_value_map_has_key(state
->params
, state
->last_map_key
)) {
290 g_string_append_printf(state
->ini_error
,
291 "Duplicate parameter key: `%s`\n",
292 state
->last_map_key
);
296 state
->expecting
= INI_EXPECT_EQUAL
;
298 case INI_EXPECT_EQUAL
:
299 if (token_type
!= G_TOKEN_CHAR
) {
300 ini_append_error_expecting(state
,
301 state
->scanner
, "'='");
305 if (state
->scanner
->value
.v_char
!= '=') {
306 ini_append_error_expecting(state
,
307 state
->scanner
, "'='");
311 state
->expecting
= INI_EXPECT_VALUE
;
313 case INI_EXPECT_VALUE
:
315 switch (token_type
) {
317 if (state
->scanner
->value
.v_char
== '-') {
318 /* Negative number */
320 INI_EXPECT_VALUE_NUMBER_NEG
;
323 ini_append_error_expecting(state
,
324 state
->scanner
, "value");
330 /* Positive integer */
331 uint64_t int_val
= state
->scanner
->value
.v_int64
;
333 if (int_val
> (1ULL << 63) - 1) {
334 g_string_append_printf(state
->ini_error
,
335 "Integer value %" PRIu64
" is outside the range of a 64-bit signed integer\n",
340 value
= bt_value_integer_create_init(
345 /* Positive floating point number */
346 value
= bt_value_float_create_init(
347 state
->scanner
->value
.v_float
);
351 value
= bt_value_string_create_init(
352 state
->scanner
->value
.v_string
);
354 case G_TOKEN_IDENTIFIER
:
357 * Using symbols would be appropriate here,
358 * but said symbols are allowed as map key,
359 * so it's easier to consider everything an
362 * If one of the known symbols is not
363 * recognized here, then fall back to creating
366 const char *id
= state
->scanner
->value
.v_identifier
;
368 if (!strcmp(id
, "null") || !strcmp(id
, "NULL") ||
369 !strcmp(id
, "nul")) {
370 value
= bt_value_null
;
371 } else if (!strcmp(id
, "true") || !strcmp(id
, "TRUE") ||
372 !strcmp(id
, "yes") ||
373 !strcmp(id
, "YES")) {
374 value
= bt_value_bool_create_init(true);
375 } else if (!strcmp(id
, "false") ||
376 !strcmp(id
, "FALSE") ||
379 value
= bt_value_bool_create_init(false);
381 value
= bt_value_string_create_init(id
);
386 /* Unset value variable will trigger the error */
391 ini_append_error_expecting(state
,
392 state
->scanner
, "value");
396 state
->expecting
= INI_EXPECT_COMMA
;
399 case INI_EXPECT_VALUE_NUMBER_NEG
:
401 switch (token_type
) {
404 /* Negative integer */
405 uint64_t int_val
= state
->scanner
->value
.v_int64
;
407 if (int_val
> (1ULL << 63) - 1) {
408 g_string_append_printf(state
->ini_error
,
409 "Integer value -%" PRIu64
" is outside the range of a 64-bit signed integer\n",
414 value
= bt_value_integer_create_init(
415 -((int64_t) int_val
));
419 /* Negative floating point number */
420 value
= bt_value_float_create_init(
421 -state
->scanner
->value
.v_float
);
424 /* Unset value variable will trigger the error */
429 ini_append_error_expecting(state
,
430 state
->scanner
, "value");
434 state
->expecting
= INI_EXPECT_COMMA
;
437 case INI_EXPECT_COMMA
:
438 if (token_type
!= G_TOKEN_CHAR
) {
439 ini_append_error_expecting(state
,
440 state
->scanner
, "','");
444 if (state
->scanner
->value
.v_char
!= ',') {
445 ini_append_error_expecting(state
,
446 state
->scanner
, "','");
450 state
->expecting
= INI_EXPECT_MAP_KEY
;
462 if (bt_value_map_insert(state
->params
,
463 state
->last_map_key
, value
)) {
464 /* Only override return value on error */
475 * Converts an INI-style argument to an equivalent map value object.
477 * Return value is owned by the caller.
480 struct bt_value
*bt_value_from_ini(const char *arg
, GString
*ini_error
)
482 /* Lexical scanner configuration */
483 GScannerConfig scanner_config
= {
484 /* Skip whitespaces */
485 .cset_skip_characters
= " \t\n",
487 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
488 .cset_identifier_first
=
492 .cset_identifier_nth
=
497 /* "hello" and "Hello" two different keys */
498 .case_sensitive
= TRUE
,
501 .cpair_comment_single
= NULL
,
502 .skip_comment_multi
= TRUE
,
503 .skip_comment_single
= TRUE
,
504 .scan_comment_multi
= FALSE
,
507 * Do scan identifiers, including 1-char identifiers,
508 * but NULL is a normal identifier.
510 .scan_identifier
= TRUE
,
511 .scan_identifier_1char
= TRUE
,
512 .scan_identifier_NULL
= FALSE
,
515 * No specific symbols: null and boolean "symbols" are
516 * scanned as plain identifiers.
518 .scan_symbols
= FALSE
,
519 .symbol_2_token
= FALSE
,
520 .scope_0_fallback
= FALSE
,
523 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
524 * integers prefixed with "$".
530 .scan_hex_dollar
= FALSE
,
532 /* Convert scanned numbers to integer tokens */
533 .numbers_2_int
= TRUE
,
535 /* Support both integers and floating-point numbers */
536 .int_2_float
= FALSE
,
538 /* Scan integers as 64-bit signed integers */
541 /* Only scan double-quoted strings */
542 .scan_string_sq
= FALSE
,
543 .scan_string_dq
= TRUE
,
545 /* Do not converter identifiers to string tokens */
546 .identifier_2_string
= FALSE
,
548 /* Scan characters as G_TOKEN_CHAR token */
549 .char_2_token
= FALSE
,
551 struct ini_parsing_state state
= {
554 .expecting
= INI_EXPECT_MAP_KEY
,
556 .ini_error
= ini_error
,
559 state
.params
= bt_value_map_create();
564 state
.scanner
= g_scanner_new(&scanner_config
);
565 if (!state
.scanner
) {
569 /* Let the scan begin */
570 g_scanner_input_text(state
.scanner
, arg
, strlen(arg
));
573 int ret
= ini_handle_state(&state
);
578 } else if (ret
> 0) {
587 BT_PUT(state
.params
);
591 g_scanner_destroy(state
.scanner
);
594 free(state
.last_map_key
);
599 * Returns the parameters map value object from a command-line
600 * parameter option's argument.
602 * Return value is owned by the caller.
605 struct bt_value
*bt_value_from_arg(const char *arg
)
607 struct bt_value
*params
= NULL
;
608 GString
*ini_error
= NULL
;
610 ini_error
= g_string_new(NULL
);
616 /* Try INI-style parsing */
617 params
= bt_value_from_ini(arg
, ini_error
);
619 printf_err("%s", ini_error
->str
);
625 g_string_free(ini_error
, TRUE
);
631 * Returns the plugin and component names from a command-line
632 * source/sink option's argument. arg must have the following format:
636 * where PLUGIN is the plugin name, and COMPONENT is the component
639 * On success, both *plugin and *component are not NULL. *plugin
640 * and *component are owned by the caller.
643 void plugin_component_names_from_arg(const char *arg
, char **plugin
,
649 size_t component_len
;
651 /* Initialize both return values to NULL: not found */
655 dot
= strchr(arg
, '.');
661 end
= arg
+ strlen(arg
);
662 plugin_len
= dot
- arg
;
663 component_len
= end
- dot
- 1;
664 if (plugin_len
== 0 || component_len
== 0) {
668 *plugin
= g_malloc0(plugin_len
+ 1);
674 g_strlcpy(*plugin
, arg
, plugin_len
+ 1);
675 *component
= g_malloc0(component_len
+ 1);
681 g_strlcpy(*component
, dot
+ 1, component_len
+ 1);
688 * Prints the Babeltrace version.
691 void print_version(void)
693 puts("Babeltrace " VERSION
);
697 * Prints the legacy, Babeltrace 1.x command usage. Those options are
698 * still compatible in Babeltrace 2.x, but it is recommended to use
699 * the more generic plugin/component parameters instead of those
700 * hard-coded option names.
703 void print_legacy_usage(FILE *fp
)
705 fprintf(fp
, "Usage: babeltrace [OPTIONS] INPUT...\n");
707 fprintf(fp
, "The following options are compatible with the Babeltrace 1.x options:\n");
709 fprintf(fp
, " --help-legacy Show this help\n");
710 fprintf(fp
, " -V, --version Show version\n");
711 fprintf(fp
, " --clock-force-correlate Assume that clocks are inherently correlated\n");
712 fprintf(fp
, " across traces\n");
713 fprintf(fp
, " -d, --debug Enable debug mode\n");
714 fprintf(fp
, " -i, --input-format=FORMAT Input trace format (default: ctf)\n");
715 fprintf(fp
, " -l, --list List available formats\n");
716 fprintf(fp
, " -o, --output-format=FORMAT Output trace format (default: text)\n");
717 fprintf(fp
, " -v, --verbose Enable verbose output\n");
719 fprintf(fp
, " Available input formats: ctf, lttng-live, ctf-metadata\n");
720 fprintf(fp
, " Available output formats: text, dummy\n");
722 fprintf(fp
, "Input formats specific options:\n");
724 fprintf(fp
, " INPUT... Input trace file(s), directory(ies), or URLs\n");
725 fprintf(fp
, " --clock-offset=SEC Set clock offset to SEC seconds\n");
726 fprintf(fp
, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n");
727 fprintf(fp
, " --stream-intersection Only process events when all streams are active\n");
729 fprintf(fp
, "text output format specific options:\n");
731 fprintf(fp
, " --clock-cycles Print timestamps in clock cycles\n");
732 fprintf(fp
, " --clock-date Print timestamp dates\n");
733 fprintf(fp
, " --clock-gmt Print and parse timestamps in GMT time zone\n");
734 fprintf(fp
, " (default: local time zone)\n");
735 fprintf(fp
, " --clock-seconds Print the timestamps as [SEC.NS]\n");
736 fprintf(fp
, " (default format: [HH:MM:SS.NS])\n");
737 fprintf(fp
, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
738 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
739 fprintf(fp
, " --debug-info-full-path Show full debug info source and binary paths\n");
740 fprintf(fp
, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n");
741 fprintf(fp
, " up executables during debug info analysis\n");
742 fprintf(fp
, " (default: `/usr/lib/debug`)\n");
743 fprintf(fp
, " -f, --fields=NAME[,NAME]... Print additional fields:\n");
744 fprintf(fp
, " all, trace, trace:hostname, trace:domain,\n");
745 fprintf(fp
, " trace:procname, trace:vpid, loglevel, emf\n");
746 fprintf(fp
, " (default: trace:hostname, trace:procname,\n");
747 fprintf(fp
, " trace:vpid)\n");
748 fprintf(fp
, " -n, --names=NAME[,NAME]... Print field names:\n");
749 fprintf(fp
, " payload (or arg or args)\n");
750 fprintf(fp
, " none, all, scope, header, context (or ctx)\n");
751 fprintf(fp
, " (default: payload, context)\n");
752 fprintf(fp
, " --no-delta Do not print time delta between consecutive\n");
753 fprintf(fp
, " events\n");
754 fprintf(fp
, " -w, --output=PATH Write output to PATH (default: standard output)\n");
758 * Prints the Babeltrace 2.x usage.
761 void print_usage(FILE *fp
)
763 fprintf(fp
, "Usage: babeltrace [OPTIONS]\n");
765 fprintf(fp
, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
766 fprintf(fp
, " of the following source and sink component\n");
767 fprintf(fp
, " instances (see the exact format of PARAMS\n");
768 fprintf(fp
, " below)\n");
769 fprintf(fp
, " -d, --debug Enable debug mode\n");
770 fprintf(fp
, " -l, --list List available plugins and their components\n");
771 fprintf(fp
, " -P, --path=PATH Set the `path` parameter of the latest source\n");
772 fprintf(fp
, " or sink component to PATH\n");
773 fprintf(fp
, " -p, --params=PARAMS Set the parameters of the latest source or\n");
774 fprintf(fp
, " sink component instance (in command-line \n");
775 fprintf(fp
, " order) to PARAMS (see the exact format of\n");
776 fprintf(fp
, " PARAMS below)\n");
777 fprintf(fp
, " --plugin-path=PATH[:PATH]... Set paths from which dynamic plugins can be\n");
778 fprintf(fp
, " loaded to PATH\n");
779 fprintf(fp
, " -r, --reset-base-params Reset the current base parameters of the\n");
780 fprintf(fp
, " following source and sink component\n");
781 fprintf(fp
, " instances to an empty map\n");
782 fprintf(fp
, " -o, --sink=PLUGIN.COMPCLS Instantiate a sink component from plugin\n");
783 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
784 fprintf(fp
, " repeated)\n");
785 fprintf(fp
, " -i, --source=PLUGIN.COMPCLS Instantiate a source component from plugin\n");
786 fprintf(fp
, " PLUGIN and component class COMPCLS (may be\n");
787 fprintf(fp
, " repeated)\n");
788 fprintf(fp
, " --begin Start time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
789 fprintf(fp
, " --end End time: [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
790 fprintf(fp
, " --timerange Time range: begin,end or [begin,end] (where [] are actual brackets)\n");
791 fprintf(fp
, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
792 fprintf(fp
, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
793 fprintf(fp
, " -h --help Show this help\n");
794 fprintf(fp
, " --help-legacy Show Babeltrace 1.x legacy options\n");
795 fprintf(fp
, " -v, --verbose Enable verbose output\n");
796 fprintf(fp
, " -V, --version Show version\n");
798 fprintf(fp
, "Format of PARAMS\n");
799 fprintf(fp
, "----------------\n");
801 fprintf(fp
, " PARAM=VALUE[,PARAM=VALUE]...\n");
803 fprintf(fp
, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
804 fprintf(fp
, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
805 fprintf(fp
, "VALUE can be one of:\n");
807 fprintf(fp
, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
808 fprintf(fp
, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
809 fprintf(fp
, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
810 fprintf(fp
, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
811 fprintf(fp
, " (`0x` prefix) signed 64-bit integer.\n");
812 fprintf(fp
, "* Double precision floating point number (scientific notation is accepted).\n");
813 fprintf(fp
, "* Unquoted string with no special characters, and not matching any of\n");
814 fprintf(fp
, " the null and boolean value symbols above.\n");
815 fprintf(fp
, "* Double-quoted string (accepts escape characters).\n");
817 fprintf(fp
, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
819 fprintf(fp
, "Example:\n");
821 fprintf(fp
, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
822 fprintf(fp
, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
823 fprintf(fp
, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
825 fprintf(fp
, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
826 fprintf(fp
, "from a shell.\n");
830 * Destroys a component configuration.
833 void bt_config_component_destroy(struct bt_object
*obj
)
835 struct bt_config_component
*bt_config_component
=
836 container_of(obj
, struct bt_config_component
, base
);
842 if (bt_config_component
->plugin_name
) {
843 g_string_free(bt_config_component
->plugin_name
, TRUE
);
846 if (bt_config_component
->component_name
) {
847 g_string_free(bt_config_component
->component_name
, TRUE
);
850 BT_PUT(bt_config_component
->params
);
851 g_free(bt_config_component
);
858 * Creates a component configuration using the given plugin name and
859 * component name. plugin_name and component_name are copied (belong to
862 * Return value is owned by the caller.
865 struct bt_config_component
*bt_config_component_create(const char *plugin_name
,
866 const char *component_name
)
868 struct bt_config_component
*cfg_component
= NULL
;
870 cfg_component
= g_new0(struct bt_config_component
, 1);
871 if (!cfg_component
) {
876 bt_object_init(cfg_component
, bt_config_component_destroy
);
877 cfg_component
->plugin_name
= g_string_new(plugin_name
);
878 if (!cfg_component
->plugin_name
) {
883 cfg_component
->component_name
= g_string_new(component_name
);
884 if (!cfg_component
->component_name
) {
889 /* Start with empty parameters */
890 cfg_component
->params
= bt_value_map_create();
891 if (!cfg_component
->params
) {
899 BT_PUT(cfg_component
);
902 return cfg_component
;
906 * Creates a component configuration from a command-line source/sink
910 struct bt_config_component
*bt_config_component_from_arg(const char *arg
)
912 struct bt_config_component
*bt_config_component
= NULL
;
914 char *component_name
;
916 plugin_component_names_from_arg(arg
, &plugin_name
, &component_name
);
917 if (!plugin_name
|| !component_name
) {
918 printf_err("Cannot get plugin or component class name\n");
922 bt_config_component
= bt_config_component_create(plugin_name
,
924 if (!bt_config_component
) {
931 BT_PUT(bt_config_component
);
935 g_free(component_name
);
936 return bt_config_component
;
940 * Destroys a configuration.
943 void bt_config_destroy(struct bt_object
*obj
)
945 struct bt_config
*bt_config
=
946 container_of(obj
, struct bt_config
, base
);
952 if (bt_config
->sources
) {
953 g_ptr_array_free(bt_config
->sources
, TRUE
);
956 if (bt_config
->sinks
) {
957 g_ptr_array_free(bt_config
->sinks
, TRUE
);
960 BT_PUT(bt_config
->plugin_paths
);
968 bool is_setuid_setgid(void)
970 return (geteuid() != getuid() || getegid() != getgid());
974 * Extracts the various paths from the string arg, delimited by ':',
975 * and converts them to an array value object.
977 * Returned array value object is empty if arg is empty.
979 * Return value is owned by the caller.
982 enum bt_value_status
plugin_paths_from_arg(struct bt_value
*plugin_paths
,
985 const char *at
= arg
;
986 const char *end
= arg
+ strlen(arg
);
991 const char *next_colon
;
993 next_colon
= strchr(at
, ':');
994 if (next_colon
== at
) {
996 * Empty path: try next character (supported
997 * to conform to the typical parsing of $PATH).
1001 } else if (!next_colon
) {
1002 /* No more colon: use the remaining */
1003 next_colon
= arg
+ strlen(arg
);
1006 path
= g_string_new(NULL
);
1012 g_string_append_len(path
, at
, next_colon
- at
);
1013 at
= next_colon
+ 1;
1014 ret
= bt_value_array_append_string(plugin_paths
, path
->str
);
1015 g_string_free(path
, TRUE
);
1022 return BT_VALUE_STATUS_OK
;
1024 return BT_VALUE_STATUS_ERROR
;
1028 * Creates a simple lexical scanner for parsing comma-delimited names
1031 * Return value is owned by the caller.
1034 GScanner
*create_csv_identifiers_scanner(void)
1036 GScannerConfig scanner_config
= {
1037 .cset_skip_characters
= " \t\n",
1038 .cset_identifier_first
= G_CSET_a_2_z G_CSET_A_2_Z
"_",
1039 .cset_identifier_nth
= G_CSET_a_2_z G_CSET_A_2_Z
":_-",
1040 .case_sensitive
= TRUE
,
1041 .cpair_comment_single
= NULL
,
1042 .skip_comment_multi
= TRUE
,
1043 .skip_comment_single
= TRUE
,
1044 .scan_comment_multi
= FALSE
,
1045 .scan_identifier
= TRUE
,
1046 .scan_identifier_1char
= TRUE
,
1047 .scan_identifier_NULL
= FALSE
,
1048 .scan_symbols
= FALSE
,
1049 .symbol_2_token
= FALSE
,
1050 .scope_0_fallback
= FALSE
,
1051 .scan_binary
= FALSE
,
1052 .scan_octal
= FALSE
,
1053 .scan_float
= FALSE
,
1055 .scan_hex_dollar
= FALSE
,
1056 .numbers_2_int
= FALSE
,
1057 .int_2_float
= FALSE
,
1058 .store_int64
= FALSE
,
1059 .scan_string_sq
= FALSE
,
1060 .scan_string_dq
= FALSE
,
1061 .identifier_2_string
= FALSE
,
1062 .char_2_token
= TRUE
,
1065 return g_scanner_new(&scanner_config
);
1069 * Inserts a string (if exists and not empty) or null to a map value
1073 enum bt_value_status
map_insert_string_or_null(struct bt_value
*map
,
1074 const char *key
, GString
*string
)
1076 enum bt_value_status ret
;
1078 if (string
&& string
->len
> 0) {
1079 ret
= bt_value_map_insert_string(map
, key
, string
->str
);
1081 ret
= bt_value_map_insert(map
, key
, bt_value_null
);
1087 * Converts a comma-delimited list of known names (--names option) to
1088 * an array value object containing those names as string value objects.
1090 * Return value is owned by the caller.
1093 struct bt_value
*names_from_arg(const char *arg
)
1095 GScanner
*scanner
= NULL
;
1096 struct bt_value
*names
= NULL
;
1097 bool found_all
= false, found_none
= false, found_item
= false;
1099 names
= bt_value_array_create();
1105 scanner
= create_csv_identifiers_scanner();
1111 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1114 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1116 switch (token_type
) {
1117 case G_TOKEN_IDENTIFIER
:
1119 const char *identifier
= scanner
->value
.v_identifier
;
1121 if (!strcmp(identifier
, "payload") ||
1122 !strcmp(identifier
, "args") ||
1123 !strcmp(identifier
, "arg")) {
1125 if (bt_value_array_append_string(names
,
1129 } else if (!strcmp(identifier
, "context") ||
1130 !strcmp(identifier
, "ctx")) {
1132 if (bt_value_array_append_string(names
,
1136 } else if (!strcmp(identifier
, "scope") ||
1137 !strcmp(identifier
, "header")) {
1139 if (bt_value_array_append_string(names
,
1143 } else if (!strcmp(identifier
, "all")) {
1145 if (bt_value_array_append_string(names
,
1149 } else if (!strcmp(identifier
, "none")) {
1151 if (bt_value_array_append_string(names
,
1156 printf_err("Unknown field name: `%s`\n",
1172 if (found_none
&& found_all
) {
1173 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1177 * Legacy behavior is to clear the defaults (show none) when at
1178 * least one item is specified.
1180 if (found_item
&& !found_none
&& !found_all
) {
1181 if (bt_value_array_append_string(names
, "none")) {
1186 g_scanner_destroy(scanner
);
1193 g_scanner_destroy(scanner
);
1200 * Converts a comma-delimited list of known fields (--fields option) to
1201 * an array value object containing those fields as string
1204 * Return value is owned by the caller.
1207 struct bt_value
*fields_from_arg(const char *arg
)
1209 GScanner
*scanner
= NULL
;
1210 struct bt_value
*fields
;
1212 fields
= bt_value_array_create();
1218 scanner
= create_csv_identifiers_scanner();
1224 g_scanner_input_text(scanner
, arg
, strlen(arg
));
1227 GTokenType token_type
= g_scanner_get_next_token(scanner
);
1229 switch (token_type
) {
1230 case G_TOKEN_IDENTIFIER
:
1232 const char *identifier
= scanner
->value
.v_identifier
;
1234 if (!strcmp(identifier
, "trace") ||
1235 !strcmp(identifier
, "trace:hostname") ||
1236 !strcmp(identifier
, "trace:domain") ||
1237 !strcmp(identifier
, "trace:procname") ||
1238 !strcmp(identifier
, "trace:vpid") ||
1239 !strcmp(identifier
, "loglevel") ||
1240 !strcmp(identifier
, "emf") ||
1241 !strcmp(identifier
, "callsite") ||
1242 !strcmp(identifier
, "all")) {
1243 if (bt_value_array_append_string(fields
,
1248 printf_err("Unknown field name: `%s`\n",
1270 g_scanner_destroy(scanner
);
1276 * Inserts the equivalent "prefix-name" true boolean value objects into
1277 * map_obj where the names are in array_obj.
1280 int insert_flat_names_fields_from_array(struct bt_value
*map_obj
,
1281 struct bt_value
*array_obj
, const char *prefix
)
1285 GString
*tmpstr
= NULL
, *default_value
= NULL
;
1288 * array_obj may be NULL if no CLI options were specified to
1289 * trigger its creation.
1295 tmpstr
= g_string_new(NULL
);
1302 default_value
= g_string_new(NULL
);
1303 if (!default_value
) {
1309 for (i
= 0; i
< bt_value_array_size(array_obj
); i
++) {
1310 struct bt_value
*str_obj
= bt_value_array_get(array_obj
, i
);
1312 bool is_default
= false;
1315 printf_err("Unexpected error\n");
1320 ret
= bt_value_string_get(str_obj
, &suffix
);
1323 printf_err("Unexpected error\n");
1327 g_string_assign(tmpstr
, prefix
);
1328 g_string_append(tmpstr
, "-");
1330 /* Special-case for "all" and "none". */
1331 if (!strcmp(suffix
, "all")) {
1333 g_string_assign(default_value
, "show");
1334 } else if (!strcmp(suffix
, "none")) {
1336 g_string_assign(default_value
, "hide");
1339 g_string_append(tmpstr
, "default");
1340 ret
= map_insert_string_or_null(map_obj
,
1348 g_string_append(tmpstr
, suffix
);
1349 ret
= bt_value_map_insert_bool(map_obj
, tmpstr
->str
,
1359 if (default_value
) {
1360 g_string_free(default_value
, TRUE
);
1363 g_string_free(tmpstr
, TRUE
);
1370 * Returns the parameters (map value object) corresponding to the
1371 * legacy text format options.
1373 * Return value is owned by the caller.
1376 struct bt_value
*params_from_text_legacy_opts(
1377 struct text_legacy_opts
*text_legacy_opts
)
1379 struct bt_value
*params
;
1381 params
= bt_value_map_create();
1387 if (map_insert_string_or_null(params
, "output-path",
1388 text_legacy_opts
->output
)) {
1393 if (map_insert_string_or_null(params
, "debug-info-dir",
1394 text_legacy_opts
->dbg_info_dir
)) {
1399 if (map_insert_string_or_null(params
, "debug-info-target-prefix",
1400 text_legacy_opts
->dbg_info_target_prefix
)) {
1405 if (bt_value_map_insert_bool(params
, "debug-info-full-path",
1406 text_legacy_opts
->dbg_info_full_path
)) {
1411 if (bt_value_map_insert_bool(params
, "no-delta",
1412 text_legacy_opts
->no_delta
)) {
1417 if (bt_value_map_insert_bool(params
, "clock-cycles",
1418 text_legacy_opts
->clock_cycles
)) {
1423 if (bt_value_map_insert_bool(params
, "clock-seconds",
1424 text_legacy_opts
->clock_seconds
)) {
1429 if (bt_value_map_insert_bool(params
, "clock-date",
1430 text_legacy_opts
->clock_date
)) {
1435 if (bt_value_map_insert_bool(params
, "clock-gmt",
1436 text_legacy_opts
->clock_gmt
)) {
1441 if (insert_flat_names_fields_from_array(params
,
1442 text_legacy_opts
->names
, "name")) {
1446 if (insert_flat_names_fields_from_array(params
,
1447 text_legacy_opts
->fields
, "field")) {
1461 int append_sinks_from_legacy_opts(GPtrArray
*sinks
,
1462 enum legacy_output_format legacy_output_format
,
1463 struct text_legacy_opts
*text_legacy_opts
)
1466 struct bt_value
*params
= NULL
;
1467 const char *plugin_name
;
1468 const char *component_name
;
1469 struct bt_config_component
*bt_config_component
= NULL
;
1471 switch (legacy_output_format
) {
1472 case LEGACY_OUTPUT_FORMAT_TEXT
:
1473 plugin_name
= "text";
1474 component_name
= "text";
1476 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1477 plugin_name
= "ctf";
1478 component_name
= "metadata-text";
1480 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1481 plugin_name
= "dummy";
1482 component_name
= "dummy";
1489 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
) {
1490 /* Legacy "text" output format has parameters */
1491 params
= params_from_text_legacy_opts(text_legacy_opts
);
1497 * Legacy "dummy" and "ctf-metadata" output formats do
1498 * not have parameters.
1500 params
= bt_value_map_create();
1507 /* Create a component configuration */
1508 bt_config_component
= bt_config_component_create(plugin_name
,
1510 if (!bt_config_component
) {
1514 BT_MOVE(bt_config_component
->params
, params
);
1516 /* Move created component configuration to the array */
1517 g_ptr_array_add(sinks
, bt_config_component
);
1531 * Returns the parameters (map value object) corresponding to the
1532 * given legacy CTF format options.
1534 * Return value is owned by the caller.
1537 struct bt_value
*params_from_ctf_legacy_opts(
1538 struct ctf_legacy_opts
*ctf_legacy_opts
)
1540 struct bt_value
*params
;
1542 params
= bt_value_map_create();
1548 if (bt_value_map_insert_integer(params
, "offset-s",
1549 ctf_legacy_opts
->offset_s
.value
)) {
1554 if (bt_value_map_insert_integer(params
, "offset-ns",
1555 ctf_legacy_opts
->offset_ns
.value
)) {
1560 if (bt_value_map_insert_bool(params
, "stream-intersection",
1561 ctf_legacy_opts
->stream_intersection
)) {
1576 int append_sources_from_legacy_opts(GPtrArray
*sources
,
1577 enum legacy_input_format legacy_input_format
,
1578 struct ctf_legacy_opts
*ctf_legacy_opts
,
1579 struct bt_value
*legacy_input_paths
)
1583 struct bt_value
*base_params
;
1584 struct bt_value
*params
= NULL
;
1585 struct bt_value
*input_path
= NULL
;
1586 struct bt_value
*input_path_copy
= NULL
;
1587 const char *input_key
;
1588 const char *component_name
;
1590 switch (legacy_input_format
) {
1591 case LEGACY_INPUT_FORMAT_CTF
:
1593 component_name
= "fs";
1595 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1597 component_name
= "lttng-live";
1604 base_params
= params_from_ctf_legacy_opts(ctf_legacy_opts
);
1609 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1610 struct bt_config_component
*bt_config_component
= NULL
;
1612 /* Copy base parameters as current parameters */
1613 params
= bt_value_copy(base_params
);
1618 /* Get current input path string value object */
1619 input_path
= bt_value_array_get(legacy_input_paths
, i
);
1624 /* Copy current input path value object */
1625 input_path_copy
= bt_value_copy(input_path
);
1626 if (!input_path_copy
) {
1630 /* Insert input path value object into current parameters */
1631 ret
= bt_value_map_insert(params
, input_key
, input_path_copy
);
1636 /* Create a component configuration */
1637 bt_config_component
= bt_config_component_create("ctf",
1639 if (!bt_config_component
) {
1643 BT_MOVE(bt_config_component
->params
, params
);
1645 /* Move created component configuration to the array */
1646 g_ptr_array_add(sources
, bt_config_component
);
1648 /* Put current stuff */
1650 BT_PUT(input_path_copy
);
1659 BT_PUT(base_params
);
1662 BT_PUT(input_path_copy
);
1667 * Escapes a string for the shell. The string is escaped knowing that
1668 * it's a parameter string value (double-quoted), and that it will be
1669 * entered between single quotes in the shell.
1671 * Return value is owned by the caller.
1674 char *str_shell_escape(const char *input
)
1677 const char *at
= input
;
1678 GString
*str
= g_string_new(NULL
);
1684 while (*at
!= '\0') {
1687 g_string_append(str
, "\\\\");
1690 g_string_append(str
, "\\\"");
1693 g_string_append(str
, "'\"'\"'");
1696 g_string_append(str
, "\\n");
1699 g_string_append(str
, "\\t");
1702 g_string_append_c(str
, *at
);
1712 g_string_free(str
, FALSE
);
1719 int append_prefixed_flag_params(GString
*str
, struct bt_value
*flags
,
1729 for (i
= 0; i
< bt_value_array_size(flags
); i
++) {
1730 struct bt_value
*value
= bt_value_array_get(flags
, i
);
1738 if (bt_value_string_get(value
, &flag
)) {
1744 g_string_append_printf(str
, ",%s-%s=true", prefix
, flag
);
1753 * Appends a boolean parameter string.
1756 void g_string_append_bool_param(GString
*str
, const char *name
, bool value
)
1758 g_string_append_printf(str
, ",%s=%s", name
, value
? "true" : "false");
1762 * Appends a path parameter string, or null if it's empty.
1765 int g_string_append_string_path_param(GString
*str
, const char *name
,
1770 if (path
->len
> 0) {
1771 char *escaped_path
= str_shell_escape(path
->str
);
1773 if (!escaped_path
) {
1778 g_string_append_printf(str
, "%s=\"%s\"", name
, escaped_path
);
1781 g_string_append_printf(str
, "%s=null", name
);
1794 * Prints the non-legacy sink options equivalent to the specified
1795 * legacy output format options.
1798 void print_output_legacy_to_sinks(
1799 enum legacy_output_format legacy_output_format
,
1800 struct text_legacy_opts
*text_legacy_opts
)
1802 const char *input_format
;
1803 GString
*str
= NULL
;
1805 str
= g_string_new(" ");
1811 switch (legacy_output_format
) {
1812 case LEGACY_OUTPUT_FORMAT_TEXT
:
1813 input_format
= "text";
1815 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1816 input_format
= "ctf-metadata";
1818 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1819 input_format
= "dummy";
1825 printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
1827 printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
1829 g_string_append(str
, "-o ");
1831 switch (legacy_output_format
) {
1832 case LEGACY_OUTPUT_FORMAT_TEXT
:
1833 g_string_append(str
, "text.text");
1835 case LEGACY_OUTPUT_FORMAT_CTF_METADATA
:
1836 g_string_append(str
, "ctf.metadata-text");
1838 case LEGACY_OUTPUT_FORMAT_DUMMY
:
1839 g_string_append(str
, "dummy.dummy");
1845 if (legacy_output_format
== LEGACY_OUTPUT_FORMAT_TEXT
&&
1846 text_legacy_opts_is_any_set(text_legacy_opts
)) {
1849 g_string_append(str
, " -p '");
1851 if (g_string_append_string_path_param(str
, "output-path",
1852 text_legacy_opts
->output
)) {
1856 g_string_append(str
, ",");
1858 if (g_string_append_string_path_param(str
, "debug-info-dir",
1859 text_legacy_opts
->dbg_info_dir
)) {
1863 g_string_append(str
, ",");
1865 if (g_string_append_string_path_param(str
,
1866 "debug-info-target-prefix",
1867 text_legacy_opts
->dbg_info_target_prefix
)) {
1871 g_string_append_bool_param(str
, "no-delta",
1872 text_legacy_opts
->no_delta
);
1873 g_string_append_bool_param(str
, "clock-cycles",
1874 text_legacy_opts
->clock_cycles
);
1875 g_string_append_bool_param(str
, "clock-seconds",
1876 text_legacy_opts
->clock_seconds
);
1877 g_string_append_bool_param(str
, "clock-date",
1878 text_legacy_opts
->clock_date
);
1879 g_string_append_bool_param(str
, "clock-gmt",
1880 text_legacy_opts
->clock_gmt
);
1881 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->names
,
1887 ret
= append_prefixed_flag_params(str
, text_legacy_opts
->fields
,
1893 /* Remove last comma and close single quote */
1894 g_string_append(str
, "'");
1897 printf_err("%s\n\n", str
->str
);
1901 g_string_free(str
, TRUE
);
1907 * Prints the non-legacy source options equivalent to the specified
1908 * legacy input format options.
1911 void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format
,
1912 struct bt_value
*legacy_input_paths
,
1913 struct ctf_legacy_opts
*ctf_legacy_opts
)
1915 const char *input_format
;
1916 GString
*str
= NULL
;
1919 str
= g_string_new(" ");
1925 switch (legacy_input_format
) {
1926 case LEGACY_INPUT_FORMAT_CTF
:
1927 input_format
= "ctf";
1929 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1930 input_format
= "lttng-live";
1936 printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
1938 printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
1941 for (i
= 0; i
< bt_value_array_size(legacy_input_paths
); i
++) {
1942 struct bt_value
*input_value
=
1943 bt_value_array_get(legacy_input_paths
, i
);
1944 const char *input
= NULL
;
1945 char *escaped_input
;
1948 assert(input_value
);
1949 ret
= bt_value_string_get(input_value
, &input
);
1950 BT_PUT(input_value
);
1951 assert(!ret
&& input
);
1952 escaped_input
= str_shell_escape(input
);
1953 if (!escaped_input
) {
1958 g_string_append(str
, "-i ctf.");
1960 switch (legacy_input_format
) {
1961 case LEGACY_INPUT_FORMAT_CTF
:
1962 g_string_append(str
, "fs -p 'path=\"");
1964 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
1965 g_string_append(str
, "lttng-live -p 'url=\"");
1971 g_string_append(str
, escaped_input
);
1972 g_string_append(str
, "\"");
1973 g_string_append_printf(str
, ",offset-s=%" PRId64
,
1974 ctf_legacy_opts
->offset_s
.value
);
1975 g_string_append_printf(str
, ",offset-ns=%" PRId64
,
1976 ctf_legacy_opts
->offset_ns
.value
);
1977 g_string_append_bool_param(str
, "stream-intersection",
1978 ctf_legacy_opts
->stream_intersection
);
1979 g_string_append(str
, "' ");
1980 g_free(escaped_input
);
1983 printf_err("%s\n\n", str
->str
);
1987 g_string_free(str
, TRUE
);
1993 * Validates a given configuration, with optional legacy input and
1994 * output formats options. Prints useful error messages if anything
1997 * Returns true when the configuration is valid.
2000 bool validate_cfg(struct bt_config
*cfg
,
2001 enum legacy_input_format
*legacy_input_format
,
2002 enum legacy_output_format
*legacy_output_format
,
2003 struct bt_value
*legacy_input_paths
,
2004 struct ctf_legacy_opts
*ctf_legacy_opts
,
2005 struct text_legacy_opts
*text_legacy_opts
)
2007 bool legacy_input
= false;
2008 bool legacy_output
= false;
2010 /* Determine if the input and output should be legacy-style */
2011 if (*legacy_input_format
!= LEGACY_INPUT_FORMAT_NONE
||
2012 !bt_value_array_is_empty(legacy_input_paths
) ||
2013 ctf_legacy_opts_is_any_set(ctf_legacy_opts
)) {
2014 legacy_input
= true;
2017 if (*legacy_output_format
!= LEGACY_OUTPUT_FORMAT_NONE
||
2018 text_legacy_opts_is_any_set(text_legacy_opts
)) {
2019 legacy_output
= true;
2023 /* If no legacy input format was specified, default to CTF */
2024 if (*legacy_input_format
== LEGACY_INPUT_FORMAT_NONE
) {
2025 *legacy_input_format
= LEGACY_INPUT_FORMAT_CTF
;
2028 /* Make sure at least one input path exists */
2029 if (bt_value_array_is_empty(legacy_input_paths
)) {
2030 switch (*legacy_input_format
) {
2031 case LEGACY_INPUT_FORMAT_CTF
:
2032 printf_err("No input path specified for legacy `ctf` input format\n");
2034 case LEGACY_INPUT_FORMAT_LTTNG_LIVE
:
2035 printf_err("No URL specified for legacy `lttng-live` input format\n");
2043 /* Make sure no non-legacy sources are specified */
2044 if (cfg
->sources
->len
!= 0) {
2045 print_input_legacy_to_sources(*legacy_input_format
,
2046 legacy_input_paths
, ctf_legacy_opts
);
2051 if (legacy_output
) {
2053 * If no legacy output format was specified, default to
2056 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_NONE
) {
2057 *legacy_output_format
= LEGACY_OUTPUT_FORMAT_TEXT
;
2061 * If any "text" option was specified, the output must be
2064 if (text_legacy_opts_is_any_set(text_legacy_opts
) &&
2065 *legacy_output_format
!=
2066 LEGACY_OUTPUT_FORMAT_TEXT
) {
2067 printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
2071 /* Make sure no non-legacy sinks are specified */
2072 if (cfg
->sinks
->len
!= 0) {
2073 print_output_legacy_to_sinks(*legacy_output_format
,
2080 * If the output is the legacy "ctf-metadata" format, then the
2081 * input should be the legacy "ctf" input format.
2083 if (*legacy_output_format
== LEGACY_OUTPUT_FORMAT_CTF_METADATA
&&
2084 *legacy_input_format
!= LEGACY_INPUT_FORMAT_CTF
) {
2085 printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
2096 * Parses a 64-bit signed integer.
2098 * Returns a negative value if anything goes wrong.
2101 int parse_int64(const char *arg
, int64_t *val
)
2106 *val
= strtoll(arg
, &endptr
, 0);
2107 if (*endptr
!= '\0' || arg
== endptr
|| errno
!= 0) {
2121 OPT_CLOCK_FORCE_CORRELATE
,
2124 OPT_CLOCK_OFFSET_NS
,
2128 OPT_DEBUG_INFO_FULL_PATH
,
2129 OPT_DEBUG_INFO_TARGET_PREFIX
,
2143 OPT_RESET_BASE_PARAMS
,
2146 OPT_STREAM_INTERSECTION
,
2150 OPT_OMIT_SYSTEM_PLUGIN_PATH
,
2151 OPT_OMIT_HOME_PLUGIN_PATH
,
2154 /* popt long option descriptions */
2155 static struct poptOption long_options
[] = {
2156 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2157 { "base-params", 'b', POPT_ARG_STRING
, NULL
, OPT_BASE_PARAMS
, NULL
, NULL
},
2158 { "begin", '\0', POPT_ARG_STRING
, NULL
, OPT_BEGIN
, NULL
, NULL
},
2159 { "clock-cycles", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_CYCLES
, NULL
, NULL
},
2160 { "clock-date", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_DATE
, NULL
, NULL
},
2161 { "clock-force-correlate", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_FORCE_CORRELATE
, NULL
, NULL
},
2162 { "clock-gmt", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_GMT
, NULL
, NULL
},
2163 { "clock-offset", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET
, NULL
, NULL
},
2164 { "clock-offset-ns", '\0', POPT_ARG_STRING
, NULL
, OPT_CLOCK_OFFSET_NS
, NULL
, NULL
},
2165 { "clock-seconds", '\0', POPT_ARG_NONE
, NULL
, OPT_CLOCK_SECONDS
, NULL
, NULL
},
2166 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
2167 { "debug-info-dir", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_DIR
, NULL
, NULL
},
2168 { "debug-info-full-path", 0, POPT_ARG_NONE
, NULL
, OPT_DEBUG_INFO_FULL_PATH
, NULL
, NULL
},
2169 { "debug-info-target-prefix", 0, POPT_ARG_STRING
, NULL
, OPT_DEBUG_INFO_TARGET_PREFIX
, NULL
, NULL
},
2170 { "end", '\0', POPT_ARG_STRING
, NULL
, OPT_END
, NULL
, NULL
},
2171 { "fields", 'f', POPT_ARG_STRING
, NULL
, OPT_FIELDS
, NULL
, NULL
},
2172 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
2173 { "help-legacy", '\0', POPT_ARG_NONE
, NULL
, OPT_HELP_LEGACY
, NULL
, NULL
},
2174 { "input-format", 'i', POPT_ARG_STRING
, NULL
, OPT_INPUT_FORMAT
, NULL
, NULL
},
2175 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
2176 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
2177 { "no-delta", '\0', POPT_ARG_NONE
, NULL
, OPT_NO_DELTA
, NULL
, NULL
},
2178 { "output", 'w', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_PATH
, NULL
, NULL
},
2179 { "output-format", 'o', POPT_ARG_STRING
, NULL
, OPT_OUTPUT_FORMAT
, NULL
, NULL
},
2180 { "path", 'P', POPT_ARG_STRING
, NULL
, OPT_PATH
, NULL
, NULL
},
2181 { "params", 'p', POPT_ARG_STRING
, NULL
, OPT_PARAMS
, NULL
, NULL
},
2182 { "plugin-path", '\0', POPT_ARG_STRING
, NULL
, OPT_PLUGIN_PATH
, NULL
, NULL
},
2183 { "reset-base-params", 'r', POPT_ARG_NONE
, NULL
, OPT_RESET_BASE_PARAMS
, NULL
, NULL
},
2184 { "sink", '\0', POPT_ARG_STRING
, NULL
, OPT_SINK
, NULL
, NULL
},
2185 { "source", '\0', POPT_ARG_STRING
, NULL
, OPT_SOURCE
, NULL
, NULL
},
2186 { "stream-intersection", '\0', POPT_ARG_NONE
, NULL
, OPT_STREAM_INTERSECTION
, NULL
, NULL
},
2187 { "timerange", '\0', POPT_ARG_STRING
, NULL
, OPT_TIMERANGE
, NULL
, NULL
},
2188 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
2189 { "version", 'V', POPT_ARG_NONE
, NULL
, OPT_VERSION
, NULL
, NULL
},
2190 { "omit-system-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_SYSTEM_PLUGIN_PATH
, NULL
, NULL
},
2191 { "omit-home-plugin-path", '\0', POPT_ARG_NONE
, NULL
, OPT_OMIT_HOME_PLUGIN_PATH
, NULL
, NULL
},
2192 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
2196 * Sets the value of a given legacy offset option and marks it as set.
2198 static void set_offset_value(struct offset_opt
*offset_opt
, int64_t value
)
2200 offset_opt
->value
= value
;
2201 offset_opt
->is_set
= true;
2204 enum bt_config_component_dest
{
2205 BT_CONFIG_COMPONENT_DEST_SOURCE
,
2206 BT_CONFIG_COMPONENT_DEST_SINK
,
2210 * Adds a configuration component to the appropriate configuration
2211 * array depending on the destination.
2213 static void add_cfg_comp(struct bt_config
*cfg
,
2214 struct bt_config_component
*cfg_comp
,
2215 enum bt_config_component_dest dest
)
2217 if (dest
== BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2218 g_ptr_array_add(cfg
->sources
, cfg_comp
);
2220 g_ptr_array_add(cfg
->sinks
, cfg_comp
);
2224 static int split_timerange(const char *arg
, const char **begin
, const char **end
)
2228 /* Try to match [begin,end] */
2229 c
= strchr(arg
, '[');
2243 /* Try to match begin,end */
2257 static char *bt_secure_getenv(const char *name
)
2259 if (is_setuid_setgid()) {
2260 printf_err("Disregarding %s environment variable for setuid/setgid binary", name
);
2263 return getenv(name
);
2266 static const char *get_home_dir(void)
2271 val
= bt_secure_getenv(HOME_ENV_VAR
);
2275 /* Fallback on password file. */
2276 pwd
= getpwuid(getuid());
2285 static int add_internal_plugin_paths(struct bt_config
*cfg
)
2287 if (!cfg
->omit_home_plugin_path
) {
2288 char path
[PATH_MAX
];
2289 const char *home_dir
;
2291 if (is_setuid_setgid()) {
2292 printf_debug("Skipping non-system plugin paths for setuid/setgid binary.");
2294 home_dir
= get_home_dir();
2296 if (strlen(home_dir
) + strlen(HOME_SUBPATH
) + 1
2298 printf_err("Home directory path too long\n");
2301 strcpy(path
, home_dir
);
2302 strcat(path
, HOME_SUBPATH
);
2303 if (plugin_paths_from_arg(cfg
->plugin_paths
, path
)) {
2304 printf_err("Invalid home plugin path\n");
2311 if (!cfg
->omit_system_plugin_path
) {
2312 if (plugin_paths_from_arg(cfg
->plugin_paths
,
2313 SYSTEM_PLUGIN_PATH
)) {
2314 printf_err("Invalid system plugin path\n");
2323 static int append_sources_from_implicit_params(GPtrArray
*sources
,
2324 struct bt_config_component
*implicit_source_comp
)
2327 size_t len
= sources
->len
;
2329 for (i
= 0; i
< len
; i
++) {
2330 struct bt_config_component
*comp
;
2331 struct bt_value
*params_to_set
;
2333 comp
= g_ptr_array_index(sources
, i
);
2334 params_to_set
= bt_value_map_extend(comp
->params
,
2335 implicit_source_comp
->params
);
2336 if (!params_to_set
) {
2337 printf_err("Cannot extend legacy component parameters with non-legacy parameters\n");
2340 BT_MOVE(comp
->params
, params_to_set
);
2347 struct bt_config
*bt_config_create(void)
2349 struct bt_config
*cfg
;
2352 cfg
= g_new0(struct bt_config
, 1);
2358 bt_object_init(cfg
, bt_config_destroy
);
2359 cfg
->sources
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2360 if (!cfg
->sources
) {
2365 cfg
->sinks
= g_ptr_array_new_with_free_func((GDestroyNotify
) bt_put
);
2371 cfg
->plugin_paths
= bt_value_array_create();
2372 if (!cfg
->plugin_paths
) {
2384 * Returns a Babeltrace configuration, out of command-line arguments,
2385 * containing everything that is needed to instanciate specific
2386 * components with given parameters.
2388 * Return value is set to the appropriate exit code to use.
2390 int bt_config_init_from_args(struct bt_config
*cfg
, int argc
, const char *argv
[])
2392 poptContext pc
= NULL
;
2394 struct ctf_legacy_opts ctf_legacy_opts
;
2395 struct text_legacy_opts text_legacy_opts
;
2396 enum legacy_input_format legacy_input_format
= LEGACY_INPUT_FORMAT_NONE
;
2397 enum legacy_output_format legacy_output_format
=
2398 LEGACY_OUTPUT_FORMAT_NONE
;
2399 struct bt_value
*legacy_input_paths
= NULL
;
2400 struct bt_config_component
*implicit_source_comp
= NULL
;
2401 struct bt_config_component
*cur_cfg_comp
= NULL
;
2402 bool cur_is_implicit_source
= false;
2403 bool use_implicit_source
= false;
2404 enum bt_config_component_dest cur_cfg_comp_dest
=
2405 BT_CONFIG_COMPONENT_DEST_SOURCE
;
2406 struct bt_value
*cur_base_params
= NULL
;
2409 memset(&ctf_legacy_opts
, 0, sizeof(ctf_legacy_opts
));
2410 memset(&text_legacy_opts
, 0, sizeof(text_legacy_opts
));
2412 text_legacy_opts
.output
= g_string_new(NULL
);
2413 if (!text_legacy_opts
.output
) {
2418 text_legacy_opts
.dbg_info_dir
= g_string_new(NULL
);
2419 if (!text_legacy_opts
.dbg_info_dir
) {
2424 text_legacy_opts
.dbg_info_target_prefix
= g_string_new(NULL
);
2425 if (!text_legacy_opts
.dbg_info_target_prefix
) {
2430 cur_base_params
= bt_value_map_create();
2431 if (!cur_base_params
) {
2436 legacy_input_paths
= bt_value_array_create();
2437 if (!legacy_input_paths
) {
2442 /* Note: implicit source never gets positional base params. */
2443 implicit_source_comp
= bt_config_component_from_arg(DEFAULT_SOURCE_COMPONENT_NAME
);
2444 if (implicit_source_comp
) {
2445 cur_cfg_comp
= implicit_source_comp
;
2446 cur_is_implicit_source
= true;
2447 use_implicit_source
= true;
2449 printf_debug("Cannot find implicit source plugin \"%s\"",
2450 DEFAULT_SOURCE_COMPONENT_NAME
);
2454 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
2456 printf_err("Cannot get popt context\n");
2460 poptReadDefaultConfig(pc
, 0);
2462 while ((opt
= poptGetNextOpt(pc
)) > 0) {
2463 arg
= poptGetOptArg(pc
);
2466 case OPT_PLUGIN_PATH
:
2467 if (is_setuid_setgid()) {
2468 printf_debug("Skipping non-system plugin paths for setuid/setgid binary.");
2470 if (plugin_paths_from_arg(cfg
->plugin_paths
, arg
)) {
2471 printf_err("Invalid --plugin-path option's argument\n");
2476 case OPT_OMIT_SYSTEM_PLUGIN_PATH
:
2477 cfg
->omit_system_plugin_path
= true;
2479 case OPT_OMIT_HOME_PLUGIN_PATH
:
2480 cfg
->omit_home_plugin_path
= true;
2482 case OPT_OUTPUT_PATH
:
2483 if (text_legacy_opts
.output
->len
> 0) {
2484 printf_err("Duplicate --output option\n");
2488 g_string_assign(text_legacy_opts
.output
, arg
);
2490 case OPT_DEBUG_INFO_DIR
:
2491 if (text_legacy_opts
.dbg_info_dir
->len
> 0) {
2492 printf_err("Duplicate --debug-info-dir option\n");
2496 g_string_assign(text_legacy_opts
.dbg_info_dir
, arg
);
2498 case OPT_DEBUG_INFO_TARGET_PREFIX
:
2499 if (text_legacy_opts
.dbg_info_target_prefix
->len
> 0) {
2500 printf_err("Duplicate --debug-info-target-prefix option\n");
2504 g_string_assign(text_legacy_opts
.dbg_info_target_prefix
, arg
);
2506 case OPT_INPUT_FORMAT
:
2509 if (opt
== OPT_INPUT_FORMAT
) {
2510 if (!strcmp(arg
, "ctf")) {
2511 /* Legacy CTF input format */
2512 if (legacy_input_format
) {
2513 print_err_dup_legacy_input();
2517 legacy_input_format
=
2518 LEGACY_INPUT_FORMAT_CTF
;
2520 } else if (!strcmp(arg
, "lttng-live")) {
2521 /* Legacy LTTng-live input format */
2522 if (legacy_input_format
) {
2523 print_err_dup_legacy_input();
2527 legacy_input_format
=
2528 LEGACY_INPUT_FORMAT_LTTNG_LIVE
;
2533 use_implicit_source
= false;
2535 /* Non-legacy: try to create a component config */
2536 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
2537 add_cfg_comp(cfg
, cur_cfg_comp
,
2541 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2542 if (!cur_cfg_comp
) {
2543 printf_err("Invalid format for --source option's argument:\n %s\n",
2547 cur_is_implicit_source
= false;
2549 assert(cur_base_params
);
2550 bt_put(cur_cfg_comp
->params
);
2551 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2552 if (!cur_cfg_comp
->params
) {
2557 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SOURCE
;
2560 case OPT_OUTPUT_FORMAT
:
2563 if (opt
== OPT_OUTPUT_FORMAT
) {
2564 if (!strcmp(arg
, "text")) {
2565 /* Legacy CTF-text output format */
2566 if (legacy_output_format
) {
2567 print_err_dup_legacy_output();
2571 legacy_output_format
=
2572 LEGACY_OUTPUT_FORMAT_TEXT
;
2574 } else if (!strcmp(arg
, "dummy")) {
2575 /* Legacy dummy output format */
2576 if (legacy_output_format
) {
2577 print_err_dup_legacy_output();
2581 legacy_output_format
=
2582 LEGACY_OUTPUT_FORMAT_DUMMY
;
2584 } else if (!strcmp(arg
, "ctf-metadata")) {
2585 /* Legacy CTF-metadata output format */
2586 if (legacy_output_format
) {
2587 print_err_dup_legacy_output();
2591 legacy_output_format
=
2592 LEGACY_OUTPUT_FORMAT_CTF_METADATA
;
2597 /* Non-legacy: try to create a component config */
2598 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
2599 add_cfg_comp(cfg
, cur_cfg_comp
,
2603 cur_cfg_comp
= bt_config_component_from_arg(arg
);
2604 if (!cur_cfg_comp
) {
2605 printf_err("Invalid format for --sink option's argument:\n %s\n",
2609 cur_is_implicit_source
= false;
2611 assert(cur_base_params
);
2612 bt_put(cur_cfg_comp
->params
);
2613 cur_cfg_comp
->params
= bt_value_copy(cur_base_params
);
2614 if (!cur_cfg_comp
->params
) {
2619 cur_cfg_comp_dest
= BT_CONFIG_COMPONENT_DEST_SINK
;
2624 struct bt_value
*params
;
2625 struct bt_value
*params_to_set
;
2627 if (!cur_cfg_comp
) {
2628 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2629 DEFAULT_SOURCE_COMPONENT_NAME
);
2633 params
= bt_value_from_arg(arg
);
2635 printf_err("Invalid format for --params option's argument:\n %s\n",
2640 params_to_set
= bt_value_map_extend(cur_cfg_comp
->params
,
2643 if (!params_to_set
) {
2644 printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n",
2649 BT_MOVE(cur_cfg_comp
->params
, params_to_set
);
2653 if (!cur_cfg_comp
) {
2654 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2655 DEFAULT_SOURCE_COMPONENT_NAME
);
2659 assert(cur_cfg_comp
->params
);
2661 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2667 case OPT_BASE_PARAMS
:
2669 struct bt_value
*params
= bt_value_from_arg(arg
);
2672 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2677 BT_MOVE(cur_base_params
, params
);
2680 case OPT_RESET_BASE_PARAMS
:
2681 BT_PUT(cur_base_params
);
2682 cur_base_params
= bt_value_map_create();
2683 if (!cur_base_params
) {
2689 if (text_legacy_opts
.names
) {
2690 printf_err("Duplicate --names option\n");
2694 text_legacy_opts
.names
= names_from_arg(arg
);
2695 if (!text_legacy_opts
.names
) {
2696 printf_err("Invalid --names option's argument\n");
2701 if (text_legacy_opts
.fields
) {
2702 printf_err("Duplicate --fields option\n");
2706 text_legacy_opts
.fields
= fields_from_arg(arg
);
2707 if (!text_legacy_opts
.fields
) {
2708 printf_err("Invalid --fields option's argument\n");
2713 text_legacy_opts
.no_delta
= true;
2715 case OPT_CLOCK_CYCLES
:
2716 text_legacy_opts
.clock_cycles
= true;
2718 case OPT_CLOCK_SECONDS
:
2719 text_legacy_opts
.clock_seconds
= true;
2721 case OPT_CLOCK_DATE
:
2722 text_legacy_opts
.clock_date
= true;
2725 text_legacy_opts
.clock_gmt
= true;
2727 case OPT_DEBUG_INFO_FULL_PATH
:
2728 text_legacy_opts
.dbg_info_full_path
= true;
2730 case OPT_CLOCK_OFFSET
:
2734 if (ctf_legacy_opts
.offset_s
.is_set
) {
2735 printf_err("Duplicate --clock-offset option\n");
2739 if (parse_int64(arg
, &val
)) {
2740 printf_err("Invalid --clock-offset option's argument\n");
2744 set_offset_value(&ctf_legacy_opts
.offset_s
, val
);
2747 case OPT_CLOCK_OFFSET_NS
:
2751 if (ctf_legacy_opts
.offset_ns
.is_set
) {
2752 printf_err("Duplicate --clock-offset-ns option\n");
2756 if (parse_int64(arg
, &val
)) {
2757 printf_err("Invalid --clock-offset-ns option's argument\n");
2761 set_offset_value(&ctf_legacy_opts
.offset_ns
, val
);
2764 case OPT_STREAM_INTERSECTION
:
2765 ctf_legacy_opts
.stream_intersection
= true;
2767 case OPT_CLOCK_FORCE_CORRELATE
:
2768 cfg
->force_correlate
= true;
2771 if (!cur_cfg_comp
) {
2772 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2773 DEFAULT_SOURCE_COMPONENT_NAME
);
2776 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2777 printf_err("--begin option must follow a --source option\n");
2780 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2787 if (!cur_cfg_comp
) {
2788 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2789 DEFAULT_SOURCE_COMPONENT_NAME
);
2792 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2793 printf_err("--end option must follow a --source option\n");
2796 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2804 const char *begin
, *end
;
2806 if (!cur_cfg_comp
) {
2807 printf_err("Can not apply parameter to unavailable default source component \"%s\".\n",
2808 DEFAULT_SOURCE_COMPONENT_NAME
);
2811 if (cur_cfg_comp_dest
!= BT_CONFIG_COMPONENT_DEST_SOURCE
) {
2812 printf_err("--timerange option must follow a --source option\n");
2815 if (split_timerange(arg
, &begin
, &end
)) {
2816 printf_err("Invalid --timerange format, expecting: begin,end or [begin,end] (where [] are actual brackets)\n");
2819 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2824 if (bt_value_map_insert_string(cur_cfg_comp
->params
,
2832 print_usage(stdout
);
2834 case OPT_HELP_LEGACY
:
2835 print_legacy_usage(stdout
);
2841 cfg
->do_list
= true;
2844 cfg
->verbose
= true;
2850 printf_err("Unknown command-line option specified (option code %d)\n",
2860 print_usage(stdout
);
2864 /* Check for option parsing error */
2866 printf_err("While parsing command-line options, at option %s: %s\n",
2867 poptBadOption(pc
, 0), poptStrerror(opt
));
2871 /* Consume leftover arguments as legacy input paths */
2873 const char *input_path
= poptGetArg(pc
);
2879 if (bt_value_array_append_string(legacy_input_paths
,
2886 if (add_internal_plugin_paths(cfg
)) {
2890 /* Append current component configuration, if any */
2891 if (cur_cfg_comp
&& !cur_is_implicit_source
) {
2892 add_cfg_comp(cfg
, cur_cfg_comp
, cur_cfg_comp_dest
);
2894 cur_cfg_comp
= NULL
;
2896 /* Validate legacy/non-legacy options */
2897 if (!validate_cfg(cfg
, &legacy_input_format
, &legacy_output_format
,
2898 legacy_input_paths
, &ctf_legacy_opts
,
2899 &text_legacy_opts
)) {
2900 printf_err("Command-line options form an invalid configuration\n");
2905 * If there's a legacy input format, convert it to source
2906 * component configurations.
2908 if (legacy_input_format
) {
2909 if (append_sources_from_legacy_opts(cfg
->sources
,
2910 legacy_input_format
, &ctf_legacy_opts
,
2911 legacy_input_paths
)) {
2912 printf_err("Cannot convert legacy input format options to source component instance(s)\n");
2915 if (append_sources_from_implicit_params(cfg
->sources
,
2916 implicit_source_comp
)) {
2917 printf_err("Cannot initialize legacy component parameters\n");
2920 use_implicit_source
= false;
2922 if (use_implicit_source
) {
2923 add_cfg_comp(cfg
, implicit_source_comp
,
2924 BT_CONFIG_COMPONENT_DEST_SOURCE
);
2925 implicit_source_comp
= NULL
;
2927 if (implicit_source_comp
2928 && !bt_value_map_is_empty(implicit_source_comp
->params
)) {
2929 printf_err("Arguments specified for implicit source, but an explicit source has been specified, overriding it\n");
2936 * If there's a legacy output format, convert it to sink
2937 * component configurations.
2939 if (legacy_output_format
) {
2940 if (append_sinks_from_legacy_opts(cfg
->sinks
,
2941 legacy_output_format
, &text_legacy_opts
)) {
2942 printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
2947 if (cfg
->sinks
->len
== 0) {
2948 /* Use implicit sink as default. */
2949 cur_cfg_comp
= bt_config_component_from_arg(DEFAULT_SINK_COMPONENT_NAME
);
2950 if (!cur_cfg_comp
) {
2951 printf_error("Cannot find implicit sink plugin \"%s\"\n",
2952 DEFAULT_SINK_COMPONENT_NAME
);
2954 add_cfg_comp(cfg
, cur_cfg_comp
,
2955 BT_CONFIG_COMPONENT_DEST_SINK
);
2956 cur_cfg_comp
= NULL
;
2965 poptFreeContext(pc
);
2968 if (text_legacy_opts
.output
) {
2969 g_string_free(text_legacy_opts
.output
, TRUE
);
2972 if (text_legacy_opts
.dbg_info_dir
) {
2973 g_string_free(text_legacy_opts
.dbg_info_dir
, TRUE
);
2976 if (text_legacy_opts
.dbg_info_target_prefix
) {
2977 g_string_free(text_legacy_opts
.dbg_info_target_prefix
, TRUE
);
2981 BT_PUT(implicit_source_comp
);
2982 BT_PUT(cur_cfg_comp
);
2983 BT_PUT(cur_base_params
);
2984 BT_PUT(text_legacy_opts
.names
);
2985 BT_PUT(text_legacy_opts
.fields
);
2986 BT_PUT(legacy_input_paths
);