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
)
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
->long_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
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
255 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
257 if(munmap(tf
->buffer
.head
,
258 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)))) {
259 g_warning("unmap size : %u\n",
260 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
261 perror("munmap error");
264 tf
->buffer
.head
= NULL
;
266 //read the first block
267 if(map_block(tf
,0)) {
268 perror("Cannot map block for tracefile");
276 if(munmap(tf
->buffer
.head
,
277 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)))) {
278 g_warning("unmap size : %u\n",
279 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
280 perror("munmap error");
289 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
295 /*****************************************************************************
296 *Open control and per cpu tracefiles
297 ****************************************************************************/
299 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
302 tf
= ltt_tracefile_open(t
,tracefile_name
);
304 t
->per_cpu_tracefile_number
++;
305 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
308 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
317 tf
= ltt_tracefile_open(t
,control_name
);
319 g_warning("ltt_tracefile_open_control : bad file descriptor");
322 t
->control_tracefile_number
++;
323 g_ptr_array_add(t
->control_tracefiles
,tf
);
325 //parse facilities tracefile to get base_id
326 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
328 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
330 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
332 fLoad
.name
= (gchar
*)pos
;
333 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
334 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
336 for(i
=0;i
<t
->facility_number
;i
++){
337 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
338 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
339 f
->base_id
= fLoad
.base_code
;
343 if(i
==t
->facility_number
) {
344 g_warning("Facility: %s, checksum: %u is not found",
345 fLoad
.name
,(unsigned int)fLoad
.checksum
);
348 }else if(ev
.event_id
== TRACE_BLOCK_START
){
350 }else if(ev
.event_id
== TRACE_BLOCK_END
){
353 g_warning("Not valid facilities trace file");
362 /*****************************************************************************
364 * ltt_tracefile_close: close a trace file,
366 * t : tracefile which will be closed
367 ****************************************************************************/
369 void ltt_tracefile_close(LttTracefile
*t
)
371 int page_size
= getpagesize();
373 if(t
->buffer
.head
!= NULL
)
374 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
375 g_warning("unmap size : %u\n",
376 PAGE_ALIGN(t
->buf_size
));
377 perror("munmap error");
385 /*****************************************************************************
386 *Get system information
387 ****************************************************************************/
389 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
396 GMarkupParseContext
* context
;
397 GError
* error
= NULL
;
398 GMarkupParser markup_parser
=
400 parser_start_element
,
403 NULL
, /* passthrough */
407 fd
= g_open(pathname
, O_RDONLY
, 0);
409 g_warning("Can not open file : %s\n", pathname
);
413 iochan
= g_io_channel_unix_new(fd
);
415 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
417 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
418 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
419 != G_IO_STATUS_EOF
) {
422 g_warning("Can not read xml file: \n%s\n", error
->message
);
425 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
427 g_warning("Can not parse xml file: \n%s\n", error
->message
);
430 g_markup_parse_context_free(context
);
432 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
434 g_warning("Can not close file: \n%s\n", error
->message
);
442 g_markup_parse_context_free(context
);
444 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
446 g_warning("Can not close file: \n%s\n", error
->message
);
457 /*****************************************************************************
458 *The following functions get facility/tracefile information
459 ****************************************************************************/
461 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
468 gchar fullname
[DIR_NAME_SIZE
];
469 GError
* error
= NULL
;
471 dir
= g_dir_open(eventdefs
, 0, &error
);
474 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
479 while((name
= g_dir_read_name(dir
)) != NULL
){
480 if(!g_pattern_match_simple("*.xml", name
)) continue;
481 strcpy(fullname
,eventdefs
);
482 strcat(fullname
,name
);
483 ltt_facility_open(t
,fullname
);
487 for(j
=0;j
<t
->facility_number
;j
++){
488 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
489 for(i
=0; i
<f
->event_number
; i
++){
491 setFieldsOffset(NULL
, et
, NULL
, t
);
498 /*****************************************************************************
499 *A trace is specified as a pathname to the directory containing all the
500 *associated data (control tracefiles, per cpu tracefiles, event
503 *When a trace is closed, all the associated facilities, types and fields
504 *are released as well.
508 /****************************************************************************
509 * get_absolute_pathname
511 * return the unique pathname in the system
513 * MD : Fixed this function so it uses realpath, dealing well with
514 * forgotten cases (.. were not used correctly before).
516 ****************************************************************************/
517 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
519 abs_pathname
[0] = '\0';
521 if ( realpath (pathname
, abs_pathname
) != NULL
)
525 /* error, return the original path unmodified */
526 strcpy(abs_pathname
, pathname
);
532 /* Search for something like : .*_.*
534 * The left side is the name, the right side is the number.
537 int get_tracefile_name_number(const gchar
*raw_name
,
541 guint raw_name_len
= strlen(raw_name
);
542 gchar char_name
[PATH_MAX
];
548 for(i
=raw_name_len
-1;i
>=0;i
--) {
549 if(raw_name
[i
] == '_') break;
551 if(i
==0) /* Either not found or name length is 0 */
555 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
557 if(endptr
== raw_name
+underscore_pos
+1)
558 return -1; /* No digit */
559 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
560 return -1; /* underflow / overflow */
562 strncpy(char_name
, raw_name
, underscore_pos
);
564 char_name
[underscore_pos
] = '\0';
566 *name
= g_quark_from_string(char_name
);
573 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
575 return &trace
->tracefiles
;
579 void compute_tracefile_group(GQuark key_id
,
581 struct compute_tracefile_group_args
*args
)
586 for(i
=0; i
<group
->len
; i
++) {
587 tf
= &g_array_index (group
, LttTracefile
, i
);
589 args
->func(tf
, args
->func_args
);
594 void ltt_tracefile_group_destroy(gpointer data
)
596 GArray
*group
= (GArray
*)data
;
600 for(i
=0; i
<group
->len
; i
++) {
601 tf
= &g_array_index (group
, LttTracefile
, i
);
603 ltt_tracefile_close(tf
);
605 g_array_free(group
, TRUE
);
608 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
610 GArray
*group
= (GArray
*)data
;
614 for(i
=0; i
<group
->len
; i
++) {
615 tf
= &g_array_index (group
, LttTracefile
, i
);
616 if(tf
->cpu_online
) return 1;
622 /* Open each tracefile under a specific directory. Put them in a
623 * GData : permits to access them using their tracefile group pathname.
624 * i.e. access control/modules tracefile group by index :
627 * relative path is the path relative to the trace root
628 * root path is the full path
630 * A tracefile group is simply an array where all the per cpu tracefiles sits.
633 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
634 gchar
*relative_path
)
636 DIR *dir
= opendir(root_path
);
637 struct dirent
*entry
;
638 struct stat stat_buf
;
641 gchar path
[PATH_MAX
];
646 gchar rel_path
[PATH_MAX
];
655 strncpy(path
, root_path
, PATH_MAX
-1);
656 path_len
= strlen(path
);
657 path
[path_len
] = '/';
659 path_ptr
= path
+ path_len
;
661 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
662 rel_path_len
= strlen(rel_path
);
663 rel_path
[rel_path_len
] = '/';
665 rel_path_ptr
= rel_path
+ rel_path_len
;
667 while((entry
= readdir(dir
)) != NULL
) {
669 if(entry
->d_name
[0] == '.') continue;
671 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
672 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
674 ret
= stat(path
, &stat_buf
);
680 g_debug("Tracefile file or directory : %s\n", path
);
682 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
684 if(S_ISDIR(stat_buf
.st_mode
)) {
686 g_debug("Entering subdirectory...\n");
687 ret
= open_tracefiles(trace
, path
, rel_path
);
688 if(ret
< 0) continue;
689 } else if(S_ISREG(stat_buf
.st_mode
)) {
694 if(get_tracefile_name_number(rel_path
, &name
, &num
))
695 continue; /* invalid name */
697 g_debug("Opening file.\n");
698 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
699 g_info("Error opening tracefile %s", path
);
701 continue; /* error opening the tracefile : bad magic number ? */
704 g_debug("Tracefile name is %s and number is %u",
705 g_quark_to_string(name
), num
);
707 tmp_tf
.cpu_online
= 1;
708 tmp_tf
.cpu_num
= num
;
711 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
713 /* Elements are automatically cleared when the array is allocated.
714 * It makes the cpu_online variable set to 0 : cpu offline, by default.
716 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
717 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
718 group
, ltt_tracefile_group_destroy
);
721 /* Add the per cpu tracefile to the named group */
722 unsigned int old_len
= group
->len
;
724 group
= g_array_set_size(group
, num
+1);
725 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
735 /* ltt_get_facility_description
737 * Opens the trace corresponding to the requested facility (identified by fac_id
740 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
742 * Returns 0 on success, or 1 on failure.
745 static int ltt_get_facility_description(LttFacility
*f
,
747 LttTracefile
*fac_tf
)
749 char desc_file_name
[PATH_MAX
];
754 text
= g_quark_to_string(t
->pathname
);
755 textlen
= strlen(text
);
757 if(textlen
>= PATH_MAX
) goto name_error
;
758 strcpy(desc_file_name
, text
);
760 text
= "/eventdefs/";
761 textlen
+=strlen(text
);
762 if(textlen
>= PATH_MAX
) goto name_error
;
763 strcat(desc_file_name
, text
);
765 text
= g_quark_to_string(f
->name
);
766 textlen
+=strlen(text
);
767 if(textlen
>= PATH_MAX
) goto name_error
;
768 strcat(desc_file_name
, text
);
771 textlen
+=strlen(text
);
772 if(textlen
>= PATH_MAX
) goto name_error
;
773 strcat(desc_file_name
, text
);
775 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
777 if(err
< 0) goto name_error
;
779 textlen
=strlen(desc_file_name
);
782 textlen
+=strlen(text
);
783 if(textlen
>= PATH_MAX
) goto name_error
;
784 strcat(desc_file_name
, text
);
786 err
= ltt_facility_open(f
, t
, desc_file_name
);
787 if(err
) goto facility_error
;
796 static void ltt_fac_ids_destroy(gpointer data
)
798 GArray
*fac_ids
= (GArray
*)data
;
800 g_array_free(fac_ids
, TRUE
);
804 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
805 * because it must be done just after the opening */
806 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
815 err
= ltt_tracefile_read_seek(tf
);
816 if(err
== EPERM
) goto seek_error
;
817 else if(err
== ERANGE
) break; /* End of tracefile */
819 err
= ltt_tracefile_read_update_event(tf
);
820 if(err
) goto update_error
;
822 /* We are on a facility load/or facility unload/ or heartbeat event */
824 * * facility 0 is hardcoded : this is the core facility. It will be shown
825 * in the facility array though, and is shown as "loaded builtin" in the
827 * It contains event :
829 * 1 : facility unload
830 * 2 : state dump facility load
833 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
834 /* Should only contain core facility */
835 g_warning("Error in processing facility file %s, "
836 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
837 tf
->event
.facility_id
);
842 struct LttFacilityLoad
*fac_load_data
;
843 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
847 switch((enum ltt_core_events
)tf
->event
.event_id
) {
848 case LTT_EVENT_FACILITY_LOAD
:
849 fac_name
= (char*)(tf
->event
.data
);
850 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
853 (struct LttFacilityLoad
*)
854 (tf
->event
.data
+ strlen(fac_name
) + 1);
855 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
856 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
857 g_assert(fac
->exists
== 0);
858 fac
->name
= g_quark_from_string(fac_name
);
859 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
860 &fac_load_data
->checksum
);
861 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
862 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
863 &fac_load_data
->pointer_size
);
864 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
865 &fac_load_data
->long_size
);
866 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
867 &fac_load_data
->size_t_size
);
868 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
869 &fac_load_data
->alignment
);
871 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
872 continue; /* error opening description */
874 fac
->trace
= tf
->trace
;
876 /* Preset the field offsets */
877 for(i
=0; i
<fac
->events
->len
; i
++){
878 et
= &g_array_index(fac
->events
, LttEventType
, i
);
879 set_fields_offsets(tf
, et
);
884 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
886 if(fac_ids
== NULL
) {
887 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
888 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
890 fac_ids
, ltt_fac_ids_destroy
);
892 g_array_append_val(fac_ids
, fac
->id
);
895 case LTT_EVENT_FACILITY_UNLOAD
:
896 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
897 /* We don't care about unload : facilities ID are valid for the whole
898 * trace. They simply won't be used after the unload. */
900 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
901 fac_name
= (char*)(tf
->event
.data
);
902 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
904 fac_state_dump_load_data
=
905 (struct LttStateDumpFacilityLoad
*)
906 (tf
->event
.data
+ strlen(fac_name
) + 1);
907 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
908 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
909 g_assert(fac
->exists
== 0);
910 fac
->name
= g_quark_from_string(fac_name
);
911 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
912 &fac_state_dump_load_data
->checksum
);
913 fac
->id
= fac_state_dump_load_data
->id
;
914 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
915 &fac_state_dump_load_data
->pointer_size
);
916 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
917 &fac_state_dump_load_data
->long_size
);
918 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
919 &fac_state_dump_load_data
->size_t_size
);
920 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
921 &fac_state_dump_load_data
->alignment
);
922 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
923 continue; /* error opening description */
925 fac
->trace
= tf
->trace
;
927 /* Preset the field offsets */
928 for(i
=0; i
<fac
->events
->len
; i
++){
929 et
= &g_array_index(fac
->events
, LttEventType
, i
);
930 set_fields_offsets(tf
, et
);
935 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
937 if(fac_ids
== NULL
) {
938 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
939 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
941 fac_ids
, ltt_fac_ids_destroy
);
943 g_array_append_val(fac_ids
, fac
->id
);
946 case LTT_EVENT_HEARTBEAT
:
949 g_warning("Error in processing facility file %s, "
950 "unknown event id %hhu in core facility.",
951 g_quark_to_string(tf
->name
),
965 g_warning("An error occured in facility tracefile parsing");
970 LttTrace
*ltt_trace_open(const gchar
*pathname
)
972 gchar abs_path
[PATH_MAX
];
977 struct ltt_block_start_header
*header
;
979 struct dirent
*entry
;
980 guint control_found
= 0;
981 guint eventdefs_found
= 0;
982 struct stat stat_buf
;
983 gchar path
[PATH_MAX
];
985 t
= g_new(LttTrace
, 1);
986 if(!t
) goto alloc_error
;
988 get_absolute_pathname(pathname
, abs_path
);
989 t
->pathname
= g_quark_from_string(abs_path
);
991 g_datalist_init(&t
->tracefiles
);
993 /* Test to see if it looks like a trace */
994 dir
= opendir(abs_path
);
999 while((entry
= readdir(dir
)) != NULL
) {
1000 strcpy(path
, abs_path
);
1002 strcat(path
, entry
->d_name
);
1003 ret
= stat(path
, &stat_buf
);
1008 if(S_ISDIR(stat_buf
.st_mode
)) {
1009 if(strcmp(entry
->d_name
, "control") == 0) {
1012 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1013 eventdefs_found
= 1;
1019 if(!control_found
|| !eventdefs_found
) goto find_error
;
1021 /* Open all the tracefiles */
1022 if(open_tracefiles(t
, abs_path
, "")) {
1023 g_warning("Error opening tracefile %s", abs_path
);
1027 /* Prepare the facilities containers : array and mapping */
1028 /* Array is zeroed : the "exists" field is set to false by default */
1029 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1030 TRUE
, sizeof(LttFacility
),
1032 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1034 g_datalist_init(&t
->facilities_by_name
);
1036 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1037 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1039 g_error("Trace %s has no facility tracefile", abs_path
);
1041 goto facilities_error
;
1044 /* Get the trace information for the control/facility 0 tracefile */
1045 g_assert(group
->len
> 0);
1046 tf
= &g_array_index (group
, LttTracefile
, 0);
1047 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1048 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_type
);
1049 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_variant
);
1050 t
->arch_size
= header
->trace
.arch_size
;
1051 t
->ltt_major_version
= header
->trace
.major_version
;
1052 t
->ltt_minor_version
= header
->trace
.minor_version
;
1053 t
->flight_recorder
= header
->trace
.flight_recorder
;
1054 t
->has_heartbeat
= header
->trace
.has_heartbeat
;
1055 t
->has_alignment
= header
->trace
.has_alignment
;
1056 t
->has_tsc
= header
->trace
.has_tsc
;
1058 t
->num_cpu
= group
->len
;
1060 for(i
=0; i
<group
->len
; i
++) {
1061 tf
= &g_array_index (group
, LttTracefile
, i
);
1062 if(ltt_process_facility_tracefile(tf
))
1063 goto facilities_error
;
1068 /* Error handling */
1070 g_datalist_clear(&t
->facilities_by_name
);
1071 g_array_free(t
->facilities_by_num
, TRUE
);
1073 g_datalist_clear(&t
->tracefiles
);
1081 GQuark
ltt_trace_name(const LttTrace
*t
)
1087 /******************************************************************************
1088 * When we copy a trace, we want all the opening actions to happen again :
1089 * the trace will be reopened and totally independant from the original.
1090 * That's why we call ltt_trace_open.
1091 *****************************************************************************/
1092 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1094 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1097 void ltt_trace_close(LttTrace
*t
)
1102 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1103 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1105 ltt_facility_close(fac
);
1108 g_datalist_clear(&t
->facilities_by_name
);
1109 g_array_free(t
->facilities_by_num
, TRUE
);
1110 g_datalist_clear(&t
->tracefiles
);
1115 /*****************************************************************************
1116 *Get the system description of the trace
1117 ****************************************************************************/
1119 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1121 g_assert(id
< t
->facilities_by_num
->len
);
1122 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1125 /* ltt_trace_facility_get_by_name
1127 * Returns the GArray of facility indexes. All the fac_ids that matches the
1128 * requested facility name.
1130 * If name is not found, returns NULL.
1132 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1134 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1137 /*****************************************************************************
1138 * Functions to discover all the event types in the trace
1139 ****************************************************************************/
1142 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1146 unsigned int num
= t
->facility_number
;
1150 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1151 count
+= f
->event_number
;
1158 //use an iteration on all the trace facilities, and inside iteration on all the
1159 //event types in each facilities instead.
1160 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1162 LttEventType
*event_type
;
1165 f
= ltt_trace_facility_by_id(t
,evId
);
1167 if(unlikely(!f
)) event_type
= NULL
;
1168 else event_type
= f
->events
[evId
- f
->base_id
];
1175 /*****************************************************************************
1176 * ltt_trace_find_tracefile
1178 * Find a tracefile by name and index in the group.
1180 * Returns a pointer to the tracefiles, else NULL.
1181 ****************************************************************************/
1183 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1188 /*****************************************************************************
1189 * Get the start time and end time of the trace
1190 ****************************************************************************/
1192 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1193 LttTime
*start
, LttTime
*end
)
1197 err
= map_block(tf
, 0);
1199 g_error("Can not map block");
1200 *start
= ltt_time_infinite
;
1202 *start
= tf
->buffer
.begin
.timestamp
;
1204 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1206 g_error("Can not map block");
1207 *end
= ltt_time_zero
;
1209 *end
= tf
->buffer
.end
.timestamp
;
1212 struct tracefile_time_span_get_args
{
1218 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1220 struct tracefile_time_span_get_args
*args
=
1221 (struct tracefile_time_span_get_args
*)user_data
;
1223 GArray
*group
= (GArray
*)data
;
1229 for(i
=0; i
<group
->len
; i
++) {
1230 tf
= &g_array_index (group
, LttTracefile
, i
);
1231 if(tf
->cpu_online
) {
1232 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1233 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1234 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1239 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1241 LttTime min_start
= ltt_time_infinite
;
1242 LttTime max_end
= ltt_time_zero
;
1243 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1245 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1247 if(start
!= NULL
) *start
= min_start
;
1248 if(end
!= NULL
) *end
= max_end
;
1253 /*****************************************************************************
1254 *Get the name of a tracefile
1255 ****************************************************************************/
1257 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1263 guint
ltt_tracefile_num(LttTracefile
*tf
)
1268 /*****************************************************************************
1269 * Get the number of blocks in the tracefile
1270 ****************************************************************************/
1272 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1274 return tf
->num_blocks
;
1278 /* Seek to the first event in a tracefile that has a time equal or greater than
1279 * the time passed in parameter.
1281 * If the time parameter is outside the tracefile time span, seek to the first
1282 * event or if after, return ERANGE.
1284 * If the time parameter is before the first event, we have to seek specially to
1287 * If the time is after the end of the trace, return ERANGE.
1289 * Do a binary search to find the right block, then a sequential search in the
1290 * block to find the event.
1292 * In the special case where the time requested fits inside a block that has no
1293 * event corresponding to the requested time, the first event of the next block
1296 * IMPORTANT NOTE : // FIXME everywhere...
1298 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1299 * you will jump over an event if you do.
1301 * Return value : 0 : no error, the tf->event can be used
1302 * ERANGE : time if after the last event of the trace
1303 * otherwise : this is an error.
1307 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1311 unsigned int block_num
, high
, low
;
1313 /* seek at the beginning of trace */
1314 err
= map_block(tf
, 0); /* First block */
1316 g_error("Can not map block");
1320 /* If the time is lower or equal the beginning of the trace,
1321 * go to the first event. */
1322 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1323 ret
= ltt_tracefile_read(tf
);
1324 if(ret
== ERANGE
) goto range
;
1325 else if (ret
) goto fail
;
1326 goto found
; /* There is either no event in the trace or the event points
1327 to the first event in the trace */
1330 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1332 g_error("Can not map block");
1336 /* If the time is after the end of the trace, return ERANGE. */
1337 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1341 /* Binary search the block */
1342 high
= tf
->num_blocks
- 1;
1346 block_num
= ((high
-low
) / 2) + low
;
1348 err
= map_block(tf
, block_num
);
1350 g_error("Can not map block");
1354 /* We cannot divide anymore : this is what would happen if the time
1355 * requested was exactly between two consecutive buffers'end and start
1356 * timestamps. This is also what would happend if we didn't deal with out
1357 * of span cases prior in this function. */
1358 /* The event is right in the buffer!
1359 * (or in the next buffer first event) */
1361 ret
= ltt_tracefile_read(tf
);
1362 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1363 else if(ret
) goto fail
;
1365 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1369 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1370 /* go to lower part */
1372 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1373 /* go to higher part */
1375 } else {/* The event is right in the buffer!
1376 (or in the next buffer first event) */
1378 ret
= ltt_tracefile_read(tf
);
1379 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1380 else if(ret
) goto fail
;
1382 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1394 /* Error handling */
1396 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1397 g_quark_to_string(tf
->name
));
1402 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1406 if(ep
->tracefile
!= tf
) {
1410 err
= map_block(tf
, ep
->block
);
1412 g_error("Can not map block");
1416 tf
->event
.offset
= ep
->offset
;
1418 err
= ltt_tracefile_read_update_event(tf
);
1420 err
= ltt_tracefile_read_op(tf
);
1426 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1427 g_quark_to_string(tf
->name
));
1431 /* Calculate the real event time based on the buffer boundaries */
1432 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1436 g_assert(tf
->trace
->has_tsc
);
1438 time
= ltt_time_from_uint64(
1439 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1440 tf
->buffer
.nsecs_per_cycle
);
1441 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1447 /* Get the current event of the tracefile : valid until the next read */
1448 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1455 /*****************************************************************************
1457 * ltt_tracefile_read : Read the next event in the tracefile
1462 * Returns 0 if an event can be used in tf->event.
1463 * Returns ERANGE on end of trace. The event in tf->event still can be used
1464 * (if the last block was not empty).
1465 * Returns EPERM on error.
1467 * This function does make the tracefile event structure point to the event
1468 * currently pointed to by the tf->event.
1470 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1471 * reinitialize it after an error if you want results to be coherent.
1472 * It would be the case if a end of trace last buffer has no event : the end
1473 * of trace wouldn't be returned, but an error.
1474 * We make the assumption there is at least one event per buffer.
1475 ****************************************************************************/
1477 int ltt_tracefile_read(LttTracefile
*tf
)
1481 err
= ltt_tracefile_read_seek(tf
);
1483 err
= ltt_tracefile_read_update_event(tf
);
1485 err
= ltt_tracefile_read_op(tf
);
1491 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1495 /* Get next buffer until we finally have an event, or end of trace */
1497 err
= ltt_seek_next_event(tf
);
1498 if(unlikely(err
== ENOPROTOOPT
)) {
1502 /* Are we at the end of the buffer ? */
1504 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1507 /* get next block */
1508 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1510 g_error("Can not map block");
1514 } else break; /* We found an event ! */
1521 /* do specific operation on events */
1522 int ltt_tracefile_read_op(LttTracefile
*tf
)
1528 /* do event specific operation */
1530 /* do something if its an heartbeat event : increment the heartbeat count */
1531 //if(event->facility_id == LTT_FACILITY_CORE)
1532 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1533 // tf->cur_heart_beat_number++;
1539 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1540 * event specific operation. */
1541 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1547 pos
= tf
->buffer
.head
+ event
->offset
;
1549 /* Read event header */
1553 if(tf
->trace
->has_tsc
) {
1554 if(tf
->trace
->has_heartbeat
) {
1555 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1557 /* 32 bits -> 64 bits tsc */
1558 /* note : still works for seek and non seek cases. */
1559 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1560 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1562 | (guint64
)event
->time
.timestamp
;
1563 event
->tsc
= tf
->buffer
.tsc
;
1566 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1567 | (guint64
)event
->time
.timestamp
;
1568 event
->tsc
= tf
->buffer
.tsc
;
1570 pos
+= sizeof(guint32
);
1572 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1573 tf
->buffer
.tsc
= event
->tsc
;
1574 pos
+= sizeof(guint64
);
1577 event
->event_time
= ltt_interpolate_time(tf
, event
);
1579 event
->time
.delta
.tv_sec
= 0;
1580 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1581 pos
) * NSEC_PER_USEC
;
1583 event
->tsc
= tf
->buffer
.tsc
;
1585 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1587 pos
+= sizeof(guint32
);
1590 event
->facility_id
= *(guint8
*)pos
;
1591 pos
+= sizeof(guint8
);
1593 event
->event_id
= *(guint8
*)pos
;
1594 pos
+= sizeof(guint8
);
1596 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1597 pos
+= sizeof(guint16
);
1601 /* get the data size and update the event fields with the current
1603 ltt_update_event_size(tf
);
1609 /****************************************************************************
1611 * map_block : map a block from the file
1613 * lttdes : ltt trace file
1614 * whichBlock : the block which will be read
1617 * EINVAL : lseek fail
1618 * EIO : can not read from the file
1619 ****************************************************************************/
1621 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1623 int page_size
= getpagesize();
1624 struct ltt_block_start_header
*header
;
1626 g_assert(block_num
< tf
->num_blocks
);
1628 if(tf
->buffer
.head
!= NULL
) {
1629 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1630 g_warning("unmap size : %u\n",
1631 PAGE_ALIGN(tf
->buf_size
));
1632 perror("munmap error");
1638 /* Multiple of pages aligned head */
1639 tf
->buffer
.head
= mmap(0,
1640 PAGE_ALIGN(tf
->buf_size
),
1641 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1642 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1644 if(tf
->buffer
.head
== MAP_FAILED
) {
1645 perror("Error in allocating memory for buffer of tracefile");
1649 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1652 tf
->buffer
.index
= block_num
;
1654 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1656 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1657 &header
->begin
.timestamp
);
1658 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1659 g_debug("block %u begin : %lu.%lu", block_num
,
1660 tf
->buffer
.begin
.timestamp
.tv_sec
, tf
->buffer
.begin
.timestamp
.tv_nsec
);
1661 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1662 &header
->begin
.cycle_count
);
1663 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1664 &header
->end
.timestamp
);
1665 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1666 g_debug("block %u end : %lu.%lu", block_num
,
1667 tf
->buffer
.end
.timestamp
.tv_sec
, tf
->buffer
.end
.timestamp
.tv_nsec
);
1668 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1669 &header
->end
.cycle_count
);
1670 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1671 &header
->lost_size
);
1673 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1674 tf
->event
.tsc
= tf
->buffer
.tsc
;
1677 * eventually support variable buffer size : will need a partial pre-read of
1678 * the headers to create an index when we open the trace... eventually. */
1679 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1680 &header
->buf_size
));
1682 /* Now that the buffer is mapped, calculate the time interpolation for the
1685 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1687 /* Make the current event point to the beginning of the buffer :
1688 * it means that the event read must get the first event. */
1689 tf
->event
.tracefile
= tf
;
1690 tf
->event
.block
= block_num
;
1691 tf
->event
.offset
= 0;
1700 /* It will update the fields offsets too */
1701 void ltt_update_event_size(LttTracefile
*tf
)
1705 /* Specific handling of core events : necessary to read the facility control
1707 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1708 tf
->event
.facility_id
);
1710 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1711 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1712 case LTT_EVENT_FACILITY_LOAD
:
1713 size
= strlen((char*)tf
->event
.data
) + 1;
1714 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1715 size
+= sizeof(struct LttFacilityLoad
);
1717 case LTT_EVENT_FACILITY_UNLOAD
:
1718 g_debug("Update Event facility unload");
1719 size
= sizeof(struct LttFacilityUnload
);
1721 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1722 size
= strlen((char*)tf
->event
.data
) + 1;
1723 g_debug("Update Event facility load state dump of facility %s",
1724 (char*)tf
->event
.data
);
1725 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1727 case LTT_EVENT_HEARTBEAT
:
1728 g_debug("Update Event heartbeat");
1729 size
= sizeof(TimeHeartbeat
);
1732 g_warning("Error in getting event size : tracefile %s, "
1733 "unknown event id %hhu in core facility.",
1734 g_quark_to_string(tf
->name
),
1735 tf
->event
.event_id
);
1736 goto event_id_error
;
1741 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1742 tf
->event
.facility_id
,
1743 tf
->event
.facility_id
,
1744 g_quark_to_string(tf
->name
));
1745 goto facility_error
;
1748 LttEventType
*event_type
=
1749 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1752 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1754 g_quark_to_string(f
->name
),
1755 g_quark_to_string(tf
->name
));
1756 goto event_type_error
;
1759 if(event_type
->root_field
)
1760 size
= get_field_type_size(tf
, event_type
,
1761 0, 0, event_type
->root_field
, tf
->event
.data
);
1765 g_debug("Event root field : f.e %hhu.%hhu size %zd",
1766 tf
->event
.facility_id
,
1767 tf
->event
.event_id
, size
);
1770 tf
->event
.data_size
= size
;
1772 /* Check consistency between kernel and LTTV structure sizes */
1773 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1780 tf
->event
.data_size
= 0;
1784 /* Take the tf current event offset and use the event facility id and event id
1785 * to figure out where is the next event offset.
1787 * This is an internal function not aiming at being used elsewhere : it will
1788 * not jump over the current block limits. Please consider using
1789 * ltt_tracefile_read to do this.
1791 * Returns 0 on success
1792 * ERANGE if we are at the end of the buffer.
1793 * ENOPROTOOPT if an error occured when getting the current event size.
1795 static int ltt_seek_next_event(LttTracefile
*tf
)
1800 /* seek over the buffer header if we are at the buffer start */
1801 if(tf
->event
.offset
== 0) {
1802 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
);
1804 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1811 pos
= tf
->event
.data
;
1813 if(tf
->event
.data_size
< 0) goto error
;
1815 pos
+= (size_t)tf
->event
.data_size
;
1817 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1819 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1828 g_error("Error in ltt_seek_next_event for tracefile %s",
1829 g_quark_to_string(tf
->name
));
1834 /*****************************************************************************
1836 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1839 ****************************************************************************/
1841 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1843 LttTime lBufTotalTime
; /* Total time for this buffer */
1844 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1845 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1847 /* Calculate the total time for this buffer */
1848 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1849 tf
->buffer
.begin
.timestamp
);
1851 /* Calculate the total cycles for this bufffer */
1852 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1853 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1855 /* Convert the total time to double */
1856 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1858 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1862 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1864 LttField
* rootFld
= evT
->root_field
;
1865 // rootFld->base_address = evD;
1868 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1869 evT
, 0,0,rootFld
, evD
);
1873 /*****************************************************************************
1875 * set_fields_offsets : set the precomputable offset of the fields
1877 * tracefile : opened trace file
1878 * event_type : the event type
1879 ****************************************************************************/
1881 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1883 LttField
*field
= event_type
->root_field
;
1884 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1887 preset_field_type_size(tf
, event_type
, 0, 0,
1888 &fixed_root
, &fixed_parent
,
1894 /*****************************************************************************
1896 * preset_field_type_size : set the fixed sizes of the field type
1899 * event_type : event type
1900 * offset_root : offset from the root
1901 * offset_parent : offset from the parent
1902 * fixed_root : Do we know a fixed offset to the root ?
1903 * fixed_parent : Do we know a fixed offset to the parent ?
1905 ****************************************************************************/
1906 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1907 off_t offset_root
, off_t offset_parent
,
1908 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1911 enum field_status local_fixed_root
, local_fixed_parent
;
1915 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1916 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1917 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1919 type
= field
->field_type
;
1921 field
->fixed_root
= *fixed_root
;
1922 if(field
->fixed_root
== FIELD_FIXED
)
1923 field
->offset_root
= offset_root
;
1925 field
->offset_root
= 0;
1927 field
->fixed_parent
= *fixed_parent
;
1928 if(field
->fixed_parent
== FIELD_FIXED
)
1929 field
->offset_parent
= offset_parent
;
1931 field
->offset_parent
= 0;
1933 size_t current_root_offset
;
1934 size_t current_offset
;
1935 enum field_status current_child_status
, final_child_status
;
1938 switch(type
->type_class
) {
1943 field
->field_size
= ltt_type_size(tf
->trace
, type
);
1944 field
->fixed_size
= FIELD_FIXED
;
1947 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
1948 field
->fixed_size
= FIELD_FIXED
;
1952 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
1953 field
->fixed_size
= FIELD_FIXED
;
1958 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
1959 field
->fixed_size
= FIELD_FIXED
;
1962 local_fixed_root
= FIELD_VARIABLE
;
1963 local_fixed_parent
= FIELD_VARIABLE
;
1964 preset_field_type_size(tf
, event_type
,
1966 &local_fixed_root
, &local_fixed_parent
,
1968 field
->fixed_size
= FIELD_VARIABLE
;
1969 field
->field_size
= 0;
1970 *fixed_root
= FIELD_VARIABLE
;
1971 *fixed_parent
= FIELD_VARIABLE
;
1974 field
->fixed_size
= FIELD_VARIABLE
;
1975 field
->field_size
= 0;
1976 *fixed_root
= FIELD_VARIABLE
;
1977 *fixed_parent
= FIELD_VARIABLE
;
1980 local_fixed_root
= FIELD_VARIABLE
;
1981 local_fixed_parent
= FIELD_VARIABLE
;
1982 preset_field_type_size(tf
, event_type
,
1984 &local_fixed_root
, &local_fixed_parent
,
1986 field
->fixed_size
= field
->child
[0]->fixed_size
;
1987 if(field
->fixed_size
== FIELD_FIXED
) {
1988 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
1990 field
->field_size
= 0;
1991 *fixed_root
= FIELD_VARIABLE
;
1992 *fixed_parent
= FIELD_VARIABLE
;
1996 current_root_offset
= field
->offset_root
;
1998 current_child_status
= FIELD_FIXED
;
1999 for(i
=0;i
<type
->element_number
;i
++) {
2000 preset_field_type_size(tf
, event_type
,
2001 current_root_offset
, current_offset
,
2002 fixed_root
, ¤t_child_status
,
2004 if(current_child_status
== FIELD_FIXED
) {
2005 current_root_offset
+= field
->child
[i
]->field_size
;
2006 current_offset
+= field
->child
[i
]->field_size
;
2008 current_root_offset
= 0;
2012 if(current_child_status
!= FIELD_FIXED
) {
2013 *fixed_parent
= current_child_status
;
2014 field
->field_size
= 0;
2015 field
->fixed_size
= current_child_status
;
2017 field
->field_size
= current_offset
;
2018 field
->fixed_size
= FIELD_FIXED
;
2022 current_root_offset
= field
->offset_root
;
2025 final_child_status
= FIELD_FIXED
;
2026 for(i
=0;i
<type
->element_number
;i
++) {
2027 enum field_status current_root_child_status
= FIELD_FIXED
;
2028 enum field_status current_child_status
= FIELD_FIXED
;
2029 preset_field_type_size(tf
, event_type
,
2030 current_root_offset
, current_offset
,
2031 ¤t_root_child_status
, ¤t_child_status
,
2033 if(current_child_status
!= FIELD_FIXED
)
2034 final_child_status
= current_child_status
;
2036 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2038 if(final_child_status
!= FIELD_FIXED
) {
2039 *fixed_root
= final_child_status
;
2040 *fixed_parent
= final_child_status
;
2041 field
->field_size
= 0;
2042 field
->fixed_size
= current_child_status
;
2044 field
->field_size
= max_size
;
2045 field
->fixed_size
= FIELD_FIXED
;
2053 /*****************************************************************************
2055 * check_fields_compatibility : Check for compatibility between two fields :
2056 * do they use the same inner structure ?
2058 * event_type1 : event type
2059 * event_type2 : event type
2062 *Returns : 0 if identical
2064 ****************************************************************************/
2065 gint
check_fields_compatibility(LttEventType
*event_type1
,
2066 LttEventType
*event_type2
,
2067 LttField
*field1
, LttField
*field2
)
2069 guint different
= 0;
2074 if(field1
== NULL
) {
2075 if(field2
== NULL
) goto end
;
2080 } else if(field2
== NULL
) {
2085 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2086 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2087 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2088 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2089 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2090 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2092 type1
= field1
->field_type
;
2093 type2
= field2
->field_type
;
2095 if(type1
->type_class
!= type2
->type_class
) {
2099 if(type1
->element_name
!= type2
->element_name
) {
2104 switch(type1
->type_class
) {
2114 if(field1
->field_size
!= field2
->field_size
) {
2120 if(type1
->element_number
!= type2
->element_number
) {
2124 for(i
=0;i
<type1
->element_number
;i
++) {
2125 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2132 /* Two elements : size and child */
2133 g_assert(type1
->element_number
!= type2
->element_number
);
2134 for(i
=0;i
<type1
->element_number
;i
++) {
2135 if(check_fields_compatibility(event_type1
, event_type2
,
2136 field1
->child
[0], field2
->child
[0])) {
2145 if(field1
->field_size
!= field2
->field_size
) {
2149 /* Two elements : size and child */
2150 g_assert(type1
->element_number
!= type2
->element_number
);
2151 for(i
=0;i
<type1
->element_number
;i
++) {
2152 if(check_fields_compatibility(event_type1
, event_type2
,
2153 field1
->child
[0], field2
->child
[0])) {
2161 if(type1
->element_number
!= type2
->element_number
) {
2165 for(i
=0;i
<type1
->element_number
;i
++) {
2166 if(check_fields_compatibility(event_type1
, event_type2
,
2167 field1
->child
[0], field2
->child
[0])) {
2182 /*****************************************************************************
2184 * getFieldtypeSize: get the size of the field type (primitive type)
2187 * offsetRoot : offset from the root
2188 * offsetParent : offset from the parrent
2190 * evD : event data, it may be NULL
2192 * int : size of the field
2193 ****************************************************************************/
2195 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2196 LttEventType
* evT
, gint offsetRoot
,
2197 gint offsetParent
, LttField
* fld
, void *evD
)
2199 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2200 LttType
* type
= fld
->field_type
;
2202 /* This likely has been tested with gcov : half of them.. */
2203 if(unlikely(fld
->field_fixed
== 1)){
2205 if(unlikely(fld
== evT
->root_field
)) {
2206 size
= fld
->field_size
;
2207 goto end_getFieldtypeSize
;
2211 /* From gcov profiling : half string, half struct, can we gain something
2212 * from that ? (Mathieu) */
2213 switch(type
->type_class
) {
2215 element_number
= (int) type
->element_number
;
2216 if(fld
->field_fixed
== -1){
2217 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2218 0,fld
->child
[0], NULL
);
2219 if(size
== 0){ //has string or sequence
2220 fld
->field_fixed
= 0;
2222 fld
->field_fixed
= 1;
2223 size
*= element_number
;
2225 }else if(fld
->field_fixed
== 0){// has string or sequence
2227 for(i
=0;i
<element_number
;i
++){
2228 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2229 fld
->child
[0], evD
+size
);
2231 }else size
= fld
->field_size
;
2233 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2234 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2240 size1
= (int) ltt_type_size(fac
, type
);
2241 if(fld
->field_fixed
== -1){
2242 fld
->sequ_number_size
= size1
;
2243 fld
->field_fixed
= 0;
2244 size
= getFieldtypeSize(evT
, offsetRoot
,
2245 0,fld
->child
[0], NULL
);
2246 fld
->element_size
= size
;
2248 element_number
= getIntNumber(tf
,size1
,evD
);
2249 type
->element_number
= element_number
;
2250 if(fld
->element_size
> 0){
2251 size
= element_number
* fld
->element_size
;
2252 }else{//sequence has string or sequence
2254 for(i
=0;i
<element_number
;i
++){
2255 size
+= getFieldtypeSize(tf
, evT
,
2256 offsetRoot
+size
+size1
,size
+size1
,
2257 fld
->child
[0], evD
+size
+size1
);
2263 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2264 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2271 if(fld
->field_fixed
== -1){
2272 fld
->field_fixed
= 0;
2274 /* Hope my implementation is faster than strlen (Mathieu) */
2275 char *ptr
=(char*)evD
;
2277 /* from gcov : many many strings are empty, make it the common case.*/
2278 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2279 //size = ptr - (char*)evD + 1; //include end : '\0'
2281 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2282 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2287 element_number
= (int) type
->element_number
;
2289 /* tested with gcov */
2290 if(unlikely(fld
->field_fixed
== -1)){
2291 offset1
= offsetRoot
;
2293 for(i
=0;i
<element_number
;i
++){
2294 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2295 fld
->child
[i
], NULL
);
2296 if(likely(size1
> 0 && size
>= 0)){
2298 if(likely(offset1
>= 0)) offset1
+= size1
;
2306 if(unlikely(size
== -1)){
2307 fld
->field_fixed
= 0;
2309 }else fld
->field_fixed
= 1;
2310 }else if(likely(fld
->field_fixed
== 0)){
2311 offset1
= offsetRoot
;
2313 for(i
=0;unlikely(i
<element_number
);i
++){
2314 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2315 fld
->child
[i
], evD
+offset2
);
2320 }else size
= fld
->field_size
;
2321 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2322 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2326 if(unlikely(fld
->field_fixed
== -1)){
2327 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2328 fld
->field_fixed
= 1;
2329 }else size
= fld
->field_size
;
2331 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2332 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2337 fld
->offset_root
= offsetRoot
;
2338 fld
->offset_parent
= offsetParent
;
2339 fld
->field_size
= size
;
2341 end_getFieldtypeSize
:
2347 /*****************************************************************************
2349 * ltt_get_int : get an integer number
2351 * reverse_byte_order: must we reverse the byte order ?
2352 * size : the size of the integer
2353 * ptr : the data pointer
2355 * gint64 : a 64 bits integer
2356 ****************************************************************************/
2358 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2363 case 1: val
= *((gint8
*)data
); break;
2364 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2365 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2366 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2367 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2368 g_critical("get_int : integer size %d unknown", size
);
2375 /*****************************************************************************
2377 * ltt_get_uint : get an unsigned integer number
2379 * reverse_byte_order: must we reverse the byte order ?
2380 * size : the size of the integer
2381 * ptr : the data pointer
2383 * guint64 : a 64 bits unsigned integer
2384 ****************************************************************************/
2386 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2391 case 1: val
= *((gint8
*)data
); break;
2392 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2393 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2394 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2395 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2396 g_critical("get_uint : unsigned integer size %d unknown",
2405 /* get the node name of the system */
2407 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2409 return s
->node_name
;
2413 /* get the domain name of the system */
2415 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2417 return s
->domain_name
;
2421 /* get the description of the system */
2423 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2425 return s
->description
;
2429 /* get the start time of the trace */
2431 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2433 return s
->trace_start
;
2437 LttTracefile
*ltt_tracefile_new()
2439 return g_new(LttTracefile
, 1);
2442 void ltt_tracefile_destroy(LttTracefile
*tf
)
2447 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2452 /* Before library loading... */
2454 static void __attribute__((constructor
)) init(void)
2456 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2457 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2459 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");