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 struct ltt_trace_header_0_3
*header_0_3
=
236 (struct ltt_trace_header_0_3
*)header
;
237 tf
->buffer_header_size
=
238 sizeof(struct ltt_block_start_header
)
239 + sizeof(struct ltt_trace_header_0_3
);
243 g_warning("Unsupported trace version : %hhu.%hhu",
244 any
->major_version
, any
->minor_version
);
250 g_warning("Unsupported trace version : %hhu.%hhu",
251 any
->major_version
, any
->minor_version
);
261 /*****************************************************************************
263 * ltt_tracefile_open : open a trace file, construct a LttTracefile
265 * t : the trace containing the tracefile
266 * fileName : path name of the trace file
267 * tf : the tracefile structure
269 * : 0 for success, -1 otherwise.
270 ****************************************************************************/
272 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
274 struct stat lTDFStat
; /* Trace data file status */
275 struct ltt_block_start_header
*header
;
276 int page_size
= getpagesize();
279 tf
->long_name
= g_quark_from_string(fileName
);
281 tf
->fd
= open(fileName
, O_RDONLY
);
283 g_warning("Unable to open input data file %s\n", fileName
);
287 // Get the file's status
288 if(fstat(tf
->fd
, &lTDFStat
) < 0){
289 g_warning("Unable to get the status of the input data file %s\n", fileName
);
293 // Is the file large enough to contain a trace
294 if(lTDFStat
.st_size
<
295 (off_t
)(sizeof(struct ltt_block_start_header
296 + sizeof(ltt_trace_header_any
)))){
297 g_print("The input data file %s does not contain a trace\n", fileName
);
301 /* Temporarily map the buffer start header to get trace information */
302 /* Multiple of pages aligned head */
303 tf
->buffer
.head
= mmap(0,
304 PAGE_ALIGN(sizeof(struct ltt_block_start_header
305 + sizeof(struct ltt_trace_header_any
))), PROT_READ
,
306 MAP_PRIVATE
, tf
->fd
, 0);
307 if(tf
->buffer
.head
== MAP_FAILED
) {
308 perror("Error in allocating memory for buffer of tracefile");
311 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
313 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
315 if(parse_trace_header(header
->trace
, tf
, NULL
)) goto unmap_file
;
317 //store the size of the file
318 tf
->file_size
= lTDFStat
.st_size
;
319 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
320 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
322 if(munmap(tf
->buffer
.head
,
323 PAGE_ALIGN(sizeof(struct ltt_block_start_header
324 + sizeof(struct ltt_trace_header_any
))))) {
325 g_warning("unmap size : %u\n",
326 PAGE_ALIGN(sizeof(struct ltt_block_start_header
327 + sizeof(struct ltt_trace_header_any
))));
328 perror("munmap error");
331 tf
->buffer
.head
= NULL
;
333 //read the first block
334 if(map_block(tf
,0)) {
335 perror("Cannot map block for tracefile");
343 if(munmap(tf
->buffer
.head
,
344 PAGE_ALIGN(sizeof(struct ltt_block_start_header
345 + sizeof(struct ltt_trace_header_any
))))) {
346 g_warning("unmap size : %u\n",
347 PAGE_ALIGN(sizeof(struct ltt_block_start_header
348 + sizeof(struct ltt_trace_header_any
))));
349 perror("munmap error");
358 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
364 /*****************************************************************************
365 *Open control and per cpu tracefiles
366 ****************************************************************************/
368 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
371 tf
= ltt_tracefile_open(t
,tracefile_name
);
373 t
->per_cpu_tracefile_number
++;
374 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
377 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
386 tf
= ltt_tracefile_open(t
,control_name
);
388 g_warning("ltt_tracefile_open_control : bad file descriptor");
391 t
->control_tracefile_number
++;
392 g_ptr_array_add(t
->control_tracefiles
,tf
);
394 //parse facilities tracefile to get base_id
395 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
397 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
399 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
401 fLoad
.name
= (gchar
*)pos
;
402 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
403 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
405 for(i
=0;i
<t
->facility_number
;i
++){
406 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
407 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
408 f
->base_id
= fLoad
.base_code
;
412 if(i
==t
->facility_number
) {
413 g_warning("Facility: %s, checksum: %u is not found",
414 fLoad
.name
,(unsigned int)fLoad
.checksum
);
417 }else if(ev
.event_id
== TRACE_BLOCK_START
){
419 }else if(ev
.event_id
== TRACE_BLOCK_END
){
422 g_warning("Not valid facilities trace file");
431 /*****************************************************************************
433 * ltt_tracefile_close: close a trace file,
435 * t : tracefile which will be closed
436 ****************************************************************************/
438 void ltt_tracefile_close(LttTracefile
*t
)
440 int page_size
= getpagesize();
442 if(t
->buffer
.head
!= NULL
)
443 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
444 g_warning("unmap size : %u\n",
445 PAGE_ALIGN(t
->buf_size
));
446 perror("munmap error");
454 /*****************************************************************************
455 *Get system information
456 ****************************************************************************/
458 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
465 GMarkupParseContext
* context
;
466 GError
* error
= NULL
;
467 GMarkupParser markup_parser
=
469 parser_start_element
,
472 NULL
, /* passthrough */
476 fd
= g_open(pathname
, O_RDONLY
, 0);
478 g_warning("Can not open file : %s\n", pathname
);
482 iochan
= g_io_channel_unix_new(fd
);
484 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
486 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
487 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
488 != G_IO_STATUS_EOF
) {
491 g_warning("Can not read xml file: \n%s\n", error
->message
);
494 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
496 g_warning("Can not parse xml file: \n%s\n", error
->message
);
499 g_markup_parse_context_free(context
);
501 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
503 g_warning("Can not close file: \n%s\n", error
->message
);
511 g_markup_parse_context_free(context
);
513 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
515 g_warning("Can not close file: \n%s\n", error
->message
);
526 /*****************************************************************************
527 *The following functions get facility/tracefile information
528 ****************************************************************************/
530 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
537 gchar fullname
[DIR_NAME_SIZE
];
538 GError
* error
= NULL
;
540 dir
= g_dir_open(eventdefs
, 0, &error
);
543 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
548 while((name
= g_dir_read_name(dir
)) != NULL
){
549 if(!g_pattern_match_simple("*.xml", name
)) continue;
550 strcpy(fullname
,eventdefs
);
551 strcat(fullname
,name
);
552 ltt_facility_open(t
,fullname
);
556 for(j
=0;j
<t
->facility_number
;j
++){
557 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
558 for(i
=0; i
<f
->event_number
; i
++){
560 setFieldsOffset(NULL
, et
, NULL
, t
);
567 /*****************************************************************************
568 *A trace is specified as a pathname to the directory containing all the
569 *associated data (control tracefiles, per cpu tracefiles, event
572 *When a trace is closed, all the associated facilities, types and fields
573 *are released as well.
577 /****************************************************************************
578 * get_absolute_pathname
580 * return the unique pathname in the system
582 * MD : Fixed this function so it uses realpath, dealing well with
583 * forgotten cases (.. were not used correctly before).
585 ****************************************************************************/
586 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
588 abs_pathname
[0] = '\0';
590 if ( realpath (pathname
, abs_pathname
) != NULL
)
594 /* error, return the original path unmodified */
595 strcpy(abs_pathname
, pathname
);
601 /* Search for something like : .*_.*
603 * The left side is the name, the right side is the number.
606 int get_tracefile_name_number(const gchar
*raw_name
,
610 guint raw_name_len
= strlen(raw_name
);
611 gchar char_name
[PATH_MAX
];
617 for(i
=raw_name_len
-1;i
>=0;i
--) {
618 if(raw_name
[i
] == '_') break;
620 if(i
==0) /* Either not found or name length is 0 */
624 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
626 if(endptr
== raw_name
+underscore_pos
+1)
627 return -1; /* No digit */
628 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
629 return -1; /* underflow / overflow */
631 strncpy(char_name
, raw_name
, underscore_pos
);
633 char_name
[underscore_pos
] = '\0';
635 *name
= g_quark_from_string(char_name
);
642 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
644 return &trace
->tracefiles
;
648 void compute_tracefile_group(GQuark key_id
,
650 struct compute_tracefile_group_args
*args
)
655 for(i
=0; i
<group
->len
; i
++) {
656 tf
= &g_array_index (group
, LttTracefile
, i
);
658 args
->func(tf
, args
->func_args
);
663 void ltt_tracefile_group_destroy(gpointer data
)
665 GArray
*group
= (GArray
*)data
;
669 for(i
=0; i
<group
->len
; i
++) {
670 tf
= &g_array_index (group
, LttTracefile
, i
);
672 ltt_tracefile_close(tf
);
674 g_array_free(group
, TRUE
);
677 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
679 GArray
*group
= (GArray
*)data
;
683 for(i
=0; i
<group
->len
; i
++) {
684 tf
= &g_array_index (group
, LttTracefile
, i
);
685 if(tf
->cpu_online
) return 1;
691 /* Open each tracefile under a specific directory. Put them in a
692 * GData : permits to access them using their tracefile group pathname.
693 * i.e. access control/modules tracefile group by index :
696 * relative path is the path relative to the trace root
697 * root path is the full path
699 * A tracefile group is simply an array where all the per cpu tracefiles sits.
702 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
703 gchar
*relative_path
)
705 DIR *dir
= opendir(root_path
);
706 struct dirent
*entry
;
707 struct stat stat_buf
;
710 gchar path
[PATH_MAX
];
715 gchar rel_path
[PATH_MAX
];
724 strncpy(path
, root_path
, PATH_MAX
-1);
725 path_len
= strlen(path
);
726 path
[path_len
] = '/';
728 path_ptr
= path
+ path_len
;
730 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
731 rel_path_len
= strlen(rel_path
);
732 rel_path
[rel_path_len
] = '/';
734 rel_path_ptr
= rel_path
+ rel_path_len
;
736 while((entry
= readdir(dir
)) != NULL
) {
738 if(entry
->d_name
[0] == '.') continue;
740 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
741 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
743 ret
= stat(path
, &stat_buf
);
749 g_debug("Tracefile file or directory : %s\n", path
);
751 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
753 if(S_ISDIR(stat_buf
.st_mode
)) {
755 g_debug("Entering subdirectory...\n");
756 ret
= open_tracefiles(trace
, path
, rel_path
);
757 if(ret
< 0) continue;
758 } else if(S_ISREG(stat_buf
.st_mode
)) {
763 if(get_tracefile_name_number(rel_path
, &name
, &num
))
764 continue; /* invalid name */
766 g_debug("Opening file.\n");
767 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
768 g_info("Error opening tracefile %s", path
);
770 continue; /* error opening the tracefile : bad magic number ? */
773 g_debug("Tracefile name is %s and number is %u",
774 g_quark_to_string(name
), num
);
776 tmp_tf
.cpu_online
= 1;
777 tmp_tf
.cpu_num
= num
;
780 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
782 /* Elements are automatically cleared when the array is allocated.
783 * It makes the cpu_online variable set to 0 : cpu offline, by default.
785 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
786 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
787 group
, ltt_tracefile_group_destroy
);
790 /* Add the per cpu tracefile to the named group */
791 unsigned int old_len
= group
->len
;
793 group
= g_array_set_size(group
, num
+1);
794 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
804 /* ltt_get_facility_description
806 * Opens the trace corresponding to the requested facility (identified by fac_id
809 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
811 * Returns 0 on success, or 1 on failure.
814 static int ltt_get_facility_description(LttFacility
*f
,
816 LttTracefile
*fac_tf
)
818 char desc_file_name
[PATH_MAX
];
823 text
= g_quark_to_string(t
->pathname
);
824 textlen
= strlen(text
);
826 if(textlen
>= PATH_MAX
) goto name_error
;
827 strcpy(desc_file_name
, text
);
829 text
= "/eventdefs/";
830 textlen
+=strlen(text
);
831 if(textlen
>= PATH_MAX
) goto name_error
;
832 strcat(desc_file_name
, text
);
834 text
= g_quark_to_string(f
->name
);
835 textlen
+=strlen(text
);
836 if(textlen
>= PATH_MAX
) goto name_error
;
837 strcat(desc_file_name
, text
);
840 textlen
+=strlen(text
);
841 if(textlen
>= PATH_MAX
) goto name_error
;
842 strcat(desc_file_name
, text
);
844 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
846 if(err
< 0) goto name_error
;
848 textlen
=strlen(desc_file_name
);
851 textlen
+=strlen(text
);
852 if(textlen
>= PATH_MAX
) goto name_error
;
853 strcat(desc_file_name
, text
);
855 err
= ltt_facility_open(f
, t
, desc_file_name
);
856 if(err
) goto facility_error
;
865 static void ltt_fac_ids_destroy(gpointer data
)
867 GArray
*fac_ids
= (GArray
*)data
;
869 g_array_free(fac_ids
, TRUE
);
873 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
874 * because it must be done just after the opening */
875 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
884 err
= ltt_tracefile_read_seek(tf
);
885 if(err
== EPERM
) goto seek_error
;
886 else if(err
== ERANGE
) break; /* End of tracefile */
888 err
= ltt_tracefile_read_update_event(tf
);
889 if(err
) goto update_error
;
891 /* We are on a facility load/or facility unload/ or heartbeat event */
893 * * facility 0 is hardcoded : this is the core facility. It will be shown
894 * in the facility array though, and is shown as "loaded builtin" in the
896 * It contains event :
898 * 1 : facility unload
899 * 2 : state dump facility load
902 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
903 /* Should only contain core facility */
904 g_warning("Error in processing facility file %s, "
905 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
906 tf
->event
.facility_id
);
911 struct LttFacilityLoad
*fac_load_data
;
912 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
916 switch((enum ltt_core_events
)tf
->event
.event_id
) {
917 case LTT_EVENT_FACILITY_LOAD
:
918 fac_name
= (char*)(tf
->event
.data
);
919 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
922 (struct LttFacilityLoad
*)
923 (tf
->event
.data
+ strlen(fac_name
) + 1);
924 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
925 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
926 g_assert(fac
->exists
== 0);
927 fac
->name
= g_quark_from_string(fac_name
);
928 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
929 &fac_load_data
->checksum
);
930 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
931 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
932 &fac_load_data
->pointer_size
);
933 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
934 &fac_load_data
->long_size
);
935 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
936 &fac_load_data
->size_t_size
);
937 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
938 &fac_load_data
->alignment
);
940 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
941 continue; /* error opening description */
943 fac
->trace
= tf
->trace
;
945 /* Preset the field offsets */
946 for(i
=0; i
<fac
->events
->len
; i
++){
947 et
= &g_array_index(fac
->events
, LttEventType
, i
);
948 set_fields_offsets(tf
, et
);
953 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
955 if(fac_ids
== NULL
) {
956 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
957 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
959 fac_ids
, ltt_fac_ids_destroy
);
961 g_array_append_val(fac_ids
, fac
->id
);
964 case LTT_EVENT_FACILITY_UNLOAD
:
965 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
966 /* We don't care about unload : facilities ID are valid for the whole
967 * trace. They simply won't be used after the unload. */
969 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
970 fac_name
= (char*)(tf
->event
.data
);
971 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
973 fac_state_dump_load_data
=
974 (struct LttStateDumpFacilityLoad
*)
975 (tf
->event
.data
+ strlen(fac_name
) + 1);
976 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
977 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
978 g_assert(fac
->exists
== 0);
979 fac
->name
= g_quark_from_string(fac_name
);
980 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
981 &fac_state_dump_load_data
->checksum
);
982 fac
->id
= fac_state_dump_load_data
->id
;
983 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
984 &fac_state_dump_load_data
->pointer_size
);
985 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
986 &fac_state_dump_load_data
->long_size
);
987 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
988 &fac_state_dump_load_data
->size_t_size
);
989 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
990 &fac_state_dump_load_data
->alignment
);
991 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
992 continue; /* error opening description */
994 fac
->trace
= tf
->trace
;
996 /* Preset the field offsets */
997 for(i
=0; i
<fac
->events
->len
; i
++){
998 et
= &g_array_index(fac
->events
, LttEventType
, i
);
999 set_fields_offsets(tf
, et
);
1004 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
1006 if(fac_ids
== NULL
) {
1007 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
1008 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
1010 fac_ids
, ltt_fac_ids_destroy
);
1012 g_array_append_val(fac_ids
, fac
->id
);
1015 case LTT_EVENT_HEARTBEAT
:
1018 g_warning("Error in processing facility file %s, "
1019 "unknown event id %hhu in core facility.",
1020 g_quark_to_string(tf
->name
),
1021 tf
->event
.event_id
);
1023 goto event_id_error
;
1029 /* Error handling */
1034 g_warning("An error occured in facility tracefile parsing");
1039 LttTrace
*ltt_trace_open(const gchar
*pathname
)
1041 gchar abs_path
[PATH_MAX
];
1046 struct ltt_block_start_header
*header
;
1048 struct dirent
*entry
;
1049 guint control_found
= 0;
1050 guint eventdefs_found
= 0;
1051 struct stat stat_buf
;
1052 gchar path
[PATH_MAX
];
1054 t
= g_new(LttTrace
, 1);
1055 if(!t
) goto alloc_error
;
1057 get_absolute_pathname(pathname
, abs_path
);
1058 t
->pathname
= g_quark_from_string(abs_path
);
1060 g_datalist_init(&t
->tracefiles
);
1062 /* Test to see if it looks like a trace */
1063 dir
= opendir(abs_path
);
1068 while((entry
= readdir(dir
)) != NULL
) {
1069 strcpy(path
, abs_path
);
1071 strcat(path
, entry
->d_name
);
1072 ret
= stat(path
, &stat_buf
);
1077 if(S_ISDIR(stat_buf
.st_mode
)) {
1078 if(strcmp(entry
->d_name
, "control") == 0) {
1081 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1082 eventdefs_found
= 1;
1088 if(!control_found
|| !eventdefs_found
) goto find_error
;
1090 /* Open all the tracefiles */
1091 if(open_tracefiles(t
, abs_path
, "")) {
1092 g_warning("Error opening tracefile %s", abs_path
);
1096 /* Prepare the facilities containers : array and mapping */
1097 /* Array is zeroed : the "exists" field is set to false by default */
1098 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1099 TRUE
, sizeof(LttFacility
),
1101 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1103 g_datalist_init(&t
->facilities_by_name
);
1105 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1106 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1108 g_error("Trace %s has no facility tracefile", abs_path
);
1110 goto facilities_error
;
1113 /* Get the trace information for the control/facility 0 tracefile */
1114 g_assert(group
->len
> 0);
1115 tf
= &g_array_index (group
, LttTracefile
, 0);
1116 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1117 g_assert(parse_trace_header(header
->trace
, tf
, t
) == 0);
1119 t
->num_cpu
= group
->len
;
1121 for(i
=0; i
<group
->len
; i
++) {
1122 tf
= &g_array_index (group
, LttTracefile
, i
);
1123 if(ltt_process_facility_tracefile(tf
))
1124 goto facilities_error
;
1129 /* Error handling */
1131 g_datalist_clear(&t
->facilities_by_name
);
1132 g_array_free(t
->facilities_by_num
, TRUE
);
1134 g_datalist_clear(&t
->tracefiles
);
1142 GQuark
ltt_trace_name(const LttTrace
*t
)
1148 /******************************************************************************
1149 * When we copy a trace, we want all the opening actions to happen again :
1150 * the trace will be reopened and totally independant from the original.
1151 * That's why we call ltt_trace_open.
1152 *****************************************************************************/
1153 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1155 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1158 void ltt_trace_close(LttTrace
*t
)
1163 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1164 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1166 ltt_facility_close(fac
);
1169 g_datalist_clear(&t
->facilities_by_name
);
1170 g_array_free(t
->facilities_by_num
, TRUE
);
1171 g_datalist_clear(&t
->tracefiles
);
1176 /*****************************************************************************
1177 *Get the system description of the trace
1178 ****************************************************************************/
1180 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1182 g_assert(id
< t
->facilities_by_num
->len
);
1183 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1186 /* ltt_trace_facility_get_by_name
1188 * Returns the GArray of facility indexes. All the fac_ids that matches the
1189 * requested facility name.
1191 * If name is not found, returns NULL.
1193 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1195 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1198 /*****************************************************************************
1199 * Functions to discover all the event types in the trace
1200 ****************************************************************************/
1203 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1207 unsigned int num
= t
->facility_number
;
1211 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1212 count
+= f
->event_number
;
1219 //use an iteration on all the trace facilities, and inside iteration on all the
1220 //event types in each facilities instead.
1221 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1223 LttEventType
*event_type
;
1226 f
= ltt_trace_facility_by_id(t
,evId
);
1228 if(unlikely(!f
)) event_type
= NULL
;
1229 else event_type
= f
->events
[evId
- f
->base_id
];
1236 /*****************************************************************************
1237 * ltt_trace_find_tracefile
1239 * Find a tracefile by name and index in the group.
1241 * Returns a pointer to the tracefiles, else NULL.
1242 ****************************************************************************/
1244 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1249 /*****************************************************************************
1250 * Get the start time and end time of the trace
1251 ****************************************************************************/
1253 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1254 LttTime
*start
, LttTime
*end
)
1258 err
= map_block(tf
, 0);
1260 g_error("Can not map block");
1261 *start
= ltt_time_infinite
;
1263 *start
= tf
->buffer
.begin
.timestamp
;
1265 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1267 g_error("Can not map block");
1268 *end
= ltt_time_zero
;
1270 *end
= tf
->buffer
.end
.timestamp
;
1273 struct tracefile_time_span_get_args
{
1279 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1281 struct tracefile_time_span_get_args
*args
=
1282 (struct tracefile_time_span_get_args
*)user_data
;
1284 GArray
*group
= (GArray
*)data
;
1290 for(i
=0; i
<group
->len
; i
++) {
1291 tf
= &g_array_index (group
, LttTracefile
, i
);
1292 if(tf
->cpu_online
) {
1293 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1294 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1295 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1300 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1302 LttTime min_start
= ltt_time_infinite
;
1303 LttTime max_end
= ltt_time_zero
;
1304 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1306 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1308 if(start
!= NULL
) *start
= min_start
;
1309 if(end
!= NULL
) *end
= max_end
;
1314 /*****************************************************************************
1315 *Get the name of a tracefile
1316 ****************************************************************************/
1318 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1324 guint
ltt_tracefile_num(LttTracefile
*tf
)
1329 /*****************************************************************************
1330 * Get the number of blocks in the tracefile
1331 ****************************************************************************/
1333 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1335 return tf
->num_blocks
;
1339 /* Seek to the first event in a tracefile that has a time equal or greater than
1340 * the time passed in parameter.
1342 * If the time parameter is outside the tracefile time span, seek to the first
1343 * event or if after, return ERANGE.
1345 * If the time parameter is before the first event, we have to seek specially to
1348 * If the time is after the end of the trace, return ERANGE.
1350 * Do a binary search to find the right block, then a sequential search in the
1351 * block to find the event.
1353 * In the special case where the time requested fits inside a block that has no
1354 * event corresponding to the requested time, the first event of the next block
1357 * IMPORTANT NOTE : // FIXME everywhere...
1359 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1360 * you will jump over an event if you do.
1362 * Return value : 0 : no error, the tf->event can be used
1363 * ERANGE : time if after the last event of the trace
1364 * otherwise : this is an error.
1368 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1372 unsigned int block_num
, high
, low
;
1374 /* seek at the beginning of trace */
1375 err
= map_block(tf
, 0); /* First block */
1377 g_error("Can not map block");
1381 /* If the time is lower or equal the beginning of the trace,
1382 * go to the first event. */
1383 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1384 ret
= ltt_tracefile_read(tf
);
1385 if(ret
== ERANGE
) goto range
;
1386 else if (ret
) goto fail
;
1387 goto found
; /* There is either no event in the trace or the event points
1388 to the first event in the trace */
1391 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1393 g_error("Can not map block");
1397 /* If the time is after the end of the trace, return ERANGE. */
1398 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1402 /* Binary search the block */
1403 high
= tf
->num_blocks
- 1;
1407 block_num
= ((high
-low
) / 2) + low
;
1409 err
= map_block(tf
, block_num
);
1411 g_error("Can not map block");
1415 /* We cannot divide anymore : this is what would happen if the time
1416 * requested was exactly between two consecutive buffers'end and start
1417 * timestamps. This is also what would happend if we didn't deal with out
1418 * of span cases prior in this function. */
1419 /* The event is right in the buffer!
1420 * (or in the next buffer first event) */
1422 ret
= ltt_tracefile_read(tf
);
1423 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1424 else if(ret
) goto fail
;
1426 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1430 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1431 /* go to lower part */
1433 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1434 /* go to higher part */
1436 } else {/* The event is right in the buffer!
1437 (or in the next buffer first event) */
1439 ret
= ltt_tracefile_read(tf
);
1440 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1441 else if(ret
) goto fail
;
1443 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1455 /* Error handling */
1457 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1458 g_quark_to_string(tf
->name
));
1463 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1467 if(ep
->tracefile
!= tf
) {
1471 err
= map_block(tf
, ep
->block
);
1473 g_error("Can not map block");
1477 tf
->event
.offset
= ep
->offset
;
1479 err
= ltt_tracefile_read_update_event(tf
);
1481 err
= ltt_tracefile_read_op(tf
);
1487 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1488 g_quark_to_string(tf
->name
));
1492 /* Calculate the real event time based on the buffer boundaries */
1493 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1497 g_assert(tf
->trace
->has_tsc
);
1499 time
= ltt_time_from_uint64(
1500 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1501 tf
->buffer
.nsecs_per_cycle
);
1502 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1508 /* Get the current event of the tracefile : valid until the next read */
1509 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1516 /*****************************************************************************
1518 * ltt_tracefile_read : Read the next event in the tracefile
1523 * Returns 0 if an event can be used in tf->event.
1524 * Returns ERANGE on end of trace. The event in tf->event still can be used
1525 * (if the last block was not empty).
1526 * Returns EPERM on error.
1528 * This function does make the tracefile event structure point to the event
1529 * currently pointed to by the tf->event.
1531 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1532 * reinitialize it after an error if you want results to be coherent.
1533 * It would be the case if a end of trace last buffer has no event : the end
1534 * of trace wouldn't be returned, but an error.
1535 * We make the assumption there is at least one event per buffer.
1536 ****************************************************************************/
1538 int ltt_tracefile_read(LttTracefile
*tf
)
1542 err
= ltt_tracefile_read_seek(tf
);
1544 err
= ltt_tracefile_read_update_event(tf
);
1546 err
= ltt_tracefile_read_op(tf
);
1552 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1556 /* Get next buffer until we finally have an event, or end of trace */
1558 err
= ltt_seek_next_event(tf
);
1559 if(unlikely(err
== ENOPROTOOPT
)) {
1563 /* Are we at the end of the buffer ? */
1565 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1568 /* get next block */
1569 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1571 g_error("Can not map block");
1575 } else break; /* We found an event ! */
1582 /* do specific operation on events */
1583 int ltt_tracefile_read_op(LttTracefile
*tf
)
1589 /* do event specific operation */
1591 /* do something if its an heartbeat event : increment the heartbeat count */
1592 //if(event->facility_id == LTT_FACILITY_CORE)
1593 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1594 // tf->cur_heart_beat_number++;
1600 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1601 * event specific operation. */
1602 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1608 pos
= tf
->buffer
.head
+ event
->offset
;
1610 /* Read event header */
1614 if(tf
->trace
->has_tsc
) {
1615 if(tf
->trace
->has_heartbeat
) {
1616 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1618 /* 32 bits -> 64 bits tsc */
1619 /* note : still works for seek and non seek cases. */
1620 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1621 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1623 | (guint64
)event
->time
.timestamp
;
1624 event
->tsc
= tf
->buffer
.tsc
;
1627 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1628 | (guint64
)event
->time
.timestamp
;
1629 event
->tsc
= tf
->buffer
.tsc
;
1631 pos
+= sizeof(guint32
);
1633 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1634 tf
->buffer
.tsc
= event
->tsc
;
1635 pos
+= sizeof(guint64
);
1638 event
->event_time
= ltt_interpolate_time(tf
, event
);
1640 event
->time
.delta
.tv_sec
= 0;
1641 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1642 pos
) * NSEC_PER_USEC
;
1644 event
->tsc
= tf
->buffer
.tsc
;
1646 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1648 pos
+= sizeof(guint32
);
1651 event
->facility_id
= *(guint8
*)pos
;
1652 pos
+= sizeof(guint8
);
1654 event
->event_id
= *(guint8
*)pos
;
1655 pos
+= sizeof(guint8
);
1657 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1658 pos
+= sizeof(guint16
);
1662 /* get the data size and update the event fields with the current
1664 ltt_update_event_size(tf
);
1670 /****************************************************************************
1672 * map_block : map a block from the file
1674 * lttdes : ltt trace file
1675 * whichBlock : the block which will be read
1678 * EINVAL : lseek fail
1679 * EIO : can not read from the file
1680 ****************************************************************************/
1682 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1684 int page_size
= getpagesize();
1685 struct ltt_block_start_header
*header
;
1687 g_assert(block_num
< tf
->num_blocks
);
1689 if(tf
->buffer
.head
!= NULL
) {
1690 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1691 g_warning("unmap size : %u\n",
1692 PAGE_ALIGN(tf
->buf_size
));
1693 perror("munmap error");
1699 /* Multiple of pages aligned head */
1700 tf
->buffer
.head
= mmap(0,
1701 PAGE_ALIGN(tf
->buf_size
),
1702 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1703 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1705 if(tf
->buffer
.head
== MAP_FAILED
) {
1706 perror("Error in allocating memory for buffer of tracefile");
1710 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1713 tf
->buffer
.index
= block_num
;
1715 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1717 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1718 &header
->begin
.timestamp
);
1719 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1720 g_debug("block %u begin : %lu.%lu", block_num
,
1721 tf
->buffer
.begin
.timestamp
.tv_sec
, tf
->buffer
.begin
.timestamp
.tv_nsec
);
1722 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1723 &header
->begin
.cycle_count
);
1724 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1725 &header
->end
.timestamp
);
1726 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1727 g_debug("block %u end : %lu.%lu", block_num
,
1728 tf
->buffer
.end
.timestamp
.tv_sec
, tf
->buffer
.end
.timestamp
.tv_nsec
);
1729 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1730 &header
->end
.cycle_count
);
1731 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1732 &header
->lost_size
);
1734 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1735 tf
->event
.tsc
= tf
->buffer
.tsc
;
1738 * eventually support variable buffer size : will need a partial pre-read of
1739 * the headers to create an index when we open the trace... eventually. */
1740 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1741 &header
->buf_size
));
1743 /* Now that the buffer is mapped, calculate the time interpolation for the
1746 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1748 /* Make the current event point to the beginning of the buffer :
1749 * it means that the event read must get the first event. */
1750 tf
->event
.tracefile
= tf
;
1751 tf
->event
.block
= block_num
;
1752 tf
->event
.offset
= 0;
1761 /* It will update the fields offsets too */
1762 void ltt_update_event_size(LttTracefile
*tf
)
1766 /* Specific handling of core events : necessary to read the facility control
1768 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1769 tf
->event
.facility_id
);
1771 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1772 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1773 case LTT_EVENT_FACILITY_LOAD
:
1774 size
= strlen((char*)tf
->event
.data
) + 1;
1775 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1776 size
+= sizeof(struct LttFacilityLoad
);
1778 case LTT_EVENT_FACILITY_UNLOAD
:
1779 g_debug("Update Event facility unload");
1780 size
= sizeof(struct LttFacilityUnload
);
1782 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1783 size
= strlen((char*)tf
->event
.data
) + 1;
1784 g_debug("Update Event facility load state dump of facility %s",
1785 (char*)tf
->event
.data
);
1786 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1788 case LTT_EVENT_HEARTBEAT
:
1789 g_debug("Update Event heartbeat");
1790 size
= sizeof(TimeHeartbeat
);
1793 g_warning("Error in getting event size : tracefile %s, "
1794 "unknown event id %hhu in core facility.",
1795 g_quark_to_string(tf
->name
),
1796 tf
->event
.event_id
);
1797 goto event_id_error
;
1802 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1803 tf
->event
.facility_id
,
1804 tf
->event
.facility_id
,
1805 g_quark_to_string(tf
->name
));
1806 goto facility_error
;
1809 LttEventType
*event_type
=
1810 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1813 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1815 g_quark_to_string(f
->name
),
1816 g_quark_to_string(tf
->name
));
1817 goto event_type_error
;
1820 if(event_type
->root_field
)
1821 size
= get_field_type_size(tf
, event_type
,
1822 0, 0, event_type
->root_field
, tf
->event
.data
);
1826 g_debug("Event root field : f.e %hhu.%hhu size %zd",
1827 tf
->event
.facility_id
,
1828 tf
->event
.event_id
, size
);
1831 tf
->event
.data_size
= size
;
1833 /* Check consistency between kernel and LTTV structure sizes */
1834 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1841 tf
->event
.data_size
= 0;
1845 /* Take the tf current event offset and use the event facility id and event id
1846 * to figure out where is the next event offset.
1848 * This is an internal function not aiming at being used elsewhere : it will
1849 * not jump over the current block limits. Please consider using
1850 * ltt_tracefile_read to do this.
1852 * Returns 0 on success
1853 * ERANGE if we are at the end of the buffer.
1854 * ENOPROTOOPT if an error occured when getting the current event size.
1856 static int ltt_seek_next_event(LttTracefile
*tf
)
1861 /* seek over the buffer header if we are at the buffer start */
1862 if(tf
->event
.offset
== 0) {
1863 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
1864 + tf
->buffer_header_size
);
1866 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1873 pos
= tf
->event
.data
;
1875 if(tf
->event
.data_size
< 0) goto error
;
1877 pos
+= (size_t)tf
->event
.data_size
;
1879 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1881 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1890 g_error("Error in ltt_seek_next_event for tracefile %s",
1891 g_quark_to_string(tf
->name
));
1896 /*****************************************************************************
1898 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1901 ****************************************************************************/
1903 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1905 LttTime lBufTotalTime
; /* Total time for this buffer */
1906 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1907 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1909 /* Calculate the total time for this buffer */
1910 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1911 tf
->buffer
.begin
.timestamp
);
1913 /* Calculate the total cycles for this bufffer */
1914 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1915 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1917 /* Convert the total time to double */
1918 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1920 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1924 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1926 LttField
* rootFld
= evT
->root_field
;
1927 // rootFld->base_address = evD;
1930 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1931 evT
, 0,0,rootFld
, evD
);
1935 /*****************************************************************************
1937 * set_fields_offsets : set the precomputable offset of the fields
1939 * tracefile : opened trace file
1940 * event_type : the event type
1941 ****************************************************************************/
1943 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1945 LttField
*field
= event_type
->root_field
;
1946 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1949 preset_field_type_size(tf
, event_type
, 0, 0,
1950 &fixed_root
, &fixed_parent
,
1956 /*****************************************************************************
1958 * preset_field_type_size : set the fixed sizes of the field type
1961 * event_type : event type
1962 * offset_root : offset from the root
1963 * offset_parent : offset from the parent
1964 * fixed_root : Do we know a fixed offset to the root ?
1965 * fixed_parent : Do we know a fixed offset to the parent ?
1967 ****************************************************************************/
1968 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1969 off_t offset_root
, off_t offset_parent
,
1970 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1973 enum field_status local_fixed_root
, local_fixed_parent
;
1977 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1978 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1979 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1981 type
= field
->field_type
;
1983 field
->fixed_root
= *fixed_root
;
1984 if(field
->fixed_root
== FIELD_FIXED
)
1985 field
->offset_root
= offset_root
;
1987 field
->offset_root
= 0;
1989 field
->fixed_parent
= *fixed_parent
;
1990 if(field
->fixed_parent
== FIELD_FIXED
)
1991 field
->offset_parent
= offset_parent
;
1993 field
->offset_parent
= 0;
1995 size_t current_root_offset
;
1996 size_t current_offset
;
1997 enum field_status current_child_status
, final_child_status
;
2000 switch(type
->type_class
) {
2005 field
->field_size
= ltt_type_size(tf
->trace
, type
);
2006 field
->fixed_size
= FIELD_FIXED
;
2009 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
2010 field
->fixed_size
= FIELD_FIXED
;
2014 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
2015 field
->fixed_size
= FIELD_FIXED
;
2020 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
2021 field
->fixed_size
= FIELD_FIXED
;
2024 local_fixed_root
= FIELD_VARIABLE
;
2025 local_fixed_parent
= FIELD_VARIABLE
;
2026 preset_field_type_size(tf
, event_type
,
2028 &local_fixed_root
, &local_fixed_parent
,
2030 field
->fixed_size
= FIELD_VARIABLE
;
2031 field
->field_size
= 0;
2032 *fixed_root
= FIELD_VARIABLE
;
2033 *fixed_parent
= FIELD_VARIABLE
;
2036 field
->fixed_size
= FIELD_VARIABLE
;
2037 field
->field_size
= 0;
2038 *fixed_root
= FIELD_VARIABLE
;
2039 *fixed_parent
= FIELD_VARIABLE
;
2042 local_fixed_root
= FIELD_VARIABLE
;
2043 local_fixed_parent
= FIELD_VARIABLE
;
2044 preset_field_type_size(tf
, event_type
,
2046 &local_fixed_root
, &local_fixed_parent
,
2048 field
->fixed_size
= field
->child
[0]->fixed_size
;
2049 if(field
->fixed_size
== FIELD_FIXED
) {
2050 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
2052 field
->field_size
= 0;
2053 *fixed_root
= FIELD_VARIABLE
;
2054 *fixed_parent
= FIELD_VARIABLE
;
2058 current_root_offset
= field
->offset_root
;
2060 current_child_status
= FIELD_FIXED
;
2061 for(i
=0;i
<type
->element_number
;i
++) {
2062 preset_field_type_size(tf
, event_type
,
2063 current_root_offset
, current_offset
,
2064 fixed_root
, ¤t_child_status
,
2066 if(current_child_status
== FIELD_FIXED
) {
2067 current_root_offset
+= field
->child
[i
]->field_size
;
2068 current_offset
+= field
->child
[i
]->field_size
;
2070 current_root_offset
= 0;
2074 if(current_child_status
!= FIELD_FIXED
) {
2075 *fixed_parent
= current_child_status
;
2076 field
->field_size
= 0;
2077 field
->fixed_size
= current_child_status
;
2079 field
->field_size
= current_offset
;
2080 field
->fixed_size
= FIELD_FIXED
;
2084 current_root_offset
= field
->offset_root
;
2087 final_child_status
= FIELD_FIXED
;
2088 for(i
=0;i
<type
->element_number
;i
++) {
2089 enum field_status current_root_child_status
= FIELD_FIXED
;
2090 enum field_status current_child_status
= FIELD_FIXED
;
2091 preset_field_type_size(tf
, event_type
,
2092 current_root_offset
, current_offset
,
2093 ¤t_root_child_status
, ¤t_child_status
,
2095 if(current_child_status
!= FIELD_FIXED
)
2096 final_child_status
= current_child_status
;
2098 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2100 if(final_child_status
!= FIELD_FIXED
) {
2101 *fixed_root
= final_child_status
;
2102 *fixed_parent
= final_child_status
;
2103 field
->field_size
= 0;
2104 field
->fixed_size
= current_child_status
;
2106 field
->field_size
= max_size
;
2107 field
->fixed_size
= FIELD_FIXED
;
2115 /*****************************************************************************
2117 * check_fields_compatibility : Check for compatibility between two fields :
2118 * do they use the same inner structure ?
2120 * event_type1 : event type
2121 * event_type2 : event type
2124 *Returns : 0 if identical
2126 ****************************************************************************/
2127 gint
check_fields_compatibility(LttEventType
*event_type1
,
2128 LttEventType
*event_type2
,
2129 LttField
*field1
, LttField
*field2
)
2131 guint different
= 0;
2136 if(field1
== NULL
) {
2137 if(field2
== NULL
) goto end
;
2142 } else if(field2
== NULL
) {
2147 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2148 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2149 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2150 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2151 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2152 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2154 type1
= field1
->field_type
;
2155 type2
= field2
->field_type
;
2157 if(type1
->type_class
!= type2
->type_class
) {
2161 if(type1
->element_name
!= type2
->element_name
) {
2166 switch(type1
->type_class
) {
2176 if(field1
->field_size
!= field2
->field_size
) {
2182 if(type1
->element_number
!= type2
->element_number
) {
2186 for(i
=0;i
<type1
->element_number
;i
++) {
2187 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2194 /* Two elements : size and child */
2195 g_assert(type1
->element_number
!= type2
->element_number
);
2196 for(i
=0;i
<type1
->element_number
;i
++) {
2197 if(check_fields_compatibility(event_type1
, event_type2
,
2198 field1
->child
[0], field2
->child
[0])) {
2207 if(field1
->field_size
!= field2
->field_size
) {
2211 /* Two elements : size and child */
2212 g_assert(type1
->element_number
!= type2
->element_number
);
2213 for(i
=0;i
<type1
->element_number
;i
++) {
2214 if(check_fields_compatibility(event_type1
, event_type2
,
2215 field1
->child
[0], field2
->child
[0])) {
2223 if(type1
->element_number
!= type2
->element_number
) {
2227 for(i
=0;i
<type1
->element_number
;i
++) {
2228 if(check_fields_compatibility(event_type1
, event_type2
,
2229 field1
->child
[0], field2
->child
[0])) {
2244 /*****************************************************************************
2246 * getFieldtypeSize: get the size of the field type (primitive type)
2249 * offsetRoot : offset from the root
2250 * offsetParent : offset from the parrent
2252 * evD : event data, it may be NULL
2254 * int : size of the field
2255 ****************************************************************************/
2257 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2258 LttEventType
* evT
, gint offsetRoot
,
2259 gint offsetParent
, LttField
* fld
, void *evD
)
2261 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2262 LttType
* type
= fld
->field_type
;
2264 /* This likely has been tested with gcov : half of them.. */
2265 if(unlikely(fld
->field_fixed
== 1)){
2267 if(unlikely(fld
== evT
->root_field
)) {
2268 size
= fld
->field_size
;
2269 goto end_getFieldtypeSize
;
2273 /* From gcov profiling : half string, half struct, can we gain something
2274 * from that ? (Mathieu) */
2275 switch(type
->type_class
) {
2277 element_number
= (int) type
->element_number
;
2278 if(fld
->field_fixed
== -1){
2279 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2280 0,fld
->child
[0], NULL
);
2281 if(size
== 0){ //has string or sequence
2282 fld
->field_fixed
= 0;
2284 fld
->field_fixed
= 1;
2285 size
*= element_number
;
2287 }else if(fld
->field_fixed
== 0){// has string or sequence
2289 for(i
=0;i
<element_number
;i
++){
2290 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2291 fld
->child
[0], evD
+size
);
2293 }else size
= fld
->field_size
;
2295 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2296 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2302 size1
= (int) ltt_type_size(fac
, type
);
2303 if(fld
->field_fixed
== -1){
2304 fld
->sequ_number_size
= size1
;
2305 fld
->field_fixed
= 0;
2306 size
= getFieldtypeSize(evT
, offsetRoot
,
2307 0,fld
->child
[0], NULL
);
2308 fld
->element_size
= size
;
2310 element_number
= getIntNumber(tf
,size1
,evD
);
2311 type
->element_number
= element_number
;
2312 if(fld
->element_size
> 0){
2313 size
= element_number
* fld
->element_size
;
2314 }else{//sequence has string or sequence
2316 for(i
=0;i
<element_number
;i
++){
2317 size
+= getFieldtypeSize(tf
, evT
,
2318 offsetRoot
+size
+size1
,size
+size1
,
2319 fld
->child
[0], evD
+size
+size1
);
2325 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2326 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2333 if(fld
->field_fixed
== -1){
2334 fld
->field_fixed
= 0;
2336 /* Hope my implementation is faster than strlen (Mathieu) */
2337 char *ptr
=(char*)evD
;
2339 /* from gcov : many many strings are empty, make it the common case.*/
2340 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2341 //size = ptr - (char*)evD + 1; //include end : '\0'
2343 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2344 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2349 element_number
= (int) type
->element_number
;
2351 /* tested with gcov */
2352 if(unlikely(fld
->field_fixed
== -1)){
2353 offset1
= offsetRoot
;
2355 for(i
=0;i
<element_number
;i
++){
2356 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2357 fld
->child
[i
], NULL
);
2358 if(likely(size1
> 0 && size
>= 0)){
2360 if(likely(offset1
>= 0)) offset1
+= size1
;
2368 if(unlikely(size
== -1)){
2369 fld
->field_fixed
= 0;
2371 }else fld
->field_fixed
= 1;
2372 }else if(likely(fld
->field_fixed
== 0)){
2373 offset1
= offsetRoot
;
2375 for(i
=0;unlikely(i
<element_number
);i
++){
2376 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2377 fld
->child
[i
], evD
+offset2
);
2382 }else size
= fld
->field_size
;
2383 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2384 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2388 if(unlikely(fld
->field_fixed
== -1)){
2389 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2390 fld
->field_fixed
= 1;
2391 }else size
= fld
->field_size
;
2393 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2394 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2399 fld
->offset_root
= offsetRoot
;
2400 fld
->offset_parent
= offsetParent
;
2401 fld
->field_size
= size
;
2403 end_getFieldtypeSize
:
2409 /*****************************************************************************
2411 * ltt_get_int : get an integer number
2413 * reverse_byte_order: must we reverse the byte order ?
2414 * size : the size of the integer
2415 * ptr : the data pointer
2417 * gint64 : a 64 bits integer
2418 ****************************************************************************/
2420 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2425 case 1: val
= *((gint8
*)data
); break;
2426 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2427 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2428 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2429 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2430 g_critical("get_int : integer size %d unknown", size
);
2437 /*****************************************************************************
2439 * ltt_get_uint : get an unsigned integer number
2441 * reverse_byte_order: must we reverse the byte order ?
2442 * size : the size of the integer
2443 * ptr : the data pointer
2445 * guint64 : a 64 bits unsigned integer
2446 ****************************************************************************/
2448 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2453 case 1: val
= *((gint8
*)data
); break;
2454 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2455 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2456 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2457 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2458 g_critical("get_uint : unsigned integer size %d unknown",
2467 /* get the node name of the system */
2469 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2471 return s
->node_name
;
2475 /* get the domain name of the system */
2477 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2479 return s
->domain_name
;
2483 /* get the description of the system */
2485 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2487 return s
->description
;
2491 /* get the start time of the trace */
2493 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2495 return s
->trace_start
;
2499 LttTracefile
*ltt_tracefile_new()
2501 return g_new(LttTracefile
, 1);
2504 void ltt_tracefile_destroy(LttTracefile
*tf
)
2509 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2514 /* Before library loading... */
2516 static void __attribute__((constructor
)) init(void)
2518 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2519 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2521 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");