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