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 <stdio.h>
  24 #include <babeltrace/context.h>
  25 #include <lttv/attribute.h>
  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 information 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 typedef struct _LttvTraceset LttvTraceset;
  52
  53 typedef struct _LttvTrace LttvTrace;
  54
  55 typedef struct _LttvTracesetPosition LttvTracesetPosition;
  56
  57 struct bt_context;
  58
  59 /* Priority of state hooks */
  60 #define LTTV_PRIO_STATE 25
  61
  62 #define LTTV_STATE_SAVE_INTERVAL 50000
  63
  64
  65 #define PREALLOC_NB_SYSCALLS    256
  66 /*
  67  * As of 2.6.38, IRQ 239 has been seen (and we have seen higher than
  68  * 256 too.
  69  */
  70 #define PREALLOC_NB_IRQS        512
  71 /* As of 2.6.38, 255 softirqs are used. */
  72 #define PREALLOC_NB_SOFT_IRQS   512
  73 #define PREALLOC_NB_TRAPS       256
  74
  75 /* Channel Quarks */
  76
  77 extern GQuark
  78         LTT_CHANNEL_FD_STATE,
  79         LTT_CHANNEL_GLOBAL_STATE,
  80         LTT_CHANNEL_IRQ_STATE,
  81         LTT_CHANNEL_MODULE_STATE,
  82         LTT_CHANNEL_NETIF_STATE,
  83         LTT_CHANNEL_SOFTIRQ_STATE,
  84         LTT_CHANNEL_SWAP_STATE,
  85         LTT_CHANNEL_SYSCALL_STATE,
  86         LTT_CHANNEL_TASK_STATE,
  87         LTT_CHANNEL_VM_STATE,
  88         LTT_CHANNEL_KPROBE_STATE,
  89         LTT_CHANNEL_FS,
  90         LTT_CHANNEL_KERNEL,
  91         LTT_CHANNEL_MM,
  92         LTT_CHANNEL_USERSPACE,
  93         LTT_CHANNEL_BLOCK;
  94
  95 /* Events Quarks */
  96
  97 extern GQuark
  98         LTT_EVENT_SYSCALL_ENTRY,
  99         LTT_EVENT_SYSCALL_EXIT,
 100         LTT_EVENT_TRAP_ENTRY,
 101         LTT_EVENT_TRAP_EXIT,
 102         LTT_EVENT_PAGE_FAULT_ENTRY,
 103         LTT_EVENT_PAGE_FAULT_EXIT,
 104         LTT_EVENT_PAGE_FAULT_NOSEM_ENTRY,
 105         LTT_EVENT_PAGE_FAULT_NOSEM_EXIT,
 106         LTT_EVENT_IRQ_ENTRY,
 107         LTT_EVENT_IRQ_EXIT,
 108         LTT_EVENT_SOFT_IRQ_RAISE,
 109         LTT_EVENT_SOFT_IRQ_ENTRY,
 110         LTT_EVENT_SOFT_IRQ_EXIT,
 111         LTT_EVENT_SCHED_SCHEDULE,
 112         LTT_EVENT_SCHED_TRY_WAKEUP,
 113         LTT_EVENT_PROCESS_FORK,
 114         LTT_EVENT_KTHREAD_CREATE,
 115         LTT_EVENT_PROCESS_EXIT,
 116         LTT_EVENT_PROCESS_FREE,
 117         LTT_EVENT_EXEC,
 118         LTT_EVENT_PROCESS_STATE,
 119         LTT_EVENT_STATEDUMP_END,
 120         //LTT_EVENT_FUNCTION_ENTRY,
 121         //LTT_EVENT_FUNCTION_EXIT,
 122         LTT_EVENT_REQUEST_ISSUE,
 123         LTT_EVENT_REQUEST_COMPLETE,
 124         LTT_EVENT_LIST_INTERRUPT,
 125         LTT_EVENT_SYS_CALL_TABLE,
 126         LTT_EVENT_SOFTIRQ_VEC,
 127         LTT_EVENT_KPROBE_TABLE,
 128         LTT_EVENT_KPROBE,
 129         LTT_EVENT_OPEN,
 130         LTT_EVENT_READ,
 131         LTT_EVENT_POLL_EVENT;
 132
 133 /* Fields Quarks */
 134
 135 extern GQuark
 136         LTT_FIELD_SYSCALL_ID,
 137         LTT_FIELD_TRAP_ID,
 138         LTT_FIELD_IRQ_ID,
 139         LTT_FIELD_SOFT_IRQ_ID,
 140         LTT_FIELD_PREV_PID,
 141         LTT_FIELD_NEXT_PID,
 142         LTT_FIELD_PREV_STATE,
 143         LTT_FIELD_PARENT_PID,
 144         LTT_FIELD_CHILD_PID,
 145         LTT_FIELD_PID,
 146         LTT_FIELD_TGID,
 147         LTT_FIELD_FILENAME,
 148         LTT_FIELD_NAME,
 149         LTT_FIELD_TYPE,
 150         LTT_FIELD_MODE,
 151         LTT_FIELD_SUBMODE,
 152         LTT_FIELD_STATUS,
 153         LTT_FIELD_THIS_FN,
 154         LTT_FIELD_CALL_SITE,
 155         LTT_FIELD_MINOR,
 156         LTT_FIELD_MAJOR,
 157         LTT_FIELD_OPERATION,
 158         LTT_FIELD_ACTION,
 159         LTT_FIELD_ID,
 160         LTT_FIELD_ADDRESS,
 161         LTT_FIELD_SYMBOL,
 162         LTT_FIELD_IP,
 163         LTT_FIELD_FD,
 164         LTT_FIELD_STATE,
 165         LTT_FIELD_CPU_ID;
 166
 167 typedef struct _LttvTraceState LttvTraceState;
 168 typedef struct _LttvTraceStateClass LttvTraceStateClass;
 169
 170 typedef struct _LttvTracefileState LttvTracefileState;
 171 typedef struct _LttvTracefileStateClass LttvTracefileStateClass;
 172
 173 void lttv_state_add_event_hooks(LttvTraceset *traceset);
 174 gint lttv_state_hook_add_event_hooks(void *hook_data, void *call_data);
 175
 176 void lttv_state_remove_event_hooks(LttvTraceset *traceset);
 177 gint lttv_state_hook_remove_event_hooks(void *hook_data, void *call_data);
 178
 179 gint lttv_state_save_hook_add_event_hooks(void *hook_data, void *call_data);
 180 gint lttv_state_save_hook_remove_event_hooks(void *hook_data, void *call_data);
 181
 182
 183 //TODO ybrosseau 2012-07-30: Change name of seek_time_closest to:
 184 //void lttv_traceset_seek_time_closest_prior_state(LttvTraceset *traceset, LttTime t);
 185
 186 void lttv_state_traceset_seek_time_closest(LttvTraceset *traceset, LttTime t);
 187 void lttv_state_traceset_seek_time(LttvTraceset *traceset, LttTime t);
 188 void lttv_state_traceset_seek_position(LttvTraceset *traceset, LttvTracesetPosition *position);
 189
 190 /* The LttvProcessState structure defines the current state for each process.
 191    A process can make system calls (in some rare cases nested) and receive
 192    interrupts/faults. For instance, a process may issue a system call,
 193    generate a page fault while reading an argument from user space, and
 194    get caught by an interrupt. To represent these nested states, an
 195    execution mode stack is maintained. The stack bottom is normal user mode
 196    and the top of stack is the current execution mode.
 197
 198    The execution mode stack tells about the process status, execution mode and
 199    submode (interrupt, system call or IRQ number). All these could be
 200    defined as enumerations but may need extensions (e.g. new process state).
 201    GQuark are thus used. They are as easy to manipulate as integers but have
 202    a string associated, just like enumerations.
 203
 204    The execution mode is one of "user mode", "kernel thread", "system call",
 205    "interrupt request", "fault". */
 206
 207 typedef GQuark LttvExecutionMode;
 208
 209 extern LttvExecutionMode
 210         LTTV_STATE_USER_MODE,
 211         LTTV_STATE_MAYBE_USER_MODE,
 212         LTTV_STATE_SYSCALL,
 213         LTTV_STATE_MAYBE_SYSCALL,
 214         LTTV_STATE_TRAP,
 215         LTTV_STATE_MAYBE_TRAP,  /* TODO */
 216         LTTV_STATE_IRQ,
 217         LTTV_STATE_SOFT_IRQ,
 218         LTTV_STATE_MODE_UNKNOWN;
 219
 220
 221 /* The submode number depends on the execution mode. For user mode or kernel
 222    thread, which are the normal mode (execution mode stack bottom),
 223    it is set to "none". For interrupt requests, faults and system calls,
 224    it is set respectively to the interrupt name (e.g. "timer"), fault name
 225    (e.g. "page fault"), and system call name (e.g. "select"). */
 226
 227 typedef GQuark LttvExecutionSubmode;
 228
 229 extern LttvExecutionSubmode
 230         LTTV_STATE_SUBMODE_NONE,
 231         LTTV_STATE_SUBMODE_UNKNOWN;
 232
 233 /* The process status is one of "running", "wait-cpu" (runnable), or "wait-*"
 234    where "*" describes the resource waited for (e.g. timer, process,
 235    disk...). */
 236
 237 typedef GQuark LttvProcessStatus;
 238
 239 extern LttvProcessStatus
 240         LTTV_STATE_UNNAMED,
 241         LTTV_STATE_WAIT_FORK,
 242         LTTV_STATE_WAIT_CPU,
 243         LTTV_STATE_EXIT,
 244         LTTV_STATE_ZOMBIE,
 245         LTTV_STATE_WAIT,
 246         LTTV_STATE_RUN,
 247         LTTV_STATE_DEAD;
 248
 249 typedef GQuark LttvProcessType;
 250
 251 extern LttvProcessType
 252         LTTV_STATE_USER_THREAD,
 253         LTTV_STATE_KERNEL_THREAD;
 254
 255 typedef GQuark LttvCPUMode;
 256 extern LttvCPUMode
 257         LTTV_CPU_UNKNOWN,
 258         LTTV_CPU_IDLE,
 259         LTTV_CPU_BUSY,
 260         LTTV_CPU_IRQ,
 261         LTTV_CPU_SOFT_IRQ,
 262         LTTV_CPU_TRAP;
 263
 264 typedef GQuark LttvIRQMode;
 265 extern LttvIRQMode
 266         LTTV_IRQ_UNKNOWN,
 267         LTTV_IRQ_IDLE,
 268         LTTV_IRQ_BUSY;
 269
 270 typedef GQuark LttvBdevMode;
 271 extern LttvBdevMode
 272         LTTV_BDEV_UNKNOWN,
 273         LTTV_BDEV_IDLE,
 274         LTTV_BDEV_BUSY_READING,
 275         LTTV_BDEV_BUSY_WRITING;
 276
 277 typedef struct _LttvExecutionState {
 278         LttvExecutionMode t;
 279         LttvExecutionSubmode n;
 280         LttTime entry;
 281         LttTime change;
 282         LttTime cum_cpu_time;
 283         LttvProcessStatus s;
 284 } LttvExecutionState;
 285
 286 typedef struct _LttvProcessState {
 287         guint pid;
 288         guint tgid;
 289         guint ppid;
 290         LttTime creation_time;
 291         LttTime insertion_time;
 292         GQuark name;
 293         GQuark pid_time;
 294         GArray *execution_stack;         /* Array of LttvExecutionState */
 295         LttvExecutionState *state;       /* Top of interrupt stack */
 296                 /* WARNING : each time the execution_stack size is modified, the state
 297                  * must be reget : g_array_set_size can have to move the array.
 298                  * (Mathieu) */
 299         guint cpu;                /* CPU where process is scheduled (being either in
 300                                      the active or inactive runqueue)*/
 301 //      guint last_tracefile_index;    /* index in the trace for cpu tracefile */
 302         /* opened file descriptors, address map?... */
 303         LttvProcessType type;        /* kernel thread or user space ? */
 304         guint free_events; /* 0 : none, 1 : free or exit dead, 2 : should delete */
 305         GHashTable *fds; /* hash table of int (file descriptor) -> GQuark (file name) */
 306 } LttvProcessState;
 307
 308 #define ANY_CPU 0 /* For clarity sake : a call to lttv_state_find_process for
 309                      a PID != 0 will search on any cpu automatically. */
 310
 311 LttvProcessState *lttv_state_find_process(LttvTraceState *ts, guint cpu,
 312                 guint pid);
 313
 314 LttvProcessState *lttv_state_find_process_or_create(LttvTraceState *ts,
 315                 guint cpu, guint pid, const LttTime *timestamp);
 316
 317 LttvProcessState *lttv_state_create_process(LttvTraceState *tcs,
 318                 LttvProcessState *parent, guint cpu, guint pid,
 319                 guint tgid, GQuark name, const LttTime *timestamp);
 320
 321 //void lttv_state_write(LttvTraceState *trace_state, LttTime t, FILE *fp);
 322 //void lttv_state_write_raw(LttvTraceState *trace_state, LttTime t, FILE *fp);
 323
 324 typedef struct _LttvCPUState {
 325         GArray *mode_stack;
 326         GArray *irq_stack;
 327         GArray *softirq_stack;
 328         GArray *trap_stack;
 329 } LttvCPUState;
 330
 331 typedef struct _LttvIRQState {
 332         GArray *mode_stack;
 333 } LttvIRQState;
 334
 335 typedef struct _LttvSoftIRQState {
 336         guint pending; /* number of times it is pending */
 337         guint running; /* number of times it is currently running (on different processors) */
 338 } LttvSoftIRQState;
 339
 340 typedef struct _LttvTrapState {
 341         guint running; /* number of times it is currently running (on different processors) */
 342 } LttvTrapState;
 343
 344 typedef struct _LttvBdevState {
 345         GArray *mode_stack;
 346 } LttvBdevState;
 347
 348 typedef struct _LttvNameTables {
 349         GQuark *syscall_names;
 350         guint nb_syscalls;
 351         GQuark *trap_names;
 352         guint nb_traps;
 353         GQuark *irq_names;
 354         guint nb_irqs;
 355         GQuark *soft_irq_names;
 356         guint nb_soft_irqs;
 357         GHashTable *kprobe_hash;
 358 } LttvNameTables;
 359
 360 struct _LttvTraceState {
 361         LttvTrace *trace;       /* LttvTrace this state belongs to */
 362         GHashTable *processes;  /* LttvProcessState objects indexed by pid and
 363                                    last_cpu */
 364         guint nb_event, save_interval;
 365         /* Block/char devices, locks, memory pages... */
 366         GQuark *eventtype_names;
 367         LttvNameTables *name_tables;
 368         LttTime *max_time_state_recomputed_in_seek;
 369         GHashTable *kprobe_hash;
 370
 371         /* Array of per cpu running process */
 372         LttvProcessState **running_process;
 373
 374         LttvCPUState *cpu_states; /* state of each cpu */
 375         /* FIXME should be a g_array to deal with resize and copy. */
 376         LttvIRQState *irq_states; /* state of each irq handler */
 377         /* FIXME should be a g_array to deal with resize and copy. */
 378         LttvSoftIRQState *soft_irq_states; /* state of each softirq */
 379         /* FIXME should be a g_array to deal with resize and copy. */
 380         LttvTrapState *trap_states; /* state of each trap */
 381         GHashTable *bdev_states; /* state of the block devices */
 382 };
 383
 384 void lttv_trace_state_init(LttvTraceState *self, LttvTrace *trace);
 385 void lttv_trace_state_fini(LttvTraceState *self);
 386
 387 void lttv_state_save(LttvTraceState *self, LttvAttribute *container);
 388 void lttv_state_restore(LttvTraceState *self, LttvAttribute *container);
 389 LttvTracesetPosition *lttv_trace_state_get_position(LttvAttribute *container);
 390 void lttv_state_saved_free(LttvTraceState *self, LttvAttribute *container);
 391
 392 //TODO ybrosseau Need to export that cleanly
 393 //int lttv_state_pop_state_cleanup(LttvProcessState *process,
 394 //                               LttvEvent *event);
 395
 396 #define HDR_PROCESS 0
 397 #define HDR_ES 1
 398 #define HDR_USER_STACK 2
 399 //#define HDR_USERTRACE 3
 400 #define HDR_PROCESS_STATE 4
 401 #define HDR_CPU 5
 402 #define HDR_TRACEFILE 6
 403 #define HDR_TRACESET 7
 404 #define HDR_TRACE 8
 405 #define HDR_QUARKS 9
 406 #define HDR_QUARK 10
 407
 408 /* Device number manipulation macros from kernel source */
 409 #define MINORBITS       20
 410 #define MINORMASK       ((1U << MINORBITS) - 1)
 411 #define MAJOR(dev)      ((unsigned int) ((dev) >> MINORBITS))
 412 #define MINOR(dev)      ((unsigned int) ((dev) & MINORMASK))
 413 #define MKDEV(ma, mi)   ((((unsigned int) (ma)) << MINORBITS) | (unsigned int) (mi))
 414
 415 #endif // STATE_H