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, |
60 | LTT_FACILITY_PROCESS; |
61 | |
62 | /* Events Quarks */ |
63 | |
64 | extern GQuark |
65 | LTT_EVENT_SYSCALL_ENTRY, |
66 | LTT_EVENT_SYSCALL_EXIT, |
67 | LTT_EVENT_TRAP_ENTRY, |
68 | LTT_EVENT_TRAP_EXIT, |
69 | LTT_EVENT_IRQ_ENTRY, |
70 | LTT_EVENT_IRQ_EXIT, |
71 | LTT_EVENT_SCHEDCHANGE, |
72 | LTT_EVENT_FORK, |
73 | LTT_EVENT_EXIT, |
74 | LTT_EVENT_FREE; |
75 | |
76 | /* Fields Quarks */ |
77 | |
78 | extern GQuark |
79 | LTT_FIELD_SYSCALL_ID, |
80 | LTT_FIELD_TRAP_ID, |
81 | LTT_FIELD_IRQ_ID, |
82 | LTT_FIELD_OUT, |
83 | LTT_FIELD_IN, |
84 | LTT_FIELD_OUT_STATE, |
85 | LTT_FIELD_PARENT_PID, |
86 | LTT_FIELD_CHILD_PID, |
87 | LTT_FIELD_PID; |
88 | |
89 | extern GQuark LTT_EVENT_SYSCALL_ENTRY; |
90 | |
ffd54a90 |
91 | typedef struct _LttvTracesetState LttvTracesetState; |
92 | typedef struct _LttvTracesetStateClass LttvTracesetStateClass; |
93 | |
94 | typedef struct _LttvTraceState LttvTraceState; |
95 | typedef struct _LttvTraceStateClass LttvTraceStateClass; |
96 | |
97 | typedef struct _LttvTracefileState LttvTracefileState; |
98 | typedef struct _LttvTracefileStateClass LttvTracefileStateClass; |
99 | |
58c88a41 |
100 | gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data); |
308711e5 |
101 | void lttv_state_add_event_hooks(LttvTracesetState *self); |
102 | |
58c88a41 |
103 | gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
104 | void lttv_state_remove_event_hooks(LttvTracesetState *self); |
105 | |
106 | void lttv_state_save_add_event_hooks(LttvTracesetState *self); |
b56b5fec |
107 | // Hook wrapper. call_data is a trace context. |
108 | gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data); |
dc877563 |
109 | |
308711e5 |
110 | void lttv_state_save_remove_event_hooks(LttvTracesetState *self); |
b56b5fec |
111 | // Hook wrapper. call_data is a trace context. |
112 | gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data); |
308711e5 |
113 | |
dd025f91 |
114 | void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t); |
dc877563 |
115 | |
b445142a |
116 | /* The LttvProcessState structure defines the current state for each process. |
117 | A process can make system calls (in some rare cases nested) and receive |
118 | interrupts/faults. For instance, a process may issue a system call, |
119 | generate a page fault while reading an argument from user space, and |
120 | get caught by an interrupt. To represent these nested states, an |
121 | execution mode stack is maintained. The stack bottom is normal user mode |
122 | and the top of stack is the current execution mode. |
123 | |
124 | The execution mode stack tells about the process status, execution mode and |
125 | submode (interrupt, system call or IRQ number). All these could be |
126 | defined as enumerations but may need extensions (e.g. new process state). |
127 | GQuark are thus used. They are as easy to manipulate as integers but have |
128 | a string associated, just like enumerations. |
dc877563 |
129 | |
b445142a |
130 | The execution mode is one of "user mode", "kernel thread", "system call", |
dc877563 |
131 | "interrupt request", "fault". */ |
132 | |
b445142a |
133 | typedef GQuark LttvExecutionMode; |
dc877563 |
134 | |
b445142a |
135 | extern LttvExecutionMode |
ffd54a90 |
136 | LTTV_STATE_USER_MODE, |
137 | LTTV_STATE_SYSCALL, |
138 | LTTV_STATE_TRAP, |
b445142a |
139 | LTTV_STATE_IRQ, |
140 | LTTV_STATE_MODE_UNKNOWN; |
ffd54a90 |
141 | |
dc877563 |
142 | |
b445142a |
143 | /* The submode number depends on the execution mode. For user mode or kernel |
144 | thread, which are the normal mode (execution mode stack bottom), |
145 | it is set to "none". For interrupt requests, faults and system calls, |
146 | it is set respectively to the interrupt name (e.g. "timer"), fault name |
996acd92 |
147 | (e.g. "page fault"), and system call name (e.g. "select"). */ |
dc877563 |
148 | |
b445142a |
149 | typedef GQuark LttvExecutionSubmode; |
dc877563 |
150 | |
b445142a |
151 | extern LttvExecutionSubmode |
152 | LTTV_STATE_SUBMODE_NONE, |
153 | LTTV_STATE_SUBMODE_UNKNOWN; |
dc877563 |
154 | |
155 | /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*" |
156 | where "*" describes the resource waited for (e.g. timer, process, |
157 | disk...). */ |
158 | |
159 | typedef GQuark LttvProcessStatus; |
160 | |
ffd54a90 |
161 | extern LttvProcessStatus |
162 | LTTV_STATE_UNNAMED, |
163 | LTTV_STATE_WAIT_FORK, |
164 | LTTV_STATE_WAIT_CPU, |
dbd243b1 |
165 | LTTV_STATE_EXIT, |
0828099d |
166 | LTTV_STATE_ZOMBIE, |
ffd54a90 |
167 | LTTV_STATE_WAIT, |
168 | LTTV_STATE_RUN; |
dc877563 |
169 | |
ffd54a90 |
170 | |
b445142a |
171 | typedef struct _LttvExecutionState { |
172 | LttvExecutionMode t; |
173 | LttvExecutionSubmode n; |
ba576a78 |
174 | LttTime entry; |
b445142a |
175 | LttTime change; |
dc877563 |
176 | LttvProcessStatus s; |
b445142a |
177 | } LttvExecutionState; |
dc877563 |
178 | |
179 | |
180 | typedef struct _LttvProcessState { |
181 | guint pid; |
3e561027 |
182 | guint ppid; |
b445142a |
183 | LttTime creation_time; |
2a2fa4f0 |
184 | LttTime insertion_time; |
dc877563 |
185 | GQuark name; |
b445142a |
186 | GQuark pid_time; |
187 | GArray *execution_stack; /* Array of LttvExecutionState */ |
188 | LttvExecutionState *state; /* Top of interrupt stack */ |
e05fc742 |
189 | /* WARNING : each time the execution_stack size is modified, the state |
190 | * must be reget : g_array_set_size can have to move the array. |
191 | * (Mathieu) */ |
2a2fa4f0 |
192 | GQuark last_cpu; /* Last CPU where process was scheduled */ |
ac4e21cf |
193 | guint last_cpu_index; /* index in the trace for cpu tracefile */ |
b445142a |
194 | /* opened file descriptors, address map?... */ |
dc877563 |
195 | } LttvProcessState; |
196 | |
2a2fa4f0 |
197 | LttvProcessState * |
198 | lttv_state_find_process(LttvTracefileState *tfs, guint pid); |
199 | |
2a2fa4f0 |
200 | LttvProcessState * |
201 | lttv_state_find_process_or_create(LttvTracefileState *tfs, guint pid); |
202 | |
203 | LttvProcessState * |
204 | lttv_state_create_process(LttvTracefileState *tfs, LttvProcessState *parent, |
205 | guint pid); |
b445142a |
206 | |
dbb7bb09 |
207 | void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp); |
b445142a |
208 | |
ffd54a90 |
209 | /* The LttvTracesetState, LttvTraceState and LttvTracefileState types |
dc877563 |
210 | inherit from the corresponding Context objects defined in processTrace. */ |
211 | |
212 | #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ()) |
ffd54a90 |
213 | #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState)) |
214 | #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
215 | #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE)) |
216 | #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE)) |
ffd54a90 |
217 | #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
218 | |
ffd54a90 |
219 | struct _LttvTracesetState { |
220 | LttvTracesetContext parent; |
dc877563 |
221 | }; |
222 | |
223 | struct _LttvTracesetStateClass { |
ffd54a90 |
224 | LttvTracesetContextClass parent; |
dc877563 |
225 | }; |
226 | |
227 | GType lttv_traceset_state_get_type (void); |
228 | |
229 | |
230 | #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ()) |
231 | #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState)) |
232 | #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
233 | #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE)) |
234 | #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE)) |
235 | #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
236 | |
dc877563 |
237 | struct _LttvTraceState { |
238 | LttvTraceContext parent; |
239 | |
00e74b69 |
240 | GHashTable *processes; /* LttvProcessState objects indexed by pid and |
241 | last_cpu */ |
308711e5 |
242 | guint nb_event, save_interval; |
dc877563 |
243 | /* Block/char devices, locks, memory pages... */ |
b445142a |
244 | GQuark *eventtype_names; |
245 | GQuark *syscall_names; |
246 | GQuark *trap_names; |
247 | GQuark *irq_names; |
2a2fa4f0 |
248 | LttTime *max_time_state_recomputed_in_seek; |
dc877563 |
249 | }; |
250 | |
251 | struct _LttvTraceStateClass { |
252 | LttvTraceContextClass parent; |
308711e5 |
253 | |
254 | void (*state_save) (LttvTraceState *self, LttvAttribute *container); |
255 | void (*state_restore) (LttvTraceState *self, LttvAttribute *container); |
256 | void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container); |
dc877563 |
257 | }; |
258 | |
259 | GType lttv_trace_state_get_type (void); |
260 | |
308711e5 |
261 | void lttv_state_save(LttvTraceState *self, LttvAttribute *container); |
262 | |
263 | void lttv_state_restore(LttvTraceState *self, LttvAttribute *container); |
264 | |
f95bc830 |
265 | void lttv_state_state_saved_free(LttvTraceState *self, |
308711e5 |
266 | LttvAttribute *container); |
267 | |
dc877563 |
268 | |
269 | #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ()) |
270 | #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState)) |
271 | #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
272 | #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE)) |
273 | #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE)) |
274 | #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
275 | |
dc877563 |
276 | struct _LttvTracefileState { |
277 | LttvTracefileContext parent; |
278 | |
279 | LttvProcessState *process; |
b445142a |
280 | GQuark cpu_name; |
eed2ef37 |
281 | // guint saved_position; |
dc877563 |
282 | }; |
283 | |
284 | struct _LttvTracefileStateClass { |
285 | LttvTracefileContextClass parent; |
286 | }; |
287 | |
288 | GType lttv_tracefile_state_get_type (void); |
289 | |
290 | |
b445142a |
291 | #endif // STATE_H |