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