lttv/lttv/traceset.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 TRACESET_H
  20 #define TRACESET_H
  21
  22 #include <lttv/attribute.h>
  23 #include <lttv/hook.h>
  24 #include <lttv/event.h>
  25 #include <ltt/ltt.h>
  26 #include <ltt/time.h>
  27 #include <lttv/trace.h>
  28 /* A traceset is a set of traces to be analyzed together. */
  29
  30 typedef struct _LttvTraceset LttvTraceset;
  31
  32 typedef struct _LttvTracesetPosition LttvTracesetPosition;
  33
  34 struct bt_context;
  35
  36
  37 //TODO ybrosseau 2012-05-15 put these struct in the .c to make them opaque
  38 struct _LttvTraceset {
  39         char * filename;
  40         GPtrArray *traces;              /* Array of pointers to LttvTrace */
  41         struct bt_context *context;
  42         LttvAttribute *a;
  43         LttvHooks *event_hooks;
  44         struct bt_ctf_iter *iter;
  45         GPtrArray *state_trace_handle_index;
  46 };
  47
  48 struct _LttvTrace {
  49         // Trace id for babeltrace
  50         LttvTraceset *traceset;         /* container traceset */
  51         gint id;
  52         LttvAttribute *a;
  53         guint ref_count;
  54         LttvTraceState *state;
  55 };
  56
  57 /* In babeltrace, the position concept is an iterator. */
  58 struct _LttvTracesetPosition {
  59         struct bt_ctf_iter *iter;
  60         struct bt_iter_pos *bt_pos;
  61 };
  62
  63 /* Tracesets may be added to, removed from and their content listed. */
  64
  65 LttvTraceset *lttv_traceset_new(void);
  66
  67 char * lttv_traceset_name(LttvTraceset * s);
  68
  69 #ifdef BABEL_CLEANUP
  70 LttvTrace *lttv_trace_new(LttTrace *t);
  71 #endif
  72
  73 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
  74
  75 LttvTraceset *lttv_traceset_copy(LttvTraceset *s_orig);
  76
  77 LttvTraceset *lttv_traceset_load(const gchar *filename);
  78
  79 struct bt_context *lttv_traceset_get_context(LttvTraceset *s);
  80
  81
  82
  83 gint lttv_traceset_save(LttvTraceset *s);
  84
  85 void lttv_traceset_destroy(LttvTraceset *s);
  86
  87
  88 void lttv_traceset_add(LttvTraceset *s, LttvTrace *t);
  89
  90 /*
  91  * lttv_trace_create : Add all traces recursively to a traceset from a path
  92  *
  93  *
  94  * ts is the traceset in which will be contained the traces
  95  *
  96  * trace_path is the path where to find a set of trace.
  97  * Traverse the path recursively to add all traces within.
  98  *
  99  * return 0 on success or a negative integer on failure
 100  */
 101 int lttv_traceset_add_path(LttvTraceset *ts, char *path);
 102
 103 unsigned lttv_traceset_number(LttvTraceset *s);
 104
 105 LttvTrace *lttv_traceset_get(LttvTraceset *s, unsigned i);
 106
 107 void lttv_traceset_remove(LttvTraceset *s, unsigned i);
 108
 109 /* An attributes table is attached to the set and to each trace in the set. */
 110
 111 LttvAttribute *lttv_traceset_attribute(LttvTraceset *s);
 112
 113 /* Take a position snapshot */
 114 LttvTracesetPosition *lttv_traceset_create_position(LttvTraceset *traceset);
 115
 116 /* Destroy position snapshot */
 117 void lttv_traceset_destroy_position(LttvTracesetPosition *traceset_pos);
 118
 119 void lttv_traceset_seek_to_position(const LttvTracesetPosition *traceset_pos);
 120
 121 guint lttv_traceset_get_cpuid_from_event(LttvEvent *event);
 122 /* Returns the minimum timestamp of the traces in the traceset */
 123 guint64 lttv_traceset_get_timestamp_begin(LttvTraceset *traceset);
 124 /* Returns the maximum timestamp of the traces in the traceset */
 125 guint64 lttv_traceset_get_timestamp_end(LttvTraceset *traceset);
 126 /* Return a TimeInterval from timestamp of the first event to the last event [experimentale]*/
 127 TimeInterval lttv_traceset_get_time_span_real(LttvTraceset *ts);
 128 /* Returns a TimeInterval struct that represents the min and max of the traceset */
 129 TimeInterval lttv_traceset_get_time_span(LttvTraceset *traceset);
 130
 131 const char *lttv_traceset_get_name_from_event(LttvEvent *event);
 132
 133 LttvTracesetPosition *lttv_traceset_create_time_position(LttvTraceset *ts, LttTime timestamp);
 134
 135 guint64 lttv_traceset_position_get_timestamp(const LttvTracesetPosition *pos);
 136
 137 LttTime  lttv_traceset_position_get_time(const LttvTracesetPosition *pos);
 138
 139 int lttv_traceset_position_compare(const LttvTracesetPosition *pos1, const LttvTracesetPosition *pos2);
 140
 141
 142
 143 #endif // TRACESET_H