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/component-factory.h>
31 #include <babeltrace/plugin/plugin.h>
32 #include <babeltrace/plugin/component-class.h>
33 #include <babeltrace/plugin/notification/iterator.h>
34 #include <babeltrace/ref.h>
35 #include <babeltrace/values.h>
37 #include <babeltrace/ctf-ir/metadata.h> /* for clocks */
41 #include "babeltrace-cfg.h"
43 static struct bt_component_factory
*component_factory
;
46 const char *component_type_str(enum bt_component_type type
)
49 case BT_COMPONENT_TYPE_SOURCE
:
51 case BT_COMPONENT_TYPE_SINK
:
53 case BT_COMPONENT_TYPE_FILTER
:
55 case BT_COMPONENT_TYPE_UNKNOWN
:
62 void print_component_classes_found(struct bt_component_factory
*factory
)
66 if (!babeltrace_verbose
) {
70 count
= bt_component_factory_get_component_class_count(factory
);
72 fprintf(stderr
, "No component classes found. Please make sure your plug-in search path is set correctly.\n");
76 printf_verbose("Found %d component classes.\n", count
);
77 for (i
= 0; i
< count
; i
++) {
78 struct bt_component_class
*component_class
=
79 bt_component_factory_get_component_class_index(
81 struct bt_plugin
*plugin
= bt_component_class_get_plugin(
83 const char *plugin_name
= bt_plugin_get_name(plugin
);
84 const char *component_name
= bt_component_class_get_name(
86 const char *path
= bt_plugin_get_path(plugin
);
87 const char *author
= bt_plugin_get_author(plugin
);
88 const char *license
= bt_plugin_get_license(plugin
);
89 const char *plugin_description
= bt_plugin_get_description(
91 const char *component_description
=
92 bt_component_class_get_description(
94 enum bt_component_type type
= bt_component_class_get_type(
97 printf_verbose("[%s - %s (%s)]\n", plugin_name
, component_name
,
98 component_type_str(type
));
99 printf_verbose("\tpath: %s\n", path
? path
: "None");
100 printf_verbose("\tauthor: %s\n", author
? author
: "Unknown");
101 printf_verbose("\tlicense: %s\n", license
? license
: "Unknown");
102 printf_verbose("\tplugin description: %s\n",
103 plugin_description
? plugin_description
: "None");
104 printf_verbose("\tcomponent description: %s\n",
105 component_description
? component_description
: "None");
108 bt_put(component_class
);
113 void print_indent(size_t indent
)
117 for (i
= 0; i
< indent
; i
++) {
123 void print_value(struct bt_value
*, size_t, bool);
126 bool print_map_value(const char *key
, struct bt_value
*object
, void *data
)
128 size_t indent
= (size_t) data
;
130 print_indent(indent
);
131 printf("\"%s\": ", key
);
132 print_value(object
, indent
, false);
138 void print_value(struct bt_value
*value
, size_t indent
, bool do_indent
)
152 print_indent(indent
);
155 switch (bt_value_get_type(value
)) {
156 case BT_VALUE_TYPE_NULL
:
159 case BT_VALUE_TYPE_BOOL
:
160 bt_value_bool_get(value
, &bool_val
);
161 printf("%s\n", bool_val
? "true" : "false");
163 case BT_VALUE_TYPE_INTEGER
:
164 bt_value_integer_get(value
, &int_val
);
165 printf("%" PRId64
"\n", int_val
);
167 case BT_VALUE_TYPE_FLOAT
:
168 bt_value_float_get(value
, &dbl_val
);
169 printf("%lf\n", dbl_val
);
171 case BT_VALUE_TYPE_STRING
:
172 bt_value_string_get(value
, &str_val
);
173 printf("\"%s\"\n", str_val
);
175 case BT_VALUE_TYPE_ARRAY
:
176 size
= bt_value_array_size(value
);
179 for (i
= 0; i
< size
; i
++) {
180 struct bt_value
*element
=
181 bt_value_array_get(value
, i
);
183 print_value(element
, indent
+ 2, true);
187 print_indent(indent
);
190 case BT_VALUE_TYPE_MAP
:
191 if (bt_value_map_is_empty(value
)) {
197 bt_value_map_foreach(value
, print_map_value
,
198 (void *) (indent
+ 2));
199 print_indent(indent
);
208 void print_bt_config_component(struct bt_config_component
*bt_config_component
)
210 printf(" %s.%s\n", bt_config_component
->plugin_name
->str
,
211 bt_config_component
->component_name
->str
);
212 printf(" begin timestamp: ");
214 if (!bt_config_component
->begin
.set
) {
217 printf("%" PRIu64
" ns\n", bt_config_component
->begin
.value_ns
);
220 printf(" end timestamp: ");
222 if (!bt_config_component
->end
.set
) {
225 printf("%" PRIu64
" ns\n", bt_config_component
->end
.value_ns
);
228 printf(" params:\n");
229 print_value(bt_config_component
->params
, 6, true);
233 void print_bt_config_components(GPtrArray
*array
)
237 for (i
= 0; i
< array
->len
; i
++) {
238 struct bt_config_component
*cfg_component
=
239 bt_config_get_component(array
, i
);
240 print_bt_config_component(cfg_component
);
241 BT_PUT(cfg_component
);
246 void print_cfg(struct bt_config
*cfg
)
248 printf("debug: %d\n", cfg
->debug
);
249 printf("verbose: %d\n", cfg
->verbose
);
250 printf("do list: %d\n", cfg
->do_list
);
251 printf("force correlate: %d\n", cfg
->force_correlate
);
252 printf("plugin paths:\n");
253 print_value(cfg
->plugin_paths
, 2, true);
254 printf("sources:\n");
255 print_bt_config_components(cfg
->sources
);
257 print_bt_config_components(cfg
->sinks
);
261 struct bt_component
*create_trimmer(struct bt_config_component
*source_cfg
)
263 struct bt_component
*trimmer
= NULL
;
264 struct bt_component_class
*trimmer_class
= NULL
;
265 struct bt_value
*trimmer_params
= NULL
;
267 assert(component_factory
);
268 trimmer_params
= bt_value_map_create();
269 if (!trimmer_params
) {
273 if (source_cfg
->begin
.set
) {
274 enum bt_value_status ret
;
275 struct bt_value
*value
;
277 value
= bt_value_integer_create_init(
278 source_cfg
->begin
.value_ns
);
283 ret
= bt_value_map_insert(trimmer_params
, "begin_ns_epoch",
290 if (source_cfg
->end
.set
) {
291 enum bt_value_status ret
;
292 struct bt_value
*value
;
294 value
= bt_value_integer_create_init(
295 source_cfg
->end
.value_ns
);
300 ret
= bt_value_map_insert(trimmer_params
, "end_ns_epoch",
308 trimmer_class
= bt_component_factory_get_component_class(
309 component_factory
, "utils", BT_COMPONENT_TYPE_FILTER
,
311 if (!trimmer_class
) {
312 fprintf(stderr
, "Could not find trimmer component class. Aborting...\n");
315 trimmer
= bt_component_create(trimmer_class
, "source_trimmer",
321 bt_put(trimmer_params
);
322 bt_put(trimmer_class
);
327 int connect_source_sink(struct bt_component
*source
,
328 struct bt_config_component
*source_cfg
,
329 struct bt_component
*sink
)
332 enum bt_component_status sink_status
;
333 struct bt_component
*trimmer
= NULL
;
334 struct bt_notification_iterator
*source_it
= NULL
;
335 struct bt_notification_iterator
*to_sink_it
= NULL
;
337 source_it
= bt_component_source_create_iterator(source
);
339 fprintf(stderr
, "Failed to instantiate source iterator. Aborting...\n");
344 if (source_cfg
->begin
.set
|| source_cfg
->begin
.set
) {
345 /* A trimmer must be inserted in the graph. */
346 enum bt_component_status trimmer_status
;
348 trimmer
= create_trimmer(source_cfg
);
350 fprintf(stderr
, "Failed to create trimmer component. Aborting...\n");
355 trimmer_status
= bt_component_filter_add_iterator(trimmer
,
358 if (trimmer_status
!= BT_COMPONENT_STATUS_OK
) {
359 fprintf(stderr
, "Failed to connect source to trimmer. Aborting...\n");
364 to_sink_it
= bt_component_filter_create_iterator(trimmer
);
366 fprintf(stderr
, "Failed to instantiate trimmer iterator. Aborting...\n");
371 BT_MOVE(to_sink_it
, source_it
);
374 sink_status
= bt_component_sink_add_iterator(sink
, to_sink_it
);
375 if (sink_status
!= BT_COMPONENT_STATUS_OK
) {
376 fprintf(stderr
, "Failed to connect to sink component. Aborting...\n");
387 int main(int argc
, char **argv
)
390 struct bt_component_class
*source_class
= NULL
;
391 struct bt_component_class
*sink_class
= NULL
;
392 struct bt_component
*source
= NULL
, *sink
= NULL
;
393 struct bt_value
*source_params
= NULL
, *sink_params
= NULL
;
394 struct bt_config
*cfg
;
395 enum bt_component_status sink_status
;
396 struct bt_value
*first_plugin_path_value
= NULL
;
397 const char *first_plugin_path
;
398 struct bt_config_component
*source_cfg
= NULL
, *sink_cfg
= NULL
;
400 cfg
= bt_config_from_args(argc
, argv
, &ret
);
407 babeltrace_verbose
= cfg
->verbose
;
408 babeltrace_debug
= cfg
->debug
;
410 /* TODO handle more than 1 source and 1 sink. */
411 if (cfg
->sources
->len
!= 1 || cfg
->sinks
->len
!= 1) {
412 fprintf(stderr
, "Unexpected configuration, aborting...\n");
417 printf_verbose("Verbose mode active.\n");
418 printf_debug("Debug mode active.\n");
419 component_factory
= bt_component_factory_create();
420 if (!component_factory
) {
421 fprintf(stderr
, "Failed to create component factory.\n");
426 if (cfg
->plugin_paths
&& !bt_value_array_is_empty(cfg
->plugin_paths
)) {
427 first_plugin_path_value
= bt_value_array_get(
428 cfg
->plugin_paths
, 0);
429 bt_value_string_get(first_plugin_path_value
,
431 ret
= bt_component_factory_load_recursive(component_factory
,
434 fprintf(stderr
, "Failed to dynamically load plugins.\n");
439 ret
= bt_component_factory_load_static(component_factory
);
441 fprintf(stderr
, "Failed to load static plugins.\n");
445 print_component_classes_found(component_factory
);
447 source_cfg
= bt_config_get_component(cfg
->sources
, 0);
448 source_params
= bt_get(source_cfg
->params
);
449 source_class
= bt_component_factory_get_component_class(
450 component_factory
, source_cfg
->plugin_name
->str
,
451 BT_COMPONENT_TYPE_SOURCE
,
452 source_cfg
->component_name
->str
);
454 fprintf(stderr
, "Could not find %s.%s source component class. Aborting...\n",
455 source_cfg
->plugin_name
->str
,
456 source_cfg
->component_name
->str
);
461 sink_cfg
= bt_config_get_component(cfg
->sinks
, 0);
462 sink_params
= bt_get(sink_cfg
->params
);
463 sink_class
= bt_component_factory_get_component_class(component_factory
,
464 sink_cfg
->plugin_name
->str
, BT_COMPONENT_TYPE_SINK
,
465 sink_cfg
->component_name
->str
);
467 fprintf(stderr
, "Could not find %s.%s output component class. Aborting...\n",
468 sink_cfg
->plugin_name
->str
,
469 sink_cfg
->component_name
->str
);
474 source
= bt_component_create(source_class
, "source", source_params
);
476 fprintf(stderr
, "Failed to instantiate selected source component. Aborting...\n");
481 sink
= bt_component_create(sink_class
, "sink", sink_params
);
483 fprintf(stderr
, "Failed to instantiate selected output component. Aborting...\n");
488 ret
= connect_source_sink(source
, source_cfg
, sink
);
494 sink_status
= bt_component_sink_consume(sink
);
495 switch (sink_status
) {
496 case BT_COMPONENT_STATUS_AGAIN
:
497 /* Wait for an arbitraty 500 ms. */
500 case BT_COMPONENT_STATUS_OK
:
502 case BT_COMPONENT_STATUS_END
:
505 fprintf(stderr
, "Sink component returned an error, aborting...\n");
511 BT_PUT(component_factory
);
513 BT_PUT(source_class
);
516 BT_PUT(source_params
);
519 BT_PUT(first_plugin_path_value
);