ltt/branches/poly/include/lttv/processTrace.h

   1 #ifndef PROCESSTRACE_H
   2 #define PROCESSTRACE_H
   3
   4 #include <lttv/traceset.h>
   5 #include <lttv/attribute.h>
   6 #include <lttv/hook.h>
   7 #include <ltt/ltt.h>
   8
   9 /* This is the generic part of trace processing. All events within a
  10    certain time interval are accessed and processing hooks are called for
  11    each. The events are examined in monotonically increasing time to more
  12    closely follow the traced system behavior.
  13
  14    Hooks are called at several different places during the processing:
  15    before traceset, after traceset, check trace, before trace, after trace,
  16    check tracefile, before tracefile, after tracefile,
  17    check_event, before_event, before_event_by_id,
  18    after_event, after_event_by_id.
  19
  20    In each case the "check" hooks are called first to determine if further
  21    processing of the trace, tracefile or event is wanted. Then, the before
  22    hooks and the after hooks are called. The before hooks for a traceset
  23    are called before those for the contained traces, which are called before
  24    those for the contained tracefiles. The after hooks are called in reverse
  25    order. The event hooks are called after all the before_tracefile hooks
  26    and before all the after_tracefile hooks.
  27
  28    The hooks receive two arguments, the hook_data and call_data. The hook_data
  29    is specified when the hook is registered and typically links to the
  30    object registering the hook (e.g. a graphical events viewer). The call_data
  31    must contain all the context related to the call. The traceset hooks receive
  32    the LttvTracesetContext provided by the caller. The trace hooks receive
  33    the LttvTraceContext from the traces array in the LttvTracesetContext.
  34    The tracefile and event hooks receive the LttvTracefileContext from
  35    the tracefiles array in the LttvTraceContext. The LttEvent and LttTime
  36    fields in the tracefile context are set to the current event and current
  37    event time before calling the event hooks. No other context field is
  38    modified.
  39
  40    The contexts in the traces and tracefiles arrays must be allocated by
  41    the caller, either before the call or during the before hooks of the
  42    enclosing traceset or trace. The order in the traces array must
  43    correspond to the lttv_traceset_get function. The order in the tracefiles
  44    arrays must correspond to the ltt_trace_control_tracefile_get and
  45    ltt_trace_per_cpu_tracefile_get functions. The traceset, trace and
  46    tracefile contexts may be subtyped as needed. Indeed, both the contexts
  47    and the hooks are defined by the caller. */
  48
  49
  50 typedef struct _LttvTracesetContext LttvTracesetContext;
  51 typedef struct _LttvTracesetContextClass LttvTracesetContextClass;
  52
  53 typedef struct _LttvTraceContext LttvTraceContext;
  54 typedef struct _LttvTraceContextClass LttvTraceContextClass;
  55
  56 typedef struct _LttvTracefileContext LttvTracefileContext;
  57 typedef struct _LttvTracefileContextClass LttvTracefileContextClass;
  58
  59 #define LTTV_TRACESET_CONTEXT_TYPE  (lttv_traceset_context_get_type ())
  60 #define LTTV_TRACESET_CONTEXT(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContext))
  61 #define LTTV_TRACESET_CONTEXT_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
  62 #define LTTV_IS_TRACESET_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACESET_CONTEXT_TYPE))
  63 #define LTTV_IS_TRACESET_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACESET_CONTEXT_TYPE))
  64 #define LTTV_TRACESET_CONTEXT_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACESET_CONTEXT_TYPE, LttvTracesetContextClass))
  65
  66 struct _LttvTracesetContext {
  67   GObject parent;
  68
  69   LttvTraceset *ts;
  70   LttvHooks *before;
  71   LttvHooks *after;
  72   LttvTraceContext **traces;
  73   LttvAttribute *a;
  74 };
  75
  76 struct _LttvTracesetContextClass {
  77   GObjectClass parent;
  78
  79   void (*init) (LttvTracesetContext *self, LttvTraceset *ts);
  80   void (*fini) (LttvTracesetContext *self);
  81   LttvTracesetContext* (*new_traceset_context) (LttvTracesetContext *self);
  82   LttvTraceContext* (*new_trace_context) (LttvTracesetContext *self);
  83   LttvTracefileContext* (*new_tracefile_context) (LttvTracesetContext *self);
  84 };
  85
  86 GType lttv_traceset_context_get_type (void);
  87
  88 void lttv_context_init(LttvTracesetContext *self, LttvTraceset *ts);
  89
  90 void lttv_context_fini(LttvTracesetContext *self);
  91
  92 LttvTracesetContext *
  93 lttv_context_new_traceset_context(LttvTracesetContext *self);
  94
  95 LttvTraceContext *
  96 lttv_context_new_trace_context(LttvTracesetContext *self);
  97
  98 LttvTracefileContext *
  99 lttv_context_new_tracefile_context(LttvTracesetContext *self);
 100
 101
 102 #define LTTV_TRACE_CONTEXT_TYPE  (lttv_trace_context_get_type ())
 103 #define LTTV_TRACE_CONTEXT(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContext))
 104 #define LTTV_TRACE_CONTEXT_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
 105 #define LTTV_IS_TRACE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACE_CONTEXT_TYPE))
 106 #define LTTV_IS_TRACE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACE_CONTEXT_TYPE))
 107 #define LTTV_TRACE_CONTEXT_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACE_CONTEXT_TYPE, LttvTraceContextClass))
 108
 109 struct _LttvTraceContext {
 110   GObject parent;
 111
 112   LttvTracesetContext *ts_context;
 113   guint index;                /* in ts_context->traces */
 114   LttTrace *t;
 115   LttvHooks *check;
 116   LttvHooks *before;
 117   LttvHooks *after;
 118   LttvTracefileContext **control_tracefiles;
 119   LttvTracefileContext **per_cpu_tracefiles;
 120   LttvAttribute *a;
 121 };
 122
 123 struct _LttvTraceContextClass {
 124   GObjectClass parent;
 125 };
 126
 127 GType lttv_trace_context_get_type (void);
 128
 129 #define LTTV_TRACEFILE_CONTEXT_TYPE  (lttv_tracefile_context_get_type ())
 130 #define LTTV_TRACEFILE_CONTEXT(obj)  (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContext))
 131 #define LTTV_TRACEFILE_CONTEXT_CLASS(vtable)  (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
 132 #define LTTV_IS_TRACEFILE_CONTEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_TRACEFILE_CONTEXT_TYPE))
 133 #define LTTV_IS_TRACEFILE_CONTEXT_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_TRACEFILE_CONTEXT_TYPE))
 134 #define LTTV_TRACEFILE_CONTEXT_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_TRACEFILE_CONTEXT_TYPE, LttvTracefileContextClass))
 135
 136 struct _LttvTracefileContext {
 137   GObject parent;
 138
 139   LttvTraceContext *t_context;
 140   gboolean control;
 141   guint index;                /* in ts_context->control/per_cpu_tracefiles */
 142   LttTracefile *tf;
 143   LttvHooks *check;
 144   LttvHooks *before;
 145   LttvHooks *after;
 146   LttEvent *e;
 147   LttvHooks *check_event;
 148   LttvHooks *before_event;
 149   LttvHooksById *before_event_by_id;
 150   LttvHooks *after_event;
 151   LttvHooksById *after_event_by_id;
 152   LttTime timestamp;
 153   LttvAttribute *a;
 154 };
 155
 156 struct _LttvTracefileContextClass {
 157   GObjectClass parent;
 158 };
 159
 160 GType lttv_tracefile_context_get_type (void);
 161
 162 void lttv_process_trace(LttTime start, LttTime end, LttvTraceset *traceset,
 163     LttvTracesetContext *context, unsigned maxNumEvents);
 164
 165 void lttv_traceset_context_add_hooks(LttvTracesetContext *self,
 166     LttvHooks *before_traceset,
 167     LttvHooks *after_traceset,
 168     LttvHooks *check_trace,
 169     LttvHooks *before_trace,
 170     LttvHooks *after_trace,
 171     LttvHooks *check_tracefile,
 172     LttvHooks *before_tracefile,
 173     LttvHooks *after_tracefile,
 174     LttvHooks *check_event,
 175     LttvHooks *before_event,
 176     LttvHooks *after_event);
 177
 178 void lttv_traceset_context_remove_hooks(LttvTracesetContext *self,
 179     LttvHooks *before_traceset,
 180     LttvHooks *after_traceset,
 181     LttvHooks *check_trace,
 182     LttvHooks *before_trace,
 183     LttvHooks *after_trace,
 184     LttvHooks *check_tracefile,
 185     LttvHooks *before_tracefile,
 186     LttvHooks *after_tracefile,
 187     LttvHooks *check_event,
 188     LttvHooks *before_event,
 189     LttvHooks *after_event);
 190
 191 typedef struct _LttvTraceHook {
 192   LttvHook h;
 193   guint id;
 194   LttField *f1;
 195   LttField *f2;
 196   LttField *f3;
 197 } LttvTraceHook;
 198
 199
 200 /* Search in the trace for the id of the named event type within the named
 201    facility. Then, find the three (if non null) named fields. All that
 202    information is then used to fill the LttvTraceHook structure. This
 203    is useful to find the specific id for an event within a trace, for
 204    registering a hook using this structure as event data;
 205    it already contains the (up to three) needed fields handles. */
 206
 207 void lttv_trace_find_hook(LttTrace *t, char *facility, char *event_type,
 208     char *field1, char *field2, char *field3, LttvHook h, LttvTraceHook *th);
 209
 210 #endif // PROCESSTRACE_H