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