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