tracecontext modified to reflect new strict boundary architecture
[lttv.git] / ltt / branches / poly / lttv / lttv / tracecontext.h
... / ...
CommitLineData
1/* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Michel Dagenais
3 *
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;
7 *
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.
12 *
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,
16 * MA 02111-1307, USA.
17 */
18
19#ifndef PROCESSTRACE_H
20#define PROCESSTRACE_H
21
22#include <lttv/traceset.h>
23#include <lttv/attribute.h>
24#include <lttv/hook.h>
25#include <ltt/ltt.h>
26
27/* This is the generic part of trace processing. All events within a
28 certain time interval are accessed and processing hooks are called for
29 each. The events are examined in monotonically increasing time to more
30 closely follow the traced system behavior.
31
32 Hooks are called at several different places during the processing:
33 before traceset, after traceset, check trace, before trace, after trace,
34 check tracefile, before tracefile, after tracefile,
35 check_event, before_event, before_event_by_id,
36 after_event, after_event_by_id.
37
38 In each case the "check" hooks are called first to determine if further
39 processing of the trace, tracefile or event is wanted. Then, the before
40 hooks and the after hooks are called. The before hooks for a traceset
41 are called before those for the contained traces, which are called before
42 those for the contained tracefiles. The after hooks are called in reverse
43 order. The event hooks are called after all the before_tracefile hooks
44 and before all the after_tracefile hooks.
45
46 The hooks receive two arguments, the hook_data and call_data. The hook_data
47 is specified when the hook is registered and typically links to the
48 object registering the hook (e.g. a graphical events viewer). The call_data
49 must contain all the context related to the call. The traceset hooks receive
50 the LttvTracesetContext provided by the caller. The trace hooks receive
51 the LttvTraceContext from the traces array in the LttvTracesetContext.
52 The tracefile and event hooks receive the LttvTracefileContext from
53 the tracefiles array in the LttvTraceContext. The LttEvent and LttTime
54 fields in the tracefile context are set to the current event and current
55 event time before calling the event hooks. No other context field is
56 modified.
57
58 The contexts in the traces and tracefiles arrays must be allocated by
59 the caller, either before the call or during the before hooks of the
60 enclosing traceset or trace. The order in the traces array must
61 correspond to the lttv_traceset_get function. The order in the tracefiles
62 arrays must correspond to the ltt_trace_control_tracefile_get and
63 ltt_trace_per_cpu_tracefile_get functions. The traceset, trace and
64 tracefile contexts may be subtyped as needed. Indeed, both the contexts
65 and the hooks are defined by the caller. */
66
67
68typedef struct _LttvTracesetContext LttvTracesetContext;
69typedef struct _LttvTracesetContextClass LttvTracesetContextClass;
70
71typedef struct _LttvTraceContext LttvTraceContext;
72typedef struct _LttvTraceContextClass LttvTraceContextClass;
73
74typedef struct _LttvTracefileContext LttvTracefileContext;
75typedef struct _LttvTracefileContextClass LttvTracefileContextClass;
76
77typedef struct _LttvTracesetContextPosition LttvTracesetContextPosition;
78typedef struct _LttvTraceContextPosition LttvTraceContextPosition;
79
80#define LTTV_TRACESET_CONTEXT_TYPE (lttv_traceset_context_get_type ())
81#define LTTV_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContext))
82#define LTTV_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
83#define LTTV_IS_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_CONTEXT_TYPE))
84#define LTTV_IS_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_CONTEXT_TYPE))
85#define LTTV_TRACESET_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
86
87struct _LttvTracesetContext {
88 GObject parent;
89
90 LttvTraceset *ts;
91 LttvTraceContext **traces;
92 LttvAttribute *a;
93 LttvAttribute *ts_a;
94 TimeInterval time_span;
95 GTree *pqueue;
96 LttEvent *e; /* Last event read by lttv_process_traceset_middle */
97};
98
99struct _LttvTracesetContextClass {
100 GObjectClass parent;
101
102 void (*init) (LttvTracesetContext *self, LttvTraceset *ts);
103 void (*fini) (LttvTracesetContext *self);
104 LttvTracesetContext* (*new_traceset_context) (LttvTracesetContext *self);
105 LttvTraceContext* (*new_trace_context) (LttvTracesetContext *self);
106 LttvTracefileContext* (*new_tracefile_context) (LttvTracesetContext *self);
107};
108
109GType lttv_traceset_context_get_type (void);
110
111void lttv_context_init(LttvTracesetContext *self, LttvTraceset *ts);
112
113void lttv_context_fini(LttvTracesetContext *self);
114
115LttvTracesetContext *
116lttv_context_new_traceset_context(LttvTracesetContext *self);
117
118LttvTraceContext *
119lttv_context_new_trace_context(LttvTracesetContext *self);
120
121LttvTracefileContext *
122lttv_context_new_tracefile_context(LttvTracesetContext *self);
123
124
125#define LTTV_TRACE_CONTEXT_TYPE (lttv_trace_context_get_type ())
126#define LTTV_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContext))
127#define LTTV_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
128#define LTTV_IS_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_CONTEXT_TYPE))
129#define LTTV_IS_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_CONTEXT_TYPE))
130#define LTTV_TRACE_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
131
132struct _LttvTraceContext {
133 GObject parent;
134
135 LttvTracesetContext *ts_context;
136 guint index; /* in ts_context->traces */
137 LttTrace *t;
138 LttvTrace *vt;
139 LttvTracefileContext **tracefiles;
140 LttvAttribute *a;
141 LttvAttribute *t_a;
142};
143
144struct _LttvTraceContextClass {
145 GObjectClass parent;
146};
147
148GType lttv_trace_context_get_type (void);
149
150#define LTTV_TRACEFILE_CONTEXT_TYPE (lttv_tracefile_context_get_type ())
151#define LTTV_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContext))
152#define LTTV_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
153#define LTTV_IS_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_CONTEXT_TYPE))
154#define LTTV_IS_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE))
155#define LTTV_TRACEFILE_CONTEXT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
156
157struct _LttvTracefileContext {
158 GObject parent;
159
160 LttvTraceContext *t_context;
161 gboolean control;
162 guint index; /* in ts_context->tracefiles */
163 LttTracefile *tf;
164 LttEvent *e;
165 LttvHooks *event;
166 LttvHooksById *event_by_id;
167 LttTime timestamp;
168 LttvAttribute *a;
169};
170
171struct _LttvTracefileContextClass {
172 GObjectClass parent;
173};
174
175GType lttv_tracefile_context_get_type (void);
176
177/* Run through the events in a traceset in sorted order calling all the
178 hooks appropriately. It starts at the current time and runs until end or
179 nb_events are processed. */
180
181void lttv_process_traceset(LttvTracesetContext *self, LttTime end,
182 unsigned nb_events);
183
184/* Process traceset can also be done in smaller pieces calling begin,
185 * then seek and middle repeatedly, and end. The middle function return the
186 * number of events processed. It will be smaller than nb_events if the end time
187 * or end position is reached. */
188
189
190void lttv_process_traceset_begin(LttvTracesetContext *self,
191 LttvHooks *before_traceset,
192 LttvHooks *before_trace,
193 LttvHooks *before_tracefile,
194 LttvHooks *event,
195 LttvHooksById *event_by_id);
196
197
198guint lttv_process_traceset_middle(LttvTracesetContext *self,
199 LttTime end,
200 unsigned nb_events,
201 const LttvTracesetContextPosition *end_position);
202
203void lttv_process_traceset_end(LttvTracesetContext *self,
204 LttvHooks *after_traceset,
205 LttvHooks *after_trace,
206 LttvHooks *after_tracefile,
207 LttvHooks *event,
208 LttvHooksById *event_by_id);
209
210
211void lttv_process_traceset_seek_time(LttvTracesetContext *self, LttTime start);
212
213gboolean lttv_process_traceset_seek_position(LttvTracesetContext *self,
214 const LttvTracesetContextPosition *pos);
215
216void lttv_process_trace_seek_time(LttvTraceContext *self, LttTime start);
217
218void lttv_traceset_context_add_hooks(LttvTracesetContext *self,
219 LttvHooks *before_traceset,
220 LttvHooks *before_trace,
221 LttvHooks *before_tracefile,
222 LttvHooks *event,
223 LttvHooksById *event_by_id);
224
225void lttv_traceset_context_remove_hooks(LttvTracesetContext *self,
226 LttvHooks *after_traceset,
227 LttvHooks *after_trace,
228 LttvHooks *after_tracefile,
229 LttvHooks *event,
230 LttvHooksById *event_by_id);
231
232void lttv_trace_context_add_hooks(LttvTraceContext *self,
233 LttvHooks *before_trace,
234 LttvHooks *before_tracefile,
235 LttvHooks *event,
236 LttvHooksById *event_by_id);
237
238void lttv_trace_context_remove_hooks(LttvTraceContext *self,
239 LttvHooks *after_trace,
240 LttvHooks *after_tracefile,
241 LttvHooks *event,
242 LttvHooksById *event_by_id);
243
244void lttv_tracefile_context_add_hooks(LttvTracefileContext *self,
245 LttvHooks *before_tracefile,
246 LttvHooks *event,
247 LttvHooksById *event_by_id);
248
249
250void lttv_tracefile_context_remove_hooks(LttvTracefileContext *self,
251 LttvHooks *after_tracefile,
252 LttvHooks *event,
253 LttvHooksById *event_by_id);
254
255
256void lttv_tracefile_context_add_hooks_by_id(LttvTracefileContext *self,
257 unsigned i,
258 LttvHooks *event_by_id);
259
260void lttv_tracefile_context_remove_hooks_by_id(LttvTracefileContext *self,
261 unsigned i);
262
263typedef struct _LttvTraceHook {
264 LttvHook h;
265 guint id;
266 LttField *f1;
267 LttField *f2;
268 LttField *f3;
269} LttvTraceHook;
270
271
272/* Search in the trace for the id of the named event type within the named
273 facility. Then, find the three (if non null) named fields. All that
274 information is then used to fill the LttvTraceHook structure. This
275 is useful to find the specific id for an event within a trace, for
276 registering a hook using this structure as event data;
277 it already contains the (up to three) needed fields handles. */
278
279void lttv_trace_find_hook(LttTrace *t, char *facility, char *event_type,
280 char *field1, char *field2, char *field3, LttvHook h, LttvTraceHook *th);
281
282
283void lttv_traceset_context_position_save(const LttvTracesetContext *self,
284 LttvTracesetContextPosition *pos);
285
286void lttv_traceset_context_position_destroy(LttvTracesetContextPosition *pos);
287
288gint lttv_traceset_context_pos_pos_compare(
289 const LttvTracesetContextPosition *pos1,
290 const LttvTracesetContextPosition *pos2);
291
292gint lttv_traceset_context_ctx_pos_compare(const LttvTracesetContext *self,
293 const LttvTracesetContextPosition *pos);
294
295gint lttv_traceset_context_pos_pos_compare(const LttvTracesetContextPosition *a,
296 const LttvTracesetContextPosition *b);
297#endif // PROCESSTRACE_H
This page took 0.023376 seconds and 4 git commands to generate.