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,
23 #include <lttv/tracecontext.h>
26 /* The operating system state, kept during the trace analysis,
27 contains a subset of the real operating system state,
28 sufficient for the analysis, and possibly organized quite differently.
30 The state information is added to LttvTracesetContext, LttvTraceContext
31 and LttvTracefileContext objects, used by process_traceset, through
32 subtyping. The context objects already reflect the multiple tracefiles
33 (one per cpu) per trace and multiple traces per trace set. The state
34 objects defined here simply add fields to the relevant context objects.
36 There is no traceset specific state yet. It may eventually contains such
37 things as clock differences over time.
39 The trace state currently consists in a process table.
41 The tracefile level state relates to the associated cpu. It contains the
42 position of the current event in the tracefile (since the state depends on
43 which events have been processed) and a pointer to the current process,
44 in the process table, being run on that cpu.
46 For each process in the process table, various informations such as exec
47 file name, pid, ppid and creation time are stored. Each process state also
48 contains an execution mode stack (e.g. irq within system call, called
51 /* Priority of state hooks */
52 #define LTTV_PRIO_STATE 25
54 #define LTTV_STATE_SAVE_INTERVAL 50000
56 /* Facilities Quarks */
66 LTT_EVENT_SYSCALL_ENTRY
,
67 LTT_EVENT_SYSCALL_EXIT
,
72 LTT_EVENT_SCHEDCHANGE
,
92 extern GQuark LTT_EVENT_SYSCALL_ENTRY
;
94 typedef struct _LttvTracesetState LttvTracesetState
;
95 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
97 typedef struct _LttvTraceState LttvTraceState
;
98 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
100 typedef struct _LttvTracefileState LttvTracefileState
;
101 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
103 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
104 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
106 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
107 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
109 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
110 // Hook wrapper. call_data is a trace context.
111 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
113 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
114 // Hook wrapper. call_data is a trace context.
115 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
117 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
119 /* The LttvProcessState structure defines the current state for each process.
120 A process can make system calls (in some rare cases nested) and receive
121 interrupts/faults. For instance, a process may issue a system call,
122 generate a page fault while reading an argument from user space, and
123 get caught by an interrupt. To represent these nested states, an
124 execution mode stack is maintained. The stack bottom is normal user mode
125 and the top of stack is the current execution mode.
127 The execution mode stack tells about the process status, execution mode and
128 submode (interrupt, system call or IRQ number). All these could be
129 defined as enumerations but may need extensions (e.g. new process state).
130 GQuark are thus used. They are as easy to manipulate as integers but have
131 a string associated, just like enumerations.
133 The execution mode is one of "user mode", "kernel thread", "system call",
134 "interrupt request", "fault". */
136 typedef GQuark LttvExecutionMode
;
138 extern LttvExecutionMode
139 LTTV_STATE_USER_MODE
,
143 LTTV_STATE_MODE_UNKNOWN
;
146 /* The submode number depends on the execution mode. For user mode or kernel
147 thread, which are the normal mode (execution mode stack bottom),
148 it is set to "none". For interrupt requests, faults and system calls,
149 it is set respectively to the interrupt name (e.g. "timer"), fault name
150 (e.g. "page fault"), and system call name (e.g. "select"). */
152 typedef GQuark LttvExecutionSubmode
;
154 extern LttvExecutionSubmode
155 LTTV_STATE_SUBMODE_NONE
,
156 LTTV_STATE_SUBMODE_UNKNOWN
;
158 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
159 where "*" describes the resource waited for (e.g. timer, process,
162 typedef GQuark LttvProcessStatus
;
164 extern LttvProcessStatus
166 LTTV_STATE_WAIT_FORK
,
174 typedef struct _LttvExecutionState
{
176 LttvExecutionSubmode n
;
180 } LttvExecutionState
;
183 typedef struct _LttvProcessState
{
186 LttTime creation_time
;
187 LttTime insertion_time
;
190 GArray
*execution_stack
; /* Array of LttvExecutionState */
191 LttvExecutionState
*state
; /* Top of interrupt stack */
192 /* WARNING : each time the execution_stack size is modified, the state
193 * must be reget : g_array_set_size can have to move the array.
195 guint cpu
; /* CPU where process is scheduled (being either in
196 the active or inactive runqueue)*/
197 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
198 /* opened file descriptors, address map?... */
201 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
202 a PID != 0 will search on any cpu automatically. */
205 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
208 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
212 lttv_state_create_process(LttvTraceState
*ts
, LttvProcessState
*parent
,
213 guint cpu
, guint pid
, const LttTime
*timestamp
);
215 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
217 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
218 inherit from the corresponding Context objects defined in processTrace. */
220 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
221 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
222 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
223 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
224 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
225 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
227 struct _LttvTracesetState
{
228 LttvTracesetContext parent
;
231 struct _LttvTracesetStateClass
{
232 LttvTracesetContextClass parent
;
235 GType
lttv_traceset_state_get_type (void);
238 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
239 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
240 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
241 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
242 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
243 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
245 struct _LttvTraceState
{
246 LttvTraceContext parent
;
248 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
250 guint nb_event
, save_interval
;
251 /* Block/char devices, locks, memory pages... */
252 GQuark
*eventtype_names
;
253 GQuark
*syscall_names
;
256 LttTime
*max_time_state_recomputed_in_seek
;
258 /* Array of per cpu running process */
259 LttvProcessState
**running_process
;
263 struct _LttvTraceStateClass
{
264 LttvTraceContextClass parent
;
266 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
267 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
268 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
271 GType
lttv_trace_state_get_type (void);
273 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
275 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
277 void lttv_state_state_saved_free(LttvTraceState
*self
,
278 LttvAttribute
*container
);
281 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
282 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
283 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
284 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
285 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
286 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
288 struct _LttvTracefileState
{
289 LttvTracefileContext parent
;
291 //LttvProcessState *process;
292 GQuark tracefile_name
;
293 // guint saved_position;
296 struct _LttvTracefileStateClass
{
297 LttvTracefileContextClass parent
;
300 GType
lttv_tracefile_state_get_type (void);