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