1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2005 Mathieu Desnoyers
4 * Complete rewrite from the original version made by XangXiu Yang.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License Version 2.1 as published by the Free Software Foundation.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
30 #include <sys/types.h>
46 #include "ltt-private.h"
47 #include <ltt/trace.h>
48 #include <ltt/facility.h>
49 #include <ltt/event.h>
51 #include <ltt/ltt-types.h>
54 /* Facility names used in this file */
56 GQuark LTT_FACILITY_NAME_HEARTBEAT
,
57 LTT_EVENT_NAME_HEARTBEAT
,
58 LTT_EVENT_NAME_HEARTBEAT_FULL
;
59 GQuark LTT_TRACEFILE_NAME_FACILITIES
;
66 #define __UNUSED__ __attribute__((__unused__))
68 #define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
71 #define g_debug(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format)
76 /* Those macros must be called from within a function where page_size is a known
78 #define PAGE_MASK (~(page_size-1))
79 #define PAGE_ALIGN(addr) (((addr)+page_size-1)&PAGE_MASK)
81 /* set the offset of the fields belonging to the event,
82 need the information of the archecture */
83 //void set_fields_offsets(LttTracefile *tf, LttEventType *event_type);
84 //size_t get_fields_offsets(LttTracefile *tf, LttEventType *event_type, void *data);
86 /* get the size of the field type according to
87 * The facility size information. */
89 static inline void preset_field_type_size(LttTracefile
*tf
,
90 LttEventType
*event_type
,
91 off_t offset_root
, off_t offset_parent
,
92 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
96 /* map a fixed size or a block information from the file (fd) */
97 static gint
map_block(LttTracefile
* tf
, guint block_num
);
99 /* calculate nsec per cycles for current block */
101 static guint32
calc_nsecs_per_cycle(LttTracefile
* t
);
102 static guint64
cycles_2_ns(LttTracefile
*tf
, guint64 cycles
);
105 /* go to the next event */
106 static int ltt_seek_next_event(LttTracefile
*tf
);
108 void ltt_update_event_size(LttTracefile
*tf
);
111 void precompute_offsets(LttFacility
*fac
, LttEventType
*event
);
114 /* Functions to parse system.xml file (using glib xml parser) */
115 static void parser_start_element (GMarkupParseContext __UNUSED__
*context
,
116 const gchar
*element_name
,
117 const gchar
**attribute_names
,
118 const gchar
**attribute_values
,
123 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
124 if(strcmp("system", element_name
)){
125 *error
= g_error_new(G_MARKUP_ERROR
,
127 "This is not system.xml file");
131 while(attribute_names
[i
]){
132 if(strcmp("node_name", attribute_names
[i
])==0){
133 des
->node_name
= g_strdup(attribute_values
[i
]);
134 }else if(strcmp("domainname", attribute_names
[i
])==0){
135 des
->domain_name
= g_strdup(attribute_values
[i
]);
136 }else if(strcmp("cpu", attribute_names
[i
])==0){
137 des
->nb_cpu
= atoi(attribute_values
[i
]);
138 }else if(strcmp("arch_size", attribute_names
[i
])==0){
139 if(strcmp(attribute_values
[i
],"LP32") == 0) des
->size
= LTT_LP32
;
140 else if(strcmp(attribute_values
[i
],"ILP32") == 0) des
->size
= LTT_ILP32
;
141 else if(strcmp(attribute_values
[i
],"LP64") == 0) des
->size
= LTT_LP64
;
142 else if(strcmp(attribute_values
[i
],"ILP64") == 0) des
->size
= LTT_ILP64
;
143 else if(strcmp(attribute_values
[i
],"UNKNOWN") == 0) des
->size
= LTT_UNKNOWN
;
144 }else if(strcmp("endian", attribute_names
[i
])==0){
145 if(strcmp(attribute_values
[i
],"LITTLE_ENDIAN") == 0)
146 des
->endian
= LTT_LITTLE_ENDIAN
;
147 else if(strcmp(attribute_values
[i
],"BIG_ENDIAN") == 0)
148 des
->endian
= LTT_BIG_ENDIAN
;
149 }else if(strcmp("kernel_name", attribute_names
[i
])==0){
150 des
->kernel_name
= g_strdup(attribute_values
[i
]);
151 }else if(strcmp("kernel_release", attribute_names
[i
])==0){
152 des
->kernel_release
= g_strdup(attribute_values
[i
]);
153 }else if(strcmp("kernel_version", attribute_names
[i
])==0){
154 des
->kernel_version
= g_strdup(attribute_values
[i
]);
155 }else if(strcmp("machine", attribute_names
[i
])==0){
156 des
->machine
= g_strdup(attribute_values
[i
]);
157 }else if(strcmp("processor", attribute_names
[i
])==0){
158 des
->processor
= g_strdup(attribute_values
[i
]);
159 }else if(strcmp("hardware_platform", attribute_names
[i
])==0){
160 des
->hardware_platform
= g_strdup(attribute_values
[i
]);
161 }else if(strcmp("operating_system", attribute_names
[i
])==0){
162 des
->operating_system
= g_strdup(attribute_values
[i
]);
163 }else if(strcmp("ltt_major_version", attribute_names
[i
])==0){
164 des
->ltt_major_version
= atoi(attribute_values
[i
]);
165 }else if(strcmp("ltt_minor_version", attribute_names
[i
])==0){
166 des
->ltt_minor_version
= atoi(attribute_values
[i
]);
167 }else if(strcmp("ltt_block_size", attribute_names
[i
])==0){
168 des
->ltt_block_size
= atoi(attribute_values
[i
]);
170 *error
= g_error_new(G_MARKUP_ERROR
,
172 "Not a valid attribute");
179 static void parser_characters (GMarkupParseContext __UNUSED__
*context
,
181 gsize __UNUSED__ text_len
,
183 GError __UNUSED__
**error
)
185 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
186 des
->description
= g_strdup(text
);
191 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
,
194 g_assert(num
< t
->facilities_by_num
->len
);
196 return &g_array_index(t
->facilities_by_num
, LttFacility
, num
);
200 guint
ltt_trace_get_num_cpu(LttTrace
*t
)
208 * Return value : 0 success, 1 bad tracefile
210 int parse_trace_header(void *header
, LttTracefile
*tf
, LttTrace
*t
)
212 guint32
*magic_number
= (guint32
*)header
;
213 struct ltt_trace_header_any
*any
= (struct ltt_trace_header_any
*)header
;
215 if(*magic_number
== LTT_MAGIC_NUMBER
)
217 else if(*magic_number
== LTT_REV_MAGIC_NUMBER
)
219 else /* invalid magic number, bad tracefile ! */
222 /* Get float byte order : might be different from int byte order
223 * (or is set to 0 if the trace has no float (kernel trace)) */
224 tf
->float_word_order
= any
->float_word_order
;
225 tf
->has_alignment
= any
->has_alignment
;
228 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
),
230 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
),
232 t
->arch_size
= any
->arch_size
;
233 t
->ltt_major_version
= any
->major_version
;
234 t
->ltt_minor_version
= any
->minor_version
;
235 t
->flight_recorder
= any
->flight_recorder
;
236 t
->has_heartbeat
= any
->has_heartbeat
;
237 t
->compact_facilities
= NULL
;
241 switch(any
->major_version
) {
244 switch(any
->minor_version
) {
247 tf
->buffer_header_size
=
248 sizeof(struct ltt_block_start_header
)
249 + sizeof(struct ltt_trace_header_0_3
);
250 g_warning("Unsupported trace version : %hhu.%hhu",
251 any
->major_version
, any
->minor_version
);
257 struct ltt_trace_header_0_7
*vheader
=
258 (struct ltt_trace_header_0_7
*)header
;
259 tf
->buffer_header_size
=
260 sizeof(struct ltt_block_start_header
)
261 + sizeof(struct ltt_trace_header_0_7
);
262 tf
->tsc_lsb_truncate
= 0;
264 tf
->tsc_msb_cutoff
= 32 - tf
->tsc_lsb_truncate
- tf
->tscbits
;
265 tf
->tsc_mask
= (1ULL<<32)-1;
266 tf
->tsc_mask_next_bit
= (1ULL<<32);
268 t
->start_freq
= ltt_get_uint64(LTT_GET_BO(tf
),
269 &vheader
->start_freq
);
270 t
->freq_scale
= ltt_get_uint32(LTT_GET_BO(tf
),
271 &vheader
->freq_scale
);
272 t
->start_tsc
= ltt_get_uint64(LTT_GET_BO(tf
),
273 &vheader
->start_tsc
);
274 t
->start_monotonic
= ltt_get_uint64(LTT_GET_BO(tf
),
275 &vheader
->start_monotonic
);
276 t
->start_time
.tv_sec
= ltt_get_uint64(LTT_GET_BO(tf
),
277 &vheader
->start_time_sec
);
278 t
->start_time
.tv_nsec
= ltt_get_uint64(LTT_GET_BO(tf
),
279 &vheader
->start_time_usec
);
280 t
->start_time
.tv_nsec
*= 1000; /* microsec to nanosec */
282 t
->start_time_from_tsc
= ltt_time_from_uint64(
284 * (1000000000.0 / tf
->trace
->freq_scale
)
285 / (double)t
->start_freq
);
286 t
->compact_event_bits
= 0;
292 struct ltt_trace_header_0_8
*vheader
=
293 (struct ltt_trace_header_0_8
*)header
;
294 tf
->buffer_header_size
=
295 sizeof(struct ltt_block_start_header
)
296 + sizeof(struct ltt_trace_header_0_8
);
297 tf
->tsc_lsb_truncate
= vheader
->tsc_lsb_truncate
;
298 tf
->tscbits
= vheader
->tscbits
;
299 tf
->tsc_msb_cutoff
= 32 - tf
->tsc_lsb_truncate
- tf
->tscbits
;
300 tf
->tsc_mask
= ((1ULL << (tf
->tscbits
))-1);
301 tf
->tsc_mask
= tf
->tsc_mask
<< tf
->tsc_lsb_truncate
;
302 tf
->tsc_mask_next_bit
= (1ULL<<(tf
->tscbits
));
303 tf
->tsc_mask_next_bit
= tf
->tsc_mask_next_bit
<< tf
->tsc_lsb_truncate
;
305 t
->start_freq
= ltt_get_uint64(LTT_GET_BO(tf
),
306 &vheader
->start_freq
);
307 t
->freq_scale
= ltt_get_uint32(LTT_GET_BO(tf
),
308 &vheader
->freq_scale
);
309 t
->start_tsc
= ltt_get_uint64(LTT_GET_BO(tf
),
310 &vheader
->start_tsc
);
311 t
->start_monotonic
= ltt_get_uint64(LTT_GET_BO(tf
),
312 &vheader
->start_monotonic
);
313 t
->start_time
.tv_sec
= ltt_get_uint64(LTT_GET_BO(tf
),
314 &vheader
->start_time_sec
);
315 t
->start_time
.tv_nsec
= ltt_get_uint64(LTT_GET_BO(tf
),
316 &vheader
->start_time_usec
);
317 t
->start_time
.tv_nsec
*= 1000; /* microsec to nanosec */
319 t
->start_time_from_tsc
= ltt_time_from_uint64(
321 * (1000000000.0 / tf
->trace
->freq_scale
)
322 / (double)t
->start_freq
);
323 t
->compact_event_bits
= 0;
328 g_warning("Unsupported trace version : %hhu.%hhu",
329 any
->major_version
, any
->minor_version
);
335 g_warning("Unsupported trace version : %hhu.%hhu",
336 any
->major_version
, any
->minor_version
);
346 /*****************************************************************************
348 * ltt_tracefile_open : open a trace file, construct a LttTracefile
350 * t : the trace containing the tracefile
351 * fileName : path name of the trace file
352 * tf : the tracefile structure
354 * : 0 for success, -1 otherwise.
355 ****************************************************************************/
357 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
359 struct stat lTDFStat
; /* Trace data file status */
360 struct ltt_block_start_header
*header
;
361 int page_size
= getpagesize();
364 tf
->long_name
= g_quark_from_string(fileName
);
366 tf
->fd
= open(fileName
, O_RDONLY
);
368 g_warning("Unable to open input data file %s\n", fileName
);
372 // Get the file's status
373 if(fstat(tf
->fd
, &lTDFStat
) < 0){
374 g_warning("Unable to get the status of the input data file %s\n", fileName
);
378 // Is the file large enough to contain a trace
379 if(lTDFStat
.st_size
<
380 (off_t
)(sizeof(struct ltt_block_start_header
)
381 + sizeof(struct ltt_trace_header_any
))){
382 g_print("The input data file %s does not contain a trace\n", fileName
);
386 /* Temporarily map the buffer start header to get trace information */
387 /* Multiple of pages aligned head */
388 tf
->buffer
.head
= mmap(0,
389 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
390 + sizeof(struct ltt_trace_header_any
)), PROT_READ
,
391 MAP_PRIVATE
, tf
->fd
, 0);
392 if(tf
->buffer
.head
== MAP_FAILED
) {
393 perror("Error in allocating memory for buffer of tracefile");
396 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
398 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
400 if(parse_trace_header(header
->trace
, tf
, NULL
)) {
401 g_warning("parse_trace_header error");
405 //store the size of the file
406 tf
->file_size
= lTDFStat
.st_size
;
407 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
408 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
410 if(munmap(tf
->buffer
.head
,
411 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
412 + sizeof(struct ltt_trace_header_any
)))) {
413 g_warning("unmap size : %u\n",
414 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
415 + sizeof(struct ltt_trace_header_any
)));
416 perror("munmap error");
419 tf
->buffer
.head
= NULL
;
421 //read the first block
422 if(map_block(tf
,0)) {
423 perror("Cannot map block for tracefile");
431 if(munmap(tf
->buffer
.head
,
432 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
433 + sizeof(struct ltt_trace_header_any
)))) {
434 g_warning("unmap size : %u\n",
435 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
436 + sizeof(struct ltt_trace_header_any
)));
437 perror("munmap error");
446 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
452 /*****************************************************************************
453 *Open control and per cpu tracefiles
454 ****************************************************************************/
456 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
459 tf
= ltt_tracefile_open(t
,tracefile_name
);
461 t
->per_cpu_tracefile_number
++;
462 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
465 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
474 tf
= ltt_tracefile_open(t
,control_name
);
476 g_warning("ltt_tracefile_open_control : bad file descriptor");
479 t
->control_tracefile_number
++;
480 g_ptr_array_add(t
->control_tracefiles
,tf
);
482 //parse facilities tracefile to get base_id
483 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
485 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
487 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
489 fLoad
.name
= (gchar
*)pos
;
490 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
491 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
493 for(i
=0;i
<t
->facility_number
;i
++){
494 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
495 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
496 f
->base_id
= fLoad
.base_code
;
500 if(i
==t
->facility_number
) {
501 g_warning("Facility: %s, checksum: %u is not found",
502 fLoad
.name
,(unsigned int)fLoad
.checksum
);
505 }else if(ev
.event_id
== TRACE_BLOCK_START
){
507 }else if(ev
.event_id
== TRACE_BLOCK_END
){
510 g_warning("Not valid facilities trace file");
519 /*****************************************************************************
521 * ltt_tracefile_close: close a trace file,
523 * t : tracefile which will be closed
524 ****************************************************************************/
526 void ltt_tracefile_close(LttTracefile
*t
)
528 int page_size
= getpagesize();
530 if(t
->buffer
.head
!= NULL
)
531 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
532 g_warning("unmap size : %u\n",
533 PAGE_ALIGN(t
->buf_size
));
534 perror("munmap error");
542 /*****************************************************************************
543 *Get system information
544 ****************************************************************************/
546 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
553 GMarkupParseContext
* context
;
554 GError
* error
= NULL
;
555 GMarkupParser markup_parser
=
557 parser_start_element
,
560 NULL
, /* passthrough */
564 fd
= g_open(pathname
, O_RDONLY
, 0);
566 g_warning("Can not open file : %s\n", pathname
);
570 iochan
= g_io_channel_unix_new(fd
);
572 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
574 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
575 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
576 != G_IO_STATUS_EOF
) {
579 g_warning("Can not read xml file: \n%s\n", error
->message
);
582 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
584 g_warning("Can not parse xml file: \n%s\n", error
->message
);
587 g_markup_parse_context_free(context
);
589 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
591 g_warning("Can not close file: \n%s\n", error
->message
);
599 g_markup_parse_context_free(context
);
601 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
603 g_warning("Can not close file: \n%s\n", error
->message
);
614 /*****************************************************************************
615 *The following functions get facility/tracefile information
616 ****************************************************************************/
618 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
625 gchar fullname
[DIR_NAME_SIZE
];
626 GError
* error
= NULL
;
628 dir
= g_dir_open(eventdefs
, 0, &error
);
631 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
636 while((name
= g_dir_read_name(dir
)) != NULL
){
637 if(!g_pattern_match_simple("*.xml", name
)) continue;
638 strcpy(fullname
,eventdefs
);
639 strcat(fullname
,name
);
640 ltt_facility_open(t
,fullname
);
644 for(j
=0;j
<t
->facility_number
;j
++){
645 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
646 for(i
=0; i
<f
->event_number
; i
++){
648 setFieldsOffset(NULL
, et
, NULL
, t
);
655 /*****************************************************************************
656 *A trace is specified as a pathname to the directory containing all the
657 *associated data (control tracefiles, per cpu tracefiles, event
660 *When a trace is closed, all the associated facilities, types and fields
661 *are released as well.
665 /****************************************************************************
666 * get_absolute_pathname
668 * return the unique pathname in the system
670 * MD : Fixed this function so it uses realpath, dealing well with
671 * forgotten cases (.. were not used correctly before).
673 ****************************************************************************/
674 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
676 abs_pathname
[0] = '\0';
678 if ( realpath (pathname
, abs_pathname
) != NULL
)
682 /* error, return the original path unmodified */
683 strcpy(abs_pathname
, pathname
);
689 /* Search for something like : .*_.*
691 * The left side is the name, the right side is the number.
694 int get_tracefile_name_number(gchar
*raw_name
,
701 guint raw_name_len
= strlen(raw_name
);
702 gchar char_name
[PATH_MAX
];
709 for(i
=raw_name_len
-1;i
>=0;i
--) {
710 if(raw_name
[i
] == '_') break;
712 if(i
==-1) { /* Either not found or name length is 0 */
713 /* This is a userspace tracefile */
714 strncpy(char_name
, raw_name
, raw_name_len
);
715 char_name
[raw_name_len
] = '\0';
716 *name
= g_quark_from_string(char_name
);
717 *num
= 0; /* unknown cpu */
718 for(i
=0;i
<raw_name_len
;i
++) {
719 if(raw_name
[i
] == '/') {
724 for(;i
<raw_name_len
;i
++) {
725 if(raw_name
[i
] == '/') {
730 for(;i
<raw_name_len
;i
++) {
731 if(raw_name
[i
] == '-') {
735 if(i
== raw_name_len
) return -1;
737 tmpptr
= &raw_name
[i
];
738 for(;i
<raw_name_len
;i
++) {
739 if(raw_name
[i
] == '.') {
744 *tid
= strtoul(tmpptr
, &endptr
, 10);
746 return -1; /* No digit */
747 if(*tid
== ULONG_MAX
)
748 return -1; /* underflow / overflow */
750 tmpptr
= &raw_name
[i
];
751 for(;i
<raw_name_len
;i
++) {
752 if(raw_name
[i
] == '.') {
757 *pgid
= strtoul(tmpptr
, &endptr
, 10);
759 return -1; /* No digit */
760 if(*pgid
== ULONG_MAX
)
761 return -1; /* underflow / overflow */
763 tmpptr
= &raw_name
[i
];
764 *creation
= strtoull(tmpptr
, &endptr
, 10);
766 return -1; /* No digit */
767 if(*creation
== G_MAXUINT64
)
768 return -1; /* underflow / overflow */
772 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
774 if(endptr
== raw_name
+underscore_pos
+1)
775 return -1; /* No digit */
776 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
777 return -1; /* underflow / overflow */
779 strncpy(char_name
, raw_name
, underscore_pos
);
780 char_name
[underscore_pos
] = '\0';
782 *name
= g_quark_from_string(char_name
);
791 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
793 return &trace
->tracefiles
;
797 void compute_tracefile_group(GQuark key_id
,
799 struct compute_tracefile_group_args
*args
)
804 for(i
=0; i
<group
->len
; i
++) {
805 tf
= &g_array_index (group
, LttTracefile
, i
);
807 args
->func(tf
, args
->func_args
);
812 void ltt_tracefile_group_destroy(gpointer data
)
814 GArray
*group
= (GArray
*)data
;
818 for(i
=0; i
<group
->len
; i
++) {
819 tf
= &g_array_index (group
, LttTracefile
, i
);
821 ltt_tracefile_close(tf
);
823 g_array_free(group
, TRUE
);
826 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
828 GArray
*group
= (GArray
*)data
;
832 for(i
=0; i
<group
->len
; i
++) {
833 tf
= &g_array_index (group
, LttTracefile
, i
);
834 if(tf
->cpu_online
) return 1;
840 /* Open each tracefile under a specific directory. Put them in a
841 * GData : permits to access them using their tracefile group pathname.
842 * i.e. access control/modules tracefile group by index :
845 * relative path is the path relative to the trace root
846 * root path is the full path
848 * A tracefile group is simply an array where all the per cpu tracefiles sits.
851 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
852 gchar
*relative_path
)
854 DIR *dir
= opendir(root_path
);
855 struct dirent
*entry
;
856 struct stat stat_buf
;
859 gchar path
[PATH_MAX
];
864 gchar rel_path
[PATH_MAX
];
873 strncpy(path
, root_path
, PATH_MAX
-1);
874 path_len
= strlen(path
);
875 path
[path_len
] = '/';
877 path_ptr
= path
+ path_len
;
879 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
880 rel_path_len
= strlen(rel_path
);
881 rel_path
[rel_path_len
] = '/';
883 rel_path_ptr
= rel_path
+ rel_path_len
;
885 while((entry
= readdir(dir
)) != NULL
) {
887 if(entry
->d_name
[0] == '.') continue;
889 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
890 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
892 ret
= stat(path
, &stat_buf
);
898 g_debug("Tracefile file or directory : %s\n", path
);
900 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
902 if(S_ISDIR(stat_buf
.st_mode
)) {
904 g_debug("Entering subdirectory...\n");
905 ret
= open_tracefiles(trace
, path
, rel_path
);
906 if(ret
< 0) continue;
907 } else if(S_ISREG(stat_buf
.st_mode
)) {
909 guint num
, tid
, pgid
;
912 num
= tid
= pgid
= 0;
914 if(get_tracefile_name_number(rel_path
, &name
, &num
, &tid
, &pgid
, &creation
))
915 continue; /* invalid name */
917 g_debug("Opening file.\n");
918 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
919 g_info("Error opening tracefile %s", path
);
921 continue; /* error opening the tracefile : bad magic number ? */
924 g_debug("Tracefile name is %s and number is %u",
925 g_quark_to_string(name
), num
);
927 tmp_tf
.cpu_online
= 1;
928 tmp_tf
.cpu_num
= num
;
932 tmp_tf
.creation
= creation
;
933 if(tmp_tf
.name
== g_quark_from_string("/compact")
934 || tmp_tf
.name
== g_quark_from_string("/flight-compact"))
938 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
940 /* Elements are automatically cleared when the array is allocated.
941 * It makes the cpu_online variable set to 0 : cpu offline, by default.
943 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
944 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
945 group
, ltt_tracefile_group_destroy
);
948 /* Add the per cpu tracefile to the named group */
949 unsigned int old_len
= group
->len
;
951 group
= g_array_set_size(group
, num
+1);
952 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
962 /* ltt_get_facility_description
964 * Opens the file corresponding to the requested facility (identified by fac_id
967 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
969 * Returns 0 on success, or 1 on failure.
972 static int ltt_get_facility_description(LttFacility
*f
,
974 LttTracefile
*fac_tf
)
976 char desc_file_name
[PATH_MAX
];
983 text
= g_quark_to_string(t
->pathname
);
984 textlen
= strlen(text
);
986 if(textlen
>= PATH_MAX
) goto name_error
;
987 strcpy(desc_file_name
, text
);
989 text
= "/eventdefs/";
990 textlen
+=strlen(text
);
991 if(textlen
>= PATH_MAX
) goto name_error
;
992 strcat(desc_file_name
, text
);
994 text
= g_quark_to_string(f
->name
);
995 fac_name_len
= strlen(text
);
996 textlen
+=fac_name_len
;
997 if(textlen
>= PATH_MAX
) goto name_error
;
998 strcat(desc_file_name
, text
);
1000 /* arch specific facilities are named like this : name_arch */
1001 if(fac_name_len
+1 < sizeof("_arch"))
1004 if(!strcmp(&text
[fac_name_len
+1-sizeof("_arch")], "_arch"))
1012 textlen
+=strlen(text
);
1013 if(textlen
>= PATH_MAX
) goto name_error
;
1014 strcat(desc_file_name
, text
);
1016 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
1018 if(err
< 0) goto name_error
;
1020 textlen
=strlen(desc_file_name
);
1025 switch(t
->arch_type
) {
1026 case LTT_ARCH_TYPE_I386
:
1029 case LTT_ARCH_TYPE_PPC
:
1032 case LTT_ARCH_TYPE_SH
:
1035 case LTT_ARCH_TYPE_S390
:
1038 case LTT_ARCH_TYPE_MIPS
:
1041 case LTT_ARCH_TYPE_ARM
:
1044 case LTT_ARCH_TYPE_PPC64
:
1047 case LTT_ARCH_TYPE_X86_64
:
1050 case LTT_ARCH_TYPE_C2
:
1053 case LTT_ARCH_TYPE_POWERPC
:
1057 g_error("Trace from unsupported architecture.");
1059 textlen
+=strlen(text
);
1060 if(textlen
>= PATH_MAX
) goto name_error
;
1061 strcat(desc_file_name
, text
);
1065 textlen
+=strlen(text
);
1066 if(textlen
>= PATH_MAX
) goto name_error
;
1067 strcat(desc_file_name
, text
);
1069 err
= ltt_facility_open(f
, t
, desc_file_name
);
1070 if(err
) goto facility_error
;
1079 static void ltt_fac_ids_destroy(gpointer data
)
1081 GArray
*fac_ids
= (GArray
*)data
;
1083 g_array_free(fac_ids
, TRUE
);
1087 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
1088 * because it must be done just after the opening */
1089 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
1098 err
= ltt_tracefile_read_seek(tf
);
1099 if(err
== EPERM
) goto seek_error
;
1100 else if(err
== ERANGE
) break; /* End of tracefile */
1102 err
= ltt_tracefile_read_update_event(tf
);
1103 if(err
) goto update_error
;
1105 /* We are on a facility load/or facility unload/ or heartbeat event */
1107 * * facility 0 is hardcoded : this is the core facility. It will be shown
1108 * in the facility array though, and is shown as "loaded builtin" in the
1110 * It contains event :
1112 * 1 : facility unload
1113 * 2 : state dump facility load
1116 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
1117 /* Should only contain core facility */
1118 g_warning("Error in processing facility file %s, "
1119 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
1120 tf
->event
.facility_id
);
1125 struct LttFacilityLoad
*fac_load_data
;
1126 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
1131 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1132 case LTT_EVENT_FACILITY_LOAD
:
1133 fac_name
= (char*)(tf
->event
.data
);
1134 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
1136 pos
= (tf
->event
.data
+ strlen(fac_name
) + 1);
1137 pos
+= ltt_align((size_t)pos
, tf
->trace
->arch_size
, tf
->has_alignment
);
1138 fac_load_data
= (struct LttFacilityLoad
*)pos
;
1140 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
1141 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
1142 /* facility may already exist if trace is paused/unpaused */
1143 if(fac
->exists
) continue;
1144 fac
->name
= g_quark_from_string(fac_name
);
1145 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
1146 &fac_load_data
->checksum
);
1147 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
1148 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1149 &fac_load_data
->pointer_size
);
1150 fac
->int_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1151 &fac_load_data
->int_size
);
1152 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1153 &fac_load_data
->long_size
);
1154 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1155 &fac_load_data
->size_t_size
);
1156 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
1157 &fac_load_data
->has_alignment
);
1159 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
1160 continue; /* error opening description */
1162 fac
->trace
= tf
->trace
;
1164 /* Preset the field offsets */
1165 for(i
=0; i
<fac
->events
->len
; i
++){
1166 et
= &g_array_index(fac
->events
, LttEventType
, i
);
1167 precompute_offsets(fac
, et
);
1172 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
1174 if(fac_ids
== NULL
) {
1175 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
1176 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1178 fac_ids
, ltt_fac_ids_destroy
);
1180 g_array_append_val(fac_ids
, fac
->id
);
1183 case LTT_EVENT_FACILITY_UNLOAD
:
1184 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
1185 /* We don't care about unload : facilities ID are valid for the whole
1186 * trace. They simply won't be used after the unload. */
1188 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1189 fac_name
= (char*)(tf
->event
.data
);
1190 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
1192 pos
= (tf
->event
.data
+ strlen(fac_name
) + 1);
1193 pos
+= ltt_align((size_t)pos
, tf
->trace
->arch_size
, tf
->has_alignment
);
1194 fac_state_dump_load_data
= (struct LttStateDumpFacilityLoad
*)pos
;
1196 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
1197 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
1198 /* facility may already exist if trace is paused/unpaused */
1199 if(fac
->exists
) continue;
1200 fac
->name
= g_quark_from_string(fac_name
);
1201 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
1202 &fac_state_dump_load_data
->checksum
);
1203 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
),
1204 &fac_state_dump_load_data
->id
);
1205 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1206 &fac_state_dump_load_data
->pointer_size
);
1207 fac
->int_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1208 &fac_state_dump_load_data
->int_size
);
1209 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1210 &fac_state_dump_load_data
->long_size
);
1211 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1212 &fac_state_dump_load_data
->size_t_size
);
1213 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
1214 &fac_state_dump_load_data
->has_alignment
);
1215 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
1216 continue; /* error opening description */
1218 fac
->trace
= tf
->trace
;
1220 /* Preset the field offsets */
1221 for(i
=0; i
<fac
->events
->len
; i
++){
1222 et
= &g_array_index(fac
->events
, LttEventType
, i
);
1223 precompute_offsets(fac
, et
);
1228 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
1230 if(fac_ids
== NULL
) {
1231 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
1232 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1234 fac_ids
, ltt_fac_ids_destroy
);
1236 g_array_append_val(fac_ids
, fac
->id
);
1237 g_debug("fac id : %u", fac
->id
);
1240 case LTT_EVENT_HEARTBEAT
:
1242 case LTT_EVENT_HEARTBEAT_FULL
:
1245 g_warning("Error in processing facility file %s, "
1246 "unknown event id %hhu in core facility.",
1247 g_quark_to_string(tf
->name
),
1248 tf
->event
.event_id
);
1250 goto event_id_error
;
1256 /* Error handling */
1261 g_warning("An error occured in facility tracefile parsing");
1266 LttTrace
*ltt_trace_open(const gchar
*pathname
)
1268 gchar abs_path
[PATH_MAX
];
1273 struct ltt_block_start_header
*header
;
1275 struct dirent
*entry
;
1276 guint control_found
= 0;
1277 guint eventdefs_found
= 0;
1278 struct stat stat_buf
;
1279 gchar path
[PATH_MAX
];
1281 t
= g_new(LttTrace
, 1);
1282 if(!t
) goto alloc_error
;
1284 get_absolute_pathname(pathname
, abs_path
);
1285 t
->pathname
= g_quark_from_string(abs_path
);
1287 g_datalist_init(&t
->tracefiles
);
1289 /* Test to see if it looks like a trace */
1290 dir
= opendir(abs_path
);
1295 while((entry
= readdir(dir
)) != NULL
) {
1296 strcpy(path
, abs_path
);
1298 strcat(path
, entry
->d_name
);
1299 ret
= stat(path
, &stat_buf
);
1304 if(S_ISDIR(stat_buf
.st_mode
)) {
1305 if(strcmp(entry
->d_name
, "control") == 0) {
1308 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1309 eventdefs_found
= 1;
1315 if(!control_found
|| !eventdefs_found
) goto find_error
;
1317 /* Open all the tracefiles */
1318 if(open_tracefiles(t
, abs_path
, "")) {
1319 g_warning("Error opening tracefile %s", abs_path
);
1323 /* Prepare the facilities containers : array and mapping */
1324 /* Array is zeroed : the "exists" field is set to false by default */
1325 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1326 TRUE
, sizeof(LttFacility
),
1328 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1330 g_datalist_init(&t
->facilities_by_name
);
1332 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1333 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1335 g_error("Trace %s has no facility tracefile", abs_path
);
1337 goto facilities_error
;
1340 /* Get the trace information for the control/facility 0 tracefile */
1341 g_assert(group
->len
> 0);
1342 tf
= &g_array_index (group
, LttTracefile
, 0);
1343 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1344 g_assert(parse_trace_header(header
->trace
,
1347 t
->num_cpu
= group
->len
;
1349 for(i
=0; i
<group
->len
; i
++) {
1350 tf
= &g_array_index (group
, LttTracefile
, i
);
1351 if(ltt_process_facility_tracefile(tf
))
1352 goto facilities_error
;
1354 t
->compact_facilities
= ltt_trace_facility_get_by_name(t
,
1355 g_quark_from_string("compact"));
1356 if(!t
->compact_facilities
)
1357 t
->compact_facilities
= ltt_trace_facility_get_by_name(t
,
1358 g_quark_from_string("flight-compact"));
1359 /* FIXME : currently does not support unload/load of compact
1360 * facility during tracing. Should check for the currently loaded
1361 * version of the facility. */
1362 g_assert(t
->compact_facilities
);
1363 g_assert(t
->compact_facilities
->len
== 1);
1365 guint facility_id
= g_array_index(t
->compact_facilities
, guint
, 0);
1366 LttFacility
*fac
= ltt_trace_facility_by_id(t
, facility_id
);
1367 unsigned int num
= ltt_facility_eventtype_number(fac
);
1368 /* Could be done much quicker, but not on much used code path */
1370 t
->compact_event_bits
= 1;
1372 t
->compact_event_bits
++;
1374 t
->compact_event_bits
= 0;
1379 /* Error handling */
1381 g_datalist_clear(&t
->facilities_by_name
);
1382 g_array_free(t
->facilities_by_num
, TRUE
);
1384 g_datalist_clear(&t
->tracefiles
);
1392 GQuark
ltt_trace_name(const LttTrace
*t
)
1398 /******************************************************************************
1399 * When we copy a trace, we want all the opening actions to happen again :
1400 * the trace will be reopened and totally independant from the original.
1401 * That's why we call ltt_trace_open.
1402 *****************************************************************************/
1403 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1405 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1408 void ltt_trace_close(LttTrace
*t
)
1413 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1414 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1416 ltt_facility_close(fac
);
1419 g_datalist_clear(&t
->facilities_by_name
);
1420 g_array_free(t
->facilities_by_num
, TRUE
);
1421 g_datalist_clear(&t
->tracefiles
);
1426 /*****************************************************************************
1427 *Get the system description of the trace
1428 ****************************************************************************/
1430 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1432 g_assert(id
< t
->facilities_by_num
->len
);
1433 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1436 /* ltt_trace_facility_get_by_name
1438 * Returns the GArray of facility indexes. All the fac_ids that matches the
1439 * requested facility name.
1441 * If name is not found, returns NULL.
1443 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1445 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1448 /*****************************************************************************
1449 * Functions to discover all the event types in the trace
1450 ****************************************************************************/
1453 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1457 unsigned int num
= t
->facility_number
;
1461 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1462 count
+= f
->event_number
;
1469 //use an iteration on all the trace facilities, and inside iteration on all the
1470 //event types in each facilities instead.
1471 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1473 LttEventType
*event_type
;
1476 f
= ltt_trace_facility_by_id(t
,evId
);
1478 if(unlikely(!f
)) event_type
= NULL
;
1479 else event_type
= f
->events
[evId
- f
->base_id
];
1486 /*****************************************************************************
1487 * ltt_trace_find_tracefile
1489 * Find a tracefile by name and index in the group.
1491 * Returns a pointer to the tracefiles, else NULL.
1492 ****************************************************************************/
1494 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1499 /*****************************************************************************
1500 * Get the start time and end time of the trace
1501 ****************************************************************************/
1503 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1504 LttTime
*start
, LttTime
*end
)
1508 err
= map_block(tf
, 0);
1510 g_error("Can not map block");
1511 *start
= ltt_time_infinite
;
1513 *start
= tf
->buffer
.begin
.timestamp
;
1515 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1517 g_error("Can not map block");
1518 *end
= ltt_time_zero
;
1520 *end
= tf
->buffer
.end
.timestamp
;
1523 struct tracefile_time_span_get_args
{
1529 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1531 struct tracefile_time_span_get_args
*args
=
1532 (struct tracefile_time_span_get_args
*)user_data
;
1534 GArray
*group
= (GArray
*)data
;
1540 for(i
=0; i
<group
->len
; i
++) {
1541 tf
= &g_array_index (group
, LttTracefile
, i
);
1542 if(tf
->cpu_online
) {
1543 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1544 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1545 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1550 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1552 LttTime min_start
= ltt_time_infinite
;
1553 LttTime max_end
= ltt_time_zero
;
1554 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1556 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1558 if(start
!= NULL
) *start
= min_start
;
1559 if(end
!= NULL
) *end
= max_end
;
1564 /*****************************************************************************
1565 *Get the name of a tracefile
1566 ****************************************************************************/
1568 GQuark
ltt_tracefile_name(const LttTracefile
*tf
)
1573 GQuark
ltt_tracefile_long_name(const LttTracefile
*tf
)
1575 return tf
->long_name
;
1580 guint
ltt_tracefile_cpu(LttTracefile
*tf
)
1585 guint
ltt_tracefile_tid(LttTracefile
*tf
)
1590 guint
ltt_tracefile_pgid(LttTracefile
*tf
)
1595 guint64
ltt_tracefile_creation(LttTracefile
*tf
)
1597 return tf
->creation
;
1599 /*****************************************************************************
1600 * Get the number of blocks in the tracefile
1601 ****************************************************************************/
1603 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1605 return tf
->num_blocks
;
1609 /* Seek to the first event in a tracefile that has a time equal or greater than
1610 * the time passed in parameter.
1612 * If the time parameter is outside the tracefile time span, seek to the first
1613 * event or if after, return ERANGE.
1615 * If the time parameter is before the first event, we have to seek specially to
1618 * If the time is after the end of the trace, return ERANGE.
1620 * Do a binary search to find the right block, then a sequential search in the
1621 * block to find the event.
1623 * In the special case where the time requested fits inside a block that has no
1624 * event corresponding to the requested time, the first event of the next block
1627 * IMPORTANT NOTE : // FIXME everywhere...
1629 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1630 * you will jump over an event if you do.
1632 * Return value : 0 : no error, the tf->event can be used
1633 * ERANGE : time if after the last event of the trace
1634 * otherwise : this is an error.
1638 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1642 unsigned int block_num
, high
, low
;
1644 /* seek at the beginning of trace */
1645 err
= map_block(tf
, 0); /* First block */
1647 g_error("Can not map block");
1651 /* If the time is lower or equal the beginning of the trace,
1652 * go to the first event. */
1653 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1654 ret
= ltt_tracefile_read(tf
);
1655 if(ret
== ERANGE
) goto range
;
1656 else if (ret
) goto fail
;
1657 goto found
; /* There is either no event in the trace or the event points
1658 to the first event in the trace */
1661 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1663 g_error("Can not map block");
1667 /* If the time is after the end of the trace, return ERANGE. */
1668 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1672 /* Binary search the block */
1673 high
= tf
->num_blocks
- 1;
1677 block_num
= ((high
-low
) / 2) + low
;
1679 err
= map_block(tf
, block_num
);
1681 g_error("Can not map block");
1685 /* We cannot divide anymore : this is what would happen if the time
1686 * requested was exactly between two consecutive buffers'end and start
1687 * timestamps. This is also what would happend if we didn't deal with out
1688 * of span cases prior in this function. */
1689 /* The event is right in the buffer!
1690 * (or in the next buffer first event) */
1692 ret
= ltt_tracefile_read(tf
);
1693 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1694 else if(ret
) goto fail
;
1696 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1700 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1701 /* go to lower part */
1702 high
= block_num
- 1;
1703 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1704 /* go to higher part */
1705 low
= block_num
+ 1;
1706 } else {/* The event is right in the buffer!
1707 (or in the next buffer first event) */
1709 ret
= ltt_tracefile_read(tf
);
1710 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1711 else if(ret
) goto fail
;
1713 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1725 /* Error handling */
1727 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1728 g_quark_to_string(tf
->name
));
1733 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1737 if(ep
->tracefile
!= tf
) {
1741 err
= map_block(tf
, ep
->block
);
1743 g_error("Can not map block");
1747 tf
->event
.offset
= ep
->offset
;
1749 /* Put back the event real tsc */
1750 tf
->event
.tsc
= ep
->tsc
;
1751 tf
->buffer
.tsc
= ep
->tsc
;
1753 err
= ltt_tracefile_read_update_event(tf
);
1755 err
= ltt_tracefile_read_op(tf
);
1761 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1762 g_quark_to_string(tf
->name
));
1766 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
)
1770 if(tsc
> tf
->trace
->start_tsc
) {
1771 time
= ltt_time_from_uint64(
1772 (double)(tsc
- tf
->trace
->start_tsc
)
1773 * (1000000000.0 / tf
->trace
->freq_scale
)
1774 / (double)tf
->trace
->start_freq
);
1775 time
= ltt_time_add(tf
->trace
->start_time_from_tsc
, time
);
1777 time
= ltt_time_from_uint64(
1778 (double)(tf
->trace
->start_tsc
- tsc
)
1779 * (1000000000.0 / tf
->trace
->freq_scale
)
1780 / (double)tf
->trace
->start_freq
);
1781 time
= ltt_time_sub(tf
->trace
->start_time_from_tsc
, time
);
1786 /* Calculate the real event time based on the buffer boundaries */
1787 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1789 return ltt_interpolate_time_from_tsc(tf
, tf
->buffer
.tsc
);
1793 /* Get the current event of the tracefile : valid until the next read */
1794 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1801 /*****************************************************************************
1803 * ltt_tracefile_read : Read the next event in the tracefile
1808 * Returns 0 if an event can be used in tf->event.
1809 * Returns ERANGE on end of trace. The event in tf->event still can be used
1810 * (if the last block was not empty).
1811 * Returns EPERM on error.
1813 * This function does make the tracefile event structure point to the event
1814 * currently pointed to by the tf->event.
1816 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1817 * reinitialize it after an error if you want results to be coherent.
1818 * It would be the case if a end of trace last buffer has no event : the end
1819 * of trace wouldn't be returned, but an error.
1820 * We make the assumption there is at least one event per buffer.
1821 ****************************************************************************/
1823 int ltt_tracefile_read(LttTracefile
*tf
)
1827 err
= ltt_tracefile_read_seek(tf
);
1829 err
= ltt_tracefile_read_update_event(tf
);
1831 err
= ltt_tracefile_read_op(tf
);
1837 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1841 /* Get next buffer until we finally have an event, or end of trace */
1843 err
= ltt_seek_next_event(tf
);
1844 if(unlikely(err
== ENOPROTOOPT
)) {
1848 /* Are we at the end of the buffer ? */
1850 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1853 /* get next block */
1854 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1856 g_error("Can not map block");
1860 } else break; /* We found an event ! */
1867 /* do specific operation on events */
1868 int ltt_tracefile_read_op(LttTracefile
*tf
)
1874 /* do event specific operation */
1876 /* do something if its an heartbeat event : increment the heartbeat count */
1877 //if(event->facility_id == LTT_FACILITY_CORE)
1878 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1879 // tf->cur_heart_beat_number++;
1885 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1886 * event specific operation. */
1887 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1893 pos
= tf
->buffer
.head
+ event
->offset
;
1895 /* Read event header */
1897 /* Align the head */
1899 pos
+= ltt_align((size_t)pos
, tf
->trace
->arch_size
, tf
->has_alignment
);
1901 g_assert(tf
->trace
->has_heartbeat
);
1902 pos
+= ltt_align((size_t)pos
, sizeof(uint32_t), tf
->has_alignment
);
1905 if(tf
->trace
->has_heartbeat
) {
1906 event
->timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1909 /* 32 bits -> 64 bits tsc */
1910 /* note : still works for seek and non seek cases. */
1911 if(event
->timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1912 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1914 | (guint64
)event
->timestamp
;
1915 event
->tsc
= tf
->buffer
.tsc
;
1918 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1919 | (guint64
)event
->timestamp
;
1920 event
->tsc
= tf
->buffer
.tsc
;
1921 event
->compact_data
= 0;
1924 /* Compact header */
1925 /* We keep the LSB of the previous timestamp, to make sure
1926 * we never go back */
1927 event
->event_id
= event
->timestamp
>> tf
->tscbits
;
1928 event
->event_id
= event
->event_id
& ((1 << tf
->trace
->compact_event_bits
) - 1);
1929 event
->compact_data
= event
->timestamp
>>
1930 (tf
->trace
->compact_event_bits
+ tf
->tscbits
);
1931 //printf("tsc bits %u, ev bits %u init data %u\n",
1932 // tf->tscbits, tf->trace->compact_event_bits, event->compact_data);
1933 /* Put the compact data back in original endianness */
1934 event
->compact_data
= ltt_get_uint32(LTT_GET_BO(tf
), &event
->compact_data
);
1935 event
->event_size
= 0xFFFF;
1936 //printf("Found compact event %d\n", event->event_id);
1937 //printf("Compact data %d\n", event->compact_data);
1938 event
->timestamp
= event
->timestamp
<< tf
->tsc_lsb_truncate
;
1939 event
->timestamp
= event
->timestamp
& tf
->tsc_mask
;
1940 //printf("timestamp 0x%lX\n", event->timestamp);
1941 //printf("mask 0x%llX\n", tf->tsc_mask);
1942 //printf("mask_next 0x%llX\n", tf->tsc_mask_next_bit);
1943 //printf("previous tsc 0x%llX\n", tf->buffer.tsc);
1944 //printf("previous tsc&mask 0x%llX\n", tf->tsc_mask&tf->buffer.tsc);
1945 //printf("previous tsc&(~mask) 0x%llX\n", tf->buffer.tsc&(~tf->tsc_mask));
1946 if(event
->timestamp
< (tf
->tsc_mask
&tf
->buffer
.tsc
)) {
1948 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&(~tf
->tsc_mask
))
1949 + tf
->tsc_mask_next_bit
)
1950 | (guint64
)event
->timestamp
;
1951 event
->tsc
= tf
->buffer
.tsc
;
1953 //printf("no wrap\n");
1955 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&(~tf
->tsc_mask
))
1956 | (guint64
)event
->timestamp
;
1957 event
->tsc
= tf
->buffer
.tsc
;
1959 //printf("current tsc 0x%llX\n", tf->buffer.tsc);
1960 event
->facility_id
= g_array_index(tf
->trace
->compact_facilities
, guint
, 0);
1962 pos
+= sizeof(guint32
);
1964 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1965 tf
->buffer
.tsc
= event
->tsc
;
1966 event
->compact_data
= 0;
1967 pos
+= sizeof(guint64
);
1969 event
->event_time
= ltt_interpolate_time(tf
, event
);
1972 event
->facility_id
= *(guint8
*)pos
;
1973 pos
+= sizeof(guint8
);
1975 event
->event_id
= *(guint8
*)pos
;
1976 pos
+= sizeof(guint8
);
1978 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1979 pos
+= sizeof(guint16
);
1983 /* Align the head */
1985 pos
+= ltt_align((size_t)pos
, tf
->trace
->arch_size
, tf
->has_alignment
);
1989 /* get the data size and update the event fields with the current
1990 * information. Also update the time if a heartbeat_full event is found. */
1991 ltt_update_event_size(tf
);
1997 /****************************************************************************
1999 * map_block : map a block from the file
2001 * lttdes : ltt trace file
2002 * whichBlock : the block which will be read
2005 * EINVAL : lseek fail
2006 * EIO : can not read from the file
2007 ****************************************************************************/
2009 static gint
map_block(LttTracefile
* tf
, guint block_num
)
2011 int page_size
= getpagesize();
2012 struct ltt_block_start_header
*header
;
2014 g_assert(block_num
< tf
->num_blocks
);
2016 if(tf
->buffer
.head
!= NULL
) {
2017 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
2018 g_warning("unmap size : %u\n",
2019 PAGE_ALIGN(tf
->buf_size
));
2020 perror("munmap error");
2026 /* Multiple of pages aligned head */
2027 tf
->buffer
.head
= mmap(0,
2028 PAGE_ALIGN(tf
->buf_size
),
2029 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
2030 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
2032 if(tf
->buffer
.head
== MAP_FAILED
) {
2033 perror("Error in allocating memory for buffer of tracefile");
2037 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
2040 tf
->buffer
.index
= block_num
;
2042 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
2045 tf
->buffer
.begin
.timestamp
= ltt_time_add(
2046 ltt_time_from_uint64(
2047 ltt_get_uint64(LTT_GET_BO(tf
),
2048 &header
->begin
.timestamp
)
2049 - tf
->trace
->start_monotonic
),
2050 tf
->trace
->start_time
);
2052 //g_debug("block %u begin : %lu.%lu", block_num,
2053 // tf->buffer.begin.timestamp.tv_sec, tf->buffer.begin.timestamp.tv_nsec);
2054 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
2055 &header
->begin
.cycle_count
);
2056 tf
->buffer
.begin
.freq
= ltt_get_uint64(LTT_GET_BO(tf
),
2057 &header
->begin
.freq
);
2058 if(tf
->buffer
.begin
.freq
== 0)
2059 tf
->buffer
.begin
.freq
= tf
->trace
->start_freq
;
2061 tf
->buffer
.begin
.timestamp
= ltt_interpolate_time_from_tsc(tf
,
2062 tf
->buffer
.begin
.cycle_count
);
2065 ltt_time_from_uint64(
2066 (double)(tf
->buffer
.begin
.cycle_count
2067 - tf
->trace
->start_tsc
) * 1000000.0
2068 / (double)tf
->trace
->start_freq
),
2069 tf
->trace
->start_time_from_tsc
);
2073 tf
->buffer
.end
.timestamp
= ltt_time_add(
2074 ltt_time_from_uint64(
2075 ltt_get_uint64(LTT_GET_BO(tf
),
2076 &header
->end
.timestamp
)
2077 - tf
->trace
->start_monotonic
),
2078 tf
->trace
->start_time
);
2080 //g_debug("block %u end : %lu.%lu", block_num,
2081 // tf->buffer.end.timestamp.tv_sec, tf->buffer.end.timestamp.tv_nsec);
2082 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
2083 &header
->end
.cycle_count
);
2084 tf
->buffer
.end
.freq
= ltt_get_uint64(LTT_GET_BO(tf
),
2086 if(tf
->buffer
.end
.freq
== 0)
2087 tf
->buffer
.end
.freq
= tf
->trace
->start_freq
;
2089 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
2090 &header
->lost_size
);
2091 tf
->buffer
.end
.timestamp
= ltt_interpolate_time_from_tsc(tf
,
2092 tf
->buffer
.end
.cycle_count
);
2095 ltt_time_from_uint64(
2096 (double)(tf
->buffer
.end
.cycle_count
2097 - tf
->trace
->start_tsc
) * 1000000.0
2098 / (double)tf
->trace
->start_freq
),
2099 tf
->trace
->start_time_from_tsc
);
2101 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
2102 tf
->event
.tsc
= tf
->buffer
.tsc
;
2103 tf
->buffer
.freq
= tf
->buffer
.begin
.freq
;
2106 * eventually support variable buffer size : will need a partial pre-read of
2107 * the headers to create an index when we open the trace... eventually. */
2108 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
2109 &header
->buf_size
));
2111 /* Now that the buffer is mapped, calculate the time interpolation for the
2114 // tf->buffer.nsecs_per_cycle = calc_nsecs_per_cycle(tf);
2115 //tf->buffer.cyc2ns_scale = calc_nsecs_per_cycle(tf);
2117 /* Make the current event point to the beginning of the buffer :
2118 * it means that the event read must get the first event. */
2119 tf
->event
.tracefile
= tf
;
2120 tf
->event
.block
= block_num
;
2121 tf
->event
.offset
= 0;
2130 /* It will update the fields offsets too */
2131 void ltt_update_event_size(LttTracefile
*tf
)
2134 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
2135 tf
->event
.facility_id
);
2139 /* Specific handling of core events : necessary to read the facility control
2142 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
2143 switch((enum ltt_core_events
)tf
->event
.event_id
) {
2144 case LTT_EVENT_FACILITY_LOAD
:
2145 size
= strlen((char*)tf
->event
.data
) + 1;
2146 //g_debug("Update Event facility load of facility %s", (char*)tf->event.data);
2147 size
+= ltt_align(size
, sizeof(guint32
), tf
->has_alignment
);
2148 size
+= sizeof(struct LttFacilityLoad
);
2150 case LTT_EVENT_FACILITY_UNLOAD
:
2151 //g_debug("Update Event facility unload");
2152 size
= sizeof(struct LttFacilityUnload
);
2154 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
2155 size
= strlen((char*)tf
->event
.data
) + 1;
2156 size
+= ltt_align(size
, sizeof(guint32
), tf
->has_alignment
);
2157 //g_debug("Update Event facility load state dump of facility %s",
2158 // (char*)tf->event.data);
2159 size
+= sizeof(struct LttStateDumpFacilityLoad
);
2161 case LTT_EVENT_HEARTBEAT
:
2162 //g_debug("Update Event heartbeat");
2163 size
= sizeof(TimeHeartbeat
);
2165 case LTT_EVENT_HEARTBEAT_FULL
:
2166 //g_debug("Update Event heartbeat full");
2167 tscdata
= (char*)(tf
->event
.data
);
2168 tf
->event
.tsc
= ltt_get_uint64(LTT_GET_BO(tf
), tscdata
);
2169 tf
->buffer
.tsc
= tf
->event
.tsc
;
2170 tf
->event
.event_time
= ltt_interpolate_time(tf
, &tf
->event
);
2171 size
= sizeof(TimeHeartbeatFull
);
2172 size
+= ltt_align(size
, sizeof(guint64
), tf
->has_alignment
);
2175 g_warning("Error in getting event size : tracefile %s, "
2176 "unknown event id %hhu in core facility.",
2177 g_quark_to_string(tf
->name
),
2178 tf
->event
.event_id
);
2179 goto event_id_error
;
2182 goto no_offset
; /* Skip the field computation */
2184 g_warning("Unknown facility %hhu (0x%hhx) in tracefile %s",
2185 tf
->event
.facility_id
,
2186 tf
->event
.facility_id
,
2187 g_quark_to_string(tf
->name
));
2188 goto facility_error
;
2192 LttEventType
*event_type
=
2193 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
2196 g_warning("Unknown event id %hhu in facility %s in tracefile %s",
2198 g_quark_to_string(f
->name
),
2199 g_quark_to_string(tf
->name
));
2200 goto event_type_error
;
2203 /* Compute the dynamic offsets */
2204 compute_offsets(tf
, f
, event_type
, &size
, tf
->event
.data
);
2206 //g_debug("Event root field : f.e %hhu.%hhu size %zd",
2207 // tf->event.facility_id,
2208 // tf->event.event_id, size);
2211 tf
->event
.data_size
= size
;
2213 /* Check consistency between kernel and LTTV structure sizes */
2214 if(tf
->event
.event_size
== 0xFFFF) {
2215 /* Event size too big to fit in the event size field */
2216 tf
->event
.event_size
= tf
->event
.data_size
;
2218 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
2225 if(tf
->event
.event_size
== 0xFFFF) {
2226 g_error("Cannot jump over an unknown event bigger than 0xFFFE bytes");
2228 /* The facility is unknown : use the kernel information about this event
2229 * to jump over it. */
2230 tf
->event
.data_size
= tf
->event
.event_size
;
2234 /* Take the tf current event offset and use the event facility id and event id
2235 * to figure out where is the next event offset.
2237 * This is an internal function not aiming at being used elsewhere : it will
2238 * not jump over the current block limits. Please consider using
2239 * ltt_tracefile_read to do this.
2241 * Returns 0 on success
2242 * ERANGE if we are at the end of the buffer.
2243 * ENOPROTOOPT if an error occured when getting the current event size.
2245 static int ltt_seek_next_event(LttTracefile
*tf
)
2250 /* seek over the buffer header if we are at the buffer start */
2251 if(tf
->event
.offset
== 0) {
2252 tf
->event
.offset
+= tf
->buffer_header_size
;
2254 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
2261 pos
= tf
->event
.data
;
2263 if(tf
->event
.data_size
< 0) goto error
;
2265 pos
+= (size_t)tf
->event
.data_size
;
2267 tf
->event
.offset
= pos
- tf
->buffer
.head
;
2269 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
2273 g_assert(tf
->event
.offset
< tf
->buf_size
- tf
->buffer
.lost_size
);
2279 g_error("Error in ltt_seek_next_event for tracefile %s",
2280 g_quark_to_string(tf
->name
));
2285 /*****************************************************************************
2287 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
2289 * 1.0 / (freq(khz) *1000) * 1000000000
2292 ****************************************************************************/
2293 /* from timer_tsc.c */
2294 #define CYC2NS_SCALE_FACTOR 10
2295 static guint32
calc_nsecs_per_cycle(LttTracefile
* tf
)
2297 //return 1e6 / (double)tf->buffer.freq;
2298 guint32 cpu_mhz
= tf
->buffer
.freq
/ 1000;
2299 guint32 cyc2ns_scale
= (1000 << CYC2NS_SCALE_FACTOR
)/cpu_mhz
;
2301 return cyc2ns_scale
;
2302 // return 1e6 / (double)tf->buffer.freq;
2305 static guint64
cycles_2_ns(LttTracefile
*tf
, guint64 cycles
)
2307 return (cycles
* tf
->buffer
.cyc2ns_scale
) >> CYC2NS_SCALE_FACTOR
;
2312 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
2314 LttField
* rootFld
= evT
->root_field
;
2315 // rootFld->base_address = evD;
2318 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
2319 evT
, 0,0,rootFld
, evD
);
2323 /*****************************************************************************
2325 * set_fields_offsets : set the precomputable offset of the fields
2327 * tracefile : opened trace file
2328 * event_type : the event type
2329 ****************************************************************************/
2331 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
2333 LttField
*field
= event_type
->root_field
;
2334 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
2337 preset_field_type_size(tf
, event_type
, 0, 0,
2338 &fixed_root
, &fixed_parent
,
2345 /*****************************************************************************
2347 * get_alignment : Get the alignment needed for a field.
2351 * returns : The size on which it must be aligned.
2353 ****************************************************************************/
2354 off_t
get_alignment(LttField
*field
)
2356 LttType
*type
= &field
->field_type
;
2358 switch(type
->type_class
) {
2360 case LTT_UINT_FIXED
:
2375 /* Align offset on type size */
2376 g_assert(field
->field_size
!= 0);
2377 return field
->field_size
;
2383 g_assert(type
->fields
->len
== 1);
2385 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
2386 return get_alignment(child
);
2390 g_assert(type
->fields
->len
== 2);
2393 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
2395 localign
= max(localign
, get_alignment(child
));
2397 child
= &g_array_index(type
->fields
, LttField
, 1);
2398 localign
= max(localign
, get_alignment(child
));
2409 for(i
=0; i
<type
->fields
->len
; i
++) {
2410 LttField
*child
= &g_array_index(type
->fields
, LttField
, i
);
2411 localign
= max(localign
, get_alignment(child
));
2418 g_error("get_alignment : unknown type");
2423 /*****************************************************************************
2425 * field_compute_static_size : Determine the size of fields known by their
2426 * sole definition. Unions, arrays and struct sizes might be known, but
2427 * the parser does not give that information.
2432 ****************************************************************************/
2434 void field_compute_static_size(LttFacility
*fac
, LttField
*field
)
2436 LttType
*type
= &field
->field_type
;
2438 switch(type
->type_class
) {
2440 case LTT_UINT_FIXED
:
2459 /* note this : array type size is the number of elements in the array,
2460 * while array field size of the length of the array in bytes */
2461 g_assert(type
->fields
->len
== 1);
2463 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
2464 field_compute_static_size(fac
, child
);
2466 if(child
->field_size
!= 0) {
2467 field
->field_size
= type
->size
* child
->field_size
;
2468 field
->dynamic_offsets
= g_array_sized_new(FALSE
, TRUE
,
2469 sizeof(off_t
), type
->size
);
2471 field
->field_size
= 0;
2476 g_assert(type
->fields
->len
== 2);
2478 off_t local_offset
= 0;
2479 LttField
*child
= &g_array_index(type
->fields
, LttField
, 1);
2480 field_compute_static_size(fac
, child
);
2481 field
->field_size
= 0;
2483 if(child
->field_size
!= 0) {
2484 field
->dynamic_offsets
= g_array_sized_new(FALSE
, TRUE
,
2485 sizeof(off_t
), SEQUENCE_AVG_ELEMENTS
);
2493 for(i
=0;i
<type
->fields
->len
;i
++) {
2494 LttField
*child
= &g_array_index(type
->fields
, LttField
, i
);
2495 field_compute_static_size(fac
, child
);
2496 if(child
->field_size
!= 0) {
2497 type
->size
+= ltt_align(type
->size
, get_alignment(child
),
2499 type
->size
+= child
->field_size
;
2501 /* As soon as we find a child with variable size, we have
2502 * a variable size */
2507 field
->field_size
= type
->size
;
2511 g_error("field_static_size : unknown type");
2518 /*****************************************************************************
2520 * precompute_fields_offsets : set the precomputable offset of the fields
2524 * offset : pointer to the current offset, must be incremented
2526 * return : 1 : found a variable length field, stop the processing.
2528 ****************************************************************************/
2531 gint
precompute_fields_offsets(LttFacility
*fac
, LttField
*field
, off_t
*offset
, gint is_compact
)
2533 LttType
*type
= &field
->field_type
;
2535 if(unlikely(is_compact
)) {
2536 g_assert(field
->field_size
!= 0);
2537 /* FIXME THIS IS A HUUUUUGE hack :
2538 * offset is between the compact_data field in struct LttEvent
2539 * and the address of the field root in the memory map.
2540 * ark. Both will stay at the same addresses while the event
2541 * is readable, so it's ok.
2543 field
->offset_root
= 0;
2544 field
->fixed_root
= FIELD_FIXED
;
2548 switch(type
->type_class
) {
2550 case LTT_UINT_FIXED
:
2565 g_assert(field
->field_size
!= 0);
2566 /* Align offset on type size */
2567 *offset
+= ltt_align(*offset
, get_alignment(field
),
2569 /* remember offset */
2570 field
->offset_root
= *offset
;
2571 field
->fixed_root
= FIELD_FIXED
;
2572 /* Increment offset */
2573 *offset
+= field
->field_size
;
2577 field
->offset_root
= *offset
;
2578 field
->fixed_root
= FIELD_FIXED
;
2582 g_assert(type
->fields
->len
== 1);
2584 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
2586 *offset
+= ltt_align(*offset
, get_alignment(field
),
2589 /* remember offset */
2590 field
->offset_root
= *offset
;
2591 field
->array_offset
= *offset
;
2592 field
->fixed_root
= FIELD_FIXED
;
2594 /* Let the child be variable */
2595 //precompute_fields_offsets(tf, child, offset);
2597 if(field
->field_size
!= 0) {
2598 /* Increment offset */
2599 /* field_size is the array size in bytes */
2600 *offset
+= field
->field_size
;
2608 g_assert(type
->fields
->len
== 2);
2613 *offset
+= ltt_align(*offset
, get_alignment(field
),
2616 /* remember offset */
2617 field
->offset_root
= *offset
;
2618 field
->fixed_root
= FIELD_FIXED
;
2620 child
= &g_array_index(type
->fields
, LttField
, 0);
2621 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
2622 g_assert(ret
== 0); /* Seq len cannot have variable len */
2624 child
= &g_array_index(type
->fields
, LttField
, 1);
2625 *offset
+= ltt_align(*offset
, get_alignment(child
),
2627 field
->array_offset
= *offset
;
2628 /* Let the child be variable. */
2629 //ret = precompute_fields_offsets(fac, child, offset);
2631 /* Cannot precompute fields offsets of sequence members, and has
2632 * variable length. */
2642 *offset
+= ltt_align(*offset
, get_alignment(field
),
2644 /* remember offset */
2645 field
->offset_root
= *offset
;
2646 field
->fixed_root
= FIELD_FIXED
;
2648 for(i
=0; i
< type
->fields
->len
; i
++) {
2649 child
= &g_array_index(type
->fields
, LttField
, i
);
2650 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
2663 *offset
+= ltt_align(*offset
, get_alignment(field
),
2665 /* remember offset */
2666 field
->offset_root
= *offset
;
2667 field
->fixed_root
= FIELD_FIXED
;
2669 for(i
=0; i
< type
->fields
->len
; i
++) {
2670 *offset
= field
->offset_root
;
2671 child
= &g_array_index(type
->fields
, LttField
, i
);
2672 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
2676 *offset
= field
->offset_root
+ field
->field_size
;
2683 g_error("precompute_fields_offsets : unknown type");
2690 /*****************************************************************************
2692 * precompute_offsets : set the precomputable offset of an event type
2695 * event : event type
2697 ****************************************************************************/
2698 void precompute_offsets(LttFacility
*fac
, LttEventType
*event
)
2704 /* First, compute the size of fixed size fields. Will determine size for
2705 * arrays, struct and unions, which is not done by the parser */
2706 for(i
=0; i
<event
->fields
->len
; i
++) {
2707 LttField
*field
= &g_array_index(event
->fields
, LttField
, i
);
2708 field_compute_static_size(fac
, field
);
2711 /* Precompute all known offsets */
2712 for(i
=0; i
<event
->fields
->len
; i
++) {
2713 LttField
*field
= &g_array_index(event
->fields
, LttField
, i
);
2714 if(event
->has_compact_data
&& i
== 0)
2715 ret
= precompute_fields_offsets(fac
, field
, &offset
, 1);
2717 ret
= precompute_fields_offsets(fac
, field
, &offset
, 0);
2725 /*****************************************************************************
2727 * preset_field_type_size : set the fixed sizes of the field type
2730 * event_type : event type
2731 * offset_root : offset from the root
2732 * offset_parent : offset from the parent
2733 * fixed_root : Do we know a fixed offset to the root ?
2734 * fixed_parent : Do we know a fixed offset to the parent ?
2736 ****************************************************************************/
2740 // preset the fixed size offsets. Calculate them just like genevent-new : an
2741 // increment of a *to value that represents the offset from the start of the
2743 // The preset information is : offsets up to (and including) the first element
2744 // of variable size. All subsequent fields must be flagged "VARIABLE OFFSET".
2746 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
2747 off_t offset_root
, off_t offset_parent
,
2748 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
2751 enum field_status local_fixed_root
, local_fixed_parent
;
2755 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
2756 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
2757 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
2759 type
= field
->field_type
;
2761 field
->fixed_root
= *fixed_root
;
2762 if(field
->fixed_root
== FIELD_FIXED
)
2763 field
->offset_root
= offset_root
;
2765 field
->offset_root
= 0;
2767 field
->fixed_parent
= *fixed_parent
;
2768 if(field
->fixed_parent
== FIELD_FIXED
)
2769 field
->offset_parent
= offset_parent
;
2771 field
->offset_parent
= 0;
2773 size_t current_root_offset
;
2774 size_t current_offset
;
2775 enum field_status current_child_status
, final_child_status
;
2778 switch(type
->type_class
) {
2780 case LTT_UINT_FIXED
:
2789 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2790 field
->fixed_size
= FIELD_FIXED
;
2793 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2794 field
->fixed_size
= FIELD_FIXED
;
2798 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2799 field
->fixed_size
= FIELD_FIXED
;
2804 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2805 field
->fixed_size
= FIELD_FIXED
;
2808 local_fixed_root
= FIELD_VARIABLE
;
2809 local_fixed_parent
= FIELD_VARIABLE
;
2810 preset_field_type_size(tf
, event_type
,
2812 &local_fixed_root
, &local_fixed_parent
,
2814 field
->fixed_size
= FIELD_VARIABLE
;
2815 field
->field_size
= 0;
2816 *fixed_root
= FIELD_VARIABLE
;
2817 *fixed_parent
= FIELD_VARIABLE
;
2820 field
->fixed_size
= FIELD_VARIABLE
;
2821 field
->field_size
= 0;
2822 *fixed_root
= FIELD_VARIABLE
;
2823 *fixed_parent
= FIELD_VARIABLE
;
2826 local_fixed_root
= FIELD_VARIABLE
;
2827 local_fixed_parent
= FIELD_VARIABLE
;
2828 preset_field_type_size(tf
, event_type
,
2830 &local_fixed_root
, &local_fixed_parent
,
2832 field
->fixed_size
= field
->child
[0]->fixed_size
;
2833 if(field
->fixed_size
== FIELD_FIXED
) {
2834 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2836 field
->field_size
= 0;
2837 *fixed_root
= FIELD_VARIABLE
;
2838 *fixed_parent
= FIELD_VARIABLE
;
2842 current_root_offset
= field
->offset_root
;
2844 current_child_status
= FIELD_FIXED
;
2845 for(i
=0;i
<type
->element_number
;i
++) {
2846 preset_field_type_size(tf
, event_type
,
2847 current_root_offset
, current_offset
,
2848 fixed_root
, ¤t_child_status
,
2850 if(current_child_status
== FIELD_FIXED
) {
2851 current_root_offset
+= field
->child
[i
]->field_size
;
2852 current_offset
+= field
->child
[i
]->field_size
;
2854 current_root_offset
= 0;
2858 if(current_child_status
!= FIELD_FIXED
) {
2859 *fixed_parent
= current_child_status
;
2860 field
->field_size
= 0;
2861 field
->fixed_size
= current_child_status
;
2863 field
->field_size
= current_offset
;
2864 field
->fixed_size
= FIELD_FIXED
;
2868 current_root_offset
= field
->offset_root
;
2871 final_child_status
= FIELD_FIXED
;
2872 for(i
=0;i
<type
->element_number
;i
++) {
2873 enum field_status current_root_child_status
= FIELD_FIXED
;
2874 enum field_status current_child_status
= FIELD_FIXED
;
2875 preset_field_type_size(tf
, event_type
,
2876 current_root_offset
, current_offset
,
2877 ¤t_root_child_status
, ¤t_child_status
,
2879 if(current_child_status
!= FIELD_FIXED
)
2880 final_child_status
= current_child_status
;
2882 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2884 if(final_child_status
!= FIELD_FIXED
) {
2885 g_error("LTTV does not support variable size fields in unions.");
2886 /* This will stop the application. */
2887 *fixed_root
= final_child_status
;
2888 *fixed_parent
= final_child_status
;
2889 field
->field_size
= 0;
2890 field
->fixed_size
= current_child_status
;
2892 field
->field_size
= max_size
;
2893 field
->fixed_size
= FIELD_FIXED
;
2897 g_error("unexpected type NONE");
2904 /*****************************************************************************
2906 * check_fields_compatibility : Check for compatibility between two fields :
2907 * do they use the same inner structure ?
2909 * event_type1 : event type
2910 * event_type2 : event type
2913 *Returns : 0 if identical
2915 ****************************************************************************/
2916 // this function checks for equality of field types. Therefore, it does not use
2917 // per se offsets. For instance, an aligned version of a structure is
2918 // compatible with an unaligned version of the same structure.
2919 gint
check_fields_compatibility(LttEventType
*event_type1
,
2920 LttEventType
*event_type2
,
2921 LttField
*field1
, LttField
*field2
)
2923 guint different
= 0;
2927 if(field1
== NULL
) {
2928 if(field2
== NULL
) goto end
;
2933 } else if(field2
== NULL
) {
2938 type1
= &field1
->field_type
;
2939 type2
= &field2
->field_type
;
2941 if(type1
->type_class
!= type2
->type_class
) {
2945 if(type1
->network
!= type2
->network
) {
2950 switch(type1
->type_class
) {
2952 case LTT_UINT_FIXED
:
2967 if(field1
->field_size
!= field2
->field_size
)
2974 LttField
*child1
= &g_array_index(type1
->fields
, LttField
, 0);
2975 LttField
*child2
= &g_array_index(type2
->fields
, LttField
, 0);
2977 if(type1
->size
!= type2
->size
)
2979 if(check_fields_compatibility(event_type1
, event_type2
, child1
, child2
))
2985 LttField
*child1
= &g_array_index(type1
->fields
, LttField
, 1);
2986 LttField
*child2
= &g_array_index(type2
->fields
, LttField
, 1);
2988 if(check_fields_compatibility(event_type1
, event_type2
, child1
, child2
))
2998 if(type1
->fields
->len
!= type2
->fields
->len
) {
3003 for(i
=0; i
< type1
->fields
->len
; i
++) {
3006 child1
= &g_array_index(type1
->fields
, LttField
, i
);
3007 child2
= &g_array_index(type2
->fields
, LttField
, i
);
3008 different
= check_fields_compatibility(event_type1
,
3009 event_type2
, child1
, child2
);
3011 if(different
) break;
3017 g_error("check_fields_compatibility : unknown type");
3026 gint
check_fields_compatibility(LttEventType
*event_type1
,
3027 LttEventType
*event_type2
,
3028 LttField
*field1
, LttField
*field2
)
3030 guint different
= 0;
3035 if(field1
== NULL
) {
3036 if(field2
== NULL
) goto end
;
3041 } else if(field2
== NULL
) {
3046 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
3047 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
3048 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
3049 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
3050 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
3051 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
3053 type1
= field1
->field_type
;
3054 type2
= field2
->field_type
;
3056 if(type1
->type_class
!= type2
->type_class
) {
3060 if(type1
->element_name
!= type2
->element_name
) {
3065 switch(type1
->type_class
) {
3067 case LTT_UINT_FIXED
:
3082 if(field1
->field_size
!= field2
->field_size
) {
3088 if(type1
->element_number
!= type2
->element_number
) {
3092 for(i
=0;i
<type1
->element_number
;i
++) {
3093 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
3100 /* Two elements : size and child */
3101 g_assert(type1
->element_number
!= type2
->element_number
);
3102 for(i
=0;i
<type1
->element_number
;i
++) {
3103 if(check_fields_compatibility(event_type1
, event_type2
,
3104 field1
->child
[0], field2
->child
[0])) {
3113 if(field1
->field_size
!= field2
->field_size
) {
3117 /* Two elements : size and child */
3118 g_assert(type1
->element_number
!= type2
->element_number
);
3119 for(i
=0;i
<type1
->element_number
;i
++) {
3120 if(check_fields_compatibility(event_type1
, event_type2
,
3121 field1
->child
[0], field2
->child
[0])) {
3129 if(type1
->element_number
!= type2
->element_number
) {
3133 for(i
=0;i
<type1
->element_number
;i
++) {
3134 if(check_fields_compatibility(event_type1
, event_type2
,
3135 field1
->child
[0], field2
->child
[0])) {
3148 /*****************************************************************************
3150 * ltt_get_int : get an integer number
3152 * reverse_byte_order: must we reverse the byte order ?
3153 * size : the size of the integer
3154 * ptr : the data pointer
3156 * gint64 : a 64 bits integer
3157 ****************************************************************************/
3159 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
3164 case 1: val
= *((gint8
*)data
); break;
3165 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
3166 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
3167 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
3168 default: val
= ltt_get_int64(reverse_byte_order
, data
);
3169 g_critical("get_int : integer size %d unknown", size
);
3176 /*****************************************************************************
3178 * ltt_get_uint : get an unsigned integer number
3180 * reverse_byte_order: must we reverse the byte order ?
3181 * size : the size of the integer
3182 * ptr : the data pointer
3184 * guint64 : a 64 bits unsigned integer
3185 ****************************************************************************/
3187 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
3192 case 1: val
= *((gint8
*)data
); break;
3193 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
3194 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
3195 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
3196 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
3197 g_critical("get_uint : unsigned integer size %d unknown",
3206 /* get the node name of the system */
3208 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
3210 return s
->node_name
;
3214 /* get the domain name of the system */
3216 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
3218 return s
->domain_name
;
3222 /* get the description of the system */
3224 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
3226 return s
->description
;
3230 /* get the NTP corrected start time of the trace */
3231 LttTime
ltt_trace_start_time(LttTrace
*t
)
3233 return t
->start_time
;
3236 /* get the monotonic start time of the trace */
3237 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
)
3239 return t
->start_time_from_tsc
;
3242 LttTracefile
*ltt_tracefile_new()
3244 return g_new(LttTracefile
, 1);
3247 void ltt_tracefile_destroy(LttTracefile
*tf
)
3252 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
3257 /* Before library loading... */
3259 static void __attribute__((constructor
)) init(void)
3261 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
3262 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
3263 LTT_EVENT_NAME_HEARTBEAT_FULL
= g_quark_from_string("heartbeat_full");
3265 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");