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 extern guint64 nr_states
;
57 /* Facilities Quarks */
61 LTT_FACILITY_KERNEL_ARCH
,
64 LTT_FACILITY_USER_GENERIC
,
66 LTT_FACILITY_STATEDUMP
;
71 LTT_EVENT_SYSCALL_ENTRY
,
72 LTT_EVENT_SYSCALL_EXIT
,
77 LTT_EVENT_SOFT_IRQ_RAISE
,
78 LTT_EVENT_SOFT_IRQ_ENTRY
,
79 LTT_EVENT_SOFT_IRQ_EXIT
,
80 LTT_EVENT_SCHED_SCHEDULE
,
81 LTT_EVENT_PROCESS_FORK
,
82 LTT_EVENT_KTHREAD_CREATE
,
83 LTT_EVENT_PROCESS_EXIT
,
84 LTT_EVENT_PROCESS_FREE
,
86 LTT_EVENT_PROCESS_STATE
,
87 LTT_EVENT_STATEDUMP_END
,
88 LTT_EVENT_FUNCTION_ENTRY
,
89 LTT_EVENT_FUNCTION_EXIT
,
90 LTT_EVENT_THREAD_BRAND
,
91 LTT_EVENT_REQUEST_ISSUE
,
92 LTT_EVENT_REQUEST_COMPLETE
,
93 LTT_EVENT_LIST_INTERRUPT
,
94 LTT_EVENT_SYS_CALL_TABLE
,
95 LTT_EVENT_SOFTIRQ_VEC
;
100 LTT_FIELD_SYSCALL_ID
,
103 LTT_FIELD_SOFT_IRQ_ID
,
106 LTT_FIELD_PREV_STATE
,
107 LTT_FIELD_PARENT_PID
,
127 typedef struct _LttvTracesetState LttvTracesetState
;
128 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
130 typedef struct _LttvTraceState LttvTraceState
;
131 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
133 typedef struct _LttvTracefileState LttvTracefileState
;
134 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
136 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
137 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
139 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
140 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
142 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
143 // Hook wrapper. call_data is a trace context.
144 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
146 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
147 // Hook wrapper. call_data is a trace context.
148 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
150 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
152 /* The LttvProcessState structure defines the current state for each process.
153 A process can make system calls (in some rare cases nested) and receive
154 interrupts/faults. For instance, a process may issue a system call,
155 generate a page fault while reading an argument from user space, and
156 get caught by an interrupt. To represent these nested states, an
157 execution mode stack is maintained. The stack bottom is normal user mode
158 and the top of stack is the current execution mode.
160 The execution mode stack tells about the process status, execution mode and
161 submode (interrupt, system call or IRQ number). All these could be
162 defined as enumerations but may need extensions (e.g. new process state).
163 GQuark are thus used. They are as easy to manipulate as integers but have
164 a string associated, just like enumerations.
166 The execution mode is one of "user mode", "kernel thread", "system call",
167 "interrupt request", "fault". */
169 typedef GQuark LttvExecutionMode
;
171 extern LttvExecutionMode
172 LTTV_STATE_USER_MODE
,
177 LTTV_STATE_MODE_UNKNOWN
;
180 /* The submode number depends on the execution mode. For user mode or kernel
181 thread, which are the normal mode (execution mode stack bottom),
182 it is set to "none". For interrupt requests, faults and system calls,
183 it is set respectively to the interrupt name (e.g. "timer"), fault name
184 (e.g. "page fault"), and system call name (e.g. "select"). */
186 typedef GQuark LttvExecutionSubmode
;
188 extern LttvExecutionSubmode
189 LTTV_STATE_SUBMODE_NONE
,
190 LTTV_STATE_SUBMODE_UNKNOWN
;
192 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
193 where "*" describes the resource waited for (e.g. timer, process,
196 typedef GQuark LttvProcessStatus
;
198 extern LttvProcessStatus
200 LTTV_STATE_WAIT_FORK
,
209 LTTV_STATE_UNBRANDED
;
211 typedef GQuark LttvProcessType
;
213 extern LttvProcessType
214 LTTV_STATE_USER_THREAD
,
215 LTTV_STATE_KERNEL_THREAD
;
217 typedef GQuark LttvCPUMode
;
226 typedef GQuark LttvIRQMode
;
232 typedef GQuark LttvBdevMode
;
236 LTTV_BDEV_BUSY_READING
,
237 LTTV_BDEV_BUSY_WRITING
;
239 typedef struct _LttvExecutionState
{
241 LttvExecutionSubmode n
;
244 LttTime cum_cpu_time
;
246 } LttvExecutionState
;
248 typedef struct _LttvProcessState
{
252 LttTime creation_time
;
253 LttTime insertion_time
;
257 GArray
*execution_stack
; /* Array of LttvExecutionState */
258 LttvExecutionState
*state
; /* Top of interrupt stack */
259 /* WARNING : each time the execution_stack size is modified, the state
260 * must be reget : g_array_set_size can have to move the array.
262 guint cpu
; /* CPU where process is scheduled (being either in
263 the active or inactive runqueue)*/
264 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
265 LttvTracefileState
*usertrace
; /* Associated usertrace */
266 /* opened file descriptors, address map?... */
267 GArray
*user_stack
; /* User space function call stack */
268 guint64 current_function
;
269 LttvProcessType type
; /* kernel thread or user space ? */
270 guint target_pid
; /* target PID of the current event. */
271 guint free_events
; /* 0 : none, 1 : free or exit dead, 2 : should delete */
274 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
275 a PID != 0 will search on any cpu automatically. */
278 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
281 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
282 const LttTime
*timestamp
);
285 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
286 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
288 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
289 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
291 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
292 inherit from the corresponding Context objects defined in processTrace. */
294 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
295 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
296 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
297 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
298 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
299 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
301 struct _LttvTracesetState
{
302 LttvTracesetContext parent
;
305 struct _LttvTracesetStateClass
{
306 LttvTracesetContextClass parent
;
309 GType
lttv_traceset_state_get_type (void);
312 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
313 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
314 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
315 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
316 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
317 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
319 typedef struct _LttvCPUState
{
326 typedef struct _LttvIRQState
{
330 typedef struct _LttvSoftIRQState
{
331 guint pending
; /* number of times it is pending */
332 guint running
; /* number of times it is currently running (on different processors) */
335 typedef struct _LttvTrapState
{
336 guint running
; /* number of times it is currently running (on different processors) */
339 typedef struct _LttvBdevState
{
343 struct _LttvTraceState
{
344 LttvTraceContext parent
;
346 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
348 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
349 pointers to LttvTracefileState objects. */
350 guint nb_event
, save_interval
;
351 /* Block/char devices, locks, memory pages... */
352 GQuark
*eventtype_names
;
353 GQuark
*syscall_names
;
360 GQuark
*soft_irq_names
;
361 LttTime
*max_time_state_recomputed_in_seek
;
363 /* Array of per cpu running process */
364 LttvProcessState
**running_process
;
365 gboolean has_precomputed_states
;
366 LttvCPUState
*cpu_states
; /* state of each cpu */
367 LttvIRQState
*irq_states
; /* state of each irq handler */
368 LttvSoftIRQState
*soft_irq_states
; /* state of each softirq */
369 LttvTrapState
*trap_states
; /* state of each trap */
370 GHashTable
*bdev_states
; /* state of the block devices */
373 struct _LttvTraceStateClass
{
374 LttvTraceContextClass parent
;
376 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
377 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
378 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
381 GType
lttv_trace_state_get_type (void);
383 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
385 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
387 void lttv_state_state_saved_free(LttvTraceState
*self
,
388 LttvAttribute
*container
);
390 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
391 LttvTracefileState
*tfs
);
393 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
394 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
395 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
396 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
397 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
398 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
400 struct _LttvTracefileState
{
401 LttvTracefileContext parent
;
403 GQuark tracefile_name
;
404 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
405 LttvCPUState
*cpu_state
; /* cpu resource state */
408 struct _LttvTracefileStateClass
{
409 LttvTracefileContextClass parent
;
412 GType
lttv_tracefile_state_get_type (void);
414 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
416 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
417 guint cpu
= tfs
->cpu
;
418 LttvProcessState
*process
= ts
->running_process
[cpu
];
420 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
421 else return process
->pid
;
425 #define HDR_PROCESS 0
427 #define HDR_USER_STACK 2
428 #define HDR_USERTRACE 3
429 #define HDR_PROCESS_STATE 4
431 #define HDR_TRACEFILE 6
432 #define HDR_TRACESET 7
437 /* Device number manipulation macros from kernel source */
439 #define MINORMASK ((1U << MINORBITS) - 1)
440 #define MAJOR(dev) ((unsigned int) ((dev) >> MINORBITS))
441 #define MINOR(dev) ((unsigned int) ((dev) & MINORMASK))
442 #define MKDEV(ma,mi) (((ma) << MINORBITS) | (mi))