9c312311 |
1 | /* This file is part of the Linux Trace Toolkit viewer |
2 | * Copyright (C) 2003-2004 Michel Dagenais |
3 | * |
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; |
7 | * |
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. |
12 | * |
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, |
16 | * MA 02111-1307, USA. |
17 | */ |
18 | |
dc877563 |
19 | #ifndef STATE_H |
20 | #define STATE_H |
21 | |
ffd54a90 |
22 | #include <glib.h> |
d8f124de |
23 | #include <lttv/tracecontext.h> |
dbb7bb09 |
24 | #include <stdio.h> |
dc877563 |
25 | |
dd025f91 |
26 | /* The operating system state, kept during the trace analysis, |
dc877563 |
27 | contains a subset of the real operating system state, |
28 | sufficient for the analysis, and possibly organized quite differently. |
29 | |
ffd54a90 |
30 | The state information is added to LttvTracesetContext, LttvTraceContext |
d3e01c7a |
31 | and LttvTracefileContext objects, used by process_traceset, through |
dc877563 |
32 | subtyping. The context objects already reflect the multiple tracefiles |
33 | (one per cpu) per trace and multiple traces per trace set. The state |
308711e5 |
34 | objects defined here simply add fields to the relevant context objects. |
35 | |
36 | There is no traceset specific state yet. It may eventually contains such |
37 | things as clock differences over time. |
38 | |
39 | The trace state currently consists in a process table. |
40 | |
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. |
45 | |
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 |
49 | from user mode). */ |
dc877563 |
50 | |
a5ba1787 |
51 | /* Priority of state hooks */ |
52 | #define LTTV_PRIO_STATE 25 |
53 | |
eed2ef37 |
54 | #define LTTV_STATE_SAVE_INTERVAL 50000 |
55 | |
56 | /* Facilities Quarks */ |
57 | |
58 | extern GQuark |
59 | LTT_FACILITY_KERNEL, |
f5d7967f |
60 | LTT_FACILITY_KERNEL_ARCH, |
f4b88a7d |
61 | LTT_FACILITY_PROCESS, |
b3fd4c02 |
62 | LTT_FACILITY_FS, |
80e0221b |
63 | LTT_FACILITY_STATEDUMP, |
64 | LTT_FACILITY_USER_GENERIC; |
eed2ef37 |
65 | |
66 | /* Events Quarks */ |
67 | |
68 | extern GQuark |
69 | LTT_EVENT_SYSCALL_ENTRY, |
70 | LTT_EVENT_SYSCALL_EXIT, |
71 | LTT_EVENT_TRAP_ENTRY, |
72 | LTT_EVENT_TRAP_EXIT, |
73 | LTT_EVENT_IRQ_ENTRY, |
74 | LTT_EVENT_IRQ_EXIT, |
faf074a3 |
75 | LTT_EVENT_SOFT_IRQ_ENTRY, |
76 | LTT_EVENT_SOFT_IRQ_EXIT, |
eed2ef37 |
77 | LTT_EVENT_SCHEDCHANGE, |
78 | LTT_EVENT_FORK, |
7bfd7820 |
79 | LTT_EVENT_KERNEL_THREAD, |
eed2ef37 |
80 | LTT_EVENT_EXIT, |
f4b88a7d |
81 | LTT_EVENT_FREE, |
b3fd4c02 |
82 | LTT_EVENT_EXEC, |
80e0221b |
83 | LTT_EVENT_ENUM_PROCESS_STATE, |
84 | LTT_EVENT_FUNCTION_ENTRY, |
85 | LTT_EVENT_FUNCTION_EXIT, |
86 | LTT_EVENT_THREAD_BRAND; |
eed2ef37 |
87 | |
88 | /* Fields Quarks */ |
89 | |
90 | extern GQuark |
91 | LTT_FIELD_SYSCALL_ID, |
92 | LTT_FIELD_TRAP_ID, |
93 | LTT_FIELD_IRQ_ID, |
faf074a3 |
94 | LTT_FIELD_SOFT_IRQ_ID, |
eed2ef37 |
95 | LTT_FIELD_OUT, |
96 | LTT_FIELD_IN, |
97 | LTT_FIELD_OUT_STATE, |
98 | LTT_FIELD_PARENT_PID, |
99 | LTT_FIELD_CHILD_PID, |
f4b88a7d |
100 | LTT_FIELD_PID, |
fcc08e1e |
101 | LTT_FIELD_TGID, |
b3fd4c02 |
102 | LTT_FIELD_FILENAME, |
103 | LTT_FIELD_NAME, |
e62e7f3a |
104 | LTT_FIELD_TYPE, |
b3fd4c02 |
105 | LTT_FIELD_MODE, |
106 | LTT_FIELD_SUBMODE, |
14236daa |
107 | LTT_FIELD_STATUS, |
80e0221b |
108 | LTT_FIELD_THIS_FN, |
109 | LTT_FIELD_CALL_SITE; |
eed2ef37 |
110 | |
ffd54a90 |
111 | typedef struct _LttvTracesetState LttvTracesetState; |
112 | typedef struct _LttvTracesetStateClass LttvTracesetStateClass; |
113 | |
114 | typedef struct _LttvTraceState LttvTraceState; |
115 | typedef struct _LttvTraceStateClass LttvTraceStateClass; |
116 | |
117 | typedef struct _LttvTracefileState LttvTracefileState; |
118 | typedef struct _LttvTracefileStateClass LttvTracefileStateClass; |
119 | |
58c88a41 |
120 | gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data); |
308711e5 |
121 | void lttv_state_add_event_hooks(LttvTracesetState *self); |
122 | |
58c88a41 |
123 | gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
124 | void lttv_state_remove_event_hooks(LttvTracesetState *self); |
125 | |
126 | void lttv_state_save_add_event_hooks(LttvTracesetState *self); |
b56b5fec |
127 | // Hook wrapper. call_data is a trace context. |
128 | gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data); |
dc877563 |
129 | |
308711e5 |
130 | void lttv_state_save_remove_event_hooks(LttvTracesetState *self); |
b56b5fec |
131 | // Hook wrapper. call_data is a trace context. |
132 | gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
133 | |
dd025f91 |
134 | void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t); |
dc877563 |
135 | |
b445142a |
136 | /* The LttvProcessState structure defines the current state for each process. |
137 | A process can make system calls (in some rare cases nested) and receive |
138 | interrupts/faults. For instance, a process may issue a system call, |
139 | generate a page fault while reading an argument from user space, and |
140 | get caught by an interrupt. To represent these nested states, an |
141 | execution mode stack is maintained. The stack bottom is normal user mode |
142 | and the top of stack is the current execution mode. |
143 | |
144 | The execution mode stack tells about the process status, execution mode and |
145 | submode (interrupt, system call or IRQ number). All these could be |
146 | defined as enumerations but may need extensions (e.g. new process state). |
147 | GQuark are thus used. They are as easy to manipulate as integers but have |
148 | a string associated, just like enumerations. |
dc877563 |
149 | |
b445142a |
150 | The execution mode is one of "user mode", "kernel thread", "system call", |
dc877563 |
151 | "interrupt request", "fault". */ |
152 | |
b445142a |
153 | typedef GQuark LttvExecutionMode; |
dc877563 |
154 | |
b445142a |
155 | extern LttvExecutionMode |
ffd54a90 |
156 | LTTV_STATE_USER_MODE, |
157 | LTTV_STATE_SYSCALL, |
158 | LTTV_STATE_TRAP, |
b445142a |
159 | LTTV_STATE_IRQ, |
faf074a3 |
160 | LTTV_STATE_SOFT_IRQ, |
b445142a |
161 | LTTV_STATE_MODE_UNKNOWN; |
ffd54a90 |
162 | |
dc877563 |
163 | |
b445142a |
164 | /* The submode number depends on the execution mode. For user mode or kernel |
165 | thread, which are the normal mode (execution mode stack bottom), |
166 | it is set to "none". For interrupt requests, faults and system calls, |
167 | it is set respectively to the interrupt name (e.g. "timer"), fault name |
996acd92 |
168 | (e.g. "page fault"), and system call name (e.g. "select"). */ |
dc877563 |
169 | |
b445142a |
170 | typedef GQuark LttvExecutionSubmode; |
dc877563 |
171 | |
b445142a |
172 | extern LttvExecutionSubmode |
173 | LTTV_STATE_SUBMODE_NONE, |
174 | LTTV_STATE_SUBMODE_UNKNOWN; |
dc877563 |
175 | |
176 | /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*" |
177 | where "*" describes the resource waited for (e.g. timer, process, |
178 | disk...). */ |
179 | |
180 | typedef GQuark LttvProcessStatus; |
181 | |
ffd54a90 |
182 | extern LttvProcessStatus |
183 | LTTV_STATE_UNNAMED, |
7b5f6cf1 |
184 | LTTV_STATE_UNBRANDED, |
ffd54a90 |
185 | LTTV_STATE_WAIT_FORK, |
186 | LTTV_STATE_WAIT_CPU, |
dbd243b1 |
187 | LTTV_STATE_EXIT, |
0828099d |
188 | LTTV_STATE_ZOMBIE, |
ffd54a90 |
189 | LTTV_STATE_WAIT, |
791dffa6 |
190 | LTTV_STATE_RUN, |
191 | LTTV_STATE_DEAD; |
dc877563 |
192 | |
e62e7f3a |
193 | typedef GQuark LttvProcessType; |
194 | |
195 | extern LttvProcessType |
196 | LTTV_STATE_USER_THREAD, |
80e0221b |
197 | LTTV_STATE_KERNEL_THREAD; |
ffd54a90 |
198 | |
b445142a |
199 | typedef struct _LttvExecutionState { |
200 | LttvExecutionMode t; |
201 | LttvExecutionSubmode n; |
ba576a78 |
202 | LttTime entry; |
b445142a |
203 | LttTime change; |
80e0221b |
204 | LttTime cum_cpu_time; |
dc877563 |
205 | LttvProcessStatus s; |
b445142a |
206 | } LttvExecutionState; |
dc877563 |
207 | |
dc877563 |
208 | typedef struct _LttvProcessState { |
209 | guint pid; |
fcc08e1e |
210 | guint tgid; |
3e561027 |
211 | guint ppid; |
b445142a |
212 | LttTime creation_time; |
2a2fa4f0 |
213 | LttTime insertion_time; |
dc877563 |
214 | GQuark name; |
7b5f6cf1 |
215 | GQuark brand; |
b445142a |
216 | GQuark pid_time; |
217 | GArray *execution_stack; /* Array of LttvExecutionState */ |
218 | LttvExecutionState *state; /* Top of interrupt stack */ |
e05fc742 |
219 | /* WARNING : each time the execution_stack size is modified, the state |
220 | * must be reget : g_array_set_size can have to move the array. |
221 | * (Mathieu) */ |
348c6ba8 |
222 | guint cpu; /* CPU where process is scheduled (being either in |
223 | the active or inactive runqueue)*/ |
224 | // guint last_tracefile_index; /* index in the trace for cpu tracefile */ |
80e0221b |
225 | LttvTracefileState *usertrace; /* Associated usertrace */ |
b445142a |
226 | /* opened file descriptors, address map?... */ |
80e0221b |
227 | GArray *user_stack; /* User space function call stack */ |
228 | guint64 current_function; |
229 | LttvProcessType type; /* kernel thread or user space ? */ |
33bdc8dd |
230 | guint target_pid; /* target PID of the current event. */ |
dc877563 |
231 | } LttvProcessState; |
232 | |
348c6ba8 |
233 | #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for |
234 | a PID != 0 will search on any cpu automatically. */ |
235 | |
2a2fa4f0 |
236 | LttvProcessState * |
348c6ba8 |
237 | lttv_state_find_process(LttvTraceState *ts, guint cpu, guint pid); |
2a2fa4f0 |
238 | |
2a2fa4f0 |
239 | LttvProcessState * |
348c6ba8 |
240 | lttv_state_find_process_or_create(LttvTraceState *ts, guint cpu, guint pid, |
d41c66bf |
241 | const LttTime *timestamp); |
2a2fa4f0 |
242 | |
243 | LttvProcessState * |
b3fd4c02 |
244 | lttv_state_create_process(LttvTraceState *tcs, LttvProcessState *parent, |
fcc08e1e |
245 | guint cpu, guint pid, guint tgid, GQuark name, const LttTime *timestamp); |
b445142a |
246 | |
dbb7bb09 |
247 | void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp); |
6d0cdf22 |
248 | void lttv_state_write_raw(LttvTraceState *self, LttTime t, FILE *fp); |
b445142a |
249 | |
ffd54a90 |
250 | /* The LttvTracesetState, LttvTraceState and LttvTracefileState types |
dc877563 |
251 | inherit from the corresponding Context objects defined in processTrace. */ |
252 | |
253 | #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ()) |
ffd54a90 |
254 | #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState)) |
255 | #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
256 | #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE)) |
257 | #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE)) |
ffd54a90 |
258 | #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
259 | |
ffd54a90 |
260 | struct _LttvTracesetState { |
261 | LttvTracesetContext parent; |
dc877563 |
262 | }; |
263 | |
264 | struct _LttvTracesetStateClass { |
ffd54a90 |
265 | LttvTracesetContextClass parent; |
dc877563 |
266 | }; |
267 | |
268 | GType lttv_traceset_state_get_type (void); |
269 | |
270 | |
271 | #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ()) |
272 | #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState)) |
273 | #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
274 | #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE)) |
275 | #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE)) |
276 | #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
277 | |
dc877563 |
278 | struct _LttvTraceState { |
279 | LttvTraceContext parent; |
280 | |
00e74b69 |
281 | GHashTable *processes; /* LttvProcessState objects indexed by pid and |
282 | last_cpu */ |
80e0221b |
283 | GHashTable *usertraces; /* GPtrArray objects indexed by pid, containing |
284 | pointers to LttvTracefileState objects. */ |
308711e5 |
285 | guint nb_event, save_interval; |
dc877563 |
286 | /* Block/char devices, locks, memory pages... */ |
b445142a |
287 | GQuark *eventtype_names; |
288 | GQuark *syscall_names; |
5e96e7e3 |
289 | guint nb_syscalls; |
b445142a |
290 | GQuark *trap_names; |
5e96e7e3 |
291 | guint nb_traps; |
b445142a |
292 | GQuark *irq_names; |
faf074a3 |
293 | GQuark *soft_irq_names; |
2a2fa4f0 |
294 | LttTime *max_time_state_recomputed_in_seek; |
348c6ba8 |
295 | |
296 | /* Array of per cpu running process */ |
297 | LttvProcessState **running_process; |
dc877563 |
298 | }; |
299 | |
300 | struct _LttvTraceStateClass { |
301 | LttvTraceContextClass parent; |
308711e5 |
302 | |
303 | void (*state_save) (LttvTraceState *self, LttvAttribute *container); |
304 | void (*state_restore) (LttvTraceState *self, LttvAttribute *container); |
305 | void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container); |
dc877563 |
306 | }; |
307 | |
308 | GType lttv_trace_state_get_type (void); |
309 | |
308711e5 |
310 | void lttv_state_save(LttvTraceState *self, LttvAttribute *container); |
311 | |
312 | void lttv_state_restore(LttvTraceState *self, LttvAttribute *container); |
313 | |
f95bc830 |
314 | void lttv_state_state_saved_free(LttvTraceState *self, |
308711e5 |
315 | LttvAttribute *container); |
316 | |
b49e54b4 |
317 | int lttv_state_pop_state_cleanup(LttvProcessState *process, |
80e0221b |
318 | LttvTracefileState *tfs); |
dc877563 |
319 | |
320 | #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ()) |
321 | #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState)) |
322 | #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
323 | #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE)) |
324 | #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE)) |
325 | #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
326 | |
dc877563 |
327 | struct _LttvTracefileState { |
328 | LttvTracefileContext parent; |
329 | |
348c6ba8 |
330 | //LttvProcessState *process; |
331 | GQuark tracefile_name; |
80e0221b |
332 | guint cpu; /* Current cpu of the tracefile */ |
eed2ef37 |
333 | // guint saved_position; |
dc877563 |
334 | }; |
335 | |
336 | struct _LttvTracefileStateClass { |
337 | LttvTracefileContextClass parent; |
338 | }; |
339 | |
340 | GType lttv_tracefile_state_get_type (void); |
341 | |
33bdc8dd |
342 | static inline guint lttv_state_get_target_pid(LttvTracefileState *tfs) |
343 | { |
344 | LttvTraceState *ts = (LttvTraceState*)tfs->parent.t_context; |
345 | guint cpu = tfs->cpu; |
346 | LttvProcessState *process = ts->running_process[cpu]; |
347 | |
e38d9ea0 |
348 | if(tfs->parent.target_pid >= 0) return tfs->parent.target_pid; |
33bdc8dd |
349 | else return process->pid; |
350 | } |
351 | |
dc877563 |
352 | |
6d0cdf22 |
353 | #define HDR_PROCESS 0 |
354 | #define HDR_ES 1 |
355 | #define HDR_USER_STACK 2 |
356 | #define HDR_USERTRACE 3 |
357 | #define HDR_PROCESS_STATE 4 |
358 | #define HDR_CPU 5 |
359 | #define HDR_TRACEFILE 6 |
360 | #define HDR_TRACESET 7 |
361 | #define HDR_TRACE 8 |
362 | #define HDR_QUARKS 9 |
363 | #define HDR_QUARK 10 |
364 | |
365 | |
366 | |
b445142a |
367 | #endif // STATE_H |