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 <lttv/trace.h>
  27 /* A traceset is a set of traces to be analyzed together. */
  28
  29 typedef struct _LttvTraceset LttvTraceset;
  30
  31 typedef struct _LttvTracesetPosition LttvTracesetPosition;
  32
  33 struct bt_context;
  34
  35
  36 //TODO ybrosseau 2012-05-15 put these struct in the .c to make them opaque
  37 struct _LttvTraceset {
  38         char * filename;
  39         GPtrArray *traces;              /* Array of pointers to LttvTrace */
  40         struct bt_context *context;
  41         LttvAttribute *a;
  42         LttvHooks *event_hooks;
  43         struct bt_ctf_iter *iter;
  44         GPtrArray *state_trace_handle_index;
  45 };
  46
  47 struct _LttvTrace {
  48         // Trace id for babeltrace
  49         LttvTraceset *traceset;         /* container traceset */
  50         gint id;
  51         LttvAttribute *a;
  52         guint ref_count;
  53         LttvTraceState *state;
  54 };
  55
  56 /* In babeltrace, the position concept is an iterator. */
  57 struct _LttvTracesetPosition {
  58         struct bt_ctf_iter *iter;
  59 };
  60
  61 /* Tracesets may be added to, removed from and their content listed. */
  62
  63 LttvTraceset *lttv_traceset_new(void);
  64
  65 char * lttv_traceset_name(LttvTraceset * s);
  66
  67 #ifdef BABEL_CLEANUP
  68 LttvTrace *lttv_trace_new(LttTrace *t);
  69 #endif
  70
  71 LttvTraceset *lttv_traceset_copy(LttvTraceset *s_orig);
  72
  73 LttvTraceset *lttv_traceset_load(const gchar *filename);
  74
  75 struct bt_context *lttv_traceset_get_context(LttvTraceset *s);
  76
  77
  78
  79 gint lttv_traceset_save(LttvTraceset *s);
  80
  81 void lttv_traceset_destroy(LttvTraceset *s);
  82
  83
  84 void lttv_traceset_add(LttvTraceset *s, LttvTrace *t);
  85
  86 /*
  87  * lttv_trace_create : Add all traces recursively to a traceset from a path
  88  *
  89  * ts is the traceset in which will be contained the traces
  90  *
  91  * trace_path is the path where to find a set of trace.
  92  * Traverse the path recursively to add all traces within.
  93  *
  94  * return 0 on success or a negative integer on failure
  95  */
  96 int lttv_traceset_add_path(LttvTraceset *ts, char *path);
  97
  98 unsigned lttv_traceset_number(LttvTraceset *s);
  99
 100 LttvTrace *lttv_traceset_get(LttvTraceset *s, unsigned i);
 101
 102 void lttv_traceset_remove(LttvTraceset *s, unsigned i);
 103
 104 /* An attributes table is attached to the set and to each trace in the set. */
 105
 106 LttvAttribute *lttv_traceset_attribute(LttvTraceset *s);
 107
 108
 109 #ifdef BABEL_CLEANUP
 110 LttTrace *lttv_trace(LttvTrace *t);
 111 #endif
 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(LttvTracesetPosition *traceset_pos);
 120
 121 guint lttv_traceset_get_cpuid_from_event(LttvEvent *event);
 122
 123 const char *lttv_traceset_get_name_from_event(LttvEvent *event);
 124
 125 #endif // TRACESET_H