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_1
*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 if(munmap(tf
->buffer
.head
,
270 PAGE_ALIGN(ltt_subbuffer_header_size()))) {
271 g_warning("unmap size : %u\n",
272 PAGE_ALIGN(ltt_subbuffer_header_size()));
273 perror("munmap error");
276 tf
->buffer
.head
= NULL
;
278 //read the first block
279 if(map_block(tf
,0)) {
280 perror("Cannot map block for tracefile");
288 if(munmap(tf
->buffer
.head
,
289 PAGE_ALIGN(ltt_subbuffer_header_size()))) {
290 g_warning("unmap size : %u\n",
291 PAGE_ALIGN(ltt_subbuffer_header_size()));
292 perror("munmap error");
302 /*****************************************************************************
304 * ltt_tracefile_close: close a trace file,
306 * t : tracefile which will be closed
307 ****************************************************************************/
309 static void ltt_tracefile_close(LttTracefile
*t
)
311 int page_size
= getpagesize();
313 if(t
->buffer
.head
!= NULL
)
314 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
315 g_warning("unmap size : %u\n",
316 PAGE_ALIGN(t
->buf_size
));
317 perror("munmap error");
324 /****************************************************************************
325 * get_absolute_pathname
327 * return the unique pathname in the system
329 * MD : Fixed this function so it uses realpath, dealing well with
330 * forgotten cases (.. were not used correctly before).
332 ****************************************************************************/
333 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
335 abs_pathname
[0] = '\0';
337 if (realpath(pathname
, abs_pathname
) != NULL
)
341 /* error, return the original path unmodified */
342 strcpy(abs_pathname
, pathname
);
348 /* Search for something like : .*_.*
350 * The left side is the name, the right side is the number.
353 static int get_tracefile_name_number(gchar
*raw_name
,
360 guint raw_name_len
= strlen(raw_name
);
361 gchar char_name
[PATH_MAX
];
368 for(i
=raw_name_len
-1;i
>=0;i
--) {
369 if(raw_name
[i
] == '_') break;
371 if(i
==-1) { /* Either not found or name length is 0 */
372 /* This is a userspace tracefile */
373 strncpy(char_name
, raw_name
, raw_name_len
);
374 char_name
[raw_name_len
] = '\0';
375 *name
= g_quark_from_string(char_name
);
376 *num
= 0; /* unknown cpu */
377 for(i
=0;i
<raw_name_len
;i
++) {
378 if(raw_name
[i
] == '/') {
383 for(;i
<raw_name_len
;i
++) {
384 if(raw_name
[i
] == '/') {
389 for(;i
<raw_name_len
;i
++) {
390 if(raw_name
[i
] == '-') {
394 if(i
== raw_name_len
) return -1;
396 tmpptr
= &raw_name
[i
];
397 for(;i
<raw_name_len
;i
++) {
398 if(raw_name
[i
] == '.') {
403 *tid
= strtoul(tmpptr
, &endptr
, 10);
405 return -1; /* No digit */
406 if(*tid
== ULONG_MAX
)
407 return -1; /* underflow / overflow */
409 tmpptr
= &raw_name
[i
];
410 for(;i
<raw_name_len
;i
++) {
411 if(raw_name
[i
] == '.') {
416 *pgid
= strtoul(tmpptr
, &endptr
, 10);
418 return -1; /* No digit */
419 if(*pgid
== ULONG_MAX
)
420 return -1; /* underflow / overflow */
422 tmpptr
= &raw_name
[i
];
423 *creation
= strtoull(tmpptr
, &endptr
, 10);
425 return -1; /* No digit */
426 if(*creation
== G_MAXUINT64
)
427 return -1; /* underflow / overflow */
431 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
433 if(endptr
== raw_name
+underscore_pos
+1)
434 return -1; /* No digit */
435 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
436 return -1; /* underflow / overflow */
438 strncpy(char_name
, raw_name
, underscore_pos
);
439 char_name
[underscore_pos
] = '\0';
441 *name
= g_quark_from_string(char_name
);
450 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
452 return &trace
->tracefiles
;
456 void compute_tracefile_group(GQuark key_id
,
458 struct compute_tracefile_group_args
*args
)
463 for(i
=0; i
<group
->len
; i
++) {
464 tf
= &g_array_index (group
, LttTracefile
, i
);
466 args
->func(tf
, args
->func_args
);
471 static void ltt_tracefile_group_destroy(gpointer data
)
473 GArray
*group
= (GArray
*)data
;
477 for(i
=0; i
<group
->len
; i
++) {
478 tf
= &g_array_index (group
, LttTracefile
, i
);
480 ltt_tracefile_close(tf
);
482 g_array_free(group
, TRUE
);
485 static gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
487 GArray
*group
= (GArray
*)data
;
491 for(i
=0; i
<group
->len
; i
++) {
492 tf
= &g_array_index (group
, LttTracefile
, i
);
500 /* Open each tracefile under a specific directory. Put them in a
501 * GData : permits to access them using their tracefile group pathname.
502 * i.e. access control/modules tracefile group by index :
505 * relative path is the path relative to the trace root
506 * root path is the full path
508 * A tracefile group is simply an array where all the per cpu tracefiles sit.
511 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
, gchar
*relative_path
)
513 DIR *dir
= opendir(root_path
);
514 struct dirent
*entry
;
515 struct stat stat_buf
;
518 gchar path
[PATH_MAX
];
523 gchar rel_path
[PATH_MAX
];
532 strncpy(path
, root_path
, PATH_MAX
-1);
533 path_len
= strlen(path
);
534 path
[path_len
] = '/';
536 path_ptr
= path
+ path_len
;
538 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
539 rel_path_len
= strlen(rel_path
);
540 rel_path
[rel_path_len
] = '/';
542 rel_path_ptr
= rel_path
+ rel_path_len
;
544 while((entry
= readdir(dir
)) != NULL
) {
546 if(entry
->d_name
[0] == '.') continue;
548 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
549 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
551 ret
= stat(path
, &stat_buf
);
557 g_debug("Tracefile file or directory : %s\n", path
);
559 // if(strcmp(rel_path, "/eventdefs") == 0) continue;
561 if(S_ISDIR(stat_buf
.st_mode
)) {
563 g_debug("Entering subdirectory...\n");
564 ret
= open_tracefiles(trace
, path
, rel_path
);
565 if(ret
< 0) continue;
566 } else if(S_ISREG(stat_buf
.st_mode
)) {
575 if(get_tracefile_name_number(rel_path
, &name
, &num
, &tid
, &pgid
, &creation
))
576 continue; /* invalid name */
578 g_debug("Opening file.\n");
579 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
580 g_info("Error opening tracefile %s", path
);
582 continue; /* error opening the tracefile : bad magic number ? */
585 g_debug("Tracefile name is %s and number is %u",
586 g_quark_to_string(name
), num
);
588 tmp_tf
.cpu_online
= 1;
589 tmp_tf
.cpu_num
= num
;
593 tmp_tf
.creation
= creation
;
594 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
596 /* Elements are automatically cleared when the array is allocated.
597 * It makes the cpu_online variable set to 0 : cpu offline, by default.
599 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
600 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
601 group
, ltt_tracefile_group_destroy
);
604 /* Add the per cpu tracefile to the named group */
605 unsigned int old_len
= group
->len
;
607 group
= g_array_set_size(group
, num
+1);
608 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
609 g_array_index (group
, LttTracefile
, num
).event
.tracefile
=
610 &g_array_index (group
, LttTracefile
, num
);
620 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
621 * because it must be done just after the opening */
622 static int ltt_process_metadata_tracefile(LttTracefile
*tf
)
628 err
= ltt_tracefile_read_seek(tf
);
629 if(err
== EPERM
) goto seek_error
;
630 else if(err
== ERANGE
) break; /* End of tracefile */
632 err
= ltt_tracefile_read_update_event(tf
);
633 if(err
) goto update_error
;
636 * It contains only core events :
638 * 1 : set_marker_format
640 if(tf
->event
.event_id
>= MARKER_CORE_IDS
) {
641 /* Should only contain core events */
642 g_warning("Error in processing metadata file %s, "
643 "should not contain event id %u.", g_quark_to_string(tf
->name
),
649 const char *marker_name
, *format
;
651 guint8 int_size
, long_size
, pointer_size
, size_t_size
, alignment
;
653 switch((enum marker_id
)tf
->event
.event_id
) {
654 case MARKER_ID_SET_MARKER_ID
:
655 marker_name
= pos
= tf
->event
.data
;
656 g_debug("Doing MARKER_ID_SET_MARKER_ID of marker %s", marker_name
);
657 pos
+= strlen(marker_name
) + 1;
658 pos
+= ltt_align((size_t)pos
, sizeof(guint16
), tf
->alignment
);
659 id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
660 g_debug("In MARKER_ID_SET_MARKER_ID of marker %s id %hu",
662 pos
+= sizeof(guint16
);
663 int_size
= *(guint8
*)pos
;
664 pos
+= sizeof(guint8
);
665 long_size
= *(guint8
*)pos
;
666 pos
+= sizeof(guint8
);
667 pointer_size
= *(guint8
*)pos
;
668 pos
+= sizeof(guint8
);
669 size_t_size
= *(guint8
*)pos
;
670 pos
+= sizeof(guint8
);
671 alignment
= *(guint8
*)pos
;
672 pos
+= sizeof(guint8
);
673 marker_id_event(tf
->trace
, g_quark_from_string(marker_name
),
674 id
, int_size
, long_size
,
675 pointer_size
, size_t_size
, alignment
);
677 case MARKER_ID_SET_MARKER_FORMAT
:
678 marker_name
= pos
= tf
->event
.data
;
679 g_debug("Doing MARKER_ID_SET_MARKER_FORMAT of marker %s",
681 pos
+= strlen(marker_name
) + 1;
683 pos
+= strlen(format
) + 1;
684 marker_format_event(tf
->trace
, g_quark_from_string(marker_name
),
686 /* get information from dictionary TODO */
689 g_warning("Error in processing metadata file %s, "
690 "unknown event id %hhu.",
691 g_quark_to_string(tf
->name
),
704 g_warning("An error occured in metadata tracefile parsing");
709 * Open a trace and return its LttTrace handle.
711 * pathname must be the directory of the trace
714 LttTrace
*ltt_trace_open(const gchar
*pathname
)
716 gchar abs_path
[PATH_MAX
];
721 ltt_subbuffer_header_t
*header
;
723 struct dirent
*entry
;
724 guint control_found
= 0;
725 struct stat stat_buf
;
726 gchar path
[PATH_MAX
];
728 t
= g_new(LttTrace
, 1);
729 if(!t
) goto alloc_error
;
731 get_absolute_pathname(pathname
, abs_path
);
732 t
->pathname
= g_quark_from_string(abs_path
);
734 g_datalist_init(&t
->tracefiles
);
736 /* Test to see if it looks like a trace */
737 dir
= opendir(abs_path
);
742 while((entry
= readdir(dir
)) != NULL
) {
743 strcpy(path
, abs_path
);
745 strcat(path
, entry
->d_name
);
746 ret
= stat(path
, &stat_buf
);
751 if(S_ISDIR(stat_buf
.st_mode
)) {
752 if(strcmp(entry
->d_name
, "control") == 0) {
759 if(!control_found
) goto find_error
;
761 /* Open all the tracefiles */
762 if(open_tracefiles(t
, abs_path
, "")) {
763 g_warning("Error opening tracefile %s", abs_path
);
767 /* Parse each trace control/metadata_N files : get runtime fac. info */
768 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_METADATA
);
770 g_error("Trace %s has no metadata tracefile", abs_path
);
775 /* Get the trace information for the control/metadata_0 tracefile */
776 g_assert(group
->len
> 0);
777 tf
= &g_array_index (group
, LttTracefile
, 0);
778 header
= (ltt_subbuffer_header_t
*)tf
->buffer
.head
;
779 ret
= parse_trace_header(header
, tf
, t
);
782 t
->num_cpu
= group
->len
;
784 ret
= allocate_marker_data(t
);
786 g_error("Error in allocating marker data");
788 for(i
=0; i
<group
->len
; i
++) {
789 tf
= &g_array_index (group
, LttTracefile
, i
);
791 if(ltt_process_metadata_tracefile(tf
))
799 destroy_marker_data(t
);
801 g_datalist_clear(&t
->tracefiles
);
809 /* Open another, completely independant, instance of a trace.
811 * A read on this new instance will read the first event of the trace.
813 * When we copy a trace, we want all the opening actions to happen again :
814 * the trace will be reopened and totally independant from the original.
815 * That's why we call ltt_trace_open.
817 LttTrace
*ltt_trace_copy(LttTrace
*self
)
819 return ltt_trace_open(g_quark_to_string(self
->pathname
));
826 void ltt_trace_close(LttTrace
*t
)
828 g_datalist_clear(&t
->tracefiles
);
833 /*****************************************************************************
834 * Get the start time and end time of the trace
835 ****************************************************************************/
837 void ltt_tracefile_time_span_get(LttTracefile
*tf
,
838 LttTime
*start
, LttTime
*end
)
842 err
= map_block(tf
, 0);
844 g_error("Can not map block");
845 *start
= ltt_time_infinite
;
847 *start
= tf
->buffer
.begin
.timestamp
;
849 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
851 g_error("Can not map block");
852 *end
= ltt_time_zero
;
854 *end
= tf
->buffer
.end
.timestamp
;
857 struct tracefile_time_span_get_args
{
863 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
865 struct tracefile_time_span_get_args
*args
=
866 (struct tracefile_time_span_get_args
*)user_data
;
868 GArray
*group
= (GArray
*)data
;
874 for(i
=0; i
<group
->len
; i
++) {
875 tf
= &g_array_index (group
, LttTracefile
, i
);
877 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
878 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
879 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
884 /* return the start and end time of a trace */
886 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
888 LttTime min_start
= ltt_time_infinite
;
889 LttTime max_end
= ltt_time_zero
;
890 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
892 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
894 if(start
!= NULL
) *start
= min_start
;
895 if(end
!= NULL
) *end
= max_end
;
900 /* Seek to the first event in a tracefile that has a time equal or greater than
901 * the time passed in parameter.
903 * If the time parameter is outside the tracefile time span, seek to the first
904 * event or if after, return ERANGE.
906 * If the time parameter is before the first event, we have to seek specially to
909 * If the time is after the end of the trace, return ERANGE.
911 * Do a binary search to find the right block, then a sequential search in the
912 * block to find the event.
914 * In the special case where the time requested fits inside a block that has no
915 * event corresponding to the requested time, the first event of the next block
918 * IMPORTANT NOTE : // FIXME everywhere...
920 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
921 * you will jump over an event if you do.
923 * Return value : 0 : no error, the tf->event can be used
924 * ERANGE : time if after the last event of the trace
925 * otherwise : this is an error.
929 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
933 unsigned int block_num
, high
, low
;
935 /* seek at the beginning of trace */
936 err
= map_block(tf
, 0); /* First block */
938 g_error("Can not map block");
942 /* If the time is lower or equal the beginning of the trace,
943 * go to the first event. */
944 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
945 ret
= ltt_tracefile_read(tf
);
946 if(ret
== ERANGE
) goto range
;
947 else if (ret
) goto fail
;
948 goto found
; /* There is either no event in the trace or the event points
949 to the first event in the trace */
952 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
954 g_error("Can not map block");
958 /* If the time is after the end of the trace, return ERANGE. */
959 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
963 /* Binary search the block */
964 high
= tf
->num_blocks
- 1;
968 block_num
= ((high
-low
) / 2) + low
;
970 err
= map_block(tf
, block_num
);
972 g_error("Can not map block");
976 /* We cannot divide anymore : this is what would happen if the time
977 * requested was exactly between two consecutive buffers'end and start
978 * timestamps. This is also what would happend if we didn't deal with out
979 * of span cases prior in this function. */
980 /* The event is right in the buffer!
981 * (or in the next buffer first event) */
983 ret
= ltt_tracefile_read(tf
);
984 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
985 else if(ret
) goto fail
;
987 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
991 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
992 /* go to lower part */
993 high
= block_num
- 1;
994 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
995 /* go to higher part */
997 } else {/* The event is right in the buffer!
998 (or in the next buffer first event) */
1000 ret
= ltt_tracefile_read(tf
);
1001 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1002 else if(ret
) goto fail
;
1004 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1016 /* Error handling */
1018 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1019 g_quark_to_string(tf
->name
));
1023 /* Seek to a position indicated by an LttEventPosition
1026 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
)
1030 if(ep
->tracefile
!= tf
) {
1034 err
= map_block(tf
, ep
->block
);
1036 g_error("Can not map block");
1040 tf
->event
.offset
= ep
->offset
;
1042 /* Put back the event real tsc */
1043 tf
->event
.tsc
= ep
->tsc
;
1044 tf
->buffer
.tsc
= ep
->tsc
;
1046 err
= ltt_tracefile_read_update_event(tf
);
1049 /* deactivate this, as it does nothing for now
1050 err = ltt_tracefile_read_op(tf);
1057 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1058 g_quark_to_string(tf
->name
));
1062 /* Given a TSC value, return the LttTime (seconds,nanoseconds) it
1066 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
)
1070 if(tsc
> tf
->trace
->start_tsc
) {
1071 time
= ltt_time_from_uint64(
1072 (double)(tsc
- tf
->trace
->start_tsc
)
1073 * (1000000000.0 / tf
->trace
->freq_scale
)
1074 / (double)tf
->trace
->start_freq
);
1075 time
= ltt_time_add(tf
->trace
->start_time_from_tsc
, time
);
1077 time
= ltt_time_from_uint64(
1078 (double)(tf
->trace
->start_tsc
- tsc
)
1079 * (1000000000.0 / tf
->trace
->freq_scale
)
1080 / (double)tf
->trace
->start_freq
);
1081 time
= ltt_time_sub(tf
->trace
->start_time_from_tsc
, time
);
1086 /* Calculate the real event time based on the buffer boundaries */
1087 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1089 return ltt_interpolate_time_from_tsc(tf
, tf
->buffer
.tsc
);
1093 /* Get the current event of the tracefile : valid until the next read */
1094 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1101 /*****************************************************************************
1103 * ltt_tracefile_read : Read the next event in the tracefile
1108 * Returns 0 if an event can be used in tf->event.
1109 * Returns ERANGE on end of trace. The event in tf->event still can be used
1110 * (if the last block was not empty).
1111 * Returns EPERM on error.
1113 * This function does make the tracefile event structure point to the event
1114 * currently pointed to by the tf->event.
1116 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1117 * reinitialize it after an error if you want results to be coherent.
1118 * It would be the case if a end of trace last buffer has no event : the end
1119 * of trace wouldn't be returned, but an error.
1120 * We make the assumption there is at least one event per buffer.
1121 ****************************************************************************/
1123 int ltt_tracefile_read(LttTracefile
*tf
)
1127 err
= ltt_tracefile_read_seek(tf
);
1129 err
= ltt_tracefile_read_update_event(tf
);
1132 /* deactivate this, as it does nothing for now
1133 err = ltt_tracefile_read_op(tf);
1140 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1144 /* Get next buffer until we finally have an event, or end of trace */
1146 err
= ltt_seek_next_event(tf
);
1147 if(unlikely(err
== ENOPROTOOPT
)) {
1151 /* Are we at the end of the buffer ? */
1153 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1156 /* get next block */
1157 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1159 g_error("Can not map block");
1163 } else break; /* We found an event ! */
1169 /* do an operation when reading a new event */
1171 /* This function does nothing for now */
1173 int ltt_tracefile_read_op(LttTracefile
*tf
)
1179 /* do event specific operation */
1187 static void print_debug_event_header(LttEvent
*ev
, void *start_pos
, void *end_pos
)
1189 unsigned int offset
= 0;
1192 g_printf("Event header (tracefile %s offset %llx):\n",
1193 g_quark_to_string(ev
->tracefile
->long_name
),
1194 ((uint64_t)ev
->tracefile
->buffer
.index
* ev
->tracefile
->buf_size
)
1195 + (long)start_pos
- (long)ev
->tracefile
->buffer
.head
);
1197 while (offset
< (long)end_pos
- (long)start_pos
) {
1198 g_printf("%8lx", (long)start_pos
- (long)ev
->tracefile
->buffer
.head
+ offset
);
1201 for (i
= 0; i
< 4 ; i
++) {
1202 for (j
= 0; j
< 4; j
++) {
1203 if (offset
+ ((i
* 4) + j
) <
1204 (long)end_pos
- (long)start_pos
)
1206 ((char*)start_pos
)[offset
+ ((i
* 4) + j
)]);
1220 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1221 * event specific operation. */
1222 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1229 pos
= tf
->buffer
.head
+ event
->offset
;
1231 /* Read event header */
1233 /* Align the head */
1234 pos
+= ltt_align((size_t)pos
, sizeof(guint32
), tf
->alignment
);
1237 event
->timestamp
= ltt_get_uint32(LTT_GET_BO(tf
), pos
);
1238 event
->event_id
= event
->timestamp
>> tf
->tscbits
;
1239 event
->timestamp
= event
->timestamp
& tf
->tsc_mask
;
1240 pos
+= sizeof(guint32
);
1242 switch (event
->event_id
) {
1243 case 29: /* LTT_RFLAG_ID_SIZE_TSC */
1244 event
->event_id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1245 pos
+= sizeof(guint16
);
1246 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1247 pos
+= sizeof(guint16
);
1248 if (event
->event_size
== 0xFFFF) {
1249 event
->event_size
= ltt_get_uint32(LTT_GET_BO(tf
), pos
);
1250 pos
+= sizeof(guint32
);
1252 pos
+= ltt_align((size_t)pos
, sizeof(guint64
), tf
->alignment
);
1253 tf
->buffer
.tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1254 pos
+= sizeof(guint64
);
1256 case 30: /* LTT_RFLAG_ID_SIZE */
1257 event
->event_id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1258 pos
+= sizeof(guint16
);
1259 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1260 pos
+= sizeof(guint16
);
1261 if (event
->event_size
== 0xFFFF) {
1262 event
->event_size
= ltt_get_uint32(LTT_GET_BO(tf
), pos
);
1263 pos
+= sizeof(guint32
);
1266 case 31: /* LTT_RFLAG_ID */
1267 event
->event_id
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1268 pos
+= sizeof(guint16
);
1269 event
->event_size
= G_MAXUINT
;
1272 event
->event_size
= G_MAXUINT
;
1276 if (likely(event
->event_id
!= 29)) {
1277 /* No extended timestamp */
1278 if (event
->timestamp
< (tf
->buffer
.tsc
& tf
->tsc_mask
))
1279 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
& ~tf
->tsc_mask
) /* overflow */
1280 + tf
->tsc_mask_next_bit
)
1281 | (guint64
)event
->timestamp
;
1283 tf
->buffer
.tsc
= (tf
->buffer
.tsc
& ~tf
->tsc_mask
) /* no overflow */
1284 | (guint64
)event
->timestamp
;
1286 event
->tsc
= tf
->buffer
.tsc
;
1288 event
->event_time
= ltt_interpolate_time(tf
, event
);
1291 print_debug_event_header(event
, pos_aligned
, pos
);
1296 * Let ltt_update_event_size update event->data according to the largest
1297 * alignment within the payload.
1298 * Get the data size and update the event fields with the current
1300 ltt_update_event_size(tf
);
1306 /****************************************************************************
1308 * map_block : map a block from the file
1310 * lttdes : ltt trace file
1311 * whichBlock : the block which will be read
1314 * EINVAL : lseek fail
1315 * EIO : can not read from the file
1316 ****************************************************************************/
1318 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1320 int page_size
= getpagesize();
1321 ltt_subbuffer_header_t
*header
;
1323 g_assert(block_num
< tf
->num_blocks
);
1325 if(tf
->buffer
.head
!= NULL
) {
1326 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1327 g_warning("unmap size : %u\n",
1328 PAGE_ALIGN(tf
->buf_size
));
1329 perror("munmap error");
1334 /* Multiple of pages aligned head */
1335 tf
->buffer
.head
= mmap(0,
1336 PAGE_ALIGN(tf
->buf_size
),
1337 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1338 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1340 if(tf
->buffer
.head
== MAP_FAILED
) {
1341 perror("Error in allocating memory for buffer of tracefile");
1345 g_assert( ( (gulong
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1348 tf
->buffer
.index
= block_num
;
1350 header
= (ltt_subbuffer_header_t
*)tf
->buffer
.head
;
1352 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1353 &header
->cycle_count_begin
);
1354 tf
->buffer
.begin
.freq
= tf
->trace
->start_freq
;
1356 tf
->buffer
.begin
.timestamp
= ltt_interpolate_time_from_tsc(tf
,
1357 tf
->buffer
.begin
.cycle_count
);
1358 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1359 &header
->cycle_count_end
);
1360 tf
->buffer
.end
.freq
= tf
->trace
->start_freq
;
1362 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1363 &header
->lost_size
);
1364 tf
->buffer
.end
.timestamp
= ltt_interpolate_time_from_tsc(tf
,
1365 tf
->buffer
.end
.cycle_count
);
1366 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1367 tf
->event
.tsc
= tf
->buffer
.tsc
;
1368 tf
->buffer
.freq
= tf
->buffer
.begin
.freq
;
1371 * eventually support variable buffer size : will need a partial pre-read of
1372 * the headers to create an index when we open the trace... eventually. */
1373 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1374 &header
->buf_size
));
1376 /* Make the current event point to the beginning of the buffer :
1377 * it means that the event read must get the first event. */
1378 tf
->event
.tracefile
= tf
;
1379 tf
->event
.block
= block_num
;
1380 tf
->event
.offset
= 0;
1388 static void print_debug_event_data(LttEvent
*ev
)
1390 unsigned int offset
= 0;
1393 if (!max(ev
->event_size
, ev
->data_size
))
1396 g_printf("Event data (tracefile %s offset %llx):\n",
1397 g_quark_to_string(ev
->tracefile
->long_name
),
1398 ((uint64_t)ev
->tracefile
->buffer
.index
* ev
->tracefile
->buf_size
)
1399 + (long)ev
->data
- (long)ev
->tracefile
->buffer
.head
);
1401 while (offset
< max(ev
->event_size
, ev
->data_size
)) {
1402 g_printf("%8lx", (long)ev
->data
+ offset
1403 - (long)ev
->tracefile
->buffer
.head
);
1406 for (i
= 0; i
< 4 ; i
++) {
1407 for (j
= 0; j
< 4; j
++) {
1408 if (offset
+ ((i
* 4) + j
) < max(ev
->event_size
, ev
->data_size
))
1409 g_printf("%02hhX", ((char*)ev
->data
)[offset
+ ((i
* 4) + j
)]);
1420 for (i
= 0; i
< 4; i
++) {
1421 for (j
= 0; j
< 4; j
++) {
1422 if (offset
+ ((i
* 4) + j
) < max(ev
->event_size
, ev
->data_size
)) {
1423 if (isprint(((char*)ev
->data
)[offset
+ ((i
* 4) + j
)]))
1424 g_printf("%c", ((char*)ev
->data
)[offset
+ ((i
* 4) + j
)]);
1436 /* It will update the fields offsets too */
1437 void ltt_update_event_size(LttTracefile
*tf
)
1441 struct marker_info
*info
;
1443 switch((enum marker_id
)tf
->event
.event_id
) {
1444 case MARKER_ID_SET_MARKER_ID
:
1445 size
= strlen((char*)tf
->event
.data
) + 1;
1446 g_debug("marker %s id set", (char*)tf
->event
.data
);
1447 size
+= ltt_align(size
, sizeof(guint16
), tf
->alignment
);
1448 size
+= sizeof(guint16
);
1449 size
+= sizeof(guint8
);
1450 size
+= sizeof(guint8
);
1451 size
+= sizeof(guint8
);
1452 size
+= sizeof(guint8
);
1453 size
+= sizeof(guint8
);
1455 case MARKER_ID_SET_MARKER_FORMAT
:
1456 g_debug("marker %s format set", (char*)tf
->event
.data
);
1457 size
= strlen((char*)tf
->event
.data
) + 1;
1458 size
+= strlen((char*)tf
->event
.data
+ size
) + 1;
1462 info
= marker_get_info_from_id(tf
->trace
, tf
->event
.event_id
);
1464 if (tf
->event
.event_id
>= MARKER_CORE_IDS
)
1465 g_assert(info
!= NULL
);
1467 /* Do not update field offsets of core markers when initially reading the
1468 * metadata tracefile when the infos about these markers do not exist yet.
1470 if (likely(info
&& info
->fields
)) {
1472 tf
->event
.data
+= ltt_align((off_t
)(unsigned long)tf
->event
.data
,
1473 info
->largest_align
,
1475 /* size, dynamically computed */
1476 if (info
->size
!= -1)
1479 size
= marker_update_fields_offsets(marker_get_info_from_id(tf
->trace
,
1480 tf
->event
.event_id
), tf
->event
.data
);
1483 tf
->event
.data_size
= size
;
1485 /* Check consistency between kernel and LTTV structure sizes */
1486 if(tf
->event
.event_size
== G_MAXUINT
) {
1487 /* Event size too big to fit in the event size field */
1488 tf
->event
.event_size
= tf
->event
.data_size
;
1492 print_debug_event_data(&tf
->event
);
1494 /* Having a marker load or marker format event out of the metadata
1495 * tracefiles is a serious bug. */
1496 switch((enum marker_id
)tf
->event
.event_id
) {
1497 case MARKER_ID_SET_MARKER_ID
:
1498 case MARKER_ID_SET_MARKER_FORMAT
:
1499 if (tf
->name
!= g_quark_from_string("/control/metadata"))
1500 g_error("Trace inconsistency : metadata event found in data "
1501 "tracefile %s", g_quark_to_string(tf
->long_name
));
1504 if (tf
->event
.data_size
!= tf
->event
.event_size
) {
1505 struct marker_info
*info
= marker_get_info_from_id(tf
->trace
,
1506 tf
->event
.event_id
);
1507 g_error("Kernel/LTTV event size differs for event %s: kernel %u, LTTV %u",
1508 g_quark_to_string(info
->name
),
1509 tf
->event
.event_size
, tf
->event
.data_size
);
1515 /* Take the tf current event offset and use the event id to figure out where is
1516 * the next event offset.
1518 * This is an internal function not aiming at being used elsewhere : it will
1519 * not jump over the current block limits. Please consider using
1520 * ltt_tracefile_read to do this.
1522 * Returns 0 on success
1523 * ERANGE if we are at the end of the buffer.
1524 * ENOPROTOOPT if an error occured when getting the current event size.
1526 static int ltt_seek_next_event(LttTracefile
*tf
)
1531 /* seek over the buffer header if we are at the buffer start */
1532 if(tf
->event
.offset
== 0) {
1533 tf
->event
.offset
+= tf
->buffer_header_size
;
1535 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1541 pos
= tf
->event
.data
;
1543 if(tf
->event
.data_size
< 0) goto error
;
1545 pos
+= (size_t)tf
->event
.data_size
;
1547 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1549 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1553 g_assert(tf
->event
.offset
< tf
->buf_size
- tf
->buffer
.lost_size
);
1559 g_error("Error in ltt_seek_next_event for tracefile %s",
1560 g_quark_to_string(tf
->name
));
1565 /*****************************************************************************
1567 * set_fields_offsets : set the precomputable offset of the fields
1569 * tracefile : opened trace file
1570 * event_type : the event type
1571 ****************************************************************************/
1573 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1575 LttField
*field
= event_type
->root_field
;
1576 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1579 preset_field_type_size(tf
, event_type
, 0, 0,
1580 &fixed_root
, &fixed_parent
,
1587 /*****************************************************************************
1589 * get_alignment : Get the alignment needed for a field.
1593 * returns : The size on which it must be aligned.
1595 ****************************************************************************/
1597 off_t
get_alignment(LttField
*field
)
1599 LttType
*type
= &field
->field_type
;
1601 switch(type
->type_class
) {
1603 case LTT_UINT_FIXED
:
1618 /* Align offset on type size */
1619 g_assert(field
->field_size
!= 0);
1620 return field
->field_size
;
1626 g_assert(type
->fields
->len
== 1);
1628 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1629 return get_alignment(child
);
1633 g_assert(type
->fields
->len
== 2);
1636 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1638 localign
= max(localign
, get_alignment(child
));
1640 child
= &g_array_index(type
->fields
, LttField
, 1);
1641 localign
= max(localign
, get_alignment(child
));
1652 for(i
=0; i
<type
->fields
->len
; i
++) {
1653 LttField
*child
= &g_array_index(type
->fields
, LttField
, i
);
1654 localign
= max(localign
, get_alignment(child
));
1661 g_error("get_alignment : unknown type");
1668 /*****************************************************************************
1670 * field_compute_static_size : Determine the size of fields known by their
1671 * sole definition. Unions, arrays and struct sizes might be known, but
1672 * the parser does not give that information.
1677 ****************************************************************************/
1679 void field_compute_static_size(LttFacility
*fac
, LttField
*field
)
1681 LttType
*type
= &field
->field_type
;
1683 switch(type
->type_class
) {
1685 case LTT_UINT_FIXED
:
1704 /* note this : array type size is the number of elements in the array,
1705 * while array field size of the length of the array in bytes */
1706 g_assert(type
->fields
->len
== 1);
1708 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1709 field_compute_static_size(fac
, child
);
1711 if(child
->field_size
!= 0) {
1712 field
->field_size
= type
->size
* child
->field_size
;
1713 field
->dynamic_offsets
= g_array_sized_new(FALSE
, TRUE
,
1714 sizeof(off_t
), type
->size
);
1716 field
->field_size
= 0;
1721 g_assert(type
->fields
->len
== 2);
1723 off_t local_offset
= 0;
1724 LttField
*child
= &g_array_index(type
->fields
, LttField
, 1);
1725 field_compute_static_size(fac
, child
);
1726 field
->field_size
= 0;
1728 if(child
->field_size
!= 0) {
1729 field
->dynamic_offsets
= g_array_sized_new(FALSE
, TRUE
,
1730 sizeof(off_t
), SEQUENCE_AVG_ELEMENTS
);
1738 for(i
=0;i
<type
->fields
->len
;i
++) {
1739 LttField
*child
= &g_array_index(type
->fields
, LttField
, i
);
1740 field_compute_static_size(fac
, child
);
1741 if(child
->field_size
!= 0) {
1742 type
->size
+= ltt_align(type
->size
, get_alignment(child
),
1744 type
->size
+= child
->field_size
;
1746 /* As soon as we find a child with variable size, we have
1747 * a variable size */
1752 field
->field_size
= type
->size
;
1756 g_error("field_static_size : unknown type");
1763 /*****************************************************************************
1765 * precompute_fields_offsets : set the precomputable offset of the fields
1769 * offset : pointer to the current offset, must be incremented
1771 * return : 1 : found a variable length field, stop the processing.
1773 ****************************************************************************/
1776 gint
precompute_fields_offsets(LttFacility
*fac
, LttField
*field
, off_t
*offset
, gint is_compact
)
1778 LttType
*type
= &field
->field_type
;
1780 if(unlikely(is_compact
)) {
1781 g_assert(field
->field_size
!= 0);
1782 /* FIXME THIS IS A HUUUUUGE hack :
1783 * offset is between the compact_data field in struct LttEvent
1784 * and the address of the field root in the memory map.
1785 * ark. Both will stay at the same addresses while the event
1786 * is readable, so it's ok.
1788 field
->offset_root
= 0;
1789 field
->fixed_root
= FIELD_FIXED
;
1793 switch(type
->type_class
) {
1795 case LTT_UINT_FIXED
:
1810 g_assert(field
->field_size
!= 0);
1811 /* Align offset on type size */
1812 *offset
+= ltt_align(*offset
, get_alignment(field
),
1814 /* remember offset */
1815 field
->offset_root
= *offset
;
1816 field
->fixed_root
= FIELD_FIXED
;
1817 /* Increment offset */
1818 *offset
+= field
->field_size
;
1822 field
->offset_root
= *offset
;
1823 field
->fixed_root
= FIELD_FIXED
;
1827 g_assert(type
->fields
->len
== 1);
1829 LttField
*child
= &g_array_index(type
->fields
, LttField
, 0);
1831 *offset
+= ltt_align(*offset
, get_alignment(field
),
1834 /* remember offset */
1835 field
->offset_root
= *offset
;
1836 field
->array_offset
= *offset
;
1837 field
->fixed_root
= FIELD_FIXED
;
1839 /* Let the child be variable */
1840 //precompute_fields_offsets(tf, child, offset);
1842 if(field
->field_size
!= 0) {
1843 /* Increment offset */
1844 /* field_size is the array size in bytes */
1845 *offset
+= field
->field_size
;
1853 g_assert(type
->fields
->len
== 2);
1858 *offset
+= ltt_align(*offset
, get_alignment(field
),
1861 /* remember offset */
1862 field
->offset_root
= *offset
;
1863 field
->fixed_root
= FIELD_FIXED
;
1865 child
= &g_array_index(type
->fields
, LttField
, 0);
1866 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
1867 g_assert(ret
== 0); /* Seq len cannot have variable len */
1869 child
= &g_array_index(type
->fields
, LttField
, 1);
1870 *offset
+= ltt_align(*offset
, get_alignment(child
),
1872 field
->array_offset
= *offset
;
1873 /* Let the child be variable. */
1874 //ret = precompute_fields_offsets(fac, child, offset);
1876 /* Cannot precompute fields offsets of sequence members, and has
1877 * variable length. */
1887 *offset
+= ltt_align(*offset
, get_alignment(field
),
1889 /* remember offset */
1890 field
->offset_root
= *offset
;
1891 field
->fixed_root
= FIELD_FIXED
;
1893 for(i
=0; i
< type
->fields
->len
; i
++) {
1894 child
= &g_array_index(type
->fields
, LttField
, i
);
1895 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
1908 *offset
+= ltt_align(*offset
, get_alignment(field
),
1910 /* remember offset */
1911 field
->offset_root
= *offset
;
1912 field
->fixed_root
= FIELD_FIXED
;
1914 for(i
=0; i
< type
->fields
->len
; i
++) {
1915 *offset
= field
->offset_root
;
1916 child
= &g_array_index(type
->fields
, LttField
, i
);
1917 ret
= precompute_fields_offsets(fac
, child
, offset
, is_compact
);
1921 *offset
= field
->offset_root
+ field
->field_size
;
1928 g_error("precompute_fields_offsets : unknown type");
1937 /*****************************************************************************
1939 * precompute_offsets : set the precomputable offset of an event type
1942 * event : event type
1944 ****************************************************************************/
1945 void precompute_offsets(LttFacility
*fac
, LttEventType
*event
)
1951 /* First, compute the size of fixed size fields. Will determine size for
1952 * arrays, struct and unions, which is not done by the parser */
1953 for(i
=0; i
<event
->fields
->len
; i
++) {
1954 LttField
*field
= &g_array_index(event
->fields
, LttField
, i
);
1955 field_compute_static_size(fac
, field
);
1958 /* Precompute all known offsets */
1959 for(i
=0; i
<event
->fields
->len
; i
++) {
1960 LttField
*field
= &g_array_index(event
->fields
, LttField
, i
);
1961 if(event
->has_compact_data
&& i
== 0)
1962 ret
= precompute_fields_offsets(fac
, field
, &offset
, 1);
1964 ret
= precompute_fields_offsets(fac
, field
, &offset
, 0);
1972 /*****************************************************************************
1974 * preset_field_type_size : set the fixed sizes of the field type
1977 * event_type : event type
1978 * offset_root : offset from the root
1979 * offset_parent : offset from the parent
1980 * fixed_root : Do we know a fixed offset to the root ?
1981 * fixed_parent : Do we know a fixed offset to the parent ?
1983 ****************************************************************************/
1987 // preset the fixed size offsets. Calculate them just like genevent-new : an
1988 // increment of a *to value that represents the offset from the start of the
1990 // The preset information is : offsets up to (and including) the first element
1991 // of variable size. All subsequent fields must be flagged "VARIABLE OFFSET".
1993 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1994 off_t offset_root
, off_t offset_parent
,
1995 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1998 enum field_status local_fixed_root
, local_fixed_parent
;
2002 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
2003 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
2004 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
2006 type
= field
->field_type
;
2008 field
->fixed_root
= *fixed_root
;
2009 if(field
->fixed_root
== FIELD_FIXED
)
2010 field
->offset_root
= offset_root
;
2012 field
->offset_root
= 0;
2014 field
->fixed_parent
= *fixed_parent
;
2015 if(field
->fixed_parent
== FIELD_FIXED
)
2016 field
->offset_parent
= offset_parent
;
2018 field
->offset_parent
= 0;
2020 size_t current_root_offset
;
2021 size_t current_offset
;
2022 enum field_status current_child_status
, final_child_status
;
2025 switch(type
->type_class
) {
2027 case LTT_UINT_FIXED
:
2036 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2037 field
->fixed_size
= FIELD_FIXED
;
2040 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2041 field
->fixed_size
= FIELD_FIXED
;
2045 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2046 field
->fixed_size
= FIELD_FIXED
;
2051 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2052 field
->fixed_size
= FIELD_FIXED
;
2055 local_fixed_root
= FIELD_VARIABLE
;
2056 local_fixed_parent
= FIELD_VARIABLE
;
2057 preset_field_type_size(tf
, event_type
,
2059 &local_fixed_root
, &local_fixed_parent
,
2061 field
->fixed_size
= FIELD_VARIABLE
;
2062 field
->field_size
= 0;
2063 *fixed_root
= FIELD_VARIABLE
;
2064 *fixed_parent
= FIELD_VARIABLE
;
2067 field
->fixed_size
= FIELD_VARIABLE
;
2068 field
->field_size
= 0;
2069 *fixed_root
= FIELD_VARIABLE
;
2070 *fixed_parent
= FIELD_VARIABLE
;
2073 local_fixed_root
= FIELD_VARIABLE
;
2074 local_fixed_parent
= FIELD_VARIABLE
;
2075 preset_field_type_size(tf
, event_type
,
2077 &local_fixed_root
, &local_fixed_parent
,
2079 field
->fixed_size
= field
->child
[0]->fixed_size
;
2080 if(field
->fixed_size
== FIELD_FIXED
) {
2081 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2083 field
->field_size
= 0;
2084 *fixed_root
= FIELD_VARIABLE
;
2085 *fixed_parent
= FIELD_VARIABLE
;
2089 current_root_offset
= field
->offset_root
;
2091 current_child_status
= FIELD_FIXED
;
2092 for(i
=0;i
<type
->element_number
;i
++) {
2093 preset_field_type_size(tf
, event_type
,
2094 current_root_offset
, current_offset
,
2095 fixed_root
, ¤t_child_status
,
2097 if(current_child_status
== FIELD_FIXED
) {
2098 current_root_offset
+= field
->child
[i
]->field_size
;
2099 current_offset
+= field
->child
[i
]->field_size
;
2101 current_root_offset
= 0;
2105 if(current_child_status
!= FIELD_FIXED
) {
2106 *fixed_parent
= current_child_status
;
2107 field
->field_size
= 0;
2108 field
->fixed_size
= current_child_status
;
2110 field
->field_size
= current_offset
;
2111 field
->fixed_size
= FIELD_FIXED
;
2115 current_root_offset
= field
->offset_root
;
2118 final_child_status
= FIELD_FIXED
;
2119 for(i
=0;i
<type
->element_number
;i
++) {
2120 enum field_status current_root_child_status
= FIELD_FIXED
;
2121 enum field_status current_child_status
= FIELD_FIXED
;
2122 preset_field_type_size(tf
, event_type
,
2123 current_root_offset
, current_offset
,
2124 ¤t_root_child_status
, ¤t_child_status
,
2126 if(current_child_status
!= FIELD_FIXED
)
2127 final_child_status
= current_child_status
;
2129 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2131 if(final_child_status
!= FIELD_FIXED
) {
2132 g_error("LTTV does not support variable size fields in unions.");
2133 /* This will stop the application. */
2134 *fixed_root
= final_child_status
;
2135 *fixed_parent
= final_child_status
;
2136 field
->field_size
= 0;
2137 field
->fixed_size
= current_child_status
;
2139 field
->field_size
= max_size
;
2140 field
->fixed_size
= FIELD_FIXED
;
2144 g_error("unexpected type NONE");
2151 /*****************************************************************************
2153 * check_fields_compatibility : Check for compatibility between two fields :
2154 * do they use the same inner structure ?
2156 * event_type1 : event type
2157 * event_type2 : event type
2160 *Returns : 0 if identical
2162 ****************************************************************************/
2163 // this function checks for equality of field types. Therefore, it does not use
2164 // per se offsets. For instance, an aligned version of a structure is
2165 // compatible with an unaligned version of the same structure.
2167 gint
check_fields_compatibility(LttEventType
*event_type1
,
2168 LttEventType
*event_type2
,
2169 LttField
*field1
, LttField
*field2
)
2171 guint different
= 0;
2175 if(field1
== NULL
) {
2176 if(field2
== NULL
) goto end
;
2181 } else if(field2
== NULL
) {
2186 type1
= &field1
->field_type
;
2187 type2
= &field2
->field_type
;
2189 if(type1
->type_class
!= type2
->type_class
) {
2193 if(type1
->network
!= type2
->network
) {
2198 switch(type1
->type_class
) {
2200 case LTT_UINT_FIXED
:
2215 if(field1
->field_size
!= field2
->field_size
)
2222 LttField
*child1
= &g_array_index(type1
->fields
, LttField
, 0);
2223 LttField
*child2
= &g_array_index(type2
->fields
, LttField
, 0);
2225 if(type1
->size
!= type2
->size
)
2227 if(check_fields_compatibility(event_type1
, event_type2
, child1
, child2
))
2233 LttField
*child1
= &g_array_index(type1
->fields
, LttField
, 1);
2234 LttField
*child2
= &g_array_index(type2
->fields
, LttField
, 1);
2236 if(check_fields_compatibility(event_type1
, event_type2
, child1
, child2
))
2246 if(type1
->fields
->len
!= type2
->fields
->len
) {
2251 for(i
=0; i
< type1
->fields
->len
; i
++) {
2254 child1
= &g_array_index(type1
->fields
, LttField
, i
);
2255 child2
= &g_array_index(type2
->fields
, LttField
, i
);
2256 different
= check_fields_compatibility(event_type1
,
2257 event_type2
, child1
, child2
);
2259 if(different
) break;
2265 g_error("check_fields_compatibility : unknown type");
2274 gint
check_fields_compatibility(LttEventType
*event_type1
,
2275 LttEventType
*event_type2
,
2276 LttField
*field1
, LttField
*field2
)
2278 guint different
= 0;
2283 if(field1
== NULL
) {
2284 if(field2
== NULL
) goto end
;
2289 } else if(field2
== NULL
) {
2294 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2295 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2296 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2297 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2298 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2299 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2301 type1
= field1
->field_type
;
2302 type2
= field2
->field_type
;
2304 if(type1
->type_class
!= type2
->type_class
) {
2308 if(type1
->element_name
!= type2
->element_name
) {
2313 switch(type1
->type_class
) {
2315 case LTT_UINT_FIXED
:
2330 if(field1
->field_size
!= field2
->field_size
) {
2336 if(type1
->element_number
!= type2
->element_number
) {
2340 for(i
=0;i
<type1
->element_number
;i
++) {
2341 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2348 /* Two elements : size and child */
2349 g_assert(type1
->element_number
!= type2
->element_number
);
2350 for(i
=0;i
<type1
->element_number
;i
++) {
2351 if(check_fields_compatibility(event_type1
, event_type2
,
2352 field1
->child
[0], field2
->child
[0])) {
2361 if(field1
->field_size
!= field2
->field_size
) {
2365 /* Two elements : size and child */
2366 g_assert(type1
->element_number
!= type2
->element_number
);
2367 for(i
=0;i
<type1
->element_number
;i
++) {
2368 if(check_fields_compatibility(event_type1
, event_type2
,
2369 field1
->child
[0], field2
->child
[0])) {
2377 if(type1
->element_number
!= type2
->element_number
) {
2381 for(i
=0;i
<type1
->element_number
;i
++) {
2382 if(check_fields_compatibility(event_type1
, event_type2
,
2383 field1
->child
[0], field2
->child
[0])) {
2396 /*****************************************************************************
2398 * ltt_get_int : get an integer number
2400 * reverse_byte_order: must we reverse the byte order ?
2401 * size : the size of the integer
2402 * ptr : the data pointer
2404 * gint64 : a 64 bits integer
2405 ****************************************************************************/
2407 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2412 case 1: val
= *((gint8
*)data
); break;
2413 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2414 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2415 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2416 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2417 g_critical("get_int : integer size %d unknown", size
);
2424 /*****************************************************************************
2426 * ltt_get_uint : get an unsigned integer number
2428 * reverse_byte_order: must we reverse the byte order ?
2429 * size : the size of the integer
2430 * ptr : the data pointer
2432 * guint64 : a 64 bits unsigned integer
2433 ****************************************************************************/
2435 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2440 case 1: val
= *((gint8
*)data
); break;
2441 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2442 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2443 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2444 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2445 g_critical("get_uint : unsigned integer size %d unknown",
2454 /* get the node name of the system */
2456 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2458 return s
->node_name
;
2462 /* get the domain name of the system */
2464 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2466 return s
->domain_name
;
2470 /* get the description of the system */
2472 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2474 return s
->description
;
2478 /* get the NTP corrected start time of the trace */
2479 LttTime
ltt_trace_start_time(LttTrace
*t
)
2481 return t
->start_time
;
2484 /* get the monotonic start time of the trace */
2485 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
)
2487 return t
->start_time_from_tsc
;
2490 static LttTracefile
*ltt_tracefile_new()
2493 tf
= g_new(LttTracefile
, 1);
2494 tf
->event
.tracefile
= tf
;
2498 static void ltt_tracefile_destroy(LttTracefile
*tf
)
2503 static void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2508 /* Before library loading... */
2510 static __attribute__((constructor
)) void init(void)
2512 LTT_TRACEFILE_NAME_METADATA
= g_quark_from_string("/control/metadata");