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 /* obtain the time of an event */
81 static inline LttTime
getEventTime(LttTracefile
* tf
);
84 /* set the offset of the fields belonging to the event,
85 need the information of the archecture */
86 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
);
87 //size_t get_fields_offsets(LttTracefile *tf, LttEventType *event_type, void *data);
89 /* get the size of the field type according to
90 * The facility size information. */
91 static inline void preset_field_type_size(LttTracefile
*tf
,
92 LttEventType
*event_type
,
93 off_t offset_root
, off_t offset_parent
,
94 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
97 /* map a fixed size or a block information from the file (fd) */
98 static gint
map_block(LttTracefile
* tf
, guint block_num
);
100 /* calculate nsec per cycles for current block */
101 static double calc_nsecs_per_cycle(LttTracefile
* t
);
103 /* go to the next event */
104 static int ltt_seek_next_event(LttTracefile
*tf
);
106 void ltt_update_event_size(LttTracefile
*tf
);
109 /* Functions to parse system.xml file (using glib xml parser) */
110 static void parser_start_element (GMarkupParseContext __UNUSED__
*context
,
111 const gchar
*element_name
,
112 const gchar
**attribute_names
,
113 const gchar
**attribute_values
,
118 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
119 if(strcmp("system", element_name
)){
120 *error
= g_error_new(G_MARKUP_ERROR
,
122 "This is not system.xml file");
126 while(attribute_names
[i
]){
127 if(strcmp("node_name", attribute_names
[i
])==0){
128 des
->node_name
= g_strdup(attribute_values
[i
]);
129 }else if(strcmp("domainname", attribute_names
[i
])==0){
130 des
->domain_name
= g_strdup(attribute_values
[i
]);
131 }else if(strcmp("cpu", attribute_names
[i
])==0){
132 des
->nb_cpu
= atoi(attribute_values
[i
]);
133 }else if(strcmp("arch_size", attribute_names
[i
])==0){
134 if(strcmp(attribute_values
[i
],"LP32") == 0) des
->size
= LTT_LP32
;
135 else if(strcmp(attribute_values
[i
],"ILP32") == 0) des
->size
= LTT_ILP32
;
136 else if(strcmp(attribute_values
[i
],"LP64") == 0) des
->size
= LTT_LP64
;
137 else if(strcmp(attribute_values
[i
],"ILP64") == 0) des
->size
= LTT_ILP64
;
138 else if(strcmp(attribute_values
[i
],"UNKNOWN") == 0) des
->size
= LTT_UNKNOWN
;
139 }else if(strcmp("endian", attribute_names
[i
])==0){
140 if(strcmp(attribute_values
[i
],"LITTLE_ENDIAN") == 0)
141 des
->endian
= LTT_LITTLE_ENDIAN
;
142 else if(strcmp(attribute_values
[i
],"BIG_ENDIAN") == 0)
143 des
->endian
= LTT_BIG_ENDIAN
;
144 }else if(strcmp("kernel_name", attribute_names
[i
])==0){
145 des
->kernel_name
= g_strdup(attribute_values
[i
]);
146 }else if(strcmp("kernel_release", attribute_names
[i
])==0){
147 des
->kernel_release
= g_strdup(attribute_values
[i
]);
148 }else if(strcmp("kernel_version", attribute_names
[i
])==0){
149 des
->kernel_version
= g_strdup(attribute_values
[i
]);
150 }else if(strcmp("machine", attribute_names
[i
])==0){
151 des
->machine
= g_strdup(attribute_values
[i
]);
152 }else if(strcmp("processor", attribute_names
[i
])==0){
153 des
->processor
= g_strdup(attribute_values
[i
]);
154 }else if(strcmp("hardware_platform", attribute_names
[i
])==0){
155 des
->hardware_platform
= g_strdup(attribute_values
[i
]);
156 }else if(strcmp("operating_system", attribute_names
[i
])==0){
157 des
->operating_system
= g_strdup(attribute_values
[i
]);
158 }else if(strcmp("ltt_major_version", attribute_names
[i
])==0){
159 des
->ltt_major_version
= atoi(attribute_values
[i
]);
160 }else if(strcmp("ltt_minor_version", attribute_names
[i
])==0){
161 des
->ltt_minor_version
= atoi(attribute_values
[i
]);
162 }else if(strcmp("ltt_block_size", attribute_names
[i
])==0){
163 des
->ltt_block_size
= atoi(attribute_values
[i
]);
165 *error
= g_error_new(G_MARKUP_ERROR
,
167 "Not a valid attribute");
174 static void parser_characters (GMarkupParseContext __UNUSED__
*context
,
176 gsize __UNUSED__ text_len
,
178 GError __UNUSED__
**error
)
180 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
181 des
->description
= g_strdup(text
);
184 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
,
187 g_assert(num
< t
->facilities_by_num
->len
);
189 return &g_array_index(t
->facilities_by_num
, LttFacility
, num
);
194 /*****************************************************************************
196 * ltt_tracefile_open : open a trace file, construct a LttTracefile
198 * t : the trace containing the tracefile
199 * fileName : path name of the trace file
200 * tf : the tracefile structure
202 * : 0 for success, -1 otherwise.
203 ****************************************************************************/
205 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
207 struct stat lTDFStat
; /* Trace data file status */
208 struct ltt_block_start_header
*header
;
209 int page_size
= getpagesize();
212 tf
->name
= g_quark_from_string(fileName
);
214 tf
->fd
= open(fileName
, O_RDONLY
);
216 g_warning("Unable to open input data file %s\n", fileName
);
220 // Get the file's status
221 if(fstat(tf
->fd
, &lTDFStat
) < 0){
222 g_warning("Unable to get the status of the input data file %s\n", fileName
);
226 // Is the file large enough to contain a trace
227 if(lTDFStat
.st_size
< (off_t
)(sizeof(struct ltt_block_start_header
))){
228 g_print("The input data file %s does not contain a trace\n", fileName
);
232 /* Temporarily map the buffer start header to get trace information */
233 /* Multiple of pages aligned head */
234 tf
->buffer
.head
= mmap(0,
235 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)), PROT_READ
,
236 MAP_PRIVATE
, tf
->fd
, 0);
237 if(tf
->buffer
.head
== MAP_FAILED
) {
238 perror("Error in allocating memory for buffer of tracefile");
241 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
243 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
245 if(header
->trace
.magic_number
== LTT_MAGIC_NUMBER
)
247 else if(header
->trace
.magic_number
== LTT_REV_MAGIC_NUMBER
)
249 else /* invalid magic number, bad tracefile ! */
252 //store the size of the file
253 tf
->file_size
= lTDFStat
.st_size
;
254 tf
->block_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
255 tf
->num_blocks
= tf
->file_size
/ tf
->block_size
;
257 munmap(tf
->buffer
.head
, PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
258 tf
->buffer
.head
= NULL
;
260 //read the first block
261 if(map_block(tf
,0)) {
262 perror("Cannot map block for tracefile");
270 munmap(tf
->buffer
.head
, PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
278 /*****************************************************************************
279 *Open control and per cpu tracefiles
280 ****************************************************************************/
282 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
285 tf
= ltt_tracefile_open(t
,tracefile_name
);
287 t
->per_cpu_tracefile_number
++;
288 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
291 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
300 tf
= ltt_tracefile_open(t
,control_name
);
302 g_warning("ltt_tracefile_open_control : bad file descriptor");
305 t
->control_tracefile_number
++;
306 g_ptr_array_add(t
->control_tracefiles
,tf
);
308 //parse facilities tracefile to get base_id
309 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
311 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
313 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
315 fLoad
.name
= (gchar
*)pos
;
316 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
317 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
319 for(i
=0;i
<t
->facility_number
;i
++){
320 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
321 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
322 f
->base_id
= fLoad
.base_code
;
326 if(i
==t
->facility_number
) {
327 g_warning("Facility: %s, checksum: %u is not found",
328 fLoad
.name
,(unsigned int)fLoad
.checksum
);
331 }else if(ev
.event_id
== TRACE_BLOCK_START
){
333 }else if(ev
.event_id
== TRACE_BLOCK_END
){
336 g_warning("Not valid facilities trace file");
345 /*****************************************************************************
347 * ltt_tracefile_close: close a trace file,
349 * t : tracefile which will be closed
350 ****************************************************************************/
352 void ltt_tracefile_close(LttTracefile
*t
)
354 if(t
->buffer
.head
!= NULL
)
355 munmap(t
->buffer
.head
, t
->buf_size
);
360 /*****************************************************************************
361 *Get system information
362 ****************************************************************************/
364 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
371 GMarkupParseContext
* context
;
372 GError
* error
= NULL
;
373 GMarkupParser markup_parser
=
375 parser_start_element
,
378 NULL
, /* passthrough */
382 fd
= g_open(pathname
, O_RDONLY
, 0);
384 g_warning("Can not open file : %s\n", pathname
);
388 iochan
= g_io_channel_unix_new(fd
);
390 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
392 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
393 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
394 != G_IO_STATUS_EOF
) {
397 g_warning("Can not read xml file: \n%s\n", error
->message
);
400 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
402 g_warning("Can not parse xml file: \n%s\n", error
->message
);
405 g_markup_parse_context_free(context
);
407 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
409 g_warning("Can not close file: \n%s\n", error
->message
);
417 g_markup_parse_context_free(context
);
419 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
421 g_warning("Can not close file: \n%s\n", error
->message
);
432 /*****************************************************************************
433 *The following functions get facility/tracefile information
434 ****************************************************************************/
436 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
443 gchar fullname
[DIR_NAME_SIZE
];
444 GError
* error
= NULL
;
446 dir
= g_dir_open(eventdefs
, 0, &error
);
449 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
454 while((name
= g_dir_read_name(dir
)) != NULL
){
455 if(!g_pattern_match_simple("*.xml", name
)) continue;
456 strcpy(fullname
,eventdefs
);
457 strcat(fullname
,name
);
458 ltt_facility_open(t
,fullname
);
462 for(j
=0;j
<t
->facility_number
;j
++){
463 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
464 for(i
=0; i
<f
->event_number
; i
++){
466 setFieldsOffset(NULL
, et
, NULL
, t
);
473 /*****************************************************************************
474 *A trace is specified as a pathname to the directory containing all the
475 *associated data (control tracefiles, per cpu tracefiles, event
478 *When a trace is closed, all the associated facilities, types and fields
479 *are released as well.
483 /****************************************************************************
484 * get_absolute_pathname
486 * return the unique pathname in the system
488 * MD : Fixed this function so it uses realpath, dealing well with
489 * forgotten cases (.. were not used correctly before).
491 ****************************************************************************/
492 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
494 abs_pathname
[0] = '\0';
496 if ( realpath (pathname
, abs_pathname
) != NULL
)
500 /* error, return the original path unmodified */
501 strcpy(abs_pathname
, pathname
);
507 /* Search for something like : .*_.*
509 * The left side is the name, the right side is the number.
512 int get_tracefile_name_number(const gchar
*raw_name
,
516 guint raw_name_len
= strlen(raw_name
);
517 gchar char_name
[PATH_MAX
];
524 for(i
=raw_name_len
-1;i
>=0;i
--) {
525 if(raw_name
[i
] == '_') break;
527 if(i
==0) /* Either not found or name length is 0 */
531 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
533 if(endptr
== raw_name
+underscore_pos
+1)
534 return -1; /* No digit */
535 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
536 return -1; /* underflow / overflow */
538 strncpy(char_name
, raw_name
, underscore_pos
);
540 *name
= g_quark_from_string(char_name
);
547 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
549 return &trace
->tracefiles
;
553 void compute_tracefile_group(GQuark key_id
,
555 struct compute_tracefile_group_args
*args
)
560 for(i
=0; i
<group
->len
; i
++) {
561 tf
= &g_array_index (group
, LttTracefile
, i
);
563 args
->func(tf
, args
->func_args
);
568 void ltt_tracefile_group_destroy(gpointer data
)
570 GArray
*group
= (GArray
*)data
;
574 for(i
=0; i
<group
->len
; i
++) {
575 tf
= &g_array_index (group
, LttTracefile
, i
);
577 ltt_tracefile_close(tf
);
579 g_array_free(group
, TRUE
);
582 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
584 GArray
*group
= (GArray
*)data
;
588 for(i
=0; i
<group
->len
; i
++) {
589 tf
= &g_array_index (group
, LttTracefile
, i
);
590 if(tf
->cpu_online
) return 1;
596 /* Open each tracefile under a specific directory. Put them in a
597 * GData : permits to access them using their tracefile group pathname.
598 * i.e. access control/modules tracefile group by index :
601 * relative path is the path relative to the trace root
602 * root path is the full path
604 * A tracefile group is simply an array where all the per cpu tracefiles sits.
607 static int open_tracefiles(LttTrace
*trace
, char *root_path
,
610 DIR *dir
= opendir(root_path
);
611 struct dirent
*entry
;
612 struct stat stat_buf
;
620 char rel_path
[PATH_MAX
];
628 strncpy(path
, root_path
, PATH_MAX
-1);
629 path_len
= strlen(path
);
630 path
[path_len
] = '/';
632 path_ptr
= path
+ path_len
;
634 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
635 rel_path_len
= strlen(rel_path
);
636 rel_path
[rel_path_len
] = '/';
638 rel_path_ptr
= rel_path
+ rel_path_len
;
640 while((entry
= readdir(dir
)) != NULL
) {
642 if(entry
->d_name
[0] == '.') continue;
644 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
645 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
647 ret
= stat(path
, &stat_buf
);
653 g_debug("Tracefile file or directory : %s\n", path
);
655 if(S_ISDIR(stat_buf
.st_mode
)) {
657 g_debug("Entering subdirectory...\n");
658 ret
= open_tracefiles(trace
, path
, rel_path
);
659 if(ret
< 0) continue;
660 } else if(S_ISREG(stat_buf
.st_mode
)) {
661 g_debug("Opening file.\n");
669 if(get_tracefile_name_number(rel_path
, &name
, &num
))
670 continue; /* invalid name */
672 g_debug("Tracefile name is %s and number is %u",
673 g_quark_to_string(name
), num
);
675 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
677 /* Elements are automatically cleared when the array is allocated.
678 * It makes the cpu_online variable set to 0 : cpu offline, by default.
680 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
681 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
682 group
, ltt_tracefile_group_destroy
);
684 /* Add the per cpu tracefile to the named group */
685 unsigned int old_len
= group
->len
;
687 group
= g_array_set_size(group
, num
+1);
688 tf
= &g_array_index (group
, LttTracefile
, num
);
690 if(ltt_tracefile_open(trace
, path
, tf
)) {
691 g_info("Error opening tracefile %s", path
);
692 g_array_set_size(group
, old_len
);
694 if(!ltt_tracefile_group_has_cpu_online(group
))
695 g_datalist_id_remove_data(&trace
->tracefiles
, name
);
697 continue; /* error opening the tracefile : bad magic number ? */
709 /* ltt_get_facility_description
711 * Opens the trace corresponding to the requested facility (identified by fac_id
714 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
716 * Returns 0 on success, or 1 on failure.
719 static int ltt_get_facility_description(LttFacility
*f
,
721 LttTracefile
*fac_tf
)
723 char desc_file_name
[PATH_MAX
];
730 text
= g_quark_to_string(t
->pathname
);
731 textlen
= strlen(text
);
733 if(textlen
>= PATH_MAX
) goto name_error
;
734 strcpy(desc_file_name
, text
);
736 text
= "/eventdefs/";
737 textlen
+=strlen(text
);
738 if(textlen
>= PATH_MAX
) goto name_error
;
739 strcat(desc_file_name
, text
);
741 text
= g_quark_to_string(f
->name
);
742 textlen
+=strlen(text
);
743 if(textlen
>= PATH_MAX
) goto name_error
;
744 strcat(desc_file_name
, text
);
747 textlen
+=strlen(text
);
748 if(textlen
>= PATH_MAX
) goto name_error
;
749 strcat(desc_file_name
, text
);
751 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
753 if(err
< 0) goto name_error
;
755 textlen
=strlen(desc_file_name
);
758 textlen
+=strlen(text
);
759 if(textlen
>= PATH_MAX
) goto name_error
;
760 strcat(desc_file_name
, text
);
762 err
= ltt_facility_open(f
, t
, desc_file_name
);
763 if(err
) goto facility_error
;
765 for(i
=0;i
<t
->facilities_by_num
->len
;i
++){
766 f
= &g_array_index(t
->facilities_by_num
, LttFacility
, i
);
768 for(j
=0; j
<f
->events
->len
; j
++){
769 et
= &g_array_index(f
->events
, LttEventType
, j
);
770 set_fields_offsets(fac_tf
, et
);
783 static void ltt_fac_ids_destroy(gpointer data
)
785 GArray
*fac_ids
= (GArray
*)data
;
789 for(i
=0; i
<fac_ids
->len
; i
++) {
790 fac
= &g_array_index (fac_ids
, LttFacility
, i
);
791 ltt_facility_close(fac
);
794 g_array_free(fac_ids
, TRUE
);
798 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
799 * because it must be done just after the opening */
800 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
807 err
= ltt_tracefile_read_seek(tf
);
808 if(err
== EPERM
) goto seek_error
;
809 else if(err
== ERANGE
) break; /* End of tracefile */
811 err
= ltt_tracefile_read_update_event(tf
);
812 if(err
) goto update_error
;
814 /* We are on a facility load/or facility unload/ or heartbeat event */
816 * * facility 0 is hardcoded : this is the core facility. It will be shown
817 * in the facility array though, and is shown as "loaded builtin" in the
819 * It contains event :
821 * 1 : facility unload
822 * 2 : state dump facility load
825 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
826 /* Should only contain core facility */
827 g_warning("Error in processing facility file %s, "
828 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
829 tf
->event
.facility_id
);
834 struct LttFacilityLoad
*fac_load_data
;
835 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
839 switch((enum ltt_core_events
)tf
->event
.event_id
) {
840 case LTT_EVENT_FACILITY_LOAD
:
841 fac_name
= (char*)(tf
->event
.data
);
842 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
845 (struct LttFacilityLoad
*)
846 (tf
->event
.data
+ strlen(fac_name
) + 1);
847 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
848 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
849 g_assert(fac
->exists
== 0);
850 fac
->name
= g_quark_from_string(fac_name
);
851 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
852 &fac_load_data
->checksum
);
853 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
854 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
855 &fac_load_data
->pointer_size
);
856 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
857 &fac_load_data
->size_t_size
);
858 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
859 &fac_load_data
->alignment
);
861 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
864 fac
->trace
= tf
->trace
;
867 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
869 if(fac_ids
== NULL
) {
870 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
871 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
873 fac_ids
, ltt_fac_ids_destroy
);
875 g_array_append_val(fac_ids
, fac
->id
);
878 case LTT_EVENT_FACILITY_UNLOAD
:
879 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
880 /* We don't care about unload : facilities ID are valid for the whole
881 * trace. They simply won't be used after the unload. */
883 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
884 fac_name
= (char*)(tf
->event
.data
);
885 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
887 fac_state_dump_load_data
=
888 (struct LttStateDumpFacilityLoad
*)
889 (tf
->event
.data
+ strlen(fac_name
) + 1);
890 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
891 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
892 g_assert(fac
->exists
== 0);
893 fac
->name
= g_quark_from_string(fac_name
);
894 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
895 &fac_state_dump_load_data
->checksum
);
896 fac
->id
= fac_state_dump_load_data
->id
;
897 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
898 &fac_state_dump_load_data
->pointer_size
);
899 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
900 &fac_state_dump_load_data
->size_t_size
);
901 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
902 &fac_state_dump_load_data
->alignment
);
903 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
906 fac
->trace
= tf
->trace
;
910 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
912 if(fac_ids
== NULL
) {
913 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
914 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
916 fac_ids
, ltt_fac_ids_destroy
);
918 g_array_append_val(fac_ids
, fac
->id
);
921 case LTT_EVENT_HEARTBEAT
:
924 g_warning("Error in processing facility file %s, "
925 "unknown event id %hhu in core facility.",
926 g_quark_to_string(tf
->name
),
941 g_warning("An error occured in facility tracefile parsing");
946 LttTrace
*ltt_trace_open(const gchar
*pathname
)
948 gchar abs_path
[PATH_MAX
];
953 struct ltt_block_start_header
*header
;
955 t
= g_new(LttTrace
, 1);
956 if(!t
) goto alloc_error
;
958 get_absolute_pathname(pathname
, abs_path
);
959 t
->pathname
= g_quark_from_string(abs_path
);
961 /* Open all the tracefiles */
962 g_datalist_init(&t
->tracefiles
);
963 if(open_tracefiles(t
, abs_path
, ""))
966 /* Prepare the facilities containers : array and mapping */
967 /* Array is zeroed : the "exists" field is set to false by default */
968 t
->facilities_by_num
= g_array_sized_new (FALSE
,
969 TRUE
, sizeof(LttFacility
),
971 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
973 g_datalist_init(&t
->facilities_by_name
);
975 /* Parse each trace control/facilitiesN files : get runtime fac. info */
976 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
978 g_error("Trace %s has no facility tracefile", abs_path
);
980 goto facilities_error
;
983 /* Get the trace information for the control/facility 0 tracefile */
984 g_assert(group
->len
> 0);
985 tf
= &g_array_index (group
, LttTracefile
, 0);
986 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
987 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_type
);
988 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_variant
);
989 t
->arch_size
= header
->trace
.arch_size
;
990 t
->ltt_major_version
= header
->trace
.major_version
;
991 t
->ltt_minor_version
= header
->trace
.minor_version
;
992 t
->flight_recorder
= header
->trace
.flight_recorder
;
993 t
->has_heartbeat
= header
->trace
.has_heartbeat
;
994 t
->has_alignment
= header
->trace
.has_alignment
;
995 t
->has_tsc
= header
->trace
.has_tsc
;
998 for(i
=0; i
<group
->len
; i
++) {
999 tf
= &g_array_index (group
, LttTracefile
, i
);
1000 if(ltt_process_facility_tracefile(tf
))
1001 goto facilities_error
;
1006 /* Error handling */
1008 g_datalist_clear(&t
->facilities_by_name
);
1009 g_array_free(t
->facilities_by_num
, TRUE
);
1011 g_datalist_clear(&t
->tracefiles
);
1018 GQuark
ltt_trace_name(LttTrace
*t
)
1024 /******************************************************************************
1025 * When we copy a trace, we want all the opening actions to happen again :
1026 * the trace will be reopened and totally independant from the original.
1027 * That's why we call ltt_trace_open.
1028 *****************************************************************************/
1029 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1031 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1034 void ltt_trace_close(LttTrace
*t
)
1036 g_datalist_clear(&t
->facilities_by_name
);
1037 g_array_free(t
->facilities_by_num
, TRUE
);
1038 g_datalist_clear(&t
->tracefiles
);
1043 /*****************************************************************************
1044 *Get the system description of the trace
1045 ****************************************************************************/
1047 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1049 g_assert(id
< t
->facilities_by_num
->len
);
1050 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1053 /* ltt_trace_facility_get_by_name
1055 * Returns the GArray of facility indexes. All the fac_ids that matches the
1056 * requested facility name.
1058 * If name is not found, returns NULL.
1060 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1062 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1065 /*****************************************************************************
1066 * Functions to discover all the event types in the trace
1067 ****************************************************************************/
1070 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1074 unsigned int num
= t
->facility_number
;
1078 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1079 count
+= f
->event_number
;
1086 //use an iteration on all the trace facilities, and inside iteration on all the
1087 //event types in each facilities instead.
1088 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1090 LttEventType
*event_type
;
1093 f
= ltt_trace_facility_by_id(t
,evId
);
1095 if(unlikely(!f
)) event_type
= NULL
;
1096 else event_type
= f
->events
[evId
- f
->base_id
];
1103 /*****************************************************************************
1104 * ltt_trace_find_tracefile
1106 * Find a tracefile by name and index in the group.
1108 * Returns a pointer to the tracefiles, else NULL.
1109 ****************************************************************************/
1111 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1116 /*****************************************************************************
1117 * Get the start time and end time of the trace
1118 ****************************************************************************/
1120 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1121 LttTime
*start
, LttTime
*end
)
1123 struct ltt_block_start_header
* header
;
1126 err
= map_block(tf
, 0);
1128 g_error("Can not map block");
1129 *start
= ltt_time_infinite
;
1131 *start
= tf
->buffer
.begin
.timestamp
;
1133 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1135 g_error("Can not map block");
1136 *end
= ltt_time_zero
;
1138 *end
= tf
->buffer
.end
.timestamp
;
1141 struct tracefile_time_span_get_args
{
1147 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1149 struct tracefile_time_span_get_args
*args
=
1150 (struct tracefile_time_span_get_args
*)user_data
;
1152 GArray
*group
= (GArray
*)data
;
1158 for(i
=0; i
<group
->len
; i
++) {
1159 tf
= &g_array_index (group
, LttTracefile
, i
);
1160 if(tf
->cpu_online
) {
1161 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1162 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1163 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1168 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1170 LttTime min_start
= ltt_time_infinite
;
1171 LttTime max_end
= ltt_time_zero
;
1172 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1174 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1176 if(start
!= NULL
) *start
= min_start
;
1177 if(end
!= NULL
) *end
= max_end
;
1182 /*****************************************************************************
1183 *Get the name of a tracefile
1184 ****************************************************************************/
1186 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1191 /*****************************************************************************
1192 * Get the number of blocks in the tracefile
1193 ****************************************************************************/
1195 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1197 return tf
->num_blocks
;
1201 /* Seek to the first event in a tracefile that has a time equal or greater than
1202 * the time passed in parameter.
1204 * If the time parameter is outside the tracefile time span, seek to the first
1205 * or the last event of the tracefile.
1207 * If the time parameter is before the first event, we have to seek specially to
1210 * If the time is after the end of the trace, get the last event.
1212 * Do a binary search to find the right block, then a sequential search in the
1213 * block to find the event.
1215 * In the special case where the time requested fits inside a block that has no
1216 * event corresponding to the requested time, the first event of the next block
1219 * IMPORTANT NOTE : // FIXME everywhere...
1221 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1222 * you will jump over an event if you do.
1224 * Return value : 0 : no error, the tf->event can be used
1225 * otherwise : this is an error.
1229 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1233 unsigned int block_num
, high
, low
;
1235 /* seek at the beginning of trace */
1236 err
= map_block(tf
, 0); /* First block */
1238 g_error("Can not map block");
1242 /* If the time is lower or equal the beginning of the trace,
1243 * go to the first event. */
1244 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1245 ret
= ltt_tracefile_read(tf
);
1246 goto found
; /* There is either no event in the trace or the event points
1247 to the first event in the trace */
1250 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1252 g_error("Can not map block");
1256 /* If the time is after the end of the trace, get the last event. */
1257 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) >= 0) {
1258 /* While the ltt_tracefile_read doesn't return ERANGE or EPERM,
1262 ret
= ltt_tracefile_read(tf
);
1263 if(ret
== ERANGE
) goto found
; /* ERANGE or EPERM */
1264 else if(ret
) goto fail
;
1268 /* Binary search the block */
1269 high
= tf
->num_blocks
- 1;
1273 block_num
= ((high
-low
) / 2) + low
;
1275 err
= map_block(tf
, block_num
);
1277 g_error("Can not map block");
1281 /* We cannot divide anymore : this is what would happen if the time
1282 * requested was exactly between two consecutive buffers'end and start
1283 * timestamps. This is also what would happend if we didn't deal with out
1284 * of span cases prior in this function. */
1285 /* The event is right in the buffer!
1286 * (or in the next buffer first event) */
1288 ret
= ltt_tracefile_read(tf
);
1289 if(ret
== ERANGE
) goto found
; /* ERANGE or EPERM */
1290 else if(ret
) goto fail
;
1292 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1296 } if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1297 /* go to lower part */
1299 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1300 /* go to higher part */
1302 } else {/* The event is right in the buffer!
1303 (or in the next buffer first event) */
1305 ltt_tracefile_read(tf
);
1306 if(ret
== ERANGE
) goto found
; /* ERANGE or EPERM */
1307 else if(ret
) goto fail
;
1309 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1319 /* Error handling */
1321 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1322 g_quark_to_string(tf
->name
));
1327 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1331 if(ep
->tracefile
!= tf
) {
1335 err
= map_block(tf
, ep
->block
);
1337 g_error("Can not map block");
1341 tf
->event
.offset
= ep
->offset
;
1343 err
= ltt_tracefile_read_update_event(tf
);
1345 err
= ltt_tracefile_read_op(tf
);
1351 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1352 g_quark_to_string(tf
->name
));
1355 /* Calculate the real event time based on the buffer boundaries */
1356 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1360 g_assert(tf
->trace
->has_tsc
);
1362 time
= ltt_time_from_uint64(
1363 (guint64
)tf
->buffer
.tsc
*tf
->buffer
.nsecs_per_cycle
);
1364 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1370 /* Get the current event of the tracefile : valid until the next read */
1371 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1378 /*****************************************************************************
1380 * ltt_tracefile_read : Read the next event in the tracefile
1385 * Returns 0 if an event can be used in tf->event.
1386 * Returns ERANGE on end of trace. The event in tf->event still can be used.
1387 * Returns EPERM on error.
1389 * This function does make the tracefile event structure point to the event
1390 * currently pointed to by the tf->event.
1392 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1393 * reinitialize it after an error if you want results to be coherent.
1394 * It would be the case if a end of trace last buffer has no event : the end
1395 * of trace wouldn't be returned, but an error.
1396 * We make the assumption there is at least one event per buffer.
1397 ****************************************************************************/
1399 int ltt_tracefile_read(LttTracefile
*tf
)
1403 err
= ltt_tracefile_read_seek(tf
);
1405 err
= ltt_tracefile_read_update_event(tf
);
1407 err
= ltt_tracefile_read_op(tf
);
1413 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1417 /* Get next buffer until we finally have an event, or end of trace */
1419 err
= ltt_seek_next_event(tf
);
1420 if(unlikely(err
== ENOPROTOOPT
)) {
1424 /* Are we at the end of the buffer ? */
1426 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1429 /* get next block */
1430 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1432 g_error("Can not map block");
1436 } else break; /* We found an event ! */
1443 /* do specific operation on events */
1444 int ltt_tracefile_read_op(LttTracefile
*tf
)
1453 /* do event specific operation */
1455 /* do something if its an heartbeat event : increment the heartbeat count */
1456 //if(event->facility_id == LTT_FACILITY_CORE)
1457 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1458 // tf->cur_heart_beat_number++;
1464 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1465 * event specific operation. */
1466 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1474 pos
= tf
->buffer
.head
+ event
->offset
;
1476 /* Read event header */
1480 if(tf
->trace
->has_tsc
) {
1481 if(tf
->trace
->has_heartbeat
) {
1482 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1484 /* 32 bits -> 64 bits tsc */
1485 /* note : still works for seek and non seek cases. */
1486 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1487 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1489 | (guint64
)event
->time
.timestamp
;
1490 event
->tsc
= tf
->buffer
.tsc
;
1493 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1494 | (guint64
)event
->time
.timestamp
;
1495 event
->tsc
= tf
->buffer
.tsc
;
1497 pos
+= sizeof(guint32
);
1499 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1500 tf
->buffer
.tsc
= event
->tsc
;
1501 pos
+= sizeof(guint64
);
1504 event
->event_time
= ltt_interpolate_time(tf
, event
);
1506 event
->time
.delta
.tv_sec
= 0;
1507 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1508 pos
) * NSEC_PER_USEC
;
1510 event
->tsc
= tf
->buffer
.tsc
;
1512 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1514 pos
+= sizeof(guint32
);
1517 event
->facility_id
= *(guint8
*)pos
;
1518 pos
+= sizeof(guint8
);
1520 event
->event_id
= *(guint8
*)pos
;
1521 pos
+= sizeof(guint8
);
1523 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1524 pos
+= sizeof(guint16
);
1528 /* get the data size and update the event fields with the current
1530 ltt_update_event_size(tf
);
1536 /****************************************************************************
1538 * map_block : map a block from the file
1540 * lttdes : ltt trace file
1541 * whichBlock : the block which will be read
1544 * EINVAL : lseek fail
1545 * EIO : can not read from the file
1546 ****************************************************************************/
1548 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1550 int page_size
= getpagesize();
1551 struct ltt_block_start_header
*header
;
1553 g_assert(block_num
< tf
->num_blocks
);
1555 if(tf
->buffer
.head
!= NULL
)
1556 munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
));
1558 /* Multiple of pages aligned head */
1559 tf
->buffer
.head
= mmap(0,
1560 PAGE_ALIGN(tf
->block_size
),
1561 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1562 PAGE_ALIGN((off_t
)tf
->block_size
* (off_t
)block_num
));
1564 if(tf
->buffer
.head
== MAP_FAILED
) {
1565 perror("Error in allocating memory for buffer of tracefile");
1569 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1572 tf
->buffer
.index
= block_num
;
1574 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1576 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1577 &header
->begin
.timestamp
);
1578 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1579 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1580 &header
->begin
.cycle_count
);
1581 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1582 &header
->end
.timestamp
);
1583 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1584 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1585 &header
->end
.cycle_count
);
1586 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1587 &header
->lost_size
);
1589 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1590 tf
->event
.tsc
= tf
->buffer
.tsc
;
1593 * eventually support variable buffer size : will need a partial pre-read of
1594 * the headers to create an index when we open the trace... eventually. */
1595 g_assert(tf
->block_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1596 &header
->buf_size
));
1598 /* Now that the buffer is mapped, calculate the time interpolation for the
1601 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1603 /* Make the current event point to the beginning of the buffer :
1604 * it means that the event read must get the first event. */
1605 tf
->event
.tracefile
= tf
;
1606 tf
->event
.block
= block_num
;
1607 tf
->event
.offset
= 0;
1616 /* It will update the fields offsets too */
1617 void ltt_update_event_size(LttTracefile
*tf
)
1621 /* Specific handling of core events : necessary to read the facility control
1623 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1624 tf
->event
.facility_id
);
1626 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1627 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1628 case LTT_EVENT_FACILITY_LOAD
:
1629 size
= strlen((char*)tf
->event
.data
) + 1;
1630 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1631 size
+= sizeof(struct LttFacilityLoad
);
1633 case LTT_EVENT_FACILITY_UNLOAD
:
1634 g_debug("Update Event facility unload");
1635 size
= sizeof(struct LttFacilityUnload
);
1637 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1638 size
= strlen((char*)tf
->event
.data
) + 1;
1639 g_debug("Update Event facility load state dump of facility %s",
1640 (char*)tf
->event
.data
);
1641 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1643 case LTT_EVENT_HEARTBEAT
:
1644 g_debug("Update Event heartbeat");
1645 size
= sizeof(TimeHeartbeat
);
1648 g_warning("Error in getting event size : tracefile %s, "
1649 "unknown event id %hhu in core facility.",
1650 g_quark_to_string(tf
->name
),
1651 tf
->event
.event_id
);
1652 goto event_id_error
;
1657 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1658 tf
->event
.facility_id
,
1659 tf
->event
.facility_id
,
1660 g_quark_to_string(tf
->name
));
1661 goto facility_error
;
1664 LttEventType
*event_type
=
1665 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1668 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1670 g_quark_to_string(f
->name
),
1671 g_quark_to_string(tf
->name
));
1672 goto event_type_error
;
1675 size
= get_field_type_size(tf
, event_type
,
1676 0, 0, event_type
->root_field
, tf
->event
.data
);
1677 g_debug("Event root field : f.e %hhu.%hhu size %lu", tf
->event
.facility_id
,
1678 tf
->event
.event_id
, size
);
1681 tf
->event
.data_size
= size
;
1683 /* Check consistency between kernel and LTTV structure sizes */
1684 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1691 tf
->event
.data_size
= 0;
1695 /* Take the tf current event offset and use the event facility id and event id
1696 * to figure out where is the next event offset.
1698 * This is an internal function not aiming at being used elsewhere : it will
1699 * not jump over the current block limits. Please consider using
1700 * ltt_tracefile_read to do this.
1702 * Returns 0 on success
1703 * ERANGE if we are at the end of the buffer.
1704 * ENOPROTOOPT if an error occured when getting the current event size.
1706 static int ltt_seek_next_event(LttTracefile
*tf
)
1712 /* seek over the buffer header if we are at the buffer start */
1713 if(tf
->event
.offset
== 0) {
1714 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
);
1716 if(tf
->event
.offset
== tf
->block_size
- tf
->buffer
.lost_size
) {
1723 if(tf
->event
.offset
== tf
->block_size
- tf
->buffer
.lost_size
) {
1728 pos
= tf
->event
.data
;
1730 if(tf
->event
.data_size
< 0) goto error
;
1732 pos
+= (size_t)tf
->event
.data_size
;
1734 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1740 g_error("Error in ltt_seek_next_event for tracefile %s",
1741 g_quark_to_string(tf
->name
));
1746 /*****************************************************************************
1748 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1751 ****************************************************************************/
1753 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1755 LttTime lBufTotalTime
; /* Total time for this buffer */
1756 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1757 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1759 /* Calculate the total time for this buffer */
1760 lBufTotalTime
= ltt_time_sub(
1761 ltt_get_time(LTT_GET_BO(tf
), &tf
->buffer
.end
.timestamp
),
1762 ltt_get_time(LTT_GET_BO(tf
), &tf
->buffer
.begin
.timestamp
));
1764 /* Calculate the total cycles for this bufffer */
1765 lBufTotalCycle
= ltt_get_uint64(LTT_GET_BO(tf
), &tf
->buffer
.end
.cycle_count
);
1766 lBufTotalCycle
-= ltt_get_uint64(LTT_GET_BO(tf
),
1767 &tf
->buffer
.begin
.cycle_count
);
1769 /* Convert the total time to double */
1770 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1772 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1776 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1778 LttField
* rootFld
= evT
->root_field
;
1779 // rootFld->base_address = evD;
1782 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1783 evT
, 0,0,rootFld
, evD
);
1787 /*****************************************************************************
1789 * set_fields_offsets : set the precomputable offset of the fields
1791 * tracefile : opened trace file
1792 * event_type : the event type
1793 ****************************************************************************/
1795 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1797 LttField
*field
= event_type
->root_field
;
1798 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1801 preset_field_type_size(tf
, event_type
, 0, 0,
1802 &fixed_root
, &fixed_parent
,
1808 /*****************************************************************************
1810 * preset_field_type_size : set the fixed sizes of the field type
1813 * event_type : event type
1814 * offset_root : offset from the root
1815 * offset_parent : offset from the parent
1816 * fixed_root : Do we know a fixed offset to the root ?
1817 * fixed_parent : Do we know a fixed offset to the parent ?
1819 ****************************************************************************/
1820 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1821 off_t offset_root
, off_t offset_parent
,
1822 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1825 enum field_status local_fixed_root
, local_fixed_parent
;
1829 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1830 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1831 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1833 type
= field
->field_type
;
1835 field
->fixed_root
= *fixed_root
;
1836 if(field
->fixed_root
== FIELD_FIXED
)
1837 field
->offset_root
= offset_root
;
1839 field
->offset_root
= 0;
1841 field
->fixed_parent
= *fixed_parent
;
1842 if(field
->fixed_parent
== FIELD_FIXED
)
1843 field
->offset_parent
= offset_parent
;
1845 field
->offset_parent
= 0;
1847 size_t current_root_offset
;
1848 size_t current_offset
;
1849 enum field_status current_child_status
, final_child_status
;
1852 switch(type
->type_class
) {
1857 field
->field_size
= ltt_type_size(tf
->trace
, type
);
1858 field
->fixed_size
= FIELD_FIXED
;
1861 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
1862 field
->fixed_size
= FIELD_FIXED
;
1866 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
1867 field
->fixed_size
= FIELD_FIXED
;
1872 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
1873 field
->fixed_size
= FIELD_FIXED
;
1876 local_fixed_root
= FIELD_VARIABLE
;
1877 local_fixed_parent
= FIELD_VARIABLE
;
1878 preset_field_type_size(tf
, event_type
,
1880 &local_fixed_root
, &local_fixed_parent
,
1882 field
->fixed_size
= FIELD_VARIABLE
;
1883 field
->field_size
= 0;
1886 field
->fixed_size
= FIELD_VARIABLE
;
1887 field
->field_size
= 0;
1890 local_fixed_root
= FIELD_VARIABLE
;
1891 local_fixed_parent
= FIELD_VARIABLE
;
1892 preset_field_type_size(tf
, event_type
,
1894 &local_fixed_root
, &local_fixed_parent
,
1896 field
->fixed_size
= field
->child
[0]->fixed_size
;
1897 if(field
->fixed_size
== FIELD_FIXED
)
1898 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
1900 field
->field_size
= 0;
1903 current_root_offset
= field
->offset_root
;
1905 current_child_status
= FIELD_FIXED
;
1906 for(i
=0;i
<type
->element_number
;i
++) {
1907 preset_field_type_size(tf
, event_type
,
1908 current_root_offset
, current_offset
,
1909 fixed_root
, ¤t_child_status
,
1911 if(current_child_status
== FIELD_FIXED
) {
1912 current_root_offset
+= field
->child
[i
]->field_size
;
1913 current_offset
+= field
->child
[i
]->field_size
;
1915 current_root_offset
= 0;
1919 if(current_child_status
!= FIELD_FIXED
) {
1920 *fixed_parent
= current_child_status
;
1921 field
->field_size
= 0;
1922 field
->fixed_size
= current_child_status
;
1924 field
->field_size
= current_offset
;
1925 field
->fixed_size
= FIELD_FIXED
;
1929 current_root_offset
= field
->offset_root
;
1932 final_child_status
= FIELD_FIXED
;
1933 for(i
=0;i
<type
->element_number
;i
++) {
1934 enum field_status current_root_child_status
= FIELD_FIXED
;
1935 enum field_status current_child_status
= FIELD_FIXED
;
1936 preset_field_type_size(tf
, event_type
,
1937 current_root_offset
, current_offset
,
1938 ¤t_root_child_status
, ¤t_child_status
,
1940 if(current_child_status
!= FIELD_FIXED
)
1941 final_child_status
= current_child_status
;
1943 max_size
= max(max_size
, field
->child
[i
]->field_size
);
1945 if(final_child_status
!= FIELD_FIXED
) {
1946 *fixed_root
= final_child_status
;
1947 *fixed_parent
= final_child_status
;
1948 field
->field_size
= 0;
1949 field
->fixed_size
= current_child_status
;
1951 field
->field_size
= max_size
;
1952 field
->fixed_size
= FIELD_FIXED
;
1960 /*****************************************************************************
1962 * check_fields_compatibility : Check for compatibility between two fields :
1963 * do they use the same inner structure ?
1965 * event_type1 : event type
1966 * event_type2 : event type
1969 *Returns : 0 if identical
1971 ****************************************************************************/
1972 gint
check_fields_compatibility(LttEventType
*event_type1
,
1973 LttEventType
*event_type2
,
1974 LttField
*field1
, LttField
*field2
)
1976 guint different
= 0;
1977 enum field_status local_fixed_root
, local_fixed_parent
;
1982 if(field1
== NULL
) {
1983 if(field2
== NULL
) goto end
;
1988 } else if(field2
== NULL
) {
1993 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
1994 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
1995 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
1996 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
1997 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
1998 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2000 type1
= field1
->field_type
;
2001 type2
= field2
->field_type
;
2003 size_t current_root_offset
;
2004 size_t current_offset
;
2005 enum field_status current_child_status
, final_child_status
;
2008 if(type1
->type_class
!= type2
->type_class
) {
2012 if(type1
->element_name
!= type2
->element_name
) {
2017 switch(type1
->type_class
) {
2027 if(field1
->field_size
!= field2
->field_size
) {
2033 if(type1
->element_number
!= type2
->element_number
) {
2037 for(i
=0;i
<type1
->element_number
;i
++) {
2038 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2045 /* Two elements : size and child */
2046 g_assert(type1
->element_number
!= type2
->element_number
);
2047 for(i
=0;i
<type1
->element_number
;i
++) {
2048 if(check_fields_compatibility(event_type1
, event_type2
,
2049 field1
->child
[0], field2
->child
[0])) {
2058 if(field1
->field_size
!= field2
->field_size
) {
2062 /* Two elements : size and child */
2063 g_assert(type1
->element_number
!= type2
->element_number
);
2064 for(i
=0;i
<type1
->element_number
;i
++) {
2065 if(check_fields_compatibility(event_type1
, event_type2
,
2066 field1
->child
[0], field2
->child
[0])) {
2074 if(type1
->element_number
!= type2
->element_number
) {
2078 for(i
=0;i
<type1
->element_number
;i
++) {
2079 if(check_fields_compatibility(event_type1
, event_type2
,
2080 field1
->child
[0], field2
->child
[0])) {
2095 /*****************************************************************************
2097 * getFieldtypeSize: get the size of the field type (primitive type)
2100 * offsetRoot : offset from the root
2101 * offsetParent : offset from the parrent
2103 * evD : event data, it may be NULL
2105 * int : size of the field
2106 ****************************************************************************/
2108 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2109 LttEventType
* evT
, gint offsetRoot
,
2110 gint offsetParent
, LttField
* fld
, void *evD
)
2112 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2113 LttType
* type
= fld
->field_type
;
2115 /* This likely has been tested with gcov : half of them.. */
2116 if(unlikely(fld
->field_fixed
== 1)){
2118 if(unlikely(fld
== evT
->root_field
)) {
2119 size
= fld
->field_size
;
2120 goto end_getFieldtypeSize
;
2124 /* From gcov profiling : half string, half struct, can we gain something
2125 * from that ? (Mathieu) */
2126 switch(type
->type_class
) {
2128 element_number
= (int) type
->element_number
;
2129 if(fld
->field_fixed
== -1){
2130 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2131 0,fld
->child
[0], NULL
);
2132 if(size
== 0){ //has string or sequence
2133 fld
->field_fixed
= 0;
2135 fld
->field_fixed
= 1;
2136 size
*= element_number
;
2138 }else if(fld
->field_fixed
== 0){// has string or sequence
2140 for(i
=0;i
<element_number
;i
++){
2141 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2142 fld
->child
[0], evD
+size
);
2144 }else size
= fld
->field_size
;
2146 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2147 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2153 size1
= (int) ltt_type_size(fac
, type
);
2154 if(fld
->field_fixed
== -1){
2155 fld
->sequ_number_size
= size1
;
2156 fld
->field_fixed
= 0;
2157 size
= getFieldtypeSize(evT
, offsetRoot
,
2158 0,fld
->child
[0], NULL
);
2159 fld
->element_size
= size
;
2161 element_number
= getIntNumber(tf
,size1
,evD
);
2162 type
->element_number
= element_number
;
2163 if(fld
->element_size
> 0){
2164 size
= element_number
* fld
->element_size
;
2165 }else{//sequence has string or sequence
2167 for(i
=0;i
<element_number
;i
++){
2168 size
+= getFieldtypeSize(tf
, evT
,
2169 offsetRoot
+size
+size1
,size
+size1
,
2170 fld
->child
[0], evD
+size
+size1
);
2176 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2177 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2184 if(fld
->field_fixed
== -1){
2185 fld
->field_fixed
= 0;
2187 /* Hope my implementation is faster than strlen (Mathieu) */
2188 char *ptr
=(char*)evD
;
2190 /* from gcov : many many strings are empty, make it the common case.*/
2191 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2192 //size = ptr - (char*)evD + 1; //include end : '\0'
2194 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2195 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2200 element_number
= (int) type
->element_number
;
2202 /* tested with gcov */
2203 if(unlikely(fld
->field_fixed
== -1)){
2204 offset1
= offsetRoot
;
2206 for(i
=0;i
<element_number
;i
++){
2207 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2208 fld
->child
[i
], NULL
);
2209 if(likely(size1
> 0 && size
>= 0)){
2211 if(likely(offset1
>= 0)) offset1
+= size1
;
2219 if(unlikely(size
== -1)){
2220 fld
->field_fixed
= 0;
2222 }else fld
->field_fixed
= 1;
2223 }else if(likely(fld
->field_fixed
== 0)){
2224 offset1
= offsetRoot
;
2226 for(i
=0;unlikely(i
<element_number
);i
++){
2227 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2228 fld
->child
[i
], evD
+offset2
);
2233 }else size
= fld
->field_size
;
2234 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2235 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2239 if(unlikely(fld
->field_fixed
== -1)){
2240 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2241 fld
->field_fixed
= 1;
2242 }else size
= fld
->field_size
;
2244 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2245 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2250 fld
->offset_root
= offsetRoot
;
2251 fld
->offset_parent
= offsetParent
;
2252 fld
->field_size
= size
;
2254 end_getFieldtypeSize
:
2260 /*****************************************************************************
2262 * ltt_get_int : get an integer number
2264 * reverse_byte_order: must we reverse the byte order ?
2265 * size : the size of the integer
2266 * ptr : the data pointer
2268 * gint64 : a 64 bits integer
2269 ****************************************************************************/
2271 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2276 case 1: val
= *((gint8
*)data
); break;
2277 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2278 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2279 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2280 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2281 g_critical("get_int : integer size %d unknown", size
);
2288 /*****************************************************************************
2290 * ltt_get_uint : get an unsigned integer number
2292 * reverse_byte_order: must we reverse the byte order ?
2293 * size : the size of the integer
2294 * ptr : the data pointer
2296 * guint64 : a 64 bits unsigned integer
2297 ****************************************************************************/
2299 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2304 case 1: val
= *((gint8
*)data
); break;
2305 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2306 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2307 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2308 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2309 g_critical("get_uint : unsigned integer size %d unknown",
2318 /* get the node name of the system */
2320 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2322 return s
->node_name
;
2326 /* get the domain name of the system */
2328 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2330 return s
->domain_name
;
2334 /* get the description of the system */
2336 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2338 return s
->description
;
2342 /* get the start time of the trace */
2344 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2346 return s
->trace_start
;
2350 LttTracefile
*ltt_tracefile_new()
2352 return g_new(LttTracefile
, 1);
2355 void ltt_tracefile_destroy(LttTracefile
*tf
)
2360 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2365 /* Before library loading... */
2367 static void __attribute__((constructor
)) init(void)
2369 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2370 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2372 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");