liblttvtraceread: clean up by removing old commented code

[lttv.git] / ltt / branches / poly / ltt / trace.h

diff --git a/ltt/branches/poly/ltt/trace.h b/ltt/branches/poly/ltt/trace.h
index 3b113167619d5b52f74fbc29a2ed17364b49488b..3e8e0de3aae88887cdb28e5e0ae05520c28685d1 100644 (file)
--- a/ltt/branches/poly/ltt/trace.h
+++ b/ltt/branches/poly/ltt/trace.h
@@ -1,5 +1,6 @@
 /* This file is part of the Linux Trace Toolkit trace reading library
  * Copyright (C) 2003-2004 Michel Dagenais
+ *               2005 Mathieu Desnoyers
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -20,10 +21,40 @@
 #define TRACE_H
 
 #include <ltt/ltt.h>
+#include <stdint.h>
+#include <glib.h>
+
+struct LttTrace {
+  GQuark pathname;                          //the pathname of the trace
+  //LttSystemDescription * system_description;//system description 
+
+  guint     num_cpu;
+
+  guint32   arch_type;
+  guint32   arch_variant;
+  guint8    arch_size;
+  guint8    ltt_major_version;
+  guint8    ltt_minor_version;
+  guint8    flight_recorder;
+  guint32   freq_scale;
+  uint64_t  start_freq;
+  uint64_t  start_tsc;
+  uint64_t  start_monotonic;
+  LttTime   start_time;
+  LttTime   start_time_from_tsc;
+
+  GData     *tracefiles;                    //tracefiles groups
+  /* Support for markers */
+  GArray    *markers;                       //indexed by marker ID
+  GHashTable *markers_hash;                 //indexed by name hash
+  GHashTable *markers_format_hash;                 //indexed by name hash
+};
+
 
 
 extern GQuark LTT_FACILITY_NAME_HEARTBEAT,
-              LTT_EVENT_NAME_HEARTBEAT;
+              LTT_EVENT_NAME_HEARTBEAT,
+              LTT_EVENT_NAME_HEARTBEAT_FULL;
 
 /* A trace is specified as a pathname to the directory containing all the
    associated data (control tracefiles, per cpu tracefiles, event 
@@ -44,44 +75,36 @@ LttTrace *ltt_trace_open(const gchar *pathname);
  */
 LttTrace *ltt_trace_copy(LttTrace *self);
 
-GQuark ltt_trace_name(LttTrace *t);
+GQuark ltt_trace_name(const LttTrace *t);
 
 void ltt_trace_close(LttTrace *t); 
 
+guint ltt_trace_get_num_cpu(LttTrace *t);
 
 LttSystemDescription *ltt_trace_system_description(LttTrace *t);
 
 
-/* Functions to discover the facilities in the trace. Once the number
-   of facilities is known, they may be accessed by position. Multiple
-   versions of a facility (same name, different checksum) have consecutive
-   positions. */
-
-unsigned ltt_trace_facility_number(LttTrace *t);
-
-LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i);
+/* Get the start time and end time of the trace */
 
-LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id);
+void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);
 
-/* Returns an array of indexes (guint) that matches the facility name */
-GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name);
 
-/* Functions to discover all the event types in the trace */
+/* Get the name of a tracefile */
 
-unsigned ltt_trace_eventtype_number(LttTrace *t);
+GQuark ltt_tracefile_name(const LttTracefile *tf);
+GQuark ltt_tracefile_long_name(const LttTracefile *tf);
 
-LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i);
+/* get the cpu number of the tracefile */
 
+guint ltt_tracefile_cpu(LttTracefile *tf);
 
-/* Get the start time and end time of the trace */
+/* For usertrace */
+guint ltt_tracefile_tid(LttTracefile *tf);
+guint ltt_tracefile_pgid(LttTracefile *tf);
+guint64 ltt_tracefile_creation(LttTracefile *tf);
 
-void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);
-
-
-/* Get the name of a tracefile */
-
-GQuark ltt_tracefile_name(LttTracefile *tf);
 
+LttTrace *ltt_tracefile_get_trace(LttTracefile *tf);
 
 /* Get the number of blocks in the tracefile */
 
@@ -106,6 +129,9 @@ int ltt_tracefile_read_seek(LttTracefile *t);
 int ltt_tracefile_read_update_event(LttTracefile *t);
 int ltt_tracefile_read_op(LttTracefile *t);
 
+/* Get the current event of the tracefile : valid until the next read */
+LttEvent *ltt_tracefile_get_event(LttTracefile *tf);
+
 /* open tracefile */
 
 gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf);
@@ -132,9 +158,13 @@ gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 
 
-/* get the start time of the trace */
+/* get the NTP start time of the trace */
+
+LttTime ltt_trace_start_time(LttTrace *t);
 
-LttTime ltt_trace_system_description_trace_start_time(LttSystemDescription *s);
+/* get the monotonic start time of the trace */
+
+LttTime ltt_trace_start_time_monotonic(LttTrace *t);
 
 /* copy tracefile info over another. Used for sync. */
 LttTracefile *ltt_tracefile_new();
@@ -143,7 +173,8 @@ void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src);
 
 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 
-GData *ltt_trace_get_tracefiles_groups(LttTrace *trace);
+/* May return a NULL tracefile group */
+GData **ltt_trace_get_tracefiles_groups(LttTrace *trace);
 
 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 
@@ -152,14 +183,19 @@ struct compute_tracefile_group_args {
   gpointer func_args;
 };
 
-void compute_tracefile_group(GArray *group,
-                             struct compute_tracefile_group_args args);
 
-LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
+void compute_tracefile_group(GQuark key_id,
+                             GArray *group,
+                             struct compute_tracefile_group_args *args);
+
+
+gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data);
+
+guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data);
 
+LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc);
 
-gint check_fields_compatibility(LttEventType *event_type1,
-    LttEventType *event_type2,
-    LttField *field1, LttField *field2);
+/* Set to enable event debugging output */
+void ltt_event_debug(int state);
 
 #endif // TRACE_H