2 * SPDX-License-Identifier: MIT
4 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 #define BT_LOG_TAG "CLI"
10 #include <babeltrace2/babeltrace.h>
11 #include "common/common.h"
12 #include "string-format/format-error.h"
13 #include "string-format/format-plugin-comp-cls-name.h"
22 #include "babeltrace2-cfg.h"
23 #include "babeltrace2-cfg-cli-args.h"
24 #include "babeltrace2-cfg-cli-args-default.h"
25 #include "babeltrace2-log-level.h"
26 #include "babeltrace2-plugins.h"
27 #include "babeltrace2-query.h"
29 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
30 #define NSEC_PER_SEC 1000000000LL
31 #define EXIT_INTERRUPTED 2
35 BT_CMD_STATUS_ERROR
= -1,
36 BT_CMD_STATUS_INTERRUPTED
= -2,
40 const char *bt_cmd_status_string(enum bt_cmd_status cmd_status
)
43 case BT_CMD_STATUS_OK
:
45 case BT_CMD_STATUS_ERROR
:
47 case BT_CMD_STATUS_INTERRUPTED
:
54 /* Application's interrupter (owned by this) */
55 static bt_interrupter
*the_interrupter
;
62 BOOL WINAPI
signal_handler(DWORD signal
) {
63 if (the_interrupter
) {
64 bt_interrupter_set(the_interrupter
);
71 void set_signal_handler(void)
73 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
74 BT_LOGE("Failed to set the Ctrl+C handler.");
78 #else /* __MINGW32__ */
81 void signal_handler(int signum
)
83 if (signum
!= SIGINT
) {
87 if (the_interrupter
) {
88 bt_interrupter_set(the_interrupter
);
93 void set_signal_handler(void)
95 struct sigaction new_action
, old_action
;
97 new_action
.sa_handler
= signal_handler
;
98 sigemptyset(&new_action
.sa_mask
);
99 new_action
.sa_flags
= 0;
100 sigaction(SIGINT
, NULL
, &old_action
);
102 if (old_action
.sa_handler
!= SIG_IGN
) {
103 sigaction(SIGINT
, &new_action
, NULL
);
107 #endif /* __MINGW32__ */
110 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
111 const char *obj
, const bt_value
*params
,
112 const bt_value
**user_result
, const char **fail_reason
)
114 return cli_query(comp_cls
, obj
, params
, cfg
->log_level
,
115 the_interrupter
, user_result
, fail_reason
);
118 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
119 const bt_plugin
*, const char *);
122 const void *find_component_class_from_plugin(const char *plugin_name
,
123 const char *comp_class_name
,
124 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
126 const void *comp_class
= NULL
;
127 const bt_plugin
*plugin
;
129 BT_LOGI("Finding component class: plugin-name=\"%s\", "
130 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
132 plugin
= borrow_loaded_plugin_by_name(plugin_name
);
137 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
138 bt_object_get_ref(comp_class
);
142 BT_LOGI("Found component class: plugin-name=\"%s\", "
143 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
145 BT_LOGI("Cannot find source component class: "
146 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
147 plugin_name
, comp_class_name
);
154 const bt_component_class_source
*find_source_component_class(
155 const char *plugin_name
, const char *comp_class_name
)
157 return (const void *) find_component_class_from_plugin(
158 plugin_name
, comp_class_name
,
159 (plugin_borrow_comp_cls_func_t
)
160 bt_plugin_borrow_source_component_class_by_name_const
);
164 const bt_component_class_filter
*find_filter_component_class(
165 const char *plugin_name
, const char *comp_class_name
)
167 return (const void *) find_component_class_from_plugin(
168 plugin_name
, comp_class_name
,
169 (plugin_borrow_comp_cls_func_t
)
170 bt_plugin_borrow_filter_component_class_by_name_const
);
174 const bt_component_class_sink
*find_sink_component_class(
175 const char *plugin_name
, const char *comp_class_name
)
177 return (const void *) find_component_class_from_plugin(plugin_name
,
179 (plugin_borrow_comp_cls_func_t
)
180 bt_plugin_borrow_sink_component_class_by_name_const
);
184 const bt_component_class
*find_component_class(const char *plugin_name
,
185 const char *comp_class_name
,
186 bt_component_class_type comp_class_type
)
188 const bt_component_class
*comp_cls
= NULL
;
190 switch (comp_class_type
) {
191 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
192 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
194 case BT_COMPONENT_CLASS_TYPE_FILTER
:
195 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
197 case BT_COMPONENT_CLASS_TYPE_SINK
:
198 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
208 void print_indent(FILE *fp
, size_t indent
)
212 for (i
= 0; i
< indent
; i
++) {
218 void print_value(FILE *, const bt_value
*, size_t);
221 void print_value_rec(FILE *, const bt_value
*, size_t);
224 void print_map_value(const char *key
, const bt_value
*object
, FILE *fp
,
227 print_indent(fp
, indent
);
228 fprintf(fp
, "%s: ", key
);
231 if (bt_value_is_array(object
) &&
232 bt_value_array_is_empty(object
)) {
233 fprintf(fp
, "[ ]\n");
237 if (bt_value_is_map(object
) &&
238 bt_value_map_is_empty(object
)) {
239 fprintf(fp
, "{ }\n");
243 if (bt_value_is_array(object
) ||
244 bt_value_is_map(object
)) {
248 print_value_rec(fp
, object
, indent
+ 2);
255 bt_value_map_foreach_entry_const_func_status
collect_map_keys(
256 const char *key
, const bt_value
*object
, void *data
)
258 GPtrArray
*map_keys
= data
;
260 g_ptr_array_add(map_keys
, (gpointer
*) key
);
262 return BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_OK
;
266 gint
g_ptr_array_sort_strings(gconstpointer a
, gconstpointer b
) {
267 const char *s1
= *((const char **) a
);
268 const char *s2
= *((const char **) b
);
270 return g_strcmp0(s1
, s2
);
274 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
281 GPtrArray
*map_keys
= NULL
;
285 switch (bt_value_get_type(value
)) {
286 case BT_VALUE_TYPE_NULL
:
287 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
288 bt_common_color_reset());
290 case BT_VALUE_TYPE_BOOL
:
291 bool_val
= bt_value_bool_get(value
);
292 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
293 bt_common_color_fg_bright_cyan(), bool_val
? "yes" : "no",
294 bt_common_color_reset());
296 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
297 uint_val
= bt_value_integer_unsigned_get(value
);
298 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
299 bt_common_color_fg_bright_red(), uint_val
,
300 bt_common_color_reset());
302 case BT_VALUE_TYPE_SIGNED_INTEGER
:
303 int_val
= bt_value_integer_signed_get(value
);
304 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
305 bt_common_color_fg_bright_red(), int_val
,
306 bt_common_color_reset());
308 case BT_VALUE_TYPE_REAL
:
309 dbl_val
= bt_value_real_get(value
);
310 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
311 bt_common_color_fg_bright_red(), dbl_val
,
312 bt_common_color_reset());
314 case BT_VALUE_TYPE_STRING
:
315 str_val
= bt_value_string_get(value
);
316 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
317 bt_common_color_fg_bright_green(), str_val
,
318 bt_common_color_reset());
320 case BT_VALUE_TYPE_ARRAY
:
323 size
= bt_value_array_get_length(value
);
325 print_indent(fp
, indent
);
326 fprintf(fp
, "[ ]\n");
330 for (i
= 0; i
< size
; i
++) {
331 const bt_value
*element
=
332 bt_value_array_borrow_element_by_index_const(
335 print_indent(fp
, indent
);
338 if (bt_value_is_array(element
) &&
339 bt_value_array_is_empty(element
)) {
340 fprintf(fp
, "[ ]\n");
344 if (bt_value_is_map(element
) &&
345 bt_value_map_is_empty(element
)) {
346 fprintf(fp
, "{ }\n");
350 if (bt_value_is_array(element
) ||
351 bt_value_is_map(element
)) {
355 print_value_rec(fp
, element
, indent
+ 2);
359 case BT_VALUE_TYPE_MAP
:
362 bt_value_map_foreach_entry_const_status foreach_status
;
364 if (bt_value_map_is_empty(value
)) {
365 print_indent(fp
, indent
);
366 fprintf(fp
, "{ }\n");
370 map_keys
= g_ptr_array_new();
372 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
377 * We want to print the map entries in a stable order. Collect
378 * all the map's keys in a GPtrArray, sort it, then print the
379 * entries in that order.
381 foreach_status
= bt_value_map_foreach_entry_const(value
,
382 collect_map_keys
, map_keys
);
383 if (foreach_status
!= BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
) {
384 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
388 g_ptr_array_sort(map_keys
, g_ptr_array_sort_strings
);
390 for (i
= 0; i
< map_keys
->len
; i
++) {
391 const char *map_key
= g_ptr_array_index(map_keys
, i
);
392 const bt_value
*map_value
;
394 map_value
= bt_value_map_borrow_entry_value_const(value
, map_key
);
395 BT_ASSERT(map_value
);
397 print_map_value(map_key
, map_value
, fp
, indent
);
410 g_ptr_array_free(map_keys
, TRUE
);
415 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
417 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
418 print_indent(fp
, indent
);
421 print_value_rec(fp
, value
, indent
);
425 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
429 comp_cls_str
= format_plugin_comp_cls_opt(
430 bt_config_component
->plugin_name
->str
,
431 bt_config_component
->comp_cls_name
->str
,
432 bt_config_component
->type
,
433 BT_COMMON_COLOR_WHEN_AUTO
);
434 BT_ASSERT(comp_cls_str
);
436 fprintf(stderr
, " %s:\n", comp_cls_str
);
438 if (bt_config_component
->instance_name
->len
> 0) {
439 fprintf(stderr
, " Name: %s\n",
440 bt_config_component
->instance_name
->str
);
443 fprintf(stderr
, " Parameters:\n");
444 print_value(stderr
, bt_config_component
->params
, 8);
446 g_free(comp_cls_str
);
450 void print_bt_config_components(GPtrArray
*array
)
454 for (i
= 0; i
< array
->len
; i
++) {
455 struct bt_config_component
*cfg_component
=
456 bt_config_get_component(array
, i
);
457 print_bt_config_component(cfg_component
);
458 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
463 void print_plugin_paths(const bt_value
*plugin_paths
)
465 fprintf(stderr
, " Plugin paths:\n");
466 print_value(stderr
, plugin_paths
, 4);
470 void print_cfg_run(struct bt_config
*cfg
)
474 print_plugin_paths(cfg
->plugin_paths
);
475 fprintf(stderr
, " Source component instances:\n");
476 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
478 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
479 fprintf(stderr
, " Filter component instances:\n");
480 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
483 fprintf(stderr
, " Sink component instances:\n");
484 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
485 fprintf(stderr
, " Connections:\n");
487 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
488 struct bt_config_connection
*cfg_connection
=
489 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
492 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
493 cfg_connection
->upstream_comp_name
->str
,
494 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
495 cfg_connection
->upstream_port_glob
->str
,
496 cfg_connection
->downstream_comp_name
->str
,
497 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
498 cfg_connection
->downstream_port_glob
->str
);
503 void print_cfg_list_plugins(struct bt_config
*cfg
)
505 print_plugin_paths(cfg
->plugin_paths
);
509 void print_cfg_help(struct bt_config
*cfg
)
511 print_plugin_paths(cfg
->plugin_paths
);
515 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
517 print_plugin_paths(cfg
->plugin_paths
);
518 fprintf(stderr
, " Path: %s\n",
519 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
523 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
525 print_plugin_paths(cfg
->plugin_paths
);
526 fprintf(stderr
, " URL: %s\n",
527 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
531 void print_cfg_query(struct bt_config
*cfg
)
533 print_plugin_paths(cfg
->plugin_paths
);
534 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
535 fprintf(stderr
, " Component class:\n");
536 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
540 void print_cfg(struct bt_config
*cfg
)
542 if (!BT_LOG_ON_INFO
) {
546 BT_LOGI_STR("CLI configuration:");
548 switch (cfg
->command
) {
549 case BT_CONFIG_COMMAND_RUN
:
552 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
553 print_cfg_list_plugins(cfg
);
555 case BT_CONFIG_COMMAND_HELP
:
558 case BT_CONFIG_COMMAND_QUERY
:
559 print_cfg_query(cfg
);
561 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
562 print_cfg_print_ctf_metadata(cfg
);
564 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
565 print_cfg_print_lttng_live_sessions(cfg
);
573 void print_plugin_info(const bt_plugin
*plugin
)
575 unsigned int major
, minor
, patch
;
577 bt_property_availability version_avail
;
578 const char *plugin_name
;
582 const char *plugin_description
;
584 plugin_name
= bt_plugin_get_name(plugin
);
585 path
= bt_plugin_get_path(plugin
);
586 author
= bt_plugin_get_author(plugin
);
587 license
= bt_plugin_get_license(plugin
);
588 plugin_description
= bt_plugin_get_description(plugin
);
589 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
591 printf("%s%s%s%s:\n", bt_common_color_bold(),
592 bt_common_color_fg_bright_blue(), plugin_name
,
593 bt_common_color_reset());
595 printf(" %sPath%s: %s\n", bt_common_color_bold(),
596 bt_common_color_reset(), path
);
601 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
602 printf(" %sVersion%s: %u.%u.%u",
603 bt_common_color_bold(), bt_common_color_reset(),
604 major
, minor
, patch
);
613 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
614 bt_common_color_reset(),
615 plugin_description
? plugin_description
: "(None)");
616 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
617 bt_common_color_reset(), author
? author
: "(Unknown)");
618 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
619 bt_common_color_reset(),
620 license
? license
: "(Unknown)");
624 enum bt_cmd_status
cmd_query(struct bt_config
*cfg
)
627 enum bt_cmd_status cmd_status
;
628 const bt_component_class
*comp_cls
= NULL
;
629 const bt_value
*results
= NULL
;
630 const char *fail_reason
= NULL
;
632 comp_cls
= find_component_class(
633 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
634 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
635 cfg
->cmd_data
.query
.cfg_component
->type
);
637 BT_CLI_LOGE_APPEND_CAUSE(
638 "Cannot find component class: plugin-name=\"%s\", "
639 "comp-cls-name=\"%s\", comp-cls-type=%d",
640 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
641 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
642 cfg
->cmd_data
.query
.cfg_component
->type
);
646 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
647 cfg
->cmd_data
.query
.cfg_component
->params
,
648 &results
, &fail_reason
);
650 BT_CLI_LOGE_APPEND_CAUSE(
651 "Failed to query component class: %s: plugin-name=\"%s\", "
652 "comp-cls-name=\"%s\", comp-cls-type=%d "
653 "object=\"%s\"", fail_reason
,
654 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
655 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
656 cfg
->cmd_data
.query
.cfg_component
->type
,
657 cfg
->cmd_data
.query
.object
->str
);
661 print_value(stdout
, results
, 0);
662 cmd_status
= BT_CMD_STATUS_OK
;
666 cmd_status
= BT_CMD_STATUS_ERROR
;
669 bt_component_class_put_ref(comp_cls
);
670 bt_value_put_ref(results
);
675 void print_component_class_help(const char *plugin_name
,
676 const bt_component_class
*comp_cls
)
678 const char *comp_class_name
=
679 bt_component_class_get_name(comp_cls
);
680 const char *comp_class_description
=
681 bt_component_class_get_description(comp_cls
);
682 const char *comp_class_help
=
683 bt_component_class_get_help(comp_cls
);
684 bt_component_class_type type
=
685 bt_component_class_get_type(comp_cls
);
688 comp_cls_str
= format_plugin_comp_cls_opt(plugin_name
, comp_class_name
,
689 type
, BT_COMMON_COLOR_WHEN_AUTO
);
690 BT_ASSERT(comp_cls_str
);
692 printf("%s\n", comp_cls_str
);
693 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
694 bt_common_color_reset(),
695 comp_class_description
? comp_class_description
: "(None)");
697 if (comp_class_help
) {
698 printf("\n%s\n", comp_class_help
);
701 g_free(comp_cls_str
);
705 enum bt_cmd_status
cmd_help(struct bt_config
*cfg
)
707 enum bt_cmd_status cmd_status
;
708 const bt_plugin
*plugin
= NULL
;
709 const bt_component_class
*needed_comp_cls
= NULL
;
711 plugin
= borrow_loaded_plugin_by_name(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
713 BT_CLI_LOGE_APPEND_CAUSE(
714 "Cannot find plugin: plugin-name=\"%s\"",
715 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
719 print_plugin_info(plugin
);
720 printf(" %sSource component classes%s: %d\n",
721 bt_common_color_bold(),
722 bt_common_color_reset(),
723 (int) bt_plugin_get_source_component_class_count(plugin
));
724 printf(" %sFilter component classes%s: %d\n",
725 bt_common_color_bold(),
726 bt_common_color_reset(),
727 (int) bt_plugin_get_filter_component_class_count(plugin
));
728 printf(" %sSink component classes%s: %d\n",
729 bt_common_color_bold(),
730 bt_common_color_reset(),
731 (int) bt_plugin_get_sink_component_class_count(plugin
));
733 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
734 /* Plugin help only */
735 cmd_status
= BT_CMD_STATUS_OK
;
739 needed_comp_cls
= find_component_class(
740 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
741 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
742 cfg
->cmd_data
.help
.cfg_component
->type
);
743 if (!needed_comp_cls
) {
744 BT_CLI_LOGE_APPEND_CAUSE(
745 "Cannot find component class: plugin-name=\"%s\", "
746 "comp-cls-name=\"%s\", comp-cls-type=%d",
747 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
748 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
749 cfg
->cmd_data
.help
.cfg_component
->type
);
754 print_component_class_help(
755 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
757 cmd_status
= BT_CMD_STATUS_OK
;
761 cmd_status
= BT_CMD_STATUS_ERROR
;
764 bt_component_class_put_ref(needed_comp_cls
);
768 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
770 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
774 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
775 const char *cc_type_name
, uint64_t count
,
776 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
777 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
780 gchar
*comp_cls_str
= NULL
;
783 printf(" %s%s component classes%s: (none)\n",
784 bt_common_color_bold(),
786 bt_common_color_reset());
789 printf(" %s%s component classes%s:\n",
790 bt_common_color_bold(),
792 bt_common_color_reset());
795 for (i
= 0; i
< count
; i
++) {
796 const bt_component_class
*comp_class
=
797 spec_comp_cls_borrow_comp_cls_func(
798 borrow_comp_cls_by_index_func(plugin
, i
));
799 const char *comp_class_name
=
800 bt_component_class_get_name(comp_class
);
801 const char *comp_class_description
=
802 bt_component_class_get_description(comp_class
);
803 bt_component_class_type type
=
804 bt_component_class_get_type(comp_class
);
806 g_free(comp_cls_str
);
807 comp_cls_str
= format_plugin_comp_cls_opt(
808 bt_plugin_get_name(plugin
), comp_class_name
, type
,
809 BT_COMMON_COLOR_WHEN_AUTO
);
810 printf(" %s", comp_cls_str
);
812 if (comp_class_description
) {
813 printf(": %s", comp_class_description
);
820 g_free(comp_cls_str
);
824 enum bt_cmd_status
cmd_list_plugins(struct bt_config
*cfg
)
826 int plugins_count
, component_classes_count
= 0, i
;
828 printf("From the following plugin paths:\n\n");
829 print_value(stdout
, cfg
->plugin_paths
, 2);
831 plugins_count
= get_loaded_plugins_count();
832 if (plugins_count
== 0) {
833 printf("No plugins found.\n");
837 for (i
= 0; i
< plugins_count
; i
++) {
838 const bt_plugin
*plugin
= borrow_loaded_plugin_by_index(i
);
840 component_classes_count
+=
841 bt_plugin_get_source_component_class_count(plugin
) +
842 bt_plugin_get_filter_component_class_count(plugin
) +
843 bt_plugin_get_sink_component_class_count(plugin
);
846 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
847 bt_common_color_bold(),
848 component_classes_count
,
849 bt_common_color_reset(),
850 bt_common_color_bold(),
852 bt_common_color_reset());
854 for (i
= 0; i
< plugins_count
; i
++) {
855 const bt_plugin
*plugin
= borrow_loaded_plugin_by_index(i
);
858 print_plugin_info(plugin
);
859 cmd_list_plugins_print_component_classes(plugin
, "Source",
860 bt_plugin_get_source_component_class_count(plugin
),
861 (plugin_borrow_comp_cls_by_index_func_t
)
862 bt_plugin_borrow_source_component_class_by_index_const
,
863 (spec_comp_cls_borrow_comp_cls_func_t
)
864 bt_component_class_source_as_component_class
);
865 cmd_list_plugins_print_component_classes(plugin
, "Filter",
866 bt_plugin_get_filter_component_class_count(plugin
),
867 (plugin_borrow_comp_cls_by_index_func_t
)
868 bt_plugin_borrow_filter_component_class_by_index_const
,
869 (spec_comp_cls_borrow_comp_cls_func_t
)
870 bt_component_class_filter_as_component_class
);
871 cmd_list_plugins_print_component_classes(plugin
, "Sink",
872 bt_plugin_get_sink_component_class_count(plugin
),
873 (plugin_borrow_comp_cls_by_index_func_t
)
874 bt_plugin_borrow_sink_component_class_by_index_const
,
875 (spec_comp_cls_borrow_comp_cls_func_t
)
876 bt_component_class_sink_as_component_class
);
880 return BT_CMD_STATUS_OK
;
884 enum bt_cmd_status
cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
887 enum bt_cmd_status cmd_status
;
888 const bt_component_class
*comp_cls
= NULL
;
889 const bt_value
*results
= NULL
;
890 bt_value
*params
= NULL
;
891 const bt_value
*map
= NULL
;
892 const bt_value
*v
= NULL
;
893 static const char * const plugin_name
= "ctf";
894 static const char * const comp_cls_name
= "lttng-live";
895 static const bt_component_class_type comp_cls_type
=
896 BT_COMPONENT_CLASS_TYPE_SOURCE
;
897 uint64_t array_size
, i
;
898 const char *fail_reason
= NULL
;
899 FILE *out_stream
= stdout
;
901 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
902 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
905 BT_CLI_LOGE_APPEND_CAUSE(
906 "Cannot find component class: plugin-name=\"%s\", "
907 "comp-cls-name=\"%s\", comp-cls-type=%d",
908 plugin_name
, comp_cls_name
,
909 BT_COMPONENT_CLASS_TYPE_SOURCE
);
913 params
= bt_value_map_create();
918 ret
= bt_value_map_insert_string_entry(params
, "url",
919 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
924 ret
= query(cfg
, comp_cls
, "sessions", params
,
925 &results
, &fail_reason
);
927 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
934 if (!bt_value_is_array(results
)) {
935 BT_CLI_LOGE_APPEND_CAUSE(
936 "Expecting an array for LTTng live `sessions` query.");
940 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
942 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
945 BT_LOGE_ERRNO("Cannot open file for writing",
947 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
948 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
950 "Cannot open file for writing: path=\"%s\"",
951 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
956 array_size
= bt_value_array_get_length(results
);
957 for (i
= 0; i
< array_size
; i
++) {
958 const char *url_text
;
959 int64_t timer_us
, streams
, clients
;
961 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
962 if (!bt_value_is_map(map
)) {
963 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
967 v
= bt_value_map_borrow_entry_value_const(map
, "url");
969 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
972 url_text
= bt_value_string_get(v
);
973 fprintf(out_stream
, "%s", url_text
);
974 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
976 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
979 timer_us
= bt_value_integer_unsigned_get(v
);
980 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
981 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
983 BT_CLI_LOGE_APPEND_CAUSE(
984 "Missing `stream-count` entry.");
987 streams
= bt_value_integer_unsigned_get(v
);
988 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
989 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
991 BT_CLI_LOGE_APPEND_CAUSE(
992 "Missing `client-count` entry.");
995 clients
= bt_value_integer_unsigned_get(v
);
996 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
999 cmd_status
= BT_CMD_STATUS_OK
;
1003 cmd_status
= BT_CMD_STATUS_ERROR
;
1006 bt_value_put_ref(results
);
1007 bt_value_put_ref(params
);
1008 bt_component_class_put_ref(comp_cls
);
1010 if (out_stream
&& out_stream
!= stdout
) {
1011 int fclose_ret
= fclose(out_stream
);
1014 BT_LOGE_ERRNO("Cannot close file stream",
1016 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1024 enum bt_cmd_status
cmd_print_ctf_metadata(struct bt_config
*cfg
)
1027 enum bt_cmd_status cmd_status
;
1028 const bt_component_class
*comp_cls
= NULL
;
1029 const bt_value
*results
= NULL
;
1030 bt_value
*params
= NULL
;
1031 const bt_value
*metadata_text_value
= NULL
;
1032 const char *metadata_text
= NULL
;
1033 static const char * const plugin_name
= "ctf";
1034 static const char * const comp_cls_name
= "fs";
1035 static const bt_component_class_type comp_cls_type
=
1036 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1037 const char *fail_reason
= NULL
;
1038 FILE *out_stream
= stdout
;
1040 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1041 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1044 BT_CLI_LOGE_APPEND_CAUSE(
1045 "Cannot find component class: plugin-name=\"%s\", "
1046 "comp-cls-name=\"%s\", comp-cls-type=%d",
1047 plugin_name
, comp_cls_name
,
1048 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1052 params
= bt_value_map_create();
1057 ret
= bt_value_map_insert_string_entry(params
, "path",
1058 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1063 ret
= query(cfg
, comp_cls
, "metadata-info",
1064 params
, &results
, &fail_reason
);
1066 BT_CLI_LOGE_APPEND_CAUSE(
1067 "Failed to query `metadata-info` object: %s", fail_reason
);
1071 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1073 if (!metadata_text_value
) {
1074 BT_CLI_LOGE_APPEND_CAUSE(
1075 "Cannot find `text` string value in the resulting metadata info object.");
1079 metadata_text
= bt_value_string_get(metadata_text_value
);
1081 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1083 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1086 BT_LOGE_ERRNO("Cannot open file for writing",
1088 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1089 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1091 "Cannot open file for writing: path=\"%s\"",
1092 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1097 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1099 BT_CLI_LOGE_APPEND_CAUSE(
1100 "Cannot write whole metadata text to output stream: "
1105 cmd_status
= BT_CMD_STATUS_OK
;
1109 cmd_status
= BT_CMD_STATUS_ERROR
;
1112 bt_value_put_ref(results
);
1113 bt_value_put_ref(params
);
1114 bt_component_class_put_ref(comp_cls
);
1116 if (out_stream
&& out_stream
!= stdout
) {
1117 int fclose_ret
= fclose(out_stream
);
1120 BT_LOGE_ERRNO("Cannot close file stream",
1122 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1130 char *instance_name
;
1134 struct trace_range
{
1135 uint64_t intersection_range_begin_ns
;
1136 uint64_t intersection_range_end_ns
;
1140 guint
port_id_hash(gconstpointer v
)
1142 const struct port_id
*id
= v
;
1144 BT_ASSERT(id
->instance_name
);
1145 BT_ASSERT(id
->port_name
);
1147 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1151 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1153 const struct port_id
*id1
= v1
;
1154 const struct port_id
*id2
= v2
;
1156 return strcmp(id1
->instance_name
, id2
->instance_name
) == 0 &&
1157 strcmp(id1
->port_name
, id2
->port_name
) == 0;
1161 void port_id_destroy(gpointer data
)
1163 struct port_id
*id
= data
;
1165 free(id
->instance_name
);
1166 free(id
->port_name
);
1171 void trace_range_destroy(gpointer data
)
1176 struct cmd_run_ctx
{
1178 GHashTable
*src_components
;
1181 GHashTable
*flt_components
;
1184 GHashTable
*sink_components
;
1190 struct bt_config
*cfg
;
1194 bool stream_intersection_mode
;
1197 * Association of struct port_id -> struct trace_range.
1199 GHashTable
*intersections
;
1202 /* Returns a timestamp of the form "(-)s.ns" */
1204 char *s_from_ns(int64_t ns
)
1209 int64_t ts_sec_abs
, ts_nsec_abs
;
1210 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1211 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1213 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1214 is_negative
= false;
1215 ts_sec_abs
= ts_sec
;
1216 ts_nsec_abs
= ts_nsec
;
1217 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1218 is_negative
= false;
1219 ts_sec_abs
= ts_sec
- 1;
1220 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1221 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1223 ts_sec_abs
= ts_sec
;
1224 ts_nsec_abs
= -ts_nsec
;
1225 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1227 ts_sec_abs
= -(ts_sec
+ 1);
1228 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1229 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1231 ts_sec_abs
= -ts_sec
;
1232 ts_nsec_abs
= ts_nsec
;
1233 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1235 ts_sec_abs
= -ts_sec
;
1236 ts_nsec_abs
= -ts_nsec
;
1239 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1240 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1248 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1249 struct cmd_run_ctx
*ctx
,
1250 const bt_component
*upstream_comp
,
1251 const bt_port_output
*out_upstream_port
,
1252 struct bt_config_connection
*cfg_conn
)
1254 typedef uint64_t (*input_port_count_func_t
)(void *);
1255 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1256 const void *, uint64_t);
1257 const bt_port
*upstream_port
=
1258 bt_port_output_as_port_const(out_upstream_port
);
1261 GQuark downstreamp_comp_name_quark
;
1262 void *downstream_comp
;
1263 uint64_t downstream_port_count
;
1265 input_port_count_func_t port_count_fn
;
1266 borrow_input_port_by_index_func_t port_by_index_fn
;
1267 bt_graph_connect_ports_status connect_ports_status
=
1268 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1269 bool insert_trimmer
= false;
1270 bt_value
*trimmer_params
= NULL
;
1271 char *intersection_begin
= NULL
;
1272 char *intersection_end
= NULL
;
1273 const bt_component_filter
*trimmer
= NULL
;
1274 const bt_component_class_filter
*trimmer_class
= NULL
;
1275 const bt_port_input
*trimmer_input
= NULL
;
1276 const bt_port_output
*trimmer_output
= NULL
;
1278 if (ctx
->intersections
&&
1279 bt_component_get_class_type(upstream_comp
) ==
1280 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1281 struct trace_range
*range
;
1282 struct port_id port_id
= {
1283 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1284 .port_name
= (char *) bt_port_get_name(upstream_port
)
1287 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1291 range
= (struct trace_range
*) g_hash_table_lookup(
1292 ctx
->intersections
, &port_id
);
1294 bt_value_map_insert_entry_status insert_status
;
1296 intersection_begin
= s_from_ns(
1297 range
->intersection_range_begin_ns
);
1298 intersection_end
= s_from_ns(
1299 range
->intersection_range_end_ns
);
1300 if (!intersection_begin
|| !intersection_end
) {
1301 BT_CLI_LOGE_APPEND_CAUSE(
1302 "Cannot create trimmer argument timestamp string.");
1306 insert_trimmer
= true;
1307 trimmer_params
= bt_value_map_create();
1308 if (!trimmer_params
) {
1312 insert_status
= bt_value_map_insert_string_entry(
1313 trimmer_params
, "begin", intersection_begin
);
1314 if (insert_status
< 0) {
1317 insert_status
= bt_value_map_insert_string_entry(
1319 "end", intersection_end
);
1320 if (insert_status
< 0) {
1325 trimmer_class
= find_filter_component_class("utils", "trimmer");
1326 if (!trimmer_class
) {
1331 BT_LOGI("Connecting upstream port to the next available downstream port: "
1332 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1333 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1334 upstream_port
, bt_port_get_name(upstream_port
),
1335 cfg_conn
->downstream_comp_name
->str
,
1336 cfg_conn
->arg
->str
);
1337 downstreamp_comp_name_quark
= g_quark_from_string(
1338 cfg_conn
->downstream_comp_name
->str
);
1339 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1340 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1341 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1342 port_count_fn
= (input_port_count_func_t
)
1343 bt_component_filter_get_input_port_count
;
1344 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1345 bt_component_filter_borrow_input_port_by_index_const
;
1347 if (!downstream_comp
) {
1348 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1349 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1350 port_count_fn
= (input_port_count_func_t
)
1351 bt_component_sink_get_input_port_count
;
1352 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1353 bt_component_sink_borrow_input_port_by_index_const
;
1356 if (!downstream_comp
) {
1357 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1358 "comp-name=\"%s\", conn-arg=\"%s\"",
1359 cfg_conn
->downstream_comp_name
->str
,
1360 cfg_conn
->arg
->str
);
1364 downstream_port_count
= port_count_fn(downstream_comp
);
1366 for (i
= 0; i
< downstream_port_count
; i
++) {
1367 const bt_port_input
*in_downstream_port
=
1368 port_by_index_fn(downstream_comp
, i
);
1369 const bt_port
*downstream_port
=
1370 bt_port_input_as_port_const(in_downstream_port
);
1371 const char *upstream_port_name
;
1372 const char *downstream_port_name
;
1374 BT_ASSERT(downstream_port
);
1376 /* Skip port if it's already connected. */
1377 if (bt_port_is_connected(downstream_port
)) {
1378 BT_LOGI("Skipping downstream port: already connected: "
1379 "port-addr=%p, port-name=\"%s\"",
1381 bt_port_get_name(downstream_port
));
1385 downstream_port_name
= bt_port_get_name(downstream_port
);
1386 BT_ASSERT(downstream_port_name
);
1387 upstream_port_name
= bt_port_get_name(upstream_port
);
1388 BT_ASSERT(upstream_port_name
);
1390 if (!bt_common_star_glob_match(
1391 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1392 downstream_port_name
, SIZE_MAX
)) {
1396 if (insert_trimmer
) {
1398 * In order to insert the trimmer between the
1399 * two components that were being connected, we
1400 * create a connection configuration entry which
1401 * describes a connection from the trimmer's
1402 * output to the original input that was being
1405 * Hence, the creation of the trimmer will cause
1406 * the graph "new port" listener to establish
1407 * all downstream connections as its output port
1408 * is connected. We will then establish the
1409 * connection between the original upstream
1410 * source and the trimmer.
1412 char *trimmer_name
= NULL
;
1413 bt_graph_add_component_status add_comp_status
;
1415 ret
= asprintf(&trimmer_name
,
1416 "stream-intersection-trimmer-%s",
1417 upstream_port_name
);
1423 ctx
->connect_ports
= false;
1424 add_comp_status
= bt_graph_add_filter_component(
1425 ctx
->graph
, trimmer_class
, trimmer_name
,
1426 trimmer_params
, ctx
->cfg
->log_level
,
1428 bt_component_filter_get_ref(trimmer
);
1430 if (add_comp_status
!=
1431 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1437 bt_component_filter_borrow_input_port_by_index_const(
1439 if (!trimmer_input
) {
1443 bt_component_filter_borrow_output_port_by_index_const(
1445 if (!trimmer_output
) {
1450 * Replace the current downstream port by the trimmer's
1453 in_downstream_port
= trimmer_input
;
1455 bt_port_input_as_port_const(in_downstream_port
);
1456 downstream_port_name
= bt_port_get_name(
1458 BT_ASSERT(downstream_port_name
);
1461 /* We have a winner! */
1462 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1463 out_upstream_port
, in_downstream_port
, NULL
);
1464 downstream_port
= NULL
;
1465 switch (connect_ports_status
) {
1466 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1469 BT_CLI_LOGE_APPEND_CAUSE(
1470 "Cannot create connection: graph refuses to connect ports: "
1471 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1472 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1473 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1474 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1476 upstream_comp
, bt_component_get_name(upstream_comp
),
1477 upstream_port
, bt_port_get_name(upstream_port
),
1478 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1479 downstream_port
, downstream_port_name
,
1480 cfg_conn
->arg
->str
);
1484 BT_LOGI("Connected component ports: "
1485 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1486 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1487 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1488 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1490 upstream_comp
, bt_component_get_name(upstream_comp
),
1491 upstream_port
, bt_port_get_name(upstream_port
),
1492 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1493 downstream_port
, downstream_port_name
,
1494 cfg_conn
->arg
->str
);
1496 if (insert_trimmer
) {
1498 * The first connection, from the source to the trimmer,
1499 * has been done. We now connect the trimmer to the
1500 * original downstream port.
1502 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1504 bt_component_filter_as_component_const(trimmer
),
1505 trimmer_output
, cfg_conn
);
1509 ctx
->connect_ports
= true;
1513 * We found a matching downstream port: the search is
1519 /* No downstream port found */
1520 BT_CLI_LOGE_APPEND_CAUSE(
1521 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1522 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1523 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1524 upstream_port
, bt_port_get_name(upstream_port
),
1525 cfg_conn
->downstream_comp_name
->str
,
1526 cfg_conn
->arg
->str
);
1532 free(intersection_begin
);
1533 free(intersection_end
);
1534 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1535 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1536 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1541 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1542 const bt_port_output
*upstream_port
)
1545 const char *upstream_port_name
;
1546 const char *upstream_comp_name
;
1547 const bt_component
*upstream_comp
= NULL
;
1551 BT_ASSERT(upstream_port
);
1552 upstream_port_name
= bt_port_get_name(
1553 bt_port_output_as_port_const(upstream_port
));
1554 BT_ASSERT(upstream_port_name
);
1555 upstream_comp
= bt_port_borrow_component_const(
1556 bt_port_output_as_port_const(upstream_port
));
1557 BT_ASSERT(upstream_comp
);
1558 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1559 BT_ASSERT(upstream_comp_name
);
1560 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1561 "port-addr=%p, port-name=\"%s\"",
1562 upstream_comp
, upstream_comp_name
,
1563 upstream_port
, upstream_port_name
);
1565 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1566 struct bt_config_connection
*cfg_conn
=
1568 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1570 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1571 upstream_comp_name
)) {
1575 if (!bt_common_star_glob_match(
1576 cfg_conn
->upstream_port_glob
->str
,
1577 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1581 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1582 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1584 BT_CLI_LOGE_APPEND_CAUSE(
1585 "Cannot connect upstream port: "
1586 "port-addr=%p, port-name=\"%s\"",
1588 upstream_port_name
);
1594 BT_CLI_LOGE_APPEND_CAUSE(
1595 "Cannot connect upstream port: port does not match any connection argument: "
1596 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1597 upstream_port_name
);
1607 bt_graph_listener_func_status
1608 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1609 const bt_port_output
*out_port
)
1611 const bt_component
*comp
;
1612 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1613 bt_graph_listener_func_status ret
=
1614 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
1616 comp
= bt_port_borrow_component_const(port
);
1617 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1618 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1619 comp
, comp
? bt_component_get_name(comp
) : "",
1620 port
, bt_port_get_name(port
));
1622 if (!ctx
->connect_ports
) {
1628 if (bt_port_is_connected(port
)) {
1629 BT_LOGW_STR("Port is already connected.");
1633 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
1634 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1635 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
1644 bt_graph_listener_func_status
graph_source_output_port_added_listener(
1645 const bt_component_source
*component
,
1646 const bt_port_output
*port
, void *data
)
1648 return graph_output_port_added_listener(data
, port
);
1652 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
1653 const bt_component_filter
*component
,
1654 const bt_port_output
*port
, void *data
)
1656 return graph_output_port_added_listener(data
, port
);
1660 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1666 if (ctx
->src_components
) {
1667 g_hash_table_destroy(ctx
->src_components
);
1668 ctx
->src_components
= NULL
;
1671 if (ctx
->flt_components
) {
1672 g_hash_table_destroy(ctx
->flt_components
);
1673 ctx
->flt_components
= NULL
;
1676 if (ctx
->sink_components
) {
1677 g_hash_table_destroy(ctx
->sink_components
);
1678 ctx
->sink_components
= NULL
;
1681 if (ctx
->intersections
) {
1682 g_hash_table_destroy(ctx
->intersections
);
1683 ctx
->intersections
= NULL
;
1686 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
1691 int add_descriptor_to_component_descriptor_set(
1692 bt_component_descriptor_set
*comp_descr_set
,
1693 const char *plugin_name
, const char *comp_cls_name
,
1694 bt_component_class_type comp_cls_type
,
1695 const bt_value
*params
)
1697 const bt_component_class
*comp_cls
;
1700 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1703 BT_CLI_LOGE_APPEND_CAUSE(
1704 "Cannot find component class: plugin-name=\"%s\", "
1705 "comp-cls-name=\"%s\", comp-cls-type=%d",
1706 plugin_name
, comp_cls_name
, comp_cls_type
);
1711 status
= bt_component_descriptor_set_add_descriptor(
1712 comp_descr_set
, comp_cls
, params
);
1713 if (status
!= BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK
) {
1714 BT_CLI_LOGE_APPEND_CAUSE(
1715 "Cannot append descriptor to component descriptor set: "
1716 "status=%s", bt_common_func_status_string(status
));
1721 bt_component_class_put_ref(comp_cls
);
1726 int append_descriptors_from_bt_config_component_array(
1727 bt_component_descriptor_set
*comp_descr_set
,
1728 GPtrArray
*component_configs
)
1733 for (i
= 0; i
< component_configs
->len
; i
++) {
1734 struct bt_config_component
*cfg_comp
=
1735 component_configs
->pdata
[i
];
1737 ret
= add_descriptor_to_component_descriptor_set(
1739 cfg_comp
->plugin_name
->str
,
1740 cfg_comp
->comp_cls_name
->str
,
1741 cfg_comp
->type
, cfg_comp
->params
);
1752 bt_get_greatest_operative_mip_version_status
get_greatest_operative_mip_version(
1753 struct bt_config
*cfg
, uint64_t *mip_version
)
1755 bt_get_greatest_operative_mip_version_status status
=
1756 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
;
1757 bt_component_descriptor_set
*comp_descr_set
= NULL
;
1761 BT_ASSERT(mip_version
);
1762 comp_descr_set
= bt_component_descriptor_set_create();
1763 if (!comp_descr_set
) {
1764 BT_CLI_LOGE_APPEND_CAUSE(
1765 "Failed to create a component descriptor set object.");
1766 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR
;
1770 ret
= append_descriptors_from_bt_config_component_array(
1771 comp_descr_set
, cfg
->cmd_data
.run
.sources
);
1773 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1777 ret
= append_descriptors_from_bt_config_component_array(
1778 comp_descr_set
, cfg
->cmd_data
.run
.filters
);
1780 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1784 ret
= append_descriptors_from_bt_config_component_array(
1785 comp_descr_set
, cfg
->cmd_data
.run
.sinks
);
1787 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1791 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1793 * Stream intersection mode adds `flt.utils.trimmer`
1794 * components; we need to include this type of component
1795 * in the component descriptor set to get the real
1796 * greatest operative MIP version.
1798 ret
= add_descriptor_to_component_descriptor_set(
1799 comp_descr_set
, "utils", "trimmer",
1800 BT_COMPONENT_CLASS_TYPE_FILTER
, NULL
);
1802 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1807 status
= bt_get_greatest_operative_mip_version(comp_descr_set
,
1808 bt_cli_log_level
, mip_version
);
1811 bt_component_descriptor_set_put_ref(comp_descr_set
);
1816 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1819 bt_graph_add_listener_status add_listener_status
;
1820 bt_get_greatest_operative_mip_version_status mip_version_status
;
1821 uint64_t mip_version
= UINT64_C(-1);
1824 ctx
->connect_ports
= false;
1825 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
1826 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1827 if (!ctx
->src_components
) {
1831 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
1832 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1833 if (!ctx
->flt_components
) {
1837 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
1838 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1839 if (!ctx
->sink_components
) {
1843 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1844 ctx
->stream_intersection_mode
= true;
1845 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
1846 port_id_equal
, port_id_destroy
, trace_range_destroy
);
1847 if (!ctx
->intersections
) {
1853 * Get the greatest operative MIP version to use to configure
1854 * the graph to create.
1856 mip_version_status
= get_greatest_operative_mip_version(
1858 if (mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH
) {
1859 BT_CLI_LOGE_APPEND_CAUSE(
1860 "Failed to find an operative message interchange "
1861 "protocol version to use to create the `run` command's "
1862 "graph (components are not interoperable).");
1864 } else if (mip_version_status
< 0) {
1865 BT_CLI_LOGE_APPEND_CAUSE(
1866 "Cannot find an operative message interchange "
1867 "protocol version to use to create the `run` command's "
1869 bt_common_func_status_string(mip_version_status
));
1873 BT_ASSERT(mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
);
1874 BT_LOGI("Found operative message interchange protocol version to "
1875 "configure the `run` command's graph: mip-version=%" PRIu64
,
1877 ctx
->graph
= bt_graph_create(mip_version
);
1882 bt_graph_add_interrupter(ctx
->graph
, the_interrupter
);
1883 add_listener_status
= bt_graph_add_source_component_output_port_added_listener(
1884 ctx
->graph
, graph_source_output_port_added_listener
, ctx
,
1886 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1887 BT_CLI_LOGE_APPEND_CAUSE(
1888 "Cannot add \"port added\" listener to graph.");
1892 add_listener_status
= bt_graph_add_filter_component_output_port_added_listener(
1893 ctx
->graph
, graph_filter_output_port_added_listener
, ctx
,
1895 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1896 BT_CLI_LOGE_APPEND_CAUSE(
1897 "Cannot add \"port added\" listener to graph.");
1904 cmd_run_ctx_destroy(ctx
);
1912 * Compute the intersection of all streams in the array `streams`, write it
1917 int compute_stream_intersection(const bt_value
*streams
,
1918 struct trace_range
*range
)
1920 uint64_t i
, stream_count
;
1923 BT_ASSERT(bt_value_get_type(streams
) == BT_VALUE_TYPE_ARRAY
);
1925 stream_count
= bt_value_array_get_length(streams
);
1927 BT_ASSERT(stream_count
> 0);
1929 range
->intersection_range_begin_ns
= 0;
1930 range
->intersection_range_end_ns
= UINT64_MAX
;
1932 for (i
= 0; i
< stream_count
; i
++) {
1933 int64_t begin_ns
, end_ns
;
1934 uint64_t begin_ns_u
, end_ns_u
;
1935 const bt_value
*stream_value
;
1936 const bt_value
*range_ns_value
;
1937 const bt_value
*begin_value
;
1938 const bt_value
*end_value
;
1940 stream_value
= bt_value_array_borrow_element_by_index_const(streams
, i
);
1941 if (bt_value_get_type(stream_value
) != BT_VALUE_TYPE_MAP
) {
1942 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1943 "expected streams array element to be a map, got %s.",
1944 bt_common_value_type_string(bt_value_get_type(stream_value
)));
1948 range_ns_value
= bt_value_map_borrow_entry_value_const(
1949 stream_value
, "range-ns");
1950 if (!range_ns_value
) {
1951 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1952 "missing expected `range-ns` key in stream map.");
1956 if (bt_value_get_type(range_ns_value
) != BT_VALUE_TYPE_MAP
) {
1957 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1958 "expected `range-ns` entry value of stream map to be a map, got %s.",
1959 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
1963 begin_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "begin");
1965 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1966 "missing expected `begin` key in range-ns map.");
1970 if (bt_value_get_type(begin_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
1971 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1972 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
1973 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
1977 end_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "end");
1979 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1980 "missing expected `end` key in range-ns map.");
1984 if (bt_value_get_type(end_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
1985 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1986 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
1987 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
1991 begin_ns
= bt_value_integer_signed_get(begin_value
);
1992 end_ns
= bt_value_integer_signed_get(end_value
);
1994 if (begin_ns
< 0 || end_ns
< 0 || end_ns
< begin_ns
) {
1995 BT_CLI_LOGE_APPEND_CAUSE(
1996 "Invalid stream range values: "
1997 "range-ns:begin=%" PRId64
", "
1998 "range-ns:end=%" PRId64
,
2003 begin_ns_u
= begin_ns
;
2006 range
->intersection_range_begin_ns
=
2007 MAX(range
->intersection_range_begin_ns
, begin_ns_u
);
2008 range
->intersection_range_end_ns
=
2009 MIN(range
->intersection_range_end_ns
, end_ns_u
);
2022 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2023 struct bt_config_component
*cfg_comp
,
2024 const bt_component_class_source
*src_comp_cls
)
2028 uint64_t trace_count
;
2029 const bt_value
*query_result
= NULL
;
2030 const bt_value
*trace_info
= NULL
;
2031 const bt_value
*stream_infos
= NULL
;
2032 const bt_value
*stream_info
= NULL
;
2033 struct port_id
*port_id
= NULL
;
2034 struct trace_range
*stream_intersection
= NULL
;
2035 const char *fail_reason
= NULL
;
2036 const bt_component_class
*comp_cls
=
2037 bt_component_class_source_as_component_class_const(src_comp_cls
);
2039 ret
= query(ctx
->cfg
, comp_cls
, "babeltrace.trace-infos",
2040 cfg_comp
->params
, &query_result
,
2043 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2044 "comp-class-name=\"%s\"", fail_reason
,
2045 bt_component_class_get_name(comp_cls
));
2050 BT_ASSERT(query_result
);
2052 if (!bt_value_is_array(query_result
)) {
2053 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2054 "component-class-name=%s, actual-type=%s",
2055 bt_component_class_get_name(comp_cls
),
2056 bt_common_value_type_string(bt_value_get_type(query_result
)));
2061 trace_count
= bt_value_array_get_length(query_result
);
2062 if (trace_count
== 0) {
2063 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2064 "component-class-name=%s", bt_component_class_get_name(comp_cls
));
2069 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2070 uint64_t stream_idx
;
2071 int64_t stream_count
;
2072 struct trace_range trace_intersection
;
2074 trace_info
= bt_value_array_borrow_element_by_index_const(
2075 query_result
, trace_idx
);
2076 if (!bt_value_is_map(trace_info
)) {
2078 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2079 "component-class-name=%s, actual-type=%s",
2080 bt_component_class_get_name(comp_cls
),
2081 bt_common_value_type_string(bt_value_get_type(trace_info
)));
2085 stream_infos
= bt_value_map_borrow_entry_value_const(
2086 trace_info
, "stream-infos");
2087 if (!stream_infos
) {
2089 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2090 "component-class-name=%s",
2091 bt_component_class_get_name(comp_cls
));
2095 if (!bt_value_is_array(stream_infos
)) {
2097 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2098 "component-class-name=%s, actual-type=%s",
2099 bt_component_class_get_name(comp_cls
),
2100 bt_common_value_type_string(bt_value_get_type(stream_infos
)));
2104 stream_count
= bt_value_array_get_length(stream_infos
);
2105 if (stream_count
== 0) {
2107 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2108 "component-class-name=%s",
2109 bt_component_class_get_name(comp_cls
));
2113 ret
= compute_stream_intersection(stream_infos
, &trace_intersection
);
2115 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2119 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2120 const bt_value
*port_name
;
2122 port_id
= g_new0(struct port_id
, 1);
2125 BT_CLI_LOGE_APPEND_CAUSE(
2126 "Cannot allocate memory for port_id structure.");
2129 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2130 if (!port_id
->instance_name
) {
2132 BT_CLI_LOGE_APPEND_CAUSE(
2133 "Cannot allocate memory for port_id component instance name.");
2137 stream_intersection
= g_new0(struct trace_range
, 1);
2138 if (!stream_intersection
) {
2140 BT_CLI_LOGE_APPEND_CAUSE(
2141 "Cannot allocate memory for trace_range structure.");
2145 *stream_intersection
= trace_intersection
;
2147 stream_info
= bt_value_array_borrow_element_by_index_const(
2148 stream_infos
, stream_idx
);
2149 if (!bt_value_is_map(stream_info
)) {
2151 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2152 "expecting element of stream list to be a map: "
2153 "component-class-name=%s, actual-type=%s",
2154 bt_component_class_get_name(comp_cls
),
2155 bt_common_value_type_string(bt_value_get_type(stream_info
)));
2159 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2162 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2163 "missing `port-name` key in stream info map: "
2164 "component-class-name=%s",
2165 bt_component_class_get_name(comp_cls
));
2169 if (!bt_value_is_string(port_name
)) {
2171 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2172 "expecting `port-name` entry of stream info map to be a string: "
2173 "component-class-name=%s, actual-type=%s",
2174 bt_component_class_get_name(comp_cls
),
2175 bt_common_value_type_string(bt_value_get_type(port_name
)));
2179 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2180 if (!port_id
->port_name
) {
2182 BT_CLI_LOGE_APPEND_CAUSE(
2183 "Cannot allocate memory for port_id port_name.");
2187 BT_LOGD("Inserting stream intersection ");
2189 g_hash_table_insert(ctx
->intersections
, port_id
, stream_intersection
);
2192 stream_intersection
= NULL
;
2199 bt_value_put_ref(query_result
);
2201 g_free(stream_intersection
);
2206 int cmd_run_ctx_create_components_from_config_components(
2207 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2210 const void *comp_cls
= NULL
;
2211 const void *comp
= NULL
;
2214 for (i
= 0; i
< cfg_components
->len
; i
++) {
2215 struct bt_config_component
*cfg_comp
=
2216 g_ptr_array_index(cfg_components
, i
);
2219 switch (cfg_comp
->type
) {
2220 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2221 comp_cls
= find_source_component_class(
2222 cfg_comp
->plugin_name
->str
,
2223 cfg_comp
->comp_cls_name
->str
);
2225 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2226 comp_cls
= find_filter_component_class(
2227 cfg_comp
->plugin_name
->str
,
2228 cfg_comp
->comp_cls_name
->str
);
2230 case BT_COMPONENT_CLASS_TYPE_SINK
:
2231 comp_cls
= find_sink_component_class(
2232 cfg_comp
->plugin_name
->str
,
2233 cfg_comp
->comp_cls_name
->str
);
2240 BT_CLI_LOGE_APPEND_CAUSE(
2241 "Cannot find component class: plugin-name=\"%s\", "
2242 "comp-cls-name=\"%s\", comp-cls-type=%d",
2243 cfg_comp
->plugin_name
->str
,
2244 cfg_comp
->comp_cls_name
->str
,
2249 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_TRACE
);
2251 switch (cfg_comp
->type
) {
2252 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2253 ret
= bt_graph_add_source_component(ctx
->graph
,
2254 comp_cls
, cfg_comp
->instance_name
->str
,
2255 cfg_comp
->params
, cfg_comp
->log_level
,
2257 bt_component_source_get_ref(comp
);
2259 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2260 ret
= bt_graph_add_filter_component(ctx
->graph
,
2261 comp_cls
, cfg_comp
->instance_name
->str
,
2262 cfg_comp
->params
, cfg_comp
->log_level
,
2264 bt_component_filter_get_ref(comp
);
2266 case BT_COMPONENT_CLASS_TYPE_SINK
:
2267 ret
= bt_graph_add_sink_component(ctx
->graph
,
2268 comp_cls
, cfg_comp
->instance_name
->str
,
2269 cfg_comp
->params
, cfg_comp
->log_level
,
2271 bt_component_sink_get_ref(comp
);
2278 BT_CLI_LOGE_APPEND_CAUSE(
2279 "Cannot create component: plugin-name=\"%s\", "
2280 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2282 cfg_comp
->plugin_name
->str
,
2283 cfg_comp
->comp_cls_name
->str
,
2284 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2288 if (ctx
->stream_intersection_mode
&&
2289 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2290 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2292 BT_CLI_LOGE_APPEND_CAUSE(
2293 "Cannot determine stream intersection of trace.");
2298 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2299 comp
, cfg_comp
->instance_name
->str
);
2300 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2301 BT_ASSERT(quark
> 0);
2303 switch (cfg_comp
->type
) {
2304 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2305 g_hash_table_insert(ctx
->src_components
,
2306 GUINT_TO_POINTER(quark
), (void *) comp
);
2308 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2309 g_hash_table_insert(ctx
->flt_components
,
2310 GUINT_TO_POINTER(quark
), (void *) comp
);
2312 case BT_COMPONENT_CLASS_TYPE_SINK
:
2313 g_hash_table_insert(ctx
->sink_components
,
2314 GUINT_TO_POINTER(quark
), (void *) comp
);
2321 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2330 bt_object_put_ref(comp
);
2331 bt_object_put_ref(comp_cls
);
2336 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2341 * Make sure that, during this phase, our graph's "port added"
2342 * listener does not connect ports while we are creating the
2343 * components because we have a special, initial phase for
2346 ctx
->connect_ports
= false;
2348 ret
= cmd_run_ctx_create_components_from_config_components(
2349 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2355 ret
= cmd_run_ctx_create_components_from_config_components(
2356 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2362 ret
= cmd_run_ctx_create_components_from_config_components(
2363 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2373 typedef uint64_t (*output_port_count_func_t
)(const void *);
2374 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2375 const void *, uint64_t);
2378 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2379 void *comp
, output_port_count_func_t port_count_fn
,
2380 borrow_output_port_by_index_func_t port_by_index_fn
)
2386 count
= port_count_fn(comp
);
2388 for (i
= 0; i
< count
; i
++) {
2389 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2391 BT_ASSERT(upstream_port
);
2392 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2403 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2406 GHashTableIter iter
;
2407 gpointer g_name_quark
, g_comp
;
2409 ctx
->connect_ports
= true;
2410 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2412 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2413 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2414 (output_port_count_func_t
)
2415 bt_component_source_get_output_port_count
,
2416 (borrow_output_port_by_index_func_t
)
2417 bt_component_source_borrow_output_port_by_index_const
);
2423 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2425 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2426 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2427 (output_port_count_func_t
)
2428 bt_component_filter_get_output_port_count
,
2429 (borrow_output_port_by_index_func_t
)
2430 bt_component_filter_borrow_output_port_by_index_const
);
2441 enum bt_cmd_status
cmd_run(struct bt_config
*cfg
)
2443 enum bt_cmd_status cmd_status
;
2444 struct cmd_run_ctx ctx
= { 0 };
2446 /* Initialize the command's context and the graph object */
2447 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2448 BT_CLI_LOGE_APPEND_CAUSE(
2449 "Cannot initialize the command's context.");
2453 if (bt_interrupter_is_set(the_interrupter
)) {
2454 BT_CLI_LOGW_APPEND_CAUSE(
2455 "Interrupted by user before creating components.");
2459 BT_LOGI_STR("Creating components.");
2461 /* Create the requested component instances */
2462 if (cmd_run_ctx_create_components(&ctx
)) {
2463 BT_CLI_LOGE_APPEND_CAUSE("Cannot create components.");
2467 if (bt_interrupter_is_set(the_interrupter
)) {
2468 BT_CLI_LOGW_APPEND_CAUSE(
2469 "Interrupted by user before connecting components.");
2473 BT_LOGI_STR("Connecting components.");
2475 /* Connect the initially visible component ports */
2476 if (cmd_run_ctx_connect_ports(&ctx
)) {
2477 BT_CLI_LOGE_APPEND_CAUSE(
2478 "Cannot connect initial component ports.");
2482 BT_LOGI_STR("Running the graph.");
2486 bt_graph_run_status run_status
= bt_graph_run(ctx
.graph
);
2489 * Reset console in case something messed with console
2490 * codes during the graph's execution.
2492 printf("%s", bt_common_color_reset());
2494 fprintf(stderr
, "%s", bt_common_color_reset());
2495 BT_LOGT("bt_graph_run() returned: status=%s",
2496 bt_common_func_status_string(run_status
));
2498 switch (run_status
) {
2499 case BT_GRAPH_RUN_STATUS_OK
:
2500 cmd_status
= BT_CMD_STATUS_OK
;
2502 case BT_GRAPH_RUN_STATUS_AGAIN
:
2503 if (bt_interrupter_is_set(the_interrupter
)) {
2505 * The graph was interrupted by a SIGINT.
2507 cmd_status
= BT_CMD_STATUS_INTERRUPTED
;
2511 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2512 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2514 cfg
->cmd_data
.run
.retry_duration_us
);
2516 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2517 if (bt_interrupter_is_set(the_interrupter
)) {
2518 cmd_status
= BT_CMD_STATUS_INTERRUPTED
;
2525 if (bt_interrupter_is_set(the_interrupter
)) {
2526 cmd_status
= BT_CMD_STATUS_INTERRUPTED
;
2530 BT_CLI_LOGE_APPEND_CAUSE(
2531 "Graph failed to complete successfully");
2536 cmd_status
= BT_CMD_STATUS_ERROR
;
2539 cmd_run_ctx_destroy(&ctx
);
2544 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2546 const char *env_clash
;
2548 if (!cfg
->command_name
) {
2552 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2553 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2557 if (g_file_test(cfg
->command_name
,
2558 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2559 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION
, __FILE__
, __LINE__
,
2560 BT_LOG_WARNING
, BT_LOG_TAG
,
2561 "The `%s` command was executed. "
2562 "If you meant to convert a trace located in "
2563 "the local `%s` directory, please use:\n\n"
2564 " babeltrace2 convert %s [OPTIONS]",
2565 cfg
->command_name
, cfg
->command_name
,
2571 void init_log_level(void)
2573 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2577 void print_error_causes(void)
2579 const bt_error
*error
= bt_current_thread_take_error();
2580 unsigned int columns
;
2581 gchar
*error_str
= NULL
;
2583 if (!error
|| bt_error_get_cause_count(error
) == 0) {
2584 fprintf(stderr
, "%s%sUnknown command-line error.%s\n",
2585 bt_common_color_bold(), bt_common_color_fg_bright_red(),
2586 bt_common_color_reset());
2590 /* Try to get terminal width to fold the error cause messages */
2591 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
2592 /* Width not found: default to 80 */
2597 * This helps visually separate the error causes from the last
2598 * logging statement.
2600 fputc('\n', stderr
);
2602 error_str
= format_bt_error(error
, columns
, bt_cli_log_level
,
2603 BT_COMMON_COLOR_WHEN_AUTO
);
2604 BT_ASSERT(error_str
);
2606 fprintf(stderr
, "%s\n", error_str
);
2610 bt_error_release(error
);
2616 int main(int argc
, const char **argv
)
2619 enum bt_config_cli_args_status cli_args_status
;
2620 enum bt_cmd_status cmd_status
;
2621 struct bt_config
*cfg
= NULL
;
2624 set_signal_handler();
2625 init_loaded_plugins();
2627 BT_ASSERT(!the_interrupter
);
2628 the_interrupter
= bt_interrupter_create();
2629 if (!the_interrupter
) {
2630 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2631 retcode
= EXIT_FAILURE
;
2635 cli_args_status
= bt_config_cli_args_create_with_default(argc
, argv
, &cfg
,
2637 if (cli_args_status
== BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY
) {
2638 /* Quit without errors; typically usage/version */
2639 retcode
= EXIT_SUCCESS
;
2640 BT_LOGI_STR("Quitting without errors.");
2644 if (cli_args_status
== BT_CONFIG_CLI_ARGS_STATUS_ERROR
) {
2645 retcode
= EXIT_FAILURE
;
2646 BT_CLI_LOGE_APPEND_CAUSE(
2647 "Command-line error: retcode=%d", retcode
);
2651 BT_ASSERT(cli_args_status
== BT_CONFIG_CLI_ARGS_STATUS_OK
);
2656 if (cfg
->command_needs_plugins
) {
2657 int ret
= require_loaded_plugins(cfg
->plugin_paths
);
2660 BT_CLI_LOGE_APPEND_CAUSE(
2661 "Failed to load plugins: ret=%d", ret
);
2662 retcode
= EXIT_FAILURE
;
2667 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2668 cfg
->command
, cfg
->command_name
);
2670 switch (cfg
->command
) {
2671 case BT_CONFIG_COMMAND_RUN
:
2672 cmd_status
= cmd_run(cfg
);
2674 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2675 cmd_status
= cmd_list_plugins(cfg
);
2677 case BT_CONFIG_COMMAND_HELP
:
2678 cmd_status
= cmd_help(cfg
);
2680 case BT_CONFIG_COMMAND_QUERY
:
2681 cmd_status
= cmd_query(cfg
);
2683 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2684 cmd_status
= cmd_print_ctf_metadata(cfg
);
2686 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2687 cmd_status
= cmd_print_lttng_live_sessions(cfg
);
2690 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2694 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", command-status=\"%s\"",
2695 cfg
->command
, cfg
->command_name
, bt_cmd_status_string(cmd_status
));
2696 warn_command_name_and_directory_clash(cfg
);
2698 switch (cmd_status
) {
2699 case BT_CMD_STATUS_OK
:
2700 retcode
= EXIT_SUCCESS
;
2702 case BT_CMD_STATUS_ERROR
:
2703 retcode
= EXIT_FAILURE
;
2705 case BT_CMD_STATUS_INTERRUPTED
:
2706 retcode
= EXIT_INTERRUPTED
;
2709 BT_LOGF("Invalid command status: cmd-status=%d", cmd_status
);
2714 if (retcode
== EXIT_FAILURE
) {
2715 print_error_causes();
2718 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2719 fini_loaded_plugins();
2720 bt_interrupter_put_ref(the_interrupter
);
2723 * Clear current thread's error in case there is one to avoid a
2726 bt_current_thread_clear_error();