projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Logging: pass dynamic log level to common functions and subsystems
[babeltrace.git] / src / cli / babeltrace2.c
1 /*
2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
3 *
4 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25 #define BT_LOG_TAG "CLI"
26 #include "logging.h"
27
28 #include <babeltrace2/babeltrace.h>
29 #include "common/common.h"
30 #include <unistd.h>
31 #include <stdlib.h>
32 #include <popt.h>
33 #include <string.h>
34 #include <stdio.h>
35 #include <glib.h>
36 #include <inttypes.h>
37 #include <unistd.h>
38 #include <signal.h>
39 #include "babeltrace2-cfg.h"
40 #include "babeltrace2-cfg-cli-args.h"
41 #include "babeltrace2-cfg-cli-args-default.h"
42
43 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
44 #define ENV_BABELTRACE_CLI_LOG_LEVEL "BABELTRACE_CLI_LOG_LEVEL"
45 #define NSEC_PER_SEC 1000000000LL
46
47 /*
48 * Known environment variable names for the log levels of the project's
49 * modules.
50 */
51 static const char* log_level_env_var_names[] = {
52 "BABELTRACE_FLT_LTTNG_UTILS_DEBUG_INFO_LOG_LEVEL",
53 "BABELTRACE_FLT_UTILS_COUNTER_LOG_LEVEL",
54 "BABELTRACE_FLT_UTILS_MUXER_LOG_LEVEL",
55 "BABELTRACE_FLT_UTILS_TRIMMER_LOG_LEVEL",
56 "BABELTRACE_PLUGIN_CTF_BFCR_LOG_LEVEL",
57 "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL",
58 "BABELTRACE_PLUGIN_CTF_MSG_ITER_LOG_LEVEL",
59 "BABELTRACE_PLUGIN_CTF_UTILS_LOG_LEVEL",
60 "BABELTRACE_PYTHON_BT2_LOG_LEVEL",
61 "BABELTRACE_SINK_CTF_FS_LOG_LEVEL",
62 "BABELTRACE_SINK_TEXT_DETAILS_LOG_LEVEL",
63 "BABELTRACE_SRC_CTF_FS_LOG_LEVEL",
64 "BABELTRACE_SRC_CTF_LTTNG_LIVE_LOG_LEVEL",
65 "BABELTRACE_SRC_TEXT_DMESG_LOG_LEVEL",
66 NULL,
67 };
68
69 /* Application's processing graph (weak) */
70 static bt_graph *the_graph;
71 static bt_query_executor *the_query_executor;
72 static bool canceled = false;
73
74 GPtrArray *loaded_plugins;
75
76 #ifdef __MINGW32__
77
78 #include <windows.h>
79
80 static
81 BOOL WINAPI signal_handler(DWORD signal) {
82 if (the_graph) {
83 bt_graph_cancel(the_graph);
84 }
85
86 canceled = true;
87
88 return TRUE;
89 }
90
91 static
92 void set_signal_handler(void)
93 {
94 if (!SetConsoleCtrlHandler(signal_handler, TRUE)) {
95 BT_LOGE("Failed to set the Ctrl+C handler.");
96 }
97 }
98
99 #else /* __MINGW32__ */
100
101 static
102 void signal_handler(int signum)
103 {
104 if (signum != SIGINT) {
105 return;
106 }
107
108 if (the_graph) {
109 bt_graph_cancel(the_graph);
110 }
111
112 if (the_query_executor) {
113 bt_query_executor_cancel(the_query_executor);
114 }
115
116 canceled = true;
117 }
118
119 static
120 void set_signal_handler(void)
121 {
122 struct sigaction new_action, old_action;
123
124 new_action.sa_handler = signal_handler;
125 sigemptyset(&new_action.sa_mask);
126 new_action.sa_flags = 0;
127 sigaction(SIGINT, NULL, &old_action);
128
129 if (old_action.sa_handler != SIG_IGN) {
130 sigaction(SIGINT, &new_action, NULL);
131 }
132 }
133
134 #endif /* __MINGW32__ */
135
136 static
137 void init_static_data(void)
138 {
139 loaded_plugins = g_ptr_array_new_with_free_func(
140 (GDestroyNotify) bt_object_put_ref);
141 }
142
143 static
144 void fini_static_data(void)
145 {
146 g_ptr_array_free(loaded_plugins, TRUE);
147 }
148
149 static
150 int create_the_query_executor(void)
151 {
152 int ret = 0;
153
154 the_query_executor = bt_query_executor_create();
155 if (!the_query_executor) {
156 BT_LOGE_STR("Cannot create a query executor.");
157 ret = -1;
158 }
159
160 return ret;
161 }
162
163 static
164 void destroy_the_query_executor(void)
165 {
166 BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor);
167 }
168
169 static
170 int query(const bt_component_class *comp_cls, const char *obj,
171 const bt_value *params, const bt_value **user_result,
172 const char **fail_reason)
173 {
174 const bt_value *result = NULL;
175 bt_query_executor_status status;
176 *fail_reason = "unknown error";
177 int ret = 0;
178
179 BT_ASSERT(fail_reason);
180 BT_ASSERT(user_result);
181 ret = create_the_query_executor();
182 if (ret) {
183 /* create_the_query_executor() logs errors */
184 goto end;
185 }
186
187 if (canceled) {
188 BT_LOGI("Canceled by user before executing the query: "
189 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
190 "query-obj=\"%s\"", comp_cls,
191 bt_component_class_get_name(comp_cls), obj);
192 *fail_reason = "canceled by user";
193 goto error;
194 }
195
196 while (true) {
197 status = bt_query_executor_query(the_query_executor,
198 comp_cls, obj, params, &result);
199 switch (status) {
200 case BT_QUERY_EXECUTOR_STATUS_OK:
201 goto ok;
202 case BT_QUERY_EXECUTOR_STATUS_AGAIN:
203 {
204 const uint64_t sleep_time_us = 100000;
205
206 /* Wait 100 ms and retry */
207 BT_LOGD("Got BT_QUERY_EXECUTOR_STATUS_AGAIN: sleeping: "
208 "time-us=%" PRIu64, sleep_time_us);
209
210 if (usleep(sleep_time_us)) {
211 if (bt_query_executor_is_canceled(the_query_executor)) {
212 BT_LOGI("Query was canceled by user: "
213 "comp-cls-addr=%p, comp-cls-name=\"%s\", "
214 "query-obj=\"%s\"", comp_cls,
215 bt_component_class_get_name(comp_cls),
216 obj);
217 *fail_reason = "canceled by user";
218 goto error;
219 }
220 }
221
222 continue;
223 }
224 case BT_QUERY_EXECUTOR_STATUS_CANCELED:
225 *fail_reason = "canceled by user";
226 goto error;
227 case BT_QUERY_EXECUTOR_STATUS_ERROR:
228 goto error;
229 case BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT:
230 *fail_reason = "invalid or unknown query object";
231 goto error;
232 case BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS:
233 *fail_reason = "invalid query parameters";
234 goto error;
235 case BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED:
236 *fail_reason = "unsupported action";
237 goto error;
238 case BT_QUERY_EXECUTOR_STATUS_NOMEM:
239 *fail_reason = "not enough memory";
240 goto error;
241 default:
242 BT_LOGF("Unknown query status: status=%d", status);
243 abort();
244 }
245 }
246
247 ok:
248 *user_result = result;
249 result = NULL;
250 goto end;
251
252 error:
253 ret = -1;
254
255 end:
256 destroy_the_query_executor();
257 bt_value_put_ref(result);
258 return ret;
259 }
260
261 static
262 const bt_plugin *find_plugin(const char *name)
263 {
264 int i;
265 const bt_plugin *plugin = NULL;
266
267 BT_ASSERT(name);
268 BT_LOGI("Finding plugin: name=\"%s\"", name);
269
270 for (i = 0; i < loaded_plugins->len; i++) {
271 plugin = g_ptr_array_index(loaded_plugins, i);
272
273 if (strcmp(name, bt_plugin_get_name(plugin)) == 0) {
274 break;
275 }
276
277 plugin = NULL;
278 }
279
280 if (plugin) {
281 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
282 name, plugin);
283 } else {
284 BT_LOGI("Cannot find plugin: name=\"%s\"", name);
285 }
286
287 bt_plugin_get_ref(plugin);
288 return plugin;
289 }
290
291 typedef const void *(*plugin_borrow_comp_cls_func_t)(
292 const bt_plugin *, const char *);
293
294 static
295 const void *find_component_class_from_plugin(const char *plugin_name,
296 const char *comp_class_name,
297 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func)
298 {
299 const void *comp_class = NULL;
300 const bt_plugin *plugin;
301
302 BT_LOGI("Finding component class: plugin-name=\"%s\", "
303 "comp-cls-name=\"%s\"", plugin_name, comp_class_name);
304
305 plugin = find_plugin(plugin_name);
306 if (!plugin) {
307 goto end;
308 }
309
310 comp_class = plugin_borrow_comp_cls_func(plugin, comp_class_name);
311 bt_object_get_ref(comp_class);
312 BT_PLUGIN_PUT_REF_AND_RESET(plugin);
313
314 end:
315 if (comp_class) {
316 BT_LOGI("Found component class: plugin-name=\"%s\", "
317 "comp-cls-name=\"%s\"", plugin_name, comp_class_name);
318 } else {
319 BT_LOGI("Cannot find source component class: "
320 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
321 plugin_name, comp_class_name);
322 }
323
324 return comp_class;
325 }
326
327 static
328 const bt_component_class_source *find_source_component_class(
329 const char *plugin_name, const char *comp_class_name)
330 {
331 return (const void *) find_component_class_from_plugin(
332 plugin_name, comp_class_name,
333 (plugin_borrow_comp_cls_func_t)
334 bt_plugin_borrow_source_component_class_by_name_const);
335 }
336
337 static
338 const bt_component_class_filter *find_filter_component_class(
339 const char *plugin_name, const char *comp_class_name)
340 {
341 return (const void *) find_component_class_from_plugin(
342 plugin_name, comp_class_name,
343 (plugin_borrow_comp_cls_func_t)
344 bt_plugin_borrow_filter_component_class_by_name_const);
345 }
346
347 static
348 const bt_component_class_sink *find_sink_component_class(
349 const char *plugin_name, const char *comp_class_name)
350 {
351 return (const void *) find_component_class_from_plugin(plugin_name,
352 comp_class_name,
353 (plugin_borrow_comp_cls_func_t)
354 bt_plugin_borrow_sink_component_class_by_name_const);
355 }
356
357 static
358 const bt_component_class *find_component_class(const char *plugin_name,
359 const char *comp_class_name,
360 bt_component_class_type comp_class_type)
361 {
362 const bt_component_class *comp_cls = NULL;
363
364 switch (comp_class_type) {
365 case BT_COMPONENT_CLASS_TYPE_SOURCE:
366 comp_cls = bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name, comp_class_name));
367 break;
368 case BT_COMPONENT_CLASS_TYPE_FILTER:
369 comp_cls = bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name, comp_class_name));
370 break;
371 case BT_COMPONENT_CLASS_TYPE_SINK:
372 comp_cls = bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name, comp_class_name));
373 break;
374 default:
375 abort();
376 }
377
378 return comp_cls;
379 }
380
381 static
382 void print_indent(FILE *fp, size_t indent)
383 {
384 size_t i;
385
386 for (i = 0; i < indent; i++) {
387 fprintf(fp, " ");
388 }
389 }
390
391 static
392 const char *component_type_str(bt_component_class_type type)
393 {
394 switch (type) {
395 case BT_COMPONENT_CLASS_TYPE_SOURCE:
396 return "source";
397 case BT_COMPONENT_CLASS_TYPE_SINK:
398 return "sink";
399 case BT_COMPONENT_CLASS_TYPE_FILTER:
400 return "filter";
401 default:
402 return "(unknown)";
403 }
404 }
405
406 static
407 void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
408 const char *comp_cls_name, bt_component_class_type type)
409 {
410 GString *shell_plugin_name = NULL;
411 GString *shell_comp_cls_name = NULL;
412
413 shell_plugin_name = bt_common_shell_quote(plugin_name, false);
414 if (!shell_plugin_name) {
415 goto end;
416 }
417
418 shell_comp_cls_name = bt_common_shell_quote(comp_cls_name, false);
419 if (!shell_comp_cls_name) {
420 goto end;
421 }
422
423 fprintf(fh, "'%s%s%s%s.%s%s%s.%s%s%s'",
424 bt_common_color_bold(),
425 bt_common_color_fg_cyan(),
426 component_type_str(type),
427 bt_common_color_fg_default(),
428 bt_common_color_fg_blue(),
429 shell_plugin_name->str,
430 bt_common_color_fg_default(),
431 bt_common_color_fg_yellow(),
432 shell_comp_cls_name->str,
433 bt_common_color_reset());
434
435 end:
436 if (shell_plugin_name) {
437 g_string_free(shell_plugin_name, TRUE);
438 }
439
440 if (shell_comp_cls_name) {
441 g_string_free(shell_comp_cls_name, TRUE);
442 }
443 }
444
445 static
446 void print_value(FILE *, const bt_value *, size_t);
447
448 static
449 void print_value_rec(FILE *, const bt_value *, size_t);
450
451 struct print_map_value_data {
452 size_t indent;
453 FILE *fp;
454 };
455
456 static
457 bt_bool print_map_value(const char *key, const bt_value *object,
458 void *data)
459 {
460 struct print_map_value_data *print_map_value_data = data;
461
462 print_indent(print_map_value_data->fp, print_map_value_data->indent);
463 fprintf(print_map_value_data->fp, "%s: ", key);
464 BT_ASSERT(object);
465
466 if (bt_value_is_array(object) &&
467 bt_value_array_is_empty(object)) {
468 fprintf(print_map_value_data->fp, "[ ]\n");
469 return true;
470 }
471
472 if (bt_value_is_map(object) &&
473 bt_value_map_is_empty(object)) {
474 fprintf(print_map_value_data->fp, "{ }\n");
475 return true;
476 }
477
478 if (bt_value_is_array(object) ||
479 bt_value_is_map(object)) {
480 fprintf(print_map_value_data->fp, "\n");
481 }
482
483 print_value_rec(print_map_value_data->fp, object,
484 print_map_value_data->indent + 2);
485 return BT_TRUE;
486 }
487
488 static
489 void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
490 {
491 bt_bool bool_val;
492 int64_t int_val;
493 uint64_t uint_val;
494 double dbl_val;
495 const char *str_val;
496 int size;
497 int i;
498
499 if (!value) {
500 return;
501 }
502
503 switch (bt_value_get_type(value)) {
504 case BT_VALUE_TYPE_NULL:
505 fprintf(fp, "%snull%s\n", bt_common_color_bold(),
506 bt_common_color_reset());
507 break;
508 case BT_VALUE_TYPE_BOOL:
509 bool_val = bt_value_bool_get(value);
510 fprintf(fp, "%s%s%s%s\n", bt_common_color_bold(),
511 bt_common_color_fg_cyan(), bool_val ? "yes" : "no",
512 bt_common_color_reset());
513 break;
514 case BT_VALUE_TYPE_UNSIGNED_INTEGER:
515 uint_val = bt_value_unsigned_integer_get(value);
516 fprintf(fp, "%s%s%" PRIu64 "%s\n", bt_common_color_bold(),
517 bt_common_color_fg_red(), uint_val,
518 bt_common_color_reset());
519 break;
520 case BT_VALUE_TYPE_SIGNED_INTEGER:
521 int_val = bt_value_signed_integer_get(value);
522 fprintf(fp, "%s%s%" PRId64 "%s\n", bt_common_color_bold(),
523 bt_common_color_fg_red(), int_val,
524 bt_common_color_reset());
525 break;
526 case BT_VALUE_TYPE_REAL:
527 dbl_val = bt_value_real_get(value);
528 fprintf(fp, "%s%s%lf%s\n", bt_common_color_bold(),
529 bt_common_color_fg_red(), dbl_val,
530 bt_common_color_reset());
531 break;
532 case BT_VALUE_TYPE_STRING:
533 str_val = bt_value_string_get(value);
534 fprintf(fp, "%s%s%s%s\n", bt_common_color_bold(),
535 bt_common_color_fg_green(), str_val,
536 bt_common_color_reset());
537 break;
538 case BT_VALUE_TYPE_ARRAY:
539 size = bt_value_array_get_size(value);
540 if (size < 0) {
541 goto error;
542 }
543
544 if (size == 0) {
545 print_indent(fp, indent);
546 fprintf(fp, "[ ]\n");
547 break;
548 }
549
550 for (i = 0; i < size; i++) {
551 const bt_value *element =
552 bt_value_array_borrow_element_by_index_const(
553 value, i);
554
555 if (!element) {
556 goto error;
557 }
558 print_indent(fp, indent);
559 fprintf(fp, "- ");
560
561 if (bt_value_is_array(element) &&
562 bt_value_array_is_empty(element)) {
563 fprintf(fp, "[ ]\n");
564 continue;
565 }
566
567 if (bt_value_is_map(element) &&
568 bt_value_map_is_empty(element)) {
569 fprintf(fp, "{ }\n");
570 continue;
571 }
572
573 if (bt_value_is_array(element) ||
574 bt_value_is_map(element)) {
575 fprintf(fp, "\n");
576 }
577
578 print_value_rec(fp, element, indent + 2);
579 }
580 break;
581 case BT_VALUE_TYPE_MAP:
582 {
583 struct print_map_value_data data = {
584 .indent = indent,
585 .fp = fp,
586 };
587
588 if (bt_value_map_is_empty(value)) {
589 print_indent(fp, indent);
590 fprintf(fp, "{ }\n");
591 break;
592 }
593
594 bt_value_map_foreach_entry_const(value, print_map_value, &data);
595 break;
596 }
597 default:
598 abort();
599 }
600 return;
601
602 error:
603 BT_LOGE("Error printing value of type %s.",
604 bt_common_value_type_string(bt_value_get_type(value)));
605 }
606
607 static
608 void print_value(FILE *fp, const bt_value *value, size_t indent)
609 {
610 if (!bt_value_is_array(value) && !bt_value_is_map(value)) {
611 print_indent(fp, indent);
612 }
613
614 print_value_rec(fp, value, indent);
615 }
616
617 static
618 void print_bt_config_component(struct bt_config_component *bt_config_component)
619 {
620 fprintf(stderr, " ");
621 print_plugin_comp_cls_opt(stderr, bt_config_component->plugin_name->str,
622 bt_config_component->comp_cls_name->str,
623 bt_config_component->type);
624 fprintf(stderr, ":\n");
625
626 if (bt_config_component->instance_name->len > 0) {
627 fprintf(stderr, " Name: %s\n",
628 bt_config_component->instance_name->str);
629 }
630
631 fprintf(stderr, " Parameters:\n");
632 print_value(stderr, bt_config_component->params, 8);
633 }
634
635 static
636 void print_bt_config_components(GPtrArray *array)
637 {
638 size_t i;
639
640 for (i = 0; i < array->len; i++) {
641 struct bt_config_component *cfg_component =
642 bt_config_get_component(array, i);
643 print_bt_config_component(cfg_component);
644 BT_OBJECT_PUT_REF_AND_RESET(cfg_component);
645 }
646 }
647
648 static
649 void print_plugin_paths(const bt_value *plugin_paths)
650 {
651 fprintf(stderr, " Plugin paths:\n");
652 print_value(stderr, plugin_paths, 4);
653 }
654
655 static
656 void print_cfg_run(struct bt_config *cfg)
657 {
658 size_t i;
659
660 print_plugin_paths(cfg->plugin_paths);
661 fprintf(stderr, " Source component instances:\n");
662 print_bt_config_components(cfg->cmd_data.run.sources);
663
664 if (cfg->cmd_data.run.filters->len > 0) {
665 fprintf(stderr, " Filter component instances:\n");
666 print_bt_config_components(cfg->cmd_data.run.filters);
667 }
668
669 fprintf(stderr, " Sink component instances:\n");
670 print_bt_config_components(cfg->cmd_data.run.sinks);
671 fprintf(stderr, " Connections:\n");
672
673 for (i = 0; i < cfg->cmd_data.run.connections->len; i++) {
674 struct bt_config_connection *cfg_connection =
675 g_ptr_array_index(cfg->cmd_data.run.connections,
676 i);
677
678 fprintf(stderr, " %s%s%s -> %s%s%s\n",
679 cfg_connection->upstream_comp_name->str,
680 cfg_connection->upstream_port_glob->len > 0 ? "." : "",
681 cfg_connection->upstream_port_glob->str,
682 cfg_connection->downstream_comp_name->str,
683 cfg_connection->downstream_port_glob->len > 0 ? "." : "",
684 cfg_connection->downstream_port_glob->str);
685 }
686 }
687
688 static
689 void print_cfg_list_plugins(struct bt_config *cfg)
690 {
691 print_plugin_paths(cfg->plugin_paths);
692 }
693
694 static
695 void print_cfg_help(struct bt_config *cfg)
696 {
697 print_plugin_paths(cfg->plugin_paths);
698 }
699
700 static
701 void print_cfg_print_ctf_metadata(struct bt_config *cfg)
702 {
703 print_plugin_paths(cfg->plugin_paths);
704 fprintf(stderr, " Path: %s\n",
705 cfg->cmd_data.print_ctf_metadata.path->str);
706 }
707
708 static
709 void print_cfg_print_lttng_live_sessions(struct bt_config *cfg)
710 {
711 print_plugin_paths(cfg->plugin_paths);
712 fprintf(stderr, " URL: %s\n",
713 cfg->cmd_data.print_lttng_live_sessions.url->str);
714 }
715
716 static
717 void print_cfg_query(struct bt_config *cfg)
718 {
719 print_plugin_paths(cfg->plugin_paths);
720 fprintf(stderr, " Object: `%s`\n", cfg->cmd_data.query.object->str);
721 fprintf(stderr, " Component class:\n");
722 print_bt_config_component(cfg->cmd_data.query.cfg_component);
723 }
724
725 static
726 void print_cfg(struct bt_config *cfg)
727 {
728 if (!BT_LOG_ON_INFO) {
729 return;
730 }
731
732 BT_LOGI_STR("CLI configuration:");
733 BT_LOGI(" Debug mode: %s\n", cfg->debug ? "yes" : "no");
734 BT_LOGI(" Verbose mode: %s\n", cfg->verbose ? "yes" : "no");
735
736 switch (cfg->command) {
737 case BT_CONFIG_COMMAND_RUN:
738 print_cfg_run(cfg);
739 break;
740 case BT_CONFIG_COMMAND_LIST_PLUGINS:
741 print_cfg_list_plugins(cfg);
742 break;
743 case BT_CONFIG_COMMAND_HELP:
744 print_cfg_help(cfg);
745 break;
746 case BT_CONFIG_COMMAND_QUERY:
747 print_cfg_query(cfg);
748 break;
749 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA:
750 print_cfg_print_ctf_metadata(cfg);
751 break;
752 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS:
753 print_cfg_print_lttng_live_sessions(cfg);
754 break;
755 default:
756 abort();
757 }
758 }
759
760 static
761 void add_to_loaded_plugins(const bt_plugin_set *plugin_set)
762 {
763 int64_t i;
764 int64_t count;
765
766 count = bt_plugin_set_get_plugin_count(plugin_set);
767 BT_ASSERT(count >= 0);
768
769 for (i = 0; i < count; i++) {
770 const bt_plugin *plugin =
771 bt_plugin_set_borrow_plugin_by_index_const(plugin_set, i);
772 const bt_plugin *loaded_plugin =
773 find_plugin(bt_plugin_get_name(plugin));
774
775 BT_ASSERT(plugin);
776
777 if (loaded_plugin) {
778 BT_LOGI("Not using plugin: another one already exists with the same name: "
779 "plugin-name=\"%s\", plugin-path=\"%s\", "
780 "existing-plugin-path=\"%s\"",
781 bt_plugin_get_name(plugin),
782 bt_plugin_get_path(plugin),
783 bt_plugin_get_path(loaded_plugin));
784 bt_plugin_put_ref(loaded_plugin);
785 } else {
786 /* Add to global array. */
787 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
788 bt_plugin_get_name(plugin));
789 bt_plugin_get_ref(plugin);
790 g_ptr_array_add(loaded_plugins, (void *) plugin);
791 }
792 }
793 }
794
795 static
796 int load_dynamic_plugins(const bt_value *plugin_paths)
797 {
798 int nr_paths, i, ret = 0;
799
800 nr_paths = bt_value_array_get_size(plugin_paths);
801 if (nr_paths < 0) {
802 BT_LOGE_STR("Cannot load dynamic plugins: no plugin path.");
803 ret = -1;
804 goto end;
805 }
806
807 BT_LOGI_STR("Loading dynamic plugins.");
808
809 for (i = 0; i < nr_paths; i++) {
810 const bt_value *plugin_path_value = NULL;
811 const char *plugin_path;
812 const bt_plugin_set *plugin_set;
813
814 plugin_path_value =
815 bt_value_array_borrow_element_by_index_const(
816 plugin_paths, i);
817 plugin_path = bt_value_string_get(plugin_path_value);
818
819 /*
820 * Skip this if the directory does not exist because
821 * bt_plugin_find_all_from_dir() expects an existing
822 * directory.
823 */
824 if (!g_file_test(plugin_path, G_FILE_TEST_IS_DIR)) {
825 BT_LOGI("Skipping nonexistent directory path: "
826 "path=\"%s\"", plugin_path);
827 continue;
828 }
829
830 plugin_set = bt_plugin_find_all_from_dir(plugin_path, false);
831 if (!plugin_set) {
832 BT_LOGI("Unable to load dynamic plugins from directory: "
833 "path=\"%s\"", plugin_path);
834 continue;
835 }
836
837 add_to_loaded_plugins(plugin_set);
838 bt_plugin_set_put_ref(plugin_set);
839 }
840 end:
841 return ret;
842 }
843
844 static
845 int load_static_plugins(void)
846 {
847 int ret = 0;
848 const bt_plugin_set *plugin_set;
849
850 BT_LOGI("Loading static plugins.");
851 plugin_set = bt_plugin_find_all_from_static();
852 if (!plugin_set) {
853 BT_LOGE("Unable to load static plugins.");
854 ret = -1;
855 goto end;
856 }
857
858 add_to_loaded_plugins(plugin_set);
859 bt_plugin_set_put_ref(plugin_set);
860 end:
861 return ret;
862 }
863
864 static
865 int load_all_plugins(const bt_value *plugin_paths)
866 {
867 int ret = 0;
868
869 if (load_dynamic_plugins(plugin_paths)) {
870 ret = -1;
871 goto end;
872 }
873
874 if (load_static_plugins()) {
875 ret = -1;
876 goto end;
877 }
878
879 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins->len);
880
881 end:
882 return ret;
883 }
884
885 static
886 void print_plugin_info(const bt_plugin *plugin)
887 {
888 unsigned int major, minor, patch;
889 const char *extra;
890 bt_property_availability version_avail;
891 const char *plugin_name;
892 const char *path;
893 const char *author;
894 const char *license;
895 const char *plugin_description;
896
897 plugin_name = bt_plugin_get_name(plugin);
898 path = bt_plugin_get_path(plugin);
899 author = bt_plugin_get_author(plugin);
900 license = bt_plugin_get_license(plugin);
901 plugin_description = bt_plugin_get_description(plugin);
902 version_avail = bt_plugin_get_version(plugin, &major, &minor,
903 &patch, &extra);
904 printf("%s%s%s%s:\n", bt_common_color_bold(),
905 bt_common_color_fg_blue(), plugin_name,
906 bt_common_color_reset());
907 if (path) {
908 printf(" %sPath%s: %s\n", bt_common_color_bold(),
909 bt_common_color_reset(), path);
910 } else {
911 puts(" Built-in");
912 }
913
914 if (version_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
915 printf(" %sVersion%s: %u.%u.%u",
916 bt_common_color_bold(), bt_common_color_reset(),
917 major, minor, patch);
918
919 if (extra) {
920 printf("%s", extra);
921 }
922
923 printf("\n");
924 }
925
926 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
927 bt_common_color_reset(),
928 plugin_description ? plugin_description : "(None)");
929 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
930 bt_common_color_reset(), author ? author : "(Unknown)");
931 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
932 bt_common_color_reset(),
933 license ? license : "(Unknown)");
934 }
935
936 static
937 int cmd_query(struct bt_config *cfg)
938 {
939 int ret = 0;
940 const bt_component_class *comp_cls = NULL;
941 const bt_value *results = NULL;
942 const char *fail_reason = NULL;
943
944 comp_cls = find_component_class(
945 cfg->cmd_data.query.cfg_component->plugin_name->str,
946 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
947 cfg->cmd_data.query.cfg_component->type);
948 if (!comp_cls) {
949 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
950 "comp-cls-name=\"%s\", comp-cls-type=%d",
951 cfg->cmd_data.query.cfg_component->plugin_name->str,
952 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
953 cfg->cmd_data.query.cfg_component->type);
954 fprintf(stderr, "%s%sCannot find component class %s",
955 bt_common_color_bold(),
956 bt_common_color_fg_red(),
957 bt_common_color_reset());
958 print_plugin_comp_cls_opt(stderr,
959 cfg->cmd_data.query.cfg_component->plugin_name->str,
960 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
961 cfg->cmd_data.query.cfg_component->type);
962 fprintf(stderr, "\n");
963 ret = -1;
964 goto end;
965 }
966
967 ret = query(comp_cls, cfg->cmd_data.query.object->str,
968 cfg->cmd_data.query.cfg_component->params,
969 &results, &fail_reason);
970 if (ret) {
971 goto failed;
972 }
973
974 print_value(stdout, results, 0);
975 goto end;
976
977 failed:
978 BT_LOGE("Failed to query component class: %s: plugin-name=\"%s\", "
979 "comp-cls-name=\"%s\", comp-cls-type=%d "
980 "object=\"%s\"", fail_reason,
981 cfg->cmd_data.query.cfg_component->plugin_name->str,
982 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
983 cfg->cmd_data.query.cfg_component->type,
984 cfg->cmd_data.query.object->str);
985 fprintf(stderr, "%s%sFailed to query info to %s",
986 bt_common_color_bold(),
987 bt_common_color_fg_red(),
988 bt_common_color_reset());
989 print_plugin_comp_cls_opt(stderr,
990 cfg->cmd_data.query.cfg_component->plugin_name->str,
991 cfg->cmd_data.query.cfg_component->comp_cls_name->str,
992 cfg->cmd_data.query.cfg_component->type);
993 fprintf(stderr, "%s%s with object `%s`: %s%s\n",
994 bt_common_color_bold(),
995 bt_common_color_fg_red(),
996 cfg->cmd_data.query.object->str,
997 fail_reason,
998 bt_common_color_reset());
999 ret = -1;
1000
1001 end:
1002 bt_component_class_put_ref(comp_cls);
1003 bt_value_put_ref(results);
1004 return ret;
1005 }
1006
1007 static
1008 void print_component_class_help(const char *plugin_name,
1009 const bt_component_class *comp_cls)
1010 {
1011 const char *comp_class_name =
1012 bt_component_class_get_name(comp_cls);
1013 const char *comp_class_description =
1014 bt_component_class_get_description(comp_cls);
1015 const char *comp_class_help =
1016 bt_component_class_get_help(comp_cls);
1017 bt_component_class_type type =
1018 bt_component_class_get_type(comp_cls);
1019
1020 print_plugin_comp_cls_opt(stdout, plugin_name, comp_class_name, type);
1021 printf("\n");
1022 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
1023 bt_common_color_reset(),
1024 comp_class_description ? comp_class_description : "(None)");
1025
1026 if (comp_class_help) {
1027 printf("\n%s\n", comp_class_help);
1028 }
1029 }
1030
1031 static
1032 int cmd_help(struct bt_config *cfg)
1033 {
1034 int ret = 0;
1035 const bt_plugin *plugin = NULL;
1036 const bt_component_class *needed_comp_cls = NULL;
1037
1038 plugin = find_plugin(cfg->cmd_data.help.cfg_component->plugin_name->str);
1039 if (!plugin) {
1040 BT_LOGE("Cannot find plugin: plugin-name=\"%s\"",
1041 cfg->cmd_data.help.cfg_component->plugin_name->str);
1042 fprintf(stderr, "%s%sCannot find plugin %s%s%s\n",
1043 bt_common_color_bold(), bt_common_color_fg_red(),
1044 bt_common_color_fg_blue(),
1045 cfg->cmd_data.help.cfg_component->plugin_name->str,
1046 bt_common_color_reset());
1047 ret = -1;
1048 goto end;
1049 }
1050
1051 print_plugin_info(plugin);
1052 printf(" %sSource component classes%s: %d\n",
1053 bt_common_color_bold(),
1054 bt_common_color_reset(),
1055 (int) bt_plugin_get_source_component_class_count(plugin));
1056 printf(" %sFilter component classes%s: %d\n",
1057 bt_common_color_bold(),
1058 bt_common_color_reset(),
1059 (int) bt_plugin_get_filter_component_class_count(plugin));
1060 printf(" %sSink component classes%s: %d\n",
1061 bt_common_color_bold(),
1062 bt_common_color_reset(),
1063 (int) bt_plugin_get_sink_component_class_count(plugin));
1064
1065 if (strlen(cfg->cmd_data.help.cfg_component->comp_cls_name->str) == 0) {
1066 /* Plugin help only */
1067 goto end;
1068 }
1069
1070 needed_comp_cls = find_component_class(
1071 cfg->cmd_data.help.cfg_component->plugin_name->str,
1072 cfg->cmd_data.help.cfg_component->comp_cls_name->str,
1073 cfg->cmd_data.help.cfg_component->type);
1074 if (!needed_comp_cls) {
1075 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1076 "comp-cls-name=\"%s\", comp-cls-type=%d",
1077 cfg->cmd_data.help.cfg_component->plugin_name->str,
1078 cfg->cmd_data.help.cfg_component->comp_cls_name->str,
1079 cfg->cmd_data.help.cfg_component->type);
1080 fprintf(stderr, "\n%s%sCannot find component class %s",
1081 bt_common_color_bold(),
1082 bt_common_color_fg_red(),
1083 bt_common_color_reset());
1084 print_plugin_comp_cls_opt(stderr,
1085 cfg->cmd_data.help.cfg_component->plugin_name->str,
1086 cfg->cmd_data.help.cfg_component->comp_cls_name->str,
1087 cfg->cmd_data.help.cfg_component->type);
1088 fprintf(stderr, "\n");
1089 ret = -1;
1090 goto end;
1091 }
1092
1093 printf("\n");
1094 print_component_class_help(
1095 cfg->cmd_data.help.cfg_component->plugin_name->str,
1096 needed_comp_cls);
1097
1098 end:
1099 bt_component_class_put_ref(needed_comp_cls);
1100 bt_plugin_put_ref(plugin);
1101 return ret;
1102 }
1103
1104 typedef void *(* plugin_borrow_comp_cls_by_index_func_t)(const bt_plugin *,
1105 uint64_t);
1106 typedef const bt_component_class *(* spec_comp_cls_borrow_comp_cls_func_t)(
1107 void *);
1108
1109 void cmd_list_plugins_print_component_classes(const bt_plugin *plugin,
1110 const char *cc_type_name, uint64_t count,
1111 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func,
1112 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func)
1113 {
1114 uint64_t i;
1115
1116 if (count == 0) {
1117 printf(" %s%s component classes%s: (none)\n",
1118 bt_common_color_bold(),
1119 cc_type_name,
1120 bt_common_color_reset());
1121 goto end;
1122 } else {
1123 printf(" %s%s component classes%s:\n",
1124 bt_common_color_bold(),
1125 cc_type_name,
1126 bt_common_color_reset());
1127 }
1128
1129 for (i = 0; i < count; i++) {
1130 const bt_component_class *comp_class =
1131 spec_comp_cls_borrow_comp_cls_func(
1132 borrow_comp_cls_by_index_func(plugin, i));
1133 const char *comp_class_name =
1134 bt_component_class_get_name(comp_class);
1135 const char *comp_class_description =
1136 bt_component_class_get_description(comp_class);
1137 bt_component_class_type type =
1138 bt_component_class_get_type(comp_class);
1139
1140 printf(" ");
1141 print_plugin_comp_cls_opt(stdout,
1142 bt_plugin_get_name(plugin), comp_class_name,
1143 type);
1144
1145 if (comp_class_description) {
1146 printf(": %s", comp_class_description);
1147 }
1148
1149 printf("\n");
1150 }
1151
1152 end:
1153 return;
1154 }
1155
1156 static
1157 int cmd_list_plugins(struct bt_config *cfg)
1158 {
1159 int ret = 0;
1160 int plugins_count, component_classes_count = 0, i;
1161
1162 printf("From the following plugin paths:\n\n");
1163 print_value(stdout, cfg->plugin_paths, 2);
1164 printf("\n");
1165 plugins_count = loaded_plugins->len;
1166 if (plugins_count == 0) {
1167 printf("No plugins found.\n");
1168 goto end;
1169 }
1170
1171 for (i = 0; i < plugins_count; i++) {
1172 const bt_plugin *plugin = g_ptr_array_index(loaded_plugins, i);
1173
1174 component_classes_count +=
1175 bt_plugin_get_source_component_class_count(plugin) +
1176 bt_plugin_get_filter_component_class_count(plugin) +
1177 bt_plugin_get_sink_component_class_count(plugin);
1178 }
1179
1180 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
1181 bt_common_color_bold(),
1182 component_classes_count,
1183 bt_common_color_reset(),
1184 bt_common_color_bold(),
1185 plugins_count,
1186 bt_common_color_reset());
1187
1188 for (i = 0; i < plugins_count; i++) {
1189 const bt_plugin *plugin = g_ptr_array_index(loaded_plugins, i);
1190
1191 printf("\n");
1192 print_plugin_info(plugin);
1193 cmd_list_plugins_print_component_classes(plugin, "Source",
1194 bt_plugin_get_source_component_class_count(plugin),
1195 (plugin_borrow_comp_cls_by_index_func_t)
1196 bt_plugin_borrow_source_component_class_by_index_const,
1197 (spec_comp_cls_borrow_comp_cls_func_t)
1198 bt_component_class_source_as_component_class);
1199 cmd_list_plugins_print_component_classes(plugin, "Filter",
1200 bt_plugin_get_filter_component_class_count(plugin),
1201 (plugin_borrow_comp_cls_by_index_func_t)
1202 bt_plugin_borrow_filter_component_class_by_index_const,
1203 (spec_comp_cls_borrow_comp_cls_func_t)
1204 bt_component_class_filter_as_component_class);
1205 cmd_list_plugins_print_component_classes(plugin, "Sink",
1206 bt_plugin_get_sink_component_class_count(plugin),
1207 (plugin_borrow_comp_cls_by_index_func_t)
1208 bt_plugin_borrow_sink_component_class_by_index_const,
1209 (spec_comp_cls_borrow_comp_cls_func_t)
1210 bt_component_class_sink_as_component_class);
1211 }
1212
1213 end:
1214 return ret;
1215 }
1216
1217 static
1218 int cmd_print_lttng_live_sessions(struct bt_config *cfg)
1219 {
1220 int ret = 0;
1221 const bt_component_class *comp_cls = NULL;
1222 const bt_value *results = NULL;
1223 bt_value *params = NULL;
1224 const bt_value *map = NULL;
1225 const bt_value *v = NULL;
1226 static const char * const plugin_name = "ctf";
1227 static const char * const comp_cls_name = "lttng-live";
1228 static const bt_component_class_type comp_cls_type =
1229 BT_COMPONENT_CLASS_TYPE_SOURCE;
1230 int64_t array_size, i;
1231 const char *fail_reason = NULL;
1232 FILE *out_stream = stdout;
1233
1234 BT_ASSERT(cfg->cmd_data.print_lttng_live_sessions.url);
1235 comp_cls = find_component_class(plugin_name, comp_cls_name,
1236 comp_cls_type);
1237 if (!comp_cls) {
1238 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1239 "comp-cls-name=\"%s\", comp-cls-type=%d",
1240 plugin_name, comp_cls_name,
1241 BT_COMPONENT_CLASS_TYPE_SOURCE);
1242 fprintf(stderr, "%s%sCannot find component class %s",
1243 bt_common_color_bold(),
1244 bt_common_color_fg_red(),
1245 bt_common_color_reset());
1246 print_plugin_comp_cls_opt(stderr, plugin_name,
1247 comp_cls_name, comp_cls_type);
1248 fprintf(stderr, "\n");
1249 goto error;
1250 }
1251
1252 params = bt_value_map_create();
1253 if (!params) {
1254 goto error;
1255 }
1256
1257 ret = bt_value_map_insert_string_entry(params, "url",
1258 cfg->cmd_data.print_lttng_live_sessions.url->str);
1259 if (ret) {
1260 goto error;
1261 }
1262
1263 ret = query(comp_cls, "sessions", params,
1264 &results, &fail_reason);
1265 if (ret) {
1266 goto failed;
1267 }
1268
1269 BT_ASSERT(results);
1270
1271 if (!bt_value_is_array(results)) {
1272 BT_LOGE_STR("Expecting an array for sessions query.");
1273 fprintf(stderr, "%s%sUnexpected type returned by session query%s\n",
1274 bt_common_color_bold(),
1275 bt_common_color_fg_red(),
1276 bt_common_color_reset());
1277 goto error;
1278 }
1279
1280 if (cfg->cmd_data.print_lttng_live_sessions.output_path->len > 0) {
1281 out_stream =
1282 fopen(cfg->cmd_data.print_lttng_live_sessions.output_path->str,
1283 "w");
1284 if (!out_stream) {
1285 ret = -1;
1286 BT_LOGE_ERRNO("Cannot open file for writing",
1287 ": path=\"%s\"",
1288 cfg->cmd_data.print_lttng_live_sessions.output_path->str);
1289 goto end;
1290 }
1291 }
1292
1293 array_size = bt_value_array_get_size(results);
1294 for (i = 0; i < array_size; i++) {
1295 const char *url_text;
1296 int64_t timer_us, streams, clients;
1297
1298 map = bt_value_array_borrow_element_by_index_const(results, i);
1299 if (!map) {
1300 BT_LOGE_STR("Unexpected empty array entry.");
1301 goto error;
1302 }
1303 if (!bt_value_is_map(map)) {
1304 BT_LOGE_STR("Unexpected entry type.");
1305 goto error;
1306 }
1307
1308 v = bt_value_map_borrow_entry_value_const(map, "url");
1309 if (!v) {
1310 BT_LOGE_STR("Unexpected empty array \"url\" entry.");
1311 goto error;
1312 }
1313 url_text = bt_value_string_get(v);
1314 fprintf(out_stream, "%s", url_text);
1315 v = bt_value_map_borrow_entry_value_const(map, "timer-us");
1316 if (!v) {
1317 BT_LOGE_STR("Unexpected empty array \"timer-us\" entry.");
1318 goto error;
1319 }
1320 timer_us = bt_value_signed_integer_get(v);
1321 fprintf(out_stream, " (timer = %" PRIu64 ", ", timer_us);
1322 v = bt_value_map_borrow_entry_value_const(map, "stream-count");
1323 if (!v) {
1324 BT_LOGE_STR("Unexpected empty array \"stream-count\" entry.");
1325 goto error;
1326 }
1327 streams = bt_value_signed_integer_get(v);
1328 fprintf(out_stream, "%" PRIu64 " stream(s), ", streams);
1329 v = bt_value_map_borrow_entry_value_const(map, "client-count");
1330 if (!v) {
1331 BT_LOGE_STR("Unexpected empty array \"client-count\" entry.");
1332 goto error;
1333 }
1334 clients = bt_value_signed_integer_get(v);
1335 fprintf(out_stream, "%" PRIu64 " client(s) connected)\n", clients);
1336 }
1337
1338 goto end;
1339
1340 failed:
1341 BT_LOGE("Failed to query for sessions: %s", fail_reason);
1342 fprintf(stderr, "%s%sFailed to request sessions: %s%s\n",
1343 bt_common_color_bold(),
1344 bt_common_color_fg_red(),
1345 fail_reason,
1346 bt_common_color_reset());
1347
1348 error:
1349 ret = -1;
1350
1351 end:
1352 bt_value_put_ref(results);
1353 bt_value_put_ref(params);
1354 bt_component_class_put_ref(comp_cls);
1355
1356 if (out_stream && out_stream != stdout) {
1357 int fclose_ret = fclose(out_stream);
1358
1359 if (fclose_ret) {
1360 BT_LOGE_ERRNO("Cannot close file stream",
1361 ": path=\"%s\"",
1362 cfg->cmd_data.print_lttng_live_sessions.output_path->str);
1363 }
1364 }
1365
1366 return ret;
1367 }
1368
1369 static
1370 int cmd_print_ctf_metadata(struct bt_config *cfg)
1371 {
1372 int ret = 0;
1373 const bt_component_class *comp_cls = NULL;
1374 const bt_value *results = NULL;
1375 bt_value *params = NULL;
1376 const bt_value *metadata_text_value = NULL;
1377 const char *metadata_text = NULL;
1378 static const char * const plugin_name = "ctf";
1379 static const char * const comp_cls_name = "fs";
1380 static const bt_component_class_type comp_cls_type =
1381 BT_COMPONENT_CLASS_TYPE_SOURCE;
1382 const char *fail_reason = NULL;
1383 FILE *out_stream = stdout;
1384
1385 BT_ASSERT(cfg->cmd_data.print_ctf_metadata.path);
1386 comp_cls = find_component_class(plugin_name, comp_cls_name,
1387 comp_cls_type);
1388 if (!comp_cls) {
1389 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
1390 "comp-cls-name=\"%s\", comp-cls-type=%d",
1391 plugin_name, comp_cls_name,
1392 BT_COMPONENT_CLASS_TYPE_SOURCE);
1393 fprintf(stderr, "%s%sCannot find component class %s",
1394 bt_common_color_bold(),
1395 bt_common_color_fg_red(),
1396 bt_common_color_reset());
1397 print_plugin_comp_cls_opt(stderr, plugin_name,
1398 comp_cls_name, comp_cls_type);
1399 fprintf(stderr, "\n");
1400 ret = -1;
1401 goto end;
1402 }
1403
1404 params = bt_value_map_create();
1405 if (!params) {
1406 ret = -1;
1407 goto end;
1408 }
1409
1410 ret = bt_value_map_insert_string_entry(params, "path",
1411 cfg->cmd_data.print_ctf_metadata.path->str);
1412 if (ret) {
1413 ret = -1;
1414 goto end;
1415 }
1416
1417 ret = query(comp_cls, "metadata-info",
1418 params, &results, &fail_reason);
1419 if (ret) {
1420 goto failed;
1421 }
1422
1423 metadata_text_value = bt_value_map_borrow_entry_value_const(results,
1424 "text");
1425 if (!metadata_text_value) {
1426 BT_LOGE_STR("Cannot find `text` string value in the resulting metadata info object.");
1427 ret = -1;
1428 goto end;
1429 }
1430
1431 metadata_text = bt_value_string_get(metadata_text_value);
1432
1433 if (cfg->cmd_data.print_ctf_metadata.output_path->len > 0) {
1434 out_stream =
1435 fopen(cfg->cmd_data.print_ctf_metadata.output_path->str,
1436 "w");
1437 if (!out_stream) {
1438 ret = -1;
1439 BT_LOGE_ERRNO("Cannot open file for writing",
1440 ": path=\"%s\"",
1441 cfg->cmd_data.print_ctf_metadata.output_path->str);
1442 goto end;
1443 }
1444 }
1445
1446 ret = fprintf(out_stream, "%s\n", metadata_text);
1447 if (ret < 0) {
1448 BT_LOGE("Cannot write whole metadata text to output stream: "
1449 "ret=%d", ret);
1450 goto end;
1451 }
1452
1453 ret = 0;
1454
1455 goto end;
1456
1457 failed:
1458 ret = -1;
1459 BT_LOGE("Failed to query for metadata info: %s", fail_reason);
1460 fprintf(stderr, "%s%sFailed to request metadata info: %s%s\n",
1461 bt_common_color_bold(),
1462 bt_common_color_fg_red(),
1463 fail_reason,
1464 bt_common_color_reset());
1465
1466 end:
1467 bt_value_put_ref(results);
1468 bt_value_put_ref(params);
1469 bt_component_class_put_ref(comp_cls);
1470
1471 if (out_stream && out_stream != stdout) {
1472 int fclose_ret = fclose(out_stream);
1473
1474 if (fclose_ret) {
1475 BT_LOGE_ERRNO("Cannot close file stream",
1476 ": path=\"%s\"",
1477 cfg->cmd_data.print_ctf_metadata.output_path->str);
1478 }
1479 }
1480
1481 return ret;
1482 }
1483
1484 struct port_id {
1485 char *instance_name;
1486 char *port_name;
1487 };
1488
1489 struct trace_range {
1490 uint64_t intersection_range_begin_ns;
1491 uint64_t intersection_range_end_ns;
1492 };
1493
1494 static
1495 guint port_id_hash(gconstpointer v)
1496 {
1497 const struct port_id *id = v;
1498
1499 BT_ASSERT(id->instance_name);
1500 BT_ASSERT(id->port_name);
1501
1502 return g_str_hash(id->instance_name) ^ g_str_hash(id->port_name);
1503 }
1504
1505 static
1506 gboolean port_id_equal(gconstpointer v1, gconstpointer v2)
1507 {
1508 const struct port_id *id1 = v1;
1509 const struct port_id *id2 = v2;
1510
1511 return !strcmp(id1->instance_name, id2->instance_name) &&
1512 !strcmp(id1->port_name, id2->port_name);
1513 }
1514
1515 static
1516 void port_id_destroy(gpointer data)
1517 {
1518 struct port_id *id = data;
1519
1520 free(id->instance_name);
1521 free(id->port_name);
1522 free(id);
1523 }
1524
1525 static
1526 void trace_range_destroy(gpointer data)
1527 {
1528 free(data);
1529 }
1530
1531 struct cmd_run_ctx {
1532 /* Owned by this */
1533 GHashTable *src_components;
1534
1535 /* Owned by this */
1536 GHashTable *flt_components;
1537
1538 /* Owned by this */
1539 GHashTable *sink_components;
1540
1541 /* Owned by this */
1542 bt_graph *graph;
1543
1544 /* Weak */
1545 struct bt_config *cfg;
1546
1547 bool connect_ports;
1548
1549 bool stream_intersection_mode;
1550
1551 /*
1552 * Association of struct port_id -> struct trace_range.
1553 */
1554 GHashTable *intersections;
1555 };
1556
1557 /* Returns a timestamp of the form "(-)s.ns" */
1558 static
1559 char *s_from_ns(int64_t ns)
1560 {
1561 int ret;
1562 char *s_ret = NULL;
1563 bool is_negative;
1564 int64_t ts_sec_abs, ts_nsec_abs;
1565 int64_t ts_sec = ns / NSEC_PER_SEC;
1566 int64_t ts_nsec = ns % NSEC_PER_SEC;
1567
1568 if (ts_sec >= 0 && ts_nsec >= 0) {
1569 is_negative = false;
1570 ts_sec_abs = ts_sec;
1571 ts_nsec_abs = ts_nsec;
1572 } else if (ts_sec > 0 && ts_nsec < 0) {
1573 is_negative = false;
1574 ts_sec_abs = ts_sec - 1;
1575 ts_nsec_abs = NSEC_PER_SEC + ts_nsec;
1576 } else if (ts_sec == 0 && ts_nsec < 0) {
1577 is_negative = true;
1578 ts_sec_abs = ts_sec;
1579 ts_nsec_abs = -ts_nsec;
1580 } else if (ts_sec < 0 && ts_nsec > 0) {
1581 is_negative = true;
1582 ts_sec_abs = -(ts_sec + 1);
1583 ts_nsec_abs = NSEC_PER_SEC - ts_nsec;
1584 } else if (ts_sec < 0 && ts_nsec == 0) {
1585 is_negative = true;
1586 ts_sec_abs = -ts_sec;
1587 ts_nsec_abs = ts_nsec;
1588 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1589 is_negative = true;
1590 ts_sec_abs = -ts_sec;
1591 ts_nsec_abs = -ts_nsec;
1592 }
1593
1594 ret = asprintf(&s_ret, "%s%" PRId64 ".%09" PRId64,
1595 is_negative ? "-" : "", ts_sec_abs, ts_nsec_abs);
1596 if (ret < 0) {
1597 s_ret = NULL;
1598 }
1599 return s_ret;
1600 }
1601
1602 static
1603 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1604 struct cmd_run_ctx *ctx,
1605 const bt_component *upstream_comp,
1606 const bt_port_output *out_upstream_port,
1607 struct bt_config_connection *cfg_conn)
1608 {
1609 typedef uint64_t (*input_port_count_func_t)(void *);
1610 typedef const bt_port_input *(*borrow_input_port_by_index_func_t)(
1611 const void *, uint64_t);
1612 const bt_port *upstream_port =
1613 bt_port_output_as_port_const(out_upstream_port);
1614
1615 int ret = 0;
1616 GQuark downstreamp_comp_name_quark;
1617 void *downstream_comp;
1618 uint64_t downstream_port_count;
1619 uint64_t i;
1620 input_port_count_func_t port_count_fn;
1621 borrow_input_port_by_index_func_t port_by_index_fn;
1622 bt_graph_status status = BT_GRAPH_STATUS_ERROR;
1623 bool insert_trimmer = false;
1624 bt_value *trimmer_params = NULL;
1625 char *intersection_begin = NULL;
1626 char *intersection_end = NULL;
1627 const bt_component_filter *trimmer = NULL;
1628 const bt_component_class_filter *trimmer_class = NULL;
1629 const bt_port_input *trimmer_input = NULL;
1630 const bt_port_output *trimmer_output = NULL;
1631
1632 if (ctx->intersections &&
1633 bt_component_get_class_type(upstream_comp) ==
1634 BT_COMPONENT_CLASS_TYPE_SOURCE) {
1635 struct trace_range *range;
1636 struct port_id port_id = {
1637 .instance_name = (char *) bt_component_get_name(upstream_comp),
1638 .port_name = (char *) bt_port_get_name(upstream_port)
1639 };
1640
1641 if (!port_id.instance_name || !port_id.port_name) {
1642 goto error;
1643 }
1644
1645 range = (struct trace_range *) g_hash_table_lookup(
1646 ctx->intersections, &port_id);
1647 if (range) {
1648 bt_value_status status;
1649
1650 intersection_begin = s_from_ns(
1651 range->intersection_range_begin_ns);
1652 intersection_end = s_from_ns(
1653 range->intersection_range_end_ns);
1654 if (!intersection_begin || !intersection_end) {
1655 BT_LOGE_STR("Cannot create trimmer argument timestamp string.");
1656 goto error;
1657 }
1658
1659 insert_trimmer = true;
1660 trimmer_params = bt_value_map_create();
1661 if (!trimmer_params) {
1662 goto error;
1663 }
1664
1665 status = bt_value_map_insert_string_entry(
1666 trimmer_params, "begin", intersection_begin);
1667 if (status != BT_VALUE_STATUS_OK) {
1668 goto error;
1669 }
1670 status = bt_value_map_insert_string_entry(
1671 trimmer_params,
1672 "end", intersection_end);
1673 if (status != BT_VALUE_STATUS_OK) {
1674 goto error;
1675 }
1676 }
1677
1678 trimmer_class = find_filter_component_class("utils", "trimmer");
1679 if (!trimmer_class) {
1680 goto error;
1681 }
1682 }
1683
1684 BT_LOGI("Connecting upstream port to the next available downstream port: "
1685 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1686 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1687 upstream_port, bt_port_get_name(upstream_port),
1688 cfg_conn->downstream_comp_name->str,
1689 cfg_conn->arg->str);
1690 downstreamp_comp_name_quark = g_quark_from_string(
1691 cfg_conn->downstream_comp_name->str);
1692 BT_ASSERT(downstreamp_comp_name_quark > 0);
1693 downstream_comp = g_hash_table_lookup(ctx->flt_components,
1694 GUINT_TO_POINTER(downstreamp_comp_name_quark));
1695 port_count_fn = (input_port_count_func_t)
1696 bt_component_filter_get_input_port_count;
1697 port_by_index_fn = (borrow_input_port_by_index_func_t)
1698 bt_component_filter_borrow_input_port_by_index_const;
1699
1700 if (!downstream_comp) {
1701 downstream_comp = g_hash_table_lookup(ctx->sink_components,
1702 GUINT_TO_POINTER(downstreamp_comp_name_quark));
1703 port_count_fn = (input_port_count_func_t)
1704 bt_component_sink_get_input_port_count;
1705 port_by_index_fn = (borrow_input_port_by_index_func_t)
1706 bt_component_sink_borrow_input_port_by_index_const;
1707 }
1708
1709 if (!downstream_comp) {
1710 BT_LOGE("Cannot find downstream component: comp-name=\"%s\", "
1711 "conn-arg=\"%s\"", cfg_conn->downstream_comp_name->str,
1712 cfg_conn->arg->str);
1713 fprintf(stderr, "Cannot create connection: cannot find downstream component: %s\n",
1714 cfg_conn->arg->str);
1715 goto error;
1716 }
1717
1718 downstream_port_count = port_count_fn(downstream_comp);
1719
1720 for (i = 0; i < downstream_port_count; i++) {
1721 const bt_port_input *in_downstream_port =
1722 port_by_index_fn(downstream_comp, i);
1723 const bt_port *downstream_port =
1724 bt_port_input_as_port_const(in_downstream_port);
1725 const char *upstream_port_name;
1726 const char *downstream_port_name;
1727
1728 BT_ASSERT(downstream_port);
1729
1730 /* Skip port if it's already connected. */
1731 if (bt_port_is_connected(downstream_port)) {
1732 BT_LOGI("Skipping downstream port: already connected: "
1733 "port-addr=%p, port-name=\"%s\"",
1734 downstream_port,
1735 bt_port_get_name(downstream_port));
1736 continue;
1737 }
1738
1739 downstream_port_name = bt_port_get_name(downstream_port);
1740 BT_ASSERT(downstream_port_name);
1741 upstream_port_name = bt_port_get_name(upstream_port);
1742 BT_ASSERT(upstream_port_name);
1743
1744 if (!bt_common_star_glob_match(
1745 cfg_conn->downstream_port_glob->str, SIZE_MAX,
1746 downstream_port_name, SIZE_MAX)) {
1747 continue;
1748 }
1749
1750 if (insert_trimmer) {
1751 /*
1752 * In order to insert the trimmer between the
1753 * two components that were being connected, we
1754 * create a connection configuration entry which
1755 * describes a connection from the trimmer's
1756 * output to the original input that was being
1757 * connected.
1758 *
1759 * Hence, the creation of the trimmer will cause
1760 * the graph "new port" listener to establish
1761 * all downstream connections as its output port
1762 * is connected. We will then establish the
1763 * connection between the original upstream
1764 * source and the trimmer.
1765 */
1766 char *trimmer_name = NULL;
1767 bt_graph_status graph_status;
1768
1769 ret = asprintf(&trimmer_name,
1770 "stream-intersection-trimmer-%s",
1771 upstream_port_name);
1772 if (ret < 0) {
1773 goto error;
1774 }
1775 ret = 0;
1776
1777 ctx->connect_ports = false;
1778 graph_status = bt_graph_add_filter_component(
1779 ctx->graph, trimmer_class, trimmer_name,
1780 trimmer_params, ctx->cfg->log_level,
1781 &trimmer);
1782 free(trimmer_name);
1783 if (graph_status != BT_GRAPH_STATUS_OK) {
1784 goto error;
1785 }
1786 BT_ASSERT(trimmer);
1787
1788 trimmer_input =
1789 bt_component_filter_borrow_input_port_by_index_const(
1790 trimmer, 0);
1791 if (!trimmer_input) {
1792 goto error;
1793 }
1794 trimmer_output =
1795 bt_component_filter_borrow_output_port_by_index_const(
1796 trimmer, 0);
1797 if (!trimmer_output) {
1798 goto error;
1799 }
1800
1801 /*
1802 * Replace the current downstream port by the trimmer's
1803 * upstream port.
1804 */
1805 in_downstream_port = trimmer_input;
1806 downstream_port =
1807 bt_port_input_as_port_const(in_downstream_port);
1808 downstream_port_name = bt_port_get_name(
1809 downstream_port);
1810 BT_ASSERT(downstream_port_name);
1811 }
1812
1813 /* We have a winner! */
1814 status = bt_graph_connect_ports(ctx->graph,
1815 out_upstream_port, in_downstream_port, NULL);
1816 downstream_port = NULL;
1817 switch (status) {
1818 case BT_GRAPH_STATUS_OK:
1819 break;
1820 case BT_GRAPH_STATUS_CANCELED:
1821 BT_LOGI_STR("Graph was canceled by user.");
1822 status = BT_GRAPH_STATUS_OK;
1823 break;
1824 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
1825 BT_LOGE("A component refused a connection to one of its ports: "
1826 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1827 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1828 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1829 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1830 "conn-arg=\"%s\"",
1831 upstream_comp, bt_component_get_name(upstream_comp),
1832 upstream_port, bt_port_get_name(upstream_port),
1833 downstream_comp, cfg_conn->downstream_comp_name->str,
1834 downstream_port, downstream_port_name,
1835 cfg_conn->arg->str);
1836 fprintf(stderr,
1837 "A component refused a connection to one of its ports (`%s` to `%s`): %s\n",
1838 bt_port_get_name(upstream_port),
1839 downstream_port_name,
1840 cfg_conn->arg->str);
1841 break;
1842 default:
1843 BT_LOGE("Cannot create connection: graph refuses to connect ports: "
1844 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1845 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1846 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1847 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1848 "conn-arg=\"%s\"",
1849 upstream_comp, bt_component_get_name(upstream_comp),
1850 upstream_port, bt_port_get_name(upstream_port),
1851 downstream_comp, cfg_conn->downstream_comp_name->str,
1852 downstream_port, downstream_port_name,
1853 cfg_conn->arg->str);
1854 fprintf(stderr,
1855 "Cannot create connection: graph refuses to connect ports (`%s` to `%s`): %s\n",
1856 bt_port_get_name(upstream_port),
1857 downstream_port_name,
1858 cfg_conn->arg->str);
1859 goto error;
1860 }
1861
1862 BT_LOGI("Connected component ports: "
1863 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1864 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1865 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1866 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1867 "conn-arg=\"%s\"",
1868 upstream_comp, bt_component_get_name(upstream_comp),
1869 upstream_port, bt_port_get_name(upstream_port),
1870 downstream_comp, cfg_conn->downstream_comp_name->str,
1871 downstream_port, downstream_port_name,
1872 cfg_conn->arg->str);
1873
1874 if (insert_trimmer) {
1875 /*
1876 * The first connection, from the source to the trimmer,
1877 * has been done. We now connect the trimmer to the
1878 * original downstream port.
1879 */
1880 ret = cmd_run_ctx_connect_upstream_port_to_downstream_component(
1881 ctx,
1882 bt_component_filter_as_component_const(trimmer),
1883 trimmer_output, cfg_conn);
1884 if (ret) {
1885 goto error;
1886 }
1887 ctx->connect_ports = true;
1888 }
1889
1890 /*
1891 * We found a matching downstream port: the search is
1892 * over.
1893 */
1894 goto end;
1895 }
1896
1897 /* No downstream port found */
1898 BT_LOGE("Cannot create connection: cannot find a matching downstream port for upstream port: "
1899 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1900 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1901 upstream_port, bt_port_get_name(upstream_port),
1902 cfg_conn->downstream_comp_name->str,
1903 cfg_conn->arg->str);
1904 fprintf(stderr,
1905 "Cannot create connection: cannot find a matching downstream port for upstream port `%s`: %s\n",
1906 bt_port_get_name(upstream_port), cfg_conn->arg->str);
1907
1908 error:
1909 ret = -1;
1910
1911 end:
1912 free(intersection_begin);
1913 free(intersection_end);
1914 BT_VALUE_PUT_REF_AND_RESET(trimmer_params);
1915 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class);
1916 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer);
1917 return ret;
1918 }
1919
1920 static
1921 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx *ctx,
1922 const bt_port_output *upstream_port)
1923 {
1924 int ret = 0;
1925 const char *upstream_port_name;
1926 const char *upstream_comp_name;
1927 const bt_component *upstream_comp = NULL;
1928 size_t i;
1929
1930 BT_ASSERT(ctx);
1931 BT_ASSERT(upstream_port);
1932 upstream_port_name = bt_port_get_name(
1933 bt_port_output_as_port_const(upstream_port));
1934 BT_ASSERT(upstream_port_name);
1935 upstream_comp = bt_port_borrow_component_const(
1936 bt_port_output_as_port_const(upstream_port));
1937 if (!upstream_comp) {
1938 BT_LOGW("Upstream port to connect is not part of a component: "
1939 "port-addr=%p, port-name=\"%s\"",
1940 upstream_port, upstream_port_name);
1941 ret = -1;
1942 goto end;
1943 }
1944
1945 upstream_comp_name = bt_component_get_name(upstream_comp);
1946 BT_ASSERT(upstream_comp_name);
1947 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1948 "port-addr=%p, port-name=\"%s\"",
1949 upstream_comp, upstream_comp_name,
1950 upstream_port, upstream_port_name);
1951
1952 for (i = 0; i < ctx->cfg->cmd_data.run.connections->len; i++) {
1953 struct bt_config_connection *cfg_conn =
1954 g_ptr_array_index(
1955 ctx->cfg->cmd_data.run.connections, i);
1956
1957 if (strcmp(cfg_conn->upstream_comp_name->str,
1958 upstream_comp_name)) {
1959 continue;
1960 }
1961
1962 if (!bt_common_star_glob_match(
1963 cfg_conn->upstream_port_glob->str,
1964 SIZE_MAX, upstream_port_name, SIZE_MAX)) {
1965 continue;
1966 }
1967
1968 ret = cmd_run_ctx_connect_upstream_port_to_downstream_component(
1969 ctx, upstream_comp, upstream_port, cfg_conn);
1970 if (ret) {
1971 BT_LOGE("Cannot connect upstream port: "
1972 "port-addr=%p, port-name=\"%s\"",
1973 upstream_port,
1974 upstream_port_name);
1975 fprintf(stderr,
1976 "Cannot connect port `%s` of component `%s` to a downstream port: %s\n",
1977 upstream_port_name,
1978 upstream_comp_name,
1979 cfg_conn->arg->str);
1980 goto error;
1981 }
1982 goto end;
1983 }
1984
1985 BT_LOGE("Cannot connect upstream port: port does not match any connection argument: "
1986 "port-addr=%p, port-name=\"%s\"", upstream_port,
1987 upstream_port_name);
1988 fprintf(stderr,
1989 "Cannot create connection: upstream port `%s` does not match any connection\n",
1990 upstream_port_name);
1991
1992 error:
1993 ret = -1;
1994
1995 end:
1996 return ret;
1997 }
1998
1999 static
2000 bt_graph_listener_status
2001 graph_output_port_added_listener(struct cmd_run_ctx *ctx,
2002 const bt_port_output *out_port)
2003 {
2004 const bt_component *comp;
2005 const bt_port *port = bt_port_output_as_port_const(out_port);
2006 bt_graph_listener_status ret = BT_GRAPH_LISTENER_STATUS_OK;
2007
2008 comp = bt_port_borrow_component_const(port);
2009 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
2010 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2011 comp, comp ? bt_component_get_name(comp) : "",
2012 port, bt_port_get_name(port));
2013
2014 if (!ctx->connect_ports) {
2015 goto end;
2016 }
2017
2018 if (!comp) {
2019 BT_LOGW_STR("Port has no component.");
2020 goto end;
2021 }
2022
2023 if (bt_port_is_connected(port)) {
2024 BT_LOGW_STR("Port is already connected.");
2025 goto end;
2026 }
2027
2028 if (cmd_run_ctx_connect_upstream_port(ctx, out_port)) {
2029 BT_LOGF_STR("Cannot connect upstream port.");
2030 fprintf(stderr, "Added port could not be connected: aborting\n");
2031 ret = BT_GRAPH_LISTENER_STATUS_ERROR;
2032 goto end;
2033 }
2034
2035 end:
2036 return ret;
2037 }
2038
2039 static
2040 bt_graph_listener_status graph_source_output_port_added_listener(
2041 const bt_component_source *component,
2042 const bt_port_output *port, void *data)
2043 {
2044 return graph_output_port_added_listener(data, port);
2045 }
2046
2047 static
2048 bt_graph_listener_status graph_filter_output_port_added_listener(
2049 const bt_component_filter *component,
2050 const bt_port_output *port, void *data)
2051 {
2052 return graph_output_port_added_listener(data, port);
2053 }
2054
2055 static
2056 void cmd_run_ctx_destroy(struct cmd_run_ctx *ctx)
2057 {
2058 if (!ctx) {
2059 return;
2060 }
2061
2062 if (ctx->src_components) {
2063 g_hash_table_destroy(ctx->src_components);
2064 ctx->src_components = NULL;
2065 }
2066
2067 if (ctx->flt_components) {
2068 g_hash_table_destroy(ctx->flt_components);
2069 ctx->flt_components = NULL;
2070 }
2071
2072 if (ctx->sink_components) {
2073 g_hash_table_destroy(ctx->sink_components);
2074 ctx->sink_components = NULL;
2075 }
2076
2077 if (ctx->intersections) {
2078 g_hash_table_destroy(ctx->intersections);
2079 ctx->intersections = NULL;
2080 }
2081
2082 BT_GRAPH_PUT_REF_AND_RESET(ctx->graph);
2083 the_graph = NULL;
2084 ctx->cfg = NULL;
2085 }
2086
2087 static
2088 int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg)
2089 {
2090 int ret = 0;
2091 bt_graph_status status;
2092
2093 ctx->cfg = cfg;
2094 ctx->connect_ports = false;
2095 ctx->src_components = g_hash_table_new_full(g_direct_hash,
2096 g_direct_equal, NULL, (GDestroyNotify) bt_object_put_ref);
2097 if (!ctx->src_components) {
2098 goto error;
2099 }
2100
2101 ctx->flt_components = g_hash_table_new_full(g_direct_hash,
2102 g_direct_equal, NULL, (GDestroyNotify) bt_object_put_ref);
2103 if (!ctx->flt_components) {
2104 goto error;
2105 }
2106
2107 ctx->sink_components = g_hash_table_new_full(g_direct_hash,
2108 g_direct_equal, NULL, (GDestroyNotify) bt_object_put_ref);
2109 if (!ctx->sink_components) {
2110 goto error;
2111 }
2112
2113 if (cfg->cmd_data.run.stream_intersection_mode) {
2114 ctx->stream_intersection_mode = true;
2115 ctx->intersections = g_hash_table_new_full(port_id_hash,
2116 port_id_equal, port_id_destroy, trace_range_destroy);
2117 if (!ctx->intersections) {
2118 goto error;
2119 }
2120 }
2121
2122 ctx->graph = bt_graph_create();
2123 if (!ctx->graph) {
2124 goto error;
2125 }
2126
2127 the_graph = ctx->graph;
2128 status = bt_graph_add_source_component_output_port_added_listener(
2129 ctx->graph, graph_source_output_port_added_listener, NULL, ctx,
2130 NULL);
2131 if (status != BT_GRAPH_STATUS_OK) {
2132 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2133 goto error;
2134 }
2135
2136 status = bt_graph_add_filter_component_output_port_added_listener(
2137 ctx->graph, graph_filter_output_port_added_listener, NULL, ctx,
2138 NULL);
2139 if (status != BT_GRAPH_STATUS_OK) {
2140 BT_LOGE_STR("Cannot add \"port added\" listener to graph.");
2141 goto error;
2142 }
2143
2144 goto end;
2145
2146 error:
2147 cmd_run_ctx_destroy(ctx);
2148 ret = -1;
2149
2150 end:
2151 return ret;
2152 }
2153
2154 static
2155 int set_stream_intersections(struct cmd_run_ctx *ctx,
2156 struct bt_config_component *cfg_comp,
2157 const bt_component_class_source *src_comp_cls)
2158 {
2159 int ret = 0;
2160 uint64_t trace_idx;
2161 int64_t trace_count;
2162 const char *path = NULL;
2163 const bt_value *query_result = NULL;
2164 const bt_value *trace_info = NULL;
2165 const bt_value *intersection_range = NULL;
2166 const bt_value *intersection_begin = NULL;
2167 const bt_value *intersection_end = NULL;
2168 const bt_value *stream_infos = NULL;
2169 const bt_value *stream_info = NULL;
2170 struct port_id *port_id = NULL;
2171 struct trace_range *trace_range = NULL;
2172 const char *fail_reason = NULL;
2173 const bt_component_class *comp_cls =
2174 bt_component_class_source_as_component_class_const(src_comp_cls);
2175
2176 ret = query(comp_cls, "trace-info",
2177 cfg_comp->params, &query_result,
2178 &fail_reason);
2179 if (ret) {
2180 BT_LOGD("Component class does not support the `trace-info` query: %s: "
2181 "comp-class-name=\"%s\"", fail_reason,
2182 bt_component_class_get_name(comp_cls));
2183 ret = -1;
2184 goto error;
2185 }
2186
2187 BT_ASSERT(query_result);
2188
2189 if (!bt_value_is_array(query_result)) {
2190 BT_LOGD("Unexpected format of \'trace-info\' query result: "
2191 "component-class-name=%s",
2192 bt_component_class_get_name(comp_cls));
2193 ret = -1;
2194 goto error;
2195 }
2196
2197 trace_count = bt_value_array_get_size(query_result);
2198 if (trace_count < 0) {
2199 ret = -1;
2200 goto error;
2201 }
2202
2203 for (trace_idx = 0; trace_idx < trace_count; trace_idx++) {
2204 int64_t begin, end;
2205 uint64_t stream_idx;
2206 int64_t stream_count;
2207
2208 trace_info = bt_value_array_borrow_element_by_index_const(
2209 query_result, trace_idx);
2210 if (!trace_info || !bt_value_is_map(trace_info)) {
2211 ret = -1;
2212 BT_LOGD_STR("Cannot retrieve trace from query result.");
2213 goto error;
2214 }
2215
2216 intersection_range = bt_value_map_borrow_entry_value_const(
2217 trace_info, "intersection-range-ns");
2218 if (!intersection_range) {
2219 ret = -1;
2220 BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
2221 goto error;
2222 }
2223
2224 intersection_begin = bt_value_map_borrow_entry_value_const(intersection_range,
2225 "begin");
2226 if (!intersection_begin) {
2227 ret = -1;
2228 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
2229 goto error;
2230 }
2231
2232 intersection_end = bt_value_map_borrow_entry_value_const(intersection_range,
2233 "end");
2234 if (!intersection_end) {
2235 ret = -1;
2236 BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
2237 goto error;
2238 }
2239
2240 begin = bt_value_signed_integer_get(intersection_begin);
2241 end = bt_value_signed_integer_get(intersection_end);
2242
2243 if (begin < 0 || end < 0 || end < begin) {
2244 BT_LOGW("Invalid trace stream intersection values: "
2245 "intersection-range-ns:begin=%" PRId64
2246 ", intersection-range-ns:end=%" PRId64,
2247 begin, end);
2248 ret = -1;
2249 goto error;
2250 }
2251
2252 stream_infos = bt_value_map_borrow_entry_value_const(trace_info,
2253 "streams");
2254 if (!stream_infos || !bt_value_is_array(stream_infos)) {
2255 ret = -1;
2256 BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
2257 goto error;
2258 }
2259
2260 stream_count = bt_value_array_get_size(stream_infos);
2261 if (stream_count < 0) {
2262 ret = -1;
2263 goto error;
2264 }
2265
2266 for (stream_idx = 0; stream_idx < stream_count; stream_idx++) {
2267 const bt_value *port_name;
2268
2269 port_id = g_new0(struct port_id, 1);
2270 if (!port_id) {
2271 ret = -1;
2272 BT_LOGE_STR("Cannot allocate memory for port_id structure.");
2273 goto error;
2274 }
2275 port_id->instance_name = strdup(cfg_comp->instance_name->str);
2276 if (!port_id->instance_name) {
2277 ret = -1;
2278 BT_LOGE_STR("Cannot allocate memory for port_id component instance name.");
2279 goto error;
2280 }
2281
2282 trace_range = g_new0(struct trace_range, 1);
2283 if (!trace_range) {
2284 ret = -1;
2285 BT_LOGE_STR("Cannot allocate memory for trace_range structure.");
2286 goto error;
2287 }
2288 trace_range->intersection_range_begin_ns = begin;
2289 trace_range->intersection_range_end_ns = end;
2290
2291 stream_info = bt_value_array_borrow_element_by_index_const(
2292 stream_infos, stream_idx);
2293 if (!stream_info || !bt_value_is_map(stream_info)) {
2294 ret = -1;
2295 BT_LOGE_STR("Cannot retrieve stream informations from trace in query result.");
2296 goto error;
2297 }
2298
2299 port_name = bt_value_map_borrow_entry_value_const(stream_info, "port-name");
2300 if (!port_name || !bt_value_is_string(port_name)) {
2301 ret = -1;
2302 BT_LOGE_STR("Cannot retrieve port name in query result.");
2303 goto error;
2304 }
2305
2306 port_id->port_name = g_strdup(bt_value_string_get(port_name));
2307 if (!port_id->port_name) {
2308 ret = -1;
2309 BT_LOGE_STR("Cannot allocate memory for port_id port_name.");
2310 goto error;
2311 }
2312
2313 BT_LOGD("Inserting stream intersection ");
2314
2315 g_hash_table_insert(ctx->intersections, port_id, trace_range);
2316
2317 port_id = NULL;
2318 trace_range = NULL;
2319 }
2320 }
2321
2322 goto end;
2323
2324 error:
2325 fprintf(stderr, "%s%sCannot determine stream intersection of trace at path \'%s\'.%s\n",
2326 bt_common_color_bold(),
2327 bt_common_color_fg_yellow(),
2328 path ? path : "(unknown)",
2329 bt_common_color_reset());
2330 end:
2331 bt_value_put_ref(query_result);
2332 g_free(port_id);
2333 g_free(trace_range);
2334 return ret;
2335 }
2336
2337 static
2338 int cmd_run_ctx_create_components_from_config_components(
2339 struct cmd_run_ctx *ctx, GPtrArray *cfg_components)
2340 {
2341 size_t i;
2342 const void *comp_cls = NULL;
2343 const void *comp = NULL;
2344 int ret = 0;
2345
2346 for (i = 0; i < cfg_components->len; i++) {
2347 struct bt_config_component *cfg_comp =
2348 g_ptr_array_index(cfg_components, i);
2349 GQuark quark;
2350
2351 switch (cfg_comp->type) {
2352 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2353 comp_cls = find_source_component_class(
2354 cfg_comp->plugin_name->str,
2355 cfg_comp->comp_cls_name->str);
2356 break;
2357 case BT_COMPONENT_CLASS_TYPE_FILTER:
2358 comp_cls = find_filter_component_class(
2359 cfg_comp->plugin_name->str,
2360 cfg_comp->comp_cls_name->str);
2361 break;
2362 case BT_COMPONENT_CLASS_TYPE_SINK:
2363 comp_cls = find_sink_component_class(
2364 cfg_comp->plugin_name->str,
2365 cfg_comp->comp_cls_name->str);
2366 break;
2367 default:
2368 abort();
2369 }
2370
2371 if (!comp_cls) {
2372 BT_LOGE("Cannot find component class: plugin-name=\"%s\", "
2373 "comp-cls-name=\"%s\", comp-cls-type=%d",
2374 cfg_comp->plugin_name->str,
2375 cfg_comp->comp_cls_name->str,
2376 cfg_comp->type);
2377 fprintf(stderr, "%s%sCannot find component class %s",
2378 bt_common_color_bold(),
2379 bt_common_color_fg_red(),
2380 bt_common_color_reset());
2381 print_plugin_comp_cls_opt(stderr,
2382 cfg_comp->plugin_name->str,
2383 cfg_comp->comp_cls_name->str,
2384 cfg_comp->type);
2385 fprintf(stderr, "\n");
2386 goto error;
2387 }
2388
2389 BT_ASSERT(cfg_comp->log_level >= BT_LOG_VERBOSE);
2390
2391 switch (cfg_comp->type) {
2392 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2393 ret = bt_graph_add_source_component(ctx->graph,
2394 comp_cls, cfg_comp->instance_name->str,
2395 cfg_comp->params, cfg_comp->log_level,
2396 (void *) &comp);
2397 break;
2398 case BT_COMPONENT_CLASS_TYPE_FILTER:
2399 ret = bt_graph_add_filter_component(ctx->graph,
2400 comp_cls, cfg_comp->instance_name->str,
2401 cfg_comp->params, cfg_comp->log_level,
2402 (void *) &comp);
2403 break;
2404 case BT_COMPONENT_CLASS_TYPE_SINK:
2405 ret = bt_graph_add_sink_component(ctx->graph,
2406 comp_cls, cfg_comp->instance_name->str,
2407 cfg_comp->params, cfg_comp->log_level,
2408 (void *) &comp);
2409 break;
2410 default:
2411 abort();
2412 }
2413
2414 if (ret) {
2415 BT_LOGE("Cannot create component: plugin-name=\"%s\", "
2416 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2417 "comp-name=\"%s\"",
2418 cfg_comp->plugin_name->str,
2419 cfg_comp->comp_cls_name->str,
2420 cfg_comp->type, cfg_comp->instance_name->str);
2421 fprintf(stderr, "%s%sCannot create component `%s`%s\n",
2422 bt_common_color_bold(),
2423 bt_common_color_fg_red(),
2424 cfg_comp->instance_name->str,
2425 bt_common_color_reset());
2426 goto error;
2427 }
2428
2429 if (ctx->stream_intersection_mode &&
2430 cfg_comp->type == BT_COMPONENT_CLASS_TYPE_SOURCE) {
2431 ret = set_stream_intersections(ctx, cfg_comp, comp_cls);
2432 if (ret) {
2433 goto error;
2434 }
2435 }
2436
2437 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2438 comp, cfg_comp->instance_name->str);
2439 quark = g_quark_from_string(cfg_comp->instance_name->str);
2440 BT_ASSERT(quark > 0);
2441
2442 switch (cfg_comp->type) {
2443 case BT_COMPONENT_CLASS_TYPE_SOURCE:
2444 g_hash_table_insert(ctx->src_components,
2445 GUINT_TO_POINTER(quark), (void *) comp);
2446 break;
2447 case BT_COMPONENT_CLASS_TYPE_FILTER:
2448 g_hash_table_insert(ctx->flt_components,
2449 GUINT_TO_POINTER(quark), (void *) comp);
2450 break;
2451 case BT_COMPONENT_CLASS_TYPE_SINK:
2452 g_hash_table_insert(ctx->sink_components,
2453 GUINT_TO_POINTER(quark), (void *) comp);
2454 break;
2455 default:
2456 abort();
2457 }
2458
2459 comp = NULL;
2460 BT_OBJECT_PUT_REF_AND_RESET(comp_cls);
2461 }
2462
2463 goto end;
2464
2465 error:
2466 ret = -1;
2467
2468 end:
2469 bt_object_put_ref(comp);
2470 bt_object_put_ref(comp_cls);
2471 return ret;
2472 }
2473
2474 static
2475 int cmd_run_ctx_create_components(struct cmd_run_ctx *ctx)
2476 {
2477 int ret = 0;
2478
2479 /*
2480 * Make sure that, during this phase, our graph's "port added"
2481 * listener does not connect ports while we are creating the
2482 * components because we have a special, initial phase for
2483 * this.
2484 */
2485 ctx->connect_ports = false;
2486
2487 ret = cmd_run_ctx_create_components_from_config_components(
2488 ctx, ctx->cfg->cmd_data.run.sources);
2489 if (ret) {
2490 ret = -1;
2491 goto end;
2492 }
2493
2494 ret = cmd_run_ctx_create_components_from_config_components(
2495 ctx, ctx->cfg->cmd_data.run.filters);
2496 if (ret) {
2497 ret = -1;
2498 goto end;
2499 }
2500
2501 ret = cmd_run_ctx_create_components_from_config_components(
2502 ctx, ctx->cfg->cmd_data.run.sinks);
2503 if (ret) {
2504 ret = -1;
2505 goto end;
2506 }
2507
2508 end:
2509 return ret;
2510 }
2511
2512 typedef uint64_t (*output_port_count_func_t)(const void *);
2513 typedef const bt_port_output *(*borrow_output_port_by_index_func_t)(
2514 const void *, uint64_t);
2515
2516 static
2517 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx *ctx,
2518 void *comp, output_port_count_func_t port_count_fn,
2519 borrow_output_port_by_index_func_t port_by_index_fn)
2520 {
2521 int ret = 0;
2522 uint64_t count;
2523 uint64_t i;
2524
2525 count = port_count_fn(comp);
2526
2527 for (i = 0; i < count; i++) {
2528 const bt_port_output *upstream_port = port_by_index_fn(comp, i);
2529
2530 BT_ASSERT(upstream_port);
2531 ret = cmd_run_ctx_connect_upstream_port(ctx, upstream_port);
2532 if (ret) {
2533 goto end;
2534 }
2535 }
2536
2537 end:
2538 return ret;
2539 }
2540
2541 static
2542 int cmd_run_ctx_connect_ports(struct cmd_run_ctx *ctx)
2543 {
2544 int ret = 0;
2545 GHashTableIter iter;
2546 gpointer g_name_quark, g_comp;
2547
2548 ctx->connect_ports = true;
2549 g_hash_table_iter_init(&iter, ctx->src_components);
2550
2551 while (g_hash_table_iter_next(&iter, &g_name_quark, &g_comp)) {
2552 ret = cmd_run_ctx_connect_comp_ports(ctx, g_comp,
2553 (output_port_count_func_t)
2554 bt_component_source_get_output_port_count,
2555 (borrow_output_port_by_index_func_t)
2556 bt_component_source_borrow_output_port_by_index_const);
2557 if (ret) {
2558 goto end;
2559 }
2560 }
2561
2562 g_hash_table_iter_init(&iter, ctx->flt_components);
2563
2564 while (g_hash_table_iter_next(&iter, &g_name_quark, &g_comp)) {
2565 ret = cmd_run_ctx_connect_comp_ports(ctx, g_comp,
2566 (output_port_count_func_t)
2567 bt_component_filter_get_output_port_count,
2568 (borrow_output_port_by_index_func_t)
2569 bt_component_filter_borrow_output_port_by_index_const);
2570 if (ret) {
2571 goto end;
2572 }
2573 }
2574
2575 end:
2576 return ret;
2577 }
2578
2579 static inline
2580 const char *bt_graph_status_str(bt_graph_status status)
2581 {
2582 switch (status) {
2583 case BT_GRAPH_STATUS_OK:
2584 return "BT_GRAPH_STATUS_OK";
2585 case BT_GRAPH_STATUS_END:
2586 return "BT_GRAPH_STATUS_END";
2587 case BT_GRAPH_STATUS_AGAIN:
2588 return "BT_GRAPH_STATUS_AGAIN";
2589 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
2590 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
2591 case BT_GRAPH_STATUS_CANCELED:
2592 return "BT_GRAPH_STATUS_CANCELED";
2593 case BT_GRAPH_STATUS_ERROR:
2594 return "BT_GRAPH_STATUS_ERROR";
2595 case BT_GRAPH_STATUS_NOMEM:
2596 return "BT_GRAPH_STATUS_NOMEM";
2597 default:
2598 return "(unknown)";
2599 }
2600 }
2601
2602 static
2603 int cmd_run(struct bt_config *cfg)
2604 {
2605 int ret = 0;
2606 struct cmd_run_ctx ctx = { 0 };
2607
2608 /* Initialize the command's context and the graph object */
2609 if (cmd_run_ctx_init(&ctx, cfg)) {
2610 BT_LOGE_STR("Cannot initialize the command's context.");
2611 fprintf(stderr, "Cannot initialize the command's context\n");
2612 goto error;
2613 }
2614
2615 if (canceled) {
2616 BT_LOGI_STR("Canceled by user before creating components.");
2617 goto error;
2618 }
2619
2620 BT_LOGI_STR("Creating components.");
2621
2622 /* Create the requested component instances */
2623 if (cmd_run_ctx_create_components(&ctx)) {
2624 BT_LOGE_STR("Cannot create components.");
2625 fprintf(stderr, "Cannot create components\n");
2626 goto error;
2627 }
2628
2629 if (canceled) {
2630 BT_LOGI_STR("Canceled by user before connecting components.");
2631 goto error;
2632 }
2633
2634 BT_LOGI_STR("Connecting components.");
2635
2636 /* Connect the initially visible component ports */
2637 if (cmd_run_ctx_connect_ports(&ctx)) {
2638 BT_LOGE_STR("Cannot connect initial component ports.");
2639 fprintf(stderr, "Cannot connect initial component ports\n");
2640 goto error;
2641 }
2642
2643 if (canceled) {
2644 BT_LOGI_STR("Canceled by user before running the graph.");
2645 goto error;
2646 }
2647
2648 BT_LOGI_STR("Running the graph.");
2649
2650 /* Run the graph */
2651 while (true) {
2652 bt_graph_status graph_status = bt_graph_run(ctx.graph);
2653
2654 /*
2655 * Reset console in case something messed with console
2656 * codes during the graph's execution.
2657 */
2658 printf("%s", bt_common_color_reset());
2659 fflush(stdout);
2660 fprintf(stderr, "%s", bt_common_color_reset());
2661 BT_LOGV("bt_graph_run() returned: status=%s",
2662 bt_graph_status_str(graph_status));
2663
2664 switch (graph_status) {
2665 case BT_GRAPH_STATUS_OK:
2666 break;
2667 case BT_GRAPH_STATUS_CANCELED:
2668 BT_LOGI_STR("Graph was canceled by user.");
2669 goto error;
2670 case BT_GRAPH_STATUS_AGAIN:
2671 if (bt_graph_is_canceled(ctx.graph)) {
2672 BT_LOGI_STR("Graph was canceled by user.");
2673 goto error;
2674 }
2675
2676 if (cfg->cmd_data.run.retry_duration_us > 0) {
2677 BT_LOGV("Got BT_GRAPH_STATUS_AGAIN: sleeping: "
2678 "time-us=%" PRIu64,
2679 cfg->cmd_data.run.retry_duration_us);
2680
2681 if (usleep(cfg->cmd_data.run.retry_duration_us)) {
2682 if (bt_graph_is_canceled(ctx.graph)) {
2683 BT_LOGI_STR("Graph was canceled by user.");
2684 goto error;
2685 }
2686 }
2687 }
2688 break;
2689 case BT_GRAPH_STATUS_END:
2690 goto end;
2691 default:
2692 BT_LOGE_STR("Graph failed to complete successfully");
2693 fprintf(stderr, "Graph failed to complete successfully\n");
2694 goto error;
2695 }
2696 }
2697
2698 goto end;
2699
2700 error:
2701 if (ret == 0) {
2702 ret = -1;
2703 }
2704
2705 end:
2706 cmd_run_ctx_destroy(&ctx);
2707 return ret;
2708 }
2709
2710 static
2711 void warn_command_name_and_directory_clash(struct bt_config *cfg)
2712 {
2713 const char *env_clash;
2714
2715 if (!cfg->command_name) {
2716 return;
2717 }
2718
2719 env_clash = getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH);
2720 if (env_clash && strcmp(env_clash, "0") == 0) {
2721 return;
2722 }
2723
2724 if (g_file_test(cfg->command_name,
2725 G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
2726 fprintf(stderr, "\nNOTE: The `%s` command was executed. If you meant to convert a\n",
2727 cfg->command_name);
2728 fprintf(stderr, "trace located in the local `%s` directory, please use:\n",
2729 cfg->command_name);
2730 fprintf(stderr, "\n");
2731 fprintf(stderr, " babeltrace2 convert %s [OPTIONS]\n",
2732 cfg->command_name);
2733 }
2734 }
2735
2736 static
2737 void init_log_level(void)
2738 {
2739 bt_cli_log_level = bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL);
2740 }
2741
2742 static
2743 void set_auto_log_levels(struct bt_config *cfg)
2744 {
2745 const char **env_var_name;
2746
2747 /*
2748 * Override the configuration's default log level if
2749 * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables
2750 * are found for backward compatibility with legacy Babetrace 1.
2751 */
2752 if (getenv("BABELTRACE_DEBUG") &&
2753 strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) {
2754 cfg->log_level = BT_LOG_VERBOSE;
2755 } else if (getenv("BABELTRACE_VERBOSE") &&
2756 strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) {
2757 cfg->log_level = BT_LOG_INFO;
2758 }
2759
2760 /*
2761 * Set log levels according to --debug or --verbose. For
2762 * backward compatibility, --debug is more verbose than
2763 * --verbose. So:
2764 *
2765 * --verbose: INFO log level
2766 * --debug: VERBOSE log level (includes DEBUG, which is
2767 * is less verbose than VERBOSE in the internal
2768 * logging framework)
2769 */
2770 if (!getenv("BABELTRACE_LOGGING_GLOBAL_LEVEL")) {
2771 if (cfg->verbose) {
2772 bt_logging_set_global_level(BT_LOG_INFO);
2773 } else if (cfg->debug) {
2774 bt_logging_set_global_level(BT_LOG_VERBOSE);
2775 } else {
2776 /*
2777 * Set library's default log level if not
2778 * explicitly specified.
2779 */
2780 bt_logging_set_global_level(cfg->log_level);
2781 }
2782 }
2783
2784 if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL)) {
2785 if (cfg->verbose) {
2786 bt_cli_log_level = BT_LOG_INFO;
2787 } else if (cfg->debug) {
2788 bt_cli_log_level = BT_LOG_VERBOSE;
2789 } else {
2790 /*
2791 * Set CLI's default log level if not explicitly
2792 * specified.
2793 */
2794 bt_cli_log_level = cfg->log_level;
2795 }
2796 }
2797
2798 env_var_name = log_level_env_var_names;
2799
2800 while (*env_var_name) {
2801 if (!getenv(*env_var_name)) {
2802 if (cfg->verbose) {
2803 g_setenv(*env_var_name, "I", 1);
2804 } else if (cfg->debug) {
2805 g_setenv(*env_var_name, "V", 1);
2806 } else {
2807 char val[2] = { 0 };
2808
2809 /*
2810 * Set module's default log level if not
2811 * explicitly specified.
2812 */
2813 val[0] = bt_log_get_letter_from_level(
2814 cfg->log_level);
2815 g_setenv(*env_var_name, val, 1);
2816 }
2817 }
2818
2819 env_var_name++;
2820 }
2821 }
2822
2823 int main(int argc, const char **argv)
2824 {
2825 int ret;
2826 int retcode;
2827 struct bt_config *cfg;
2828
2829 init_log_level();
2830 set_signal_handler();
2831 init_static_data();
2832 cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode);
2833
2834 if (retcode < 0) {
2835 /* Quit without errors; typically usage/version */
2836 retcode = 0;
2837 BT_LOGI_STR("Quitting without errors.");
2838 goto end;
2839 }
2840
2841 if (retcode > 0) {
2842 BT_LOGE("Command-line error: retcode=%d", retcode);
2843 goto end;
2844 }
2845
2846 if (!cfg) {
2847 BT_LOGE_STR("Failed to create a valid Babeltrace configuration.");
2848 fprintf(stderr, "Failed to create Babeltrace configuration\n");
2849 retcode = 1;
2850 goto end;
2851 }
2852
2853 set_auto_log_levels(cfg);
2854 print_cfg(cfg);
2855
2856 if (cfg->command_needs_plugins) {
2857 ret = load_all_plugins(cfg->plugin_paths);
2858 if (ret) {
2859 BT_LOGE("Failed to load plugins: ret=%d", ret);
2860 retcode = 1;
2861 goto end;
2862 }
2863 }
2864
2865 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2866 cfg->command, cfg->command_name);
2867
2868 switch (cfg->command) {
2869 case BT_CONFIG_COMMAND_RUN:
2870 ret = cmd_run(cfg);
2871 break;
2872 case BT_CONFIG_COMMAND_LIST_PLUGINS:
2873 ret = cmd_list_plugins(cfg);
2874 break;
2875 case BT_CONFIG_COMMAND_HELP:
2876 ret = cmd_help(cfg);
2877 break;
2878 case BT_CONFIG_COMMAND_QUERY:
2879 ret = cmd_query(cfg);
2880 break;
2881 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA:
2882 ret = cmd_print_ctf_metadata(cfg);
2883 break;
2884 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS:
2885 ret = cmd_print_lttng_live_sessions(cfg);
2886 break;
2887 default:
2888 BT_LOGF("Invalid/unknown command: cmd=%d", cfg->command);
2889 abort();
2890 }
2891
2892 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2893 cfg->command, cfg->command_name, ret);
2894 warn_command_name_and_directory_clash(cfg);
2895 retcode = ret ? 1 : 0;
2896
2897 end:
2898 BT_OBJECT_PUT_REF_AND_RESET(cfg);
2899 fini_static_data();
2900 return retcode;
2901 }
BabelTrace - Trace Format Babel Tower
This page took 0.118918 seconds and 5 git commands to generate.