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