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     LTT_FACILITY_BLOCK,
  65     LTT_FACILITY_STATEDUMP;
  66
  67 /* Events Quarks */
  68
  69 extern GQuark
  70     LTT_EVENT_SYSCALL_ENTRY,
  71     LTT_EVENT_SYSCALL_EXIT,
  72     LTT_EVENT_TRAP_ENTRY,
  73     LTT_EVENT_TRAP_EXIT,
  74     LTT_EVENT_IRQ_ENTRY,
  75     LTT_EVENT_IRQ_EXIT,
  76     LTT_EVENT_SOFT_IRQ_ENTRY,
  77     LTT_EVENT_SOFT_IRQ_EXIT,
  78     LTT_EVENT_SCHED_SCHEDULE,
  79     LTT_EVENT_PROCESS_FORK,
  80     LTT_EVENT_KTHREAD_CREATE,
  81     LTT_EVENT_PROCESS_EXIT,
  82     LTT_EVENT_PROCESS_FREE,
  83     LTT_EVENT_EXEC,
  84     LTT_EVENT_PROCESS_STATE,
  85     LTT_EVENT_STATEDUMP_END,
  86     LTT_EVENT_FUNCTION_ENTRY,
  87     LTT_EVENT_FUNCTION_EXIT,
  88     LTT_EVENT_THREAD_BRAND,
  89     LTT_EVENT_REQUEST_ISSUE,
  90     LTT_EVENT_REQUEST_COMPLETE,
  91     LTT_EVENT_LIST_INTERRUPT,
  92     LTT_EVENT_SYS_CALL_TABLE;
  93
  94 /* Fields Quarks */
  95
  96 extern GQuark
  97     LTT_FIELD_SYSCALL_ID,
  98     LTT_FIELD_TRAP_ID,
  99     LTT_FIELD_IRQ_ID,
 100     LTT_FIELD_SOFT_IRQ_ID,
 101     LTT_FIELD_PREV_PID,
 102     LTT_FIELD_NEXT_PID,
 103     LTT_FIELD_PREV_STATE,
 104     LTT_FIELD_PARENT_PID,
 105     LTT_FIELD_CHILD_PID,
 106     LTT_FIELD_PID,
 107     LTT_FIELD_TGID,
 108     LTT_FIELD_FILENAME,
 109     LTT_FIELD_NAME,
 110     LTT_FIELD_TYPE,
 111     LTT_FIELD_MODE,
 112     LTT_FIELD_SUBMODE,
 113     LTT_FIELD_STATUS,
 114     LTT_FIELD_THIS_FN,
 115     LTT_FIELD_CALL_SITE,
 116     LTT_FIELD_MINOR,
 117     LTT_FIELD_MAJOR,
 118     LTT_FIELD_OPERATION,
 119     LTT_FIELD_ACTION,
 120     LTT_FIELD_ID,
 121     LTT_FIELD_ADDRESS,
 122     LTT_FIELD_SYMBOL;
 123
 124 typedef struct _LttvTracesetState LttvTracesetState;
 125 typedef struct _LttvTracesetStateClass LttvTracesetStateClass;
 126
 127 typedef struct _LttvTraceState LttvTraceState;
 128 typedef struct _LttvTraceStateClass LttvTraceStateClass;
 129
 130 typedef struct _LttvTracefileState LttvTracefileState;
 131 typedef struct _LttvTracefileStateClass LttvTracefileStateClass;
 132
 133 gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data);
 134 void lttv_state_add_event_hooks(LttvTracesetState *self);
 135
 136 gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data);
 137 void lttv_state_remove_event_hooks(LttvTracesetState *self);
 138
 139 void lttv_state_save_add_event_hooks(LttvTracesetState *self);
 140 // Hook wrapper. call_data is a trace context.
 141 gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data);
 142
 143 void lttv_state_save_remove_event_hooks(LttvTracesetState *self);
 144 // Hook wrapper. call_data is a trace context.
 145 gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data);
 146
 147 void lttv_state_traceset_seek_time_closest(LttvTracesetState *self, LttTime t);
 148
 149 /* The LttvProcessState structure defines the current state for each process.
 150    A process can make system calls (in some rare cases nested) and receive
 151    interrupts/faults. For instance, a process may issue a system call,
 152    generate a page fault while reading an argument from user space, and
 153    get caught by an interrupt. To represent these nested states, an
 154    execution mode stack is maintained. The stack bottom is normal user mode
 155    and the top of stack is the current execution mode.
 156
 157    The execution mode stack tells about the process status, execution mode and
 158    submode (interrupt, system call or IRQ number). All these could be
 159    defined as enumerations but may need extensions (e.g. new process state).
 160    GQuark are thus used. They are as easy to manipulate as integers but have
 161    a string associated, just like enumerations.
 162
 163    The execution mode is one of "user mode", "kernel thread", "system call",
 164    "interrupt request", "fault". */
 165
 166 typedef GQuark LttvExecutionMode;
 167
 168 extern LttvExecutionMode
 169   LTTV_STATE_USER_MODE,
 170   LTTV_STATE_SYSCALL,
 171   LTTV_STATE_TRAP,
 172   LTTV_STATE_IRQ,
 173   LTTV_STATE_SOFT_IRQ,
 174   LTTV_STATE_MODE_UNKNOWN;
 175
 176
 177 /* The submode number depends on the execution mode. For user mode or kernel
 178    thread, which are the normal mode (execution mode stack bottom),
 179    it is set to "none". For interrupt requests, faults and system calls,
 180    it is set respectively to the interrupt name (e.g. "timer"), fault name
 181    (e.g. "page fault"), and system call name (e.g. "select"). */
 182
 183 typedef GQuark LttvExecutionSubmode;
 184
 185 extern LttvExecutionSubmode
 186   LTTV_STATE_SUBMODE_NONE,
 187   LTTV_STATE_SUBMODE_UNKNOWN;
 188
 189 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
 190    where "*" describes the resource waited for (e.g. timer, process,
 191    disk...). */
 192
 193 typedef GQuark LttvProcessStatus;
 194
 195 extern LttvProcessStatus
 196   LTTV_STATE_UNNAMED,
 197   LTTV_STATE_WAIT_FORK,
 198   LTTV_STATE_WAIT_CPU,
 199   LTTV_STATE_EXIT,
 200   LTTV_STATE_ZOMBIE,
 201   LTTV_STATE_WAIT,
 202   LTTV_STATE_RUN,
 203   LTTV_STATE_DEAD;
 204
 205 extern GQuark
 206   LTTV_STATE_UNBRANDED;
 207
 208 typedef GQuark LttvProcessType;
 209
 210 extern LttvProcessType
 211   LTTV_STATE_USER_THREAD,
 212   LTTV_STATE_KERNEL_THREAD;
 213
 214 typedef GQuark LttvCPUMode;
 215 extern LttvCPUMode
 216   LTTV_CPU_UNKNOWN,
 217   LTTV_CPU_IDLE,
 218   LTTV_CPU_BUSY,
 219   LTTV_CPU_IRQ,
 220   LTTV_CPU_SOFT_IRQ,
 221   LTTV_CPU_TRAP;
 222
 223 typedef GQuark LttvIRQMode;
 224 extern LttvIRQMode
 225   LTTV_IRQ_UNKNOWN,
 226   LTTV_IRQ_IDLE,
 227   LTTV_IRQ_BUSY;
 228
 229 typedef GQuark LttvBdevMode;
 230 extern LttvBdevMode
 231   LTTV_BDEV_UNKNOWN,
 232   LTTV_BDEV_IDLE,
 233   LTTV_BDEV_BUSY_READING,
 234   LTTV_BDEV_BUSY_WRITING;
 235
 236 typedef struct _LttvExecutionState {
 237   LttvExecutionMode t;
 238   LttvExecutionSubmode n;
 239   LttTime entry;
 240   LttTime change;
 241   LttTime cum_cpu_time;
 242   LttvProcessStatus s;
 243 } LttvExecutionState;
 244
 245 typedef struct _LttvProcessState {
 246   guint pid;
 247   guint tgid;
 248   guint ppid;
 249   LttTime creation_time;
 250   LttTime insertion_time;
 251   GQuark name;
 252   GQuark brand;
 253   GQuark pid_time;
 254   GArray *execution_stack;         /* Array of LttvExecutionState */
 255   LttvExecutionState *state;       /* Top of interrupt stack */
 256       /* WARNING : each time the execution_stack size is modified, the state
 257        * must be reget : g_array_set_size can have to move the array.
 258        * (Mathieu) */
 259   guint cpu;                /* CPU where process is scheduled (being either in
 260                                the active or inactive runqueue)*/
 261 //  guint  last_tracefile_index;    /* index in the trace for cpu tracefile */
 262   LttvTracefileState  *usertrace;    /* Associated usertrace */
 263   /* opened file descriptors, address map?... */
 264   GArray *user_stack;          /* User space function call stack */
 265   guint64  current_function;
 266   LttvProcessType type;        /* kernel thread or user space ? */
 267   guint target_pid; /* target PID of the current event. */
 268   guint free_events; /* 0 : none, 1 : free or exit dead, 2 : should delete */
 269 } LttvProcessState;
 270
 271 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
 272                      a PID != 0 will search on any cpu automatically. */
 273
 274 LttvProcessState *
 275 lttv_state_find_process(LttvTraceState *ts, guint cpu, guint pid);
 276
 277 LttvProcessState *
 278 lttv_state_find_process_or_create(LttvTraceState *ts, guint cpu, guint pid,
 279     const LttTime *timestamp);
 280
 281 LttvProcessState *
 282 lttv_state_create_process(LttvTraceState *tcs, LttvProcessState *parent,
 283     guint cpu, guint pid, guint tgid, GQuark name, const LttTime *timestamp);
 284
 285 void lttv_state_write(LttvTraceState *self, LttTime t, FILE *fp);
 286 void lttv_state_write_raw(LttvTraceState *self, LttTime t, FILE *fp);
 287
 288 /* The LttvTracesetState, LttvTraceState and LttvTracefileState types
 289    inherit from the corresponding Context objects defined in processTrace. */
 290
 291 #define LTTV_TRACESET_STATE_TYPE  (lttv_traceset_state_get_type ())
 292 #define LTTV_TRACESET_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_STATE_TYPE, LttvTracesetState))
 293 #define LTTV_TRACESET_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 294 #define LTTV_IS_TRACESET_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_STATE_TYPE))
 295 #define LTTV_IS_TRACESET_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_STATE_TYPE))
 296 #define LTTV_TRACESET_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_STATE_TYPE, LttvTracesetStateClass))
 297
 298 struct _LttvTracesetState {
 299   LttvTracesetContext parent;
 300 };
 301
 302 struct _LttvTracesetStateClass {
 303   LttvTracesetContextClass parent;
 304 };
 305
 306 GType lttv_traceset_state_get_type (void);
 307
 308
 309 #define LTTV_TRACE_STATE_TYPE  (lttv_trace_state_get_type ())
 310 #define LTTV_TRACE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_STATE_TYPE, LttvTraceState))
 311 #define LTTV_TRACE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 312 #define LTTV_IS_TRACE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_STATE_TYPE))
 313 #define LTTV_IS_TRACE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_STATE_TYPE))
 314 #define LTTV_TRACE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_STATE_TYPE, LttvTraceStateClass))
 315
 316 typedef struct _LttvCPUState {
 317   GArray *mode_stack;
 318   guint last_irq;
 319   guint last_soft_irq;
 320   guint last_trap;
 321 } LttvCPUState;
 322
 323 typedef struct _LttvIRQState {
 324   GArray *mode_stack;
 325 } LttvIRQState;
 326
 327 typedef struct _LttvSoftIRQState {
 328   guint running; /* number of times it is currently running (on different processors) */
 329 } LttvSoftIRQState;
 330
 331 typedef struct _LttvTrapState {
 332   guint running; /* number of times it is currently running (on different processors) */
 333 } LttvTrapState;
 334
 335 typedef struct _LttvBdevState {
 336   GArray *mode_stack;
 337 } LttvBdevState;
 338
 339 struct _LttvTraceState {
 340   LttvTraceContext parent;
 341
 342   GHashTable *processes;  /* LttvProcessState objects indexed by pid and
 343                              last_cpu */
 344   GHashTable *usertraces;  /* GPtrArray objects indexed by pid, containing
 345                              pointers to LttvTracefileState objects. */
 346   guint nb_event, save_interval;
 347   /* Block/char devices, locks, memory pages... */
 348   GQuark *eventtype_names;
 349   GQuark *syscall_names;
 350   guint  nb_syscalls;
 351   GQuark *trap_names;
 352   guint  nb_traps;
 353   guint  nb_irqs;
 354   guint  nb_soft_irqs;
 355   GQuark *irq_names;
 356   GQuark *soft_irq_names;
 357   LttTime *max_time_state_recomputed_in_seek;
 358
 359   /* Array of per cpu running process */
 360   LttvProcessState **running_process;
 361   gboolean has_precomputed_states;
 362   LttvCPUState *cpu_states; /* state of each cpu */
 363   LttvIRQState *irq_states; /* state of each irq handler */
 364   LttvSoftIRQState *soft_irq_states; /* state of each softirq */
 365   LttvTrapState *trap_states; /* state of each trap */
 366   GHashTable *bdev_states; /* state of the block devices */
 367 };
 368
 369 struct _LttvTraceStateClass {
 370   LttvTraceContextClass parent;
 371
 372   void (*state_save) (LttvTraceState *self, LttvAttribute *container);
 373   void (*state_restore) (LttvTraceState *self, LttvAttribute *container);
 374   void (*state_saved_free) (LttvTraceState *self, LttvAttribute *container);
 375 };
 376
 377 GType lttv_trace_state_get_type (void);
 378
 379 void lttv_state_save(LttvTraceState *self, LttvAttribute *container);
 380
 381 void lttv_state_restore(LttvTraceState *self, LttvAttribute *container);
 382
 383 void lttv_state_state_saved_free(LttvTraceState *self,
 384     LttvAttribute *container);
 385
 386 int lttv_state_pop_state_cleanup(LttvProcessState *process,
 387     LttvTracefileState *tfs);
 388
 389 #define LTTV_TRACEFILE_STATE_TYPE  (lttv_tracefile_state_get_type ())
 390 #define LTTV_TRACEFILE_STATE(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileState))
 391 #define LTTV_TRACEFILE_STATE_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 392 #define LTTV_IS_TRACEFILE_STATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_STATE_TYPE))
 393 #define LTTV_IS_TRACEFILE_STATE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_STATE_TYPE))
 394 #define LTTV_TRACEFILE_STATE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_STATE_TYPE, LttvTracefileStateClass))
 395
 396 struct _LttvTracefileState {
 397   LttvTracefileContext parent;
 398
 399   GQuark tracefile_name;
 400   guint cpu;  /* Current cpu of the tracefile */ /* perhaps merge in cpu_state */
 401   LttvCPUState *cpu_state; /* cpu resource state */
 402 };
 403
 404 struct _LttvTracefileStateClass {
 405   LttvTracefileContextClass parent;
 406 };
 407
 408 GType lttv_tracefile_state_get_type (void);
 409
 410 static inline guint lttv_state_get_target_pid(LttvTracefileState *tfs)
 411 {
 412   LttvTraceState *ts = (LttvTraceState*)tfs->parent.t_context;
 413   guint cpu = tfs->cpu;
 414   LttvProcessState *process = ts->running_process[cpu];
 415
 416   if(tfs->parent.target_pid >= 0) return tfs->parent.target_pid;
 417   else return process->pid;
 418 }
 419
 420
 421 #define HDR_PROCESS 0
 422 #define HDR_ES 1
 423 #define HDR_USER_STACK 2
 424 #define HDR_USERTRACE 3
 425 #define HDR_PROCESS_STATE 4
 426 #define HDR_CPU 5
 427 #define HDR_TRACEFILE 6
 428 #define HDR_TRACESET 7
 429 #define HDR_TRACE 8
 430 #define HDR_QUARKS 9
 431 #define HDR_QUARK 10
 432
 433 /* Device number manipulation macros from kernel source */
 434 #define MINORBITS       20
 435 #define MINORMASK       ((1U << MINORBITS) - 1)
 436 #define MAJOR(dev)      ((unsigned int) ((dev) >> MINORBITS))
 437 #define MINOR(dev)      ((unsigned int) ((dev) & MINORMASK))
 438 #define MKDEV(ma,mi)    (((ma) << MINORBITS) | (mi))
 439
 440 #endif // STATE_H