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 */
60 LTT_FACILITY_KERNEL_ARCH
,
63 LTT_FACILITY_STATEDUMP
;
68 LTT_EVENT_SYSCALL_ENTRY
,
69 LTT_EVENT_SYSCALL_EXIT
,
74 LTT_EVENT_SOFT_IRQ_ENTRY
,
75 LTT_EVENT_SOFT_IRQ_EXIT
,
76 LTT_EVENT_SCHEDCHANGE
,
81 LTT_EVENT_ENUM_PROCESS_STATE
;
89 LTT_FIELD_SOFT_IRQ_ID
,
102 typedef struct _LttvTracesetState LttvTracesetState
;
103 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
105 typedef struct _LttvTraceState LttvTraceState
;
106 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
108 typedef struct _LttvTracefileState LttvTracefileState
;
109 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
111 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
112 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
114 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
115 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
117 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
118 // Hook wrapper. call_data is a trace context.
119 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
121 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
122 // Hook wrapper. call_data is a trace context.
123 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
125 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
127 /* The LttvProcessState structure defines the current state for each process.
128 A process can make system calls (in some rare cases nested) and receive
129 interrupts/faults. For instance, a process may issue a system call,
130 generate a page fault while reading an argument from user space, and
131 get caught by an interrupt. To represent these nested states, an
132 execution mode stack is maintained. The stack bottom is normal user mode
133 and the top of stack is the current execution mode.
135 The execution mode stack tells about the process status, execution mode and
136 submode (interrupt, system call or IRQ number). All these could be
137 defined as enumerations but may need extensions (e.g. new process state).
138 GQuark are thus used. They are as easy to manipulate as integers but have
139 a string associated, just like enumerations.
141 The execution mode is one of "user mode", "kernel thread", "system call",
142 "interrupt request", "fault". */
144 typedef GQuark LttvExecutionMode
;
146 extern LttvExecutionMode
147 LTTV_STATE_USER_MODE
,
152 LTTV_STATE_MODE_UNKNOWN
;
155 /* The submode number depends on the execution mode. For user mode or kernel
156 thread, which are the normal mode (execution mode stack bottom),
157 it is set to "none". For interrupt requests, faults and system calls,
158 it is set respectively to the interrupt name (e.g. "timer"), fault name
159 (e.g. "page fault"), and system call name (e.g. "select"). */
161 typedef GQuark LttvExecutionSubmode
;
163 extern LttvExecutionSubmode
164 LTTV_STATE_SUBMODE_NONE
,
165 LTTV_STATE_SUBMODE_UNKNOWN
;
167 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
168 where "*" describes the resource waited for (e.g. timer, process,
171 typedef GQuark LttvProcessStatus
;
173 extern LttvProcessStatus
175 LTTV_STATE_WAIT_FORK
,
184 typedef struct _LttvExecutionState
{
186 LttvExecutionSubmode n
;
190 } LttvExecutionState
;
193 typedef struct _LttvProcessState
{
196 LttTime creation_time
;
197 LttTime insertion_time
;
200 GArray
*execution_stack
; /* Array of LttvExecutionState */
201 LttvExecutionState
*state
; /* Top of interrupt stack */
202 /* WARNING : each time the execution_stack size is modified, the state
203 * must be reget : g_array_set_size can have to move the array.
205 guint cpu
; /* CPU where process is scheduled (being either in
206 the active or inactive runqueue)*/
207 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
208 /* opened file descriptors, address map?... */
211 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
212 a PID != 0 will search on any cpu automatically. */
215 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
218 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
222 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
223 guint cpu
, guint pid
, GQuark name
, const LttTime
*timestamp
);
225 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
227 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
228 inherit from the corresponding Context objects defined in processTrace. */
230 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
231 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
232 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
233 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
234 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
235 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
237 struct _LttvTracesetState
{
238 LttvTracesetContext parent
;
241 struct _LttvTracesetStateClass
{
242 LttvTracesetContextClass parent
;
245 GType
lttv_traceset_state_get_type (void);
248 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
249 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
250 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
251 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
252 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
253 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
255 struct _LttvTraceState
{
256 LttvTraceContext parent
;
258 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
260 guint nb_event
, save_interval
;
261 /* Block/char devices, locks, memory pages... */
262 GQuark
*eventtype_names
;
263 GQuark
*syscall_names
;
266 GQuark
*soft_irq_names
;
267 LttTime
*max_time_state_recomputed_in_seek
;
269 /* Array of per cpu running process */
270 LttvProcessState
**running_process
;
274 struct _LttvTraceStateClass
{
275 LttvTraceContextClass parent
;
277 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
278 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
279 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
282 GType
lttv_trace_state_get_type (void);
284 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
286 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
288 void lttv_state_state_saved_free(LttvTraceState
*self
,
289 LttvAttribute
*container
);
292 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
293 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
294 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
295 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
296 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
297 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
299 struct _LttvTracefileState
{
300 LttvTracefileContext parent
;
302 //LttvProcessState *process;
303 GQuark tracefile_name
;
304 // guint saved_position;
307 struct _LttvTracefileStateClass
{
308 LttvTracefileContextClass parent
;
311 GType
lttv_tracefile_state_get_type (void);