4 * Babeltrace Trace Converter
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/babeltrace.h>
30 #include <babeltrace/plugin/plugin.h>
31 #include <babeltrace/component/component.h>
32 #include <babeltrace/component/component-source.h>
33 #include <babeltrace/component/component-sink.h>
34 #include <babeltrace/component/component-filter.h>
35 #include <babeltrace/component/component-class.h>
36 #include <babeltrace/component/notification/iterator.h>
37 #include <babeltrace/ref.h>
38 #include <babeltrace/values.h>
40 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
45 #include "babeltrace-cfg.h"
46 #include "default-cfg.h"
48 GPtrArray
*loaded_plugins
;
51 void init_loaded_plugins_array(void)
53 loaded_plugins
= g_ptr_array_new_full(8, bt_put
);
57 void fini_loaded_plugins_array(void)
59 g_ptr_array_free(loaded_plugins
, TRUE
);
63 struct bt_plugin
*find_plugin(const char *name
)
66 struct bt_plugin
*plugin
= NULL
;
68 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
69 plugin
= g_ptr_array_index(loaded_plugins
, i
);
71 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
78 return bt_get(plugin
);
82 struct bt_component_class
*find_component_class(const char *plugin_name
,
83 const char *comp_class_name
,
84 enum bt_component_class_type comp_class_type
)
86 struct bt_component_class
*comp_class
= NULL
;
87 struct bt_plugin
*plugin
= find_plugin(plugin_name
);
93 comp_class
= bt_plugin_get_component_class_by_name_and_type(plugin
,
94 comp_class_name
, comp_class_type
);
101 const char *component_type_str(enum bt_component_class_type type
)
104 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
106 case BT_COMPONENT_CLASS_TYPE_SINK
:
108 case BT_COMPONENT_CLASS_TYPE_FILTER
:
110 case BT_COMPONENT_CLASS_TYPE_UNKNOWN
:
117 void print_component_classes_found(void)
119 int plugins_count
, component_classes_count
= 0, i
;
121 if (!babeltrace_verbose
) {
125 plugins_count
= loaded_plugins
->len
;
126 if (plugins_count
== 0) {
127 fprintf(stderr
, "No plugins found. Please make sure your plug-in search path is set correctly.\n");
131 for (i
= 0; i
< plugins_count
; i
++) {
132 struct bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
134 component_classes_count
+= bt_plugin_get_component_class_count(plugin
);
137 printf_verbose("Found %d component classes in %d plugins.\n",
138 component_classes_count
, plugins_count
);
140 for (i
= 0; i
< plugins_count
; i
++) {
142 struct bt_plugin
*plugin
= g_ptr_array_index(loaded_plugins
, i
);
143 unsigned int major
, minor
, patch
;
145 enum bt_plugin_status version_status
;
147 component_classes_count
=
148 bt_plugin_get_component_class_count(plugin
);
149 version_status
= bt_plugin_get_version(plugin
, &major
, &minor
,
152 for (j
= 0; j
< component_classes_count
; j
++) {
153 struct bt_component_class
*comp_class
=
154 bt_plugin_get_component_class(plugin
, j
);
155 const char *plugin_name
= bt_plugin_get_name(plugin
);
156 const char *comp_class_name
=
157 bt_component_class_get_name(comp_class
);
158 const char *path
= bt_plugin_get_path(plugin
);
159 const char *author
= bt_plugin_get_author(plugin
);
160 const char *license
= bt_plugin_get_license(plugin
);
161 const char *plugin_description
=
162 bt_plugin_get_description(plugin
);
163 const char *comp_class_description
=
164 bt_component_class_get_description(comp_class
);
165 enum bt_component_class_type type
=
166 bt_component_class_get_type(comp_class
);
168 printf_verbose("[%s - %s (%s)]\n", plugin_name
,
169 comp_class_name
, component_type_str(type
));
170 printf_verbose("\tpath: %s\n", path
? path
: "None");
171 printf_verbose("\tauthor: %s\n",
172 author
? author
: "Unknown");
173 printf_verbose("\tlicense: %s\n",
174 license
? license
: "Unknown");
175 printf_verbose("\tplugin description: %s\n",
176 plugin_description
? plugin_description
: "None");
178 if (version_status
== BT_PLUGIN_STATUS_OK
) {
179 printf_verbose("\tplugin version: %u.%u.%u",
180 major
, minor
, patch
);
189 printf_verbose("\tcomponent description: %s\n",
190 comp_class_description
? comp_class_description
: "None");
197 void print_indent(size_t indent
)
201 for (i
= 0; i
< indent
; i
++) {
207 void print_value(struct bt_value
*, size_t, bool);
210 bool print_map_value(const char *key
, struct bt_value
*object
, void *data
)
212 size_t indent
= (size_t) data
;
214 print_indent(indent
);
215 printf_verbose("\"%s\": ", key
);
216 print_value(object
, indent
, false);
222 void print_value(struct bt_value
*value
, size_t indent
, bool do_indent
)
236 print_indent(indent
);
239 switch (bt_value_get_type(value
)) {
240 case BT_VALUE_TYPE_NULL
:
241 printf_verbose("null\n");
243 case BT_VALUE_TYPE_BOOL
:
244 bt_value_bool_get(value
, &bool_val
);
245 printf_verbose("%s\n", bool_val
? "true" : "false");
247 case BT_VALUE_TYPE_INTEGER
:
248 bt_value_integer_get(value
, &int_val
);
249 printf_verbose("%" PRId64
"\n", int_val
);
251 case BT_VALUE_TYPE_FLOAT
:
252 bt_value_float_get(value
, &dbl_val
);
253 printf_verbose("%lf\n", dbl_val
);
255 case BT_VALUE_TYPE_STRING
:
256 bt_value_string_get(value
, &str_val
);
257 printf_verbose("\"%s\"\n", str_val
);
259 case BT_VALUE_TYPE_ARRAY
:
260 size
= bt_value_array_size(value
);
261 printf_verbose("[\n");
263 for (i
= 0; i
< size
; i
++) {
264 struct bt_value
*element
=
265 bt_value_array_get(value
, i
);
267 print_value(element
, indent
+ 2, true);
271 print_indent(indent
);
272 printf_verbose("]\n");
274 case BT_VALUE_TYPE_MAP
:
275 if (bt_value_map_is_empty(value
)) {
276 printf_verbose("{}\n");
280 printf_verbose("{\n");
281 bt_value_map_foreach(value
, print_map_value
,
282 (void *) (indent
+ 2));
283 print_indent(indent
);
284 printf_verbose("}\n");
292 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
294 printf_verbose(" %s.%s\n", bt_config_component
->plugin_name
->str
,
295 bt_config_component
->component_name
->str
);
296 printf_verbose(" params:\n");
297 print_value(bt_config_component
->params
, 6, true);
301 void print_bt_config_components(GPtrArray
*array
)
305 for (i
= 0; i
< array
->len
; i
++) {
306 struct bt_config_component
*cfg_component
=
307 bt_config_get_component(array
, i
);
308 print_bt_config_component(cfg_component
);
309 BT_PUT(cfg_component
);
314 void print_cfg(struct bt_config
*cfg
)
316 printf_verbose("debug: %d\n", cfg
->debug
);
317 printf_verbose("verbose: %d\n", cfg
->verbose
);
318 printf_verbose("do list: %d\n", cfg
->do_list
);
319 printf_verbose("force correlate: %d\n", cfg
->force_correlate
);
320 printf_verbose("plugin paths:\n");
321 print_value(cfg
->plugin_paths
, 2, true);
322 printf_verbose("sources:\n");
323 print_bt_config_components(cfg
->sources
);
324 printf_verbose("sinks:\n");
325 print_bt_config_components(cfg
->sinks
);
329 struct bt_component
*create_trimmer(struct bt_config_component
*source_cfg
)
331 struct bt_component
*trimmer
= NULL
;
332 struct bt_component_class
*trimmer_class
= NULL
;
333 struct bt_value
*trimmer_params
= NULL
;
334 struct bt_value
*value
;
336 trimmer_params
= bt_value_map_create();
337 if (!trimmer_params
) {
341 value
= bt_value_map_get(source_cfg
->params
, "begin");
343 enum bt_value_status ret
;
345 ret
= bt_value_map_insert(trimmer_params
, "begin",
352 value
= bt_value_map_get(source_cfg
->params
, "end");
354 enum bt_value_status ret
;
356 ret
= bt_value_map_insert(trimmer_params
, "end",
363 value
= bt_value_map_get(source_cfg
->params
, "clock-gmt");
365 enum bt_value_status ret
;
367 ret
= bt_value_map_insert(trimmer_params
, "clock-gmt",
375 trimmer_class
= find_component_class("utils", "trimmer",
376 BT_COMPONENT_CLASS_TYPE_FILTER
);
377 if (!trimmer_class
) {
378 fprintf(stderr
, "Could not find trimmer component class. Aborting...\n");
381 trimmer
= bt_component_create(trimmer_class
, "source_trimmer",
387 bt_put(trimmer_params
);
388 bt_put(trimmer_class
);
393 int connect_source_sink(struct bt_component
*source
,
394 struct bt_config_component
*source_cfg
,
395 struct bt_component
*sink
)
398 enum bt_component_status sink_status
;
399 struct bt_component
*trimmer
= NULL
;
400 struct bt_notification_iterator
*source_it
= NULL
;
401 struct bt_notification_iterator
*to_sink_it
= NULL
;
403 source_it
= bt_component_source_create_iterator(source
);
405 fprintf(stderr
, "Failed to instantiate source iterator. Aborting...\n");
410 if (bt_value_map_has_key(source_cfg
->params
, "begin")
411 || bt_value_map_has_key(source_cfg
->params
, "end")) {
412 /* A trimmer must be inserted in the graph. */
413 enum bt_component_status trimmer_status
;
415 trimmer
= create_trimmer(source_cfg
);
417 fprintf(stderr
, "Failed to create trimmer component. Aborting...\n");
422 trimmer_status
= bt_component_filter_add_iterator(trimmer
,
425 if (trimmer_status
!= BT_COMPONENT_STATUS_OK
) {
426 fprintf(stderr
, "Failed to connect source to trimmer. Aborting...\n");
431 to_sink_it
= bt_component_filter_create_iterator(trimmer
);
433 fprintf(stderr
, "Failed to instantiate trimmer iterator. Aborting...\n");
438 BT_MOVE(to_sink_it
, source_it
);
441 sink_status
= bt_component_sink_add_iterator(sink
, to_sink_it
);
442 if (sink_status
!= BT_COMPONENT_STATUS_OK
) {
443 fprintf(stderr
, "Failed to connect to sink component. Aborting...\n");
455 void add_to_loaded_plugins(struct bt_plugin
**plugins
)
458 struct bt_plugin
*plugin
= *plugins
;
459 /* Check if it's already loaded (from another path). */
460 struct bt_plugin
*loaded_plugin
=
461 find_plugin(bt_plugin_get_name(plugin
));
464 printf_verbose("Not loading plugin `%s`: already loaded from `%s`\n",
465 bt_plugin_get_path(plugin
),
466 bt_plugin_get_path(loaded_plugin
));
467 BT_PUT(loaded_plugin
);
470 /* Transfer ownership to global array. */
471 g_ptr_array_add(loaded_plugins
, plugin
);
478 int load_dynamic_plugins(struct bt_config
*cfg
)
480 int nr_paths
, i
, ret
= 0;
482 nr_paths
= bt_value_array_size(cfg
->plugin_paths
);
488 for (i
= 0; i
< nr_paths
; i
++) {
489 struct bt_value
*plugin_path_value
= NULL
;
490 const char *plugin_path
;
491 struct bt_plugin
**plugins
;
493 plugin_path_value
= bt_value_array_get(cfg
->plugin_paths
, i
);
494 if (bt_value_string_get(plugin_path_value
,
496 BT_PUT(plugin_path_value
);
500 plugins
= bt_plugin_create_all_from_dir(plugin_path
, true);
502 printf_debug("Unable to dynamically load plugins from path %s.\n",
504 BT_PUT(plugin_path_value
);
508 add_to_loaded_plugins(plugins
);
511 BT_PUT(plugin_path_value
);
518 int load_static_plugins(void)
521 struct bt_plugin
**plugins
;
523 plugins
= bt_plugin_create_all_from_static();
525 printf_debug("Unable to load static plugins.\n");
530 add_to_loaded_plugins(plugins
);
536 int main(int argc
, const char **argv
)
539 struct bt_component_class
*source_class
= NULL
;
540 struct bt_component_class
*sink_class
= NULL
;
541 struct bt_component
*source
= NULL
, *sink
= NULL
;
542 struct bt_value
*source_params
= NULL
, *sink_params
= NULL
;
543 struct bt_config
*cfg
;
544 enum bt_component_status sink_status
;
545 struct bt_config_component
*source_cfg
= NULL
, *sink_cfg
= NULL
;
547 init_loaded_plugins_array();
549 cfg
= bt_config_create();
551 fprintf(stderr
, "Failed to create Babeltrace configuration\n");
556 ret
= set_default_config(cfg
);
561 ret
= bt_config_init_from_args(cfg
, argc
, argv
);
563 babeltrace_verbose
= cfg
->verbose
;
564 babeltrace_debug
= cfg
->debug
;
570 /* TODO handle more than 1 source and 1 sink. */
571 if (cfg
->sources
->len
!= 1 || cfg
->sinks
->len
!= 1) {
576 printf_verbose("Verbose mode active.\n");
577 printf_debug("Debug mode active.\n");
579 if (load_dynamic_plugins(cfg
)) {
580 fprintf(stderr
, "Failed to load dynamic plugins.\n");
585 if (load_static_plugins()) {
586 fprintf(stderr
, "Failed to load static plugins.\n");
590 print_component_classes_found();
591 source_cfg
= bt_config_get_component(cfg
->sources
, 0);
592 source_params
= bt_get(source_cfg
->params
);
593 source_class
= find_component_class(source_cfg
->plugin_name
->str
,
594 source_cfg
->component_name
->str
,
595 BT_COMPONENT_CLASS_TYPE_SOURCE
);
597 fprintf(stderr
, "Could not find %s.%s source component class. Aborting...\n",
598 source_cfg
->plugin_name
->str
,
599 source_cfg
->component_name
->str
);
604 sink_cfg
= bt_config_get_component(cfg
->sinks
, 0);
605 sink_params
= bt_get(sink_cfg
->params
);
606 sink_class
= find_component_class(sink_cfg
->plugin_name
->str
,
607 sink_cfg
->component_name
->str
,
608 BT_COMPONENT_CLASS_TYPE_SINK
);
610 fprintf(stderr
, "Could not find %s.%s output component class. Aborting...\n",
611 sink_cfg
->plugin_name
->str
,
612 sink_cfg
->component_name
->str
);
617 source
= bt_component_create(source_class
, "source", source_params
);
619 fprintf(stderr
, "Failed to instantiate selected source component. Aborting...\n");
624 sink
= bt_component_create(sink_class
, "sink", sink_params
);
626 fprintf(stderr
, "Failed to instantiate selected output component. Aborting...\n");
631 ret
= connect_source_sink(source
, source_cfg
, sink
);
637 sink_status
= bt_component_sink_consume(sink
);
638 switch (sink_status
) {
639 case BT_COMPONENT_STATUS_AGAIN
:
640 /* Wait for an arbitraty 500 ms. */
643 case BT_COMPONENT_STATUS_OK
:
645 case BT_COMPONENT_STATUS_END
:
648 fprintf(stderr
, "Sink component returned an error, aborting...\n");
655 BT_PUT(source_class
);
658 BT_PUT(source_params
);
663 fini_loaded_plugins_array();