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