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, |
14236daa |
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, |
14236daa |
83 | LTT_EVENT_ENUM_PROCESS_STATE, |
84 | LTT_EVENT_FUNCTION_ENTRY, |
85 | LTT_EVENT_FUNCTION_EXIT; |
eed2ef37 |
86 | |
87 | /* Fields Quarks */ |
88 | |
89 | extern GQuark |
90 | LTT_FIELD_SYSCALL_ID, |
91 | LTT_FIELD_TRAP_ID, |
92 | LTT_FIELD_IRQ_ID, |
faf074a3 |
93 | LTT_FIELD_SOFT_IRQ_ID, |
eed2ef37 |
94 | LTT_FIELD_OUT, |
95 | LTT_FIELD_IN, |
96 | LTT_FIELD_OUT_STATE, |
97 | LTT_FIELD_PARENT_PID, |
98 | LTT_FIELD_CHILD_PID, |
f4b88a7d |
99 | LTT_FIELD_PID, |
b3fd4c02 |
100 | LTT_FIELD_FILENAME, |
101 | LTT_FIELD_NAME, |
e62e7f3a |
102 | LTT_FIELD_TYPE, |
b3fd4c02 |
103 | LTT_FIELD_MODE, |
104 | LTT_FIELD_SUBMODE, |
14236daa |
105 | LTT_FIELD_STATUS, |
106 | LTT_FIELD_THIS_FN, |
107 | LTT_FIELD_CALL_SITE; |
eed2ef37 |
108 | |
ffd54a90 |
109 | typedef struct _LttvTracesetState LttvTracesetState; |
110 | typedef struct _LttvTracesetStateClass LttvTracesetStateClass; |
111 | |
112 | typedef struct _LttvTraceState LttvTraceState; |
113 | typedef struct _LttvTraceStateClass LttvTraceStateClass; |
114 | |
115 | typedef struct _LttvTracefileState LttvTracefileState; |
116 | typedef struct _LttvTracefileStateClass LttvTracefileStateClass; |
117 | |
58c88a41 |
118 | gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data); |
308711e5 |
119 | void lttv_state_add_event_hooks(LttvTracesetState *self); |
120 | |
58c88a41 |
121 | gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
122 | void lttv_state_remove_event_hooks(LttvTracesetState *self); |
123 | |
124 | void lttv_state_save_add_event_hooks(LttvTracesetState *self); |
b56b5fec |
125 | // Hook wrapper. call_data is a trace context. |
126 | gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data); |
dc877563 |
127 | |
308711e5 |
128 | void lttv_state_save_remove_event_hooks(LttvTracesetState *self); |
b56b5fec |
129 | // Hook wrapper. call_data is a trace context. |
130 | gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
131 | |
dd025f91 |
132 | void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t); |
dc877563 |
133 | |
b445142a |
134 | /* The LttvProcessState structure defines the current state for each process. |
135 | A process can make system calls (in some rare cases nested) and receive |
136 | interrupts/faults. For instance, a process may issue a system call, |
137 | generate a page fault while reading an argument from user space, and |
138 | get caught by an interrupt. To represent these nested states, an |
139 | execution mode stack is maintained. The stack bottom is normal user mode |
140 | and the top of stack is the current execution mode. |
141 | |
142 | The execution mode stack tells about the process status, execution mode and |
143 | submode (interrupt, system call or IRQ number). All these could be |
144 | defined as enumerations but may need extensions (e.g. new process state). |
145 | GQuark are thus used. They are as easy to manipulate as integers but have |
146 | a string associated, just like enumerations. |
dc877563 |
147 | |
b445142a |
148 | The execution mode is one of "user mode", "kernel thread", "system call", |
dc877563 |
149 | "interrupt request", "fault". */ |
150 | |
b445142a |
151 | typedef GQuark LttvExecutionMode; |
dc877563 |
152 | |
b445142a |
153 | extern LttvExecutionMode |
ffd54a90 |
154 | LTTV_STATE_USER_MODE, |
155 | LTTV_STATE_SYSCALL, |
156 | LTTV_STATE_TRAP, |
b445142a |
157 | LTTV_STATE_IRQ, |
faf074a3 |
158 | LTTV_STATE_SOFT_IRQ, |
b445142a |
159 | LTTV_STATE_MODE_UNKNOWN; |
ffd54a90 |
160 | |
dc877563 |
161 | |
b445142a |
162 | /* The submode number depends on the execution mode. For user mode or kernel |
163 | thread, which are the normal mode (execution mode stack bottom), |
164 | it is set to "none". For interrupt requests, faults and system calls, |
165 | it is set respectively to the interrupt name (e.g. "timer"), fault name |
996acd92 |
166 | (e.g. "page fault"), and system call name (e.g. "select"). */ |
dc877563 |
167 | |
b445142a |
168 | typedef GQuark LttvExecutionSubmode; |
dc877563 |
169 | |
b445142a |
170 | extern LttvExecutionSubmode |
171 | LTTV_STATE_SUBMODE_NONE, |
172 | LTTV_STATE_SUBMODE_UNKNOWN; |
dc877563 |
173 | |
174 | /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*" |
175 | where "*" describes the resource waited for (e.g. timer, process, |
176 | disk...). */ |
177 | |
178 | typedef GQuark LttvProcessStatus; |
179 | |
ffd54a90 |
180 | extern LttvProcessStatus |
181 | LTTV_STATE_UNNAMED, |
182 | LTTV_STATE_WAIT_FORK, |
183 | LTTV_STATE_WAIT_CPU, |
dbd243b1 |
184 | LTTV_STATE_EXIT, |
0828099d |
185 | LTTV_STATE_ZOMBIE, |
ffd54a90 |
186 | LTTV_STATE_WAIT, |
791dffa6 |
187 | LTTV_STATE_RUN, |
188 | LTTV_STATE_DEAD; |
dc877563 |
189 | |
e62e7f3a |
190 | typedef GQuark LttvProcessType; |
191 | |
192 | extern LttvProcessType |
193 | LTTV_STATE_USER_THREAD, |
194 | LTTV_STATE_KERNEL_THREAD; |
ffd54a90 |
195 | |
b445142a |
196 | typedef struct _LttvExecutionState { |
197 | LttvExecutionMode t; |
198 | LttvExecutionSubmode n; |
ba576a78 |
199 | LttTime entry; |
b445142a |
200 | LttTime change; |
b49e54b4 |
201 | LttTime cum_cpu_time; |
dc877563 |
202 | LttvProcessStatus s; |
b445142a |
203 | } LttvExecutionState; |
dc877563 |
204 | |
dc877563 |
205 | typedef struct _LttvProcessState { |
206 | guint pid; |
3e561027 |
207 | guint ppid; |
b445142a |
208 | LttTime creation_time; |
2a2fa4f0 |
209 | LttTime insertion_time; |
dc877563 |
210 | GQuark name; |
b445142a |
211 | GQuark pid_time; |
212 | GArray *execution_stack; /* Array of LttvExecutionState */ |
213 | LttvExecutionState *state; /* Top of interrupt stack */ |
e05fc742 |
214 | /* WARNING : each time the execution_stack size is modified, the state |
215 | * must be reget : g_array_set_size can have to move the array. |
216 | * (Mathieu) */ |
348c6ba8 |
217 | guint cpu; /* CPU where process is scheduled (being either in |
218 | the active or inactive runqueue)*/ |
219 | // guint last_tracefile_index; /* index in the trace for cpu tracefile */ |
ae3d0f50 |
220 | LttvTracefileState *usertrace; /* Associated usertrace */ |
b445142a |
221 | /* opened file descriptors, address map?... */ |
302efbad |
222 | GArray *user_stack; /* User space function call stack */ |
223 | guint64 current_function; |
e62e7f3a |
224 | LttvProcessType type; /* kernel thread or user space ? */ |
dc877563 |
225 | } LttvProcessState; |
226 | |
348c6ba8 |
227 | #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for |
228 | a PID != 0 will search on any cpu automatically. */ |
229 | |
2a2fa4f0 |
230 | LttvProcessState * |
348c6ba8 |
231 | lttv_state_find_process(LttvTraceState *ts, guint cpu, guint pid); |
2a2fa4f0 |
232 | |
2a2fa4f0 |
233 | LttvProcessState * |
348c6ba8 |
234 | lttv_state_find_process_or_create(LttvTraceState *ts, guint cpu, guint pid, |
235 | LttTime *timestamp); |
2a2fa4f0 |
236 | |
237 | LttvProcessState * |
b3fd4c02 |
238 | lttv_state_create_process(LttvTraceState *tcs, LttvProcessState *parent, |
239 | guint cpu, guint pid, GQuark name, const LttTime *timestamp); |
b445142a |
240 | |
dbb7bb09 |
241 | void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp); |
b445142a |
242 | |
ffd54a90 |
243 | /* The LttvTracesetState, LttvTraceState and LttvTracefileState types |
dc877563 |
244 | inherit from the corresponding Context objects defined in processTrace. */ |
245 | |
246 | #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ()) |
ffd54a90 |
247 | #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState)) |
248 | #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
249 | #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE)) |
250 | #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE)) |
ffd54a90 |
251 | #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
252 | |
ffd54a90 |
253 | struct _LttvTracesetState { |
254 | LttvTracesetContext parent; |
dc877563 |
255 | }; |
256 | |
257 | struct _LttvTracesetStateClass { |
ffd54a90 |
258 | LttvTracesetContextClass parent; |
dc877563 |
259 | }; |
260 | |
261 | GType lttv_traceset_state_get_type (void); |
262 | |
263 | |
264 | #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ()) |
265 | #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState)) |
266 | #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
267 | #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE)) |
268 | #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE)) |
269 | #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
270 | |
dc877563 |
271 | struct _LttvTraceState { |
272 | LttvTraceContext parent; |
273 | |
00e74b69 |
274 | GHashTable *processes; /* LttvProcessState objects indexed by pid and |
275 | last_cpu */ |
6806b3c6 |
276 | GHashTable *usertraces; /* GPtrArray objects indexed by pid, containing |
277 | pointers to LttvTracefileState objects. */ |
308711e5 |
278 | guint nb_event, save_interval; |
dc877563 |
279 | /* Block/char devices, locks, memory pages... */ |
b445142a |
280 | GQuark *eventtype_names; |
281 | GQuark *syscall_names; |
7cd289b0 |
282 | guint nb_syscalls; |
b445142a |
283 | GQuark *trap_names; |
284 | GQuark *irq_names; |
faf074a3 |
285 | GQuark *soft_irq_names; |
2a2fa4f0 |
286 | LttTime *max_time_state_recomputed_in_seek; |
348c6ba8 |
287 | |
288 | /* Array of per cpu running process */ |
289 | LttvProcessState **running_process; |
dc877563 |
290 | }; |
291 | |
292 | struct _LttvTraceStateClass { |
293 | LttvTraceContextClass parent; |
308711e5 |
294 | |
295 | void (*state_save) (LttvTraceState *self, LttvAttribute *container); |
296 | void (*state_restore) (LttvTraceState *self, LttvAttribute *container); |
297 | void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container); |
dc877563 |
298 | }; |
299 | |
300 | GType lttv_trace_state_get_type (void); |
301 | |
308711e5 |
302 | void lttv_state_save(LttvTraceState *self, LttvAttribute *container); |
303 | |
304 | void lttv_state_restore(LttvTraceState *self, LttvAttribute *container); |
305 | |
f95bc830 |
306 | void lttv_state_state_saved_free(LttvTraceState *self, |
308711e5 |
307 | LttvAttribute *container); |
308 | |
b49e54b4 |
309 | int lttv_state_pop_state_cleanup(LttvProcessState *process, |
310 | LttvTracefileState *tfs); |
dc877563 |
311 | |
312 | #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ()) |
313 | #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState)) |
314 | #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
315 | #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE)) |
316 | #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE)) |
317 | #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
318 | |
dc877563 |
319 | struct _LttvTracefileState { |
320 | LttvTracefileContext parent; |
321 | |
348c6ba8 |
322 | //LttvProcessState *process; |
323 | GQuark tracefile_name; |
ae3d0f50 |
324 | guint cpu; /* Current cpu of the tracefile */ |
eed2ef37 |
325 | // guint saved_position; |
dc877563 |
326 | }; |
327 | |
328 | struct _LttvTracefileStateClass { |
329 | LttvTracefileContextClass parent; |
330 | }; |
331 | |
332 | GType lttv_tracefile_state_get_type (void); |
333 | |
334 | |
b445142a |
335 | #endif // STATE_H |