trimmer: error checking, reporting, begin > end check
[babeltrace.git] / converter / babeltrace-cfg.c
CommitLineData
c42c79ea
PP
1/*
2 * Babeltrace trace converter - parameter parsing
3 *
4 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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
22 * SOFTWARE.
23 */
24
25#include <errno.h>
26#include <stdlib.h>
27#include <string.h>
28#include <assert.h>
29#include <stdio.h>
30#include <stdbool.h>
31#include <inttypes.h>
32#include <babeltrace/babeltrace.h>
33#include <babeltrace/values.h>
34#include <popt.h>
35#include <glib.h>
36#include "babeltrace-cfg.h"
37
38/*
39 * Error printf() macro which prepends "Error: " the first time it's
40 * called. This gives a nicer feel than having a bunch of error prefixes
41 * (since the following lines usually describe the error and possible
42 * solutions), or the error prefix just at the end.
43 */
44#define printf_err(fmt, args...) \
45 do { \
46 if (is_first_error) { \
47 fprintf(stderr, "Error: "); \
48 is_first_error = false; \
49 } \
50 fprintf(stderr, fmt, ##args); \
51 } while (0)
52
53static bool is_first_error = true;
54
55/* INI-style parsing FSM states */
56enum ini_parsing_fsm_state {
57 /* Expect a map key (identifier) */
58 INI_EXPECT_MAP_KEY,
59
60 /* Expect an equal character ('=') */
61 INI_EXPECT_EQUAL,
62
63 /* Expect a value */
64 INI_EXPECT_VALUE,
65
66 /* Expect a negative number value */
67 INI_EXPECT_VALUE_NUMBER_NEG,
68
69 /* Expect a comma character (',') */
70 INI_EXPECT_COMMA,
71};
72
73/* INI-style parsing state variables */
74struct ini_parsing_state {
75 /* Lexical scanner (owned by this) */
76 GScanner *scanner;
77
78 /* Output map value object being filled (owned by this) */
79 struct bt_value *params;
80
81 /* Next expected FSM state */
82 enum ini_parsing_fsm_state expecting;
83
84 /* Last decoded map key (owned by this) */
85 char *last_map_key;
86
87 /* Complete INI-style string to parse (not owned by this) */
88 const char *arg;
89
90 /* Error buffer (not owned by this) */
91 GString *ini_error;
92};
93
94/* Offset option with "is set" boolean */
95struct offset_opt {
96 int64_t value;
97 bool is_set;
98};
99
100/* Legacy "ctf"/"lttng-live" format options */
101struct ctf_legacy_opts {
102 struct offset_opt offset_s;
103 struct offset_opt offset_ns;
104 bool stream_intersection;
105};
106
107/* Legacy "text" format options */
108struct text_legacy_opts {
109 /*
110 * output, dbg_info_dir, dbg_info_target_prefix, names,
111 * and fields are owned by this.
112 */
113 GString *output;
114 GString *dbg_info_dir;
115 GString *dbg_info_target_prefix;
116 struct bt_value *names;
117 struct bt_value *fields;
118
119 /* Flags */
120 bool no_delta;
121 bool clock_cycles;
122 bool clock_seconds;
123 bool clock_date;
124 bool clock_gmt;
125 bool dbg_info_full_path;
126};
127
128/* Legacy input format format */
129enum legacy_input_format {
130 LEGACY_INPUT_FORMAT_NONE = 0,
131 LEGACY_INPUT_FORMAT_CTF,
132 LEGACY_INPUT_FORMAT_LTTNG_LIVE,
133};
134
135/* Legacy output format format */
136enum legacy_output_format {
137 LEGACY_OUTPUT_FORMAT_NONE = 0,
138 LEGACY_OUTPUT_FORMAT_TEXT,
139 LEGACY_OUTPUT_FORMAT_CTF_METADATA,
140 LEGACY_OUTPUT_FORMAT_DUMMY,
141};
142
143/*
144 * Prints the "out of memory" error.
145 */
146static
147void print_err_oom(void)
148{
149 printf_err("Out of memory\n");
150}
151
152/*
153 * Prints duplicate legacy output format error.
154 */
155static
156void print_err_dup_legacy_output(void)
157{
158 printf_err("More than one legacy output format specified\n");
159}
160
161/*
162 * Prints duplicate legacy input format error.
163 */
164static
165void print_err_dup_legacy_input(void)
166{
167 printf_err("More than one legacy input format specified\n");
168}
169
170/*
171 * Checks if any of the "text" legacy options is set.
172 */
173static
174bool text_legacy_opts_is_any_set(struct text_legacy_opts *opts)
175{
176 return (opts->output && opts->output->len > 0) ||
177 (opts->dbg_info_dir && opts->dbg_info_dir->len > 0) ||
178 (opts->dbg_info_target_prefix &&
179 opts->dbg_info_target_prefix->len > 0) ||
180 bt_value_array_size(opts->names) > 0 ||
181 bt_value_array_size(opts->fields) > 0 ||
182 opts->no_delta || opts->clock_cycles || opts->clock_seconds ||
183 opts->clock_date || opts->clock_gmt ||
184 opts->dbg_info_full_path;
185}
186
187/*
188 * Checks if any of the "ctf" legacy options is set.
189 */
190static
191bool ctf_legacy_opts_is_any_set(struct ctf_legacy_opts *opts)
192{
193 return opts->offset_s.is_set || opts->offset_ns.is_set ||
194 opts->stream_intersection;
195}
196
197/*
198 * Appends an "expecting token" error to the INI-style parsing state's
199 * error buffer.
200 */
201static
202void ini_append_error_expecting(struct ini_parsing_state *state,
203 GScanner *scanner, const char *expecting)
204{
205 size_t i;
206 size_t pos;
207
208 g_string_append_printf(state->ini_error, "Expecting %s:\n", expecting);
209
210 /* Only print error if there's one line */
211 if (strchr(state->arg, '\n') != NULL || strlen(state->arg) == 0) {
212 return;
213 }
214
215 g_string_append_printf(state->ini_error, "\n %s\n", state->arg);
216 pos = g_scanner_cur_position(scanner) + 4;
217
218 if (!g_scanner_eof(scanner)) {
219 pos--;
220 }
221
222 for (i = 0; i < pos; ++i) {
223 g_string_append_printf(state->ini_error, " ");
224 }
225
226 g_string_append_printf(state->ini_error, "^\n\n");
227}
228
229static
230int ini_handle_state(struct ini_parsing_state *state)
231{
232 int ret = 0;
233 GTokenType token_type;
234 struct bt_value *value = NULL;
235
236 token_type = g_scanner_get_next_token(state->scanner);
237 if (token_type == G_TOKEN_EOF) {
238 if (state->expecting != INI_EXPECT_COMMA) {
239 switch (state->expecting) {
240 case INI_EXPECT_EQUAL:
241 ini_append_error_expecting(state,
242 state->scanner, "'='");
243 break;
244 case INI_EXPECT_VALUE:
245 case INI_EXPECT_VALUE_NUMBER_NEG:
246 ini_append_error_expecting(state,
247 state->scanner, "value");
248 break;
249 case INI_EXPECT_MAP_KEY:
250 ini_append_error_expecting(state,
251 state->scanner, "unquoted map key");
252 break;
253 default:
254 break;
255 }
256 goto error;
257 }
258
259 /* We're done! */
260 ret = 1;
261 goto success;
262 }
263
264 switch (state->expecting) {
265 case INI_EXPECT_MAP_KEY:
266 if (token_type != G_TOKEN_IDENTIFIER) {
267 ini_append_error_expecting(state, state->scanner,
268 "unquoted map key");
269 goto error;
270 }
271
272 free(state->last_map_key);
273 state->last_map_key =
274 strdup(state->scanner->value.v_identifier);
275 if (!state->last_map_key) {
276 g_string_append(state->ini_error,
277 "Out of memory\n");
278 goto error;
279 }
280
281 if (bt_value_map_has_key(state->params, state->last_map_key)) {
282 g_string_append_printf(state->ini_error,
6d1d5711 283 "Duplicate parameter key: `%s`\n",
c42c79ea
PP
284 state->last_map_key);
285 goto error;
286 }
287
288 state->expecting = INI_EXPECT_EQUAL;
289 goto success;
290 case INI_EXPECT_EQUAL:
291 if (token_type != G_TOKEN_CHAR) {
292 ini_append_error_expecting(state,
293 state->scanner, "'='");
294 goto error;
295 }
296
297 if (state->scanner->value.v_char != '=') {
298 ini_append_error_expecting(state,
299 state->scanner, "'='");
300 goto error;
301 }
302
303 state->expecting = INI_EXPECT_VALUE;
304 goto success;
305 case INI_EXPECT_VALUE:
306 {
307 switch (token_type) {
308 case G_TOKEN_CHAR:
309 if (state->scanner->value.v_char == '-') {
310 /* Negative number */
311 state->expecting =
312 INI_EXPECT_VALUE_NUMBER_NEG;
313 goto success;
314 } else {
315 ini_append_error_expecting(state,
316 state->scanner, "value");
317 goto error;
318 }
319 break;
320 case G_TOKEN_INT:
321 {
322 /* Positive integer */
323 uint64_t int_val = state->scanner->value.v_int64;
324
325 if (int_val > (1ULL << 63) - 1) {
326 g_string_append_printf(state->ini_error,
327 "Integer value %" PRIu64 " is outside the range of a 64-bit signed integer\n",
328 int_val);
329 goto error;
330 }
331
332 value = bt_value_integer_create_init(
333 (int64_t) int_val);
334 break;
335 }
336 case G_TOKEN_FLOAT:
337 /* Positive floating point number */
338 value = bt_value_float_create_init(
339 state->scanner->value.v_float);
340 break;
341 case G_TOKEN_STRING:
342 /* Quoted string */
343 value = bt_value_string_create_init(
344 state->scanner->value.v_string);
345 break;
346 case G_TOKEN_IDENTIFIER:
347 {
348 /*
349 * Using symbols would be appropriate here,
350 * but said symbols are allowed as map key,
351 * so it's easier to consider everything an
352 * identifier.
353 *
354 * If one of the known symbols is not
355 * recognized here, then fall back to creating
356 * a string value.
357 */
358 const char *id = state->scanner->value.v_identifier;
359
360 if (!strcmp(id, "null") || !strcmp(id, "NULL") ||
361 !strcmp(id, "nul")) {
362 value = bt_value_null;
363 } else if (!strcmp(id, "true") || !strcmp(id, "TRUE") ||
364 !strcmp(id, "yes") ||
365 !strcmp(id, "YES")) {
366 value = bt_value_bool_create_init(true);
367 } else if (!strcmp(id, "false") ||
368 !strcmp(id, "FALSE") ||
369 !strcmp(id, "no") ||
370 !strcmp(id, "NO")) {
371 value = bt_value_bool_create_init(false);
372 } else {
373 value = bt_value_string_create_init(id);
374 }
375 break;
376 }
377 default:
378 /* Unset value variable will trigger the error */
379 break;
380 }
381
382 if (!value) {
383 ini_append_error_expecting(state,
384 state->scanner, "value");
385 goto error;
386 }
387
388 state->expecting = INI_EXPECT_COMMA;
389 goto success;
390 }
391 case INI_EXPECT_VALUE_NUMBER_NEG:
392 {
393 switch (token_type) {
394 case G_TOKEN_INT:
395 {
396 /* Negative integer */
397 uint64_t int_val = state->scanner->value.v_int64;
398
399 if (int_val > (1ULL << 63) - 1) {
400 g_string_append_printf(state->ini_error,
401 "Integer value -%" PRIu64 " is outside the range of a 64-bit signed integer\n",
402 int_val);
403 goto error;
404 }
405
406 value = bt_value_integer_create_init(
407 -((int64_t) int_val));
408 break;
409 }
410 case G_TOKEN_FLOAT:
411 /* Negative floating point number */
412 value = bt_value_float_create_init(
413 -state->scanner->value.v_float);
414 break;
415 default:
416 /* Unset value variable will trigger the error */
417 break;
418 }
419
420 if (!value) {
421 ini_append_error_expecting(state,
422 state->scanner, "value");
423 goto error;
424 }
425
426 state->expecting = INI_EXPECT_COMMA;
427 goto success;
428 }
429 case INI_EXPECT_COMMA:
430 if (token_type != G_TOKEN_CHAR) {
431 ini_append_error_expecting(state,
432 state->scanner, "','");
433 goto error;
434 }
435
436 if (state->scanner->value.v_char != ',') {
437 ini_append_error_expecting(state,
438 state->scanner, "','");
439 goto error;
440 }
441
442 state->expecting = INI_EXPECT_MAP_KEY;
443 goto success;
444 default:
445 assert(false);
446 }
447
448error:
449 ret = -1;
450 goto end;
451
452success:
453 if (value) {
454 if (bt_value_map_insert(state->params,
455 state->last_map_key, value)) {
456 /* Only override return value on error */
457 ret = -1;
458 }
459 }
460
461end:
462 BT_PUT(value);
463 return ret;
464}
465
466/*
467 * Converts an INI-style argument to an equivalent map value object.
468 *
469 * Return value is owned by the caller.
470 */
471static
472struct bt_value *bt_value_from_ini(const char *arg, GString *ini_error)
473{
474 /* Lexical scanner configuration */
475 GScannerConfig scanner_config = {
476 /* Skip whitespaces */
477 .cset_skip_characters = " \t\n",
478
479 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
480 .cset_identifier_first =
481 G_CSET_a_2_z
482 "_"
483 G_CSET_A_2_Z,
484 .cset_identifier_nth =
485 G_CSET_a_2_z
486 "_0123456789-.:"
487 G_CSET_A_2_Z,
488
489 /* "hello" and "Hello" two different keys */
490 .case_sensitive = TRUE,
491
492 /* No comments */
493 .cpair_comment_single = NULL,
494 .skip_comment_multi = TRUE,
495 .skip_comment_single = TRUE,
496 .scan_comment_multi = FALSE,
497
498 /*
499 * Do scan identifiers, including 1-char identifiers,
500 * but NULL is a normal identifier.
501 */
502 .scan_identifier = TRUE,
503 .scan_identifier_1char = TRUE,
504 .scan_identifier_NULL = FALSE,
505
506 /*
507 * No specific symbols: null and boolean "symbols" are
508 * scanned as plain identifiers.
509 */
510 .scan_symbols = FALSE,
511 .symbol_2_token = FALSE,
512 .scope_0_fallback = FALSE,
513
514 /*
515 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
516 * integers prefixed with "$".
517 */
518 .scan_binary = TRUE,
519 .scan_octal = TRUE,
520 .scan_float = TRUE,
521 .scan_hex = TRUE,
522 .scan_hex_dollar = FALSE,
523
524 /* Convert scanned numbers to integer tokens */
525 .numbers_2_int = TRUE,
526
527 /* Support both integers and floating-point numbers */
528 .int_2_float = FALSE,
529
530 /* Scan integers as 64-bit signed integers */
531 .store_int64 = TRUE,
532
533 /* Only scan double-quoted strings */
534 .scan_string_sq = FALSE,
535 .scan_string_dq = TRUE,
536
537 /* Do not converter identifiers to string tokens */
538 .identifier_2_string = FALSE,
539
540 /* Scan characters as G_TOKEN_CHAR token */
541 .char_2_token = FALSE,
542 };
543 struct ini_parsing_state state = {
544 .scanner = NULL,
545 .params = NULL,
546 .expecting = INI_EXPECT_MAP_KEY,
547 .arg = arg,
548 .ini_error = ini_error,
549 };
550
551 state.params = bt_value_map_create();
552 if (!state.params) {
553 goto error;
554 }
555
556 state.scanner = g_scanner_new(&scanner_config);
557 if (!state.scanner) {
558 goto error;
559 }
560
561 /* Let the scan begin */
562 g_scanner_input_text(state.scanner, arg, strlen(arg));
563
564 while (true) {
565 int ret = ini_handle_state(&state);
566
567 if (ret < 0) {
568 /* Error */
569 goto error;
570 } else if (ret > 0) {
571 /* Done */
572 break;
573 }
574 }
575
576 goto end;
577
578error:
579 BT_PUT(state.params);
580
581end:
582 if (state.scanner) {
583 g_scanner_destroy(state.scanner);
584 }
585
586 free(state.last_map_key);
587 return state.params;
588}
589
590/*
591 * Returns the parameters map value object from a command-line
bdc61c70 592 * parameter option's argument.
c42c79ea
PP
593 *
594 * Return value is owned by the caller.
595 */
596static
597struct bt_value *bt_value_from_arg(const char *arg)
598{
599 struct bt_value *params = NULL;
c42c79ea
PP
600 GString *ini_error = NULL;
601
c42c79ea
PP
602 ini_error = g_string_new(NULL);
603 if (!ini_error) {
604 print_err_oom();
605 goto end;
606 }
607
608 /* Try INI-style parsing */
bdc61c70 609 params = bt_value_from_ini(arg, ini_error);
c42c79ea
PP
610 if (!params) {
611 printf_err("%s", ini_error->str);
612 goto end;
613 }
614
615end:
616 if (ini_error) {
617 g_string_free(ini_error, TRUE);
618 }
619 return params;
620}
621
622/*
623 * Returns the plugin and component names from a command-line
bdc61c70
PP
624 * source/sink option's argument. arg must have the following format:
625 *
626 * PLUGIN.COMPONENT
627 *
628 * where PLUGIN is the plugin name, and COMPONENT is the component
629 * name.
c42c79ea
PP
630 *
631 * On success, both *plugin and *component are not NULL. *plugin
632 * and *component are owned by the caller.
633 */
634static
635void plugin_component_names_from_arg(const char *arg, char **plugin,
636 char **component)
637{
638 const char *dot;
bdc61c70 639 const char *end;
c42c79ea
PP
640 size_t plugin_len;
641 size_t component_len;
642
bdc61c70 643 /* Initialize both return values to NULL: not found */
c42c79ea
PP
644 *plugin = NULL;
645 *component = NULL;
646
647 dot = strchr(arg, '.');
bdc61c70
PP
648 if (!dot) {
649 /* No dot */
c42c79ea
PP
650 goto end;
651 }
652
bdc61c70 653 end = arg + strlen(arg);
c42c79ea 654 plugin_len = dot - arg;
bdc61c70 655 component_len = end - dot - 1;
c42c79ea
PP
656 if (plugin_len == 0 || component_len == 0) {
657 goto end;
658 }
659
bdc61c70 660 *plugin = g_malloc0(plugin_len + 1);
c42c79ea
PP
661 if (!*plugin) {
662 print_err_oom();
663 goto end;
664 }
665
bdc61c70
PP
666 g_strlcpy(*plugin, arg, plugin_len + 1);
667 *component = g_malloc0(component_len + 1);
c42c79ea
PP
668 if (!*component) {
669 print_err_oom();
670 goto end;
671 }
672
bdc61c70 673 g_strlcpy(*component, dot + 1, component_len + 1);
c42c79ea
PP
674
675end:
676 return;
677}
678
679/*
680 * Prints the Babeltrace version.
681 */
682static
683void print_version(void)
684{
685 puts("Babeltrace " VERSION);
686}
687
688/*
689 * Prints the legacy, Babeltrace 1.x command usage. Those options are
690 * still compatible in Babeltrace 2.x, but it is recommended to use
691 * the more generic plugin/component parameters instead of those
692 * hard-coded option names.
693 */
694static
695void print_legacy_usage(FILE *fp)
696{
697 fprintf(fp, "Usage: babeltrace [OPTIONS] INPUT...\n");
698 fprintf(fp, "\n");
699 fprintf(fp, "The following options are compatible with the Babeltrace 1.x options:\n");
700 fprintf(fp, "\n");
701 fprintf(fp, " --help-legacy Show this help\n");
702 fprintf(fp, " -V, --version Show version\n");
703 fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n");
704 fprintf(fp, " across traces\n");
705 fprintf(fp, " -d, --debug Enable debug mode\n");
706 fprintf(fp, " -i, --input-format=FORMAT Input trace format (default: ctf)\n");
707 fprintf(fp, " -l, --list List available formats\n");
708 fprintf(fp, " -o, --output-format=FORMAT Output trace format (default: text)\n");
709 fprintf(fp, " -v, --verbose Enable verbose output\n");
710 fprintf(fp, "\n");
711 fprintf(fp, " Available input formats: ctf, lttng-live, ctf-metadata\n");
712 fprintf(fp, " Available output formats: text, dummy\n");
713 fprintf(fp, "\n");
714 fprintf(fp, "Input formats specific options:\n");
715 fprintf(fp, "\n");
716 fprintf(fp, " INPUT... Input trace file(s), directory(ies), or URLs\n");
717 fprintf(fp, " --clock-offset=SEC Set clock offset to SEC seconds\n");
718 fprintf(fp, " --clock-offset-ns=NS Set clock offset to NS nanoseconds\n");
719 fprintf(fp, " --stream-intersection Only process events when all streams are active\n");
720 fprintf(fp, "\n");
721 fprintf(fp, "text output format specific options:\n");
722 fprintf(fp, " \n");
723 fprintf(fp, " --clock-cycles Print timestamps in clock cycles\n");
724 fprintf(fp, " --clock-date Print timestamp dates\n");
528debdf 725 fprintf(fp, " --clock-gmt Print and parse timestamps in GMT time zone\n");
c42c79ea
PP
726 fprintf(fp, " (default: local time zone)\n");
727 fprintf(fp, " --clock-seconds Print the timestamps as [SEC.NS]\n");
728 fprintf(fp, " (default format: [HH:MM:SS.NS])\n");
729 fprintf(fp, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
6d1d5711 730 fprintf(fp, " (default: `/usr/lib/debug`)\n");
c42c79ea
PP
731 fprintf(fp, " --debug-info-full-path Show full debug info source and binary paths\n");
732 fprintf(fp, " --debug-info-target-prefix=DIR Use directory DIR as a prefix when looking\n");
733 fprintf(fp, " up executables during debug info analysis\n");
6d1d5711 734 fprintf(fp, " (default: `/usr/lib/debug`)\n");
c42c79ea
PP
735 fprintf(fp, " -f, --fields=NAME[,NAME]... Print additional fields:\n");
736 fprintf(fp, " all, trace, trace:hostname, trace:domain,\n");
d9b99e4e 737 fprintf(fp, " trace:procname, trace:vpid, loglevel, emf\n");
c42c79ea
PP
738 fprintf(fp, " (default: trace:hostname, trace:procname,\n");
739 fprintf(fp, " trace:vpid)\n");
740 fprintf(fp, " -n, --names=NAME[,NAME]... Print field names:\n");
741 fprintf(fp, " payload (or arg or args)\n");
742 fprintf(fp, " none, all, scope, header, context (or ctx)\n");
743 fprintf(fp, " (default: payload, context)\n");
744 fprintf(fp, " --no-delta Do not print time delta between consecutive\n");
745 fprintf(fp, " events\n");
746 fprintf(fp, " -w, --output=PATH Write output to PATH (default: standard output)\n");
747}
748
749/*
750 * Prints the Babeltrace 2.x usage.
751 */
752static
753void print_usage(FILE *fp)
754{
755 fprintf(fp, "Usage: babeltrace [OPTIONS]\n");
756 fprintf(fp, "\n");
b07ffa28
PP
757 fprintf(fp, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
758 fprintf(fp, " of the following source and sink component\n");
759 fprintf(fp, " instances (see the exact format of PARAMS\n");
760 fprintf(fp, " below)\n");
c42c79ea
PP
761 fprintf(fp, " -d, --debug Enable debug mode\n");
762 fprintf(fp, " -l, --list List available plugins and their components\n");
ad6a19bd
PP
763 fprintf(fp, " -P, --path=PATH Set the `path` parameter of the latest source\n");
764 fprintf(fp, " or sink component to PATH\n");
bdc61c70 765 fprintf(fp, " -p, --params=PARAMS Set the parameters of the latest source or\n");
b07ffa28
PP
766 fprintf(fp, " sink component instance (in command-line \n");
767 fprintf(fp, " order) to PARAMS (see the exact format of\n");
768 fprintf(fp, " PARAMS below)\n");
ad6a19bd 769 fprintf(fp, " --plugin-path=PATH[:PATH]... Set paths from which dynamic plugins can be\n");
015cee23 770 fprintf(fp, " loaded to PATH\n");
b07ffa28
PP
771 fprintf(fp, " -r, --reset-base-params Reset the current base parameters of the\n");
772 fprintf(fp, " following source and sink component\n");
773 fprintf(fp, " instances to an empty map\n");
015cee23
PP
774 fprintf(fp, " -o, --sink=PLUGIN.COMPCLS Instantiate a sink component from plugin\n");
775 fprintf(fp, " PLUGIN and component class COMPCLS (may be\n");
776 fprintf(fp, " repeated)\n");
777 fprintf(fp, " -i, --source=PLUGIN.COMPCLS Instantiate a source component from plugin\n");
778 fprintf(fp, " PLUGIN and component class COMPCLS (may be\n");
779 fprintf(fp, " repeated)\n");
bdc61c70
PP
780 fprintf(fp, " -h --help Show this help\n");
781 fprintf(fp, " --help-legacy Show Babeltrace 1.x legacy options\n");
c42c79ea
PP
782 fprintf(fp, " -v, --verbose Enable verbose output\n");
783 fprintf(fp, " -V, --version Show version\n");
bdc61c70 784 fprintf(fp, "\n\n");
b07ffa28
PP
785 fprintf(fp, "Format of PARAMS\n");
786 fprintf(fp, "----------------\n");
c42c79ea 787 fprintf(fp, "\n");
bdc61c70 788 fprintf(fp, " PARAM=VALUE[,PARAM=VALUE]...\n");
c42c79ea 789 fprintf(fp, "\n");
bdc61c70
PP
790 fprintf(fp, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
791 fprintf(fp, "where PARAM is the parameter name (C identifier plus [:.-] characters), and\n");
792 fprintf(fp, "VALUE can be one of:\n");
c42c79ea 793 fprintf(fp, "\n");
bdc61c70
PP
794 fprintf(fp, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
795 fprintf(fp, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
796 fprintf(fp, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
797 fprintf(fp, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
798 fprintf(fp, " (`0x` prefix) signed 64-bit integer.\n");
799 fprintf(fp, "* Double precision floating point number (scientific notation is accepted).\n");
800 fprintf(fp, "* Unquoted string with no special characters, and not matching any of\n");
801 fprintf(fp, " the null and boolean value symbols above.\n");
802 fprintf(fp, "* Double-quoted string (accepts escape characters).\n");
c42c79ea 803 fprintf(fp, "\n");
bdc61c70 804 fprintf(fp, "Whitespaces are allowed around individual `=` and `,` tokens.\n");
c42c79ea 805 fprintf(fp, "\n");
bdc61c70 806 fprintf(fp, "Example:\n");
c42c79ea 807 fprintf(fp, "\n");
bdc61c70
PP
808 fprintf(fp, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
809 fprintf(fp, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
810 fprintf(fp, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
c42c79ea 811 fprintf(fp, "\n");
bdc61c70
PP
812 fprintf(fp, "IMPORTANT: Make sure to single-quote the whole argument when you run babeltrace\n");
813 fprintf(fp, "from a shell.\n");
c42c79ea
PP
814}
815
816/*
817 * Destroys a component configuration.
818 */
819static
820void bt_config_component_destroy(struct bt_object *obj)
821{
822 struct bt_config_component *bt_config_component =
823 container_of(obj, struct bt_config_component, base);
824
825 if (!obj) {
826 goto end;
827 }
828
829 if (bt_config_component->plugin_name) {
830 g_string_free(bt_config_component->plugin_name, TRUE);
831 }
832
833 if (bt_config_component->component_name) {
834 g_string_free(bt_config_component->component_name, TRUE);
835 }
836
837 BT_PUT(bt_config_component->params);
838 g_free(bt_config_component);
839
840end:
841 return;
842}
843
844/*
bdc61c70
PP
845 * Creates a component configuration using the given plugin name and
846 * component name. plugin_name and component_name are copied (belong to
847 * the return value).
c42c79ea
PP
848 *
849 * Return value is owned by the caller.
850 */
851static
852struct bt_config_component *bt_config_component_create(const char *plugin_name,
bdc61c70 853 const char *component_name)
c42c79ea
PP
854{
855 struct bt_config_component *cfg_component = NULL;
856
857 cfg_component = g_new0(struct bt_config_component, 1);
858 if (!cfg_component) {
859 print_err_oom();
860 goto error;
861 }
862
863 bt_object_init(cfg_component, bt_config_component_destroy);
864 cfg_component->plugin_name = g_string_new(plugin_name);
865 if (!cfg_component->plugin_name) {
866 print_err_oom();
867 goto error;
868 }
869
870 cfg_component->component_name = g_string_new(component_name);
871 if (!cfg_component->component_name) {
872 print_err_oom();
873 goto error;
874 }
875
bdc61c70
PP
876 /* Start with empty parameters */
877 cfg_component->params = bt_value_map_create();
878 if (!cfg_component->params) {
879 print_err_oom();
880 goto error;
881 }
882
c42c79ea
PP
883 goto end;
884
885error:
886 BT_PUT(cfg_component);
887
888end:
889 return cfg_component;
890}
891
892/*
893 * Creates a component configuration from a command-line source/sink
bdc61c70 894 * option's argument.
c42c79ea
PP
895 */
896static
897struct bt_config_component *bt_config_component_from_arg(const char *arg)
898{
899 struct bt_config_component *bt_config_component = NULL;
900 char *plugin_name;
901 char *component_name;
c42c79ea
PP
902
903 plugin_component_names_from_arg(arg, &plugin_name, &component_name);
904 if (!plugin_name || !component_name) {
49849a47 905 printf_err("Cannot get plugin or component class name\n");
c42c79ea
PP
906 goto error;
907 }
908
c42c79ea 909 bt_config_component = bt_config_component_create(plugin_name,
bdc61c70 910 component_name);
c42c79ea
PP
911 if (!bt_config_component) {
912 goto error;
913 }
914
915 goto end;
916
917error:
918 BT_PUT(bt_config_component);
919
920end:
bdc61c70
PP
921 g_free(plugin_name);
922 g_free(component_name);
c42c79ea
PP
923 return bt_config_component;
924}
925
926/*
927 * Destroys a configuration.
928 */
929static
930void bt_config_destroy(struct bt_object *obj)
931{
932 struct bt_config *bt_config =
933 container_of(obj, struct bt_config, base);
934
935 if (!obj) {
936 goto end;
937 }
938
939 if (bt_config->sources) {
940 g_ptr_array_free(bt_config->sources, TRUE);
941 }
942
943 if (bt_config->sinks) {
944 g_ptr_array_free(bt_config->sinks, TRUE);
945 }
946
947 BT_PUT(bt_config->plugin_paths);
948 g_free(bt_config);
949
950end:
951 return;
952}
953
954/*
955 * Extracts the various paths from the string arg, delimited by ':',
956 * and converts them to an array value object.
957 *
958 * Returned array value object is empty if arg is empty.
959 *
960 * Return value is owned by the caller.
961 */
962static
963struct bt_value *plugin_paths_from_arg(const char *arg)
964{
965 struct bt_value *plugin_paths;
966 const char *at = arg;
967 const char *end = arg + strlen(arg);
968
969 plugin_paths = bt_value_array_create();
970 if (!plugin_paths) {
971 print_err_oom();
972 goto error;
973 }
974
975 while (at < end) {
976 int ret;
977 GString *path;
978 const char *next_colon;
979
980 next_colon = strchr(at, ':');
981 if (next_colon == at) {
982 /*
983 * Empty path: try next character (supported
984 * to conform to the typical parsing of $PATH).
985 */
986 at++;
987 continue;
988 } else if (!next_colon) {
989 /* No more colon: use the remaining */
990 next_colon = arg + strlen(arg);
991 }
992
993 path = g_string_new(NULL);
994 if (!path) {
995 print_err_oom();
996 goto error;
997 }
998
999 g_string_append_len(path, at, next_colon - at);
1000 at = next_colon + 1;
1001 ret = bt_value_array_append_string(plugin_paths, path->str);
1002 g_string_free(path, TRUE);
1003 if (ret) {
1004 print_err_oom();
1005 goto error;
1006 }
1007 }
1008
1009 goto end;
1010
1011error:
1012 BT_PUT(plugin_paths);
1013
1014end:
1015 return plugin_paths;
1016}
1017
1018/*
1019 * Creates a simple lexical scanner for parsing comma-delimited names
1020 * and fields.
1021 *
1022 * Return value is owned by the caller.
1023 */
1024static
1025GScanner *create_csv_identifiers_scanner(void)
1026{
1027 GScannerConfig scanner_config = {
1028 .cset_skip_characters = " \t\n",
1029 .cset_identifier_first = G_CSET_a_2_z G_CSET_A_2_Z "_",
1030 .cset_identifier_nth = G_CSET_a_2_z G_CSET_A_2_Z ":_-",
1031 .case_sensitive = TRUE,
1032 .cpair_comment_single = NULL,
1033 .skip_comment_multi = TRUE,
1034 .skip_comment_single = TRUE,
1035 .scan_comment_multi = FALSE,
1036 .scan_identifier = TRUE,
1037 .scan_identifier_1char = TRUE,
1038 .scan_identifier_NULL = FALSE,
1039 .scan_symbols = FALSE,
1040 .symbol_2_token = FALSE,
1041 .scope_0_fallback = FALSE,
1042 .scan_binary = FALSE,
1043 .scan_octal = FALSE,
1044 .scan_float = FALSE,
1045 .scan_hex = FALSE,
1046 .scan_hex_dollar = FALSE,
1047 .numbers_2_int = FALSE,
1048 .int_2_float = FALSE,
1049 .store_int64 = FALSE,
1050 .scan_string_sq = FALSE,
1051 .scan_string_dq = FALSE,
1052 .identifier_2_string = FALSE,
1053 .char_2_token = TRUE,
1054 };
1055
1056 return g_scanner_new(&scanner_config);
1057}
1058
6e1bc0df
MD
1059/*
1060 * Inserts a string (if exists and not empty) or null to a map value
1061 * object.
1062 */
1063static
1064enum bt_value_status map_insert_string_or_null(struct bt_value *map,
1065 const char *key, GString *string)
1066{
1067 enum bt_value_status ret;
1068
1069 if (string && string->len > 0) {
1070 ret = bt_value_map_insert_string(map, key, string->str);
1071 } else {
1072 ret = bt_value_map_insert(map, key, bt_value_null);
1073 }
1074 return ret;
1075}
1076
c42c79ea
PP
1077/*
1078 * Converts a comma-delimited list of known names (--names option) to
1079 * an array value object containing those names as string value objects.
1080 *
1081 * Return value is owned by the caller.
1082 */
1083static
1084struct bt_value *names_from_arg(const char *arg)
1085{
1086 GScanner *scanner = NULL;
1087 struct bt_value *names = NULL;
6e1bc0df 1088 bool found_all = false, found_none = false, found_item = false;
c42c79ea
PP
1089
1090 names = bt_value_array_create();
1091 if (!names) {
1092 print_err_oom();
1093 goto error;
1094 }
1095
1096 scanner = create_csv_identifiers_scanner();
1097 if (!scanner) {
1098 print_err_oom();
1099 goto error;
1100 }
1101
1102 g_scanner_input_text(scanner, arg, strlen(arg));
1103
1104 while (true) {
1105 GTokenType token_type = g_scanner_get_next_token(scanner);
1106
1107 switch (token_type) {
1108 case G_TOKEN_IDENTIFIER:
1109 {
1110 const char *identifier = scanner->value.v_identifier;
1111
1112 if (!strcmp(identifier, "payload") ||
1113 !strcmp(identifier, "args") ||
1114 !strcmp(identifier, "arg")) {
6e1bc0df 1115 found_item = true;
c42c79ea
PP
1116 if (bt_value_array_append_string(names,
1117 "payload")) {
1118 goto error;
1119 }
1120 } else if (!strcmp(identifier, "context") ||
1121 !strcmp(identifier, "ctx")) {
6e1bc0df 1122 found_item = true;
c42c79ea
PP
1123 if (bt_value_array_append_string(names,
1124 "context")) {
1125 goto error;
1126 }
1127 } else if (!strcmp(identifier, "scope") ||
1128 !strcmp(identifier, "header")) {
6e1bc0df 1129 found_item = true;
c42c79ea
PP
1130 if (bt_value_array_append_string(names,
1131 identifier)) {
1132 goto error;
1133 }
6e1bc0df
MD
1134 } else if (!strcmp(identifier, "all")) {
1135 found_all = true;
1136 if (bt_value_array_append_string(names,
1137 identifier)) {
c42c79ea
PP
1138 goto error;
1139 }
6e1bc0df
MD
1140 } else if (!strcmp(identifier, "none")) {
1141 found_none = true;
c42c79ea
PP
1142 if (bt_value_array_append_string(names,
1143 identifier)) {
1144 goto error;
1145 }
c42c79ea 1146 } else {
6d1d5711 1147 printf_err("Unknown field name: `%s`\n",
c42c79ea
PP
1148 identifier);
1149 goto error;
1150 }
1151 break;
1152 }
1153 case G_TOKEN_COMMA:
1154 continue;
1155 case G_TOKEN_EOF:
1156 goto end;
1157 default:
1158 goto error;
1159 }
1160 }
1161
6e1bc0df
MD
1162end:
1163 if (found_none && found_all) {
6d1d5711 1164 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
6e1bc0df
MD
1165 goto error;
1166 }
1167 /*
1168 * Legacy behavior is to clear the defaults (show none) when at
1169 * least one item is specified.
1170 */
1171 if (found_item && !found_none && !found_all) {
1172 if (bt_value_array_append_string(names, "none")) {
1173 goto error;
1174 }
1175 }
1176 if (scanner) {
1177 g_scanner_destroy(scanner);
1178 }
1179 return names;
c42c79ea
PP
1180
1181error:
1182 BT_PUT(names);
c42c79ea
PP
1183 if (scanner) {
1184 g_scanner_destroy(scanner);
1185 }
1186 return names;
1187}
1188
1189
1190/*
1191 * Converts a comma-delimited list of known fields (--fields option) to
1192 * an array value object containing those fields as string
1193 * value objects.
1194 *
1195 * Return value is owned by the caller.
1196 */
1197static
1198struct bt_value *fields_from_arg(const char *arg)
1199{
1200 GScanner *scanner = NULL;
1201 struct bt_value *fields;
1202
1203 fields = bt_value_array_create();
1204 if (!fields) {
1205 print_err_oom();
1206 goto error;
1207 }
1208
1209 scanner = create_csv_identifiers_scanner();
1210 if (!scanner) {
1211 print_err_oom();
1212 goto error;
1213 }
1214
1215 g_scanner_input_text(scanner, arg, strlen(arg));
1216
1217 while (true) {
1218 GTokenType token_type = g_scanner_get_next_token(scanner);
1219
1220 switch (token_type) {
1221 case G_TOKEN_IDENTIFIER:
1222 {
1223 const char *identifier = scanner->value.v_identifier;
1224
1225 if (!strcmp(identifier, "trace") ||
1226 !strcmp(identifier, "trace:hostname") ||
1227 !strcmp(identifier, "trace:domain") ||
1228 !strcmp(identifier, "trace:procname") ||
1229 !strcmp(identifier, "trace:vpid") ||
1230 !strcmp(identifier, "loglevel") ||
1231 !strcmp(identifier, "emf") ||
6e1bc0df
MD
1232 !strcmp(identifier, "callsite") ||
1233 !strcmp(identifier, "all")) {
c42c79ea
PP
1234 if (bt_value_array_append_string(fields,
1235 identifier)) {
1236 goto error;
1237 }
c42c79ea 1238 } else {
6d1d5711 1239 printf_err("Unknown field name: `%s`\n",
c42c79ea
PP
1240 identifier);
1241 goto error;
1242 }
1243 break;
1244 }
1245 case G_TOKEN_COMMA:
1246 continue;
1247 case G_TOKEN_EOF:
1248 goto end;
1249 default:
1250 goto error;
1251 }
1252 }
1253
1254 goto end;
1255
1256error:
1257 BT_PUT(fields);
1258
1259end:
1260 if (scanner) {
1261 g_scanner_destroy(scanner);
1262 }
1263 return fields;
1264}
1265
1266/*
1267 * Inserts the equivalent "prefix-name" true boolean value objects into
1268 * map_obj where the names are in array_obj.
1269 */
1270static
1271int insert_flat_names_fields_from_array(struct bt_value *map_obj,
1272 struct bt_value *array_obj, const char *prefix)
1273{
1274 int ret = 0;
1275 int i;
6e1bc0df 1276 GString *tmpstr = NULL, *default_value = NULL;
c42c79ea
PP
1277
1278 /*
1279 * array_obj may be NULL if no CLI options were specified to
1280 * trigger its creation.
1281 */
1282 if (!array_obj) {
1283 goto end;
1284 }
1285
1286 tmpstr = g_string_new(NULL);
1287 if (!tmpstr) {
1288 print_err_oom();
1289 ret = -1;
1290 goto end;
1291 }
1292
6e1bc0df
MD
1293 default_value = g_string_new(NULL);
1294 if (!default_value) {
1295 print_err_oom();
1296 ret = -1;
1297 goto end;
1298 }
1299
c42c79ea
PP
1300 for (i = 0; i < bt_value_array_size(array_obj); i++) {
1301 struct bt_value *str_obj = bt_value_array_get(array_obj, i);
1302 const char *suffix;
6e1bc0df 1303 bool is_default = false;
c42c79ea
PP
1304
1305 if (!str_obj) {
1306 printf_err("Unexpected error\n");
1307 ret = -1;
1308 goto end;
1309 }
1310
1311 ret = bt_value_string_get(str_obj, &suffix);
1312 BT_PUT(str_obj);
1313 if (ret) {
1314 printf_err("Unexpected error\n");
1315 goto end;
1316 }
1317
1318 g_string_assign(tmpstr, prefix);
1319 g_string_append(tmpstr, "-");
6e1bc0df
MD
1320
1321 /* Special-case for "all" and "none". */
1322 if (!strcmp(suffix, "all")) {
1323 is_default = true;
1324 g_string_assign(default_value, "show");
1325 } else if (!strcmp(suffix, "none")) {
1326 is_default = true;
1327 g_string_assign(default_value, "hide");
1328 }
1329 if (is_default) {
1330 g_string_append(tmpstr, "default");
1331 ret = map_insert_string_or_null(map_obj,
1332 tmpstr->str,
1333 default_value);
1334 if (ret) {
1335 print_err_oom();
1336 goto end;
1337 }
1338 } else {
1339 g_string_append(tmpstr, suffix);
1340 ret = bt_value_map_insert_bool(map_obj, tmpstr->str,
1341 true);
1342 if (ret) {
1343 print_err_oom();
1344 goto end;
1345 }
c42c79ea
PP
1346 }
1347 }
1348
1349end:
6e1bc0df
MD
1350 if (default_value) {
1351 g_string_free(default_value, TRUE);
1352 }
c42c79ea
PP
1353 if (tmpstr) {
1354 g_string_free(tmpstr, TRUE);
1355 }
1356
1357 return ret;
1358}
1359
c42c79ea
PP
1360/*
1361 * Returns the parameters (map value object) corresponding to the
1362 * legacy text format options.
1363 *
1364 * Return value is owned by the caller.
1365 */
1366static
1367struct bt_value *params_from_text_legacy_opts(
1368 struct text_legacy_opts *text_legacy_opts)
1369{
1370 struct bt_value *params;
1371
1372 params = bt_value_map_create();
1373 if (!params) {
1374 print_err_oom();
1375 goto error;
1376 }
1377
1378 if (map_insert_string_or_null(params, "output-path",
1379 text_legacy_opts->output)) {
1380 print_err_oom();
1381 goto error;
1382 }
1383
1384 if (map_insert_string_or_null(params, "debug-info-dir",
1385 text_legacy_opts->dbg_info_dir)) {
1386 print_err_oom();
1387 goto error;
1388 }
1389
1390 if (map_insert_string_or_null(params, "debug-info-target-prefix",
1391 text_legacy_opts->dbg_info_target_prefix)) {
1392 print_err_oom();
1393 goto error;
1394 }
1395
1396 if (bt_value_map_insert_bool(params, "debug-info-full-path",
1397 text_legacy_opts->dbg_info_full_path)) {
1398 print_err_oom();
1399 goto error;
1400 }
1401
1402 if (bt_value_map_insert_bool(params, "no-delta",
1403 text_legacy_opts->no_delta)) {
1404 print_err_oom();
1405 goto error;
1406 }
1407
1408 if (bt_value_map_insert_bool(params, "clock-cycles",
1409 text_legacy_opts->clock_cycles)) {
1410 print_err_oom();
1411 goto error;
1412 }
1413
1414 if (bt_value_map_insert_bool(params, "clock-seconds",
1415 text_legacy_opts->clock_seconds)) {
1416 print_err_oom();
1417 goto error;
1418 }
1419
1420 if (bt_value_map_insert_bool(params, "clock-date",
1421 text_legacy_opts->clock_date)) {
1422 print_err_oom();
1423 goto error;
1424 }
1425
1426 if (bt_value_map_insert_bool(params, "clock-gmt",
1427 text_legacy_opts->clock_gmt)) {
1428 print_err_oom();
1429 goto error;
1430 }
1431
1432 if (insert_flat_names_fields_from_array(params,
1433 text_legacy_opts->names, "name")) {
1434 goto error;
1435 }
1436
1437 if (insert_flat_names_fields_from_array(params,
1438 text_legacy_opts->fields, "field")) {
1439 goto error;
1440 }
1441
1442 goto end;
1443
1444error:
1445 BT_PUT(params);
1446
1447end:
1448 return params;
1449}
1450
1451static
1452int append_sinks_from_legacy_opts(GPtrArray *sinks,
1453 enum legacy_output_format legacy_output_format,
1454 struct text_legacy_opts *text_legacy_opts)
1455{
1456 int ret = 0;
1457 struct bt_value *params = NULL;
1458 const char *plugin_name;
1459 const char *component_name;
1460 struct bt_config_component *bt_config_component = NULL;
1461
1462 switch (legacy_output_format) {
1463 case LEGACY_OUTPUT_FORMAT_TEXT:
1464 plugin_name = "text";
1465 component_name = "text";
1466 break;
1467 case LEGACY_OUTPUT_FORMAT_CTF_METADATA:
1468 plugin_name = "ctf";
1469 component_name = "metadata-text";
1470 break;
1471 case LEGACY_OUTPUT_FORMAT_DUMMY:
1472 plugin_name = "dummy";
1473 component_name = "dummy";
1474 break;
1475 default:
1476 assert(false);
1477 break;
1478 }
1479
1480 if (legacy_output_format == LEGACY_OUTPUT_FORMAT_TEXT) {
1481 /* Legacy "text" output format has parameters */
1482 params = params_from_text_legacy_opts(text_legacy_opts);
1483 if (!params) {
1484 goto error;
1485 }
1486 } else {
1487 /*
1488 * Legacy "dummy" and "ctf-metadata" output formats do
1489 * not have parameters.
1490 */
1491 params = bt_value_map_create();
1492 if (!params) {
1493 print_err_oom();
1494 goto error;
1495 }
1496 }
1497
1498 /* Create a component configuration */
1499 bt_config_component = bt_config_component_create(plugin_name,
bdc61c70 1500 component_name);
c42c79ea
PP
1501 if (!bt_config_component) {
1502 goto error;
1503 }
1504
bdc61c70
PP
1505 BT_MOVE(bt_config_component->params, params);
1506
c42c79ea
PP
1507 /* Move created component configuration to the array */
1508 g_ptr_array_add(sinks, bt_config_component);
1509
1510 goto end;
1511
1512error:
1513 ret = -1;
1514
1515end:
1516 BT_PUT(params);
1517
1518 return ret;
1519}
1520
1521/*
1522 * Returns the parameters (map value object) corresponding to the
1523 * given legacy CTF format options.
1524 *
1525 * Return value is owned by the caller.
1526 */
1527static
1528struct bt_value *params_from_ctf_legacy_opts(
1529 struct ctf_legacy_opts *ctf_legacy_opts)
1530{
1531 struct bt_value *params;
1532
1533 params = bt_value_map_create();
1534 if (!params) {
1535 print_err_oom();
1536 goto error;
1537 }
1538
1539 if (bt_value_map_insert_integer(params, "offset-s",
1540 ctf_legacy_opts->offset_s.value)) {
1541 print_err_oom();
1542 goto error;
1543 }
1544
1545 if (bt_value_map_insert_integer(params, "offset-ns",
1546 ctf_legacy_opts->offset_ns.value)) {
1547 print_err_oom();
1548 goto error;
1549 }
1550
1551 if (bt_value_map_insert_bool(params, "stream-intersection",
1552 ctf_legacy_opts->stream_intersection)) {
1553 print_err_oom();
1554 goto error;
1555 }
1556
1557 goto end;
1558
1559error:
1560 BT_PUT(params);
1561
1562end:
1563 return params;
1564}
1565
1566static
1567int append_sources_from_legacy_opts(GPtrArray *sources,
1568 enum legacy_input_format legacy_input_format,
1569 struct ctf_legacy_opts *ctf_legacy_opts,
528debdf 1570 struct bt_value *legacy_input_paths)
c42c79ea
PP
1571{
1572 int ret = 0;
1573 int i;
1574 struct bt_value *base_params;
1575 struct bt_value *params = NULL;
1576 struct bt_value *input_path = NULL;
1577 struct bt_value *input_path_copy = NULL;
1578 const char *input_key;
1579 const char *component_name;
1580
1581 switch (legacy_input_format) {
1582 case LEGACY_INPUT_FORMAT_CTF:
1583 input_key = "path";
1584 component_name = "fs";
1585 break;
1586 case LEGACY_INPUT_FORMAT_LTTNG_LIVE:
1587 input_key = "url";
1588 component_name = "lttng-live";
1589 break;
1590 default:
1591 assert(false);
1592 break;
1593 }
1594
1595 base_params = params_from_ctf_legacy_opts(ctf_legacy_opts);
1596 if (!base_params) {
1597 goto error;
1598 }
1599
1600 for (i = 0; i < bt_value_array_size(legacy_input_paths); i++) {
1601 struct bt_config_component *bt_config_component = NULL;
1602
1603 /* Copy base parameters as current parameters */
1604 params = bt_value_copy(base_params);
1605 if (!params) {
1606 goto error;
1607 }
1608
1609 /* Get current input path string value object */
1610 input_path = bt_value_array_get(legacy_input_paths, i);
1611 if (!input_path) {
1612 goto error;
1613 }
1614
1615 /* Copy current input path value object */
1616 input_path_copy = bt_value_copy(input_path);
1617 if (!input_path_copy) {
1618 goto error;
1619 }
1620
1621 /* Insert input path value object into current parameters */
1622 ret = bt_value_map_insert(params, input_key, input_path_copy);
1623 if (ret) {
1624 goto error;
1625 }
1626
1627 /* Create a component configuration */
1628 bt_config_component = bt_config_component_create("ctf",
bdc61c70 1629 component_name);
c42c79ea
PP
1630 if (!bt_config_component) {
1631 goto error;
1632 }
1633
bdc61c70
PP
1634 BT_MOVE(bt_config_component->params, params);
1635
c42c79ea
PP
1636 /* Move created component configuration to the array */
1637 g_ptr_array_add(sources, bt_config_component);
1638
1639 /* Put current stuff */
1640 BT_PUT(input_path);
1641 BT_PUT(input_path_copy);
c42c79ea
PP
1642 }
1643
1644 goto end;
1645
1646error:
1647 ret = -1;
1648
1649end:
1650 BT_PUT(base_params);
1651 BT_PUT(params);
1652 BT_PUT(input_path);
1653 BT_PUT(input_path_copy);
1654 return ret;
1655}
1656
1657/*
1658 * Escapes a string for the shell. The string is escaped knowing that
1659 * it's a parameter string value (double-quoted), and that it will be
1660 * entered between single quotes in the shell.
1661 *
1662 * Return value is owned by the caller.
1663 */
1664static
1665char *str_shell_escape(const char *input)
1666{
1667 char *ret = NULL;
1668 const char *at = input;
1669 GString *str = g_string_new(NULL);
1670
1671 if (!str) {
1672 goto end;
1673 }
1674
1675 while (*at != '\0') {
1676 switch (*at) {
1677 case '\\':
1678 g_string_append(str, "\\\\");
1679 break;
1680 case '"':
1681 g_string_append(str, "\\\"");
1682 break;
1683 case '\'':
1684 g_string_append(str, "'\"'\"'");
1685 break;
1686 case '\n':
1687 g_string_append(str, "\\n");
1688 break;
1689 case '\t':
1690 g_string_append(str, "\\t");
1691 break;
1692 default:
1693 g_string_append_c(str, *at);
1694 break;
1695 }
1696
1697 at++;
1698 }
1699
1700end:
1701 if (str) {
1702 ret = str->str;
1703 g_string_free(str, FALSE);
1704 }
1705
1706 return ret;
1707}
1708
1709static
1710int append_prefixed_flag_params(GString *str, struct bt_value *flags,
1711 const char *prefix)
1712{
1713 int ret = 0;
1714 int i;
1715
1716 if (!flags) {
1717 goto end;
1718 }
1719
1720 for (i = 0; i < bt_value_array_size(flags); i++) {
1721 struct bt_value *value = bt_value_array_get(flags, i);
1722 const char *flag;
1723
1724 if (!value) {
1725 ret = -1;
1726 goto end;
1727 }
1728
1729 if (bt_value_string_get(value, &flag)) {
1730 BT_PUT(value);
1731 ret = -1;
1732 goto end;
1733 }
1734
1735 g_string_append_printf(str, ",%s-%s=true", prefix, flag);
1736 BT_PUT(value);
1737 }
1738
1739end:
1740 return ret;
1741}
1742
1743/*
1744 * Appends a boolean parameter string.
1745 */
1746static
1747void g_string_append_bool_param(GString *str, const char *name, bool value)
1748{
1749 g_string_append_printf(str, ",%s=%s", name, value ? "true" : "false");
1750}
1751
1752/*
1753 * Appends a path parameter string, or null if it's empty.
1754 */
1755static
1756int g_string_append_string_path_param(GString *str, const char *name,
1757 GString *path)
1758{
1759 int ret = 0;
1760
1761 if (path->len > 0) {
1762 char *escaped_path = str_shell_escape(path->str);
1763
1764 if (!escaped_path) {
1765 print_err_oom();
1766 goto error;
1767 }
1768
1769 g_string_append_printf(str, "%s=\"%s\"", name, escaped_path);
1770 free(escaped_path);
1771 } else {
1772 g_string_append_printf(str, "%s=null", name);
1773 }
1774
1775 goto end;
1776
1777error:
1778 ret = -1;
1779
1780end:
1781 return ret;
1782}
1783
1784/*
1785 * Prints the non-legacy sink options equivalent to the specified
1786 * legacy output format options.
1787 */
1788static
1789void print_output_legacy_to_sinks(
1790 enum legacy_output_format legacy_output_format,
1791 struct text_legacy_opts *text_legacy_opts)
1792{
1793 const char *input_format;
1794 GString *str = NULL;
1795
1796 str = g_string_new(" ");
1797 if (!str) {
1798 print_err_oom();
1799 goto end;
1800 }
1801
1802 switch (legacy_output_format) {
1803 case LEGACY_OUTPUT_FORMAT_TEXT:
1804 input_format = "text";
1805 break;
1806 case LEGACY_OUTPUT_FORMAT_CTF_METADATA:
1807 input_format = "ctf-metadata";
1808 break;
1809 case LEGACY_OUTPUT_FORMAT_DUMMY:
1810 input_format = "dummy";
1811 break;
1812 default:
1813 assert(false);
1814 }
1815
49849a47 1816 printf_err("Both `%s` legacy output format and non-legacy sink component\ninstances(s) specified.\n\n",
c42c79ea 1817 input_format);
49849a47 1818 printf_err("Specify the following non-legacy sink component instance instead of the\nlegacy `%s` output format options:\n\n",
c42c79ea
PP
1819 input_format);
1820 g_string_append(str, "-o ");
1821
1822 switch (legacy_output_format) {
1823 case LEGACY_OUTPUT_FORMAT_TEXT:
1824 g_string_append(str, "text.text");
1825 break;
1826 case LEGACY_OUTPUT_FORMAT_CTF_METADATA:
1827 g_string_append(str, "ctf.metadata-text");
1828 break;
1829 case LEGACY_OUTPUT_FORMAT_DUMMY:
1830 g_string_append(str, "dummy.dummy");
1831 break;
1832 default:
1833 assert(false);
1834 }
1835
1836 if (legacy_output_format == LEGACY_OUTPUT_FORMAT_TEXT &&
1837 text_legacy_opts_is_any_set(text_legacy_opts)) {
1838 int ret;
1839
bdc61c70 1840 g_string_append(str, " -p '");
c42c79ea
PP
1841
1842 if (g_string_append_string_path_param(str, "output-path",
1843 text_legacy_opts->output)) {
1844 goto end;
1845 }
1846
1847 g_string_append(str, ",");
1848
1849 if (g_string_append_string_path_param(str, "debug-info-dir",
1850 text_legacy_opts->dbg_info_dir)) {
1851 goto end;
1852 }
1853
1854 g_string_append(str, ",");
1855
1856 if (g_string_append_string_path_param(str,
1857 "debug-info-target-prefix",
1858 text_legacy_opts->dbg_info_target_prefix)) {
1859 goto end;
1860 }
1861
1862 g_string_append_bool_param(str, "no-delta",
1863 text_legacy_opts->no_delta);
1864 g_string_append_bool_param(str, "clock-cycles",
1865 text_legacy_opts->clock_cycles);
1866 g_string_append_bool_param(str, "clock-seconds",
1867 text_legacy_opts->clock_seconds);
1868 g_string_append_bool_param(str, "clock-date",
1869 text_legacy_opts->clock_date);
1870 g_string_append_bool_param(str, "clock-gmt",
1871 text_legacy_opts->clock_gmt);
1872 ret = append_prefixed_flag_params(str, text_legacy_opts->names,
1873 "name");
1874 if (ret) {
1875 goto end;
1876 }
1877
1878 ret = append_prefixed_flag_params(str, text_legacy_opts->fields,
1879 "field");
1880 if (ret) {
1881 goto end;
1882 }
1883
1884 /* Remove last comma and close single quote */
1885 g_string_append(str, "'");
1886 }
1887
1888 printf_err("%s\n\n", str->str);
1889
1890end:
1891 if (str) {
1892 g_string_free(str, TRUE);
1893 }
1894 return;
1895}
1896
1897/*
1898 * Prints the non-legacy source options equivalent to the specified
1899 * legacy input format options.
1900 */
1901static
1902void print_input_legacy_to_sources(enum legacy_input_format legacy_input_format,
1903 struct bt_value *legacy_input_paths,
1904 struct ctf_legacy_opts *ctf_legacy_opts)
1905{
1906 const char *input_format;
1907 GString *str = NULL;
1908 int i;
1909
1910 str = g_string_new(" ");
1911 if (!str) {
1912 print_err_oom();
1913 goto end;
1914 }
1915
1916 switch (legacy_input_format) {
1917 case LEGACY_INPUT_FORMAT_CTF:
1918 input_format = "ctf";
1919 break;
1920 case LEGACY_INPUT_FORMAT_LTTNG_LIVE:
1921 input_format = "lttng-live";
1922 break;
1923 default:
1924 assert(false);
1925 }
1926
49849a47 1927 printf_err("Both `%s` legacy input format and non-legacy source component\ninstance(s) specified.\n\n",
c42c79ea 1928 input_format);
49849a47 1929 printf_err("Specify the following non-legacy source component instance(s) instead of the\nlegacy `%s` input format options and positional arguments:\n\n",
c42c79ea
PP
1930 input_format);
1931
1932 for (i = 0; i < bt_value_array_size(legacy_input_paths); i++) {
1933 struct bt_value *input_value =
1934 bt_value_array_get(legacy_input_paths, i);
1935 const char *input = NULL;
1936 char *escaped_input;
1937 int ret;
1938
1939 assert(input_value);
1940 ret = bt_value_string_get(input_value, &input);
1941 BT_PUT(input_value);
1942 assert(!ret && input);
1943 escaped_input = str_shell_escape(input);
1944 if (!escaped_input) {
1945 print_err_oom();
1946 goto end;
1947 }
1948
1949 g_string_append(str, "-i ctf.");
1950
1951 switch (legacy_input_format) {
1952 case LEGACY_INPUT_FORMAT_CTF:
bdc61c70 1953 g_string_append(str, "fs -p 'path=\"");
c42c79ea
PP
1954 break;
1955 case LEGACY_INPUT_FORMAT_LTTNG_LIVE:
bdc61c70 1956 g_string_append(str, "lttng-live -p 'url=\"");
c42c79ea
PP
1957 break;
1958 default:
1959 assert(false);
1960 }
1961
1962 g_string_append(str, escaped_input);
1963 g_string_append(str, "\"");
1964 g_string_append_printf(str, ",offset-s=%" PRId64,
1965 ctf_legacy_opts->offset_s.value);
1966 g_string_append_printf(str, ",offset-ns=%" PRId64,
1967 ctf_legacy_opts->offset_ns.value);
1968 g_string_append_bool_param(str, "stream-intersection",
1969 ctf_legacy_opts->stream_intersection);
1970 g_string_append(str, "' ");
1971 g_free(escaped_input);
1972 }
1973
1974 printf_err("%s\n\n", str->str);
1975
1976end:
1977 if (str) {
1978 g_string_free(str, TRUE);
1979 }
1980 return;
1981}
1982
1983/*
1984 * Validates a given configuration, with optional legacy input and
1985 * output formats options. Prints useful error messages if anything
1986 * is wrong.
1987 *
1988 * Returns true when the configuration is valid.
1989 */
1990static
1991bool validate_cfg(struct bt_config *cfg,
1992 enum legacy_input_format *legacy_input_format,
1993 enum legacy_output_format *legacy_output_format,
1994 struct bt_value *legacy_input_paths,
1995 struct ctf_legacy_opts *ctf_legacy_opts,
1996 struct text_legacy_opts *text_legacy_opts)
1997{
1998 bool legacy_input = false;
1999 bool legacy_output = false;
2000
2001 /* Determine if the input and output should be legacy-style */
2002 if (*legacy_input_format != LEGACY_INPUT_FORMAT_NONE ||
2003 cfg->sources->len == 0 ||
2004 !bt_value_array_is_empty(legacy_input_paths) ||
2005 ctf_legacy_opts_is_any_set(ctf_legacy_opts)) {
2006 legacy_input = true;
2007 }
2008
2009 if (*legacy_output_format != LEGACY_OUTPUT_FORMAT_NONE ||
2010 cfg->sinks->len == 0 ||
2011 text_legacy_opts_is_any_set(text_legacy_opts)) {
2012 legacy_output = true;
2013 }
2014
2015 if (legacy_input) {
2016 /* If no legacy input format was specified, default to CTF */
2017 if (*legacy_input_format == LEGACY_INPUT_FORMAT_NONE) {
2018 *legacy_input_format = LEGACY_INPUT_FORMAT_CTF;
2019 }
2020
2021 /* Make sure at least one input path exists */
2022 if (bt_value_array_is_empty(legacy_input_paths)) {
2023 switch (*legacy_input_format) {
2024 case LEGACY_INPUT_FORMAT_CTF:
6d1d5711 2025 printf_err("No input path specified for legacy `ctf` input format\n");
c42c79ea
PP
2026 break;
2027 case LEGACY_INPUT_FORMAT_LTTNG_LIVE:
6d1d5711 2028 printf_err("No URL specified for legacy `lttng-live` input format\n");
c42c79ea
PP
2029 break;
2030 default:
2031 assert(false);
2032 }
2033 goto error;
2034 }
2035
2036 /* Make sure no non-legacy sources are specified */
2037 if (cfg->sources->len != 0) {
2038 print_input_legacy_to_sources(*legacy_input_format,
2039 legacy_input_paths, ctf_legacy_opts);
2040 goto error;
2041 }
2042 }
2043
2044 if (legacy_output) {
2045 /*
2046 * If no legacy output format was specified, default to
2047 * "text".
2048 */
2049 if (*legacy_output_format == LEGACY_OUTPUT_FORMAT_NONE) {
2050 *legacy_output_format = LEGACY_OUTPUT_FORMAT_TEXT;
2051 }
2052
2053 /*
2054 * If any "text" option was specified, the output must be
2055 * legacy "text".
2056 */
2057 if (text_legacy_opts_is_any_set(text_legacy_opts) &&
2058 *legacy_output_format !=
2059 LEGACY_OUTPUT_FORMAT_TEXT) {
6d1d5711 2060 printf_err("Options for legacy `text` output format specified with a different legacy output format\n");
c42c79ea
PP
2061 goto error;
2062 }
2063
2064 /* Make sure no non-legacy sinks are specified */
2065 if (cfg->sinks->len != 0) {
2066 print_output_legacy_to_sinks(*legacy_output_format,
2067 text_legacy_opts);
2068 goto error;
2069 }
2070 }
2071
2072 /*
2073 * If the output is the legacy "ctf-metadata" format, then the
2074 * input should be the legacy "ctf" input format.
2075 */
2076 if (*legacy_output_format == LEGACY_OUTPUT_FORMAT_CTF_METADATA &&
2077 *legacy_input_format != LEGACY_INPUT_FORMAT_CTF) {
6d1d5711 2078 printf_err("Legacy `ctf-metadata` output format requires using legacy `ctf` input format\n");
c42c79ea
PP
2079 goto error;
2080 }
2081
2082 return true;
2083
2084error:
2085 return false;
2086}
2087
2088/*
2089 * Parses a 64-bit signed integer.
2090 *
2091 * Returns a negative value if anything goes wrong.
2092 */
2093static
2094int parse_int64(const char *arg, int64_t *val)
2095{
2096 char *endptr;
2097
2098 errno = 0;
2099 *val = strtoll(arg, &endptr, 0);
2100 if (*endptr != '\0' || arg == endptr || errno != 0) {
2101 return -1;
2102 }
2103
2104 return 0;
2105}
2106
2107/* popt options */
2108enum {
2109 OPT_NONE = 0,
b07ffa28 2110 OPT_BASE_PARAMS,
c42c79ea
PP
2111 OPT_CLOCK_CYCLES,
2112 OPT_CLOCK_DATE,
2113 OPT_CLOCK_FORCE_CORRELATE,
2114 OPT_CLOCK_GMT,
2115 OPT_CLOCK_OFFSET,
2116 OPT_CLOCK_OFFSET_NS,
2117 OPT_CLOCK_SECONDS,
2118 OPT_DEBUG,
2119 OPT_DEBUG_INFO_DIR,
2120 OPT_DEBUG_INFO_FULL_PATH,
2121 OPT_DEBUG_INFO_TARGET_PREFIX,
2122 OPT_FIELDS,
2123 OPT_HELP,
2124 OPT_HELP_LEGACY,
2125 OPT_INPUT_FORMAT,
2126 OPT_LIST,
2127 OPT_NAMES,
2128 OPT_NO_DELTA,
2129 OPT_OUTPUT_FORMAT,
2130 OPT_OUTPUT_PATH,
ad6a19bd 2131 OPT_PATH,
bdc61c70 2132 OPT_PARAMS,
c42c79ea 2133 OPT_PLUGIN_PATH,
b07ffa28 2134 OPT_RESET_BASE_PARAMS,
c42c79ea
PP
2135 OPT_SINK,
2136 OPT_SOURCE,
2137 OPT_STREAM_INTERSECTION,
2138 OPT_VERBOSE,
2139 OPT_VERSION,
2140};
2141
2142/* popt long option descriptions */
2143static struct poptOption long_options[] = {
2144 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
b07ffa28 2145 { "base-params", 'b', POPT_ARG_STRING, NULL, OPT_BASE_PARAMS, NULL, NULL },
c42c79ea
PP
2146 { "clock-cycles", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL },
2147 { "clock-date", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
2148 { "clock-force-correlate", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
2149 { "clock-gmt", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
2150 { "clock-offset", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
2151 { "clock-offset-ns", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL },
2152 { "clock-seconds", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
2153 { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
2154 { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL },
2155 { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL },
2156 { "debug-info-target-prefix", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_TARGET_PREFIX, NULL, NULL },
2157 { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
2158 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
2159 { "help-legacy", '\0', POPT_ARG_NONE, NULL, OPT_HELP_LEGACY, NULL, NULL },
2160 { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL },
2161 { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
2162 { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
2163 { "no-delta", '\0', POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
2164 { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT_PATH, NULL, NULL },
2165 { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL },
ad6a19bd 2166 { "path", 'P', POPT_ARG_STRING, NULL, OPT_PATH, NULL, NULL },
bdc61c70 2167 { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL },
ad6a19bd 2168 { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
b07ffa28 2169 { "reset-base-params", 'r', POPT_ARG_NONE, NULL, OPT_RESET_BASE_PARAMS, NULL, NULL },
c42c79ea
PP
2170 { "sink", '\0', POPT_ARG_STRING, NULL, OPT_SINK, NULL, NULL },
2171 { "source", '\0', POPT_ARG_STRING, NULL, OPT_SOURCE, NULL, NULL },
2172 { "stream-intersection", '\0', POPT_ARG_NONE, NULL, OPT_STREAM_INTERSECTION, NULL, NULL },
2173 { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
2174 { "version", 'V', POPT_ARG_NONE, NULL, OPT_VERSION, NULL, NULL },
2175 { NULL, 0, 0, NULL, 0, NULL, NULL },
2176};
2177
2178/*
2179 * Sets the value of a given legacy offset option and marks it as set.
2180 */
2181static void set_offset_value(struct offset_opt *offset_opt, int64_t value)
2182{
2183 offset_opt->value = value;
2184 offset_opt->is_set = true;
2185}
2186
bdc61c70
PP
2187enum bt_config_component_dest {
2188 BT_CONFIG_COMPONENT_DEST_SOURCE,
2189 BT_CONFIG_COMPONENT_DEST_SINK,
2190};
2191
2192/*
2193 * Adds a configuration component to the appropriate configuration
2194 * array depending on the destination.
2195 */
2196static void add_cfg_comp(struct bt_config *cfg,
2197 struct bt_config_component *cfg_comp,
2198 enum bt_config_component_dest dest)
2199{
2200 if (dest == BT_CONFIG_COMPONENT_DEST_SOURCE) {
2201 g_ptr_array_add(cfg->sources, cfg_comp);
2202 } else {
2203 g_ptr_array_add(cfg->sinks, cfg_comp);
2204 }
2205}
2206
c42c79ea
PP
2207/*
2208 * Returns a Babeltrace configuration, out of command-line arguments,
2209 * containing everything that is needed to instanciate specific
2210 * components with given parameters.
2211 *
2212 * *exit_code is set to the appropriate exit code to use as far as this
2213 * function goes.
2214 *
2215 * Return value is NULL on error, otherwise it's owned by the caller.
2216 */
528debdf 2217struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_code)
c42c79ea
PP
2218{
2219 struct bt_config *cfg = NULL;
2220 poptContext pc = NULL;
2221 char *arg = NULL;
b7726e32
MD
2222 struct ctf_legacy_opts ctf_legacy_opts;
2223 struct text_legacy_opts text_legacy_opts;
c42c79ea
PP
2224 enum legacy_input_format legacy_input_format = LEGACY_INPUT_FORMAT_NONE;
2225 enum legacy_output_format legacy_output_format =
2226 LEGACY_OUTPUT_FORMAT_NONE;
2227 struct bt_value *legacy_input_paths = NULL;
bdc61c70
PP
2228 struct bt_config_component *cur_cfg_comp = NULL;
2229 enum bt_config_component_dest cur_cfg_comp_dest =
2230 BT_CONFIG_COMPONENT_DEST_SOURCE;
b07ffa28 2231 struct bt_value *cur_base_params = NULL;
c42c79ea 2232 int opt;
bdc61c70 2233 bool cur_cfg_comp_params_set = false;
c42c79ea 2234
b7726e32
MD
2235 memset(&ctf_legacy_opts, 0, sizeof(ctf_legacy_opts));
2236 memset(&text_legacy_opts, 0, sizeof(text_legacy_opts));
c42c79ea
PP
2237 *exit_code = 0;
2238
2239 if (argc <= 1) {
2240 print_usage(stdout);
2241 goto end;
2242 }
2243
2244 text_legacy_opts.output = g_string_new(NULL);
2245 if (!text_legacy_opts.output) {
2246 print_err_oom();
2247 goto error;
2248 }
2249
2250 text_legacy_opts.dbg_info_dir = g_string_new(NULL);
2251 if (!text_legacy_opts.dbg_info_dir) {
2252 print_err_oom();
2253 goto error;
2254 }
2255
2256 text_legacy_opts.dbg_info_target_prefix = g_string_new(NULL);
2257 if (!text_legacy_opts.dbg_info_target_prefix) {
2258 print_err_oom();
2259 goto error;
2260 }
2261
b07ffa28
PP
2262 cur_base_params = bt_value_map_create();
2263 if (!cur_base_params) {
2264 print_err_oom();
2265 goto error;
2266 }
2267
c42c79ea
PP
2268 /* Create config */
2269 cfg = g_new0(struct bt_config, 1);
2270 if (!cfg) {
2271 print_err_oom();
2272 goto error;
2273 }
2274
2275 bt_object_init(cfg, bt_config_destroy);
2276 cfg->sources = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
2277 if (!cfg->sources) {
2278 print_err_oom();
2279 goto error;
2280 }
2281
2282 cfg->sinks = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
2283 if (!cfg->sinks) {
2284 print_err_oom();
2285 goto error;
2286 }
2287
2288 legacy_input_paths = bt_value_array_create();
2289 if (!legacy_input_paths) {
2290 print_err_oom();
2291 goto error;
2292 }
2293
2294 /* Parse options */
2295 pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
2296 if (!pc) {
2297 printf_err("Cannot get popt context\n");
2298 goto error;
2299 }
2300
2301 poptReadDefaultConfig(pc, 0);
2302
2303 while ((opt = poptGetNextOpt(pc)) > 0) {
2304 arg = poptGetOptArg(pc);
2305
2306 switch (opt) {
2307 case OPT_PLUGIN_PATH:
2308 if (cfg->plugin_paths) {
2309 printf_err("Duplicate --plugin-path option\n");
2310 goto error;
2311 }
2312
2313 cfg->plugin_paths = plugin_paths_from_arg(arg);
2314 if (!cfg->plugin_paths) {
2315 printf_err("Invalid --plugin-path option's argument\n");
2316 goto error;
2317 }
2318 break;
2319 case OPT_OUTPUT_PATH:
2320 if (text_legacy_opts.output->len > 0) {
2321 printf_err("Duplicate --output option\n");
2322 goto error;
2323 }
2324
2325 g_string_assign(text_legacy_opts.output, arg);
2326 break;
2327 case OPT_DEBUG_INFO_DIR:
2328 if (text_legacy_opts.dbg_info_dir->len > 0) {
2329 printf_err("Duplicate --debug-info-dir option\n");
2330 goto error;
2331 }
2332
2333 g_string_assign(text_legacy_opts.dbg_info_dir, arg);
2334 break;
2335 case OPT_DEBUG_INFO_TARGET_PREFIX:
2336 if (text_legacy_opts.dbg_info_target_prefix->len > 0) {
2337 printf_err("Duplicate --debug-info-target-prefix option\n");
2338 goto error;
2339 }
2340
2341 g_string_assign(text_legacy_opts.dbg_info_target_prefix, arg);
2342 break;
2343 case OPT_INPUT_FORMAT:
2344 case OPT_SOURCE:
2345 {
c42c79ea
PP
2346 if (opt == OPT_INPUT_FORMAT) {
2347 if (!strcmp(arg, "ctf")) {
2348 /* Legacy CTF input format */
2349 if (legacy_input_format) {
2350 print_err_dup_legacy_input();
2351 goto error;
2352 }
2353
2354 legacy_input_format =
2355 LEGACY_INPUT_FORMAT_CTF;
2356 break;
2357 } else if (!strcmp(arg, "lttng-live")) {
2358 /* Legacy LTTng-live input format */
2359 if (legacy_input_format) {
2360 print_err_dup_legacy_input();
2361 goto error;
2362 }
2363
2364 legacy_input_format =
2365 LEGACY_INPUT_FORMAT_LTTNG_LIVE;
2366 break;
2367 }
2368 }
2369
2370 /* Non-legacy: try to create a component config */
bdc61c70
PP
2371 if (cur_cfg_comp) {
2372 add_cfg_comp(cfg, cur_cfg_comp,
2373 cur_cfg_comp_dest);
2374 }
2375
2376 cur_cfg_comp = bt_config_component_from_arg(arg);
2377 if (!cur_cfg_comp) {
49849a47 2378 printf_err("Invalid format for --source option's argument:\n %s\n",
c42c79ea
PP
2379 arg);
2380 goto error;
2381 }
2382
b07ffa28
PP
2383 assert(cur_base_params);
2384 bt_put(cur_cfg_comp->params);
c9313318
PP
2385 cur_cfg_comp->params = bt_value_copy(cur_base_params);
2386 if (!cur_cfg_comp) {
2387 print_err_oom();
2388 goto end;
2389 }
2390
bdc61c70
PP
2391 cur_cfg_comp_dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
2392 cur_cfg_comp_params_set = false;
c42c79ea
PP
2393 break;
2394 }
2395 case OPT_OUTPUT_FORMAT:
2396 case OPT_SINK:
2397 {
c42c79ea
PP
2398 if (opt == OPT_OUTPUT_FORMAT) {
2399 if (!strcmp(arg, "text")) {
2400 /* Legacy CTF-text output format */
2401 if (legacy_output_format) {
2402 print_err_dup_legacy_output();
2403 goto error;
2404 }
2405
2406 legacy_output_format =
2407 LEGACY_OUTPUT_FORMAT_TEXT;
2408 break;
2409 } else if (!strcmp(arg, "dummy")) {
2410 /* Legacy dummy output format */
2411 if (legacy_output_format) {
2412 print_err_dup_legacy_output();
2413 goto error;
2414 }
2415
2416 legacy_output_format =
2417 LEGACY_OUTPUT_FORMAT_DUMMY;
2418 break;
2419 } else if (!strcmp(arg, "ctf-metadata")) {
2420 /* Legacy CTF-metadata output format */
2421 if (legacy_output_format) {
2422 print_err_dup_legacy_output();
2423 goto error;
2424 }
2425
2426 legacy_output_format =
2427 LEGACY_OUTPUT_FORMAT_CTF_METADATA;
2428 break;
2429 }
2430 }
2431
2432 /* Non-legacy: try to create a component config */
bdc61c70
PP
2433 if (cur_cfg_comp) {
2434 add_cfg_comp(cfg, cur_cfg_comp,
2435 cur_cfg_comp_dest);
2436 }
2437
2438 cur_cfg_comp = bt_config_component_from_arg(arg);
2439 if (!cur_cfg_comp) {
49849a47 2440 printf_err("Invalid format for --sink option's argument:\n %s\n",
c42c79ea
PP
2441 arg);
2442 goto error;
2443 }
2444
b07ffa28
PP
2445 assert(cur_base_params);
2446 bt_put(cur_cfg_comp->params);
c9313318
PP
2447 cur_cfg_comp->params = bt_value_copy(cur_base_params);
2448 if (!cur_cfg_comp) {
2449 print_err_oom();
2450 goto end;
2451 }
2452
bdc61c70
PP
2453 cur_cfg_comp_dest = BT_CONFIG_COMPONENT_DEST_SINK;
2454 cur_cfg_comp_params_set = false;
2455 break;
2456 }
2457 case OPT_PARAMS:
2458 {
2459 struct bt_value *params;
b07ffa28 2460 struct bt_value *params_to_set;
bdc61c70
PP
2461
2462 if (!cur_cfg_comp) {
2463 printf_err("--params option must follow a --source or --sink option\n");
2464 goto error;
2465 }
2466
2467 if (cur_cfg_comp_params_set) {
49849a47 2468 printf_err("Duplicate --params option for the same current component\ninstance (class %s.%s)\n",
bdc61c70
PP
2469 cur_cfg_comp->plugin_name->str,
2470 cur_cfg_comp->component_name->str);
2471 goto error;
2472 }
2473
2474 params = bt_value_from_arg(arg);
2475 if (!params) {
2476 printf_err("Invalid format for --params option's argument:\n %s\n",
2477 arg);
2478 goto error;
2479 }
2480
b07ffa28
PP
2481 params_to_set = bt_value_map_extend(cur_base_params,
2482 params);
2483 BT_PUT(params);
2484 if (!params_to_set) {
2485 printf_err("Cannot extend current base parameters with --params option's argument:\n %s\n",
2486 arg);
2487 goto error;
2488 }
2489
2490 BT_MOVE(cur_cfg_comp->params, params_to_set);
bdc61c70 2491 cur_cfg_comp_params_set = true;
c42c79ea
PP
2492 break;
2493 }
ad6a19bd
PP
2494 case OPT_PATH:
2495 if (!cur_cfg_comp) {
2496 printf_err("--path option must follow a --source or --sink option\n");
2497 goto error;
2498 }
2499
2500 assert(cur_cfg_comp->params);
2501
2502 if (bt_value_map_insert_string(cur_cfg_comp->params,
2503 "path", arg)) {
2504 print_err_oom();
2505 goto error;
2506 }
2507 break;
b07ffa28
PP
2508 case OPT_BASE_PARAMS:
2509 {
2510 struct bt_value *params = bt_value_from_arg(arg);
2511
2512 if (!params) {
2513 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2514 arg);
2515 goto error;
2516 }
2517
2518 BT_MOVE(cur_base_params, params);
2519 break;
2520 }
2521 case OPT_RESET_BASE_PARAMS:
2522 BT_PUT(cur_base_params);
2523 cur_base_params = bt_value_map_create();
2524 if (!cur_base_params) {
2525 print_err_oom();
2526 goto error;
2527 }
2528 break;
c42c79ea
PP
2529 case OPT_NAMES:
2530 if (text_legacy_opts.names) {
2531 printf_err("Duplicate --names option\n");
2532 goto error;
2533 }
2534
2535 text_legacy_opts.names = names_from_arg(arg);
2536 if (!text_legacy_opts.names) {
2537 printf_err("Invalid --names option's argument\n");
2538 goto error;
2539 }
2540 break;
2541 case OPT_FIELDS:
2542 if (text_legacy_opts.fields) {
2543 printf_err("Duplicate --fields option\n");
2544 goto error;
2545 }
2546
2547 text_legacy_opts.fields = fields_from_arg(arg);
2548 if (!text_legacy_opts.fields) {
2549 printf_err("Invalid --fields option's argument\n");
2550 goto error;
2551 }
2552 break;
2553 case OPT_NO_DELTA:
2554 text_legacy_opts.no_delta = true;
2555 break;
2556 case OPT_CLOCK_CYCLES:
2557 text_legacy_opts.clock_cycles = true;
2558 break;
2559 case OPT_CLOCK_SECONDS:
2560 text_legacy_opts.clock_seconds = true;
2561 break;
2562 case OPT_CLOCK_DATE:
2563 text_legacy_opts.clock_date = true;
2564 break;
2565 case OPT_CLOCK_GMT:
2566 text_legacy_opts.clock_gmt = true;
2567 break;
2568 case OPT_DEBUG_INFO_FULL_PATH:
2569 text_legacy_opts.dbg_info_full_path = true;
2570 break;
2571 case OPT_CLOCK_OFFSET:
2572 {
2573 int64_t val;
2574
2575 if (ctf_legacy_opts.offset_s.is_set) {
2576 printf_err("Duplicate --clock-offset option\n");
2577 goto error;
2578 }
2579
2580 if (parse_int64(arg, &val)) {
2581 printf_err("Invalid --clock-offset option's argument\n");
2582 goto error;
2583 }
2584
2585 set_offset_value(&ctf_legacy_opts.offset_s, val);
2586 break;
2587 }
2588 case OPT_CLOCK_OFFSET_NS:
2589 {
2590 int64_t val;
2591
2592 if (ctf_legacy_opts.offset_ns.is_set) {
2593 printf_err("Duplicate --clock-offset-ns option\n");
2594 goto error;
2595 }
2596
2597 if (parse_int64(arg, &val)) {
2598 printf_err("Invalid --clock-offset-ns option's argument\n");
2599 goto error;
2600 }
2601
2602 set_offset_value(&ctf_legacy_opts.offset_ns, val);
2603 break;
2604 }
2605 case OPT_STREAM_INTERSECTION:
2606 ctf_legacy_opts.stream_intersection = true;
2607 break;
2608 case OPT_CLOCK_FORCE_CORRELATE:
2609 cfg->force_correlate = true;
2610 break;
2611 case OPT_HELP:
2612 BT_PUT(cfg);
2613 print_usage(stdout);
2614 goto end;
2615 case OPT_HELP_LEGACY:
2616 BT_PUT(cfg);
2617 print_legacy_usage(stdout);
2618 goto end;
2619 case OPT_VERSION:
2620 BT_PUT(cfg);
2621 print_version();
2622 goto end;
2623 case OPT_LIST:
2624 cfg->do_list = true;
2625 goto end;
2626 case OPT_VERBOSE:
2627 cfg->verbose = true;
2628 break;
2629 case OPT_DEBUG:
2630 cfg->debug = true;
2631 break;
2632 default:
2633 printf_err("Unknown command-line option specified (option code %d)\n",
2634 opt);
2635 goto error;
2636 }
2637
2638 free(arg);
2639 arg = NULL;
2640 }
2641
bdc61c70
PP
2642 /* Append current component configuration, if any */
2643 if (cur_cfg_comp) {
2644 add_cfg_comp(cfg, cur_cfg_comp, cur_cfg_comp_dest);
2645 cur_cfg_comp = NULL;
2646 }
2647
c42c79ea
PP
2648 /* Check for option parsing error */
2649 if (opt < -1) {
2650 printf_err("While parsing command-line options, at option %s: %s\n",
2651 poptBadOption(pc, 0), poptStrerror(opt));
2652 goto error;
2653 }
2654
2655 /* Consume leftover arguments as legacy input paths */
2656 while (true) {
2657 const char *input_path = poptGetArg(pc);
2658
2659 if (!input_path) {
2660 break;
2661 }
2662
2663 if (bt_value_array_append_string(legacy_input_paths,
2664 input_path)) {
2665 print_err_oom();
2666 goto error;
2667 }
2668 }
2669
2670 /* Validate legacy/non-legacy options */
2671 if (!validate_cfg(cfg, &legacy_input_format, &legacy_output_format,
2672 legacy_input_paths, &ctf_legacy_opts,
2673 &text_legacy_opts)) {
2674 printf_err("Command-line options form an invalid configuration\n");
2675 goto error;
2676 }
2677
2678 /*
2679 * If there's a legacy input format, convert it to source
2680 * component configurations.
2681 */
2682 if (legacy_input_format) {
2683 if (append_sources_from_legacy_opts(cfg->sources,
2684 legacy_input_format, &ctf_legacy_opts,
528debdf 2685 legacy_input_paths)) {
49849a47 2686 printf_err("Cannot convert legacy input format options to source component instance(s)\n");
c42c79ea
PP
2687 goto error;
2688 }
2689 }
2690
2691 /*
2692 * If there's a legacy output format, convert it to sink
2693 * component configurations.
2694 */
2695 if (legacy_output_format) {
2696 if (append_sinks_from_legacy_opts(cfg->sinks,
2697 legacy_output_format, &text_legacy_opts)) {
49849a47 2698 printf_err("Cannot convert legacy output format options to sink component instance(s)\n");
c42c79ea
PP
2699 goto error;
2700 }
2701 }
2702
2703 goto end;
2704
2705error:
2706 BT_PUT(cfg);
2707 cfg = NULL;
2708 *exit_code = 1;
2709
2710end:
2711 if (pc) {
2712 poptFreeContext(pc);
2713 }
2714
2715 if (text_legacy_opts.output) {
2716 g_string_free(text_legacy_opts.output, TRUE);
2717 }
2718
2719 if (text_legacy_opts.dbg_info_dir) {
2720 g_string_free(text_legacy_opts.dbg_info_dir, TRUE);
2721 }
2722
2723 if (text_legacy_opts.dbg_info_target_prefix) {
2724 g_string_free(text_legacy_opts.dbg_info_target_prefix, TRUE);
2725 }
2726
2727 free(arg);
bdc61c70 2728 BT_PUT(cur_cfg_comp);
b07ffa28 2729 BT_PUT(cur_base_params);
c42c79ea
PP
2730 BT_PUT(text_legacy_opts.names);
2731 BT_PUT(text_legacy_opts.fields);
2732 BT_PUT(legacy_input_paths);
2733 return cfg;
2734}
This page took 0.131731 seconds and 4 git commands to generate.