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> |
dc877563 |
23 | #include <lttv/processTrace.h> |
24 | |
25 | /* The operating system state kept during the trace analysis |
26 | contains a subset of the real operating system state, |
27 | sufficient for the analysis, and possibly organized quite differently. |
28 | |
ffd54a90 |
29 | The state information is added to LttvTracesetContext, LttvTraceContext |
dc877563 |
30 | and LttvTracefileContext objects, used by processTrace, through |
31 | subtyping. The context objects already reflect the multiple tracefiles |
32 | (one per cpu) per trace and multiple traces per trace set. The state |
308711e5 |
33 | objects defined here simply add fields to the relevant context objects. |
34 | |
35 | There is no traceset specific state yet. It may eventually contains such |
36 | things as clock differences over time. |
37 | |
38 | The trace state currently consists in a process table. |
39 | |
40 | The tracefile level state relates to the associated cpu. It contains the |
41 | position of the current event in the tracefile (since the state depends on |
42 | which events have been processed) and a pointer to the current process, |
43 | in the process table, being run on that cpu. |
44 | |
45 | For each process in the process table, various informations such as exec |
46 | file name, pid, ppid and creation time are stored. Each process state also |
47 | contains an execution mode stack (e.g. irq within system call, called |
48 | from user mode). */ |
dc877563 |
49 | |
ffd54a90 |
50 | typedef struct _LttvTracesetState LttvTracesetState; |
51 | typedef struct _LttvTracesetStateClass LttvTracesetStateClass; |
52 | |
53 | typedef struct _LttvTraceState LttvTraceState; |
54 | typedef struct _LttvTraceStateClass LttvTraceStateClass; |
55 | |
56 | typedef struct _LttvTracefileState LttvTracefileState; |
57 | typedef struct _LttvTracefileStateClass LttvTracefileStateClass; |
58 | |
308711e5 |
59 | void lttv_state_add_event_hooks(LttvTracesetState *self); |
60 | |
61 | void lttv_state_remove_event_hooks(LttvTracesetState *self); |
62 | |
63 | void lttv_state_save_add_event_hooks(LttvTracesetState *self); |
dc877563 |
64 | |
308711e5 |
65 | void lttv_state_save_remove_event_hooks(LttvTracesetState *self); |
66 | |
67 | void lttv_state_restore_closest_state(LttvTracesetState *self, LttTime t); |
dc877563 |
68 | |
b445142a |
69 | /* The LttvProcessState structure defines the current state for each process. |
70 | A process can make system calls (in some rare cases nested) and receive |
71 | interrupts/faults. For instance, a process may issue a system call, |
72 | generate a page fault while reading an argument from user space, and |
73 | get caught by an interrupt. To represent these nested states, an |
74 | execution mode stack is maintained. The stack bottom is normal user mode |
75 | and the top of stack is the current execution mode. |
76 | |
77 | The execution mode stack tells about the process status, execution mode and |
78 | submode (interrupt, system call or IRQ number). All these could be |
79 | defined as enumerations but may need extensions (e.g. new process state). |
80 | GQuark are thus used. They are as easy to manipulate as integers but have |
81 | a string associated, just like enumerations. |
dc877563 |
82 | |
b445142a |
83 | The execution mode is one of "user mode", "kernel thread", "system call", |
dc877563 |
84 | "interrupt request", "fault". */ |
85 | |
b445142a |
86 | typedef GQuark LttvExecutionMode; |
dc877563 |
87 | |
b445142a |
88 | extern LttvExecutionMode |
ffd54a90 |
89 | LTTV_STATE_USER_MODE, |
90 | LTTV_STATE_SYSCALL, |
91 | LTTV_STATE_TRAP, |
b445142a |
92 | LTTV_STATE_IRQ, |
93 | LTTV_STATE_MODE_UNKNOWN; |
ffd54a90 |
94 | |
dc877563 |
95 | |
b445142a |
96 | /* The submode number depends on the execution mode. For user mode or kernel |
97 | thread, which are the normal mode (execution mode stack bottom), |
98 | it is set to "none". For interrupt requests, faults and system calls, |
99 | it is set respectively to the interrupt name (e.g. "timer"), fault name |
996acd92 |
100 | (e.g. "page fault"), and system call name (e.g. "select"). */ |
dc877563 |
101 | |
b445142a |
102 | typedef GQuark LttvExecutionSubmode; |
dc877563 |
103 | |
b445142a |
104 | extern LttvExecutionSubmode |
105 | LTTV_STATE_SUBMODE_NONE, |
106 | LTTV_STATE_SUBMODE_UNKNOWN; |
dc877563 |
107 | |
108 | /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*" |
109 | where "*" describes the resource waited for (e.g. timer, process, |
110 | disk...). */ |
111 | |
112 | typedef GQuark LttvProcessStatus; |
113 | |
ffd54a90 |
114 | extern LttvProcessStatus |
115 | LTTV_STATE_UNNAMED, |
116 | LTTV_STATE_WAIT_FORK, |
117 | LTTV_STATE_WAIT_CPU, |
118 | LTTV_STATE_EXIT, |
119 | LTTV_STATE_WAIT, |
120 | LTTV_STATE_RUN; |
dc877563 |
121 | |
ffd54a90 |
122 | |
b445142a |
123 | typedef struct _LttvExecutionState { |
124 | LttvExecutionMode t; |
125 | LttvExecutionSubmode n; |
ba576a78 |
126 | LttTime entry; |
b445142a |
127 | LttTime change; |
dc877563 |
128 | LttvProcessStatus s; |
b445142a |
129 | } LttvExecutionState; |
dc877563 |
130 | |
131 | |
132 | typedef struct _LttvProcessState { |
133 | guint pid; |
3e561027 |
134 | guint ppid; |
b445142a |
135 | LttTime creation_time; |
dc877563 |
136 | GQuark name; |
b445142a |
137 | GQuark pid_time; |
138 | GArray *execution_stack; /* Array of LttvExecutionState */ |
139 | LttvExecutionState *state; /* Top of interrupt stack */ |
140 | /* opened file descriptors, address map?... */ |
dc877563 |
141 | } LttvProcessState; |
142 | |
143 | |
b445142a |
144 | LttvProcessState *lttv_state_find_process(LttvTracefileState *tfs, guint pid); |
145 | |
146 | |
ffd54a90 |
147 | /* The LttvTracesetState, LttvTraceState and LttvTracefileState types |
dc877563 |
148 | inherit from the corresponding Context objects defined in processTrace. */ |
149 | |
150 | #define LTTV_TRACESET_STATE_TYPE (lttv_traceset_state_get_type ()) |
ffd54a90 |
151 | #define LTTV_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState)) |
152 | #define LTTV_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
153 | #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE)) |
154 | #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE)) |
ffd54a90 |
155 | #define LTTV_TRACESET_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass)) |
dc877563 |
156 | |
ffd54a90 |
157 | struct _LttvTracesetState { |
158 | LttvTracesetContext parent; |
dc877563 |
159 | }; |
160 | |
161 | struct _LttvTracesetStateClass { |
ffd54a90 |
162 | LttvTracesetContextClass parent; |
dc877563 |
163 | }; |
164 | |
165 | GType lttv_traceset_state_get_type (void); |
166 | |
167 | |
168 | #define LTTV_TRACE_STATE_TYPE (lttv_trace_state_get_type ()) |
169 | #define LTTV_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState)) |
170 | #define LTTV_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
171 | #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE)) |
172 | #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE)) |
173 | #define LTTV_TRACE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass)) |
174 | |
dc877563 |
175 | struct _LttvTraceState { |
176 | LttvTraceContext parent; |
177 | |
178 | GHashTable *processes; /* LttvProcessState objects indexed by pid */ |
308711e5 |
179 | guint nb_event, save_interval; |
dc877563 |
180 | /* Block/char devices, locks, memory pages... */ |
b445142a |
181 | GQuark *eventtype_names; |
182 | GQuark *syscall_names; |
183 | GQuark *trap_names; |
184 | GQuark *irq_names; |
dc877563 |
185 | }; |
186 | |
187 | struct _LttvTraceStateClass { |
188 | LttvTraceContextClass parent; |
308711e5 |
189 | |
190 | void (*state_save) (LttvTraceState *self, LttvAttribute *container); |
191 | void (*state_restore) (LttvTraceState *self, LttvAttribute *container); |
192 | void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container); |
dc877563 |
193 | }; |
194 | |
195 | GType lttv_trace_state_get_type (void); |
196 | |
308711e5 |
197 | void lttv_state_save(LttvTraceState *self, LttvAttribute *container); |
198 | |
199 | void lttv_state_restore(LttvTraceState *self, LttvAttribute *container); |
200 | |
201 | void lttv_state_saved_state_free(LttvTraceState *self, |
202 | LttvAttribute *container); |
203 | |
dc877563 |
204 | |
205 | #define LTTV_TRACEFILE_STATE_TYPE (lttv_tracefile_state_get_type ()) |
206 | #define LTTV_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState)) |
207 | #define LTTV_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
208 | #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE)) |
209 | #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE)) |
210 | #define LTTV_TRACEFILE_STATE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass)) |
211 | |
dc877563 |
212 | struct _LttvTracefileState { |
213 | LttvTracefileContext parent; |
214 | |
215 | LttvProcessState *process; |
b445142a |
216 | GQuark cpu_name; |
308711e5 |
217 | guint saved_position; |
dc877563 |
218 | }; |
219 | |
220 | struct _LttvTracefileStateClass { |
221 | LttvTracefileContextClass parent; |
222 | }; |
223 | |
224 | GType lttv_tracefile_state_get_type (void); |
225 | |
226 | |
b445142a |
227 | #endif // STATE_H |