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>
29 #define max(a,b) ((a)>(b)?(a):(b))
33 #define LTT_MAGIC_NUMBER 0x00D6B7ED
34 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
36 #define NSEC_PER_USEC 1000
38 #define LTT_PACKED_STRUCT __attribute__ ((packed))
40 /* Hardcoded facilities */
41 #define LTT_FACILITY_CORE 0
44 #define LTT_GET_BO(t) ((t)->reverse_bo)
46 #define LTT_HAS_FLOAT(t) ((t)->float_word_order!=0)
47 #define LTT_GET_FLOAT_BO(t) \
48 (((t)->float_word_order==__BYTE_ORDER)?0:1)
51 /* Hardcoded core events */
52 enum ltt_core_events
{
53 LTT_EVENT_FACILITY_LOAD
,
54 LTT_EVENT_FACILITY_UNLOAD
,
56 LTT_EVENT_STATE_DUMP_FACILITY_LOAD
61 /* enumeration definition */
63 typedef enum _BuildinEvent
{
64 TRACE_FACILITY_LOAD
= 0,
65 TRACE_BLOCK_START
= 17,
67 TRACE_TIME_HEARTBEAT
= 19
71 /* structure definition */
73 typedef struct _FacilityLoad
{
77 } LTT_PACKED_STRUCT FacilityLoad
;
79 typedef struct _BlockStart
{
80 LttTime time
; //Time stamp of this block
81 LttCycleCount cycle_count
; //cycle count of the event
82 guint32 block_id
; //block id
83 } LTT_PACKED_STRUCT BlockStart
;
85 typedef struct _BlockEnd
{
86 LttTime time
; //Time stamp of this block
87 LttCycleCount cycle_count
; //cycle count of the event
88 guint32 block_id
; //block id
89 } LTT_PACKED_STRUCT BlockEnd
;
93 typedef guint8
uint8_t;
94 typedef guint16
uint16_t;
95 typedef guint32
uint32_t;
96 typedef guint64
uint64_t;
98 /* Hardcoded facility load event : this plus an preceding "name" string */
99 struct LttFacilityLoad
{
103 guint32 pointer_size
;
108 struct LttFacilityUnload
{
112 struct LttStateDumpFacilityLoad
{
116 guint32 pointer_size
;
121 typedef struct _TimeHeartbeat
{
122 LttTime time
; //Time stamp of this block
123 uint64_t cycle_count
; //cycle count of the event
124 } LTT_PACKED_STRUCT TimeHeartbeat
;
126 struct ltt_event_header_hb
{
128 unsigned char facility_id
;
129 unsigned char event_id
;
133 struct ltt_event_header_nohb
{
135 unsigned char facility_id
;
136 unsigned char event_id
;
140 struct ltt_trace_header
{
141 uint32_t magic_number
;
143 uint32_t arch_variant
;
145 //uint32_t system_type;
146 uint8_t major_version
;
147 uint8_t minor_version
;
148 uint8_t flight_recorder
;
149 uint8_t has_heartbeat
;
150 uint8_t has_alignment
; /* Event header alignment */
155 struct ltt_block_start_header
{
157 struct timeval timestamp
;
158 uint64_t cycle_count
;
161 struct timeval timestamp
;
162 uint64_t cycle_count
;
164 uint32_t lost_size
; /* Size unused at the end of the buffer */
165 uint32_t buf_size
; /* The size of this sub-buffer */
166 struct ltt_trace_header trace
;
171 GQuark type_name
; //type name if it is a named type
172 GQuark element_name
; //elements name of the struct
175 LttTypeEnum type_class
; //which type
176 GQuark
* enum_strings
; //for enum labels
177 struct _LttType
** element_type
; //for array, sequence and struct
178 unsigned element_number
; //the number of elements
179 //for enum, array, sequence and structure
182 struct _LttEventType
{
185 guint index
; //id of the event type within the facility
186 LttFacility
* facility
; //the facility that contains the event type
187 LttField
* root_field
; //root field
190 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
191 * fields in the exact same order. LttEventPosition is a parent of LttEvent. */
194 /* Begin of LttEventPosition fields */
195 LttTracefile
*tracefile
;
200 uint64_t tsc
; /* Current timestamp counter */
202 /* End of LttEventPosition fields */
204 union { /* choice by trace has_tsc */
205 guint32 timestamp
; /* truncated timestamp */
209 unsigned char facility_id
; /* facility ID are never reused. */
210 unsigned char event_id
;
214 void * data
; //event data
216 guint event_size
; //event_size field of the header :
217 //used to verify data_size from facility.
219 int count
; //the number of overflow of cycle count
220 gint64 overflow_nsec
; //precalculated nsec for overflows
223 struct _LttEventPosition
{
224 LttTracefile
*tracefile
;
229 uint64_t tsc
; /* Current timestamp counter */
233 enum field_status
{ FIELD_UNKNOWN
, FIELD_VARIABLE
, FIELD_FIXED
};
236 //guint field_pos; //field position within its parent
237 LttType
* field_type
; //field type, if it is root field
238 //then it must be struct type
240 off_t offset_root
; //offset from the root, -1:uninitialized
241 enum field_status fixed_root
; //offset fixed according to the root
242 //-1:uninitialized, 0:unfixed, 1:fixed
243 off_t offset_parent
; //offset from the parent,-1:uninitialized
244 enum field_status fixed_parent
; //offset fixed according to its parent
245 //-1:uninitialized, 0:unfixed, 1:fixed
246 // void * base_address; //base address of the field ????
248 guint field_size
; // //>0: size of the field,
250 // //-1: uninitialize
251 enum field_status fixed_size
;
254 gint sequ_number_size
; //the size of unsigned used to save the
255 //number of elements in the sequence
257 gint element_size
; //the element size of the sequence
258 //int field_fixed; //0: field has string or sequence
259 //1: field has no string or sequenc
262 struct _LttField
* parent
;
263 struct _LttField
** child
; //for array, sequence, struct and union:
264 //list of fields, it may have only one
265 //field if the element is not a struct or
267 unsigned current_element
; //which element is currently processed
268 // Used for sequences and arrays.
274 //gchar * name; //facility name
276 guint32 checksum
; //checksum of the facility
277 guint32 id
; //id of the facility
279 guint32 pointer_size
;
285 //LttEventType ** events; //array of event types
286 //unsigned int event_number; //number of events in the facility
287 //LttType ** named_types;
288 //unsigned int named_types_number;
291 GData
*events_by_name
;
292 // GArray *named_types;
293 //GData *named_types_by_name;
296 unsigned char exists
; /* 0 does not exist, 1 exists */
299 typedef struct _LttBuffer
{
305 uint64_t cycle_count
;
309 uint64_t cycle_count
;
311 uint32_t lost_size
; /* Size unused at the end of the buffer */
314 uint64_t tsc
; /* Current timestamp counter */
315 double nsecs_per_cycle
;
318 struct _LttTracefile
{
319 gboolean cpu_online
; //is the cpu online ?
320 GQuark long_name
; //tracefile complete filename
321 GQuark name
; //tracefile name
322 guint cpu_num
; //cpu number of the tracefile
323 LttTrace
* trace
; //trace containing the tracefile
324 int fd
; //file descriptor
325 off_t file_size
; //file size
326 //unsigned block_size; //block_size
327 unsigned int num_blocks
; //number of blocks in the file
328 gboolean reverse_bo
; //must we reverse byte order ?
329 gboolean float_word_order
; //what is the byte order of floats ?
332 LttEvent event
; //Event currently accessible in the trace
335 LttBuffer buffer
; //current buffer
336 guint32 buf_size
; /* The size of blocks */
339 //unsigned int count; //the number of overflow of cycle count
340 //double nsec_per_cycle; //Nsec per cycle
341 //TimeHeartbeat * last_heartbeat; //last heartbeat
343 //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
344 //void * last_event_pos;
346 //LttTime prev_block_end_time; //the end time of previous block
347 //LttTime prev_event_time; //the time of the previous event
348 //LttCycleCount pre_cycle_count; //previous cycle count of the event
352 GQuark pathname
; //the pathname of the trace
353 //LttSystemDescription * system_description;//system description
355 GArray
*facilities_by_num
; /* fac_id as index in array */
356 GData
*facilities_by_name
; /* fac name (GQuark) as index */
357 /* Points to array of fac_id of all the
358 * facilities that has this name. */
362 guint32 arch_variant
;
364 guint8 ltt_major_version
;
365 guint8 ltt_minor_version
;
366 guint8 flight_recorder
;
367 guint8 has_heartbeat
;
368 guint8 has_alignment
;
371 GData
*tracefiles
; //tracefiles groups
374 /* The characteristics of the system on which the trace was obtained
375 is described in a LttSystemDescription structure. */
377 struct _LttSystemDescription
{
383 LttArchEndian endian
;
385 gchar
*kernel_release
;
386 gchar
*kernel_version
;
389 gchar
*hardware_platform
;
390 gchar
*operating_system
;
395 /*****************************************************************************
396 macro for size of some data types
397 *****************************************************************************/
398 // alignment -> dynamic!
400 //#define TIMESTAMP_SIZE sizeof(guint32)
401 //#define EVENT_ID_SIZE sizeof(guint16)
402 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
405 #endif /* LTT_PRIVATE_H */