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