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
,
69 LTT_EVENT_SYSCALL_ENTRY
,
70 LTT_EVENT_SYSCALL_EXIT
,
75 LTT_EVENT_SOFT_IRQ_ENTRY
,
76 LTT_EVENT_SOFT_IRQ_EXIT
,
77 LTT_EVENT_SCHED_SCHEDULE
,
78 LTT_EVENT_PROCESS_FORK
,
79 LTT_EVENT_KTHREAD_CREATE
,
80 LTT_EVENT_PROCESS_EXIT
,
81 LTT_EVENT_PROCESS_FREE
,
83 LTT_EVENT_PROCESS_STATE
,
84 LTT_EVENT_STATEDUMP_END
,
85 LTT_EVENT_FUNCTION_ENTRY
,
86 LTT_EVENT_FUNCTION_EXIT
,
87 LTT_EVENT_THREAD_BRAND
,
88 LTT_EVENT_REQUEST_ISSUE
,
89 LTT_EVENT_REQUEST_COMPLETE
;
97 LTT_FIELD_SOFT_IRQ_ID
,
100 LTT_FIELD_PREV_STATE
,
101 LTT_FIELD_PARENT_PID
,
117 typedef struct _LttvTracesetState LttvTracesetState
;
118 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
120 typedef struct _LttvTraceState LttvTraceState
;
121 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
123 typedef struct _LttvTracefileState LttvTracefileState
;
124 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
126 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
127 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
129 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
130 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
132 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
133 // Hook wrapper. call_data is a trace context.
134 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
136 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
137 // Hook wrapper. call_data is a trace context.
138 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
140 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
142 /* The LttvProcessState structure defines the current state for each process.
143 A process can make system calls (in some rare cases nested) and receive
144 interrupts/faults. For instance, a process may issue a system call,
145 generate a page fault while reading an argument from user space, and
146 get caught by an interrupt. To represent these nested states, an
147 execution mode stack is maintained. The stack bottom is normal user mode
148 and the top of stack is the current execution mode.
150 The execution mode stack tells about the process status, execution mode and
151 submode (interrupt, system call or IRQ number). All these could be
152 defined as enumerations but may need extensions (e.g. new process state).
153 GQuark are thus used. They are as easy to manipulate as integers but have
154 a string associated, just like enumerations.
156 The execution mode is one of "user mode", "kernel thread", "system call",
157 "interrupt request", "fault". */
159 typedef GQuark LttvExecutionMode
;
161 extern LttvExecutionMode
162 LTTV_STATE_USER_MODE
,
167 LTTV_STATE_MODE_UNKNOWN
;
170 /* The submode number depends on the execution mode. For user mode or kernel
171 thread, which are the normal mode (execution mode stack bottom),
172 it is set to "none". For interrupt requests, faults and system calls,
173 it is set respectively to the interrupt name (e.g. "timer"), fault name
174 (e.g. "page fault"), and system call name (e.g. "select"). */
176 typedef GQuark LttvExecutionSubmode
;
178 extern LttvExecutionSubmode
179 LTTV_STATE_SUBMODE_NONE
,
180 LTTV_STATE_SUBMODE_UNKNOWN
;
182 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
183 where "*" describes the resource waited for (e.g. timer, process,
186 typedef GQuark LttvProcessStatus
;
188 extern LttvProcessStatus
190 LTTV_STATE_WAIT_FORK
,
199 LTTV_STATE_UNBRANDED
;
201 typedef GQuark LttvProcessType
;
203 extern LttvProcessType
204 LTTV_STATE_USER_THREAD
,
205 LTTV_STATE_KERNEL_THREAD
;
207 typedef GQuark LttvCPUMode
;
215 typedef GQuark LttvIRQMode
;
221 typedef GQuark LttvBdevMode
;
225 LTTV_BDEV_BUSY_READING
,
226 LTTV_BDEV_BUSY_WRITING
;
228 typedef struct _LttvExecutionState
{
230 LttvExecutionSubmode n
;
233 LttTime cum_cpu_time
;
235 } LttvExecutionState
;
237 typedef struct _LttvProcessState
{
241 LttTime creation_time
;
242 LttTime insertion_time
;
246 GArray
*execution_stack
; /* Array of LttvExecutionState */
247 LttvExecutionState
*state
; /* Top of interrupt stack */
248 /* WARNING : each time the execution_stack size is modified, the state
249 * must be reget : g_array_set_size can have to move the array.
251 guint cpu
; /* CPU where process is scheduled (being either in
252 the active or inactive runqueue)*/
253 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
254 LttvTracefileState
*usertrace
; /* Associated usertrace */
255 /* opened file descriptors, address map?... */
256 GArray
*user_stack
; /* User space function call stack */
257 guint64 current_function
;
258 LttvProcessType type
; /* kernel thread or user space ? */
259 guint target_pid
; /* target PID of the current event. */
262 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
263 a PID != 0 will search on any cpu automatically. */
266 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
269 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
270 const LttTime
*timestamp
);
273 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
274 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
276 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
277 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
279 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
280 inherit from the corresponding Context objects defined in processTrace. */
282 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
283 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
284 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
285 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
286 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
287 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
289 struct _LttvTracesetState
{
290 LttvTracesetContext parent
;
293 struct _LttvTracesetStateClass
{
294 LttvTracesetContextClass parent
;
297 GType
lttv_traceset_state_get_type (void);
300 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
301 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
302 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
303 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
304 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
305 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
307 typedef struct _LttvCPUState
{
312 typedef struct _LttvIRQState
{
316 typedef struct _LttvBdevState
{
320 struct _LttvTraceState
{
321 LttvTraceContext parent
;
323 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
325 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
326 pointers to LttvTracefileState objects. */
327 guint nb_event
, save_interval
;
328 /* Block/char devices, locks, memory pages... */
329 GQuark
*eventtype_names
;
330 GQuark
*syscall_names
;
337 GQuark
*soft_irq_names
;
338 LttTime
*max_time_state_recomputed_in_seek
;
340 /* Array of per cpu running process */
341 LttvProcessState
**running_process
;
342 gboolean has_precomputed_states
;
343 LttvCPUState
*cpu_states
; /* state of each cpu */
344 LttvIRQState
*irq_states
; /* state of each irq handler */
345 GHashTable
*bdev_states
; /* state of the block devices */
348 struct _LttvTraceStateClass
{
349 LttvTraceContextClass parent
;
351 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
352 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
353 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
356 GType
lttv_trace_state_get_type (void);
358 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
360 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
362 void lttv_state_state_saved_free(LttvTraceState
*self
,
363 LttvAttribute
*container
);
365 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
366 LttvTracefileState
*tfs
);
368 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
369 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
370 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
371 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
372 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
373 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
375 struct _LttvTracefileState
{
376 LttvTracefileContext parent
;
378 GQuark tracefile_name
;
379 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
380 LttvCPUState
*cpu_state
; /* cpu resource state */
383 struct _LttvTracefileStateClass
{
384 LttvTracefileContextClass parent
;
387 GType
lttv_tracefile_state_get_type (void);
389 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
391 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
392 guint cpu
= tfs
->cpu
;
393 LttvProcessState
*process
= ts
->running_process
[cpu
];
395 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
396 else return process
->pid
;
400 #define HDR_PROCESS 0
402 #define HDR_USER_STACK 2
403 #define HDR_USERTRACE 3
404 #define HDR_PROCESS_STATE 4
406 #define HDR_TRACEFILE 6
407 #define HDR_TRACESET 7
412 #define MKDEV(ma,mi) ((ma)<<8 | (mi))