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