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