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
22 #include <lttv/traceset.h>
23 #include <lttv/attribute.h>
24 #include <lttv/hook.h>
26 #include <ltt/markers.h>
28 /* This is the generic part of trace processing. All events within a
29 certain time interval are accessed and processing hooks are called for
30 each. The events are examined in monotonically increasing time to more
31 closely follow the traced system behavior.
33 Hooks are called at several different places during the processing:
34 before traceset, after traceset, check trace, before trace, after trace,
35 check tracefile, before tracefile, after tracefile,
36 check_event, before_event, before_event_by_id,
37 after_event, after_event_by_id.
39 In each case the "check" hooks are called first to determine if further
40 processing of the trace, tracefile or event is wanted. Then, the before
41 hooks and the after hooks are called. The before hooks for a traceset
42 are called before those for the contained traces, which are called before
43 those for the contained tracefiles. The after hooks are called in reverse
44 order. The event hooks are called after all the before_tracefile hooks
45 and before all the after_tracefile hooks.
47 The hooks receive two arguments, the hook_data and call_data. The hook_data
48 is specified when the hook is registered and typically links to the
49 object registering the hook (e.g. a graphical events viewer). The call_data
50 must contain all the context related to the call. The traceset hooks receive
51 the LttvTracesetContext provided by the caller. The trace hooks receive
52 the LttvTraceContext from the traces array in the LttvTracesetContext.
53 The tracefile and event hooks receive the LttvTracefileContext from
54 the tracefiles array in the LttvTraceContext. The LttEvent and LttTime
55 fields in the tracefile context are set to the current event and current
56 event time before calling the event hooks. No other context field is
59 The contexts in the traces and tracefiles arrays must be allocated by
60 the caller, either before the call or during the before hooks of the
61 enclosing traceset or trace. The order in the traces array must
62 correspond to the lttv_traceset_get function. The order in the tracefiles
63 arrays must correspond to the ltt_trace_control_tracefile_get and
64 ltt_trace_per_cpu_tracefile_get functions. The traceset, trace and
65 tracefile contexts may be subtyped as needed. Indeed, both the contexts
66 and the hooks are defined by the caller. */
69 typedef struct _LttvTracesetContext LttvTracesetContext
;
70 typedef struct _LttvTracesetContextClass LttvTracesetContextClass
;
72 typedef struct _LttvTraceContext LttvTraceContext
;
73 typedef struct _LttvTraceContextClass LttvTraceContextClass
;
75 typedef struct _LttvTracefileContext LttvTracefileContext
;
76 typedef struct _LttvTracefileContextClass LttvTracefileContextClass
;
78 typedef struct _LttvTracesetContextPosition LttvTracesetContextPosition
;
79 typedef struct _LttvTraceContextPosition LttvTraceContextPosition
;
81 #ifndef LTTVFILTER_TYPE_DEFINED
82 typedef struct _LttvFilter LttvFilter
;
83 #define LTTVFILTER_TYPE_DEFINED
86 #define LTTV_TRACESET_CONTEXT_TYPE (lttv_traceset_context_get_type ())
87 #define LTTV_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContext))
88 #define LTTV_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
89 #define LTTV_IS_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_CONTEXT_TYPE))
90 #define LTTV_IS_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_CONTEXT_TYPE))
91 #define LTTV_TRACESET_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
93 struct _LttvTracesetContext
{
97 LttvTraceContext
**traces
;
100 TimeInterval time_span
;
103 LttvTracesetContextPosition
*sync_position
; /* position at which to sync the
107 struct _LttvTracesetContextClass
{
110 void (*init
) (LttvTracesetContext
*self
, LttvTraceset
*ts
);
111 void (*fini
) (LttvTracesetContext
*self
);
112 LttvTracesetContext
* (*new_traceset_context
) (LttvTracesetContext
*self
);
113 LttvTraceContext
* (*new_trace_context
) (LttvTracesetContext
*self
);
114 LttvTracefileContext
* (*new_tracefile_context
) (LttvTracesetContext
*self
);
117 GType
lttv_traceset_context_get_type (void);
119 void lttv_context_init(LttvTracesetContext
*self
, LttvTraceset
*ts
);
121 void lttv_context_fini(LttvTracesetContext
*self
);
123 LttvTracesetContext
*
124 lttv_context_new_traceset_context(LttvTracesetContext
*self
);
127 lttv_context_new_trace_context(LttvTracesetContext
*self
);
129 LttvTracefileContext
*
130 lttv_context_new_tracefile_context(LttvTracesetContext
*self
);
133 #define LTTV_TRACE_CONTEXT_TYPE (lttv_trace_context_get_type ())
134 #define LTTV_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContext))
135 #define LTTV_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
136 #define LTTV_IS_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_CONTEXT_TYPE))
137 #define LTTV_IS_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_CONTEXT_TYPE))
138 #define LTTV_TRACE_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
140 struct _LttvTraceContext
{
143 LttvTracesetContext
*ts_context
;
144 guint index
; /* in ts_context->traces */
147 //LttvTracefileContext **tracefiles;
151 TimeInterval time_span
;
154 struct _LttvTraceContextClass
{
158 GType
lttv_trace_context_get_type (void);
160 #define LTTV_TRACEFILE_CONTEXT_TYPE (lttv_tracefile_context_get_type ())
161 #define LTTV_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContext))
162 #define LTTV_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
163 #define LTTV_IS_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_CONTEXT_TYPE))
164 #define LTTV_IS_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE))
165 #define LTTV_TRACEFILE_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
167 struct _LttvTracefileContext
{
170 LttvTraceContext
*t_context
;
172 guint index
; /* in ts_context->tracefiles */
176 LttvHooksById
*event_by_id
;
179 gint target_pid
; /* Target PID of the event.
180 Updated by state.c. -1 means unset. */
183 struct _LttvTracefileContextClass
{
187 GType
lttv_tracefile_context_get_type (void);
189 /* Run through the events in a traceset in sorted order calling all the
190 hooks appropriately. It starts at the current time and runs until end or
191 nb_events are processed. */
193 void lttv_process_traceset(LttvTracesetContext
*self
, LttTime end
,
196 /* Process traceset can also be done in smaller pieces calling begin,
197 * then seek and middle repeatedly, and end. The middle function return the
198 * number of events processed. It will be smaller than nb_events if the end time
199 * or end position is reached. */
202 void lttv_process_traceset_begin(LttvTracesetContext
*self
,
203 LttvHooks
*before_traceset
,
204 LttvHooks
*before_trace
,
205 LttvHooks
*before_tracefile
,
207 LttvHooksById
*event_by_id
);
210 guint
lttv_process_traceset_middle(LttvTracesetContext
*self
,
213 const LttvTracesetContextPosition
*end_position
);
215 void lttv_process_traceset_end(LttvTracesetContext
*self
,
216 LttvHooks
*after_traceset
,
217 LttvHooks
*after_trace
,
218 LttvHooks
*after_tracefile
,
220 LttvHooksById
*event_by_id
);
223 void lttv_process_traceset_seek_time(LttvTracesetContext
*self
, LttTime start
);
225 gboolean
lttv_process_traceset_seek_position(LttvTracesetContext
*self
,
226 const LttvTracesetContextPosition
*pos
);
228 void lttv_process_trace_seek_time(LttvTraceContext
*self
, LttTime start
);
230 void lttv_traceset_context_add_hooks(LttvTracesetContext
*self
,
231 LttvHooks
*before_traceset
,
232 LttvHooks
*before_trace
,
233 LttvHooks
*before_tracefile
,
235 LttvHooksById
*event_by_id
);
237 void lttv_traceset_context_remove_hooks(LttvTracesetContext
*self
,
238 LttvHooks
*after_traceset
,
239 LttvHooks
*after_trace
,
240 LttvHooks
*after_tracefile
,
242 LttvHooksById
*event_by_id
);
244 void lttv_trace_context_add_hooks(LttvTraceContext
*self
,
245 LttvHooks
*before_trace
,
246 LttvHooks
*before_tracefile
,
248 LttvHooksById
*event_by_id
);
250 void lttv_trace_context_remove_hooks(LttvTraceContext
*self
,
251 LttvHooks
*after_trace
,
252 LttvHooks
*after_tracefile
,
254 LttvHooksById
*event_by_id
);
256 void lttv_tracefile_context_add_hooks(LttvTracefileContext
*self
,
257 LttvHooks
*before_tracefile
,
259 LttvHooksById
*event_by_id
);
262 void lttv_tracefile_context_remove_hooks(LttvTracefileContext
*self
,
263 LttvHooks
*after_tracefile
,
265 LttvHooksById
*event_by_id
);
268 void lttv_tracefile_context_add_hooks_by_id(LttvTracefileContext
*self
,
270 LttvHooks
*event_by_id
);
272 void lttv_tracefile_context_remove_hooks_by_id(LttvTracefileContext
*self
,
275 typedef struct _LttvTraceHook
{
277 guint16 id
; /* id of the marker associated with this hook */
278 GPtrArray
*fields
; /* struct marker_fields pointers */
282 /* Get the head of marker list correcponding to the given trace hook.
284 struct marker_info
*lttv_trace_hook_get_marker(LttTrace
*t
, LttvTraceHook
*th
);
286 /* Remove the hooks from the array. Does not free the array itself. */
287 void lttv_trace_hook_remove_all(GArray
**th
);
289 /* Search in the trace for the id of the named event type within the named
290 facility. Then, find the three (if non null) named fields. All that
291 information is then used to fill the LttvTraceHook structure. This
292 is useful to find the specific id for an event within a trace, for
293 registering a hook using this structure as event data;
294 it already contains the (up to three) needed fields handles.
295 Returns the modified LttvTraceHook array.
296 Prints warnings if events or markers are not found. returns 1 on error,
298 Adds the hooks to the trace_hooks array.
301 int lttv_trace_find_hook(LttTrace
*t
, GQuark marker_name
,
302 GQuark fields
[], LttvHook h
, gpointer hook_data
, GArray
**trace_hooks
);
304 static inline struct marker_field
*
305 lttv_trace_get_hook_field(LttvTraceHook
*hook
, unsigned int index
)
307 return g_ptr_array_index(hook
->fields
, index
);
311 LttvTracefileContext
*lttv_traceset_context_get_current_tfc(
312 LttvTracesetContext
*self
);
315 LttvTracesetContextPosition
*lttv_traceset_context_position_new(
316 const LttvTracesetContext
*self
);
318 void lttv_traceset_context_position_save(const LttvTracesetContext
*self
,
319 LttvTracesetContextPosition
*pos
);
321 void lttv_traceset_context_position_destroy(LttvTracesetContextPosition
*pos
);
323 void lttv_traceset_context_position_copy(LttvTracesetContextPosition
*dest
,
324 const LttvTracesetContextPosition
*src
);
326 gint
lttv_traceset_context_pos_pos_compare(
327 const LttvTracesetContextPosition
*pos1
,
328 const LttvTracesetContextPosition
*pos2
);
330 gint
lttv_traceset_context_ctx_pos_compare(const LttvTracesetContext
*self
,
331 const LttvTracesetContextPosition
*pos2
);
333 LttTime
lttv_traceset_context_position_get_time(
334 const LttvTracesetContextPosition
*pos
);
336 gint
compare_tracefile(gconstpointer a
, gconstpointer b
);
339 /* Synchronisation helpers : save/restore synchronization between ltt traces and
340 * a traceset context. */
341 void lttv_process_traceset_synchronize_tracefiles(LttvTracesetContext
*tsc
);
343 void lttv_process_traceset_get_sync_data(LttvTracesetContext
*tsc
);
345 /* Seek n events forward and backward (without filtering) : only use these where
346 * necessary : the seek backward is costy. */
348 #define BACKWARD_SEEK_MUL 2 /* Multiplication factor of time_offset between
349 backward seek iterations */
351 static const LttTime seek_back_default_offset
= { 1, 0 };
353 typedef gboolean
check_handler(guint count
, gboolean
*stop_flag
, gpointer data
);
355 guint
lttv_process_traceset_seek_n_forward(LttvTracesetContext
*self
,
357 check_handler
*check
,
363 typedef void (*seek_time_fct
)(LttvTracesetContext
*self
, LttTime start
);
365 /* If first_offset is ltt_time_zero, it will choose a default value */
366 guint
lttv_process_traceset_seek_n_backward(LttvTracesetContext
*self
,
368 LttTime first_offset
,
370 check_handler
*check
,
377 #define FIELD_ARRAY(val...) ((GQuark[]){ val, 0 })
379 #endif // PROCESSTRACE_H