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
,
67 LTT_EVENT_SYSCALL_ENTRY
,
68 LTT_EVENT_SYSCALL_EXIT
,
73 LTT_EVENT_SOFT_IRQ_ENTRY
,
74 LTT_EVENT_SOFT_IRQ_EXIT
,
75 LTT_EVENT_SCHEDCHANGE
,
87 LTT_FIELD_SOFT_IRQ_ID
,
96 typedef struct _LttvTracesetState LttvTracesetState
;
97 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
99 typedef struct _LttvTraceState LttvTraceState
;
100 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
102 typedef struct _LttvTracefileState LttvTracefileState
;
103 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
105 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
106 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
108 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
109 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
111 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
112 // Hook wrapper. call_data is a trace context.
113 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
115 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
116 // Hook wrapper. call_data is a trace context.
117 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
119 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
121 /* The LttvProcessState structure defines the current state for each process.
122 A process can make system calls (in some rare cases nested) and receive
123 interrupts/faults. For instance, a process may issue a system call,
124 generate a page fault while reading an argument from user space, and
125 get caught by an interrupt. To represent these nested states, an
126 execution mode stack is maintained. The stack bottom is normal user mode
127 and the top of stack is the current execution mode.
129 The execution mode stack tells about the process status, execution mode and
130 submode (interrupt, system call or IRQ number). All these could be
131 defined as enumerations but may need extensions (e.g. new process state).
132 GQuark are thus used. They are as easy to manipulate as integers but have
133 a string associated, just like enumerations.
135 The execution mode is one of "user mode", "kernel thread", "system call",
136 "interrupt request", "fault". */
138 typedef GQuark LttvExecutionMode
;
140 extern LttvExecutionMode
141 LTTV_STATE_USER_MODE
,
146 LTTV_STATE_MODE_UNKNOWN
;
149 /* The submode number depends on the execution mode. For user mode or kernel
150 thread, which are the normal mode (execution mode stack bottom),
151 it is set to "none". For interrupt requests, faults and system calls,
152 it is set respectively to the interrupt name (e.g. "timer"), fault name
153 (e.g. "page fault"), and system call name (e.g. "select"). */
155 typedef GQuark LttvExecutionSubmode
;
157 extern LttvExecutionSubmode
158 LTTV_STATE_SUBMODE_NONE
,
159 LTTV_STATE_SUBMODE_UNKNOWN
;
161 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
162 where "*" describes the resource waited for (e.g. timer, process,
165 typedef GQuark LttvProcessStatus
;
167 extern LttvProcessStatus
169 LTTV_STATE_WAIT_FORK
,
178 typedef struct _LttvExecutionState
{
180 LttvExecutionSubmode n
;
184 } LttvExecutionState
;
187 typedef struct _LttvProcessState
{
190 LttTime creation_time
;
191 LttTime insertion_time
;
194 GArray
*execution_stack
; /* Array of LttvExecutionState */
195 LttvExecutionState
*state
; /* Top of interrupt stack */
196 /* WARNING : each time the execution_stack size is modified, the state
197 * must be reget : g_array_set_size can have to move the array.
199 guint cpu
; /* CPU where process is scheduled (being either in
200 the active or inactive runqueue)*/
201 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
202 /* opened file descriptors, address map?... */
205 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
206 a PID != 0 will search on any cpu automatically. */
209 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
212 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
216 lttv_state_create_process(LttvTraceState
*ts
, LttvProcessState
*parent
,
217 guint cpu
, guint pid
, const LttTime
*timestamp
);
219 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
221 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
222 inherit from the corresponding Context objects defined in processTrace. */
224 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
225 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
226 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
227 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
228 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
229 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
231 struct _LttvTracesetState
{
232 LttvTracesetContext parent
;
235 struct _LttvTracesetStateClass
{
236 LttvTracesetContextClass parent
;
239 GType
lttv_traceset_state_get_type (void);
242 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
243 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
244 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
245 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
246 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
247 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
249 struct _LttvTraceState
{
250 LttvTraceContext parent
;
252 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
254 guint nb_event
, save_interval
;
255 /* Block/char devices, locks, memory pages... */
256 GQuark
*eventtype_names
;
257 GQuark
*syscall_names
;
260 GQuark
*soft_irq_names
;
261 LttTime
*max_time_state_recomputed_in_seek
;
263 /* Array of per cpu running process */
264 LttvProcessState
**running_process
;
268 struct _LttvTraceStateClass
{
269 LttvTraceContextClass parent
;
271 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
272 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
273 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
276 GType
lttv_trace_state_get_type (void);
278 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
280 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
282 void lttv_state_state_saved_free(LttvTraceState
*self
,
283 LttvAttribute
*container
);
286 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
287 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
288 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
289 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
290 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
291 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
293 struct _LttvTracefileState
{
294 LttvTracefileContext parent
;
296 //LttvProcessState *process;
297 GQuark tracefile_name
;
298 // guint saved_position;
301 struct _LttvTracefileStateClass
{
302 LttvTracefileContextClass parent
;
305 GType
lttv_tracefile_state_get_type (void);