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
50 BT_CMD_STATUS_ERROR
= -1,
51 BT_CMD_STATUS_INTERRUPTED
= -2,
55 const char *bt_cmd_status_string(enum bt_cmd_status cmd_status
)
58 case BT_CMD_STATUS_OK
:
60 case BT_CMD_STATUS_ERROR
:
62 case BT_CMD_STATUS_INTERRUPTED
:
69 /* Application's interrupter (owned by this) */
70 static bt_interrupter
*the_interrupter
;
77 BOOL WINAPI
signal_handler(DWORD signal
) {
78 if (the_interrupter
) {
79 bt_interrupter_set(the_interrupter
);
86 void set_signal_handler(void)
88 if (!SetConsoleCtrlHandler(signal_handler
, TRUE
)) {
89 BT_LOGE("Failed to set the Ctrl+C handler.");
93 #else /* __MINGW32__ */
96 void signal_handler(int signum
)
98 if (signum
!= SIGINT
) {
102 if (the_interrupter
) {
103 bt_interrupter_set(the_interrupter
);
108 void set_signal_handler(void)
110 struct sigaction new_action
, old_action
;
112 new_action
.sa_handler
= signal_handler
;
113 sigemptyset(&new_action
.sa_mask
);
114 new_action
.sa_flags
= 0;
115 sigaction(SIGINT
, NULL
, &old_action
);
117 if (old_action
.sa_handler
!= SIG_IGN
) {
118 sigaction(SIGINT
, &new_action
, NULL
);
122 #endif /* __MINGW32__ */
125 int query(struct bt_config
*cfg
, const bt_component_class
*comp_cls
,
126 const char *obj
, const bt_value
*params
,
127 const bt_value
**user_result
, const char **fail_reason
)
129 return cli_query(comp_cls
, obj
, params
, cfg
->log_level
,
130 the_interrupter
, user_result
, fail_reason
);
133 typedef const void *(*plugin_borrow_comp_cls_func_t
)(
134 const bt_plugin
*, const char *);
137 const void *find_component_class_from_plugin(const char *plugin_name
,
138 const char *comp_class_name
,
139 plugin_borrow_comp_cls_func_t plugin_borrow_comp_cls_func
)
141 const void *comp_class
= NULL
;
142 const bt_plugin
*plugin
;
144 BT_LOGI("Finding component class: plugin-name=\"%s\", "
145 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
147 plugin
= find_loaded_plugin(plugin_name
);
152 comp_class
= plugin_borrow_comp_cls_func(plugin
, comp_class_name
);
153 bt_object_get_ref(comp_class
);
154 BT_PLUGIN_PUT_REF_AND_RESET(plugin
);
158 BT_LOGI("Found component class: plugin-name=\"%s\", "
159 "comp-cls-name=\"%s\"", plugin_name
, comp_class_name
);
161 BT_LOGI("Cannot find source component class: "
162 "plugin-name=\"%s\", comp-cls-name=\"%s\"",
163 plugin_name
, comp_class_name
);
170 const bt_component_class_source
*find_source_component_class(
171 const char *plugin_name
, const char *comp_class_name
)
173 return (const void *) find_component_class_from_plugin(
174 plugin_name
, comp_class_name
,
175 (plugin_borrow_comp_cls_func_t
)
176 bt_plugin_borrow_source_component_class_by_name_const
);
180 const bt_component_class_filter
*find_filter_component_class(
181 const char *plugin_name
, const char *comp_class_name
)
183 return (const void *) find_component_class_from_plugin(
184 plugin_name
, comp_class_name
,
185 (plugin_borrow_comp_cls_func_t
)
186 bt_plugin_borrow_filter_component_class_by_name_const
);
190 const bt_component_class_sink
*find_sink_component_class(
191 const char *plugin_name
, const char *comp_class_name
)
193 return (const void *) find_component_class_from_plugin(plugin_name
,
195 (plugin_borrow_comp_cls_func_t
)
196 bt_plugin_borrow_sink_component_class_by_name_const
);
200 const bt_component_class
*find_component_class(const char *plugin_name
,
201 const char *comp_class_name
,
202 bt_component_class_type comp_class_type
)
204 const bt_component_class
*comp_cls
= NULL
;
206 switch (comp_class_type
) {
207 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
208 comp_cls
= bt_component_class_source_as_component_class_const(find_source_component_class(plugin_name
, comp_class_name
));
210 case BT_COMPONENT_CLASS_TYPE_FILTER
:
211 comp_cls
= bt_component_class_filter_as_component_class_const(find_filter_component_class(plugin_name
, comp_class_name
));
213 case BT_COMPONENT_CLASS_TYPE_SINK
:
214 comp_cls
= bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name
, comp_class_name
));
224 void print_indent(FILE *fp
, size_t indent
)
228 for (i
= 0; i
< indent
; i
++) {
234 const char *component_type_str(bt_component_class_type type
)
237 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
239 case BT_COMPONENT_CLASS_TYPE_SINK
:
241 case BT_COMPONENT_CLASS_TYPE_FILTER
:
249 void print_plugin_comp_cls_opt(FILE *fh
, const char *plugin_name
,
250 const char *comp_cls_name
, bt_component_class_type type
)
252 GString
*shell_plugin_name
= NULL
;
253 GString
*shell_comp_cls_name
= NULL
;
256 shell_plugin_name
= bt_common_shell_quote(plugin_name
, false);
257 if (!shell_plugin_name
) {
262 shell_comp_cls_name
= bt_common_shell_quote(comp_cls_name
, false);
263 if (!shell_comp_cls_name
) {
267 fprintf(fh
, "'%s%s%s%s",
268 bt_common_color_bold(),
269 bt_common_color_fg_cyan(),
270 component_type_str(type
),
271 bt_common_color_fg_default());
273 if (shell_plugin_name
) {
274 fprintf(fh
, ".%s%s%s",
275 bt_common_color_fg_blue(),
276 shell_plugin_name
->str
,
277 bt_common_color_fg_default());
280 fprintf(fh
, ".%s%s%s'",
281 bt_common_color_fg_yellow(),
282 shell_comp_cls_name
->str
,
283 bt_common_color_reset());
286 if (shell_plugin_name
) {
287 g_string_free(shell_plugin_name
, TRUE
);
290 if (shell_comp_cls_name
) {
291 g_string_free(shell_comp_cls_name
, TRUE
);
296 void print_value(FILE *, const bt_value
*, size_t);
299 void print_value_rec(FILE *, const bt_value
*, size_t);
302 void print_map_value(const char *key
, const bt_value
*object
, FILE *fp
,
305 print_indent(fp
, indent
);
306 fprintf(fp
, "%s: ", key
);
309 if (bt_value_is_array(object
) &&
310 bt_value_array_is_empty(object
)) {
311 fprintf(fp
, "[ ]\n");
315 if (bt_value_is_map(object
) &&
316 bt_value_map_is_empty(object
)) {
317 fprintf(fp
, "{ }\n");
321 if (bt_value_is_array(object
) ||
322 bt_value_is_map(object
)) {
326 print_value_rec(fp
, object
, indent
+ 2);
333 bt_bool
collect_map_keys(const char *key
, const bt_value
*object
, void *data
)
335 GPtrArray
*map_keys
= data
;
337 g_ptr_array_add(map_keys
, (gpointer
*) key
);
343 gint
g_ptr_array_sort_strings(gconstpointer a
, gconstpointer b
) {
344 const char *s1
= *((const char **) a
);
345 const char *s2
= *((const char **) b
);
347 return g_strcmp0(s1
, s2
);
351 void print_value_rec(FILE *fp
, const bt_value
*value
, size_t indent
)
358 GPtrArray
*map_keys
= NULL
;
362 switch (bt_value_get_type(value
)) {
363 case BT_VALUE_TYPE_NULL
:
364 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
365 bt_common_color_reset());
367 case BT_VALUE_TYPE_BOOL
:
368 bool_val
= bt_value_bool_get(value
);
369 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
370 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
371 bt_common_color_reset());
373 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
374 uint_val
= bt_value_integer_unsigned_get(value
);
375 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
376 bt_common_color_fg_red(), uint_val
,
377 bt_common_color_reset());
379 case BT_VALUE_TYPE_SIGNED_INTEGER
:
380 int_val
= bt_value_integer_signed_get(value
);
381 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
382 bt_common_color_fg_red(), int_val
,
383 bt_common_color_reset());
385 case BT_VALUE_TYPE_REAL
:
386 dbl_val
= bt_value_real_get(value
);
387 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
388 bt_common_color_fg_red(), dbl_val
,
389 bt_common_color_reset());
391 case BT_VALUE_TYPE_STRING
:
392 str_val
= bt_value_string_get(value
);
393 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
394 bt_common_color_fg_green(), str_val
,
395 bt_common_color_reset());
397 case BT_VALUE_TYPE_ARRAY
:
400 size
= bt_value_array_get_length(value
);
402 print_indent(fp
, indent
);
403 fprintf(fp
, "[ ]\n");
407 for (i
= 0; i
< size
; i
++) {
408 const bt_value
*element
=
409 bt_value_array_borrow_element_by_index_const(
412 print_indent(fp
, indent
);
415 if (bt_value_is_array(element
) &&
416 bt_value_array_is_empty(element
)) {
417 fprintf(fp
, "[ ]\n");
421 if (bt_value_is_map(element
) &&
422 bt_value_map_is_empty(element
)) {
423 fprintf(fp
, "{ }\n");
427 if (bt_value_is_array(element
) ||
428 bt_value_is_map(element
)) {
432 print_value_rec(fp
, element
, indent
+ 2);
436 case BT_VALUE_TYPE_MAP
:
439 bt_value_map_foreach_entry_const_status foreach_status
;
441 if (bt_value_map_is_empty(value
)) {
442 print_indent(fp
, indent
);
443 fprintf(fp
, "{ }\n");
447 map_keys
= g_ptr_array_new();
449 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
454 * We want to print the map entries in a stable order. Collect
455 * all the map's keys in a GPtrArray, sort it, then print the
456 * entries in that order.
458 foreach_status
= bt_value_map_foreach_entry_const(value
,
459 collect_map_keys
, map_keys
);
460 if (foreach_status
!= BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
) {
461 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
465 g_ptr_array_sort(map_keys
, g_ptr_array_sort_strings
);
467 for (i
= 0; i
< map_keys
->len
; i
++) {
468 const char *map_key
= g_ptr_array_index(map_keys
, i
);
469 const bt_value
*map_value
;
471 map_value
= bt_value_map_borrow_entry_value_const(value
, map_key
);
472 BT_ASSERT(map_value
);
474 print_map_value(map_key
, map_value
, fp
, indent
);
487 g_ptr_array_free(map_keys
, TRUE
);
492 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
494 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
495 print_indent(fp
, indent
);
498 print_value_rec(fp
, value
, indent
);
502 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
504 fprintf(stderr
, " ");
505 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
506 bt_config_component
->comp_cls_name
->str
,
507 bt_config_component
->type
);
508 fprintf(stderr
, ":\n");
510 if (bt_config_component
->instance_name
->len
> 0) {
511 fprintf(stderr
, " Name: %s\n",
512 bt_config_component
->instance_name
->str
);
515 fprintf(stderr
, " Parameters:\n");
516 print_value(stderr
, bt_config_component
->params
, 8);
520 void print_bt_config_components(GPtrArray
*array
)
524 for (i
= 0; i
< array
->len
; i
++) {
525 struct bt_config_component
*cfg_component
=
526 bt_config_get_component(array
, i
);
527 print_bt_config_component(cfg_component
);
528 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
533 void print_plugin_paths(const bt_value
*plugin_paths
)
535 fprintf(stderr
, " Plugin paths:\n");
536 print_value(stderr
, plugin_paths
, 4);
540 void print_cfg_run(struct bt_config
*cfg
)
544 print_plugin_paths(cfg
->plugin_paths
);
545 fprintf(stderr
, " Source component instances:\n");
546 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
548 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
549 fprintf(stderr
, " Filter component instances:\n");
550 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
553 fprintf(stderr
, " Sink component instances:\n");
554 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
555 fprintf(stderr
, " Connections:\n");
557 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
558 struct bt_config_connection
*cfg_connection
=
559 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
562 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
563 cfg_connection
->upstream_comp_name
->str
,
564 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
565 cfg_connection
->upstream_port_glob
->str
,
566 cfg_connection
->downstream_comp_name
->str
,
567 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
568 cfg_connection
->downstream_port_glob
->str
);
573 void print_cfg_list_plugins(struct bt_config
*cfg
)
575 print_plugin_paths(cfg
->plugin_paths
);
579 void print_cfg_help(struct bt_config
*cfg
)
581 print_plugin_paths(cfg
->plugin_paths
);
585 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
587 print_plugin_paths(cfg
->plugin_paths
);
588 fprintf(stderr
, " Path: %s\n",
589 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
593 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
595 print_plugin_paths(cfg
->plugin_paths
);
596 fprintf(stderr
, " URL: %s\n",
597 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
601 void print_cfg_query(struct bt_config
*cfg
)
603 print_plugin_paths(cfg
->plugin_paths
);
604 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
605 fprintf(stderr
, " Component class:\n");
606 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
610 void print_cfg(struct bt_config
*cfg
)
612 if (!BT_LOG_ON_INFO
) {
616 BT_LOGI_STR("CLI configuration:");
618 switch (cfg
->command
) {
619 case BT_CONFIG_COMMAND_RUN
:
622 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
623 print_cfg_list_plugins(cfg
);
625 case BT_CONFIG_COMMAND_HELP
:
628 case BT_CONFIG_COMMAND_QUERY
:
629 print_cfg_query(cfg
);
631 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
632 print_cfg_print_ctf_metadata(cfg
);
634 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
635 print_cfg_print_lttng_live_sessions(cfg
);
643 void print_plugin_info(const bt_plugin
*plugin
)
645 unsigned int major
, minor
, patch
;
647 bt_property_availability version_avail
;
648 const char *plugin_name
;
652 const char *plugin_description
;
654 plugin_name
= bt_plugin_get_name(plugin
);
655 path
= bt_plugin_get_path(plugin
);
656 author
= bt_plugin_get_author(plugin
);
657 license
= bt_plugin_get_license(plugin
);
658 plugin_description
= bt_plugin_get_description(plugin
);
659 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
661 printf("%s%s%s%s:\n", bt_common_color_bold(),
662 bt_common_color_fg_blue(), plugin_name
,
663 bt_common_color_reset());
665 printf(" %sPath%s: %s\n", bt_common_color_bold(),
666 bt_common_color_reset(), path
);
671 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
672 printf(" %sVersion%s: %u.%u.%u",
673 bt_common_color_bold(), bt_common_color_reset(),
674 major
, minor
, patch
);
683 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
684 bt_common_color_reset(),
685 plugin_description
? plugin_description
: "(None)");
686 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
687 bt_common_color_reset(), author
? author
: "(Unknown)");
688 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
689 bt_common_color_reset(),
690 license
? license
: "(Unknown)");
694 enum bt_cmd_status
cmd_query(struct bt_config
*cfg
)
697 enum bt_cmd_status cmd_status
;
698 const bt_component_class
*comp_cls
= NULL
;
699 const bt_value
*results
= NULL
;
700 const char *fail_reason
= NULL
;
702 comp_cls
= find_component_class(
703 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
704 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
705 cfg
->cmd_data
.query
.cfg_component
->type
);
707 BT_CLI_LOGE_APPEND_CAUSE(
708 "Cannot find component class: plugin-name=\"%s\", "
709 "comp-cls-name=\"%s\", comp-cls-type=%d",
710 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
711 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
712 cfg
->cmd_data
.query
.cfg_component
->type
);
716 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
717 cfg
->cmd_data
.query
.cfg_component
->params
,
718 &results
, &fail_reason
);
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 print_value(stdout
, results
, 0);
732 cmd_status
= BT_CMD_STATUS_OK
;
736 cmd_status
= BT_CMD_STATUS_ERROR
;
739 bt_component_class_put_ref(comp_cls
);
740 bt_value_put_ref(results
);
745 void print_component_class_help(const char *plugin_name
,
746 const bt_component_class
*comp_cls
)
748 const char *comp_class_name
=
749 bt_component_class_get_name(comp_cls
);
750 const char *comp_class_description
=
751 bt_component_class_get_description(comp_cls
);
752 const char *comp_class_help
=
753 bt_component_class_get_help(comp_cls
);
754 bt_component_class_type type
=
755 bt_component_class_get_type(comp_cls
);
757 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
759 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
760 bt_common_color_reset(),
761 comp_class_description
? comp_class_description
: "(None)");
763 if (comp_class_help
) {
764 printf("\n%s\n", comp_class_help
);
769 enum bt_cmd_status
cmd_help(struct bt_config
*cfg
)
771 enum bt_cmd_status cmd_status
;
772 const bt_plugin
*plugin
= NULL
;
773 const bt_component_class
*needed_comp_cls
= NULL
;
775 plugin
= find_loaded_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
777 BT_CLI_LOGE_APPEND_CAUSE(
778 "Cannot find plugin: plugin-name=\"%s\"",
779 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
783 print_plugin_info(plugin
);
784 printf(" %sSource component classes%s: %d\n",
785 bt_common_color_bold(),
786 bt_common_color_reset(),
787 (int) bt_plugin_get_source_component_class_count(plugin
));
788 printf(" %sFilter component classes%s: %d\n",
789 bt_common_color_bold(),
790 bt_common_color_reset(),
791 (int) bt_plugin_get_filter_component_class_count(plugin
));
792 printf(" %sSink component classes%s: %d\n",
793 bt_common_color_bold(),
794 bt_common_color_reset(),
795 (int) bt_plugin_get_sink_component_class_count(plugin
));
797 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
798 /* Plugin help only */
799 cmd_status
= BT_CMD_STATUS_OK
;
803 needed_comp_cls
= find_component_class(
804 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
805 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
806 cfg
->cmd_data
.help
.cfg_component
->type
);
807 if (!needed_comp_cls
) {
808 BT_CLI_LOGE_APPEND_CAUSE(
809 "Cannot find component class: plugin-name=\"%s\", "
810 "comp-cls-name=\"%s\", comp-cls-type=%d",
811 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
812 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
813 cfg
->cmd_data
.help
.cfg_component
->type
);
818 print_component_class_help(
819 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
821 cmd_status
= BT_CMD_STATUS_OK
;
825 cmd_status
= BT_CMD_STATUS_ERROR
;
828 bt_component_class_put_ref(needed_comp_cls
);
829 bt_plugin_put_ref(plugin
);
833 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
835 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
839 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
840 const char *cc_type_name
, uint64_t count
,
841 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
842 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
847 printf(" %s%s component classes%s: (none)\n",
848 bt_common_color_bold(),
850 bt_common_color_reset());
853 printf(" %s%s component classes%s:\n",
854 bt_common_color_bold(),
856 bt_common_color_reset());
859 for (i
= 0; i
< count
; i
++) {
860 const bt_component_class
*comp_class
=
861 spec_comp_cls_borrow_comp_cls_func(
862 borrow_comp_cls_by_index_func(plugin
, i
));
863 const char *comp_class_name
=
864 bt_component_class_get_name(comp_class
);
865 const char *comp_class_description
=
866 bt_component_class_get_description(comp_class
);
867 bt_component_class_type type
=
868 bt_component_class_get_type(comp_class
);
871 print_plugin_comp_cls_opt(stdout
,
872 bt_plugin_get_name(plugin
), comp_class_name
,
875 if (comp_class_description
) {
876 printf(": %s", comp_class_description
);
887 enum bt_cmd_status
cmd_list_plugins(struct bt_config
*cfg
)
889 int plugins_count
, component_classes_count
= 0, i
;
891 printf("From the following plugin paths:\n\n");
892 print_value(stdout
, cfg
->plugin_paths
, 2);
894 plugins_count
= get_loaded_plugins_count();
895 if (plugins_count
== 0) {
896 printf("No plugins found.\n");
900 for (i
= 0; i
< plugins_count
; i
++) {
901 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
903 component_classes_count
+=
904 bt_plugin_get_source_component_class_count(plugin
) +
905 bt_plugin_get_filter_component_class_count(plugin
) +
906 bt_plugin_get_sink_component_class_count(plugin
);
909 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
910 bt_common_color_bold(),
911 component_classes_count
,
912 bt_common_color_reset(),
913 bt_common_color_bold(),
915 bt_common_color_reset());
917 for (i
= 0; i
< plugins_count
; i
++) {
918 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
921 print_plugin_info(plugin
);
922 cmd_list_plugins_print_component_classes(plugin
, "Source",
923 bt_plugin_get_source_component_class_count(plugin
),
924 (plugin_borrow_comp_cls_by_index_func_t
)
925 bt_plugin_borrow_source_component_class_by_index_const
,
926 (spec_comp_cls_borrow_comp_cls_func_t
)
927 bt_component_class_source_as_component_class
);
928 cmd_list_plugins_print_component_classes(plugin
, "Filter",
929 bt_plugin_get_filter_component_class_count(plugin
),
930 (plugin_borrow_comp_cls_by_index_func_t
)
931 bt_plugin_borrow_filter_component_class_by_index_const
,
932 (spec_comp_cls_borrow_comp_cls_func_t
)
933 bt_component_class_filter_as_component_class
);
934 cmd_list_plugins_print_component_classes(plugin
, "Sink",
935 bt_plugin_get_sink_component_class_count(plugin
),
936 (plugin_borrow_comp_cls_by_index_func_t
)
937 bt_plugin_borrow_sink_component_class_by_index_const
,
938 (spec_comp_cls_borrow_comp_cls_func_t
)
939 bt_component_class_sink_as_component_class
);
943 return BT_CMD_STATUS_OK
;
947 enum bt_cmd_status
cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
950 enum bt_cmd_status cmd_status
;
951 const bt_component_class
*comp_cls
= NULL
;
952 const bt_value
*results
= NULL
;
953 bt_value
*params
= NULL
;
954 const bt_value
*map
= NULL
;
955 const bt_value
*v
= NULL
;
956 static const char * const plugin_name
= "ctf";
957 static const char * const comp_cls_name
= "lttng-live";
958 static const bt_component_class_type comp_cls_type
=
959 BT_COMPONENT_CLASS_TYPE_SOURCE
;
960 uint64_t array_size
, i
;
961 const char *fail_reason
= NULL
;
962 FILE *out_stream
= stdout
;
964 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
965 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
968 BT_CLI_LOGE_APPEND_CAUSE(
969 "Cannot find component class: plugin-name=\"%s\", "
970 "comp-cls-name=\"%s\", comp-cls-type=%d",
971 plugin_name
, comp_cls_name
,
972 BT_COMPONENT_CLASS_TYPE_SOURCE
);
976 params
= bt_value_map_create();
981 ret
= bt_value_map_insert_string_entry(params
, "url",
982 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
987 ret
= query(cfg
, comp_cls
, "sessions", params
,
988 &results
, &fail_reason
);
990 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
997 if (!bt_value_is_array(results
)) {
998 BT_CLI_LOGE_APPEND_CAUSE(
999 "Expecting an array for LTTng live `sessions` query.");
1003 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
1005 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
1008 BT_LOGE_ERRNO("Cannot open file for writing",
1010 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1011 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1013 "Cannot open file for writing: path=\"%s\"",
1014 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1019 array_size
= bt_value_array_get_length(results
);
1020 for (i
= 0; i
< array_size
; i
++) {
1021 const char *url_text
;
1022 int64_t timer_us
, streams
, clients
;
1024 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1025 if (!bt_value_is_map(map
)) {
1026 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
1030 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1032 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
1035 url_text
= bt_value_string_get(v
);
1036 fprintf(out_stream
, "%s", url_text
);
1037 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1039 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
1042 timer_us
= bt_value_integer_unsigned_get(v
);
1043 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1044 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1046 BT_CLI_LOGE_APPEND_CAUSE(
1047 "Missing `stream-count` entry.");
1050 streams
= bt_value_integer_unsigned_get(v
);
1051 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1052 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1054 BT_CLI_LOGE_APPEND_CAUSE(
1055 "Missing `client-count` entry.");
1058 clients
= bt_value_integer_unsigned_get(v
);
1059 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1062 cmd_status
= BT_CMD_STATUS_OK
;
1066 cmd_status
= BT_CMD_STATUS_ERROR
;
1069 bt_value_put_ref(results
);
1070 bt_value_put_ref(params
);
1071 bt_component_class_put_ref(comp_cls
);
1073 if (out_stream
&& out_stream
!= stdout
) {
1074 int fclose_ret
= fclose(out_stream
);
1077 BT_LOGE_ERRNO("Cannot close file stream",
1079 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1087 enum bt_cmd_status
cmd_print_ctf_metadata(struct bt_config
*cfg
)
1090 enum bt_cmd_status cmd_status
;
1091 const bt_component_class
*comp_cls
= NULL
;
1092 const bt_value
*results
= NULL
;
1093 bt_value
*params
= NULL
;
1094 const bt_value
*metadata_text_value
= NULL
;
1095 const char *metadata_text
= NULL
;
1096 static const char * const plugin_name
= "ctf";
1097 static const char * const comp_cls_name
= "fs";
1098 static const bt_component_class_type comp_cls_type
=
1099 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1100 const char *fail_reason
= NULL
;
1101 FILE *out_stream
= stdout
;
1103 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1104 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1107 BT_CLI_LOGE_APPEND_CAUSE(
1108 "Cannot find component class: plugin-name=\"%s\", "
1109 "comp-cls-name=\"%s\", comp-cls-type=%d",
1110 plugin_name
, comp_cls_name
,
1111 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1115 params
= bt_value_map_create();
1120 ret
= bt_value_map_insert_string_entry(params
, "path",
1121 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1126 ret
= query(cfg
, comp_cls
, "metadata-info",
1127 params
, &results
, &fail_reason
);
1129 BT_CLI_LOGE_APPEND_CAUSE(
1130 "Failed to query `metadata-info` object: %s", fail_reason
);
1134 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1136 if (!metadata_text_value
) {
1137 BT_CLI_LOGE_APPEND_CAUSE(
1138 "Cannot find `text` string value in the resulting metadata info object.");
1142 metadata_text
= bt_value_string_get(metadata_text_value
);
1144 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1146 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1149 BT_LOGE_ERRNO("Cannot open file for writing",
1151 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1152 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1154 "Cannot open file for writing: path=\"%s\"",
1155 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1160 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1162 BT_CLI_LOGE_APPEND_CAUSE(
1163 "Cannot write whole metadata text to output stream: "
1168 cmd_status
= BT_CMD_STATUS_OK
;
1172 cmd_status
= BT_CMD_STATUS_ERROR
;
1175 bt_value_put_ref(results
);
1176 bt_value_put_ref(params
);
1177 bt_component_class_put_ref(comp_cls
);
1179 if (out_stream
&& out_stream
!= stdout
) {
1180 int fclose_ret
= fclose(out_stream
);
1183 BT_LOGE_ERRNO("Cannot close file stream",
1185 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1193 char *instance_name
;
1197 struct trace_range
{
1198 uint64_t intersection_range_begin_ns
;
1199 uint64_t intersection_range_end_ns
;
1203 guint
port_id_hash(gconstpointer v
)
1205 const struct port_id
*id
= v
;
1207 BT_ASSERT(id
->instance_name
);
1208 BT_ASSERT(id
->port_name
);
1210 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1214 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1216 const struct port_id
*id1
= v1
;
1217 const struct port_id
*id2
= v2
;
1219 return strcmp(id1
->instance_name
, id2
->instance_name
) == 0 &&
1220 strcmp(id1
->port_name
, id2
->port_name
) == 0;
1224 void port_id_destroy(gpointer data
)
1226 struct port_id
*id
= data
;
1228 free(id
->instance_name
);
1229 free(id
->port_name
);
1234 void trace_range_destroy(gpointer data
)
1239 struct cmd_run_ctx
{
1241 GHashTable
*src_components
;
1244 GHashTable
*flt_components
;
1247 GHashTable
*sink_components
;
1253 struct bt_config
*cfg
;
1257 bool stream_intersection_mode
;
1260 * Association of struct port_id -> struct trace_range.
1262 GHashTable
*intersections
;
1265 /* Returns a timestamp of the form "(-)s.ns" */
1267 char *s_from_ns(int64_t ns
)
1272 int64_t ts_sec_abs
, ts_nsec_abs
;
1273 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1274 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1276 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1277 is_negative
= false;
1278 ts_sec_abs
= ts_sec
;
1279 ts_nsec_abs
= ts_nsec
;
1280 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1281 is_negative
= false;
1282 ts_sec_abs
= ts_sec
- 1;
1283 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1284 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1286 ts_sec_abs
= ts_sec
;
1287 ts_nsec_abs
= -ts_nsec
;
1288 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1290 ts_sec_abs
= -(ts_sec
+ 1);
1291 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1292 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1294 ts_sec_abs
= -ts_sec
;
1295 ts_nsec_abs
= ts_nsec
;
1296 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1298 ts_sec_abs
= -ts_sec
;
1299 ts_nsec_abs
= -ts_nsec
;
1302 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1303 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1311 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1312 struct cmd_run_ctx
*ctx
,
1313 const bt_component
*upstream_comp
,
1314 const bt_port_output
*out_upstream_port
,
1315 struct bt_config_connection
*cfg_conn
)
1317 typedef uint64_t (*input_port_count_func_t
)(void *);
1318 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1319 const void *, uint64_t);
1320 const bt_port
*upstream_port
=
1321 bt_port_output_as_port_const(out_upstream_port
);
1324 GQuark downstreamp_comp_name_quark
;
1325 void *downstream_comp
;
1326 uint64_t downstream_port_count
;
1328 input_port_count_func_t port_count_fn
;
1329 borrow_input_port_by_index_func_t port_by_index_fn
;
1330 bt_graph_connect_ports_status connect_ports_status
=
1331 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1332 bool insert_trimmer
= false;
1333 bt_value
*trimmer_params
= NULL
;
1334 char *intersection_begin
= NULL
;
1335 char *intersection_end
= NULL
;
1336 const bt_component_filter
*trimmer
= NULL
;
1337 const bt_component_class_filter
*trimmer_class
= NULL
;
1338 const bt_port_input
*trimmer_input
= NULL
;
1339 const bt_port_output
*trimmer_output
= NULL
;
1341 if (ctx
->intersections
&&
1342 bt_component_get_class_type(upstream_comp
) ==
1343 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1344 struct trace_range
*range
;
1345 struct port_id port_id
= {
1346 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1347 .port_name
= (char *) bt_port_get_name(upstream_port
)
1350 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1354 range
= (struct trace_range
*) g_hash_table_lookup(
1355 ctx
->intersections
, &port_id
);
1357 bt_value_map_insert_entry_status insert_status
;
1359 intersection_begin
= s_from_ns(
1360 range
->intersection_range_begin_ns
);
1361 intersection_end
= s_from_ns(
1362 range
->intersection_range_end_ns
);
1363 if (!intersection_begin
|| !intersection_end
) {
1364 BT_CLI_LOGE_APPEND_CAUSE(
1365 "Cannot create trimmer argument timestamp string.");
1369 insert_trimmer
= true;
1370 trimmer_params
= bt_value_map_create();
1371 if (!trimmer_params
) {
1375 insert_status
= bt_value_map_insert_string_entry(
1376 trimmer_params
, "begin", intersection_begin
);
1377 if (insert_status
< 0) {
1380 insert_status
= bt_value_map_insert_string_entry(
1382 "end", intersection_end
);
1383 if (insert_status
< 0) {
1388 trimmer_class
= find_filter_component_class("utils", "trimmer");
1389 if (!trimmer_class
) {
1394 BT_LOGI("Connecting upstream port to the next available downstream port: "
1395 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1396 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1397 upstream_port
, bt_port_get_name(upstream_port
),
1398 cfg_conn
->downstream_comp_name
->str
,
1399 cfg_conn
->arg
->str
);
1400 downstreamp_comp_name_quark
= g_quark_from_string(
1401 cfg_conn
->downstream_comp_name
->str
);
1402 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1403 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1404 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1405 port_count_fn
= (input_port_count_func_t
)
1406 bt_component_filter_get_input_port_count
;
1407 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1408 bt_component_filter_borrow_input_port_by_index_const
;
1410 if (!downstream_comp
) {
1411 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1412 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1413 port_count_fn
= (input_port_count_func_t
)
1414 bt_component_sink_get_input_port_count
;
1415 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1416 bt_component_sink_borrow_input_port_by_index_const
;
1419 if (!downstream_comp
) {
1420 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1421 "comp-name=\"%s\", conn-arg=\"%s\"",
1422 cfg_conn
->downstream_comp_name
->str
,
1423 cfg_conn
->arg
->str
);
1427 downstream_port_count
= port_count_fn(downstream_comp
);
1429 for (i
= 0; i
< downstream_port_count
; i
++) {
1430 const bt_port_input
*in_downstream_port
=
1431 port_by_index_fn(downstream_comp
, i
);
1432 const bt_port
*downstream_port
=
1433 bt_port_input_as_port_const(in_downstream_port
);
1434 const char *upstream_port_name
;
1435 const char *downstream_port_name
;
1437 BT_ASSERT(downstream_port
);
1439 /* Skip port if it's already connected. */
1440 if (bt_port_is_connected(downstream_port
)) {
1441 BT_LOGI("Skipping downstream port: already connected: "
1442 "port-addr=%p, port-name=\"%s\"",
1444 bt_port_get_name(downstream_port
));
1448 downstream_port_name
= bt_port_get_name(downstream_port
);
1449 BT_ASSERT(downstream_port_name
);
1450 upstream_port_name
= bt_port_get_name(upstream_port
);
1451 BT_ASSERT(upstream_port_name
);
1453 if (!bt_common_star_glob_match(
1454 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1455 downstream_port_name
, SIZE_MAX
)) {
1459 if (insert_trimmer
) {
1461 * In order to insert the trimmer between the
1462 * two components that were being connected, we
1463 * create a connection configuration entry which
1464 * describes a connection from the trimmer's
1465 * output to the original input that was being
1468 * Hence, the creation of the trimmer will cause
1469 * the graph "new port" listener to establish
1470 * all downstream connections as its output port
1471 * is connected. We will then establish the
1472 * connection between the original upstream
1473 * source and the trimmer.
1475 char *trimmer_name
= NULL
;
1476 bt_graph_add_component_status add_comp_status
;
1478 ret
= asprintf(&trimmer_name
,
1479 "stream-intersection-trimmer-%s",
1480 upstream_port_name
);
1486 ctx
->connect_ports
= false;
1487 add_comp_status
= bt_graph_add_filter_component(
1488 ctx
->graph
, trimmer_class
, trimmer_name
,
1489 trimmer_params
, ctx
->cfg
->log_level
,
1492 if (add_comp_status
!=
1493 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1499 bt_component_filter_borrow_input_port_by_index_const(
1501 if (!trimmer_input
) {
1505 bt_component_filter_borrow_output_port_by_index_const(
1507 if (!trimmer_output
) {
1512 * Replace the current downstream port by the trimmer's
1515 in_downstream_port
= trimmer_input
;
1517 bt_port_input_as_port_const(in_downstream_port
);
1518 downstream_port_name
= bt_port_get_name(
1520 BT_ASSERT(downstream_port_name
);
1523 /* We have a winner! */
1524 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1525 out_upstream_port
, in_downstream_port
, NULL
);
1526 downstream_port
= NULL
;
1527 switch (connect_ports_status
) {
1528 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1531 BT_CLI_LOGE_APPEND_CAUSE(
1532 "Cannot create connection: graph refuses to connect ports: "
1533 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1534 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1535 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1536 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1538 upstream_comp
, bt_component_get_name(upstream_comp
),
1539 upstream_port
, bt_port_get_name(upstream_port
),
1540 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1541 downstream_port
, downstream_port_name
,
1542 cfg_conn
->arg
->str
);
1546 BT_LOGI("Connected component ports: "
1547 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1548 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1549 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1550 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1552 upstream_comp
, bt_component_get_name(upstream_comp
),
1553 upstream_port
, bt_port_get_name(upstream_port
),
1554 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1555 downstream_port
, downstream_port_name
,
1556 cfg_conn
->arg
->str
);
1558 if (insert_trimmer
) {
1560 * The first connection, from the source to the trimmer,
1561 * has been done. We now connect the trimmer to the
1562 * original downstream port.
1564 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1566 bt_component_filter_as_component_const(trimmer
),
1567 trimmer_output
, cfg_conn
);
1571 ctx
->connect_ports
= true;
1575 * We found a matching downstream port: the search is
1581 /* No downstream port found */
1582 BT_CLI_LOGE_APPEND_CAUSE(
1583 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1584 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1585 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1586 upstream_port
, bt_port_get_name(upstream_port
),
1587 cfg_conn
->downstream_comp_name
->str
,
1588 cfg_conn
->arg
->str
);
1594 free(intersection_begin
);
1595 free(intersection_end
);
1596 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1597 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1598 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1603 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1604 const bt_port_output
*upstream_port
)
1607 const char *upstream_port_name
;
1608 const char *upstream_comp_name
;
1609 const bt_component
*upstream_comp
= NULL
;
1613 BT_ASSERT(upstream_port
);
1614 upstream_port_name
= bt_port_get_name(
1615 bt_port_output_as_port_const(upstream_port
));
1616 BT_ASSERT(upstream_port_name
);
1617 upstream_comp
= bt_port_borrow_component_const(
1618 bt_port_output_as_port_const(upstream_port
));
1619 BT_ASSERT(upstream_comp
);
1620 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1621 BT_ASSERT(upstream_comp_name
);
1622 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1623 "port-addr=%p, port-name=\"%s\"",
1624 upstream_comp
, upstream_comp_name
,
1625 upstream_port
, upstream_port_name
);
1627 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1628 struct bt_config_connection
*cfg_conn
=
1630 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1632 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1633 upstream_comp_name
)) {
1637 if (!bt_common_star_glob_match(
1638 cfg_conn
->upstream_port_glob
->str
,
1639 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1643 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1644 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1646 BT_CLI_LOGE_APPEND_CAUSE(
1647 "Cannot connect upstream port: "
1648 "port-addr=%p, port-name=\"%s\"",
1650 upstream_port_name
);
1656 BT_CLI_LOGE_APPEND_CAUSE(
1657 "Cannot connect upstream port: port does not match any connection argument: "
1658 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1659 upstream_port_name
);
1669 bt_graph_listener_func_status
1670 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1671 const bt_port_output
*out_port
)
1673 const bt_component
*comp
;
1674 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1675 bt_graph_listener_func_status ret
=
1676 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
1678 comp
= bt_port_borrow_component_const(port
);
1679 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1680 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1681 comp
, comp
? bt_component_get_name(comp
) : "",
1682 port
, bt_port_get_name(port
));
1684 if (!ctx
->connect_ports
) {
1690 if (bt_port_is_connected(port
)) {
1691 BT_LOGW_STR("Port is already connected.");
1695 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
1696 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1697 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
1706 bt_graph_listener_func_status
graph_source_output_port_added_listener(
1707 const bt_component_source
*component
,
1708 const bt_port_output
*port
, void *data
)
1710 return graph_output_port_added_listener(data
, port
);
1714 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
1715 const bt_component_filter
*component
,
1716 const bt_port_output
*port
, void *data
)
1718 return graph_output_port_added_listener(data
, port
);
1722 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1728 if (ctx
->src_components
) {
1729 g_hash_table_destroy(ctx
->src_components
);
1730 ctx
->src_components
= NULL
;
1733 if (ctx
->flt_components
) {
1734 g_hash_table_destroy(ctx
->flt_components
);
1735 ctx
->flt_components
= NULL
;
1738 if (ctx
->sink_components
) {
1739 g_hash_table_destroy(ctx
->sink_components
);
1740 ctx
->sink_components
= NULL
;
1743 if (ctx
->intersections
) {
1744 g_hash_table_destroy(ctx
->intersections
);
1745 ctx
->intersections
= NULL
;
1748 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
1753 int add_descriptor_to_component_descriptor_set(
1754 bt_component_descriptor_set
*comp_descr_set
,
1755 const char *plugin_name
, const char *comp_cls_name
,
1756 bt_component_class_type comp_cls_type
,
1757 const bt_value
*params
)
1759 const bt_component_class
*comp_cls
;
1762 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1765 BT_CLI_LOGE_APPEND_CAUSE(
1766 "Cannot find component class: plugin-name=\"%s\", "
1767 "comp-cls-name=\"%s\", comp-cls-type=%d",
1768 plugin_name
, comp_cls_name
, comp_cls_type
);
1773 status
= bt_component_descriptor_set_add_descriptor(
1774 comp_descr_set
, comp_cls
, params
);
1775 if (status
!= BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK
) {
1776 BT_CLI_LOGE_APPEND_CAUSE(
1777 "Cannot append descriptor to component descriptor set: "
1778 "status=%s", bt_common_func_status_string(status
));
1783 bt_component_class_put_ref(comp_cls
);
1788 int append_descriptors_from_bt_config_component_array(
1789 bt_component_descriptor_set
*comp_descr_set
,
1790 GPtrArray
*component_configs
)
1795 for (i
= 0; i
< component_configs
->len
; i
++) {
1796 struct bt_config_component
*cfg_comp
=
1797 component_configs
->pdata
[i
];
1799 ret
= add_descriptor_to_component_descriptor_set(
1801 cfg_comp
->plugin_name
->str
,
1802 cfg_comp
->comp_cls_name
->str
,
1803 cfg_comp
->type
, cfg_comp
->params
);
1814 bt_get_greatest_operative_mip_version_status
get_greatest_operative_mip_version(
1815 struct bt_config
*cfg
, uint64_t *mip_version
)
1817 bt_get_greatest_operative_mip_version_status status
=
1818 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
;
1819 bt_component_descriptor_set
*comp_descr_set
= NULL
;
1823 BT_ASSERT(mip_version
);
1824 comp_descr_set
= bt_component_descriptor_set_create();
1825 if (!comp_descr_set
) {
1826 BT_CLI_LOGE_APPEND_CAUSE(
1827 "Failed to create a component descriptor set object.");
1828 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR
;
1832 ret
= append_descriptors_from_bt_config_component_array(
1833 comp_descr_set
, cfg
->cmd_data
.run
.sources
);
1835 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1839 ret
= append_descriptors_from_bt_config_component_array(
1840 comp_descr_set
, cfg
->cmd_data
.run
.filters
);
1842 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1846 ret
= append_descriptors_from_bt_config_component_array(
1847 comp_descr_set
, cfg
->cmd_data
.run
.sinks
);
1849 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1853 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1855 * Stream intersection mode adds `flt.utils.trimmer`
1856 * components; we need to include this type of component
1857 * in the component descriptor set to get the real
1858 * greatest operative MIP version.
1860 ret
= add_descriptor_to_component_descriptor_set(
1861 comp_descr_set
, "utils", "trimmer",
1862 BT_COMPONENT_CLASS_TYPE_FILTER
, NULL
);
1864 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1869 status
= bt_get_greatest_operative_mip_version(comp_descr_set
,
1870 bt_cli_log_level
, mip_version
);
1873 bt_component_descriptor_set_put_ref(comp_descr_set
);
1878 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1881 bt_graph_add_listener_status add_listener_status
;
1882 bt_get_greatest_operative_mip_version_status mip_version_status
;
1883 uint64_t mip_version
= UINT64_C(-1);
1886 ctx
->connect_ports
= false;
1887 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
1888 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1889 if (!ctx
->src_components
) {
1893 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
1894 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1895 if (!ctx
->flt_components
) {
1899 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
1900 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1901 if (!ctx
->sink_components
) {
1905 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1906 ctx
->stream_intersection_mode
= true;
1907 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
1908 port_id_equal
, port_id_destroy
, trace_range_destroy
);
1909 if (!ctx
->intersections
) {
1915 * Get the greatest operative MIP version to use to configure
1916 * the graph to create.
1918 mip_version_status
= get_greatest_operative_mip_version(
1920 if (mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH
) {
1921 BT_CLI_LOGE_APPEND_CAUSE(
1922 "Failed to find an operative message interchange "
1923 "protocol version to use to create the `run` command's "
1924 "graph (components are not interoperable).");
1926 } else if (mip_version_status
< 0) {
1927 BT_CLI_LOGE_APPEND_CAUSE(
1928 "Cannot find an operative message interchange "
1929 "protocol version to use to create the `run` command's "
1931 bt_common_func_status_string(mip_version_status
));
1935 BT_ASSERT(mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
);
1936 BT_LOGI("Found operative message interchange protocol version to "
1937 "configure the `run` command's graph: mip-version=%" PRIu64
,
1939 ctx
->graph
= bt_graph_create(mip_version
);
1944 bt_graph_add_interrupter(ctx
->graph
, the_interrupter
);
1945 add_listener_status
= bt_graph_add_source_component_output_port_added_listener(
1946 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
1948 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1949 BT_CLI_LOGE_APPEND_CAUSE(
1950 "Cannot add \"port added\" listener to graph.");
1954 add_listener_status
= bt_graph_add_filter_component_output_port_added_listener(
1955 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
1957 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1958 BT_CLI_LOGE_APPEND_CAUSE(
1959 "Cannot add \"port added\" listener to graph.");
1966 cmd_run_ctx_destroy(ctx
);
1974 * Compute the intersection of all streams in the array `streams`, write it
1979 int compute_stream_intersection(const bt_value
*streams
,
1980 struct trace_range
*range
)
1982 uint64_t i
, stream_count
;
1985 BT_ASSERT(bt_value_get_type(streams
) == BT_VALUE_TYPE_ARRAY
);
1987 stream_count
= bt_value_array_get_length(streams
);
1989 BT_ASSERT(stream_count
> 0);
1991 range
->intersection_range_begin_ns
= 0;
1992 range
->intersection_range_end_ns
= UINT64_MAX
;
1994 for (i
= 0; i
< stream_count
; i
++) {
1995 int64_t begin_ns
, end_ns
;
1996 uint64_t begin_ns_u
, end_ns_u
;
1997 const bt_value
*stream_value
;
1998 const bt_value
*range_ns_value
;
1999 const bt_value
*begin_value
;
2000 const bt_value
*end_value
;
2002 stream_value
= bt_value_array_borrow_element_by_index_const(streams
, i
);
2003 if (bt_value_get_type(stream_value
) != BT_VALUE_TYPE_MAP
) {
2004 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2005 "expected streams array element to be a map, got %s.",
2006 bt_common_value_type_string(bt_value_get_type(stream_value
)));
2010 range_ns_value
= bt_value_map_borrow_entry_value_const(
2011 stream_value
, "range-ns");
2012 if (!range_ns_value
) {
2013 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2014 "missing expected `range-ns` key in stream map.");
2018 if (bt_value_get_type(range_ns_value
) != BT_VALUE_TYPE_MAP
) {
2019 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2020 "expected `range-ns` entry value of stream map to be a map, got %s.",
2021 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2025 begin_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "begin");
2027 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2028 "missing expected `begin` key in range-ns map.");
2032 if (bt_value_get_type(begin_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2033 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2034 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
2035 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2039 end_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "end");
2041 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2042 "missing expected `end` key in range-ns map.");
2046 if (bt_value_get_type(end_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2047 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2048 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
2049 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2053 begin_ns
= bt_value_integer_signed_get(begin_value
);
2054 end_ns
= bt_value_integer_signed_get(end_value
);
2056 if (begin_ns
< 0 || end_ns
< 0 || end_ns
< begin_ns
) {
2057 BT_CLI_LOGE_APPEND_CAUSE(
2058 "Invalid stream range values: "
2059 "range-ns:begin=%" PRId64
", "
2060 "range-ns:end=%" PRId64
,
2065 begin_ns_u
= begin_ns
;
2068 range
->intersection_range_begin_ns
=
2069 MAX(range
->intersection_range_begin_ns
, begin_ns_u
);
2070 range
->intersection_range_end_ns
=
2071 MIN(range
->intersection_range_end_ns
, end_ns_u
);
2084 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2085 struct bt_config_component
*cfg_comp
,
2086 const bt_component_class_source
*src_comp_cls
)
2090 uint64_t trace_count
;
2091 const bt_value
*query_result
= NULL
;
2092 const bt_value
*trace_info
= NULL
;
2093 const bt_value
*stream_infos
= NULL
;
2094 const bt_value
*stream_info
= NULL
;
2095 struct port_id
*port_id
= NULL
;
2096 struct trace_range
*stream_intersection
= NULL
;
2097 const char *fail_reason
= NULL
;
2098 const bt_component_class
*comp_cls
=
2099 bt_component_class_source_as_component_class_const(src_comp_cls
);
2101 ret
= query(ctx
->cfg
, comp_cls
, "babeltrace.trace-infos",
2102 cfg_comp
->params
, &query_result
,
2105 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2106 "comp-class-name=\"%s\"", fail_reason
,
2107 bt_component_class_get_name(comp_cls
));
2112 BT_ASSERT(query_result
);
2114 if (!bt_value_is_array(query_result
)) {
2115 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2116 "component-class-name=%s, actual-type=%s",
2117 bt_component_class_get_name(comp_cls
),
2118 bt_common_value_type_string(bt_value_get_type(query_result
)));
2123 trace_count
= bt_value_array_get_length(query_result
);
2124 if (trace_count
== 0) {
2125 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2126 "component-class-name=%s", bt_component_class_get_name(comp_cls
));
2131 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2132 uint64_t stream_idx
;
2133 int64_t stream_count
;
2134 struct trace_range trace_intersection
;
2136 trace_info
= bt_value_array_borrow_element_by_index_const(
2137 query_result
, trace_idx
);
2138 if (!bt_value_is_map(trace_info
)) {
2140 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2141 "component-class-name=%s, actual-type=%s",
2142 bt_component_class_get_name(comp_cls
),
2143 bt_common_value_type_string(bt_value_get_type(trace_info
)));
2147 stream_infos
= bt_value_map_borrow_entry_value_const(
2148 trace_info
, "stream-infos");
2149 if (!stream_infos
) {
2151 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2152 "component-class-name=%s",
2153 bt_component_class_get_name(comp_cls
));
2157 if (!bt_value_is_array(stream_infos
)) {
2159 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2160 "component-class-name=%s, actual-type=%s",
2161 bt_component_class_get_name(comp_cls
),
2162 bt_common_value_type_string(bt_value_get_type(stream_infos
)));
2166 stream_count
= bt_value_array_get_length(stream_infos
);
2167 if (stream_count
== 0) {
2169 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2170 "component-class-name=%s",
2171 bt_component_class_get_name(comp_cls
));
2175 ret
= compute_stream_intersection(stream_infos
, &trace_intersection
);
2177 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2181 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2182 const bt_value
*port_name
;
2184 port_id
= g_new0(struct port_id
, 1);
2187 BT_CLI_LOGE_APPEND_CAUSE(
2188 "Cannot allocate memory for port_id structure.");
2191 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2192 if (!port_id
->instance_name
) {
2194 BT_CLI_LOGE_APPEND_CAUSE(
2195 "Cannot allocate memory for port_id component instance name.");
2199 stream_intersection
= g_new0(struct trace_range
, 1);
2200 if (!stream_intersection
) {
2202 BT_CLI_LOGE_APPEND_CAUSE(
2203 "Cannot allocate memory for trace_range structure.");
2207 *stream_intersection
= trace_intersection
;
2209 stream_info
= bt_value_array_borrow_element_by_index_const(
2210 stream_infos
, stream_idx
);
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 enum bt_cmd_status
cmd_run(struct bt_config
*cfg
)
2502 enum bt_cmd_status cmd_status
;
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
:
2559 cmd_status
= BT_CMD_STATUS_OK
;
2561 case BT_GRAPH_RUN_STATUS_AGAIN
:
2562 if (bt_interrupter_is_set(the_interrupter
)) {
2564 * The graph was interrupted by a SIGINT.
2566 cmd_status
= BT_CMD_STATUS_INTERRUPTED
;
2570 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2571 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2573 cfg
->cmd_data
.run
.retry_duration_us
);
2575 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2576 if (bt_interrupter_is_set(the_interrupter
)) {
2577 cmd_status
= BT_CMD_STATUS_INTERRUPTED
;
2584 if (bt_interrupter_is_set(the_interrupter
)) {
2585 cmd_status
= BT_CMD_STATUS_INTERRUPTED
;
2589 BT_CLI_LOGE_APPEND_CAUSE(
2590 "Graph failed to complete successfully");
2595 cmd_status
= BT_CMD_STATUS_ERROR
;
2598 cmd_run_ctx_destroy(&ctx
);
2603 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2605 const char *env_clash
;
2607 if (!cfg
->command_name
) {
2611 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2612 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2616 if (g_file_test(cfg
->command_name
,
2617 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2618 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION
, __FILE__
, __LINE__
,
2619 BT_LOG_WARNING
, BT_LOG_TAG
,
2620 "The `%s` command was executed. "
2621 "If you meant to convert a trace located in "
2622 "the local `%s` directory, please use:\n\n"
2623 " babeltrace2 convert %s [OPTIONS]",
2624 cfg
->command_name
, cfg
->command_name
,
2630 void init_log_level(void)
2632 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2636 void print_error_causes(void)
2638 const bt_error
*error
= bt_current_thread_take_error();
2640 GString
*folded
= NULL
;
2641 unsigned int columns
;
2643 if (!error
|| bt_error_get_cause_count(error
) == 0) {
2644 fprintf(stderr
, "%s%sUnknown command-line error.%s\n",
2645 bt_common_color_bold(), bt_common_color_fg_red(),
2646 bt_common_color_reset());
2650 /* Try to get terminal width to fold the error cause messages */
2651 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
2652 /* Width not found: default to 80 */
2657 * This helps visually separate the error causes from the last
2658 * logging statement.
2660 fprintf(stderr
, "\n");
2662 /* Reverse order: deepest (root) cause printed at the end */
2663 for (i
= bt_error_get_cause_count(error
) - 1; i
>= 0; i
--) {
2664 const bt_error_cause
*cause
=
2665 bt_error_borrow_cause_by_index(error
, (uint64_t) i
);
2666 const char *prefix_fmt
=
2667 i
== bt_error_get_cause_count(error
) - 1 ?
2668 "%s%sERROR%s: " : "%s%sCAUSED BY%s ";
2671 fprintf(stderr
, prefix_fmt
,
2672 bt_common_color_bold(), bt_common_color_fg_red(),
2673 bt_common_color_reset());
2675 /* Print actor name */
2676 fprintf(stderr
, "[");
2677 switch (bt_error_cause_get_actor_type(cause
)) {
2678 case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN
:
2679 fprintf(stderr
, "%s%s%s",
2680 bt_common_color_bold(),
2681 bt_error_cause_get_module_name(cause
),
2682 bt_common_color_reset());
2684 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT
:
2685 fprintf(stderr
, "%s%s%s: ",
2686 bt_common_color_bold(),
2687 bt_error_cause_component_actor_get_component_name(cause
),
2688 bt_common_color_reset());
2689 print_plugin_comp_cls_opt(stderr
,
2690 bt_error_cause_component_actor_get_plugin_name(cause
),
2691 bt_error_cause_component_actor_get_component_class_name(cause
),
2692 bt_error_cause_component_actor_get_component_class_type(cause
));
2694 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS
:
2695 print_plugin_comp_cls_opt(stderr
,
2696 bt_error_cause_component_class_actor_get_plugin_name(cause
),
2697 bt_error_cause_component_class_actor_get_component_class_name(cause
),
2698 bt_error_cause_component_class_actor_get_component_class_type(cause
));
2700 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR
:
2701 fprintf(stderr
, "%s%s%s (%s%s%s): ",
2702 bt_common_color_bold(),
2703 bt_error_cause_message_iterator_actor_get_component_name(cause
),
2704 bt_common_color_reset(),
2705 bt_common_color_bold(),
2706 bt_error_cause_message_iterator_actor_get_component_output_port_name(cause
),
2707 bt_common_color_reset());
2708 print_plugin_comp_cls_opt(stderr
,
2709 bt_error_cause_message_iterator_actor_get_plugin_name(cause
),
2710 bt_error_cause_message_iterator_actor_get_component_class_name(cause
),
2711 bt_error_cause_message_iterator_actor_get_component_class_type(cause
));
2717 /* Print file name and line number */
2718 fprintf(stderr
, "] (%s%s%s%s:%s%" PRIu64
"%s)\n",
2719 bt_common_color_bold(),
2720 bt_common_color_fg_magenta(),
2721 bt_error_cause_get_file_name(cause
),
2722 bt_common_color_reset(),
2723 bt_common_color_fg_green(),
2724 bt_error_cause_get_line_number(cause
),
2725 bt_common_color_reset());
2728 folded
= bt_common_fold(bt_error_cause_get_message(cause
),
2731 BT_LOGE_STR("Could not fold string.");
2732 fprintf(stderr
, "%s\n",
2733 bt_error_cause_get_message(cause
));
2737 fprintf(stderr
, "%s\n", folded
->str
);
2738 g_string_free(folded
, TRUE
);
2746 bt_error_release(error
);
2750 int main(int argc
, const char **argv
)
2753 enum bt_cmd_status cmd_status
;
2754 struct bt_config
*cfg
= NULL
;
2757 set_signal_handler();
2758 init_loaded_plugins();
2760 BT_ASSERT(!the_interrupter
);
2761 the_interrupter
= bt_interrupter_create();
2762 if (!the_interrupter
) {
2763 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2768 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
,
2772 /* Quit without errors; typically usage/version */
2774 BT_LOGI_STR("Quitting without errors.");
2779 BT_CLI_LOGE_APPEND_CAUSE(
2780 "Command-line error: retcode=%d", retcode
);
2785 BT_CLI_LOGE_APPEND_CAUSE(
2786 "Failed to create a valid Babeltrace CLI configuration.");
2793 if (cfg
->command_needs_plugins
) {
2794 ret
= require_loaded_plugins(cfg
->plugin_paths
);
2796 BT_CLI_LOGE_APPEND_CAUSE(
2797 "Failed to load plugins: ret=%d", ret
);
2803 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2804 cfg
->command
, cfg
->command_name
);
2806 switch (cfg
->command
) {
2807 case BT_CONFIG_COMMAND_RUN
:
2808 cmd_status
= cmd_run(cfg
);
2810 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2811 cmd_status
= cmd_list_plugins(cfg
);
2813 case BT_CONFIG_COMMAND_HELP
:
2814 cmd_status
= cmd_help(cfg
);
2816 case BT_CONFIG_COMMAND_QUERY
:
2817 cmd_status
= cmd_query(cfg
);
2819 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2820 cmd_status
= cmd_print_ctf_metadata(cfg
);
2822 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2823 cmd_status
= cmd_print_lttng_live_sessions(cfg
);
2826 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2830 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", command-status=\"%s\"",
2831 cfg
->command
, cfg
->command_name
, bt_cmd_status_string(cmd_status
));
2832 warn_command_name_and_directory_clash(cfg
);
2834 switch (cmd_status
) {
2835 case BT_CMD_STATUS_OK
:
2838 case BT_CMD_STATUS_ERROR
:
2840 print_error_causes();
2842 case BT_CMD_STATUS_INTERRUPTED
:
2846 BT_LOGF("Invalid command status: cmd-status=%d", cmd_status
);
2851 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2852 fini_loaded_plugins();
2853 bt_interrupter_put_ref(the_interrupter
);
2856 * Clear current thread's error in case there is one to avoid a
2859 bt_current_thread_clear_error();