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
,
64 LTT_FACILITY_USER_GENERIC
;
69 LTT_EVENT_SYSCALL_ENTRY
,
70 LTT_EVENT_SYSCALL_EXIT
,
75 LTT_EVENT_SOFT_IRQ_ENTRY
,
76 LTT_EVENT_SOFT_IRQ_EXIT
,
77 LTT_EVENT_SCHEDCHANGE
,
79 LTT_EVENT_KERNEL_THREAD
,
83 LTT_EVENT_ENUM_PROCESS_STATE
,
84 LTT_EVENT_FUNCTION_ENTRY
,
85 LTT_EVENT_FUNCTION_EXIT
,
86 LTT_EVENT_THREAD_BRAND
;
94 LTT_FIELD_SOFT_IRQ_ID
,
110 typedef struct _LttvTracesetState LttvTracesetState
;
111 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
113 typedef struct _LttvTraceState LttvTraceState
;
114 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
116 typedef struct _LttvTracefileState LttvTracefileState
;
117 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
119 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
120 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
122 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
123 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
125 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
126 // Hook wrapper. call_data is a trace context.
127 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
129 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
130 // Hook wrapper. call_data is a trace context.
131 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
133 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
135 /* The LttvProcessState structure defines the current state for each process.
136 A process can make system calls (in some rare cases nested) and receive
137 interrupts/faults. For instance, a process may issue a system call,
138 generate a page fault while reading an argument from user space, and
139 get caught by an interrupt. To represent these nested states, an
140 execution mode stack is maintained. The stack bottom is normal user mode
141 and the top of stack is the current execution mode.
143 The execution mode stack tells about the process status, execution mode and
144 submode (interrupt, system call or IRQ number). All these could be
145 defined as enumerations but may need extensions (e.g. new process state).
146 GQuark are thus used. They are as easy to manipulate as integers but have
147 a string associated, just like enumerations.
149 The execution mode is one of "user mode", "kernel thread", "system call",
150 "interrupt request", "fault". */
152 typedef GQuark LttvExecutionMode
;
154 extern LttvExecutionMode
155 LTTV_STATE_USER_MODE
,
160 LTTV_STATE_MODE_UNKNOWN
;
163 /* The submode number depends on the execution mode. For user mode or kernel
164 thread, which are the normal mode (execution mode stack bottom),
165 it is set to "none". For interrupt requests, faults and system calls,
166 it is set respectively to the interrupt name (e.g. "timer"), fault name
167 (e.g. "page fault"), and system call name (e.g. "select"). */
169 typedef GQuark LttvExecutionSubmode
;
171 extern LttvExecutionSubmode
172 LTTV_STATE_SUBMODE_NONE
,
173 LTTV_STATE_SUBMODE_UNKNOWN
;
175 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
176 where "*" describes the resource waited for (e.g. timer, process,
179 typedef GQuark LttvProcessStatus
;
181 extern LttvProcessStatus
183 LTTV_STATE_UNBRANDED
,
184 LTTV_STATE_WAIT_FORK
,
192 typedef GQuark LttvProcessType
;
194 extern LttvProcessType
195 LTTV_STATE_USER_THREAD
,
196 LTTV_STATE_KERNEL_THREAD
;
198 typedef struct _LttvExecutionState
{
200 LttvExecutionSubmode n
;
203 LttTime cum_cpu_time
;
205 } LttvExecutionState
;
207 typedef struct _LttvProcessState
{
210 LttTime creation_time
;
211 LttTime insertion_time
;
215 GArray
*execution_stack
; /* Array of LttvExecutionState */
216 LttvExecutionState
*state
; /* Top of interrupt stack */
217 /* WARNING : each time the execution_stack size is modified, the state
218 * must be reget : g_array_set_size can have to move the array.
220 guint cpu
; /* CPU where process is scheduled (being either in
221 the active or inactive runqueue)*/
222 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
223 LttvTracefileState
*usertrace
; /* Associated usertrace */
224 /* opened file descriptors, address map?... */
225 GArray
*user_stack
; /* User space function call stack */
226 guint64 current_function
;
227 LttvProcessType type
; /* kernel thread or user space ? */
230 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
231 a PID != 0 will search on any cpu automatically. */
234 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
237 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
241 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
242 guint cpu
, guint pid
, GQuark name
, const LttTime
*timestamp
);
244 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
246 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
247 inherit from the corresponding Context objects defined in processTrace. */
249 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
250 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
251 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
252 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
253 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
254 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
256 struct _LttvTracesetState
{
257 LttvTracesetContext parent
;
260 struct _LttvTracesetStateClass
{
261 LttvTracesetContextClass parent
;
264 GType
lttv_traceset_state_get_type (void);
267 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
268 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
269 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
270 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
271 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
272 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
274 struct _LttvTraceState
{
275 LttvTraceContext parent
;
277 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
279 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
280 pointers to LttvTracefileState objects. */
281 guint nb_event
, save_interval
;
282 /* Block/char devices, locks, memory pages... */
283 GQuark
*eventtype_names
;
284 GQuark
*syscall_names
;
289 GQuark
*soft_irq_names
;
290 LttTime
*max_time_state_recomputed_in_seek
;
292 /* Array of per cpu running process */
293 LttvProcessState
**running_process
;
296 struct _LttvTraceStateClass
{
297 LttvTraceContextClass parent
;
299 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
300 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
301 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
304 GType
lttv_trace_state_get_type (void);
306 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
308 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
310 void lttv_state_state_saved_free(LttvTraceState
*self
,
311 LttvAttribute
*container
);
313 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
314 LttvTracefileState
*tfs
);
316 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
317 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
318 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
319 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
320 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
321 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
323 struct _LttvTracefileState
{
324 LttvTracefileContext parent
;
326 //LttvProcessState *process;
327 GQuark tracefile_name
;
328 guint cpu
; /* Current cpu of the tracefile */
329 // guint saved_position;
332 struct _LttvTracefileStateClass
{
333 LttvTracefileContextClass parent
;
336 GType
lttv_tracefile_state_get_type (void);