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
70 typedef guint8
uint8_t;
71 typedef guint16
uint16_t;
72 typedef guint32
uint32_t;
73 typedef guint64
uint64_t;
75 struct ltt_event_header_hb
{
81 struct ltt_event_header_nohb
{
88 /* Block and trace headers */
90 struct ltt_trace_header_any
{
91 uint32_t magic_number
;
93 uint32_t arch_variant
;
94 uint32_t float_word_order
;
96 uint8_t major_version
;
97 uint8_t minor_version
;
98 uint8_t flight_recorder
;
99 uint8_t has_heartbeat
;
100 uint8_t alignment
; /* Event header alignment */
104 struct ltt_trace_header_1_0
{
105 uint32_t magic_number
;
107 uint32_t arch_variant
;
108 uint32_t float_word_order
;
110 uint8_t major_version
;
111 uint8_t minor_version
;
112 uint8_t flight_recorder
;
113 uint8_t has_heartbeat
;
114 uint8_t alignment
; /* Event header alignment */
115 uint8_t tsc_lsb_truncate
;
117 uint8_t compact_data_shift
;
121 uint64_t start_monotonic
;
122 uint64_t start_time_sec
;
123 uint64_t start_time_usec
;
127 struct ltt_block_start_header
{
129 uint64_t cycle_count
;
133 uint64_t cycle_count
;
136 uint32_t lost_size
; /* Size unused at the end of the buffer */
137 uint32_t buf_size
; /* The size of this sub-buffer */
138 struct ltt_trace_header_any trace
[0];
142 enum field_status
{ FIELD_UNKNOWN
, FIELD_VARIABLE
, FIELD_FIXED
};
144 typedef struct _LttBuffer
{
150 uint64_t cycle_count
;
151 uint64_t freq
; /* Frequency in khz */
155 uint64_t cycle_count
;
156 uint64_t freq
; /* Frequency in khz */
158 uint32_t lost_size
; /* Size unused at the end of the buffer */
161 uint64_t tsc
; /* Current timestamp counter */
162 uint64_t freq
; /* Frequency in khz */
163 //double nsecs_per_cycle; /* Precalculated from freq */
164 guint32 cyc2ns_scale
;
167 struct LttTracefile
{
168 gboolean cpu_online
; //is the cpu online ?
169 GQuark long_name
; //tracefile complete filename
170 GQuark name
; //tracefile name
171 guint cpu_num
; //cpu number of the tracefile
172 guint tid
; //Usertrace tid, else 0
173 guint pgid
; //Usertrace pgid, else 0
174 guint64 creation
; //Usertrace creation, else 0
175 LttTrace
* trace
; //trace containing the tracefile
176 int fd
; //file descriptor
177 off_t file_size
; //file size
178 //unsigned block_size; //block_size
179 guint num_blocks
; //number of blocks in the file
180 gboolean reverse_bo
; //must we reverse byte order ?
181 gboolean float_word_order
; //what is the byte order of floats ?
182 size_t alignment
; //alignment of events in the tracefile.
183 // 0 or the architecture size in bytes.
185 guint8 has_heartbeat
;
186 size_t buffer_header_size
;
187 int compact
; //compact tracefile ?
188 uint8_t tsc_lsb_truncate
;
190 uint8_t tsc_msb_cutoff
;
191 uint8_t compact_event_bits
;
193 uint64_t tsc_mask_next_bit
; //next MSB after the mask
196 LttEvent event
; //Event currently accessible in the trace
199 LttBuffer buffer
; //current buffer
200 guint32 buf_size
; /* The size of blocks */
203 //unsigned int count; //the number of overflow of cycle count
204 //double nsec_per_cycle; //Nsec per cycle
205 //TimeHeartbeat * last_heartbeat; //last heartbeat
207 //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
208 //void * last_event_pos;
210 //LttTime prev_block_end_time; //the end time of previous block
211 //LttTime prev_event_time; //the time of the previous event
212 //LttCycleCount pre_cycle_count; //previous cycle count of the event
215 /* The characteristics of the system on which the trace was obtained
216 is described in a LttSystemDescription structure. */
218 struct LttSystemDescription
{
224 LttArchEndian endian
;
226 gchar
*kernel_release
;
227 gchar
*kernel_version
;
230 gchar
*hardware_platform
;
231 gchar
*operating_system
;
236 /*****************************************************************************
237 macro for size of some data types
238 *****************************************************************************/
239 // alignment -> dynamic!
241 //#define TIMESTAMP_SIZE sizeof(guint32)
242 //#define EVENT_ID_SIZE sizeof(guint16)
243 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
246 //off_t get_alignment(LttField *field);
248 /* Calculate the offset needed to align the type.
249 * If alignment is 0, alignment is disactivated.
250 * else, the function returns the offset needed to
251 * align align_drift on the alignment value (should be
252 * the size of the architecture). */
253 static inline unsigned int ltt_align(size_t align_drift
,
257 size_t align_offset
= min(alignment
, size_of_type
);
262 g_assert(size_of_type
!= 0);
263 return ((align_offset
- align_drift
) & (align_offset
-1));
267 #endif /* LTT_PRIVATE_H */