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
,
90 LTT_EVENT_LIST_INTERRUPT
;
98 LTT_FIELD_SOFT_IRQ_ID
,
101 LTT_FIELD_PREV_STATE
,
102 LTT_FIELD_PARENT_PID
,
120 typedef struct _LttvTracesetState LttvTracesetState
;
121 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
123 typedef struct _LttvTraceState LttvTraceState
;
124 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
126 typedef struct _LttvTracefileState LttvTracefileState
;
127 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
129 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
130 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
132 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
133 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
135 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
136 // Hook wrapper. call_data is a trace context.
137 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
139 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
140 // Hook wrapper. call_data is a trace context.
141 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
143 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
145 /* The LttvProcessState structure defines the current state for each process.
146 A process can make system calls (in some rare cases nested) and receive
147 interrupts/faults. For instance, a process may issue a system call,
148 generate a page fault while reading an argument from user space, and
149 get caught by an interrupt. To represent these nested states, an
150 execution mode stack is maintained. The stack bottom is normal user mode
151 and the top of stack is the current execution mode.
153 The execution mode stack tells about the process status, execution mode and
154 submode (interrupt, system call or IRQ number). All these could be
155 defined as enumerations but may need extensions (e.g. new process state).
156 GQuark are thus used. They are as easy to manipulate as integers but have
157 a string associated, just like enumerations.
159 The execution mode is one of "user mode", "kernel thread", "system call",
160 "interrupt request", "fault". */
162 typedef GQuark LttvExecutionMode
;
164 extern LttvExecutionMode
165 LTTV_STATE_USER_MODE
,
170 LTTV_STATE_MODE_UNKNOWN
;
173 /* The submode number depends on the execution mode. For user mode or kernel
174 thread, which are the normal mode (execution mode stack bottom),
175 it is set to "none". For interrupt requests, faults and system calls,
176 it is set respectively to the interrupt name (e.g. "timer"), fault name
177 (e.g. "page fault"), and system call name (e.g. "select"). */
179 typedef GQuark LttvExecutionSubmode
;
181 extern LttvExecutionSubmode
182 LTTV_STATE_SUBMODE_NONE
,
183 LTTV_STATE_SUBMODE_UNKNOWN
;
185 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
186 where "*" describes the resource waited for (e.g. timer, process,
189 typedef GQuark LttvProcessStatus
;
191 extern LttvProcessStatus
193 LTTV_STATE_WAIT_FORK
,
202 LTTV_STATE_UNBRANDED
;
204 typedef GQuark LttvProcessType
;
206 extern LttvProcessType
207 LTTV_STATE_USER_THREAD
,
208 LTTV_STATE_KERNEL_THREAD
;
210 typedef GQuark LttvCPUMode
;
218 typedef GQuark LttvIRQMode
;
224 typedef GQuark LttvBdevMode
;
228 LTTV_BDEV_BUSY_READING
,
229 LTTV_BDEV_BUSY_WRITING
;
231 typedef struct _LttvExecutionState
{
233 LttvExecutionSubmode n
;
236 LttTime cum_cpu_time
;
238 } LttvExecutionState
;
240 typedef struct _LttvProcessState
{
244 LttTime creation_time
;
245 LttTime insertion_time
;
249 GArray
*execution_stack
; /* Array of LttvExecutionState */
250 LttvExecutionState
*state
; /* Top of interrupt stack */
251 /* WARNING : each time the execution_stack size is modified, the state
252 * must be reget : g_array_set_size can have to move the array.
254 guint cpu
; /* CPU where process is scheduled (being either in
255 the active or inactive runqueue)*/
256 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
257 LttvTracefileState
*usertrace
; /* Associated usertrace */
258 /* opened file descriptors, address map?... */
259 GArray
*user_stack
; /* User space function call stack */
260 guint64 current_function
;
261 LttvProcessType type
; /* kernel thread or user space ? */
262 guint target_pid
; /* target PID of the current event. */
265 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
266 a PID != 0 will search on any cpu automatically. */
269 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
272 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
273 const LttTime
*timestamp
);
276 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
277 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
279 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
280 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
282 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
283 inherit from the corresponding Context objects defined in processTrace. */
285 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
286 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
287 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
288 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
289 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
290 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
292 struct _LttvTracesetState
{
293 LttvTracesetContext parent
;
296 struct _LttvTracesetStateClass
{
297 LttvTracesetContextClass parent
;
300 GType
lttv_traceset_state_get_type (void);
303 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
304 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
305 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
306 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
307 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
308 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
310 typedef struct _LttvCPUState
{
315 typedef struct _LttvIRQState
{
319 typedef struct _LttvBdevState
{
323 struct _LttvTraceState
{
324 LttvTraceContext parent
;
326 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
328 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
329 pointers to LttvTracefileState objects. */
330 guint nb_event
, save_interval
;
331 /* Block/char devices, locks, memory pages... */
332 GQuark
*eventtype_names
;
333 GQuark
*syscall_names
;
340 GQuark
*soft_irq_names
;
341 LttTime
*max_time_state_recomputed_in_seek
;
343 /* Array of per cpu running process */
344 LttvProcessState
**running_process
;
345 gboolean has_precomputed_states
;
346 LttvCPUState
*cpu_states
; /* state of each cpu */
347 LttvIRQState
*irq_states
; /* state of each irq handler */
348 GHashTable
*bdev_states
; /* state of the block devices */
351 struct _LttvTraceStateClass
{
352 LttvTraceContextClass parent
;
354 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
355 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
356 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
359 GType
lttv_trace_state_get_type (void);
361 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
363 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
365 void lttv_state_state_saved_free(LttvTraceState
*self
,
366 LttvAttribute
*container
);
368 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
369 LttvTracefileState
*tfs
);
371 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
372 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
373 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
374 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
375 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
376 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
378 struct _LttvTracefileState
{
379 LttvTracefileContext parent
;
381 GQuark tracefile_name
;
382 guint cpu
; /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
383 LttvCPUState
*cpu_state
; /* cpu resource state */
386 struct _LttvTracefileStateClass
{
387 LttvTracefileContextClass parent
;
390 GType
lttv_tracefile_state_get_type (void);
392 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
394 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
395 guint cpu
= tfs
->cpu
;
396 LttvProcessState
*process
= ts
->running_process
[cpu
];
398 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
399 else return process
->pid
;
403 #define HDR_PROCESS 0
405 #define HDR_USER_STACK 2
406 #define HDR_USERTRACE 3
407 #define HDR_PROCESS_STATE 4
409 #define HDR_TRACEFILE 6
410 #define HDR_TRACESET 7
415 #define MKDEV(ma,mi) ((ma)<<8 | (mi))