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