1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Xiangxiu Yang
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;
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.
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,
23 #include <sys/types.h>
26 #define LTT_MAGIC_NUMBER 0x00D6B7ED
27 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
29 #define NSEC_PER_USEC 1000
31 #define LTT_PACKED_STRUCT __attribute__ ((packed))
33 /* Hardcoded facilities */
34 #define LTT_FACILITY_CORE 0
36 /* Hardcoded core events */
37 enum ltt_core_events
{
38 LTT_EVENT_FACILITY_LOAD
,
39 LTT_EVENT_FACILITY_UNLOAD
,
40 LTT_EVENT_STATE_DUMP_FACILITY_LOAD
,
46 /* enumeration definition */
48 typedef enum _BuildinEvent
{
49 TRACE_FACILITY_LOAD
= 0,
50 TRACE_BLOCK_START
= 17,
52 TRACE_TIME_HEARTBEAT
= 19
56 /* structure definition */
58 typedef struct _FacilityLoad
{
62 } LTT_PACKED_STRUCT FacilityLoad
;
64 typedef struct _BlockStart
{
65 LttTime time
; //Time stamp of this block
66 LttCycleCount cycle_count
; //cycle count of the event
67 guint32 block_id
; //block id
68 } LTT_PACKED_STRUCT BlockStart
;
70 typedef struct _BlockEnd
{
71 LttTime time
; //Time stamp of this block
72 LttCycleCount cycle_count
; //cycle count of the event
73 guint32 block_id
; //block id
74 } LTT_PACKED_STRUCT BlockEnd
;
78 typedef guint8
uint8_t;
79 typedef guint16
uint16_t;
80 typedef guint32
uint32_t;
81 typedef guint64
uint64_t;
83 /* Hardcoded facility load event : this plus an following "name" string */
84 struct LttFacilityLoad
{
93 struct LttFacilityUnload
{
97 struct LttStateDumpFacilityLoad
{
101 guint32 pointer_size
;
108 typedef struct _TimeHeartbeat
{
109 LttTime time
; //Time stamp of this block
110 uint64_t cycle_count
; //cycle count of the event
111 } LTT_PACKED_STRUCT TimeHeartbeat
;
113 struct ltt_event_header_hb
{
115 unsigned char facility_id
;
116 unsigned char event_id
;
118 } __attribute((aligned(8)));
120 struct ltt_event_header_nohb
{
122 unsigned char facility_id
;
123 unsigned char event_id
;
125 } __attribute((aligned(8)));
127 struct ltt_trace_header
{
128 uint32_t magic_number
;
130 uint32_t arch_variant
;
132 //uint32_t system_type;
133 uint8_t major_version
;
134 uint8_t minor_version
;
135 uint8_t flight_recorder
;
136 uint8_t has_heartbeat
;
137 uint8_t has_alignment
; /* Event header alignment */
139 } __attribute((aligned(8)));
142 struct ltt_block_start_header
{
144 struct timeval timestamp
;
145 uint64_t cycle_count
;
148 struct timeval timestamp
;
149 uint64_t cycle_count
;
151 uint32_t lost_size
; /* Size unused at the end of the buffer */
152 uint32_t buf_size
; /* The size of this sub-buffer */
153 struct ltt_trace_header trace
;
154 } __attribute((aligned(8)));
158 GQuark type_name
; //type name if it is a named type
159 GQuark element_name
; //elements name of the struct
162 LttTypeEnum type_class
; //which type
163 GQuark
* enum_strings
; //for enum labels
164 struct _LttType
** element_type
; //for array, sequence and struct
165 unsigned element_number
; //the number of elements
166 //for enum, array, sequence and structure
169 struct _LttEventType
{
172 guint index
; //id of the event type within the facility
173 LttFacility
* facility
; //the facility that contains the event type
174 LttField
* root_field
; //root field
177 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
178 * fields in the exact same order. LttEventPosition is a parent of LttEvent. */
181 /* Begin of LttEventPosition fields */
182 LttTracefile
*tracefile
;
187 uint64_t tsc
; /* Current timestamp counter */
189 /* End of LttEventPosition fields */
191 union { /* choice by trace has_tsc */
192 guint32 timestamp
; /* truncated timestamp */
196 unsigned char facility_id
; /* facility ID are never reused. */
197 unsigned char event_id
;
201 void * data
; //event data
204 int count
; //the number of overflow of cycle count
205 gint64 overflow_nsec
; //precalculated nsec for overflows
208 struct _LttEventPosition
{
209 LttTracefile
*tracefile
;
214 uint64_t tsc
; /* Current timestamp counter */
218 enum field_status
{ FIELD_UNKNOWN
, FIELD_VARIABLE
, FIELD_FIXED
};
221 //guint field_pos; //field position within its parent
222 LttType
* field_type
; //field type, if it is root field
223 //then it must be struct type
225 off_t offset_root
; //offset from the root, -1:uninitialized
226 enum field_status fixed_root
; //offset fixed according to the root
227 //-1:uninitialized, 0:unfixed, 1:fixed
228 off_t offset_parent
; //offset from the parent,-1:uninitialized
229 enum field_status fixed_parent
; //offset fixed according to its parent
230 //-1:uninitialized, 0:unfixed, 1:fixed
231 // void * base_address; //base address of the field ????
233 guint field_size
; // //>0: size of the field,
235 // //-1: uninitialize
236 enum field_status fixed_size
;
239 gint sequ_number_size
; //the size of unsigned used to save the
240 //number of elements in the sequence
242 gint element_size
; //the element size of the sequence
243 //int field_fixed; //0: field has string or sequence
244 //1: field has no string or sequenc
247 struct _LttField
* parent
;
248 struct _LttField
** child
; //for array, sequence, struct and union:
249 //list of fields, it may have only one
250 //field if the element is not a struct or
252 unsigned current_element
; //which element is currently processed
253 // Used for sequences and arrays.
259 //gchar * name; //facility name
261 guint32 checksum
; //checksum of the facility
262 guint32 id
; //id of the facility
264 guint32 pointer_size
;
269 //LttEventType ** events; //array of event types
270 //unsigned int event_number; //number of events in the facility
271 //LttType ** named_types;
272 //unsigned int named_types_number;
275 GData
*events_by_name
;
276 // GArray *named_types;
277 //GData *named_types_by_name;
280 unsigned char exists
; /* 0 does not exist, 1 exists */
283 typedef struct _LttBuffer
{
289 uint64_t cycle_count
;
293 uint64_t cycle_count
;
295 uint32_t lost_size
; /* Size unused at the end of the buffer */
298 uint64_t tsc
; /* Current timestamp counter */
299 double nsecs_per_cycle
;
302 struct _LttTracefile
{
303 gboolean cpu_online
; //is the cpu online ?
304 GQuark name
; //tracefile name
305 guint cpu_num
; //cpu number of the tracefile
306 LttTrace
* trace
; //trace containing the tracefile
307 int fd
; //file descriptor
308 off_t file_size
; //file size
309 unsigned block_size
; //block_size
310 unsigned int num_blocks
; //number of blocks in the file
311 gboolean reverse_bo
; //must we reverse byte order ?
314 LttEvent event
; //Event currently accessible in the trace
317 LttBuffer buffer
; //current buffer
318 guint32 buf_size
; /* The size of blocks */
321 //unsigned int count; //the number of overflow of cycle count
322 //double nsec_per_cycle; //Nsec per cycle
323 //TimeHeartbeat * last_heartbeat; //last heartbeat
325 //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
326 //void * last_event_pos;
328 //LttTime prev_block_end_time; //the end time of previous block
329 //LttTime prev_event_time; //the time of the previous event
330 //LttCycleCount pre_cycle_count; //previous cycle count of the event
334 GQuark pathname
; //the pathname of the trace
335 //LttSystemDescription * system_description;//system description
337 GArray
*facilities_by_num
; /* fac_id as index in array */
338 GData
*facilities_by_name
; /* fac name (GQuark) as index */
339 /* Points to array of fac_id of all the
340 * facilities that has this name. */
342 guint8 ltt_major_version
;
343 guint8 ltt_minor_version
;
344 guint8 flight_recorder
;
345 guint8 has_heartbeat
;
349 GData
*tracefiles
; //tracefiles groups
352 /* The characteristics of the system on which the trace was obtained
353 is described in a LttSystemDescription structure. */
355 struct _LttSystemDescription
{
361 LttArchEndian endian
;
363 gchar
*kernel_release
;
364 gchar
*kernel_version
;
367 gchar
*hardware_platform
;
368 gchar
*operating_system
;
373 /*****************************************************************************
374 macro for size of some data types
375 *****************************************************************************/
376 // alignment -> dynamic!
378 //#define TIMESTAMP_SIZE sizeof(guint32)
379 //#define EVENT_ID_SIZE sizeof(guint16)
380 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
382 #define LTT_GET_BO(t) ((t)->reverse_bo)
385 #endif /* LTT_PRIVATE_H */