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