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_FS,
  62     LTT_FACILITY_LIST,
  63     LTT_FACILITY_USER_GENERIC;
  64
  65 /* Events Quarks */
  66
  67 extern GQuark
  68     LTT_EVENT_SYSCALL_ENTRY,
  69     LTT_EVENT_SYSCALL_EXIT,
  70     LTT_EVENT_TRAP_ENTRY,
  71     LTT_EVENT_TRAP_EXIT,
  72     LTT_EVENT_IRQ_ENTRY,
  73     LTT_EVENT_IRQ_EXIT,
  74     LTT_EVENT_SOFT_IRQ_ENTRY,
  75     LTT_EVENT_SOFT_IRQ_EXIT,
  76     LTT_EVENT_SCHED_SCHEDULE,
  77     LTT_EVENT_PROCESS_FORK,
  78     LTT_EVENT_KTHREAD_CREATE,
  79     LTT_EVENT_PROCESS_EXIT,
  80     LTT_EVENT_PROCESS_FREE,
  81     LTT_EVENT_EXEC,
  82     LTT_EVENT_PROCESS_STATE,
  83     LTT_EVENT_STATEDUMP_END,
  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_PREV_PID,
  96     LTT_FIELD_NEXT_PID,
  97     LTT_FIELD_PREV_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_WAIT_FORK,
 185   LTTV_STATE_WAIT_CPU,
 186   LTTV_STATE_EXIT,
 187   LTTV_STATE_ZOMBIE,
 188   LTTV_STATE_WAIT,
 189   LTTV_STATE_RUN,
 190   LTTV_STATE_DEAD;
 191
 192 extern GQuark
 193   LTTV_STATE_UNBRANDED;
 194
 195 typedef GQuark LttvProcessType;
 196
 197 extern LttvProcessType
 198   LTTV_STATE_USER_THREAD,
 199   LTTV_STATE_KERNEL_THREAD;
 200
 201 typedef GQuark LttvCPUMode;
 202 extern LttvCPUMode
 203   LTTV_CPU_UNKNOWN,
 204   LTTV_CPU_IDLE,
 205   LTTV_CPU_BUSY,
 206   LTTV_CPU_IRQ,
 207   LTTV_CPU_TRAP;
 208
 209 typedef GQuark LttvIRQMode;
 210 extern LttvIRQMode
 211   LTTV_IRQ_UNKNOWN,
 212   LTTV_IRQ_IDLE,
 213   LTTV_IRQ_BUSY;
 214
 215 typedef struct _LttvExecutionState {
 216   LttvExecutionMode t;
 217   LttvExecutionSubmode n;
 218   LttTime entry;
 219   LttTime change;
 220   LttTime cum_cpu_time;
 221   LttvProcessStatus s;
 222 } LttvExecutionState;
 223
 224 typedef struct _LttvProcessState {
 225   guint pid;
 226   guint tgid;
 227   guint ppid;
 228   LttTime creation_time;
 229   LttTime insertion_time;
 230   GQuark name;
 231   GQuark brand;
 232   GQuark pid_time;
 233   GArray *execution_stack;         /* Array of LttvExecutionState */
 234   LttvExecutionState *state;       /* Top of interrupt stack */
 235       /* WARNING : each time the execution_stack size is modified, the state
 236        * must be reget : g_array_set_size can have to move the array.
 237        * (Mathieu) */
 238   guint cpu;                /* CPU where process is scheduled (being either in
 239                                the active or inactive runqueue)*/
 240 //  guint  last_tracefile_index;    /* index in the trace for cpu tracefile */
 241   LttvTracefileState  *usertrace;    /* Associated usertrace */
 242   /* opened file descriptors, address map?... */
 243   GArray *user_stack;          /* User space function call stack */
 244   guint64  current_function;
 245   LttvProcessType type;        /* kernel thread or user space ? */
 246   guint target_pid; /* target PID of the current event. */
 247 } LttvProcessState;
 248
 249 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
 250                      a PID != 0 will search on any cpu automatically. */
 251
 252 LttvProcessState *
 253 lttv_state_find_process(LttvTraceState *ts, guint cpu, guint pid);
 254
 255 LttvProcessState *
 256 lttv_state_find_process_or_create(LttvTraceState *ts, guint cpu, guint pid,
 257     const LttTime *timestamp);
 258
 259 LttvProcessState *
 260 lttv_state_create_process(LttvTraceState *tcs, LttvProcessState *parent,
 261     guint cpu, guint pid, guint tgid, GQuark name, const LttTime *timestamp);
 262
 263 void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp);
 264 void lttv_state_write_raw(LttvTraceState *self, LttTime t, FILE *fp);
 265
 266 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
 267    inherit from the corresponding Context objects defined in processTrace. */
 268
 269 #define LTTV_TRACESET_STATE_TYPE  (lttv_traceset_state_get_type ())
 270 #define LTTV_TRACESET_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
 271 #define LTTV_TRACESET_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 272 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
 273 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
 274 #define LTTV_TRACESET_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 275
 276 struct _LttvTracesetState {
 277   LttvTracesetContext parent;
 278 };
 279
 280 struct _LttvTracesetStateClass {
 281   LttvTracesetContextClass parent;
 282 };
 283
 284 GType lttv_traceset_state_get_type (void);
 285
 286
 287 #define LTTV_TRACE_STATE_TYPE  (lttv_trace_state_get_type ())
 288 #define LTTV_TRACE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
 289 #define LTTV_TRACE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 290 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
 291 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
 292 #define LTTV_TRACE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 293
 294 typedef struct _LttvCPUState {
 295   GArray *mode_stack;
 296 } LttvCPUState;
 297
 298 typedef struct _LttvIRQState {
 299   GArray *mode_stack;
 300 } LttvIRQState;
 301
 302 struct _LttvTraceState {
 303   LttvTraceContext parent;
 304
 305   GHashTable *processes;  /* LttvProcessState objects indexed by pid and
 306                              last_cpu */
 307   GHashTable *usertraces;  /* GPtrArray objects indexed by pid, containing
 308                              pointers to LttvTracefileState objects. */
 309   guint nb_event, save_interval;
 310   /* Block/char devices, locks, memory pages... */
 311   GQuark *eventtype_names;
 312   GQuark *syscall_names;
 313   guint  nb_syscalls;
 314   GQuark *trap_names;
 315   guint  nb_traps;
 316   guint  nb_irqs;
 317   guint  nb_softirqs;
 318   GQuark *irq_names;
 319   GQuark *soft_irq_names;
 320   LttTime *max_time_state_recomputed_in_seek;
 321
 322   /* Array of per cpu running process */
 323   LttvProcessState **running_process;
 324   gboolean has_precomputed_states;
 325   LttvCPUState *cpu_states; /* state of each cpu */
 326   LttvIRQState *irq_states; /* state of each irq handler */
 327 };
 328
 329 struct _LttvTraceStateClass {
 330   LttvTraceContextClass parent;
 331
 332   void (*state_save) (LttvTraceState *self, LttvAttribute *container);
 333   void (*state_restore) (LttvTraceState *self, LttvAttribute *container);
 334   void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container);
 335 };
 336
 337 GType lttv_trace_state_get_type (void);
 338
 339 void lttv_state_save(LttvTraceState *self, LttvAttribute *container);
 340
 341 void lttv_state_restore(LttvTraceState *self, LttvAttribute *container);
 342
 343 void lttv_state_state_saved_free(LttvTraceState *self,
 344     LttvAttribute *container);
 345
 346 int lttv_state_pop_state_cleanup(LttvProcessState *process,
 347     LttvTracefileState *tfs);
 348
 349 #define LTTV_TRACEFILE_STATE_TYPE  (lttv_tracefile_state_get_type ())
 350 #define LTTV_TRACEFILE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
 351 #define LTTV_TRACEFILE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 352 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
 353 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
 354 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 355
 356 struct _LttvTracefileState {
 357   LttvTracefileContext parent;
 358
 359   GQuark tracefile_name;
 360   guint cpu;  /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
 361   LttvCPUState *cpu_state; /* cpu resource state */
 362 };
 363
 364 struct _LttvTracefileStateClass {
 365   LttvTracefileContextClass parent;
 366 };
 367
 368 GType lttv_tracefile_state_get_type (void);
 369
 370 static inline guint lttv_state_get_target_pid(LttvTracefileState *tfs)
 371 {
 372   LttvTraceState *ts = (LttvTraceState*)tfs->parent.t_context;
 373   guint cpu = tfs->cpu;
 374   LttvProcessState *process = ts->running_process[cpu];
 375
 376   if(tfs->parent.target_pid >= 0) return tfs->parent.target_pid;
 377   else return process->pid;
 378 }
 379
 380
 381 #define HDR_PROCESS 0
 382 #define HDR_ES 1
 383 #define HDR_USER_STACK 2
 384 #define HDR_USERTRACE 3
 385 #define HDR_PROCESS_STATE 4
 386 #define HDR_CPU 5
 387 #define HDR_TRACEFILE 6
 388 #define HDR_TRACESET 7
 389 #define HDR_TRACE 8
 390 #define HDR_QUARKS 9
 391 #define HDR_QUARK 10
 392
 393
 394
 395 #endif // STATE_H