4 * Babeltrace Trace Converter Library
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.
25 #include <babeltrace/babeltrace-internal.h>
26 #include <babeltrace/format.h>
27 #include <babeltrace/ctf/types.h>
28 #include <babeltrace/ctf/metadata.h>
29 #include <babeltrace/ctf-text/types.h>
30 #include <babeltrace/prio_heap.h>
31 #include <babeltrace/babeltrace.h>
32 #include <babeltrace/types.h>
33 #include <babeltrace/ctf/types.h>
34 #include <babeltrace/ctf-ir/metadata.h>
37 struct stream_saved_pos
{
39 * Use file_stream pointer to check if the trace collection we
40 * restore to match the one we saved from, for each stream.
42 struct ctf_file_stream
*file_stream
;
43 size_t cur_index
; /* current index in packet index */
44 ssize_t offset
; /* offset from base, in bits. EOF for end of file. */
47 struct babeltrace_saved_pos
{
48 struct trace_collection
*tc
;
49 GArray
*stream_saved_pos
; /* Contains struct stream_saved_pos */
53 int prio
; /* Callback order priority. Lower first. Dynamically assigned from dependency graph. */
56 struct bt_dependencies
*depends
;
57 struct bt_dependencies
*weak_depends
;
58 struct bt_dependencies
*provides
;
59 enum bt_cb_ret (*callback
)(void *private_data
, void *caller_data
);
62 struct bt_callback_chain
{
63 GArray
*callback
; /* Array of struct bt_callback, ordered by priority */
67 * per id callbacks need to be per stream class because event ID vs
68 * event name mapping can vary from stream to stream.
70 struct bt_stream_callbacks
{
71 GArray
*per_id_callbacks
; /* Array of struct bt_callback_chain */
75 * struct babeltrace_iter: data structure representing an iterator on a trace
78 struct babeltrace_iter
{
79 struct ptr_heap
*stream_heap
;
80 struct trace_collection
*tc
;
81 struct trace_collection_pos
*end_pos
;
82 GArray
*callbacks
; /* Array of struct bt_stream_callbacks */
83 struct bt_callback_chain main_callbacks
; /* For all events */
85 * Flag indicating if dependency graph needs to be recalculated.
86 * Set by babeltrace_iter_add_callback(), and checked (and
87 * cleared) by upon entry into babeltrace_iter_read_event().
88 * babeltrace_iter_read_event() is responsible for calling dep
89 * graph calculation if it sees this flag set.
91 int recalculate_dep_graph
;
93 * Array of pointers to struct bt_dependencies, for garbage
94 * collection. We're not using a linked list here because each
95 * struct bt_dependencies can belong to more than one
101 struct bt_dependencies
{
102 GArray
*deps
; /* Array of GQuarks */
103 int refcount
; /* free when decremented to 0 */
107 struct bt_dependencies
*_babeltrace_dependencies_create(const char *first
,
111 struct bt_dependencies
*dep
;
113 dep
= g_new0(struct bt_dependencies
, 1);
115 dep
->deps
= g_array_new(FALSE
, TRUE
, sizeof(GQuark
));
118 GQuark q
= g_quark_from_string(iter
);
119 g_array_append_val(dep
->deps
, q
);
120 iter
= va_arg(ap
, const char *);
125 struct bt_dependencies
*babeltrace_dependencies_create(const char *first
, ...)
128 struct bt_dependencies
*deps
;
131 deps
= _babeltrace_dependencies_create(first
, ap
);
137 * babeltrace_iter_add_callback: Add a callback to iterator.
139 int babeltrace_iter_add_callback(struct babeltrace_iter
*iter
,
140 bt_event_name event
, void *private_data
, int flags
,
141 enum bt_cb_ret (*callback
)(void *private_data
, void *caller_data
),
142 struct bt_dependencies
*depends
,
143 struct bt_dependencies
*weak_depends
,
144 struct bt_dependencies
*provides
)
147 gpointer
*event_id_ptr
;
148 unsigned long event_id
;
149 struct trace_collection
*tc
= iter
->tc
;
151 for (i
= 0; i
< tc
->array
->len
; i
++) {
152 struct ctf_trace
*tin
;
153 struct trace_descriptor
*td_read
;
155 td_read
= g_ptr_array_index(tc
->array
, i
);
156 tin
= container_of(td_read
, struct ctf_trace
, parent
);
158 for (stream_id
= 0; stream_id
< tin
->streams
->len
; stream_id
++) {
159 struct ctf_stream_class
*stream
;
160 struct bt_stream_callbacks
*bt_stream_cb
= NULL
;
161 struct bt_callback_chain
*bt_chain
= NULL
;
162 struct bt_callback new_callback
;
164 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
166 /* find or create the bt_stream_callbacks for this stream */
167 if (iter
->callbacks
->len
>= stream_id
) {
168 bt_stream_cb
= &g_array_index(iter
->callbacks
,
169 struct bt_stream_callbacks
, stream
->stream_id
);
171 g_array_set_size(iter
->callbacks
, stream
->stream_id
);
173 if (!bt_stream_cb
|| !bt_stream_cb
->per_id_callbacks
) {
174 struct bt_stream_callbacks new_stream_cb
;
175 new_stream_cb
.per_id_callbacks
= g_array_new(1, 1,
176 sizeof(struct bt_callback_chain
));
177 g_array_insert_val(iter
->callbacks
, stream
->stream_id
, new_stream_cb
);
178 bt_stream_cb
= &g_array_index(iter
->callbacks
,
179 struct bt_stream_callbacks
, stream
->stream_id
);
183 /* find the event id */
184 event_id_ptr
= g_hash_table_lookup(stream
->event_quark_to_id
,
185 (gconstpointer
) (unsigned long) event
);
186 /* event not found in this stream class */
188 printf("event not found\n");
191 event_id
= (uint64_t)*event_id_ptr
;
193 /* find or create the bt_callback_chain for this event */
194 if (bt_stream_cb
->per_id_callbacks
->len
>= event_id
) {
195 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
196 struct bt_callback_chain
, event_id
);
198 g_array_set_size(bt_stream_cb
->per_id_callbacks
, event_id
);
200 if (!bt_chain
|| !bt_chain
->callback
) {
201 struct bt_callback_chain new_chain
;
202 new_chain
.callback
= g_array_new(1, 1, sizeof(struct bt_callback
));
203 g_array_insert_val(bt_stream_cb
->per_id_callbacks
, event_id
,
205 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
206 struct bt_callback_chain
, event_id
);
209 /* callback for all events */
210 if (!iter
->main_callbacks
.callback
) {
211 iter
->main_callbacks
.callback
= g_array_new(1, 1,
212 sizeof(struct bt_callback
));
214 bt_chain
= &iter
->main_callbacks
;
217 new_callback
.private_data
= private_data
;
218 new_callback
.flags
= flags
;
219 new_callback
.callback
= callback
;
220 new_callback
.depends
= depends
;
221 new_callback
.weak_depends
= weak_depends
;
222 new_callback
.provides
= provides
;
224 /* TODO : take care of priority, for now just FIFO */
225 g_array_append_val(bt_chain
->callback
, new_callback
);
232 static int stream_read_event(struct ctf_file_stream
*sin
)
236 ret
= sin
->pos
.parent
.event_cb(&sin
->pos
.parent
, &sin
->parent
);
240 fprintf(stdout
, "[error] Reading event failed.\n");
247 * returns true if a < b, false otherwise.
249 int stream_compare(void *a
, void *b
)
251 struct ctf_file_stream
*s_a
= a
, *s_b
= b
;
253 if (s_a
->parent
.timestamp
< s_b
->parent
.timestamp
)
260 * babeltrace_filestream_seek: seek a filestream to given position.
262 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
264 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
265 const struct trace_collection_pos
*begin_pos
,
266 unsigned long stream_id
)
270 switch (begin_pos
->type
) {
273 * just insert into the heap we should already know
278 ctf_move_pos_slow(&file_stream
->pos
, 0, SEEK_SET
);
279 ret
= stream_read_event(file_stream
);
282 case BT_SEEK_RESTORE
:
285 assert(0); /* Not yet defined */
292 * babeltrace_iter_seek: seek iterator to given position.
294 int babeltrace_iter_seek(struct babeltrace_iter
*iter
,
295 const struct trace_collection_pos
*begin_pos
)
299 struct trace_collection
*tc
= iter
->tc
;
301 for (i
= 0; i
< tc
->array
->len
; i
++) {
302 struct ctf_trace
*tin
;
303 struct trace_descriptor
*td_read
;
305 td_read
= g_ptr_array_index(tc
->array
, i
);
306 tin
= container_of(td_read
, struct ctf_trace
, parent
);
308 /* Populate heap with each stream */
309 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
311 struct ctf_stream_class
*stream
;
314 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
315 for (filenr
= 0; filenr
< stream
->streams
->len
;
317 struct ctf_file_stream
*file_stream
;
319 file_stream
= g_ptr_array_index(stream
->streams
,
321 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
332 struct babeltrace_iter
*babeltrace_iter_create(struct trace_collection
*tc
,
333 struct trace_collection_pos
*begin_pos
,
334 struct trace_collection_pos
*end_pos
)
338 struct babeltrace_iter
*iter
;
340 iter
= malloc(sizeof(struct babeltrace_iter
));
343 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
345 iter
->end_pos
= end_pos
;
346 iter
->callbacks
= g_array_new(0, 1, sizeof(struct bt_stream_callbacks
));
347 iter
->recalculate_dep_graph
= 0;
348 iter
->main_callbacks
.callback
= NULL
;
349 iter
->dep_gc
= g_ptr_array_new();
351 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
353 goto error_heap_init
;
355 for (i
= 0; i
< tc
->array
->len
; i
++) {
356 struct ctf_trace
*tin
;
357 struct trace_descriptor
*td_read
;
359 td_read
= g_ptr_array_index(tc
->array
, i
);
360 tin
= container_of(td_read
, struct ctf_trace
, parent
);
362 /* Populate heap with each stream */
363 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
365 struct ctf_stream_class
*stream
;
368 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
371 for (filenr
= 0; filenr
< stream
->streams
->len
;
373 struct ctf_file_stream
*file_stream
;
375 file_stream
= g_ptr_array_index(stream
->streams
,
379 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
389 ret
= heap_insert(iter
->stream_heap
, file_stream
);
399 heap_free(iter
->stream_heap
);
401 g_free(iter
->stream_heap
);
407 void babeltrace_iter_destroy(struct babeltrace_iter
*iter
)
409 struct bt_stream_callbacks
*bt_stream_cb
;
410 struct bt_callback_chain
*bt_chain
;
413 heap_free(iter
->stream_heap
);
414 g_free(iter
->stream_heap
);
416 /* free all events callbacks */
417 if (iter
->main_callbacks
.callback
)
418 g_array_free(iter
->main_callbacks
.callback
, TRUE
);
420 /* free per-event callbacks */
421 for (i
= 0; i
< iter
->callbacks
->len
; i
++) {
422 bt_stream_cb
= &g_array_index(iter
->callbacks
,
423 struct bt_stream_callbacks
, i
);
424 if (!bt_stream_cb
|| !bt_stream_cb
->per_id_callbacks
)
426 for (j
= 0; j
< bt_stream_cb
->per_id_callbacks
->len
; j
++) {
427 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
428 struct bt_callback_chain
, j
);
429 g_array_free(bt_chain
->callback
, TRUE
);
431 g_array_free(bt_stream_cb
->per_id_callbacks
, TRUE
);
437 int babeltrace_iter_next(struct babeltrace_iter
*iter
)
439 struct ctf_file_stream
*file_stream
, *removed
;
442 file_stream
= heap_maximum(iter
->stream_heap
);
444 /* end of file for all streams */
449 ret
= stream_read_event(file_stream
);
451 removed
= heap_remove(iter
->stream_heap
);
452 assert(removed
== file_stream
);
458 /* Reinsert the file stream into the heap, and rebalance. */
459 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
460 assert(removed
== file_stream
);
467 void process_callbacks(struct babeltrace_iter
*iter
,
468 struct ctf_stream
*stream
)
470 struct bt_stream_callbacks
*bt_stream_cb
;
471 struct bt_callback_chain
*bt_chain
;
472 struct bt_callback
*cb
;
476 /* process all events callback first */
477 if (iter
->main_callbacks
.callback
) {
478 for (i
= 0; i
< iter
->main_callbacks
.callback
->len
; i
++) {
479 cb
= &g_array_index(iter
->main_callbacks
.callback
, struct bt_callback
, i
);
482 ret
= cb
->callback(NULL
, NULL
);
485 case BT_CB_ERROR_STOP
:
493 /* process per event callbacks */
494 bt_stream_cb
= &g_array_index(iter
->callbacks
,
495 struct bt_stream_callbacks
, stream
->stream_id
);
496 if (!bt_stream_cb
|| !bt_stream_cb
->per_id_callbacks
)
499 if (stream
->event_id
> bt_stream_cb
->per_id_callbacks
->len
)
501 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
502 struct bt_callback_chain
, stream
->event_id
);
503 if (!bt_chain
|| !bt_chain
->callback
)
506 for (i
= 0; i
< bt_chain
->callback
->len
; i
++) {
507 cb
= &g_array_index(bt_chain
->callback
, struct bt_callback
, i
);
510 ret
= cb
->callback(NULL
, NULL
);
513 case BT_CB_ERROR_STOP
:
524 int babeltrace_iter_read_event(struct babeltrace_iter
*iter
,
525 struct ctf_stream
**stream
,
526 struct ctf_stream_event
**event
)
528 struct ctf_file_stream
*file_stream
;
531 file_stream
= heap_maximum(iter
->stream_heap
);
533 /* end of file for all streams */
537 *stream
= &file_stream
->parent
;
538 *event
= g_ptr_array_index((*stream
)->events_by_id
, (*stream
)->event_id
);
540 if ((*stream
)->stream_id
> iter
->callbacks
->len
)
543 process_callbacks(iter
, *stream
);
549 int convert_trace(struct trace_descriptor
*td_write
,
550 struct trace_collection
*trace_collection_read
)
552 struct babeltrace_iter
*iter
;
553 struct ctf_stream
*stream
;
554 struct ctf_stream_event
*event
;
555 struct ctf_text_stream_pos
*sout
;
556 struct trace_collection_pos begin_pos
;
559 sout
= container_of(td_write
, struct ctf_text_stream_pos
,
562 begin_pos
.type
= BT_SEEK_BEGIN
;
563 iter
= babeltrace_iter_create(trace_collection_read
, &begin_pos
, NULL
);
564 while (babeltrace_iter_read_event(iter
, &stream
, &event
) == 0) {
565 ret
= sout
->parent
.event_cb(&sout
->parent
, stream
);
567 fprintf(stdout
, "[error] Writing event failed.\n");
570 ret
= babeltrace_iter_next(iter
);
575 babeltrace_iter_destroy(iter
);