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_STATEDUMP
,
64 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_SCHEDCHANGE
,
79 LTT_EVENT_KERNEL_THREAD
,
83 LTT_EVENT_ENUM_PROCESS_STATE
,
84 LTT_EVENT_STATEDUMP_END
,
85 LTT_EVENT_FUNCTION_ENTRY
,
86 LTT_EVENT_FUNCTION_EXIT
,
87 LTT_EVENT_THREAD_BRAND
;
95 LTT_FIELD_SOFT_IRQ_ID
,
112 typedef struct _LttvTracesetState LttvTracesetState
;
113 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
115 typedef struct _LttvTraceState LttvTraceState
;
116 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
118 typedef struct _LttvTracefileState LttvTracefileState
;
119 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
121 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
122 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
124 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
125 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
127 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
128 // Hook wrapper. call_data is a trace context.
129 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
131 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
132 // Hook wrapper. call_data is a trace context.
133 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
135 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
137 /* The LttvProcessState structure defines the current state for each process.
138 A process can make system calls (in some rare cases nested) and receive
139 interrupts/faults. For instance, a process may issue a system call,
140 generate a page fault while reading an argument from user space, and
141 get caught by an interrupt. To represent these nested states, an
142 execution mode stack is maintained. The stack bottom is normal user mode
143 and the top of stack is the current execution mode.
145 The execution mode stack tells about the process status, execution mode and
146 submode (interrupt, system call or IRQ number). All these could be
147 defined as enumerations but may need extensions (e.g. new process state).
148 GQuark are thus used. They are as easy to manipulate as integers but have
149 a string associated, just like enumerations.
151 The execution mode is one of "user mode", "kernel thread", "system call",
152 "interrupt request", "fault". */
154 typedef GQuark LttvExecutionMode
;
156 extern LttvExecutionMode
157 LTTV_STATE_USER_MODE
,
162 LTTV_STATE_MODE_UNKNOWN
;
165 /* The submode number depends on the execution mode. For user mode or kernel
166 thread, which are the normal mode (execution mode stack bottom),
167 it is set to "none". For interrupt requests, faults and system calls,
168 it is set respectively to the interrupt name (e.g. "timer"), fault name
169 (e.g. "page fault"), and system call name (e.g. "select"). */
171 typedef GQuark LttvExecutionSubmode
;
173 extern LttvExecutionSubmode
174 LTTV_STATE_SUBMODE_NONE
,
175 LTTV_STATE_SUBMODE_UNKNOWN
;
177 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
178 where "*" describes the resource waited for (e.g. timer, process,
181 typedef GQuark LttvProcessStatus
;
183 extern LttvProcessStatus
185 LTTV_STATE_UNBRANDED
,
186 LTTV_STATE_WAIT_FORK
,
194 typedef GQuark LttvProcessType
;
196 extern LttvProcessType
197 LTTV_STATE_USER_THREAD
,
198 LTTV_STATE_KERNEL_THREAD
;
200 typedef struct _LttvExecutionState
{
202 LttvExecutionSubmode n
;
205 LttTime cum_cpu_time
;
207 } LttvExecutionState
;
209 typedef struct _LttvProcessState
{
213 LttTime creation_time
;
214 LttTime insertion_time
;
218 GArray
*execution_stack
; /* Array of LttvExecutionState */
219 LttvExecutionState
*state
; /* Top of interrupt stack */
220 /* WARNING : each time the execution_stack size is modified, the state
221 * must be reget : g_array_set_size can have to move the array.
223 guint cpu
; /* CPU where process is scheduled (being either in
224 the active or inactive runqueue)*/
225 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
226 LttvTracefileState
*usertrace
; /* Associated usertrace */
227 /* opened file descriptors, address map?... */
228 GArray
*user_stack
; /* User space function call stack */
229 guint64 current_function
;
230 LttvProcessType type
; /* kernel thread or user space ? */
231 guint target_pid
; /* target PID of the current event. */
234 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
235 a PID != 0 will search on any cpu automatically. */
238 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
241 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
242 const LttTime
*timestamp
);
245 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
246 guint cpu
, guint pid
, guint tgid
, GQuark name
, const LttTime
*timestamp
);
248 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
249 void lttv_state_write_raw(LttvTraceState
*self
, LttTime t
, FILE *fp
);
251 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
252 inherit from the corresponding Context objects defined in processTrace. */
254 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
255 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
256 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
257 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
258 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
259 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
261 struct _LttvTracesetState
{
262 LttvTracesetContext parent
;
265 struct _LttvTracesetStateClass
{
266 LttvTracesetContextClass parent
;
269 GType
lttv_traceset_state_get_type (void);
272 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
273 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
274 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
275 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
276 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
277 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
279 struct _LttvTraceState
{
280 LttvTraceContext parent
;
282 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
284 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
285 pointers to LttvTracefileState objects. */
286 guint nb_event
, save_interval
;
287 /* Block/char devices, locks, memory pages... */
288 GQuark
*eventtype_names
;
289 GQuark
*syscall_names
;
294 GQuark
*soft_irq_names
;
295 LttTime
*max_time_state_recomputed_in_seek
;
297 /* Array of per cpu running process */
298 LttvProcessState
**running_process
;
299 gboolean has_precomputed_states
;
302 struct _LttvTraceStateClass
{
303 LttvTraceContextClass parent
;
305 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
306 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
307 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
310 GType
lttv_trace_state_get_type (void);
312 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
314 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
316 void lttv_state_state_saved_free(LttvTraceState
*self
,
317 LttvAttribute
*container
);
319 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
320 LttvTracefileState
*tfs
);
322 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
323 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
324 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
325 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
326 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
327 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
329 struct _LttvTracefileState
{
330 LttvTracefileContext parent
;
332 //LttvProcessState *process;
333 GQuark tracefile_name
;
334 guint cpu
; /* Current cpu of the tracefile */
335 // guint saved_position;
338 struct _LttvTracefileStateClass
{
339 LttvTracefileContextClass parent
;
342 GType
lttv_tracefile_state_get_type (void);
344 static inline guint
lttv_state_get_target_pid(LttvTracefileState
*tfs
)
346 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
347 guint cpu
= tfs
->cpu
;
348 LttvProcessState
*process
= ts
->running_process
[cpu
];
350 if(tfs
->parent
.target_pid
>= 0) return tfs
->parent
.target_pid
;
351 else return process
->pid
;
355 #define HDR_PROCESS 0
357 #define HDR_USER_STACK 2
358 #define HDR_USERTRACE 3
359 #define HDR_PROCESS_STATE 4
361 #define HDR_TRACEFILE 6
362 #define HDR_TRACESET 7