Commit | Line | Data |
---|---|---|
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 | ||
60 | static bool is_first_error = true; | |
61 | ||
62 | /* INI-style parsing FSM states */ | |
63 | enum 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 */ | |
81 | struct 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 */ | |
102 | struct offset_opt { | |
103 | int64_t value; | |
104 | bool is_set; | |
105 | }; | |
106 | ||
107 | /* Legacy "ctf"/"lttng-live" format options */ | |
108 | struct 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 */ | |
115 | struct 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 */ | |
137 | enum 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 */ | |
144 | enum 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 | */ | |
153 | static | |
154 | void 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 | */ | |
163 | static | |
164 | void 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 | ||
191 | static | |
192 | int 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 | ||
406 | error: | |
407 | ret = -1; | |
408 | goto end; | |
409 | ||
410 | success: | |
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 | ||
419 | end: | |
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 | */ | |
429 | static | |
05e21286 | 430 | struct 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 | ||
537 | error: | |
65300d60 | 538 | BT_OBJECT_PUT_REF_AND_RESET(state.params); |
9009cc24 PP |
539 | |
540 | end: | |
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 | */ | |
555 | static | |
05e21286 | 556 | struct 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 | ||
574 | end: | |
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 | */ |
597 | static | |
598 | void 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 | ||
696 | error: | |
282c8cd0 PP |
697 | if (name) { |
698 | *name = NULL; | |
699 | } | |
700 | ||
701 | *plugin = NULL; | |
702 | *comp_cls = NULL; | |
703 | ||
704 | end: | |
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 | */ | |
727 | static | |
728 | void 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 | */ | |
740 | static | |
741 | void 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 | ||
765 | end: | |
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 | */ | |
776 | static | |
777 | struct 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 | ||
819 | error: | |
65300d60 | 820 | BT_OBJECT_PUT_REF_AND_RESET(cfg_component); |
9009cc24 PP |
821 | |
822 | end: | |
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 | */ | |
830 | static | |
fd5f8053 | 831 | struct 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 | ||
855 | error: | |
65300d60 | 856 | BT_OBJECT_PUT_REF_AND_RESET(cfg_comp); |
9009cc24 PP |
857 | |
858 | end: | |
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 | */ | |
868 | static | |
869 | void 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 | ||
936 | end: | |
937 | return; | |
938 | } | |
939 | ||
940 | static | |
941 | void 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 | */ | |
962 | static | |
963 | GScanner *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 | */ | |
1009 | static | |
05e21286 | 1010 | struct 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 | ||
1087 | end: | |
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 | ||
1106 | error: | |
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 | */ | |
1121 | static | |
05e21286 | 1122 | struct 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 | ||
1179 | error: | |
65300d60 | 1180 | BT_OBJECT_PUT_REF_AND_RESET(fields); |
9009cc24 PP |
1181 | |
1182 | end: | |
1183 | if (scanner) { | |
1184 | g_scanner_destroy(scanner); | |
1185 | } | |
1186 | return fields; | |
1187 | } | |
1188 | ||
1189 | static | |
1190 | void 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 | */ | |
1209 | static | |
1210 | int 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 | ||
1286 | end: | |
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 */ | |
1299 | enum { | |
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 | ||
1345 | enum 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 | */ | |
1356 | static | |
1357 | void 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 | ||
1378 | static | |
1379 | int 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 | ||
1409 | end: | |
1410 | return ret; | |
1411 | } | |
1412 | ||
1413 | static | |
05e21286 | 1414 | int 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 | ||
1431 | end: | |
1432 | if (ret) { | |
1433 | printf_err("Cannot append plugin paths from BABELTRACE_PLUGIN_PATH\n"); | |
1434 | } | |
1435 | ||
1436 | return ret; | |
1437 | } | |
1438 | ||
1439 | static | |
05e21286 | 1440 | int 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; | |
1473 | error: | |
1474 | printf_err("Cannot append home and system plugin paths\n"); | |
1475 | return -1; | |
1476 | } | |
1477 | ||
1478 | static | |
1479 | int 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 | ||
1485 | static | |
1486 | struct 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 | ||
1519 | error: | |
65300d60 | 1520 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1521 | |
1522 | end: | |
1523 | return cfg; | |
1524 | } | |
1525 | ||
1526 | static | |
1527 | struct 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 | ||
1569 | error: | |
65300d60 | 1570 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1571 | |
1572 | end: | |
1573 | return cfg; | |
1574 | } | |
1575 | ||
1576 | static | |
1577 | struct 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 | ||
1591 | error: | |
65300d60 | 1592 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1593 | |
1594 | end: | |
1595 | return cfg; | |
1596 | } | |
1597 | ||
1598 | static | |
1599 | struct 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 | ||
1619 | error: | |
65300d60 | 1620 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1621 | |
1622 | end: | |
1623 | return cfg; | |
1624 | } | |
1625 | ||
1626 | static | |
1627 | struct 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 | ||
1647 | error: | |
65300d60 | 1648 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1649 | |
1650 | end: | |
1651 | return cfg; | |
1652 | } | |
1653 | ||
1654 | static | |
1655 | struct 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 | ||
1681 | error: | |
65300d60 | 1682 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1683 | |
1684 | end: | |
1685 | return cfg; | |
1686 | } | |
1687 | ||
1688 | static | |
1689 | struct 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 | ||
1716 | error: | |
65300d60 | 1717 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1718 | |
1719 | end: | |
1720 | return cfg; | |
1721 | } | |
1722 | ||
1723 | static | |
1724 | int 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 | ||
1741 | end: | |
1742 | return ret; | |
1743 | } | |
1744 | ||
1745 | /* | |
1746 | * Prints the expected format for a --params option. | |
1747 | */ | |
1748 | static | |
1749 | void 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 | */ | |
1786 | static | |
1787 | void 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 | ||
1806 | static | |
1807 | struct 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 | */ | |
1822 | static | |
1823 | struct 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 | ||
1929 | error: | |
1930 | *retcode = 1; | |
65300d60 | 1931 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
1932 | |
1933 | end: | |
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 | */ | |
1948 | static | |
1949 | void 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 | ||
1967 | static | |
1968 | struct 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 | */ | |
1984 | static | |
1985 | struct 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 | ||
2121 | error: | |
2122 | *retcode = 1; | |
65300d60 | 2123 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
2124 | |
2125 | end: | |
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 | */ | |
2138 | static | |
2139 | void 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 | ||
2157 | static | |
2158 | struct 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 | */ | |
2173 | static | |
2174 | struct 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 | ||
2259 | error: | |
2260 | *retcode = 1; | |
65300d60 | 2261 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
2262 | |
2263 | end: | |
2264 | if (pc) { | |
2265 | poptFreeContext(pc); | |
2266 | } | |
2267 | ||
2268 | free(arg); | |
2269 | return cfg; | |
2270 | } | |
2271 | ||
2272 | /* | |
2273 | * Prints the run command usage. | |
2274 | */ | |
2275 | static | |
2276 | void 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 | */ | |
2363 | static | |
2364 | struct 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 | ||
601b0d3c | 2536 | status = bt_value_map_extend(¶ms_to_set, |
05e21286 PP |
2537 | cur_cfg_comp->params, |
2538 | params); | |
65300d60 | 2539 | BT_OBJECT_PUT_REF_AND_RESET(params); |
601b0d3c | 2540 | if (status != BT_VALUE_STATUS_OK) { |
9009cc24 PP |
2541 | printf_err("Cannot extend current component parameters with --params option's argument:\n %s\n", |
2542 | arg); | |
2543 | goto error; | |
2544 | } | |
2545 | ||
65300d60 | 2546 | BT_OBJECT_MOVE_REF(cur_cfg_comp->params, params_to_set); |
9009cc24 PP |
2547 | break; |
2548 | } | |
2549 | case OPT_KEY: | |
2550 | if (strlen(arg) == 0) { | |
2551 | printf_err("Cannot set an empty string as the current parameter key\n"); | |
2552 | goto error; | |
2553 | } | |
2554 | ||
2555 | g_string_assign(cur_param_key, arg); | |
2556 | break; | |
2557 | case OPT_VALUE: | |
2558 | if (!cur_cfg_comp) { | |
2559 | printf_err("Cannot set a parameter's value of unavailable component:\n %s\n", | |
2560 | arg); | |
2561 | goto error; | |
2562 | } | |
2563 | ||
2564 | if (cur_param_key->len == 0) { | |
2565 | printf_err("--value option specified without preceding --key option:\n %s\n", | |
2566 | arg); | |
2567 | goto error; | |
2568 | } | |
2569 | ||
05e21286 | 2570 | if (bt_value_map_insert_string_entry(cur_cfg_comp->params, |
9009cc24 PP |
2571 | cur_param_key->str, arg)) { |
2572 | print_err_oom(); | |
2573 | goto error; | |
2574 | } | |
2575 | break; | |
2576 | case OPT_NAME: | |
2577 | if (!cur_cfg_comp) { | |
2578 | printf_err("Cannot set the name of unavailable component:\n %s\n", | |
2579 | arg); | |
2580 | goto error; | |
2581 | } | |
2582 | ||
2583 | g_string_assign(cur_cfg_comp->instance_name, arg); | |
2584 | break; | |
2585 | case OPT_BASE_PARAMS: | |
2586 | { | |
05e21286 PP |
2587 | struct bt_value *params = |
2588 | bt_value_from_arg(arg); | |
9009cc24 PP |
2589 | |
2590 | if (!params) { | |
2591 | printf_err("Invalid format for --base-params option's argument:\n %s\n", | |
2592 | arg); | |
2593 | goto error; | |
2594 | } | |
2595 | ||
65300d60 | 2596 | BT_OBJECT_MOVE_REF(cur_base_params, params); |
9009cc24 PP |
2597 | break; |
2598 | } | |
2599 | case OPT_RESET_BASE_PARAMS: | |
65300d60 | 2600 | BT_OBJECT_PUT_REF_AND_RESET(cur_base_params); |
05e21286 | 2601 | cur_base_params = bt_value_map_create(); |
9009cc24 PP |
2602 | if (!cur_base_params) { |
2603 | print_err_oom(); | |
2604 | goto error; | |
2605 | } | |
2606 | break; | |
2607 | case OPT_CONNECT: | |
05e21286 | 2608 | if (bt_value_array_append_string_element( |
07208d85 | 2609 | connection_args, arg)) { |
9009cc24 PP |
2610 | print_err_oom(); |
2611 | goto error; | |
2612 | } | |
2613 | break; | |
2614 | case OPT_RETRY_DURATION: | |
2615 | if (retry_duration < 0) { | |
5b70610d | 2616 | printf_err("--retry-duration option's argument must be positive or 0: %ld\n", |
9009cc24 PP |
2617 | retry_duration); |
2618 | goto error; | |
2619 | } | |
2620 | ||
2621 | cfg->cmd_data.run.retry_duration_us = | |
2622 | (uint64_t) retry_duration; | |
2623 | break; | |
2624 | case OPT_HELP: | |
2625 | print_run_usage(stdout); | |
2626 | *retcode = -1; | |
65300d60 | 2627 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
2628 | goto end; |
2629 | default: | |
2630 | printf_err("Unknown command-line option specified (option code %d)\n", | |
2631 | opt); | |
2632 | goto error; | |
2633 | } | |
2634 | ||
2635 | free(arg); | |
2636 | arg = NULL; | |
2637 | } | |
2638 | ||
2639 | /* Check for option parsing error */ | |
2640 | if (opt < -1) { | |
2641 | printf_err("While parsing command-line options, at option %s: %s\n", | |
2642 | poptBadOption(pc, 0), poptStrerror(opt)); | |
2643 | goto error; | |
2644 | } | |
2645 | ||
2646 | /* This command does not accept leftover arguments */ | |
2647 | if (poptPeekArg(pc)) { | |
2648 | printf_err("Unexpected argument: %s\n", poptPeekArg(pc)); | |
2649 | goto error; | |
2650 | } | |
2651 | ||
2652 | /* Add current component */ | |
2653 | if (cur_cfg_comp) { | |
2654 | ret = add_run_cfg_comp_check_name(cfg, cur_cfg_comp, | |
2655 | cur_cfg_comp_dest, instance_names); | |
65300d60 | 2656 | BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp); |
9009cc24 PP |
2657 | if (ret) { |
2658 | goto error; | |
2659 | } | |
2660 | } | |
2661 | ||
2662 | if (cfg->cmd_data.run.sources->len == 0) { | |
2663 | printf_err("Incomplete graph: no source component\n"); | |
2664 | goto error; | |
2665 | } | |
2666 | ||
2667 | if (cfg->cmd_data.run.sinks->len == 0) { | |
2668 | printf_err("Incomplete graph: no sink component\n"); | |
2669 | goto error; | |
2670 | } | |
2671 | ||
2672 | if (append_home_and_system_plugin_paths_cfg(cfg)) { | |
2673 | goto error; | |
2674 | } | |
2675 | ||
da91b29a | 2676 | ret = bt_config_cli_args_create_connections(cfg, |
05e21286 | 2677 | connection_args, |
9009cc24 PP |
2678 | error_buf, 256); |
2679 | if (ret) { | |
2680 | printf_err("Cannot creation connections:\n%s", error_buf); | |
2681 | goto error; | |
2682 | } | |
2683 | ||
2684 | goto end; | |
2685 | ||
2686 | error: | |
2687 | *retcode = 1; | |
65300d60 | 2688 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
2689 | |
2690 | end: | |
2691 | if (pc) { | |
2692 | poptFreeContext(pc); | |
2693 | } | |
2694 | ||
2695 | if (cur_param_key) { | |
2696 | g_string_free(cur_param_key, TRUE); | |
2697 | } | |
2698 | ||
2699 | free(arg); | |
65300d60 PP |
2700 | BT_OBJECT_PUT_REF_AND_RESET(cur_cfg_comp); |
2701 | BT_OBJECT_PUT_REF_AND_RESET(cur_base_params); | |
2702 | BT_OBJECT_PUT_REF_AND_RESET(instance_names); | |
2703 | BT_OBJECT_PUT_REF_AND_RESET(connection_args); | |
9009cc24 PP |
2704 | return cfg; |
2705 | } | |
2706 | ||
2707 | static | |
05e21286 | 2708 | struct bt_config *bt_config_run_from_args_array(const struct bt_value *run_args, |
9009cc24 PP |
2709 | int *retcode, bool force_omit_system_plugin_path, |
2710 | bool force_omit_home_plugin_path, | |
05e21286 | 2711 | const struct bt_value *initial_plugin_paths) |
9009cc24 PP |
2712 | { |
2713 | struct bt_config *cfg = NULL; | |
2714 | const char **argv; | |
0ca8409d | 2715 | int64_t i, len; |
07208d85 | 2716 | const size_t argc = bt_value_array_get_size(run_args) + 1; |
9009cc24 PP |
2717 | |
2718 | argv = calloc(argc, sizeof(*argv)); | |
2719 | if (!argv) { | |
2720 | print_err_oom(); | |
2721 | goto end; | |
2722 | } | |
2723 | ||
2724 | argv[0] = "run"; | |
2725 | ||
07208d85 | 2726 | len = bt_value_array_get_size(run_args); |
0ca8409d MD |
2727 | if (len < 0) { |
2728 | printf_err("Invalid executable arguments\n"); | |
2729 | goto end; | |
2730 | } | |
2731 | for (i = 0; i < len; i++) { | |
05e21286 PP |
2732 | const struct bt_value *arg_value = |
2733 | bt_value_array_borrow_element_by_index_const(run_args, | |
2734 | i); | |
9009cc24 PP |
2735 | const char *arg; |
2736 | ||
f6ccaed9 | 2737 | BT_ASSERT(arg_value); |
601b0d3c | 2738 | arg = bt_value_string_get(arg_value); |
f6ccaed9 | 2739 | BT_ASSERT(arg); |
9009cc24 | 2740 | argv[i + 1] = arg; |
9009cc24 PP |
2741 | } |
2742 | ||
2743 | cfg = bt_config_run_from_args(argc, argv, retcode, | |
2744 | force_omit_system_plugin_path, force_omit_home_plugin_path, | |
2745 | initial_plugin_paths); | |
2746 | ||
2747 | end: | |
2748 | free(argv); | |
2749 | return cfg; | |
2750 | } | |
2751 | ||
2752 | /* | |
2753 | * Prints the convert command usage. | |
2754 | */ | |
2755 | static | |
2756 | void print_convert_usage(FILE *fp) | |
2757 | { | |
2758 | fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] [convert] [OPTIONS] [PATH/URL]\n"); | |
2759 | fprintf(fp, "\n"); | |
2760 | fprintf(fp, "Options:\n"); | |
2761 | fprintf(fp, "\n"); | |
fd5f8053 PP |
2762 | fprintf(fp, " -c, --component=[NAME:]TYPE.PLUGIN.CLS\n"); |
2763 | fprintf(fp, " Instantiate the component class CLS of type\n"); | |
2764 | fprintf(fp, " TYPE (`source`, `filter`, or `sink`) found\n"); | |
2765 | fprintf(fp, " in the plugin PLUGIN, add it to the\n"); | |
2766 | fprintf(fp, " conversion graph, and optionally name it\n"); | |
2767 | fprintf(fp, " NAME (you can also specify the name with\n"); | |
2768 | fprintf(fp, " --name)\n"); | |
9009cc24 PP |
2769 | fprintf(fp, " --name=NAME Set the name of the current component\n"); |
2770 | fprintf(fp, " to NAME (must be unique amongst all the\n"); | |
2771 | fprintf(fp, " names of the created components)\n"); | |
2772 | fprintf(fp, " --omit-home-plugin-path Omit home plugins from plugin search path\n"); | |
2773 | fprintf(fp, " (~/.local/lib/babeltrace/plugins)\n"); | |
2774 | fprintf(fp, " --omit-system-plugin-path Omit system plugins from plugin search path\n"); | |
2775 | fprintf(fp, " -p, --params=PARAMS Add initialization parameters PARAMS to the\n"); | |
2776 | fprintf(fp, " current component (see the expected format\n"); | |
2777 | fprintf(fp, " of PARAMS below)\n"); | |
2778 | fprintf(fp, " -P, --path=PATH Set the `path` string parameter of the\n"); | |
2779 | fprintf(fp, " current component to PATH\n"); | |
2780 | fprintf(fp, " --plugin-path=PATH[:PATH]... Add PATH to the list of paths from which\n"); | |
2781 | fprintf(fp, " --retry-duration=DUR When babeltrace(1) needs to retry to run\n"); | |
2782 | fprintf(fp, " the graph later, retry in DUR µs\n"); | |
2783 | fprintf(fp, " (default: 100000)\n"); | |
2784 | fprintf(fp, " dynamic plugins can be loaded\n"); | |
2785 | fprintf(fp, " --run-args Print the equivalent arguments for the\n"); | |
2786 | fprintf(fp, " `run` command to the standard output,\n"); | |
2787 | fprintf(fp, " formatted for a shell, and quit\n"); | |
2788 | fprintf(fp, " --run-args-0 Print the equivalent arguments for the\n"); | |
2789 | fprintf(fp, " `run` command to the standard output,\n"); | |
2790 | fprintf(fp, " formatted for `xargs -0`, and quit\n"); | |
8ed0bf10 PP |
2791 | fprintf(fp, " --stream-intersection Only process events when all streams\n"); |
2792 | fprintf(fp, " are active\n"); | |
9009cc24 PP |
2793 | fprintf(fp, " -u, --url=URL Set the `url` string parameter of the\n"); |
2794 | fprintf(fp, " current component to URL\n"); | |
3efa3052 | 2795 | fprintf(fp, " -h, --help Show this help and quit\n"); |
9009cc24 | 2796 | fprintf(fp, "\n"); |
e7ad156c | 2797 | fprintf(fp, "Implicit `source.ctf.fs` component options:\n"); |
9009cc24 PP |
2798 | fprintf(fp, "\n"); |
2799 | fprintf(fp, " --clock-offset=SEC Set clock offset to SEC seconds\n"); | |
2800 | fprintf(fp, " --clock-offset-ns=NS Set clock offset to NS ns\n"); | |
9009cc24 | 2801 | fprintf(fp, "\n"); |
e7ad156c | 2802 | fprintf(fp, "Implicit `sink.text.pretty` component options:\n"); |
9009cc24 PP |
2803 | fprintf(fp, "\n"); |
2804 | fprintf(fp, " --clock-cycles Print timestamps in clock cycles\n"); | |
2805 | fprintf(fp, " --clock-date Print timestamp dates\n"); | |
2806 | fprintf(fp, " --clock-gmt Print and parse timestamps in the GMT\n"); | |
2807 | fprintf(fp, " time zone instead of the local time zone\n"); | |
2808 | fprintf(fp, " --clock-seconds Print the timestamps as `SEC.NS` instead\n"); | |
2809 | fprintf(fp, " of `hh:mm:ss.nnnnnnnnn`\n"); | |
2810 | fprintf(fp, " --color=(never | auto | always)\n"); | |
2811 | fprintf(fp, " Never, automatically, or always emit\n"); | |
2812 | fprintf(fp, " console color codes\n"); | |
2813 | fprintf(fp, " -f, --fields=FIELD[,FIELD]... Print additional fields; FIELD can be:\n"); | |
2814 | fprintf(fp, " `all`, `trace`, `trace:hostname`,\n"); | |
2815 | fprintf(fp, " `trace:domain`, `trace:procname`,\n"); | |
2816 | fprintf(fp, " `trace:vpid`, `loglevel`, `emf`\n"); | |
2817 | fprintf(fp, " -n, --names=NAME[,NAME]... Print field names; NAME can be:\n"); | |
2818 | fprintf(fp, " `payload` (or `arg` or `args`), `none`,\n"); | |
2819 | fprintf(fp, " `all`, `scope`, `header`, `context`\n"); | |
2820 | fprintf(fp, " (or `ctx`)\n"); | |
2821 | fprintf(fp, " --no-delta Do not print time delta between\n"); | |
2822 | fprintf(fp, " consecutive events\n"); | |
2823 | fprintf(fp, " -w, --output=PATH Write output text to PATH instead of\n"); | |
2824 | fprintf(fp, " the standard output\n"); | |
2825 | fprintf(fp, "\n"); | |
e7ad156c | 2826 | fprintf(fp, "Implicit `filter.utils.muxer` component options:\n"); |
9009cc24 PP |
2827 | fprintf(fp, "\n"); |
2828 | fprintf(fp, " --clock-force-correlate Assume that clocks are inherently\n"); | |
2829 | fprintf(fp, " correlated across traces\n"); | |
2830 | fprintf(fp, "\n"); | |
e7ad156c | 2831 | fprintf(fp, "Implicit `filter.utils.trimmer` component options:\n"); |
9009cc24 PP |
2832 | fprintf(fp, "\n"); |
2833 | fprintf(fp, " -b, --begin=BEGIN Set the beginning time of the conversion\n"); | |
2834 | fprintf(fp, " time range to BEGIN (see the format of\n"); | |
2835 | fprintf(fp, " BEGIN below)\n"); | |
2836 | fprintf(fp, " -e, --end=END Set the end time of the conversion time\n"); | |
2837 | fprintf(fp, " range to END (see the format of END below)\n"); | |
2838 | fprintf(fp, " -t, --timerange=TIMERANGE Set conversion time range to TIMERANGE:\n"); | |
2839 | fprintf(fp, " BEGIN,END or [BEGIN,END] (literally `[` and\n"); | |
2840 | fprintf(fp, " `]`) (see the format of BEGIN/END below)\n"); | |
2841 | fprintf(fp, "\n"); | |
e7ad156c | 2842 | fprintf(fp, "Implicit `filter.lttng-utils.debug-info` component options:\n"); |
9009cc24 | 2843 | fprintf(fp, "\n"); |
9a16feea PP |
2844 | fprintf(fp, " --debug-info Create an implicit\n"); |
2845 | fprintf(fp, " `filter.lttng-utils.debug-info` component\n"); | |
9009cc24 PP |
2846 | fprintf(fp, " --debug-info-dir=DIR Search for debug info in directory DIR\n"); |
2847 | fprintf(fp, " instead of `/usr/lib/debug`\n"); | |
2848 | fprintf(fp, " --debug-info-full-path Show full debug info source and\n"); | |
2849 | fprintf(fp, " binary paths instead of just names\n"); | |
2850 | fprintf(fp, " --debug-info-target-prefix=DIR\n"); | |
2851 | fprintf(fp, " Use directory DIR as a prefix when\n"); | |
2852 | fprintf(fp, " looking up executables during debug\n"); | |
2853 | fprintf(fp, " info analysis\n"); | |
9009cc24 PP |
2854 | fprintf(fp, "\n"); |
2855 | fprintf(fp, "Legacy options that still work:\n"); | |
2856 | fprintf(fp, "\n"); | |
2857 | fprintf(fp, " -i, --input-format=(ctf | lttng-live)\n"); | |
2858 | fprintf(fp, " `ctf`:\n"); | |
fd5f8053 | 2859 | fprintf(fp, " Create an implicit `source.ctf.fs`\n"); |
9009cc24 PP |
2860 | fprintf(fp, " component\n"); |
2861 | fprintf(fp, " `lttng-live`:\n"); | |
fd5f8053 PP |
2862 | fprintf(fp, " Create an implicit `source.ctf.lttng-live`\n"); |
2863 | fprintf(fp, " component\n"); | |
e7ad156c | 2864 | fprintf(fp, " -o, --output-format=(text | ctf | dummy | ctf-metadata)\n"); |
9009cc24 | 2865 | fprintf(fp, " `text`:\n"); |
fd5f8053 | 2866 | fprintf(fp, " Create an implicit `sink.text.pretty`\n"); |
9009cc24 | 2867 | fprintf(fp, " component\n"); |
dd46f7ea | 2868 | fprintf(fp, " `ctf`:\n"); |
e7ad156c PP |
2869 | fprintf(fp, " Create an implicit `sink.ctf.fs`\n"); |
2870 | fprintf(fp, " component\n"); | |
9009cc24 | 2871 | fprintf(fp, " `dummy`:\n"); |
fd5f8053 | 2872 | fprintf(fp, " Create an implicit `sink.utils.dummy`\n"); |
9009cc24 PP |
2873 | fprintf(fp, " component\n"); |
2874 | fprintf(fp, " `ctf-metadata`:\n"); | |
fd5f8053 PP |
2875 | fprintf(fp, " Query the `source.ctf.fs` component class\n"); |
2876 | fprintf(fp, " for metadata text and quit\n"); | |
9009cc24 PP |
2877 | fprintf(fp, "\n"); |
2878 | fprintf(fp, "See `babeltrace --help` for the list of general options.\n"); | |
2879 | fprintf(fp, "\n\n"); | |
2880 | fprintf(fp, "Format of BEGIN and END\n"); | |
2881 | fprintf(fp, "-----------------------\n"); | |
2882 | fprintf(fp, "\n"); | |
2883 | fprintf(fp, " [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]\n"); | |
2884 | fprintf(fp, "\n\n"); | |
2885 | print_expected_params_format(fp); | |
2886 | } | |
2887 | ||
2888 | static | |
2889 | struct poptOption convert_long_options[] = { | |
2890 | /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ | |
2891 | { "begin", 'b', POPT_ARG_STRING, NULL, OPT_BEGIN, NULL, NULL }, | |
2892 | { "clock-cycles", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL }, | |
2893 | { "clock-date", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL }, | |
2894 | { "clock-force-correlate", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL }, | |
2895 | { "clock-gmt", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL }, | |
2896 | { "clock-offset", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL }, | |
2897 | { "clock-offset-ns", '\0', POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL }, | |
2898 | { "clock-seconds", '\0', POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL }, | |
2899 | { "color", '\0', POPT_ARG_STRING, NULL, OPT_COLOR, NULL, NULL }, | |
fd5f8053 | 2900 | { "component", 'c', POPT_ARG_STRING, NULL, OPT_COMPONENT, NULL, NULL }, |
9009cc24 PP |
2901 | { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL }, |
2902 | { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL }, | |
2903 | { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL }, | |
2904 | { "debug-info-target-prefix", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_TARGET_PREFIX, NULL, NULL }, | |
2905 | { "end", 'e', POPT_ARG_STRING, NULL, OPT_END, NULL, NULL }, | |
2906 | { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL }, | |
9009cc24 PP |
2907 | { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, |
2908 | { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL }, | |
2909 | { "name", '\0', POPT_ARG_STRING, NULL, OPT_NAME, NULL, NULL }, | |
2910 | { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL }, | |
9a16feea | 2911 | { "debug-info", '\0', POPT_ARG_NONE, NULL, OPT_DEBUG_INFO, NULL, NULL }, |
9009cc24 PP |
2912 | { "no-delta", '\0', POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL }, |
2913 | { "omit-home-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_HOME_PLUGIN_PATH, NULL, NULL }, | |
2914 | { "omit-system-plugin-path", '\0', POPT_ARG_NONE, NULL, OPT_OMIT_SYSTEM_PLUGIN_PATH, NULL, NULL }, | |
2915 | { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT, NULL, NULL }, | |
2916 | { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL }, | |
2917 | { "params", 'p', POPT_ARG_STRING, NULL, OPT_PARAMS, NULL, NULL }, | |
2918 | { "path", 'P', POPT_ARG_STRING, NULL, OPT_PATH, NULL, NULL }, | |
2919 | { "plugin-path", '\0', POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL }, | |
2920 | { "retry-duration", '\0', POPT_ARG_STRING, NULL, OPT_RETRY_DURATION, NULL, NULL }, | |
2921 | { "run-args", '\0', POPT_ARG_NONE, NULL, OPT_RUN_ARGS, NULL, NULL }, | |
2922 | { "run-args-0", '\0', POPT_ARG_NONE, NULL, OPT_RUN_ARGS_0, NULL, NULL }, | |
9009cc24 PP |
2923 | { "stream-intersection", '\0', POPT_ARG_NONE, NULL, OPT_STREAM_INTERSECTION, NULL, NULL }, |
2924 | { "timerange", '\0', POPT_ARG_STRING, NULL, OPT_TIMERANGE, NULL, NULL }, | |
2925 | { "url", 'u', POPT_ARG_STRING, NULL, OPT_URL, NULL, NULL }, | |
2926 | { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL }, | |
2927 | { NULL, 0, '\0', NULL, 0, NULL, NULL }, | |
2928 | }; | |
2929 | ||
2930 | static | |
2931 | GString *get_component_auto_name(const char *prefix, | |
05e21286 | 2932 | const struct bt_value *existing_names) |
9009cc24 PP |
2933 | { |
2934 | unsigned int i = 0; | |
2935 | GString *auto_name = g_string_new(NULL); | |
2936 | ||
2937 | if (!auto_name) { | |
2938 | print_err_oom(); | |
2939 | goto end; | |
2940 | } | |
2941 | ||
07208d85 | 2942 | if (!bt_value_map_has_entry(existing_names, prefix)) { |
9009cc24 PP |
2943 | g_string_assign(auto_name, prefix); |
2944 | goto end; | |
2945 | } | |
2946 | ||
2947 | do { | |
2948 | g_string_printf(auto_name, "%s-%d", prefix, i); | |
2949 | i++; | |
07208d85 | 2950 | } while (bt_value_map_has_entry(existing_names, auto_name->str)); |
9009cc24 PP |
2951 | |
2952 | end: | |
2953 | return auto_name; | |
2954 | } | |
2955 | ||
2956 | struct implicit_component_args { | |
2957 | bool exists; | |
fd5f8053 | 2958 | GString *comp_arg; |
9009cc24 PP |
2959 | GString *name_arg; |
2960 | GString *params_arg; | |
05e21286 | 2961 | struct bt_value *extra_params; |
9009cc24 PP |
2962 | }; |
2963 | ||
2964 | static | |
2965 | int assign_name_to_implicit_component(struct implicit_component_args *args, | |
05e21286 | 2966 | const char *prefix, struct bt_value *existing_names, |
9009cc24 PP |
2967 | GList **comp_names, bool append_to_comp_names) |
2968 | { | |
2969 | int ret = 0; | |
2970 | GString *name = NULL; | |
2971 | ||
2972 | if (!args->exists) { | |
2973 | goto end; | |
2974 | } | |
2975 | ||
da91b29a | 2976 | name = get_component_auto_name(prefix, |
05e21286 | 2977 | existing_names); |
9009cc24 PP |
2978 | |
2979 | if (!name) { | |
2980 | ret = -1; | |
2981 | goto end; | |
2982 | } | |
2983 | ||
2984 | g_string_assign(args->name_arg, name->str); | |
2985 | ||
05e21286 | 2986 | if (bt_value_map_insert_entry(existing_names, name->str, |
9009cc24 PP |
2987 | bt_value_null)) { |
2988 | print_err_oom(); | |
2989 | ret = -1; | |
2990 | goto end; | |
2991 | } | |
2992 | ||
2993 | if (append_to_comp_names) { | |
2994 | *comp_names = g_list_append(*comp_names, name); | |
2995 | name = NULL; | |
2996 | } | |
2997 | ||
2998 | end: | |
2999 | if (name) { | |
3000 | g_string_free(name, TRUE); | |
3001 | } | |
3002 | ||
3003 | return ret; | |
3004 | } | |
3005 | ||
3006 | static | |
3007 | int append_run_args_for_implicit_component( | |
9009cc24 | 3008 | struct implicit_component_args *impl_args, |
05e21286 | 3009 | struct bt_value *run_args) |
9009cc24 PP |
3010 | { |
3011 | int ret = 0; | |
3012 | size_t i; | |
3013 | ||
3014 | if (!impl_args->exists) { | |
3015 | goto end; | |
3016 | } | |
3017 | ||
05e21286 | 3018 | if (bt_value_array_append_string_element(run_args, "--component")) { |
fd5f8053 PP |
3019 | print_err_oom(); |
3020 | goto error; | |
9009cc24 PP |
3021 | } |
3022 | ||
05e21286 | 3023 | if (bt_value_array_append_string_element(run_args, impl_args->comp_arg->str)) { |
9009cc24 PP |
3024 | print_err_oom(); |
3025 | goto error; | |
3026 | } | |
3027 | ||
05e21286 | 3028 | if (bt_value_array_append_string_element(run_args, "--name")) { |
9009cc24 PP |
3029 | print_err_oom(); |
3030 | goto error; | |
3031 | } | |
3032 | ||
05e21286 | 3033 | if (bt_value_array_append_string_element(run_args, impl_args->name_arg->str)) { |
9009cc24 PP |
3034 | print_err_oom(); |
3035 | goto error; | |
3036 | } | |
3037 | ||
3038 | if (impl_args->params_arg->len > 0) { | |
05e21286 | 3039 | if (bt_value_array_append_string_element(run_args, "--params")) { |
9009cc24 PP |
3040 | print_err_oom(); |
3041 | goto error; | |
3042 | } | |
3043 | ||
05e21286 | 3044 | if (bt_value_array_append_string_element(run_args, |
9009cc24 PP |
3045 | impl_args->params_arg->str)) { |
3046 | print_err_oom(); | |
3047 | goto error; | |
3048 | } | |
3049 | } | |
3050 | ||
05e21286 | 3051 | for (i = 0; i < bt_value_array_get_size(impl_args->extra_params); |
da91b29a | 3052 | i++) { |
05e21286 | 3053 | const struct bt_value *elem; |
9009cc24 PP |
3054 | const char *arg; |
3055 | ||
05e21286 PP |
3056 | elem = bt_value_array_borrow_element_by_index(impl_args->extra_params, |
3057 | i); | |
9009cc24 PP |
3058 | if (!elem) { |
3059 | goto error; | |
3060 | } | |
3061 | ||
f6ccaed9 | 3062 | BT_ASSERT(bt_value_is_string(elem)); |
601b0d3c | 3063 | arg = bt_value_string_get(elem); |
05e21286 | 3064 | ret = bt_value_array_append_string_element(run_args, arg); |
9009cc24 PP |
3065 | if (ret) { |
3066 | print_err_oom(); | |
3067 | goto error; | |
3068 | } | |
3069 | } | |
3070 | ||
3071 | goto end; | |
3072 | ||
3073 | error: | |
3074 | ret = -1; | |
3075 | ||
3076 | end: | |
3077 | return ret; | |
3078 | } | |
3079 | ||
3080 | static | |
94023a1c | 3081 | void finalize_implicit_component_args(struct implicit_component_args *args) |
9009cc24 | 3082 | { |
f6ccaed9 | 3083 | BT_ASSERT(args); |
9009cc24 | 3084 | |
fd5f8053 PP |
3085 | if (args->comp_arg) { |
3086 | g_string_free(args->comp_arg, TRUE); | |
9009cc24 PP |
3087 | } |
3088 | ||
3089 | if (args->name_arg) { | |
3090 | g_string_free(args->name_arg, TRUE); | |
3091 | } | |
3092 | ||
3093 | if (args->params_arg) { | |
3094 | g_string_free(args->params_arg, TRUE); | |
3095 | } | |
3096 | ||
65300d60 | 3097 | bt_object_put_ref(args->extra_params); |
9009cc24 PP |
3098 | } |
3099 | ||
94023a1c PP |
3100 | static |
3101 | void destroy_implicit_component_args(void *args) | |
3102 | { | |
3103 | if (!args) { | |
3104 | return; | |
3105 | } | |
3106 | ||
3107 | finalize_implicit_component_args(args); | |
3108 | g_free(args); | |
3109 | } | |
3110 | ||
9009cc24 PP |
3111 | static |
3112 | int init_implicit_component_args(struct implicit_component_args *args, | |
fd5f8053 | 3113 | const char *comp_arg, bool exists) |
9009cc24 PP |
3114 | { |
3115 | int ret = 0; | |
3116 | ||
3117 | args->exists = exists; | |
fd5f8053 | 3118 | args->comp_arg = g_string_new(comp_arg); |
9009cc24 PP |
3119 | args->name_arg = g_string_new(NULL); |
3120 | args->params_arg = g_string_new(NULL); | |
05e21286 | 3121 | args->extra_params = bt_value_array_create(); |
9009cc24 | 3122 | |
fd5f8053 | 3123 | if (!args->comp_arg || !args->name_arg || |
e7ad156c | 3124 | !args->params_arg || !args->extra_params) { |
9009cc24 | 3125 | ret = -1; |
94023a1c | 3126 | finalize_implicit_component_args(args); |
9009cc24 PP |
3127 | print_err_oom(); |
3128 | goto end; | |
3129 | } | |
3130 | ||
3131 | end: | |
3132 | return ret; | |
3133 | } | |
3134 | ||
3135 | static | |
3136 | void append_implicit_component_param(struct implicit_component_args *args, | |
3137 | const char *key, const char *value) | |
3138 | { | |
f6ccaed9 PP |
3139 | BT_ASSERT(args); |
3140 | BT_ASSERT(key); | |
3141 | BT_ASSERT(value); | |
9009cc24 PP |
3142 | append_param_arg(args->params_arg, key, value); |
3143 | } | |
3144 | ||
3145 | static | |
e7ad156c | 3146 | int append_implicit_component_extra_param(struct implicit_component_args *args, |
9009cc24 PP |
3147 | const char *key, const char *value) |
3148 | { | |
3149 | int ret = 0; | |
3150 | ||
f6ccaed9 PP |
3151 | BT_ASSERT(args); |
3152 | BT_ASSERT(key); | |
3153 | BT_ASSERT(value); | |
9009cc24 | 3154 | |
05e21286 | 3155 | if (bt_value_array_append_string_element(args->extra_params, "--key")) { |
9009cc24 PP |
3156 | print_err_oom(); |
3157 | ret = -1; | |
3158 | goto end; | |
3159 | } | |
3160 | ||
05e21286 | 3161 | if (bt_value_array_append_string_element(args->extra_params, key)) { |
9009cc24 PP |
3162 | print_err_oom(); |
3163 | ret = -1; | |
3164 | goto end; | |
3165 | } | |
3166 | ||
05e21286 | 3167 | if (bt_value_array_append_string_element(args->extra_params, "--value")) { |
9009cc24 PP |
3168 | print_err_oom(); |
3169 | ret = -1; | |
3170 | goto end; | |
3171 | } | |
3172 | ||
05e21286 | 3173 | if (bt_value_array_append_string_element(args->extra_params, value)) { |
9009cc24 PP |
3174 | print_err_oom(); |
3175 | ret = -1; | |
3176 | goto end; | |
3177 | } | |
3178 | ||
3179 | end: | |
3180 | return ret; | |
3181 | } | |
3182 | ||
3183 | static | |
3184 | int convert_append_name_param(enum bt_config_component_dest dest, | |
3185 | GString *cur_name, GString *cur_name_prefix, | |
05e21286 PP |
3186 | struct bt_value *run_args, |
3187 | struct bt_value *all_names, | |
9009cc24 PP |
3188 | GList **source_names, GList **filter_names, |
3189 | GList **sink_names) | |
3190 | { | |
3191 | int ret = 0; | |
3192 | ||
3193 | if (cur_name_prefix->len > 0) { | |
fd5f8053 | 3194 | /* We're after a --component option */ |
9009cc24 PP |
3195 | GString *name = NULL; |
3196 | bool append_name_opt = false; | |
3197 | ||
3198 | if (cur_name->len == 0) { | |
3199 | /* | |
3200 | * No explicit name was provided for the user | |
3201 | * component. | |
3202 | */ | |
fd5f8053 | 3203 | name = get_component_auto_name(cur_name_prefix->str, |
05e21286 | 3204 | all_names); |
9009cc24 PP |
3205 | append_name_opt = true; |
3206 | } else { | |
3207 | /* | |
3208 | * An explicit name was provided for the user | |
3209 | * component. | |
3210 | */ | |
05e21286 PP |
3211 | if (bt_value_map_has_entry(all_names, |
3212 | cur_name->str)) { | |
9009cc24 PP |
3213 | printf_err("Duplicate component instance name:\n %s\n", |
3214 | cur_name->str); | |
3215 | goto error; | |
3216 | } | |
3217 | ||
3218 | name = g_string_new(cur_name->str); | |
3219 | } | |
3220 | ||
3221 | if (!name) { | |
3222 | print_err_oom(); | |
3223 | goto error; | |
3224 | } | |
3225 | ||
3226 | /* | |
3227 | * Remember this name globally, for the uniqueness of | |
3228 | * all component names. | |
3229 | */ | |
05e21286 | 3230 | if (bt_value_map_insert_entry(all_names, name->str, bt_value_null)) { |
9009cc24 PP |
3231 | print_err_oom(); |
3232 | goto error; | |
3233 | } | |
3234 | ||
3235 | /* | |
3236 | * Append the --name option if necessary. | |
3237 | */ | |
3238 | if (append_name_opt) { | |
05e21286 | 3239 | if (bt_value_array_append_string_element(run_args, "--name")) { |
9009cc24 PP |
3240 | print_err_oom(); |
3241 | goto error; | |
3242 | } | |
3243 | ||
05e21286 | 3244 | if (bt_value_array_append_string_element(run_args, name->str)) { |
9009cc24 PP |
3245 | print_err_oom(); |
3246 | goto error; | |
3247 | } | |
3248 | } | |
3249 | ||
3250 | /* | |
3251 | * Remember this name specifically for the type of the | |
3252 | * component. This is to create connection arguments. | |
3253 | */ | |
3254 | switch (dest) { | |
3255 | case BT_CONFIG_COMPONENT_DEST_SOURCE: | |
3256 | *source_names = g_list_append(*source_names, name); | |
3257 | break; | |
3258 | case BT_CONFIG_COMPONENT_DEST_FILTER: | |
3259 | *filter_names = g_list_append(*filter_names, name); | |
3260 | break; | |
3261 | case BT_CONFIG_COMPONENT_DEST_SINK: | |
3262 | *sink_names = g_list_append(*sink_names, name); | |
3263 | break; | |
3264 | default: | |
0fbb9a9f | 3265 | abort(); |
9009cc24 PP |
3266 | } |
3267 | ||
3268 | g_string_assign(cur_name_prefix, ""); | |
3269 | } | |
3270 | ||
3271 | goto end; | |
3272 | ||
3273 | error: | |
3274 | ret = -1; | |
3275 | ||
3276 | end: | |
3277 | return ret; | |
3278 | } | |
3279 | ||
3280 | /* | |
3281 | * Escapes `.`, `:`, and `\` of `input` with `\`. | |
3282 | */ | |
3283 | static | |
3284 | GString *escape_dot_colon(const char *input) | |
3285 | { | |
3286 | GString *output = g_string_new(NULL); | |
3287 | const char *ch; | |
3288 | ||
3289 | if (!output) { | |
3290 | print_err_oom(); | |
3291 | goto end; | |
3292 | } | |
3293 | ||
3294 | for (ch = input; *ch != '\0'; ch++) { | |
3295 | if (*ch == '\\' || *ch == '.' || *ch == ':') { | |
3296 | g_string_append_c(output, '\\'); | |
3297 | } | |
3298 | ||
3299 | g_string_append_c(output, *ch); | |
3300 | } | |
3301 | ||
3302 | end: | |
3303 | return output; | |
3304 | } | |
3305 | ||
3306 | /* | |
3307 | * Appends a --connect option to a list of arguments. `upstream_name` | |
3308 | * and `downstream_name` are escaped with escape_dot_colon() in this | |
3309 | * function. | |
3310 | */ | |
3311 | static | |
05e21286 | 3312 | int append_connect_arg(struct bt_value *run_args, |
9009cc24 PP |
3313 | const char *upstream_name, const char *downstream_name) |
3314 | { | |
3315 | int ret = 0; | |
3316 | GString *e_upstream_name = escape_dot_colon(upstream_name); | |
3317 | GString *e_downstream_name = escape_dot_colon(downstream_name); | |
3318 | GString *arg = g_string_new(NULL); | |
3319 | ||
3320 | if (!e_upstream_name || !e_downstream_name || !arg) { | |
3321 | print_err_oom(); | |
3322 | ret = -1; | |
3323 | goto end; | |
3324 | } | |
3325 | ||
05e21286 | 3326 | ret = bt_value_array_append_string_element(run_args, "--connect"); |
9009cc24 PP |
3327 | if (ret) { |
3328 | print_err_oom(); | |
3329 | ret = -1; | |
3330 | goto end; | |
3331 | } | |
3332 | ||
3333 | g_string_append(arg, e_upstream_name->str); | |
3334 | g_string_append_c(arg, ':'); | |
3335 | g_string_append(arg, e_downstream_name->str); | |
05e21286 | 3336 | ret = bt_value_array_append_string_element(run_args, arg->str); |
9009cc24 PP |
3337 | if (ret) { |
3338 | print_err_oom(); | |
3339 | ret = -1; | |
3340 | goto end; | |
3341 | } | |
3342 | ||
3343 | end: | |
3344 | if (arg) { | |
3345 | g_string_free(arg, TRUE); | |
3346 | } | |
3347 | ||
3348 | if (e_upstream_name) { | |
3349 | g_string_free(e_upstream_name, TRUE); | |
3350 | } | |
3351 | ||
3352 | if (e_downstream_name) { | |
3353 | g_string_free(e_downstream_name, TRUE); | |
3354 | } | |
3355 | ||
3356 | return ret; | |
3357 | } | |
3358 | ||
3359 | /* | |
3360 | * Appends the run command's --connect options for the convert command. | |
3361 | */ | |
3362 | static | |
05e21286 | 3363 | int convert_auto_connect(struct bt_value *run_args, |
9009cc24 PP |
3364 | GList *source_names, GList *filter_names, |
3365 | GList *sink_names) | |
3366 | { | |
3367 | int ret = 0; | |
3368 | GList *source_at = source_names; | |
3369 | GList *filter_at = filter_names; | |
3370 | GList *filter_prev; | |
3371 | GList *sink_at = sink_names; | |
3372 | ||
f6ccaed9 PP |
3373 | BT_ASSERT(source_names); |
3374 | BT_ASSERT(filter_names); | |
3375 | BT_ASSERT(sink_names); | |
9009cc24 PP |
3376 | |
3377 | /* Connect all sources to the first filter */ | |
3378 | for (source_at = source_names; source_at != NULL; source_at = g_list_next(source_at)) { | |
3379 | GString *source_name = source_at->data; | |
3380 | GString *filter_name = filter_at->data; | |
3381 | ||
3382 | ret = append_connect_arg(run_args, source_name->str, | |
3383 | filter_name->str); | |
3384 | if (ret) { | |
3385 | goto error; | |
3386 | } | |
3387 | } | |
3388 | ||
3389 | filter_prev = filter_at; | |
3390 | filter_at = g_list_next(filter_at); | |
3391 | ||
3392 | /* Connect remaining filters */ | |
3393 | for (; filter_at != NULL; filter_prev = filter_at, filter_at = g_list_next(filter_at)) { | |
3394 | GString *filter_name = filter_at->data; | |
3395 | GString *filter_prev_name = filter_prev->data; | |
3396 | ||
3397 | ret = append_connect_arg(run_args, filter_prev_name->str, | |
3398 | filter_name->str); | |
3399 | if (ret) { | |
3400 | goto error; | |
3401 | } | |
3402 | } | |
3403 | ||
3404 | /* Connect last filter to all sinks */ | |
3405 | for (sink_at = sink_names; sink_at != NULL; sink_at = g_list_next(sink_at)) { | |
3406 | GString *filter_name = filter_prev->data; | |
3407 | GString *sink_name = sink_at->data; | |
3408 | ||
3409 | ret = append_connect_arg(run_args, filter_name->str, | |
3410 | sink_name->str); | |
3411 | if (ret) { | |
3412 | goto error; | |
3413 | } | |
3414 | } | |
3415 | ||
3416 | goto end; | |
3417 | ||
3418 | error: | |
3419 | ret = -1; | |
3420 | ||
3421 | end: | |
3422 | return ret; | |
3423 | } | |
3424 | ||
3425 | static | |
3426 | int split_timerange(const char *arg, char **begin, char **end) | |
3427 | { | |
3428 | int ret = 0; | |
3429 | const char *ch = arg; | |
3430 | size_t end_pos; | |
3431 | GString *g_begin = NULL; | |
3432 | GString *g_end = NULL; | |
3433 | ||
f6ccaed9 | 3434 | BT_ASSERT(arg); |
9009cc24 PP |
3435 | |
3436 | if (*ch == '[') { | |
3437 | ch++; | |
3438 | } | |
3439 | ||
3440 | g_begin = bt_common_string_until(ch, "", ",", &end_pos); | |
3441 | if (!g_begin || ch[end_pos] != ',' || g_begin->len == 0) { | |
3442 | goto error; | |
3443 | } | |
3444 | ||
3445 | ch += end_pos + 1; | |
3446 | ||
3447 | g_end = bt_common_string_until(ch, "", "]", &end_pos); | |
3448 | if (!g_end || g_end->len == 0) { | |
3449 | goto error; | |
3450 | } | |
3451 | ||
f6ccaed9 PP |
3452 | BT_ASSERT(begin); |
3453 | BT_ASSERT(end); | |
9009cc24 PP |
3454 | *begin = g_begin->str; |
3455 | *end = g_end->str; | |
3456 | g_string_free(g_begin, FALSE); | |
3457 | g_string_free(g_end, FALSE); | |
3458 | g_begin = NULL; | |
3459 | g_end = NULL; | |
3460 | goto end; | |
3461 | ||
3462 | error: | |
3463 | ret = -1; | |
3464 | ||
3465 | end: | |
3466 | if (g_begin) { | |
3467 | g_string_free(g_begin, TRUE); | |
3468 | } | |
3469 | ||
3470 | if (g_end) { | |
3471 | g_string_free(g_end, TRUE); | |
3472 | } | |
3473 | ||
3474 | return ret; | |
3475 | } | |
3476 | ||
3477 | static | |
3478 | int g_list_prepend_gstring(GList **list, const char *string) | |
3479 | { | |
3480 | int ret = 0; | |
3481 | GString *gs = g_string_new(string); | |
3482 | ||
f6ccaed9 | 3483 | BT_ASSERT(list); |
9009cc24 PP |
3484 | |
3485 | if (!gs) { | |
3486 | print_err_oom(); | |
3487 | goto end; | |
3488 | } | |
3489 | ||
3490 | *list = g_list_prepend(*list, gs); | |
3491 | ||
3492 | end: | |
3493 | return ret; | |
3494 | } | |
3495 | ||
94023a1c PP |
3496 | static |
3497 | struct implicit_component_args *create_implicit_component_args(void) | |
3498 | { | |
3499 | struct implicit_component_args *impl_args = | |
3500 | g_new0(struct implicit_component_args, 1); | |
3501 | ||
3502 | if (!impl_args) { | |
3503 | goto end; | |
3504 | } | |
3505 | ||
3506 | if (init_implicit_component_args(impl_args, NULL, true)) { | |
3507 | destroy_implicit_component_args(impl_args); | |
3508 | impl_args = NULL; | |
3509 | goto end; | |
3510 | } | |
3511 | ||
3512 | end: | |
3513 | return impl_args; | |
3514 | } | |
3515 | ||
3516 | static | |
3517 | int fill_implicit_ctf_inputs_args(GPtrArray *implicit_ctf_inputs_args, | |
3518 | struct implicit_component_args *base_implicit_ctf_input_args, | |
3519 | GList *leftovers) | |
3520 | { | |
3521 | int ret = 0; | |
3522 | GList *leftover; | |
601b0d3c | 3523 | enum bt_value_status status; |
94023a1c PP |
3524 | |
3525 | for (leftover = leftovers; leftover != NULL; | |
3526 | leftover = g_list_next(leftover)) { | |
3527 | GString *gs_leftover = leftover->data; | |
3528 | struct implicit_component_args *impl_args = | |
3529 | create_implicit_component_args(); | |
3530 | ||
3531 | if (!impl_args) { | |
3532 | print_err_oom(); | |
3533 | goto error; | |
3534 | } | |
3535 | ||
3536 | impl_args->exists = true; | |
3537 | g_string_assign(impl_args->comp_arg, | |
3538 | base_implicit_ctf_input_args->comp_arg->str); | |
3539 | g_string_assign(impl_args->params_arg, | |
3540 | base_implicit_ctf_input_args->params_arg->str); | |
3541 | ||
3542 | /* | |
3543 | * We need our own copy of the extra parameters because | |
3544 | * this is where the unique path goes. | |
3545 | */ | |
65300d60 | 3546 | BT_OBJECT_PUT_REF_AND_RESET(impl_args->extra_params); |
601b0d3c | 3547 | status = bt_value_copy(&impl_args->extra_params, |
05e21286 | 3548 | base_implicit_ctf_input_args->extra_params); |
601b0d3c | 3549 | if (status != BT_VALUE_STATUS_OK) { |
94023a1c PP |
3550 | print_err_oom(); |
3551 | destroy_implicit_component_args(impl_args); | |
3552 | goto error; | |
3553 | } | |
3554 | ||
3555 | /* Append unique path parameter */ | |
3556 | ret = append_implicit_component_extra_param(impl_args, | |
3557 | "path", gs_leftover->str); | |
3558 | if (ret) { | |
3559 | destroy_implicit_component_args(impl_args); | |
3560 | goto error; | |
3561 | } | |
3562 | ||
3563 | g_ptr_array_add(implicit_ctf_inputs_args, impl_args); | |
3564 | } | |
3565 | ||
3566 | goto end; | |
3567 | ||
3568 | error: | |
3569 | ret = -1; | |
3570 | ||
3571 | end: | |
3572 | return ret; | |
3573 | } | |
3574 | ||
9009cc24 PP |
3575 | /* |
3576 | * Creates a Babeltrace config object from the arguments of a convert | |
3577 | * command. | |
3578 | * | |
3579 | * *retcode is set to the appropriate exit code to use. | |
3580 | */ | |
3581 | static | |
3582 | struct bt_config *bt_config_convert_from_args(int argc, const char *argv[], | |
3583 | int *retcode, bool force_omit_system_plugin_path, | |
9a16feea | 3584 | bool force_omit_home_plugin_path, |
05e21286 | 3585 | const struct bt_value *initial_plugin_paths, char *log_level) |
9009cc24 PP |
3586 | { |
3587 | poptContext pc = NULL; | |
3588 | char *arg = NULL; | |
0a011c88 JG |
3589 | enum bt_config_component_dest cur_comp_dest = |
3590 | BT_CONFIG_COMPONENT_DEST_UNKNOWN; | |
9009cc24 PP |
3591 | int opt, ret = 0; |
3592 | struct bt_config *cfg = NULL; | |
9009cc24 PP |
3593 | bool got_input_format_opt = false; |
3594 | bool got_output_format_opt = false; | |
3595 | bool trimmer_has_begin = false; | |
3596 | bool trimmer_has_end = false; | |
75a2cb9b | 3597 | bool stream_intersection_mode = false; |
9009cc24 PP |
3598 | GString *cur_name = NULL; |
3599 | GString *cur_name_prefix = NULL; | |
3600 | const char *leftover = NULL; | |
3601 | bool print_run_args = false; | |
3602 | bool print_run_args_0 = false; | |
3603 | bool print_ctf_metadata = false; | |
05e21286 PP |
3604 | struct bt_value *run_args = NULL; |
3605 | struct bt_value *all_names = NULL; | |
9009cc24 PP |
3606 | GList *source_names = NULL; |
3607 | GList *filter_names = NULL; | |
3608 | GList *sink_names = NULL; | |
94023a1c PP |
3609 | GList *leftovers = NULL; |
3610 | GPtrArray *implicit_ctf_inputs_args = NULL; | |
3611 | struct implicit_component_args base_implicit_ctf_input_args = { 0 }; | |
e7ad156c | 3612 | struct implicit_component_args implicit_ctf_output_args = { 0 }; |
9009cc24 PP |
3613 | struct implicit_component_args implicit_lttng_live_args = { 0 }; |
3614 | struct implicit_component_args implicit_dummy_args = { 0 }; | |
3615 | struct implicit_component_args implicit_text_args = { 0 }; | |
3616 | struct implicit_component_args implicit_debug_info_args = { 0 }; | |
3617 | struct implicit_component_args implicit_muxer_args = { 0 }; | |
3618 | struct implicit_component_args implicit_trimmer_args = { 0 }; | |
05e21286 | 3619 | struct bt_value *plugin_paths; |
9009cc24 PP |
3620 | char error_buf[256] = { 0 }; |
3621 | size_t i; | |
3622 | struct bt_common_lttng_live_url_parts lttng_live_url_parts = { 0 }; | |
e7ad156c | 3623 | char *output = NULL; |
9009cc24 | 3624 | |
05e21286 | 3625 | (void) bt_value_copy(&plugin_paths, initial_plugin_paths); |
398454ed | 3626 | |
9009cc24 PP |
3627 | *retcode = 0; |
3628 | ||
3629 | if (argc <= 1) { | |
3630 | print_convert_usage(stdout); | |
3631 | *retcode = -1; | |
3632 | goto end; | |
3633 | } | |
3634 | ||
94023a1c | 3635 | if (init_implicit_component_args(&base_implicit_ctf_input_args, |
fd5f8053 | 3636 | "source.ctf.fs", false)) { |
9009cc24 PP |
3637 | goto error; |
3638 | } | |
3639 | ||
e7ad156c PP |
3640 | if (init_implicit_component_args(&implicit_ctf_output_args, |
3641 | "sink.ctf.fs", false)) { | |
3642 | goto error; | |
3643 | } | |
3644 | ||
9009cc24 | 3645 | if (init_implicit_component_args(&implicit_lttng_live_args, |
fd5f8053 | 3646 | "source.ctf.lttng-live", false)) { |
9009cc24 PP |
3647 | goto error; |
3648 | } | |
3649 | ||
fd5f8053 PP |
3650 | if (init_implicit_component_args(&implicit_text_args, |
3651 | "sink.text.pretty", false)) { | |
9009cc24 PP |
3652 | goto error; |
3653 | } | |
3654 | ||
fd5f8053 PP |
3655 | if (init_implicit_component_args(&implicit_dummy_args, |
3656 | "sink.utils.dummy", false)) { | |
9009cc24 PP |
3657 | goto error; |
3658 | } | |
3659 | ||
3660 | if (init_implicit_component_args(&implicit_debug_info_args, | |
9a16feea | 3661 | "filter.lttng-utils.debug-info", false)) { |
9009cc24 PP |
3662 | goto error; |
3663 | } | |
3664 | ||
fd5f8053 PP |
3665 | if (init_implicit_component_args(&implicit_muxer_args, |
3666 | "filter.utils.muxer", true)) { | |
9009cc24 PP |
3667 | goto error; |
3668 | } | |
3669 | ||
3670 | if (init_implicit_component_args(&implicit_trimmer_args, | |
fd5f8053 | 3671 | "filter.utils.trimmer", false)) { |
9009cc24 PP |
3672 | goto error; |
3673 | } | |
3674 | ||
94023a1c PP |
3675 | implicit_ctf_inputs_args = g_ptr_array_new_with_free_func( |
3676 | (GDestroyNotify) destroy_implicit_component_args); | |
3677 | if (!implicit_ctf_inputs_args) { | |
3678 | print_err_oom(); | |
3679 | goto error; | |
3680 | } | |
3681 | ||
05e21286 | 3682 | all_names = bt_value_map_create(); |
9009cc24 PP |
3683 | if (!all_names) { |
3684 | print_err_oom(); | |
3685 | goto error; | |
3686 | } | |
3687 | ||
05e21286 | 3688 | run_args = bt_value_array_create(); |
9009cc24 PP |
3689 | if (!run_args) { |
3690 | print_err_oom(); | |
3691 | goto error; | |
3692 | } | |
3693 | ||
3694 | cur_name = g_string_new(NULL); | |
3695 | if (!cur_name) { | |
3696 | print_err_oom(); | |
3697 | goto error; | |
3698 | } | |
3699 | ||
3700 | cur_name_prefix = g_string_new(NULL); | |
3701 | if (!cur_name_prefix) { | |
3702 | print_err_oom(); | |
3703 | goto error; | |
3704 | } | |
3705 | ||
3706 | ret = append_env_var_plugin_paths(plugin_paths); | |
3707 | if (ret) { | |
3708 | goto error; | |
3709 | } | |
3710 | ||
3711 | /* | |
3712 | * First pass: collect all arguments which need to be passed | |
3713 | * as is to the run command. This pass can also add --name | |
3714 | * arguments if needed to automatically name unnamed component | |
3715 | * instances. Also it does the following transformations: | |
3716 | * | |
3717 | * --path=PATH -> --key path --value PATH | |
3718 | * --url=URL -> --key url --value URL | |
3719 | * | |
3720 | * Also it appends the plugin paths of --plugin-path to | |
3721 | * `plugin_paths`. | |
3722 | */ | |
3723 | pc = poptGetContext(NULL, argc, (const char **) argv, | |
3724 | convert_long_options, 0); | |
3725 | if (!pc) { | |
3726 | printf_err("Cannot get popt context\n"); | |
3727 | goto error; | |
3728 | } | |
3729 | ||
3730 | poptReadDefaultConfig(pc, 0); | |
3731 | ||
3732 | while ((opt = poptGetNextOpt(pc)) > 0) { | |
3733 | char *name = NULL; | |
3734 | char *plugin_name = NULL; | |
3735 | char *comp_cls_name = NULL; | |
3736 | ||
3737 | arg = poptGetOptArg(pc); | |
3738 | ||
3739 | switch (opt) { | |
fd5f8053 PP |
3740 | case OPT_COMPONENT: |
3741 | { | |
3742 | enum bt_component_class_type type; | |
3743 | const char *type_prefix; | |
3744 | ||
9009cc24 PP |
3745 | /* Append current component's name if needed */ |
3746 | ret = convert_append_name_param(cur_comp_dest, cur_name, | |
3747 | cur_name_prefix, run_args, all_names, | |
3748 | &source_names, &filter_names, &sink_names); | |
3749 | if (ret) { | |
3750 | goto error; | |
3751 | } | |
3752 | ||
3753 | /* Parse the argument */ | |
3754 | plugin_comp_cls_names(arg, &name, &plugin_name, | |
fd5f8053 | 3755 | &comp_cls_name, &type); |
9009cc24 | 3756 | if (!plugin_name || !comp_cls_name) { |
fd5f8053 | 3757 | printf_err("Invalid format for --component option's argument:\n %s\n", |
9009cc24 PP |
3758 | arg); |
3759 | goto error; | |
3760 | } | |
3761 | ||
3762 | if (name) { | |
3763 | g_string_assign(cur_name, name); | |
3764 | } else { | |
3765 | g_string_assign(cur_name, ""); | |
3766 | } | |
3767 | ||
fd5f8053 PP |
3768 | switch (type) { |
3769 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
3770 | cur_comp_dest = BT_CONFIG_COMPONENT_DEST_SOURCE; | |
3771 | type_prefix = "source"; | |
9009cc24 | 3772 | break; |
fd5f8053 PP |
3773 | case BT_COMPONENT_CLASS_TYPE_FILTER: |
3774 | cur_comp_dest = BT_CONFIG_COMPONENT_DEST_FILTER; | |
3775 | type_prefix = "filter"; | |
9009cc24 | 3776 | break; |
fd5f8053 PP |
3777 | case BT_COMPONENT_CLASS_TYPE_SINK: |
3778 | cur_comp_dest = BT_CONFIG_COMPONENT_DEST_SINK; | |
3779 | type_prefix = "sink"; | |
9009cc24 PP |
3780 | break; |
3781 | default: | |
0fbb9a9f | 3782 | abort(); |
9009cc24 PP |
3783 | } |
3784 | ||
05e21286 | 3785 | if (bt_value_array_append_string_element(run_args, |
fd5f8053 PP |
3786 | "--component")) { |
3787 | print_err_oom(); | |
3788 | goto error; | |
3789 | } | |
3790 | ||
05e21286 | 3791 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3792 | print_err_oom(); |
3793 | goto error; | |
3794 | } | |
3795 | ||
3796 | g_string_assign(cur_name_prefix, ""); | |
fd5f8053 PP |
3797 | g_string_append_printf(cur_name_prefix, "%s.%s.%s", |
3798 | type_prefix, plugin_name, comp_cls_name); | |
9009cc24 PP |
3799 | free(name); |
3800 | free(plugin_name); | |
3801 | free(comp_cls_name); | |
3802 | name = NULL; | |
3803 | plugin_name = NULL; | |
3804 | comp_cls_name = NULL; | |
3805 | break; | |
fd5f8053 | 3806 | } |
9009cc24 PP |
3807 | case OPT_PARAMS: |
3808 | if (cur_name_prefix->len == 0) { | |
3809 | printf_err("No current component of which to set parameters:\n %s\n", | |
3810 | arg); | |
3811 | goto error; | |
3812 | } | |
3813 | ||
05e21286 | 3814 | if (bt_value_array_append_string_element(run_args, |
9009cc24 PP |
3815 | "--params")) { |
3816 | print_err_oom(); | |
3817 | goto error; | |
3818 | } | |
3819 | ||
05e21286 | 3820 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3821 | print_err_oom(); |
3822 | goto error; | |
3823 | } | |
3824 | break; | |
3825 | case OPT_PATH: | |
3826 | if (cur_name_prefix->len == 0) { | |
3827 | printf_err("No current component of which to set `path` parameter:\n %s\n", | |
3828 | arg); | |
3829 | goto error; | |
3830 | } | |
3831 | ||
05e21286 | 3832 | if (bt_value_array_append_string_element(run_args, "--key")) { |
9009cc24 PP |
3833 | print_err_oom(); |
3834 | goto error; | |
3835 | } | |
3836 | ||
05e21286 | 3837 | if (bt_value_array_append_string_element(run_args, "path")) { |
9009cc24 PP |
3838 | print_err_oom(); |
3839 | goto error; | |
3840 | } | |
3841 | ||
05e21286 | 3842 | if (bt_value_array_append_string_element(run_args, "--value")) { |
9009cc24 PP |
3843 | print_err_oom(); |
3844 | goto error; | |
3845 | } | |
3846 | ||
05e21286 | 3847 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3848 | print_err_oom(); |
3849 | goto error; | |
3850 | } | |
3851 | break; | |
3852 | case OPT_URL: | |
3853 | if (cur_name_prefix->len == 0) { | |
3854 | printf_err("No current component of which to set `url` parameter:\n %s\n", | |
3855 | arg); | |
3856 | goto error; | |
3857 | } | |
3858 | ||
05e21286 | 3859 | if (bt_value_array_append_string_element(run_args, "--key")) { |
9009cc24 PP |
3860 | print_err_oom(); |
3861 | goto error; | |
3862 | } | |
3863 | ||
05e21286 | 3864 | if (bt_value_array_append_string_element(run_args, "url")) { |
9009cc24 PP |
3865 | print_err_oom(); |
3866 | goto error; | |
3867 | } | |
3868 | ||
05e21286 | 3869 | if (bt_value_array_append_string_element(run_args, "--value")) { |
9009cc24 PP |
3870 | print_err_oom(); |
3871 | goto error; | |
3872 | } | |
3873 | ||
05e21286 | 3874 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3875 | print_err_oom(); |
3876 | goto error; | |
3877 | } | |
3878 | break; | |
3879 | case OPT_NAME: | |
3880 | if (cur_name_prefix->len == 0) { | |
3881 | printf_err("No current component to name:\n %s\n", | |
3882 | arg); | |
3883 | goto error; | |
3884 | } | |
3885 | ||
05e21286 | 3886 | if (bt_value_array_append_string_element(run_args, "--name")) { |
9009cc24 PP |
3887 | print_err_oom(); |
3888 | goto error; | |
3889 | } | |
3890 | ||
05e21286 | 3891 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3892 | print_err_oom(); |
3893 | goto error; | |
3894 | } | |
3895 | ||
3896 | g_string_assign(cur_name, arg); | |
3897 | break; | |
3898 | case OPT_OMIT_HOME_PLUGIN_PATH: | |
3899 | force_omit_home_plugin_path = true; | |
3900 | ||
05e21286 | 3901 | if (bt_value_array_append_string_element(run_args, |
9009cc24 PP |
3902 | "--omit-home-plugin-path")) { |
3903 | print_err_oom(); | |
3904 | goto error; | |
3905 | } | |
3906 | break; | |
3907 | case OPT_RETRY_DURATION: | |
05e21286 | 3908 | if (bt_value_array_append_string_element(run_args, |
9009cc24 PP |
3909 | "--retry-duration")) { |
3910 | print_err_oom(); | |
3911 | goto error; | |
3912 | } | |
3913 | ||
05e21286 | 3914 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3915 | print_err_oom(); |
3916 | goto error; | |
3917 | } | |
3918 | break; | |
3919 | case OPT_OMIT_SYSTEM_PLUGIN_PATH: | |
3920 | force_omit_system_plugin_path = true; | |
3921 | ||
05e21286 | 3922 | if (bt_value_array_append_string_element(run_args, |
9009cc24 PP |
3923 | "--omit-system-plugin-path")) { |
3924 | print_err_oom(); | |
3925 | goto error; | |
3926 | } | |
3927 | break; | |
3928 | case OPT_PLUGIN_PATH: | |
3929 | if (bt_config_append_plugin_paths_check_setuid_setgid( | |
3930 | plugin_paths, arg)) { | |
3931 | goto error; | |
3932 | } | |
3933 | ||
05e21286 | 3934 | if (bt_value_array_append_string_element(run_args, |
9009cc24 PP |
3935 | "--plugin-path")) { |
3936 | print_err_oom(); | |
3937 | goto error; | |
3938 | } | |
3939 | ||
05e21286 | 3940 | if (bt_value_array_append_string_element(run_args, arg)) { |
9009cc24 PP |
3941 | print_err_oom(); |
3942 | goto error; | |
3943 | } | |
3944 | break; | |
3945 | case OPT_HELP: | |
3946 | print_convert_usage(stdout); | |
3947 | *retcode = -1; | |
65300d60 | 3948 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
3949 | goto end; |
3950 | case OPT_BEGIN: | |
3951 | case OPT_CLOCK_CYCLES: | |
3952 | case OPT_CLOCK_DATE: | |
3953 | case OPT_CLOCK_FORCE_CORRELATE: | |
3954 | case OPT_CLOCK_GMT: | |
3955 | case OPT_CLOCK_OFFSET: | |
3956 | case OPT_CLOCK_OFFSET_NS: | |
3957 | case OPT_CLOCK_SECONDS: | |
3958 | case OPT_COLOR: | |
3959 | case OPT_DEBUG: | |
9a16feea | 3960 | case OPT_DEBUG_INFO: |
9009cc24 PP |
3961 | case OPT_DEBUG_INFO_DIR: |
3962 | case OPT_DEBUG_INFO_FULL_PATH: | |
3963 | case OPT_DEBUG_INFO_TARGET_PREFIX: | |
3964 | case OPT_END: | |
3965 | case OPT_FIELDS: | |
3966 | case OPT_INPUT_FORMAT: | |
3967 | case OPT_NAMES: | |
9009cc24 PP |
3968 | case OPT_NO_DELTA: |
3969 | case OPT_OUTPUT_FORMAT: | |
3970 | case OPT_OUTPUT: | |
3971 | case OPT_RUN_ARGS: | |
3972 | case OPT_RUN_ARGS_0: | |
3973 | case OPT_STREAM_INTERSECTION: | |
3974 | case OPT_TIMERANGE: | |
3975 | case OPT_VERBOSE: | |
3976 | /* Ignore in this pass */ | |
3977 | break; | |
3978 | default: | |
3979 | printf_err("Unknown command-line option specified (option code %d)\n", | |
3980 | opt); | |
3981 | goto error; | |
3982 | } | |
3983 | ||
3984 | free(arg); | |
3985 | arg = NULL; | |
3986 | } | |
3987 | ||
3988 | /* Append current component's name if needed */ | |
3989 | ret = convert_append_name_param(cur_comp_dest, cur_name, | |
3990 | cur_name_prefix, run_args, all_names, &source_names, | |
3991 | &filter_names, &sink_names); | |
3992 | if (ret) { | |
3993 | goto error; | |
3994 | } | |
3995 | ||
3996 | /* Check for option parsing error */ | |
3997 | if (opt < -1) { | |
3998 | printf_err("While parsing command-line options, at option %s: %s\n", | |
3999 | poptBadOption(pc, 0), poptStrerror(opt)); | |
4000 | goto error; | |
4001 | } | |
4002 | ||
4003 | poptFreeContext(pc); | |
4004 | free(arg); | |
4005 | arg = NULL; | |
4006 | ||
4007 | /* | |
4008 | * Second pass: transform the convert-specific options and | |
4009 | * arguments into implicit component instances for the run | |
4010 | * command. | |
4011 | */ | |
4012 | pc = poptGetContext(NULL, argc, (const char **) argv, | |
4013 | convert_long_options, 0); | |
4014 | if (!pc) { | |
4015 | printf_err("Cannot get popt context\n"); | |
4016 | goto error; | |
4017 | } | |
4018 | ||
4019 | poptReadDefaultConfig(pc, 0); | |
4020 | ||
4021 | while ((opt = poptGetNextOpt(pc)) > 0) { | |
4022 | arg = poptGetOptArg(pc); | |
4023 | ||
4024 | switch (opt) { | |
4025 | case OPT_BEGIN: | |
4026 | if (trimmer_has_begin) { | |
4027 | printf("At --begin option: --begin or --timerange option already specified\n %s\n", | |
4028 | arg); | |
4029 | goto error; | |
4030 | } | |
4031 | ||
4032 | trimmer_has_begin = true; | |
e7ad156c | 4033 | ret = append_implicit_component_extra_param( |
9009cc24 PP |
4034 | &implicit_trimmer_args, "begin", arg); |
4035 | implicit_trimmer_args.exists = true; | |
4036 | if (ret) { | |
4037 | goto error; | |
4038 | } | |
4039 | break; | |
4040 | case OPT_END: | |
4041 | if (trimmer_has_end) { | |
4042 | printf("At --end option: --end or --timerange option already specified\n %s\n", | |
4043 | arg); | |
4044 | goto error; | |
4045 | } | |
4046 | ||
4047 | trimmer_has_end = true; | |
e7ad156c | 4048 | ret = append_implicit_component_extra_param( |
9009cc24 PP |
4049 | &implicit_trimmer_args, "end", arg); |
4050 | implicit_trimmer_args.exists = true; | |
4051 | if (ret) { | |
4052 | goto error; | |
4053 | } | |
4054 | break; | |
4055 | case OPT_TIMERANGE: | |
4056 | { | |
4057 | char *begin; | |
4058 | char *end; | |
4059 | ||
4060 | if (trimmer_has_begin || trimmer_has_end) { | |
4061 | printf("At --timerange option: --begin, --end, or --timerange option already specified\n %s\n", | |
4062 | arg); | |
4063 | goto error; | |
4064 | } | |
4065 | ||
4066 | ret = split_timerange(arg, &begin, &end); | |
4067 | if (ret) { | |
4068 | printf_err("Invalid --timerange option's argument: expecting BEGIN,END or [BEGIN,END]:\n %s\n", | |
4069 | arg); | |
4070 | goto error; | |
4071 | } | |
4072 | ||
e7ad156c | 4073 | ret = append_implicit_component_extra_param( |
9009cc24 | 4074 | &implicit_trimmer_args, "begin", begin); |
e7ad156c | 4075 | ret |= append_implicit_component_extra_param( |
9009cc24 PP |
4076 | &implicit_trimmer_args, "end", end); |
4077 | implicit_trimmer_args.exists = true; | |
4078 | free(begin); | |
4079 | free(end); | |
4080 | if (ret) { | |
4081 | goto error; | |
4082 | } | |
4083 | break; | |
4084 | } | |
4085 | case OPT_CLOCK_CYCLES: | |
4086 | append_implicit_component_param( | |
4087 | &implicit_text_args, "clock-cycles", "yes"); | |
4088 | implicit_text_args.exists = true; | |
4089 | break; | |
4090 | case OPT_CLOCK_DATE: | |
4091 | append_implicit_component_param( | |
4092 | &implicit_text_args, "clock-date", "yes"); | |
4093 | implicit_text_args.exists = true; | |
4094 | break; | |
4095 | case OPT_CLOCK_FORCE_CORRELATE: | |
4096 | append_implicit_component_param( | |
a2a54545 PP |
4097 | &implicit_muxer_args, |
4098 | "assume-absolute-clock-classes", "yes"); | |
9009cc24 PP |
4099 | break; |
4100 | case OPT_CLOCK_GMT: | |
4101 | append_implicit_component_param( | |
4102 | &implicit_text_args, "clock-gmt", "yes"); | |
eb01fbce JD |
4103 | append_implicit_component_param( |
4104 | &implicit_trimmer_args, "clock-gmt", "yes"); | |
9009cc24 PP |
4105 | implicit_text_args.exists = true; |
4106 | break; | |
4107 | case OPT_CLOCK_OFFSET: | |
94023a1c | 4108 | base_implicit_ctf_input_args.exists = true; |
a2a54545 | 4109 | append_implicit_component_param( |
291a6dc5 | 4110 | &base_implicit_ctf_input_args, |
a2a54545 | 4111 | "clock-class-offset-s", arg); |
9009cc24 PP |
4112 | break; |
4113 | case OPT_CLOCK_OFFSET_NS: | |
94023a1c | 4114 | base_implicit_ctf_input_args.exists = true; |
291a6dc5 PP |
4115 | append_implicit_component_param( |
4116 | &base_implicit_ctf_input_args, | |
4117 | "clock-class-offset-ns", arg); | |
9009cc24 PP |
4118 | break; |
4119 | case OPT_CLOCK_SECONDS: | |
4120 | append_implicit_component_param( | |
4121 | &implicit_text_args, "clock-seconds", "yes"); | |
4122 | implicit_text_args.exists = true; | |
4123 | break; | |
4124 | case OPT_COLOR: | |
9009cc24 | 4125 | implicit_text_args.exists = true; |
e7ad156c PP |
4126 | ret = append_implicit_component_extra_param( |
4127 | &implicit_text_args, "color", arg); | |
9009cc24 PP |
4128 | if (ret) { |
4129 | goto error; | |
4130 | } | |
4131 | break; | |
9a16feea PP |
4132 | case OPT_DEBUG_INFO: |
4133 | implicit_debug_info_args.exists = true; | |
9009cc24 PP |
4134 | break; |
4135 | case OPT_DEBUG_INFO_DIR: | |
e7ad156c PP |
4136 | implicit_debug_info_args.exists = true; |
4137 | ret = append_implicit_component_extra_param( | |
4cd687b9 | 4138 | &implicit_debug_info_args, "debug-info-dir", arg); |
9009cc24 PP |
4139 | if (ret) { |
4140 | goto error; | |
4141 | } | |
4142 | break; | |
4143 | case OPT_DEBUG_INFO_FULL_PATH: | |
e7ad156c | 4144 | implicit_debug_info_args.exists = true; |
9009cc24 PP |
4145 | append_implicit_component_param( |
4146 | &implicit_debug_info_args, "full-path", "yes"); | |
4147 | break; | |
4148 | case OPT_DEBUG_INFO_TARGET_PREFIX: | |
e7ad156c PP |
4149 | implicit_debug_info_args.exists = true; |
4150 | ret = append_implicit_component_extra_param( | |
9009cc24 PP |
4151 | &implicit_debug_info_args, |
4152 | "target-prefix", arg); | |
4153 | if (ret) { | |
4154 | goto error; | |
4155 | } | |
4156 | break; | |
4157 | case OPT_FIELDS: | |
4158 | { | |
05e21286 | 4159 | struct bt_value *fields = fields_from_arg(arg); |
9009cc24 PP |
4160 | |
4161 | if (!fields) { | |
4162 | goto error; | |
4163 | } | |
4164 | ||
e7ad156c | 4165 | implicit_text_args.exists = true; |
9009cc24 PP |
4166 | ret = insert_flat_params_from_array( |
4167 | implicit_text_args.params_arg, | |
05e21286 | 4168 | fields, "field"); |
65300d60 | 4169 | bt_object_put_ref(fields); |
9009cc24 PP |
4170 | if (ret) { |
4171 | goto error; | |
4172 | } | |
4173 | break; | |
4174 | } | |
4175 | case OPT_NAMES: | |
4176 | { | |
05e21286 | 4177 | struct bt_value *names = names_from_arg(arg); |
9009cc24 PP |
4178 | |
4179 | if (!names) { | |
4180 | goto error; | |
4181 | } | |
4182 | ||
e7ad156c | 4183 | implicit_text_args.exists = true; |
9009cc24 PP |
4184 | ret = insert_flat_params_from_array( |
4185 | implicit_text_args.params_arg, | |
05e21286 | 4186 | names, "name"); |
65300d60 | 4187 | bt_object_put_ref(names); |
9009cc24 PP |
4188 | if (ret) { |
4189 | goto error; | |
4190 | } | |
4191 | break; | |
4192 | } | |
4193 | case OPT_NO_DELTA: | |
4194 | append_implicit_component_param( | |
4195 | &implicit_text_args, "no-delta", "yes"); | |
4196 | implicit_text_args.exists = true; | |
4197 | break; | |
4198 | case OPT_INPUT_FORMAT: | |
4199 | if (got_input_format_opt) { | |
4200 | printf_err("Duplicate --input-format option\n"); | |
4201 | goto error; | |
4202 | } | |
4203 | ||
4204 | got_input_format_opt = true; | |
4205 | ||
4206 | if (strcmp(arg, "ctf") == 0) { | |
94023a1c | 4207 | base_implicit_ctf_input_args.exists = true; |
9009cc24 PP |
4208 | } else if (strcmp(arg, "lttng-live") == 0) { |
4209 | implicit_lttng_live_args.exists = true; | |
4210 | } else { | |
4211 | printf_err("Unknown legacy input format:\n %s\n", | |
4212 | arg); | |
4213 | goto error; | |
4214 | } | |
4215 | break; | |
4216 | case OPT_OUTPUT_FORMAT: | |
4217 | if (got_output_format_opt) { | |
4218 | printf_err("Duplicate --output-format option\n"); | |
4219 | goto error; | |
4220 | } | |
4221 | ||
4222 | got_output_format_opt = true; | |
4223 | ||
4224 | if (strcmp(arg, "text") == 0) { | |
4225 | implicit_text_args.exists = true; | |
e7ad156c PP |
4226 | } else if (strcmp(arg, "ctf") == 0) { |
4227 | implicit_ctf_output_args.exists = true; | |
9009cc24 PP |
4228 | } else if (strcmp(arg, "dummy") == 0) { |
4229 | implicit_dummy_args.exists = true; | |
4230 | } else if (strcmp(arg, "ctf-metadata") == 0) { | |
4231 | print_ctf_metadata = true; | |
4232 | } else { | |
4233 | printf_err("Unknown legacy output format:\n %s\n", | |
4234 | arg); | |
4235 | goto error; | |
4236 | } | |
4237 | break; | |
4238 | case OPT_OUTPUT: | |
e7ad156c PP |
4239 | if (output) { |
4240 | printf_err("Duplicate --output option\n"); | |
4241 | goto error; | |
4242 | } | |
4243 | ||
4244 | output = strdup(arg); | |
4245 | if (!output) { | |
4246 | print_err_oom(); | |
9009cc24 PP |
4247 | goto error; |
4248 | } | |
4249 | break; | |
4250 | case OPT_RUN_ARGS: | |
4251 | if (print_run_args_0) { | |
4252 | printf_err("Cannot specify --run-args and --run-args-0\n"); | |
4253 | goto error; | |
4254 | } | |
4255 | ||
4256 | print_run_args = true; | |
4257 | break; | |
4258 | case OPT_RUN_ARGS_0: | |
4259 | if (print_run_args) { | |
4260 | printf_err("Cannot specify --run-args and --run-args-0\n"); | |
4261 | goto error; | |
4262 | } | |
4263 | ||
4264 | print_run_args_0 = true; | |
4265 | break; | |
4266 | case OPT_STREAM_INTERSECTION: | |
75a2cb9b JG |
4267 | /* |
4268 | * Applies to all traces implementing the trace-info | |
4269 | * query. | |
4270 | */ | |
4271 | stream_intersection_mode = true; | |
9009cc24 PP |
4272 | break; |
4273 | case OPT_VERBOSE: | |
3efa3052 PP |
4274 | if (*log_level != 'V' && *log_level != 'D') { |
4275 | *log_level = 'I'; | |
9009cc24 | 4276 | } |
9009cc24 PP |
4277 | break; |
4278 | case OPT_DEBUG: | |
3efa3052 | 4279 | *log_level = 'V'; |
9009cc24 PP |
4280 | break; |
4281 | } | |
4282 | ||
4283 | free(arg); | |
4284 | arg = NULL; | |
4285 | } | |
4286 | ||
4287 | /* Check for option parsing error */ | |
4288 | if (opt < -1) { | |
4289 | printf_err("While parsing command-line options, at option %s: %s\n", | |
4290 | poptBadOption(pc, 0), poptStrerror(opt)); | |
4291 | goto error; | |
4292 | } | |
4293 | ||
3efa3052 PP |
4294 | /* |
4295 | * Legacy behaviour: --verbose used to make the `text` output | |
4296 | * format print more information. --verbose is now equivalent to | |
4297 | * the INFO log level, which is why we compare to 'I' here. | |
4298 | */ | |
4299 | if (*log_level == 'I') { | |
4300 | append_implicit_component_param(&implicit_text_args, | |
4301 | "verbose", "yes"); | |
4302 | } | |
4303 | ||
9009cc24 PP |
4304 | /* |
4305 | * Append home and system plugin paths now that we possibly got | |
4306 | * --plugin-path. | |
4307 | */ | |
4308 | if (append_home_and_system_plugin_paths(plugin_paths, | |
4309 | force_omit_system_plugin_path, | |
4310 | force_omit_home_plugin_path)) { | |
4311 | goto error; | |
4312 | } | |
4313 | ||
94023a1c PP |
4314 | /* Consume and keep leftover arguments */ |
4315 | while ((leftover = poptGetArg(pc))) { | |
4316 | GString *gs_leftover = g_string_new(leftover); | |
9009cc24 | 4317 | |
94023a1c PP |
4318 | if (!gs_leftover) { |
4319 | print_err_oom(); | |
4320 | goto error; | |
4321 | } | |
4322 | ||
4323 | leftovers = g_list_append(leftovers, gs_leftover); | |
4324 | if (!leftovers) { | |
4325 | g_string_free(gs_leftover, TRUE); | |
4326 | print_err_oom(); | |
4327 | goto error; | |
4328 | } | |
9009cc24 PP |
4329 | } |
4330 | ||
4331 | /* Print CTF metadata or print LTTng live sessions */ | |
4332 | if (print_ctf_metadata) { | |
94023a1c PP |
4333 | GString *gs_leftover; |
4334 | ||
4335 | if (g_list_length(leftovers) == 0) { | |
9009cc24 PP |
4336 | printf_err("--output-format=ctf-metadata specified without a path\n"); |
4337 | goto error; | |
4338 | } | |
4339 | ||
94023a1c PP |
4340 | if (g_list_length(leftovers) > 1) { |
4341 | printf_err("Too many paths specified for --output-format=ctf-metadata\n"); | |
4342 | goto error; | |
4343 | } | |
4344 | ||
9009cc24 PP |
4345 | cfg = bt_config_print_ctf_metadata_create(plugin_paths); |
4346 | if (!cfg) { | |
4347 | goto error; | |
4348 | } | |
4349 | ||
94023a1c | 4350 | gs_leftover = leftovers->data; |
9009cc24 | 4351 | g_string_assign(cfg->cmd_data.print_ctf_metadata.path, |
94023a1c | 4352 | gs_leftover->str); |
c327e427 PP |
4353 | |
4354 | if (output) { | |
4355 | g_string_assign( | |
4356 | cfg->cmd_data.print_ctf_metadata.output_path, | |
4357 | output); | |
4358 | } | |
4359 | ||
9009cc24 PP |
4360 | goto end; |
4361 | } | |
4362 | ||
4363 | /* | |
e7ad156c PP |
4364 | * If -o ctf was specified, make sure an output path (--output) |
4365 | * was also specified. --output does not imply -o ctf because | |
4366 | * it's also used for the default, implicit -o text if -o ctf | |
4367 | * is not specified. | |
4368 | */ | |
4369 | if (implicit_ctf_output_args.exists) { | |
4370 | if (!output) { | |
4371 | printf_err("--output-format=ctf specified without --output (trace output path)\n"); | |
4372 | goto error; | |
4373 | } | |
4374 | ||
4375 | /* | |
4376 | * At this point we know that -o ctf AND --output were | |
4377 | * specified. Make sure that no options were specified | |
4378 | * which would imply -o text because --output would be | |
4379 | * ambiguous in this case. For example, this is wrong: | |
4380 | * | |
4381 | * babeltrace --names=all -o ctf --output=/tmp/path my-trace | |
4382 | * | |
4383 | * because --names=all implies -o text, and --output | |
4384 | * could apply to both the sink.text.pretty and | |
4385 | * sink.ctf.fs implicit components. | |
4386 | */ | |
4387 | if (implicit_text_args.exists) { | |
4388 | printf_err("Ambiguous --output option: --output-format=ctf specified but another option implies --output-format=text\n"); | |
4389 | goto error; | |
4390 | } | |
4391 | } | |
4392 | ||
4393 | /* | |
4394 | * If -o dummy and -o ctf were not specified, and if there are | |
4395 | * no explicit sink components, then use an implicit | |
4396 | * `sink.text.pretty` component. | |
9009cc24 | 4397 | */ |
e7ad156c PP |
4398 | if (!implicit_dummy_args.exists && !implicit_ctf_output_args.exists && |
4399 | !sink_names) { | |
9009cc24 PP |
4400 | implicit_text_args.exists = true; |
4401 | } | |
4402 | ||
e7ad156c PP |
4403 | /* |
4404 | * Set implicit `sink.text.pretty` or `sink.ctf.fs` component's | |
4405 | * `path` parameter if --output was specified. | |
4406 | */ | |
4407 | if (output) { | |
4408 | if (implicit_text_args.exists) { | |
4409 | append_implicit_component_extra_param(&implicit_text_args, | |
4410 | "path", output); | |
4411 | } else if (implicit_ctf_output_args.exists) { | |
4412 | append_implicit_component_extra_param(&implicit_ctf_output_args, | |
4413 | "path", output); | |
4414 | } | |
4415 | } | |
4416 | ||
94023a1c PP |
4417 | /* Decide where the leftover argument(s) go */ |
4418 | if (g_list_length(leftovers) > 0) { | |
9009cc24 | 4419 | if (implicit_lttng_live_args.exists) { |
94023a1c PP |
4420 | GString *gs_leftover; |
4421 | ||
4422 | if (g_list_length(leftovers) > 1) { | |
4423 | printf_err("Too many URLs specified for --output-format=lttng-live\n"); | |
4424 | goto error; | |
4425 | } | |
4426 | ||
4427 | gs_leftover = leftovers->data; | |
9009cc24 | 4428 | lttng_live_url_parts = |
94023a1c | 4429 | bt_common_parse_lttng_live_url(gs_leftover->str, |
94b828f3 | 4430 | error_buf, sizeof(error_buf)); |
9009cc24 PP |
4431 | if (!lttng_live_url_parts.proto) { |
4432 | printf_err("Invalid LTTng live URL format: %s\n", | |
4433 | error_buf); | |
4434 | goto error; | |
4435 | } | |
4436 | ||
4437 | if (!lttng_live_url_parts.session_name) { | |
4438 | /* Print LTTng live sessions */ | |
4439 | cfg = bt_config_print_lttng_live_sessions_create( | |
4440 | plugin_paths); | |
4441 | if (!cfg) { | |
4442 | goto error; | |
4443 | } | |
4444 | ||
9009cc24 | 4445 | g_string_assign(cfg->cmd_data.print_lttng_live_sessions.url, |
94023a1c | 4446 | gs_leftover->str); |
c327e427 PP |
4447 | |
4448 | if (output) { | |
4449 | g_string_assign( | |
4450 | cfg->cmd_data.print_lttng_live_sessions.output_path, | |
4451 | output); | |
4452 | } | |
4453 | ||
9009cc24 PP |
4454 | goto end; |
4455 | } | |
4456 | ||
e7ad156c | 4457 | ret = append_implicit_component_extra_param( |
94023a1c PP |
4458 | &implicit_lttng_live_args, "url", |
4459 | gs_leftover->str); | |
9009cc24 PP |
4460 | if (ret) { |
4461 | goto error; | |
4462 | } | |
4463 | } else { | |
94023a1c PP |
4464 | /* |
4465 | * Append one implicit component argument set | |
4466 | * for each leftover (souce.ctf.fs paths). Copy | |
4467 | * the base implicit component arguments. | |
4468 | * Note that they still have to be named later. | |
4469 | */ | |
4470 | ret = fill_implicit_ctf_inputs_args( | |
4471 | implicit_ctf_inputs_args, | |
4472 | &base_implicit_ctf_input_args, leftovers); | |
9009cc24 PP |
4473 | if (ret) { |
4474 | goto error; | |
4475 | } | |
4476 | } | |
4477 | } | |
4478 | ||
4479 | /* | |
fd5f8053 PP |
4480 | * Ensure mutual exclusion between implicit `source.ctf.fs` and |
4481 | * `source.ctf.lttng-live` components. | |
9009cc24 | 4482 | */ |
94023a1c PP |
4483 | if (base_implicit_ctf_input_args.exists && |
4484 | implicit_lttng_live_args.exists) { | |
fd5f8053 | 4485 | printf_err("Cannot create both implicit `%s` and `%s` components\n", |
94023a1c | 4486 | base_implicit_ctf_input_args.comp_arg->str, |
fd5f8053 | 4487 | implicit_lttng_live_args.comp_arg->str); |
9009cc24 PP |
4488 | goto error; |
4489 | } | |
4490 | ||
4491 | /* | |
fd5f8053 | 4492 | * If the implicit `source.ctf.fs` or `source.ctf.lttng-live` |
94023a1c PP |
4493 | * components exists, make sure there's at least one leftover |
4494 | * (which is the path or URL). | |
9009cc24 | 4495 | */ |
94023a1c PP |
4496 | if (base_implicit_ctf_input_args.exists && |
4497 | g_list_length(leftovers) == 0) { | |
fd5f8053 | 4498 | printf_err("Missing path for implicit `%s` component\n", |
94023a1c | 4499 | base_implicit_ctf_input_args.comp_arg->str); |
9009cc24 PP |
4500 | goto error; |
4501 | } | |
4502 | ||
94023a1c | 4503 | if (implicit_lttng_live_args.exists && g_list_length(leftovers) == 0) { |
fd5f8053 PP |
4504 | printf_err("Missing URL for implicit `%s` component\n", |
4505 | implicit_lttng_live_args.comp_arg->str); | |
9009cc24 PP |
4506 | goto error; |
4507 | } | |
4508 | ||
4509 | /* Assign names to implicit components */ | |
94023a1c PP |
4510 | for (i = 0; i < implicit_ctf_inputs_args->len; i++) { |
4511 | struct implicit_component_args *impl_args = | |
4512 | g_ptr_array_index(implicit_ctf_inputs_args, i); | |
4513 | ||
4514 | ret = assign_name_to_implicit_component(impl_args, | |
4515 | "source-ctf-fs", all_names, &source_names, true); | |
4516 | if (ret) { | |
4517 | goto error; | |
4518 | } | |
9009cc24 PP |
4519 | } |
4520 | ||
4521 | ret = assign_name_to_implicit_component(&implicit_lttng_live_args, | |
4522 | "lttng-live", all_names, &source_names, true); | |
4523 | if (ret) { | |
4524 | goto error; | |
4525 | } | |
4526 | ||
4527 | ret = assign_name_to_implicit_component(&implicit_text_args, | |
4528 | "pretty", all_names, &sink_names, true); | |
4529 | if (ret) { | |
4530 | goto error; | |
4531 | } | |
4532 | ||
e7ad156c PP |
4533 | ret = assign_name_to_implicit_component(&implicit_ctf_output_args, |
4534 | "sink-ctf-fs", all_names, &sink_names, true); | |
4535 | if (ret) { | |
4536 | goto error; | |
4537 | } | |
4538 | ||
9009cc24 PP |
4539 | ret = assign_name_to_implicit_component(&implicit_dummy_args, |
4540 | "dummy", all_names, &sink_names, true); | |
4541 | if (ret) { | |
4542 | goto error; | |
4543 | } | |
4544 | ||
4545 | ret = assign_name_to_implicit_component(&implicit_muxer_args, | |
4546 | "muxer", all_names, NULL, false); | |
4547 | if (ret) { | |
4548 | goto error; | |
4549 | } | |
4550 | ||
4551 | ret = assign_name_to_implicit_component(&implicit_trimmer_args, | |
4552 | "trimmer", all_names, NULL, false); | |
4553 | if (ret) { | |
4554 | goto error; | |
4555 | } | |
4556 | ||
4557 | ret = assign_name_to_implicit_component(&implicit_debug_info_args, | |
4558 | "debug-info", all_names, NULL, false); | |
4559 | if (ret) { | |
4560 | goto error; | |
4561 | } | |
4562 | ||
4563 | /* Make sure there's at least one source and one sink */ | |
4564 | if (!source_names) { | |
4565 | printf_err("No source component\n"); | |
4566 | goto error; | |
4567 | } | |
4568 | ||
4569 | if (!sink_names) { | |
4570 | printf_err("No sink component\n"); | |
4571 | goto error; | |
4572 | } | |
4573 | ||
4574 | /* | |
4575 | * Prepend the muxer, the trimmer, and the debug info to the | |
4576 | * filter chain so that we have: | |
4577 | * | |
4578 | * sources -> muxer -> [trimmer] -> [debug info] -> | |
4579 | * [user filters] -> sinks | |
4580 | */ | |
4581 | if (implicit_debug_info_args.exists) { | |
4582 | if (g_list_prepend_gstring(&filter_names, | |
4583 | implicit_debug_info_args.name_arg->str)) { | |
4584 | goto error; | |
4585 | } | |
4586 | } | |
4587 | ||
4588 | if (implicit_trimmer_args.exists) { | |
4589 | if (g_list_prepend_gstring(&filter_names, | |
4590 | implicit_trimmer_args.name_arg->str)) { | |
4591 | goto error; | |
4592 | } | |
4593 | } | |
4594 | ||
4595 | if (g_list_prepend_gstring(&filter_names, | |
4596 | implicit_muxer_args.name_arg->str)) { | |
4597 | goto error; | |
4598 | } | |
4599 | ||
4600 | /* | |
4601 | * Append the equivalent run arguments for the implicit | |
4602 | * components. | |
4603 | */ | |
94023a1c PP |
4604 | for (i = 0; i < implicit_ctf_inputs_args->len; i++) { |
4605 | struct implicit_component_args *impl_args = | |
4606 | g_ptr_array_index(implicit_ctf_inputs_args, i); | |
4607 | ||
4608 | ret = append_run_args_for_implicit_component(impl_args, | |
4609 | run_args); | |
4610 | if (ret) { | |
4611 | goto error; | |
4612 | } | |
9009cc24 PP |
4613 | } |
4614 | ||
fd5f8053 | 4615 | ret = append_run_args_for_implicit_component(&implicit_lttng_live_args, |
9009cc24 PP |
4616 | run_args); |
4617 | if (ret) { | |
4618 | goto error; | |
4619 | } | |
4620 | ||
fd5f8053 PP |
4621 | ret = append_run_args_for_implicit_component(&implicit_text_args, |
4622 | run_args); | |
9009cc24 PP |
4623 | if (ret) { |
4624 | goto error; | |
4625 | } | |
4626 | ||
e7ad156c PP |
4627 | ret = append_run_args_for_implicit_component(&implicit_ctf_output_args, |
4628 | run_args); | |
4629 | if (ret) { | |
4630 | goto error; | |
4631 | } | |
4632 | ||
fd5f8053 PP |
4633 | ret = append_run_args_for_implicit_component(&implicit_dummy_args, |
4634 | run_args); | |
9009cc24 PP |
4635 | if (ret) { |
4636 | goto error; | |
4637 | } | |
4638 | ||
fd5f8053 PP |
4639 | ret = append_run_args_for_implicit_component(&implicit_muxer_args, |
4640 | run_args); | |
9009cc24 PP |
4641 | if (ret) { |
4642 | goto error; | |
4643 | } | |
4644 | ||
fd5f8053 | 4645 | ret = append_run_args_for_implicit_component(&implicit_trimmer_args, |
9009cc24 PP |
4646 | run_args); |
4647 | if (ret) { | |
4648 | goto error; | |
4649 | } | |
4650 | ||
fd5f8053 | 4651 | ret = append_run_args_for_implicit_component(&implicit_debug_info_args, |
9009cc24 PP |
4652 | run_args); |
4653 | if (ret) { | |
4654 | goto error; | |
4655 | } | |
4656 | ||
4657 | /* Auto-connect components */ | |
4658 | ret = convert_auto_connect(run_args, source_names, filter_names, | |
4659 | sink_names); | |
4660 | if (ret) { | |
4661 | printf_err("Cannot auto-connect components\n"); | |
4662 | goto error; | |
4663 | } | |
4664 | ||
4665 | /* | |
4666 | * We have all the run command arguments now. Depending on | |
4667 | * --run-args, we pass this to the run command or print them | |
4668 | * here. | |
4669 | */ | |
4670 | if (print_run_args || print_run_args_0) { | |
c60cf081 PP |
4671 | if (stream_intersection_mode) { |
4672 | printf_err("Cannot specify --stream-intersection with --run-args or --run-args-0\n"); | |
4673 | goto error; | |
4674 | } | |
4675 | ||
05e21286 PP |
4676 | for (i = 0; i < bt_value_array_get_size(run_args); i++) { |
4677 | const struct bt_value *arg_value = | |
4678 | bt_value_array_borrow_element_by_index(run_args, | |
4679 | i); | |
9009cc24 PP |
4680 | const char *arg; |
4681 | GString *quoted = NULL; | |
4682 | const char *arg_to_print; | |
4683 | ||
f6ccaed9 | 4684 | BT_ASSERT(arg_value); |
601b0d3c | 4685 | arg = bt_value_string_get(arg_value); |
9009cc24 PP |
4686 | |
4687 | if (print_run_args) { | |
4688 | quoted = bt_common_shell_quote(arg, true); | |
4689 | if (!quoted) { | |
4690 | goto error; | |
4691 | } | |
4692 | ||
4693 | arg_to_print = quoted->str; | |
4694 | } else { | |
4695 | arg_to_print = arg; | |
4696 | } | |
4697 | ||
4698 | printf("%s", arg_to_print); | |
4699 | ||
4700 | if (quoted) { | |
4701 | g_string_free(quoted, TRUE); | |
4702 | } | |
4703 | ||
05e21286 | 4704 | if (i < bt_value_array_get_size(run_args) - 1) { |
9009cc24 PP |
4705 | if (print_run_args) { |
4706 | putchar(' '); | |
4707 | } else { | |
4708 | putchar('\0'); | |
4709 | } | |
4710 | } | |
4711 | } | |
4712 | ||
4713 | *retcode = -1; | |
65300d60 | 4714 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
4715 | goto end; |
4716 | } | |
4717 | ||
05e21286 PP |
4718 | cfg = bt_config_run_from_args_array(run_args, retcode, |
4719 | force_omit_system_plugin_path, | |
4720 | force_omit_home_plugin_path, | |
4721 | initial_plugin_paths); | |
fc11b6a6 PP |
4722 | if (!cfg) { |
4723 | goto error; | |
4724 | } | |
4725 | ||
75a2cb9b | 4726 | cfg->cmd_data.run.stream_intersection_mode = stream_intersection_mode; |
9009cc24 PP |
4727 | goto end; |
4728 | ||
4729 | error: | |
4730 | *retcode = 1; | |
65300d60 | 4731 | BT_OBJECT_PUT_REF_AND_RESET(cfg); |
9009cc24 PP |
4732 | |
4733 | end: | |
4734 | if (pc) { | |
4735 | poptFreeContext(pc); | |
4736 | } | |
4737 | ||
4738 | free(arg); | |
e7ad156c | 4739 | free(output); |
9009cc24 PP |
4740 | |
4741 | if (cur_name) { | |
4742 | g_string_free(cur_name, TRUE); | |
4743 | } | |
4744 | ||
4745 | if (cur_name_prefix) { | |
4746 | g_string_free(cur_name_prefix, TRUE); | |
4747 | } | |
4748 | ||
94023a1c PP |
4749 | if (implicit_ctf_inputs_args) { |
4750 | g_ptr_array_free(implicit_ctf_inputs_args, TRUE); | |
4751 | } | |
4752 | ||
65300d60 PP |
4753 | bt_object_put_ref(run_args); |
4754 | bt_object_put_ref(all_names); | |
9009cc24 PP |
4755 | destroy_glist_of_gstring(source_names); |
4756 | destroy_glist_of_gstring(filter_names); | |
4757 | destroy_glist_of_gstring(sink_names); | |
94023a1c PP |
4758 | destroy_glist_of_gstring(leftovers); |
4759 | finalize_implicit_component_args(&base_implicit_ctf_input_args); | |
4760 | finalize_implicit_component_args(&implicit_ctf_output_args); | |
4761 | finalize_implicit_component_args(&implicit_lttng_live_args); | |
4762 | finalize_implicit_component_args(&implicit_dummy_args); | |
4763 | finalize_implicit_component_args(&implicit_text_args); | |
4764 | finalize_implicit_component_args(&implicit_debug_info_args); | |
4765 | finalize_implicit_component_args(&implicit_muxer_args); | |
4766 | finalize_implicit_component_args(&implicit_trimmer_args); | |
65300d60 | 4767 | bt_object_put_ref(plugin_paths); |
9009cc24 PP |
4768 | bt_common_destroy_lttng_live_url_parts(<tng_live_url_parts); |
4769 | return cfg; | |
4770 | } | |
4771 | ||
4772 | /* | |
4773 | * Prints the Babeltrace 2.x general usage. | |
4774 | */ | |
4775 | static | |
4776 | void print_gen_usage(FILE *fp) | |
4777 | { | |
4778 | fprintf(fp, "Usage: babeltrace [GENERAL OPTIONS] [COMMAND] [COMMAND ARGUMENTS]\n"); | |
4779 | fprintf(fp, "\n"); | |
4780 | fprintf(fp, "General options:\n"); | |
4781 | fprintf(fp, "\n"); | |
3efa3052 PP |
4782 | fprintf(fp, " -d, --debug Enable debug mode (same as --log-level=V)\n"); |
4783 | fprintf(fp, " -h, --help Show this help and quit\n"); | |
5bd4da00 | 4784 | fprintf(fp, " -l, --log-level=LVL Set all log levels to LVL (`N`, `V`, `D`,\n"); |
3efa3052 PP |
4785 | fprintf(fp, " `I`, `W` (default), `E`, or `F`)\n"); |
4786 | fprintf(fp, " -v, --verbose Enable verbose mode (same as --log-level=I)\n"); | |
4787 | fprintf(fp, " -V, --version Show version and quit\n"); | |
9009cc24 PP |
4788 | fprintf(fp, "\n"); |
4789 | fprintf(fp, "Available commands:\n"); | |
4790 | fprintf(fp, "\n"); | |
4791 | fprintf(fp, " convert Convert and trim traces (default)\n"); | |
4792 | fprintf(fp, " help Get help for a plugin or a component class\n"); | |
4793 | fprintf(fp, " list-plugins List available plugins and their content\n"); | |
4794 | fprintf(fp, " query Query objects from a component class\n"); | |
4795 | fprintf(fp, " run Build a processing graph and run it\n"); | |
4796 | fprintf(fp, "\n"); | |
4797 | fprintf(fp, "Use `babeltrace COMMAND --help` to show the help of COMMAND.\n"); | |
4798 | } | |
4799 | ||
3efa3052 PP |
4800 | static |
4801 | char log_level_from_arg(const char *arg) | |
4802 | { | |
4803 | char level = 'U'; | |
4804 | ||
4805 | if (strcmp(arg, "VERBOSE") == 0 || | |
4806 | strcmp(arg, "V") == 0) { | |
4807 | level = 'V'; | |
4808 | } else if (strcmp(arg, "DEBUG") == 0 || | |
4809 | strcmp(arg, "D") == 0) { | |
4810 | level = 'D'; | |
4811 | } else if (strcmp(arg, "INFO") == 0 || | |
4812 | strcmp(arg, "I") == 0) { | |
4813 | level = 'I'; | |
4814 | } else if (strcmp(arg, "WARN") == 0 || | |
4815 | strcmp(arg, "WARNING") == 0 || | |
4816 | strcmp(arg, "W") == 0) { | |
4817 | level = 'W'; | |
4818 | } else if (strcmp(arg, "ERROR") == 0 || | |
4819 | strcmp(arg, "E") == 0) { | |
4820 | level = 'E'; | |
4821 | } else if (strcmp(arg, "FATAL") == 0 || | |
4822 | strcmp(arg, "F") == 0) { | |
4823 | level = 'F'; | |
4824 | } else if (strcmp(arg, "NONE") == 0 || | |
4825 | strcmp(arg, "N") == 0) { | |
4826 | level = 'N'; | |
4827 | } | |
4828 | ||
4829 | return level; | |
4830 | } | |
4831 | ||
9009cc24 PP |
4832 | struct bt_config *bt_config_cli_args_create(int argc, const char *argv[], |
4833 | int *retcode, bool force_omit_system_plugin_path, | |
9a16feea | 4834 | bool force_omit_home_plugin_path, |
05e21286 | 4835 | const struct bt_value *initial_plugin_paths) |
9009cc24 PP |
4836 | { |
4837 | struct bt_config *config = NULL; | |
9009cc24 PP |
4838 | int i; |
4839 | const char **command_argv = NULL; | |
4840 | int command_argc = -1; | |
4841 | const char *command_name = NULL; | |
3efa3052 | 4842 | char log_level = 'U'; |
9009cc24 PP |
4843 | |
4844 | enum command_type { | |
4845 | COMMAND_TYPE_NONE = -1, | |
4846 | COMMAND_TYPE_RUN = 0, | |
4847 | COMMAND_TYPE_CONVERT, | |
4848 | COMMAND_TYPE_LIST_PLUGINS, | |
4849 | COMMAND_TYPE_HELP, | |
4850 | COMMAND_TYPE_QUERY, | |
4851 | } command_type = COMMAND_TYPE_NONE; | |
4852 | ||
4853 | *retcode = -1; | |
4854 | ||
4855 | if (!initial_plugin_paths) { | |
05e21286 | 4856 | initial_plugin_paths = bt_value_array_create(); |
9009cc24 PP |
4857 | if (!initial_plugin_paths) { |
4858 | *retcode = 1; | |
4859 | goto end; | |
4860 | } | |
4861 | } else { | |
65300d60 | 4862 | bt_object_get_ref(initial_plugin_paths); |
9009cc24 PP |
4863 | } |
4864 | ||
4865 | if (argc <= 1) { | |
d878cbfd PP |
4866 | print_version(); |
4867 | puts(""); | |
9009cc24 PP |
4868 | print_gen_usage(stdout); |
4869 | goto end; | |
4870 | } | |
4871 | ||
4872 | for (i = 1; i < argc; i++) { | |
4873 | const char *cur_arg = argv[i]; | |
3efa3052 | 4874 | const char *next_arg = i == (argc - 1) ? NULL : argv[i + 1]; |
9009cc24 PP |
4875 | |
4876 | if (strcmp(cur_arg, "-d") == 0 || | |
4877 | strcmp(cur_arg, "--debug") == 0) { | |
3efa3052 | 4878 | log_level = 'V'; |
9009cc24 PP |
4879 | } else if (strcmp(cur_arg, "-v") == 0 || |
4880 | strcmp(cur_arg, "--verbose") == 0) { | |
3efa3052 PP |
4881 | if (log_level != 'V' && log_level != 'D') { |
4882 | /* | |
4883 | * Legacy: do not override a previous | |
4884 | * --debug because --verbose and --debug | |
4885 | * can be specified together (in this | |
4886 | * case we want the lowest log level to | |
4887 | * apply, VERBOSE). | |
4888 | */ | |
4889 | log_level = 'I'; | |
4890 | } | |
5bd4da00 PP |
4891 | } else if (strcmp(cur_arg, "--log-level") == 0 || |
4892 | strcmp(cur_arg, "-l") == 0) { | |
3efa3052 PP |
4893 | if (!next_arg) { |
4894 | printf_err("Missing log level value for --log-level option\n"); | |
4895 | *retcode = 1; | |
4896 | goto end; | |
4897 | } | |
4898 | ||
4899 | log_level = log_level_from_arg(next_arg); | |
4900 | if (log_level == 'U') { | |
4901 | printf_err("Invalid argument for --log-level option:\n %s\n", | |
4902 | next_arg); | |
4903 | *retcode = 1; | |
4904 | goto end; | |
4905 | } | |
4906 | ||
4907 | i++; | |
4908 | } else if (strncmp(cur_arg, "--log-level=", 12) == 0) { | |
4909 | const char *arg = &cur_arg[12]; | |
4910 | ||
5bd4da00 PP |
4911 | log_level = log_level_from_arg(arg); |
4912 | if (log_level == 'U') { | |
4913 | printf_err("Invalid argument for --log-level option:\n %s\n", | |
4914 | arg); | |
4915 | *retcode = 1; | |
4916 | goto end; | |
4917 | } | |
4918 | } else if (strncmp(cur_arg, "-l", 2) == 0) { | |
4919 | const char *arg = &cur_arg[2]; | |
4920 | ||
3efa3052 PP |
4921 | log_level = log_level_from_arg(arg); |
4922 | if (log_level == 'U') { | |
4923 | printf_err("Invalid argument for --log-level option:\n %s\n", | |
4924 | arg); | |
4925 | *retcode = 1; | |
4926 | goto end; | |
4927 | } | |
9009cc24 PP |
4928 | } else if (strcmp(cur_arg, "-V") == 0 || |
4929 | strcmp(cur_arg, "--version") == 0) { | |
4930 | print_version(); | |
4931 | goto end; | |
4932 | } else if (strcmp(cur_arg, "-h") == 0 || | |
4933 | strcmp(cur_arg, "--help") == 0) { | |
4934 | print_gen_usage(stdout); | |
4935 | goto end; | |
4936 | } else { | |
9009cc24 PP |
4937 | /* |
4938 | * First unknown argument: is it a known command | |
4939 | * name? | |
4940 | */ | |
3efa3052 PP |
4941 | command_argv = &argv[i]; |
4942 | command_argc = argc - i; | |
4943 | ||
9009cc24 PP |
4944 | if (strcmp(cur_arg, "convert") == 0) { |
4945 | command_type = COMMAND_TYPE_CONVERT; | |
4946 | } else if (strcmp(cur_arg, "list-plugins") == 0) { | |
4947 | command_type = COMMAND_TYPE_LIST_PLUGINS; | |
4948 | } else if (strcmp(cur_arg, "help") == 0) { | |
4949 | command_type = COMMAND_TYPE_HELP; | |
4950 | } else if (strcmp(cur_arg, "query") == 0) { | |
4951 | command_type = COMMAND_TYPE_QUERY; | |
4952 | } else if (strcmp(cur_arg, "run") == 0) { | |
4953 | command_type = COMMAND_TYPE_RUN; | |
4954 | } else { | |
4955 | /* | |
4956 | * Unknown argument, but not a known | |
3efa3052 PP |
4957 | * command name: assume the default |
4958 | * `convert` command. | |
9009cc24 PP |
4959 | */ |
4960 | command_type = COMMAND_TYPE_CONVERT; | |
3efa3052 PP |
4961 | command_name = "convert"; |
4962 | command_argv = &argv[i - 1]; | |
4963 | command_argc = argc - i + 1; | |
9009cc24 PP |
4964 | } |
4965 | break; | |
4966 | } | |
4967 | } | |
4968 | ||
4969 | if (command_type == COMMAND_TYPE_NONE) { | |
4970 | /* | |
4971 | * We only got non-help, non-version general options | |
4972 | * like --verbose and --debug, without any other | |
4973 | * arguments, so we can't do anything useful: print the | |
4974 | * usage and quit. | |
4975 | */ | |
4976 | print_gen_usage(stdout); | |
4977 | goto end; | |
4978 | } | |
4979 | ||
f6ccaed9 PP |
4980 | BT_ASSERT(command_argv); |
4981 | BT_ASSERT(command_argc >= 0); | |
9009cc24 PP |
4982 | |
4983 | switch (command_type) { | |
4984 | case COMMAND_TYPE_RUN: | |
4985 | config = bt_config_run_from_args(command_argc, command_argv, | |
4986 | retcode, force_omit_system_plugin_path, | |
4987 | force_omit_home_plugin_path, initial_plugin_paths); | |
4988 | break; | |
4989 | case COMMAND_TYPE_CONVERT: | |
4990 | config = bt_config_convert_from_args(command_argc, command_argv, | |
4991 | retcode, force_omit_system_plugin_path, | |
9a16feea | 4992 | force_omit_home_plugin_path, |
3efa3052 | 4993 | initial_plugin_paths, &log_level); |
9009cc24 PP |
4994 | break; |
4995 | case COMMAND_TYPE_LIST_PLUGINS: | |
4996 | config = bt_config_list_plugins_from_args(command_argc, | |
4997 | command_argv, retcode, force_omit_system_plugin_path, | |
4998 | force_omit_home_plugin_path, initial_plugin_paths); | |
4999 | break; | |
5000 | case COMMAND_TYPE_HELP: | |
5001 | config = bt_config_help_from_args(command_argc, | |
5002 | command_argv, retcode, force_omit_system_plugin_path, | |
5003 | force_omit_home_plugin_path, initial_plugin_paths); | |
5004 | break; | |
5005 | case COMMAND_TYPE_QUERY: | |
5006 | config = bt_config_query_from_args(command_argc, | |
5007 | command_argv, retcode, force_omit_system_plugin_path, | |
5008 | force_omit_home_plugin_path, initial_plugin_paths); | |
5009 | break; | |
5010 | default: | |
0fbb9a9f | 5011 | abort(); |
9009cc24 PP |
5012 | } |
5013 | ||
5014 | if (config) { | |
3efa3052 PP |
5015 | if (log_level == 'U') { |
5016 | log_level = 'W'; | |
9009cc24 PP |
5017 | } |
5018 | ||
3efa3052 | 5019 | config->log_level = log_level; |
9009cc24 PP |
5020 | config->command_name = command_name; |
5021 | } | |
5022 | ||
5023 | end: | |
65300d60 | 5024 | bt_object_put_ref(initial_plugin_paths); |
9009cc24 PP |
5025 | return config; |
5026 | } |