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 */
65 LTT_EVENT_SYSCALL_ENTRY
,
66 LTT_EVENT_SYSCALL_EXIT
,
71 LTT_EVENT_SCHEDCHANGE
,
89 extern GQuark LTT_EVENT_SYSCALL_ENTRY
;
91 typedef struct _LttvTracesetState LttvTracesetState
;
92 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
94 typedef struct _LttvTraceState LttvTraceState
;
95 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
97 typedef struct _LttvTracefileState LttvTracefileState
;
98 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
100 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
101 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
103 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
104 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
106 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
107 // Hook wrapper. call_data is a trace context.
108 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
110 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
111 // Hook wrapper. call_data is a trace context.
112 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
114 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
116 /* The LttvProcessState structure defines the current state for each process.
117 A process can make system calls (in some rare cases nested) and receive
118 interrupts/faults. For instance, a process may issue a system call,
119 generate a page fault while reading an argument from user space, and
120 get caught by an interrupt. To represent these nested states, an
121 execution mode stack is maintained. The stack bottom is normal user mode
122 and the top of stack is the current execution mode.
124 The execution mode stack tells about the process status, execution mode and
125 submode (interrupt, system call or IRQ number). All these could be
126 defined as enumerations but may need extensions (e.g. new process state).
127 GQuark are thus used. They are as easy to manipulate as integers but have
128 a string associated, just like enumerations.
130 The execution mode is one of "user mode", "kernel thread", "system call",
131 "interrupt request", "fault". */
133 typedef GQuark LttvExecutionMode
;
135 extern LttvExecutionMode
136 LTTV_STATE_USER_MODE
,
140 LTTV_STATE_MODE_UNKNOWN
;
143 /* The submode number depends on the execution mode. For user mode or kernel
144 thread, which are the normal mode (execution mode stack bottom),
145 it is set to "none". For interrupt requests, faults and system calls,
146 it is set respectively to the interrupt name (e.g. "timer"), fault name
147 (e.g. "page fault"), and system call name (e.g. "select"). */
149 typedef GQuark LttvExecutionSubmode
;
151 extern LttvExecutionSubmode
152 LTTV_STATE_SUBMODE_NONE
,
153 LTTV_STATE_SUBMODE_UNKNOWN
;
155 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
156 where "*" describes the resource waited for (e.g. timer, process,
159 typedef GQuark LttvProcessStatus
;
161 extern LttvProcessStatus
163 LTTV_STATE_WAIT_FORK
,
171 typedef struct _LttvExecutionState
{
173 LttvExecutionSubmode n
;
177 } LttvExecutionState
;
180 typedef struct _LttvProcessState
{
183 LttTime creation_time
;
184 LttTime insertion_time
;
187 GArray
*execution_stack
; /* Array of LttvExecutionState */
188 LttvExecutionState
*state
; /* Top of interrupt stack */
189 GQuark last_cpu
; /* Last CPU where process was scheduled */
190 guint last_cpu_index
; /* index in the trace for cpu tracefile */
191 /* opened file descriptors, address map?... */
195 lttv_state_find_process(LttvTracefileState
*tfs
, guint pid
);
198 lttv_state_find_process_or_create(LttvTracefileState
*tfs
, guint pid
);
201 lttv_state_create_process(LttvTracefileState
*tfs
, LttvProcessState
*parent
,
204 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
206 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
207 inherit from the corresponding Context objects defined in processTrace. */
209 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
210 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
211 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
212 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
213 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
214 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
216 struct _LttvTracesetState
{
217 LttvTracesetContext parent
;
220 struct _LttvTracesetStateClass
{
221 LttvTracesetContextClass parent
;
224 GType
lttv_traceset_state_get_type (void);
227 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
228 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
229 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
230 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
231 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
232 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
234 struct _LttvTraceState
{
235 LttvTraceContext parent
;
237 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
239 guint nb_event
, save_interval
;
240 /* Block/char devices, locks, memory pages... */
241 GQuark
*eventtype_names
;
242 GQuark
*syscall_names
;
245 LttTime
*max_time_state_recomputed_in_seek
;
248 struct _LttvTraceStateClass
{
249 LttvTraceContextClass parent
;
251 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
252 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
253 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
256 GType
lttv_trace_state_get_type (void);
258 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
260 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
262 void lttv_state_state_saved_free(LttvTraceState
*self
,
263 LttvAttribute
*container
);
266 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
267 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
268 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
269 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
270 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
271 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
273 struct _LttvTracefileState
{
274 LttvTracefileContext parent
;
276 LttvProcessState
*process
;
278 // guint saved_position;
281 struct _LttvTracefileStateClass
{
282 LttvTracefileContextClass parent
;
285 GType
lttv_tracefile_state_get_type (void);