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
)
337 GPtrArray
*map_keys
= NULL
;
343 switch (bt_value_get_type(value
)) {
344 case BT_VALUE_TYPE_NULL
:
345 fprintf(fp
, "%snull%s\n", bt_common_color_bold(),
346 bt_common_color_reset());
348 case BT_VALUE_TYPE_BOOL
:
349 bool_val
= bt_value_bool_get(value
);
350 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
351 bt_common_color_fg_cyan(), bool_val
? "yes" : "no",
352 bt_common_color_reset());
354 case BT_VALUE_TYPE_UNSIGNED_INTEGER
:
355 uint_val
= bt_value_integer_unsigned_get(value
);
356 fprintf(fp
, "%s%s%" PRIu64
"%s\n", bt_common_color_bold(),
357 bt_common_color_fg_red(), uint_val
,
358 bt_common_color_reset());
360 case BT_VALUE_TYPE_SIGNED_INTEGER
:
361 int_val
= bt_value_integer_signed_get(value
);
362 fprintf(fp
, "%s%s%" PRId64
"%s\n", bt_common_color_bold(),
363 bt_common_color_fg_red(), int_val
,
364 bt_common_color_reset());
366 case BT_VALUE_TYPE_REAL
:
367 dbl_val
= bt_value_real_get(value
);
368 fprintf(fp
, "%s%s%lf%s\n", bt_common_color_bold(),
369 bt_common_color_fg_red(), dbl_val
,
370 bt_common_color_reset());
372 case BT_VALUE_TYPE_STRING
:
373 str_val
= bt_value_string_get(value
);
374 fprintf(fp
, "%s%s%s%s\n", bt_common_color_bold(),
375 bt_common_color_fg_green(), str_val
,
376 bt_common_color_reset());
378 case BT_VALUE_TYPE_ARRAY
:
381 size
= bt_value_array_get_length(value
);
383 print_indent(fp
, indent
);
384 fprintf(fp
, "[ ]\n");
388 for (i
= 0; i
< size
; i
++) {
389 const bt_value
*element
=
390 bt_value_array_borrow_element_by_index_const(
393 print_indent(fp
, indent
);
396 if (bt_value_is_array(element
) &&
397 bt_value_array_is_empty(element
)) {
398 fprintf(fp
, "[ ]\n");
402 if (bt_value_is_map(element
) &&
403 bt_value_map_is_empty(element
)) {
404 fprintf(fp
, "{ }\n");
408 if (bt_value_is_array(element
) ||
409 bt_value_is_map(element
)) {
413 print_value_rec(fp
, element
, indent
+ 2);
417 case BT_VALUE_TYPE_MAP
:
420 bt_value_map_foreach_entry_const_status foreach_status
;
422 if (bt_value_map_is_empty(value
)) {
423 print_indent(fp
, indent
);
424 fprintf(fp
, "{ }\n");
428 map_keys
= g_ptr_array_new();
430 BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
435 * We want to print the map entries in a stable order. Collect
436 * all the map's keys in a GPtrArray, sort it, then print the
437 * entries in that order.
439 foreach_status
= bt_value_map_foreach_entry_const(value
,
440 collect_map_keys
, map_keys
);
441 if (foreach_status
!= BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK
) {
442 BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
446 g_ptr_array_sort(map_keys
, g_ptr_array_sort_strings
);
448 for (i
= 0; i
< map_keys
->len
; i
++) {
449 const char *map_key
= g_ptr_array_index(map_keys
, i
);
450 const bt_value
*map_value
;
452 map_value
= bt_value_map_borrow_entry_value_const(value
, map_key
);
453 BT_ASSERT(map_value
);
455 print_map_value(map_key
, map_value
, fp
, indent
);
468 g_ptr_array_free(map_keys
, TRUE
);
473 void print_value(FILE *fp
, const bt_value
*value
, size_t indent
)
475 if (!bt_value_is_array(value
) && !bt_value_is_map(value
)) {
476 print_indent(fp
, indent
);
479 print_value_rec(fp
, value
, indent
);
483 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
485 fprintf(stderr
, " ");
486 print_plugin_comp_cls_opt(stderr
, bt_config_component
->plugin_name
->str
,
487 bt_config_component
->comp_cls_name
->str
,
488 bt_config_component
->type
);
489 fprintf(stderr
, ":\n");
491 if (bt_config_component
->instance_name
->len
> 0) {
492 fprintf(stderr
, " Name: %s\n",
493 bt_config_component
->instance_name
->str
);
496 fprintf(stderr
, " Parameters:\n");
497 print_value(stderr
, bt_config_component
->params
, 8);
501 void print_bt_config_components(GPtrArray
*array
)
505 for (i
= 0; i
< array
->len
; i
++) {
506 struct bt_config_component
*cfg_component
=
507 bt_config_get_component(array
, i
);
508 print_bt_config_component(cfg_component
);
509 BT_OBJECT_PUT_REF_AND_RESET(cfg_component
);
514 void print_plugin_paths(const bt_value
*plugin_paths
)
516 fprintf(stderr
, " Plugin paths:\n");
517 print_value(stderr
, plugin_paths
, 4);
521 void print_cfg_run(struct bt_config
*cfg
)
525 print_plugin_paths(cfg
->plugin_paths
);
526 fprintf(stderr
, " Source component instances:\n");
527 print_bt_config_components(cfg
->cmd_data
.run
.sources
);
529 if (cfg
->cmd_data
.run
.filters
->len
> 0) {
530 fprintf(stderr
, " Filter component instances:\n");
531 print_bt_config_components(cfg
->cmd_data
.run
.filters
);
534 fprintf(stderr
, " Sink component instances:\n");
535 print_bt_config_components(cfg
->cmd_data
.run
.sinks
);
536 fprintf(stderr
, " Connections:\n");
538 for (i
= 0; i
< cfg
->cmd_data
.run
.connections
->len
; i
++) {
539 struct bt_config_connection
*cfg_connection
=
540 g_ptr_array_index(cfg
->cmd_data
.run
.connections
,
543 fprintf(stderr
, " %s%s%s -> %s%s%s\n",
544 cfg_connection
->upstream_comp_name
->str
,
545 cfg_connection
->upstream_port_glob
->len
> 0 ? "." : "",
546 cfg_connection
->upstream_port_glob
->str
,
547 cfg_connection
->downstream_comp_name
->str
,
548 cfg_connection
->downstream_port_glob
->len
> 0 ? "." : "",
549 cfg_connection
->downstream_port_glob
->str
);
554 void print_cfg_list_plugins(struct bt_config
*cfg
)
556 print_plugin_paths(cfg
->plugin_paths
);
560 void print_cfg_help(struct bt_config
*cfg
)
562 print_plugin_paths(cfg
->plugin_paths
);
566 void print_cfg_print_ctf_metadata(struct bt_config
*cfg
)
568 print_plugin_paths(cfg
->plugin_paths
);
569 fprintf(stderr
, " Path: %s\n",
570 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
574 void print_cfg_print_lttng_live_sessions(struct bt_config
*cfg
)
576 print_plugin_paths(cfg
->plugin_paths
);
577 fprintf(stderr
, " URL: %s\n",
578 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
582 void print_cfg_query(struct bt_config
*cfg
)
584 print_plugin_paths(cfg
->plugin_paths
);
585 fprintf(stderr
, " Object: `%s`\n", cfg
->cmd_data
.query
.object
->str
);
586 fprintf(stderr
, " Component class:\n");
587 print_bt_config_component(cfg
->cmd_data
.query
.cfg_component
);
591 void print_cfg(struct bt_config
*cfg
)
593 if (!BT_LOG_ON_INFO
) {
597 BT_LOGI_STR("CLI configuration:");
599 switch (cfg
->command
) {
600 case BT_CONFIG_COMMAND_RUN
:
603 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
604 print_cfg_list_plugins(cfg
);
606 case BT_CONFIG_COMMAND_HELP
:
609 case BT_CONFIG_COMMAND_QUERY
:
610 print_cfg_query(cfg
);
612 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
613 print_cfg_print_ctf_metadata(cfg
);
615 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
616 print_cfg_print_lttng_live_sessions(cfg
);
624 void print_plugin_info(const bt_plugin
*plugin
)
626 unsigned int major
, minor
, patch
;
628 bt_property_availability version_avail
;
629 const char *plugin_name
;
633 const char *plugin_description
;
635 plugin_name
= bt_plugin_get_name(plugin
);
636 path
= bt_plugin_get_path(plugin
);
637 author
= bt_plugin_get_author(plugin
);
638 license
= bt_plugin_get_license(plugin
);
639 plugin_description
= bt_plugin_get_description(plugin
);
640 version_avail
= bt_plugin_get_version(plugin
, &major
, &minor
,
642 printf("%s%s%s%s:\n", bt_common_color_bold(),
643 bt_common_color_fg_blue(), plugin_name
,
644 bt_common_color_reset());
646 printf(" %sPath%s: %s\n", bt_common_color_bold(),
647 bt_common_color_reset(), path
);
652 if (version_avail
== BT_PROPERTY_AVAILABILITY_AVAILABLE
) {
653 printf(" %sVersion%s: %u.%u.%u",
654 bt_common_color_bold(), bt_common_color_reset(),
655 major
, minor
, patch
);
664 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
665 bt_common_color_reset(),
666 plugin_description
? plugin_description
: "(None)");
667 printf(" %sAuthor%s: %s\n", bt_common_color_bold(),
668 bt_common_color_reset(), author
? author
: "(Unknown)");
669 printf(" %sLicense%s: %s\n", bt_common_color_bold(),
670 bt_common_color_reset(),
671 license
? license
: "(Unknown)");
675 int cmd_query(struct bt_config
*cfg
)
678 const bt_component_class
*comp_cls
= NULL
;
679 const bt_value
*results
= NULL
;
680 const char *fail_reason
= NULL
;
682 comp_cls
= find_component_class(
683 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
684 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
685 cfg
->cmd_data
.query
.cfg_component
->type
);
687 BT_CLI_LOGE_APPEND_CAUSE(
688 "Cannot find component class: plugin-name=\"%s\", "
689 "comp-cls-name=\"%s\", comp-cls-type=%d",
690 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
691 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
692 cfg
->cmd_data
.query
.cfg_component
->type
);
697 ret
= query(cfg
, comp_cls
, cfg
->cmd_data
.query
.object
->str
,
698 cfg
->cmd_data
.query
.cfg_component
->params
,
699 &results
, &fail_reason
);
704 print_value(stdout
, results
, 0);
708 BT_CLI_LOGE_APPEND_CAUSE(
709 "Failed to query component class: %s: plugin-name=\"%s\", "
710 "comp-cls-name=\"%s\", comp-cls-type=%d "
711 "object=\"%s\"", fail_reason
,
712 cfg
->cmd_data
.query
.cfg_component
->plugin_name
->str
,
713 cfg
->cmd_data
.query
.cfg_component
->comp_cls_name
->str
,
714 cfg
->cmd_data
.query
.cfg_component
->type
,
715 cfg
->cmd_data
.query
.object
->str
);
719 bt_component_class_put_ref(comp_cls
);
720 bt_value_put_ref(results
);
725 void print_component_class_help(const char *plugin_name
,
726 const bt_component_class
*comp_cls
)
728 const char *comp_class_name
=
729 bt_component_class_get_name(comp_cls
);
730 const char *comp_class_description
=
731 bt_component_class_get_description(comp_cls
);
732 const char *comp_class_help
=
733 bt_component_class_get_help(comp_cls
);
734 bt_component_class_type type
=
735 bt_component_class_get_type(comp_cls
);
737 print_plugin_comp_cls_opt(stdout
, plugin_name
, comp_class_name
, type
);
739 printf(" %sDescription%s: %s\n", bt_common_color_bold(),
740 bt_common_color_reset(),
741 comp_class_description
? comp_class_description
: "(None)");
743 if (comp_class_help
) {
744 printf("\n%s\n", comp_class_help
);
749 int cmd_help(struct bt_config
*cfg
)
752 const bt_plugin
*plugin
= NULL
;
753 const bt_component_class
*needed_comp_cls
= NULL
;
755 plugin
= find_loaded_plugin(cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
757 BT_CLI_LOGE_APPEND_CAUSE(
758 "Cannot find plugin: plugin-name=\"%s\"",
759 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
);
764 print_plugin_info(plugin
);
765 printf(" %sSource component classes%s: %d\n",
766 bt_common_color_bold(),
767 bt_common_color_reset(),
768 (int) bt_plugin_get_source_component_class_count(plugin
));
769 printf(" %sFilter component classes%s: %d\n",
770 bt_common_color_bold(),
771 bt_common_color_reset(),
772 (int) bt_plugin_get_filter_component_class_count(plugin
));
773 printf(" %sSink component classes%s: %d\n",
774 bt_common_color_bold(),
775 bt_common_color_reset(),
776 (int) bt_plugin_get_sink_component_class_count(plugin
));
778 if (strlen(cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
) == 0) {
779 /* Plugin help only */
783 needed_comp_cls
= find_component_class(
784 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
785 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
786 cfg
->cmd_data
.help
.cfg_component
->type
);
787 if (!needed_comp_cls
) {
788 BT_CLI_LOGE_APPEND_CAUSE(
789 "Cannot find component class: plugin-name=\"%s\", "
790 "comp-cls-name=\"%s\", comp-cls-type=%d",
791 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
792 cfg
->cmd_data
.help
.cfg_component
->comp_cls_name
->str
,
793 cfg
->cmd_data
.help
.cfg_component
->type
);
799 print_component_class_help(
800 cfg
->cmd_data
.help
.cfg_component
->plugin_name
->str
,
804 bt_component_class_put_ref(needed_comp_cls
);
805 bt_plugin_put_ref(plugin
);
809 typedef void *(* plugin_borrow_comp_cls_by_index_func_t
)(const bt_plugin
*,
811 typedef const bt_component_class
*(* spec_comp_cls_borrow_comp_cls_func_t
)(
815 void cmd_list_plugins_print_component_classes(const bt_plugin
*plugin
,
816 const char *cc_type_name
, uint64_t count
,
817 plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func
,
818 spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func
)
823 printf(" %s%s component classes%s: (none)\n",
824 bt_common_color_bold(),
826 bt_common_color_reset());
829 printf(" %s%s component classes%s:\n",
830 bt_common_color_bold(),
832 bt_common_color_reset());
835 for (i
= 0; i
< count
; i
++) {
836 const bt_component_class
*comp_class
=
837 spec_comp_cls_borrow_comp_cls_func(
838 borrow_comp_cls_by_index_func(plugin
, i
));
839 const char *comp_class_name
=
840 bt_component_class_get_name(comp_class
);
841 const char *comp_class_description
=
842 bt_component_class_get_description(comp_class
);
843 bt_component_class_type type
=
844 bt_component_class_get_type(comp_class
);
847 print_plugin_comp_cls_opt(stdout
,
848 bt_plugin_get_name(plugin
), comp_class_name
,
851 if (comp_class_description
) {
852 printf(": %s", comp_class_description
);
863 int cmd_list_plugins(struct bt_config
*cfg
)
866 int plugins_count
, component_classes_count
= 0, i
;
868 printf("From the following plugin paths:\n\n");
869 print_value(stdout
, cfg
->plugin_paths
, 2);
871 plugins_count
= get_loaded_plugins_count();
872 if (plugins_count
== 0) {
873 printf("No plugins found.\n");
877 for (i
= 0; i
< plugins_count
; i
++) {
878 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
880 component_classes_count
+=
881 bt_plugin_get_source_component_class_count(plugin
) +
882 bt_plugin_get_filter_component_class_count(plugin
) +
883 bt_plugin_get_sink_component_class_count(plugin
);
886 printf("Found %s%d%s component classes in %s%d%s plugins.\n",
887 bt_common_color_bold(),
888 component_classes_count
,
889 bt_common_color_reset(),
890 bt_common_color_bold(),
892 bt_common_color_reset());
894 for (i
= 0; i
< plugins_count
; i
++) {
895 const bt_plugin
*plugin
= borrow_loaded_plugin(i
);
898 print_plugin_info(plugin
);
899 cmd_list_plugins_print_component_classes(plugin
, "Source",
900 bt_plugin_get_source_component_class_count(plugin
),
901 (plugin_borrow_comp_cls_by_index_func_t
)
902 bt_plugin_borrow_source_component_class_by_index_const
,
903 (spec_comp_cls_borrow_comp_cls_func_t
)
904 bt_component_class_source_as_component_class
);
905 cmd_list_plugins_print_component_classes(plugin
, "Filter",
906 bt_plugin_get_filter_component_class_count(plugin
),
907 (plugin_borrow_comp_cls_by_index_func_t
)
908 bt_plugin_borrow_filter_component_class_by_index_const
,
909 (spec_comp_cls_borrow_comp_cls_func_t
)
910 bt_component_class_filter_as_component_class
);
911 cmd_list_plugins_print_component_classes(plugin
, "Sink",
912 bt_plugin_get_sink_component_class_count(plugin
),
913 (plugin_borrow_comp_cls_by_index_func_t
)
914 bt_plugin_borrow_sink_component_class_by_index_const
,
915 (spec_comp_cls_borrow_comp_cls_func_t
)
916 bt_component_class_sink_as_component_class
);
924 int cmd_print_lttng_live_sessions(struct bt_config
*cfg
)
927 const bt_component_class
*comp_cls
= NULL
;
928 const bt_value
*results
= NULL
;
929 bt_value
*params
= NULL
;
930 const bt_value
*map
= NULL
;
931 const bt_value
*v
= NULL
;
932 static const char * const plugin_name
= "ctf";
933 static const char * const comp_cls_name
= "lttng-live";
934 static const bt_component_class_type comp_cls_type
=
935 BT_COMPONENT_CLASS_TYPE_SOURCE
;
936 uint64_t array_size
, i
;
937 const char *fail_reason
= NULL
;
938 FILE *out_stream
= stdout
;
940 BT_ASSERT(cfg
->cmd_data
.print_lttng_live_sessions
.url
);
941 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
944 BT_CLI_LOGE_APPEND_CAUSE(
945 "Cannot find component class: plugin-name=\"%s\", "
946 "comp-cls-name=\"%s\", comp-cls-type=%d",
947 plugin_name
, comp_cls_name
,
948 BT_COMPONENT_CLASS_TYPE_SOURCE
);
952 params
= bt_value_map_create();
957 ret
= bt_value_map_insert_string_entry(params
, "url",
958 cfg
->cmd_data
.print_lttng_live_sessions
.url
->str
);
963 ret
= query(cfg
, comp_cls
, "sessions", params
,
964 &results
, &fail_reason
);
971 if (!bt_value_is_array(results
)) {
972 BT_CLI_LOGE_APPEND_CAUSE(
973 "Expecting an array for LTTng live `sessions` query.");
977 if (cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->len
> 0) {
979 fopen(cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
,
983 BT_LOGE_ERRNO("Cannot open file for writing",
985 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
986 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
988 "Cannot open file for writing: path=\"%s\"",
989 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
994 array_size
= bt_value_array_get_length(results
);
995 for (i
= 0; i
< array_size
; i
++) {
996 const char *url_text
;
997 int64_t timer_us
, streams
, clients
;
999 map
= bt_value_array_borrow_element_by_index_const(results
, i
);
1000 if (!bt_value_is_map(map
)) {
1001 BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
1005 v
= bt_value_map_borrow_entry_value_const(map
, "url");
1007 BT_CLI_LOGE_APPEND_CAUSE("Missing `url` entry.");
1010 url_text
= bt_value_string_get(v
);
1011 fprintf(out_stream
, "%s", url_text
);
1012 v
= bt_value_map_borrow_entry_value_const(map
, "timer-us");
1014 BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry.");
1017 timer_us
= bt_value_integer_unsigned_get(v
);
1018 fprintf(out_stream
, " (timer = %" PRIu64
", ", timer_us
);
1019 v
= bt_value_map_borrow_entry_value_const(map
, "stream-count");
1021 BT_CLI_LOGE_APPEND_CAUSE(
1022 "Missing `stream-count` entry.");
1025 streams
= bt_value_integer_unsigned_get(v
);
1026 fprintf(out_stream
, "%" PRIu64
" stream(s), ", streams
);
1027 v
= bt_value_map_borrow_entry_value_const(map
, "client-count");
1029 BT_CLI_LOGE_APPEND_CAUSE(
1030 "Missing `client-count` entry.");
1033 clients
= bt_value_integer_unsigned_get(v
);
1034 fprintf(out_stream
, "%" PRIu64
" client(s) connected)\n", clients
);
1040 BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
1047 bt_value_put_ref(results
);
1048 bt_value_put_ref(params
);
1049 bt_component_class_put_ref(comp_cls
);
1051 if (out_stream
&& out_stream
!= stdout
) {
1052 int fclose_ret
= fclose(out_stream
);
1055 BT_LOGE_ERRNO("Cannot close file stream",
1057 cfg
->cmd_data
.print_lttng_live_sessions
.output_path
->str
);
1065 int cmd_print_ctf_metadata(struct bt_config
*cfg
)
1068 const bt_component_class
*comp_cls
= NULL
;
1069 const bt_value
*results
= NULL
;
1070 bt_value
*params
= NULL
;
1071 const bt_value
*metadata_text_value
= NULL
;
1072 const char *metadata_text
= NULL
;
1073 static const char * const plugin_name
= "ctf";
1074 static const char * const comp_cls_name
= "fs";
1075 static const bt_component_class_type comp_cls_type
=
1076 BT_COMPONENT_CLASS_TYPE_SOURCE
;
1077 const char *fail_reason
= NULL
;
1078 FILE *out_stream
= stdout
;
1080 BT_ASSERT(cfg
->cmd_data
.print_ctf_metadata
.path
);
1081 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1084 BT_CLI_LOGE_APPEND_CAUSE(
1085 "Cannot find component class: plugin-name=\"%s\", "
1086 "comp-cls-name=\"%s\", comp-cls-type=%d",
1087 plugin_name
, comp_cls_name
,
1088 BT_COMPONENT_CLASS_TYPE_SOURCE
);
1093 params
= bt_value_map_create();
1099 ret
= bt_value_map_insert_string_entry(params
, "path",
1100 cfg
->cmd_data
.print_ctf_metadata
.path
->str
);
1106 ret
= query(cfg
, comp_cls
, "metadata-info",
1107 params
, &results
, &fail_reason
);
1112 metadata_text_value
= bt_value_map_borrow_entry_value_const(results
,
1114 if (!metadata_text_value
) {
1115 BT_CLI_LOGE_APPEND_CAUSE(
1116 "Cannot find `text` string value in the resulting metadata info object.");
1121 metadata_text
= bt_value_string_get(metadata_text_value
);
1123 if (cfg
->cmd_data
.print_ctf_metadata
.output_path
->len
> 0) {
1125 fopen(cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
,
1128 BT_LOGE_ERRNO("Cannot open file for writing",
1130 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1131 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
1133 "Cannot open file for writing: path=\"%s\"",
1134 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1140 ret
= fprintf(out_stream
, "%s\n", metadata_text
);
1142 BT_CLI_LOGE_APPEND_CAUSE(
1143 "Cannot write whole metadata text to output stream: "
1153 BT_CLI_LOGE_APPEND_CAUSE(
1154 "Failed to query `metadata-info` object: %s", fail_reason
);
1157 bt_value_put_ref(results
);
1158 bt_value_put_ref(params
);
1159 bt_component_class_put_ref(comp_cls
);
1161 if (out_stream
&& out_stream
!= stdout
) {
1162 int fclose_ret
= fclose(out_stream
);
1165 BT_LOGE_ERRNO("Cannot close file stream",
1167 cfg
->cmd_data
.print_ctf_metadata
.output_path
->str
);
1175 char *instance_name
;
1179 struct trace_range
{
1180 uint64_t intersection_range_begin_ns
;
1181 uint64_t intersection_range_end_ns
;
1185 guint
port_id_hash(gconstpointer v
)
1187 const struct port_id
*id
= v
;
1189 BT_ASSERT(id
->instance_name
);
1190 BT_ASSERT(id
->port_name
);
1192 return g_str_hash(id
->instance_name
) ^ g_str_hash(id
->port_name
);
1196 gboolean
port_id_equal(gconstpointer v1
, gconstpointer v2
)
1198 const struct port_id
*id1
= v1
;
1199 const struct port_id
*id2
= v2
;
1201 return strcmp(id1
->instance_name
, id2
->instance_name
) == 0 &&
1202 strcmp(id1
->port_name
, id2
->port_name
) == 0;
1206 void port_id_destroy(gpointer data
)
1208 struct port_id
*id
= data
;
1210 free(id
->instance_name
);
1211 free(id
->port_name
);
1216 void trace_range_destroy(gpointer data
)
1221 struct cmd_run_ctx
{
1223 GHashTable
*src_components
;
1226 GHashTable
*flt_components
;
1229 GHashTable
*sink_components
;
1235 struct bt_config
*cfg
;
1239 bool stream_intersection_mode
;
1242 * Association of struct port_id -> struct trace_range.
1244 GHashTable
*intersections
;
1247 /* Returns a timestamp of the form "(-)s.ns" */
1249 char *s_from_ns(int64_t ns
)
1254 int64_t ts_sec_abs
, ts_nsec_abs
;
1255 int64_t ts_sec
= ns
/ NSEC_PER_SEC
;
1256 int64_t ts_nsec
= ns
% NSEC_PER_SEC
;
1258 if (ts_sec
>= 0 && ts_nsec
>= 0) {
1259 is_negative
= false;
1260 ts_sec_abs
= ts_sec
;
1261 ts_nsec_abs
= ts_nsec
;
1262 } else if (ts_sec
> 0 && ts_nsec
< 0) {
1263 is_negative
= false;
1264 ts_sec_abs
= ts_sec
- 1;
1265 ts_nsec_abs
= NSEC_PER_SEC
+ ts_nsec
;
1266 } else if (ts_sec
== 0 && ts_nsec
< 0) {
1268 ts_sec_abs
= ts_sec
;
1269 ts_nsec_abs
= -ts_nsec
;
1270 } else if (ts_sec
< 0 && ts_nsec
> 0) {
1272 ts_sec_abs
= -(ts_sec
+ 1);
1273 ts_nsec_abs
= NSEC_PER_SEC
- ts_nsec
;
1274 } else if (ts_sec
< 0 && ts_nsec
== 0) {
1276 ts_sec_abs
= -ts_sec
;
1277 ts_nsec_abs
= ts_nsec
;
1278 } else { /* (ts_sec < 0 && ts_nsec < 0) */
1280 ts_sec_abs
= -ts_sec
;
1281 ts_nsec_abs
= -ts_nsec
;
1284 ret
= asprintf(&s_ret
, "%s%" PRId64
".%09" PRId64
,
1285 is_negative
? "-" : "", ts_sec_abs
, ts_nsec_abs
);
1293 int cmd_run_ctx_connect_upstream_port_to_downstream_component(
1294 struct cmd_run_ctx
*ctx
,
1295 const bt_component
*upstream_comp
,
1296 const bt_port_output
*out_upstream_port
,
1297 struct bt_config_connection
*cfg_conn
)
1299 typedef uint64_t (*input_port_count_func_t
)(void *);
1300 typedef const bt_port_input
*(*borrow_input_port_by_index_func_t
)(
1301 const void *, uint64_t);
1302 const bt_port
*upstream_port
=
1303 bt_port_output_as_port_const(out_upstream_port
);
1306 GQuark downstreamp_comp_name_quark
;
1307 void *downstream_comp
;
1308 uint64_t downstream_port_count
;
1310 input_port_count_func_t port_count_fn
;
1311 borrow_input_port_by_index_func_t port_by_index_fn
;
1312 bt_graph_connect_ports_status connect_ports_status
=
1313 BT_GRAPH_CONNECT_PORTS_STATUS_OK
;
1314 bool insert_trimmer
= false;
1315 bt_value
*trimmer_params
= NULL
;
1316 char *intersection_begin
= NULL
;
1317 char *intersection_end
= NULL
;
1318 const bt_component_filter
*trimmer
= NULL
;
1319 const bt_component_class_filter
*trimmer_class
= NULL
;
1320 const bt_port_input
*trimmer_input
= NULL
;
1321 const bt_port_output
*trimmer_output
= NULL
;
1323 if (ctx
->intersections
&&
1324 bt_component_get_class_type(upstream_comp
) ==
1325 BT_COMPONENT_CLASS_TYPE_SOURCE
) {
1326 struct trace_range
*range
;
1327 struct port_id port_id
= {
1328 .instance_name
= (char *) bt_component_get_name(upstream_comp
),
1329 .port_name
= (char *) bt_port_get_name(upstream_port
)
1332 if (!port_id
.instance_name
|| !port_id
.port_name
) {
1336 range
= (struct trace_range
*) g_hash_table_lookup(
1337 ctx
->intersections
, &port_id
);
1339 bt_value_map_insert_entry_status insert_status
;
1341 intersection_begin
= s_from_ns(
1342 range
->intersection_range_begin_ns
);
1343 intersection_end
= s_from_ns(
1344 range
->intersection_range_end_ns
);
1345 if (!intersection_begin
|| !intersection_end
) {
1346 BT_CLI_LOGE_APPEND_CAUSE(
1347 "Cannot create trimmer argument timestamp string.");
1351 insert_trimmer
= true;
1352 trimmer_params
= bt_value_map_create();
1353 if (!trimmer_params
) {
1357 insert_status
= bt_value_map_insert_string_entry(
1358 trimmer_params
, "begin", intersection_begin
);
1359 if (insert_status
< 0) {
1362 insert_status
= bt_value_map_insert_string_entry(
1364 "end", intersection_end
);
1365 if (insert_status
< 0) {
1370 trimmer_class
= find_filter_component_class("utils", "trimmer");
1371 if (!trimmer_class
) {
1376 BT_LOGI("Connecting upstream port to the next available downstream port: "
1377 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1378 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1379 upstream_port
, bt_port_get_name(upstream_port
),
1380 cfg_conn
->downstream_comp_name
->str
,
1381 cfg_conn
->arg
->str
);
1382 downstreamp_comp_name_quark
= g_quark_from_string(
1383 cfg_conn
->downstream_comp_name
->str
);
1384 BT_ASSERT(downstreamp_comp_name_quark
> 0);
1385 downstream_comp
= g_hash_table_lookup(ctx
->flt_components
,
1386 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1387 port_count_fn
= (input_port_count_func_t
)
1388 bt_component_filter_get_input_port_count
;
1389 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1390 bt_component_filter_borrow_input_port_by_index_const
;
1392 if (!downstream_comp
) {
1393 downstream_comp
= g_hash_table_lookup(ctx
->sink_components
,
1394 GUINT_TO_POINTER(downstreamp_comp_name_quark
));
1395 port_count_fn
= (input_port_count_func_t
)
1396 bt_component_sink_get_input_port_count
;
1397 port_by_index_fn
= (borrow_input_port_by_index_func_t
)
1398 bt_component_sink_borrow_input_port_by_index_const
;
1401 if (!downstream_comp
) {
1402 BT_CLI_LOGE_APPEND_CAUSE("Cannot find downstream component: "
1403 "comp-name=\"%s\", conn-arg=\"%s\"",
1404 cfg_conn
->downstream_comp_name
->str
,
1405 cfg_conn
->arg
->str
);
1409 downstream_port_count
= port_count_fn(downstream_comp
);
1411 for (i
= 0; i
< downstream_port_count
; i
++) {
1412 const bt_port_input
*in_downstream_port
=
1413 port_by_index_fn(downstream_comp
, i
);
1414 const bt_port
*downstream_port
=
1415 bt_port_input_as_port_const(in_downstream_port
);
1416 const char *upstream_port_name
;
1417 const char *downstream_port_name
;
1419 BT_ASSERT(downstream_port
);
1421 /* Skip port if it's already connected. */
1422 if (bt_port_is_connected(downstream_port
)) {
1423 BT_LOGI("Skipping downstream port: already connected: "
1424 "port-addr=%p, port-name=\"%s\"",
1426 bt_port_get_name(downstream_port
));
1430 downstream_port_name
= bt_port_get_name(downstream_port
);
1431 BT_ASSERT(downstream_port_name
);
1432 upstream_port_name
= bt_port_get_name(upstream_port
);
1433 BT_ASSERT(upstream_port_name
);
1435 if (!bt_common_star_glob_match(
1436 cfg_conn
->downstream_port_glob
->str
, SIZE_MAX
,
1437 downstream_port_name
, SIZE_MAX
)) {
1441 if (insert_trimmer
) {
1443 * In order to insert the trimmer between the
1444 * two components that were being connected, we
1445 * create a connection configuration entry which
1446 * describes a connection from the trimmer's
1447 * output to the original input that was being
1450 * Hence, the creation of the trimmer will cause
1451 * the graph "new port" listener to establish
1452 * all downstream connections as its output port
1453 * is connected. We will then establish the
1454 * connection between the original upstream
1455 * source and the trimmer.
1457 char *trimmer_name
= NULL
;
1458 bt_graph_add_component_status add_comp_status
;
1460 ret
= asprintf(&trimmer_name
,
1461 "stream-intersection-trimmer-%s",
1462 upstream_port_name
);
1468 ctx
->connect_ports
= false;
1469 add_comp_status
= bt_graph_add_filter_component(
1470 ctx
->graph
, trimmer_class
, trimmer_name
,
1471 trimmer_params
, ctx
->cfg
->log_level
,
1474 if (add_comp_status
!=
1475 BT_GRAPH_ADD_COMPONENT_STATUS_OK
) {
1481 bt_component_filter_borrow_input_port_by_index_const(
1483 if (!trimmer_input
) {
1487 bt_component_filter_borrow_output_port_by_index_const(
1489 if (!trimmer_output
) {
1494 * Replace the current downstream port by the trimmer's
1497 in_downstream_port
= trimmer_input
;
1499 bt_port_input_as_port_const(in_downstream_port
);
1500 downstream_port_name
= bt_port_get_name(
1502 BT_ASSERT(downstream_port_name
);
1505 /* We have a winner! */
1506 connect_ports_status
= bt_graph_connect_ports(ctx
->graph
,
1507 out_upstream_port
, in_downstream_port
, NULL
);
1508 downstream_port
= NULL
;
1509 switch (connect_ports_status
) {
1510 case BT_GRAPH_CONNECT_PORTS_STATUS_OK
:
1513 BT_CLI_LOGE_APPEND_CAUSE(
1514 "Cannot create connection: graph refuses to connect ports: "
1515 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1516 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1517 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1518 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1520 upstream_comp
, bt_component_get_name(upstream_comp
),
1521 upstream_port
, bt_port_get_name(upstream_port
),
1522 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1523 downstream_port
, downstream_port_name
,
1524 cfg_conn
->arg
->str
);
1528 BT_LOGI("Connected component ports: "
1529 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
1530 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1531 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
1532 "downstream-port-addr=%p, downstream-port-name=\"%s\", "
1534 upstream_comp
, bt_component_get_name(upstream_comp
),
1535 upstream_port
, bt_port_get_name(upstream_port
),
1536 downstream_comp
, cfg_conn
->downstream_comp_name
->str
,
1537 downstream_port
, downstream_port_name
,
1538 cfg_conn
->arg
->str
);
1540 if (insert_trimmer
) {
1542 * The first connection, from the source to the trimmer,
1543 * has been done. We now connect the trimmer to the
1544 * original downstream port.
1546 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1548 bt_component_filter_as_component_const(trimmer
),
1549 trimmer_output
, cfg_conn
);
1553 ctx
->connect_ports
= true;
1557 * We found a matching downstream port: the search is
1563 /* No downstream port found */
1564 BT_CLI_LOGE_APPEND_CAUSE(
1565 "Cannot create connection: cannot find a matching downstream port for upstream port: "
1566 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
1567 "downstream-comp-name=\"%s\", conn-arg=\"%s\"",
1568 upstream_port
, bt_port_get_name(upstream_port
),
1569 cfg_conn
->downstream_comp_name
->str
,
1570 cfg_conn
->arg
->str
);
1576 free(intersection_begin
);
1577 free(intersection_end
);
1578 BT_VALUE_PUT_REF_AND_RESET(trimmer_params
);
1579 BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(trimmer_class
);
1580 BT_COMPONENT_FILTER_PUT_REF_AND_RESET(trimmer
);
1585 int cmd_run_ctx_connect_upstream_port(struct cmd_run_ctx
*ctx
,
1586 const bt_port_output
*upstream_port
)
1589 const char *upstream_port_name
;
1590 const char *upstream_comp_name
;
1591 const bt_component
*upstream_comp
= NULL
;
1595 BT_ASSERT(upstream_port
);
1596 upstream_port_name
= bt_port_get_name(
1597 bt_port_output_as_port_const(upstream_port
));
1598 BT_ASSERT(upstream_port_name
);
1599 upstream_comp
= bt_port_borrow_component_const(
1600 bt_port_output_as_port_const(upstream_port
));
1601 BT_ASSERT(upstream_comp
);
1602 upstream_comp_name
= bt_component_get_name(upstream_comp
);
1603 BT_ASSERT(upstream_comp_name
);
1604 BT_LOGI("Connecting upstream port: comp-addr=%p, comp-name=\"%s\", "
1605 "port-addr=%p, port-name=\"%s\"",
1606 upstream_comp
, upstream_comp_name
,
1607 upstream_port
, upstream_port_name
);
1609 for (i
= 0; i
< ctx
->cfg
->cmd_data
.run
.connections
->len
; i
++) {
1610 struct bt_config_connection
*cfg_conn
=
1612 ctx
->cfg
->cmd_data
.run
.connections
, i
);
1614 if (strcmp(cfg_conn
->upstream_comp_name
->str
,
1615 upstream_comp_name
)) {
1619 if (!bt_common_star_glob_match(
1620 cfg_conn
->upstream_port_glob
->str
,
1621 SIZE_MAX
, upstream_port_name
, SIZE_MAX
)) {
1625 ret
= cmd_run_ctx_connect_upstream_port_to_downstream_component(
1626 ctx
, upstream_comp
, upstream_port
, cfg_conn
);
1628 BT_CLI_LOGE_APPEND_CAUSE(
1629 "Cannot connect upstream port: "
1630 "port-addr=%p, port-name=\"%s\"",
1632 upstream_port_name
);
1638 BT_CLI_LOGE_APPEND_CAUSE(
1639 "Cannot connect upstream port: port does not match any connection argument: "
1640 "port-addr=%p, port-name=\"%s\"", upstream_port
,
1641 upstream_port_name
);
1651 bt_graph_listener_func_status
1652 graph_output_port_added_listener(struct cmd_run_ctx
*ctx
,
1653 const bt_port_output
*out_port
)
1655 const bt_component
*comp
;
1656 const bt_port
*port
= bt_port_output_as_port_const(out_port
);
1657 bt_graph_listener_func_status ret
=
1658 BT_GRAPH_LISTENER_FUNC_STATUS_OK
;
1660 comp
= bt_port_borrow_component_const(port
);
1661 BT_LOGI("Port added to a graph's component: comp-addr=%p, "
1662 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1663 comp
, comp
? bt_component_get_name(comp
) : "",
1664 port
, bt_port_get_name(port
));
1666 if (!ctx
->connect_ports
) {
1672 if (bt_port_is_connected(port
)) {
1673 BT_LOGW_STR("Port is already connected.");
1677 if (cmd_run_ctx_connect_upstream_port(ctx
, out_port
)) {
1678 BT_CLI_LOGE_APPEND_CAUSE("Cannot connect upstream port.");
1679 ret
= BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
;
1688 bt_graph_listener_func_status
graph_source_output_port_added_listener(
1689 const bt_component_source
*component
,
1690 const bt_port_output
*port
, void *data
)
1692 return graph_output_port_added_listener(data
, port
);
1696 bt_graph_listener_func_status
graph_filter_output_port_added_listener(
1697 const bt_component_filter
*component
,
1698 const bt_port_output
*port
, void *data
)
1700 return graph_output_port_added_listener(data
, port
);
1704 void cmd_run_ctx_destroy(struct cmd_run_ctx
*ctx
)
1710 if (ctx
->src_components
) {
1711 g_hash_table_destroy(ctx
->src_components
);
1712 ctx
->src_components
= NULL
;
1715 if (ctx
->flt_components
) {
1716 g_hash_table_destroy(ctx
->flt_components
);
1717 ctx
->flt_components
= NULL
;
1720 if (ctx
->sink_components
) {
1721 g_hash_table_destroy(ctx
->sink_components
);
1722 ctx
->sink_components
= NULL
;
1725 if (ctx
->intersections
) {
1726 g_hash_table_destroy(ctx
->intersections
);
1727 ctx
->intersections
= NULL
;
1730 BT_GRAPH_PUT_REF_AND_RESET(ctx
->graph
);
1735 int add_descriptor_to_component_descriptor_set(
1736 bt_component_descriptor_set
*comp_descr_set
,
1737 const char *plugin_name
, const char *comp_cls_name
,
1738 bt_component_class_type comp_cls_type
,
1739 const bt_value
*params
)
1741 const bt_component_class
*comp_cls
;
1744 comp_cls
= find_component_class(plugin_name
, comp_cls_name
,
1747 BT_CLI_LOGE_APPEND_CAUSE(
1748 "Cannot find component class: plugin-name=\"%s\", "
1749 "comp-cls-name=\"%s\", comp-cls-type=%d",
1750 plugin_name
, comp_cls_name
, comp_cls_type
);
1755 status
= bt_component_descriptor_set_add_descriptor(
1756 comp_descr_set
, comp_cls
, params
);
1757 if (status
!= BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK
) {
1758 BT_CLI_LOGE_APPEND_CAUSE(
1759 "Cannot append descriptor to component descriptor set: "
1760 "status=%s", bt_common_func_status_string(status
));
1765 bt_component_class_put_ref(comp_cls
);
1770 int append_descriptors_from_bt_config_component_array(
1771 bt_component_descriptor_set
*comp_descr_set
,
1772 GPtrArray
*component_configs
)
1777 for (i
= 0; i
< component_configs
->len
; i
++) {
1778 struct bt_config_component
*cfg_comp
=
1779 component_configs
->pdata
[i
];
1781 ret
= add_descriptor_to_component_descriptor_set(
1783 cfg_comp
->plugin_name
->str
,
1784 cfg_comp
->comp_cls_name
->str
,
1785 cfg_comp
->type
, cfg_comp
->params
);
1796 bt_get_greatest_operative_mip_version_status
get_greatest_operative_mip_version(
1797 struct bt_config
*cfg
, uint64_t *mip_version
)
1799 bt_get_greatest_operative_mip_version_status status
=
1800 BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
;
1801 bt_component_descriptor_set
*comp_descr_set
= NULL
;
1805 BT_ASSERT(mip_version
);
1806 comp_descr_set
= bt_component_descriptor_set_create();
1807 if (!comp_descr_set
) {
1808 BT_CLI_LOGE_APPEND_CAUSE(
1809 "Failed to create a component descriptor set object.");
1810 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR
;
1814 ret
= append_descriptors_from_bt_config_component_array(
1815 comp_descr_set
, cfg
->cmd_data
.run
.sources
);
1817 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1821 ret
= append_descriptors_from_bt_config_component_array(
1822 comp_descr_set
, cfg
->cmd_data
.run
.filters
);
1824 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1828 ret
= append_descriptors_from_bt_config_component_array(
1829 comp_descr_set
, cfg
->cmd_data
.run
.sinks
);
1831 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1835 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1837 * Stream intersection mode adds `flt.utils.trimmer`
1838 * components; we need to include this type of component
1839 * in the component descriptor set to get the real
1840 * greatest operative MIP version.
1842 ret
= add_descriptor_to_component_descriptor_set(
1843 comp_descr_set
, "utils", "trimmer",
1844 BT_COMPONENT_CLASS_TYPE_FILTER
, NULL
);
1846 status
= BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR
;
1851 status
= bt_get_greatest_operative_mip_version(comp_descr_set
,
1852 bt_cli_log_level
, mip_version
);
1855 bt_component_descriptor_set_put_ref(comp_descr_set
);
1860 int cmd_run_ctx_init(struct cmd_run_ctx
*ctx
, struct bt_config
*cfg
)
1863 bt_graph_add_listener_status add_listener_status
;
1864 bt_get_greatest_operative_mip_version_status mip_version_status
;
1865 uint64_t mip_version
= UINT64_C(-1);
1868 ctx
->connect_ports
= false;
1869 ctx
->src_components
= g_hash_table_new_full(g_direct_hash
,
1870 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1871 if (!ctx
->src_components
) {
1875 ctx
->flt_components
= g_hash_table_new_full(g_direct_hash
,
1876 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1877 if (!ctx
->flt_components
) {
1881 ctx
->sink_components
= g_hash_table_new_full(g_direct_hash
,
1882 g_direct_equal
, NULL
, (GDestroyNotify
) bt_object_put_ref
);
1883 if (!ctx
->sink_components
) {
1887 if (cfg
->cmd_data
.run
.stream_intersection_mode
) {
1888 ctx
->stream_intersection_mode
= true;
1889 ctx
->intersections
= g_hash_table_new_full(port_id_hash
,
1890 port_id_equal
, port_id_destroy
, trace_range_destroy
);
1891 if (!ctx
->intersections
) {
1897 * Get the greatest operative MIP version to use to configure
1898 * the graph to create.
1900 mip_version_status
= get_greatest_operative_mip_version(
1902 if (mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH
) {
1903 BT_CLI_LOGE_APPEND_CAUSE(
1904 "Failed to find an operative message interchange "
1905 "protocol version to use to create the `run` command's "
1906 "graph (components are not interoperable).");
1908 } else if (mip_version_status
< 0) {
1909 BT_CLI_LOGE_APPEND_CAUSE(
1910 "Cannot find an operative message interchange "
1911 "protocol version to use to create the `run` command's "
1913 bt_common_func_status_string(mip_version_status
));
1917 BT_ASSERT(mip_version_status
== BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK
);
1918 BT_LOGI("Found operative message interchange protocol version to "
1919 "configure the `run` command's graph: mip-version=%" PRIu64
,
1921 ctx
->graph
= bt_graph_create(mip_version
);
1926 bt_graph_add_interrupter(ctx
->graph
, the_interrupter
);
1927 add_listener_status
= bt_graph_add_source_component_output_port_added_listener(
1928 ctx
->graph
, graph_source_output_port_added_listener
, NULL
, ctx
,
1930 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1931 BT_CLI_LOGE_APPEND_CAUSE(
1932 "Cannot add \"port added\" listener to graph.");
1936 add_listener_status
= bt_graph_add_filter_component_output_port_added_listener(
1937 ctx
->graph
, graph_filter_output_port_added_listener
, NULL
, ctx
,
1939 if (add_listener_status
!= BT_GRAPH_ADD_LISTENER_STATUS_OK
) {
1940 BT_CLI_LOGE_APPEND_CAUSE(
1941 "Cannot add \"port added\" listener to graph.");
1948 cmd_run_ctx_destroy(ctx
);
1956 * Compute the intersection of all streams in the array `streams`, write it
1961 int compute_stream_intersection(const bt_value
*streams
,
1962 struct trace_range
*range
)
1964 uint64_t i
, stream_count
;
1967 BT_ASSERT(bt_value_get_type(streams
) == BT_VALUE_TYPE_ARRAY
);
1969 stream_count
= bt_value_array_get_length(streams
);
1971 BT_ASSERT(stream_count
> 0);
1973 range
->intersection_range_begin_ns
= 0;
1974 range
->intersection_range_end_ns
= UINT64_MAX
;
1976 for (i
= 0; i
< stream_count
; i
++) {
1977 int64_t begin_ns
, end_ns
;
1978 uint64_t begin_ns_u
, end_ns_u
;
1979 const bt_value
*stream_value
;
1980 const bt_value
*range_ns_value
;
1981 const bt_value
*begin_value
;
1982 const bt_value
*end_value
;
1984 stream_value
= bt_value_array_borrow_element_by_index_const(streams
, i
);
1985 if (bt_value_get_type(stream_value
) != BT_VALUE_TYPE_MAP
) {
1986 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1987 "expected streams array element to be a map, got %s.",
1988 bt_common_value_type_string(bt_value_get_type(stream_value
)));
1992 range_ns_value
= bt_value_map_borrow_entry_value_const(
1993 stream_value
, "range-ns");
1994 if (!range_ns_value
) {
1995 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
1996 "missing expected `range-ns` key in stream map.");
2000 if (bt_value_get_type(range_ns_value
) != BT_VALUE_TYPE_MAP
) {
2001 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2002 "expected `range-ns` entry value of stream map to be a map, got %s.",
2003 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2007 begin_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "begin");
2009 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2010 "missing expected `begin` key in range-ns map.");
2014 if (bt_value_get_type(begin_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2015 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2016 "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
2017 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2021 end_value
= bt_value_map_borrow_entry_value_const(range_ns_value
, "end");
2023 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2024 "missing expected `end` key in range-ns map.");
2028 if (bt_value_get_type(end_value
) != BT_VALUE_TYPE_SIGNED_INTEGER
) {
2029 BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
2030 "expected `end` entry value of range-ns map to be a signed integer, got %s.",
2031 bt_common_value_type_string(bt_value_get_type(range_ns_value
)));
2035 begin_ns
= bt_value_integer_signed_get(begin_value
);
2036 end_ns
= bt_value_integer_signed_get(end_value
);
2038 if (begin_ns
< 0 || end_ns
< 0 || end_ns
< begin_ns
) {
2039 BT_CLI_LOGE_APPEND_CAUSE(
2040 "Invalid stream range values: "
2041 "range-ns:begin=%" PRId64
", "
2042 "range-ns:end=%" PRId64
,
2047 begin_ns_u
= begin_ns
;
2050 range
->intersection_range_begin_ns
=
2051 MAX(range
->intersection_range_begin_ns
, begin_ns_u
);
2052 range
->intersection_range_end_ns
=
2053 MIN(range
->intersection_range_end_ns
, end_ns_u
);
2066 int set_stream_intersections(struct cmd_run_ctx
*ctx
,
2067 struct bt_config_component
*cfg_comp
,
2068 const bt_component_class_source
*src_comp_cls
)
2072 uint64_t trace_count
;
2073 const bt_value
*query_result
= NULL
;
2074 const bt_value
*trace_info
= NULL
;
2075 const bt_value
*stream_infos
= NULL
;
2076 const bt_value
*stream_info
= NULL
;
2077 struct port_id
*port_id
= NULL
;
2078 struct trace_range
*stream_intersection
= NULL
;
2079 const char *fail_reason
= NULL
;
2080 const bt_component_class
*comp_cls
=
2081 bt_component_class_source_as_component_class_const(src_comp_cls
);
2083 ret
= query(ctx
->cfg
, comp_cls
, "babeltrace.trace-infos",
2084 cfg_comp
->params
, &query_result
,
2087 BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
2088 "comp-class-name=\"%s\"", fail_reason
,
2089 bt_component_class_get_name(comp_cls
));
2094 BT_ASSERT(query_result
);
2096 if (!bt_value_is_array(query_result
)) {
2097 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
2098 "component-class-name=%s, actual-type=%s",
2099 bt_component_class_get_name(comp_cls
),
2100 bt_common_value_type_string(bt_value_get_type(query_result
)));
2105 trace_count
= bt_value_array_get_length(query_result
);
2106 if (trace_count
== 0) {
2107 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
2108 "component-class-name=%s", bt_component_class_get_name(comp_cls
));
2113 for (trace_idx
= 0; trace_idx
< trace_count
; trace_idx
++) {
2114 uint64_t stream_idx
;
2115 int64_t stream_count
;
2116 struct trace_range trace_intersection
;
2118 trace_info
= bt_value_array_borrow_element_by_index_const(
2119 query_result
, trace_idx
);
2120 if (!bt_value_is_map(trace_info
)) {
2122 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
2123 "component-class-name=%s, actual-type=%s",
2124 bt_component_class_get_name(comp_cls
),
2125 bt_common_value_type_string(bt_value_get_type(trace_info
)));
2129 stream_infos
= bt_value_map_borrow_entry_value_const(
2130 trace_info
, "stream-infos");
2131 if (!stream_infos
) {
2133 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
2134 "component-class-name=%s",
2135 bt_component_class_get_name(comp_cls
));
2139 if (!bt_value_is_array(stream_infos
)) {
2141 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
2142 "component-class-name=%s, actual-type=%s",
2143 bt_component_class_get_name(comp_cls
),
2144 bt_common_value_type_string(bt_value_get_type(stream_infos
)));
2148 stream_count
= bt_value_array_get_length(stream_infos
);
2149 if (stream_count
== 0) {
2151 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
2152 "component-class-name=%s",
2153 bt_component_class_get_name(comp_cls
));
2157 ret
= compute_stream_intersection(stream_infos
, &trace_intersection
);
2159 BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
2163 for (stream_idx
= 0; stream_idx
< stream_count
; stream_idx
++) {
2164 const bt_value
*port_name
;
2166 port_id
= g_new0(struct port_id
, 1);
2169 BT_CLI_LOGE_APPEND_CAUSE(
2170 "Cannot allocate memory for port_id structure.");
2173 port_id
->instance_name
= strdup(cfg_comp
->instance_name
->str
);
2174 if (!port_id
->instance_name
) {
2176 BT_CLI_LOGE_APPEND_CAUSE(
2177 "Cannot allocate memory for port_id component instance name.");
2181 stream_intersection
= g_new0(struct trace_range
, 1);
2182 if (!stream_intersection
) {
2184 BT_CLI_LOGE_APPEND_CAUSE(
2185 "Cannot allocate memory for trace_range structure.");
2189 *stream_intersection
= trace_intersection
;
2191 stream_info
= bt_value_array_borrow_element_by_index_const(
2192 stream_infos
, stream_idx
);
2193 if (!bt_value_is_map(stream_info
)) {
2195 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2196 "expecting element of stream list to be a map: "
2197 "component-class-name=%s, actual-type=%s",
2198 bt_component_class_get_name(comp_cls
),
2199 bt_common_value_type_string(bt_value_get_type(stream_info
)));
2203 port_name
= bt_value_map_borrow_entry_value_const(stream_info
, "port-name");
2206 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2207 "missing `port-name` key in stream info map: "
2208 "component-class-name=%s",
2209 bt_component_class_get_name(comp_cls
));
2213 if (!bt_value_is_string(port_name
)) {
2215 BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
2216 "expecting `port-name` entry of stream info map to be a string: "
2217 "component-class-name=%s, actual-type=%s",
2218 bt_component_class_get_name(comp_cls
),
2219 bt_common_value_type_string(bt_value_get_type(port_name
)));
2223 port_id
->port_name
= g_strdup(bt_value_string_get(port_name
));
2224 if (!port_id
->port_name
) {
2226 BT_CLI_LOGE_APPEND_CAUSE(
2227 "Cannot allocate memory for port_id port_name.");
2231 BT_LOGD("Inserting stream intersection ");
2233 g_hash_table_insert(ctx
->intersections
, port_id
, stream_intersection
);
2236 stream_intersection
= NULL
;
2243 bt_value_put_ref(query_result
);
2245 g_free(stream_intersection
);
2250 int cmd_run_ctx_create_components_from_config_components(
2251 struct cmd_run_ctx
*ctx
, GPtrArray
*cfg_components
)
2254 const void *comp_cls
= NULL
;
2255 const void *comp
= NULL
;
2258 for (i
= 0; i
< cfg_components
->len
; i
++) {
2259 struct bt_config_component
*cfg_comp
=
2260 g_ptr_array_index(cfg_components
, i
);
2263 switch (cfg_comp
->type
) {
2264 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2265 comp_cls
= find_source_component_class(
2266 cfg_comp
->plugin_name
->str
,
2267 cfg_comp
->comp_cls_name
->str
);
2269 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2270 comp_cls
= find_filter_component_class(
2271 cfg_comp
->plugin_name
->str
,
2272 cfg_comp
->comp_cls_name
->str
);
2274 case BT_COMPONENT_CLASS_TYPE_SINK
:
2275 comp_cls
= find_sink_component_class(
2276 cfg_comp
->plugin_name
->str
,
2277 cfg_comp
->comp_cls_name
->str
);
2284 BT_CLI_LOGE_APPEND_CAUSE(
2285 "Cannot find component class: plugin-name=\"%s\", "
2286 "comp-cls-name=\"%s\", comp-cls-type=%d",
2287 cfg_comp
->plugin_name
->str
,
2288 cfg_comp
->comp_cls_name
->str
,
2293 BT_ASSERT(cfg_comp
->log_level
>= BT_LOG_TRACE
);
2295 switch (cfg_comp
->type
) {
2296 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2297 ret
= bt_graph_add_source_component(ctx
->graph
,
2298 comp_cls
, cfg_comp
->instance_name
->str
,
2299 cfg_comp
->params
, cfg_comp
->log_level
,
2302 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2303 ret
= bt_graph_add_filter_component(ctx
->graph
,
2304 comp_cls
, cfg_comp
->instance_name
->str
,
2305 cfg_comp
->params
, cfg_comp
->log_level
,
2308 case BT_COMPONENT_CLASS_TYPE_SINK
:
2309 ret
= bt_graph_add_sink_component(ctx
->graph
,
2310 comp_cls
, cfg_comp
->instance_name
->str
,
2311 cfg_comp
->params
, cfg_comp
->log_level
,
2319 BT_CLI_LOGE_APPEND_CAUSE(
2320 "Cannot create component: plugin-name=\"%s\", "
2321 "comp-cls-name=\"%s\", comp-cls-type=%d, "
2323 cfg_comp
->plugin_name
->str
,
2324 cfg_comp
->comp_cls_name
->str
,
2325 cfg_comp
->type
, cfg_comp
->instance_name
->str
);
2329 if (ctx
->stream_intersection_mode
&&
2330 cfg_comp
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
2331 ret
= set_stream_intersections(ctx
, cfg_comp
, comp_cls
);
2333 BT_CLI_LOGE_APPEND_CAUSE(
2334 "Cannot determine stream intersection of trace.");
2339 BT_LOGI("Created and inserted component: comp-addr=%p, comp-name=\"%s\"",
2340 comp
, cfg_comp
->instance_name
->str
);
2341 quark
= g_quark_from_string(cfg_comp
->instance_name
->str
);
2342 BT_ASSERT(quark
> 0);
2344 switch (cfg_comp
->type
) {
2345 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
2346 g_hash_table_insert(ctx
->src_components
,
2347 GUINT_TO_POINTER(quark
), (void *) comp
);
2349 case BT_COMPONENT_CLASS_TYPE_FILTER
:
2350 g_hash_table_insert(ctx
->flt_components
,
2351 GUINT_TO_POINTER(quark
), (void *) comp
);
2353 case BT_COMPONENT_CLASS_TYPE_SINK
:
2354 g_hash_table_insert(ctx
->sink_components
,
2355 GUINT_TO_POINTER(quark
), (void *) comp
);
2362 BT_OBJECT_PUT_REF_AND_RESET(comp_cls
);
2371 bt_object_put_ref(comp
);
2372 bt_object_put_ref(comp_cls
);
2377 int cmd_run_ctx_create_components(struct cmd_run_ctx
*ctx
)
2382 * Make sure that, during this phase, our graph's "port added"
2383 * listener does not connect ports while we are creating the
2384 * components because we have a special, initial phase for
2387 ctx
->connect_ports
= false;
2389 ret
= cmd_run_ctx_create_components_from_config_components(
2390 ctx
, ctx
->cfg
->cmd_data
.run
.sources
);
2396 ret
= cmd_run_ctx_create_components_from_config_components(
2397 ctx
, ctx
->cfg
->cmd_data
.run
.filters
);
2403 ret
= cmd_run_ctx_create_components_from_config_components(
2404 ctx
, ctx
->cfg
->cmd_data
.run
.sinks
);
2414 typedef uint64_t (*output_port_count_func_t
)(const void *);
2415 typedef const bt_port_output
*(*borrow_output_port_by_index_func_t
)(
2416 const void *, uint64_t);
2419 int cmd_run_ctx_connect_comp_ports(struct cmd_run_ctx
*ctx
,
2420 void *comp
, output_port_count_func_t port_count_fn
,
2421 borrow_output_port_by_index_func_t port_by_index_fn
)
2427 count
= port_count_fn(comp
);
2429 for (i
= 0; i
< count
; i
++) {
2430 const bt_port_output
*upstream_port
= port_by_index_fn(comp
, i
);
2432 BT_ASSERT(upstream_port
);
2433 ret
= cmd_run_ctx_connect_upstream_port(ctx
, upstream_port
);
2444 int cmd_run_ctx_connect_ports(struct cmd_run_ctx
*ctx
)
2447 GHashTableIter iter
;
2448 gpointer g_name_quark
, g_comp
;
2450 ctx
->connect_ports
= true;
2451 g_hash_table_iter_init(&iter
, ctx
->src_components
);
2453 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2454 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2455 (output_port_count_func_t
)
2456 bt_component_source_get_output_port_count
,
2457 (borrow_output_port_by_index_func_t
)
2458 bt_component_source_borrow_output_port_by_index_const
);
2464 g_hash_table_iter_init(&iter
, ctx
->flt_components
);
2466 while (g_hash_table_iter_next(&iter
, &g_name_quark
, &g_comp
)) {
2467 ret
= cmd_run_ctx_connect_comp_ports(ctx
, g_comp
,
2468 (output_port_count_func_t
)
2469 bt_component_filter_get_output_port_count
,
2470 (borrow_output_port_by_index_func_t
)
2471 bt_component_filter_borrow_output_port_by_index_const
);
2482 int cmd_run(struct bt_config
*cfg
)
2485 struct cmd_run_ctx ctx
= { 0 };
2487 /* Initialize the command's context and the graph object */
2488 if (cmd_run_ctx_init(&ctx
, cfg
)) {
2489 BT_CLI_LOGE_APPEND_CAUSE(
2490 "Cannot initialize the command's context.");
2494 if (bt_interrupter_is_set(the_interrupter
)) {
2495 BT_CLI_LOGW_APPEND_CAUSE(
2496 "Interrupted by user before creating components.");
2500 BT_LOGI_STR("Creating components.");
2502 /* Create the requested component instances */
2503 if (cmd_run_ctx_create_components(&ctx
)) {
2504 BT_CLI_LOGE_APPEND_CAUSE("Cannot create components.");
2508 if (bt_interrupter_is_set(the_interrupter
)) {
2509 BT_CLI_LOGW_APPEND_CAUSE(
2510 "Interrupted by user before connecting components.");
2514 BT_LOGI_STR("Connecting components.");
2516 /* Connect the initially visible component ports */
2517 if (cmd_run_ctx_connect_ports(&ctx
)) {
2518 BT_CLI_LOGE_APPEND_CAUSE(
2519 "Cannot connect initial component ports.");
2523 BT_LOGI_STR("Running the graph.");
2527 bt_graph_run_status run_status
= bt_graph_run(ctx
.graph
);
2530 * Reset console in case something messed with console
2531 * codes during the graph's execution.
2533 printf("%s", bt_common_color_reset());
2535 fprintf(stderr
, "%s", bt_common_color_reset());
2536 BT_LOGT("bt_graph_run() returned: status=%s",
2537 bt_common_func_status_string(run_status
));
2539 switch (run_status
) {
2540 case BT_GRAPH_RUN_STATUS_OK
:
2542 case BT_GRAPH_RUN_STATUS_AGAIN
:
2543 if (bt_interrupter_is_set(the_interrupter
)) {
2544 BT_CLI_LOGW_APPEND_CAUSE(
2545 "Graph was interrupted by user.");
2549 if (cfg
->cmd_data
.run
.retry_duration_us
> 0) {
2550 BT_LOGT("Got BT_GRAPH_RUN_STATUS_AGAIN: sleeping: "
2552 cfg
->cmd_data
.run
.retry_duration_us
);
2554 if (usleep(cfg
->cmd_data
.run
.retry_duration_us
)) {
2555 if (bt_interrupter_is_set(the_interrupter
)) {
2556 BT_CLI_LOGW_APPEND_CAUSE(
2557 "Graph was interrupted by user.");
2563 case BT_GRAPH_RUN_STATUS_END
:
2566 if (bt_interrupter_is_set(the_interrupter
)) {
2567 BT_CLI_LOGW_APPEND_CAUSE(
2568 "Graph was interrupted by user and failed: "
2570 bt_common_func_status_string(run_status
));
2574 BT_CLI_LOGE_APPEND_CAUSE(
2575 "Graph failed to complete successfully");
2588 cmd_run_ctx_destroy(&ctx
);
2593 void warn_command_name_and_directory_clash(struct bt_config
*cfg
)
2595 const char *env_clash
;
2597 if (!cfg
->command_name
) {
2601 env_clash
= getenv(ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH
);
2602 if (env_clash
&& strcmp(env_clash
, "0") == 0) {
2606 if (g_file_test(cfg
->command_name
,
2607 G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) {
2608 _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION
, __FILE__
, __LINE__
,
2609 BT_LOG_WARNING
, BT_LOG_TAG
,
2610 "The `%s` command was executed. "
2611 "If you meant to convert a trace located in "
2612 "the local `%s` directory, please use:\n\n"
2613 " babeltrace2 convert %s [OPTIONS]",
2614 cfg
->command_name
, cfg
->command_name
,
2620 void init_log_level(void)
2622 bt_cli_log_level
= bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL
);
2626 void print_error_causes(void)
2628 const bt_error
*error
= bt_current_thread_take_error();
2630 GString
*folded
= NULL
;
2631 unsigned int columns
;
2633 if (!error
|| bt_error_get_cause_count(error
) == 0) {
2634 fprintf(stderr
, "%s%sUnknown command-line error.%s\n",
2635 bt_common_color_bold(), bt_common_color_fg_red(),
2636 bt_common_color_reset());
2640 /* Try to get terminal width to fold the error cause messages */
2641 if (bt_common_get_term_size(&columns
, NULL
) < 0) {
2642 /* Width not found: default to 80 */
2647 * This helps visually separate the error causes from the last
2648 * logging statement.
2650 fprintf(stderr
, "\n");
2652 /* Reverse order: deepest (root) cause printed at the end */
2653 for (i
= bt_error_get_cause_count(error
) - 1; i
>= 0; i
--) {
2654 const bt_error_cause
*cause
=
2655 bt_error_borrow_cause_by_index(error
, (uint64_t) i
);
2656 const char *prefix_fmt
=
2657 i
== bt_error_get_cause_count(error
) - 1 ?
2658 "%s%sERROR%s: " : "%s%sCAUSED BY%s ";
2661 fprintf(stderr
, prefix_fmt
,
2662 bt_common_color_bold(), bt_common_color_fg_red(),
2663 bt_common_color_reset());
2665 /* Print actor name */
2666 fprintf(stderr
, "[");
2667 switch (bt_error_cause_get_actor_type(cause
)) {
2668 case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN
:
2669 fprintf(stderr
, "%s%s%s",
2670 bt_common_color_bold(),
2671 bt_error_cause_get_module_name(cause
),
2672 bt_common_color_reset());
2674 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT
:
2675 fprintf(stderr
, "%s%s%s: ",
2676 bt_common_color_bold(),
2677 bt_error_cause_component_actor_get_component_name(cause
),
2678 bt_common_color_reset());
2679 print_plugin_comp_cls_opt(stderr
,
2680 bt_error_cause_component_actor_get_plugin_name(cause
),
2681 bt_error_cause_component_actor_get_component_class_name(cause
),
2682 bt_error_cause_component_actor_get_component_class_type(cause
));
2684 case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS
:
2685 print_plugin_comp_cls_opt(stderr
,
2686 bt_error_cause_component_class_actor_get_plugin_name(cause
),
2687 bt_error_cause_component_class_actor_get_component_class_name(cause
),
2688 bt_error_cause_component_class_actor_get_component_class_type(cause
));
2690 case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR
:
2691 fprintf(stderr
, "%s%s%s (%s%s%s): ",
2692 bt_common_color_bold(),
2693 bt_error_cause_message_iterator_actor_get_component_name(cause
),
2694 bt_common_color_reset(),
2695 bt_common_color_bold(),
2696 bt_error_cause_message_iterator_actor_get_component_output_port_name(cause
),
2697 bt_common_color_reset());
2698 print_plugin_comp_cls_opt(stderr
,
2699 bt_error_cause_message_iterator_actor_get_plugin_name(cause
),
2700 bt_error_cause_message_iterator_actor_get_component_class_name(cause
),
2701 bt_error_cause_message_iterator_actor_get_component_class_type(cause
));
2707 /* Print file name and line number */
2708 fprintf(stderr
, "] (%s%s%s%s:%s%" PRIu64
"%s)\n",
2709 bt_common_color_bold(),
2710 bt_common_color_fg_magenta(),
2711 bt_error_cause_get_file_name(cause
),
2712 bt_common_color_reset(),
2713 bt_common_color_fg_green(),
2714 bt_error_cause_get_line_number(cause
),
2715 bt_common_color_reset());
2718 folded
= bt_common_fold(bt_error_cause_get_message(cause
),
2721 BT_LOGE_STR("Could not fold string.");
2722 fprintf(stderr
, "%s\n",
2723 bt_error_cause_get_message(cause
));
2727 fprintf(stderr
, "%s\n", folded
->str
);
2728 g_string_free(folded
, TRUE
);
2736 bt_error_release(error
);
2740 int main(int argc
, const char **argv
)
2744 struct bt_config
*cfg
= NULL
;
2747 set_signal_handler();
2748 init_loaded_plugins();
2750 BT_ASSERT(!the_interrupter
);
2751 the_interrupter
= bt_interrupter_create();
2752 if (!the_interrupter
) {
2753 BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
2758 cfg
= bt_config_cli_args_create_with_default(argc
, argv
, &retcode
,
2762 /* Quit without errors; typically usage/version */
2764 BT_LOGI_STR("Quitting without errors.");
2769 BT_CLI_LOGE_APPEND_CAUSE(
2770 "Command-line error: retcode=%d", retcode
);
2775 BT_CLI_LOGE_APPEND_CAUSE(
2776 "Failed to create a valid Babeltrace CLI configuration.");
2783 if (cfg
->command_needs_plugins
) {
2784 ret
= require_loaded_plugins(cfg
->plugin_paths
);
2786 BT_CLI_LOGE_APPEND_CAUSE(
2787 "Failed to load plugins: ret=%d", ret
);
2793 BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
2794 cfg
->command
, cfg
->command_name
);
2796 switch (cfg
->command
) {
2797 case BT_CONFIG_COMMAND_RUN
:
2800 case BT_CONFIG_COMMAND_LIST_PLUGINS
:
2801 ret
= cmd_list_plugins(cfg
);
2803 case BT_CONFIG_COMMAND_HELP
:
2804 ret
= cmd_help(cfg
);
2806 case BT_CONFIG_COMMAND_QUERY
:
2807 ret
= cmd_query(cfg
);
2809 case BT_CONFIG_COMMAND_PRINT_CTF_METADATA
:
2810 ret
= cmd_print_ctf_metadata(cfg
);
2812 case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS
:
2813 ret
= cmd_print_lttng_live_sessions(cfg
);
2816 BT_LOGF("Invalid/unknown command: cmd=%d", cfg
->command
);
2820 BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
2821 cfg
->command
, cfg
->command_name
, ret
);
2822 warn_command_name_and_directory_clash(cfg
);
2823 retcode
= ret
? 1 : 0;
2826 BT_OBJECT_PUT_REF_AND_RESET(cfg
);
2827 fini_loaded_plugins();
2828 bt_interrupter_put_ref(the_interrupter
);
2831 print_error_causes();
2835 * Clear current thread's error in case there is one to avoid a
2838 bt_current_thread_clear_error();