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