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 program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License Version 2 as
8 * published by the Free Software Foundation;
10 * This program 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
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 #include <sys/types.h>
45 #include "ltt-private.h"
46 #include <ltt/trace.h>
47 #include <ltt/facility.h>
48 #include <ltt/event.h>
50 #include <ltt/ltt-types.h>
53 /* Facility names used in this file */
55 GQuark LTT_FACILITY_NAME_HEARTBEAT
,
56 LTT_EVENT_NAME_HEARTBEAT
;
57 GQuark LTT_TRACEFILE_NAME_FACILITIES
;
64 #define __UNUSED__ __attribute__((__unused__))
66 #define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
69 #define g_debug(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format)
74 /* Those macros must be called from within a function where page_size is a known
76 #define PAGE_MASK (~(page_size-1))
77 #define PAGE_ALIGN(addr) (((addr)+page_size-1)&PAGE_MASK)
79 /* set the offset of the fields belonging to the event,
80 need the information of the archecture */
81 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
);
82 //size_t get_fields_offsets(LttTracefile *tf, LttEventType *event_type, void *data);
84 /* get the size of the field type according to
85 * The facility size information. */
86 static inline void preset_field_type_size(LttTracefile
*tf
,
87 LttEventType
*event_type
,
88 off_t offset_root
, off_t offset_parent
,
89 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 */
96 static double calc_nsecs_per_cycle(LttTracefile
* t
);
98 /* go to the next event */
99 static int ltt_seek_next_event(LttTracefile
*tf
);
101 void ltt_update_event_size(LttTracefile
*tf
);
104 /* Functions to parse system.xml file (using glib xml parser) */
105 static void parser_start_element (GMarkupParseContext __UNUSED__
*context
,
106 const gchar
*element_name
,
107 const gchar
**attribute_names
,
108 const gchar
**attribute_values
,
113 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
114 if(strcmp("system", element_name
)){
115 *error
= g_error_new(G_MARKUP_ERROR
,
117 "This is not system.xml file");
121 while(attribute_names
[i
]){
122 if(strcmp("node_name", attribute_names
[i
])==0){
123 des
->node_name
= g_strdup(attribute_values
[i
]);
124 }else if(strcmp("domainname", attribute_names
[i
])==0){
125 des
->domain_name
= g_strdup(attribute_values
[i
]);
126 }else if(strcmp("cpu", attribute_names
[i
])==0){
127 des
->nb_cpu
= atoi(attribute_values
[i
]);
128 }else if(strcmp("arch_size", attribute_names
[i
])==0){
129 if(strcmp(attribute_values
[i
],"LP32") == 0) des
->size
= LTT_LP32
;
130 else if(strcmp(attribute_values
[i
],"ILP32") == 0) des
->size
= LTT_ILP32
;
131 else if(strcmp(attribute_values
[i
],"LP64") == 0) des
->size
= LTT_LP64
;
132 else if(strcmp(attribute_values
[i
],"ILP64") == 0) des
->size
= LTT_ILP64
;
133 else if(strcmp(attribute_values
[i
],"UNKNOWN") == 0) des
->size
= LTT_UNKNOWN
;
134 }else if(strcmp("endian", attribute_names
[i
])==0){
135 if(strcmp(attribute_values
[i
],"LITTLE_ENDIAN") == 0)
136 des
->endian
= LTT_LITTLE_ENDIAN
;
137 else if(strcmp(attribute_values
[i
],"BIG_ENDIAN") == 0)
138 des
->endian
= LTT_BIG_ENDIAN
;
139 }else if(strcmp("kernel_name", attribute_names
[i
])==0){
140 des
->kernel_name
= g_strdup(attribute_values
[i
]);
141 }else if(strcmp("kernel_release", attribute_names
[i
])==0){
142 des
->kernel_release
= g_strdup(attribute_values
[i
]);
143 }else if(strcmp("kernel_version", attribute_names
[i
])==0){
144 des
->kernel_version
= g_strdup(attribute_values
[i
]);
145 }else if(strcmp("machine", attribute_names
[i
])==0){
146 des
->machine
= g_strdup(attribute_values
[i
]);
147 }else if(strcmp("processor", attribute_names
[i
])==0){
148 des
->processor
= g_strdup(attribute_values
[i
]);
149 }else if(strcmp("hardware_platform", attribute_names
[i
])==0){
150 des
->hardware_platform
= g_strdup(attribute_values
[i
]);
151 }else if(strcmp("operating_system", attribute_names
[i
])==0){
152 des
->operating_system
= g_strdup(attribute_values
[i
]);
153 }else if(strcmp("ltt_major_version", attribute_names
[i
])==0){
154 des
->ltt_major_version
= atoi(attribute_values
[i
]);
155 }else if(strcmp("ltt_minor_version", attribute_names
[i
])==0){
156 des
->ltt_minor_version
= atoi(attribute_values
[i
]);
157 }else if(strcmp("ltt_block_size", attribute_names
[i
])==0){
158 des
->ltt_block_size
= atoi(attribute_values
[i
]);
160 *error
= g_error_new(G_MARKUP_ERROR
,
162 "Not a valid attribute");
169 static void parser_characters (GMarkupParseContext __UNUSED__
*context
,
171 gsize __UNUSED__ text_len
,
173 GError __UNUSED__
**error
)
175 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
176 des
->description
= g_strdup(text
);
179 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
,
182 g_assert(num
< t
->facilities_by_num
->len
);
184 return &g_array_index(t
->facilities_by_num
, LttFacility
, num
);
188 guint
ltt_trace_get_num_cpu(LttTrace
*t
)
196 * Return value : 0 success, 1 bad tracefile
198 int parse_trace_header(void *header
, LttTracefile
*tf
, LttTrace
*t
)
200 guint32
*magic_number
= (guint32
*)header
;
201 struct ltt_trace_header_any
*any
= (struct ltt_trace_header_any
*)header
;
203 if(*magic_number
== LTT_MAGIC_NUMBER
)
205 else if(*magic_number
== LTT_REV_MAGIC_NUMBER
)
207 else /* invalid magic number, bad tracefile ! */
210 /* Get float byte order : might be different from int byte order
211 * (or is set to 0 if the trace has no float (kernel trace)) */
212 tf
->float_word_order
= any
->float_word_order
;
215 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
),
217 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
),
219 t
->arch_size
= any
->arch_size
;
220 t
->ltt_major_version
= any
->major_version
;
221 t
->ltt_minor_version
= any
->minor_version
;
222 t
->flight_recorder
= any
->flight_recorder
;
223 t
->has_heartbeat
= any
->has_heartbeat
;
224 t
->has_alignment
= any
->has_alignment
;
225 t
->has_tsc
= any
->has_tsc
;
229 switch(any
->major_version
) {
232 switch(any
->minor_version
) {
235 struct ltt_trace_header_0_3
*header_0_3
=
236 (struct ltt_trace_header_0_3
*)header
;
241 g_warning("Unsupported trace version : %hhu.%hhu",
242 any
->major_version
, any
->minor_version
);
248 g_warning("Unsupported trace version : %hhu.%hhu",
249 any
->major_version
, any
->minor_version
);
259 /*****************************************************************************
261 * ltt_tracefile_open : open a trace file, construct a LttTracefile
263 * t : the trace containing the tracefile
264 * fileName : path name of the trace file
265 * tf : the tracefile structure
267 * : 0 for success, -1 otherwise.
268 ****************************************************************************/
270 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
272 struct stat lTDFStat
; /* Trace data file status */
273 struct ltt_block_start_header
*header
;
274 int page_size
= getpagesize();
277 tf
->long_name
= g_quark_from_string(fileName
);
279 tf
->fd
= open(fileName
, O_RDONLY
);
281 g_warning("Unable to open input data file %s\n", fileName
);
285 // Get the file's status
286 if(fstat(tf
->fd
, &lTDFStat
) < 0){
287 g_warning("Unable to get the status of the input data file %s\n", fileName
);
291 // Is the file large enough to contain a trace
292 if(lTDFStat
.st_size
< (off_t
)(sizeof(struct ltt_block_start_header
))){
293 g_print("The input data file %s does not contain a trace\n", fileName
);
297 /* Temporarily map the buffer start header to get trace information */
298 /* Multiple of pages aligned head */
299 tf
->buffer
.head
= mmap(0,
300 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)), PROT_READ
,
301 MAP_PRIVATE
, tf
->fd
, 0);
302 if(tf
->buffer
.head
== MAP_FAILED
) {
303 perror("Error in allocating memory for buffer of tracefile");
306 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
308 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
310 if(parse_trace_header(header
->trace
, tf
, NULL
)) goto unmap_file
;
312 //store the size of the file
313 tf
->file_size
= lTDFStat
.st_size
;
314 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
315 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
317 if(munmap(tf
->buffer
.head
,
318 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)))) {
319 g_warning("unmap size : %u\n",
320 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
321 perror("munmap error");
324 tf
->buffer
.head
= NULL
;
326 //read the first block
327 if(map_block(tf
,0)) {
328 perror("Cannot map block for tracefile");
336 if(munmap(tf
->buffer
.head
,
337 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)))) {
338 g_warning("unmap size : %u\n",
339 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
340 perror("munmap error");
349 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
355 /*****************************************************************************
356 *Open control and per cpu tracefiles
357 ****************************************************************************/
359 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
362 tf
= ltt_tracefile_open(t
,tracefile_name
);
364 t
->per_cpu_tracefile_number
++;
365 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
368 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
377 tf
= ltt_tracefile_open(t
,control_name
);
379 g_warning("ltt_tracefile_open_control : bad file descriptor");
382 t
->control_tracefile_number
++;
383 g_ptr_array_add(t
->control_tracefiles
,tf
);
385 //parse facilities tracefile to get base_id
386 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
388 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
390 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
392 fLoad
.name
= (gchar
*)pos
;
393 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
394 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
396 for(i
=0;i
<t
->facility_number
;i
++){
397 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
398 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
399 f
->base_id
= fLoad
.base_code
;
403 if(i
==t
->facility_number
) {
404 g_warning("Facility: %s, checksum: %u is not found",
405 fLoad
.name
,(unsigned int)fLoad
.checksum
);
408 }else if(ev
.event_id
== TRACE_BLOCK_START
){
410 }else if(ev
.event_id
== TRACE_BLOCK_END
){
413 g_warning("Not valid facilities trace file");
422 /*****************************************************************************
424 * ltt_tracefile_close: close a trace file,
426 * t : tracefile which will be closed
427 ****************************************************************************/
429 void ltt_tracefile_close(LttTracefile
*t
)
431 int page_size
= getpagesize();
433 if(t
->buffer
.head
!= NULL
)
434 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
435 g_warning("unmap size : %u\n",
436 PAGE_ALIGN(t
->buf_size
));
437 perror("munmap error");
445 /*****************************************************************************
446 *Get system information
447 ****************************************************************************/
449 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
456 GMarkupParseContext
* context
;
457 GError
* error
= NULL
;
458 GMarkupParser markup_parser
=
460 parser_start_element
,
463 NULL
, /* passthrough */
467 fd
= g_open(pathname
, O_RDONLY
, 0);
469 g_warning("Can not open file : %s\n", pathname
);
473 iochan
= g_io_channel_unix_new(fd
);
475 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
477 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
478 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
479 != G_IO_STATUS_EOF
) {
482 g_warning("Can not read xml file: \n%s\n", error
->message
);
485 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
487 g_warning("Can not parse xml file: \n%s\n", error
->message
);
490 g_markup_parse_context_free(context
);
492 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
494 g_warning("Can not close file: \n%s\n", error
->message
);
502 g_markup_parse_context_free(context
);
504 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
506 g_warning("Can not close file: \n%s\n", error
->message
);
517 /*****************************************************************************
518 *The following functions get facility/tracefile information
519 ****************************************************************************/
521 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
528 gchar fullname
[DIR_NAME_SIZE
];
529 GError
* error
= NULL
;
531 dir
= g_dir_open(eventdefs
, 0, &error
);
534 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
539 while((name
= g_dir_read_name(dir
)) != NULL
){
540 if(!g_pattern_match_simple("*.xml", name
)) continue;
541 strcpy(fullname
,eventdefs
);
542 strcat(fullname
,name
);
543 ltt_facility_open(t
,fullname
);
547 for(j
=0;j
<t
->facility_number
;j
++){
548 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
549 for(i
=0; i
<f
->event_number
; i
++){
551 setFieldsOffset(NULL
, et
, NULL
, t
);
558 /*****************************************************************************
559 *A trace is specified as a pathname to the directory containing all the
560 *associated data (control tracefiles, per cpu tracefiles, event
563 *When a trace is closed, all the associated facilities, types and fields
564 *are released as well.
568 /****************************************************************************
569 * get_absolute_pathname
571 * return the unique pathname in the system
573 * MD : Fixed this function so it uses realpath, dealing well with
574 * forgotten cases (.. were not used correctly before).
576 ****************************************************************************/
577 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
579 abs_pathname
[0] = '\0';
581 if ( realpath (pathname
, abs_pathname
) != NULL
)
585 /* error, return the original path unmodified */
586 strcpy(abs_pathname
, pathname
);
592 /* Search for something like : .*_.*
594 * The left side is the name, the right side is the number.
597 int get_tracefile_name_number(const gchar
*raw_name
,
601 guint raw_name_len
= strlen(raw_name
);
602 gchar char_name
[PATH_MAX
];
608 for(i
=raw_name_len
-1;i
>=0;i
--) {
609 if(raw_name
[i
] == '_') break;
611 if(i
==0) /* Either not found or name length is 0 */
615 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
617 if(endptr
== raw_name
+underscore_pos
+1)
618 return -1; /* No digit */
619 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
620 return -1; /* underflow / overflow */
622 strncpy(char_name
, raw_name
, underscore_pos
);
624 char_name
[underscore_pos
] = '\0';
626 *name
= g_quark_from_string(char_name
);
633 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
635 return &trace
->tracefiles
;
639 void compute_tracefile_group(GQuark key_id
,
641 struct compute_tracefile_group_args
*args
)
646 for(i
=0; i
<group
->len
; i
++) {
647 tf
= &g_array_index (group
, LttTracefile
, i
);
649 args
->func(tf
, args
->func_args
);
654 void ltt_tracefile_group_destroy(gpointer data
)
656 GArray
*group
= (GArray
*)data
;
660 for(i
=0; i
<group
->len
; i
++) {
661 tf
= &g_array_index (group
, LttTracefile
, i
);
663 ltt_tracefile_close(tf
);
665 g_array_free(group
, TRUE
);
668 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
670 GArray
*group
= (GArray
*)data
;
674 for(i
=0; i
<group
->len
; i
++) {
675 tf
= &g_array_index (group
, LttTracefile
, i
);
676 if(tf
->cpu_online
) return 1;
682 /* Open each tracefile under a specific directory. Put them in a
683 * GData : permits to access them using their tracefile group pathname.
684 * i.e. access control/modules tracefile group by index :
687 * relative path is the path relative to the trace root
688 * root path is the full path
690 * A tracefile group is simply an array where all the per cpu tracefiles sits.
693 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
694 gchar
*relative_path
)
696 DIR *dir
= opendir(root_path
);
697 struct dirent
*entry
;
698 struct stat stat_buf
;
701 gchar path
[PATH_MAX
];
706 gchar rel_path
[PATH_MAX
];
715 strncpy(path
, root_path
, PATH_MAX
-1);
716 path_len
= strlen(path
);
717 path
[path_len
] = '/';
719 path_ptr
= path
+ path_len
;
721 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
722 rel_path_len
= strlen(rel_path
);
723 rel_path
[rel_path_len
] = '/';
725 rel_path_ptr
= rel_path
+ rel_path_len
;
727 while((entry
= readdir(dir
)) != NULL
) {
729 if(entry
->d_name
[0] == '.') continue;
731 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
732 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
734 ret
= stat(path
, &stat_buf
);
740 g_debug("Tracefile file or directory : %s\n", path
);
742 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
744 if(S_ISDIR(stat_buf
.st_mode
)) {
746 g_debug("Entering subdirectory...\n");
747 ret
= open_tracefiles(trace
, path
, rel_path
);
748 if(ret
< 0) continue;
749 } else if(S_ISREG(stat_buf
.st_mode
)) {
754 if(get_tracefile_name_number(rel_path
, &name
, &num
))
755 continue; /* invalid name */
757 g_debug("Opening file.\n");
758 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
759 g_info("Error opening tracefile %s", path
);
761 continue; /* error opening the tracefile : bad magic number ? */
764 g_debug("Tracefile name is %s and number is %u",
765 g_quark_to_string(name
), num
);
767 tmp_tf
.cpu_online
= 1;
768 tmp_tf
.cpu_num
= num
;
771 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
773 /* Elements are automatically cleared when the array is allocated.
774 * It makes the cpu_online variable set to 0 : cpu offline, by default.
776 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
777 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
778 group
, ltt_tracefile_group_destroy
);
781 /* Add the per cpu tracefile to the named group */
782 unsigned int old_len
= group
->len
;
784 group
= g_array_set_size(group
, num
+1);
785 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
795 /* ltt_get_facility_description
797 * Opens the trace corresponding to the requested facility (identified by fac_id
800 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
802 * Returns 0 on success, or 1 on failure.
805 static int ltt_get_facility_description(LttFacility
*f
,
807 LttTracefile
*fac_tf
)
809 char desc_file_name
[PATH_MAX
];
814 text
= g_quark_to_string(t
->pathname
);
815 textlen
= strlen(text
);
817 if(textlen
>= PATH_MAX
) goto name_error
;
818 strcpy(desc_file_name
, text
);
820 text
= "/eventdefs/";
821 textlen
+=strlen(text
);
822 if(textlen
>= PATH_MAX
) goto name_error
;
823 strcat(desc_file_name
, text
);
825 text
= g_quark_to_string(f
->name
);
826 textlen
+=strlen(text
);
827 if(textlen
>= PATH_MAX
) goto name_error
;
828 strcat(desc_file_name
, text
);
831 textlen
+=strlen(text
);
832 if(textlen
>= PATH_MAX
) goto name_error
;
833 strcat(desc_file_name
, text
);
835 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
837 if(err
< 0) goto name_error
;
839 textlen
=strlen(desc_file_name
);
842 textlen
+=strlen(text
);
843 if(textlen
>= PATH_MAX
) goto name_error
;
844 strcat(desc_file_name
, text
);
846 err
= ltt_facility_open(f
, t
, desc_file_name
);
847 if(err
) goto facility_error
;
856 static void ltt_fac_ids_destroy(gpointer data
)
858 GArray
*fac_ids
= (GArray
*)data
;
860 g_array_free(fac_ids
, TRUE
);
864 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
865 * because it must be done just after the opening */
866 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
875 err
= ltt_tracefile_read_seek(tf
);
876 if(err
== EPERM
) goto seek_error
;
877 else if(err
== ERANGE
) break; /* End of tracefile */
879 err
= ltt_tracefile_read_update_event(tf
);
880 if(err
) goto update_error
;
882 /* We are on a facility load/or facility unload/ or heartbeat event */
884 * * facility 0 is hardcoded : this is the core facility. It will be shown
885 * in the facility array though, and is shown as "loaded builtin" in the
887 * It contains event :
889 * 1 : facility unload
890 * 2 : state dump facility load
893 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
894 /* Should only contain core facility */
895 g_warning("Error in processing facility file %s, "
896 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
897 tf
->event
.facility_id
);
902 struct LttFacilityLoad
*fac_load_data
;
903 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
907 switch((enum ltt_core_events
)tf
->event
.event_id
) {
908 case LTT_EVENT_FACILITY_LOAD
:
909 fac_name
= (char*)(tf
->event
.data
);
910 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
913 (struct LttFacilityLoad
*)
914 (tf
->event
.data
+ strlen(fac_name
) + 1);
915 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
916 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
917 g_assert(fac
->exists
== 0);
918 fac
->name
= g_quark_from_string(fac_name
);
919 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
920 &fac_load_data
->checksum
);
921 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
922 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
923 &fac_load_data
->pointer_size
);
924 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
925 &fac_load_data
->long_size
);
926 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
927 &fac_load_data
->size_t_size
);
928 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
929 &fac_load_data
->alignment
);
931 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
932 continue; /* error opening description */
934 fac
->trace
= tf
->trace
;
936 /* Preset the field offsets */
937 for(i
=0; i
<fac
->events
->len
; i
++){
938 et
= &g_array_index(fac
->events
, LttEventType
, i
);
939 set_fields_offsets(tf
, et
);
944 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
946 if(fac_ids
== NULL
) {
947 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
948 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
950 fac_ids
, ltt_fac_ids_destroy
);
952 g_array_append_val(fac_ids
, fac
->id
);
955 case LTT_EVENT_FACILITY_UNLOAD
:
956 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
957 /* We don't care about unload : facilities ID are valid for the whole
958 * trace. They simply won't be used after the unload. */
960 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
961 fac_name
= (char*)(tf
->event
.data
);
962 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
964 fac_state_dump_load_data
=
965 (struct LttStateDumpFacilityLoad
*)
966 (tf
->event
.data
+ strlen(fac_name
) + 1);
967 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
968 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
969 g_assert(fac
->exists
== 0);
970 fac
->name
= g_quark_from_string(fac_name
);
971 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
972 &fac_state_dump_load_data
->checksum
);
973 fac
->id
= fac_state_dump_load_data
->id
;
974 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
975 &fac_state_dump_load_data
->pointer_size
);
976 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
977 &fac_state_dump_load_data
->long_size
);
978 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
979 &fac_state_dump_load_data
->size_t_size
);
980 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
981 &fac_state_dump_load_data
->alignment
);
982 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
983 continue; /* error opening description */
985 fac
->trace
= tf
->trace
;
987 /* Preset the field offsets */
988 for(i
=0; i
<fac
->events
->len
; i
++){
989 et
= &g_array_index(fac
->events
, LttEventType
, i
);
990 set_fields_offsets(tf
, et
);
995 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
997 if(fac_ids
== NULL
) {
998 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
999 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1001 fac_ids
, ltt_fac_ids_destroy
);
1003 g_array_append_val(fac_ids
, fac
->id
);
1006 case LTT_EVENT_HEARTBEAT
:
1009 g_warning("Error in processing facility file %s, "
1010 "unknown event id %hhu in core facility.",
1011 g_quark_to_string(tf
->name
),
1012 tf
->event
.event_id
);
1014 goto event_id_error
;
1020 /* Error handling */
1025 g_warning("An error occured in facility tracefile parsing");
1030 LttTrace
*ltt_trace_open(const gchar
*pathname
)
1032 gchar abs_path
[PATH_MAX
];
1037 struct ltt_block_start_header
*header
;
1039 struct dirent
*entry
;
1040 guint control_found
= 0;
1041 guint eventdefs_found
= 0;
1042 struct stat stat_buf
;
1043 gchar path
[PATH_MAX
];
1045 t
= g_new(LttTrace
, 1);
1046 if(!t
) goto alloc_error
;
1048 get_absolute_pathname(pathname
, abs_path
);
1049 t
->pathname
= g_quark_from_string(abs_path
);
1051 g_datalist_init(&t
->tracefiles
);
1053 /* Test to see if it looks like a trace */
1054 dir
= opendir(abs_path
);
1059 while((entry
= readdir(dir
)) != NULL
) {
1060 strcpy(path
, abs_path
);
1062 strcat(path
, entry
->d_name
);
1063 ret
= stat(path
, &stat_buf
);
1068 if(S_ISDIR(stat_buf
.st_mode
)) {
1069 if(strcmp(entry
->d_name
, "control") == 0) {
1072 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1073 eventdefs_found
= 1;
1079 if(!control_found
|| !eventdefs_found
) goto find_error
;
1081 /* Open all the tracefiles */
1082 if(open_tracefiles(t
, abs_path
, "")) {
1083 g_warning("Error opening tracefile %s", abs_path
);
1087 /* Prepare the facilities containers : array and mapping */
1088 /* Array is zeroed : the "exists" field is set to false by default */
1089 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1090 TRUE
, sizeof(LttFacility
),
1092 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1094 g_datalist_init(&t
->facilities_by_name
);
1096 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1097 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1099 g_error("Trace %s has no facility tracefile", abs_path
);
1101 goto facilities_error
;
1104 /* Get the trace information for the control/facility 0 tracefile */
1105 g_assert(group
->len
> 0);
1106 tf
= &g_array_index (group
, LttTracefile
, 0);
1107 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1108 g_assert(parse_trace_header(header
->trace
, tf
, t
) == 0);
1110 t
->num_cpu
= group
->len
;
1112 for(i
=0; i
<group
->len
; i
++) {
1113 tf
= &g_array_index (group
, LttTracefile
, i
);
1114 if(ltt_process_facility_tracefile(tf
))
1115 goto facilities_error
;
1120 /* Error handling */
1122 g_datalist_clear(&t
->facilities_by_name
);
1123 g_array_free(t
->facilities_by_num
, TRUE
);
1125 g_datalist_clear(&t
->tracefiles
);
1133 GQuark
ltt_trace_name(const LttTrace
*t
)
1139 /******************************************************************************
1140 * When we copy a trace, we want all the opening actions to happen again :
1141 * the trace will be reopened and totally independant from the original.
1142 * That's why we call ltt_trace_open.
1143 *****************************************************************************/
1144 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1146 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1149 void ltt_trace_close(LttTrace
*t
)
1154 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1155 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1157 ltt_facility_close(fac
);
1160 g_datalist_clear(&t
->facilities_by_name
);
1161 g_array_free(t
->facilities_by_num
, TRUE
);
1162 g_datalist_clear(&t
->tracefiles
);
1167 /*****************************************************************************
1168 *Get the system description of the trace
1169 ****************************************************************************/
1171 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1173 g_assert(id
< t
->facilities_by_num
->len
);
1174 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1177 /* ltt_trace_facility_get_by_name
1179 * Returns the GArray of facility indexes. All the fac_ids that matches the
1180 * requested facility name.
1182 * If name is not found, returns NULL.
1184 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1186 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1189 /*****************************************************************************
1190 * Functions to discover all the event types in the trace
1191 ****************************************************************************/
1194 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1198 unsigned int num
= t
->facility_number
;
1202 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1203 count
+= f
->event_number
;
1210 //use an iteration on all the trace facilities, and inside iteration on all the
1211 //event types in each facilities instead.
1212 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1214 LttEventType
*event_type
;
1217 f
= ltt_trace_facility_by_id(t
,evId
);
1219 if(unlikely(!f
)) event_type
= NULL
;
1220 else event_type
= f
->events
[evId
- f
->base_id
];
1227 /*****************************************************************************
1228 * ltt_trace_find_tracefile
1230 * Find a tracefile by name and index in the group.
1232 * Returns a pointer to the tracefiles, else NULL.
1233 ****************************************************************************/
1235 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1240 /*****************************************************************************
1241 * Get the start time and end time of the trace
1242 ****************************************************************************/
1244 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1245 LttTime
*start
, LttTime
*end
)
1249 err
= map_block(tf
, 0);
1251 g_error("Can not map block");
1252 *start
= ltt_time_infinite
;
1254 *start
= tf
->buffer
.begin
.timestamp
;
1256 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1258 g_error("Can not map block");
1259 *end
= ltt_time_zero
;
1261 *end
= tf
->buffer
.end
.timestamp
;
1264 struct tracefile_time_span_get_args
{
1270 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1272 struct tracefile_time_span_get_args
*args
=
1273 (struct tracefile_time_span_get_args
*)user_data
;
1275 GArray
*group
= (GArray
*)data
;
1281 for(i
=0; i
<group
->len
; i
++) {
1282 tf
= &g_array_index (group
, LttTracefile
, i
);
1283 if(tf
->cpu_online
) {
1284 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1285 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1286 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1291 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1293 LttTime min_start
= ltt_time_infinite
;
1294 LttTime max_end
= ltt_time_zero
;
1295 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1297 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1299 if(start
!= NULL
) *start
= min_start
;
1300 if(end
!= NULL
) *end
= max_end
;
1305 /*****************************************************************************
1306 *Get the name of a tracefile
1307 ****************************************************************************/
1309 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1315 guint
ltt_tracefile_num(LttTracefile
*tf
)
1320 /*****************************************************************************
1321 * Get the number of blocks in the tracefile
1322 ****************************************************************************/
1324 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1326 return tf
->num_blocks
;
1330 /* Seek to the first event in a tracefile that has a time equal or greater than
1331 * the time passed in parameter.
1333 * If the time parameter is outside the tracefile time span, seek to the first
1334 * event or if after, return ERANGE.
1336 * If the time parameter is before the first event, we have to seek specially to
1339 * If the time is after the end of the trace, return ERANGE.
1341 * Do a binary search to find the right block, then a sequential search in the
1342 * block to find the event.
1344 * In the special case where the time requested fits inside a block that has no
1345 * event corresponding to the requested time, the first event of the next block
1348 * IMPORTANT NOTE : // FIXME everywhere...
1350 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1351 * you will jump over an event if you do.
1353 * Return value : 0 : no error, the tf->event can be used
1354 * ERANGE : time if after the last event of the trace
1355 * otherwise : this is an error.
1359 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1363 unsigned int block_num
, high
, low
;
1365 /* seek at the beginning of trace */
1366 err
= map_block(tf
, 0); /* First block */
1368 g_error("Can not map block");
1372 /* If the time is lower or equal the beginning of the trace,
1373 * go to the first event. */
1374 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1375 ret
= ltt_tracefile_read(tf
);
1376 if(ret
== ERANGE
) goto range
;
1377 else if (ret
) goto fail
;
1378 goto found
; /* There is either no event in the trace or the event points
1379 to the first event in the trace */
1382 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1384 g_error("Can not map block");
1388 /* If the time is after the end of the trace, return ERANGE. */
1389 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1393 /* Binary search the block */
1394 high
= tf
->num_blocks
- 1;
1398 block_num
= ((high
-low
) / 2) + low
;
1400 err
= map_block(tf
, block_num
);
1402 g_error("Can not map block");
1406 /* We cannot divide anymore : this is what would happen if the time
1407 * requested was exactly between two consecutive buffers'end and start
1408 * timestamps. This is also what would happend if we didn't deal with out
1409 * of span cases prior in this function. */
1410 /* The event is right in the buffer!
1411 * (or in the next buffer first event) */
1413 ret
= ltt_tracefile_read(tf
);
1414 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1415 else if(ret
) goto fail
;
1417 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1421 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1422 /* go to lower part */
1424 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1425 /* go to higher part */
1427 } else {/* The event is right in the buffer!
1428 (or in the next buffer first event) */
1430 ret
= ltt_tracefile_read(tf
);
1431 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1432 else if(ret
) goto fail
;
1434 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1446 /* Error handling */
1448 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1449 g_quark_to_string(tf
->name
));
1454 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1458 if(ep
->tracefile
!= tf
) {
1462 err
= map_block(tf
, ep
->block
);
1464 g_error("Can not map block");
1468 tf
->event
.offset
= ep
->offset
;
1470 err
= ltt_tracefile_read_update_event(tf
);
1472 err
= ltt_tracefile_read_op(tf
);
1478 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1479 g_quark_to_string(tf
->name
));
1483 /* Calculate the real event time based on the buffer boundaries */
1484 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1488 g_assert(tf
->trace
->has_tsc
);
1490 time
= ltt_time_from_uint64(
1491 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1492 tf
->buffer
.nsecs_per_cycle
);
1493 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1499 /* Get the current event of the tracefile : valid until the next read */
1500 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1507 /*****************************************************************************
1509 * ltt_tracefile_read : Read the next event in the tracefile
1514 * Returns 0 if an event can be used in tf->event.
1515 * Returns ERANGE on end of trace. The event in tf->event still can be used
1516 * (if the last block was not empty).
1517 * Returns EPERM on error.
1519 * This function does make the tracefile event structure point to the event
1520 * currently pointed to by the tf->event.
1522 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1523 * reinitialize it after an error if you want results to be coherent.
1524 * It would be the case if a end of trace last buffer has no event : the end
1525 * of trace wouldn't be returned, but an error.
1526 * We make the assumption there is at least one event per buffer.
1527 ****************************************************************************/
1529 int ltt_tracefile_read(LttTracefile
*tf
)
1533 err
= ltt_tracefile_read_seek(tf
);
1535 err
= ltt_tracefile_read_update_event(tf
);
1537 err
= ltt_tracefile_read_op(tf
);
1543 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1547 /* Get next buffer until we finally have an event, or end of trace */
1549 err
= ltt_seek_next_event(tf
);
1550 if(unlikely(err
== ENOPROTOOPT
)) {
1554 /* Are we at the end of the buffer ? */
1556 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1559 /* get next block */
1560 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1562 g_error("Can not map block");
1566 } else break; /* We found an event ! */
1573 /* do specific operation on events */
1574 int ltt_tracefile_read_op(LttTracefile
*tf
)
1580 /* do event specific operation */
1582 /* do something if its an heartbeat event : increment the heartbeat count */
1583 //if(event->facility_id == LTT_FACILITY_CORE)
1584 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1585 // tf->cur_heart_beat_number++;
1591 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1592 * event specific operation. */
1593 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1599 pos
= tf
->buffer
.head
+ event
->offset
;
1601 /* Read event header */
1605 if(tf
->trace
->has_tsc
) {
1606 if(tf
->trace
->has_heartbeat
) {
1607 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1609 /* 32 bits -> 64 bits tsc */
1610 /* note : still works for seek and non seek cases. */
1611 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1612 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1614 | (guint64
)event
->time
.timestamp
;
1615 event
->tsc
= tf
->buffer
.tsc
;
1618 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1619 | (guint64
)event
->time
.timestamp
;
1620 event
->tsc
= tf
->buffer
.tsc
;
1622 pos
+= sizeof(guint32
);
1624 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1625 tf
->buffer
.tsc
= event
->tsc
;
1626 pos
+= sizeof(guint64
);
1629 event
->event_time
= ltt_interpolate_time(tf
, event
);
1631 event
->time
.delta
.tv_sec
= 0;
1632 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1633 pos
) * NSEC_PER_USEC
;
1635 event
->tsc
= tf
->buffer
.tsc
;
1637 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1639 pos
+= sizeof(guint32
);
1642 event
->facility_id
= *(guint8
*)pos
;
1643 pos
+= sizeof(guint8
);
1645 event
->event_id
= *(guint8
*)pos
;
1646 pos
+= sizeof(guint8
);
1648 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1649 pos
+= sizeof(guint16
);
1653 /* get the data size and update the event fields with the current
1655 ltt_update_event_size(tf
);
1661 /****************************************************************************
1663 * map_block : map a block from the file
1665 * lttdes : ltt trace file
1666 * whichBlock : the block which will be read
1669 * EINVAL : lseek fail
1670 * EIO : can not read from the file
1671 ****************************************************************************/
1673 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1675 int page_size
= getpagesize();
1676 struct ltt_block_start_header
*header
;
1678 g_assert(block_num
< tf
->num_blocks
);
1680 if(tf
->buffer
.head
!= NULL
) {
1681 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1682 g_warning("unmap size : %u\n",
1683 PAGE_ALIGN(tf
->buf_size
));
1684 perror("munmap error");
1690 /* Multiple of pages aligned head */
1691 tf
->buffer
.head
= mmap(0,
1692 PAGE_ALIGN(tf
->buf_size
),
1693 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1694 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1696 if(tf
->buffer
.head
== MAP_FAILED
) {
1697 perror("Error in allocating memory for buffer of tracefile");
1701 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1704 tf
->buffer
.index
= block_num
;
1706 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1708 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1709 &header
->begin
.timestamp
);
1710 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1711 g_debug("block %u begin : %lu.%lu", block_num
,
1712 tf
->buffer
.begin
.timestamp
.tv_sec
, tf
->buffer
.begin
.timestamp
.tv_nsec
);
1713 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1714 &header
->begin
.cycle_count
);
1715 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1716 &header
->end
.timestamp
);
1717 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1718 g_debug("block %u end : %lu.%lu", block_num
,
1719 tf
->buffer
.end
.timestamp
.tv_sec
, tf
->buffer
.end
.timestamp
.tv_nsec
);
1720 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1721 &header
->end
.cycle_count
);
1722 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1723 &header
->lost_size
);
1725 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1726 tf
->event
.tsc
= tf
->buffer
.tsc
;
1729 * eventually support variable buffer size : will need a partial pre-read of
1730 * the headers to create an index when we open the trace... eventually. */
1731 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1732 &header
->buf_size
));
1734 /* Now that the buffer is mapped, calculate the time interpolation for the
1737 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1739 /* Make the current event point to the beginning of the buffer :
1740 * it means that the event read must get the first event. */
1741 tf
->event
.tracefile
= tf
;
1742 tf
->event
.block
= block_num
;
1743 tf
->event
.offset
= 0;
1752 /* It will update the fields offsets too */
1753 void ltt_update_event_size(LttTracefile
*tf
)
1757 /* Specific handling of core events : necessary to read the facility control
1759 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1760 tf
->event
.facility_id
);
1762 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1763 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1764 case LTT_EVENT_FACILITY_LOAD
:
1765 size
= strlen((char*)tf
->event
.data
) + 1;
1766 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1767 size
+= sizeof(struct LttFacilityLoad
);
1769 case LTT_EVENT_FACILITY_UNLOAD
:
1770 g_debug("Update Event facility unload");
1771 size
= sizeof(struct LttFacilityUnload
);
1773 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1774 size
= strlen((char*)tf
->event
.data
) + 1;
1775 g_debug("Update Event facility load state dump of facility %s",
1776 (char*)tf
->event
.data
);
1777 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1779 case LTT_EVENT_HEARTBEAT
:
1780 g_debug("Update Event heartbeat");
1781 size
= sizeof(TimeHeartbeat
);
1784 g_warning("Error in getting event size : tracefile %s, "
1785 "unknown event id %hhu in core facility.",
1786 g_quark_to_string(tf
->name
),
1787 tf
->event
.event_id
);
1788 goto event_id_error
;
1793 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1794 tf
->event
.facility_id
,
1795 tf
->event
.facility_id
,
1796 g_quark_to_string(tf
->name
));
1797 goto facility_error
;
1800 LttEventType
*event_type
=
1801 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1804 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1806 g_quark_to_string(f
->name
),
1807 g_quark_to_string(tf
->name
));
1808 goto event_type_error
;
1811 if(event_type
->root_field
)
1812 size
= get_field_type_size(tf
, event_type
,
1813 0, 0, event_type
->root_field
, tf
->event
.data
);
1817 g_debug("Event root field : f.e %hhu.%hhu size %zd",
1818 tf
->event
.facility_id
,
1819 tf
->event
.event_id
, size
);
1822 tf
->event
.data_size
= size
;
1824 /* Check consistency between kernel and LTTV structure sizes */
1825 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1832 tf
->event
.data_size
= 0;
1836 /* Take the tf current event offset and use the event facility id and event id
1837 * to figure out where is the next event offset.
1839 * This is an internal function not aiming at being used elsewhere : it will
1840 * not jump over the current block limits. Please consider using
1841 * ltt_tracefile_read to do this.
1843 * Returns 0 on success
1844 * ERANGE if we are at the end of the buffer.
1845 * ENOPROTOOPT if an error occured when getting the current event size.
1847 static int ltt_seek_next_event(LttTracefile
*tf
)
1852 /* seek over the buffer header if we are at the buffer start */
1853 if(tf
->event
.offset
== 0) {
1854 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
);
1856 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1863 pos
= tf
->event
.data
;
1865 if(tf
->event
.data_size
< 0) goto error
;
1867 pos
+= (size_t)tf
->event
.data_size
;
1869 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1871 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1880 g_error("Error in ltt_seek_next_event for tracefile %s",
1881 g_quark_to_string(tf
->name
));
1886 /*****************************************************************************
1888 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1891 ****************************************************************************/
1893 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1895 LttTime lBufTotalTime
; /* Total time for this buffer */
1896 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1897 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1899 /* Calculate the total time for this buffer */
1900 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1901 tf
->buffer
.begin
.timestamp
);
1903 /* Calculate the total cycles for this bufffer */
1904 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1905 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1907 /* Convert the total time to double */
1908 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1910 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1914 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1916 LttField
* rootFld
= evT
->root_field
;
1917 // rootFld->base_address = evD;
1920 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1921 evT
, 0,0,rootFld
, evD
);
1925 /*****************************************************************************
1927 * set_fields_offsets : set the precomputable offset of the fields
1929 * tracefile : opened trace file
1930 * event_type : the event type
1931 ****************************************************************************/
1933 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1935 LttField
*field
= event_type
->root_field
;
1936 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1939 preset_field_type_size(tf
, event_type
, 0, 0,
1940 &fixed_root
, &fixed_parent
,
1946 /*****************************************************************************
1948 * preset_field_type_size : set the fixed sizes of the field type
1951 * event_type : event type
1952 * offset_root : offset from the root
1953 * offset_parent : offset from the parent
1954 * fixed_root : Do we know a fixed offset to the root ?
1955 * fixed_parent : Do we know a fixed offset to the parent ?
1957 ****************************************************************************/
1958 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1959 off_t offset_root
, off_t offset_parent
,
1960 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1963 enum field_status local_fixed_root
, local_fixed_parent
;
1967 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1968 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1969 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1971 type
= field
->field_type
;
1973 field
->fixed_root
= *fixed_root
;
1974 if(field
->fixed_root
== FIELD_FIXED
)
1975 field
->offset_root
= offset_root
;
1977 field
->offset_root
= 0;
1979 field
->fixed_parent
= *fixed_parent
;
1980 if(field
->fixed_parent
== FIELD_FIXED
)
1981 field
->offset_parent
= offset_parent
;
1983 field
->offset_parent
= 0;
1985 size_t current_root_offset
;
1986 size_t current_offset
;
1987 enum field_status current_child_status
, final_child_status
;
1990 switch(type
->type_class
) {
1995 field
->field_size
= ltt_type_size(tf
->trace
, type
);
1996 field
->fixed_size
= FIELD_FIXED
;
1999 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2000 field
->fixed_size
= FIELD_FIXED
;
2004 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2005 field
->fixed_size
= FIELD_FIXED
;
2010 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2011 field
->fixed_size
= FIELD_FIXED
;
2014 local_fixed_root
= FIELD_VARIABLE
;
2015 local_fixed_parent
= FIELD_VARIABLE
;
2016 preset_field_type_size(tf
, event_type
,
2018 &local_fixed_root
, &local_fixed_parent
,
2020 field
->fixed_size
= FIELD_VARIABLE
;
2021 field
->field_size
= 0;
2022 *fixed_root
= FIELD_VARIABLE
;
2023 *fixed_parent
= FIELD_VARIABLE
;
2026 field
->fixed_size
= FIELD_VARIABLE
;
2027 field
->field_size
= 0;
2028 *fixed_root
= FIELD_VARIABLE
;
2029 *fixed_parent
= FIELD_VARIABLE
;
2032 local_fixed_root
= FIELD_VARIABLE
;
2033 local_fixed_parent
= FIELD_VARIABLE
;
2034 preset_field_type_size(tf
, event_type
,
2036 &local_fixed_root
, &local_fixed_parent
,
2038 field
->fixed_size
= field
->child
[0]->fixed_size
;
2039 if(field
->fixed_size
== FIELD_FIXED
) {
2040 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2042 field
->field_size
= 0;
2043 *fixed_root
= FIELD_VARIABLE
;
2044 *fixed_parent
= FIELD_VARIABLE
;
2048 current_root_offset
= field
->offset_root
;
2050 current_child_status
= FIELD_FIXED
;
2051 for(i
=0;i
<type
->element_number
;i
++) {
2052 preset_field_type_size(tf
, event_type
,
2053 current_root_offset
, current_offset
,
2054 fixed_root
, ¤t_child_status
,
2056 if(current_child_status
== FIELD_FIXED
) {
2057 current_root_offset
+= field
->child
[i
]->field_size
;
2058 current_offset
+= field
->child
[i
]->field_size
;
2060 current_root_offset
= 0;
2064 if(current_child_status
!= FIELD_FIXED
) {
2065 *fixed_parent
= current_child_status
;
2066 field
->field_size
= 0;
2067 field
->fixed_size
= current_child_status
;
2069 field
->field_size
= current_offset
;
2070 field
->fixed_size
= FIELD_FIXED
;
2074 current_root_offset
= field
->offset_root
;
2077 final_child_status
= FIELD_FIXED
;
2078 for(i
=0;i
<type
->element_number
;i
++) {
2079 enum field_status current_root_child_status
= FIELD_FIXED
;
2080 enum field_status current_child_status
= FIELD_FIXED
;
2081 preset_field_type_size(tf
, event_type
,
2082 current_root_offset
, current_offset
,
2083 ¤t_root_child_status
, ¤t_child_status
,
2085 if(current_child_status
!= FIELD_FIXED
)
2086 final_child_status
= current_child_status
;
2088 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2090 if(final_child_status
!= FIELD_FIXED
) {
2091 *fixed_root
= final_child_status
;
2092 *fixed_parent
= final_child_status
;
2093 field
->field_size
= 0;
2094 field
->fixed_size
= current_child_status
;
2096 field
->field_size
= max_size
;
2097 field
->fixed_size
= FIELD_FIXED
;
2105 /*****************************************************************************
2107 * check_fields_compatibility : Check for compatibility between two fields :
2108 * do they use the same inner structure ?
2110 * event_type1 : event type
2111 * event_type2 : event type
2114 *Returns : 0 if identical
2116 ****************************************************************************/
2117 gint
check_fields_compatibility(LttEventType
*event_type1
,
2118 LttEventType
*event_type2
,
2119 LttField
*field1
, LttField
*field2
)
2121 guint different
= 0;
2126 if(field1
== NULL
) {
2127 if(field2
== NULL
) goto end
;
2132 } else if(field2
== NULL
) {
2137 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2138 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2139 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2140 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2141 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2142 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2144 type1
= field1
->field_type
;
2145 type2
= field2
->field_type
;
2147 if(type1
->type_class
!= type2
->type_class
) {
2151 if(type1
->element_name
!= type2
->element_name
) {
2156 switch(type1
->type_class
) {
2166 if(field1
->field_size
!= field2
->field_size
) {
2172 if(type1
->element_number
!= type2
->element_number
) {
2176 for(i
=0;i
<type1
->element_number
;i
++) {
2177 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2184 /* Two elements : size and child */
2185 g_assert(type1
->element_number
!= type2
->element_number
);
2186 for(i
=0;i
<type1
->element_number
;i
++) {
2187 if(check_fields_compatibility(event_type1
, event_type2
,
2188 field1
->child
[0], field2
->child
[0])) {
2197 if(field1
->field_size
!= field2
->field_size
) {
2201 /* Two elements : size and child */
2202 g_assert(type1
->element_number
!= type2
->element_number
);
2203 for(i
=0;i
<type1
->element_number
;i
++) {
2204 if(check_fields_compatibility(event_type1
, event_type2
,
2205 field1
->child
[0], field2
->child
[0])) {
2213 if(type1
->element_number
!= type2
->element_number
) {
2217 for(i
=0;i
<type1
->element_number
;i
++) {
2218 if(check_fields_compatibility(event_type1
, event_type2
,
2219 field1
->child
[0], field2
->child
[0])) {
2234 /*****************************************************************************
2236 * getFieldtypeSize: get the size of the field type (primitive type)
2239 * offsetRoot : offset from the root
2240 * offsetParent : offset from the parrent
2242 * evD : event data, it may be NULL
2244 * int : size of the field
2245 ****************************************************************************/
2247 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2248 LttEventType
* evT
, gint offsetRoot
,
2249 gint offsetParent
, LttField
* fld
, void *evD
)
2251 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2252 LttType
* type
= fld
->field_type
;
2254 /* This likely has been tested with gcov : half of them.. */
2255 if(unlikely(fld
->field_fixed
== 1)){
2257 if(unlikely(fld
== evT
->root_field
)) {
2258 size
= fld
->field_size
;
2259 goto end_getFieldtypeSize
;
2263 /* From gcov profiling : half string, half struct, can we gain something
2264 * from that ? (Mathieu) */
2265 switch(type
->type_class
) {
2267 element_number
= (int) type
->element_number
;
2268 if(fld
->field_fixed
== -1){
2269 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2270 0,fld
->child
[0], NULL
);
2271 if(size
== 0){ //has string or sequence
2272 fld
->field_fixed
= 0;
2274 fld
->field_fixed
= 1;
2275 size
*= element_number
;
2277 }else if(fld
->field_fixed
== 0){// has string or sequence
2279 for(i
=0;i
<element_number
;i
++){
2280 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2281 fld
->child
[0], evD
+size
);
2283 }else size
= fld
->field_size
;
2285 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2286 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2292 size1
= (int) ltt_type_size(fac
, type
);
2293 if(fld
->field_fixed
== -1){
2294 fld
->sequ_number_size
= size1
;
2295 fld
->field_fixed
= 0;
2296 size
= getFieldtypeSize(evT
, offsetRoot
,
2297 0,fld
->child
[0], NULL
);
2298 fld
->element_size
= size
;
2300 element_number
= getIntNumber(tf
,size1
,evD
);
2301 type
->element_number
= element_number
;
2302 if(fld
->element_size
> 0){
2303 size
= element_number
* fld
->element_size
;
2304 }else{//sequence has string or sequence
2306 for(i
=0;i
<element_number
;i
++){
2307 size
+= getFieldtypeSize(tf
, evT
,
2308 offsetRoot
+size
+size1
,size
+size1
,
2309 fld
->child
[0], evD
+size
+size1
);
2315 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2316 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2323 if(fld
->field_fixed
== -1){
2324 fld
->field_fixed
= 0;
2326 /* Hope my implementation is faster than strlen (Mathieu) */
2327 char *ptr
=(char*)evD
;
2329 /* from gcov : many many strings are empty, make it the common case.*/
2330 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2331 //size = ptr - (char*)evD + 1; //include end : '\0'
2333 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2334 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2339 element_number
= (int) type
->element_number
;
2341 /* tested with gcov */
2342 if(unlikely(fld
->field_fixed
== -1)){
2343 offset1
= offsetRoot
;
2345 for(i
=0;i
<element_number
;i
++){
2346 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2347 fld
->child
[i
], NULL
);
2348 if(likely(size1
> 0 && size
>= 0)){
2350 if(likely(offset1
>= 0)) offset1
+= size1
;
2358 if(unlikely(size
== -1)){
2359 fld
->field_fixed
= 0;
2361 }else fld
->field_fixed
= 1;
2362 }else if(likely(fld
->field_fixed
== 0)){
2363 offset1
= offsetRoot
;
2365 for(i
=0;unlikely(i
<element_number
);i
++){
2366 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2367 fld
->child
[i
], evD
+offset2
);
2372 }else size
= fld
->field_size
;
2373 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2374 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2378 if(unlikely(fld
->field_fixed
== -1)){
2379 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2380 fld
->field_fixed
= 1;
2381 }else size
= fld
->field_size
;
2383 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2384 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2389 fld
->offset_root
= offsetRoot
;
2390 fld
->offset_parent
= offsetParent
;
2391 fld
->field_size
= size
;
2393 end_getFieldtypeSize
:
2399 /*****************************************************************************
2401 * ltt_get_int : get an integer number
2403 * reverse_byte_order: must we reverse the byte order ?
2404 * size : the size of the integer
2405 * ptr : the data pointer
2407 * gint64 : a 64 bits integer
2408 ****************************************************************************/
2410 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2415 case 1: val
= *((gint8
*)data
); break;
2416 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2417 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2418 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2419 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2420 g_critical("get_int : integer size %d unknown", size
);
2427 /*****************************************************************************
2429 * ltt_get_uint : get an unsigned integer number
2431 * reverse_byte_order: must we reverse the byte order ?
2432 * size : the size of the integer
2433 * ptr : the data pointer
2435 * guint64 : a 64 bits unsigned integer
2436 ****************************************************************************/
2438 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2443 case 1: val
= *((gint8
*)data
); break;
2444 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2445 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2446 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2447 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2448 g_critical("get_uint : unsigned integer size %d unknown",
2457 /* get the node name of the system */
2459 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2461 return s
->node_name
;
2465 /* get the domain name of the system */
2467 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2469 return s
->domain_name
;
2473 /* get the description of the system */
2475 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2477 return s
->description
;
2481 /* get the start time of the trace */
2483 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2485 return s
->trace_start
;
2489 LttTracefile
*ltt_tracefile_new()
2491 return g_new(LttTracefile
, 1);
2494 void ltt_tracefile_destroy(LttTracefile
*tf
)
2499 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2504 /* Before library loading... */
2506 static void __attribute__((constructor
)) init(void)
2508 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2509 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2511 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");