ltt/branches/poly/include/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/processTrace.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 processTrace, 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 typedef struct _LttvTracesetState LttvTracesetState;
  52 typedef struct _LttvTracesetStateClass LttvTracesetStateClass;
  53
  54 typedef struct _LttvTraceState LttvTraceState;
  55 typedef struct _LttvTraceStateClass LttvTraceStateClass;
  56
  57 typedef struct _LttvTracefileState LttvTracefileState;
  58 typedef struct _LttvTracefileStateClass LttvTracefileStateClass;
  59
  60 void lttv_state_add_event_hooks(LttvTracesetState *self);
  61
  62 void lttv_state_remove_event_hooks(LttvTracesetState *self);
  63
  64 void lttv_state_save_add_event_hooks(LttvTracesetState *self);
  65
  66 void lttv_state_save_remove_event_hooks(LttvTracesetState *self);
  67
  68 void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t);
  69
  70 /* The LttvProcessState structure defines the current state for each process.
  71    A process can make system calls (in some rare cases nested) and receive
  72    interrupts/faults. For instance, a process may issue a system call,
  73    generate a page fault while reading an argument from user space, and
  74    get caught by an interrupt. To represent these nested states, an
  75    execution mode stack is maintained. The stack bottom is normal user mode
  76    and the top of stack is the current execution mode.
  77
  78    The execution mode stack tells about the process status, execution mode and
  79    submode (interrupt, system call or IRQ number). All these could be
  80    defined as enumerations but may need extensions (e.g. new process state).
  81    GQuark are thus used. They are as easy to manipulate as integers but have
  82    a string associated, just like enumerations.
  83
  84    The execution mode is one of "user mode", "kernel thread", "system call",
  85    "interrupt request", "fault". */
  86
  87 typedef GQuark LttvExecutionMode;
  88
  89 extern LttvExecutionMode
  90   LTTV_STATE_USER_MODE,
  91   LTTV_STATE_SYSCALL,
  92   LTTV_STATE_TRAP,
  93   LTTV_STATE_IRQ,
  94   LTTV_STATE_MODE_UNKNOWN;
  95
  96
  97 /* The submode number depends on the execution mode. For user mode or kernel
  98    thread, which are the normal mode (execution mode stack bottom),
  99    it is set to "none". For interrupt requests, faults and system calls,
 100    it is set respectively to the interrupt name (e.g. "timer"), fault name
 101    (e.g. "page fault"), and system call name (e.g. "select"). */
 102
 103 typedef GQuark LttvExecutionSubmode;
 104
 105 extern LttvExecutionSubmode
 106   LTTV_STATE_SUBMODE_NONE,
 107   LTTV_STATE_SUBMODE_UNKNOWN;
 108
 109 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
 110    where "*" describes the resource waited for (e.g. timer, process,
 111    disk...). */
 112
 113 typedef GQuark LttvProcessStatus;
 114
 115 extern LttvProcessStatus
 116   LTTV_STATE_UNNAMED,
 117   LTTV_STATE_WAIT_FORK,
 118   LTTV_STATE_WAIT_CPU,
 119   LTTV_STATE_EXIT,
 120   LTTV_STATE_WAIT,
 121   LTTV_STATE_RUN;
 122
 123
 124 typedef struct _LttvExecutionState {
 125   LttvExecutionMode t;
 126   LttvExecutionSubmode n;
 127   LttTime entry;
 128   LttTime change;
 129   LttvProcessStatus s;
 130 } LttvExecutionState;
 131
 132
 133 typedef struct _LttvProcessState {
 134   guint pid;
 135   guint ppid;
 136   LttTime creation_time;
 137   LttTime insertion_time;
 138   GQuark name;
 139   GQuark pid_time;
 140   GArray *execution_stack;         /* Array of LttvExecutionState */
 141   LttvExecutionState *state;       /* Top of interrupt stack */
 142   GQuark last_cpu;                /* Last CPU where process was scheduled */
 143   /* opened file descriptors, address map?... */
 144 } LttvProcessState;
 145
 146
 147 LttvProcessState *
 148 lttv_state_find_process(LttvTracefileState *tfs, guint pid);
 149
 150 LttvProcessState *
 151 lttv_state_find_process_from_trace(LttvTraceState *ts, GQuark cpu, guint pid);
 152
 153 LttvProcessState *
 154 lttv_state_find_process_or_create(LttvTracefileState *tfs, guint pid);
 155
 156 LttvProcessState *
 157 lttv_state_create_process(LttvTracefileState *tfs, LttvProcessState *parent,
 158     guint pid);
 159
 160 void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp);
 161
 162 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
 163    inherit from the corresponding Context objects defined in processTrace. */
 164
 165 #define LTTV_TRACESET_STATE_TYPE  (lttv_traceset_state_get_type ())
 166 #define LTTV_TRACESET_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
 167 #define LTTV_TRACESET_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 168 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
 169 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
 170 #define LTTV_TRACESET_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 171
 172 struct _LttvTracesetState {
 173   LttvTracesetContext parent;
 174 };
 175
 176 struct _LttvTracesetStateClass {
 177   LttvTracesetContextClass parent;
 178 };
 179
 180 GType lttv_traceset_state_get_type (void);
 181
 182
 183 #define LTTV_TRACE_STATE_TYPE  (lttv_trace_state_get_type ())
 184 #define LTTV_TRACE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
 185 #define LTTV_TRACE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 186 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
 187 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
 188 #define LTTV_TRACE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 189
 190 struct _LttvTraceState {
 191   LttvTraceContext parent;
 192
 193   GHashTable *processes;  /* LttvProcessState objects indexed by pid */
 194   guint nb_event, save_interval;
 195   /* Block/char devices, locks, memory pages... */
 196   GQuark *eventtype_names;
 197   GQuark *syscall_names;
 198   GQuark *trap_names;
 199   GQuark *irq_names;
 200   LttTime *max_time_state_recomputed_in_seek;
 201 };
 202
 203 struct _LttvTraceStateClass {
 204   LttvTraceContextClass parent;
 205
 206   void (*state_save) (LttvTraceState *self, LttvAttribute *container);
 207   void (*state_restore) (LttvTraceState *self, LttvAttribute *container);
 208   void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container);
 209 };
 210
 211 GType lttv_trace_state_get_type (void);
 212
 213 void lttv_state_save(LttvTraceState *self, LttvAttribute *container);
 214
 215 void lttv_state_restore(LttvTraceState *self, LttvAttribute *container);
 216
 217 void lttv_state_state_saved_free(LttvTraceState *self,
 218     LttvAttribute *container);
 219
 220
 221 #define LTTV_TRACEFILE_STATE_TYPE  (lttv_tracefile_state_get_type ())
 222 #define LTTV_TRACEFILE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
 223 #define LTTV_TRACEFILE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 224 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
 225 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
 226 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 227
 228 struct _LttvTracefileState {
 229   LttvTracefileContext parent;
 230
 231   LttvProcessState *process;
 232   GQuark cpu_name;
 233   guint saved_position;
 234 };
 235
 236 struct _LttvTracefileStateClass {
 237   LttvTracefileContextClass parent;
 238 };
 239
 240 GType lttv_tracefile_state_get_type (void);
 241
 242
 243 #endif // STATE_H