ltt/branches/poly/lttv/lttv/state.h

   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
  19 #ifndef STATE_H
  20 #define STATE_H
  21
  22 #include <glib.h>
  23 #include <lttv/tracecontext.h>
  24 #include <stdio.h>
  25
  26 /* The operating system state, kept during the trace analysis,
  27    contains a subset of the real operating system state,
  28    sufficient for the analysis, and possibly organized quite differently.
  29
  30    The state information is added to LttvTracesetContext, LttvTraceContext
  31    and LttvTracefileContext objects, used by process_traceset, through
  32    subtyping. The context objects already reflect the multiple tracefiles
  33    (one per cpu) per trace and multiple traces per trace set. The state
  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). */
  50
  51 /* Priority of state hooks */
  52 #define LTTV_PRIO_STATE 25
  53
  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
  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
 100 gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data);
 101 void lttv_state_add_event_hooks(LttvTracesetState *self);
 102
 103 gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data);
 104 void lttv_state_remove_event_hooks(LttvTracesetState *self);
 105
 106 void lttv_state_save_add_event_hooks(LttvTracesetState *self);
 107 // Hook wrapper. call_data is a trace context.
 108 gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data);
 109
 110 void lttv_state_save_remove_event_hooks(LttvTracesetState *self);
 111 // Hook wrapper. call_data is a trace context.
 112 gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data);
 113
 114 void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t);
 115
 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.
 129
 130    The execution mode is one of "user mode", "kernel thread", "system call",
 131    "interrupt request", "fault". */
 132
 133 typedef GQuark LttvExecutionMode;
 134
 135 extern LttvExecutionMode
 136   LTTV_STATE_USER_MODE,
 137   LTTV_STATE_SYSCALL,
 138   LTTV_STATE_TRAP,
 139   LTTV_STATE_IRQ,
 140   LTTV_STATE_MODE_UNKNOWN;
 141
 142
 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
 147    (e.g. "page fault"), and system call name (e.g. "select"). */
 148
 149 typedef GQuark LttvExecutionSubmode;
 150
 151 extern LttvExecutionSubmode
 152   LTTV_STATE_SUBMODE_NONE,
 153   LTTV_STATE_SUBMODE_UNKNOWN;
 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
 161 extern LttvProcessStatus
 162   LTTV_STATE_UNNAMED,
 163   LTTV_STATE_WAIT_FORK,
 164   LTTV_STATE_WAIT_CPU,
 165   LTTV_STATE_EXIT,
 166   LTTV_STATE_ZOMBIE,
 167   LTTV_STATE_WAIT,
 168   LTTV_STATE_RUN;
 169
 170
 171 typedef struct _LttvExecutionState {
 172   LttvExecutionMode t;
 173   LttvExecutionSubmode n;
 174   LttTime entry;
 175   LttTime change;
 176   LttvProcessStatus s;
 177 } LttvExecutionState;
 178
 179
 180 typedef struct _LttvProcessState {
 181   guint pid;
 182   guint ppid;
 183   LttTime creation_time;
 184   LttTime insertion_time;
 185   GQuark name;
 186   GQuark pid_time;
 187   GArray *execution_stack;         /* Array of LttvExecutionState */
 188   LttvExecutionState *state;       /* Top of interrupt stack */
 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) */
 192   guint cpu;                /* CPU where process is scheduled (being either in
 193                                the active or inactive runqueue)*/
 194 //  guint  last_tracefile_index;    /* index in the trace for cpu tracefile */
 195   /* opened file descriptors, address map?... */
 196 } LttvProcessState;
 197
 198 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
 199                      a PID != 0 will search on any cpu automatically. */
 200
 201 LttvProcessState *
 202 lttv_state_find_process(LttvTraceState *ts, guint cpu, guint pid);
 203
 204 LttvProcessState *
 205 lttv_state_find_process_or_create(LttvTraceState *ts, guint cpu, guint pid,
 206     LttTime *timestamp);
 207
 208 LttvProcessState *
 209 lttv_state_create_process(LttvTraceState *ts, LttvProcessState *parent,
 210     guint cpu, guint pid, const LttTime *timestamp);
 211
 212 void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp);
 213
 214 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
 215    inherit from the corresponding Context objects defined in processTrace. */
 216
 217 #define LTTV_TRACESET_STATE_TYPE  (lttv_traceset_state_get_type ())
 218 #define LTTV_TRACESET_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
 219 #define LTTV_TRACESET_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 220 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
 221 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
 222 #define LTTV_TRACESET_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 223
 224 struct _LttvTracesetState {
 225   LttvTracesetContext parent;
 226 };
 227
 228 struct _LttvTracesetStateClass {
 229   LttvTracesetContextClass parent;
 230 };
 231
 232 GType lttv_traceset_state_get_type (void);
 233
 234
 235 #define LTTV_TRACE_STATE_TYPE  (lttv_trace_state_get_type ())
 236 #define LTTV_TRACE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
 237 #define LTTV_TRACE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 238 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
 239 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
 240 #define LTTV_TRACE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 241
 242 struct _LttvTraceState {
 243   LttvTraceContext parent;
 244
 245   GHashTable *processes;  /* LttvProcessState objects indexed by pid and
 246                              last_cpu */
 247   guint nb_event, save_interval;
 248   /* Block/char devices, locks, memory pages... */
 249   GQuark *eventtype_names;
 250   GQuark *syscall_names;
 251   GQuark *trap_names;
 252   GQuark *irq_names;
 253   LttTime *max_time_state_recomputed_in_seek;
 254
 255   /* Array of per cpu running process */
 256   LttvProcessState **running_process;
 257
 258 };
 259
 260 struct _LttvTraceStateClass {
 261   LttvTraceContextClass parent;
 262
 263   void (*state_save) (LttvTraceState *self, LttvAttribute *container);
 264   void (*state_restore) (LttvTraceState *self, LttvAttribute *container);
 265   void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container);
 266 };
 267
 268 GType lttv_trace_state_get_type (void);
 269
 270 void lttv_state_save(LttvTraceState *self, LttvAttribute *container);
 271
 272 void lttv_state_restore(LttvTraceState *self, LttvAttribute *container);
 273
 274 void lttv_state_state_saved_free(LttvTraceState *self,
 275     LttvAttribute *container);
 276
 277
 278 #define LTTV_TRACEFILE_STATE_TYPE  (lttv_tracefile_state_get_type ())
 279 #define LTTV_TRACEFILE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
 280 #define LTTV_TRACEFILE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 281 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
 282 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
 283 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 284
 285 struct _LttvTracefileState {
 286   LttvTracefileContext parent;
 287
 288   //LttvProcessState *process;
 289   GQuark tracefile_name;
 290 //  guint saved_position;
 291 };
 292
 293 struct _LttvTracefileStateClass {
 294   LttvTracefileContextClass parent;
 295 };
 296
 297 GType lttv_tracefile_state_get_type (void);
 298
 299
 300 #endif // STATE_H