| 1 | /* This file is part of the Linux Trace Toolkit trace reading library |
| 2 | * Copyright (C) 2003-2004 Michel Dagenais |
| 3 | * 2005 Mathieu Desnoyers |
| 4 | * |
| 5 | * This library is free software; you can redistribute it and/or |
| 6 | * modify it under the terms of the GNU Lesser General Public |
| 7 | * License Version 2.1 as published by the Free Software Foundation. |
| 8 | * |
| 9 | * This library is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 12 | * Lesser General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU Lesser General Public |
| 15 | * License along with this library; if not, write to the |
| 16 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 17 | * Boston, MA 02111-1307, USA. |
| 18 | */ |
| 19 | |
| 20 | #ifndef TRACE_H |
| 21 | #define TRACE_H |
| 22 | |
| 23 | #include <ltt/ltt.h> |
| 24 | |
| 25 | extern GQuark LTT_FACILITY_NAME_HEARTBEAT, |
| 26 | LTT_EVENT_NAME_HEARTBEAT; |
| 27 | |
| 28 | /* A trace is specified as a pathname to the directory containing all the |
| 29 | associated data (control tracefiles, per cpu tracefiles, event |
| 30 | descriptions...). |
| 31 | |
| 32 | When a trace is closed, all the associated facilities, types and fields |
| 33 | are released as well. |
| 34 | |
| 35 | return value is NULL if there is an error when opening the trace. |
| 36 | |
| 37 | */ |
| 38 | |
| 39 | LttTrace *ltt_trace_open(const gchar *pathname); |
| 40 | |
| 41 | /* copy reopens a trace |
| 42 | * |
| 43 | * return value NULL if error while opening the trace |
| 44 | */ |
| 45 | LttTrace *ltt_trace_copy(LttTrace *self); |
| 46 | |
| 47 | GQuark ltt_trace_name(const LttTrace *t); |
| 48 | |
| 49 | void ltt_trace_close(LttTrace *t); |
| 50 | |
| 51 | guint ltt_trace_get_num_cpu(LttTrace *t); |
| 52 | |
| 53 | LttSystemDescription *ltt_trace_system_description(LttTrace *t); |
| 54 | |
| 55 | |
| 56 | /* Functions to discover the facilities in the trace. Once the number |
| 57 | of facilities is known, they may be accessed by position. Multiple |
| 58 | versions of a facility (same name, different checksum) have consecutive |
| 59 | positions. */ |
| 60 | |
| 61 | unsigned ltt_trace_facility_number(LttTrace *t); |
| 62 | |
| 63 | LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i); |
| 64 | |
| 65 | LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id); |
| 66 | |
| 67 | /* Returns an array of indexes (guint) that matches the facility name */ |
| 68 | GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name); |
| 69 | |
| 70 | /* Functions to discover all the event types in the trace */ |
| 71 | |
| 72 | unsigned ltt_trace_eventtype_number(LttTrace *t); |
| 73 | |
| 74 | LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i); |
| 75 | |
| 76 | |
| 77 | /* Get the start time and end time of the trace */ |
| 78 | |
| 79 | void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end); |
| 80 | |
| 81 | |
| 82 | /* Get the name of a tracefile */ |
| 83 | |
| 84 | GQuark ltt_tracefile_name(const LttTracefile *tf); |
| 85 | GQuark ltt_tracefile_long_name(const LttTracefile *tf); |
| 86 | |
| 87 | /* get the cpu number of the tracefile */ |
| 88 | |
| 89 | guint ltt_tracefile_num(LttTracefile *tf); |
| 90 | |
| 91 | LttTrace *ltt_tracefile_get_trace(LttTracefile *tf); |
| 92 | |
| 93 | /* Get the number of blocks in the tracefile */ |
| 94 | |
| 95 | unsigned ltt_tracefile_block_number(LttTracefile *tf); |
| 96 | |
| 97 | |
| 98 | /* Seek to the first event of the trace with time larger or equal to time */ |
| 99 | |
| 100 | int ltt_tracefile_seek_time(LttTracefile *t, LttTime time); |
| 101 | |
| 102 | /* Seek to the first event with position equal or larger to ep */ |
| 103 | |
| 104 | int ltt_tracefile_seek_position(LttTracefile *t, |
| 105 | const LttEventPosition *ep); |
| 106 | |
| 107 | /* Read the next event */ |
| 108 | |
| 109 | int ltt_tracefile_read(LttTracefile *t); |
| 110 | |
| 111 | /* ltt_tracefile_read cut down in pieces */ |
| 112 | int ltt_tracefile_read_seek(LttTracefile *t); |
| 113 | int ltt_tracefile_read_update_event(LttTracefile *t); |
| 114 | int ltt_tracefile_read_op(LttTracefile *t); |
| 115 | |
| 116 | /* Get the current event of the tracefile : valid until the next read */ |
| 117 | LttEvent *ltt_tracefile_get_event(LttTracefile *tf); |
| 118 | |
| 119 | /* open tracefile */ |
| 120 | |
| 121 | gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf); |
| 122 | |
| 123 | /* get the data type size and endian type of the local machine */ |
| 124 | |
| 125 | void getDataEndianType(LttArchSize * size, LttArchEndian * endian); |
| 126 | |
| 127 | /* get an integer number */ |
| 128 | gint64 get_int(gboolean reverse_byte_order, gint size, void *data); |
| 129 | |
| 130 | /* get the node name of the system */ |
| 131 | |
| 132 | gchar * ltt_trace_system_description_node_name (LttSystemDescription * s); |
| 133 | |
| 134 | |
| 135 | /* get the domain name of the system */ |
| 136 | |
| 137 | gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s); |
| 138 | |
| 139 | |
| 140 | /* get the description of the system */ |
| 141 | |
| 142 | gchar * ltt_trace_system_description_description (LttSystemDescription * s); |
| 143 | |
| 144 | |
| 145 | /* get the NTP start time of the trace */ |
| 146 | |
| 147 | LttTime ltt_trace_start_time(LttTrace *t); |
| 148 | |
| 149 | /* get the monotonic start time of the trace */ |
| 150 | |
| 151 | LttTime ltt_trace_start_time_monotonic(LttTrace *t); |
| 152 | |
| 153 | /* copy tracefile info over another. Used for sync. */ |
| 154 | LttTracefile *ltt_tracefile_new(); |
| 155 | void ltt_tracefile_destroy(LttTracefile *tf); |
| 156 | void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src); |
| 157 | |
| 158 | void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname); |
| 159 | |
| 160 | /* May return a NULL tracefile group */ |
| 161 | GData **ltt_trace_get_tracefiles_groups(LttTrace *trace); |
| 162 | |
| 163 | typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args); |
| 164 | |
| 165 | struct compute_tracefile_group_args { |
| 166 | ForEachTraceFileFunc func; |
| 167 | gpointer func_args; |
| 168 | }; |
| 169 | |
| 170 | |
| 171 | void compute_tracefile_group(GQuark key_id, |
| 172 | GArray *group, |
| 173 | struct compute_tracefile_group_args *args); |
| 174 | |
| 175 | LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num); |
| 176 | |
| 177 | |
| 178 | gint check_fields_compatibility(LttEventType *event_type1, |
| 179 | LttEventType *event_type2, |
| 180 | LttField *field1, LttField *field2); |
| 181 | |
| 182 | gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data); |
| 183 | |
| 184 | guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data); |
| 185 | |
| 186 | #endif // TRACE_H |