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
)) goto unmap_file
;
315 //store the size of the file
316 tf
->file_size
= lTDFStat
.st_size
;
317 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
318 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
320 if(munmap(tf
->buffer
.head
,
321 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
322 + sizeof(struct ltt_trace_header_any
)))) {
323 g_warning("unmap size : %u\n",
324 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
325 + sizeof(struct ltt_trace_header_any
)));
326 perror("munmap error");
329 tf
->buffer
.head
= NULL
;
331 //read the first block
332 if(map_block(tf
,0)) {
333 perror("Cannot map block for tracefile");
341 if(munmap(tf
->buffer
.head
,
342 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
343 + sizeof(struct ltt_trace_header_any
)))) {
344 g_warning("unmap size : %u\n",
345 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)
346 + sizeof(struct ltt_trace_header_any
)));
347 perror("munmap error");
356 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
362 /*****************************************************************************
363 *Open control and per cpu tracefiles
364 ****************************************************************************/
366 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
369 tf
= ltt_tracefile_open(t
,tracefile_name
);
371 t
->per_cpu_tracefile_number
++;
372 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
375 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
384 tf
= ltt_tracefile_open(t
,control_name
);
386 g_warning("ltt_tracefile_open_control : bad file descriptor");
389 t
->control_tracefile_number
++;
390 g_ptr_array_add(t
->control_tracefiles
,tf
);
392 //parse facilities tracefile to get base_id
393 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
395 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
397 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
399 fLoad
.name
= (gchar
*)pos
;
400 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
401 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
403 for(i
=0;i
<t
->facility_number
;i
++){
404 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
405 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
406 f
->base_id
= fLoad
.base_code
;
410 if(i
==t
->facility_number
) {
411 g_warning("Facility: %s, checksum: %u is not found",
412 fLoad
.name
,(unsigned int)fLoad
.checksum
);
415 }else if(ev
.event_id
== TRACE_BLOCK_START
){
417 }else if(ev
.event_id
== TRACE_BLOCK_END
){
420 g_warning("Not valid facilities trace file");
429 /*****************************************************************************
431 * ltt_tracefile_close: close a trace file,
433 * t : tracefile which will be closed
434 ****************************************************************************/
436 void ltt_tracefile_close(LttTracefile
*t
)
438 int page_size
= getpagesize();
440 if(t
->buffer
.head
!= NULL
)
441 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
442 g_warning("unmap size : %u\n",
443 PAGE_ALIGN(t
->buf_size
));
444 perror("munmap error");
452 /*****************************************************************************
453 *Get system information
454 ****************************************************************************/
456 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
463 GMarkupParseContext
* context
;
464 GError
* error
= NULL
;
465 GMarkupParser markup_parser
=
467 parser_start_element
,
470 NULL
, /* passthrough */
474 fd
= g_open(pathname
, O_RDONLY
, 0);
476 g_warning("Can not open file : %s\n", pathname
);
480 iochan
= g_io_channel_unix_new(fd
);
482 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
484 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
485 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
486 != G_IO_STATUS_EOF
) {
489 g_warning("Can not read xml file: \n%s\n", error
->message
);
492 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
494 g_warning("Can not parse xml file: \n%s\n", error
->message
);
497 g_markup_parse_context_free(context
);
499 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
501 g_warning("Can not close file: \n%s\n", error
->message
);
509 g_markup_parse_context_free(context
);
511 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
513 g_warning("Can not close file: \n%s\n", error
->message
);
524 /*****************************************************************************
525 *The following functions get facility/tracefile information
526 ****************************************************************************/
528 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
535 gchar fullname
[DIR_NAME_SIZE
];
536 GError
* error
= NULL
;
538 dir
= g_dir_open(eventdefs
, 0, &error
);
541 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
546 while((name
= g_dir_read_name(dir
)) != NULL
){
547 if(!g_pattern_match_simple("*.xml", name
)) continue;
548 strcpy(fullname
,eventdefs
);
549 strcat(fullname
,name
);
550 ltt_facility_open(t
,fullname
);
554 for(j
=0;j
<t
->facility_number
;j
++){
555 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
556 for(i
=0; i
<f
->event_number
; i
++){
558 setFieldsOffset(NULL
, et
, NULL
, t
);
565 /*****************************************************************************
566 *A trace is specified as a pathname to the directory containing all the
567 *associated data (control tracefiles, per cpu tracefiles, event
570 *When a trace is closed, all the associated facilities, types and fields
571 *are released as well.
575 /****************************************************************************
576 * get_absolute_pathname
578 * return the unique pathname in the system
580 * MD : Fixed this function so it uses realpath, dealing well with
581 * forgotten cases (.. were not used correctly before).
583 ****************************************************************************/
584 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
586 abs_pathname
[0] = '\0';
588 if ( realpath (pathname
, abs_pathname
) != NULL
)
592 /* error, return the original path unmodified */
593 strcpy(abs_pathname
, pathname
);
599 /* Search for something like : .*_.*
601 * The left side is the name, the right side is the number.
604 int get_tracefile_name_number(const gchar
*raw_name
,
608 guint raw_name_len
= strlen(raw_name
);
609 gchar char_name
[PATH_MAX
];
615 for(i
=raw_name_len
-1;i
>=0;i
--) {
616 if(raw_name
[i
] == '_') break;
618 if(i
==0) /* Either not found or name length is 0 */
622 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
624 if(endptr
== raw_name
+underscore_pos
+1)
625 return -1; /* No digit */
626 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
627 return -1; /* underflow / overflow */
629 strncpy(char_name
, raw_name
, underscore_pos
);
631 char_name
[underscore_pos
] = '\0';
633 *name
= g_quark_from_string(char_name
);
640 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
642 return &trace
->tracefiles
;
646 void compute_tracefile_group(GQuark key_id
,
648 struct compute_tracefile_group_args
*args
)
653 for(i
=0; i
<group
->len
; i
++) {
654 tf
= &g_array_index (group
, LttTracefile
, i
);
656 args
->func(tf
, args
->func_args
);
661 void ltt_tracefile_group_destroy(gpointer data
)
663 GArray
*group
= (GArray
*)data
;
667 for(i
=0; i
<group
->len
; i
++) {
668 tf
= &g_array_index (group
, LttTracefile
, i
);
670 ltt_tracefile_close(tf
);
672 g_array_free(group
, TRUE
);
675 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
677 GArray
*group
= (GArray
*)data
;
681 for(i
=0; i
<group
->len
; i
++) {
682 tf
= &g_array_index (group
, LttTracefile
, i
);
683 if(tf
->cpu_online
) return 1;
689 /* Open each tracefile under a specific directory. Put them in a
690 * GData : permits to access them using their tracefile group pathname.
691 * i.e. access control/modules tracefile group by index :
694 * relative path is the path relative to the trace root
695 * root path is the full path
697 * A tracefile group is simply an array where all the per cpu tracefiles sits.
700 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
701 gchar
*relative_path
)
703 DIR *dir
= opendir(root_path
);
704 struct dirent
*entry
;
705 struct stat stat_buf
;
708 gchar path
[PATH_MAX
];
713 gchar rel_path
[PATH_MAX
];
722 strncpy(path
, root_path
, PATH_MAX
-1);
723 path_len
= strlen(path
);
724 path
[path_len
] = '/';
726 path_ptr
= path
+ path_len
;
728 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
729 rel_path_len
= strlen(rel_path
);
730 rel_path
[rel_path_len
] = '/';
732 rel_path_ptr
= rel_path
+ rel_path_len
;
734 while((entry
= readdir(dir
)) != NULL
) {
736 if(entry
->d_name
[0] == '.') continue;
738 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
739 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
741 ret
= stat(path
, &stat_buf
);
747 g_debug("Tracefile file or directory : %s\n", path
);
749 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
751 if(S_ISDIR(stat_buf
.st_mode
)) {
753 g_debug("Entering subdirectory...\n");
754 ret
= open_tracefiles(trace
, path
, rel_path
);
755 if(ret
< 0) continue;
756 } else if(S_ISREG(stat_buf
.st_mode
)) {
761 if(get_tracefile_name_number(rel_path
, &name
, &num
))
762 continue; /* invalid name */
764 g_debug("Opening file.\n");
765 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
766 g_info("Error opening tracefile %s", path
);
768 continue; /* error opening the tracefile : bad magic number ? */
771 g_debug("Tracefile name is %s and number is %u",
772 g_quark_to_string(name
), num
);
774 tmp_tf
.cpu_online
= 1;
775 tmp_tf
.cpu_num
= num
;
778 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
780 /* Elements are automatically cleared when the array is allocated.
781 * It makes the cpu_online variable set to 0 : cpu offline, by default.
783 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
784 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
785 group
, ltt_tracefile_group_destroy
);
788 /* Add the per cpu tracefile to the named group */
789 unsigned int old_len
= group
->len
;
791 group
= g_array_set_size(group
, num
+1);
792 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
802 /* ltt_get_facility_description
804 * Opens the trace corresponding to the requested facility (identified by fac_id
807 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
809 * Returns 0 on success, or 1 on failure.
812 static int ltt_get_facility_description(LttFacility
*f
,
814 LttTracefile
*fac_tf
)
816 char desc_file_name
[PATH_MAX
];
821 text
= g_quark_to_string(t
->pathname
);
822 textlen
= strlen(text
);
824 if(textlen
>= PATH_MAX
) goto name_error
;
825 strcpy(desc_file_name
, text
);
827 text
= "/eventdefs/";
828 textlen
+=strlen(text
);
829 if(textlen
>= PATH_MAX
) goto name_error
;
830 strcat(desc_file_name
, text
);
832 text
= g_quark_to_string(f
->name
);
833 textlen
+=strlen(text
);
834 if(textlen
>= PATH_MAX
) goto name_error
;
835 strcat(desc_file_name
, text
);
838 textlen
+=strlen(text
);
839 if(textlen
>= PATH_MAX
) goto name_error
;
840 strcat(desc_file_name
, text
);
842 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
844 if(err
< 0) goto name_error
;
846 textlen
=strlen(desc_file_name
);
849 textlen
+=strlen(text
);
850 if(textlen
>= PATH_MAX
) goto name_error
;
851 strcat(desc_file_name
, text
);
853 err
= ltt_facility_open(f
, t
, desc_file_name
);
854 if(err
) goto facility_error
;
863 static void ltt_fac_ids_destroy(gpointer data
)
865 GArray
*fac_ids
= (GArray
*)data
;
867 g_array_free(fac_ids
, TRUE
);
871 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
872 * because it must be done just after the opening */
873 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
882 err
= ltt_tracefile_read_seek(tf
);
883 if(err
== EPERM
) goto seek_error
;
884 else if(err
== ERANGE
) break; /* End of tracefile */
886 err
= ltt_tracefile_read_update_event(tf
);
887 if(err
) goto update_error
;
889 /* We are on a facility load/or facility unload/ or heartbeat event */
891 * * facility 0 is hardcoded : this is the core facility. It will be shown
892 * in the facility array though, and is shown as "loaded builtin" in the
894 * It contains event :
896 * 1 : facility unload
897 * 2 : state dump facility load
900 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
901 /* Should only contain core facility */
902 g_warning("Error in processing facility file %s, "
903 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
904 tf
->event
.facility_id
);
909 struct LttFacilityLoad
*fac_load_data
;
910 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
914 switch((enum ltt_core_events
)tf
->event
.event_id
) {
915 case LTT_EVENT_FACILITY_LOAD
:
916 fac_name
= (char*)(tf
->event
.data
);
917 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
920 (struct LttFacilityLoad
*)
921 (tf
->event
.data
+ strlen(fac_name
) + 1);
922 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
923 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
924 g_assert(fac
->exists
== 0);
925 fac
->name
= g_quark_from_string(fac_name
);
926 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
927 &fac_load_data
->checksum
);
928 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
929 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
930 &fac_load_data
->pointer_size
);
931 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
932 &fac_load_data
->long_size
);
933 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
934 &fac_load_data
->size_t_size
);
935 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
936 &fac_load_data
->alignment
);
938 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
939 continue; /* error opening description */
941 fac
->trace
= tf
->trace
;
943 /* Preset the field offsets */
944 for(i
=0; i
<fac
->events
->len
; i
++){
945 et
= &g_array_index(fac
->events
, LttEventType
, i
);
946 set_fields_offsets(tf
, et
);
951 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
953 if(fac_ids
== NULL
) {
954 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
955 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
957 fac_ids
, ltt_fac_ids_destroy
);
959 g_array_append_val(fac_ids
, fac
->id
);
962 case LTT_EVENT_FACILITY_UNLOAD
:
963 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
964 /* We don't care about unload : facilities ID are valid for the whole
965 * trace. They simply won't be used after the unload. */
967 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
968 fac_name
= (char*)(tf
->event
.data
);
969 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
971 fac_state_dump_load_data
=
972 (struct LttStateDumpFacilityLoad
*)
973 (tf
->event
.data
+ strlen(fac_name
) + 1);
974 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
975 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
976 g_assert(fac
->exists
== 0);
977 fac
->name
= g_quark_from_string(fac_name
);
978 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
979 &fac_state_dump_load_data
->checksum
);
980 fac
->id
= fac_state_dump_load_data
->id
;
981 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
982 &fac_state_dump_load_data
->pointer_size
);
983 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
984 &fac_state_dump_load_data
->long_size
);
985 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
986 &fac_state_dump_load_data
->size_t_size
);
987 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
988 &fac_state_dump_load_data
->alignment
);
989 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
990 continue; /* error opening description */
992 fac
->trace
= tf
->trace
;
994 /* Preset the field offsets */
995 for(i
=0; i
<fac
->events
->len
; i
++){
996 et
= &g_array_index(fac
->events
, LttEventType
, i
);
997 set_fields_offsets(tf
, et
);
1002 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
1004 if(fac_ids
== NULL
) {
1005 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
1006 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1008 fac_ids
, ltt_fac_ids_destroy
);
1010 g_array_append_val(fac_ids
, fac
->id
);
1013 case LTT_EVENT_HEARTBEAT
:
1016 g_warning("Error in processing facility file %s, "
1017 "unknown event id %hhu in core facility.",
1018 g_quark_to_string(tf
->name
),
1019 tf
->event
.event_id
);
1021 goto event_id_error
;
1027 /* Error handling */
1032 g_warning("An error occured in facility tracefile parsing");
1037 LttTrace
*ltt_trace_open(const gchar
*pathname
)
1039 gchar abs_path
[PATH_MAX
];
1044 struct ltt_block_start_header
*header
;
1046 struct dirent
*entry
;
1047 guint control_found
= 0;
1048 guint eventdefs_found
= 0;
1049 struct stat stat_buf
;
1050 gchar path
[PATH_MAX
];
1052 t
= g_new(LttTrace
, 1);
1053 if(!t
) goto alloc_error
;
1055 get_absolute_pathname(pathname
, abs_path
);
1056 t
->pathname
= g_quark_from_string(abs_path
);
1058 g_datalist_init(&t
->tracefiles
);
1060 /* Test to see if it looks like a trace */
1061 dir
= opendir(abs_path
);
1066 while((entry
= readdir(dir
)) != NULL
) {
1067 strcpy(path
, abs_path
);
1069 strcat(path
, entry
->d_name
);
1070 ret
= stat(path
, &stat_buf
);
1075 if(S_ISDIR(stat_buf
.st_mode
)) {
1076 if(strcmp(entry
->d_name
, "control") == 0) {
1079 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1080 eventdefs_found
= 1;
1086 if(!control_found
|| !eventdefs_found
) goto find_error
;
1088 /* Open all the tracefiles */
1089 if(open_tracefiles(t
, abs_path
, "")) {
1090 g_warning("Error opening tracefile %s", abs_path
);
1094 /* Prepare the facilities containers : array and mapping */
1095 /* Array is zeroed : the "exists" field is set to false by default */
1096 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1097 TRUE
, sizeof(LttFacility
),
1099 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1101 g_datalist_init(&t
->facilities_by_name
);
1103 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1104 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1106 g_error("Trace %s has no facility tracefile", abs_path
);
1108 goto facilities_error
;
1111 /* Get the trace information for the control/facility 0 tracefile */
1112 g_assert(group
->len
> 0);
1113 tf
= &g_array_index (group
, LttTracefile
, 0);
1114 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1115 g_assert(parse_trace_header(header
->trace
, tf
, t
) == 0);
1117 t
->num_cpu
= group
->len
;
1119 for(i
=0; i
<group
->len
; i
++) {
1120 tf
= &g_array_index (group
, LttTracefile
, i
);
1121 if(ltt_process_facility_tracefile(tf
))
1122 goto facilities_error
;
1127 /* Error handling */
1129 g_datalist_clear(&t
->facilities_by_name
);
1130 g_array_free(t
->facilities_by_num
, TRUE
);
1132 g_datalist_clear(&t
->tracefiles
);
1140 GQuark
ltt_trace_name(const LttTrace
*t
)
1146 /******************************************************************************
1147 * When we copy a trace, we want all the opening actions to happen again :
1148 * the trace will be reopened and totally independant from the original.
1149 * That's why we call ltt_trace_open.
1150 *****************************************************************************/
1151 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1153 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1156 void ltt_trace_close(LttTrace
*t
)
1161 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1162 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1164 ltt_facility_close(fac
);
1167 g_datalist_clear(&t
->facilities_by_name
);
1168 g_array_free(t
->facilities_by_num
, TRUE
);
1169 g_datalist_clear(&t
->tracefiles
);
1174 /*****************************************************************************
1175 *Get the system description of the trace
1176 ****************************************************************************/
1178 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1180 g_assert(id
< t
->facilities_by_num
->len
);
1181 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1184 /* ltt_trace_facility_get_by_name
1186 * Returns the GArray of facility indexes. All the fac_ids that matches the
1187 * requested facility name.
1189 * If name is not found, returns NULL.
1191 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1193 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1196 /*****************************************************************************
1197 * Functions to discover all the event types in the trace
1198 ****************************************************************************/
1201 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1205 unsigned int num
= t
->facility_number
;
1209 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1210 count
+= f
->event_number
;
1217 //use an iteration on all the trace facilities, and inside iteration on all the
1218 //event types in each facilities instead.
1219 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1221 LttEventType
*event_type
;
1224 f
= ltt_trace_facility_by_id(t
,evId
);
1226 if(unlikely(!f
)) event_type
= NULL
;
1227 else event_type
= f
->events
[evId
- f
->base_id
];
1234 /*****************************************************************************
1235 * ltt_trace_find_tracefile
1237 * Find a tracefile by name and index in the group.
1239 * Returns a pointer to the tracefiles, else NULL.
1240 ****************************************************************************/
1242 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1247 /*****************************************************************************
1248 * Get the start time and end time of the trace
1249 ****************************************************************************/
1251 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1252 LttTime
*start
, LttTime
*end
)
1256 err
= map_block(tf
, 0);
1258 g_error("Can not map block");
1259 *start
= ltt_time_infinite
;
1261 *start
= tf
->buffer
.begin
.timestamp
;
1263 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1265 g_error("Can not map block");
1266 *end
= ltt_time_zero
;
1268 *end
= tf
->buffer
.end
.timestamp
;
1271 struct tracefile_time_span_get_args
{
1277 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1279 struct tracefile_time_span_get_args
*args
=
1280 (struct tracefile_time_span_get_args
*)user_data
;
1282 GArray
*group
= (GArray
*)data
;
1288 for(i
=0; i
<group
->len
; i
++) {
1289 tf
= &g_array_index (group
, LttTracefile
, i
);
1290 if(tf
->cpu_online
) {
1291 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1292 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1293 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1298 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1300 LttTime min_start
= ltt_time_infinite
;
1301 LttTime max_end
= ltt_time_zero
;
1302 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1304 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1306 if(start
!= NULL
) *start
= min_start
;
1307 if(end
!= NULL
) *end
= max_end
;
1312 /*****************************************************************************
1313 *Get the name of a tracefile
1314 ****************************************************************************/
1316 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1322 guint
ltt_tracefile_num(LttTracefile
*tf
)
1327 /*****************************************************************************
1328 * Get the number of blocks in the tracefile
1329 ****************************************************************************/
1331 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1333 return tf
->num_blocks
;
1337 /* Seek to the first event in a tracefile that has a time equal or greater than
1338 * the time passed in parameter.
1340 * If the time parameter is outside the tracefile time span, seek to the first
1341 * event or if after, return ERANGE.
1343 * If the time parameter is before the first event, we have to seek specially to
1346 * If the time is after the end of the trace, return ERANGE.
1348 * Do a binary search to find the right block, then a sequential search in the
1349 * block to find the event.
1351 * In the special case where the time requested fits inside a block that has no
1352 * event corresponding to the requested time, the first event of the next block
1355 * IMPORTANT NOTE : // FIXME everywhere...
1357 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1358 * you will jump over an event if you do.
1360 * Return value : 0 : no error, the tf->event can be used
1361 * ERANGE : time if after the last event of the trace
1362 * otherwise : this is an error.
1366 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1370 unsigned int block_num
, high
, low
;
1372 /* seek at the beginning of trace */
1373 err
= map_block(tf
, 0); /* First block */
1375 g_error("Can not map block");
1379 /* If the time is lower or equal the beginning of the trace,
1380 * go to the first event. */
1381 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1382 ret
= ltt_tracefile_read(tf
);
1383 if(ret
== ERANGE
) goto range
;
1384 else if (ret
) goto fail
;
1385 goto found
; /* There is either no event in the trace or the event points
1386 to the first event in the trace */
1389 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1391 g_error("Can not map block");
1395 /* If the time is after the end of the trace, return ERANGE. */
1396 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1400 /* Binary search the block */
1401 high
= tf
->num_blocks
- 1;
1405 block_num
= ((high
-low
) / 2) + low
;
1407 err
= map_block(tf
, block_num
);
1409 g_error("Can not map block");
1413 /* We cannot divide anymore : this is what would happen if the time
1414 * requested was exactly between two consecutive buffers'end and start
1415 * timestamps. This is also what would happend if we didn't deal with out
1416 * of span cases prior in this function. */
1417 /* The event is right in the buffer!
1418 * (or in the next buffer first event) */
1420 ret
= ltt_tracefile_read(tf
);
1421 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1422 else if(ret
) goto fail
;
1424 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1428 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1429 /* go to lower part */
1431 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1432 /* go to higher part */
1434 } else {/* The event is right in the buffer!
1435 (or in the next buffer first event) */
1437 ret
= ltt_tracefile_read(tf
);
1438 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1439 else if(ret
) goto fail
;
1441 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1453 /* Error handling */
1455 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1456 g_quark_to_string(tf
->name
));
1461 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1465 if(ep
->tracefile
!= tf
) {
1469 err
= map_block(tf
, ep
->block
);
1471 g_error("Can not map block");
1475 tf
->event
.offset
= ep
->offset
;
1477 err
= ltt_tracefile_read_update_event(tf
);
1479 err
= ltt_tracefile_read_op(tf
);
1485 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1486 g_quark_to_string(tf
->name
));
1490 /* Calculate the real event time based on the buffer boundaries */
1491 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1495 g_assert(tf
->trace
->has_tsc
);
1497 time
= ltt_time_from_uint64(
1498 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1499 tf
->buffer
.nsecs_per_cycle
);
1500 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1506 /* Get the current event of the tracefile : valid until the next read */
1507 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1514 /*****************************************************************************
1516 * ltt_tracefile_read : Read the next event in the tracefile
1521 * Returns 0 if an event can be used in tf->event.
1522 * Returns ERANGE on end of trace. The event in tf->event still can be used
1523 * (if the last block was not empty).
1524 * Returns EPERM on error.
1526 * This function does make the tracefile event structure point to the event
1527 * currently pointed to by the tf->event.
1529 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1530 * reinitialize it after an error if you want results to be coherent.
1531 * It would be the case if a end of trace last buffer has no event : the end
1532 * of trace wouldn't be returned, but an error.
1533 * We make the assumption there is at least one event per buffer.
1534 ****************************************************************************/
1536 int ltt_tracefile_read(LttTracefile
*tf
)
1540 err
= ltt_tracefile_read_seek(tf
);
1542 err
= ltt_tracefile_read_update_event(tf
);
1544 err
= ltt_tracefile_read_op(tf
);
1550 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1554 /* Get next buffer until we finally have an event, or end of trace */
1556 err
= ltt_seek_next_event(tf
);
1557 if(unlikely(err
== ENOPROTOOPT
)) {
1561 /* Are we at the end of the buffer ? */
1563 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1566 /* get next block */
1567 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1569 g_error("Can not map block");
1573 } else break; /* We found an event ! */
1580 /* do specific operation on events */
1581 int ltt_tracefile_read_op(LttTracefile
*tf
)
1587 /* do event specific operation */
1589 /* do something if its an heartbeat event : increment the heartbeat count */
1590 //if(event->facility_id == LTT_FACILITY_CORE)
1591 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1592 // tf->cur_heart_beat_number++;
1598 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1599 * event specific operation. */
1600 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1606 pos
= tf
->buffer
.head
+ event
->offset
;
1608 /* Read event header */
1612 if(tf
->trace
->has_tsc
) {
1613 if(tf
->trace
->has_heartbeat
) {
1614 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1616 /* 32 bits -> 64 bits tsc */
1617 /* note : still works for seek and non seek cases. */
1618 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1619 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1621 | (guint64
)event
->time
.timestamp
;
1622 event
->tsc
= tf
->buffer
.tsc
;
1625 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1626 | (guint64
)event
->time
.timestamp
;
1627 event
->tsc
= tf
->buffer
.tsc
;
1629 pos
+= sizeof(guint32
);
1631 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1632 tf
->buffer
.tsc
= event
->tsc
;
1633 pos
+= sizeof(guint64
);
1636 event
->event_time
= ltt_interpolate_time(tf
, event
);
1638 event
->time
.delta
.tv_sec
= 0;
1639 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1640 pos
) * NSEC_PER_USEC
;
1642 event
->tsc
= tf
->buffer
.tsc
;
1644 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1646 pos
+= sizeof(guint32
);
1649 event
->facility_id
= *(guint8
*)pos
;
1650 pos
+= sizeof(guint8
);
1652 event
->event_id
= *(guint8
*)pos
;
1653 pos
+= sizeof(guint8
);
1655 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1656 pos
+= sizeof(guint16
);
1660 /* get the data size and update the event fields with the current
1662 ltt_update_event_size(tf
);
1668 /****************************************************************************
1670 * map_block : map a block from the file
1672 * lttdes : ltt trace file
1673 * whichBlock : the block which will be read
1676 * EINVAL : lseek fail
1677 * EIO : can not read from the file
1678 ****************************************************************************/
1680 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1682 int page_size
= getpagesize();
1683 struct ltt_block_start_header
*header
;
1685 g_assert(block_num
< tf
->num_blocks
);
1687 if(tf
->buffer
.head
!= NULL
) {
1688 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1689 g_warning("unmap size : %u\n",
1690 PAGE_ALIGN(tf
->buf_size
));
1691 perror("munmap error");
1697 /* Multiple of pages aligned head */
1698 tf
->buffer
.head
= mmap(0,
1699 PAGE_ALIGN(tf
->buf_size
),
1700 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1701 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1703 if(tf
->buffer
.head
== MAP_FAILED
) {
1704 perror("Error in allocating memory for buffer of tracefile");
1708 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1711 tf
->buffer
.index
= block_num
;
1713 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1715 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1716 &header
->begin
.timestamp
);
1717 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1718 g_debug("block %u begin : %lu.%lu", block_num
,
1719 tf
->buffer
.begin
.timestamp
.tv_sec
, tf
->buffer
.begin
.timestamp
.tv_nsec
);
1720 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1721 &header
->begin
.cycle_count
);
1722 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1723 &header
->end
.timestamp
);
1724 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1725 g_debug("block %u end : %lu.%lu", block_num
,
1726 tf
->buffer
.end
.timestamp
.tv_sec
, tf
->buffer
.end
.timestamp
.tv_nsec
);
1727 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1728 &header
->end
.cycle_count
);
1729 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1730 &header
->lost_size
);
1732 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1733 tf
->event
.tsc
= tf
->buffer
.tsc
;
1736 * eventually support variable buffer size : will need a partial pre-read of
1737 * the headers to create an index when we open the trace... eventually. */
1738 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1739 &header
->buf_size
));
1741 /* Now that the buffer is mapped, calculate the time interpolation for the
1744 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1746 /* Make the current event point to the beginning of the buffer :
1747 * it means that the event read must get the first event. */
1748 tf
->event
.tracefile
= tf
;
1749 tf
->event
.block
= block_num
;
1750 tf
->event
.offset
= 0;
1759 /* It will update the fields offsets too */
1760 void ltt_update_event_size(LttTracefile
*tf
)
1764 /* Specific handling of core events : necessary to read the facility control
1766 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1767 tf
->event
.facility_id
);
1769 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1770 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1771 case LTT_EVENT_FACILITY_LOAD
:
1772 size
= strlen((char*)tf
->event
.data
) + 1;
1773 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1774 size
+= sizeof(struct LttFacilityLoad
);
1776 case LTT_EVENT_FACILITY_UNLOAD
:
1777 g_debug("Update Event facility unload");
1778 size
= sizeof(struct LttFacilityUnload
);
1780 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1781 size
= strlen((char*)tf
->event
.data
) + 1;
1782 g_debug("Update Event facility load state dump of facility %s",
1783 (char*)tf
->event
.data
);
1784 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1786 case LTT_EVENT_HEARTBEAT
:
1787 g_debug("Update Event heartbeat");
1788 size
= sizeof(TimeHeartbeat
);
1791 g_warning("Error in getting event size : tracefile %s, "
1792 "unknown event id %hhu in core facility.",
1793 g_quark_to_string(tf
->name
),
1794 tf
->event
.event_id
);
1795 goto event_id_error
;
1800 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1801 tf
->event
.facility_id
,
1802 tf
->event
.facility_id
,
1803 g_quark_to_string(tf
->name
));
1804 goto facility_error
;
1807 LttEventType
*event_type
=
1808 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1811 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1813 g_quark_to_string(f
->name
),
1814 g_quark_to_string(tf
->name
));
1815 goto event_type_error
;
1818 if(event_type
->root_field
)
1819 size
= get_field_type_size(tf
, event_type
,
1820 0, 0, event_type
->root_field
, tf
->event
.data
);
1824 g_debug("Event root field : f.e %hhu.%hhu size %zd",
1825 tf
->event
.facility_id
,
1826 tf
->event
.event_id
, size
);
1829 tf
->event
.data_size
= size
;
1831 /* Check consistency between kernel and LTTV structure sizes */
1832 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1839 tf
->event
.data_size
= 0;
1843 /* Take the tf current event offset and use the event facility id and event id
1844 * to figure out where is the next event offset.
1846 * This is an internal function not aiming at being used elsewhere : it will
1847 * not jump over the current block limits. Please consider using
1848 * ltt_tracefile_read to do this.
1850 * Returns 0 on success
1851 * ERANGE if we are at the end of the buffer.
1852 * ENOPROTOOPT if an error occured when getting the current event size.
1854 static int ltt_seek_next_event(LttTracefile
*tf
)
1859 /* seek over the buffer header if we are at the buffer start */
1860 if(tf
->event
.offset
== 0) {
1861 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
)
1862 + tf
->buffer_header_size
;
1864 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1871 pos
= tf
->event
.data
;
1873 if(tf
->event
.data_size
< 0) goto error
;
1875 pos
+= (size_t)tf
->event
.data_size
;
1877 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1879 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1888 g_error("Error in ltt_seek_next_event for tracefile %s",
1889 g_quark_to_string(tf
->name
));
1894 /*****************************************************************************
1896 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1899 ****************************************************************************/
1901 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1903 LttTime lBufTotalTime
; /* Total time for this buffer */
1904 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1905 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1907 /* Calculate the total time for this buffer */
1908 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1909 tf
->buffer
.begin
.timestamp
);
1911 /* Calculate the total cycles for this bufffer */
1912 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1913 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1915 /* Convert the total time to double */
1916 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1918 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1922 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1924 LttField
* rootFld
= evT
->root_field
;
1925 // rootFld->base_address = evD;
1928 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1929 evT
, 0,0,rootFld
, evD
);
1933 /*****************************************************************************
1935 * set_fields_offsets : set the precomputable offset of the fields
1937 * tracefile : opened trace file
1938 * event_type : the event type
1939 ****************************************************************************/
1941 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1943 LttField
*field
= event_type
->root_field
;
1944 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1947 preset_field_type_size(tf
, event_type
, 0, 0,
1948 &fixed_root
, &fixed_parent
,
1954 /*****************************************************************************
1956 * preset_field_type_size : set the fixed sizes of the field type
1959 * event_type : event type
1960 * offset_root : offset from the root
1961 * offset_parent : offset from the parent
1962 * fixed_root : Do we know a fixed offset to the root ?
1963 * fixed_parent : Do we know a fixed offset to the parent ?
1965 ****************************************************************************/
1966 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1967 off_t offset_root
, off_t offset_parent
,
1968 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1971 enum field_status local_fixed_root
, local_fixed_parent
;
1975 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1976 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1977 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1979 type
= field
->field_type
;
1981 field
->fixed_root
= *fixed_root
;
1982 if(field
->fixed_root
== FIELD_FIXED
)
1983 field
->offset_root
= offset_root
;
1985 field
->offset_root
= 0;
1987 field
->fixed_parent
= *fixed_parent
;
1988 if(field
->fixed_parent
== FIELD_FIXED
)
1989 field
->offset_parent
= offset_parent
;
1991 field
->offset_parent
= 0;
1993 size_t current_root_offset
;
1994 size_t current_offset
;
1995 enum field_status current_child_status
, final_child_status
;
1998 switch(type
->type_class
) {
2003 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2004 field
->fixed_size
= FIELD_FIXED
;
2007 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2008 field
->fixed_size
= FIELD_FIXED
;
2012 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2013 field
->fixed_size
= FIELD_FIXED
;
2018 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2019 field
->fixed_size
= FIELD_FIXED
;
2022 local_fixed_root
= FIELD_VARIABLE
;
2023 local_fixed_parent
= FIELD_VARIABLE
;
2024 preset_field_type_size(tf
, event_type
,
2026 &local_fixed_root
, &local_fixed_parent
,
2028 field
->fixed_size
= FIELD_VARIABLE
;
2029 field
->field_size
= 0;
2030 *fixed_root
= FIELD_VARIABLE
;
2031 *fixed_parent
= FIELD_VARIABLE
;
2034 field
->fixed_size
= FIELD_VARIABLE
;
2035 field
->field_size
= 0;
2036 *fixed_root
= FIELD_VARIABLE
;
2037 *fixed_parent
= FIELD_VARIABLE
;
2040 local_fixed_root
= FIELD_VARIABLE
;
2041 local_fixed_parent
= FIELD_VARIABLE
;
2042 preset_field_type_size(tf
, event_type
,
2044 &local_fixed_root
, &local_fixed_parent
,
2046 field
->fixed_size
= field
->child
[0]->fixed_size
;
2047 if(field
->fixed_size
== FIELD_FIXED
) {
2048 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2050 field
->field_size
= 0;
2051 *fixed_root
= FIELD_VARIABLE
;
2052 *fixed_parent
= FIELD_VARIABLE
;
2056 current_root_offset
= field
->offset_root
;
2058 current_child_status
= FIELD_FIXED
;
2059 for(i
=0;i
<type
->element_number
;i
++) {
2060 preset_field_type_size(tf
, event_type
,
2061 current_root_offset
, current_offset
,
2062 fixed_root
, ¤t_child_status
,
2064 if(current_child_status
== FIELD_FIXED
) {
2065 current_root_offset
+= field
->child
[i
]->field_size
;
2066 current_offset
+= field
->child
[i
]->field_size
;
2068 current_root_offset
= 0;
2072 if(current_child_status
!= FIELD_FIXED
) {
2073 *fixed_parent
= current_child_status
;
2074 field
->field_size
= 0;
2075 field
->fixed_size
= current_child_status
;
2077 field
->field_size
= current_offset
;
2078 field
->fixed_size
= FIELD_FIXED
;
2082 current_root_offset
= field
->offset_root
;
2085 final_child_status
= FIELD_FIXED
;
2086 for(i
=0;i
<type
->element_number
;i
++) {
2087 enum field_status current_root_child_status
= FIELD_FIXED
;
2088 enum field_status current_child_status
= FIELD_FIXED
;
2089 preset_field_type_size(tf
, event_type
,
2090 current_root_offset
, current_offset
,
2091 ¤t_root_child_status
, ¤t_child_status
,
2093 if(current_child_status
!= FIELD_FIXED
)
2094 final_child_status
= current_child_status
;
2096 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2098 if(final_child_status
!= FIELD_FIXED
) {
2099 *fixed_root
= final_child_status
;
2100 *fixed_parent
= final_child_status
;
2101 field
->field_size
= 0;
2102 field
->fixed_size
= current_child_status
;
2104 field
->field_size
= max_size
;
2105 field
->fixed_size
= FIELD_FIXED
;
2113 /*****************************************************************************
2115 * check_fields_compatibility : Check for compatibility between two fields :
2116 * do they use the same inner structure ?
2118 * event_type1 : event type
2119 * event_type2 : event type
2122 *Returns : 0 if identical
2124 ****************************************************************************/
2125 gint
check_fields_compatibility(LttEventType
*event_type1
,
2126 LttEventType
*event_type2
,
2127 LttField
*field1
, LttField
*field2
)
2129 guint different
= 0;
2134 if(field1
== NULL
) {
2135 if(field2
== NULL
) goto end
;
2140 } else if(field2
== NULL
) {
2145 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2146 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2147 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2148 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2149 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2150 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2152 type1
= field1
->field_type
;
2153 type2
= field2
->field_type
;
2155 if(type1
->type_class
!= type2
->type_class
) {
2159 if(type1
->element_name
!= type2
->element_name
) {
2164 switch(type1
->type_class
) {
2174 if(field1
->field_size
!= field2
->field_size
) {
2180 if(type1
->element_number
!= type2
->element_number
) {
2184 for(i
=0;i
<type1
->element_number
;i
++) {
2185 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2192 /* Two elements : size and child */
2193 g_assert(type1
->element_number
!= type2
->element_number
);
2194 for(i
=0;i
<type1
->element_number
;i
++) {
2195 if(check_fields_compatibility(event_type1
, event_type2
,
2196 field1
->child
[0], field2
->child
[0])) {
2205 if(field1
->field_size
!= field2
->field_size
) {
2209 /* Two elements : size and child */
2210 g_assert(type1
->element_number
!= type2
->element_number
);
2211 for(i
=0;i
<type1
->element_number
;i
++) {
2212 if(check_fields_compatibility(event_type1
, event_type2
,
2213 field1
->child
[0], field2
->child
[0])) {
2221 if(type1
->element_number
!= type2
->element_number
) {
2225 for(i
=0;i
<type1
->element_number
;i
++) {
2226 if(check_fields_compatibility(event_type1
, event_type2
,
2227 field1
->child
[0], field2
->child
[0])) {
2242 /*****************************************************************************
2244 * getFieldtypeSize: get the size of the field type (primitive type)
2247 * offsetRoot : offset from the root
2248 * offsetParent : offset from the parrent
2250 * evD : event data, it may be NULL
2252 * int : size of the field
2253 ****************************************************************************/
2255 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2256 LttEventType
* evT
, gint offsetRoot
,
2257 gint offsetParent
, LttField
* fld
, void *evD
)
2259 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2260 LttType
* type
= fld
->field_type
;
2262 /* This likely has been tested with gcov : half of them.. */
2263 if(unlikely(fld
->field_fixed
== 1)){
2265 if(unlikely(fld
== evT
->root_field
)) {
2266 size
= fld
->field_size
;
2267 goto end_getFieldtypeSize
;
2271 /* From gcov profiling : half string, half struct, can we gain something
2272 * from that ? (Mathieu) */
2273 switch(type
->type_class
) {
2275 element_number
= (int) type
->element_number
;
2276 if(fld
->field_fixed
== -1){
2277 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2278 0,fld
->child
[0], NULL
);
2279 if(size
== 0){ //has string or sequence
2280 fld
->field_fixed
= 0;
2282 fld
->field_fixed
= 1;
2283 size
*= element_number
;
2285 }else if(fld
->field_fixed
== 0){// has string or sequence
2287 for(i
=0;i
<element_number
;i
++){
2288 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2289 fld
->child
[0], evD
+size
);
2291 }else size
= fld
->field_size
;
2293 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2294 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2300 size1
= (int) ltt_type_size(fac
, type
);
2301 if(fld
->field_fixed
== -1){
2302 fld
->sequ_number_size
= size1
;
2303 fld
->field_fixed
= 0;
2304 size
= getFieldtypeSize(evT
, offsetRoot
,
2305 0,fld
->child
[0], NULL
);
2306 fld
->element_size
= size
;
2308 element_number
= getIntNumber(tf
,size1
,evD
);
2309 type
->element_number
= element_number
;
2310 if(fld
->element_size
> 0){
2311 size
= element_number
* fld
->element_size
;
2312 }else{//sequence has string or sequence
2314 for(i
=0;i
<element_number
;i
++){
2315 size
+= getFieldtypeSize(tf
, evT
,
2316 offsetRoot
+size
+size1
,size
+size1
,
2317 fld
->child
[0], evD
+size
+size1
);
2323 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2324 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2331 if(fld
->field_fixed
== -1){
2332 fld
->field_fixed
= 0;
2334 /* Hope my implementation is faster than strlen (Mathieu) */
2335 char *ptr
=(char*)evD
;
2337 /* from gcov : many many strings are empty, make it the common case.*/
2338 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2339 //size = ptr - (char*)evD + 1; //include end : '\0'
2341 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2342 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2347 element_number
= (int) type
->element_number
;
2349 /* tested with gcov */
2350 if(unlikely(fld
->field_fixed
== -1)){
2351 offset1
= offsetRoot
;
2353 for(i
=0;i
<element_number
;i
++){
2354 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2355 fld
->child
[i
], NULL
);
2356 if(likely(size1
> 0 && size
>= 0)){
2358 if(likely(offset1
>= 0)) offset1
+= size1
;
2366 if(unlikely(size
== -1)){
2367 fld
->field_fixed
= 0;
2369 }else fld
->field_fixed
= 1;
2370 }else if(likely(fld
->field_fixed
== 0)){
2371 offset1
= offsetRoot
;
2373 for(i
=0;unlikely(i
<element_number
);i
++){
2374 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2375 fld
->child
[i
], evD
+offset2
);
2380 }else size
= fld
->field_size
;
2381 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2382 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2386 if(unlikely(fld
->field_fixed
== -1)){
2387 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2388 fld
->field_fixed
= 1;
2389 }else size
= fld
->field_size
;
2391 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2392 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2397 fld
->offset_root
= offsetRoot
;
2398 fld
->offset_parent
= offsetParent
;
2399 fld
->field_size
= size
;
2401 end_getFieldtypeSize
:
2407 /*****************************************************************************
2409 * ltt_get_int : get an integer number
2411 * reverse_byte_order: must we reverse the byte order ?
2412 * size : the size of the integer
2413 * ptr : the data pointer
2415 * gint64 : a 64 bits integer
2416 ****************************************************************************/
2418 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2423 case 1: val
= *((gint8
*)data
); break;
2424 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2425 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2426 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2427 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2428 g_critical("get_int : integer size %d unknown", size
);
2435 /*****************************************************************************
2437 * ltt_get_uint : get an unsigned integer number
2439 * reverse_byte_order: must we reverse the byte order ?
2440 * size : the size of the integer
2441 * ptr : the data pointer
2443 * guint64 : a 64 bits unsigned integer
2444 ****************************************************************************/
2446 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2451 case 1: val
= *((gint8
*)data
); break;
2452 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2453 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2454 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2455 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2456 g_critical("get_uint : unsigned integer size %d unknown",
2465 /* get the node name of the system */
2467 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2469 return s
->node_name
;
2473 /* get the domain name of the system */
2475 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2477 return s
->domain_name
;
2481 /* get the description of the system */
2483 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2485 return s
->description
;
2489 /* get the start time of the trace */
2491 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2493 return s
->trace_start
;
2497 LttTracefile
*ltt_tracefile_new()
2499 return g_new(LttTracefile
, 1);
2502 void ltt_tracefile_destroy(LttTracefile
*tf
)
2507 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2512 /* Before library loading... */
2514 static void __attribute__((constructor
)) init(void)
2516 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2517 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2519 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");