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