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