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_FUNCTION_ENTRY
,
85 LTT_EVENT_FUNCTION_EXIT
;
93 LTT_FIELD_SOFT_IRQ_ID
,
108 typedef struct _LttvTracesetState LttvTracesetState
;
109 typedef struct _LttvTracesetStateClass LttvTracesetStateClass
;
111 typedef struct _LttvTraceState LttvTraceState
;
112 typedef struct _LttvTraceStateClass LttvTraceStateClass
;
114 typedef struct _LttvTracefileState LttvTracefileState
;
115 typedef struct _LttvTracefileStateClass LttvTracefileStateClass
;
117 gint
lttv_state_hook_add_event_hooks(void *hook_data
, void *call_data
);
118 void lttv_state_add_event_hooks(LttvTracesetState
*self
);
120 gint
lttv_state_hook_remove_event_hooks(void *hook_data
, void *call_data
);
121 void lttv_state_remove_event_hooks(LttvTracesetState
*self
);
123 void lttv_state_save_add_event_hooks(LttvTracesetState
*self
);
124 // Hook wrapper. call_data is a trace context.
125 gint
lttv_state_save_hook_add_event_hooks(void *hook_data
, void *call_data
);
127 void lttv_state_save_remove_event_hooks(LttvTracesetState
*self
);
128 // Hook wrapper. call_data is a trace context.
129 gint
lttv_state_save_hook_remove_event_hooks(void *hook_data
, void *call_data
);
131 void lttv_state_traceset_seek_time_closest(LttvTracesetState
*self
, LttTime t
);
133 /* The LttvProcessState structure defines the current state for each process.
134 A process can make system calls (in some rare cases nested) and receive
135 interrupts/faults. For instance, a process may issue a system call,
136 generate a page fault while reading an argument from user space, and
137 get caught by an interrupt. To represent these nested states, an
138 execution mode stack is maintained. The stack bottom is normal user mode
139 and the top of stack is the current execution mode.
141 The execution mode stack tells about the process status, execution mode and
142 submode (interrupt, system call or IRQ number). All these could be
143 defined as enumerations but may need extensions (e.g. new process state).
144 GQuark are thus used. They are as easy to manipulate as integers but have
145 a string associated, just like enumerations.
147 The execution mode is one of "user mode", "kernel thread", "system call",
148 "interrupt request", "fault". */
150 typedef GQuark LttvExecutionMode
;
152 extern LttvExecutionMode
153 LTTV_STATE_USER_MODE
,
158 LTTV_STATE_MODE_UNKNOWN
;
161 /* The submode number depends on the execution mode. For user mode or kernel
162 thread, which are the normal mode (execution mode stack bottom),
163 it is set to "none". For interrupt requests, faults and system calls,
164 it is set respectively to the interrupt name (e.g. "timer"), fault name
165 (e.g. "page fault"), and system call name (e.g. "select"). */
167 typedef GQuark LttvExecutionSubmode
;
169 extern LttvExecutionSubmode
170 LTTV_STATE_SUBMODE_NONE
,
171 LTTV_STATE_SUBMODE_UNKNOWN
;
173 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
174 where "*" describes the resource waited for (e.g. timer, process,
177 typedef GQuark LttvProcessStatus
;
179 extern LttvProcessStatus
181 LTTV_STATE_WAIT_FORK
,
190 typedef struct _LttvExecutionState
{
192 LttvExecutionSubmode n
;
195 LttTime cum_cpu_time
;
197 } LttvExecutionState
;
199 typedef struct _LttvProcessState
{
202 LttTime creation_time
;
203 LttTime insertion_time
;
206 GArray
*execution_stack
; /* Array of LttvExecutionState */
207 LttvExecutionState
*state
; /* Top of interrupt stack */
208 /* WARNING : each time the execution_stack size is modified, the state
209 * must be reget : g_array_set_size can have to move the array.
211 guint cpu
; /* CPU where process is scheduled (being either in
212 the active or inactive runqueue)*/
213 gboolean kernel_thread
; /* Is this thread a kernel_thread ? */
214 // guint last_tracefile_index; /* index in the trace for cpu tracefile */
215 LttvTracefileState
*usertrace
; /* Associated usertrace */
216 /* opened file descriptors, address map?... */
217 GArray
*user_stack
; /* User space function call stack */
218 guint64 current_function
;
221 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
222 a PID != 0 will search on any cpu automatically. */
225 lttv_state_find_process(LttvTraceState
*ts
, guint cpu
, guint pid
);
228 lttv_state_find_process_or_create(LttvTraceState
*ts
, guint cpu
, guint pid
,
232 lttv_state_create_process(LttvTraceState
*tcs
, LttvProcessState
*parent
,
233 guint cpu
, guint pid
, GQuark name
, const LttTime
*timestamp
);
235 void lttv_state_write(LttvTraceState
*self
, LttTime t
, FILE *fp
);
237 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
238 inherit from the corresponding Context objects defined in processTrace. */
240 #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ())
241 #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
242 #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
243 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
244 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
245 #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
247 struct _LttvTracesetState
{
248 LttvTracesetContext parent
;
251 struct _LttvTracesetStateClass
{
252 LttvTracesetContextClass parent
;
255 GType
lttv_traceset_state_get_type (void);
258 #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ())
259 #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
260 #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
261 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
262 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
263 #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
265 struct _LttvTraceState
{
266 LttvTraceContext parent
;
268 GHashTable
*processes
; /* LttvProcessState objects indexed by pid and
270 GHashTable
*usertraces
; /* GPtrArray objects indexed by pid, containing
271 pointers to LttvTracefileState objects. */
272 guint nb_event
, save_interval
;
273 /* Block/char devices, locks, memory pages... */
274 GQuark
*eventtype_names
;
275 GQuark
*syscall_names
;
279 GQuark
*soft_irq_names
;
280 LttTime
*max_time_state_recomputed_in_seek
;
282 /* Array of per cpu running process */
283 LttvProcessState
**running_process
;
286 struct _LttvTraceStateClass
{
287 LttvTraceContextClass parent
;
289 void (*state_save
) (LttvTraceState
*self
, LttvAttribute
*container
);
290 void (*state_restore
) (LttvTraceState
*self
, LttvAttribute
*container
);
291 void (*state_saved_free
) (LttvTraceState
*self
, LttvAttribute
*container
);
294 GType
lttv_trace_state_get_type (void);
296 void lttv_state_save(LttvTraceState
*self
, LttvAttribute
*container
);
298 void lttv_state_restore(LttvTraceState
*self
, LttvAttribute
*container
);
300 void lttv_state_state_saved_free(LttvTraceState
*self
,
301 LttvAttribute
*container
);
303 int lttv_state_pop_state_cleanup(LttvProcessState
*process
,
304 LttvTracefileState
*tfs
);
306 #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ())
307 #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
308 #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
309 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
310 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
311 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
313 struct _LttvTracefileState
{
314 LttvTracefileContext parent
;
316 //LttvProcessState *process;
317 GQuark tracefile_name
;
318 guint cpu
; /* Current cpu of the tracefile */
319 // guint saved_position;
322 struct _LttvTracefileStateClass
{
323 LttvTracefileContextClass parent
;
326 GType
lttv_tracefile_state_get_type (void);