1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Xiangxiu Yang
3 * 2006 Mathieu Desnoyers
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.
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.
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.
24 #include <sys/types.h>
27 #include <ltt/event.h>
28 #include <ltt/marker.h>
29 #include <ltt/trace.h>
32 #define max(a,b) ((a)>(b)?(a):(b))
36 #define min(a,b) ((a)<(b)?(a):(b))
41 #define LTT_MAGIC_NUMBER 0x00D6B7ED
42 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
44 #define NSEC_PER_USEC 1000
46 #define LTT_PACKED_STRUCT __attribute__ ((packed))
48 /* Hardcoded facilities */
49 #define LTT_FACILITY_CORE 0
52 #define LTT_GET_BO(t) ((t)->reverse_bo)
54 #define LTT_HAS_FLOAT(t) ((t)->float_word_order!=0)
55 #define LTT_GET_FLOAT_BO(t) \
56 (((t)->float_word_order==__BYTE_ORDER)?0:1)
58 #define SEQUENCE_AVG_ELEMENTS 1000
60 /* Hardcoded core events */
61 enum ltt_core_events
{
62 LTT_EVENT_FACILITY_LOAD
,
63 LTT_EVENT_FACILITY_UNLOAD
,
65 LTT_EVENT_HEARTBEAT_FULL
,
66 LTT_EVENT_STATE_DUMP_FACILITY_LOAD
71 /* enumeration definition */
73 typedef enum _BuildinEvent
{
74 TRACE_FACILITY_LOAD
= 0,
75 TRACE_BLOCK_START
= 17,
77 TRACE_TIME_HEARTBEAT
= 19
81 /* structure definition */
83 typedef struct _FacilityLoad
{
87 } LTT_PACKED_STRUCT FacilityLoad
;
89 typedef struct _BlockStart
{
90 LttTime time
; //Time stamp of this block
91 LttCycleCount cycle_count
; //cycle count of the event
92 guint32 block_id
; //block id
93 } LTT_PACKED_STRUCT BlockStart
;
95 typedef struct _BlockEnd
{
96 LttTime time
; //Time stamp of this block
97 LttCycleCount cycle_count
; //cycle count of the event
98 guint32 block_id
; //block id
99 } LTT_PACKED_STRUCT BlockEnd
;
103 typedef guint8
uint8_t;
104 typedef guint16
uint16_t;
105 typedef guint32
uint32_t;
106 typedef guint64
uint64_t;
108 /* Hardcoded facility load event : this plus an preceding "name" string */
109 struct LttFacilityLoad
{
114 guint32 pointer_size
;
116 guint32 has_alignment
;
119 struct LttFacilityUnload
{
123 struct LttStateDumpFacilityLoad
{
128 guint32 pointer_size
;
130 guint32 has_alignment
;
134 typedef struct _TimeHeartbeat
{
135 } LTT_PACKED_STRUCT TimeHeartbeat
;
137 typedef struct _TimeHeartbeatFull
{
139 } LTT_PACKED_STRUCT TimeHeartbeatFull
;
141 struct ltt_event_header_hb
{
147 struct ltt_event_header_nohb
{
154 /* Block and trace headers */
156 struct ltt_trace_header_any
{
157 uint32_t magic_number
;
159 uint32_t arch_variant
;
160 uint32_t float_word_order
;
162 uint8_t major_version
;
163 uint8_t minor_version
;
164 uint8_t flight_recorder
;
165 uint8_t has_heartbeat
;
166 uint8_t has_alignment
; /* Event header alignment */
170 struct ltt_trace_header_1_0
{
171 uint32_t magic_number
;
173 uint32_t arch_variant
;
174 uint32_t float_word_order
;
176 uint8_t major_version
;
177 uint8_t minor_version
;
178 uint8_t flight_recorder
;
179 uint8_t has_heartbeat
;
180 uint8_t has_alignment
; /* Event header alignment */
181 uint8_t tsc_lsb_truncate
;
186 uint64_t start_monotonic
;
187 uint64_t start_time_sec
;
188 uint64_t start_time_usec
;
192 struct ltt_block_start_header
{
194 uint64_t cycle_count
;
198 uint64_t cycle_count
;
201 uint32_t lost_size
; /* Size unused at the end of the buffer */
202 uint32_t buf_size
; /* The size of this sub-buffer */
203 struct ltt_trace_header_any trace
[0];
209 // LTTV does not care about type names. Everything is a field.
210 // GQuark type_name; //type name if it is a named type
213 LttTypeEnum type_class
; //which type
214 GHashTable
*enum_map
; //maps enum labels to numbers.
215 gint32 highest_value
; //For enum
216 gint32 lowest_value
; //For enum
217 GArray
*fields
; // Array of LttFields, for array, sequence, union, struct.
218 GData
*fields_by_name
;
219 guint network
; // Is the type in network byte order ?
220 //part added by gaby for fmt:
228 struct _LttEventType
{
231 guint index
; //id of the event type within the facility
232 struct marker_info
*info
;
233 GArray
* fields
; //event's fields (LttField)
234 GData
*fields_by_name
;
235 int has_compact_data
; //event header contains compact data (first field)
239 enum field_status
{ FIELD_UNKNOWN
, FIELD_VARIABLE
, FIELD_FIXED
};
245 LttType field_type
; //field type
247 off_t offset_root
; //offset from the root
248 enum field_status fixed_root
; //offset fixed according to the root
250 guint field_size
; // size of the field
251 // Only if field type size is set to 0
252 // (it's variable), then the field_size should be
253 // dynamically calculated while reading the trace
254 // and put here. Otherwise, the field_size always
255 // equals the type size.
256 off_t array_offset
; // offset of the beginning of the array (for array
258 GArray
* dynamic_offsets
; // array of offsets calculated dynamically at
259 // each event for sequences and arrays that
260 // contain variable length fields.
267 guint32 checksum
; //checksum of the facility
268 guint32 id
; //id of the facility
272 guint32 pointer_size
;
277 GData
*events_by_name
;
278 // not necessary in LTTV GData *named_types;
280 unsigned char exists
; /* 0 does not exist, 1 exists */
284 typedef struct _LttBuffer
{
290 uint64_t cycle_count
;
291 uint64_t freq
; /* Frequency in khz */
295 uint64_t cycle_count
;
296 uint64_t freq
; /* Frequency in khz */
298 uint32_t lost_size
; /* Size unused at the end of the buffer */
301 uint64_t tsc
; /* Current timestamp counter */
302 uint64_t freq
; /* Frequency in khz */
303 //double nsecs_per_cycle; /* Precalculated from freq */
304 guint32 cyc2ns_scale
;
307 struct LttTracefile
{
308 gboolean cpu_online
; //is the cpu online ?
309 GQuark long_name
; //tracefile complete filename
310 GQuark name
; //tracefile name
311 guint cpu_num
; //cpu number of the tracefile
312 guint tid
; //Usertrace tid, else 0
313 guint pgid
; //Usertrace pgid, else 0
314 guint64 creation
; //Usertrace creation, else 0
315 LttTrace
* trace
; //trace containing the tracefile
316 int fd
; //file descriptor
317 off_t file_size
; //file size
318 //unsigned block_size; //block_size
319 guint num_blocks
; //number of blocks in the file
320 gboolean reverse_bo
; //must we reverse byte order ?
321 gboolean float_word_order
; //what is the byte order of floats ?
322 size_t has_alignment
; //alignment of events in the tracefile.
323 // 0 or the architecture size in bytes.
325 guint8 has_heartbeat
;
326 size_t buffer_header_size
;
327 int compact
; //compact tracefile ?
328 uint8_t tsc_lsb_truncate
;
330 uint8_t tsc_msb_cutoff
;
332 uint64_t tsc_mask_next_bit
; //next MSB after the mask
335 LttEvent event
; //Event currently accessible in the trace
338 LttBuffer buffer
; //current buffer
339 guint32 buf_size
; /* The size of blocks */
342 //unsigned int count; //the number of overflow of cycle count
343 //double nsec_per_cycle; //Nsec per cycle
344 //TimeHeartbeat * last_heartbeat; //last heartbeat
346 //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
347 //void * last_event_pos;
349 //LttTime prev_block_end_time; //the end time of previous block
350 //LttTime prev_event_time; //the time of the previous event
351 //LttCycleCount pre_cycle_count; //previous cycle count of the event
354 /* The characteristics of the system on which the trace was obtained
355 is described in a LttSystemDescription structure. */
357 struct LttSystemDescription
{
363 LttArchEndian endian
;
365 gchar
*kernel_release
;
366 gchar
*kernel_version
;
369 gchar
*hardware_platform
;
370 gchar
*operating_system
;
375 /*****************************************************************************
376 macro for size of some data types
377 *****************************************************************************/
378 // alignment -> dynamic!
380 //#define TIMESTAMP_SIZE sizeof(guint32)
381 //#define EVENT_ID_SIZE sizeof(guint16)
382 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
385 //off_t get_alignment(LttField *field);
387 /* Calculate the offset needed to align the type.
388 * If has_alignment is 0, alignment is disactivated.
389 * else, the function returns the offset needed to
390 * align align_drift on the has_alignment value (should be
391 * the size of the architecture). */
392 static inline unsigned int ltt_align(size_t align_drift
,
394 size_t has_alignment
)
396 size_t alignment
= min(has_alignment
, size_of_type
);
398 if(!has_alignment
) return 0;
400 g_assert(size_of_type
!= 0);
401 return ((alignment
- align_drift
) & (alignment
-1));
405 #endif /* LTT_PRIVATE_H */