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