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
,
65 LTT_FACILITY_STATEDUMP
;
70 LTT_EVENT_SYSCALL_ENTRY
,
71 LTT_EVENT_SYSCALL_EXIT
,
76 LTT_EVENT_SOFT_IRQ_RAISE
,
77 LTT_EVENT_SOFT_IRQ_ENTRY
,
78 LTT_EVENT_SOFT_IRQ_EXIT
,
79 LTT_EVENT_SCHED_SCHEDULE
,
80 LTT_EVENT_PROCESS_FORK
,
81 LTT_EVENT_KTHREAD_CREATE
,
82 LTT_EVENT_PROCESS_EXIT
,
83 LTT_EVENT_PROCESS_FREE
,
85 LTT_EVENT_PROCESS_STATE
,
86 LTT_EVENT_STATEDUMP_END
,
87 LTT_EVENT_FUNCTION_ENTRY
,
88 LTT_EVENT_FUNCTION_EXIT
,
89 LTT_EVENT_THREAD_BRAND
,
90 LTT_EVENT_REQUEST_ISSUE
,
91 LTT_EVENT_REQUEST_COMPLETE
,
92 LTT_EVENT_LIST_INTERRUPT
,
93 LTT_EVENT_SYS_CALL_TABLE
,
94 LTT_EVENT_SOFTIRQ_VEC
;
102 LTT_FIELD_SOFT_IRQ_ID
,
105 LTT_FIELD_PREV_STATE
,
106 LTT_FIELD_PARENT_PID
,
126 typedef struct _LttvTracesetState LttvTracesetState
;
127 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
129 typedef struct _LttvTraceState LttvTraceState
;
130 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
132 typedef struct _LttvTracefileState LttvTracefileState
;
133 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
135 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
136 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
138 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
139 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
141 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
142 // Hook wrapper. call_data is a trace context.
143 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
145 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
146 // Hook wrapper. call_data is a trace context.
147 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
149 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
151 /* The LttvProcessState structure defines the current state for each process.
152 A process can make system calls (in some rare cases nested) and receive
153 interrupts/faults. For instance, a process may issue a system call,
154 generate a page fault while reading an argument from user space, and
155 get caught by an interrupt. To represent these nested states, an
156 execution mode stack is maintained. The stack bottom is normal user mode
157 and the top of stack is the current execution mode.
159 The execution mode stack tells about the process status, execution mode and
160 submode (interrupt, system call or IRQ number). All these could be
161 defined as enumerations but may need extensions (e.g. new process state).
162 GQuark are thus used. They are as easy to manipulate as integers but have
163 a string associated, just like enumerations.
165 The execution mode is one of "user mode", "kernel thread", "system call",
166 "interrupt request", "fault". */
168 typedef GQuark LttvExecutionMode
;
170 extern LttvExecutionMode
171 LTTV_STATE_USER_MODE
,
176 LTTV_STATE_MODE_UNKNOWN
;
179 /* The submode number depends on the execution mode. For user mode or kernel
180 thread, which are the normal mode (execution mode stack bottom),
181 it is set to "none". For interrupt requests, faults and system calls,
182 it is set respectively to the interrupt name (e.g. "timer"), fault name
183 (e.g. "page fault"), and system call name (e.g. "select"). */
185 typedef GQuark LttvExecutionSubmode
;
187 extern LttvExecutionSubmode
188 LTTV_STATE_SUBMODE_NONE
,
189 LTTV_STATE_SUBMODE_UNKNOWN
;
191 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
192 where "*" describes the resource waited for (e.g. timer, process,
195 typedef GQuark LttvProcessStatus
;
197 extern LttvProcessStatus
199 LTTV_STATE_WAIT_FORK
,
208 LTTV_STATE_UNBRANDED
;
210 typedef GQuark LttvProcessType
;
212 extern LttvProcessType
213 LTTV_STATE_USER_THREAD
,
214 LTTV_STATE_KERNEL_THREAD
;
216 typedef GQuark LttvCPUMode
;
225 typedef GQuark LttvIRQMode
;
231 typedef GQuark LttvBdevMode
;
235 LTTV_BDEV_BUSY_READING
,
236 LTTV_BDEV_BUSY_WRITING
;
238 typedef struct _LttvExecutionState
{
240 LttvExecutionSubmode n
;
243 LttTime cum_cpu_time
;
245 } LttvExecutionState
;
247 typedef struct _LttvProcessState
{
251 LttTime creation_time
;
252 LttTime insertion_time
;
256 GArray
*execution_stack
; /* Array of LttvExecutionState */
257 LttvExecutionState
*state
; /* Top of interrupt stack */
258 /* WARNING : each time the execution_stack size is modified, the state
259 * must be reget : g_array_set_size can have to move the array.
261 guint cpu
; /* CPU where process is scheduled (being either in
262 the active or inactive runqueue)*/
263 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
264 LttvTracefileState
*usertrace
; /* Associated usertrace */
265 /* opened file descriptors, address map?... */
266 GArray
*user_stack
; /* User space function call stack */
267 guint64 current_function
;
268 LttvProcessType type
; /* kernel thread or user space ? */
269 guint target_pid
; /* target PID of the current event. */
270 guint free_events
; /* 0 : none, 1 : free or exit dead, 2 : should delete */
273 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
274 a PID != 0 will search on any cpu automatically. */
277 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
280 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
281 const LttTime
*timestamp
);
284 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
285 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
287 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
288 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
290 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
291 inherit from the corresponding Context objects defined in processTrace. */
293 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
294 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
295 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
296 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
297 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
298 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
300 struct _LttvTracesetState
{
301 LttvTracesetContext parent
;
304 struct _LttvTracesetStateClass
{
305 LttvTracesetContextClass parent
;
308 GType
lttv_traceset_state_get_type (void);
311 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
312 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
313 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
314 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
315 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
316 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
318 typedef struct _LttvCPUState
{
325 typedef struct _LttvIRQState
{
329 typedef struct _LttvSoftIRQState
{
330 guint pending
; /* number of times it is pending */
331 guint running
; /* number of times it is currently running (on different processors) */
334 typedef struct _LttvTrapState
{
335 guint running
; /* number of times it is currently running (on different processors) */
338 typedef struct _LttvBdevState
{
342 struct _LttvTraceState
{
343 LttvTraceContext parent
;
345 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
347 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
348 pointers to LttvTracefileState objects. */
349 guint nb_event
, save_interval
;
350 /* Block/char devices, locks, memory pages... */
351 GQuark
*eventtype_names
;
352 GQuark
*syscall_names
;
359 GQuark
*soft_irq_names
;
360 LttTime
*max_time_state_recomputed_in_seek
;
362 /* Array of per cpu running process */
363 LttvProcessState
**running_process
;
364 gboolean has_precomputed_states
;
365 LttvCPUState
*cpu_states
; /* state of each cpu */
366 LttvIRQState
*irq_states
; /* state of each irq handler */
367 LttvSoftIRQState
*soft_irq_states
; /* state of each softirq */
368 LttvTrapState
*trap_states
; /* state of each trap */
369 GHashTable
*bdev_states
; /* state of the block devices */
372 struct _LttvTraceStateClass
{
373 LttvTraceContextClass parent
;
375 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
376 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
377 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
380 GType
lttv_trace_state_get_type (void);
382 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
384 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
386 void lttv_state_state_saved_free(LttvTraceState
*self
,
387 LttvAttribute
*container
);
389 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
390 LttvTracefileState
*tfs
);
392 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
393 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
394 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
395 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
396 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
397 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
399 struct _LttvTracefileState
{
400 LttvTracefileContext parent
;
402 GQuark tracefile_name
;
403 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
404 LttvCPUState
*cpu_state
; /* cpu resource state */
407 struct _LttvTracefileStateClass
{
408 LttvTracefileContextClass parent
;
411 GType
lttv_tracefile_state_get_type (void);
413 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
415 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
416 guint cpu
= tfs
->cpu
;
417 LttvProcessState
*process
= ts
->running_process
[cpu
];
419 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
420 else return process
->pid
;
424 #define HDR_PROCESS 0
426 #define HDR_USER_STACK 2
427 #define HDR_USERTRACE 3
428 #define HDR_PROCESS_STATE 4
430 #define HDR_TRACEFILE 6
431 #define HDR_TRACESET 7
436 /* Device number manipulation macros from kernel source */
438 #define MINORMASK ((1U << MINORBITS) - 1)
439 #define MAJOR(dev) ((unsigned int) ((dev) >> MINORBITS))
440 #define MINOR(dev) ((unsigned int) ((dev) & MINORMASK))
441 #define MKDEV(ma,mi) (((ma) << MINORBITS) | (mi))