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>
45 #include "ltt-private.h"
46 #include <ltt/trace.h>
47 #include <ltt/event.h>
48 #include <ltt/ltt-types.h>
49 #include <ltt/marker.h>
51 /* Tracefile names used in this file */
53 GQuark LTT_TRACEFILE_NAME_METADATA
;
60 #define __UNUSED__ __attribute__((__unused__))
62 #define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
65 #define g_debug(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format)
70 /* Those macros must be called from within a function where page_size is a known
72 #define PAGE_MASK (~(page_size-1))
73 #define PAGE_ALIGN(addr) (((addr)+page_size-1)&PAGE_MASK)
75 LttTrace
*father_trace
= NULL
;
77 /* set the offset of the fields belonging to the event,
78 need the information of the archecture */
79 //void set_fields_offsets(LttTracefile *tf, LttEventType *event_type);
80 //size_t get_fields_offsets(LttTracefile *tf, LttEventType *event_type, void *data);
83 /* get the size of the field type according to
84 * The facility size information. */
85 static inline void preset_field_type_size(LttTracefile
*tf
,
86 LttEventType
*event_type
,
87 off_t offset_root
, off_t offset_parent
,
88 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
92 /* map a fixed size or a block information from the file (fd) */
93 static gint
map_block(LttTracefile
* tf
, guint block_num
);
95 /* calculate nsec per cycles for current block */
97 static guint32
calc_nsecs_per_cycle(LttTracefile
* t
);
98 static guint64
cycles_2_ns(LttTracefile
*tf
, guint64 cycles
);
101 /* go to the next event */
102 static int ltt_seek_next_event(LttTracefile
*tf
);
104 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
105 gchar
*relative_path
);
106 static int ltt_process_metadata_tracefile(LttTracefile
*tf
);
107 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
108 LttTime
*start
, LttTime
*end
);
109 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
);
110 static gint
map_block(LttTracefile
* tf
, guint block_num
);
111 static void ltt_update_event_size(LttTracefile
*tf
);
113 /* Enable event debugging */
114 static int a_event_debug
= 0;
116 void ltt_event_debug(int state
)
118 a_event_debug
= state
;
123 * Return value : 0 success, 1 bad tracefile
125 static int parse_trace_header(ltt_subbuffer_header_t
*header
,
126 LttTracefile
*tf
, LttTrace
*t
)
128 if (header
->magic_number
== LTT_MAGIC_NUMBER
)
130 else if(header
->magic_number
== LTT_REV_MAGIC_NUMBER
)
132 else /* invalid magic number, bad tracefile ! */
136 t
->ltt_major_version
= header
->major_version
;
137 t
->ltt_minor_version
= header
->minor_version
;
138 t
->arch_size
= header
->arch_size
;
140 tf
->alignment
= header
->alignment
;
142 /* Get float byte order : might be different from int byte order
143 * (or is set to 0 if the trace has no float (kernel trace)) */
144 tf
->float_word_order
= 0;
146 switch(header
->major_version
) {
149 g_warning("Unsupported trace version : %hhu.%hhu",
150 header
->major_version
, header
->minor_version
);
154 switch(header
->minor_version
) {
157 struct ltt_subbuffer_header_2_3
*vheader
= header
;
158 tf
->buffer_header_size
= ltt_subbuffer_header_size();
161 tf
->tsc_mask
= ((1ULL << tf
->tscbits
) - 1);
162 tf
->tsc_mask_next_bit
= (1ULL << tf
->tscbits
);
165 t
->start_freq
= ltt_get_uint64(LTT_GET_BO(tf
),
166 &vheader
->start_freq
);
167 t
->freq_scale
= ltt_get_uint32(LTT_GET_BO(tf
),
168 &vheader
->freq_scale
);
170 t
->start_freq
= father_trace
->start_freq
;
171 t
->freq_scale
= father_trace
->freq_scale
;
175 t
->start_tsc
= ltt_get_uint64(LTT_GET_BO(tf
),
176 &vheader
->cycle_count_begin
);
177 t
->start_monotonic
= 0;
178 t
->start_time
.tv_sec
= ltt_get_uint64(LTT_GET_BO(tf
),
179 &vheader
->start_time_sec
);
180 t
->start_time
.tv_nsec
= ltt_get_uint64(LTT_GET_BO(tf
),
181 &vheader
->start_time_usec
);
182 t
->start_time
.tv_nsec
*= 1000; /* microsec to nanosec */
184 t
->start_time_from_tsc
= ltt_time_from_uint64(
186 * 1000000000.0 * tf
->trace
->freq_scale
187 / (double)t
->start_freq
);
192 g_warning("Unsupported trace version : %hhu.%hhu",
193 header
->major_version
, header
->minor_version
);
198 g_warning("Unsupported trace version : %hhu.%hhu",
199 header
->major_version
, header
->minor_version
);
207 /*****************************************************************************
209 * ltt_tracefile_open : open a trace file, construct a LttTracefile
211 * t : the trace containing the tracefile
212 * fileName : path name of the trace file
213 * tf : the tracefile structure
215 * : 0 for success, -1 otherwise.
216 ****************************************************************************/
218 static gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
220 struct stat lTDFStat
; /* Trace data file status */
221 ltt_subbuffer_header_t
*header
;
222 int page_size
= getpagesize();
225 tf
->long_name
= g_quark_from_string(fileName
);
227 tf
->fd
= open(fileName
, O_RDONLY
);
229 g_warning("Unable to open input data file %s\n", fileName
);
233 // Get the file's status
234 if(fstat(tf
->fd
, &lTDFStat
) < 0){
235 g_warning("Unable to get the status of the input data file %s\n", fileName
);
239 // Is the file large enough to contain a trace
240 if(lTDFStat
.st_size
<
241 (off_t
)(ltt_subbuffer_header_size())){
242 g_print("The input data file %s does not contain a trace\n", fileName
);
246 /* Temporarily map the buffer start header to get trace information */
247 /* Multiple of pages aligned head */
248 tf
->buffer
.head
= mmap(0,
249 PAGE_ALIGN(ltt_subbuffer_header_size()), PROT_READ
,
250 MAP_PRIVATE
, tf
->fd
, 0);
251 if(tf
->buffer
.head
== MAP_FAILED
) {
252 perror("Error in allocating memory for buffer of tracefile");
255 g_assert( ( (gulong
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
257 header
= (ltt_subbuffer_header_t
*)tf
->buffer
.head
;
259 if(parse_trace_header(header
, tf
, NULL
)) {
260 g_warning("parse_trace_header error");
264 //store the size of the file
265 tf
->file_size
= lTDFStat
.st_size
;
266 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
267 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
269 tf
->subbuf_corrupt
= 0;
271 if(munmap(tf
->buffer
.head
,
272 PAGE_ALIGN(ltt_subbuffer_header_size()))) {
273 g_warning("unmap size : %u\n",
274 PAGE_ALIGN(ltt_subbuffer_header_size()));
275 perror("munmap error");
278 tf
->buffer
.head
= NULL
;
280 //read the first block
281 if(map_block(tf
,0)) {
282 perror("Cannot map block for tracefile");
290 if(munmap(tf
->buffer
.head
,
291 PAGE_ALIGN(ltt_subbuffer_header_size()))) {
292 g_warning("unmap size : %u\n",
293 PAGE_ALIGN(ltt_subbuffer_header_size()));
294 perror("munmap error");
304 /*****************************************************************************
306 * ltt_tracefile_close: close a trace file,
308 * t : tracefile which will be closed
309 ****************************************************************************/
311 static void ltt_tracefile_close(LttTracefile
*t
)
313 int page_size
= getpagesize();
315 if(t
->buffer
.head
!= NULL
)
316 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
317 g_warning("unmap size : %u\n",
318 PAGE_ALIGN(t
->buf_size
));
319 perror("munmap error");
326 /****************************************************************************
327 * get_absolute_pathname
329 * return the unique pathname in the system
331 * MD : Fixed this function so it uses realpath, dealing well with
332 * forgotten cases (.. were not used correctly before).
334 ****************************************************************************/
335 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
337 abs_pathname
[0] = '\0';
339 if (realpath(pathname
, abs_pathname
) != NULL
)
343 /* error, return the original path unmodified */
344 strcpy(abs_pathname
, pathname
);
350 /* Search for something like : .*_.*
352 * The left side is the name, the right side is the number.
356 static int get_tracefile_name_number(gchar
*raw_name
,
363 guint raw_name_len
= strlen(raw_name
);
364 gchar char_name
[PATH_MAX
];
372 for(i
= 0; i
< raw_name_len
-1;i
++) {
373 if(raw_name
[i
] != '/')
376 raw_name
= &raw_name
[i
];
377 raw_name_len
= strlen(raw_name
);
379 for(i
=raw_name_len
-1;i
>=0;i
--) {
380 if(raw_name
[i
] == '_') break;
382 if(i
==-1) { /* Either not found or name length is 0 */
383 /* This is a userspace tracefile */
384 strncpy(char_name
, raw_name
, raw_name_len
);
385 char_name
[raw_name_len
] = '\0';
386 *name
= g_quark_from_string(char_name
);
387 *num
= 0; /* unknown cpu */
388 for(i
=0;i
<raw_name_len
;i
++) {
389 if(raw_name
[i
] == '/') {
394 for(;i
<raw_name_len
;i
++) {
395 if(raw_name
[i
] == '/') {
400 for(;i
<raw_name_len
;i
++) {
401 if(raw_name
[i
] == '-') {
405 if(i
== raw_name_len
) return -1;
407 tmpptr
= &raw_name
[i
];
408 for(;i
<raw_name_len
;i
++) {
409 if(raw_name
[i
] == '.') {
414 *tid
= strtoul(tmpptr
, &endptr
, 10);
416 return -1; /* No digit */
417 if(*tid
== ULONG_MAX
)
418 return -1; /* underflow / overflow */
420 tmpptr
= &raw_name
[i
];
421 for(;i
<raw_name_len
;i
++) {
422 if(raw_name
[i
] == '.') {
427 *pgid
= strtoul(tmpptr
, &endptr
, 10);
429 return -1; /* No digit */
430 if(*pgid
== ULONG_MAX
)
431 return -1; /* underflow / overflow */
433 tmpptr
= &raw_name
[i
];
434 *creation
= strtoull(tmpptr
, &endptr
, 10);
436 return -1; /* No digit */
437 if(*creation
== G_MAXUINT64
)
438 return -1; /* underflow / overflow */
442 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
444 if(endptr
== raw_name
+underscore_pos
+1)
445 return -1; /* No digit */
446 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
447 return -1; /* underflow / overflow */
449 strncpy(char_name
, raw_name
, underscore_pos
);
450 char_name
[underscore_pos
] = '\0';
452 *name
= g_quark_from_string(char_name
);
461 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
463 return &trace
->tracefiles
;
467 void compute_tracefile_group(GQuark key_id
,
469 struct compute_tracefile_group_args
*args
)
474 for(i
=0; i
<group
->len
; i
++) {
475 tf
= &g_array_index (group
, LttTracefile
, i
);
477 args
->func(tf
, args
->func_args
);
482 static void ltt_tracefile_group_destroy(gpointer data
)
484 GArray
*group
= (GArray
*)data
;
489 destroy_marker_data(g_array_index (group
, LttTracefile
, 0).mdata
);
490 for(i
=0; i
<group
->len
; i
++) {
491 tf
= &g_array_index (group
, LttTracefile
, i
);
493 ltt_tracefile_close(tf
);
495 g_array_free(group
, TRUE
);
498 static gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
500 GArray
*group
= (GArray
*)data
;
504 for(i
=0; i
<group
->len
; i
++) {
505 tf
= &g_array_index (group
, LttTracefile
, i
);
513 /* Open each tracefile under a specific directory. Put them in a
514 * GData : permits to access them using their tracefile group pathname.
515 * i.e. access control/modules tracefile group by index :
518 * relative path is the path relative to the trace root
519 * root path is the full path
521 * A tracefile group is simply an array where all the per cpu tracefiles sit.
524 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
, gchar
*relative_path
)
526 DIR *dir
= opendir(root_path
);
527 struct dirent
*entry
;
528 struct stat stat_buf
;
530 struct marker_data
*mdata
;
532 gchar path
[PATH_MAX
];
537 gchar rel_path
[PATH_MAX
];
546 strncpy(path
, root_path
, PATH_MAX
-1);
547 path_len
= strlen(path
);
548 path
[path_len
] = '/';
550 path_ptr
= path
+ path_len
;
552 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
553 rel_path_len
= strlen(rel_path
);
554 rel_path
[rel_path_len
] = '/';
556 rel_path_ptr
= rel_path
+ rel_path_len
;
558 while((entry
= readdir(dir
)) != NULL
) {
560 if(entry
->d_name
[0] == '.') continue;
562 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
563 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
565 ret
= stat(path
, &stat_buf
);
571 g_debug("Tracefile file or directory : %s\n", path
);
573 // if(strcmp(rel_path, "/eventdefs") == 0) continue;
575 if(S_ISDIR(stat_buf
.st_mode
)) {
577 g_debug("Entering subdirectory...\n");
578 ret
= open_tracefiles(trace
, path
, rel_path
);
579 if(ret
< 0) continue;
580 } else if(S_ISREG(stat_buf
.st_mode
)) {
589 if(get_tracefile_name_number(rel_path
, &name
, &num
, &tid
, &pgid
, &creation
))
590 continue; /* invalid name */
592 g_debug("Opening file.\n");
593 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
594 g_info("Error opening tracefile %s", path
);
596 continue; /* error opening the tracefile : bad magic number ? */
599 g_debug("Tracefile name is %s and number is %u",
600 g_quark_to_string(name
), num
);
603 tmp_tf
.cpu_online
= 1;
604 tmp_tf
.cpu_num
= num
;
608 tmp_tf
.creation
= creation
;
609 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
611 /* Elements are automatically cleared when the array is allocated.
612 * It makes the cpu_online variable set to 0 : cpu offline, by default.
614 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
615 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
616 group
, ltt_tracefile_group_destroy
);
617 mdata
= allocate_marker_data();
619 g_error("Error in allocating marker data");
622 /* Add the per cpu tracefile to the named group */
623 unsigned int old_len
= group
->len
;
625 group
= g_array_set_size(group
, num
+1);
627 g_assert(group
->len
> 0);
629 mdata
= g_array_index (group
, LttTracefile
, 0).mdata
;
631 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
632 g_array_index (group
, LttTracefile
, num
).event
.tracefile
=
633 &g_array_index (group
, LttTracefile
, num
);
634 for (i
= 0; i
< group
->len
; i
++)
635 g_array_index (group
, LttTracefile
, i
).mdata
= mdata
;
645 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
646 * because it must be done just after the opening */
647 static int ltt_process_metadata_tracefile(LttTracefile
*tf
)
653 err
= ltt_tracefile_read_seek(tf
);
654 if(err
== EPERM
) goto seek_error
;
655 else if(err
== ERANGE
) break; /* End of tracefile */
657 err
= ltt_tracefile_read_update_event(tf
);
658 if(err
) goto update_error
;
661 * It contains only core events :
663 * 1 : set_marker_format
665 if(tf
->event
.event_id
>= MARKER_CORE_IDS
) {
666 /* Should only contain core events */
667 g_warning("Error in processing metadata file %s, "
668 "should not contain event id %u.", g_quark_to_string(tf
->name
),
674 const char *channel_name
, *marker_name
, *format
;
676 guint8 int_size
, long_size
, pointer_size
, size_t_size
, alignment
;
678 switch((enum marker_id
)tf
->event
.event_id
) {
679 case MARKER_ID_SET_MARKER_ID
:
680 channel_name
= pos
= tf
->event
.data
;
681 pos
+= strlen(channel_name
) + 1;
683 g_debug("Doing MARKER_ID_SET_MARKER_ID of marker %s.%s",
684 channel_name
, marker_name
);
685 pos
+= strlen(marker_name
) + 1;
686 pos
+= ltt_align((size_t)pos
, sizeof(guint16
), tf
->alignment
);
687 id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
688 g_debug("In MARKER_ID_SET_MARKER_ID of marker %s.%s id %hu",
689 channel_name
, marker_name
, id
);
690 pos
+= sizeof(guint16
);
691 int_size
= *(guint8
*)pos
;
692 pos
+= sizeof(guint8
);
693 long_size
= *(guint8
*)pos
;
694 pos
+= sizeof(guint8
);
695 pointer_size
= *(guint8
*)pos
;
696 pos
+= sizeof(guint8
);
697 size_t_size
= *(guint8
*)pos
;
698 pos
+= sizeof(guint8
);
699 alignment
= *(guint8
*)pos
;
700 pos
+= sizeof(guint8
);
701 marker_id_event(tf
->trace
,
702 g_quark_from_string(channel_name
),
703 g_quark_from_string(marker_name
),
704 id
, int_size
, long_size
,
705 pointer_size
, size_t_size
, alignment
);
707 case MARKER_ID_SET_MARKER_FORMAT
:
708 channel_name
= pos
= tf
->event
.data
;
709 pos
+= strlen(channel_name
) + 1;
711 g_debug("Doing MARKER_ID_SET_MARKER_FORMAT of marker %s.%s",
712 channel_name
, marker_name
);
713 pos
+= strlen(marker_name
) + 1;
715 pos
+= strlen(format
) + 1;
716 marker_format_event(tf
->trace
,
717 g_quark_from_string(channel_name
),
718 g_quark_from_string(marker_name
),
720 /* get information from dictionary TODO */
723 g_warning("Error in processing metadata file %s, "
724 "unknown event id %hhu.",
725 g_quark_to_string(tf
->name
),
738 g_warning("An error occured in metadata tracefile parsing");
743 * Open a trace and return its LttTrace handle.
745 * pathname must be the directory of the trace
748 LttTrace
*ltt_trace_open(const gchar
*pathname
)
750 gchar abs_path
[PATH_MAX
];
755 ltt_subbuffer_header_t
*header
;
757 struct dirent
*entry
;
758 struct stat stat_buf
;
759 gchar path
[PATH_MAX
];
761 t
= g_new(LttTrace
, 1);
762 if(!t
) goto alloc_error
;
764 get_absolute_pathname(pathname
, abs_path
);
765 t
->pathname
= g_quark_from_string(abs_path
);
767 g_datalist_init(&t
->tracefiles
);
769 /* Test to see if it looks like a trace */
770 dir
= opendir(abs_path
);
775 while((entry
= readdir(dir
)) != NULL
) {
776 strcpy(path
, abs_path
);
778 strcat(path
, entry
->d_name
);
779 ret
= stat(path
, &stat_buf
);
787 /* Open all the tracefiles */
788 if(open_tracefiles(t
, abs_path
, "")) {
789 g_warning("Error opening tracefile %s", abs_path
);
793 /* Parse each trace metadata_N files : get runtime fac. info */
794 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_METADATA
);
796 g_error("Trace %s has no metadata tracefile", abs_path
);
802 * Get the trace information for the metadata_0 tracefile.
803 * Getting a correct trace start_time and start_tsc is insured by the fact
804 * that no subbuffers are supposed to be lost in the metadata channel.
805 * Therefore, the first subbuffer contains the start_tsc timestamp in its
808 g_assert(group
->len
> 0);
809 tf
= &g_array_index (group
, LttTracefile
, 0);
810 header
= (ltt_subbuffer_header_t
*)tf
->buffer
.head
;
811 ret
= parse_trace_header(header
, tf
, t
);
814 t
->num_cpu
= group
->len
;
816 //ret = allocate_marker_data(t);
818 // g_error("Error in allocating marker data");
820 for(i
=0; i
<group
->len
; i
++) {
821 tf
= &g_array_index (group
, LttTracefile
, i
);
823 if(ltt_process_metadata_tracefile(tf
))
825 // goto metadata_error;
832 // destroy_marker_data(t);
834 g_datalist_clear(&t
->tracefiles
);
842 /* Open another, completely independant, instance of a trace.
844 * A read on this new instance will read the first event of the trace.
846 * When we copy a trace, we want all the opening actions to happen again :
847 * the trace will be reopened and totally independant from the original.
848 * That's why we call ltt_trace_open.
850 LttTrace
*ltt_trace_copy(LttTrace
*self
)
852 return ltt_trace_open(g_quark_to_string(self
->pathname
));
859 void ltt_trace_close(LttTrace
*t
)
861 g_datalist_clear(&t
->tracefiles
);
866 /*****************************************************************************
867 * Get the start time and end time of the trace
868 ****************************************************************************/
870 void ltt_tracefile_time_span_get(LttTracefile
*tf
,
871 LttTime
*start
, LttTime
*end
)
875 err
= map_block(tf
, 0);
877 g_error("Can not map block");
878 *start
= ltt_time_infinite
;
880 *start
= tf
->buffer
.begin
.timestamp
;
882 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
884 g_error("Can not map block");
885 *end
= ltt_time_zero
;
887 *end
= tf
->buffer
.end
.timestamp
;
890 struct tracefile_time_span_get_args
{
896 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
898 struct tracefile_time_span_get_args
*args
=
899 (struct tracefile_time_span_get_args
*)user_data
;
901 GArray
*group
= (GArray
*)data
;
907 for(i
=0; i
<group
->len
; i
++) {
908 tf
= &g_array_index (group
, LttTracefile
, i
);
910 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
911 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
912 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
917 /* return the start and end time of a trace */
919 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
921 LttTime min_start
= ltt_time_infinite
;
922 LttTime max_end
= ltt_time_zero
;
923 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
925 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
927 if(start
!= NULL
) *start
= min_start
;
928 if(end
!= NULL
) *end
= max_end
;
933 /* Seek to the first event in a tracefile that has a time equal or greater than
934 * the time passed in parameter.
936 * If the time parameter is outside the tracefile time span, seek to the first
937 * event or if after, return ERANGE.
939 * If the time parameter is before the first event, we have to seek specially to
942 * If the time is after the end of the trace, return ERANGE.
944 * Do a binary search to find the right block, then a sequential search in the
945 * block to find the event.
947 * In the special case where the time requested fits inside a block that has no
948 * event corresponding to the requested time, the first event of the next block
951 * IMPORTANT NOTE : // FIXME everywhere...
953 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
954 * you will jump over an event if you do.
956 * Return value : 0 : no error, the tf->event can be used
957 * ERANGE : time if after the last event of the trace
958 * otherwise : this is an error.
962 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
966 unsigned int block_num
, high
, low
;
968 /* seek at the beginning of trace */
969 err
= map_block(tf
, 0); /* First block */
971 g_error("Can not map block");
975 /* If the time is lower or equal the beginning of the trace,
976 * go to the first event. */
977 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
978 ret
= ltt_tracefile_read(tf
);
979 if(ret
== ERANGE
) goto range
;
980 else if (ret
) goto fail
;
981 goto found
; /* There is either no event in the trace or the event points
982 to the first event in the trace */
985 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
987 g_error("Can not map block");
991 /* If the time is after the end of the trace, return ERANGE. */
992 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
996 /* Binary search the block */
997 high
= tf
->num_blocks
- 1;
1001 block_num
= ((high
-low
) / 2) + low
;
1003 err
= map_block(tf
, block_num
);
1005 g_error("Can not map block");
1009 /* We cannot divide anymore : this is what would happen if the time
1010 * requested was exactly between two consecutive buffers'end and start
1011 * timestamps. This is also what would happend if we didn't deal with out
1012 * of span cases prior in this function. */
1013 /* The event is right in the buffer!
1014 * (or in the next buffer first event) */
1016 ret
= ltt_tracefile_read(tf
);
1017 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1018 else if(ret
) goto fail
;
1020 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1024 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1025 /* go to lower part */
1026 high
= block_num
- 1;
1027 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1028 /* go to higher part */
1029 low
= block_num
+ 1;
1030 } else {/* The event is right in the buffer!
1031 (or in the next buffer first event) */
1033 ret
= ltt_tracefile_read(tf
);
1034 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1035 else if(ret
) goto fail
;
1037 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1049 /* Error handling */
1051 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1052 g_quark_to_string(tf
->name
));
1056 /* Seek to a position indicated by an LttEventPosition
1059 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
)
1063 if(ep
->tracefile
!= tf
) {
1067 err
= map_block(tf
, ep
->block
);
1069 g_error("Can not map block");
1073 tf
->event
.offset
= ep
->offset
;
1075 /* Put back the event real tsc */
1076 tf
->event
.tsc
= ep
->tsc
;
1077 tf
->buffer
.tsc
= ep
->tsc
;
1079 err
= ltt_tracefile_read_update_event(tf
);
1082 /* deactivate this, as it does nothing for now
1083 err = ltt_tracefile_read_op(tf);
1090 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1091 g_quark_to_string(tf
->name
));
1095 /* Given a TSC value, return the LttTime (seconds,nanoseconds) it
1099 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
)
1103 if(tsc
> tf
->trace
->start_tsc
) {
1104 time
= ltt_time_from_uint64(
1105 (double)(tsc
- tf
->trace
->start_tsc
)
1106 * 1000000000.0 * tf
->trace
->freq_scale
1107 / (double)tf
->trace
->start_freq
);
1108 time
= ltt_time_add(tf
->trace
->start_time_from_tsc
, time
);
1110 time
= ltt_time_from_uint64(
1111 (double)(tf
->trace
->start_tsc
- tsc
)
1112 * 1000000000.0 * tf
->trace
->freq_scale
1113 / (double)tf
->trace
->start_freq
);
1114 time
= ltt_time_sub(tf
->trace
->start_time_from_tsc
, time
);
1119 /* Calculate the real event time based on the buffer boundaries */
1120 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1122 return ltt_interpolate_time_from_tsc(tf
, tf
->buffer
.tsc
);
1126 /* Get the current event of the tracefile : valid until the next read */
1127 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1134 /*****************************************************************************
1136 * ltt_tracefile_read : Read the next event in the tracefile
1141 * Returns 0 if an event can be used in tf->event.
1142 * Returns ERANGE on end of trace. The event in tf->event still can be used
1143 * (if the last block was not empty).
1144 * Returns EPERM on error.
1146 * This function does make the tracefile event structure point to the event
1147 * currently pointed to by the tf->event.
1149 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1150 * reinitialize it after an error if you want results to be coherent.
1151 * It would be the case if a end of trace last buffer has no event : the end
1152 * of trace wouldn't be returned, but an error.
1153 * We make the assumption there is at least one event per buffer.
1154 ****************************************************************************/
1156 int ltt_tracefile_read(LttTracefile
*tf
)
1160 err
= ltt_tracefile_read_seek(tf
);
1162 err
= ltt_tracefile_read_update_event(tf
);
1165 /* deactivate this, as it does nothing for now
1166 err = ltt_tracefile_read_op(tf);
1173 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1177 /* Get next buffer until we finally have an event, or end of trace */
1179 err
= ltt_seek_next_event(tf
);
1180 if(unlikely(err
== ENOPROTOOPT
)) {
1184 /* Are we at the end of the buffer ? */
1186 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1189 /* get next block */
1190 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1192 g_error("Can not map block");
1196 } else break; /* We found an event ! */
1202 /* do an operation when reading a new event */
1204 /* This function does nothing for now */
1206 int ltt_tracefile_read_op(LttTracefile
*tf
)
1212 /* do event specific operation */
1220 static void print_debug_event_header(LttEvent
*ev
, void *start_pos
, void *end_pos
)
1222 unsigned int offset
= 0;
1225 g_printf("Event header (tracefile %s offset %llx):\n",
1226 g_quark_to_string(ev
->tracefile
->long_name
),
1227 ((uint64_t)ev
->tracefile
->buffer
.index
* ev
->tracefile
->buf_size
)
1228 + (long)start_pos
- (long)ev
->tracefile
->buffer
.head
);
1230 while (offset
< (long)end_pos
- (long)start_pos
) {
1231 g_printf("%8lx", (long)start_pos
- (long)ev
->tracefile
->buffer
.head
+ offset
);
1234 for (i
= 0; i
< 4 ; i
++) {
1235 for (j
= 0; j
< 4; j
++) {
1236 if (offset
+ ((i
* 4) + j
) <
1237 (long)end_pos
- (long)start_pos
)
1239 ((char*)start_pos
)[offset
+ ((i
* 4) + j
)]);
1253 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1254 * event specific operation. */
1255 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1262 pos
= tf
->buffer
.head
+ event
->offset
;
1264 /* Read event header */
1266 /* Align the head */
1267 pos
+= ltt_align((size_t)pos
, sizeof(guint32
), tf
->alignment
);
1270 event
->timestamp
= ltt_get_uint32(LTT_GET_BO(tf
), pos
);
1271 event
->event_id
= event
->timestamp
>> tf
->tscbits
;
1272 event
->timestamp
= event
->timestamp
& tf
->tsc_mask
;
1273 pos
+= sizeof(guint32
);
1275 switch (event
->event_id
) {
1276 case 29: /* LTT_RFLAG_ID_SIZE_TSC */
1277 event
->event_id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1278 pos
+= sizeof(guint16
);
1279 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1280 pos
+= sizeof(guint16
);
1281 if (event
->event_size
== 0xFFFF) {
1282 event
->event_size
= ltt_get_uint32(LTT_GET_BO(tf
), pos
);
1283 pos
+= sizeof(guint32
);
1285 pos
+= ltt_align((size_t)pos
, sizeof(guint64
), tf
->alignment
);
1286 tf
->buffer
.tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1287 pos
+= sizeof(guint64
);
1289 case 30: /* LTT_RFLAG_ID_SIZE */
1290 event
->event_id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1291 pos
+= sizeof(guint16
);
1292 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1293 pos
+= sizeof(guint16
);
1294 if (event
->event_size
== 0xFFFF) {
1295 event
->event_size
= ltt_get_uint32(LTT_GET_BO(tf
), pos
);
1296 pos
+= sizeof(guint32
);
1299 case 31: /* LTT_RFLAG_ID */
1300 event
->event_id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1301 pos
+= sizeof(guint16
);
1302 event
->event_size
= G_MAXUINT
;
1305 event
->event_size
= G_MAXUINT
;
1309 if (likely(event
->event_id
!= 29)) {
1310 /* No extended timestamp */
1311 if (event
->timestamp
< (tf
->buffer
.tsc
& tf
->tsc_mask
))
1312 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
& ~tf
->tsc_mask
) /* overflow */
1313 + tf
->tsc_mask_next_bit
)
1314 | (guint64
)event
->timestamp
;
1316 tf
->buffer
.tsc
= (tf
->buffer
.tsc
& ~tf
->tsc_mask
) /* no overflow */
1317 | (guint64
)event
->timestamp
;
1319 event
->tsc
= tf
->buffer
.tsc
;
1321 event
->event_time
= ltt_interpolate_time(tf
, event
);
1324 print_debug_event_header(event
, pos_aligned
, pos
);
1329 * Let ltt_update_event_size update event->data according to the largest
1330 * alignment within the payload.
1331 * Get the data size and update the event fields with the current
1333 ltt_update_event_size(tf
);
1339 /****************************************************************************
1341 * map_block : map a block from the file
1343 * lttdes : ltt trace file
1344 * whichBlock : the block which will be read
1347 * EINVAL : lseek fail
1348 * EIO : can not read from the file
1349 ****************************************************************************/
1351 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1353 int page_size
= getpagesize();
1354 ltt_subbuffer_header_t
*header
;
1356 g_assert(block_num
< tf
->num_blocks
);
1358 if(tf
->buffer
.head
!= NULL
) {
1359 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1360 g_warning("unmap size : %u\n",
1361 PAGE_ALIGN(tf
->buf_size
));
1362 perror("munmap error");
1367 /* Multiple of pages aligned head */
1368 tf
->buffer
.head
= mmap(0,
1369 PAGE_ALIGN(tf
->buf_size
),
1370 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1371 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1373 if(tf
->buffer
.head
== MAP_FAILED
) {
1374 perror("Error in allocating memory for buffer of tracefile");
1378 g_assert( ( (gulong
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1381 tf
->buffer
.index
= block_num
;
1383 header
= (ltt_subbuffer_header_t
*)tf
->buffer
.head
;
1385 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1386 &header
->cycle_count_begin
);
1387 tf
->buffer
.begin
.freq
= tf
->trace
->start_freq
;
1389 tf
->buffer
.begin
.timestamp
= ltt_interpolate_time_from_tsc(tf
,
1390 tf
->buffer
.begin
.cycle_count
);
1391 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1392 &header
->cycle_count_end
);
1393 tf
->buffer
.end
.freq
= tf
->trace
->start_freq
;
1395 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1396 &header
->lost_size
);
1397 tf
->buffer
.end
.timestamp
= ltt_interpolate_time_from_tsc(tf
,
1398 tf
->buffer
.end
.cycle_count
);
1399 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1400 tf
->event
.tsc
= tf
->buffer
.tsc
;
1401 tf
->buffer
.freq
= tf
->buffer
.begin
.freq
;
1404 * eventually support variable buffer size : will need a partial pre-read of
1405 * the headers to create an index when we open the trace... eventually. */
1406 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1407 &header
->buf_size
));
1409 /* Make the current event point to the beginning of the buffer :
1410 * it means that the event read must get the first event. */
1411 tf
->event
.tracefile
= tf
;
1412 tf
->event
.block
= block_num
;
1413 tf
->event
.offset
= 0;
1415 if (header
->events_lost
) {
1416 g_warning("%d events lost so far in tracefile %s at block %u",
1417 (guint
)header
->events_lost
,
1418 g_quark_to_string(tf
->long_name
),
1420 tf
->events_lost
= header
->events_lost
;
1422 if (header
->subbuf_corrupt
) {
1423 g_warning("%d subbuffer(s) corrupted so far in tracefile %s at block %u",
1424 (guint
)header
->subbuf_corrupt
,
1425 g_quark_to_string(tf
->long_name
),
1427 tf
->subbuf_corrupt
= header
->subbuf_corrupt
;
1436 static void print_debug_event_data(LttEvent
*ev
)
1438 unsigned int offset
= 0;
1441 if (!max(ev
->event_size
, ev
->data_size
))
1444 g_printf("Event data (tracefile %s offset %llx):\n",
1445 g_quark_to_string(ev
->tracefile
->long_name
),
1446 ((uint64_t)ev
->tracefile
->buffer
.index
* ev
->tracefile
->buf_size
)
1447 + (long)ev
->data
- (long)ev
->tracefile
->buffer
.head
);
1449 while (offset
< max(ev
->event_size
, ev
->data_size
)) {
1450 g_printf("%8lx", (long)ev
->data
+ offset
1451 - (long)ev
->tracefile
->buffer
.head
);
1454 for (i
= 0; i
< 4 ; i
++) {
1455 for (j
= 0; j
< 4; j
++) {
1456 if (offset
+ ((i
* 4) + j
) < max(ev
->event_size
, ev
->data_size
))
1457 g_printf("%02hhX", ((char*)ev
->data
)[offset
+ ((i
* 4) + j
)]);
1468 for (i
= 0; i
< 4; i
++) {
1469 for (j
= 0; j
< 4; j
++) {
1470 if (offset
+ ((i
* 4) + j
) < max(ev
->event_size
, ev
->data_size
)) {
1471 if (isprint(((char*)ev
->data
)[offset
+ ((i
* 4) + j
)]))
1472 g_printf("%c", ((char*)ev
->data
)[offset
+ ((i
* 4) + j
)]);
1484 /* It will update the fields offsets too */
1485 void ltt_update_event_size(LttTracefile
*tf
)
1489 struct marker_info
*info
;
1491 if (tf
->name
== LTT_TRACEFILE_NAME_METADATA
) {
1492 switch((enum marker_id
)tf
->event
.event_id
) {
1493 case MARKER_ID_SET_MARKER_ID
:
1494 size
= strlen((char*)tf
->event
.data
) + 1;
1495 g_debug("marker %s id set", (char*)tf
->event
.data
+ size
);
1496 size
+= strlen((char*)tf
->event
.data
+ size
) + 1;
1497 size
+= ltt_align(size
, sizeof(guint16
), tf
->alignment
);
1498 size
+= sizeof(guint16
);
1499 size
+= sizeof(guint8
);
1500 size
+= sizeof(guint8
);
1501 size
+= sizeof(guint8
);
1502 size
+= sizeof(guint8
);
1503 size
+= sizeof(guint8
);
1505 case MARKER_ID_SET_MARKER_FORMAT
:
1506 size
= strlen((char*)tf
->event
.data
) + 1;
1507 g_debug("marker %s format set", (char*)tf
->event
.data
);
1508 size
+= strlen((char*)tf
->event
.data
+ size
) + 1;
1509 size
+= strlen((char*)tf
->event
.data
+ size
) + 1;
1514 info
= marker_get_info_from_id(tf
->mdata
, tf
->event
.event_id
);
1516 if (tf
->event
.event_id
>= MARKER_CORE_IDS
)
1517 g_assert(info
!= NULL
);
1519 /* Do not update field offsets of core markers when initially reading the
1520 * metadata tracefile when the infos about these markers do not exist yet.
1522 if (likely(info
&& info
->fields
)) {
1524 tf
->event
.data
+= ltt_align((off_t
)(unsigned long)tf
->event
.data
,
1525 info
->largest_align
,
1527 /* size, dynamically computed */
1528 if (info
->size
!= -1)
1531 size
= marker_update_fields_offsets(marker_get_info_from_id(tf
->mdata
,
1532 tf
->event
.event_id
), tf
->event
.data
);
1535 tf
->event
.data_size
= size
;
1537 /* Check consistency between kernel and LTTV structure sizes */
1538 if(tf
->event
.event_size
== G_MAXUINT
) {
1539 /* Event size too big to fit in the event size field */
1540 tf
->event
.event_size
= tf
->event
.data_size
;
1544 print_debug_event_data(&tf
->event
);
1546 if (tf
->event
.data_size
!= tf
->event
.event_size
) {
1547 struct marker_info
*info
= marker_get_info_from_id(tf
->mdata
,
1548 tf
->event
.event_id
);
1550 g_error("Undescribed event %hhu in channel %s", tf
->event
.event_id
,
1551 g_quark_to_string(tf
->name
));
1552 g_error("Kernel/LTTV event size differs for event %s: kernel %u, LTTV %u",
1553 g_quark_to_string(info
->name
),
1554 tf
->event
.event_size
, tf
->event
.data_size
);
1560 /* Take the tf current event offset and use the event id to figure out where is
1561 * the next event offset.
1563 * This is an internal function not aiming at being used elsewhere : it will
1564 * not jump over the current block limits. Please consider using
1565 * ltt_tracefile_read to do this.
1567 * Returns 0 on success
1568 * ERANGE if we are at the end of the buffer.
1569 * ENOPROTOOPT if an error occured when getting the current event size.
1571 static int ltt_seek_next_event(LttTracefile
*tf
)
1576 /* seek over the buffer header if we are at the buffer start */
1577 if(tf
->event
.offset
== 0) {
1578 tf
->event
.offset
+= tf
->buffer_header_size
;
1580 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1586 pos
= tf
->event
.data
;
1588 if(tf
->event
.data_size
< 0) goto error
;
1590 pos
+= (size_t)tf
->event
.data_size
;
1592 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1594 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1598 g_assert(tf
->event
.offset
< tf
->buf_size
- tf
->buffer
.lost_size
);
1604 g_error("Error in ltt_seek_next_event for tracefile %s",
1605 g_quark_to_string(tf
->name
));
1610 /*****************************************************************************
1612 * set_fields_offsets : set the precomputable offset of the fields
1614 * tracefile : opened trace file
1615 * event_type : the event type
1616 ****************************************************************************/
1618 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1620 LttField
*field
= event_type
->root_field
;
1621 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1624 preset_field_type_size(tf
, event_type
, 0, 0,
1625 &fixed_root
, &fixed_parent
,
1632 /*****************************************************************************
1634 * get_alignment : Get the alignment needed for a field.
1638 * returns : The size on which it must be aligned.
1640 ****************************************************************************/
1642 off_t
get_alignment(LttField
*field
)
1644 LttType
*type
= &field
->field_type
;
1646 switch(type
->type_class
) {
1648 case LTT_UINT_FIXED
:
1663 /* Align offset on type size */
1664 g_assert(field
->field_size
!= 0);
1665 return field
->field_size
;
1671 g_assert(type
->fields
->len
== 1);
1673 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1674 return get_alignment(child
);
1678 g_assert(type
->fields
->len
== 2);
1681 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1683 localign
= max(localign
, get_alignment(child
));
1685 child
= &g_array_index(type
->fields
, LttField
, 1);
1686 localign
= max(localign
, get_alignment(child
));
1697 for(i
=0; i
<type
->fields
->len
; i
++) {
1698 LttField
*child
= &g_array_index(type
->fields
, LttField
, i
);
1699 localign
= max(localign
, get_alignment(child
));
1706 g_error("get_alignment : unknown type");
1713 /*****************************************************************************
1715 * field_compute_static_size : Determine the size of fields known by their
1716 * sole definition. Unions, arrays and struct sizes might be known, but
1717 * the parser does not give that information.
1722 ****************************************************************************/
1724 void field_compute_static_size(LttFacility
*fac
, LttField
*field
)
1726 LttType
*type
= &field
->field_type
;
1728 switch(type
->type_class
) {
1730 case LTT_UINT_FIXED
:
1749 /* note this : array type size is the number of elements in the array,
1750 * while array field size of the length of the array in bytes */
1751 g_assert(type
->fields
->len
== 1);
1753 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1754 field_compute_static_size(fac
, child
);
1756 if(child
->field_size
!= 0) {
1757 field
->field_size
= type
->size
* child
->field_size
;
1758 field
->dynamic_offsets
= g_array_sized_new(FALSE
, TRUE
,
1759 sizeof(off_t
), type
->size
);
1761 field
->field_size
= 0;
1766 g_assert(type
->fields
->len
== 2);
1768 off_t local_offset
= 0;
1769 LttField
*child
= &g_array_index(type
->fields
, LttField
, 1);
1770 field_compute_static_size(fac
, child
);
1771 field
->field_size
= 0;
1773 if(child
->field_size
!= 0) {
1774 field
->dynamic_offsets
= g_array_sized_new(FALSE
, TRUE
,
1775 sizeof(off_t
), SEQUENCE_AVG_ELEMENTS
);
1783 for(i
=0;i
<type
->fields
->len
;i
++) {
1784 LttField
*child
= &g_array_index(type
->fields
, LttField
, i
);
1785 field_compute_static_size(fac
, child
);
1786 if(child
->field_size
!= 0) {
1787 type
->size
+= ltt_align(type
->size
, get_alignment(child
),
1789 type
->size
+= child
->field_size
;
1791 /* As soon as we find a child with variable size, we have
1792 * a variable size */
1797 field
->field_size
= type
->size
;
1801 g_error("field_static_size : unknown type");
1808 /*****************************************************************************
1810 * precompute_fields_offsets : set the precomputable offset of the fields
1814 * offset : pointer to the current offset, must be incremented
1816 * return : 1 : found a variable length field, stop the processing.
1818 ****************************************************************************/
1821 gint
precompute_fields_offsets(LttFacility
*fac
, LttField
*field
, off_t
*offset
, gint is_compact
)
1823 LttType
*type
= &field
->field_type
;
1825 if(unlikely(is_compact
)) {
1826 g_assert(field
->field_size
!= 0);
1827 /* FIXME THIS IS A HUUUUUGE hack :
1828 * offset is between the compact_data field in struct LttEvent
1829 * and the address of the field root in the memory map.
1830 * ark. Both will stay at the same addresses while the event
1831 * is readable, so it's ok.
1833 field
->offset_root
= 0;
1834 field
->fixed_root
= FIELD_FIXED
;
1838 switch(type
->type_class
) {
1840 case LTT_UINT_FIXED
:
1855 g_assert(field
->field_size
!= 0);
1856 /* Align offset on type size */
1857 *offset
+= ltt_align(*offset
, get_alignment(field
),
1859 /* remember offset */
1860 field
->offset_root
= *offset
;
1861 field
->fixed_root
= FIELD_FIXED
;
1862 /* Increment offset */
1863 *offset
+= field
->field_size
;
1867 field
->offset_root
= *offset
;
1868 field
->fixed_root
= FIELD_FIXED
;
1872 g_assert(type
->fields
->len
== 1);
1874 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1876 *offset
+= ltt_align(*offset
, get_alignment(field
),
1879 /* remember offset */
1880 field
->offset_root
= *offset
;
1881 field
->array_offset
= *offset
;
1882 field
->fixed_root
= FIELD_FIXED
;
1884 /* Let the child be variable */
1885 //precompute_fields_offsets(tf, child, offset);
1887 if(field
->field_size
!= 0) {
1888 /* Increment offset */
1889 /* field_size is the array size in bytes */
1890 *offset
+= field
->field_size
;
1898 g_assert(type
->fields
->len
== 2);
1903 *offset
+= ltt_align(*offset
, get_alignment(field
),
1906 /* remember offset */
1907 field
->offset_root
= *offset
;
1908 field
->fixed_root
= FIELD_FIXED
;
1910 child
= &g_array_index(type
->fields
, LttField
, 0);
1911 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
1912 g_assert(ret
== 0); /* Seq len cannot have variable len */
1914 child
= &g_array_index(type
->fields
, LttField
, 1);
1915 *offset
+= ltt_align(*offset
, get_alignment(child
),
1917 field
->array_offset
= *offset
;
1918 /* Let the child be variable. */
1919 //ret = precompute_fields_offsets(fac, child, offset);
1921 /* Cannot precompute fields offsets of sequence members, and has
1922 * variable length. */
1932 *offset
+= ltt_align(*offset
, get_alignment(field
),
1934 /* remember offset */
1935 field
->offset_root
= *offset
;
1936 field
->fixed_root
= FIELD_FIXED
;
1938 for(i
=0; i
< type
->fields
->len
; i
++) {
1939 child
= &g_array_index(type
->fields
, LttField
, i
);
1940 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
1953 *offset
+= ltt_align(*offset
, get_alignment(field
),
1955 /* remember offset */
1956 field
->offset_root
= *offset
;
1957 field
->fixed_root
= FIELD_FIXED
;
1959 for(i
=0; i
< type
->fields
->len
; i
++) {
1960 *offset
= field
->offset_root
;
1961 child
= &g_array_index(type
->fields
, LttField
, i
);
1962 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
1966 *offset
= field
->offset_root
+ field
->field_size
;
1973 g_error("precompute_fields_offsets : unknown type");
1982 /*****************************************************************************
1984 * precompute_offsets : set the precomputable offset of an event type
1987 * event : event type
1989 ****************************************************************************/
1990 void precompute_offsets(LttFacility
*fac
, LttEventType
*event
)
1996 /* First, compute the size of fixed size fields. Will determine size for
1997 * arrays, struct and unions, which is not done by the parser */
1998 for(i
=0; i
<event
->fields
->len
; i
++) {
1999 LttField
*field
= &g_array_index(event
->fields
, LttField
, i
);
2000 field_compute_static_size(fac
, field
);
2003 /* Precompute all known offsets */
2004 for(i
=0; i
<event
->fields
->len
; i
++) {
2005 LttField
*field
= &g_array_index(event
->fields
, LttField
, i
);
2006 if(event
->has_compact_data
&& i
== 0)
2007 ret
= precompute_fields_offsets(fac
, field
, &offset
, 1);
2009 ret
= precompute_fields_offsets(fac
, field
, &offset
, 0);
2017 /*****************************************************************************
2019 * preset_field_type_size : set the fixed sizes of the field type
2022 * event_type : event type
2023 * offset_root : offset from the root
2024 * offset_parent : offset from the parent
2025 * fixed_root : Do we know a fixed offset to the root ?
2026 * fixed_parent : Do we know a fixed offset to the parent ?
2028 ****************************************************************************/
2032 // preset the fixed size offsets. Calculate them just like genevent-new : an
2033 // increment of a *to value that represents the offset from the start of the
2035 // The preset information is : offsets up to (and including) the first element
2036 // of variable size. All subsequent fields must be flagged "VARIABLE OFFSET".
2038 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
2039 off_t offset_root
, off_t offset_parent
,
2040 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
2043 enum field_status local_fixed_root
, local_fixed_parent
;
2047 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
2048 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
2049 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
2051 type
= field
->field_type
;
2053 field
->fixed_root
= *fixed_root
;
2054 if(field
->fixed_root
== FIELD_FIXED
)
2055 field
->offset_root
= offset_root
;
2057 field
->offset_root
= 0;
2059 field
->fixed_parent
= *fixed_parent
;
2060 if(field
->fixed_parent
== FIELD_FIXED
)
2061 field
->offset_parent
= offset_parent
;
2063 field
->offset_parent
= 0;
2065 size_t current_root_offset
;
2066 size_t current_offset
;
2067 enum field_status current_child_status
, final_child_status
;
2070 switch(type
->type_class
) {
2072 case LTT_UINT_FIXED
:
2081 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2082 field
->fixed_size
= FIELD_FIXED
;
2085 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2086 field
->fixed_size
= FIELD_FIXED
;
2090 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2091 field
->fixed_size
= FIELD_FIXED
;
2096 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2097 field
->fixed_size
= FIELD_FIXED
;
2100 local_fixed_root
= FIELD_VARIABLE
;
2101 local_fixed_parent
= FIELD_VARIABLE
;
2102 preset_field_type_size(tf
, event_type
,
2104 &local_fixed_root
, &local_fixed_parent
,
2106 field
->fixed_size
= FIELD_VARIABLE
;
2107 field
->field_size
= 0;
2108 *fixed_root
= FIELD_VARIABLE
;
2109 *fixed_parent
= FIELD_VARIABLE
;
2112 field
->fixed_size
= FIELD_VARIABLE
;
2113 field
->field_size
= 0;
2114 *fixed_root
= FIELD_VARIABLE
;
2115 *fixed_parent
= FIELD_VARIABLE
;
2118 local_fixed_root
= FIELD_VARIABLE
;
2119 local_fixed_parent
= FIELD_VARIABLE
;
2120 preset_field_type_size(tf
, event_type
,
2122 &local_fixed_root
, &local_fixed_parent
,
2124 field
->fixed_size
= field
->child
[0]->fixed_size
;
2125 if(field
->fixed_size
== FIELD_FIXED
) {
2126 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2128 field
->field_size
= 0;
2129 *fixed_root
= FIELD_VARIABLE
;
2130 *fixed_parent
= FIELD_VARIABLE
;
2134 current_root_offset
= field
->offset_root
;
2136 current_child_status
= FIELD_FIXED
;
2137 for(i
=0;i
<type
->element_number
;i
++) {
2138 preset_field_type_size(tf
, event_type
,
2139 current_root_offset
, current_offset
,
2140 fixed_root
, ¤t_child_status
,
2142 if(current_child_status
== FIELD_FIXED
) {
2143 current_root_offset
+= field
->child
[i
]->field_size
;
2144 current_offset
+= field
->child
[i
]->field_size
;
2146 current_root_offset
= 0;
2150 if(current_child_status
!= FIELD_FIXED
) {
2151 *fixed_parent
= current_child_status
;
2152 field
->field_size
= 0;
2153 field
->fixed_size
= current_child_status
;
2155 field
->field_size
= current_offset
;
2156 field
->fixed_size
= FIELD_FIXED
;
2160 current_root_offset
= field
->offset_root
;
2163 final_child_status
= FIELD_FIXED
;
2164 for(i
=0;i
<type
->element_number
;i
++) {
2165 enum field_status current_root_child_status
= FIELD_FIXED
;
2166 enum field_status current_child_status
= FIELD_FIXED
;
2167 preset_field_type_size(tf
, event_type
,
2168 current_root_offset
, current_offset
,
2169 ¤t_root_child_status
, ¤t_child_status
,
2171 if(current_child_status
!= FIELD_FIXED
)
2172 final_child_status
= current_child_status
;
2174 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2176 if(final_child_status
!= FIELD_FIXED
) {
2177 g_error("LTTV does not support variable size fields in unions.");
2178 /* This will stop the application. */
2179 *fixed_root
= final_child_status
;
2180 *fixed_parent
= final_child_status
;
2181 field
->field_size
= 0;
2182 field
->fixed_size
= current_child_status
;
2184 field
->field_size
= max_size
;
2185 field
->fixed_size
= FIELD_FIXED
;
2189 g_error("unexpected type NONE");
2196 /*****************************************************************************
2198 * check_fields_compatibility : Check for compatibility between two fields :
2199 * do they use the same inner structure ?
2201 * event_type1 : event type
2202 * event_type2 : event type
2205 *Returns : 0 if identical
2207 ****************************************************************************/
2208 // this function checks for equality of field types. Therefore, it does not use
2209 // per se offsets. For instance, an aligned version of a structure is
2210 // compatible with an unaligned version of the same structure.
2212 gint
check_fields_compatibility(LttEventType
*event_type1
,
2213 LttEventType
*event_type2
,
2214 LttField
*field1
, LttField
*field2
)
2216 guint different
= 0;
2220 if(field1
== NULL
) {
2221 if(field2
== NULL
) goto end
;
2226 } else if(field2
== NULL
) {
2231 type1
= &field1
->field_type
;
2232 type2
= &field2
->field_type
;
2234 if(type1
->type_class
!= type2
->type_class
) {
2238 if(type1
->network
!= type2
->network
) {
2243 switch(type1
->type_class
) {
2245 case LTT_UINT_FIXED
:
2260 if(field1
->field_size
!= field2
->field_size
)
2267 LttField
*child1
= &g_array_index(type1
->fields
, LttField
, 0);
2268 LttField
*child2
= &g_array_index(type2
->fields
, LttField
, 0);
2270 if(type1
->size
!= type2
->size
)
2272 if(check_fields_compatibility(event_type1
, event_type2
, child1
, child2
))
2278 LttField
*child1
= &g_array_index(type1
->fields
, LttField
, 1);
2279 LttField
*child2
= &g_array_index(type2
->fields
, LttField
, 1);
2281 if(check_fields_compatibility(event_type1
, event_type2
, child1
, child2
))
2291 if(type1
->fields
->len
!= type2
->fields
->len
) {
2296 for(i
=0; i
< type1
->fields
->len
; i
++) {
2299 child1
= &g_array_index(type1
->fields
, LttField
, i
);
2300 child2
= &g_array_index(type2
->fields
, LttField
, i
);
2301 different
= check_fields_compatibility(event_type1
,
2302 event_type2
, child1
, child2
);
2304 if(different
) break;
2310 g_error("check_fields_compatibility : unknown type");
2319 gint
check_fields_compatibility(LttEventType
*event_type1
,
2320 LttEventType
*event_type2
,
2321 LttField
*field1
, LttField
*field2
)
2323 guint different
= 0;
2328 if(field1
== NULL
) {
2329 if(field2
== NULL
) goto end
;
2334 } else if(field2
== NULL
) {
2339 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2340 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2341 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2342 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2343 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2344 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2346 type1
= field1
->field_type
;
2347 type2
= field2
->field_type
;
2349 if(type1
->type_class
!= type2
->type_class
) {
2353 if(type1
->element_name
!= type2
->element_name
) {
2358 switch(type1
->type_class
) {
2360 case LTT_UINT_FIXED
:
2375 if(field1
->field_size
!= field2
->field_size
) {
2381 if(type1
->element_number
!= type2
->element_number
) {
2385 for(i
=0;i
<type1
->element_number
;i
++) {
2386 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2393 /* Two elements : size and child */
2394 g_assert(type1
->element_number
!= type2
->element_number
);
2395 for(i
=0;i
<type1
->element_number
;i
++) {
2396 if(check_fields_compatibility(event_type1
, event_type2
,
2397 field1
->child
[0], field2
->child
[0])) {
2406 if(field1
->field_size
!= field2
->field_size
) {
2410 /* Two elements : size and child */
2411 g_assert(type1
->element_number
!= type2
->element_number
);
2412 for(i
=0;i
<type1
->element_number
;i
++) {
2413 if(check_fields_compatibility(event_type1
, event_type2
,
2414 field1
->child
[0], field2
->child
[0])) {
2422 if(type1
->element_number
!= type2
->element_number
) {
2426 for(i
=0;i
<type1
->element_number
;i
++) {
2427 if(check_fields_compatibility(event_type1
, event_type2
,
2428 field1
->child
[0], field2
->child
[0])) {
2441 /*****************************************************************************
2443 * ltt_get_int : get an integer number
2445 * reverse_byte_order: must we reverse the byte order ?
2446 * size : the size of the integer
2447 * ptr : the data pointer
2449 * gint64 : a 64 bits integer
2450 ****************************************************************************/
2452 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2457 case 1: val
= *((gint8
*)data
); break;
2458 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2459 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2460 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2461 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2462 g_critical("get_int : integer size %d unknown", size
);
2469 /*****************************************************************************
2471 * ltt_get_uint : get an unsigned integer number
2473 * reverse_byte_order: must we reverse the byte order ?
2474 * size : the size of the integer
2475 * ptr : the data pointer
2477 * guint64 : a 64 bits unsigned integer
2478 ****************************************************************************/
2480 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2485 case 1: val
= *((gint8
*)data
); break;
2486 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2487 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2488 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2489 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2490 g_critical("get_uint : unsigned integer size %d unknown",
2499 /* get the node name of the system */
2501 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2503 return s
->node_name
;
2507 /* get the domain name of the system */
2509 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2511 return s
->domain_name
;
2515 /* get the description of the system */
2517 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2519 return s
->description
;
2523 /* get the NTP corrected start time of the trace */
2524 LttTime
ltt_trace_start_time(LttTrace
*t
)
2526 return t
->start_time
;
2529 /* get the monotonic start time of the trace */
2530 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
)
2532 return t
->start_time_from_tsc
;
2535 static LttTracefile
*ltt_tracefile_new()
2538 tf
= g_new(LttTracefile
, 1);
2539 tf
->event
.tracefile
= tf
;
2543 static void ltt_tracefile_destroy(LttTracefile
*tf
)
2548 static void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2553 /* Before library loading... */
2555 static __attribute__((constructor
)) void init(void)
2557 LTT_TRACEFILE_NAME_METADATA
= g_quark_from_string("metadata");