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