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. */
55 enum bt_cb_ret (*callback
)(void *private_data
, void *caller_data
);
58 struct bt_callback_chain
{
59 GArray
*callback
; /* Array of struct bt_callback, ordered by priority */
63 * per id callbacks need to be per stream class because event ID vs
64 * event name mapping can vary from stream to stream.
66 struct bt_stream_callbacks
{
67 GArray
*per_id_callbacks
; /* Array of struct bt_callback_chain */
71 * struct babeltrace_iter: data structure representing an iterator on a trace
74 struct babeltrace_iter
{
75 struct ptr_heap
*stream_heap
;
76 struct trace_collection
*tc
;
77 struct trace_collection_pos
*end_pos
;
78 GArray
*callbacks
; /* Array of struct bt_stream_hooks */
79 struct bt_callback_chain main_callbacks
; /* For all events */
81 * Flag indicating if dependency graph needs to be recalculated.
82 * Set by babeltrace_iter_add_callback(), and checked (and
83 * cleared) by upon entry into babeltrace_iter_read_event().
84 * babeltrace_iter_read_event() is responsible for calling dep
85 * graph calculation if it sees this flag set.
87 int recalculate_dep_graph
;
89 * Array of pointers to struct bt_dependencies, for garbage
90 * collection. We're not using a linked list here because each
91 * struct bt_dependencies can belong to more than one
97 struct bt_dependencies
{
98 GArray
*deps
; /* Array of GQuarks */
99 int refcount
; /* free when decremented to 0 */
103 struct bt_dependencies
*_babeltrace_dependencies_create(const char *first
,
107 struct bt_dependencies
*dep
;
109 dep
= g_new0(struct bt_dependencies
, 1);
111 dep
->deps
= g_array_new(FALSE
, TRUE
, sizeof(GQuark
));
114 GQuark q
= g_quark_from_string(iter
);
115 g_array_append_val(dep
->deps
, q
);
116 iter
= va_arg(ap
, const char *);
121 struct bt_dependencies
*babeltrace_dependencies_create(const char *first
, ...)
124 struct bt_dependencies
*deps
;
127 deps
= _babeltrace_dependencies_create(first
, ap
);
132 static int stream_read_event(struct ctf_file_stream
*sin
)
136 ret
= sin
->pos
.parent
.event_cb(&sin
->pos
.parent
, &sin
->parent
);
140 fprintf(stdout
, "[error] Reading event failed.\n");
147 * returns true if a < b, false otherwise.
149 int stream_compare(void *a
, void *b
)
151 struct ctf_file_stream
*s_a
= a
, *s_b
= b
;
153 if (s_a
->parent
.timestamp
< s_b
->parent
.timestamp
)
160 * babeltrace_filestream_seek: seek a filestream to given position.
162 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
164 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
165 const struct trace_collection_pos
*begin_pos
,
166 unsigned long stream_id
)
170 switch (begin_pos
->type
) {
173 * just insert into the heap we should already know
178 ctf_move_pos_slow(&file_stream
->pos
, 0, SEEK_SET
);
179 ret
= stream_read_event(file_stream
);
182 case BT_SEEK_RESTORE
:
185 assert(0); /* Not yet defined */
192 * babeltrace_iter_seek: seek iterator to given position.
194 int babeltrace_iter_seek(struct babeltrace_iter
*iter
,
195 const struct trace_collection_pos
*begin_pos
)
199 struct trace_collection
*tc
= iter
->tc
;
201 for (i
= 0; i
< tc
->array
->len
; i
++) {
202 struct ctf_trace
*tin
;
203 struct trace_descriptor
*td_read
;
205 td_read
= g_ptr_array_index(tc
->array
, i
);
206 tin
= container_of(td_read
, struct ctf_trace
, parent
);
208 /* Populate heap with each stream */
209 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
211 struct ctf_stream_class
*stream
;
214 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
215 for (filenr
= 0; filenr
< stream
->streams
->len
;
217 struct ctf_file_stream
*file_stream
;
219 file_stream
= g_ptr_array_index(stream
->streams
,
221 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
232 struct babeltrace_iter
*babeltrace_iter_create(struct trace_collection
*tc
,
233 struct trace_collection_pos
*begin_pos
,
234 struct trace_collection_pos
*end_pos
)
238 struct babeltrace_iter
*iter
;
240 iter
= malloc(sizeof(struct babeltrace_iter
));
243 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
245 iter
->end_pos
= end_pos
;
247 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
249 goto error_heap_init
;
251 for (i
= 0; i
< tc
->array
->len
; i
++) {
252 struct ctf_trace
*tin
;
253 struct trace_descriptor
*td_read
;
255 td_read
= g_ptr_array_index(tc
->array
, i
);
256 tin
= container_of(td_read
, struct ctf_trace
, parent
);
258 /* Populate heap with each stream */
259 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
261 struct ctf_stream_class
*stream
;
264 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
267 for (filenr
= 0; filenr
< stream
->streams
->len
;
269 struct ctf_file_stream
*file_stream
;
271 file_stream
= g_ptr_array_index(stream
->streams
,
275 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
285 ret
= heap_insert(iter
->stream_heap
, file_stream
);
295 heap_free(iter
->stream_heap
);
297 g_free(iter
->stream_heap
);
303 void babeltrace_iter_destroy(struct babeltrace_iter
*iter
)
305 heap_free(iter
->stream_heap
);
306 g_free(iter
->stream_heap
);
310 int babeltrace_iter_next(struct babeltrace_iter
*iter
)
312 struct ctf_file_stream
*file_stream
, *removed
;
315 file_stream
= heap_maximum(iter
->stream_heap
);
317 /* end of file for all streams */
322 ret
= stream_read_event(file_stream
);
324 removed
= heap_remove(iter
->stream_heap
);
325 assert(removed
== file_stream
);
331 /* Reinsert the file stream into the heap, and rebalance. */
332 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
333 assert(removed
== file_stream
);
339 int babeltrace_iter_read_event(struct babeltrace_iter
*iter
,
340 struct ctf_stream
**stream
,
341 struct ctf_stream_event
**event
)
343 struct ctf_file_stream
*file_stream
;
346 file_stream
= heap_maximum(iter
->stream_heap
);
348 /* end of file for all streams */
352 *stream
= &file_stream
->parent
;
353 *event
= g_ptr_array_index((*stream
)->events_by_id
, (*stream
)->event_id
);
358 int convert_trace(struct trace_descriptor
*td_write
,
359 struct trace_collection
*trace_collection_read
)
361 struct babeltrace_iter
*iter
;
362 struct ctf_stream
*stream
;
363 struct ctf_stream_event
*event
;
364 struct ctf_text_stream_pos
*sout
;
365 struct trace_collection_pos begin_pos
;
368 sout
= container_of(td_write
, struct ctf_text_stream_pos
,
371 begin_pos
.type
= BT_SEEK_BEGIN
;
372 iter
= babeltrace_iter_create(trace_collection_read
, &begin_pos
, NULL
);
373 while (babeltrace_iter_read_event(iter
, &stream
, &event
) == 0) {
374 ret
= sout
->parent
.event_cb(&sout
->parent
, stream
);
376 fprintf(stdout
, "[error] Writing event failed.\n");
379 ret
= babeltrace_iter_next(iter
);
384 babeltrace_iter_destroy(iter
);