1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2005 Mathieu Desnoyers
4 * Complete rewrite from the original version made by XangXiu Yang.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License Version 2 as
8 * published by the Free Software Foundation;
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 #include <sys/types.h>
45 #include "ltt-private.h"
46 #include <ltt/trace.h>
47 #include <ltt/facility.h>
48 #include <ltt/event.h>
50 #include <ltt/ltt-types.h>
53 /* Facility names used in this file */
55 GQuark LTT_FACILITY_NAME_HEARTBEAT
,
56 LTT_EVENT_NAME_HEARTBEAT
;
57 GQuark LTT_TRACEFILE_NAME_FACILITIES
;
64 #define __UNUSED__ __attribute__((__unused__))
66 #define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
69 #define g_debug(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format)
74 /* Those macros must be called from within a function where page_size is a known
76 #define PAGE_MASK (~(page_size-1))
77 #define PAGE_ALIGN(addr) (((addr)+page_size-1)&PAGE_MASK)
79 /* set the offset of the fields belonging to the event,
80 need the information of the archecture */
81 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
);
82 //size_t get_fields_offsets(LttTracefile *tf, LttEventType *event_type, void *data);
84 /* get the size of the field type according to
85 * The facility size information. */
86 static inline void preset_field_type_size(LttTracefile
*tf
,
87 LttEventType
*event_type
,
88 off_t offset_root
, off_t offset_parent
,
89 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
92 /* map a fixed size or a block information from the file (fd) */
93 static gint
map_block(LttTracefile
* tf
, guint block_num
);
95 /* calculate nsec per cycles for current block */
96 static double calc_nsecs_per_cycle(LttTracefile
* t
);
98 /* go to the next event */
99 static int ltt_seek_next_event(LttTracefile
*tf
);
101 void ltt_update_event_size(LttTracefile
*tf
);
104 /* Functions to parse system.xml file (using glib xml parser) */
105 static void parser_start_element (GMarkupParseContext __UNUSED__
*context
,
106 const gchar
*element_name
,
107 const gchar
**attribute_names
,
108 const gchar
**attribute_values
,
113 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
114 if(strcmp("system", element_name
)){
115 *error
= g_error_new(G_MARKUP_ERROR
,
117 "This is not system.xml file");
121 while(attribute_names
[i
]){
122 if(strcmp("node_name", attribute_names
[i
])==0){
123 des
->node_name
= g_strdup(attribute_values
[i
]);
124 }else if(strcmp("domainname", attribute_names
[i
])==0){
125 des
->domain_name
= g_strdup(attribute_values
[i
]);
126 }else if(strcmp("cpu", attribute_names
[i
])==0){
127 des
->nb_cpu
= atoi(attribute_values
[i
]);
128 }else if(strcmp("arch_size", attribute_names
[i
])==0){
129 if(strcmp(attribute_values
[i
],"LP32") == 0) des
->size
= LTT_LP32
;
130 else if(strcmp(attribute_values
[i
],"ILP32") == 0) des
->size
= LTT_ILP32
;
131 else if(strcmp(attribute_values
[i
],"LP64") == 0) des
->size
= LTT_LP64
;
132 else if(strcmp(attribute_values
[i
],"ILP64") == 0) des
->size
= LTT_ILP64
;
133 else if(strcmp(attribute_values
[i
],"UNKNOWN") == 0) des
->size
= LTT_UNKNOWN
;
134 }else if(strcmp("endian", attribute_names
[i
])==0){
135 if(strcmp(attribute_values
[i
],"LITTLE_ENDIAN") == 0)
136 des
->endian
= LTT_LITTLE_ENDIAN
;
137 else if(strcmp(attribute_values
[i
],"BIG_ENDIAN") == 0)
138 des
->endian
= LTT_BIG_ENDIAN
;
139 }else if(strcmp("kernel_name", attribute_names
[i
])==0){
140 des
->kernel_name
= g_strdup(attribute_values
[i
]);
141 }else if(strcmp("kernel_release", attribute_names
[i
])==0){
142 des
->kernel_release
= g_strdup(attribute_values
[i
]);
143 }else if(strcmp("kernel_version", attribute_names
[i
])==0){
144 des
->kernel_version
= g_strdup(attribute_values
[i
]);
145 }else if(strcmp("machine", attribute_names
[i
])==0){
146 des
->machine
= g_strdup(attribute_values
[i
]);
147 }else if(strcmp("processor", attribute_names
[i
])==0){
148 des
->processor
= g_strdup(attribute_values
[i
]);
149 }else if(strcmp("hardware_platform", attribute_names
[i
])==0){
150 des
->hardware_platform
= g_strdup(attribute_values
[i
]);
151 }else if(strcmp("operating_system", attribute_names
[i
])==0){
152 des
->operating_system
= g_strdup(attribute_values
[i
]);
153 }else if(strcmp("ltt_major_version", attribute_names
[i
])==0){
154 des
->ltt_major_version
= atoi(attribute_values
[i
]);
155 }else if(strcmp("ltt_minor_version", attribute_names
[i
])==0){
156 des
->ltt_minor_version
= atoi(attribute_values
[i
]);
157 }else if(strcmp("ltt_block_size", attribute_names
[i
])==0){
158 des
->ltt_block_size
= atoi(attribute_values
[i
]);
160 *error
= g_error_new(G_MARKUP_ERROR
,
162 "Not a valid attribute");
169 static void parser_characters (GMarkupParseContext __UNUSED__
*context
,
171 gsize __UNUSED__ text_len
,
173 GError __UNUSED__
**error
)
175 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
176 des
->description
= g_strdup(text
);
179 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
,
182 g_assert(num
< t
->facilities_by_num
->len
);
184 return &g_array_index(t
->facilities_by_num
, LttFacility
, num
);
188 guint
ltt_trace_get_num_cpu(LttTrace
*t
)
196 * Return value : 0 success, 1 bad tracefile
198 int parse_trace_header(void *header
, LttTracefile
*tf
, LttTrace
*t
)
200 guint32
*magic_number
= (guint32
*)header
;
201 struct ltt_trace_header_any
*any
= (struct ltt_trace_header_any
*)header
;
203 if(*magic_number
== LTT_MAGIC_NUMBER
)
205 else if(*magic_number
== LTT_REV_MAGIC_NUMBER
)
207 else /* invalid magic number, bad tracefile ! */
210 /* Get float byte order : might be different from int byte order
211 * (or is set to 0 if the trace has no float (kernel trace)) */
212 tf
->float_word_order
= any
->float_word_order
;
215 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
),
217 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
),
219 t
->arch_size
= any
->arch_size
;
220 t
->ltt_major_version
= any
->major_version
;
221 t
->ltt_minor_version
= any
->minor_version
;
222 t
->flight_recorder
= any
->flight_recorder
;
223 t
->has_heartbeat
= any
->has_heartbeat
;
224 t
->has_alignment
= any
->has_alignment
;
225 t
->has_tsc
= any
->has_tsc
;
229 switch(any
->major_version
) {
232 switch(any
->minor_version
) {
235 tf
->buffer_header_size
=
236 sizeof(struct ltt_block_start_header
)
237 + sizeof(struct ltt_trace_header_0_3
);
241 g_warning("Unsupported trace version : %hhu.%hhu",
242 any
->major_version
, any
->minor_version
);
248 g_warning("Unsupported trace version : %hhu.%hhu",
249 any
->major_version
, any
->minor_version
);
259 /*****************************************************************************
261 * ltt_tracefile_open : open a trace file, construct a LttTracefile
263 * t : the trace containing the tracefile
264 * fileName : path name of the trace file
265 * tf : the tracefile structure
267 * : 0 for success, -1 otherwise.
268 ****************************************************************************/
270 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
272 struct stat lTDFStat
; /* Trace data file status */
273 struct ltt_block_start_header
*header
;
274 int page_size
= getpagesize();
277 tf
->long_name
= g_quark_from_string(fileName
);
279 tf
->fd
= open(fileName
, O_RDONLY
);
281 g_warning("Unable to open input data file %s\n", fileName
);
285 // Get the file's status
286 if(fstat(tf
->fd
, &lTDFStat
) < 0){
287 g_warning("Unable to get the status of the input data file %s\n", fileName
);
291 // Is the file large enough to contain a trace
292 if(lTDFStat
.st_size
<
293 (off_t
)(sizeof(struct ltt_block_start_header
)
294 + sizeof(struct ltt_trace_header_any
))){
295 g_print("The input data file %s does not contain a trace\n", fileName
);
299 /* Temporarily map the buffer start header to get trace information */
300 /* Multiple of pages aligned head */
301 tf
->buffer
.head
= mmap(0,
302 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
303 + sizeof(struct ltt_trace_header_any
)), PROT_READ
,
304 MAP_PRIVATE
, tf
->fd
, 0);
305 if(tf
->buffer
.head
== MAP_FAILED
) {
306 perror("Error in allocating memory for buffer of tracefile");
309 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
311 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
313 if(parse_trace_header(header
->trace
, tf
, NULL
)) {
314 g_warning("parse_trace_header error");
318 //store the size of the file
319 tf
->file_size
= lTDFStat
.st_size
;
320 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
321 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
323 if(munmap(tf
->buffer
.head
,
324 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
325 + sizeof(struct ltt_trace_header_any
)))) {
326 g_warning("unmap size : %u\n",
327 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
328 + sizeof(struct ltt_trace_header_any
)));
329 perror("munmap error");
332 tf
->buffer
.head
= NULL
;
334 //read the first block
335 if(map_block(tf
,0)) {
336 perror("Cannot map block for tracefile");
344 if(munmap(tf
->buffer
.head
,
345 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
346 + sizeof(struct ltt_trace_header_any
)))) {
347 g_warning("unmap size : %u\n",
348 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
349 + sizeof(struct ltt_trace_header_any
)));
350 perror("munmap error");
359 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
365 /*****************************************************************************
366 *Open control and per cpu tracefiles
367 ****************************************************************************/
369 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
372 tf
= ltt_tracefile_open(t
,tracefile_name
);
374 t
->per_cpu_tracefile_number
++;
375 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
378 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
387 tf
= ltt_tracefile_open(t
,control_name
);
389 g_warning("ltt_tracefile_open_control : bad file descriptor");
392 t
->control_tracefile_number
++;
393 g_ptr_array_add(t
->control_tracefiles
,tf
);
395 //parse facilities tracefile to get base_id
396 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
398 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
400 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
402 fLoad
.name
= (gchar
*)pos
;
403 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
404 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
406 for(i
=0;i
<t
->facility_number
;i
++){
407 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
408 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
409 f
->base_id
= fLoad
.base_code
;
413 if(i
==t
->facility_number
) {
414 g_warning("Facility: %s, checksum: %u is not found",
415 fLoad
.name
,(unsigned int)fLoad
.checksum
);
418 }else if(ev
.event_id
== TRACE_BLOCK_START
){
420 }else if(ev
.event_id
== TRACE_BLOCK_END
){
423 g_warning("Not valid facilities trace file");
432 /*****************************************************************************
434 * ltt_tracefile_close: close a trace file,
436 * t : tracefile which will be closed
437 ****************************************************************************/
439 void ltt_tracefile_close(LttTracefile
*t
)
441 int page_size
= getpagesize();
443 if(t
->buffer
.head
!= NULL
)
444 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
445 g_warning("unmap size : %u\n",
446 PAGE_ALIGN(t
->buf_size
));
447 perror("munmap error");
455 /*****************************************************************************
456 *Get system information
457 ****************************************************************************/
459 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
466 GMarkupParseContext
* context
;
467 GError
* error
= NULL
;
468 GMarkupParser markup_parser
=
470 parser_start_element
,
473 NULL
, /* passthrough */
477 fd
= g_open(pathname
, O_RDONLY
, 0);
479 g_warning("Can not open file : %s\n", pathname
);
483 iochan
= g_io_channel_unix_new(fd
);
485 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
487 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
488 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
489 != G_IO_STATUS_EOF
) {
492 g_warning("Can not read xml file: \n%s\n", error
->message
);
495 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
497 g_warning("Can not parse xml file: \n%s\n", error
->message
);
500 g_markup_parse_context_free(context
);
502 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
504 g_warning("Can not close file: \n%s\n", error
->message
);
512 g_markup_parse_context_free(context
);
514 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
516 g_warning("Can not close file: \n%s\n", error
->message
);
527 /*****************************************************************************
528 *The following functions get facility/tracefile information
529 ****************************************************************************/
531 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
538 gchar fullname
[DIR_NAME_SIZE
];
539 GError
* error
= NULL
;
541 dir
= g_dir_open(eventdefs
, 0, &error
);
544 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
549 while((name
= g_dir_read_name(dir
)) != NULL
){
550 if(!g_pattern_match_simple("*.xml", name
)) continue;
551 strcpy(fullname
,eventdefs
);
552 strcat(fullname
,name
);
553 ltt_facility_open(t
,fullname
);
557 for(j
=0;j
<t
->facility_number
;j
++){
558 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
559 for(i
=0; i
<f
->event_number
; i
++){
561 setFieldsOffset(NULL
, et
, NULL
, t
);
568 /*****************************************************************************
569 *A trace is specified as a pathname to the directory containing all the
570 *associated data (control tracefiles, per cpu tracefiles, event
573 *When a trace is closed, all the associated facilities, types and fields
574 *are released as well.
578 /****************************************************************************
579 * get_absolute_pathname
581 * return the unique pathname in the system
583 * MD : Fixed this function so it uses realpath, dealing well with
584 * forgotten cases (.. were not used correctly before).
586 ****************************************************************************/
587 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
589 abs_pathname
[0] = '\0';
591 if ( realpath (pathname
, abs_pathname
) != NULL
)
595 /* error, return the original path unmodified */
596 strcpy(abs_pathname
, pathname
);
602 /* Search for something like : .*_.*
604 * The left side is the name, the right side is the number.
607 int get_tracefile_name_number(const gchar
*raw_name
,
611 guint raw_name_len
= strlen(raw_name
);
612 gchar char_name
[PATH_MAX
];
618 for(i
=raw_name_len
-1;i
>=0;i
--) {
619 if(raw_name
[i
] == '_') break;
621 if(i
==0) /* Either not found or name length is 0 */
625 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
627 if(endptr
== raw_name
+underscore_pos
+1)
628 return -1; /* No digit */
629 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
630 return -1; /* underflow / overflow */
632 strncpy(char_name
, raw_name
, underscore_pos
);
634 char_name
[underscore_pos
] = '\0';
636 *name
= g_quark_from_string(char_name
);
643 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
645 return &trace
->tracefiles
;
649 void compute_tracefile_group(GQuark key_id
,
651 struct compute_tracefile_group_args
*args
)
656 for(i
=0; i
<group
->len
; i
++) {
657 tf
= &g_array_index (group
, LttTracefile
, i
);
659 args
->func(tf
, args
->func_args
);
664 void ltt_tracefile_group_destroy(gpointer data
)
666 GArray
*group
= (GArray
*)data
;
670 for(i
=0; i
<group
->len
; i
++) {
671 tf
= &g_array_index (group
, LttTracefile
, i
);
673 ltt_tracefile_close(tf
);
675 g_array_free(group
, TRUE
);
678 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
680 GArray
*group
= (GArray
*)data
;
684 for(i
=0; i
<group
->len
; i
++) {
685 tf
= &g_array_index (group
, LttTracefile
, i
);
686 if(tf
->cpu_online
) return 1;
692 /* Open each tracefile under a specific directory. Put them in a
693 * GData : permits to access them using their tracefile group pathname.
694 * i.e. access control/modules tracefile group by index :
697 * relative path is the path relative to the trace root
698 * root path is the full path
700 * A tracefile group is simply an array where all the per cpu tracefiles sits.
703 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
704 gchar
*relative_path
)
706 DIR *dir
= opendir(root_path
);
707 struct dirent
*entry
;
708 struct stat stat_buf
;
711 gchar path
[PATH_MAX
];
716 gchar rel_path
[PATH_MAX
];
725 strncpy(path
, root_path
, PATH_MAX
-1);
726 path_len
= strlen(path
);
727 path
[path_len
] = '/';
729 path_ptr
= path
+ path_len
;
731 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
732 rel_path_len
= strlen(rel_path
);
733 rel_path
[rel_path_len
] = '/';
735 rel_path_ptr
= rel_path
+ rel_path_len
;
737 while((entry
= readdir(dir
)) != NULL
) {
739 if(entry
->d_name
[0] == '.') continue;
741 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
742 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
744 ret
= stat(path
, &stat_buf
);
750 g_debug("Tracefile file or directory : %s\n", path
);
752 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
754 if(S_ISDIR(stat_buf
.st_mode
)) {
756 g_debug("Entering subdirectory...\n");
757 ret
= open_tracefiles(trace
, path
, rel_path
);
758 if(ret
< 0) continue;
759 } else if(S_ISREG(stat_buf
.st_mode
)) {
764 if(get_tracefile_name_number(rel_path
, &name
, &num
))
765 continue; /* invalid name */
767 g_debug("Opening file.\n");
768 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
769 g_info("Error opening tracefile %s", path
);
771 continue; /* error opening the tracefile : bad magic number ? */
774 g_debug("Tracefile name is %s and number is %u",
775 g_quark_to_string(name
), num
);
777 tmp_tf
.cpu_online
= 1;
778 tmp_tf
.cpu_num
= num
;
781 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
783 /* Elements are automatically cleared when the array is allocated.
784 * It makes the cpu_online variable set to 0 : cpu offline, by default.
786 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
787 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
788 group
, ltt_tracefile_group_destroy
);
791 /* Add the per cpu tracefile to the named group */
792 unsigned int old_len
= group
->len
;
794 group
= g_array_set_size(group
, num
+1);
795 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
805 /* ltt_get_facility_description
807 * Opens the trace corresponding to the requested facility (identified by fac_id
810 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
812 * Returns 0 on success, or 1 on failure.
815 static int ltt_get_facility_description(LttFacility
*f
,
817 LttTracefile
*fac_tf
)
819 char desc_file_name
[PATH_MAX
];
824 text
= g_quark_to_string(t
->pathname
);
825 textlen
= strlen(text
);
827 if(textlen
>= PATH_MAX
) goto name_error
;
828 strcpy(desc_file_name
, text
);
830 text
= "/eventdefs/";
831 textlen
+=strlen(text
);
832 if(textlen
>= PATH_MAX
) goto name_error
;
833 strcat(desc_file_name
, text
);
835 text
= g_quark_to_string(f
->name
);
836 textlen
+=strlen(text
);
837 if(textlen
>= PATH_MAX
) goto name_error
;
838 strcat(desc_file_name
, text
);
841 textlen
+=strlen(text
);
842 if(textlen
>= PATH_MAX
) goto name_error
;
843 strcat(desc_file_name
, text
);
845 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
847 if(err
< 0) goto name_error
;
849 textlen
=strlen(desc_file_name
);
852 textlen
+=strlen(text
);
853 if(textlen
>= PATH_MAX
) goto name_error
;
854 strcat(desc_file_name
, text
);
856 err
= ltt_facility_open(f
, t
, desc_file_name
);
857 if(err
) goto facility_error
;
866 static void ltt_fac_ids_destroy(gpointer data
)
868 GArray
*fac_ids
= (GArray
*)data
;
870 g_array_free(fac_ids
, TRUE
);
874 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
875 * because it must be done just after the opening */
876 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
885 err
= ltt_tracefile_read_seek(tf
);
886 if(err
== EPERM
) goto seek_error
;
887 else if(err
== ERANGE
) break; /* End of tracefile */
889 err
= ltt_tracefile_read_update_event(tf
);
890 if(err
) goto update_error
;
892 /* We are on a facility load/or facility unload/ or heartbeat event */
894 * * facility 0 is hardcoded : this is the core facility. It will be shown
895 * in the facility array though, and is shown as "loaded builtin" in the
897 * It contains event :
899 * 1 : facility unload
900 * 2 : state dump facility load
903 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
904 /* Should only contain core facility */
905 g_warning("Error in processing facility file %s, "
906 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
907 tf
->event
.facility_id
);
912 struct LttFacilityLoad
*fac_load_data
;
913 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
917 switch((enum ltt_core_events
)tf
->event
.event_id
) {
918 case LTT_EVENT_FACILITY_LOAD
:
919 fac_name
= (char*)(tf
->event
.data
);
920 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
923 (struct LttFacilityLoad
*)
924 (tf
->event
.data
+ strlen(fac_name
) + 1);
925 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
926 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
927 g_assert(fac
->exists
== 0);
928 fac
->name
= g_quark_from_string(fac_name
);
929 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
930 &fac_load_data
->checksum
);
931 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
932 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
933 &fac_load_data
->pointer_size
);
934 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
935 &fac_load_data
->long_size
);
936 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
937 &fac_load_data
->size_t_size
);
938 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
939 &fac_load_data
->alignment
);
941 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
942 continue; /* error opening description */
944 fac
->trace
= tf
->trace
;
946 /* Preset the field offsets */
947 for(i
=0; i
<fac
->events
->len
; i
++){
948 et
= &g_array_index(fac
->events
, LttEventType
, i
);
949 set_fields_offsets(tf
, et
);
954 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
956 if(fac_ids
== NULL
) {
957 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
958 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
960 fac_ids
, ltt_fac_ids_destroy
);
962 g_array_append_val(fac_ids
, fac
->id
);
965 case LTT_EVENT_FACILITY_UNLOAD
:
966 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
967 /* We don't care about unload : facilities ID are valid for the whole
968 * trace. They simply won't be used after the unload. */
970 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
971 fac_name
= (char*)(tf
->event
.data
);
972 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
974 fac_state_dump_load_data
=
975 (struct LttStateDumpFacilityLoad
*)
976 (tf
->event
.data
+ strlen(fac_name
) + 1);
977 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
978 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
979 g_assert(fac
->exists
== 0);
980 fac
->name
= g_quark_from_string(fac_name
);
981 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
982 &fac_state_dump_load_data
->checksum
);
983 fac
->id
= fac_state_dump_load_data
->id
;
984 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
985 &fac_state_dump_load_data
->pointer_size
);
986 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
987 &fac_state_dump_load_data
->long_size
);
988 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
989 &fac_state_dump_load_data
->size_t_size
);
990 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
991 &fac_state_dump_load_data
->alignment
);
992 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
993 continue; /* error opening description */
995 fac
->trace
= tf
->trace
;
997 /* Preset the field offsets */
998 for(i
=0; i
<fac
->events
->len
; i
++){
999 et
= &g_array_index(fac
->events
, LttEventType
, i
);
1000 set_fields_offsets(tf
, et
);
1005 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
1007 if(fac_ids
== NULL
) {
1008 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
1009 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1011 fac_ids
, ltt_fac_ids_destroy
);
1013 g_array_append_val(fac_ids
, fac
->id
);
1016 case LTT_EVENT_HEARTBEAT
:
1019 g_warning("Error in processing facility file %s, "
1020 "unknown event id %hhu in core facility.",
1021 g_quark_to_string(tf
->name
),
1022 tf
->event
.event_id
);
1024 goto event_id_error
;
1030 /* Error handling */
1035 g_warning("An error occured in facility tracefile parsing");
1040 LttTrace
*ltt_trace_open(const gchar
*pathname
)
1042 gchar abs_path
[PATH_MAX
];
1047 struct ltt_block_start_header
*header
;
1049 struct dirent
*entry
;
1050 guint control_found
= 0;
1051 guint eventdefs_found
= 0;
1052 struct stat stat_buf
;
1053 gchar path
[PATH_MAX
];
1055 t
= g_new(LttTrace
, 1);
1056 if(!t
) goto alloc_error
;
1058 get_absolute_pathname(pathname
, abs_path
);
1059 t
->pathname
= g_quark_from_string(abs_path
);
1061 g_datalist_init(&t
->tracefiles
);
1063 /* Test to see if it looks like a trace */
1064 dir
= opendir(abs_path
);
1069 while((entry
= readdir(dir
)) != NULL
) {
1070 strcpy(path
, abs_path
);
1072 strcat(path
, entry
->d_name
);
1073 ret
= stat(path
, &stat_buf
);
1078 if(S_ISDIR(stat_buf
.st_mode
)) {
1079 if(strcmp(entry
->d_name
, "control") == 0) {
1082 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1083 eventdefs_found
= 1;
1089 if(!control_found
|| !eventdefs_found
) goto find_error
;
1091 /* Open all the tracefiles */
1092 if(open_tracefiles(t
, abs_path
, "")) {
1093 g_warning("Error opening tracefile %s", abs_path
);
1097 /* Prepare the facilities containers : array and mapping */
1098 /* Array is zeroed : the "exists" field is set to false by default */
1099 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1100 TRUE
, sizeof(LttFacility
),
1102 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1104 g_datalist_init(&t
->facilities_by_name
);
1106 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1107 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1109 g_error("Trace %s has no facility tracefile", abs_path
);
1111 goto facilities_error
;
1114 /* Get the trace information for the control/facility 0 tracefile */
1115 g_assert(group
->len
> 0);
1116 tf
= &g_array_index (group
, LttTracefile
, 0);
1117 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1118 g_assert(parse_trace_header(header
->trace
,
1121 t
->num_cpu
= group
->len
;
1123 for(i
=0; i
<group
->len
; i
++) {
1124 tf
= &g_array_index (group
, LttTracefile
, i
);
1125 if(ltt_process_facility_tracefile(tf
))
1126 goto facilities_error
;
1131 /* Error handling */
1133 g_datalist_clear(&t
->facilities_by_name
);
1134 g_array_free(t
->facilities_by_num
, TRUE
);
1136 g_datalist_clear(&t
->tracefiles
);
1144 GQuark
ltt_trace_name(const LttTrace
*t
)
1150 /******************************************************************************
1151 * When we copy a trace, we want all the opening actions to happen again :
1152 * the trace will be reopened and totally independant from the original.
1153 * That's why we call ltt_trace_open.
1154 *****************************************************************************/
1155 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1157 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1160 void ltt_trace_close(LttTrace
*t
)
1165 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1166 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1168 ltt_facility_close(fac
);
1171 g_datalist_clear(&t
->facilities_by_name
);
1172 g_array_free(t
->facilities_by_num
, TRUE
);
1173 g_datalist_clear(&t
->tracefiles
);
1178 /*****************************************************************************
1179 *Get the system description of the trace
1180 ****************************************************************************/
1182 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1184 g_assert(id
< t
->facilities_by_num
->len
);
1185 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1188 /* ltt_trace_facility_get_by_name
1190 * Returns the GArray of facility indexes. All the fac_ids that matches the
1191 * requested facility name.
1193 * If name is not found, returns NULL.
1195 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1197 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1200 /*****************************************************************************
1201 * Functions to discover all the event types in the trace
1202 ****************************************************************************/
1205 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1209 unsigned int num
= t
->facility_number
;
1213 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1214 count
+= f
->event_number
;
1221 //use an iteration on all the trace facilities, and inside iteration on all the
1222 //event types in each facilities instead.
1223 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1225 LttEventType
*event_type
;
1228 f
= ltt_trace_facility_by_id(t
,evId
);
1230 if(unlikely(!f
)) event_type
= NULL
;
1231 else event_type
= f
->events
[evId
- f
->base_id
];
1238 /*****************************************************************************
1239 * ltt_trace_find_tracefile
1241 * Find a tracefile by name and index in the group.
1243 * Returns a pointer to the tracefiles, else NULL.
1244 ****************************************************************************/
1246 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1251 /*****************************************************************************
1252 * Get the start time and end time of the trace
1253 ****************************************************************************/
1255 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1256 LttTime
*start
, LttTime
*end
)
1260 err
= map_block(tf
, 0);
1262 g_error("Can not map block");
1263 *start
= ltt_time_infinite
;
1265 *start
= tf
->buffer
.begin
.timestamp
;
1267 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1269 g_error("Can not map block");
1270 *end
= ltt_time_zero
;
1272 *end
= tf
->buffer
.end
.timestamp
;
1275 struct tracefile_time_span_get_args
{
1281 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1283 struct tracefile_time_span_get_args
*args
=
1284 (struct tracefile_time_span_get_args
*)user_data
;
1286 GArray
*group
= (GArray
*)data
;
1292 for(i
=0; i
<group
->len
; i
++) {
1293 tf
= &g_array_index (group
, LttTracefile
, i
);
1294 if(tf
->cpu_online
) {
1295 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1296 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1297 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1302 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1304 LttTime min_start
= ltt_time_infinite
;
1305 LttTime max_end
= ltt_time_zero
;
1306 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1308 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1310 if(start
!= NULL
) *start
= min_start
;
1311 if(end
!= NULL
) *end
= max_end
;
1316 /*****************************************************************************
1317 *Get the name of a tracefile
1318 ****************************************************************************/
1320 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1326 guint
ltt_tracefile_num(LttTracefile
*tf
)
1331 /*****************************************************************************
1332 * Get the number of blocks in the tracefile
1333 ****************************************************************************/
1335 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1337 return tf
->num_blocks
;
1341 /* Seek to the first event in a tracefile that has a time equal or greater than
1342 * the time passed in parameter.
1344 * If the time parameter is outside the tracefile time span, seek to the first
1345 * event or if after, return ERANGE.
1347 * If the time parameter is before the first event, we have to seek specially to
1350 * If the time is after the end of the trace, return ERANGE.
1352 * Do a binary search to find the right block, then a sequential search in the
1353 * block to find the event.
1355 * In the special case where the time requested fits inside a block that has no
1356 * event corresponding to the requested time, the first event of the next block
1359 * IMPORTANT NOTE : // FIXME everywhere...
1361 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1362 * you will jump over an event if you do.
1364 * Return value : 0 : no error, the tf->event can be used
1365 * ERANGE : time if after the last event of the trace
1366 * otherwise : this is an error.
1370 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1374 unsigned int block_num
, high
, low
;
1376 /* seek at the beginning of trace */
1377 err
= map_block(tf
, 0); /* First block */
1379 g_error("Can not map block");
1383 /* If the time is lower or equal the beginning of the trace,
1384 * go to the first event. */
1385 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1386 ret
= ltt_tracefile_read(tf
);
1387 if(ret
== ERANGE
) goto range
;
1388 else if (ret
) goto fail
;
1389 goto found
; /* There is either no event in the trace or the event points
1390 to the first event in the trace */
1393 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1395 g_error("Can not map block");
1399 /* If the time is after the end of the trace, return ERANGE. */
1400 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1404 /* Binary search the block */
1405 high
= tf
->num_blocks
- 1;
1409 block_num
= ((high
-low
) / 2) + low
;
1411 err
= map_block(tf
, block_num
);
1413 g_error("Can not map block");
1417 /* We cannot divide anymore : this is what would happen if the time
1418 * requested was exactly between two consecutive buffers'end and start
1419 * timestamps. This is also what would happend if we didn't deal with out
1420 * of span cases prior in this function. */
1421 /* The event is right in the buffer!
1422 * (or in the next buffer first event) */
1424 ret
= ltt_tracefile_read(tf
);
1425 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1426 else if(ret
) goto fail
;
1428 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1432 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1433 /* go to lower part */
1434 high
= block_num
- 1;
1435 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1436 /* go to higher part */
1437 low
= block_num
+ 1;
1438 } else {/* The event is right in the buffer!
1439 (or in the next buffer first event) */
1441 ret
= ltt_tracefile_read(tf
);
1442 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1443 else if(ret
) goto fail
;
1445 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1457 /* Error handling */
1459 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1460 g_quark_to_string(tf
->name
));
1465 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1469 if(ep
->tracefile
!= tf
) {
1473 err
= map_block(tf
, ep
->block
);
1475 g_error("Can not map block");
1479 tf
->event
.offset
= ep
->offset
;
1481 err
= ltt_tracefile_read_update_event(tf
);
1483 err
= ltt_tracefile_read_op(tf
);
1489 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1490 g_quark_to_string(tf
->name
));
1494 /* Calculate the real event time based on the buffer boundaries */
1495 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1499 g_assert(tf
->trace
->has_tsc
);
1501 time
= ltt_time_from_uint64(
1502 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1503 tf
->buffer
.nsecs_per_cycle
);
1504 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1510 /* Get the current event of the tracefile : valid until the next read */
1511 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1518 /*****************************************************************************
1520 * ltt_tracefile_read : Read the next event in the tracefile
1525 * Returns 0 if an event can be used in tf->event.
1526 * Returns ERANGE on end of trace. The event in tf->event still can be used
1527 * (if the last block was not empty).
1528 * Returns EPERM on error.
1530 * This function does make the tracefile event structure point to the event
1531 * currently pointed to by the tf->event.
1533 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1534 * reinitialize it after an error if you want results to be coherent.
1535 * It would be the case if a end of trace last buffer has no event : the end
1536 * of trace wouldn't be returned, but an error.
1537 * We make the assumption there is at least one event per buffer.
1538 ****************************************************************************/
1540 int ltt_tracefile_read(LttTracefile
*tf
)
1544 err
= ltt_tracefile_read_seek(tf
);
1546 err
= ltt_tracefile_read_update_event(tf
);
1548 err
= ltt_tracefile_read_op(tf
);
1554 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1558 /* Get next buffer until we finally have an event, or end of trace */
1560 err
= ltt_seek_next_event(tf
);
1561 if(unlikely(err
== ENOPROTOOPT
)) {
1565 /* Are we at the end of the buffer ? */
1567 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1570 /* get next block */
1571 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1573 g_error("Can not map block");
1577 } else break; /* We found an event ! */
1584 /* do specific operation on events */
1585 int ltt_tracefile_read_op(LttTracefile
*tf
)
1591 /* do event specific operation */
1593 /* do something if its an heartbeat event : increment the heartbeat count */
1594 //if(event->facility_id == LTT_FACILITY_CORE)
1595 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1596 // tf->cur_heart_beat_number++;
1602 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1603 * event specific operation. */
1604 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1610 pos
= tf
->buffer
.head
+ event
->offset
;
1612 /* Read event header */
1616 if(tf
->trace
->has_tsc
) {
1617 if(tf
->trace
->has_heartbeat
) {
1618 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1620 /* 32 bits -> 64 bits tsc */
1621 /* note : still works for seek and non seek cases. */
1622 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1623 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1625 | (guint64
)event
->time
.timestamp
;
1626 event
->tsc
= tf
->buffer
.tsc
;
1629 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1630 | (guint64
)event
->time
.timestamp
;
1631 event
->tsc
= tf
->buffer
.tsc
;
1633 pos
+= sizeof(guint32
);
1635 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1636 tf
->buffer
.tsc
= event
->tsc
;
1637 pos
+= sizeof(guint64
);
1640 event
->event_time
= ltt_interpolate_time(tf
, event
);
1642 event
->time
.delta
.tv_sec
= 0;
1643 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1644 pos
) * NSEC_PER_USEC
;
1646 event
->tsc
= tf
->buffer
.tsc
;
1648 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1650 pos
+= sizeof(guint32
);
1653 event
->facility_id
= *(guint8
*)pos
;
1654 pos
+= sizeof(guint8
);
1656 event
->event_id
= *(guint8
*)pos
;
1657 pos
+= sizeof(guint8
);
1659 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1660 pos
+= sizeof(guint16
);
1664 /* get the data size and update the event fields with the current
1666 ltt_update_event_size(tf
);
1672 /****************************************************************************
1674 * map_block : map a block from the file
1676 * lttdes : ltt trace file
1677 * whichBlock : the block which will be read
1680 * EINVAL : lseek fail
1681 * EIO : can not read from the file
1682 ****************************************************************************/
1684 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1686 int page_size
= getpagesize();
1687 struct ltt_block_start_header
*header
;
1689 g_assert(block_num
< tf
->num_blocks
);
1691 if(tf
->buffer
.head
!= NULL
) {
1692 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1693 g_warning("unmap size : %u\n",
1694 PAGE_ALIGN(tf
->buf_size
));
1695 perror("munmap error");
1701 /* Multiple of pages aligned head */
1702 tf
->buffer
.head
= mmap(0,
1703 PAGE_ALIGN(tf
->buf_size
),
1704 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1705 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1707 if(tf
->buffer
.head
== MAP_FAILED
) {
1708 perror("Error in allocating memory for buffer of tracefile");
1712 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1715 tf
->buffer
.index
= block_num
;
1717 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1719 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1720 &header
->begin
.timestamp
);
1721 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1722 g_debug("block %u begin : %lu.%lu", block_num
,
1723 tf
->buffer
.begin
.timestamp
.tv_sec
, tf
->buffer
.begin
.timestamp
.tv_nsec
);
1724 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1725 &header
->begin
.cycle_count
);
1726 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1727 &header
->end
.timestamp
);
1728 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1729 g_debug("block %u end : %lu.%lu", block_num
,
1730 tf
->buffer
.end
.timestamp
.tv_sec
, tf
->buffer
.end
.timestamp
.tv_nsec
);
1731 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1732 &header
->end
.cycle_count
);
1733 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1734 &header
->lost_size
);
1736 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1737 tf
->event
.tsc
= tf
->buffer
.tsc
;
1740 * eventually support variable buffer size : will need a partial pre-read of
1741 * the headers to create an index when we open the trace... eventually. */
1742 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1743 &header
->buf_size
));
1745 /* Now that the buffer is mapped, calculate the time interpolation for the
1748 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1750 /* Make the current event point to the beginning of the buffer :
1751 * it means that the event read must get the first event. */
1752 tf
->event
.tracefile
= tf
;
1753 tf
->event
.block
= block_num
;
1754 tf
->event
.offset
= 0;
1763 /* It will update the fields offsets too */
1764 void ltt_update_event_size(LttTracefile
*tf
)
1768 /* Specific handling of core events : necessary to read the facility control
1770 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1771 tf
->event
.facility_id
);
1773 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1774 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1775 case LTT_EVENT_FACILITY_LOAD
:
1776 size
= strlen((char*)tf
->event
.data
) + 1;
1777 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1778 size
+= sizeof(struct LttFacilityLoad
);
1780 case LTT_EVENT_FACILITY_UNLOAD
:
1781 g_debug("Update Event facility unload");
1782 size
= sizeof(struct LttFacilityUnload
);
1784 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1785 size
= strlen((char*)tf
->event
.data
) + 1;
1786 g_debug("Update Event facility load state dump of facility %s",
1787 (char*)tf
->event
.data
);
1788 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1790 case LTT_EVENT_HEARTBEAT
:
1791 g_debug("Update Event heartbeat");
1792 size
= sizeof(TimeHeartbeat
);
1795 g_warning("Error in getting event size : tracefile %s, "
1796 "unknown event id %hhu in core facility.",
1797 g_quark_to_string(tf
->name
),
1798 tf
->event
.event_id
);
1799 goto event_id_error
;
1804 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1805 tf
->event
.facility_id
,
1806 tf
->event
.facility_id
,
1807 g_quark_to_string(tf
->name
));
1808 goto facility_error
;
1811 LttEventType
*event_type
=
1812 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1815 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1817 g_quark_to_string(f
->name
),
1818 g_quark_to_string(tf
->name
));
1819 goto event_type_error
;
1822 if(event_type
->root_field
)
1823 size
= get_field_type_size(tf
, event_type
,
1824 0, 0, event_type
->root_field
, tf
->event
.data
);
1828 g_debug("Event root field : f.e %hhu.%hhu size %zd",
1829 tf
->event
.facility_id
,
1830 tf
->event
.event_id
, size
);
1833 tf
->event
.data_size
= size
;
1835 /* Check consistency between kernel and LTTV structure sizes */
1836 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1843 tf
->event
.data_size
= 0;
1847 /* Take the tf current event offset and use the event facility id and event id
1848 * to figure out where is the next event offset.
1850 * This is an internal function not aiming at being used elsewhere : it will
1851 * not jump over the current block limits. Please consider using
1852 * ltt_tracefile_read to do this.
1854 * Returns 0 on success
1855 * ERANGE if we are at the end of the buffer.
1856 * ENOPROTOOPT if an error occured when getting the current event size.
1858 static int ltt_seek_next_event(LttTracefile
*tf
)
1863 /* seek over the buffer header if we are at the buffer start */
1864 if(tf
->event
.offset
== 0) {
1865 tf
->event
.offset
+= tf
->buffer_header_size
;
1867 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1874 pos
= tf
->event
.data
;
1876 if(tf
->event
.data_size
< 0) goto error
;
1878 pos
+= (size_t)tf
->event
.data_size
;
1880 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1882 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1886 g_assert(tf
->event
.offset
< tf
->buf_size
- tf
->buffer
.lost_size
);
1892 g_error("Error in ltt_seek_next_event for tracefile %s",
1893 g_quark_to_string(tf
->name
));
1898 /*****************************************************************************
1900 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1903 ****************************************************************************/
1905 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1907 LttTime lBufTotalTime
; /* Total time for this buffer */
1908 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1909 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1911 /* Calculate the total time for this buffer */
1912 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1913 tf
->buffer
.begin
.timestamp
);
1915 /* Calculate the total cycles for this bufffer */
1916 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1917 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1919 /* Convert the total time to double */
1920 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1922 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1926 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1928 LttField
* rootFld
= evT
->root_field
;
1929 // rootFld->base_address = evD;
1932 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1933 evT
, 0,0,rootFld
, evD
);
1937 /*****************************************************************************
1939 * set_fields_offsets : set the precomputable offset of the fields
1941 * tracefile : opened trace file
1942 * event_type : the event type
1943 ****************************************************************************/
1945 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1947 LttField
*field
= event_type
->root_field
;
1948 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1951 preset_field_type_size(tf
, event_type
, 0, 0,
1952 &fixed_root
, &fixed_parent
,
1958 /*****************************************************************************
1960 * preset_field_type_size : set the fixed sizes of the field type
1963 * event_type : event type
1964 * offset_root : offset from the root
1965 * offset_parent : offset from the parent
1966 * fixed_root : Do we know a fixed offset to the root ?
1967 * fixed_parent : Do we know a fixed offset to the parent ?
1969 ****************************************************************************/
1970 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1971 off_t offset_root
, off_t offset_parent
,
1972 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1975 enum field_status local_fixed_root
, local_fixed_parent
;
1979 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1980 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1981 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1983 type
= field
->field_type
;
1985 field
->fixed_root
= *fixed_root
;
1986 if(field
->fixed_root
== FIELD_FIXED
)
1987 field
->offset_root
= offset_root
;
1989 field
->offset_root
= 0;
1991 field
->fixed_parent
= *fixed_parent
;
1992 if(field
->fixed_parent
== FIELD_FIXED
)
1993 field
->offset_parent
= offset_parent
;
1995 field
->offset_parent
= 0;
1997 size_t current_root_offset
;
1998 size_t current_offset
;
1999 enum field_status current_child_status
, final_child_status
;
2002 switch(type
->type_class
) {
2007 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2008 field
->fixed_size
= FIELD_FIXED
;
2011 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2012 field
->fixed_size
= FIELD_FIXED
;
2016 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2017 field
->fixed_size
= FIELD_FIXED
;
2022 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2023 field
->fixed_size
= FIELD_FIXED
;
2026 local_fixed_root
= FIELD_VARIABLE
;
2027 local_fixed_parent
= FIELD_VARIABLE
;
2028 preset_field_type_size(tf
, event_type
,
2030 &local_fixed_root
, &local_fixed_parent
,
2032 field
->fixed_size
= FIELD_VARIABLE
;
2033 field
->field_size
= 0;
2034 *fixed_root
= FIELD_VARIABLE
;
2035 *fixed_parent
= FIELD_VARIABLE
;
2038 field
->fixed_size
= FIELD_VARIABLE
;
2039 field
->field_size
= 0;
2040 *fixed_root
= FIELD_VARIABLE
;
2041 *fixed_parent
= FIELD_VARIABLE
;
2044 local_fixed_root
= FIELD_VARIABLE
;
2045 local_fixed_parent
= FIELD_VARIABLE
;
2046 preset_field_type_size(tf
, event_type
,
2048 &local_fixed_root
, &local_fixed_parent
,
2050 field
->fixed_size
= field
->child
[0]->fixed_size
;
2051 if(field
->fixed_size
== FIELD_FIXED
) {
2052 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2054 field
->field_size
= 0;
2055 *fixed_root
= FIELD_VARIABLE
;
2056 *fixed_parent
= FIELD_VARIABLE
;
2060 current_root_offset
= field
->offset_root
;
2062 current_child_status
= FIELD_FIXED
;
2063 for(i
=0;i
<type
->element_number
;i
++) {
2064 preset_field_type_size(tf
, event_type
,
2065 current_root_offset
, current_offset
,
2066 fixed_root
, ¤t_child_status
,
2068 if(current_child_status
== FIELD_FIXED
) {
2069 current_root_offset
+= field
->child
[i
]->field_size
;
2070 current_offset
+= field
->child
[i
]->field_size
;
2072 current_root_offset
= 0;
2076 if(current_child_status
!= FIELD_FIXED
) {
2077 *fixed_parent
= current_child_status
;
2078 field
->field_size
= 0;
2079 field
->fixed_size
= current_child_status
;
2081 field
->field_size
= current_offset
;
2082 field
->fixed_size
= FIELD_FIXED
;
2086 current_root_offset
= field
->offset_root
;
2089 final_child_status
= FIELD_FIXED
;
2090 for(i
=0;i
<type
->element_number
;i
++) {
2091 enum field_status current_root_child_status
= FIELD_FIXED
;
2092 enum field_status current_child_status
= FIELD_FIXED
;
2093 preset_field_type_size(tf
, event_type
,
2094 current_root_offset
, current_offset
,
2095 ¤t_root_child_status
, ¤t_child_status
,
2097 if(current_child_status
!= FIELD_FIXED
)
2098 final_child_status
= current_child_status
;
2100 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2102 if(final_child_status
!= FIELD_FIXED
) {
2103 *fixed_root
= final_child_status
;
2104 *fixed_parent
= final_child_status
;
2105 field
->field_size
= 0;
2106 field
->fixed_size
= current_child_status
;
2108 field
->field_size
= max_size
;
2109 field
->fixed_size
= FIELD_FIXED
;
2117 /*****************************************************************************
2119 * check_fields_compatibility : Check for compatibility between two fields :
2120 * do they use the same inner structure ?
2122 * event_type1 : event type
2123 * event_type2 : event type
2126 *Returns : 0 if identical
2128 ****************************************************************************/
2129 gint
check_fields_compatibility(LttEventType
*event_type1
,
2130 LttEventType
*event_type2
,
2131 LttField
*field1
, LttField
*field2
)
2133 guint different
= 0;
2138 if(field1
== NULL
) {
2139 if(field2
== NULL
) goto end
;
2144 } else if(field2
== NULL
) {
2149 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2150 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2151 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2152 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2153 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2154 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2156 type1
= field1
->field_type
;
2157 type2
= field2
->field_type
;
2159 if(type1
->type_class
!= type2
->type_class
) {
2163 if(type1
->element_name
!= type2
->element_name
) {
2168 switch(type1
->type_class
) {
2178 if(field1
->field_size
!= field2
->field_size
) {
2184 if(type1
->element_number
!= type2
->element_number
) {
2188 for(i
=0;i
<type1
->element_number
;i
++) {
2189 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2196 /* Two elements : size and child */
2197 g_assert(type1
->element_number
!= type2
->element_number
);
2198 for(i
=0;i
<type1
->element_number
;i
++) {
2199 if(check_fields_compatibility(event_type1
, event_type2
,
2200 field1
->child
[0], field2
->child
[0])) {
2209 if(field1
->field_size
!= field2
->field_size
) {
2213 /* Two elements : size and child */
2214 g_assert(type1
->element_number
!= type2
->element_number
);
2215 for(i
=0;i
<type1
->element_number
;i
++) {
2216 if(check_fields_compatibility(event_type1
, event_type2
,
2217 field1
->child
[0], field2
->child
[0])) {
2225 if(type1
->element_number
!= type2
->element_number
) {
2229 for(i
=0;i
<type1
->element_number
;i
++) {
2230 if(check_fields_compatibility(event_type1
, event_type2
,
2231 field1
->child
[0], field2
->child
[0])) {
2246 /*****************************************************************************
2248 * getFieldtypeSize: get the size of the field type (primitive type)
2251 * offsetRoot : offset from the root
2252 * offsetParent : offset from the parrent
2254 * evD : event data, it may be NULL
2256 * int : size of the field
2257 ****************************************************************************/
2259 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2260 LttEventType
* evT
, gint offsetRoot
,
2261 gint offsetParent
, LttField
* fld
, void *evD
)
2263 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2264 LttType
* type
= fld
->field_type
;
2266 /* This likely has been tested with gcov : half of them.. */
2267 if(unlikely(fld
->field_fixed
== 1)){
2269 if(unlikely(fld
== evT
->root_field
)) {
2270 size
= fld
->field_size
;
2271 goto end_getFieldtypeSize
;
2275 /* From gcov profiling : half string, half struct, can we gain something
2276 * from that ? (Mathieu) */
2277 switch(type
->type_class
) {
2279 element_number
= (int) type
->element_number
;
2280 if(fld
->field_fixed
== -1){
2281 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2282 0,fld
->child
[0], NULL
);
2283 if(size
== 0){ //has string or sequence
2284 fld
->field_fixed
= 0;
2286 fld
->field_fixed
= 1;
2287 size
*= element_number
;
2289 }else if(fld
->field_fixed
== 0){// has string or sequence
2291 for(i
=0;i
<element_number
;i
++){
2292 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2293 fld
->child
[0], evD
+size
);
2295 }else size
= fld
->field_size
;
2297 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2298 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2304 size1
= (int) ltt_type_size(fac
, type
);
2305 if(fld
->field_fixed
== -1){
2306 fld
->sequ_number_size
= size1
;
2307 fld
->field_fixed
= 0;
2308 size
= getFieldtypeSize(evT
, offsetRoot
,
2309 0,fld
->child
[0], NULL
);
2310 fld
->element_size
= size
;
2312 element_number
= getIntNumber(tf
,size1
,evD
);
2313 type
->element_number
= element_number
;
2314 if(fld
->element_size
> 0){
2315 size
= element_number
* fld
->element_size
;
2316 }else{//sequence has string or sequence
2318 for(i
=0;i
<element_number
;i
++){
2319 size
+= getFieldtypeSize(tf
, evT
,
2320 offsetRoot
+size
+size1
,size
+size1
,
2321 fld
->child
[0], evD
+size
+size1
);
2327 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2328 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2335 if(fld
->field_fixed
== -1){
2336 fld
->field_fixed
= 0;
2338 /* Hope my implementation is faster than strlen (Mathieu) */
2339 char *ptr
=(char*)evD
;
2341 /* from gcov : many many strings are empty, make it the common case.*/
2342 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2343 //size = ptr - (char*)evD + 1; //include end : '\0'
2345 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2346 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2351 element_number
= (int) type
->element_number
;
2353 /* tested with gcov */
2354 if(unlikely(fld
->field_fixed
== -1)){
2355 offset1
= offsetRoot
;
2357 for(i
=0;i
<element_number
;i
++){
2358 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2359 fld
->child
[i
], NULL
);
2360 if(likely(size1
> 0 && size
>= 0)){
2362 if(likely(offset1
>= 0)) offset1
+= size1
;
2370 if(unlikely(size
== -1)){
2371 fld
->field_fixed
= 0;
2373 }else fld
->field_fixed
= 1;
2374 }else if(likely(fld
->field_fixed
== 0)){
2375 offset1
= offsetRoot
;
2377 for(i
=0;unlikely(i
<element_number
);i
++){
2378 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2379 fld
->child
[i
], evD
+offset2
);
2384 }else size
= fld
->field_size
;
2385 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2386 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2390 if(unlikely(fld
->field_fixed
== -1)){
2391 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2392 fld
->field_fixed
= 1;
2393 }else size
= fld
->field_size
;
2395 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2396 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2401 fld
->offset_root
= offsetRoot
;
2402 fld
->offset_parent
= offsetParent
;
2403 fld
->field_size
= size
;
2405 end_getFieldtypeSize
:
2411 /*****************************************************************************
2413 * ltt_get_int : get an integer number
2415 * reverse_byte_order: must we reverse the byte order ?
2416 * size : the size of the integer
2417 * ptr : the data pointer
2419 * gint64 : a 64 bits integer
2420 ****************************************************************************/
2422 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2427 case 1: val
= *((gint8
*)data
); break;
2428 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2429 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2430 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2431 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2432 g_critical("get_int : integer size %d unknown", size
);
2439 /*****************************************************************************
2441 * ltt_get_uint : get an unsigned integer number
2443 * reverse_byte_order: must we reverse the byte order ?
2444 * size : the size of the integer
2445 * ptr : the data pointer
2447 * guint64 : a 64 bits unsigned integer
2448 ****************************************************************************/
2450 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2455 case 1: val
= *((gint8
*)data
); break;
2456 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2457 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2458 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2459 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2460 g_critical("get_uint : unsigned integer size %d unknown",
2469 /* get the node name of the system */
2471 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2473 return s
->node_name
;
2477 /* get the domain name of the system */
2479 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2481 return s
->domain_name
;
2485 /* get the description of the system */
2487 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2489 return s
->description
;
2493 /* get the start time of the trace */
2495 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2497 return s
->trace_start
;
2501 LttTracefile
*ltt_tracefile_new()
2503 return g_new(LttTracefile
, 1);
2506 void ltt_tracefile_destroy(LttTracefile
*tf
)
2511 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2516 /* Before library loading... */
2518 static void __attribute__((constructor
)) init(void)
2520 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2521 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2523 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");