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, |
c3b3b60b |
84 | LTT_EVENT_STATEDUMP_END, |
80e0221b |
85 | LTT_EVENT_FUNCTION_ENTRY, |
86 | LTT_EVENT_FUNCTION_EXIT, |
87 | LTT_EVENT_THREAD_BRAND; |
eed2ef37 |
88 | |
89 | /* Fields Quarks */ |
90 | |
91 | extern GQuark |
92 | LTT_FIELD_SYSCALL_ID, |
93 | LTT_FIELD_TRAP_ID, |
94 | LTT_FIELD_IRQ_ID, |
faf074a3 |
95 | LTT_FIELD_SOFT_IRQ_ID, |
eed2ef37 |
96 | LTT_FIELD_OUT, |
97 | LTT_FIELD_IN, |
98 | LTT_FIELD_OUT_STATE, |
99 | LTT_FIELD_PARENT_PID, |
100 | LTT_FIELD_CHILD_PID, |
f4b88a7d |
101 | LTT_FIELD_PID, |
fcc08e1e |
102 | LTT_FIELD_TGID, |
b3fd4c02 |
103 | LTT_FIELD_FILENAME, |
104 | LTT_FIELD_NAME, |
e62e7f3a |
105 | LTT_FIELD_TYPE, |
b3fd4c02 |
106 | LTT_FIELD_MODE, |
107 | LTT_FIELD_SUBMODE, |
14236daa |
108 | LTT_FIELD_STATUS, |
80e0221b |
109 | LTT_FIELD_THIS_FN, |
110 | LTT_FIELD_CALL_SITE; |
eed2ef37 |
111 | |
ffd54a90 |
112 | typedef struct _LttvTracesetState LttvTracesetState; |
113 | typedef struct _LttvTracesetStateClass LttvTracesetStateClass; |
114 | |
115 | typedef struct _LttvTraceState LttvTraceState; |
116 | typedef struct _LttvTraceStateClass LttvTraceStateClass; |
117 | |
118 | typedef struct _LttvTracefileState LttvTracefileState; |
119 | typedef struct _LttvTracefileStateClass LttvTracefileStateClass; |
120 | |
58c88a41 |
121 | gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data); |
308711e5 |
122 | void lttv_state_add_event_hooks(LttvTracesetState *self); |
123 | |
58c88a41 |
124 | gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
125 | void lttv_state_remove_event_hooks(LttvTracesetState *self); |
126 | |
127 | void lttv_state_save_add_event_hooks(LttvTracesetState *self); |
b56b5fec |
128 | // Hook wrapper. call_data is a trace context. |
129 | gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data); |
dc877563 |
130 | |
308711e5 |
131 | void lttv_state_save_remove_event_hooks(LttvTracesetState *self); |
b56b5fec |
132 | // Hook wrapper. call_data is a trace context. |
133 | gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
134 | |
dd025f91 |
135 | void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t); |
dc877563 |
136 | |
b445142a |
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. |
144 | |
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. |
dc877563 |
150 | |
b445142a |
151 | The execution mode is one of "user mode", "kernel thread", "system call", |
dc877563 |
152 | "interrupt request", "fault". */ |
153 | |
b445142a |
154 | typedef GQuark LttvExecutionMode; |
dc877563 |
155 | |
b445142a |
156 | extern LttvExecutionMode |
ffd54a90 |
157 | LTTV_STATE_USER_MODE, |
158 | LTTV_STATE_SYSCALL, |
159 | LTTV_STATE_TRAP, |
b445142a |
160 | LTTV_STATE_IRQ, |
faf074a3 |
161 | LTTV_STATE_SOFT_IRQ, |
b445142a |
162 | LTTV_STATE_MODE_UNKNOWN; |
ffd54a90 |
163 | |
dc877563 |
164 | |
b445142a |
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 |
996acd92 |
169 | (e.g. "page fault"), and system call name (e.g. "select"). */ |
dc877563 |
170 | |
b445142a |
171 | typedef GQuark LttvExecutionSubmode; |
dc877563 |
172 | |
b445142a |
173 | extern LttvExecutionSubmode |
174 | LTTV_STATE_SUBMODE_NONE, |
175 | LTTV_STATE_SUBMODE_UNKNOWN; |
dc877563 |
176 | |
177 | /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*" |
178 | where "*" describes the resource waited for (e.g. timer, process, |
179 | disk...). */ |
180 | |
181 | typedef GQuark LttvProcessStatus; |
182 | |
ffd54a90 |
183 | extern LttvProcessStatus |
184 | LTTV_STATE_UNNAMED, |
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 | |
c4a72569 |
193 | extern GQuark |
194 | LTTV_STATE_UNBRANDED; |
195 | |
e62e7f3a |
196 | typedef GQuark LttvProcessType; |
197 | |
198 | extern LttvProcessType |
199 | LTTV_STATE_USER_THREAD, |
80e0221b |
200 | LTTV_STATE_KERNEL_THREAD; |
ffd54a90 |
201 | |
b445142a |
202 | typedef struct _LttvExecutionState { |
203 | LttvExecutionMode t; |
204 | LttvExecutionSubmode n; |
ba576a78 |
205 | LttTime entry; |
b445142a |
206 | LttTime change; |
80e0221b |
207 | LttTime cum_cpu_time; |
dc877563 |
208 | LttvProcessStatus s; |
b445142a |
209 | } LttvExecutionState; |
dc877563 |
210 | |
dc877563 |
211 | typedef struct _LttvProcessState { |
212 | guint pid; |
fcc08e1e |
213 | guint tgid; |
3e561027 |
214 | guint ppid; |
b445142a |
215 | LttTime creation_time; |
2a2fa4f0 |
216 | LttTime insertion_time; |
dc877563 |
217 | GQuark name; |
7b5f6cf1 |
218 | GQuark brand; |
b445142a |
219 | GQuark pid_time; |
220 | GArray *execution_stack; /* Array of LttvExecutionState */ |
221 | LttvExecutionState *state; /* Top of interrupt stack */ |
e05fc742 |
222 | /* WARNING : each time the execution_stack size is modified, the state |
223 | * must be reget : g_array_set_size can have to move the array. |
224 | * (Mathieu) */ |
348c6ba8 |
225 | guint cpu; /* CPU where process is scheduled (being either in |
226 | the active or inactive runqueue)*/ |
227 | // guint last_tracefile_index; /* index in the trace for cpu tracefile */ |
80e0221b |
228 | LttvTracefileState *usertrace; /* Associated usertrace */ |
b445142a |
229 | /* opened file descriptors, address map?... */ |
80e0221b |
230 | GArray *user_stack; /* User space function call stack */ |
231 | guint64 current_function; |
232 | LttvProcessType type; /* kernel thread or user space ? */ |
33bdc8dd |
233 | guint target_pid; /* target PID of the current event. */ |
dc877563 |
234 | } LttvProcessState; |
235 | |
348c6ba8 |
236 | #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for |
237 | a PID != 0 will search on any cpu automatically. */ |
238 | |
2a2fa4f0 |
239 | LttvProcessState * |
348c6ba8 |
240 | lttv_state_find_process(LttvTraceState *ts, guint cpu, guint pid); |
2a2fa4f0 |
241 | |
2a2fa4f0 |
242 | LttvProcessState * |
348c6ba8 |
243 | lttv_state_find_process_or_create(LttvTraceState *ts, guint cpu, guint pid, |
d41c66bf |
244 | const LttTime *timestamp); |
2a2fa4f0 |
245 | |
246 | LttvProcessState * |
b3fd4c02 |
247 | lttv_state_create_process(LttvTraceState *tcs, LttvProcessState *parent, |
fcc08e1e |
248 | guint cpu, guint pid, guint tgid, GQuark name, const LttTime *timestamp); |
b445142a |
249 | |
dbb7bb09 |
250 | void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp); |
6d0cdf22 |
251 | void lttv_state_write_raw(LttvTraceState *self, LttTime t, FILE *fp); |
b445142a |
252 | |
ffd54a90 |
253 | /* The LttvTracesetState, LttvTraceState and LttvTracefileState types |
dc877563 |
254 | inherit from the corresponding Context objects defined in processTrace. */ |
255 | |
256 | #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ()) |
ffd54a90 |
257 | #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState)) |
258 | #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
259 | #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE)) |
260 | #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE)) |
ffd54a90 |
261 | #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
262 | |
ffd54a90 |
263 | struct _LttvTracesetState { |
264 | LttvTracesetContext parent; |
dc877563 |
265 | }; |
266 | |
267 | struct _LttvTracesetStateClass { |
ffd54a90 |
268 | LttvTracesetContextClass parent; |
dc877563 |
269 | }; |
270 | |
271 | GType lttv_traceset_state_get_type (void); |
272 | |
273 | |
274 | #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ()) |
275 | #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState)) |
276 | #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
277 | #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE)) |
278 | #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE)) |
279 | #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
280 | |
dc877563 |
281 | struct _LttvTraceState { |
282 | LttvTraceContext parent; |
283 | |
00e74b69 |
284 | GHashTable *processes; /* LttvProcessState objects indexed by pid and |
285 | last_cpu */ |
80e0221b |
286 | GHashTable *usertraces; /* GPtrArray objects indexed by pid, containing |
287 | pointers to LttvTracefileState objects. */ |
308711e5 |
288 | guint nb_event, save_interval; |
dc877563 |
289 | /* Block/char devices, locks, memory pages... */ |
b445142a |
290 | GQuark *eventtype_names; |
291 | GQuark *syscall_names; |
5e96e7e3 |
292 | guint nb_syscalls; |
b445142a |
293 | GQuark *trap_names; |
5e96e7e3 |
294 | guint nb_traps; |
6214c229 |
295 | guint nb_irqs; |
296 | guint nb_softirqs; |
b445142a |
297 | GQuark *irq_names; |
faf074a3 |
298 | GQuark *soft_irq_names; |
2a2fa4f0 |
299 | LttTime *max_time_state_recomputed_in_seek; |
348c6ba8 |
300 | |
301 | /* Array of per cpu running process */ |
302 | LttvProcessState **running_process; |
7df20ca4 |
303 | gboolean has_precomputed_states; |
dc877563 |
304 | }; |
305 | |
306 | struct _LttvTraceStateClass { |
307 | LttvTraceContextClass parent; |
308711e5 |
308 | |
309 | void (*state_save) (LttvTraceState *self, LttvAttribute *container); |
310 | void (*state_restore) (LttvTraceState *self, LttvAttribute *container); |
311 | void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container); |
dc877563 |
312 | }; |
313 | |
314 | GType lttv_trace_state_get_type (void); |
315 | |
308711e5 |
316 | void lttv_state_save(LttvTraceState *self, LttvAttribute *container); |
317 | |
318 | void lttv_state_restore(LttvTraceState *self, LttvAttribute *container); |
319 | |
f95bc830 |
320 | void lttv_state_state_saved_free(LttvTraceState *self, |
308711e5 |
321 | LttvAttribute *container); |
322 | |
b49e54b4 |
323 | int lttv_state_pop_state_cleanup(LttvProcessState *process, |
80e0221b |
324 | LttvTracefileState *tfs); |
dc877563 |
325 | |
326 | #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ()) |
327 | #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState)) |
328 | #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
329 | #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE)) |
330 | #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE)) |
331 | #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
332 | |
dc877563 |
333 | struct _LttvTracefileState { |
334 | LttvTracefileContext parent; |
335 | |
348c6ba8 |
336 | //LttvProcessState *process; |
337 | GQuark tracefile_name; |
80e0221b |
338 | guint cpu; /* Current cpu of the tracefile */ |
eed2ef37 |
339 | // guint saved_position; |
dc877563 |
340 | }; |
341 | |
342 | struct _LttvTracefileStateClass { |
343 | LttvTracefileContextClass parent; |
344 | }; |
345 | |
346 | GType lttv_tracefile_state_get_type (void); |
347 | |
33bdc8dd |
348 | static inline guint lttv_state_get_target_pid(LttvTracefileState *tfs) |
349 | { |
350 | LttvTraceState *ts = (LttvTraceState*)tfs->parent.t_context; |
351 | guint cpu = tfs->cpu; |
352 | LttvProcessState *process = ts->running_process[cpu]; |
353 | |
e38d9ea0 |
354 | if(tfs->parent.target_pid >= 0) return tfs->parent.target_pid; |
33bdc8dd |
355 | else return process->pid; |
356 | } |
357 | |
dc877563 |
358 | |
6d0cdf22 |
359 | #define HDR_PROCESS 0 |
360 | #define HDR_ES 1 |
361 | #define HDR_USER_STACK 2 |
362 | #define HDR_USERTRACE 3 |
363 | #define HDR_PROCESS_STATE 4 |
364 | #define HDR_CPU 5 |
365 | #define HDR_TRACEFILE 6 |
366 | #define HDR_TRACESET 7 |
367 | #define HDR_TRACE 8 |
368 | #define HDR_QUARKS 9 |
369 | #define HDR_QUARK 10 |
370 | |
371 | |
372 | |
b445142a |
373 | #endif // STATE_H |