projects / babeltrace.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
bt_value_map_extend(): put output parameter as last parameter
[babeltrace.git] / cli / babeltrace-cfg-cli-args.c
CommitLineData
9009cc24
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
b4565e8b
PP		 25#define BT_LOG_TAG "CLI-CFG-CLI-ARGS"
26#include "logging.h"
27
9009cc24
PP		 28#include <errno.h>
29#include <stdlib.h>
30#include <string.h>
f6ccaed9 31#include <babeltrace/assert-internal.h>
9009cc24
PP		 32#include <stdio.h>
33#include <stdbool.h>
34#include <inttypes.h>
35#include <babeltrace/babeltrace.h>
36#include <babeltrace/common-internal.h>
9009cc24
PP		 37#include <popt.h>
38#include <glib.h>
39#include <sys/types.h>
9009cc24
PP		 40#include "babeltrace-cfg.h"
41#include "babeltrace-cfg-cli-args.h"
42#include "babeltrace-cfg-cli-args-connect.h"
7845e95f 43#include "version.h"
9009cc24
PP		 44
45/*
46 * Error printf() macro which prepends "Error: " the first time it's
47 * called. This gives a nicer feel than having a bunch of error prefixes
48 * (since the following lines usually describe the error and possible
49 * solutions), or the error prefix just at the end.
50 */
51#define printf_err(fmt, args...) \
52 do { \
53 if (is_first_error) { \
54 fprintf(stderr, "Command line error: "); \
55 is_first_error = false; \
56 } \
57 fprintf(stderr, fmt, ##args); \
58 } while (0)
59
60static bool is_first_error = true;
61
62/* INI-style parsing FSM states */
63enum ini_parsing_fsm_state {
64 /* Expect a map key (identifier) */
65 INI_EXPECT_MAP_KEY,
66
67 /* Expect an equal character ('=') */
68 INI_EXPECT_EQUAL,
69
70 /* Expect a value */
71 INI_EXPECT_VALUE,
72
73 /* Expect a negative number value */
74 INI_EXPECT_VALUE_NUMBER_NEG,
75
76 /* Expect a comma character (',') */
77 INI_EXPECT_COMMA,
78};
79
80/* INI-style parsing state variables */
81struct ini_parsing_state {
82 /* Lexical scanner (owned by this) */
83 GScanner *scanner;
84
85 /* Output map value object being filled (owned by this) */
05e21286 86 struct bt_value *params;
9009cc24
PP		 87
88 /* Next expected FSM state */
89 enum ini_parsing_fsm_state expecting;
90
91 /* Last decoded map key (owned by this) */
92 char *last_map_key;
93
94 /* Complete INI-style string to parse (not owned by this) */
95 const char *arg;
96
97 /* Error buffer (not owned by this) */
98 GString *ini_error;
99};
100
101/* Offset option with "is set" boolean */
102struct offset_opt {
103 int64_t value;
104 bool is_set;
105};
106
107/* Legacy "ctf"/"lttng-live" format options */
108struct ctf_legacy_opts {
109 struct offset_opt offset_s;
110 struct offset_opt offset_ns;
111 bool stream_intersection;
112};
113
114/* Legacy "text" format options */
115struct text_legacy_opts {
116 /*
117 * output, dbg_info_dir, dbg_info_target_prefix, names,
118 * and fields are owned by this.
119 */
120 GString *output;
121 GString *dbg_info_dir;
122 GString *dbg_info_target_prefix;
05e21286
PP		 123 const struct bt_value *names;
124 const struct bt_value *fields;
9009cc24
PP		 125
126 /* Flags */
127 bool no_delta;
128 bool clock_cycles;
129 bool clock_seconds;
130 bool clock_date;
131 bool clock_gmt;
132 bool dbg_info_full_path;
133 bool verbose;
134};
135
136/* Legacy input format format */
137enum legacy_input_format {
138 LEGACY_INPUT_FORMAT_NONE = 0,
139 LEGACY_INPUT_FORMAT_CTF,
140 LEGACY_INPUT_FORMAT_LTTNG_LIVE,
141};
142
143/* Legacy output format format */
144enum legacy_output_format {
145 LEGACY_OUTPUT_FORMAT_NONE = 0,
146 LEGACY_OUTPUT_FORMAT_TEXT,
147 LEGACY_OUTPUT_FORMAT_DUMMY,
148};
149
150/*
151 * Prints the "out of memory" error.
152 */
153static
154void print_err_oom(void)
155{
156 printf_err("Out of memory\n");
157}
158
159/*
160 * Appends an "expecting token" error to the INI-style parsing state's
161 * error buffer.
162 */
163static
164void ini_append_error_expecting(struct ini_parsing_state *state,
165 GScanner *scanner, const char *expecting)
166{
167 size_t i;
168 size_t pos;
169
170 g_string_append_printf(state->ini_error, "Expecting %s:\n", expecting);
171
172 /* Only print error if there's one line */
173 if (strchr(state->arg, '\n') != NULL || strlen(state->arg) == 0) {
174 return;
175 }
176
177 g_string_append_printf(state->ini_error, "\n %s\n", state->arg);
178 pos = g_scanner_cur_position(scanner) + 4;
179
180 if (!g_scanner_eof(scanner)) {
181 pos--;
182 }
183
184 for (i = 0; i < pos; ++i) {
185 g_string_append_printf(state->ini_error, " ");
186 }
187
188 g_string_append_printf(state->ini_error, "^\n\n");
189}
190
191static
192int ini_handle_state(struct ini_parsing_state *state)
193{
194 int ret = 0;
195 GTokenType token_type;
196 struct bt_value *value = NULL;
197
198 token_type = g_scanner_get_next_token(state->scanner);
199 if (token_type == G_TOKEN_EOF) {
200 if (state->expecting != INI_EXPECT_COMMA) {
201 switch (state->expecting) {
202 case INI_EXPECT_EQUAL:
203 ini_append_error_expecting(state,
204 state->scanner, "'='");
205 break;
206 case INI_EXPECT_VALUE:
207 case INI_EXPECT_VALUE_NUMBER_NEG:
208 ini_append_error_expecting(state,
209 state->scanner, "value");
210 break;
211 case INI_EXPECT_MAP_KEY:
212 ini_append_error_expecting(state,
213 state->scanner, "unquoted map key");
214 break;
215 default:
216 break;
217 }
218 goto error;
219 }
220
221 /* We're done! */
222 ret = 1;
223 goto success;
224 }
225
226 switch (state->expecting) {
227 case INI_EXPECT_MAP_KEY:
228 if (token_type != G_TOKEN_IDENTIFIER) {
229 ini_append_error_expecting(state, state->scanner,
230 "unquoted map key");
231 goto error;
232 }
233
234 free(state->last_map_key);
235 state->last_map_key =
236 strdup(state->scanner->value.v_identifier);
237 if (!state->last_map_key) {
238 g_string_append(state->ini_error,
239 "Out of memory\n");
240 goto error;
241 }
242
05e21286
PP		 243 if (bt_value_map_has_entry(state->params,
244 state->last_map_key)) {
9009cc24
PP		 245 g_string_append_printf(state->ini_error,
246 "Duplicate parameter key: `%s`\n",
247 state->last_map_key);
248 goto error;
249 }
250
251 state->expecting = INI_EXPECT_EQUAL;
252 goto success;
253 case INI_EXPECT_EQUAL:
254 if (token_type != G_TOKEN_CHAR) {
255 ini_append_error_expecting(state,
256 state->scanner, "'='");
257 goto error;
258 }
259
260 if (state->scanner->value.v_char != '=') {
261 ini_append_error_expecting(state,
262 state->scanner, "'='");
263 goto error;
264 }
265
266 state->expecting = INI_EXPECT_VALUE;
267 goto success;
268 case INI_EXPECT_VALUE:
269 {
270 switch (token_type) {
271 case G_TOKEN_CHAR:
272 if (state->scanner->value.v_char == '-') {
273 /* Negative number */
274 state->expecting =
275 INI_EXPECT_VALUE_NUMBER_NEG;
276 goto success;
277 } else {
278 ini_append_error_expecting(state,
279 state->scanner, "value");
280 goto error;
281 }
282 break;
283 case G_TOKEN_INT:
284 {
285 /* Positive integer */
286 uint64_t int_val = state->scanner->value.v_int64;
287
288 if (int_val > (1ULL << 63) - 1) {
289 g_string_append_printf(state->ini_error,
290 "Integer value %" PRIu64 " is outside the range of a 64-bit signed integer\n",
291 int_val);
292 goto error;
293 }
294
05e21286 295 value = bt_value_integer_create_init((int64_t)int_val);
9009cc24
PP		 296 break;
297 }
298 case G_TOKEN_FLOAT:
299 /* Positive floating point number */
05e21286 300 value = bt_value_real_create_init(state->scanner->value.v_float);
9009cc24
PP		 301 break;
302 case G_TOKEN_STRING:
303 /* Quoted string */
05e21286 304 value = bt_value_string_create_init(state->scanner->value.v_string);
9009cc24
PP		 305 break;
306 case G_TOKEN_IDENTIFIER:
307 {
308 /*
309 * Using symbols would be appropriate here,
310 * but said symbols are allowed as map key,
311 * so it's easier to consider everything an
312 * identifier.
313 *
314 * If one of the known symbols is not
315 * recognized here, then fall back to creating
316 * a string value.
317 */
318 const char *id = state->scanner->value.v_identifier;
319
320 if (!strcmp(id, "null") || !strcmp(id, "NULL") ||
321 !strcmp(id, "nul")) {
322 value = bt_value_null;
323 } else if (!strcmp(id, "true") || !strcmp(id, "TRUE") ||
324 !strcmp(id, "yes") ||
325 !strcmp(id, "YES")) {
05e21286 326 value = bt_value_bool_create_init(true);
9009cc24
PP		 327 } else if (!strcmp(id, "false") ||
328 !strcmp(id, "FALSE") ||
329 !strcmp(id, "no") ||
330 !strcmp(id, "NO")) {
05e21286 331 value = bt_value_bool_create_init(false);
9009cc24 332 } else {
05e21286 333 value = bt_value_string_create_init(id);
9009cc24
PP		 334 }
335 break;
336 }
337 default:
338 /* Unset value variable will trigger the error */
339 break;
340 }
341
342 if (!value) {
343 ini_append_error_expecting(state,
344 state->scanner, "value");
345 goto error;
346 }
347
348 state->expecting = INI_EXPECT_COMMA;
349 goto success;
350 }
351 case INI_EXPECT_VALUE_NUMBER_NEG:
352 {
353 switch (token_type) {
354 case G_TOKEN_INT:
355 {
356 /* Negative integer */
357 uint64_t int_val = state->scanner->value.v_int64;
358
359 if (int_val > (1ULL << 63) - 1) {
360 g_string_append_printf(state->ini_error,
361 "Integer value -%" PRIu64 " is outside the range of a 64-bit signed integer\n",
362 int_val);
363 goto error;
364 }
365
05e21286 366 value = bt_value_integer_create_init(-((int64_t)int_val));
9009cc24
PP		 367 break;
368 }
369 case G_TOKEN_FLOAT:
370 /* Negative floating point number */
05e21286 371 value = bt_value_real_create_init(-state->scanner->value.v_float);
9009cc24
PP		 372 break;
373 default:
374 /* Unset value variable will trigger the error */
375 break;
376 }
377
378 if (!value) {
379 ini_append_error_expecting(state,
380 state->scanner, "value");
381 goto error;
382 }
383
384 state->expecting = INI_EXPECT_COMMA;
385 goto success;
386 }
387 case INI_EXPECT_COMMA:
388 if (token_type != G_TOKEN_CHAR) {
389 ini_append_error_expecting(state,
390 state->scanner, "','");
391 goto error;
392 }
393
394 if (state->scanner->value.v_char != ',') {
395 ini_append_error_expecting(state,
396 state->scanner, "','");
397 goto error;
398 }
399
400 state->expecting = INI_EXPECT_MAP_KEY;
401 goto success;
402 default:
0fbb9a9f 403 abort();
9009cc24
PP		 404 }
405
406error:
407 ret = -1;
408 goto end;
409
410success:
411 if (value) {
05e21286 412 if (bt_value_map_insert_entry(state->params,
9009cc24
PP		 413 state->last_map_key, value)) {
414 /* Only override return value on error */
415 ret = -1;
416 }
417 }
418
419end:
65300d60 420 BT_OBJECT_PUT_REF_AND_RESET(value);
9009cc24
PP		 421 return ret;
422}
423
424/*
425 * Converts an INI-style argument to an equivalent map value object.
426 *
427 * Return value is owned by the caller.
428 */
429static
05e21286 430struct bt_value *bt_value_from_ini(const char *arg,
da91b29a 431 GString *ini_error)
9009cc24
PP		 432{
433 /* Lexical scanner configuration */
434 GScannerConfig scanner_config = {
435 /* Skip whitespaces */
436 .cset_skip_characters = " \t\n",
437
438 /* Identifier syntax is: [a-zA-Z_][a-zA-Z0-9_.:-]* */
439 .cset_identifier_first =
440 G_CSET_a_2_z
441 "_"
442 G_CSET_A_2_Z,
443 .cset_identifier_nth =
444 G_CSET_a_2_z
445 "_0123456789-.:"
446 G_CSET_A_2_Z,
447
448 /* "hello" and "Hello" two different keys */
449 .case_sensitive = TRUE,
450
451 /* No comments */
452 .cpair_comment_single = NULL,
453 .skip_comment_multi = TRUE,
454 .skip_comment_single = TRUE,
455 .scan_comment_multi = FALSE,
456
457 /*
458 * Do scan identifiers, including 1-char identifiers,
459 * but NULL is a normal identifier.
460 */
461 .scan_identifier = TRUE,
462 .scan_identifier_1char = TRUE,
463 .scan_identifier_NULL = FALSE,
464
465 /*
466 * No specific symbols: null and boolean "symbols" are
467 * scanned as plain identifiers.
468 */
469 .scan_symbols = FALSE,
470 .symbol_2_token = FALSE,
471 .scope_0_fallback = FALSE,
472
473 /*
474 * Scan "0b"-, "0"-, and "0x"-prefixed integers, but not
475 * integers prefixed with "$".
476 */
477 .scan_binary = TRUE,
478 .scan_octal = TRUE,
479 .scan_float = TRUE,
480 .scan_hex = TRUE,
481 .scan_hex_dollar = FALSE,
482
483 /* Convert scanned numbers to integer tokens */
484 .numbers_2_int = TRUE,
485
486 /* Support both integers and floating-point numbers */
487 .int_2_float = FALSE,
488
489 /* Scan integers as 64-bit signed integers */
490 .store_int64 = TRUE,
491
492 /* Only scan double-quoted strings */
493 .scan_string_sq = FALSE,
494 .scan_string_dq = TRUE,
495
496 /* Do not converter identifiers to string tokens */
497 .identifier_2_string = FALSE,
498
499 /* Scan characters as G_TOKEN_CHAR token */
500 .char_2_token = FALSE,
501 };
502 struct ini_parsing_state state = {
503 .scanner = NULL,
504 .params = NULL,
505 .expecting = INI_EXPECT_MAP_KEY,
506 .arg = arg,
507 .ini_error = ini_error,
508 };
509
05e21286 510 state.params = bt_value_map_create();
9009cc24
PP		 511 if (!state.params) {
512 goto error;
513 }
514
515 state.scanner = g_scanner_new(&scanner_config);
516 if (!state.scanner) {
517 goto error;
518 }
519
520 /* Let the scan begin */
521 g_scanner_input_text(state.scanner, arg, strlen(arg));
522
523 while (true) {
524 int ret = ini_handle_state(&state);
525
526 if (ret < 0) {
527 /* Error */
528 goto error;
529 } else if (ret > 0) {
530 /* Done */
531 break;
532 }
533 }
534
535 goto end;
536
537error:
65300d60 538 BT_OBJECT_PUT_REF_AND_RESET(state.params);
9009cc24
PP		 539
540end:
541 if (state.scanner) {
542 g_scanner_destroy(state.scanner);
543 }
544
545 free(state.last_map_key);
546 return state.params;
547}
548
549/*
550 * Returns the parameters map value object from a command-line
551 * parameter option's argument.
552 *
553 * Return value is owned by the caller.
554 */
555static
05e21286 556struct bt_value *bt_value_from_arg(const char *arg)
9009cc24 557{
05e21286 558 struct bt_value *params = NULL;
9009cc24
PP		 559 GString *ini_error = NULL;
560
561 ini_error = g_string_new(NULL);
562 if (!ini_error) {
563 print_err_oom();
564 goto end;
565 }
566
567 /* Try INI-style parsing */
05e21286 568 params = bt_value_from_ini(arg, ini_error);
9009cc24
PP		 569 if (!params) {
570 printf_err("%s", ini_error->str);
571 goto end;
572 }
573
574end:
575 if (ini_error) {
576 g_string_free(ini_error, TRUE);
577 }
da91b29a 578
9009cc24
PP		 579 return params;
580}
581
582/*
fd5f8053
PP		 583 * Returns the plugin name, component class name, component class type,
584 * and component name from a command-line --component option's argument.
585 * arg must have the following format:
9009cc24 586 *
fd5f8053 587 * [NAME:]TYPE.PLUGIN.CLS
9009cc24 588 *
fd5f8053
PP		 589 * where NAME is the optional component name, TYPE is either `source`,
590 * `filter`, or `sink`, PLUGIN is the plugin name, and CLS is the
591 * component class name.
9009cc24
PP		 592 *
593 * On success, both *plugin and *component are not NULL. *plugin
e5c7cd9b
PP		 594 * and *comp_cls are owned by the caller. On success, *name can be NULL
595 * if no component class name was found, and *comp_cls_type is set.
9009cc24
PP		 596 */
597static
598void plugin_comp_cls_names(const char *arg, char **name, char **plugin,
fd5f8053 599 char **comp_cls, enum bt_component_class_type *comp_cls_type)
9009cc24
PP		 600{
601 const char *at = arg;
602 GString *gs_name = NULL;
fd5f8053 603 GString *gs_comp_cls_type = NULL;
9009cc24
PP		 604 GString *gs_plugin = NULL;
605 GString *gs_comp_cls = NULL;
606 size_t end_pos;
607
f6ccaed9
PP		 608 BT_ASSERT(arg);
609 BT_ASSERT(plugin);
610 BT_ASSERT(comp_cls);
611 BT_ASSERT(comp_cls_type);
9009cc24
PP		 612
613 if (!bt_common_string_is_printable(arg)) {
614 printf_err("Argument contains a non-printable character\n");
615 goto error;
616 }
617
618 /* Parse the component name */
619 gs_name = bt_common_string_until(at, ".:\\", ":", &end_pos);
620 if (!gs_name) {
621 goto error;
622 }
623
624 if (arg[end_pos] == ':') {
625 at += end_pos + 1;
626 } else {
627 /* No name */
628 g_string_assign(gs_name, "");
629 }
630
fd5f8053
PP		 631 /* Parse the component class type */
632 gs_comp_cls_type = bt_common_string_until(at, ".:\\", ".", &end_pos);
633 if (!gs_comp_cls_type || at[end_pos] == '\0') {
634 printf_err("Missing component class type (`source`, `filter`, or `sink`)\n");
635 goto error;
636 }
637
638 if (strcmp(gs_comp_cls_type->str, "source") == 0 ||
639 strcmp(gs_comp_cls_type->str, "src") == 0) {
640 *comp_cls_type = BT_COMPONENT_CLASS_TYPE_SOURCE;
641 } else if (strcmp(gs_comp_cls_type->str, "filter") == 0 ||
642 strcmp(gs_comp_cls_type->str, "flt") == 0) {
643 *comp_cls_type = BT_COMPONENT_CLASS_TYPE_FILTER;
644 } else if (strcmp(gs_comp_cls_type->str, "sink") == 0) {
645 *comp_cls_type = BT_COMPONENT_CLASS_TYPE_SINK;
646 } else {
647 printf_err("Unknown component class type: `%s`\n",
648 gs_comp_cls_type->str);
649 goto error;
650 }
651
652 at += end_pos + 1;
653
9009cc24
PP		 654 /* Parse the plugin name */
655 gs_plugin = bt_common_string_until(at, ".:\\", ".", &end_pos);
656 if (!gs_plugin || gs_plugin->len == 0 || at[end_pos] == '\0') {
7b1e06a1 657 printf_err("Missing plugin or component class name\n");
9009cc24
PP		 658 goto error;
659 }
660
661 at += end_pos + 1;
662
663 /* Parse the component class name */
664 gs_comp_cls = bt_common_string_until(at, ".:\\", ".", &end_pos);
665 if (!gs_comp_cls || gs_comp_cls->len == 0) {
fd5f8053 666 printf_err("Missing component class name\n");
9009cc24
PP		 667 goto error;
668 }
669
670 if (at[end_pos] != '\0') {
671 /* Found a non-escaped `.` */
672 goto error;
673 }
674
675 if (name) {
676 if (gs_name->len == 0) {
677 *name = NULL;
678 g_string_free(gs_name, TRUE);
679 } else {
680 *name = gs_name->str;
681 g_string_free(gs_name, FALSE);
682 }
683 } else {
684 g_string_free(gs_name, TRUE);
685 }
686
687 *plugin = gs_plugin->str;
688 *comp_cls = gs_comp_cls->str;
689 g_string_free(gs_plugin, FALSE);
690 g_string_free(gs_comp_cls, FALSE);
691 gs_name = NULL;
692 gs_plugin = NULL;
693 gs_comp_cls = NULL;
694 goto end;
695
696error:
282c8cd0
PP		 697 if (name) {
698 *name = NULL;
699 }
700
701 *plugin = NULL;
702 *comp_cls = NULL;
703
704end:
9009cc24
PP		 705 if (gs_name) {
706 g_string_free(gs_name, TRUE);
707 }
708
709 if (gs_plugin) {
710 g_string_free(gs_plugin, TRUE);
711 }
712
713 if (gs_comp_cls) {
714 g_string_free(gs_comp_cls, TRUE);
715 }
716
282c8cd0
PP		 717 if (gs_comp_cls_type) {
718 g_string_free(gs_comp_cls_type, TRUE);
9009cc24
PP		 719 }
720
9009cc24
PP		 721 return;
722}
723
724/*
725 * Prints the Babeltrace version.
726 */
727static
728void print_version(void)
729{
7845e95f
MJ		 730 if (GIT_VERSION[0] == '\0') {
731 puts("Babeltrace " VERSION);
732 } else {
733 puts("Babeltrace " VERSION " - " GIT_VERSION);
734 }
9009cc24
PP		 735}
736
737/*
738 * Destroys a component configuration.
739 */
740static
741void bt_config_component_destroy(struct bt_object *obj)
742{
743 struct bt_config_component *bt_config_component =
744 container_of(obj, struct bt_config_component, base);
745
746 if (!obj) {
747 goto end;
748 }
749
750 if (bt_config_component->plugin_name) {
751 g_string_free(bt_config_component->plugin_name, TRUE);
752 }
753
754 if (bt_config_component->comp_cls_name) {
755 g_string_free(bt_config_component->comp_cls_name, TRUE);
756 }
757
758 if (bt_config_component->instance_name) {
759 g_string_free(bt_config_component->instance_name, TRUE);
760 }
761
65300d60 762 BT_OBJECT_PUT_REF_AND_RESET(bt_config_component->params);
9009cc24
PP		 763 g_free(bt_config_component);
764
765end:
766 return;
767}
768
769/*
770 * Creates a component configuration using the given plugin name and
771 * component name. `plugin_name` and `comp_cls_name` are copied (belong
772 * to the return value).
773 *
774 * Return value is owned by the caller.
775 */
776static
777struct bt_config_component *bt_config_component_create(
778 enum bt_component_class_type type,
779 const char *plugin_name, const char *comp_cls_name)
780{
781 struct bt_config_component *cfg_component = NULL;
782
783 cfg_component = g_new0(struct bt_config_component, 1);
784 if (!cfg_component) {
785 print_err_oom();
786 goto error;
787 }
788
3fea54f6
PP		 789 bt_object_init_shared(&cfg_component->base,
790 bt_config_component_destroy);
9009cc24
PP		 791 cfg_component->type = type;
792 cfg_component->plugin_name = g_string_new(plugin_name);
793 if (!cfg_component->plugin_name) {
794 print_err_oom();
795 goto error;
796 }
797
798 cfg_component->comp_cls_name = g_string_new(comp_cls_name);
799 if (!cfg_component->comp_cls_name) {
800 print_err_oom();
801 goto error;
802 }
803
804 cfg_component->instance_name = g_string_new(NULL);
805 if (!cfg_component->instance_name) {
806 print_err_oom();
807 goto error;
808 }
809
810 /* Start with empty parameters */
05e21286 811 cfg_component->params = bt_value_map_create();
9009cc24
PP		 812 if (!cfg_component->params) {
813 print_err_oom();
814 goto error;
815 }
816
817 goto end;
818
819error:
65300d60 820 BT_OBJECT_PUT_REF_AND_RESET(cfg_component);
9009cc24
PP		 821
822end:
823 return cfg_component;
824}
825
826/*
fd5f8053 827 * Creates a component configuration from a command-line --component
9009cc24
PP		 828 * option's argument.
829 */
830static
fd5f8053 831struct bt_config_component *bt_config_component_from_arg(const char *arg)
9009cc24
PP		 832{
833 struct bt_config_component *cfg_comp = NULL;
834 char *name = NULL;
835 char *plugin_name = NULL;
836 char *comp_cls_name = NULL;
fd5f8053 837 enum bt_component_class_type type;
9009cc24 838
fd5f8053 839 plugin_comp_cls_names(arg, &name, &plugin_name, &comp_cls_name, &type);
9009cc24 840 if (!plugin_name || !comp_cls_name) {
9009cc24
PP		 841 goto error;
842 }
843
844 cfg_comp = bt_config_component_create(type, plugin_name, comp_cls_name);
845 if (!cfg_comp) {
846 goto error;
847 }
848
849 if (name) {
850 g_string_assign(cfg_comp->instance_name, name);
851 }
852
853 goto end;
854
855error:
65300d60 856 BT_OBJECT_PUT_REF_AND_RESET(cfg_comp);
9009cc24
PP		 857
858end:
859 g_free(name);
860 g_free(plugin_name);
861 g_free(comp_cls_name);
862 return cfg_comp;
863}
864
865/*
866 * Destroys a configuration.
867 */
868static
869void bt_config_destroy(struct bt_object *obj)
870{
871 struct bt_config *cfg =
872 container_of(obj, struct bt_config, base);
873
874 if (!obj) {
875 goto end;
876 }
877
65300d60 878 BT_OBJECT_PUT_REF_AND_RESET(cfg->plugin_paths);
9009cc24
PP		 879
880 switch (cfg->command) {
881 case BT_CONFIG_COMMAND_RUN:
882 if (cfg->cmd_data.run.sources) {
883 g_ptr_array_free(cfg->cmd_data.run.sources, TRUE);
884 }
885
886 if (cfg->cmd_data.run.filters) {
887 g_ptr_array_free(cfg->cmd_data.run.filters, TRUE);
888 }
889
890 if (cfg->cmd_data.run.sinks) {
891 g_ptr_array_free(cfg->cmd_data.run.sinks, TRUE);
892 }
893
894 if (cfg->cmd_data.run.connections) {
895 g_ptr_array_free(cfg->cmd_data.run.connections,
896 TRUE);
897 }
898 break;
899 case BT_CONFIG_COMMAND_LIST_PLUGINS:
900 break;
901 case BT_CONFIG_COMMAND_HELP:
65300d60 902 BT_OBJECT_PUT_REF_AND_RESET(cfg->cmd_data.help.cfg_component);
9009cc24
PP		 903 break;
904 case BT_CONFIG_COMMAND_QUERY:
65300d60 905 BT_OBJECT_PUT_REF_AND_RESET(cfg->cmd_data.query.cfg_component);
9009cc24
PP		 906
907 if (cfg->cmd_data.query.object) {
908 g_string_free(cfg->cmd_data.query.object, TRUE);
909 }
910 break;
911 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA:
912 if (cfg->cmd_data.print_ctf_metadata.path) {
913 g_string_free(cfg->cmd_data.print_ctf_metadata.path,
914 TRUE);
c327e427
PP		 915 g_string_free(
916 cfg->cmd_data.print_ctf_metadata.output_path,
917 TRUE);
9009cc24
PP		 918 }
919 break;
920 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS:
921 if (cfg->cmd_data.print_lttng_live_sessions.url) {
922 g_string_free(
923 cfg->cmd_data.print_lttng_live_sessions.url,
924 TRUE);
c327e427
PP		 925 g_string_free(
926 cfg->cmd_data.print_lttng_live_sessions.output_path,
927 TRUE);
9009cc24
PP		 928 }
929 break;
930 default:
0fbb9a9f 931 abort();
9009cc24
PP		 932 }
933
934 g_free(cfg);
935
936end:
937 return;
938}
939
940static
941void destroy_glist_of_gstring(GList *list)
942{
94023a1c
PP		 943 GList *at;
944
9009cc24
PP		 945 if (!list) {
946 return;
947 }
948
9009cc24
PP		 949 for (at = list; at != NULL; at = g_list_next(at)) {
950 g_string_free(at->data, TRUE);
951 }
952
953 g_list_free(list);
954}
955
956/*
957 * Creates a simple lexical scanner for parsing comma-delimited names
958 * and fields.
959 *
960 * Return value is owned by the caller.
961 */
962static
963GScanner *create_csv_identifiers_scanner(void)
964{
965 GScanner *scanner;
966 GScannerConfig scanner_config = {
967 .cset_skip_characters = " \t\n",
968 .cset_identifier_first = G_CSET_a_2_z G_CSET_A_2_Z "_",
969 .cset_identifier_nth = G_CSET_a_2_z G_CSET_A_2_Z ":_-",
970 .case_sensitive = TRUE,
971 .cpair_comment_single = NULL,
972 .skip_comment_multi = TRUE,
973 .skip_comment_single = TRUE,
974 .scan_comment_multi = FALSE,
975 .scan_identifier = TRUE,
976 .scan_identifier_1char = TRUE,
977 .scan_identifier_NULL = FALSE,
978 .scan_symbols = FALSE,
979 .symbol_2_token = FALSE,
980 .scope_0_fallback = FALSE,
981 .scan_binary = FALSE,
982 .scan_octal = FALSE,
983 .scan_float = FALSE,
984 .scan_hex = FALSE,
985 .scan_hex_dollar = FALSE,
986 .numbers_2_int = FALSE,
987 .int_2_float = FALSE,
988 .store_int64 = FALSE,
989 .scan_string_sq = FALSE,
990 .scan_string_dq = FALSE,
991 .identifier_2_string = FALSE,
992 .char_2_token = TRUE,
993 };
994
995 scanner = g_scanner_new(&scanner_config);
996 if (!scanner) {
997 print_err_oom();
998 }
999
1000 return scanner;
1001}
1002
1003/*
1004 * Converts a comma-delimited list of known names (--names option) to
1005 * an array value object containing those names as string value objects.
1006 *
1007 * Return value is owned by the caller.
1008 */
1009static
05e21286 1010struct bt_value *names_from_arg(const char *arg)
9009cc24
PP		 1011{
1012 GScanner *scanner = NULL;
05e21286 1013 struct bt_value *names = NULL;
9009cc24
PP		 1014 bool found_all = false, found_none = false, found_item = false;
1015
05e21286 1016 names = bt_value_array_create();
9009cc24
PP		 1017 if (!names) {
1018 print_err_oom();
1019 goto error;
1020 }
1021
1022 scanner = create_csv_identifiers_scanner();
1023 if (!scanner) {
1024 goto error;
1025 }
1026
1027 g_scanner_input_text(scanner, arg, strlen(arg));
1028
1029 while (true) {
1030 GTokenType token_type = g_scanner_get_next_token(scanner);
1031
1032 switch (token_type) {
1033 case G_TOKEN_IDENTIFIER:
1034 {
1035 const char *identifier = scanner->value.v_identifier;
1036
1037 if (!strcmp(identifier, "payload") ||
1038 !strcmp(identifier, "args") ||
1039 !strcmp(identifier, "arg")) {
1040 found_item = true;
05e21286 1041 if (bt_value_array_append_string_element(names,
9009cc24
PP		 1042 "payload")) {
1043 goto error;
1044 }
1045 } else if (!strcmp(identifier, "context") ||
1046 !strcmp(identifier, "ctx")) {
1047 found_item = true;
05e21286 1048 if (bt_value_array_append_string_element(names,
9009cc24
PP		 1049 "context")) {
1050 goto error;
1051 }
1052 } else if (!strcmp(identifier, "scope") ||
1053 !strcmp(identifier, "header")) {
1054 found_item = true;
05e21286 1055 if (bt_value_array_append_string_element(names,
9009cc24
PP		 1056 identifier)) {
1057 goto error;
1058 }
1059 } else if (!strcmp(identifier, "all")) {
1060 found_all = true;
05e21286 1061 if (bt_value_array_append_string_element(names,
9009cc24
PP		 1062 identifier)) {
1063 goto error;
1064 }
1065 } else if (!strcmp(identifier, "none")) {
1066 found_none = true;
05e21286 1067 if (bt_value_array_append_string_element(names,
9009cc24
PP		 1068 identifier)) {
1069 goto error;
1070 }
1071 } else {
1072 printf_err("Unknown name: `%s`\n",
1073 identifier);
1074 goto error;
1075 }
1076 break;
1077 }
1078 case G_TOKEN_COMMA:
1079 continue;
1080 case G_TOKEN_EOF:
1081 goto end;
1082 default:
1083 goto error;
1084 }
1085 }
1086
1087end:
1088 if (found_none && found_all) {
1089 printf_err("Only either `all` or `none` can be specified in the list given to the --names option, but not both.\n");
1090 goto error;
1091 }
1092 /*
1093 * Legacy behavior is to clear the defaults (show none) when at
1094 * least one item is specified.
1095 */
1096 if (found_item && !found_none && !found_all) {
05e21286 1097 if (bt_value_array_append_string_element(names, "none")) {
9009cc24
PP		 1098 goto error;
1099 }
1100 }
1101 if (scanner) {
1102 g_scanner_destroy(scanner);
1103 }
1104 return names;
1105
1106error:
65300d60 1107 BT_OBJECT_PUT_REF_AND_RESET(names);
9009cc24
PP		 1108 if (scanner) {
1109 g_scanner_destroy(scanner);
1110 }
1111 return names;
1112}
1113
1114/*
1115 * Converts a comma-delimited list of known fields (--fields option) to
1116 * an array value object containing those fields as string
1117 * value objects.
1118 *
1119 * Return value is owned by the caller.
1120 */
1121static
05e21286 1122struct bt_value *fields_from_arg(const char *arg)
9009cc24
PP		 1123{
1124 GScanner *scanner = NULL;
05e21286 1125 struct bt_value *fields;
9009cc24 1126
05e21286 1127 fields = bt_value_array_create();
9009cc24
PP		 1128 if (!fields) {
1129 print_err_oom();
1130 goto error;
1131 }
1132
1133 scanner = create_csv_identifiers_scanner();
1134 if (!scanner) {
1135 goto error;
1136 }
1137
1138 g_scanner_input_text(scanner, arg, strlen(arg));
1139
1140 while (true) {
1141 GTokenType token_type = g_scanner_get_next_token(scanner);
1142
1143 switch (token_type) {
1144 case G_TOKEN_IDENTIFIER:
1145 {
1146 const char *identifier = scanner->value.v_identifier;
1147
1148 if (!strcmp(identifier, "trace") ||
1149 !strcmp(identifier, "trace:hostname") ||
1150 !strcmp(identifier, "trace:domain") ||
1151 !strcmp(identifier, "trace:procname") ||
1152 !strcmp(identifier, "trace:vpid") ||
1153 !strcmp(identifier, "loglevel") ||
1154 !strcmp(identifier, "emf") ||
1155 !strcmp(identifier, "callsite") ||
1156 !strcmp(identifier, "all")) {
05e21286 1157 if (bt_value_array_append_string_element(fields,
9009cc24
PP		 1158 identifier)) {
1159 goto error;
1160 }
1161 } else {
1162 printf_err("Unknown field: `%s`\n",
1163 identifier);
1164 goto error;
1165 }
1166 break;
1167 }
1168 case G_TOKEN_COMMA:
1169 continue;
1170 case G_TOKEN_EOF:
1171 goto end;
1172 default:
1173 goto error;
1174 }
1175 }
1176
1177 goto end;
1178
1179error:
65300d60 1180 BT_OBJECT_PUT_REF_AND_RESET(fields);
9009cc24
PP		 1181
1182end:
1183 if (scanner) {
1184 g_scanner_destroy(scanner);
1185 }
1186 return fields;
1187}
1188
1189static
1190void append_param_arg(GString *params_arg, const char *key, const char *value)
1191{
f6ccaed9
PP		 1192 BT_ASSERT(params_arg);
1193 BT_ASSERT(key);
1194 BT_ASSERT(value);
9009cc24
PP		 1195
1196 if (params_arg->len != 0) {
1197 g_string_append_c(params_arg, ',');
1198 }
1199
1200 g_string_append(params_arg, key);
1201 g_string_append_c(params_arg, '=');
1202 g_string_append(params_arg, value);
1203}
1204
1205/*
1206 * Inserts the equivalent "prefix-NAME=yes" strings into params_arg
1207 * where the names are in names_array.
1208 */
1209static
1210int insert_flat_params_from_array(GString *params_arg,
05e21286 1211 const struct bt_value *names_array, const char *prefix)
9009cc24
PP		 1212{
1213 int ret = 0;
1214 int i;
1215 GString *tmpstr = NULL, *default_value = NULL;
1216 bool default_set = false, non_default_set = false;
1217
1218 /*
1219 * names_array may be NULL if no CLI options were specified to
1220 * trigger its creation.
1221 */
1222 if (!names_array) {
1223 goto end;
1224 }
1225
1226 tmpstr = g_string_new(NULL);
1227 if (!tmpstr) {
1228 print_err_oom();
1229 ret = -1;
1230 goto end;
1231 }
1232
1233 default_value = g_string_new(NULL);
1234 if (!default_value) {
1235 print_err_oom();
1236 ret = -1;
1237 goto end;
1238 }
1239
07208d85 1240 for (i = 0; i < bt_value_array_get_size(names_array); i++) {
05e21286
PP		 1241 const struct bt_value *str_obj =
1242 bt_value_array_borrow_element_by_index_const(names_array,
1243 i);
9009cc24
PP		 1244 const char *suffix;
1245 bool is_default = false;
1246
1247 if (!str_obj) {
1248 printf_err("Unexpected error\n");
1249 ret = -1;
1250 goto end;
1251 }
1252
601b0d3c 1253 suffix = bt_value_string_get(str_obj);
9009cc24
PP		 1254
1255 g_string_assign(tmpstr, prefix);
1256 g_string_append(tmpstr, "-");
1257
1258 /* Special-case for "all" and "none". */
1259 if (!strcmp(suffix, "all")) {
1260 is_default = true;
1261 g_string_assign(default_value, "show");
1262 } else if (!strcmp(suffix, "none")) {
1263 is_default = true;
1264 g_string_assign(default_value, "hide");
1265 }
1266 if (is_default) {
1267 default_set = true;
1268 g_string_append(tmpstr, "default");
1269 append_param_arg(params_arg, tmpstr->str,
1270 default_value->str);
1271 } else {
1272 non_default_set = true;
1273 g_string_append(tmpstr, suffix);
1274 append_param_arg(params_arg, tmpstr->str, "yes");
1275 }
1276 }
1277
1278 /* Implicit field-default=hide if any non-default option is set. */
1279 if (non_default_set && !default_set) {
1280 g_string_assign(tmpstr, prefix);
1281 g_string_append(tmpstr, "-default");
1282 g_string_assign(default_value, "hide");
1283 append_param_arg(params_arg, tmpstr->str, default_value->str);
1284 }
1285
1286end:
1287 if (default_value) {
1288 g_string_free(default_value, TRUE);
1289 }
1290
1291 if (tmpstr) {
1292 g_string_free(tmpstr, TRUE);
1293 }
1294
1295 return ret;
1296}
1297
1298/* popt options */
1299enum {
1300 OPT_NONE = 0,
1301 OPT_BASE_PARAMS,
1302 OPT_BEGIN,
1303 OPT_CLOCK_CYCLES,
1304 OPT_CLOCK_DATE,
1305 OPT_CLOCK_FORCE_CORRELATE,
1306 OPT_CLOCK_GMT,
1307 OPT_CLOCK_OFFSET,
1308 OPT_CLOCK_OFFSET_NS,
1309 OPT_CLOCK_SECONDS,
1310 OPT_COLOR,
fd5f8053 1311 OPT_COMPONENT,
9009cc24
PP		 1312 OPT_CONNECT,
1313 OPT_DEBUG,
9a16feea 1314 OPT_DEBUG_INFO,
9009cc24
PP		 1315 OPT_DEBUG_INFO_DIR,
1316 OPT_DEBUG_INFO_FULL_PATH,
1317 OPT_DEBUG_INFO_TARGET_PREFIX,
1318 OPT_END,
1319 OPT_FIELDS,
9009cc24
PP		 1320 OPT_HELP,
1321 OPT_INPUT_FORMAT,
1322 OPT_KEY,
1323 OPT_LIST,
1324 OPT_NAME,
1325 OPT_NAMES,
9009cc24
PP		 1326 OPT_NO_DELTA,
1327 OPT_OMIT_HOME_PLUGIN_PATH,
1328 OPT_OMIT_SYSTEM_PLUGIN_PATH,
9009cc24 1329 OPT_OUTPUT,
fd5f8053 1330 OPT_OUTPUT_FORMAT,
9009cc24
PP		 1331 OPT_PARAMS,
1332 OPT_PATH,
1333 OPT_PLUGIN_PATH,
1334 OPT_RESET_BASE_PARAMS,
1335 OPT_RETRY_DURATION,
1336 OPT_RUN_ARGS,
1337 OPT_RUN_ARGS_0,
9009cc24
PP		 1338 OPT_STREAM_INTERSECTION,
1339 OPT_TIMERANGE,
1340 OPT_URL,
1341 OPT_VALUE,
1342 OPT_VERBOSE,
1343};
1344
1345enum bt_config_component_dest {
0a011c88 1346 BT_CONFIG_COMPONENT_DEST_UNKNOWN = -1,
9009cc24
PP		 1347 BT_CONFIG_COMPONENT_DEST_SOURCE,
1348 BT_CONFIG_COMPONENT_DEST_FILTER,
1349 BT_CONFIG_COMPONENT_DEST_SINK,
1350};
1351
1352/*
1353 * Adds a configuration component to the appropriate configuration
1354 * array depending on the destination.
1355 */
1356static
1357void add_run_cfg_comp(struct bt_config *cfg,
1358 struct bt_config_component *cfg_comp,
1359 enum bt_config_component_dest dest)
1360{
65300d60 1361 bt_object_get_ref(cfg_comp);
9009cc24
PP		 1362
1363 switch (dest) {
1364 case BT_CONFIG_COMPONENT_DEST_SOURCE:
1365 g_ptr_array_add(cfg->cmd_data.run.sources, cfg_comp);
1366 break;
1367 case BT_CONFIG_COMPONENT_DEST_FILTER:
1368 g_ptr_array_add(cfg->cmd_data.run.filters, cfg_comp);
1369 break;
1370 case BT_CONFIG_COMPONENT_DEST_SINK:
1371 g_ptr_array_add(cfg->cmd_data.run.sinks, cfg_comp);
1372 break;
1373 default:
0fbb9a9f 1374 abort();
9009cc24
PP		 1375 }
1376}
1377
1378static
1379int add_run_cfg_comp_check_name(struct bt_config *cfg,
1380 struct bt_config_component *cfg_comp,
1381 enum bt_config_component_dest dest,
05e21286 1382 struct bt_value *instance_names)
9009cc24
PP		 1383{
1384 int ret = 0;
1385
1386 if (cfg_comp->instance_name->len == 0) {
1387 printf_err("Found an unnamed component\n");
1388 ret = -1;
1389 goto end;
1390 }
1391
05e21286
PP		 1392 if (bt_value_map_has_entry(instance_names,
1393 cfg_comp->instance_name->str)) {
9009cc24
PP		 1394 printf_err("Duplicate component instance name:\n %s\n",
1395 cfg_comp->instance_name->str);
1396 ret = -1;
1397 goto end;
1398 }
1399
05e21286 1400 if (bt_value_map_insert_entry(instance_names,
9009cc24
PP		 1401 cfg_comp->instance_name->str, bt_value_null)) {
1402 print_err_oom();
1403 ret = -1;
1404 goto end;
1405 }
1406
1407 add_run_cfg_comp(cfg, cfg_comp, dest);
1408
1409end:
1410 return ret;
1411}
1412
1413static
05e21286 1414int append_env_var_plugin_paths(struct bt_value *plugin_paths)
9009cc24
PP		 1415{
1416 int ret = 0;
1417 const char *envvar;
1418
1419 if (bt_common_is_setuid_setgid()) {
b4565e8b 1420 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
9009cc24
PP		 1421 goto end;
1422 }
1423
1424 envvar = getenv("BABELTRACE_PLUGIN_PATH");
1425 if (!envvar) {
1426 goto end;
1427 }
1428
1429 ret = bt_config_append_plugin_paths(plugin_paths, envvar);
1430
1431end:
1432 if (ret) {
1433 printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n");
1434 }
1435
1436 return ret;
1437}
1438
1439static
05e21286 1440int append_home_and_system_plugin_paths(struct bt_value *plugin_paths,
9009cc24
PP		 1441 bool omit_system_plugin_path, bool omit_home_plugin_path)
1442{
1443 int ret;
1444
1445 if (!omit_home_plugin_path) {
1446 if (bt_common_is_setuid_setgid()) {
b4565e8b 1447 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
9009cc24
PP		 1448 } else {
1449 char *home_plugin_dir =
1450 bt_common_get_home_plugin_path();
1451
1452 if (home_plugin_dir) {
1453 ret = bt_config_append_plugin_paths(
1454 plugin_paths, home_plugin_dir);
1455 free(home_plugin_dir);
1456
1457 if (ret) {
1458 printf_err("Invalid home plugin path\n");
1459 goto error;
1460 }
1461 }
1462 }
1463 }
1464
1465 if (!omit_system_plugin_path) {
1466 if (bt_config_append_plugin_paths(plugin_paths,
1467 bt_common_get_system_plugin_path())) {
1468 printf_err("Invalid system plugin path\n");
1469 goto error;
1470 }
1471 }
1472 return 0;
1473error:
1474 printf_err("Cannot append home and system plugin paths\n");
1475 return -1;
1476}
1477
1478static
1479int append_home_and_system_plugin_paths_cfg(struct bt_config *cfg)
1480{
1481 return append_home_and_system_plugin_paths(cfg->plugin_paths,
1482 cfg->omit_system_plugin_path, cfg->omit_home_plugin_path);
1483}
1484
1485static
1486struct bt_config *bt_config_base_create(enum bt_config_command command,
05e21286 1487 const struct bt_value *initial_plugin_paths,
da91b29a 1488 bool needs_plugins)
9009cc24
PP		 1489{
1490 struct bt_config *cfg;
1491
1492 /* Create config */
1493 cfg = g_new0(struct bt_config, 1);
1494 if (!cfg) {
1495 print_err_oom();
1496 goto error;
1497 }
1498
3fea54f6 1499 bt_object_init_shared(&cfg->base, bt_config_destroy);
9009cc24
PP		 1500 cfg->command = command;
1501 cfg->command_needs_plugins = needs_plugins;
1502
1503 if (initial_plugin_paths) {
05e21286
PP		 1504 struct bt_value *initial_plugin_paths_copy;
1505
1506 (void) bt_value_copy(&initial_plugin_paths_copy,
1507 initial_plugin_paths);
1508 cfg->plugin_paths = initial_plugin_paths_copy;
9009cc24 1509 } else {
05e21286 1510 cfg->plugin_paths = bt_value_array_create();
9009cc24
PP		 1511 if (!cfg->plugin_paths) {
1512 print_err_oom();
1513 goto error;
1514 }
1515 }
1516
1517 goto end;
1518
1519error:
65300d60 1520 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1521
1522end:
1523 return cfg;
1524}
1525
1526static
1527struct bt_config *bt_config_run_create(
05e21286 1528 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1529{
1530 struct bt_config *cfg;
1531
1532 /* Create config */
1533 cfg = bt_config_base_create(BT_CONFIG_COMMAND_RUN,
1534 initial_plugin_paths, true);
1535 if (!cfg) {
1536 goto error;
1537 }
1538
1539 cfg->cmd_data.run.sources = g_ptr_array_new_with_free_func(
65300d60 1540 (GDestroyNotify) bt_object_put_ref);
9009cc24
PP		 1541 if (!cfg->cmd_data.run.sources) {
1542 print_err_oom();
1543 goto error;
1544 }
1545
1546 cfg->cmd_data.run.filters = g_ptr_array_new_with_free_func(
65300d60 1547 (GDestroyNotify) bt_object_put_ref);
9009cc24
PP		 1548 if (!cfg->cmd_data.run.filters) {
1549 print_err_oom();
1550 goto error;
1551 }
1552
1553 cfg->cmd_data.run.sinks = g_ptr_array_new_with_free_func(
65300d60 1554 (GDestroyNotify) bt_object_put_ref);
9009cc24
PP		 1555 if (!cfg->cmd_data.run.sinks) {
1556 print_err_oom();
1557 goto error;
1558 }
1559
1560 cfg->cmd_data.run.connections = g_ptr_array_new_with_free_func(
1561 (GDestroyNotify) bt_config_connection_destroy);
1562 if (!cfg->cmd_data.run.connections) {
1563 print_err_oom();
1564 goto error;
1565 }
1566
1567 goto end;
1568
1569error:
65300d60 1570 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1571
1572end:
1573 return cfg;
1574}
1575
1576static
1577struct bt_config *bt_config_list_plugins_create(
05e21286 1578 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1579{
1580 struct bt_config *cfg;
1581
1582 /* Create config */
1583 cfg = bt_config_base_create(BT_CONFIG_COMMAND_LIST_PLUGINS,
1584 initial_plugin_paths, true);
1585 if (!cfg) {
1586 goto error;
1587 }
1588
1589 goto end;
1590
1591error:
65300d60 1592 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1593
1594end:
1595 return cfg;
1596}
1597
1598static
1599struct bt_config *bt_config_help_create(
05e21286 1600 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1601{
1602 struct bt_config *cfg;
1603
1604 /* Create config */
1605 cfg = bt_config_base_create(BT_CONFIG_COMMAND_HELP,
1606 initial_plugin_paths, true);
1607 if (!cfg) {
1608 goto error;
1609 }
1610
1611 cfg->cmd_data.help.cfg_component =
d94d92ac 1612 bt_config_component_create(-1, NULL, NULL);
9009cc24
PP		 1613 if (!cfg->cmd_data.help.cfg_component) {
1614 goto error;
1615 }
1616
1617 goto end;
1618
1619error:
65300d60 1620 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1621
1622end:
1623 return cfg;
1624}
1625
1626static
1627struct bt_config *bt_config_query_create(
05e21286 1628 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1629{
1630 struct bt_config *cfg;
1631
1632 /* Create config */
1633 cfg = bt_config_base_create(BT_CONFIG_COMMAND_QUERY,
1634 initial_plugin_paths, true);
1635 if (!cfg) {
1636 goto error;
1637 }
1638
1639 cfg->cmd_data.query.object = g_string_new(NULL);
1640 if (!cfg->cmd_data.query.object) {
1641 print_err_oom();
1642 goto error;
1643 }
1644
1645 goto end;
1646
1647error:
65300d60 1648 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1649
1650end:
1651 return cfg;
1652}
1653
1654static
1655struct bt_config *bt_config_print_ctf_metadata_create(
05e21286 1656 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1657{
1658 struct bt_config *cfg;
1659
1660 /* Create config */
1661 cfg = bt_config_base_create(BT_CONFIG_COMMAND_PRINT_CTF_METADATA,
1662 initial_plugin_paths, true);
1663 if (!cfg) {
1664 goto error;
1665 }
1666
1667 cfg->cmd_data.print_ctf_metadata.path = g_string_new(NULL);
1668 if (!cfg->cmd_data.print_ctf_metadata.path) {
1669 print_err_oom();
1670 goto error;
1671 }
1672
c327e427
PP		 1673 cfg->cmd_data.print_ctf_metadata.output_path = g_string_new(NULL);
1674 if (!cfg->cmd_data.print_ctf_metadata.output_path) {
1675 print_err_oom();
1676 goto error;
1677 }
1678
9009cc24
PP		 1679 goto end;
1680
1681error:
65300d60 1682 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1683
1684end:
1685 return cfg;
1686}
1687
1688static
1689struct bt_config *bt_config_print_lttng_live_sessions_create(
05e21286 1690 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1691{
1692 struct bt_config *cfg;
1693
1694 /* Create config */
1695 cfg = bt_config_base_create(BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS,
1696 initial_plugin_paths, true);
1697 if (!cfg) {
1698 goto error;
1699 }
1700
1701 cfg->cmd_data.print_lttng_live_sessions.url = g_string_new(NULL);
1702 if (!cfg->cmd_data.print_lttng_live_sessions.url) {
1703 print_err_oom();
1704 goto error;
1705 }
1706
c327e427
PP		 1707 cfg->cmd_data.print_lttng_live_sessions.output_path =
1708 g_string_new(NULL);
1709 if (!cfg->cmd_data.print_lttng_live_sessions.output_path) {
1710 print_err_oom();
1711 goto error;
1712 }
1713
9009cc24
PP		 1714 goto end;
1715
1716error:
65300d60 1717 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1718
1719end:
1720 return cfg;
1721}
1722
1723static
1724int bt_config_append_plugin_paths_check_setuid_setgid(
05e21286 1725 struct bt_value *plugin_paths, const char *arg)
9009cc24
PP		 1726{
1727 int ret = 0;
1728
1729 if (bt_common_is_setuid_setgid()) {
b4565e8b 1730 BT_LOGI_STR("Skipping non-system plugin paths for setuid/setgid binary.");
9009cc24
PP		 1731 goto end;
1732 }
1733
1734 if (bt_config_append_plugin_paths(plugin_paths, arg)) {
1735 printf_err("Invalid --plugin-path option's argument:\n %s\n",
1736 arg);
1737 ret = -1;
1738 goto end;
1739 }
1740
1741end:
1742 return ret;
1743}
1744
1745/*
1746 * Prints the expected format for a --params option.
1747 */
1748static
1749void print_expected_params_format(FILE *fp)
1750{
1751 fprintf(fp, "Expected format of PARAMS\n");
1752 fprintf(fp, "-------------------------\n");
1753 fprintf(fp, "\n");
1754 fprintf(fp, " PARAM=VALUE[,PARAM=VALUE]...\n");
1755 fprintf(fp, "\n");
1756 fprintf(fp, "The parameter string is a comma-separated list of PARAM=VALUE assignments,\n");
1757 fprintf(fp, "where PARAM is the parameter name (C identifier plus the [:.-] characters),\n");
1758 fprintf(fp, "and VALUE can be one of:\n");
1759 fprintf(fp, "\n");
1760 fprintf(fp, "* `null`, `nul`, `NULL`: null value (no backticks).\n");
1761 fprintf(fp, "* `true`, `TRUE`, `yes`, `YES`: true boolean value (no backticks).\n");
1762 fprintf(fp, "* `false`, `FALSE`, `no`, `NO`: false boolean value (no backticks).\n");
1763 fprintf(fp, "* Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal\n");
1764 fprintf(fp, " (`0x` prefix) signed 64-bit integer.\n");
1765 fprintf(fp, "* Double precision floating point number (scientific notation is accepted).\n");
1766 fprintf(fp, "* Unquoted string with no special characters, and not matching any of\n");
1767 fprintf(fp, " the null and boolean value symbols above.\n");
1768 fprintf(fp, "* Double-quoted string (accepts escape characters).\n");
1769 fprintf(fp, "\n");
1770 fprintf(fp, "You can put whitespaces allowed around individual `=` and `,` symbols.\n");
1771 fprintf(fp, "\n");
1772 fprintf(fp, "Example:\n");
1773 fprintf(fp, "\n");
1774 fprintf(fp, " many=null, fresh=yes, condition=false, squirrel=-782329,\n");
1775 fprintf(fp, " observe=3.14, simple=beef, needs-quotes=\"some string\",\n");
1776 fprintf(fp, " escape.chars-are:allowed=\"this is a \\\" double quote\"\n");
1777 fprintf(fp, "\n");
1778 fprintf(fp, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
1779 fprintf(fp, "babeltrace from a shell.\n");
1780}
1781
1782
1783/*
1784 * Prints the help command usage.
1785 */
1786static
1787void print_help_usage(FILE *fp)
1788{
1789 fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] help [OPTIONS] PLUGIN\n");
e5c7cd9b 1790 fprintf(fp, " babeltrace [GENERAL OPTIONS] help [OPTIONS] TYPE.PLUGIN.CLS\n");
9009cc24
PP		 1791 fprintf(fp, "\n");
1792 fprintf(fp, "Options:\n");
1793 fprintf(fp, "\n");
9009cc24
PP		 1794 fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1795 fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n");
1796 fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1797 fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1798 fprintf(fp, " dynamic plugins can be loaded\n");
3efa3052 1799 fprintf(fp, " -h, --help Show this help and quit\n");
9009cc24
PP		 1800 fprintf(fp, "\n");
1801 fprintf(fp, "See `babeltrace --help` for the list of general options.\n");
1802 fprintf(fp, "\n");
1803 fprintf(fp, "Use `babeltrace list-plugins` to show the list of available plugins.\n");
1804}
1805
1806static
1807struct poptOption help_long_options[] = {
1808 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
9009cc24
PP		 1809 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
1810 { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL },
1811 { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL },
1812 { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
9009cc24
PP		 1813 { NULL, 0, '\0', NULL, 0, NULL, NULL },
1814};
1815
1816/*
1817 * Creates a Babeltrace config object from the arguments of a help
1818 * command.
1819 *
1820 * *retcode is set to the appropriate exit code to use.
1821 */
1822static
1823struct bt_config *bt_config_help_from_args(int argc, const char *argv[],
1824 int *retcode, bool force_omit_system_plugin_path,
1825 bool force_omit_home_plugin_path,
05e21286 1826 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1827{
1828 poptContext pc = NULL;
1829 char *arg = NULL;
1830 int opt;
1831 int ret;
1832 struct bt_config *cfg = NULL;
1833 const char *leftover;
1834 char *plugin_name = NULL, *comp_cls_name = NULL;
9009cc24
PP		 1835
1836 *retcode = 0;
1837 cfg = bt_config_help_create(initial_plugin_paths);
1838 if (!cfg) {
1839 goto error;
1840 }
1841
1842 cfg->omit_system_plugin_path = force_omit_system_plugin_path;
1843 cfg->omit_home_plugin_path = force_omit_home_plugin_path;
1844 ret = append_env_var_plugin_paths(cfg->plugin_paths);
1845 if (ret) {
1846 goto error;
1847 }
1848
1849 /* Parse options */
1850 pc = poptGetContext(NULL, argc, (const char **) argv,
1851 help_long_options, 0);
1852 if (!pc) {
1853 printf_err("Cannot get popt context\n");
1854 goto error;
1855 }
1856
1857 poptReadDefaultConfig(pc, 0);
1858
1859 while ((opt = poptGetNextOpt(pc)) > 0) {
1860 arg = poptGetOptArg(pc);
1861
1862 switch (opt) {
1863 case OPT_PLUGIN_PATH:
1864 if (bt_config_append_plugin_paths_check_setuid_setgid(
1865 cfg->plugin_paths, arg)) {
1866 goto error;
1867 }
1868 break;
1869 case OPT_OMIT_SYSTEM_PLUGIN_PATH:
1870 cfg->omit_system_plugin_path = true;
1871 break;
1872 case OPT_OMIT_HOME_PLUGIN_PATH:
1873 cfg->omit_home_plugin_path = true;
1874 break;
9009cc24
PP		 1875 case OPT_HELP:
1876 print_help_usage(stdout);
1877 *retcode = -1;
65300d60 1878 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1879 goto end;
1880 default:
1881 printf_err("Unknown command-line option specified (option code %d)\n",
1882 opt);
1883 goto error;
1884 }
1885
1886 free(arg);
1887 arg = NULL;
1888 }
1889
1890 /* Check for option parsing error */
1891 if (opt < -1) {
1892 printf_err("While parsing command-line options, at option %s: %s\n",
1893 poptBadOption(pc, 0), poptStrerror(opt));
1894 goto error;
1895 }
1896
1897 leftover = poptGetArg(pc);
1898 if (leftover) {
e5c7cd9b 1899 plugin_comp_cls_names(leftover, NULL,
fd5f8053
PP		 1900 &plugin_name, &comp_cls_name,
1901 &cfg->cmd_data.help.cfg_component->type);
9009cc24 1902 if (plugin_name && comp_cls_name) {
e5c7cd9b
PP		 1903 /* Component class help */
1904 g_string_assign(
1905 cfg->cmd_data.help.cfg_component->plugin_name,
9009cc24 1906 plugin_name);
e5c7cd9b
PP		 1907 g_string_assign(
1908 cfg->cmd_data.help.cfg_component->comp_cls_name,
9009cc24
PP		 1909 comp_cls_name);
1910 } else {
e5c7cd9b 1911 /* Fall back to plugin help */
e5c7cd9b
PP		 1912 g_string_assign(
1913 cfg->cmd_data.help.cfg_component->plugin_name,
1914 leftover);
9009cc24 1915 }
e5c7cd9b
PP		 1916 } else {
1917 print_help_usage(stdout);
1918 *retcode = -1;
65300d60 1919 BT_OBJECT_PUT_REF_AND_RESET(cfg);
e5c7cd9b 1920 goto end;
9009cc24
PP		 1921 }
1922
1923 if (append_home_and_system_plugin_paths_cfg(cfg)) {
1924 goto error;
1925 }
1926
1927 goto end;
1928
1929error:
1930 *retcode = 1;
65300d60 1931 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 1932
1933end:
9009cc24
PP		 1934 g_free(plugin_name);
1935 g_free(comp_cls_name);
1936
1937 if (pc) {
1938 poptFreeContext(pc);
1939 }
1940
1941 free(arg);
1942 return cfg;
1943}
1944
1945/*
1946 * Prints the help command usage.
1947 */
1948static
1949void print_query_usage(FILE *fp)
1950{
7b1e06a1 1951 fprintf(fp, "Usage: babeltrace [GEN OPTS] query [OPTS] TYPE.PLUGIN.CLS OBJECT\n");
9009cc24
PP		 1952 fprintf(fp, "\n");
1953 fprintf(fp, "Options:\n");
1954 fprintf(fp, "\n");
9009cc24
PP		 1955 fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
1956 fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n");
1957 fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
1958 fprintf(fp, " -p, --params=PARAMS Set the query parameters to PARAMS\n");
1959 fprintf(fp, " (see the expected format of PARAMS below)\n");
1960 fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
1961 fprintf(fp, " dynamic plugins can be loaded\n");
3efa3052 1962 fprintf(fp, " -h, --help Show this help and quit\n");
9009cc24
PP		 1963 fprintf(fp, "\n\n");
1964 print_expected_params_format(fp);
1965}
1966
1967static
1968struct poptOption query_long_options[] = {
1969 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
9009cc24
PP		 1970 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
1971 { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL },
1972 { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL },
1973 { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL },
1974 { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
9009cc24
PP		 1975 { NULL, 0, '\0', NULL, 0, NULL, NULL },
1976};
1977
1978/*
1979 * Creates a Babeltrace config object from the arguments of a query
1980 * command.
1981 *
1982 * *retcode is set to the appropriate exit code to use.
1983 */
1984static
1985struct bt_config *bt_config_query_from_args(int argc, const char *argv[],
1986 int *retcode, bool force_omit_system_plugin_path,
1987 bool force_omit_home_plugin_path,
05e21286 1988 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 1989{
1990 poptContext pc = NULL;
1991 char *arg = NULL;
1992 int opt;
1993 int ret;
1994 struct bt_config *cfg = NULL;
1995 const char *leftover;
05e21286 1996 struct bt_value *params = bt_value_null;
9009cc24
PP		 1997
1998 *retcode = 0;
1999 cfg = bt_config_query_create(initial_plugin_paths);
2000 if (!cfg) {
2001 goto error;
2002 }
2003
2004 cfg->omit_system_plugin_path = force_omit_system_plugin_path;
2005 cfg->omit_home_plugin_path = force_omit_home_plugin_path;
2006 ret = append_env_var_plugin_paths(cfg->plugin_paths);
2007 if (ret) {
2008 goto error;
2009 }
2010
2011 /* Parse options */
2012 pc = poptGetContext(NULL, argc, (const char **) argv,
2013 query_long_options, 0);
2014 if (!pc) {
2015 printf_err("Cannot get popt context\n");
2016 goto error;
2017 }
2018
2019 poptReadDefaultConfig(pc, 0);
2020
2021 while ((opt = poptGetNextOpt(pc)) > 0) {
2022 arg = poptGetOptArg(pc);
2023
2024 switch (opt) {
2025 case OPT_PLUGIN_PATH:
2026 if (bt_config_append_plugin_paths_check_setuid_setgid(
2027 cfg->plugin_paths, arg)) {
2028 goto error;
2029 }
2030 break;
2031 case OPT_OMIT_SYSTEM_PLUGIN_PATH:
2032 cfg->omit_system_plugin_path = true;
2033 break;
2034 case OPT_OMIT_HOME_PLUGIN_PATH:
2035 cfg->omit_home_plugin_path = true;
2036 break;
9009cc24
PP		 2037 case OPT_PARAMS:
2038 {
65300d60 2039 bt_object_put_ref(params);
05e21286 2040 params = bt_value_from_arg(arg);
9009cc24
PP		 2041 if (!params) {
2042 printf_err("Invalid format for --params option's argument:\n %s\n",
2043 arg);
2044 goto error;
2045 }
2046 break;
2047 }
2048 case OPT_HELP:
2049 print_query_usage(stdout);
2050 *retcode = -1;
65300d60 2051 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2052 goto end;
2053 default:
2054 printf_err("Unknown command-line option specified (option code %d)\n",
2055 opt);
2056 goto error;
2057 }
2058
2059 free(arg);
2060 arg = NULL;
2061 }
2062
9009cc24
PP		 2063 /* Check for option parsing error */
2064 if (opt < -1) {
2065 printf_err("While parsing command-line options, at option %s: %s\n",
2066 poptBadOption(pc, 0), poptStrerror(opt));
2067 goto error;
2068 }
2069
2070 /*
7b1e06a1
PP		 2071 * We need exactly two leftover arguments which are the
2072 * mandatory component class specification and query object.
9009cc24 2073 */
7b1e06a1
PP		 2074 leftover = poptGetArg(pc);
2075 if (leftover) {
2076 cfg->cmd_data.query.cfg_component =
2077 bt_config_component_from_arg(leftover);
2078 if (!cfg->cmd_data.query.cfg_component) {
2079 printf_err("Invalid format for component class specification:\n %s\n",
2080 leftover);
2081 goto error;
2082 }
2083
f6ccaed9 2084 BT_ASSERT(params);
da91b29a
PP		 2085 BT_OBJECT_MOVE_REF(cfg->cmd_data.query.cfg_component->params,
2086 params);
7b1e06a1
PP		 2087 } else {
2088 print_query_usage(stdout);
2089 *retcode = -1;
65300d60 2090 BT_OBJECT_PUT_REF_AND_RESET(cfg);
7b1e06a1
PP		 2091 goto end;
2092 }
2093
9009cc24
PP		 2094 leftover = poptGetArg(pc);
2095 if (leftover) {
2096 if (strlen(leftover) == 0) {
2097 printf_err("Invalid empty object\n");
2098 goto error;
2099 }
2100
2101 g_string_assign(cfg->cmd_data.query.object, leftover);
2102 } else {
2103 print_query_usage(stdout);
2104 *retcode = -1;
65300d60 2105 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2106 goto end;
2107 }
2108
2109 leftover = poptGetArg(pc);
2110 if (leftover) {
2111 printf_err("Unexpected argument: %s\n", leftover);
2112 goto error;
2113 }
2114
2115 if (append_home_and_system_plugin_paths_cfg(cfg)) {
2116 goto error;
2117 }
2118
2119 goto end;
2120
2121error:
2122 *retcode = 1;
65300d60 2123 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2124
2125end:
2126 if (pc) {
2127 poptFreeContext(pc);
2128 }
2129
65300d60 2130 bt_object_put_ref(params);
9009cc24
PP		 2131 free(arg);
2132 return cfg;
2133}
2134
2135/*
2136 * Prints the list-plugins command usage.
2137 */
2138static
2139void print_list_plugins_usage(FILE *fp)
2140{
2141 fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] list-plugins [OPTIONS]\n");
2142 fprintf(fp, "\n");
2143 fprintf(fp, "Options:\n");
2144 fprintf(fp, "\n");
2145 fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2146 fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n");
2147 fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2148 fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2149 fprintf(fp, " dynamic plugins can be loaded\n");
3efa3052 2150 fprintf(fp, " -h, --help Show this help and quit\n");
9009cc24
PP		 2151 fprintf(fp, "\n");
2152 fprintf(fp, "See `babeltrace --help` for the list of general options.\n");
2153 fprintf(fp, "\n");
2154 fprintf(fp, "Use `babeltrace help` to get help for a specific plugin or component class.\n");
2155}
2156
2157static
2158struct poptOption list_plugins_long_options[] = {
2159 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2160 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
2161 { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL },
2162 { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL },
2163 { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
2164 { NULL, 0, '\0', NULL, 0, NULL, NULL },
2165};
2166
2167/*
2168 * Creates a Babeltrace config object from the arguments of a
2169 * list-plugins command.
2170 *
2171 * *retcode is set to the appropriate exit code to use.
2172 */
2173static
2174struct bt_config *bt_config_list_plugins_from_args(int argc, const char *argv[],
2175 int *retcode, bool force_omit_system_plugin_path,
2176 bool force_omit_home_plugin_path,
05e21286 2177 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 2178{
2179 poptContext pc = NULL;
2180 char *arg = NULL;
2181 int opt;
2182 int ret;
2183 struct bt_config *cfg = NULL;
2184 const char *leftover;
2185
2186 *retcode = 0;
2187 cfg = bt_config_list_plugins_create(initial_plugin_paths);
2188 if (!cfg) {
2189 goto error;
2190 }
2191
2192 cfg->omit_system_plugin_path = force_omit_system_plugin_path;
2193 cfg->omit_home_plugin_path = force_omit_home_plugin_path;
2194 ret = append_env_var_plugin_paths(cfg->plugin_paths);
2195 if (ret) {
2196 goto error;
2197 }
2198
2199 /* Parse options */
2200 pc = poptGetContext(NULL, argc, (const char **) argv,
2201 list_plugins_long_options, 0);
2202 if (!pc) {
2203 printf_err("Cannot get popt context\n");
2204 goto error;
2205 }
2206
2207 poptReadDefaultConfig(pc, 0);
2208
2209 while ((opt = poptGetNextOpt(pc)) > 0) {
2210 arg = poptGetOptArg(pc);
2211
2212 switch (opt) {
2213 case OPT_PLUGIN_PATH:
2214 if (bt_config_append_plugin_paths_check_setuid_setgid(
2215 cfg->plugin_paths, arg)) {
2216 goto error;
2217 }
2218 break;
2219 case OPT_OMIT_SYSTEM_PLUGIN_PATH:
2220 cfg->omit_system_plugin_path = true;
2221 break;
2222 case OPT_OMIT_HOME_PLUGIN_PATH:
2223 cfg->omit_home_plugin_path = true;
2224 break;
2225 case OPT_HELP:
2226 print_list_plugins_usage(stdout);
2227 *retcode = -1;
65300d60 2228 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2229 goto end;
2230 default:
2231 printf_err("Unknown command-line option specified (option code %d)\n",
2232 opt);
2233 goto error;
2234 }
2235
2236 free(arg);
2237 arg = NULL;
2238 }
2239
2240 /* Check for option parsing error */
2241 if (opt < -1) {
2242 printf_err("While parsing command-line options, at option %s: %s\n",
2243 poptBadOption(pc, 0), poptStrerror(opt));
2244 goto error;
2245 }
2246
2247 leftover = poptGetArg(pc);
2248 if (leftover) {
2249 printf_err("Unexpected argument: %s\n", leftover);
2250 goto error;
2251 }
2252
2253 if (append_home_and_system_plugin_paths_cfg(cfg)) {
2254 goto error;
2255 }
2256
2257 goto end;
2258
2259error:
2260 *retcode = 1;
65300d60 2261 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2262
2263end:
2264 if (pc) {
2265 poptFreeContext(pc);
2266 }
2267
2268 free(arg);
2269 return cfg;
2270}
2271
2272/*
2273 * Prints the run command usage.
2274 */
2275static
2276void print_run_usage(FILE *fp)
2277{
2278 fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] run [OPTIONS]\n");
2279 fprintf(fp, "\n");
2280 fprintf(fp, "Options:\n");
2281 fprintf(fp, "\n");
2282 fprintf(fp, " -b, --base-params=PARAMS Set PARAMS as the current base parameters\n");
2283 fprintf(fp, " for all the following components until\n");
2284 fprintf(fp, " --reset-base-params is encountered\n");
2285 fprintf(fp, " (see the expected format of PARAMS below)\n");
fd5f8053
PP		 2286 fprintf(fp, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2287 fprintf(fp, " Instantiate the component class CLS of type\n");
2288 fprintf(fp, " TYPE (`source`, `filter`, or `sink`) found\n");
2289 fprintf(fp, " in the plugin PLUGIN, add it to the graph,\n");
2290 fprintf(fp, " and optionally name it NAME (you can also\n");
2291 fprintf(fp, " specify the name with --name)\n");
2292 fprintf(fp, " -C, --connect=CONNECTION Connect two created components (see the\n");
9009cc24 2293 fprintf(fp, " expected format of CONNECTION below)\n");
9009cc24
PP		 2294 fprintf(fp, " --key=KEY Set the current initialization string\n");
2295 fprintf(fp, " parameter key to KEY (see --value)\n");
2296 fprintf(fp, " -n, --name=NAME Set the name of the current component\n");
2297 fprintf(fp, " to NAME (must be unique amongst all the\n");
2298 fprintf(fp, " names of the created components)\n");
2299 fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2300 fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n");
2301 fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2302 fprintf(fp, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2303 fprintf(fp, " current component (see the expected format\n");
2304 fprintf(fp, " of PARAMS below)\n");
2305 fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2306 fprintf(fp, " dynamic plugins can be loaded\n");
2307 fprintf(fp, " -r, --reset-base-params Reset the current base parameters to an\n");
2308 fprintf(fp, " empty map\n");
2309 fprintf(fp, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n");
2310 fprintf(fp, " the graph later, retry in DUR µs\n");
2311 fprintf(fp, " (default: 100000)\n");
9009cc24
PP		 2312 fprintf(fp, " --value=VAL Add a string initialization parameter to\n");
2313 fprintf(fp, " the current component with a name given by\n");
2314 fprintf(fp, " the last argument of the --key option and a\n");
2315 fprintf(fp, " value set to VAL\n");
3efa3052 2316 fprintf(fp, " -h, --help Show this help and quit\n");
9009cc24
PP		 2317 fprintf(fp, "\n");
2318 fprintf(fp, "See `babeltrace --help` for the list of general options.\n");
2319 fprintf(fp, "\n\n");
2320 fprintf(fp, "Expected format of CONNECTION\n");
2321 fprintf(fp, "-----------------------------\n");
2322 fprintf(fp, "\n");
2323 fprintf(fp, " UPSTREAM[.UPSTREAM-PORT]:DOWNSTREAM[.DOWNSTREAM-PORT]\n");
2324 fprintf(fp, "\n");
2325 fprintf(fp, "UPSTREAM and DOWNSTREAM are names of the upstream and downstream\n");
2326 fprintf(fp, "components to connect together. You must escape the following characters\n\n");
2327 fprintf(fp, "with `\\`: `\\`, `.`, and `:`. You can set the name of the current\n");
2328 fprintf(fp, "component with the --name option.\n");
2329 fprintf(fp, "\n");
2330 fprintf(fp, "UPSTREAM-PORT and DOWNSTREAM-PORT are optional globbing patterns to\n");
2331 fprintf(fp, "identify the upstream and downstream ports to use for the connection.\n");
2332 fprintf(fp, "When the port is not specified, `*` is used.\n");
2333 fprintf(fp, "\n");
2334 fprintf(fp, "When a component named UPSTREAM has an available port which matches the\n");
2335 fprintf(fp, "UPSTREAM-PORT globbing pattern, it is connected to the first port which\n");
2336 fprintf(fp, "matches the DOWNSTREAM-PORT globbing pattern of the component named\n");
2337 fprintf(fp, "DOWNSTREAM.\n");
2338 fprintf(fp, "\n");
2339 fprintf(fp, "The only special character in UPSTREAM-PORT and DOWNSTREAM-PORT is `*`\n");
2340 fprintf(fp, "which matches anything. You must escape the following characters\n");
2341 fprintf(fp, "with `\\`: `\\`, `*`, `?`, `[`, `.`, and `:`.\n");
2342 fprintf(fp, "\n");
2343 fprintf(fp, "You can connect a source component to a filter or sink component. You\n");
2344 fprintf(fp, "can connect a filter component to a sink component.\n");
2345 fprintf(fp, "\n");
2346 fprintf(fp, "Examples:\n");
2347 fprintf(fp, "\n");
2348 fprintf(fp, " my-src:my-sink\n");
2349 fprintf(fp, " ctf-fs.*stream*:utils-muxer:*\n");
2350 fprintf(fp, "\n");
2351 fprintf(fp, "IMPORTANT: Make sure to single-quote the whole argument when you run\n");
2352 fprintf(fp, "babeltrace from a shell.\n");
2353 fprintf(fp, "\n\n");
2354 print_expected_params_format(fp);
2355}
2356
2357/*
2358 * Creates a Babeltrace config object from the arguments of a run
2359 * command.
2360 *
2361 * *retcode is set to the appropriate exit code to use.
2362 */
2363static
2364struct bt_config *bt_config_run_from_args(int argc, const char *argv[],
2365 int *retcode, bool force_omit_system_plugin_path,
2366 bool force_omit_home_plugin_path,
05e21286 2367 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 2368{
2369 poptContext pc = NULL;
2370 char *arg = NULL;
2371 struct bt_config_component *cur_cfg_comp = NULL;
0a011c88
JG		 2372 enum bt_config_component_dest cur_cfg_comp_dest =
2373 BT_CONFIG_COMPONENT_DEST_UNKNOWN;
05e21286 2374 struct bt_value *cur_base_params = NULL;
9009cc24
PP		 2375 int opt, ret = 0;
2376 struct bt_config *cfg = NULL;
05e21286
PP		 2377 struct bt_value *instance_names = NULL;
2378 struct bt_value *connection_args = NULL;
9009cc24
PP		 2379 GString *cur_param_key = NULL;
2380 char error_buf[256] = { 0 };
c0521175 2381 long retry_duration = -1;
601b0d3c 2382 enum bt_value_status status;
9009cc24
PP		 2383 struct poptOption run_long_options[] = {
2384 { "base-params", 'b', POPT_ARG_STRING, NULL, OPT_BASE_PARAMS, NULL, NULL },
fd5f8053
PP		 2385 { "component", 'c', POPT_ARG_STRING, NULL, OPT_COMPONENT, NULL, NULL },
2386 { "connect", 'C', POPT_ARG_STRING, NULL, OPT_CONNECT, NULL, NULL },
9009cc24
PP		 2387 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
2388 { "key", '\0', POPT_ARG_STRING, NULL, OPT_KEY, NULL, NULL },
2389 { "name", 'n', POPT_ARG_STRING, NULL, OPT_NAME, NULL, NULL },
2390 { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL },
2391 { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL },
2392 { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL },
2393 { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
2394 { "reset-base-params", 'r', POPT_ARG_NONE, NULL, OPT_RESET_BASE_PARAMS, NULL, NULL },
c0521175 2395 { "retry-duration", '\0', POPT_ARG_LONG, &retry_duration, OPT_RETRY_DURATION, NULL, NULL },
9009cc24
PP		 2396 { "value", '\0', POPT_ARG_STRING, NULL, OPT_VALUE, NULL, NULL },
2397 { NULL, 0, '\0', NULL, 0, NULL, NULL },
2398 };
2399
2400 *retcode = 0;
2401 cur_param_key = g_string_new(NULL);
2402 if (!cur_param_key) {
2403 print_err_oom();
2404 goto error;
2405 }
2406
2407 if (argc <= 1) {
2408 print_run_usage(stdout);
2409 *retcode = -1;
2410 goto end;
2411 }
2412
2413 cfg = bt_config_run_create(initial_plugin_paths);
2414 if (!cfg) {
2415 goto error;
2416 }
2417
2418 cfg->cmd_data.run.retry_duration_us = 100000;
2419 cfg->omit_system_plugin_path = force_omit_system_plugin_path;
2420 cfg->omit_home_plugin_path = force_omit_home_plugin_path;
05e21286 2421 cur_base_params = bt_value_map_create();
9009cc24
PP		 2422 if (!cur_base_params) {
2423 print_err_oom();
2424 goto error;
2425 }
2426
05e21286 2427 instance_names = bt_value_map_create();
9009cc24
PP		 2428 if (!instance_names) {
2429 print_err_oom();
2430 goto error;
2431 }
2432
05e21286 2433 connection_args = bt_value_array_create();
9009cc24
PP		 2434 if (!connection_args) {
2435 print_err_oom();
2436 goto error;
2437 }
2438
2439 ret = append_env_var_plugin_paths(cfg->plugin_paths);
2440 if (ret) {
2441 goto error;
2442 }
2443
2444 /* Parse options */
2445 pc = poptGetContext(NULL, argc, (const char **) argv,
2446 run_long_options, 0);
2447 if (!pc) {
2448 printf_err("Cannot get popt context\n");
2449 goto error;
2450 }
2451
2452 poptReadDefaultConfig(pc, 0);
2453
2454 while ((opt = poptGetNextOpt(pc)) > 0) {
2455 arg = poptGetOptArg(pc);
2456
2457 switch (opt) {
2458 case OPT_PLUGIN_PATH:
2459 if (bt_config_append_plugin_paths_check_setuid_setgid(
2460 cfg->plugin_paths, arg)) {
2461 goto error;
2462 }
2463 break;
2464 case OPT_OMIT_SYSTEM_PLUGIN_PATH:
2465 cfg->omit_system_plugin_path = true;
2466 break;
2467 case OPT_OMIT_HOME_PLUGIN_PATH:
2468 cfg->omit_home_plugin_path = true;
2469 break;
fd5f8053 2470 case OPT_COMPONENT:
9009cc24 2471 {
9009cc24 2472 enum bt_config_component_dest new_dest;
9009cc24
PP		 2473
2474 if (cur_cfg_comp) {
2475 ret = add_run_cfg_comp_check_name(cfg,
2476 cur_cfg_comp, cur_cfg_comp_dest,
2477 instance_names);
65300d60 2478 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
9009cc24
PP		 2479 if (ret) {
2480 goto error;
2481 }
2482 }
2483
fd5f8053 2484 cur_cfg_comp = bt_config_component_from_arg(arg);
9009cc24 2485 if (!cur_cfg_comp) {
fd5f8053
PP		 2486 printf_err("Invalid format for --component option's argument:\n %s\n",
2487 arg);
9009cc24
PP		 2488 goto error;
2489 }
2490
fd5f8053
PP		 2491 switch (cur_cfg_comp->type) {
2492 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2493 new_dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
2494 break;
2495 case BT_COMPONENT_CLASS_TYPE_FILTER:
2496 new_dest = BT_CONFIG_COMPONENT_DEST_FILTER;
2497 break;
2498 case BT_COMPONENT_CLASS_TYPE_SINK:
2499 new_dest = BT_CONFIG_COMPONENT_DEST_SINK;
2500 break;
2501 default:
2502 abort();
2503 }
2504
f6ccaed9 2505 BT_ASSERT(cur_base_params);
65300d60 2506 bt_object_put_ref(cur_cfg_comp->params);
601b0d3c
PP		 2507 status = bt_value_copy(
2508 &cur_cfg_comp->params,
05e21286 2509 cur_base_params);
601b0d3c 2510 if (status != BT_VALUE_STATUS_OK) {
9009cc24
PP		 2511 print_err_oom();
2512 goto error;
2513 }
2514
2515 cur_cfg_comp_dest = new_dest;
2516 break;
2517 }
2518 case OPT_PARAMS:
2519 {
05e21286
PP		 2520 struct bt_value *params;
2521 struct bt_value *params_to_set;
9009cc24
PP		 2522
2523 if (!cur_cfg_comp) {
2524 printf_err("Cannot add parameters to unavailable component:\n %s\n",
2525 arg);
2526 goto error;
2527 }
2528
05e21286 2529 params = bt_value_from_arg(arg);
9009cc24
PP		 2530 if (!params) {
2531 printf_err("Invalid format for --params option's argument:\n %s\n",
2532 arg);
2533 goto error;
2534 }
2535
35294e83
PP		 2536 status = bt_value_map_extend(cur_cfg_comp->params,
2537 params, &params_to_set);
65300d60 2538 BT_OBJECT_PUT_REF_AND_RESET(params);
601b0d3c 2539 if (status != BT_VALUE_STATUS_OK) {
9009cc24
PP		 2540 printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n",
2541 arg);
2542 goto error;
2543 }
2544
65300d60 2545 BT_OBJECT_MOVE_REF(cur_cfg_comp->params, params_to_set);
9009cc24
PP		 2546 break;
2547 }
2548 case OPT_KEY:
2549 if (strlen(arg) == 0) {
2550 printf_err("Cannot set an empty string as the current parameter key\n");
2551 goto error;
2552 }
2553
2554 g_string_assign(cur_param_key, arg);
2555 break;
2556 case OPT_VALUE:
2557 if (!cur_cfg_comp) {
2558 printf_err("Cannot set a parameter's value of unavailable component:\n %s\n",
2559 arg);
2560 goto error;
2561 }
2562
2563 if (cur_param_key->len == 0) {
2564 printf_err("--value option specified without preceding --key option:\n %s\n",
2565 arg);
2566 goto error;
2567 }
2568
05e21286 2569 if (bt_value_map_insert_string_entry(cur_cfg_comp->params,
9009cc24
PP		 2570 cur_param_key->str, arg)) {
2571 print_err_oom();
2572 goto error;
2573 }
2574 break;
2575 case OPT_NAME:
2576 if (!cur_cfg_comp) {
2577 printf_err("Cannot set the name of unavailable component:\n %s\n",
2578 arg);
2579 goto error;
2580 }
2581
2582 g_string_assign(cur_cfg_comp->instance_name, arg);
2583 break;
2584 case OPT_BASE_PARAMS:
2585 {
05e21286
PP		 2586 struct bt_value *params =
2587 bt_value_from_arg(arg);
9009cc24
PP		 2588
2589 if (!params) {
2590 printf_err("Invalid format for --base-params option's argument:\n %s\n",
2591 arg);
2592 goto error;
2593 }
2594
65300d60 2595 BT_OBJECT_MOVE_REF(cur_base_params, params);
9009cc24
PP		 2596 break;
2597 }
2598 case OPT_RESET_BASE_PARAMS:
65300d60 2599 BT_OBJECT_PUT_REF_AND_RESET(cur_base_params);
05e21286 2600 cur_base_params = bt_value_map_create();
9009cc24
PP		 2601 if (!cur_base_params) {
2602 print_err_oom();
2603 goto error;
2604 }
2605 break;
2606 case OPT_CONNECT:
05e21286 2607 if (bt_value_array_append_string_element(
07208d85 2608 connection_args, arg)) {
9009cc24
PP		 2609 print_err_oom();
2610 goto error;
2611 }
2612 break;
2613 case OPT_RETRY_DURATION:
2614 if (retry_duration < 0) {
5b70610d 2615 printf_err("--retry-duration option's argument must be positive or 0: %ld\n",
9009cc24
PP		 2616 retry_duration);
2617 goto error;
2618 }
2619
2620 cfg->cmd_data.run.retry_duration_us =
2621 (uint64_t) retry_duration;
2622 break;
2623 case OPT_HELP:
2624 print_run_usage(stdout);
2625 *retcode = -1;
65300d60 2626 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2627 goto end;
2628 default:
2629 printf_err("Unknown command-line option specified (option code %d)\n",
2630 opt);
2631 goto error;
2632 }
2633
2634 free(arg);
2635 arg = NULL;
2636 }
2637
2638 /* Check for option parsing error */
2639 if (opt < -1) {
2640 printf_err("While parsing command-line options, at option %s: %s\n",
2641 poptBadOption(pc, 0), poptStrerror(opt));
2642 goto error;
2643 }
2644
2645 /* This command does not accept leftover arguments */
2646 if (poptPeekArg(pc)) {
2647 printf_err("Unexpected argument: %s\n", poptPeekArg(pc));
2648 goto error;
2649 }
2650
2651 /* Add current component */
2652 if (cur_cfg_comp) {
2653 ret = add_run_cfg_comp_check_name(cfg, cur_cfg_comp,
2654 cur_cfg_comp_dest, instance_names);
65300d60 2655 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
9009cc24
PP		 2656 if (ret) {
2657 goto error;
2658 }
2659 }
2660
2661 if (cfg->cmd_data.run.sources->len == 0) {
2662 printf_err("Incomplete graph: no source component\n");
2663 goto error;
2664 }
2665
2666 if (cfg->cmd_data.run.sinks->len == 0) {
2667 printf_err("Incomplete graph: no sink component\n");
2668 goto error;
2669 }
2670
2671 if (append_home_and_system_plugin_paths_cfg(cfg)) {
2672 goto error;
2673 }
2674
da91b29a 2675 ret = bt_config_cli_args_create_connections(cfg,
05e21286 2676 connection_args,
9009cc24
PP		 2677 error_buf, 256);
2678 if (ret) {
2679 printf_err("Cannot creation connections:\n%s", error_buf);
2680 goto error;
2681 }
2682
2683 goto end;
2684
2685error:
2686 *retcode = 1;
65300d60 2687 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 2688
2689end:
2690 if (pc) {
2691 poptFreeContext(pc);
2692 }
2693
2694 if (cur_param_key) {
2695 g_string_free(cur_param_key, TRUE);
2696 }
2697
2698 free(arg);
65300d60
PP		 2699 BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp);
2700 BT_OBJECT_PUT_REF_AND_RESET(cur_base_params);
2701 BT_OBJECT_PUT_REF_AND_RESET(instance_names);
2702 BT_OBJECT_PUT_REF_AND_RESET(connection_args);
9009cc24
PP		 2703 return cfg;
2704}
2705
2706static
05e21286 2707struct bt_config *bt_config_run_from_args_array(const struct bt_value *run_args,
9009cc24
PP		 2708 int *retcode, bool force_omit_system_plugin_path,
2709 bool force_omit_home_plugin_path,
05e21286 2710 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 2711{
2712 struct bt_config *cfg = NULL;
2713 const char **argv;
0ca8409d 2714 int64_t i, len;
07208d85 2715 const size_t argc = bt_value_array_get_size(run_args) + 1;
9009cc24
PP		 2716
2717 argv = calloc(argc, sizeof(*argv));
2718 if (!argv) {
2719 print_err_oom();
2720 goto end;
2721 }
2722
2723 argv[0] = "run";
2724
07208d85 2725 len = bt_value_array_get_size(run_args);
0ca8409d
MD		 2726 if (len < 0) {
2727 printf_err("Invalid executable arguments\n");
2728 goto end;
2729 }
2730 for (i = 0; i < len; i++) {
05e21286
PP		 2731 const struct bt_value *arg_value =
2732 bt_value_array_borrow_element_by_index_const(run_args,
2733 i);
9009cc24
PP		 2734 const char *arg;
2735
f6ccaed9 2736 BT_ASSERT(arg_value);
601b0d3c 2737 arg = bt_value_string_get(arg_value);
f6ccaed9 2738 BT_ASSERT(arg);
9009cc24 2739 argv[i + 1] = arg;
9009cc24
PP		 2740 }
2741
2742 cfg = bt_config_run_from_args(argc, argv, retcode,
2743 force_omit_system_plugin_path, force_omit_home_plugin_path,
2744 initial_plugin_paths);
2745
2746end:
2747 free(argv);
2748 return cfg;
2749}
2750
2751/*
2752 * Prints the convert command usage.
2753 */
2754static
2755void print_convert_usage(FILE *fp)
2756{
2757 fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n");
2758 fprintf(fp, "\n");
2759 fprintf(fp, "Options:\n");
2760 fprintf(fp, "\n");
fd5f8053
PP		 2761 fprintf(fp, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n");
2762 fprintf(fp, " Instantiate the component class CLS of type\n");
2763 fprintf(fp, " TYPE (`source`, `filter`, or `sink`) found\n");
2764 fprintf(fp, " in the plugin PLUGIN, add it to the\n");
2765 fprintf(fp, " conversion graph, and optionally name it\n");
2766 fprintf(fp, " NAME (you can also specify the name with\n");
2767 fprintf(fp, " --name)\n");
9009cc24
PP		 2768 fprintf(fp, " --name=NAME Set the name of the current component\n");
2769 fprintf(fp, " to NAME (must be unique amongst all the\n");
2770 fprintf(fp, " names of the created components)\n");
2771 fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n");
2772 fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n");
2773 fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n");
2774 fprintf(fp, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n");
2775 fprintf(fp, " current component (see the expected format\n");
2776 fprintf(fp, " of PARAMS below)\n");
2777 fprintf(fp, " -P, --path=PATH Set the `path` string parameter of the\n");
2778 fprintf(fp, " current component to PATH\n");
2779 fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n");
2780 fprintf(fp, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n");
2781 fprintf(fp, " the graph later, retry in DUR µs\n");
2782 fprintf(fp, " (default: 100000)\n");
2783 fprintf(fp, " dynamic plugins can be loaded\n");
2784 fprintf(fp, " --run-args Print the equivalent arguments for the\n");
2785 fprintf(fp, " `run` command to the standard output,\n");
2786 fprintf(fp, " formatted for a shell, and quit\n");
2787 fprintf(fp, " --run-args-0 Print the equivalent arguments for the\n");
2788 fprintf(fp, " `run` command to the standard output,\n");
2789 fprintf(fp, " formatted for `xargs -0`, and quit\n");
8ed0bf10
PP		 2790 fprintf(fp, " --stream-intersection Only process events when all streams\n");
2791 fprintf(fp, " are active\n");
9009cc24
PP		 2792 fprintf(fp, " -u, --url=URL Set the `url` string parameter of the\n");
2793 fprintf(fp, " current component to URL\n");
3efa3052 2794 fprintf(fp, " -h, --help Show this help and quit\n");
9009cc24 2795 fprintf(fp, "\n");
e7ad156c 2796 fprintf(fp, "Implicit `source.ctf.fs` component options:\n");
9009cc24
PP		 2797 fprintf(fp, "\n");
2798 fprintf(fp, " --clock-offset=SEC Set clock offset to SEC seconds\n");
2799 fprintf(fp, " --clock-offset-ns=NS Set clock offset to NS ns\n");
9009cc24 2800 fprintf(fp, "\n");
e7ad156c 2801 fprintf(fp, "Implicit `sink.text.pretty` component options:\n");
9009cc24
PP		 2802 fprintf(fp, "\n");
2803 fprintf(fp, " --clock-cycles Print timestamps in clock cycles\n");
2804 fprintf(fp, " --clock-date Print timestamp dates\n");
2805 fprintf(fp, " --clock-gmt Print and parse timestamps in the GMT\n");
2806 fprintf(fp, " time zone instead of the local time zone\n");
2807 fprintf(fp, " --clock-seconds Print the timestamps as `SEC.NS` instead\n");
2808 fprintf(fp, " of `hh:mm:ss.nnnnnnnnn`\n");
2809 fprintf(fp, " --color=(never | auto | always)\n");
2810 fprintf(fp, " Never, automatically, or always emit\n");
2811 fprintf(fp, " console color codes\n");
2812 fprintf(fp, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n");
2813 fprintf(fp, " `all`, `trace`, `trace:hostname`,\n");
2814 fprintf(fp, " `trace:domain`, `trace:procname`,\n");
2815 fprintf(fp, " `trace:vpid`, `loglevel`, `emf`\n");
2816 fprintf(fp, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n");
2817 fprintf(fp, " `payload` (or `arg` or `args`), `none`,\n");
2818 fprintf(fp, " `all`, `scope`, `header`, `context`\n");
2819 fprintf(fp, " (or `ctx`)\n");
2820 fprintf(fp, " --no-delta Do not print time delta between\n");
2821 fprintf(fp, " consecutive events\n");
2822 fprintf(fp, " -w, --output=PATH Write output text to PATH instead of\n");
2823 fprintf(fp, " the standard output\n");
2824 fprintf(fp, "\n");
e7ad156c 2825 fprintf(fp, "Implicit `filter.utils.muxer` component options:\n");
9009cc24
PP		 2826 fprintf(fp, "\n");
2827 fprintf(fp, " --clock-force-correlate Assume that clocks are inherently\n");
2828 fprintf(fp, " correlated across traces\n");
2829 fprintf(fp, "\n");
e7ad156c 2830 fprintf(fp, "Implicit `filter.utils.trimmer` component options:\n");
9009cc24
PP		 2831 fprintf(fp, "\n");
2832 fprintf(fp, " -b, --begin=BEGIN Set the beginning time of the conversion\n");
2833 fprintf(fp, " time range to BEGIN (see the format of\n");
2834 fprintf(fp, " BEGIN below)\n");
2835 fprintf(fp, " -e, --end=END Set the end time of the conversion time\n");
2836 fprintf(fp, " range to END (see the format of END below)\n");
2837 fprintf(fp, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n");
2838 fprintf(fp, " BEGIN,END or [BEGIN,END] (literally `[` and\n");
2839 fprintf(fp, " `]`) (see the format of BEGIN/END below)\n");
2840 fprintf(fp, "\n");
e7ad156c 2841 fprintf(fp, "Implicit `filter.lttng-utils.debug-info` component options:\n");
9009cc24 2842 fprintf(fp, "\n");
9a16feea
PP		 2843 fprintf(fp, " --debug-info Create an implicit\n");
2844 fprintf(fp, " `filter.lttng-utils.debug-info` component\n");
9009cc24
PP		 2845 fprintf(fp, " --debug-info-dir=DIR Search for debug info in directory DIR\n");
2846 fprintf(fp, " instead of `/usr/lib/debug`\n");
2847 fprintf(fp, " --debug-info-full-path Show full debug info source and\n");
2848 fprintf(fp, " binary paths instead of just names\n");
2849 fprintf(fp, " --debug-info-target-prefix=DIR\n");
2850 fprintf(fp, " Use directory DIR as a prefix when\n");
2851 fprintf(fp, " looking up executables during debug\n");
2852 fprintf(fp, " info analysis\n");
9009cc24
PP		 2853 fprintf(fp, "\n");
2854 fprintf(fp, "Legacy options that still work:\n");
2855 fprintf(fp, "\n");
2856 fprintf(fp, " -i, --input-format=(ctf | lttng-live)\n");
2857 fprintf(fp, " `ctf`:\n");
fd5f8053 2858 fprintf(fp, " Create an implicit `source.ctf.fs`\n");
9009cc24
PP		 2859 fprintf(fp, " component\n");
2860 fprintf(fp, " `lttng-live`:\n");
fd5f8053
PP		 2861 fprintf(fp, " Create an implicit `source.ctf.lttng-live`\n");
2862 fprintf(fp, " component\n");
e7ad156c 2863 fprintf(fp, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n");
9009cc24 2864 fprintf(fp, " `text`:\n");
fd5f8053 2865 fprintf(fp, " Create an implicit `sink.text.pretty`\n");
9009cc24 2866 fprintf(fp, " component\n");
dd46f7ea 2867 fprintf(fp, " `ctf`:\n");
e7ad156c
PP		 2868 fprintf(fp, " Create an implicit `sink.ctf.fs`\n");
2869 fprintf(fp, " component\n");
9009cc24 2870 fprintf(fp, " `dummy`:\n");
fd5f8053 2871 fprintf(fp, " Create an implicit `sink.utils.dummy`\n");
9009cc24
PP		 2872 fprintf(fp, " component\n");
2873 fprintf(fp, " `ctf-metadata`:\n");
fd5f8053
PP		 2874 fprintf(fp, " Query the `source.ctf.fs` component class\n");
2875 fprintf(fp, " for metadata text and quit\n");
9009cc24
PP		 2876 fprintf(fp, "\n");
2877 fprintf(fp, "See `babeltrace --help` for the list of general options.\n");
2878 fprintf(fp, "\n\n");
2879 fprintf(fp, "Format of BEGIN and END\n");
2880 fprintf(fp, "-----------------------\n");
2881 fprintf(fp, "\n");
2882 fprintf(fp, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n");
2883 fprintf(fp, "\n\n");
2884 print_expected_params_format(fp);
2885}
2886
2887static
2888struct poptOption convert_long_options[] = {
2889 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
2890 { "begin", 'b', POPT_ARG_STRING, NULL, OPT_BEGIN, NULL, NULL },
2891 { "clock-cycles", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL },
2892 { "clock-date", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
2893 { "clock-force-correlate", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL },
2894 { "clock-gmt", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL },
2895 { "clock-offset", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
2896 { "clock-offset-ns", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL },
2897 { "clock-seconds", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
2898 { "color", '\0', POPT_ARG_STRING, NULL, OPT_COLOR, NULL, NULL },
fd5f8053 2899 { "component", 'c', POPT_ARG_STRING, NULL, OPT_COMPONENT, NULL, NULL },
9009cc24
PP		 2900 { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
2901 { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL },
2902 { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL },
2903 { "debug-info-target-prefix", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_TARGET_PREFIX, NULL, NULL },
2904 { "end", 'e', POPT_ARG_STRING, NULL, OPT_END, NULL, NULL },
2905 { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
9009cc24
PP		 2906 { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
2907 { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL },
2908 { "name", '\0', POPT_ARG_STRING, NULL, OPT_NAME, NULL, NULL },
2909 { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
9a16feea 2910 { "debug-info", '\0', POPT_ARG_NONE, NULL, OPT_DEBUG_INFO, NULL, NULL },
9009cc24
PP		 2911 { "no-delta", '\0', POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
2912 { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL },
2913 { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL },
2914 { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT, NULL, NULL },
2915 { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL },
2916 { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL },
2917 { "path", 'P', POPT_ARG_STRING, NULL, OPT_PATH, NULL, NULL },
2918 { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
2919 { "retry-duration", '\0', POPT_ARG_STRING, NULL, OPT_RETRY_DURATION, NULL, NULL },
2920 { "run-args", '\0', POPT_ARG_NONE, NULL, OPT_RUN_ARGS, NULL, NULL },
2921 { "run-args-0", '\0', POPT_ARG_NONE, NULL, OPT_RUN_ARGS_0, NULL, NULL },
9009cc24
PP		 2922 { "stream-intersection", '\0', POPT_ARG_NONE, NULL, OPT_STREAM_INTERSECTION, NULL, NULL },
2923 { "timerange", '\0', POPT_ARG_STRING, NULL, OPT_TIMERANGE, NULL, NULL },
2924 { "url", 'u', POPT_ARG_STRING, NULL, OPT_URL, NULL, NULL },
2925 { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
2926 { NULL, 0, '\0', NULL, 0, NULL, NULL },
2927};
2928
2929static
2930GString *get_component_auto_name(const char *prefix,
05e21286 2931 const struct bt_value *existing_names)
9009cc24
PP		 2932{
2933 unsigned int i = 0;
2934 GString *auto_name = g_string_new(NULL);
2935
2936 if (!auto_name) {
2937 print_err_oom();
2938 goto end;
2939 }
2940
07208d85 2941 if (!bt_value_map_has_entry(existing_names, prefix)) {
9009cc24
PP		 2942 g_string_assign(auto_name, prefix);
2943 goto end;
2944 }
2945
2946 do {
2947 g_string_printf(auto_name, "%s-%d", prefix, i);
2948 i++;
07208d85 2949 } while (bt_value_map_has_entry(existing_names, auto_name->str));
9009cc24
PP		 2950
2951end:
2952 return auto_name;
2953}
2954
2955struct implicit_component_args {
2956 bool exists;
fd5f8053 2957 GString *comp_arg;
9009cc24
PP		 2958 GString *name_arg;
2959 GString *params_arg;
05e21286 2960 struct bt_value *extra_params;
9009cc24
PP		 2961};
2962
2963static
2964int assign_name_to_implicit_component(struct implicit_component_args *args,
05e21286 2965 const char *prefix, struct bt_value *existing_names,
9009cc24
PP		 2966 GList **comp_names, bool append_to_comp_names)
2967{
2968 int ret = 0;
2969 GString *name = NULL;
2970
2971 if (!args->exists) {
2972 goto end;
2973 }
2974
da91b29a 2975 name = get_component_auto_name(prefix,
05e21286 2976 existing_names);
9009cc24
PP		 2977
2978 if (!name) {
2979 ret = -1;
2980 goto end;
2981 }
2982
2983 g_string_assign(args->name_arg, name->str);
2984
05e21286 2985 if (bt_value_map_insert_entry(existing_names, name->str,
9009cc24
PP		 2986 bt_value_null)) {
2987 print_err_oom();
2988 ret = -1;
2989 goto end;
2990 }
2991
2992 if (append_to_comp_names) {
2993 *comp_names = g_list_append(*comp_names, name);
2994 name = NULL;
2995 }
2996
2997end:
2998 if (name) {
2999 g_string_free(name, TRUE);
3000 }
3001
3002 return ret;
3003}
3004
3005static
3006int append_run_args_for_implicit_component(
9009cc24 3007 struct implicit_component_args *impl_args,
05e21286 3008 struct bt_value *run_args)
9009cc24
PP		 3009{
3010 int ret = 0;
3011 size_t i;
3012
3013 if (!impl_args->exists) {
3014 goto end;
3015 }
3016
05e21286 3017 if (bt_value_array_append_string_element(run_args, "--component")) {
fd5f8053
PP		 3018 print_err_oom();
3019 goto error;
9009cc24
PP		 3020 }
3021
05e21286 3022 if (bt_value_array_append_string_element(run_args, impl_args->comp_arg->str)) {
9009cc24
PP		 3023 print_err_oom();
3024 goto error;
3025 }
3026
05e21286 3027 if (bt_value_array_append_string_element(run_args, "--name")) {
9009cc24
PP		 3028 print_err_oom();
3029 goto error;
3030 }
3031
05e21286 3032 if (bt_value_array_append_string_element(run_args, impl_args->name_arg->str)) {
9009cc24
PP		 3033 print_err_oom();
3034 goto error;
3035 }
3036
3037 if (impl_args->params_arg->len > 0) {
05e21286 3038 if (bt_value_array_append_string_element(run_args, "--params")) {
9009cc24
PP		 3039 print_err_oom();
3040 goto error;
3041 }
3042
05e21286 3043 if (bt_value_array_append_string_element(run_args,
9009cc24
PP		 3044 impl_args->params_arg->str)) {
3045 print_err_oom();
3046 goto error;
3047 }
3048 }
3049
05e21286 3050 for (i = 0; i < bt_value_array_get_size(impl_args->extra_params);
da91b29a 3051 i++) {
05e21286 3052 const struct bt_value *elem;
9009cc24
PP		 3053 const char *arg;
3054
05e21286
PP		 3055 elem = bt_value_array_borrow_element_by_index(impl_args->extra_params,
3056 i);
9009cc24
PP		 3057 if (!elem) {
3058 goto error;
3059 }
3060
f6ccaed9 3061 BT_ASSERT(bt_value_is_string(elem));
601b0d3c 3062 arg = bt_value_string_get(elem);
05e21286 3063 ret = bt_value_array_append_string_element(run_args, arg);
9009cc24
PP		 3064 if (ret) {
3065 print_err_oom();
3066 goto error;
3067 }
3068 }
3069
3070 goto end;
3071
3072error:
3073 ret = -1;
3074
3075end:
3076 return ret;
3077}
3078
3079static
94023a1c 3080void finalize_implicit_component_args(struct implicit_component_args *args)
9009cc24 3081{
f6ccaed9 3082 BT_ASSERT(args);
9009cc24 3083
fd5f8053
PP		 3084 if (args->comp_arg) {
3085 g_string_free(args->comp_arg, TRUE);
9009cc24
PP		 3086 }
3087
3088 if (args->name_arg) {
3089 g_string_free(args->name_arg, TRUE);
3090 }
3091
3092 if (args->params_arg) {
3093 g_string_free(args->params_arg, TRUE);
3094 }
3095
65300d60 3096 bt_object_put_ref(args->extra_params);
9009cc24
PP		 3097}
3098
94023a1c
PP		 3099static
3100void destroy_implicit_component_args(void *args)
3101{
3102 if (!args) {
3103 return;
3104 }
3105
3106 finalize_implicit_component_args(args);
3107 g_free(args);
3108}
3109
9009cc24
PP		 3110static
3111int init_implicit_component_args(struct implicit_component_args *args,
fd5f8053 3112 const char *comp_arg, bool exists)
9009cc24
PP		 3113{
3114 int ret = 0;
3115
3116 args->exists = exists;
fd5f8053 3117 args->comp_arg = g_string_new(comp_arg);
9009cc24
PP		 3118 args->name_arg = g_string_new(NULL);
3119 args->params_arg = g_string_new(NULL);
05e21286 3120 args->extra_params = bt_value_array_create();
9009cc24 3121
fd5f8053 3122 if (!args->comp_arg || !args->name_arg ||
e7ad156c 3123 !args->params_arg || !args->extra_params) {
9009cc24 3124 ret = -1;
94023a1c 3125 finalize_implicit_component_args(args);
9009cc24
PP		 3126 print_err_oom();
3127 goto end;
3128 }
3129
3130end:
3131 return ret;
3132}
3133
3134static
3135void append_implicit_component_param(struct implicit_component_args *args,
3136 const char *key, const char *value)
3137{
f6ccaed9
PP		 3138 BT_ASSERT(args);
3139 BT_ASSERT(key);
3140 BT_ASSERT(value);
9009cc24
PP		 3141 append_param_arg(args->params_arg, key, value);
3142}
3143
3144static
e7ad156c 3145int append_implicit_component_extra_param(struct implicit_component_args *args,
9009cc24
PP		 3146 const char *key, const char *value)
3147{
3148 int ret = 0;
3149
f6ccaed9
PP		 3150 BT_ASSERT(args);
3151 BT_ASSERT(key);
3152 BT_ASSERT(value);
9009cc24 3153
05e21286 3154 if (bt_value_array_append_string_element(args->extra_params, "--key")) {
9009cc24
PP		 3155 print_err_oom();
3156 ret = -1;
3157 goto end;
3158 }
3159
05e21286 3160 if (bt_value_array_append_string_element(args->extra_params, key)) {
9009cc24
PP		 3161 print_err_oom();
3162 ret = -1;
3163 goto end;
3164 }
3165
05e21286 3166 if (bt_value_array_append_string_element(args->extra_params, "--value")) {
9009cc24
PP		 3167 print_err_oom();
3168 ret = -1;
3169 goto end;
3170 }
3171
05e21286 3172 if (bt_value_array_append_string_element(args->extra_params, value)) {
9009cc24
PP		 3173 print_err_oom();
3174 ret = -1;
3175 goto end;
3176 }
3177
3178end:
3179 return ret;
3180}
3181
3182static
3183int convert_append_name_param(enum bt_config_component_dest dest,
3184 GString *cur_name, GString *cur_name_prefix,
05e21286
PP		 3185 struct bt_value *run_args,
3186 struct bt_value *all_names,
9009cc24
PP		 3187 GList **source_names, GList **filter_names,
3188 GList **sink_names)
3189{
3190 int ret = 0;
3191
3192 if (cur_name_prefix->len > 0) {
fd5f8053 3193 /* We're after a --component option */
9009cc24
PP		 3194 GString *name = NULL;
3195 bool append_name_opt = false;
3196
3197 if (cur_name->len == 0) {
3198 /*
3199 * No explicit name was provided for the user
3200 * component.
3201 */
fd5f8053 3202 name = get_component_auto_name(cur_name_prefix->str,
05e21286 3203 all_names);
9009cc24
PP		 3204 append_name_opt = true;
3205 } else {
3206 /*
3207 * An explicit name was provided for the user
3208 * component.
3209 */
05e21286
PP		 3210 if (bt_value_map_has_entry(all_names,
3211 cur_name->str)) {
9009cc24
PP		 3212 printf_err("Duplicate component instance name:\n %s\n",
3213 cur_name->str);
3214 goto error;
3215 }
3216
3217 name = g_string_new(cur_name->str);
3218 }
3219
3220 if (!name) {
3221 print_err_oom();
3222 goto error;
3223 }
3224
3225 /*
3226 * Remember this name globally, for the uniqueness of
3227 * all component names.
3228 */
05e21286 3229 if (bt_value_map_insert_entry(all_names, name->str, bt_value_null)) {
9009cc24
PP		 3230 print_err_oom();
3231 goto error;
3232 }
3233
3234 /*
3235 * Append the --name option if necessary.
3236 */
3237 if (append_name_opt) {
05e21286 3238 if (bt_value_array_append_string_element(run_args, "--name")) {
9009cc24
PP		 3239 print_err_oom();
3240 goto error;
3241 }
3242
05e21286 3243 if (bt_value_array_append_string_element(run_args, name->str)) {
9009cc24
PP		 3244 print_err_oom();
3245 goto error;
3246 }
3247 }
3248
3249 /*
3250 * Remember this name specifically for the type of the
3251 * component. This is to create connection arguments.
3252 */
3253 switch (dest) {
3254 case BT_CONFIG_COMPONENT_DEST_SOURCE:
3255 *source_names = g_list_append(*source_names, name);
3256 break;
3257 case BT_CONFIG_COMPONENT_DEST_FILTER:
3258 *filter_names = g_list_append(*filter_names, name);
3259 break;
3260 case BT_CONFIG_COMPONENT_DEST_SINK:
3261 *sink_names = g_list_append(*sink_names, name);
3262 break;
3263 default:
0fbb9a9f 3264 abort();
9009cc24
PP		 3265 }
3266
3267 g_string_assign(cur_name_prefix, "");
3268 }
3269
3270 goto end;
3271
3272error:
3273 ret = -1;
3274
3275end:
3276 return ret;
3277}
3278
3279/*
3280 * Escapes `.`, `:`, and `\` of `input` with `\`.
3281 */
3282static
3283GString *escape_dot_colon(const char *input)
3284{
3285 GString *output = g_string_new(NULL);
3286 const char *ch;
3287
3288 if (!output) {
3289 print_err_oom();
3290 goto end;
3291 }
3292
3293 for (ch = input; *ch != '\0'; ch++) {
3294 if (*ch == '\\' || *ch == '.' || *ch == ':') {
3295 g_string_append_c(output, '\\');
3296 }
3297
3298 g_string_append_c(output, *ch);
3299 }
3300
3301end:
3302 return output;
3303}
3304
3305/*
3306 * Appends a --connect option to a list of arguments. `upstream_name`
3307 * and `downstream_name` are escaped with escape_dot_colon() in this
3308 * function.
3309 */
3310static
05e21286 3311int append_connect_arg(struct bt_value *run_args,
9009cc24
PP		 3312 const char *upstream_name, const char *downstream_name)
3313{
3314 int ret = 0;
3315 GString *e_upstream_name = escape_dot_colon(upstream_name);
3316 GString *e_downstream_name = escape_dot_colon(downstream_name);
3317 GString *arg = g_string_new(NULL);
3318
3319 if (!e_upstream_name || !e_downstream_name || !arg) {
3320 print_err_oom();
3321 ret = -1;
3322 goto end;
3323 }
3324
05e21286 3325 ret = bt_value_array_append_string_element(run_args, "--connect");
9009cc24
PP		 3326 if (ret) {
3327 print_err_oom();
3328 ret = -1;
3329 goto end;
3330 }
3331
3332 g_string_append(arg, e_upstream_name->str);
3333 g_string_append_c(arg, ':');
3334 g_string_append(arg, e_downstream_name->str);
05e21286 3335 ret = bt_value_array_append_string_element(run_args, arg->str);
9009cc24
PP		 3336 if (ret) {
3337 print_err_oom();
3338 ret = -1;
3339 goto end;
3340 }
3341
3342end:
3343 if (arg) {
3344 g_string_free(arg, TRUE);
3345 }
3346
3347 if (e_upstream_name) {
3348 g_string_free(e_upstream_name, TRUE);
3349 }
3350
3351 if (e_downstream_name) {
3352 g_string_free(e_downstream_name, TRUE);
3353 }
3354
3355 return ret;
3356}
3357
3358/*
3359 * Appends the run command's --connect options for the convert command.
3360 */
3361static
05e21286 3362int convert_auto_connect(struct bt_value *run_args,
9009cc24
PP		 3363 GList *source_names, GList *filter_names,
3364 GList *sink_names)
3365{
3366 int ret = 0;
3367 GList *source_at = source_names;
3368 GList *filter_at = filter_names;
3369 GList *filter_prev;
3370 GList *sink_at = sink_names;
3371
f6ccaed9
PP		 3372 BT_ASSERT(source_names);
3373 BT_ASSERT(filter_names);
3374 BT_ASSERT(sink_names);
9009cc24
PP		 3375
3376 /* Connect all sources to the first filter */
3377 for (source_at = source_names; source_at != NULL; source_at = g_list_next(source_at)) {
3378 GString *source_name = source_at->data;
3379 GString *filter_name = filter_at->data;
3380
3381 ret = append_connect_arg(run_args, source_name->str,
3382 filter_name->str);
3383 if (ret) {
3384 goto error;
3385 }
3386 }
3387
3388 filter_prev = filter_at;
3389 filter_at = g_list_next(filter_at);
3390
3391 /* Connect remaining filters */
3392 for (; filter_at != NULL; filter_prev = filter_at, filter_at = g_list_next(filter_at)) {
3393 GString *filter_name = filter_at->data;
3394 GString *filter_prev_name = filter_prev->data;
3395
3396 ret = append_connect_arg(run_args, filter_prev_name->str,
3397 filter_name->str);
3398 if (ret) {
3399 goto error;
3400 }
3401 }
3402
3403 /* Connect last filter to all sinks */
3404 for (sink_at = sink_names; sink_at != NULL; sink_at = g_list_next(sink_at)) {
3405 GString *filter_name = filter_prev->data;
3406 GString *sink_name = sink_at->data;
3407
3408 ret = append_connect_arg(run_args, filter_name->str,
3409 sink_name->str);
3410 if (ret) {
3411 goto error;
3412 }
3413 }
3414
3415 goto end;
3416
3417error:
3418 ret = -1;
3419
3420end:
3421 return ret;
3422}
3423
3424static
3425int split_timerange(const char *arg, char **begin, char **end)
3426{
3427 int ret = 0;
3428 const char *ch = arg;
3429 size_t end_pos;
3430 GString *g_begin = NULL;
3431 GString *g_end = NULL;
3432
f6ccaed9 3433 BT_ASSERT(arg);
9009cc24
PP		 3434
3435 if (*ch == '[') {
3436 ch++;
3437 }
3438
3439 g_begin = bt_common_string_until(ch, "", ",", &end_pos);
3440 if (!g_begin || ch[end_pos] != ',' || g_begin->len == 0) {
3441 goto error;
3442 }
3443
3444 ch += end_pos + 1;
3445
3446 g_end = bt_common_string_until(ch, "", "]", &end_pos);
3447 if (!g_end || g_end->len == 0) {
3448 goto error;
3449 }
3450
f6ccaed9
PP		 3451 BT_ASSERT(begin);
3452 BT_ASSERT(end);
9009cc24
PP		 3453 *begin = g_begin->str;
3454 *end = g_end->str;
3455 g_string_free(g_begin, FALSE);
3456 g_string_free(g_end, FALSE);
3457 g_begin = NULL;
3458 g_end = NULL;
3459 goto end;
3460
3461error:
3462 ret = -1;
3463
3464end:
3465 if (g_begin) {
3466 g_string_free(g_begin, TRUE);
3467 }
3468
3469 if (g_end) {
3470 g_string_free(g_end, TRUE);
3471 }
3472
3473 return ret;
3474}
3475
3476static
3477int g_list_prepend_gstring(GList **list, const char *string)
3478{
3479 int ret = 0;
3480 GString *gs = g_string_new(string);
3481
f6ccaed9 3482 BT_ASSERT(list);
9009cc24
PP		 3483
3484 if (!gs) {
3485 print_err_oom();
3486 goto end;
3487 }
3488
3489 *list = g_list_prepend(*list, gs);
3490
3491end:
3492 return ret;
3493}
3494
94023a1c
PP		 3495static
3496struct implicit_component_args *create_implicit_component_args(void)
3497{
3498 struct implicit_component_args *impl_args =
3499 g_new0(struct implicit_component_args, 1);
3500
3501 if (!impl_args) {
3502 goto end;
3503 }
3504
3505 if (init_implicit_component_args(impl_args, NULL, true)) {
3506 destroy_implicit_component_args(impl_args);
3507 impl_args = NULL;
3508 goto end;
3509 }
3510
3511end:
3512 return impl_args;
3513}
3514
3515static
3516int fill_implicit_ctf_inputs_args(GPtrArray *implicit_ctf_inputs_args,
3517 struct implicit_component_args *base_implicit_ctf_input_args,
3518 GList *leftovers)
3519{
3520 int ret = 0;
3521 GList *leftover;
601b0d3c 3522 enum bt_value_status status;
94023a1c
PP		 3523
3524 for (leftover = leftovers; leftover != NULL;
3525 leftover = g_list_next(leftover)) {
3526 GString *gs_leftover = leftover->data;
3527 struct implicit_component_args *impl_args =
3528 create_implicit_component_args();
3529
3530 if (!impl_args) {
3531 print_err_oom();
3532 goto error;
3533 }
3534
3535 impl_args->exists = true;
3536 g_string_assign(impl_args->comp_arg,
3537 base_implicit_ctf_input_args->comp_arg->str);
3538 g_string_assign(impl_args->params_arg,
3539 base_implicit_ctf_input_args->params_arg->str);
3540
3541 /*
3542 * We need our own copy of the extra parameters because
3543 * this is where the unique path goes.
3544 */
65300d60 3545 BT_OBJECT_PUT_REF_AND_RESET(impl_args->extra_params);
601b0d3c 3546 status = bt_value_copy(&impl_args->extra_params,
05e21286 3547 base_implicit_ctf_input_args->extra_params);
601b0d3c 3548 if (status != BT_VALUE_STATUS_OK) {
94023a1c
PP		 3549 print_err_oom();
3550 destroy_implicit_component_args(impl_args);
3551 goto error;
3552 }
3553
3554 /* Append unique path parameter */
3555 ret = append_implicit_component_extra_param(impl_args,
3556 "path", gs_leftover->str);
3557 if (ret) {
3558 destroy_implicit_component_args(impl_args);
3559 goto error;
3560 }
3561
3562 g_ptr_array_add(implicit_ctf_inputs_args, impl_args);
3563 }
3564
3565 goto end;
3566
3567error:
3568 ret = -1;
3569
3570end:
3571 return ret;
3572}
3573
9009cc24
PP		 3574/*
3575 * Creates a Babeltrace config object from the arguments of a convert
3576 * command.
3577 *
3578 * *retcode is set to the appropriate exit code to use.
3579 */
3580static
3581struct bt_config *bt_config_convert_from_args(int argc, const char *argv[],
3582 int *retcode, bool force_omit_system_plugin_path,
9a16feea 3583 bool force_omit_home_plugin_path,
05e21286 3584 const struct bt_value *initial_plugin_paths, char *log_level)
9009cc24
PP		 3585{
3586 poptContext pc = NULL;
3587 char *arg = NULL;
0a011c88
JG		 3588 enum bt_config_component_dest cur_comp_dest =
3589 BT_CONFIG_COMPONENT_DEST_UNKNOWN;
9009cc24
PP		 3590 int opt, ret = 0;
3591 struct bt_config *cfg = NULL;
9009cc24
PP		 3592 bool got_input_format_opt = false;
3593 bool got_output_format_opt = false;
3594 bool trimmer_has_begin = false;
3595 bool trimmer_has_end = false;
75a2cb9b 3596 bool stream_intersection_mode = false;
9009cc24
PP		 3597 GString *cur_name = NULL;
3598 GString *cur_name_prefix = NULL;
3599 const char *leftover = NULL;
3600 bool print_run_args = false;
3601 bool print_run_args_0 = false;
3602 bool print_ctf_metadata = false;
05e21286
PP		 3603 struct bt_value *run_args = NULL;
3604 struct bt_value *all_names = NULL;
9009cc24
PP		 3605 GList *source_names = NULL;
3606 GList *filter_names = NULL;
3607 GList *sink_names = NULL;
94023a1c
PP		 3608 GList *leftovers = NULL;
3609 GPtrArray *implicit_ctf_inputs_args = NULL;
3610 struct implicit_component_args base_implicit_ctf_input_args = { 0 };
e7ad156c 3611 struct implicit_component_args implicit_ctf_output_args = { 0 };
9009cc24
PP		 3612 struct implicit_component_args implicit_lttng_live_args = { 0 };
3613 struct implicit_component_args implicit_dummy_args = { 0 };
3614 struct implicit_component_args implicit_text_args = { 0 };
3615 struct implicit_component_args implicit_debug_info_args = { 0 };
3616 struct implicit_component_args implicit_muxer_args = { 0 };
3617 struct implicit_component_args implicit_trimmer_args = { 0 };
05e21286 3618 struct bt_value *plugin_paths;
9009cc24
PP		 3619 char error_buf[256] = { 0 };
3620 size_t i;
3621 struct bt_common_lttng_live_url_parts lttng_live_url_parts = { 0 };
e7ad156c 3622 char *output = NULL;
9009cc24 3623
05e21286 3624 (void) bt_value_copy(&plugin_paths, initial_plugin_paths);
398454ed 3625
9009cc24
PP		 3626 *retcode = 0;
3627
3628 if (argc <= 1) {
3629 print_convert_usage(stdout);
3630 *retcode = -1;
3631 goto end;
3632 }
3633
94023a1c 3634 if (init_implicit_component_args(&base_implicit_ctf_input_args,
fd5f8053 3635 "source.ctf.fs", false)) {
9009cc24
PP		 3636 goto error;
3637 }
3638
e7ad156c
PP		 3639 if (init_implicit_component_args(&implicit_ctf_output_args,
3640 "sink.ctf.fs", false)) {
3641 goto error;
3642 }
3643
9009cc24 3644 if (init_implicit_component_args(&implicit_lttng_live_args,
fd5f8053 3645 "source.ctf.lttng-live", false)) {
9009cc24
PP		 3646 goto error;
3647 }
3648
fd5f8053
PP		 3649 if (init_implicit_component_args(&implicit_text_args,
3650 "sink.text.pretty", false)) {
9009cc24
PP		 3651 goto error;
3652 }
3653
fd5f8053
PP		 3654 if (init_implicit_component_args(&implicit_dummy_args,
3655 "sink.utils.dummy", false)) {
9009cc24
PP		 3656 goto error;
3657 }
3658
3659 if (init_implicit_component_args(&implicit_debug_info_args,
9a16feea 3660 "filter.lttng-utils.debug-info", false)) {
9009cc24
PP		 3661 goto error;
3662 }
3663
fd5f8053
PP		 3664 if (init_implicit_component_args(&implicit_muxer_args,
3665 "filter.utils.muxer", true)) {
9009cc24
PP		 3666 goto error;
3667 }
3668
3669 if (init_implicit_component_args(&implicit_trimmer_args,
fd5f8053 3670 "filter.utils.trimmer", false)) {
9009cc24
PP		 3671 goto error;
3672 }
3673
94023a1c
PP		 3674 implicit_ctf_inputs_args = g_ptr_array_new_with_free_func(
3675 (GDestroyNotify) destroy_implicit_component_args);
3676 if (!implicit_ctf_inputs_args) {
3677 print_err_oom();
3678 goto error;
3679 }
3680
05e21286 3681 all_names = bt_value_map_create();
9009cc24
PP		 3682 if (!all_names) {
3683 print_err_oom();
3684 goto error;
3685 }
3686
05e21286 3687 run_args = bt_value_array_create();
9009cc24
PP		 3688 if (!run_args) {
3689 print_err_oom();
3690 goto error;
3691 }
3692
3693 cur_name = g_string_new(NULL);
3694 if (!cur_name) {
3695 print_err_oom();
3696 goto error;
3697 }
3698
3699 cur_name_prefix = g_string_new(NULL);
3700 if (!cur_name_prefix) {
3701 print_err_oom();
3702 goto error;
3703 }
3704
3705 ret = append_env_var_plugin_paths(plugin_paths);
3706 if (ret) {
3707 goto error;
3708 }
3709
3710 /*
3711 * First pass: collect all arguments which need to be passed
3712 * as is to the run command. This pass can also add --name
3713 * arguments if needed to automatically name unnamed component
3714 * instances. Also it does the following transformations:
3715 *
3716 * --path=PATH -> --key path --value PATH
3717 * --url=URL -> --key url --value URL
3718 *
3719 * Also it appends the plugin paths of --plugin-path to
3720 * `plugin_paths`.
3721 */
3722 pc = poptGetContext(NULL, argc, (const char **) argv,
3723 convert_long_options, 0);
3724 if (!pc) {
3725 printf_err("Cannot get popt context\n");
3726 goto error;
3727 }
3728
3729 poptReadDefaultConfig(pc, 0);
3730
3731 while ((opt = poptGetNextOpt(pc)) > 0) {
3732 char *name = NULL;
3733 char *plugin_name = NULL;
3734 char *comp_cls_name = NULL;
3735
3736 arg = poptGetOptArg(pc);
3737
3738 switch (opt) {
fd5f8053
PP		 3739 case OPT_COMPONENT:
3740 {
3741 enum bt_component_class_type type;
3742 const char *type_prefix;
3743
9009cc24
PP		 3744 /* Append current component's name if needed */
3745 ret = convert_append_name_param(cur_comp_dest, cur_name,
3746 cur_name_prefix, run_args, all_names,
3747 &source_names, &filter_names, &sink_names);
3748 if (ret) {
3749 goto error;
3750 }
3751
3752 /* Parse the argument */
3753 plugin_comp_cls_names(arg, &name, &plugin_name,
fd5f8053 3754 &comp_cls_name, &type);
9009cc24 3755 if (!plugin_name || !comp_cls_name) {
fd5f8053 3756 printf_err("Invalid format for --component option's argument:\n %s\n",
9009cc24
PP		 3757 arg);
3758 goto error;
3759 }
3760
3761 if (name) {
3762 g_string_assign(cur_name, name);
3763 } else {
3764 g_string_assign(cur_name, "");
3765 }
3766
fd5f8053
PP		 3767 switch (type) {
3768 case BT_COMPONENT_CLASS_TYPE_SOURCE:
3769 cur_comp_dest = BT_CONFIG_COMPONENT_DEST_SOURCE;
3770 type_prefix = "source";
9009cc24 3771 break;
fd5f8053
PP		 3772 case BT_COMPONENT_CLASS_TYPE_FILTER:
3773 cur_comp_dest = BT_CONFIG_COMPONENT_DEST_FILTER;
3774 type_prefix = "filter";
9009cc24 3775 break;
fd5f8053
PP		 3776 case BT_COMPONENT_CLASS_TYPE_SINK:
3777 cur_comp_dest = BT_CONFIG_COMPONENT_DEST_SINK;
3778 type_prefix = "sink";
9009cc24
PP		 3779 break;
3780 default:
0fbb9a9f 3781 abort();
9009cc24
PP		 3782 }
3783
05e21286 3784 if (bt_value_array_append_string_element(run_args,
fd5f8053
PP		 3785 "--component")) {
3786 print_err_oom();
3787 goto error;
3788 }
3789
05e21286 3790 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3791 print_err_oom();
3792 goto error;
3793 }
3794
3795 g_string_assign(cur_name_prefix, "");
fd5f8053
PP		 3796 g_string_append_printf(cur_name_prefix, "%s.%s.%s",
3797 type_prefix, plugin_name, comp_cls_name);
9009cc24
PP		 3798 free(name);
3799 free(plugin_name);
3800 free(comp_cls_name);
3801 name = NULL;
3802 plugin_name = NULL;
3803 comp_cls_name = NULL;
3804 break;
fd5f8053 3805 }
9009cc24
PP		 3806 case OPT_PARAMS:
3807 if (cur_name_prefix->len == 0) {
3808 printf_err("No current component of which to set parameters:\n %s\n",
3809 arg);
3810 goto error;
3811 }
3812
05e21286 3813 if (bt_value_array_append_string_element(run_args,
9009cc24
PP		 3814 "--params")) {
3815 print_err_oom();
3816 goto error;
3817 }
3818
05e21286 3819 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3820 print_err_oom();
3821 goto error;
3822 }
3823 break;
3824 case OPT_PATH:
3825 if (cur_name_prefix->len == 0) {
3826 printf_err("No current component of which to set `path` parameter:\n %s\n",
3827 arg);
3828 goto error;
3829 }
3830
05e21286 3831 if (bt_value_array_append_string_element(run_args, "--key")) {
9009cc24
PP		 3832 print_err_oom();
3833 goto error;
3834 }
3835
05e21286 3836 if (bt_value_array_append_string_element(run_args, "path")) {
9009cc24
PP		 3837 print_err_oom();
3838 goto error;
3839 }
3840
05e21286 3841 if (bt_value_array_append_string_element(run_args, "--value")) {
9009cc24
PP		 3842 print_err_oom();
3843 goto error;
3844 }
3845
05e21286 3846 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3847 print_err_oom();
3848 goto error;
3849 }
3850 break;
3851 case OPT_URL:
3852 if (cur_name_prefix->len == 0) {
3853 printf_err("No current component of which to set `url` parameter:\n %s\n",
3854 arg);
3855 goto error;
3856 }
3857
05e21286 3858 if (bt_value_array_append_string_element(run_args, "--key")) {
9009cc24
PP		 3859 print_err_oom();
3860 goto error;
3861 }
3862
05e21286 3863 if (bt_value_array_append_string_element(run_args, "url")) {
9009cc24
PP		 3864 print_err_oom();
3865 goto error;
3866 }
3867
05e21286 3868 if (bt_value_array_append_string_element(run_args, "--value")) {
9009cc24
PP		 3869 print_err_oom();
3870 goto error;
3871 }
3872
05e21286 3873 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3874 print_err_oom();
3875 goto error;
3876 }
3877 break;
3878 case OPT_NAME:
3879 if (cur_name_prefix->len == 0) {
3880 printf_err("No current component to name:\n %s\n",
3881 arg);
3882 goto error;
3883 }
3884
05e21286 3885 if (bt_value_array_append_string_element(run_args, "--name")) {
9009cc24
PP		 3886 print_err_oom();
3887 goto error;
3888 }
3889
05e21286 3890 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3891 print_err_oom();
3892 goto error;
3893 }
3894
3895 g_string_assign(cur_name, arg);
3896 break;
3897 case OPT_OMIT_HOME_PLUGIN_PATH:
3898 force_omit_home_plugin_path = true;
3899
05e21286 3900 if (bt_value_array_append_string_element(run_args,
9009cc24
PP		 3901 "--omit-home-plugin-path")) {
3902 print_err_oom();
3903 goto error;
3904 }
3905 break;
3906 case OPT_RETRY_DURATION:
05e21286 3907 if (bt_value_array_append_string_element(run_args,
9009cc24
PP		 3908 "--retry-duration")) {
3909 print_err_oom();
3910 goto error;
3911 }
3912
05e21286 3913 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3914 print_err_oom();
3915 goto error;
3916 }
3917 break;
3918 case OPT_OMIT_SYSTEM_PLUGIN_PATH:
3919 force_omit_system_plugin_path = true;
3920
05e21286 3921 if (bt_value_array_append_string_element(run_args,
9009cc24
PP		 3922 "--omit-system-plugin-path")) {
3923 print_err_oom();
3924 goto error;
3925 }
3926 break;
3927 case OPT_PLUGIN_PATH:
3928 if (bt_config_append_plugin_paths_check_setuid_setgid(
3929 plugin_paths, arg)) {
3930 goto error;
3931 }
3932
05e21286 3933 if (bt_value_array_append_string_element(run_args,
9009cc24
PP		 3934 "--plugin-path")) {
3935 print_err_oom();
3936 goto error;
3937 }
3938
05e21286 3939 if (bt_value_array_append_string_element(run_args, arg)) {
9009cc24
PP		 3940 print_err_oom();
3941 goto error;
3942 }
3943 break;
3944 case OPT_HELP:
3945 print_convert_usage(stdout);
3946 *retcode = -1;
65300d60 3947 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 3948 goto end;
3949 case OPT_BEGIN:
3950 case OPT_CLOCK_CYCLES:
3951 case OPT_CLOCK_DATE:
3952 case OPT_CLOCK_FORCE_CORRELATE:
3953 case OPT_CLOCK_GMT:
3954 case OPT_CLOCK_OFFSET:
3955 case OPT_CLOCK_OFFSET_NS:
3956 case OPT_CLOCK_SECONDS:
3957 case OPT_COLOR:
3958 case OPT_DEBUG:
9a16feea 3959 case OPT_DEBUG_INFO:
9009cc24
PP		 3960 case OPT_DEBUG_INFO_DIR:
3961 case OPT_DEBUG_INFO_FULL_PATH:
3962 case OPT_DEBUG_INFO_TARGET_PREFIX:
3963 case OPT_END:
3964 case OPT_FIELDS:
3965 case OPT_INPUT_FORMAT:
3966 case OPT_NAMES:
9009cc24
PP		 3967 case OPT_NO_DELTA:
3968 case OPT_OUTPUT_FORMAT:
3969 case OPT_OUTPUT:
3970 case OPT_RUN_ARGS:
3971 case OPT_RUN_ARGS_0:
3972 case OPT_STREAM_INTERSECTION:
3973 case OPT_TIMERANGE:
3974 case OPT_VERBOSE:
3975 /* Ignore in this pass */
3976 break;
3977 default:
3978 printf_err("Unknown command-line option specified (option code %d)\n",
3979 opt);
3980 goto error;
3981 }
3982
3983 free(arg);
3984 arg = NULL;
3985 }
3986
3987 /* Append current component's name if needed */
3988 ret = convert_append_name_param(cur_comp_dest, cur_name,
3989 cur_name_prefix, run_args, all_names, &source_names,
3990 &filter_names, &sink_names);
3991 if (ret) {
3992 goto error;
3993 }
3994
3995 /* Check for option parsing error */
3996 if (opt < -1) {
3997 printf_err("While parsing command-line options, at option %s: %s\n",
3998 poptBadOption(pc, 0), poptStrerror(opt));
3999 goto error;
4000 }
4001
4002 poptFreeContext(pc);
4003 free(arg);
4004 arg = NULL;
4005
4006 /*
4007 * Second pass: transform the convert-specific options and
4008 * arguments into implicit component instances for the run
4009 * command.
4010 */
4011 pc = poptGetContext(NULL, argc, (const char **) argv,
4012 convert_long_options, 0);
4013 if (!pc) {
4014 printf_err("Cannot get popt context\n");
4015 goto error;
4016 }
4017
4018 poptReadDefaultConfig(pc, 0);
4019
4020 while ((opt = poptGetNextOpt(pc)) > 0) {
4021 arg = poptGetOptArg(pc);
4022
4023 switch (opt) {
4024 case OPT_BEGIN:
4025 if (trimmer_has_begin) {
4026 printf("At --begin option: --begin or --timerange option already specified\n %s\n",
4027 arg);
4028 goto error;
4029 }
4030
4031 trimmer_has_begin = true;
e7ad156c 4032 ret = append_implicit_component_extra_param(
9009cc24
PP		 4033 &implicit_trimmer_args, "begin", arg);
4034 implicit_trimmer_args.exists = true;
4035 if (ret) {
4036 goto error;
4037 }
4038 break;
4039 case OPT_END:
4040 if (trimmer_has_end) {
4041 printf("At --end option: --end or --timerange option already specified\n %s\n",
4042 arg);
4043 goto error;
4044 }
4045
4046 trimmer_has_end = true;
e7ad156c 4047 ret = append_implicit_component_extra_param(
9009cc24
PP		 4048 &implicit_trimmer_args, "end", arg);
4049 implicit_trimmer_args.exists = true;
4050 if (ret) {
4051 goto error;
4052 }
4053 break;
4054 case OPT_TIMERANGE:
4055 {
4056 char *begin;
4057 char *end;
4058
4059 if (trimmer_has_begin || trimmer_has_end) {
4060 printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n",
4061 arg);
4062 goto error;
4063 }
4064
4065 ret = split_timerange(arg, &begin, &end);
4066 if (ret) {
4067 printf_err("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s\n",
4068 arg);
4069 goto error;
4070 }
4071
e7ad156c 4072 ret = append_implicit_component_extra_param(
9009cc24 4073 &implicit_trimmer_args, "begin", begin);
e7ad156c 4074 ret |= append_implicit_component_extra_param(
9009cc24
PP		 4075 &implicit_trimmer_args, "end", end);
4076 implicit_trimmer_args.exists = true;
4077 free(begin);
4078 free(end);
4079 if (ret) {
4080 goto error;
4081 }
4082 break;
4083 }
4084 case OPT_CLOCK_CYCLES:
4085 append_implicit_component_param(
4086 &implicit_text_args, "clock-cycles", "yes");
4087 implicit_text_args.exists = true;
4088 break;
4089 case OPT_CLOCK_DATE:
4090 append_implicit_component_param(
4091 &implicit_text_args, "clock-date", "yes");
4092 implicit_text_args.exists = true;
4093 break;
4094 case OPT_CLOCK_FORCE_CORRELATE:
4095 append_implicit_component_param(
a2a54545
PP		 4096 &implicit_muxer_args,
4097 "assume-absolute-clock-classes", "yes");
9009cc24
PP		 4098 break;
4099 case OPT_CLOCK_GMT:
4100 append_implicit_component_param(
4101 &implicit_text_args, "clock-gmt", "yes");
eb01fbce
JD		 4102 append_implicit_component_param(
4103 &implicit_trimmer_args, "clock-gmt", "yes");
9009cc24
PP		 4104 implicit_text_args.exists = true;
4105 break;
4106 case OPT_CLOCK_OFFSET:
94023a1c 4107 base_implicit_ctf_input_args.exists = true;
a2a54545 4108 append_implicit_component_param(
291a6dc5 4109 &base_implicit_ctf_input_args,
a2a54545 4110 "clock-class-offset-s", arg);
9009cc24
PP		 4111 break;
4112 case OPT_CLOCK_OFFSET_NS:
94023a1c 4113 base_implicit_ctf_input_args.exists = true;
291a6dc5
PP		 4114 append_implicit_component_param(
4115 &base_implicit_ctf_input_args,
4116 "clock-class-offset-ns", arg);
9009cc24
PP		 4117 break;
4118 case OPT_CLOCK_SECONDS:
4119 append_implicit_component_param(
4120 &implicit_text_args, "clock-seconds", "yes");
4121 implicit_text_args.exists = true;
4122 break;
4123 case OPT_COLOR:
9009cc24 4124 implicit_text_args.exists = true;
e7ad156c
PP		 4125 ret = append_implicit_component_extra_param(
4126 &implicit_text_args, "color", arg);
9009cc24
PP		 4127 if (ret) {
4128 goto error;
4129 }
4130 break;
9a16feea
PP		 4131 case OPT_DEBUG_INFO:
4132 implicit_debug_info_args.exists = true;
9009cc24
PP		 4133 break;
4134 case OPT_DEBUG_INFO_DIR:
e7ad156c
PP		 4135 implicit_debug_info_args.exists = true;
4136 ret = append_implicit_component_extra_param(
4cd687b9 4137 &implicit_debug_info_args, "debug-info-dir", arg);
9009cc24
PP		 4138 if (ret) {
4139 goto error;
4140 }
4141 break;
4142 case OPT_DEBUG_INFO_FULL_PATH:
e7ad156c 4143 implicit_debug_info_args.exists = true;
9009cc24
PP		 4144 append_implicit_component_param(
4145 &implicit_debug_info_args, "full-path", "yes");
4146 break;
4147 case OPT_DEBUG_INFO_TARGET_PREFIX:
e7ad156c
PP		 4148 implicit_debug_info_args.exists = true;
4149 ret = append_implicit_component_extra_param(
9009cc24
PP		 4150 &implicit_debug_info_args,
4151 "target-prefix", arg);
4152 if (ret) {
4153 goto error;
4154 }
4155 break;
4156 case OPT_FIELDS:
4157 {
05e21286 4158 struct bt_value *fields = fields_from_arg(arg);
9009cc24
PP		 4159
4160 if (!fields) {
4161 goto error;
4162 }
4163
e7ad156c 4164 implicit_text_args.exists = true;
9009cc24
PP		 4165 ret = insert_flat_params_from_array(
4166 implicit_text_args.params_arg,
05e21286 4167 fields, "field");
65300d60 4168 bt_object_put_ref(fields);
9009cc24
PP		 4169 if (ret) {
4170 goto error;
4171 }
4172 break;
4173 }
4174 case OPT_NAMES:
4175 {
05e21286 4176 struct bt_value *names = names_from_arg(arg);
9009cc24
PP		 4177
4178 if (!names) {
4179 goto error;
4180 }
4181
e7ad156c 4182 implicit_text_args.exists = true;
9009cc24
PP		 4183 ret = insert_flat_params_from_array(
4184 implicit_text_args.params_arg,
05e21286 4185 names, "name");
65300d60 4186 bt_object_put_ref(names);
9009cc24
PP		 4187 if (ret) {
4188 goto error;
4189 }
4190 break;
4191 }
4192 case OPT_NO_DELTA:
4193 append_implicit_component_param(
4194 &implicit_text_args, "no-delta", "yes");
4195 implicit_text_args.exists = true;
4196 break;
4197 case OPT_INPUT_FORMAT:
4198 if (got_input_format_opt) {
4199 printf_err("Duplicate --input-format option\n");
4200 goto error;
4201 }
4202
4203 got_input_format_opt = true;
4204
4205 if (strcmp(arg, "ctf") == 0) {
94023a1c 4206 base_implicit_ctf_input_args.exists = true;
9009cc24
PP		 4207 } else if (strcmp(arg, "lttng-live") == 0) {
4208 implicit_lttng_live_args.exists = true;
4209 } else {
4210 printf_err("Unknown legacy input format:\n %s\n",
4211 arg);
4212 goto error;
4213 }
4214 break;
4215 case OPT_OUTPUT_FORMAT:
4216 if (got_output_format_opt) {
4217 printf_err("Duplicate --output-format option\n");
4218 goto error;
4219 }
4220
4221 got_output_format_opt = true;
4222
4223 if (strcmp(arg, "text") == 0) {
4224 implicit_text_args.exists = true;
e7ad156c
PP		 4225 } else if (strcmp(arg, "ctf") == 0) {
4226 implicit_ctf_output_args.exists = true;
9009cc24
PP		 4227 } else if (strcmp(arg, "dummy") == 0) {
4228 implicit_dummy_args.exists = true;
4229 } else if (strcmp(arg, "ctf-metadata") == 0) {
4230 print_ctf_metadata = true;
4231 } else {
4232 printf_err("Unknown legacy output format:\n %s\n",
4233 arg);
4234 goto error;
4235 }
4236 break;
4237 case OPT_OUTPUT:
e7ad156c
PP		 4238 if (output) {
4239 printf_err("Duplicate --output option\n");
4240 goto error;
4241 }
4242
4243 output = strdup(arg);
4244 if (!output) {
4245 print_err_oom();
9009cc24
PP		 4246 goto error;
4247 }
4248 break;
4249 case OPT_RUN_ARGS:
4250 if (print_run_args_0) {
4251 printf_err("Cannot specify --run-args and --run-args-0\n");
4252 goto error;
4253 }
4254
4255 print_run_args = true;
4256 break;
4257 case OPT_RUN_ARGS_0:
4258 if (print_run_args) {
4259 printf_err("Cannot specify --run-args and --run-args-0\n");
4260 goto error;
4261 }
4262
4263 print_run_args_0 = true;
4264 break;
4265 case OPT_STREAM_INTERSECTION:
75a2cb9b
JG		 4266 /*
4267 * Applies to all traces implementing the trace-info
4268 * query.
4269 */
4270 stream_intersection_mode = true;
9009cc24
PP		 4271 break;
4272 case OPT_VERBOSE:
3efa3052
PP		 4273 if (*log_level != 'V' && *log_level != 'D') {
4274 *log_level = 'I';
9009cc24 4275 }
9009cc24
PP		 4276 break;
4277 case OPT_DEBUG:
3efa3052 4278 *log_level = 'V';
9009cc24
PP		 4279 break;
4280 }
4281
4282 free(arg);
4283 arg = NULL;
4284 }
4285
4286 /* Check for option parsing error */
4287 if (opt < -1) {
4288 printf_err("While parsing command-line options, at option %s: %s\n",
4289 poptBadOption(pc, 0), poptStrerror(opt));
4290 goto error;
4291 }
4292
3efa3052
PP		 4293 /*
4294 * Legacy behaviour: --verbose used to make the `text` output
4295 * format print more information. --verbose is now equivalent to
4296 * the INFO log level, which is why we compare to 'I' here.
4297 */
4298 if (*log_level == 'I') {
4299 append_implicit_component_param(&implicit_text_args,
4300 "verbose", "yes");
4301 }
4302
9009cc24
PP		 4303 /*
4304 * Append home and system plugin paths now that we possibly got
4305 * --plugin-path.
4306 */
4307 if (append_home_and_system_plugin_paths(plugin_paths,
4308 force_omit_system_plugin_path,
4309 force_omit_home_plugin_path)) {
4310 goto error;
4311 }
4312
94023a1c
PP		 4313 /* Consume and keep leftover arguments */
4314 while ((leftover = poptGetArg(pc))) {
4315 GString *gs_leftover = g_string_new(leftover);
9009cc24 4316
94023a1c
PP		 4317 if (!gs_leftover) {
4318 print_err_oom();
4319 goto error;
4320 }
4321
4322 leftovers = g_list_append(leftovers, gs_leftover);
4323 if (!leftovers) {
4324 g_string_free(gs_leftover, TRUE);
4325 print_err_oom();
4326 goto error;
4327 }
9009cc24
PP		 4328 }
4329
4330 /* Print CTF metadata or print LTTng live sessions */
4331 if (print_ctf_metadata) {
94023a1c
PP		 4332 GString *gs_leftover;
4333
4334 if (g_list_length(leftovers) == 0) {
9009cc24
PP		 4335 printf_err("--output-format=ctf-metadata specified without a path\n");
4336 goto error;
4337 }
4338
94023a1c
PP		 4339 if (g_list_length(leftovers) > 1) {
4340 printf_err("Too many paths specified for --output-format=ctf-metadata\n");
4341 goto error;
4342 }
4343
9009cc24
PP		 4344 cfg = bt_config_print_ctf_metadata_create(plugin_paths);
4345 if (!cfg) {
4346 goto error;
4347 }
4348
94023a1c 4349 gs_leftover = leftovers->data;
9009cc24 4350 g_string_assign(cfg->cmd_data.print_ctf_metadata.path,
94023a1c 4351 gs_leftover->str);
c327e427
PP		 4352
4353 if (output) {
4354 g_string_assign(
4355 cfg->cmd_data.print_ctf_metadata.output_path,
4356 output);
4357 }
4358
9009cc24
PP		 4359 goto end;
4360 }
4361
4362 /*
e7ad156c
PP		 4363 * If -o ctf was specified, make sure an output path (--output)
4364 * was also specified. --output does not imply -o ctf because
4365 * it's also used for the default, implicit -o text if -o ctf
4366 * is not specified.
4367 */
4368 if (implicit_ctf_output_args.exists) {
4369 if (!output) {
4370 printf_err("--output-format=ctf specified without --output (trace output path)\n");
4371 goto error;
4372 }
4373
4374 /*
4375 * At this point we know that -o ctf AND --output were
4376 * specified. Make sure that no options were specified
4377 * which would imply -o text because --output would be
4378 * ambiguous in this case. For example, this is wrong:
4379 *
4380 * babeltrace --names=all -o ctf --output=/tmp/path my-trace
4381 *
4382 * because --names=all implies -o text, and --output
4383 * could apply to both the sink.text.pretty and
4384 * sink.ctf.fs implicit components.
4385 */
4386 if (implicit_text_args.exists) {
4387 printf_err("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text\n");
4388 goto error;
4389 }
4390 }
4391
4392 /*
4393 * If -o dummy and -o ctf were not specified, and if there are
4394 * no explicit sink components, then use an implicit
4395 * `sink.text.pretty` component.
9009cc24 4396 */
e7ad156c
PP		 4397 if (!implicit_dummy_args.exists && !implicit_ctf_output_args.exists &&
4398 !sink_names) {
9009cc24
PP		 4399 implicit_text_args.exists = true;
4400 }
4401
e7ad156c
PP		 4402 /*
4403 * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's
4404 * `path` parameter if --output was specified.
4405 */
4406 if (output) {
4407 if (implicit_text_args.exists) {
4408 append_implicit_component_extra_param(&implicit_text_args,
4409 "path", output);
4410 } else if (implicit_ctf_output_args.exists) {
4411 append_implicit_component_extra_param(&implicit_ctf_output_args,
4412 "path", output);
4413 }
4414 }
4415
94023a1c
PP		 4416 /* Decide where the leftover argument(s) go */
4417 if (g_list_length(leftovers) > 0) {
9009cc24 4418 if (implicit_lttng_live_args.exists) {
94023a1c
PP		 4419 GString *gs_leftover;
4420
4421 if (g_list_length(leftovers) > 1) {
4422 printf_err("Too many URLs specified for --output-format=lttng-live\n");
4423 goto error;
4424 }
4425
4426 gs_leftover = leftovers->data;
9009cc24 4427 lttng_live_url_parts =
94023a1c 4428 bt_common_parse_lttng_live_url(gs_leftover->str,
94b828f3 4429 error_buf, sizeof(error_buf));
9009cc24
PP		 4430 if (!lttng_live_url_parts.proto) {
4431 printf_err("Invalid LTTng live URL format: %s\n",
4432 error_buf);
4433 goto error;
4434 }
4435
4436 if (!lttng_live_url_parts.session_name) {
4437 /* Print LTTng live sessions */
4438 cfg = bt_config_print_lttng_live_sessions_create(
4439 plugin_paths);
4440 if (!cfg) {
4441 goto error;
4442 }
4443
9009cc24 4444 g_string_assign(cfg->cmd_data.print_lttng_live_sessions.url,
94023a1c 4445 gs_leftover->str);
c327e427
PP		 4446
4447 if (output) {
4448 g_string_assign(
4449 cfg->cmd_data.print_lttng_live_sessions.output_path,
4450 output);
4451 }
4452
9009cc24
PP		 4453 goto end;
4454 }
4455
e7ad156c 4456 ret = append_implicit_component_extra_param(
94023a1c
PP		 4457 &implicit_lttng_live_args, "url",
4458 gs_leftover->str);
9009cc24
PP		 4459 if (ret) {
4460 goto error;
4461 }
4462 } else {
94023a1c
PP		 4463 /*
4464 * Append one implicit component argument set
4465 * for each leftover (souce.ctf.fs paths). Copy
4466 * the base implicit component arguments.
4467 * Note that they still have to be named later.
4468 */
4469 ret = fill_implicit_ctf_inputs_args(
4470 implicit_ctf_inputs_args,
4471 &base_implicit_ctf_input_args, leftovers);
9009cc24
PP		 4472 if (ret) {
4473 goto error;
4474 }
4475 }
4476 }
4477
4478 /*
fd5f8053
PP		 4479 * Ensure mutual exclusion between implicit `source.ctf.fs` and
4480 * `source.ctf.lttng-live` components.
9009cc24 4481 */
94023a1c
PP		 4482 if (base_implicit_ctf_input_args.exists &&
4483 implicit_lttng_live_args.exists) {
fd5f8053 4484 printf_err("Cannot create both implicit `%s` and `%s` components\n",
94023a1c 4485 base_implicit_ctf_input_args.comp_arg->str,
fd5f8053 4486 implicit_lttng_live_args.comp_arg->str);
9009cc24
PP		 4487 goto error;
4488 }
4489
4490 /*
fd5f8053 4491 * If the implicit `source.ctf.fs` or `source.ctf.lttng-live`
94023a1c
PP		 4492 * components exists, make sure there's at least one leftover
4493 * (which is the path or URL).
9009cc24 4494 */
94023a1c
PP		 4495 if (base_implicit_ctf_input_args.exists &&
4496 g_list_length(leftovers) == 0) {
fd5f8053 4497 printf_err("Missing path for implicit `%s` component\n",
94023a1c 4498 base_implicit_ctf_input_args.comp_arg->str);
9009cc24
PP		 4499 goto error;
4500 }
4501
94023a1c 4502 if (implicit_lttng_live_args.exists && g_list_length(leftovers) == 0) {
fd5f8053
PP		 4503 printf_err("Missing URL for implicit `%s` component\n",
4504 implicit_lttng_live_args.comp_arg->str);
9009cc24
PP		 4505 goto error;
4506 }
4507
4508 /* Assign names to implicit components */
94023a1c
PP		 4509 for (i = 0; i < implicit_ctf_inputs_args->len; i++) {
4510 struct implicit_component_args *impl_args =
4511 g_ptr_array_index(implicit_ctf_inputs_args, i);
4512
4513 ret = assign_name_to_implicit_component(impl_args,
4514 "source-ctf-fs", all_names, &source_names, true);
4515 if (ret) {
4516 goto error;
4517 }
9009cc24
PP		 4518 }
4519
4520 ret = assign_name_to_implicit_component(&implicit_lttng_live_args,
4521 "lttng-live", all_names, &source_names, true);
4522 if (ret) {
4523 goto error;
4524 }
4525
4526 ret = assign_name_to_implicit_component(&implicit_text_args,
4527 "pretty", all_names, &sink_names, true);
4528 if (ret) {
4529 goto error;
4530 }
4531
e7ad156c
PP		 4532 ret = assign_name_to_implicit_component(&implicit_ctf_output_args,
4533 "sink-ctf-fs", all_names, &sink_names, true);
4534 if (ret) {
4535 goto error;
4536 }
4537
9009cc24
PP		 4538 ret = assign_name_to_implicit_component(&implicit_dummy_args,
4539 "dummy", all_names, &sink_names, true);
4540 if (ret) {
4541 goto error;
4542 }
4543
4544 ret = assign_name_to_implicit_component(&implicit_muxer_args,
4545 "muxer", all_names, NULL, false);
4546 if (ret) {
4547 goto error;
4548 }
4549
4550 ret = assign_name_to_implicit_component(&implicit_trimmer_args,
4551 "trimmer", all_names, NULL, false);
4552 if (ret) {
4553 goto error;
4554 }
4555
4556 ret = assign_name_to_implicit_component(&implicit_debug_info_args,
4557 "debug-info", all_names, NULL, false);
4558 if (ret) {
4559 goto error;
4560 }
4561
4562 /* Make sure there's at least one source and one sink */
4563 if (!source_names) {
4564 printf_err("No source component\n");
4565 goto error;
4566 }
4567
4568 if (!sink_names) {
4569 printf_err("No sink component\n");
4570 goto error;
4571 }
4572
4573 /*
4574 * Prepend the muxer, the trimmer, and the debug info to the
4575 * filter chain so that we have:
4576 *
4577 * sources -> muxer -> [trimmer] -> [debug info] ->
4578 * [user filters] -> sinks
4579 */
4580 if (implicit_debug_info_args.exists) {
4581 if (g_list_prepend_gstring(&filter_names,
4582 implicit_debug_info_args.name_arg->str)) {
4583 goto error;
4584 }
4585 }
4586
4587 if (implicit_trimmer_args.exists) {
4588 if (g_list_prepend_gstring(&filter_names,
4589 implicit_trimmer_args.name_arg->str)) {
4590 goto error;
4591 }
4592 }
4593
4594 if (g_list_prepend_gstring(&filter_names,
4595 implicit_muxer_args.name_arg->str)) {
4596 goto error;
4597 }
4598
4599 /*
4600 * Append the equivalent run arguments for the implicit
4601 * components.
4602 */
94023a1c
PP		 4603 for (i = 0; i < implicit_ctf_inputs_args->len; i++) {
4604 struct implicit_component_args *impl_args =
4605 g_ptr_array_index(implicit_ctf_inputs_args, i);
4606
4607 ret = append_run_args_for_implicit_component(impl_args,
4608 run_args);
4609 if (ret) {
4610 goto error;
4611 }
9009cc24
PP		 4612 }
4613
fd5f8053 4614 ret = append_run_args_for_implicit_component(&implicit_lttng_live_args,
9009cc24
PP		 4615 run_args);
4616 if (ret) {
4617 goto error;
4618 }
4619
fd5f8053
PP		 4620 ret = append_run_args_for_implicit_component(&implicit_text_args,
4621 run_args);
9009cc24
PP		 4622 if (ret) {
4623 goto error;
4624 }
4625
e7ad156c
PP		 4626 ret = append_run_args_for_implicit_component(&implicit_ctf_output_args,
4627 run_args);
4628 if (ret) {
4629 goto error;
4630 }
4631
fd5f8053
PP		 4632 ret = append_run_args_for_implicit_component(&implicit_dummy_args,
4633 run_args);
9009cc24
PP		 4634 if (ret) {
4635 goto error;
4636 }
4637
fd5f8053
PP		 4638 ret = append_run_args_for_implicit_component(&implicit_muxer_args,
4639 run_args);
9009cc24
PP		 4640 if (ret) {
4641 goto error;
4642 }
4643
fd5f8053 4644 ret = append_run_args_for_implicit_component(&implicit_trimmer_args,
9009cc24
PP		 4645 run_args);
4646 if (ret) {
4647 goto error;
4648 }
4649
fd5f8053 4650 ret = append_run_args_for_implicit_component(&implicit_debug_info_args,
9009cc24
PP		 4651 run_args);
4652 if (ret) {
4653 goto error;
4654 }
4655
4656 /* Auto-connect components */
4657 ret = convert_auto_connect(run_args, source_names, filter_names,
4658 sink_names);
4659 if (ret) {
4660 printf_err("Cannot auto-connect components\n");
4661 goto error;
4662 }
4663
4664 /*
4665 * We have all the run command arguments now. Depending on
4666 * --run-args, we pass this to the run command or print them
4667 * here.
4668 */
4669 if (print_run_args || print_run_args_0) {
c60cf081
PP		 4670 if (stream_intersection_mode) {
4671 printf_err("Cannot specify --stream-intersection with --run-args or --run-args-0\n");
4672 goto error;
4673 }
4674
05e21286
PP		 4675 for (i = 0; i < bt_value_array_get_size(run_args); i++) {
4676 const struct bt_value *arg_value =
4677 bt_value_array_borrow_element_by_index(run_args,
4678 i);
9009cc24
PP		 4679 const char *arg;
4680 GString *quoted = NULL;
4681 const char *arg_to_print;
4682
f6ccaed9 4683 BT_ASSERT(arg_value);
601b0d3c 4684 arg = bt_value_string_get(arg_value);
9009cc24
PP		 4685
4686 if (print_run_args) {
4687 quoted = bt_common_shell_quote(arg, true);
4688 if (!quoted) {
4689 goto error;
4690 }
4691
4692 arg_to_print = quoted->str;
4693 } else {
4694 arg_to_print = arg;
4695 }
4696
4697 printf("%s", arg_to_print);
4698
4699 if (quoted) {
4700 g_string_free(quoted, TRUE);
4701 }
4702
05e21286 4703 if (i < bt_value_array_get_size(run_args) - 1) {
9009cc24
PP		 4704 if (print_run_args) {
4705 putchar(' ');
4706 } else {
4707 putchar('\0');
4708 }
4709 }
4710 }
4711
4712 *retcode = -1;
65300d60 4713 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 4714 goto end;
4715 }
4716
05e21286
PP		 4717 cfg = bt_config_run_from_args_array(run_args, retcode,
4718 force_omit_system_plugin_path,
4719 force_omit_home_plugin_path,
4720 initial_plugin_paths);
fc11b6a6
PP		 4721 if (!cfg) {
4722 goto error;
4723 }
4724
75a2cb9b 4725 cfg->cmd_data.run.stream_intersection_mode = stream_intersection_mode;
9009cc24
PP		 4726 goto end;
4727
4728error:
4729 *retcode = 1;
65300d60 4730 BT_OBJECT_PUT_REF_AND_RESET(cfg);
9009cc24
PP		 4731
4732end:
4733 if (pc) {
4734 poptFreeContext(pc);
4735 }
4736
4737 free(arg);
e7ad156c 4738 free(output);
9009cc24
PP		 4739
4740 if (cur_name) {
4741 g_string_free(cur_name, TRUE);
4742 }
4743
4744 if (cur_name_prefix) {
4745 g_string_free(cur_name_prefix, TRUE);
4746 }
4747
94023a1c
PP		 4748 if (implicit_ctf_inputs_args) {
4749 g_ptr_array_free(implicit_ctf_inputs_args, TRUE);
4750 }
4751
65300d60
PP		 4752 bt_object_put_ref(run_args);
4753 bt_object_put_ref(all_names);
9009cc24
PP		 4754 destroy_glist_of_gstring(source_names);
4755 destroy_glist_of_gstring(filter_names);
4756 destroy_glist_of_gstring(sink_names);
94023a1c
PP		 4757 destroy_glist_of_gstring(leftovers);
4758 finalize_implicit_component_args(&base_implicit_ctf_input_args);
4759 finalize_implicit_component_args(&implicit_ctf_output_args);
4760 finalize_implicit_component_args(&implicit_lttng_live_args);
4761 finalize_implicit_component_args(&implicit_dummy_args);
4762 finalize_implicit_component_args(&implicit_text_args);
4763 finalize_implicit_component_args(&implicit_debug_info_args);
4764 finalize_implicit_component_args(&implicit_muxer_args);
4765 finalize_implicit_component_args(&implicit_trimmer_args);
65300d60 4766 bt_object_put_ref(plugin_paths);
9009cc24
PP		 4767 bt_common_destroy_lttng_live_url_parts(&lttng_live_url_parts);
4768 return cfg;
4769}
4770
4771/*
4772 * Prints the Babeltrace 2.x general usage.
4773 */
4774static
4775void print_gen_usage(FILE *fp)
4776{
4777 fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n");
4778 fprintf(fp, "\n");
4779 fprintf(fp, "General options:\n");
4780 fprintf(fp, "\n");
3efa3052
PP		 4781 fprintf(fp, " -d, --debug Enable debug mode (same as --log-level=V)\n");
4782 fprintf(fp, " -h, --help Show this help and quit\n");
5bd4da00 4783 fprintf(fp, " -l, --log-level=LVL Set all log levels to LVL (`N`, `V`, `D`,\n");
3efa3052
PP		 4784 fprintf(fp, " `I`, `W` (default), `E`, or `F`)\n");
4785 fprintf(fp, " -v, --verbose Enable verbose mode (same as --log-level=I)\n");
4786 fprintf(fp, " -V, --version Show version and quit\n");
9009cc24
PP		 4787 fprintf(fp, "\n");
4788 fprintf(fp, "Available commands:\n");
4789 fprintf(fp, "\n");
4790 fprintf(fp, " convert Convert and trim traces (default)\n");
4791 fprintf(fp, " help Get help for a plugin or a component class\n");
4792 fprintf(fp, " list-plugins List available plugins and their content\n");
4793 fprintf(fp, " query Query objects from a component class\n");
4794 fprintf(fp, " run Build a processing graph and run it\n");
4795 fprintf(fp, "\n");
4796 fprintf(fp, "Use `babeltrace COMMAND --help` to show the help of COMMAND.\n");
4797}
4798
3efa3052
PP		 4799static
4800char log_level_from_arg(const char *arg)
4801{
4802 char level = 'U';
4803
4804 if (strcmp(arg, "VERBOSE") == 0 ||
4805 strcmp(arg, "V") == 0) {
4806 level = 'V';
4807 } else if (strcmp(arg, "DEBUG") == 0 ||
4808 strcmp(arg, "D") == 0) {
4809 level = 'D';
4810 } else if (strcmp(arg, "INFO") == 0 ||
4811 strcmp(arg, "I") == 0) {
4812 level = 'I';
4813 } else if (strcmp(arg, "WARN") == 0 ||
4814 strcmp(arg, "WARNING") == 0 ||
4815 strcmp(arg, "W") == 0) {
4816 level = 'W';
4817 } else if (strcmp(arg, "ERROR") == 0 ||
4818 strcmp(arg, "E") == 0) {
4819 level = 'E';
4820 } else if (strcmp(arg, "FATAL") == 0 ||
4821 strcmp(arg, "F") == 0) {
4822 level = 'F';
4823 } else if (strcmp(arg, "NONE") == 0 ||
4824 strcmp(arg, "N") == 0) {
4825 level = 'N';
4826 }
4827
4828 return level;
4829}
4830
9009cc24
PP		 4831struct bt_config *bt_config_cli_args_create(int argc, const char *argv[],
4832 int *retcode, bool force_omit_system_plugin_path,
9a16feea 4833 bool force_omit_home_plugin_path,
05e21286 4834 const struct bt_value *initial_plugin_paths)
9009cc24
PP		 4835{
4836 struct bt_config *config = NULL;
9009cc24
PP		 4837 int i;
4838 const char **command_argv = NULL;
4839 int command_argc = -1;
4840 const char *command_name = NULL;
3efa3052 4841 char log_level = 'U';
9009cc24
PP		 4842
4843 enum command_type {
4844 COMMAND_TYPE_NONE = -1,
4845 COMMAND_TYPE_RUN = 0,
4846 COMMAND_TYPE_CONVERT,
4847 COMMAND_TYPE_LIST_PLUGINS,
4848 COMMAND_TYPE_HELP,
4849 COMMAND_TYPE_QUERY,
4850 } command_type = COMMAND_TYPE_NONE;
4851
4852 *retcode = -1;
4853
4854 if (!initial_plugin_paths) {
05e21286 4855 initial_plugin_paths = bt_value_array_create();
9009cc24
PP		 4856 if (!initial_plugin_paths) {
4857 *retcode = 1;
4858 goto end;
4859 }
4860 } else {
65300d60 4861 bt_object_get_ref(initial_plugin_paths);
9009cc24
PP		 4862 }
4863
4864 if (argc <= 1) {
d878cbfd
PP		 4865 print_version();
4866 puts("");
9009cc24
PP		 4867 print_gen_usage(stdout);
4868 goto end;
4869 }
4870
4871 for (i = 1; i < argc; i++) {
4872 const char *cur_arg = argv[i];
3efa3052 4873 const char *next_arg = i == (argc - 1) ? NULL : argv[i + 1];
9009cc24
PP		 4874
4875 if (strcmp(cur_arg, "-d") == 0 ||
4876 strcmp(cur_arg, "--debug") == 0) {
3efa3052 4877 log_level = 'V';
9009cc24
PP		 4878 } else if (strcmp(cur_arg, "-v") == 0 ||
4879 strcmp(cur_arg, "--verbose") == 0) {
3efa3052
PP		 4880 if (log_level != 'V' && log_level != 'D') {
4881 /*
4882 * Legacy: do not override a previous
4883 * --debug because --verbose and --debug
4884 * can be specified together (in this
4885 * case we want the lowest log level to
4886 * apply, VERBOSE).
4887 */
4888 log_level = 'I';
4889 }
5bd4da00
PP		 4890 } else if (strcmp(cur_arg, "--log-level") == 0 ||
4891 strcmp(cur_arg, "-l") == 0) {
3efa3052
PP		 4892 if (!next_arg) {
4893 printf_err("Missing log level value for --log-level option\n");
4894 *retcode = 1;
4895 goto end;
4896 }
4897
4898 log_level = log_level_from_arg(next_arg);
4899 if (log_level == 'U') {
4900 printf_err("Invalid argument for --log-level option:\n %s\n",
4901 next_arg);
4902 *retcode = 1;
4903 goto end;
4904 }
4905
4906 i++;
4907 } else if (strncmp(cur_arg, "--log-level=", 12) == 0) {
4908 const char *arg = &cur_arg[12];
4909
5bd4da00
PP		 4910 log_level = log_level_from_arg(arg);
4911 if (log_level == 'U') {
4912 printf_err("Invalid argument for --log-level option:\n %s\n",
4913 arg);
4914 *retcode = 1;
4915 goto end;
4916 }
4917 } else if (strncmp(cur_arg, "-l", 2) == 0) {
4918 const char *arg = &cur_arg[2];
4919
3efa3052
PP		 4920 log_level = log_level_from_arg(arg);
4921 if (log_level == 'U') {
4922 printf_err("Invalid argument for --log-level option:\n %s\n",
4923 arg);
4924 *retcode = 1;
4925 goto end;
4926 }
9009cc24
PP		 4927 } else if (strcmp(cur_arg, "-V") == 0 ||
4928 strcmp(cur_arg, "--version") == 0) {
4929 print_version();
4930 goto end;
4931 } else if (strcmp(cur_arg, "-h") == 0 ||
4932 strcmp(cur_arg, "--help") == 0) {
4933 print_gen_usage(stdout);
4934 goto end;
4935 } else {
9009cc24
PP		 4936 /*
4937 * First unknown argument: is it a known command
4938 * name?
4939 */
3efa3052
PP		 4940 command_argv = &argv[i];
4941 command_argc = argc - i;
4942
9009cc24
PP		 4943 if (strcmp(cur_arg, "convert") == 0) {
4944 command_type = COMMAND_TYPE_CONVERT;
4945 } else if (strcmp(cur_arg, "list-plugins") == 0) {
4946 command_type = COMMAND_TYPE_LIST_PLUGINS;
4947 } else if (strcmp(cur_arg, "help") == 0) {
4948 command_type = COMMAND_TYPE_HELP;
4949 } else if (strcmp(cur_arg, "query") == 0) {
4950 command_type = COMMAND_TYPE_QUERY;
4951 } else if (strcmp(cur_arg, "run") == 0) {
4952 command_type = COMMAND_TYPE_RUN;
4953 } else {
4954 /*
4955 * Unknown argument, but not a known
3efa3052
PP		 4956 * command name: assume the default
4957 * `convert` command.
9009cc24
PP		 4958 */
4959 command_type = COMMAND_TYPE_CONVERT;
3efa3052
PP		 4960 command_name = "convert";
4961 command_argv = &argv[i - 1];
4962 command_argc = argc - i + 1;
9009cc24
PP		 4963 }
4964 break;
4965 }
4966 }
4967
4968 if (command_type == COMMAND_TYPE_NONE) {
4969 /*
4970 * We only got non-help, non-version general options
4971 * like --verbose and --debug, without any other
4972 * arguments, so we can't do anything useful: print the
4973 * usage and quit.
4974 */
4975 print_gen_usage(stdout);
4976 goto end;
4977 }
4978
f6ccaed9
PP		 4979 BT_ASSERT(command_argv);
4980 BT_ASSERT(command_argc >= 0);
9009cc24
PP		 4981
4982 switch (command_type) {
4983 case COMMAND_TYPE_RUN:
4984 config = bt_config_run_from_args(command_argc, command_argv,
4985 retcode, force_omit_system_plugin_path,
4986 force_omit_home_plugin_path, initial_plugin_paths);
4987 break;
4988 case COMMAND_TYPE_CONVERT:
4989 config = bt_config_convert_from_args(command_argc, command_argv,
4990 retcode, force_omit_system_plugin_path,
9a16feea 4991 force_omit_home_plugin_path,
3efa3052 4992 initial_plugin_paths, &log_level);
9009cc24
PP		 4993 break;
4994 case COMMAND_TYPE_LIST_PLUGINS:
4995 config = bt_config_list_plugins_from_args(command_argc,
4996 command_argv, retcode, force_omit_system_plugin_path,
4997 force_omit_home_plugin_path, initial_plugin_paths);
4998 break;
4999 case COMMAND_TYPE_HELP:
5000 config = bt_config_help_from_args(command_argc,
5001 command_argv, retcode, force_omit_system_plugin_path,
5002 force_omit_home_plugin_path, initial_plugin_paths);
5003 break;
5004 case COMMAND_TYPE_QUERY:
5005 config = bt_config_query_from_args(command_argc,
5006 command_argv, retcode, force_omit_system_plugin_path,
5007 force_omit_home_plugin_path, initial_plugin_paths);
5008 break;
5009 default:
0fbb9a9f 5010 abort();
9009cc24
PP		 5011 }
5012
5013 if (config) {
3efa3052
PP		 5014 if (log_level == 'U') {
5015 log_level = 'W';
9009cc24
PP		 5016 }
5017
3efa3052 5018 config->log_level = log_level;
9009cc24
PP		 5019 config->command_name = command_name;
5020 }
5021
5022end:
65300d60 5023 bt_object_put_ref(initial_plugin_paths);
9009cc24
PP		 5024 return config;
5025}
BabelTrace - Trace Format Babel Tower
This page took 0.262165 seconds and 4 git commands to generate.