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_USER_GENERIC
;
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_SCHED_SCHEDULE
,
77 LTT_EVENT_PROCESS_FORK
,
78 LTT_EVENT_KTHREAD_CREATE
,
79 LTT_EVENT_PROCESS_EXIT
,
80 LTT_EVENT_PROCESS_FREE
,
82 LTT_EVENT_PROCESS_STATE
,
83 LTT_EVENT_STATEDUMP_END
,
84 LTT_EVENT_FUNCTION_ENTRY
,
85 LTT_EVENT_FUNCTION_EXIT
,
86 LTT_EVENT_THREAD_BRAND
;
94 LTT_FIELD_SOFT_IRQ_ID
,
111 typedef struct _LttvTracesetState LttvTracesetState
;
112 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
114 typedef struct _LttvTraceState LttvTraceState
;
115 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
117 typedef struct _LttvTracefileState LttvTracefileState
;
118 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
120 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
121 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
123 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
124 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
126 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
127 // Hook wrapper. call_data is a trace context.
128 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
130 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
131 // Hook wrapper. call_data is a trace context.
132 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
134 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
136 /* The LttvProcessState structure defines the current state for each process.
137 A process can make system calls (in some rare cases nested) and receive
138 interrupts/faults. For instance, a process may issue a system call,
139 generate a page fault while reading an argument from user space, and
140 get caught by an interrupt. To represent these nested states, an
141 execution mode stack is maintained. The stack bottom is normal user mode
142 and the top of stack is the current execution mode.
144 The execution mode stack tells about the process status, execution mode and
145 submode (interrupt, system call or IRQ number). All these could be
146 defined as enumerations but may need extensions (e.g. new process state).
147 GQuark are thus used. They are as easy to manipulate as integers but have
148 a string associated, just like enumerations.
150 The execution mode is one of "user mode", "kernel thread", "system call",
151 "interrupt request", "fault". */
153 typedef GQuark LttvExecutionMode
;
155 extern LttvExecutionMode
156 LTTV_STATE_USER_MODE
,
161 LTTV_STATE_MODE_UNKNOWN
;
164 /* The submode number depends on the execution mode. For user mode or kernel
165 thread, which are the normal mode (execution mode stack bottom),
166 it is set to "none". For interrupt requests, faults and system calls,
167 it is set respectively to the interrupt name (e.g. "timer"), fault name
168 (e.g. "page fault"), and system call name (e.g. "select"). */
170 typedef GQuark LttvExecutionSubmode
;
172 extern LttvExecutionSubmode
173 LTTV_STATE_SUBMODE_NONE
,
174 LTTV_STATE_SUBMODE_UNKNOWN
;
176 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
177 where "*" describes the resource waited for (e.g. timer, process,
180 typedef GQuark LttvProcessStatus
;
182 extern LttvProcessStatus
184 LTTV_STATE_WAIT_FORK
,
193 LTTV_STATE_UNBRANDED
;
195 typedef GQuark LttvProcessType
;
197 extern LttvProcessType
198 LTTV_STATE_USER_THREAD
,
199 LTTV_STATE_KERNEL_THREAD
;
201 typedef GQuark LttvCPUMode
;
207 typedef struct _LttvExecutionState
{
209 LttvExecutionSubmode n
;
212 LttTime cum_cpu_time
;
214 } LttvExecutionState
;
216 typedef struct _LttvProcessState
{
220 LttTime creation_time
;
221 LttTime insertion_time
;
225 GArray
*execution_stack
; /* Array of LttvExecutionState */
226 LttvExecutionState
*state
; /* Top of interrupt stack */
227 /* WARNING : each time the execution_stack size is modified, the state
228 * must be reget : g_array_set_size can have to move the array.
230 guint cpu
; /* CPU where process is scheduled (being either in
231 the active or inactive runqueue)*/
232 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
233 LttvTracefileState
*usertrace
; /* Associated usertrace */
234 /* opened file descriptors, address map?... */
235 GArray
*user_stack
; /* User space function call stack */
236 guint64 current_function
;
237 LttvProcessType type
; /* kernel thread or user space ? */
238 guint target_pid
; /* target PID of the current event. */
241 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
242 a PID != 0 will search on any cpu automatically. */
245 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
248 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
249 const LttTime
*timestamp
);
252 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
253 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
255 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
256 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
258 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
259 inherit from the corresponding Context objects defined in processTrace. */
261 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
262 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
263 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
264 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
265 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
266 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
268 struct _LttvTracesetState
{
269 LttvTracesetContext parent
;
272 struct _LttvTracesetStateClass
{
273 LttvTracesetContextClass parent
;
276 GType
lttv_traceset_state_get_type (void);
279 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
280 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
281 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
282 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
283 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
284 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
286 typedef struct _LttvCPUState
{
287 LttvCPUMode previous_state
;
288 LttvCPUMode present_state
;
291 struct _LttvTraceState
{
292 LttvTraceContext parent
;
294 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
296 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
297 pointers to LttvTracefileState objects. */
298 guint nb_event
, save_interval
;
299 /* Block/char devices, locks, memory pages... */
300 GQuark
*eventtype_names
;
301 GQuark
*syscall_names
;
308 GQuark
*soft_irq_names
;
309 LttTime
*max_time_state_recomputed_in_seek
;
311 /* Array of per cpu running process */
312 LttvProcessState
**running_process
;
313 gboolean has_precomputed_states
;
314 LttvCPUState
*cpu_states
; /* state of each cpu */
317 struct _LttvTraceStateClass
{
318 LttvTraceContextClass parent
;
320 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
321 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
322 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
325 GType
lttv_trace_state_get_type (void);
327 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
329 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
331 void lttv_state_state_saved_free(LttvTraceState
*self
,
332 LttvAttribute
*container
);
334 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
335 LttvTracefileState
*tfs
);
337 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
338 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
339 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
340 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
341 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
342 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
344 struct _LttvTracefileState
{
345 LttvTracefileContext parent
;
347 GQuark tracefile_name
;
348 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
349 LttvCPUState
*cpu_state
; /* cpu resource state */
352 struct _LttvTracefileStateClass
{
353 LttvTracefileContextClass parent
;
356 GType
lttv_tracefile_state_get_type (void);
358 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
360 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
361 guint cpu
= tfs
->cpu
;
362 LttvProcessState
*process
= ts
->running_process
[cpu
];
364 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
365 else return process
->pid
;
369 #define HDR_PROCESS 0
371 #define HDR_USER_STACK 2
372 #define HDR_USERTRACE 3
373 #define HDR_PROCESS_STATE 4
375 #define HDR_TRACEFILE 6
376 #define HDR_TRACESET 7