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