449cb9d7 |
1 | /* This file is part of the Linux Trace Toolkit viewer |
2 | * Copyright (C) 2003-2004 Xiangxiu Yang |
3 | * |
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; |
7 | * |
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. |
12 | * |
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, |
16 | * MA 02111-1307, USA. |
17 | */ |
18 | |
fcdf0ec2 |
19 | #ifndef LTT_PRIVATE_H |
20 | #define LTT_PRIVATE_H |
21 | |
858bd80a |
22 | #include <glib.h> |
cbd41522 |
23 | #include <sys/types.h> |
fcdf0ec2 |
24 | #include <ltt/ltt.h> |
3b10b765 |
25 | #include <endian.h> |
e3247aa5 |
26 | |
eed2ef37 |
27 | |
28 | #ifndef max |
29 | #define max(a,b) ((a)>(b)?(a):(b)) |
30 | #endif |
31 | |
32 | |
3aee1200 |
33 | #define LTT_MAGIC_NUMBER 0x00D6B7ED |
34 | #define LTT_REV_MAGIC_NUMBER 0xEDB7D600 |
35 | |
36 | #define NSEC_PER_USEC 1000 |
37 | |
cbd41522 |
38 | #define LTT_PACKED_STRUCT __attribute__ ((packed)) |
39 | |
3aee1200 |
40 | /* Hardcoded facilities */ |
41 | #define LTT_FACILITY_CORE 0 |
3b10b765 |
42 | |
43 | /* Byte ordering */ |
44 | #define LTT_GET_BO(t) ((t)->reverse_bo) |
45 | |
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) |
49 | |
3aee1200 |
50 | /* Hardcoded core events */ |
51 | enum ltt_core_events { |
52 | LTT_EVENT_FACILITY_LOAD, |
53 | LTT_EVENT_FACILITY_UNLOAD, |
b77d1b57 |
54 | LTT_EVENT_HEARTBEAT, |
55 | LTT_EVENT_STATE_DUMP_FACILITY_LOAD |
3aee1200 |
56 | }; |
57 | |
58 | |
59 | #if 0 |
e3247aa5 |
60 | /* enumeration definition */ |
61 | |
62 | typedef enum _BuildinEvent{ |
63 | TRACE_FACILITY_LOAD = 0, |
64 | TRACE_BLOCK_START = 17, |
65 | TRACE_BLOCK_END = 18, |
0d7aac52 |
66 | TRACE_TIME_HEARTBEAT= 19 |
e3247aa5 |
67 | } BuildinEvent; |
fcdf0ec2 |
68 | |
7c6b3cd7 |
69 | |
70 | /* structure definition */ |
71 | |
e3247aa5 |
72 | typedef struct _FacilityLoad{ |
45e14832 |
73 | gchar * name; |
e3247aa5 |
74 | LttChecksum checksum; |
cbd41522 |
75 | guint32 base_code; |
e3247aa5 |
76 | } LTT_PACKED_STRUCT FacilityLoad; |
77 | |
78 | typedef struct _BlockStart { |
3aee1200 |
79 | LttTime time; //Time stamp of this block |
e3247aa5 |
80 | LttCycleCount cycle_count; //cycle count of the event |
cbd41522 |
81 | guint32 block_id; //block id |
e3247aa5 |
82 | } LTT_PACKED_STRUCT BlockStart; |
83 | |
84 | typedef struct _BlockEnd { |
3aee1200 |
85 | LttTime time; //Time stamp of this block |
e3247aa5 |
86 | LttCycleCount cycle_count; //cycle count of the event |
cbd41522 |
87 | guint32 block_id; //block id |
e3247aa5 |
88 | } LTT_PACKED_STRUCT BlockEnd; |
3aee1200 |
89 | #endif //0 |
90 | |
91 | |
92 | typedef guint8 uint8_t; |
93 | typedef guint16 uint16_t; |
94 | typedef guint32 uint32_t; |
95 | typedef guint64 uint64_t; |
96 | |
16fcbb80 |
97 | /* Hardcoded facility load event : this plus an preceding "name" string */ |
3aee1200 |
98 | struct LttFacilityLoad { |
99 | guint32 checksum; |
100 | guint32 id; |
101 | guint32 long_size; |
102 | guint32 pointer_size; |
103 | guint32 size_t_size; |
104 | guint32 alignment; |
16fcbb80 |
105 | } LTT_PACKED_STRUCT; |
3aee1200 |
106 | |
107 | struct LttFacilityUnload { |
108 | guint32 id; |
16fcbb80 |
109 | } LTT_PACKED_STRUCT; |
3aee1200 |
110 | |
111 | struct LttStateDumpFacilityLoad { |
112 | guint32 checksum; |
113 | guint32 id; |
114 | guint32 long_size; |
115 | guint32 pointer_size; |
116 | guint32 size_t_size; |
117 | guint32 alignment; |
16fcbb80 |
118 | } LTT_PACKED_STRUCT; |
e3247aa5 |
119 | |
120 | typedef struct _TimeHeartbeat { |
3aee1200 |
121 | LttTime time; //Time stamp of this block |
122 | uint64_t cycle_count; //cycle count of the event |
e3247aa5 |
123 | } LTT_PACKED_STRUCT TimeHeartbeat; |
124 | |
3aee1200 |
125 | struct ltt_event_header_hb { |
126 | uint32_t timestamp; |
127 | unsigned char facility_id; |
128 | unsigned char event_id; |
129 | uint16_t event_size; |
16fcbb80 |
130 | } LTT_PACKED_STRUCT; |
3aee1200 |
131 | |
132 | struct ltt_event_header_nohb { |
133 | uint64_t timestamp; |
134 | unsigned char facility_id; |
135 | unsigned char event_id; |
136 | uint16_t event_size; |
16fcbb80 |
137 | } LTT_PACKED_STRUCT; |
3aee1200 |
138 | |
b7576a11 |
139 | |
140 | /* Block and trace headers */ |
141 | |
142 | struct ltt_trace_header_any { |
143 | uint32_t magic_number; |
144 | uint32_t arch_type; |
145 | uint32_t arch_variant; |
146 | uint32_t float_word_order; |
147 | uint8_t arch_size; |
148 | uint8_t major_version; |
149 | uint8_t minor_version; |
150 | uint8_t flight_recorder; |
151 | uint8_t has_heartbeat; |
152 | uint8_t has_alignment; /* Event header alignment */ |
153 | uint8_t has_tsc; |
154 | } LTT_PACKED_STRUCT; |
155 | |
156 | |
157 | /* For version 0.3 */ |
158 | |
159 | struct ltt_trace_header_0_3 { |
3aee1200 |
160 | uint32_t magic_number; |
161 | uint32_t arch_type; |
162 | uint32_t arch_variant; |
79257ba5 |
163 | uint32_t float_word_order; |
3aee1200 |
164 | uint8_t arch_size; |
b7576a11 |
165 | uint8_t major_version; |
166 | uint8_t minor_version; |
167 | uint8_t flight_recorder; |
168 | uint8_t has_heartbeat; |
169 | uint8_t has_alignment; /* Event header alignment */ |
170 | uint8_t has_tsc; |
16fcbb80 |
171 | } LTT_PACKED_STRUCT; |
3aee1200 |
172 | |
986e2a7c |
173 | /* For version 0.4 */ |
174 | |
175 | struct ltt_trace_header_0_4 { |
176 | uint32_t magic_number; |
177 | uint32_t arch_type; |
178 | uint32_t arch_variant; |
179 | uint32_t float_word_order; |
180 | uint8_t arch_size; |
181 | uint8_t major_version; |
182 | uint8_t minor_version; |
183 | uint8_t flight_recorder; |
184 | uint8_t has_heartbeat; |
185 | uint8_t has_alignment; /* Event header alignment */ |
186 | uint8_t has_tsc; |
791dffa6 |
187 | uint64_t start_freq; |
188 | uint64_t start_tsc; |
986e2a7c |
189 | uint64_t start_monotonic; |
190 | struct timespec start_time; |
191 | } LTT_PACKED_STRUCT; |
3aee1200 |
192 | |
b7576a11 |
193 | |
3aee1200 |
194 | struct ltt_block_start_header { |
195 | struct { |
f221c98e |
196 | struct timeval timestamp; |
3aee1200 |
197 | uint64_t cycle_count; |
986e2a7c |
198 | uint64_t freq; |
3aee1200 |
199 | } begin; |
200 | struct { |
f221c98e |
201 | struct timeval timestamp; |
3aee1200 |
202 | uint64_t cycle_count; |
986e2a7c |
203 | uint64_t freq; |
3aee1200 |
204 | } end; |
205 | uint32_t lost_size; /* Size unused at the end of the buffer */ |
206 | uint32_t buf_size; /* The size of this sub-buffer */ |
51551c6f |
207 | struct ltt_trace_header_any trace[0]; |
16fcbb80 |
208 | } LTT_PACKED_STRUCT; |
3aee1200 |
209 | |
e3247aa5 |
210 | |
211 | struct _LttType{ |
3aee1200 |
212 | GQuark type_name; //type name if it is a named type |
213 | GQuark element_name; //elements name of the struct |
45e14832 |
214 | gchar * fmt; |
8d1e6362 |
215 | unsigned int size; |
e3247aa5 |
216 | LttTypeEnum type_class; //which type |
3aee1200 |
217 | GQuark * enum_strings; //for enum labels |
e3247aa5 |
218 | struct _LttType ** element_type; //for array, sequence and struct |
219 | unsigned element_number; //the number of elements |
220 | //for enum, array, sequence and structure |
7c6b3cd7 |
221 | }; |
222 | |
e3247aa5 |
223 | struct _LttEventType{ |
3aee1200 |
224 | GQuark name; |
45e14832 |
225 | gchar * description; |
3aee1200 |
226 | guint index; //id of the event type within the facility |
e3247aa5 |
227 | LttFacility * facility; //the facility that contains the event type |
228 | LttField * root_field; //root field |
7c6b3cd7 |
229 | }; |
230 | |
3aee1200 |
231 | /* Structure LttEvent and LttEventPosition must begin with the _exact_ same |
232 | * fields in the exact same order. LttEventPosition is a parent of LttEvent. */ |
c02ea99f |
233 | struct _LttEvent{ |
3aee1200 |
234 | |
235 | /* Begin of LttEventPosition fields */ |
236 | LttTracefile *tracefile; |
237 | unsigned int block; |
eed2ef37 |
238 | unsigned int offset; |
3aee1200 |
239 | |
240 | /* Timekeeping */ |
241 | uint64_t tsc; /* Current timestamp counter */ |
242 | |
243 | /* End of LttEventPosition fields */ |
244 | |
245 | union { /* choice by trace has_tsc */ |
246 | guint32 timestamp; /* truncated timestamp */ |
247 | LttTime delta; |
248 | } time; |
249 | |
250 | unsigned char facility_id; /* facility ID are never reused. */ |
251 | unsigned char event_id; |
252 | |
c02ea99f |
253 | LttTime event_time; |
3aee1200 |
254 | |
c02ea99f |
255 | void * data; //event data |
77175651 |
256 | guint data_size; |
b77d1b57 |
257 | guint event_size; //event_size field of the header : |
258 | //used to verify data_size from facility. |
3aee1200 |
259 | |
c02ea99f |
260 | int count; //the number of overflow of cycle count |
2dee981d |
261 | gint64 overflow_nsec; //precalculated nsec for overflows |
3aee1200 |
262 | }; |
dfb73233 |
263 | |
3aee1200 |
264 | struct _LttEventPosition{ |
265 | LttTracefile *tracefile; |
266 | unsigned int block; |
eed2ef37 |
267 | unsigned int offset; |
3aee1200 |
268 | |
269 | /* Timekeeping */ |
270 | uint64_t tsc; /* Current timestamp counter */ |
c02ea99f |
271 | }; |
272 | |
273 | |
3aee1200 |
274 | enum field_status { FIELD_UNKNOWN, FIELD_VARIABLE, FIELD_FIXED }; |
275 | |
e3247aa5 |
276 | struct _LttField{ |
3aee1200 |
277 | //guint field_pos; //field position within its parent |
e3247aa5 |
278 | LttType * field_type; //field type, if it is root field |
7c6b3cd7 |
279 | //then it must be struct type |
280 | |
281 | off_t offset_root; //offset from the root, -1:uninitialized |
3aee1200 |
282 | enum field_status fixed_root; //offset fixed according to the root |
7c6b3cd7 |
283 | //-1:uninitialized, 0:unfixed, 1:fixed |
284 | off_t offset_parent; //offset from the parent,-1:uninitialized |
3aee1200 |
285 | enum field_status fixed_parent; //offset fixed according to its parent |
7c6b3cd7 |
286 | //-1:uninitialized, 0:unfixed, 1:fixed |
287 | // void * base_address; //base address of the field ???? |
288 | |
3aee1200 |
289 | guint field_size; // //>0: size of the field, |
290 | // //0 : uncertain |
291 | // //-1: uninitialize |
292 | enum field_status fixed_size; |
293 | |
294 | /* for sequence */ |
295 | gint sequ_number_size; //the size of unsigned used to save the |
0d7aac52 |
296 | //number of elements in the sequence |
297 | |
3aee1200 |
298 | gint element_size; //the element size of the sequence |
299 | //int field_fixed; //0: field has string or sequence |
7c6b3cd7 |
300 | //1: field has no string or sequenc |
301 | //-1: uninitialize |
302 | |
e3247aa5 |
303 | struct _LttField * parent; |
3aee1200 |
304 | struct _LttField ** child; //for array, sequence, struct and union: |
7c6b3cd7 |
305 | //list of fields, it may have only one |
3aee1200 |
306 | //field if the element is not a struct or |
307 | //union |
7c6b3cd7 |
308 | unsigned current_element; //which element is currently processed |
3aee1200 |
309 | // Used for sequences and arrays. |
7c6b3cd7 |
310 | }; |
311 | |
7c6b3cd7 |
312 | |
e3247aa5 |
313 | struct _LttFacility{ |
3aee1200 |
314 | LttTrace *trace; |
315 | //gchar * name; //facility name |
316 | GQuark name; |
317 | guint32 checksum; //checksum of the facility |
318 | guint32 id; //id of the facility |
319 | |
320 | guint32 pointer_size; |
cb03932a |
321 | guint32 long_size; |
3aee1200 |
322 | guint32 size_t_size; |
323 | guint32 alignment; |
324 | |
325 | |
326 | //LttEventType ** events; //array of event types |
327 | //unsigned int event_number; //number of events in the facility |
328 | //LttType ** named_types; |
329 | //unsigned int named_types_number; |
330 | |
331 | GArray *events; |
332 | GData *events_by_name; |
333 | // GArray *named_types; |
334 | //GData *named_types_by_name; |
335 | GData *named_types; |
336 | |
337 | unsigned char exists; /* 0 does not exist, 1 exists */ |
7c6b3cd7 |
338 | }; |
339 | |
3aee1200 |
340 | typedef struct _LttBuffer { |
341 | void * head; |
342 | unsigned int index; |
343 | |
344 | struct { |
345 | LttTime timestamp; |
346 | uint64_t cycle_count; |
986e2a7c |
347 | uint64_t freq; /* Frequency in khz */ |
3aee1200 |
348 | } begin; |
349 | struct { |
350 | LttTime timestamp; |
351 | uint64_t cycle_count; |
986e2a7c |
352 | uint64_t freq; /* Frequency in khz */ |
3aee1200 |
353 | } end; |
354 | uint32_t lost_size; /* Size unused at the end of the buffer */ |
355 | |
356 | /* Timekeeping */ |
357 | uint64_t tsc; /* Current timestamp counter */ |
986e2a7c |
358 | uint64_t freq; /* Frequency in khz */ |
791dffa6 |
359 | //double nsecs_per_cycle; /* Precalculated from freq */ |
360 | guint32 cyc2ns_scale; |
3aee1200 |
361 | } LttBuffer; |
362 | |
e3247aa5 |
363 | struct _LttTracefile{ |
3aee1200 |
364 | gboolean cpu_online; //is the cpu online ? |
d3d34f49 |
365 | GQuark long_name; //tracefile complete filename |
3aee1200 |
366 | GQuark name; //tracefile name |
367 | guint cpu_num; //cpu number of the tracefile |
e3247aa5 |
368 | LttTrace * trace; //trace containing the tracefile |
369 | int fd; //file descriptor |
370 | off_t file_size; //file size |
f628823c |
371 | //unsigned block_size; //block_size |
3aee1200 |
372 | unsigned int num_blocks; //number of blocks in the file |
373 | gboolean reverse_bo; //must we reverse byte order ? |
3b10b765 |
374 | gboolean float_word_order; //what is the byte order of floats ? |
3aee1200 |
375 | |
823820eb |
376 | size_t buffer_header_size; |
377 | |
3aee1200 |
378 | /* Current event */ |
379 | LttEvent event; //Event currently accessible in the trace |
380 | |
381 | /* Current block */ |
382 | LttBuffer buffer; //current buffer |
383 | guint32 buf_size; /* The size of blocks */ |
384 | |
385 | /* Time flow */ |
386 | //unsigned int count; //the number of overflow of cycle count |
387 | //double nsec_per_cycle; //Nsec per cycle |
388 | //TimeHeartbeat * last_heartbeat; //last heartbeat |
389 | |
887208b7 |
390 | //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed |
3aee1200 |
391 | //void * last_event_pos; |
7c6b3cd7 |
392 | |
3aee1200 |
393 | //LttTime prev_block_end_time; //the end time of previous block |
394 | //LttTime prev_event_time; //the time of the previous event |
395 | //LttCycleCount pre_cycle_count; //previous cycle count of the event |
e3247aa5 |
396 | }; |
7c6b3cd7 |
397 | |
3aee1200 |
398 | struct _LttTrace{ |
399 | GQuark pathname; //the pathname of the trace |
400 | //LttSystemDescription * system_description;//system description |
401 | |
402 | GArray *facilities_by_num; /* fac_id as index in array */ |
403 | GData *facilities_by_name; /* fac name (GQuark) as index */ |
404 | /* Points to array of fac_id of all the |
b56dcdf2 |
405 | * facilities that has this name. */ |
406 | guint num_cpu; |
3aee1200 |
407 | |
16fcbb80 |
408 | guint32 arch_type; |
409 | guint32 arch_variant; |
410 | guint8 arch_size; |
3aee1200 |
411 | guint8 ltt_major_version; |
412 | guint8 ltt_minor_version; |
413 | guint8 flight_recorder; |
414 | guint8 has_heartbeat; |
16fcbb80 |
415 | guint8 has_alignment; |
3aee1200 |
416 | guint8 has_tsc; |
791dffa6 |
417 | uint64_t start_freq; |
418 | uint64_t start_tsc; |
986e2a7c |
419 | uint64_t start_monotonic; |
420 | LttTime start_time; |
88612d17 |
421 | LttTime start_time_from_tsc; |
3aee1200 |
422 | |
423 | GData *tracefiles; //tracefiles groups |
80da81ad |
424 | }; |
7c6b3cd7 |
425 | |
a5dcde2f |
426 | /* The characteristics of the system on which the trace was obtained |
427 | is described in a LttSystemDescription structure. */ |
428 | |
429 | struct _LttSystemDescription { |
45e14832 |
430 | gchar *description; |
431 | gchar *node_name; |
432 | gchar *domain_name; |
a5dcde2f |
433 | unsigned nb_cpu; |
434 | LttArchSize size; |
435 | LttArchEndian endian; |
45e14832 |
436 | gchar *kernel_name; |
437 | gchar *kernel_release; |
438 | gchar *kernel_version; |
439 | gchar *machine; |
440 | gchar *processor; |
441 | gchar *hardware_platform; |
442 | gchar *operating_system; |
a5dcde2f |
443 | LttTime trace_start; |
444 | LttTime trace_end; |
445 | }; |
446 | |
7c6b3cd7 |
447 | /***************************************************************************** |
448 | macro for size of some data types |
449 | *****************************************************************************/ |
3aee1200 |
450 | // alignment -> dynamic! |
451 | |
452 | //#define TIMESTAMP_SIZE sizeof(guint32) |
453 | //#define EVENT_ID_SIZE sizeof(guint16) |
454 | //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE) |
455 | |
7c6b3cd7 |
456 | |
fcdf0ec2 |
457 | #endif /* LTT_PRIVATE_H */ |