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>
28 #define max(a,b) ((a)>(b)?(a):(b))
32 #define LTT_MAGIC_NUMBER 0x00D6B7ED
33 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
35 #define NSEC_PER_USEC 1000
37 #define LTT_PACKED_STRUCT __attribute__ ((packed))
39 /* Hardcoded facilities */
40 #define LTT_FACILITY_CORE 0
42 /* Hardcoded core events */
43 enum ltt_core_events
{
44 LTT_EVENT_FACILITY_LOAD
,
45 LTT_EVENT_FACILITY_UNLOAD
,
47 LTT_EVENT_STATE_DUMP_FACILITY_LOAD
52 /* enumeration definition */
54 typedef enum _BuildinEvent
{
55 TRACE_FACILITY_LOAD
= 0,
56 TRACE_BLOCK_START
= 17,
58 TRACE_TIME_HEARTBEAT
= 19
62 /* structure definition */
64 typedef struct _FacilityLoad
{
68 } LTT_PACKED_STRUCT FacilityLoad
;
70 typedef struct _BlockStart
{
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 BlockStart
;
76 typedef struct _BlockEnd
{
77 LttTime time
; //Time stamp of this block
78 LttCycleCount cycle_count
; //cycle count of the event
79 guint32 block_id
; //block id
80 } LTT_PACKED_STRUCT BlockEnd
;
84 typedef guint8
uint8_t;
85 typedef guint16
uint16_t;
86 typedef guint32
uint32_t;
87 typedef guint64
uint64_t;
89 /* Hardcoded facility load event : this plus an preceding "name" string */
90 struct LttFacilityLoad
{
99 struct LttFacilityUnload
{
103 struct LttStateDumpFacilityLoad
{
107 guint32 pointer_size
;
112 typedef struct _TimeHeartbeat
{
113 LttTime time
; //Time stamp of this block
114 uint64_t cycle_count
; //cycle count of the event
115 } LTT_PACKED_STRUCT TimeHeartbeat
;
117 struct ltt_event_header_hb
{
119 unsigned char facility_id
;
120 unsigned char event_id
;
124 struct ltt_event_header_nohb
{
126 unsigned char facility_id
;
127 unsigned char event_id
;
131 struct ltt_trace_header
{
132 uint32_t magic_number
;
134 uint32_t arch_variant
;
136 //uint32_t system_type;
137 uint8_t major_version
;
138 uint8_t minor_version
;
139 uint8_t flight_recorder
;
140 uint8_t has_heartbeat
;
141 uint8_t has_alignment
; /* Event header alignment */
146 struct ltt_block_start_header
{
148 struct timeval timestamp
;
149 uint64_t cycle_count
;
152 struct timeval timestamp
;
153 uint64_t cycle_count
;
155 uint32_t lost_size
; /* Size unused at the end of the buffer */
156 uint32_t buf_size
; /* The size of this sub-buffer */
157 struct ltt_trace_header trace
;
162 GQuark type_name
; //type name if it is a named type
163 GQuark element_name
; //elements name of the struct
166 LttTypeEnum type_class
; //which type
167 GQuark
* enum_strings
; //for enum labels
168 struct _LttType
** element_type
; //for array, sequence and struct
169 unsigned element_number
; //the number of elements
170 //for enum, array, sequence and structure
173 struct _LttEventType
{
176 guint index
; //id of the event type within the facility
177 LttFacility
* facility
; //the facility that contains the event type
178 LttField
* root_field
; //root field
181 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
182 * fields in the exact same order. LttEventPosition is a parent of LttEvent. */
185 /* Begin of LttEventPosition fields */
186 LttTracefile
*tracefile
;
191 uint64_t tsc
; /* Current timestamp counter */
193 /* End of LttEventPosition fields */
195 union { /* choice by trace has_tsc */
196 guint32 timestamp
; /* truncated timestamp */
200 unsigned char facility_id
; /* facility ID are never reused. */
201 unsigned char event_id
;
205 void * data
; //event data
207 guint event_size
; //event_size field of the header :
208 //used to verify data_size from facility.
210 int count
; //the number of overflow of cycle count
211 gint64 overflow_nsec
; //precalculated nsec for overflows
214 struct _LttEventPosition
{
215 LttTracefile
*tracefile
;
220 uint64_t tsc
; /* Current timestamp counter */
224 enum field_status
{ FIELD_UNKNOWN
, FIELD_VARIABLE
, FIELD_FIXED
};
227 //guint field_pos; //field position within its parent
228 LttType
* field_type
; //field type, if it is root field
229 //then it must be struct type
231 off_t offset_root
; //offset from the root, -1:uninitialized
232 enum field_status fixed_root
; //offset fixed according to the root
233 //-1:uninitialized, 0:unfixed, 1:fixed
234 off_t offset_parent
; //offset from the parent,-1:uninitialized
235 enum field_status fixed_parent
; //offset fixed according to its parent
236 //-1:uninitialized, 0:unfixed, 1:fixed
237 // void * base_address; //base address of the field ????
239 guint field_size
; // //>0: size of the field,
241 // //-1: uninitialize
242 enum field_status fixed_size
;
245 gint sequ_number_size
; //the size of unsigned used to save the
246 //number of elements in the sequence
248 gint element_size
; //the element size of the sequence
249 //int field_fixed; //0: field has string or sequence
250 //1: field has no string or sequenc
253 struct _LttField
* parent
;
254 struct _LttField
** child
; //for array, sequence, struct and union:
255 //list of fields, it may have only one
256 //field if the element is not a struct or
258 unsigned current_element
; //which element is currently processed
259 // Used for sequences and arrays.
265 //gchar * name; //facility name
267 guint32 checksum
; //checksum of the facility
268 guint32 id
; //id of the facility
270 guint32 pointer_size
;
276 //LttEventType ** events; //array of event types
277 //unsigned int event_number; //number of events in the facility
278 //LttType ** named_types;
279 //unsigned int named_types_number;
282 GData
*events_by_name
;
283 // GArray *named_types;
284 //GData *named_types_by_name;
287 unsigned char exists
; /* 0 does not exist, 1 exists */
290 typedef struct _LttBuffer
{
296 uint64_t cycle_count
;
300 uint64_t cycle_count
;
302 uint32_t lost_size
; /* Size unused at the end of the buffer */
305 uint64_t tsc
; /* Current timestamp counter */
306 double nsecs_per_cycle
;
309 struct _LttTracefile
{
310 gboolean cpu_online
; //is the cpu online ?
311 GQuark long_name
; //tracefile complete filename
312 GQuark name
; //tracefile name
313 guint cpu_num
; //cpu number of the tracefile
314 LttTrace
* trace
; //trace containing the tracefile
315 int fd
; //file descriptor
316 off_t file_size
; //file size
317 unsigned block_size
; //block_size
318 unsigned int num_blocks
; //number of blocks in the file
319 gboolean reverse_bo
; //must we reverse byte order ?
322 LttEvent event
; //Event currently accessible in the trace
325 LttBuffer buffer
; //current buffer
326 guint32 buf_size
; /* The size of blocks */
329 //unsigned int count; //the number of overflow of cycle count
330 //double nsec_per_cycle; //Nsec per cycle
331 //TimeHeartbeat * last_heartbeat; //last heartbeat
333 //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
334 //void * last_event_pos;
336 //LttTime prev_block_end_time; //the end time of previous block
337 //LttTime prev_event_time; //the time of the previous event
338 //LttCycleCount pre_cycle_count; //previous cycle count of the event
342 GQuark pathname
; //the pathname of the trace
343 //LttSystemDescription * system_description;//system description
345 GArray
*facilities_by_num
; /* fac_id as index in array */
346 GData
*facilities_by_name
; /* fac name (GQuark) as index */
347 /* Points to array of fac_id of all the
348 * facilities that has this name. */
351 guint32 arch_variant
;
353 guint8 ltt_major_version
;
354 guint8 ltt_minor_version
;
355 guint8 flight_recorder
;
356 guint8 has_heartbeat
;
357 guint8 has_alignment
;
360 GData
*tracefiles
; //tracefiles groups
363 /* The characteristics of the system on which the trace was obtained
364 is described in a LttSystemDescription structure. */
366 struct _LttSystemDescription
{
372 LttArchEndian endian
;
374 gchar
*kernel_release
;
375 gchar
*kernel_version
;
378 gchar
*hardware_platform
;
379 gchar
*operating_system
;
384 /*****************************************************************************
385 macro for size of some data types
386 *****************************************************************************/
387 // alignment -> dynamic!
389 //#define TIMESTAMP_SIZE sizeof(guint32)
390 //#define EVENT_ID_SIZE sizeof(guint16)
391 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
393 #define LTT_GET_BO(t) ((t)->reverse_bo)
396 #endif /* LTT_PRIVATE_H */