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