2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
4 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #define BT_LOG_TAG "CLI"
28 #include <babeltrace2/babeltrace.h>
29 #include "common/common.h"
38 #include "babeltrace2-cfg.h"
39 #include "babeltrace2-cfg-cli-args.h"
40 #include "babeltrace2-cfg-cli-args-default.h"
41 #include "babeltrace2-log-level.h"
42 #include "babeltrace2-plugins.h"
43 #include "babeltrace2-query.h"
45 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
46 #define NSEC_PER_SEC 1000000000LL
48 /* Application's interrupter (owned by this) */
49 static bt_interrupter
*the_interrupter
;
56 BOOL WINAPI
signal_handler(DWORD signal
) {
57 if (the_interrupter
) {
58 bt_interrupter_set(the_interrupter
);
65 void set_signal_handler(void)
67 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
68 BT_LOGE("Failed to set the Ctrl+C handler.");
72 #else /* __MINGW32__ */
75 void signal_handler(int signum
)
77 if (signum
!= SIGINT
) {
81 if (the_interrupter
) {
82 bt_interrupter_set(the_interrupter
);
87 void set_signal_handler(void)
89 struct sigaction new_action
, old_action
;
91 new_action
.sa_handler
= signal_handler
;
92 sigemptyset(&new_action
.sa_mask
);
93 new_action
.sa_flags
= 0;
94 sigaction(SIGINT
, NULL
, &old_action
);
96 if (old_action
.sa_handler
!= SIG_IGN
) {
97 sigaction(SIGINT
, &new_action
, NULL
);
101 #endif /* __MINGW32__ */
104 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
105 const char *obj
, const bt_value
*params
,
106 const bt_value
**user_result
, const char **fail_reason
)
108 return cli_query(comp_cls
, obj
, params
, cfg
->log_level
,
109 the_interrupter
, user_result
, fail_reason
);
112 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
113 const bt_plugin
*, const char *);
116 const void *find_component_class_from_plugin(const char *plugin_name
,
117 const char *comp_class_name
,
118 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
120 const void *comp_class
= NULL
;
121 const bt_plugin
*plugin
;
123 BT_LOGI("Finding component class: plugin-name=\"%s\", "
124 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
126 plugin
= find_loaded_plugin(plugin_name
);
131 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
132 bt_object_get_ref(comp_class
);
133 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
137 BT_LOGI("Found component class: plugin-name=\"%s\", "
138 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
140 BT_LOGI("Cannot find source component class: "
141 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
142 plugin_name
, comp_class_name
);
149 const bt_component_class_source
*find_source_component_class(
150 const char *plugin_name
, const char *comp_class_name
)
152 return (const void *) find_component_class_from_plugin(
153 plugin_name
, comp_class_name
,
154 (plugin_borrow_comp_cls_func_t
)
155 bt_plugin_borrow_source_component_class_by_name_const
);
159 const bt_component_class_filter
*find_filter_component_class(
160 const char *plugin_name
, const char *comp_class_name
)
162 return (const void *) find_component_class_from_plugin(
163 plugin_name
, comp_class_name
,
164 (plugin_borrow_comp_cls_func_t
)
165 bt_plugin_borrow_filter_component_class_by_name_const
);
169 const bt_component_class_sink
*find_sink_component_class(
170 const char *plugin_name
, const char *comp_class_name
)
172 return (const void *) find_component_class_from_plugin(plugin_name
,
174 (plugin_borrow_comp_cls_func_t
)
175 bt_plugin_borrow_sink_component_class_by_name_const
);
179 const bt_component_class
*find_component_class(const char *plugin_name
,
180 const char *comp_class_name
,
181 bt_component_class_type comp_class_type
)
183 const bt_component_class
*comp_cls
= NULL
;
185 switch (comp_class_type
) {
186 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
187 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
189 case BT_COMPONENT_CLASS_TYPE_FILTER
:
190 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
192 case BT_COMPONENT_CLASS_TYPE_SINK
:
193 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
203 void print_indent(FILE *fp
, size_t indent
)
207 for (i
= 0; i
< indent
; i
++) {
213 const char *component_type_str(bt_component_class_type type
)
216 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
218 case BT_COMPONENT_CLASS_TYPE_SINK
:
220 case BT_COMPONENT_CLASS_TYPE_FILTER
:
228 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
229 const char *comp_cls_name
, bt_component_class_type type
)
231 GString
*shell_plugin_name
= NULL
;
232 GString
*shell_comp_cls_name
= NULL
;
235 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
236 if (!shell_plugin_name
) {
241 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
242 if (!shell_comp_cls_name
) {
246 fprintf(fh
, "'%s%s%s%s",
247 bt_common_color_bold(),
248 bt_common_color_fg_cyan(),
249 component_type_str(type
),
250 bt_common_color_fg_default());
252 if (shell_plugin_name
) {
253 fprintf(fh
, ".%s%s%s",
254 bt_common_color_fg_blue(),
255 shell_plugin_name
->str
,
256 bt_common_color_fg_default());
259 fprintf(fh
, ".%s%s%s'",
260 bt_common_color_fg_yellow(),
261 shell_comp_cls_name
->str
,
262 bt_common_color_reset());
265 if (shell_plugin_name
) {
266 g_string_free(shell_plugin_name
, TRUE
);
269 if (shell_comp_cls_name
) {
270 g_string_free(shell_comp_cls_name
, TRUE
);
275 void print_value(FILE *, const bt_value
*, size_t);
278 void print_value_rec(FILE *, const bt_value
*, size_t);
281 void print_map_value(const char *key
, const bt_value
*object
, FILE *fp
,
284 print_indent(fp
, indent
);
285 fprintf(fp
, "%s: ", key
);
288 if (bt_value_is_array(object
) &&
289 bt_value_array_is_empty(object
)) {
290 fprintf(fp
, "[ ]\n");
294 if (bt_value_is_map(object
) &&
295 bt_value_map_is_empty(object
)) {
296 fprintf(fp
, "{ }\n");
300 if (bt_value_is_array(object
) ||
301 bt_value_is_map(object
)) {
305 print_value_rec(fp
, object
, indent
+ 2);
312 bt_bool
collect_map_keys(const char *key
, const bt_value
*object
, void *data
)
314 GPtrArray
*map_keys
= data
;
316 g_ptr_array_add(map_keys
, (gpointer
*) key
);
322 gint
g_ptr_array_sort_strings(gconstpointer a
, gconstpointer b
) {
323 const char *s1
= *((const char **) a
);
324 const char *s2
= *((const char **) b
);
326 return g_strcmp0(s1
, s2
);
330 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
338 GPtrArray
*map_keys
= NULL
;
344 switch (bt_value_get_type(value
)) {
345 case BT_VALUE_TYPE_NULL
:
346 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
347 bt_common_color_reset());
349 case BT_VALUE_TYPE_BOOL
:
350 bool_val
= bt_value_bool_get(value
);
351 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
352 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
353 bt_common_color_reset());
355 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
356 uint_val
= bt_value_integer_unsigned_get(value
);
357 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
358 bt_common_color_fg_red(), uint_val
,
359 bt_common_color_reset());
361 case BT_VALUE_TYPE_SIGNED_INTEGER
:
362 int_val
= bt_value_integer_signed_get(value
);
363 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
364 bt_common_color_fg_red(), int_val
,
365 bt_common_color_reset());
367 case BT_VALUE_TYPE_REAL
:
368 dbl_val
= bt_value_real_get(value
);
369 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
370 bt_common_color_fg_red(), dbl_val
,
371 bt_common_color_reset());
373 case BT_VALUE_TYPE_STRING
:
374 str_val
= bt_value_string_get(value
);
375 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
376 bt_common_color_fg_green(), str_val
,
377 bt_common_color_reset());
379 case BT_VALUE_TYPE_ARRAY
:
382 size
= bt_value_array_get_length(value
);
388 print_indent(fp
, indent
);
389 fprintf(fp
, "[ ]\n");
393 for (i
= 0; i
< size
; i
++) {
394 const bt_value
*element
=
395 bt_value_array_borrow_element_by_index_const(
401 print_indent(fp
, indent
);
404 if (bt_value_is_array(element
) &&
405 bt_value_array_is_empty(element
)) {
406 fprintf(fp
, "[ ]\n");
410 if (bt_value_is_map(element
) &&
411 bt_value_map_is_empty(element
)) {
412 fprintf(fp
, "{ }\n");
416 if (bt_value_is_array(element
) ||
417 bt_value_is_map(element
)) {
421 print_value_rec(fp
, element
, indent
+ 2);
425 case BT_VALUE_TYPE_MAP
:
428 bt_value_map_foreach_entry_const_status foreach_status
;
430 if (bt_value_map_is_empty(value
)) {
431 print_indent(fp
, indent
);
432 fprintf(fp
, "{ }\n");
436 map_keys
= g_ptr_array_new();
438 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
443 * We want to print the map entries in a stable order. Collect
444 * all the map's keys in a GPtrArray, sort it, then print the
445 * entries in that order.
447 foreach_status
= bt_value_map_foreach_entry_const(value
,
448 collect_map_keys
, map_keys
);
449 if (foreach_status
!= BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
) {
450 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
454 g_ptr_array_sort(map_keys
, g_ptr_array_sort_strings
);
456 for (i
= 0; i
< map_keys
->len
; i
++) {
457 const char *map_key
= g_ptr_array_index(map_keys
, i
);
458 const bt_value
*map_value
;
460 map_value
= bt_value_map_borrow_entry_value_const(value
, map_key
);
461 BT_ASSERT(map_value
);
463 print_map_value(map_key
, map_value
, fp
, indent
);
475 BT_LOGE("Error printing value of type %s.",
476 bt_common_value_type_string(bt_value_get_type(value
)));
480 g_ptr_array_free(map_keys
, TRUE
);
485 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
487 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
488 print_indent(fp
, indent
);
491 print_value_rec(fp
, value
, indent
);
495 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
497 fprintf(stderr
, " ");
498 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
499 bt_config_component
->comp_cls_name
->str
,
500 bt_config_component
->type
);
501 fprintf(stderr
, ":\n");
503 if (bt_config_component
->instance_name
->len
> 0) {
504 fprintf(stderr
, " Name: %s\n",
505 bt_config_component
->instance_name
->str
);
508 fprintf(stderr
, " Parameters:\n");
509 print_value(stderr
, bt_config_component
->params
, 8);
513 void print_bt_config_components(GPtrArray
*array
)
517 for (i
= 0; i
< array
->len
; i
++) {
518 struct bt_config_component
*cfg_component
=
519 bt_config_get_component(array
, i
);
520 print_bt_config_component(cfg_component
);
521 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
526 void print_plugin_paths(const bt_value
*plugin_paths
)
528 fprintf(stderr
, " Plugin paths:\n");
529 print_value(stderr
, plugin_paths
, 4);
533 void print_cfg_run(struct bt_config
*cfg
)
537 print_plugin_paths(cfg
->plugin_paths
);
538 fprintf(stderr
, " Source component instances:\n");
539 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
541 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
542 fprintf(stderr
, " Filter component instances:\n");
543 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
546 fprintf(stderr
, " Sink component instances:\n");
547 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
548 fprintf(stderr
, " Connections:\n");
550 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
551 struct bt_config_connection
*cfg_connection
=
552 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
555 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
556 cfg_connection
->upstream_comp_name
->str
,
557 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
558 cfg_connection
->upstream_port_glob
->str
,
559 cfg_connection
->downstream_comp_name
->str
,
560 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
561 cfg_connection
->downstream_port_glob
->str
);
566 void print_cfg_list_plugins(struct bt_config
*cfg
)
568 print_plugin_paths(cfg
->plugin_paths
);
572 void print_cfg_help(struct bt_config
*cfg
)
574 print_plugin_paths(cfg
->plugin_paths
);
578 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
580 print_plugin_paths(cfg
->plugin_paths
);
581 fprintf(stderr
, " Path: %s\n",
582 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
586 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
588 print_plugin_paths(cfg
->plugin_paths
);
589 fprintf(stderr
, " URL: %s\n",
590 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
594 void print_cfg_query(struct bt_config
*cfg
)
596 print_plugin_paths(cfg
->plugin_paths
);
597 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
598 fprintf(stderr
, " Component class:\n");
599 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
603 void print_cfg(struct bt_config
*cfg
)
605 if (!BT_LOG_ON_INFO
) {
609 BT_LOGI_STR("CLI configuration:");
611 switch (cfg
->command
) {
612 case BT_CONFIG_COMMAND_RUN
:
615 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
616 print_cfg_list_plugins(cfg
);
618 case BT_CONFIG_COMMAND_HELP
:
621 case BT_CONFIG_COMMAND_QUERY
:
622 print_cfg_query(cfg
);
624 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
625 print_cfg_print_ctf_metadata(cfg
);
627 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
628 print_cfg_print_lttng_live_sessions(cfg
);
636 void print_plugin_info(const bt_plugin
*plugin
)
638 unsigned int major
, minor
, patch
;
640 bt_property_availability version_avail
;
641 const char *plugin_name
;
645 const char *plugin_description
;
647 plugin_name
= bt_plugin_get_name(plugin
);
648 path
= bt_plugin_get_path(plugin
);
649 author
= bt_plugin_get_author(plugin
);
650 license
= bt_plugin_get_license(plugin
);
651 plugin_description
= bt_plugin_get_description(plugin
);
652 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
654 printf("%s%s%s%s:\n", bt_common_color_bold(),
655 bt_common_color_fg_blue(), plugin_name
,
656 bt_common_color_reset());
658 printf(" %sPath%s: %s\n", bt_common_color_bold(),
659 bt_common_color_reset(), path
);
664 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
665 printf(" %sVersion%s: %u.%u.%u",
666 bt_common_color_bold(), bt_common_color_reset(),
667 major
, minor
, patch
);
676 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
677 bt_common_color_reset(),
678 plugin_description
? plugin_description
: "(None)");
679 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
680 bt_common_color_reset(), author
? author
: "(Unknown)");
681 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
682 bt_common_color_reset(),
683 license
? license
: "(Unknown)");
687 int cmd_query(struct bt_config
*cfg
)
690 const bt_component_class
*comp_cls
= NULL
;
691 const bt_value
*results
= NULL
;
692 const char *fail_reason
= NULL
;
694 comp_cls
= find_component_class(
695 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
696 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
697 cfg
->cmd_data
.query
.cfg_component
->type
);
699 BT_CLI_LOGE_APPEND_CAUSE(
700 "Cannot find component class: plugin-name=\"%s\", "
701 "comp-cls-name=\"%s\", comp-cls-type=%d",
702 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
703 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
704 cfg
->cmd_data
.query
.cfg_component
->type
);
709 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
710 cfg
->cmd_data
.query
.cfg_component
->params
,
711 &results
, &fail_reason
);
716 print_value(stdout
, results
, 0);
720 BT_CLI_LOGE_APPEND_CAUSE(
721 "Failed to query component class: %s: plugin-name=\"%s\", "
722 "comp-cls-name=\"%s\", comp-cls-type=%d "
723 "object=\"%s\"", fail_reason
,
724 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
725 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
726 cfg
->cmd_data
.query
.cfg_component
->type
,
727 cfg
->cmd_data
.query
.object
->str
);
731 bt_component_class_put_ref(comp_cls
);
732 bt_value_put_ref(results
);
737 void print_component_class_help(const char *plugin_name
,
738 const bt_component_class
*comp_cls
)
740 const char *comp_class_name
=
741 bt_component_class_get_name(comp_cls
);
742 const char *comp_class_description
=
743 bt_component_class_get_description(comp_cls
);
744 const char *comp_class_help
=
745 bt_component_class_get_help(comp_cls
);
746 bt_component_class_type type
=
747 bt_component_class_get_type(comp_cls
);
749 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
751 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
752 bt_common_color_reset(),
753 comp_class_description
? comp_class_description
: "(None)");
755 if (comp_class_help
) {
756 printf("\n%s\n", comp_class_help
);
761 int cmd_help(struct bt_config
*cfg
)
764 const bt_plugin
*plugin
= NULL
;
765 const bt_component_class
*needed_comp_cls
= NULL
;
767 plugin
= find_loaded_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
769 BT_CLI_LOGE_APPEND_CAUSE(
770 "Cannot find plugin: plugin-name=\"%s\"",
771 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
776 print_plugin_info(plugin
);
777 printf(" %sSource component classes%s: %d\n",
778 bt_common_color_bold(),
779 bt_common_color_reset(),
780 (int) bt_plugin_get_source_component_class_count(plugin
));
781 printf(" %sFilter component classes%s: %d\n",
782 bt_common_color_bold(),
783 bt_common_color_reset(),
784 (int) bt_plugin_get_filter_component_class_count(plugin
));
785 printf(" %sSink component classes%s: %d\n",
786 bt_common_color_bold(),
787 bt_common_color_reset(),
788 (int) bt_plugin_get_sink_component_class_count(plugin
));
790 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
791 /* Plugin help only */
795 needed_comp_cls
= find_component_class(
796 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
797 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
798 cfg
->cmd_data
.help
.cfg_component
->type
);
799 if (!needed_comp_cls
) {
800 BT_CLI_LOGE_APPEND_CAUSE(
801 "Cannot find component class: plugin-name=\"%s\", "
802 "comp-cls-name=\"%s\", comp-cls-type=%d",
803 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
804 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
805 cfg
->cmd_data
.help
.cfg_component
->type
);
811 print_component_class_help(
812 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
816 bt_component_class_put_ref(needed_comp_cls
);
817 bt_plugin_put_ref(plugin
);
821 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
823 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
826 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
827 const char *cc_type_name
, uint64_t count
,
828 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
829 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
834 printf(" %s%s component classes%s: (none)\n",
835 bt_common_color_bold(),
837 bt_common_color_reset());
840 printf(" %s%s component classes%s:\n",
841 bt_common_color_bold(),
843 bt_common_color_reset());
846 for (i
= 0; i
< count
; i
++) {
847 const bt_component_class
*comp_class
=
848 spec_comp_cls_borrow_comp_cls_func(
849 borrow_comp_cls_by_index_func(plugin
, i
));
850 const char *comp_class_name
=
851 bt_component_class_get_name(comp_class
);
852 const char *comp_class_description
=
853 bt_component_class_get_description(comp_class
);
854 bt_component_class_type type
=
855 bt_component_class_get_type(comp_class
);
858 print_plugin_comp_cls_opt(stdout
,
859 bt_plugin_get_name(plugin
), comp_class_name
,
862 if (comp_class_description
) {
863 printf(": %s", comp_class_description
);
874 int cmd_list_plugins(struct bt_config
*cfg
)
877 int plugins_count
, component_classes_count
= 0, i
;
879 printf("From the following plugin paths:\n\n");
880 print_value(stdout
, cfg
->plugin_paths
, 2);
882 plugins_count
= get_loaded_plugins_count();
883 if (plugins_count
== 0) {
884 printf("No plugins found.\n");
888 for (i
= 0; i
< plugins_count
; i
++) {
889 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
891 component_classes_count
+=
892 bt_plugin_get_source_component_class_count(plugin
) +
893 bt_plugin_get_filter_component_class_count(plugin
) +
894 bt_plugin_get_sink_component_class_count(plugin
);
897 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
898 bt_common_color_bold(),
899 component_classes_count
,
900 bt_common_color_reset(),
901 bt_common_color_bold(),
903 bt_common_color_reset());
905 for (i
= 0; i
< plugins_count
; i
++) {
906 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
909 print_plugin_info(plugin
);
910 cmd_list_plugins_print_component_classes(plugin
, "Source",
911 bt_plugin_get_source_component_class_count(plugin
),
912 (plugin_borrow_comp_cls_by_index_func_t
)
913 bt_plugin_borrow_source_component_class_by_index_const
,
914 (spec_comp_cls_borrow_comp_cls_func_t
)
915 bt_component_class_source_as_component_class
);
916 cmd_list_plugins_print_component_classes(plugin
, "Filter",
917 bt_plugin_get_filter_component_class_count(plugin
),
918 (plugin_borrow_comp_cls_by_index_func_t
)
919 bt_plugin_borrow_filter_component_class_by_index_const
,
920 (spec_comp_cls_borrow_comp_cls_func_t
)
921 bt_component_class_filter_as_component_class
);
922 cmd_list_plugins_print_component_classes(plugin
, "Sink",
923 bt_plugin_get_sink_component_class_count(plugin
),
924 (plugin_borrow_comp_cls_by_index_func_t
)
925 bt_plugin_borrow_sink_component_class_by_index_const
,
926 (spec_comp_cls_borrow_comp_cls_func_t
)
927 bt_component_class_sink_as_component_class
);
935 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
938 const bt_component_class
*comp_cls
= NULL
;
939 const bt_value
*results
= NULL
;
940 bt_value
*params
= NULL
;
941 const bt_value
*map
= NULL
;
942 const bt_value
*v
= NULL
;
943 static const char * const plugin_name
= "ctf";
944 static const char * const comp_cls_name
= "lttng-live";
945 static const bt_component_class_type comp_cls_type
=
946 BT_COMPONENT_CLASS_TYPE_SOURCE
;
947 int64_t array_size
, i
;
948 const char *fail_reason
= NULL
;
949 FILE *out_stream
= stdout
;
951 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
952 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
955 BT_CLI_LOGE_APPEND_CAUSE(
956 "Cannot find component class: plugin-name=\"%s\", "
957 "comp-cls-name=\"%s\", comp-cls-type=%d",
958 plugin_name
, comp_cls_name
,
959 BT_COMPONENT_CLASS_TYPE_SOURCE
);
963 params
= bt_value_map_create();
968 ret
= bt_value_map_insert_string_entry(params
, "url",
969 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
974 ret
= query(cfg
, comp_cls
, "sessions", params
,
975 &results
, &fail_reason
);
982 if (!bt_value_is_array(results
)) {
983 BT_CLI_LOGE_APPEND_CAUSE(
984 "Expecting an array for LTTng live `sessions` query.");
988 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
990 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
994 BT_LOGE_ERRNO("Cannot open file for writing",
996 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
997 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
999 "Cannot open file for writing: path=\"%s\"",
1000 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1005 array_size
= bt_value_array_get_length(results
);
1006 for (i
= 0; i
< array_size
; i
++) {
1007 const char *url_text
;
1008 int64_t timer_us
, streams
, clients
;
1010 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1012 BT_CLI_LOGE_APPEND_CAUSE("Unexpected empty array entry.");
1015 if (!bt_value_is_map(map
)) {
1016 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
1020 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1022 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
1025 url_text
= bt_value_string_get(v
);
1026 fprintf(out_stream
, "%s", url_text
);
1027 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1029 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
1032 timer_us
= bt_value_integer_unsigned_get(v
);
1033 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1034 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1036 BT_CLI_LOGE_APPEND_CAUSE(
1037 "Missing `stream-count` entry.");
1040 streams
= bt_value_integer_unsigned_get(v
);
1041 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1042 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1044 BT_CLI_LOGE_APPEND_CAUSE(
1045 "Missing `client-count` entry.");
1048 clients
= bt_value_integer_unsigned_get(v
);
1049 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1055 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
1062 bt_value_put_ref(results
);
1063 bt_value_put_ref(params
);
1064 bt_component_class_put_ref(comp_cls
);
1066 if (out_stream
&& out_stream
!= stdout
) {
1067 int fclose_ret
= fclose(out_stream
);
1070 BT_LOGE_ERRNO("Cannot close file stream",
1072 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1080 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1083 const bt_component_class
*comp_cls
= NULL
;
1084 const bt_value
*results
= NULL
;
1085 bt_value
*params
= NULL
;
1086 const bt_value
*metadata_text_value
= NULL
;
1087 const char *metadata_text
= NULL
;
1088 static const char * const plugin_name
= "ctf";
1089 static const char * const comp_cls_name
= "fs";
1090 static const bt_component_class_type comp_cls_type
=
1091 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1092 const char *fail_reason
= NULL
;
1093 FILE *out_stream
= stdout
;
1095 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1096 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1099 BT_CLI_LOGE_APPEND_CAUSE(
1100 "Cannot find component class: plugin-name=\"%s\", "
1101 "comp-cls-name=\"%s\", comp-cls-type=%d",
1102 plugin_name
, comp_cls_name
,
1103 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1108 params
= bt_value_map_create();
1114 ret
= bt_value_map_insert_string_entry(params
, "path",
1115 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1121 ret
= query(cfg
, comp_cls
, "metadata-info",
1122 params
, &results
, &fail_reason
);
1127 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1129 if (!metadata_text_value
) {
1130 BT_CLI_LOGE_APPEND_CAUSE(
1131 "Cannot find `text` string value in the resulting metadata info object.");
1136 metadata_text
= bt_value_string_get(metadata_text_value
);
1138 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1140 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1143 BT_LOGE_ERRNO("Cannot open file for writing",
1145 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1146 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1148 "Cannot open file for writing: path=\"%s\"",
1149 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1155 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1157 BT_CLI_LOGE_APPEND_CAUSE(
1158 "Cannot write whole metadata text to output stream: "
1168 BT_CLI_LOGE_APPEND_CAUSE(
1169 "Failed to query `metadata-info` object: %s", fail_reason
);
1172 bt_value_put_ref(results
);
1173 bt_value_put_ref(params
);
1174 bt_component_class_put_ref(comp_cls
);
1176 if (out_stream
&& out_stream
!= stdout
) {
1177 int fclose_ret
= fclose(out_stream
);
1180 BT_LOGE_ERRNO("Cannot close file stream",
1182 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1190 char *instance_name
;
1194 struct trace_range
{
1195 uint64_t intersection_range_begin_ns
;
1196 uint64_t intersection_range_end_ns
;
1200 guint
port_id_hash(gconstpointer v
)
1202 const struct port_id
*id
= v
;
1204 BT_ASSERT(id
->instance_name
);
1205 BT_ASSERT(id
->port_name
);
1207 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1211 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1213 const struct port_id
*id1
= v1
;
1214 const struct port_id
*id2
= v2
;
1216 return strcmp(id1
->instance_name
, id2
->instance_name
) == 0 &&
1217 strcmp(id1
->port_name
, id2
->port_name
) == 0;
1221 void port_id_destroy(gpointer data
)
1223 struct port_id
*id
= data
;
1225 free(id
->instance_name
);
1226 free(id
->port_name
);
1231 void trace_range_destroy(gpointer data
)
1236 struct cmd_run_ctx
{
1238 GHashTable
*src_components
;
1241 GHashTable
*flt_components
;
1244 GHashTable
*sink_components
;
1250 struct bt_config
*cfg
;
1254 bool stream_intersection_mode
;
1257 * Association of struct port_id -> struct trace_range.
1259 GHashTable
*intersections
;
1262 /* Returns a timestamp of the form "(-)s.ns" */
1264 char *s_from_ns(int64_t ns
)
1269 int64_t ts_sec_abs
, ts_nsec_abs
;
1270 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1271 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1273 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1274 is_negative
= false;
1275 ts_sec_abs
= ts_sec
;
1276 ts_nsec_abs
= ts_nsec
;
1277 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1278 is_negative
= false;
1279 ts_sec_abs
= ts_sec
- 1;
1280 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1281 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1283 ts_sec_abs
= ts_sec
;
1284 ts_nsec_abs
= -ts_nsec
;
1285 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1287 ts_sec_abs
= -(ts_sec
+ 1);
1288 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1289 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1291 ts_sec_abs
= -ts_sec
;
1292 ts_nsec_abs
= ts_nsec
;
1293 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1295 ts_sec_abs
= -ts_sec
;
1296 ts_nsec_abs
= -ts_nsec
;
1299 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1300 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1308 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1309 struct cmd_run_ctx
*ctx
,
1310 const bt_component
*upstream_comp
,
1311 const bt_port_output
*out_upstream_port
,
1312 struct bt_config_connection
*cfg_conn
)
1314 typedef uint64_t (*input_port_count_func_t
)(void *);
1315 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1316 const void *, uint64_t);
1317 const bt_port
*upstream_port
=
1318 bt_port_output_as_port_const(out_upstream_port
);
1321 GQuark downstreamp_comp_name_quark
;
1322 void *downstream_comp
;
1323 uint64_t downstream_port_count
;
1325 input_port_count_func_t port_count_fn
;
1326 borrow_input_port_by_index_func_t port_by_index_fn
;
1327 bt_graph_connect_ports_status connect_ports_status
=
1328 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1329 bool insert_trimmer
= false;
1330 bt_value
*trimmer_params
= NULL
;
1331 char *intersection_begin
= NULL
;
1332 char *intersection_end
= NULL
;
1333 const bt_component_filter
*trimmer
= NULL
;
1334 const bt_component_class_filter
*trimmer_class
= NULL
;
1335 const bt_port_input
*trimmer_input
= NULL
;
1336 const bt_port_output
*trimmer_output
= NULL
;
1338 if (ctx
->intersections
&&
1339 bt_component_get_class_type(upstream_comp
) ==
1340 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1341 struct trace_range
*range
;
1342 struct port_id port_id
= {
1343 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1344 .port_name
= (char *) bt_port_get_name(upstream_port
)
1347 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1351 range
= (struct trace_range
*) g_hash_table_lookup(
1352 ctx
->intersections
, &port_id
);
1354 bt_value_map_insert_entry_status insert_status
;
1356 intersection_begin
= s_from_ns(
1357 range
->intersection_range_begin_ns
);
1358 intersection_end
= s_from_ns(
1359 range
->intersection_range_end_ns
);
1360 if (!intersection_begin
|| !intersection_end
) {
1361 BT_CLI_LOGE_APPEND_CAUSE(
1362 "Cannot create trimmer argument timestamp string.");
1366 insert_trimmer
= true;
1367 trimmer_params
= bt_value_map_create();
1368 if (!trimmer_params
) {
1372 insert_status
= bt_value_map_insert_string_entry(
1373 trimmer_params
, "begin", intersection_begin
);
1374 if (insert_status
< 0) {
1377 insert_status
= bt_value_map_insert_string_entry(
1379 "end", intersection_end
);
1380 if (insert_status
< 0) {
1385 trimmer_class
= find_filter_component_class("utils", "trimmer");
1386 if (!trimmer_class
) {
1391 BT_LOGI("Connecting upstream port to the next available downstream port: "
1392 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1393 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1394 upstream_port
, bt_port_get_name(upstream_port
),
1395 cfg_conn
->downstream_comp_name
->str
,
1396 cfg_conn
->arg
->str
);
1397 downstreamp_comp_name_quark
= g_quark_from_string(
1398 cfg_conn
->downstream_comp_name
->str
);
1399 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1400 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1401 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1402 port_count_fn
= (input_port_count_func_t
)
1403 bt_component_filter_get_input_port_count
;
1404 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1405 bt_component_filter_borrow_input_port_by_index_const
;
1407 if (!downstream_comp
) {
1408 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1409 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1410 port_count_fn
= (input_port_count_func_t
)
1411 bt_component_sink_get_input_port_count
;
1412 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1413 bt_component_sink_borrow_input_port_by_index_const
;
1416 if (!downstream_comp
) {
1417 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1418 "comp-name=\"%s\", conn-arg=\"%s\"",
1419 cfg_conn
->downstream_comp_name
->str
,
1420 cfg_conn
->arg
->str
);
1424 downstream_port_count
= port_count_fn(downstream_comp
);
1426 for (i
= 0; i
< downstream_port_count
; i
++) {
1427 const bt_port_input
*in_downstream_port
=
1428 port_by_index_fn(downstream_comp
, i
);
1429 const bt_port
*downstream_port
=
1430 bt_port_input_as_port_const(in_downstream_port
);
1431 const char *upstream_port_name
;
1432 const char *downstream_port_name
;
1434 BT_ASSERT(downstream_port
);
1436 /* Skip port if it's already connected. */
1437 if (bt_port_is_connected(downstream_port
)) {
1438 BT_LOGI("Skipping downstream port: already connected: "
1439 "port-addr=%p, port-name=\"%s\"",
1441 bt_port_get_name(downstream_port
));
1445 downstream_port_name
= bt_port_get_name(downstream_port
);
1446 BT_ASSERT(downstream_port_name
);
1447 upstream_port_name
= bt_port_get_name(upstream_port
);
1448 BT_ASSERT(upstream_port_name
);
1450 if (!bt_common_star_glob_match(
1451 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1452 downstream_port_name
, SIZE_MAX
)) {
1456 if (insert_trimmer
) {
1458 * In order to insert the trimmer between the
1459 * two components that were being connected, we
1460 * create a connection configuration entry which
1461 * describes a connection from the trimmer's
1462 * output to the original input that was being
1465 * Hence, the creation of the trimmer will cause
1466 * the graph "new port" listener to establish
1467 * all downstream connections as its output port
1468 * is connected. We will then establish the
1469 * connection between the original upstream
1470 * source and the trimmer.
1472 char *trimmer_name
= NULL
;
1473 bt_graph_add_component_status add_comp_status
;
1475 ret
= asprintf(&trimmer_name
,
1476 "stream-intersection-trimmer-%s",
1477 upstream_port_name
);
1483 ctx
->connect_ports
= false;
1484 add_comp_status
= bt_graph_add_filter_component(
1485 ctx
->graph
, trimmer_class
, trimmer_name
,
1486 trimmer_params
, ctx
->cfg
->log_level
,
1489 if (add_comp_status
!=
1490 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1496 bt_component_filter_borrow_input_port_by_index_const(
1498 if (!trimmer_input
) {
1502 bt_component_filter_borrow_output_port_by_index_const(
1504 if (!trimmer_output
) {
1509 * Replace the current downstream port by the trimmer's
1512 in_downstream_port
= trimmer_input
;
1514 bt_port_input_as_port_const(in_downstream_port
);
1515 downstream_port_name
= bt_port_get_name(
1517 BT_ASSERT(downstream_port_name
);
1520 /* We have a winner! */
1521 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1522 out_upstream_port
, in_downstream_port
, NULL
);
1523 downstream_port
= NULL
;
1524 switch (connect_ports_status
) {
1525 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1528 BT_CLI_LOGE_APPEND_CAUSE(
1529 "Cannot create connection: graph refuses to connect ports: "
1530 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1531 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1532 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1533 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1535 upstream_comp
, bt_component_get_name(upstream_comp
),
1536 upstream_port
, bt_port_get_name(upstream_port
),
1537 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1538 downstream_port
, downstream_port_name
,
1539 cfg_conn
->arg
->str
);
1543 BT_LOGI("Connected component ports: "
1544 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1545 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1546 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1547 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1549 upstream_comp
, bt_component_get_name(upstream_comp
),
1550 upstream_port
, bt_port_get_name(upstream_port
),
1551 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1552 downstream_port
, downstream_port_name
,
1553 cfg_conn
->arg
->str
);
1555 if (insert_trimmer
) {
1557 * The first connection, from the source to the trimmer,
1558 * has been done. We now connect the trimmer to the
1559 * original downstream port.
1561 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1563 bt_component_filter_as_component_const(trimmer
),
1564 trimmer_output
, cfg_conn
);
1568 ctx
->connect_ports
= true;
1572 * We found a matching downstream port: the search is
1578 /* No downstream port found */
1579 BT_CLI_LOGE_APPEND_CAUSE(
1580 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1581 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1582 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1583 upstream_port
, bt_port_get_name(upstream_port
),
1584 cfg_conn
->downstream_comp_name
->str
,
1585 cfg_conn
->arg
->str
);
1591 free(intersection_begin
);
1592 free(intersection_end
);
1593 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1594 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1595 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1600 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1601 const bt_port_output
*upstream_port
)
1604 const char *upstream_port_name
;
1605 const char *upstream_comp_name
;
1606 const bt_component
*upstream_comp
= NULL
;
1610 BT_ASSERT(upstream_port
);
1611 upstream_port_name
= bt_port_get_name(
1612 bt_port_output_as_port_const(upstream_port
));
1613 BT_ASSERT(upstream_port_name
);
1614 upstream_comp
= bt_port_borrow_component_const(
1615 bt_port_output_as_port_const(upstream_port
));
1616 BT_ASSERT(upstream_comp
);
1617 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1618 BT_ASSERT(upstream_comp_name
);
1619 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1620 "port-addr=%p, port-name=\"%s\"",
1621 upstream_comp
, upstream_comp_name
,
1622 upstream_port
, upstream_port_name
);
1624 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1625 struct bt_config_connection
*cfg_conn
=
1627 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1629 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1630 upstream_comp_name
)) {
1634 if (!bt_common_star_glob_match(
1635 cfg_conn
->upstream_port_glob
->str
,
1636 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1640 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1641 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1643 BT_CLI_LOGE_APPEND_CAUSE(
1644 "Cannot connect upstream port: "
1645 "port-addr=%p, port-name=\"%s\"",
1647 upstream_port_name
);
1653 BT_CLI_LOGE_APPEND_CAUSE(
1654 "Cannot connect upstream port: port does not match any connection argument: "
1655 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1656 upstream_port_name
);
1666 bt_graph_listener_func_status
1667 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1668 const bt_port_output
*out_port
)
1670 const bt_component
*comp
;
1671 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1672 bt_graph_listener_func_status ret
=
1673 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
1675 comp
= bt_port_borrow_component_const(port
);
1676 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1677 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1678 comp
, comp
? bt_component_get_name(comp
) : "",
1679 port
, bt_port_get_name(port
));
1681 if (!ctx
->connect_ports
) {
1687 if (bt_port_is_connected(port
)) {
1688 BT_LOGW_STR("Port is already connected.");
1692 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
1693 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1694 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
1703 bt_graph_listener_func_status
graph_source_output_port_added_listener(
1704 const bt_component_source
*component
,
1705 const bt_port_output
*port
, void *data
)
1707 return graph_output_port_added_listener(data
, port
);
1711 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
1712 const bt_component_filter
*component
,
1713 const bt_port_output
*port
, void *data
)
1715 return graph_output_port_added_listener(data
, port
);
1719 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1725 if (ctx
->src_components
) {
1726 g_hash_table_destroy(ctx
->src_components
);
1727 ctx
->src_components
= NULL
;
1730 if (ctx
->flt_components
) {
1731 g_hash_table_destroy(ctx
->flt_components
);
1732 ctx
->flt_components
= NULL
;
1735 if (ctx
->sink_components
) {
1736 g_hash_table_destroy(ctx
->sink_components
);
1737 ctx
->sink_components
= NULL
;
1740 if (ctx
->intersections
) {
1741 g_hash_table_destroy(ctx
->intersections
);
1742 ctx
->intersections
= NULL
;
1745 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
1750 int add_descriptor_to_component_descriptor_set(
1751 bt_component_descriptor_set
*comp_descr_set
,
1752 const char *plugin_name
, const char *comp_cls_name
,
1753 bt_component_class_type comp_cls_type
,
1754 const bt_value
*params
)
1756 const bt_component_class
*comp_cls
;
1759 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1762 BT_CLI_LOGE_APPEND_CAUSE(
1763 "Cannot find component class: plugin-name=\"%s\", "
1764 "comp-cls-name=\"%s\", comp-cls-type=%d",
1765 plugin_name
, comp_cls_name
, comp_cls_type
);
1770 status
= bt_component_descriptor_set_add_descriptor(
1771 comp_descr_set
, comp_cls
, params
);
1772 if (status
!= BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK
) {
1773 BT_CLI_LOGE_APPEND_CAUSE(
1774 "Cannot append descriptor to component descriptor set: "
1775 "status=%s", bt_common_func_status_string(status
));
1780 bt_component_class_put_ref(comp_cls
);
1785 int append_descriptors_from_bt_config_component_array(
1786 bt_component_descriptor_set
*comp_descr_set
,
1787 GPtrArray
*component_configs
)
1792 for (i
= 0; i
< component_configs
->len
; i
++) {
1793 struct bt_config_component
*cfg_comp
=
1794 component_configs
->pdata
[i
];
1796 ret
= add_descriptor_to_component_descriptor_set(
1798 cfg_comp
->plugin_name
->str
,
1799 cfg_comp
->comp_cls_name
->str
,
1800 cfg_comp
->type
, cfg_comp
->params
);
1811 bt_get_greatest_operative_mip_version_status
get_greatest_operative_mip_version(
1812 struct bt_config
*cfg
, uint64_t *mip_version
)
1814 bt_get_greatest_operative_mip_version_status status
=
1815 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
;
1816 bt_component_descriptor_set
*comp_descr_set
= NULL
;
1820 BT_ASSERT(mip_version
);
1821 comp_descr_set
= bt_component_descriptor_set_create();
1822 if (!comp_descr_set
) {
1823 BT_CLI_LOGE_APPEND_CAUSE(
1824 "Failed to create a component descriptor set object.");
1825 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR
;
1829 ret
= append_descriptors_from_bt_config_component_array(
1830 comp_descr_set
, cfg
->cmd_data
.run
.sources
);
1832 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1836 ret
= append_descriptors_from_bt_config_component_array(
1837 comp_descr_set
, cfg
->cmd_data
.run
.filters
);
1839 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1843 ret
= append_descriptors_from_bt_config_component_array(
1844 comp_descr_set
, cfg
->cmd_data
.run
.sinks
);
1846 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1850 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1852 * Stream intersection mode adds `flt.utils.trimmer`
1853 * components; we need to include this type of component
1854 * in the component descriptor set to get the real
1855 * greatest operative MIP version.
1857 ret
= add_descriptor_to_component_descriptor_set(
1858 comp_descr_set
, "utils", "trimmer",
1859 BT_COMPONENT_CLASS_TYPE_FILTER
, NULL
);
1861 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1866 status
= bt_get_greatest_operative_mip_version(comp_descr_set
,
1867 bt_cli_log_level
, mip_version
);
1870 bt_component_descriptor_set_put_ref(comp_descr_set
);
1875 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1878 bt_graph_add_listener_status add_listener_status
;
1879 bt_get_greatest_operative_mip_version_status mip_version_status
;
1880 uint64_t mip_version
= UINT64_C(-1);
1883 ctx
->connect_ports
= false;
1884 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
1885 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1886 if (!ctx
->src_components
) {
1890 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
1891 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1892 if (!ctx
->flt_components
) {
1896 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
1897 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1898 if (!ctx
->sink_components
) {
1902 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1903 ctx
->stream_intersection_mode
= true;
1904 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
1905 port_id_equal
, port_id_destroy
, trace_range_destroy
);
1906 if (!ctx
->intersections
) {
1912 * Get the greatest operative MIP version to use to configure
1913 * the graph to create.
1915 mip_version_status
= get_greatest_operative_mip_version(
1917 if (mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH
) {
1918 BT_CLI_LOGE_APPEND_CAUSE(
1919 "Failed to find an operative message interchange "
1920 "protocol version to use to create the `run` command's "
1921 "graph (components are not interoperable).");
1923 } else if (mip_version_status
< 0) {
1924 BT_CLI_LOGE_APPEND_CAUSE(
1925 "Cannot find an operative message interchange "
1926 "protocol version to use to create the `run` command's "
1928 bt_common_func_status_string(mip_version_status
));
1932 BT_ASSERT(mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
);
1933 BT_LOGI("Found operative message interchange protocol version to "
1934 "configure the `run` command's graph: mip-version=%" PRIu64
,
1936 ctx
->graph
= bt_graph_create(mip_version
);
1941 bt_graph_add_interrupter(ctx
->graph
, the_interrupter
);
1942 add_listener_status
= bt_graph_add_source_component_output_port_added_listener(
1943 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
1945 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1946 BT_CLI_LOGE_APPEND_CAUSE(
1947 "Cannot add \"port added\" listener to graph.");
1951 add_listener_status
= bt_graph_add_filter_component_output_port_added_listener(
1952 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
1954 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1955 BT_CLI_LOGE_APPEND_CAUSE(
1956 "Cannot add \"port added\" listener to graph.");
1963 cmd_run_ctx_destroy(ctx
);
1971 * Compute the intersection of all streams in the array `streams`, write it
1976 int compute_stream_intersection(const bt_value
*streams
,
1977 struct trace_range
*range
)
1980 unsigned int stream_count
;
1983 BT_ASSERT(bt_value_get_type(streams
) == BT_VALUE_TYPE_ARRAY
);
1985 stream_count
= bt_value_array_get_length(streams
);
1987 BT_ASSERT(stream_count
> 0);
1989 range
->intersection_range_begin_ns
= 0;
1990 range
->intersection_range_end_ns
= UINT64_MAX
;
1992 for (i
= 0; i
< stream_count
; i
++) {
1993 int64_t begin_ns
, end_ns
;
1994 uint64_t begin_ns_u
, end_ns_u
;
1995 const bt_value
*stream_value
;
1996 const bt_value
*range_ns_value
;
1997 const bt_value
*begin_value
;
1998 const bt_value
*end_value
;
2000 stream_value
= bt_value_array_borrow_element_by_index_const(streams
, i
);
2001 if (bt_value_get_type(stream_value
) != BT_VALUE_TYPE_MAP
) {
2002 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2003 "expected streams array element to be a map, got %s.",
2004 bt_common_value_type_string(bt_value_get_type(stream_value
)));
2008 range_ns_value
= bt_value_map_borrow_entry_value_const(
2009 stream_value
, "range-ns");
2010 if (!range_ns_value
) {
2011 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2012 "missing expected `range-ns` key in stream map.");
2016 if (bt_value_get_type(range_ns_value
) != BT_VALUE_TYPE_MAP
) {
2017 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2018 "expected `range-ns` entry value of stream map to be a map, got %s.",
2019 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2023 begin_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "begin");
2025 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2026 "missing expected `begin` key in range-ns map.");
2030 if (bt_value_get_type(begin_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2031 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2032 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
2033 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2037 end_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "end");
2039 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2040 "missing expected `end` key in range-ns map.");
2044 if (bt_value_get_type(end_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2045 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2046 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
2047 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2051 begin_ns
= bt_value_integer_signed_get(begin_value
);
2052 end_ns
= bt_value_integer_signed_get(end_value
);
2054 if (begin_ns
< 0 || end_ns
< 0 || end_ns
< begin_ns
) {
2055 BT_CLI_LOGE_APPEND_CAUSE(
2056 "Invalid stream range values: "
2057 "range-ns:begin=%" PRId64
", "
2058 "range-ns:end=%" PRId64
,
2063 begin_ns_u
= begin_ns
;
2066 range
->intersection_range_begin_ns
=
2067 MAX(range
->intersection_range_begin_ns
, begin_ns_u
);
2068 range
->intersection_range_end_ns
=
2069 MIN(range
->intersection_range_end_ns
, end_ns_u
);
2082 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2083 struct bt_config_component
*cfg_comp
,
2084 const bt_component_class_source
*src_comp_cls
)
2088 int64_t trace_count
;
2089 const bt_value
*query_result
= NULL
;
2090 const bt_value
*trace_info
= NULL
;
2091 const bt_value
*stream_infos
= NULL
;
2092 const bt_value
*stream_info
= NULL
;
2093 struct port_id
*port_id
= NULL
;
2094 struct trace_range
*stream_intersection
= NULL
;
2095 const char *fail_reason
= NULL
;
2096 const bt_component_class
*comp_cls
=
2097 bt_component_class_source_as_component_class_const(src_comp_cls
);
2099 ret
= query(ctx
->cfg
, comp_cls
, "babeltrace.trace-infos",
2100 cfg_comp
->params
, &query_result
,
2103 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2104 "comp-class-name=\"%s\"", fail_reason
,
2105 bt_component_class_get_name(comp_cls
));
2110 BT_ASSERT(query_result
);
2112 if (!bt_value_is_array(query_result
)) {
2113 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2114 "component-class-name=%s, actual-type=%s",
2115 bt_component_class_get_name(comp_cls
),
2116 bt_common_value_type_string(bt_value_get_type(query_result
)));
2121 trace_count
= bt_value_array_get_length(query_result
);
2122 if (trace_count
< 0) {
2123 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2124 "component-class-name=%s", bt_component_class_get_name(comp_cls
));
2129 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2130 uint64_t stream_idx
;
2131 int64_t stream_count
;
2132 struct trace_range trace_intersection
;
2134 trace_info
= bt_value_array_borrow_element_by_index_const(
2135 query_result
, trace_idx
);
2136 BT_ASSERT(trace_info
);
2137 if (!bt_value_is_map(trace_info
)) {
2139 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2140 "component-class-name=%s, actual-type=%s",
2141 bt_component_class_get_name(comp_cls
),
2142 bt_common_value_type_string(bt_value_get_type(trace_info
)));
2146 stream_infos
= bt_value_map_borrow_entry_value_const(
2147 trace_info
, "stream-infos");
2148 if (!stream_infos
) {
2150 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2151 "component-class-name=%s",
2152 bt_component_class_get_name(comp_cls
));
2156 if (!bt_value_is_array(stream_infos
)) {
2158 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2159 "component-class-name=%s, actual-type=%s",
2160 bt_component_class_get_name(comp_cls
),
2161 bt_common_value_type_string(bt_value_get_type(stream_infos
)));
2165 stream_count
= bt_value_array_get_length(stream_infos
);
2166 if (stream_count
< 0) {
2168 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2169 "component-class-name=%s",
2170 bt_component_class_get_name(comp_cls
));
2174 ret
= compute_stream_intersection(stream_infos
, &trace_intersection
);
2176 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2180 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2181 const bt_value
*port_name
;
2183 port_id
= g_new0(struct port_id
, 1);
2186 BT_CLI_LOGE_APPEND_CAUSE(
2187 "Cannot allocate memory for port_id structure.");
2190 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2191 if (!port_id
->instance_name
) {
2193 BT_CLI_LOGE_APPEND_CAUSE(
2194 "Cannot allocate memory for port_id component instance name.");
2198 stream_intersection
= g_new0(struct trace_range
, 1);
2199 if (!stream_intersection
) {
2201 BT_CLI_LOGE_APPEND_CAUSE(
2202 "Cannot allocate memory for trace_range structure.");
2206 *stream_intersection
= trace_intersection
;
2208 stream_info
= bt_value_array_borrow_element_by_index_const(
2209 stream_infos
, stream_idx
);
2210 BT_ASSERT(stream_info
);
2211 if (!bt_value_is_map(stream_info
)) {
2213 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2214 "expecting element of stream list to be a map: "
2215 "component-class-name=%s, actual-type=%s",
2216 bt_component_class_get_name(comp_cls
),
2217 bt_common_value_type_string(bt_value_get_type(stream_info
)));
2221 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2224 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2225 "missing `port-name` key in stream info map: "
2226 "component-class-name=%s",
2227 bt_component_class_get_name(comp_cls
));
2231 if (!bt_value_is_string(port_name
)) {
2233 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2234 "expecting `port-name` entry of stream info map to be a string: "
2235 "component-class-name=%s, actual-type=%s",
2236 bt_component_class_get_name(comp_cls
),
2237 bt_common_value_type_string(bt_value_get_type(port_name
)));
2241 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2242 if (!port_id
->port_name
) {
2244 BT_CLI_LOGE_APPEND_CAUSE(
2245 "Cannot allocate memory for port_id port_name.");
2249 BT_LOGD("Inserting stream intersection ");
2251 g_hash_table_insert(ctx
->intersections
, port_id
, stream_intersection
);
2254 stream_intersection
= NULL
;
2261 bt_value_put_ref(query_result
);
2263 g_free(stream_intersection
);
2268 int cmd_run_ctx_create_components_from_config_components(
2269 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2272 const void *comp_cls
= NULL
;
2273 const void *comp
= NULL
;
2276 for (i
= 0; i
< cfg_components
->len
; i
++) {
2277 struct bt_config_component
*cfg_comp
=
2278 g_ptr_array_index(cfg_components
, i
);
2281 switch (cfg_comp
->type
) {
2282 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2283 comp_cls
= find_source_component_class(
2284 cfg_comp
->plugin_name
->str
,
2285 cfg_comp
->comp_cls_name
->str
);
2287 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2288 comp_cls
= find_filter_component_class(
2289 cfg_comp
->plugin_name
->str
,
2290 cfg_comp
->comp_cls_name
->str
);
2292 case BT_COMPONENT_CLASS_TYPE_SINK
:
2293 comp_cls
= find_sink_component_class(
2294 cfg_comp
->plugin_name
->str
,
2295 cfg_comp
->comp_cls_name
->str
);
2302 BT_CLI_LOGE_APPEND_CAUSE(
2303 "Cannot find component class: plugin-name=\"%s\", "
2304 "comp-cls-name=\"%s\", comp-cls-type=%d",
2305 cfg_comp
->plugin_name
->str
,
2306 cfg_comp
->comp_cls_name
->str
,
2311 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_TRACE
);
2313 switch (cfg_comp
->type
) {
2314 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2315 ret
= bt_graph_add_source_component(ctx
->graph
,
2316 comp_cls
, cfg_comp
->instance_name
->str
,
2317 cfg_comp
->params
, cfg_comp
->log_level
,
2320 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2321 ret
= bt_graph_add_filter_component(ctx
->graph
,
2322 comp_cls
, cfg_comp
->instance_name
->str
,
2323 cfg_comp
->params
, cfg_comp
->log_level
,
2326 case BT_COMPONENT_CLASS_TYPE_SINK
:
2327 ret
= bt_graph_add_sink_component(ctx
->graph
,
2328 comp_cls
, cfg_comp
->instance_name
->str
,
2329 cfg_comp
->params
, cfg_comp
->log_level
,
2337 BT_CLI_LOGE_APPEND_CAUSE(
2338 "Cannot create component: plugin-name=\"%s\", "
2339 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2341 cfg_comp
->plugin_name
->str
,
2342 cfg_comp
->comp_cls_name
->str
,
2343 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2347 if (ctx
->stream_intersection_mode
&&
2348 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2349 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2351 BT_CLI_LOGE_APPEND_CAUSE(
2352 "Cannot determine stream intersection of trace.");
2357 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2358 comp
, cfg_comp
->instance_name
->str
);
2359 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2360 BT_ASSERT(quark
> 0);
2362 switch (cfg_comp
->type
) {
2363 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2364 g_hash_table_insert(ctx
->src_components
,
2365 GUINT_TO_POINTER(quark
), (void *) comp
);
2367 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2368 g_hash_table_insert(ctx
->flt_components
,
2369 GUINT_TO_POINTER(quark
), (void *) comp
);
2371 case BT_COMPONENT_CLASS_TYPE_SINK
:
2372 g_hash_table_insert(ctx
->sink_components
,
2373 GUINT_TO_POINTER(quark
), (void *) comp
);
2380 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2389 bt_object_put_ref(comp
);
2390 bt_object_put_ref(comp_cls
);
2395 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2400 * Make sure that, during this phase, our graph's "port added"
2401 * listener does not connect ports while we are creating the
2402 * components because we have a special, initial phase for
2405 ctx
->connect_ports
= false;
2407 ret
= cmd_run_ctx_create_components_from_config_components(
2408 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2414 ret
= cmd_run_ctx_create_components_from_config_components(
2415 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2421 ret
= cmd_run_ctx_create_components_from_config_components(
2422 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2432 typedef uint64_t (*output_port_count_func_t
)(const void *);
2433 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2434 const void *, uint64_t);
2437 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2438 void *comp
, output_port_count_func_t port_count_fn
,
2439 borrow_output_port_by_index_func_t port_by_index_fn
)
2445 count
= port_count_fn(comp
);
2447 for (i
= 0; i
< count
; i
++) {
2448 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2450 BT_ASSERT(upstream_port
);
2451 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2462 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2465 GHashTableIter iter
;
2466 gpointer g_name_quark
, g_comp
;
2468 ctx
->connect_ports
= true;
2469 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2471 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2472 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2473 (output_port_count_func_t
)
2474 bt_component_source_get_output_port_count
,
2475 (borrow_output_port_by_index_func_t
)
2476 bt_component_source_borrow_output_port_by_index_const
);
2482 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2484 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2485 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2486 (output_port_count_func_t
)
2487 bt_component_filter_get_output_port_count
,
2488 (borrow_output_port_by_index_func_t
)
2489 bt_component_filter_borrow_output_port_by_index_const
);
2500 int cmd_run(struct bt_config
*cfg
)
2503 struct cmd_run_ctx ctx
= { 0 };
2505 /* Initialize the command's context and the graph object */
2506 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2507 BT_CLI_LOGE_APPEND_CAUSE(
2508 "Cannot initialize the command's context.");
2512 if (bt_interrupter_is_set(the_interrupter
)) {
2513 BT_CLI_LOGW_APPEND_CAUSE(
2514 "Interrupted by user before creating components.");
2518 BT_LOGI_STR("Creating components.");
2520 /* Create the requested component instances */
2521 if (cmd_run_ctx_create_components(&ctx
)) {
2522 BT_CLI_LOGE_APPEND_CAUSE("Cannot create components.");
2526 if (bt_interrupter_is_set(the_interrupter
)) {
2527 BT_CLI_LOGW_APPEND_CAUSE(
2528 "Interrupted by user before connecting components.");
2532 BT_LOGI_STR("Connecting components.");
2534 /* Connect the initially visible component ports */
2535 if (cmd_run_ctx_connect_ports(&ctx
)) {
2536 BT_CLI_LOGE_APPEND_CAUSE(
2537 "Cannot connect initial component ports.");
2541 BT_LOGI_STR("Running the graph.");
2545 bt_graph_run_status run_status
= bt_graph_run(ctx
.graph
);
2548 * Reset console in case something messed with console
2549 * codes during the graph's execution.
2551 printf("%s", bt_common_color_reset());
2553 fprintf(stderr
, "%s", bt_common_color_reset());
2554 BT_LOGT("bt_graph_run() returned: status=%s",
2555 bt_common_func_status_string(run_status
));
2557 switch (run_status
) {
2558 case BT_GRAPH_RUN_STATUS_OK
:
2560 case BT_GRAPH_RUN_STATUS_AGAIN
:
2561 if (bt_interrupter_is_set(the_interrupter
)) {
2562 BT_CLI_LOGW_APPEND_CAUSE(
2563 "Graph was interrupted by user.");
2567 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2568 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2570 cfg
->cmd_data
.run
.retry_duration_us
);
2572 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2573 if (bt_interrupter_is_set(the_interrupter
)) {
2574 BT_CLI_LOGW_APPEND_CAUSE(
2575 "Graph was interrupted by user.");
2581 case BT_GRAPH_RUN_STATUS_END
:
2584 if (bt_interrupter_is_set(the_interrupter
)) {
2585 BT_CLI_LOGW_APPEND_CAUSE(
2586 "Graph was interrupted by user and failed: "
2588 bt_common_func_status_string(run_status
));
2592 BT_CLI_LOGE_APPEND_CAUSE(
2593 "Graph failed to complete successfully");
2606 cmd_run_ctx_destroy(&ctx
);
2611 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2613 const char *env_clash
;
2615 if (!cfg
->command_name
) {
2619 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2620 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2624 if (g_file_test(cfg
->command_name
,
2625 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2626 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION
, __FILE__
, __LINE__
,
2627 BT_LOG_WARNING
, BT_LOG_TAG
,
2628 "The `%s` command was executed. "
2629 "If you meant to convert a trace located in "
2630 "the local `%s` directory, please use:\n\n"
2631 " babeltrace2 convert %s [OPTIONS]",
2632 cfg
->command_name
, cfg
->command_name
,
2638 void init_log_level(void)
2640 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2644 void print_error_causes(void)
2646 const bt_error
*error
= bt_current_thread_take_error();
2648 GString
*folded
= NULL
;
2649 unsigned int columns
;
2651 if (!error
|| bt_error_get_cause_count(error
) == 0) {
2652 fprintf(stderr
, "%s%sUnknown command-line error.%s\n",
2653 bt_common_color_bold(), bt_common_color_fg_red(),
2654 bt_common_color_reset());
2658 /* Try to get terminal width to fold the error cause messages */
2659 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
2660 /* Width not found: default to 80 */
2665 * This helps visually separate the error causes from the last
2666 * logging statement.
2668 fprintf(stderr
, "\n");
2670 /* Reverse order: deepest (root) cause printed at the end */
2671 for (i
= bt_error_get_cause_count(error
) - 1; i
>= 0; i
--) {
2672 const bt_error_cause
*cause
=
2673 bt_error_borrow_cause_by_index(error
, (uint64_t) i
);
2674 const char *prefix_fmt
=
2675 i
== bt_error_get_cause_count(error
) - 1 ?
2676 "%s%sERROR%s: " : "%s%sCAUSED BY%s ";
2679 fprintf(stderr
, prefix_fmt
,
2680 bt_common_color_bold(), bt_common_color_fg_red(),
2681 bt_common_color_reset());
2683 /* Print actor name */
2684 fprintf(stderr
, "[");
2685 switch (bt_error_cause_get_actor_type(cause
)) {
2686 case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN
:
2687 fprintf(stderr
, "%s%s%s",
2688 bt_common_color_bold(),
2689 bt_error_cause_get_module_name(cause
),
2690 bt_common_color_reset());
2692 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT
:
2693 fprintf(stderr
, "%s%s%s: ",
2694 bt_common_color_bold(),
2695 bt_error_cause_component_actor_get_component_name(cause
),
2696 bt_common_color_reset());
2697 print_plugin_comp_cls_opt(stderr
,
2698 bt_error_cause_component_actor_get_plugin_name(cause
),
2699 bt_error_cause_component_actor_get_component_class_name(cause
),
2700 bt_error_cause_component_actor_get_component_class_type(cause
));
2702 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS
:
2703 print_plugin_comp_cls_opt(stderr
,
2704 bt_error_cause_component_class_actor_get_plugin_name(cause
),
2705 bt_error_cause_component_class_actor_get_component_class_name(cause
),
2706 bt_error_cause_component_class_actor_get_component_class_type(cause
));
2708 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR
:
2709 fprintf(stderr
, "%s%s%s (%s%s%s): ",
2710 bt_common_color_bold(),
2711 bt_error_cause_message_iterator_actor_get_component_name(cause
),
2712 bt_common_color_reset(),
2713 bt_common_color_bold(),
2714 bt_error_cause_message_iterator_actor_get_component_output_port_name(cause
),
2715 bt_common_color_reset());
2716 print_plugin_comp_cls_opt(stderr
,
2717 bt_error_cause_message_iterator_actor_get_plugin_name(cause
),
2718 bt_error_cause_message_iterator_actor_get_component_class_name(cause
),
2719 bt_error_cause_message_iterator_actor_get_component_class_type(cause
));
2725 /* Print file name and line number */
2726 fprintf(stderr
, "] (%s%s%s%s:%s%" PRIu64
"%s)\n",
2727 bt_common_color_bold(),
2728 bt_common_color_fg_magenta(),
2729 bt_error_cause_get_file_name(cause
),
2730 bt_common_color_reset(),
2731 bt_common_color_fg_green(),
2732 bt_error_cause_get_line_number(cause
),
2733 bt_common_color_reset());
2736 folded
= bt_common_fold(bt_error_cause_get_message(cause
),
2739 BT_LOGE_STR("Could not fold string.");
2740 fprintf(stderr
, "%s\n",
2741 bt_error_cause_get_message(cause
));
2745 fprintf(stderr
, "%s\n", folded
->str
);
2746 g_string_free(folded
, TRUE
);
2754 bt_error_release(error
);
2758 int main(int argc
, const char **argv
)
2762 struct bt_config
*cfg
= NULL
;
2765 set_signal_handler();
2766 init_loaded_plugins();
2768 BT_ASSERT(!the_interrupter
);
2769 the_interrupter
= bt_interrupter_create();
2770 if (!the_interrupter
) {
2771 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2776 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
,
2780 /* Quit without errors; typically usage/version */
2782 BT_LOGI_STR("Quitting without errors.");
2787 BT_CLI_LOGE_APPEND_CAUSE(
2788 "Command-line error: retcode=%d", retcode
);
2793 BT_CLI_LOGE_APPEND_CAUSE(
2794 "Failed to create a valid Babeltrace CLI configuration.");
2801 if (cfg
->command_needs_plugins
) {
2802 ret
= require_loaded_plugins(cfg
->plugin_paths
);
2804 BT_CLI_LOGE_APPEND_CAUSE(
2805 "Failed to load plugins: ret=%d", ret
);
2811 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2812 cfg
->command
, cfg
->command_name
);
2814 switch (cfg
->command
) {
2815 case BT_CONFIG_COMMAND_RUN
:
2818 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2819 ret
= cmd_list_plugins(cfg
);
2821 case BT_CONFIG_COMMAND_HELP
:
2822 ret
= cmd_help(cfg
);
2824 case BT_CONFIG_COMMAND_QUERY
:
2825 ret
= cmd_query(cfg
);
2827 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2828 ret
= cmd_print_ctf_metadata(cfg
);
2830 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2831 ret
= cmd_print_lttng_live_sessions(cfg
);
2834 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2838 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2839 cfg
->command
, cfg
->command_name
, ret
);
2840 warn_command_name_and_directory_clash(cfg
);
2841 retcode
= ret
? 1 : 0;
2844 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2845 fini_loaded_plugins();
2846 bt_interrupter_put_ref(the_interrupter
);
2849 print_error_causes();
2853 * Clear current thread's error in case there is one to avoid a
2856 bt_current_thread_clear_error();