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