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 file 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
);
853 textlen
+=strlen(text
);
854 if(textlen
>= PATH_MAX
) goto name_error
;
855 strcat(desc_file_name
, text
);
857 err
= ltt_facility_open(f
, t
, desc_file_name
);
858 if(err
) goto facility_error
;
867 static void ltt_fac_ids_destroy(gpointer data
)
869 GArray
*fac_ids
= (GArray
*)data
;
871 g_array_free(fac_ids
, TRUE
);
875 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
876 * because it must be done just after the opening */
877 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
886 err
= ltt_tracefile_read_seek(tf
);
887 if(err
== EPERM
) goto seek_error
;
888 else if(err
== ERANGE
) break; /* End of tracefile */
890 err
= ltt_tracefile_read_update_event(tf
);
891 if(err
) goto update_error
;
893 /* We are on a facility load/or facility unload/ or heartbeat event */
895 * * facility 0 is hardcoded : this is the core facility. It will be shown
896 * in the facility array though, and is shown as "loaded builtin" in the
898 * It contains event :
900 * 1 : facility unload
901 * 2 : state dump facility load
904 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
905 /* Should only contain core facility */
906 g_warning("Error in processing facility file %s, "
907 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
908 tf
->event
.facility_id
);
913 struct LttFacilityLoad
*fac_load_data
;
914 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
918 switch((enum ltt_core_events
)tf
->event
.event_id
) {
919 case LTT_EVENT_FACILITY_LOAD
:
920 fac_name
= (char*)(tf
->event
.data
);
921 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
924 (struct LttFacilityLoad
*)
925 (tf
->event
.data
+ strlen(fac_name
) + 1);
926 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
927 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
928 g_assert(fac
->exists
== 0);
929 fac
->name
= g_quark_from_string(fac_name
);
930 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
931 &fac_load_data
->checksum
);
932 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
933 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
934 &fac_load_data
->pointer_size
);
935 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
936 &fac_load_data
->long_size
);
937 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
938 &fac_load_data
->size_t_size
);
939 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
940 &fac_load_data
->alignment
);
942 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
943 continue; /* error opening description */
945 fac
->trace
= tf
->trace
;
947 /* Preset the field offsets */
948 for(i
=0; i
<fac
->events
->len
; i
++){
949 et
= &g_array_index(fac
->events
, LttEventType
, i
);
950 set_fields_offsets(tf
, et
);
955 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
957 if(fac_ids
== NULL
) {
958 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
959 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
961 fac_ids
, ltt_fac_ids_destroy
);
963 g_array_append_val(fac_ids
, fac
->id
);
966 case LTT_EVENT_FACILITY_UNLOAD
:
967 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
968 /* We don't care about unload : facilities ID are valid for the whole
969 * trace. They simply won't be used after the unload. */
971 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
972 fac_name
= (char*)(tf
->event
.data
);
973 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
975 fac_state_dump_load_data
=
976 (struct LttStateDumpFacilityLoad
*)
977 (tf
->event
.data
+ strlen(fac_name
) + 1);
978 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
979 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
980 g_assert(fac
->exists
== 0);
981 fac
->name
= g_quark_from_string(fac_name
);
982 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
983 &fac_state_dump_load_data
->checksum
);
984 fac
->id
= fac_state_dump_load_data
->id
;
985 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
986 &fac_state_dump_load_data
->pointer_size
);
987 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
988 &fac_state_dump_load_data
->long_size
);
989 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
990 &fac_state_dump_load_data
->size_t_size
);
991 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
992 &fac_state_dump_load_data
->alignment
);
993 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
994 continue; /* error opening description */
996 fac
->trace
= tf
->trace
;
998 /* Preset the field offsets */
999 for(i
=0; i
<fac
->events
->len
; i
++){
1000 et
= &g_array_index(fac
->events
, LttEventType
, i
);
1001 set_fields_offsets(tf
, et
);
1006 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
1008 if(fac_ids
== NULL
) {
1009 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
1010 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1012 fac_ids
, ltt_fac_ids_destroy
);
1014 g_array_append_val(fac_ids
, fac
->id
);
1017 case LTT_EVENT_HEARTBEAT
:
1020 g_warning("Error in processing facility file %s, "
1021 "unknown event id %hhu in core facility.",
1022 g_quark_to_string(tf
->name
),
1023 tf
->event
.event_id
);
1025 goto event_id_error
;
1031 /* Error handling */
1036 g_warning("An error occured in facility tracefile parsing");
1041 LttTrace
*ltt_trace_open(const gchar
*pathname
)
1043 gchar abs_path
[PATH_MAX
];
1048 struct ltt_block_start_header
*header
;
1050 struct dirent
*entry
;
1051 guint control_found
= 0;
1052 guint eventdefs_found
= 0;
1053 struct stat stat_buf
;
1054 gchar path
[PATH_MAX
];
1056 t
= g_new(LttTrace
, 1);
1057 if(!t
) goto alloc_error
;
1059 get_absolute_pathname(pathname
, abs_path
);
1060 t
->pathname
= g_quark_from_string(abs_path
);
1062 g_datalist_init(&t
->tracefiles
);
1064 /* Test to see if it looks like a trace */
1065 dir
= opendir(abs_path
);
1070 while((entry
= readdir(dir
)) != NULL
) {
1071 strcpy(path
, abs_path
);
1073 strcat(path
, entry
->d_name
);
1074 ret
= stat(path
, &stat_buf
);
1079 if(S_ISDIR(stat_buf
.st_mode
)) {
1080 if(strcmp(entry
->d_name
, "control") == 0) {
1083 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1084 eventdefs_found
= 1;
1090 if(!control_found
|| !eventdefs_found
) goto find_error
;
1092 /* Open all the tracefiles */
1093 if(open_tracefiles(t
, abs_path
, "")) {
1094 g_warning("Error opening tracefile %s", abs_path
);
1098 /* Prepare the facilities containers : array and mapping */
1099 /* Array is zeroed : the "exists" field is set to false by default */
1100 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1101 TRUE
, sizeof(LttFacility
),
1103 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1105 g_datalist_init(&t
->facilities_by_name
);
1107 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1108 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1110 g_error("Trace %s has no facility tracefile", abs_path
);
1112 goto facilities_error
;
1115 /* Get the trace information for the control/facility 0 tracefile */
1116 g_assert(group
->len
> 0);
1117 tf
= &g_array_index (group
, LttTracefile
, 0);
1118 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1119 g_assert(parse_trace_header(header
->trace
,
1122 t
->num_cpu
= group
->len
;
1124 for(i
=0; i
<group
->len
; i
++) {
1125 tf
= &g_array_index (group
, LttTracefile
, i
);
1126 if(ltt_process_facility_tracefile(tf
))
1127 goto facilities_error
;
1132 /* Error handling */
1134 g_datalist_clear(&t
->facilities_by_name
);
1135 g_array_free(t
->facilities_by_num
, TRUE
);
1137 g_datalist_clear(&t
->tracefiles
);
1145 GQuark
ltt_trace_name(const LttTrace
*t
)
1151 /******************************************************************************
1152 * When we copy a trace, we want all the opening actions to happen again :
1153 * the trace will be reopened and totally independant from the original.
1154 * That's why we call ltt_trace_open.
1155 *****************************************************************************/
1156 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1158 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1161 void ltt_trace_close(LttTrace
*t
)
1166 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1167 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1169 ltt_facility_close(fac
);
1172 g_datalist_clear(&t
->facilities_by_name
);
1173 g_array_free(t
->facilities_by_num
, TRUE
);
1174 g_datalist_clear(&t
->tracefiles
);
1179 /*****************************************************************************
1180 *Get the system description of the trace
1181 ****************************************************************************/
1183 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1185 g_assert(id
< t
->facilities_by_num
->len
);
1186 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1189 /* ltt_trace_facility_get_by_name
1191 * Returns the GArray of facility indexes. All the fac_ids that matches the
1192 * requested facility name.
1194 * If name is not found, returns NULL.
1196 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1198 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1201 /*****************************************************************************
1202 * Functions to discover all the event types in the trace
1203 ****************************************************************************/
1206 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1210 unsigned int num
= t
->facility_number
;
1214 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1215 count
+= f
->event_number
;
1222 //use an iteration on all the trace facilities, and inside iteration on all the
1223 //event types in each facilities instead.
1224 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1226 LttEventType
*event_type
;
1229 f
= ltt_trace_facility_by_id(t
,evId
);
1231 if(unlikely(!f
)) event_type
= NULL
;
1232 else event_type
= f
->events
[evId
- f
->base_id
];
1239 /*****************************************************************************
1240 * ltt_trace_find_tracefile
1242 * Find a tracefile by name and index in the group.
1244 * Returns a pointer to the tracefiles, else NULL.
1245 ****************************************************************************/
1247 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1252 /*****************************************************************************
1253 * Get the start time and end time of the trace
1254 ****************************************************************************/
1256 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1257 LttTime
*start
, LttTime
*end
)
1261 err
= map_block(tf
, 0);
1263 g_error("Can not map block");
1264 *start
= ltt_time_infinite
;
1266 *start
= tf
->buffer
.begin
.timestamp
;
1268 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1270 g_error("Can not map block");
1271 *end
= ltt_time_zero
;
1273 *end
= tf
->buffer
.end
.timestamp
;
1276 struct tracefile_time_span_get_args
{
1282 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1284 struct tracefile_time_span_get_args
*args
=
1285 (struct tracefile_time_span_get_args
*)user_data
;
1287 GArray
*group
= (GArray
*)data
;
1293 for(i
=0; i
<group
->len
; i
++) {
1294 tf
= &g_array_index (group
, LttTracefile
, i
);
1295 if(tf
->cpu_online
) {
1296 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1297 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1298 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1303 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1305 LttTime min_start
= ltt_time_infinite
;
1306 LttTime max_end
= ltt_time_zero
;
1307 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1309 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1311 if(start
!= NULL
) *start
= min_start
;
1312 if(end
!= NULL
) *end
= max_end
;
1317 /*****************************************************************************
1318 *Get the name of a tracefile
1319 ****************************************************************************/
1321 GQuark
ltt_tracefile_name(const LttTracefile
*tf
)
1326 GQuark
ltt_tracefile_long_name(const LttTracefile
*tf
)
1328 return tf
->long_name
;
1333 guint
ltt_tracefile_num(LttTracefile
*tf
)
1338 /*****************************************************************************
1339 * Get the number of blocks in the tracefile
1340 ****************************************************************************/
1342 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1344 return tf
->num_blocks
;
1348 /* Seek to the first event in a tracefile that has a time equal or greater than
1349 * the time passed in parameter.
1351 * If the time parameter is outside the tracefile time span, seek to the first
1352 * event or if after, return ERANGE.
1354 * If the time parameter is before the first event, we have to seek specially to
1357 * If the time is after the end of the trace, return ERANGE.
1359 * Do a binary search to find the right block, then a sequential search in the
1360 * block to find the event.
1362 * In the special case where the time requested fits inside a block that has no
1363 * event corresponding to the requested time, the first event of the next block
1366 * IMPORTANT NOTE : // FIXME everywhere...
1368 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1369 * you will jump over an event if you do.
1371 * Return value : 0 : no error, the tf->event can be used
1372 * ERANGE : time if after the last event of the trace
1373 * otherwise : this is an error.
1377 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1381 unsigned int block_num
, high
, low
;
1383 /* seek at the beginning of trace */
1384 err
= map_block(tf
, 0); /* First block */
1386 g_error("Can not map block");
1390 /* If the time is lower or equal the beginning of the trace,
1391 * go to the first event. */
1392 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1393 ret
= ltt_tracefile_read(tf
);
1394 if(ret
== ERANGE
) goto range
;
1395 else if (ret
) goto fail
;
1396 goto found
; /* There is either no event in the trace or the event points
1397 to the first event in the trace */
1400 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1402 g_error("Can not map block");
1406 /* If the time is after the end of the trace, return ERANGE. */
1407 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1411 /* Binary search the block */
1412 high
= tf
->num_blocks
- 1;
1416 block_num
= ((high
-low
) / 2) + low
;
1418 err
= map_block(tf
, block_num
);
1420 g_error("Can not map block");
1424 /* We cannot divide anymore : this is what would happen if the time
1425 * requested was exactly between two consecutive buffers'end and start
1426 * timestamps. This is also what would happend if we didn't deal with out
1427 * of span cases prior in this function. */
1428 /* The event is right in the buffer!
1429 * (or in the next buffer first event) */
1431 ret
= ltt_tracefile_read(tf
);
1432 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1433 else if(ret
) goto fail
;
1435 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1439 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1440 /* go to lower part */
1441 high
= block_num
- 1;
1442 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1443 /* go to higher part */
1444 low
= block_num
+ 1;
1445 } else {/* The event is right in the buffer!
1446 (or in the next buffer first event) */
1448 ret
= ltt_tracefile_read(tf
);
1449 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1450 else if(ret
) goto fail
;
1452 if(ltt_time_compare(time
, tf
->event
.event_time
) <= 0)
1464 /* Error handling */
1466 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1467 g_quark_to_string(tf
->name
));
1472 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1476 if(ep
->tracefile
!= tf
) {
1480 err
= map_block(tf
, ep
->block
);
1482 g_error("Can not map block");
1486 tf
->event
.offset
= ep
->offset
;
1488 err
= ltt_tracefile_read_update_event(tf
);
1490 err
= ltt_tracefile_read_op(tf
);
1496 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1497 g_quark_to_string(tf
->name
));
1501 /* Calculate the real event time based on the buffer boundaries */
1502 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1506 g_assert(tf
->trace
->has_tsc
);
1508 time
= ltt_time_from_uint64(
1509 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1510 tf
->buffer
.nsecs_per_cycle
);
1511 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1517 /* Get the current event of the tracefile : valid until the next read */
1518 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1525 /*****************************************************************************
1527 * ltt_tracefile_read : Read the next event in the tracefile
1532 * Returns 0 if an event can be used in tf->event.
1533 * Returns ERANGE on end of trace. The event in tf->event still can be used
1534 * (if the last block was not empty).
1535 * Returns EPERM on error.
1537 * This function does make the tracefile event structure point to the event
1538 * currently pointed to by the tf->event.
1540 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1541 * reinitialize it after an error if you want results to be coherent.
1542 * It would be the case if a end of trace last buffer has no event : the end
1543 * of trace wouldn't be returned, but an error.
1544 * We make the assumption there is at least one event per buffer.
1545 ****************************************************************************/
1547 int ltt_tracefile_read(LttTracefile
*tf
)
1551 err
= ltt_tracefile_read_seek(tf
);
1553 err
= ltt_tracefile_read_update_event(tf
);
1555 err
= ltt_tracefile_read_op(tf
);
1561 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1565 /* Get next buffer until we finally have an event, or end of trace */
1567 err
= ltt_seek_next_event(tf
);
1568 if(unlikely(err
== ENOPROTOOPT
)) {
1572 /* Are we at the end of the buffer ? */
1574 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1577 /* get next block */
1578 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1580 g_error("Can not map block");
1584 } else break; /* We found an event ! */
1591 /* do specific operation on events */
1592 int ltt_tracefile_read_op(LttTracefile
*tf
)
1598 /* do event specific operation */
1600 /* do something if its an heartbeat event : increment the heartbeat count */
1601 //if(event->facility_id == LTT_FACILITY_CORE)
1602 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1603 // tf->cur_heart_beat_number++;
1609 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1610 * event specific operation. */
1611 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1617 pos
= tf
->buffer
.head
+ event
->offset
;
1619 /* Read event header */
1623 if(tf
->trace
->has_tsc
) {
1624 if(tf
->trace
->has_heartbeat
) {
1625 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1627 /* 32 bits -> 64 bits tsc */
1628 /* note : still works for seek and non seek cases. */
1629 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1630 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1632 | (guint64
)event
->time
.timestamp
;
1633 event
->tsc
= tf
->buffer
.tsc
;
1636 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1637 | (guint64
)event
->time
.timestamp
;
1638 event
->tsc
= tf
->buffer
.tsc
;
1640 pos
+= sizeof(guint32
);
1642 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1643 tf
->buffer
.tsc
= event
->tsc
;
1644 pos
+= sizeof(guint64
);
1647 event
->event_time
= ltt_interpolate_time(tf
, event
);
1649 event
->time
.delta
.tv_sec
= 0;
1650 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1651 pos
) * NSEC_PER_USEC
;
1653 event
->tsc
= tf
->buffer
.tsc
;
1655 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1657 pos
+= sizeof(guint32
);
1660 event
->facility_id
= *(guint8
*)pos
;
1661 pos
+= sizeof(guint8
);
1663 event
->event_id
= *(guint8
*)pos
;
1664 pos
+= sizeof(guint8
);
1666 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1667 pos
+= sizeof(guint16
);
1671 /* get the data size and update the event fields with the current
1673 ltt_update_event_size(tf
);
1679 /****************************************************************************
1681 * map_block : map a block from the file
1683 * lttdes : ltt trace file
1684 * whichBlock : the block which will be read
1687 * EINVAL : lseek fail
1688 * EIO : can not read from the file
1689 ****************************************************************************/
1691 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1693 int page_size
= getpagesize();
1694 struct ltt_block_start_header
*header
;
1696 g_assert(block_num
< tf
->num_blocks
);
1698 if(tf
->buffer
.head
!= NULL
) {
1699 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1700 g_warning("unmap size : %u\n",
1701 PAGE_ALIGN(tf
->buf_size
));
1702 perror("munmap error");
1708 /* Multiple of pages aligned head */
1709 tf
->buffer
.head
= mmap(0,
1710 PAGE_ALIGN(tf
->buf_size
),
1711 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1712 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1714 if(tf
->buffer
.head
== MAP_FAILED
) {
1715 perror("Error in allocating memory for buffer of tracefile");
1719 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1722 tf
->buffer
.index
= block_num
;
1724 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1726 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1727 &header
->begin
.timestamp
);
1728 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1729 //g_debug("block %u begin : %lu.%lu", block_num,
1730 // tf->buffer.begin.timestamp.tv_sec, tf->buffer.begin.timestamp.tv_nsec);
1731 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1732 &header
->begin
.cycle_count
);
1733 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1734 &header
->end
.timestamp
);
1735 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1736 //g_debug("block %u end : %lu.%lu", block_num,
1737 // tf->buffer.end.timestamp.tv_sec, tf->buffer.end.timestamp.tv_nsec);
1738 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1739 &header
->end
.cycle_count
);
1740 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1741 &header
->lost_size
);
1743 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1744 tf
->event
.tsc
= tf
->buffer
.tsc
;
1747 * eventually support variable buffer size : will need a partial pre-read of
1748 * the headers to create an index when we open the trace... eventually. */
1749 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1750 &header
->buf_size
));
1752 /* Now that the buffer is mapped, calculate the time interpolation for the
1755 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1757 /* Make the current event point to the beginning of the buffer :
1758 * it means that the event read must get the first event. */
1759 tf
->event
.tracefile
= tf
;
1760 tf
->event
.block
= block_num
;
1761 tf
->event
.offset
= 0;
1770 /* It will update the fields offsets too */
1771 void ltt_update_event_size(LttTracefile
*tf
)
1775 /* Specific handling of core events : necessary to read the facility control
1777 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1778 tf
->event
.facility_id
);
1780 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1781 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1782 case LTT_EVENT_FACILITY_LOAD
:
1783 size
= strlen((char*)tf
->event
.data
) + 1;
1784 //g_debug("Update Event facility load of facility %s", (char*)tf->event.data);
1785 size
+= sizeof(struct LttFacilityLoad
);
1787 case LTT_EVENT_FACILITY_UNLOAD
:
1788 //g_debug("Update Event facility unload");
1789 size
= sizeof(struct LttFacilityUnload
);
1791 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1792 size
= strlen((char*)tf
->event
.data
) + 1;
1793 //g_debug("Update Event facility load state dump of facility %s",
1794 // (char*)tf->event.data);
1795 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1797 case LTT_EVENT_HEARTBEAT
:
1798 //g_debug("Update Event heartbeat");
1799 size
= sizeof(TimeHeartbeat
);
1802 g_warning("Error in getting event size : tracefile %s, "
1803 "unknown event id %hhu in core facility.",
1804 g_quark_to_string(tf
->name
),
1805 tf
->event
.event_id
);
1806 goto event_id_error
;
1811 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1812 tf
->event
.facility_id
,
1813 tf
->event
.facility_id
,
1814 g_quark_to_string(tf
->name
));
1815 goto facility_error
;
1818 LttEventType
*event_type
=
1819 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1822 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1824 g_quark_to_string(f
->name
),
1825 g_quark_to_string(tf
->name
));
1826 goto event_type_error
;
1829 if(event_type
->root_field
)
1830 size
= get_field_type_size(tf
, event_type
,
1831 0, 0, event_type
->root_field
, tf
->event
.data
);
1835 //g_debug("Event root field : f.e %hhu.%hhu size %zd",
1836 // tf->event.facility_id,
1837 // tf->event.event_id, size);
1840 tf
->event
.data_size
= size
;
1842 /* Check consistency between kernel and LTTV structure sizes */
1843 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1850 tf
->event
.data_size
= 0;
1854 /* Take the tf current event offset and use the event facility id and event id
1855 * to figure out where is the next event offset.
1857 * This is an internal function not aiming at being used elsewhere : it will
1858 * not jump over the current block limits. Please consider using
1859 * ltt_tracefile_read to do this.
1861 * Returns 0 on success
1862 * ERANGE if we are at the end of the buffer.
1863 * ENOPROTOOPT if an error occured when getting the current event size.
1865 static int ltt_seek_next_event(LttTracefile
*tf
)
1870 /* seek over the buffer header if we are at the buffer start */
1871 if(tf
->event
.offset
== 0) {
1872 tf
->event
.offset
+= tf
->buffer_header_size
;
1874 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1881 pos
= tf
->event
.data
;
1883 if(tf
->event
.data_size
< 0) goto error
;
1885 pos
+= (size_t)tf
->event
.data_size
;
1887 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1889 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1893 g_assert(tf
->event
.offset
< tf
->buf_size
- tf
->buffer
.lost_size
);
1899 g_error("Error in ltt_seek_next_event for tracefile %s",
1900 g_quark_to_string(tf
->name
));
1905 /*****************************************************************************
1907 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1910 ****************************************************************************/
1912 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1914 LttTime lBufTotalTime
; /* Total time for this buffer */
1915 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1916 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1918 /* Calculate the total time for this buffer */
1919 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1920 tf
->buffer
.begin
.timestamp
);
1922 /* Calculate the total cycles for this bufffer */
1923 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1924 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1926 /* Convert the total time to double */
1927 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1929 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1933 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1935 LttField
* rootFld
= evT
->root_field
;
1936 // rootFld->base_address = evD;
1939 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1940 evT
, 0,0,rootFld
, evD
);
1944 /*****************************************************************************
1946 * set_fields_offsets : set the precomputable offset of the fields
1948 * tracefile : opened trace file
1949 * event_type : the event type
1950 ****************************************************************************/
1952 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1954 LttField
*field
= event_type
->root_field
;
1955 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1958 preset_field_type_size(tf
, event_type
, 0, 0,
1959 &fixed_root
, &fixed_parent
,
1965 /*****************************************************************************
1967 * preset_field_type_size : set the fixed sizes of the field type
1970 * event_type : event type
1971 * offset_root : offset from the root
1972 * offset_parent : offset from the parent
1973 * fixed_root : Do we know a fixed offset to the root ?
1974 * fixed_parent : Do we know a fixed offset to the parent ?
1976 ****************************************************************************/
1977 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1978 off_t offset_root
, off_t offset_parent
,
1979 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1982 enum field_status local_fixed_root
, local_fixed_parent
;
1986 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1987 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1988 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1990 type
= field
->field_type
;
1992 field
->fixed_root
= *fixed_root
;
1993 if(field
->fixed_root
== FIELD_FIXED
)
1994 field
->offset_root
= offset_root
;
1996 field
->offset_root
= 0;
1998 field
->fixed_parent
= *fixed_parent
;
1999 if(field
->fixed_parent
== FIELD_FIXED
)
2000 field
->offset_parent
= offset_parent
;
2002 field
->offset_parent
= 0;
2004 size_t current_root_offset
;
2005 size_t current_offset
;
2006 enum field_status current_child_status
, final_child_status
;
2009 switch(type
->type_class
) {
2014 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2015 field
->fixed_size
= FIELD_FIXED
;
2018 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2019 field
->fixed_size
= FIELD_FIXED
;
2023 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2024 field
->fixed_size
= FIELD_FIXED
;
2029 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2030 field
->fixed_size
= FIELD_FIXED
;
2033 local_fixed_root
= FIELD_VARIABLE
;
2034 local_fixed_parent
= FIELD_VARIABLE
;
2035 preset_field_type_size(tf
, event_type
,
2037 &local_fixed_root
, &local_fixed_parent
,
2039 field
->fixed_size
= FIELD_VARIABLE
;
2040 field
->field_size
= 0;
2041 *fixed_root
= FIELD_VARIABLE
;
2042 *fixed_parent
= FIELD_VARIABLE
;
2045 field
->fixed_size
= FIELD_VARIABLE
;
2046 field
->field_size
= 0;
2047 *fixed_root
= FIELD_VARIABLE
;
2048 *fixed_parent
= FIELD_VARIABLE
;
2051 local_fixed_root
= FIELD_VARIABLE
;
2052 local_fixed_parent
= FIELD_VARIABLE
;
2053 preset_field_type_size(tf
, event_type
,
2055 &local_fixed_root
, &local_fixed_parent
,
2057 field
->fixed_size
= field
->child
[0]->fixed_size
;
2058 if(field
->fixed_size
== FIELD_FIXED
) {
2059 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2061 field
->field_size
= 0;
2062 *fixed_root
= FIELD_VARIABLE
;
2063 *fixed_parent
= FIELD_VARIABLE
;
2067 current_root_offset
= field
->offset_root
;
2069 current_child_status
= FIELD_FIXED
;
2070 for(i
=0;i
<type
->element_number
;i
++) {
2071 preset_field_type_size(tf
, event_type
,
2072 current_root_offset
, current_offset
,
2073 fixed_root
, ¤t_child_status
,
2075 if(current_child_status
== FIELD_FIXED
) {
2076 current_root_offset
+= field
->child
[i
]->field_size
;
2077 current_offset
+= field
->child
[i
]->field_size
;
2079 current_root_offset
= 0;
2083 if(current_child_status
!= FIELD_FIXED
) {
2084 *fixed_parent
= current_child_status
;
2085 field
->field_size
= 0;
2086 field
->fixed_size
= current_child_status
;
2088 field
->field_size
= current_offset
;
2089 field
->fixed_size
= FIELD_FIXED
;
2093 current_root_offset
= field
->offset_root
;
2096 final_child_status
= FIELD_FIXED
;
2097 for(i
=0;i
<type
->element_number
;i
++) {
2098 enum field_status current_root_child_status
= FIELD_FIXED
;
2099 enum field_status current_child_status
= FIELD_FIXED
;
2100 preset_field_type_size(tf
, event_type
,
2101 current_root_offset
, current_offset
,
2102 ¤t_root_child_status
, ¤t_child_status
,
2104 if(current_child_status
!= FIELD_FIXED
)
2105 final_child_status
= current_child_status
;
2107 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2109 if(final_child_status
!= FIELD_FIXED
) {
2110 *fixed_root
= final_child_status
;
2111 *fixed_parent
= final_child_status
;
2112 field
->field_size
= 0;
2113 field
->fixed_size
= current_child_status
;
2115 field
->field_size
= max_size
;
2116 field
->fixed_size
= FIELD_FIXED
;
2124 /*****************************************************************************
2126 * check_fields_compatibility : Check for compatibility between two fields :
2127 * do they use the same inner structure ?
2129 * event_type1 : event type
2130 * event_type2 : event type
2133 *Returns : 0 if identical
2135 ****************************************************************************/
2136 gint
check_fields_compatibility(LttEventType
*event_type1
,
2137 LttEventType
*event_type2
,
2138 LttField
*field1
, LttField
*field2
)
2140 guint different
= 0;
2145 if(field1
== NULL
) {
2146 if(field2
== NULL
) goto end
;
2151 } else if(field2
== NULL
) {
2156 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2157 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2158 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2159 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2160 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2161 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2163 type1
= field1
->field_type
;
2164 type2
= field2
->field_type
;
2166 if(type1
->type_class
!= type2
->type_class
) {
2170 if(type1
->element_name
!= type2
->element_name
) {
2175 switch(type1
->type_class
) {
2185 if(field1
->field_size
!= field2
->field_size
) {
2191 if(type1
->element_number
!= type2
->element_number
) {
2195 for(i
=0;i
<type1
->element_number
;i
++) {
2196 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2203 /* Two elements : size and child */
2204 g_assert(type1
->element_number
!= type2
->element_number
);
2205 for(i
=0;i
<type1
->element_number
;i
++) {
2206 if(check_fields_compatibility(event_type1
, event_type2
,
2207 field1
->child
[0], field2
->child
[0])) {
2216 if(field1
->field_size
!= field2
->field_size
) {
2220 /* Two elements : size and child */
2221 g_assert(type1
->element_number
!= type2
->element_number
);
2222 for(i
=0;i
<type1
->element_number
;i
++) {
2223 if(check_fields_compatibility(event_type1
, event_type2
,
2224 field1
->child
[0], field2
->child
[0])) {
2232 if(type1
->element_number
!= type2
->element_number
) {
2236 for(i
=0;i
<type1
->element_number
;i
++) {
2237 if(check_fields_compatibility(event_type1
, event_type2
,
2238 field1
->child
[0], field2
->child
[0])) {
2253 /*****************************************************************************
2255 * getFieldtypeSize: get the size of the field type (primitive type)
2258 * offsetRoot : offset from the root
2259 * offsetParent : offset from the parrent
2261 * evD : event data, it may be NULL
2263 * int : size of the field
2264 ****************************************************************************/
2266 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2267 LttEventType
* evT
, gint offsetRoot
,
2268 gint offsetParent
, LttField
* fld
, void *evD
)
2270 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2271 LttType
* type
= fld
->field_type
;
2273 /* This likely has been tested with gcov : half of them.. */
2274 if(unlikely(fld
->field_fixed
== 1)){
2276 if(unlikely(fld
== evT
->root_field
)) {
2277 size
= fld
->field_size
;
2278 goto end_getFieldtypeSize
;
2282 /* From gcov profiling : half string, half struct, can we gain something
2283 * from that ? (Mathieu) */
2284 switch(type
->type_class
) {
2286 element_number
= (int) type
->element_number
;
2287 if(fld
->field_fixed
== -1){
2288 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2289 0,fld
->child
[0], NULL
);
2290 if(size
== 0){ //has string or sequence
2291 fld
->field_fixed
= 0;
2293 fld
->field_fixed
= 1;
2294 size
*= element_number
;
2296 }else if(fld
->field_fixed
== 0){// has string or sequence
2298 for(i
=0;i
<element_number
;i
++){
2299 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2300 fld
->child
[0], evD
+size
);
2302 }else size
= fld
->field_size
;
2304 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2305 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2311 size1
= (int) ltt_type_size(fac
, type
);
2312 if(fld
->field_fixed
== -1){
2313 fld
->sequ_number_size
= size1
;
2314 fld
->field_fixed
= 0;
2315 size
= getFieldtypeSize(evT
, offsetRoot
,
2316 0,fld
->child
[0], NULL
);
2317 fld
->element_size
= size
;
2319 element_number
= getIntNumber(tf
,size1
,evD
);
2320 type
->element_number
= element_number
;
2321 if(fld
->element_size
> 0){
2322 size
= element_number
* fld
->element_size
;
2323 }else{//sequence has string or sequence
2325 for(i
=0;i
<element_number
;i
++){
2326 size
+= getFieldtypeSize(tf
, evT
,
2327 offsetRoot
+size
+size1
,size
+size1
,
2328 fld
->child
[0], evD
+size
+size1
);
2334 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2335 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2342 if(fld
->field_fixed
== -1){
2343 fld
->field_fixed
= 0;
2345 /* Hope my implementation is faster than strlen (Mathieu) */
2346 char *ptr
=(char*)evD
;
2348 /* from gcov : many many strings are empty, make it the common case.*/
2349 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2350 //size = ptr - (char*)evD + 1; //include end : '\0'
2352 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2353 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2358 element_number
= (int) type
->element_number
;
2360 /* tested with gcov */
2361 if(unlikely(fld
->field_fixed
== -1)){
2362 offset1
= offsetRoot
;
2364 for(i
=0;i
<element_number
;i
++){
2365 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2366 fld
->child
[i
], NULL
);
2367 if(likely(size1
> 0 && size
>= 0)){
2369 if(likely(offset1
>= 0)) offset1
+= size1
;
2377 if(unlikely(size
== -1)){
2378 fld
->field_fixed
= 0;
2380 }else fld
->field_fixed
= 1;
2381 }else if(likely(fld
->field_fixed
== 0)){
2382 offset1
= offsetRoot
;
2384 for(i
=0;unlikely(i
<element_number
);i
++){
2385 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2386 fld
->child
[i
], evD
+offset2
);
2391 }else size
= fld
->field_size
;
2392 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2393 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2397 if(unlikely(fld
->field_fixed
== -1)){
2398 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2399 fld
->field_fixed
= 1;
2400 }else size
= fld
->field_size
;
2402 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2403 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2408 fld
->offset_root
= offsetRoot
;
2409 fld
->offset_parent
= offsetParent
;
2410 fld
->field_size
= size
;
2412 end_getFieldtypeSize
:
2418 /*****************************************************************************
2420 * ltt_get_int : get an integer number
2422 * reverse_byte_order: must we reverse the byte order ?
2423 * size : the size of the integer
2424 * ptr : the data pointer
2426 * gint64 : a 64 bits integer
2427 ****************************************************************************/
2429 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2434 case 1: val
= *((gint8
*)data
); break;
2435 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2436 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2437 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2438 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2439 g_critical("get_int : integer size %d unknown", size
);
2446 /*****************************************************************************
2448 * ltt_get_uint : get an unsigned integer number
2450 * reverse_byte_order: must we reverse the byte order ?
2451 * size : the size of the integer
2452 * ptr : the data pointer
2454 * guint64 : a 64 bits unsigned integer
2455 ****************************************************************************/
2457 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2462 case 1: val
= *((gint8
*)data
); break;
2463 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2464 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2465 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2466 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2467 g_critical("get_uint : unsigned integer size %d unknown",
2476 /* get the node name of the system */
2478 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2480 return s
->node_name
;
2484 /* get the domain name of the system */
2486 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2488 return s
->domain_name
;
2492 /* get the description of the system */
2494 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2496 return s
->description
;
2500 /* get the start time of the trace */
2502 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2504 return s
->trace_start
;
2508 LttTracefile
*ltt_tracefile_new()
2510 return g_new(LttTracefile
, 1);
2513 void ltt_tracefile_destroy(LttTracefile
*tf
)
2518 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2523 /* Before library loading... */
2525 static void __attribute__((constructor
)) init(void)
2527 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2528 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2530 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");