1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Michel Dagenais
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License Version 2 as
6 * published by the Free Software Foundation;
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19 #ifndef PROCESSTRACE_H
20 #define PROCESSTRACE_H
23 #include <lttv/traceset.h>
24 #include <lttv/attribute.h>
25 #include <lttv/hook.h>
27 #include <ltt/marker.h>
29 /* This is the generic part of trace processing. All events within a
30 certain time interval are accessed and processing hooks are called for
31 each. The events are examined in monotonically increasing time to more
32 closely follow the traced system behavior.
34 Hooks are called at several different places during the processing:
35 before traceset, after traceset, check trace, before trace, after trace,
36 check tracefile, before tracefile, after tracefile,
37 check_event, before_event, before_event_by_id,
38 after_event, after_event_by_id.
40 In each case the "check" hooks are called first to determine if further
41 processing of the trace, tracefile or event is wanted. Then, the before
42 hooks and the after hooks are called. The before hooks for a traceset
43 are called before those for the contained traces, which are called before
44 those for the contained tracefiles. The after hooks are called in reverse
45 order. The event hooks are called after all the before_tracefile hooks
46 and before all the after_tracefile hooks.
48 The hooks receive two arguments, the hook_data and call_data. The hook_data
49 is specified when the hook is registered and typically links to the
50 object registering the hook (e.g. a graphical events viewer). The call_data
51 must contain all the context related to the call. The traceset hooks receive
52 the LttvTracesetContext provided by the caller. The trace hooks receive
53 the LttvTraceContext from the traces array in the LttvTracesetContext.
54 The tracefile and event hooks receive the LttvTracefileContext from
55 the tracefiles array in the LttvTraceContext. The LttEvent and LttTime
56 fields in the tracefile context are set to the current event and current
57 event time before calling the event hooks. No other context field is
60 The contexts in the traces and tracefiles arrays must be allocated by
61 the caller, either before the call or during the before hooks of the
62 enclosing traceset or trace. The order in the traces array must
63 correspond to the lttv_traceset_get function. The order in the tracefiles
64 arrays must correspond to the ltt_trace_control_tracefile_get and
65 ltt_trace_per_cpu_tracefile_get functions. The traceset, trace and
66 tracefile contexts may be subtyped as needed. Indeed, both the contexts
67 and the hooks are defined by the caller. */
70 typedef struct _LttvTracesetContext LttvTracesetContext
;
71 typedef struct _LttvTracesetContextClass LttvTracesetContextClass
;
73 typedef struct _LttvTraceContext LttvTraceContext
;
74 typedef struct _LttvTraceContextClass LttvTraceContextClass
;
76 typedef struct _LttvTracefileContext LttvTracefileContext
;
77 typedef struct _LttvTracefileContextClass LttvTracefileContextClass
;
79 typedef struct _LttvTracesetContextPosition LttvTracesetContextPosition
;
80 typedef struct _LttvTraceContextPosition LttvTraceContextPosition
;
82 #ifndef LTTVFILTER_TYPE_DEFINED
83 typedef struct _LttvFilter LttvFilter
;
84 #define LTTVFILTER_TYPE_DEFINED
87 #define LTTV_TRACESET_CONTEXT_TYPE (lttv_traceset_context_get_type ())
88 #define LTTV_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContext))
89 #define LTTV_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
90 #define LTTV_IS_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_CONTEXT_TYPE))
91 #define LTTV_IS_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_CONTEXT_TYPE))
92 #define LTTV_TRACESET_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
94 struct _LttvTracesetContext
{
98 LttvTraceContext
**traces
;
101 TimeInterval time_span
;
103 struct bt_ctf_iter
*iter
;
104 /* TODO ybrosseau: Added for babeltrace proto */
105 LttvHooks
*event_hooks
;
107 LttvTracesetContextPosition
*sync_position
; /* position at which to sync the
111 struct _LttvTracesetContextClass
{
114 void (*init
) (LttvTracesetContext
*self
, LttvTraceset
*ts
);
115 void (*fini
) (LttvTracesetContext
*self
);
116 LttvTracesetContext
* (*new_traceset_context
) (LttvTracesetContext
*self
);
117 LttvTraceContext
* (*new_trace_context
) (LttvTracesetContext
*self
);
118 LttvTracefileContext
* (*new_tracefile_context
) (LttvTracesetContext
*self
);
121 GType
lttv_traceset_context_get_type (void);
123 void lttv_context_init(LttvTracesetContext
*self
, LttvTraceset
*ts
);
125 void lttv_context_fini(LttvTracesetContext
*self
);
127 LttvTracesetContext
*
128 lttv_context_new_traceset_context(LttvTracesetContext
*self
);
131 lttv_context_new_trace_context(LttvTracesetContext
*self
);
133 LttvTracefileContext
*
134 lttv_context_new_tracefile_context(LttvTracesetContext
*self
);
137 #define LTTV_TRACE_CONTEXT_TYPE (lttv_trace_context_get_type ())
138 #define LTTV_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContext))
139 #define LTTV_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
140 #define LTTV_IS_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_CONTEXT_TYPE))
141 #define LTTV_IS_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_CONTEXT_TYPE))
142 #define LTTV_TRACE_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
144 struct _LttvTraceContext
{
147 LttvTracesetContext
*ts_context
;
148 guint index
; /* in ts_context->traces */
151 //LttvTracefileContext **tracefiles;
155 TimeInterval time_span
;
158 struct _LttvTraceContextClass
{
162 GType
lttv_trace_context_get_type (void);
164 #define LTTV_TRACEFILE_CONTEXT_TYPE (lttv_tracefile_context_get_type ())
165 #define LTTV_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContext))
166 #define LTTV_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
167 #define LTTV_IS_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_CONTEXT_TYPE))
168 #define LTTV_IS_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE))
169 #define LTTV_TRACEFILE_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
171 struct _LttvTracefileContext
{
174 LttvTraceContext
*t_context
;
176 guint index
; /* in ts_context->tracefiles */
180 LttvHooksById
*event_by_id
;
183 gint target_pid
; /* Target PID of the event.
184 Updated by state.c. -1 means unset. */
187 struct _LttvTracefileContextClass
{
191 GType
lttv_tracefile_context_get_type (void);
193 /* Run through the events in a traceset in sorted order calling all the
194 hooks appropriately. It starts at the current time and runs until end or
195 nb_events are processed. */
197 void lttv_process_traceset(LttvTracesetContext
*self
, LttTime end
,
200 /* Process traceset can also be done in smaller pieces calling begin,
201 * then seek and middle repeatedly, and end. The middle function return the
202 * number of events processed. It will be smaller than nb_events if the end time
203 * or end position is reached. */
206 void lttv_process_traceset_begin(LttvTracesetContext
*self
,
207 LttvHooks
*before_traceset
,
208 LttvHooks
*before_trace
,
209 LttvHooks
*before_tracefile
,
211 LttvHooksByIdChannelArray
*event_by_id_channel
);
214 guint
lttv_process_traceset_middle(LttvTracesetContext
*self
,
217 const LttvTracesetContextPosition
*end_position
);
219 void lttv_process_traceset_end(LttvTracesetContext
*self
,
220 LttvHooks
*after_traceset
,
221 LttvHooks
*after_trace
,
222 LttvHooks
*after_tracefile
,
224 LttvHooksByIdChannelArray
*event_by_id_channel
);
226 guint
lttv_process_traceset_update(LttvTracesetContext
*self
);
229 void lttv_process_traceset_seek_time(LttvTracesetContext
*self
, LttTime start
);
231 void lttv_traceset_context_compute_time_span(LttvTracesetContext
*self
,
232 TimeInterval
*time_span
);
234 gboolean
lttv_process_traceset_seek_position(LttvTracesetContext
*self
,
235 const LttvTracesetContextPosition
*pos
);
237 void lttv_process_trace_seek_time(LttvTraceContext
*self
, LttTime start
);
239 void lttv_traceset_context_add_hooks(LttvTracesetContext
*self
,
240 LttvHooks
*before_traceset
,
241 LttvHooks
*before_trace
,
242 LttvHooks
*before_tracefile
,
244 LttvHooksByIdChannelArray
*event_by_id_channel
);
246 void lttv_traceset_context_remove_hooks(LttvTracesetContext
*self
,
247 LttvHooks
*after_traceset
,
248 LttvHooks
*after_trace
,
249 LttvHooks
*after_tracefile
,
251 LttvHooksByIdChannelArray
*event_by_id_channel
);
253 void lttv_trace_context_add_hooks(LttvTraceContext
*self
,
254 LttvHooks
*before_trace
,
255 LttvHooks
*before_tracefile
,
257 LttvHooksByIdChannelArray
*event_by_id_channel
);
259 void lttv_trace_context_remove_hooks(LttvTraceContext
*self
,
260 LttvHooks
*after_trace
,
261 LttvHooks
*after_tracefile
,
263 LttvHooksByIdChannelArray
*event_by_id_channel
);
265 void lttv_tracefile_context_add_hooks(LttvTracefileContext
*self
,
266 LttvHooks
*before_tracefile
,
268 LttvHooksById
*event_by_id
);
271 void lttv_tracefile_context_remove_hooks(LttvTracefileContext
*self
,
272 LttvHooks
*after_tracefile
,
274 LttvHooksById
*event_by_id
);
276 typedef struct _LttvTraceHook
{
278 struct marker_data
*mdata
;
280 guint16 id
; /* id of the marker associated with this hook */
281 GPtrArray
*fields
; /* struct marker_fields pointers */
285 /* Get the head of marker list corresponding to the given trace hook.
287 struct marker_info
*lttv_trace_hook_get_marker(LttTrace
*t
, LttvTraceHook
*th
);
289 /* Remove the hooks from the array. Does not free the array itself. */
290 void lttv_trace_hook_remove_all(GArray
**th
);
292 /* Search in the trace for the id of the named event type within the named
293 facility. Then, find the three (if non null) named fields. All that
294 information is then used to fill the LttvTraceHook structure. This
295 is useful to find the specific id for an event within a trace, for
296 registering a hook using this structure as event data;
297 it already contains the (up to three) needed fields handles.
298 Returns the modified LttvTraceHook array.
299 Prints warnings if events or markers are not found. returns 1 on error,
301 Adds the hooks to the trace_hooks array.
304 int lttv_trace_find_hook(LttTrace
*t
, GQuark facility_name
, GQuark event_name
,
305 GQuark fields
[], LttvHook h
, gpointer hook_data
,
306 GArray
**trace_hooks
);
308 static inline struct marker_field
*
309 lttv_trace_get_hook_field(LttvTraceHook
*hook
, unsigned int index
)
311 return g_ptr_array_index(hook
->fields
, index
);
315 static inline GQuark
lttv_merge_facility_event_name(GQuark fac
, GQuark ev
)
318 const char *sfac
, *sev
;
321 sfac
= g_quark_to_string(fac
);
322 sev
= g_quark_to_string(ev
);
323 tmp
= g_new(char, strlen(sfac
) + strlen(sev
) + 3); /* 3: _ \0 \0 */
327 ret
= g_quark_from_string(tmp
);
333 LttvTracefileContext
*
334 lttv_traceset_context_get_current_tfc(LttvTracesetContext
*self
);
337 LttvTracesetContextPosition
*
338 lttv_traceset_context_position_new(const LttvTracesetContext
*self
);
340 void lttv_traceset_context_position_save(const LttvTracesetContext
*self
,
341 LttvTracesetContextPosition
*pos
);
343 void lttv_traceset_context_position_destroy(LttvTracesetContextPosition
*pos
);
345 void lttv_traceset_context_position_copy(LttvTracesetContextPosition
*dest
,
346 const LttvTracesetContextPosition
*src
);
349 lttv_traceset_context_pos_pos_compare(const LttvTracesetContextPosition
*pos1
,
350 const LttvTracesetContextPosition
*pos2
);
352 gint
lttv_traceset_context_ctx_pos_compare(const LttvTracesetContext
*self
,
353 const LttvTracesetContextPosition
*pos2
);
356 lttv_traceset_context_position_get_time(const LttvTracesetContextPosition
*pos
);
358 gint
compare_tracefile(gconstpointer a
, gconstpointer b
);
361 /* Synchronisation helpers : save/restore synchronization between ltt traces and
362 * a traceset context. */
363 void lttv_process_traceset_synchronize_tracefiles(LttvTracesetContext
*tsc
);
365 void lttv_process_traceset_get_sync_data(LttvTracesetContext
*tsc
);
367 /* Seek n events forward and backward (without filtering) : only use these where
368 * necessary : the seek backward is costy. */
370 #define BACKWARD_SEEK_MUL 2 /* Multiplication factor of time_offset between
371 backward seek iterations */
373 static const LttTime seek_back_default_offset
= { 1, 0 };
375 typedef gboolean
check_handler(guint count
, gboolean
*stop_flag
, gpointer data
);
377 guint
lttv_process_traceset_seek_n_forward(LttvTracesetContext
*self
,
379 check_handler
*check
,
386 typedef void (*seek_time_fct
)(LttvTracesetContext
*self
, LttTime start
);
388 /* If first_offset is ltt_time_zero, it will choose a default value */
389 guint
lttv_process_traceset_seek_n_backward(LttvTracesetContext
*self
,
391 LttTime first_offset
,
393 check_handler
*check
,
400 #define FIELD_ARRAY(val...) ((GQuark[]){ val, 0 })
402 #endif // PROCESSTRACE_H