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 min(a,b) ((a)<(b)?(a):(b))
38 #define LTT_MAGIC_NUMBER 0x00D6B7ED
39 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
41 #define NSEC_PER_USEC 1000
43 #define LTT_PACKED_STRUCT __attribute__ ((packed))
45 /* Hardcoded facilities */
46 #define LTT_FACILITY_CORE 0
49 #define LTT_GET_BO(t) ((t)->reverse_bo)
51 #define LTT_HAS_FLOAT(t) ((t)->float_word_order!=0)
52 #define LTT_GET_FLOAT_BO(t) \
53 (((t)->float_word_order==__BYTE_ORDER)?0:1)
55 #define SEQUENCE_AVG_ELEMENTS 1000
57 /* Hardcoded core events */
58 enum ltt_core_events
{
59 LTT_EVENT_FACILITY_LOAD
,
60 LTT_EVENT_FACILITY_UNLOAD
,
62 LTT_EVENT_STATE_DUMP_FACILITY_LOAD
67 /* enumeration definition */
69 typedef enum _BuildinEvent
{
70 TRACE_FACILITY_LOAD
= 0,
71 TRACE_BLOCK_START
= 17,
73 TRACE_TIME_HEARTBEAT
= 19
77 /* structure definition */
79 typedef struct _FacilityLoad
{
83 } LTT_PACKED_STRUCT FacilityLoad
;
85 typedef struct _BlockStart
{
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 BlockStart
;
91 typedef struct _BlockEnd
{
92 LttTime time
; //Time stamp of this block
93 LttCycleCount cycle_count
; //cycle count of the event
94 guint32 block_id
; //block id
95 } LTT_PACKED_STRUCT BlockEnd
;
99 typedef guint8
uint8_t;
100 typedef guint16
uint16_t;
101 typedef guint32
uint32_t;
102 typedef guint64
uint64_t;
104 /* Hardcoded facility load event : this plus an preceding "name" string */
105 struct LttFacilityLoad
{
110 guint32 pointer_size
;
112 guint32 has_alignment
;
115 struct LttFacilityUnload
{
119 struct LttStateDumpFacilityLoad
{
124 guint32 pointer_size
;
126 guint32 has_alignment
;
129 typedef struct _TimeHeartbeat
{
130 LttTime time
; //Time stamp of this block
131 uint64_t cycle_count
; //cycle count of the event
132 } LTT_PACKED_STRUCT TimeHeartbeat
;
134 struct ltt_event_header_hb
{
136 unsigned char facility_id
;
137 unsigned char event_id
;
141 struct ltt_event_header_nohb
{
143 unsigned char facility_id
;
144 unsigned char event_id
;
149 /* Block and trace headers */
151 struct ltt_trace_header_any
{
152 uint32_t magic_number
;
154 uint32_t arch_variant
;
155 uint32_t float_word_order
;
157 uint8_t major_version
;
158 uint8_t minor_version
;
159 uint8_t flight_recorder
;
160 uint8_t has_heartbeat
;
161 uint8_t has_alignment
; /* Event header alignment */
166 /* For version 0.3 */
168 struct ltt_trace_header_0_3
{
169 uint32_t magic_number
;
171 uint32_t arch_variant
;
172 uint32_t float_word_order
;
174 uint8_t major_version
;
175 uint8_t minor_version
;
176 uint8_t flight_recorder
;
177 uint8_t has_heartbeat
;
178 uint8_t has_alignment
; /* Event header alignment */
182 /* For version 0.4 */
184 struct ltt_trace_header_0_4
{
185 uint32_t magic_number
;
187 uint32_t arch_variant
;
188 uint32_t float_word_order
;
190 uint8_t major_version
;
191 uint8_t minor_version
;
192 uint8_t flight_recorder
;
193 uint8_t has_heartbeat
;
194 uint8_t has_alignment
; /* Event header alignment */
198 uint64_t start_monotonic
;
199 struct timeval start_time
;
203 struct ltt_block_start_header
{
205 struct timeval timestamp
;
206 uint64_t cycle_count
;
210 struct timeval timestamp
;
211 uint64_t cycle_count
;
214 uint32_t lost_size
; /* Size unused at the end of the buffer */
215 uint32_t buf_size
; /* The size of this sub-buffer */
216 struct ltt_trace_header_any trace
[0];
221 // LTTV does not care about type names. Everything is a field.
222 // GQuark type_name; //type name if it is a named type
225 LttTypeEnum type_class
; //which type
226 GHashTable
*enum_map
; //maps enum labels to numbers.
227 GArray
*fields
; // Array of LttFields, for array, sequence, union, struct.
228 GData
*fields_by_name
;
231 struct _LttEventType
{
234 guint index
; //id of the event type within the facility
235 LttFacility
* facility
; //the facility that contains the event type
236 GArray
* fields
; //event's fields (LttField)
237 GData
*fields_by_name
;
240 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
241 * fields in the exact same order. LttEventPosition is a parent of LttEvent. */
244 /* Begin of LttEventPosition fields */
245 LttTracefile
*tracefile
;
250 uint64_t tsc
; /* Current timestamp counter */
252 /* End of LttEventPosition fields */
254 union { /* choice by trace has_tsc */
255 guint32 timestamp
; /* truncated timestamp */
259 unsigned char facility_id
; /* facility ID are never reused. */
260 unsigned char event_id
;
264 void * data
; //event data
266 guint event_size
; //event_size field of the header :
267 //used to verify data_size from facility.
269 int count
; //the number of overflow of cycle count
270 gint64 overflow_nsec
; //precalculated nsec for overflows
273 struct _LttEventPosition
{
274 LttTracefile
*tracefile
;
279 uint64_t tsc
; /* Current timestamp counter */
283 enum field_status
{ FIELD_UNKNOWN
, FIELD_VARIABLE
, FIELD_FIXED
};
288 LttType field_type
; //field type
290 off_t offset_root
; //offset from the root
291 enum field_status fixed_root
; //offset fixed according to the root
293 guint field_size
; // size of the field
294 // Only if field type size is set to 0
295 // (it's variable), then the field_size should be
296 // dynamically calculated while reading the trace
297 // and put here. Otherwise, the field_size always
298 // equels the type size.
299 off_t array_offset
; // offset of the beginning of the array (for array
301 GArray
* dynamic_offsets
; // array of offsets calculated dynamically at
302 // each event for sequences and arrays that
303 // contain variable length fields.
309 guint32 checksum
; //checksum of the facility
310 guint32 id
; //id of the facility
314 guint32 pointer_size
;
319 GData
*events_by_name
;
320 // not necessary in LTTV GData *named_types;
322 unsigned char exists
; /* 0 does not exist, 1 exists */
325 typedef struct _LttBuffer
{
331 uint64_t cycle_count
;
332 uint64_t freq
; /* Frequency in khz */
336 uint64_t cycle_count
;
337 uint64_t freq
; /* Frequency in khz */
339 uint32_t lost_size
; /* Size unused at the end of the buffer */
342 uint64_t tsc
; /* Current timestamp counter */
343 uint64_t freq
; /* Frequency in khz */
344 //double nsecs_per_cycle; /* Precalculated from freq */
345 guint32 cyc2ns_scale
;
348 struct _LttTracefile
{
349 gboolean cpu_online
; //is the cpu online ?
350 GQuark long_name
; //tracefile complete filename
351 GQuark name
; //tracefile name
352 guint cpu_num
; //cpu number of the tracefile
353 LttTrace
* trace
; //trace containing the tracefile
354 int fd
; //file descriptor
355 off_t file_size
; //file size
356 //unsigned block_size; //block_size
357 guint num_blocks
; //number of blocks in the file
358 gboolean reverse_bo
; //must we reverse byte order ?
359 gboolean float_word_order
; //what is the byte order of floats ?
360 size_t has_alignment
; //alignment of events in the tracefile.
361 // 0 or the architecture size in bytes.
363 size_t buffer_header_size
;
366 LttEvent event
; //Event currently accessible in the trace
369 LttBuffer buffer
; //current buffer
370 guint32 buf_size
; /* The size of blocks */
373 //unsigned int count; //the number of overflow of cycle count
374 //double nsec_per_cycle; //Nsec per cycle
375 //TimeHeartbeat * last_heartbeat; //last heartbeat
377 //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
378 //void * last_event_pos;
380 //LttTime prev_block_end_time; //the end time of previous block
381 //LttTime prev_event_time; //the time of the previous event
382 //LttCycleCount pre_cycle_count; //previous cycle count of the event
386 GQuark pathname
; //the pathname of the trace
387 //LttSystemDescription * system_description;//system description
389 GArray
*facilities_by_num
; /* fac_id as index in array */
390 GData
*facilities_by_name
; /* fac name (GQuark) as index */
391 /* Points to array of fac_id of all the
392 * facilities that has this name. */
396 guint32 arch_variant
;
398 guint8 ltt_major_version
;
399 guint8 ltt_minor_version
;
400 guint8 flight_recorder
;
401 guint8 has_heartbeat
;
405 uint64_t start_monotonic
;
407 LttTime start_time_from_tsc
;
409 GData
*tracefiles
; //tracefiles groups
412 /* The characteristics of the system on which the trace was obtained
413 is described in a LttSystemDescription structure. */
415 struct _LttSystemDescription
{
421 LttArchEndian endian
;
423 gchar
*kernel_release
;
424 gchar
*kernel_version
;
427 gchar
*hardware_platform
;
428 gchar
*operating_system
;
433 /*****************************************************************************
434 macro for size of some data types
435 *****************************************************************************/
436 // alignment -> dynamic!
438 //#define TIMESTAMP_SIZE sizeof(guint32)
439 //#define EVENT_ID_SIZE sizeof(guint16)
440 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
443 /* Calculate the offset needed to align the type.
444 * If has_alignment is 0, alignment is disactivated.
445 * else, the function returns the offset needed to
446 * align align_drift on the has_alignment value (should be
447 * the size of the architecture). */
448 static inline unsigned int ltt_align(size_t align_drift
,
450 size_t has_alignment
)
452 size_t alignment
= min(has_alignment
, size_of_type
);
454 return ((alignment
- align_drift
) & (alignment
-1));
457 off_t
field_align(LttTracefile
*tf
, LttField
*field
, off_t offset
);
460 #endif /* LTT_PRIVATE_H */