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
60 LTT_CHANNEL_GLOBAL_STATE
,
61 LTT_CHANNEL_IRQ_STATE
,
62 LTT_CHANNEL_MODULE_STATE
,
63 LTT_CHANNEL_NETIF_STATE
,
64 LTT_CHANNEL_SOFTIRQ_STATE
,
65 LTT_CHANNEL_SWAP_STATE
,
66 LTT_CHANNEL_SYSCALL_STATE
,
67 LTT_CHANNEL_TASK_STATE
,
69 LTT_CHANNEL_KPROBE_STATE
,
73 LTT_CHANNEL_USERSPACE
,
79 LTT_EVENT_SYSCALL_ENTRY
,
80 LTT_EVENT_SYSCALL_EXIT
,
83 LTT_EVENT_PAGE_FAULT_ENTRY
,
84 LTT_EVENT_PAGE_FAULT_EXIT
,
85 LTT_EVENT_PAGE_FAULT_NOSEM_ENTRY
,
86 LTT_EVENT_PAGE_FAULT_NOSEM_EXIT
,
89 LTT_EVENT_SOFT_IRQ_RAISE
,
90 LTT_EVENT_SOFT_IRQ_ENTRY
,
91 LTT_EVENT_SOFT_IRQ_EXIT
,
92 LTT_EVENT_SCHED_SCHEDULE
,
93 LTT_EVENT_PROCESS_FORK
,
94 LTT_EVENT_KTHREAD_CREATE
,
95 LTT_EVENT_PROCESS_EXIT
,
96 LTT_EVENT_PROCESS_FREE
,
98 LTT_EVENT_PROCESS_STATE
,
99 LTT_EVENT_STATEDUMP_END
,
100 LTT_EVENT_FUNCTION_ENTRY
,
101 LTT_EVENT_FUNCTION_EXIT
,
102 LTT_EVENT_THREAD_BRAND
,
103 LTT_EVENT_REQUEST_ISSUE
,
104 LTT_EVENT_REQUEST_COMPLETE
,
105 LTT_EVENT_LIST_INTERRUPT
,
106 LTT_EVENT_SYS_CALL_TABLE
,
107 LTT_EVENT_SOFTIRQ_VEC
,
108 LTT_EVENT_KPROBE_TABLE
,
114 LTT_FIELD_SYSCALL_ID
,
117 LTT_FIELD_SOFT_IRQ_ID
,
120 LTT_FIELD_PREV_STATE
,
121 LTT_FIELD_PARENT_PID
,
142 typedef struct _LttvTracesetState LttvTracesetState
;
143 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
145 typedef struct _LttvTraceState LttvTraceState
;
146 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
148 typedef struct _LttvTracefileState LttvTracefileState
;
149 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
151 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
152 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
154 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
155 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
157 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
158 // Hook wrapper. call_data is a trace context.
159 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
161 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
162 // Hook wrapper. call_data is a trace context.
163 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
165 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
167 /* The LttvProcessState structure defines the current state for each process.
168 A process can make system calls (in some rare cases nested) and receive
169 interrupts/faults. For instance, a process may issue a system call,
170 generate a page fault while reading an argument from user space, and
171 get caught by an interrupt. To represent these nested states, an
172 execution mode stack is maintained. The stack bottom is normal user mode
173 and the top of stack is the current execution mode.
175 The execution mode stack tells about the process status, execution mode and
176 submode (interrupt, system call or IRQ number). All these could be
177 defined as enumerations but may need extensions (e.g. new process state).
178 GQuark are thus used. They are as easy to manipulate as integers but have
179 a string associated, just like enumerations.
181 The execution mode is one of "user mode", "kernel thread", "system call",
182 "interrupt request", "fault". */
184 typedef GQuark LttvExecutionMode
;
186 extern LttvExecutionMode
187 LTTV_STATE_USER_MODE
,
192 LTTV_STATE_MODE_UNKNOWN
;
195 /* The submode number depends on the execution mode. For user mode or kernel
196 thread, which are the normal mode (execution mode stack bottom),
197 it is set to "none". For interrupt requests, faults and system calls,
198 it is set respectively to the interrupt name (e.g. "timer"), fault name
199 (e.g. "page fault"), and system call name (e.g. "select"). */
201 typedef GQuark LttvExecutionSubmode
;
203 extern LttvExecutionSubmode
204 LTTV_STATE_SUBMODE_NONE
,
205 LTTV_STATE_SUBMODE_UNKNOWN
;
207 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
208 where "*" describes the resource waited for (e.g. timer, process,
211 typedef GQuark LttvProcessStatus
;
213 extern LttvProcessStatus
215 LTTV_STATE_WAIT_FORK
,
224 LTTV_STATE_UNBRANDED
;
226 typedef GQuark LttvProcessType
;
228 extern LttvProcessType
229 LTTV_STATE_USER_THREAD
,
230 LTTV_STATE_KERNEL_THREAD
;
232 typedef GQuark LttvCPUMode
;
241 typedef GQuark LttvIRQMode
;
247 typedef GQuark LttvBdevMode
;
251 LTTV_BDEV_BUSY_READING
,
252 LTTV_BDEV_BUSY_WRITING
;
254 typedef struct _LttvExecutionState
{
256 LttvExecutionSubmode n
;
259 LttTime cum_cpu_time
;
261 } LttvExecutionState
;
263 typedef struct _LttvProcessState
{
267 LttTime creation_time
;
268 LttTime insertion_time
;
272 GArray
*execution_stack
; /* Array of LttvExecutionState */
273 LttvExecutionState
*state
; /* Top of interrupt stack */
274 /* WARNING : each time the execution_stack size is modified, the state
275 * must be reget : g_array_set_size can have to move the array.
277 guint cpu
; /* CPU where process is scheduled (being either in
278 the active or inactive runqueue)*/
279 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
280 LttvTracefileState
*usertrace
; /* Associated usertrace */
281 /* opened file descriptors, address map?... */
282 GArray
*user_stack
; /* User space function call stack */
283 guint64 current_function
;
284 LttvProcessType type
; /* kernel thread or user space ? */
285 guint target_pid
; /* target PID of the current event. */
286 guint free_events
; /* 0 : none, 1 : free or exit dead, 2 : should delete */
289 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
290 a PID != 0 will search on any cpu automatically. */
293 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
296 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
297 const LttTime
*timestamp
);
300 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
301 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
303 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
304 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
306 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
307 inherit from the corresponding Context objects defined in processTrace. */
309 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
310 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
311 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
312 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
313 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
314 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
316 struct _LttvTracesetState
{
317 LttvTracesetContext parent
;
320 struct _LttvTracesetStateClass
{
321 LttvTracesetContextClass parent
;
324 GType
lttv_traceset_state_get_type (void);
327 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
328 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
329 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
330 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
331 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
332 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
334 typedef struct _LttvCPUState
{
337 GArray
*softirq_stack
;
341 typedef struct _LttvIRQState
{
345 typedef struct _LttvSoftIRQState
{
346 guint pending
; /* number of times it is pending */
347 guint running
; /* number of times it is currently running (on different processors) */
350 typedef struct _LttvTrapState
{
351 guint running
; /* number of times it is currently running (on different processors) */
354 typedef struct _LttvBdevState
{
358 struct _LttvTraceState
{
359 LttvTraceContext parent
;
361 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
363 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
364 pointers to LttvTracefileState objects. */
365 guint nb_event
, save_interval
;
366 /* Block/char devices, locks, memory pages... */
367 GQuark
*eventtype_names
;
368 GQuark
*syscall_names
;
375 GQuark
*soft_irq_names
;
376 LttTime
*max_time_state_recomputed_in_seek
;
377 GHashTable
*kprobe_hash
;
379 /* Array of per cpu running process */
380 LttvProcessState
**running_process
;
381 gboolean has_precomputed_states
;
382 LttvCPUState
*cpu_states
; /* state of each cpu */
383 LttvIRQState
*irq_states
; /* state of each irq handler */
384 LttvSoftIRQState
*soft_irq_states
; /* state of each softirq */
385 LttvTrapState
*trap_states
; /* state of each trap */
386 GHashTable
*bdev_states
; /* state of the block devices */
389 struct _LttvTraceStateClass
{
390 LttvTraceContextClass parent
;
392 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
393 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
394 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
397 GType
lttv_trace_state_get_type (void);
399 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
401 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
403 void lttv_state_state_saved_free(LttvTraceState
*self
,
404 LttvAttribute
*container
);
406 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
407 LttvTracefileState
*tfs
);
409 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
410 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
411 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
412 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
413 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
414 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
416 struct _LttvTracefileState
{
417 LttvTracefileContext parent
;
419 GQuark tracefile_name
;
420 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
421 LttvCPUState
*cpu_state
; /* cpu resource state */
424 struct _LttvTracefileStateClass
{
425 LttvTracefileContextClass parent
;
428 GType
lttv_tracefile_state_get_type (void);
430 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
432 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
433 guint cpu
= tfs
->cpu
;
434 LttvProcessState
*process
= ts
->running_process
[cpu
];
436 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
437 else return process
->pid
;
441 #define HDR_PROCESS 0
443 #define HDR_USER_STACK 2
444 #define HDR_USERTRACE 3
445 #define HDR_PROCESS_STATE 4
447 #define HDR_TRACEFILE 6
448 #define HDR_TRACESET 7
453 /* Device number manipulation macros from kernel source */
455 #define MINORMASK ((1U << MINORBITS) - 1)
456 #define MAJOR(dev) ((unsigned int) ((dev) >> MINORBITS))
457 #define MINOR(dev) ((unsigned int) ((dev) & MINORMASK))
458 #define MKDEV(ma,mi) (((ma) << MINORBITS) | (mi))