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_ENTRY
,
77 LTT_EVENT_SOFT_IRQ_EXIT
,
78 LTT_EVENT_SCHED_SCHEDULE
,
79 LTT_EVENT_PROCESS_FORK
,
80 LTT_EVENT_KTHREAD_CREATE
,
81 LTT_EVENT_PROCESS_EXIT
,
82 LTT_EVENT_PROCESS_FREE
,
84 LTT_EVENT_PROCESS_STATE
,
85 LTT_EVENT_STATEDUMP_END
,
86 LTT_EVENT_FUNCTION_ENTRY
,
87 LTT_EVENT_FUNCTION_EXIT
,
88 LTT_EVENT_THREAD_BRAND
,
89 LTT_EVENT_REQUEST_ISSUE
,
90 LTT_EVENT_REQUEST_COMPLETE
,
91 LTT_EVENT_LIST_INTERRUPT
,
92 LTT_EVENT_SYS_CALL_TABLE
,
93 LTT_EVENT_SOFTIRQ_VEC
;
101 LTT_FIELD_SOFT_IRQ_ID
,
104 LTT_FIELD_PREV_STATE
,
105 LTT_FIELD_PARENT_PID
,
125 typedef struct _LttvTracesetState LttvTracesetState
;
126 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
128 typedef struct _LttvTraceState LttvTraceState
;
129 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
131 typedef struct _LttvTracefileState LttvTracefileState
;
132 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
134 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
135 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
137 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
138 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
140 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
141 // Hook wrapper. call_data is a trace context.
142 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
144 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
145 // Hook wrapper. call_data is a trace context.
146 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
148 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
150 /* The LttvProcessState structure defines the current state for each process.
151 A process can make system calls (in some rare cases nested) and receive
152 interrupts/faults. For instance, a process may issue a system call,
153 generate a page fault while reading an argument from user space, and
154 get caught by an interrupt. To represent these nested states, an
155 execution mode stack is maintained. The stack bottom is normal user mode
156 and the top of stack is the current execution mode.
158 The execution mode stack tells about the process status, execution mode and
159 submode (interrupt, system call or IRQ number). All these could be
160 defined as enumerations but may need extensions (e.g. new process state).
161 GQuark are thus used. They are as easy to manipulate as integers but have
162 a string associated, just like enumerations.
164 The execution mode is one of "user mode", "kernel thread", "system call",
165 "interrupt request", "fault". */
167 typedef GQuark LttvExecutionMode
;
169 extern LttvExecutionMode
170 LTTV_STATE_USER_MODE
,
175 LTTV_STATE_MODE_UNKNOWN
;
178 /* The submode number depends on the execution mode. For user mode or kernel
179 thread, which are the normal mode (execution mode stack bottom),
180 it is set to "none". For interrupt requests, faults and system calls,
181 it is set respectively to the interrupt name (e.g. "timer"), fault name
182 (e.g. "page fault"), and system call name (e.g. "select"). */
184 typedef GQuark LttvExecutionSubmode
;
186 extern LttvExecutionSubmode
187 LTTV_STATE_SUBMODE_NONE
,
188 LTTV_STATE_SUBMODE_UNKNOWN
;
190 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
191 where "*" describes the resource waited for (e.g. timer, process,
194 typedef GQuark LttvProcessStatus
;
196 extern LttvProcessStatus
198 LTTV_STATE_WAIT_FORK
,
207 LTTV_STATE_UNBRANDED
;
209 typedef GQuark LttvProcessType
;
211 extern LttvProcessType
212 LTTV_STATE_USER_THREAD
,
213 LTTV_STATE_KERNEL_THREAD
;
215 typedef GQuark LttvCPUMode
;
224 typedef GQuark LttvIRQMode
;
230 typedef GQuark LttvBdevMode
;
234 LTTV_BDEV_BUSY_READING
,
235 LTTV_BDEV_BUSY_WRITING
;
237 typedef struct _LttvExecutionState
{
239 LttvExecutionSubmode n
;
242 LttTime cum_cpu_time
;
244 } LttvExecutionState
;
246 typedef struct _LttvProcessState
{
250 LttTime creation_time
;
251 LttTime insertion_time
;
255 GArray
*execution_stack
; /* Array of LttvExecutionState */
256 LttvExecutionState
*state
; /* Top of interrupt stack */
257 /* WARNING : each time the execution_stack size is modified, the state
258 * must be reget : g_array_set_size can have to move the array.
260 guint cpu
; /* CPU where process is scheduled (being either in
261 the active or inactive runqueue)*/
262 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
263 LttvTracefileState
*usertrace
; /* Associated usertrace */
264 /* opened file descriptors, address map?... */
265 GArray
*user_stack
; /* User space function call stack */
266 guint64 current_function
;
267 LttvProcessType type
; /* kernel thread or user space ? */
268 guint target_pid
; /* target PID of the current event. */
269 guint free_events
; /* 0 : none, 1 : free or exit dead, 2 : should delete */
272 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
273 a PID != 0 will search on any cpu automatically. */
276 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
279 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
280 const LttTime
*timestamp
);
283 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
284 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
286 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
287 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
289 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
290 inherit from the corresponding Context objects defined in processTrace. */
292 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
293 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
294 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
295 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
296 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
297 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
299 struct _LttvTracesetState
{
300 LttvTracesetContext parent
;
303 struct _LttvTracesetStateClass
{
304 LttvTracesetContextClass parent
;
307 GType
lttv_traceset_state_get_type (void);
310 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
311 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
312 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
313 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
314 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
315 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
317 typedef struct _LttvCPUState
{
324 typedef struct _LttvIRQState
{
328 typedef struct _LttvSoftIRQState
{
329 guint running
; /* number of times it is currently running (on different processors) */
332 typedef struct _LttvTrapState
{
333 guint running
; /* number of times it is currently running (on different processors) */
336 typedef struct _LttvBdevState
{
340 struct _LttvTraceState
{
341 LttvTraceContext parent
;
343 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
345 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
346 pointers to LttvTracefileState objects. */
347 guint nb_event
, save_interval
;
348 /* Block/char devices, locks, memory pages... */
349 GQuark
*eventtype_names
;
350 GQuark
*syscall_names
;
357 GQuark
*soft_irq_names
;
358 LttTime
*max_time_state_recomputed_in_seek
;
360 /* Array of per cpu running process */
361 LttvProcessState
**running_process
;
362 gboolean has_precomputed_states
;
363 LttvCPUState
*cpu_states
; /* state of each cpu */
364 LttvIRQState
*irq_states
; /* state of each irq handler */
365 LttvSoftIRQState
*soft_irq_states
; /* state of each softirq */
366 LttvTrapState
*trap_states
; /* state of each trap */
367 GHashTable
*bdev_states
; /* state of the block devices */
370 struct _LttvTraceStateClass
{
371 LttvTraceContextClass parent
;
373 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
374 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
375 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
378 GType
lttv_trace_state_get_type (void);
380 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
382 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
384 void lttv_state_state_saved_free(LttvTraceState
*self
,
385 LttvAttribute
*container
);
387 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
388 LttvTracefileState
*tfs
);
390 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
391 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
392 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
393 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
394 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
395 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
397 struct _LttvTracefileState
{
398 LttvTracefileContext parent
;
400 GQuark tracefile_name
;
401 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
402 LttvCPUState
*cpu_state
; /* cpu resource state */
405 struct _LttvTracefileStateClass
{
406 LttvTracefileContextClass parent
;
409 GType
lttv_tracefile_state_get_type (void);
411 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
413 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
414 guint cpu
= tfs
->cpu
;
415 LttvProcessState
*process
= ts
->running_process
[cpu
];
417 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
418 else return process
->pid
;
422 #define HDR_PROCESS 0
424 #define HDR_USER_STACK 2
425 #define HDR_USERTRACE 3
426 #define HDR_PROCESS_STATE 4
428 #define HDR_TRACEFILE 6
429 #define HDR_TRACESET 7
434 /* Device number manipulation macros from kernel source */
436 #define MINORMASK ((1U << MINORBITS) - 1)
437 #define MAJOR(dev) ((unsigned int) ((dev) >> MINORBITS))
438 #define MINOR(dev) ((unsigned int) ((dev) & MINORMASK))
439 #define MKDEV(ma,mi) (((ma) << MINORBITS) | (mi))